diff --git a/docs/api/beta/access-profiles.tag.mdx b/docs/api/beta/access-profiles.tag.mdx new file mode 100644 index 000000000..d3bf40ab7 --- /dev/null +++ b/docs/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/docs/api/beta/access-request-approvals.tag.mdx b/docs/api/beta/access-request-approvals.tag.mdx new file mode 100644 index 000000000..b9442f841 --- /dev/null +++ b/docs/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/docs/api/beta/access-request-identity-metrics.tag.mdx b/docs/api/beta/access-request-identity-metrics.tag.mdx new file mode 100644 index 000000000..8b2c53bf0 --- /dev/null +++ b/docs/api/beta/access-request-identity-metrics.tag.mdx @@ -0,0 +1,24 @@ +--- +id: access-request-identity-metrics +title: "Access Request Identity Metrics" +description: "Access Request Identity Metrics" +custom_edit_url: null +--- + + + +Use this API to implement access request identity metrics functionality. +With this functionality in place, access request reviewers can see relevant details about the requested access item and associated source activity. +This allows reviewers to see how many of the identities who share a manager with the access requester have this same type of access and how many of them have had activity in the related source. +This additional context about whether the access has been granted before and how often it has been used can help those approving access requests make more informed decisions. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/docs/api/beta/access-requests.tag.mdx b/docs/api/beta/access-requests.tag.mdx new file mode 100644 index 000000000..17b532dc1 --- /dev/null +++ b/docs/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/docs/api/beta/account-activities.tag.mdx b/docs/api/beta/account-activities.tag.mdx new file mode 100644 index 000000000..21e93473c --- /dev/null +++ b/docs/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/docs/api/beta/account-aggregations.tag.mdx b/docs/api/beta/account-aggregations.tag.mdx new file mode 100644 index 000000000..b8e9b4ffb --- /dev/null +++ b/docs/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/docs/api/beta/account-usages.tag.mdx b/docs/api/beta/account-usages.tag.mdx new file mode 100644 index 000000000..b4ff6e232 --- /dev/null +++ b/docs/api/beta/account-usages.tag.mdx @@ -0,0 +1,23 @@ +--- +id: account-usages +title: "Account Usages" +description: "Account Usages" +custom_edit_url: null +--- + + + +Use this API to implement account usage insight functionality. +With this functionality in place, administrators can gather information and insights about how their tenants' source accounts are being used. +This allows organizations to get the information they need to start optimizing and securing source account usage. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/docs/api/beta/accounts.tag.mdx b/docs/api/beta/accounts.tag.mdx new file mode 100644 index 000000000..e95316e4b --- /dev/null +++ b/docs/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/docs/api/beta/add-access-request-recommendations-ignored-item.api.mdx b/docs/api/beta/add-access-request-recommendations-ignored-item.api.mdx new file mode 100644 index 000000000..c134bc677 --- /dev/null +++ b/docs/api/beta/add-access-request-recommendations-ignored-item.api.mdx @@ -0,0 +1,87 @@ +--- +id: add-access-request-recommendations-ignored-item +sidebar_label: Notification of Ignored Access Request Recommendations +hide_title: true +hide_table_of_contents: true +api: eJztW/lv28gV/lcG7A+bBKIuyydQFIrtFFo4a9cHAtQxmhE5kiYhh1wedlTD/3u/94akSEk+Npu2u4ESwLbIN2/e9b1jSN07UawSmenIjHznwJG+P/Q8labn6tdcpdm58qIwVMZnknQ0NVGi/FGmQqflZHKaOgfXzmg4EnaVKJaJpXXOTcvxVeolOqbP2OhyplMxPBsJzSxTIUVSrlG+kJZdUrDT2LAtTo2nhDT8SWC5Xeq3cEHc6SAQYyVCmXyh9dXdv2ZJroSeEBHWpBkRNjez3C9nSniQNQ9VIjxs4ytP+0pkkZjR74LfYqVVrQ1DFGK+jfy5c3C/oqlapxorAd6WrZhECavmK5PpbF5y1djROSAVWg6Ey3CXdpBxHGiPBeh8Tmmbeyf1ZiqU9Fc2jxU2jsaflZeBUZyQkzOtUrpbbkH+rmjTLNFmClrIEUrs4VxdjY6cVa+pSkQxOhKZ/IJlIsNl6RENya2+yjAOiGvf2+/tdfe2d7tbva1er9vt7XYH3XF3Z7I1GChv33loOdYcLxH7t4sLCaNJw+BjRfLW3LFW4K1tv6+2ezt73d62v9Wf7O13Pdnb3uuRwFaEVVGUyUNCw/Dw8Pji4l9n56fvRifHuHF+il9rAIDQAoslCZvyrPCC4e2Nx0FK4Lwk2R4eXkzPtIt4u64HSeWimxexG3ol06MsAl/LOY0BFevIfre3CpImD5HmvMEkD4I5IMu4W0CabLQBwwYM/zUwEGmIe9j5STtjjXKJtGk3eNbt7rq93mVv72CwfbC12+7u7/3zpTIsEHRe4GaBpEG3uwqew0AjCsVxkqCIuKi9WZ4YqmsTDsayiI5RnrhsmlsZ6O+JIl9lUgeHkb82FprCvtNGudNEapJQscgeFgpwvNU+BWRI9dCypHggFZiuGQ2wRLsn3kq/6jkOC2XIyon0CIzrYd0U6MporBflEkCai/Ej26pdJcc73f3+YLIzkLK/N+jtbo/3J3Jrq7u/vc8oRuikcqrqOJZJIucrW/9dGZVoTwSRB4/8m5sLCduzALw5lhAQXpASmMcL7E9Qs7SVmoW8IlNfsxZ6o7eHZ2KwKwJppjlfl9MlIxj36gJXDPKzHNMl6lCguWV8muipNk+lhaPjd8Ork0vKB8f/uDq+wF/EayUvDNERGZ/CEqIiFmbRHUtcKHCHmpCqAOZA7hJvCq5voJA0aZ1Q20/pPKW856uJzIMMK4rd16yosxaTJAobUGLcfM3EK91W7RYSKa4hJXgzMZYpFsCFRP6GUB5n7klhyTdipqSvktdtMfR9TUrKQACNYIr1c2pg0YETdC2DSQ4oQxidzaI8EybKtKeavliYsumNRao5qTuFwAHJn48TZKEcwrGadRRW0VKIWPgHMlvLNaW7rBmNTTo3GRVHUKKye1GC6oPMlFOLn4oiHXGfjsRjSroqY9UzKKe791YYmyCRz2SevgB3ZwHSj8uqVTduVQG+lLpym43YG6WbioyEm6Q2Ly6oKneVwBcTrQJ/g90NdjfYfSF2l2+ua33WzA1XRuawb8LFc6X1STh6TCRKIjtdWEe2BAxStEg/f7gEsL8oQ/Tqa6y/75RhS/mK8MPKH/b6uBwfytK/8AUJyHa0GkyQiZR/wHIvJGZDWVNtre72LkrGGgFq1rSIyJqJmEe5kDBZkhtDksi0JfxIpeanTMzkrSo7c86AtKvx3TjSJtt0kptOclONNtXox6lGm05yg90Ndv+c2H2yk6ykYrQUfVKah6FM5jbSivt8EilAIMrDa1FBjl213K0QM1H1WE6zc3DG/d64N9n11MCXA39na3/S93b6cnu3t9sbD/q7Tr3WXy9wXIGsiamav60f2cRo4m7Rx+UGwZVmUeQ3j/9g3kRNKK1R6qn6ZtgcJr2pesf+/ppnWFEk3kszLzuktNFDmoWNKKeBNiTapKQFgRRT5EUjkKo05KJQ0qEClwRBIwIdagYvaQG+ydwdTjKoYoFSBlm1izZekENCzgRBRF1zhMDSUFJNqOcDB+5gp8jO37E7LVz0uzp5cU4an5DG4virpxQBverct9ed744gfEI54sI6+JGDXjvtSIMAwEBgc1bVd276801/vqnxmxr/Y9T4TX++we4Gu39O7P6G/rzohh7vz0Hw4v4ctO2uqHqpdxRc//M2naFSSMDhLSLPyxM+bi57cO4rEEokUBylnERkNsOnjtSuPYR1C3e5S2+jdYpXZFybj1qOnQmstHkSgMksy+L0oNO5hxPhvIe2jHW7fI/FRHdtMOyMYbk1SYneHrAAJAJ+f89u0GazJ5oi26ZBZm6dwIpSDMMZfGD8JGcjQ/buPMqR+JhNi14OKaKML0PEGCPGTylTtzmqVvSDXldJ8PD7dbGMHtFlnfme3A30ApIuqUgq3JC7EA1gxP66gjyHNocNcwqA65s6zQX17FbCFcpFHaI5r78i0CmR9cVbJRMMFPbRx6ufP1y+FlPqVDlT5Ck1yUrTaAGsnSGMOBMOy8cAtIiLUxLl0xkrN2w8aCHkiUkAo4iP5kIpcT0qDPULSsQ5cjqbnRYpTiO06uZV6UFf3aqAqmd7YW0KTu2bDqzYkY11r7lS8kihjX1Fh97B+mhccaQpgRE+mKZQkSdEcR2XesmaXt8qxF9KbiVOmVv6ekkKa9prz7644wGwxEIGKVvrmze3/NwaP5q/cIW4LstAlijkaD4e80qvfbMcDX4u8WvK8dF8mGmU4eYyYbOeSFFFA1+MhDeLolT9TQgKHYLK9TQH0r5ZrDva1GVEuP1uTSTXbulqF00ly3cCYBgbTHJMRZ17mgjtnvEtbD+xZ5EXPmHk9sWnhs58+Rq1lyj9yEu/WWba0KUNXZsn0kJ+W9oosOiFNOjAecAGwOHC/5wJCkFrudHyWpv5mX2H11D58CAqc0njA/vhYJEEi78E3yDqigapmnry6oEhPouCF9W3hrHK04RlC67KG0Qoq0t2s/JWp1lUav9o+pLGw8Why6kJ5t87Sz+SSf44eff/lPE2meZHzDRFl0yHl+eLr14cl/NM87Xu51+8rr93rWsrHn/zuXzxefmdZJKKQMDGKIacOvTeFp3m6tEknZ3PFH7iLmcQHhMwhPFYyb1VnVEcyIywxrnGm2nFhxqxkhl1rS2K9yjk/BAnEemG0ZUZTRPQIJmk6KblWAf0XRM6di93lgxj2xJTtNHnNOfJivbyZhiSVVt8wJxpPAQLzZj04gjufY6KYfMC8XJG4SaOyhBEKxiGuaE35SF2HgqJQH8mTn2derlNpxg5jSptEXFDWq0qcwsBgFRo87SVhOnphM7LMYrXwvGZvRCNaXFYDtOTF2m+oEGuUuRcBcV3mlpLA8dzvIEBd6aCmKZc1AK0haq2w/vR5QpHMDMp9PJUO0qmnWJR2iFaMKHBzobPVrvX7ro86OA6DY2Yy2vMf4kyPSmTHwaP4ntcz31raylK7xdPEX6s728VYKbxqRPTiSFZMbcjnx29r51nR286BGwM3xjVZjS+Y/H9PZ040TT6QJexno4zrm8WgyYPd1jAJ088/X1RdOJRPOpw+UsM1dHG6jMcmn/tCnua9STtTe2E4eyUzvWccfHdtdAeliTyDhfp54HzEf/xIYqtmiDi6/dOefQIGsuX/v0HHk+mEA== +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 objectrequired
+ +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/add-access-request-recommendations-requested-item.api.mdx b/docs/api/beta/add-access-request-recommendations-requested-item.api.mdx new file mode 100644 index 000000000..1cf79c23a --- /dev/null +++ b/docs/api/beta/add-access-request-recommendations-requested-item.api.mdx @@ -0,0 +1,87 @@ +--- +id: add-access-request-recommendations-requested-item +sidebar_label: Notification of Requested Access Request Recommendations +hide_title: true +hide_table_of_contents: true +api: eJztW2tz27gV/SsY9sMmGVEvy88vHcV2Otpx1q4fk5k6ngYiIQkJBWoJ0o7q8X/vuRckRUryY7Npu5sqmbFN8uLivnEuCN578UwlMtWxGYTegSfDsB8Eytpz9WumbHqugng6VSZkkuKuCgepmnoNL5Vj6x1ce4P+QLhxIicRSyO9m4YXKhskekbXmOpyoq3onw1EgMfZVFkhhYlTPdIBDxHpRKa4lxSMVCikmyPJ59CQQtzJ8oYKm6JkG8ZgCYYYlGYyiuZiKr8ocFUFeQMMBKg/ZzZdmjznc6ejSExUNBOzJL7VoRIjpcKhDL4IbUSchCoRaSz0lB4rEWfJQlyndxNWyqd7G4dz7+B+xQxqnYqsGlugpp8YxYmQRkAUk+p0XrDXiYL70iRTDQ/2TPGUppKzWZRr1Ppsab57zwYTNZX0VzqfKUgQDz+rIAUjKIFgSLWy9LSYguKipLVpos0YtJBjKjGHd3U1OPJWfatKEcXgSKTyC4ax7eENsi+GqK9yOouIazfY7+y197Z321udrU6n3e7stnvtYXtntNXrqWDfe2h4zi4vEfu3iwsJ41HN8kNF8lb8slbgre2wq7Y7O3vtzna41R3t7bcD2dne65DAToRVUZTJppQz/cPD44uLf56dn74bnBzjwfkpfq1JE8QsWCxJWJdnhRcM7x48nsyUwpck28PDi+mZdhFv19UgKV108yJ2/aBgepTG4Os42xlyxjmy2+6sZssv1QJhM2Y/yii5kZMmvotUOHbO2mTBJgv+Y1lApFixUsz8pJ0xRvlEWrcbPOu3d/1O57Kzd9DbPtjabbb39/7xUhkWqXOeJ8wihXrt9mrWHEYaUSiOkwSrh4+lOc0Sg8VEj6rLoRhigaL1UJtbGenvmUWhSqWODuNwbSzUhX2njfLHidQkoWKRAwzMV2AKyGmcKOFYUjyQCkxXjwZYotkRb2VYQpLDXBmycoJ6AV7r07ou0JXRGC+KIUhpXoUfmVbtKjncae93e6OdnpTdvV5nd3u4P5JbW+397X3OYoSOlWNVzWOZJHK+MvXflFGJDkQUB/DIv2CQREnYngXgyTGEEuEFJYF5vMD+lGqOtlQzl1ek6itAkxRvD89Eb1dE0owzvi/HS0Yw/tUF7hiUZjmkWwRNoLljfJrosTZPlYWj43f9q5NLqgfHf786vsBfxGulLvQBhUxIYQlREQuT+I4lzhUg7GRVBHMQNHyTc30DhaSxVULtruzcUt0L1UhmUYoR+exrRlRZi1EST2upxHnzNRWvdFM1GyikuIeSEEzEUFoMYHirxBvK8lnqn+SWfAOwKQEqXzdFPww1KSkjgWwEU4yfg5EARKfUdQxGGVIZwuh0EmcpQ9hA1X2xMGXdG4tSc1J1CiUHJH8+TvoMqzkmallYRksuYu4fyOwsV5fusmI0NuncpLQ4BozYgzjB6oPKlBHYtyIvR+Qui8JjCrqyYlUrKJe7904YVyBRz2RmX5B3ZxHKj8+qlQ9uVZ58liB/0Q/IhZvyioSHpDYPzqlKdxWJL0ZaReEmdze5u8ndF+bu8sN10GdNw3BlZAb7Jrx4rkCfhKPHxKIgco2Fc2QDDX4BkX7+cInE/qIM0auvM+p/viM+ckv5ivD90h/u/rBoH4qlf+ELEpDt6DQYoRKp8IDlXkjMhnKm2lqd7V2cDDUC1KyBiKiaiZjHmZAwWZIZQ5JI2+BdFvNTKibyVhXInCsgzWpCfxZrk26Q5AZJblajzWr046xGGyS5yd1N7v45c/dJJFlKxdmS4ySbTacymbtIy5/zTqQAgSh2rUWZcuyqZbRCzESJsbw6cvCG3c6wM9oNVC+UvXBna3/UDXa6cnu3s9sZ9rq7XnWtv17kcZlk9Zyq+Nv5kU0MEHcLHJcZBJdN4zisb//BvIkaUVmj0lPiZtgcJr0psWN3f81brDgW76WZFwjJ1jCkWdiIahpop0SbFLQgkGKMumgESpWGXBRKeqrAJUHQiEhPdf52TxHfZO73RylUcYlSBFk5izZBlEFCrgRRTKg5RmBpKKlGhPnAgRHsGNX5O6LT3EW/C8mLc9L4hDQWx18DpSjRS+S+vW5/dwDhE6oRF87Bj2z0um5HGgQAGgJXs0rcucHnG3y+WeM3a/yPscZv8Pkmdze5++fM3d+Az3M09Dg+B8GL8Tlom21RYql3FFz/dZjOqZJLwOEt4iDIEt5uLjA44wqEEgk0iy0XEZlOcNWS2nebsH7uLn/pPFqrPErmu4rU8FxX4OTNkghsJmk6swet1j3cCPc9NOVMN4uTLCa+a4JlawjbrSlLdH7ApSAR8Ek8N0GTDZ9oim1XCJm5cwOrSlEMd/CW8ZOcjZyyf+d04M6xadDxkDzO+DZEnKHJ+MkydZPjakU/6HWVRA+/XxfH6BFd1pnvydlALyDpkoqkwg25C/EARuyvK8hz6KpYP6MQuL6p0lwQancSrlAuViLq9LorAp0SWVe8VTLhU4708uPVzx8uX4sxYVWuFZklmKw0NRfItjOEEdfCfvEigAbx8pTE2XjCyvVrr1oo98QoglHER3OhlLge5Ib6BYvEOao6m50GKS4kNOrmVeHBUN2qiNbP5sLaFJw6NC1YsSVr417zWslNhTbukA6dwvpofHGkqYRRhjBNriL3iOJ6VuglK3p9qxB/KbgVmcrc7OslKZxprwN3dCdAASAWMrJsrW+e3PHzK/yoA8Md4rosA1kil6P+giwovPbNctT4+cSvLsdH82GisRDXhwlX94TFOhqFYiCCSRxb9VchKHQoVa7HGTLtm8W6o0l9zgi/266I5Lspfe0DVrJ8J0gM44JJDmlZZ1QTA/CZ0KXtJ/Ys6sInNN2h+FTTmW9f0yliUIZxYL9ZZprQpwl9VydsLr9b3Ciw6EgadOA64ALgcOF/rgS5oJXa6HitrfzMvsVjaPkIICpzsbMDd3GwKIL5X4IfEHVJg1JNqLx8ZYhrkfOiFa5mrGI/YdmCq/JGMRbWJbs5ecv9LFps/2j6ksb9xbbLqYnm37tKP1JJ/jh1939U8TaV5kesNDlOpu3L88XnF8dFR1M/2P380evqyWtdGfH42efi6PPyqWSSipKAjZG3OdXUe5sjzdXNScsfr+AnnnIF4UYBbRg3loytqoxmkUwp17jWBBOteFtjpmRKqLVB8R5PuT7Mkph0U9YxGiegQTGxQNNyqCP6zIQ23ouZJaexg8QUbXRtM+6taK5ggjZZNcUHdJomQLBQl0lHR/Dsc5y3mxeIlzMKN3FUhCCg4HSaGTorD7GzqZAI9GfiNNQ2yFw5RdNpVGGLmAFpOaqoLZQApEKT+61kak9HtGOOZrwSjs/MhWi0+XY5TE9epP6CWrlSkXMV5R89NZYajud4Iwd8+tyI+lysBYCFqjLD+8HlCkcwMxZ6BaoZJ+NWPsi2iBZMqLFz4bPV7DTbPjc6uE9tIzrzCvPalxVoPMpPvZ77sGspTu8XbxL+jz7xynOduqvWjLYUyciZ6whdb37tPdube+WnYmV3jl5uQh0+ht/f06YUtasPdBt0tONxfbPoRLn7wwDenOL28IuiTZH8bYjP3zmUux+rr3moQXYj3IbXk7Q3lU2Is1Pa+vOG+QduU7efksg70gg/D7yP+I+LeOYUBRHfv/eK3UnQOL7079/RCMJ8 +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 objectrequired
+ +Notification successfully acknowledged. + +
Schema
    access object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/add-access-request-recommendations-viewed-item.api.mdx b/docs/api/beta/add-access-request-recommendations-viewed-item.api.mdx new file mode 100644 index 000000000..f7f12cb2a --- /dev/null +++ b/docs/api/beta/add-access-request-recommendations-viewed-item.api.mdx @@ -0,0 +1,87 @@ +--- +id: add-access-request-recommendations-viewed-item +sidebar_label: Notification of Viewed Access Request Recommendations +hide_title: true +hide_table_of_contents: true +api: eJztW/tv28gR/lcW7A+XBKJelp9AUSi2U+jgnF0/GqCO0azIlbQXcqnjknZUw/97v5klKerhx+XS9i5VgjgmOTs7MzvfPJbLey+ZqlRmOjGD0DvwZBj2g0BZe65+yZXNzlWQxLEyIZPYv2t1p8JBpmKv4WVybL2Da2/QHwg3SBSjxNIw76bhhcoGqZ7SNea5nGgr+mcDEeBxHisrpDBJpkc64CEim8gM99KSkQqFdHOkxRwaUog7acUtC9UU7/IsT9V8iJtb3OlsAnaYz43QUSSGSsQy/Qym/NRx+HOW5qopWLRAGiLKrRrlkRglKTioUlhcJCJUmUpjbZTQI3qImSX9MzNh1F0rN47psjhNGK7Q4G0SzryD+xXLqHVasz3m2rJIkFGHymQ6m5VsdaqwjKRIw4O0GZ7SFHI6jQrLtn62NM+9Z4OJiiX9ls2mCjMnw59VkIHRNCWnyLSy9LScgvyjorVZqs0YtJAjlpjDu7oaHHmry6wqEcXgSGTyM4axLWVANCS3+iLjaURcu8F+Z6+9t73b3upsdTrtdme33WsP2zujrV5PBfveQ8Nz9niJ2L9eXEiYjEqLs7cMFclbW4+1Am9th1213dnZa3e2w63uaG+/HcjO9l6HBHYirIqiTB4TfPqHh8cXF/88Oz99Nzg5xoPzU/y3BjFKEIslCRflWeEFw7sHj4Oa0HxJsj08vJieaef+dl13kmqJbl7Erh+UTI+yBHwdZzsFVtxCdtudVZQs8hA25wmA1WgmbJakBJwqMngbLGyw8B/EApEihWWY+Uk7Y4zyiXTRblhZv73rdzqXnb2D3vbB1m6zvb/3j5fKMAfQeQGbOZB67fYqdg4jDS8Ux2mKHOIjVyNtGgDG5bEqvw6RngRlTXMrI/0tUYTUKXV0mIRrfWFR2HfIsP44lZokVCxygIECHG91SA4ZA+3CsSR/IBWYbtEbYIlmR7yVYVWjHBbKkJVTGRAY18N6UaArozFelEMA6ao8WDOt2lVyuNPe7/ZGOz0pu3u9zu72cH8kt7ba+9v7jGK4jpVjVcexTFM5W5n6r8qoVAciSgKsyL+4uJCwPQvAk2MIAeEFIYF5vMD+BDVHW6lZyCsy9SVroEZ7e3gmersikmac8305XjKC8a8ucMcgPMsh3aICBZo7xqepHmvzVFg4On7Xvzq5pHhw/Ler4wv8RrxW4kIfBZEJyS0hKnxhktyxxIUCVD5ZFcEcVC6+Kbi+gULS2Dqhdld2ZinuhWok8yjDiGL2NSPqrMUoTeIFKDFuvmTilW6qZgOBFPcQEoKJGEqLAVzvKvGGUD7N/JPCkm/ERMlQpa+boh+GmpSUkQAawRTjZ1ShomAn6DoGI1cBU02b5BkX1IFaXIu5KRdXYx5qTuqLQuCA5M/7CaJQDuFYzToKK28pRCzWBzI7yy1Kd1kzGpt0ZjJKjqBEYg+SFNkHkSmn6t+KIhzRclkEHlPSVRGrHkE53L13wrgAiXgmc/sC3J1FCD8+q1Y9uFUF+Cw1Ay4a8WqUy1REJDwktXlwQVUtVwl8MdIqCjfY3WB3g90XYnf54brSZ03bcGVkDvumnDxXSp+UvcckoiRyzYVbyIaAQYoS6ccPlwD2Z2WIXn2ZUhf0Desjl8pXhO9X6+HuD8v2oUz987UgAdmOToMRIpEKD1juucRsKGeqrdXZ3iXpUMNBzZoSEVEzFbMk5x2PNDeGJJG2IcJEWfNDJibyVlU7F4nbfUG96k8TbbJNJbmpJDfZaJONvp9stKkkN9jdYPePid0nK8lKKkZLUSfZPI5lOnOeVjznnUgBAlHuXYsKcrxUy9UKMRNVjeUtVg7esNsZdka7geqFshfubO2PusFOV27vdnY7w15316vn+us5jiuQLWKqtt5uHdnEKOJuUcflBs5lsyQJF7f/YN5UjSisUeip6mbYHCa9qWrH7v6ad1hJIt7Tm7CiQrILNaSZ24hiGmhjok1LWhBIMUZcNAKhSkMuciUdK3BJ4TQi0rFm8JIW4JvO/P4ogyoOKKWTVbNoE0Q5JORIECVUNSdwLA0l1YhqPnDgCnaM6PwNq9NiiX5TJS/OSeMT0lgcfwmUIqBXlfv2uv3dAYRPKUZcuAV+ZKPXdTvSwAHQELiYVdWdm/p8U59vcvwmx38fOX5Tn2+wu8HuHxO7v6I+L6qhx+tzELy4Pgdtsy2qWuodOdd/vUxnqBQSsHuLJAjylLebyxqc6wq4Egk0TSwHEZlNcNWS2nebsH6xXP7SabSWOyHju3DU8FxL4ITN0wg8Jlk2tQet1j3WEGv30JRT3SyPsZjkrgl+rSEMtyYm0eEBhz8i4ON+boImWz3V5NguCjJztwasJ7kw1oL3i5/kbGTMiztLcsQ9ZtOgsyGFk/FtiDhFh/GDZeomO9WKftDrKo0efrsujtEjuqwz35OzgV5A0iUVSYUbWi44Axjxel1BnkMXwvo5rf/1TZ3mgkp2J+EK5TwNUZvXXRHolMi64q2SKR9+pDcfr378cPlajKlQ5UCRW6qRlabOAlA7gxtxIOyXbwFoEOemNMnHE1auv/CehYAnRhGMIj6aC6XE9aAw1E/IEOcI6Wx2GqQ4itCom1flCobqVkWUPJtza5Nz6tC0YMWWXBj3mhMldxTauBM6dATro/HFkab4xWdHiaZQkRtEcT0t9ZI1vb5WiD+V3EqYMjf7ekkKZ9rrwJ3bCYB+YiEjy9b66skdP7/Gj9ov3CGuyzKQJQo5Ft+OBeWqfbUcC/x84rcox0fzYaKRhReHCRf0hEUSjUIxEMEkSaz6ixDkOgSV63EOpH21WHc0qc+I8Lvtmki+m9LXPmpKlu8EwDDOmeSQcjqXNAmqPRM62H7ilUVc+ISOOxSfFnTm29dIvUQZJoH9aplpQp8m9F2csIX8LrORY9F5NOjAccA5wOF8/TkSFILWYqPjtTbyM/sWj6H0EUBU5mKnB+7iYB4Ei98EPyDqigahmkry6n0hrkXBi9LbgrHKzYRlC67KGyXIqkt2c/JWm1mUaX9v+pLG/fmey6mJZt86Sj8SSX4/cfd/FPE2keZ7jDRFkUx7l+fzLy+Oy3Zm8VT38+eu68eudW3E4wefy3PPy0eSSSoCARuj6HHq0HtbVJqrO5O0dT5R+ImnHEG4S0APVn7tokSd0TSSGWGNY00w0Yr3NKZKZlS1Nsjfk5jjwzRNSDdVfDYzTkGDYGJRTcuhjuhLE9p1L2eWDGNXEpO30bXNubGiuYIJemTVFB/QZpoAzkItJp0bwbOfk6LXvIC/nJG7iaPSBVEKxnFu6KA8xM5jIeHoz/hpqG2Qu3CKjtOo0hYJF6TVqDK2EABIhSY3W2lsT0e0XY5OvOaOz8wFb7TFXjlMT6tI/QX1cZUi5yoqPoFqLDUcz/EGBvyJiqbU5CIXoCxUtRneDy5XOIKZsdArUM0kHbeKQbZFtGBCjZ1zn61mp9n2udHBfeoZ0ZbXmP9U/xALjYf76uu5b7yWnPR+/g7h//trrwL71G21prS/SEbPXYfoGvVr79lGnZrMequOxm5CvT7G3t/T9hT1rg90G8Np7+P6Zt6WciuIAbxNxb3iZ0XbI8V7EZ+/eKj2QVZf+FC37Ea4ra8naW9q2xFnp7QJ6A2LD91it7OSyjvcpJ8H3kf8xUUydVqCiO/fe+U+JWgcX/rzb0zcy+w= +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 objectrequired
+ +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/add-access-request-recommendations-viewed-items.api.mdx b/docs/api/beta/add-access-request-recommendations-viewed-items.api.mdx new file mode 100644 index 000000000..8d93c1ab2 --- /dev/null +++ b/docs/api/beta/add-access-request-recommendations-viewed-items.api.mdx @@ -0,0 +1,87 @@ +--- +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: eJztW/tv2zgS/lcI3w/bFpFfcZ7A4eA8evAi3eTyuAKXBldaom22EuUTpaS+IP/7fTOUZMl2HpstbncLt2gaSeRwnt/MUNR9I56qRKY6NoOgsd+QQdD3fWXtufpPpmx6rvw4ipQJeIj9p1Z3KhikKrKNjUYqx7axf90Y9AfCzRL5NLEwr3Gz0QiU9RM9pWssdDnRVvTPBsLH4yxSVkhh4lSPtM9TRDqRKe5ZlYp4JJKCngqEdEsl+VIa3Ig7lShxy9w1xfsszXCZ1HkQdzqdgKyyiufQjTAUQyUimXwFXX7uaPw1TTLVFMykLw0NyqwaZaEYxQnRKNjGRSwClaok0gZ0R/QQa0v6Z2bCqLtWZhzRRYaaUGEuxEEczBr790s6UqsEd8yzfipiM2dgVQfKpDqdFdR1omBYkmejAaZTPKWV5HQa5qpufbG03H3D+hMVSfotnU0VeUOSyBno8IqV+/Hwi/JTPJgm5D6pVvy0WJo8qRxr00SbMcaCv0hi7cbV1eCosewPqmRdDI5EKr9iGqta+jSG5FHfZDQNiWrX3+vstne3dtqbnc1Op93u7LR77WF7e7TZ6yl/r/Gw0XDqegnbv55dcAivrBgELkL8Vsy1kuHNraCrtjrbu+3OVrDZHe3utX3Z2drtEMOOhWVWlMkiirP+4eHxxcW/z85P3w9OjvHg/BT/rQgtJYjEAod1fpZoQfHuwePhT3F/Sbw9PLx4PI+d++F11UlKE928iFzfL4gepTHoPjjSdopYcpbstjvLUbQARcJmvASCOZwJm8YJRZYtwKOxjpJ1lPwOUUJDkQVTrPyknjFHeTS0rjdY1mvveJ3OZWd3v7e1v7nTbO/t/uulPMxD6zyPp0qI9drt5ag6DDXcUBwnCdKOh3yPlGsQSS4Dlsl5iMQmkES1uZWhflV4PeKPSLpSh4dxsNIZ6sy+R272xonUxKFiln1MFKB4qwPyyAgwIBxJcggSgcfV3QGaaHbEgQzKOucwF4bUnEifonF1XNcZujIa80UxBTFdFhYrllU7Sg6323vd3mi7J2V3t9fZ2RrujeTmZntva4/DGL5j5VjZFbhUX/rvyqhE+yKMfVjkv1yWSOieGeDFXw5lTOMF+qdYc2NLMXN+Raq+pRuo8w4Oz0RvR4TSjDO+L8cLSjDe1QXuGOC2HNItqmkguSN8muixNk/hwtHx+/7VySUBwvE/ro4v8BvRWgKGPmooE5BbglX4wiS+Y45zAe6QK6wKoQ4qNd/lVN9BIGlsdaB2V3ZmCfgCNZJZmGJGvvqKGVXSYpTEUS2UOG6+peKNbqrmBpAU94AJ/kQMpcUErpmVeEdhPk29k1yT78REyUAlb5uiHwSahJShQDSCKObPqLZF1U+h6wiMXPVM1XCcpVyU+6pui7kq69aYY81J1SgUHOD8eT8BDGVgjsWsRmHpLTmLuX3As9NcnbvLitJYpTOTUnbESGR8P06QfoBMGbUOVuRwROayAB5TjCsRqwqhDHcfHDMOIYFnMrMviLuzEPDjsWjlg1uVB5+lNsKhEVujMFOOSHhIYvPkfFRpriLwxUirMFjH7jp217H7wthdfLhY+1Dps6KhuDIyg34TTp5LpU/C3mNiUQxy2xnOkBsCCslLpJ8/XiKwvypD49W3KTVI37E+cql8ifl+aQ93f1j0D0Xqn9uCGGQ9OglGQCIV7DPfc45dkciq2lxe7X2cDDUc1KwoEYGaiZjFGe+VJJkxxIm0GyKIlTU/pWIib1VRmjMC0qom8KaxNum6klxXkutstM5GP042WleS69hdx+6fM3afrCRLrjha8jrJZlEkk5nztPw5b0UKDBDFrrYoQ45NtVitEDFR1liNeuXQGHY7w85ox1e9QPaC7c29Udff7sqtnc5OZ9jr7jSquf56HsdlkNVjqmJvZ0dWMYq4W9RxmYFz2TSOg/r2H9SbqBHBGkFPWTdD51DpTVk7dvdWvP2KY/GB3qHlFZKt1ZBmriPCNIyNaGxSjMUAKcbARSMAVRp8kSvpSIFKAqcRoY40By9JAbrJzOuPUojiAqVwsnIVbfwwA4eMBGFMVXMMx9IQUo2o5gMFrmDHQOfvWJ3mJvpNlbw4J4lPSGJx/M1XigK9rNy3Vu3vDsB8Qhhx4Qz8yEav63akgQOgIXCYVdad6/p8XZ+vc/w6x/8YOX5dn69jdx27f87Y/RX1eV4NPV6fY8CL63OMbbZFWUu9J+f6v5fpHCo5B+zeIvb9LOHt5qIG57oCrkQMTWPLICLTCa5aUntuE9bLzeUtnGNruaMzHsNRa5iFXz0fYJfSEQXXHjjGsyQEvUmaTu1+q3UPe8KOD0051c3iTIuJ75qg3RpCiSvwiQ4SuFikAXx80C3QZAskmpzcISITd/ZgmcmdYRfeO36SspERG3oWZ8BAJrNBB0Vyh+PbYHGKbuMny6Ob7GBL8kGuqyR8+O2yOEKPyLJKfU+uhvECnC6ISCLckLngGCDE9roCP4cOzvoZ+cL1TXXMBZXvjsOlkfOURC1fd4mhUxrWFQdKJnyEkt6CvPn54+VbMaailUEjs1QvK01dBsLuDG7EoNgv3gjQJM5TSZyN+WSn6NfeuVAQilEIpYhP5kIpcT3IFfULssU54J3VTpMUIwrNunlTWDBQtyqkRNqca5ucUwemBS22ZG3eW06a3F1o447r0HmsT8YTR5qwjA+f0ZhcRG4WxfW0kEtW5HotE38pqBUhy9Ts2wUunGqvfXeGB8HKapGhZW29enFHz6vQo1YMd4jqIg+kiZyP+psyv7Daq/mo0fOIXp2PT+bjRCMj16cJB4DCIqGGgRgIfxLHVv1NCHIdCpXrcYZIezVbd7SoxxHhddsVljy3pKc91JfM3wkCwzhnkkPK71zexKj8TODC9jNbFrjwGd13ID7XZObb10jDNDKIfftqnmlBjxb0HE7YnH+X5cix6HAaZGAccA5wOLc/I0HOaAUbHa2VyM/kWzyH0ocPVpmKne67i/05COa/CX5Ao8sxgGoqz8t3h7gWOS1KdTVlFRsLixpc5jeMkWEX9Ob4LTe2KOv+0eQlifvz/ZdTE86+N0o/giR/HNz9nRBvjTQ/ItLkBTPtY57Pv984Llqb6/oZ7+dPYVcPYevKjMePQRenoBcPKHMRR2HA6sg7nmrwHeS15vI+JW2k87cxeMoYwj0DOrLyuxlRJTQNZUrRxmjjT7TiHY4pyn6qWzfI4+OIEWKaxCScyj/AGXNrkECVEj2pDulTFdqDL1aWHMiuKCZ/o2ubcZtFa/kTdMyqKT6i6TQ+3IUaTjpFgmdf4rzzvIDHnJHDiaPCCVEMRlFm6Nw82M4iIeHqz3hqoK2fOUBF/2lUoYuYS9JyVoEuFAIkQpNbrySypyPaPEdfXnHIZ9aCP9p85xyqJytSh0FdXSnIuQrzj6o2FlqO52gjCryJCqfU8iIboDBUlRU+DC6XKIKYsZDLV804GbfySbZFY0GEWjvnPpvNTrPtcauD+9RBokmvEP+l+mkXWg/3IdkzX42RHxygnVx01vv5m4X1d2TuO7IcDqgDa01p/5HMkLmu0TXy141nG3lqPCutPC6rzTyQZUI7A6B0f0+bWdTdPtBtEKOdkuubeePKzSIm8KYWQ+JXRZsp+VsUjz+QKHdNll8PUT/tZriNsifH3lQ2L85OacuwMcw/qIvcPkwi73CTfu43PuEvLuKpkxmD+P59o9jVxBhHl/78D6wn9B4= +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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

arrayrequired
+ +The recommended access items that were viewed for an identity. + +
  • Array [
    • access objectrequired
  • ]
+ +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/approve-access-request.api.mdx b/docs/api/beta/approve-access-request.api.mdx new file mode 100644 index 000000000..3f3bdc465 --- /dev/null +++ b/docs/api/beta/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: eJztW+lT20oS/1emtB9yFDK2MYf5suUAecV7JLAcldol1GYsje1J5BmtDsBL8b/vr3tGvgmEpPblpZykUrLU09P3MWrdBTZVmSy0NYdxsBvINM3stepEkcrzU/WfUuVFsBYUsp8Hu5eBuy/8A9FhaJnkwdVaEKs8ynRKqIDofKBzoUycWm0K4dHmQhohHY7M45AeR00cm2QkioES9saoTNge/6ieY2ksjk9/+3dn/93he1HmKgO6DABJYm9ULAorwErPZkOsw+YyIlJqoD6VmRyqAgvAw12gib5UFgM8MngwZlsmkMFakEcDNZTB7l1QjFJ6mheZNv3gfi0gonWmIKkiK9Uiz0roeJ5wokDdymGaEK5m1G7s1He62812q6vkRr2Bq82tnQj/6vWmCu6v3DaQzRsbj4iM2V1O1bVWNyp7kYvIDofKFLTDhLIe9AHSImsKPKP1oCTRESt5/XNOSO4WmbTdzyoiXYNqyLHQKqenfotFaUB2ZZLILnG1TBh7bqHwdMxKga2DdDRhAdKVZTGw2eM0uaeLBM0SsH9+LAii0offCaBQEl0UIybKlEMy7cP9g/fnh+f/JFOeEDq+C/J0/Pimh/uPbTdvCaT7zWY72qo3cBXJrV67HjU2Ghu0pTPPRznVeZrIkSDoJ2/fieVQ/KGMUTCy+3tsFmVKFmopk+RVEkYQxIAICw2qFojAE/ZRelptL24krNThneMehh/Wt8NG47yxs9va3N3YrtXbO/8KiBJQy0DehvYLGzaJRvbAPLUmd4bQrDcX/YNiVIr9RIg4VZQZGBTaCaWKOURVXnIc6sGIRxyTeA2ClWXQfJQXakg0P9ORHLmtemORwgvjLF3/dxmVCGnwDGNFBcT7iYGSscrWhM0qbn7/cI6g90UZgle3Kbn/dxA872Uqy5wzzolXDCE22VfC3e+SiRE5Dn5ax0QgAqCOHQc9qRMV7zLdE4pZUE5UG4u7vbVZV8cw4CXapBQgRrbkLJCVxhAlMl8TsVW5eVGIgbxWVbphtbqUFHJO+oGSilUB1vZs/ARffauNCvuZ1MQIiwy+EitBuULHxMHQZiRbQlk5M8PN+k+rXq81xBsZj5PxnmeG/CeT0RfgOnxCxLowGutFtYQSGLz9oW3VtpLdrXq72epttaRs7rQa25vddk9ubNTbm+027e7tYypUBzLL5Ghh698U8ryORGIjWAk5AyJFTpYCAipz0nDD/HEdMI4nyJ9ytIMds1nZc6FuizWkpDd7J6K1LRJp+iXfl/05IZjw4mwhAYJzh/g4031tlpFS5Zr9g7edi6Nz3Dk9+MfFwRmuCNdCEdWBa5uYzNJyPTSwN0yxZ4DDmEogDji+eO2xvgZD0uTTgDqfimmwrZ4skwIr/O5LVkyjFr3MDmfiJ/vNbSFe6pqqrYku3UN+iAaiK3MsgAoJ/LULxeGRl+RrH8Re1UQnjjUxiboOEQJIsX4ERELC2SkMM4JeCY8HMRqBsCwQEwsdqVldTEQ5X45USeRoWinkHKD8cTvpREUJ4pjNaS8cW4sn0esHNDvJzdc5c0lnZAqqSwGJrBPZLIOERRe86SKvSiVSV47AYyo4bTiK1mZy4wFR884RgwTJzyJZ5k/wu5ME4Sdk1sYPrpV3Pg6VLhqxNio1+Yjk0yMv9lBjdVWOL3paJfHKd1e+u/LdJ/ru/MNTX+by0zFV7C2+TsrL4VBmI2dp/jlxKwUARFUmi7HLsarmqxVCJsY1VjBbOQTdZqPb6G1HqhXLVry10e41o62m3NxubDe6reZ2MJ3rLyd+PHayWZ+a0rfTI4sYRdw16rjSwLjywtp4xlpJvJnqUVij0DOumyFziPRqUju2FmvH97YAb0CM2jF7oBO4OD0i/HSWQOhJbrbMIkVlthMdwGXBJSXZMCSt+URkVTquSsdV+lmln18j/axKx5Xvrnz3r+m731Q6th4rHVvfUDq2BJVYPSqx/szSMUbdQaVZD0qhNwolxGuobEzBCq786aN3+0JmfVWMC72ZKrLZXqwiz60V76QZVcVSPnMSaSbiovAG2CHBZhUsAKToI0QaejmlrXs7RCfkqEnpxDzRQ81+TAwBbzYKO70CXDmfqextvIs2UVKCQg4KiaWzVwsb0zAn1aPyDxj4HLSPQP0Dzzi9tr7rPFicEsdHxLE4uI2UIp8fn/9u1uuL2A9BfEbh4szpmi38oTNzadBGqNvUha9xCboq1Vel+irdr9L9r5HuV6X6yndXvvvX9N1vKNV9NfRwqQ6AJ5fqgK3VxbiWekvG9X+v2NlVPAVs3sJGXKvHkxqc6wqYEhGUWj5o5UGt3WDdvccPva7CaroqX7+bDG/dr/tBM6xzzYGjtcwSoBgURZrvrq/fQYVQ3X1NprpWDccYe1OL7HC9C7ktCUluXInMiQBE5+TQdx81Fnqmya5dEGTkTgXMJlkwVMFDB1/FXI3vjNCYCIdmjSaYvI3xbZCYosF4kTN0jW1qgT/wdZEl99/Pi0P0AC/LxPfV3QAvQOkci8TCFakLtgBErK8L0LPnIlinJPVfXk3DnFHF7ihcgJxkIXpX0Fwg6JjAmuKNkhnaCTc+8/L3D+evRJ/qVI4TZU4lstLUWMDTTmBGHAc71SgJLeLUlNmyP2DmOjPDOuR3opdAKOKjOVNKXB56Qb1HgjhFRGex0yLFQYRWXb2sNBira5VQ7qxNpE3GqWMDC9frcmbdK86T3FBo4ya1aPDxownFvqbwpSnfE4xnkftDcZlWfMkpvp5LxN8qbKF3VMaWv5qjwon2Mko0zwbC+QkF3Jil9ezNHb5wCh91X7hDWOdpIEl4OmZHrKJKa8+mYwZfSPhm6fhoPgw0kvDsMuFinsiRQ5NYHIpoYG2u/i4EmQ65ymW/hKc9m6wb2jRkjwib9SmSQrdlqEOUlEzfERzDOGOSXUrpXNFYd7jCbvuJNYu48InH/T7N8My3L5F5CTK2Uf5smmnDkDYMXZzIPf0usZFh0VwieHBjqmwAexP9cyTwhE7FRodraeRn9Ou8htJHBFIZS57uuh+7kyDorwQ/IOgxDEI1VeTjoTP8Fh7X/XjE1QurOkuYl+AivYlFUp2Tm6N3/EaUEu3Pxi9x3JkcudCA94+O0g9Ekp8n7v5JEW8VaX7FSONrZDq6PJ18I3BQdTNT4/rLRuyXTNiP59vdePvjQ+njTyZm58enpse/MtqNTeAovL1vg6bd842vRhcPL+l0faDwP55ylOFGAm0aN55cf00jShNZuO9AEI+igVZ87JGCPqps18gn7JBjCJoFClxobhlRn3nIIGyJRlUnNDRPB/PVzpJd3ZXNZJH0Oy/9mIiFM6GNVjXxAZ2oiWBQ1IXSgDKefba+HT2DTZ3wRzH7lZkKmnMvDXajiFIOhYQzPGLLsc6j0oVcNKVGVbKwXLSOV1Xxh5yEWKhxP5YN8+MenaijWZ8y2Uf2gsXm/jgdoictelOYMHKqEvYpgpttSh7DDT8JBypJyUiQL1A6qqkd3h2eL2AEMuPf4disv+4X5esECyTU/Dnz2ag1avWQmyHcp7YSnfsU8s4TPk6at8m7yVuFn+pTJ+/W1A+tp3QASCyXrodznfRl8FAnjeW7Mx9CVc00Wq8BNeNYe3dH50fUXd7TbWCgw4nLq0njyA0ctErXk6+RHhTey1P/4dIrfgO2/POppVxVh59mNDn3CHD5RdFxyRQj91eAdudaTJwD8C9SwvMRVzQVgoU3RNRfuxXurOyrsFdT5xcnx3RqGHT9R1xDdxSTyRvcpP93g4/4ix82dS4DIL5/F1QHm4BxeOnP/wAFa2v0 +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Body

+ +Reviewer's comment. + +
    author object
+ +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/approve-approval-item.api.mdx b/docs/api/beta/approve-approval-item.api.mdx new file mode 100644 index 000000000..48c2ebd08 --- /dev/null +++ b/docs/api/beta/approve-approval-item.api.mdx @@ -0,0 +1,75 @@ +--- +id: approve-approval-item +sidebar_label: Approve an Approval Item +hide_title: true +hide_table_of_contents: true +api: eJztW21z2kgS/itT3Ie8lAVIgA18uSMYZ8kR8GGc3J7XVTtIA0wiNJxenHAu//fr7hmBBNjGXGr3dotPCGmm3/uZ7tHovqAWIuSxVEHXKzQLfLEI1Z1o0Q/3u7GYF04KMZ9GheZN4bMKvzK8FxVuTwqeiNxQLnAuzBzNZMRal11mSESMByylQ5OKrCPjmQjxAffmMjhhKmRwh6lvgQymJTcJQxHELIlg0DyJYjbnXwWMAMqh+HciorgI0ix4yOciFiHKdF+QyH3B4xk8CuAB/JMeXEfuTMx5oXlfiJcLvBvFIXApPJwUkJgMBSgch4nY1kSw7jlTE5LtG+ostR3Edz5f+EhLTCr1SaNaqZ6JRrV26oxr43G96lR57bTSOPPqwGWnZDxj2O4PlDKlS5IWc6Lajm2PXc4r8OuMXTE5tR2He2PHhmubu4WHW+QVLVQQiQglccpl/Mnza60tETFPxFz6EVPjL8Ilp7gqiMF3OA9k8aVLMVX6EuHk+2019Uz0ZogRGEvNGjy3ZYpNzZ/zjeM27Hq5Xql5jqjZp/WyXfMqzqTeKLvcrtXt1LYQTiLsvojhatrhDM9ltPD5sk/x8BxndLKnJ2AAPS3GBzUL2NUccgwZQk7tp10+kGjai7WjWfurlNVlm+EHDkGzVsQNBY/FTkUmKpxziLmCByOsWAL/nORl+8wqn1m2PbLrzWqtWTkrlhv1fyHVufLkRB5Ktm6VTy2nNnLKTcdpOvWiXa4S2Zyue3l3fefpqG6TGRh3XZUARsLwSCWhK9ir1vkrZB3F8HwXUxEkc0Tvi26/e/VT5xxuDTsfOu2RuRxdD/t02fnnZXdIV5ed/nm3/x6u2q1+u9PDm0Hi+7dZiTL0tvUiaVAjntMnljHNxZUEMfCKhAbptdCPC3/d/3t/8LkPd953+p1ht42ydYaj7kW33Rp1B31S5WPnvJv+Owex36d/WpeXw8GnVg8uP3UHPbo97Hzqdj7DnYvB8CMqPeh12z+vHiODn1q9Xqf/vgPX3Y+Xrfao1W/1fr7qXsGNq+77/uDiAu32qdMfwe/HVv+61YNRevaoczUq5Cy2Fn3bYKj4rgjYtNgIDUSAMhee1Cs3rcg/BFvzYODi5InB8heDQszDqYhfDkE5rkxTOZD5YZD0rABfAGmLUQpQesChuP4yzrCISr/lebBeR8g7s9Yepmt2sdaAkuPXcmN5J9g51CFurMIl8YyB9DiJxYEc0+lsLGB8qrPwcowXMxWIfjIfw+KQ5TlIy9X9GK+q290WRiNnRcqJkCw8A06r55+4n+yp8h0OfZnONduxarWaBRWbg2wDjsbvelBXyXi5r6XJYdJMSgXYFcS4zOooBm4Pa6QZ5pHlXNd6JtpW1esPBJxc8foqAih4cbqbZXFPfmYNDcVEQMPhCo+Nl9tl9BMpn8ma3yTlgr0zbRVpYEea9RR6qJclU5b2eurulLnbP1OyZPW0LEn+t3HRVfM/eoWTya9sc51Jrv19vGK37eGWCW1dLVL5rPDRwQV03bLLlt0Y2ZVmtYEFdKVeo0oXTL4JAxJawCkV8zsSgKAczaU7SBk8XuvaDaAvwlCFWeo8DPkShskNruuGeUXgZsNMUFvEMx6zbzxi0UK4BL30L1Axm4DFvGLhNuuj1HvgmQe8X93VErd9idsVHZSUWWwo4iQMgLDMdWlsrLwlk6gyOF16P7Bb1m14W3l7BM6FDIQ1DblECcm4zIWJDGNRergozVUoTGefQhWNy28ngCWKNnvHPdBX69c2yqD5Qu5+BVr7FH3XgYT5LJ0CSxZ4InyMrTgTfHxabjjVyWmVc6detc9q48aEVyrlRq3RoJ4OYI1Pxa6gybN+L6DnlC7zlQse+Q8YBNIFm04UgJjviLNHfEA09kxcPXalppGXxeJ7fAIw8q59yapnzOfBNKH7fLphhMC6xtYDgYqP8RbuDIHmmvAglFO5E8tTgDzvXLSueyMCxX9cY3+Sgt7GZk8A0ephWCrK2Zn6RhIbBSiPhA/mEF6RvTVU34JCPIiyA6X+Fy0jTENPTHjixzDDcN8xI0uaTUI1z6US5c33mL2WRVE8gWKK9ghjd8bGPIIJpp57CzAoFrHVM5Z8y2aCeyJ8U2Sw+klUEtZ4WmsimL8EQox7HqauJjBJIJVBGFjuVRIjSkhX5H2xNmXeG2sM6WWdgskBkj8fJ7D8JyAcqZnNwlW0GBGNf0Bmbbm8dKOM0cikyyDmUFjASH8JZgyxuGCw6AJARszAEborAuAJ0nErxMpCI8HdRy3MeazomcuTaI+8u/QBfixSbfXgTpjkgzBQBo3IG6mbDCLBQypkcbIZtXJXmvgMcN33jrl7zN1j7u6Zu5sPh+ZFgHlKpU9lu/S5UOFYgtWDHXUPvb5ZqoRxcEOYBPhuh/HohHlKRMGrmM34HTVhIIdOa5BdBJ61UFBBHsujY3l0hNgjxP55IPZYHh1z95i7f8zcfbI8WklF2WLqpCiZz3m41JFmnutdQhjA0nMWbJVyq43SbLWCxNiqxirkK4fC2LHH9uTMFVWPV73TSmPiuKcOr53ZZ/a46pwVsmv9zTqPV0mWz6mMv7Uf9famCO+gjksCCK4oVsrL72kltH2OsIbQwxOIphBKBbA5mPT24SGtHavbtWNfxaAbEIbaMXxkz+x62NPb85o82k2/7cakJdPpHT0sKWkTT3yXUXwsHY+l43H5OS4/f5rl51g6HnP3mLt/zNx9UelYfa50rL6gdKyyfvpa8/csHT2oO+j9KjgFdEhPd4diAarAlT6Ck6a9PqGyKvTWVSSVHxBxKP5CUZFHZ6qbhRK+4bUIkUr30nsomaPnpfv8MesHmKJl0koloQ+zZ3G8iJql0j04GZz7UOQLWUzPzQTqG546KI3BsjtAC9/m6gTFAXTsXTMokltCiZGvYZKIaydRnmOMg7Nor/NJyumRkSXYg2kyJ3hK0EQh3caX+zxYmrMeRYq6Lf1Ar+vQf/jfddGEHtFll/me5AbjGUi6oSKqcIvugnChQ0/gr2uQp60xrpWg529us2OusKbXEm6NXK9T2KI4WwINcJjD3gkeQsTG6qsI2OsPn0dv2BQrWUKSJMIiWphvF9glhBEhZSvdwcZJFMWhSqYzUq5lGiId45iZbOKDUdgvwZUQ7CY91NWHJWQImE9mx0mCYAZn3b5OPeiJO+Hj6lpcWxuDU3oBhLws8dy8N5RS1HLIQB/wgLvFXwLLnCmSWBHgGKMibc+zm0WqF8/odagQf0mpWZqaRdSiNxtSaNPeuPoghRsKMgv3I7LWwcw1PStDD/szuINUN2VASxg5eM5rbuq1g+XI0bOQXl6OX4LPMwnLdH4a03DHIlhlfY91mTtTKhJ/ZQxDB1PlZppAph0s1jdkalFGWE45I5KlWVrSgqKT5OtBYgQ6mPgYF32qeZTGdErbX8mzgAu/Mg73fs3pTLdvYG3GkZ5yo4NlRoYWMrQ0TkRGfvMlCgiLx5lAB8IBHQDttf8JCYygGWzUtHYiP5Ev0RxcPlwQlahEi6b+01yDoLli9ABHr8YAVGPNvnrXBf+ZoYULW85Y6W7DpgW35fUVrL4bdtPyrjZicEX+f9MXNW6tN2UGgb/80Sj9CJL8/+Du74R4R6T5MyKNKY8x3IitaTeyQf7O1HTbm4QRflkJhTg+pVzF45vQK8TU4FEVkyW08HmMUU1Z7c6koO2FheAx1ocnGFlqTpkIpTemPzSRRGhKR1FDEJlDQyh9oFdkozVnTgmji0/0K/6PErPHqyAkoV0VRfYZOr7ABbdgt4enC+DZF2XavivwzCU6lp2nzoaiaz5PAjwDD2Inc8YhpJ6JCE9GbqKBC5q/QKS2UFT6rWalWYyhhioUqf0J59FgcgWVMzTFGcc/wwv8HpltazA9etF8KbpWZCh8ikwcly/tn6MN0WbNhL/AfhNQFwowkeHwsTvaogjEAtOAqXBaMpOiEo7FU92gvA6fStEuli1qKeA+9mXQIWeI60POYusj4M04vF/v2P+GnxCb5Qb7hNICt85QiUT3Nrq5vCmsm0uY0KRPio1c+H/jQ15oR2bYm8K8+3vcdcGO6wFvA09s6W9u180UNTXgI7yGrnYCqLH5eW/WLK+H5kPgN5g2j3yavFOjdMswWK53Cwpw+VXgJgOohN3iDxBk6+vjA6TZMCh0/2BS2p8ic+lBegcrM33rHQ82hqvtgsvBFYTtw38Bo6G2pw== +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
\ No newline at end of file diff --git a/docs/api/beta/approve-approval-items-in-bulk.api.mdx b/docs/api/beta/approve-approval-items-in-bulk.api.mdx new file mode 100644 index 000000000..990a40fd6 --- /dev/null +++ b/docs/api/beta/approve-approval-items-in-bulk.api.mdx @@ -0,0 +1,75 @@ +--- +id: approve-approval-items-in-bulk +sidebar_label: Bulk approve Approval Items +hide_title: true +hide_table_of_contents: true +api: eJztW21z4jgS/isq7sO8VMw7CfDljiFkljkGcoTM3F42VStsAZoxFifbmeFS+e/X3ZLBBpIQbmr3dotPGFvq937ULcv3ObUQmkdSBV0v18zxxUKrO9GiH+53IzEPu8G72P+aO8lFfBrmmje5z0p/ZfQod3uS80ToarlAEkBgNJMha1122RjmMEsO7liCZlqedWQ0E5rxgHFvLoMTpjSDO0x9C2QwLbix1iKIWBzCoHkcRmzOvwoYAcS1+HcswigPAi245nMRCY1i3eckCrDg0QweBfAA/kkPrkN3JuY817zPRcsF3g0jDVxyDyc5JCa1ANUjHYttZQTrnjM1Idm+odoS5AeS4jufL3ykJSaV+qRRrVTPRKNaOy2Pa+NxvVqu8tpppXHm1XMPt8gmXKggFCEKUS4W8SfLqrUmHzJPRFz6IVPjL8IlTV0VRGAQnAc29aVLLit8CXHy/baGZiaaSKODI2lYgzm2rLCp9HMKl91GqV6sV2peWdRKp/ViqeZVypN6o+jyUq1eSswKPhK6+yKGq2mHMzyX4cLnyz65/znO6F/PTMB4eVqMD2oWsKs5BC4yhEDdT7tsDNG0F2tHs/ZXKa3LNsMPHIJmrYirBY/ETkUmSs85xFzOgxFOJIF/RvJi6cwpnjml0qhUb1ZrzcpZvtio/wupzpUnJ/JQsnWneOqUa6NysVkuN8v1fKlYJbIZXffy7vrO01HdJjMw7roqBuCB4aGKtSvYq9b5K2QdRvB8F1MRxHNExYtuv3v1U+ccbg07Hzrtkb0cXQ/7dNn552V3SFeXnf55t/8ertqtfrvTw5tB7Pu3aYlS9Lb1ImlQI57RJ5IRzUWERqS9IqFBeiP048Jf9//eH3zuw533nX5n2G2jbJ3hqHvRbbdG3UGfVPnYOe8m/85B7PfJn9bl5XDwqdWDy0/dQY9uDzufup3PcOdiMPyISg963fbPq8fI4KdWr9fpv+/AdffjZas9avVbvZ+vuldw46r7vj+4uEC7fer0R/D7sdW/bvVglJk96lyNchmLrUXfNhgqvisCNi02QgMRoMyFJ83CSCvdD8HWLBi4OHlisfzFoBBxPRXRyyEow5UZKgcyPwySnhXgCyBtPkwAygw4FNdfxhkWUem3PA/W6xB5p9baw3RNL9YGUDL8Wm4k7wQ7hxLEjZReEs8ISI/jSBzIMZnOxgLGJzoLL8N4MVOB6MfzMSwOaZ6DpBrcj/GqeNxtYTRyWqSMCPHCs+C0ev6J+/GeKt/h0JfpXCuVnVqt5pTKpTKyDTgav+tBXSWj5b6WJodJOykRYFcQ4zJrohi4PayRZphFlnNT69loW1fdPw5wErIEea9CgIIXp7tdFvfkZ9dQLSYCqnhXeGy8TLJhLckTKZ/Kmt8k5YK9M20VaWBHmvUUeqiXJVOa9nrq7pS52z9T0mTNtDRJ/rdx3lXzP3qFk8qvdO+aSq79fbxit+3hlg1tUy1S+azw0cEFdN0pFZ1SY1SqNKsNLKAr9RpVumDyTRiQ0AJOqZjfkQAE5Wgu00HK4PFat9QA+kJrpdPUudZ8CcPkBtd1r7wicLNhJqgtohmP2DcesnAhXIJe+heoiE3AYl4+d5v2UeI98MwD3q/uaonbvsQ9gA5Kyhw2FFGsAyAsM10aGytvySSqDE6X3g/slk0b3lbeHoFzIQPhTDWXKCEZl7kwkWEsSg8XpbnSwnb2CVTRuHwmJsAS+RJ7xz3Q1+jXtsqg+TR3vwKtfYq+60DCfJZMgSULPKEfYyvOBB+fFhvl6uS0ynm5Xi2d1caNCa9Uio1ao0E9HcAan4pdQZNl/V5Azyld5isXPPIfMAikCzadKAAx3xFnj/iAaOyZuGbsSk0rL4vE9+gEYORd+5JVz5jPg2lM9/l0wwiBc42tBwIVH+Mt3BQCzQ3hgZZTuRPLE4A871y0rnsjAsV/XGN/koDexmZPANHqYVgqytmZ+kYSWwUoj4QP5hBenr21VN+CQjwI0wOl+RcuQ0xDT0x47Ecww3LfMSNNmk20mmdSifLme8Rey7zIn0AxRRtvkTtjYx7CBFvPvQUYFIvI6VlLvmUzwT2h3+QZrH4SlYQ1ntaaEOYvgRDjnoepawhMYkhlEAaWexVHiBLSFVlfrE2Z9cYaQ3ppp2BygOTPxwks/zEIR2qms3AVLVZE6x+Q2VguK90oZTQy6TKIOBQWMNJfghk1FhcMFl0AyJBZOEJ3hQA8QTJuhVhpaCS4+2iEOY8UPXN5HO6Rd5c+wI9Dqq0e3AmbfBAGyqIReSNxk0UkeEiFLE62o1buShKfAa773jF3j7l7zN09c3fz4dC+CLBPqfSpbJc+F0qPJVg92FH30DuRpYoZBzfoOMAXJoyHJ8xTIgxeRWzG76gJAzlMWoPsIvCchYIK8lgeHcujI8QeIfbPA7HH8uiYu8fc/WPm7pPl0UoqyhZbJ4XxfM710kSafW52CWEAS85ZsFXKrTZK09UKEmOrGiuXrRxy43JpXJqcuaLq8ap3WmlMyu5pmdfOSmelcbV8lkuv9TfrPF4lWTanUv42fjTbm0LfQR0XBxBcYaSUl93Timn7HGENoYfHEE0aSgWwOZj09uEhqR2r27VjX0WgGxCG2lE/smd2PeyZ7XlDHu1m3nZj0pLpzI4elpS0iSe+yzA6lo7H0vG4/ByXnz/N8nMsHY+5e8zdP2buvqh0rD5XOlZfUDpWWT95rfl7lo4e1B30fhWcAjokR6a1WIAqcGWO4CRpb06orAq9dRVJ5QdEHIq/UFTk0RHqZq6Ab3gdQqQCnuZ27Gnuwr30HmCYkcMoEmsfZsyiaBE2C4V7cCw49CHPFzKfnJUJ1Dc8aVAYgzV3ABW+wTVJiQPoCLlhkCdXaInRbqCRiBvHUG5jXIODaH/zScrJMZEl2IAZMid4MtBGHt3GF/o8WNrzHXmKtC39QK9r7T/877oYQo/osst8T3KD8Qwk3VARVbhFd0GI0EEn8Nc1yNM2uNaK0ds3t+kxV1jHGwm3Rq7XJmxLylsCDXBYmb0TXEOURuqrCNjrD59Hb9gUq1dCjzjEwlnYjwDYJYQRoWMr2bXGSRS5WsXTGSnXsk2QiWvMRjbxwSjsl+BKCHaTHOTqw7IxBJwns+MkQdCCs25fJx70xJ3wcUXNr62NwSm9oABWLPDMvDeURtRmyMAc6oC7+V8Cx54jklgF4BirIm3Js5tFohdP6XWoEH9JqDmGmkPUwjcbUhjT3rjm8ISrBZmF+yFZ62Dmhp6Tooc9GdxBqpsyoCWsHDzjNTfx2sFyZOg5SC8rxy/B55mEpTk7jRmIYyGsrL7HusydKRWKvzKGoYOpcjONIdMOFusbMnUoI5xyMSWSY1g60oFCk+TrQWIEJpj4GBd6qnOUwXFK21/Js4ALvzIO937N6Ey3b2A9xpGecsODZUaGDjJ0DE6EVn779QkIi0eYQAfCARMA7bX/CQmsoClsNLR2Ij+RL9AcXD5cEJWohIum+dNcg6C9YvQAR6/GAFRjnb56vwX/maWFi1nGWMkOw6YFt+X1Fay4G3Yz8q42X3AV/n/TFzVurTdiBoG//NEo/QiS/P/g7u+EeEek+TMijS2JMdyIrW0x0kH+ztZ02xuDIX6iCMU3PqVcxSOb0B9E1NRRFZMmtPB5hFFNWe3OpKAthYXgEdaHJxhZak6ZCHU3pj80jkRoSsdPNYjMoQmUPtDLs9GaM6eEMcUn+hX/h7Hd11UQktCiijz7DF1e4IJbsMPDEwXw7Iuyrd4VeOYSHcvOE2dD0TWfxwGeewex4znjEFLPRIQnQzc2wAUNXyASWygq/VazkizGUEMV8tTy6Hk4mFxB5QyNcMrxz/ACv4d2qxpMj160H4OuFRkKnyITx2VL++doQ7Q5M+EvsMcE1IUCTKQ4fOyOtigCscA2XUpPC3ZSWMCxeJIblDfhU8mX8kWHWgq4j70YdMUp4u9SX9RufFC7GYr364363/aLXLvoYLdQWOCmGaoSmw7HtJU3uXVbCRPSjSX8bUoPv+maYSMKQ+/vcYsFW60HvA1ssH+/uV13UdTNgHPwGlrYCcDF5me8aWO8HtoPft9gvjzyce9OJZL9wWC53hrIweVXgTsKIDY01CA4bfmQUOaB2RRKTdl6bYJ916oDvxxcQVQ8/Bd9c0gz +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
\ No newline at end of file diff --git a/docs/api/beta/approve-non-employee-request.api.mdx b/docs/api/beta/approve-non-employee-request.api.mdx new file mode 100644 index 000000000..22dec4d17 --- /dev/null +++ b/docs/api/beta/approve-non-employee-request.api.mdx @@ -0,0 +1,87 @@ +--- +id: approve-non-employee-request +sidebar_label: Approve a Non-Employee Request +hide_title: true +hide_table_of_contents: true +api: eJztW+1z2jga/1c0vg/bdmICJOSFLzeUkB67NHBAmumlmaywBWjXyKxf2nKZ/O/3eyTZ2JAmabdzt7vHdCa1pUePnvcXId854VJEPJGh6vpO0+HLZRR+FBeh6iyWQbgSYih+S0WcOHtOLLw0ksnKaV7fOZexiNqhSsTnpJUmc4w50ldNJYJFc8EVnwnn5v5mz0n4LKZJYHQzlKwnp8JbeYFgbzXoQqjEAbAvYi+SS6IGtLQMLTHjTGG1yFYbGnnAIkMa48oHRCKnEsDJXDAFqiyYiCogfckjvhCJiGJNvCT0Sw6y9xyFCbxJ39ncv0RyvqlMxIJJn724vOyevcQiokJGAtJLolRATN5cLLjTvHOS1ZJQx0kk1cy5J3FYkl+H/oogNtd6JFHIAlPYMJCe1sz+LzERdLeNOpz8IjzSDYiDHhMIgGa9cLGwaMo0bLLYNoAsVFpuJSZJbgv+uSfUjPR7WK1W7++hUJkEwkgnE07LLjsTnowJ8f09QUYiXoYqNiTVq1X679kSNpwRDc+WCQ+C/lTr93HpQNUPCGYaRguOXRzS69fZAqDFZ45ZQlj3auLg5GTi1kSj4R5Oqtzlk4bnnpweT2v16mGtceo5kE5mnttSGYqpiITyBEtCo5Y4Dj3JE+Gzrg9RkA/uPcGkmd1mU6h0Qf7Yarf7lxfj23Z/OOz0WuNu/wLPF+fdNwDCZGc0uh0M++fdXmc9MOz887IzGt+2Bph61+qZGcJDT4NBr9vWmPDWbr0dtLpvio+3QDbuDGmkMxx3zwvAvcuRnelfXHTa4/7wdtT+R+dtC0Odi3F33Ou87ehd3vTfdYYXrYt25/bNsH85wFD3TIO8LzwWSM+HLPEY6nXPO+337V7ndjRujQlo0BqNrvrDs9tBHzwQpmFfrx5e6v9G/cLUqH85bNPouPXG/L0FJ503/eF7/Tr6CXuNLnu01bAz6A/H63dC9K7b72WcZ2potcfdd4YH0PGTYW07IipG+rMBm4VTbR6k4phezsb9mMXpchlGZCufZDKXxrEzs7kIPzGpphGHPaRekkaiUjLegigzPz9LwjHZEEz2Yccpk5jttOkWjdrRSbXW8A/q05PTqsdrjZNa3TutnVRPDhp+HfgLsSVDknvCFVhBfiK38bwwVcmFjtpPEWNzF2QhM7LseqbDfpHABIAVO7v2Tx6MEp6k8aOupL2hc6bV/SOsVz8OOhdn3QsykIs+GUDr7L32BVhurweILeV2gA4pbYmwSbSqmUllxcyXJ7wsAMWGuLXkWmWqC3z0I98EG8sGdptg4OGkC9Shhi9IqHa/9/zE4mWJZZrnYSJmEfqUpR8PwD4inZtIrZ8y1qu5MPacCeITj1kAY2YZ4rI516u1U7d64tYPxrWTZqPebJxWakf1fxEpXiQoon5PSizKx2g4rDYPGpXjY6Lh8WTaRW55zWNyvKcSmtqu1p4sEX53EswYl+D3Pi9sSia2S0271PT/kpoKCHM6CiQTfY5FenRUOzqaNCbVag1Px95BXUwPavzoaN2NXMkgkHzBRgtgd+6/ECqss/dQhhLMzZPxxBbmhw/V4u1AUsDuRFEYMZcNBVSgKHNOS3Fugs6FyRiqAk7pf1WB/nhY8EXCZdAO/Wck9nOphDuLuCQKhSbZw0JGrEqfcucijAQzKDNj1HBlo4IkKjX2mvvMypK1LTMk8Yh7vwJX9xm2dakk1rNsCTWIiKVf2lYcCz45qp7WD6dHh5zXTw5rx43J6ZQfHFRPG6enOlWKOEZrXKw8eBTx1dbWb4QSkfRYEHrQyL8hEKQhyF4ToDcn+4P246d1oHE8Q/5j8GVgczYtvYxOBPbQsr9uD9jhMbKzmqV6nM82hKDcyxGZfBoEfEJD1AODc4O4H8mZVI/libPOeSsLZTZ+Eq6HQpNUPpklSIUtzBFpkjUDlLljEUAcSN3slcX6CgxxFRcBpXmLVzG1fb6Y8jRIsMLu/sCKImo2jcJFyZU8c3zCXsiKqOyxCY0h+3pzNkHe97Om/FXL88QycXtWkq/YXHDUZi8rrOX7kphEuQZvBFKsXwER475PrmsQTFOKpjrmhmmiT0q8jeC6FmVZG+uI0isqhZwDlD9tJy0EchCn2Sx6YW4tlkSrH9BsJFembrxRZ8UrlXAPXKDjX0GMUQQJswl4k0nMbDgidcUIPCqDyyNWMZrqcPfWEIN0ouc8nsbP8LtBgPDjatbyiY/COl9MvbuJRlobmZpsRLKNvV5soXJ1ZY7PUM8G/s53d767891n+u7m5NCeQNpZXfrUtkufS8VTyDfSyXOr9Im09aiQZUCmwjWK3EOfnJVIP16N4di/ojEEvPi8pIPd71gfmVS+RXwr14cZn2QnB1nqX+uCCNRyNBxMEYmE39R0rynWgjKiOtje7TyMJhIGqh4oERE1I7YKU8YhsihViijh8R7zQxGrHxI254iPHB4RxyYC0q7Kd5ehVF931LurJHeV5C4b7bLRHzob7SrJne/ufPfP6buPVpI5VdpbbJ0Up4sFj1b2KNTM658/GABY9ls4y11Oq2qzWiFkLK+xnHLl4EzqtUlteuyJQ58f+kcHp9O6d1TnjePacW1yWD92irn+eu3HuZOVfaqgb6NHLWIUcR9Rx6UKxhUnYeiXj/8g3khMKaxR6MnrZsgcIr3Ja8f66XbtOA5Duu+xyiqkuFRDqrWMKKYBdkGwUQYLAM5miIuKIVRJ0EWmJBcCWCIYDQvkQmrnJS6AN1q5rWkCVoyjZEaW7yKVF6SgUEeCIKSqOYRhSTApplTzAYOuYGeIzt+xOrUq+l2VPBsSxz3imHU+e0KQo+eVe+Oh890uiI8oRoyMgr9w0Gu6Ha5gAGgITMzK685dfb6rz3c5fpfj/xo5flef73x357t/Tt/9ivrcVkNfrs8B8Oz6HLCVKstrqXMyrv96ma5dxVKgzZuFnpdG+rg5q8F1XQFTIoKWob6/rS88N5394pUyN7seFu/fSf9+317Wcui2N5WJhsI0CrBwniTLuLm/fwfFQWH3Fb6UlexinQo/VbxwsT+BtB4IRHRjwDgdAbDWoGsbjYoWdSTJmk3o08iN4DVzZLdQgD4kfhQz3Z0gja7CFMFOo9mjGyjWsvQwSFyirfgh1tAVbUlb/IGvyyi4//28GERf4OUh8T26G+AZKN1g0d78yC7nj6gGN7tvXdFf5xXq2+pbm/UJrM5eCx6hQTA/Zbz48Wr8ks2o8tSen8ZU9ApJrQJ8ZwAT0ZGtlR3r0yKdbKIwnc014a3SDyfkSWwagGH2QY2EYNfFK0BDxGgtUlokdFigVTcvMu344qMIKBtW1pIkw5O+gvXKfV5a91JnPt0iSGVut2G08kG57ExSQJKUwQnGsqg7Pna9zPjiBb6+lYi/Zdhcg83V2OKXG1QY0V575iKOB3cmFHBNLa1v3tzgcwv4qJ/CCGHdpIEkYeko/9zlZVr7ZjpK+FzCV6bjg7qaS6TV8jJmohiLkRUDn3WZNw/DWPydMTIdcoPrWQov+mayPtGmrvYIt14tkOSaLV3pokjU9PXgGMoYE59QktY1SojyTfnGJX/WmoXP/6w/Svm5xLMevkYuJUg/9OJvppk2dGlD18SA2NJvUhUZFnybeDBfg2gDaK/1ryOBJbQQ9wyuB6O6Rr+v11Bq8ECqxhIvm+aluQ5w9onpCYLOYRCGqcbOfwDEO7O4KF+VhJWdDmxKcJveIESa3JCboTc/naLU+UfjlzhurQ9R+ipYfe8o/YVI8seJu/+jiLeLNH/FSGOrXjqMHK6/suusb+XmHy/kX+Sh44ZxaiI3rveSS7y21d32ESCdUc8F/mJWe7Yux9Hs6PZt61rzMuAJ+YCOAd5cCn14sBQ8oUpxj+wwXGi/RfFNwQItokY00x8URGCQo92TAfDp4+1sZ67dy5ShZAX0Hqe6g6G9vDmaUVFhV+jnlAclUi9HFzQw90tom7oR9DggM2BnmWkw+iwwVXRVGmSnC8ZhgE/Yjy9jLzVhDq2dEpksQl0o5qsynyfDJBYququJFnF/SufSaHkLZvLEXrCS2B5KQ/T6Qwhze3rNyFAE2o4JrlzkP4UbtunORbAkI0GMRrkmCju87Y63MAKZisEXuvYwmu3bRfE+wQIJNVPGfA4qtUrV1c0Fxqk5Q/9bQG6/e0UZWvrgYv0hbska79an8t/zi1mbg6h52F/S+RfRmppmxjSS187DjSQWN/UN+6yXRHcypw4UK+7u6NCEmqt7GgYx1JFf36z7Jt1vQgn0jN51CoTiEY5fDO0XtC/ZMz/XfZCx7PhPrdadv4PHXwUdGIAbtNXgQp/oaArNhP0JwdVfIawXbv02Qj2mWWFOiR6FvSl07oO+/ipkYj8XXphDiIh/wiD9bTof8A8v4dKYOYD0+J2THekBxuDNSqyHKgz7AE0A7D/zm2eU +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Approve a Non-Employee Request

+ + + + + +Approves a non-employee approval request and notifies the next approver. + +## Request + +

Path Parameters

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/bulk-delete-roles.api.mdx b/docs/api/beta/bulk-delete-roles.api.mdx new file mode 100644 index 000000000..be876eac9 --- /dev/null +++ b/docs/api/beta/bulk-delete-roles.api.mdx @@ -0,0 +1,85 @@ +--- +id: bulk-delete-roles +sidebar_label: Delete Role(s) +hide_title: true +hide_table_of_contents: true +api: eJztW1tv27gS/iuEzsO2RezYjuNLXg6cJl1kT7rpyQV9SIJdSqJtNhKpJaWm3iD//cwMKVmykya9YM9uYRRILYmc+wy/oai7QGfC8FxqdRQHe0FYJDcHIhG5ONWJsMFWkPOZDfYuA3d9vRXEwkZGZjgFJpzPpWWTd0dMKplLngvLOEMqLEYyMIjpKdNKMG1Yqo1gRKh9pa7UhOX6Rih2K/M50thiJ6c//zY5eHv06xY7PTk+LH/DVLo8u9inO4wX+VwbmS8YcDfij0IaEQM1FvEkYbmXqc2OFONxLFGMLZCrxu4xeilfgLTJokmJySnDa5IdVI2SIgaGUsEIQQIImzMO2nFrdYR2IHHOdGEimEEsU674TKRC5exWm5uZ0UVm0Tq3cxnNiVJTKom2TEUaCtMGT3g2+zpeBHt3Qal2sJebQmwFkVY50MZHPMsSGZFXtz9Y9NNdYKO5SDn+yheZAM/p8IOIcqCbGYyBXIJ7kSyoeBTTz6anjyWoCNIeHZDQzhSgYyicq0WMQnri3Bi+gEuZi9TWmNrcSDUL7rcC8YmnWSIwtHrRuDvqjPrDUbcnOmG304Vfw85ud9wdiyjiQMcPGfkhPRoiur3xtLvbHXUHwfX9/VbNJJeVHhCxucyREYXw/jLAnTkbstTUv1zyHPR3RiHxHAxG4fghsWgIH9GQFbGcYDbTyjoL9zq9deueirwwChwO+UKOcTGDQSFjtDf+yrm9YeCrqTYpmJHuOduzKo3RCV8dCiu5jexA9CLJ22tx4qauOvYzJNjB+QnD0UhLqCJFG59Pzv7z2+nh2cXxOXqqckTjARhQxl/G6+iAuFTk+oM+F8NwOhx3RX88jcNhf9AZ8J7o89F4sLOLPBRPv1CjWNosgYKBM5GfKpKEh8jQpWTFHx9gHJSRiEROicZBrlci0LOvG8Dp/7QSpQ6OHTLsdzrrsfY6kViEDo2BwtpiLvSwnE0b5SyEQoM1SKqPPJHxNwVWM3ZikXOZvNbxM+z9RirRmhkuUUJBIkcwkQHFjzLGLKBVxZEsE4XGrURAp9Pusn0eM5/47LVXBv1ieHQDtI6eEWYXSsJ8Vk7B9IR8fIytGAoeDjrjXn8K3uO9Ub873A3HU76z0xnvjsfIPRXWwspQr5Nl/Wyy/lkoYWTEEg2rk/wTDGIEB9uTAMT8gZL7iA+IxnPiHfRyYys1vbwsF59yXFb3X79j/SFLuJoVdJ/PVoygWhdna/kBmjvCJ0bOpHpIlLJMHBy+mbhEOD3878XhGfxCWmtoZKIgWmMMSxAVYmGub0lir8Att8xCvYxwsWKvPNVXoBCH0lsbKN2VXVgwJsTWlGMNZK889wdm1EmzqdFpI5Uobz7l7IVsi/YWLJlwL+U5rPohtzBBOyDxahJFIstbx96Sr9hc8FiYl2028TCGJwyyEYgSUoG1F/DNEolMC0hlQUuHLnKmdC4j0fTF0pSr1aosTsd1p2BygORPx8kkygsQjtSsZ2EVLV5E7x+Q2VmuKd15zWhk0oXKeQRaAPoCTKaNwaUxBN1kbpkvR+guC4VHleOqilWvuVTu3jphqOrCs4gX9hl59y6B8tMi1aoHH4VPPgJBrhqJCm2CJXxFgoe0dONkP6pyV5n4bCpFEm9yd5O7m9x9Zu6uPjz1CLuJpyhbHl/5H0DhjgqlS8jjZhAozETy4CqI+QyPJrgIuoJ3eRyFo37M+/j/uNPt74rO7rC/Oxz2RVCHA5fLVK/ysJl2tZBwrv7uXrj2MBLUw/4J4I5liUxlzj5KnXBnuDU7PjKSlY3QtxtyOOSAenk0mHZEv9eLw2h3NBoNBjyMer1QjL/ZkL4TBBMVYCDxKRICszXln7xWkCm7HRcp0FS2XCPWsFi73+mDHlNhhIqwVLjODlIbphUqfigAHx38TNs9yfOvtmNNltKkl1dPNtdXwTWFbyW3M2zZ1XTXTXeh/C4O4uK1rsbQwqB0udXzp4tHV6Nph8l3P7+8P/f7RDBefMpwP+E7tj4Opa8JP6lKrbsflu19ieqXZRYFpOR0GkzB/yLeI7mXEgdLU+2sc3ujTShh7VEPdH8AiAxb6IJ2s0yhFErC7RaLtbDqp5zNOUAfDoudtQ7cIFcVtzItVb5pEjdN4gZoboDmjwM0N03iJnc3ufvPzN0vahIJJ9kiTblZuEjzz1FbzmBAhcBZlXKPAfEdVmGsVcAd9rphdzqMBHWAg53xtBcNenx32B12w35v+F06QABxHwHHAW4WxuZax82dfTCvEVMsa1h6KtwMNm/A7N54HTuea83ecrUoEZJtYMhlh0c1DcamONaUY2EAZzOoiwrfY0ntXm3JVAAVA0HjWitMXtQC6JpFazLNQRWXKMtXrp6LfxdrqRIkGlGzhsCC9iwUU8R8QIEQ7Ayq83dEp95F34Tk2SlqfEzN5GHZX1bIffehVzdHILzBGnHmHPzIOxzX7XAFAQANgatZFe7c4PMNPt+s8Zs1/sdY4zf4fJO7m9z9Z+buF+Bzj4Yex+cw4Nn4HMa2O6zCUm8wuP5ymE6p4iWg8GY6igpD280lBgcjWAE3Zb4gJheA61+7UJ4AaMfMlLHaw331VqEAuEU3It5zBw3p1JB/tvLk+v4apYcYRU0zbak6cSQYbOMEu117pRGgEIg2naKFSWDYPM8zu7e9fQf+B7/ft3km21AWIQTyhdK37Uin2yEY/YF6hmeKXO7iADpf6Ri0yWNGYlK4CkrEnf/IRhj+4Efaa/4sZTwIhYGx0AXUTCKzhafPfIDSbRAxg+7kJ+sPcKG91/QDvS5Mcv/tujhCj+jykPk+yw3GM5B0RUVU4XoZM2cI5R33tchZLk/Y/vXWmJ3gsB7bF9xAn+HeiLz45f35SzZDAEsFpLCInYXEjgNS8B2ECBXISfl2ACfRmmV0MXOnGSeN9y+YkGyagMLsSp0JwS6PvBF+hZXjFEo9mRQnCaouOOv6RemdWHwUCS6q7aUlMfAg8LfBQtu8Me8lLaDUaUiFZyjdgckr1WIHEuuaRCCAY7yK1Diyy6zUi9f0+loh/lVSazlqLaJmX65I4Ux7GbmjehFUBSTBE0vW+mrmjl6rRg/bMriDVFdlQEt4OZpvzaLSa18tR4NeC+k15bhS7+lQdHMaczWLWVhck5gdsWiutRX/ZgxDB9PgclZAFn21WHQSu0UZ0ep1aiK1HMuWbAHWJPmOITGUCyYe4lpPUEcDClSxS8nfybOQ879DJx6z3xs60+1LWJJxZKwj+9UyI8MWMmy5GmC9/G7Fw8CC3EYdqA64AHi99D9VAi9ore45Wg9WdSK/TXNwaYhAVKJisz13sbcscP4Xowc4uhoDZRihevUeEY/Xe1q47DWMVW4yrFpwXd5Ew2q7Yjcnb7XJhSvw301f1Hiy3Is5Ucnie1fpRyrJ36fu/p8q3qbS/IiVxoNn3NM8XX42c/i57zy+8fMTQNsQ26Sjb2nqGbXvweH6RiTulM8F/IWnVBioKeD1D0DqhLKE55hCVEKiuRS0hZEJniPQ3MIw1imlfWY01pry66OZgTFQIywAYB7KBOjRJnvJmVN2OhSLQYTXtnCHh/DDqjm0xKLN3kNXqSKIAewo8ZgIPPugfWt5BmHwDqOIHZSRBQgvTQuFn1aB2EXKOMTvE+EXSxsVrkpCg6mqj2E04cxqVlkyMK5RBfr8SJjUnkxxdxwa71qUPcELgsz6rXEwPXrRfUkRLBU5Fe4MG45r9ghP0YbQbs1FkmFPCyVe4BmuJYe3R+drFIGYsvTtWFub2bafZLdxLBDBXsyFz0672+60qDeB+9jJQYvXEJ++DsLzeC/sy9Xou1u+C9h8yPfXfcjnl3TsxbYz3JVE3xWuN3RduPt8DSOt3odDZzfHXh0e393hvhU2pvd4G8TGTZHL62XPiVdA1u1fUeN+I3DfxL8waZ0vstpJwvU3QdgKuxluT+yzY+vbCe9OcHcwCP1niqnbcjH8Fm7i373gCv7Bhc5cOmE1xvt3QbmBCWMc3RIJPgSE/A9U8/7+f/loXrA= +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/cancel-access-request.api.mdx b/docs/api/beta/cancel-access-request.api.mdx new file mode 100644 index 000000000..80aa0fcb0 --- /dev/null +++ b/docs/api/beta/cancel-access-request.api.mdx @@ -0,0 +1,100 @@ +--- +id: cancel-access-request +sidebar_label: Cancel Access Request +hide_title: true +hide_table_of_contents: true +api: eJztW21v2zgS/iuE7sNui9iJnfd8OaRpe8ii3fbSBP2QBre0RNvcSqSOlJp6g/z3e2ZI2ZadNGl3cbtbCAVSWxoO532eoaWbxJbKyUpbc5olR0kqTary4zRV3p+p/9bKV8lG4lVaO13NkqPLm+TCK3diTaU+V8d1NcW1RGfmSPKanguLjgKj5Or2aiOp5MQTWWArIl+f4FamfOp0Sftj9/Op9uL47alQJiutNpUIbLyQosQ1bSYi7CPiPn1xbFYu0RoxUnFprjJhTT4Teix0JabSC2MrUUrvcaeaKiHL0tlPMhe+UmX/gzk2M1HZj8qIa11NxZuzf/3n+Pnr05+FhLaWzCCsixR2zCxqmERcTy1u6Ik2Msd+UZpmk7aIOnzUjm7bKCrk68PYkeaZzWDvm6ShS44qV6uNJCXTm4puQfJcp+y8zV89WfAm8elUFZI+VbNSwaZ29KtKyYltU0cniBG2gTVmuZWZGEOxKMuKwI1DGgGDRJcJyGxtquO00p9gGcQQSVgUJCHcC8sivCqtPMu7RrwQ01cO3l0TkyPCqbFyngxFptQZmGN51OA064tzK3zNAo9rsn2jw2pobIiZrUVRQyHyOTjdwxFyqM+yKHMSbZgeDg62DrZ3s6HaHewdbA12s+3h+OBwK5WD3YNBcrvQ+UGFzpSEp5YsnVNQkxT3BHhLlNNWWJFpbK7EaCYK7Sv5UfWTWwgDXZj65I5kvl1id6dHGnV39w7S3eFhurcFldNU7o2h72B7sL3k4ccJRCI55UtrfIiD4daQ/msbhsQsiU0PBaKqncFHHdKrCcJrJG/Lz7JZg8gMweFnEKXoJ9+cJ0Hcna2tdQlPcg2G4oVzcN79UnJGwRLaoKjo7HfIspo/maqkzk9sph6Os5faqN7ESU0SKhY5xcIY9xRnhXVKBJZNHWO6dsTBEv2BeIbi0FSMk6gMBZqT6UfwekwmXxiN9aJZgqTjJLhnW7Wv5Ghv63C4M97bkXJ4sDPY3x0djuX29tbh7uEh7V4gDuQkmCbuLZ2Ts7Wt/6WMcjoVuU3hkd9gELfIQt4cSzTixj/sA+bxCPufQ69AO1czyiuoc26goz07eSt29kUuzaTm63KyYgTTu3iHKwbBLkd0iVoANA+M33CzuUsUZeqCqvPzFy+PL16d48rZi39fvHiHT8Rrre+ih2oUH4QlREUsTO01SxwV4LxTOcyhUGyfRq5PoZA0fplQ+6UkRGyNZZ2jRT+Nu9+xYpm1GDtbtFIpDTBD/Kj7qr+Bpo5rhazSqRhJz42dyZ+G2tF7FS35VEyVzJR7AnSQZZqURHtHNoIp1s8IHcgs47rBDMY1Ullxv7d1RQBBp6rti4Up295YVNtXy06h5IDkD8cJSm8N4VjN5SycR0sUMfoHMgfLtaU7X62SM1NJFPWUoUhqnYOFxQi66cqLWI7IXR6FxzR084q13ES43L0OwjyvLN9LZe0fkXdvc5SfHqs2v/FJxeTjft50YblwU6xIsZ7z4kg1d1eT+GKsVZ51udvlbpe7j8zd1ZtnEZfFuwx9BuvQ58LE4ee3uwCa4+gxtpmQfmN4Ex25QdNShEg/vT+PgxPo1eeSpog/EB+FVr6OLOf+CNdHDeJuWv/CFyQg2zFoMEYlUtkRy72QmA0VTLW9vttL60YaAWrugIg8J9IIImEyVxvDeN9viMwqb36g8fTTfFbkCki7mqw3n706JNkhya4bdd3o++hGHZLscrfL3b9n7n4RSc6l4myJOMnXRSHdLERavE/aSgEC0ZwQinnKsatW0QoxE3OMlbSRQzIaDkaD8X6qdjK5k+1tH46H6d5Q7u4P9gejneF+stzrLxd5PE+ydk4t+Tv4kU0MEPcJOK42CC5fWZu1j/9gXqfGVNao9MxxM5/u314tsOPOOnb82VbQDYyBHd09x4sXZ6+WDsQl2c3WLlUEs4PpQC4rhpT8U4f6rPlHnA46dtCxaz9d+/k+2k8HHbvc7XL375m7XwUddx6CjjtfAR13BEGsMUGsPxM6ZsAdBM3GcAp0SGuY1xBsLKEKPsXTx5j2lXQTVc2BXgtFDg/XUeS5teK1NLP5gzatk0izMBeVN9AWROsaWhBIMUGJNAJVSwPdUlTpQhEmRfyIXBea85gUAl836x2PK2gVcqaJt/ku2qR5DQm5KOSWzl4tYkwjnNSY4B848DnoBIX6DzzjjN76XefB4ow0fkUaixefU6Uo5+fnv7t3PSVwCuEdlYt3wdf3PC4QzsylwRihPpehfM0haAfVO6jetfuu3X8f7b6D6l3udrn798zdr4DqEQ3dD9VB8GioDtr+lphjqZcUXP93xM6pEiXg8BY2ZayeLTA44wqEEglUWj5oLSU9FZ9stp+I95vxkXh6nJ6QYRCqdjlop1VV+qPNzRv4Cj667ctS95vHko297qe22BzBQHfUHnrUNOQZEfDj82GDPlvXaQrgUO2YebA160OhCpvz0wVf5GxkwU6cYQIRgc2GQLDHYOLLELHEJPGDZ2p+8HdjTT/odeHy29+vS2B0jy53me+Lu4FeQNIVFUmFq8XbD+8Idofd196BWLQSOvAfrm32hsiG4pmSTjUvD/z40/vzJ2JCYJOTvfaEc5Wm6QDp8hYhwsXsuHkehN84oP7ibD2ZsuDHrSduKHnEOIfC4oN5p5S4PI1G+BlV/gxlmU1KixRXAlp19WPjnUx9Ujk1wP7CkhR4OjObsNCmbK17ws2OpwJt8LHgq/0Ppieea6pBmpo20UQVecgTl2Wjl1zS61uF+EfDrRezjbn5JytSBNNepuEJ7hQZTCxk7tla37x54Ndb4kcjFK4Q11UZyBJRjvZzUmnjtW+Wo8WvR/zacnww76canbS9TITCJTwaYZ6JU5FOrfXqn0JQ6FAaXE5qZNE3i3VNm/Y4I3rDrSWRemHLnu4BF7J8r5AYJgSTHFFfZlhiwwkJp+Qv7Fnk/C+YmjPxS0tnvnyJ9kmUmU39N8tMG/Zow16oAT7KH7oTBRZym3TgOhAC4GThf64EUdCluhd43VnVmf0mr6HWkEJU5uLLo/DlaFHg4ifBN4h6ToMyTLB6/uQYvovIi1pUy1jNgcCqBdflzS0644rdgrzznzWpW/7V9CWNjxfnJm9MPvujq/Q9leSvU3f/pIrXVZrvsdJEoEvnj2eLtxNfPOo9svtfm/vK98gwtiPcWe04kSwn2bOIF9fPET2/5Ie/uMu1gjE9JqbwfiehqGVGZS4ryiquKulUKz6BKJWsCHtuUGTbgitB6SyVH8yZzGjiQIOy4YGJ5Ujn4Mdn5M3OkhM2AFuKK/ru6/jEhkVKYKJVffEeQ6GBNR0NhPSsMO79auNk+A6R8ZZfjH3eBBtAX1HUhl5Lhdh1ISRC+oGIzLRP61A4MR8a1djCMvScr2qqCIU6qdDn0cgV/s2YDrcxNy8F3gN7Ie58PNmG6cmLNCXQ1DVX5EzlnBlE1x4bHuKNaO9NVV5SkKDqAwCqpR1en56vcQQzE39OsW6yGRf5TaIFExrPQvhs9wf9rR6PK7hOEx6G6CXm4R3LBqMvXpluBeHN4kS/e8eZoyi0YZqfNks69SPj1mGeC+PzZbIyPlPwxHfKN5IpTdqgubmhwyGaKG/pMijp5OHyajEs0jfwDodEPHF/VHQ4EX+V6J3PGFnEU4j1n1tohg0rwsHTF2mvlg4D3r6hI7hkFF/jLsK5hpPXuEh/j5IP+IcvtgxBDyK+fpM0p4SgCXwbCHcXgokfSM3b2/8BMQRTeg== +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/cancel-workflow-execution.api.mdx b/docs/api/beta/cancel-workflow-execution.api.mdx new file mode 100644 index 000000000..bc6e07730 --- /dev/null +++ b/docs/api/beta/cancel-workflow-execution.api.mdx @@ -0,0 +1,95 @@ +--- +id: cancel-workflow-execution +sidebar_label: Cancel Workflow Execution by ID +hide_title: true +hide_table_of_contents: true +api: eJztW1tv2zgW/iuE9mHaIrJzcZqNXxZumi4ySKfZXNCHNEBpibI5lSkNKbX1Bvnv+51DSbZsp2kzxc600EsrU4eH587vMNRtkOXKykJn5iQOhkEkTaTSt5n9kKTZp+PPKirpXbAVFHLiguF1UL9zwc1WECsXWZ0zyTC4ckoUU+3E6OxEFJnwzIQUtjRGm4n4VM0VqmbcA2eHZ6uLObjfEg97lJlCfS5GZTGlFV0+rCeGfqIa4rWyRqbBzR3EyKWVM4URxzwMfkAcHYO5JsFyCU6r0l5O1QaBxMlLUFr1R6mtgkUKWyqIWMxTYun0LMfDVqA+52kWYyiRqSOCaKpmMhjeBsU8Z8rCQmOmlDwHtt05GCu5J8P9g0EcDvb3ovBQbQ/Cwd7z/WSc7MtkexzckT5WuTwzTjliuLs9oP/awv8G65KVTCFCoU2sI1koB+srQbIrV4hP0glXRpFyLilTMS4Lem2VgIPMYjr8NKZJRWmNisGrYuIl6AV3W8Fge3tdgqNU0/RjazMLGc4bBklLinEWz2lFbT7KVMfk72plYinzPCXRwbL/uyO+t+umzMa/q6jAxNxSsBba2yVWhdTpEXth3extYV9po8KJlZokVCxyhIkCHD/qmEJzlsEynqXIvApM12u5EJbo7YgXMoa+Xr+jShmYqbAy+gBelEgPCXRlNOaLeorQsUgg1D3LqgMlx8+3D3cHyfOBlLv/HOwc7I8PE7m3t324f3hIq8/gZznxpqnWltbK+drS/1ZGWR2JNIvgkf/CIFZJ2J4F4MUpbQo1cw/7gHl8hf0p1zxto2Ylr6BM30KNeHF0JgYHIpVmUvK4nKwYwYRXFxgxZZrKMQ1RbkJzz/iN1RNtNmagKWdUR14evxpdnV5i5Pz4P1fHF3giXmtlbGTqjIKoiIUp6kOxUIDzSqUwh4p74lnF9RkUksYtE2r/y80djInYSmSZFphRrb5hxjJrkdhs1kqlyJdF8UT3VG8LWYuxmSyiqRhLhwmZT91nI+R8XoSnlSWfiamSsbJPe2IUx5qUlKlANoIp5s8p/WUcL3I/KZHKEEYX0wxFw2SFjlTbFwtTtr2BJNAFU5wuO4WSA5I/HCejqCghHKu5nIVNtFQi1hUvrizXlu5ytQrOTSEjaCHTdA4zWgsLc0HUhWsKoSbbz6Sp6ZqKdXe3UIvL3WsvzMsi43eRLN1X5N1ZivITsmrNi4+qSj5HddhXI/ZG7aaqIuElqc2TK6rGXXXii0SrNO5yt8vdLne/MndXX55XqKd6y9BnZx36XBkJaJpZ3jzXoE+DsGoihjeVI7cEDFJBpF/fXiKxPyhD9ACUBDi/Iz7yW/ma8KPGH358TPCjcVbLFyQg29FrkKASqXjIci8kZkN5U+2tr/Yqs2ONADUbICKqphXzrBQSJqtbBOm2RJwpZ34pxFSiPkpGsL4C0qomDvNMm6JDkh2S7Hajbjf6eXajDkl2udvl7o+Zu19Eko1UnC0VTnLlbCbt3Eda9Z60lQIEzfmbaFKOXbWKVoiZaDBW0EYOwXh3Z7yTHERqEMtB/HzvMNmNnu/K/YOdg53xYPcgWN7rrxd53CRZO6eW/O39yCYGiPsIHFcaBJcrsixuH//BvFYlVNao9DS4GTaHSW8W2HHjGWcB3cAY2NHec7x4dX5K/LE0sye7ZaWNFMFsbzqQy4IhJcUwLK1d0UHHDjp220+3/fw0208HHbvc7XL3x8zdb4KOg4eg4+AboONAEMRKCGL9ldAxBu4gaJbAKdAhKmFeQ7Axhyp4qk4fq7QvpJ2oogF6LRS5e7iOIi+zTLyWZl6DJdc6iTQLc1F5A+2MaG1NCwIpJiiRRqBqaaBbiio9U4RJET8i1TPNeUwKga+dh6OkgFY+Z1b/no7fUVpCQi4KaUZnrxliTCOcVELwDxz4HHSCQv0dzzgrb/2p82BxThqfksbi+HOkFOV8c/67v+mWwInx9zTEhff1PdcF/Jm5NGgj1Ofcl68GgnZQvYPq3Xbfbfc/x3bfQfUud7vc/TFz9xugeoWG7ofqIPhqqA7a3rZosNQrCq7/O2LnVKkk4PAWWcRYPV5gcMYVCCUSKM/4oJXv3g6D/soVXsSA69/q+K7vbwkHdA+YIKKXrrQpJk2LInfDfv8WToOz7noy1z3UMvitmJvsUy/KZv0xLLWhCNGdU59wRMBXkv0CPTaz1RTJvuwxc290VoxiFsbnawZf5EwXjcmbc7QiwrPZEoj6Kqp4GCLmaCl+cUzd4yha0w96Xdn07s/r4hndo8sm831xNdALSLqiIqlws7i2fUH426++dnl7safQyf/u2mJviGxXvFDSojnwl2Ge/Pr28qmYEOrkrC8dAV6lqU1A3pwhRLiqjeqLITSJNxqblZMpCz5qXb2hLBIUez3xzlwoJa5PKiP8hnJ/jvrMJqVJiksCzbp5UnsnVh9VSjthb2FJCjwdmz4s1JeteU951+P2QBs8zni0986E4qWmYkSRzzSVitztieu81ksu6fVYIf5Rcws9t5C5uacrUnjTXkf+KneEVCYWMnVsrUcv7vmFS/yol8IIcV2VgSxRydG+MBXVXnu0HC1+IfFry/HOvJ1qbKntacJXMOGwI6axOBHRNMuc+pcQFDqUBteTEln0aLE+0aIhZ0S4u70kUuiXDHUIgMjynSIxjA8mOaYNmvFJ5o9KOCXfs2eR8+/RPsfifUtnHr7GPkqUcRa5R8tMC4a0YOhrgKvk99sUBRZy238WgqT3AXC08D9XgkrQpbrneW2s6sy+z3Noa4ggKnNx+dD/GC4KXPUk+AVRNzQow4Svmytk+C0qXrRXtYxVnwysWnBd3jTDFrliNy9v8/dN2jb/bvqSxqPFAcobk86/d5W+p5L8feruX1TxukrzM1aaCvFSuPGyVWuwHOQvKry2fqDH38op/Iu3nKsMrtG6cDPGKGaZUZ7KgqKaszqaasVHAbmSBWG/LYqsbMaZiK6d0h8NHzOaWNAgbR0wqRzrFPz4sLpeWXLCeGBJfqXfrqyuTmQISbSWqifeojszEdxCnRld2sW737OqRbuAZ87IseJl7WyArtmsNFiN8rKcCYmQeiAiYu2i0hcuNGpG1bbIGPo1s+osplAjFXrco9iZe5PQKTMa2CXHP7AW/O6qI2aYnrxYfTy4UORcpRyZRNeG7Q/xRrSFU5Xm1Bui6gKAqaUVXp9crnEEM1P9XSOzk341yfWJFkyoPfLhs9fb6W2H3C5gnFotdLNLzI/8p5f1x5qi+ZJTjOf+E8dWON4uDtkf+xVntYUQ9u/ndHRFgpW+F/E94HWwoQfEzCF/qFm1gWgsptQ4gvr2ls46qC+6o2H0+NRIX98sWh5uFWFteo6bbzHv1ezJefVZ51P+a819H39u1KQ+qjPzRZce4PGDouYeGqAFhuh8+sJi+Rf+fGZpytpfMKiVanrmszd0UsUQZNO2XD3ABig8/wNn1+GX +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Cancel Workflow Execution by ID

+ + + + + +Use this API to cancel a running workflow execution. + +## 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/certification-campaigns.tag.mdx b/docs/api/beta/certification-campaigns.tag.mdx new file mode 100644 index 000000000..1bee1c4e0 --- /dev/null +++ b/docs/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 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 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 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, IdentityNow would provision all the access the user needs, nothing more. + +IdentityNow 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 IdentityNow: + +- ManagerCampaign: IdentityNow 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: IdentityNow 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 IdentityNow 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 IdentityNow 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 IdentityNow. +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 IdentityNow 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/docs/api/beta/certifications.tag.mdx b/docs/api/beta/certifications.tag.mdx new file mode 100644 index 000000000..bffc42614 --- /dev/null +++ b/docs/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/submit-reassign-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/docs/api/beta/close-access-request.api.mdx b/docs/api/beta/close-access-request.api.mdx new file mode 100644 index 000000000..975de62e2 --- /dev/null +++ b/docs/api/beta/close-access-request.api.mdx @@ -0,0 +1,98 @@ +--- +id: close-access-request +sidebar_label: Close Access Request +hide_title: true +hide_table_of_contents: true +api: eJztW1lz2zgS/iso7oOTlC4rTrz2y5ZjJ1OeyuH1sXmwXRuIhCRMKIBLkHYUl//7ft0AKerwMU5qd2ZKk6qxTQKNPr/uBoGbyGYql4W25jCJdqM4tU7txbFy7lj9p1SuiFpRIUcu2j2P/HMRXrjoshUlysW5zmg+Zp+OtRPKJJnVphBMywnpZ+VhlijGshAyV8IVZfxVaCOkyDBJmxEeyUJ1xCEmSyMGSpROJZiR23I0tiXmVXQ2nEj1UMXTOFVCXSlQGRYqx1glZJbl9kqmnlxLlCbVXxW/Ot+XJlapmBel5vny2bgoMrfb7SagmZJuOk7qlF92Yjvp6sR0Zaa7Vy+7MZNqe/naga/u847YE4X9Co6udTEWn45/+ffewYfDj0KWxdjmupgK7dWhc5V0LsyFObViqE1Sq2FRZUyI2D87bAkjr/QIcmERcaJkHo+FxFxoCkNAGXPy6S7LXrpdcRRo7n08EBcLJryIOuLMec3s27ScGLE/trBaTsSdSlVciI3TXMZficTHcjJQ+UarsZ4SGwf22qRWJhtiUBaFNTRVfctsTtbaP/mXiK0ppDZEgSYUFTnD5Nzv08DeEVRQrX3+XsN4kMmWhn4W+koXWrmn2TMFMbImEcPPihgsShwemgz+R6seHjgxzO1EKDAFVTlb5rGqxGDxeJy3gLDDWUhU8jzaikZO1O5FtE+hJA4TZQrynyoCyX5h8rVOU8RSnJaJEndOECeFzAuVXETwxkSTYsdw1FrNFJawVKHBWcIM3U1q306yVD1ALK4GdcTpuP4TaOGneLZJ8awxXS0SaLCqGS/gHNqNwRPgQuW5zb26SVPwCChdj0bwJe8VR4h+7bAIeVLNJqNEUQ19nGckNnZdnteulujWv2SNZdq1oN3nYmhzoSRZdM6LvSTgmIGRIh/YGt69sck02r2JKliIdou8VK2IYger0yugWqpjhurub47w9iZy8VhNJP1WTDMFBLaD3xCz0SIwVzg3wDIik1OKV2aTWVmKtspfO4FBz9F5JJuJ4TDhDAAtQHcUKMzk4ogZazLP5XSJswUg5tiyHsZnGcNSKghaY+jO8HSz/arXW/JLpgCGqtkkgi7UpMmJgwnNKLptReqbJLORbP14pyeTvtzuyVhtJ696m/TbsN+P5U6vt9mLLjF+Al7lSC3TWla4hIlqFVfYN6/ojjjQLkvlFM5ZmgRMf5Y5eZMjN68k+2ivO0x/KMu04Cyrmi/FXjKh6ADwFFhuIk0p03Qa9OXRpKGMWuQfosO6U3FJ4p4wzq3SiQLEk25PVQ7ShCl4WAfkqvpBNfJ7M74CmDY1JhnNRup+XTVXbog+e3xLQVah0sOinJRsQjw5NFXM4493gI4yVw+JZK9QbKXpndJQvrhPnGqZpizVs1tIgkn8bH+5jGt6+6o4fUwErDD6vIaXNdlguQ6eH/O8WxI0Vy6zxnnQ6ff69GMZWDKC/TagoShzQ8lj2AQWcQ2lO2/PYUkLymoOsM/6HD51AI9O9GQk9uxu9XrLHO6nmhLSW0pn93DJmK3JL1DS6uQHeFkE60ShLkv3bfIIQHunjWqPctRxlEmZ5RgTfZByyTaxyPeeJNU8JILP1HPeCk10NsUbpJ8KsPeDMOS+oTSkVuQhhs6MxvxZNamTOnGsWFZtKzl43dvpbw1fb0nZ//vW5varwc5QvnzZ23m1sxPNwP3hnPWLMirXsUhtDIt8h0LyGdzz4iuSzh02YBqP0D+FjB9bixn4FYX6VqAmF2/2j8TWtkilGZX8XI4WlGDaZyd4YuDsckCPqMiA5J7wJxQ22twHfgdv3+2dvT/Fk+O3/zx7e4LfiNYS6O0ZeGtCbglW4QtjxHgxE4DjjpsLyucvAtUXEEga1xyoXSMIRYBBzAirr5jRJO2L9GYocdx8K8Qz3VGdFooKPJvIApXaQBLSUPOC4S88drTfB02+EGMlkZ6ptUtQtUJINJeIRhDF/ClVJzJJfHVKBIYlQllx00JNq7GFRoMwZ4uZKuetMcPw902jUHCA84f9BE0QwJN9Yi4Ka28JLAb7gGevueXSYA4lp2jh0BHFHpdtnlNniH5PUNkf4IjM5QA8phpXI1YzNTHcffDMHBSW38WydI+Iu6MU8NNm0eoXVyoEH5eJHo3YGpWZAiIFPOfJYVRtrirw0WWoNFnH7jp217H7yNhdfHkc6rLwlkufzeXS58yEzbDvqwq0nL3H2GrH7DuXN8GQLQGFhBLp18+nYauN9h2/Zbyh9vPqI5/KlyvL2h7++aDq7qrUP7MFMch69BIMgUQq2WW+ZxyzoryqXi6v9s7mAw0HNStKxJJ26qa25K2WvDTcKUnXEolVzmwUYiyv6qaTEdDvz7br7n5dSa4ryXU2Wmejv0Y2WleS69hdx+6fM3bvrSRrrjhaQp3kyslE5lPvaeE9SSsFBohqh1DUIcemWqxWiJioa6xovnKIBv3NweZwO1ZbidxKXr/cGfbj1335antze3Ow1d+Omrn+fBbHdZDNx1TD3t6OrGIUcVeo4/gLgCusTea3/0r6bDgkWCPoqetm6Bwqvaxrx/7Ocu14aq34IE3jo12zhjQzHRGmYeyExtafXfjL/EjTt3VAlQZf5Ep6okAlp0+XqZ7o+tMe6ObT9h5/hPeBUjlZvUr4POkYCVJLVbOFY2kIqYZU84ECV7AjoPNPrE4bX22eXMmLY5L4PUks3n6LlaJAryv3V6v2dw/BfE4YceINfMdGr+92pIEDoCHwmFXXnev6fF2fr3P8Osf/NXL8uj5fx+46dv+csfs76vNQDd1dn9PBncfW5xjb6Ym6lnrHJyH+12U6h0rggN1b2Dguc95urmpwrivgSsRQZvngbCaLMf7qzh8RdV0+2ID3vvL3PJV5iqHVobQbmAomuu3ITHeqY3HGXvPJtAH0swJ66IyADzMawOfi/AIdVm6uyX892DFxr+rqaEl9+O1eynQekWw4tSXgjcm0BHw9+BI/pkMgaCQ2HI/mExutJfkg11me3v64LJ7QHbKsUt+9q2G8AKcLIpIIl2Qu2ByE2F5n4GffI9VeSWY+v2yOOaHK3HO4NHKWbaib6y8x9ImG9cUbJXM+iUsfOJ79+vn0uRhRPcp4UPKZsnACVYojuBHj3V612U+TOAXx2Wl/dnbucwrFlximUIq4MCdKifPmkZxjIDernSYpBgua9fgDtXJunj8UyY2DNvh1wk87F6YtDjTBlKa8TmOCiNwHivOskks25HoqE3+rqFVntpmae77AhVfteeyP58QIciIhU8faevLinl67QY+6LDwhqos8kCYCH/MfweLKak/mY45em+jN83FhPo81HV6dmyY8tgmHXJkm4lDEfFD8H0KQ61ConI9KRNqT2bqmRdscEe1+r8FS2y/Z1m2UjszfewSG8c4kB5S6uXIJJ8g5bL+wZYELX/gQ85c5mfnxOTIsjaQTvk/mmRZs04JtjxMu8O8TGDkWYptkYBzwDrA/sz8jQWC0gY2e1krkZ/JdnkPpIwarTMVlu/6P3RkIht8Ev6DR9RhANVXe9WdBPpHoaVEWm1NWtWewqMFlflOL5LmgN89vvWdFCfWPJi9JvDfbWvlk0unPRuk7kOSPg7v/J8RbI81fEWlCLUxblMezyw1vf/zs8c85P/wjZ5ghFkURazP0Qk023oRSdXkH099Xcnx9iSGIuwn0arOLTU1CWSoLClYGq3isFe99ZEoWVPa2KGDshAEmyy0pU4UbUqMcY+hKEspxOdAp6PHufLWyv9/ja2pyV76GV3IDRmvFY/TSqiM+ox01MbyNWlE6X4J3v9nQk55AGUd8m+mg8mG6ZDMpDV3DANvlREhEygOOnmgXlx6P0ZkaVenCckVbz6rAiSKIROhwU5ZP3KchbaujY2/48wNrwZ1d2FOH6smK1KBQv1cLcqxSDjgaN9+xPEQbQdQeqzQjJ0EyQV2pGit8ODxdoghiJtwds/moGya5Lo0FEeoMvfu87Gx2em3ulPCceku4eIO4v6E1f5Nm0QdvZp8S1tc019c019c019c019c0H39NM7QCtIfTzejjBCFx6fed/C5fdTuy3uWjTMP7fChdxrQfiCE3N7SFTRtft/SYvYd2jmZ7WryPhAm8lc0bTV8VbaGGb6ft0yk3N2GvdPmjMG21+Rl+e/zesZeNLcujT/ShIBqEi6gTv/uay2s8pP/vRhf4hz9s5hMk3Val5zdR9S0DYzxd+u+/0Ai7Vw== +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/). A token with ORG_ADMIN authority is required. + +To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND "Access Request". Use the Column Chooser to select 'Tracking Number', and use the 'Download' button to export a CSV containing the tracking numbers. + +To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/idn/api/v3/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 Completed event trigger](https://developer.sailpoint.com/idn/docs/event-triggers/triggers/provisioning-completed/) 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/compare-identity-snapshots-access-type.api.mdx b/docs/api/beta/compare-identity-snapshots-access-type.api.mdx new file mode 100644 index 000000000..ad7963cc8 --- /dev/null +++ b/docs/api/beta/compare-identity-snapshots-access-type.api.mdx @@ -0,0 +1,91 @@ +--- +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: eJztXI1v2zYW/1cIHXBtjcjfaRoDh0OatLsM7dprkvVwWYDREm1zk0mNlJJ4gf/3e++RkiV/pE62uy09A0VjSeTj+34/UqTuAp0KwzOp1WkcDIJIT1NuxGksVCaz2ZniqZ3ozB5FkbD2fJaKYC/I+NgGg8ugaMX+IW2mzSy42gtiYSMjUyQI5M4n0rKpyCY6ZmORWcZZAm2ZHrFYjkbCCAV08dKmIpIjGTFejsRG2rBsIthYXgvFZDHaUGQ3Am50mS3YY5/EL7k0QIrnMJiRv5JIzEYgHpJ/JmM1KCiEE8fvwAgeP2MgEcjMgU1hUK67QCLvKc8m8EjBA7iSMfy20URMeTC4CzLUxCCwmZFqHMz3AuMYAB1mJherehAL/omUuOXTNEEar6LOYVu8PHh1wHlfxIf8sD2MD+P9Xr+/3+2NhkB9LUe8apLfxFmpe+zLbiYymjAlRGxZpkHbzDtFnW2j4U/J2i+5APsv8RZya3UkeSbWKm+ogQRXyGOdp1MVywh6WSZHjMexiBl4ghFTfQ0/He0ag0ZkuVEibjIUkYWu0x4b8cTipe+6x1SeJHA91NnEE/5r8bAmXLfdPgjbvbDdOe/0Bu02/Pv3RmELL+zcb4c1evcdWQddtPCPZUZePZiR7qMZ6d7HyOHWjCRyKrNgeaT3/BYMMB0Kg6NAsOZJRhZ05mv+oM6EYJff99jRx1N2lnEVcxOzY50kIqJw/liG6dXzSZaldtBqxeJaJJjEmpbLJNVSZU1w2BYEfIunsmU9nTAq6YSLcH9BSWaqDcSngp9TyhvNoBo25EUVXXT322v0C+OKsTDQ05Fxt3poi6lUcppPgwH0m/Jb95uoxGLEQQt0Nd+kTT0aWbGqzg90G9gGDWKWHKFvO60yeNBkFzbnSTIrwhuc/UaC3zfIOg1UfMrHUkGgQX+j8/GE6HjDPBlz/AZjlOrfrPxI52pV96cj1sBU02AyA62C4lOd5olTpWCNf4XnOuNJeIy9G6jSVCtIRRMoOOD+ZAdsuCYcJhwo6jyJq4kNE2FhN9AfazifaLAbgaoaK9BYDBYDm0moqAy1JWwGAQ8VN0NWGAnCIq7YhF8LuA02IuVgewkJPsr2UBoo2EaAxaZCYX5UkBXAU6zAURtE5G8keQN5Im6veQJJl7SArYHt3BbcPAkPcnVxY32q+An1nM+vkJozqcUOkBzxT91HjkqoAwIpMG0BZyr5NdLgqOBf0JmnaYJVDzq3frJI4W6VJW4Mx34yE1Nbua+HP4EmEMgY1FwmHV+ANFYKwLIrO46QTfzliyvSx1JBnBPEWENHKAyjy+Do5ASuPr15/+H7N8EVFhhp04TPvqMI2mZ834FhzG3gxOrcRGJ7kq79Zorziv2dooJudNh51X4VHRx0X/b6+8N2B3/xNu+O4HdvGNT04cWuyRqcQ9AFdWaDM7pAGcDoVEsdmD4FPk4ABAMvc2Snv86JjhMJI7I3xoDzhABzF/nA5WqKcwA08QwjVyoIRhk3H+FaG1woFhlE4bGOt9D7W6lEODZcIoeCWI6gIwOK1zLGZERx6UgWVqF2zRrWAE00O+w1jwnWo3zHXhhUouHRz0DrdAvfvlAS+rOiC/p5EYRrhhUHgg9ftg+7/dHLPufdV/3Owf7wcMR7vfbh/uEhjj4Fw/GxsGtisj70N0IJA5A60RFY5FdQCEw2QPfEAA2+fRgTjS30j1DOtS3F9PyyTNxCeufs9fFH1j9gCVfjnO7z8ZISVHhxhuUP0AQfFtkRJHeEPxg5luq+bHDy5u3Rxbtzygj/vHhzBr+Q1srU8AhmdA7nayqAE31DHHsBbriFooP5HWF9w1NtgEBc2WpD6a7szIIymc/U0MOPvqZHlTQbGT2thRLFzW3GnsumaO5BNYN7UERgSjTkFmciypV4DOI0C995TTZ8bX/RZEdxLFFIKLpUGmEGzHHW6mccUnm4BqEsCAroPMPKKSNRt8VClXVrLDLJu6pRMDiA8y/7yVGUATIkn6hFYektnkVvH+DZaa7O3XlFaaTSmcoAREAPBJ2RNgAjIDOBbBKKn09HaC4LiUcV7cqMNa8kSEp37x0zJ5mmZxHP7RZx9zGB9BOSaOWDa+GDj2YbLhuRNQoz+YzkgTR19q1KcxWBzwBIJ/Eudnexu4vdLWN3+eEnD539U4I+nVXoc6GKtTwQYgX6GPIepZcW/Jwh93C9yEOkbz+fQ2D/jAuIlonbFKcAvyM+cqV8Dfgv7OHuDxF+lMaq2QIZJD06CUaQiUQ8IL4XHDuQSKrqrY72VpuhBAdVayAiZE3DZjpnHFRmcqVoUmj3WKyFVc8yPx102JgyII6q4tDNvHZIcockd9VoV42+mmq0Q5K72N3F7tOM3XuRZMkVRYvHSTafTrmZOU/zz1FazqDBYl2+DDky1TJaQWKsxFhBHTkEw25n2BkdRKIf8378snc46kYvu3z/oHPQGfa7B0G11l8u4rgMsnpMVezt7Oje0AlzDTguV+BcNtM6ri//gXqNGGFaw9RT4mbQOaj0aoEd+6vY8TudgWxAmN6Trl9evPj0DunD0EQe9eaWVzFoSXXuTQBCSnoHIG4lLYTuoOMOOu7Kz678fB3lZwcdd7G7i92nGbsPgo79L0HH/gOgY58hxBohxPojoWMs3WaOERgFZIhyUK9C2JiCKPDLrz76sM+4GYusBHpVFLm/7j31KRjHoMOeudE2vLB2q7ZcAZAVt6kLoBIE7cDiDizuCs6u4HwdBWcHFnexu4vdpxm7DwCLHg1tBovQYGuwCG2bbVZiqbe06fR/jRkpVDwH5N5MR4QW4wUKJFyBp3qg/Zj2ptPZlEHQckdrUN2h3+cKaaV1J+N5yx8jad350yHoNnPo6gCq4zY3CVAptgLfgRHBePMmT2Wz2Dar9A3tBx6C5tYkJdwF6QIQG9DOYzdAk9RuJHq2S4NE3BnB7+8Nyi3H91IudpXOABwzR2YPD894L6PbJK2aPbPUukletSIfyHVhkvlvl8UR2iDLOvXdOxq0Z8DpkogowhWaC7wBty+jvS6An2OXw45y9IDLq2qbM8TsjsOVlos6hOvV3RWGPmCzLnstwGeM38Lx/NvP5y/YGJEqZYrcIkgWEqcWEGsfwY0oEx4V2xmwExWnxfmGo9qGEYw8NkpAKcxvVy9OtX0HJeIT5HRSO3YSlEaw1/ab1Xmt34bN6T+okJ1I4/ayu33iXkS3gf8yLeTiFbkey8RfCmphEYdIzb5Y4sKp9jJyG5AjCH8kwRNL2nr04I5eWKGH8y+4g1SXeUBNeD7q23yiwmqP5qNGL0R6dT5+UJ/pHFy9W3GW0U7ohMYpiyZaW/F3xtB1MFQuxzlE2qPZosN3IUVE2G1XWArdkKEMAVQSf+8gMJRzJj7Eok6YRrsJPoXtj2RZyAs/0qGRH2sy0+1LqL3YMtbRA05gLPGMA4Y4YOjyhPX8u9KGjgWxjTJQHnAOcLywP2UCz2glNzpaazM/kW9RHywfeMaTqNh04C4GiyTof7mToNi6bAOpOihOKtJrrSRhnhbWt5qyitWEZQ2u8ptoKKtLenP8lm/lsNT+2eRFiY8Wiy4fVDL7vbP0hkzy58m7f1DG22WarzHTeJSM7kbD+ulE1clfe0y3ugho6Rgh/A9PKVYJkMN0Z3FysEooTXiGXk1RHU2koOWDVPAM8eEeepaeUiTCTB/DHyaJRGhsoA2ErQXcyocyAXpNdr4YmVPAOPCJdsVrm/sX/hpcEqajosk+w4xORWAWnM3hVlN49pP207ozsMxHNCw7KYwNoGs6zRWehQe28ynj4FJf8IhY2ih3iQsmd0oUutAE/cpeRRSjq6EITZrXmKn9MMKVaZj0Vgz/hbHA7tYvS4Pq0Yr+TOhCkE8iIc/EdnVo/yXa4G3hRCQpzich6wIAE5UR3p+er1AEYsqvxmszbvlOtoVtgQhOoZz79JqdZjukKQXcT7XNYAZcIf7Nf/FDDMu+fLdY1X8yH4PwBQ9nKq0UF+dQjbmbXblp7mWwdpoLfQf0cQc/08XrylwXP48xAWtg/7s7XN/Bud8cb7tDxzihAv/AoF2cUt2ozj/qKwlr1fOzmAXrP/vgVzoC+ljA9tLRm6tN30e4h4Xqxxh+j6GXv4iwxdDdxw/9tD6RcI8uii9APFIP/1/fNrhHj+W3Hx6pyN2HCp7ehwrucYfiaxQLb7haLAQ+sH4892UyfoGQb+nzRGt5KF5jqVmVhYI36Pcw31xi4AFfIXoEd5WvJc3xGwXOwUllroF7w1LpurIHAXVdrnp/8wZQ1/w/A05Gug== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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' + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/compare-identity-snapshots.api.mdx b/docs/api/beta/compare-identity-snapshots.api.mdx new file mode 100644 index 000000000..604304633 --- /dev/null +++ b/docs/api/beta/compare-identity-snapshots.api.mdx @@ -0,0 +1,95 @@ +--- +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: eJztXHlv3LgV/yqE+kcSw5rL4zgeoCgcJ9l6kWxcH01Rx0A4EjXDjYbUkpLtWcPfve89UsccPuLddtepgMAZSeTju9+PFKnrQGfC8FxqdRAHoyDSs4wbcRALlct8fqx4Zqc6t8FmkPOJDUZnQfmM/V3aXJt5cL4ZxMJGRmZIBoicTKVlM5FPdcwmIreMs1gmiTBCRYLphEW6UDlLtGGCR1PGo0hYy2QuZiyfZ8LSo3wq2EReCMVkOeJY5JcCbgyYLRljR+KXQhrowwsY0MhfSRhmIxAMx3omYzUqKYRTx/PICB4/YyAVSMuBVWFQtutAIv8Zz6fwSMEDuJIx/LbRVMx4MLoOkEG4a3Mj1SS42QyMYwC0l5tCrOpC1PwTKXHFZ1mKNF5F/d2eeLnzaofzoYh3+W5vHO/G21vD4fZgKxkDdc/RL4UARVcsldL37+ZslZOyI+ujakq+Fpga9Ho7YW8r7PVP+lujXg/+/fteRgaPZmRwFyOvHsyIc6ED8KATdKB17HBjOPZAN7Nr2Fzhc08xTb95ylLwG+R01VWf8yzbxPvo05uMBEnFTNBFHnU6nRcs18yIvDCqwxg7SJgq0pSh98+yfA6d4apB2HrKEIe+m4jZrZKncibzYJn3D/wKRpmNhUGuITyKFGKl5uOzOhaCnf1zi+0dHrDjnKuYm5jt6zQVEQXQYRUY58+neZ7ZUbcbiwuRYsLoWC7TTEuVdyBjdCHEujyTXevphFFFJ6wD7AWF9UyDWFLBzxlFaidohlDCUysaXjDY7q0xJYwrJsJAT0fG3dpCL5xJJWfFLBhBvxm/cr+JSiwSDlqgq5vbtKmTxIpVdX6k28A2aBDzUoIGdFpl8KDDTm0BVpwzm4lIJhIMdinzKdsg62yg4jM+kYrnAvobXUymRMcb5smY4zcYo1L/7cqnEFrRPcTLBmbWDQgO0CooPtNZkTpVCrbxr/BE5zwN97H3Bqo008oKNoUUD+5PdsCGa8JhyoGiLtIYKksdajKp7Ab6YxvOJzbYpUBVTRRoLAaLgc0k1jPUlrA55BCoczmy4utbxBWb8gsBt8FGpBxsL6HCRpAcQBook0aAxSBbxDCwgnwInmIFjrpBRP5Kkm8gT8TtBU8L4bSArYHtwpbcPAkPcjVyxYnGWqeCq6DhJ9Tz5uYcqTmTUtaGsoD/LaVqVqKSfQdgmB7/DPw66zfARyxyENTejj2Ag0iDR4MjwiiQ21MZkVjdny0Odf3wwuJYQIxhUMW5dALUpeoN8LWu/ZJsZixzw82cfRXz0DlAxqWxHQaVdO6dAQxp0B1gLCQP3jSek9uXivlJXzI7tyjnuPCB1PR68BAEf6kgZ9EJdb6QOnV4CoSOvqJpeRxLVxQPF8RaFOIGy2ll9HVCG918shfH6C2DTX99JGb6Au9sIZ26pq70GK706N2Ut4DBRK4ZpbfSp0/80iiYcRZ96ci7HwqFzYbrPHA/ldCJvTUGPCsEVFonE5foKUmwsY7nGPZSgSFl3HmEu93iVs6z93UsVrHNsku9k0qEE8MlciiI5Qg6ovNcyBgzGQW1I1n6ArXrLEA00ESnz17zmFA4yrfvhUFtGh59BVo4r7iPoVMloT8ruwAgrKYAa4YVO4KPX/Z2B8Pk5ZDzwathf2d7vJvwra3e7vbuLo4+A/PyyYJrlnG6OPQPQgkjI5bqCCzyKygE5gage5cicPCHhzbReID+EQG7tpWYnl+WiyuoDZy93j9kwx2WcjUp6D6fLClBhafHWDsBivBxmVpBckf4o5ETqdaxIhRW5LPgzdt3e6fvT+DO0dt/nL49hl9Ia2U2BzBYqhjdUlP1nEIiyWsBLrmFioXFAeoQ2/BUN0AgrmyzoXRXPgf5NA89/OhrejRJs8To2UIoUdxc5ey57IjOJuQyuAcVCHL6mFuX0Agf7EGoZ3n43mtywwODFx22V6UyV1dh0spxksk45gmQ2mM9CGVBlURD4oSyKyOxaItalYvWqFPK+6ZRMDiA8/v9ZC/KAVaSTyxEYeUtnkVvH+DZaW6Ru5OG0kilc5UDAoEeiFgjbQxWSiwKEkCRT0doLguJR5XtqozVzJSU7j44Zt7kmp5FvLAPiLvDFNJPSKJVDy6EDz6aqrhsRNYozeQzkkfh1Nm3qsxVBj4DFJ7Gbey2sdvG7gNjd/lhCXz8U4I+/VXoc6rKpTcQYgX6GPIepZfW55whN3EVxEOkHz+dQGB/xfU+y8RVhvOH3xEfuVK+ZuZQ2sPdHyP8qIy1YAtkkPToJEggE4l4RHzXHDuQSKraWh3tnQYwDw6q1kBEyJqGzXXh1n0KpWhGaTdZrIVVz3I/l3TzFcqAOKqKQzdta5FkiyTbatRWo++mGrVIso3dNnafZuzeiSQrrihaPE6yxWzGzdx5mn9OL9wYNKgX9auQI1MtoxUkxiqMFSwih2A86I/7yU4khjEfxi+3dpNB9HLAt3f6O/3xcLATNGv9WR3HVZAtxlTD3s6O7sWmMLgSWyhwLptrHS8u/4F6jUgwrWHqqXAz6BxUel5jx+EqdvxJ5yAbEAbsaG5ZXjw9eo/0YWgij3rThcGX7qZcEafXCAgp6QWCuJI2b6FjCx3b8tOWn++m/LTQsY3dNnafZux+E3Qc3gcdh98AHYcMIVaCEOuPhI6xdDtBEjAKyBAVoF6FsDEDUeCXX330YZ9zMxF5BfSaKHJ73XvqAzCOQYc9dqPd8sLardpyBUBWXGUugCoQ1ILFFiy2BactON9HwWnBYhu7bew+zdj9BrDo0dDtYBEaPBgsQttOj1VY6h3tWP1fY0YKFc8BuTfTEaHFuEaBhCvwIA60n9DGdjrcMgq67iQMqjv0xy8grXSvZXzT9YeAoLGDpI6/wqTQr9w5fA1mA3PddHgmO+X5DaUvafvwGHS1Jg3hvkcXctiANiq7ATqkaCPRl13iI+JO7X47cFDtUL6TMm4lR3vOAQ4zR2YTN/Z6v6LbJJ+aP7PUukN+tCIfyHVq0pvfLosjdIss69R352jQngGnSyKiCOdoLrA/nqNBe50CP/sua+0VaPOz82abY0TpjsOVlnXlwRXqwQpDH7HZgL0W4CXGb9p4/uOnkxdsgtiUckNhERYLiZMJiK5DcCPKfXvlBgbsROWoPg6xt7BFBGONJSkohfnd7c29zEeQxUnt2ElQ4sBeD9/bzhf63bKX/bMK2Rtp3NZ3t23ci+j2+59lpVy8IddjmfhLSS101EKiZl8sceFUexa5LccRBDyS4LitHbT16MEdvbBBD2dccAepLvOAmvB8LG7siUqrPZqPBXoh0lvk47P6NJW4dX+hW3ng0E7pQMcBi6ZaW/E3xtB1MFTOJgVE2qPZusRBQ4qIcNBrsBS6IUMZAowk/t5DYCjnTHyMZZxQjHZTegrbL2RZyAtf6IzJlwWZ6fYZVFtsGevoGw5sLPGMA4Y4YOjyhPX8+2MQwCzENspAecA5wH5tf8oEntFGbnS01mZ+It+lPlg+8BAmUbHZyF2M6iTof7mjmti6agOpOijP9NGLrDRlnhZWtAVllesHyxpc5TfVUEiX9Ob4rd7DYXH9s8mLEu/VyywfVTr/vbP0LZnkz5N3/6CM12aa7zHTeFyM7kbDLp36QSd/7THd6rKfpVOH8BeeUqwSBOflUbN86cRVlvIcvZqiOppKQQsGmeA54sNN9Cw9o0gsD25ZR2hioA2ErQXcyscyBXp03qscmVPAOPCJdsVrW/hX/BpcEiagosM+wRxORWAWnL/h5lJ49rP2E7ljsMwhGpa9KY0NoGs2KxQeVge2ixnj4FL3eEQsbVS4xAXTOVUdu9ME/apeZRSjq6EIHZrJmJn9mOBaNExzG4a/Zyywu/UL0aB6tKI/QloLciTcyTVstwjt76MN3hZORZrhDBKyrsCjX/UIHw5OVigCMeXX37WZdH0n28W2QASnUM59tjr9Ti+kKQXcz7TNYc7bIP7Df/lrCcv+fF2v5T+przb4woczlm6Gy3KozsLNstwE9yxYO8GFviP6CkM5x4UZ0RTMgB2ur3EpByd9N3jbHU7GmRQ4BkZrfZr1Dh3e8Y2FtUx/FbgW0fygg19xCOjE/yOHXv6qwgOGHjx+6D/XhxLulHb1OxGPlPlpfWDhDo2U3494pB7+v76McIceqy9HPFKR7WcOnt5nDu5wh/JbFrU3nNfrgt9YVZ77ahm/QAS49DmhtTyU77HUvMlCyRv0uzmHVs51iBn3wL28aHRZeb2PUlQLyj+8BXhz8x8/xgAj +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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' + +## Request + +

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. + +
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/complete-campaign.api.mdx b/docs/api/beta/complete-campaign.api.mdx new file mode 100644 index 000000000..58a45ad9d --- /dev/null +++ b/docs/api/beta/complete-campaign.api.mdx @@ -0,0 +1,119 @@ +--- +id: complete-campaign +sidebar_label: Complete a Campaign +hide_title: true +hide_table_of_contents: true +api: eJztW/9TGzcW/1c0ez80MNiAMSF45ubGAdKhlxTOgeYHYK7yrmyrWa/2pF2Ij+F/v8970q69NoQ07VzbjCcdau9KT+/7+zxZuo9MrqwstMlOk6gXxWaap6pQR3KaSz3Ooq2okGMX9a6iI2ULPdIxDxbVABfdbEWJcrHVOb0AjV6vF8uSvlzj38VEO6GyJDc6K8SdTlNhy0y4Mo6Vc6MyTWdiZKyQ2UzEFVFRTGQhpFViczOXrhBJqTY320/RU0VpMyFFbLJC4amyFhT1CGRUTVRg3uZmZgqxRBH80v+OguiOCDVkrSi0BS+O/3JrbnWiElEYIZOpBsfOeKax5Ow6iyWmBYIr9NStyog7Cd51oaZOTOStEsTaUKn5xITZG6j/lNqCLWtS/DUjcXQyuPh3//jd6Y/QWiLOBt/7b9dkrkTlVmEhBXMWtlRbkVNxaXUxgxHvo0un7BGp6VPRL4sJGVYnWa8SsVfmCeZGNw8wq8XKyhWvTYK590tWPuMPMm2LYzWSZUq8QwxNinds0YbySVFlYVoyJ90pUeamFhR0tkSZQTrHgypL9GN69ffByU9n/zyJPD/QBAQbydRBsmBvYg5006Df7V8ccXgfuXiippI+FbNcgWcz/EXFBSiBh5xMohzPXVlzVdxjvLMwNCxwN1EQzS6L9KJ/fj44++lkQ5A30wurbs1H9cLzvxFErhQyl71NQeYZdIXV2RjfVVZOyTaBJp4ELXC0sb4xfP5WfZJEDs/CuIcHENUFPzpaCmpvOocxNCqXVk5JOscOoknaXMI1tqIML/BNJ/i8oszA68OiXbzDNTV30YjBpMGsGu29Gh1297oH6rC7/7Iz3B8OX3U7Xbn/cu/wIHkVeTd00JzztursdFaN00cuyeHxoiUGnAvwMUR/8GFxJ10z58hqDtKI4aFu5hCMZI2v9Cuvz+7OziqHR6mmxHTCielpLocINQofnd3KVCe/gZdlH09UIXV6ZBK1asJli72Bm7fGVmri0OfSGBND1sMMMTVIzZ4kJSQSgce1G9aFJtq74rVMxCDIdxSEIee0Mv4IWlR2nmPoMtOYL6op8KI6wTyyrDpQcvhy57DTHb3sStl51d092B8ejuTe3s7h/uEhrT6FH8ixV01YW1orZytLf68yZXUsUhPDIv+FQqyS0D0zwItjCifx523ANL5A/xQxfmwtZuBXUN7eQkF5fXQuugcildm45OdyvKSErHX5nkIYzi6H9IhiE5J7wmdWj3X2GCtV5jk+edO/fHvBmedflyfv8YlorVT7PoI6S8gtwSp8YWLumOMgAMedSqEOlDOxGahuQiDJZb4eqN1CEIqQ4zAjrP7IjEXSYmTNtBFKsS9y4oVuq/YWihOeTWURT8RQOkyACWn4ps8drbdBk5tiomSi7EZb9JNE+xonEI0givkzEELFTzhvMIFRiVAGM7qYmLKgIq5j1bTFXJVNa8wz9NtFo1BwgPPn/QS1qgRzLOZiFNbeElgM9gHPXnNN7i6Ws+QsKySqIEYiTcbGAk4gM0E2XbgaYmnS/VRm1bg6Yy0WHk537zwzx4Xhd4CG7gvi7jxF+mmxaPWLWxWCz1HtDRiMrFGZKWSkkM95co3Ugi6qwBcjrdJkHbvr2F3H7hfG7vLLQcBl4S1Dn91V6HOZAQxPjOXiuQJ9LHtPxlCaB/kWyRtyS8zbuB8+XCCwPyru49SnnADn74iPfClfRZa1PfzzIcGP2lgNWxCDrEcvwQiZSCU95nvOMSvKq2pvdbU3xg41HDR7BCIia1oxMyV3xeigM+JEui2RGOWy7wrfQ0pGuD4D+j65xY3yGkmukeS6Gq2r0bdTjdZIch2769j9a8buZ5FkzRVHS8BJrpxOpZ15TwvvSVopMEBUO4SiDjk21TJaIWKixlhREzlEw87ucHd0EKtuIrvJy73DUSd+2ZH7B7sHu8Nu5yBarPVX8ziug6wZUwv29nZkFQPE3QLHlRmcyxXGJM3tP6jXqhGltbC77HEzdA6V3syxY3cVO/5oCsgGwsCO9ontxcvBW6KPpZk86c2UNlYEs73q/G8YBCn55wj1SbtiDR3X0HFdftbl55spP2vouI7ddez+NWP3V0HH7nPQsfsroGNXEMQaEcT6I6FjAtxB0GwEo9DJkhLqzQg25hAFn8LuYwj7QtqxKmqg10CRncNVFHlhjHhHR3ECWHKNnchsri5Kbxg7pbG2GqvpEM5Y0/EWZC0NdEtepaeKMCn8R6R6qjmOSSDQtbNWf1RAKh8zlb/Vq+gsTktwyEkhNbT3auBjmg6bjAj+gQLvg46RqH/HPc5grd+0HywGJPFbklicfIqVopiv93/3HzslcArmLaWL997WTxwX8HvmMkMboT7lPn3VEHQN1ddQfV3u1+X+2yj3a6i+jt117P41Y/dXQPWAhp6G6hjwxVAdY9s7osZSb/iw7P8bsXOoBA788WgTM1ZP5hiccQVciRjKDW+08sHbXrRdn4TfvtfJw3Z1Ijyi09wEDT1XpU0xeFIUuettb9/DWDDSQ1vmuo0cBnsVs8zctTF7ewgNPZJ8/HF2chwaIPrnp6HPaLN6rSYP9umOiXtlV+ePHZTOxws+S5lOEZMVZ2hBhCezJeDtwZv4MQmIVuI7x6Pb7D0r8kGuS5s+/HZZPKEnZHlMfZ9dDeMFOF0SkUS4mR++f0+426++cgR/Xktox7+zstgZDeuI10paPnZOh2Be/PDhYkOMCW1ytJeOgK7S1B4gXs7hIpzN+tWBEJrEBcaacjxhxvuNIzcUPWKUQmBxnb1XSlydBiX8iDQ/QF5mldIkxamAZt28qKyTqFuVUgVszzVJjqeTbBsa2paNeRtc7bgt0Bk+Tvlp+zpriWNNSYgOqPOYICJ3eeIqr+SSC3J9LRN/q6i1PLUWU3MbS1x41V7F/gh3jBAmEjJ1rK2vXtzTay3Qox4KT4jqMg+kicBH86BUXFntq/lo0GsRvSYf19mHiUYpbU4TPnMJh0qYJuJUxBNjnPqHEOQ6FAZX4xJR9NVs3dGiLY6IVmdngaWWX7KlWwCGzN9bBEbmnUkOqTAzLjF+i4RD8me2LGL+Z74x83NDZn58hfpJIxMTu6/mmRZs0YItnwNc4N+XJ3IsxDbJwHnAO8DR3P6cCQKjC3nP03o0qzP5bZ5DpSEGq0zF5T3/pTdPcOGT4Bc0uh6DNEy4uj46RveSAi2qUQ1lVTsCyxpc5Tc1KI1LevP81r9rUrn8s8lLEvfnGydnWTr7vbP0E5nkz5N3/6CMt84032KmCUiXNiAH8wuFJ1VP8vj1u/oaGxpu+CnzG3qJxeh4HYDe6g4gbVFPFP7iLQc5o3H0Oty9MfxZJJSnsqBw4HQQT7TivYNcyYJA4xbf55tyCKPNp7xB9wCJ0NhiDOLdAczKoU5Bj3e3q5UlR5pHpOQQ9N2V4ayFgS+jF1Vt8QHtXBbDntTK0SlfvPvFhJ7uPUx6ztddjysvAVqbTssMq1FAl1Mh4YvPuFKiXVz6jIfOLlOVLgxjxnpWFf7koyQCX09UdurORrQtjY53wWOeWQsO48KeNFRPVgxXCueCDFQq/XXErSW8/xxtuGlrotKcnATpGshNLazw7vRihSKIZeGHEGPH22GS26axIEJ9lXefvfZue6fFfQbdkERvhvZ3gfjR/Grvwk3phgvez3fi1zei/9Ab0aFsU7+1ndM2Idm09P2f77evolrPGN/jS6p1y40mbkLNOUbd39N+EvWgD/QYyYw2K65u5u0lt+VwUPo8v6f8pGO8CKIkG/yLWPOa7KN8V5ug2Wy+/xHh40dF2yaY93CDUX5fi5nxL8IPKa2LGWOhauLKL0TUdfsZfq/ss2NvFvYvzs9o1zAahrviU78VY+UdHtLfXnSNf/hiwuVjDOLn91G1sYkxnm4FOh/DXOEDlI5h/wPAmKWs +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Complete a Campaign

+ + + +:::caution deprecated + +This endpoint has been deprecated and may be replaced or removed in future versions of the API. + +::: + +:::caution + +This endpoint will run successfully for any campaigns that are **past due**. + +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 + + +## Request + +

Path Parameters

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/complete-trigger-invocation.api.mdx b/docs/api/beta/complete-trigger-invocation.api.mdx new file mode 100644 index 000000000..416dc5b81 --- /dev/null +++ b/docs/api/beta/complete-trigger-invocation.api.mdx @@ -0,0 +1,83 @@ +--- +id: complete-trigger-invocation +sidebar_label: Complete Trigger Invocation +hide_title: true +hide_table_of_contents: true +api: eJztW21z00gS/itTug8LVGQnjiGbfLkyIVxlC0g2L8WHkDrG0sgekEdajUTwpfLf7+mekSzZIckG6m6XMlSBJfX09Osz3aPRdZDlqpClzsxhHOwFUTbLU1Wqs0JPJqo4NF+yiJ8GG0EpJzbYuwj8MxtcbgSxslGhc6bYC/b9aCukEboZK8pMSHFy8Pv5wenZv08OTo+P3p0eiHKeK1E6Zj3wz2UhZxhd0CzXgSaOuSyneGTwAFc6xm8bTdVMBnvXATHAXQseZhLcbASF+qPShYIiZVGpZenOpkocvhJZIkr86opX601yqK+SLjBiM9naSgZyGO5Eu8NwOE62QzkYx+HOcPD8181EbY9jFdxcuomVLV9m8ZwEW5YjykypTEmPZJ6n2s3b/2RJrutVjbLxJxWVZJKC3FNqZZlORYUqVzVfVvTcaIjT1tCNhN6yFFfSioky5HUVi6upMsv2IArQ0/OeOPG6sBMrUJqS5Fd0TeOUifNMm/IxlsOIosiK+zUi1zGpmClr5YRn1yZ2kkiRSJ1CxJYOIHUDdIJgnHelG0UR2AjvNaGtiJXR0JZEyqoyr8rbvNEwYDcW2RfycCJTq25WBHZhLRyzdoQtGbsnDksrXAQ4QRJtWBUm9OnhbmseENx0Iv2iDotGcsRjqUtWtE7IVh7fdPSoQ+phDmsbZ9kC9IfksnlmrIvXweaQ/uta5h2ZgtNBhI0LLStb+4Piz1bso6RKxZgMOFWFIvuYxXAYdUyDyqpoWayWgH053NxclWA/1TT8gMMjRIDXDJKOFGMkM80IX8lUxxRBPyiPY1UiXvezWN0f+a8RDeGkkBwULqIjDBRkfB1jhJhlsIxjWWMb03VDHpbobYmXMuaEJv32vTIwU1nI6DN40RLwQHCphwgdiwRCfWNataPk+MXm7mCYvBhKOfh1uLXzfLybyO3tzd3nu7s0u09p25pbFoWcr0z9L0ItHYkUsZzq/8AgACnYngVwSLIR6FLN7P0+YB4PsD8hj6Nt1GwgSH0tNwA+L/ePxXBHpNJMKr4vJ0tGMOH5Ka1iVZrKMd2iZQGaO8ZHyHFtbhNFmWpGGf7q4PXo/M0Z7vhFNNggXivr78jUGQVREQvT7Iol9gpwXqkU5iBgf+a5PoNC0tg2oXZXdm5hTMIeWaUlRvjZbxnRZi2SIpt1Uonz5mspnuie6m0ga3FvJstoKsbSYkDmUvcZ4XJehm+8JZ+JqZKxKp72xCiOGf1kKpCNYIrxc0p/GceL3E8qpDKE0eUUQAWswFK1tKQvTNn1xgIz37SdQskBye+Pk1FUVhCO1WxnYRMtul5mHeLF3nJd6c6WUXBuShnRgpumc5ixKGBhBkSNVaMGQk22n0lT0zWIRYhcq8Vw99YJ86rM+FkkK/uAvDtOAT8hq9Y8+KJ88lnCYYdG7I3aTR6RfJXAgz1V46468UWiVRqvc3edu+vcfWDuLj888VWPf8qlz9Zq6XNuqITPCl48V0qfpsKqiVwp7Ry5IVwxTYb47f0ZEvszOgfQq685VaI/sD5qmoIlNzX+cPfHVH40zur4ggRkOzoNXHuwx3IvJGZDOVNtr872OivGGgFqbikRgZqFmGeVkDBZURlDkki7IeJMWfNLKaYS+Chdl8EISLOaOGw6pXUlua4k16vRejX6OVajdSW5zt117v49c/fOSrKRirPF10m2ms1kMXeR5p+TtlKAoNl/E03KsauWqxViJpoaK+hWDsF4sDXeSnYiNYzlMH6xvZsMohcD+Xxna2drPBzsBO21/mKRx02SdXOq5W/nRzYxirgvqOMqg+CyZZbF3e0/mLdQCcFavfXNdTNsDpNeNrXjYHe1djzLMvFWmnldIdlODWkWNiJMA+2MaIuaFgRSTICLRgCqNOSiUNIzBS60aS9SPdOcvKQF+BbzcJSUUMUlyvJOKK6jtIKEjARpRlVzhsDSUFIlVPOBA1ewE6DzD6xOvYu+q5IXJ6TxG9JYHHyNlKJEbyr357ft7x5C+IIw4tQ5+Bsbva7bkQYBgIbAYVZTd67r83V9vl7j12v8z7HGr+vzde6uc/fvmbt/oj731dC363MQPLg+B21vUzS11GsKrv95mc6p4iXg8BZZFFUFbzfXNTjXFQglEijPLIMInRraC/r+9ES4OG5h+9c6vunXhzHoOBEXiU6+qkgxbFqWud3r96/hNrjrpidz3QOawXPl3GRXPYzuj2GrW2CIzgu4lCMCMTo+9G1Gjw1daIplB3zM3JmdVaOohfl5i/hOznQYivw5zypAHbPZoMNUPq74NimIpuIXy9Q9jqMV/aDXeZHefL8ujtE3dLnNfHfOBnoBSZdUJBUuyV3wPxixv84hz75DrVFFLr+4bNOcUpXuJFyhXKw81NkNVgQ6IrKBeKlkgRbCvex48tv7s6ets1OVpbJYaWomkF3HCCPGvlG98U+DeDkqsmoyZeVGnVcrlGsiSWEU8cGcKiUuDr2h3mFROAGKs9lHi3NXGHX5pPZgrL6olNbL3sLaFJw6Nn1YsS87457y2shNhDb4OXMHkD6YULzSBFmUH0zjVeSeUFzktV6ypddjhfhHzS103ELmZp8uSeFMexG5ozoREp5YyNSytR49ueMXtvhRx4U7xHVZBrKEl6P7QiyqvfZoOTr8QuLXleODeT/VWHi7w4TDOWGxbqaxOBTRNMus+qcQFDqUKheTCpn2aLGuaNKQMyIcbLZECt2UoQ5RRrJ8b5AYxgWTHNMyzlVMhgLPxC5tP7JngQsf0WTH4mNHZ759gdWWKOMsso+WmSYMacLQ4YT18rvFjAILuU06MA64ANhf+J+RwAvawkbH61bkZ/Z9HsOnUSGqO52Z77mLvQUI+l+CHxB1QwOopiq8eUWIa+F50YrWMVa9f7BswVV50wwL6ZLdnLzN/hUtrn81fUnj0WKb5cik8x+N0t9Akr8O7v6fEG+NND8j0vi6mLYrTxZH0w8ef+7XH8m44+T0nWeD0fAj8tkCvpdp59tLX16u7kBaPi6Nf/HUujPf6AbQa3H3yAVVm1GeypISjAEmmmrFexe5kiWVqhsU5NmMQQHykSLoUJnRhE+7F7CeRLepU/Dj3fV6Zsm56+pgCjG6thU3UHy2e4peWPXEezoOHyFCqJWk8yF49inzPeUpguSYYky8quMO9d9sVhnMRhBRzYREdN8TnLG2UeUwFJ2lUbUtMq5Cm1E1oFDUkwo9bqqKmT1KaFscHXcrBu+ZCyFo/Z44TE9e9N9jLBQ5Uanrr0DX7TLu443AD6cqzamZxQKAWlC1Znh7eLbCEcyMhV6R6mXFpO8H2T7Rggl1cy58tntbvc2Quxvcp94Q7XeLeX06XtSn9Tufu3RC8XrxRuA7v3LxCxp1Iv2ctttItsp1T65vvQhu6Vsxco8/f2laVzQ6U2p3QX99TTs01Mvd0G3kJrX/F5eLNo3bJZicftdpeYeKT+qvPp7yO6aHfDVzq171ZqOZL/YZAvz8rGh7AvqgiYcavH/EIroH/oVFeDbnKqIeuPImhnpaN8LtSd1Je9naJzg+ot25YOy/15m5LY9CXuEm/bsXfMBfwrTcWZ8+6qH710G9gQgax5f+/Bd6d6eT +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Complete Trigger Invocation

+ + + + + +Completes an invocation to a REQUEST_RESPONSE type trigger. + +## Request + +

Path Parameters

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/complete-work-item.api.mdx b/docs/api/beta/complete-work-item.api.mdx new file mode 100644 index 000000000..574552035 --- /dev/null +++ b/docs/api/beta/complete-work-item.api.mdx @@ -0,0 +1,75 @@ +--- +id: complete-work-item +sidebar_label: Complete a Work Item +hide_title: true +hide_table_of_contents: true +api: eJztW1tz4joS/isq9mEuFXMLJMDLLkPIHGYJZAmZ2bOZVB1hC9CMsbyynRk2lf++3S3b2EASws6eW/GEkaW+96duIe4Lyheah1J5PafQKthq4bsiFJ+U/toLxaJwVAj5LCi0bgo4xHAsKNweFRwR2Fr6uBCWjecyYO3LHkvWB4yzb7hAwoIi68pwLjTjHuPOQnpHTGkGI0x986Q3K9mR1sILWRTApEUUhGzBvwqYAVS1+HckgrAIkvhc8wUQ1yjPfUEiZ5+Hc3jlwQv4Jh14Duy5WPBC674QLn0cDUINXAoPRwUkJrUATUMdiU0tBOudMTUl2VLxgaT4zlEvmCOmx41ps3ZcOxXNWv2kOqlPJo1atcbrJ8fNU6dReLhFNoGvvEAEKES1XMaPPKs2SywcMDX5IuwQuNjKC8EMOJv7vitt8kvpS4BL7jf1Shf6Gr0YSsMQjLCh+7qqz6lZtZuVRrlxXHeqol45aZQrdee4Om00yzav1BuVxJjgGaF7L2KYLtuf4ZkMfJcvB+T05zijVx2zAKPkaTE+qLnHrhYQrsgQwnM37fKRQ8terB2t2l2lrC6bDD9wCJqVIrYWPBRbFZkqveAQcwUHZlihBP45ycuVU6t8alUq40qjVau3jk+L5WbjX0h1oRw5lfuSbVjlE6taH1fLrWq1VW0UK+Uakc3pupN3VyNPR3WHzMC4basI4AamByrStmCv2mevkHUQwvttTIUXLRAEz3uD3tVP3TMYGnU/dDvj+HF8PRrQY/efl70RPV12B2e9wXt46rQHnW4fB73IdW+zEmXobepF0qBGPKdPKENamyDIFQkN0huhHxf+evD3wfDTAEbedwfdUa+DsnVH4955r9Me94YDUuWie9ZLvp2B2O+TL+3Ly9HwY7sPjx97wz4Nj7ofe91PMHI+HF2g0sN+r/Nz+hoZ/NTu97uD91147l1ctjvj9qDd//mqdwUDV733g+H5OdrtY3cwhs+L9uC63YdZZvW4ezUu5Cy2En3TYKj4tghYt9gYDUSAshCONLsfbWw/BFvzYGDj4mmM5S8GhZDrmQhfDkE5rsxQ2ZP5fpD0rABfAGmLQQJQZsK+uP4yzrCJSrftOLBLB8g7s9fup2t2szaAkuPXtkN5J9gZFB52qPSSeIZAehKFYk+OyXI2ETA/0Vk4Ocb+XHliEC0msDlkeQ6Tkm83xmmFuN3CaOSsSDkRIt+JwSl9/5G70Y4q3+HUl+lcr1Ster1uVaqVKrL1OBq/50BdJcPlrpYmh8l4USLAtiDGbdZEMXB7WCHNKI8sZyKEmEuiTStQ7AcDTkKWIO9VAFDw4nSPt8Ud+cV7qBZTAbW7LRw2WSbZsJLkiZTPZM2vknLezpmWRhrYkVY9hR7qZcmUpb1auj1l7nbPlCxZsyxLkv9tUoTO7I9e4WTyq53Jokxy7e7jlN2mh9txaJtqkcrnuKvdu9KtlK1Kc1w5btWaWEAfN+pU6YLJ12FAQgs4o2J+SwIQlKO5JDWO0nu81q00gb7QWuksda41X8I0ucZ11SGnBG7WzAS1RTjnIfvGAxb4wibopW+eCtkULOYUC7dZH6UdLngOx2vbGuGOK7Hz76KkzGIjEUbaA8Iy16WxiXKWTKLK4HTpFH9ct+xQ9HSUs0PgnEtPWDPNJUpIxmU2LGQYi9LBTWmhNPYjSDKBKppXzMUEWKJYYe+4A/oa/TqxMmg+ze2vQGuXou/ak7CeJUtgywJP6MfYilPBJyflZrU2PalxXm3UKqf1SXPKj4/LzXqzST0dwBqfiW1Bk2f9XkDPKW3mKhs88h8wCKQLNp0oADHfEmeP+IBo7Ji4Zm6qZiwvC8X38Ahg5F3nktVOmcu9WUTjfLZmBM+6xtYDgYpPcAiPgkBzQ3io5UxuxfIEIM+65+3r/phA8R/X2J8koLd2xONBtDoYlopydq6+kcSxApRHwgVzCKfI3sZU34JC3AuyE6X5FiwDTENHTHnkhrAi5r5lRZY0m2q1yKUS5c33kL2WRVE8gmKKjttCe84mPIAFcT33FmBQ+KHVjy35ls0Fd4R+U2Sw+0lUEvZ42msCWL8EQow7DqauITCNIJVBGNjuVRQiSkhb5H2xMmXeGysM6WedgskBkj8fJ7D9RyAcqZnNwjRaYhFj/4DMxnJ56cYZo5FJl17IobCAme4SzKixuGCw6QJABiyGI3RXAMDjJfNSxMpCI8HdhRHmLFT0zuZRsEPeXboAPxaplr64E3HyQRioGI3IG4mbYkSCl1TI4uJ4VuquJPEZ4LrrHHL3kLuH3N0xd9dfjuLj//gtlT7Hm6XPudITCVb3ttQ99EvIUkWMgxt05OHPJIwHR8xRIvBehWzO76gJAzlMWoPswnMsX0EFeSiPDuXRAWIPEPvngdhDeXTI3UPu/jFz98nyKJWKsiWuk4JoseB6aSItfm9OCWECS25XrC5OpAel2WoFibG0xirkK4fCpFqZVKantqg5vOacHDenVfukyuunldPKpFY9LWT3+ptVHqdJls+pjL+NH83xptB3UMdFHgRXECrl5M+0Ijo+R1hD6OERRJOGUgFsDia9fXhIasfaZu04UCHoBoShdtSPnJldj/rmeN6QR7uZX7sxacl05kQPS0o6xBPfZfAD76EcSsdD6XjYfg7bz6F0PJSOh9w95O7/u3SsPVc61l5QOtbYIPlZ87csHR2oO+j3VXAK6JBclNbCB1XgyVzBSdLe3FBJC71VFUnlB0Qciu8rKvLo4nSrUMJfeC1CpNK9dB7gjWFtZI+0C5PmYegHrVLpHnwJPnwocl8Wk+sxnvqGlwtKEzDgFmzCH21NHuIEuiRuGBTJ+lpigBs0JOLGF5TOGMrgEzrSfJJycjNkCWozQ+YILwPGwUbD+Bs+95bxlY4iBdeGfqDXtXYf/nddDKFHdNlmvie5wXwGkq6piCrcorsgKuhuE/jrGuTpGChrR+jgm9vsnCss3Y2EGzNX2xF2ItUNgYY4rcreCa4hMEP1VXjs9YdP4zdshgUrAUYUYK0s4tv+7BLCiACxnRxU4yIKVq2i2ZyUa8d9jwllTEA2dcEo7LN3JQS7Se5uDWCnGAG0k9lxkSA0wVW3rxMPOuJOuLiJFlfWxuCUjlcCK5Z4bt0byhzqLKRn7nHAaPGzZ8VXhyRu/DgnVpFO4dmNn+jFM3rtK8RfEmqWoWYRteDNmhTGtDe2uS9ha0Fm4W5A1tqbuaFnZehhGwYjSHVdBrRELAfPec1OvLa3HDl6FtLLy/HZ+zSXsBvnlzGDaiyAzdR1WI/Zc6UC8VfGMHQwVW5mEWTa3mJ9Q6YWZYRVLWdEsgxLS1pQW5J8fUgMzwQTn+DeTqWNMtBNafsLeRZw4RfGYeyXnM40fANbMM50lB3sLTMytJChZXAiiOU3OxwGFt5aAh0IB0wAdFb+JySIBc1go6G1FfmJfInW4PZhg6hEJfBb5ktrBYLxE6MXODudA1CNpXn6kxZ8ZzEt3L9yxkoOFdYtuCmvq2CTXbObkTc9b8GN9/emL2rcXp29DD13+aNR+hEk+f3g7m+EeAek+TMiTVwFY7gR27iryAb5u7im2zwLDPC/iFBv41vKVbylCS1BSH0cVTFZQr7LQ4xqymp7LgWdIviCh1gfHmFkqQVlIjT8mP7QKxKhGd041SAyh75PukCvyMYrzpwSxhSf6Ff8HkTxUa6CkISuVBTZJ2jsPBvcgk0dXiKAd19U3N1dgWcu0bHsLHE2FF2LReThVXcQO1owDiH1TEQ4MrAjA1zQ43kisYWi0i9dlWQxhhqqUKQuRy+C4fQKKmfofTOOf4YX+D2IT6fB9OjF+F+fK0VGwqXIxHn50v452hBt1ly4PraVgLpQgIkMh4veeIMiEPPiPkvpWSleFJRwLl7eBuVN+BwXK8WyRS0FjGP7BY1whngnvl0MlWX6H9v1GLxfHcr/Sn+2jbcZ7A9KPp6MofCR6WlM73hTWPWOsKAlHfyn1hzbS3h3f48HJ9hNPeAw0MWu/OZ21ShRwwL2x2doTKeACOt/yc2q/XoU/3n3DabEI3/U3Sp1curnLVcNfwEevwo8JwCxoU0Gwekgh4QyL8xRT2bJxo8h2FqlffXl8Aoc//BfY34twA== +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
\ No newline at end of file diff --git a/docs/api/beta/connector-rule-management.tag.mdx b/docs/api/beta/connector-rule-management.tag.mdx new file mode 100644 index 000000000..8fa8cc7a0 --- /dev/null +++ b/docs/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/docs/api/beta/connectors.tag.mdx b/docs/api/beta/connectors.tag.mdx new file mode 100644 index 000000000..11f6a76b8 --- /dev/null +++ b/docs/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/docs/api/beta/create-access-profile.api.mdx b/docs/api/beta/create-access-profile.api.mdx new file mode 100644 index 000000000..8cdb87794 --- /dev/null +++ b/docs/api/beta/create-access-profile.api.mdx @@ -0,0 +1,157 @@ +--- +id: create-access-profile +sidebar_label: Create an Access Profile +hide_title: true +hide_table_of_contents: true +api: eJztPf1z4jiy/4qK98PspjABwpCQqq07BrKzXGVCjpCbei+T2hW2DNo1NmvZk+Gm8r9fd0v+xITMx5u73XNN1QC21Gq1+kutVudjI9iIkEcy8CdO47xhh4JHYmjbQqnrMHClJxrNRsSXqnF+19DPmXmhGvfNhiOUHcoNAoDu85VUbHg9YRqOYtxnxU6td/6QRcFvwmcPMlph4yabzl7/PBy/mVw12Wx6eVH4fnP7yvy8md7ORunLIEweJC0Yj6NVEMpoywCLUPwey1A4MBizueexyODWYhOfcceRiHOT8Tw2ge9ti8M+Pc46VhFbCMaVCmwJM3Y0nGglSvN+odhNEIc2EmAOb9f8g1zHa6bizSYIsaMn/CV0dWFA7J4jLHOl8BycVLfdbjN7xUNuRyJULXYZ+EsR5hsrwABmC0htQqFE+B5AI0zxQapI+kvGNV4bs4hNtgoexHsRAin8LfPFQ7kFzI49CIDJFTWJNw6tLRA2BVqJgCfXMtIrUEYcmAoXSKjoVeBsG+cfG8l6Nc6jMBbNhh34kfAjfMU3G0/axKTHvypktI8NZa/EmuO3aLsRwHrB4ldhR40yRxZXAV7DrIDjIwnsC52lkwOhohDmsgMCl2syZoFbsazQWHzg642H/bv2oHPWPuOnnUHbafdFuwPfBidnru1026eDLk2aO1NgMj3Lx2bD52txGIUraPUMBC7gM9gKYcEC8QVXwsLxrAfgVdF4LAHdHdOPPY8vEJJegiIOEx/YaE2rwPgiiKND2IwCz4MlwfaAOqyljDyxhk9iHcTsmDAjOMKgzhLUEV+tRZ6xRGNuwBTRYQ/AsgmQZkPjD82Rf61IrkvL1+52rPaJ1e7Mu93zk+75y7NWp937v6plWweOBKn8QtQ8DuojAdX6BAy78277HJDs7sdQ+LiUeQQXQeAJ7hOGLo+9qHqd364EoBtW4QwayIAFJVrFjbkW+NZn2yDWSlL6thc7oCkjUHQ47cAX7CLjiVZ+omYKwYMvQpxAEcEpPt4rDWV1kDG1yz0lygpAN99dROHHazR5k/HF1Xwy/99dW6fRwH4tRnZPa+nEJAhJVPSEGzHEAQ2JEhGy/osE6AugAlBmE0dgz7D5g1RAItYDZfmKO2ymVSQTYQi9Sa2CToeVK1ArwxFo9hyFNnFIGMFMOhX6i/f6LueOEL12p+8ueqDGzuxuu38yaDxbX/0Ur7lPygdJzxypNh4H45JTY7S4wEYgAPAGrUWeUgFYDjQdEnQNu57ezPHh9XA++ok4DwjZZDLSxAaJsbXJteMwhKmx99yLiwOB+c0j8UXkNia78QjkIP5NmGEmXAHj26S7FFn7KgP1pRZI+xHa0dD/raRd5XOgNGaeScVSD05PT2ChT/odMFUnrrNoL/rtfke4PZzBIdHQblGVEyhILIr4NjVBuffAtwrX23TPY2UePZvNcKQq3sq5Y3rwwijT8Y01HFvJYLlVLPi9uiesaYO0aWa9cnjxMOTbg5ZzCJ4QarySETzsNBKvJ/oUNQxqMO3I4tJ6Hnhu5F4tyICCRGdsDdLhC+GQrUVfiqMoPaF8wRCv1WF/KtfL6HTyKZnaCBvMmE06DmaqfcjWDrvvY6q9o4DkjudTrWdzzEca7/LiDXwiB+Z8oNyLZ+rD4miTcesJUem2Oz3RORGdbrc9oB9PsevTfFEcN8/IRQxGVz/kGKfVG7SF64iXzentD9NwOQrwyw14+tIWY7GJmuPRDz/9fTjGTy+AvU+Bx3ODEm8/pp64RvTrugs50Oy95MnWwjxusZHW2N62CWr8N2Kl8o6R+QGakgwOgKV9WrZ1og2ODbYgWMPmIpWYVKpwU5Mo9xEMh4ZnmkgK7HvA1ID04OgoLOQvVuBB4LgxLuzoiKTx6AhtVJTZf20xlLZcaFnImlS5N5oWBq9R4LtyieQ/oEsKBETJhm6x3sGbvSPSJxHep22PHaxJFc3SvVfl6u9bboNE5owZPYOE1CNqAw2DvpcOvtbDsV/hqXS3RPAMTplEVeJjGJFITxsaX3Jv9PnTgFWG3SXgB9+rcX1ANxbG+QrY6pG4d4N7V/HpduQSrYh+tEiwAfJvNLMR8F0k9+r1IiskVJgfMPrD6+ufp2+vLmbwLPk08ZHk55vh1fA1fXs9/cfF7Gp4BS9fz6a317u+wljPBqMJgLX0HQnUjzn5gMswiDfwHKwWaRK1CXwlUQMgn6crB42RCC32DxRMMIshOgDQBs2jar3zj45SpI+Oztk88QnTLUQWXnjnY/O0aWGnkTPXJcUA2MyAzXTnPDF2YBjXrWz5d3SNBmUIiVDecJ8vMzipB2+UZm7Jddcy5RHGkL3GFfY5eKjsNRK3qYGRZ6mdSCC0seSA22JL74+OEuaYOKDuSM0V7NPOMqe8jl0+I9LgJPNMvYoEXJPFCjAj/U+SmedbxH4Hlzyivb59OjjrDCzeH7hWb8C71kLYC6sDNv60w0W/b/f3O4TDgvhCu1zDWWKfpAfL0iCj+j7QTPWJGn6Wdnyelm8dVPPfVO+Uka9VUK2CahX0TVQQil6mgJRYPne7WhZQQ6RyxFgrAqDLZKzwIxmhyaSLJwNNdJ+TYAQetlRFI+TS17HOlCZ3Dfd00Vmc8RPrpSscq+c6PYs73YF1ZnZbp6IzgB7dgb3o2+2+1XH4mdU7Edw6W4ietTjpdF+63d6Z2+WN+0fSK++lApxhFiMMMYeS78YR39Li+Rknr0Bm1+CxSUALkQ9idAADfzfqQnPc3SEU4i1NTQTxAc9hEBkKjuLugaSOL8FTVhhED1RuNNyArAJ8hHt0+JXOZW+QoGJBU9p+zM73MPKBGtFeSc+BTRcQvvh2eDUuv4adEajGOEKmcNCLzrcfTa/mw8nVDTymPRE8AsngoPIfm8Wua606Dve/sYMoao08Hv7WeLxHMF+C4MXfb4eXefCv5QKPj8roRcITmxXQ+ypeL56D5stOF9G7fzxkeXNw9tuzFM2r6fzn9Edu2J+G+L+ePSzhjgW7STfC6XjEttdVYlCIlSSDJTqkqsc0nQPq1Ixsn3hmhezN0u4maBXh9lEfJhwdpcjjnloR/0N3jWOTZcRpsoQ2dAoM1GnmN+C5s9/CLl8rctrGSTLnIL+7e/OGWHPp7YjUY7r4n2pJbqiZiRrArHHKe2jycBweR3mjk1/R9MQlfXKASECajE5fRJ/0rCfFFN76QcT03CwkiEPx+OTkFxxWMIjm7Jc8FzRcm1DSYVgSyktpbvPQE6JlQ5eOPXAHi77r/BXXQfo8AgRgM07Hgank71i0Z0Yvx8KVPjhodGSAM7UNkyf+XLIomj1T3Zt6SZk7cOBguZb8WvJrya8lv5b8P6Xk15L+7SR9D9GHqACQMNQllecWS44BcFe6Q0yQKKTadNYsnpUmaRtpFkKLDdMkPeLoUODb98KjvW+qPjDWk55ENXNnop7gLlAQkC4QAmHvcNrj0+J4icOe0EHj04dDf1ySPIsE3ZoEnfTEVp903ZksKXMGnead3O+JIGHMiABQKFNbrG67sxsdKYU2siy6OjGzTsysEzPrxMw6MbNOzKwTM+vEzDoxs07MzEc26sTMOjGzTsysEzPrxMw6MbPOiqqzov7dWVF1YmadmFmroFoF1YmZdWJmnZhZJ2bWSRr/LUkadXpWnZ5VS34t+bXk15JfS/5/h+TXkl4nZtaJmXVi5h81MbPXbu8GREaexGP9C0p/sYBiURz6GcWSaPQicKj0qfRB4UmK5Xx2smbRdDoiAoUwAuocFv8fwZxby5BLxFBn7NjQ0RzgIanXQYj1TRFkYpMqdD9QotUppP+MzGRwOUJuY3SzOoRYROjWl7+j+jddmHTSIqtVJudU8EW/Pej23H6P8+5Zr3P6cjFw+clJe/ByQLlWa1g2vqwM2BeHfi2ABcAzodN++U+Bp9BcmaMCGvz5UXiC8czcG902nabBF8zfhwgr3r4aXbPeKfO4v4zpOV+WiOBbtzdVdlcDnoZyKZ90o8YXPw5vL+fwZAYm8eIGviGsHW9p6FNg30ZLg7ywCh4IYzMBzMVUApNV0V4eGahHMCHuq3xDqX+pLbgwa2YOeKGHGb2iRx40c8NgXRAlkpsPEftOtkSrCZomTWfDFFgniT0eoQhvIuvSUPKIrQR3RPg9qCNTYZh72v1QSToddxydP4cA3BhEWQcvMXEX7Lq0S/Y5I2VZwSZ65DK/KCgcgPkzzLQd4WEKTTMvhSm3GBTN+mCFYhqniN08RzQi6daPuA2z4J63BTKGIWYbgN8CWlsxo47oKAEUj5+0SzVWISEGsXmjkRlHAb2zeayeIXfXHqgfi6aWvngvjPCpNHrriLQQNFDCaCTjNFFn0ypdrkTw04OOWnZr2a1l9zmyW345MzdQzFtyfSquodz6pto6Gs8d1yc0u6GkJPs/teOoF5J2YcZF+tvbuanzrk9+aAP29fwjbcp379Ck61E6pE9Mf7YWiCDR0aQSgCYSzjnhnWFMhNKkOtkd7ccgXEhgUL/CRQStGVLOP/q/YexTKhhXTeYEQvkvIrbioB9NEiBpQLow4FibQOo01NqTrD3J2hrV1ujPYY1qT7KW3Vp2/5iy+6QnmWJF0mL8JBWv1zzcak4z7+kuDIMGSfagyJLz09OFvLeCwFjqYzWKnkNj0e0sOu6pLXoO7zn9k4Hbtftd/vK0c9pZ9Lqnjbytv8vkOBWyokzl1luvI5GY/pxPyGIfmEtFQeAUw39A3lC4qNZQ9aR+M9C8hVkxie/YHez6jvMgwDzCbeIhqYIP6Wc0Qp0GbdfYNkza0pWKJehFn4GqkoHO0ZNrAVBCPHUwfwmoRQmWADfcWkMX7ydoQUmYLB3FXEpVpAm8QN//eOASY74u+nwAgTxYzNX6it6pWaIv8uTZDGd8iTNmFx9sIVDQU8/9ZVV8d4I3X1BH3OgF3hPo1bsd7gMDwIZA66zU76z989o/r218beP/HDa+9s9r2a1l948pu5/gnxtvaL9/Dg2e7Z9D21abpb7Uj3TH81u76SQqBgNibxbYVP3CyXxwugMCD/E+CA5yC379SLPyEJx2lEzp+Oc6GmttdH7Auc7Vb9w/3iOOwIk4n01AF7k2HLs1jotdFGYdkEepJxOHHjRaRdFGnR8ff4Q1hrV9bPGNbElz1cIPHjDh53gBhK3QWbq+AfIbNqC/9KoHaNGqhBIZX2tJAq7XyNy2bShYK4onPwk5qRexDWLQiwSmiWlLhgnpMaC4gR3IC2Uu5SNNd+YH87oNvccvn4sGtGcuVeR7cjRozwDT0hRxCvcZX+RuBO5wR2aCcIvX3Rlsis267JXgId4Hp1OP7/72dv49W6KTSkoiVugfm1I4nF0Di5ASHCYnANiJ7FIYxEtzu6VwxoJCx1wPJsze+TdCsLvkus4VWIcZqHMiKXYSpEGw1/13yeo4mDODhrOVURIZDxj/GCh0zAv9vicjSbsJmVW7ar3zLTaWoa5lpaiNmaKufXG3SebFc/P6XCT+J4FmGTEjaOr7EhaatHe2ztmxQfIRBPcUUeuzB9fwrBw83HrBE4RaxgEpYfAonozZyap9Nh4FeBbCK+Lxzn+rL2EVujGtsZgCA+o5bGLuUv2FMWQdFIO7ZQxS9Nlo0c0viyTC6rZzKFl6SEta4E8SfpcgGL5mJl0ujdyZADw939Ei+QutLMj8L7DbdtgvhTnT4zswu9jSCWz12TjjgBYOaGkdoAz+2qohY4Fs4xx0TQhigFG2/qQJDKI5vadhVWp1An9MfdA02IAqQVGbc/3jPFNw5hujF9g6bQNqGN3x9KwQ/7i2gYWmrUCsJJBQpuAuvl4AFrVEN41vGshCK/ufNl+cce6SMFZ6+9paeo8m+c/Ru/8mjVdrmj+jpjEOMsYtZ9lfiL/I7s3qkk5Pl9QsC9sXVrzMFW3Ue7q0AKKR8bTQn65rdbhgX1KZKqtZly9Ml4PxRCW49I5rWrDNwCzVUSsXSbtL0c6X5GpWjVpRVCsd5cuLX92XKlxp2u6pvrRbEinJMq+uNGSAlSts3JXLWexWKCgWKHhmYYD7pyuLfFM8sgIDX/kG//4L/PVl9v/Hy+xYLQ+sL+kbE1jJ2/xXZvu6exxCNQkFVjG4npCmo9AEt6OsZEEe0MbjERp5cnKAAIICqRvBST6baGiDNTkmwAYopEJpQEuqzBaCBueeKXRBR33JyJz8B73PRjOnL2HoQmRUV4H7S9Fib0H3+jZoQYxrYbIavPs1MAGuGzBU12jn2DixfQylPvaxQgSgHa+xjOIhA+lIZccqKb7oi4QWdLuEpb0SpwYtL06BavmIcK2mrtFpOTt4YCwwg8oc0AHpcyYsm8hMePqmILQrRjEOwQbja62Et0E1D04o7EfzRvLNZL4DEYD52tS0gnB5bDqpY2yLN+tg8pp9TlqdVtui6AmW7ghUBBKWAz7aU4+vzIcfs7NJHQhB/1QX81O7vcG5HBp3mBYGGjfZdPb65+H4zeSqyWbTy4vC95vbV+anKa9jfoHjah4kLZIj8Wibv4dHrIA+fWRwa7GJn54WYCA+hw0VlykM+/Q4yT2lwyVFXyhTyQQIgOHa5DJTVkzRE/4SuibHBTkaZ5cLu+12G+UJhRwWssUuA39JjJ02VulFQax/ghEvfUoqPkil4yYarySI2ESvVVB9HTz0x5KNpRZYUulBYA1ZRU3ijUNrC4RNgVYiYNICsGEZ8cy7wcDX8QaPeZANYx2I0wHPu0Y54AkmaoUhUXj18SP6bhgBfMTHYJAxwnx3nwX38BeA1IcBpOh/E1vyFoldLTLMmT7eOVZHDa976AOGJ9vmo7ZYNxka430tyjrQ8euQP8BD/P+88Q7+kYXQWgEa0fOPjeQ0CNpouMmWu2rHab7gNB8f/wVoalSr +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 objectrequired
    + +Owner of the Access Profile + +
    source objectrequired
    entitlements object[]nullable
    + +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. + +
  • Array [
  • ]
    • accessRequestConfig objectnullable
    + +Access request configuration for this object + +
    approvalSchemes object[]nullable
    + +List describing the steps in approving the request + +
  • Array [
  • ]
    • revocationRequestConfig objectnullable
    + +Revocation request configuration for this object. + +
    approvalSchemes object[]nullable
    + +List describing the steps in approving the revocation request + +
  • Array [
  • ]
    • provisioningCriteria objectnullable
    + +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[]nullable
    + +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. + +
  • Array [
    • children object[]nullable
    + +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. + +
  • Array [
  • ]
  • ]
+ +Access Profile created + +
Schema
    owner objectrequired
    + +Owner of the Access Profile + +
    source objectrequired
    entitlements object[]nullable
    + +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. + +
  • Array [
  • ]
    • accessRequestConfig objectnullable
    + +Access request configuration for this object + +
    approvalSchemes object[]nullable
    + +List describing the steps in approving the request + +
  • Array [
  • ]
    • revocationRequestConfig objectnullable
    + +Revocation request configuration for this object. + +
    approvalSchemes object[]nullable
    + +List describing the steps in approving the revocation request + +
  • Array [
  • ]
    • provisioningCriteria objectnullable
    + +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[]nullable
    + +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. + +
  • Array [
    • children object[]nullable
    + +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. + +
  • Array [
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/create-access-request.api.mdx b/docs/api/beta/create-access-request.api.mdx new file mode 100644 index 000000000..a1638ee47 --- /dev/null +++ b/docs/api/beta/create-access-request.api.mdx @@ -0,0 +1,131 @@ +--- +id: create-access-request +sidebar_label: Submit an Access Request +hide_title: true +hide_table_of_contents: true +api: eJztHGlTGzn2r6i8H2ZCYWObmw+75QBJMZsEFsymdoFK5G7Z1qRb8ra6IR6K/77vUJ82kGSyx6RcUzXB3dLTuy9Jfd+yM5XIVFtzErYOWkGiZKoGQaCcO1f/ypRLW+stp4Is0em8dXB137p0Kjm0JlWf00GWTuFZS4fmQNKcdsKTDhhQ6+bhZr2VyonDYQxWeLiuBa9C5YJEz3B9WH041U64bBTr1Il0qgQDFR6o0Ca14iRUJgVk3tm7dXE3VYkSOhV3OorE2EaRvRPSzKujhJzNEnsrIwH/IDzlOtfm2gxqwJ2QACkfEQrp5iaYJtbYzEVzMaqB7AgxAERzAG5mjVNinNgY0AYalAlnFrAVsZKGSfHLXJupdGKklPGEprAWUnX0DvAOBUyGcRk8HNskR0ebCaz4UgUyg2XqK8DfVVTXC2YYm8KiaZYYACxUktjk2uixmNvMLy3CbBbpAOTUYLQDTgMaOviUEwnyWReAUGUyAG2IBzH2j9KpZNQi0INwjvCAlgmwCjBkeaiQICbqVxUAE0AkJzRlhKBmiQxSHShkTTBVgAgBB8Gqz9qlwJAFlGnJRI1BIQxOBJ47GRek6VTFCBzgqJz1BEYYddcABswmVQwkqMmIQNgYWOWmIBfQhAwlQitcNVjgUplm7ubnaZrO3MHGRqhuVYQm1nFSRySxDsDaAIvZkDO9cbu5AWDTdt162gzmBfKHVpmBuBdpLhT7Gxb0ENsFiBeFSjkg/x8g5wAlHDl7bVjrAA+nZBJMxeDs5KtW5GkvSmEisKYgWUAkRVhYe2MTbC4NqV2bRe0D4Mq4DMahkqIxswXQ28o6TdWcJNKw/l2bIbkTnJveWZHOZ8oJO26sdIAjP3x4fT54N/wwODw8vrj48OHarIlDQGpUWLo34TiLUj2LVE6RVmRdUqAORcXoDgK4yGYzm4AuOxWNSymDW8j/trjCVMJbQMsCGxNQRpWAyM5R85EJJKjXKhV1dyvAZ4/1JGNn/1Xim6gFBQ0IWKkzRGqOZFBdSVjy7qhUSOIAPbQjS5YQPZAl6IDQB34Cn/iz+hyoWYoaxuoiwZPVHR48rYicpFeIlqiPgXu34OPFkcrtBtBAttQQAz9EvCM9L3jNgJAa4q4juZzbSKHf4pdgMGMND0gwJNNIxfAv+YuaAtDk91NdihmRqU5ZF7H8rOMsRnn2t+vgEH6vC1MDPdP8BLUTOQgMIyUqtUegTp4f//30r8cLSmkNRrCmZhYqWNgamp5IdawIce8D0IrQASy1uETdgtwKtmEArBovhBs2aH5fhD5vc+hLE+AthMl4BMye6hm6PHg60kk6TfRkiqHA3moMQBQFEbEjC8xHtBzbS81cOuIUqY2lkZOGcBfxZf+qExFq4HJazAO5gr+3c6VYAU7AB4iPiYohbB2Bun5EB+JmIJixxjiGilxNWCgAE8NxRsj6B3wIKdaCWJHJLBYyHJurU0PFOuK4phAgfsjEIMAhqpnx9Ht5VvF7Qm3Xn9dbb823NiBLYWDMuSLc4hDVRC7S4KA5oelV3wrwL03tKQgh8FceWe+0zjyyN0UkYm7PF+QwrvI9BM0wP6WFb5/KW4V6DqxSzP0ORHZVBxFngA1GeTHOUowfOG4d7QshXw4PSVq/WaM6NRdW6FjdIy2qGCtXRaUgeWR3d6fTqTg9f/1hcPT25B15RIuJdhF7n7W1OaKFAenPa2vvbKoO1tYERzGNNgJUhJqlmMcGn30lOYHVTPnyhPW0HAdZc5F9O+82CkRIOcRQfvJJKeXn4GQdOADv/e/QMtCLc8YEg8C1c/pd5QE8rFOP5g0yyRxr02IcQFlAaeKRe2lDqE7u6SdwG0qZNMnUeivAQsWk+AroiTwrNn51WG/ctxykI7HEvzDWQwViR5iNAlygHXQWo3UOlizjlU3wd71sGQhMqdCD57yEdJ6ZdTelkkDleq1dJTqgW9HpT6hKdesih4K2XvHdIOcq+A7g6HGWSSLn8JMSqAotLk2A6fBCfZagevioH+z39rp7Wzs73fHWdrjT7e3s9HZDKff7ve723lbr4aFg6ZCgLIFmshiruWr+A49roae1brIoWqjvBo34AZAxSo8l5EgUvaswIaWpgqTRJUdyy+YIVmFMrtZVkQnw0lHYqbGigT7iK0f4hhWHXFeB8nmFJSWHVHjSYPljonhErdJnWOzj+Nn56auTN8fI5FP65/jd8GT45vgt/LusiFbMK8uuEXEBBUL7K1WvxorGMkCgDpehVV8HWA0roNtuem2M4ZW49fTiXiU3t8O+2u7t7HV72+Fmf7y33w1kb3uvh+hAPhp7K34ap0MeyDlD6BMMv25CcSYf4Q0RfQX7qIrO4EtkHjLRGyYT2CGXU+J+vlBc+CBLtv+LnRrMVYiCCBO4tyqVEFyWOhwZhhqpkNHZEh1ZYswVrzSYzah743k53t3b78Nf425vd2+0uxfKLbnZ3Za91nptzjsoj2FWigk9eEcy/kfAN4euf8PiDwvuIBnpNJHJXHxS8zaEmkyJmdRYzYASz30bQ2GsGlVbMyDUZuByc0dqnqWV3At7H5x8SedsoKnOgEiDPSaoYiEZ3cDKPjNY3qT6loszzI42ltbjHbb9PHN4Xh3RFCnlI+WybBkNTeEwHVmDmQTgqSeGQx41MPIUs0ipIXfAtOCTsXdIlq+kZ9qHW0pxqJQs0iVCwDtFTnBoAOLmUzBx8WaQ58IiVNWEG9Hrb4mpzXwpRH0RAumTxtiGjCHW35oqUvUZYm6ItIYK+4C+exAWFeG4WvN7ojmJzLFYRnieCQZTCcxaRnm1CmVYc0Qcq4MyDUsU1djrpCzzssZhwVKvrAHVUgctzynz7hUhTzF8SacSKx1OYcC1lP2ueU6CNIGKhObiPm+oUScK4zymRDZLGyT6fIFg58g04FMdgotQeCxzxgqGVH3gsETl6v3YeuQvi3JDp6yrRdnl64RqEcAOEp7GErx1C7nXxuS57vG7/W67u9vu9Yb93kF/86C33el2u/8skg9O4LCtnCc5N48EZIy/aJSxNj4U9+CH/Ox/9Ld/ANf7XcD/IVxvZ0EDann3Qt71mFYAGAbEfXmSJSjdksQ9wGYTYNaGOO9R9gVlYRrS5T3wMaSIczIjmkPFDvkqYgBmNd9YbTC6W93uIoaHpLziGLv3T2A5sthjxwIMRKnD34FLM0UNwW50dGjDLwh3r7RR7UkiNWJIGw5QDIbKZ2MYTWJs4zLIPD2lcfWUEDjR6YmXMqz2LokYYBNobfAJYJ18QYp6aTTMF/kUiCVFgFmyrNpVcrTT3e9vjXe2pOzvbfV2t0f7Y7m52d3f3t8nRwN6ADX/spy/vvRrZVSiAwjsULrq3xS2cCXwnl0mLv7lZQLB+MJ0g8cWZHp8Be7WYcPz5eGZ2NoVEUTQjJ7LSYMJpn25WA8B5Qz4NNETbZ6qWY6OXw0u3wypIvzb5fHF8LFa0OS9Cey1jiHFuCOMPQFkdyrirSGx5qGuVTbU/EDtKkYIukXFJMzwqy+ZUQWd79mVphTw1qb4WXdUZ513oyCagdMaSZe38pRYY9/RfuM5uSamEJBV8gIStCKcCHKsDuZTCQ9xhvu2ZSpWhF6IqzpQdVmUrHysOn1TFQoaB2D+vJ4MgjQD5IjMqhUW2uJR9PIBnJlzdeyGTS85Nylt2kl0k4FNKNvCsIC7ud4dUd8UHI/JxxUeC11gTha5u7eMzFFq6R3tfT5vd2cRuJ82kVa8uFXe+KjH4GtDUUb93CN5f06TiwrS8yI3fG4lrGx3Zbsr2/1C222+PPd5mX9LqU9vMfW5NL4h/NuyBK1ocOeDuF5jQdLBAp8i/fJ+6BvN2DzG4kZ9z/yIQ/mSlnAuD34+yg8M5KG/lAUiSHxkCsbgiVR4QHiXGBOjmFWbi6tBdjzSoKBmSYpIW5z5jniSGarqJZS/+V4Jd1IrG6jcZG9zl32VSa4yyVU0WkWjHyYarTLJle2ubPePabtPZpIFVmQtPk9yWRzLZM6a5t/T/oOAAeXJ3cLkSFTNbAWBiSLHatUzh9ao3xv1xruB2grlVrizuT/uBzt9ub3b2+2Ntvq7rWqsvyrtuDCyuk1V5M1yJBZDEoe92MyAcrnU2rDe/svo5Cu6NXQ9Rd4MPAeW3hS5Y39/MXccWive4nG8/Fh2LYc0JY/Qp8HYGMdWzwlLMQG/aPCIjwa8UJXwcFNbJLh34k8E8bEbgJvM24NxCqSwoZS79X4VbYIoAwzJE+CuGK57J3WaHwIFCJTBTsA7f8fs1Ivod2Xy4hwpfoMUi+PPgVJo6EXmvr2sv3sCyCfoIy5YwI80ernakQYUAAoC9llF3rnKz1f5+SrGr2L8jxHjV/n5ynZXtvvHtN2vyM99NvR4fg4Dvjg/h7GdrihyqVeoXP/1NJ1MxWNA6i1sQAeswjIHp7wCVAkRmlm6WzmTeIey1Thx5lp46xJTQsYmSyIYlN/ZuQchgXAeOnKmO/kBKWPv6OLOCDizxOlolxshDqAD17xAh9iaaNRcdnMEnJlMhKCO5neDnoRs8L6dpSuG4NgIzDoeo/RaRI/xJh2UED85Gt0hrVmgD+i6TKKH308LA3qElmXse3I1GC8A0waJSMJNeUn2AvNtXn3hqmwZQ7BG6y8sdorD+uKlkgndK6ArUb+8H74QE8wyycr58qE/aifFGagIebFB3sLHSRRYEptNpnz6vLZJglYjxhFeY702F0qJq+p5nnPwx8TSQXk/66tujMnavBd8Cw7LAW34ZBifLWuLIzqQh5fDaIwnkS9lXs1yumSFrm9F4k85tPweG0FzLxpYMGuv+MSYCMB0EYSMHHHrmxdneO0KvDZdgGoj1CYOyAmPR31rK8il9s141OC1EV4dj2vzfqrxdFZtmmCPJRxEwCgUJyKYWuvUX4RA1UEzuJpkYEXfjNYdLtomi2j3uxWU2rxkW7chIST83oBhGFYmOcKATPmIhVTNhGySH0myYPMf6aTjxxrN9PgK4iaODG3wFfdmGzjjgm1csM0+wHn8OSyhYuE5SLwnhEbPCnBYyp88gUe04vcY1lKvTuA3aA6GhgBQJShudsA/DkoH5/8S9AJHF2PADWM+XWz24a0aDwtjU41ZeSegycFFfCMLIbHBN8a36ERhmPx/oxcpHpQNE7w2+L299COe5P/H7/6PPN7K0/yInsZnuNh4PC+v5R0vOdZM1+iunr+OdtO4jda8tdW8iHVVmO7C1SldOUb9+GWjyl2jL73ds+yE+X/g6kz13skTR+hvnkPne51WR6dCyuULvqore+mz8sU2LV8Fgf/TWfDUcskEBSlfA22eLZ9FMkXfRb47mGpFDZ6ZArpGeO8MVNXG5G+LT7swoAl9fiYBxZRQkuuILpAMy5UluUUuH+jeNX9eAqtM/koFXjHpiPdQc5sAjA/rbTxEA+9+tb7wvgD7O6NPEhzlJk3XyzKDNxEB7SzGG/XP2X2oXZBxeILy26icF/x1h2JW7qvRoSAJdAFUJbE7HePegQ5UxbyfWQus2/mNA2A9StGwhEtCzlVE/gfH1Yuz52CDT2lPVUSXDiC2QpqtKiu8PRkuQARgxgFdgerYZLLhJ7kNHAtAsAhm9dns9DrdNhWF8BwL6FiaCvCL4ss09W9fNPXwvtwzWX1zaPXNodU3h1bfHFp9c2j1zaHVN4dW3xxafXNo9c2h1TeHVt8ceuqbQ77FgNs6GzM8hYDVSMbbTLydd9VqbudBXT7FDT94dX+Pe9S4v/WAj2EAboBe3ZRbV/gLQPJeNXU1PincI/WHo9rUDCk2QxdPfeGOGs/g/e8nx95U9iTPTvEkQGvkv6YU8/ZqIu+wIQD/P2hdw3/wwwdYai7g8/tWflgBxjDcvKG8rJ/q/0AyHx7+DXVxjTI= +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-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. +* You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. +* Does not support self request. Only manager can request to revoke access for their directly managed employees. +* If a `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] You can specify a `removeDate` if the access doesn't already have a sunset date. The `removeDate` must be a future date, in the UTC timezone. +* 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
    + +**Possible values:** `>= 1`, `<= 25` + +
  • Array [
    • 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. + +
  • ]
    • 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. + +
+ +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/create-account.api.mdx b/docs/api/beta/create-account.api.mdx new file mode 100644 index 000000000..c4fdaa5bb --- /dev/null +++ b/docs/api/beta/create-account.api.mdx @@ -0,0 +1,90 @@ +--- +id: create-account +sidebar_label: Create Account +hide_title: true +hide_table_of_contents: true +api: eJztW1tTGzsS/iuq2YeTUHiMjQOBh911gJwilQSWS+UBqEWekW0lM5JX0kB8KP77drc0N5tAkpPazUm5qKI8GqnV9/5alu8iPROGO6nVYRrtRokR3IlhkuhCuWg9cnxio92LKIzY6Go9SoVNjJzhGlhxNpWWDY8PmS1GuXSWccW4n82IGkxjjttP8CJlRrjCKMvcVPjBw/2YsUt1Bs/XVhcmEYfpNbudCgMTkHRJ61ZmGRsJT1OkLC+sw2epkqxIYUAqonrNnTNyVDhhr5kefRSJiy/V39fW3msndlnFrlbZHHiezbRxdpnjsTZsLDPBRtwCcc+ajdfWLtWQOf1JKODITdnRye//Hu6/O3zPeOGm2kg3Z7CDEf8ppIGFTrOEA+cu7BuDUq1ICpwIir2Lzq0we1o58dkNgQIqW6ZqNzBkd3Ou+EREV/egeaQqrHulU1h7F5WbRLvOFGI9SpAMmA1e8dkskwmJ0v1o0VB3kU2mIuf4yc1nAkzntROtNwhdRLX60NYzg/7hJDwh1fodPC36gWB+B1ZNYzc8A4ZJmWgbXvvVIxyUbrC8f/WmlsHCVmoSLXklNxPhgtnICOQ2DeeEJeIzz2cZUtkcjMbJSPR6W8nOYGN7sDXg481tnoz4eJsP0iS6v1+PeJpKJM+z4xZXbU7uG3SbHD+9BxiQnCIagmtLhTJJO8v4/D3PcYM3eqrYvhbwogCnCaMfUxqxw3chRstxPzPnMsMnWBvDzH9aeJ5pqVyc6BzEAnaddKSEsH5YGXmPdIaT7tFCdqaV9SL3N/rLHjC0c5X4qE6Fg31s9A0+uUAruD/jRLTcnCE5LhUoutwDAplZxw3mBD8ZfAZC1S54lSR/WvS7tn/JdJkTmTI9rvJV7bqV49Ve1E92ei83Xg7Ati83U7610cNPWzubSR8+77yIHtC2Ja2dCFtkLmh6sLGxzMZeJkGN7MAYiKUOO6E8ilnP8xYyAxtBasD8IxWEnkzjb7HA47rx6t7TqXg6+l5LJToTA4YCDgWxnMBCtMyNTNF4uYb87kmW6qV5cUuhoIm4x17xFOT18u0FYVCRhiefgNbXpINzJWE9K5cwMGqZkx7YVmwLPtra2OkPxhCkvP9y0Nt+MdoZ883NjZ0XOzu4ew4eBnm5mQC4MXy+tPXvQgkjE5ZpqAPyD4E1kNtQYWhzWCKdyO3TNiAaX6F/zMV+biVm4JdhnVlnnL3aO2aDbZZxNSlonE8WlKA656cwooos4yMcwiIDknvCR0ZOpHqIFaGKHANu/+D18PztGYycHPzr/OAUPiGtJQAxVOCtKbolsAq+MNW3xHEQ4JZbZkUG6hBpzNYC1TUQiAccESZK/2TnFpQJvjXmEFKwIuz+wIomaTY2Om+FUuKLMnsmYxGvA9SAsZy7ZBoggfZ4Yw0CWcxc523Q5BqbCp4K8zxmw6pglIUw53PELFBJasAyLiCUBaEJXTimtJOJaNuiVmXbGnU2eds0CgYHcP60nwwTVwBzJGYzCitvCSwG+wDPXnNt7s4aSiOVziFHJyAF4J45qNEY0DCDisIQHoZ0hOaykHhUOa/KWM0kSenunWdm32l6l/DCfkXcHWeQfjokWvXiRoTgswgJfDYia5RmChkJXlLCx8VhVmWuMvABHYosXcXuKnZXsfuVsbv48iSguvCWoE9vGfqcq9BaYfFcgj6GvEfpsv/6w/dv3pDrDBQSINKbD2ehcYP54vMMgeEPxEe+lC8D2coefnyE8KMyVssWyCDpMXSgkIlEukt81xyToryqNpd3e63NSIKDqgcgIvYMbK4LxkFlplAEorldZ9AWWPWbY1N+Qy0a8OszIO6q0o5vF1ZIcoUkV9VoVY1+mWq0QpKr2F3F7l8zdh9FkhVXFC0BJ9kiz7mZe08L71FazmBCfb5YhRyZahGtIDFWYayojRyiUb836o23EzFI+SDd2twZ95OtPn+x3dvujQb97ahZ6y/qOK6CrB1TDXt7O/ojdmFuAMcVCpzLOq3T9vEfqNeIMaY1TD0Vbgadg0qvKuzY33ngAF9r9o6reYmQbAtDqlpHmNNgbo5zTTkXJnA2gbyoGKQqqf2pqcwFUDF48p7JXFLwohRA18w7w7EDUXyglE5W7RK+17GUCTKNqFmDY0n80meMmA8oEIKdQHb+geg0mOhPIXl2ghK/RYnZwedECAz0Crm/eOh89xCYN5gjTr2Bv3DQ67sdrsABoCHwOavCnSt8vsLnqxq/qvG/Ro1f4fNV7K5i968Zu9+AzwMa+jI+hwlfjc9hbrzBKiz1Gp3rfw7TKVQCB+TeTCdJYei4ucTghCvAlZChmbaURDje/om65c0fuiiEWNCzURi8xzF1bmZ3u907sA5Y5T7mMxlD0gIDubnSt3irozsClTyQbfBagI8snODvbNEGMenTSHRZn9+IuNcuSYDOWV4ceZSy4jmZba4LyGhEZp2Bewf3oWFgcQa9w2+WZsfkLkvygVznJrv/87J4Ql+Q5SH1PbobzGfA6YKIKMJVfa/rFIG2333pdlddPLA56y9tdoTT+uyV4Aa6AP99xbM3H86eswnCSwrvwiKyFRL7AQiQY3ARSl/D8uweF1FFMbqYTInxYevbEQwXNs5AYHapToVgF4dBCe8hr59AIiaV4iJBsY+rrp6V1knFjciw5MWt60RdmaouaKjLW+ueU3mjPkAq+JjTaHypOmxfYtaRWKZxThCR2jp2MSvl4g25vpeJv5XUOp5ah6jZ5wtceNVeJP62TQIxiyR4Zklb3725p9dp0MOmCUaQ6iIPqInAR/s7raS02nfz0aLXQXptPi7Vh6mE2tlexnyqYhZKX5ayQ5ZMtbbiH4yh62AYXEwKiKLvZusWN+1QRHT6Gw2WOn7LjuwAEiT+3kJgKO9MfISVmICIBoymUh+S12RZiPlrunF63ZKZhi+gYOLMVCf2u3nGDTu4YcfnABv4D9fSgFmIbZSB8oB3gL3a/pQJAqONvOdpPZjViXyX1mBpSIBVfylytusfdusEFz4xeoGzqzmQhhFIV9/y4d3UQIvuODaVVR4BLGpwmd9MQy1c0JvntzqCwvr4s8mLEg/rk5Ijlc1/dJb+Qib5efLu/ynjrTLNr5hpArTFE8eT+q76QX0fun2D/Ke/HQ09P0QOaTC0M814fRWg5/IhJJ6STwX8h7eUdqghgHbL/2gAAVmTEIjhMEApQSVTKej4Yia4Qxi7jkGic0oq4W4zNKlEaEI3tA1on0PDKTOgRwfs5c6cYt9jZHRRfLYF9VB0KX4K7bCI2QfoKBWox2A3iVdE4N1HHdrKU9DJMeqE7Zd+C/gxzwuFv3UAtouccYiOJ5wbrJUUPgdDc6lEqQtNKLZaVSYkjBoUIaa+yuT2aIwn49B0N3z4ib3Ahcsr6KB6tKLy1q8FOREZBRnOa3cgT9GGwOlMRTbDfhYKCGBJ0djh3eHZEkUgprzHx9pMumGR7eJcIIKdnnefzbgXb3So84FxbA+hA28Q9/fyWf0rnZb33dXfA6x+nPPtP84JhR87tu4MTxbRBoXvIH2LfhHxxq+hpti9w9jdHTKDPes9DkPyw9OMi6u6HcUnoOUPnqin/yQwoYVvOjpnc8Iu4WRj+Ssc7JL9Cn+Y9ejcq8YBw/ERHutFo/CzodyflRh+C4P4fze6hD940DMfC/jbIhy/i8qTR0ySRLcEiQ9hpPABxby//y+H+gi7 +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. +>**Note: This API only supports account creation for file based sources.** +A token with ORG_ADMIN authority is required to call this API. + +## Request + +

Body

required
    attributes objectrequired
    + +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/create-campaign-template.api.mdx b/docs/api/beta/create-campaign-template.api.mdx new file mode 100644 index 000000000..f6f1295f0 --- /dev/null +++ b/docs/api/beta/create-campaign-template.api.mdx @@ -0,0 +1,183 @@ +--- +id: create-campaign-template +sidebar_label: Create a Campaign Template +hide_title: true +hide_table_of_contents: true +api: eJztXetz2ziS/1dQug9JpiyZekveD7eKrcxqz7Gyfkxq13ElEAnZnEiklo9kfCn/79fdAEjwoZft3GRmWTs7Y5F4NIDuXzcajea3mr8SAY9c35s4taOaHQgeiWO+XHH31rsUy9UCftcOahG/DWtH17VjEUTu3LWpCtMFw9rNQc0RoR24K3wBLR1TS4wzW5VhujU246FwGFTXrxrQQSjsOHCje+jkW+0qFMGx70Xit2gUR3fYset4R7p8PVJNHUl6azcP1P8qEECYgIFEQSwOaoH4dyzC6LXvQLPf6KcbpK9t7MGL8BVfrRZqUIe/hjiAb7XQvhNLjn9F9ysBQ/Jnvwo7qhVGmh8glFgFOK+RK0Ks7zpGK2EUuN5toZUJzMicRXcinbAobU/8Bg8XWL1lD63+cNbqW7zV6/Ge1cS/+v3ZbNizLGtQezioeXwptvd4eeeGSR8vQoa1GuxvHP7y2UxwrISrdCs8ZBFYMk1Z+IIKh40MZW+5x29FwIrz8ZDrel/KjLc7E2jUydGZ8OHcD2jCuefFfMGWiv6UK4FuyWA7rB/xO8qEg03DUpaxBZRxpt7iXnMgULDkwIA1rFSP3GVura2WVbfadat72WoddTpHltVo9zr/QsKWvgNyuAtlb6mk/Z2p67aOrGFj2BsSdSg7TrzIkDfz/YXgXklHOUnwHKRWhMxFgQBWKEgEuwMmmAnhsaSjzBrP+SKkduc8XkTqN5DlfwVOORfz7UJ9CXxBpaVUGvx4APziEN8k7xO2M1hxHvjLbEX2xeWAh5riBiM2hzVcOAz+4HHkw3TD0BeLe7byV/GCGuIRszVv4Rqwr250J4EiDgLALxYDWjaeCDo0ljzQNAfWoNfr95y2sABoev1+r9l0Zo5otaw5LrNsvdiL8OIlgvbkZHx2Obn8Z1E9XEKN9X0n9XYGszMotb69t24YwVIphMJWAdndxfZmx1hsfbvLoKFQ46/qYcP2l7WHB0I87ixcT5zEUr/uAntCrjCsous7zIkJ4b7eufZdVjOEd34MXDODRz72CnxywKS4EssAN3lscjGtD2DZmKagwd7fgchkmVJzbGio6oNMbwTAcizAe4sFdmuyH0HKahGHsmUn6e0N4KualgOUZdUVMrJvU22yAiSONOEfJVmJVHyFgXyovWu9/1BjL6OvPvsqxOfwlSQvECHINk5QKaF6gnTrzS40UUp1swM/7sNXWS0BvRL+q7Z3QQygm+bnzl+kqgjolHLsenKBcPgL97MgFXpg6ikmIhuJiNyISNAYDY8AE6ZzMo3yROjCFwt3yYwaqbFzLUUoS6+S3ZvdUGMLYBdMl50sluHcnoHF0jeFvCgQyTxK82Si0FiOH3FzxYMI++cGQocrYbug0pVIIJOQhSfCv7BQSPb9dFgwJ8PDb67zcKhF4hMTnrPyXeQW346XwDZy+dBwcEQE0ECmRQH91ppEj7CEjBnImEE/4kSkAx9/EcG9D3LoCeEAMKC9BpLwxRVfQRRm99ixG2iTq2bAZdmclBoi6ycKcEDBIlk8quEGkwqXBH8ZhxGS5Ho0BfM4igP65QcOrBfQy+3I/YJFTb6GNmDe7/2YRcF9ppSxzyH9zFMoQtnwAWGgbd3fiofRAbVDgAHbFuF+wUY6lsVEEEBJgLcVmK6iUWpzNbuXTQvMwSOr2eh0e//apIxLlIxSvumwjjVcwo4L1prgypiZhqHT347ORj+Pz+HJxfTq/Hj8cfr+TP4cj86P/wZ/nE9Pxx+Pp2/fTS8ml5PpGaKMIROqvlbCZ366oRx7fLbOaMwpZioZMmoC9gPGplSa9YbZWMtbgnlLEUhB6+tcfPE/i9Fi4X/diQYqKQ035G2o+7i+Yfn9JQiVQ/SH+0/CZDQp9txgI9sWqwikDzCbiS+g+l0J01geYN+JATjmYFoS7wOUzOeEK/gaTYQ48FBDz6mSt6uVSxztKhue0RjR1EXxByD6whexKkONEiyontykayAWTAc5D8k2zQ9ui1y5dnJx0LgRAaSKw/2AFvFDWQmyeqNEBWpxeDc+O5mc/Yz8fwl8fQJ/HI/Ojsen8uHo+HLyy+jS+DHGEiAcp2P1VP2gquPz8ynKEkoSFD3Jio6qj2aJHyi74mKfAeZq5dV2g+EImSnXxqrbnJbrykubAR7zMg+YnfEPJZjoY7uuZy9ioCpbw3Vgol20P9hLaE39vEc2iDPl5syNaOPnIe7afuwBb0MnQBaI4J0fuKiVAEZDPw5s8coErePp+fn4dCQn+erM+JmZYOP55r3/TlvlMoeYIy38jfaS3le3cV/d7B412w3Yd0mM9yO+yPjgzKUHBS1uaYuS0AOP2q1yJYBNMZifmdrEZlqVkmbCSZkMaJqblkVMqfYiz0OgQZpu+IlEIs4voAWTJB4E/L4I7WCih2RNkTYOaWfylQceLD/uczhyImps2Mcs5Ua9rG8XUDEs2zpkje4F4F3pZlSzr4aF96PzM/jP5OzNtLilPhGgBkVIjEUtai5bijAEMytroFGLMCEL3+YL938LS6XnZdchYDM7mh+ybILrijyG3t4DsIFeH79jnT5bcO82puf8NmsECa9+dQFPvHixQBWRgL1seBq4t26pba2n82T8ZnR1eommyvgfV+ML+AvbKswowpFUZD7x4Z3/Vc6uHABuT0OxgOlAJPxJtfoTDIh7oVnQlb/C+xAmkymVBTVU7yU1zKa1kkVNSf5sZkvXOHvpNkTjAEAZnoE02Xepax2L/yQNgPqpmsmf2B3wpwheAWw7jouD1Bo5hPr3iO7cKRh/ZND6cURWlp0zSNOpzK5GujE9NRcFIQwo384nIztCnywNU7GxtIs1tygStaHhqJnLuXqNSaMpvYedi619bKRcwASawdjcKGTqPACXKwS70tPlXA/myAUBR7eOHtYYqXkriTmJfOnzye/cR4g2+OrhYJsAbfLnPkLbvFXN7atuWtZRs9Xo9aWTuczMqMyKJ5oVc3cRgQ7c6lA6AY0XLGEHGSoXIEFx4oJTw3aKSpCsbYUy6VzJbmn8oRx3lPE/L8QcRAFQ9/PjfMnY6eQE1/4rqEey4PU+M+16JtAFgQRkBdWaz8Sg17Yt+H/HHgx4uzt3+vNmX8Cfzry7x/7WcCyrmTbWa/T23Wjy89nHN5PTS9q0nl+djnOLlSvzKBd02rNx7AQg9EY+J7AIY9jeR8e09YvC88Rft3XbZzCGS8YRNYA8K5uULg77DmAf3bqBxEBsPLNjyplHesNEXD5FV7dGsYk397ez61vlUkECpFzmjzNxZYAHTBwosprsf+Jst9HIlFBWmqylHU1Z0RAZ8zBvz6jFfDBm4no7O97IFRQ8sO++1zSRO6U4Qfu7eSSZpkd6FYgQeEZJYf6wBjeqx+OLi/zmk57t68E8oV8zoU4HcrQ02MRTDic0B0MwtBAgcEJAawf3BBXyxG3lh6E7W5Dr0NgbGDivDaZD/oW7ZItkQeZC9p0cfZqEkhuG3JM7IPNkLh2rqGAP5LgS/QKjuPUB/Dzu2YLdBn68ypya6F5ovGBebN3SEJpz6ZRiJ5dTWlYp1nrFaH5+nv4yPj9D18PHn8+nV++ewjmayBdh0qPJKfmucEtinPSVn+PtqkOMvicnOe+nPJLs9gZ2tzW08UhyYNu8Nx9adrPdbO8T+5DpiM4WMl29hyVz+ZLBfzEchMSdOHK3tkMbJj7Z4WTX0nAU4/Ijs5hcnLjDpJdcyQGusFEoswMFI1TZBqV10fwiHPhEPz8hi37S/ApA+ynxhgMmbZYYSUtOboymdthXOy7Z3Bq4zTH5GrhLhEAPIUM3DkSNKTeE9Si/5L9N5MumZVn7ov5BTc73MYhqFHDX28GX8CYOYC3Qo+/EttqfS/7IB/zAqonfcAYQA00DlnaA65bvleQGx8cNmmQKmjxJadlsrNmCbDvNJ1k+Hb+F/yY64uO78ykYSmPl9l9/0D8iarI+CKM94qOS/UWZupQha34gteTp+BgMa+Mcbp3nolTT4+Ekd1q8b3Fb9J0uHU7a81bL5kPLalq05rrDTZMzOj2lMxBJTnEertDoBhZ3tPEGZrIgvljPD+kxv+QdpSS1XwAmjEklkpNaTcTDQ/YcmGg3hnOT7lhHObYuikppYzg7AVipYMWCfiaXwn7m0HSl3BCw+Z67t7GOD5CBWzRebJ9cgKqDdO9YVHGVDq90+EYdjsy0i6JK+FIrKqy4VUcBPvlKUamOPtG6JlpKOtkAzP6CQOYJlxAA+QCeHRAvyY54kG5jdt627ARmgVgKx0X53zEQDs/MTVcEHnbKJigkjYefU6cEBxv91iOka7DzQjEclTpVIdkRHKwLdXTqgDCGJPuesmbyuzeSIlICC3HLFywdSbJpeqG59UUapmff+aEwPEDaVODsHJFl5Czp3J9Ng1v5Y3ep2x7ndkqUnqeUXkoMfpp8ST+LhCLdckHMNrPCXmLmGa6NbI9rT1tq6eSu00Mw2pvdzepEItUWUtqiIJBSd+YCRX2MtBSp5H5f6SxYzP+gMT1xr7xW8T191yyHsW3DTEtoqHZ2Ylr+uUXN4spN4koK38M0ToPVHffGHpkb5K7a4whOO3dyeCDNXnTag8HCPnz4UPOpFyaMbvAxe2k+SY4zuHRcY5gNGdwyWMthowhWZxZH4hX5ocVyBaBBtLhJZHKGDuU8Lum9wc5iIxqC6gHrKEaLvc+e/9Urq1gY68vMLzzL0Dg6E8ADiv91MAe+d3ERl+TlefWEs8n9wojlUu2NRNvwVboMyzcXWfGTBR/lsy2h/YIeyYiuklWSJztgJ2Pojh/cK1+ucuUu1d2SbTJvqFa5IUg8uqbrVsXaSR0Z6tjg7LmItIaA6/7px3SuoiqnLWqDNWnoQKnfOulV4zEU9Pz0QYO9vtdnCgdZCnHXWU6laW/C/ujjyfh4cjGZnl3Qyesv0/8Zf5yenf4z8/xsavzMGKKZNzDxN3kEKg1z1UEcxo0JI6r3pnhmZ95aUZ2TIOjg8ZIjMFdLY2gEXyp4kqdbsdr96cipwmWTMOsb0pHE5OGBxRbSp09N4mmyjoVmfB7JLaQbpNcEnOSagrbLcGoc9qH2zQx/ftAB8WCfIOMQUjZuG1AuiTPsFcoQmNChMU6FFLNatlAJlkvWpIAKFRr6QnsoCuGg8pQiHz1PEdnZgOzdOpePi/0aLoM0prFwOFc8MkJErAnANM5FbzjotsRgLgYz9BF1BqILINft25vDGyUCl8Qcqii2dRGB6vVGwCnIyYEySp6Jc5X5pdZuM/9K5yaC6wcY08oPYG6BywyfpUQkOwAzhYAp9XqVsdk5tYHAJ/0Vj+M3GI00ZHVjMjBjX7ZTpt6eXLepd8VySSDtczLjxrMqdbaT2OK1v0piX+JQj9hLc/VevSrR/4mrklRlOjY+cxf04seSB6nW6ZDzuaRCNimvhD0O1HFvsgRr9m4nUNcM7um+y+RldMLUWHcQFCjIoELaWpkwNN+uEYaN3ewAwblg8mdl/fVH2sZp87V2TXX6Vt8RM06W6tDpQEsd0e32hrSp+W5MXIy1yYaX7Mvk51m37DPx+QZn7O9hwBR2qJssmbWFS02aNaW36xqaoxTvaZ91oE/kEp9z4rrcV+3sSpeSOVSqKNnSC5LKW+GSxlZH/jrHoRE3QCKpxKjf47OWbXXbVhP+6s17XWfudDnn5Dn4QXSB3MDpuzZk57csqygrOng7jGlR57Crv8fJrFIIVCkEqhQCVQqBKoVAlUKgSiFQpRDILG2VQqBKIVClEKhSCFQpBKoUAlUKgSqFQJVC4D/url+VQqBKIVClEKhSCFQpBKoUAlUKgSqFQJVCoEohsKMLukohUKUQqFIIVCkEquuHf6Lrh1UKgSqFQJVCoEohUDo5VQqBKoVApcN/eB1epRCoUghUKQSqFAJVCoEqhUCVQqBKIVClEKhSCOydQiC5bSZvMfadmbCHQ6czbHeG9mDYbc6cQWfeHXCr22xZtYO1d92TCBM8hWvVrUHdal02h0fN3lGn1ei1W/8y6T7CI9bvczu/2cETLPN6hAqQr4XxCu8D/xXQK8JHDW1Hhb7vUbR7svHO3yXrC7vVbXF75nRanW63M5jBbwckv90Z2LN+N52YC2j4HcWXXsjucndI9C1LIxg7mTo5KflJerYrqAmNdH6jV1Cf46w/xZEgu/Y0RVJZdoAg32zcVMsiOpRF/iqNDJKv1sblKCI2q2lZyE1m9ul5G9JQX0V6Po+DDtqTr/8wl3bTTA1ZgJj1Ra/THQrhdFudPrcHs+GAd+fCGTTnotWfpzy2PkVCHin69daAkGJ41LEaVrv7VKTYM69CBRi7AYbaD3xHvCjmgdg/v0N6+DVJJiR1pcnfu2aXyBwHKKQq+syvt3oOfwSQy59/PGO6kDUgmATR/1ExMJedI4eEw3mnObN7Q9HnndawORs6wuq1rfaw51hty0mFpyT5Rbmx1Ab8O2r3GoNufz8I3D1jRoVyW1HOWPWnY91jMnv8gS2prXleHmFL5a7m/EHBpCQLymPxJIFwXBzl88XmnwdXNrReRBXZwJ8QVJQQ/A4bot3zmzxxnrabSckB03Vt1uw6PWs4t7v2oNPuzAY9MPq73Va72Z07fDBH74OyqkqYCh89/N7YtJGx95SAHESV5LDZFaYUi/4gOCWdgJ3SzDMLFwPKKVac1QHf05tuZjz/zHcoMDkJNH9Cbpqs91Zezj32nR18oW9gjeq3aKADhTLY3oaKeFPwi0se8iU6mmWTmaD87KkBzESjyV5zh52r8R2rwaCnN+D2Z2hrsoNb+cpzoT7TVZib3gUs6Vb0BZ+BuLU6816H89ag0+x3QUHwdtsadodDimiQ8frbDx9+xhuOrs3U7RjK+MRDdbmUOt89rKa6GlNdjfkPvxqD5kQc7iB37xYAP3UaWvLii1DCR/tpiUa0GnqZFCKpzTZVVqWS5dKCL687VLJbyW4lu/tfa6OX5yoxhXpLpk+zaPpceer2FCrPgukjEw7gjStVSB5gyoWkw0dlIv39/SUI9meM3wmZ+G2lb7E8k30kVXmB+FGyHvL5TIdXaNWfrgUSSPOokk8AEgnniOhOKa6lVmK72NsbP5i5wKBeiYmIub0oUQidBceeR47b8IA5vgi9F9kgcEJA7NVz6pSupbIkK0uy0kaVNvrzaKPKkqxkt5LdP6bsbrQks8FWyk4K4+WS06kzBmLK9zLFHRRIUqSxROSS0wHTWsHGWGJj1bKWQ23Was6a874tOg7vOL32cN6yey3e7Tf7zVmn1a+Zuv46leNEyLIyZay3XEd5HVAEeMsv9oC5wsj3naz7L8YAujnCGgUua7sZ5hym9CaxHVvDkvwLvo9BSffaQgozNqSXzhFiGpRdYtlAl4UCnN26mBpM5RxFVsKMEXVGGeMX7tIl4cVRQLvBfX1EOd+loGgmS3pJcjEgEix8tJp9YCw3SsJUg3uyYG+5jLN/JutUp7h5iiXPznHEpzhiNv7NFgIFPbHcu2X+XQzDDhAjLuQCr3H0yt0O94ABYEMgMSuxOyv7vLLPKx1f6fg/h46v7PNKdivZ/WPK7h72ubKG1tvnUGBn+xzKNiyW2FJvKD3R/7eZTqKiKJCZs3SO+tQGJ7sCWAkJWvkhgQiP7uBXSQptjGcgq1ASFAcY4XMXRavw6PDwG6wTrM9Dg6/cJMrH879ikM/hDCanBHcwQEDKGBZgo3cTta+QH0AKXEoGTJxJjct5VsmeaiHMN/mEN7asL3reY3SkbOYAL9cqRqLHGGgCu4jkyrXMbpcbH4zrKlg8PH0ssqE1Yymbvo29QXkGlOaGSLeJcLlgwaGhCzS5Ze9XQNWxBKtRHN2ZagS3acXEpVMs1mKvBQ8ojzieXLz8+/vLV0bS5DhEG1ffLmXvgEUIyEbai4+VSLcEfnwrP/0wypyToOCw+QIGzD54F0KwaxXlfX8GCH8OkExTipUEoQDWunmpV8fB7KCo/BrpTCLjuY53CDN0yDP1XpGiox2B8Q2Dxgevzk4omYurMzXoDzzgBo9dr/S4uDGuxxLxX7q1umytTq2Fr3JUyKm9tmXcjQ3Si03wRUiz9ejOZXt1oz3cPsETbDVPA86EoiN7umXrVXs0HZn26thelo4P3nvKFJitxiRo6XQiE7wR74fivxlD1kExuL6NQYoeTRalJ6yTRNRblkFSXXZZd+tgExJ9pyAYnmQmPkOdTCaJD9aa50iR/EQrCzKvLmdnxkyPr/G+PpR0fDt8NM3YYR07rEsMCBX96nMGQCzINo6BcEAywHG6/oQEilAD92RbpahOzR9SHVQNeGldJrxbHckfRynA6eSN9AJLJ2UAhtGkTs778DKnagvVU2aytDMgP4NFehc+aMXcvEl6E2cUasofbbw44lHqM8Hbzc+N0muQ5MfB3d8J8Sqk+TMijTJy0feoPHqvfed+rLcj35JvRG7+BGHhkmjZ1+ZyRtrOH+XLhs6bH61c/6mysrB5TWL202DJl8HWftur/KLQts+bG19myn3DY78v5Zjh1Ou/BlNyp/Y7RFPLbfK2YOr0yhGt1dYkewntxatJ5pWj575ltFPyv8fcv9yUdbQ06eiaT7Kuz5iVTEw+4VV6aXN7Isfcxc1dJqT8Ymcyjmy6QDe5zLUlRZWZbs9IZbdDprnvPJfGzY5dRrHHF3e35kfJLaPMLlS4JrYxW8+etxqAOM3dyiVkWjqv1aa9eJATUoY8+De8VenSQEy5HaWfrTQbQsxH00Z+S+vOFeQCXgkeIcYc6I9iAhKuAh95Td9ivqUrSQHoLb6Q95jv6ZBS9ywzNEnvAip3SuIUy2+lQV8yOXaDvRdMeDbgAHrk6LtePvvVV6659AbQidb4OL/L2MM0YkB2vMSvc24zCxw3tGNpvdq+5wk9Fz7t/5Na2pSje6kwBMpoKYJlOJ3j6aJrC0P7b+kLlH+ojhZh6g11lA7kHDGbLggd5Hw329oGk6N+JxYr+noIkAXoayq8yWWhRWjMU/ds/eD2UFUKD7EsNII+Msk+7UazYdXJZwTP0cUGTGs0Lr+hw/h2g+Jbeq6a1rLztVJ3s2lfKEFFp8/hCo8pkJhYOqGkv++6VuLvA5m/Q6cgvP32DRtGB9iDccnr+ib1bakb8NKfTaj5WaCEqwPUuspspBymxZNhdLnJGtJHvrHsjeG3fDfF04IaXjmig3Ppgg04XjvFfx/VPsD/0Mpaqftj3+TzbzV9oAFlfk0SKvI1Gy71Bw7z4eH/AALb8HQ= +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create a Campaign Template

+ + + +:::caution deprecated + +This endpoint has been deprecated and may be replaced or removed in future versions of the API. + +::: + +Create a campaign Template based on campaign. + +## 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
    alerts object[]
    + +A list of errors and warnings that have accumulated. + +
  • Array [
    • localizations object[]
  • Array [
  • ]
  • ]
    • 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. + +
  • Array [
  • ]
    • 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 objectrequired
    + +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. + +
    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). + +
  • Array [
  • ]
+ +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
    alerts object[]
    + +A list of errors and warnings that have accumulated. + +
  • Array [
    • localizations object[]
  • Array [
  • ]
  • ]
    • 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. + +
  • Array [
  • ]
    • 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 objectrequired
    + +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. + +
    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). + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/create-campaign.api.mdx b/docs/api/beta/create-campaign.api.mdx new file mode 100644 index 000000000..e11aa5148 --- /dev/null +++ b/docs/api/beta/create-campaign.api.mdx @@ -0,0 +1,175 @@ +--- +id: create-campaign +sidebar_label: Create a campaign +hide_title: true +hide_table_of_contents: true +api: eJztPdty27iSv4LSPiSZkmRSd/k8bCmyktVZx/KR7UnNcVIJSEI2JxSp5SWON+V/3+4GSIKiZEnxTCaZZU0mkUig0Wj0DY1u6GstWImQx27gT53acc0OBY/FmC9X3L3xa/VazG+i2vF1bSzC2F24NjVlaYOo9r5ec0Rkh+4KXwCEMUGIGGe+uGObu7E7N75l8a1grr8IwqV8uwqDz64jHHhI70LxP4mIYmYFzn0TUImEnYRufA/ofK1dRSIcB34svsSjJL5FFF3HP7bVCMdyIrX3D4TgKhSAgoAZxmEi6jUF+iVArh1/pa9umL+2EbAf4yu+WnkK/aPfI5zh11pk34olx0/x/UrAnAPrd2HHSC039vCBRkDuebMFobyt8YXnLpnWI8fmuubzpagVSVyXgGBeQLAV0ldEiIvraBhFcej6NwSMOzPfu0+nVlysqcOCBRHbzscXX+AzYdayh0Z/aLX6Bm/1erxnmPip3x8ubMswjH7toS4xhIGLgC81kAybNNkUB3IjJufP4NOKhzGOz1ksYERYoDqLVsJ2ucckW8QwCUZLIKJ/sEgIwvXjUQq6kXaMjr66zsPRjfCRm8VHJnxnFbh+zJzATpawmJLHACxzRMxdL2qmlNSolU/9Dff5jQjzdXlYo12Z1I9QQHv1YxIin/jkswjvA1+A+AonYnHALBTFz664A9G07nFgN2RLSR9JFu54ri820URiD08cQKYRuyVuLhLqWcTsABEhHFPATcYukWAIgy0TVAkiVRKLJE5C+haEDqwX4Mvt2P2MTXW+BhhA9/sgYXF4X2jF82UitcSzcUk2AoffA+x0vBWP4jrBuXM9DwhjC/czAukYBhNhCC1DEa0CPxJFuraMltEw2g2ze2kaxwb8MZudbu/fSEFJtX04ClsgWvm0xkHiOUgQ0ISw1rn6lJQhJPxkicrkzehs9HoyhycXs6v5ePJh9vZMfp2M5uP/gg/z2enkw3j25nx2Mb2czs5Qy2gyofoDxqD/XO8syHX7xOeWJ3QVZAWBJ7hfmoZsGTECwXwNBjEliYamjRyx4IkHLLTgXiQ0dOg7oMKTOJiLz8EnMfK84G4vHKgl2CjoirwNfb9tbFj+YAlC5RD+0eFEmI6m5ZGbbGTbYhWD9IHOZuKz8Jkr1TS2B7XvJKA4FmDhiPdBlSwWpFfwNXyFx75A1U6d/AxwxFK94LBFGCzlsKnqkBzt+g4uBxAE59hkl2SJQRF95l6i2hBQUgtqJDcbGpANQecQHdTMgGHDmzJXbiUuThpoG4GmSqLDFC3qjyQMQcsx2b25wQSm4nA+OTuZnr1G/r8Evj6BD+PR2XhyKh+OxpfTX0eX2pcJtgDhOJ2op+oLdZ3M5zOUJZQkaHpSFB3V/wF9C8APye1cHDLBtV7rZrvJcIZMl2tt1W1Oy3Xl52CAx/zCA2YXXLVMJwYI1/VtLwGsij3AWfPBiQGTxJ4DNPX1HtkgKbRbMDdmtzwCaQe9aweJD7wNgwBaIIK3AXh1MCqo0ShIQlu80JXWeDafT05HkshXZ9rXAoG150hk8v72coj2sFDSpXUYvnzcX1I63mhftlrHZvfYbDd7pil1fBBzr+AO60sPBlqgOdXwgUft1mYjgKAY0McCWUNjUIAqJU1XJ5tkIMXZNAxiSjK6wvljENRQSwE/EUnU8x5A0FHiYcjvy6qdeW5E3hRZY1DyvsPueOjD8oOuu+XIiWixbXCHEikLG8Z2QStGm1z8otPtgb7zNrFZyr6pWng7mp/BP9OzV7PynulEgBkUETEWQUy5bCmiCNysooNGEIEgXmBzz/3f0lKldNl3CghmT/dDts30ukKP4S6sDj7Qy/E56/SZx/2bhJ7zm6ITJPzG1QU88RPPQxORKXsJeBa6N+5G3zol58nk1ejq9BJdlcm/riYX8AlhlSiK6kgasoD48Da4k9SVE7gDXRQJD8iBmvAXBfUXmBD3I72hK79F9xEQkymTBT3U6Bt66KBTI5vvZW25ZWXP3aZo1kEpwzOQJvuWWTxCky2t5C/SAWicKkr+wm6BP0X4AtS247g4ydQiR9D/HrU7d0rOHzm0QRKTl2WvOaQ5KYurkW9MT/VFQRUGmO/mk5EdJ4AcTVOxsfSLU25RKKaOhqMoV8TuUiMakfQedi7gskNLsEdkXMAFsmBubhwxtWHH5YrAr/TTdq4PNHJBwB8e8mlNEJs3EpmTOIB3D+Wd+wi1Db56qO8SoGXggGL7w6zNGwXuUHPTMo7NVrPX7/x7m5tRuRVPdCsWrheDDdygUtf1OTRbwg4yYne3Lgg3qWLpO9PWlabtlI0gedtKy+S0ksPS/CM5b+oFTAI7P/jgiQWIAmjdT80Sc26OCpU5YXqCa38H5pE8+HSfmQ9tCQxBIAJFQTUWlhj02rYB/3fswYC3uwunvzD7Aj46i+4B+1s1JukvSWltvUZvzkfT12cfXk1PL2nTOr86nawt1lobLTr1+MhnfLlh5FwXoRJ6JZ+TsogS2N7HY9r6xdE8i9ft3PZpjOGSc0QAkGclSBnisG9B7WMINZQ6EIEXdkxr7lG6YSIun93BDi/VYlN/Eexm1zcqpIIISLksagHJDcADuh4os5ocf+rs9tHIlVBemuyVBpqKoiEK7uG6P6MW80GjxPVudnwvV1Dw0L79s8hE4ZQygQ4P80g08xFCjGRHwDNKCpVwTE8mZ5fTy99oozqeXFysbz7p2aERzBP6ZpFfSoa1gEuTTX0VcEJ3MAJHCxUEEgSsdnhPqqJO3vcqiCLX8ih0qO0NND2fOkxH/DN3yRcpKpkLOXZ2fqAjSmEYCk/uoZmnCxlYRQNbl/PK7AvM4iYA5edz3xbsJgySVaaypQ8nR6H5gnuxc0tD2pzLoBQ7uZzRskqxTleM6PN69utkfoahhw+v57Or86dwTorksygbUeeU9aFwS5IyT4FnsqdA3n1tiDb29GQt+mkPzYEx6PYGdrc1tHuGCZ9s3lsMDdtsm+39dfXaQHS2UBjqLSyZy5cM/sXzGhJ34sj9YEc2ED7b4RTXUgsU4/Ijs+hcnIXDZJRcyQGusNaosAMFJ1T5Bhv7ovtFeuAjff2ILPox5VdQtB+zaDjopMclRuKyJjcaqD321Y5LPnequPU5Bani3iAE6RQKeONE1JzWprBdyy/5l6l8aRqGcajWr9ckvccgqnHIXX+PWMKrJIS1wIi+k9hqfy75Y81PxlUTX5ACqAN1B5Z2gNuW74XkBifADZpkCiKexHQTNbZsQbbphywKgbJ8OnkD/2Y24sP5fAaO0kSF/ctRidQfGxE2xRiEBo/4aMP+YpO5lIfNQSit5OlkDI61dg63LXKx0dLj4SR3WrxvcFv0nS4dTtqLVsvmQ8MwDVrzdMDHiDM6PaUzEIlOmQ5X6HQDizup8wZusiC+2M4P0W16LCN5RxnJNC4ABGPSiKxJbYrEw0PxHJhw16bzPt+xjtbYuiwqG4EhdULwUsGLBftMIYXD3KHZSoUhYPO9cG8SmUUASyytIc4X4VMIUA2Q7x3LJq6y4ZUNf9SGIzPtY6gyvkwNFXbcaaNAPwXKUKmBPtK6ZlZKBtlAmf0DFZkvXNIAyAfwrE68JAfiYb6N2XvbspcyC8VSOC7K/1wsdsuJPDPXQxF42ClBoDDGPPqUByU4+Og3Pmm6JpuXmuGs1KkKyY7g4F2oo1MHhDEi2feVN7O+eyMpIiPgiRvusXwm2abpWcqtz+SmgfrfBpHQIkCpq8DZHDXLyFnSuT+bhTfyy/5SV9o6ldT+KWE6zzG9lDr4afIl4yxSFaWQS2L2OCscJGa+Ftoojrj1tKWWE3ebHYLZvt/frc4kUm0hpS8KAiltZ0EWKTVD+gxKcv9c6Sx5zP+iOT1xr7zV8D191yynsWvDTEuomXZ2onv+a4ta1Cvvs1BS9BbIOAtXt9yf+ORuULjqgCO4NLizpg+k24tBe3BY2Lt372oBjcKENgw+Zs/1J9lxBpeBa0yzIYdbJms5bBTD6lhJLF5QHFosV6A0CJf0sCEq4qGCxxtGb7KzRMuGoH7AOorREv+TH9z5mzqW5vq88A3PMlI9agngAcX/aTIHvndxEZcU5XnxhLPJfVRSngAol+pgTbRLv8qQ4ebNRVH8ZMNvitluwP2CHsmMrg2rJE92wE/G1J0gvFexXBXKXarkz10yr5lWuSHIIrp66Fbl2kkbCRY5IZEvnotIbwi47rcgoXMV1TmHmDqsGaC6Mr8NsqvaY2joB/mDJnt5n54p1IsY4q5zM5a6vwn7ow8nk/H0Yjo7u6CT119n/z35MDs7/a3w/GymfS04ooU3QPj3ufNDnKqSLfEjnWniB8kFWR7mnAi0QdVIytF5v8pcfJZuoEvZijKInmYryvMzs9VodS+NHqXkGc1Ob/DvfEOaZ8xtT3hT6Usb0tDUm21JYup16VCpfNSBklwz7E5vYbV6ds9qGcNen3e7XbMvxNBwzK41bNd28fP6MtSVydtE9rXwUYnum94fQNcs4fDnIOujpwUqup55QzUw4eG3LIbUWHR+s3FJ9Pel9dBeMkLw0BUpZoT+JOuy/cRLO4y6rvXMltU2LZMbC6PD+WLQNltty7EGhugbjtUjn6d8Yl48JD5wOdc9sE1LWvLStspbpucc9INBr3HpYwY494PVWinN92dZ8B0Bq20bZO18jIbqC7vVbXHbcjqtTrfbGVjw3QHHpt0Z2Fa/W6tnQgdUOaf0+YtktQrCuKZHIq5rltl1esZwYXftQafdsQa97kJ0u6222V04fLBAO3gQ4zxIxyTNISfz2DKMcnh1qnmm4EwXnEyVOCMcmTqTkDVcJJQ5o3xP3GHIM4eIMmiyk0VaROSoqgimKoKpimCqIpiqCKYqgqmKYKoimKoI5ifLVq2KYKoimKoIpiqCqYpgqiKYqgimKoKpimCqIpg9D1SrIpiqCKYqgqmKYKoE2r9RAm1VBFMVwVRFMFURzEbiVEUwVRFMZcN/eBteFcFURTBVEUxVBFMVwVRFMFURTFUEUxXB/K2LYChbudsddhadttXvDYwO7w0HhrAFbO1te9HvWKJfq/9oxTJp1pKWXfTn5ZdnaS6IYqthDBpG67JlHLfMY3PQ7LRMRDE/nsRz3gOS0nfFVDLa0/lIugDpOcn2UxKpxLaeVkgsNwXo5ZtHN62ySZoqIr9tzLwxHkl6MXYaQAn46SVHRGhhGx1z0DZtq2V2+v3+wEKuF9bQGThWp8NzQn+v0qS/monbl2b7uNs5bnea7U7nOzKxIuCfyMPl2qniElIF1cYTjW+u5EBkHtZqtNZiv0psygHS651hoh9a4rbVlREBgRHAsFi8I7jRaTnAEcOO2eHcbC3sYb+vy933rD/7IYSv3Tk2h81u53takAIh/ygRPKwW7uewO9+zXI8Wsm21REt0By1TDDpmq2/1nN6w7XRMu2P0gIT5Qv5AZX1/tRyRJ9Y2jju9pjFof0c5Kq3BX+uSfb/aRGUzpxmBcyua43lA9aKymLJvgXuVSf0RrZ7c2HY21U2OPReTJCn/kTVgq5RXb+g5qvijYxiRzZInn1AQWYxIyIKzceDssb9/BaLfuEE/BDCUCaQ2dFQ/lYY76CUGTyTIQqJpMRIGlGia7CV32FzNb6wmg9GLkNufANZ0j1DJle9Cf5Z2YW5e37JhWNEX3AIGa3UWPbA1LdCb/a41XPB22xh2h0M6pZM5qLsDaq+xase1mcr4Fli/yiNVMEWD739UXKV7V+ne/8/TvUGf8STaQ+7OPVA/DZpa9uKzUMJHR4rqhxtxNdJlUhoJXuK0qfP6zzumgi9TeCvZrWS3kt3DSzXo5VwVW6u35PqYZdfnylcVAWg8S66PLKLFKgLVSAbl5UJSQF25SP98ewmC/QnPpCMmvqzSzOw/yD+SpryE/ChbD/ncSo8MU9OfrwUiSHRUBdWgiYRzTHjnGGteYrs82qsgtFxgUH+Di4ixIyp+p/ONxPfpWoKoDps4EfnPiomNpAFxVN9p0BUElSdZeZKVNaqs0d/HGlWeZCW7lez+nLL7qCdZzE9QflKULJecztAwuUi+l9c2QYPs2h+WiVwWRNe9FQTGMh+rVvQcalbLtMxF3xYdh3ecXnu4aNm9Fu/2zb5pdVqY8JDb+utcjjMhK8qUtt5yHWWJiwixciXxgbmiOAicYvgvwaSQBao1SsZL/WagOZD0feY7toYbaoqDABMB7lMPKSr4kH5OI9Rp0HaJbcO0LTTg7MbF625AVbmBzE3CKugGw0trmOcuXRJenAXADe8bowXWp0pBSZksGyWrL0ZN4AXoNQfAWG6cpV6F9+TB3nD3aRe/rVWEq2sbnuLJsznO+BRnzCZfbCFQ0DPPvbv5XrwYM989diEXeEugV+52uA8MABsCqbMyv7Pyzyv/vLLxlY3/e9j4yj+vZLeS3Z9Tdg/wz5U3tN0/hwZ7++fQtmmwzJd6RVdufG83nURFYSBvgwlsutnQyX1w8iuAlRChVRCREuHxLXzLroXFql3p7Us8ktCD17dxvIqOj46+wvLAsjw0+cptpvmAfnDXtIPlkQU02aBuMC9AihY2YKPzqdpONImgoUv3WhJDEnBJXnVvSS0CMlMo+FHIac3SfZCASiMwdawTU/xDjzGpAjYPWfWgvKhpbX4wr6vQe3j6XCSgLXPZRL5HR4P2DDBdmyIlxuNywToDoAv0tOXoV4DVWOqoURLf6tYDd2flO/hm2KzFXgoe0pW4eGDx/J9vL19o938mEbq2aaEUOwcWIf01SoP32IlMShgkN7eE+KhwPILywhYeTJi98y+EYNdTRYQzUOxz0MREUuwkSPix1/vn6eo4eNEd2rxmTklkPNfxj4BCR7zQ7wXZN9oIuL68RQueNt/5DXZC9xJkRcdqirSvY9erdF5cm9e3IvEfKbSGhNYgaNGLNSwkaa9tmW5jg9AiCO5FRK1vHlzCa2jwcNcETxDqOg5ICYVH8VDLTlftm/EowGsgvCIe7/y3dOlVsRuTuiqtjJ9icWcQif9kDFkHxeD6JgEp+ma06KatBklEo2VoKDXkkA23Aa4g4XcKguFLZuIWmmLyRAJw0nxHiuRHWlmQeVVnWJgzPb7G0lNo6QR29M0444ANHLAhdUCk8Fc3cwOyINs4B9IDkgHG+fqTJlCIanpPwtqo1Qn8EfVB04D1l/LuptWx/HKcK7j0HjJ6ga2zNqCG0ZPOjvmwLknBepA3MufESmMA6xQs4+sFYAzX6CbxzWJQaCB/tPnijEd5qAQL9f5oLb1Fk/w4evcv0niVpvk7ahrl22LIUQXyXgbO/STdhZR+H2trivmBP2VQTjnfdF3/9/mBLLnn25XonyeQ75snvjXRXE8gf3K++NpvEO11O9O3FEs9di3cXjVUO680yQizfiNJXk+1+6attWKrfQiyuRgrm0fxPidXQt19h4h+H5J219AeVwH9ybTUEvP3mcW+BQX7FLCvLaO8/mGd0R6/TuGwDH3ALWVuFd7QzfdLtRMtH0pEdIMR/A1v1XU2IKXcjmWRO+7PdED4kw5or+Vvndy6gsKZK8FjVDF1+u2LJfkYqzBAVhPyfgV2Q6UsIShj7nHL9QAeHbilI8sbNOSWGS0WXbKRyN+ygbHk5aVN9lYw4dugBjC6RL+7ErDfAxVmyus3TlIzhuRdJj5e8wJoJ0uG1+TtsHWOG9mJdMnswPdFSouANrVZr9Q/QSOKU6Abx0S4jGYLPClzbaGZtB1jgUWL1DEZkF6zRvlE5qiyqcKjvhaQ2AUb7GjjVngrut0d0ALlq9u76WUJIgDzpa5tBuHNkeoUHWFbAIKBH8k+7abZNBoUCIHnGC4CntWAy9840H4MZ50Bv+ZHg6oxsAJY1jtWKGvJ9WDGlZrfWIqP6zUn2kVwGOo4WmFMHrFNZOhFBreua3lwC1TBLQa+4OHXrxirxWjPg1a6c/0+D+SoYlYZsyVl+kmg4KtDwoa6kUIFBcunnxhfkj1kHPjRtu+12Nz5DCPiNZwiHQ7LMGPI8ZYC/Pu49g7+q6FyVoVBX+Xzr7U0aA9tfs8uwuJbdhfqA07z4eH/ADZSOqc= +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create a campaign

+ + + +:::caution deprecated + +This endpoint has been deprecated and may be replaced or removed in future versions of the API. + +::: + +Creates a new Certification Campaign with the information provided in the request body. + +## Request + +

Body

required
    alerts object[]
    + +A list of errors and warnings that have accumulated. + +
  • Array [
    • localizations object[]
  • Array [
  • ]
  • ]
    • 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. + +
  • Array [
  • ]
    • 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 objectrequired
    + +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. + +
    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). + +
  • Array [
  • ]
+ +Indicates that the campaign requested was successfully created and returns its representation. + +
Schema
    alerts object[]
    + +A list of errors and warnings that have accumulated. + +
  • Array [
    • localizations object[]
  • Array [
  • ]
  • ]
    • 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. + +
  • Array [
  • ]
    • 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 objectrequired
    + +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. + +
    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). + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/create-common-access.api.mdx b/docs/api/beta/create-common-access.api.mdx new file mode 100644 index 000000000..41eddb29a --- /dev/null +++ b/docs/api/beta/create-common-access.api.mdx @@ -0,0 +1,83 @@ +--- +id: create-common-access +sidebar_label: Create common access items +hide_title: true +hide_table_of_contents: true +api: eJztW+tv2zgS/1cI3YdtC8tO3LTZ5MvBeR28SJusk6Af0uBKS7TNViJ1JJXUG+R/v5khJcuPPJoN7roLt0BrUcPhvH7DGZq+jXQhDHdSq34a7UaJEdyJfZ3nWvWSRFgbtSLHxzbavYz6vT7zr1h4d9WKUmETIwvkAPPPJ9Ky3mmfwX+lFSlzmvE0ZUZnwnY4zWKF0SMJz/jSTQTLpHVMj1jieQeqkTaMs6S0TufCtNlA/KeUBmbx0k20kX+Q1MwmoAHOllzu+qlxrlORSTXe9eqACgYmC+v2dDqNdm/pEXiBxs6UohUlWjmhHL7iRZHJhHh3vlpU6jayyUTkHD+5aSFATT38KhIHfEEVsJ+TwtJcb5VH6WTaoLHOgKjRoiX354zRP4juWmHG7YOUSMNeDU6ODxkYsLe/f3h29u/TwclR//jwddRaWlWoMkfnzlPCC2SBDnbSZaJexjv+HJmAQIrn4kdVoTl3CzQ/xqL5DoQos4wPUUZ0JnDWN0qYj88QjSbWAtJT/4dd5Zmgw+5WG6/vRB7wAxTWcVfaVYtUntk/+XjUH3w4PICxg8OPffiwhLsz4CKWMSRhqXZ0vxg07UFBBx44QINUAL9CK+ujuLvRXQ7GgXClUegix2VmUSSE+LxYScatlaMAMxbAiYK+EBB/AGC9ADDQNaBsjeI1iv+KKG5FACt3UaTwtEJfgu+1FDci3ZteWGEaJEMN+zNXFY9BoFvJxO+pyzwqigeTiU8fIZtsbWyswEEmIQGwQ2Mg8GPm8wkUEtInkpAr2BB2ciwypLrmmUxfMHf4zLUPJcTjMXMklYjHhkuUUJDICUzECudapjCD5dqIkAyrXEh0KLD4zvOCDAWWaG+yPZ6ykG+hzvLKoDUNT74Br6cE8YWSMJ9VU5hMqY66Z1mxLfjw/cZOd2v0fovz7q9bm9vvhjsj/vbtxs67nR1cPQff8bFoxjY3hk+Xlv6XAMTIhGU6AY/8AQaBQAHbkwC0OEzBUH5CaiUeT7D/OVaPRFurGeRlTnx3LSgg9/ZP2dY2y7galzTOxwtGUPHF2aoE5BmfGDmWK3NbheyDw6PexfE5JtvD3y8Oz+AT8lpCd09BtKYYliAqxMJE3/jy1ytwwy2zIgNziLTN3gSub0AhDvtpg1D6Jzu1uGelYsTLzMGMsPqKGU3WbGR0Pgclws13x17Jtmi32BDHcu6SCRtyLOHBhUj+BnFcuPg4WPINmwieCvO6zXppKlFJnjFAIzCF+VNghKU/QtczGJUAZRBGQvleOqa0k4mY98XMlPPemKWU46ZTEBwg+eNx0ktcCcKRmk0U1tESRAz+AZm95ealO28YjUw6VY4noAXPsimY0RiwMBuCbtJZFtIRustC4lEVXZ2xmpmS0t0HL8yB0/Qu4aV9Au5OM0g/MalWv7gWAXzUY/lsRN6o3BQyUmjAaHKgqt1VAZ+NpMjSNXbX2F1j94nYXXxZ1T3hLZU+m8ulz4WqjjZAiaXSx1D0KL1w/uEd2cI2IZRIv306B2B/EwrpxfcCDzpesD7yW/mS8L3aH358iOVH7aw5X6CAZEevwQgykUh3Se6ZxGQob6q3y6sdaTOUEKBqRYkIWdOwqS4ZB5OZUimUhNsWS7Ww6hfHJhzyY9VoYQbEVVUaF1qql+xC15XkupJc70br3WhdSa4ryTV219h96UqylorQEuokW+Y5N1MfaeE9assZELDqAJ/VkCNXLVYryIzVNVY0XzlEw+7mcHO0nYitlG+l79/ujLrJ+y5/t725vTnc6m5Hzb3+cobjGmTzmGr42/uRTAxF3DXUcaWC4LJO63T++A/Ma8QI0xp9xVjVzWBzMOlVXTt2d5Zrx3Ot2QeuplWFZOdqSDWzEeY0oM2R1lS0QMDZGPKiYpCqJMiFoSRzAVwMHt9mMpcEXtQC+Jpp3Bs5UMUDpQqyehWpkqwECSkTZBqrZg2BJUFJMcKaDzhQBTuG7PyC1Wlw0Z+q5NkANT5Gjdnh90QIBHpdub9bdb7bB+EN5ogz7+B7Dnp9t8MVBAA0BD5n1XXnuj5f1+frPX69x/899vh1fb7G7hq7f03s/kB9Hqqh++tzIHhyfQ607Q1W11JHGFz/8zKdoBIkoPBmOklKQ8fNVQ1OdQWEEgpUaEtJhLsJPHX8JYeYV9cMfcXvZSlNBiQT5wq72+ncgovANXdtXsg2ZC7wkpsqfdMGFp0h2GVFysG7AR5eSEB3Ev0CbTKqkRi3PskRc29iUgMjFExNx8EPcsY7Jui7qS4hrRGbFl7dCTFEwyBiAQ3EL/7KTJtiZkk/0OvCZHd/XhfP6B5dVpnvwdWAnoGkCyqiClfoLvA1MCJ/4V2QfZ+heiW69/KqSXOGFbmXcIlytstgF9ddEugEybpsT3AD7YL/YuPVb5/OX7Mx1qGUB0qLJbCQ2DgAkk4hjCjP9apDfpxEW4/R5XhCyvXmvkZBXLFRBkZhn9WZEOyyHwz1ETaAAWRsMjtOEpQkcNbVq8qDqbgWGe6N7Zm1MThlqjpgxQ6fm/ea9kFqGKSCjzmNtj+rmB1ITE8S93OkCSpS/8cui0ov3tDruUL8o+IWEBgTN/t6QQpv2svEX8tJANzIgmeWrPXsxT2/uMEPuysYQa6LMqAlghzzX34lldeeLcccvxj5zcvxWX2aSNhk56cxn9OYhT0yS1mfJROtrfgnYxg6CJXLcQlIe7ZYN7hoTIiIuxsNkWK/ZCxjKBlJvmMAhvLBxIe4ZVPFoqGYU6mH7RfyLOSFL9BQp+zLnM40fAk7K1KmOrHPlhkXjHHB2OcJG+QPV0FBWMA26kB5wAfA/sz/lAmCoI3c6HmtzPzEvkNzcPvAi+DExRa7/mF3lgTDJ39dHKlrGkjVWHHXXwfCMwu8cPeaM1Z1VrBowWV5Mw2b5oLdvLz1WRVupD+bvqhxb3akcqKy6Utn6Xsyyc+Td/9PGW+daf6OmSbUwHg0OZj9BuWw6laavxnB++Sz1ijAbelCt7+sfV8LVQ83bk8vDPYbyzRuLjcuKMMowoPMFJqbJij3Qg26fCSJZ+YTAf/CW8ot1B5A80XtJFVdTUZFxh2ikLJQMpGCDjMKwR3Wsy1Egs4pcxRGo5WgZSVGY7qCbMDEHNpPmQE/Om6vVuYEcF8sYxzisy2po8K1kgk0x6LNPkF/qRIII+wt8cIIvPuqQ5N5BpF0ioHIDqrgpB8/lQpWwzxS5owDBB6J4FTapPSJFlpNJSpbaCpV61lV1kFooAp03VuY3J6M8JwcWvBGoD6yFsSpDYfkYHr0YoiZmSIDkRGSkG6+FXmMN6AjnoisoKviIBbe5p6t8KF/vsQRmCkLeiWirc24EybZDtICE2z5fPi8bW+2N2JqgWAcm0XoxxvM98nrK+7G28VIvJ19Q/DT/iIt4Bv7oE6BB3uodOl7N98hX0bzHTL0UxPsoOHF7S0e+mDLeIfDkFfwROHyatYNUgcGE+jwh1q0bwIPHcK3DTH99qM+XVj+GgWbVD/DHyg9SHvVaPJPT/BoLRqGX9rl/rzC8BsYxH93o8/wF5NR4SMQiGj8NqpO/4DG88U//wXpKdKN +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/create-connector-rule.api.mdx b/docs/api/beta/create-connector-rule.api.mdx new file mode 100644 index 000000000..2f4db8e8c --- /dev/null +++ b/docs/api/beta/create-connector-rule.api.mdx @@ -0,0 +1,104 @@ +--- +id: create-connector-rule +sidebar_label: Create Connector Rule +hide_title: true +hide_table_of_contents: true +api: eJztXG1v2zgS/iuE7sO2vcixnbRpfB8OTtLupmg2uThBgUuDKy3RNnclUkdKSb2B//vNDClZsp2Xdnt324VQILWp0XDe+QxF+S7I+dQGg6vgUCslolwbdl4kgp1wxaciFSoPrrcCnQnDc6nVcRwMgsgInovqBqQPtoJY2MjIDKmA5pBoLONMiVsWVcwNEHc+qiHL9a9CsVuZz9jp+Y//Gh6dHP/MeJHPtJH5nEnLjPh3IY2IgZRFPElYPoPR4dlxB2bDi8LmBzqeB4O7oKQNBrkpxKowFzOxIgLxJBGBF1zKUVHgw7MskRGpuv2LxZvvAhvNRMrx04qKdQM4fc+dVMAzn2cCaPT4FyDx8joBrwLFU1GSbAVWFyYCa8YCLZ0ZtHUuhcUJiRL+99xsbqSartk6B/WQkukJw8/GOUR85mmW4H0fxHgkzI2MxIGYaCNOS3d616VSvRdqms+CQQ++8c/Vt/7rxcpsjwnDWe17XaIfLMsKk2nblO0CnUouiTXESz7jebAo7bc+mVBFijY8KGQSn/AMhio/DCe5MIelV5vDRyIRG4ZPdCwn8/qws9A6Fze+zsaNV3zeHR0c1mTDr5W1z4y+kRY+OFXwWjUE38+EBpOM9CT/6fxkVGPSvHAfuyZVnfH58PDtmTCptDhwWNhcp/I34gFXR8Oz2lwjnv1kXPKXiU1D981KF+uTjYooEta+5Wgce99ty4gkN6wG5MMBe70pATBQMNzWgr9SDqLKyqnieWHEejZfLMN0UqiIorci77AjIh5ThFaEUmVFzriZFlgoodipmOkix8FncgJf588fKQXEYT3v3fAy/LkxHKNL5iK1tfGKpyqShI9RX1f/vkUZKfVqWHMijc1/Rn5fWhiQ5YbSsHEWvEAzNQSSMdDB4vBQfVg1xLoMYJqp4WkK8RRVUXOvJCPHeLHYUMLBbSAOkQ3Le5HQhUDrpj+0mxaNlXetHIyW1x7O4BthfOVzt68nc0nxJNN74lLZyAmwVLTX6VIhc3M9yvJiEw8joKYp9jE4MR34y/7KqnD5G5mwNFfNCDDKc5hjXOTiSRVoFRWkPEOlnJwIv9ydti7Z3aI++wP4arFwnraZVtbJ0+/2Nhd1B/PiFQD4jWDfuRcB2AFCPZ1ARLQwsYWJLUxsYWILE1v80cLE791NLUz8nmHi1uMCNMpsjLDQ4cUN1TZ+mm+Oj+5FWK97vZ1493XUHe/3die9vfFu9Kq7149342i8H0/IfuX8j0MoxY5Hp+z1q26PXV4cslymoDRMxW5nQrndUkJMt9yWKLghTbffC7t7Yb9/0Xs5eLk/6O/8EwVIEaTIzRI84r4vkSjhUBCquR6Va7G4vsfnFQZ3XcFut7sBtCcS8pm9MQbwf8jOKbShKZDeUS5g2FjHtPUs1Q1PZNz5ki5hNdCawROLnMukLCIPO/atVCKEqiZRQkEiY3JirbuRMeZFCmCHOZZlrBFdp2FHsESnxw54zHxCsEOvDKaP4dGvwOv4CZF2qSTcz8pboHQzgFv3TSv2BB+/6u73dyevdjnvv97t7b0c70/4zk53/+X+PsUYYD/AjnYDeGlO/aNQwkBpT3QEHvkNDAKBDLYnAWjyh/BO0wfE4wn2x2roaCs1vbwsF5/zLcYZQHK2uwcxrKYFjfPpihFUeDlaSxjQ3DE+NXIqN9b6snM5evN2ePn+AnH5m39cvhnBJ+S1BmqHCqI1xrAEUSEWZvqWJPYKYKZZ6EYiSP4Oe+G5vgCFuLJ1Qum+2bkFY0JsTXiR5HCHn33DHXXWbGJ02kglypvPiHA7orPFxjgGq3Q0Y2Nu4QatiPzFEPqALA/fe0u+YDPBY2Ged9gwjiUqyRMG2QhM4f45MGI8jjF1HYNJgcibHiQBoGJKAxAQTV8sTblavsp68r7uFEwOkPzxOBlGeQHCkZr1LKyixYvo/QMyO8s1pbuoGY1MOlc5dEUSH3nNwYzGgIUZLKhMQu/gyxG6y0LhUSVdVbHqSyOVuxMnzFGu6VrEC/uEvDtLoPyEpFp14Ub45LO4MLtqRN4o3eQrElykVgtv9lSVu8rEBywhkrjN3TZ329x9Yu6uXixxj79K0GfDHuil8k/VcfFcgz6Gokfp8tG72+/xjtxiYBAPkd59uPDP7IFefM4QM39DfOSW8jXhh5U/3PiYuoLSWQ1foIBkR6fBBCqRiAck91JiMpQz1c76bG+1GUsIULUBIkLVNGyuC2gsEdgr3KFi3G7RfqT6IWczDvWR066Wq4A4q4rDTEuVt0iyRZLtatSuRn+e1ahFkm3utrn7febug0iykoqyxeMkW6QpN3MXaf46assZELDyQTyrUo5ctYpWkBmrMFbQRA7BuN8b9yZ7kdiN+W78amd/0o9e9fnLvd5eb7zb3wvqa/3VMo+rJGvmVM3fzo9kYgBxN4DjCgXBZXOt4+b2H5jXiAmWNSw9FW4Gm4NJryvs2N/f8GBQazw0Oy8Rkm1gSLW0EdY0oE2R1pS0QMDZFOqiYlCqJMiFoSRTAVwMBA1LZCopeVEL4GvmIT0S9YlSBlk1i1RRUoCEVAkS7fbSb7kEJelRKUCwOSHYKVTnb4hOvYt+F5Jn56jxe9SYvfkcCYGJXiH3l5v2d49BeIM1YuQcfM9Gr+t2uIIAgIbA1awKd7b4vMXn7RrfrvF/jjW+xedt7ra5+33m7hfgc4+G7sfnQPBkfA60nS6rsNRbDK7/OUynVPESUHgzHUWFoe3mEoPj0RYBg3h8CCe5BFx/6EJ5WOCJVDzLoQZ41iBMqzfZwuoI8MANBtd4qCAVEJSoWqbpTG7GkUOwXVGHyAdPoLjuwelVmASIZnme2cH29h24G9y86PBMdsqTTUrfdiKdbo/BxhvKF54zcKmKBPhim29POuQgIzEHXMEk5s5dZBKMdnAbbS0/yLk8cDXXBZRIYrOFx6R8PNIwiJhBM/KDJeoOxd+afqDXpUkWv18Xx+geXTaZ78HZgJ6BpCsq+tMiZYiMELm72dcCZbkaYbfXX5vsFMn67EBwA22FewDy7N2Hi+dsiniV6kVhESoLiQ0GZNwZhAjVw2H5MABvoiXK6GI6I8GHjcctmH9skoDC7KMaCcGujr0RfoaF4hwqO5kUbxJUTPCu62eld2JxIxJcQztLS2LgQQ5sg4W2eeO+57ReUmMhFXxMabTzUYXsSGIZk7juI41XkfpEdpWVevGaXl8rxF9KbqHjFhI3+3xFCmfaq8gd34mgCCALnliy1ldP7viFNX7YhcEIcl2VAS3h5Wg+JItKr321HA1+IfJryvFRfZhJWIybtzFXsZiFtTSJ2TGLZlpb8XfGMHQwDa6mBWTRV4t1i5OGlBFhv1sTKXRThjIEaEnyvYfEUC6Y+BiXdkI2GkCfil1KfiLPQs5/ooPPnxo60/AVrMBIGevIfrXMOGGIE4auBlgvv1vgMLAgt1EHqgMuAA6X/qdK4AWt1T3Ha2NVJ/bbdA8uDRGISlxsNnBfBssC5z8xuoDUFQ2UYUTm1WNDfM/Z88JVrmGsck9h1YLr8iYaFtcVuzl5qz0tXHD/aPqixsPl1supSubfukrfU0n+OHX3/1Tx2krzZ6w0HivjFub58gcT3lQHqf27BI+++bUBgK28i1Wdfq+9JNR4jca/q3JVzbl892DTIeoH3heopipP81/X36X45tzX3gCoDurTKfvlIftHDsyvnIxHvlgGKBx8s1cvPgceR69v0eIzhJmAv3CVaii1S9CMul/ToCPoNUZZwnOsNlRto5kUtLmTCZ4jJt/CjNcpVcjMaCzL4FJiNKUj4wZCiUM7LhPgR48fypk5FTIH+DHf8LstqMOkn9eYcTUVHfYB+m0VgQWx18YDNHDtF+2b7hFkzBkmHDsqkxDAcJoWCn8EBMQuUsYh1R/J1FjaqHALiu/anAqaIHl1V1ldsQSgCh3qOk1qTyc+/GsJ+chckI/WPzQA09cib6nIuUgoiZCu2U49xhuqQDgTCb2MBquhwNPtyxlOji/WOAIz5cK0o810299kt5EWmCxjdqcDURtSGwfj2PJCL1xj7t6gYM2fg1kNwrvlw5L/+i+9+HTElm07w71KlLtwLaRr1a+C1VYdKsIMm3m4dHeHO1nYuy5wGIogbpNcXS/bUvwGLN2OFlWoXwXupPhHKOGFewHXb5msPxvCbtnd4XbJHqSt7zecneJ+YTD2v2GTuk0Yw29hEP8Ogo/wL8Cf33FhBEQ0fheUW5pA4/iWYHETVvIfUM3F4j+V7zkq +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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
  • Array [
  • ]
    • output objectnullable
    sourceCode objectrequired
    + +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[]required
  • Array [
  • ]
    • output objectnullable
    sourceCode objectrequired
    + +SourceCode + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/create-custom-password-instructions.api.mdx b/docs/api/beta/create-custom-password-instructions.api.mdx new file mode 100644 index 000000000..c1c367420 --- /dev/null +++ b/docs/api/beta/create-custom-password-instructions.api.mdx @@ -0,0 +1,75 @@ +--- +id: create-custom-password-instructions +sidebar_label: Create Custom Password Instructions +hide_title: true +hide_table_of_contents: true +api: eJztW+tz0zoW/1c03g88pnbaUujSYdkJBe7tDo9uaYcPbeei2EqiW0f2tWRC6PC/7+8cyY7TpC3L3mG5TOjQ2tbR0Xk/ZPkyKkpVSacLc5BFe1FaKenUfm1dMTmU1k6LKjsw1lV1SjA22oicHNlo7zTyQKKBEgtg5xtRpmxa6ZLugfh4rK3oHx4Iv4IVbqxE6lGUDQrdQSGGRcVAtlSpHmqVAW6kxMHzRPSFKy6UEVPtxuLt0S+/9Z+/PngjZO3GRaXdTGCtSv1R6wqzXCFSmefA5SlIwAMNKuueFdks2ruMGthoD8urjSgtjFPG0ZAsy1ynLKDe75ZYuYxsOlYTSVduViowVwx+V6kD3rIicTqtLI0SvSTVFg7caTOKlmWjGt5ApXSgvayUBQVeTDxG4sD/kXKitqoSRk7UhiAwNxegNJmoTV6kF0KmaVEbJ4Z5MSWWlaknpLZ0LM1Ixc2UPayiqvYWgFcBhtpoO8YAYYqtyhUraM9f0XOmKiaqiKg9uoghIJ1jcDKUYYm0yNTCg4uBDPctKmbnBtpWjjcLL4+3pHuZxEEmy/OujId55182WIf7c3O4XZHBpr/ClGHHOUQqBtLqVPx6/PoVAU6gf1LjRH7Sk3oicmVGsHLY7tbm5qaAdiqZgnybiOuWm2qY+wDLSaOd/ux9QH4sNAzEOZleYO7BsOOB+jMbuHDqkwOqNK/Bl5Ai1+ZiA78vlHjSF78evXj5j7Ozs+jk6BX9eZokyZNe/6lI4SEXkIcgFORlTAA8wfAahMUP0XpVBVGKQVVMyYq9HEDMrKjFVGIEF5WfAqLBBNwSrgmOPRci08OhYhw0d0OUuZJ2Dia0I7iz6LdBLs3FWeTJJ7L2xBMpxpUatkxEwkmyXX4QJuBKPKX1n/TkU5LxAj9SGDXFrIGYjrvsAYiloLJEvCmcTpWYqjuVAt/5TNi6LAuEBYjIryKk9+yGahY+k5JEMDoYo8zVKntTn+SkpCH480rz81Nbi1thHhtg4tn+4c6uACWjmmILQrq3pkwNZZ078VHmtSKmSBzhIV2COpDntGMSrk0TxENL6TwO3ureC84WvVOgv5iU0szmEa4sIGbEV+YwUw5RxorBbG6DrY6jusphpGMYC6kSlBPtIKGEEHyA3t7cpD+LUjxSbF/QIOzotixFkXWdLdbZYp0t1tlinS2+b7Zo+G6W/D4JZGdVztjPNdnYi6oC0lgcKVdXBjaoh0Fx3G6IAfoNkpM2EJnO/sTk4RnZp6B5a9x5qY2KR5XURKFikinaCmD8qDMSwaSoVJCNKDwLDJcs2BQkkWyJZzIDv56/RvSkdcQdEufXZLQTozFfNFMEIk9jkSuWVbtKDh5tPt7eGT7akXL77ztbuw8Hj4fywYPNxw8fP6bVJ8pamILtrC2rSs6Wlv5FGVUhnrItcfBDewrZMwG8OKZopyb2dh1c74e3Ol6gl0Nq8Dhx1eWu+HN88g5PTJ3nckCPqHNtg8HbSo+0WRkSQmJ//uJl/+TVMZ4cvfj3yYt3uCJcS31738BaMzJLkApbGCMFuTkDU4Qmn48plt0PWO+DIWlsF1D7OzuzEGYTOTAjrL5iRhe1GFaIS11XYr9B/rmrE5VsIPTjGZJhOqYEiQkhg9zvp6kqXfwqSPK+GCuZqeoe0mmWaWJS5j6AWcyfUQ6RWUau6xEMa7iy4p2GonbCcLRe1MVclIvamIe+V12lkHOA8tvtpJ+6GsQxm10vbK0lkBj0A5q95BapO+4IjUU6M0jq4ELmyDVpUXEeHNSUC60I4YjUZRF4TAPXRqxuROdw99oT89wVPJbK2n6F3x3mCD8xs9YOfFTB+SzlZB+NWBuNmkJECmU5Tw5Qrboaxxeom/Js7btr31377lf67tXBo9Aph1EufR4slz4vi2qgIXWzou7h1pNqdQk1VLUxlN0lasqsUNbccWIs4fToo0CHd2vQrkwWl4U2bl0ercujdYhdh9ifJ8Suy6O1765996/puzeWRy1V7C2hTrL1ZCKrmbe0ME7cSgEA0byIEK3LsaquViuETLQ1VrRYOUSD7a3B1nA3VTuZ3MkePXg83E4fbcuHu1u7W4Od7d2om+tP537cOtmiT3X07fXIIkYR9xF1XG1gXNYVRba4p1XTG4ghhTXecvXv4D9Dd7Q7ef7li68dH67aNjugLT2y0nd+iWv2zyr2MWlAgvpUeq9pK591hbiuENdZZp1lfo4ss64Q17679t2/pu/+FxViqIaurxAB8NUVImCTTdHWUi/Du9DvWyiyqwQK/FvhIuXX99m8CuS6AqZEBJWF9S9s3Rh3Pf/muX27G+vFM6e+BPWk1VWOGWPnSrvX611CY9DUl0SWOkEgg9LczBTTJC0mvQHEtCIC0RtY720EwKdS/QIJy7jSZMY+5jFyL3H/jhkGC8nz/uSNmOmoCKmSDyh4NBsCJh9Mih+Hd9N3LEMnbEJL/IGvkyr/8r/z4hFdw8sq8d24GuAFKL3CIrFwTuqC6oGI9XUCevZ9wOrXpO3T8y7MOyrQPYVLkPOkQ23F9hJBbwlsWzxTskL34M8E3/3X++N7YkRlKYeF2lJFrDT1EXCsQ5gRh71+s+tMkzgTVUU9GjNz/dDE+HMu5Gb+YJQ4M3Sm4PQgCOoN8sERAjiLnSYpjhk06/xuo8FMfVQ5pcpkLm0yTp2ZHqTYkwvz7nFa5P5BG3/AB0+TMxOL583hD392IbDIW+ritGz4kh2+vpWIvzXYYo8tZmz23hUqvGhPU3/4IYWvEwqZW5bWNy/u8cUdfNRs4QlhvUoDSSLQIRe0ljZa+2Y6FvDxgbRFOs7M+7FGzl2cJnyIExYpM8/EgUjHRWHVP4Ug0yFXOR3V8LRvJmtKi8bsEfH2Zoek2C8ZazqrxvS9gmMYb0xyQBmcC5gCtZ3JvNt+YM0iLnzgY2QfFnjmx6dItASZFan9ZpppwZgWjH2csIH+cP4GxIYTgxwHvAHsz/XPkSAQ2omNHtfKyM/oezyH0kcKUhmLLff8zd48CDbHmHiAoFsYhGoqwNv3U/QZQcBFyWxBWM3WwVUJLtObF8ihV+Tm6W03Tyiv/mj8Esf9+Q7LW5PP/uwofU0k+XHi7v8p4q0jzc8YaUJJTDuVR/PvkV6sOAl56ynsxXOPbUvVqeKpAyHDZgZDl9J1p2ehelzeW7R0HlbhN0Y5KnCdjy7Kf35F9VIXUZlLR/7D8SMda8W7EqWSjirRDbLhYsI+X1YFBRplPaIRfxhWQTgSfaTOgY+PmTYrS3ZNX+aSBdG9rbk14m+8WEaJeI9G0aQwAGoS6ewBxn4vQrf4DjZwSCYknjdmhfJuMqkNfTUGsuuJkDDeW2wv0xYNCwsDPaNRjSwKLjLbWU28IKMmFhJul6qJfTukDW/00h0Tu2UtWJgNu90QPWmRD6OjE2sZOVK5bBqmxSbiNtyw63is8pJPE4MsNJ2dFV4fHC9hpOPNFnylKimqUS9Msj2CBRJq1rz5PEi2ks2Ymxc6H4+uD411B/k+a13c+DHhFZO8nO/5/2CfFYY8SA1Mr6QNOuK59k2X73RPoxs7XfRFY2qMAXd5SXs51Pp9oceID7RRcHo+7+q4k8IE3tPhVutC0V5CCATx8YzTe9g0WH47Qs2mn+H3iW6EPe/07odvaccsGoSvJyd+G6KSUzyk33vRGX5wU5SeLfrEkp5fRs2mHmA8Xvr3H3bQmt0= +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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."}}>
+ +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."}}>
here\"\n}"} language={"json"}>
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/create-domain-dkim.api.mdx b/docs/api/beta/create-domain-dkim.api.mdx new file mode 100644 index 000000000..0bc53091c --- /dev/null +++ b/docs/api/beta/create-domain-dkim.api.mdx @@ -0,0 +1,87 @@ +--- +id: create-domain-dkim +sidebar_label: Verify domain address via DKIM +hide_title: true +hide_table_of_contents: true +api: eJztW1tz2zYW/isY7kOTjCjZsh2v/bKj2E7HrW/rS/PgeCYQCUloKJIFSDtaj//7fucApEhLTtLUu20zSjIZigQOzu07FxC8D6yKSqOLWbB7fR9cWWX2srRQn4pBWUxwL7D5bpoVeqQjWegsDW+V0aNZGGdTqdMw/qinu3eYr4Kbh5tOkOXK8LjDONgNIqNkofZ56D5GBp2gkGNLZE8aNG2AmbGykdE5/cbMPZ4ppHDriCITQyV4ba1icaul2P/58Fi8cMR/VjMrDmOVFu75sdTJS6xm1G+lssWbLIZ89/xTGwXWClOqThCRqGlBj2SeJ56d3q+WeLgPbDRRU0lXxSxX4Cob/qqiAnRzQ4IWWll66nhsjLOF0ekY49QnOc0TvgWO8kynRTfKSA9tcQeVnDKOjbI2eHiAqnTBU52Ig/oJPcNlDsW59ftra8xGi+SRtoXIRk5NRfZRpVZU8otRZkQxqRTqxBYQKsIK3eDZFKPjzytlvb8x3NwaroUSf8Ih/oRyOx6GuL+59Vri3zBa0NWJuhNXV4f7QlqbRRpuEos7XUyWu0oAZf0v7IMRcOiDVA4TFTvtj2SZQGUjmVjVIO1crU2PjaKtUG6+twdueFY9+Us2W4NxaYycgTvgbWoXBXpoLHsdsNHXCXN00a8uNhbR9qSPSAQBApWzf8XWLw2vuShkUS5hpanbs4OT/cOTHxe06ubWTvp4sYcFNp0NrJu2f3kqyE9xCwsKBYvPoENc1iLAFVy4qgNG8BhWjof9IvPA2lyGpb1EgzFxYAx0EopzVZQmBX09YhT5KCOGCDNkVZ3eykTHzwikWEHMZC+L1TJNt5l9q1MVjg1kA4eKWY4wkeB9q2PSzzQzSjiSpHwSgcd1W1aDJrrr4o2MIa+Tb88LQ7HJyOgjaB0uRXiboatUY76opgg9jz9LllXbSg5fr+30N0evN6Xs/3NzfXtruDOSGxtrO1s7O7T6FBCUY7UMGe2lf1Qp7B+JJItgkf9AIcgr0D0zwIsvAdMTNmAaX6H/S8jlxtZien4F5dUOktqbvTOxuS0SmY5Lvi/Hj5SQhlcXuJOWSUIRwkURSO4Inxo9fiKgpeWUsL9/8HZwdXSJO+cH/746uMAV0VpA/iCFt8bklmAVvjDJ7phjL8CdtMKqBOpQcVe88lRfQSCJUNEYqN0vO7NQpvCxEDP86ktmNEmLkcmmLShFrggRL3RXdTsI6Lg3lUU0EUNpMQEmpOGvBlGk8iI88pp8JSZKxsq87ArkS01CykQAjSCK+TPKDAjhBF1HYFQCyorzR1YWgiqdSLVtMVdl2xrzSHLUNAqBA5x/2U8GUVGCORazicLaWzyL3j7g2Wmuzd1lQ2ms0hkiYkRBNElmUKMx0LAYQjZdWOHDEZnLIvCk1bg6YjXrDg53x44ZFyARz2RpvwJ3ZwkVhyxa/eBWefBZissuGrE1KjP5iISHJDZP9qNqc1XAF0jtSbzC7gq7K+x+JXYfPzz3HUSz9FlfLH2uUirLMsPJc6H0Mew9aSaqQa6TcIbsCCjEl0g/vbt0BSZXvZ9yKs+esT5yqXyB+UFtD3d/SOVHbayWLYhB1qOTYIRIpOJd5nvOMSvKqWpjcbW3mRlqOGi6pERE1DRilpVCQmWmTLlklbaDgl/Z9IdCTCTio4yoAXMRkLuDOHQ9yaqSXFWSq2y0ykbfTTZaVZIr7K6w+/fE7mcryZorRouvk2w5nUozc57mn5O0UmCAqPayRQ05NtXjaoWIibrGCtqVQzDsrw/XR9uR2ozlZvx6Y2fUj1735db2+vb6cLO/HTRz/fUcxzXI2phq2NvZkVWMIu4WdVyZwrlskWVxe/sP6jVqRGGNQk9dN0PnUOnNvHbcWqwdjxUGx+IkK8QgSbI7LrYrmxNiZOGg5Tj4mGZ3trX4lAl0mAkOetKMFfFjs9JEqq4zbZnnmSlcgekmPXcdfiKn6g/V4tDChWNTxQefCNp+81k1fHFxhf35rxaUWrT3ZAp4EwTglKqGAov1J1ejlX/0dxZlu8wycSzTWVVB21aPkc4xRDkPY6c01lRj6cWFGCNvpgLG0nA00o+G/KEw9J4t0VPNwZ28HHTNLByMCjiaC6RVEKpX0WmUlOCQM0WSkSUzBB4NEKgR9QSgwB3OGNn7Gf1r+pTtf4d3iXOS+IgkFuRdihJBrf2tZfv/h2DeUA65cPB74kWA64ZligCBhtHltNoTVv3bqn9b1YCrGvD7qAFX/dsKuyvs/j2x+zv6N18NPd2/YcBX928Y210TdS31lo/L/L/bOIaK54DdW2RRVBp+HVH1aFxXUGeE8XlmOYhIOg0X9KpjRf78m8Uj15I5dkqTYNSkKHK72+vdw0qwzkNX5rqr+XRaMUPnRkeMekOoZknUoeMjDmE0QAzODn3P12W9Gk2u6+IcE28dPZqfYvos5RQNGplvhtZQODId6oC8G/FtsJijh/jB8uguu82CfJDryiQPf1wWR+gJWZap77OrYbwAp49EJBFuOvV5xwsquN3qC6ce50mEmvj+wmKnNKwv3ihp0A2491ovfnp3+VKMqcxkmJeWTyVp6gsAlDO4CIexQfWOhyZxZjFZOZ4w44PWWzSCjRglEFi8Ty+UEteHXgkniO/nCMis0kHr2NTNi8o6sbpVCaW+butsW0/HaQ8a6rWPW73kNMf9gE5xOeW73fdpKPY1RR86p8ljvIjc3onrvJJLNuT6Vib+UVELHbXQnUl7+YgLp9rryJ3KioBdIiETy9r65sUdvbBBj5on3CGqj3kgTXg+2u8+o8pq38xHi15I9Np8vE/fTTRyaHua38wRFikwicWhiCZZZtW/hCDXIRhcj0ug6JvZuqNFQ0ZE2F9rsBS6JUMdoiJk/o4AjNQ5kxxSRuaCJEOtlsYOkh/YssD8B/TLsfjQkplvXyNx0sg4i+w380wLhrRg6GKA9fy7vESOBWyTDBwHnAPsze3PkcAz2oh7jtbSqM7kezyHUkMEVpmKzXfdj915gPNXgh/Q6HoMwjAV1PXbYPwWnhYlp5ayqq2Axxpc5DfJkBMf6c3xW29VVmdE/0ryksSD+Y7JaZrMnjtKPxFJ/jpx90+KeKtI8z1GGl/i0s7j+fz7iIOqGZl/z/DoUDzmkIsyq75/aALjja/xFnf9aFt6ovA/njK+uQJHf+PO7VPl0ySUJ7IgJHAkiCZa8X5BrmRB9WKHvBEMEnr9FwvoCpnQmD8aMRBTosPTCejxjna1smSQuWKUfIF+25KbFlormqD/VF3xDi1cGsGU1L7RmR08+zXzfdwFVHJGKhH7lYOgUJtOyxSrEZbLqZBwwy94UaxtVLpgh24uVZUuMi4X61kV8sk9SYQuNzJmak9HtBWNLrfhLF9YC75i/T40VE9WTPlFTTAX5Fwl/oOczqNS/0u04aHhRCU5OQkiNYo21Vjh+PBygSKIpe7dVDcz456fZHs0FkSopXLus9Fd766F3GLgPvVjaHkbxH9xJ/zbH2g0D/y3vPF+vhH/XB8Z+SxE7UMvT/znG6VrZ1zfeB0s9I3oRCbUWuLZ/T3thlAj9UC3gUhqta9v5j0S/QJNtyvCjeZHRd2434YPL2ecUH3bvfh+gVo3N8PttHx27E2j+z07pT2nYOi/n5q6Rt7IO9yk/3eD9/gb0Hdfzm/oIyu6j87cb+ZgjKNbVS7LEre/IDEfHv4LmU0i9g== +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/create-form-definition-dynamic-schema.api.mdx b/docs/api/beta/create-form-definition-dynamic-schema.api.mdx new file mode 100644 index 000000000..15ac20e5a --- /dev/null +++ b/docs/api/beta/create-form-definition-dynamic-schema.api.mdx @@ -0,0 +1,71 @@ +--- +id: create-form-definition-dynamic-schema +sidebar_label: Generate JSON Schema dynamically. +hide_title: true +hide_table_of_contents: true +api: eJztW21v2zgS/iuE7oDbApGdpGn3Nl8Obtw9ZJE2QZxcP6QBSku0xVYSdSTV1Gf4v+/MULTenMSb612KO3eBwKLIeePzDDmkdhlYPjfB8U1wUhqrMvar0pkJbvcCVQjNrVT5aRwcB5EW3Ap8ORYzmUt8MV7kPJPRJEpExoO9QIt/lsLYNypeBMfLIBYm0rLAniAAW5k0zCaCVR1ZwRep4jGzijn5jLMZqGDxWgeLnRJmvJZI5VbkFjXwokhlREYOPxtUswyqfvCr0OiClcJQX2u1nJbWPbXfzVpuob9d69uOn47RE87KXIIjbF7KmMkYjJKzhczn4CO87jgClotvPCtSAeL2q3/hhj/+HwywiwJ7G7A8n8Pzt3CuQgiH2GBRsFqtB6jpZxHZzoBRHQDo2XKv6+24fvJT9vC0sMZ4ZsU32/J21Hz9iFsN1Wim3DAXnehXgZdCf+8QY1B9j64RV9C6ZWxIQNM0Hm0RCFSA6r8KbaD3+zKbgoc9O/7RfL2lQZVIljuZDdMO9ogLHNgVyNy+PqqNhEcxp95NK1vq74dgwaMvfI7tc2mTcjqIVDY0XKaFArlDU4So1gxjlXFJkZE27aO8lXAuXRLBGK3tXxJgAlMckzwQ1KZ9n+jb4aRLmGCUKwi0Hm/C9Xp6O1N3sML4YO6TWoDqGU+NoBZTqNw4Cw9BW2+SL4UtdW58dhSpyADz5rvlRlXaorST9VsexxQgnl40+/WicN4YxxKVxmjib5Pz9x5pc5HjIiJibypP00XQmrCu7j97I4PE2sIcD8n60LUOlJ4PY81ndni4f7gfHhwO175vNpqCvNfN91Ib+54QvKyhho2MWrvMBMdnZZr2RkDbvQNS3ldxxh/QYCzXdgzB8kAlFsbQEFrphlRiJtiTUdeenB4DH1sWmnP43yawwz1oRb1Hm5A/ypnQWml2B2pbewcVRaVGHv0B1Hdda6MiFhYcOlGxaPS9Z5Fa9wTDM2EMxMY0RnGtOeJcWpGZJgLeojPv3ACfrWHi85jrmI0uTitvfUpglWxaQwZBf3LaHqQKCLZhsTqjdq+P4pZb5lpbK5PIw+vJIwtTNQwhTr/OtZzLDZuIs8bbKjkUyhg5BUu+8hQmkakZvLgjo5wsdscNM5DfIkszW1s2fvvr6PrsaivbKosQy7gV6a/d0OqDAcm65CntWdAcbHJTUEW+ZcQV7utw71Gh8rElHLUjtLehELeQMaCf+zG8E9Ng1Rb3zuPMJQtbmg5W6yW6t4g35UzqsRgiDXaB7W7X+6A7vueYGOs4e7ANZ3lpE6Xlv4iXO+bumLtj7vMz9+U2zC0NVBWA00wa3MqaHXl35N2R9/nJe7QNeZEGDApVqBrLfMfYHWN3jH02xh7+siG8SrGM5wtf05o/RNEmUbZhyHbMaHO7eyzs33l9TTS4SLMIX2s6sOog8xQ80zlgaCL0V9hWvN0CGbsEsksgz5tA2rTvuLcmevdmy4965JLilyjefylmf90Xr/nR4SsxfT09OJjG0+n+q5+jeHr0mNvNRPN05ylDvbrn+E161hrHWjdnuzJglxP+f3PCD7GpQDsEoEnaRXB8swyugaAnyMVvdlTaBK/0/T3YMewy0Pnb1S0KxSV6DmCrklU4VfHCq6HL++49z9+raxx3t1Pd9zRudAY0T5AF6IyArPkiwKoHde0FhEOvE03LhE0UXsoBVIlfHP0IhuhEWN9nGmowobtoCytDwvVNkMtUzo5Sp0F9lbQEG3luVwNeyIHLyXaRqztCwxTySs91DzqEJnagNOEUDMgFLTlwyqUZEu4QP+NlihBYQ+xByRgQJMBClZo5MXuYdVx4XTOYWMBm8S+Geg8QBXs9/8Cva52u/n1fnKB7fNkUvge1QX8GlnZcRBduaxQTrpz2Hpbr1QPPkg97ys6x2yF7I7iGNcqqLyJnP/324epF4wqyNLggC4kXt4yzC4AI3hayURQBt6tBkHtsolU5dyX0qHVyTVvfWQoOs4/5RAh2c1oF4T0k0su3kysKKQ7CZrcS3v7kZycWX0WKK8agjiQCT8b5ECI05K1xL/Cyl2VKw9KRu5QCrYOPecjGUgvCPn1l4l1E7zi7KbxfvOHXU434k5cWOmkhSTMvOla40N5EqcSlLYKNAYrgqaFoPVm5kxc25IVzDcAJUWrXBoxEZUf7viHys/ZkO1ryKKW17fiYf0hklLD2MObSGTOJKtOYnbIoUcqIvzGG0EEa3OCXQ+LJZt2h0pAYER7uN0wKncpQhqURZN8ZECN3YOJTVVq38isGKTV2lPxEMwuc/wQLbMw+tXym5hvYSWDPWEXmyTajwhAVhi4HmMp+t/1DYOECCj5QHnAAOKnnnzJBZWgj7zlZG7M6iR/SGFwaIjCVpMDa6B6O6wRX/WL0Anuv+0Aaxo2lZxSDZ1bJwoW4FSy/L+hGsG9vqmCn1Imbs9ePpRv+H81f9HhUb/XP83TxvbP0PZnkx8m7z5TxdpnmfzHTVNt5LJkv629o39YfSf2nvmLrfJgptxa1xcduIA7o0yy/m6R9U+0/ezniGo8qEwF/4S3lHjqBAD31xUZTUJFyS1/FYZaKEgkggQK+ENziXnYPmaIyyixQrWM6g8qXBM3pi2MNU8BTPpUpyBuwq1ozpwTgNsqIU3w2JZX+9MFywvO5GLAPULLmEcAMDwoAbvjuM2CTDJ0A0i4QqGzswQubyCwrYeoWmGfKjHGgyCMIj6WJSpeII5XnwseCvkFk61E+KyF10AU6shBQKZ3P8MhVRqIB5Ed0AY79cTSEHmdxffriHbkUKTEN+7XLkMdkA3vCRKQFHWOAWfgRWK3h3elVTyIIyw34FQn6BLAaZIbYt/5IFga8HBwM9kMqf6Ad60iofRvCtyllO99GV0jHYmQIaHNnG6UrjlyFehN0K9TqFOC+GhWqngRLXBi5XE65EVi0rbAZ2K+xnr+t6zF8Ao2J4DEya11cn7iDt/DKfV/sq+neIRyWiW4EVjqFfbBvswq/OJ/gTEyr7/kz2tcEmt9BI/49Dj7CfwH+rwLOaehE7csgBXKU7rzFyfW7pE2bhOoHurla/Q4JiPVB +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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[]
  • Array [
  • ]
+ +An error with the authorization occurred + +
Schema
    messages object[]
  • Array [
  • ]
+ +An error with the user permissions occurred + +
Schema
    messages object[]
  • Array [
  • ]
+ +An error with the item not found + +
Schema
    messages object[]
  • Array [
  • ]
+ +Too many requests + +
Schema
    messages object[]
  • Array [
  • ]
+ +An internal server error occurred + +
Schema
    messages object[]
  • Array [
  • ]
\ No newline at end of file diff --git a/docs/api/beta/create-form-definition-file-request.api.mdx b/docs/api/beta/create-form-definition-file-request.api.mdx new file mode 100644 index 000000000..b9e0e6184 --- /dev/null +++ b/docs/api/beta/create-form-definition-file-request.api.mdx @@ -0,0 +1,75 @@ +--- +id: create-form-definition-file-request +sidebar_label: Upload new form definition file. +hide_title: true +hide_table_of_contents: true +api: eJztW2FT2zwS/isa34drZ3AcUqAlX24olHt53/bgSLh2Csyg2Eqi1pZ8klzIy+S/365kEdsJkHLM0Llzp9M6srT77GqfldaWbwNDJzronwf7hTYyI4dSZTq43AgSpmPFc8OlCPrBCVU0Y4YpcnU7hi4HbMwFx5tHB/MroqeySBOSURNPCSXYgyR3XcjRQSfYCGTOFLVDEpAYK0YNO6zJOuQpO2X/Lpg20D/3OhHfbSDgB4xraoeOHBHm1EyDJuzDRucLcSEGRnExITpnMR/P8LLZC8QoQMEVA6BGFWwjYDc0y1PU3y3/hCv+8X9AgI6nLKNB/zYwsxzHaasW7tyEExmWxixpnj92/9JhAw+9l8kM5cdSGCYMXmZFaji4zUTopTChxiJYwiJH31hsamaeB2NwPk58rnCiDGcaR9jWFVY0/Ay9qh41U0buwEBvhEMBYjDigqpZ0wuoYz4H25mIZYIKKppL+4YOAM/ohEW5mGwQd/ktZxMcPG9Omm3QuRTaWdLrbuJ/deCnzBRKaIhZwa6X4tZC2Kh6mOZ5ymMbxdE3jSIecm/dlS7ik8e9ue86Eq6tI2Eamb1AOOSaalLkqaQJiKoGZq/bexN234abvWGv29/c6m+/7bzd2nq387Xh7lI8xhpKPFoDkeuHgCgpBIf4I2cfjw4AFTVEM/WDwR34KwhPwFN8zCFTgDcd7NVerVBq8/C3r19+++PdyfBk9/Bff+zuft3Z+fuXfw6/dPJlyiAUS5RGJljDjCadagZNCp54+GUQw+0G+OAJqeBhQnvG5zT+DvEMfSbcTItRJ5ZZpClPc8mFiXQeIhQdwQ+mBE0jCG4T+QgHNYabdFkFuuvMhsup7+rIsgXYluiwJwhTCubtGjDYySuTDZFxXChlQ+6Z6JAwA9bty2Rlfqk67WDRE4BnTGtwlK6MokpRTCrcsMy1l774gMZ8cgM8nbShIqEqIXsnR6W13ouklE1QLi5ZD1uQypi6HFX34kfb7vVZvwlDXGstgJgIzwYLNSuNL4eB4U7dseITLu5T6u6SqUwTTXKpNR8Bkh80hUkkcgw3ri0oJ8smE81SMK6RTA4+HO6dfRyuha1EBAgNuzHLyIbQ6p1BY1PQlGBHhINNbgpKz9dADJGA3KYV2+kRNKhnbT5Rk1IN/dxFdM1GzbX3k48zaIeYMYVuxCoyccJUdXmDpp2tBqzBYiy6SAEuwL46XdXM8T0PLGMdZ1csYcucpYWZSsX/tLxsmdsyt2XuyzP3zTrMLWAvRSBOMw7zD3Hdkrclb0velyfv1jrkRRoQIQ3UDIVoGdsytmXsizF289HlNqczrIqJ5n9CGEtJUqomz/i0p2Vty9qWtT/J2u3HWFsIXeS5VPh4NGMJpzaWW9a2rG1Z+1Ks7e2ucC8sqBkVM//8WP8URatEWYch6zGjzu063gWbvb5qNDhPkxhvK/vGqBGZR+VDeTLAdyGKfFgjMtoE0iaQl00gddo3zLsjujfSvwnyo/x7s8Ubv5qZu3HSfcPG77psh271ttloZ7S5OUpGo+722zgZbT1mdjXRPN14m6G273nV5V+luTeYqpyz9pFbmxP+f3PCL7Kp2L7veflNhbI8tqGHj9zoD7CXjp7zuEbL2pa1LWt/grWIg0E0cTOzB/bOgKP7yMUbs1eYKZ4x03nfnmLpQ22Axl/iebabEDfWEwi2cosRjmQy82rsMTf0OnDavhOzsr8z0PHgyI3ARpWXgIoyZqYSzx5C4LkDhogqKA/L3R2Z0dHyEcfIHbkK0ETcKzgUhUph/NSYXPej6BYQUmHmHZrzjtsVmZmQ13ZmR5AjguZ5JB9AGGbYwVLeKehYAxTHnOZShhXuondMixSn8y5cHpSM7sBgnslCESdmAzMIJMY0nblmgJhDufZXbXt37Gm8JfvArjOVzv97W5yge2xZ5b4HtUF/AkgbJqIJl4uIHGDWd9qX4nKxEuDJid6SsmPs1iPvGVWwSzTyOxPk1e+fh68JhB6eaWUJKTRuiRlQGbpQcgIhInGd2otj4Gk5yB6IU7KYuBdGe7VzGrb4HKdgMLkQA8bI+VHphH9AUjz9MBhal+IgbHar2uUrPzsJ+8FSzP6dhScx8HgiIvBQRGvjXtvTeZlUsAwIlx6gtXMhQnLAFeRb+/YZ+5QmonWUnOfeLlqx66kg/uKlhU5aaKXp1w0UzrXnccpxmYpha44iaKqtt56s3MkLK/LCiYLACVFqEwN6osRRP10T+1l7Mo6aPJvQ6jguxOcpx2PVtWHEJTN/8vqIxFMpNfsbIRg6SINzPNDIngzrGpWGlhFhr1uBFDqVIQ8LzSy+j0AM4YKJjmRh3CouCeTPxFHyys4scP4KFsuEXNVsts3nsCvAnomM9ZMxo8IQFYYuB+gSv9vKYWDhYgg2uPO4NgD2F/NvM0EJtJL3nKyVWd2Kj+wYXBpigGqlwDrnfvQXCa68IvYG9r7rA2kYN4meUQR+k1IWLqo1Z/k1vunBZbyphF1Pw28Orx9rT43+avaixXuLbfuxSGfPnaXvySS/Tt59oYzXZpr/xUxTbs0x3KqlZzXI35f7tSVOnWn75QH8C3ctV+0zM6iSFsdeqoLylBp7Yh5ZHU85OBWK15xRg3u/DYwsmVkmQqWK9Ieqzwqa2G8SFECmUMbzFOR1yHChmVrCuI0lziv+1oUte1FXPKViwjrkM5RrIoZpwSIZpgfvfYO5tEAHMDMnOLHkwE82bLqyrIBd/gx5WWSEQkg9EhEJ13HhElcshWDeF9Ju/e5GeRZjqKEJtlxnUPscjwfu2UVl4h/RBfPuX6CA63EW7548eENOWWojE/vVt+2PyYZoC6cszW0JD7DwE4GFhk9HwyWJIExosCtmHakmUTlIR9gXhGB55MLnTWez0w1tuQDtWHVB3VcR7j5MuPfTm04zHisfOz3LF2nlgoKVQASh6x4SFK4yccXhedAsDmFYf8U3aGV9CBXHFItLGHh7O6KaYcE0x2aoTxXWxZeLWsjWkDANeA1l6RgSA3vA4len5fdNr5e+WFv7u7aVFvunVGJWqZrh0hXZS8bOL2HMlNGEqUotvu9whkP3Pt6LWfVJGpaWbhBWR7mpdF96YFer20+OBxiNo/LLt8zuhSxAK3djcQl+LndOqzYO5QV2ms//AwR45OU= +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 new form definition file.' (create-form-definition-file-request)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Upload new form definition file.

+ + + + + +Parameter `{formDefinitionID}` should match a form definition ID. + +## Request + +

Path Parameters

Body

required
+ +Returns a new form definition file + +
Schema
+ +An error with the request occurred + +
Schema
    messages object[]
  • Array [
  • ]
+ +An error with the authorization occurred + +
Schema
    messages object[]
  • Array [
  • ]
+ +An error with the user permissions occurred + +
Schema
    messages object[]
  • Array [
  • ]
+ +An error with the item not found + +
Schema
    messages object[]
  • Array [
  • ]
+ +An error with payload size too large + +
Schema
    messages object[]
  • Array [
  • ]
+ +An error with unsupported media type + +
Schema
    messages object[]
  • Array [
  • ]
+ +Too many requests + +
Schema
    messages object[]
  • Array [
  • ]
+ +An internal server error occurred + +
Schema
    messages object[]
  • Array [
  • ]
+ +An external service is not available + +
Schema
    messages object[]
  • Array [
  • ]
\ No newline at end of file diff --git a/docs/api/beta/create-form-definition.api.mdx b/docs/api/beta/create-form-definition.api.mdx new file mode 100644 index 000000000..726581bac --- /dev/null +++ b/docs/api/beta/create-form-definition.api.mdx @@ -0,0 +1,127 @@ +--- +id: create-form-definition +sidebar_label: Creates a form definition. +hide_title: true +hide_table_of_contents: true +api: eJztHWtz2zbyr2B4Hy6ZseRHEqf1lxtFVhpdZcmV5Pru7EwKkbDEhiJVgIyj8/i/3y4eJEBRDyf2JNeynUkoElgsFvvCYhe581I6Fd7JldfORJrMyduEz4X3fs9LFozTNEzibuCdeD5nNGX48ZTdhHGIH7w9j7M/MibSN0mw9E7uvIAJn4cL+fHEw7ckFCSdMaIbkgVdRgkNSJoQBZLcAEwS5EBNSwDuJ3HK4hQB08UiCn2Jzv7vAqHfecKfsTnFpwVHZNOQiRUkyjidFr8MamUE7A57HvtM54uIQdezpWlqf5/Tzz0WT9OZd3J0cHAAL8LYvIBf6XKBfUXKw3gKzT83pkkjpnPm4uLd73kIvJ3EgcRidSbeW+e7wd43b2hEomQa+vCWpmSeBOHN0prfEgYFCkbRcuUbNUvkh4sQCI6gQyA9p34KWJMkS/PGMIUwZfMK9IZswZnA7lSBtTBrQjd3kXgWsYHksISvwsqnOYRmPZwVjUzrMVCUfKJRxprXcat/SrY1bsXBdTwYbm034LjccTZHaQDA8GswREkoWEC9rVxT7NjAWahmj4uVzTVDm3LANkjJiuXohSBtyQ2Rn5v2srkLIZKM+2wsp7QqLCAUTHEHThrhJZPfmZ+SCUPOECyCHyxokm5KbsMogveEhdCeAxdwdsM4i32G0q6ZIowXwE3PJkv9hJN6ThJuvgPAOfIQtkiZP4uRHuQjWz6H1e72zy/GLsVGOfpdhHcdd3qds05/bauOgm+ttAQKv3VHd8HNyx0W/VGRsxe8+I7LrdZrda1UK9Ig4Y1cr2JdUZw3obVntVfLrFULjo9LnisKtWS4mL7PFmmTvEtu2SfG9x40qJ7l3nVsjVsakrqLL1/FOXMABpzBQsDYJEyF1gaOsg7YgvJUU3OTElZ4IWWT3dRRO5kD6BCMUKVG6vxCdmje+SOjkSBkPIOJ+3kTYnDQ77TsaRrRGOwm5VOW4nIQhjDCdAmD9ju7DNpP0scYF1RCMXJ7sMvI0CSlYbxpYMEoB4PuDAzrLBgjtzMmNUqYok1RgLCVIXl/MP6wGx5AAYMKapNdunRjP8qAHR6IOggEoMsUuWm8NHIkcRYa6d0wAKQNEsBeZzux13yRLtUYu3VA1lB9Rpe7tB8BP6TiEjQ9Ie0Z8z+KfJUoUXIGf2EbMAvQiMaJ/Ciyif6q6SFQ4NWrpqJwTlakNhWsAT6FAHQ+maXeDUOYUYEk0G2nTp042DIpBi0ef0q7YYeLpBG07FfnF/jR78Af7QE+SWGAh25f/5IPnTP9Sz6MLvUv+dAxv+DBtX6/7GL4ao1Xa7xa49Ua78k1nu222TsgyWHVOxhnjF9NO+nlAiKj8bDb/4lUNxqpKar5yCFwMkgWmsIuW0/XAPnQ647GGyHJDVkZWkwo51TKiiZpLi4V+4kcovTbV1Fbu+Fqrtl65AC1T74byI17tA10QApcx28Gg16n1V/T5k2SRIzGln1T9EWjVRBamjd327bn6Q8avmvJciBbrdk34ImaKXZmClsF5J9zHVARggTdExAwXaim8g7uVrETT8HAs4q9oezg3d/nbKOCH6bVgvof6RTfT0FBZZMmmMp9QcNokYRxui8WDaSM2A+SOdhfZL4wlSM6s/QK8HLZK8I9AtuwmxsYe0OkRzdwYj1uy45sQRY8CTIf6AJLRYsw3WqQTkGs1qxjHQ9SbZARoKPkBLAgsRuaBJ7hjDBcI5rCuOhTpchTKmA5iRL/I3DJu+6p5dV18sHfhQEj5DQUdAK0QEYMAxkKRokYvRtcVnUazZJbQjpxVZ/T7qj1plc5lh5l7XCd/rqeaqh1Qw47v1x0h5Udh+AzhZxdx4PzcXfQb/WqGg0WKpIKE754c9YdfzjrjEatnyoBjrLJPEzPmBDAnXkHsLrdt912C8dY3wssbnijI+3QtTP+cNp527rojT/82updVA/H0lN2Q7MolfJSVhfhNE64EsJFxheJUOKntTuuOep2WEX4Sy8MqvW+ftCEw2CsJg82d2hQvLDniG/L6LtGQY+91STUfPnX4Utb9RagUP+CNrsJp6uKsMUnYcopX5I5XZjtGhptqVqhS6aO0cjEtkUF7Ka3al7KB1rFLHp0wiJ8WebaSk2Pjf4OahY7uUav5fuwDqi2h2yefJIz1CZ8B+iqIUAGCYhxYRh3wP9weHhwfHz04/GLF4fHPxy/RhNqU7ataPmEllURYItt7WiT+vh4OGd1W7Bwz/XMSaCm8ZpzQPNV+WOR9gBiJrR5zf0xsf7kJwyqYeeu3JrF9Q70f42KP8x/W6Lu3VOL4aodDGuaVoCdXMfjzr/GpPR1zD6DFzke/PQTKMHyt2Q6jZjq1xp2WlV9W5xR6YCcdvrl76DmgRDX8fm7QX8F+PksiRkGKVrdXvlbB5gCFSN42e0VjEfy6Ax0fmu8AvQUvCTs15Y6caWjr5Rge9C7OOuPyt/bSZTNY2HZWJw4/FTUwQdNCHhUM4YHOTkZJ4SJSNOJSKNJBvzk77Y2qnpY15TqITYtuYWiq05pYI6Jz23+vC9rHaU09AGkw5F3XqTUondaHPusk2lXBVWY+5q/duEvqdVge1exM7B3f194KvczAFa7OuOrVJx4Mqn0LPR+zZsTqfOcwa/uLHBK5RjnEpTR+6ewACtoCcD5iayNOTvebmtyy6ItjYwbVOtfFVJwbEwRPxAq0wS3dly5ioHa+8nEHuUBYetGGIuUYrQgn+4DLNJFHP6BDltui/Tu0T6SfiLzlK61S0UOlKSQcwCsA0hrmo3McKXw1tdFq7YNZs/NKODIeJLu9PoYy91GYvnqcAsRlataVuOVHoeEB+6k9ankrhIBA8A2RucxEQH6hXLtzT8Lm+AZAFkmmIugkNkjIHJsj7DUbz5XnOrTGPNTFlSgIw4ilRSTxBlnAvgsXs2o2jJPJ43rSWS7tLQ7yHjeTr2rXOQ16W+yR0XeWynX7dWrzVTBIWRWxW3M+Kqor5etAXZwJAq23/1xd/xv4nzuSo2QLu1UHt3Qlab87S5JPNuGqpKk3dSWlUgDnC7J8iR660k4UJIC5woyErypMPoX8r1rKtT48kiJM2Ua8FxQLGGXMkdpw8boEIR+hsKstE0K1oTKw8VEJRvlTCoY/xSqoDNnfsIDbIwHTBnnQOZoqbPSEMf1RmY956k5uJuNy8Hw57e9wSVxG1wm/ONNlNyCuh9cDNud0medVFRwpgGDnrTs4LKo9Xkri34lRl/NwPnyIanN2vz/cLIiyRYVahrdqwxndG1wFbVqVCrt0T3GdkWK9VAnQ987ux2N5TxXzO7SzSsTlXNFrLG21CKu/26Ldn/v0uSGRoLJN2IB7q2SsKODw6r04DTjeBJAYnZbNjreFyd7b2DdaRYGhn+XNrNaAz8635bM9ekWG2xnV67DqrC/u9jb7c5WMc4mj6s6231nP6g2/H8Rw98rGXvXLthMTS7BA8B0YTwwd3wAbKmykFvn3QeYf+nVWzbJ8QUUImG6Ife9dgVqV2BXV2BjrKRXERzJYyJFqVN1PGQDg9YBkTogUgdEHjUgsvlsrbfhJO2Bclofpf1Zjjrqo7T6KK0+SquP0rYfpW0q326XrWhhg7+mOFtm5pd2OXVhdl2YXRdm14XZdWF2XZi9eeS6TLEuU6zLFOvC7Frj1Rqv1ni1xqsLs+sa3Lowuy7MfjBT1IXZdWF2XQD7JyiArQuza778HvmyLsyuC7O/eWG2yuOqSPZQuduBiZZjpk1lcc0tFcQAsVf96ODoRePgdePwaHx0cHL48uTV6+brly9/OP6Pp04WaYqxc+jXSEOZhL4pdK6xQYzlcWJYhfKZ/mJwjih4KxsRz2E9HeYGqSfPGxrqhHWd0f7y4KBCgcSEcQ4ukdxk27eYJ77MM0VK7Jy3vk2VgHaK2knAqqTcza7KW+L6KqVtpbPmrJz7moYCHZyM1vJm1TETMaA8kJm3arYml59o2GpTvlUZgq9Iowp/tCff59eVq/xcot46nMTixsVoWwqd6obZevJpwEPYI6wbVH0lsyQKBAFDIkI0uGrPhi4yWnzJ+gpF5HFzcOpgpi3aTrhpjJB92eeKVFFMYTHEoH6awV4MG5qIjVoCTXkHCWkk1S5UNtqCDY7j5ep9i9TQFKQf2qmH/Vs28UqG4czwGZ50wqY6EyVexZyEKeO20MOr45flU72iL5KIA16AezfYxvVj0/JUSqyS2Yoyk1WZpVk6S3j4X2Xra8mtJbeW3G8uuS92kdxMMI7Bi3kI64/Bilp4a+GthfdbC+/RjxXkTRLYZcdL4yGLB4moLSi7SMhukuHKdjmBznwz49ncoChNfPzMZd1qiTO7mICJiZwjxrGgrbMDZ9QKpFYg31aBuGJfml4u6OV/scv0Ilm58MyZ5o9+cPCC3fxwwI7py6NXbHI8OTycBJPJwavXfjB5uW3atqL58slLDfVqzWY+NFIrlNSqNaudilon/HV1wnfhVCAeDLgJK+2xuOQCBBSTo7DaJ8Pbhq48sTiRcb0T8DJw8u+xzORzA030FJhNK6vGJAmWZhj5jxKuVD7J0KgpOl+5cyHFbBhZvgFoyJKcjYPkx9tqMMRpztJZgvdpAI9KwaI4AW9fVv4Ww6GDpNSQGivjWHM1S9OFONnfvwM8aJzeN+kibIb6EoI4uZVLPQGlsTIvw1HId9hA6gA1QFOiyUN5yiTXRgK3DjBwoQz/bIRsssCXScaJArOHKkXXrsjXMi0tXv5dyNZNXOK9lfnBvC54dP/1c1GA1sylinwbR4P2BDAtTRGn8L5g0RGaATX6CqMWpgHDTkcrgw2w2RF5wygHA5QmH1lMnv3zcvycAINh4hQLdDl9XqxxDiwii4bykyHsJA/qeZJN1Va55QS5pF+LNwBgjeeIMXJlLrLog5YcdkZjSVLshK+VmXv/zKxOwD6xCM1Bs6AkMl4YxPtAoX3q9HsuswbmCcdaYaUvUJyu4wY5DbmqgBOyjZ6iOoK7Wph5UWteX4rE3wy0hoLWkNDE8xIWirRXfiQrqXyw+ggC8yKRWl88uILXsOA1phwYp4FQyziowmqJhxua9M2qfTEeDjyptlw8ruPLWejPiNuNKJVFxCzJooB0iT9LEsH+QQiyDorBFV6lw74YrVsctCElonF0YKHUUEM2wkYmmMSvB4IRK2aiE7wARJr1hIDaDJRI/iZXFmT+N5kM/JszZ/n6CtwEbBkkvvhinHHABg7YUDpAaPyVb4eMhdYR5iD1gGKAdrH+UhNoRC29p2BVanUJfl/2QdPgA6qqDGxxon6cFApOPxH5AVvnbUANo9eYnyHDb6JhoZV1iGWMfpmCq/hiNlBcopvC1/SV53rf23xxxq3Cjx/E0fKxtfQaTfL96N1vpPFqTfNn1DTaV8f98LD4h787xd0BpQyDyivEynXSV+WaY13Mq8tnr9xKWCut2BRcuiWFRbGgqpKxctCLZGPjtdsZpuji5amcV26OpclIs1ONVlJ/VlN3rMyd1cQbuYNxbyO5unvAVXylOz/MvREFitUXOahNjUMy52qALbX9Bml9EdIDMU5L62BQzK/PKcVsvuklNzhVs2POr+B7nFsUi+vUrnJI1sVfD4D0Hu/sAvVvx4Zso/NG759WaHshZKKPkHeuSaY1twoUB3A2oEVEU0kzWWU8kyW+nC1gN417sT3U9MlcWsYFT1AOmC5OmcodN1drNwllsRYZFyNTacDURg/1LP4WmSpmx6uzZjSewjpfMsJiH0Qeo1igLvHb76BbJaIj0JTnqGjJqVG+sAmazzPYbMuly+YEWGGbhg5C4WdKgoEdYmZooapr8l7GqqLqxynIeBrjczG4Gak76ixFvGUs0MPmrARIj6uYhwbNRIYsoiZk4G6jt8EG7d+YsWghY2yAFuY7FSOcdccrEAFYrPRqM+HTfd1J7GNbTOaHySv2edE8bB405PYd3mOsY05jC/jGOEvp/istALiL3gc2UxG3TO3qVfjkylsJn4BwzjDCAt/u7jCDE+MJ9/gaDBNHyXpfhArwF8CcMRqg9OaxnbYK+DaknivMwkrwFyMYqkdLFthvbGsHgc4HsvQFI0Y4m7l0uT1Ob9HAwZ8n3jX8L82W1r936j2q73iaqTifgmsc+Cr/VT/gNO/v/wcRfUQz +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +
  • Array [
    • rules object[]
    + +List of rules. + +
  • Array [
  • ]
    • effects object[]
    + +List of effects. + +
  • Array [
    • config object
    + +Arbitrary map containing a configuration based on the EffectType. + +
  • ]
  • ]
    • formElements object[]
    + +FormElements is a list of nested form elements + +
  • Array [
    • config object
    + +Config object. + +
  • ]
    • formInput object[]
    + +FormInput is a list of form inputs that are required when creating a form-instance object + +
  • Array [
  • ]
    • owner objectrequired
    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 + +
  • Array [
  • ]
+ +Returns a new form definition + +
Schema
    owner object
    usedBy object[]
    + +List of objects using the form definition. Whenever a system uses a form, the API reaches out to the form service to record that the system is currently using it. + +
  • Array [
  • ]
    • formInput object[]
    + +List of form inputs required to create a form-instance object. + +
  • Array [
  • ]
    • formElements object[]
    + +List of nested form elements. + +
  • Array [
    • config object
    + +Config object. + +
  • ]
    • formConditions object[]
    + +Conditional logic that can dynamically modify the form as the recipient is interacting with it. + +
  • Array [
    • rules object[]
    + +List of rules. + +
  • Array [
  • ]
    • effects object[]
    + +List of effects. + +
  • Array [
    • config object
    + +Arbitrary map containing a configuration based on the EffectType. + +
  • ]
  • ]
+ +An error with the request occurred + +
Schema
    messages object[]
  • Array [
  • ]
+ +An error with the authorization occurred + +
Schema
    messages object[]
  • Array [
  • ]
+ +An error with the user permissions occurred + +
Schema
    messages object[]
  • Array [
  • ]
+ +Too many requests + +
Schema
    messages object[]
  • Array [
  • ]
+ +An internal server error occurred + +
Schema
    messages object[]
  • Array [
  • ]
\ No newline at end of file diff --git a/docs/api/beta/create-form-instance.api.mdx b/docs/api/beta/create-form-instance.api.mdx new file mode 100644 index 000000000..97512cad8 --- /dev/null +++ b/docs/api/beta/create-form-instance.api.mdx @@ -0,0 +1,115 @@ +--- +id: create-form-instance +sidebar_label: Creates a form instance. +hide_title: true +hide_table_of_contents: true +api: eJztPWtz2za2fwWj+2GbGVN+JHFSf9gdRWZS3cqSK8n13rUzKURCEhuK1PIRR5vxf7/nAfAtS0mdTbqrdNpSJHBwcHDeOEA+tRI5j1tnN61uGifhUrwOo2XcenvQClcqkokXBj23ddZyIiUThR97QZzIwFGtg1ak/pmqOHkVuuvW2aeWq2In8lbYB3rgW+HFIlkooRuKlVz7oXRFEgoGKKSYAUzh5UCdMEhUkCBAuVr5nkNIHP4eI9RPrdhZqKXEp1WEKCaeivEXw3NfreufPLeOXe8ccZMiDTxATXguDOnNPBUBBuqjXK58Ba2O9B+r4T/mD3RI1itsHSeRF8zh90drHlqBXCoaqHVvWlSRmMBbRqNEBE0bV0zXAjsKFaRL8UH6qboNroejn1/3h9fv7L/b3atJbzgQxVXpGjIg7Oswej/zwzv7o3JSHPM2GA+vRl17c5dxmEa0DDgmskV9PPjIUJBLclo1NmykDIK2kBKNvb7OdIpLgh9a99mqtMLp78pJTKOVdN7LOb6fe8kinbadcHkYS89fhV6QHMYrCxcrPnTDpfQCnKOXEAEakcDFVx9XXtSw/Da9RwZA+YBHt8R8J0cnT62jl9bxyeTk6Oz42dnzF+0Xz569PP3HFpZjuDgyYnquZl7gGUGu4vC63OLcSKzninBGT8SabtYE3skk49BkAe2xxWOLTRUvM5tesEpZN7gufZL+ZVHYoVl9gtSJBC0QvNg4OS1z+MmXU+XHqJZIyoqTAfWBTY4B1Fj6MMYmvikgzkjeo4J0vJUHqiWuU36UfatwgJeoZfyn1GJFCcimR5+18uqd24NJb/J/zS17hH6yLmgf06GsarK3OyiYnYf8N2uIDIUCQ8koklVUcjbBhtjX7fhhQKaY12ImUx9EYib9WFW5f1xqz6s0DUNfgSTMfDlHlvcCF40srOEsl2cRL8LUBxMEJvoDTE1OfVIFIo1VRJICk4bVgG4fPEmKgnCTOBZDuOoJaK/hEOAw8NdliAAHfhtQZPEkialaTpXrwpuqctHT1BTTc6nQrDxrTbekgXXHCc07F78DJEIQgqcSqRiILkgBSV/EpmVxDal7J469eaDc26AzHvfeDOzzh9r0Bu8uR8M3I3s8rjfrBaDL5jByDJbt6tVFbzJpgjZOp0svSRBcd3hx2bcbW3UNUaFVZ9C1+/3GVvjk+2x6tNCZecCrArpo9g1O8JyNjM8GfllMC3C2iumfnXYV9kvI/CaJ36AuJ31i8FXoLETiLcEvBoIBo4lYge/rxsCDiViG4C6DaOSvUZjcNQwRulNx5/m+ALKE6D8kMGPbPhOLJFnFZ4egd5y4Le/g36X8VxiQeuJH0//QBwzj5NBVH5SPRmaegu04RGysJLR87wP8P/GtqQLxU9Y6TC3AMkrai2TpF6Xx+PmL45cnL56fHrF5lqCIwGAmp8/yRYefak4mqaRiJ33SsJnhA8bTjlLJbh4UPPsGh+btY+vobi3QGXHwwp5c5hUYp067aafWydHk+Dn4aGfPn7efPj15+fLkH00I72yOi77DzSczy4LpQ4egJQPL0zYMHlr3bw/KkZDu1uicMwDrTrvVljJ+NUG6L68O6V16E6/CIGaf5OTouMmxSdIoQEsTqLtHDu/qo2lP2/itLqrpzG3NIqo7tCpakTQ42S+aneyMoxGqhdKxxU3SyCCr7OPRfTz6p41HUYCW8qO3hHUGg5EGFDChAHD4pxnEATvGNmqlbW9bdGaJitjdo/bkXEmQavQBVZDLJpkw6L0MPyjKCEnBthZMLXtbMk1gTgmoCN9ft8UEeqL3yT2DUICDB3aFHErtS2Y+KfmjaOpB5sECimscusrWgBqTgjxOmUJACTDnGWZzFWAKjJ1Qnjgo5TD6KmF6F6wz2YiGUPF16btZIMe8AfcU0PYcRhHsuzdbF0J3tPlMw9o3adJz2tQgaDTXkXQSQFiEEBubxsXItKrwjbds+CLHrA3dytovSn01pNxiGDWoc9N1BM36OCvpm9Z5JNkGZ3twLrY17gTgwA1HW9sNo6L3O0CHdTiq+LKD3dzYx8aqFAoWKYemOPVVw3L0vZjElT63NycUYtJFk0ZLQC6LYu4glQ/wdOZkqpAzYuXDD+W2RS/JBEaBggKBlMBQMxUplDGS60Km5QewIfyEk3qCTq3+DgCXyEPYIlHOIkB6iPdq/aSNrv/l1aRMsXGGPqVbbgPQHBfgHG1qZTP8YnIBgcJv3bG84OblLimGx0SuFEjkK4QxLNuOehBL74XF8TvovawXivNDaB0U2vMya9WC45fyf7xkuJiOo1ZJW/wU3kHsEB181qB6lge3QWHcypCyvPj0KsiYAzCIFCwEjA1xT6y1QUkfu2oFkYqm5kP6V9vie7PVsVUdYVQoIw881UaNZP8idmhu/zMFT1qANYOJO1kTYXDQ77TsaRrJACykjOYqIVOkEAZ4/DDowN5l0EGYPMa4oBLykbvDXUaGJgm4JQ8NHCsZgX9QGhjWOVbgti8UaRQwzI4BhK0MyQfDybvd8AAKGFRQm+zSpRc4fgrs8Jmog0AAuorJLYO1kSPCOdZI74YBIG2QAPa62Im9lqtkzWPs1gFZg/uMr3dpP8Y8QHwNml6I7kI57+NslaRgOROUK4D32EgGIX0Eb0x/1fSIUeD5VZspnJEVqS1jZYFPEQM6H8xS74YhzChHEui2Uyc7cLdMSmEO5tGntBt2uEgawYL9sn+BHwObknH4RMJASTv9ix7sC/2LHsbX+hc92OYXPJSt3y+7GL69xttrvL3G22u8r67xim5bMQIiDmuOYEpj/GrakZcLiIwno97gjWhuNOYp8nxoCE6KYVYComw9XQPkXb83njwIiQKyKrRA0G4fElKTNBOXhngig8hb2TXUNgZc7Q2hRwZQ++S7gXwwRnuADkiB2+DVcNi3O4MNbV5lW3nGvjF90WjlhCbzVg7bDlr6g4ZftmQZkK3W7BvwxJ4pdmaKogrIPmc6oKH8DHSPK0JOOGYdyqGiHczBwKuG2JA6fIWcbGmW23b+U11uomYzGPuBTI9uUMr1VFK71ALTtG7q6H32PE1XT9IxxGbNOtH5IG6DjAAdOaVrErwZZOCZSAmFa1RIpAIrccJy6ofOe+CSn3rnBa/Ozgb/yXOVEOdejAleYkTPpf0ilIjxT8Prpk7jRXgnhB009TnvjTuv+o1j6VE2DmcPNvXkoTYNObJ/ueqNGjuOeHftNhhe4k5Dp9/UaLjiTKrZ1n53YY/HnTeNAHl3+0LFMXBn1gGsbu91r9uh3YyNvcDiejO9HYcbypN35/brzlV/8u7XTv+qeTiVnHP5CclLVV3w/jQJ4SqNVmHM4qe1O6456nZYRfifXhhU6wP9oAmHyVhNnqwEwdAgf1GcI76tol82CnrsrSZhz5f/PXxZ2prJ1d89bVnPvHldEXaiqZdEMlqLpVyZcA2NNqlW6JJyAbWYFm1RDrvdqpuXshp2C7PoY41iYUs/49pGTY+N/hJzYWPZ6HUcB9YB1fZI4d4bWRidft4OnRsC5HyHugT+5fHx0enpyY+nT58en748fYEmtLRDzrT8ipaVCbDFttrapH6dXdcMly1YlPf1soJdmcjPrXDFPoUSCImW/oPn6j17k8UHDqRN0YQ3U13dycOtUcy1W3/VQgL8XK6BLSTVy27TDtWwNJ//yGJkLQ0bdmzN18J+bUEnFCZ0wJjfZQWX4GavYEpZG0/5EInPonCZ9bG0UvqscuHXRXd9gwA/Xo2JHqjZiSwQqLCJIm6Dif33iah8naiPEClMhm/e9O3at3A+9xX364zsTlPfDjAIOZnn9qD6HUw5EOI2uPxpOKgBv1yEgcJEVKfXr36zQfDR+EEk1a1hPKbtUbDrnUkNKMgD2kDoZapLSh0dNnTdYf/qYjCufu+GfroM4oIfhROHn0wdfNCEgEeeMTzQ5CgXDBMh9wiRRrcL8KPfXe046WHL7pIe4sFihsJil0zmrlqMDYPeZG6XtY/Ppq91nmuhLXqna6Sj5tLt+WsX/iLLBSahIforRvhfuPP6s1rryN34ow272or0XwG9X7PmgnReafCbTwVwrHJMAHFOVZGPb+VraMWA81fyKEx9wHZ/IrNJxkZFURhtslD0rZp5IhubE1MobpWZH1/GiakFa6qzBJeYMr7A2lTXha3yimwq7WqL3qyh90K6DQNT2ZiX5PYxqxhDCL2ByIrCuWzsbqEixs3xqagJy9SyqgF4HysNerP1bGR9YFtjy0t5rj8kBEsOihpWSIdLvD7C17meOzVt07rpzywLxZkYvim3igtnNCJXdC57TARhCnqFxoRT5FtDEz+E2TcY9j69z3yeNIpwCfhtiVAqsK7GW2ikuwGZeLhh5IHruWlQ/ioWIXpLENbFHoa/nEFF0mH8TQzMKCKvmjKmEmY6vtwJN40RyiUYgiZ1+TExxJBOkgLHYEPj2vESaMqXkKCQlSWTGm3BBsdpZcHWFl0jE5BhaMcPh8BSWxSLYcUH8q2/mug62/nDguvQ8cg1510k8XNFWP79CdhM7e2iSllJ/ClPHm5y/01BcKXeHM9/mIhgjSmM/CBYoXb/0YOqHBtShVid6jUV+V/oL4a/yAQ9UOqfQfp6pf4Gpc845pltnsTGeOWFt1T5hkhwaJ5DpAR6sghjNGwh/dIa2zNH8mae75tqXb0ng2UMuhgav3jJ5wWK39lphP250v250u/2XGnhzVXUcN6v3Olq1DdKDB+Nr2qos5TrGuKU01N4dolMaUE1pDGr6iYalSTVnAxcrq0wmrfNibEgvCMeS71D95B56xFkujbhrQdw9QySas0xc/T+YO3+YG3pYO1X1p8cDukDkM+A3esbP9onZ7e2eMFN6FDEg4jvfNBx2xZQAjPohq5q2p0pUuc8b1mJKytmYB8p7iPFPxQpbgoNUYencYVX8+PfmY9tDohXZVv3RRJFgBfgzrtED07HtDwniWWZbTiVXJdZmYJbHXn/0vsxe8ndS+5ecr+15D7dRXLpFDDwqT7eG++Fdy+8e+H95sJ78mMDecMQgtpgbTzk+LNEtCgou0jIbpJRlu3qwWfzLd/qybmBKQ3huYsuP15zUuHMHh6exwP5YxV9ACVl78AZewWyVyDfVoGUxb4yvUzQq5e5ml5bssQ/Ou7RUzV7eaRO5bOT52p6Oj0+nrrT6dHzF447fbZt2kVF8+WTJw31fEMw7xmpjVlqec32TsVeJ/z36oTvwqlAPBRwE+6kYInPFQgoHmrFmiuI3jGnGq/OKKt3Bl4GTv4tFvt8tNBEz4HZtLKypqG7NsPQfdW1+jMqIq3dfcVFRgmeYaQypRtdG/LgENkmOQ+FGC1VsgjxvjXgUBIriei3KOtumcHQOWIVxCOluJ+QJe8/ARYySO7bcuXVUvhTUBi1ORluQp7DBiT/PECbkIw8OhlA60LASzs/rYx3HoRsbu5Yh2kkGMwBqhN95xC9pqPEwfovMbVu4/Ie1OYH87qK/Ps/PhcGtGEuTeR7cDRoLwDTyhRxCm9z9hyjCeDRa0yamwVMOZ3UBhtisxPxSskIr84K36tA/PC/15MnhRuoeKsnu2DnEliELn7KqvmxEx2uisJ0zmFyp5TgIp8WryvDKtuxUuLGbFIOQEOO7PGESIqd8DWbuLc/ZJdKmqsi2zklkfE8NzgECh3KUr8ntKe3pOspA9YVeM7sNrDEuRdxDSJteZkp8rGJm5WZlyzM60uR+B8DzWJoFkGLn1SwYNLemGIxsPgIAs+yI7W+eHCGZxXgWfMIGMdCqFUceAeU8CinJR2zal+MRwkeKa0yHrfB9cJzFqLcTbDCMtusPeEswjBWfxMCWQfF4IbuDP1itO5wUIskwjo5KqBk8ZCWZ6WxIvz6IBgBM5OcYpEDmfRQzLzAZZH8jVYWZP43qnz4rTRnen0DLgK2xLtRvxhnHBAvQ40s1gGxxp/9OmQstIwwB76ykhigm68/aQKNaEHvMaxGrU7gD6kPmgYHUOWru1Zn/OMsV3D6SdAHbJ21ATWMHmN27gd+Cw0LLWyJWMbgVylYxxdPcAYVujG+pi+V0Hxv88UZd3Iffhj468fW0hs0yfejd7+Rxttrmv9ETaP9dIyFR/nfB2PnVYylm3C9z7gBWctjw0WuhUtMH75/s37mbNfBSyWf9ULMyu3MXzCtrNiM3MhK/ZWuRtJVM6WCD7xTPL92G0s9QdCLGYCienmlPeWaNruKTSk8fI25XIvv/cy3WYqAVr5MKDCiOwAXVErPp9TQ6z4wd7WCDlxFISpepa+OmdPqR8As0pdTj65SwhJHM7IkVcUuPUoU/o5TLpXFarCFDOaqLa7x1mEHBAJzFSAY+O13kCI+XQAycYkiJc6NmIG7u1ymsOxr1Ih4jW0itsmi68VOGusitCBQhhZ8903Wy+hPFHKcAmVNFISgwxlmfT28o7G141ggcSYjDqTHVcwSQGYiI+XrMzIHlYBpG2yQc2uh/BVlUgAtrGrJR7joTWoQAVjAlzq1w2h+qDvFh9gWS79h8sw+T9vH7SOLAjV4jzEthN8F4A9E0yU+zIwuRkuHwGScVUk5euMg+aZVCZJBXhYYRcOXT5/wbDVGjff4GtRPhJmCt3lAiL8A4kJJV0WF+L3LKT2LSjLzgL2W3sM4lXt06OrLB9sWA/3LIV1KM9V/OdaSHKtWJO/gJf73rHUL/7Tw9snsCBS9x/NuwTzlTA7DNW5ak5eiH3Ca9/f/DxS1nk0= +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 objectrequired
    formInput object
    + +FormInput is an object of form input labels to value + +
    recipients object[]required
    + +Recipients is required + +
  • Array [
  • ]
+ +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 + +
  • Array [
    • rules object[]
    + +List of rules. + +
  • Array [
  • ]
    • effects object[]
    + +List of effects. + +
  • Array [
    • config object
    + +Arbitrary map containing a configuration based on the EffectType. + +
  • ]
  • ]
    • 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 + +
  • Array [
    • config object
    + +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 + +
  • Array [
    • messages object[]
    + +Messages is a list of web.ErrorMessage items + +
  • Array [
  • ]
  • ]
    • 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 + +
  • Array [
  • ]
+ +An error with the request occurred + +
Schema
    messages object[]
  • Array [
  • ]
+ +An error with the authorization occurred + +
Schema
    messages object[]
  • Array [
  • ]
+ +An error with the user permissions occurred + +
Schema
    messages object[]
  • Array [
  • ]
+ +Too many requests + +
Schema
    messages object[]
  • Array [
  • ]
+ +An internal server error occurred + +
Schema
    messages object[]
  • Array [
  • ]
\ No newline at end of file diff --git a/docs/api/beta/create-identity-attribute.api.mdx b/docs/api/beta/create-identity-attribute.api.mdx new file mode 100644 index 000000000..9fdc7dcdc --- /dev/null +++ b/docs/api/beta/create-identity-attribute.api.mdx @@ -0,0 +1,103 @@ +--- +id: create-identity-attribute +sidebar_label: Create Identity Attribute +hide_title: true +hide_table_of_contents: true +api: eJztXFtv2zgW/iuE96HTInYuTZtNXhZumi4yyEy7uaAPaYChJdrmjExpSCqpN8h/3+8cUrJku43bKXZmCqFAYUvk4bmf79Bk7nt5oaz0Ojenae+ol1glvTpNlfHaz4feWz0qvept9bycuN7Rda96J+qXrnez1UuVS6wuiBDIXE61E4GWE1IYdSd0NU9W8wag6lRSWjwF5fvelVP2ODdeffTD0k9pNZ2ao2pmv7D5WGeqX1M4Ckv0bh7AgVW/l8r5V3kKavf8VVsFobwt1VYvIcLG0ytZFJlOWOjtXx0xfN9zyVTNJH3y80JBhHz0q0o8WMSqUJHXkBNvjZypxigHTsyktyq/El4lU4NlMkFzRD4WHk9X1YDJ6qOcFRnRK3XaewA17YpMzn/eeLFR6bRRzvXHViuTZvMvWbQy6c/5nSAbsIzgwnlpUmnTBgujPM+UNCs8XEzzOyd0WK5eRcALnlRUnojcilSNZZl5nh8+HY1l5lSDHTIXFg8LbqRojNhQ0kgF5GdYW3+pYKvUSUIm1b+VWQlv+4xg/J3UqqRNpnKUqW+zfoPe42p1c+fVbOOFPQUyW5HnPVnHgp9KL9IckW5yL6byFh4gXF7aBB9MStPpBQJwrCelJUYHG+mJSXDUtVk7086TweMAMYZjSbPgaCuw7QqV6DHiVkAU1h/bqHIVW2asvlRZfcuWixqR1so5vmoI7B7PCF/nqIH3lnMSQ+Sa68gvFl8lG1XdmNagimxXR8KRKbOs0mvILb0TDMvnCpMeHijqtGdeLgJ7rWerVeGB31vlity4wO7ezu6qwS7X++6drIpEKlyZwJRuDA5J91227rJ1l627bN1l62+drfd3dlZtdJwhD3lxYi2M0xfnypfWICtHT47QWoyArckI2sA2Oh18u0SdKi91dpynGxjnDXJnf2KlJg4Vs5xgIqn0VqeYIWa5VSKQrCzI4wYtC0ITg13xSqaQN8h3HIUhNVqZ/AZap+njDF0ZjfmimoKoYyf/xLLqQMnRy53Dvf3xy30p9/65v3vwYnQ4ls+f7xy+ODzkfIfiICctl6r8vL30v5VBQCQiy1G69H+hENRT6J4Z4MU3Dw2msWFwhLG1mJFfQa3bFvLJq+N3Yv9AZNJMSn4uJ0tKMP2rCzwhHw+5NWa8QPit1RNt1rGiTDmjxvD1yZvh1dklnpyf/Ofq5AKfiNZKJzo08NaU3BKswheq5BIFIAjiVAZ1qHQgnkWqzyCQNK45UIdvIbFWhREz4uprZjRJi7HNZ61QSkKfK37QAzXYEiN6NpM+mYqRdJgAE9LwZ0PAosL3z6Imn4mpksiBTwdimKaahARk4UyJ0ibnICRkmlLoBgLjEqEMZrSf5qWn1K4T1bbFQpVtayxyyVnTKBQc4PxxPxkmvgRzLGYzCmtviSxG+4DnoLk2d5cNpbFK58bLxBNUA25KcmuhYSAqL7R3IqajUGhn0lTj6ozVTJGc7n4KzLz2Ob9LZOk2iLt3GdJPn0WrX9yqGHxwgzxmI7ZGZaaYkfDST0OsVKNqc1WBL1AJs7SL3S52u9jdMHaXX57HtjS+Zeizpje9MrKEfi0XzxXoY1UAxKIaxPAmGnKLeqQIkX58f4nA/k0ZGq8+FrT1+A3xUSjlK8wPa3uE5yOCH7WxWrYgBlmPQYIxMpFKj5jvBcesqKCq56urvcntSMNBzRqIiKxpxTwvhbQE1o0hTqTb4lbDPKk6DW7yQwakVU3aL3JtfIckOyTZVaOuGn0/1ahDkl3sdrH794zdzyLJmiuOloiTXDmbSTsPnhbfk7RSYICofiARdcixqZbRChETNcbqtZFDb7S3O9odHyRqP5X76cvnh+O95OWefHGwe7A72t876DVr/fUijusga8dUw97BjmFzUtlb4LjSwLmcz/O0vf0H9Vo1prRGqafGzdA5VHqzwI77q9jx59xDNhAGdrSf2F68Oj8j+liayZPewmYpBS2rbmn3Wn3UznfQsYOOXfnpys93U3466NjFbhe7f8/Y/SLouP8YdNz/Aui4LwhijQli/ZnQMQXuIGg2hlEgQ1JCvYZgYwFR8CnuPsaw99JOlK+BXgtF7h2uOUiU5+InaeYVWHKtnUizUBelN4yd0VhbjcUAKSZIkUYga2mgW/IqPVOESeE/ItMzzXFMAoGunfeHYw+pQsxU/lavok2SlWk8spDltPeaw8c03EmNCf6BAu+DTpCov+EeZ7TWH9oPFuck8RlJLE4+JkpRzNf7vy/WnRI4BfOW0sVFsPUnjguEPXNp0Eaoj0VIXzUE7aB6B9W7ct+V+++j3HdQvYvdLnb/nrH7BVA9oqFPQ3UM2BiqY+xgR9RY6k08Yf3/RewcKpEDdm+RJ4zV0wUGZ1wBVyKGipw3WgtJ17J62/WVLLm4BEZHpQkWBo5Km2Hg1PvCHW1v38NQMNDDQBZ6UE02+d0gyWfbI2hnTeIJR5nJaWiAGL47jT3GgFVrNXlvSHVMPCg6nlLuOSicjxZ8lnJ17H6O9kMEMlt08Dd6Ej8GiwXaiCeORw/Yc1bkg1xXNnv447IEQp+QZZ36PrsaxgtwuiQiiXCzuHt3QZg7rL5yA29RR2i3f29lsbc0bE+8UtKiIQgHYH748f3lUzEhpMmRTpcdJkJpag0QK+/gIpzJhtVhEJrExcXm5WTKjA9bx20ocsQ4g8Dig7lQSlw3L0GcIyezSmmS4jRAs25+qKyTqluVUfUbLDRJjqdTsw0NbcvWvKdc6bgl0AYfZ/x08MH0xWtNCUhTxaYxUUTu8MR1UcklG3J9LRP/qKj1A7U+U3NPl7gIqr1OwvHtBOFLJGTmWFtfvXig12/Qo/4JT4jqMg+kichH+5BUUlntq/lo0esTvTYfH8z7qUYZbU8TIWsJhyqYpeJUJNM8d+pfQpDrUBhcT0pE0VezdUeL9jki+ns7DZb6Ycm+7gMUMn9nCAwTnEmOqCgzJsnD9giH5C9sWcT8L3z94peWzPz4GrWTRqZ54r6aZ1qwTwv2Qw5wkf9QmsixENskA+eB4ADHC/tzJoiMNvJeoLU2qzP5bZ5DpSEBq0zFFUfhy9EiwcVPgl/Q6HoM0jBh6vrYGL6LSIvqU0tZ1W7AsgZX+c1ylMUlvQV+6980qVT+1eQliYeLTZO3Jpt/6yz9iUzy18m7f1LG6zLN95hpIsqlzcfzxV8POFncxgr3R/me59I1z/XXMJu3MGNbtdQ2xZuM8RZd83JhGF/d+KsGVLfqrusY54tny/385tfGbiAwxRfreemuGMnyKgLU1V1L2lafKvyPt5ycuINAf8YdJ8O2JiHoylMYcxpLplrxfkehpCd5tyiU8hmnHohC+Q5dLROa8JVgCxtJdKg6Az3eka9WlpwhApImR6bvroznQ3LEIPpnNRDv0YKaBGqg9pNOJuPdr3nsQy/giu/Ik8XryruBMmez0tBtSbBdzoREDD0SAnCJpAyZGt2oUZUucsa69awqbVFskQgDbsTszL0d01Y6uvSGpz+yFhzdxX10qL7hpAtBzlXGoUjj2n3KY7QRXv2pygpqgFFmgDibYfDT6eUKRRAz8ceb3E624yS3TWNBhPrB4D7PB7uDnT73R3RrEv0kWvYG8WO2eu1Bovm3R1qOeL/4DWHzvzMSY4cam+2C9uKIiTI0WqGppb81strUok2aUuuL1/f3tFtDXd4DPUa6oK2A65tFA0ffQDbs2nDI/qZotyD+TNC/nHO1j9sCq79/UF8ZZoSdoM+OvWl05+/e0p5YbxT/9MksbDRYeYeH9P9R7wP+4UteBL/AIH5+36u27TAm0K1g1TpUET+QmA8P/wM9mKMD +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 Identity Attribute' (create-identity-attribute)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create Identity Attribute

+ + + + + +This creates a new identity attribute. + +## Request + +

Body

required
    sources object[]
    + +List of sources for an attribute, this specifies how the value of the rule is derived + +
  • Array [
  • ]
+ +The identity attribute was created successfully + +
Schema
    sources object[]
    + +List of sources for an attribute, this specifies how the value of the rule is derived + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/create-identity-profile.api.mdx b/docs/api/beta/create-identity-profile.api.mdx new file mode 100644 index 000000000..317b15f71 --- /dev/null +++ b/docs/api/beta/create-identity-profile.api.mdx @@ -0,0 +1,116 @@ +--- +id: create-identity-profile +sidebar_label: Create an Identity Profile +hide_title: true +hide_table_of_contents: true +api: eJztXG1z2zYS/isY3oc2GVPWi+W3LzeK7fTcSWKfbE/mzvFcIRKSkJCASpBxVI//++0uQIoUKdtxc9c2w+lMapPAYl+f3QUB33l6IRKeSq1OQ+/QCxLBU3EaCpXKdHme6KmMhLflhcIEiVzgOBh1OZeG2aGGccXy8cxN+KBGLNWfhGK3Mp2zs/FP/xkdvz19x3iWznWCI4FAIn7NZCJCGMoCHkUsRbKj81N6QNSbiHeAnZTPjHd47a2/M97Nlod0hUlf6XDpHd55+TLeYZpkYssLtEphFr7ii0UkA5J++6NB0e48E8xFzOltFJ1NYZU7L10uBIitJx9FkHpbJZLXnuKxwFUXCWoylcADzJUh/lvV2sXSpCL2Z0KhxkHuTEnglJ0eMz0F4QU7yxdwC5o0kWoGv4svPF5E+EiGvf5gZ0hM8PBMRUsr1/2W5aS26jt4+hX0OY73gJo1QIMYR/gCfmQhGugxylOdxByU7eFoP5WxqLFeXr7f7Q/8bs/vDi77vcPe7mG/39kZ9P+NHMU6lFPZxNIbblJmXwd/BG/AHHghDXrFjTjScazVcaqB64edJ48HYPqzuNBZEjT4UkXWu5oUKosiPsHFLcProSpY6Umuk6agWkn6dsmCzKQ6ZtOIpwwHsIXDApBV34IHl1gpRKsvTUMfWnSd+6rodoG6zEJlMcX/8cm7y9PLf6HS1haHGfm6lj9Eldu5DOYWZxIxFYlQAWAMogCsV9ZAQRjEtbG8zkJ1uVUMP2OxfnDQ2+/uD4Zh76DH93e7vWHY398ZDic7k/6gz71ScD/Mxj+ymCsfXRh1ykJpFhFfMlXCgGfw915GkeQxg/8jSN6jvy8SSUBe4kkCrs7AMUqBBY92dxodI5/PYOwmlC846HVhxaZYafDBr3Ogi7Or8dHJN3cfR7Z1HqA6ZqMATcaOAfWCVCdLAsy6S1QMzAxZmNyDVqk7CGnXPhyLaSLMfFxAayHrROtIcEXCTnkWgVdOeWTqOAnow+SUcZbTRLmQKJYqSohQhB0GbiGxVFkyUOEMnB2y+O0c6hzOgjlXM9CQIkU57ufcsImA9zEPRVktLmXnax3pzFYktVCqqwk8d2Ix1c0GjcOagNMTEWk1Q+tsQttyYA76ZYb2S9yMUpBukqWQyNRUzh6PMqHQYzapveLq1o9cMmFg3BicBrwRtZyTWdNTyXRObTxn8DLhyqBQpWD3eJLwJRCRUG2Zx5mvSf3uSdFSrqsKlykYq4QA1JMyQndNc3aPxVQqmWf0uo2N4GYBUrBihitrVvO2nol89cXSEtYV65WWqtYGPAjQWQtteWV7NKp7PcXzMCS6PDovcdxUvIySiQSOkiX7JJb+Zx5BjC64TAz6ONQnCTYISxaLFDAr5Q4scpgqs3234tGa1xM+WWXLs6Hqnr5dusySP6euyGHs3h7f7++K3f1uD34KupPuIOQ9PhzYlJiXgJcNVi6/P113uGJClU5tnAvHUqSefAkEKWssFjpJxzkSP8UMa+7CzaexMBBlp40Zq0COLJNhoxvJsHAioAXoicSaUtXu3sEwCLsHfVDjwTAcTvfCveFgEE5RsoQE2RSClRKVK5XxiNkZzVBZilE3rEnBG7UIYwHBL6ExwLI+REPU4/VUhdh1EAgLZp0U1nRlvjkXUOnACJeiVhBReGtjg7sxe611JYSI9/c3dany5v2enArWXmhlrLFB882445q+Gkte2za3bXPbNrdtc9s2t21z2za3bXPbNrdtc9s2t21z2za3bfP33DbvdLsNrRxka5WykyQBVnw2FmmWKEhpMlcZfX9mEx3Sd26pQDoZdr6miX4YpEKIXBkd6fAJUPVaKuHPEi6RQ0EsBzARc8lnGWIKiREQLMnc6jSuCmCgiU6PveIhGzv5jpwwFqGDT0CrOQiqDF3Z9j2fggGQm7RhWbEn+GQXvH5nurvDOZRovb3h5GDKB4PuwfDggDpcYQyfiaZkVl36J9xDkAGLNFQj8jdQCJRtoHtigBZ/ev4jGk9MFXZsIabjl6XiS7oFNdCro3O2s8ciqIQyes5na0pQ/tVFDYtAckv4DIoq2djk5vX68cnr0dWbS3gyPvnn1ckF/IS0avX7SIG3UlxqKpXm+pY4dgLcQl1mRATqwKrupaP6EgQCJC4PlPY3Q1s3zAUhzHCrN8wok2bTBHrocihR3HxJ2Y+yIzpbULHhxgVPoZSeIMLk5ePLUYCQ5L9xmnzJ5lCWi+RFh42K7GmxxsD8JRBikFYxdC2BaQahLOjUis5SpnQqg7Umf6XK9cyQI8mbslEwOIDzx/0Eqn2EZRKzHIWFtzgWnX2AZ6u5KneXJaWRSpcq5dBH2Oo70An2EgxwlMnUMAdHaC4DwKPycQVilWGf4O6tZYY2aXC3i2fmCXF3HgH8+CRa8eKzcMFHVYlFI7JGbiaHSK4sp8luVGGuPPDZVIoobGO3jd02dp8Yu+svx+77gHtLpU/DR4Ir5bYbMHnWSp+EvEfpfE/iN9t+WUNuYdvqSqSf31+6A4LYv35Z4O7DN6yPbCqvMT8q7GGfT7D8KIxVsQUySHq0EkwBiUR4SHyvOCZFWVUN6qu91tCGgYOqhhIRUDNhS50xDipLMqWQE262WKiFUT+kbM4BH6FnBH4tAlKfH/oLLVXaVpJtJdlmozYbfT/ZqK0k29htY/evGbsPVpIFVxQtrk4yWRzzZGk9zb1HaTmDASw/qbLajiZTrVcrSIwVNZZXrRy8Sb836U33ArET8p1wd3Aw7Qe7fT7c6+31Jjv9Pa+c669XcVwEWTWmSva2dnSfG5LPUMdlCpzLpFqH1e0/UG8ipghrCD1F3Qw6B5XeFLVj/6DhY4bW7C3u0bsKyVRqSLXSEWIajI1xbJKPlfhhbQa4qNiCtlHJlWQsgAoeoWGRjCUFL0oBdJOlP5qmIIoNlNzJilWkCqIMOCQkyD+W3XKJ386mWPMBBapgZ4DO37A6dSb6XZU8G6PEb1BihjvW+EWSFZX7sGl/9xSYTxAjLqyBN2z02m6HK3AAaAgsZhV1Z1uft/V5m+PbHP995Pi2Pm9jt43dv2bsfkV97qqhzfU5DHhyfQ5jO11W1FKvuT3X8P8t0ylUHAfk3kwHQZbQdnNeg4MSjICHdCwTFrmCuv7IuvIIinaMTBmqw/zwiO9OYR2CKbA4vcFTBLEAX0SJFtoQCnGc6G2vT8JDfrZtsAJlSQTD5mm6MIfb23dgZ7DvfYcvZCefqvRtJ9Dx9gSU24BbeMDAxigOoOvzdoEOWSaR6PwWKYm4tZM7FeEZsBftKT9IOT8QstQZYCOR2cLzT84R6TGwuIAu5AdDozvkeDX5QK6rJLr//bJYQhtkaVLfg6vBeAacrono2QMiuW9cYMluV695yCoNYZvXry12hsP67JXgCfQT9svHjz+/v3zBStcaDNbIQmJnAaF2Di5CQDjKvwLgJMpNic5mc2J8VPnOgoHHphEIzD6oCyHYdX6o5R1kiDFAOqkUJwlCEZx182NunVB8FhEmz85Kk+h44PzboKFtXpn3ghIldRRSFUftOh+U706sSkz4OMaJSA0iu17kcvGSXM9l4m85Nd9S84maebHGhVXtdWDP7QQQ/UiCR4a09ezFLT2/RA/bL3iCVNd5QE04Pqpfx4Lcas/mo0LPR3pVPj6o93TsuDqNWcxiBpJoFLJTFsy1NuLvjKHrYBhczzKIomezRWedfYoIv98tseTbJX3pQ01J/L2BwFDWmfgEczqVNBqqPRXakPyFLAsx/wt03CH7pSIzPb6G1IsjQx2YZ/OMC/q4oG8xwDj+bWZDx8JDfSAD4YB1gKOV/QkJHKMl3LO0GlGdyG/THEwNAbBKVMzi0P5yuAI49xOjFzi6GAMw7NEZU/e9EP+aiqN1v7oDYJWVbyasa7DOb6Qhq67pzfJbbGZhpv2zyYsSj1Z7Lngr6Vuj9AYk+fPg7h+EeC3SfI9I44pk3Lscr/620snqkLi9KOMuQa5H1UO34uqX4oobZPYO0OP3dPJrOrXrVuXLVr3uYxeh3NWjr1618Z7OAzdsbBO6doFl/8FLJMU1EXcPoOkWx/XGCxnuGsXGWxT5ds76/YT16wn/64sAN089n185cf/44fjq2fj6AfjGw+r5PSMAWFpz7Yw4wvor16HUd73xs8xcwL/wlrITdaDQ39u/hlY+u46EFhAVdHUE81gwl4L2yxaCp2j2LcRSHVPugajBhCeMJTSjq8YJBCmP+ERGQI++6OQrc0oRtpVCJMPfTVZcRbM3rzrsvWCgWzAWbl/gmSR491G7fYwLsPE5Qhk7zuGN4T3dTLlLiFnMIKgfw8BQGsAAUkaglRK5LjQ1O8WsPG8huKIIdKRfgIOfTfFTjEQP8J64FiCdcd9hQPUllFoJMhYRYTGOqzaqj9EGfPXnIlqg90CdAS1HGQffnl7WKAIxZSOio5PZtptktnEsEMENAes+g06v0/WpQUYI0yaNuSoRP9r4h/HWPfFu9RHqT/AX+yzMYMu8vcBNYpQusy283Sy59uqbJdB+z3FDBV7e3eEmIu4e3ONjSEO4Q3V9s9oYwN8wmmkzkSDxk8BNLPf1ysfLqavdqvpnOdyvsDPsBuWDY8t7PudnuFXrTdwfHIzt/lfCbxF84N9D7wP8h8luYd0NBtHzOy/fTYYxH4tLwnxDtep+QDHv7/8LImiAxg== +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 objectnullable
    + +The owner of the Identity Profile. + +
    authoritativeSource objectrequired
    + +The authoritative source for this Identity Profile. + +
    identityAttributeConfig object
    attributeTransforms object[]
  • Array [
    • transformDefinition object
    + +The seaspray transformation definition + +
    attributes objectnullable
    + +Arbitrary key-value pairs to store any metadata for the object + +
  • ]
    • identityExceptionReportReference objectnullable
+ +The created Identity Profile + +
Schema
    owner objectnullable
    + +The owner of the Identity Profile. + +
    authoritativeSource objectrequired
    + +The authoritative source for this Identity Profile. + +
    identityAttributeConfig object
    attributeTransforms object[]
  • Array [
    • transformDefinition object
    + +The seaspray transformation definition + +
    attributes objectnullable
    + +Arbitrary key-value pairs to store any metadata for the object + +
  • ]
    • identityExceptionReportReference objectnullable
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/create-non-employee-record.api.mdx b/docs/api/beta/create-non-employee-record.api.mdx new file mode 100644 index 000000000..57ab556dc --- /dev/null +++ b/docs/api/beta/create-non-employee-record.api.mdx @@ -0,0 +1,97 @@ +--- +id: create-non-employee-record +sidebar_label: Create Non-Employee Record +hide_title: true +hide_table_of_contents: true +api: eJztW21v2zgS/iuE7kNfYDm28+4vd26THrJI21xeEOCSAKUl2mZXIrWklNQb5L/fzJCSJdt5aTZ33e15uwhsiRw+M5x5OEOTt4HOhOG51OogDvpBZATPxSet9tMs0VMhjkWkTRy0Aiuiwsh8GvQvboMzK8x7rXLxLR8U+QSeBTJWfSWStJ9yxcciuLq7agU5H1t8CQLDUiI7lCMRTaNEsI/UNBUqD6BxLGxkZIZYAMnpRFpmxG+FsDm7kUnCHDbGmQJpopRmCGD7Uh3X22JHaQTLJ4KNdJLoG6nGrNSB2QjU7l+qVw61NX0n/BUo6sd8p2PQ9XYOVUMRN7TDBa8rtEPo2vaSAATYNTeFaAURWgx0Bak8yxIZUbe1rxZF3wY2moiU46d8mgkYTA+/iigHQZnBWcqlsNQ3inSh8k88FbXGNjegYjBvRm8VETMZw9iovO/PFAhAmOIbB41QBppO8rRtUwmTetcKRtLYJw5Ut8wry6jnkiHO3RAoPOHPlI0dl4g+KVGDFWXy3VKp1wP2+Id/3o40wc8mWn0/durVHGWz+g/FuvAxjws+Bdcup/Jgj+kRRMY1T2RtpnMNLm+uoZ2FSIB4qkcOgPFjNeF85QAw1gLBWF2YSCAzfKeariMgacruRbvdnc7O5tZOtNnbjbY6XfgU8a3RbifqrnfXccyY50uDgMexxMF4ctQIhyauu3lggxxeDAsgjmGih2tDPgZCMHMs0mLdDuNlS8ukJeZI+TeZFimz8nfBbJFl2kAktckyOTf5HlDGMtPAACmHOEddRJhL8PGH7MUcDORBRnIZ9puzXKfXCTvrYW/jtNPp0/9hZxP+ksOr+L8ABaQuB9IlIJsLQO7qlHfR4Kk6ldQiv4zVMppm7l/zvbqxZ7ri6iJzgtRYrmbkfXfnENlMK+t8pQcwFzj9PVF/vHRZCV6MteXSIKqm5+zsYO/hmfGrjXT+97KLwIrqV1T/f0L1P4i9u7thZyfsrZ92d/qbvf7mbru71fv3DyDvzn04Uh3LkRQP09T9QM4nQtGiWeXs3IdvKfjpJnHJ+Isi8SIfwrDR6a9vtre3EcPdPasLFUNuYdlYupYkEq2/bww4XsiORV4Yhbw7aiDCCgGTDKkojF9wmYlFDtz2XsdP4KsPUolwbLhEhIIgR9CRgcRrGWPBlGqooZxIZB1Ugdo1zQiWaHfZOx6zsgZ775VBMxoe/QqynsIsZ0pCf1Z2AU6hAL5nWLEt+HCrs9vbGG1tcN7b2ehubw53R3x9vbO7ubtLTi2sBd6rswc3hk8Xhv6nUMLIiCU6ghn5HQwCDgO2JwA0OHSRuUjt43NAMp5gf6R117ZS0+NlWFm3gLnevT9iG9sQR2pc0HM+njOCCs9O4IkqkoQP8RHWmrjkkuDPRo6lWgZFqCLFLG1v/8Pg7PAUnhzv/+ts/wQ+oayFenygwFtjdEuACr4w0TeE2CuAMWZFAuaAIGNvvdS3oBBXtt7Qp9Z2CvlICr414kWSQw8/+pIeddFsZHTaCKXIbUOw17It2i02xGfAENGEDbmFDtpxwdtBFIksDw+9Jd+yieCxMG/abFCtNrioglDoPwVBDJYhDF0nYFRAKAMYSA90ATmJzmU0x64zUzZnY8Ylh/VJweAA5I/7ySDKCwBHatajsPIWD9HPD2B2lmuiO51jRDtVOY9AC54kUzCjgQQTmAl0k7llno5wuiwQjyrbVYxVp0iiu48OzF6u6V3EC/uEuDtKgH5CUq16cS188FlMaxwb0WyU0+QZCV6i2tTZt6qmqwx8yE5FEq9idxW7q9h9YuzOvzz2FbR/S6lPdzH1OVO8APsaWjwXUh9D3qM0Kxu5LVM3kS0GBvEp0i/npxDYv0IKB+3Ftwx3E14wP3JL+QL4QTUf7vkQ049qshpzgQDJjk6DETCRiPuEe4aYDOVMtb442gdthhIcVC1JEYE1DZvqgnEwmSmUQiTcthjUaVa9ytmEX1M1CHgdA+KoKg4zLVW+yiRXmeRqNVqtRj/ParTKJFexu4rdv2bsPphJVqgoWnyeZIs05WbqPM2/d/vd0ICVv+WwKuRoquazFRTGqhwraGYOwbDXHXZH25HYiPlGvLW+O+pFWz2+ud3d7g43ettBfa2/mMVxFWTNmKrNt5tHMjHtxRtWKHAum2sdN7f/wLxGjJDWkHqqvBlsDia9qnLH3u5i7niqNZ6bmJYZkm3kkGpmI+Q0aJtiW1O2hQacjYEXFQOqkoALXUmmAqQYPF2RyFRS8KIWINdMw8EoB1VcoJROVo0iVZQUgJCYINGYNWtwLAlKihHmfCCBMtgxsPMLZqd+iv5QJs+OUeND1Jjtf4uEwECvMvfNZfu7BwDeIEecuAm+Z6PXVTtcgQNAQeA4q8o7V/n5Kj9frfGrNf7nWONX+fkqdlex+9eM3e/Iz302dH9+Dg2enJ9D23aHVbnUB3Su/3maTqHiEZB7Mx1FhaHt5jIHp7wCXAkBZdoSiXA87xys1c+UhO5slg3wmDTmhQ5SYRJoOcnzzPbX1m5hpmCG7to8k+3y3I7SN3jIaG0I5lnCPLI6iogN2ODowFcWbbKtkei+jutIuLM0aYOOChanXeEHJePpKpzCqS6A3UhMi4Gre1eixwAxgzrilS3Pi4FlFvQDvc5McvfHdXGC7tFlmfkeHA3aM0A6pyKqcDU71X6CSbcbfeFs+2whwUKttzDYZ2zWY+8EN1ARuN8uXv9yfvqGjTHVpFAvLGa5QmJtAMFyBC5CVDYo9/GxE60uRhfjCQEfNH4pwdBhowQUZpfqRAh2ceCN8Ak4/hhImUyKnQTxAPa6el3OTiyuRYLLX3tmSXQ8Gas1sNAab/R7Q0sd1QRSuSM38LR9qUK2J5GBJC7Z2MarSCUeu8hKvXhNr+eC+FspLXTSQpJm38yhcKa9iNzJmwjiF0XwxJK1nj24kxfW5GEBBU9Q6jwGtITH0fx9Kypn7dk4GvJClNfEcanOJxLW0WY35miLWVgGk5gdsGiitRV/ZwxdB8PgYlxAFD0b1g0OGlJEhL1ODVLohgxlCFkh4TuEwFDOmfgQV2VKSjTkayp2IfmFZhZi/gvUzDH70tCZHl/A4oktYx3ZZ2PGAUMcMHQcYD1+tzahY+EBM9CBeMA5wPvZ/BMTeKA13nOylrI6iV+jPrg04KUTkmKzvvvSnxGc/+SupmDrqg3QMCbV1S9+8J15WbhANYxVbgfMW3ARb6JhXZyzm8NbbUfhWvln0xc1Hsx2TT6rZPrSLH0Pk/x5ePcHMd6KaX5GpvFpLu4+1i5P7JcFydx1s7krYo1rA9WB//p5f39Uvzqp/8BB++qcff2YfO2U/Oy4ev20+uMHzatz5s2D3w9cqakdyn7ovksrwCClyfJVVJ0a3vksd3Hv09K9RPgLb4nhqA6BKo/qVsr96oKyhOfIBcSF0UQK2jXJBCgFGXML41GnxF+Z0UiaUBuToDGdeTYw0RzqXJmAPNrXL0fmRDMuHcdowO+2oNINx4omUIWLNjuHQlaBDxgsYvFkCrz7qn01ewKzeoThwPbKEIFUNU0LhbcSAHaRMg6B+EgcxdJGhaN7qGmVKG2hKWGuepXchwGKKrSpnDOp/TzCDXmo9Wvh8shYEC3W78aD6XEWlfPYmSLHIqF4xnbNYucx2RCj4UQkGV1+AVhQFNdG+HhwuiARhCnn1W1txmu+k13DtiAEi0rnPuvtbrsTUpGFV1OgKoUIqQl315lY42JAdYu34Ym3s58iftx1W79qY7m1luEWIWpVuPLP1doXwdJaG6q3CZbk8P72FneRsPi8w8cADLcoLq5mdSV+A7luN4mK818F7mL4ny/C0yklIX67YvF3GSx3XQ+3Q/Vg26varsHRZ9yrC4b+NnHqNkAMv4GH+LcfXMI/+KIz52nQiJ7fBuV2IjIfyS2zvWXJjv+Aat7d/QdULXv7 +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +
+ +Created non-employee record. + +
Schema
    data object
    + +Attribute blob/bag for a non-employee. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/create-non-employee-request.api.mdx b/docs/api/beta/create-non-employee-request.api.mdx new file mode 100644 index 000000000..ac4f069c2 --- /dev/null +++ b/docs/api/beta/create-non-employee-request.api.mdx @@ -0,0 +1,103 @@ +--- +id: create-non-employee-request +sidebar_label: Create Non-Employee Request +hide_title: true +hide_table_of_contents: true +api: eJztXOtzGjkS/1dU3IfdpDyY4WEb34c7gnGWXWI4wHHlnJRXzAhQdtBw80jidfG/X3dL8wKMH5t9pdjd8oKm1epudf/UrZG4K/lLEfBI+qrrlk5LTiB4JC581VksPf9WiKH4XyzCqHRQCoUTBzK6LZ1e35UuQxG0fRWJL1ErjubQVpKuOlXCW5wuuOIzUfqw+nBQivgsxIfA0UpYsp6cCufW8QR7Q6QLoaISELsidAK5RGFAlPFchizQw7PP0vOYFo5xpoCbSLglJFy58CCS01sWzYFquQz8TyIAyQ3FK98F4e/WhilIRiNAe8p0gn00BxkIsFAUxOKg5KDqIDRwg3E86VCvw48hsrwrhc5cLDh+im6XAgbxJx+Fg0YEmcDekRQh9XUcP1bRBV+IHHEYBVLNSuv2MDMhXCZdGBtmgpn+TAGDMnQQXzhogjzQXpIvyuFCwuysDkpTGYSPHChvke9CRj23DHGlh0DmHn8mb+y4hfUokRqsKL0nc6VeO+zxb9NednwSfzn31dNlp17FURrpP8hWx0HwMOMxuquZyu4Z86fg4p+4J3MzHfkMIu4T0IXg3RAY+RAAYcxYRXE+chDQ9QUKE/px4AiM8SeqqTuCJEXeVadpn1ROGkcnTqPadI4qNnxy+NG0WXHsml3DMV0ebQ0C7roSB+PeoBAORblW64K1IngwiQEBJp4/OZzwGZv6wRocHDC7wnhCGTIZEhos+Be5iBcslL8KFsbLpR9AJJXJMhEPojMAlm2mgQEWHOIcdRFWJMHHd9mLaTEQ0BjxZdhvzXKVasWq1KxqfVypnNJ/VqUBf8nhlfs7iAJctwtikyCNDUFWeci7LuBUHkpykZ/EahJNmfvnfC9v7ExXXCZkRCJtLjwE2quVlihc+irUvlIFMXdjeQLhKaan/vdo9Oae15/Sercbx+XWsEon7PKye7Z7ru4JMl6pVWpHJ1WrIercqtenx9bEdarWkSOObLvaqDcd+2nBPdIDdV0AktB3JMf15DNg4iaqGKGeHvbqUSuBkQSJnynLUEToces48ciBc43PHH+TEQXOFl/WlD0ZIRTvk4J9UvAXSQrUuos+nLLuoW4PdY+Guj8lA6SkTld/3OtGYhFuJgo9CRCDIWXIGMi7IF6YLAZpzWvk4UHAsQyUCbffOUaKYkl3zS9tUTs5mVi2aDSs+qTCLT5pONZJ83hqVyt1u9F0MhNoqFlfNKYiEAomFBCEauXMKboGXDLl71FSP91UU6h4gTljq93uX16Mb9r94bDTa427/Qv4fHHefQ1E8LAzGt0Mhv3zbq+TNQw7/7nsjMY3rQE8etvq6SfIBz8NBr1umzjBt3brzaDVfZ3/eAPMxp0htnSG4+55jrh3OTJP+hcXnfa4P7wZtX/ovGlBU+di3B33Om86NMrr/tvO8KJ10e7cvB72LwfQ1D0jkne5jznR0yYjPDT1uued9rt2r3MzGrfGSDRojUZX/eHZzaAPOiCnYZ96Dy/pf6N+7tGofzlsY+u49Vr/vQFNOq/7w3f0dfQTjDW67OFQw86gPxxn35HR226/l2ieTEOrPe6+1TqAHD9p1Tb2XFqK4fyZHSGMEHQPnOIQv5yN+2FWPRGASEUkidtc+J+ZVNMAlvAgdqI4WAOSnCkT8DiL/DH6ELjs9sApipiMtB4WDYDnit1wa9XpCSA0txsntoHwWsOtigJgJUzSSLgCVWBRwbD5iulXQUCoRqOyeZqHqFHEo3gL+uVCiaKhc0bT/SN4L30cdC7OuhfoIBd9dIDW2TuKBfDcXg8oNia3A+wA25ZQR6GsakYzt30vLQGgUAuXWa5VlDqnRz9wC3kNjDah8m/NxRLWPtHnLGSvsDRbLExpttvyhjADceCF6ZXvyqkUuwH4/gL6ai5Ufglgn7nJRxPG6yW03bQqJ1a1NrZPThvV00azbB9V/4ui6N3KryqJYblLhnrltNYoHx+jDNtX6FZuaXzFQx0Y34ozPsd/zDjagaAdzIpEv2EfZvvkac7Cu008dmMi040h2z6F/+p22a41s82h/U7V5k7VnxDyD8zSHxf3OwVZrXbuq5k9tfq2bbS2J3EuOkEACbHFoPiIA4Vr3LQgGb4bwf1VqaguLT9lZ213bulSudP23UcswedSCWsWcIkSChLZgY4MI0y6CCwLP8DSBVkmGQ3RFc0Jlijb7BV3mbEQaxtlEEYD7vwCvB5Td14qCf1Z0gUyg7Sw2DKsOBZ8clRpVuvTozrn1ZO6fdyYNKe8Vqs0G80mebgIQyjk87CcVCTFoV8LJQLpMM93YEZ+BYOA44DtSQAa/PFFDPF4hP1xn0LTpmoaeRm+HTyA6uxVe8DqxxBUahZTO5+tGUFZlyNoUbHn8Qk24Ws23EMixv1AzuTWcjdZlM46560kHzZJOPLalt9K5aJbgqjgC3NIV6NMAYy1UHhgDgg29tJwfQkKcRXmCc1bhfA2xALNFVMeexH0MKNv6ZFnzaaBvyiEkqNfpbLvZVmUD9gE2wApnDmbwArtMl9jwsuW44hlZPWMJV+yueCQRb0os1ZaUeMuETCF/rfAiEGpjaGrGUxjTMkpcffjiF6Xrpf6mSmLs5GBSS8/KRgcIPnDftKCagCEIzXzUZh6ixHRzA/IrC1XlG68hozhrYq4A1pwD9ZVxw8CsDCbgG4yCpmBI5yuEIBHJXQpYuVTJIK7N1oYqEnomcPj8BFxN/AAfixSLX3wSZjgC7HK1mhEs5FMk0EkU4JTZ0OVTlcS+AyWIc/dx+4+dvex+8jYXX84NC8P6WkqFUXL/Sv/lp0zzYXCZcLdohMojESawfUkZscYxeTi4Xwgnw5cZ6EO4VRaj7ksoMw8Zy98mDlbg294/8lyex6FB6XVB5Mklu1yvdJk2c4hKDyF/O4hGwWbHXaa6L5R/lArXSoMHURmc+KoUK1MBK0KeuM0Z7j34FQS94Lel9CI3IO+LoYxJoHQAV32w2qV5N32puVg3BiCO6DMbSPvDmhulM8SIr1Hp1HkgIGxTX7+49UYZP8F6gigF1+WOJVfMTnXeeSG8K0UDHT7JKnpk7wzAwIUkIJYazAFHxDuKcmdSVzKTFXbHO3cDyYS0FFtqU/A1gG79WPGwWRBrBRKwsMD5voiVN9FbM4/0dSBvHr5xVGVay19qaJ9GbMvY/ap0D4V+nZSoX0Zs4/dfez+PWP3SWUM5UlhvFjw4FZ7mnmuTw8BAUvOUGaHIe9LxmsszbHWs+9J1Z7Y02NH1F1ed49qzWnVOaryxrF9bE/q1eMd2bcOsrUEPJtvk4CjielkU8BiBc4VRr7vFveewbxQWyCsIfSkeTPYvJBmV5ubuePY9/HiwW2SIYWFHFJlNkJMA9oF0gYJLRBwNgNcVAygSoJc6EoSCgCLBVgseHIhKXhRC+Ab3FqtaQSq6EBJnCwdRSrHi0FCQgLPx6zZB8eSoKSYYs4HHCiDnQE6f8Xs1EzRb8rk2RA17qHGrPPFEQIDPc3cG9teLnRB+AAxYqQn+J63DLra4QocAAoCjVlp3rnPz/f5+X6N36/x38Yav8/P97G7j92/Z+w+IT832dD9+TkQPDo/B9pyhaW51Dk61x+eplOoGAnIvZnvOHEQ5Le6Ka8AV0KBlj4dql5yvDBcOswf9rKS/LqEF40xMdQyxYEHpPMoWoanh4d3MFUwRasyX8pycuJS+Z/xzsbhBOyzBXpkegcQCVhr0DWlRZmMG0j0Xw12xFybmtRBTwWT07bwTs50sh/m8NaPAd6IzQGemjW+RM14/AsKie9Cc7UFTbOhH+h1GXir366LZnSPLtvMt3M0oGcg6ZqK5oxRci98hFm3Hn3jdni2kmClVt0YrI9kVfZK8ABKAv3y4vsfr8Yv2AxzTYr1OMQ0V0gsDiBaBuAihGWtZCMfO9HyEvjxbE6CtwqvSjB22NQDhdl7NRKCXeePLQ8Blcmk2EkQEGCvD98ns+OKT8LD9a+cWRIdT7rqECx0yAv9XtBaR0WBVPrgF7SW3yuLnUmEIIlrNtIYFanGY9fLRC+e0+u5Qvwj4WZpbhZxC1+sSaFNe+3oc18OBDCy4F5I1nr24JqfleOHFRS0INd1GdASRo7iCy4nmbVny1HgZyG/ohzv1dVcwkJa7MY0brEQ1kHPZV3mzH0/FP9iDF0Hw+B6FkMUPVuszzioRRFhVSs5kSw9pCUtSAtJvh4EhtLOxCe4LFNW4kPCplwdkj/TzELM/0w/hPBzQWdqvobVEyld3wmfLTMOaOGAlsaA0MivFyd0LDzmCDoQDmgHaGfzT0hgBM3hnua1FdWJ/SH1waXBAVGJS7g81V9OM4Aznxg9QOqUBmAYs+r0lR98Z4YXnX7OGyvZD1i34Ka8ng8L45rdtLzpfhQuln81fVHjVrZt0lfe7ddG6XuQ5K+Du38S4u2R5ltEGpPn4vZj7lcLOklFsnale+0aduEWdnp/On992tx8Ti8+77i3nF5bzt86zl06zm7/5m/SPnzVNb3JWbyFsOOGQO6CwO7j+xikNFlrV7MQGl6ZLHdz81Ofv4G/8JQQjgoRKPOSW63FK2lLj0eIBYSFzlwK2jZZClAKMuYDjEd/Qfi1DHwETSiOidGMDgAFMNEcCl3pAT/a2E9G5gQzOh3HaMDvYUy1G50fmkMZLsrsCipZBT4QYBWLR1Pg2UfflLMjmNUBhgM7S0IEUtXFIlZ4nwzEjheMQyA+EEeuDJ1Ywz0UtUoktvApYU57JdiHAYoqlKmeCxZhf4o78hIvgZceORZES2i247k+CqYvRJcyRYbCo3hGumKx8xBviFFrLrwl/ZYAiAVVcW6EN93xBkdgpsztZT+YHZpO4SHSAhMsKrX71Mp2uWJRkYU3/aEshQjJMW9vOfaV/RDW2hXs9GXEV/zFKrMOYwF1uMRdP5Qz1gWdLp+vS9vLZyjI5lhmA8HdHe4MYT25wmYgwG2H6w9ZqYjfgLHeIaJ6+xeBOxPmlYRF9zLTLYjNdy1YweoeetdpJ+2H3E7AoE/n7SbmF7kWelMj4J+hEf+elt7Dv/DFX2rnASJqvyslW4QIZsQ3SeC25S/mA6q5Wv0f+TpyYQ== +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +
+ +Non-Employee request creation object + +
Schema
    nonEmployeeSource object
    data object
    + +Attribute blob/bag for a non-employee. + +
    approvalItems object[]
    + +List of approval item for the request + +
  • Array [
    • approver object
    + +Reference to the associated Identity + +
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/create-non-employee-source-schema-attributes.api.mdx b/docs/api/beta/create-non-employee-source-schema-attributes.api.mdx new file mode 100644 index 000000000..a1e88e7fc --- /dev/null +++ b/docs/api/beta/create-non-employee-source-schema-attributes.api.mdx @@ -0,0 +1,83 @@ +--- +id: create-non-employee-source-schema-attributes +sidebar_label: Create Non-Employee Source Schema Attribute +hide_title: true +hide_table_of_contents: true +api: eJztW+tv2zgS/1cI3Yc+YDm24zzsLwc3Se+y6OsSB727NEBpibbZlUktKSX1Bfnfb2ZIyZLlPLbbu90tjAKpbZHDef5mhiJvA50KwzOp1WkcDIPICJ6Jd1qdLNJEL4U417mJxHk0Fws+yjIjJ3kmbNAKrIhyI7NlMLy8DS6sMEdaZeJrNsqzOfwWyFgNlUgWwwVXfCaCq7urVpDxmcWHsEBYrMDeyKmIllEi2FsauhAqC2BwLGxkZIq8AWfjubRs9OGUORYt40yJG2aJM8YL1thUG1Yj7yRos/FcFKMzEc2VjHjCFF8ItshtxiaC5Ur+kgsmFctwrJ8HUotFmlmWab82LN1Y9kZmc8YVE1+lzaSaOco3MkmYETZPMiTL2aeg3+m0u+1+Z8DOxFQYoSLBIq2miYyyTwEOTrWytC5baJu1WLfDIuBQL1bLWRbBWsCyYyhmYETP00aGF9oIEArmALH7mQJTLGTGrqVOyCWq/IDJU25AqEwYS0aXaJaUg7lbAUoL35zOwJPAP4ibYHgbZMuUngHvahbctQIjfsmlEeBvmclFKxBfORgLx/SiQfewczjZF9Nu3N8VnS58mvBOJPoHnUGnHzS9ojAwk3GALobEhc1e6XiJi6+vFaGXgn/BI56moHQSdOeLRXK3Ta715IuIMhTeYKRkEpy/fLouW4M7eMr0lNyptF2bvVfJkuFM9mx88s/xMwaebfM01QZNiQ7csDeqf6UmnIWKTPhEJI+z8QaHsVjaNOFLWEE7B784pbUyDKx1f66vN4oinauMvUMrw7pl/NAPj6sBFlsLuaZS3taDkBzaRWCNFe5YaSvPylwk6Rhg53EucCRDhKpoYrIELazpdr4Cghg8RU4lsOIUBQy75XFlIBGJuU5iYR5f/O8S1EeLQxRmbAohaNEAE/21vvwJuKeBmPQs5ACsTmOlqQoN1COpZGCidSK4anBwChrHCHDYtg5fQLegRStxgAgFKCo8ito6KlZZRqp3NV4uHS/rflL4K+YBmZG01URTTzEUv3d3jrCDIAq8XqeD/9Vlc3NZObmARVTtdwp4GW8yMqhqwYF2cHFxerzmp91up9PZCw+6e/tht7vXCQ+7B91wb9Ib9AQgW+ewiWYNOQBJQQF2aQHRn2DjsUGvnW4OabQx5OKYZ9osEQOaNnbGrYMNmbcVLHSMkfCwFoC2CDNJtq5z9nEu1GbPu+GWJdxisnMr1OOh1+kOws5h2Nsddw+He73h3qDd3e/9G/Xirfw/YaniQfcx0+8Md/faBweOmfsyglD5AkOCMLsVHI/GJ/Df6fHJu/Hp+F/NOucExkMspuD1iD5QSSCPmc8kIA7fVH4AKAhI+cju47GFaWmbPrbp4wdOHz519Ddli6NEgmHYiTHAaQhleJYbBYxL51S+gATdxksUTKprnsjvmUtikXGZHOn4Cc7/WioRzgyXyKEgliOYyIDitYwRHqi2dySLuKBxdcegCp+94jHI6+Q78sJgQBoe/Qy0TjdiaZ2hC+dZxRTw8tK7NywrDgSf7HcGvf50v89577DfPdibDKZ8d7cz2BsMcPWFsBbavkpdHXBj+LKx9N+EEkZGLNHgE/I/oBAAadA9MUCLwxQJqdI+bgOi8UTwcWNLMT2/FI8tiLVXRx9Y/wCSmJrl9DufrSlBhRfn2CTlCbhwJak6wu+NnEn1UO44Pnk9uniD6ePs5B8XJ+fwCWk1csdIgbfG6JbAKvjCXN8Qx14AzGtWJKAOSGzspaf6EgTiylYHSvfN1R3gW1MOvSLM8KtvmFElzaYGepdqKEVua4A9l23RbgFMY7rnWTRnE25XGeXliLJY+MZr8iWbCw74+AJ62jiWKCQkAIhGIArzl4j3PI4xdB2BaQ6h7HpxnWeAQJlcTwArVdatsQKVN1WjULZ6SnoYRVkOzJGY1SgsvcWz6O0DPDvNNbNHoTRS6VJlPMoQA6FljLQxoGEGAMck9Pcejqh9BOBRxbgSsRACC7EI7t46Zo4zTc8intsnxN2HBOAndLmveHAtfPDRNoNDI7JGYSaPSPCQ6hec7EeV5ioCH/KZSOJt7G5jdxu7T4zd9Ydnvkf2T6n06TZLnwvFc9CvoeTZKH0MeY/SrBhE5Y03ZIuBQnyJ9NPHMQT2z9A/wXjxNcW67TvWRy6VN5gflfZwv0+K5qhI/StbIIOkRyfBFJBIxEPie8UxKcqpare52mttJhIcVG0oEamsXuqccVCZyZVCTrhtsVgLq55lbM6vXU9mrUNAXFXFYaollt7bSnJbSW6z0TYb/SjZaFtJbmN3G7t/zth9sJIsuaJo8XWSzRcLbpbO0/xzlJYzGFC+MGZlyJGp1qsVJMbKGiuoVw7BpNeddKcHkejHvB/v7w6mvWi/x/cOugfdSb93EFRz/eUqjssgq8dUxd7OjqRiKOKuoY7LFTiXzbSO69t/oF4jpghrCD1l3Qw6B5VelbVjb9CsHcda41mGZVEh2VoNqVY6QkyDsQsca4qx9E5+BriocBtbAl/oSnIhgIrBt/kJvqXH4EUpgK5ZhqMp7vu6QCmcrFxFqijJgUNCgkRj1azBsSRumE/pZIBZUgU7A3T+jtWpN9FvquTZGUrsziWcfI2EwEAvK/e9Tfu7p7gHjhhx7gx8z0av63a4AgeAhsBhVll3buvzbX2+zfHbHP9j5Phtfb6N3W3s/jlj91fU574aur8+hwFPrs9hbLvDylrqNTrX/71Mp1DxHJB7Mx1FuaHt5qIGp7oCXAkZSrUlEMFDqcNgp3oEIfSHm3Zui0OqdzuujAt5/VwzFo2O39wkQGaeZakd7uzcghnBfHdtnsq2O9yRLZW+aUd6sTMB3W2AJTw/4EIQB9D5ZbdAmxRvJPq2A0Ii7sxAoqIXgzloy/hBysWJmCXIxRyZFh4Y8n5GPwOLKTQZzyyNbpNfNeQDuS5McvfbZXGE7pFlk/oeXA3GM+B0TUQU4Wp1DJ3Of7jVG4fRV1kGu7heY7H3OKzHXgluoF1wLzae//Rx/ILNsA4lHMgtlsBCYuMAkfQBXIRwblRs8uMkSj1G57M5MT6qvUbBuGLTBARmn9S5EOzy1CvhHSSAM0BsUilOEgQSOOvqeWGdWFyLBHNje6VJdDwZqx3Q0A6vzXtBeZAaBqncYTj4tf1JhexYIjxJzOc4xotI/R+7TAu5eEWub2XiLwW10FELiZp9scaFU+1l5I7lRBDcSIInlrT1zYs7emGFHnZX8AtSXecBNeH5qL/8igqrfTMfNXoh0qvz8Ul9nEtIsvVpzGEas5Ajk5idsmiutRV/ZQxdB8PgcpZDFH0zWze4aEgREfY6FZZCt2QoQygZib83EBjKOROfYMqmikVDMadiF5KfybIQ85+hoY7Z55rM9PMlZFYcGevIfjPPuGCIC4YOA6zn3yUudCyIbZSBcMA5wNHK/oQEntEK7jlaG1GdyO/QHEwNEbBKVGw6dF+GK4Dznxg9wNHlGIDhgI4e+teBeDrO08LsVVNWsVewrsEmv4mGpLmmN8dvuVeFifSPJi9KPFptqeBdiO+N0vcgyR8Hd38nxNsizY+INL4Gxq3Js9Xdp5OiWynDyh9A94e+64eyG2ey6welq+ekn3jCee2A8685mLx+QQyEw1giUXwnVI3gV74Ybe5f4gb7XMBfeEpARL0EdGruth6yWyUEDGcYsgRZ0VwK2vlIBc+wsG1h2OiFu21nNGIb9LdEaEZ3BfACHgftygTo0d58sTInNHBVMzotfrc5tV90R28OnbRos4/QjCrQgcFGFE+XwLMv2nek5+B2H9Br2XHhyVBRLhagz2yJSszxuhh7zN1jaaPcoTL0pUoUutBU15azCojCOEIR6F6BMAv7foqb6tCvV7z6kbXAqa3fUQfVoxX9ZcGVIGfC3TfEcfWe5DHaEEoh+iZdZwC2oLGtrPD2dNygCMSUvxmgzWzHT7I7OBaIYO/n3Ge33W13QuqF8Lg+dJbQvFeIH7mrlRvumrL1ezzrrnm7er+wvdf6+99r9QCJDeNOijugaPDcNbBuK+Ey2LSVAFOHjRuv1d0E6E/nuCMB829vcRMN2+s7/BnsgTs0l1erzpl2HMCv8TMg3xTSiHjAb56feZB8QR6wugR7jzzFvq9arrZ8Avj4s8CdolKMuyu6FcMJtYEh99i/QQrH7mJGMb3xagw3FdwMt0n44NirysbNh/e4XRpM/K3dhduDMvwGswH8HQaf4B980akDCrzai7/fBsWOLoxxdIuaelNJ6T+A4mHYfwGKuASS +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Body

required
+ +Schema Attribute created. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/create-non-employee-source.api.mdx b/docs/api/beta/create-non-employee-source.api.mdx new file mode 100644 index 000000000..929f8c423 --- /dev/null +++ b/docs/api/beta/create-non-employee-source.api.mdx @@ -0,0 +1,117 @@ +--- +id: create-non-employee-source +sidebar_label: Create Non-Employee Source +hide_title: true +hide_table_of_contents: true +api: eJztXG1zGjkS/isq7sNuUh7Mq234ckUwzrFLDAc4rj0n5RUzArSZkThpJg7n8n+/bkkzzACxvd7U7cuxW5XAjNTq935aSLkvyRVTNOZS9INSu+QrRmN2KUUvWoVyzdhEJspnpaOSZn6ieLwutW/uS1eaqa4UMfsSd5J4Cc9KPBBtwcKoHVFBF6z08eHjUSmmC40vgaCXUiQDPmf+2g8ZeWeGRkzEJRgcMO0rvkJegJPpkmui2L8TpmNyx8OQWN4IJQKosZSaNgyWP4hxfixO5IqReMnIXIahvONiQVIZiPZB7PYH8Z3lWqu2Jf4dCOrWfCMDkPV+i6uCIHZpyxe8zridwdSyowRMgF5jlbCjko8aA1mBKl2tQu6bace/aCR9X9L+kkUUP8XrFYPF5OwX5sdAaKXQSjFnGt8KGrHcKB0rkK20rb9LGEXkfK+yYDD7QuEhzh+zmPKw9LBF4Cn655tvz1rGOhLJE4El5Z1galfNQ3z8CNnHFcSDfezPpYooKL90ddU/3xGnH4Bl0DV4UOS75reqZ5Wz5mmlXq1Xq5VK9bTSqMwqJ/N6o8H8VunhIW9pDAR0ZqBlpudCqR8IjBvnpyh9lPn/tVSfFkomq6cVPwWX7p+DVyvj3Rsa5C4lAi9oTNDdKBc69VOdzDwaRPCkIGC1Vq+1WsgOOKWSn5nSuwYZcPBrsEc2JGcFqhRdw1ces0g/7b5/Iut86VuR6qgc35eJiG3KelRFdqAzzP+ZpqqVbTI2wo9s1ipyu5+8TRTjXBZ+eLBE9UoKbVVTq1R2LdA1OTz4WtJ4dvqlYTicmzq3+fTtLbWvlGwbjVbqlfrJWc1rsgb1Go35qTcL/Jp34rOTarXWbLT8KhrATu/v5aK4qkvD/YBQraXPjcLueLyEnAEF98k0nrrRyZnfrLX8k0oVPvn0ZN6q+OBXdeTmeQXKcYKDX8jLCyvXbiV64fr7StrDIz49gLgHbp9ypl+Thl+cW+zbXVUxkUQYtp1ud3h1Ob3tDsfj3qAz7Q8v4fPlRf8tDIKXvcnkdjQeXvQHvc2Dce+fV73J9LYzglfvOwP7Bungp9Fo0O8aSvCt23k36vTf5j/eArFpb4xPeuNp/yI3eHA1cW+Gl5e97nQ4vp10/9F714FHvctpfzroveuZVd4O3/fGl53Lbu/27Xh4NYJH/XMz5Kfcxxzr2SPHPDwa9C963Z+6g97tZNqZ4qBRZzK5Ho7Pb0dDkAEpjYdm9vjK/DUZ5l5NhlfjLj6ddt7aP29Bkt7b4fgn83XyI6w1uRrgUuPeaDiebr4joff94SCVPDVDpzvtv7cyAB8/WtF2MHNHELSfA/ToKIgQ0MQav5xPhwAGktVKqtTTuTBD0qpxKe8IF3NFwR8SP07UlsfnVJl6+Xksp+hD4Pj7s+BX61OBchPySKXaDOq1+RmkElptnlVdrqk3gxorRFZKZMzmTDHhs2sQBbLfw2+p04dQOoTSIZTyoRTJgM85exzbBFA1vZjvgLt26XrJrEqyLp5qEoI+SEp4C1pUqi2vcubV6tPqWbtZazdb5epJ7V+oD9uef1NOHMnHeGhU2vVm+fTU8iA29byLmcP04kkY0hlOtS2+Y44D0lwY2Lvbu4FXzfY0t4r5UgXgXIBGwtDhDW07udeObxZ4IO1rkgD8dnlLF/iv5dQBPNRriJ0fg9nPgCN+KJOg9yVmStDwORBzwBbUX2OPCnwGplFNpZkrGRlDvK+SzqhfJmaXh8ZAaJbEzO7dzFAZEcCbwI6nZJ5g/BAEPLlgBAKEisBOEjLGiYDxNQ/AkwHfkhlY+BPu+/hLKhasTC4l8UMODg+xu5RJGMBC4RpVbgAfcEzDO7rWQAmnraDlgMFFD2nhf0+pFYOou6U328U09jYuhinSUwp05RHAtYkSIAKfF7wW95UI8MnFZxraVuEbbSkFBkl3ZfAM3H7BBfMWinLkkBmWfZhIEJHyAPUWSYWoGEmmtjLjiooETZSr5A0NSLpz13XCYHpS1EfTPcffrgSH+SSdAukw2xzZsyw7ZXR2UmnVGvOTBqW1s0b1tDlrzWm9Xmk17UZIxLTG2MqtnWKC4tJvGTS33Ceh9MEi/2HoUBR0bxgwiz8fRhgaz9A/5hA7drMHZPkluB97BI7/pjsijVPItWKRmOd0saUE4V1NsCkvpC+Q3BIeKr7gezupFNOc9y46adl1tR5p7SujXAToltKkvCVUxXgjAOZhzUJQByRi8tpRfQ0CUaHzA7n9pteQBCPwrTlNwhhmuNX3zMiT3uSdNJR8u3lNvudlVj6CeMeqRGN/SWYUk5a09eJ1x/fZKvYGTpOvyZJRSC+vyqQTBByFpCGBaASiMH+NKYgGAYauJeAyF+IDmcSYpfh2F7lR5U4xcellkDcKBgdw/rSfdAB0AHNGzHwUZt7iWHT2AZ6t5orcTbeqpl6LmPogBRSpNahRQd2CzASycciqLh2huTQkHpGOyzJWHnqYdPfOMgPQx7zzaaKfEXejENKPZ0TLXnxmLvjADaTLRsYaqZlcRoKXBsrhZDcqM1ca+ATQSRgcYvcQu4fYfWbsbr8cu+1a99ZAn+ou9LkSNAH9KlM8d6CPMt4jJEkH2W7MGvKIgEIcRPrhegqB/QlgPoxnX1a4+/wN8ZEt5TvMdzJ72OczhB+ZsQq2QAaNHq0Ec8hELGgbvjccG0VZVdV3V7uQasbBQcUeiGg6grVMCAWVqUQI5ITqIxJIpsV3MVlSyI8UIkJrmwFxVRF4K8ktwj0gyQOSPFSjQzX6a1SjA5I8xO4hdv+csfsoksy4MtHicJJOooiqtdu2t+/NTzwEBpD04ADJQs6YahutIDGSYaxSETmUZrXqrDo/9VkjoI3gpN6a1/yTGm2eVk+rs0bttJSv9TebOM6CrBhTOXtbOxoVA4j7DDguEeBcOpYyKG7/gXoVm2Naw9ST4WbQOaj0Y4Yda61d7DiVEk/brVOEpAsYUmx0hDkNxkY4VqVjYQAlC8iLgkCq4sAXuhKPGFBReCYv5BE3wYtSAF219jrzGESxgZI6WbYKF36YAIcmE4QSUbMEx+K4hztHzAcUDIJdQHb+hujUmeg3IXkyRokHKDHpffEZw0DPkHtz3/5uX9hdYDKxBv7KRq/tdqgAB4CGwOasDHce8PkBnx9q/KHG/zVq/AGfH2L3ELt/ztj9FfjcoaGv43MY8Gx8DmPLFZJhqQt0rv85TDeh4jgw7k2k7yfKbDenGNzgCnAlZGgltUkiFG/JlI7zRz48dyqihJdrlD3wCSwlKoSRyzhe6fbx8T1YCiz0UKYrXubusI6Qd2VfRsczUM+ezINHBGyU4QBzTsIuUDa6VRzd1+Y6Q9xq2kiDjgoaN7vCj1IW7nrJGmQglswRHo9yrmQeA4sr6CO+02Z02bjOjnwg15UKH367LJbQV2TZp75HV4PxBDjdEtGd+0jvEU0QdNvVd25EbQoJNmq1ncWGOKxG3jCqoCOwv118/8P19BVZINQ0oZ5oRLmMY28AwTICFzGprJPu4+MkU12UTBZLeyqm8EsJhg6ZhyAw+SAmjJGb/Pm0MSRlo1KcxEwewFkfv0+tE7DPLMTyV95oEh2PB+IYNHRMC/NemVJnegIu7DkkeFr+IDxyzjEDcSzZOMaJaFo8crNK5aI5uV7KxN9Sap6l5hlq+tUWF1a1N/Y4EJ4FM2qhoTbaevHilp6Xo4cNFDxBqts8oCYcH8Xft/zUai/mo0DPQ3pFPj6I6yWHOlqcRmzaSg9H9Ym/lFKzvxOCroNhcLNIIIpezNYdLuqZiPBqlRxLnl3S4x6gQsPfAAJDWGeiM6zKBpRIwGsisCH5s7EsxPzP5hjYzwWZzeMbKJ44MpC+fjHPuKCHC3o2B2jHv61N6Fh4CBFkcKfl0AG6G/ubTOAYzeU9S2tvVjfkj80cLA14VdFQ0au2/dLeJDj3yV5oxNHZGEjDCKqzX/zMoUJLyxyTzisr3Q7Y1uAuv6GEurilN8tvth2FtfKPJi9K3NnsmgxFuP7WWformeSPk3d/p4x3yDR/xUzjYC7uPuZu6vXShiS9pJxe0Xr6ClYpdxcYD78/477iV+7PphdaC/dZb55N9eOeKyS/Yjae3YcYNLbYOmKPkf/GgdjdrU1tLqtrc6zZJDDTZkATl95IK14tWIU0xlA3qc5fcmY2RVaMxgiIjzDcZGTSE+gAcyK0vobQwhx7V2BHCm0sD4Ge2bZPV6Ymi1i0jc6O33ViOjNcKz1KfQ19qgA1KexR8eAJvPtFumZ1AjYfobeT8zQCAIlGUSLwugKwnUSEQpw9ESYB135iszm0rIKlupAGD2ez0tSG8YcimAu3TEV6OMf9dmjlc9HwxFoQDNpttoPqc468EWTMQhOuOK7YyzxFG0LQW7Jwha4LpQhQaT5U3vWnOxSBmHA3D6VaHLtJ+hjHAhF3IB4m1MvVcsUzPRQ8x6YTYiNH3F6NJYU7p9k/7bB1ezL7peH3+zcYXFHGbup4hTuAKFViuzvbSt+U9rbSEL1L7Ljh/f09bhJhb/mAj4Ex3IG4+bhpG/Eb0LWbRSbKPzHcpHC/TnjmMk62G7H7swt2s3aG3YB6dOzH3KbAaGguR83cPzER2f0NRe/gIf7ZLn2A/zElrqynwSDz/L6U7hbCGEs3BXP7sIz7gGI+PPwXJ1VgtA== +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 objectrequired
    + +Owner of non-employee source. + +
    approvers object[]
    + +**Possible values:** `<= 3` + +
    + +List of approvers. + +
  • Array [
  • ]
    • accountManagers object[]
    + +**Possible values:** `<= 10` + +
    + +List of account managers. + +
  • Array [
  • ]
+ +Created non-employee source. + +
Schema
    approvers object[]
    + +List of approvers + +
  • Array [
  • ]
    • accountManagers object[]
    + +List of account managers + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/create-notification-template.api.mdx b/docs/api/beta/create-notification-template.api.mdx new file mode 100644 index 000000000..1877a78bf --- /dev/null +++ b/docs/api/beta/create-notification-template.api.mdx @@ -0,0 +1,85 @@ +--- +id: create-notification-template +sidebar_label: Create Notification Template +hide_title: true +hide_table_of_contents: true +api: eJztXP9T2zgW/1c0vs7sthObEEI5+OFuUkr32KOFgzCdu8B0FVtJ1DqST7KhOYb//d57kh2HGOh22d3ujlsGYlt6et/fR5KVm0BnwvBcanWYBHtBbATPxTudy4mM6fZQzLMU7gWdIOdTG+yNgvpjG1x2gkTY2MgMr4HGcCYtc4Qs4yz3BNhEG7bQhWFW5iJiF+pC/VsXLOaK8dRqVljBcuwrVJJpqXKWw80swb5LMhFjb6SxeYfFOltAB8GMsBlwIthYJws2MXpOt0dTkTNV43XJSjnC5fezPM/s3sZGIq5EirqILJcpPYxiPd+QidrgmdwYi5xvAMGwTjAsCT4n4WqygpzsWtpZXQSVsIxb+CRzBuS15/2/hbC5Zx2IrGgAhGVvdSInTtCJFGliHXHu9BPPuJo64rYYz4E0Njw5PhtWpK9nQsEFTxYRGNGKuDAyX4Ahb4JzK8y+Vrn4nA+KfIbGBYH3GmW0e86mweUtmNwTfwVsB3s3dCmNABfKTSE6QYxEVY6PeJalntbGR4sechPYeCbmHD/li0yAz+jxRxHnwF5m0Ai5FBaffhKLWiObG6mm0Eh85sAT3opTXSQf5lwVPP1wrc2nD+Bb8w+2mM+5WQTrrikY0GR6QmoqRQtuO4Hic/HwWENuP7G3XPGpMOysGC8JNw2D9Mpx7u8JA89FIot509DrROfCWiDCXJ8IfMOUF5bN+YKNwRWSRCTgYM5jirwwAu0uFA4yCg7eDg6P4PrkH8fvDuDv2dsz/H002P8n/B0eDOD6si626wCMpjrmaaOO1hl1bb1DL/lGR+tAnLzaP2H9HZaC7xZ0n0+jFV0LUg14NLnFg2bBHDLjV4I9AwnHwhxPTiB8oBVq3bJnOfxxHzFcNPbCGFTs2c2HD9NUj3kagdclRZy/A5vdRo0CeVZYKpUolVt3nxnElzBNnKoiTfkYWXWhUXGOD3CozAgIj2XsrA/uiLMrnhYwuIWkdk0ahk6QZSBjOH5cDsEcEbHDCXAZp0Xim0AfFeKIjortwF24gNRZpJiOwCj9bjdCUcY+pu9X+UkqOKTbqWY+i6GOwf/IwRvVR6w1qG2idf6rqc0R/63UhnXnYbU9q/wNkp9M30CHQZIALduos4sAW+xdBBjS2KpJgUZk6WKon3jgU6TKhhrGvs/hV7o9NPhrGHHBEjnFWhQyC2WByQlzwYoZUhe5zTmFLDmSdWkDXUpfK2jzN9Zt5LN2p4lDmTxSOzZ3xoJv8XB7p5+E/e2tONwV3X7Y33q5PRlPtvmkO24YFxwJfniR63AqFIInkZADuPLYOCgINOeQxwJEAmEu56JRIHzgyjWhgApNVHgKPPQ+BuqS9bq9btjdhJ9ht7tHP1GX/v2HKg4iCvmrcHrNLWR1MHQ5xhMwfNupwYsRYYKqalZVCUpWLnNXpz0zr3MNnV13BxAJU/S6XfyzKtNgKYKDIqtoNWgRTYtoWkTTIpoW0bSIpkU0LaL5vRFNvwnE7KcSXfHAGPC2kJ0KqJQKK+dkfakJJVCQASTx/UTgJhE5hMa+Tr6gpr6BKAynhkvkUBDLMXRkQPFKUuTMEQo4kiXsoHarisZktcle8QTkdfLte2FATbnh8SegddjoGasMnSsJ/VnZhcmkKvYNw4odwccvu7u9/uRln/PeX/ubO9vj3Qnf2urubu/uOhxEGMHWxubG8HUQ9wP6kIwdxpD/A4VAbIDuiQEaHLogDLSP2+C3xTTh+dlaZauA1bGRU9mcSz10e33wZnB+NIQ7pwf/Oj84g09Ia21JeYDpMEG31JRgZ1D38qUAGKNWpKAODM8XnuoLEIgrW28o3ZVdWFAm+NaEQ9GDHn70hh510sul5TKUYrd2yr6XkYg6gFUxT/A8nrExwImEaZfDXwziWGR5eOQ1+cLjn+cRg6olUUhe1uMHQC/Vb6gttKgdi1VbLFV5F2eUWeSobhQMDuD8cT8ZxDnMRMgnVqKw8hbPorcP8Ow0t8rdsKY0UulC5TwGKXgKpTTWxiAUHYNsMrfMpyM0l4XEo8p2VcbCFFiKRenurWPGJUjIZ7ywXxB3Jymkn5BEqx5cCR98hK5dNiJrlGbyGanEidjZt6rMVQa+w2Bt7Lax28buF8bu3YenfummDn0216HPuQIwNtOGiuca9DF+ssTKRm470Bmyw0AhHiL9+H4Igf0JQCBuwn3OEKE9IT5ypbxh8am0h7s/pnlDaawVWyCDpEcnwQQykUj2iO8lx6Qop6qt9dHeaDOW4KCqASJC1qRVL8ZBZaZQCjnhMEdMtLDqu9wtS3CICGtdBnSblaHbrWyRZIsk22rUVqM/TTVqkWQbu23s/jFj90EkWXFF0eJxUrnHRp7mn6O0uCK+tXzLrAo5MtVdtILEWIWxglXkEIx7m+PNyU4s+gnvJy+3die9+GWPb+9s7myO+72doF7rR8s4roJsNaZq9nZ2dDs7wlwBjisUOJfNtU5Wl/9AvUZMMK1h6qlwM+gcVHpZYcfe7jp2HGqNu36LEiHZFQypljrCnAZt59jWlG1pc2EKeVExSFUS+EJXwnXXkOESKkvlXPolYYF0zSIcTHDDw28XeSerRvEbG5YyQaoRNWtwLAlCigliPqBACHYK2fkJ0ak30S9C8uwUJT5CidnB51gIDPQKuW83re8eAvMGc8SZM/A9C71utsMVOABMCFzOqnBni89bfN7W+LbG/zlqfIvP29htY/ePGbs/A597NHQ/PocGX4zPt3EnnlVY6g06128O0ylUPAfk3kzHcWFoubnE4IQrwJWQoUxbSiIcD2kEG80HNAI83YHI0DFVmBTalgdcbsBWYKPbiGcyghQG5soXSl/TKRc83XLviyH0RhE0YIOTQz+3iEi7RqIDu2xHxJ2uSR501fIgzYOUy7cK6V1LR6bDwNm9M9FtfMcNZhLfWWodkfOsyQdynZv09pfL4gjdI0uT+h4cDdoz4PSOiCjC5fIwzhnCbjf62pGcZSnBqVpvbbBjbNZjrwQ3MCdwuxff//h++JxVr6awwiLOFRJnBxAuJ+AilMwG5Uo+dqL6YnQxnRHjg5W9EgweNklBYHahzoRgo0OvhHeQ5U8hLZNKsZOgTIC9vvx4FV/p545T0axAKvf+DtyNLlTIXkvMQXjwjNp4EWmSx0ZZKRevyfW1TPylpBY6aiFRs8/vcOFUO4rduzcxRDCS4KklbX314I5eWKOHUyi4g1Tv8oCa8Hys7nDFpdW+mo8VeiHSW+XjQr2fSaikq92YS1zMQiFME3bI4pnWVvydMXQdDIPRtIAo+mq2rnHQkCIi7HVrLIVuyFCGgAuJvyMIDOWciY+xLhMs0YDYVOJC8ieyLMT8T3SO7qcVmen2CMontkx0bL+aZxwwxAFDlwOs599VJ3QsfFsNZKA84Bxgf2l/ygSe0Vrec7QaszqR36A+WBpiYJWo2GzPXewtE5z/xOgBtq7aQBpGWF3t+cE187SwRK0oq1wQuKvBdX5TDZXxjt4cv9WCFFbLb01elHiwXDc5VuniqbP0PZnk28m7v1PGazPNnzHTeKCL64+nyyPFB+WUxB+YefxUjDvs8uCJlvJYSnVgpIbag9rRjF/l/IU7gvDoOQP3yv3Dr7dXL8j/nLfgn+qddUnfEvBl75lXr48/+DZ0/e3tx97zxqxE3uknjvVc+MrD+vXlXvpeAQG/4SnZjKZeMLF1ByLQDHVCOJnC5EfJP55JQQtFGciCU4QOvfY9p4QNRsYqIawjNCV5DXg2h6m9TIEebWWUI3PKq27+geGP1+UpnOoof8Te4/cTxBC9OG/Hl3Hg2UftJ/BnYMcT+nKE12VOAGw+nxcKRkOTFXPGIfM8kjgSaePCegdWSpS60DRDqHqVyR4zEooQ0QzWzO3xBPcgZCxq+eGRsSA9WL8Bwd0JKB+zS0FOReq/VKJzZ3b3GG1ISuFMpBmd6gK2lBW1Ed4eDtcoAjFlQa5YRNpMN3wnu4FtgQjOop37bEWbUTekWSXcx4k4hGuN+D5ZndW/FIPVvjTjzqmSav+l/ZqMb/prMjyaw2n4RoaLx2j8wi0LuFWYUXDPKgzM62e4XAMtbm5whRGXJW7xNgyEy1ejy+WKA17VDtuNyoLnt7bC4YLgqV/KWt+zw4UQ18OtXj7Y9rK2ooSyB8ujcXO3OGb4NVYY+L0XXMB/uNCZC0loRPdvgnKpGdo4uuU8oAkG+w8o5u3t/wHVMYkZ +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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
    0","description":"The description in the template"}}>
+ +A template object for your site + +
Schema
    0","description":"The description in the template"}}>
 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/create-oauth-client.api.mdx b/docs/api/beta/create-oauth-client.api.mdx new file mode 100644 index 000000000..d8bb8fdf7 --- /dev/null +++ b/docs/api/beta/create-oauth-client.api.mdx @@ -0,0 +1,83 @@ +--- +id: create-oauth-client +sidebar_label: Create OAuth Client +hide_title: true +hide_table_of_contents: true +api: eJztXG1z2zYS/isY3ocmGVGWZMmy9eVG8UurnmP7/HKZqeNJIRKS0FIAjyDjqB7999tdgBIp0XbiOJc0o+mklkhwsbvYl2fBhe48HYuEp1KrQej1vCARPBWnPEsn+5EUKvVqnhFBlsh05vWu77wrI5J9rVLxMe3DILjmmbin8QE/oCd6U674WHg385ual/KxwTGnOJhZksaDG6EwQSJjnBimvZxIw+zchnHF7HBLrw4sJOK/mTDpax0CF3f0VSYCGE6TTNS8ABkCXuEWj+NIBiTQ1h8Gid95JpiIKcdP6SwWMJ0e/iECFC1OUPxUCoN3h5mRShhzwqeiMNqkiVRjGK2yKOLDSOTTrsogmIInmR6xFD7n1OhL/2zgpGdmorMoZEMRaTVmqQbC4iOfxkjX6wdT4V/oiCfevOZN9FTEoMurJHoaPzkBdnV+zLgxOpCg4pDdSlAv8qVvlUhyjpdMlniapGnc29qKdMCjiTZpr9nabneQP/UkRfXZJAMb8WG5QxxltTbSyUNMHIipLt6br1D9fCYK3x9RQF/RHWuOLDOgwJxbtHudyL/I4N4HOhQ1lohRIszkfar/FKoG5hy6R9+DhYfwV/LIsFGkbw2KwYMArOQSB/+HRzIET7sQYNGhKUglwcDHIgG2YOYpT+2l7ZZXaYXZdGhX1VhC6FJ2GkZMsbFQ6PULQcD7ChYK3z4gJ3izqIhupzFHXyTxvjLDuRa/iOHdnXbDshxCuAjSq0QWeeRJwmcVliJTMTXrJrVqcmBDkTRpbjwQeRL9ATjMZwOnG5g6O4OrMgRXU/AvYVOdCLrDbicgGDilHCuJkQAN8Oryl9PzwW/9y8Hpyfv904NDNk44SIicgCpAL0rcsmI0rRcFvr7PWWvrN3a6u3sNiNI1j6a4hBk+SzllXRBLLfYzcYu04NFVj1x61P7x4PDk8v3++eEB/B30jy/wNpgBilB5c10zcPH88Oj88OKX95en/zo8waySypTo/5xL9NCiWS226o2Cjs2abQXgO0NhvR7DZlndlWxVCrDC69LxSUmr6kSvyD0Wl/6FVpG0BqRHI/z40tpdidmSjk+Pjo4HJ4dV6+AUfXriBuRDCxrsL5mb5xSqmCTu1sInexFnQ8jDyC849Ei6sPeybAWnJ0cDp6IH2FwZdnb1+niwX+TVzpnzipEnUbyYMYdaR4KrtdgDgV2qEOEC6RU9EuRYzUMlE8Dw49CIYflUZBhS0XMQBMIsKLvlCAK+mKNE6Enh83EGq+9oEmPAYXFadFiYFRQKSAON/SKLY52kz8mBsSQNs7NQQsS1thCsSglBxOXUfE1W8DrAVLA3l5jxoYv+m2Nm57aRd+HR9yRyytBVAphAx+LpaQSlG/EswpQI0JmomR6PovVYdUH31t2rzgYjpjSjZ9EITCwCOZIirNFIh1RuZRSh4VpgXRDWMeCef1dm451XZ4THp7AWa+iVaE74B9AYfMCbiRxP0gWTFlDeTvRiVrmaokKAcj0eS1cv+DR1byQTk5Jyqu5aXABhc14roP9ri0DLansQUZWSXSkEL72zGFlsOdRflEPn1vW9+dxyYmKtjM2brUZjPUS68WCbMBOAvxB18Uzligyrjas4/+AgX5hiSVWKwq1gr7nb2N3uhC3Rae7sNpqdcLs1AnAQ8GZnt4lmCepPRPr4dBc0rmpK9oJsCmwUah/4APlsBoE0zRIFNqJt7JSUJJzlQNiNono5Y3SC7VYY7g1bTR4OO82g2+3utcP2jug2Q9FsdnkzbIThcHuHd0ejvXZzxFsgT5sPu6FoBaNtlOWxKu9bV3XfTRX3Taq2TZW2qdKqq7TnrMo+P/nfW1k9WkBtCqZNwbQpmFYKplSzwcHJpkb6UWskB/6rMvwi04Qwwk/lGoC3foJ3KSvjiBoLAeOg1SAfU6hBpM1BNcvnapHC87cJYRnqNppdv9H1m83L5m6v3eltd+uNvd3f0AumOqQK6huyHHGIs1kcVvG96zd2/FbnstXotVq91m692WgT399BNfr1yjsZeoviYwW5l3F07QmV4EMQaQWNPFQ2pvbPIoouQ1h1WFn37qW7FMwwX9mHq1Fbf7pytF1VgTr7OkwSCAw+O89LLmmX0YVmNtThDEOlVITRnrFMDUXKZbQP0eJxvH8E6+uDqiVyKIhlCjMx7aHjLjltn1uSuSXSuJIRoibqTfaahywvwPedMJibEx78CbQGn1A/XykJz7P8ESaXRUXFtKIr+HCnsddqj3baHGrPdrPbGe6N+PZ2Y6+zt0dxBiwHjLYKKZan/hnBNCACApzyL4KwHHRPDNDkFaD4njUgGp9Y7dqxCzEdvwzf+EKZxF7vn7F2F2KVGmd0nY9XlKD8q4u1AASSW8KniRzLytIvhy8Hh0f9q+NLgoD/vjq8gE9Ia+2l8WrKm+hb4tgJgBHViAjUIcI6e+Wovipsa7mB0mXDmQFl5ntj8ISbveKJImk2SvS05EqBfT3OXsi6qNcACME1SB/BhA25WW52vELEGKf+sdPkKzaB0lokL+usH0IsAiEBKIE3AlF4foaIiochuq4lMMrAlQWlZ52lTGlAFKK8FktVrqaDPKYcFxcFnQM4/4S6PEgzRHEoZtELF9Yi8w0dWh/g2WquzN1lQWmk0plKeYC4KIpmoMaE6rUhyCYBsbhwRNudEHhUPm4RsTAE5mJRuHtjmTlINd0LeGY+we/OIDorn0Rb3PggnPNhae6iEa1GvkwuIrlsTw+7UYvlyh3f7oFtfHfjuxvf/UTfXb2Z4x53l6BPcx36XKm8YgEh1qBPQtajdLmscQtZw0LcQaRf3166/S0sJT/GCE6fER/ZVL7GfH+xHvb6MO8RyFP/ci2QQdKjlWAEkUiEPeJ7yTEpyqpqe322I50MJRioqoCIEDUTNtMZ46CyJFPUrcANFjjCqJ9S9zoo37m0eyxChX6spa0ONkhygyQ32WiTjX6MbLRBkhvf3fju39N3H0SSC67IWxxOMtl0ypOZtTR3H6XlDAawvAOELVyOlmoVrSAxtsBYXhk5eMNWc9gcdQPRDnk73NneG7WCnRbvdJvd5rDd6nrFXH+99OOFk5V9qrDedh1JxQDiPgCOyxQYl0m1Dsvbf6DeRIwwrFGbaY6bqXtnfrPAjq29irdaWrM3XM1yhGRKGFItdYQxDcZOcWzhlRCocgxxUTEIVRL4QlOSUwFU8F0yi+RUkvOiFEA3mfn9UQqiWEfJjWwxi1RBlAGHFAlcNwYYlgQhxQgxH1AgBDuG6PyM6NQt0RcheXaOEh+jxOzwo+0YYgvk3qna3x3kr9Qu7ALfs9Frqx2uwACgILAxa4E7N/h8g883OX6T43+MHL/B5xvf3fju39N3PwOfOzR0Pz6HAZ+Mz2FsvcEWWOqIOiL+3zCdXMVxYBv0dRBkCW035xiccAWYEjIUa2qpiDmew/W2iodwDfVNICC0vGTYa0wtjKa3tXUHSwRLM6/zWNZtq1k6U/q2Hujp1hD0UhFysDfAuhcOoPYPO0GdlJpItFsb5Ii4VfGitQRUTdvBD1LOG61nOoOwRmRq2DDnbIguA4sxFBA/GRpdJ5tZkw/kukqi+ZfLYgndI0uV+h6cDcYz4HRFRBThZnnM+gLRtp197bD1MoPgWq+36bqm0teCJ9j7RS8tXvz69vJloTUXm2jGTEhqD+PsDEyEYli/2HpMaSXR2dh2fvVLr0j2886vOnunLoRg1wOnhBMI7ucQjUml/VKb282LfHVC8UFEmPfqS02i4clQbYGGtsrtcS8px1ExIJVtxIKr9XfKZwfUoCMxV+MYJyLVduw6zuUqtlQ/lYl/5NR8S80naublChdWtdeuBX21j/zJk7tWqQI9n9qRfKS6yoPtcSQ+yi+2Fv16T+ajRM9HemU+3qm3EwkJtPwYs/EqPyExYMFEayP+yRiaDrrB9TgDL3oyW7c4qW+jX6tRYMm3U/rSBzhI/B2DYyhrTHyI6ZjQiAagpkLrkr/TyoLP/06dfL+XZKbL15A1cWSoA/NknnFCHyf0bQwwjn+blNCwwLft4QNwemsA+8v1p0jgGC3EPUurMqoT+S16Jm8tIyrLnr9lgCsdD8PRpb7Anrd81YdnwBwtzEwlZeX7AKsaXOc30pAQV/Rm+V3sQ2GS/N7kRYn7y+2SUxXNnjtK3xNJvp+4+40i3ibS/IiRxuFb3HY8X/7gy2Feiaz+QEvxWN3Kqbr7fwbBHnZbO5hWUbV+rcNkD58l63YajxzeouNSq6elnvDDD+VjS19wMqd8MGf9GM3KcZTlcRM6LFA48WFr3sqjGG7o2rkId901wX9h8znyNtJk8a4GLcbX165UWN85xlcbE2GoJ57SBIkINfLy6ESRUBzxFAMqJZRgIgXtOcWCp6iHGhqYnlISiBONihXGEhpT/3cC3sIjPpQR0KO3IvnMnGK1rWnQBPG7yajwxbmCCVdjUWdvBRMqgIiAWwDY1wP3/tBuL+ACgsIZxhR2kMcZwPvTaaZgNvSBbMo4RLNHglEoTZDZnAnKVSLXhaaqY/FUnkAwyqEIdSqGk6k5HeHrDBmIQsx5ZC4IOca9ywDV4youfD0X5FxE5LU4rlwxPkYbjWYiohg3ISDhC2y6X87wZnC5RhGIKQNyBaKuk/GWe8hs4VgggpW5NZ/terPe8KlShetY00+5KhC3Xf+l33xZNcG75RucR39Kyzkl1pRbMW6A4qyZrXHtTsK1V95JuMHgCv4DN+7ucHMMS+s5XoYYjTsv1zfLqhm/4Rln2iSjrYc/BW7OuLcyvjs04XZh1l83YTFvn7Abbw+OvSlshpyd4hakN3Q/ETa1+zoJx+NJ+P+e9w7+gy86tiYAg+j6nZfvksIYSzfHslVQzn1AMefz/wH6lc6/ +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/create-password-org-config.api.mdx b/docs/api/beta/create-password-org-config.api.mdx new file mode 100644 index 000000000..52018afc0 --- /dev/null +++ b/docs/api/beta/create-password-org-config.api.mdx @@ -0,0 +1,85 @@ +--- +id: create-password-org-config +sidebar_label: Create Password Org Config +hide_title: true +hide_table_of_contents: true +api: eJztW1tv2zgW/iuE9qEX2E7s5jLJy8JN00EG6SSbJuhDEmxpibbZkUktKTX1BPnv+51DSZYvuWzbmZ0pjAKpLR4enju/Q1O3kc2Uk7m25iiJ9qPYKZmrU+n9jXXJiRsdWDPUo6gV5XLko/3LqBoTYaQIk6PrVpQoHzud8df96HysveifHonA0ot8rERWTbZuJGJm0BEXxmcq1kOtEoE/aeLFjU5TUXglEjWURZqLzzItVOfKnFsxUEIOUiVyyxTENi58bicz7tr43BUxSeJbYmoLMQGF8Cpn8o+B/qhBdWiIZ/IxCEC8ryIMqqsIi56p/xTaQYWTs5//3X/z7ujXFmvmLMSwTsgiH1unf2dLCB/DpMIOxTOdmP1KpjY0bgeN92+cztUz2NSruMDnKex6G1145WDTXH3J+2BItn6QQXR9B6M7yKZ8/tom4HLLXyEqXEnSt6KYGJqchmSWpTpmGTc+efLRbeTjsZpI+pRPMwWv2cEnFecQLXMUGLlWnkbvNVhj6sDCHNJEi4FwZBJaFna6GSuY3z3oLjFEtBROCUSPCmt0xPl4IRJodChTrzq8HI9E+/ykFakvcpKlKpjgDuN6pPNz+5sy3yL0VeCD0ACjq+gPlfNNmVXvtCny4IFSXg13jpQDt6F1E5mHR696SwqwKCUbCsZF8bURk8D9HrG3SWSQ6Ekxifa7+Cy/hM87mw1dtht6dDfntDhWZkRx/HXCpzx7hej3yLszJ+9OQ97uTw15dxry7t1B3lzn9Dlarnl3DdIHUyCk2oowWxxY8mu3t8pgkIskQ8XJsEzwf29zk/6bt9OZGiqnTMzF8L76Gq2rwLoKrKvAn14Flty396QaUdmr2wtVYGtV4h+kGvksDp1DbLbFmUIQGsAnPeQyUIICMQAqIKtoAwPp5DuWgkTlUqcHNlENWhhFm9GSH99qo9ojJzVJqFjkGBMFOH7WCWaIiXXkS2JJriYVmI4Ero1Pluh0xWuZiLNSv4NSGXKgk/Fv4HWUPC7QhdGYL6opQgN3Qqh7llW7Sg52Nvd6W8OdLSl7P211d7cHe0P56tXm3vbeHq0+Ud7L0VyOSufkdGnpn5VRTscitTE88jsMAnQM27MAvDimANxN/OM+YB5PsD/nEdPWapbyCgKbLSHF64NTsbUrUmlGBT+XowUjmPbFezwxRZpS4NblKjA+cYhfs0oUZSj5LqM3h2/7F8fneHJ2+K+Lw/f4RLyW2oa+QbRWVRexMLY3LHGpwI30gPEpzEGV9mXJ9SUUksY3CXX45qcexqzqBGaUq6+Y0WQthg5bUzOV4oDMxXPdUZ0WmhA8Q/GKx2IgPSbAhUT+sh/HKsvbx6UlX4qxkolyLzqinySalJRpKFce86fczSQJpW5gMCx4P7nRaCmKXBib61jN+2JmynlvzKrYcdMplByQ/PE46cd5AeFYzWYW1tFSilj6BzIHy81Ld94wGpt0anKJUgnKdAozOgcLiwF007kXZTkid3kUHlPR1RWrWZy53L0LwrzJLY/FsvBPyLvTFOWnzarVA59VmXye4FOoRuyNyk1lRSqxFU8uqWp3VYkf+sZ17q5zd527T8zdxcGzst0pRxn6dJehz4WpjlugxBL0CVDc2IUzmeDIFh3WlBDplw/nAUoydP+S0aHJd8RHYStfEr5f+yM8HxD8qJ015wsSkO0YNBiiEqlkn+WeScyGCqZ6tbzaW+sGGgFqVkBEVE3HJ2MSJnOFMSSJ9C2RWOXNs1yMJeqjREZ4HyogtzhJO7NA62skuUaS691ovRv9OLvRGkmuc3edu3/P3H0QSdZScbaUOMkXk4l00xBp5ThpKwUIRHXwLuqUY1ctohViJmqMFc0jh2jQ6w66w91YbSVyK9l5tTfsxTs9ub3b3e0Otnq7UXOvv5zlcZ1k8znV8HfwI5sYIO4zcFxhEFw+tzaZP/6DeZ0aUlmj0lPjZtgcJr2usWNvbxk7nlsr3kkzrRCSn8OQZmYjqmmgnRCtq2hBIMUIddEIlCoNuSiU9ESBi0PQiFRPdF4dloOvm7b7wxyqhESpgqxeRZs4LSAhV4LUEmq2CCwNJdWQMB84MIIdoTp/R3RauuibkLw4I42PSWNx+CVWihK9Ru7bq853jyC8oxrxPjj4noPe0O1IgwBAQxBqVo071/h8jc/Xe/x6j/8x9vg1Pl/n7jp3/565+z/g8xIN3Y/PQfBkfA7azqaosdRb/u3/z4bpnCqlBOGygo3jwvFxc4XBGVcglEigzHouIpIuAUQbK67/RXRxkGBhkKhwKQjHeZ75/Y2NWzgKDrrryEx3UL/gq3xq7E0ntpONAayzovDQDYGQZETAVxvDAh02rdMUvaHUMfNg6PIqReRhcD4UfpCzkRP24NQWKG7MpiUQ6WUk8WOImKGNeOaZusORs6Qf9Lpw6d236xIY3aPLKvM9uBroBSRdUJFUuJ7d83xPmDusvnTbc7aPUJ+2fBvmhMh64rWSDg1B+Oni+S8fzl+IESFNzvTCE8hVmq8qSXGKEOFK1q+O8WkSby7OFqMxC96f+6GEMkcMUygsrsx7pcTlUWmEX1Hiz1CT2aQ0SXEZoFnXzyvvJOqzSmn368wsSYGnE7MBC23IuXkveKfjlkCbcBkITztXpi3eaCpA4SoYaEoVucMTl1mll2zo9bVC/KPi1g7c2szNv1iQIpj2Mg4Xb2KkL7GQqWdrffXigV+7wY/6JzwhrosykCVKOeZ/3oorr321HHP82sRvXo4r82GssY3OTxOhagmPXTBNxJGIx9Z69U8hKHQoDS5HBbLoq8W6oUXbnBHt3mZDpHZYsq3bAIUs3zESw4RgkgPalBmTWMA1k4SU/MieRc5/RMuciI9zOvPjS+ydRJnY2H+1zLRgmxZshxrgS/nD1kSBRVffoEO4U8kBcDDzP1eCUtBG3Qu8VlZ1Zr/Bc2hroOvnzMVn++HL/qzAVRfmeICoaxqUYcLU9Q9++C5KXrQ/zRmrOg1YtOCyvKnFtrhgtyBvfRpFW+VfTV/SuD87NDkx6fR7V+l7Kslfp+7+nyreutL8iJWmRLl0+Hg2e2Pl8I++Xr+5+no9mnfEPetf9iXNbHtdAsfl08TwuhH+YpSLBiN79E3cCTKcajLKUplTenF5icda8TlEpmROCrQoxO2ES0LmLNUh5QOjEb8y5WA7ic5Rp+DHJ+XVypIzNyBcCjD67gtuhmiteIy+VnXEB7SGJkZ8UFtIdz0w9smW/eF7hMgpRZh4U0Ud0N9kUhisRgWimAiJ2H4kNBPt4To2BroToypbWMag9ayqnFDMkwodbpDcxJ8M6Ygb3XMjAh9ZCwHoy/NtmJ68SO0C9V61Imcq5Ugguvn+4THeCPv2WKUZNaYo/0CCqrHCu6PzJY5gZjz0ilUHPdpGOclvEC2YUJ8WwudVp9vZbHPfgufU56GVbjA/YK+L+gW7EzcS9et3c5F4OzvcX79n94T37Mo9m5qtjYzOB8kBRWj+QqN9Ga1qtNG6jakdx/DtLZ0gUed5R49Rwuh44vJ61lTSN7ANJ0ncmf+m6ASj/OmifT5lBFIeVSz/JkO9bpgRTqcepL1unBicntA5XTQoXwGchMMPJ2/wkP7uR1f4hy82CzlB7wnS89uoOkoETeBbQb1VSKf8QGre3f0X6Ol6Vw== +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create Password Org Config

+ + + + + +This API creates the password org config. Unspecified fields will use default value. +To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to "true". +Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' + +## Request + +

Body

required
    = 1` and `<= 60`"} schema={{"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}}>= 6` and `<= 18`"} schema={{"type":"integer","format":"int32","description":"The length of \"digit token\". The default value is 6.","minimum":6,"maximum":18,"default":6,"example":9}}>
+ +Reference to the password org config. + +
Schema
    = 1` and `<= 60`"} schema={{"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}}>= 6` and `<= 18`"} schema={{"type":"integer","format":"int32","description":"The length of \"digit token\". The default value is 6.","minimum":6,"maximum":18,"default":6,"example":9}}>
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/create-password-sync-group.api.mdx b/docs/api/beta/create-password-sync-group.api.mdx new file mode 100644 index 000000000..70ebb275f --- /dev/null +++ b/docs/api/beta/create-password-sync-group.api.mdx @@ -0,0 +1,83 @@ +--- +id: create-password-sync-group +sidebar_label: Create Password Sync Group +hide_title: true +hide_table_of_contents: true +api: eJztW21v2zgS/iuE7sNuC8vxW5yXLwc3aRdZtNtcXlDg0uCWlmibuzKpI6Wm3iD//Z4hKVuKnSbbC+7ahdEisEVyODOc5+EMTd1GOheGF1KrkzQ6jBIjeCFOubU32qTnC5X8ZHSZR62o4FMbHV5FVRujRuZabXTdilJhEyNzkgQ5FzNp2ej0hHmBlnGWVwMtDZzSQDbmVqRMK1bMBLO5SOREJk4by3KjP8lUpG02YoX+XSh2I4sZe3/2079Gx+9OfmG8LGbayGLBMJcR/y6lgbBCs4RnGSR6DdrQ3YqkpI7Q/za6tMIcaVWIz8UIEsgmmarDSr2Y1IudevGcKz4Vc6GKwxuMF9H1HSylqYQtXukUAm+jaubosDClaEUJyVYFNfE8z4I9O79ZcsxtZJOZmHP6VCxyAVfp8W8iKaAlDMZaFFJYapVprY8tjFTT6L6XT46ZnnjfLX2KTuIzn+cZjRvu73cnw3437o/T3XjQ6/bjg2RvN94Xnd0k6Yv+bppGd61I8bmg6Zrif8HTjRPc12o14YboYF2aoXLvqYZHFid/yrhl5ORucGPCXnLQ3e/sp3uDwZh3EtHp7g2Gk4P+eNjrDHY7bm6rS5OIk9TWJuXG8MXanG+lLWjW5Yw+AhCzToRlJ8cWgxAKc7tuwV1NsatKs8Fw2JkMdtNhpzscdvdSzg963c7u/gByvtyl00G8tQIkn+CwC7gqRVfGFWAgsXYOAzW43XDLKnGtaKLNnCNOIxoU04CmZzu9ftzpx93hRWdw2Ong/z/RQZVZxsfUg8Id+s11CtQ+n4IZxxoshT6TmtCzkEUjRFfkVl+324CFjZHcizYF8uMx2AjB54qMOzLKCJuDLD1l9PB8DcRnYiKMUIkgZmygaeV34sgtbW1pa0tb3y9tEfCeBpzW90Vxg02sdpRJkBV7bYw2LGZnoiiNQsBLD72QorExcjTKDqX6xDOZPiPPpaLgMjvSqXg8gN5IJZBRckkaCqdygoEhw8UIxI1BjDmRFXu4fu1GzMAT7S57xVPY6+07CsZQnBie/A5ZT+GoSyUxnlVDmEwZwvWhacWe4ONh56A3mAwHnPf2B9293fHBhPf7nYPdgwOafS6sBeM8TlU/CSWMTFimkaXLP+AQABu+dwq4yTcQ1QNr4GQ8wf8EYN93aWbQl1EV0EJx8urolA32AGI1Ld1zPr3nBBVfnm/iES/4vZFTqTapIlQ5J0Qcv34zunx7gSdnr/9x+focn0jWWuU0UojWlMISqiIWZvrGaRwMIKqxIoM7qDJ6GaS+hEEcNVOto7RhA7RwJmJrwsuswIgw+4YRddFsYvS8AaXEl0zsR9kW7RYb0zMQXDJrFnEvR0ki8iJ+Gzz5ks0ET4V5gTIuTSUZyTMGNEIoxi8giPE0Jeh6AZMSUBau1tNlwZQuZCKaa7FyZXM1VmT5tr4oBA5o/nicjJKihHLOzDoKl9ESVAzrA52955raXdSc5ly6UAVPYAWq0gXcaAw8zMawTRaWBTqi5bIgHlX1WzJWfQ9wdPfOK3NcaNeW8NI+AXenGegndqYtGz6JAD5LuWGot2k1qmUKjBQSRze4qsorX1TAZ9j2snSL3S12t9h9InbvN56FWi60utSnu576XKpw8EWb51rqY1z0KF2djv3h0puwkC0Gh4QU6ecPF+FYDf3F55yOsJ4xP/Jb+Zryo+V6+OdjSj+Wi9VYC1LQ+dFbMAETifTQ6b3S2DnKu6q/PtsbbcYSAao2pIhgTcMWumQcLjOlUqQJty2WamHVDwWbcfAjByKs9QxIs6o0zrVUxTaT3GaS291ouxv9dXajbSa5xe4Wu98ndr+YSS61cmgJeZIt53NuFj7SQjtZyxk6sOpXBbaEnFuq+9kKCWPLHCtqZg7RuNcddyd7iRikfJAO+weTXjLs8d297l53POjtRfW9/mqF4yXImpiqrbdfR+diJHGfkMeVCsFlC63T5vEf3GvEhGiNqGeZN8PncOn1MnfsHaznjhdas3dcLaoMyTZySLXyEXEa+s6pr6n6ogNnU/CiYqAqCb0olOjsOGaGzpIzOZcOvGQF5JpFPJoUMMUDpQqy5SxSJVkJDR0TZJqyZo3AkjBSTCjngwSXwU7Bzs+YnYYl+q8yeXZGFr8li9nrz4kQBPRl5r676Xz3BMob4ohzv8APHPT6aocrBAAKAs9Zy7xzm59v8/PtHr/d4/8ae/w2P99id4vd7xO7fyI/D9nQw/k5Ojw5P0ffdoctc6k3FFz/8zTdQSVo4MKb6SQpjTturnJwl1cglEihXFtHIpzuZkY7G+5l0l0Wn/h7lUqToeesKHJ7uLNzi5XCCt21eS7bIDAsVrFQ+qad6PnOGO7ZwDx0RcCjjDq4i6t+grbzrZEUvp7rnHDvaWcNBSo87k6FvyhZhWtJC12C3ZyYFkOoh1Byj6FijjriB+t6t13orNkHuy5Ndvff2+IFPWDLJvd9cTb0Z9D0nolkwvXqBu45Jd1+9rV7uKuNhAq13tpk76lbj70S3KAi8L9d/Pjzh4sXbEqppoN6aSnLFZJqA4DlFCHiqGxUnePTILe7IJCmM6f4qPFLCUGHTTIYzD6qcyHY1Ulwwi/g+DOQsnMpDRKOB2jU9Y/V6qTik8ho+2uvPEmBJ1O1Aw/t8Ma4F26rczWBVP7GEJ62P6qYHUtiIHcTmvoEE12Jx67yyi5es+trlfhbJS320mInzb64p4V37VXib94kwC+J4Jl13vrqyb28uCaPCig8Ian3dSBPBD2av28l1ap9tR4NeTHJa+rxUX2YSeyjzWHM0xaz2AazlJ2wZKa1FX9njEKHYHA1LYGir1brhiaNHSLiXqemUuynjGWMrNDp9xbAUD6Y+Jh2ZZeUaORrKvWQ/NWtLDD/q7vL9mvDZvf4Cpsn9Ux1Yr9aZ5owpgljzwE26O/3Jgosuh8HGxwP+AA4Wq2/Y4KgaI33vKyNrO7E77gxtDUkUNVJsfmh/3K4IrjwibkG6r3sAxqmpHr5ix+9RRBk0QbVcFZ1HHDfg+v6Zhr74j2/eX2Xx1G0V35r9pLFo9WpyXuVLZ6bpR9gkm+Hd/9PjLdlmr8i04Q0l04fz1YvEL1+9gu83W/oAm/tFvhDF55X17A394DLCKFupUIJVeeFVyHFXT/4pJP5mcBftDp6c0UISjz/GhklfnVBecYLIgJHhMlMCndkkkN7SpdbBEY9d+SVG02MicLYCZo6Cw1WmaPIlRnkuUP9ambuOMbn4gQF+m5LV7e5d9VmKMFFm31AFasSrABVsHQtBW2/6VDKniOYTwkL7LjCB/LU+bxU9PYb1C7njAOFj4AolTYpPdejoFWi8oV22fJyVEV8hE4yoe1qOTO37yd0Go9Cv4aVR+YCVGw4iofra6/XrAw5E5l/4w/9mpXOY7IB0HgmMncTHoGOnFXUZnh3crEmEcKUD/O2NtOdMMjuUF8IoYrSh0+/3W13Yldh0VsgKElR9deEH7lVZxsAeD8Sb1e/Q3xjb0WGfZwKsJ2cDg3J1NIXhL76voo2Vt/A9YyKdLTf3pKyVI7e0WPwGh1aXF2vKk36Brn+fMmV678LOtcIP2jEFwuXloQDjPVfaqgA9iP8mdUX+17XzhFO39PpXTQOr2nO/ZGI4Td4SH8Po4/4hy869+FH73LS89uoOmBEHy+3yv82pT/hA5l5d/cfTJ1rLQ== +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/create-personal-access-token.api.mdx b/docs/api/beta/create-personal-access-token.api.mdx new file mode 100644 index 000000000..8cc6ed0a3 --- /dev/null +++ b/docs/api/beta/create-personal-access-token.api.mdx @@ -0,0 +1,91 @@ +--- +id: create-personal-access-token +sidebar_label: Create Personal Access Token +hide_title: true +hide_table_of_contents: true +api: eJztW21v2zgS/iuE7kNfYDm249ixvxzSJD1k0W1yiYPiLg1QWqJsthKpJaWmviD//WaGlPyaxNvt3u0ujAJpQpHDmeG8PEON7gOdC8MLqdVZHAyDyAheiAthrFY8PYoiYe1IfxEqaARWRKWRxSwY3twH11aYY60K8a04KospjAU2H2azMPdrQ06LwwJX22HGFZ8IpJIPeZo+M+324bYRFHxikW7FDXPsMOLHBjAjFjYyMkfugffRVFrmBLCMs2oH5nZgtEMTODDil1LY4o2OQZT7FSLveSYYVzGzEWiG6eRpOtIIUFthStEIIlSHKpAmz/NURqTWvc8WCd8HNpqKjONvxSwXsJUefxZREayKcU7DLNGG2VxEMplJNWHFVDCFvAFHj8gGP734QDM3eLCFFBZ3xJULO9vCAM21nUcLe+B+m3d5eXE0eoV7jYXfLm6yY66ULnAIF1pSIhwCjE2FYbCC6TslYjae0YQSrIckvJvqDEbg4HAO/DcWKG1FF1gU33iWp8j1ex2Ln67YGWh54kw2eAB7wnNakI0bw2ewTpVpyse40J2OLERmN+sg4WVa4FA+JGoWLRRpL6vnip49qZwmO0uY0t54QBx3glLEDVrkNHgn03RBe/B3MaXHnhW//OMyQx+DJiMTzwRX9okDIvJT/hWOAH7BeUZOpkXNOZ4Eab5mQBZLmr4BwTM93OiiITE0TKSxznSfmQhBQ6sYHPph0WFunEWik8uCDvf4scBz6bw1eHhwJGyulXVW3Wm11h34uDLJ97oQLHTGJZ2+tErB/iQY5+aY8oIBu0YUjBdgHeMSCFRnFUubp3zmbPK7PX3ZK2W8nU+enTzjkc4Zwali9LrKwciV0cnecCsjhmH61bJHHfaSdhz1EnGYHHS77e7goNU96Ebjcbvd6R8mnPyLNLIdo157v5bZnFt7p038NLPtuD0WSWc8SLqd3v7hfrfbT3rdpDfY7w6SqB/xqN3vtbqdg/5h3GkdRJ2D3pjvJ/v96GDA4/HgDxEs1pLI7+t0jR8Z+R+L8i7Gb1xi52Gfk01uE9EpPj2fJy82mhctfgEeH4ODAlhprnmdo/qcRp6mfjI6Z7iexFFlhsd3dnL6fnQ2+hdGtbmI9SgIto2/bycVhIRlTXaiQfuwxbu9hPNYiG6r3UvGXdFqH0adVm+fjH87U3iagWkJCC2EEBuju1RRkWxnmaGrMs+1wbA9j/EXvDins4Uxn3o28QNRIOPoYjHMCDFcb7RXfEpIDWc0WAwsIipBy8wgaEvnBA1IdAiNMAs8ki653Yw3Oq12P2z1w3Z71D4cdg+G+/1ma3D472A1l8G51nGyijFe3ZU1zwXeLue5LOeTXndjnksl2AI7NQaCZsguRVEadDXpPNiDXDYGlIvpT6qvPJU/MnvFouAyPQYXft6o3kolQnBxiRwKYjmChQwofpUxIr5MG8Q/SLIKQjRv+UhAE802pIiYeVjAjr0waGaGR1+A1tkWbnatJKxn1RJwLEo+j2wr+oKPe61BB9JNl/POYbfdP4BExPf3W4ODAXlXBocHpYvdkF2Wt/6HAIOAFJfqCE7kP6AQMAPQPTFAmwfrCeiRMyAaW8Z3N7cW0/PLsIJrQHR+c3zBun2WcjUpaZxPVpSgwuurtVwJkjvC5wAypdrEShUgT07fHl2/G8HI5ek/r0+v4DektVbHHSmw1hjNElgFW5jqO+LYC4D+akUK6kCU99pTfb0Ai/1ED/rszIIyK2wNK/zuG1YskmaJodJk7kqRK3fZS9kUzQZkQRiDQBVN2ZgjmtGKpr9GR86L8J3X5Gs2hXApzKsmO4pjiUJCCAJvBKKwfobplMcxuq4jkJTgyoKqAl0WUE4UMlqJrnNVriKXKra8WzwUdA7g/Hk7OYqKEpgjMRe9sLYWz6I/H+DZaW6Zu9GC0kilM1XwCKQApDQDNRqDBS7Aayg8LPPhiKolCDyqmldHrMUUQuHuZ8fMSaHpWcRLu4XfXaQQfkISrX7wVXjnw2TgoxGdRnVMPiL5vEKL/az6uCrHZ1DmpfHOd3e+u/PdLX139WGFe/xTgj7tdehzrTiUh9pQ8lyDPoasR2lWTSJ44w+ywUAhHiL99GHkISDMF99yhHM/EB+5VL7G/FF9Hm58XN3uVal/fhbIIOnRSZBAJBLxkPiec0yKcqraX9/trTZjCQaqNkBEuoSb6ZJxUJkplUJOuEUoLax6Ufg7pAorOwwtVBzmWqpihyR3SHKXjXbZ6K+TjXZIcue7O9/9c/ruk0iy5oq8xeMkW2YZNzNnaf65e7kKE1j1nonVLkdHtYpWkBirMVawjByCcac9bif9SHRj3o17+4OkE/U6/KDf7rfH3U4/WMz1N3M/rp1s2acWztudo3/nYr4CjisVGJcttI6Xr/9AvUYkGNYw9NS4mV75PdzW2LEzWMeOI63Zz1zNKoRklzCkmusIYxrMzXCuqebCBM4mEBcV3rtK4AtNCd+9hczg1W0qM0nOi1IAXTMLj5ICRHGOUhlZvYtUUVoChxQJUo2oWYNhSXwfkSDmAwqEYCcQnX8gOvVH9JuQPLtEid+hxOz0WyQEOnqN3A823e/iSxGDMeLKHfAjF72u2uEKDAAKAhezaty5w+c7fL7L8bsc/9fI8Tt8vvPdne/+OX33V+Bzj4Yex+cwYWt8DnObLVZjqbfUvPO/hunkKp4D1+Cno6g0dN1cYXDCFWBKyFCuqc0n59hXG+xtbpWllgNEho6p0qQwd1oUuR3u7d3DWcEZPTR5LptV04jSd81IZ3tjUNCG2DNvk8MJ7OjizNcWTdKukWjALtoRcafruh0KdE73wk9SrnqMZrqE+EZkGthI442JhoHFHCqJF9Z3laBu1uQDua5N+vDbZXGEHpFlk/qe3A3mM+B0RUQU4XbeP32FsNvtvtZFPU8lWKp11jY7x2kd9kZwAzWB76j76cPoFZsg2CRnLy3iXCGpLYuvtTr6hh7ML0aXE9d5erT0rgSdhyUpCMw+qish2M2ZV8J7iPKXEJZJpbhIUCTAVbcvq9OJxVeRYgJszjWJhidjtQca2uNL615RsqOqQCrX+wOjzY8qZCcSY5DEpI1zvIhU5LGbjd0838vE3zY72asVLpxqbyLXexOBByMJnlrS1ndv7uiFC/SwhIIRpLrKA2rC87H8hiuqTu27+ViiFyK9ZT4+qg9TCZl0eRlzgYtZSIRpzM5YNNXair8zhqaDbnAzKcGLvputO9w0JI8IO60FlkK3ZShDwIXE3ztwDOWMiY8xLxMs0YDYVOxc8hOdLPj8J2oe+7QkMw3fQPrEmbGO7HfzjBuGuGHoYoD1/LvshIaFnW4gA8UBZwDH8/OnSOAZXYh7jtbGqE7k94rqWw1qP6U8WvepzgPcUp950FjpZQVYXb/zww5yTwtT1JKyqguBVQ2u85tqyIwrenP81hdSmC3/aPKixEfze5Nzlc5+dJR+JJL8ceLu/yni7SLNXzHSeKCL94+X84+wTquSpPpOaVNfeN27/zv1yaMLkCp8lbLoeG88hly/W7TUCQ8/4SnFD8L5UEXNv+lZJJSnvEBPo0gTTaWgW4lc8ALxaAOtXWcUHXKjkVuoPYnQhDqFDaiRQx0pU2xsx3vzamdOTuzALtoa/m1L9yEZfhU2hSpXNNkHKBRVBKaCRSJ2fsCzz9pXi1dgLRdobOykMkAAgllWKmw4B7bLjHEw82esNJY2Kl0wBeUqUenCfSVQr6oiC5o/itCkcslk9jzBC2+opReM8Zm9wBatv+0G1S/Y0VyQS5GSHeG85VLiOdrgAeFUpDmWqZAJBLZlz3f4+Wy0RhGIKQtyRaKpzWTPL7J7OBeIYMnmzGe/2W62QiphYByrPiisF4i7/vDN3yqt2uL9/LJ/6w8hfRLD6mMvxzszZKN01ZArPm+CR4pPKGemWKXCjPt7vFjBauwBh8GtsWq/uZ0XWvgXUHYXLFStfhFY2Psb/XA0o6zsK/j1VxVY/7kV7tLmybm3C4X0xTleXwVj/6Vn5u4EDL+DQfw5DD7CP/hD5844YBKNQ5Hv74VgjqNbwZ9N2d//gmI+PPwX8q/Dww== +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 objectrequired
    + +Personal access token owner's identity. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/create-potential-role-provision-request.api.mdx b/docs/api/beta/create-potential-role-provision-request.api.mdx new file mode 100644 index 000000000..dd573a043 --- /dev/null +++ b/docs/api/beta/create-potential-role-provision-request.api.mdx @@ -0,0 +1,107 @@ +--- +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: eJztXOtz2kgS/1emdB82SVkYMBjjL1fEJrvs+bWAK3Vnu7IjaYDJCkmrRxzO5f/9untGL5ABO7nsbpb9kDXSTE+/+9cjaR4MPxAhj6XvDRzj2LBDwWNx5cfCiyV3h74rrkL/k4xgwFD8nogoNvaMmE8j4/jGGPQGDIewc+lJb2rc7RmOiOxQBkgQyI1nMmJzEc98h0UxD+OIcfbRt1jssyClC5eCdEEWAjlYIeAhh3kixHUeDInEAh7P4JYHN+BXJKJIcb1nRPZMzLlx/GDEi4BuxiHy87hnhMC0DAXIFoeJWOVP0IpsTgIwTZRJpCo+83ngIrkju9Gti8OOedTh3GwJp2vybt0yna7TPmi12s2DiQWLVfIZFHX5Zdz2lvQEbDKJ6qsQ4Qv4ByuHi1wAoGviorEr5vB/M/CDxOWhjHFMmUF0g3kyZ/kQlkrEJn7IuMcKlNAJLBDCs93EESRKDPbI/AIuoWA1o6iXCXcjUEwUL0gyoDonUQPXd0SqthUNSy8WUxESwxOeuLFxXN9DyZBd9Tf/rP5u1OuPT6lCs2ra/nzueya3bVD2ihbe+sA1iOqg/2qr3M8gCETI1EymZhaVEbF76brfSh+WYrGoDxz5+HinaEOYv/WdBc4oyzZMzSk9XIoSB9pR5Q1wRU/cpzFs+x56KxLhQeBKm0bvf4yQ0sMqU771UdiYXkBiSEqxFBHeRWoXpP/lgFlWPI5i/oS0lvIBGkX9K/7KUf1OetyzBTNZz7b9BGyhgxCmnRYJb1p3NPPDmBWuPYOJH4UH+ddNPYKiJOMGaEIijNE/kDH/HsZimt7E0OA05UA65GML+MFj5WJABX5BXtZmynlpWu3DI/uwbdkHdstud3jrwHK6HXHAj0SrYUBY5IOLdqnWZIUit5e2IOxGtqAeYRShd8KCqhStr2CPj4+UbKPA9yLlZc16c9XbQRoRgMVqbCjiJPSilVLFomQ+5+FCRy1KgWqHWhcnUWoEFcHgFmFWQb9SbMhtnMHJ+FiusrnpRd22207HMa1JZ2K2JkcN02ryiXl0dNS26l2n220eoKa9ZwfimkUzIykQYTLFBa5TqppDMVm1zamIuXTBIpafxNUr/S11tzkcUJ0wKk0NJxh+T9TKZazkJXMLqhiwp2eDLhUEKbOKNUrVB0XwoFlkvtnGTJLXvpdxUCqez+ah0S6o4MfQT4IRxexmA43z+Mb8Rak0S7NTpATVXtozZgMGgHp+awz7v1z3R+P+6a3BYMatcfl23Btc4O+STdPLFABpzkK2xKr7j0tZJhuNCSjjakkf7CRl6Opy3L8YD3pnt8Ye/uxfnA4uflQ/3vUGZ8jZnmL15PL86qw/7t8atbL/qTl5lGXaEh7CqJt8EbiWj07pwZ9qJWwats3fShe6RD+vEC6jKPSYweAXFHJwelFj7CKB2ignVZpjMx4xz49BecIrUkKVeDCPW26GtQrllLcscTix7AnULXF4aHXbvG432pOJ0+5S3QKviRBHb+f6ejT2U6G02au6CVj1tRKwwto/ySkiznTWJ+4mFKwOFhuQSd2O5FxqqM4BmU6juIgbILzXh1G3DmJMoJLOPITC2wmSjX+mKPm8ZWGqjIadpx+C2mQE6MKO5SeB8BsgBrgAQFbxmW5MafQGMTso5u8Jd7e3lh79TBHTWdsIiF6JVsxMzD0n19F6gY5QICXFCsQvNJP5iji2tibaR1f9E4j1wX8goinKzy8vMLTzcCiPWA15/GuM1IGztImtTnu6Sc/3CKrrZYHdL4AAuGKeRjZ12t3JweGkLdpmQwAMaAmbm1b9qGO2W0fdNkCBht1pbI8FCtL+ELGIfwLPpZnr0s6Ihg3P2UjryWT1zn6jjssC5xfJfJAF98ArJdotXDtt8bdFAutYbdZXXJQqX+KJ8Qz92HedLaONJoGF9Cy9tZBEoAnI8MgBdanctRMX4ykIiYQlnKvycmvYbVdxS0bZ3FlvY1lVzovuRD05tu9+VaASDby1ZIWs/m9w1ocM/wwc3GaDaAXqEE+So0v6SWiLGrrb8SmP+ciWAno8/DMSGEo8Bqe1kli8ky5MOsmmAp8yCly+SLt2QHch9yKXmt9j48xX3c4xO5d8LlGLUID4GbeEu91wB5ioWCeb9i+xoOJ/URucIgYZ//tDbzweDt5ej/uj2tnlSW88gPSUxaHh6jWw76T9UD+EqwDbemcjuKayMaY5xcId9Y+bcktBt5l78DDkuKEEuppXYM3HKj9xoU49w8QlnHZjNO1u46jerXcOG7zNuV1vdA6bjbbdOuSHTad9BKMrhjSb9WxMqwkCF31jm7R1Czmch/YMIG86Ue1BgJacBLp/SqcvEO3pxLfBYx/XuuwG+2gjV9pnQsRyMV8swd8jcCobVF2rRpTpXgBNvh0yqW7HhqumZmro04ydDPu9MS15fXWq/9JqH/RHH7JuENqn4fVF/8P4p2F/9NPl2WnpVtplfRhensGsq+HlSX80Us3W8s10xZL0ORtPmyXtu7DcwOVzeqKzqoWRup0+8aHyC5jATsIQ9/ur69FT6jnvXVxT89i7Hl9+GJ6Xuc7urvWlnNe1bneVIcnT2N9mC2Wkdv30RmKrXl/VxYkrUeZ+GEI6MPUGIupDA0m1Fcgs31lgqyI9iBVJHeVX2ht0aIPshB4DbMrY76QnzGnIJXIoiGUbJqpel3Y1VStFJFMsTOPKuwKgiVqDveWAP7V8J1oY1GnI7d+A1jaN+7UnYT5Lp+CTLpVWK5cVHcGtw3q32ZoctjhvHrUanbbVnfCDgzrA7i5BXzA1n4qqYlxemvaooWPD1ObK/+J+geC4e4sM0OJP14dlGxCNLYG+GpuJqfllsfgc7wGsfntyxVod5nJvmtB1Pl1Sgmdej1bKC0iuCF+GciorH2akAXfaf9e7PhvDFb1hZewhrZWHuj0v7Ut9agBm/r0q5kqAe2hLI+GCOnDj/I2m+gYEgiJTHCjVr2gRgTKZhsswQ69eMaNIGjpdf14KJYqbzzF7JWuitgf4H64BWrdnzOLUCKjnaW/Urr55pjX5hs0Ed0T4usZ6jiNRSCgqugGf8wU2EtwpPJCbJBDKwIyExJLEuDEkbVG2Ra7K5WKfJpazolEwOIDzzX7Ss+MEKx6KWYzCzFs0i+m+gaM1V+ZuXFAaqXThxdwGKbjrLkCNkK1tyEwgm4wjptMRmiuCxOOl47KMVcyXlO7OFTNpLrV5Em0Rd1cupB+TRMtufBI6+KLsjQGHrJGaSWckuIli02Q9KjNXGviA0wQ1eLvY3cXuLna3id3lm0P9xFTfJejTWIU+1x5PQL8hFc8V6BOS93g+SweplwiUIempg4ZIP78fQ2D/JjwcLz4H+N7BV8RHqpSvPvPN7KGuW+kz3bT057ZABkmPSoIJZCLhHBPfOcekKKWqg9XV3vmhJcFBvQqICFkzZAs/YRxUFiYe4WYe7THHF5H3Q8xmHPKjfpROGRBX9Rwz8KUX75DkDknuqtGuGn0/1WiHJHexu4vdv2bsrkWSGVcULRon6RfrlKfp+ygtZzCApe/usSzkyFTLaAWJsQxjGWXkYFjNhtWYdGzRcnjLOTzoTpr2YZO3O41Ow2o1O0ax1t/kcZwFWTmmCvZWdtRP+cJPgOMSD5wrin3fKW//gXpDMcG0hqknw82gc1DpXY4dW6vY8cKPQTYgDNgxfGJ78Xp4hvTxGTmSR73RUxKE2Up16qkMQkp6xYXeithBxx103JWfXfn5bsrPDjruYncXu3/N2H0WdGxtgo6tZ0DHFkOINUGI9UdCRwdwB0KzCRgFZMiepgt8iQ3+0ruPOuxjHk5FnAG9IopsVz2nHoBxQnTYkVrtiQfWateWewBkxedABVAGgnZgcQcWdwVnV3C+j4KzA4u72N3F7l8zdp8BFjUaehoswoCtwSKMrdVZhqXe0Zv/3xozUqhoDsi9mW8TWnRyFEi4Qr29aQQ+bfXReRXHxj6+nmmq1zNN/XpmtP+QnbPxuJ+9cmvSJ1P7D0tnW8CI9Ns4A7/hQTypRElCF1aYxXEQHe/vP8AssOxjjQeylr4n7/n3Nduf71ug1oqMha9IqujEAax3NdDwuEY2CSW6vcqRRFxZSH+BYURgKXoqvpaypz+9XQByZorMHr5drF2QLtMXZN7ih4hG18jlVuQDua5D9/HLZVGEnpClSn1rV4PxDDhdEhFFuENzgavQ521gr2vg50QluF6C3nFzVxwzQkCvOFwZmRcp3MxurjB0icOa7K3gIXQb6v2OVz+/H79mUzocANNIEiGCFhL7DgjEK3AjSpO99F0HnESVK/ST6YyE65XeJsGwZBMXlMJuvZEQ7EZ/9LS4gPoxhIRPasdJgnIMzrp7lVrQEZ+Ei6W1lmsbnVM63j5ocZ+X5r2mMkr9RuFYjNqtZ7JTidkNI4nGaBHpRQ52E6Ry8YJcL2XiHyk1fSyJSdSi10tcKNXe2OrtZBtyg4rgiLT14sUVPbNAD5szuIJUl3lATWg+yu8A2anVXsxHiZ6J9Mp83Hrv6dvs8rTsiCIosa7DBsye+X4k/skYug6Gys00gUh7MVv0QbhJEWE26wWWTLWkKU1AnMTfGQSGp5xJHW1AgMdX3T+F7a9kWcgLv9IXn7+WZKbLN1CYcaTj29GLecYFTVzQVHki0vyruoeOBbGNMlAeUA5wktufMoFmtJAbFa3KzE/k92mOoT96IypRcKx+HOdJUP+lvn/D0dkYSNUI2LO3ouA307Sw+JWUlW41LGtwlV/Xh5q7pDfFb/bIDuvwn01elLiX78hceu7ia2fpJzLJnyfv/kEZb5dpvsdMoyE07mwO83Oy+n/KU5EwJkg3uiEqRuJbDTxXtzEj/IxawL9wlxIKtRTQsFELSlCrSChweYyhR6nHnklBGyCB4DGC2D10f39O6QJ6AxRPRIrQlA7DCkGvHFpWiace1Ng4X5lTVCuEjM6Hv6NEv7LgQ9xAQy1q7D30pB7oKsR+FF+WhXsffd2YjsB9rtD72GnqkYAM5/PEw+MSgO1kzjj4/Qa3dWRkJyq7QnvqiVQXfqwO2NCz0lSD8YAi0PkDIpxHlxPcW4e2veCdG9YC54z0xjqoHq2oP7jMBRkKl8IHx5X7j020ISTMmXADdBIoDYASRWGF88F4hSIQ8/TzBD+c7utJ0T6OBSLY5yn3Oag1anWT+h46xSmKoYcvED9R58Sl+wFrj4FEz/PxkQNX+xDpmQ4lh33IHz68/LRJXQuxidkPcFMPmU9U46W64xujqjuGqcfFcyiXGmS8vXr8Y94jQ0c1wxYcqD884K4RNo2PeFmdO4idGNgMAyk/6e9J6f9vhy9Wauc3+lJ47dmQeqfEoJMlt5fjGxyfuEaip454zIW5y3v0Z1roVXp64mtGm2JPHTxayV66E+2VVJuynXvh85RdYOmZp4u+gMnlWHjEYwXUdihpUo3Sz9/MsfqsO6Wy8mARBVUz1Bbr2rF3hW2vq0vcbDYsfcDlXO3ghfweizP8e2zcGnQylx+o/IplHa8/GOl+OIxRdPG//wERXlLV +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +## Request + +

Path Parameters

Query Parameters

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 + +
    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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/create-provisioning-policy.api.mdx b/docs/api/beta/create-provisioning-policy.api.mdx new file mode 100644 index 000000000..8df804088 --- /dev/null +++ b/docs/api/beta/create-provisioning-policy.api.mdx @@ -0,0 +1,98 @@ +--- +id: create-provisioning-policy +sidebar_label: Create Provisioning Policy +hide_title: true +hide_table_of_contents: true +api: eJztXAtv2zgS/iuErkAf8CNxnbYJsDi4sdv1XprknOSKRRLs0hJtcyuTOlFq6gb57zczpF5+JNmkuHYXQoFGlsjhzHAeH0cUrz0diZgnUqth4O15fix4Io5j/VkauCfV9FiH0l94DS/hU+PtnXsnOo19YbzLhhcI48cywt7Q93QmDesdD9lUKKQpDOPMEmQRUWknYh6F+HvMjQiYVmwiRRiwzzxMBUtirsxEx3PTYjkx+CNVIlQA7eEZS41gVzOhmBFJAvyxNGK/9N/uszLTLFlEghnLaYON04TJhF3JMGQ8NJpd6fgTjq6TmYhdO+pjWhfqNGeD+VyxscAxA+CCQWsWlYexYrFEZ3JypsQV40kSSxgUaM54whY6hcHCBTwDOkEaU9cSHRh0JCbACRA6Lw0PQ1akormQwlw+myVJZPba7UB8FiFOYctwGUYaVNXy9bwtA9UOtG/ahU7b01TChJXuNKVqltloRo7+c9L0XMcCWMCmZCDAZQ84/AS6v5LJjB2N3v/W638YHjKeJjMdy2SBsxWL/6YyBkFRKxw0nripbIERGeGn2BAM6do7MyLe1zC5X5IeUEDjAr73Vlla7M254lPhXd6A1UU85nORiNgQFYm2F3Ho3/AUPIBfdkLBoBtexo23l8SpAAb8mZhzb+/aw+nGtglOh3ezas2CWVNnEgmJLxxsF3t0/N3tN1tvXu4E27vb/M2rre2doPOmu7Mz7vLOy86uh0ziuMIkb3WwwMGW2fBRbJXgIx5FICJpuP2HwbGvV7nU4z+En1TkObfSokJitIAEJg57WB0sy7cs3iZTpt5lad3V2sZoJVJxP5GfUUsgkCQulpV5H2ZKd5iebHK1CmtkWOv4ss4I4ccH9zdFsAFvdlwu2FRjh4x7ZDk1YGKnxOgqwyoNQz7GYScQQWAGhUrnOAn7o0HvdAAtzo779mJw2Ht7gBf94Ul2NTgY0LPeycnw/SG2PswvLYXf3o+Ozo5zOvlP2zX/ORq8H56cDkZFv2F/cHg6PP216Fq6M+gPTwvKhwdH+//Cnj/3Dt8PfjsGFj4ejfpoQ4VWc4FW/YGiKkzOOp2T9lrsQg0VGzolH+qrBoREF18xmJo0inScQMCPpU6XZi9PRRD/34FpOZ4aNt5z9gdMGQRJmHQeBDbAZMQbNsrMOQTjWE6n0GwMwZ1ZYWDiA2aVs3lENuD+zIphBQV64KYGLAajGV8nNfTqlcWbcXAErsCN0vkYeLCGbNaZMvgJ2PwEJApQa6fUjMeCLB9C+BzstWDG7EEbJ0zTJscSp7EIyd5BIU/3bSLq+b5OVYL5YyJD8bSx6lF5MkY3xqfc9QEykPSsEwVLU0FqvtIpJO0sMWL3fHLQy5xGQDkXymn9dp7PouChPLu+T3GqFIRIuL3RjDbxrkoJ2yyUXxHiQll/vkOEgcLo8A3ULojQWrX791I7XPvWiuyzpyYfAWlks3qhXHi6Q7C+NN9IssBSuodozt9DAe4UW0wx15/R42EEHUPsADA1ifW8ZGsX6leAWeiEiBCt103gWdmJrM4Akizwwdr0BwgNzAbhrkwoHJ7lWQFSBKFVU8oPPI45JiUJnJl1+fohuRlDLbbM8mBuna1K+gM540MkCIzloG4dD2sCedacYigAEMKwOBZJWB4mJxenISKDnJmSQJ4LOmdKAuphB/3eMetl7bwbggMTnoaId/BXlcbt7OZ0Ssgys69C6irDzg6h95PriYxNgmzetJ5ch9xdP7lOidd9tE8R3wABP9Rp8IF/sULsz4T/CdjzdrZKz07kV0KA+b1RDsc8BHYkqzTF3Vy6sdZgzooQHA+OYDWQQcGquO9CjqgkIEQIdgmuQGsUkFjppGoOZbTd8kpKziBKphL6jVayAdxszvS3mF8BnKX5AMPK/+Aibr3Mj5NxjtSbtEa8j5w3hfO+Q2vuiwTWRqafaJie0sPVVS41yemRca6m06XlGMF74q3kD675qjHfQqYCQAsUloWc85w4xFEw78WhRerrPD8DuYUPbvDbMqkVx1wyZafsZdtZmnxnauURcI5TaWYiuIVlDGbY5b2tHeh4hWUb6MkvM9eBVR84r6KyxP7hT08mkj0JVePo7KevX3FxafCyD7mj0d//CX5L+pstlAP3AMAWYmLsnzyWgHpsf+i+HJseQg4Q/UQ9xCLycEn2ED6IRhZlicREliNOOs4Np9pVqihNHs/wWEyxHrCF6zOwxm3iIPmeLHRublZT3qZcs5pqtrc255rb/PMenlmKTOt90iQQn/0VqV2w875pxLi8ubGKioWJALrboTpb2/inGkRtSA7Y2vjNchhRl1jqEktdYqlLLHWJpS6x1CWWusRSl1jqEktdYvkhSizUpgsrm1VsH0rANWwQx8Bpk41EksYKX75bPbm3qgA8goXdGQAsS+L4wXC/Gj4CkmRfB/eYxXcQ+5vTmCPAYIJY9qGjjXoBqp1eoVuS2VRTu+o0gyZa2+wtD9jIybfvhLFhx/8EtIbB3Qy54JB1ASSe+/GaYcVrwcevtnY73cmrLuedN93t1zvj3Ql/+XJrd2d3F0efA7iH4LwuHleHprqN9FmofZiRr6AQcEKDGzwwEeHg9w/hROOeXmTb5mI6fhnuKUBc/Hb/mHVfs5CraUr3+XRJCap5dlJZfGDIwNIHET4CpCvXLq+yxUl/8K53dnBK64Z/nw1O4AppreyO6anMHzWB1pm+Io6dAFfcMCNCUAdm7xeO6gsQCOJvuaG0v8zCgDKZ81Po4UZf06NM2qb0siv5dgMGeyZbotUAfAD35jwBnJ6v6bD5CwAnIkqaB06TL9gMgqyIn7dYLwgkCslDu4/HrhEAaNglhNs3M0nBlQXtHNFpglFI+kvhrlBldTaKeHJQnhR0DuD8bjvp+UkKzJGYZS/MrcWx6OYHeLaaq3J3WlIaqXShElzZ4h4XWA/rOAYNu61GhrlwhNNlIPCorF0escphksLdB8uMDZAQz3hq7uF3xyGEnyaJlj/4LJzzEby00YhmI5smF5EcHqHOrlU+XZnj52il9t3ad2vfvY/vLj8cuYpmGfqsKWueKbeNDpPnCvSJyXqUzvbafSV44yaygbjOQaRfPp66TXrQXnyJMuT6jfCRTeUrzPfy+bD3x7RYzSarMhfIIOnRSjCBSCSCPeK74NjLysHdrZero8HidizBQNUaiIhLNtpxiYWeOFW09OSmwQItjHqauAKSLVtSBMRRVdC0mydrJFkjyTob1dnob5ONaiRZ+27tu39N370VSVb3KTmcZNL5nMcLa2nZe2WQljNowLJ368VL8nzjUhmtIDGWYyyvihy8cWd7vD157YtuwLvBq5e7k47/qsN3Xm+/3h53O6+9cq4/L/w4d7KqT5Xm284jqRhAHL6XSBUYl0m0DqrlP1BvLCYY1qi6nuFm0Dmo9LLAjt1V7HioE5ANCAN2jDeUF89GB0gfhrYvQEFv7r1P7FRnP+xBSEn1VPFFmkftOaihYw0d6/RTp58fKv3U0LH23dp3/5q++6egY/cu6Nj9E9CxyxBiTRBifU/oGADuQGg2gUnB79BTUK9C2BiBKHDlqo/ZNgceT0WSA70KiuzsrqLIU63ZB9yF5sCSqVQiVaEuDG/Qdo5t46ytxK03UwiRikHUkoBu0arkXCAmxV0eoZxL8mMUCOjGi2ZvkoBU1mcye8tHkcoPU+CQgkKosfaqwcYkmJOYIPwDClQHnUKg/oY1Tjdbj6oHsxFKfIASs8EXXwj0+bz+u7Nul8AQN5RguDixc71hu4CtmeN2JSW+RDZ85RC0huo1VK/TfZ3u/x7pvobqte/WvvvX9N0/AdUdGtoM1aHBvaE6tG1tsRxLvaMNn/9vxE6u4jgg82baJ6weFBiccAWYEjIUaSq00nk/e17bHfHUvs6O/Llprz3RyMOjhxArWjbTOITe2SFK1zB7MGs3LR7JVvb1ktJXdJLSGFS2Jhrh5lPrediATqqyA7RI37FEk7bxj4hb7btNtV7+zeatlLMN6rSV3pJp4LZhZ150G1iMYG3x1FDrFpnTinwg11kc3jxeFktogyzr1HfraNCeAadLIqIIl8VJUScIxO3oK+dFFckFXwF0VgY7wmYd9lbwmA7Xwl0xz375ePo8P6IsYKlB5CskrhfAgY7BRCi89bIdItiJMk6s0+mMGO9V9uCgO7FJCAKzC3UiBDsvfZzFRhCoSaXYSVBswF73O8ILNNTmlX4bj+Zqsr7EqIQf5VAbJyIt+9h5lMnFS3I9lIl/ZNSallqTqJnnS1xY1Z77dk+3Dz6NJHhoSFsPHtzSa5bo4aIK7iDVZR7skXHER3XnlJ/N2oP5qNBrIr0qHxfq40xCbq12YzaUMTOj73GGzJ9pbcQ/GUPTQTc4p4PaHszWFQ7aJI9odrZKLDXtkE3ZBKRI/B2AYyhrTHyMmZqAirY1E3LJ32lmwed/pw/8fq/ITLfPIaFiSzxt7sE844BNHLBpY4Bx/Nt8hYYFvo0yuK+n0QD2i/mnSOAYLcU9S2ttVCfybeqDqcEHVu0hA9Ge/bFXBDh3xegBts7bQBhGoJ3vJcPvnhwt+ganrKysRLCswVV+Qw25cklvlt/8RSfmzx9NXpS4V1RS8Pubbx2lN0SSHyfufqeIV0eav2OkcdAXK5Kj4jTJQfERnvsy8CHHB6weD/DtvvO/90E2+deV6z+ufNTXkEvfP37HzxXvfQAGPIDIQuy65WA5nr110Hy1iJt/iwtPKSzTggomwx7TioC1TAgVkX+X6s+koPJPBPpEmN/AIKLnFHTBHnDSYfaJ0JR0HoN1cliwyxDo0QuKbGROsdGuIdCF8bdJ3XYZDdGHKzy+4CN+gO2DB+JqHDdqwzP8jJoYPQEnPEYfZv3MrwFfz+cwNwlZczpnHKLHHc4fSOOnNke5j9atCPa837xXFrAxqqAILVqXxnNzNME3C9IXJR+/YyxwceNeK4DqS6ZaCDLCb74xT6CLVOLHXbQhsDRnIozQmsAtAWuXA8CH4ekKRSCm3LssHU/brpNpY1sggithaz4vW9utrSatDOE+Lq/nXK162voTq5aOIMnfqdRnQddnQd95FrQLi7icb0dYlqYTYmx5wdZ3zt2hX+gwe6VDndeXeC4b3gyrQ9Dt+hqNCmseN3gbojdWy84vi3IG5aHsuIT8M+eN9vwsC+vP6ZVs+WDotWJkNXi1KMpveCbTJ4FVu1wUivq2uEoM2cfubV6TMmjRfeU1JVZ6bA9bsL217WWpiHZ8hKVrb+wOp57bemDMr+Am/r/nXcA/+KEjG6+gEd2/9rLqOrSxdLOFzjqc7y5A8dDsf92EFRg= +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Body

required
    fields object[]
  • Array [
  • ]
+ +Created ProvisioningPolicyDto object + +
Schema
    fields object[]
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/create-reassignment-configuration.api.mdx b/docs/api/beta/create-reassignment-configuration.api.mdx new file mode 100644 index 000000000..68c687183 --- /dev/null +++ b/docs/api/beta/create-reassignment-configuration.api.mdx @@ -0,0 +1,107 @@ +--- +id: create-reassignment-configuration +sidebar_label: Create a Reassignment Configuration +hide_title: true +hide_table_of_contents: true +api: eJztXG1T20gS/itTug+bpCxjGwjgL1cOkDvvkcCBKaqOUJuxNLZnI81oNVKIj+K/X3fP6M02mE2o7G7OFSrY0kxPvz7dPRpx5+lEpDyTWg1Dr+8FqeCZOBfcGDlVsVDZoVYTOc3tGK/lZXxqvP61d6XTT6w+0LtpeaEwQSoTGtr3DomYYZwpcdsYyxpU2USnLJsJZhIRyIkUIZMhjJLZvA0rGhHkKXyGVe+8SyNSmJyJL9kgz2bIiQxVP60R94M68b4Vybu5B/5S8VsuTPZGh0Dtjr7KVIDgWZqLlhcgYZAEbvEkiWRAFLZ+NSjOnWeCmYg5fsrmiQAB9fhXEWTeotwjEMWtxMawFMlHbKCw8DlPQmCJ6QmoZo1aODNSTSNRaoRxFbJbVD4x0fKSFE2YSWGsSJacCN+mOkabltyaLAVSK7kticuQZZoVRGAtJjMRswnQgoniC4+TCGn1goPufmd/b7/L97phOO5097vjg85BZ7wb7HZ2hHffqrEy0s/FSKafysY2sMGRDesNI1p6HQvHKo9ZJMFuYJvPPJI1VRtwUZ6xAFgZg6uKCEwPnmqN9LAVkV+gio46ODw8vrj45fz435fHF6MLuHN4fD4avh0eDkbD0/d44d3g/eXg5JfR4OJfFxhQlajLk0FPdOewFBDZR5FNxtPsCL3+SUonZ0QTs9uZDGaoeKJQqh8mWj2gDQzQAKFjDnHi4VQ/k7FomqXT6/mdPb/XHXW7/e52v9trb+/s/gd5Eyr8Rs508gBjbcaGE7CSNAx+wE4qjyJmycMIJlWIIU2IBCETc4XWqkNH+yHZkBIfo3AWKZZl3e6Munv9Tgd+2p1OB2S9XzSR84gh8Hpu4QEG3VOkmEQrYyO41+nir2VlAIhGc4sj4HeP4EYJS8+KZ5ZFC2hfhVxLWFXeeBIHoZhIJa2AE7TusETEINBpiEYG/8A88ghnkD4+y2AZN+UTAWp4hKvjIiWrS3C0vd/hvLO7uw9wBJ84n3QPdjo73Q76v+LxE5z/nzl4pw+mDtHrWChNEvE5w8mPrH8lo0jymMFvNHHdAwtl+b0KE49ExmFkjRuepny+xIwbhwvP9K0NODPTeRQiElYwb81eGQYIWcD4/RkTlnrEiAVDzs1s1RA0U6QVcXWS/D9MCYDnU5ENNxH3B0XcJiXblCziBPznWXJyJRzk265PPyNKwH3Kvy2P56HMllHuAZcf4Ghw+gpbsplosMKCZp6loHgwvblMvV6tQwwyHlnVInahgKBeoRwHGGzslpsi+X+buR2RNxsU+O4oEOuQ+tv1jJxwyDjF8AXPqFwT9f9tzlAssfGG7+0NtcuDOk492De4AeeuEvfu13QY1TAYt9PpLHcVh5FE2xynKXiUDwbL8hTrODlx/lWryBDBFdU/7W/pLJr2tmB7qMMnGOOtVMKfplwih4JYDmAiA4qfJfldrFPh8LswD41rN8wDmmh32RuOLZSV79AJg+pMefAJaD1lv+JSSZjPiim4ZVFE5oplxZ7g49edg97O5PUO5739ne7e7vhgwre3Owe7BwcUjMIYPhXrK/J/CCVSqHgjHYBF/gsKwTTlGi9a/LHau2kDovHE5G/HlmI6fhnuxrUggb85PGM7eyziaprTdT5dUILyLy+W2mmQ3BI+TeVUqlWsFPXy0fHbweXJCK64qtdrIa2lrceBKioLYNX1LVklAObSolxvs1eO6isQiCtTHyjtNzM3uPsE4MfzKIMZbvUVM+qkbZ1UD6XAbl2yF7It2i3oGhDleQZ11JgbmKBtyn81CAKRZP6J0+QrNgMQEunLNhuEIcEv1AsQjUAU5s+x/eBhiKFrCUxyCGVgRmbQp2VM6QzgtmmLSpWLmxsFppzUjYLBAZyv95NBkOXAHIlZj8LSWxyLReUXOs01uat3hKTSucp4AFLwCDdBdArJD5AJZJOZYQ6O0FwGgEcV40rEqkMlwd07y8xRpulewHPzhLg7iwB+fBKtvPFZuOAzmPgsGpE1CjM5RHJZkSa7UaW5isBnkIqjcBO7m9jdxO4TY3fxZlH3uLtU+qzYUL1UPAf9ppQ8l0qflLxHaVYMsmWrNWQLH+G4EunnqxEE9ifo1GC8+JLg06RnrI9sKl9iflDaw14fU9VdGKthC2SQ9Og2ZgGJRNgnviuOSVFWVdvLq73V6ViCg6oVJSKgZsrmOmccVJbmitp/blos1MKonzI244CP0BoAvxYBcVUV+omWtrXfVJKbSnKTjTbZ6MfIRptKchO7m9j9a8buo5VkyRVFi6uTTB7HPJ1bT3P37bNxGFA9Mi9Djky1WK0gMVbWWF6zcvDGve64O9kLxE7Id8LX2weTXvC6x3f3unvd8U5vz6vn+usqjssga8ZUzd7WjqRi3I6FOi5X4Fwm0zpsbv/l+EBmgrCG0FPWzaBzUOlNWTv2DlacW9CaveNqXlRIplFDqkpHiGkwNsaxaTEWBnA2BVxU+GxIAl/oSrgF7rMUt8QjGUsK3hHtN2fp3B9MMhDFBkrhZOUqUgVRDhwSEkTa7lXfcglCignWfECBKtgpoPMzVqfORN9UybNzlPgEJWbHXwIhMNDLyn131f7uEJhPESMurIEf2Oi13Q5X4ADQEFjMKuvOTX2+qc83OX6T43+MHL+pzzexu4ndv2bs/o763FVDD9fnMODJ9fkunuhlZS31Fp3ru5fpFCqOA3JvpoMgT2m7uajBqa4AV0KGEm0IRDi+I+FtPfx+BJ4ds/W/5SxPI5gwy7LE9Le27sBgYKj7Nk9kuzjppPRtO9Dx1hi0tAKA7FkvdB4cwAZnQ9dgtEnFqUQvtpBHxK3CSSj0V1A8bQ4/Srk4gjHXOYAckWnhkUznUXQZWEygnfjJ0Og2edCSfCDXZRrdf7ssltADsqxS36OrwXgGnC6IiCLcVC/EXGDtbVdfei2myifYr/WWFjvFYT32RvAUGgP7COPFz1ejl2yKFSdFfI4HuJmQ2CJAzJyBixCiDYrtfJxESSbV+XRGjA8aD0wwgtgkAoHZB3UhBLsuTsC8B6g/B2wmleIkQXCAs25eFNYJxWcRYRZsV5pEx5Oh2gINbfHGvJeU8ag1kMoeiYKr7Q/KZ0cSgQi9ncY4EanTY9dJIRevyfW1TPytoOZbaj5RMy8XuLCqvQ7sAZwAwhhJcDx3CNr66sUtPb9GD/souIJUF3lATTg+mo+5gsJqX81Hg56P9Jp8fFBXdHi0OY1Z9CrOlg9ZMNPaiL8zhq6DYXA9zSGKvpotOrHqU0T4vU6NJd8u6UsfikPi7wQCQ1ln4mNMzlSbaCjbVGhD8iNZFmL+I53M+9iQmS5fQw7FkaEOzFfzjAv6uKBvMcA4/t05VWAWDwCCDPbMKTnAYWV/QgLHaA33LK2VqE7kt2gOpoYAWCUqJunbL/0K4NwnRjdwdDkGYBhr6/LBH8c3cSytezqZW1NWsSuwqMFlfiMN6XFBb5bfclcKU+afTV6UeFBtnpyqaP7cKP0Akvx5cPcPQrwN0vyISOOqXdyEPK9e6T0u+pJVr8Guf2V1+Y3V9e+XNl8vXfFGTu29j4fPYddewXjkfcKWh+FFal44ToxB/cbVp8ubl7i7PhPwP9wlbKJGAto0ajypaqsTSiKeYRQTigUzKWjbIxE8w1q3hZGkY0KeJNUId9DcEqEpvVeQgok4NKoywte3cWO+WJkTQNhCGv0Yv5ucei9cK5hBGy3a7Ao6URWAG2IXikdL4N6v2rWjF+CJZ+jI7Khwbigy4zhXeAQd2M5jxiGE1kRAKE2QW6AG+ylR6EJTqVvOKlALQwtFaFM/lsbmdHLhTrBXjr5mLfBz47bTQfVoRXsG3asEORdR2ZI125R1tCG6/JmIEnQSyDICz31XK7wbjpYoAjFlQK5AtHU63XKTzBaOBSLYDlr32W532x2f2iO4jm0ldO414vYl/3XvuzVc8q56qPBcfyPApVHsf7YS3LpDZnPbj9ke+Np7rAeGrmqGHTMMu7vDTR5sCu/xMqAL7iBc31T9Hn4D8nazh5rmTwI3GdzTBX9k3zl0uwnLj02wDbUz7AbSo2Nvak392SlupXlj9+cLYrs/kfJbxC74v+99gH/wRSdWLERCvH7nFbt9MMbSLaqwVUWI+4Bi3t//Dyhy/no= +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +
  • Array [
    • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/create-role-insight-requests.api.mdx b/docs/api/beta/create-role-insight-requests.api.mdx new file mode 100644 index 000000000..363994812 --- /dev/null +++ b/docs/api/beta/create-role-insight-requests.api.mdx @@ -0,0 +1,87 @@ +--- +id: create-role-insight-requests +sidebar_label: Generate insights for roles +hide_title: true +hide_table_of_contents: true +api: eJztW21v2zgS/iuE78O2ReTI73a+HNwkXXiRbnJ5QYFLA5SWaJtdmfSRVFJfkP9+M0NKtmyn7XWLu23hD9uNpeHwmfcZmn6s6YUw3EmtRmntqJYYwZ241JkYKSunM3cp/pUL62ztoJaKhREJvAZCZ3JxUHN8amtHtzWkZ2GBrd0hqU2MXCBbYHqVj+fSWcaZZ88M0stAz4zfgjnN3GzzJV8sMpkQwDobAtFMWubkXCCtEYzDf0qzBTd8LpwwFqiyjI1zK5WwlrhZ9iDxmWALoxN4KlI20YZ2S3Lr9FyYOghohF1oZQXI9Fhrxg383y5JQAMgSxXnVKigx0IeYJho5YRyyGdNjsOPFpk91mwyE3OOf7nlQgB7Pf4oElwIOMEsTnooMl2jsc5INa1t6jjYiY28aFV4u9GJT3y+yJBnP2kMYtHtRf0e51FbpIOID+JxlA7STqvd7jRbk3Ht6SB4R3oC/+xCBBvPOUhbS4EgQiNtwbwGlZdvn/GDB26Do6T1Csxm3IyjeBA1uteN/lF7cNRq1hud+J8ILePW/eqlFDvV9T3BaQT0BXid+Kixgqfy+ViY88nNAjewawAluMhUmG0w2vGM+XVMT1juVwbHlSWiOrty3Dj0cTdjMeMq9e4+4/fg3tpAzLqCz8NMlB7AgMfx+duLs9Pr05OKJDEARulHqd0OgesiREcnEIgz7igEpaqCAnZBPm4MX8JH6cTcbhvmCfayjrt8x7vnfDzQA2IQC/PP8eXpEISAJ6Pf2cXl+a+Xp1dX8KkUD/5+MxydwR93uGEpqY+tWjLgPG5OwP+74zhqj5N21G+P06jVaHR5t9FqiF6vtuH+z3vjljN+jnTLMeI13d/Wmsmg0Y/7oteMxaA96ceNXrPTavZ7Sczb7UkbOASSXq/Z4kmzHweSxqDRaccibpUkg35XtJN+ZwCprSu640ZHcDFpt3sJpuzCCKUyQU9OOvLstXpgL0OSBMuhKttxvO0jx5mEtMdOjQFnjdilcLlRkDTlxGf4YMexTpfohVLd80xSNH2njJkKx2V2rNOdeaoK9g0UimhquESEgiAnsBBrxb1MYQWba/BwzxIjEUUgumr4gybqDfaap6zw0+MgDGrS8OQP4DX6ilR+oySsZ8USJlfVase2oif4uBsPmu1Jt815s99u9DrjwYS3WvGgMxjg7nOoeXxaSTtFWFa3JqeVCct0Ahb5NygEXB50TwBo8x2R/IwNiMdX6B8TiqctxQx4mROf3AHUstfHF6zdYxlX05ye8+mGElR0c0XRlGV8jI+wQcGyQIzPjZxKtQtKkUFOTt8Mb86u4cnl6T9uTq/gL+S11coMFXhrim6pKSvP9AMhDgJgdbAiA3VAcWCvAtdXIBBXdp1Q+k92aUGZ4FsTnmeQyl+F3XesWGfNJkbPK6FEcfPJsReyLuoH0OrAMyh3yYyNObY7WhH5q2GSiIWLzoImX7GZ4KkwL6FrSlOJQkLRgWgEprB+iT0TT1MMXc9gkkMoC6o1Ooeyop1MRNUWK1VWrbFKJ2frRsHgAORf9pNh4nIAR2KuR2HpLQFisA9g9pqrorteUxqpdKkcT0AKnmXLslyOQTbsWEM6QnNZSDyqoCsz1tNalqR099aDOXGa3iU8t18RdxcZpJ+IRCtf3IsQfBY7Y5+NyBqFmUJGCm0zLQ5UpbmKwGcTKbJ0H7v72N3H7lfG7ubLou8Jb6n12TEh3iieg34NFc+t1seQ98C8WhD5mcwb8oCBQkKL9Nu7awjsP6BbB3rxaSGN+J79kS/lW+CHpT388zG2H6WxKrZAgKRHL8EEMpFIjwj3CjEpyquqtb3bG23GEhxU7WgRIWsattQ5DRcmVwqRcHvAUi2s+sX56YYnOM37DIi7qjRaaBio9p3kvpPcV6N9Nfp5qtG+k9zH7j52f8zY/WwnWaKiaAl9ks3nc26W3tPCe5SWMyBgxdcUrAw5MtVmt4LMWNlj1aqdQ23cbIwbk14i2ilvp93WYNJMuk3e6TV6jXG7icedq1p/u4rjMsiqMbVmb29HUjE0cffQx+UKnMs6rdPq8R+o14gJpjVMPWXfDDoHld6VvWNzsOMUWmv2lqtl0SHZSg+pVjrCnAa0c6Q1BS0QcDaFvKgYpCoJuNCV8NA/YnhmyzI5lxS8KAXwNctoOHEgig+UwsnKXaRKshwQUibINHbNGhxLgpBigj0fcKAOdgrZ+Tt2p8FEf6qTZ5co8RlKzE4/JUJgoJede2fX+e4IwBvMEVfewM8c9PpphytwABgIfM4q+859f77vz/c1fl/jf44av+/P97G7j90fM3b/i/48dEPP9+dA8NX9OdDWY1b2Um/Quf7nbTqFSkBA7s10kuSGjpuLHpz6CnAlBLTQdHdowd0MPh3iVYWouCRzaFaXxXzr70HlJgPamXMLe3R4+Ai2Ahs91flC1iGFgbncUumHeqLnh2NQ0I7cg5cEfJwhARtejMJsUSftGokO7LMdMfe6JnnQVUHndC78Wc6Kz8mIS51DfiM2BwycPTgTPcabPzBJ/GKJuk7OsyUfyHVjsqc/L4tn9Iwsu9T32d2AngHSDRFRBLz9IcDowIjsdQN4jn2qGuZo59u7dZorbM09wi3KVbnBca65BegcyZrsteAG5gb/DceL395dvyyuqEFCwKt7UyYkThAQUhfgRpTwhsVpPy6iGmR0Pp2RcMPK9ykYYGySgVLYe3UlBLsdBUX9DpXgElI3qR0XCcoWuOruRWHBVNyLDItkfaVtdE6ZqkPQ4iGvrHtJBZEmB6n8LTO8rPheRexEYp6SWNiRpriFh4Mgu10UcvE1ub4VxN8KbpHnFhE3+3IDhVftbeLv5yQQ5ciCZ5a09c2be37RGj8cs+AJct3EgJoIOKrfgiWF1b4ZR4VfhPyqON6rdzMJ1ba6jPnkxiwUyyxlI5bMtLbi74yh62Co3E5ziLRvhvWAm0YUEVEzXoMU+S0jGUHvSPjOIDCUdyY+xtpNrYuGrk6lPmw/kGUhL3ygq34fKjLT41sosUiZ6sR+M2bcMMINI58nbMDvKxg6FsQ2ykB5wDvA8cr+lAkC0LXc6HntzPzE/pDWYPlIACpxsYsj/+FolQTDX4xeIHVJA6kaW+/ye0H4zAIvLGMVZRWHBpsa3MabaaieG3rzeMtDK6yofzV5UeLh6mzlXGXL752ln8kkf528+3/KePtM8zNmmtAMo7vRtmFqWHfy16Gn2z7rs/STBfgX3lKsUt8NU42/uY1dzDqjRcYdejVFdTKTgk4JFoI77A8P0LP0nCKx+FFDuAI+pVvKBiBzmOtkBvzoHLvYOVzXpuYT7YqfbU6jCu6VzGDqFHX2DgY3lYBZcGjDmxjw7qMO09sVWOYCDctOCmND0zWf5wp2w7jM54yDS33BI1Jpk9wnLpjhlCh0oan1K1cVUYyuhiLQ7XJh5vZ8ggfQMNuuGf4Le4HdbTh9BtWjFbGTx8moFORSZOSZSFdt7b/EG7wtmolsQT9IAFh4TXq1w9vR9RZHYKYsyAXjuTbTw7DIHiItMMERyrtPq96oxxGNFPAcpzAYdNeYF9fNV79YwOxIv37ZdMXH1dn7D/PTnFCvcNA4XOARGmoh98ORn0Vva5VZtIY/5wnTKMwuMxxbgebxEU9acDx7wsdAgGP87d1q8qJpBxbQiQuNQ38ImvTpTGY1zG9/a4EzUjknX5xfgQWf/gMNu5pv +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 insights for roles' (create-role-insight-requests)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Generate insights for roles

+ + + +:::caution deprecated + +This endpoint has been deprecated and may be replaced or removed in future versions of the API. + +::: + +Submits a create role insights request to the role insights application. At this time there are no parameters. All business roles will be processed for the customer. + +## Request + +
+ +Submitted a role insights generation request + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/create-role-mining-sessions.api.mdx b/docs/api/beta/create-role-mining-sessions.api.mdx new file mode 100644 index 000000000..14271abce --- /dev/null +++ b/docs/api/beta/create-role-mining-sessions.api.mdx @@ -0,0 +1,111 @@ +--- +id: create-role-mining-sessions +sidebar_label: Create a role mining session +hide_title: true +hide_table_of_contents: true +api: eJztXG1z2kgS/itTug+bpCwMGBvjL1fYJnvs2cYHuFK3jis7SAPMRtLo9GKHc/m/X3fPSEggY9bJvh5JlQukmZ5+faa7NeLRUqGIeCJV0HetE8uJBE/EUHniUgYymI1EHMO92NqzEj6LrZNbq9/tMxzA9Ajrbs9yRexEMkQqQGM8lzGL04kvk5hxpkmyCKf4NIXFmiqLxH9SEScsUSyZl4fwMPSkQ4zVYHEz8lS5C+vkcWXBYQXpkEfcF4mIYjNbRgIETKJU7FmOChIRJEipsM7+zzGSe7RiZy58jp+SRShgATX5WTgJEAojVFciRazHKby9ys4YRKFbTE2ZdGEhiTPYVEUgJuimQhVAW3zhfugRPTNp0XdR46BgoA6iSODJilUaOaIWgHQn5zzhI0eKwBH4MRbII0+SSE7SRLyXHkw6y6cCnzIOPb64grn4NQ2SiAexB+ZB218orYcTsCz3pfUEtGDiBZ8Ib7vhLjBRsU4+7Z8CrGf1z69q/fPe1bg//ven7ng87J/ejHuj2sXgrDvuD66QUkBTLc+sAWJpP1URXO3966Z7MYJr99xLBTmlZuHu6QnmbjZaSbe5hXkU8QWMBV35xesx6BJ8/GndxwXzJLju9iauFW18azWdTuO43qm3jxr8kHOn3mgfNRuHTuuIHzXdw2MYXTGk2aznY1pNELjoG6tcVzH90YoFj5z5R4tlE4FjnjDQkps6IEPyOtGC1PP4BGXTMZaL+pLHPm102RfsY4xcaZ8pEVuK+WoJ/j8CByNHJmSxNfwfEdI9YSylgRjPIxHPlecWDCEBUWciqvQ5mgSqN7MQ7ieCpbFwGZgE1Y6XHO45KQoL44nERLjX5eU22OhwzwL7+jzRvBw0NbfPENqO75wj91UsNepVPIHfXaV+Pw+sfnCtcDOS3EO1b8EaWsZPfVCcPwH/LoepDGDLDTOK5OqbeGxW8hgWOTpTqd4qX2DrKmenvHxcxL2Xl4uHgruLr14Ucgsg8+LSccKTNH5mD6d7SHs1OanYtK2zYa877p1bL+0/SLUiaajKYfTQvTVUF2B5jN3lkjfX5+aTwYd+b/RpcDru9q/o6vXw5qr3afyPYW/0j8HFeenWYIwzuhefhoMLmHU9HJz1RqP+1fcVN7MV756R/Fn8IEk2Q4y2RL5/b6MgGllkZXTdOwNu+z8WDbGmt/Kos8HlJWDnXRVv+Gm80NAHKaH0hsKRIWxfSd/dbr+VbuZAgHcRe5gr9iAB8CLhCHkvGA8YEWZ8otJkg6c9v7++mElQkoBJuHtK2bMKxGAKiljPbzMN9ChFOssmnY8HQGRd3FWeyuJ/UNFnHkEgE+LHaRiqKCG4L9nsPPX9RWHtK0O0ioeKWkPk3mBkZJMFc0UCOiVvyvK9X44oZVRFy4QqxP0AF3uYS2fOfCG0zXRStcw1YF/LFtbJFIDAPVxxX0Ykfi+KvjVR4A48qHQuI/l3UG7hLINYNHTKUw/oTrkXF50F7ZRnCdv47+oSNHOTN45o2PCSmbhmNqu39xv1zdF/nihL5yCwsYZQcGqwhGx3HQlGVFqipfmmqtL6g9Z5u/JkV57sypNfpzz5XZLrQjL9DWoO5YcpYtsbcIclrbdrRVTuLhXJ6PHBr1Cqbdu+atdfW0EgA8E2VcTx1xUNG9cxO/sctjEyhid0/accFFXnkRkfrRcqiKrdKd+jd2XC15UJcosMPMtB+tu7r3XsNDp1cdS2j9uc2y3hdmzeqU9st+MeHrRah82D6aSQUp8bO60ykmd2AJ7CTiSlTesukt8FvxPBsxyyBx5nCW6NkE65cip/2+WzaKi9qkr7pdXYs1XdhirtqbQt5nnbV/TTt9lUsImyirbt+qat4PigGiKPN+Faqwg2Bh82xaWJEeuo3pzw9sGx7Uxbx3ar05nYvH1ct9uTo/bkYOo0hDO1VvwZMu9mw6537PrxuHF00mic1A9rB63jH61V19s00pi8aL9NsT00qb+pBFr1+rqDnXlYfbNeFEE822wokjQKAKCl6dKYJ0oT5S6YxB0bcgnp1r5dMaBLyzPlblFAvZeBsGcRl8ihIJYdmGiKQYwRX0XCVKtZn4DGlbJx1EStwU451FVGvjMjDKoz4s5noLVNR+ImkDCfZVOwO6FxsXJZ0RZ8clTvNFvToxbnzeNWo3046Uz5wUG9c9jpUHCA6fhMVBUr5aW/FwFEnMMw9fPkf0Eh4G+ge2KAFn8+f161AdHYsoDVY3MxDb8sEV+SPcjmTs+uWavNPB7MUrrOZytKCOyb0Vr6DZJrwoNIzmRQxUqGb+e9992bizFcGUKC2xvBJ6S11sroBuCtLrqlorxkrh50saMFQASOhQfqAABm7wzVdyAQJOHFgVJ/ixcxKJOZTgDMMKtXzCiSZtNI+aVQorj5krA3siZqe5AOwjXYWiBHmnBq4eveyLuu44gwsS+MJt+xOWCXiN7WWNd1JQoJKZbO7GH+AvNK7roYuprANIVQBmZkMsdOWKASCbhcbhXlqlwthjJMuSgaBYMDOH/ZT7pOkgJzJGYxCnNvMSwa+wDPWnNl7sYFpZFKF0HCHZCCe94C1BhFoGEGdSTDB+MGjhhl8D4PsnE5YhXTIIK7S82MbpUAnvE03iLurj2AH5tEy2/cCxN8MSb4pjWF1sjMZBDJPJenyVkDK9NFFvhQxwp6DrKL3V3s7mJ3m9hdvZnlPcsmaKuq73kT8BT0G9HmuZb6ROQ9gWLZIN2n1obco4a01s4PH8YQ2J8h24fx4kuIB2O+YX6kt/I15ru5PfT1CaYfubFKtkAGSY9agikgkXBPiO8lx6QoraqD9dXeq2giwUGDihSRnsMsVMo4qAzycn3cKN5jrhJx8F2iS3/uYL2vERBXDVw7VDJIdpnkLpPc7Ua73eivsxvtMsld7O5i988ZuxszyZwrihaTJ8Wp7/NooT3N3EdpOYMBLHv4zvKQI1OtZitIjOU5llXOHKxJszFpTNuOaLm85R4ddKZN56jJD9uNdmPSarat4l5/u4zjPMjKMVWwt7ajOZcQ3UMelwbgXHGilFtu/4F6IzFFWEPoyfNm0Dmo9C7PHZudigc3SrFLHiyyDCku5ZDBUkeIaTDWx7FRNpYeEc4AFwMGUCWVPv6DDXabRXi40ZO+pOBFKYButLC7U3wQrAMlc7J8FRk4XgocEhJ4CrNmBY4lQUgxxZwPKFAGOwN0/obZqTHRV2XybIgSX6DErPfFEQIDPc/cD6v6u31gPkKMGGkDP9Po1dUOD8ABoCDQmJXnnbv8fJef7/b43R7/19jjd/n5LnZ3sfvnjN1fkJ+bbOj5/BwGbJ2fw9haneW51Hs6DPxbp+kUKoYDcm+mHCeNqN2c5eCUV4ArIUOhokO7IU/m8G0fj6HY+iiJHS9fQ9WJv2YpjTwYOU+SMD7Z338ES4GFnmo8lLXsyEegHmqO8vcnoJ4K5MEjAjrKcADrXvdNZVEj3UYS3VdjHRHXmjaHq60YNE5d4Y2U8WgJmnChUkA3IrOHh2KMK9FlPFsDdcR3MY2ukeusyQdy3UTe09fLogk9I0uV+jauBuMZcLoiIopwh+YCkwMhstcN8HOmgaqbopVv74pjRpiYaw7XRi43GyzmmmsMDXBYk50KHkHVoJ9vvPnhw/gtm2E6SnCQ4vk9JiTWDxBQ1+BGBHfdrNePk2gHilQ6m5Nw3dLTFAwvNvVAKexjMBKC3ZpjQYsr2AeGANykdpwkCCtw1t2bzIKuuBcebpG1pbbROaUb7IMW93lp3lvaDqlukIE+z4VHgT8GNjuXiFIYETTGiEhlILsNM7l4Qa7XMvG3jJqtqdlELX67woVW7a2jT+c4EOP6EFNM2nr14pqeXaCHRRZcQaqrPKAmDB/lZ2BOZrVX81GiZyO9Mh8fgw90arQ8jWloYzFslZ7L+syZKxWLvzOGroOhcjtLIdJezRYdVbUpIuxmvcCSrZe0pQ2ZI/F3AYERaGfSbxpR4qIgpwtcHbY/kWUBF36CutplP5Vkpsu3sMHiSFc58at5xgVtXNDWOBEb/s0rO8Asnl4EGQgHtAOcLe1PSGAYLWCjplWJ/ER+n+bg9oFnAvUJuvBEfzlZgqD5pF/rwNH5GIBqTLzzp4LwnRlauImVlJW1DFY1uM6vp2DvXNGb5jdvWeF++keTFyXuLjsrg8BbfGuUfgZJ/ji4+zsh3g5p/opIY1Jh7FAOl7900vu2R5l3Pw2ydkr7cNMhbXx/f7uz3xUnuVcvl05y15cnudffGy+fdl9/63ibV/NKr/vKLSeVTGN147knFrVrKcCnKl6kreevqura3pjl+dc/gQKgKRndlMRFDD81Jct6IxuftMwF/IW7tBVRUQklOzUhKEkvEgIREgRt2rScuRTUAgtBH1j+7CFwKp8X3unBV36Q0Ix0FkFEco9PpAf06CFNtjKn/UDXVghb+D1OqQ6nn6+Y82AmauyDYBB0EInYkcBjRnDvZ2VaEyMw5jXiFjvPsAxqCt9PA3xRGNhOfcYBMV8APLCUk+p92VFBIDJdKKps8lnZJoVIiiLUqDaP/Hgwxacr0hEFXHthLYC12DxaAdWjFY3Bl4IMhX43GseVK9eXaAOY2nPhhegkkFQIfAdgucJlf7xGEYgFBu5UNNs3k+J9HAtEsEOg3eeg1qjVbaqY6aWxOPF5UCCu3y+vfpN41Rcfl0+WfpUfuTIAgEXvfojNXGQ51YW67orcWpVdEdgG5tg8gfuPj9jvwzbBE16GpbGZhBtF1gGgqhsmUN+PyvLPhL3mQZM91q/rmMbS+hM0bEzoGbqXuHHsXaG/cz3Arqo1Mb/h5etWVcQf4CL+PbE+wn/Cc+1GMIiuP1pZ4xfGaLr473/WNa1R +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +
    oneOf
    + +string + +
+ +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/create-role.api.mdx b/docs/api/beta/create-role.api.mdx new file mode 100644 index 000000000..3d0eceb50 --- /dev/null +++ b/docs/api/beta/create-role.api.mdx @@ -0,0 +1,198 @@ +--- +id: create-role +sidebar_label: Create a Role +hide_title: true +hide_table_of_contents: true +api: eJztPWtz4sayf2WK+yGJCzBg/MBVqXtZYL2csMYHcLZyvS6fQRqwskLiaCR7yZb/++3umdET29jZm2xyVFu1Bmke3T39mp7u4UvFX4uAh47vDe3KacUKBA/FxHdFpVoJ+VJWTq8q+FVWrqsVW0grcNbYGtrObh3JuhdDpjpJxlkALesfvV/8iK0iGbJbfifgceh/Eh67d8JbbF9l48nZTbf/fnheZZPxaGA++4H6Or18Q08Yj8JbP3DCDYzALO66LNRz1tlHb+gxbtsOQlOFSbJdV3zDPD/UsGnQmONZbmQ73pJx6GxZQkq2DvyFg+8WMDoPC48BLyl9y4FhbIUDZ9KPAktAe5GbFlrjrPke0HAlhXsnJAI+g24r/tlZRSsmo/XaD7ChK7wlNF0AFXDcFK3ZwhGujWO3Go0Gs255wK1QBDDYyPeWIkg3ljAjEGouAAMhRXAHQ+OY4rMjQ8QcCQE93/n34k4EQDkPKCXu1XOAnN0L6A9/8UW0tmlpgf7xAFsnc52Vg1hAwzyQwEmB+HckZPjGtzeV0y/01QkEMFwYRKJasXwvFF6Ir/h67ToWMeT+rxL57EtFWkA+jp/CzVoA5/nzX4UVVvIM2WWacWHtgKtDB7gWOjl2qqsMA8Ch0BWXxLGZv1BrimzMiL8V6YmZEUuxCJkXAcr3t8DRxFyam7APsDB0D+4diRzXBjK84TabKOSZCAJYByIYrEzkhkgZ8Zmv1i5C1rI6zZPGydFxu2Mfn5wcNJrHbd7k7YZotpqHzZPKQ7Xi8ZXYDZnbaMW9GsBn8zlwse3ItYsiAQOksYS+wIkjYr3KabN1koYIG7DW4dExTq0EaQdS9lHezPjsHhjJdK1WgBFXHNa5glxVC52VyJKg0WrWGge1RnPWap0etE4PT+rNRvt/iYO4PfbcjWIZgGfl2w4szqsAcjkshxmg/gK4WrNW4xRAaz0OV2buImjIPLgihvXzHJxft5QWyC5bAt1l4HEG6wrKLgpkBKoLBBjESUjgO+Y50gXNajla5QD2fiBW6rmIHAl0YItIgjpb+cHcYcAnFpoEUK7O2pEW8veKC0t4QDno5TDABTQBDg5zwrwwJnyAbvBBgg5Q43iRZ6lZzMQrvkRIAytidzxwsLXvgrQ7IepkJlyxArBBKQrPWeXmBOF01hLehWK1hp4KYtvhK/MctKgf1JFV/XtPBNvURUL8BXdlgfooN9RXkRqkX/WsF1SKGri4usKLVmgxh/3B+Ww4+6VoNMc0PvbbqmCEgwokpWdAY0ggLqjV78yg3zFgBsdbR+Hv0jcxjECxXVTk0IbFQVvs2Fv0Fm8fLTi3hWg3mkeLeVs0midWq3F00Nldb717XmfR8tTZMCQDn9HIgKsPNgiNEDATZxfj6QwfXnRnvXfQZYGErDInVMQGebfIMKPUBIAa8KQbZSf6TmaA+F3k1oa+8gDkADLSM2KGiVgImN8SSCjlfFwo3yPFahUeBHwDA4KRXcltvP1ymzfsG2S7yuXR02bAXizAJjVOmseHTXEElqizQFvUPGp2mh1hWRyBfkwactIFb3FC7QvAMmnpeqkcdHu9wXR6czEZvx2OBt8VTXEWndesmhbj7EwozAlhcu++JpNn4c/QBz44Sw8UuB0rgSybZftq651iuW6awYD1CPCMTXpA/Kk5auMX8WAW00EyStrxZnItLLC8Fi0ooKx4fncl++gsIK792Vgp19QqkpobDd7D3+wSpl/sqASzsw3721y4zvHxASjCg1aj2RbNAxCaVqNDX57ikqcdg+y8aabJQtA7/zG1ePV2pyEWtjisji9/HAfLno8fprApcCzRF+uw2u/9+O6f3T7+dX3YYWV4JTUpcQp6XWI1B5/+1lkjDnmYn+aHDyintCnxQA9rLsC9Be66Yv/Moc0GqIBlwD29o9CmBxvf3zqgtrV6kCDycrFJOApmgy2Hw1FdqJY8AL9GAU28xpbOHYDhggeD35ORX27kp7Pueb876cMjY0tvRsPp7JGdMnZLtkXOb4S5IG5VkCH6sLgJiUFAXCAkeDUMXUxqvgCPyb9HQQrvfcJuAYuwSfaRpx+9j54B7ZQNPRu3U4bMROLUDACXLRaOp4wmwLXSZIopKT7jkklABAfOILrL6LC1A/Om9RUiEK+Vkywqroawt3oniqIJT+IU7+MZpppAaFvUJkVB/XLm7BMVJDOUU+uSQ6jAInHw5Ck+GfzzsjuawoPz8ewm/tIbn8+6w3P8CHNOZtObD8PZO/g2OO/HnwEW+H88KbJUF/YD8eQZpWYmSFOsp+kyjrsAsT6JzdNO8jZFRN4KiWhKkceuIQ8B+XkUgtEFQ+NHoPnhkX4CMpk2CZFUTJdnmngNX+10V9E4jy/PZ0TNjPLPeUAx+4IPQRoFOTQVvImlIBBacWFYJCUTZIUL2MsqGjWDfvwMozApy1pFjwNIGIJGcjc5Mx4jsG0ZfxIbw/GaRJvdogJpLyOGLAcXrq3SnY8Rg2I0SmMmEMfD1cWKOy7CpqJkw61m9WkuS1zTqYq0LQJ/ZTS6VyRuHgVUawG/9+rk52GoicJ7KNIYP1TEJYZMscf2YEzreHHAKRhzCBvS5kmrCQ5wh4xhEsa6UvilluP60ZUjyhAZfsYNx8uJM6VmersCixWiH4u0ekYMg+1yaAyxsgAwDOgFdr8f7IdpfY0K3CgP2kzR/jhmCYySgrfOF8zzbZiDzIEDLO7o7ZTpiy19j5hQaaoqS9RilRmtWGUppahANmqxqqaO/WGzCmAkjZ9vvIsN0skhdkCpRVc/y7QWD1wh6hYsWdPqLDrzo4X9P8i+jsfR7lr+iszKrePasEd7iS/89BqW5qY0N6W5Kc1NaW5Kc/NVzE1pXkrzUpqX0rx8g+alNCd/pjl52L50IwFielCM/hc0MxoexJeMUkyyHCvmaQSaHrEeT9KHL+bkLX1qV2fdOBWGZCQQ+BZgozhkIqSBSEKc1dRxQrxqEobS2UDcdTdVgoFeMIujZnPpvNDYVgWebsA9m2FIvHYHWpvXnyZaqyTay4nWVAcsJuL7es+mCxKjz0vJbHuJ3sBTX/iaDhyrrK8t5vjl0X6tZm9648lkMOrOhuNz+Hz+dnimLHT6MDB+MAHNMJjObroX8Orn7ihjzOHhaNijkdCD6r6/6A7P0h9vYLDZYIJPBpPZ8G2q8ehyqt+Mz88Hvdl4cjPtvRu87+achGrlbPzzYHLePe8Nbs4m48uL1GlF+uAiAT1+pIGHR6Ph20Hvlx4mus26M2x00Z1OP4wn/ZuLMeCAI2EeHP65pD/TcerVdHw56eHTWfdM/X8DmAzOxpNf6Ov0J5hrejnCqSaDi/FklnzHgX4ejkcGc7MM3d5s+LPCAeD4SaG2za/E9TNCpq0wLjFJSn82lqkMPEzV01bEMNW5fw98tQg48ENkhVEgHkmiSHi/H/ozZT4L56p/VprF09pqhxNpA1QW+dmtv+KSDaCH8sG563B5/iogLiX4q9umzMwY1oWe7OGxI6G437Na2myS8joCUJoLVJPiMyhMCf4s+SkZbyI5N6yq/APjjWXUT1EpFo+uEE5XLLm1SeHgLfyXb2ayaQKYhmqDrbFC0OEq142WF9U2vF4KD6QCTw7B/YdG6qAVdP0eTrIHTpLHQLFvWIBWxPFkyEHlArbSX6mdpKQUHMrwnQuTgQHDAMUwYyx/ionyF1smlWgLA3s+c1UKa+4Ys84+3GICA5BdmvkoS0OG+P+9H3xCVwqcPXnrR4AygL5ylgHXmMQ7XzBZWZNQBCeTYUFprpJSZkHwKS+QrCNbR8HalypFFr12h+aRETjxamL0LdPcGq9f9iwT5SS2uRcpGxQnX+A6pTXF3Af0ubftQD3e5pmzc90b0QYOyMBjeGbBIzfUKXAPcW6u4quXz4l+wlzlV4Y8WKZTOkyqj9wFDNVFp+X0fG/hLLed4ub0e2YeOmx2lpHW9iqTOs7iqxSPgLMeALjLtJOdxBuhF1HD5DUFRoNhVjN3PJQGNaPy5GDSO/CEmJmO/QpPtbefGqdIsiIpciQEneRwt/d6NJCt1wgffN4OK+k6mOcrQKtm4u4Us7u3uoRZIEeYsqEezc3sQO61JMePBisCtWO6nMF69owTOP5wTl7X++5594w+Fdyrgg/SVyDrdA/Hsx0gacQppW0Z+NHabDcpgOJ70kE1jcwbLwd3CdM6oz22JM3Jpc4FkXVMzNjbI9j29k7ZOElhzUQ8UFxVUw0+Nn7PPb5Mmsfex4p/ylFTdc3ji2N02RkSz0MLwc4QpaoajOIeKs4B6CXWc65yWfb2DN2H9t6e0r8Zc18gbsw22OUVgZg4wz8O9pnhqiqCRzseYvI0SyD0W/zoBND2kXXcOWl2avyos6i1O7xVmwtrXmuC13bc5OLoyDrKpuFlmP+tH1BW90PGXTB6Gfbz4SZuggr7zlcVEjtoSy10+KIY/DTj7KZA639hDarzvf8qKnRXcP9fdWieO0p1WqrTv7I6RX4uKFMplrumOWuqPLuvHJnc0j4FGcwMFE3m3qaaPpIAShjPHVjLWXqqHikmxVVlcTxvzk/4Qe1wIexae2G3a9xudWonOr34WDQ70KPVseZHVuOo1rT5Sa19IHjtZC7atflBs3W4aLVPFi1euc7H+SlgYApmckF+JB81JylSgg1z4p+cHaFtQFzjVRbzVcpivkpZzFcW85XFfGUxX1nMVxbzlcV8ZTFfWcxXFvOVxXxlMV9ZzFemv5bpr2X6639O+mtZXfEtpcOWxXyluSnNTWluSnNTmptv1tyU5qU0L6V5Kc3LN2heSnNSFvP9jerSymK+spivLOYri/nKYr6ymK8s5iuL+cpivrKYryzmK4v5yuqTsvqkLOb7RjVoWcxXFvOV6vQ/W52WxXyvKeZrNxrF+r2e62DwfUDJ8zU2EWEUeElY05iTuW9vKGXdg7VxCLNXl/plNYwtwDCAnrZ3OHF4C7v8GmzQKMtV5ftb0FFrZtqs+gGWWuGQhqO3hNuBEvVmpnigp5FBNgu4hSK+XY5ysQ6PiqdMF6xtMj/huGVacSz4/KjRabUXR23OWyft5vHhvLPgBweNzmGHAj+g+yXonecNwBlu+0FOKdnb+Q0IArt2qW09Tb67lqcxdqA/HtWptjGaGl4Wis8h/hDnm94Fax8zl3vLiJ7zZY4IXu1yui2kpgYeB87SefLYuj942zURRh3WxLG2RQwddY7qkxa/9e8JYo0AVg+qAAKGKPb0qHuAEPdkuqGjvskNWJoV04YbeujZt/RID61OCNOiRHLzOWTfO3VRr8KOOy5hmnOZZFfv4Y54HdZGmpJ77FZwWwQ/pAP96vBNmhIqbtvJ8dkiwiAnhUL9KMQYgmPlYp4JKQsp1lp9jNKLgsIBkD/PJ10rRDtOaKalMOYWDaJeH/z9U5onH5RMiEYk3YAPaQEWFOyy/ABDYmwOuDmhZFodkT0FxeOZdrHGytRDIDTvFTD90Kd3Fo/kDnJ34YL6qRFq8Ys7oYWPEhCMn5jEhoxG0sFH6qxbxctlBD+29qXslrJbyu4uspt/OdG3Fui35Ppsubrg0tM/MY3Gs+D6BELF3s3vUP+mdlBqISkTQLtI//gw079xjUHbz2vKAfh6/pEy5QXgu/F65DaBxvQna4EAEh11LAA0kbBPCe4EYiKUItVBcba3WAcODOptcREjPO/Z+BFtvoLIo00+ByfZ9oX0vjO/A67iu6QBKbht19a+44WlJ1l6kqU1Kq3R38calZ5kKbul7P41ZfdJTzKGiqRF+0kyWq14sFGcpt+rumtoYALXIjm4vjO5tWlvBQdjsY9VyXoOlXmrOW8uji3RtnnbPjroLFrWUYsfHjePm/N267iStvVXiRzHQpaVqdR6q3UkEoMThwcdkQfMJUPft7PhPyBvIBao1ihXz/jNQHMg6XXsO7Y6Rd9x5vsYTN8YD0lmfEgvoRHqNGi7wrYm30BdAKMq/UFVOb4KVDsrAaNgighznZVDwotYwLjBptZd4MmTEhTDZPEsKncS8EBNgBkrFMTlDiZmLtDngxHIg12Cdv6K3qleot/lybMJYjxCjNngsyUECnrsuR9ui+8OAfgAdcRULfAjgV612+EeMECcRRT7naV/XvrnpY0vbfzfw8aX/nkpu6Xs/jVl9wX+ufaGHvfPocHO/jm0rTdY7Eu9pdydP9pNJ1HREBB7M9+iGw/txAenPAh4iGnzOAkm4/cUK3cjvBj2quLY3ikmytciDxw365OwT1eU64KayLzLvbl+uEbogUcR07VPKURrjgNW9rGDrODE6GEq5KLAhVe3YbiWp/v7X2DNYa0f6nzt1E1ZquffY13b/hwIvUWHYbKBkldswLoXQ71HqdMqBZQDr7QmDa7WTGdVVSSsHcWXnxzZVCls/Aj0JA1Txfx/zZT0GEBcw47kO6nvaEMaF/ADvC4D9+H346IGegSXbeR7cjZozwDSHIqIwnXCJ6mMswK3JCYJt3ytwmRjbNZibwQPMPOPTkG+/8eH2Q+6KiGpItD3vHF2ASxCSrFrTgQ+qXK08Dbwo6Wq7u1mzlxQCNnCBYTZR28qBLtKF/VMQL0TSbGTII2Cva6/N6tjY9kaGtJ6QklkPGD2faDQPs/0+4GMJu0uUlUD9Y9ejfWpCMNB449tNIrqKsSrtcGLp/B6LRD/ZUarqdFqNJr8IQeFIu2VpXJ4LNAEOAR3JVHr1ZOr8Wqp8Wp0hV8NR83DgJTQcGRPyiyzaq+GIzNeDcfLwvHR+6AqrzPdmNJTpppkyKxb35fivxlD1kExuFpGIEWvBosyvmokEbVWIwVSTU1Zc2rgXxJ8IxAMTzETn6N9J/fGB8/Ps5VI/otWFmT+X1TP868MzvT4CswwtrR9S74aZpywhhPWlA6QGn5l5ZCxQLYRB5X9SwzQS9afNIEGNKX31FhbtToNv0990DRYACqNIten6stpouD0J0YvsHXcBtQwuufx2SHHsiE1Fpq6DLFMYCFPwSK8rg8WNkc3BW8c2EKr+63hixh3k/gLXiT5tbX0I5rk29G7f5LGKzXN31HTaIcZ45g6OvjGtzeDpOoPq3yf/zUHU62b+pWFQvSwvNg/dbF/8V7/VPF1iuZPlEjHNI8vYy/euH6lF/DZi8/jYphC8b+eZOtV3Nf527WvYnSydfspjJ64UDqe7Pdf/Hydv915a/Vq9o7d1I1RyVVN2ZuYkvsOkst9CtfrpG/X2eG2mtyVMztdhJK+VuuqhPwPgfzhGv5l7/24+grSm713IHPtQOqGgOvnC+sLhdlx7bWKlGVKo9WjR8qUi5VvpjJkez2ZHixfvnWVr53adn1HumRnx1KZ66fLBovQx7+Psh18/foPhT+p1PnaRTHAgIYvdJgw7bG+0cGXonmW5noCeEuONwXauBVSYDZTAIYDgf0N0UUlFx1EWtCxwFpwYrAquonA1+hWA32Qy+jKAxhoSTcrBOB/cFdXMNHBtZlZ3dCgokTopKl7f1TBJMxl3XJvKersA5h1zwKZxygtpl7Cu199Ha6dguReoJfG+sZzY7jukYflawA2WGJwHZ5z70D2wFkgYli+5wlDC7rQiMW9jEuOfiOiQKWlePn8eKGNVMqLe2YucOKkPm4G0lMVrFIFCSIT4RLjY7tsDO65scF1rN0Kd023dABYnhSpGd4PZ4URYTBPKda6Hyz3dSe5j21hEIx1KvY5qDfrjRrF/vDmO1+GK+6lBu/RquvfBcgz35fkeF3F7nBLpW7gwLvMMLgKm6BfYJGpCFUl0+pNHC0ItK+y8eTsptt/PzyvMry+x3yGHRV9nV6+oScmcwMYAdcVt5ehnhP3eEMvPsrCU6JsVzy9wKtILIMN3baS+jkQz4S+1tpPotQC9FJzj2W6+JJw4EwRWl1GkZlWX4CS7wENV1K4d3jx1UcPDyHMPVrJLUAu/RhafAiW/gWu+HKVVqPRSH7LAQYbqUtMUo31dSVzoX7yIrgT6uyf7hdBzCkAXmfv/HtBBZOYwOKJe/Uc61HvwdtXl41sWLS21c8s+MkAWyfTiS3YMA9k4rFiqHZ/jQeVyHqRCh2rwPxVRQXmwRu8xYA9PPjyBQ+vMFL9gI/BduDJyNV1EoTGbzCQOsQiK0D+SEVnTdT0fUj6lKSYDoKxcdVDHYw92TZ9poC/8QSNsc6QsmXUuUvA7+Eh/n9a+Qj/cOugyISN6PmXijnFhDZqXBMa2hYZ0R8QzYeH/wPDQ93/ +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create a Role

+ + + + + +This API creates a role. +You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority 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 the ROLE_SUBADMIN is not associated with themselves. +The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. + +## Request + +

Body

required
    owner objectrequired
    + +The owner of this object. + +
    accessProfiles object[]nullable
  • Array [
  • ]
    • entitlements object[]
  • Array [
  • ]
    • membership objectnullable
    + +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 objectnullable
    + +Defines STANDARD type Role membership + +
    key objectnullable
    + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
    children object[]nullable
    + +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. + +
  • Array [
    • key objectnullable
    + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
    children object[]nullable
    + +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. + +
  • Array [
    • key objectnullable
    + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
  • ]
  • ]
    • identities object[]nullable
    + +Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST. + +
  • Array [
  • ]
    • legacyMembershipInfo objectnullable
    + +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 objectnullable
    + +Access request configuration for this object + +
    approvalSchemes object[]
    + +List describing the steps in approving the request + +
  • Array [
  • ]
    • revocationRequestConfig objectnullable
    + +Revocation request configuration for this object. + +
    approvalSchemes object[]
    + +List describing the steps in approving the revocation request + +
  • Array [
  • ]
+ +Role created + +
Schema
    owner objectrequired
    + +The owner of this object. + +
    accessProfiles object[]nullable
  • Array [
  • ]
    • entitlements object[]
  • Array [
  • ]
    • membership objectnullable
    + +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 objectnullable
    + +Defines STANDARD type Role membership + +
    key objectnullable
    + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
    children object[]nullable
    + +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. + +
  • Array [
    • key objectnullable
    + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
    children object[]nullable
    + +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. + +
  • Array [
    • key objectnullable
    + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
  • ]
  • ]
    • identities object[]nullable
    + +Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST. + +
  • Array [
  • ]
    • legacyMembershipInfo objectnullable
    + +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 objectnullable
    + +Access request configuration for this object + +
    approvalSchemes object[]
    + +List describing the steps in approving the request + +
  • Array [
  • ]
    • revocationRequestConfig objectnullable
    + +Revocation request configuration for this object. + +
    approvalSchemes object[]
    + +List describing the steps in approving the revocation request + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/create-search-attribute-config.api.mdx b/docs/api/beta/create-search-attribute-config.api.mdx new file mode 100644 index 000000000..9176807f8 --- /dev/null +++ b/docs/api/beta/create-search-attribute-config.api.mdx @@ -0,0 +1,100 @@ +--- +id: create-search-attribute-config +sidebar_label: Configure/create extended search attributes in IdentityNow. +hide_title: true +hide_table_of_contents: true +api: eJztW1tz00gW/itd2ocZqPgak5C8bJkAW5kKCZtL8RBSO22pbfcgd2vVEsGTyn/f75yWZMl2CMOwc6EEVWBLp0+f+/lOW7oLbKJSmWlrjqPgMAhTJTN1oWQazsdZlupJnqkja6Z6FuwEmZy54PA68PdFRSA8Re4ZBTc7QaRcmOqEvx4Gl3PtxPjtsZBhqJLMCWmErBYbuVA7zUuRdkksl3wLdyIhRaxdJuyUL/U+yjhXIpE6FdI5G2oI7eiuTJJYhyyGOH7pRGbXNnJdIY4zcavjWGRzZQRY6QjL6ZvQJslZvEiEhUqq523ixah4JaldWN4mrOsODszoRJsP4mzyiwozb5vuezOGNB+w463O5uLs/F//Gb98c3wqZJ7NbaqzpYCRUvXfXKcqIsFDyTJ603VhfrqpXPbCRsvg8C4oaYPDLM3VTgBBMmUyulUzQ+8XRz64C1w4VwtJn7JlouAVy+KBL3RBEGRaObpLVqpROWhsyPlNl56SZ2BwUtao25VlQKk+yUUS02LceSN1XAVKcA8+3renX7TN5XwtGB7d8hR3aE/R2LRmkOq622aL5vZvZLIeVTriSIAQ9eCrhUa3Ls5dMAwPBs/7zyf7B9NoOBoO+4N92Z/sPot2+9Pdg73n2EWB1i6VOs0XE5Vi+QNr9vr957Rmsrnm/h5KZjpjE2xP3/uGWN7Lmw5a8882c37GmoXge3uDvb3Js0m/P8Cn/XB3qKa7A7m3B4YLMFup+BDlfkl5f8+qpcol1rhil/6Q/mu6asylBY7oiHOV5anBR+2DpcgbcSudcDnonJvmcbwsyhERGuQbkbqly9SCXPiV2eTFHfX7mxIexRoMxas0telnpJwgvakUaMOl6XfIsp7Zkcpg0iMbfUHivdZGdWap1CShYpFDLKS691FHWCEWNkVuMssyK5muEf9kie5AvJAR9PX6HRXKUMCmMvwAXtR6HhPoymisF+USysMphHpgW7Wv5GSvfzAcTfdGUg6fjwb7zyYHU7m72z94dnBAu6MZODlrlAGZpnK5sfW/lFGpDkVsUZL1rzAIOgJszwLw5liiETdbK0rTB8zjCwufp63ULOQVmfqUoV+KF0dvxWhfxNLMcr4uZ2tGMJ2rC1wxCHY5oUvUKKC5Z3yW6pk220RRJl9Qn3/56vX46uQSV85f/fvq1QU+Ea+N/j6mvhdRWEJUxMLc3rLEhQKcdyqGOVTUFU8Lrk+hkDSuTqhdLQkRW1OZxxlWFLtvWVFnLaboyY1U4rz5lIkfdVd1d8SEri1kBugykQ4LrG/WT33t6JwUlnwq5kpGKn3SFeMo0qSkjAVjDof1SzASMoq4bjCDaY5UVtzYbZ4JA2AQNvtAzZRNb6yq9kndKZQckPzxOBmHWQ7hWM16FlbRUohY+Acye8s1pbtcr5JLk8kQWkgqk6FNU1hYoMwLDXhUlCNyl0PhMSVdVbHqzYjL3RsvzMvM8r1Q5u4L8u5tjPLTYdWqGx9VkXyM7Xw1Ym+UbioqUlHPeXFBVbmrTHwx1SqO2txtc7fN3S/M3fWb5wUuK+4y9BlsQp8rU0w5v24DaClHj7HlKPSrR9rekTsCBikg0k/vLosZCvTqU0LTzzfER76VbyLLyh/++oTgR+Wshi9IwGKgJA2mqEQqOmS5VxJ7TMum2t3c7bVNJxoBarZARFTNVCxtLiRMlubGkCTS7YjIKmd+yMRcoj5KRri+AtKuJuokFgi3RZItkmy7UduNvp9u1CLJNnfb3P175u5nkWQlFWdLgZNcvljIdOkjrbjPp7MCBKI8IRRVyrGr1tEKMRMVxgqayCGYDAeTwXQ/VKNIjqK93YPpMNwbymf7g/3BZDTcD+q9/nqVx1WSNXOq5m/vRzYxQNxH4LjcILhcZm3UPP6DeVM1pbLGv16UuBk2h0lvVthxtIkdT20G3cAY2DF94Hjx6vyE+GNrZk92s3kaKoLZ3nQglxlDSophWFq7rIWOLXRs20/bfr6b9tNCxzZ329z9e+bub4KOo8eg4+g3QMeRIIg1JYj1Z0LHCLiDoNlU86MxYQ7zGoKNCVTBp+L0sUj7TKYzlVVAr4EihwebKPLSWvFGmmUJllzjJNKszEXlDbQLok1LWhBIMUOJNAJVSwPdUlTphSJMSs/RxHqhOY9JIfBNl53xNINWPmfKeKt20SaMc0jIRSG2dPZqEWMa4aSmBP/Agc9BZyjU3/CMs/DW7zoPFuek8QlpLF59CpWinK/Of59te0rgGMKnVC4uvK8feFzAn5lLgzFCfUp8+aogaAvVW6jetvu23X8f7b6F6m3utrn798zd3wDVCzT0MFQHwRdDddB2+6LCUq8puP5wxM6pUkjA4S1syFg9WmFwxhUIJRIosXzQmshsjm89GYYYNDLXc/w8b6d6wrgTlg/k+3nAi5enMVbNsyxxh73eHbwGb913ZaK7KGZwXLY09rYb2kVvAlNtqUL00KnPOCLgB/b9Bl22c6oplH3dY+be6qwZBS2sz88ZfJZz+RD3ErOI8Gx2BMK+CCu+DBETzBQ/OKbuchht6Ae9rtL4/vfr4hk9oMs28312N9ALSLqmIqlwQ+6C+8GI/XUFeY580Rrn5PHrmzrNBYF0L+EG5arx0M8Dww2BzohsKF4gbjBB+Cdmfvzp3eUTMSNoyqUhd4SKlaZZAsn1FmHEpW9cPj1Ci7gbpTafzVm5ceP5HEo1MY1hFPHeXCglro8LQ52iJ5yjiLPZaZHiukGrbn4sPRipjyqmdtldWZuCU0emByv2ZGPdE26NPENog48Lvtp9bzripaaKpanFE02hIo+E4jop9ZI1vb5WiH+U3DqeW4e5uSdrUnjTXof+ee8Q+U4sZOzYWl+9uefXqfGjgQtXiOu6DGSJQo7mU1Vh6bWvlqPBr0P8mnK8N+/mGn23uUz4Micc2mYciWMRzq116p9CUOhQqlzPcmTaV4t1S5t2OCM6w35NpI7fsqM7QJEs3wkSw/hgkhPq4gxirD9P4bT9mT2LuvAzv+3xc0NnvnyNZkuUkQ3dV8tMG3Zow46vE66Q3/cyCizkNunAdcAHwNHK/1wJCkFrtdHz2lr5mX2P11D7CCEqc3HJof9yuCqCxSfBN4i6okGpJhBePWdGLyoVvKihNYxVHh+sW3BT3tiij67Zzctb/QhKvfWvpi9pPF6dspyZePmtq/QDleSvU3f/pIrXVprvsdIUsJhOK89Xbzy++oPeXfu/v6i3E1AisUGLyaievi8KtLp5nun4FVX8i7tchXi2wOTmXyglfFZnBDtklK9cr8K5VnwSkiiZEfLdoZyxC64xSWqpsGHeZUYzft01hTMkZlcdgx+f1Zc7Sy4FHlbzO7H47vLiyRGLZMNkrbriHYZTgwEmpcGUnlnGvV9sMaFewCtvKWTFyzKMAScXi9zQe7AQO18IiWR5JNbh7jD3JRkjkVGlLSyD2mpVWZ8oiUiFLo9o6cKdTemQHfN7LaQf2QsR7YoTdpi+Fo0rRc5VzOFFdM2h5THeyKPOXMUJjcYIUkDLery/Ob7c4AhmpvhZx6azXrHI9YgWTGg49OGz2x10+x0elnCdJk0M8zXmR+uvO2PYUIbOPfz0uXq/lX/iqUVadz1U71a/P7Rvfn+bN78LIEETYC+hU05yYu6nVn9ccB2UxwV8LLD9wADj5ZzOGEB9d0fHYjRB39NllFk6c7m+WQ3HPJBiAR+P8cT6QS19pJBzO5dLRknF+cvmD000s/sV/sjts7Q3tWOQt2d0+BhMitfcF/5EJ5W3uEj/Hgbv8RdfbOLTDER8/S4oz0dB4/nSn/8BUGCsgw== +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/create-segment.api.mdx b/docs/api/beta/create-segment.api.mdx new file mode 100644 index 000000000..2bad516b7 --- /dev/null +++ b/docs/api/beta/create-segment.api.mdx @@ -0,0 +1,101 @@ +--- +id: create-segment +sidebar_label: Create Segment +hide_title: true +hide_table_of_contents: true +api: eJztXG1T20gS/itTug9JKGRsYyDw4a4cIFlvEeDAXOqOULdjaWRPIs1oNRLES/Hfr7tnJEvYvCSbu9tNKUkRLM30dPd0P/PMm289nYqM51KrUejteUEmeC7OxTQRKvfWvZxPjbd36bknxrta90JhgkymWAdqjGfSsOHpiNmqhnFmbOEO+6j+urZ2rHOxt7bGnAgWikgqibUNS/ic5fyzYLlM4IdmaaZTPgU5+IHHMZMh1IHSwnQ+qiE8/SwUu5H5jJ2cvfv38OD96JjpjBTgRT7TmcznDDTKxK+FzESIcgIUlDs9O2AVvhQmf6PDubd365Vlvb08K8S6F2iVo/nwiqdpLAPyz8YngwbfeiaYiYTjb/k8FeACPfkkAvQWai8yVBbfyrBWxuSZVFNv2XuidNcLw0YHqJ34wpM0xkrdqNeL+nzg7wS7A38wiTZ93p+E/s6gv/W6G4nNSSi8u3VP8UR8bVuTwkgljGFYudmsK+R/mf+G0m3HrjQm0lnCwVFeCCV87MSVrVLv3syg5/KFDthLTnSz+X633/W7Pfg37nb36F+nS3/+heokOpSR/O/oU8r+KoUa8r+uEzQ95jGrFWq2TelVapiJNBMG85C5vtE3SmSrQlEVccwnKMLG9LIWVJXpyGaGrdhZCmIrd9kqoYoEgWF0cHg8Ho3/uQwMJyQf63UYWQGOjUOWFCZnE8EE5DC8j0WUM1QWs9iIHPP1RSn0BdOKSZUW+TrTWPxGGgEAM+h22RsesjObx0xkGdS+kSAF/FPEedOHlY7gsOck5chiDuBI2IyDYLf3ussH2xHnoRCDbm87mgxEt/c66He3N3efn4o/FQlXPgR/iH3EQmnSGKAQK9secd3TYaOcQBIc1vCUTmQOiQPOAXecnpyP8eHpcLz/E1SJ0JHrTObW2ZARwYxkBkWWYRxd87hoNgSxWFfid7nbFGmqs9y7A3eAG+kZBcOZiAS0H4hqNIES19LIiYzB3fuA3SKTz0BW8QXzwDQT7oGydnzT2dOdcuJKMkAR8kytmUXAD48P4NPh3y+GR+cY9Au73TOwiefQwqTInxEJx9jlZYOLenW5sbYDEHkLe+5pox/K2hVQCCUwEqqmbXA0FDgfn42O361q/hHBjwkcQlhK1QiQf1AhHG1mMg4hSmqt8Czj86VGjiSEImi+6CUDZSCEEvNDO6gqdXlVf3+4CNZGteX0wgANcnld13OidSy4WqEoALd7CWATIhcCjgdjJ6H3/eHc4ks8Z7YBwCJlfytLGTbj8ElpJqLIDThACDmAiLcX8diImoE4ctVtKWnp3R0+BWtT6HPbn/1uD/9rKl8yzpLAtMyuZXYts2uZXcvsWmbXMruW2f3RHNQyO8vsAJWWydx+LFGXQ0IoHxArLzKFOGmxzi3pgUUhrf9JBb6XNNx/J9IXipzLeF+Hz4iCt0DA/GnGJWpoQTWAiri8eS1DqAF8JIPRgUSWcE3lmoALnuj0Ggi974xB52U8+AyyRs8Y+C6UhPqsrALj3wILl5sVO4JPtru7/UG0PeC8/3rQ29ma7EZ8c7O7u7VLw2ECIcmn9Zx7IJvfCRggZMAQ7GL5GzgERkfwPSlAjT8/uUnGM7PQlq3MdPqyXHyBEZSzN/unbLDDYq6mBT3n03tOUP7F+RLfAsut4JNMTuVKWliOJweHb4cXR2N4cgYDyOE5/IaylujUsMo/Taxtpm9IY2fADUeaGIM7gL2yNSd1DQziytQLSvvJzA04k7ncgxqu9RU16qJZlOmkkUqUN19y9lJ2RGcdiErFOCbcQAVtSfbaMAhEmvtHzpNrbAbsR2SvOmwYhtLRYEJCUzIeHoaW4qCAqIBUFrSorwsgQjqXwb15y8KV99lviSBH9U7B5ADNn46TYZAXoByZWc/CKlqciiU+hs5z95n8wmnk0rnKERxx32EObgToDACZwDYJMOngiBH7B7JYlqsQq4H9qM17q8xBruldwAvzjLw7jQF+fDKtenEtXPIZt9kCaES9IavZCiESvESzqbIrVXVXmfiW9be52+Zum7vPzN37L8/cEpZ7S9RnxTrWhXJbmzh4LlGfjKIHeFdZiOiN68h1nD06ivTzh7HbP4XywK1xy/M78iM7lC8pP6z6wz6fIP2oOqvRF6gg+dFaEAESiXCP9F5oTI6yrtpcbu2tziYSAlStoIiAmhmb64JxcFlWKIWacLPOQi2MepFbAsshI4yxCIitqtBPtVR5yyRbJtmORu1o9OOMRi2TbHO3zd0/Z+4+yiQrrShbHE8yRZLwbG4jzb2n1U8GBVi5mcqqlKvWO+tsBYWximN5TebgTfq9SS/aCcQg5INwe3M36gfbfb6109vpTQb9Ha8+1l8u8rhKsmZO1frb9qPbYsuugccVCoLL5FqHzeW/AvfSIoQ1OkFY8mbwObj0quKO/d1l7jjWmr3nal4yJNPgkGrhI8Q0KJtg2awsS/s1U8BFxQCqJOiFoYTbkT7L8EBjLBNJyYtWgNxs7g+jHEyxiVIGWdWKVEFcgIaEBLFG1qwhsCTusUXI+UACMdgpoPN3ZKeui34Xk2dnaPERWswOvwRCYKJXzH1r1fruCJTPECPObQc/sNBrZztcQQDAhMBiVsU7W37e8vN2jG/H+B9jjG/5eZu7be7+OXP3K/i5Y0MP83Mo8Gx+voUH2FjFpd7S9vv/mqZTqjgNKLyZDugAQbjg4MQrIJRQoVQbAhGez+DTRnmgAB5Zsm/VKLIY3s7yPDV7Gxu30DvQK3cdnsqOuyQ0V/qmE+hkYwIuWX3gwWUfFqA7Q7aBDvkzkxiyFt9IuPWuO8LgGfAyrQQ/Krk86DXXBSAaiVnHkyYufOgxqJjC3OFFeUITvbFkH9h1kcV3v98WK+gBW1a579HWoDwDTe+ZiCZcYXdBN4Mg6q8L0GffgtOwwJ69vKqXOUcybjVcKrkYYHAC119S6ASL9dkbwTM8qkJ7Gi9//jB+xaZIQQkC8BDstDyLyNkphBFB3LBc38dKNOpkupjaU3TDxg4KphSLYnAK+6jOhWCX5fHBY8D+MwBrcjtWEoQPWOvqZdmDobgWMQ6LnYW3MThlqDbAixu8Ue8VDYE0V5DKHnbFE6Mflc8OJCIT3ZfDMs5Emvqxy7S0i9fs+lYl/lJK8600n6SZV/e0sK69DOyJnADyGkXw2JC3vrlxK8+vycOJFTxBqfd1QE84PZr7XkHZa9+sR0Oej/KaenxUH2YSxtdmNWbhjBkYHuOQjVgw09qIvzGGoYOpcjktINO+Wa0bbNSnjPD73ZpKvm3Slz6wRdLvCBJD2WDiExytiaxo4HEqtGn7C/Us4MIvMJcO2S8Nm+nxJQyqWDLUgflmnbFBHxv0LU4Yp78dszCwILfRBsIBGwD7i/4nJHCK1rDRylqJ/CR+g+rg8BGAqiTFpHv2w94CBN1vjF5g6aoMQDWS7WonEO+POlk4cDWcVS4T3Pfgsr6xhvHynt+svtUyFY6hfzR70eLhYjXlRMXz743SDyDJHwd3/0+I1yLNj4g0jv7iquTZ4iL6YTlRsdeLnndDqLyV0LjYU7vX8+gFl/qFmycKruCDD9xcWb64Ut3RsFc0nr5rsTCqvG7w0F2C5m2BxX2A8sB+47z+4rT98mFud8y7elEd066fWrensssD1m6ZAUGDBLnZXh2q3jhmvrxGi5sIM/AaviXEpfkSiLZfbYBctC4ojXmO2ETYDAoJWt1JoZOR5a8jPuiE8DTNNII4HuRGQVMKhAwCj8N8nPxH+w9ly5xgz04hMDvxsyloiklfnDDjaio67ANMuFUAyYWTbTxBA+8+aTfrPof8OsX0ZAdlygJ1TpJC4UUbULtIGAdgeCKvQ2mCwg4/MPdWovQFXVdhVa0SixEw0IQOTTuzxJxEuHEgA1FL3yfaguw1btcAXI+96AJvYciZiClmsFxzgvaUbMAMfybiFGMIxk6g0aLWwvvReEkiCFMG7ApER2fTDVfJbGBZTAEw3obPZqfX6fo0MYTnOHtOuKoJ36deZ4tv8bh3j63aJvlTfnmHS1mcLW6kuPKJTijsDNcuIVx6pvZ1JTNcXYBnt7e4IIZz6jt8DMCLqy2XV4vpMqU4VKCFMZrDfha4ION2YvzxnHhTiRFLW0w4i7c17GLbo2WvagsgeM0LCk/c95Ekdi0n4zfwEH/ueR/hL2JraoMRCtHzW69cGYUyVi7++Q/H3Tjr +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create Segment

+ + + + + +This API creates a segment. +>**Note:** Segment definitions may take time to propagate to all identities. +A token with ORG_ADMIN or API authority is required to call this API. + +## Request + +

Body

required
    owner objectnullable
    + +The owner of this object. + +
    visibilityCriteria object
    expression object
    value object
    children object[]
    + +List of expressions + +
  • Array [
  • ]
+ +Segment created + +
Schema
    owner objectnullable
    + +The owner of this object. + +
    visibilityCriteria object
    expression object
    value object
    children object[]
    + +List of expressions + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/create-send-token.api.mdx b/docs/api/beta/create-send-token.api.mdx new file mode 100644 index 000000000..682d552f9 --- /dev/null +++ b/docs/api/beta/create-send-token.api.mdx @@ -0,0 +1,83 @@ +--- +id: create-send-token +sidebar_label: Create and send user token +hide_title: true +hide_table_of_contents: true +api: eJztW21v2zgS/iuE7kNfYNmJkzZxvhzcxDlkL9nk4uT6IQ22tETZ7EqklpSS+oL895sZUrJku003W9ztFkaB1KI4w3l5ZjhD0w+BzoXhhdTqJA4OgsgIXoixUPGV/lWooBMUfGqDg5vg7HjIDrUqjE5TYYLbThALGxmZIy1QXs2kZcOLE2aBmBVIzYz4rRS26AIbK6LSyGIOrB6CaysM8hKfi2FZzJC9jNVBlvADpA5uH4G9J36nYyB6oEdpBAhZmFJ0ggjpVYGveJ6nMiIlep8sSvMQ2GgmMo6finkuQD49+SSiAiTJDapcSGHxbQmiDFPJ6UGVaconKUxPeGphEU9rCyPVNFhWGdVgHIlZYnTGCqRlNi9+kTGIBtqyRIo0ZopnImYv8L8XwEV85lmOqwT3Mk27PJ1IFTwi91TeCTO/olW/QRyhygyNNz4b/3Ixuhyf/zw8heF/n58cjpoD+P79+eU/63f+YXQ2PDltP9RUqw4ml1YyMpKlqUuD2eNjp+Gvm4aRl5SERcBMRF5j7tL5HQ1SM2/5qWm1ZaO1pXBy2Fwr67zd39rC/9YpRrC1BS9Ki3j9TvDyIMbYelhx38K/DtLLASXaYcROjloG39of7A8GyfYO3092Y763398dDN5uD7bf7O9N+GSAFnQKrVu8xs714eFoPIaRY7Dc6GjV8WPiwXRCNgJqJ1ZLlooLOs0Ybc6EtXwqfr/WI6RmmSOv4mrhIG+K1trXiuKu0DilYJhVKgaExDUIc5BYgljDV0/bdmHahgXbqgcegbvrQHeYShTWqRuyS1GURkGSkAkrwPGVyyeQ/RgkVqnuINHE3xGZsSi4TA91vNZJbWGPpRLh1HCJEpKSLAJCBhzvJCEi00YwxxKBgirQvG7LU2CJ7jZ7x2Pmg5x2FFQG3WR49CvwWh8rS5lXSaBnFQmTMUtAqC8sK/YEn7zdGvR3k7e7nPf3d7f33kwGCd/Z2Rq8GVCgVIhrrM2N4fOVpf8hlDAyYqmOwCP/EYhJDrYnAWhxIJGFyOzTPiAe32B/TAVubq2ml5fQ3mGcvTu8YLt7LOVqWtI4ny4ZQYXX45XwA80d43Mjp1J9LVEcjY6H16dXMHI5+tf1aAyfkNdKuhgqQGuMsARRAQszfU8SewXuYbe0IgVziLjLXnuur0EhrmxzonRPdm7BmICthJdpARR+9TUUTdY+czRCKXIFB3spu6LbYRMcy3gRzdiEWyAAF+L018MoEnkRnnpLvmYzwWNhXnXZMI4lKslTBtEITIF+DowYj2MMXccgKSGUQRhZzHRZMKULGYm2LxamXE6GVa46bToFgwMkfxonw6goQThSsxmFNVq8iN4/ILOzXFu6q4bRyKRzVfAItOBpOgczGgMWZhPQTRaW+XSE7rKQeFQ1r85YzRQ8aiTIo0LTu4iX9hvi7iKF9BOSavWLO+GDz2L2d9mIvFG5yWckeIlqE7GfVbtrsdVgqbaJ3U3sbmL3G2N3+WVVV/m3VPpsr5Y+UK9B06cNbZ4rpY8h9CjNqklU3nhHdhgYxJdIP72/8pUhzBefc2w2vmN95LbyFeGHtT/c+ITq4cpZLV+ggGRHp0ECmUjEByT3QmIylDPVzupqx9pMJABUrSkRsSNic10yDiYzpVIoCbcdFmth1YuCzTjkRw4RYa3LgLiqisNcS1VsKslNJbnZjTa70Y+zG20qyU3sbmL3rxm7X60ka6koWnydZMss42bukObfo7acwQRWHfqyOuTIVcvVCjJjdY0VtCuHYNLfnmwne5HYjflu/HZnkPSjt33+Zm97b3uy298Lmnv9zSKO6yBrx1TD386PZGIo4u6gjisVgMsWWsft4z8wrxEJpjVMPXXdDDYHk97WtWN/sO5YW7MzruZVhWRbNaRa2AhzGszNcK6p5sIEzqaQFxWDVCVBLoSSzARwMQAalspMUvCiFsDXzMNhUoAqLlAqkNWrSBWlJUhImSDVdIoMwJKgpEiw5gMOVMFOITt/x+o0W5xEP7uSZ5eo8SlqzEafIyEw0OvK/c26890TEN5gjhg7B3/hoNd1O1wBAKAhcDmrrjs39fmmPt/s8Zs9/sfY4zf1+SZ2N7H714zd31Gf+2roy/U5TPjm+hzmdrdYXUsdI7j+52U6hYqXgODNdBSVho6bqxqc6gqAEgqUa7qgkHO82RT0soT36Jy6R3eb8CoUVoROmNKkMGdWFLk96PUewEfgm8cuz2W3ukOk9H030llvAoZZk3PwcoCLL5zgb2DhAl2yqpEIXJfliLmzMemBEAVb03nwVznjxSV03lyXkNeITQcvAHkQ0TCImEMH8cLS7C6BZkU/0OvapI9/XBfH6Au6rDPfV1eD+QwkXVIRVbhd3FwbY7ntVl+5v7bYQrBF668sdo7T+uyd4AZ6Afetxcuf3l+9YlMsMinIS4v1rZDYFUCYXABEKIkNqxN8JKJ9xehyOiPBh63vSDBoWJKCwuyDGgvBbk68EX6G7H4J6ZhMikSCMgBS3b6svBOLO5HixtddWBKBJ2PVAwv1eIvuFW1y1A1IBR8zGu1+UCE7kph7JG7WOMerSM0du8krvXhDr+cK8beKW+i4hcTNvlqSwpn2JnJ3biKIXGTBU0vWevbijl/Y4IetE4wg12UZ0BJejvY3W1HltWfL0eIXIr+2HB/U+5mEHbRNxlzCYhY2wDRmJyyaaW3F3xlD6GAY3ExLiKJni3WPi4YUEWF/qyFS6JYMZQj1IMl3CoGhHJj4BPdjKkc0VGoqdiH5kTwLMf8RuuWYfWzpTMM3sG3izFhH9tky44IhLhi6HGC9/G5XQmBBbKMOlAccAA4X/qdM4AVt5D3Ha21WJ/a96kKdjUBU4mLzA/dwsEhw/hOjFzi7ngNpGMvp+rs+eGaeF25NLWNVBwHLFlyVN9WwIy7ZzclbH0ThLvln0xc1Hi7OS85VOv/eWfoLmeTPk3f/Txlvk2l+xEzjC1w8d7xcXMof/bHL2dB+A3xJDd9ZNIPmna//Vs8D8cB6JuAvvKXYp9ocOh/q5agqajLKU15glFCWiGZS0ElCLjhd1u8gUnVGkQ1NP6YT6BeJ0ZR+CWHABBx6P5kCPzrrrlbmFICuUEWc4LMtqZ3BtaIZdKaiy95Dc6cicDM2dnhbA9590r7DG4OnLxAo7KgCDxRxWVYq+u2ANmXGOED0CYTF0kalS4TQ5ylR2UJTKVlTVVkBoYsqdKnFMZk9T/CQGvrfBpCeWAtwZP0JNZiefqwAVT92T7UilyIlpOO8dhvwFG9AbzgTaY4ggSwu8Kr2YoWzk6sVjsBMWdALWnhtpj1PZHs4F5hgu+Xgs9Pd7m6F1H7AOHZq0Aw3mB+S18mhdN+cLtlUMdNC4sPieP6p3774XQfbhV6Oh1u4dunaF9cl3gTQJVZ7KbWI+CuYTjDDVhLePjzg6Qe2To84DJyxtb65XXRF+ARc3SkItZa/Cuy+/bF7eOV+ruHb7NXvE7BZcxTuZOWrc28b3e7FOZ4xBRP/M53MNe6G38Mg/j0IPsA/eNC5QwPetMdx6MT94Q3McXyrWmXdVu0/oJqPj/8F1FBpVQ== +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 and send user token' (create-send-token)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create and send user token

+ + + + + +This API send token request. + +## Request + +

Body

required
+ +Token send status. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/create-service-desk-integration.api.mdx b/docs/api/beta/create-service-desk-integration.api.mdx new file mode 100644 index 000000000..ada8fa729 --- /dev/null +++ b/docs/api/beta/create-service-desk-integration.api.mdx @@ -0,0 +1,155 @@ +--- +id: create-service-desk-integration +sidebar_label: Create new Service Desk integration +hide_title: true +hide_table_of_contents: true +api: eJztXX1TGznS/yo63x+BFDa2sTHmsrvlAHmOKxJ4eLnUFaRq5RmNrc1Y42c0A/FSfPfrbmnePGNj2NTd7j6T3UrwWGr1m7p/ao3EYyPiE904vG1cifBeOoIdC/2VnapITEIeyUA1vuw0XKGdUM7p42HjKBQ8EowzJR7Yqm66xdiIRcFXodiDjKbsPJywkTuTigVhsZd5yuNoGoQyWjCpWSj+L5ahcIEA444jtGbRFJ4L5c4DqaJWY6cRzIUZ6tQFphxiytJFsnkRdhpIUOjofeAuGoePSwJdTwXTc+FITzqaBZ4VTWYUkA8zAtByAvhCRUiHz+e+dKjJ7i8aiT02tDMVM07f+v65B7p9bESLuYCBgvEvwokaywotaCM36hudskWfW1YQ1AyaTPGZWCK2Y4baafAoCuU4joRGA85D1FYk4RPwRf1KWljDBXZoMVQT/sRmsY7YWLBYSdBqKxn0sKFhTDWBz+Ibn819sUw1ZxP2CZl4WlLFC3jKNVzPwYjdi3DBFNJZRQ8ZMRQ25YBhc314p+5UMyH7KXi4Oj79WHxypyq4c4XHYz/K6NuuVapLvgIWgwclwkvhvcS5zrEP6Eu64LMwvVBZRXdIBC8zWUXn+PqcZEc6QsUzdMTT45NP16fX/0JXy/hPnwLn0t18hIRTdnrcKiik6ww7B23e2/c4d4XotTv73rgn2p0Dp9ve3xviQIlvbzaUK/Xc5wvj4EXlx/N5EEaNJ/QMGdEz6nUcBY2nL/DU8WEavNgcV0EcgjvZzq81RpFKpU2Ozm6urk8uiyZJHm5okaVhqu1x0Bvwgec4rtvuDDjvHwz3vaHX8/a9ze2xNNBqs1yHXCqgwP45KpjGEDgy/ZdNVJ7VR6lEzIN0FE1Xhwa2FQpgxoFkNF6wzOg7kKQiYAaeI4kxd74+8NBlTjCbQ8ex9MGFt9eHpm+LX39dDIdD0sc8FBDmMbJHYSyA+xlXfCJcI5quCE1GaafH+oVCgMfdSw2PgZ+jQHly0krGuhSaqIKAeodB/siknIpQbCgqD0O+gI8yEjNdtv5TWdycVm4Tv9rru51hhx/stzt9t3vQ6/fHPd7d66K6uk5/P9ekP9jPmgwPunsNNH9Zzurc/6bc8A2z03KRpGChScMOfR1btcbaYJSUQF7pOqeRNBoUZztkUEhOmvsfSf8VnnqVjv4wFcBAaIBQkQ14kHBiDFkwMbPgx7gJBCpmbAyfw2BGUgXhBPDaqcfIFkwldNy8PzAODgDdgwfh5kQbB4EvuAFZ3D1X/iIxaZrlPO7rvImLDp4fo6wAeAqOp5BdEC/l/DmHB88Dh48AtrCPEEkCYAshS2JMl0mPLWsf9UisrnPlFwZ6bxntVjL5yjSQxH3ErDobT9vx3HXjJXni6vzm8uikmCbssw2zBATR14y/nEaqpvsYpjvfPI38PQaXaqIb8rFvwepvYu3vl2zkROAl7BhAtxMF4aKYdrL1hrE35J1VpizHncR0xoPAPc1ktf7uvtBIVUbBKWKkr9I4hFCn3x06oHH4yeGQt9tOZ6+zl9f4Wg3nE/Wa8T4uWKIe1F4W6lODWmGMLCl/5BFOf0geAT+JcbvfgT+NhL2MMusA068g14U/VeS6BkGAdOpUyUhyX/4qwitSRZU1IXTA/zwzHy1dGfYHP0sJMNPr+cxgtbhmpMsYDBBNeWRisi7GfKlgjsQO+bYz5Woi9Hos8u6nbzMfl0pI4Yc3nVb7DSy3ncCFhj+8ubn+0Dx489OPd3fh3Z1695fj86Prf12cGCYubt6fnR6xu7u7hubSNyt0N3LxQfXThA51R93/gE9PDDNElPoit/TNewGTV1zkBMxRYezdcaajH01blm9s2HyYSmeaKANdF10YNKlcENT8TDabgczeovVuN081Hcr4x4/v/nJ7dDy6Ht2aL+QMVwssE9SYtfX2b+u/z3N5Ab7SGjlOEKvo0qTs39a7dZ6USF5MJ6kevI6Plw63zKf5G+P1FiuKhNWg/MdDmmGtiYiK7fTWNttmj4nVINlvLXXFPufzre0WfIScv8XKXBG3KW+tY+MxrECZLZPVRPZ5ah/Jy9j23xJKT9+V2RP1H+D1KW8uxr58+fHdrp0fd8rEehXkqSfWKce1TzaDQLhMS1cmugHuVYRLsylLaYbf48yGLhUD2JRKoFkJCGrkJgbBaqEioBAG8WRqwHQOB1Ti2udw7LzMwMm3ubSlpZKon1Egy/5cKLcA0anIiVK6O4Y5GByWX0ZmQANjkAVknoKWzTPbk3KCweYYxXzELGMTCSV9CSsGLV2BRVWBzMG/GPkA6vuBQvDLPY9URikLl3bSX1YJKQpWKTsNIDzjkXm0180nkkEeH12UV2BPhdrkSyp+WbcW+yekU9cgNxQswrJAhKoDxuwqF5UjkacZGHxZkjTrcteV+B33L3L5d2lJ+pgkZ1jaNO65HyO8+SqyTyjzuJSjMOu8ZMmwKnO9dnmwMhNW1Ysub86WACY92XANsHKo5ZpRu3cgxntuv+/0eW/QPxi77YHrOOODwaDXcQYHm4N9Ir+6UlTF0UiGEYVFskzeUcsAA5vYQtITgvoKyJ8rZ1NLJJjV521wCIWeg4cau3Xb7bLLu1hh8XWCn80+g1soT9ebDvWmQ73pUG861JsO9aZDvelQbzrUmw71pkO96VBvOtSbDvWmQ73pUG861JsO9aZDvelQbzrUmw71pkO96fD/bNMBKPaq9hWOfIlR5yQMIac12aWI4lCZRWh+Do8Dl85cSHWP/t16yWbDejhpNjaOAncDxX6AeNOchKbqI4hlgIG2pkDRaoaaNSQT1E/tihYATbQ67D13WRKVj6wwqPiQO1+B1ukGznVD+wws6cKkm67/K4YVA8HH++1ht+ft9ziHlWRn0B8PPb631x72h1QlngmtYcWfr00lC/3i0P8D6SOUDsRIhwC8C7bioHtigAavKHOtsAHR2ED/uDQ0bVMxLb+wSv0W7QBEfX90wXoDBpF6EtNzPllSgmreXOG6JvZ99Pg0VxnC56GcSFXFShIOjk8+jG7OruHJ5cn/3pxcwU9Iq3QCaYTLGxfdMrCJ6YE4tgI8cA0J1wd1CLfF3lqqb0EgTMe5htJm9YUGZTKbcaGHHb2iR550VslKphLNm28R25It0dqBVAjPIGPBAmDMsVSGS35o/hZgo5hHzTOrybdsCmtbEW632CjNDIyCvIb+VEOClEF7gkTAi2EqCzpXFcQRpNMIgkPRFpkqi9bIYspZ3ig4OYDz5/1k5EQABsknCrMw9RbLorUP8Gw0t1RRzymNVLqAbAnrRmjpL0CNYUi1CZBNRprZcITm0hB4VNIujVj5oErh7qNhxgRIiGc81hvMO4ChUjVJtPSLe2Enn05Lri5ZIzGTjUjwJYpNnW2r1FzJxGeeFL5bz9167tZzd8O5u/zlpX2bIg99OmXoc6PscVJMniXoE5L3wCIkaWQwvTHkDp5PtRDpH5+v7RFWXCGZBcx3xEcmlZeYH6X2MM/HCD9SYxVsgQzeZ6sSDyKRcA+J74xjUpRR1V55tA9BOJbgoKoCIkLUDNkiiGkJG8aK8CzXO8wNhFZvIjblEB+TA7pBeka3mR7SrZFkjSTrbFRnoz9HNqqRZD1367n7x5y7a5FkyhXNFouTdDyb8XBhPM1+b24HgQYsea+XpVPOVGWX0AoSYynGahSRQ2Pc7Yw73sARPZf33P29odd19ru8P+gMOuNed9DI5/rbbB6nk6w4p3L2NnY0V5uIEDcjYgXOpaMgcIvlP3rdysOwRjuRCW4GnbdMHdJix17F/kkQgWxAGLBjuKK8eHN5Zvan7UZnaF+8QZht30GgHReElOjDoGmpoxo61tCxTj91+vnTpJ8aOtZzt567f8y5+yLo2HsOOvZeAB17DCGWhxDrvwkdXekSNPPAKCCDE4N6FcLGOYiSvOiQTvuIhxMRpUCvgCK7w4q3C4OAfeRqkYAlXahEqkxdGN4Cekt8kXt3RQFHEwiRikHUkoBu0avkTCAmxXsKfTmTNI9RIKAbLpojD89hmDmT+Fs6ilSOHwOHFBTwNRUc94HLKHm1BShQHXQCgfo71jittX5TPZhdosRnKDE7+eYIgXM+rf/2q94SwPcJQgwXV8bWK14XMDVzrmAZIb7NTfhKIWgN1WuoXqf7Ot3/OdJ9DdXruVvP3T/m3H0BVLdoaDVUhwYbQ3Vo22qzFEt9oFe3/9OIfWROghIH5N4scAiruxkGByVoAQ8lvlYMg9wAxD8yrjyKoynOTOmqQ3tkrYlH1pocL+g+NAcnMRotf597Yzpp9QXfXp0J8FmUfB5QRXfOcYDG7qrOuoHMIQo1CohDH5pPo2iuD3d3H8EvwB+eWnwuW8lxfRU8tJxgtjsGY1TEOXNsCX0UG7DRxald0rTIkqGkV/tpJhBxY9fkmoT0DMlayskxtAWsdpghs4MvOlvHpcd0aFktklstyFFL8oFcN6H/9NtlMYRWyFKlvrWjQXsGnC6J2DAvKCe+dIUQ34xe8qgsbeHmQrc02Dk267L3god40pjet9n6x+frbTZBYEuBJdaIqYXElQhMzQtwEQqco+TdE+xEuSw5YiHYqPB2D05U5vkgMLtTV0Kw21OrhE+QUS4hBZBKsZOgqIO9vmwl1nHFvfAx2bYyTaLjwWTYBQ3t8kK/bUqstAKRyhxbwKMAeEmHOdOJ3k5trIi0oGS380QunpPrtUz8NaHWNNSaRE1vL3FhVHvrmLfFHYgWSIL7mrT16sENvWaOHi7X4AlSXeYBNWH5KL6T5SRWezUfBXpNpFfk4059piN6xW7MxC6mIen6LjtlzjQItPiJMXQdnAa3kxhm0avZonOBTZoRzW47x1LTDNmUTcCgxN8ZTAxlnImPEQMQBApMNYam5M9kWZjzP9Pxmp8LMtPjW/y9C9DSDRz9ap5xwCYO2DQxQFv+7QVG23TrDMpAccA4wFFmf4oEltFc3DO0KqM6kd+lPpgaHGDVnFOdH5oPh1mAsz8x+gJbp20gDCOET99So8sIDC1MhwVlJcWHZQ2W+fUDyMJLejP8pluomJl/b/KixKOsRoM3J3zvKL0ikvx+4u5/KeLVkebPGGksqMZa52X2S2ZOslN89pT/+jvJSkuvTe4PSw8Wlu7zyt/ZZdukF2MV7idYc69Vej9BeivV8vVTlnJyv1Px4oPVFzSlhAv3Kq26Oafyvpbf+R0Oa65wSK5YqK8+qK8+qK8+qK8++J5XH6y++MBUA5+5MmBQOiX/3AH0defPbUCl89w2nD57DDsNp5udo0aIR0PZil8eWL63NZLyPh1uJE8F/A3fUgSimhl3IvN76rBykCeEFzQhkjS/im4qBVX454ITMzuI5oIZoV/QFkJuvDUNCU3oHle8fIf73FxXR3vQycicQKop5mBMpGsiYvtGZGDjZot9FpQW4hALrngWB777JbCV1yuY6hc41QEcWIDFjoLZLFZ4lSWwHc8YBxj3DAqD2OzEZrHgBEqJRBcBlVvSXglyRniHItDVBiKc6XPPIpAc2HpmLMBa2u4cg+pzOCkT5FL4aVmwWCp7jjYgvOZU+HP0UFjpCKXzSOzj6XWJIhBT9nWFIJzs2k56F9sCEZumocNeCzJ1k0p0CFkCHQFAyRG3vxyx9KsRi7ht6f7ZdP/89/K7Fe3kxRre7hx3uVDY2NQUTRX3trG6igv4Z4oVX2j0+Ii7IVjWfMLHEHOw1H77JatY4icgbnZFCNmZEGO34ZvX5mphW3Yvv1+A4M30MDsta9vmi9IX57jn1BjbXwk5M4X8kD/AQ/z7sHEH/yGYnhuxoBE9f2wk22LQxtBN6ghVy2j7A4r59PRvPvhZxA== +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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
    + +Owner's identity. + +
    clusterRef object
    + +Source cluster. + +
    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. + +
  • Array [
  • ]
    • 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"}}>
    attributes objectrequired
    + +Service Desk integration's attributes. Validation constraints enforced by the implementation. + +
    beforeProvisioningRule object
    + +Before Provisioning Rule. + +
+ +details of the created integration + +
Schema
    ownerRef object
    + +Owner's identity. + +
    clusterRef object
    + +Source cluster. + +
    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. + +
  • Array [
  • ]
    • 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"}}>
    attributes objectrequired
    + +Service Desk integration's attributes. Validation constraints enforced by the implementation. + +
    beforeProvisioningRule object
    + +Before Provisioning Rule. + +
\\\\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\": \"RULE\",\n \"id\": \"048eb3d55c5a4758bd07dccb87741c78\",\n \"name\": \"Before Provisioning Airtable Rule\"\n }\n}"} language={"json"}>
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/create-sod-policy.api.mdx b/docs/api/beta/create-sod-policy.api.mdx new file mode 100644 index 000000000..9c14739b7 --- /dev/null +++ b/docs/api/beta/create-sod-policy.api.mdx @@ -0,0 +1,120 @@ +--- +id: create-sod-policy +sidebar_label: Create SOD policy +hide_title: true +hide_table_of_contents: true +api: eJztHWtTG0fyr0ztVZ2NixV6IRBf7mSBHVIYHCGfLwEqGe3OSuOsdpR9gBWK/37dPbMvSSBhbMfObWIbaXemp7un372z3FpqJkIeSxUcu9aB5YSCx+JcuW+VL525tW3FfBxZBxfW+dkhMxevti1XzELhwFCYFIeJ2LYi4SShjOcw9tZ6F4mwr4JYfIx7STzB+dINDiLl2jOCcXADY4V1dUewIieUM8QBMBhOZMQ0GhEbqXjCXosAUPQZD1wGQD2YH8tgzHqOI6KIveSRcJkGu81uJMzgzJdTGTPlsd06E0EsY19M4WfEPBUywZ0Je+4LL2b/ZKEcT+ItWBHwCSWnAfeugkzQK9Uug4H4I5EhYBkqX+BaZ4PXv/YO3xyf1oBvIdwVUfxSucCSW/oKgzN2OcidIMZbfDYDiLQHOx8iZMKtFTkTMeX4KZ7PBLBFjT4IJwa4sxB3LJYiwrvSLYyJ4hAwthY5qneNHR8iWuIjn858HF33Gg2vydv2ntNt2+2R17J5c+Tae+3m7n7dE62RK4gO7p4F/lwjfrdtBXwqNl50lEQyQP7hrPL6mo/2x/mfFkDVO76SGtiRKQdOWS6MsGM5FUurDSeC4Q12MxEBi1GE8q1imUC5ZQya9Wbdrjfgz7BeP6A/tTr998sqwqfKlZ78cjim8J+EZGnNdZt0Rh9AtQqXUZBjQLUg6iV8SD8N0iKIElQAR8FNyQOH1AB3FMQk8X0+wikGM3UDajwQ3iqhXkALRz6LmHRJdQmBstjr+WvJM3AOh2cMRxIhQTJFc3R8eHQ6PB7+jMYsJy67CvhuolqLmC4pWdPpNvbrvN3xOHeFaNcbHW/UFvXGvtOsd1pda2OFSpdyZTTz+XyFQp0ns5kKY+sOYJLFS2cdxgrXAWMsQthtrZqwEyIUsGWPEJMUQrr/YQqjjMh/f/7FjFglB/rOT4kI5+uXPhc8BGP9B45eJ5n/5mSqn0v3YAPbNt5ivdND9rhJ3hbZKhB3EH2O/gG9HNj/6BFcLE5njpnPnr+RsRzriynQrTKBP/BrAb5tygM+FiFw/1qKG2JJHHIA6JD+usKREXzQvg7uypBdWiohd5hr6qXFBHxWcyFW7ZKjQnDwCLDnXstHSUk+lXGaW6ZCe1IVEOKp68TPKTrbKYURiyYq8V2gdKqQdO2K4wmP0V4GKmapWy3Q+kGNmJcEhEBtFWlRDDZ6PT3vJwIAEtSCkRYBrOQgASEiUDQpR6evzgb9o0O4dHo2/DX7WrIw2dW7NLTK8OBhyOfLbgMGpdSleGi7WWLrhTXsvW7AFfjRxCUhnJmukMq71Neq8Hjj2OGZcaCAxeeKIoyzexwS6aRPxaIsCiuwupbKp0CM7GYviuQ4wLgRA0I5RkwXQTwcnvEMwiDxV8pcKjxveqe910cDuHI+7A2P+9Y2rrQUHR+KmEuwFnyECo0ikaEcMfKwEJgaWMzO/BLyTuvUZaDhw83XoFNgzdFrvw5VMkORPjYTStzNcXvQqXPfP/Mo/K/c+9d374uieXdVHPifhwUbrSJkHC4IaZEtIwXmmQdLyB4KD6N6jGTJRPLUME045GwCwtsMWtFOpqRozXGFxxMfYmaP+xHK0ma7/n5xTTDKOjwYaccSok/N0jfjM+hezSqsar0+Oj0a9E4KQpNf6Z+dvjo57g+PTyGj6/ePzs9/fdk7X7Tl6Xhyl9mSOmHsm3zyYcUoiz1mpMV5D4/eTK5eFhOwzI8YrgDWMC1xYsiXo7gkbVMViLktA52baZxOcNA6f4WDKNIwk2qMQeYTCtwniF0kJRgNSuan/KNJ0clZMaljAsQFt2rRg93Dh/vEJnfLoPInR2/gp7VsT43tsMo+Op+xoaU4PkyjGI0lixVoh4TQlRK9LFBmlOyD6oDOLhuS/d3OvrPb7DodMCT7jsM7XrfuNFqN1uaG5IcELL2Nng1tQcmePA3FngubB1sTYhwAVuiuGH1kWBV5p1mX0tbpNDqd0e6oDrQ1OntOqym8VoN3OlZK2uIS20+Auncv1JJdXFBWuEP1oEoLKy2stPAv08LCrf69jnVdyJMXsXMekajeW901w2HINfcTkat3cYqtR9mnfGWNb7Pi2IpaWBabljl7vyxmnKWQjhE+D1V5ymWZ1TWML1liWK4ofPVSgMn8i5l62t4wenxVyo43zSuLyeymc9anmovJYyEP+6zyk+UGrChJ5ZSglOzeGx2viYMX41uzfubkFn3c0+zZEw0XGJMVwUAJZRD4z4rz/tNw7pJVxY1LO2YrDNpiIpd/e4xU7XX2m16X75NUtbpOfVfsew3ueY+3SqdgXzKrVKoNm28mu5Nov1EZuMH2HgvWX1VdXW1++ouFytweXK00FgWFoKS1bCw24E3RUKDvWm8G9CjDU7OvJRd0d6f3HFzNDCyydnHNemN5swvdprTbVvUhqz5k1YesCpVVH7LqQ1Z9yKoPWfUhqz5k1Yes3HvVh6z6kFUHpOqAVB2Qqg9ZaWGlhf+nWvjt9CHlIzpLa3uWWY1zTVEvLzSuGfi9NkHL7YZCCWadkLKzAVs/bG+ptLOuAbQZ3O7W/e2PqoFbNXCrBm7VwK0auN9UA9fsRp7ZP6Bnegbt1m7TaTTcEZiiVkvYbafVsLvtLrf3Oh2nuyvgr9ewHmwPL3v7XbvRHDa6B+29g9b+Sje/MCLtMLfr9WUB7ENwGMTsKAzBaNtsIOIkDMCGS+0HzClYNlIuVUhkAIIsqQLymTrPLlUi+8rdIBp+BcmPPQ65RAwFoezARAYQr6WL8jZVkJtokJkrw3HlEhhwotaAYM1lA0Nf3xCDcV/Ind8B1iYV5XeBhPksnQK+P0vKViwr9gQfderdZtvrtDlv7rcbe7ujrsdbrXp3t0tVvimIEvjb9fV8EhbpMF85sCN/CvTMHHivT0jj4psnXQRjA/5j61mPzcg0+DI8Kr4NgcvL/lvW3mM+D8YJXefjBSYE9rvzVSVgDfgMLL5c2XJOM8DDo1e9dydokwdHP707Oh/eU+LuBSCtLooloAqyMFE6jjIE3HAIaYQP7BBujb0wUF8AQRBmFQdK/S2aR8BMZup+MMOsvmJGETTzQjUtqZKjz9Wz57ImattshNemPIbMbVSMxl6gWZnF9onh5As2gSxQhFs11nNdaXpk5FawKD8HQGBEXVRdDcBLQJUFHajHwBAitKUWWs7KpXaESX5OipuCygGYr5eTnhMngByRWdTCTFoMimZ/AGfNucUnBHKmEUvn4HvA4sJIf552B9kIaJNxxIw5wu2KwPAE6bjMYhVzOjJ3bzQyVPbGughPog307q0P5scm0rIb18IoH6bZxhrRbqTbZCwS3KRIHiebUdl2pYrPwJT7bqW7le5Wuruh7i7eHJhH6cxdCn1WPE/3LuAJ8Dck57kU+ugaZ6BYOkhnaHojt7E9ZEKkH98PQbF/FwG19T/OMAX+jPGRduVLyPey/dDXRxh+ZJtV2gtEkPioKfDAEgn3gPDOMS5Eia3l1V6pcCRBQIMVISJYzZDNVcI4sCxMgoDaZdE2c5WIgmcxm/BCvUDp+qQI8E0yMoirSLKKJCtvVHmjv483qiLJSncr3f0+dffBSLLc/TNxUpRMp5yKpSBp5j5SyxkMYOmhDpapXKEOnEcrCIxlMZZVjhysUbMxanh7jmi7vO12Wl2v6XSafHevsdcYtZvYG819/UWux5mSlXWqsN96H4nFEMRdQxyXBCBcUayUWy7/Jdje8dCsoenJ4mbgec0UvSl2bHaXY8ehUuwND+ZphBSVYsgg5xHaNBg7xbFhOhYGcDYGuxgwMFUS8EJRwuMPNgtBaPSbAlF5kQqAG87tnhcDKVpRUiHLVpGB4yeAIVkCX2HUrECwJBApPIz5AAJFsGOwzp8xOjVb9KRIng2Q4hN6N+LRR0cIVPQsct9dVd89Dsyj9ud6g+8p9JonOgIQAEgItM3K4s4qPq/i88rHVz7+7+Hjq/i80t1Kd79P3X1EfG6iofvjcxiwcXy+i4/LsSyWekWP/n/tMJ1UxWBA4s2U4yQhlZvTGJziChAlRGim6CngGccXeFs72cu70Zzg+74xHtSoJKEPIyZxPIsOdnZuYYdgZ+5qfCZr6ZGVQN3UHDXdGQFbVlgcfDRAaxcOYL23xyajqBFPQ4liq20cAdccTo9QRMBpqgY/CDl96HWuErBqBGYbH/c1IkSX8ZkUyB+epQfFkSNL9AFd70L/7um0aED30LKKfQ+uBuMZYLpAIpJwlb+e/RyDbb360kvacweCCVpzabEzHNZkLwUP8Twi9Sye//h+uMXG9OQJqjg+YD5mQpqzMW9BRMiE9dL6PU4irxKqZDwhxHulDgmqDPN8IJhdBudCsIv0MNgp2PYBGGNiKU4SpP846+p5ujuuuBY+ur1azkkUPOkGO8ChHV6at0UujnIBGejD8/io4WVgs0Npni3SD0kaEim1YxezlC5eoOtTkfhHCs3W0GyCFm0tYKFZe+HoJ24c0FsEwf2IuPXJi2t4dgEeJk5wBaEu4oCcMHiU+1pOumufjEcJno3wynhcBu/p+fTyNKbNVfp06TFzJkpF4l+MoeigGlyME9CiT0aLHoq3SSPsZr2Akq2XtKUN0SDhdwKKEWhh0uciKRhREKcFrlbJ32hnQed/oyMPv5VopssXeCQCRrrKiT4ZZ1zQxgVtbQMig7/2SShYoNtIA9kBLQD9fP/JEhhEC3ZPw1pp1Qn8Ds2hp+wAVYISzQ70l4PcwJlPjG7g6GwMmGEMprNOH3xnBhY6phKz0jLAIgeX8fUV+MMFvml8szIU+shvjV6kuJdXS/B48Oe20vdYkm/H7v5FFq+yNH9HS2PCW6w6DvLfzXKUJiLZo+GF9wF98ZMtD5zYzp7qzc5bP/1Yyxd8HUl1IGXxQMrCezC+znGRRwnUAydENnpQ/WsfCPnaJwPXHR/57glECUD3S2Jl6iJFp//S5K/L3Qxst00E/At3KXahygIos/4FXKhxRUAzEH308hTlOBMpqA46EzzGXHgbPa2aUmQyCxUKGb7UAQGN6fBCCCac+3wkfXxNB3bq0pU5BRA60UY/h9+jJDvR6kx4MBY19h4MQOCAm8KyFD5rBvc+KFOfOgdP9RYdHTtMnR8kodNpEuCrNgDtZMrAKKzzkK6MnEQHcqAzgUh5oSgVzmalUQ26XiShRgWacBqdedhi02Zsw7XAD0amvwasL8hnTshAmLeywLhyGWMdbPC+9kT4M3Q8YADAtBe95Jvj4RJEhfYf6HJETYXjHTMp2sGx+FIbIF6LT6vWqNVtKp/Qi7iiGIxyAXifdr3wgq1FAbzNe4p/m18YZzQcyzE7M2wdIG8SXR7SNbgLq1SDA6cyUWR0rNtbrCpjUeoOL/+hXT8egkrrTfgN4OnqMtmp3wVGB6adaQ/1sXdTvlzu06IN0jN0xfrBsVeFKuLbM6zdWyPze/CmuiAa8hu4iP8eWJfwP/q4mZZTGETXwbuYojiM0XDTLHBVEmQ+IJl3d/8D7L4yww== +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create SOD policy

+ + + +:::caution deprecated + +This endpoint has been deprecated and may be replaced or removed in future versions of the API. + +::: + +This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. +Requires role of ORG_ADMIN. + +## Request + +

Body

required
    ownerRef object
    + +Owner's identity. + +
    violationOwnerAssignmentConfig objectnullable
    ownerRef object
    + +Owner's identity. + +
    conflictingAccessCriteria object
    leftCriteria object
    criteriaList object[]
    + +List of criteria. There is a min of 1 and max of 50 items in the list. + +
  • Array [
  • ]
    • rightCriteria object
    criteriaList object[]
    + +List of criteria. There is a min of 1 and max of 50 items in the list. + +
  • Array [
  • ]
+ +SOD policy created + +
Schema
    ownerRef object
    + +Owner's identity. + +
    violationOwnerAssignmentConfig objectnullable
    ownerRef object
    + +Owner's identity. + +
    conflictingAccessCriteria object
    leftCriteria object
    criteriaList object[]
    + +List of criteria. There is a min of 1 and max of 50 items in the list. + +
  • Array [
  • ]
    • rightCriteria object
    criteriaList object[]
    + +List of criteria. There is a min of 1 and max of 50 items in the list. + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/create-source-schema.api.mdx b/docs/api/beta/create-source-schema.api.mdx new file mode 100644 index 000000000..4ac472e62 --- /dev/null +++ b/docs/api/beta/create-source-schema.api.mdx @@ -0,0 +1,99 @@ +--- +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: eJztXW1z27qx/isY9UOTjCVb8ru/3FFkxVFrW64kn9xzHY8DkZDEE5JQCdKO6vF/7+4C4ItIvyRxe09P2c7k2CSwWCx2n13sAvR9Qy5FxGNPhgO3cdRwIsFjMZZJ5IixsxABb2w0Yj5XjaOrhn6sGtcbjSWPeCBiEeGL+4YXQt8ljxfQOoQX8JuixkB0oxGJvydeJIB+HCVio6E04aP7RrxaUts48sJ542Gj4QrlRN4S+YHnk4VgelDmuS2gJL7xYOljl45z2D7YOtjedduHbX6wt9XedTsHO7u70x3e2e4cNh6u9cBCxe+lu8LR1vlwZBiLMMZXfLn0PYfksPmbwsHvy2zK6W/CiYGNZYRSiz2QBbz13PJUqmbiuUzOWIxzIsrfOyEr2peMhS2fGo07jkxg6kQ09m7FkOY2IcLfO4CWC8NOTIb0SBNlaqViEcATHtNjLVIWiWUkFIheFbm6VCJCljwX3nnxqhsDA9Mk/gGeuO3KEiVcFkvmcN9JfNBuep+EHugG0yPNPBGxmYwYD+1kvDDHcJFL1T3ravGd43qg1npq6fN/JbtmBHbLfeD6xaxCtxiGTzy1EK7ldgGz5ZGzeB1+7xZSCc2XyhaWSWgVGQ4VsshZOm6LDUN/BY19ccuhLcx2HslkaaawphSBCKYiGs5IMULHT1xxIaLAUwpYUznWp1L6gocl3j/4fA4cuGTf4Rw4Fpq5iIVS66Why5YZYXbnxYu8ers85tgXpjKfR2KuiT0i+Rn3lQCGZwCnSSTybPIo4ito64FlqCrJizAJEG67l5OP/fPJoNed9OFxb3h2MRwP6Ofjwajfm9xc9Edng/F4MDwf08Nxb/hLf3Qz7n3sn3XhSf+8+/4U2591z7sn8OZ0OPzr5QU8OB/ejLrnx8Ozm26v1x9j94vR8H9/hf+O+91R7yP8MOmfXZzqsS/PT4e9v9IP48nosje5HPWPbybd0Ul/gn3HH7uj/sVwcD4xDzW9XwbI2+D8BH49GQ0vL27WHo5/Pe+tP7vojsefhqNjnPLlaAQSuMk9AnaHl/BoeH76682o/7fL/hgH6x4fDyZAont6Y1tkL2Gy3ZOTUf+ki00sL+Obj91f+jdn/bP3/dFYN8sJdJ0teGum8GSbKgFVNCsvYEkMo/4HWLHLy8ExOtyiSg/pB+4zq18aYh0AhSnoY7JcyigGHJmuECe0K259Dt+xvE4dMbRq/dL2UWzJlWrGC7DH+YLxBPQbAFJ7RqKQqmF1d0cGS6lAt+0biihs5/K0q6lEAmYVon0dg8N24pzBGzoFVa8mAuDnyFuBVmWRhZATEDZSIBdXo46mqE3lEWa4izS8GQrTeE7mKSZCPvVBykATxqKfiVbR2qqZ86X8ikQB9QIe8jmxhMsoYMkiAbRpGAHhikbPmQDqQArG9ZTGpaWRNGDyuj0TH+sPC5y4ErQG8c+wxCKQiAxwfkJp8eAgcxHr0ODNWwYB30K6iqmFTHyXOoO2gaNCIWAH8W0JLbX/AigFYQfECEFLYXTUVFgGCBFg0pxBQPVtZdya9hxGZ9knAlyrw2yRNd9gMDDoWxjCmNAT+VAgTIBxA91gEaYbShQkSbqE7Bn1xglmBHB4fKKZyRmNRkT8yUIi/qwx8TH9fURlfOl81RqThPrnlqZVRo3nLCMJwWMkDpq/yyY8gpXSqlwC4x+gpL0dSmS8AOFdSC+MW2wQg2hB6LDq4LQ8lPhKBywANN3jDXZ63L0wAym78imolRRgCktNoiLluYtQl42sVIt95LfawYLYDMwxD7yrZ9HOrNWth7iQqidKGZuJAIALTQaYBmcs4TUPTU+tCFrH9XTzjh9Zox7THH00w5k2T4OyWn4GZG1EYHCu7OxeNHmDR681dVKGdQ9bYiSlk8oewvbQARMJZaL8lV5H44Gf6I2O405GLnMWPJzD+rMxhFW2sRZrKACP9axtc7Wh5+mluCIxOJyaSBiwDyz0tyR0ULhZUJafkpWR9k9rMcMR7CCDlGWMtVQKeegcZsa52cjWSaIIA1jLH3nNiqDjMaOiHSeuXipN5FkmMaM9jV4cbRyPBy3PE3ddz4QAqcUYyM+FOkesm06c9H4d8yv1thgYFVgJpCsAZHW0rgNztfCWJljm5lFud2C2g7qDCaQjTggPHKFf0zpf7mJBU3cynk/MZrSfoJjdanq6fMAbgJbtuD63J8K7IzbQ24O8feU9S4hCy1Td4Af6izJ8kBdLUYz8VznsIaOv0mFFvsrsojaYR14DVDEJyG9V8abBqsRdjicjPQslJlgxcyXiFE8SUw4Hu1O53lbt0KlPaWgwG+PkwUC+MtrIFKdt5P10wPzqUrfw+V8l81wM+5Ltx5FmS282U28O+3afO9qXPbtuxPIT1mR5eWaP8+/gpJBIWNtPExjDY51g/KDXqToHWdxl5RJZFpoLA12tb32f3lhWbUavHyg7OfPmiU7OVmUhi3x+lL6LYfsKovA44qzQXYdz69wHfMVMTrQwgfsGKdUZgXkuSWRSMY0H4C7F66rURlmCGby7YuaF5LvAayw8Z4FaHKzlUdZzI49kXn8sH5ry8lxaL34kG2oTNGBqeglPh/QfiLjh3/fD4Wm/e17etE8o7eiKyF9RdEfpUs2STutpcQC4pDI/ToX1aM40ZcLqc0VnSus+5BPvRc66QH0GW00M1wBhcipinLENIuRa8s+k/QK+hHfI19PrZQValosVhgkRpgIllDLlZpRLi9Abnp8DzAzTtNd1Xjqlt5RdfpnOGF4GxzpAzURExQJEA1mZwt/dO3B2O4fO3lYbfnL43uxwy2lvt7e/L4W/SAIeNjFWRseRZoDLifciE2S6YKLrQPbckN3SgNnrZyyHAsSC9WQtSeDqLPFj73VStZnywZoESLdJWuiW869IfcahSZaP9VQ/i8L/BQyB8ebC/BeydEJL9srMZHhhg2zwy+RxMXyxe6wvWAn7glvbLwXRfKHJYIxjWrx7B7723TscJNIztRBBgA4O26ZPMiX5HD4//4cngQu1J/Or92ltsQjVKTikWGg07hdSjHTotcVPnxr5mwVJR0kLD2X6pdJgCWc0zFhIONjf22/PZgfOVht+mu7gb86+u7eV1UuN3a6v+cnaVqs8OV3LXJubfWimhr8+UFBB9d0XAqBrq0+6gsjuuGKGAGo2+m0eY5UJnjRjj1Yih4Zb7cNmu9Ps7Ew6naPtztHuQau9tfN/OEfYR2LR7Sf48DlEx5bMd3Cz3Z50to6AoY7lJqeBpuL9QOgJ1rOEIEV7Luhe7bhyLKmEUqezBLNiRk6pA10Kh1g19WzkuC4/1+Xnuvxcl5/r8nNdfq7Lz3X5uS4/1+Xnuvxcl5/r8nNdfq7Lz3X5uS4/1+Xn373M6/JzXX6uy891+bkuP9fl57r8XJef6/JzXX6uy8+vUH7e2doq+6oeAD/sLftRBNreZCObA9K5oTRsn0p3RdmYELBJ35x+pWKzK2Lu+T3Yhz8vuw9gl815xMk8BbHsSNdkjig/GUjcmhBJi/HUrojvIIlWm73nLsxXz69nJoOyi7iDmezBCxbzUhddbResiFvUqBhW7As+3ds67OzM9nY47xzstPd3p4czvr29dbh7SBXxQCjF5y8IQk9EKCLPwQQsrMg/QCCgyCB7YoAGf3nYSTRe6MV123Sahl8WQ5C+ARj6vnfBdvZBm8N5Qs/5fE0IYfMSi1Nh4vvolo0tbxgmhpE39yq9u42PjvsfupenGJimBTGkVYpOu6F1LcAq6MJC3hHHZgJ0vkL4lD9vsXeG6rs0q5o2NMUJU/k3aA89zOgVPfKk2SySQcGUyG6+xeyN1xKtDfBZaPc8hkB5ylV2vuMdOASxjJunRpLv2AICGRG9bbFulitL41Vyftx1dYYRCcwS2qfbZB04VM9Zi3MyURZXIwOQ0/yioHEA5y8IvZw4AeZomnkrTLXFsGjWB3jWkitHYVZoJNJVGHMnNll6R0aUoQD/yjyq05EFU9oVgCe07VLEyuMiwd2ZZuY4lvRO5yyetbsLH+CnSVNLX9wKY3yKCkWERiKf0jSIZLYb1Nm0SpfLGj4D/Pfd2nZr261t94W2u/5yZM7ZmbcU+lQctrsM8TSAjMh5lkIfvSkIJbONdN5JL+QGblFMiPSXTxMw7K8ipAr6tyV+D+YV4yPtyisyHHY99POpPbtjXX+2FsggyVHPYAZIJNwj4jvjmASlRbVdHu2DjKYeKGhYESLi6QO2komuSSchVWC52qDiTPjnmC34rbBVeEJAOmngNpdUg60jyTqSrL1R7Y3+MN6ojiRr261t9z/Tdp+MJFOuyFpMnKSSIODRSmuaeY+z5QwaMHvjg6UmR0u1Hq0gMZbGWI1i5NCYdtrT9mzfETsu33H3tg9nHWevw3f32/vt6U5nv5H39VeZHadGVrSp3HrrddTlDjy7GOlynoqldIvpPxBvJGZU1I+zkBjWDgK4h+s0duwcVlTDpGRnWMY1EZIqxJBhJiPENGgbYNvItqWjonPAxRBPE3hSXznxAgFUIkyj+l7gxfokqUC60arZncUwFW0oVsnSUczJeEVI4EuMmiUoloc1uhnGfECBItg5oPMrRqdmiX4qkmcjnPEpzpj1vzlCoKGnkftuVX53gEduESPGeoEfSfRGttiThOmZ1zTurOPzOj6vfXzt4/8YPr6Oz2vbrW33P9N2vyM+N9HQ4/E5NHhxfA5tW1ssjaU+0IGPf3eYTqZiOCD1ZtKhw/1uFoOXjlv06HgDnm4JxZ09b/DIFXJc8IG5qXwu71rEMd7DADpLqQiR8IvsR41Ncwdi895+lP1h09xIw8MkFGrqWSaRD+0XcbxUR5ub97D4sOgPLb70WvZSdAhDOTLYnILEK8Asux+GDVj3YmA2Ky1arsijY8ik7kRcL545k9NQsIiUaH6Ssj2DtoLZME1mI3cjiB7jRUDYmvxZUesWaWNpfjCvy8h/+Pm5aEKPzKVKfE+OBu0ZcLo2RZzCNS4XaBEQovXCG+s9jX3dBNf66jrfhhRIc1hqmfkv3B92SgwNsVmHvRc8wtsSVDJ585dPk7dsjhEuIUyiMLgWHh0D4+wC1IgQtGvLB9iJnFp24a1bKNCgxbKZD0Jhn8OxEOwqp9JsBL6AxN4tXAS9fmNX0BW3wkev28qkjcrpueEmSHGzeIH0LXlY2op4oT6wo29nNM09z+wov54i7SzZ1dLOi+fm9aNM/MlSa2pqTaKm3q5xoUV75egDPw7ABpLgviJp/fDgml4zRw/3bfAEqa7zoG+rEh/FsppjV+2H+SjQayK9Ih+fw0/6NHKhm71oZm5qDZizkFKJ/2EMVQdN5WqegKX9MFt0BLpJFtHsbOVYauohm14TglHi7xQMI9TKxKcYDFAsJCFMDF1ttl9oZQEXvtBFgS+FOdPjK4BwbOlKR/0wzzhgEwdsapxQhn/tElGx8HgazIFwQCtAL1t/QgLDaA4bNa1K5Cfym9SHziICq0RFLY/0L0cZCJqfGL3A1mkbgOoGfQjEFBrxNq2hRQf888KyWYh1CZb59SW44zW5aX7TLBi66N/bfHHG3SxZg9+neG2UfgRJfj+4+/+EeDXS/BGRxkTXmPQcZX8EqJ9dMcofj378o0fp8Wj7waKq7xXp7wZVfjaofFS8/K2eiq/kVH8kJ38ivOpLNOZAefbNl9e4CVZxEeyZ21nFy1n1qfmfPDWfOzT/+Jn2/JH2J86ao97MJEnA7MvzqP/ebHLK2XRF59/hX3hLzot2ttyJswvxeUKg4LG+VQduzgFVpjzcEmaBG6YNhFoZkGtaRhL9oTA3uOc00whsmPt86vlAjypFdmROHkTvxhDo8HeVmM9/SXPzv8U+me+XRJgWwbNO8O43afIjY4Aq+p4EO7boB7uQIEhCGA0dVRIwDhj7DETi110S7cnNzVw9Bf35kLSXdWuIvTgFuqQGRquGMyzxeI7IIeEzYwEQKlPfAdFnFxAb2URGwiczxXbFve5ztAF+mwvhkzJDGAI7EpEb4WwwKVEEYqH5SomM5pumk9rEtkAEcwpafbZb7dZWk/bY8BxTEwEPc8R/MulRfc0MN7qbS8wJ46CJ3pzrfMiV+dt0KKSj3J+psykRMLkF5k+g4f095g8xR/CAj8GRYHLq6jrb/hPC2c/v5G4ZFXhKS3KNNyPzN+jeUgW08MftKjm3Oe9wlaW7GvDjV4FZspR7ul2jk5nEkX5tqmdN8lNZ91JZEPFT99AJ0ifbXufyTBdD+sLV1PyBvUDn3yJ+Bw/x36PGZ/g//CKXWi2hET2/b9hsNrTRdPF//wSadfHH +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Body

required
    attributes object[]
    + +The attribute definitions which form the schema. + +
  • Array [
    • 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. + +
  • Array [
    • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/create-source.api.mdx b/docs/api/beta/create-source.api.mdx new file mode 100644 index 000000000..56146c811 --- /dev/null +++ b/docs/api/beta/create-source.api.mdx @@ -0,0 +1,164 @@ +--- +id: create-source +sidebar_label: Creates a source in IdentityNow. +hide_title: true +hide_table_of_contents: true +api: eJztPWl320aSf6Uf90PsPJIiqVv7YR9N0TIzkqjlEU/W9pObQJNETAIcHJYZP/33raO7AZCgJDuaTCaDTF4GAvqorq67u4pfK8FKhTL2Ar/nVs4qTqhkrIZBEjqqUq1EyklCL15Xzt59rYwjFXYCP1Zf4nYSz+FdxXP9s4gaR2dL6cuZqny4/1CtxHIW4XceKKrAK1dFTuitcCaYZzT3IsGTRUKKaKUcb+o5ggcTd148h9fTZLEwr34a9q9FqFahipQfE8R10fbXYiWj6C4IXRgnVCJKJksvjpUrZCRWC+n5NQRYSN8VynfC9Qq/JavAh8EcBQAJzxc9F8aEdV4Hd/X3flvEwSflMxT9wcVt+/yqd10Vw/540Omav4LQvBiOX9E7IQEtAeJLwOpC9Y/EC2GyOBCOhIXEuOb2Ta8OiF3JUC5VrMKIUOshTv6RqHAN33z4An+uwuCzF8Ey21En+lzZxGBvygPakXDOj3GYqI9V4cXCCfypN0sAXdBOGSxKxPa5WniAJADttbdQ4kVn+PNL3aAuhiqOPX/GgwPoPCTgAlYA6wuWgHpczlpEKqahP8brFbQIptmJsKedB6f5WBfilyARyySKRRIpnoDWnFkD4oqoYhvMdAVrGOYuSBYubh3OOe7B4IAQ/OAG/g+xhq1gAqQDbCaBRpaw+TDhxjrgS+hNEgDBhe1z4sW6Sp9xPxXAfkcTOEHIH8VM+chBKrN6gAaZx5mrpaycfa3gwLBlkyBYKOlX7qsVQxyVs6lcRKpaUV/kcrVQ+m/kIT3fq8Bd4xhpD9yQasVBTvRj/CRXqwXsCRLG3q8RUsfX7cmDya8AL5JeiCwfe8CW8NVzM20iWLk/q+Dc0u37i7WZLE96uFDPNRtuhYVdQqXlnDZPGieHRyfOYevUOWo04cmRR9PThtPcbx0gBpjKt6fOT/UmAbFSQ3DkBGgAO+UJLTfv1dpAc78x0DfOk/n4wHQkxDzmL6CHVUBkwFQThOs6QhHcAXXg/Pn5BmqqQpBHxCgSJrnzkemMHBJ9s1sP7x5/3Rx8BPDgFwSdO4qJwuFDM6ubjmwRovxkiTK7d969HvVGv6DQTtdq38KaimlmQzydG8R5ek3fQCHN/e+mENeLQOqvc5RSCMHV+hrHv7+HmZwFCKVHtwmHAl0TOJ5EodTRnbb3KGXVd7wIQplu9+GP2MPO5Xg46g7yW2hefvMOOnalWxt4dNQ8OpocThqwgc2jY2e/pab7TXl09KwbWARAxzKc2QjaSuk4QeLHHRTPCxKJHVKEj7Ngm3uKTFfBfUXwr+PGdqfTH1+Pbjv9waB72R71+tfwfP26d5Hf3AfaffN+axyyjtOYYHOikIcP3eZp0zk8bTQP3dbJ4cn+ceu4dXAon5UEngjTuRG+4h0L7NpR6+To+EPR7u4imEGyKNjGPLkIbASASYAIaMcNRKd/dXPZ/XsWwKqI5mSmBKBKYdPR7HHF3RxMy11kiqP9EJu29X8JyQ3Gl908cdGbbyajEPFYRDDHjROndXxw0GjSkzyRx0cNkCDPSjBbs3f5iXaOt549ljCzCVdgSuF8WxgFCxStR1bLvI9ugqAJPUiOMIFCwEx25mCfOsEy2+qzXCQq0hJHffGiOPP1h8iQ6V4vVVkPE4AmpLYxWh/H3XWWq6ytCxChUT4Fr6ZgRXWBJEXAQ5PER5LOsWU6EDkKhtZh1EUQfEpW1DhdptHI9dwO6e9MadzgO9dluucXGCkZwqYQA8bhmrycQEw9WI60q04i9n7scsNgmV2qhWgH7AA8zMwmxk76KiS+J8gdhGN7VOxYZSGTkTAi8ojep0y6XkR+UTIFN9sD7JSy5Z8qWyYKWEndGB8eJtqxvVaPhIkfGbbqdC7IUwU/O7iLiCsdMHJAlvwmjVOyyoyNkQ7ozZNqf8T3SROig4L+eqlN/sk7zh53Bo8VGYYSJbgXq2X2/R+IfTABr7udUX9wO+y86V61NzyCza/fvCs6zPBk1+74+PhZ96Vg/qv1kF/SruRHvASFi10t7kgVc3uN3Sg72DsL4haqGFNmtftkBMuTIzaCDw4PJweT1n5LpvE8rT9g+b930Ek66CwMklXl/sM9hhQ5DnoTLFDC/8kI8aY9HL7tD85vb/qXvc5GcGHz4zeT4QrX/A0Rhucmw4L5r9biRu+IuOHPTybIjUjDTXZn14ZO68WEuonLPEnlnTV4UpPG4f7pSSMlqdSx3oK/+ntmOUak21l+Vr4LymlrCqTkqZIxBq4LKDiPvT49yIUwPVKPbIJHAStYCCJwskZziEOzBWyw7XSPR28w3NVpj7rwGl27/rBHz+e9AXDs7U13cNUbDsHLHtLLYaf/czfDxt3r9qtLbH/Vvm5fwJfLfv9v4xt4cd2/HbSvz/tXt+Cyd4fY/WbQ/zuicNhtDzpv4GHUBV+S5x5fX/Y7f6OH4Wgw7ozGg+757ag9uOiOsO/wTXvQven3wPXnlzzezz2ErXd9AX9eDPrjm9uNl8Nfrjub78ym4pLHgwFg4DbzykQY+teXv9wOuv877g5xsvb5eQ+jDe3LW9Mi/QiLbV9cDLoXFJAwsAxv37R/7t5eda9edQdDbpZB6CZY8FUv4cE2RQgqaLa9gVtoGHRfw46Nx73z7YOrbyE539Dce/9HkaWpM3Kn9IGG7hPRQVYtnoNEn83pKAl9GA7r0wiWDIu7g6e5CiKgbfOFDlJM5+1lF48SKlgVmZQcSrlR4dKL0MyM9Dg5Ui8eBESkE3xW5B9rs4hsWPBOwogMW9JbPCKzyg5gpItjeFNEpvE1waBVPopiF8/gYC56prHy3FYMHDqkOCg4pdoHi/BQCdC9phNEkMI4jcKjOw/9qKmC0UU22B+sNKZBcm/yM8Gx+TIHiRsA1fhBbEASIWAEnExYn4oYPTjJTMUcbnjxUixVPA/cyMSTsDNQG5v1fLT5ZQUt2eMGTQ7IXhIgJFpysyOlwjZ81meBoPm/rGlzJIw6B0fRHGG9JS/S0LCYp82r6JdkPAyEIwJkuvrgljjCHNeFeHLGZyIInibvvIuC05MaJWAyTMMSEZ+MSMRnlom76HcHySwC5xNTTOLzc53H2pYaj3EGOGpxmDjI/q4YyRB2ikl5Sxh/x0jClbEkjAzngLybwANfXfRiG1gBpaUPYMnZB0HTPq+Ky/P2jZ4oMjtvhdoWAUxgqwlVRDx3IdKyxlVUF2/kZ3sCrMWcwFiCZ6Sd3it2Py15IpYp5LAEwYUsA0DLRRTAZ3ROqScTAtM4L3eVChgCjXpMMuMjG06ZPbWUZfxpITubhWqWyrltZfekxWt59FxLJ2LY1LBbgNhxLO5FtPYdYBE/SKLFmvdRa+AHehvLXzhz6c9g/8XQw4CRJgdq7SuQx7xqe2Giyuv0osI4tUcB9l8T36GIg+ZslSMsgyPWTxs2w5kYBsv0QgDYWpEVeagcplq52VOeJAQTOLbwkdYsMDp2MRUdl+PuWWwizEESCwoG8uYwc+w2Wh4f3HU9bQJYjtEiP2PqnIm2XTjR/abML6TbvGGUA2UZuAqELNEpEN1yAmpr7q0ic1WGX2XinTqSxB20vwZWPUp4gAj1GtP8dhcjNLmT1nxqOkWng6OrhtLt9gFsILRsMHhjbQ+Yd2ei57tIB1n+ymoWH5GWkrqWH6gvtsUHaTErxUh/bZs9xPRFNMz3h/T9IrpC46FhECVL0ltFsLGw2oIuA5PGnhEl2ljRa6XB+ZIBAuVI4Lso09teOYlJIsLUwDZayQODfBLkyOSXrfH9sMH87Fg34vM/CucZG/Yp7scZg8XOptXmoVotpMO67NF9I5Af4CYDyyM+zh8BSS4WsuFPm/MRvqvzmvcJ4zFpOKPQP93ypa3DvNFwY75CB9h6thhxMBGvhwNBQ76lqG/UmVhYtI6AJHQsjD0KsMfrs7pog+YEO9ueSVfFW6AgV8KDip163VxZQx5gZw31S/G9tyq1pMtz9r6aZQKJNwQ/Fl2m49t7dZHbjv5K+WQv1jRsiHvLZI/joWP5kd9SKCy/45KWXrN3oXIzdBbAhY9Pg9oPb4CuYWFygYh3c0G3n+RnKRwci1nbqqVoQ2p46M1NpbMBYyS9xYrMa9u0jmixy8sBbc/9CgOoOxFkLraa65ikFf+bmc71QKmG+oQRqQlDf/D/OTC/VuZKLuJ5Z66cTyNvqcCgqZztN6oVDBEM6UgzC9u7iuND/4RuHC1hiUDgFHZcAE2M5iBq58EiG1xF7Mzocg16jTLmV/ut7QPWhEwMAreBsDYbDe3rWcbgs9VARJ88PvPlecUK3Mf8upqNe14CXpiVSC0FNyU3QXjLR7cJ2CAZBWaNJLp1a4LROgRjTtJvwmAK7FSnMacyWcS77l6as1kkJWRYjrE/fDB7ZXsI20W7tQCUvSL5x8fdLzBYc92+7nRZoucD71tfvznynqKK1CPj6qlx+Bb886xx+EehuVoXbhWH5pnR1t9Jh1Lo/ulV0Z2Ehl3xyBAIP3mCJARfglrqew3AaWFVzDxyVa2E8XzmXzLJwV+bp0FvZAwDHNAkGHc5pJhr7CNQl7dvuu3L0Rs6g4nQi3yCnAahBPAtV+hG3pFJoS8g6MgRzQzOKQgwcScjASI7NlEqIt4MtTRazVrjtNY6GTUPzw5Ozlqn9f0ToJmjo/1G4/9yErn3BEId2avKqX57sp66fhJZ4hS5y4pW+JNsxAU78wAMXNyVjdBs3kraMBcysEDT0ZNMlKywSPuKF6kFj0LwZW5efJNHbM6/eyqaM/o27x96+S12jXlTsxPTjf8nTuNC01oMJKd1TSr9CdN6qIwysx02Ca1Va8C/QGgHZ4eNs8Z+/aR1TBQGvjZZG88BENG6HfApYB3UGs1aa3/UPDlrnABk9ZNTBOu+8F4xXy/PWm8fNu3rWgulG3WPVuAesa5pNZrbqqbD2NP6ygYA8lk2ZLpQpAjZnU3hucok1zjeaq5CSrup5iLr6FS6iprVSITnM2/AlgsStzaRGH3CELXnqKiKgiLXyuQk4SV9b+bXK2UuRJkLUeZClLkQZS5EmQtR5kKUuRDl7dUyF6LMhShzIcpciD+JbClzIf7TdrzMhShzIcpciDIXosyFKHMhylyIMheizIUocyHKXIgyF6LMhShzIcpciDIXosyFKHMhylyIvxDOy1yIMheizIUocyHKXIgyF6LMhShzIcpciDIXosyFKHMh/qy5EAeNRkH6wwIvA4luGMLG1cTAhNY8fe9Be0OTwKUf+PD8z2CKuc+YgOCqGIyUTuA+gbpfe76qzULpIYSKQHagI3uDFPZd4v0XHtLwI7XLW36AiXpTvJIurJfX19GLQV8glA4eEDyF7se+B/2F6YKixsSyC6ZVx0pOjhqnrYPp0YGUrZOD5vHh5HQq9/cbp4enp0R7KopAPT1+9nmBP8EBYn8ROLAjvwFCgPQB9wQATf70A38a44nShdvaZWp4hc58Ea86N+LgGMjenyX0Xs42kODXxnjm54Nlj3rcKkMeuB96M68wYcNYNOfd1+3xJZ4u2nNGHGvrpK7tG+UMoAItmMQdvQBkzgiMU4dC1T/qUX+0wWrbUJ/5aDdPq3TooWcv6JEdOr0/aFjJ4Z8TEi+8uqpXwZZDAUG3RTkLSEfhfmw7jlrFtUuNyR9Rj7oqfAl+ZRqC1PdJl5LittJ1lf2BmGlC4Q8TAwWl7216QCkq87uRipDL7KYgcwDkT7BXnBg8NqKJHBdaatEgGuPJ1ZjLQzfKII1QugaN4phf4tE/RiPA7REeHX8SB1M0GwSPb9pZiZW9mUni7oqBOY8D+sahoEf57ib9fSX74bPSzEe3N1gaqWykWEskfbWDOutWdrsM44OCVgu35N2Sd0vefSLvbn4c6KRP/ZVMn4LMz7Gvww+oPLdMn5Coxw/MD5zpi7e8kfRLaNpE+untSP92Gh6TfFmhhfaM9hGr8i3g23Y/+P3E3Fo3qj/dCwSQ8MgrmIIkUu4ZwZ1CTIhiVO0XpD8E4cQDAvULTES81GHDmGHi08G2jKp05oV3zufyszKXG0gC0gUOt8axt9KSLC3JUhuV2ugvo41KS7Lk3ZJ3/z1590FL0kJF3KLtpChZLmW4ZkrT33G1UkADYcqPpBnktFWb1goOJqyNVclbDpVJqzlpTo8ddeDKA/do/3Taco5a8vC4edycHLTwUn2q69+lfGyZLM9Tmf3mfSQU05VQvBsJxBXFQeDmw3+A3lBN6a5EnJrEsHdgwN1/sLZj67Tg/Cqg47G1sZCinA3ppzhCmRZg5iy0DU1buoE7A7no44mBF3DZEYy21gQlKehgMmeowrjhutae4uk3M4ohMjuL5zuLBCAkSbAIOAf0TnqxzZ7jzFA5A+n8jNap3qLfZcmLAa74Elcsul8cpZDRreV+WBTf7eHZN8qIIW/wjkAvezvSBwKwV4mt3Vna56V9Xur4Usf/NXR8aZ+XvFvy7r8n736Dfa6tod32OTR4sn0ObesNYW2p13Sr548204lVNARE3iJwKGfCTW1wsiswIwXar4KIhIiM5/DXns4GgTds6zMUSbiAj/M4XkVne3tfYXNgU+7rcuXVTREVP7irO8FybwIYKRA2aVocNhDtm552JuqEztCj29dEjjQ4I1dfjEovYT44srlfs4Y1CB6mmkmEoteY/wiuww+Rvo6KyNhaH6xrHC7uf/9aeKAdaylC34OzQXsBkG4sEZfwAbeLiz9SmQKefRxhARiSUO0EtzfVHeibbd/d7GOzlnilZEgXg/G44sVPb0cvxQytS+JurnyjPMoRkeIGSISkV9uE7rETKZQ0h6+dOxxBbhHTBSxYvPeHSol32SKWA5DDhNJ2Lrf1wwuzO676rBao8erZq7nLPc/19wBDe/mc2JdcrAjdgMzVt/p739xqTrMTeIl8u/rdyqxLZtb1vUD8lxmtxqPVaLTo5QYUjNp3Dl+2cYBlcQi5iAhb3z05j1fLjIc+E7zBUTdh4ARcgiN/pOWYXftuOHLj1XC8PBzv/bdzz9lMaja5czr5rIfX5IJI/Y8QSDrIBu9mCXDRd4N1h5PWiCNqrUYGpBpPWfNqYAgSfJfAGD4Tk5ygIiY7RBeHIpb8SDsLPP+Rch8+5tZMr9+BvsSWbuBE3w0zTljDCWssAyINP6sjJCy8RIZVgZDpmQA66f6TJNCAZuQej1Uo1Wn4PeqDqsEBUGmUaHXGf5ylAk4/CfqArW0bEMMVKnGiD/kwQViPdZ/e8/5NV7rjCMAmBrfhXQSgCjfwxvDaCBSqxz/benHF7TRQgoV0n1tK75Akfx65+y+SeKWk+StKGm3ZYsBRh/FeBe66m6bI6KIyaf3nh4ytwlLNmUrNmkdtxeON2jY7SxZXUzC4tHCusLAp+aSL8OYH3V1Gt6Asj613+3C1Wz3hA4VhHyrak63jamH4tuqqD9VW1cBRKbgNMHbWc7Ng5GuvPVLHc7tApq3VWFhmMluFcneNxmeFf3etwGedxhao+7epalZU1OyvU+kqW+jqD014tdli24mguTzQ7eyY7STOJ2RR7kyi/P2JjQV5jc3GVlqhzr7akdWncbGVCvcEsU/5axmxvyO3LJNZxnE7k/dVnHllE68ezYbaSIZ6cL84mWk7yWg7x4gTgh7MB9pM4snk8OzOrMkm1jyQ6AJ4B7OSdkaH+rLG7Csdl9k+oIuo8Cn8F76STU7BMkBJWrokO9AKBDpar2S9O3NPUWh/BavAGE8VLchgSRb3KgzQzFe61saMVoq5z3IhJ94Cyxjj4bOZWZJhzAEkquEaYiERTtyEubhGS1281ZWmQoy04vVJ+PZroEOuQyBvqvwjzo1RB7p1uUx8LGoMYCdLIcF0fMTywzpcCTsoejN5CVzoyfYy1jqalLgEKhSrwmXUnw75J0kyBt4jc4F9F+kjY0B9xjZLFzLQuhTb5cNzj40NVmVtrhbEUiBElR/lrL/eaGtEGMzX9aSCcLanO0V72BYGwTAok89+vVlv1CgsiLU0gygGcZEZnH8mJsqkVOZ+x6W+SY9f01NzNj6ddACTsWnSxLiCC6a6m1c/DfvXSI1cGEOX4M7/JI0mK2BCpFEZIUGb4yqqCGZ/myZZUVkLR2Gq/gbY7/229jMJiv7g4rZ9ftW7rgotmvRfWI5Ky6rxK3pnLoHEa0675tQ0IjV0humWLxBTpugwgrZHUCKKE46ecnT6XcVEp0E5zTFuDa++fsWjFgzX3uNrqm5A+t+UfLOSfSfme1MGJK2JAH9wTQSqNmKy8vNp5FTpbKMKw4vO8OeXtjbaUMWxrRNlyyxwVr8WHDo0bYs1IBI+5n9MhnraeXCaj3UhfjF1HhKSaDBBQV0HpqZdxSJwBShS7sjd1TJl3IPBdcUJN6Bi4ARbwQSSXVEsDaSWq5hrp+fWkRYNYmWzWFdzx2d3NIE+/QE0mPhFZvUAzS7a+KTwwMaWt2hjeYv0bKZCtpOJxgNFfGAN66KjBeTBvfU9jxrptLTv1gUWNPW4Bx/lPdj2Q+Z45aZPJS4xM5Lu9/BJUSjv4CX+96zyHv6HjuWKpR00ovdfK+bcFdrwuCZGVhQi0g+4zPv7/we0CmYY +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Query Parameters

Body

required
    owner objectrequired
    + +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 + +
  • Array [
  • ]
    • passwordPolicies object[]
    + +List of references to the associated PasswordPolicy objects. + +
  • Array [
  • ]
    • 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 objectrequired
    + +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 + +
  • Array [
  • ]
    • passwordPolicies object[]
    + +List of references to the associated PasswordPolicy objects. + +
  • Array [
  • ]
    • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/create-subscription.api.mdx b/docs/api/beta/create-subscription.api.mdx new file mode 100644 index 000000000..4acd5f1fa --- /dev/null +++ b/docs/api/beta/create-subscription.api.mdx @@ -0,0 +1,117 @@ +--- +id: create-subscription +sidebar_label: Create a Subscription +hide_title: true +hide_table_of_contents: true +api: eJztXAtz2zYS/is4Xm+aeETJkhU79kynp9hKo9axfZJ8no7taSESktBQpI4grage/ffbXYAvUbaVx7VpjtOZxiSBxWKf3y5B3VvBXIQ8koHfc60jywkFj8QgHiknlHO8bdWsiE+UdXRtDUM5mYhQWbc1yxXZiCNrOJWKdS56TM9XjDNfLJjK0WFRAHcjTYJx32WuGEsfxib3pH8XOMQKPIq49FSdDaeCRcu5YMG4SA1GiHBG8xdT6UyZE/hjOWHB6DfhRAzYCcV/YhkK9+jG32FvhsOLAoH0OZtG0fyYJuPA7p3wo1ehdCfigfEiG6GngYTwmVDRq8BdWkf3VrK0dRSFsahZwFsEk/ARn889qXfZ+E2h8O4t5UzFjONfuFUQp96EoasJXVtGTKCmmh5Xs3w+E6iMeYhajKRQSITuZsQUTPSRyaLK8jpmOKUOQ8R7Ppt7OKvjOELpTcPGCqKwVmu0Pmip3KPHVhQuGoySkWDvl7/jktn+n1ywd4L2ktiV4X1EJItrStc/4rSuna5LaxH58jLCj2eoCzQnuOz+u3s2fNXvnfzQhave2WnvDP8YHPd7F0P44+q8/9Pr0/OrssMURIKr1NnOztn5sLuzw3pjbfJgw7kFaiyaCr9sfXlTr+fnIo9mUmbihdEFUZgtRTKiyzyDQ5TCCq1RzcETxIngrgeu97QikpFsHITgobhUBONYv/uvy+5g+Eu/O7g4Pxt0N8SAGvA5hxVhu6A46bPe4Nx+ub/bZG6sAxYSnfGouI2LYfMNsTHmsRclN4D5TAbIdpFNI5tEMEyOywEjlWustOjWfbXohHHoPS2ey/4pGSoEOfEe4pnPvYYTqyiYwYYjMdH7LG4Q96GOGo3FYlE3d+sg2WSLJ1LNeeRM3wbuFvqhXSZqZTOYo2pM1sEaBz+fHddYR/8Dyjv5+azztndczzkBPoPLjvnXjEBbz7g1zxKrerPOoeG6E6OdRiYwDh/wvnXbMukDpEf7KBIxXtVxXYmX3GN33AMPZzO+ZCPBuOtqu8L54ziKQ1G/8W988CBwxF86l8M3O6huJTzQr3BrzA9QSyGHSdrycJWF9DwkB4TepBaWEnrVGfSON9HKxmoK0ne82BXsFVfSwY2kD6Mpu1RoGjNBWfOCK7UIQpdxoEeSUdly3U6/2/9leP5T92zbBQUPRTgM3gl/fVm6mS2TV70RENzJdogXufV1zEu8MJuQ2UZhat5CNlgD2MmoKJpN6XLNBUFsZ1vlQkQZcSJkxCkZA2tpEUf9c83t5kYjm9bxY8/jI5yqkUB53WR2aV127qeuiXEc1DmWwnO1XiMcj9RRQfhnEMFosGIfHgIKi1SBcRy5Wj3Fz4Y4mCmpEPuMttbMldS0yaCeVlZu2ofLURsxiAFnf5Zd5ww5rxX0+EQMn0M/qRw3Cm21KiJAzCkbovxt0XsyVZSR6jaZL4c5PiUB8oUCRBfEGvY+7n+dqwEzg9lZPBuBLp81W7YrJzICIeKN5yBhHrEp1wE/D9MveBj5MIXusUEQh45gfaHoj6L7Nlt77Rf7By8Pd5stlBAw2ReTrUAs8qjHfiwnbCB0tYHp2w0cVYfl63zGf4ccD7GkMREwGSCAhyVU1JiEjRAivqhPo5lHCIpDogKL8iQgcsAN/A6KJLRrk9rWQ5W9ADJ2s2RHOdXkRZCzo27JctCcfFwrH+ZGQeAJ7pdkdTUVIJqwaD5qGsTgHaFwhLwT8C/37EhiwC1hP4WIAzyGEtsQ649NY8BlGPcWfKmYYQ2ITnjoelhHEK4Caw3SUiPNRjoIpJLCS9jeWHoAwZ42hB8H52cXHPKjnoDODfVdgjK8JfH4LtvWgmD7e8SyCuUgUFlUJMNMXLuotm+uv3/2TV26GHGiZc9l333HbqzWbnOvdTB2edNptw9229zZbTZfNsXh/p7b3t9zbqznt0RGo8gTsK6ys69zDjYYz2Adbup8wqwpwHQhfHjo0XUFZjYPAJGSlULNRNbboPBim22qhiYKErPpgQKzW22uJy4CFfV1uUV2pfdODBOQK7Qf4CZZd1bZPlqbltz2saqyUFRuLgbTMGfqo2IZUZTYOiTfhMgTRPwQ6i2iog2YJ0M1ZTCSxyKW6EeT9j/2l3HvbxQBUvfV5p+Y+6cYHJLV0FstfeeL1lu5dk1KxU/WaOdrU2k+pX2ROi32XTbCnDz8KKb9QtbPZ8n/kTxXq1Wud0JRDmaWo/PZYw1T0wk1KcXhPqTHha47Mdm4bLQkNDKDxBskrdW0vM2TxWzzWfqR0i3orNiUTJ+c6atEshscsdS/lFt0+Ar9s95JMYXujpvNcYu37QPnsG23R+M9m7dGrn3Qbr14uTsWeyPdeagapZ/eKM1p+eky26xDZfZ265q99qvmbNWcrZqzVXO2as5WzdmqOVs1Z6vmbNWcrZqzf3ZztmrNfm2tWUt3K9q7uxvCkSfRc7phCAZgg+tgwNRhCX0tqYBHgbvESASy5p50P6nfUIxa+lTY8Vbg+TXATxswOrVBBLHswEQGFO+ki2XOLAAj1SRTnI/jijoHSdSbgPzcpAZlx2YzVP1y5x3Q2qbUvvQlzGfJFCZdihoPLCsOBB/t7x622uP9Nuetl+3mwYvR4Zjv7e0evjg8xNVnYLV8okVj1uZhyJelpX/A0CUd5oF/evJ3ckaudI2mF4cpMhIz9bQOiMaWqE2PTbdp+GURuEINwuWr4wvWPmAe9ycx3eeTNSH49uWghC9g55rwOZi33JgcEiR80n3duTzFYt/UtFYNaZUK/g4ABwgTYJbAKtjCNFgQx2YDC56B9TrbMVR3YEPcV/mBUl+ppQJhMhPUYIZZfcOMPGk2DqG2zLsS+c37iD3Dqq8GlQzcmyG0YIC3YUKgC6Qd7JLMI/vUSHKHTaG0h7T8YRUWFRZBHGFwl+vJORPlOl5LwshpXinoHMD5FpnbiWJgjraZ98LUWgyLRj/As5ZckbthTmgk0iWETgdRIUZ9JwhDPBQ6gr3JSDETjjQWnHE/GZdGrHx0pHD3VjNzEgX0zOGx2sLvLjwIPzZtLX2gk6vCJAk5Rkcj0kaiJhORMAFNta8ko1J1JY6vIW3lu5XvVr67pe+uP+wnXVP9lKDPhnczlz7WmUFIybMEfUKyHl+3CHCQrkW1IqlBZyDSj1dDXQfjeMCdSaP3M+EjncpLzHdSfej7I4QfqbIKukAGSY6mhwuRSLhHxHfGcfpOq727V17tdRCOJBiovwEiYoOGLYOY6oMw9n3khKsawF2h/G+xboP4qN8z6AiIq/qurSFuhSQrJFlloyobfTXZqEKSle9WvvvX9N1HkWTxUKPBSSqezXi41JZmnlOnmMGA7EVv6nLpUas8WkFiLMVYVhE5WKNWc9QcHzii7fK2u793OG45+y3+4qB50By1WwdWPtdfZ36cOlnRp3L61nokEQOIuwMcF/tgXCoKArfY/ovxXcoYw1ry1oxwM8gcRHqbYsfWYRk7DoOAveX+MkFIqoAhszc6FNNg7AzHhslYGMDZBOKizyBUSeALTQmb2DYLwWiYJ2eSnBd3AXTDpd0ZY7dVO0piZOkq5jWsokjgBYiaAzAsCZsUY8R8QIEQ7ASi82dEp0ZFn4TkWR93fIo7Zt33jhDo6Clyf7Gpv9vzdYeaDbSCH2j06mqH+2AAUBDomJXizgqfV/i8yvFVjv86cnyFzyvfrXz3r+m7H4DPDRp6GJ/DgK3xOYyt77IUS72mcw1/NEwnVzEckHmzwHHikNrNCQYHISgBN2W0pEXwIOOxNmU85oSeqeZH5gyBjaAfzM0u/CbKEagFgert6hY5xk8PYPF5oCgicSRiNVIK+ZkWLo4oU2+weLzhHvQO+l7V+Vymxy38YEFnHEYg7A1xDA8caJ/FAfRbNHqBOmkqlOgMOnISca235ARkeoziUcrJufVlEEOsJDI1PHhlDJNu4zlqqEq+VeZTAZRzaX+wr8vQW336XjShB/aySXyPrgbjGXC6tkXcwm1mKwOE8Hr1ksVkaQnLvlZpsXMc1mL5E4Hs2Y9Xw+dMn67CwBErxMxC0hklzi7ARCgwdpK3AjiJclUYxJMpMd4pvHdBR2RjDzbMbnw81nXdM0I4g4zRhxBPIi0eZL19ts3hGpBQo3ji8DklTqowcieP6ze+zU4kxjM6D4VjzBapYGTX82RfPLevj2Xi7wk123yjQdTU8zUutGivHX2Ox4FogCS4p0haH724pmfn6GE5BneQ6joPKAnDR/FtmZNo7aP5KNCzkV6Rjxv/in4pau3IqPlkypyA6zFnGgRKfM/oRCC6wfUkBi/6aLbo56ls8gi7tZtjydZL2tIGjEn8nYJj+NqY+AhzPEGcANCf72qX/JU0Cz7/K503/7WwZ7p9DakYR+I5sI/mGRe0cUFbxwBl+De/ywXMgm/jHigOaAM4zvRPkcAwmot7mtbGqE7kG8kZYeUAq0QFMpC+OMoCnPmL0QMcnY6BMIwQPX1/CNfM0MJ0VxBW0lxYl2CZXy+ALLsmN81v2tzCzPul7Rd33Ml6MOe+t/zcUfqBSPLlxN0/KeJVkeZrjDQGNGMvs5/93l83KW++9s/c/6iv3Om7kEc+VSl8jJJ8RPJlfwNeszBGka2akjQfGV8ZkF9uJOObjqmA/8NTCvBU1EHJrL8BQ+ibJzT3eIShkFKBM5WCWlBzwSPcUg3DUTCj8D0PAzQk/PFMJDShX+0Mwc65x0fSA3r0kiRZmVOU1dUIBgO8BrOmX9rEM/ZT7k9EnV0JJnyQd4gdATzmA89+C0xrYADufIHRgJ0kEQKQ+mwW+7AaBvN4xvDLjSfCiCuVE+ts5wS+LxJZBFQvpLOS0I/xCbdAn8SIcKbOxwNdyVpPH6c3a0GwUObVBog+5+jZRvrC40ldu91R/YQ2hCh7Krw5GgmkakDt+VDytjcsUQRivvloJQgnDTNJNXAsEMGaWpvPXr1Z37WpxsQP4aAqh3I9R/yYtA7FyOCRCHWfvdL5v/+VVxNqsd5tzLHji3I13xLrbkf6K61r3Q6on6fYFYEB9/fYFcTyf4W3IZBjy+n6Nqvs8Qo/vaXuILVH3gnsSpnXUfZQ/86CaT+V37Nhw0HP0B3HR8fmGzcX59h7tUbmV2xnOu6HfIGJBf5/ZN3Af3ARmG3BILp/byXtYRij6SZ4exPcNH/gNler/wLqvtxP +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 objectnullable
    + +Config required if BASIC_AUTH is used. + +
    bearerTokenAuthConfig objectnullable
    + +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 objectnullable
    + +Config required if BASIC_AUTH is used. + +
    bearerTokenAuthConfig objectnullable
    + +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/create-transform.api.mdx b/docs/api/beta/create-transform.api.mdx new file mode 100644 index 000000000..b92f416f4 --- /dev/null +++ b/docs/api/beta/create-transform.api.mdx @@ -0,0 +1,563 @@ +--- +id: create-transform +sidebar_label: Create transform +hide_title: true +hide_table_of_contents: true +api: eJztfYt22ziy4K/gavYc21lJlmzn5dmePYrtdLtv/Fg/JrMTZ1sQCUmMKVLDRxR14o/ab7g/dusBkKAky3LS09124DmTFkk8CoWqQlWhUPhcy+Qgre2+q10kMkr7cTJKa+/rNV+lXhKMsyCOaru1vUTJTKVCikhNRGZKirj3QXmZCEYj5QdQIpw2xaup8FVf5mFWF9lQiSDKVBLJUPRDORBBKlKViSwWfRmmCn8EkR94UBlKS/gyhCIBduXlaRaPyt6a4iQKp+JcBuFpDK0KNRqH8VQBXEP5UVFnsheEQTbFZj2CGdopwZ0E2bCER8ORJblqimM1gba5ji9KXAhPRqKnRJ7C6yCiTg59FWXYy2kS94NQiZEcj4NokFIHutDlYVN0oP1rFXG/FhhJgIDl2TBOsBkYbaL+lQcJdIGAyzBkNHROD5u1ei0eq0TiTBz6MBcMYwEhfMfKKs1exf60tvu5Ztqq7eLQZqfyAmArQYHuYHB62NiXFwN6ogzbgUGFODFQb/NDipU/11JvqEYSf2XTsYLmmAJqi3pJ1DhRKTRGTYi4LwCVBvvhtCHiRM+xShpAMkGE4y9mWw+MR/KuFsmRglfUbb0msywJejnQJBLrOEEUZQE8AWRUsoQwhZLRYA7CyygArAksjKARvjMLqeqTBPLCBi6CEWAXnsRFLPYBUfB1FERvVDTIhrXdNjzJT+bpaetGA3knBDQTUIK6L1nKTDbCEOUjHLv0vDiPso4ZNHzqyVQ929lXXuyXjweRfoRZhInjH36ArckQ+wfg9+LRWCZKP72GLqkgPhxJGAFC6UGZOFX7gQRwM6CB8Egm1ylC1H62Mx7GEdbvB0ma/V2GgY9TlYf4LtCsYYMK/K0+nfTxVxpvt589g1+hTLPD4n2o+tmpxGbCOL7Ox/RjohL4b4QAhsGv6hgmCiEARPnxqBOOh/I4B8oJvOKl9az6KlGRp+j3OJSe6oRh+YC/gsFQd5oCnSMOUqRUrJ7mvWLO4L9IDvl4TPCAHEiQZn5UEc5TTO9yQMF7m2QqqFWfmOT3Y4/oc4YKipk/MTOPw8yTED4Os2yc7m5u+uqjCpEymilIvzFKvyZM0mbgR5s+NLtZ0E+6GZfN3NxUOGWu7yOVyQbAKkFuxnlGcssStzC3IFdY6gF3hEGaCSAdkY6VF/QDj6TnQiJmsaI+KS/XciXKw1D2EDkslICEYOp33wGTBBnhbAGRz8oYWx6kcZ54RBW2OKDn9zf1stkZRqk2OV+wYKHbCxbMtQy8j4S7KihVZlxWW31C0ZmyFABWhFofgXN1dUSnGsjqu0pPVUZf1hMxsRZqqUII9QOTEdH3VwJQMMDtqLSkzoroqPayRFLd3qktw24vVZFu951pLQ0tIl/SAK1XX7mKXWhtCdmwXMqUIPEEHIqAsF4VKeWnmjGD6CPoJb7oTassX1n2TBN7MvTykNfwMxzXTQF+egolYtDezlQfnoYWvL04DpWM5gDuCMIXw2Q0P1CchgogSargiDAeAADpMM5DH+FOVENhddLRQCQmU/w3AsQImQqg9syM36xDUIUgE4BcD0jIHiEpoCgizazpEetBrjBplmpG65wX5r6CVainkrR8cY7iUoZ7Q0lvQ9YUvmXCRzlK4nAipymiRSuyV7W9MM59ca6SjwEMVuwr1I9HgAlxmZFefFWrTPGd5XGuyyGupNEUxREk+E0T2R3wcqnOaKE+p+rdCiyLSmD3M1i9m8JKDOESFBBZXdVw1bmqocp5VaOJhwfb9rAJcGDW9ioBakhEVExwAT22frN4wv8EAKcMj/AAIOlli2HXZLkaAWoNAC2veAKdAgMiHKyGgR1lJtMX3Iotfa4i/N/fjk8uDsR+zhag4dZiHReklcByBPUlaDsp25KgaAejfAS0D/ohqhNamgBIO09b1gCvogpxtVuPXGrNM869xZdWYr8roZSdGUPhcNZwmZVOS4oiQIi9e63WpRvjEkwKgYqrWIdWNjSpzZLEZAh6jsUg0Aw0jvOJ7NQhh0kcIV0hjKIPFn2eqLqYxjn5MPKUPSTdkYzkQCVdca2mkzghl4M/hYlG7Ql4F00wkY+pMFo7azC1XAXsdx9fR8DfGfOC/gJl5nm4OcOEW97L9ovWi6fPW9vt7Xa71Wo/b+20eq1n/e2dHeW9fMwsupR6KqrjIgv6bu2x0kJhVy+1nwobt1q5MNFvV41Lc31ZB0bPqdQ05v2yihnZiTP12BtwO0yIhmPjK1hedKEH4a7iK5W0vA7LBoiCtlrP8lDcEzOlQ2NZxUQN1KfS/YHSdKaZ0hty3zk13pNl9XwVBqMgo4kh8pxpwjhe7mtnVRw1S+r21CCYsR21X+f22TQenyUl8gXGIXCzxfmlm/bGEhBmXV3oWtTNVSzoqhMniMZ5pr/t1o6OjoTviyn81cVPP+2ORrtp2jw/P8f1Pc/solhm0/c3j45qN/iHSErHoGRxu1ut9ryP6LAQpVUROgHBmOYeyr5+Hlq+c1wkEgWLTwSLQpbOuIHv5WOG9egW+9l5m5232Xmbnbf5z+BtnpUIVtk7ubIjCuIx4+Pq+JQqmXhDAWPkvU0GuSIt3sbJtS/JJKpCtZI8sD2GpWURR3Z3CAiL86Zg25+1ZqA2gG3W72gqla3R149BGqC1rvdGkaxZNveBPeoomnWnevC8BDQrQ90/OO2cXRwdHF/QaLmj8zix5nClQVvmFYwGRFY/GOTaOqR9Z+OyWIgcwAZaUhO0gnwFIwDZHGj3BxhTiqpCLUYZLocMaMpV0BZRRNajPMwCGJkAEZYEqmJA6D1en+CnrXTrXXXw+zA+BVIXBruKp2mF4evKYh1ZZ5NsmY2m2IM1O4nDtByowU0KUNw6ODP6pjjsiyjOhF5567PaRBCGJmygDA5Yl2Zw3OXGnJVlIYitrgI5ZzQBr3HVeBNE178TdibDALjCYh1N0FK33E/iETE0NFEaygKxQz3OxEiQ9JpBldGtsgJcahQfaY0setfMhoK0TuasCPqgkWHzKB9pSvjRjshY1h23H8VRAxvg3r9qZu8xj6+DEO2G1Xwr5UaRAHUL2YqgwUUHdRbsP5JJEk+MbIXS0GmKom0VyVAsh7xINBk4u1vUfilWhDiCeyE3wkAGUZpVwIF5x24NcvrcGCFM+9GMB9cSjdiB0Xvq9CSjqUAdAqNAMCqmACbltjDAIx71SOENEELROd6vusSwffUJCAVB1ahBZQxQKJtXEcXdeLDCwRj0Z3K+lqs9cb38CPjBD7tCNEQ3og1C4+/owivspqOp83CfCvkB6ENyimvWbAlyiWEZaiAkqzXFQiUXapdPXIhihTRuL0RDMFPs+hUx+x/rVRiboJMlWfo2yIbrV7Un+wdvDi4O9p9c1TY2LLF7yqv99GspE56IQsoVHmdRz36xXACmR2oUJ9PflzaLdUtzhsqa5F9Empxd22dmneQaD0M7zgjWktDgQftemRL1+CpTsj5I4nycNtFGRKig4/XPax0f5nbtZkN8+SLCmO1F8cMPYq2TI82ubTwu3+GsNCz9CWe3jJE2n8DUXyUyS8fXgY08ZlvNVm8QA+guBrIBwxx6nWrBrmP5oA/em+GVzgiYPs2o0dCruOKFhmri0gNLBYz7IyBj8VqRyWtFjgOuUixulvwr4WXBxvRgmAJA+RhIE4SH+rpvrNJTS1Fny8DyyWi8LbAMqlbNjKLNlukv2mNgK/+1c3qo2Q4hniX0vawYojJrXTgqd1T+gKn8lvgqR+WOyh8Fld8rOHCW6vV7C/4kkVN0ZWZqlM7Tw80c8YOSh1WQSqkOKpkfYrQE4wExgE2f72o/x0PkIAH/Px8FvLPjeM/x3oPlvX9jfO0ss1ptrODm9WgjJEgBv+j4J2OUqaQfYzATOyqgeu5h3AaSepc84h2h/sW+8Vdd5CT4pj90aQ675hv5ymlPQXswU/Kr0g5giu3FzISF774p0LJD47Kr/tUVJuDXBKjEaPR/xA0XC/iKrTYLH3LPPDJXC9AhMA2Dl5SsrXnLiCUZQduR7B6rQEQvbhZN378RijmPFsfrOZPUidIHK0r/kAMEsxK2bHp+H9OKpGOvtC95dwZjRgPcnli/YFerpqCJYQ6904S7wGKIU4fFDT9YYrrwW23QGTy3g+h2EN0OottBdDuIbgfR7SC6HUS3g+h2EJ255sy1P425dstx61nbohI8PmtWdYzqqo/VMSHjC30uUbtBaGLFeYAD3y/6FtrM6OXAwg1gTxyRj0w9ktrZZRYvQSJohC3jgpKSiHhCeoCwICSGv2WqZZrmI1qesRwVhaYOz09ePGu1dadPFlpuxwTWHh0uzD0LZbeI3y9lWcF/XygyW2CstjiF2VRJhO/KWuLLVfRFNMxfUa0x+1d9x9XMGERRrYuR+42jo4bvr12s2UH+/+jCZxTvphIsQJEvE78J74s/bPXNfudUWH+61aMj3//pp9EImvtnt/IZW6VKZZP4Hts6PTg5fXPwy/nJ6wvT1tERnizAFu1W7LbIFtfEcKpiVO7PYzDCYUEB9YnaPTg92fvpl4vDo4Nffu78vQMV/yJGKXPwKPAjjKKui59llEsQkm1US9svn7d0B6DrMElRT0zCuHiHckyrJc4WLhogIwJ2Vdzd9Dxgbw+Pt7cQMDI/oRdyrrZbreiO1nB27gUotNmIZBQzrFZ/d3VDQNfKiH5NG/AG5xP+Y80fPM1gvfqGhluNN7dr21LoZ1jItVBg/pgVSbfb1NrqQyMHdO6MNrDYd4O4GDOLpcVhRq2SAOkgFmflEOs77Fcny5p0C7RiUIuiUdCc+UGfPCfZoq50F2XWpzlph+sIHn+Gj7DEsRbaFHTQz2jEc3XSKSgln6CXASs7oL7gVDNX4PGY4mz07swgCsBT7BP/T0DTkcwK4DLRObcA/qwE/7J53iTNJ1SMn0GABl21Eay71Wq1G63njdaOaG/ttl7sPn3G9Qq6LJo7lRyZT3KQvv4K0hbGIND7hu45wnyQlmvwHEYQFc0NHPZioXpGWuSMPJ2TnvydBFrz6Kjp++JHsSazteJAlPgVBWUXB9dsPW/C4Dr7oAWUQzzdv+jqVg4ODuqCjlXVxdoaCrQv4i0uQD/nodiBd8jIVHIIjQtZFZvUojg9MkWGYi1eW/MAhddrQtbFr/DXpXIi5tdQuF7gcl9OQ2RrxgO38Z/UTR3HUBWrLe6qjtBbKEAcHGk0/PijGDKYUmK3LUIBjGSqkTADLw3ep+FjSyUCcXXQeNghTGBDJf6AZFqtAoZyVflnFWaCug1ld9pbrRdPn1Wr3bLIcdclYV6YXptb209XauEf/6CF8vYmdos2/i/8Ndberk0mjXzRUkZtvN163tg2UrYQjKORWQPpUO/M8bs/TtkqTQ3+nGld22ldTutyWpfTupzW5bQup3U5retxaF3Oi+u8uA/Hi4sUa8XNLI100SrJfUNdKPmAi3VxsS4u1sXFurhYFxfr4mJdXKyLi3VxsS7OSnJW0sOwklysi9t1cbsubtfF7bq4XRe36+J2Xdyuy59t18XFujity2ldTutyWpfTupzW5bQup3W5WBfnxXVe3NlYlyItzL1uS7NiVcob3JrITcU9FsvV4+I3f3hzUbIbXpnn4aSHuOADNUS7okg9I/6XKKNzTN2Dou4bUwVNFKBTXMPiSvUf5ur/uKjvAcUrJHPd/21B9bL7H61at0Hwt1kILLXtDSpnMB7498cL+uegqoi9uXBJvexL3ZzEdRL3IUlct2/mPDjOg+M8OM6D4zw4zoPjPDjOg/Nn8+C4fTOndTmty2ldTutyWpfTupzW5bQut2/mvLjOi7vEi3sks+EdJ7Cty2m+8eKaiv2hibO6NOHeHCwueAwLJrU8wBRHdSHDGCpPwFahirCsDMsSVF5f297UDLvs8npahHDw4qA8tVf7bW6v38QxNRC+vxTfG8V1PMgzpTCJ4sn/bE/oEBXMvn85XklszJ3CM8LjFtmhpQZ1IfIx2nJ+PIn4OJrk9zgz3c1u9dSYPlpq9IFyuvnCn6tIH0FdylnWGdQuyZUu1+0iK3Qtwbcc6PWgqZp13NOLPM5PgAdwpaeFCSJ9s0pERdM+UxiNFpZL+CjyKNACEiWPqbGhIWMwVwONMPktwG1UF5jbjuW6dcatMw9znVFE9KnaDySebQbyC49kcp3euXnoSN6R/IMkedV+tjMegpy/k8Q1WZypwYpRKCvNdU8VJ92tuU6oE0O7BJ+I8lGPXRnaaVc4amlxr4A3P9mwhpYzfHnOR8/LxAqE9mSqm2NXBzuTTdog+i7wHl+L/0DbeHd4fiK228+eNdqg+I2HsrGl675fN9qZipqT4DoYKz+QzTgZbOLTJlT8hSv+oivOrK+1y3N3aN3JlgcrW6iBv+NlmncYbr/L1cBWTgq0wDRpk9uT8ppggq1Kool3n2cQVMFBx8OwPLEPY/CyOJnW5tJr1dLOkU5UQi9u6rdOBWJtSV8n15lc0D5SYfQNzf50JvRMzretAAfxVKnD/aUdoFspGERxog6SJE7SFYSSpGBHtOw4gxOLqEShwYZyBD3ksRjFHznNGLNeBEay5muMYURGxv7EehhcI++IY8w2dBqTpxksZU9R2Q0xQV8+WuielyfNOyXS9y5uK/yb5KGq7lgu4eFoYaK7aMVEc2XQs51T7UcVAYCeQEAYq5FSPvEvLb4f42tAVm9aRW1lCTVN7MnQy0MWqGc4rkc107Yk1iPWg1xh0kx4ekBXlOp8UsekbaXli/Ox8gIZ7g0lvQ1VNMCr079hwkc5ZiLjLFY9ZTKMXdX2wjj3xblKPgYwWLGvUBLR1dGXWRACOq5qlSm+s3ztxh7iavHTduorHXkvugNELUzbGSzW8eicqncrsCwqwUpMBaurZJozGALU6LCHK4oKv6qh7Lzi+5bh4TanmgYFylYI0OQLi4oJLqDH1m8WT/ifAOCU4REeACS9bDHsmixXI0BqsY8Z4HD/kpy2ZHzQ3OHxBD2ZfpHvsZQ+bCjQ1qjY165Nw62lGkcapUfRGhKWprSuHcKfglE+AtoP4wltSepAl1TsPG1ZA5wxB9qtRy615hnn3uIrB2XzexNK2ZlJEGuy1BUa2qx0WlIUAULs3Wu1PpdBSFqXuMSErZSPbx1a2ajunRQkMRnGqZ0rlTz3Kc4npZDDLHXALkhXlO+2ryTuRNSLSAtMrIoNdkcykgOVdMW1mk7ihB0IU5ho9NnhsaY4vkZfPBbGXLJrMLVcpfSwD5SOB9NfoMw8DzdnmHDLe9l+0Xrx9Hlru73dbrda7eetnVav9ay/vbOjvJePmUWXUs97W3UM5r4vtwC/TXsEPp2CATcS6x7UCBueTBWQoK1KLhDOKMcTPmhRmWE1AqJ+XNPoHC/fleMFKE59ApvtjoTleU9z1Hx+8uLTKpvlpnA1IXld/9Z7kkipYIqjdKYMslSDs9Pa+YMJdEPfnEyYTHfOf27ySWvFzS/7rqYIlZgM9BfHw46HHy4PpzFuDty5LdMvgujv4FNraq2cyIB5pafNbGQUofJlVn9y4nI1iujc1dEHtG+xhQmXLyZxozBcqtsl66o5aNZBh748v6pt/FVklv5o9l+0AUQB92Z7Bwy0fAwEx7qh6W2behsmSq3QXwc61JXB3kW3CNcm85f8QotrvthpUc2qUKHBOqHihMqDFSqh6men8q7tmNt8e6s6V0DUoB8ebS19+4A+kqNNPcENlas8UobOWFA0WfLdDmVjQNSuqI/YwXvVfQXcyS2ERnEUyD7/YJ8Jwj4xFToF8sVsLsYLBvJVAWbQEXQZojIjgdjWr2ogdzYs8BBpetQzguiRuYGcDPq+ZFAcX+fjO0QQndSYl0D8esGsLxv0LRQhfj4/ORbcAtLstZo2mDHGEsbIp1LgZXEPlbZx6LIpuoAjy9RonOndKLrsiANZCtqpG19T6eDFh4qo4wZtBtO3K+hULRoC3bx2Oz95cgx625Mnxr1leK6gcSNosDb3jYea/soaVlSUz1CP0joQ+sF19Kzs4e6rJhbrGiemUWO6LaBmBh5Vr+g6wmhTDscB2WaWgBnmo5GNxwZviCDT4ozj7TOqcyi9SG+TKEZen+GLg6MDPCPWuTzHr6edvZp9JVIVECJOJzmd5HygknOiEheK6sj7cZI3Vj1G2z8MfnV07uj8sdI5xxd00Jt0zF6oO2n9XmENPNtVC5w95lNjBKfAYZs6oBqotYw4sAIgjH5KO+L6ri1WP5/wLZ/csgn5kMIkTDSR2jh1QFtIAfC9F8ro2tTnzBraDbAkqca80VxsK3e3t7qmud8wAKO787TV/X5CMJzo+Q5Fj5M6Tuo4qeOkzu8mdUzU0B1Ov0WheysHpB3uW/Gc2Uwg+RiJ2Fxea80HzTHGlk0k38VMF3cH2TCI8HUiOPIguyW4/MA0eVF8dnzq+PTh8uk4lJ7qhOEf5p3vWHeeL3TKH0iYbfytqbhgd51wqhqDhJSPUwjNlL54PUwKxtXahi7Gt5VXvc4NgErAq6sa/FiDH//1/9FX4TzJjtMfPKffweYJqPKf6F3BMPNMz4VWW6P1gW9p2A4ZVFADBfsG0YJVWQNQjfF79/9k49dO45/va3el0DmjHl7lQeiTX7GaOof6b7falC9Hs3U53ntFwy+QLDO7exSvGGS5z1esJ8i99u4i7flrTKQgwfLIr45aOA3DyZ2HK3cwlaALQHIBSE4IOSH0RwmhFFC96DoYWwL5KgxGQUbqAh1JmBdGZZF7KT/6aGzBfSW/WdpQmb6OzZYg5Sw5s0fdS/9jn7/0EiWvBeX/g86yiVJgEU3i8pxEEeNTkTkV7q4zefurqHV3SlpOv6FCVopkP9MMXhV5Q4mnLQFWmhsmbUkpkv/KUUPUCkVttRo9PN2lA7fqQKdahuNRkWpvkzJNDx4qaTH96/TVtxRq14XKvKrO9ZRSYAyTeLLKQegy6eE60vwmiRRzHpLZeF7mkQjQSSssYUedRtYhGcQoCxNerTgvYqSBBwTFfOtXDzXHtMxBmVDaYlSnGUUmCyD5xlg66DYKn3Qok4G5Zc14741opUZMZD0nR+Sw+vnMgyYi7JDOJOXZSf8VwVbk6LiqVVMZLm8oysPwq5Y7TjZSYhJIiduyp9q4JFxKELfUPYqlLoMBLNro+6rsS3eemy+SKpH4pvhaEyxa3NyRxPlgCF/7wSflm4218oNn7jkE4mF+4KT6iPMOKKrwn7+rMPaQ2C8wSRF290ZGgxwTt1fENnf9PzCFPzkm73ITnBOySl++gGI5rhFFboHfIuWunpLv3n1YpdPivOlyUu0pzHg1R6n8ukSbVkkWUOrCA6aWRRYX6Ua0mlQsu+VJ02L56VK/XTqpxqZZo71Q8FA5TO9f9tQqcFwIvupS1K4XR/twPNt08IwaOun3obuVhkuX0NjqmUmytHATPqacw1rUGpiNPCRNg7FBlGIhRHDORBT9dmKHOAIRT2pr0NfNaSndaM8Ed28vGqyK/N9oTkG1ojktJP4tswpzqljbbrRRKNkrCk6fDEOtQ5ZHnhcGwBNX4S7igHJQMEax6cqkFz3bqHh2Cyp+n1lXlTXwG+dc47LEID8vpICF5P5dC0indz1cvQuaG7kAZkfdj5O68/HYxec78n605J0vTFjsqNuy3d7bSLSj35Yn7CPEUo5emP2vC/a7jIJ/AfYO93mg9onRivW/5fnPX0h/MPxw/UFu73wYbvXaw+sPQ5nmyvOZQzUcd8/Z4YJpqsQ8YztlMryGlyiaoXIiybnv5WkWj1Qy//3OWUGcL8D4mZI+zgcMZ6fVmvdp7IUBOrkpObNoiLOZw8U4NwojqWN/yjeWfsRML8ilGHutAyAkZmHxiKs3P6ScrTD1hmokF8m32V2SDLCyF/vq7ql9DXKtMcCQaSRuApnSsrB8oqhwvJ+QmzR0TuWqjh/ARLMtXklfnOnx7enBINGC4XMNbR2uTmumCvBUsb+xoFv1XMnes9bLrZ3+sx0pt17stJ8/7b3sy+3t1sunLykz4Ag4UA4W5jSvdm3yFtNVh8GvCt3WEnDP+cqx89qtadDnts3pmsXVEulx2WKYGl6RqU94ml282jsVO89FqB1usDrMZN5SUePyHN6gb53DAU1mVmr4JAmqrppyu11fDrp/8Lpz+QbvAT07+D+XB+fwC9t6v3DnibgyJpNWX31pBjCR6JQJAR3Kb4onutUnMCCpM43pguZ0PycQ1EwHNXTvC2rYTdsuBSY14ptPmdlh6eE7PkGv963Yr/Sk4+H+R8O4Lp+IIbCySjaaolOsjybj0khOKW7K98sbrvo5ZsakHR7c84F1PJiNkCpRWZ2NUo68sScFmQMgX2HTz8tyvH+TcrJbXFhQS7HFaC610hd9VqC7sJBGKMW7SL1M5+/04gQT64seqimgfWhxxL62kYxMuUJi2QsSibsjBmY/i+mbJ/Fi3zv57jQE8dOgoRUfPirNfOQt0dqSKNUYI5GMvoWVrV01m5FS0Q9U6DvedbzreHdF3p39eKbSMfCi+UqqT3te9bmMZA74TWjxnFN9EsXWjzCF2GjhiayjuqZVpJ/fXgBjXytyXoMZhqrsb6gf8VI+B3ynmA9+3zN7YGbpL+cCASQ88gj6IImUv0twlxATohhV2/O9vY6TXgAEGi1QETF5MgXj4mXMSR5pW6Mu/Fil0VomhhLkI1hpeAG2SeKiIr/BO2JOk3SapFuN3Gr0aFYjp0k63nW8+zB5d6kmWUBF3KL1pDQfjWQyZUozCfHwMjkBBTCqkuqLguVoqma1FWxMFDpWrao51Hpb7V67/9xTO77c8Z9tv+xvec+25NPn7eft3s7W85q91r8r+bhgsipPWfPN88j3I6gETxrlERBXmsWxX6FWRG+i+ijWKB7A6M2A8yZe7FDojjvzuuNxnMHY8HrpxlzuQtP+5dkbQYfAuXnEG+8eINNyAkbyhqNKSTsSdFbbqY5OdXTLj1t+Hs3y41RHx7uOdx8m795Lddy5S3XcuYfquCNQxaKj4H+k6uiD3oGqWT/AiI8iMU5xvFV7HzXbZ3h4KCsUvYoWufVyXou8iGNxJKOpUZbSiicyKtGF4g3KjrBsYspioLIYgIiM8Fq8IOY422CkUCfFAwJ8Us/nnN7QbjJtdOgoGvNMGeyte9FB4PbFkDHQWICH6vqo/kEL5AcdgKD+DX2cera+yR8szuhIBI6YLkJWyPOF//fpoiiBwyKCgef6lnAB9pnjLXyR+jRm8VWooE5Vd6q6W+7dcv84lnunqjvedbz7MHn3Hqq61oZuV9WhwMqqOpRttkShS72m6M3fW2PvWPGofPZdX5/plzo4ICFV8BJvocZO8OrmPSblTo75dTBQN9otglN3+X7k2nsMQR0pIEIcyjgmF+1YYo2addq1hs2jHslDqJ6a/QwzCzN605TjoGlilKN4Qkdne4pSUdyeYAsLiM7poTZKmjQXfLyXZSM1zjNjboApTucubdlkC6Wsn9xMXQBraNLjZKDxaAx2x1pKpZs6bHxmfDCuyyS8+faxcEO3jGUR+pb2BuUFQDozxBqHFRtqOEclnXufo4ly4cHtga25zk6w2JZ4pWRChy4xYmb957cXG2Kgr3b39VHuIgPKKZAIib6OiR7BStZhcAS8U4nPQVYT/RAGLK6ic6XEO3MT9TGsCWcgxAmlWEmR3MBa79dXObMNGNqUlXobtDSSDRFEfDoR3javoobYD1Bi4YFuKqOHyIck343NuKQ1rq8F4i+mtQa31qDW0o0ZKBi17zyO9/aA37EJGaaEra/unNtrWO2hwQVvsNVZGBATGo5qVJVnZu2r4ai018D2qnBcRW/pAEy1mmBhZc5PHApvGMep+t9CIOkgG7wb5MBFXw0WnbppEEc0tloWSA3ushE0QIsk+N4AY0RMTLKHqzgpMTH7U4gluzSzwPNdOlXTrYyZXr8LIoIa0wt8NczYYQM7bLAMSDX8vJalfOspjoHkABPAXjn/JAk0oJbc47YWSnVqfpPq4NLgAah8yfR4lx92SwFnErbQByxdlAExXKPTQDrODJ6FbgsXtAqyjPtgFoPz8OL5mmgGbwxvsQmKa+ufbbw44k7pZTmJwulvLaVvkSR/Hrn7B0k8J2keo6TRajF6K7UP8FXsTw/K04gRHyG8CEA/yuCtuIjFvsysFLo+PL3mFAazRxQrpxDfxsm1T56E2ZOL+wennbOLo4Nj1Of1ucfzOLHOPu7W9MmxaoF94HEVcXpKfXpMf2UP7ms8EvkmiK5nP78OQkpgV/uPdTy1+VEZrm7CIJMsfQuq2vpVDUzqNwcXB/tPrmobG2XX+vjmtGhlfQB62zht6ns70k4Yrn9e6/ijIFq72RBfvpBxSPzyww9irZNj9vw1bPHW45Qa3tnTtP+OU6E3dCawH1M32oC0pdwrrbDPu31TOo4L/8LXlJPIAELAwC0TsNkNYdIik71PesNAkcNoDBOLyn8dRUs8IlGsz2wqncltQJOfAM1KMPGDECcKtzRMz5IkJlsWdDA3oVQlHGATY9aPaKCa4i3m+QD8JWi/Y2g3fPsQa0O+OMQo9g23g9Y9GuURHiYFsPEGE5Apd4gEP0i9nFcuoIZIGVzEpPsXtYwYR1mDQ2iSJQtG5Ekf9yICT9Xuzrik+wLGT/VGBKDeYtpyIGcq5DRMtVWzOZm2Qdw0hiocowcBll3QwG2xcHR4MdciNBbp3a84GWzqSukmloVG0D5m8tlutputBtmLmGcWzGqwt63G92jWK2dFK/T3udx70WUxT2KkJvbxUyaCYDRSfgAlQiCcV1PjAqtrF47xG4RyYCU14sx5RNXs4xE6ca25SJePtVo3twpUSCxKwjxd8VThfhoeFiB7lMmX6IPHJysnz/GGHgOPhgPdWU1xrCboMtIHaIuDsEV+TU4+E1WYToCk6gd0le14TEkw9R0fWOjysCk6WhVidi3BAKNYmXC4jE7ImtPMBDjqZIQGIN1muRKg0bw5RscwTmjORjz7Sd7VLD8JWN5DdKLA28+f0WOIjoMbfA0rELqj3r0vfQL4BK2x55AcK9cKPVZ6q6pxMSUFUrum5vfg0FXBNdgbubSs7ec5PUG/bA2PCNMWJTu7EjlBsQ3/7tau8HKEeo3zF/DpeHz/uWZcx1CG2zWa+iJFVf/AYd7c/Ddm2FrA +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 nullable 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 + +
    + +string + +
    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 + +
    + +string + +
    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 + +
    + +string + +
    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 + +
    + +string + +
    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","enum":["LT","LTE","GT","GTE"],"example":"LT"}}>
    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 + +
    + +string + +
    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 + +
    + +string + +
    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 objectrequired
    + +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. + + +
    **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"}}} collapsible={false} discriminator={false}>
    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 objectrequired
    + +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 nullable 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 + +
    + +string + +
    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 + +
    + +string + +
    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 + +
    + +string + +
    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 + +
    + +string + +
    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","enum":["LT","LTE","GT","GTE"],"example":"LT"}}>
    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 + +
    + +string + +
    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 + +
    + +string + +
    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 objectrequired
    + +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. + + +
    **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"},"additionalProperties":true}} collapsible={false} discriminator={false}>
    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 objectrequired
    + +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/create-verified-from-address.api.mdx b/docs/api/beta/create-verified-from-address.api.mdx new file mode 100644 index 000000000..20ff7def0 --- /dev/null +++ b/docs/api/beta/create-verified-from-address.api.mdx @@ -0,0 +1,83 @@ +--- +id: create-verified-from-address +sidebar_label: Create Verified From Address +hide_title: true +hide_table_of_contents: true +api: eJztW21z27gR/isY9cMlGVGyHSeu/aVV/HLjGydx/dJ8cDwTiIQk5EiAB5J2VI//e59dgBRpyUmay7R3qZKZRAQXi2dfsQtBdz2bKydLbc1x0tvrxU7JUv1TOT3RKjlyNhsliVNF0ev3SjktentXvTe2xNuYJxW9634vUUXsdE7PYLHPLIQURt2KQplEOaEyqVMhPSshTSK00aUmuhtey3MTubMxKAZYzanfKlWUr2wy7+3d8aN2ChhLV6l+L7amVKakVzLP08Bg+LEgDHe9Ip5hTfpUznMFVHb8UcUl+GIJSFxqVdBbnbRoitJpM+3d93uMd/kNXnySWZ7yEEv29zAwiG1GE9vSnJeyrIqVXEyVkSZPD98cHL/5GSPnl/v7h+fn+HQ0Oj45POhd34NbqUte65DgeHYHpWWANY67GutKQPfEBTrPYSkv8NbGJv3XNdkbWKq2ueDFRAD/f65o1t/2xsayyvZTDa2IQ+esE5E4U2XlDLSnJ6KcKRG8V4zhvkIXcPcbmepk8P0UmqgSWPdtolYJ3gV7pI2Kpk5qQqgYcoyJFG43OsEMkVmnhGcprBeB6QYdU0ATg03xSiaQ18u3H4QhHToZ/wpexyss/RDQpdGYL+opQidiAlCPLKt2lBy/3Njd2p683JZy66/bmzsvxrsT+fz5xu6L3V1aPUPakFPV9gLpnJwvLf2zMnCdWKQ2hkX+BYUgX0H3DIAXxxRdqqz4sg2Yx1fo/wJyedpGzIBXlOpT2UeyfLV/KrZ3RCrNtOJxOX2gBBNdktuaKk3lmIYoEUJyz/it01NtPhcDB4dHo8uTC4ycHf7j8vAcn4jXUv4eGXhrQm4JqPCFmb1lxEGAW1kgq6dQh0oG4lng+gwCSVO0CbV/KuYFlAnfmsgqLTEjrL5iRpu1mGDv6YQSx82nUjzRAzXoizGNZbKMZ2IsC0yACYn82SiOVV5GJ0GTz8RMSSSQpwOBrUyTkDIViEYwxfw5GNHGRKHrGUwqhDLA6HJmq1IY7Hax6tpiocquNRaJ5KRtFAoOIP+yn4zisgI4FrMdhY23BIjBPsDsNddFd9FSGqt0bkoZQwqZpnOo0TloWIwhmy4LEdIRmatA4jE1XZOxOvmR0Lz2YHyCRD6TVfEVcXeaIv1ELFrz4kaF4IMb2JCN2Bq1mUJGwksSmycHqsZcdeALbF5pso7ddeyuY/crY/fhy7NQKLZLnxXV4qWRFfTrePNcKn0ce4+xoibylb03ZF9AIaFE+uXdBQL7V2WIXn3Kqbr/jvWR38qXwI8ae/jxMZUfjbE6tiCArEcvwQSZSCV7jHuBmBXlVfV8ebUj68YaDmpWlIjImk7MbSUkVOYqYwiJLPoisaowP5ViJpEfZUwNkc+AtKpJotxqU64ryXUlud6N1rvRj7MbrSvJdeyuY/fPGbufrSQbVBwtoU4qqiyTbu49LbwnaaUAgaiPLEUTcmyqh9UKMRNNjdXrVg698dbmeHOyE6vtRG4nL5/vTrbil1vyxc7mzuZ4e2un197rrxZx3ARZN6Za9vZ2ZBWjiLtBHVfRGWVRWpt0j/+gXqcmlNYo9TR1M3QOlV43tePW7nLteGGteC3NvK6Qik4NaRY6opwG2oxoXU0LAimmyItGIFVp4CJX0pkCF0fn7qnONAcvSQG+bh6NJiVE8YFSO1mzijZxWgEhZ4LUUtVs4VgaQqoJ1XzgwBXsFNn5O1anwUS/q5IXZyTxCUksDj/FSlGgN5X7i1Xnu8cA7yhHnHsDP3LQ67sdaeAAaAh8zmrqznV9vq7P13v8eo//Mfb4dX2+jt117P45Y/c/qM9DNfR4fQ6Cr67PQTvYEE0tdUTO9V8v0zlUAgJ2b2HjuHJ83FzX4FxXwJUIUG4LTiKynOFpeBMuRkTk61G4w6LoaoSv/T2qytEdjFlZ5sXecHgHY8FI9wOZ6wFyGOxVzo29pdsLwzE0tCL50C0BH2hEIEanx6G5GLB6nSYP9umOmXtls0Dkq1A6Hwx/lrORGVtxbiskOGbTF/D24E08DIg5WomfCqYesPcsyQe5Ll16//tl8YwekWWV+j67GugFkD4QkUS4JnPB6mDE9roEnn2fq0YVGfrquk1zTrW5R7hEudhvqJ/bWgL0lsi2xCslHRoH/xXHk1/eXTwVU6pIOSNUBRXDSlMLgZg6hRtxxhvVx/00iTchZ6vpjIUbdb5QoQgTkxRKEe/NuVLi6jgo6g22gjPkblY7TVKcLmjW9ZPagom6USntkoOFtsk5dWKG0OJQduY95R2RWwdt8DHj0cF7E4kDTYmKroIxTRCRO0FxlddyyZZc3wriLzW3yHOLmFvx9AEKr9qr2F/QiRHmxEKmBWvrmxf3/KIWP+qzMEJcH2IgTQQc3a/B4tpq34yjwy8ifl0c7827mcZ2250mfHYTBXbLNBHHIp5ZW6i/CUGuQ6FyNa0Qad8M65YWjTgioq2NFqTILxnpCMUj4ztBYBjvTHJMmzfXLhZlnUl82H5gyyIvfOC7gh86MvPwFfZYokxsXHwzZlowogUjnyeKgN9vYeRYiG2SgfOAd4D9hf05EwSgrdzoea3M/Mx+yHNo+4gBlbkU+Z5/2FskwfBJ8AuibmiQqqn2br4YxLMIvGgf6yirPjV4qMFlvKnF9vlAbx5vc2pFW+ofTV6SeLQ4XHlr0vn3ztKPZJI/Tt79H2W8dab5ETNNqIbpkPJscQX7cHHfmG7ytvrWx28fr76k29zFxSLk0yxb6E3akfQqFI7LJ4p05D1T+BdvOSFwdY/eibtBLpXajPJUlhQ6nDrimVZ8FpErWVIR2if3tRmHe7h9jo6TGU35IruDXiS6R52CH5+W1ytLjkpf4ZLz0HNRcUNEa8Uz9LZqIN6hPTQxbE+tId33wLuPNvSI59DeKXmPOKg9CpVdllUGq1HwV5mQ8NsvuF2ii7jy2RGdolG1LizXl82sOlWQP5MIA26SXFa8ndAxNzrolnd9YS04V309HKonK1K7QP1XI8iZSsOPBPoP+ocv8YZLRzOV5uQkSO2o8lRrhdfHF0scwcwUkCtWA+umwzCpGBKtvy5eePd5PtgcbETct2Ccej200y3m4ecLzXV4+g2EWPwIouOLd4sj/u/1s4ewaVG3MczpII1QVr5D8h3pVe+xjhT9y4x6V5Dc3dFxC7Vo9zSMOKZe/up60X1xx4MJfOzCLdGvitr9cM4fXcx5Gw59/fIXGNQU+hn+KOeztNet9vr0LR1q9cbhhx2ZPylw8haD9O9e7z3+4sHm3nno1x80jtY/nBaBxvOlP/8G/JLMuA== +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/create-workflow.api.mdx b/docs/api/beta/create-workflow.api.mdx new file mode 100644 index 000000000..c416c270c --- /dev/null +++ b/docs/api/beta/create-workflow.api.mdx @@ -0,0 +1,127 @@ +--- +id: create-workflow +sidebar_label: Create Workflow +hide_title: true +hide_table_of_contents: true +api: eJztXAtv2zgS/iuEboFui8ixHcdpDCx23cS9zaJtcolzvbs0wNISbauVSJ0oNfUF+e83M6Relpu42e7eXiEUbW2JHM57Po4o3zoqFglPAyVPfGfkeIngqXirkg/zUN04O07KF9oZXTn5Je1c7zi+0F4SxDgL5hzRHMaZFDfsxo5jN0G6ZOlSMBgcJMJnaRIsFiJhXPpMpyLWTMfCC+YB3AskDU3EvzOhUzZT/qoDi2vhZUmQroCBW+dSi+RIyVR8SsdZukSmdDzK1xtFXPKFcK7vgD9L5wWQcUa39BVZcEZpkokdx0MqMsVbPI7DwCP5d99rFOfW0d5SRJzuhuHpnBYvSVw5kkcCmFM3UiSw3s6tk65iAYpQs/fCS+FWnKBW00BopELjR8UoDYqQC2ddi1OQH0cyNSdd3JQ2EJ94FIc490KA8iYRD0LnLucAKDcpBT4ICJoDUjxlMFDXiHYYw1FE4IlmwGwUaA3TNZri5PgNmC8MwXQp3pEwEclwL6UhVUos0AzUpG7QwgopzVUSAf1TpK2XQcw8LtlMMG/J5QJGzVYsi31QuVwQJWICl+Xs7HLKVMLOxtOjn3Nn6DT0afTY1KeQWYT2OTmevJmeTP+Jnlqqrri6SfFIChVvLGiUBoIlYi4SIT2wO6g78LezYiYD4By0mJuy8IuSm7532Hvefb4/fO7t9w+9YbcHnzw+nB92vd5ebw/Xe5zfbFjsLdgy4BGD/9HF7+7u1og8tMZx+Q2XIWeoOQH3PAWLBXoJJmo4LNhfoM+ig6RV57xZKvA+nsKqsywVOveRjkMczgMZrDFYSNdUQsRjZM6klrTBIjm0+AQZJRVNn9IpT9IvVzZNQ0fGVTufCVU2BTdGiYi1h4U5hXiDKIhUIoiuNakVChWdBBp8dgkeWgnos1BwuKyFINbyhM185WURKJySHJogH/HLxekbZpIdg6BlgntLsyDyh9Jw3ycD8PCsoi2TRAtJb6tZCZOmV1QTyM8a7rlkfaRXWBoHzig9g05BDswiLEU97TjzREU4GebEKpDpT8WnDgjvYHr3gjgAkU78zncw8rtO7lHwActGZhQ7clKreQlF4wIkQ7KZ5wmtqbqEMOpc6CyEsTILw53cMuOj6cnpG7KZHV5xDXvljuIIVjUxZtV9XHrtHaYkPgtFNW/MlAI7yYbRJzQS7e4Hmj6u5euiAGM+lSqllEqVl8onxphZDJ3SuDhEECfZ5jzUVZPRd2TelOTt4iuv3+SF5Ph6vVBVqyQRrJn8+ksT+eTvkLLh++Qf08n5m/Er+Hhx9PPk+PLV5Lie3POR93CNa9ytu6CSwhb43I6Tj+BJbGpnjcvROw+oqBwKZSMks0CsgVlOrG++gVicTC+YwBXWlAVu29DOo8tNbtWqggJfjvIgcUsduDbhombmQQjVHgPqoVUpccQc8J34FCeCgINxC0qyYRAF8HEZQDohYXWVLTNmDpIzJWs8ftcx3OirH7//qVMwyX74gT0x6C558vSaylfFXp+AaUhQX9VkIidaqrIBABv22q5cj3N7URnBtIu62bBgqRcteOItXcDNLsR9MF85X1q/x5jHMY0zzwBoxmcqSx9e+jxDWGYYIOBuGLBgHROnXrPHBdQTP8M09PUMQkXKEN1sEC9R8sKI3jBL5d4WxvnIw8BnR+fg4KVvk0qMlo6Vp5uIe208E6huZDJLoCQ6yzSN9Wh3F1lJ+ayzyJJsl8pDoegue8ae7e7B3332DFXa2GUV9bypV4BLGyqRHbfxHu2M7q5LFkioWu5rSllwQAWOrANYHsOF5pWmASVmogyJKj6obFqsKSq4HDPew8g4B8YNWLuuscdiz3XoabFhA9FVAN23h4CMDA8ioArEsSCjiSny4lyXnYz9UFnKq9IXVQdgqpGFtvbmjbmmdejWoSvDSxC6Ln+12DRz+p1xTqgSsZLazOh3u5s7OIV/FrXyEW2r+xtT2yDMgo2T4w4r7Xp5CXhzIST2DiFUMhDI7EZgVn0f7Pe7PW9fHLr+3sHMHfD53OXz3sAdDge9wXzv0N8fHppaiFtzmH6kMlndioOTCBOG2Fniqbm019+8Oc+iGdRGRMJBJHR9k8yWXMO2Sci8D+DXWO0jCAa/zBLxO/OAq4DW/AxVzgrJa9x0gRu7v9tkpYIPH0a4uNBGXnzqzEIs44i1hggwYheoW6zf7ffdbs/tdae94ag7HPWGneHecO95bzA4+JeT86W22DcW3mNnQIIq4nrrvt6DJI+np0XLYssm4JbtvHv4x4BYa+kdQJ7ng+Gcc1+IAeT5+Wwgur3nXr87HPS3b+ltWNUPdBzyFe0a6su+hm0WFyGz/5u+RNuUbpvSbVO6bUq3TelvCMG2Tem2Kd02pdumdNuUbpvS33BTunnDVrXBplbJUYg1l02SBLzWZecizRKJ1WfeOFGE9TyQpMzOl7RT7t9IwXYEkMCR8reIs5ewa3EXCQ+QQ0EsezCRAcWPgY+QjfCVIZlnThpXh3GgiU6PveA+yGvkO7LCUP3k3gegdbJFqr40YZ9PARBcRn9zWXEg+GzYPewP5sMB5/3ng97B/uxwzvf2uof7h9TGicDbIClWsQlPEr5qLP1XbB4FHguVBxb5DygEcAPo3qA+XBwbqKmINoLTug2IxpbbEjO2ENPyyzAB7UBUvzg6Y4MDFkLOz+g6X6wpQbqXF9izBWiG0MZAT5DcED4FBw82Zr8cQBxPXo4vXyEwOJ/87XJyAZ+QViO2xhK81Ue3VNRMWkKYpaUA2L4xYBG2JuyZpfoMBOJ2N2wHBuabXgGKjpiFXzDDrr5hRpU0Q+BbC6U8W38fdERnBxAfXIt4Crl4BlDfZ8qc5Xs2BkQap+4rq8lnbCm4L5KnHTYuEDyjzrqG+SuEjgDty8OA8wxCWdA5QiwLmOS9td5Hqcq6NcoU8qpqFAwO4HyLlOulGRYfFLMahYW3WBatfYBno7k6d9OK0kilK0i0sA+BkeEK1JgkuK2HZMkCQCM2HaG5NCQemY8rMlY1ZVK6e22YOU4V3fN4preIu7MQ0o9LohU3PgobfJraJZSNyBq5mWxGsltlmmxHFebKAx9QlAj9Nnbb2G1jd8vYXb95bh8Q2bsEfXpN6HMpeQb6Tah4NqBPQt4jAanaQabVYgy5g3t6C5F+eTuFwP4gJI4HvIj49SviI1PKG8yPC3uY67O885qX/tIWyCDp0UhgHp6MiO+SYyd/ujbo7jVXe6mSWQAOKjdARMiaCVupjHFQWZJJiZxwvcN8JbR8krIlh/zIqb9iMiCuCvse0/1pkWSLJNtq1Fajb6YatUiyjd02dv8/Y/deJFk/7Glxks6iiCcr42n2PkrLGQxg+VGl8gFucRSuilaQGCswllNHDs6s35v15geeGPh84A/3Dud9b9jn+we9g95s0D9wqrX+qozjIsjqMVWxt7EjqRhA3EfAcZkE59KpUn69/QfqTcQc0xo1b3PcDDrv4DnYHDv2DzecXFCKveZylSMkXcOQstQR5jQYG+HYJB9LRwgWkBclHkMIgC97Lgio4Nkp82ACgxelALrJyh3PUxDFBEr5aqRdJZBemAGHlAlChahZgWMF+OxtjpgPKBCCXUB2/oro1JroNyF5do4Sv6JHMZNPnhAY6AVy39/U3z2R9knAhTHwZxq9ZrfDJTgAbAhMzipwZ4vPW3ze1vi2xn8bNb7F523strH7/xm7X4DPLRr6PD6HAVvjcxjb6bICS72kE1h/NEynULEckHsz5XlZQu3mHIMTrgBXQoZiRSfv8EwPfNvNj3SZU3IIBg0f9eMMt2AeMMtdh8dBcQJPqhs8pbc7A51sSDfmqB+6Cg5g47MTu53okEKTAH3WJDgibtRrj7GVRwLvpZwf0FypDFIakdnB81/Wf+gynqKEzcMTbY95m0Msa/KBXJdJePfbZTGEPiPLJvXduxqMZ8Dpmoj20Ej+Oy54Dicyqzd+zaWsHrg7a75ZcYrD+uyF4AmenKMHFt//8nb6tPoaiqb3KQLcEODJbXARyl/jvHmPk6ikJCpbmJ+nGdcej2C8MHO48Z28EIJdVU/KnUMmJpXiJEHBj7Ouv8+t44uPIsSa16kdD90NfLkLGtrltXlPqb7RRiCQ5oUOfAvknXTZcYBphw624xgrIu3r2FWcy8Urcj2Wib/k1FxDzSVq+ukaF0a1V545buNB0CIJHmrS1qMXN/TcCj3cNcEVpLrOA2rC8lF/qOXlVns0HzV6LtKr8/FOvqWjg/VpzOQqpqH2hT47Yd5SKS1+ZAxdB8PgapFBFD2aLTqv6FJEuP1uhSXXLOkGLkBB4u8VBIY0zmTO0RESUQDSpG9C8leyLMT8r3Rq7teazHT5CiomjvSVpx/NMy7o4oKuyQHa8m8KEjoWxLZJ5HgSjhzgqLQ/ZQLLaCXvGVobszqR36U5WBo8YNUcn49H5suoTHD2E6MbOLoYA2kYkXTxmA++M0sLq1JNWXkPYF2DTX5DBcVwTW+G36IHhQXyzyYvSjwuWyWnMlx97Sz9mUzy58m7/6OM12aabzHTWGyLLcfz8sfpJuXrKu2b5d/6ezl/0E8lWCG3fmvBwRRILNiNaTXxvrB7iGY7md71EvAv3KX6QVs7MGf5w49VQnHIU8y0VGm8ZSCoERULnqJKdjDbqYiqQ5wo1Bh4GRFa0NtECYQRD/ksCNFu+KgkX5lTEjebHcw1+N2aFNcyauiwt4IJ6UGqwL4AHvaBe++VbRBcgMucocuw4zwBwUYgijKJ3g9sZxF4P3soS/mB9jJTTD0lpch1oWg7UszKKwumPxShQzvkJNKnc3zGEXiikoweWAtykbYPOLiXVvJIKcg5vrOABc1ZP/n/EG3IgO5ShDF6NiAB2BRUM9Xrk2mDIhCTGuTyREcli107Se/iWCCCW3bjPnudXqfr0hYWruNGH7yyQtz+pGjld0jXXi0pHun8jr8+amMSt6i7MfZSkdfMbJlNU+LKKZsSsM1dYsMCLt7eYo8Nd+l3eBmoYgPn6rrcgOM3IGZ6bdTF+CAwvdmHO+7UvKdmmznNp1bYFzAzTP/u3rHXlZ7K2Sl2Mm02vXUi0x5KOL0oB/+OnHfwB2tPbJwGBtH1WydvtsKY98Ubu/wzqNB+QDHv7v4L9IwPzg== +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +
    oneOf
+ +The Workflow object + +
Schema
    creator object
    + +Workflow creator's identity. + +
    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. + +
    oneOf
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/create-workgroup.api.mdx b/docs/api/beta/create-workgroup.api.mdx new file mode 100644 index 000000000..25210665d --- /dev/null +++ b/docs/api/beta/create-workgroup.api.mdx @@ -0,0 +1,91 @@ +--- +id: create-workgroup +sidebar_label: Create a new Governance Group. +hide_title: true +hide_table_of_contents: true +api: eJztW+tv2zgS/1cI3Yc+YDm24zhxvhycRxdZpE0ucVAc0gClJdpmK5M6UkrqC/K/38yQkuVHHu0We7uFUCC1qeG8OPPjDE3dBzoVhmdSq5M42A8iI3gmPmrzdWJ0ngaNwIooNzKbB/vX98GVFeZQq0x8ywZ5NoWxQMZq/66g378DUhHcPNw0goxPLBL8pm+FUVxFgv2GNDaAh7GwkZEpygWpw6m0bHB+wpx4yzhT4o6tzmyCOkb8Jxc2O9AxaHRPX6URoHpmctEIIlROZfiIp2kiIzJt64tFOfeBjaZixvFTNk8FSNajLyLKgG9q0BGZFBaf6jslzCayZb3PkOyVZTIGmeCj5hojN7/kYzMj1eRRPkfDM4aUyEeofIbuOzk6/jA8Gf4bvSa+8VmaIKNy9KEBK/ByCYWm7OSIhJQMO1G/vdfi3d6Y81iIbqvdG4+6otXeizqt3nYfBSk++w5jYmnThM8ZzlqWdZmnqTZZ8AA8QRkao1lHmX6pQZXYoMh7xKC9nd5etNPpRz0waC+KeG/cb0Xt7fY2xRKPz1Qyd8HzYgPXRK9beHTABlEkrF2LYbRvid13S6s8XhG6eMD0mGVTsVH6TMxGmMW5SxMvXULeTCDmG8FYmxnP3FCvW5XQ7nXb3f5eb3e71Wqtum9V7w85ikFFnECIPUU6TVYMaqJSkLcKMgym/gTFHlNkIeQJZdbCohKkJS5SoD7gIyNsCvxctndaLfzv0QWkNWAOTDzWxSixRq0atWrUqlHrT0Ot7iagOkwkpBk7NkYbFrILkeVGiZhJtyq+8mIjKL2YRF1ueSJ/Jn7FIuMyOdTxC8L5nVQinBguUUNBKkcwkQHHWxnDDDbTRjDHsggsolsOP/BEs80OeAz2OvsOvTHoQcOjr8Dr5AWpfaUkzGfFFMAsBkv/mFixK/io1+p3uuNel/POXre9uzPqj/n2dqu/0++7kLeWT6qIHHBj+Hw92QSgkIxYoiNYkf+CQyAYwPekAAmHKVCXz+zza0A8XuD/IdjlaEszvb4Mu4MGlPAHh+esu8sSriY5jfPJihNUeHUJIypPEj7CIY9ojvGZkRO5EWuKXebo+N3g6nQIIxfH/7o6voRPyGutvxgoiNYYw1JTSk31HWnsDbjjllmRgDtgO2ZvPde3YBCHnKsQSvfNzi04E2JrzPMkgxle+oYZVdZsbPRsKZUi10qx17Ipmg02wjEAi2jKRtzCBO3S/S2icpqFp96Tb9kUkl2YN002iGOJRvKEQTYCU5g/B0aMxzGmrmMwziGVQRmZTXWeMaUzGa1if+nK5dVYwMhpdVEwOUDz5+NkEGU5KEdmVrOwjBavol8f0Nl5blm7YcVp5NK5yjhgIlAmc3CjMVhRjcA2mVnm4QiXywLwqIKuRKwqOhLcvXfKOIAEPOO5fUHenScAPyGZVj64FT75IAy0RyNajWKZPCLBQzSbJnuqcrmKxGdjKZK4zt06d+vcfWHurj688O1ZtfRpr5c+V4rn4F9Dm+da6WMoepRmBRGVN34hGwwc4kuk3z8OIbG/CoX04luKJ1M/sT5yW/ma8oNyPdz4CMuPcrGW1gIVJD86C8aARCLeJ70XGpOjnKu216W902YkIUDVhhIRUNOwuc4ZB5eZXCnUhNsGi7Ww6lXGphzwkbsegxAQpao4TDVUx3UlWVeS9W5U70a/zm5UV5J17ta5+/fM3ScryVIryhZfJ9l8NuNm7iLNP0drOQMCVvxQwMqUo6VarVaQGStrrGC5cghGnfaoPd6NRDfm3bi33R93ol6H7+y2d9ujbmc3qO7114s8LpNsOacq6+3WkVwMRdwt1HG5guCymdbx8vEfuNeIMcIaQk9ZN4PPwaU3Ze3Y6a/XjkOt2Xuu5kWFZJdqSLXwEWIa0M6Q1hS0QMDZBHBRMYAqCXphKMmZAC4GgoYlciYpedEK4Gvm4WCcgSkuUYogK6VIFSU5aEhIkGismjUElgQjxRhrPuBAFewE0PknVqd+if5QJc8u0OJTtJgdf4uEwEQvK/edTee7J6C8QYy4dAv8yEGv63a4ggCAhsBhVll31vV5XZ/Xe3y9x/8ae3xdn9e5W+fu3zN3v6M+99XQ4/U5ELy4PgfaZouVtdQ7DK4/vUynVPEaUHgzHUW5oePmoganugJCCRVKtSUQ4XhnM9gq72vaAC94YjXoFMlNAs+nWZba/a2te1gfWJeHJk9ls7iDo/RdM9KzrRE4ZQPe4MUAl1tIQJc6nYAmedRIDFqHcMTc+ZdswPAEP9NZ8JOc8eYKLtxc54BpxKaBN5B8ANEwqJhC9/DK+nsu6I81+8CuK5M8/HFbHKNHbNnkvielAT0DTVdMRBNuFvdxL7HUdtLXbuUutg9szzrrl52QrMMOBDfQB7hfLF7//nH4hk2wwKQEzy3WtkJiRwApcg4hQgA2KE7vcRLtKRBIkykpPlj6fQQTho0TMJh9UpdCsOsT74QPgOwXAMXkUpwkKPtx1s3rYnVicSsS3PSaC09i4MlYbYGHtvjSvDe0wVEnIJW7c4NXjT6pkB1JU9yfQRpvIjV27Dot7OIVu35UiX8U3ELHLSRu9s2KFs6115G7bxNB1iILnljy1g8Ld/zCCj9sm2AEua7qgJ7weiz/qhUVq/bDeizxC5Hfsh6f1MephN1zeRpzYMUsbH5JzE5YNNXain8yhqGDaXA9ySGLflitOxQaUkaEnVZFpdCJDGUItSDpdwqJoVww8RHuxVSKaKjSVOxS8jOtLOT8Z+iUY/Z5yWYavoYtEyljHdkf1hkFhigwdBhgvf5uR8LAwhtmYAPhgAuAw8X6ExJ4RSu453htRHViv0VzcGuIQFXiYtN992V/AXD+E6MHSF3SAAxjKV3+zgffmeeF29KSs4pDgFUPruubaNgNV/zm9C0PoXCH/KvZixYPFmcleEfvZ6P0I0jy18Hd/xPi1UjzKyKNL27xzPFi8TbQcdGGrN+DL6+du0vaz98aL+5UL+58lyNP3JFezd8X3mzGtCFlfTdTTdYDX3eun0HiIflUwF94SphD/QB0W9Q/krAqozThGWYnoVM0lYJOL1LBM6xhG5ghekaIkhqN5kGPSowm9JaCAddz6Ddlgu8L4Pl6IZlT4rsCGeMTv9vcveEAsqIpdMOiyT5CQ6kiCC9sJvGGCDz7on1XeQkRdo4Byo6KoIXicTbLFd75B7XzGeOQGs9EdixtlDsA9nemnQmaSthyVoFGmDJoQpPaKjOzZ2M8GIeeuxLAz8iC+LX+VBxcj6tYhElpyIVIKMOQbrn9eI43ZE04FQkFCeweUEiKioT3J8M1jsBMWbArEk1tJlt+kt1CWmCCbZ4Ln+1mu9kKqe2BcewOoQGvMD+kVX/iNbyVlwHKnwW+51U+n53YtmyleMCGuuSujXKd6nVQ6VSh95liGwuj9/d48oKt2wMOAwZgW399s+jK8Btwcycw1Np+Fdj5+yP/cDinLdy3+Ou/ZWCz6Ga4U50naW8qnfb5GZ5vBSP/fuLMHRoYfgeD+Hc/+AT/4ItOXVQAEY3fB8URHNA4vkWttKlU8B/QzIeH/wH5Yx+V +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create a new Governance Group.

+ + + + + +This API creates a new Governance Group. + +## Request + +

Body

required
    owner object
    + +Owner's identity. + +
+ +Governance Group object created. + +
Schema
    owner object
    + +Owner's identity. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/custom-forms.tag.mdx b/docs/api/beta/custom-forms.tag.mdx new file mode 100644 index 000000000..b43f6ecea --- /dev/null +++ b/docs/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/docs/api/beta/custom-password-instructions.tag.mdx b/docs/api/beta/custom-password-instructions.tag.mdx new file mode 100644 index 000000000..bcdbecd4e --- /dev/null +++ b/docs/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/put-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/docs/api/beta/delete-access-profile.api.mdx b/docs/api/beta/delete-access-profile.api.mdx new file mode 100644 index 000000000..e338a18c9 --- /dev/null +++ b/docs/api/beta/delete-access-profile.api.mdx @@ -0,0 +1,87 @@ +--- +id: delete-access-profile +sidebar_label: Delete the specified Access Profile +hide_title: true +hide_table_of_contents: true +api: eJztW1tTGzkW/iuq3odcyncgYF62HCBTTJHAcqk8ALWRu2VbmW51j6SGeCj++35HUttuGwKTye5OUs4DcauPjs5d35HluygvhOZW5uowiXajRKTCikEcC2NOdD6SqYgakeVjE+1eRn6chRcmum5ggom1LIgBpp9PpGGDk0Pm+RjGFRNfpLFSjVl9dutKXanziVgaZllpLFO5ZUPBpGKlEQ02yjXY8KxI8bBEH2OJQO4XTZgcMTsRUwylOda1OYkxKIpUxk7TBjuSI8H2pjHmn1luBcMCnJ3mEIsdjpi0TJoGRjY7HSa0xlvopYUttRKJk3wAtr8JxW6lnZDGDXZ8+su/B/vvDz802NnxxeneQfWE2WHg7OKtG2O8tJNcSzv1fH8vpYbcEFSqG7CF+N6OkEYxniTSi81XGHkhnM1gAD6EQqRukkkFqwtNhmBnealjvDUmjyUnCzmp7YrxW/B1wTXPYEZNHr+LFB7gWJnglSQXF9xOomW/H+6zfPQAQxLGewVTKj2jXatL0YhMPBEZj3bvIjstaBFjNeIElMHXGOrF/e5OZ4dv73Q3Ov0O73TxabPb6/a7fRHHPLq/vybOpsiVQUSCWa+zSf/VBfyQszhXVijLmjByQpGA8CSJSSwB+91yw0zpxB+VKRuWll5rQS5S8+nQaChmsUAh6pl4CVrRfSNC1KxKcFrNuJ3AYwhI7i1VzON4KYwhj7QvDIYoe5AICfknyEEL8HlItz8bWuVu1aj58LOILTlWU6pb6a2UCMtlupcn4iEH1EV/J5VojjWXJL5PhxgTSfQbmZBwWa5JbmJZBYKja9WcCbu0uuwtT9hpsPleUAZGs5rHv4EXlaGnBLpQEvNZNYXJxJWIR5YV24IP33T6vc3Rm03Oezub3e2tYX/ENxBSW/0+rZ7BFXzsTRPW5lrz6crSvwgltIxZmsc8lX/AIFpw2N7XKFqcEsWKzDztA8fjGfanKulpZ2oGeZkVXyzVhbd7J2xzm6VcjUs3zsdLRlDNizOMqDJNqUz4JITmnvGxlmOpHsxFVWZU+/cP3g0ujs4xcnrwr4uDM3wiXitbwEBV+QVREQuT/NZJHBRwWYYAjxHhLfY6cH0Nhbgyi4TSP5kpyliG2BrxMrWYEVZ/YMYiazbSeVZLb5c3Xyx7KVui1UBSYSzjNp6wIUdqsdwn8msqYIVtHgVLvmYTwROhX7XYINRhnrIbnoIp5k9d2U2SeSUYlchz4SpsXrqdTMai7ou5KeveQBJI6yiOFp1CyQHJn46TQWxLCOfUXMzCWbQEEav6lwTL1aU7X66JU2V5DC14mk5hRq1hYVcepTWzsijJ9hlXFR02MuQHKtb9/VytA5LmvRdm3+buXcxL84y8O0lRfppOtdmLGxGSz1BV9tVIzLZLWCJUJLwktd3kQDVzV5X4bCRFmqxzd52769x9Zu4uvzwNGMi9nUnlsoV2/l6r2+qwY5dOAdmz4RRIKCeY9d8BTDCOc/cy4nmOQHVIEsX9uNvZ2Ii3toY7m2IY90V/Q/R7b5J4tDPcGW5EiyDicl4gZtlbT9aFQPIB4nx3hQdja+3XVfSA4i9qeg+FK6Jeea8IfHd97/4RHO2uWvdChR6EIEyTzYzte6cZ6q2IHMgM6eQ6Gk/Hfv14HnoQ0IsvBeH774hSPaBaEX4wywo/PiR/z1KmlhEkoItmr8EIISCSXSf3XOJobqqN1dXe5XooUSbUqp3I1JpN85JxmEyXSpEkHL1jkgtDbppw7FLBgW4folVV0ixyqewaz6/x/BoTrDHBz4MJ1nh+nbvr3P0xc/dP4XmHk0yZZVxPfaSF96QtHZxvzM5E2SzlHsPiG2yGsZZh97DXHXZH27HYTPhm8majP+rFb3p8a7u73R1u9ra/C+wGiLsBjisVgsvYPE9q0Urm1WJEZc0drle4GTavwexefxU7nuc5e8/VtEJIpoYh1dxGVNNAmxGtrmhBwNkYdVExlCoJuSiUZCbARdPXFqnMpEte0gJ89bQ5GNGxv0+U5dNpPMdpCQldJai+HLnlktqJEWE+cHAIdozq/B3RaXDRX0Ly7JQ0PiKN2cGXWAhK9Bly33rozP0QwmuqEWfewS6sH+t20GGWCg2Br1kz3LnG52t8vt7j13v8z7HHr/H5OnfXuftj5u6fwOcBDT2Oz0HwbHwO2laHzbDUOwqu/zlMd6kSJHDhzfI4LrU7bq4wOIxgBAalnbpFLoDr93woDwDaKTNlonb9aWwzHKfvwhEETa/pIkkmEInze1DuOgxNjNr1SaZ9J5P7iNYjYOl1KnUKyom1hdltt+/garj4vsUL2UIFhLftVOW3rTjP2kPY94HShcAIqUwE7iKVX6DlnKMlxb8vlo65d5UzB0U6XOaOlb/KmS70UAxM8xLl0bFpMORKiEU3DBELNCIvjKNuudhb0Q96Xej0/q/r4hk9ostD5vvqaqBnkHRJRVLheh4eZ4Ta/eorQTLfiajT660sdkxkPfZWcE33q9yXHy9//Xj+io0Jq7paURqCyUJSc4FsO0GIuFo4qL4IoElue9J5OQ5XsWpftVDusVEKhdmVOhOCXR4GI3zAJnGKqu5MSpOEKyQ06/pl5Z1E3IiU9s/W3JIUeIj/NizU5rV5r9xe6ZoKqfAxc6OtK9Vk+5JKmKQ9n2iCiq5HZJdFpRdf0OtbhfhHxa0Zcs1xM6+WpPCmvYxTSaU0RgEgFjw1zlrfvLjn11zgRx0YRojrsgxkiSBH/QuyuPLaN8tR49ckfnU5rtTHicRGXJ/GfOFiBvtomrBDFk/y3Ih/MkahQ2lwOS6RRd8s1i0t2nQZ0ex1FkRq+iWbsglY6eQ7QmIoH0x8SNu6QzU5AJ9KfEp+cp5Fzn9C052wTzWd3fAldl+iTPLYfLPMtGCTFmz6GmCC/H5zo8BCbpMOrg74ANib+99VgiDoQt3zvB6s6o59282hrSGGqI6LKXb9w+68wIVPzL0g6hkNyjCh8tlXhnhmgRftcDVjVecJyxZclTfNsbEu2c3LOzvPos3276Yvabxwc/dYpdPvXaUfqSR/n7r7f6p460rzM1aagJMp3NyyoaFYDPK3Aa+tHgPSOfVE4C/eGn9dHZAcDc/8QvkioyLllqLaZXU8kcIdIBSCW8J+DYqsPHOZCFhN6Y820TEaa9AgbQ0wKR/KFPzcEXe1MncJ44El+ZWeTekv8mCteIKGVLTYR/R0KoZbqJ+jSxp49zkPjd0ZPHNCjmX7lbMBurKsVHQtH2KXGeMIqSciIpEmLn3hQnunRGULd4eIzWZVWUyhRiq0XGejM3M8orNptL0Ljn9iLfjdhINpmJ68GC7pzxU5FamLTKKrw/aneCPamhORFtRRouoCgImFFd4fnq9wBDNl3C8MWrket8Mk0yZaMKH2yIfPBt23arp2AeNFbixar5r41HP5k4xCxHIkERn13xMsh+Td/Hh+/duTH/+3J2FLp16sXdABJAVK6XtD34hfRkuNOGbtyoR+iTRBQBHB3R0dUlFrek/Dv5eCTkAur+ddp+vWEfD0Gc3+CCVYfCWwXp4GI71iz/qdy4NaVIetajo/Z4nw8TdBxzPQ4P4aVP78zMnnX/gTtoUpK99B1Y4t9g+ODs4PIo8SHwJJ4QPMgW3gP7LH2eA= +sidebar_class_name: "delete api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. 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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/delete-access-profiles-in-bulk.api.mdx b/docs/api/beta/delete-access-profiles-in-bulk.api.mdx new file mode 100644 index 000000000..34d910719 --- /dev/null +++ b/docs/api/beta/delete-access-profiles-in-bulk.api.mdx @@ -0,0 +1,107 @@ +--- +id: delete-access-profiles-in-bulk +sidebar_label: Delete Access Profile(s) +hide_title: true +hide_table_of_contents: true +api: eJztXOtv2zgS/1cI3YdtA9uxHefhfDnk1UMW6SaXB/ohDW5pibK5lUkdSaX1Bvnfb2ZIWZLtPNotbrsLo2hrS+Rwnr8Zjig/RDoXhjup1WkS7UeJyIQTB3EsrL0wOpWZsKfqsMg+Ra3I8bGN9m8jf5uV96O7FsyzsZE50gEq1xNp2cHFKZNKOsmdsIyzERBhRB8GMZ0yrQTThk21EWyBZOej+qgOZzA85UXmWkymjKsZznITAWQTGQPZZHEe4wbvssKKFlN6vpxln2WWsZFgIG2qzRSmcpUQsY0NqW6s2NhgqRRZUq5hhM1hYrWYpcuF5WP6yB2bFtYhTSOm+h4optJY12GnJYH/FgIGeKobGyP4cpLC4u5cZTNYDnS0seFMAUu32ER/FvfCtMoFUBAjchgNhEGiJqdz5jzxUeEYB/k0jDLPaKdUgrdyQlo+YE5/EgruuQnarMXOL//1n4Pj96e/tNjV+c3l0Un5DYwVLlzdHNI1xgs30Ua6GUqDEksD6zrNYuTHBT8AnSjGk0SiLVrgC4tkphxsC1pBw81nIRnP6bIgExlPSEfcWh1LkpYkuNKFib2tZn7AKBNIiSdT8EbrhOmAKwfjHOpkFu0/RCXn0T7aoxXFWjmhHN7ieZ6hOoHzzd8suvdDZOOJmHL85Ga5AIfXo99E7IBubjCenISowLn1ODpN6FozUs6AI/S402OL/y3KCXzXzIUh6NfjxvAZfJVOTG2ND+uMVOPosRWJL3yaZwLDtR8Pe3vdvcHuXq8vuqNetwefdrvbvWFvKOKYA50wZC8M6dMQ0esP0952b6+3E90ByaYDL8sCfl/5swX+lQOL2k8yZxAeph7ANhexBN9ddlGZetPFXCntatLDx5h79wiW9XFO8baxkfLM0sIro547UFROodQAkqfho6bskdaZ4CqqKRWlfASVOOnwa9QATETLY2L60ntZwx4PS3r0LrfsK7eVWXYGW3sjMsvOzt5ouMpyNITv0ZCm5R6R0xIxyFv63e6y+S6FK4wCFVEgyvRJyJqrGhH0GRBf0OZ3iinH7SdMVYs+v5iDTo9LI+OMgBjAv/gi4sLBDLrXSEodRokLXI8yBUCLxzKPvZtIp20dd4UFVQSAcobHn5i/2qm7SGmZHQw2Hg8SH3bxYNjr9Ya830WvyAVgNTBfSVNG9lfBRAWHgWAl0leCROlqI+9qcf9JVwveuAgSlKFeLU9IdquQj5sxhT1437PSvA56v8Zfmqz4VA9u4T15lYmfVhooBOYkh7NXa8SIVBihYg/+Xri6gQtbuu5Taf45HS1EPOBajaBXGcs9mc5y5BGxl/R4fH3OcAQJ89ICQhVT9L7L87MTLCMr1dIV9KdXm+7lxWp220O7be/y4Wgr4V2wG+fdrUFvb7DXTYcJLqz49DXSSptnULzg6K9k4j1X4PyGoRWiR4/SK/PJDQZJ9PT9er7xIL+QcOYoc3s3D9DbFSHycjJBd8aIpflBM8S/N1SDAPwNEDFMkQiSiB7vHkNC6nf7z+QgTNOOQdrFqFCi2jcs1fHr1LJOLevUsk4t69TyZ6SWEjJLf+UARFvdYZcTJA16fV5CUg2RbleP3krF3Lt/oEQ1WLVZOsokJBx2YgxgSJvV81a99zPSycwH+D3P5PfMVYlwXGZHOnmFJ72TSrTHhkvkUBDLMUxE37mXhOm0ffMkS6iicU23Ak10euyQJyxsbNlREAb9B7MV0HoNIN4oCfNZOYVJj8VPLCt2BR/tdIf9Qboz4Ly/N+jtbo+GKd8C39keDnH1KTiIt/cLYPgvoYSRMct0DBb5HRRioMiAwgIZoMVfnwiIxiv0fw1y+bFzMQO/zIkvDhtih0cXbLDLMq7GBV3n4wUlqPbNFVxRRZZhSyv0IFqBiXMjx1KtYqXEweOTdwc3Z9dw5fLk3zcnV/AJaS31bg9UCf/AKvjCRH8mjoMAn7llFhAhxoYU2whUN0Agrmx9oPTf7MyCMstGLswIq6+YUSfNUqOnjVCiuPni2BvZEZ0Ww9YEm3IHuWvELXUtfDGF+JW79lnQ5AabCJ4I87bDDkIDkmcMohGIUtsRu0NJUjVZ0wJCWVAzUReOKe1kvACvlSqb1qhA9KxuFAwO4PxlPzmIXQHMkZj1KJx7S2CxSs9ec03urmtKI5XOlOMxSMGzbAZqNAY0TC1jCek/wBGaywLwqHLcHLHquYHg7r1n5thpukdNuZfj7iID+GmTaPMb9yIEHxUkHo3EvE8MmgiIFOpkmhxGzc1VBr7vhK9jdx2769h9Zewu3ixLvHCXSp/eculzo8JDH0yeS6WPIe9Runwy9DuVN8GQ9AgplEg/f7gOT55o55zj45fvWB/5VL7E/MHcHv76qCyny9Rf2QIZJD16CVJAIpHsE98Vx766JlVtLa/2TpuRBAdVK0pEQE3DZrrwT/oKpZATblss0cKqnxyb8Pt5lU8IiKuqpJ1rqdy6klxXkutstM5Gf59stK4k17G7jt2/Zuw+W0nOuaJoCXWSLaZTbmbe08J9lJYzGFAdb5qHHJlqsVpBYmxeY0XNyiEa9XujXrobi0HCB8nO1jDtxzt9vr3b2+2NBv3dqJ7rb6s4ngdZM6Zq9vZ2JBVDEYdHWwoFzmWd1kmz/QfqNSJFWKMjSGXdDDrvRL6/SLVjf7hcO15rzd7jUZVQIdlGDakqHSGmwdgpjjXlWBjA2RhwUeGTMqn9sTY5FUDFgNOwTE4lBS9KAXTNrH2QOhDFB0rpZLVTcHFWAIeEBJnGqlmDY0k8opNizQcUqIIdAzp/x+o0mOgPVfLsEiU+Q4nZyZdYCAz0eeW+vaq/ewrMG8SIK2/gJxq9frfDFTgAbAg8Zs3rznV9vq7P1zl+neP/Hjl+XZ+vY3cdu3/N2P2K+jxUQ0/X5zDg1fU5jO102byWeofO9X8v0ylUAgfk3kzHcWGo3VzW4KAEK+CidDNa5Abq+iPvygdQtGNkykTt+25sO5y52J/SMYvo7vEOeQRPRHlybQmDOE6LNptT7CaeCmv7I+0RLorVpResMBlMmDiX2/3NzQewN9j5scNz2QEYBJO7mdKfO7Gebo5AySvwCw8a+FjFAXSMzC/QIQsZiUHgEZOIe3uRTtDdwW7UW36WcnkaZaYLwEgi08JDOcEh6TKwmMNu5CdLozvkgEvygVw3Jnv847J4Qk/Iskp9z64G4xlwuiAiinBX+cgVlu5+9SVPqdIRbvf6S4ud47A+OxTcwL7CPwF58/OH67dsjAUrAYY/5SMkvc7D2QW4CAHiQfk0ACdRjjK6GE/80bLG8xYMQJZmIDD7qK6EYLenQQm/QKa4BGgnleIkQWiCs+7elNZJxL3IMIl2Kk2i40EQbIKGNnlj3ltKmLSzkApPZdLVzkfVZscScYzexcAxQUTaKLLbvJSL1+T6Vib+UVJrh5AjavbtAhdetbexP78TAwogCZ5Z0tY3L+7ptWv0cBsGV5DqIg+oicBH8ylZXFrtm/lo0GsjvSYfH9UHf96vMY159GIWkmmWsFMWT7S24p+MoetgGNyOC4iib2aLDhm2KSLa/W6NpbZfsi3bUFsSf2cQGMo7Ex9hbqfSRkPVpxIfkr+SZSHmf6U3UH5tyEyXbyEF48hEx/abecYF27hg22OADfz7DIeOBbGNMhAOeAc4quxPSBAYreGep7US1Yn8Js3B1BADq0TF5vv+y34FcOEToxs4ej4GYBhL8/lzQ3wPL9DCNNdQVtlUWNTgMr+Zhuy6oDfP77yphRn3R5MXJT6oei/4FtP3RuknkOTHwd0/CfHWSPN3RJpQLGMP87J6hfakOhD8zGuMf+wF1OX3T8PWGl2fVBB2OPWAOwy143Jf0r9ICv/CXcIN2iPADsy/RowVVZ1QnnGHEUYIE0+koI5GLrjDOrSFXq6nhApQ6aMG6G1rIDQ2MAYgxEJ9zEcyA3rUcy9XDu9IUpGLPobfbUHbKnqNegI7ZNFhH2CTqWJwEdxg4qkRuPebDjvNK/CSC3Qydlw6HhSA02mh8MVsYLuY4ts0L3lnIm1ceBCF/aYSpS78W+XzWSWioNujCPSmrDBTe55isxz24TUnfGEt8EEbOuWgerSiPxsfVYJcioyiBMc1txAv0QbPb09EluMWFzKAUP7tkbDC+9PrJYpATFl6gbyjzXgzTLKbOBaI4FbNu89Wp9fptmnrgq/awJYP9oIN9le8tv7Gvl30w4fqIcH6RxPqfaT1jyb8gD+aEEom3Otu5tjlpZeQ/N7b9ztuo4V+B8yqdzwAxSfYH4GBDw/YEcQWwCNeBrNjuwnfUCx39/gNFvCdQWqRfBLYkQqPotrXMyoFQ+tp+RkbNh38DN9tfHZsvYVzcY5912gUfhxi6ptZhn+Gi/jvfvQR/sAXnXtkgkF0/SEqW8MwxtMta+5VJWf4gGI+Pv4PDX79LQ== +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +
  • Array [
    • usedBy object[]
    + +List of references to objects which are using the indicated Access Profile + +
  • Array [
  • ]
  • ]
+ +Returned if at least one deletion will be performed. + +
Schema
    inUse object[]
    + +List of usages of Access Profiles targeted for deletion. + +
  • Array [
    • usedBy object[]
    + +List of references to objects which are using the indicated Access Profile + +
  • Array [
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/delete-account.api.mdx b/docs/api/beta/delete-account.api.mdx new file mode 100644 index 000000000..700c1dacf --- /dev/null +++ b/docs/api/beta/delete-account.api.mdx @@ -0,0 +1,99 @@ +--- +id: delete-account +sidebar_label: Delete Account +hide_title: true +hide_table_of_contents: true +api: eJztW1tTGzkW/iuq3odJKGzAmJsfdosEMsUUuSyBSm0BtSN3y7aStuSRuiEeiv++3zlS222bhCQztTNJ9UvSdB8dnfv5JEt3iZ0oJwttzUmW9JJM5apQh2lqS1Mk60khhz7pXSbxjU+u10HjU6cnNAYjLrwSxUh7cfjmRBRWBA5CGiHDmLa4MudEoEw2sdoUwpf9sS58jaYaVUj/Aa8z4VRROuPBOb48OVrlY00+jSMDZcVt4OxYnGTKFLqYvrK368LYgim8LV2qBGZX+WBd3I50OhIpBHHKl3khtKkz+slHQbQZiltdjPijUR8LIYdDp4ZsONFXxa1Spj4B6VAToC3EuRXyxuosGMunykin7TpEEZqmSe14DM0UEchCTG0pLjPtZT+fieOvn4yKYuJ7GxuZulE5ua7tpc7ZHG1w2NCZ2ZATvXGzvREHt+LgpwJuHilH7M3M3iM1bgu26q3OcyFzDzHz3N6yAHCng2IsQ80svjLToIRxFDnmELQfYAI20uuzn/97ePTy5JWQZTGyDjYIOv5WakcKWpgcs1Vh074y/1xbe/X6/Li3tib+g4nJIzXvzidmzwYbe2EHLMVVcqRyjYhS2Qudq6tEFNOJaq+tIX69SkuaHzF8R6HqnltTwH+HEIziGvbqVcx7Y2nkUCXX9wjyiXRyjKmd56GaQn0CA4KnwQf8pTPin8KCMundJTQn3vrCIViS+/WkUjfpFa5Uy2kTE4riGmzURzme5DReDbb3Bwfd7e6eOuju7Hb6O/3+frfTlTu72wd72X5CwiFYJ9Z45WnizmaH/lti76cmDZmTqQIh4mmalJRHXoNcTia5Tjl+N957GnNXU+ZBWZGwzLWaXRA7qTk54iRwmvCFdHBFJJ44C1f5pG4PMjsVkmgy23+vUio2oEVEFzroBZoVSZA+0emkWrK+ZPW6ITvpwdb+5n53r7u7v53J3c0teto92E47eD7YSe7hI6QnE1castnOuBTgO1F0NzdXxXiea5hRHDtnnWiJM64RUFkH2UhT5QvRtxkHvjY3MtfZV3ng87YJ5n5uM7UaesuR9kIb1Ro6OAoSKhY5xUDyzI3OyHlj61T0YGVepluMTFiivSWeyQz6Bv2eR2XIkE6mH8DrJHtcoAujMV5UQwScOrDuU9OqPSX7u5sHne5gtytlZ7+7tbfTPxjI7e3Ng52DA5p9jAhD5vra3NI5OV2Z+mdllNOpyC0KkP5dUaORsD0LwJNjCArJ2D/uA+bxBfY/h16BdqZmlFdQJVoXUjx7/kZ090QuzbDk93K4ZATTunhLpafMc6rGoaZA88D4tdNDbR4SRZlyTAl3dPzi8OL0HG/Ojv99cfwWT8RrpZsfGkRrRmEJURELI3SCYq7ArUTrQklOkeBtsRa5rkEhGZt1JNThLz/1MCZiayCRUhgRZ39gRJ11KPP1VEpD2RZPdFu119Fx8W4sCzTvvvQYYENDWkMiq0nROo2WXBMjJTPlnrbFYZZpUlLmAtkIphg/BSMhM2q6Cx2N25gtC4INOlWLvpibctEb82pyWncKJQckfzxODtOihHCsZj0LZ9ESRYz+gczBcovSndeMxiadokan0AINdwozOiANVCboRggsliNyl0fhMRXdrGLViySXu5dBmKPC8rdUlv4L8u5NjvLTYtVmH25UTD5PgCBUI/ZG5aZYkfCRCz4NjlQzd1WJLwZa5VmTu03uNrn7hbm7/PEsorr4laHP1ir0uTAR01PzXIE+jqPH2Ar4/x4WSMGR6wIGiRDpl3fnccVAC7qPEwKGfyI+Cq18FcjO/BHe9wl+zJy14AsSkO0YNBigEqmsx3LPJWZDBVNtr872wrq+RoCaByAiqqbjJZaEyVxpGERLvy4yq7z5qRAjecPLHsgbKmBY+LbCUq9Bkg2SbLpR041+mG7UIMkmd5vc/T5z97NIciYVZ0vESb4cj6WbhkiL30lbKUAw31+cpRy7ahmtEDMxw1jJInJI+p2t/tZgL1XdTHaz3e2DQSfd7cidva29rX63s5fUe/3lPI9nSbaYUzV/Bz+yiQHiboDjSoPg8oW12eL2H8zr1IDKGpWeGW6GzWHS6zl27K5ix1e2gG5gDOzoPrG9eHF2SvwxNbMnu4UfHyhp2XThpwSClPwDiPqofdFAxwY6Nu2naT8/TPtpoGOTu03ufp+5+1XQsfsYdOx+BXTsCoJYA4JYfyV0zIA7CJoN4BTokJYwryHYOIEqeIq7jzHtC+mGqpgBvQUU2TlYRZHn1oqX0kwrsOQXdiLN3FxU3kA7JlpX0YJAiiFKpBGoWtqG3971WBEmRfyIeOiCDpAo4uumrcNBAa1CzlTxNptFmzQvISEXhdzS3qtFjGmEkxoQ/AMH3gcdolD/iXuc0Vt/aD9YnJHGp6SxOP6YKkU5P9v/3XnolMAJhHdULt4GX3/iuEDYM5cGywj1cRLK1wyCNlC9gepNu2/a/Y/R7huo3uRuk7vfZ+5+BVSPaOjTUB0EXwzVQdveFDMs9YKC6/+O2DlVogQc3sKmjNWzOQZnXIFQmh+jpzJCR4Z7yUZ1xnjjTmf3CZ1LJkgYpCldDpLqZPcdnATn3LflRLd1PEJu7C0f7+7DMg8UHTpjGhKMCPgkfpigzWZ1miI3lDlmHozMilCMVifIP8uZTj2T96ZYeojAZp0OWsco4tcQcYIlxE+eqdscNSv6Qa8Ll9//cV0Co0/o8pD5Pjsb6AUkXVKRVLieHyN/S3g7zL5ymHzeQ2inv7My2Wsi64hnSjo6hc+HX5788u78qRgSyuQsLz0BXKVpWYA8eYMQ4Sp2WB0EoUHcWJwth+E6wuHCURvKGjHI6crBlXmrlLisXUMQZ6jHbFIapLgE0Kgvv1cgF8Y95S7HywFt8Djmt+0r0xJHmoqPpm5NNFFFXt2Jy0mll6zp9a1C/KPi1grcWszNP12SIpj2Mg1Ht1OkLrGQuWdrffPkgV+rxo/WTnhDXJdlIEtEORYPSKWV175ZjgV+LeK3KMeVecd3XRaHiVCxhEcHzDNxItKRtV79SwgKHUqDy2GJLPpmsfiCTYszotXZrInUClO2dAuAkOU7RWKYEEyyTw2Z8YgNWyOckr+yZ5Hzv/L9ml8XdObXl+ibRJnZ9CsuyyzJTBO2aMJWqAE+yh/vOEBY5DbpwHUgBMDzuf+5EkRBa3Uv8HqwqjP7DR5DrSGFqMzFT3rhj968wMUnwR+IekaDMkx4enZkjG7YRF7UmxaMVe0ELFtwVd7coiUu2S3IO/s9k9rk301f0vhwvmHy2uTTP7tKf6KS/H3q7l9U8ZpK8yNWmohwKdx42rgUqAf5s4jXVjfw+Iqowr/4yrnKYBpLlfmlyjqjSS4LimrO6nSkFS/9J0oWhP3WKbLsmDMx3i5TPjAaOtAgbT0wqezrHPx4c7qaWXLCBGBJfqW/fRmPSliEJJaSqi3eYTVmgNcdrcTiPcj3Ni7J3sIzb/j66VHlbICu8bg0dM0RYpdjIRFSj0REpn1ahsKFhZlRlS0sQ7/ZqCqLKdRIhTavSdzYvx7QrjIWrDXHPzIX/O7jljJMT16MNxnnipypnCOT6BZh+2O8EW2tkcontBZE1QUAU7UZXp6cr3AEMxN/x7BuuBEH+Q2iBRNaHoXw2W5vtTdbvFzA+4n1BVavC+LzHdH5peWF6Lub76E3d5Wbu8p/47vKEZjQinJjQhugFO5lWOGGfYTLpGIO8l64RDtCPtCXuzvaHaOV9T29/q1UtPVyeT1fNPNmQ7R0lvQGMODyteR6sjw5izZ4WqVWvKz8oJzVdq6ZzndyEjx+ULQBBFHvr0EVduhYkPAh7OHVhqz8ykXL79m+ytHx6fH5cRLQ7ENgLj5Ab7Sr/wHNdrBY +sidebar_class_name: "delete api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Delete Account

+ + + + + +Use this API to delete an account. +This endpoint submits an account delete task and returns the task ID. +This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account's returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future. +A token with ORG_ADMIN authority is required to call this API. +>**NOTE:** You can only delete accounts from sources of the "DelimitedFile" type.** + +## Request + +

Path Parameters

+ +Async task details. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/delete-campaign-template-schedule.api.mdx b/docs/api/beta/delete-campaign-template-schedule.api.mdx new file mode 100644 index 000000000..07015d4bc --- /dev/null +++ b/docs/api/beta/delete-campaign-template-schedule.api.mdx @@ -0,0 +1,99 @@ +--- +id: delete-campaign-template-schedule +sidebar_label: Deletes a Campaign Template's Schedule +hide_title: true +hide_table_of_contents: true +api: eJztW1tzEzkW/iuq3ocBKrYTxyQkL1smCVuZCgObS/EQUoXcLduCttQjqQPeVP77fkdSt912QrjtzkD1Czjd0tG5fUffkeWbRBfCcCe1Os6S/SQTuXDigM8KLifqXMyKnDtxlk5FVuYi2Ugcn9hk/zI5EMbJsUz9VFZNsMnVBmTY1MiCXkDioZdomZsKZqMcNtaGcZbGWczFdbrsVLjSKIuXg80Bk2OaZgSTlim9mG6F60IXK9LSSDeHPjfJhRXmQCsnPrlh6aako8zUfrVGp1pj35Qqubr1ehZGwAABw50pxUZScMNn0NZYL1KS/gWHsI1E4QX+khmtCz1mPNm/Sdy8oKfWGakmye1GYsSfpTQLiU1fnMMHx4dMe7PWzWcfp9oueQlWjwQEsxCVjGwWnzArp0U3ByORpWL72e4oG+yO+lxsjZ/tiNHmaLS9kwmRkI1G2EIrKyxp298c0H9Nnf7QLCW3Kcc6TKqMQhrDRcYI69hHbpkt01RYOy5zNipdIyzVdKehLiZRBEUGWVFI0KBL7hlsbq5rcJBLmn5kDLKiE1OABIwbWox0NqcVpbrmufTOiCuTSF4UeczG3ntLcm/W46RH70XqMLEwlPZOBr9kwnGZH+hMrMd0NYQvpBKdieGSNBRe5RQTGSRey4yCNdPwTBBZRdqPa0YPnuhusec8g73BvoNoDNzkDE8/QBZB8iGFLpTEfFZNYTLz6LpnWbEr+Ghnc68/GO8MOO8/G2ztPh3tjfn29ube0709Wn2GOPNJcE1cmxvD52tL/0soYWTKcp0iIv+BQ4zg8L1XwC+OKRLZbR+OgZfxBf4nCIWxtZlRX0bQ30DleH7wmg12Wc7VpPTP+WTFCapzcUaYLvOcj+gRgRWWB8GvjJxIdZcqQpUzKiyHRy+GFyfneHJ69O+LozN8IllrtW+oKkRBVeTCVH/0GkcDPK4A7ZSwzZ5EqU9gEFd2eaCM5XNu4Uzk1piXucOMuPodM5ZFs7HRswaU0lAn2SPZFd0NoBbPZtylUzbiFhN0gO6TITBfuM5J9OQTNhU8E+Zxlw2zTJKRPGdAI4Ri/pzgz7Nsgf1xCShDGemmGkVDaSdT0YzFwpXNaAAE0vkRJ8tBIXBA84fzZJi6Esp5M5dRWGdLVLGqeFn0XFO789UqOFeOp7CC5/kcbjTYQJwviNLZuhBK8v2Mq2pcXbFubxdm+XL3Mihz6LR/l/LSfgHuXucoPx1vWv3iWkTwWarDoRr5aFRhihUJL8lsPzmOqsNVAZ+NpcizFrstdlvsfiF2V1+eRtYT33rqs7VOfS4UB1fVxm+ea9SnZljVoEC2QyA3GBwSKdLvb84B7A9C0XjxqSAG+gP5UdjK15Qf1vEIz0dEP+pgNWJBCno/BgvGqEQi2/d6LzT2jgqu2l5f7YU2I4kEVXdQRFRNw+a6ZBwuA79XpAm3GyzTwqrfHJty1EfuGWyogLSqyjqFlsq1TLJlku1u1O5Gv85u1DLJFrstdn9O7H6WSdZaebREnmTL2Yybeci0+J6spTPU7fr8jdWQ86FaZSskjNUcK2kyh2TU3xptjXdTMcj4INvZ3hv3050+f7q7tbs1GvR3k+W9/nKB4xpkTUwtxTvE0bsYJO4aPK5USC7rtM6ax39wrxFjKmtUemreDJ/DpVcL7njnGaeDbRAM7mjuOV68OD0h+Vjaiye/6dKkgmh2cB2Gc+cpJeUwPC2ta6ljSx3b7afdfn6Z7aelji12W+z+nNj9Kuo4eIg6Dr6COg4YUawxUay/kjpm4B1EzcYICt0vKOFeRbSxgCn4FE8fI+wdNxPhaqLXYJH9vXUWea41e8nVvCJLtnESqRbuovKGsTMaa6qxGMDZBCVSMVQtCXZLWSVngjgpffmfy5n0OCaDINfMO8Oxg1UBM6vfp+PvNC+hoS8KuaazV40ck0gnMSb6Bwn+HHSCQv0DzzhjtL7rPJidksUnZDE7+pQKQZivz3+f3nVL4BjKGyoXZyHW91wXCGfmXKGNEJ+KUL5qCtpS9Zaqt9t9u93/Gtt9S9Vb7LbY/Tmx+xVUPbKh+6k6BnwxVcfY7iarudQLSq7/O2P3UIka+PRmOvVcPVtwcM8rkEqLS8lURugu7n7SW7vUa3s3Mrvt2cU95dARBAVLk2PW1LnC7vd6N4gb4nXb5YXsopwhdG6u9Mduqme9EZx1Rx2ia6cBczSADV8fx5aj6z1tJCVzqHxeePC7t43SFv73Nw0+K5luGFNA5+hGWBCzwZD4MbH8Y6hYoKv4zfrRXZ9Ia/bBrguT336/LUHQPbbc5b7ProbxDJqumEgmXC2uctNN81lYfe1C92JbocP//tpir2hYnz0X3KA/CPdhHv3+5vwxmxDx9MAvLXFeIalTAHReI0V8YRtWd0Nokt9rjC4nU6/4sHH7hoDExjkMZm/VmRDs8jg64Q9U/FOUaO9SmiR8VaBZV4+q6GTiWuS0GXYXnqTEk5nqwUM93pj32G98vkOQCh9n/mn3reqwQ0n1SNIGTmOiib7hY5dFZRdfsutblfhHJa0TpHW8NPt4RYvg2ss03OZOgWYSwXPrvfXNiwd5nSV51E7hCUld1YE8EfVo3plKq6h9sx4NeR2S19TjrXozldhVm9NYKGLMYlPMM3bM0qnWVvyTMUodgsHlpASKvlmtj7RoxyOi099cUqkTluzIDjii1+8EwFAhmfiI9mhPUXQ4LfGQfOcjC8y/QwedsXcNm/3jS2ylNDLTqf1mnWnBDi3YCTXARv3DTkWJBWyTDb4OhAQ4WMTfV4Ko6FLdC7LurOpefM/Poa0hhapeii32wx/7iwIXPzH/gkbXY1CGiWLXt8jwN4uyaLtqOKs6HFj14Lq+ucYuueK3oG/9FSftnH83e8ni4eIM5ZXK5z+6St9TSf4+dfcvqnhtpfkVK00kvZRuftnYHSwn+fPI19bP9OjQeSrwL956rHp+je7F92OexSwLIs5MWe1RnU6l8KcBheCOuN8GZZaeeSSicSf4o+fzgiYGYwBbC07KRzKHPH9eXa3MPWACsaS40t+2jLcnNFIS3aXosjdo0FSKsFBzRvd28e69jl3aGSLzmgLLDqtgg3TNZqXCaoTLcsY4UuqBjMikTctQuNCrKVH5QnvqV8+qUEypRiZ0fZtiZvbVmA6a0cMuBf6BtRB3G0+Z4XqKYvzV4MKQU5H7zKRxTdr+kGxkW2cq8oLaQ1RdEDCxtMLL4/M1iRCm4lcb2kx6cZLt0VgIofYopM92d6u72fHtAp4X2jo0tA31w084ef07T1b9MhSdyNKPQxtZebM4bv9f/gg07jbUJvQKOugiG8rQtoR+8TJZ7xcxcb/+LafXHk3IFJbT8JsbOhqhHuqWHv9ZCuq7L68W7ZFvKxEZ+owOdYxasfpjz2XzH53Gn4U+9l/ufOdPQO+0uDoAVPNF75/g4wdBRwYwFY01LPRnOl778CKc+ixNWftehLqzuhM/PDo5Oj9KAtm5a6+PH+AsVLP/AqsyGnI= +sidebar_class_name: "delete api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Deletes a Campaign Template's Schedule

+ + + +:::caution deprecated + +This endpoint has been deprecated and may be replaced or removed in future versions of the API. + +::: + +Deletes the schedule for a campaign template. Returns a 404 if there is no schedule set. + +## 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/delete-campaign-template.api.mdx b/docs/api/beta/delete-campaign-template.api.mdx new file mode 100644 index 000000000..17c4b65ef --- /dev/null +++ b/docs/api/beta/delete-campaign-template.api.mdx @@ -0,0 +1,99 @@ +--- +id: delete-campaign-template +sidebar_label: Delete a Campaign Template +hide_title: true +hide_table_of_contents: true +api: eJztW11zEzkW/Suq3ocBKrZjxyEkL1smCVuZCgObj+IhpAq5W7YFbalXUgPeVP77niup2247IcBQOwPVL2B3S1f361ydq8g3iS6E4U5qdZIlB0kmcuHEIZ8XXE7VhZgXOXci2Uocn9rk4Co5FMbJiUz9FFYNtMn1Fuba1MiCXkDSkZdkGWdpHMRcFMfGC3Zy1E1oSmEEZAms7UwpthIr0tJIt8BaN8mlFeZQKyc+u1HpZrS+zNRBJbBTCTwIaifXt1Cj4IbP8c1YL0OSMgXH7K1E4QW+yQyfbToTc54c3CRuUdBT64xU0+R2KzHiP6U0S52ahl3MBLRnesIcPt1hnIAYFjTKyEjxGWNyWmKQ7vefbT/b2c36+33+7Ol2fzcbPBvu7o6HfLAz2E9IfyNsoZUVlnQbbA/pv6YGf2iWkleUYx0mVUbRgKdJHVJdWMc+cctsmabC2kmZs3Hp6LURTFqmltOdhrqY5EqjRAZZUUjQoEvOGG5vb2pwmEuafmyMNtDhrBYwaWgx1tmCVpTqI8+ld0ZcmUTyoshjIvXeW5J7sxkVPX4vUoeJhaFMdTL4JROOy/xQZ2IzgusBeyGV6EwNl6Sh8CqnmMgg8aPMKFhzDc8EkVVc/bhm9OCJbp895xnsDfYdRmPgJmd4+gGyCEUPKXSpJOazagqTGZtAqXuWFXuCj59u7w+Gk6dDzpEv/b3d8f6E7+xs7+/u79Pqc8SZT4Nr4trcGL7YWPpfQgkjU5brFBH5LxxiBIfvvQJ+cUyRyGX7cAy8jK/wPwEmjK3NjPoyQvYWSsTzw9dsuMdyrqalf86na05QnctzQnCZ53xMjwiasDwIfmXkVKq7VBGqnFPdODp+Mbo8vcCTs+N/Xx6f4xPJ2ihbI1UhCqoiF2b6k9c4GuBxBWinhG32JEp9AoO4sqsDZfhmFxbORG5NeJk7zIir3zFjVTSbGD1vQCkNZZA9kl3R3QJq8WzOXTpjY24xQQfoPhkB84XrnEZPPmEzwTNhHnfZKMskGclzBjRCKOYvCP48y5bYn5SAMpSRbqZRNJR2MhXNWCxd2YwGQCCdH3G6GhQCBzR/OE9GqSuhnDdzFYV1tkQVq4qXRc81tbtYr4IL5XgKK3ieL+BGgw3H+YIona0LoSTfz7mqxtUV6/Z2aZYvdy+DMkdO+3cpL+1X4O51jvLT8abVLz6KCD5LdThUIx+NKkyxIuElme0nx1F1uCrgs4kUedZit8Vui92vxO76y7PIeuJbT336m9TnUnFQUW385rlBfWqGVQ0KPDkEcovBIZEi/f7mAsD+IBSNF58L4ps/kB+FrXxD+VEdj/B8TPSjDlYjFqSg92OwYIJKJLIDr/dSY++o4KqdzdVeaDOWSFB1B0VE1TRsoUvG4TJTKkWacLvFMi2s+s2xGUd95J7BhgpIq6qsU2ipXMskWybZ7kbtbvTr7EYtk2yx22L358TuF5lkrZVHS+RJtpzPuVmETIvvyVrOMKA+f2M15Hyo1tkKCWM1x0qazCEZD/rj/mQvFcOMD7OnO/uTQfp0wHf3+nv98XCwl6zu9VdLHNcga2JqJd4hjt7FIHEfweNKheSyTuusefwH9xoxobJGpafmzfA5XHq95I53nnE62AbB4I7mnuPFy7NTko+lvXjymy5NKohmB9dhOHeeUlIOw9PSupY6ttSx3X7a7eeX2X5a6thit8Xuz4ndb6KOw4eo4/AbqOOQEcWaEMX6K6ljBt5B1GyCoNBdgRLuVUQbC5iCT/H0McLecTMVriZ6DRY52N9kkRdas5dcLSqyZBsnkWrpLipvGDunsaYaiwGcTVEiFUPVkmC3lFVyLoiT0p/6czmXHsdkEOSaRWc0cbAqYGb97+n4nuYlNPRFIdd09qqRYxLpJCZE/yDBn4NOUah/4BlnjNafOg9mZ2TxKVnMjj+nQhDm6/Pf3btuCZxAeUPl4jzE+p7rAuHMnCu0EeJzEcpXTUFbqt5S9Xa7b7f7X2O7b6l6i90Wuz8ndr+Bqkc2dD9Vx4CvpuoY291mNZd6Qcn1f2fsHipRA5/eTKeeq2dLDu55BVJpeY+YygjdvD1Ieht3dm3vRma3Cd34JXIY9CpNjsEz5wp70OvdIFwI022XF7KLKoaIuYXSn7qpnvfG8NEd5Ydumwao0QA2en0SO42ud7CRlMOh4Hnhwd3eJMpWuN1fMPiiZLpGTHFcoAlhQcwWQ77HfPKPoWKBZuI360d3ff5s2Ae7Lk1+++dtCYLuseUu931xNYxn0HTNRDLhenlB+5yYd1h945r2cjehM//BxmKvaNiAPRfcoC0I12Ae/f7m4jGbEt/0eC8tUV0hqUEAYl4jRXw9G1VXQmiS32KMLqczr/iocemG8MMmOQxmb9W5EOzqJDrhDxT6M1Rm71KaJHwxoFnXj6roZOKjyGkP7C49SYknM9WDh3q8Me+x3+98YyAVPs790+5b1WFHksqQpH2bxkQTfZ/HrorKLr5i1/cq8Y9KWidI63hp9vGaFsG1V2m4xJ0CxCSC59Z767sXD/I6K/Koi8ITkrquA3ki6tG8KpVWUftuPRryOiSvqcdb9WYmsZk2p7FQu5jFXphn7ISlM62t+CdjlDoEg6tpCRR9t1qfaNGOR0RnsL2iUics2ZEdUEOv3ymAoUIy8TFtzZ6Z6HBI4iH5zkcWmH+Hxjlj7xo2+8dX2EFpZKZT+90604IdWrATaoCN+ocNihIL2CYbfB0ICXC4jL+vBFHRlboXZN1Z1b34np9DW0MKVb0UWxyELwfLAhc/Mf+CRtdjUIaJWdeXx/CdRVm0SzWcVZ0JrHtwU99cY3Nc81vQt/7LJm2Yfzd7yeLR8ujklcoXP7pK31NJ/j519y+qeG2l+RUrTeS6lG5+2dgUrCb588jXNo/y6Kx5JvAv3nqselqNpsW3YZ7FrAoiqkxZ7VGdzqTwhwCF4I643xZllp57JKJfJ/ij1fOCpgZjAFsLTsrHMoc8f0xdrcw9YAKxpLjSd1vGSxMaKYmmUnTZG/RlKkVYqCej67p4917H5uwckXlNgWVHVbBBuubzUmE1wmU5Zxwp9UBGZNKmZShcaNGUqHyhPfWrZ1UoplQjE7q+OzFz+2pC58toXVcC/8BaiLuNh8twPUUx/jRwaciZyH1m0rgmbX9INrKtMxN5QV0hqi4ImFhZ4eXJxYZECFPxLxraTHtxku3RWAih9iikz063393u+HYBzwttHfrYhvrUdoFXVj/MZCs/4Wxk4s3yZP3rfqoZ9woi+b2CTqdIgzI0HaHJu0o2mzxMPJAZ/Tp0BmVpzM0NHWJQ23NLj9G8U4d8db3saHwnCGfSZ/SSE8B7/UeYq9o/Oos/13zs/wzzTT/NvNOo6mBOLZY9eYKPHwS18rAGDS/s8WctXtfwIpzGrEzZ+HsFtU91h3x0fHp8cZwENnLXZhw/wDUoN/8DjwXXJg== +sidebar_class_name: "delete api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Delete a Campaign Template

+ + + +:::caution deprecated + +This endpoint has been deprecated and may be replaced or removed in future versions of the API. + +::: + +Deletes a campaign template by ID. + +## 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/delete-campaigns.api.mdx b/docs/api/beta/delete-campaigns.api.mdx new file mode 100644 index 000000000..b26309551 --- /dev/null +++ b/docs/api/beta/delete-campaigns.api.mdx @@ -0,0 +1,107 @@ +--- +id: delete-campaigns +sidebar_label: Deletes Campaigns +hide_title: true +hide_table_of_contents: true +api: eJztW1tvFDsS/itW78MBlLlmkiF5WYUQjnIUSDYX8RCixdPtmTF02712N2E2yn/fr2x3zy0hENAeQC0kNNNdLte9vnI8N5HOheGF1OowiXajRKSiEPs8y7mcKBttRAWf2Gj3MtoXppBjGTtaNqe42sAiGxuZ0wuweOlYWBZXJOx6qq1gh4ll3AhmcxGDkUiYVKyYCpYb/Ukm+J5KWzA9rlfSkjbbK4upNvK/IIh5mgpjWVaCcCQYV+z49M9/7718ffiGacM42z84Pfff2xEJlhsBiQVUK0wpNiIr4tLIYgaNbqILK8y+VoX4XNAmpKVM1G61/a43RnR1Cx2N+E8pbPFCJ1h7s6LyObSQUA+yk0JzzQvNPBOShlhIM5clpq1VQex4nqfBtJ0PlnjeRDaeiozTp2KWC+yiRx9EXIARDJaTN4Slt9j4MRKRaz1fbgyf4assRGYX9rOFkWoS3W5E4jPWp4IM1I93es+7z58PNze3YiF63d5wc7DTTUa94XA77m+DTyDZ3ObDXn+wud3tuU9bfKcbd7v9HgwKnoUsiGMIlzqeTr2do9tbIjLC5lpZr2i/219XdC+ORQ4HsxY7FUVpFMWVVzq4jF1zy2wJOmvHZZrOGK/WSAVzEKmdWShPTnqkU7y4g253XcL9VIIhOzAGEXq/lCNEFpMWMn3iqUy+Q5bVAElEwWW6rxOx7tzV5H0llWhNDJckoXAix1gYchQrWKaRw55lFV2OjgSu44Qs0e6xFzxhwaFsPyhDrjc8/gheVHEeEuhCSaxn1RIENRtDqHu2FUPBR9vdnf5gvD3gvP980BtujXbGfHOzu7O1s0O7Z4gDPhGLkV5lwPLWfwoljIxZqlF3XP0xgsP2TgC3+R1Jc48PHI+vsD/lraet1QzyMipTGyhxL/ZP2GDIUq4mpXvOJytGUK2LMzxRCHY+okdUb6C5Z3xs5ESqu0QRqswox18evNq7ODrHk9ODf10cnOET8Vqr9HsK0ZpQWEJUxMJUXzuJgwIu75DdMVKtzZ4Frs+gEKdCNCeUdiEJEVtjXqYFVoTd71ixyJqNjc6WUin2NZ09kW3R3kCjwLOMF/GUjbjFAu37zjNfO1pHwZLP2FTwRJin6DlJIklJnjJkI5hi/cx1nCSZN65xiVSGMBINqiyY0oWMxbIv5qZc9sa8/h0tOoWSA5I/HCd7cVFCOKfmYhbW0RJEDP6h5ur2WZbufLVKzlTBY2jBqUzG2qB7ojJBN1lYFsoRucui8KiKrq5Yi2XdlbvXXpiXhXbvYl7ar8i7kxTlp+VUq198EiH5XAcLiIG8UbkpVKRQz93iGlcEW1SJzwA+0qTJ3SZ3m9z9ytxdfXkacFl466BPbx36XCg+B+9r0Me46FGaVUR+tPCO3CA8HyDSX2/PkdgfhSJ68TknEP0D8ZFv5evIsvaHfz4i+FE7a8kXJKCzo9dgjEokkl0n91xiZyhvqs313V5pM5IIUHUHRETVNGymSzc+mVIpkoTbDZZoYdUfBZty1EfuEK6vgLSrSlq5BsJtkGSDJJtu1HSj36cbNUiyyd0md3/N3P0ikqylctkScJIts4ybmY+08J605QwErDohZHXKOVetohVixmqMFS0jh2jU741642EsBgkfJNubO+N+vN3nW8PesDca9IfRYq+/nOdxnWTLObXgb+9HZ2KAuE/AcaVCcNlC62T5+A/mNWJMZY1KT42bYXOY9GqOHQfr2PGNLqAbGAM7mnuOFy9Oj4g/nZ4Te7KbLk0sCGZ704GcFw5SUgzD0tIWDXRsoGPTfpr289u0nwY6Nrnb5O6vmbvfBB0HD0HHwTdAxwEjiDUmiPV3QscEuIOg2RhOgQ5xCfMqgo05VMGncPoY0r7gZiKKGugtocj+zh1XBrRmr7maVWDJLp1Eqrm5qLyBNiNaU9GCgLMJSqRiqFoS6JaiSmaCMCnih6Uyky6PSSHwNbPW3riAVj5nqnird5EqTktI6IpCqunsVSPGJF38GBP8Awd3DjpBof6BZ5zBW991HsxOSeMj0pgdfI6FoJyvz3+37rolcAjhDZWLM+/re64L+DNzrjBGiM+5L181BG2gegPVm3bftPvfo903UL3J3SZ3f83c/QaoHtDQ/VAdBF8N1UHb7rIaS72i4Pq/I3aXKkECF95Mxw6rJ3MM7nAFQokEyrU7aM05XUGOOvVd3U59Udfjfy9OaVJQTYsit7udzg28BO/ctnku2yhecFQxU/q6HeusM4Jp7qg6dMnUZxgRsL2TwzBgtJ1djaTQ9XXOMfdWdppQkMLa7l7BFzkrnjn3zTB7MM9mgyHMQxi5xxAxxwzxh3XUbRc2a/pBrwuT3n6/Lp7RPbrcZb4v7gZ6BklXVCQVruaXzM8IcPvd166az5sIHfX31zY7JrI+eyG4wTTgb788+evt+VM2IZjp0ry0hHCFpLkAiXKCEHFlbK+6CUKLXGcxupxMneB7S3dtKG3YOIXC7J06E4JdHgYjvEF9P0VBdialRcLVAFp19aTyTiI+iZRaX3tuSQo8magOLNThS+ueujbn5gGp8DFzT9vvVIu9lFR9JLVrogkquvGOXeaVXnxBr8cK8Y+KW8tzazlu9umKFN60l7G/ux0jd4kFT62z1qM39/xaC/xoeMIT4roqA1kiyLF8QyquvPZoOZb4tYjfshzv1NupRA9dXsZ8yWIWLTBN2CGLp1pb8U/GKHQoDS4nJbLo0WJd06YtlxGtfndBpJbfsiVbQIROviMkhvLBxEfUkR0g0f5sxKXke+dZ5Px7zMsJe7+ks3t8icZJlImO7aNlpg1btGHL1wAb5Pd9iQILuU06uDrgA2B/7n9XCYKgC3XP87qzqjv2HbeGWkMMUR0Xm+/6L7vzAhc+MfeCqGsalGEC1PWdMXxngRc1pyVjVUcBqxZclzfV6IkrdvPy1n/QpD75s+lLGu/NT0yOVTr70VX6nkry89Tdv6niNZXmd6w0AeLSyePp/IdzB9UwEn609qN+TYbJHHHt9AtDx2I2vQjAcP2okM6ypwL/460rCg62YyhyY56DS4uM8pQXlD6ufMRTKdwhQy54QSBzg0JYZy7lc6OpzmCUdIwmBjSoDxbgl49kCn7uGLzambvM9AiWAsj9SrIMlzI0Yh9Dq2izt5j7VAz/08xH14Hx7oMOw98ZQuCEIoi9rKIK6C7LSoXdqACUGeOI3QdCL5E2Ln2FxAioRGUL7TBmvaoqFxTTpELbTT8ms8djOr/GaLwQYQ/shQCz4fAapicv0jhAg1WtyKlIXQoQ3fJ88BBvhHVrKtKcpk6UdyA9sbDD68PzNY5gpsJfTLSZdMIi2yFaMKE5zIfPZrvX7rbcXILnNMRhTl4S3/8OdvHHtEsBeDM/sP+ZfjQbOh6NKp2cjtZIvdKPTn5GvYziJZ38r2Q3oikNsnh7c0NnLzS23dJj5D8N9pdX84mMvoGrP4NxY+1HQbN/OPRvnc9c+w5D/vpfM2hQ9Cv8uc4Xaa8WZu2TYzrhikbhZ7yZPzYw/BoP6f/d6B3+4YvOfcCByD2/iapDONB4vhVOugsmhA+k5u3t/wAcrGgB +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Deletes Campaigns

+ + + +:::caution deprecated + +This endpoint has been deprecated and may be replaced or removed in future versions of the API. + +::: + +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/delete-connector-rule.api.mdx b/docs/api/beta/delete-connector-rule.api.mdx new file mode 100644 index 000000000..dce4805cb --- /dev/null +++ b/docs/api/beta/delete-connector-rule.api.mdx @@ -0,0 +1,96 @@ +--- +id: delete-connector-rule +sidebar_label: Delete a Connector-Rule +hide_title: true +hide_table_of_contents: true +api: eJztW1tT27oW/isan4fddnACIZSSlzMp0D3soZfDZfpAmVPFVhK1tuRtydBshv9+viUpTpxAabs7p7sdv0AiLy2tu76lyDeR5RMTDS6ifa2USKwu2UmVCfaSKz4RuVA2utyIUmGSUhZWahUNogORCSsMs1PBknpaSdNMIRI5liJlo5l7PpFXQrGjg847NWRWf8SXa2mn7PXJ7/8dHrw8esV4Zae6lHbGpGGl+LOSJaZbzRKeZeCB0eGbo060EelClJxkOEohReqkqMUmqUFT8JLnGC9JqZtI4QtoZYpHkmQvuJ1GqwodHTA9vksdSOGXwZS5aNHAlpXYiIydZcTbyLxwS4tPRaZTDI15ZoggmYqcR4ObyM4KR2lLqSbRLZFyN2kQPUu29jbF091nu5z3RbrH9zZH6V66s93v7/S2x6Po9pKWNoVWRhhi1tvs07+mBq80iW7hLhYzqVKZ8LmHSG5hLLvmhpkqSYQx4ypjo8rS41KQ2dViOlQe0SRblQp+kCow8RJ0SPr+5ua6BPuZpOmHZQnjxeykZjBuSDHSqXO0VFc8kym5NaxMLHlRZCQ6WHY/GOJ7s25GPfoAF5GvS4oIK71dUmG5zPadB1ZNvurwF1KJeFJySRIKJ3KCiQwcr2SKGSzXsIxnOY8NR9eJlr0HS3S22HOeQl+v335QBmayJU8+ghdF60MCnSuJ+Ww+hcmUjSHUPcuKXcFHTzf3ev3x0z7nvWf9rd2d0d6Yb29v7u3s7dHqOfyMDDZLa/Oy5LO1pX8XSpQyYZlGwsm/YJBScNjeCeAWp9yxIjcP+8Dx+AL7n0EvT1urGeRlVnyyG4yz5/tvWH+XZVxNKjfOJytGUPH5KUZUlWV8REOUl9DcM35dyolUd4kiVJVTxTs4fDE8Pz7DyMnhf84PT/GJeK2Vu6GaZxRERSxM9bWTOCjg8gpFIrEi7bAngesTKMSVWSaU/puZGRgTsTXmVWYxI6x+x4xl1mxc6ryRSi5vPln2SHZEZwNZi7Gc22TKRtxggvap+2SInC9sfBws+YRNBU9F+bjDhmkqSUmeMWQjmGL+jNKfp+ki98cVUlm4sq1RNJS2MhFNXyxM2fQGkkBaR3G87BRKDkj+cJwME1tBOKfmchbW0RJEnFe8NFiuKd3ZahWcKcsTaIENZgYzliUs7AqitKYuhJJsn3M1p6sr1u3tQi1X7l56YQ6sds8SXpkvyLs3GcpP7FSrH1yJkHyG6rCvRs4bczeFioSHpLabHKhqd80Tn2EbztI2d9vcbXP3C3N39eFJQD3hqYM+W+vQ51wFDEub5xr0qRHWnMjBm+DIDQaDBIj0x9uzgJBBDzBJYPM74iO/la8JP6z94cdHBD9qZzV8QQI6O3oNxqhEIh04uRcSO0N5U22vr/ZClyOJAFV3QERUzZLNdMU4TFZWSpEk3GywVAujfrNsylEfuUOwvgLSqiqNCy2VbZFkiyTb3ajdjX6d3ahFkm3utrn7c+buZ5FkLZXLloCTTJXnvJz5SAvPSVvOQFCfv7E65ZyrVtEKMWM1xoqayCEa9bZGW+PdRPRT3k+fbu+Ne8nTHt/Z3drdGvV7u9HyXn+xyOM6yZo5teRv70dnYoC4K+C4SiG4jNU6bR7/wbylGFNZo9JT42bYHCa9XGDHO884LXQDY2DH8p7jxfOTY+KPpR17spuuykQQzPamAzm3DlJSDMPS0tgWOrbQsd1+2u3nl9l+WujY5m6buz9n7n4VdOw/BB37XwEd+4wg1pgg1o+EjilwB0GzMZwCHZIK5lUEGwuogk/h9DGkveXlRNga6DVQZG9vHUWeaU2XG2ZzsGQaJ5FqYS4qb6DNibac04KAhzsNqFoS6JaiSuaCMCnih2Uyly6PSSHwLWfxcGyhlc+Z1d/T8T3JKkjoikKm6exVI8YkwkmMCf6BgzsHnaBQf8czzuCtv3UezE5I42PSmB1+SoSgnK/Pf3fuuiVwBOFLKhen3tf3XBfwZ+ZcoY0QnwpfvmoI2kL1Fqq323273f8a230L1dvcbXP358zdr4DqAQ3dD9VB8MVQHbSdTVZjqRcUXP93xO5SJUjgwpvpxGH1dIHBYQQjMCjtzC1yDoi/70N5WNkpZaZM1YDu2sZ5feM4rm/hDvxgdEm3YHOBoFzc/KWCRJd5B1G3po+Jk+neyPQ2oqUJY3r1qjID5dTawgy63Rt4Hd6+7fBCdlAM4Xg7U/q6k+i8O4Kp76hidGnVZywR0J3k0LB0nJ9KSang66Zj7r3mLENBD++5ewqf5UzXlSkcZuhlmGezwZA2ISzdMEQs0JP8Zhx1x4Xhmn7Q67zMbv++Lp7RPbrcZb7PrgZ6BklXVCQVLheRckoA3q++Fi+LTYl+OuitLfaayHrsueAlugt/m+bRH2/PHrMJwVZXNipDiFlI6jOQeG8QIq4sDuc3S2iS26lKXU2mTvBh4+4OpSEbZ1CYvVOnQrCLo2CEV9gvTlDgnUlpknA1hWZdPpp7JxVXIqOttLOwJAUeUqELC3V5Y95jt226/kIqfMzdaOeditmBpGomafsnmqCiaxfZRTHXiy/p9a1C/GvOLfbcYsfNPF6Rwpv2IvF3wRPUAmLBM+Os9c2Le37xEj9qxjBCXFdlIEsEOZo3rpK5175Zjga/mPg15Xin3k4l9uTmNOYLFzPYUrOUHbFkqrUR/2aMQofS4GJSIYu+WaxrWjR2GRH3NpdEiv2SsYyBMJ18x0gM5YOJj2iHdwBH+7MWl5LvnWeR8+/Rf6fsfUNnN3yBjZgoU52Yb5aZFoxpwdjXABPk9/scBRZym3RwdcAHwP7C/64SBEGX6p7ndWdVd+y7bg5tDQlEdVxMMfBfBosCFz4x94CoaxqUYQLo9R00ekUl8KLNrmGs+dHCqgXX5c009tgVu3l56x9Iad/9p+lLGg8XJzCvVTb73lX6nkryz6m7P6jitZXmV6w0ATJTuLllQ2+xHOTPA15bPxGkI+upwF88dbnq0Dl6H//CHaGYZUZFxi1FtcvqZCqFO0soBLeE/TYosnTuMhFtP6U/OkbHaFKCBmlrgEn5SGbg50675ytzlzAeWJJf6bupwt0LjZBEbyo67C3aO5XALdTa0a1fPPugQ493Cs+8Iceyg7mzAbryvFL0niDErnLGEVIPREQqTVL5whVaBK+CdtCvnjXPYgo1UqHjmpwyN6/HdEyNDnjJ8Q+sBb+bcEYN05MXwyuIC0VOROYik+iasP0h3oi2eCqygppLVF0AMLG0wsujszWOYKbCDyO6nHTDJNMlWjCh9siHz3Znq7MZu3YB44U2Fq1XQ3zquYAr6xcu4/DGZSMMbxan8z/sNdGw91DT0C3o0Iw0qnwT4zvGi2ilY8SsgUzpTdcpNCeCmxs6WKEe6paG/6wEde0Xl4v2yLWV8Ax9TuuXPu+1xqOTIPNj9kWvm96pxfyAUM0WZwMRPn4UdKQADdB4Qwd35uPk8w/8qdDSlLXfTRr99cHh8eHZYeThzF27efgAc6Be/Q90xQ9J +sidebar_class_name: "delete api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/delete-custom-password-instructions.api.mdx b/docs/api/beta/delete-custom-password-instructions.api.mdx new file mode 100644 index 000000000..e3e05eff2 --- /dev/null +++ b/docs/api/beta/delete-custom-password-instructions.api.mdx @@ -0,0 +1,87 @@ +--- +id: delete-custom-password-instructions +sidebar_label: Delete Custom Password Instructions by page ID +hide_title: true +hide_table_of_contents: true +api: eJztW21T27gW/iua3A9bOtgBmpYlX+6kQHfYoS2Xl+kHYLaKrSQqjuSV5NIsk/9+zzmSHTsJ0HJftu34S0ts6ei8PUePZOmuo3NhuJNaHaWdficVmXBiv7BOT0+4tbfapEfKOlMk2MZ2NjuOj22nf9nxjVjZijWaXW+CKJsYmeNvEHw+kZYNTo6YH4G5iWCJl5CXEmRNAhtpQ41sLhI5kiKFdmPBjg5iNmBO3wjFbqWbsPenv/0xOHh79I7xwk20kW7GYCgj/iykgV5Os4RnGcjyCsRgQs4Nn4IWBg2560hUMOduAq8UvKBfYwEO2ezYZCKmvNO/67hZjm9ARanG8EaoYop+SCZcjUVUWtEXCgRXP6HhcoORVNLiWKNM30YW/EEm9/1f+FybsXBRYYVBdfr4RwRayAxeTkc8DJHoVDQe3Ax5+F2JMsKCpPt1W/u+HHj1faV6oTKd3EQ8SXSh3Gq/pfeh3/UcJfrAdPoQa7GaJqKMM9OjhzMEIuuTCUMqvvBpnmGAavbPN0Nw/yyEmS2iC7rxTDwQ3fk6vXyvKjGDbnWVNhlnr/dPerssg5AXaAegJWbYOxUjXmSOfeZZITBDr66uOuEh/hl35tfk7xwECYs67Wz18L+mJu8gnzW4WzkWweCpTLgTljRC1wrr2C23zBZJIqwdFRkbFg5fGxpVLbqD/4bYyRVGCfRtEOI1iNEJva2tVQ32M4ndD40BT0TstBIwamgx1CkhUSowWaYYpDAyiuR5nqHqILL7yaLcu9Vo6OEnn8a5wTLlpPdLKhxgYR/Tfw0um8q+kUpEY8MlaihIZcQNA4mfZQo92FQbjA6KxJRDE6hdM6vAE/E2e81TsNfbtx+MATc5w5MbkIUl9DGFLpSE/qzswmRaZdSaYcWu4MNXW3s7vdGrHuc7v/a2d18O90b8xYutvZd7ezj6FOIMqWZrY3Nj+Gxl6N+EEkYmPpHlX+AQIzj4nhSgwaGLdGJqH49BgNCj5q4BTtCXOfHFBcSwZcg0naCiizNEb5FlfIiPsHSA5V7weyPHUj1Uog8O3wwujs/hyenhvy4Oz+AvlLUySQ1UiShQFXJhom9J42AA4Yoqi0hj9jxIfQ4GcWXrDaX/ZWcWnFkiH3qE0df0qItmIwN1pQ4lws0Xx57JWMSbgFp4NuUumbAht9BBe+g+HwDmcxcdB08+ZxPBU2E2YMpMU4lG8swXIAv9Zwh/nqYL7I8KgLKgeVVD0VDayWSpui5c2YwGgEA6anFcDwqCAzR/PE8GiStAOTKzjsIqW4KKZcVLg+ea2p0vV8GZchxqMzKAGbjRGPAwFUTpbFUIJfp+ylXZrqpY8/nCLCp3b70yB07Tu4QX9itwd5JB+YnItOrFZxHAR/OYr0YUjTJMoSLBSzSbOodWVbhK4DOgR1naYrfFbovdr8Tu8svTwHrCW6I+L1apzxtthhK8rtbwHmS/bKYLxiEMplAKZ3cOnDDVwqpfHJtwAD0nWuZhDboLlUa5lsq19KilR22JbUvsz1NiW3rUYrfF7o+J3QfpUaUVoSXwJFtMp9zMfKaF92gtZ9Cg2lRiFeQoVMtsBYWximN1msyhM9zZHm6PdhPRS3kvffVib7STvNrhL3e3d7eHvZ3dTn2uv1zguAJZE1O1ePs4kouBxH0GHlcoSC7rtE6be1rgXiNGWNaw9IQd578gdg737+bzkjuu3bhzYBsIBu5o7tkzuzg9RvkwNIlHv+nCJOA3E1wHzbkjSok5DJ6W1rXUsaWO7fTTTj8/zfTTUscWuy12f0zsfhN17D1GHXvfQB17DCnWCCnW30kdU+AdSM1GEBSwISnAvQppY44f08HzGNsK9o7jt/6K6NVZ5Mt1H1+P8Es7JuyZH+2er7D+Yy9XQGTFl9wDqCJBLVlsyWI74bQTzs8x4bRkscVui90fE7vfQBYDG7qfLEKDryaL0DbeYhWXeoPJ9X/njASVoIE/G6gTYovpggUSr4BUWpzNxTKCR1X7na4/gVidzozqRxG7d/4I6xzae2LqtSxMBl0nzuW23+3eQfAgaPOY5zKGmgbxczOlb+NET7tD8NiaYoRH+jzwsAGd6fUDxORuIzGjffkj4d75ZCDmLgSBPng/KBnPaWJUZ0CKmRezySD7Q3bRY1Ax52r2i6XWMWXTin1g14XJ5v+5LV7QPbasc9+Do0F7BpoumYgmXGO4IAtAEMXrAvTZ97VrUGDYL6/rbc6Qq3sNV1ou5h/cp95ZUeg9NtthrwU3sJDwR6qf/f7hfIONkaFShSgskmMhcUkBGDuBNKIKOCiPMWAnmpSMLsYTMm4QdsX9QgcRx/Ckc8yu1JkQ7PIoOOodTA2nUMvJ7dhJUPnAXtfPygim4rPIcNaMF97G5JSp6oIXu7zRb4NmSFpKSAV/TulpfKUidiCNqB0tDybSGQ12mZd28ZpdT1XiH6W0yEuLSJrdWNLCu/Yy8adpE4A9iuCZJW89eXAvL6rJw3UXPEGpyzqgJ4IevBG1pIzak/VoyKOz6k09rtSHiYTpt9mN+WrHLMyeWcqOWDLR2op/Moapg1C5HBeAtCerdYuDRoSIaGerplLkh4wkHmMn/Y4BGMonEx/iZE5cRvuFPcH2I0UW6sJHWGqn7GPDZnp8CXMutkx1Yp+sMw4Y4YCRrxM26O+nNEysjr9MQHXAJ8D+Iv5UCYKitdroZa2t/CS+S31w+khAVZJi877/0V8UwfJcO73A1lUbKNXIxasDT3gLI8jCea3hrHIXYdmDq/pmGqbTJb95fauvcTjFfm/2osWDxWbLe5XN/ttV+p5K8v3U3b+p4rWV5mesNIEdY7rRsGEZUU/y14HTrW7+WbqABv/CW8IqEXFY5vg7Zchi6oLyjDvMakJ1MpGCtg1ywR3yw03MLD0lJMIKH+EPi0MSNDbQBmBrgbfyocxAHt0GKkfmBBhPPjGu+NsW4UO/Zv7mWMw+wEpOJRAWXMXhEVN490mH5dwZROYEA8sOymAD6ZpOC4VX4UDtYso4pNQjGZFKC+sJcgYs6pQofaGJ+lW9ShRjqqEJMa1nzNS+H+GONCx2a4F/ZCyIuw3b0eB6jGK4n7Uw5FRkvLx42KT2j8mGbIsmIstxHQlVFwiYqI3w9uh8RSIIU2EXXptxN3SyXWwLQnAJ5dPnRbwdb0W0pIDnubYOVr4N9emK40MXJNlwVt5zW87Ou8X+/Pd1azLMU7jA6Oa4l4bWF35R5Jekl52HlqQgoh/uVcIKZgJuwx53d7gBg4u0OT72N/Vw5QOBRHTByncEpWX5pmDTS//7y3n3mH8jcCuiuk8Ydhs6dJevXD9+ozXPTkMQNki1J92GXKtruTmqZnVNSxtCZOZ4R9PveZHe/qXfFat1W/luhAZXOxUHh8eH54dQov8NsesiUw== +sidebar_class_name: "delete api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/delete-form-definition.api.mdx b/docs/api/beta/delete-form-definition.api.mdx new file mode 100644 index 000000000..be5ada62d --- /dev/null +++ b/docs/api/beta/delete-form-definition.api.mdx @@ -0,0 +1,67 @@ +--- +id: delete-form-definition +sidebar_label: Deletes a form definition. +hide_title: true +hide_table_of_contents: true +api: eJztWl1v2zYU/SuE9rAWiOw0Tbs1L0NaJ0CGtgkaB31IA4SWaIutRKok1dQz8t93LilFluU2WVYgxWY/JDZ1eb/PJS+pReT4zEZ759GryjpdsENtChtdbEWpsImRpZNaRXvRCTe8EE4YdrmYgmQkplJJeng0ur5kNtNVnrKCuyRjnBEFS29I2NFoEG1FuhSG+ykpOKYiB7/DDi8QlY0gUmoRKfwA8apIEEpSq+Qui1Z1PexJB4kRnytpBCQ7U4mtyCaZKHi0t4jcvCQR1hmpZqD8Gs90XMs9XJV7vRWJr7woc3q6XX/iNX+az60ML0g3W2plhSV1drZ36V/XpHfCVUZZxhUTRenmbKLTOVgnWjmhHE3gZZnLxPt3+NHSrMWykdJ5ld/KnBlRQiKmWeYywfAjFUnO8Y994XklmJI5xat2jJ58FIlr7Ch58onPaHymh0Rho2t8tqJd2NrTex/6GqMNu5Iu89IoDsI6ppOkMhSPf2LEikKloZRyMjguFY7L/JVOxW1RHbWUULwQ1sIiuzSLG8PJvdKJwi6774CMeRMmMBn8Zx1XKTcp2z85qq1tAspq3oz4rnNp14JcJzwXfS++9uONPO835VgYjZYTUqj47LQVs9b4ehoMD+KOjZxJ9S2h4SnLdJ5aVmpr5QSa+DSxTE/x4MorFXixK26ZBbAT5yPbajY6ONw/ez2+k261RtDQia+ur9kYo40zeOIqnjMiJHVoKISg9nxHiXGGWTKgiIhu0YbkRJTaq4mPXK4mg0QXQ4s8KrVUbshdzi3owpfhlZhE1112b5o8wzhyxlV2JVfBRswEaUXljrsw9Hx3Ra3Tdi65yEAv6E419ftZP24oRx6xAbNP7oJZXrlMG/mXx+UGuRvkbpD78Mh9ehfkVhY7NuRpIRF/5PUGvBvwbsD78OBds8Xvg5dgwJR2aKcqtUHsBrEbxD4YYnderHGv1qzgat70tPY+DbkHyl0QcjdkdLHd1bdFcyNvORuCp1lCj40/bljJzCNYZhRy6FSYL9hWHNwhMzYFZFNAHraAdGG/Yt4N0Bsjm9OpZharlMQIkynyQE6lLzqtmS+SdPupmP6+LZ7z3Z1nYvJ88uTJJJ1Mtp/9lqST3dvMXi409zfeV6hn3zh+kw1qbUBtiNmmDdjUhP9vTfgpNhWkh0A2STf3Nx1nAOgrwuJXt1+5jK5kbLlHutg97DLI+Au6LCiEy3R7geKvTIg8GhJt3N572GH/piYioVQHwu1KZXJMzJwr7d5wuEAd4MpdD3gpB6HiubnSV97XE6C2d9PShJQCTwQehEEA4e0LN5IjYwOIPfOQT1Ne5eTgmwB+lzN5kNJrrivDApstwjRKVZ7PwzBULLEV+9V66gH5eKtnH+w6M/n1v7clMPqGLevc911poGfQdMVEMuGizZFTqsNBei9T2tpMJ7U7PWHHRLbDXgpusAI4/Uko9ujP9+PHbCYU3cmJlFWWljsBcIGEsxOkiKZlYz9JgJx6EpDtMqOrWWhQ9zvnwn5jOc1hMPugToVg50e1E96iTL07OB17l9IkGg7rzMWjJjqp+CJyqseD1pOUeDJVQ3hoyDvzHtMdIyu0QWFWAbAYHXxQMRtJgwroT7uIpjaRrOPsvGzs4kt23VeJXxpuceAWe2728YoWwbXnSS5p4Ujoug0seG69t+4tPPCLl/jFM4PEiYnrqg7kiVqP7ml+0kTt3np0+MXEr6vHB/U+k3Qt3JnGQh1rbo6PWJJpbcUfjFHqEAzOZxVQdG+1rkho7BER72wvqRQHkbGMKyu8fq8BDBWSiU905cK6qhkKZxogeekjC8xfYvlK2WXHZj98jnWaKFOd2HvrTAJjEhiHGmBr/cPmihKLlifY4OtASIBXbfx9JagVXap7gdfaqu7ZD/0cWhoSXYYSg5Un/NhrC1z9jfkHRH1DgzJM27YGUQy/Wc2LlrmOs5pVd9WDfX1zjX3Iit+Cvs1c0uKns5cs3m830scqn//oKv2NSvLz1N0HqnibSvNfrDT1ZpnSbbkZXE7yl/V+rYepMzo4ywT+4qnHqu+H0be0x+zLjMqcO//yEqE6ySScSq/LCO5o77dFmaULj0T0jgR/9GGe0cyABrC12JPyiczBb8DGrWTuARM2lhRX+m0r34iSrCTjaiYG7D0aKJUgLNS2Ijz07CNi6RU9RWROKLBs1AQbm66iqLC9nxMuq4JxpNQtGZFKm1ShcKH3V6LxhfZbv5tZDYop1cgE30ALdCPHUzoAlIlYCvwtshD35nAUrqco3pwFNIa8E7nPTKLrbttv441sizORl76phlro/JckvDka9ziCmbKwKxEDbWbDepIdEi2YUHsU0ufp4MlgO/btAsbRgDt0Yh31qQWz/TfeBquZuGjPWX7Iu3T1UkI9wBBJGxr2KvQkoR88j1b7QUzb671IhxYjg11Ev1hMuBXUIV3T8OdKGGpNL9rmxzeN8Dt9Rws6RSUQ3zH00bv6pbvHbO07eWuNaA6B1Nx3XXlFv/D1k4Ay/RcBry8wJxM8RetO2gUy6lpKt8Sgd7TVaaVHB68PxgdR2KqsW6nrL3AGatHfBOl0xg== +sidebar_class_name: "delete api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Deletes a form definition.

+ + + + + +Parameter `{formDefinitionID}` should match a form definition ID. + +## Request + +

Path Parameters

+ +Returns an empty body + +
Schema
    + +object + +
+ +An error with the request occurred + +
Schema
    messages object[]
  • Array [
  • ]
+ +An error with the authorization occurred + +
Schema
    messages object[]
  • Array [
  • ]
+ +An error with the user permissions occurred + +
Schema
    messages object[]
  • Array [
  • ]
+ +An error with the item not found + +
Schema
    messages object[]
  • Array [
  • ]
+ +Too many requests + +
Schema
    messages object[]
  • Array [
  • ]
+ +An internal server error occurred + +
Schema
    messages object[]
  • Array [
  • ]
\ No newline at end of file diff --git a/docs/api/beta/delete-identity-attribute.api.mdx b/docs/api/beta/delete-identity-attribute.api.mdx new file mode 100644 index 000000000..3e8ced900 --- /dev/null +++ b/docs/api/beta/delete-identity-attribute.api.mdx @@ -0,0 +1,95 @@ +--- +id: delete-identity-attribute +sidebar_label: Delete Identity Attribute +hide_title: true +hide_table_of_contents: true +api: eJztW1lz2zgS/iso7UOOMiXbUeK1X7YUx9nylHOsj8qD46pAJCQhQwIcAHSidfm/79cASOpynGRSO5MUX2weQN/d+BoCb3q6FIY7qdVx1jvoZSIXThxnQjnp5iPnjBxXTvS2eo5Pbe/gsle/Y81L27vawkSbGlkSIZA5n0nLAi3LuGKynsTrSeyTdDPmZoJN5bVQTPFC9Bk7x4MPdm6dKD5gYoYbh3/cZB9YaUhWJ0GyqKxjY8GscMxpNuG5FbifaCPYXFcsBc/AfjP3PhSyIq0MnkKpm96FFeZQKyc+u1HlZqSozNRBPTMB74nMRdJQOAjke1e3UL7kBuI7YawnJskEJQeZrR7phTv/DzzTmSh47+Cm5+YlPbcgp6a923UDilbaB5Y5kc6UTHkeDAVSRvxRSSPgNGcqsdUTn3lR5kQzk7bM+fw1sSTpjLClVhZ+At/d7SH9W+b2WrOUlFeOJUyqDIzIceQdYiNg7E/cMlulqbB2UuUMYtFrmBuOVu10OGNMk1xllMhAKxIJEvRJ0eH29roEh7mk6UfGaAMZThsCkyUpxjqbE0eprnkuM7JD5EwkeVnmJDpIDj5aonuzbnE9/ihSh4ltOAVxHJf5oc7EundWnfNSKpFMDZckofAip5hIAXotM8xgBQViIMl0UMGPI4FbR8ES/R32nGfQN+h3GJWBmZzh6e+gRWl5n0AXSmI+q6cg4BlS4S62Yk/w8bPt/d3h5NmQ891/Dnf2no73J/zJk+39p/v7xL2An/k0mCby5sbw+RrrfwsljExZrhGc8r8wiBEctvcCeOaYIpHO9n4feBpfYX9KjjC2UTPKyyiBtxhnzw/fsuEey7maVv45n64YQSUXZ5SfVZ7zMT2iNILmgfAbI6dSbRJFqKqg8vDi6OXo4uQcT06P/nNxdIYrorVWCkeqziiIiliY6U9e4qiAzyuUktSJrM8eR6qPoRBXdnGgDHehNiK2JrzKHWZE7htmLJJmE6OLpVRKQ7VjD2Vf9LeQtXhWcJfO2JhbTNAhdR+PkPOlS06iJR+zmeCZMI/6bJRlkpREUUI2VlSW+ZzSn2dZm/uTCqkcyr1G0VDayVQs+6I15bI3kATS+REni06h5IDk98fJKHUVhPNqLmZhEy1RxLriZdFyy9Kdr1bBuXI8dVSM8znMaAws7AuidLYphJJsX3BVj2sq1u1tq5Yvd6+CMC+c9u9SXtmvyLu3OcpP4lVrXlyLmHyW6nCoRt4btZtiRcJLUttPjqMad9WJzyZS5FmXu13udrn7lbm7+vI0op741kOfnXXoc6E4EKc2fvFcgz4NwqoHeXgTHbnFYJAIkX57d47E/h1QGuPF55Kw4Q/ER2EpXxN+1PgjPB8T/GicteQLEtDbMWgwQSUS2YGXu5XYGyqY6sk6t5fajCUCVG2AiKiaxmN/DpOZSimShNstlmlh1QPHZhz1kXsEGyogcVVZUmqpXIckOyTZrUbdavTrrEYdkuxyt8vdnzN3v4gkG6l8tkScZKui4GYeIi2+J205w4Bm/401KeddtYpWiBhrMFZvGTn0xrs7453JXiqGGR9mz57sT3bTZ7v86d7O3s54uLvXW1zrL9s8bpJsOacW/B386E0MEHcNHFcpBJd1WmfL238wrxETKmtUehrcDJvDpFctdty4x+mgGwgDO5o7thcvTk+IPlh78mQ3XZlUEMwOpsNw7jykpBiGpaV1HXTsoGO3/HTLzy+z/HTQscvdLnd/ztz9Jug4vA86Dr8BOg4ZQawJQay/EjpmwB0EzSZwCnRIK5hXEWwsoQqu4u5jTHvHzVS4Bugtocjd/XUUea41e8XVvAZLdmknUrXmovKGsQWNNfVYDODxvAOqlgS6paiShSBMivhhuSykz2NSCHTNPBlNHLQKObP6ezru07yChL4o5Jr2XjViTLr6MAQo+H3QKQr1D9zjjN76U/vB7JQ0PiGN2dHnVAjK+Wb/9+mmUwLHEN5QuTgLvr7juEDYM+cKbYT4XIby1UDQDqp3UL1b7rvl/tdY7juo3uVul7s/Z+5+A1SPaOhuqI4BXw3VMba/zRos9ZKC6/+O2H2qRAl8eDOdeqyetRjc4wqEUnswmcoInas96A2ao7nNMVk7uKHDsbc9OttL+DCIVpkc42fOlfZgMLiBx+Cp2z4vZb+mofSnfqqLwRhm2lCB6MBpyDYawEZvj2Oz0fc2NpLCONQ8TzxY3GtFAQvL+zMGX6RMkpMr5+hDWCCzxRDyMaT8Y4hYop94YOMhYLLQmn7Q68Lkt39el0DoDl02me+L3DCeQdIVFUmFq/Yo9hmB78B97UB2u6DQtv/uGrM3NGyXPRfcoDMIJ2Ee/vbu/BGbEuT0KV9ZQrtCUo+ApHmLEPElbVSfCqFJfpUxupqG4+mjpXM3lEJskkNh9l6dCcEu6/Pwr1HrT1GcvUlpkvD1gGZdPay9k4lrkdMy2G8tSYEnMzWAhQZ8ad4jv+T53kAqXBb+af+9StgLSZVI0tJNY6KKvtVjl2WtF1/Q63uF+EdNLQnUEk/NPlqRIpj2Mg3nuFPkMZHgufXW+m7mgV6yQI8aKTwhqqsykCWiHMunpdLaa98txxK9hOgty/FevZtJrKfL01goX8xiOcwzdszSmdZW/IsxCh1Kg8tphSz6brE+EdPEZ0Syu70gUhJYJjIBOvTynSAxVAgmPqbV2YMTHfZJfEp+8J5FzscvL5Z09o8vsYjSyEyn9rtlJoYJMUxCDbBR/rBGUWAht0kHXwdCABy2/veVIAq6UPcCrY1V3ZMf+Dm0NKQQ1VOx5UG4OWgLXLxi/gWNbsagDBO4bs6P4Z5FWrRQLRmr3hZYteC6vLnG+rhityBv8+MmrZl/N31J41G7e/JG5fMfXaXvqCR/n7r7F1W8rtL8ipUmwl0KN8829gWLQf484rX13Tzabp4J/MVbn6seWaNvaT+yWyRU5txRVPusTmdS+H2AUnBH2G+LIksXPhPRslP6o9vzhKYGY5C2FpiUj2UOen6nuubMfcIEYEl+pXtbxXMTGiGJvlL02Tu0ZiqFW6gtoxO7ePdRx/7sDJ55S45lL2pnA3QVRaXoAz6IXRWMI6TuiYhM2rQKhQtdmhK1LbSHfs2sOosp1EiFvm9QTGHfTGiLGd3rguPv4QW/27i/DNOTF+O3f60ipyL3kUnjlmH7fbQRbclM5CU1hqi6AGBigcOr4/M1iiCm4o8a2kwHcZId0FgQofYohM+T/k5/O/HtAp6X2jq0skvi++8o17/7XA3Em3Zv/af4ADSuVNRiDEraHiP9q9DyhC6TPgJd6zIx88CbBo3LDNaiYTc3tJFCfdctPf6jEtSlX161LZVvReFNukY/6wX+gv0ensbPOx95i3z5U9CNitS7gWrebgT0cPm7oP0DFT4OxbiwxePFC6/CJtDCpLWfSahlaxrzF0cnR+dHvYCANgGAeAFroMT9D5PRKhI= +sidebar_class_name: "delete api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 Attribute' (delete-identity-attribute)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Delete Identity Attribute

+ + + + + +This deletes an identity attribute with the given name. The `system` and `standard` properties must be set to false before you can delete an identity attribute. + +## 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/delete-identity-attributes-in-bulk.api.mdx b/docs/api/beta/delete-identity-attributes-in-bulk.api.mdx new file mode 100644 index 000000000..a66470bf8 --- /dev/null +++ b/docs/api/beta/delete-identity-attributes-in-bulk.api.mdx @@ -0,0 +1,95 @@ +--- +id: delete-identity-attributes-in-bulk +sidebar_label: Bulk delete Identity Attributes +hide_title: true +hide_table_of_contents: true +api: eJztW1tv2zgW/iuE96EXRM6lbrPJy8JJ20UGaZvNBX1IA5SWaJtTidSSVFpvkP++3yEp2bKdps0UO9OuMEDHosjDc+d3Tqibni6F4U5qdZT19nuZyIUTR5lQTrrZ0DkjR5UT9kgdVPmn3kbP8Ynt7V/26ilsPqd3tYH1NjWyJHqgdj6VlgWSlsl6BW9WsLE2jLOJvBaKWeGYHjPFC2H7C2SZm3LHuBEsrYwBjXzGCl6WImNSMa5Yw8qJ0WOZYx5XSjs2EnHvrM/Y+VSwj3ZmnSg+YlGGB4f/cZN9ZKUhJTiJvYrK+oXEjNNszHMr8Aw+BZvpikhHorTzqkh9qMgKMIpRqOmmd2GFOdTKiS9uWLkpqU5mar9emZSB56ShkIyg6P2wR+/qFjo14t+VsO5AZyB54x+lEbCWM5XY6KVEXTl6Ba3kMvXW3PzdkgluejadioLTLzcrBYyiR7+L1PWWbbVqUHb00mLaXDtERGb+f+21x9J6260x8SPmRDpV4CoPpiUfCoxwY/gMjxI2sQsMWqxVE7wQX3hR5jREK3u3CyOXYQhCSFvmfPaWnq5uMQX7+yUrPvzW7357S5OMsKVWNoi0szVYFemtZlGxLIGfZaRW74uCRXuwz9wyW6WpsHZc5Qx70Gs4CpxezZfDjUa0yFVGBZ8NRAIHfRJrsLW1ysFhLmn5K2MQJAk7bQiMW1yM4Ba0o1TXPJcZOeCDPaJt6kw4LvNDnYl1xmkz+1oqkUwMl8Sh8CynWEihdS0zrGAFhVAgSa5CIvh5/ZahoYn+NjvgGeQN8h1GYci0hqefQIsy1X0MXSiJ9axeAtf0yeaObcWu4KMXW3s7g/GLAec7fx9s7z4f7Y35s2dbe8/39mh3eI/lE7HoqbUHt7f+p1DCyJTlGk4v/wOFGMGhe8+A33yN099hA0/jG/RP6S3MbcSM/DJKPRvIsgeHJ2ywy3KuJpUf55MlJajk4gwjqspzPqIhSjCQPBB+Z+REqrVxqqqCQvLlq9fDi+NzjJy++tfFqzP8Ilorx8JQ1REFVuELU/3ZcxwF8HGF/Jf6zP00Un0KgbiyixNleApZHb415lXusCLuvmbFImk2NrpohVIa8jR7LPuiv4GoxVjBXTplI26xQIfQfTpEzJcuOY6afMqmgmfCPMGplWWShESyQzRWdKDwGYU/z7J57I8rhDKYkW6qkTRwVslUtG0xV2XbGvP8drxoFAoOcH6/nwxTV4E5L+ZiFDbeElmsM14WNdfm7nw5C86U46mjJI/DOdU4plPnE6J0tkmEknRfcFXPazLWYtr26e5NYOal0/5dyiv7DXF3kiP9JF605sW1iMFnKQ+HbOStUZspZiS8JLH94jirMVcd+GwsRZ51sdvFbhe73xi7yy9PI+qJbz302V6FPheKAytr4w/PFejTIKx6koc30ZAbDAqJEOm39+cI7E+oLTBffCkJNf9AfBSO8hXmh409wviI4EdjrJYtiEGvxyDBGJlIZPue7znHXlFBVc9Wd3utzUjCQdUaiIisaXzVQsWTqZQiTrjdYJkWVj1ybMqRH7lHsCED0q4qS0otleuQZIcku9OoO41+ndOoQ5Jd7Hax+3PG7leRZMOVj5aIk2xVFNzMgqfF9yQtZ5jQ9N9YE3LeVMtohYixBmP12sihN9rZHm2Pd1MxyPgge/Fsb7yTvtjhz3e3d7dHg53d3uJZfzmP4ybI2jG1YO9gR69igLhr4LhKwbms0zprt/+gXiPGlNYo9TS4GTqHSq/m2HFtj9NBNhAGdjR3tBcvTo+JPrb25ElvujKpIJgdVBf68wQpyYehaWldBx076NgdP93x88scPx107GK3i92fM3a/CzoO7oOOg++AjgNGEGtMEOvPhI4ZcAdBszGMAhniNQrIUUIU/Irdxxj2jpuJcA3Qa6HInb1VFHmuNXvD1awGS7bViVRzdVF6w9yC5pp6Ll3hiBdAkLUk0C15lSwEYVL4D8tlIX0ck0Cga2bJcOwgVYiZ5b+n4znNK3Dok0Kuqfeq4WPS1dc4QMH3QSdI1D+wxxmt9Yf6weyUJD4midmrL6kQFPNN//f5ulsCR2DeULo4C7a+47pA6JlzhTJCfClD+mogaAfVO6jeHffdcf9rHPcdVO9it4vdnzN2vwOqRzR0N1THhG+G6pjb32INlnpNzvU/R+w+VCIH3r2ZTj1Wz+YY3OMKuBIxVGrfaC05XSvubTZXiueXbzfpLnES7xLTxWSCiIG7yuRYNHWutPubmzcwGox12+el7NeElP7cT3WxOYKm1iQhunMaAo4msOHJUaw3+l7NRpInh7TniQele8HIZ6F8f83gq5Tpki9Zc4ZShAUyGwxeH73KD4PFEiXFI+tn970XrcgHuS5MfvvHZQmE7pBlnfq+uhvmM3C6JCKJcDW/R35G+DvsvnKbfH6mUOd/Z2WzdzRthx0IblAchMswj397f/6ETQh1+qivLAFeIalMQNycwEV8VhvWF0NokT9ojK4mU8/4sHX1hqKIjXMIzD6oMyHYZX37+i3S/Snys1cpLRI+JdCqq8e1dTJxLXI6CftzTZLjyUxtQkObvLXuiT/1fHkgFX4WfrT/QSXspaRkJOn0pjlRRF/tscuylosvyPVQJv5WU0sCtcRTs0+WuAiqvUzDVe4UoUwkeG69th68eaCXLNCjWgojRHWZB9JE5KN9YSqtrfZgPlr0EqLX5uODej+VOFLby1jIYMziRMwzdsTSqdZW/IMxch0Kg8tJhSh6MFufadPER0Sys7XAUhK2TGQCgOj5O0ZgqOBMfEQHtMcnOrRKfEh+9JZFzMfPRloy++FLnKM0M9OpfTDPtGFCGyYhB9jIfzimyLEQ2ySDzwPBAQ7n9veZIDK6kPcCrbVZ3ZPf9GvoaEjBqqdiy/3wsD9PcPEX8y9odjMHaZjwdXOFDM8s0qKzqqWsujOwrMFVfnONI3JJb4Hf5u+bdGz+1eQliYfzBso7lc9+dJa+I5P8dfLun5TxukzzK2aaiHipEXk6/wjuVV2bxK/R7vgWDHU33NSzu/RJGAXHQcR5q41A6lRPBf7FWx/jHpSj5PFFnEc/i4Swo6No8NkgnUrhWwil4I4w4wZ5pC58BKPap7SBQtETmhjMQbhbYFk+kjno+SZ3vTP3gRYAKfkDPdsqXrnQcGWUpKLP3qOqUynMSRUdXfbFu991LO3OYNETcgj2snYSgLWiqBR9pQe2q4JxuOI9ngTFplVIeCjwlKh1oT1kbFbV0U8uSiL0fW1jCvtuTN1pFL4LDnPPXvAXG1vTUD1Z0RsZZVMjyKnIvUfTvDbcv482vDSZirykmhLZGsBNLOzw5uh8hSKIqfj3EG0mm3GR3aS5IEJlVXCfZ/3t/lbiywyMU4mGKniBOH1GW39Buu4b2iV3vJk35/9Pv6aNJyeVPJsldexIr1UowULpS1/UrpS+WLlY/KKcmlK5jMk3N9ThoWrwloaRVqh9cHk1L/ToCZuETo+vlj8J6jDEPy0k5zOPCmIrYfVvJlR/hhWhe/TVuVcLFf3JO+qj9UbxS98iNCcM/4xB+ne/9wH/4UGXwfExyY/f9OpWH+YEujX8Woc+4g8S8/b2v7PQvPw= +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 Identity Attributes' (delete-identity-attributes-in-bulk)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Bulk delete Identity Attributes

+ + + + + +This deletes identity attributes for a given set of names. Attributes that are currently mapped in an Identity Profile cannot be deleted. The `system` and `standard` properties must be set to false before you can delete an identity attribute. + +## 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/delete-identity-profile.api.mdx b/docs/api/beta/delete-identity-profile.api.mdx new file mode 100644 index 000000000..b1fb0d38f --- /dev/null +++ b/docs/api/beta/delete-identity-profile.api.mdx @@ -0,0 +1,101 @@ +--- +id: delete-identity-profile +sidebar_label: Delete an Identity Profile +hide_title: true +hide_table_of_contents: true +api: eJztW1tv2zgW/iuE92HaInJ8y8V+WaRJOsggbbq5oA9psENLlM1WJjUkldQN8t/3nENKlmy3SdvBzkzhl9aRyHO/fKTI+5bOheFOanWStEatRGTCiZNEKCfd/K3RqcxEa6vl+MS2Rtet8g0Lr2zrZgsm2djIHIkAicuptMzTsYwrtjyFjbkVCdPw5qj9Xr1XZ4rZIo6FtVvM4WShklxL5didzDJmhCuMYhx+pMIIFQvmNAwEQkX2MXBijtuPMMIWmSOiBzDoo1BAwk3Z2fmv/z04en3yhvHCTbVBaYCPEX8U0oAsQC/mwIq4H7w9IQqXwCHVWabvpJowIydTB/oY0ZjGSe6m2CMmEzWSQe0o92qPvKBgy5wbPoOfBi1635JotJy7KbxS8AL+Wp4byQRe2ngqZrw1um+5eY7DrDMgGrxJtZlxB0+KAkY+bLVKEVsjZwqx6iGx6hVwBlASn/gsz5C4SPv76XDQH+yJ4WBntzfeGY/3B70B39ntD/eS/dbDDfKxuVYWwgCk6nV6+F+T1wEYKHdgrIidkyPBhuwSnHVOvmJ6/EHErvItmnrZtR/0mMVGcKCCIsZaOZAdWfE8z2RM0bv9wSK/+5qVlgRRJS8KiYYQi8jSKbFfcEaOwdx+OjrQYNI46dUGi69xyZLFMTq9V1MpTMPQabrf2e/udwfJcG8v7nU78It3dnb3OwPe4Wkf/enj4klcaGid/ksef5wYXaiEnXkDXAozk4o7bVi8n3b6nbQXjbt8NxqIfj8aDsV+tDvs74zj7v5ef4cCqsHoSXLUH9XF+VUoYWTsExYCl7kgDbo+4Y4zqcgH+laYjM+3WIHlYjynh6XoQPVCmFsZizaKl/FCgd/N47JdWWEYcAUfUubeTTULsxPigHI1BLZFnmvjkE2s8ZkTaz1eJSEoISInyQ1N5kccKxW8wTgLxJbt8xoK40ExYb0u6w5GO3uj/pAdHl0yyK5+TdUfF+FuKlSlMbvjtrLD1+TZWZZnocaF466w6+QSqphh97jwZR6evONG+XfHxmhMiNKzxP5SzHL/YrW9LAo9s55jXdySxQOIBvWNni0y/ULCMExBCOoHHDLodFZLxWEmIVMZCVDVLQgP6YsDFldhHRvrhNqIVLc8k99Wm75eUhLhuMwOdfKEpH8llYgmhkuUUJDIMUzEAL+VCSbVTBusaEiyrG80rlnvwRLtLnvJE9DX63cYlEFLGigiQOvkCbXuSkmYz8opUPZ8mq9nK/YEH+92hr1BujvgvLc/6O7tjIcp7/c7w53hELnPwKF8IuqhxY3h8xXWZW3JNLRz+RkMAm0DbE8CiBBo0omZfdwHROMpRRf08mMrNYO8UNk+uS3oNC8P37LBHqSXmhT0nE+WjKCiqwts/0WW8TE+wraNyU6EzwB8yLV1t0yso+NXB1enl/Dk/Pg/V8cX8AtprSQPNEGpEgxLEBViYarvSOKgABYBC60vxlbLXgSqL0Ahrmx9oPR/2bkFY0JspRxxF3sRuK+ZUSfNUqNnjVSivPnk2DPZFu0tNsZnUMni6QIs4vAXHk1Ep8GSL9hU8ESY5212kCQSleQZg2wEojB/DoQYTxJMXU8gLSCVBSEAXTimtKMOUvfFwpRNbyzKyWndKZgcIPnjcXIQuwKEIzXrWVhFSxAx+Adk9pZrSndZMxqZdK4cj0ELgK9zMKMx2ODHoJsEtBrKEbrLQuFR5biqYtWrJJW7116YI6fpXcwL+4S8e5tB+YlIterFrQjJZxEn+2pE3ijdFCpSwPI0OYyq3FUmPoOKnSWb3N3k7iZ3n5i7yy/Pw0otvCXo012FPlcqrJA/15ZsFfQxFD1Kl8vozwRvgiO3EFYHiPTbu8uw/sZ18acc16J/Ij7yrXx1iVf5wz8fl6vJsvUvfIECkh29BilUIpGMSO6FxGQob6r+KrdX2owlBKhaAxELXGXMdeH3CwqFWJdxu8USLaz6xbEph/pYbh7oav8gog2EDZLcIMlNN9p0o5+nG22Q5CZ3N7n7z8zdryLJSirKloCTbDGbcTP3kRbeo7acwQBWfjNgVcqRq5bRChJjFcZqNZFDa9zrjrvpXiwGCR8ku/1h2ot3e3xnr7vXHQ96e616r79e5HGVZM2cqvnb+5FMDCDuFnBcoSC4rNM6aW7/FfThAMsafQkqcTPYHEx6s8COg1Xs+EY70A235KPwfWt1e/Hq/NR/mPDk0W66MPiNwpRfMtyUO4KUGMNgaWndBjpuoOOm/Wzaz0/TfjbQcZO7m9z9Z+buN0HHwWPQcfAN0HHAEGKlCLH+SuiYAO5AaJaCU0CHuADzKoSNOagCv8LuY0h7x81EuAroNVBkb7iKIi+1Zq+5mpdgyTZ2ItXCXFjeYOwMx5pyrMQzVRMokYpB1ZKAbjGq8GQAYFI8JZDJmaQ8RoWArplHB6kDrXzOlPFWcZEqzgqQkIpCpnHvVUOMSQgnkSL8Awq0DzqBQv0n7nEGb/3QfjA7R41PUWN2/CkWAnO+2v/dWXdK4ASEN1guLryvv3BcwO+ZcwXLCPEp9+WrgqAbqL6B6pt2v2n3P0e730D1Te5ucvefmbvfANUDGvoyVIcBT4bqMLbdYRWWeoXB9X9H7JQqQQIKb6ZjwurJAoODEayAh9LNiQkeJD70oXxQuClm5teO/d/gcfmZgFhcXLPAOoTn/ket7eVpdvt+zSWAhxYKgWjTK1qYDCZPncvtaHv7HvwPfn9o81y2y9lK37VjPdseg9HX1DM8vupzFwfg3YewdGmTx4zEpPAVlIh7/5GNMPzBj3Ri4auU8UQ6BsYcVjXMk9likEAhQOkxniKG1ckvlka3KSBX9AO9rkz28OO6eEJf0GWd+b7KDcYzkHRJRVThZhEzFwjlPfeVyFm0J/yI0FthdobDeuyl4AbWGf5czbPf3l0+ZxMEsFRACovYWUhccUAKvoUQoQJ5UJ4xwUnUs4wuJlMS/KBxigcTkqUZKMzeqwsh2HV5R+QNdI5zKPVkUpwkqLrgrJtnpXcScSsybKrthSUx8CAptsFC27wx7zk1UFppSOWPrcPT9nsVsSOJdU0iEMAxQUVaOLLrvNSL1/T6XiH+VVKLPLWIqNnnS1J4017H/lR4DFUBSfDMkrW+m7mnF9Xo4bIMniDVZRnQEkGO5tmruPTad8vRoBchvaYc79W7qYTu3JzGfC1jFpprlrATFk+1tuLfjGHoYBpcTwrIou8W6w6ZRpQRUa9TEynyLCMZAdYk+U4hMZQPJj7GXk9QR/tdF0rJ38mzkPO/w0o8Yb83dKbH19CScWSiY/vdMiPDCBlGvgbYIL/veBhYkNuoA9UBHwCHC/9TJQiC1uqep7W2qhP5bZqDrSEGUYmKzUf+j9GiwIVfjF7g6GoMlGGE6tVpNLwKF2hh22sYq9xkWLbgqryZhm67ZDcvb/WpFDvw301f1PhgsRdzprL5n12lv1BJ/j519y+qeJtK8zNWmgCeMdyIbVhl1IP8ZcBrq3uDuHk9FfAvvKVcJZzOy1uciGLqhPKMO4xqfzV3KgXtKuSCO8R+WxhZekaZGO7/wdqRCE3ofqkBkTmsA2UG9Gjfu+TMKWE8sES/4t+2CKcwNIQkrFJFm72DhZ6KwS24yMPzv/Dugw6rvQvwzFu613xUOhtA12xWKLyHC2IXM8YhpB6JiETauPCFC9Z8qrrRqgn6VbPKLMZQQxXoIqswM3uWhpuTNcc/wgv8bsNuNZgevRguKi8UORcZRSaOa8L2x2hDtEVTkeV0uRHEgkVjjcPrk8sVikBMhU8k2ky2wyS7jWOBCC6PfPj02912J6LlAjzPtXWwMG6IT9d811xSX47E+8VW/eaC+2MX3EOfxAXOdo5bfWj9wi+4/IL3euWKO8bNCkm89w5rqCk4Dufc36NlcQn4gI//KARuP1zfLFZ3tCqGwMLfsM5OodQt336ve/LZedD0OX3j+sKd+LXqlPubar7Y2mjBz48Cd0TWKfJwA9P8HhaJ6Uf6Xa4ajZXvQI2Ng6Pj0+PL45YHZeswSfgBVoGq+z8PpwB9 +sidebar_class_name: "delete api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Delete an Identity Profile

+ + + + + +This deletes an Identity Profile based on ID. + +On success, this endpoint will return a reference to the bulk delete task result. + +A token with ORG_ADMIN authority is required to call this API. + +The following rights are required to access this endpoint: idn:identity-profile:delete + +## Request + +

Path Parameters

+ +Accepted - Returns a TaskResult object referencing the bulk delete job created. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/delete-identity-profiles.api.mdx b/docs/api/beta/delete-identity-profiles.api.mdx new file mode 100644 index 000000000..aaad92aa9 --- /dev/null +++ b/docs/api/beta/delete-identity-profiles.api.mdx @@ -0,0 +1,97 @@ +--- +id: delete-identity-profiles +sidebar_label: Delete Identity Profiles +hide_title: true +hide_table_of_contents: true +api: eJztW21TGzkS/isq34dNUozxGxj7y5V5yRZbZOHAVD4AdZFnZFvJWPJJGohD8d+vu6UZz9gEWJK6293yblUKa6RWvz7drdHc1/RcGO6kVsdJrV9LRCqcOE6EctItzowey1TY2lbN8Ymt9a9q+SNWPLvZglU2NnKOVIDGcCot84Qsm2Wpk/NUsLWF7FZyxlkqrWN6zGw2n6dSJOz40Nav1bU6VTAWx8LaLeaQpFDJXEvl2J1MU2aEy4wCAkaMhREqFsxpmCjYKEu/hP2Z4/YLzLDABREdwKQvQgEJN2Wn57/+e3D44fh3xjM31Qa5g32M+E8mDXAC9GIOW9Hug7NjojCEHcY6TfWdVBNm5GTqLONGVJZx4rvKdp/JRPVlUEM092roe0ZBw7heWLevk0Wtf7+i01XtVYQMK9kIltYDJeSk1ncmE1u1WCsHy5EqRyXHZO/tzxZJ39dsPBUzvr7nSbDM2t5gIRTS744busVcwAJuDF/AT+nEzCK9MG6dAV3VHrZq4iufgTOgI7XiXnOvsbfbHbV4uyMajWZ31G5095Ldxqix2+sBnWem7KHrAWNIr7bisvugnkOv2Qf4D3Vi51pZQXy1Gq11cQdgs7kD+0XsnHwLzMqG4D/n5D5Mjz6L2BXuhtZf9bbPesRiIzhQQbW8Uu8Dle9FXlphYunsYJhHtl8aw5OA3+BoEOJOetFlsm6YtQDGoPGOOpbC1Ep2q43HYJHmXrOT9LrduNVswF+8sbO71+jwBh+30cqKz8QLd6GpZfr7PP4yMTpTCTv1ShgKM5OKO21YvDdutBvjVjRq8t2oI9rtqNcTe9Fur70zipt73fZOggxUNnoRH+WhMju/CiWMjD2OjIEFF7hB8yfccSYV2UHfCpPyxRbLLLjQaEGDOetA9UKYWxlDtAB7Kc8U2N48z9ulFYbBrmBDApS7qWZhdUI7IF8VhhFGtXG4TaxxzIlHLQ6yzLhDxAdvjZwkM1Q3P+QIoPAEfS0QW9XPB63YIJuwVpM1O/2dbr/dYweHQwYR1i6J+uMs3E2FKiRmd9wWeniKn51VfpZiXDjuskdQCqipbIYIdeGzD4x85Eb5Z0fGaAyI3LK0/VDM5v7Bei5c5h9m/Y5ldvMtEKFyJFtG+4WEaRiCSQCxTqOxDhcHkDUhKRIDBXaBe0gPEOXkgNlNqlueyj+GT09DSiIcl+mBTl4Q9O+lEtHEcIkcCmI5hoXo4LcywaCaacilnmSOcTSvXlEcaKLeZPs8AXm9fAdBGNSkARABWscvwLpLJWE9y5cA7Pkwf3xb0RV8tNvotTrj3Q7nrb1Os7sz6o15u93o7UDSgt1nYFA+EWXXyhNjdescW1INVYb8BgqB1AG6JwZEcLTVXPodGxCNl4AuyOXnFmIGfgHZvrotyDb7B2es04XwUpOMxvlkRQkquryAEZWlKR/hEJYZGOxE+BRqIvko7uaBdXj0fnB5MoSR86N/XR5dwF9Iay14IBFKlaBbAqvgC1N9RxwHARAELGS+GNMtexeovgOBuLLlidL/sgsLygTfGnMsB9m7sPsjK8qk2djoWSWUKG6+OvZG1kV9i41wDJAsnrIRR/TXHqne+YoiOgmafMemgifCvK2zQZJIFJKnDKIxwzqZL4AQ40mCoesJjDMIZUFVgM4cU9pRBinbYqnKqjWWcHJSNgoGB3D+vJ8MYpcBcyRmOQoLbwksBvsAz15zVe6GJaWRShfK8RikgKp6AWo0BhP8CGSTUEQHOEJzWQAelc8rEKuMkgR3Hzwzh07Ts5hn9gVxd5YC/EQkWvHgVoTgo8rWoxFZIzdTQKTQYtDiMKswVx74DBA7TTaxu4ndTey+MHZXH56Hbi08pdKnuV76XKrQuH8rtW1F6WPIe5TOu/tvVN4EQ25hWR1KpN8+DsOxALbrX+fYO//E+sin8vU2r7CHHx/lHWWe+pe2QAZJj16CMSCRSPrE95JjUpRXVXt9t/fajCQ4qHqkRMywy1jozB9jZAprXcbtFku0sOoXx6Yc8DE/09DFsUZE5xqbSnJTSW6y0SYb/X2y0aaS3MTuJnb/mrH7ZCVZcEXREuokm81m3Cy8p4XnKC1nMIHl7w1YEXJkqtVqBYmxosaqVSuH2qjVHDXH3Vh0Et5Jdtu9cSvebfGdbrPbHHVa3Vo5118t47gIsmpMlezt7UgqhiLuFuq4TIFzWad1Uj3+y+jlAcIavaDK62bQOaj0pqgdW7312nGoNfvA1SKvkGylhlRLHSGmwdwZzjX5XIkv6SaAi4oBVEngC10Jz3QjZvB8N5UzScGLUgBds4gGYwei+EDJnazYRao4zYBDQoJUY9WswbEkCCnGWPMBBapgJ4DOP7E6DSb6oUqenaPEJygxO/oaC4GBXlTuO4+d7x4D8wYx4sIb+DsHvb7b4QocABoCj1lF3bmpzzf1+SbHb3L83yPHb+rzTexuYvevGbt/oD4P1dD363OY8OL6HObWG6yopd6jc/3Py3QKlcABuTfTcZwZOm7Oa3BQghUwKN2CNsErIAfelQdQtGNkPnWP7ObhBrkEX0SJ5toSCnFcWNteXWS38fpQVFxB8y2EFy4zKSyZOje3/e3te7A52PqhzueynpNR+q4e69n2CBT9CIbhZQMfrzgBL9CFHqVOVjISA8GjJhH3NiO9oMuD7eh8+UnKeH8InWGhM7ybg2S2GARNcEoaxjsf0JH8Yml2nZxwTT6Q69KkDz8uiyf0HVkeU9+Tu8F8BpyuiIgi3Cz95ALLd7/7mrcsUxK2fK21zU5xWovtC26gt/BvQd789nH4lk2waCXQyCzWy0JilwFhdwYuQqA4yN8I4CLKU0ZnkykxPqi8c8EgZOMUBGbX6kIIdpXf1/sdssU5wDupFBcJQhRcdfMmt04ibkWKibS+1CQ6HgTCNmhom1fWvaWkSd2FVP6SEYzWr1XEDiVimcTkj3OCiNQssqt5LhcvyfVaJv6RU4s8tYio2bcrXHjVXsX+Dk8MSIAkeGpJW6/e3NOLSvSwFYMRpLrKA2oi8FF9UxbnVns1HxV6EdKr8nGtPk4lZOTqMubxi1lIqGnCjlk81dqKfzKGroNhcDXJIIpezdYdbhpRREStRomlyG8ZyQjqS+LvBAJDeWfiI8zvVN5oqPxU4kPyE1kWYv4TdN8J+1SRmYavIA3jzETH9tU844YRbhh5DLCBf5/l0LHwSh3IQDjgHeBgaX9CgsBoCfc8rUdRnchv0xpMDTGwSlTsvO9/9JcAF/5i9ABnF3MAhrE8L94d4n3qQAtTXUVZ+cHCqgbX+U01ZNgVvXl+i4MtzLp/NnlR4sHy/OVUpYufjdLfQZI/D+7+nxBvgzR/R6QJBTOeY54vP584+ulfGaA/k1wrXxtgFO2HgnD9wBFPxKcC/oWnBAZU/PP8Yj+WSWVC85Q7DBv/AclUCjqqmAvusLjcQtfVMwr1cB0cGlIiNKFPDgzohENzKVOgR4fp+c6cItJXrug4+Ntm/nY9fuMyhdZX1NlH6B5VDHbHzhGvg8Czzzq0kBdg+jP6+uYw9yao6mazTOGXIcB2NmMcfPYZl0ukjTOPjNBIquIjB021ZbEqhwn0ZRSBPjIRZmZPx+EifcmzntkLHMuGI3BQPVrRf59QWwpyLlJyfZxX7Queow3uHE1FOqe77sAWdKKlHT4cD9coAjFlQa5Y1LWZbIdFdhvnAhHsv7z7tOvNeiOifgTGsZODbrvCPn30sf5B1tr3D8Xp/+bTrNd9mhWSM3ZV23M8U0SLZL7L8701NuUrvTWsK3fXgCJT7MZh6v09nkBhu/mAw4BbeLxxdbPsJPEXbOFPoqgd/yLwBCS8+oiGCyo7wlHH+jsdbHD9Cn+69eTc8oHB2Sme89VG4SO0mT88MfwOBvHffu0a/ocfeu4DBibR+H0tP4qEOZ5uXt89Vt6EP1DMh4f/AhlQwgo= +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +The following rights are required to access this endpoint: idn:identity-profile:delete + +## Request + +

Body

arrayrequired
+ +Identity Profile bulk delete request body. + +
  • Array [
    • + +string + +
  • ]
+ +Accepted - Returns a TaskResult object referencing the bulk delete job created. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/delete-identity.api.mdx b/docs/api/beta/delete-identity.api.mdx new file mode 100644 index 000000000..d15af8778 --- /dev/null +++ b/docs/api/beta/delete-identity.api.mdx @@ -0,0 +1,95 @@ +--- +id: delete-identity +sidebar_label: Deletes an identity. +hide_title: true +hide_table_of_contents: true +api: eJztW1tT20oS/itT2oeTpLDxRWDsly0HSIpTJGG5VB4ItRlLI3sSeUY7IwFeiv++3T262iYQkrPnnJR5QZZmevreX49Gd55OhOGp1Ooo9EZeKGKRiqNQqFSmC2/LS/nUeqNLL78lhfWutmCYDYxMcBpMOp8JNj45YkakmVGW2SwIhLVRFsMtm2hlBZMRS2GYEf/JhE1FyGS+BrvhlrllwzYsaEWQGVx7dHnnXVhh9rVKxW06ztIZMiJDNSrmjtw87+oeeEq44XP4ZSxNlchZwmHSlqfgAfySIdIPZmLOvdGdly4SvGtTI9XUu9/ykDlpBOghNZlYlrJQCjtCMuKWz5MY54uovxcN/b4/EEN/Z7c32ZlM9vyez3d2+8NBuOchc4UeLC7c6/j4r0n+vWYBSqpS1mJShTLgqbB1pZGmarqdZCk+NqBcy1Q1PdVsInJjoKJVTsRx0EZJ/U5nlYP9WOL0Q2O0AR5OSwIN0+FiUl3zWIZtdpSyOV+U7MI4Tjwxm4hARrJuZ5g35+Yr3AIxEqNTEaAfcBWygCulU+S65gi5OMgnT5IYFwA+t79YZPZu1Y568gUowkSgDT5NrgpP56AtPhWrBl+2L1cLxsNQ4k8eO23egrgq0mZOazPtNDFL0wR4jsm9szhtuEPpJitCodyS9KdvlDBILdJxrG+AG6SkMwOmRfNwa3Ugac0DkXIZ2xr73Bi+WOE+lmAaoIhc5eYmeqxGy8J6hp7KKsBlKub2cTXWyJzTwEfVWU1gOJLdyHS2vHiltv3xu5Px0dv3//7w8f3hKSqhzDePiV7zt6CSO52hoxbGmPFc63YmEwbTnix4QeLQ8fyE8Y/rRoaFK1XsanYzk0FTQ+grhR5FM+t0+t1O3xfDQdQZ+tzvDHeD7kTs9KPBTrQ7GXZRgy7tPcYMjvphdt5ym2rV3ut0wjAa7vodjgykT/IU8o4fZaD0n+ICnQj+gAmZNgLzsPCr+9p8Zzdvsrvb4b1+L+rsTHzR8fe6vYAPB/6k3+l2RSeqaskagQt5H+RlHTfj1VBv8lXmryqzSFcWvplFHkoiK3G8HHn1wLv849VylevF73RXK9KF4lD1tZH/hey5UpHKwlcMcslmJngozBaDVJdXrt8/noM/fRUKx4vbBGv8T6wwAgvmKvNjlpuOufsTNBCy48bXnRcZpIrqJIjAWCIcEd8Vx6UL+Z3+6mpvtJnIEDxkTeXOAEWxhc4YB5WZTCnkhNstFmph1W8pZMdrKBQELDDwKHUKFbYSLVX6EzUVkh/u6/AJWeGNVKI1NVyiIKQyKMmhQORwLUOUYK4N6hZJFumDxrUbugWo0+6y1zwEtTgAs58Lg9FoePAVaB09IWlfKAnzWTEFklJZTtcsKwaCT3Y7w54f7fqc9/b87mBnMox4v98Z7gyHuHruH49XuLcCIh2KW6wBdVAwGMEtegowULjTE+sZ0XiC/hHUu7GlmIU/Iy7aYpy93j9h/oDFXE0zus+nS0pQrYszTA5ZHPMJ3kJgDZI7wh+MnEq1jhWhsjmC/YPDN+OL43O4c3r4r4vDM7hCWisdyFgVGFRTRpzpG+I4F4CAM4AwBJxt9iqn+goE4srWB+aZ1S6gRZmDb0Uc4B3MyFdfM6NOmkVGzxtYuQCRL2RbtLcAC1oEzCmUtQm3MEE7bP5qDLGXpK3jXJOv8iT2ss3GFSKFDAFECXADqASoWoH7KIOIdxBLQ1cAuFMGommLSpVNa1Ql6bhuFAwO4PxxPxkHaQbMkZj1KCy9JWex6BHCXHNN7s6X25yFSnkAUgCeBSitjQENU8cjU1t2OhJ1P+eqGFf0JV690lI/884xc5BqehbwzD4h7k5iSD8tEq18cC3y4KNU6bKRqDcOeUaiPOpipRhVmqsIfAYdUhxuYncTu5vYfWLsLj88zbc16GnJFUVLjpNsNp9zs3Celj+nTpnBgGqDqgw5MtUyWkFirMRYXhM5eJNed9KNBoHwQ+6Hu/1h1At2e3xn0B10J35v4NVr/WUVx2WQNWOqZm9nR1IxgLhrwHGZAucCkK3Dhreieo2IMK1h6ilxM+i8XaBswo5rt55SkA0IA3Y0D+z6XJweI31YmshXjRoGLanObf4gpEQfBk1Lm26g4wY6bsrPpvz8MuVnAx03sbuJ3b9n7H4XdPQfg47+d0BHnyHEihBi/ZnQMQTcgdAsAqOADEEG6lUIGxMQBa7y3cc87FNupiItgV4DRfaGqyjyXGv2Dl+i5WDJNnYiVaUuTG8wdo5jTTEWBnA2hRSpGGQtqd0bEjkXiEnx1WIs55LiGAUCumbRGkcpSOViZvk1J/wO4gw4pKQQa9x71eBjEt/IRQj/gALtg04hUf8x7xufvR/MTlHiY5SYHd4GQmDMl/u/O+te3h4B8wbTxZmz9QNvcd2eOVfQRojbxKWvEoJuoPoGqm/K/abc/xrlfgPVN7G7id2/Z+x+B1TP0dDDUB0GPBmqw9h2h5VY6g13p7v+v4idQiXngNyb6YCwelhhcMIV4ErVmU1MI3jaceRty/Ks5vadDO89PFSJoNDxk5kYBuEZNjva3r4DM4F57ts8ke3inI3SN+1Az7cnoJs1aQcPVrkQwwF09NMt0CbFGom+6xIdEXdqJlHQS0HddLDgm5SLU0kLaD6YI7OF58hyP6LbwGICTcRvlka3yW9W5AO5Lkx8/+OyOEIPyLJOfd9cDcYz4HRJRBThqjoDe4aI262+chK2qiK4199bWewDDuux14IbaAfc8ZcXv388f8mmiDMpzjOLEFdIbAwgUk7ARSiPjYujIDiJSovR2dSdxRo3Dttg3LAoBoHZJ3UmBLssTim9hwR/ChmZVIqTBCUBnHX1orBOKK5FjLWvXWkSHU+Gahs0tM0b815SnaOGoHYqs/1JtdiBxPRTnnHMRaT+jl0mhVy8JtdzmfhHQa3lqLWImn25xIVT7WXgztQGELxIgseWtPXsxR29Vo0edk9wB6ku84CayPloHpEKCqs9m48GvRbSa/LxSX2k03vNaczlLGahBsYhO2LBTGsr/skYug6GweU0gyh6Nlt0ZLBFEdHqdWostdySLdkCSEj8HUNgKOdMfIIlmRCJdpsjFJKfybIQ85/pkPLnhsx0+xIqJ44MdWCfzTMu2MIFWy4H2Jx/V5jQsSC2UQbKA84B9iv7UybIGa3lPUdrbVYn8ts0B0tDAKwSFZuM3I9RleDyK0YPcHQ5BtIwIury0BgePM5pYXVqKKvYC1jW4Cq/sYaiuKQ3x2/5RhML5V9NXpR4XG2ZfFDx4mdn6QcyyV8n7/5JGW+TaX7FTJNjXHQ3Wnbp1DQ6+escr61u4eEe80xY+iiJYpXgNDQr1TcIdUJJzFP0aorqYCYFNf+J4Clivy30LD2nSIQ+HcMfWjwiNDUwBsLWAiblExkDPdqeLlbmFDAOWKJd8bfN8sMSGlwSmknRZh+hH1MBmAV7MTymC8++6LwpOwPLnKBh2UFhbABd83mm8CQ4sJ3NGU/ZYx4RShtkLnFBa6ZEoQtN0K+cVUQxuhqK0KauxMzthwj3laFlrRn+kbXA7jbfVAbVoxXzM+KVIKcidh+mwLgmbH+MNnhbaybiBLtByLoAwERthXdH5ysUgZjK32RoM93OJ9ltHAtEsD1y7tNvd9udFrULcD/RNoX+tcE+tlu0iV74e3vZB++qvfSf+3VcXk2wDdhOcN8KecxcW+Lav0uvav9gwkiG+MHeDMTAZ3d3uK2BDdE93oblsGe+vKp6HeoRQc14Dd1lBIG//ClcXboXp/lHcy/LmHIfyK3ltNiHU4uqBffg8qvAzh1Yhf4WmKWtFWLEPXCbL7UpK68nsGsqG+KDw+PD80PPgZB1NTi/ALkhy/wPO7/qRg== +sidebar_class_name: "delete api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Deletes an identity.

+ + + + + +The API returns successful response if the requested identity was deleted. + +## 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 is invalid. It may indicate that the specified identity is marked as protected and cannot be deleted. + +
Schema
    associationDetails object[]
    + +list of all the resource associations for the identity + +
  • Array [
    • entities object[]
    + +the specific resource this identity has ownership on + +
  • Array [
    • identityEntity 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/delete-mfa-config.api.mdx b/docs/api/beta/delete-mfa-config.api.mdx new file mode 100644 index 000000000..eb09b7a23 --- /dev/null +++ b/docs/api/beta/delete-mfa-config.api.mdx @@ -0,0 +1,84 @@ +--- +id: delete-mfa-config +sidebar_label: Delete MFA method configuration +hide_title: true +hide_table_of_contents: true +api: eJztW21T27gW/isa3w+0HexAoOWSL3dSoDvswsLyMp0OZW4VW0602JIr2dCU4b/vOUeyY5NQWrZzb7eTfqCJJR2d9/McRb4NdCEML6VW+0kwCBKRiVIcvhnuaJXKcbAalHxsg8FFAM+Ye1i5+cHlKky3sZEFfR0EZxNp2fB4nxmR62thWTkRLG6vYak29NQWIpapFAlDurkoJzqJ3qshK/WVUOxGlhN2dPLLf4e7h/u/M17BuJHllMEGRnyspIGVpWYxzzKg57aNgFsr4gonAse3wbkVBlguxadyCBRQCpmoQZ7ysMPVIOeKj0VweQciFdxw4EcYSzQkClZwWL0aKBiAb45b3CyeiJwHg9ugnBY4YksjFSpNfOJ5keEjfVXy8FoYmU6Du9WgZj4YlKYS8woUDDdhOiUttXTDcAxkM0KV2ZTZqii0KUELbpyWWcaNYCutLVcYVwlbSSod3ojRShSghEbYQisrLHLeX1vD/7p84L5duwFDXLX5ASFjVK0qcTkvikzGNLX3p0Uat/Pa0aM/RVzCwsKg05XScQDmOHQaXaBIVWUZH6EmF+nrMOVt+b+keKGQTHuPkdaZ4Cq4T3Q/bcmJDueXRjQz5VUGIqc8s6K1HXIHu0y0Lb9dDDQtuCowy5CAdwHD9o8ZTxIwl207BGjvWibCRB1x/aco1jmKy+MYlv0mpk/lJjaiZFdiShGL8QeWJgurMUWgsKXFCPwyVx9v1vsb7zb+yIYvzz/q+F2RnG+YvavP5rf+7ub2FlkGVgHpcjosgb9RVYpvZ/mIPvDMRUk7gnhNlOTIwU9RgH2/5e/6htXbPy4MeLPMgjtgGebTE/C/I3AznyvvWpM7bt3xxZYrOlGczwQ3NzdR24gdGwbJC/r3Llior4Y1ZG5zUUTvZBJWsT1jQA0hOxFlZRRkD+nU5C3KRjqhHCvVNc/k94zyRJTA4o5OFpq3y+wbqUQ4Nlwih4JYjmGhNwsaMNeQ6BzJ2tI0r2sw0ES0zl7zBOR18u14YdCGhsdXQGt/Yd7pMnSuJKxn9RLwmaaQLdhWbAk+erW23d9MX21y3v/35vrWy9F2yjc21rZfbm/j7pCsLZQc29qbG8Onc1v/IhT4TcwyDbVOfgaFGMGtr6S0ObpEKXL7uA2IxlfoH4PIzW3E9PwyrKWrjLPXO8dsc4tlXI0res7H95SgwvPTucAFyR3hIyPHUi0snarKsVLv7r0Znh+cwZOTvT/O907hE9KaAx1DBd6aoFsCq+ALE4jpcibADbeQzTJQB2Rw9sJTfQECcWXbE6X7ZqcWlMl8oocVfvcFK9qkWWp03gml2AEP9kxGIlplI3yW8zKesBG3sABMiNNfDCHKizI88Jp8wSaCQ+p5HrFhkkiX1xhEIxCF9VMghEUBQ9cRSCsIZUGISVdQOzSkadG1xUyV99NoncgO2kbB4ADOH/eTYVxWwByJ2Y7Cxls8i94+wLPTXJe7s5bSSKVTVfIYi00GQCfWAHliyEwgm4SS49MRmstC4lH1vCZjtfMzpbtDx8xuqWks5pX9irg7ziD9hCRaM3AtfPBR5fNFAq1Rm8lnJF9JaLGf1ZirDnwG4DdLlrG7jN1l7H5l7N4fPPF9jB8l6LM+D33OlW8fsXjOQR9D3qN03WN+dv2OM+QqonAPkX59e+abU2wJPhXYxX1HfORK+Rzzw8Ye7vkI4UdjrI4tkEHSo++0IROJZEB8zzgmRTlVbczv9kabkQQHVQsgImRNw6a6oh7TVEohJ9yuskQLq1ZKNuGQHx1mdRmQWqckLLRU5RJJLpHkshotq9HPU42WSHIZu8vY/WfG7heRZMMVRYvHSbbKc26mztP8OB2KM5jA6hN11oQcmeo+WkFirMFYQRc5BKP++mg93YrFZsI3k1cb22k/ftXnL7fWt9ZHm/2toF3rL2Zx3ARZN6Za9nZ2bB8zVwqcy5ZaJ93jP1CvESmmNUw9DW4GneNPBw127G/PY8czrdkhV9MaIdkOhlQzHWFOg7k5zm1OkmECZ2PIi4pBqpLAF7qSzAVQMeA0LJO5pOBFKYCumYbDtMQTcwqU2smaXaSKswo4pEyQaUTNGhxLgpAiRcwHFAjBjiE7f89fM5yJ/haSZyco8QFKzPY+xUJgoDfI/eWi8919YN5gjjh1Bn7goNd1O1yBA0BD4HJWgzuX+HyJz5c1flnjf44av8Tny9hdxu4/M3a/AZ97NPQwPocJX43PYW60xhos9YbuevyvYTqFiueA3JvpmC7+JDMMTrjCXy5wV7YwjeAtpUHQy1Peu3XDd71m1CF/x1NlMpg4KcvCDnq9WzAVmOgu4oWM6tsFSt/gNYTeCPSzIPXgHQEXZjiBLn25DSJSrpHovy7ZEXGnan95JrCgcjoW/iLl+h7HVFeQ3ojMKgNf975Ej4HFAhqJFUuzI/KdOflArnOT3f19WRyhB2RZpL4v7gbzGXB6T0QU4XJ2ke0UUbfbfe4626ySYKfWn9vsCKf12WvBDbQE7seLZ7++PXvOxog1KdYrizBXSGwOIFqOwUUolw3rg3xcROXF6Go8IcaHnZ9KMHZYmoHA7L06FYJdtK/XnEBWJpUOW3eItLp8VlsnEdciw/oXzTSJjicT1QMN9Xhn3XN3jwebAqngY05Po/cqZLsSU5DEmo1zvIjU47GLopaLt+R6KhP/qqmFjlpI1Ozze1w41V7E7upNDAGMJHhmSVtP3tzRC1v0sIOCJ0j1Pg+oCc9H9weuuLbak/no0AuRXpeP9+rtREIh7S6r79VZqINZwvZZPNHaiv8whq6DYXAxriCKnszWDW4aUkSE/bUWS6HbMpQhwELi7wACQzln4iMsy4RKNAA2lbiQ/ECWhZj/QBcpP3RkpscXUD1xZqJj+2SeccMQNwxdDrCef1ec0LEgtlEGygPOAXZm9qdM4Blt5T1Ha2FWJ/I9WoOlIQZWiYotBu7LYJbg/CdGAzi7mQNpGFF185MfXsb1tLBCdZRVnwfc1+A8v5mGwnhPb47f5jwKi+WPJi9KPJwdmxypbPq9s/QDmeTHybv/p4y3zDQ/Y6bxOBfdjbb1DUHbyV97vDZ/jIfnzBMBf2GUYpUgNTQs7tUCRDFtQkXGS/Rqiup4IgUdABSCl4j9VtGzdE6RCL06hj+0eURobGAOhK0FTMpHMgN6dERd78wpYBywRLvid1tRF0LvL0ygoRQRews9mYrBLNiP4SULGPtT+8bsFCxzjIZlu7WxAXTleaXw2jKwXeWMg0s94hGJtHHlEhe0Z0rUutAE/ZpVdRSjq6EIEXUmJrdHKZ4tQ9vaMvwje4HdrT9YBtWjFf0rFDNBTkRGnonzurD9MdrgbeFEZAV2hJB1AYCJ1g6H+2dzFIGYsiAXdN7ajHt+ke3hXCCC7ZFzn41oPVoLqV2A54W2JfSwHfaxqWq/JtB5W+K+O97OjtZ/hHdkfDnCPqJX4OEXClm5vsb1kBd4ex1mDppXXXwbeVlfV78Ibm/xhAT7qjt8/LES2H5fXM5aJmo1wVr+trt/ZeJBzTw78Uw/n7vF//3fg3lAC/VBoZrOzggC+HhFl/C9NqAJBzXQ+Q+J6AbdCVFr2dxvKNjWNV377t7B3tle4FDSIpDgP4BGIQ3+BT8YykI= +sidebar_class_name: "delete api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 MFA method configuration' (delete-mfa-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Delete MFA method configuration

+ + + + + +This API removes the configuration for the specified MFA method. +A token with ORG_ADMIN authority is required to call this API. + +## Request + +

Path Parameters

+ +MFA configuration of an MFA method. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/delete-native-change-detection-config.api.mdx b/docs/api/beta/delete-native-change-detection-config.api.mdx new file mode 100644 index 000000000..948299fa8 --- /dev/null +++ b/docs/api/beta/delete-native-change-detection-config.api.mdx @@ -0,0 +1,96 @@ +--- +id: delete-native-change-detection-config +sidebar_label: Delete Native Change Detection Configuration +hide_title: true +hide_table_of_contents: true +api: eJztW1tzEzkW/isq78MAlbZjxyEkL1smCVOZCpfNpXgI1CJ3y7aYttQjqQOeVP77fkdSt912IMBQOwPVL0lfjo7OXd+R1TcdXQjDndTqJOscdDKRCyde4MG1OJxxNRVHuE/p/aFWEzntbHUcn9rOwVXnXJcmFbbzdgvDbGpkQWRgcuSZWOZmginPiqWeF8sqZiz13MowNZto46mtZ8lsIVI5kSJj44V/PgUPxU6Oum/UiDn9O24+SDdjo1cnWwxjX579+t/R0fOTF4yXbqaNdAsmLTPij1IasHGapTzPwQtPMagLNaxISyKEKjedSysMFHTioxuBA6knM3UQ5LEHZZFxJzpvb6FrwQ2fQw9j/UhJGhccY7Y6Ci9wJzNcV3N3DpwpBaZLZ2LOOwc3HbcoiMo6I9W0c7tuvYulHTwj8ZHPi5xGDNL9/pPtJzu7WX+/z5883u7vZoMnw93d8ZAPdgb7HRLPCFtoZeEXTDXYHtK/5gQvNFnfCeVYwqTKZMorb5HQwjr2gVtmyxSq20mZs3Hp6LURZFS1HA6zjmmQK42ClaWKTIIEXdJtuL29KcFhLmn4sTHwXcLOagaThhRjnXk3SnXNc5mR0+LMxJIXRU6ig2XvvSW+N5tG1uP3CDgMLAwFupPBLohDLvNDnYlNh6z745lUIpkaLklC4UVOMZCB47XMMILNtfGhDZZMBxU8XbfhPVii22dPeQZ9g36HURmYyRme/g5elIT3CXSpJMazagiipM6fO6YVe4KPH2/vD4aTx0POES/9vd3x/oTv7Gzv7+7v0+xz+JlPg2ni3NwYvtiY+lehhJEpyzXSSf4JgxjBbUxgPzmGSCfm9n4feB5fYH/Kh0BbqxnlZZSuW4yzp4ev2HCP5agxpX/Op2tGUMnlOSVomed8TI8oKaF5YPzSyKlUd4kiVDmnYnB0/Gx0eXqBJ2fH/7k8PscV8doofSNVZRRERSzM9AcvcVTA5xWqY+pE1mWPItdHUIgru0oow51dWBgTsTXhZe4wIs5+x4hV1mxi9LyRSmmobeyB7IruFrIWz+bcpTM25hYDdEjdRyPkfOGS02jJR2wmeCbMwy4bZZkkJXnOkI1givELSn+eZcvcn5RIZeGLs0bRUNrJVDR9sTRl0xtIAuk8xemqUyg5IPn9cTJKXQnhvJqrWVhHSxSxqnhZtFxTuov1KrhQjmPJouVjATMaAwv7giidrQuhJNvPuaro6op1e7tUy5e750GYI6f9u5SX9gvy7lWO8pN41eoX1yImn6U6HKqR90blpliR8JLU9oMjVe2uKvEZFts8a3O3zd02d78wd9dfnkXUE9966NPfhD6XKiJUWjw3oE+NsCqiAI+DIz3SjRDpt9cXEQeDXnwsCGl+R3wUlvIN4Ue1P8LzMcGP2lkNX5CA3o4R4KMSiezAy72U2BsqmGpnc7Zn2owlAlTdARFRNQ1b6JJxmMyUSpEk3G6xTAurfnFsxlEfuUewoQLSrCpLCi2Va5FkiyTb1ahdjX6e1ahFkm3utrn7Y+buZ5FkLZXPloiTbDmfc7MIkRbfk7acgaDef2N1ynlXraMVYsZqjNVpIofOeNAf9yd7qRhmfJg93tmfDNLHA76719/rj4eDvc7qWn+1zOM6yZo5teLv4MewzSnMNXBcqRBc1mmdNbf/YF4jJlTWqPTUuBk2h0nfLrHjnXucDrqBMbCj+cT24uXZKfHH1J492S1su1LSetOBnDsPKSmGYWlpXQsdW+jYLj/t8vPTLD8tdGxzt83dHzN3vwo6Du+DjsOvgI5DRhBrQhDr74SOGXAHQbMJnAId0hLmVQQbC6iCq+bxAsfNVLga6DVQ5GB/E0VeaM2ec7WowJJt7ESqpbmovIF2TrSmogUBjycXULUk0C1FlZwLwqSIH5bLufR5TAqBr1kko4mDViFn1n9Px32al5DQF4Vc096rRoxJhJOYEPwDB78POkWh/o57nNFbf2k/mJ2RxqekMTv+mApBOV/v/+7edUrgBMIbKhfnwdefOC4Q9sy5QhshPhahfNUQtIXqLVRvl/t2uf85lvsWqre52+buj5m7XwHVIxr6NFQHwRdDddB2t1mNpZ5RcP3fEbtPlSiBD2+mU4/VsyUG97gCobQ8hkxlhA7WHnR68SBu7yZcnGS3vXCyOAkni5P6ZHGSVueUQ4sQJC5NDjYz5wp70OvdwJFw4G2XF7KL+gZfuoXSH7qpnvfGsN4dhYnOoYYkJAI6RBx7kK43vZEU3aEUeubBEV5ZimM4xB89+CxnOj9MHl5ASRbYbDFkQow0/xgiFmgzfrGeuusja0M/6HVp8tu/rktg9Ald7jLfZ2cDPYOkayqSCm+X57HPCZOH2TdOZS/XGfo1YLAx2UsiG7Cnghs0DOGAzIPfXl88ZFNCor4SlJZAsJDUOiCXXiFEfKUbVYdFaJBffIwupzMv+KhxHIcyi01yKMzeqHMh2NVJNMILLAFnqNnepDRI+DJBo94+qLyTiWuR0+rYXVqSAk9mqgcL9Xhj3EO/EvqWQSpczv3T7huVsCNpQsxbTxNV9B0guyoqvfiKXt8qxL8qbknglnhu9uGaFMG0V2k43p0ivYkFz6231jdPHvglK/yov8IT4rouA1kiytE8RJVWXvtmORr8EuLXlOONej2TWGabw1ioasxilcwzdsLSmdZW/JsxCh1Kg6tpiSz6ZrE+0KSJz4hksL0iUhKmTGQC0OjlO0ViqBBMfEyLtscsOmyf+JR85z2LnH+Hljpj7xo6+8dXWFuJMtOp/WaZacKEJkxCDbBR/rB0UWAht0kHXwdCABwu/e8rQRR0pe4FXndWdc++58fQ0pBCVM/FFgfh5mBZ4OIV8y+IuqZBGSbMXR8ro29KIi9avxrGqnYL1i24KW+usWyu2S3IW//mSUvpP01f0ni03FR5qfLF967Sn6gk/5y6+zdVvLbS/IyVJqJgCjc/bWwXVoP8acRrm5t8tAs9E/iLtz5XPeBGOxO+lCMUs8qoyLmjqPZZnc6k8NsDheCOsN8WRZae+0xEJ0/pjybQM5oa0CBtLTApH8sc/PwGdjUz9wkTgCX5le5tGY9T6PghYJe9RsemUriFujU6yIt373Vs287hmVfkWHZUORugaz4vFX3YB7HLOeMIqXsiIpM2LUPhQlOgRGUL7aFfParKYgo1UqHr+xYzty8ntPOMpnbF8ffMBb/buO0M05MX4zeBS0XORO4jk+iasP0+3oi2ZCbygvpFVF0AMLEyw/OTiw2OYKbibx3aTHtxkO0RLZhQexTCZ6fb724nvl3A80Jbhw63IT41ZCx8GMrCl6Gs/jSUHa5+zbkemzfLXfgf5NPQuHxR39EraCuNjFKGPih0pFed2JGC+qDqSWmb4/NNKdqcGWxL429uaDeGurRbevxHKajVv3q7bMB84wrf0zWa4gmqkfiMaR+cRZUe+t+TVj8hvVOfagNRLZZ7Bx1c/i5oywHj0JhDXL8n5EUJL8Ku0cqQjd9VqJmrO/mj49Pji+NOwEZ3QYN4Ac1R/P4Hi1wrYg== +sidebar_class_name: "delete api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 Native Change Detection Configuration' (delete-native-change-detection-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Delete Native Change Detection Configuration

+ + + + + +Deletes the native change detection configuration for the source specified by the given ID. +A token with API, or ORG_ADMIN authority is required to call this API. + +## 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/delete-non-employee-record-in-bulk.api.mdx b/docs/api/beta/delete-non-employee-record-in-bulk.api.mdx new file mode 100644 index 000000000..7d374645c --- /dev/null +++ b/docs/api/beta/delete-non-employee-record-in-bulk.api.mdx @@ -0,0 +1,89 @@ +--- +id: delete-non-employee-record-in-bulk +sidebar_label: Delete Multiple Non-Employee Records +hide_title: true +hide_table_of_contents: true +api: eJztW9tu2zoW/RVC89ALIjtxbid5GThpOshBeprJBX1IApSWKJutRGpIqaknyL/P2iQlW7bTdnqKmZ7CKFDYErm59pVr08xDpEtheCW1Ok2jwygVuajEH1qdFGWup0JciESb9FQd1fnHaCOyIqmNrKbR4c1DdG2FOdaqEp+rYV1N8CySqTpUIi8OC674WER3j3cbUcXHll5CbNzIZWcyE8k0yQV744YWQlURBqfCJkaWhAh4ribSMiP+VQtbsXuZ58wjZEWdV7LEbAWhohFqHFrLRtyKlGnFqsnCCIm3pdGfZCrS3q26mBdN60gj3KRM57m+l2rMbAITHd6qZ143aw49hGcwR0B2pFNY5GEBe0fdEezXYG/0GWFaL0jBurB/ZWqxESVkU1gDEnlZ5jJx/ul/sCT2IbLJRBScPlXTUmAhPfogkgqCoBi8WUlh6S1UXQZ1JrGwzpaMQjiCOG4Mn+KrrERh55axlYE98CLTpuCAF9W1TKPHx8d5FW7cuneP4bEttbIez2BzZ5WRWFCXxUyqlJQV1rmgdTu3zNZJIqzN6hyWrOg1/ITQULPplWYjmlTVRsH5UgUhHkEvApydzc1lBMe5pOknxmgDDBetgKyDgpxFK0r1iecyJXv9ID+louIyP9apWGXsLtjXUol4bLgkhMJBTjAxhDSFa6FhGS+S/EwquHEEWHzmcDmJhyV6W+yIp6zJgOOgDMxUGZ58hCyqCF8DdK0k5rNmCkIJqWOeWlbsCz7a2zwY7GR7O5wPftvZ2t8dHWR8e3vzYPfggFYv4GfUg/nIayKyu/Q/hBJGJizXCTzybxjECA7bOwBu8RVB/IQPnIxvsP8V9PJjWzUDXkZlcINxdnR8znb2Wc7VuHbP+XjBCCq+vsQTVec5H9EjSnto7gW/NXIs1SooQtUFJdirk9fD67MrPLk4+ef1ySU+kayl4jlUTUYBKmJhou8d4qCAyytUpKRCKWQvg9SXUIgrOz9Q+m92amFMxFbGUXwxI6y+Ysa8aJYZXXRSKfF7Bnsue6K3gazFMxSUZNKt2y+HyPmyis+CJV+yieCpMC96bJimkpTkOUM2QijmTyn9eZrOcj+rkcoAI6uJRtFQupKJ6PpiZsquN5AEsnIjzuadQskB5F+Pk2FS1QDn1JzPwjZaAsSm4qXBcl10V4tVcKoqnkALnudTmNFgv6tcQZSVbQuhJNtj/23GtRWLKnKjlit3bzyYV5V27xJe22/Iu/Mc5Sd2qrUvPomQfJbqcNhgyRuNm0JFwktS201utuHGFk3is0yKPF3n7jp317n7jbm7+PIisJ7w1lGfrWXqc604eLs2bvNcoj4tw2oGOXoTHLnBYJBAkX5/d4XE/igUjRefSyKCP5Af+a18Cfyw9Yd/PiL60Tqr4wsC6OzoNchQiUR66HDPEDtDeVNtL6/2WpuRRICqFRQRVdOwqa4Zh8lMrRQh4XaDpVpY9axiE476yB2D9RWQVlVpXGqpqjWTXDPJ9W603o1+nd1ozSTXubvO3b9m7n6RSbaoXLYEnmTrouBm6iMtvCdtOcOA9vyNtSnnXLXIVkgYazlW1GUO0WiwNdrK9hOxk/KddG/7IBskewO+u7+1vzXaGexH83v9zSyP2yTr5tScv70fnYlB4j6Bx9UKwWUrrdPu8R/Ma0RGZY1KT8ubYXOY9K7ljoODZe54pTUdck8bhmQ7HFLNbEQ1DWMLGmuasRjA2Rh1UTGUKglcFEqyEJBiEDQsl4V0yUtaQK6ZxsOsgio+URZPQvE9yWsgdJUg18SaNQJLQkmREeeDBMdgx6jOP5CdBhf9KSbPLkjjM9KYnXxOhKBEb5n77qrz3VOAN1QjLr2Dnzjo9d0OVwgANAS+ZrW8c83P1/x8vcev9/hfY49f8/N17q5z96+Zu/8FPw9s6Gl+jgHfzM8xtrfJWi71moLrf07TXaoEBC68mU6S2rjj5oaDO16BUCJApbauiHC6nBL15+88xOGqSJ8uZsT+Yoa730Ic0cOrTY5Zk6oq7WG//wCvwVuPPV7KHooZHFdNlb7vJbroj2CqFVWIrgv4jKMBbHh+GrqMnrOzkRTKvu454d7qTjMKWljfnRB/UbLihXPnVNeodE7MBkPYh7ByjwGxRE/xzLrRPRdGS/pBr2uTP/55XbygJ3RZZb4vrobxDEgXVCQV7mbXkS6JgPvVly4lzTYVatoGS4u9pWEDdiS4QXfgf8d4/vu7qxdsTLTTpX1tifEKSX0CEuccIeLK2rA506dJbqcxuh5PHPBh51cTSiOW5VCY3apLIdjNaTDCH6j3FyjQzqQ0SbiaQLPunjfeScUnkdNW2JtZkgJPpqoPC/V5Z94Lt+25/kAqf1sHT3u3KmavJFUjSds3jQkqunaP3ZSNXnxOr+8F8bdGWuylxU6afbGAwpv2JvG3cBLkMonguXXW+u7Fvbx4Th41U3hCUhcxkCUCju5vXUnjte/G0ZEXk7wujlv1biKxp3anMV/CmMWWmKfslCUTra34O2MUOpQGN+MaWfTdsO5p0dhlRDzYnIMU+yVjGYMhOnxnSAzlg4mPaId2BEWDu6nUp+R751nk/Hv0zyl739HZPb7BRkojU53Y78ZMC8a0YOxrgA34/T5FgUV306CDqwM+AI5n/neVIACdq3te1sqq7sT33RzaGugeoJNiy0P/5XBW4MInf1uQRrdjUIaJYLe//uE7C7Jos+oYqzkaWLTgMt5cY49csJvH2x5N0b75s+lLGg9nJyhvVT790VX6iUry89Td/1PFW1eaX7HSBMpLJ5EXs8vIJ01zEm4B30TbGf9tN9vbiYmNxzu7e4N4tJ0l8SA52NvO9vZ4xveiO0iiwHUKhC5jPl2OAvNbPhu07tY0/sdbl/WOp6MLcn2d40PzgsqcV5Qfrj4kEyncqUIpeEUscoNiVBcup0ujqZCgd3SCxgZjUAAs2C0fyRzy3Ll3szJ3qecpKkUIfbe1a21orWSCLlX02Ds0eiqBg6nJo5sbePdBh27vEj4+pxBhr5qwAX0rilphNcrwumAcwfmV2EqlTWpfAtHzKdHYQjsS2c5q6gEFLangLmILU9i3GR1YoxeeC6GvrIUIsuG0GqYnLxLfp06qVeRC5C7GaVy3AfiabMRtPBF5SW0m6jeonJhb4c3p1ZJECFMWeqGd12bcD5Nsn8ZCCDVaPny2e1u9zdg1HnhOXRsa4w58d2/+TXPnv3Oz3v+Fgl2MyYfZof3P/lcEYeejlqVf0pEbWaH2LZTvXW+iVb0rps53r+iHJtTwYvTDA2Gndu6RHgMdHQDc3M06NfqGVfxZjWt3Pwo6Iwg/DsRXU7eth8OA5V89qIH0M/z5zxfH3s315Odv6SQsGoU/mSj88YLh93hI/x9Gt/iHL7r0cYpB7vlD1BzWYYyX2/CnVfQhfCA1Hx//A9o84Q0= +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/delete-non-employee-record.api.mdx b/docs/api/beta/delete-non-employee-record.api.mdx new file mode 100644 index 000000000..bddd5dc27 --- /dev/null +++ b/docs/api/beta/delete-non-employee-record.api.mdx @@ -0,0 +1,83 @@ +--- +id: delete-non-employee-record +sidebar_label: Delete Non-Employee Record +hide_title: true +hide_table_of_contents: true +api: eJztWl1v2zgW/SuE9mGawrIdx22avCzcJF1kkE67+UAf0gClJdpmRyK9pNTWG+S/77mXkmzZadPNFLszhV8SWyIvz/3kuTRvIztXThbamtM0OoxSlalC/WbNST7P7EKpc5VYl0adyKukdLpYRIfXt9GVV+7ImkJ9KUZlMcOzSKfm0KgsP8ylkVMV3dzddKJCTj29hMC4lijO9EQliyRT4jUPzZUpIgxOlU+cnhMWILmcaS+c+lepfCE+6ywTAZuQwkCaqqU5BtgFwrl0MscI5xmjJilzCXSdyOAFvmlSpL1MC1mQJXQqnlxdnR7vYDQh0E7BNoUrVSdSXyRGk7BBcrD7ov9i/FxNdtPhnurv4tNY9hM13O8f9Idks2Smchkd3kbFYk5zfOG0mUZ3ZBun/Nwarzy9H2A8/q1jEwkZ2RQiFtqkOpGF8qKYqaVhpBe+TBLl/aTMxLgs6LVTAsYzy+mFFWOaVJTOKChoKiEBQTe660TDfn8TwVGmafqJc9YBw3kjYNJCMbbpglbU5pPMNDujWplEyvk8I+gQ2fvoSe7tpmXs+KNKCvKio4gsdLBLqgqpsyObqk0rrrvylTYqnjqpCaFiyAkmCkj8pFPMELmFZYJIYYMKPI4ALx0LS3R3xUuZQt+g31GlDMxUOJn8DlmULQ8BujIa80U9heJqAlBfWVbtKzl+3j8YDCfPh1IOXgx395+NDyZyb69/8OzggFbP4WdkjF9ZWzonFxtL/0MZ5XQiMpvAI/+GQZySsD0D4MUxRRcq9w/7gGV8h/0voVcY26hZ4RVUKDrI3JdHb8VwX2TSTEt+LqdrRjDx1QUlbJllckyPKO2geRD8xumpNvdBUabMqdIcn7waXZ1d4sn5yT+vTi7wiWRtlJeRqTMKUBELM/uZEVcKcF6h3iSFSrviaSX1KRSSxq8O1OGbX3gYE7E1kWVWYEa1+j0zVkWLibN5K5WSUFXFE91V3Q6yFs9yWSQzMZYeE2xI3acj5Py8iM8qSz4VMyVT5Xa6YpSmmpSUmUA2QijmLyj9ZZouc39SIpUBRhczi6JhbKET1fbF0pRtbyAJdMEjzladQskB5A/HySgpSoBjNVezsImWCmJd8dLKcm10l+tVcGEKmUALmWULmNGhmBdcEHXhm0KoyfbYoepxTcW6u1uqxeXudQBzXFh+l8jSf0fevc1QfmJWrXnxSVXJ56kOh2rE3qjdVFUkvCS1eXI1qnFXnfhiolWWbnN3m7vb3P3O3F1/eV6xnuotU5/dTepzZSSYrXW8eW5Qn4Zh1YOY3lSO7AgYpKJIv767RGL/rgyNV1/mxCV/ID8KW/kG+FHjj/B8TPSjcVbLFwSQ7Rg0mKASqfSQcS8Rs6GCqfY2V3tl3VgjQM09FBFV04mFLYWEyVxpDCGRviNSq7z5pRAzifoomcGGCkirmjSeW22KLZPcMsntbrTdjX6e3WjLJLe5u83dv2bufpNJNqg4Wyqe5Ms8l24RIq16T9pKgQHN+ZtoUo5dtc5WSJhoOFbUZg7ReLA73p3sJ2qYymH6fO9gMkieD+Sz/d393fFwsB+t7vXXyzxukqydUyv+Dn5kE4PEfQKPKw2CyxfWpu3jP5jXqQmVNSo9DW+GzWHSm4Y7Dg42ueOltXQMvKgZkm9xSLO0EdU0jM1prKvHYoAUU9RFI1CqNHBRKOlcQYpD0IhM55qTl7SAXLeIR5MCqoREWT8JxfckK4GQK0FmiTVbBJaGkmpCnA8SmMFOUZ1/IDutXPSHmLw4J43PSGNx8iVRihK9Ye7P7jvfPQV4RzXiIjj4Kwe9oduRBgGAhiDUrIZ3bvn5lp9v9/jtHv9z7PFbfr7N3W3u/jVz97/g5xUb+jo/x4Dv5ucY2+2Lhku9ouD6n9N0TpUKAYe3sElSOj5urjk48wqE0vKmB1+boAscUW/1VkUcbkL43q1O7/jyB9HDgKx0GYbPimLuD3u9WzgMjrrryrnuoo7BZ8XC2M/dxOa9Max0TwGimwIh2WiAGL09rRqMLpvYaYriUPJYeDA4K0XxCsPz4fA3JdOND/LkwpYociymIxDxVUTxY0Cco534xfPoLkfQhn7Q68pld39clyDoK7rcZ75vrobxAkjXVCQVbpZ3dS6Ie4fVN27sLPcT6tcGG4u9oWED8VJJh8Yg/ITx5Nd3lztiSoyTM770RHaVphYBOfMWIcIVbVQf59Mk3mScLaczBj5q/WBCGSQmGRQW782FUuL6tDLCbyj156jNbFKapLgc0KybJ7V3UvVJZbQLdpeWpMDTqenBQj3ZmrfDOx63BtrgY85Pu+9NLI41FSJNOzeNqVTkTk9cz2u95IpejwXxt1paHKTFLM3vrKEIpr1OwgWcBGlMImTm2VqPXjzIi1fkUR+FJyR1HQNZosLR/pkrqb32aBwteTHJa+N4b97NNLbT9jQRqpfw2A2zVJyKZGatV38XgkKH0uB6WiKLHg3rMy0ac0bEg/4KpDgsGesY5JDxnSExTAgmOabNmbmJBW0zaUjJD+xZ5PwHtM6p+NDSmR9fYw+lkalN/KMx04IxLRiHGuAr/GGLosBCbpMOXAdCABwt/c+VoAK6UveCrHurOovv8Ry+4waoLMXPD8OXw2WBqz4JfkGjmzEow8Stmx/+8F1UsmifahmrPhVYt+Am3sxie1yzW8DbnErRlvln05c0Hi0PT96YbPGjq/RXKsmfp+7+nyrettL8jJWmYrsUbrxs1RasBvnLiq9tHubRafNM4S/ecq4ysUbbwo0Ys5hVQfNMFhTVnNXJTCs+BpgrWRD361Bk2ZwzER07pT+aPRY0dRiDtPXgpHKsM8jjg+p6ZckJE4gl+ZW++5J7EVormaGtVF3xDp2ZSeAW6sroqgXefbRVe3YBz7wlx4rj2tkgXXleGqxGeVnmQiKkHoiIVPukDIULTZpRtS0sU79mVp3FFGqkQpf7E5f7NxM6YUbzuuL4B9aC3311vAzTkxerW9xLRc5VxpFJ49q0/SHZiLZ4prI59YWouiBgamWF16eXGxIhzHjohf7bummvmuR7NBZCqD0K4bPX3e32Y24X8HxufYFOtgWfr7G3Lp43t+xbkXi7PFt/xHX4auMgxt+b02EVwSlDBxJ6vuvovp4PUw91ShfyZ8BOo25v6VSDuqA7egwM1DJf3ywbHG4MYVv6jOZygmxX31DmyXl1q35HPHT//l4t6oM5s1j25BE+/q6olQd4NLyAz2ctDC28CKcxK1M2fq+g5qnpkI9Pzk4uT6LARe7biqsPsASKzX8Aw1VGNA== +sidebar_class_name: "delete api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Delete Non-Employee Record

+ + + + + +This request will delete a non-employee record. + +## 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/delete-non-employee-request.api.mdx b/docs/api/beta/delete-non-employee-request.api.mdx new file mode 100644 index 000000000..f948f7c34 --- /dev/null +++ b/docs/api/beta/delete-non-employee-request.api.mdx @@ -0,0 +1,95 @@ +--- +id: delete-non-employee-request +sidebar_label: Delete Non-Employee Request +hide_title: true +hide_table_of_contents: true +api: eJztW21z0zoW/isa74cLTPPSNFCaLzuhLTu9Uy5sX4YPpTMotpIIbMkr2UC20/++z5FkJ05SCr3M3gvjL+BYR0fnXc9R5ZtI58LwQmp1kkSjKBGpKMQfWh1neaoXQpyJ/5TCFtFOZEVcGlksotHVTXRphTnUqhBfinFZzPEukokaKZFmo4wrPhPR9e31TlTwmaVBcOxULNmpnIp4EaeCvXKkmVBFBOJE2NjInISBKBdzaZnxy7PPMk2ZF45xpsBNVNwCSRci5tzwDCTGOiElsck5xNuJFAbwSybR+joN0ar1ZMKkYsVcsMvLkyM21SbjZAQal0bAVIUpxU4kvnBMJc6D+GD3ef/55JmY7ibDPdHfxdOE92Mx3O8f9IdkwXguMh6NbqJikdMcWxipZhgJ/EdRWULCW7KcETbXygpL9APMx3/rgrOYXKAK1oG0iYx5IawTujYbt8yWcSysnZYpm5QFDRvBYFq1nF5oNqFJRWmUqDWvJOhGtzvRsN/flOAwlTT92BhtIMNZzWDakGKikwWtKNUnnsqEPBVWJpY8z1MSHSx7Hyzxvdm0lJ58EDE5IDcUsIX0dklEwWV6qBOxzapNYV9KJTozwyVJKJzIMSYycPwkE8xgmYZlPEumvQqOjgReOhqW6O6yFzxhITfYYVAGZioMjz+CFyXTfQJdKon5rJpCMYc4uGtZsS/45Fn/YDCcPhtyPng+3N1/OjmY8r29/sHTgwNaPYOfkU92ZW1uDF9sLP0voYSRMUt1DI/8FwYxgsP2TgC3OKbIQmT2fh84Ht9g/wvo5WlrNYO8jMrIDvL6xeEbNtxnKVez0r3nszUjqM7lOWVzmaZ8Qq8oDaG5Z/zayJlU20QRqsyoDh0dvxxfnl7gzdnxvy+Pz/FEvDaKz1hVGQVREQtz/dlJHBRweYVqFBci6bIngesTKMSVXSWU/pddWBgTsTXlZVpgRlh9y4xV1mxqdNZIpdjXXPZIdkV3B1mLd6gc8ZxNuMUE7VP3yRg5nxed02DJJ2wueCLM4y4bJ4kkJXnKkI1givkLSn+eJMvcn5ZIZQgji7lG0VC6kLFo+mJpyqY3kASycBSnq06h5IDk98fJOC5KCOfUXM3COlqCiFXFS4LlmtJdrFfBhSp4DC14mi5gRmNgYVcQZWHrQijJ9ti/Krq6Yt3eLtVy5e6VF+ao0G4s5qX9hrx7k6L8dJxq9cAnEZLPUh321ch5o3JTqEgYJLXd5EBVu6tKfDaVIk3a3G1zt83db8zd9cGzgHrCqIM+u5vQ51Jx4F5t3Oa5AX1qhFUROXgTHLnDYJAAkX5/e4HE/igU0YsvOWHLH4iP/Fa+Ify49od/PyH4UTur4QsS0NnRazBFJRLJyMm9lNgZyptqb3O1l9pMJAJUbYGIqJqGLXTJOExmSqVIEm53WKKFVb8VbM5RH7lDsL4C0qoq6eRaqqJFki2SbHejdjf6dXajFkm2udvm7s+Zu19FkrVULlsCTrJllnGz8JEWxklbzkBQn7+xOuWcq9bRCjFjNcaKmsghmgx2J7vT/VgMEz5Mnu0dTAfxswF/ur+7vzsZDvaj1b3+apnHdZI1c2rF396PzsQAcZ+A40qF4LKF1knz+A/mNWJKZY1KT42bYXOY9HqJHbeecRbQDYyBHc0dx4uXZ6fEH0s79mQ3XZpYEMz2pgM5LxykpBiGpaU70W6hYwsd2+2n3X5+je2nhY5t7ra5+3Pm7ndBx+F90HH4HdBxyAhiTQli/ZXQMQHuIGg2hVOgQ1zCvIpgYw5V8BROH0PaF9zMRFEDvQaKHBxsosgLremqwaICS7ZxEqmW5qLyBtqMaE1FCwLOZiiRiqFqSaBbiiqZCcKkiB+Wyky6PCaFwNcsOuNpAa18zqz/PR2/47SEhK4opJrOXjViTCKcxJTgHzi4c9AZCvUPPOMM3vpT58HsjDQ+JY3Z8ZdYCMr5+vz36bZbAicQ3lC5OPe+vuO6gD8z5wpthPiS+/JVQ9AWqrdQvd3u2+3+19juW6je5m6buz9n7n4HVA9o6G6oDoJvhuqg7fZZjaVeUnD93xG7S5UggQtvpmOH1ZMlBne4AqG0vE5MZYRu4Y6i3urN3U6FsHs3MrmN6IYx4UMvWmlS0M+LIrejXu8GHoOnbrs8l10UMjitWCj9uRvrrDeBmbZUILpw6rONCNj4zUloNrrOxkZSGPua55h7izutKGBheXfH4Kuc6VYxuXKBPoR5NjsMIR9Cyr2GiDn6id+so+66ENrQD3pdmvT2z+viGd2hyzbzfXU10DNIuqYiqXC9vBB+TuDbr75xLXy5odCx/2BjsddENmAvBDfoDPxNmEe/v714zGYEOV3Kl5bQrpDUIyBp3iBEXEkbV7dCaJLbZYwuZ3Mn+Lhx74ZSiE1TKMzeqXMh2NVJMMIfqPVnKM7OpDRJuHpAs64fVd5JxCeR0jbYXVqSAk8mqgcL9Xhj3mO35bneQCp/sRtvu+9Uhx1JqkSStm6iCSq6Vo9d5ZVefEWvhwrxj4pbx3PrOG728ZoU3rRXsb/HHSOPiQVPrbPWgxf3/Dor/KiRwhviui4DWSLI0bwtFVdee7AcDX4d4teU4516O5fYT5vTmC9fzGI7TBN2wuK51lb8kzEKHUqDq1mJLHqwWJ9p0Y7LiM6gvyJSxy/ZkR2gQyffKRJD+WDiE9qdHTjR/pzEpeR751nk/Hv0zgl739DZvb7CJkqUiY7tg2WmBTu0YMfXABvk93sUBRZym3RwdcAHwOHS/64SBEFX6p7ntbWqO/Y9N4e2hhiiOi42H/kfo2WBC0/MDRB1TYMyTOC6vj+G3yzwoo2qYazqWGDdgpvyphr745rdvLz1Hzdpz/y76Usaj5enJ69VuvjRVfqOSvL3qbt/UcVrK82vWGkC3KVwc8uGvmA1yF8EvLZ5mkfHzXOBfzHqctUha/QtrhNzKGaVUZ7ygqLaZXU8l8KdA+SCF4T9diiydOYyES07pT+6PcdoZkCDtLXApHwiU/BzJ9XVytwljAeW5Ff6bctwb0IjJNFXii57i9ZMxXALtWV0YxdjH3Toz87hmTfkWHZUORugK8tKhdUoL8uMcYTUPRGRSBuXvnChS1OisoV20K+eVWUxhRqp0HUNisns6ykdMaN7XXH8PWvB7zacL8P05MXwpeBSkTORusgkuiZsv483oq0zF2lOjSGqLgCYWFnh1cnFBkcwU+GPGtrMemGS7REtmFB75MNnr7vb7Xdcu4D3ubYFWtmG+O5bycbHjctvORuheLM8XX/IR5dh6yDM38vpvIoEKn0P4tu+q2hr24e5I5nQh59ziE9kNzd0skGN0C29Bhm1zVfXyx7H9YYwLz2jwZwi4cVX1Hl0Fr7XfMy+6zPPrTpVJ3VqsWzSIzx+FNTb03eb16Dyhy9OTj/gj2dWpmz8AYOaqbplPjo+Pb44jjw22bY1hweYBcXnfw+R4t4= +sidebar_class_name: "delete api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Delete Non-Employee Request

+ + + + + +This request will delete a non-employee request. + +## 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/delete-non-employee-schema-attribute.api.mdx b/docs/api/beta/delete-non-employee-schema-attribute.api.mdx new file mode 100644 index 000000000..8afcb536b --- /dev/null +++ b/docs/api/beta/delete-non-employee-schema-attribute.api.mdx @@ -0,0 +1,84 @@ +--- +id: delete-non-employee-schema-attribute +sidebar_label: Delete Non-Employee Source's Schema Attribute +hide_title: true +hide_table_of_contents: true +api: eJztW9ty2zgS/RUU92HilCnJshPHftlSbGfLU85lfak8OK4KREISEhLgAKQTjcv/vqcbJHWz46wnOzuT0ksikUCjb6dxGoJvIlsoJ0ttzXEa7UepylSp3lhzlBeZnSp1lkxULgdl6fSwKlW0GXmVVE6X02j/8ia68ModWFOqr+WgKid4FunU7BuV5fu5NHKsoqvbq82olGNPLyE5bkSLEz1SyTTJlHjNQ3NlygiDU+UTpwtSCiqdT7QXyqRxYbUpRdDQCyl8oRI90onwrKOQjZJiZB3eG6ylmrW8rVyiOh8MLCikkzmEOM82aFqlkNB+MzJ4gW+tKDgFFrP8aP8mKqcFvfZ4a8bR7Wbk1G+VdgquK12lNiP1VWJFGtNP9rZe9F4Mn6vRVrqzrXpb+DSUvUTt7Pb2ejvRqp1KBG+L1t3iOBVPLi6ODzew2J2aBrv+bDV5UaHTiGLrlC+s8crT0n1MwX+Lc95YkVCSIHyx0CbViaQQlhBFmilfii/SC18lifJ+VGUCxtNrh0U8AtlOL60Y0qSyckalkFULCRp0yNadXm9Vg4NM0/Qj55AasThtBYwWtBjadEoranMtM512YH29MomURZGR6hDZ/eRJ7s2q0+3wk0pKyjJH0Cp18EuqSqmzA5uq1QAtu/iVNioeO6lJQ8UqJ5goIPFap5ghcgvPBJHCBhN4HCk8iy080dkSL2UKe4N9B7UxcFPpZPIZsgj2Dyl0YTTmi2YKAs8Qu2dZtavk8Hlvr78zer4jZf/Fztbus+HeSG5v9/ae7e3R6jniDMT7ubWlc3K6svS/lFEOGM9sgoj8Doc4JeF7VoAXxxRdqtw/HAOW8R3+pxQPY1sza30FFbpN1JaXB+/Ezq7IpBlX/FyOl5xg4oszgmmVZXJIjwh5sDwIfuv0WJu7VFGmyqlSHh69GlycnOPJ6dG/L47O8IlkrZTHgWkQBVWRCxP7hTWuDWBcoWQmpUo74mkt9SkMksbPD9Thm596OBO5NZJVVmJGvfodM+ZFi5Gz+QKUkrAriCe6ozqbQC2e5bJMJmIoPSbYAN2nA2C+KOOT2pNPxUTJVLmNjhikqSYjZSaARgjF/CnBX6bpDPujClCGMrqcWBQNY0uNOr8Qi5krF6MBEOiSR5zMB4XAAc0fzpNBUlZQjs2cR2GbLbWKTcVLa88tane+XAWnppQJrJBZNoUbnYOHuSDq0reFUJPvscM249qKdXs7M4vL3eugzGFp+V0iK/8duHuXofzEbFr74lrV4PNUh0M14mg0YaorEl6S2Ty5HtWGqwG+GGmVpWvsrrG7xu53Ynf55WnNeuq3TH22VqnPhZFg5tbx5rlCfVqG1QxielMHclPAITVF+vX9OYD9WRkar74WRCd/ID8KW/mK8oM2HuH5kOhHG6yFWJCC7MdgwQiVSKX7rPdMY3ZUcNX26mqvrBtqJKi5gyKiajoxtZWQcJmrjCFNpN8UqVXe/FKKiUR9lMxgQwWcb1vWTHLNJNe70Xo3+nl2ozWTXGN3jd2/J3a/ySRbrRgtNU/yVZ5LNw2ZVr8na6XAgPb8TbSQ41AtsxUSJlqOFS0yh2jY3xpujXYTtZPKnfT59t6onzzvy2e7W7tbw53+bjS/11/OcNyCbBFTc/EOcWQXg8Rdg8dVBsnlS2vTxeM/uNepEZU1Kj0tb4bP4dKrljv291a547m1dIw9bRiSX+CQZuYjqmkYm9NY14zFACnGqItGoFRp6EWppHMFKQ5JIzKdawYvWQG5bhoPRiVMCUBZPgnF9ySroCFXgswSa7ZILA0j1Yg4HyQwgx2jOv9AdlqH6A8xeXFKFp+QxeLoa6IUAb1l7s/uOt89hvKOasRZCPA9B72h25EGCYCGINSslneu+fman6/3+PUe/3Ps8Wt+vsbuGrt/T+z+F/y8ZkP383MM+G5+jrGdnmi51CtKrj+dpjNUag04vYVNksrxcXPDwZlXIJVmV1b4WgddQIm68/c+4nA/wndvmosSt91A5OL2jgdezt33uOUrLkQig/6VyyB0UpaF3+92bxBWhPO2IwvdQbVDZMupsV86ic27Q/jyjjJF9wkCJGmAGLw7rtuQDgfCacr1UBhZeAgLm05ZjfDwEfI3JdNtEIr3FFaKIGZTABd13vFjqFig6fjF8+gO59mKfbDrwmW3f9yWIOgeW+5y3zdXw3gBTZdMJBOuZjeS+PZMWH3lXtJs16Gurr+y2Fsa1hcvlXRoH8IPHU9+fX++IcbES7kuVJ4osdLUSABZ75AiXPcGzaE/TeKtyNlqPGHFBws/qxDOxCiDweKDOVNKXB7XTniDDeEUFZxdSpMUFw2adfWkiU6qrlVGe2Vn5klKPJ2aLjzUlQvzNnhf5AZCG3zM+Wnng4nFoaZypWl/pzG1idwPisuisUvO2fVYJf7RSIuDtJil+Y0lLYJrL5NwTScB2EmEzDx769GLB3nxnDzqtvCEpC7rQJ6o9Vj8MSxpovZoPRbkxSRvUY8P5v1EY9NdnCZCjRMee2aWimORTKz16p9CUOoQDC7HFVD0aLW+0KIxIyLu9+ZUisOSsY5BIVm/EwDDhGSSQ9rCmcFYkDuTBkh+5MgC8x/RYKfi44LN/PgSOy2NTG3iH60zLRjTgnGoAb7WP2xklFjANtnAdSAkwMEs/lwJakXn6l6QdWdVZ/FdnsOX7KAqS/HFfviyPytw9SfBL2h0OwZlmBh4+/MgvotaFu1mC85qzg6WPbiqb2axiS75Lejbnl3RxvpXs5csHsyOWN6abPqjq/Q9leSvU3f/TxVvXWl+xkpTc2JKN162bh7mk/xlzddWj/zoTHqi8C/eMlaZfqO54XaNWcy8oCKTJWU1ozqZaMWHBYWSJXG/TcosmzMS0dcT/NESsqCxwxjA1oOTyqHOII+Ps5uVJQMmEEuKK333FXcstFYyQfOpOuI9+jeTICzUu9GFDLz7ZOsm7gyRecf3xA+bYIN05XllsBrhssqFREo9kBGp9kkVChdaOaMaX1imfu2sBsWUamRCh7sYl/u3IzqHRos7F/gH1kLcfX0IDddTFOsb3jNDTlXGmUnjFmn7Q7KRbfFEZQV1j6i6IGBqboXXx+crEiHM1HfmrRt360m+S2MhhNqjkD7bna1OL+Z2Ac8L60v0uwvqU3smFi7+h/vjaESW77svJ+fN7FD+f/B3APVeQ01Ct6BTMLKgCk1LaCYvo7uaSUzdX7l3P9dP0vv5vyBAizKBX0jczQ2dq1CHdUuPf6sUNe2XV7PmiZtOxI0+o70doZKob3jlyWl9tX9DPPAHBPfY25wNmunsWCDCx8+KThPmzaBu8fGKtX8y8Cg9WnffXmFsOHxiT4XX4XhqbuLKDzjUJ7ZHBodHJ0fnR1GgXXexjvoDAoO6+h8+eOqN +sidebar_class_name: "delete api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + + +## 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/delete-non-employee-source-schema-attributes.api.mdx b/docs/api/beta/delete-non-employee-source-schema-attributes.api.mdx new file mode 100644 index 000000000..53f9b3d26 --- /dev/null +++ b/docs/api/beta/delete-non-employee-source-schema-attributes.api.mdx @@ -0,0 +1,83 @@ +--- +id: delete-non-employee-source-schema-attributes +sidebar_label: Delete all custom schema attributes +hide_title: true +hide_table_of_contents: true +api: eJztWltv27gS/iuEzsO2hWU7jts0eTlw0/Qgi/SyuaAPaYDSEm2zlUgtKbX1Bvnv+81Qkm9J09Mtztkt/JLY0nDuM/yG5nVkC+Vkqa05TqODKFWZKtUra47yIrNzpc5s5RJ1lsxULkdl6fS4KpWPOpFXSeV0OY8OLq+jC6/coTWl+lKOqnKGZ5FOzYFRWX6QSyOnKrq6uepEpZx6egkBcSNBnOiJSuZJpsRLJs2VKSMQp8onThekGzQ7n2kvlEnjwmpTiqCoFzLLRFL50ubCs5JCtlqKiXVCCgNhqhHm2Z4uDCikkzl4OM8maBJSSCjfiQxe4FughV9gLfOODq6jcl7wOwgx0+imEzn1e6WdgvdKV6lOpL5ICCOaQbK/87T/dPxETXbS4a7q7+DTWPYTNdzr7/eH0aaNSgSHC51G5DCnfGGNh8cheoAl+Le65pUVCXkePomFNqlOJJleghVppnwpPksvfJUkyvtJlQn4hl47CPFwTru8tGJMi8rKGZWCV80kaNAlW4f9/qYGh5mm5UfOwd2xOG0ZTFa0GNt0ThK1+SQznVIIasnEUhZFRqqDZe+DJ77Xm0634w8qKSl2jtK21MEvqSqlzg5tqjYDtO7iF9qoeOqkJg0Vq5xgoQDHTzrFCpFbeCawFDaYwHSk8CK28ER3RzyTKewN9h3WxsBNpZPJR/CikrpPoQujsV40SxB4Tts7xKo9JcdP+vuD4eTJUMrB0+HO3uPx/kTu7vb3H+/vk/QccUYZ+SXZ0jk53xD9H2WU04nIbIKI/AGHOCXhe1aAhWOJLlXu748B8/gG/1OKB9rWzFpfQd2jg3p9dvhGDPdEJs204udyuuYEE1+cUZlWWSbH9IgqD5YHxq+dnmpzmyrKVDm1n+dHL0YXJ+d4cnr028XRGT4Rr42eMzJNRUFV5MLMfmaNawO4rtCHklKlXfGo5voIBknjlwl1+ObnHs5Ebk1klZVYUUu/ZcUyazFx6G7LpZSEVise6K7qdlC1eJbLMpmJsfRYYEPpPhqh5osyPqk9+UjMlEyVe9gVozTVZKTMBKoRTLF+TuUv03RR+5MKpQxldDmzaBrGljr0zkUsFq5cjQaKQJdMcbIcFCoOaH5/noySsoJybOZyFbbZUqvYdLy09tyqdufrXXBuSpnACmwbc7jROXiYG6IufdsINfke21ZD13asm5uFWdzuXgZlnpeW3yWy8t9Qd28ytJ+YTWtffFJ18Xnqw6EbcTSaMNUdCS/JbF5cU7XhagpfTLTK0m3tbmt3W7vfWLvrL09r1FO/Zeizswl9LowE3LWON88N6NMirIaI4U0dyI6AQ2qI9OvbcxT2R2WIXn0pCE7+QHwUtvIN5UdtPMLzMcGPNlgrsSAF2Y/Bggk6kUoPWO+Fxuyo4KrdTWkvrBtrJKi5BSKiazoxt5WQcJmrjCFNpO+I1CpvfinFTKI/SkawoQMuzwJbJLlFktvdaLsb/Ty70RZJbmt3W7v/zNr9KpJsteJqqXGSr/JcunnItPo9WSsFCNrzN9GWHIdqHa0QM9FirGgVOUTjwc54Z7KXqGEqh+mT3f3JIHkykI/3dvZ2xsPBXrS8118u6rgtstWaWop3iCO7GCDuE3BcZZBcvrQ2XT3+g3udmlBbo9bT4mb4HC69arHjYH8TO55bS2fD8wYh+RUMaRY+op4G2pxoXUMLAimm6ItGoFVp6EWppHMFLg5JIzKday5esgJ83TweTUqYEgpl/SQU35OsgobcCTJLqNkisTSMVBPCfODACHaK7vwD0Wkdor+E5MUpWXxCFoujL4lSVOgtcn982/nuMZR31CPOQoDvOOgN0440SAAMBKFntbhzi8+3+Hy7x2/3+J9jj9/i823tbmv3n1m7/wU+r9HQ3fgcBN+Mz0Hb7YsWS72g5Pqfw3QulVoDTm9hk6RyfNzcYHDGFUilxXUQvixBtzqi3vJdijjcj/C96+aixE0vALlYrt4UIdgYNK5cBjazsiz8Qa93jUAigDddWegu+htiWc6N/dxNbN4bw3u3NCa6QRCKkAjE6M1xPXh02fVOU3aHVsjMQyDYWMpjBIQPjb/Kme5/UITnsEsENh2BSqgzjR9DxQJjxi+eqbucWRv2wa4Ll938dVsCoztsuc19X5UGegFN10wkE64WF3v4zk+QvnG9Z7HP0Bw32BD2msgG4pmSDgND+Gnjwa9vzx+KKSFR7gSVJxCsNI0OqKU3SBHudKPmmJ8W8ebjbDWdseKjlR9SqLLEJIPB4p05U0pcHtdOeIUt4BQ9m11KixS3CVp19aCJTqo+qYx2x+7Ck5R4OjU9eKgnV9Y95J2QRwZt8DHnp913JhbPNTUoTTs60dQm8gQoLovGLrlk1/cq8a+GWxy4xczNP1zTIrj2MgkXcxKUN7GQmWdvfbfwwC9e4kfzFZ4Q13UdyBO1Hqs/fyVN1L5bjxV+MfFb1eOdeTvT2GZXl4nQ1YTHLpml4lgkM2u9+rcQlDpUBpfTClX03Wp9JqExV0Q86C+pFAeRsY4BGlm/ExSGCckkx7RpM2axgHMmDSX5niOLmn+PkToV71ds5seX2FuJMrWJ/26dSWBMAuPQA3ytf9i6KLFQ22QD94GQAIeL+HMnqBVd6nuB161dndn3eA1fq4OqzMUXB+HLwaLB1Z8EvyDqlgZtmDB3+4Mg3QKsedH+teKs5rRg3YOb+mYW2+aa34K+7WkVbaV/N3vJ4tHiUOW1yeY/ukvf0Un+Pn33/9Txtp3mZ+w0NQqmdGOx9biwnOTPary2echHp9Azhb94y7XKgBvjDA9ojGKWGRWZLCmruaqTmVZ8PFAoWRL261Bm2ZwrEZM8lT+GQGY0daBB2XpgUjnWGfjxAXYjWXLBBGBJcaXvvuIZhWQlM4ybqiveYmIzCcJC0xpdwcC7D7Ye284QmTd83fp5E2yArjyvDKRRXVa5kEipezIi1T6pQuPC8GZU4wvL0K9d1VQxpRqZ0OW5xeX+9YROnjHULgX+HlmIu6+PneF6imJ9p3thyKnKODOJbhW238cb2RbPVFbQvIiuCwCmliS8PD7f4Ahmpr55bt20Vy/yPaIFExqPQvrsdne6/ZjHBTwvrC8x4a6oTwPZV2+9r6fk9eLw/cdfoq83GJoMegUddpHaVZhUwsx4Gd02M2Lpwcb1+uWxEYPIDNbT+utrOi+hOeqGHv9eKRrGL68WIxKPlogOfcbYOkG/UF/xwoPT+sr+Q7F64/4Oe5ojPjNfTPcRPn5UdCjQmoEBGkrz2Q0rFF6H052lhRu/f9DQ1U7cz49Ojs6PooBhbtvC6w+wH03qT8V+ddQ= +sidebar_class_name: "delete api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Delete all custom schema attributes

+ + + + + +This end-point deletes all custom schema attributes for a non-employee source. + +## 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/delete-non-employee-source.api.mdx b/docs/api/beta/delete-non-employee-source.api.mdx new file mode 100644 index 000000000..1cbd4e484 --- /dev/null +++ b/docs/api/beta/delete-non-employee-source.api.mdx @@ -0,0 +1,83 @@ +--- +id: delete-non-employee-source +sidebar_label: Delete Non-Employee Source +hide_title: true +hide_table_of_contents: true +api: eJztWttu2zoW/RVC83DawrIdx22avAzcNB3kIL1MLuhDGqC0RNtsJVJDSmk9Qf591t6U5FvadHKKmXMKvyS2RG6ufeXaNG8iWygnS23NcRodRKnKVKneWHOUF5mdK3VmK5eoqBN5lVROl/Po4PImuvDKHVpTqq/lqCpneBbp1BwYleUHuTRyqqKr26tOVMqpp5cQGDcSxYmeqGSeZEq85qG5MmWEwanyidMFYQGS85n2wql/VcqX4ovOMhGwCSkMpKlGmmeAXSAspJM5RjjPGDVJKSTQdSKDF/gWxkLR9cWCloLf0JraKVijdJXqROqrxFo0fZDs7zzvPx8/U5OddLir+jv4NJb9RA33+vv9IVkpmalcRgc3UTkveMnSaTONbskaTvnCGq88vR9gPP6t4nhjRUJmNaWIhTapTmSpvChnamEK6YWvkkR5P6kyMa5Keu2UgLnMYnppxZgmlZUzKoWsWkhA0I1uO9Gw399EcJhpmn7knHXAcNoKmKygGNt0Titqcy0znZL565VJpCyKjKBDZO+TJ7k3m5ax408qKclvjmKw1MEuqSqlzg5tqjatuO62V9qoeOqkJoSKISeYKCDxWqeYIXILywSRwgYVeBwBXjgWlujuiBcyhb5Bv8NaGZipdDL5DFmUH/cBujAa80UzRehUTADqG8uqPSXHz/r7g+Hk2VDKwfPhzt7T8f5E7u7295/u79PqOfyMHPFLa0vn5Hxj6X8oo5xORGYTeOTfMIhTErZnALw4puhS5f5+H7CMH7D/OfQKY1s1a7yCSkMHufri8J0Y7olMmmnFz+V0zQgmvjijFK2yTI7pEaUdNA+C3zo91eYuKMpUOdWWl0evRhcn53hyevTPi6MzfCJZGwVlZJqMAlTEwsx+YcS1ApxXqDBJqdKueFJLfQKFpPHLA3X45ucexkRsTWSVlZhRr37HjGXRYuJsvpJKSaij4pHuqm4HWYtnuSyTmRhLjwk2pO6TEXK+KOOT2pJPxEzJVLnHXTFKU01KykwgGyEU8+eU/jJNF7k/qZDKAKPLmUXRMLbUoW4ufLEw5ao3kAS65BEny06h5ADy++NklJQVwLGay1nYRksNsal4aW25VXTn61VwbkqZQAuZZXOY0TlYmAuiLn1bCDXZHntSM66tWLe3C7W43L0OYF6Wlt8lsvI/kHfvMpSfmFVrX1yrOvk81eFQjdgbjZvqioSXpDZPrke17moSX0y0ytJt7m5zd5u7P5i76y9Pa9ZTv2Xqs7NJfS6MBJe1jjfPDerTMqxmENOb2pEdAYPUFOn39+dI7M/K0Hj1tSAu+RP5UdjKN8CPWn+E52OiH62zVnxBANmOQYMJKpFKDxj3AjEbKphqd3O1V9aNNQLU3EERUTWdmNtKSJjMVcYQEuk7IrXKm99KMZOoj5IZbKiAtKpJ48JqU26Z5JZJbnej7W706+xGWya5zd1t7v41c/e7TLJFxdlS8yRf5bl08xBp9XvSVgoMaM/fRJty7Kp1tkLCRMuxolXmEI0HO+OdyV6ihqkcps929yeD5NlAPt3b2dsZDwd70fJef7nI4zbJVnNqyd/Bj2xikLhr8LjKILh8aW26evwH8zo1obJGpaflzbA5THrVcsfB/iZ3PLeWDn7nDUPyKxzSLGxENQ1jcxrrmrEYIMUUddEIlCoNXBRKOleQ4hA0ItO55uQlLSDXzePRpIQqIVHWT0LxPckqIORKkFlizRaBpaGkmhDngwRmsFNU55/ITmsX/SEmL05J4xPSWBx9TZSiRG+Z+9O7znePAd5RjTgLDv7GQW/odqRBAKAhCDWr5Z1bfr7l59s9frvH/xp7/Jafb3N3m7t/zdz9L/h5zYa+zc8x4If5OcZ2+6LlUq8ouP7nNJ1TpUbA4S1sklSOj5sbDs68AqG0uNvBFyXoykbUW75HEYe7Eb5301ySuOVLH0QSA77KZZg0K8vCH/R6N3Ab3HXblYXuoprBc+Xc2C/dxOa9MWx1Rxmi+wIh5WiAGL07rtuMLhvaaYrlUPhYeDA7q0ZRC/PzEfF3JdNND/LnHFqIIKYjEPd1XPFjQCzQVPzmeXSX42hDP+h14bLbP65LEPQNXe4y33dXw3gBpGsqkgpXizs6Z8TAw+obN3UWuwp1bYONxd7SsIF4oaRDexB+yHj0+/vzx2JKvJPzvvJEeZWmRgGZ8w4hwnVt1Bzq0yTeapytpjMGPlr52YTySEwyKCw+mDOlxOVxbYQ3KPinqNBsUpqkuCjQrKtHjXdSda0y2gu7C0tS4OnU9GChnlyZ95j3PW4QtMHHnJ92P5hYvNRUjjTt3zSmVpH7PXFZNHrJJb0eCuJvjbQ4SItZmn+8hiKY9jIJ13ASJDOJkJlnaz148SAvXpJH3RSekNR1DGSJGsfqj11J47UH41iRF5O8VRwfzPuZxqa6Ok2EGiY89sQsFccimVnr1d+FoNChNLicVsiiB8P6QovGnBHxoL8EKQ5LxjoGRWR8J0gME4JJjmmLZoZiQd5MGlLyI3sWOf8RDXQqPq7ozI8vsZPSyNQm/sGYacGYFoxDDfA1/rBRUWAht0kHrgMhAA4X/udKUANdqntB1p1VncX3eA7fdANUluKLg/DlYFHg6k+CX9DodgzKMDHs9uc/fBe1LNqtVozVnA2sW3ATb2axSa7ZLeBtz6Zo4/yz6UsajxZHKG9NNv/ZVfobleTPU3f/TxVvW2l+xUpTc14KN162bg6Wg/xFzdc2j/TozHmm8BdvOVeZXqN54XaMWcyyoCKTJUU1Z3Uy04oPAwolS+J+HYosm3Mmom+n9EfLx4KmDmOQth6cVI51Bnl8XN2sLDlhArEkv9J3X3FHQmslMzSXqiveoz8zCdxCvRlduMC7T7Zu0s7gmXfkWPGycTZIV55XBqtRXla5kAipeyIi1T6pQuFCq2ZUYwvL1K+d1WQxhRqp0OUuxeX+7YTOmdHCLjn+nrXgd18fMsP05MX69vZCkVOVcWTSuFXafp9sRFs8U1lB3SGqLgiYWlrh9fH5hkQIM/Udc+umvXqS79FYCKH2KITPbnen24+5XcDzwvoS/ewKfL6+vnIVvr1dvxKJN4sT9gdcg683DmL8vYKOrAhOFTqQ0PldRnd1fph60F6QRzMxgwY09uaGTjioF7qlx0BC7fPl1aLN4fYQFqbPaDQnyHn1HZUendY37B+L5Xv3d+JuDuTMfNGLR/j4WVEL38JFuwvAfNLCYMLrcBazNHHj1wpqmtr++OXRydH5URQ4yF1bcP0BuqPI/AezDENI +sidebar_class_name: "delete api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Delete Non-Employee Source

+ + + + + +This request will delete a non-employee source. + +## 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/delete-notification-templates-in-bulk.api.mdx b/docs/api/beta/delete-notification-templates-in-bulk.api.mdx new file mode 100644 index 000000000..eeb243707 --- /dev/null +++ b/docs/api/beta/delete-notification-templates-in-bulk.api.mdx @@ -0,0 +1,83 @@ +--- +id: delete-notification-templates-in-bulk +sidebar_label: Bulk Delete Notification Templates +hide_title: true +hide_table_of_contents: true +api: eJztW21z0zoW/isa74cLTJy0pdBtv+ykUHZ7p9BuX4YPoQOKrSS6OJJXsluynf73fc6R7TgvUC6XuctlMjAQy9LReT/PUZS7yObKyUJbc5xGB1GqMlWoN7bQI53w8KWa5pkslD82h2X2MepEhRz76GAQtWf56LqDxT5xOqdnkLqcaC9AzYuZLcUQa0WgLoqapCgmsuDXuVM32pY+m4nEKbxLxcg6euWE14XqigttEiwlovgrxVAVUowwtXSqI/JMSa9EYk0hk0L4Ms+tK0RhhTJymClRejlWXXDvVVI6XcwgwV105ZV7gTXqU9EviwlJpVNzYFqSxQ23B4H96Poesjr1n1L54tCmoHTHj9opqLBwpepExIgyBb2SeZ5VtHq/eVLNXeSTiZpK+lTMcgVlSefkDNxB1Klvjdvhbyop8CJ3ZKhCK377Uc1ak3zhtBljkvokwSsNJZkt0/dTaUqZvb+17uN7ovzel9OpdLPovhNNVarL6VoqhsYH0dHr/vEJns/+dfrmCP9fvL4gK883CRNAK7OJpJFVWssuoUSYy9Yt8DhVniwjyAQdmPXwxZnY3ROZNOOSx+W4uyCZMtH9fael8AFrA4wVuuAZtceSu75kk70sLBbdh3U+h7sGNe5s7dJ/i0y+saKynoiFNinZjl1Vicro4lZ6uFiSgPdRmcG3C3rtFHmmmS+H9w1pEVzUwKG1qYgEDrqkud2trVUOXmSalh85ByXF4rwhMFrgYgjfox21uZGZTklNv9ftPuNeKWJLZy9s+hU2faWNisdOauJQMcsJFiKi7Y1OsUJMLTQTSAobROB5i3aFJrrb4lCmkDfI96ISBmoqnEw+ghblqIcYujIa60W9ROi0cbY126o9JYfPt/Z3dkfPd6Xc+fvu9t6z4f5IPn26tf9sfz+ECvuoXxOvi1v/UxnldBJ8XP8XCkEug+6ZAd7860P8z42p+OoCI6bMMsqWIYs1gX3q9FibL6WKl0ev+lcnlxg5P/r31dEFPhGtlZrQN3VEgVX4wsTeMseVABxXiNgE+b8rnlRUn0AgaXx7og5PfuahTPjWSJZZgRXV7mtWtEmLkbPThVBKQg0Qj3RXdTuIWoxNZZFMxBBlJRU2hO6TPmI+L+KTSpNPxETJVLnHXdFPU01CykwgGkEU62cU/jJN57E/KqlciVtdTCySBtWZRC3aYq7KRWvM89tJ2ygUHOD8YT/pJwVqAfvEQhQ23lKxWGe8tNLcIneXy1lwxgUXKzIq3dY5aJgTokbhrxOhJt2jGNXzmoxFGbkWi9Pd68BMSNjIZ7L0XxF3ZxnST8yiNS9uVBV8nvJwyEZsjdpMVUbCSxKbF1ezGnPVgS9GWmXpJnY3sbuJ3a+M3eWX5xXqqaEYQZ/tVehzZSRwuHVcPFegT4Ow6kkMbypDdgQUUkGkX99eIrA/KkPz1aeckOJ3xEehlK8w32/sEcaHBD8aYy3YghhkPQYJRshEKj1gvuccB8zKqnq6utsr64YaDmrWQERkTW6ehITKXGkMcSJ9R6RWefNLISYS+VEygg0ZkHY1aZxbbYoNktwgyU012lSjn6cabZDkJnY3sfvXjN0vIsmGK46WCifVp5zsadV7klYKTGjO30QTcmyqZbRCxESDsaJF5BANd7aH26O9RO2mcjd9/nR/tJM835HP9rb3toe7O3tRu9YP5nHcBNliTLXsHezIKgaIuwGOKw2cyxfWpovHf1CvUyNKa5R6GtwMnUOl1w123NlfxY6X1orX0sxqhOQXMKSZ64hyGuZOaa6r52KCFGPkRSOQqjT4IlfSUwUqDk4jMj3VHLwkBei6WdwfFRAlBMrySSiek6wEh5wJMkuo2cKxNIRUI8J8oMAIdozs/B3RaWWiP4TkxTlJfEISi6NPiVIU6A1yf7bufPcYzDvKERfBwJ856A3djjRwADQEIWc1uHODzzf4fFPjNzX+56jxG3y+id1N7P41Y/d34PMKDX0en2PCV+NzzO1uiQZLvSLn+tNhOodKxQG7t7BJUjo+bq4xOOMKuBIxlFvPSUTSZZOot/6iSY8uy8TVbRO6sUIoMTBYugzrJkWR+4Ne7w52g73uuzLXXaQzmK6YGXvbTey0Rxdk1uShcH+GfIhv0PTPjqs+o8uadpqcOWQ+Jh70zrKR20L/fEb8RcpGTtmgfH0nkOkIOH7lWDwMFnN0Fb94nt1lR1qRD3Jduez+j8sSCH1GlnXq++JumC/A6ZKIJML1/ILRBUHwsPvKNaN5WaG2bWdls1OatiMOlXToD8I3GY9+fXv5WIwJeHLgl54wr9LUKSB0zuAinNj69ak+LeJa42w5njDj/YXvTSiQxCiDwOKduVBKDI4rJbxBxj9HimaV0iLFWYFWXT+qrZOqG5VRMezONUmOp1PTg4Z6cmHdYy583CFog49THu2+M7F4qSkf0S0ynlOJyA2fGOS1XLIl17cy8beaWhyoxUzNP17iIqh2kIR7OAmimUjIzLO2vnnzQC9u0aN2CiNEdZkH0kTFx+K3XUlttW/mY4FeTPQW+Xhn3k40quriMhGSmPAoilkqjkUysdarfwhBrkNhMBiXiKJvZuuWNo05IuKdrRZLcdgy1jEwIvN3gsAwwZnkkGo0QxQL9GbSEJIf2LKI+Q/ooFPxYUFmHh6glNLM1Cb+m3mmDWPaMA45wFf8h0pFjoXYJhk4DwQHeDG3P2eCitFW3gu01mZ1Jt/jNVQaErDKVHx+EB4O5gmu+iT4Bc1u5iANE8Ruvv/Ds6hoUblaUFZ9OLCswVV+M4squaS3wG9zOEWV80eTlyTuz89QTk02+95Z+jOZ5MfJu/+njLfJND9jpqlAL51Fns+vSR/V7cmgur/80CXl+R3l5ipyC59HhLXIo1myqgFpx9FhBQlXjw3pXHui8C/ecjpgCE/3xqnlY6DUJkSgnAKHE0cy0YoPHHIlC4KXHXJeO+Vgz52lDIO2kgmN+Sa7g1YkWkSdgR4fidc7S47JgF3JdejZl9z10F7JBA2s6oq36AFNAstT/0eXOvDuN1s1ghcw/hn5jnhZ+xNw3XRaGuxGoV9OhYTXPuB0qfZJGXIj2kGjal1YRpfNqjpRkDeTCF3uhNzUn47oLBttcsu3HtgLruWrg2yonqxIjQA1WY0g5yqrfl3QWeoMHqINh44nKsv5djrYQj/Z2uH18eUKRRAzHnKh07du3KsW+R7NBRHqwIL7PO1ud7di7kgwTg0dPLhFnK6di3DvXLR/IiGaX1Ise+Td/DT/R/3VRFUIqYPp5XQGR7KXoaMKzewgWt/MYnG7nUXQTqgHxvy7Ozq2of7unoaRKOhMYHA9b93oCfuE45tW4qi+L4gvZ1znq/OB1S9CqKMMK8KR0BfnXrfa9LNTOhyLhtWvO6bhxMHJWwzSvwfRO/zBg82Df9JPQGj8LqrP7zAn0K0B1To8UX0gMe/v/wfLaRmj +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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, please contact support to enable usage. + +## Request + +

Body

arrayrequired
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/delete-oauth-client.api.mdx b/docs/api/beta/delete-oauth-client.api.mdx new file mode 100644 index 000000000..f6b8f9a41 --- /dev/null +++ b/docs/api/beta/delete-oauth-client.api.mdx @@ -0,0 +1,95 @@ +--- +id: delete-oauth-client +sidebar_label: Delete OAuth Client +hide_title: true +hide_table_of_contents: true +api: eJztW1tzEzkW/iuq3ocBKrYTx0mIX7ZMCFuZCgObS/EQUoXcLduCbqlXUgPeVP77fkeS2247IcBQOwPVL2B3H537OfqOIt8kuhSGO6nVSZYMk0zkwolXvHKzo1wK5ZKtxIq0MtLNk+HVTXJphTnSyonPbgQiPEtsOdS0oJP6FcOCKz4VyfXt9Vbi+NQSzSsiZoGlTfAiEzY1siTBEHsxk5YF2ZZxxQJ54NeFCiU3vMBLY70SktaUHOK3EoUX+CYz0jSdiYInw5vEzUt6ap2RaprcbiVG/KeSRsBGZyqxKV80ZDLPTnzmRZkTHzHZfTo5HOwODsThYG+/P94bj58O+gO+t797eJA9TchWI2yplRWWFOhvD+i/ppg/NEvJd2QUdBpsb2/SBB+xY2O0YR12JlxllMiYnDAHLckOYR0b62zO4DSpPvJcZuSkyJpY8rLMZerD2ntvie/NpnP0+L1IKcCloSRwMmieCcdlfqQzsenIdb+9kEp0poZL0lB4lVMsZOD4UWZYwQptBAssmQ4meLpuw7/wRHeHPeMZ7A32HUVj4CZnePoBvChBH1LoUkmsZ4sliCObQKl7xIoDwcf724f9wWR/wHn/6WDnYG98OOG7u9uHe4eHJL0Q1iKd7Ypsbgyfb4j+l1DCyJTlOkVE/guHGMHhe6+AF44l0onCPhwDz+Mr/E95G2hrM6O+jCp0i3H27Og1GxywnKtp5Z/z6ZoTVOfynAqpynM+pkdUIbA8MH5l5FSqu1QRqiqotp8fvxhdnl7gydnxvy+Pz/GJeG0U+UghWzNKS6iKXJjpT17jaMAnbplFC0idyLrsSeT6BAZxZVcJZfhm5xbORG5NeJU7rIjS71ixyppNjC4apZSGdsYeya7obrExPSu4S2dszC0WIIRE/mSUpqJ0ndPoySdsJngmzOMuG2WZJCN5zlCNYIr1czBiPMuodAODSYVShjLSzXTlmNJOpqIZi6Urm9FAEUjnKU5Xg0LFAc0fzpNR6ioo581crcI6W6KKMT7QOXiuqd3FitO8S+fK8RRW8Dyfw43GwMNsDNuks4tOR+GyaDxqQVd3rNvbpVm+3b0Myjx32r9LeWW/ou5e52g/HW9a/eKjiMWHNNCxG/loLMIUOxJektl+caSqw7UofDaRIs/a2m1rt63dr6zd9ZdnERnFtx767GxCn0tFMFIbv3luQB/js0dptiDy8CYGcovBIREi/f7mAoX9QSiiF59Lgn0/EB+FrXxD+VEdj/B8TPCjDlYjFqSg92OwYIJOJLKh13upsXdUcNXuprQX2owlElTdARHRNQ2b64pxuMxUSpEm3G6xTAurfnNsxtEfOSrC2tABSarKOqWWAW63SLJFku1u1O5Gv8Zu1CLJtnbb2v05a/eLSLLWyldLxEm2Kgpu5iHT4nuyljMQsMUZHatLzodqHa0QM1ZjrKSJHJJxf2e8MzlIxSDjg2x/93DST/f7fO9g52BnPOgfJKt7/dWyjusia9bUSrxDHL2LAeI+AsdVCsllndZZ8/gP7jViQm2NWk+Nm+FzuPR6iR3vPIV0sA2MgR3NPceLl2enxB+iPXvym65MKghmB9eBnDsPKSmH4WlpXQsdW+jYbj/t9vPLbD8tdGxrt63dn7N2vwk6Dh6CjoNvgI4DRhBrQhDrr4SOGXAHQbMJggIb0gruVQQbS5iCT/H0MZa942YqXA30Giiyf7iJIi+0Zi+5mi/Akm2cRKqlu6i9gbYgWrOgBQFnU7RIxdC1JNAtZZUsBGFS5A/LZSF9HZNB4GvmndHEwapQM4t8q6VIleYVNPRNIdd09qqRYxLpJCYE/8DBn4NO0ah/4BlnjNafOg9mZ2TxKVnMjj+nQlDN1+e/e3fdEjiB8obaxXmI9T3XBcKZOVcYI8TnMrSvGoK2UL2F6u123273v8Z230L1tnbb2v05a/cboHpEQ/dDdRB8NVQHbXeb1VjqBSXX/x2x+1KJGvj0Zjr1WD1bYnCPK5BKyyu61EboAuww6a1evrW9G5ndJnRpl3BhUKkyOehmzpV22OvdIFKI0G2Xl7KLBoZgubnSn7qpLnpjuOeOzkMXTUOVEQEbvT6JQ0bX+9ZISt/Q6zzz4GlvDSUqPO7vFnyRM13kpRDOMX+wwGaLIdVjKvnHULHEHPGb9dRdnzob9sGuS5Pf/nlbAqN7bLnLfV+UBnoGTddMJBOul3eszwl0B+kbN62XGwkFvL8hzF9g7rNnghtMBOEGzKPf31w8ZlOCmr7UK0soV0iaDVAsr5EivpWNFrdBaJHfXYyupjOv+Khx34ZKh01yGMzeqnMh2NVJdMIf6PFnaMrepbRI+D5Aq64fLaKTiY8ip+2vu/QkJZ7MVA8e6vHGusd+q/MzgVT4WPin3beqw55L6kCStmyiiSb6EY9dlQu7+Ipd36vEPxbcOoFbx3Ozj9e0CK69ihfIU9QvseC59d76buGBX2eFHw1QeEJc13UgT0Q9mrek0kXUvluPBr8O8Wvq8Va9mUnso81lLLQtZrEN5hk7YelMayv+yRilDpXB1bRCFX23Wp9IaCe0wP72ikqdILIjO0CFXr9TFIYKycTHtCt7UKLD+YgvyXc+sqj5d5iZM/auYbN/fIXNkygzndrv1pkEdkhgJ/QAG/UPexMlFmqbbPB9ICTA0TL+vhNERVf6XuB1Z1f37Ht+DW0NKVT1XGw5DF+GywYXPzH/gqhrGrRhAtX1vTF8Z5EXbVANZy2OA9Y9uKlvrrEvrvkt6Fv/UZP2yr+bvWTxaHlq8krl8x/dpe/pJH+fvvsXdby20/yKnSbCXEo3LzbOA6tJ/izitc1TPDpmngn8i7e+Vj2ixrziJzCPYlYZlTl3lNW+qtOZFH7+LwV3hP22KLN04SsRozqVP6Y8z2hqQIOytcCkfCxz8PMn1AvJ3BdMAJYUV/puq3hfQiMlMU+KLnuDkUylCAuNY3RTF+/e6ziXnSMyrymw7Pki2ABdRVEpSKO6rArGkVIPZEQmbVqFxoXpTImFL7SHfvWqRRVTqpEJXT+YmMK+mtDRMqbWlcA/IAtxt/FcGa6nKMYf5y0NORO5z0yia8L2h3gj2zozkZc0EKLrAoCJFQkvTy42OIKZin/M0Gbai4tsj2jBhMajkD673Z3udsePC3heauswwjbUp4mLrf6GcT0Fb5an6Q/+mDHuDwTseyUdRpHUKgwaYaa7ShozHdYMZUa/mpxBN3p9c0PHFTTl3NJjjOk0C19dLwcYP/jBd/QZU+ME1bz+q8dVnR+dxd9HPvZ/cNn8LeSdSi/O2dR8OWIn+PhB0GSOdZhfobQ/OvEKhRfhcGVlycafH2gkqgfe58enxxfHSUAYd22w8QPsRwv5H5SOiU0= +sidebar_class_name: "delete api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Delete OAuth Client

+ + + + + +This deletes an OAuth client. + +## Request + +

Path Parameters

+ +No content. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/delete-password-sync-group.api.mdx b/docs/api/beta/delete-password-sync-group.api.mdx new file mode 100644 index 000000000..39a762a07 --- /dev/null +++ b/docs/api/beta/delete-password-sync-group.api.mdx @@ -0,0 +1,83 @@ +--- +id: delete-password-sync-group +sidebar_label: Delete Password Sync Group by ID +hide_title: true +hide_table_of_contents: true +api: eJztW9ty2zgS/RUU92GSlCnZ8i3Wy5ZiOylPOYnXl8qD49pAJCQhoQAOQNrRuPzve7pBUtfEmUxqZyall1gigUbfTuM0hNxHNldOFtqakzTqRqnKVKHOpPd31qUXE5O8crbMo42okEMfda+j+p2gl4Lf+uhmAzN94nROkiDncqS96J2diCDQi2KkhM9VogdapSKvhXgSMiQhLdEThf2kjLjTxUi8PX/1397R65M3QpbFyDpdTAREOvVbqR0kFFYkMssgNyzUgopeJSUNhJr30ZVX7tCaQn0uepBAquvUdOuVY1o55pXjsTRyqMbKFN07zFfRzQMMyqWTY+juPMvTZFYuIWkjMniBbzqlRZORGsuoex8Vk5ye+sJpM4weNqJa2ahbuFItu0iJkyNhB6u8QfYF15Fh6rMc5xkJ33v+fGuwt70Vb/fT3Xins7UdHyT7u/FztbmbJNtqezdNI9LeKZ9b45UnzTqbO/Rnfv038CD5xxQiFtqkOpF1oEhx5QtxJ73wZZIo7wdlJvplQa+dokiY6XTo2qdJRekMQqNNJSRo0CJX7GxuLmtwmGmafuycddDhvBEwmNOib1OOvTa3MtMpOaRamUTKPM9IdYhsf/Qk9345Jrb/USUFJuaO8r3QwS+pKqTODm2qluO3GK6X2ijki9SkoWKVE0wUkHirU8wQYwvPBJEUVTKBx81HEJ5obYkXMoW9wb7Dyhi4qXAy+QRZhMXHFLoyGvNFPUXoVAyg1BeWVftK9vc2Dzo7g70dKTvPd7b2d/sHA7m9vXmwe3BAq48RZwDBz6wtnZOTpaVfKaOcTkRmgUH9OxzilITvWQFeHFMApLF/PAYs4xv8T3AJYxszK30FYXxDSPHi8Ezs7ItMmmHJz+VwwQkmvrog/JZZJvv0iIAJy4Pgt04PtVmlijLlmCrI0fHL3tXpJZ6cH//n6vgCn0jWUvnrmRpRUBW5MLJ3rHFlAOMK6E4KlbbEs0rqMxgkjZ8dqKvCOfFwJnJrIMuswIxq9RUzZkWLgbPjOSgloSCKJ7qlWhtALZ6NZZGMRF96TLABus96wHxexKeVJ5+JkZKpck9RpNNUk5EyE0AjhGL+hOAv03SK/UEJKCuu5BZFw9hCJwuVbOrK+WgABLrgEaezQSFwQPPH86SXFCWUYzNnUdhkS6ViXfHSynPz2l0uVsGJKWQCK7DnTOBG5+BhLoi68E0h1OR77Cb1uKZiPTxMzeJy9zooc1RYfpfI0n8D7s4ylJ+YTWte3KoKfJ7qcKhGHI06TFVFwksymydXo5pw1cAX2JyzdI3dNXbX2P1G7C6+PK9YT/WWqc/WMvW5MhWtpc1zifo0DKsexPSmCuSGgEMqivTru8uKNGO8+pwT2/yB/Chs5UvK95p4hOd9oh9NsOZiQQqyH4MFA1QilXZZ76nG7Kjgqu3l1V5a19dIULOCIqJqOjGxpZBwmSuNIU2k3xCpVd78UoiRRH2UzGBDBaRVTRrnVptizSTXTHK9G613o59nN1ozyTV219j9Z2L3q0yy0YrRUvEkX47H0k1CplXvyVopMKA5fxMN5DhUi2yFhImGY0XzzCHqd7b6W4P9RO2kcifd2z4YdJK9jtzd39rf6u909qPZvf56iuMGZPOYmol3iCO7GCTuFjyuNEguX1ibzh//wb1ODaisUelpeDN8DpfeNNyxc7DMHS+tFa+lmdQMyc9xSDP1EdU0jB3TWFePxQAphqiLRqBUaehFqaTHClIckkZkeqwZvGQF5LpJ3BsUMCUAZfEkFN+TrISGXAkyS6zZIrE0jFQD4nyQwAx2iOr8A9lpFaI/xeTFOVl8ShaL48+JUgT0hrnvrjrfPYHyjmrERQjwFw56Q7cjDRIADUGoWQ3vXPPzNT9f7/HrPf7n2OPX/HyN3TV2/5nY/QP8vGJDX+bnGPDN/BxjW5ui4VIvKbn+7zSdoVJpwOktbJKUjo+baw7OvAKpNL1HQmWEbkx0o/aKexe+fa/TB763QfQwaFa6DMNHRZH7brt9j4AhUA8tmesW6hhiVkyMvWsldtzuw0srChDdFAhgowF8CSUs0GIXO01ZHEoeCw8OZ6MoX+F4Phz+qmS6AEKRnNgSRY7FbAhkfJVR/Bgq5mgnfvE8usUZtGQf7Lpy2cOftyUI+oItq9z31dUwXkDTBRPJhJvpNZsL4t5h9aXLNtP9hPq1ztJib2lYR7xQ0qExCD9hPPn13eVTMSTGyYgvPZFdpalFAGbOkCJc0Xr1cT5N4k0G2TQcseK9uR9MCEFikMFg8d5cKCWuTyonvEGpP0dtZpfSJMXlgGbdPKmjk6pbldEu2Jp6khJPp6YND7Xl3LynvONxa6ANPo75aeu9icWRpkKkaeemMZWJ3OmJ67y2S87Y9b1K/KuWFgdpMUvzTxe0CK69TsIFnAQwJhEy8+yt7148yItn5FEfhSckdVEH8kSlx/zPXEkdte/WY05eTPLm9Xhv3o00ttP5aSJUL+GxG2apOBHJyFqv/i0EpQ7B4HpYAkXfrdYdLRozIuLO5oxKcVgy1jHIIet3CmCYkEyyT5szcxML2mbSAMkPHFlg/gNa51R8mLOZH19jD6WRqU38d+tMC8a0YBxqgK/0D1sUJRawTTZwHQgJcDiNP1eCStGZuhdkrazqLL7Nc/h2HVRlKT7vhi/daYGrPgl+QaObMSjDxK2bH/7oqmAli/apOWfVpwKLHlzWN7PYHhf8FvRtTqVoy/y72UsW96aHJ29NNvnRVfoLleTvU3f/ooq3rjQ/Y6Wp2C6lGy9btQWzSf6i4mvLh3l02jxS+BdvGatMrNG2hIvPxGJmBeWZLCirGdXJSCs+BsiVLIj7bVBm2TEjER07wR/NHgsaOowBbD04qezrDPL4oLpeWTJgArGkuNJ3X3IvwrerR2grVUu8Q2dmEoSFujK6aoF3H23Vnl0gMmcUWHFUBxukazwuDd3XhtrlWEik1CMZkWqflKFwoUkzqvaFZerXzKpRTKlGJrS4P3Fj/3ZAJ8xoXmcC/8haiLuvjpfheopidal7asi5yjgzadw8bX9MNrItHqksp74QVRcETM2s8PrkckkihBkPu9B/WzdsV5N8m8ZCCLVHIX22W1utzZjbBTzPrS/Qyc6pT42XWHFLX/Qn4uRoMR/vpyfsf82l/WoHotahndOpF9lVhlYmNI/X0armEVO7OqX/eTCCE2jU/T0dj1A79UCPfysV9d7XN9NOiTtMBIk+o0sdoGwsXsuf9ceT80rxp+IPXNZfaVB92Gcm0z4/wsdPio4HNN3Zx6hwfsNahhfhhGdmytJvINSQNV330fHp8eVxFPjNqu29+gCnoID9D+zQhPI= +sidebar_class_name: "delete api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/delete-personal-access-token.api.mdx b/docs/api/beta/delete-personal-access-token.api.mdx new file mode 100644 index 000000000..34154684c --- /dev/null +++ b/docs/api/beta/delete-personal-access-token.api.mdx @@ -0,0 +1,95 @@ +--- +id: delete-personal-access-token +sidebar_label: Delete Personal Access Token +hide_title: true +hide_table_of_contents: true +api: eJztW1tzEzkW/iuq3ocBypfEcRLil60QwlamwsDmUjyEVCF3y7agW+qV1IA3lf++35HUtjt2CDDUzkD1C9jd0tG5fUffUeSbRJfCcCe1OsmSUZKJXDjxWhirFc8P01RYe6E/CJV0EivSykg3T0ZXN8mlFeZIKyc+u8PKzfAsseWomHfLOLfL/eSuo9l2VHDFp4KklCOe5w8Mu7697iSOTy3JrbVhQR3m9bEJRmTCpkaWpD10v5hJy4IBlnFWr8DCCsyv0IMGJTe8wCBjvSWS5pYcNnQShRf4JjNSNJ2Jgiejm8TNS3pqnZFqmtx2EiP+U0kj4DBnKrGuh9i8OPNyxWdelDkJFJOdp5OD4c5wXxwMd/cG493x+OlwMOS7ezsH+9nThLxghC21ssKSJoOtIf3XXO8PzVKKhHI9Um64tbU+5iiXeM+OjdGGddmZcJVRImNywhzUJYOEdWysszmDF6X6yHOZkbeiaBLJyzKXqU+W/ntLcm/WvaTH70XqyM2GUsvJoHkmHJf5kc7EukfvOvCFVKI7NVyShsKrnGIig8SPMsMMVmgjWBDJdDDBj+s1/AtP9LbZM57B3mDfUTQGbnKGpx8gi9L+IYUulcR8Vk9BHNkESt2zrNgXfLy3dTAYTvaGnA+eDrf3d8cHE76zs3Wwe3BAqxdICiS6XVmbG8Pna0v/SyhhZMpynSIi/4VDjODwvVfAL44p0onCPhwDL+Mr/E8JHMYuzIz6MsJ7B+B6dvSaDfdZztW08s/59I4TVPfynBBV5Tkf0yOCCiwPgl8ZOZVqkypCVQWh/vnxi8PL0ws8OTv+9+XxOT6RrDXUHwJWKqO0hKrIhZn+5DWOBnzillnUhNSJrMeeRKlPYBBXdnWgDN/s3MKZyK0Jr3KHGXH1DTNWRbOJ0UUDSmkojuyR7Ileh43pWcFdOmNjbjEBIaThT6iola57Gj35hM0Ez4R53GOHWSbJSFQRoBFCMX8OQYxnGUE3CJhUgDKUkW6mK8eUdjIVzVgsXdmMBkAgnR9xuhoUAgc0fzhPDlNXQTlv5ioKF9kSVYzxgc7Bc03tLlac5l06V46nsALbxBxuNAYeZmPYJp2tKx2Fy6LwqHrcomLd3i7N8uXuZVDmudP+Xcor+xW4e52j/HS9aYsXH0UEH9XzWI18NOowxYqEl2S2nxxHLcJVA59NpMizFrstdlvsfiV27748i8wovvXUZ3ud+lwqDoKqjd8816iP8dmjNKsHeXoTA9lhcEikSL+/uahZnGXic0n87wfyo7CVryl/uIhHeD4m+rEIViMWpKD3Y7BggkokspHXe6mxd1Rw1c76ai+0GUskqNpAEVE1DZvrinG4zFRKkSbcdlimhVW/OTbjqI8Luos5tKrKuqWWxExbJtkyyXY3anejX2U3aplki90Wuz8ndr/IJBdaebREnmSrouBmHjItvidrOcMAVp/RsQXkfKjushUSxhYcK2kyh2Q82B5vT/ZTMcz4MNvbOZgM0r0B393f3t8eDwf7yepef7XE8QJkTUytxDvE0bsYJO4jeFylkFzWaZ01j//gXiMmVNao9Cx4M3wOl14vuePGU0gH2yAY3NHcc7x4eXZK8rG0F09+05VJBdHs4DoM585TSspheFpa11LHljq220+7/fwy209LHVvsttj9ObH7TdRx+BB1HH4DdRwyolgTolh/JXXMwDuImk0QFNiQVnCvItpYwhR8iqePEfaOm6lwC6LXYJGDg3UWeaE1e8nVvCZLtnESqZbuovKGsQWNNfVYDOBsihKp6A/wEuyWskoWgjgp8oflspAex2QQ5Jp593DiYFXATJ1vi1WkSvMKGvqikGs6e9XIMYl0EhOif5Dgz0GnKNQ/8IwzRutPnQezM7L4lCxmx59TIQjzi/Pf3U23BE6gvKFycR5ifc91gXBmzhXaCPG5DOVrQUFbqt5S9Xa7b7f7X2O7b6l6i90Wuz8ndr+Bqkc2dD9Vx4CvpuoY29tiCy71gpLr/87YPVSiBj69mU49V8+WHNzzCqTS8uIvlRG6CTtK+psv6PZvZHab0F1gIohBt8rkmDBzrrSjfv8GIUOobnu8lD1UMkTNzZX+1Et10R/DTxtKEN04DXCjAezw9UnsNnreyUZSHoei54UHl3uzKGPhen/J4IuS6WovxXKORoQFMR2GnI855R9DxRINxW/Wj+75HFqzD3Zdmvz2z9sSBN1jyyb3fXE1jGfQ9I6JZML18ur2ObHvsPraBe7ljkLn/oO1xV7RsAF7JrhBaxCuwjz6/c3FYzYlzukxX1miu0JSkwDU3L25HSb5bcboajrzih82Lt4Qhtgkh8HsrToXgl2dRCf8gWJ/hursXUqThC8INOv6UR2dTHwUOe2DvaUnKfFkpvrwUJ835j32e55vDqTCx8I/7b1VXfZcUimStHfTmGii7/XY1cbb3d+rxD82I+3xHS2Ca6/ScJE7BZBJBM+t99Z3Lx7kdVfkUSeFJyT1rg7kiahH87pUWkftu/VoyOuSvKYeb9WbmcSG2pzGQv1iFvthnrETls60tuKfjFHqEAyuphVQ9N1qfaJFux4R3cHWikrdsGRXdkEPvX6nAIYKycTHtD17dqLDQYmH5DsfWWD+HZrnjL1r2OwfX2EXpZGZTu1360wLdmnBbqgBNuofNilKLGCbbPB1ICTA0TL+vhJERVfqXpC1sap78X1X/0wkhapeii1H4ctoWeDiJ+ZfJJ2VMSjDxK4XF8jwnUVZtFM1nFWfC9z14Lq+ucYGecdvQd/FXzdp0/y72UsWHy6PT16pfP6jq/Q9leTvU3f/oorXVppfsdJEvkvp5peNjcFqkj+LfG39OI/Om2cC/+Ktx6qn1mhcfCvmWcyqoDLnjrLaozqdSeEPAkrBHXG/DmWWLjwS0bMT/NHueUFTgzGArQUn5WOZQ54/qq5X5h4wgVhSXOm7reLFCY2URGMpeuwNejOVIizUl9GVXbx7r2ODdo7IvKbAsud1sEG6iqJSWI1wWRWMI6UeyIhM2rQKhQttmhK1L7SnfotZNYop1ciEnu9QTGFfTeiMGe3rSuAfWAtxt/GAGa6nKMaf6y0NORO5z0wa16TtD8lGtnVnIi+pM0TVBQETKyu8PLlYkwhhKv5VQ5tpP06yfRoLIdQehfTZ6W33trq+XcDzUluHXrahPrVea2S5/tllIxdvlufrX/17x7hhENPvl3RMRWpUofMI3d5VspmDYvJIZvRLyxm0pnE3N3SiQf3PLT1GJ0/t8tX1srXxLSG8Sp/RWE6A87u/kFw14tFZ/C3lY/83mS/8bnKjGfWZnJov2/EEHz8I6uIxD70utPfHLF6z8CIcxKxMWftTBXVNi+b4+fHp8cVxEkjIpj04foAjUGX+B0UGu94= +sidebar_class_name: "delete api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Delete Personal Access Token

+ + + + + +This deletes a personal access token. + +## Request + +

Path Parameters

+ +No content. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/delete-provisioning-policy.api.mdx b/docs/api/beta/delete-provisioning-policy.api.mdx new file mode 100644 index 000000000..476bec442 --- /dev/null +++ b/docs/api/beta/delete-provisioning-policy.api.mdx @@ -0,0 +1,96 @@ +--- +id: delete-provisioning-policy +sidebar_label: Delete Provisioning Policy by UsageType +hide_title: true +hide_table_of_contents: true +api: eJztXG1T20gS/itTvg95KWzAQAj+cuWAk/MeAQ5MpbaA2h1LY3t2ZY1WI0F8FP/9nu4ZSzI2gbCp292sqlIVIc309Hs/PdbotmESlcpMm7gfNjqNUEUqUyepudYW93Q8PjGRDmaNtUYmx7bRuWicmTwNlG1crWG0DVKd0GzMPeC5VmQTJZIKBZEwCXGjswk/tIkK9EirUORWjpUwsZD4lyQYxqy0LuOuyMyvKnaTuif9NWFScXz64afuwcf+kZB5NjGpzmZCW5Gq33KdglxmRCCjCIvgLia1wLZVQU4Dwfpt49yqdN/EmfqcdUGBxNFh3Kly23TcdqYyBm+NqzvImchUTiFbapmKJmkTiflrjRgP8JdlpUCFa405N41OluYKDAQTNZWNzm0jmyU8NkuxTuPuvv4GUI1TrugfEOvqs5wmEU1pB3ubbzfebu2Em3ub8u2bjc2dsP12e2dnuC3bW+09EFvJFut3QMsu87W8OPEnzGil8ZhSS1zG/Vj0QxVnUOmRuVkTUjjZoflY2DxJTJqJa5lqk9tFSoWn2ZZ4D2t68dbEzQSGluIXo2OVkkFlGDprzomvOZNO5UxAeeMxhg0NHGP/tNcd9OA9oTg/OaDLB1cUPRlMvMOxoKAX4IkOFbmOXCU1ZnWr4k3ktcJiMxHn0yF4gK7gz3aVu2sEQqhGkCgkrQ14mEwVB0BgplM4fcmM7WCMF6YpBiRrhdNURZIDy4gX+6nCtegGgcnjTCBSRzpSL9aWoy5T0C6NHUHX9FT6OSAzBA9MKLxnClbzjcmjkMbkFpqh6YVxKFS9RqCcy9hr/cs8nyfhc3n2c1+QqWIVZLj9oBs9xDtYzuA1wxx07SwOFoS4jHtH3XeHj4nQi+Uw+hZqV0xopdqDJ6kd14HzIvfshS1WIBpzq17GB/2zJwh2oO03kix0lJ4gmo/3SCGcUpfAp+aaIh4rmBS5I5qJUWqmFV+7jH80OQchSPioG+FZNYiczpD/Z/RgVRaLlQrhNgu51YVd4+FEjWyaRxHJ1uiMZGSROxUSABWPYq6LA1w4b8KFVz9d9Q57/Kx7dtb/cESjj4pLR+GnD6fH5ycFneJPN7X487T3oX826J2W8/oHvaNBf/BjObVyp3fQH5SUjw6P9/9NM//VPfrQ++kELHw6Pj2gOr5CGXV1qKtDXR3q6vD3rA7IX5wOzwv8fEd9QKpsAs9C84Mi0d7Ypv8WE+WRIV/MkAGhWR2H1ND4lojwt7KZuJEWmTBAC2VHeSTgePQ45ZQTl9Od2lKV5SmyBGh5Io6DFrUP2xsbyxzsR5qm99IU4jbFaUFgtMDF0ITcO+n4WkY6pHbDr0wkK73Y+i+W6N4ul0cz/AUxh4nQJaIu004vocqkjvZNqFaV0kVm38NHm+NUUiIUilkOMNFZJyTTTA0040j6hOrGLfZH0ERrU7yTIeR18u17YaCmLJXBr6BFDe5jDJ3HGvPFfIrQYeHPK5ZVu0oO32zstbdHb7alREe2ubsz3BvJra2NvZ09assaU9gZTmQra8s0lbOlpT8oxKsORGTQw+r/QiGIVuieGeDFMUUjCOzjNmAaT9A/1XU3thDT8yuoR6b6/W7/RGzvikjG45zvy/E9JcTN87MFkET9JSR3hI9RkXW8ipU5iDrove+eHw4Y3/znvHeGK6K1tL/QjecRZbi4TswNc+wF4LhSEdRBWea1p/oaAsnYVgdq95edWSiTyrDMowwz/OorZlRJu9RTDaXAbSiIl7qlWmuIWtybygx4YigpoRkXuq+RRFWSNQ+9Jl+LiZKAF69aohuGmoSUEbBRBKKMZRD+Dur42B/lCGXFOyIGSSM2mUbuW7BFqcpFa5QZ7bBqFAoOcP64n3SDLAdzLGY1Cgtv8SzOM17oNbfI3eB+FpzFmQwgBbLyDGpMU2iYE6LObJEINel+KuP5uCJj3d2VYnG6++iYOcgMPwtkbp8QdycR0k+TRSseXCsffFwGXTZia8zN5DMSHpLYPNmPKsw1D3wx0ioK69itY7eO3SfG7v2Hpx71+KcMfTaXoc957LeFqXguQZ8CYc0HMbzxhuTtZQ+Rfvg08JvPGK8+J7Rp+g3xkSvlS8x3C3u4+0MG1XNjLdiCGGQ9OglGyEQq7DDfJcesKKeqreXVAMKHGg4ar4CIyJopgWRuSNM8Zogs7ZoIjbLxi8w3uoxgXQakVeOwmaDlyGokWSPJuhrV1ej7qUY1kqxjt47dv2bsfhFJFlxxtHicZPPpVKYz52n+OUkrBQYU+2+iCDk21X20QsREgbEai8ihMWxvDjdHu4HaDuV2+GZrb9QO3rTlzu7m7uZwu73bqNb6izKOiyBbjKmKvZ0dWcUAcbR/msdwLpsZEy5u/0G9qRpRWuNfUua4GTqHSq9K7LhyjzODbCAM7Jg+sL14fnpI9LG0+6EGevP706lXHYbLjCEl+TA0rW1WQ8caOtblpy4/3035qaFjHbt17P41Y/eroOP2Y9Bx+yug47YgiDUiiPVHQscQuIOg2QhGgQxBDvXGBBsTiIIrv/vowz6T6VhlBdBbQJHtvWUUOTBGfKS3ZTxYsgs7kXGpLkpvGDulsel8rKZXBMZIkbFA1tJAt+RVeqoIk9JbCJGeao5jEgh001mzO8oglYuZ+7+n4+8gysEhJ4XI0N6rgY9puJMaEfwDBd4HHSNRf8M9Tm+t37UfLE5J4kOSWPQ+B0pRzBf7vzur3hLog/mU0sWZs/UDrwu4PXN6rSJWnxOXvgoIWkP1GqrX5b4u999Hua+heh27dez+NWP3K6C6R0MPQ3UMeDJUx9jWhiiw1Htyrv87YudQ8RywewsTMFYPSwzOuAKuVB7xozRCR8U6jXUH2O367fwQ29368oE4TQOK42R3DTpYR8jRMZ2nEShNsiyxnfX1W9gSNrxryUS3tD8OEJubVmCm60MocEVuoldRXRzSADq859uQFms/1eTgLhsycWcLlpdcGTbhtw++SJkOxZGR+QVgR2aN3g32zsa3wWKCTuOF5dEtdq4l+SDXeRrd/X5ZHKEHZFmlvi+uhvECnN4TkUS4Ks9BnhEsd6svnYYsSw39INBeWuyYhrXFOyVT9AzuHZmXP3wavBJjAqOcDHJLOFhp6h4QTidwEU523fn7IjSJ609q8rE7ENpdeCOHgkuMIggsLuMzpcRF5UiJOEXaZpXSJMWZgmZdvZxbJ1TXKqIC2So1SY6nw3gdGlqXC/NecTHkrkHHuJzOD6A2xYGmHEVHCXiMF5GbQHGRzOWSFbmey8Q/5tSajlqTqdlX97hwqr0I3BveASKcSMjIsraevbij16zQoxYLd4jqfR5IE56PxfeogrnVns3HAr0m0Vvk4zL+NNGotIvThEtswk74FEFfBBNjrPqnEOQ6FAYX4xxR9Gy2bmjRJkdEs71RYanplmzqJnAj83eIwIidM8kh1W2GLcbtoHBI/syWRcz/zMeSfl6QmW9foLzSyNAE9tk804JNWrDpcoD1/LvqRY6F2CYZOA84B9gv7c+ZwDNayXuO1sqszuTXeQ6VhgCsMhWbdNwfnTLB+SvBD2h0MQZpmGB38WYZndbwtKiELShrvmFwX4PL/EYGlfOe3hy/xc+eVE3/bPKSxN1yX+U4jmbfOks/kEn+PHn3D8p4dab5HjONB8Lkbrys7xiqTv7O47Xlfb7iWBmecqwy5kZHU37WokqIjsKRV3NUBxOteIcgUTIj7LdGnmWmHImA2hT+6AOZ0JiP6KVgWaKn0xHo8R72fGXJAeOAJdmV/ra5f6PCwCXRcaqW+ERnCQOYhRo2epcXz+hEIDN6BsuckGHFwdzYAF3TaR7TBzXAdj4VEi71iEeE2ga5S1z+/KUTwTD0K2bNo5hcjURoceuSTu3xiDaf0ddWDP/IWrC79TvPUD1Z0X/oohTklI4vUvLAuEXY/hhteFtzoqKEWkZkXQAwVVnhY3+wRBHEYv9zh0nH636SXaexIELtkXOfrdZma6PJ7QLuJ8ZmaHIX2KeeTFS/uyLch1fEcCbKU4j33PK23IP/k359xVcqajHWE9o4I/lz1/K4/vPCfzuF7NWpfEZlZQtKY8pvmqCrmUCVROP2lvZfqCm7o9u/5Yqa+4urst/iPnV+CrU4yP+gOl+eerFe8S9IC99lWSnUfM8wnpXbBQ1c/qpol6EQjLrJZ3NRH8Gvj+DXR/DrI/h/iyP4X59ky8pwd4XBbsud87577jblKzOXframjbJio7T4bot8oO3yFygzAJb/A20jDNQ= +sidebar_class_name: "delete api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/delete-reassignment-configuration.api.mdx b/docs/api/beta/delete-reassignment-configuration.api.mdx new file mode 100644 index 000000000..16cef533d --- /dev/null +++ b/docs/api/beta/delete-reassignment-configuration.api.mdx @@ -0,0 +1,83 @@ +--- +id: delete-reassignment-configuration +sidebar_label: Delete Reassignment Configuration +hide_title: true +hide_table_of_contents: true +api: eJztWltz00oS/itT2ocDVOQbCSF+2TJJ2MqpsLC5FA8hVYylsT0gz4gZCfCm8t/36x5JtuyQsBxq9xzKLyBLPX3vnq8ncxPZXDlZaGtO0mgYpSpThTpT0ns9NXNlikNrJnpaBppoJyrk1EfDq+itdR/FKmF0vYPlPnE6Z9JhdMTMvJBZ1qIULZ5iYp0oZkr4XCV6olUqdAoqXSwgzqukdPQ4vLqJLr1yWFuor8WoLGakhk7N0K3wjpNV3sNgT3R9C+Vy6eQcv5xnZppUzCXY7EQGH/CrlgtXQHIyU3MZDW+iYpHTV184babR7bqZpdGfStUojQesdupTqZ2CTwtXqp1IfZXzPCM2g+Sg/7z3fP95X+7303Tc6z/vjw96B73xXrLX21UR6eqUz63xypP8QW+X/mtLvcehweiUNN3t9TaXHmaaFh07B8/HCE1ROkNun3AcSHXlCzG2KYzxQpvPMtNpB1Yl5HyEGixlnmc6YYHdD5743my6zI4/qKTAwtxRnhU6GJSqQurs0KZq073r3n2pjYqnTmrSULHKCRYKcPysU6wQc+uUCCyFDSYwHSm8dDs80emLFzKFvcG+w8oYuKlwMvkIXlQDDyl0GcJdL0G4mwy+Q6zaV3L8rHcw2J0825Vy8Hy3v783PpjIp097B3sHByR9rryX0+CaSrZ0Ti42RP9DGeV0IjKbICL/hkMo9asSYuFYogs19w/HgHl8h/8vYFegbcys9BVUhztCiheHb8TuvsikmZb8Xk7XnGDiy3MqszLL5JheUVHA8sD4tdNTbe5SRZlyTlV+dPxydHl6gTdnx/+6PD7HE/Ha6Dgjg2xNKS2hKnJhZr+wxpUBX6QXHsWRoDo64knF9QkMksavEurwyy88nIncmsgyK7Cikn7HilXWYuLsvFVKSWha4pHuqM6OGNO7uSySmRhLjwUIIZE/GSWJyov4tPLkEzFTMlXucUeM0lSTkTITqEYwxfoFGAmZplS6gcGkRClDGV3MbFkIYwudqHYslq5sRwNFoAumOF0NChUHNH84T0ZJUUI5NnO1CptsqVSs4gOdg+fa2l2sOI1dujCFTGAF9pAF3OgcPCzGsE0XXlTtiMLl0XhMTdd0rNvbpVnc7l4FZY4Ky98SWfrvqLs3GdpPzKY1Hz6rqviQBrbqRhyNOkxVR8JHMpsXV1RNuOrCF9j1snRbu9va3dbud9bu+sezCjBVXxn69Dehz6WRAI7W8ea5AX0cZ4+xoiYKeCoEckfAIRVE+v3tBQr7ozJEr77mhPR+Ij4KW/mG8qMmHuH9mOBHE6xWLEhB9mMFsdGJVDpkvZcas6OCq55uSntp3VgjQc0dEBFd04mFLYWEy1xpDGki/Y5IrfLmt0LMJPqjREV4HzogSTVpnFttii2S3CLJ7W603Y1+nd1oiyS3tbut3b9m7d6LJButuFoqnOTL+Vy6Rci06jtZKwUIRH10J5qS41CtoxViJhqMFbWRQzQe9Mf9yX6idlO5mz57ejAZJM8Gcm+/v98f7w72o9W9/mpZx02RtWtqJd4hjuxigLjPwHGlQXL5wtq0ffwH9zo1obZGrafBzfA5XHrdYMfBwSZ2vLBWvJJmUSMk38KQZukj6mmgnROtq2lBIMUUfdEItCoNvSiV9FyBi0PSiEzPNRcvWQG+bhGPJgVMCYVSJ1kjRZskK6Ehd4LMEmq2SCwNI9WEMB84MIKdojv/RHRahegPIXlxRhafksXi+GuiFBV6g9z37jrfPYHyjnrEeQjwNw56w7QjDRIAA0HoWQ3u3OLzLT7f7vHbPf7X2OO3+Hxbu9va/WvW7n+Bzys09G18DoLvxueg7fREg6VeUnL9z2E6l0qlAae3sElSOj5urjE44wqk0vL+BrURutgwjLrfvhvhuzfL+w63fNWC0GJQtHQZVs+KIvfDbvcG8UPcbjsy1516kbFfOomdd8dw2h39iC4OhNojAjF6c1LNGx32uNOU1KEDMvPgf7aR0hdx4LPieznTtQ0K7MKW6HnMZkegAKoE49dQMcd08Ztn6g4n1IZ9sOvSZbd/3JbA6Bu23OW+e6WBXkDTNRPJhOvlzZhzguJB+sb9mOX2QuPbYEPYayIbiBdKOswJ4S8aj35/e/FYTAmAcgMoPWFfpWliQAm9QYpwgxvVp/u0iPccZ8vpjBUftf5+QgUlJhkMFu/MuVLi6qRywj/R+c/QqtmltEhxd6BV14/q6KTqs8poU+wsPUmJp1PThYe6srXuMW+APClog8c5v+28M7E40tSXKPWZpjKRBz9xldd2yRW7flSJv9Xc4sAtZm7+8ZoWwbVXSbiPk6CqiYXMPHvrh4UHfvEKPxqr8Ia4rutAnqj0aP/VK6mj9sN6tPjFxK+txzvzdqaxu7aXidDMhMfmmKXiRCQza736uxCUOlQGV9MSVfTDan0hoTFXRDzoragUB5GxjoEVWb9TFIYJySTHtFczVLFAcSYNJfmeI4uaf49JOhXvWzbz6ytsqUSZ2sT/sM4kMCaBcegBvtI/7FiUWKhtsoH7QEiAw2X8uRNUiq70vcDrzq7O7Lu8hu/CQVXm4vNh+DFcNrjqSfAHom5o0IYJajd/B6SbgBUv2rZazqoPCdY9uKlvZrFbrvkt6NscUtEO+mezlyweLc9SXpts8bO79Dc6yZ+n7/6fOt620/yKnaYCv5RuLLaaElaT/EWF1zbP9ujweabwL75yrTLOxhTDcxmjmFVGeSYLymqu6mSmFZ8K5EoWhP12KLPsnCsRAzyVP2Y/ZjQFAqejaQ9MKsc6Az8+t64lSy6YACwprvTblzyakKxkhilTdcRbDGomQVhoSKObF/j2wVbT2jki84YCK47qYAN0zeelofvIULucC4mUeiAjUu2TMjQuTApG1b6wDP2aVXUVU6qRCR0eV9zcv57QgTNm2ZXAPyALcffVaTNcT1GsrmIvDTlTWZhXQNeG7Q/xRrbFM5XlNCai6wKAqRUJr04uNjiCmfGwC+O4ddNutch3iRZMaDwK6fO00+/0Yh4X8D63vsBg21Kf5rB7br2vJ+TN8sT9p9ybr3YUGgW6OR1qkZ5lGE3CbHgV3TMbgsNw5TY8xo0ZbKRFNzd0GELT0i29/lQqmrSvrpeDEA+QiAE9YyadoCuoe6x9dFZdlX8s7rxJf6cl9SGeWSzn9wiPHxWN/SuaY0iG7nw+w3oFgnCCs7J0428cNGE1U/XR8enxxXEUAMtd+3X1ADegI/0HtvZTWg== +sidebar_class_name: "delete api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Delete Reassignment Configuration

+ + + + + +Deletes all Reassignment Configuration for the specified identity + +## Request + +

Path Parameters

+ +Reassignment Configuration deleted + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/delete-role.api.mdx b/docs/api/beta/delete-role.api.mdx new file mode 100644 index 000000000..f1c49c16f --- /dev/null +++ b/docs/api/beta/delete-role.api.mdx @@ -0,0 +1,84 @@ +--- +id: delete-role +sidebar_label: Delete a Role +hide_title: true +hide_table_of_contents: true +api: eJztW21z0zoW/isa74cLTO00oVCaLzuhLXd6p9BuX4YPpbMotpIIbMlXkoFsp/99nyPZTpy0lOWyu/cy+VBwrKOj867nKMpNpEthuJNaHWXRMMpELpw407mItiLHpzYaXkX00UbXWxi1qZElUYP2YiYtG50esTDJMs6Iko3nTDrLjg6Sd2rEnP4oFPss3Yxot9jJ2a//HB28Pnqzxc5Ojg+bZ23Cx/PLl/4N45WbaSMdmFlmxO+VNCIDN5byPGeuXjthR4rxLJMk0xYkWFruPn4FnzOt8nmXE5MTRp9HaSqsZadGTyTUZlKleZVhaalAK4KK3ODPWp1K7oJU57oymBhWLrjiU1EI5dhnbT5Oja5Ky/SEfZ7JdBbYdISTZLxCFGNhEhi+5IYXMKkh899EkqxdcjfDkMIAPskMz41VoqEzldiKbDoTBY+GN5Gbl0RlnZFqGt2ueu7ogIRptAEn8YUXZU5TBule/8X2C777ov90e2+bb/fxtNMf9AX+nvVfRLfXtLAttbIICqw12N6h/7orvIGftHJkgRiWy2TKKUJoSZJaWFiGW2Yrb+1JlbNx5WgYhoUx1GI6bDumSa4yauGFRoKElNvZ3l6XYD+XNP3QGIRWzM5aBpOOFGOd+QiT6hPPZUbWr1cmlrwscxIdLHsfLPG9WbeyHn8QqSO3GUomJ4NdMuG4zPd1JtY9suqQV1KJeGq4JAmFFznFRAaOn2SGGazQsExg2fjO0yUd78ESSZ+95Bn0Dfrt18rATM7w9CN4UaI/JNClkpjPmilMZmwCoe5ZVuwKPn6+vTfYmTzf4XzwYqe/+2y8N+FPEUPP9vZo9QJ+RlLYpbW5MXy+tvSvQgkjU5Zr5Kf8FwxiBIftvQB+cUyRThT2YR94Ht9g/wvoFWhbNWt5mRNfHBWWl/unbGeX5VxNK/+eT1eMoOLLc8rQKs/5mF5RVkLzwPjEyKlUd4kiVFVQmT04fDW6PL7Am7PDf1wenuOJeK3V3ZFqMgqiIhZm+rOXuFbA5xUqcorKlLAnNdcnUIgru0wowyc7tzAmYmvCq9xhRr36HTOWWbOJ0UUnlXzefHHskUxEsoWsxbuCOxS8MbeYoEPqPqEKW7r4uLbkEzYTPBPmccJGdSHnOUM2gqmv1Uh/VPhF7k8qpLLwlVajaCjtZCq6vliYsusNJIF0nuJ42SmUHJD84TgZpa6CcF7N5Sxso6UWsal4WW25rnQXq1VwrhxPoQX2H+xK2hhY2BdE2kebQijJ9thZGrq2Yt3eLtTy5e51EObAaT+W8sp+Q96d5ig/sVetHfgk6uSzVIdDNRLtfgtL1BUJg6S2n1xTte5qEp9NpMizTe5ucneTu9+Yu6uDZzXqqUc99OmvQ59LVYNd2jzXoE+LsBoiD29qR3ogXkOk395e1HAa9OJLSVDzB+KjsJWvCT9q/RHejwl+tM7q+IIE9HYMGkxQiUQ29HIvJPaGCqZ6ur7aK23GEgGq7oCIqJqGzXXl0b6plCJJuN1imRZW/eLYjKM+8tAv+ApIq6osLrVUboMkN0hysxttdqOfZzfaIMlN7m5y96+Zu19Fkq1UPltqnGSrouBmHiKtHidtOQNBe/7G2pTzrlpFK8SMtRgr6iKHaDzoj/uT3VTsZHwne/50bzJInw/4s93+bn+8M9iNlvf6q0Uet0nWzaklfwc/ehMDxH0CjqsUgss6rbPu8R/Ma8SEyhqVnhY3w+Yw6XWLHQd769jxQmv2mqt5g5BsB0OqhY2opoG2IFrT0IKAsynqomIoVRJyUSjJQoCLQdCwXBbSJy9pAb5mHo8mDqqERFk9CW0Oqq2vBLkm1KwRWBJKiglhPnDwCHaK6vwD0Wntoj+E5NkZaXxMGrPDL6kQlOgtcn921/nuEYQ3VCPOg4PvOegN3Q5XCAA0BKFmtbhzg883+Hyzx2/2+J9jj9/g803ubnL3r5m7/wE+r9HQ/fgcBN+Mz0GbbLMWS72i4Pqfw3SfKrUEPryZTtPK+OPmBoPDCFbgpXRzv8glcP1+COURQDtlpszU0OhcxJUCcEs/imwYLmJQJWrGVkau6TpDIRCji9sv/gIGsYx6NMX2bmR2G9H6BDSDjpXJMT5zrrTDXu8GrofLbxNeygQVEd53c6U/J6kuemPY+45SRncOQtoSgb+BEhZIvLOMpHwIxdMzD67z5qHIhwv9MfNXOdNlEYqJua5QLj2bLYbcqWPTv4aIJRqTX6ynTnwsrukHvS5NfvvHdQmM7tHlLvN9dTXQM0i6oiKpcL0Il3NC8WH1taBZ7EzU+Q3WFjshsgF7KbhBixG+DHn029uLx2xK2NXXjsoSbBaSmg1k3ylCxNfGUfPFAE3y25XR1TTc/hl1vnqhXGSTHAqzd+pcCHZ1VBvhDTaNM1R5b1KaJHxhoVnXjxrvZOKTyGk/TRaWpMBDzPdgoR7vzHvs907fZEiFx8K/Td6pmB1IKmmSMADR1Cr6npFdlY1efEmv7xXibw23OHCLPTf7eEWKYNqrNFzlSVEQiAXPrbfWdy8e+MVL/KgjwxviuioDWaKWo/uFWdp47bvl6PCLiV9Xjnfqrb8v1p3GQrliFvtqnrEjls60tuLvjFHoUBpcTStk0XeL5S+pxT4j4sH2kkhxWDKWMWCml+8YiaFCMPExbfMe5WgAQJWFlHzvPYucf48mPGPvOzr711fYjYky06n9bplpwZgWjEMNsLX8YbOjwEJukw6+DoQA2F/431eCWtCluhd43VnVPfuen0NbQwpRPRdbDsOH4aLA1U/MDxB1S4MyTCi9/QqRLiDWvGjH6xirOV9YteC6vLnGRrtityBve75Fm++fTV/SeLQ4hjlR+fxHV+l7Ksmfp+7+nyreptL8jJWmxs0Ubn7ZusFYDvKXNV5bPxakc+uZwL8Y9bnqIToaoHDFmVDMMqMy546i2md1OpPCHyiUgjvCflsUWbrwmYjen9K/uSs9NaBB2lpgUj6WOfj5I+9mZe4TJgBL8it9tpXvavxt8BkaVJGwt+jxVAq3UH9HlzYw9kHXjd45PHNKjmUHjbMBuoqiUnQfHGJXBeMIqQciIpM2rULhQrunRGML7aFfO6vJYgo1UiHxnY4p7MmEzqrRBi85/oG14HdbH1TD9OTF+gL4QpEzkfvIJLoubH+IN6Itnom8pA4TVRcATCyt8ProYo0jmCnrb7on2kx79STbI1owofYohM/TpJ9sx75dwPtSW4eGqyM+dVr1LwZWg+9mcTC/+ZHBf+1HBvWeSs1Qr6QTQfJUFZqz0P9eRb7/Be1QZvT7jxn8SK9vbuisiDrCW3r9eyXoIOLqetHs+SYZcUbP6KwnqHziK15+dFbb/jFb+23CnXI255tqvjjaiPD4UdCJCKS9vQZVOLLysoSBcKi1NGXta5/OecDB4fHhxWEUgNhdOKR+gOqotP8GVXbtEA== +sidebar_class_name: "delete api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/delete-search-attribute-config.api.mdx b/docs/api/beta/delete-search-attribute-config.api.mdx new file mode 100644 index 000000000..10851e9b7 --- /dev/null +++ b/docs/api/beta/delete-search-attribute-config.api.mdx @@ -0,0 +1,84 @@ +--- +id: delete-search-attribute-config +sidebar_label: Delete an extended search attribute in IdentityNow. +hide_title: true +hide_table_of_contents: true +api: eJztW1tTGzsS/iuq2YeTpBgbiBMWXrYcIKc4RS7LpfJAqI08I9tKxtIcSZPgpfjv+3VrZnyDkFvtOUk5D8GeabX63l8LcZ3YUjkZtDVHebKX5KpQQZ0q6bJxPwSnB1VQ+9YM9SjZSIIc+WTvIonvRUsgIkUVGSWXG+DjM6dL/rqXnI21F/3XR0JmmSqDF9IIdRWUyVUuZMvFyInCq1xEKbwIYyUy65zypTW5NqPbVmXze3femr4I9oMy4pMOY/Hq5Pf/9A9eHL0Usgpj63SYCsji1J+VdmATrMhkUWCnKGEHWpbSQZCgHOl6nZBU0IF/bCSa9CllGCfLSr4k6e2QhW7F9NFSd0hL20ddad9GqGQvuEptJD4bq4lM9q6TMC1JBA8mhvygruSkLFgq9emF1EXrieTm5pI4kcG88rR4e7NHP5aEtSQJhAwiFRq2zWRjcBJD+SA+SS98BYd5P6wKAe702imyn5kthwoDWhQqZ6CwNjWTKEEnudlIeptbqxKcm9oj/8WqVJy0DIYL2zRE0V5jJXPlNoR1NZ34481Z7W/Qq6uSDEjGrMWjfWVZFqQfGHTfe9r8etW2dvBeZYG87ygjgo7GU85Ztyp8X0xgFjlSIj4fUGyy45l+3kMk4EdZ6DxqMIS3VL7Hcs8khtvoH5nq8epuz60b6DyHjit2EpVXTkxtJSRM5ipjSBLpN0RulTe/BTGWHxXnnffkKw50xGZaWm3CD7RUrgJU27e5ui1ilxTSRqUjJzUpwiZDOOVKgONHzXk+sY5sSyzbnCK6zoJte5ubnS3xTOYwSwza/VoZmDI4mX0AL6pr9wl0bjTWi2aJ0LkYQqg7tlU7Sg6ebu5u94ZPe1Ju/7O3tfNksDuUjx9v7j7Z3aXd6/jwc3tL5+R0ZevflVFOZ6KwKEScDE5JT5ECAZpw0kFN/P0+YB5fYP8z6BVpWzWbeA4oXRtCimf7r0VvRxTSjCp+LkdLRjDp+SmemKoo5IAeUdWC5pHxK6dH2txavEw1oSZycPi8f358hicnh/8+PzzFJ+K10jz6pilQEBWxMLafWOJaAS5TqKFZQOKLRzXXR1BIGj9PqOM3P/UwJmJrKKsiYEW9+y0r5lmLobOThfrIeXMVxAPdUZ0NFEE8m8iAaj+QHgtsrISP+tzz0uPako/qIvawI/p5rklJWVCFAFOsn1I1lXk+K6XDChmvuJ1Z1GBjg87Uoi9mplz0BpJAB6Y4nncKJQckvz9O+lmoIByrOZ+FbbTUIjYNJK8ttyjd2XJTmZogM2iBxjuN/T0L3F80oEHTVzTZfiJNQ6cNV1E0lJuZWockzYsozEGw/C6Tlf+CvHtdoPykrFr74qOqk49LZaxG7I3GTXVF4joac6What3VJL4YalXk69xd5+46d78wd5dfntQgkt+2UnG21DjJV5OJdNMYafV70lYKELQgVLQpx65aRivETLQYK1lEDslge2uwNdzJVC+Xvfzp493hdvZ0Wz7Z2drZGvS2d5L5Xn8xy+M2yRZzas7f0Y9sYoC4j8BxFWYG54O1+UK0knmdGlJZo9LT4mbYHCa9nGHHW4F+gG5gDOzolrBjw//85Jj4Y2tmT3azlcsUwexoOpDLwJCSYhiW1j6soeMaOq7bz7r9/DLtZw0d17m7zt2fM3e/Cjr27oOOva+Ajj1BEGtIEOuvhI45cAdBsyGcAh2yCuY1BBtLqIJP9eljnfZBupEKLdBbQJHbu6so8sxa8UKaaQOW/MJJpJmZi8obaCdE6xpaEEgxQok0AlVLA91SVOmJIkyK+BGFnmjOY1IIfN007Q8DtIo5s3yojO9ZUUFCLgqFpbNXixjTCCc1JPgHDnwOOkKh/oFnnLW3vus8WJyQxseksTi8ypSinG/Pf59sbq5yP4LwjsrFafQ1R/hdZ+bSYIxQV2UsXy0EXUP1NVRft/t1u/812v0aqq9zd527P2fufgVUr9HQ3VAdBF8M1UHb2RQtlnpOwfV/R+ycKrUEHN7CZozV8xkGZ1yBUJrdx+FLKWGM712ZZRg1gu/GmyVpe7MkjTdLutd0UeUGK+JgEOWsXIHF4xBKv9ftXsN9cNtNR5a6g6oGD4apsZ86mZ10B7DZLeUIzq7Tkwj4Mk/coMMGd5piOhZAZh7NzypS9MINfOHgs5xNfYNmiqFERDYbAvFfxxc/hoglhovfPFN3OJ5W9INe5664+X5dIqM7dLnNfJ/dDfQCki6pSCpckrsQB2DE/jqHPPuxevUrcvzF5TzNKaH1KOEK5awD0e8JtlcEekVk2+IZwgejRLw68+CPN2cPxYgwKteIyvNdK01DBbLsNcKIa2C/uUZCi7gtOVuNxqxcf+GiDuWcGBYwinhrTpUSF0e1oV6iOZygmrPZaZHiAkKrLh80HszVR1VQ3+zMrE3BqXPThRW7cmHdQ+6RPExog4+T5ipYKg40lS5NvZ5oahV5NhQXZaOXnNPrW4X4R8MtjdxS5uYfLkkRTXuRFZpKaIbEJxay8Gytb9488kvn+NHkhSfEdVkGskQtx+L1qqzx2jfLscAvJX6Lcrw1b8aaLsQtLBOx3gmP/lnk4khkY2u9+pcQFDqUKhejCpn2zWJ9ok1Tzoh0e3NOpDRumeoUcJLlO0ZimBhMckDtnNGMjQcrnLbv2LOoC+/4suK7BZ358QW6LlHmNvPfLDNtmNKGaawTvpY/NjUKLOQ26cB1IAbA/sz/XAlqQedqY+R1a+Vn9l1eQ+0jg6jMxZd78cverAjWnwS/IOqWBqWa0Hh74YxuV9a8qLMtGKs5R1i24Kq8hUVDXbJblLf9bSg12b+bvqRxf3bc8soU0x9dpe+oJH+fuvsXVbx1pfkVK02NjynceNt6kJgP8mc1pls9/qPz6bHC/3jLucpQHINOvCtOKGaeUVnIQFHNWZ2NteKDg1LJQPhwgyLLTjgTMeNT+mM8ZEYjBxqkrQdulQNdgB8fbTc7S06YCD7Jr/TdV/VFC4uQxCCqOuINZjkDtO9ojqMrvnj33tYD3Sk885ocKw4aZwN0TSaVoSvuELuaCImQuicicu2zKhYuzA9GNbawDP3aVU0WU6iRCh2eaNzEvxrSmTTG3TnH37MX/O7rA2mYnrxY37CfKXKiCo5MoluE9vfxRrSlY1WUNEmi6gKAqbkdXhydrXAEM1P/FsS6Ubde5LtECyY0QsXwedzZ6mymPFLgeWl9wOy7ID6Nagt/2rBy+x/Om4uwznKIXs+O6X+yv5mouxmNId2SztzIRlUcneLoepE0oyvPprcOr3izx9bErDOGgWnV9TUd1tA4d0OP/6wUnQRcXM4mNZ6YEAD0GTPzECVJfcawD05qRR6K7/6TjVvVbg4kzXR2FpHg4wdFRxisH0Z9aMinTCx9fBXPoeYWrfymhobA9mzg4PD48OwQJfF/UoksHg== +sidebar_class_name: "delete api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/delete-segment.api.mdx b/docs/api/beta/delete-segment.api.mdx new file mode 100644 index 000000000..e194289c2 --- /dev/null +++ b/docs/api/beta/delete-segment.api.mdx @@ -0,0 +1,97 @@ +--- +id: delete-segment +sidebar_label: Delete Segment by ID +hide_title: true +hide_table_of_contents: true +api: eJztW1tTGzkW/isq78MkFLbBGAg87JYDZIopclkulQdCbeRu2VbSLfVIaoKH4r/PdyR1+wYhyaR2Jql+AVt9dHTu+o6svm3pQhjupFbHaWu/lYpMOHEmxrlQrrXecnxsW/uXrThiW1froLGJkQXNwYzzibRs8OaYhamWuYlgNpAzW4hEjqRI2XDqH4zltVDs+LDzTv17be2VdmJ/bY1F7oEF2LKcg5x/BCOdC+Yk/dFsrJlU+C9GI5G4DnunBhj+CIafpJuw16e//m9w+PL4FdPGS8RLN9FGuimDiEb8XkoDScAg4VkGcYLgHahZcMNzSG9I2duWJMUK7iZ4pPAA32SKzzaZiJy39m9bblrQqHVGqnHrbr1VsW/tO1OKVSPNbHJ8SCIEa9Ha4obnRUbcxGjr2Wivv9XfFXv97Z3ecHs4fNbv9fn2ztbebvqsdXdFC9lCKyssidHb6NO/xcVeQUGtHNbqkGT9jY1VmoNMkixHxsBWbXYqXGkUjCNH3k2kjbCODXXqjSfVNc9kSuJG1sSSF0UmEx883Q+W+N6umkgPP8BZZGNDoeZkkDwVjsvsQKdi1ZzL1nshlWiPDZckofAiJ5jIwPFappjBcm0ECyyZDip4ukX7whKdTfacp9A36HcQlYGZnOHJR/CiNHhMoAslMZ9VU5hM2QhCPbCs2BV8uLOx1+uPdvqc9571N3e3h3sjvrW1sbe9t0er58JaPg6miWtzY/h0ZelfhRJGJizTCGL5BwxiBIftvQB+cUyRTuT2cR94Hl9gf4reQFurGeVlTty4dcbZ84M3rL/LMq7GpR/n4yUjqPbFGaVTmWV8SEOUJ9A8MH5t5Fiq+0QRqsypAh0evRhcnJxj5PTovxdHZ/hEvFbq0UAhWlMKS4iKWJjoT17iqMAnbpGJGcwh0g5bi1zXoBBXdp5Qxko2tTAmYmvEyww1Zy2ufs+MedZsZHS+kEo+b24ceyI7orPOhjSWc5dM2JBbTIALiXxtkCSicO2TaMk1NhE8FeZphw3SVJKSPGPIRjD1ZXIoGE9TSt3AYFQilYWviLp0TGknk6U6MzPlojeQBNJ5ipN5p1ByQPLH42SQuBLCeTXns7COlihi9A9kDpZblO58zmjepFPleAItULSnMKMxsDAbQjfpbFXpyF0WhUdVdHXFurubqeXL3csgzKHT/lnCS/sFefcmQ/lpe9XqB9ciJp+lih6qkfdG5aZYkfCQ1PaTI1XtrirxGXbJLG1yt8ndJne/MHeXH55GZBSfeuizuQp9LlTEhbR5rkAf46NH6Qo8/uHhTXTkOiHLCJF+e3sewSfoxU1B4O874qOwla8IP6j9EcaHBD9qZy34ggT0dgwajFCJRLrv5Z5J7A0VTLW1utoLbYYSAarugYiomoZNdck4TGZKpUgSbtdZqoVVvzg24aiPHBlhbaiAtKpK24WWhEwbJNkgyWY3anajn2U3apBkk7tN7v6YuftZJFlL5bMl4iRb5jk30xBp8TlpyxkIWHVGx+qU865aRivEjNUYq7WIHFrD3uZwc7SbiH7K++nO1t6ol+z0+Pbu5u7msN/bbc3v9ZezPK6TbDGn5vwd/BgPJc01cFypEFzWaZ0uHv/BvEaMqKxR6alxM2wOk17NsOO9p5AOuoExsKN54Hjx4vSE+GNpz57spkuTCILZwXQg585DSophWFpa10DHBjo220+z/fw0208DHZvcbXL3x8zdr4KO/cegY/8roGOfEcQaEcT6O6FjCtxB0GwEp0CHpIR5FcHGAqrgUzx9jGnvuBkLVwO9BRTZ21tFkedas5dcTSuwZBdOItXMXFTeQJsTraloQcDjlQNULQl0S1FFtwmASRE/LJO59HlMCoGvmbYHIwetQs5U8VavIlWSlZDQF4VM09mrRoxJhJMYEfwDB38OOkah/o5nnNFbf+k8mJ2SxiekMTu6SYSgnK/Pf7fvuyVwDOENlYuz4OsHrguEM3Ou0EaImyKUrxqCNlC9gerNdt9s9z/Hdt9A9SZ3m9z9MXP3K6B6REMPQ3UQfDFUB21ng9VY6gUF1/8dsftUiRL48GY68Vg9nWFwjysQSrOLwFRG6Brsfqsbr6/a7q1M7zAe4H+QpjQZSCbOFXa/272Fk+Ccuw4vZAe1C35yU6U/dRKdd4ewzD1Fh+6YhgQjAn97NyzQ8WY1kiI3lDnPPBjZK0IxCmP7awWf5Uw3ecl7U7QeLLBZZ4jyGEV+GCIWaCF+sZ6646NmRT/odWGyu7+uS2D0gC73me+zq4GeQdIlFUmFK3IXvA1G3l8XkOcg1KhBSe69vJqnOSNMHiRcoZztM/RrQG9FoNdE1mPPBTdoGMIFmSe/vT1/ysaERH0lKC2BYCGpdUAuvUEY+Uo3qC6L0CS/+RhdjideucHCdRzKLDbKYBT2Tp0JwS6Po6FeYQs4Rc32ZqdJwpcJmnX1pPJgKq5FRrtjZ2ZtCk6Zqi6s2OUL8576ndC3DFLhY+5HO+9Umx1KKlCSdnSiiSr6DpBdFpVefE6vbxXiXxW3duDW9tzs0yUpgmkvk3C9O0F6EwueWW+tb1488GvP8aP+CiPEdVkGskSUY/ESVVJ57ZvlWODXJn6LcrxTbycS2+ziNBaqGrPYJbOUHbNkorUV/2GMQodS5XJcItO+WaxPtGjbZ0S7tzEnUjss2ZZtgEYv3wkSQ4Vg4kPatD1m0eH4xKfte+9Z1IX3aKlT9n5BZz98ib2VKFOd2G+WmRZs04LtUCdslD9sXRRYyG3SwdeBEAAHM//7ShAFnauNgde9ld+z7/o5tH0kENVzscV++LI/K4LxE/MPiLqmQakmzF1fK6M3OSIv2r8WjFWdFixbcFXeTGPbXLJbkLf+zZO20n+avqTxYHao8lpl0+9dpR+oJP+cuvs3Vbym0vyMlSaiYAo3v2xsF+aD/HnEdKuHfHQKPRH4i6c+Vz3gRjsTXk8jFDPPqMi4o6j2WZ1MpPDHA4XgjvDhOkWWzn0mopOn9EcT6BmNDWiQtha4lQ9lBn7+ALtamfuECeCT/ErfbRmvU2iEJNpN0WFv0bGpBG6hbo0u8uLZBx3btjN45g05lh1WzgboyvNS0et0ELvMGUdIPRIRqbRJGQoXmjclKltoD/3qWVUWU6iRCh3ft5jcvh7RyTOa2jnHP7IW/G7jsTNMT16Mb/DNFDkVmY9MoluE9o/xRrS1JyIrqF9E1QUAE3MrvDw+X+EIZir+1qHNuBsn2S7Rggm1UCF8tjqbnY22bykwXmjr0OEuiE8NWf2q5HDKjg+XY/B2dtr+c7yXGXcxaj+6BZ2okW3K0DKFxvSyVTWmIN+XKb2gOoHx6MntLR23UKt2R8O/l4J6+curWRfmuyE4lz6j6x2h3Cy/uzlv0yenUdin7Hzy8Bud90pdnRaq6eygoIWPHwWdL0BwdOEQ3R8AebHCg3BENDdl5UcU6tzqtv3w6OTo/Ah17E+PjOLp +sidebar_class_name: "delete api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Delete Segment by ID

+ + + + + +This API deletes the segment specified by the given ID. +>**Note:** Segment deletion may take some time to go into effect. +A token with ORG_ADMIN or API authority is required to call this API. + +## Request + +

Path Parameters

+ +No content. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/delete-service-desk-integration.api.mdx b/docs/api/beta/delete-service-desk-integration.api.mdx new file mode 100644 index 000000000..a0a987bdd --- /dev/null +++ b/docs/api/beta/delete-service-desk-integration.api.mdx @@ -0,0 +1,95 @@ +--- +id: delete-service-desk-integration +sidebar_label: Delete a Service Desk integration +hide_title: true +hide_table_of_contents: true +api: eJztW1tzEzkW/iuq3ocBypckGLLxy5ZJwlamwsDmUjyEVCF3y7aGbqlHUod4Uvnv8x1JbbvjmABD7QDVL4mtPjo6d31HVt8kjk9tMrxIToW5kqlgB8J+YEfKianhTmqVXHaSTNjUyNJ/HSYHIhdOMK6YuJbWSTVljclyOZmN5+zooMfYiDn9QSj2UboZe22mbJQVUjFtmlPDKK/cTBvp5kxaZsQflTQiAwPG01RYy9wM40JlpcZSvaST6FKE9Y4yyJd5+SJfYruqTScpueEFCAypfZMofMEkmeGRJPVK7mbJXZ2PDpiebFYTsoVVMbEWOBk6U4lOYt08pxWsLMqcCMR1mesMQxOeWyJIZ6LgyfAmcfPSUzoDo3pK7ucME06q3d5eEntbamWFpQk7WwP615R1o5Te+G4m2FRewRfQyVbeopMqz+dRAyzTSQZbW+t893MplGOHxsBtXXYiXGUUHCMnninpLaxjY515x0l1xXOZkX9SDSmUI5a8LHOZenn6v1vie7NuAD3+XaSOfGXItU4GbTPhuMz3ve3WjdUU9qVUogvFJUkovMgpJjJwvJIZxWyhjWCBJfmWVPB0vYbhYYneNnvBM+gb9NuPysBMzvD0A3hR2D0k0LmSmM/qKUxmbAKhNiwrdgUfP9/a2xlMng843/n3YHv32Xhvwp8+3dp7trdHqxfwHJ8G08S1uTF8vrb0f4USRqYs1yk88icMYgSH7b0AfnGKfScK+7APPI/PsP8Z9Aq0CzWjvMyJa9dhnL3Yf8MGuyznalr5cT69YwTVPT/FiEJ48jENUUZB88D4tZFTqe7NG1UVVNMODl+Ozo/PMHJy+L/zw1N8Il5rFW2kEK0ZhSVERSzM9EcvcVTgI7fMIjlSZEePPYlcn0AhruwqoQzf7NzCmIitCa9yhxlx9XtmrLJmE6OLRir5vLl27JHsiV6HjWms4C6dsTG3mECVB+RPRsji0nWPoyWfsJngmTCPeyiomSQlec6QjWCK+XMwYjzLKHUDg0mFVBa+PujKMaUd6kfTF0tTNr2BJJDOUxyvOoWSA5I/HCej1FUQzqu5moWLaIkiRv9A5mC5pnRnK0bzJp0rx1NowamwpdoYWJiNoZt0lsVyRO6yKDyqpltUrNvbpVq+3L0Kwhw47Z+lvLKfkXdvcpSfrldt8eBKxOSztGmEauS9UbspViQ8JLX95Ei1cFed+GwiRZ61udvmbpu7n5m7dx+eRDQVn3ros70Ofc5VxKS0ea5BH+OjR+kauP4Z4FZwZIdAboRIv749iziYAOx1STDxG+KjsJWvCT9a+COMjwl+LJzV8AUJ6O0YNJigEols6OVeSuwNFUz1dH21l9qMJQJU3QMRUTUNm+uKcZjMVEqRJNx2WKaFVb84NuOojzXK1wug310g/RZJtkiy3Y3a3ejn2I1aJNnmbpu7P2bufhJJLqTy2RJxkq2Kgpt5iLT4nLTlDASsPtdji5TzrrqLVogZW2CspIkckvHO9nh7spuKQcYH2fOne5Od9PkOf7a7vbs9HuzsJqt7/cUyjxdJ1sypFX8HP3oTA8RdAcdVCsFlndZZ8/gP5jViQmXNH9nWuBk2h0kvl9jxnpPL37SDbmAM7Gg2HC+enxwTfyzt2ZPddGVSQTA7mA7k3HlISTEcDqlb6NhCx3b7abefn2b7aaFjm7tt7v6YuftF0HHwEHQcfAF0HDCCWBOCWP8kdMyAOwiaTeAU6JBWMK8i2FhCFXyKp48x7R03U+EWQK+BInf21lHkmdbsFVfzGizZxkmkWpqLyhtoC6I1NS3dP4g/kKNqSaBbiipZCMKkiB+Wy0L6PCaFwNfMu6OJg1YhZ+p4W6wiVZpXkNAXhVzT2atGjEmEk5gQ/AMHfw46RaH+hmec0Vt/6zyYnZDGx6QxO7xOhaCcX5z/PrvvlgBdtjBULk6DrzdcFwhn5lyhjRDXZShfCwjaQvUWqrfbfbvd/xzbfQvV29xtc/fHzN0vgOoRDW2G6iD4bKgO2t4WW2CplxRc/3fE7lMlSuDDm+nUY/VsicFhBCswKN3cL3IOiL8fQnlUuRllpszU0IY7qV0ExIcup1u+QziD4Gln/fnKndWa6pKuvhYCMbu84Uv1iu7qDpP+pum2fyOz24RkJDAa7FCZHHNmzpV22O/fIDwQFrc9XsoeqiYixM2V/thLddEfwyf3lDu63RpSmwjY6M1R7Gx63qFGUs6EAuuZB/d6E1J2wM3+QsMnOdO9ZIqbOZoeFth0GPIrxq8fhoglmpdfrKfu+Xhd0w96nZv89u/rEhht0OU+831yNdAzSHpHRVLhchlSp4T0w+prgbXcveg3hp21xV4T2Q57IbhBGxKu3Tz69e3ZYzYlfOvrS2UJWgtJDQky9A1CxNfPUX0FhSb5Lc3oahouT48al3woX9kkh8LsnToVgl0cRSP8ho3lBDuBNylNEr740KzLR7V3MnElctpze0tLUuAhJ/qwUJ835j32+6tvRKTCx8KP9t6pLjuQVPYo5D1NVNH3leyirPXiK3p9rRD/qrl1A7eu52Yf35EimPYiDZfGUxQNYsFz66311YsHft0VftS1YYS43pWBLBHlaF7NSmuvfbUcDX5d4teU4516O5PYvJvTWChhzGLvzTN2xNKZ1lb8hzEKHUqDi2mFLPpqsT7Sol2fEd2drRWRumHJruwCinr5jpEYKgQTHxMU8EhIh0MZn5LvvWeR8+/RqGfsfUNnP3xB73CAMtOp/WqZacEuLdgNNcBG+cOGSIGF3CYdfB0IAbC/9L+vBFHQlboXeN1b1T37vp9DW0MKUT0XWw7Dl+GywMVPzD8g6gUNyjAh+cVlNXxnkRftig1j1WcQdy24Lm+usRnfsVuQd/FLKm3Q35u+pPFoeVTzWuXzb12lN1SS76fu/kMVr600P2Olidiaws0vG5uQ1SB/EfHa+tEhnW3PBP7iqc9VD+PRJC1fAVtlVObcUVSHV+xmUvhDh1JwR9ivQ5GlC5+JpdGU/mgtPaOpAQ3S1gKT8rHMwc8fi9crc58wAViSX+m7reIlDY2QRBMreuwt+kCVwi3UA9L1YDz7Xcdm8BSeeUOOZQe1swG6iqJS9IIgxK4KxhFSD0REJm1ahcKFllCJ2hbaQ7/FrDqLKdRIhZ7vhkxhX0/ia3Urjn9gLfjdxsNsmJ68GN81XCpyIvLQp4CuCdsf4o1o685EXlIXiqoLACZWVnh1dLbGEcxU/AVFm2k/TrJ9ogUTao9C+Dztbfe2ur5dwHiprUMT1hA/vP+58XXIuwF5szzQ/w5fHo37EzUW/ZJO4EjrKjQ6ob+8SDb2l5g/lBm9IzuDnYj05obOa6jjuqXhPypBhwEXl8tmyjeh8CN9zhZvgW602KOTqMRj9gVvod6rVX36qObLg4cEHz8IOq+AHujqoYk/UPJShgfhyGllytqPMo3u/ODw+PDsMAkQ6D4EED/AKKhxfwGmICsA +sidebar_class_name: "delete api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/delete-sod-policy-schedule.api.mdx b/docs/api/beta/delete-sod-policy-schedule.api.mdx new file mode 100644 index 000000000..872cc4828 --- /dev/null +++ b/docs/api/beta/delete-sod-policy-schedule.api.mdx @@ -0,0 +1,100 @@ +--- +id: delete-sod-policy-schedule +sidebar_label: Delete SOD policy schedule +hide_title: true +hide_table_of_contents: true +api: eJztW1tTGzsS/iuq2YeTpLANxkDgZcsJ5BSnSGC5VB4ItZFnZFvJWJqVZpJ4Kf77ft2SxzaGkHBSe05S85LYM61W3/trIV8ntlBOltqawyzZSzKVq1Kd2ezE5jqdnqVjlVW5StaSUo58sneZnB3vi/AyuVoDfeFUKkuFxaWr1FriVVo5XU5Be51ceOVeWlOqL2W/Kse0Xmdmz9usVTCPvc+gVcnVDfPyqdMFyQJJzsfaiyCOFz7KIYbWCSl8oVI91CoTJE3g1H5nTtV/Ku1A7ixI7VAcn/7+7/7+68M3bShQSCcn4OY8i6Zpk0JCqLXE4AW+6QyfaauJTPauk3Ja0FNfOm1Gyc1a4gL/WtXbAitxuE/blvg0F4y/1gpMKl+KgYqaZaQQCae+yEmR03ZquPl8uNvb7O2o3d7WdnewNRg873V7cmt7c3cne56QqaBkYY1XnuTsrvfov2Vp3liRkuFN2SbRe+vrqzQvc4334sA5WLUlTlVZOQOZdFCB1FUkrc2mAs7Q5pPMdUbiRtbEUhYFtOQI6nzwxPd61YZ28EGlJTnBUbyVOkieqVLq/KXN1Kq9b5v3lTaqNXJSk4SKRU6xUIDjJ51hhZhYR3YlljMvMN2yfWGJ9oZ4ITNxGvV7GZWBmUon04/gRbnwkEAXRmO9mC0Rmp1537ZqR8nB9vputzfc7knZfd7b2Nka7A7l5ub67tbuLu0+Ud7LUTBN3Fs6J6crW/+ujHI6FblN4ZH/wiBOSdieBeDNsQR5NfEP+4B5fIP9KbwDba1mlFdQeq8hLV+8PBG9HZFLM6r4uRzdMoJpXZxRvlV5Lgf0iBIJmgfGx06PtLlLFGWqCRWP/YNX/Yujczw5PfjXxcEZPhGvleLRN4jWjMISoiIWxvYzSxwV+CxRUpCAKTKwLZ5Frs+gkDR+kVCHb37qYUzE1lBWeYkVcfc7ViyyFkNnJ0uplIZaKJ7otmqvoQ7g2USW6VgMpMcCuJDIn/XTVBVl6yha8pkYK5kp97Qt+lmmSUmZC2QjmGL9lAqKzDJK3cBgWCGVIYwux7YqhbGlTtWyL+amXPYGkkCXTHG06BRKDkj+cJz007KCcKzmYhbW0RJFjP6BzMFyy9KdLxiNTTo1pUyhhczzKczo0HVQmaCbLv2s0pG7PAqPmdHVFevmZq4Wl7vXQZj90vK7VFb+G/LuJEf5abFq9YtPKiYfwsDGasTemLkpViS8JLV5caSq3TVLfIGelmdN7ja52+TuN+bu7ZenERnFtwx9Nlahz4WRwKPWcfNcgT6Oo8dYMSNieBMduSZgkAiR/nh7jsT+qAzRqy8FocMfiI9CK18Rvl/7IzwfEPyonbXkCxKQ7Rg0GKISqWyP5Z5LzIYKptpc3e2VdQONADV3QERUTSemthISJnOVMSSJ9Gsis8qb30oxlqiPEhnhfaiAtKsh9K8JmTZIskGSTTdqutGv0o0aJNnkbpO7P2fufhVJ1lJxtkSc5KvJRLppiLT4nrSVAgRidkYn6pRjV91GK8RM1BgrWUYOyaC7MdgY7qSql8letr25O+ym2125tbOxszHodXeSxV5/Oc/jOsmWc2rB38GPbGKAuE/AcZVBcPnS2mz5+A/mdWpIZY1KT42bYXOY9GqOHe88hSyhGxgDO7p7jhcvTo+IP7Zm9mQ3W7lUEcwOpgO5LBlSUgzD0tqXDXRsoGPTfpr288u0nwY6Nrnb5O7PmbvfBR17D0HH3ndAx54giDUkiPVXQscMuIOg2RBOgQ5pBfMago0FVMGnePoY076UbqTKGugtocju7iqKPLdWvJZmOgNLfukk0szNReUNtBOidTNaEEgxQok0AlVLA91SVOmJIkyK+BG5nmjOY1IIfN201R+W0CrkzCze6l20SfMKEnJRyC2dvVrEmKa/6w8J/oEDn4OOUKh/4Bln9NafOg8Wp6TxEWksDr6kSlHO1+e/W3fdEjiE8I7KxVnw9T3XBcKZuTQYI9SXIpSvGoI2UL2B6k27b9r9r9HuG6je5G6Tuz9n7n4HVI9o6H6oDoJvhuqgba+LGku9ouD6vyN2TpUoAYe3sClj9WyOwRlXIJTmt4GpjNA92b2kU1/cRUHpXOvspuPnN4TDLBBEq1wO+nFZFn6v07mGx+Cpm7YsdBuFDE4rp8Z+bqd20hnATHdUILpwGrKNCET/5DAOG222sdMUxqHmMfNgcdaKAhaW5zsGX+VM937JlVPMISKwWRMI+RhS/BgiFpgnfvNM3eYQWtEPel24/ObP6xIY3aPLXeb76m6gF5D0loqkwtX8ojbd8Z6E3Veua88bCh37d1c2OyayrnihpMNkEG7CPPnj7flTMSLIySlfeUK7StOMgKQ5QYhwSevPboXQIu4yzlajMQveX7p3QykkhjkUFu/MmVLi8jAa4Q1q/SmKM5uUFimuB7Tq6snMO5n6pHJqg+25JSnwdGY6sFBHLq17yi2PZwNt8HHCT9vvTEvsa6pEmlo30UQVedQTl8VML7mg12OF+MeMWytwazE3//SWFMG0l2m4x50ij4mFzD1b69GbB36tBX40SOEJcb0tA1kiyrF8Wyqdee3RcizxaxG/ZTnembdjjX66vEyE8iU82mGeiUORjq316p9CUOhQGlyOKmTRo8X6TJu2OCNa3fUFkVphy5ZuAR2yfEdIDBOCSQ6oOzM4seGchFPyPXsWOf8es3Mm3i/pzI8v0USJMrOpf7TMtGGLNmyFGuCj/KFHUWAht0kHrgMhAF7O/c+VIAq6UPcCrzurOrPv8BpqDSlEZS6+2Atf9uYFLn4S/IKoaxqUYQLX9f0xfBeRFzWqJWPNjgVuW3BV3tyiP96yW5C3/uMm9cy/m76kcX9+enJs8umPrtL3VJK/T939iypeU2l+xUoT4S6FG28b54LFIH8R8drqaR4dN48V/sVbzlVG1phbeBJjFLPIqMhlSVHNWZ2OteJzgELJkrDfGkWWnXAmYmSn9Me0x4xGDjRIWw9MKgc6Bz8+qZ7tLDlhArAkv9J3X8V7ExYhiblStcVbjGYmhVtoLKMbu3j3wcb57AyeOSHHiv2ZswG6JpPKYDfKy2oiJELqgYjItE+rULgwpRk1s4Vl6FevmmUxhRqp0OYBxU388ZCOmDG9Ljj+gb3gdx/Pl2F68mL8Ld9ckVOVc2QS3TJsf4g3oq01VnlBgyGqLgCYWtjh9eH5CkcwM/GPGtaNOnGR7xAtmNB4FMJns73RXm/xuIDnhfUlRtkl8WnyWvwV4cKgtRSJ1/PD9R//m8nYV2gg6BR0mEXSVmFACTPhZbI4E2LJXv0rSpYWg8YY2hHh9TUdfNCcdEOPMfDTVH15NR+BeHSE9ekz5s8h6sHtn1kuqvskCp895T/dPPrHl3dqOTvYM9P5TJ/g40dFRwFQEgMzdOOzGpY7vAinOQtLVv7eQbNXPWHvHxwdnB8kAcrc1cnjB5gJtep/w+jWCg== +sidebar_class_name: "delete api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Delete SOD policy schedule

+ + + +:::caution deprecated + +This endpoint has been deprecated and may be replaced or removed in future versions of the API. + +::: + +This deletes schedule for a specified SOD policy. +Requires role of ORG_ADMIN. + +## Request + +

Path Parameters

+ +No content. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/delete-sod-policy.api.mdx b/docs/api/beta/delete-sod-policy.api.mdx new file mode 100644 index 000000000..125b40f5a --- /dev/null +++ b/docs/api/beta/delete-sod-policy.api.mdx @@ -0,0 +1,100 @@ +--- +id: delete-sod-policy +sidebar_label: Delete SOD policy by ID +hide_title: true +hide_table_of_contents: true +api: eJztW1tTGzkW/iuq3ocJKV/AGAi8bDlAppgigeVSeSDURu6WbWXaUo+kDvFQ/Pf9jiS3r4Qkk9qZpPplxnRLR9+56juK+j7RhTDcSa1OsuQgyUQunLjU2bnOZTpJGonjQ5sc3CSXZ0csPrxtYFxhRMqdwCRnStFIrEhLI90EY++TayvMoVZOfHK90o1ovszUgdVZs/AyDu4wViS3D16WTY0sCAMQXI2kZQGGZZzZQqRyIEXGCECY3HqnLsQfpTQYYXQumB6ws4tf/9s7en3ypgXMBTd8DAHGejSS5BYcOBqJwgv8JTP8tulIjHlycJ+4SUFPrTNSDZOHRmKC/Eq7ZYyCnRzRsg6/ZpZhTkfohEJ84uMiJ7lisP1isN/d7u6J/e7Obqe/0++/6Ha6fGd3e38ve4EVI8o/SmEmM5i5HsqU5+uw9jU05yohbANe5i5AfVjGeqIySY6y7G4kANcAMywsvXH1wEXA7Flci5GUDaYN3o+4yeYUmhllwHMr5jT0K9/SCFtoZYUloJ3NLv1vEc4bzVIKDOVaZOfu5ubqmMNc4j07NgYomuxCuNIoRIAM9iYYwjrW19mE9JDqI89lRgijaBLJiyInxSGy/cGS3PtVI+r+B5E6ihhDeeBkQJ4Jx2V+qDOxGhzL9n0llWgODZeEUHjIKSYySPwoM8xgY20ECyKnIePHLcYILNHaYi95xi6ifodRGZjJGZ7+DlmUo08BulYS89l0CpMZG2jz2LJiT/D+7uZ+pzvY7XLeedHd2tvp7w/49vbm/s7+Pq0+FtbyYTBNXJsbwycrS/8qlDAyZblGIMk/YRAjOGzvAfjFMQV5P7ZP+8DL+AL7Uy6GsZWaES+j8tNAGL88PGfdPZZzNSz9cz5cMoJqXl9S1pV5zvtVQDciiDMjh1KtgyJUOabidnT8qnd9eoUnF8f/uT6+xC+StVLcegrR6vMRUBELI33nEUcF7rhlFumWoq622PMo9TkU4srOD5ThLzuxMCaLBQAz4uprZsyLZgOjxwuplIZazZ7Jlmg1WJ+ejblLR6zPLSbAhTT8eS9NReGap9GSz9lI8EyYjRbrZZkkJVFAkI0QivkTCGI8yyh1g4BBiVQGGOlGunRMaSfTpVo5M+WiN5AE0vkRp/NOoeQA8qfjpJe6kqobqTmfhVW0RIjRP8AcLLeI7mrOaN6kE+V46qhw5hOY0WBXRGWCbtLZaaUjd1kUHjUdV1Wsh4eZWr7cvQ5gjpz271Je2i/Iu/Mc5afpVatefBQx+SztSqEaeW9M3RQrEl6S2n5yHFW5a5r4DBtwntW5W+dunbtfmLvLLy8iM4pvPfXZWqU+14qDL2vjN88V6mN89CjNpoM8vYmObBBnixTpt7dXSOzfhaLx4lNBrO078qOwla+A71X+CM/7RD8qZy34ggB6OwYNBqhEIjvwuGeIvaGCqbZXV3ulTV8iQNUaioiqadhEl4zDZKZUipBw22CZFlb94sBsUR85MsLaUAFpVUXdiSRmWjPJmknWu1G9G/0su1HNJOvcrXP3x8zdzzLJCpXPlsiTbDkeczMJkRbfk7acYQCbntGxKuW8q5bZCgljFcdKFplD0u9s9bcGe6noZryb7W7vDzrpbofv7G3tbfW7nb1kfq+/meVxlWSLOTXn7+BHb2KQuI/gcaVCcFmndbZ4/AfzGjGgskalp+LNsDlMejvjjmtPIR10g2BwR/PI8eL1xSnJx9JePNlNlyYVRLOD6TCcO08pKYZhaWldTR1r6lhvP/X289NsPzV1rHO3zt0fM3e/ijp2n6KO3a+gjl1GFGtAFOvvpI4ZeAdRswGcAh3SEuZVRBsLqIJf8fQxpr3jZihcRfQWWGRnf5VFXmnNXnM1mZIlu3ASqWbmovKGsWMaa6ZjMYCzIUqkYqhaEuyWokqOBXFSxA/L5Vj6PCaFINdMmr2Bg1YhZ6bxVq0iVZqXQOiLQq7p7FUjxiTCSQyI/kGCPwcdolB/xzPO6K2/dB7MLkjjU9KYHX9KhaCcr85/d9bdEjgBeEPl4jL4+pHrAuHMnCu0EeJTEcpXRUFrql5T9Xq7r7f7n2O7r6l6nbt17v6YufsVVD2yocepOgZ8MVXH2NYmq7jUK3+T9P/N2H2qRAQ+vJlOPVfPZhzc8wqE0uyWMpURutR7kLSri8UoKO17mT0kdCGZaGFAVJocw0bOFfag3b6Ho+CghxYvZAv1C75yE6XvWqket/uwzprCE67MUtDQANY7P4k9Rsub1kiK3lDqvPBg6HgxN7EwuL9a8FnJdOmXPDhB+8GCmAZDpMdI8o8BsUAb8Yv1o1s+clb0g17XJn/467oEQY/oss58n10N4xmQLqlIKtzO7o9fEucOq6/cIp/tI3Ta31lZ7IyGddhLwQ3dc/YXYJ799vZqgw2JafpMLy2RXCGpNUCunCNEfCXrTS+D0CS/uRhdDkceeG/hug1lDhvkUJi9U5dCsJuTaIQ3KPEXqMnepDRJ+DJAs26fTb2TiY8ip92vNbMkBZ7MVBsWavOFeRt+p/MtgVT4OfZPW+9Ukx1JKkCSdmwaE1X0HR67KaZ68Tm9vhXEv6bSmkFa00uzG0sogmlv0nB9O0X6kgieW2+tb148yGvOyaP+CU9I6jIGskTEsXhJKp167ZtxLMhrkrxFHO/U25HENro4jYWqxSx2wTxjJywdaW3Fvxmj0KE0uBmWyKJvhnVHizZ9RjQ7m3OQmmHJpmyCFHp8p0gMFYKJ92lT9pxEh+MRn5LvvWeR8+/RMmfs/YLO/vEN9k4amenUfjNmWrBJCzZDDbARf9iaKLCQ26SDrwMhAA5n/veVIAKdq3tB1tqq7sW3/RzaGlJA9VJscRD+OJgVuPiL+Rc0uhqDMkycuro2hr9ZlEX704KxpqcByxZcxUsfXqgluwW81b9p0lb5T9OXNO7NDk3OVD753lX6kUryz6m7f1PFqyvNz1hpIsulcPPLxnZgPshfRr62eohHp8wjgf/irc9VT6jRrvgGzLOYeUFFzh1Ftc/qdCSFb/8LwR1xvwZFlh77TESnTulP34+RoKHBGKStBSflfZlDnj+gnq7MfcIEYkl+pb9tGa9LaIQk2knRYm/RkakUbqFujC7q4t0HHduyS3jmnBzLjqbOBukaj0uF1SgvyzHjCKknIiKTNi1D4UJzpsTUFtpTv2rWNIsp1EiFlu9LzNieDehkGU3rnOOfWAt+t/FYGaYnL8YP+WaKXIjcRyaNW6TtT8lGtDVHIi+oH0TVBQETcyu8PrlakQhhKv5bhjbDdpxk2zQWQqg9CuGz3dpqbTZ9u4DnhbYOHewCfP+N4OwTTNafsJOj5TC8nx2of5fvOOM+Qg1Au6AzK0JXhoYktH43yXzrhykHMqPvU0dQgd7e39OhBjVDD/Q4fF5JHSGMSpE++5bxUUW+4weUa/X5XVAPP/vSM/bpSUJd0bQb+0rMz6Jdsw3/j0dPf6u6Ftn0DFFN5mFNEcPQ6M1han8s5AGGF+HgaG7Kyj+tkGZVM390fHp8dZwE+rSOPcQfBzd0EvA/QnwsJg== +sidebar_class_name: "delete api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Delete SOD policy by ID

+ + + +:::caution deprecated + +This endpoint has been deprecated and may be replaced or removed in future versions of the API. + +::: + +This deletes a specified SOD policy. +Requires role of ORG_ADMIN. + +## Request + +

Path Parameters

Query Parameters

+ +No content. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/delete-source-schema.api.mdx b/docs/api/beta/delete-source-schema.api.mdx new file mode 100644 index 000000000..f35c41350 --- /dev/null +++ b/docs/api/beta/delete-source-schema.api.mdx @@ -0,0 +1,95 @@ +--- +id: delete-source-schema +sidebar_label: Delete Source Schema by ID +hide_title: true +hide_table_of_contents: true +api: eJztW1tv2zgW/iuE92HawpfYcZomLws3SRcZpNNuLuhDGqC0RNtsZVIrUW28Qf77fueQki07adpMsTMt9JLY1OHhufM7NHXTsqnKpNPWHMet/VasEuXUmS2ySJ1FMzWXrXbLyWne2r9s+eG8ddVupTKTc1Bm9OCmpQ3mptLNQG3wAN9yJgbTditT/yl0psDfZYVqt3LPeP+m5RYp07pMm2nrto318yjTKcmD8fOZEn5RcXzYBSd1LedpQlMG0V7/xdaL7Z24v9eXL55v9XfiwYvhzs54KAfbgz0wu1ssXpvF+ooY6xLfIRZPfoRYV8Q9T63JYUmsPdga0r/6Cn9YEVnjlHGiI7SJdSSdyoXDwiSayp34InORFxH8kU+KRIwLR48zJXQuzHK6s2JMk1yRGRWDV2DiJeiSssOtrU0JDhJN04+yzGaQ4bRiMKlJMbbxglbU5rNMdEzGCCsTS5mmCYkOlr2POfG92bS6HX9UkcPENKNYdNrbJVZO6uTAxmrTQ+sOeaWN6kwzqUlCxSJHmCjA8bOOMUPMLSzjWQrrVWC6uvdgiW5fvJQx9PX6HQRlYCaXyegTeFGePCTQhdGYL8opQsdiAqHuWVbtKjl+vrU3GE6eD6VEvPR3d8Z7E7m9vbW3s0ex3JrDz3LqTRPWllkmFxtL/0sZlelIJDaCR/4Lg2RKwvYsAC+OKdqpef6wD5jHN9ifEsLTVmoGeYVT164tpHh58FYMd0UizbTgcTldM4LpXJxRnhZJIsc0RKkHzT3jN5meanOXKMoUc6pOh0evRhcn5xg5Pfr3xdEZPhGvq3VhR6bMKIiKWJjZLyxxUIDzClUwciruimeB6zMoJE2+Sqj9t3yRw5iIrYksEocZYfU7ZqyyFpPMzmupxHlz7cQT3VXdNrIWY3PpopkYyxwTrE/dZyPkfOo6J8GSz8RMyVhlT7tiFMealJSJQDaCKeYvKP1lHC9zf1IglSGMdjOLomGs05Gq+2Jpyro3kATaMcXJqlMoOSD5w3EyilwB4VjN1SysoiWIWFa8OFiuLt35ehVcGCcjaCGTZAEzZhkszAVRu7wqhJpsP5empKsq1u3tUi0ud6+9MIfO8rNIFvk35N3bBOWnw6pVDz6rkHw51WFfjdgbpZtCRcJDUpsnB6rKXWXii4lWSdzkbpO7Te5+Y+6uPzwNqCc8ZejT34Q+F0YWsG/Gm+cG9KkQVknE8CY4si1gkACRfn93jsT+pAzRq+uU8OQPxEd+K98QflT5w4+PCX5Uzqr5ggRkO3oNJqhEKt5nuZcSs6G8qbY3V3tls7FGgJo7ICKqZiYWthASJssKY0gSmbdFbFVufnNiJlEfJSNYXwFpVRN3UquNa5BkgySb3ajZjX6d3ahBkk3uNrn7c+buV5FkJRVnS8BJeTGfy2zhIy08J22lAEF1/iaqlGNXraMVYiYqjNWqI4fWeNAf9ye7kRrGchg/396bDKLnA7mz29/tj4eD3dbqXn+5zOMqyeo5teJv70c2MUDcZ+C4wiC4cmdtXD/+g3kzNaGyRqWnws2wOUx6tcSOd55xOugGxsCO2T3HixenJ8QfSzN7sps/DqakZdOBXDqGlBTDsLTOXQMdG+jYbD/N9vPLbD8NdGxyt8ndnzN3vws6Dh+CjsPvgI5DQRBrQhDrr4SOMXAHQbMJnAIdogLmNQQbU6iCT+H0MaS9k9lUuQro1VDkYG8TRZ5bK15LsyjBUl47iTRLc1F5A+2caLOSFgRSTFEijUDV0kC3FFV6rgiTIn5Eouea85gUAt9s0RlNHLTyObP+ezq+R0kBCbkoJJbOXi1iTCOc1ITgHzjwOegUhfoHnnEGb/2p82BxShqfkMbi6DpSinK+Ov/dueuWwDGEz6hcnHlf33NdwJ+ZS4M2Ql2nvnxVELSB6g1Ub7b7Zrv/Nbb7Bqo3udvk7s+Zu98B1QMauh+qg+CboTpou1uiwlKvKLj+74idUyVIwOEtbMRYPV5i8I0Luod8Xbi8oxvuxI4X4viQ5UHULS8VU8Whq7j7rZ7H9nnvprwkfNvzMI+GwgXdW9D7DsIrVGQJps6cS/P9Xu8GfoZ/b7sy1V2UP7jaLYz90o3svDeGce+oW3RN1ecoEYjR2+PQonTZM5mm4PeVkpl7P7EtKMzhL76Z8FXOdMuYAmABxYRn0xZIlBCIPAwRU3Qhv+VM3eXA29APel1kye2f18UzukeXu8z31dVALyDpmoqkwhW5CwEDRuyvC8hz4MvcqCC3X16t0nCseAk3KJdbFf2gMNgQ6A2RDcRLJTP0HP6OzZPf350/FVMCs1xMipxwtNLUfSAd3yKMuFiOyvsmNIn3r8wW0xkrN6rd6KHkFJMERhHvzZlS4vI4GOoP7CKnKPtsdpqkuNLQrKsnpQdj9VkltMF2l9am4NSx6cGKPVmb95Q3U+46tMHHOY9235uOONRU4zSBAqIJKnITKS7TUi+5otdjhfhHya3juXWYW/50TQpv2svI3xCPUCGIhUxyttajF/f8Oiv8qEXDCHFdl4EsEeSo38OKSq89Wo4avw7xq8vx3rybaezU9WnCVzuRY6NNYnEsopm1ufqnEBQ6lCqX0wKZ9mixvtCiHc6IzmBrRaSOX7KjO8CdLN8JEsP4YJJj2vcZ9lh/AsNp+4E9i7rwAV15LD7UdObhS2zPRBnbKH+0zLRghxbs+DqRB/n97keBhdwmHbgO+AA4WPqfK0EQdKU2el53Vn5m3+M5tH1EEJW55Om+/7K/LILhk+AHRF3RoFQTbK9upuG7CLxoC6wZqzxwWLfgpryJxc67Zjcvb/WzKe3Gfzd9SePR8lzmjUkWP7pK31NJ/j519y+qeE2l+RUrTQDSFG68bOg4VoP8ZcB0m+eEdJA9U/iLp5yrjNnREXGPxyhmlVGaSEdRzVkdzbTiE4ZUSUf4sE2RZeeciWlmKf3RRzKjaQYapG0O3CrHOgE/PgMvV5acMB58kl/pe16EGxkWIYmOVXXFOzR9JoJbqOGju8B49tGGzu8MnnlLjhWHpbMBuubzwmA1ystiLiRC6oGIiHUeFb5wof8zqrSFZehXzSqzmEKNVOhy65PN8zcTOrxGX7zi+AfWgt/zcHIN05MXw9uFS0VOVcKRSXR1aP8Qb0RbZ6aSlFpOVF0AMLWywuvj8w2OYGbCzyU2m/bCpLxHtGBCLZQPn+1uv7vV4ZYC46nNHZrkmvhfaedqkVgVf0LtvZTOsohl4TsN3+ddhndAyQT7K6+DhlaPR8u3MdEZzCAOTbq5oTMQan5uaRi9PzXYl1fLvob7C5iLPqO/nCCB19/RvFn+rNB6chre5nzKv+LUXii9U4vy3M4sli17Cx8/Ker0K02oa3u8FKvvjz5GitJy6M1hOz4WYrv4x/7gaGXixk8r1IxVHfrh0cnR+RFK0/8AUpLxig== +sidebar_class_name: "delete api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Delete Source Schema by ID

+ + + + + +Delete Source Schema by ID + +## 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/delete-subscription.api.mdx b/docs/api/beta/delete-subscription.api.mdx new file mode 100644 index 000000000..9e15568c8 --- /dev/null +++ b/docs/api/beta/delete-subscription.api.mdx @@ -0,0 +1,95 @@ +--- +id: delete-subscription +sidebar_label: Delete a Subscription +hide_title: true +hide_table_of_contents: true +api: eJztW21z07gW/isa3w8LTJ20aaDbfLkT2nKnO2Xh9mX4UDqDYsuJwJa8lgzNdvrf73MkxYmTlgLL3F0Yf4HElo7O23P0HFW5iXQpKm6lVsdpNIpSkQsrzuqJSSpZ0uNoK7J8aqLRZXReyelUVCa62sLA5YhRdOimGcYVE9fSWKmmzKwIYVYzzqyf34PIkle8wJSKBN9EkoSU3M7wSuEFvskUn00yEwWPRjeRnZf01ECGmka3W1El/qhlJaC0rWqxrtCqBez4EKLENS/KnGRsZzs72YAP471kfxgPJ9luzAeTNN4bDp7+up2J3UkqotsrWsKUWhlhSIHB9pD+ay/zu2aJVlYoy2ImVSoTTm6wM8FIP2Es+8QNXJEkwpisztmktvS6EkwappbT4aAJTbJ1pUQKWUGI16BHFg+3tzc1OMglTT+qKl1Bh9NGQNbSYqLTOa0o1Ueey5RCEFYmkbwsc1IdIvvvDcm92XS9nrwXiaXYVZQzVnq/pMJymR9o+GwjTOtReSGViKcVl6ShcConmMgg8aNMKWkKDc94kUx7E9y4XiuC8ERvhz3nKez19h0EY+AmW/HkA2RRPj+k0IWSmM8WU5hMWQal7llW7Ak+eba9Pxhmz4acD34d7uw9nexnfHd3e//p/j6tXiDOfOpdE9bmVcXnG0v/RyhRyYTlOkFE/oRDKsHhe6eAWxxTpBWFeTgGTsYX+P8cdvmxjZlBX2bFtd0CRp8fvGbDPZZzNa3dcz5dc4KKL84IpnWe8wk9IvzBci/4FTAu1V2qCFUXVEUOj16ML07O8eT06L8XR2f4RLI2aspYLRAFVZELM/3JaRwMcLhC2UmsSHvsSZD6BAZxZVYHSv/NzA2cidzKeJ1bzAir3zFjVTTLKl20oORwc23ZI9kTvS2gFs8KbpMZm3CDCdpD98kYmC9tfBI8+YTNBE9F9bjHxmkqyUieM6ARQjF/TvDnabrEflYDylBG2plG0VDaykS0Y7F0ZTsaAIG0bsTJalAIHND84TwZJ7aGcs7MVRQ22RJUXFS8NHiurd35ehWcK8sTWMHzfA43VhU87AqitKYphJJ8X3C1GNdUrNvbpVmu3L30yhxa7d4lvDZfgLvXOcpP7ExrXnwUAXyG6rCvRi4aizCFioSXZLabHEY14VoAn2VS5GmH3Q67HXa/ELvrL08D6wlvHfXZ2aQ+F4rX8G/lNs8N6tMwrMUgR29CILcYHBIo0m9vzgHsD0LReHFdEqn8jvzIb+Ubyo+bePjnE6IfTbBasSAFnR+9BRkqkUhHTu+lxs5R3lW7m6u90NVEIkHVHRQRVbNic10zDpdVtVKkCTdbLNXCqF8sm3HUR+4YrK+AtKpK41JLZTsm2THJbjfqdqOfZzfqmGSH3Q67PyZ2P8skG60cWgJPMnVR8GruMy28J2s5w4Dm/I01kHOhWmcrJIw1HCtqM4doMtiZ7GR7iRimfJg+293PBsmzAX+6t7O3MxkO9qLVvf5yieMGZG1MrcTbx9G5GCTuI3hcrZBcxmqdto//4N5KZFTW3FHsgjfD53Dp1ZI73nnGaWEbBIM7VvccL16cnpB8LO1PeuE3XVeJIJrtXYfh3DpKSTnsT4k76thRx2776bafn2b76ahjh90Ouz8mdr+KOg4foo7Dr6COQ0YUKyOK9XdSxxS8g6hZhqDAhqSGexXRxhKm4FM4fQywt7yaCtsQvRaLHOxvsshzrdlLruYLsmRaJ5Fq6S4qbxhb0NhqMRYDOJuiRCqGqiXBbimrZCGIkyJ/WC4L6XBMBkFuNY/HmYVVHjPrf0/H9ySvoaErCrmms1eNHJNIJ5ER/YMEdw46RaH+jmecIVp/6TyYnZLFJ2QxO7pOhCDMN+e/T++6JXAM5SsqF2c+1vdcF/Bn5lyhjRDXpS9fDQXtqHpH1bvtvtvuf47tvqPqHXY77P6Y2P0Kqh7Y0P1UHQO+mKpjbG+bNVzqBSXX/52xO6gEDVx6M504rp4uOTicYAQeSjt3i1yA4h/4VB7XdkbINOUoXMeNif8j3eLVC7tmhLAQUb2ii7CFQF4urwdTTaK7uqOo38hYndu/keltRDoQ2fR21lWO8TNrSzPq928QfoT9tsdL2UNVRAbYudKfeoku+hP4/I5yRrdXPXRpABu/Pg6dS88FrJKECV9AnXAfPuciyn6E0V1Y+KxkuntMeTFHU8O8mC0G/IT8dI+hYonm5BfjRvdcPm7YB7suqvz2r9viBd1jy13u++xqGM+g6ZqJZMLVMmXOiMn71TcSZ7k70d8QBhuLvaJhA/Zc8Apthr9W8+i3N+eP2ZT4q6sftSHqLCQ1HEDga6SIq4/jxRUTmuS2rErX05lTfNy6xEN4ZFkOg9lbdSYEuzwOTvgdG8cpKr1zKU0SrrjQrKtHi+ik4qPIaU/tLT1JiSdT1YeH+rw177HbP12jIRU+Fu5p762K2aGkskYp78YEE13fyC7LhV18xa5vVeJfC2mxlxY7aebxmhbetZeJvxSeoCiQCJ4b561vXtzLi1fkUVeGJyR1XQfyRNCjffUqWUTtm/VoyYtJXluPt+rNTGJzbk9jvnwxg701T9kxS2ZaG/Fvxih1CAaX0xoo+ma1PtGisUNEPNheUSn2S8YyBtV0+p0AGMonE5/QVu+YjvaHLg6S71xkgfl3aMRT9q5ls3t8iR2ZRqY6Md+sMy0Y04KxrwEm6O83PEosYJtscHXAJ8DBMv6uEgRFV+qel3VnVXfi+24ObQ0JVHVSsBH5L6NlgQufmHtBo5sxKMPE1JvLaPjOgiza9VrOWpwxrHtwU99cY7Nd85vXt/lLKW3A/zR7yeLx8ijmlcrn37tK31NJ/jl192+qeF2l+RkrTeDOlG5u2dBkrCb588DXNo8G6ex6JvAv3jqsOpqOJsi1dY7FrAoqc24pqx2qk5kU7lChFNwS99uizNKFQyL6f4I/WkcnaFphDGBrwEn5ROaQ5469FytzBxhPLCmu9B303F/C0EhJNKmix96gz1MJwkI9Hl3/xbv3OjR7Z4jMawosO1wEG6SrKGqF1QiXdcE4UuqBjEilSWpfuNDyKbHwhXbUr5m1QDGlGpnQc91OVZhX2ZnvTVYC/8BaiLsJh9VwPUUx/J5wacipyF1m0rg2bX9INrItnom8pC4TVRcETKys8PL4fEMihKnwFxJdTfthkunTWAih9sinz25vp7cdu3YBz0ttLBqwlvrUeYFXrv02s5WEN8tD+q//SWbYMojr90s69CJFat97+HbvMrqz3cPckUzpR6EzqE3Dbm7oeIQaoFt6/EctqPe+vFr2Nq4nhFvpMxrLDEBf/w3nqjGPTsOvPR+zzV923qn44kxPzZftfISPHwSdAkBd9MpQ2B3TOGX8C3+QszJl408drX748Ojk6Pwo8sTjrn03fIDtqCz/A9AFx3Q= +sidebar_class_name: "delete api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Delete a Subscription

+ + + + + +Deletes an existing subscription to a trigger. + +## 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/delete-tagged-object.api.mdx b/docs/api/beta/delete-tagged-object.api.mdx new file mode 100644 index 000000000..723bea788 --- /dev/null +++ b/docs/api/beta/delete-tagged-object.api.mdx @@ -0,0 +1,83 @@ +--- +id: delete-tagged-object +sidebar_label: Delete Tagged Object +hide_title: true +hide_table_of_contents: true +api: eJztW21v2zgS/iuE78O2RWwnjpM0/nJwE3fhRdrk8oJikQZbWqJtdmVSS0ptfUH++z0zlGTLTtpctrjbLfyllcThcN75DM3cNmyqnMy0NcO40WvEKlGZupSTiYpPRx9VlDW2Gl5FudPZvNG7vm1ceeWOrMnUl6yfZ1N8a+jY9DI56c2kkRPVuLm72Wrg3dNYYCUCL9/ASKx85HRKS2LBy6n2IqzqhRRZILdMLsbWiWyqhE9VpMcaA9k8VS2IlEonZ5jjPAuliVUqIc5Ww2AAb0RJskdTNZON3m340Gv4zGkzwYgy+Ywk7B8dDS4ufjs7P309PBlgoH92djI86l8OT9/i7aj/5qw//JkeB28vh5cngzf4H2/DY37/FY/npzzx4vT4t7NTzP2VX67OjwYwxlbDqT9y7RTsm7lcrVtAsVrCjlfUz2xhGdJYfZGzNCENeLW7rXu11vFXdH6UKMNjFgRPhRROjZVTJlIPyaPGuy/Hh93d7oE67O7td0Z7o9HLbqcr9/Z3Dw/ilw2KB6d8ao1XnsTqbHfpv/rib62IKK5M1iJJu9vb6zRHica4GDiHyGiKc5XlzsBgOkhM2imfiZGN5wJxpc0nmeiYxC1YE0uZpomOOObbHz3xvV03mS2DP3WUIZkOkscqkzo5srG6L6Tqwr7WRjUnTmqSULHIESYKcPykY8wQM+uUCCxLozNd3b6wRGtHvJIx9A36HRXKwEyZk9Hv4EXZ+y2BrozGfFFOETquMuyeZdWBkqP97cNOd7zflbLzsrtzsDc6HMvd3e3DvcNDWn2mvEfK+6W1pXNyvrb0z8oopyOR2Age+TcM4pSE7VkAXhxTdKZm/ts+YB6PsD9Fc6Ct1CzkFVS9tlBuXh2die6BSKSZ5PxdTlaMYJpXF5ReeZLIEX2ivIHmgfGp0xNtvlZdjgev+1cnVC/OB/+6GlzgiXit1cG+QbTGFJYQFbEwtZ9Z4kKBz9ILj9yLMhW3xIuC6wsoJI1fJtThzc89jInYGss8yTCjWP2eGcusxdjZWS2VolDqxTPdUq0tMaJvM5lFUzGSnkqVYfIX/ShSadY8KSz5QkyVjJV73hL9ONakpEwEshFMMX8ORkLGMaVuYDDOkcoQRmdTm2fC2ExHK3VmYcq6N5AEOmOKk2WnUHJA8m/HST/KcgjHai5nYRUthYiFfyBzsFxdusslo7FJ5yaTEbSQSTKHGZ2jYjqCbjrzZaUjd3kUHlPSVRXr7m6hFpe7N0GY48zyWCRz/4i8O0tQfpqsWjXwSRXJ56mih2rE3ijdVFQkDJLaPLmgqtxVJr7ArpzEm9zd5O4mdx+Zu6uD5wUyKkYZ+uysQ58rIwG3rePNcw36OI4eY0VJxPCmcOSWgEEKiPTLu0sk9u/KEL36khIY/I74KGzla8L3K3+E7yOCH5Wzar4gAdmOQYMxKpGKeyz3QmI2VDDV7vpqr60baQSouQciomo6Mbe5kDCZy40hSaTfErFV3vyUialEfZTICO9DBaRVTdxMrSZkukGSGyS52Y02u9GPshttkOQmdze5+/fM3a8iyUoqzpYCJ/l8NpNuHiKtGCdtpQCBKM/oRJVy7KpVtELMRIWxGnXk0Bh1dkY744NIdWPZjfd3D8edaL8j9w52DnZG3c5BY3mvv17kcZVk9Zxa8nfwI5sYIO4TcFxuEFw+szauH//lfGpJZY1KT4WbYXOY9KbCjp3Ddex4aa14I828REi+hiHNwkZU00A7I1pX0oJAignqohEoVRpyUSjpmQIXh6ARiZ5pTl7SAnzdvNkfZ1AlJEoZZNUq2kRJDgm5EiSWULNFYGkoqcaE+cCBEewE1fk7otPCRX8KyYtz0viENBaDL5FSlOgVct+773x3COEd1YiL4OAHDnpDtyMNAgANQahZFe7c4PMNPt/s8Zs9/sfY4zf4fJO7m9z9e+buf4HPCzT0MD4HwaPxOWhb26LCUq8puP7nMJ1TpZCAw1vYKModHzeXGJxxBUJpcfOEr3bQrZJGO9yFaAZdffuWwuOufavjO76SQvgwiJa7BPTTLEt9rw06ZeCpu5ZMdQuFDE7L5sZ+bkV21h7BTPdUILoqELKNCET/bFh0GC22sdMUxqHmMfNgcdaKAhaW59Phr3KmCxrkyrnNUeWYzRbd+yhCij9DxBT9xE+eqVscQmv6Qa8rl9z9eV0Cowd0uc98X10N9AKSrqhIKtwsbhBdEPgOq6/dI1psKNSwddYWOyWyjnilpENnEH7DePbLu8vnYkKQk1M+94R2laYeAUlzhhDhktYvz/NpEu8yzuaTKQver/1iQikkxgkUFu/NhVLielgY4S1q/TmKM5uUJimuBzTr5lnpnVh9Ugltg62FJSnwdGzasFBb1uY95y2PewNt8Djjr633pimONVUiTVs30RQqcqsnrtNSL7mk11OF+EfJrRm4NZmbf74iRTDtdRRu4ETIY2IhE8/WevLigV9ziR81UvhCXFdlIEsUctR/54pKrz1Zjhq/JvGry/HevJtq7Kf1aSKUL+GxHSaxGIpoaq1X/xSCQofS4HqSI4ueLNZnWrTJGdHsbC+J1AxLNnUT6JDlO0FimBBMckS7M4MTC9xm4pCSH9izyPkP6J1j8aGmM3++xiZKlLGN/JNlpgWbtGAz1ABfyB/2KAos5DbpwHUgBMDRwv9cCQpBl+pe4HVvVWf2bZ7Dt98gKnPxaS+89BYFrngSPEDUFQ3KMIHr6pc/vIuCF21UNWOVxwKrFlyXN7HYH1fsFuStjqVoz/yr6Usa9xenJ6cmmX/vKv1AJfnr1N3/U8XbVJofsdIUcJfCjZct+oLlIH9V4LX10zw6bp4q/ItRzlVG1uhbuBNjFLPMKE1kRlHNWR1NteJzgFTJjLDfFkWWnXEmomWn9Ee3x4wmDjRIWw9MKkc6AT8+qS5XlpwwAViSX+nd59Vl5WiKvlK1xDu0ZiaCW6gto7sWGPtoi/7sAp45I8eK49LZAF2zWW6wGuVlPhMSIfWNiIi1j/JQuNClGVXawjL0q2aVWUyhRiq0uEFxM386piNmdK9Ljv/GWvC7L86XYXryYnHpeqHIuUo4MomuDtu/xRvR1pyqJKXGEFUXAEwtrfBmeLnGEcyMh15owK2btItJvk20YELtUQif3dZOa7vJ7QK+p9ZnaGVr4lPnJWo39Vdj8HZxrP7UK/vFvkGAv53SYRVJk4cGJPR81416z4dJveIaf0/H9LcDUwhPdLe3dK5BbdAdfUY/T03z9c2iw+HOEMalZ7SXY6T76nX3ZZ2enRcX45+LR97Hv1ed8oTOzBfNeQOPvyvq6XmUOrony/XYy/lPEA4GvqM/VggnQmy+MBDOjJamrP2qQh1e1ccfD04Gl/TXEPIBvFA8wFuoiP8BBg6hrA== +sidebar_class_name: "delete api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Delete Tagged Object

+ + + + + +This deletes a tagged object for the specified type. + +## Request + +

Path Parameters

+ +No content. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/delete-tags-to-many-object.api.mdx b/docs/api/beta/delete-tags-to-many-object.api.mdx new file mode 100644 index 000000000..58a1fcb07 --- /dev/null +++ b/docs/api/beta/delete-tags-to-many-object.api.mdx @@ -0,0 +1,89 @@ +--- +id: delete-tags-to-many-object +sidebar_label: Remove Tags from Multiple Objects +hide_title: true +hide_table_of_contents: true +api: eJztW21v2zgS/iuE7sO2heUkTpo0+XJwHLfnRRL7HAfFIg1aWqJtbiVSR0pNfUH++80MKVmy06bXLe52C6NAI4vD4bw+nKHp+0BnwvBcajWIg5MgFonIxYTP7URfcLUcTn8XUR60Aiuiwsh8GZzc3AfXVpieVrn4nHeLfAHvAhmrk5zPT1Ku+FwEtw+3rQA+WxwDdnMRM8fLBjASCxsZmeGysOhkIS3rjgbMiFR/EpbhRDYzOmVpkeQySwTTbnL7nXqnuizXH4VidzJf4LwW6/XHk/fds4vBZYsNx2/Kx3F/NFwNjIfn/cbz1fWp/3g1vB73qkFtyhclBeOgpkb9GYhqxL8KaUCjXLOIJwnLvQJtMBQOCpuf6hhsdb+m6VWRZdrkMNXpw/JlBvpyI1i31+tfXb0fjYevB+f9FrAbnQ963clgCBL1uhej7uANPPUvJ4PJef8C/rbY4Iw+/ub0QTXO3o+GMO23UqVSIhQ3OMlNIVpBhJ5TOUrHsyyREbl/53eLIt4HNlqIlOMTCgdC6zIGMoPBkkthcdS9HouZrdFyY/gSSGUuUvs0DzdaUdncSDUHKqGKFCOnaRQYqFkFPpVmgceaXeBTaRh4RMvAn5Vp6APaBgNRfOYphBesXZvS9NnZZEhuCh5ArfgxaZv0gzOmZxASovLxgmJmJoxQkWBkcwxyHdTX70THe692X708fBW97BxHh7t78BTxw9nxbrS3v7ePyyuePmouVSQJnyIb5+GmQP8oIClDI3iMNCyWNkv4kiGz75L0rUwSyVMGfzFkHkCwXOY05DLdJfoZTKMxQoEnI8Qr87Au/TmfigQzbVoKRHnnJG7XBbsJTq/fvx5cdi976PFRbwAw1FoB3FcDbTTqX57Bi4v++E3fQdSMA/gAcTW25ucZcyMth1eYxCCgULGTEO2aSJuTjQnQAFdWxm6zLjvY3WXCGHhPds8Lo2CunDlH3OkiiRmPYxYXLk2FY+SZez6IiCALCV4TJRUGQZcwEqnFZ5AFlCaKNjtrssQZViYACwlA3FxpwIuGcb1h6s4+LZKPdYfDIA4bYTOtrEvwzu7BJgpeAmw6DGIhkyomOSxJ6dGT3XHLbBFFwtpZkbBpgcEJYYmGUqvpLixWllOeiZOgjdEENt6UoAdhBNP7ZPuQjRumX0kxBRDHFaX6xBNJBvlB4BmLnMukp+NH87kp7GupRDg3XKKELlwimMiA4ycZo0tTcBdzLMuMJrqmB8ES7T12ymPQ1+nX88qgUw2PPgKvwTcg3LWSMJ+VU5iMq9h+ZFlxJPj0cPe4czA7POC88+pg7+jl9HjG9/d3j18eH+PqKfgZyobHcKK59BuhhJERSzRsvPLfYBDANbA9CUCLf/vmQzy+wf4TTGSirdT08jKsgFqMs9PeiB0csYSreUHv+XzNCCq8vtpAatDcMR4aOZdfBaiz/uvu9TnubeP+P6/7V/CEvDZqqa4qMwpEhVhY6DuHRE4Byiuo8SKoQdrshef6AhTiytYJpftklxaMyTwYwgy/+iMz6qxd8VZPpciVi+yZbIt2C7IW3qU8jxZsyi3WQy51X3Qh57M8PPeWfMEWsG8J8xzgMo4lKskTBtkITGH+knaFOF7l/qyAVBYEexpAQ+lcRqLpi5Up1/fNEtnO607B5ADJn46TbpQXIBypWc/CKlq8iCXixd5yTekm6yi4VDmPQAsoNJdgRmNwp0ZAlLmtgFCi7WGbL+kqxKoDNsHdhROm3J0jXthvyLtRAvATkmrVwCfhk492JIdG5I3STR6R/HZFkz1V5a4y8dlMiiTe5u42d7e5+425uz449lWPH6XSZ2+z9LlWvpfFzXOj9KkqrJKIyhvvSOqMfYn069uJ78KBXnzOpC8Yf1B95LbyDeG7lT/c+ykVtKWzGr5AAcmOToMZIJGIT0julcRkKGeq/c3VXmszlRCg6pESEVDTsKUuqHI2hVIoCbctFmth1S85W3DAR04VrENAXFXFYaalyreV5LaS3O5G293o59mNtpXkNne3ufvXzN2vVpKVVJQtvk6yRZpys3SR5sdRW86AoDp/Y1XKkavWqxVkxqoaK2hWDsG0szfdmx1F4iDmB/Hh/vGsEx12+MujvaO96UHnKKjv9TerPK6SrJlTNX87P5KJoYj7BHVcoSC4bK513Dz+A/MaMUNYQ+ip6mawOZj0tqodO8ebteNEa4ZfoJUVkm3UkGplI8Q0oE2R1pS0QMDZHHBRMYAqCXJhKMlUABeDh7aJTCUlL2oBfM0y7M5yUMUlyvpJKHyOkgIkJCRINFbNGgJLgpJihjUfcKAKdg7o/AOrU++iP1TJszFqfI4as/7nSAhM9Kpyf/nY+e4AhDeIEVfOwV846HXdDlcQANAQOMyq6s5tfb6tz7d7/HaP/zn2+G19vs3dbe7+NXP3v6jPfTX05focCL65Pgfa9i6raqnXdB/if12mU6p4CSi8mY6iwtBxc1mDU10BoYQCZdoSiHC8lxbs5HRBIfTXx3amRfIxdNfMArzUhtWhE6wwCdAv8jyzJzs79+Av8NNDm2eyDTAGLsuXSt+1I53uTMFIj+APXhRwuYYEdKHNLdAmCxuJQewQj5g7e5e3TCzYnc6Gv8q5vLSz1AVgHLFp4e0kH1D0GkTMoJv4xRJ1mwJoQz/Q69okD39cF8foC7o8Zr6vrgb0DCRdUxFVuF3dQbzC0tutvnETcbWdYLvW2VhsiGQddiq4gb7AfYPx7Ne3k+dsjgUnJXxhsdYVEjsESJkRhAgBWrc8zcdJtMcYXczd9Zpu4/sSTCA2S0Bh9k5dCcFuBt4Il4D0Y4BmMilOEoQGOOv2WemdWHwSCW6C7ZUlMfBkrHbAQju8Me85bXjUGUgFjym9bb9TITuTiEMSN26k8SpSo8duslIvXtPre4X4W8ktdNxC4mafr0nhTHsTufs3EWQxsuCJJWt99+KOX1jjh20UvEGu6zKgJbwczW+5otJr3y1Hg1+I/JpyvFNvFxJ20+Y05sCL2QXd+BqwaKG1FX9nDEMH0+BmXkAWfbdYd7hoSBkRdnZrIoVuyVCGUBuSfOeQGMoFE5/i3kyliYaqTcUuJT+QZyHnP0DnHLMPDZ3p9Q1soUgZ68h+t8y4YIgLhg4DrJff7VAYWJDbqAPhgAuA3sr/hARe0BruOV6Pojqx36E5uDVEICpxsdmJ+3CyAjj/xGgAqSsagGEsravv/fB6sOeF21TDWOWhwLoFN+VNNOyOa3Zz8laHUrhj/tn0RY27q7OToUqWPxqlv4Akfx7c/T8h3hZpfkak8cUunkGOV78z6JdtSfNS/k2VZbW77XiD/em75uVV84273rVfdWxetm7ctS4vDMOSkBxkJN/D1FPy1FeXmyePeDS+EPA/jBKyUBcAPdbqSnOdUZbwHHOQMChaSEFnFpngOVaqLcwDnRJuZEYjWEFnSozmBmgAZCxU0HwqE+BHp+rlypzS25XBGIV0U7rw9+U1JBD0wKLN3kIbqSIIImwh8V4IjP2ufS95BXE0wjBkZ2VoQomYpoXCX5SA2EXKOCTAE/EbSxsVDmaho1SitIWmQrWaVWIOJgaq0KZmyqR2OMPjcOi0a2H6xFoQpdafhYPp0Ys+MFaKjEVCLke6ZpPxFG/IjXAhkgyDBPYIKBdFbYWLwWSDIzBTFvSKRFub+Y6fZHeQFphgM+fCZ7+9194NqbmB99gTQttdYz6mFpBNqh8aXZQ/NCp/pbQWkPer7wN+rt8reYjADmonw7M/NFjhOjrXRN8EzSYaJtXbaEj7BfbcQHd/j8dE2Fc+4GsAKDyDuLldtYz4Cfi74yKCqI8Cjyn89xPhZEn1hT+P2PziBTtZN8MdQX2V9rZ2LDAa4mFcMPU/y0rdCYfhd/AS/z8J3sG/ACHMBTMQ0fv7oDwvBBrHtyzkHqtj/AOq+fDwH4VaOw0= +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + +
    objectRefs object[]
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/delete-transform.api.mdx b/docs/api/beta/delete-transform.api.mdx new file mode 100644 index 000000000..84a4b6f27 --- /dev/null +++ b/docs/api/beta/delete-transform.api.mdx @@ -0,0 +1,96 @@ +--- +id: delete-transform +sidebar_label: Delete a transform +hide_title: true +hide_table_of_contents: true +api: eJztW1tTGzkW/iuq3odJUtiA44TBL1sOkC2myITlUnkgVEXulm2RbqlHUkM8FP99vyOp2zcISSa1M0n1C9jqo6Nz13dk9W3i+MQmg4vkzHBlx9oUNrncSDJhUyNLJ7VKBsm+yIUTlrmpYK6mY7YUqRxLkbHRzD+ayGuh2OF+lw2dEwVmqwlzmmV+OuMLc92UOyYtqyymS8W0EkwbVmgj2GEmlJNuxo6NHstcsIKXJVhZdiPznBlhq9zRJK6YMEabLjscgyPY6TStjN1gM12xorKOjaXBXyMKfS1WxB8bXTAOhg37kRjT+l5cL/oiffe9GkKZj9DwRrrpAqNavcpNtSG5IYgRf1TSQDeon9IiXrzh8WE32Uh0KQwn0x5mMG6Y3pgfz0tueIExQ465TRS+gE5meCTJHSV302TVR4f7TI9XVGxsD+paomTgTCU2EutmObG1sihzIhCfylxnGBrz3BJBOhUFTwa3iZuVntIZWCW5I1LuJw2SXprt/MqzyfTq4xV/3r+a9kbb049XU24rkWbJ3SUtbEutrLDEqrfVp3/Lov8OG2nl4HXWgV8zmfI62khqAQ/ecMtslabC2nGVs1Hl6DGcBauq+XQoPKJJrjIqBFZgEiTokuz9ra11CfZySdMPKJogw0nDYLwkxUhn3rtSXfNcZuTLuDKxRBjlJDpYbl5Z4nu7bkQ9uhKpIycbCgMng10y4bjM97z9Vw2+6unXUonOxHBJEvoEgP6ZYOB4LTMK3CKEMbGsgyIkSrLoO1iiu81e8Qz6Bv32ojIwE4Io/QheFKKPCXSuJOazegqTGUP4PbSs2BF89HJrt9cfv+xz3vu1v73zYrQ75s+fb+2+2N2l1Qv4mU+CaeLa3Bg+W1v6P0IJI1OWa2SZ/BMGMYLD9l4AvzglDYqRfdwHnscX2P8MegXaRs0oL3Pik9tAoXu1d8z6OyznalL5cT5ZMYLqnJ9iRFV5zkc0RFkJzQPjt0ZOpLpPFKGqgsr1/sHr4fnRGUZODv57fnCKT8RrrXQPVZ1REBWxMNU3XuKogM8rlIjUiazLnkWuz6AQasgioQzf7MzCmIitMUcRxoy4+j0zFlmHYruYSj5vPjn2RHZFdwNZi7GCu3TKRpz2BB1S99kQOV+6zlG05DM2FTwT5in2mCyTpCTPGbIRTDF/RunPs2ye++MKqSx8ydYoGko7mYplX8xNuewNJIF0nuJo0SmUHJD88TgZpq6CcF7NxSxsoiWKWFe8LFpuWbqz1So4U46n0AK7ygxmNAYW9gVROtsUQkm2L7iq6ZqKdXc3V8uXuzdBmH2n/bOUV/YL8u44R/npeNWaB9ciJp+lOhyqkfdG7aZYkfDQb1M0OVI17qoTHxu3yLM2d9vcbXP3C3N39eFJRD3xqYc+2+vQ51xF4Eqb5xr0aRBWTeThTXTkBkH2CJF+e3cW0THoASUJan5HfBS28jXhh40/wviohu311j/3BQno7Rg0GKMSiWzg5Z5L7A0VTPV8fbXX2owkAlTdAxFRNY1vOzhMZiqlSBKOViTTwqpfHJty1EfuEWyogLSqyjqllsq1SLJFku1u1O5GP89u1CLJNnfb3P0xc/ezSLKRymdLxEm2KgpuZiHS4nPSljMQNOdvrEk576pVtELMWIOxkmXkkIx626Pt8U4q+hnvZy+f74576csef7GzvbM96vd2ksW9/mKex02SLefUgr+DH72JAeKugeMqheCyTuts+fivoqPkMZU1Kj0NbobNYdLLOXa894zTQTcwBnY0Dxwvnp8cEX8s7dmT3XRlUn8yHkwXzs0JUlIMw9LSuhY6ttCx3X7a7een2X5a6Njmbpu7P2bufhV07D8GHftfAR37jCDWmCDW3wkdM+AOgmZjOAU6pBXMqwg2llAFn+LpY0x7x81EuAboLaHI3u46ijzTmr3halaDJbt0Eqnm5qLyBtqCaE1NS1cm4iUNVC0JdEtRJQtBmBTxw3JZSJ/HpBD4mllnOHbQKuTM6u/p+J7mFST0RSHX4bbHDZeuvkoBDv4cdIJC/R3POKO3/tJ5MDshjY9IY3bwKRWCcr45/31x3y2BQwhvqFycBl8/cF0gnJlzhTZCfCpD+WogaAvVW6jebvftdv9zbPctVG9zt83dHzN3vwKqRzT0MFQHwRdDddB2t1iDpV5TcP3fEbtPlSiBD+9wddhfWqgxOIxgBQalm/lFzgHx90IoDys3pcyUmRo0120H8AGh0ku69VoIBOH8ei8VILq1O0g2G3q7eSuzu4RWITgZNKlMDqKpc6UdbG7ewsFw7F2Xl7Ir471opW+6qS42R7DqPQWL7qeG5CQCunMce5Oud4mRFPWhRHrmwUHeCBTfcJS/kvBZznQlmTw/Q9vCApsNhgyJEeiHIWKJ9uMX66m7PuLW9INe5ya/++u6BEYP6HKf+T67GugZJF1RkVS4nAfFKWH1sPpaaMz3H/qVoLe22Fsi67FXghs0EuHizJPf3p09ZRNCqL5CVJbAsZDUUiDHjhEivgIO60skNMlvSkZXk6kXfLh0TYcyjo1zKMzeq1Mh2EV9t/53bA0nqOXepDRJ+PJBsy6f1N7JxLXIadfszi1JgYeo34SFNvnSvKd+h/SthFQU3360+1512L6kwiVppyeaqKLvDNlFWevFF/T6ViH+VXPrBG4dz80+XZEimPYiDde+U6Q9seC59db65sUDv84CP+q7MEJcV2UgS0Q5li9XpbXXvlmOJX4d4rcsx3v1biqx/S5PY6FmMYvdM8/YIUunWlvxb8YodCgNLiYVsuibxbqhRTs+Izq9rQWROmHJjuwATHr5jpAYKgQTH9Fm7rGMDscqPiU/eM8i5z+g1c7YhyWd/fAFvVcCykyn9ptlpgU7tGAn1AAb5Q9bGgUWcpt08HUgBMDe3P++EkRBF+pe4HVvVffsN/0c2hpSiOq52HIQvgzmBS5+Yv4BUTc0KMOExZvrZvQKSuRF+9qSsepThFULrsuba2ynK3YL8ja/hdIW+0/TlzQezg9b3qp89r2r9AOV5J9Td/+mitdWmp+x0kR0TOHml41txGKQv4p4bf3wz/oX8fAXT32ueiCONie+VzedvwFIjMqcu/plNp5OpfDHBqXgjrDfBkWWLnwmosOn9Bc2MJoY0CBtLTApH8kc/PzBdr0y9wkTgCX5lb7bKl6z0AhJtKGiy96hk1Mp3EJdHF3wxbMrHdu5U3jmmBzL9mtnA3QVRaXoPUCIXRWMI6QeiYhM2rQKhQtNnRK1LbSHfs2sOosp1EiFru9n0Ei8HdOJNJrdBcc/shb8buNxNExPXoyvGc4VORG5j0yiW4btj/FGtHWmIi+pj0TVBQATCyu8OTxb4whmKv4Gos1kM06ym0QLJtQehfB53t3ubnV8u4DxUluHrmtJ/NV3TVcj8HZ+Bt++2Pp9X2yNuym1QZslnfiRj6rQloX29yKZt7+YMJAZvW08hRvp2e0tHQhRQ3hHw39Ugk4bLi7nvZ7vkRFm9DlrXlV90L9PTqK4T9lj78feK3t9pqlm8+OMBB8/CjoFkfSCK6jCMZUXLTwIB1kLU9Z+6lk6Itg/ODo4O0gCLLsPlcQPsATq7v8AWa2cFg== +sidebar_class_name: "delete api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/delete-verified-from-address.api.mdx b/docs/api/beta/delete-verified-from-address.api.mdx new file mode 100644 index 000000000..226e7abf7 --- /dev/null +++ b/docs/api/beta/delete-verified-from-address.api.mdx @@ -0,0 +1,95 @@ +--- +id: delete-verified-from-address +sidebar_label: Delete Verified From Address +hide_title: true +hide_table_of_contents: true +api: eJztW1tzEzsS/isq78MBymMnxpBNXrZMErZyKlw2l+UhpAp5RrYFY82spAnxpvLf9+uWPL4lBDjUngM1L2DPSK2+fa2vFfmmVZTKSq8Lc5S19lqZypVX/1ZWj7TKXtpiOsgyq5xrtVtejl1r76L1uvB4m/Ik17psY5JLrS7pO0QcsAghxVWUIpwymbJCTaXOhazlldLKKYZaknrT0jS5lH6CVwYv8E1n+OzSCWa29m5aflbSU+etNuPWbbtl1X8qbRUU97ZSt5f0xJXQSjka39vq03+r6r0uRFoYr4wXidAmI0OUE36iBIlTzovP0glXpSnUHFW5GFaeXlsltBNmMd0XYkiTfGUNrNQmCgkadEjB/tbWpgb7uabph9YWFjqc1AJGK1oMi2xGK2pzJXOddeCKuDKJlGWZxxh0PzqSe7PpqWL4UaWeXG0pzF4Hv2TKIxL7RaY2vboezZfaqGRspSYNFaucYqKAxCudYYaYFvBMECmKYAKPI4XVtZyWOYmHJzrb4oXMYG+wbz8aAzd5K9NPkEUp+JBC50ZjvphPEToTIyh1z7JqR8nh863dXn/0vC9l7+/97Z1nw92RfPp0a/fZ7i6tPkWc5Ti4Jq4trZWzjaX/qQxSOhV5kSIi/4VDrJLwPSvAi2OK9mrqHo4By/gK/5/BrjC2NjPqK7y69m3g7MX+W9HfEbk044qfy/GaE0xyfkqoqvJcDukRw6UdlXhj9Vibu1RRppoS4g8OXw7Oj8/w5OTwX+eHp/hEsjagPzBzREFV5MKk+MwaRwMYV6gOqVdZRzyJUp/AIGnc8kAdvrmZgzORWyNZ5R4z4up3zFgWLUYoWytQYtxce/FId1SnDdTi2VT6dCKG0mFCEaD7ZADMlz45jp58IiZKonI97ghUQU1GylwAjRCK+TOCP8rZAvujClCGMtpPChQNg0KZqtVYLFy5Gg2AQHsecbwcFAIHNH84Twapr6Acm7mMwjpboorzipdFz61qd7ZeBWfGyxRWyDyfwY3WwsNcELV3dSHU5PupNPNxdcW6vV2YxeXuVVDmwBf8LpWV+wrcvc1RfhI2rX5xpSL4HNXhUI04GvMwxYqEl2Q2T46j6nDNgS+wS+VZg90Guw12vxK76y9PIuuJb5n6bG9Sn3MjK/jX8ua5QX1qhjUfxPQmBrIt4JBIkX5/dwZgf1KGxqvrkjjgD+RHYSvfUH5QxyM8HxL9qIO1EgtSkP0YLBihEqlsj/VeaMyOCq56urnay8IONRLU3EERUTWtmBWVkHCZrYwhTaRri6xQzvzmxUSiPkpmsKEC0qomS8pCG98wyYZJNrtRsxv9OrtRwyQb7DbY/Tmx+0UmWWvFaIk8yVXTqbSzkGnxPVkrBQbU52+ihhyHap2tkDBRc6zWKnNoDXvbw+3RTqr6mexnz5/ujnrp8558trO9sz3s93Zay3v9xQLHNchWMbUU7xBHdjFI3BV4XEWHo84XRbZ6/Af3WjWiskalp+bN8DlcerngjneecXrYBsHgjvae48Xzk2OSj6VZPPmtqGyqiGYH12G49EwpKYfhae18Qx0b6thsP83288tsPw11bLDbYPfnxO43Ucf+Q9Sx/w3UsS+IYo2IYv2Z1DED7yBqNkJQYENawb2GaGMJU/Apnj5G2Htpx8rXRG+FRfZ2N1nkWVGIV9LM5mTJrZxEmoW7qLxh7JTG2vlYDJBijBJpBKqWBrulrNJTRZwU+SNyPdWMYzIIcu0sGYw8rAqYWf97Or6neQUNuSjkBZ29FsgxjXRSI6J/kMDnoGMU6h94xhmj9YfOg8UJWXxMFovD61Qpwnx9/vvsrlsCR1DeUrk4DbG+57pAODOXBm2Eui5D+aopaEPVG6rebPfNdv9rbPcNVW+w22D358TuN1D1yIbup+oY8NVUHWM7W6LmUi8puf7vjJ2hEjXg9BZFylw9W3Bw5hVIpcUlXCojdBt2r9Wd36RNKNuTeINWue6Nzm4xLHQDQbnK5pgx8b50e93uDWKGWN12ZKk7KGUIm5+Z4nMnLabdIRx1Rw2iK6cBbzRADN4exXajw162mhI5VD0WHnzOdlHKwvd8y+CLkul+LwVzhk5EBDFtgaSPScWPoWKJjuI3x6M7nEQb9sGuc5vf/nFbgqB7bLnLfV9cDeMFNF0zkUy4pHAh+BDE8TqHPvuhZA0qivbF5fKYU6LoQcONkYtth/440NtQ6A0N64kXSlr0D+G+zKPf3509FmMiplwYKkecWGnqJACtt0gjLnyD+d0RmsR7kS2q8YSNG6zcziGgiVEOp4j35lQpcXEUHfUaO8IJSji7nSYprho06/LRPIKZulI5bZadhbcpOXVmuvBiV67Me8wbI3cQ2uDjlJ923ptEHGiqV3QlncdEE7khFBfl3C65ZNf3KvG3ubQkSEtYmnu8pkVw7UUabnunQDuJkLljb3334kFesiSP2i08IanrOpAnoh6rd6rSedS+W48VeQnJW9XjvXk30dh1V6eJUOSEw6aZZ+JIpJOicOofQlDqEFQuxhWQ9t1qfaZFE0ZE0ttaUikJSyY6AYdk/Y4BDBOSSQ5pD2cKU4TTFIbtB44s6sIHdNiZ+LBiMz++wFZLI7Midd+tMy2Y0IJJqBMu6h92MkosYJts4DoQEmB/EX+uBFHRpdoYZN1Z+Vl8l+fQ9pFCVZbiyr3wZW9RBOMnwS9odD0GpZooeH3LDN9FlEXb2Yqz5ocH6x7c1DcvsIuu+S3oW/8JlHbWv5q9ZPFgccbyxuSzH12l76kkf526+ydVvKbS/IqVJpJiSjdeNnYPy0n+InK6zTM/OpSeKPyLt4xV5t/obrhfYxazLKjMpaesZlSnE634tKBU0hM/bFNmFVNGIhr7lLl3EDS2GAPYOvBWOdQ55PF59nxlyYAJ5JPiSt9dFW9XFEhJdJ+qI96hgTMpwkLNG93rxbuPReziThGZtxRYcTAPNkjXdFoZrEa4rKZCIqUeyIhMu7QKhQu9nFFzXxRM/epZcxRTqpEJHW5j7NS9GdFBNHrcpcA/sBbi7uIpNFxPUYy/61sYcqLy+DvC9hq1f0g2si2ZqLyk9hFVFwRMLa3w6uhsQyKEmfinj8KOu3GS69JYCKEWKqTP0852ZyvhlgLPy8J5NLwr6vMvHOe/khT0M0mx+J3kSi7eLA7hv/6XkXHHIKrfLekwi/SoQnsSesKL1j09IWbv6Yx+lTmB3jTw5oYOPqhLuqXHaPipq764XDRA3IjAr/QZ/ecISFdfMOPRSfzZ5WNxn67z4zkzW3TmLXz8pKihh35oe6Ehn7jw6uFFOJNZmrLxVwvqjeo++eDw+PDsEJXif3BHjkQ= +sidebar_class_name: "delete api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Delete Verified From Address

+ + + + + +Delete a verified sender email address + +## 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/delete-workflow.api.mdx b/docs/api/beta/delete-workflow.api.mdx new file mode 100644 index 000000000..3eccdf1ca --- /dev/null +++ b/docs/api/beta/delete-workflow.api.mdx @@ -0,0 +1,83 @@ +--- +id: delete-workflow +sidebar_label: Delete Workflow By Id +hide_title: true +hide_table_of_contents: true +api: eJztW1tz27oR/isY9uEkHlOyZTmu9dJRbKfjM85J6svkwfFMIBKSkJAAC5BxVI//e79dkNTNjtOctD0no5dYIhd738W3EHIX2UI5WWprTtNoEKUqU6V6Z92ncWZvo+2olBMfDa6j5pGPbrZB5ROnC1qFNce8RkhxW9N0hNjaOjFylKm0fehFIo2xpRgpEaSkW1ugvJyqmcgrX4qxdj681p7XdiDfq6RyupxBh7voyit3ZE2pvpTDqpySXr4YNBIGuTRyoqKbe6hYSCdzCHGeVxp8gao6BUtNShcS61ctOU2FHYtyqsSCB5z6Z6WdgndKVyloVM4y4uV1XuDDdqS+FJlN8WgsM08EyVTlMhrcReWsYMrSaTNhSslrBlGyezBSck/G+wf9NO7v7yXxodrpx/29F/vj0XhfjndG0T0Z4pQvrPHKE8PeTp/+LGv9mxUJOcWUIhbapDqRpfJsBumu4NRb6YWvkkR5P64yMapKeu2U0F6Y+fLSkvudKitnEDptaiZBg050vx31d3bWNTjKNC0/cc466HDeMhgvaTGy6YwkavNZZprDW0smlrIoMlIdLLsfPfG9W3elHX1USYmFhaPELXXwS6pKqbMjjsK625eVfaWNiidOatJQscoJFgpw/KxTrBC5dZSjxLLJB6brLIUQnujsipcyhb3BvqPaGLipdDL5BF5UVE8pdGU01otmidCpGEOpR8SqAyVHL3YOe/3xi76Uvb/2dw/2R4djube3c7h/eEjSc8QZleAXZEvn5GxN9N+VUU4nIrMJIvIvOMQpCd+zAiyc6qVUuX86BszjG/yPgg/yVGtmra+gwt5GI3l59Fb0D0QmzaTi53Ky4gQTX13giamyjFpFqE1YHhi/cXqizYMVaKqc2sbxyavh1dklnpyf/OPq5AKfiNdabxuapqKgKnJham9Z49oAris0swTdrCO2aq5bMEgav0iowzc/83Amcmssq6zEilr6AysWWYuxs/lSKSWhC4pnuqM626haPMtlmUzFSHossKF0t4ao+aKMz2pPbompkqlyzztimKaajJSZQDWCKdbPqPxlms5rf1yhlKGMLqcWTQP9WydqORZzVy5HA0WgS6Y4WwwKFQc0fzpPhklZQTk2c7EK22ypVWw6Xlp7blm7y9UuODOlTGCFzLIZ3OgcPMwNUZe+bYSafI/tpKFrO9b9/dwsbnevgzLHpeV3iaz8N9Td2wztJ2bT2hefVV18nvpw6EYcjSZMdUfCSzKbF9dUbbiawsdeqrJ0U7ub2t3U7jfW7urL8xr11G8Z+uyuQ58rI4FErePNcw36tAirIWJ4UwdyW8AhNUT69d0lCvuTMkQPQEmA8wfio7CVryk/bOMRno8IfrTBWooFKch+DBaM0YlUOmC95xqzo4Kr9talvbJupJGg5gGIiK7pxMxWQsJlrjKGNJF+W6RWefNLKaYS/VEygg0dkKSaNC6sNuUGSW6Q5GY32uxGP89utEGSm9rd1O6fs3a/iiRbrbhaapzkqzyXbhYyrX5P1koBgvb8TbQlx6FaRSvETLQYK1pGDtGotzvaHR8kqp/Kfvpi73DcS1705P7B7sHuqN87iBb3+ut5HbdFtlxTC/EOcWQXA8R9Bo6rDJLLl9amy8d/cK9TY2pr1Hpa3Ayfw6U3LXbsHa5jx0trxWtpZg1C8ksY0sx9RD0NtDnRuoYWBFJM0BeNQKvSNhzz6lyBi0PSiEznmouXrABfN4uH4xKmhEJZPQnF9ySroCF3gswSarZILE3H12PCfODACHaC7vwD0Wkdot+F5MU5WXxGFouTL4lSVOgtct9/6Hz3FMo76hEXIcCPHPSGaUcaJAAGgtCzWty5wecbfL7Z4zd7/M+xx2/w+aZ2N7X756zd/wCf12jocXwOgm/G56Dt7IgWS72i5Pqfw3QulVoDTm9hk6RyfNzcYHDGFUil+YUQaiN0YWIQddv7HN07nd7zDQ3ChEGdymWgmZZl4Qfd7h2ihOjcd2ShO2heCFQ5M/a2k9i8O4JrHug6dD0gVBgRiOHb03qq6LBfnabUDX2OmQcvsyWUpPA2nwh/lTNdBqHwzWyFzsZstgXSvE4jfgwVC8wQv3im7nDarNkHu65cdv/7bQmMHrHlIfd9VRroBTRdMZFMuJlfqLkgwB2kr12rmW8iNKT11oS9IbKeeKmkwzQQfrd49uu7y+diQjCTy7zyhHCVprkAhfIWKcJtbNic4dMi3lmcrSZTVny49CsJlY0I94nemwulxPVp7YTf0N/P0ZDZpbRIcQ+gVTfPmuik6rPKaOvrzD1JiadT04WHunJp3XPe5nge0AYfc37aeW9icayp+2jarommNpHHO3FdNHbJBbu+V4m/NNziwC1mbv75ihbBtddJuHWToHaJhcw8e+u7hQd+8QI/Gp7whLiu6kCeqPVY/m0raaL23Xos8YuJ37Ie7827qcYeurxMhJYlPLbALBWnIpla69XfhKDUoTK4nlSoou9W65aExlwRcW9nQaU4iIx1DETI+p2hMExIJjmiHZkBiQVWM2koyQ8cWdT8B8zLqfiwZDM/vsbGSZSpTfx360wCYxIYhx7ga/3DvkSJhdoO1/pQ9CEBjubx505QK7rQ9wKvB7s6s+/yGtoaEqjKXHwxCF8G8wZXfxL8gqhbGrRhAtTtr334LmpetDktOas5Clj14Lq+mcWeuOK3oG97FEX75B/NXrJ4OD8xeWOy2Y/u0o90kj9O3/0/dbxNp/kZO00NcSndWGw9Cywm+csar62f4NER81ThX7zlWmU0jVmFpy9GMYuMikyWlNVc1clUK579CyVLwn7blFk250rEmE7ljwmPGU0caFC2HphUjnQGfnw63UiWXDABWFJc6buveAAhWckUs6TqiHcYx0yCsNAoRvcr8O6jrWeyC0TmLQVWHDfBBujK88pAGtVllQuJlHoiI1Ltkyo0LkxmRjW+sAz92lVNFVOqkQkdHkpc7t+M6VgZE+tC4J+Qhbj7+kwZrqco1he854acq4wzk+iWYftTvJFt8VRlBQ2D6LoAYGpBwuvTyzWOYGY87MLQbd2kWy/yXaIFExqPQvrsdXY7OzGPC3heWF9ifF1Sn6/SN7fPxcsZsmk1Ce/mZ+n/3bv39fZCc0G3oHMsUroKc0oYB6+jVgToBzql/x0whVn06u6OTjloQLqnx5juaYS+vpnPPjwzNhLb+/OPGvvsvL6K/1w8eFP/QX2b0zkzmw/mET5+UjTPQ2NMvdCZD1xYn/AiHMksLFn70YKGqXZMPj45O7k8iQI2eWhrrj/AfDSffwOPBVMu +sidebar_class_name: "delete api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Delete Workflow By Id

+ + + + + +Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. + +## 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/delete-workgroup-members.api.mdx b/docs/api/beta/delete-workgroup-members.api.mdx new file mode 100644 index 000000000..338d2c1ec --- /dev/null +++ b/docs/api/beta/delete-workgroup-members.api.mdx @@ -0,0 +1,91 @@ +--- +id: delete-workgroup-members +sidebar_label: Remove members from Governance Group +hide_title: true +hide_table_of_contents: true +api: eJztW21v2zgS/iuE7sO2QfwaJ47z4Q5uk3a9aDe5xEFxSIIrLdE2txKpJaWm3iD//WaGlCzZzku7vbvdhVEgtSVqOK/PPKSpu0CnwvBMajWKgqMgErHIxAdtPs2MztP3IpkIY4PdwIowNzJbBEdXd8GlFea1Vpn4kg3zbA7XAhmpo9visaNbGCqCm/ub3SDjM4sD3urPwiiuQsHe4hgbwM1I2NDIFKeHycdzadnwbMSMSGC0ZVoJpg1LtBGMJU4XNjU6YZytymsyNmSZ/iQUu5XZHOXsstPzt/8eHr8f/cw46KnRAAZzGPFrLo2IYDwLeRyzzM/cvFbX6u+M7ey80XGsb6WasakUccT0lI0ioTIvgSumSW0e+wFSgRRBooXNmjs7pSjFE7GzAz5MuYGPGToUvYjXwerSaxCA3UCiI1IOTl31zugYlcA51kyHsYVJwVFmcgHxCuci4cHRXZAtUpzGZgasgZHiC0/SGC91w0HnsH3I+4edvfagzdsd+NTrdDuDzkCEIQ/uMYDeolc6WqC4ulLvpM1QLel8IyFo4NOJ8CGMXLQ2hKsMZwwSNhkQYn6pDKfkaRrLkJK09YvFee8q9j1TIR5FoA5kU6EZXH6GWt573Bi+wPBkIrEVr+rJLyLM1mPlU+UHyybcypBFIuMytigxNVhyqNlSznqUHpR3PD5lOBhFCZUnWFuj45Ofx6Pxv7CkluEtr96D3tHzJ2Gj4+ZKnvQhT3jvYMp5JESv3TmYTnqi3TkMu+2DXhcncMn8FXZE0qYxXzB8sD7dexnOuYiZ/99CGt5X7l+Vk5QGOvuC3kGPi/5k2h90RG8wjSb93kH7gHdFjx8ODvb2g0LNYBhFUrCLBIAiIJCSGU39Ko8/rYLfuct/1OIe09SmWlkXvG67/3AGOiiNACoipnRWfq9kJhXHkyn4jZWAtmDWPzzBubfla/K8nr0urTbFGEDRVOpwgfg4QY3c5KRYy5ViiZlLNTaA1ZPBheDYjGe5XVfpWo0BNn8cj89YET/mxrJQR6hAlhuFaAX4ANAuVSQ/yygHcC/0zeY8K1oH6OrHUkxhDhblqDAACtnoQs3K1urbSrfdY4w1ao2khpOPp4IT0tsgBNPL6wkuX2sP1+pRz4Ja6Lyay1Y9+GOegF+M4BGfxKXzKmMozTFTuVTkCagw3x9DxxTAq+CyhLvRE51nzOZhKKxFVJ4CPOYQHCay8CmF0Q2l+UVZPduB52IqjIAhGyrDlbwjEEs4jNh1MAn3eL/XO+gf7u/1xKR/yA/b7a4Q3fbhfjQ96F0H7Ja7SEx1riK0weFF0daQIwVljlZAZwVwjsmgERRgsAJ7zwW5ogwosg+i/Fc4roaRK+oizDiVCzjxSNlrt9fz6HUsYXp2YgzEvAGx8IUnp1X2xCZANjCxpfrMYxl9FQo+jliuEb+Gqn+6W72RSjRmBjIaNBSkMsEFSAR0wCwnZupEFuSMxtUbGnii2WGveMR8L2GvvTHgpszw8BPIGj2jQ18qCc+z4hEAV0KhB6YVfcEnB+1Btwf5yXn3sNfp708GU74HbG9/MMDZEyg/PqtSkbIF1Kd+K5QwQGRiDYRZ/gYOATAA35MCNPnzuwbJeIb/EbTd2NJMry9DQNkFuH31+oz1+izmapbTdT5bcYJqXF5g48/jGKHL0Uuw3Ak+NXIm1Uaa7LnV8cmb4eW7MVw5P/nn5ckFfEJZa4uXoWsbkJaaUHiub0ljbwCCg4UyCaHkmmzHS90Bg7iy1YHSfbMLaDIJ5NaU53EGT/jZNzxRFe2quVpKBfq+kE3R3AUmDNcAhMM5MlNkxG7dsjMEKE6zxjvvyR02B7AX5mWTDZdQDtUIQuH5xZJS+4XPNIdSFgSdCO0AhDJcIXZLV9ajscSWd9WgYHGA5k/nyTDMsFWTmdUqLLPFq+jjAzo7z9W1G1ecRi5dQDMLwQpYIC7AjcaAh6G/QyPLLPNwhOGyADyqGFciFkJgYRbB3XunzHGm6V7Ic/uMujuLAX4aZFp5gygTFh+tbRwaiWrH9YgEN9FsetiPKsNVFL5bvW5rd1u729p9Zu2u3ix4j79L1KezTn0uld+Dwua5Rn2McES+2Kj6zfFkF8hdZMieIv30Yey3uWC8+JIiufyO/Mi18jXlh2U83PUJ0o8yWLVYoILkR2cBEnsRHZHeS43JUc5Ve+uzvdFmIiFB1QaKCKhp2ELnjIPLTK7casPuskgLq37I2JwDPnK3sCAExFlV1Ei1VF+3nt4yyS2T3HajbTf6Q3ejLZPc1u62dv+ctfsokyy1omrxPMnmScLNwmWav4/WcgYDlpvbZclRqFbZCgpjJccK6swhmHQ7k860H4pexHvRwd5g2g0Puny/3+l3Jr1uP6j2+qtlHZdFVq+pSrxdHMnFQOI+A4/LFSSXzbSO6tt/4F4jpghr9DNdwZvB57gXWXLH7mCdO461Zu+5WhQMydY4pFr6CDENxiY41hRjYQBnM8BFxQCqpKYffjOZCJBiIGlYLBNJxYtWgFyzaAynGZjiCmX5M7CfRaowzkFDQoJYI2vWkFgSjBRT5HwggRjsDND5O7JTH6LfxeTZOVr8Di1mJ19CIbDQS+a+v2l/dwTKG8SICxfgBzZ63WqHK0gAWBA4zCp555afb/n5tsdve/xfo8dv+fm2dre1++es3a/g554NPczPYcCz+TmMbbZZyaXeYHL9z2k6lYrXgNKb6TDMDW03FxyceAWkEiqUaksggmcXj4JWeazRtu4qRxzvW/5kQQtPyjTcIQQ8s0B80amamxgkzLMstUet1h1EECJ33+SpbBbHiZS+bYY6aU3AbRsQCY8OuOrDAXSm1E3QJJ8biWntMJCEuwiQlZjAEAnaLX5UMh4lw9AudA6oR2J28WSeTzG6DCqmsL74wfpjbuixNfvArksT3/9+W5ygB2zZ5L5HZ4PxDDRdMRFNuFkeB75AMu5mXzsUvGwwuIDrrk12isO67JXgBg9Y0W8aL376MH7JZkhBCQJyi+xXSFwzQBGdQYoQxA2L/X18iLoOpNdsTooPa7+gYEmxaQwGs2t1IQS7Kk7A/AzYfw5gTS7FhwThAz5186KITiQ+ixjbYnPpSUw8GakWeKjFa8+9pBZIa4XKaafmtWqwY4nIJLGV4xhvojs0dpUWdvGKXd+qxN8KaQ0nrUHS7MsVLZxrr0J3IieEukYRPLbkrW+e3MlrVOThwgquoNRVHdATXo/6715hEbVv1qMmr4Hy6npcqw9zCf21/hhzcMYstMc4YiMWzrW24h+MYepgGVzNcqiib1brFidtUEU0uu2KSg03ZUM2gC2Sfu+gMJRLJndcjsiKBh6nIleSHymyUPMf6fjdx5rNdPkKmiqOjHRov1lnnLCBEzYcBlivvz/U/JKO66ENhAMuAV4v409I4BWt4J6TtRHVSXyLnsHWEIKqJMWmR+7L0RLg/CdGN3B0OQZgGMl2+UsgHvT3srBx1ZxVbBOsenBd31hDv1zxm9O33KbCHvpHsxctHi53U05VvPjeKP0AkvxxcPf/hHhbpPkrIo2nv7greb58Q+bkv/mWAqY2mejXJNWCeuW54fpOIm51zwX8hbuEC8TqYc3kjjkjY6oKSmOeYQURgoRzKWgPIhU8Q565i1msE6r61GiEGlhpkqCZgTEAERb4L5/IGOTRLnkxM6fidCQWcwi/25wWQvQe1hzWtKLJPsCyUIWQArgkxHMecO8X7deGF5AFZ5hE7LhILCB4SZIrPNEMaucJ45C+T2RfJG2YO5CEFaIShS800czyqQIxMK3RBHpBQZjEnk5xextWzpUke2IuyDHr97bB9RhFH+SlIecipirAcfUlwlOyIbMbcxGnuCgFhBd4CHs5w/vReE0iCFMW7ILFvzazln/ItnAsCMGlmEufvWan2W7Q0gSu4xoPltEV4efuFY7ay3mrh8lXc/JuucX/l3/nz4MAropaKe7woRtzt0pzS+Wr5RuAGPmj+vuASfkGZnW9DGAwx+U2PHx3hztEuIC8x8ugCW4/XN0s14YERpAq+BkAaApAKR6JyItz76mX7PFXDjeaVmxxqsVydyOAj58EbopUbbu/geFu+4o0dCP87yWN8YLYTSFh7YcgXEe7J9yW2KNjbyrbFGenuDkYTPzrjInbcTH8Fi7i36PgGv7BFxdr6gZ0/S4o9i9hjJNb0MhNLMp/gEjAsP8A5qK5VQ== +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 members from Governance Group' (delete-workgroup-members)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Remove members from Governance Group

+ + + + + +This API removes one or more members from a Governance Group. A token with API, ORG_ADMIN authority is required to call this API. + +> **Following field of Identity is an optional field in the request.** + +> **name** + +## Request + +

Path Parameters

Body

arrayrequired
+ +List of identities to be removed from a Governance Group members list. + +
  • Array [
  • ]
+ +List of deleted and not deleted identities from Governance Group members list. + +
Schema
  • Array [
    • 204 - Identity is removed from Governance Group members list.\n\n> 404 - Identity is not member of Governance Group.\n","type":"string","example":"204"}}> Identity deleted from Governance Group members list.\n\n> Referenced Governance Group Member with Identity Id \"bc3a744678534eb78a8002ee2085df64\" was not found.\n"}}>
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/delete-workgroup.api.mdx b/docs/api/beta/delete-workgroup.api.mdx new file mode 100644 index 000000000..30c95f6ef --- /dev/null +++ b/docs/api/beta/delete-workgroup.api.mdx @@ -0,0 +1,83 @@ +--- +id: delete-workgroup +sidebar_label: Delete a Governance Group +hide_title: true +hide_table_of_contents: true +api: eJztWltv2zgW/iuE9mHaIvItaVLnZeAmaZFBOu3mgj6kAUpLtM1WIrUklcQb5L/vd0hJtuy06XSK2ZnCL60sHZ77OfwOw7tIF8JwJ7U6TqP9KBWZcOK9Np+nRpdFtBU5PrXR/mX0Wl8Lo7hKBHtNn2x0tQVymxhZ0HIsPp9Jy0bvjlngYhlnq6vYeM6ks+z4sAPeBTc8B6UhCXeRJCYFdzN8UviAXzLFsxH/KaUR0M+ZUmxFNpmJnEf7d5GbF0RlnZFqGt2vKnR8yPSEuZlY0wNcxS3Pi4yWD5Jh/0XvxfZewnd3h9tpr4+nF2lvuPe81+vvDKP7K1LCFlpZYUnuoLdD/7Wl/a5ZopUTyrGYSZXKhJMTSDxZIKxjN9wyWyaJsHZSZmxcOvpsBIPj1GK502xMi1xplEjBq2ISNOiQoTu93roGB5mk5UfGaAMdThsGk5YWY53OSaJU1zyTKUWikkwseVFkpDpYdj9Z4nu37nE9/iQSRyE0lEBOBr+kwnGZHehUrEdnNTivpBLx1HBJGgqvcoKFDByvZYoVLNfwTGBZx9HTdVrRgyc6ffaSp7A32HdQGQM3OcOTz+BFyf2YQhdKYj2rlzCZsgmU+oJYsSf4eLc3HOxMdnc4H7zY6e89Hw8nfHu7N3w+HJL0HHHm0+CaSjY3hs/XRL8WShiZsEwniMh/4RAjOHzvFfDCsUQ6kdvHY+B5fIP/z2FXoG3MrPRlTty6LVTvy4N3bGePZVxNS/+eT1ecoOKLM6rWMsv4mF5RhcLywPitkVOpHlJFqDKnrnJ49Gp0cXKON6dH/744OsMT8VprLSNVVxRURS7M9I3XuDLA1xWaTuJE2mHPKq7PYBBXdplQhl92buFM5NaEl5nDikr6AyuWWbOJ0XmrlHzd3Dr2RHZEZwtVi3c5d8mMjbnFAh1K99kINV+4+KTy5DM2EzwV5mmHjdJUkpE8Y6hGMMX6OZU/T9NF7U9KlDKUkW6m0TSUdjIR7VgsXNmOBopAOk9xshwUKg5o/niejBJXQjlv5nIVNtlSqVh3vLTyXFu789UuOFeOJ7CCZ9kcbjQGHvYNkbaHuhFK8n3OVU3XdKz7+4VZvt29CcocOu2/Jby031B37zK0n9ib1ny4FlXxWerDoRv5aNRhqjoSPpLZfnFF1YSrLnw2kSJLN7W7qd1N7X5j7a5+PK1QT/XVQ5/+OvS5ULyEf43fPNegT4OwaiIPb6pAbjE4pIJIv70/R2F/ForoxW1BsPMH4qOwla8pP2riEd6PCX40wWrFghT0fgwWTNCJRLrv9V5o7B0VXLW9Lu2VNmOJBFUPQER0TcPmumQcLjOlUqQJt1ss1cKqXxybcfRH7hFs6IAkVaVxoaVyGyS5QZKb3WizG/08u9EGSW5qd1O7/8za/SqSbLTy1VLhJFvmOTfzkGnVd7KWMxA052+sKTkfqlW0QsxYg7GiNnKIxoP+uD/ZS8ROynfS3e3hZJDsDvjzvf5ef7wz2IuW9/rLRR03RdauqaV4hzh6FwPEXQPHlQrJZZ3Wafv4D+41YkJtjVpPg5vhc7j0qsGOg+E6djzXmr3hal4jJNvCkGrhI+ppoM2J1tS0IOBsir6oGFqVhF6USjIX4GKQNCyTufTFS1aAr5nHo4mDKaFQVk9C8TvJSmjoO0GmCTVrJJaEkWJCmA8cPIKdojv/QHRahehPIXl2ShafkMXs6DYRggq9Qe7PHzrfPYbyhnrEWQjwFw56w7TDFRIAA0HoWQ3u3ODzDT7f7PGbPf7n2OM3+HxTu5va/WfW7h/A5xUa+jI+B8E343PQdnqswVKvKLn+cpjuS6XSwKc300lSGn/cXGNwOMEKvJRu7oVcANcfhFQeAbRTZcpU7d/UtzX2b0Aqoiu6rpAL5ODiRoe/bEFLom5Dbrt3Mr2PSAihyWBIaTIQzZwr7H63e4f4Iq73HV7IDtoeQuzmSt90Ep13x3DqA/2KLhaE2iQCfx8kCOj4iBhJSR86pGce4uN9QOmNOPmz5K9yptshFPi5LtETPZsthgKpEtC/hooFpo9frKfu+IRbsw92XZjs/s/bEhh9wZaH3PdVaaBn0HTFRDLhapETZwTVg/S1zFhsPzTeDdaEvSWyAXspuMEcEf7i8eS39+dP2ZQAqm8QpSVsLCRNFCixd0gR3wBH9ek/LfJ7ErJpOvOKj1p/X6GCY5MMBrMP6kwIdnlcOeF37AynaOXepbRI+O5Bq66e1NFJxbXIaNPsLDxJiYek78JDXd5a99RvkH6SkAqPuX/b+aBidiipb0na6ImmMtEPhuyyqO3iS3Z9rxL/qrnFgVvsudmnK1oE114m4b5OgqonFjyz3lvfLTzwi5f40diFN8R1VQfyRKVH+69iSR2179ajxS8mfm09Pqj3M4ndt72MhZ7FLDbPLGXHLJlpbcWvjFHqUBlcTktU0XerdUNCY18R8aC3pFIcRMYyBpb0+p2gMFRIJj6mvdxDGQ2Up9JQkh99ZFHzHzFpp+xjy2b/+hJbLlGmOrHfrTMJjElgHHqArfQPOxolFmqbbPB9ICTAwSL+vhNUii71vcDrwa7u2Xf9GtoaEqjqudhiP/zYXzS46on5D0Td0KANExRv/k6I36ziRdtay1n1IcKqB9f1zTR20xW/BX2bQyzaYf9u9pLFo8VZy1uVzX90l/5CJ/n79N3/U8fbdJqfsdNU4JjSzYutpojlJH9Z4bX1sz86nJ4J/IuvvlY9DseU4+c2j2KWGRUZd5TVvqqTmRT+1KAQ3BH226LM0rmvRAz4VP6YDT2jqQENytYCk/KxzMDPn2vXkrkvmAAsKa7025Z+dCFZyQxTqOiw9xjkVIKw0BBHNzPw7ZOuprkzROYdBZYd1sEG6MrzUkEa1WWZM46UeiQjUmmTMjQuzHRK1L7QHvo1q+oqplQjEzp+nDG5fTuhA2nMukuBf0QW4m6r02i4nqJY3fheGHIqMp+ZRNeG7Y/xRrbFM5EVNEai6wKAiSUJb47P1ziCmbKwC+O6NtNutch2iRZMaDwK6bPd6Xd6sR8X8L7Q1mHwbalP49YDN99XE/FucRL/xy/OV9sG4f1uQSdbpEwZ5o8w511GizkPC/ZlSvf1Z9CXvt3d0cEHTT739BoDP03Vl1eLocYPg/AnPWOMnKDCxVcseHJa3dF/yr566f5BxeuDOzVfzOwRHj8LGvWhOQZi6O7PYrxe4UM4rVlasvb3jNYgfHh0cnR+FAXw8dDeWz3ADegu/wPwcjJy +sidebar_class_name: "delete api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 Governance Group' (delete-workgroup)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Delete a Governance Group

+ + + + + +This API deletes a Governance Group by its ID. + +## 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/delete-workgroups-in-bulk.api.mdx b/docs/api/beta/delete-workgroups-in-bulk.api.mdx new file mode 100644 index 000000000..f68e161c4 --- /dev/null +++ b/docs/api/beta/delete-workgroups-in-bulk.api.mdx @@ -0,0 +1,94 @@ +--- +id: delete-workgroups-in-bulk +sidebar_label: Delete Governance Group(s) +hide_title: true +hide_table_of_contents: true +api: eJztW1tz2zYW/isY7kMTjSjrall+2B3n1rqTbLyOPXlwPFOQBCU0FKAFSDuqx/99zzkAKVKU4yTN7rYdTWdSiwQOzvU7H0DyLtArYXgutTpNguMgEZnIxXttPs6NLlb2VD0rso9BN8j53AbHV8GP+kYYxVUs2I80IrjuwiwbG7lCKSDjg7pYSMtOzk6ZVDKXPBeWcRaBIEbyYRjTKdNKMG3YUhuQtS2290F9UH9n7DRlXK1xeL4QIC+RMchL2hPYgt+IhsxYKyViXA2Wt1bHkmbeynzBZN4FeQqEartjdRiUZSwSjCcJTJGKsU5HqksrOh2WSZuXChlhVyBf9FoyntinbMnNR5jObW12zBVTOkfhztnJ15sK3kURiRbuD/EJVLKo5lsz50r+RgH9Sgs7HRD1Shcq+WIbbcPC2nQS/nutrMyjyOKk7xrRTsdr9qC5Jy0xDXs300vZ/gpLjV6yuDBGqLwRkpoT3FL/LgSsDHblXKJRYOQmVSCRG15taXP6wjIyWubMfpRgpVbZGi/tdEEKAqsC5Crx+trSbHLBDs8tZLxwQVD6kRj0mLew06lAYAHeyuQSdFTFMhJm9ypYFzUX8pxqOZdLCMRD7qIyJwcM+v0dMsk/ui7Wp4ggxShs+cLoW/AGFFEsCMJ6nQ4Anl/smU7WwfEd/ZRGAEbmphDdAHWA6OItvlplmMQw9eBXixB4F9h4IZYc/8rXKwGgqKNfwWsgd2UQcXMpLN6VCf2vCaCvfTai+jt91bCph+jsFuHG8DX8lLlY2triNjdSzYP7biA+8eUqE4jkk8MpP5xNRXh0NInC8WzCQ57GkzCZTMQgHo74qD8EWfE06qfTaBgOxPQoHPcPR2E0nI1DPplMRqNRwuNkGFzfg+xc5ig5qLoHto4XpOS5c2ZDA2/8d1cEVSlrmJww7E/bPm7V0qY91SAg+IpAN+Wj7SBnCcvsCOB5bYFHYvdg4rTXPE1KDNtesbaOz4VaIILx4ZiLaZROZwMxnqVJNB0f9g/5UIz50exwNMGw2ZznxY6c2tX8Bfvp4uKs8iJzc6FsE3RtXhiFGAlgBFWHDeBGJgXP2vCWLwAFAER8KfpJFYIlBWrQYBbQ/Es646F22B8zxkLWll5Cgi3iWFibFlm29pPG/RlNas2R1GQLK7qAI3D1wWY+9su2JODoFPEcBtaDAHreb/lyO7w/FUtYzgie8CirvFobQ5juwZE8kyQSr4NvKYs/gTcVuHDJ3ehIF3lpPjablMusgKgxkcdb6gVo1Ne48FKRkoBUPjCtyelRP4r40SicHcXjcCziYXg0iI/C0XQU9/tidng4isCxMQd3Y4OrfO9XOBepMBiFNndgw2g6GEwBIUQymoTjIR+G/Kgfh0fpIBb9JB7zacpuud0OxxZe3ndruH+FNVcVwvUOvHNYdwoF3IRaV62Pl9mmygCzxq3S+jL3B/e7VKtDsavKwCHluN9vZ9rzTCJzeWkMZEUInvY1K5t9OILe6MJywzOZfBVafh7dEgE5nD0HwHgccV5JJcK5gZwHDQWpTEgDEgFYsA6IJjiRJUDSuF4TBfv93oA94wnz3Yo998ZgbzM8/giyTpPHFbpUEuazcgqTDrceWFZMBY8O+7PhOIX84MOj8WA6iWYpH436s8lshqsvIbp8LurwW7aLrRQRShgZs0zHEJHfwCEAF+B7UoAW//IOQzK+wP+I925sZabXlyHkdAGgnz0/Y+Mpy7iaF3Sdz7ecoMLLd3BFQQojbjiWBZY7wW+NnEu1SxUBlBJL88XLVyeXry/gyvnLf12+fAd/oazW3vRElVsOTTx0Adwv3xiAkGChTGJEctbxUjtgEFe2PlC6X3YNbWkJuZXyIgPy2/Gr75hRF+02CNuUFvH5ieyJXhdgD64BTAPvjriFCdqx1s5JjCQ1fO092WELaAfCPIXNygbsoRpBKMxfNzY8KCAtoJQFsXUEf4A/GYtmLDaubEZjgyqv60HB4gDNH8+TkzjHLk9m1quwyhav4mZL6DzX1O6i5jRy6RraHWxHYGSGG0TYc8WATGCbzC3zcIThsgA8qhxXIVadtxLcvXHKvMg13aPu83jdnWUAPyGZVt24Eb74iK87NBL1nuwRCW6i2TTZj6rCVRY+S6XIkn3t7mt3X7tfWLvbN0ve4+8S9Rm0qQ/w1gL8a6h5tqiPEe7sjZWDHJN2gewih/YU6ef3F1DYH/FoBuj0pxVSyO/Ij1wrbyl/UsXDXY+QflTBasQCFSQ/OguQ+ovkmPTeaEyOcq4atVd7pU0kIUHVDooIqGnYWheMg8tModx+xHbpUE/9UJ7pua0HISCuqpJwpaXK90xyzyT33Wjfjf463WjPJPe1u6/dP2ftfpZJVlpRtXieZIvlkpu1yzR/H63lDAZszsWrkqNQbbMVFMYqjhU0mUMQDQfRIJ3GYpzwcXI4mqXD+HDIJ9PBdBCNh9Og3uuvNnVcFVmzpmrxdnEkFwOJuwEeVyhILptrnTSP/8C9RqQIawg9FW/Gx4DB/XXFHYezNne80Jq9waedniHZBodUGx8hpsHYJY415VgYwNkccFExgCqp3XMPuRQgxUDSuMeNWLxoBcg16/AkzcEUVyhlklWrSBVnBWhISJBpZM0aEkviyX5KDxnNmhjsHND5O7JTH6LfxeTZOVr8mh6wvvwUC4GFXjH3ya7z3VNQ3iBGvHMBfuCg1+12uIIEgA2Bw6yKd+75+Z6f73v8vsf/NXr8np/va3dfu3/O2v0Kfu7Z0MP8HAZ8MT+Hsb0+q7jUK0yu/zlNp1LxGlB6Mx3Tm4fJhoPj6zsCLsp8TYtcAq9/7lL5BEi7e7VBHd+WLwsc38JQEVzjmwRLATmIlqy0JfThOCE4qAbbA3z9JnTvIuArDEQpnTWFyWDsIs9X9vjg4A6CDMG97/GV7AH2QZzztdK3vVgvDyLw7A7QkrYsYhxAb+25BXoUFiMx8x1MknAXJHIE5jgEiw6UPytZ8SVFf60LAEYS02VQJT4L6TKouIItyA+WRvco61r2gV2XJrv//bY4QQ/Ysst9n10NxjPQdMtENOF6kxjvkK+71VvpselBuMcbthZ7i8OG7JngBjYT7rHHk5/fXzxlc2SphBKFRYIsJG4roM7OIEUIBU/KRwA4iRoTJNV84d7RbDxkwapjaQYGsw/qnRDs6tQ74Z/QHs4Bz8mlOEkQhOCs6ydldBJxIzLsnL2NJzHxIPMPwEMHvDHvKXVJ2k7UXpnqfVAheyFN+f4rjvEmujfRrlalXbxm17cq8bdSWuikhSTNPt3Swrn2KnYv7cRQ+iiCZ5a89c2LO3lhTR7uveAKSt3WAT3h9Wg+GovLqH2zHg15Icpr6vFBvacXlJvTmAMuZqGDZgk7ZfFCayv+wRimDpbB1byAKvpmteit6JAqIhz2ayqFbslQhkAoSb/XUBjKJZN75474jAaqpxJXkr9QZKHmf6F3+H5p2EyXr6Dv4shEx/abdcYFQ1wwdBhgvf6urWFiQW2jDYQDLgGeb+JPSOAVreGek7UT1Un8Ac3B1hCDqiTFro7dj+MNwPm/GN3A0dUYgGHk49XDQvjNvCzsbQ1nlScJ2x5s65tpaKlbfnP6VidZ2Gb/aPaixSebA5e3Klt/b5R+AEn+OLj7f0K8PdL8FZHGM2Q8uDzffPPx8r/8mQJs8CG/yU6/d6lX1TNPENsnjlb4z3vgLoEDsX/YW7kvcJA21QWtMp5jGRGMxAsp6KxiJXiOZLOLqayXVPoroxFvhHWC5gbGAE5YIME8khnIo9P0cmVOFeqYLCYS/rYFbZhwrXgBe1/RY+9h+6hiyAPcOuL7IHDvV+33kO8gFc4wk9iLMruA5S2XhYLVEAiKJX4H9FgKJtLGhUNK/3GSM0ET16xmlbCBuY0m0DcRwizt2xSPwWGHXcu0R9aCRLP+DBxcj1HEbQHuzypDzkVGpYDjmvuEx2RDeocLka1w8wowL/Bl7c0Kb04vWhJBmLJgVyx62swP/CR7gGNBCO7HXPqMeoNeP6T9CVzHLR1stxvq73xX/4l9up2Jd5sHAPsPPvcffO4/+Nx/8Pkn/+DTs2c89jhY4Sk/QmThjmHcqddVsDn1ggn1c6/rbrDAAzIYc3eHh8F4EHSPl8ECPGm8ut6c8eAvkO0Ohemg7KPAw0j/FDK8WNOGwJ86th+v4tGTm+EOmj87tn6Gd/YWj9yDyH/TunTnmIbfwkX8F6Ac/oMfeuVaF374itfvgvKpAIxxcsud166Nh/8Dzby//w/vdH7l +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 Governance Group(s)' (delete-workgroups-in-bulk)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Delete Governance Group(s)

+ + + + + + +This API initiates a bulk deletion of one or more Governance Groups. + +> If any of the indicated Governance Groups have one or more connections associated with it,then those Governance Groups will be added in **inUse** list of the response. Governance Group(s) marked as **inUse** can not be deleted. + +> If any of the indicated Governance Groups is not does not exists in Organization,then those Governance Groups will be added in **notFound** list of the response. Governance Groups marked as **notFound** will not be deleted. + +> If any of the indicated Governance Groups does not have any connections associated with it,then those Governance Groups will be added in **deleted** list of the response. A Governance Group marked as **deleted** will be deleted from current Organization. + +> If the request contains any **inUse** or **notFound** Governance Group IDs then it skips only these Governance Groups for deletion and deletes the rest of Governance Groups which have no connections associated with it. + +> **This API has limit number of Governance Groups can be deleted at one time. If the request contains more then 100 Governance Groups IDs to be deleted then the API will throw an exception.** + +## Request + +

Body

required
+ +Governance Group bulk delete response. + +
Schema
  • Array [
    • 204 - Governance Group deleted successfully.\n\n> 409 - Governance Group is in use,hence can not be deleted.\n\n> 404 - Governance Group not found.\n","example":204}}> Governance Group deleted successfully.\n\n> Unable to delete Governance Group f80bba83-98c4-4ec2-81c8-373c00e9663b because it is in use.\n\n> Referenced Governance Group 2b711763-ed35-42a2-a80c-8f1ce0dc4a7f was not found.\n","type":"string"}}>
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/delete.api.mdx b/docs/api/beta/delete.api.mdx new file mode 100644 index 000000000..133920f92 --- /dev/null +++ b/docs/api/beta/delete.api.mdx @@ -0,0 +1,97 @@ +--- +id: delete +sidebar_label: Delete Source by ID +hide_title: true +hide_table_of_contents: true +api: eJztW1tz2zYW/isY7kOTjCVZshxHftlRbKfr1mmyvkwenEwDkaCEhgJYArSjevzf9zsAKJGWXLtpZttm+JJQJHBw7uc7MHATGRGXhbSLaP/yJrowojjQyorPdlzaGd5FMlH7RpdFLMz+nCs+FdGH2w9bkc5Fwa3U6jiJ9qNEZMKKaCuyfGpo2pmfEmFkIkxcyJzGYuT5TBomVNLJtVSW+YmGcWZyEctUxsyvxqRix4lQFrz9pK+779WYWf1JKHYt7Yy9Of3+5/Hh6+OfttjZm4vTg6Pqly6qF2cXL907xiGKJhkZli7Er6UsRAJiLOZZxiwxNH57TCvgp04Zj2NdKmuYVvgqKoauJT5PBCjM9RUIpLIwdotGbBzmJUu6bBzbkmfMWG5LQ/QtN5+Y+AzFk07AhfJkbSEFEb6SnM0FeE7Y90fn7GOPJnT8/N6NTG4/QtE5LzgGicI4y0nSbc5hs61I4QN+yQTPJp6JOY/2byK7yOmtwSpqGt1uRZUmon1blGLdToJ5I7LjQxASn/k8z4jCIB71X2y/2NlN+qM+f/F8u7+bDF4Md3cnQz7YGYwico9CmFwrAw/A0oPtAf3XXGAcxyKHgliHnQpbFgqPMnWaJM6EseyaG2ZKjDMmLbNsQZbxc+A62it9YayYd8FgTH6rLC3E8zyTsfPO3i+GVrtZV4Se/CJiS5osyJet9Lz6r3eZJW3QFzKfnwiTQY9gNRWFULEgZTdVDJ2pck7BcD4++/Hn06Ozi5NzCoiVKusfYBFYbM1Qd+1yfOhciPghN4Key8xuss/e3kjEKayy3d8bpXuD7dFwkPZf9Dmt5F3kobX+UyLiO4XgCZ9k8Ghp8owvGE3ewAR7Yma6zBJyZgVz9cQ8t4undd7o9e3t7fKN8ZqmQPG+5ixVzue8QEKKToMTUWx4B7mmYHMTSPk8xByWuOJZWZeorlmv2If1UqklcOkYHW5vr3vDQSbhaeyoKJBt7nffiU5cypEK3MnkKzppIiyX2YFOHmHEV1KJzrTgkjgUjuUYExkoXsmE1DjXBaUrIlmZ1Y3rNtwKmuj22UueQF4v30EQBmqyBY8/gdbxIzz4QknMZ9UUJpFKwdQ9y4o9wSfPt0eDYfp8yDkSTX9vdzJK+c7O9mh3NKLV50gQKEy1+I14UfDF2tLfCyUKlJhMI/XL36AQODd07xhwi5OzIKGYh23gaDxC/5Q6/NilmIFfRnV2C1788uAtG+6xjKtp6d7z6R0lqM7FGfknPJNC0adsSO4JvynkVKpNrFQZ6PDo1diHwunRfy+OzvBEtNaq81jBWxNyS7AKX5jpa8dxEMAlZERf7Arbs0D1GQTiytQHSlPLzvCtlCNBYEZYfcOMOmmWFnreCKXYgxL2RHZFdwsZBu/m3MYzNuEGE0KlfuaLSuckaPIZmyF5ieIpqnCSSBISldjlCoP5C0pVPElcQXEE0hKhLBzE0KVlSlsZi6YtVqpsWgNBIK0bcVI3CgUHOH/YTwJMcGLWo3DpLYHFYB/w7DXX5O78bvlcKMtjSMGpfsa6KFztgmwSACekIzKXQeJR1bhlxqIUWInl0t1rz8yh1e5bzEvziLh7myH9dJxoyw9XIgSfISjms5GzRmWmkJFCoXeTw6iluarABxYTWdLGbhu7bew+MnbvfqywVvjqoE9/HfpcqNBN/bYJuRfOe5SuWq7fHLwJhnS9WYBIP7w7D90cdYOfc+pDviI+8qV8veVY2sO/nxD8WBqrYQti0OnRS5AiE4lk3/G94jhaocSd9dVe6WIi4aBqA0RE1izYQpeMQ2VFqZSDs2aLJVoY9Z1lM478yF3r4zNgvWtukWSLJNtq1Fajb6catUiyjd02dv+Zsfu7SLK51Rdw0mqHD54WvruNd4YBrNo6ZsuQW27u1dEKEWNLjBU1kUM0GfQn/XQvFsOED5PnO6N0ED8f8N29/l5/MhzsRfVaf7mK42WQNWOqZm9vR6digLgr4LhSwbmM1Tppbv9BvYVIKa1R6lniZugcKv2wwo7Ddez4k7aQDYSBHYt7thcvTk/89rMnT3rz+/UUtH6P2s64dZCSfBialsa20LGFjm35acvPN1N+WujYxm4bu//M2P1D0HH4EHQc/gHoOGQEsVKCWH8ldEyAOwiapTAKZIhLqFcRbMwhCp7C7mMIe8uLqbBLoNdAkYPRhlMLWrPXXC0qsGQaO5FqpS5Kbxg7p7FFNRYDOJsiRSqGrCWBbsmr5FwQJoX/sEzOpYtjEgh0i0VnnFpI5WOm8rflKlLFWQkOXVLINO29aviYpLMUKcE/UHD7oFMk6q+4xxms9af2g9kpSXxCErOjz7EQFPPL/d/dTacEjsF8QenizNv6nuMCfs+cK7QR4nPu09cSgrZQvYXqbblvy/23Ue5bqN7Gbhu7/8zY/QNQPaCh+6E6BjwaqmNsd5stsdQr7o+7/n8RuwuVwIFzb6Zjh9WTFQZ3uIIObUe14/DuRPZ+1Asn6N3pbbz26N8zUxYZRsyszc1+r3cDG8E2t12ey64M59+Vvu7Get6bQDEbcg4dMfXxRQPoLHtoL7pOq4Ukx/VZzhH3OnZykItC1+5Uwe9Srs78LiAI82S26ER0cCL3Gizm6CC+M2501znNmnyQ66LIbv+8LJ7QPbJsUt/vrobxDJzeEZFE+LC1vCNxRnDbr752U2JVQmijf7C22BsaNmAvBS/QC/izL09+eHf+lE0JZLogLw3hWyGpK0CYvIWLuCQ2rs6B0CRXVwpdTmeO8XHjpA0FDUszCMzeqzMh2GXtDgU7RTp2KqVJwmUAmvXhSWWdRFyJjApfd6VJcjyZqB401OONeU9dkXPdgFR4nLu33feqww4l5R5JxZrGBBH9me3LvJKL1+T6Uib+VVHreGodR808vcOFV+1l7E9ux4hcIsEz47T1xYt7ep0aPWqd8Iao3uWBNBH4aJ6PiiurfTEfDXodotfk4716N5OooM1p1S2TcG7/mMUzrY34N2PkOhQGl9MSUfTFbF3Toh0XEZ3Bdo2ljl+yIzvAg46/EwSG8s7EJ1SPHRzRfmfEheRHZ1nE/Ed0ywn72JDZvb5E2aSRiY7NF/NMC3ZowY7PASbw76sSORZim2RwecA7wMHK/i4TBEZrec/T2pjVHfmem0OlIQarjorJ9/2P/VWCC0/MfaDRyzFIwwSnlyfG6GpToEWlqaGsaiPgrgbX+c00KuIdvXl+l3/OpCr5d5OXJB6v9kveqGzxtbP0PZnk75N3/6KM12aabzHTBIBL7uaWDZ1A3clfBry2vn9HG8wzgX/x1cWqw9LoVPxVTkIxdUJ5xi15tYvqeEZ3ImlDXHBL2G+LPEvPXSSiSafwR3/nCE0LjEHYGmBSPpEZ6Lm96Wpl7gLGA0uyK/02ZTgpoeGS6CRFl71DM6ZimIUaMTqji2+/6NCRncEyb93N1cPK2ABd83mp6H4p2C7njMOlHvCIRJq49IkLfZkSlS60g37LWVUUk6uRCF3XkhRz8yalTWVJF+aiR64Fu5uwowzVkxXDPdGVIKcic55J45qw/SHa8LbOTGQ5tYLIugBgorbC6+PzNYogpsKfMXQx7YVJpkdjQYTaI+8+O91+d7vj2gW8z7WxaF4b7FOvVd1VnSz8ddWGC96s9tHb+8df6f5xqKPUAPVy2q4j65S+IfNd72UUul6M3pcJ3XydwXr04eaGtnKoD7yl17+WgvYJLj+sWjzXGsO76BkddYp8d/eKct2qT06DWp+6P0bVLy5vZLTafVSL1cZDhMdPgvYrwCy6erDrNpQcK/6D33KqTVn7owy1i8ttgMOjk6Pzo8ijr03gIzxAcqTX/wGQmifq +sidebar_class_name: "delete api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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}` + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/disable-account-for-identity.api.mdx b/docs/api/beta/disable-account-for-identity.api.mdx new file mode 100644 index 000000000..9d466bb8a --- /dev/null +++ b/docs/api/beta/disable-account-for-identity.api.mdx @@ -0,0 +1,99 @@ +--- +id: disable-account-for-identity +sidebar_label: Disable IDN Account for Identity +hide_title: true +hide_table_of_contents: true +api: eJztW1tz1DgW/iuqnocBKu5OOg25vGw1CWxlKkA2l+IhpBa1re4W2JJXsoHeVP77fufIdt8SAhlqZ6DMA+W2pXM/R99RpOuOzZWThbbmKOnsdxLt5ShVwzi2pSleWneUKFPoYtbZ6BRy4jv7l53qo+9cbXQS5WOnc5qP2edT7cXw5Ej4cpTpwgspCuk/isKKirA4OnwtZCAgxtZhhNdmgg+6YtQFJ/WlUM7I9NDG4Hi9wuVYSWdEZp0ScmTLoqINMjURrbyYKqdAqnQppkyLIvf7vV5i4zLDEFa466VOc6tN0Y1t1vNS+t5UpXkPvzJreqVXzvP//4bEyvvutMjS3xpuEX2K5iw7Nxsdr+LSkbn2L687F/h+YE0BdYZlMSXb6cTsV+r7yEMOtZ9JIyeqc3UDc+bSyUxBec8ENKmbS0zd6Bh8wC+d4NnHU5VJskwxy+mtLxwEIgGc+k+pnYIvC1eqdQfNDY2HYGuZ5SkR6cd7W7ubu9u7g/7mdtxPNrd2B9s76tn21tbT3e3NvQ5J6JTPrfGK/dLf7K+7B+Gh8kIlIhKnqiidwaMeiwKsSTjlC/FZeoQI23RcpumMIiLMgTMsD/UzX6iMBIzJgqYgRjLPUx2z83ofPHG7XreFHX1QcdG5wb+NzmBzc13Cg1SDoHjhHALwbilHNoGRPGT6JNNgrAfKAsc6yjOOEhanQOgd2ESt+3DVZS+1UdHESU0SKhY5xkQBip90QkHPmRBIChtU4HHL3oUlulviuUygb9DvoFIGZiqcjD+CFtWA+wS6MBrzRT0FYcSJfAdbtaPk6NnmXn8wfjaQsr872Np5Otoby21E1NO9PeKeIQ6QAn6Bt3ROztZY/1MZ5XQsUhvDI/+FQZySsD0LwMwxRSNu/P0+YBrfYH9KmTC2UbOSV1Bib6CCPT84EYMdkUozKfm9nKwYwUQXZ5TDCHaqgiE5oXkg/MbpiTa3iaJMmVHZOHzxcnhxfI43py/+dfHiDE9Ea60ADw2iNaGwhKiIhan9zBJXCnDeqRTmUElXPKmoPoFC0vjFgdovJCFiayzLtMCMivstMxZJi7Gz2VIqxaEKike6q7obYkTvMlnEUzGSHhPgQhr+JNSO6Liy5BNUcZko97grhkmiSUmZCmQjiGL+DISETBKuG0xgXCKVIYwuprQwGFvoWC37Ym7KZW8gCXTBI44XnULJAcnvj5NhXJQQjtVczMImWioRK/9A5mC5ZenOV6vkDItVDC0klcnYOgcLixF0o+W1KkfkLo/CY+pxTcWiElirxeXuVRDmsLD8LZal/4a8O0lRfiJWrfnwSVXJ52l5D9WIvVG7qapIVT3nydWoxl114ouxVmnS5m6bu23ufmPurn48rXBZ9ZWhz9Y69LkwEkjUOl4816CP4+gxVtSDGN5UjtwQMEgFkf54e47E/qgMjVdfckKcPxAfhaV8HVk2/gjvRwQ/Gmct+YIEZDsGDcaoRCrZZ7nnErOhgqm217mh+RlpBKi5BSIS8hczWwoJk7nSGJJE+g2RWOXN74WYStTH0DWECkhcTRKFdqNFki2SbFejdjX6ZVajFkm2udvm7s+Zu19Fko1UnC0VTvJllkk3C5FWfSdtpcAAUe8Qiibl2FWraIWIiQZjdZaRQ2fU3xptjXdiNUjkIHm2vTfux8/68unO1s7WaNDf6Syu9ZfzPG6SbDmnFvwd/MgmBoj7BBxXGgSXL6xNlrf/YF6nxlTWqPQ0uBk2h0mv5thxsI4dX9sCuoEwsKO7Y3vx4vSY6IM1kye72dLFimB2MB2Gy4IhJcUwLK190ULHFjq2y0+7/Pwyy08LHdvcbXP358zd74KOg/ug4+A7oONAEMQaE8T6K6FjAtxB0GwMp0CHuIR5DcHGHKrU5wyatC+km6iiAXpLKLK/t44iz60Vr6SZ1WDJL+1Emrm5qLxhbEZjXT0WA6SYoEQagaqlgW4pqnSmCJMifkSqM815TAqBrptFw3EBrULO1PHWcNEmTsuEjlagKKSW9l4tYkwjnNSY4B8o8D7oBIX6B+5xVt76U/vB4pQ0PiaNxYsvsVKU883+79PbTgkcmXAIRZwFX99xXCDsmUuDNkJ9yUP5aiBoC9VbqN4u9+1y/2ss9y1Ub3O3zd2fM3e/A6pXaOhuqI4B3wzVMba7KRos9ZKC6/+O2DlVKgk4vIWNGasncwzOuAKhRALlljda+eTtfqc3P+Ib1Wd3e9c6uelVh5o7dO6XMGIQb/nI8TW8Bm/ddGWuu/XZW2M/85njEUx1SxWiQ6ch42hAOFHNDLpsZ6eJa6h7TDxYnTWjoK2PNX+VMp0nJnfO0IuIQGZDIOyrsOLXEDFHT/G759FdDqM1/aDXhUtv/rwugdAdutxmvq9yw3gBSVdUJBWu5se0zwiAB+5rh7Xniwpt/ffXmL2hYX3xXEmH7iCchnn0x9vzx2JCsJPTvqTD7UJp6hOQOCcIES5rw/pkCE3ilcbZcjJlwYdLZ28ojcQ4hcLinTlTSlzWJ/Jfo96fokCzSWmS4ppAs64eNQfe1SeV0lK4cthdJ6YHC/Xk0rzHvOxxf6ANHrNwTv6dicShpmqkafmmMZWK3O6Jy7zWSy7o9VAhfqupRYFaxNT84xUpgmkv43CWO0YuEwmZerbWg5kHetECPWqm8IaorspAlqjkWD4xFddee7AcS/Qiorcsxzvzdqqxpi5PE6GECY8lMU3EkYin1nr1DyEodCgNLiclsujBYn0mphFnRNTfXBApCiwjTbciWL61axoMUGzYK+GUfM+eRc6/R/+ciPdLOvPrSyykNDKxsX+wzMQwIoZRqAG+kj+sUxRYyG3SgetACICDuf+5ElSCLtS9QOvWqs7kezyHloYYojIVn++HH/vzAlc9Cf5Ao5sxKMMEsJszZPgtKlq0WC0Zq94aWLXgurypxRq5Yrcgb/MHTlo3/276ksbD+Q7KG5POfnSVvqOS/H3q7l9U8dpK8ytWmgryUrgx26o3WAzy5xVeW9/Roy3nqcL/+Mq5yugavQt3Y4xiFgnlqSwoqjmr46lWvBeQK1kQ9tugyLIZZyLadkp/dHxMaOIwBmnrgUnlSKd0PZB2q2vOkhMmAEvyK/32ZXV2wiIk0VuqrniL9swAtztqzejULr59sFWPdgbPnJBjxWHtbICuLCsN3ZGD2GUmJELqnohAKxCXoXChUzOqtoVl6NfMqrOYQo1U6HKT4jL/ZkzbzOhgFxx/Dy/43Vd7zDA9ebG6IzhX5FSlHJk0buUm5D20EW0RXYak5hBVFwBMLXB4dXS+RhHETPWHDesmvWqS79FYEKH2KITPdneruxlxu4D31GuhnV0Uf+Gq6HDhqujCVdSleLyeb7P/sBuo1aJC3UAvp90sErUM3UloC+ku51pbiJn7fEOz7gzRa0ypmcTw62va/6BW6YZeo++n5vryat4FcfdYzUQbOkZJWL3Buajro9Pqrudj/gvOyr3OWzWod+3MbN6wd/D4UVGfD8nRDUNi3ohhacKHsFWzMGXtjxnUVDXt88kb2rRiMHLbAl09QHWUoP8BJhknQw== +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Disable IDN Account for Identity

+ + + + + +This API submits a task to disable IDN account for a single identity. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/disable-account.api.mdx b/docs/api/beta/disable-account.api.mdx new file mode 100644 index 000000000..ee6f69c49 --- /dev/null +++ b/docs/api/beta/disable-account.api.mdx @@ -0,0 +1,96 @@ +--- +id: disable-account +sidebar_label: Disable Account +hide_title: true +hide_table_of_contents: true +api: eJztW1tv2zgW/iuE9mHaIrbjSy72y8K9DTJop9k02T6kwQ4tUTZbmdSKUlNPkP++3zmkbDnOpe0MdqaFESCwJfLw3M93aPIqsrkqZKmtOUqiUZRoJyeZGsexrUwZ7USlnLpodB6FJy662IkS5eJC5zQJU05n2onx8ZFw1WSuSyekKKX7KEorAjVRzpSQnoCQJhGFKqvCOH7OY4+et4V4b8aY9FEZcanLmXhz8vN/xs9fH/0qZFXObKHLhcBKhfpvpQuVEP1YZhmI+PXb4NapuKKB4PgqOnOqeGZNqT6XY1AgKXRiRoER13KlLNVoLo2cqujiGoLlspBzVarCMQFN4uUSU3cigxf4phNaJZ6puYxGV1G5yOmpKwttptH1TlRzF43KolKbqlrpgSmpz3KeZ0RCpf3DdDjoDw7UcLC335vsTSaHg95A7u33hwfJYUT8EXXlyqc2WdDqNxeLSVhYDa9knmc6Zrt2Pjha/KrB9jpXJ56qqBy0mtpiyaIyZL1OsCI5gxfXTj6omJwjL8h7Sq0cUYWeVWFk9m9V6DQsTk51c72jVDhV7sATRD1FgFKsnBOfZKYTmIV8Q5bsIGCrEJcSFiOT80DwyS7Cpg9Kaa/4C+ZoqrefDruHu4f9vaSn9rr7h7vdvaTfSw+Hu7Hs7h12yXYQPVbHhf2kHRglCneynjdGiSqvOW54eQkeJlWJJ14KZytQh5cLjhfLFMmfWeuXM3h9cz5eGFsKtzCxd3VlXFWESFrSpum8eNKQfmJtpqRpip/KzKlriFjqktURovnUTqeZCvaPrq+v2YNdbo3zJu3t9jaVMCaufNwmqpQ6c9E3+16dVoRkovXigshJzeoNawioCxFbQNgwOPhM1Iw6CnFKUfd7qr7FK3UibLrMSPc6Uy9mZxocDPYP+4nc3+3Sp/1hP+7h83AvukXVjrV2olyV1Zoe7O5usvEs01CjeFEUCMSWOOFMCZG15y04u5ggBZD5teGIaX+NBe7XjVf3M5uozQR3M5+91Ea1pgUMBQ4Vsxxjog+PhIw3t3BaT7JWL49rrykUmmh3xVOZiDoXPQvCkCILGX8ELZ9K7mfozGjMF/UUJFlOaHcsqw6UnOzvDnuDdH8gZe9w0D3YmwxT2e/vDveGQ1p9Dg9DfXCNtWVRyMXG0j8rg7wXi8yiKunfFVU5Cd0zA7w4puhSzd3DNmAaX6B/qid+7FLMwK+gqocUK54+OxaDA5FJM634uZzeUIJpnb2lAldlGad5LiaQ3BN+U+ipNrexokw1p4B7/uLl+OzVKZ6cvPjX2Yu3+ES0NnDCGOnOJOSWYBW+MLOXzHEQ4FI65NYM6kA2E08C1ScQSAakEAZq/80tHJQJ30olQgozwuq3zGiSFmlh52uhFHuIIB7ptmrviAk9m8synomJpNxsfWZ+gkBWedl6FTT5RMyUTFTxuC3GSaJJSNQxRCOIYv4ChIRMEgpdTyCtSsrgVLhsVVJ61ygIa7ZYqXLdGqts8qppFAoOcP6wn4zjsgJzLGYzCpfeElgM9gHPXnPr3J02lMYqXSBHx5ACKGwBNRYFNCxQmAShwJCOyFwOicfU45YZq5kkOd299sw8Ly2/i2XlviDujjOknxaLtnzxSYXgqyEDshFbozZTyEh4yQmfJodRS3PVgS9SrbJkG7vb2N3G7hfG7s2XJwHVhbcMfbqb0OfMhEaPiucG9CmUB8V1N/g7w5tgyB0BhQSI9Mu709BGYrz6nBMw/BPxkS/lm0B2aQ//fELwY2msNVsQg6HPIQlSZCKVjJjvFcesKK+q/uZqL20x0XBQcwtE5H5pYSshobKiMgyipdsRiVXO/FSKmfzEjQb1W5wBaVWTtHKrTblFklskua1G22r041SjLZLcxu42dr/P2L0XSS654mgJOMlV87ksFt7TwnuSVgoMWO0vLkOOTXUTrRAxscRY0TpyiCa97qSbHsRqkMhBst8fpr14vyf3DroH3cmgdxA1a/35Ko6XQbYeUw17ezuyigHiPgHHVQbO5Uprk/XtP6i3UCmlNUo9S9wMnUOlFyvsONjEjr/aErKBMLBjccf24tnJK6KPpZk86Y33rwlme9X5/XmClLxRrT5rV26h4xY6bsvPtvz8MOVnCx23sbuN3e8zdr8KOg4ego6Dr4COA0EQKyWI9VdCxwS4g6BZCqNAhriCeg3Bxhyi4FPYfQxhX8piqsol0FtDkb3hJoo8tVa8lmZRgyW3thNpVuqi9Iaxcxpb1GMxQIopUqQRyFra+t/e9VwRJoX/iEzPNccxCQS6xaI1TktI5WOm9rflKtrEWQUOOSlklvZeLXxMw51USvAPFHgfdIpE/SfucQZr/aH9YHFCEr8iicWLz3S6BSpc7v/u3XZK4MiEczNvva3vOC7g98ylQRuhPuc+fS0h6Baqb6H6ttxvy/2PUe63UH0bu9vY/T5j9yugekBDd0N1DPhiqI6x7V2xxFIvybn+74idQyVwwO4tbMxYPVlhcMYVcCViKLe80crH0kdRpz7N3rnSyXXjqLZvAjxPVZFh6KwsczfqdK5gKpjoui1z3UYGg7XKhbGX7djOOxPo55bUQydNfZjRAH/anxdos3ILTav6ZMfEvapZHPJUqJwPF9xLmU7Ykw0XaECEJ7Mj4OvBl/gxWMzRSPzkeHSbfWdDPsh1VmTXf1wWT+gOWW5T372rYbwApzdEJBEuVhcX3hLq9qtvXF9YVRLa7+9tLPaGhvXEUyULtAT+CMyjX96dPhZTwpoc65UjmKs0NQeIlmO4COeycX0chCZxeSlsNZ0x4+O1AzcUOyLNILB4b94qJc6PghJ+RZI/QVZmldIkxYmAZl08qq2TqE8qo/rXXmmSHE8npgMNdeTavMdc67gp0AYf5/y0/d60xHNNKUhTzaYxQUTu8cR5XsslG3J9KxP/qKm1PLUWU3OPb3DhVXse+wPcMQKYSMjMsba+eXFPr9WgRx0UnhDVmzyQJgIf68ek4tpq38zHGr0W0Vvn4715N9MopOvThM9bwqEOZok4EvHMWqf+KQS5DoXB+bRCFH0zW5e0aIsjotXbbbDU8ku2dAuwkPl7hcAw3pnkhMoyoxLrN0g4JH9jyyLmf+NrSr+tycyPz1E9aWRiY/fNPNOCLVqw5XOAC/yHmw5gFrFNMnAe8A7wbGV/zgSB0Ube87RuzepMvsNzqDTEYJWpuHzkv4xWCS58EvyCRi/HIA0Tql4eHKPLV4EWVag1ZdX7ATc1uMlvZlEYb+jN87v8VZOK5d9NXpJ4vNo2eWOyxZ+dpe/IJH+fvPsXZbxtpvkRM03AubT9eLK65vii7kjuvl748N2+W6/2+TtxaNPh3yxn6ECaUfU0AMTNfUPHV/HwH285OTCGR4dUX0xUokkoz2RJYcRpJJ5pxTsOuZIlgc0dcmU759APl9rQVzKhaYExyBMOIFhOdAZ6vCderyw5Qj2SJUei764KJzQsYgAdrGqLd2gCDRqFghpAOhuMdx9s6ATfwhWOyZPE89q7gPLm88rQlVuwXc3pFuNDLojeI658pkQ/aFStC8tYczmrThvk2yQC31xUxdy9SWkzG31yw9MeWAuOVt89hOrJiuGa7kqQE5Wxp9C49T7hIdpw79ZMZTm1oEjzQHyqscLro9MNiiBmws8ntph2wiTXobEgQv2Yd59+u9vebXF/gufU0aFpbrIf7k2vrmGvud/Vau/+b3X7OhQ+6lg6OW2zkXSV76B8v3oe1f0qho/4CnTdsqIJmlFrizFXV7QbQz3cNT1GMqBW//xi1Z5xWxtmJiGW71HSo5PA9mP+PWntCvatTNc7iGax2jyI8PGjoj0HzENnDn55U4h58S/CrxCt0wVDiXrixs8r1LT6GX6j6d6xF43m//gNbblFk3ABfO73MQp5iYf0fxS9xx+++PvFnHr5+VVU7wpijKdbY7bbIEv4AJ1j2P8AMQFiZA== +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Body

required
+ +Async task details + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/disable-accounts-for-identities.api.mdx b/docs/api/beta/disable-accounts-for-identities.api.mdx new file mode 100644 index 000000000..fcbd1a379 --- /dev/null +++ b/docs/api/beta/disable-accounts-for-identities.api.mdx @@ -0,0 +1,83 @@ +--- +id: disable-accounts-for-identities +sidebar_label: Disable IDN Accounts for Identities +hide_title: true +hide_table_of_contents: true +api: eJztW1tv2zgW/iuE5mHaIvI9zeVlkUu7yKCdZnNBH5JgS0u0zalEekgprTfIf9/vkJQt2U7SyXZ3ZwqjaGBJ5OG5fuccirqL9FQYXkitTtJoP0ql5cNMHCSJLlVh32pzkgpVyEIKG21FBR/baP8qqp5HN1tRKmxi5JRIgMDFRFp2cHrCbDnMZWFZwe1n/NUskGYnx78y7uezkTZM8GTCpF9lxqZG3+IiZVKxYiKYEb+XwhZsqNNZCxyIr4UwimfHOgEnd0urvxPcKJZrIxgf6rIIi0o1rlaAHGwijACp0mSYMimKqd1vt1OdlDmGOF20LJfZVEtVtBKdty3ntj0R2bSNq1yrdmmFse7vPyGKsLY1KfLsp/lqMT2KF0tG91uRFUlpICL0dxdd4vmRVgXEOSiLCelUpmo/6MXGFnyI/ZwrPhbRzT3UHBRxCD2Q3HQpjYDNClOKrSghYqqgR3w6zWTi5Gj/Zkkvd5FNJiLn9KuYTQXE1sPfRFJAC1A4PMAxiaeVHU7SNdq9gD1kapkeOdPUNEp2/DKRMKRQZOR2ZexKIDJdWJkbw2e4lIXIbY0jWxhojjQlvvJ8mglSSi/Z6+52dvu7g16nn/TSTnd30N8Rr/vd7vZuv7MLOmHINv73utudUYeu9vrpkI+2t/sjUh9oglGiGC3cufLhwzL7fOaVG93f01gj7FQr6zXS6+ysaoLmsGoYS0UBd3Ey/lEzPKSMuXkeW9cPaq0x4qpalyl5PYykMGTOoafrQ4148aEWzPC0ism94bGlPdKpqC2OABJjYUAMHpLzwt/q91bYOatk8mTYLc9K0WBi0BlglRyxRiHxpHznng7Zg0tFAMDTVNJDnrm7iDxgjGcLdwNejGDIEgpuyn8mRoAMlRAsVUB1/aRWriP2hVumNOFcqdJWVHdEMuWqM1Z6aIaBN+nTZmhaARqrKez7CbHVZOex2Kyz0+v0auyoMsvub3y8DTqd1RA7yiSYZG+MAbbE7EwUpVHE+2glLzCkHKngMjJ9Tgw+AIU+qpcc+gFveyuViMcGngYOhWM5wcSQzcj7XE7yJCv8dOOajgZNtLrskKcsIBI7CsKQ5xiefAatk28I70slMZ9VU2Bxh9EPLCt2BB++7uz1BqPXA857u4PuzvZwb8T7/c7e9t5etIg8uwa8mkv/XShhZMIyncAi/4JCjODQvU/2tPhjeNe0gaPxDfqnzOTHzsUM/DIK9C3G2eHRKRvssIyrcenu8/GSElR8eY475JmUu3xmheSe8Acjx1KtY0WoMqdcdfzm7cHluwvcOXvzj8s35/hFtFZKpAMFb03JLbUD34n+4jgOAlC4WZFBHSJtsVeB6isIxJWtD5T+ys4slAnfGvEyKzAjrL5mRp00GxmdN0KpQsUXsiVaW2xI9wCOSOpDbjFB+4rsFbBKTIv4XdDkK9RTPBXmZYsdLCDWAbjF/BkIEfYuSrpRiVAGM7KYEOQCWmTSxPqaKpvWWMDnu7pRKDjA+dN+cpAUJZhzYtajcO4tgcVgH/DsNdfk7qKmNKfSGZJMAil4ls2gRmOgYeRUSqU+BRGSSdI9Krpq3Byx6lnBwd17z8xxod2zhJf2G+LuNAP8xE60+YNbEYLPVeChtq5nwoBIeEhiu8nLFXgV+AzFQpZuYncTu5vY/cbYXX5YVXfhqSt9uqulz6Xi6Am1cclzpfQxznuUZtUgX796Q24xKCSUSL98vEBgfxaKxouvU2oXv2N95FP5CvMHc3v4+0MqP+bGatiCGHR69BJQ7S3Sfcf3gmOnKK+q/upqb7UZSjioWlMiUg/OZrpkHCozpfJdgN1iqRZW/VywCb91HSr49QhIq6o09o3/ppLcVJKbbLTJRj9MNtpUkpvY3cTuXzN2H60k51y5aAl1ki3znJuZ97TwnKTlDAOW95AhmDPVcrVCxNi8xoqalUM07HWH3dFOIgYpH6Sv+3ujXvK6x7d3ujvd4aC3E9Vz/dUijudB1oypmr29HZ2KUcTdoo4rFZzLFlqnze0/qNeIEcEaQc+8bobOodKbee3Y21vzOkNr9p6rWVUh2UYNqRY6IkzD2JzGmmosBnA2Bi4qBqiS4ItcSeYCVAychmUyly54SQrQNbP4YFRAFB8oixdcYRWpkqxM6fUUkCDTVDVrOJaEkGJENR8ouAp2DHT+jtVpbUv92ZU8OyOJ35HE7M3XRAgK9Hnlvr1uf/dE+Rd57Nwb+IGNXt/tcAUHQEPgMWted27q8019vsnxmxz/Y+T4TX2+id1N7P41Y/cP1OehGnq4PseAb67PMbbVYfNa6i051/+8THehEjhw7s10kpTGbTdXNbirK+BKxNBUWwcinA4+Re3FOaK4Oi5UnR+iIwSuPPScNU9s3cFgMNR9i09lqzrSoPQXd2RrCC2tASA6KeCDjQb4g2pugZZTsZG0qoc8R9wr3AlF/lqdCnuUsuK5s+RMlwA5R2aLweODR7nbYHGKduJn60a3nAetyAe5Lk12/5/L4gk9IMs69T26GsYzcLokIolwszjldk61t1995azbIp9Qv7Z6GOgDDeuxQ8ENGgP/CuPFLx8vXrIxVZwu4ktLxa6Q1CIgZk7hIg7RDqrtfJrkkozR5XjiGD9ovDChCGKjDAKza3UuBLsKx3FmvwLqz4DNTqU0STg4oFk3L+bnBcWtyCgLLp0VlKlqQ0Nt3pj30mU81xrUDh21rlXMjiUBkaTMTWOCiK7TY1fTSi5ek+u5TPxUUYs9tdhRsy+XuPCqvUr8AZwEYUwkeGadtp69uKcX1+hRH4U7RHWZB9JE4KP5miuprPZsPhr0YqLX5ONafXQnGZvTmEcvZpENs5SdsGSitRV/Y4xch8Lgalwiip7Nljs+GbuIiHudGkuxXzKWdKjU8bdyytXVJhplm0p9SH5ylkXMf0LrnLJPDZnd7SvkUBqZ6sQ+m2daMKYFY48BNvAfDkSCWTr5BxkcDngHOFrY3yFBYLSGe57WWlR35NtuDqWGBKw6Kna67y/2FwAXfjH3gEbPxwCGqbaev/jDNQu0KE81lFXtCixrcJXfTCM9LunN8zvflaKU+WeTlyQ+WGyefFDZ7Huj9ANI8ufB3f8T4m2Q5kdEmlDt0ibk2eLM/puqL1k6Y/+9jrijWYd/OzmbJ91dVB2GAnF195C2tycCf/HUgYOr5NEnuc7PlU11QtOMFxRGDkaSiRRu32EqeEHF5ha5ss5d6E+NJrxBd+kIjQ3GACcsimA+lBnouZ3xamXuItRXsuRIdG1L1/zQWskEfaxosY9oBRV6BENtIJ3twLPfdOgHz+EKp+RJ7LjyLlR5eV4qOusMtsuccfjwEy6I3iMpPVKiK1Si0oV2teZ8VgUb5NskgvvEQZjcfhjRlja65ZqnPbEWHM2G/WyonqxIbQH1WnNBzkTmQoHGLX258gRtuHdMH69QIwqYF3S8fLHC+5OLFYogpizkQsOvzbgdJtk2jQUR6se8+/Rb3VYndv0J7lNfh9a5zn7tm5/qiLtD5MZXRQ2XvFvs6v/XPyYKCY46k/aUNtVIitJ3Sr47vYrWdKfEcuhP0fFMqJvFwLs72oChhu2ebmMl6u6vbha9GF1hAb8R4xraz4I2AMLOf3wxc4k7dPqrrzSoRfQz/ObOo2Nvag336Qfa5oqG4duh3O8dGP4FN+nvfnSNf7jQU+9i9IER3b+Lqp04jPF0qwppXYEQfpCY9/f/Boq29oY= +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/download-role-insights-entitlements-changes.api.mdx b/docs/api/beta/download-role-insights-entitlements-changes.api.mdx new file mode 100644 index 000000000..4d81a4897 --- /dev/null +++ b/docs/api/beta/download-role-insights-entitlements-changes.api.mdx @@ -0,0 +1,83 @@ +--- +id: download-role-insights-entitlements-changes +sidebar_label: Download entitlement insights for a role +hide_title: true +hide_table_of_contents: true +api: eJztW9ty2zgS/RUU52ESlSn5Gsd+2XIcZ8pTmY3Xl82D7apAJCQhoUAOQNrRuvzve7oBUtTFsZNJ7WZSekksAmicvneD4F2UF8rKUufmOI32ozS/NVku09M8U8fG6eGodEem1GWmxsqU7nAkzVC5aC0q5dBF+5cRzRT11Oh6LUqVS6wuiCQIno+0E8qkRa5NKawqK2ucKEcKDxuyQof1YpBbIYUFzS72KKSVY1UqSzvdRZoIFrIcYchgAL/CQmBfi1wyUmMZ7d9F5aSgQVdabYbR/Vpk1Z+VtgoclrZSixgVb1nDEJrIqc9yXGRE52WysbeuXuzGL3eljLdVuhfLvfV+nO6lO1vb2zubW4M+dgkA/6yUnUwRutwyA/ObnuE55OGqDGxXDkBZKq6UJpU2FW5iSvlZ+EV9lQKcuPz3ljg4ORZn9aTDPMtUQhTFSSOr62ejsizcfq+XqhuVkYK7TuqMVdBN8nFPp6YnC92rN4uThk48lfkvBB244oDy+ZW5Mmf+mYBWXVUUxFzKWiPwA5DJb2l4oFWWun3R6eiUFa2Ve6/L0UGSKOc6HSJFYk/VQIK2oK2I5kPziXsSBSyJyOc2BVNRW7EDmTnV1toyQmQl5YSHgXnMWi6yPFW1YTxoQw+pd6Czpep9w89/cAV78PMqflM/fZqSBbYQPork1u0ThU6HpNPpQP/utuOftMRTD8w4Ga0Q7lZcRfYqWqbZb1XcNdFyRW4c4hbGN9fX6b85b6xgHypVaVechhglReJuwCPiQpJDVdoQz1Jk2pUiH7TjFwJaLvpKyDQNgprGMFqLKYxMfS57IEp/P4wXphZtL8N4mGmKlUfWYoM44CS7GbBeSGAK0Pp5OiHNaXMjM53OYZBFkemEA37voyO6S7Dk/Y8wFgrAlhRLPuThQArZIUt9Hvei/RsVDy2kBoSKISdYKEDxRrMPj3NL/k8kSZycEmhed8YsIInuhnglU/Dr+TsMzEBMpZXJJ9Ci1PUYoAujsV7USxDjG4tesq3aVbL/Yn1vc3vwYlvKzZfbG7s7/b2B3Npa39vZ26PdxwgocuhFE/aW1srJwta/KQN/SkSWJ9DIfyAQqyRkzwB4cyzRpRq7x3XANJ4gfwqufm7DZsAryAzXYKGvDk/E9q7IkNErfi6Hc0Iw8cUZhboqy2Q/C74Gzj3hd1YPtVkGRZlqTLXB66M3Bxdvz/Hk9OhfF0dn+ItoLRQJBwbWmpJZAipsYZTfMuLAwK1EHFIUv8g/O4FqBwzJUEuEidr/chMHYda5BSvC7ktWtEmLgc3HM67EfvO5FM90V3XX4OF4NpZlMhJ96bAAKqTpHUouRRm/DZLsiJGSSFDPu+IgTTUxKTMBbwRRrJ9MQ4X2BAYVXBlgkKfyqhQmL3WiZnUxFeWsNuAEFIUw421bKeQcQP64nRwkZQVwzGbbCxtrCRCDfoDZS24W3XlLaCxSym1IN5iZTSBGayFh0QdvGsEyhCNOLwg8pp7XRCwKgTVbHO7+8GBelzmPJbJyT/C7kwzhJ2bWmoEbFZyPY7aPRqyNWk0hImGQ2ObFYVajrtrxfQJc+e7Kd1e++0TfnR88DZVZGOXSZ2Ox9LkwsoJ8LSfPhdLHsvWYXNSTuLwJilxDs1CXSL+/P4djf1KG5qOApPryO9ZHPpUvgD9o9BFq/boVqFP/VBcEkOXoORggEql0n3FPEbOgvKi2Fnd7k9u+hoGaJSUioqYVk7wSEiKzlfEVrVsTaa6c+bUUI4n4KLlV8hHQN++x7yxWleSqklxlo1U2+mmy0aqSXPnuynf/nr77xUqyQcXeEuokV43H0k68pYVx4lYKTBD1GaFoXI5VNV+tEDHR1FjRbOUQ9Tc3+huD3URtp3I7fbG1N9hMXmzKnd2N3Y3+9uZu1M71l1M/bpxs1qda+vZ6ZBGjiLtBHVcZGJcr8zydPf6r6LXCgMIahZ6mbobMIdLrunbcWXbCeAyNWLLSM7/FA0eNvt6WBhBQknqvaSqfVYW4qhBXWWaVZX6OLLOqEFe+u/Ldv6fvfkWFGKqhhytETHhyhYi53XXR1FJvyLj+54Uiu0pA4K9Y5ElSWT7wrKtAritgSgRoqDiG0OWa/ahHL6/j+lJO7665ZXPfa731jhN/GahXXxqi2xVcOHrMlc1Aq76qcAdVQoX3XVnobribMTH5Ld9X6EN+S0ITvcX2bkgT+GaE36DLwrea7NsHQybuVcHskiXXVyK+SJnvHUDHk7xC+GMyawK+EGyNHwNiIc3kV8ezu2xbC/yBrwub3f91XjyhB3hZJr4v7ob5AkjnWCQWrkldsAkQYn1dAM+hj2QHFdnB5XV7zhlV7h7hwsxpNqJ+Y3MB0DuatileKWnRVvgj+Ge/vz9/LoZUr3K88FdklKYGAx53AjPieHhQH0fTIk5RNq+GI2buYObAn/xPDDIIRVyZM6XE5XEQ1D+RKE4R2VnstEhxMKFVT79MI2fWPed8yY2FNnQnhZ92r0wsXmvr79r4+2yBRX975LKo+ZItvr4VxC81tdhTi5kaXeOZQeFFe5n4CyQJggCRkJljaX3z5p5e3KJHXRieENV5DCSJgGP2NU1Sa+2bcczQi4neLI4r836kkYxnlwkf+4RDLs1ScSySUZ479Q8hyHTIVS6HFTztm2Hd0qYxe0S8ud6CFPstYx2jtGR8b+EYxhuT7FNq58omR9FnUu+2H1iziAsf+L7Vhxme+fElMjDNTPPkK26IzWGmDWPaMPZxwgX8PsGRYcG3iQeOA94ADqf650gQgLZio6e1NPIz+R6v4SucgMpUXLHvf+xPg2BzWZAGaHYzB6GaKvPmxRV+i0CLstyMsOozhXkJLuLNciTXObl5vM2pCiXcH41f4vhgevTyzmST7x2lH4gkP07c/T9FvFWk+RkjTaiVydx429BUtI38VajpFo8C0S+Ab/yLUfZVLsvR9HAbx1VMm1CRyZKsmr06GWnFhwiFkiXVh2tkWfmYPRH9Prk/WkUmNLSYA7d1qFtlX2eg1xXn050lO4wvPkmv9NtV3MnQXr6W74r3dDE/gVqop6OrAhj7mIfm7gyaOeGL/K9rZaPoGo8rg93IL6uxkDCpRywi1S6pfOBCi2dULYucS79mVe3FZGrEQpe7Gzt27wZ0Po3Wt6X4R/aC3l04nIboSYvh/vaUkVOVsWXSvNnS/jHasLZ4pLKCukpEXRRgqrXDH8fnCxRBzDjwhe49t8NeWOR6NBdEqIXy5rPV3eiux9xS4HmRuxJ9cBt+aL0e+5pi3i7vpuf0f+0TjZBR+GpzQWdghLPy7YvvJi+jmW4Sa/bbX20saSgJbN1SogEZgWsic3dHpynUY93TY38RnxoX6IGcY3pV/EFWVx9dfI+PLpbq/JOic5Pp1y7hbCTiD2OerqHVdxNP+m7iCyqYfpEyVcH19IjhKz3m2Wn4DuO5OF/6mdRSJPVRuZm0YdQIp+5/f43J/hCUcflxf0zaWtl8OEGMNEdWvx0hWN7/F64RSEQ= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Download entitlement insights for a role

+ + + + + +This endpoint returns the entitlement insights for a role. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/download-role-mining-potential-role-zip.api.mdx b/docs/api/beta/download-role-mining-potential-role-zip.api.mdx new file mode 100644 index 000000000..be0f162f9 --- /dev/null +++ b/docs/api/beta/download-role-mining-potential-role-zip.api.mdx @@ -0,0 +1,83 @@ +--- +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: eJztW1tv27gS/iuEzsM2hWU7juPEeTlw03SRRbvNyQUFThqgtETb7MqkVpTSeoP89/PNULLlS5o2W+zZLdyHxqaGw2+unKHou8CmKpO5tuY0Do6C2H4yiZXxuU3UG220GZ/ZXJlcy4SG/qvToBHkcuyCo+vgdHAqaFR4yuCmEcTKRZlOiR+4XU60E8rEqdUmFxVvJ6SI7DRNVK5ioT6nNsuFHQltRjabMhaBT6BKq7VFRstogzH+NOUFhVPOgboJTKnM5BQMM0J2F2haPpX5BI8MHuBbSQwxG4GLJmoqg6O7IJ+l/DDPSIJG4CFgpCh0HNw3gkz9XuhMQTl5Vqh1CdUmRELTKuqzJClBdhjt9tuqdxAeHkgZdlXcD2W/PQzjfry/1+3ud/ZGQyy2EXdaN8D3RT9Y03D8oJKX5OkcHO7t92UvbHeHB2G31+uH/W7vMOx3utFo/7Dd73XlQ/J4g39/MwA7nAhOk6lbbQuXzERWmMq/PtohO1VOLrks9ZJk3X63PRrF3fBwrzcKu4dyLxx2hu2wF3f7h9HeKB5128H9DQFyqTVQDsHvtNv0ZxnURRFFSsUqbopzlReZIcf/Q6dipKHdyJpceg1H7pbHHCPUMWHLNb5Kg/igL4ma4q8rJVArApD/EzsMEQqZpomOOI5aWI6GvkLRQ21kNgvu8a8RdDfJc5xorCBOsgwowlImRLAeMSaykHK5GNp4JqBkbW5louMvgPvoiO8GdHb4UUU5RXVG6Yl04eFAY8mxjdUmSZbBvtJGheMMGqYcw5AjTIR32Fsdk9anNlPCsyTHIRGYrrnsD+12c1e8kDHk9fIdl8JATXkmo9/Ai1LnY4CujMZ8UU0hd62suWFZdaDksNdGPI0QSrJz2N092B/2R3Jvr93f7/dp9SkCU469asq1ZZbJ2drSPyujMh2JxEawyB9QSKakK7MsL44pOldT97gNmMdX6J8i0tPOxSzxilx9zhsIhRfHZ6J7IBJpxgWPy/GKEkx4dUGJo0gSOaQhin1I7hm/zfRYm01QlCmmtEG9PHk1uHp9iZHzk/9cnVzgE/Fa26cGSNgmJrcEVPjCxH5ixKUAn6RDFkygDorl5yXX5xBIIqZrhNp/czMHZcK3RrJIcswoV98wo85ajDI7XQoljpvPuXimm6rZEEMaQ7RGEzGUDhNgQiJ/PkCiSfPwdanJ52KiZKyynaYYxLEmIZEpEI1givkzMBIyjhUne2IwKhDKAKPziS1yYWyuI7Vsi4Uql62BIKD0BIrXdaNQcAD5434yiPIC4FjMehTOvaWEWNoHmL3mltFd1pTGKp0huUaQQibYBiKbZdCwGEI2jSxapiMyl0PiMRXdPGNRCqzE4nT3xoN5mVt+FsnCfUXcnSVIPyGLNn9wq8rggxvYMhuxNSozlRkJD0lsnlxSzc1VBT42DZXE29jdxu42dr8ydlcfnpdVXPmUS5/d9dLnysgC+s1481wrfTL2HmNFReR7GG/IhqCazmvnl3eXCOzflCF6FKZU0H7H+shv5WvgB3N7+PEhlR9zYy3ZggCyHssuDJlIxUeMe4GYFeVVtbe+2iubDTUc1GwoEZE1MzGzhZBQGYpzrn6la6A1VM78lIuJRH6UiAjnfAb0/WPIDeS2ktxWktvdaLsb/Ti70baS3MbuNnb/mbH7xUpyjoqjpayTXDGd0hEbe1r53B9ZgkBU54liHnJsqtVqhZiJeY0VLFcOwbCzO9wdHUSqG8tu3NvrjzpRryP3D3YPdofdzkFQ3+uvF3E8D7LlmKrZ29uRVYwi7hZ1XGHgXC63Nl4+/oN6MzWitEapZ143Q+dQ6U1VO+5vOmE8hUUy8tILv8QDR42+3pYGEFCS+qiZVz7bCnFbIW53me0u82PsMtsKcRu729j9Z8buN1SIZTX0cIUIgq+uEEHbbIt5LfWKnOsvLxQ5VEoE7N7CRlGR8YFnVQVyXQFXIkBjxTmEbgocBS16qx36+wdhef/Ate7mNzjuW/MX4CGR4tnKLYn7ln/vH0qYOGrdVZcO7lvVLRS6fsBVphewyBIsPMnz1B21WndgBnvfN2Wqm+UL+Zmxn5qRnbaGUPaGPEavvH3MEoEYnJ2WlXKTLZVpCgafOZm5txvrhtwe9uNTzi9ypisU5BAzWyBXMpuGQOCUjsnDdLVGmtlPjqmb7Ihr8kGuqyy5//OyeEYPyLJJfV9cDfQCSFdEJBFuyFxwIDBie10Bz7FPe4OCnOb6pk5zQWW+R7hGudi6qDnprAF6S2Qd8ULJDD2IP69/9su7yx0xpuKWk0vhqK5WmroRhOcZ3IiT56A6u6ZJvJ9lthhPWLjB0tsBClYxSqAU8d5cKCWuT0tF/Ypd5RzbAKudJinOPDTr5lllwVjdqoQ23OZC2+ScOjYtaLEll+bt8ObKXUjtllXzvQnFS005jwKMaUoR+WBeXKeVXLIm11NB/KviFnpuIXNzOysovGqvI3/bJELG8IHtWFtPXtzzC2v8qGXDCHFdxUCaKHEsv9OJKqs9GccSv5D4LeN4b95NNHbu5WnCJ0rhsPEmsTgV0cRap/4tBLkOhcr1uECkPRnWJ1o05IgIO+0apNAvGeoQdSjje43AMN6Z5JDqAC6DLCpEE/uw/cCWRV74wFeYPizJzMPX2K6JMraRezJmWjCkBUOfJ1yJ3++G5Fh0wQkycB7wDnC8sD9nghJoLTd6XhszP7Nv8Ry+vQaozMWlR/7L0SIJlp8EPyDqOQ1SNZXx87dc+C5KXrQlLimrOoBY1eA63sRiJ17Rm8c7P4Kh3fnvJi9JPFic07w1yex7Z+kHMsnfJ+/+nzLeNtP8iJmmLKzJ3XjZsgOpO/mLsqZbPzdEcwG58T+ecqxyDY8OiXs+rmLqjNJE5uTVHNXRRCs+cUiVzKk+bJBn2SlHYppZCn/0lcxonIEGYetQt8qhTsCvKS4XK0sOGF98kl3puyu47aG1ogk6WNUU79AEmghmoQaQ7hXg2UdbdoIXsMwZXzx/WRkbRdd0WhisRnFZTIWESz3iEbF2UeETF/pBoypdWC795rOqKCZXIxGa3AplU/d2RIfZ6JNrhn9kLdjdlSfZUD1Zsbw6vRDkXCXsmUS3XNo/xhveFk5UklILiqyLAkzVVnhzernGEcyMg1xo9W02bpWTXItowYRaKO8+e83dZjvklgLjqXU5muYa8xN/FftZ1YLtlAdQ7tuu+6+67d3izP+v/MVBuT1RX9FK6fSNhC58L+T72OtgUx+LqUf13yKstLL0eP3Kf72bJYraJfp5Q4v2ZwKd07p3d3TwQx3ePQ3/Xig6Vbi+WTRv3ETBJ+gz+u8RstTqrfq6Xp+dl/fvd8QXf/KwUSnVwaWZLc4sAnz8TdFRx0IX1Kc+CdI3/o7hCSBXLfJkqH/2lwpPwD73lfsb0PojPza/f+wPBWsTV38/QH31/Jzm5xME/f3/AC4CSW8= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

+ +Succeeded. Returns a zip file containing csv files for identities and entitlements for the potential role. + +
Schema
    + +string + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/enable-account-for-identity.api.mdx b/docs/api/beta/enable-account-for-identity.api.mdx new file mode 100644 index 000000000..181308e8a --- /dev/null +++ b/docs/api/beta/enable-account-for-identity.api.mdx @@ -0,0 +1,99 @@ +--- +id: enable-account-for-identity +sidebar_label: Enable IDN Account for Identity +hide_title: true +hide_table_of_contents: true +api: eJztW1tz1DgW/iuqnocBKu5OOg25vGw1CWxlKkA2l+IhpBa1re4W2JJXsoHeVP77fufIdt8SAhlqZ6DMA+W2pXM/R99RpOuOzZWThbbmKOnsd5SRo1QN49iWpnhp3VGiTKGLWWejU8iJ7+xfdqqPvnO10UmUj53OaTomn0+1F8OTI+HLUaYLL6QopP8oCisCXXF0+FrIMF+MrcMAr80EH3TFpwtG6kuhnJHpoY3B8HqFybGSzojMOiXkyJZFIA0qNQ2tvJgqp0CpdClmTIsi9/u9XmLjMsMQ1rbrpU5zq03RjW3W81L63lSleQ+/Mmt6pVfO8///hsDK++60yNLfamYRfYnmHDs3Gx2v4tKRrfYvrzsX+H5gTQFlhmUxJcPpxOxXyvvIQwy1n0kjJ6pzdQNb5tLJTEF1zwQ0KZtLTN3oGHzAL53g2cdTlUmySzHL6a0vHAQiAZz6T6mdgh8LV6p178zNjIdgaZnlKRHpx3tbu5u727uD/uZ23E82t3YH2zvq2fbW1tPd7c29DknolM+t8Yq90t/srzsHsaHyQiUiEqeqKJ3Box6LAqxJOOUL8Vl6xAebdFym6YziIcyBLywP9TNfqIwEjMmCpiBGMs9THbPveh88cbtet4UdfVBx0bnBv43OYHNzXcKDVIOgeOEcwu9uKUc2gZE8ZPok02CsB8oCxzrKMY4SFqdA5B3YRK37cNVlL7VR0cRJTRIqFjnGRAGKn3RCMc95EEgKG1TgccvehSW6W+K5TKBv0O+gUgZmKpyMP4IW5f99Al0YjfminoIw4jS+g63aUXL0bHOvPxg/G0jZ3x1s7Twd7Y3lNiLq6d4ecc8QB0gBv8BbOidna6z/qYxyOhapjeGR/8IgTknYngVg5piiETf+fh8wjW+wP6VMGNuoWckrKLE3UL+eH5yIwY5IpZmU/F5OVoxgooszymEEO9XAkJzQPBB+4/REm9tEUabMqGwcvng5vDg+x5vTF/+6eHGGJ6K1Vn2HBtGaUFhCVMTC1H5miSsFOO9UCnOopCueVFSfQCFp/OJA7ReSELE1lmVaYEbF/ZYZi6TF2NlsKZXiUAXFI91V3Q0xoneZLOKpGEmPCXAhDX8Sakd0XFnyCYq4TJR73BXDJNGkpEwFshFEMX8GQkImCdcNJjAukcoQRhdTWhaMLXSsln0xN+WyN5AEuuARx4tOoeSA5PfHyTAuSgjHai5mYRMtlYiVfyBzsNyydOerVXKGtSqGFpLKZGydg4XFCLrR2lqVI3KXR+Ex9bimYlEJrNXicvcqCHNYWP4Wy9J/Q96dpCg/EavWfPikquTztLaHasTeqN1UVaSqnvPkalTjrjrxxVirNGlzt83dNne/MXdXP55WuKz6ytBnax36XBgJJGodL55r0Mdx9Bgr6kEMbypHbggYpIJIf7w9R2J/VIbGqy85Ic4fiI/CUr6OLBt/hPcjgh+Ns5Z8QQKyHYMGY1Qileyz3HOJ2VDBVNvr3ND5jDQC1NwCEQn5i5kthYTJXGkMSSL9hkis8ub3Qkwl6mNoGkIFJK4miUK30SLJFkm2q1G7Gv0yq1GLJNvcbXP358zdryLJRirOlgon+TLLpJuFSKu+k7ZSYICodwhFk3LsqlW0QsREg7E6y8ihM+pvjbbGO7EaJHKQPNveG/fjZ335dGdrZ2s06O90Ftf6y3keN0m2nFML/g5+ZBMDxH0CjisNgssX1ibL238wr1NjKmtUehrcDJvDpFdz7DhYx46vbQHdQBjY0d2xvXhxekz0wZrJk91s6WJFMDuYDsNlwZCSYhiW1r5ooWMLHdvlp11+fpnlp4WObe62uftz5u53QcfBfdBx8B3QcSAIYo0JYv2V0DEB7iBoNoZToENcwryGYGMOVepjBk3aF9JNVNEAvSUU2d9bR5Hn1opX0sxqsOSXdiLN3FxU3jA2o7GuHosBUkxQIo1A1dJAtxRVOlOESRE/ItWZ5jwmhUDXzaLhuIBWIWfqeGu4aBOnZUInK1AUUkt7rxYxphFOakzwDxR4H3SCQv0D9zgrb/2p/WBxShofk8bixZdYKcr5Zv/36W2nBI5MOIIizoKv7zguEPbMpUEbob7koXw1ELSF6i1Ub5f7drn/NZb7Fqq3udvm7s+Zu98B1Ss0dDdUx4BvhuoY290UDZZ6ScH1f0fsnCqVBBzewsaM1ZM5BmdcgVAigXLLG6188na/05sf8Y3qs7u9a53c9MKJ5g4d+yWIGKRbPnB8DafBWTddmetuffTW2M984ngES91ShOjMaUg4GhBOUzODLpvZaeIayh4TD0ZnxShm60PNX6VMx4nJmzO0IiKQ2RCI+iqq+DVEzNFS/O55dJejaE0/6HXh0ps/r0sgdIcut5nvq9wwXkDSFRVJhav5Ke0zwt+B+9pZ7fmaQjv//TVmb2hYXzxX0qE5CIdhHv3x9vyxmBDq5Kwv6WS7UJraBOTNCUKEq9qwPhhCk3ihcbacTFnw4dLRG8oiMU6hsHhnzpQSl/Vp/Nco96eoz2xSmqS4JNCsq0fNcXf1SaW0Eq4cddeJ6cFCPbk07zGvetweaIPHLJySf2cicaipGGlavWlMpSJ3e+Iyr/WSC3o9VIjfampRoBYxNf94RYpg2ss4HOWOkcpEQqaerfVg5oFetECPeim8IaqrMpAlKjmWD0zFtdceLMcSvYjoLcvxzrydaiypy9NEqGDCY0VME3Ek4qm1Xv1DCAodSoPLSYkserBYn4lpxBkR9TcXRIoCy0jTpQiWb+2OBuMTG7ZKOCXfs2eR8+/RPifi/ZLO/PoS6yiNTGzsHywzMYyIYRRqgK/kD8sUBRZym3TgOhAC4GDuf64ElaALdS/QurWqM/kez6GlIYaoTMXn++HH/rzAVU+CP9DoZgzKMOHr5ggZfouKFq1VS8aqdwZWLbgub2qxRK7YLcjb/H2Tls2/m76k8XC+gfLGpLMfXaXvqCR/n7r7F1W8ttL8ipWmQrwUbsy2ag0Wg/x5hdfWN/Rox3mq8D++cq4yuEbrws0Yo5hFQnkqC4pqzup4qhVvBeRKFoT9NiiybMaZiK6d0h8NHxOaOIxB2npgUjnSKd0NpM3qmrPkhAnAkvxKv31ZHZ2wCEm0lqor3qI7M4DtjjozOrSLbx9s1aKdwTMn5FhxWDsboCvLSkNX5CB2mQmJkLonIhLt4zIULjRqRtW2sAz9mll1FlOokQpd7lFc5t+MaZcZDeyC4+/hBb/7aosZpicvVlcE54qcqpQjk8at3IO8hzaiLaKrkNQbouoCgKkFDq+Oztcogpip/q5h3aRXTfI9Ggsi1B6F8NnubnU3I24X8J5aLXSzC8RfzK+JDheuiS7cQl0Kx+v5JvuPunxaLSnUC/Ry2soiQcvQm4SekC5yrvWEmLnP1zOrthCNxpQaSYy+vqa9D+qTbug1en5qrC+v5i0Qt46wPj2jBR2jHqze3lzU9NFpdc/zMf/1ZuVO560K1Dt2ZjZv1jt4/Kiox4fg6IQhMW/CsDThQ9imWZiy9ocM6qia1vnkDW1YMRK5bXWuHqA66s//AEjgI9s= +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Enable IDN Account for Identity

+ + + + + +This API submits a task to enable IDN account for a single identity. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/enable-account.api.mdx b/docs/api/beta/enable-account.api.mdx new file mode 100644 index 000000000..d00141a0d --- /dev/null +++ b/docs/api/beta/enable-account.api.mdx @@ -0,0 +1,96 @@ +--- +id: enable-account +sidebar_label: Enable Account +hide_title: true +hide_table_of_contents: true +api: eJztW1tz2zYW/isY7kOTjCVZF1+klx0lcTruJI3XsTcPjmcLkZCEhgK4BBlH9fi/73cOQImyfEnSzrbNcDLjSOTBwbnjOxBwHdlM5bLQ1hwn0ShSRk5SNY5jW5oi2okKOXPR6CIKT1x0uRMlysW5zmgMRpzNtRPjk2PhyslCF05IUUj3URRWeGZC+rFCmkTkqihz40QxV57s+GVbiA9mDPqPyogrXczF29Mf/zN++eb4ZyHLYm5zXSwFJsnVf0udq4RYxzJNwcRP3YagTsUlEULY6+jcqfyFNYX6XIzBgRTQiRkFQVzLFbJQo4U0cqaiyxvolMlcLlShcscMNGmWSQzdiQxe4JtOaJZ4rhYyGl1HxTKjp67ItZlFNztRJV00KvJSbVtpbQfmpD7LRZYSCzXtH06Hg/7gQA0He/u9yd5kcjjoDeTefn94kBxGJB9xV654bpMlzX57spiUhcPwSmZZqmP2aOdXR5Nf18TelOrUcxWlg1WnNl+J6D3XSbSj/ykOvLp28quKKS6ynOKm0MoRV9hZ5Uam/1a5nobJKZxuz3c8FU4VO4gEUQ0R4BQr58QnmeoEbqHYkAUHCMTKxZWEx8jlTAg5OUTY9cEo7bV8wR118/anw+7h7mF/L+mpve7+4W53L+n3pofD3Vh29w675DuoHquT3H7SDoISh3tFz2pUoswqiWtRXkCGSVngidfC2RLcEeWCU8UyR4pntvrVHFFfH48XxhbCLU3sQ10ZV+bK06x403CePKlpP7E2VdLU1Z/K1KkbqFjogs0REvnMzmapCv6Pbm5uOIJdZo3zLu3t9raNMCapfN4mqpA6ddE3x15VUYRkptXkgthJzeYNcwiYCxmbQ9lAHGImqmcdpThVp4cjVd8RlToRdrqqSA8GUy/mYBocDPYP+4nc3+3Sp/1hP+7h83AvusPUjq12qlyZVpYe7O5ui/Ei1TCjOMpzJGJLnHKlhMrayxaCXUxQAsj92nDGtL/GAw/bxpv7hU3UdoG7Xc9eaaNasxyOgoSKRY4x0KdHQs5bWAStZ1mZl+naGwaFJdpd8VwmoqpFL4IyZMhcxh/By5eShwU6NxrjRTUERZYL2j3TqgMlJ/u7w95guj+Qsnc46B7sTYZT2e/vDveGQ5p9gQjD+uBqc8s8l8utqX9UBnUvFqnFqqR/U7TKSdieBeDJMUQXauEe9wHz+AL703riaVdqBnkFrXooseL5ixMxOBCpNLOSn8vZLSOY1vk7WuDKNOUyz4sJNPeM3+Z6ps1doihTLijhXh69Gp+/PsOT06N/nR+9wyfitQURxih3JqGwhKiIhbm9YomDAlfSobamMAeqmXgWuD6DQjIghUCo/Te3dDAmYmsqkVIYEWa/Y0SdtZjmdrGRSrGHCOKJbqv2jpjQs4Us4rmYSKrN1lfmZ0hklRWt18GSz8RcyUTlT9tinCSalMQ6hmwEU4xfgpGQSUKp6xlMy4IqOC1ctiyovGssCBu+WJty0xvravK67hRKDkj+eJyM46KEcKxmPQtX0RJEDP6BzN5ym9Kd1YzGJl2iRsfQAihsCTPmOSwssDAJAoChHJG7HAqPqehWFateJLncvfHCvCwsv4tl6b4g705SlJ8Wq7Z68UmF5KsgA6oRe6NyU6hIeMkFnwYHqpW7qsQXU63SpMndJneb3P3C3L398jSguvCWoU93G/qcm9Do0eK5BX1y5UFx1Q3+xvAmOHJHwCABIv30/iy0kaBXnzMChn8gPvJL+TaQXfnDP58Q/Fg5a8MXJGDoc0iDKSqRSkYs91piNpQ3VX97tlc2n2gEqLkDInK/tLSlkDBZXhoG0dLtiMQqZ34oxFx+4kaD+i2ugDSrSVqZ1aZokGSDJJvVqFmNvp/VqEGSTe42ufv3zN0HkeRKKs6WgJNcuVjIfOkjLbwnbaUAwXp/cZVy7KrbaIWYiRXGijaRQzTpdSfd6UGsBokcJPv94bQX7/fk3kH3oDsZ9A6i+lp/sc7jVZJt5lTN396PbGKAuE/AcaVBcLnC2mRz+w/mzdWUyhqVnhVuhs1h0ss1dhxsY8efbQHdwBjYMb9ne/H89DXxx9TMnuzG+9cEs73p/P48QUreqFaftSsa6NhAx2b5aZaf72b5aaBjk7tN7v49c/eroOPgMeg4+AroOBAEsaYEsf5M6JgAdxA0m8Ip0CEuYV5DsDGDKvgUdh9D2hcyn6liBfQ2UGRvuI0iz6wVb6RZVmDJbexEmrW5qLyBdkG0eUULAilmKJFGoGpp63971wtFmBTxI1K90JzHpBD45svWeFpAK58zVbytZtEmTktIyEUhtbT3ahFjGuGkpgT/wIH3QWco1H/gHmfw1u/aDxanpPFr0lgcfabTLTDhav93765TAscmnJt55319z3EBv2cuDdoI9Tnz5WsFQRuo3kD1ZrlvlvvvY7lvoHqTu03u/j1z9yugekBD90N1EHwxVAdte1essNQrCq7/O2LnVAkScHgLGzNWT9YYnHEFQokEyixvtPKx9FHUqU6zd651ctPxJ7YjOghPuNCLVOYpKOdFkblRp3MNT8FDN22Z6TYKGJxVLI29asd20ZnAPHdUHjpo6rOMCPw5f56gzbbNNc3qax0z95ZmbShQYXE+W/AgZzpgTy5cov8Qns2OQKiHUOLHEDFDH/GDY+o2h86WftDrPE9vfr8untE9utxlvgdnA72ApLdUJBUu1/cW3hHo9rNv3V5YLyS03d/bmuwtkfXEcyVzdAT+BMyTn96fPRUzgpqc6qUjlKs09QZIlhOECJeycXUahAbx6pLbcjZnwccb520odcQ0hcLig3mnlLg4Dkb4GTX+FEWZTUqDFNcBGnX5pPJOoj6plJa/9tqSFHg6MR1YqCM3xj3lpY57Am3wccFP2x9MS7zUVIE0LdlEE1TkFk9cZJVesqbXtwrxj4pby3NrMTf39JYU3rQXsT+/HSN/iYVMHVvrmyf3/Fo1ftRA4QlxvS0DWSLIsXlKKq689s1ybPBrEb9NOT6Y93ONdXRzmPBlSzgsg2kijkU8t9apfwpBoUNpcDErkUXfLNYVTdrijGj1dmsitfyULd0CKmT5XiMxjA8mOaFVmUGJ9fsjnJK/sGeR87/wLaVfNnTmxxdYPIkysbH7ZplpwhZN2PI1wAX5w0UHCIvcJh24DvgAeLH2P1eCIGit7nled1Z1Zt/hMbQ0xBCVubhs5L+M1gUufBL8gqhXNCjDBKpX58bo7lXgRQvUhrGq7YDbFtyWN7VYF2/Zzcu7+lGT1sq/mr6k8Xi9a/LWpMs/ukrfU0n+OnX3T6p4TaX5HitNgLm0+3i6vuV4VDUk998ufPxq3503+/yVOHTpiG/WMzQg9ax6HgDi9rah45t4+Iu3XBwYwqNBqu4lKlFnlKWyoDTiMhLPteINh0zJgsDmDoWyXXDqhzttaCuZ0SwHDeqEAwiWE52CH2+JVzNLzlCPZCmQ6LsrwwENixxAA6va4j16QIM+Iaf+j44G492vNjSC7xAKJxRJ4mUVXUB5i0Vp6MYtxC4XdInxsRBMtItLXynRDhpV2cIy1lyNqsoGxTapwBcXVb5wb6e0l402uRZpj8yFQKuuHsL05MVwS3etyKlKOVKIbrNPeIw3wrs1V2lGHSjKPBCfqs3w5vhsiyOYmfDric1nnTDIdYgWTKgf8+HTb3fbuy3uT/CcGjr0zDXmR/7G9Pr+9Ub0Xa937v8q167Dkke9Siej/TXSq/S9k29UL6KqUQX5yN999r0qup85tbQgub6mXRhq3m7oMaoAtfgXl+u+jPvZcB85CUn8gHmenAapn/LvSBtXr++Uudo5NMv1pkGEjx8V7TVgHDpyyMubQSyLfxF+fWidLRlDVAO3flahbtWP8BtMD9Je1pr+k7e01RZNwsXvhd+/yOUVHtLfUfQB//DF3yvmmsvPr6NqNxA0nm8F1u7CKuEDbA6y/wFrmF0U +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Body

required
+ +Async task details + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/enable-accounts-for-identities.api.mdx b/docs/api/beta/enable-accounts-for-identities.api.mdx new file mode 100644 index 000000000..a78d151b1 --- /dev/null +++ b/docs/api/beta/enable-accounts-for-identities.api.mdx @@ -0,0 +1,83 @@ +--- +id: enable-accounts-for-identities +sidebar_label: Enable IDN Accounts for Identities +hide_title: true +hide_table_of_contents: true +api: eJztW1tv2zgW/iuE5mGmReRr0lxeFmmbLjLoTLu5oA9psKUl2uZUIj2k1NYb5L/vdw4lW7KdpJPt7s4URtHAksjDcz/foaibyM6Uk4W25jSNjiJl5ChTx0liS1P4V9adpsoUutDKRztRISc+OrqK6ufR9U6UKp84PSMKmH8x1V4cvz0VvhzluvCikP4j/loRKIvTl78KGaaLsXVCyWQqdFhkLmbOfsJFKrQRxVQJp34vlS/EyKbzDhhQXwrljMxe2gSM3Kws/lpJZ0RunRJyZMsirKnNpF4AUoipcgqUSpdhxrQoZv6o201tUuYYworoeKmzmdWm6CQ273opfXeqslkXV7k13dIr5/nvPyGJ8r4zLfLsh3qxmJ7EyxWj253Iq6R0EBDKu4ku8fyFNQWEOS6LKSlUp+ao0oqPPdhQR7k0cqKi61vouFLDc2iBpKZL7RTsVbhS7UQJETMFPZKzWaYTFqP7myet3EQ+mapc0q9iPlOQ2o5+U0kBJUDdsD4ziae1FU7TDbq9gDV06oUds2EaCiUrfp5qmDGYuJtqz6auBSLDVStL5+Qcl7pQuW9w5AsHzZGm1BeZzzJFShkkh/2D3sHwYHfQGyaDtNc/2B3uq2fDfn/vYNg7AJ1qyB7+D/p7vXGPrg6H6UiO9/aGY1IfaIJRohgtfbl24Odl9vEsKDe6vaWxTvmZNT5oZNDbX9cEzRH1MJGqAt7CMv5RM9yljIV57ls3DOpsMOK6WlcpBT2MtXJkzlGgGwKNeAmBVpnhYRWTe8NjS//CpqqxOOJHTZQDMXhILotwazhYY+eslimQEZ9kVqoWE7u9XaySI9QoJB6U7zzQIXtIbSj+ZZpqeigzvovIQ4YJbOFulS3GMGQJBbflP1NjZAyTUFKq09T7B7XyPhKfpRfGUpYrTdqJmo5Iplx3xloP7TAIJn3YDG0rQGMNhX07IXba7NwXm012Br1Bgx1TZtntdYi33V5vPcReZBpMihPnkFticaaK0hnifbxWFQTqjTZwGZ0+JgbvSIUhqlcc+g5ve6WNiicOngYOFbOcYGJVy8j7uCIFknX+5HFtR4MmOn3xXKaiykjiRSUMeY6TyUfQOv2K8L40GvNFPQUW5xx9x7JqX8nRs97hYHf8bFfKwcFuf39vdDiWw2HvcO/wMFpGnt+QvNpL/10Z5XQiMpvAIv+CQpyS0H0o9bT4ffmubQOm8RX6p8oUxi7ErPgVFOg7QornL96K3X2RSTMp+b6crCjBxJfnuEOeSbUrVFZIHgi/cXqizSZWlClzqlUvT14dX76+wJ2zk39cnpzjF9Faw0fHBt6akltaTr5T+5k5rgSgcPMqgzpU2hFPK6pPIZA0vjlQhys/91AmfGssy6zAjGr1DTOapMXY2bwVSnVW/El3VGdHjOgekiOK+kh6TLABjz1FrlKzIn5dafIp4JRMlXvSEcfLFMsJ3GP+HIQo9y4B3bhEKIMZXUwp5SK16KSd6xuqbFtjmT5fN41CwQHOH/aT46QowRyL2YzChbdULFb2Ac9Bc23uLhpKY5XOUWQSSCGzbA41OgcNo6ZSKQ0liDKZJt0D0dXjFhmrWRU43f0SmHlZWH6WyNJ/Rdy9zZB+YhZt8eCTqoKP4XeFrJuVsMpIeEhi8+RV/F0HvgBYyNJt7G5jdxu7Xxm7qw9rdFc9ZejTX4c+l0aiJ7SOi+ca9HHsPcaKelDAr8GQOwIKqSDSz+8uENgflaHx6suM2sVviI9CKV9j/nhhj3B/RPBjYayWLYhB1mOQgLC3So+Y7yXHrKigquH6aq+sG2k4qNkAEakHF3NbCgmVudKELsDviNQqb34sxFR+4g4V/IYMSKuaNA59/xZJbpHkthptq9F3U422SHIbu9vY/WvG7r1IcsEVR0uFk3yZ59LNg6dVz0laKTBgdQ8ZgrGpVtEKERMLjBW1kUM0GvRH/fF+onZTuZs+Gx6OB8mzgdzb7+/3R7uD/ahZ66+WcbwIsnZMNewd7MgqBoj7BBxXGjiXL6xN29t/UK9TY0prlHoWuBk6h0qvF9hxcLjhdYa14hdp5jVC8i0MaZY6opyGsTmNdfVYDJBigrxoBFKVBl/kSjpXoOLgNCLTuebgJSlA183j43EBUUKgLF9vVatok2RlSm+nkAkyS6jZwrE0hFRjwnygwAh2guz8DdFpY0v90UhenJHEr0licfIlUYoCfYHc9zbt756a8BpPnAcD37HRG7odaeAAaAhCzlrgzi0+3+LzbY3f1vjvo8Zv8fk2drex+9eM3T+Azys0dDc+x4CvxucY2+mJBZZ6Rc71P4fpHCoVB+zewiZJ6Xi7ucbgjCvgSsTQzHpOIpIOPkXd5TmiuD4u1A3HiOgEAaPDwFj7vNYN7AU73XbkTHfqEw3GfuYDWyMoaUP+oYMCIdZoQDikxgt0WMNO06oh4zHxoG+Widy1PhN2L2Ujczbk3JbIcUxmR8DhK4fi22Bxhm7iR8+jO+xAa/JBrkuX3f7nsgRCd8iySX33robxApyuiEgiXC8PuZ0T9A6rrx11W5YTatfWzwK9oWED8VxJh74gvMH46ed3F0/EhAAnB3zpCesqTR0CQuYtXIQT2nG9m0+TuMY4W06mzPhx630JBZAYZxBYvDfnSomr6jTO/Fdk+jOkZlYpTVKcDWjW9U+L04Lqk8qoCK6cFNSp6UJDXdma94QLHncGjTNHnfcmFi815SFNhZvGVCJyoyeuZrVcsiHXY5n4oaYWB2oxU/NPVrgIqr1KwvmbBFFMJGTmWVuPXjzQixv0qI3CHaK6ygNpouKj/ZYrqa32aD5a9GKi1+bjvXnHBxnb00RIXsKjGGapOBXJ1Fqv/iYEuQ6FwdWkRBQ9mi0+PRlzRMSDXoOlOCwZazpTyvytHXFlaGKB2kwaQvIDWxYx/wGdcyo+tGTm21cooTQytYl/NM+0YEwLxiEH+Ir/6jwkmKWDf5CB80BwgBdL+3MmqBht5L1Aa2NWZ/JdnkOlIQGrTMXPjsLF0TLBVb8EP6DRizFIwwStF+/9cC0qWlSmWsqqNwVWNbjOb2ZRHVf0FvhdbEpRxfyzyUsSHy/3Tt6YbP6ts/QdmeTPk3f/Txlvm2m+x0xTgV3agzxbHtk/qduSlSP23+qEO3p1+DfL2T7ozlH1vAKI65uHtLs9VfiLp5wcGMijTeLGj2FTk9AskwWFEaeRZKoVbzvMlCwIbO6QK9ucQ3/mLOUbNJdMaOIwBnnCAwTLkc5AjzfG65UlR2hAsuRIdO1L7n1orWSKNlZ1xDt0ggYtgqMukI524NlvtmoHz+EKb8mTxMvau4Dy8rw0dNQZbJe5kPDhB1ww1T4pQ6ZEU2hUrQvLWHMxq04b5NskAn/hoFzu34xpRxvNcsPTHlgLjuar7WyonqxIbQG1WgtBzlTGoUDjVr5beYA23DumT1eoD0WaV3S6fLnCL6cXaxRBzHjIhX7fukm3muS7NBZEqB8L7jPs9Du9mPsT3Ke2Dp1zg/jJ8nuf+oA7J+TWB0Utj7xZ7un/t78jqsob9SXdGe2okQxl6JNCa3oVbWhNeSuJm1O0O1PqZDHu5oY2X6hbu6XbWIg6+6vrZSNGV6AfNmG4m/2oqPmvdv3jizlX7arLX3+dQf1hmBE2du4de91ott++oS2uaFR9N5SHfQMnP+Mm/T2K3uMfLuws+Bd9XET3b6J6Fw5jAt0aHm1CB9UPEvP29t/c6vMe +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/entitlements.tag.mdx b/docs/api/beta/entitlements.tag.mdx new file mode 100644 index 000000000..2faf1fb48 --- /dev/null +++ b/docs/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/docs/api/beta/export-form-definitions-by-tenant.api.mdx b/docs/api/beta/export-form-definitions-by-tenant.api.mdx new file mode 100644 index 000000000..02e8ac19f --- /dev/null +++ b/docs/api/beta/export-form-definitions-by-tenant.api.mdx @@ -0,0 +1,91 @@ +--- +id: export-form-definitions-by-tenant +sidebar_label: List form definitions by tenant. +hide_title: true +hide_table_of_contents: true +api: eJztPNl22ziWv4LDfqgkR5KXrOWXOYotJ+qWLZcll2fGzklBJCShQoEKQcZR++Tf+94LgJuoJal4kp6WHxKKuADuvgAg7r2ET7R3dOMdpzqJZuw0imfae9fwAqH9WM4TGSnvyDuP2JzHfCYSEWsWi4+pjEXQ8hpeNBcxR6huAHDi8zyKExzkRIylktigXy+GQnGVAHQ+CMx57yn4Ab2i8VgLbJY418dUxAuvikGfYG7VreqqRExEzPRc+HK8kGrCkqlgZhD4j36NZawTQFSnYcLGMVCGb0diIpXCHhbMj8JQ+DhFiw3ht064CngcML1QCf/MDA4jETCp2M3vT1n7ossGDug4680uMsLePZomyVwf7e0F4pMIkT8tzWU4j6RKWn4025OB2uNzuecma+ZYNHMG/W3OAVlgrZo0DR36cetWDXNSP/EwFUyiPPwIhhlxLYIGU1ECwpoI9xsmIVqlCsRnpDBONOMJ20fxaX8qZtw7uveSxRxlIQ13oWkMUuSJefXiGQlkzAEN72i/4X1uTqKmFZ8RjfelAeLns3koCMIpiXc05qEWK7pkOhDKmdygAj0EWaMBM/5ZztIZU+lsBK0gYsMYzZIIHpM0VihGzjT0CAXJ0udh+O8i+u6YyQTljRI2tEsSMLOSYcREhEi1sc6vES+wryfUJJl6R4fPQYAzqdzv/YLwqa0oSxJLSfoEslb+rk8m/rEMySusVYBTArJWjUQ6yf9MsjOUFEWHKnvq3qJ0dDpHNwnogRCMu4KhojtsBpGGoLFotMa1RrE+whGePEFWPXlyxJ6Ijw02SRpM3zWAwCemtcCq1UB+LDjMuxpgFgWkVXUQdfqkEyTKK0v31AqzqBMkaBiJ3XqzBdI9u/W8DVqSj5PpiUa+bdKTAQD95FqCdFR1ZGDebachIB5SiAYr0N5gVsANlgtyrdgyszYMLvN/YJm9JMdNgss6vkNAPYckQGic/nB/H/8ri+uSXDPoPPgvTREc1QOdms0gWDT6E1io2WjBEkolyMHhz8FF8zhSY4m0+BE4N0gzYAI+n4fSp7xk70+Ns9wvM4HHMUflkYmY6cJ7MxtmKzEKOJEGd/sansrvZbBM0pWSoJpskkpQrgCQKoSpCnHopnPu7tu/Zs0/7g86rLW+UvbVPUHxmaYqludoki5hWofVmbHYDRPjcDhZaZLqnKfleX7RRf2tnbUIsAGDkwIkIBLdKQh1SwIzI9Qh1scOQ2g2uRXG3JPO+bA7/B9Wau6SSBNUHgHZBubPDhBz55yE7O0KvLF3E/EowK6cqkgpNiGJa5TP6p00qZCTMTCc2PLd1Q4V7UtjyYYIZM79D5CRwvuJTKbpiDxl5jf39LyJqOm9IJpxSUKWSSiKQkFa0eZfL5bp7Vmv4bxE7vGrSs2up0KB444xCVxosHt0JOh5ELJBfTAIgBMFZwGcShPMHbOhtIg/SV+YfBJTS2iCTJqCixkOfLefxjFwPlxYRGTSKjqZbXXxiqgtKCO7Vdf9y3+c9vrXrAxwHcUfxhAdIIT0ry6PO5XmQZTGvijoqhsGXpkOZaUtNG9U2r+I0V9W6UyKRZH/++i2YYmXj+1iUnH2HAhH6qp5mqw2AtJTiTB5nY76ahIDq+lNqTA/AU02tKxR0O2kkWcpbvYHkUFjjb0UQh7OX/Lig+Fl9/wNWwE2cNM5+zDgZaOw77YwiS0nq1P9kI9EuCJOb2IxvTrYwMQeTbBVjKbx1oXntqujgwWMLn2moZjmsV2WeCRb4LJMKQ4VBCEDuSroYIOJxG89Nq7T54qNBJtzrSkPL3pbpBjcM2bnkNoFxEcesjCaSP9rEoEHsdyKaDeY8GlmuNaKO6GYgfXo1YashLb5/4wJC/2Vdnpa6Fuw1gcyTTvRcKWFdnKAPKQNO/89ZJXWoficQEv/zZteZ6ktmoDOmX7ty067rm8bfN2tets9gYyq2v5WBsCIW3Xxtn++NPjFNFIwdues3e1V2zqgBCG4kk6vc7yE8UBgjXerTtrDpUFPQOex3/Gw219CZ2BKw1t13O9dnZ0Pqu1QhaYzpQvOCQmHn4Y7+GAZAY+GYngg4uB/IgSjPCEND4gf/SZk4MlOW/Z1dop1Ii+giLL3TQ2GlVfgDPWiqJ9Vl+OZqq0Qf7Lp750bBCuGijnBebxVNmzRyWrAJW+8069t9IvKpQ+iJrkeCn+qoJQOGTSXPUeQi2e9svxDUPYCNi8Dqslr3N7ArN0X0Ps9A2fk80qT39wXhjMux7vs/HbVveyc0LLD9/f4S2jpAS5hP0h0sXNtEVWyQGIDy7GLlDU8Pq5G0TwG2xjOQyhbaOlokcdhrukZKh45lxRKNEZqEXOf1qvugL5qlVNd4ZnHQmNXk38W43lraaElTkPRt2ufa4i4BLAeUsFDB11K+trnJ2wTcFsFt6p/uRGuHxc8MAwMv/qXZadp3m7MDr87VkWFuCxyDhQCObkmxaDmNTmFpjKtPqBT/iOMZiDReQEO+RxqhSaXJYIW6yagImGIeZ4AVaHqOxZjAVWyqaV5Iallj0YL+4REPWZR7NpdJvOIlgELbok2R84vroZljg0y9Cn1Ar/b65x1zldCOaMrLOrgoBhHTceywN3LbZZ2vidy5YXWTEIgbiOvGt9K71mTSVs0Z73QlNeh1SjAGzFLI3JVXTo0IkNh+r6YJy32NrrDlZbGV01qqWzcqsK8lSl5Wfj0SmXKYbb6Yglzg0/S1ht8W9yyyxRf3C73Rnd0HM1gaKkjVeuROr+xLcA7H1MeasaGU1xMykCy7SD7ztqe5RFt8vJ4AlEUyyaBY8hkAZNCFrLFpOdR8j3mBZeQz3zc32ZmAEkgAK6bWAse03pcURkjeC3Y3VSQR5EJxhQzEEI5lp/3h++3wwM44FBBb7JNl67ywxTU4StRl7SPKwy7uVo4OyKctUV6OwwAaYcEppVbqddsnizMHNt1QNUwfQbX28AP6ITBNSYF7Hgq/A86kxK3CwHuFAJlDlxF1KjTkW11a3u0Y0ivWobDGVuR21yLJuQUGtD55ES9HYZAUY4k8G2rTh0VbCBKAMT3J2k77FBIFsFC/Or8Bj+oEjzu4xMZAzx0z+0veuic2V/0MLi2v+ih437BQzn6/bZN4Nt5vJ3H23m8ncd7cI9XOlxWqIBIw+ormNIcvzs4ynLzLYN6ILOIb40gO4aHbOEJLoQbct0g73vdwXDtSFSQVUdTjGp+ZKRlaWYuNfVENiLl7cuorSy4WitKj2xAm5NvN+TaGm0NH5ADt+p1v9/rtM9XwLyOolBwtbxR0/AKjKbwVi7bGp5tsOP/xZ2d/0ud2CnF1kpRdAFZc+YDlu3/NR6PZRC60E1lHcqlYkdNIMCLmtqQOjzA6l+Jyg3rf5e0vINbL+MxnnxYvdJjAdYs0XUIgs3jKEh9c7aK58t0y4t0ZsR6zzq060EGBhUBOpImQARR9uC1W6YEhRZMoIx4ft4NVMksUI7CyP/QosX2QlbXySZ/KwPB2InUfAS8YIUlZjS1t/3ruk6DaXTHWEfV9TnpDtqve7Vz2VlWTtc5X9XTTLVqSrtuXdfx0uzg36r+Ba7ut3t1QP25WUkFgq9en3WH7886g0H7Te2Ag3Q0k8mZ0Bq0M+sAUbd72j1u0w7Cyl4QceXYnqrDDYfh+5POafuqN3z/e7t3VT+dSE7MCUOyl6q7kBMVxcYI52k8j7QxP+vdUebo29/SURQrGHTr5/bBMg4XYy17ELzEg/xFkUbaAqugXw4Kdu6NIWGnl/85elna/8zdX2n7s+wI2/FIJjGPF2zG565cw6BNrhW6pObbGTYqxqJ87Ja3HF7KbjgoUNFzp0eqWlvr6RHoF3Cz2KlysMP3QQ7oti/FLPokCpv7W4xuAGHkFQcOXh0c7L94cfjri6dPD168evESQ2jNVu4DRlbDgA2xtWND6sPs72W4bLHDV9jRQ1UzB7xryhnT4FbL8aRN3RlIdse1OyVekvrh/uHT5v7L5sHh8HD/6ODZ0fOXrZfPnr168b9e4WMRHLaZSDoCvm7p3GKDGLuT6Mson9kWh3PIIVtZi3g21sNh7pB68HNDl/ZgPO3ciHC86auKAcJgOitibY9tWfD6j3peVTNW2++L+Wt4z+oO47cVE3EMSRiV9Wbf9yMUGJBG+nSyFXn/tSftVzov8IfhcRSITbSf5JCoUSZMFM/sL5/ltzzvIDE2rjg9yz4EwbO+hlr3lQKzY5tlgI3uF7JTHtZkwD167+azJ4KZeVvSXaGaV4NNh/ZMNzwfSE/9WE5kzbG9XqGVTSP8jAhCl5YY4k2ViEk55hhkbAZFtCq3VVvCzMbQrXCzGKHBiM81h1Px0IxjBveTFKo/BHRrREYElvMlJCgsm7qXgDZgg/N4WUDZYKc8AX8DcOZh706MvEooOnN6hhYKZXyqK7q65mu6kuXmfZFFMeAFuHeDTVo/dJAnXm6zB9vYLE+TaRTLf5rsYme5O8vdWe4Pt9yn21huqkWMyyUzqTUtj+yMd2e8O+P90cZ7+GsNe6MI6nq1cBmy/ioTLRrKNhaynWWUbbt6ZM+1ufmK2mA4zXxsNpclVDQTb12I8ejoQMT4CV1nC83YOZCdA/mxDqRs9hXyMkN3RLpa1/ViafVTtxKZv/rB/lMxfrUvXvBnh8/F6MXo4GAUjEb7z1/6wejZJrKLjubbiScP9XxFMS+d1WpjtUZmu6Ri5xP+c33CT5FU0KofaBN+24+fs1yBgeJxLPy+KMVLd248PT+ilcQjyDKQ+Hf4YctMQGmPd21NhLlRC2G9PfqsN18t1XvmKi4PZ0HDNxdupTF+V+XuMLk3l2l8afG5bEl70YCK7oi5IzDTpdV9J0NzmVbCyerMBGhgn3gsaSeJuGEu/co3KZA1TmJrR3YnvRdRGtsLPxpoxPb7FHpNR8/U4hdN0C1kamOJPqDrKg6//HVazEAraKlj39rZAJ4BphUSkYR3uVIM0PGa2ZdUI3fGuNBzuDRZH8EO2WvBY3D5SfRBKPbo79fDx2wiFB6OEoH9ZD77IOMCVIQ+DMp2f7ATbcbHUToxxWm7tKxEmSR+5Y/fcQ6EYDfusopz8EuXncGQWIqd8LUJLNvfoMNL/R7TyYBZFOP3wMZC8VzCrWqyExmbr9w0wVgSzTbbzdzRxQt0fSsSf3OjNc1oTRoNb+8pYWFYe+OH9LWUD3EWh8Czj8itb57cjNcsjNecxKA4TRy1ioP5eJrwKC8G+k5q34xHabwmjlfG41ZdT6U/ZeVuzDgupqdRGgasy/xpFGnxX4yh6qAZ3OB1OeKb0brDSZtkEc3D/QJKTTNlUzZTLQi/HhiGMsrER3jJBwXSiIH3DIxJ/kGSBZv/gw78/lGimV7fQGBGyCDyv+JaqArOOGETJ2waH6At/iabQsXCeAQ0kB8wCnCcy588gUW04PfMWLVenYbfoz4YGnxA1XzqNT8yP45yB+dulaMGhM5gwA1jnpbtE8NvZsfCuFZilguzVQ4u44snflSFbwZf15f27n42epHidp4591W4+N5eeoUn+Xn87g/yeDtP8//R09jsGNWtWP0Vlfy1zdeWbOpK0+EBTfc4ka26L5XzJfbiQPOQJ3TQgL5cnNJng7GYC55g7tdAzYpmZIlQLKL5C3vgfUIHHGJz6clI0gcgeI+om5mTwZjEEuWKv3VqPpDF63imXE1Ei11DxaR8EAvWqSAebPsTZEmIDkAyFyhYduKEDUnXbJZCjk93o6UzvMh1k0YEUvupcVxQ7CvheGFO7Ge9nBWjqiEJVDELKD/644G596og+A1zgdzdaig3d+Zlxb8j5FKE9i6ARiVt3zQ2aFtzKsI5VdGAFp6hyGc46w6XRoTBlPkUpRXFkz3bSe8hbPFEhfe0ddDab1K5AO+h4k6g9CoMTudpKwdTCtcStqr6eJ8vr6y5Q9mGCczv90AhTfWdmnrD1Hc3XrW+o9KaKjyoGaaAKALd3+NBMix5vuBrczsm1n2BORmY39a4EsvdPcsPcs9yrYjpwo389mt7Tt2j+063l9juWuSvvhZ5jTTcPdTfKIzdFcU/+oriNbLNL5n+RunuLhauXCy8htn5Tc05s9/ly2oQlt4B7FTwAO9ohRhlurXp+ohCr6VNidIi6JsORnu+ot6yDzjVly//AmQbIsk= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

List form definitions by tenant.

+ + + + + +No parameters required. + +## Request + +

Query Parameters

+ +Returns a list of form definition objects by tenant used by SP-Config + +
Schema
  • Array [
    • object object
    owner object
    usedBy object[]
    + +List of objects using the form definition. Whenever a system uses a form, the API reaches out to the form service to record that the system is currently using it. + +
  • Array [
  • ]
    • formInput object[]
    + +List of form inputs required to create a form-instance object. + +
  • Array [
  • ]
    • formElements object[]
    + +List of nested form elements. + +
  • Array [
    • config object
    + +Config object. + +
  • ]
    • formConditions object[]
    + +Conditional logic that can dynamically modify the form as the recipient is interacting with it. + +
  • Array [
    • rules object[]
    + +List of rules. + +
  • Array [
  • ]
    • effects object[]
    + +List of effects. + +
  • Array [
    • config object
    + +Arbitrary map containing a configuration based on the EffectType. + +
  • ]
  • ]
  • ]
+ +An error with the request occurred + +
Schema
    messages object[]
  • Array [
  • ]
+ +An error with the authorization occurred + +
Schema
    messages object[]
  • Array [
  • ]
+ +An error with the user permissions occurred + +
Schema
    messages object[]
  • Array [
  • ]
+ +Too many requests + +
Schema
    messages object[]
  • Array [
  • ]
+ +An internal server error occurred + +
Schema
    messages object[]
  • Array [
  • ]
\ No newline at end of file diff --git a/docs/api/beta/export-identity-profiles.api.mdx b/docs/api/beta/export-identity-profiles.api.mdx new file mode 100644 index 000000000..dab707b88 --- /dev/null +++ b/docs/api/beta/export-identity-profiles.api.mdx @@ -0,0 +1,115 @@ +--- +id: export-identity-profiles +sidebar_label: Export Identity Profiles +hide_title: true +hide_table_of_contents: true +api: eJztPGtz2za2fwXD/dBWI8qSLD9n7txRZNlV17a8ktzcrptxIRKS0FAkS5BxtB7/93vOAfiQSL+SbLfJ6ksik8DBeb8I4N4KQhHxWAb+wLWOLfExDKJ44Ao/lvHqKgpm0hPKqlsxnyvr+MZKX7Hs3bu65QrlRDJEKABjspCKaUD4v1Sx9OdMphNDM5FJn8ULwWZBtOQxU6Fw5EwKl01X9FyFthP4MzlnSkQfpCMagEbII74UsYgQmXtL4np/JCJawTsf3sCfnlzK2NpE6oJ/ZH6ynIqIBTMWCZV4gF0cwM84ifzGr/5YCHbz8y7rXg3YOOa+yyOX9QLPEw7CYFfZ0u++X8RxqI53dlzxQXjIwYbi0gsD6ccNJ1juSNff4aHcUQYOUJLCsXMSfkDa2TKIBPBCswEGIJmR+CORkQCJzLinRB3kwpehB+S195p1SzkLseTW8b0Vr0KkGdYVcxHBTA1GP9ptw4Ol9OUyWVrHMG/JP+rfBMUVMw5coL8eHurV3AxmMyXK7BzSY0AbOEhCTDzPcBXEFTfYtUq4560KYr2T8YLVSDo1ZHzI59LnsYD5UZDMFwTHCOarEcdnCCNj/+PMd4LEL/N+MGO1OEpEjckYuAqMD4Mw8TQrBav9nz0JYu7ZPZxdQ5aGga8EWwjugvqTHHBghTkswBDvgsQDIxTGMkBycpbJDfjHalonauxOIKvmPnDMBYmBzKTv4DwgQxs9B0EDKowIYQ732YJ/EPAYZETMwfFyGXInriM14DgiARJbCt+Fhf0gRk1RAletEZD/IcpriBNh+4F7idBcwNGAdqJSbL4KDUJ6KpRoGgSe4L5V0BOa+aiugE8lt1gBS8URCMN62FSkU5qSST9RKDJyvSm31MqPwXHqaVNUBf9PZunfNF2AmW3w/AFle5o+RZVRSYjBBtBD9uuY4nnBHb4G1+O5ivRWR7ogUscIoVaTbq12zGrijzrzRU0/Q2aWn4aRDCKIXcU3VkGGlnSZ+IMdOq2jptg/ODzgvCPcI37UnLpH7t5up7PX3p1NrcdkpxD7J2VX8CVoHtxWAnkENJfFOgZof3GhIsGbIh3rZy8TKMgB5AeCAIh1lstnTSr00k5fWg/v0A61M1TI4nazif+tc+8c8hX0iTqBYcH0d0Bfaa9ZymHQtCFJieExQuJh6EmHjH7nd4Xg7ssS5VHEUfYyFktVeK5XKnv7jYTLIAa8ySYANiCJWGqqPgCDpV67FJAy3rQ2l/lZz2LAbw2XzaJgSbyPeTQXcZ6FgcIp4c2eR30Mo9jUC5z3JEfw84T4zgYFjRIJGmzZBjY48wi87xQ7mQwZTm4wPQiVykmiCFgJOUngwz9hoJSceiKPh4OT/uVkMPnldvjmp35vctsbXp4Ozur586vR8HRw3q+z0TX+Ox5ej3rw/2TUvRyfDkcXdXIzk9Hg7Kw/uh1fvxn3RoOryWB4mfIUcSKlET5mATdWt9frj8cpZHhhHoz6/7juj1Mc8PlkAiB/uezd6mULb64nP94OR/iz17246g7OLm8B2KQ/gieI1u1J/3RwOUA84MnZ8Of+6LJ7CSDORsPrK3hUTXjxRY7f+eC03/uld96/HU+6E3xyOZwMTge9LsK/nfQvrs7186vuePx2ODq5vRqeD3q/FJ8QHenqV9dv4P2tWWvQH+frj4a0JrIb/hv3zy5gDP0a/TwAAk7647/fDi4n/bNR15A3HhYW1KyCH5MugssERb/LUoLHgN7fT8+Hb7GqyR2JgQOKL93P0svBSWPNQ7Wdo9Zh83B3z20dtfjhfrO157YPO3t70860vdvmuKSOEZ+xqCtV6PEV+cr15X8csS74ZsjITiA5cSA2gpeEJcHfaLrBgDXgPkE9iQPEyJg7OjzPG86oEtv0BHnCc6MpeLdp5JqVGx5jpcAr2nPhCwpuLPElxErgG7pkNNJhusAmO4rBuNXe7ewREtwdgrHrLKvAy/VVL+HpK+BzHI98cAA+RuASwB6+QG/qYlL+cshtkL/d3LPbh5NW57h5cNw6+Gcx9CM4O5awegVty8ClQqsipHEIafq182fjVdCmN1yJHiQvgQ96ZLcpG3pKbXgSLzByc9TQcZBEToUWrVH6nJFMgNzCk5QDmyF23UguVhA6VAzBcAY1FqMYbOI/ZnBQ+PJpmsijcdyB7j4fGxEVGvoUEuvAXxol09iSeu+KDg3MSNdNI1PA7hbSwUhIRdgMajssziiloQ5QzpEM8Esd4slnLPblXOSPCdSbNuon8nTNLX4Gfm+h9JR8yeB/zPgeUOOzlPO5psB+p1Ix0vmUNkHR/KSCtpqwYpWtVOjg6xTIhL0vrT6vjKbfsvJUB2DijJb4SMygZFmMMrf4bIOgJCzwHNgt4Xn1EmmgmBT7QrjCbTAQKcQGbNgB+XNQVGzYLYQP05wF9+dAne7WKtIttuCKTQW8X3J3XR2NG0wXoyZUpR2U1T5vSJnZwC7d5ZlCsYllbPCoqyy12jKEDgvYdGMgb5rEEIews/y8mz4RM+kDFsAaWjrjIU8hAQfCEAtT3axOdDNdAUtR/K6ZvwjuEPs0scEyy1TGGIs5GbrgzqJiAWqUl2QHluwIpcq1k/BRQSuyAOTwlDvvsZlG/TJdBkGVFwBC1EdTuq2WxbedlDZs6Gu4jTxReFwDN5Uho2UScV+hqIqF7ysL4kwkoKoGmklq8IWkn8ZvlplZ5ldJNS5f5A+KOWP1MrmVQ/0vPXQ1GcInGarVclKCqxC48jiJBTm80ruXV4sL/jxbcGOtQvrrUCM245dVFHCl/LjrEhzuXa1hyP3VevWQNSo3YTy8K3W5utFUArLRir0XK1u3gUMuI/qoA+laBB7XX7GliHlmYbmXLlJ0n6OvZW8JmyRWt7S3M08vViawps/pi5kJMQcH/LC9L/YPmy345TSnzV2Xt/jervbnaQ48KWsAZsKFEYNNfcym0MCnRmqnRpl1ptb9j44glo0EVnCjNBxVyemZdJOr9yPq1w0qw3bmgZME4nqVnkk30zKAZVqUGwXx9HD30BVHtjs9mtp86sxssd/Zt93OrH3Q4W6nvXuI5EVEzWOmupa8c99POH6cwhnVcadgy3pYo1Ikj/FScxxC4gRKIKxyXBRJ2bIHvosFGAU143H11xcK7upKQNoHI0zML4SYVHerAt8rnfEDdkE3CTPgHtFE87ZvGgumXnx4IGXsVPVQe5Do+DHrRxEgbrNR4UOS5jF9IGLTwF1haJE+8EK6n9JMfcT3uWD10usF7gs84ClEE3secYkYCkLZgYkYAz9IF6MffdDRIFM1oXHrqgucaLTYG+6ykaGvZ4jRnt95D7CqTWcdoWvd80inoNmkClCxrDgQfLrfPGp3ZvsdziG7bR3sTY9mfHe3ebR3dISrLyFT4HNRFXTXlz7D/EQ6zAsgGZT/AoZAxqtMQKXFn4rT6zIgGC+MQHpsRqbBl8XiY1yHQP+md8U6B8yDRDSh53y+wQTfvh5XVeMa8BByWlnZH0hLnZP+aff6HHuLpvNq1RFWqfTpQlKhrTigRJXyupyAO0iLlcC0DpPqmoFaA4LAhxcHSv2Xon4XMyYLM8zqFTOKoPPefGpKZDcfY/a9bIhGHfJl7PjwGBLKKfqjNHuvdR10Yfa54WTNfBT+ocG6WZBOc8El5B9TiKKuq78R6e/8YMq6Zx4kMX5yNRszclnkrNyMJ6ljOS8KBY0DMH9eT6BQQj9OZBatMNMWg6KRD+CsObeO3aTANGIpfgyDEkwXP04QYRnGwOsyGStm3BF9kwLH46fjMo9V9Jfk7i40MtQpxRYhT9QL7O7KA/djE2nZiw/CGB9lNNobkTRSMRmPZIoimmxGZeJKDV9/Ndva7tZ2t7b7QtvdfDkyX47NW0p9WuXU59o3rTgMnqXUJyLt8QOWDtJlnRZkHbsCJkX66e0EDBtqdab30mHz5wvmRzqUl5DvZvIwmwPSvQNp6M9lgQgSHzUFM/BEwj0mvHOMdZJIrNotr3YaQAkHCupXpIjgNSO2ChLGgWVR4vu0m0jVmRsI5X8Xm31EDvZAtAekFoVr660I20xym0luo9E2Gn0z0WibSW5td2u7X6ftPplJZliRtZg8SSXLJY9WWtPMe6SWMxiQb+jOTI5EtZmtIDCW5VjWeuZgTdutaWt24IiOyzvu/u7RrO3st/neQeugNe20D6xirL/J7TgzsnWbKshby9F8xog+QB6X+KBcKg4Cd739l+A21Rm6NXQ9Wd4MPG9gxz/LHTsVW3aCGGgDwJA7Ro+0F69H5/rzqwaPfNMfL/M9jvRxEVNK2jxOZ1W2qeM2ddyGn234+WbCzzZ13Nru1na/Ttt9VerYeS517LwidewwTLFmmGL9J1NHV+pTgDMQCu5F02c48Cs9kAK/eLbdp3BSJU301rLI9lHFVpsgYBe4S8QkS2qtE+nn7EL3BmOXODZKx0rcHTcHF+njcUYZ6N0NcikwJ8VNXnRmknbXAW4AN1rZ3RmeuDMnMY2+ZatI3/ES1+wWSze83XGJ+99mmP4BBOqDzsFRf8Eep5HWZ/WD2QgpPkeKGe6TwG2FLOv/7lXtEhgA8hG6i7GW9SPbBXTPnPtQRoiPoXZfWQq6TdW3qfo23G/D/bcR7rep+tZ2t7b7ddruK1J1kw09nqrDgBen6jC20WRZLnVKez//7IydTMVgQOrNAodydTfPwenYODykc1GwyDWk+D2tyt0kXqBlStc/Tjcu2+YMwjGeuUFPVPUOxISJ6zvc1LoUoKdI7Zzuqwk5wrR2Nucoc0LWQnQw79QkJ5EHo9PrDe5BE0ADHho8lI0Ugh/c0R0HU2B/hWfDjazainEA3aagF2iQ7CKJ5qF9KQHXkjR7da3sGoUnIac7lVdQ3zANpo7b942q0mNAMYQ65TtlDvw+0JUhG/QBXdeR9/D5tGhAj9BSxb4nV4PxDDDdINHSu5ZT7RljUq9XL+lQHqjwc0K7tNgQh7XZG8EjqDj0Dpvvf3o7+YEVzhzTlRlCYu0BxngFKkKuspvuNsFJFL3ye4u6a/t50DTZzAOCmbmGJt1LfQkxZAROn1iKkwT5GZz18ss1+Nq8Ry6d+dW3zaEyPI5EYwyJ+mKemzClixfo+lQk/pZCszU0m6DhxR5rWGjW3jh6f7gD/gFBcE8Rtz55cQ3PLsDDAg2eINRNHJATBo/1XVhOKrVPxmMNno3w1vH41X9LJwPXpzHtuZha0M1LA+YsgkCJ/2UMVQfN4GaegBV9Mlp0HNEmi7DbzQJKtl7SljZknYTfORiGr5WJTzHqm4Nr1H8hk/yNJAs2/xvddvHbGs30+AaCM450A+cVN8Zs4IwL2rigrX2AMvjr2IeKBbaNNJAf0ArQy+VPnsAgWvB7GlalVyfwOzQHQ4MDqBIUFR7rP45zB2d+MXqBo7Mx4IYtOiJl9qXhuUED6yE/pquZlbYbNjlYxtcLIO5u8E3jm300xVj8V6MXKe7mXRm8FeBLe+lHPMlfx+/+hzze1tN8i57GpNGobrTsxkEtVPI3Jl8rdwkVXQ8I/8JbslXK2KEeKtyAVAAUejymc6Bo1c5CCuovhILHmPvVUbOCJVmiOYoszCVZc7oVJQKUOVSE0gN41AFPV+ZkMDqxRLni3yrJzs7r4+YN9hZKPt8BsWC5hzuB4d3vgan7xiCZKxQsO0mFzfBqkcQ3tyYkS8ZBpZ7RCFcqJ9GOC6o/X6S8CCj1y2alVoyqhiTQsTsRLdVwNtaXYhUE/8xaIHdl+tZc36Fj7oDLCRkJT58hh3HraftzsEHb7IXwQiw4wetCAiYKK1wMJiWIAMw3H0uCaL5jJqkdHAtAsrvErN1Gq9G0qVzACy4CFUPtVQCuTweWTiiqTT28z1v2/9aLYk2AwcpgJ8RuGaKd6EpFl4Y3Vqk0pO4BFYdQbiyARhx1f49tFayWHvCxvroPS0bgujlqX3XxQpHQr+vy2UrWvRfYqEjv1jWtCIuOar+cD/9dt8Y+wcfsVt1PZOT2Ctiv7wrYJ9Qhvef3E7Vhe4/r593j+oRk8lt1P1E2/+WXsT7B2vzS25y17/LuIoRYvPRDeyyKt3qa/qpRmFX67r/WDD7rY9LDHyk7zQ9c6uHh/wFohC2O +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Export Identity Profiles

+ + + + + +This exports existing identity profiles in the format specified by the sp-config service. + +## Request + +

Query Parameters

+ +List of export objects with identity profiles. + +
Schema
  • Array [
    • self object
    + +Self block for imported/exported object. + +
    object object
    owner objectnullable
    + +The owner of the Identity Profile. + +
    authoritativeSource objectrequired
    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[]
  • Array [
    • transformDefinition object
    + +The seaspray transformation definition. + +
    attributes object
    + +Arbitrary key-value pairs to store any metadata for the object + +
  • ]
    • identityExceptionReportReference objectnullable
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/export-non-employee-records.api.mdx b/docs/api/beta/export-non-employee-records.api.mdx new file mode 100644 index 000000000..6c3bb50ff --- /dev/null +++ b/docs/api/beta/export-non-employee-records.api.mdx @@ -0,0 +1,95 @@ +--- +id: export-non-employee-records +sidebar_label: Exports Non-Employee Records to CSV +hide_title: true +hide_table_of_contents: true +api: eJztW1tz1DgW/iuq3ochVLtvdMjlZadJwlSocNlclodAFWpb3S2wJa9kA72p/Pf9jiS72+mEAEPtDJSruDiWdHTu5zuKfNXRuTC8kFodJ539jvica1O80Oooy1O9FOJUxNokttPtWBGXRhbLzv7lVefCCnOgVSE+F5OyWOBdRyZqX4k02zeCJ5hf/5xxxeei8/b6bbdT8LmlydghqrZgJ3Im4mWcCvbcTc2EKjqYnAgbG5kTc2DtfCEtM+I/pbCFZZwdnP2bJfqTSjVP2EwbxtOUKdAVga5lM6MzzMyN/igTkTCrSxOLHpjLueGZKISxThxJG+QcgnShAg4CAi9G8d5wd7C7vTseicd7XAyGu+NHo2Q0iuPpaDiaYbICFcyUJHCT3TO3FztO2IOLi+PDLUwg5qUR0HNhSgGNxguR8c7+VadY5kTGFkaqeeeaNGWEzbWywtL4aDCg/5o7HDlbQSxoAtRjMgcUR+Rgln5sP9LzShwex7pUxQuw3J1JY/1TysNDvtBKdMGQTLveZKZrC26KQ17gvUro/zfqmVa9s0wWiy7DY5eF5+3t7Sj83e6y91r9jr+9RIuegof1Yp1hvsyq6aPBaBANxtFg+3ywuz8Y4E80pH+7fmQ3GuycD/fWR96o1zJNJc96Bws+m0nsHV50Wf2mycYnP/577IftGi9PhCngAquV38URTHXd7Yxvs85BKmENdmQMXDNip6IojYKx5IwVC1E5MpvqZMng2FJ95KlMek1D8jxPZezCs//eEt2rTa/R0/ciLsipDQVzIb3PJKKAKQ90IjY97KazPpVKRHPDJXEoHMsxFobIwQqWaSOYJ8m0F8HN6zUiBproDdkTBORpkO8gCAM1Qd/xB9CiRHMfQxdKYj2rljDpQ/yObcWO4NPHg73RePZ4zPlodzzc2Z7uzfijR4O97b092j0T1sKn7dre3Bi+3Nj6D6GEkTFLdQyL/BcKQUKD7h0DbnNKboXI7P02cDS+Qv/nkMvPrcUM/DKK5S6S2JODV2y8w1Ku5qV7z+c3lKCiizNKSWWa8im9oiwDyT3hl0bOpbqNFaHKjHLy4dHTycXJOd6cHv3r4ugMT0RrIxFPFLw1IbcEq/CFhf7kOA4CfOKWWZFCHSLpsYeB6kMIxJVdnyj9T3ZpoUz41oyXaYEVYfdbVqyT9sl9PZRiX4/YA9kTvS6b0ruMF/GCTbnFApiQpj+cxLHIi+gkaPIhW6BgCbPVY5MkkSQkTxmiEUSxfglCjCdUPqQnMCsRymAGiUyXBUpOIX1RWdlipcqmNRAEsnAzTtaNQsEBzu/3k0lclGDOibkehbW3BBaDfcCz11yTu/M1pTmVLlXBY0iBCrqEGo2BhtkUsklU2pCOyFwWiUdV8+qMRSmwEsulu+eemcNCu7GYl/Yr4u5VivQTOdHqgY8iBB/cQFd1nKxRmSlkJAyS2G5xXe2DLqrAZzMp0qSN3TZ229j9yti9OXgaMGkYddBnuAl9LhRHT6CNK54b0Mc471GaVZMcvAmG7DIoJECkZ6/PEdgfhKL5aEwIOv9AfORL+Qbzk9oe/v2U4EdtrIYtiEGnRy/BDJlIJPuO7xXHTlFeVY82d3uqzVTCQdUtEBFZ07ClLhmHykypFHHCbRddj7Dqt4ItOPIjUD349RmQdlVJlGupihZJtkiyrUZtNfp1qlGLJNvYbWP354zdLyLJmisXLQEn2TLLuFl6TwvjJC1nmMCq01FWh5wz1U20QsRYjbE6TeTQmY6G0+FsJxbjhI+Tx4/2ZqP48Yhv7wx3htPxaKezXusvV3FcB1kzptbs7e3oVAwQ9xE4rlRwLltonTSP/6BeI2aU1ij11LgZOodK366w43gTO77QBWQDYWBHc8fx4sXpCdHH1o486c2fS1PQOtVhOi8cpCQfhqalLVro2ELHtvy05eeXKT8tdGxjt43dnzN2vwk6ju+DjuNvgI5jRhBrRhDrr4SOCXAHQbMZjAIZ4hLqVQQbc4iCp3D6GMK+4GYuihroNVDkaG8TRZ5rTdculhVYso2TSLVSF6U3zM1obn0NAxM4myNFKoasJYFuyatkJgiTwn9YKjPp4pgEAl2zjCazAlL5mKn8rd5FqjgtwaFLCqmms1cNH5NwJzEj+AcK7hx0jkT9A884g7X+1HkwOyWJT0hidvQ5FoJivj7/3b7tlsAxmDeULs68re+4LuDPzLlCGyE+5z591RC0heotVG/LfVvuf41y30L1Nnbb2P05Y/cboHpAQ3dDdUz4aqiOub0Bq7HUU3Ku/ztid6ESOHDuzXTssHqywuAOV8CViCGgdMohdOl4v9Nfv7gceehu+1cyuW6M2H5147lDF7IJMnpuS5OCyqIocrvf71/BiDDedY/nsofcBjsWS6U/0dXX/hSauyUp0R1UH4A0gU1eHYf+o+fUbiR5tk+Djrg3ghOUfBjGcNcOvkiZbkuTdZeQj3kyXYYoCF7mXoPFHC3Gb9bN7jmv2pAPcl2Y9PrPy+IJ3SHLber74m6Yz8DpDRFJhLer+/NnhMf97hu36Fc1hn4TMNrY7CVNG7Enghs0C/5yzINnr8+32JxQqMsCpSUALCS1DYijV3ARl+Um1UURWuQKj9HlfOEYnzSu4lBUsVkKgdkbdSYEuzwOSniB9H+KfO1USouESxG06u2DyjqJ+ChSqoy9lSbJ8WSi+tBQnzfWbbkq6NoFqfCYube9Nypih5KSk6RqTnOCiK77Y5d5JRdfk+t7mfhHRS3y1CJHzW7d4MKr9jL2V7tjhDaR4Kl12vruzT29aI0e9VZ4Q1Rv8kCaCHw0L1DFldW+m48GvYjoNfl4o14vJEpscxnzGY1ZVMg0YccsXmhtxT8ZI9ehMLicl4ii72brE20auYiIRoM1liK/ZSQjAEbH3wkCQ3ln4lMq2A6vaH904kLynbMsYv4d2umEvWvI7F5foq7SzETH9rt5pg0j2jDyOcAG/n3ZIsdCbJMMLg94BzhY2d9lgsDoWt7ztG7N6o58362h0hCDVUfF5vv+h/1VggtPzA3Q7HoO0nDHfSgSrpTRJzWBFtWuhrKqk4KbGtzkN9UomTf05vmtf99JZfTvJi9JPFkdqLxU6fJHZ+k7MsnfJ+/+RRmvzTS/YqYJCJjczW0bWoV1J38S8NrmAR+dQC8E/sWoi1UHttHKuObMoZh1QnnKC/JqF9XxQgp3NJALXhD265Jn6cxFIrp4Cn80gI7Q3GAOwtYCk/KpTEHPHV5XO3MXMB5Ykl3pZ1uGqxQaLolWU/TYa3RrKoZZqFOjS7wYe69Dy3YGy7wiw7LDytgAXVlWKuxGcVlmjMOl7vGIRNq49IkLjZsSlS60g371qiqKydVIhJ7rWUxmX87o1BkN7Zrh79kLdrfhyBmqJyuGLyBXgpyK1HkmzWvC9vtow9uihUhz6hWRdQHAxNoOz4/PNyiCmAq/59Bm3g+LbJ/mggi1R959HvWGvUHk2gW8z7Ut0N2uEfffUlrW+C41fPtK+vWfWDZc8mp18P5jv00NxcV9xJnTIRexXPouxbeLl53b2kUs3XcfojY2IrarnhFdyAKiE4GrKzoooSbqml6Dc+rCL9+u+iPXV8I09Ix+dYZkIb6gggen4evWLXbLp6+3ylQd76nlqrPv4PGDoAMBiIK2GRy7ExvHjR/wZzprS+rPXanNqvvrP47IX/gdFTs8QGLkpP8Be8g/Kw== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Exports Non-Employee Records to CSV

+ + + + + +This requests a CSV download for all non-employees from a provided source. + +## Request + +

Path Parameters

+ +Exported CSV + +
Schema
    any
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/export-non-employee-source-schema-template.api.mdx b/docs/api/beta/export-non-employee-source-schema-template.api.mdx new file mode 100644 index 000000000..b474a8d02 --- /dev/null +++ b/docs/api/beta/export-non-employee-source-schema-template.api.mdx @@ -0,0 +1,97 @@ +--- +id: export-non-employee-source-schema-template +sidebar_label: Exports Source Schema Template +hide_title: true +hide_table_of_contents: true +api: eJztW1tvGzcW/iuE9qFJoJFsRYljvyycxClcOJf1BXlwApSaoSS2I3JKcuJoDf/3/c4hRxdLjtO02LbBvCQjDnl47uc7NOe6YyvlZNDWHBedg476XFkX3lhzNKtKO1fqzNYuV2f5VM3kucKgDKrT7XiV106Heefg8rpz4ZV7YU1Qn8NhHaYY6+jCHBhVzg6ckkXn483HbifIiadXIJ411MWJHqt8npdKvJZGTtRMmdDB5EL53OmK+AJX51PthVO/1coHL6Qo7JUprSzE2DoRpkpELkVkUzR88mspKmc/6UIVwvOs3gdzGkmJK12WTFc7xXTGtiztlTYT0QgofA4NHXwwUSLvWKIfoIJKOjlTQTnPStDEaCUhfhdalOBAYWCQ7+8+23n25NlwoJ7uS7Wz+2z4eFAMBnk+GuwOxphsQAUzddG5LXaS6rgQDy4ujl8+xITELEwVXK1gB5a4c3DdCfOKyPjgwH7nhjTulK+s8crT+8HODv23vsMRmxuq2a5AbJiTXWET2gH27ef+Ez0vJZR5bmsT3kCK7lg7H59KmR6qqTWqC6K67M7YxK7rg3ThJeh3lSno/w8GDN90O8NtPL4oNRgQR87Bmpk4VaF2BizrMZssuYUY2WIu4CbafJKlLnrrvMuqKnXOft7/xRPd603d2dEvKg9kWkdREXTUXKECuH9hC7Wp59sme6WNyiZOauJQMcs5FiYfJMeaWfhaJClsFIHn9db8Bpro7YrncPHGV18kYaCm4GT+K2hRxN7H0IXRWC+aJUIvg2bLtmpPydHTnf3BcPx0KOXg2XB378lofywfP97Zf7K/T7vPlPcwo1/ZWzon5xtb/6iMcjoXpc1hkf9CIQgd6J4Z4M2xRAc18/fbgGl8hf7PIVecuxAz8SvIfbtIB89fvBPDPVFKM6l5XE5uKcFkF2cUmHVZyhENUaxB8kj4rdMTbbaxokw9owz38ujV4cXJOUZOj/5zcXSGJ6K1kdYODby1ILcEq/CFqb1ijpMAV9IjDZVQhyp64lGi+ggCSeNXJ+r4y889lAnfGsu6DFiRdt+yYpW0GDs7WwulPOZy8UD3VK8rRjQ2kyGfipH0WAAT0vRHh3muqpCdJE0+ElOkRuUe9sRhUWgSUpYC0QiiWD8HISELSsQ6EhjXCGUwo8PU1kEYGzTS85otlqpctwaCQAeecbJqFAoOcH6/nxzmoQZzLOZqFC68JbGY7AOeo+bWuTtfURqrdG6CzCGFLMs51OgcNCxGkE2jbqV0RObySDymmbfIWJQCG7E43b2OzLwMlt/lsvZfEXfvSqSfjEVbvPikUvDBDWxTEckajZlSRsJLEpsXL+pm0kUT+GKsVVm0sdvGbhu7Xxm7t1+eJmSW3jL02d2EPhdGAk9bx8VzA/o49h5jRTOJ4U0yZFdAIQki/fT+HIH9qzI0HwifAOSfiI9iKd9g/nBhjzg+IvixMNaaLYhB1mOUYIxMpIoD5nvJMSsqqurx5m6vrBtpOKjZAhGRNZ2Y21pIqMzVxhAn0nfRRyhvfghiKpEfAWTBb8yAtKspsspqE1ok2SLJthq11ej7qUYtkmxjt43df2bsfhFJLrjiaEk4ydezmXTz6GnpPUkrBSaI5oxQLEKOTXUbrRAxscBYnXXk0BkNdke7471cDQs5LJ4+3h8P8qcD+WRvd293NBzsdVZr/eUyjhdBth5TK/aOdmQVA8R9Ao6rDZzLB2uL9eM/qNepMaU1Sj0L3AydQ6Ufl9hxuIkd39gA2UAY2NHdcbx4cXpC9LE1kye9xSNTClpWHabLwJCSfBia1j600LGFjm35acvPd1N+WujYxm4bu//M2P1d0HF4H3Qc/g7oOBQEscYEsf5K6FgAdxA0G8MokCGvoV5DsLGCKHhKp48p7IN0ExUWQG8NRQ72N1HkubV0iWHegCW/dhJpluqi9Ia5M5q7uNSACVJMkCKNQNbSQLfkVXqmCJPSXYZSzzTHMQkEum6eHY4DpIox0/jbYhdt8rIGh5wUSktnrxY+puFOakzwDxT4HHSCRP0nnnEma/2h82BxShKfkMTi6HOuFMX84vz3ybZbAsdg3lG6OIu2vuO6QDwzlwZthPpcxfS1gKAtVG+helvu23L/fZT7Fqq3sdvG7j8zdn8HVE9o6G6ojglfDdUxt7cjFljqFTnX/x2xc6gkDti9hc0ZqxdLDM64Aq5EDAGlUw6hq7cHnb6xJlPpenEWobvvX+viph/xWyYD3AR2Uh45L95z7TcXijt0s5nwY2S9diVITkOo/EG/fw2LwpI3PVnpHhIdjBrmxl71cjvrj6DGLRmKLqTGaKQJ4vDdcWpGemwDp8nNY05k4tEiLDU5NCzDdxC+SJkuEJOp5xBWRDJdgZBILsfDYLFCv/GD59k9drEN+SDXhStv/rgskdAdsmxT3xd3w3wBTm+JSCJ8XF5E55vLcfeN6+jLgkN/FhhsbPaWpg3EcyUdOod4U+bBT+/PH4oJQVJOCbUnNKw09RAIqndwEU55h82tEVrEVcjZejJlxg/X7uVQiIlxCYHFB3OmlLg8Tkp4g1pwiuTNKqVFivMFrfr4oLFOoT6pkspkb6lJcjxdmD401Jdr6x5ySeTeQRs8zni098Fk4qWmTKWptNOcJCK3guKyauSSK3J9KxP/aqhlkVrG1PzDW1xE1V7m8Z53jjgnErL0rK1v3jzSy1boUaOFEaJ6mwfSROJj/TZV3ljtm/lYo5cRvXU+Ppj3U416u75MxPQmPMplWYhjkU+t9erfQpDrUBhcTmpE0TezdUWbZhwR2WBnhaUsbpnpDOiR+TtBYJjoTHJE1ZvBi43nKBySP7NlEfM/o7cuxM9rMvPwJYoszSxs7r+ZZ9owow2zmAN84j/WMHIsxDbJwHkgOsCLpf05EyRGV/JepLU1qzP5Pq+h0kCfgjAVXx3EHwfLBJee4gcjNHsxB2m4wx9KpPtl+C0SLSpka8pqjg1ua3CT39Kift7SW+R38cdPqql/N3lJ4sPl6cpbU87/7Cx9Ryb5++TdvyjjtZnme8w0CQ6Tu/G2qW9YdfLnCa9tnvZ5/u4N/+Itxyojb/Q13KkxilklRGiZvJqjOp9qxecElZKBsF+XPMvOOBLR0lP4oxtkQhOHOQhbD0wqR7oEPT7JbnaWHDARWJJd6bev070KC5dE36l64j1aN5PDLNS20Y1evPvFpv7tDJZ5R4YVLxtjA3TNZrWh7/jAdj0TEi51j0cU2ud1TFzo4oxqdGEZ+i1WNVFMrkYi9LiBcTP/dkxH0OhuVwx/z16wu0/nz1A9WTF9FLgU5FSV7Jk0bx2230cb3pZNVVlR44isCwCmVnZ4fXy+QRHETPqjh3WTflrk+zQXRKg9iu7zuLfb28m4XcB4ZX1Aq7tCPH5e6O/+unDNG6+XB/B/zy8+U33i7yArOjQjqevY6MT287Kzrf3E0gP+vPPuDpR00fSg6GqmUCVRu76mUxhqym5oGDJQi3/5cdlvcZ8KU9MzmuExko/6gl4fnKYPSB+KLV+XbhWwOTs08+WxQQePvyo6bYBc6MnBMR8HMTfxRTwwWlmy+HyU2rZF8/7jEfmfvAMBpAdIjBz3P5IxOyg= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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' + +## Request + +

Path Parameters

+ +Exported Source Schema Template + +
Schema
    any
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/export-outliers-zip.api.mdx b/docs/api/beta/export-outliers-zip.api.mdx new file mode 100644 index 000000000..a13a2213a --- /dev/null +++ b/docs/api/beta/export-outliers-zip.api.mdx @@ -0,0 +1,88 @@ +--- +id: export-outliers-zip +sidebar_label: IAI Identity Outliers Export +hide_title: true +hide_table_of_contents: true +api: eJztW21z27gR/isYdqZ5GVGyFSeu/aWj2M6Nbpxz6pdmWsfTQCQkISEBHkDGUTz+7312QVKSZcepL23vMsqH2AQXi33HszB4FdlCOVlqa4ZptBupz4V15VFVZlo5/09dRJ2olBMf7Z5Hw8FQNG+ii06UKp84XdBczDydai8Gb4YisPBCikz7Utix0BNjnUqFrSeL0uLt3snfhfTiUmUZ/WyIjTXxnRO64nSqvBLlpaVHzNaYPVLiiy4KTJAmrdfHw57NqtzUNNokWZWqXaFTZUpdzob7HVHOCtURY+18ua9KlZAq+7LEWIb/VwZrsTriz0KWpdOjCkTicarG2mA9r4K29QILNE/emWP1a6UdyGVVTq3TX9jmwiewP816pKXebfSNc2nkROVgtOuUTB/BC4V0Moc8jnxxFRk8wOqkAV5q8sCvlXKzaMUvs7BAOVVz0VrDeiMLP7UlWXisM7AXmNWJXBAXITGWmVedyCdTlcto9yosuRt5KGcmIFWmyik8Do/e/utk+Hp4ODgenv4DL05Oj8/2Ts+OB4fRxfX1BTH1hTVeeWLT39igH8vCnlRJolSq0q44VmXl4D14lsTvB39DzNRemsxKkGxyDI2tW40wCoRNfnVbPEG4xJoSxiARZFFkOmF/9LAaDd2tLVjmEtOikTYS5r7Gv060dZsye1jLlOLAOYgR1wpBCh2cQSZGjImRTWcCuaPNJ5nptHu3cB888b1FOjv6gDilIHGUzqUOJk5VKXW2Z1N1mybLwr5CCMcTJzmSFYucYKIAx086xQyRw4QisGziielIYPVZ5kVG7GGJ7qZ4KVNxXOu3VysDM5VOJh/Bi0rNfQKdGY35opmC2GV33rGs2lZy9GJjp781frElZf8vW5vbz0c7Y/ns2cbO850dWj1X3iOr/MLa0jm5mjI/KaOcTkRmE3jkCwyCJITtWQBenFKuVLm/3wfM4xvsj7oW1lOtmrW8olSfyw7q38u9N2JrG6XJTCoel5MbRjDx2QlGTJVlckRDpasUNA+Mj5yeaPO1FN4/eDU4OzzFyPHB384OTvAb8Vqp9QODaE0pLCEqYmFqL1niWoFLlHOvMpiDEvlpzfUpFJJI6AVCHZ78zMOYiK2xrLISM+rVb5mxyFqMnc2XUonz5nMpHuuu6nawL2AM2ZpMxUh6yn/D5E8HqDJFGR/Wlnwqpiiyyj3pikGaalJSZgLZCKaYP6MNRqYppW5gMK6QyhBGo5RXJUpMqRO17Iu5KZe9gSTQJVMcLjqFkgOS3x8ng6SsIByruZiFbbTUItb+gczBcsvSnS4YjU06M6XETgfKbAYzOgcLC+xdQmMnr8sRucuj8JiGrq1YVAIbtbjcvQ7C7JeW3yWy8t+Qd28ylJ+YVWtffFJ18nHtD9WIvdG4qa5IeElq8+SaqnVXk/jY4VSWrnN3nbvr3P3G3L358riGcPVbhj6bq9DnzDQwF0qsQB/H0WPsDSwcHNkRhOeCdX5+e4rE/qgM0QPXEyL9jvgobOUrwg9af4TxEcGP1llLviAB2Y5BgzEqkUp3We65xGyoYKpnq6u9sm6kEaDmFoiIqunEzFZCwmSuMoYkkb4DDKy8eVSKqUR9lMgI70MFpFVNGhdWm3KNJNdIcr0brXejH2c3WiPJde6uc/ePmbtfRZKtVJwtNU7yVZ7TERtHWv2etJUCBKI5TBRtyrGrbqIVYiZajBUtI4do1N8cbY63E7WVyq30xbOdcT950ZfPtze3N0db/e1oca8/n+dxm2TLObXg7+BHNjFA3CfguMoguHxpbbp8/AfzOjWmssbH3A1uhs1h0osWO/Z3VrHjqbXitTSzBiH5JQxp5jaimgbanGhdQwsCKSaoi0agVGnIRaGkcwUuDkEjMp1rTl7SAnzdLB6M6Yg4JEoTZO0q9Rm750qQWULNFoGloaQaE+YDB0awE1Tn74hOaxf9JiQvjknjQ9JYHHwOh9CiRe7PbzvfHUJ4RzXiJDj4joPe0O1IgwBAQxBqVos71/h8jc/Xe/x6j/8x9vg1Pl/n7jp3/5i5+x/g8xoN3Y3PQfDN+By03Q3RYqlXFFz/c5jOqVJLwOEtbJJUjo+bGwzOuAKhRAJNFNcQWU7x0GuuFfTC1RO8CZA/CFO5DETTsiz8bq93BR/BN9ddWehucx/D2MtuYvPeCIa5pebQ5YCQX0TAl2zCAl22qtMUuKHKMfNgY9aDQhS25vPgr3Km+yTkvJmtUNeYDd+PqYOIhyFigQ7ikWfqLgfNin7Q68xl179dl8DoDl1uM99XVwO9gKQ3VCQVLshdcDYYsb/OIM9eKFGDihx8frFIc0KQPEi4QjnfZqiN668IdERkffFSSYd+Ifxl4/HPb0+fiAkBUS4ElScMrDR1DkilNwgjLnSD5pSfJvHe42w1mbJyg6W/o1BiiXEGo4h35kQpcT6sDfULdoBjlGw2O01SXCVo1sXjxoOp+qQy2hy7c2tTcOrU9GDFnlya94Q3Qu4YtAmXYzDafWdisa9duD3lmaZWkRtAcV40eskFvR4qxJ8abnHgFjM3una1JEUw7XkS7uUkyG5iITPP1nrw4oFfvMCP2iuMENebMpAlajmW//qVNF57sBxL/GLityzHO/N2qrHLLk8ToagJj00yS8VQJFNrvfqrEBQ6lCrnkwqZ9mCxLmnRmDMi7m8siBSHJWMdAzOyfIdIDBOCSY5oz2bIQjfTTBrS9j17FnXhPV/xer+kMw+fY2slytQm/sEy04IxLRiHOuFr+cPORYFFV8GgA9eBEAB7c/9zJagFXaiNgdetlZ/Z93gObR90K5C5+GI3POzOi2D9W7g7SNQtDUo1Qe7274F4FjUv2r6WjNUcFty04Kq8mcWuecNuQd72sIp20t+bvqTxYH6mcmSy2feu0ndUkt9P3f0/Vbx1pfkRK00NginceNm6W1gM8pc1pls946NDaL66jbecq4y30c1wf8YoZpFRkcmSopqzOplqxacDhZIl4cMORZbNORPRyFP6Kx8YTRxokLYeuFWOdAZ+zaVxXllywgTwSX6lZ19xi0JrJVN0m6or3qJhMwncQs0a3cDAuw+27tpO4Jk35Fix3zgboCvPK0N3qyF2lQuJkLonIlLtkyoULvRuRjW2sAz92llNFlOokQpdbltc7o/GdPCMnnbB8fesBb83l59hevJifY98rsixyjgyiW4Z2t/HG9EWT1VWULuIqgsAphZWeD08XeEIZsZDL7Tl1k169STfI1owoRYqhM+z7mZ3I+aWAuOF9SUa3AXm9GlCEz7tNwrioGnHlmLxan7ovv5o4b/80UK90VKH1CvozI/cV4WuLnTP59HCpfy6f0a3NYWL6eXVFZ0JUUN5TcPhEwfq0hB0VAnmHyjc7eMHfQBxq+QfFZ121N9c1McZUUTdYdO5crcI8fmkigUNc8JZ1sKsmx8dEJP2eOGnA8T/9b8BRrMiTw== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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' + +## Request + +

Query Parameters

+ +Succeeded. Returns zip of 2 CSVs to download. 1 CSV for ignored outliers and 1 for non-ignored outliers + +
Schema
    + +string + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/export-role-mining-potential-role-async.api.mdx b/docs/api/beta/export-role-mining-potential-role-async.api.mdx new file mode 100644 index 000000000..a6189e113 --- /dev/null +++ b/docs/api/beta/export-role-mining-potential-role-async.api.mdx @@ -0,0 +1,79 @@ +--- +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: eJztG2tz0zr2r2i8Hy4wdV5NH+mXndCWO2Xgtpu2w4fSWWRbSQSO5JXsltDJf99zjuTETtIHvezuhQ3MgGNJR+f9snQX6EwYnkutTpLgIBBfM23ygU7Fe6mkGp3pXKhc8hRf9e1UxcFWkPORDQ6ugpP+CcP3zM0NrreCRNjYyAzhAbSLsbRMqCTTUuWsyFLNE8t4mrJ8LJhUQ20mtDeDJ8ZZVu7GDIKVCt7R04Q2YFZYi7Nzzc63GQdQLNG3CsHyCKZ9kxnjJh7LG9Fg7ETFaQEIMZkg1FzCI1cJox+pmMD/FvdAXOo7N4DIjBs+EbkwSOpdIJGejOdjGFIwAL88NsC3rcDGYzHhwcFdkE8zGswNsmS2FRjxr0IaAdzNTSFWWSTWkigRqvjKJ1mK4Pbjdq8ldvfC/T3Ow65IeiHvtaIw6SU7293uTmd7GMFma/HMqjL8c9j2V0SU3CulGv6dvf3tnR7fDVvdaC/s7u72wl53dz/sdbrxcGe/1dvt8mB27fYXNn+tkyniF2uF++Ejz7JUxqQuzc8W0blbJURHn0Wco/gMKjbKHEcBs+OF1M90VqTcyHxaWQkaKkbCBOsEhIRNigkQXy5kfKKB1IpmeUUiRtyOZTwGXauqGpsUNmdjfiNQfSPUblLPZL5SoOlVudYCefhZh3oCG/bjGHhbQTrSsB1XK0ifDNmQp1ZsgX0wpfNys7ru52Oeg70INpajcTotyfO0IU44Hca1GQEHvhHvqwiiisxmlRcPcbp1DzEEBJwKrgHU7/E9x84xOe0IZrMZ6arNtLJOxJ1WB/+r8+Gtjth5EU1knoukwQYiL4xCt+GYfZI4HsQgKpBIYUEaIJzSpxAL0KdoFQsWa6QxF8CAJ2sluLrTIfmPjX7+X+nn1mMSd4EWY+6yE94KXFiEN0VBYWCJd0dzRTViKIxA5cwp0n5dllDQinfjJNrbDdudDvhdzochH3baYbvXSaJkGA15q4tu3+Y8L+yqAaF2uTGmh/fu8o/L48vjI8wMligRqphgpjCfcPLHP88Gp78Pjs/P4df55eGhezoeDE4HmEA8ic3ngJFAJ3Bdk+2Cp0+je0H2AsH/tH44j+UdWLfVWmX5YSrRHI+NgZwo9D4LzXDozZBUjEUQIZlEu77hqUwa3+OWHlbNRORcpoc6EeuUs47sG6lEODJcIoaCUI5hIQOINzLBbGCiwUAdSKdCws1r1DQIONFos9fgc70JsUNPDLLW8PgLwFpvLXWELpWE9axcggkK5pb3bCv2BI92W5CFDCEB4Z39bntvJ+oN+fZ2q7fT6+HuE5AyH4mqW+PG8OnK1r8LJYyMWapjkMg3YIgR3PrkljaHJTIXE/u4DAjGE/iP9unmzsn0+LJcfM23INS9Pjxj3T2WcjUq6D0fLTFBhZdog6pIU0yj5yrtAJ8aOZJqHSqldR8dv+lfvruAN4NjMKRzeEJYK+VAH9JalaBaAqqgC2N9Sxh7Am4hobciBXZgrH7lob4Cgriy1YnS/bJTC8wE3RryIs1hhd99zYoqaDY0elIzJbKbrzl7IRuisQWxD96BA4YQGXH0tNoFwFdo8VkevvOcfMXGgifCvGywfpJIJBLSYrBGAArrpxhEeVKJoMMCTBmQkflYFznGPRmLuiwWrKxLY+Ff3lWFgsYBmD+uJ/04LwA5IrNqhXNt8Sh6+QDOjnN17C4qTCOWTlXOY6AC8pwpsNEY4DCLgDYJ4du7IxSXBcejynlzjzWruE1yd+8dMke5prGYF/YJdneWgvsJibT5wI3wxmcxTjpvRNIoxeQ9Egwi2bTYz5qLqzR8NpQiTTa2u7Hdje0+0XaXB8u8x49S6tNeTX0uFS+Av4aC50rqY0h7lGblJNc6coLcgiKgTJHefrgAw/4iFHPpKvYzfmB+5EL5CvL9uTzc+0iWRYoP/QtZIILER9/8Ak8kkgPCe4ExMcqxant1tzfaRBIUVK1JEcFrGjbVBdVOplDUleEWiy1h1W++yuOUvzoP6Np0IfXpNpnkJpPcRKNNNPp1otEmk9zY7sZ2f07bfTCTnGNF1uLzJFtMJtxMnab5caSWM5jAym8GbG5yJKrlbAWBsXmOFdQzhyDqtKP2cC8W3YR3k93t3rAT73b4zl57rx11O3tBNdZfLex4bmR1m6rI28nRtV2FuYE8rlCgXDbXOqm3/4C9RgzRraHrmefNwHNg6XWZO+6s6zCegEQMaum52+KeVqPLt7kCFCAldVYzz3w2GeImQ9xEmU2U+TWizCZD3NjuxnZ/Ttv9jgzRZ0P3Z4gw4ckZIsxttNg8l3qDyvVfTxTJVDwGpN5Mx3FhqOFZZoGUV4AqIUKZtuRE8IDYQdDE0yChO7YV+mNbtnk3P9g2a86Pe4U4FcaWDpPNmu6je8j92UCXtTpqCpPCJuM8z+xBs3kHC0G4swbPZMMfTJkqfduI9aQZAWfXOC38vu0MFCew/tmJT4sbJBYjUfOdmyTgTkjECNRxEBa1NB+EjKfkUPpTXYBjJDBbDKzEayG9xrM/XE1/szS7QVq3Qh/QdWnS2Z+nxQG6h5Z17HtwN5jPANMlEv3pCStAW+h4A8jrEvA5dD6uX6CCXF1X55xjTu8wXJm5iFNYiXRWEDrFaR32WnADBYdrzr94++HiJRthJkuepLCYRAuJpQfY4hmoEXnKftmoxkUUvIwuRmMirl/7FICWyYYpMIV9VOdCsKsTz6g/IIQMwOcT23GRIDeDq65flBJMxI1IMbo2FtxG5ZSJagIXm7y27iVFUio5KidZGx9VyI4kOjg0JprjSaQuPLvKSrp4ha7nIvG3ElrooIUEzb5cwsKx9ip2R0ticA/OiC1x69mbO3hhBR7WZ/AGoS7jgJzweNQ/4MSl1J6NRw1eiPDqeHxUH9yJt9oy5rwisxBl04SdsHistRV/ZwxVB03lalSApT0bLTpmF5JFhJ1WBaXQbRnKEJJOwu8dGIZyysQjDPqU82hIB1XizPYTSRb8wic6xPypRjO9voLYjDMTHdtn44wbhrhh6PyE9fi70IeKhQfUgAbyA04BDhfyJ0/gEa34Rgdrrecn8E1ag+EjBlQJis0O3I+DhRP0T4wGcPZ8DrhqzNnnn7TwjLmHhfGvxqyy27DMwVV8Uw1hd4lvDt95vwVD8V+NXqS4v2jKnKp0+qO99D2e5K/jd/9HHm/jaX5FT+OzaGxuDhb3E45/wKli1GCixFcwVbt57dPE1b6jxQO/Av6FUTJ/qgGgwqKakRKjKqAs5TkaCjmKeCwFdSwywXNMObdQWfWEjDszGtGDupQAjQzMAU9gIRXmkUwBXoNdLHbmZIMun0VVwd+2oLIJ94rHUAGLBvuAB7VjkDQWkHguAcY+a19JnoOwz+h+0FGpPwxZVSg8xg5oFxPGQUsfUbJE2rhwvhDqSSVKXmjKJuerSseA2oskNKiUMhN7OsRmONTZFV16ZC9QJes74cB6lKK/cLMgZCBSUnacV68WHoMNChyORZphCQuOXOCh4cUO708uViACMGWBrlg0tBk1/SLbxLkABKsypz7bjXajFVKVAu+xIoSiuwKcrnlBjq10YaEAcgWeb2LZ77yphVrh7n25S1vLuly54fNT3xbzcRULomaGPUJkbeGKOFdsXwXrim1YelC9R7ZUb+Pw6vWtWskNBdoYi3rY4O4O+1BYg87wNTgqbHJcXS/KSyrzQMXwOQkO3B2M+yXyYuBvg71kFw/dU1tLfdlHVdNFCyWAxy8COy8LorGSfhZK33kZ7RlILrN+dg1LXDOPOOlm+a9H4cWUkrQSyspnMSTUrXANwgfnXleaNmen2CoNIn8nbuL6T4bfwkv89yD4CH/hh86cs4FJ9P4uKLu5MMfBxT//BhnVXAQ= +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/export-role-mining-potential-role-status.api.mdx b/docs/api/beta/export-role-mining-potential-role-status.api.mdx new file mode 100644 index 000000000..499d3a48c --- /dev/null +++ b/docs/api/beta/export-role-mining-potential-role-status.api.mdx @@ -0,0 +1,79 @@ +--- +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: eJztW1tz27YS/isYnocmGVE3y5LllzOK7XTcSWof2Z48OJ4TkAQlJBTBAqQT1aP/3t0FSFEXX+Km57QZvSQWASy+ve+C4J2nMqF5LlV6GnmHnviaKZ2PVSLeyVSmk3OVizSXPMFHFznPC+M1vJxPjHd47Z2OThkOMDvZu2l4kTChlhkSBHKXU2mYSKNMyTRnWuRailthmExjpWe0LeOBKnKWTwULC61hN2ZoH6ZixllWAmAaN7L4moAh45rPRC40IrnzJG6X8XwKQykMwC8jjLF8NTwTTsWMe4d3Xj7PaBCgAOKGZ4HAk6KQkbdoeFr8VkgtQBq5LsQmR8IimRHLzG3CJO4ivvJZliD5g7AzbIv+wD8YcO73RDT0+bAd+NEw2t/r9fa7e3EAm23FndVl/n3Rj9blKSPQBYh5C0sr/HQHB3v7Q973271g4Pf6/aE/7PUP/GG3F8b7B+1hv8fv48fq7PurAbBbE9HiVqrCJHOmi9SZCPukAgZEwbDABFe5XuGsN+y14zjq+Qd7/djvHfA9P+gGbb8f9YYH4V4cxb22t7hBQCZTKQgH4XfbbfxvFdRFEYYguyYbi7zQqbnHqAmRRQlIQpUiNqTGsyyRIXlF65NBknc1ifEkOYvJ1p3sVPBJhEgi0+jEubTQQIsnwGueiBnQPVdZkXAt83lN6uCMYiK0t02qaASzYgYiKxcyPlNgFjJCEeIuaDJ56QdfpjKcMg5yX27KZoXJ2ZTfCpYrFoCq0jApIhFVK4XjvtJDG1TuZh2pGWw4IlnWQAcKtuPpBujTmMU8MaLBIsVSlZeb1QGhKnjOuBZsKidTsBTHnuMNMeF0GFd6AhL4nbRQB4hWuFjUHjwk6fY9zBARiJ+4BqDfE2dPbBAGBxAmJ696WOOVgz3qVxuyO2aFAbWAlrSIBRhqKNbsc+kp7bAfRsGg73e6XYgBnMc+j7sdvzPsRkEUBzFv99BzraVvugda131esNzlP1cnVyfHmGTWOBFpMcOkU004/fW/5+Ozn8cnFxfw6+Lq6Mj+dTIen40xFz1JzJjUhLdYoIvXdLuU6dP4XrK9BPhX24eNR4gd1vS2RaSjRKI7nmgNkdB3cQndMHZuSCbGAhXNmUS/vuWJjJrfEpYeNs1I5FwmRyoS24xzFewbmQp/orlEhIIgh7AQ4ru6lRFmppkCB7UkrQkJO6+5GtHb7WaHveYRcy7EjhwzKFrNw89Aa7u3rAK6SiWsZ+USTDg2o2zdVgwED/ptyIgxJEPePeh1BvvBMOZ7e+3h/nCIu89Ay3wi6mGNa83nG1v/LFKhZcgSFYJGfgeBaMFB9gSANoclMhcz87gOiMYT5I/+aedWbDq8LBdf8wak2tdH56w3YAlPJwU955M1IaT+FfpgWiQJD6q42XAgzrScyHQblNK7j0/ejK7eXsKT8Qk40gX8hbQ2KssRlFxphGYJUMEWpuoLIXYMfOEG6pgExCGiJnvlqL4ChrjLy26itL/M3IAwwbZiXiQ5rHC7b1lRJ81irWYrrkR+8zVnL2RTNBuQ++AZBGBIkQHHSKtsAnyFHp/l/lsnyVdsKngk9MsmG0WRRCahWAFvBKKwfo5JlEe1DBoX4MoARuZTLJ8h78lQrOpiKcpVbSzjy9u6UtA5APnjdjIK8wLAEZt1L6ysxUF0+gHMVnKr6C5rQiORztOch8AF1DlzECNUTSFEJuBNQvp24QjVZSDwpOW8KmItamGTwt07C+Y4VzQW8sI8we/OEwg/PrFWDdwK53wG86SNRqSNUk0uIsEgsk2L3axKXaXjs1iKJNr57s53d777RN9dHyzrHjdKpU9ns/S5SnkB8tWUPDdKH03WkypWTrJnEVaRDWgCyhLpl/eX4NifRcpsuYot6Xesj2wq3wA/qvRhnweybFJc6l/qAgGSHC0HMUQiER0S7iViEpQV1d7mbm+UDiQYaLqlRISoqdlcFdQ7QXtNJwTcYLMlTPqT6/I41a82AtoTH5+OfHaV5K6S3GWjXTb6cbLRrpLc+e7Od/+ZvvtgJVmhIm9xdZIpZjOu59bS3Lh96QATWPlGgFUuR6par1aQGKtqLG+1cvCCbifoxINQ9CLei/p7w7gb9rt8f9AZdIJed+DVc/310o8rJ1v1qZq+rR7tsavQt1DHFSkYl8mVilaP/wp8NxdjWMPQU9XNIHMQ6U1ZO+5vO2E8BY1otNILu8U9R4223uYpQICS1HpNVfnsKsRdhbjLMrss82NkmV2FuPPdne/+M333GypEVw3dXyHChCdXiDC32WZVLfUGjet/XiiSqzgEZN5MhXR7JVpWgVRXgCkhoImgGIJ3fQ69Fl4G8e0NIt/dIDKtu+oO1qJV3cHxcSqMrd1zWrTsO3efg4rD1l35Bn6B79apuLR8FTqB/aZ5npnDVusOaICaF02eyaa7ojJP1ZdmqGatAGS8JXzhm27rqjiBjc5PXYHcJAVpiT5gAyYRt+oikaC1g9rocPNBynj3Ce1grgoIkUSmwcBfnD3SY4CY8XT+k6HZTbK/Df6AryudLP48L5bQPbxsE9+Du8F8BkjXWHT3KIwAu6GLDqCvK8BzZKPdqEBbub6pz7nA6t4i3Ji5zFjYk3Q3AJ3htC57LbiG1sMe07/45f3lSzbBmpZiSmGwnBYSmxDwynMwI4qZo/LIGhdRGtOqmEyJudHKSwH0URYnIBT2Ib0Qgl2fOkH9CslkDNGfxI6LBAUcXHXzotRgJG5Fgnm2uZQ2GqeM0hZIscVX1r2knErNR+2SZPND6rNjiaEO/YrmOBbpPJ5dZyVfvMbXc0H8q6TmW2o+UTMv11BY0V6H9pJJCIHC+rMhaT17c0vPr9HDTg2eINV1DCgJh2P1VU5Yau3ZOFbo+UhvFceH9L29+7ayjNn4yAzk2yRipyycKmXEvxlD00FXuZ4U4GnPhkUX7nzyCL/brkHy7Za+9KH8JHxvwTFSa0z2li1VPwoKwzSybvuRNAtx4SM05xH7uMIzPb6GLI0zIxWaZ2PGDX3c0Ldxwjj8NgmiYeFVNeCB4oA1gKOl/ikSOKC12GhpbY38RL5FazB9hACVqJjs0P44XAZB9xejAZxdzYFQjdV79XILfjNHCzPhirDKc4d1CW7iTRQk4DW5WbzVyQsm5b8bv8jxaHk8c5Ym8+8dpe+JJH+fuPt/ini7SPMjRhpXT6O50bau8agb+WtX020eFxq8pyvgXxglX6XSHRojavWoiqkTyhKeo1WTV4dT/AoDL2ELnmN92EDLUjPyxEwrdH9oJ4nQRMMccFsDdSsPZAL0muxyuTMnh7HFJ+oVf5uCuh3cK5xC4yqa7D3erw5BLdj34XUCGPukXAN4AZo5py9EjktlM7wXW6R4+xxgFzPGwaQesYhImrCwgQvawFSUslBU+lWrSi9GU0MWmtQB6Zk5i/EMG9rjmuIf2Qv0btwBNogetei+eVgyMhYJWSbOWy3tH6MN1uZPRZJh5wlRV+Bd3+UO704vNygCsdQAX9DhKz1puUWmhXOBCLZQ1nz2mp1m26eWAp5nyuTQK9eIj92XOo9/ioPfWaxb593yRP+v/ALIZR1sF1oZnqUhL4VtcWxXeu1t60ph6WH926C1xhSHNz/BqfemOKO6Hw6tzBTkh5vd3eHZDXZrC3z8WyHwYOD6ZtmIUUME+sW/oYW23y3cL7wXY/cRzEv24HdHWyVRnj2m8+Wxgwd/fhZ4WrEUAPacz4L0jR8TPQPkuhqeDfXPfi70DOyVgSxuYK49tSP122F7rldbuPHmC5vk6qzl5xPw4MUfmxmAAQ== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/export-role-mining-potential-role.api.mdx b/docs/api/beta/export-role-mining-potential-role.api.mdx new file mode 100644 index 000000000..9ef32ad1c --- /dev/null +++ b/docs/api/beta/export-role-mining-potential-role.api.mdx @@ -0,0 +1,83 @@ +--- +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: eJztWltv27gS/iuEzsM2hWXn4jRNXg7cNF1k0W5zckEf0gClJdpWK5NaUkrqDfLfzzdDypYvSdrs4pxu4T40MkXOfHPlDMXbyBTKyjIz+jiNDiL1tTC2PDW5epfpTA9PTKl0mcmchqJWVMqhiw4uo+PesaAh4adFV60oVS6xWUGkQOh8lDmhdFqYTJciNTc6NzJ1Qua5KEdKZHpg7JgZCzwJKYqalbBEONMY46cxsxBOOYfZbXGsk7wCN5GltKDM8Ch1KvhHrsb462g5sZkn2oYEhbRyrEplSY7bKCOwhSxHeKXxAr8CI+ijFblkpMYyOriNyknBL0tL8t61Iqv+qDKroLXSVmpZfrUKPTCDqvoqx0VO5F4mW/ub6sVe/HJPyrir0v1Y7m/243Q/3d3pdne3dwZ9MFuJs2ja5q+h7S1pP73XAE/Af0X8XWE0SBC67c1N+jOP4axKEqVSlbbFqSorq2FV8WdWiEEGDInRpfQ4EnfNY44d5yEnoPervYDIYYhQyKLIs4Q9sQN2NHSfHluRd1qM9DMt7SS6w79W1F0lz2GegYM4shYo4iCTgl4HjIkMolwp+iadiIwc9lrmWfoAuM+O6K5AZ/qfVVKSb1uKZtKFhwON5YcmVaskmQf7JtMqHlpoGAgVQ06wUIDidZaS1sfGKuFJCuNF4HntOX+AJtpb4pVMIa+X7zAIAzWVViZfQIsyzWOALnSG9aJeQg5ZW3MFW7WnZP/F5v52d/CiK+X2y+7W3m5/fyB3djb3d/f3ifsY7iuHXjWBt7RWTpZY/6q0slkicpPAIn9CIVZJF/IUM8eSrFRj97gNmMY36J/ShZ87FTPgFaX6WrYQCq8OT0R3T+RSDysel8MFJej44ozSQ5Xnsk9DFOqQ3BN+b7NhpldBUboaU1J/ffSmd/H2HCOnR/+5ODrDE9Fayu09pDGdklsCKnxhZG4YcRDgRjrkihzqoFh+Hqg+h0ASMd2YmPlfbuKgTPjWQFZ5iRWB+4oVTdJiYM14LpQ4br6W4lnWVu2W6NMYojUZib50WGD8nvC8h0RTlPHboMnnYqRkquxGW/TSNCMhkSkQjSCK9RMQEjJNVVpvKoMKoQwwWTkyVSm0KbNEzdtipsp5ayAIKD1hxtumUSg4gPxxP+klZQVwLGYzCqfeEiAG+wCz19w8uvOG0lilEyTXBFJgd55AjdZCw6IP2TJk0ZCOyFwOiUfX86YZi1JgLRanu3cezOvS8LtEVu4b4u4kR/qJWbTpi2sVgg9uYEI2YmvUZgoZCS9JbF4cZk3NVQc+Ng2Vp+vYXcfuOna/MXYXX56GKi685dJna7n0udCygn4tb55LpY9l79FG1JN8F+AN2RJU03nt/PbhHIH9RWmaj86E6te/sT7yW/kS+N7UHn68T+XH1FhztiCArMfQxyATqfSAcc8Qs6K8qnaWub0xtp/BQfWKEhFZ04qJqYSEymylufqVroV2Sjn9SylGEvlRIiKc8xnQ91wxN13rSnJdSa53o/Vu9PPsRutKch2769j9Z8bug5XkFBVHS6iTXDUe0xEbe1p4T9JKgQmiPk8U05BjUy1WK0RMTGusaL5yiPrbW/2twV6iuqnspi929gfbyYttubu3tbfV727vRc29/nIWx9Mgm4+phr29HVnFKOKuUcdVGs7lSmPS+eM/qNeqAaU1Sj3Tuhk6h0qv6tpxd9UJ4zEsYslLzzyLe44afb0tNSCgJPVRM6181hXiukJc7zLrXebn2GXWFeI6dtex+8+M3e+oEEM1dH+FiAnfXCFibntTTGupN+Rc//NCkUMlIGD3FiZJKssHnnUVyHUFXIkADRXnELoPcBB16Kt27L/Sx+ErvevcTu8x3HWmH8Bjmop3C3cH7jr+4gfdIeBa0otR2RzkR2VZuINO5xZLYNW7tiyydvjsPtHmpp2YcacPla7IVvRh20cmTRC9k+NQD7fZHjYjl/f5kYl767AGyLlhJT7LfJAyXYcgs09MhYzIZFoC4RHcj4cBsZB68ovj2W12tyX5INeFze/+uiye0D2yrFLfg9wwXwDpgogkwhWZC24CQmyvC+A59MmtV5FrXF4155xRMe8RLs2cbVDUgmwvAXpP07bFKyUtOg1/Kv/stw/nG2JIJSynkMpR9awy6jkQhCdwI06RvfqEmhbxrmVNNRyxcL25bwAUkmKQQynioz5TSlweB0X9jr3jFMme1U6LFOcXWnX1rLZgqq5VTttqe6Ztcs4s1R1osSPn1m3wFsq9RuM2UvujjsXrjDIbhRHPCSLy8bu4LGq5ZEOup4L4V00t9tRipuY2FlB41V4m/k5Jgrzgw9extp7M3NOLG/SoMcMIUV3EQJoIOOa/3CS11Z6MY45eTPTmcXzUH0YZ9uf5ZcKnQ+GwveapOBbJyBin/i0EuQ6FyuWwQqQ9GdYNMY05IuLtzQak2LOMsxjVJuN7i8DQ3plkn3Z7LnYM6kCd+rD9xJZFXvjEF5U+zcnMw5fYlGlmahL3ZMzEMCaGsc8TLuD3ex45Fl1jggycB7wDHM7sz5kgAG3kRk9rZeZn8h1ew1fQAJWpuOLA/ziYJcHwJPgFzZ7OQaqmYn36LYvuCQZatPHNKas+ZljU4DLe3GC/XdCbxzs9aKE9+EeTlyTuzU5j3ut88ndn6XsyyY+Td/9PGW+daX7GTBPKZ3I3Zhv6jKaTvwo13fLpIFoIyI3/8ZZjlSt19EHc2XEV0yRU5LIkr+aoTkaZ4nOFQsmS6sMWeZYZcyQW1lD4o3tkQkOLOQhbh7pV9rMc9NrifMZZcsD44pPsSr9dxc0N8UpG6FNVW3xAq6cTmIXaPLo9gHefTej3zmCZE76S/bo2Noqu8bjS4EZxWY2FhEs94hFp5pLKJy50fVrVujBc+k1X1VFMrkYitLnhsWP3fkBH1uiGG4Z/hBfs7sJ5NVRPVgzXoGeCnKqcPZPmzZf2j9GGt8UjlRfUaCLrogBTDQ7vjs+XKIKYdpALDb2xw05Y5Do0F0SohfLus9Peam/G3FJgvDCuRGvcIH7EjZd4Vl+R3wjHTO77rsUvuu3t7GT/x72LHzYz6kI6BZ3IkYoq3zn53vYyWtXbYulB85b+QntLr5cvx4cOF/3QCEYg0re3dN5DLd8dDf9RKTpMuLyadXPcVcFJ6Blt9wBpa/HufFPRz07DLfsN8eD9/5Vy1+eVejI7qojw+EXRCcdMXGpcnwTpOy/5PwHkotLvrrDEH5qxJv0sf6zWWL94A5961ulJx69HCKi7/wJgA8Xk +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

+ +Succeeded. Returns a zip file containing csv files for identities and entitlements for the potential role. + +
Schema
    + +string + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/export-sp-config.api.mdx b/docs/api/beta/export-sp-config.api.mdx new file mode 100644 index 000000000..0bc61fa20 --- /dev/null +++ b/docs/api/beta/export-sp-config.api.mdx @@ -0,0 +1,105 @@ +--- +id: export-sp-config +sidebar_label: Initiates configuration objects export job +hide_title: true +hide_table_of_contents: true +api: eJztXOtz2zYS/1cw6oc2GVO2ZMW2/OVGlmUfU1nSSXJzOcfjQiQkM6EIliDjqB7/77e7AF962M5jmjaj6Uwqk3jsLvbx2yWA+4oMRcRjTwa2WzmuiE+hjOJR2JbB1JtVdipKOEnkxYvK8dV95VKJCN7E4lPcSuJbeFZR4bFDbY8jwV3skD2Y84DPROX64XqnEvOZwuajgWWGhoeuUE7khTg5TD2+9RQLpYrZnef7TFPC5OS9cGLFppGcs/hWsFgEPIhZLBlnr0f9HtOzJZoJNvV8UX0XnMmIzWUkmBdMZTTX7/hEJjENokdl8SIUCh7wmAGXkQhif8FUEtLMhoBpEjjYm/sghR0WiamIcParEecj1i5Ofv3LbRyH6nh31xUfhY+SrSru+aH0grjqyPmu5wa7rnTUruJcWSXKd38yEwvXMky/qII8I/FHIlR8Il1Yg/slmXWMkOhvhaKII+mzO+SIpDhBCTh+4goXfhDvmq90aC8SsO5xlIidCnYHGeA0PAx9z9GEvVc4131FObdizvEXyg1m12TCQNz3+1PSkOU3YYRSiD2hsJ/4RKSMUeyrzPTzRWEBn+PKSGTA9HK1DvCAqdCILl0jEC0om4s8GQJ4FPEF/OnFYq4KJKs48gLUaxEkc1TIVrvdGY1uBsP+md3twAvzYNj5z2VnNL5p93tn9jk+H4+HN6O3vfbNqH85bHcKby7H/77pD/Fnu3UxaNnnvRsYbNwZwpOz/vDi5rRzZvfssd3vwZPz/m+dYa/VgyHOh/3LATyyTzu9sT1+e9M/ed1pFybNXuT0de2zTvttu9u5GY1bY3zS64/tM7vdwvFvxp2LQVc/H7RGozf94enNoN+122+LT4iPdPbB5Qm8vzFz2Z1RPv+wT3MOL+l/o875BbShX8PfbGDgtDP69cbujTvnw5Zhb9QvTKhFBT/GLRxuPGz1RigR+m2fn3dApJcno/bQHpjuQN6vZ93+G/QP4hOfhz4umxnn4QFWNPgSHSoawWMaxOzC8CzmH+DfMBKOcEXggN/4CMZf1OKtyv2oKre2MSqg9m197XJXNbDlup6OF5lbjnk0EzEoAeidcLyp52RhLRI+B4+PWiq4c8tQeVJHXdR0iGvCd3Nly11vNt2g5Gofd8SpOdjuZhvy3A3G48110IkKoeTZNpDJdyKaolY7cK29I1GzGs2pY/HJ4dSa8ldHr0TzwGmKRtHg3R6a80ZqHzH2b0PvGIIw05MBWUBX7MX0Qj/TkdimqVLdeCj0v1+vUMtrcfU8uVyviOVKE1gHuFWiTtOVUXS9rAklYa7yvyTr0Gh2AkCQuWLqBSDlQptdXAY2zUTN3stJtSRGg1heywmrMSS5skrtgC98CWAylx+RaroC2MjMh38EeMUnWsBroVHe2qC9rAtqh33aQ/I+cj95fIi8l5mamCpGoqvr5di09fR/Z0+/7MbJasyKK5lEDujKZAEashl1B5gtmKaURECeAT4cfbd9qlJnv4y807DwtOKVyXiOwhmRrGEvffWFDmcHm4W1WlNYzT1qFn6wuNOkZocHj/gl448MS3HEA4UZGXGF3uJx8RbaL0lYO/yvlvEagp4j6FzZ1sk6f7si7nWeeyjmACzZqceBvhjSLp9d8OgD+pg24FLIXC3WlTobgx/yQxJWlsXqzWbgklUyyXhU6VPweYFbZPTOi28h4VUxpFNyE455dOSlAZeW5vPX4BlzFImGJD+G9intn7dgG7zDd1vHDfT85YZa6YHP/pVi8jFIOBK0AiB8wK4w7AVVcyLWRuwwNbUBrYZaFSOhQpCbjtX1vfrG5QZMwLjjiBCBL87xRyISQVNBriXB4ykAH6g2zy5IPLcAAVNjmespnHMZeEATIGDGgZZZoAF6jAWqFUCz3zhoTo4OXatx5HCrsd/k1tHB0dSq1w729vZqLj9yaohkVMzjZC3GLM89onZMTsmU0ulM6gjRGCPzcNzBeGD3MHSfDwFSoIr1ITh3KDi3EQB0u9TorGXjj1JukzV9SJHwU1ShHRVo2mECzFFkMA9WTqPsIrGd/w76Qwzo9gX9KJFgnhHECz1dAltHhq7ewRMX8iQr9sg/LxcOBcMXLAliD4tfnvFDHDWVI05Ma2E5jENlc+VdgECzvKCgujVr75VVq43r9eP6/nHt4H9IpxMJTNW+lkgjQXbHIXpBZghDPm/+uXQp0n0tAWYVfQ7pQhJiB63cYlW315PyUKwcXhmbyhTcaFRpXXPhFdi4zmF/Wm+GrAA4XTXi4nRFrr5/NjMeLdWfS/XqljMX1kj6HGIbOLqJ/ISp4xrGtWck9smXNvb2Vt1n2/fAGbJOFAFFFhuKOImQYk8vqCkUs4l0Fww8lRdA1PXc6rvgczzp4/7TFTEYUFu6z3AZZyBOaxZxkqogoh3oiC7+o+diNYQK9HrIVCupXVnGIItqjZ1wFzjWHLYNM+i9Iu58gLE+w6unXdC949pumFYcCj452GvWG9ODBuf1o0bt8NWkOeX7+3vNV80mmSSEKgiKRa+eVhTKU5+LQESew3yI/r73JwgE7EHh5wpULpx8TRFiwxrQGM9x2Wjk1DZj09DL8APODuPspD1gjUNwBcEsoed8tiSEwLrE2BIkvkmz8UsBcK4H7gNw89ZaWhoDIDltXXYxCJict7KDY618/GkFoK8uqiWQCrpwK++0l9IMkLMUPogDvCV7aUZ9CQxxxLl5Q0//pRYKC2lg0zzxY+hhZl/Tozh0/pUpNSZHf+1iv3hVUd2BEKJSoDvhCjpInXW8bBGesbpGki/ZreCuiF5UWaEeSChYQf8FxSK38FFmmoAxCwK5+I0qkAAfRXktclGWVyP3Jt3ioqBxAOVP60nLiRMgjtgsWmGmLVk5ktYHaNaSK1M3LgiNRLoIYgi9CIIhjXNkFGEJZgK8ebH+UIW+zEPZz3mQtkt9VrkohNRcaGJOY0nvHJ6oZ9jdwAf3YxFr2YuPwhgflQu1N6LVSJfJeCQTFKmzaZUtV2r4WVl2a7tb293a7nNsd/nl0KSN5i2Bn9oq+LkMeALyjSh4roCfiLQnkCxtpMGYXsgdSk+0dF6/GYNhfxABtieEquH3N8JHOpSvfhPK1kM/nyD8yBartBZIIMnRbGcATyTcY6I7p7iS5tyNvf3V2c5kNPFAQYM1IJGg7kImkBvBmidBgJRwtQO5kFDBzzG75eAfMTtXKst5ReBaeg/DFklukeQ2Gm2j0Q8TjbZIcmu7W9v9Z9ruo0iyvHXA4CSVzOc8WmhNM++RW86gAUs/YLDM5AqfrXK0goOxDGNVysihMqnXJrXpoSMaLm+4B/vNad05qPNXh7XD2qRRP6wUY/1VbseZkZVtqrDeeh1JxADicCNaEoByqVhKt1wABPFGYopujbbJprgZZA4ivc6xY2MVO/ZkDLzBwIAdow0FxsthV2+D1cOj3OhDNcLsdKsFfhBESIk6DJL2VLyFjlvouA0/2/Dzw4SfLXTc2u7Wdv+ZtvtZ0LHxFHRsfAZ0bDCEWFOEWN8TOrqAOxCaTWFRgAdz+gn4CIEV+GWqj8bs9Qb2DOiVUGS9uYoix1KyCx4sUrCkSpXIIBcXujdoO8e2UdoWd22zGbjIgIHX8gDdolbh1gXApLhdwffmHtkxMgTjRgurNcUNYdpmUn3LZjE7nRQ5BV9i7VWCjnmgTmKK8A9GoDroDBz1N6xxmtX6qnowGyLHXeSYdT45QqDNZ/XfV+v2CdhAfITuYqTXesOGAV0z5wGkEeJTqN1XBkG3UH0L1bfhfhvuf4xwv4XqW9vd2u4/03Y/A6obNLQZqkODZ0N1aFvdYxmWOkPl+ssRO5mKoYDUm0mHsLqbY3DCFaBKSBBen4BOhOPlDJXd7Jjzrt7AWsH7HBATanKSyIdW6Z0F9/pmhYcqD70qOC9YqHgRyDu6uGAColnjdXCbqbYwbMBaA9skGPrQR+Sh6mo/R4NrKRMnqKTp3QiPjkybcGH5FpB7mNsfdvAsn1EjegwkhpBD/KyodZXUZoU/4Osy8h++nhc90AZe1onv0dmgPQNKl1g0G4XT6zdGCLj17CuXcORBBEv99ZXJ+tiszk4Ej+jqCtz98svrN+MXbIYwk8w8wSMX6aZ+zgagIuTGWulOEOxEkSWSyUxvr2+V9tqg2bCpDwyzd8FICHZlGyH0wL8PwSGTSLGTIB+AvZ53YwZIaJeX+r2gMLd8wUf1XWCxUw+9D50gwjaGRUrv2FWY8sULfH0pET+lo1l6NItGUy+WqNCivXL07m0nEiQW7iuS1hdPrsezCuNh8gRPcNRlGlASho7yDiknXbUvpqM0noXjlel4F7yhAxnlbky7LKYgBPous5lzK6US/2IMVQfN4GqWgBV9MVl0CsQii7DqewWSLD2l5VmACIm+LhhGoJVJ3xBDgETq2giZ5O+0smDzv9N5pd9LPNPjKwic2BIvd/limnFCCye0tA9Qhn4dl1CxwLaRB/IDWgHa+fqTJzCEFvyeHmutV6fhd6kPhgZHmjs1VHis/zjOHZz5xehFZafQBtwwAupszxielzZjYXAqCSstBSxLcJVeX0JMXJKbpjf7oIlx8u/GL3Lcyism/cBffGsvvcGT/H387nfyeFtP8yN6GgNxsfI4zK/C6uT3aqw9Y1q4X2LldHDhlPzqKeFnnwz+yy7zwLdTSSI3eVDRwE8MVl2tXio6awj/wlvyU5RJQJ6mj1IjgisOFPo8Rosmj+bceoLqHqHgMeLeHbQqOScvZM7oCnMme0ZH+yJYLg6ZqofXpFFlPp2Zk7PQoBp1Gv9WidknIsEcIY8WVfYGUtHAAZXENBR3KMO799LkoyPQygEqNTtNFZ3hkeokgNnQJyVzxsGcnrAG11NOop025EWBSGUhCfZmvVIPhmaGLNCFMSKaq/4US+qQrReU/om5QOeVqaeD6HEV9aUHlZyRId4BZA6yl1OWp8YGS7NuhR9iIgwRB8CnKMxwYY9XRoTBAvMRR0azXdNJ7WJbGARTQ60++9Vadc+iVAmeY14JqXthcBsk78G6qw3nH/MTk8uaeZ9/XNje+bf+zj+DFDDF2w2xJIlrkOiUU+f2ePGiGYscHGX34EhusQAAb+/vsWaF6e4DPga/iQURvLUgzWTpag7oQLUrKgd8EFgzMR9LrLE+xWuKI6tfgTDB1j10PezRtteFGsWgj5XBysRcaDjX5ZaI38FD/Pe48g7+gz8KV1PQ8/tKWryENnrcFF+ug1fmh76B5P/jGYmK +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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* ObjectExportImportOptions
+ +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/forward-access-request.api.mdx b/docs/api/beta/forward-access-request.api.mdx new file mode 100644 index 000000000..a2a6c278e --- /dev/null +++ b/docs/api/beta/forward-access-request.api.mdx @@ -0,0 +1,103 @@ +--- +id: forward-access-request +sidebar_label: Forwards an access request approval to a new owner. +hide_title: true +hide_table_of_contents: true +api: eJztW21z0zoW/isa74cLTPPSkFLaLzuhlDu9Uyhb2uFD6SyKrSQCR/L6hTbb6X/f5xzJjp20tBRmLzAGhknso6Pzruco0lVgE5XKXFtzEAW7wcSmFzKNRmGosuxY/adQWR5sBLmcZsHuWeCeC/9CjJIktV9knAXnG0GksjDVCbECo5OZzoQyUWK1yYVnmwlphHQ8Us9Deh5dcWTihchnStgLo1JhJ/ylfI+hkTg6/vPfo5evD96IIlMp2KUgiGN7oSKRWwFVMNMc4zC5DEmULqRPZCrnKscA6HAVaJIvkfkMrwxe4Fs5CWywEWThTM1lsHsV5IuE3mZ5qs00uN4ISGidKlgqTwu1rrMSOloVnCRQl3KexMRrEO5sPu8/H28PdoZjJZ/2N/Fp69nzEP/6/YEKrs/dNLDNCxstSIzmLAeGdGSXCTm2Rc6zeQvDDvV5V+UNrcmVyYkpyGIdMpvep4w4X61rbsefVJg3GJ0FRl0ckYfYWKGdz4kjpMa0cECuVUYcalRrlrzJcAeV4TDShQDo5tocKjOFr3Y38U1elt8GW1vXy9nvNYMnFmQeTZYaLxqmu3M+TJjrnN34yueJt/XL3AbX19ccIVliTeZsMOgP1v1HOZTkmL6DPMqL1OCjdpqXOXEhM5EVnCeTIkZWyHIMkskyabbIcjXvBg/2qRN32O+vS7gXa7LTfpra9CtSjhGeAommDSygo++QZTV2IpVLHe/ZSN3t2VfaqM40lZokVCxyiIHeyxgh5hZVwrEsQ4zpmokJS3Q3xQsZVdVtzytDbk9l+Bm87hPMp0ZjvCiHUEVAhN02rdpWcvysvzMYTp4NpRw8H25ub413JvLp0/7O1s4OzT5HHMipM42fW6apXKxN/adC1uhQxDaER/4Lg6RKwvYsAE+OIRpxk93tA+ZxD/tTZjnaSk0vr8jVZb4hpHix91YMt0UszbTg53K6YgTTOX1H1RjBLsf0iMoVNHeMj1I91eYmUZQp5lSSXu6/Gp0enuDJ8f6/Tvff4RPxWluVRgbRGlFYWl5gZvaCJfYKcN6pGOZQUVc88VyfQCFpsjqhzmpJiNiayCLOMcLPfsOIOmsxSe28kUqcN5e5eKS7qrshxvQMJT6cibHMMAAuJPInrnZ0Dr0ln4iZkihcj7tiFEWalMRCiWwEU4xfgJGQUcR1w5W6AqkMYXQ+o4XD2FyHqumLpSmb3ljWvsO6Uyg5IPndcTIK8wLCsZr1LKyixYvo/QOZneWa0p2sVsmFyWmhByXKZGjTFBYWY+im80z4ckTuylB4TElXVax6Sedy99oJ4+o56pkssnvk3dsY5afDqlUvviiffBkjE7fmkDdKN/mK5Os5D65WJm+LMvHFRKs4anO3zd02d++Zu6svjz0uWyK1YX9zHfqcGlnAvikvnmvQJ+XoMVaURA6FO0duCBjEQ6S/3p8gsT8rQ/TqMiHo/APxkVvK15Fl5Q/3fEzwo3JWwxckINvRaTBBJVLRLsu9lJgN5Uz1dH02QOCxRoCaGyAidWdiYQtu0NLCGJJEZhsisiozf+RiJlEffSfIFdB1ix1uF1sk2SLJdjVqV6PfZzVqkWSbu23u/pq5+1UkWUnF2eJxUlbM5zJduEjz70lbKUAgyh1CUaUcu2oVrRAzUWGsoIkcgvFgc7w52Q7VMJLD6NnTnckgfDaQW9ub25vj4WA7qK/1Z8s8rpKsmVM1fzs/sokB4r4AxxUGwZXl1kbN7T+YN1UTKmtUeircDJvDpOdL7Dhcx45vbA7dwBjYMb1le/H0+JD40zY/sSe72SINFcFsZzqQy5whJcUwLK35x4oWOrbQsV1+2uXn91h+WujY5m6bu79m7n4TdBzeBR2H3wAdh4Ig1oQg1t8JHSPgDoJmEzgFOoQFzGsINiZQBZ/87qNP+1ymU5VXQK+BIgc76yjyxFrxWppFCZayxk6kWZqLyhto50SblrQgkGKKEmno3Ii27vyBnivCpIgfEeu55jwmhcA3XXRGkxxauZwp462aRZswLiAhF4XY0t6rRYxphJOaEPwDB94HnaJQ/8A9Tu+t79oPFsek8SFpLPYvQ6Uo56v9362bTgkcQPiUysU75+tbjgu4PXNp0Eaoy8SVrwqCtlC9hertct8u97/Hct9C9TZ329z9NXP3G6C6R0O3Q3UQ3Buqg7bbFxWWekXB9X9H7JwqXgIOb2FDxurREoMzrkAokUCJ5Y1WPkO9G/Tc7/gd76tOeQA5610tz1Vf9/wxW4xzzYGTtUhjsJjleZLt9npXcCFcd92Vie6issGL+cLYi25o570x7HZDSaITqC79iECM3h747qPLRk81xbUrgszcuYDVpAiGK/jQwVc50zFx8u0CjYlwbDYEcsDHGD+GiAkajD8ypu5yTK3pB71O0/j6+3VxjG7R5SbzfXU20AtIuqIiqXBO7kIsgBH76xTy7LkKNirI/WfndZp3hNidhGuUy1WIfisYrAl0RGQD8ULJFO2EOz7z6K/3J4/FlHAq14kiI4isNDUWyLS3CCOug6PyKAkN4qUptcV0xsqNGod1KO/EJIZRxAfzTilxduAN9QYLxDEqOpudBikuIjTq/FHpwUh9UTGtnd2ltSk4dWR6sGJPNsY95nWSGwq9PLbf/WA64qWm8qVpvScaryL3h+IsKfWSNb0eKsQ/Sm4dn6jMLXu8IoUz7VnoDn+HSH5igTRmaz14csevU+NH3ReeENdVGcgSXo7mEauw9NqD5Wjw6xC/phwfzPuZxiLcHCZczRMZ1tA4EgcinFmbqX8KQaFDqXI2LZBpDxbrgibtcEZ0Bv2aSB03ZUd3AClZvkMkhnHB5O59MKKxbnOF0/YjexZ14SPflvnY0Jkfn2HlJcrIhtmDZaYJOzRhx9WJzMvvFjYKLOQ26cB1wAXA3tL/XAm8oLXa6HjdWPmZfY/H0PIRQlTmkiW77svusgj6T4JfEHVFg1JNiLw6dIbvwvOi1a1hrHIvYdWC6/LGFovqit2cvNUvorTQ/mz6ksaj5ZYL3b360VX6lkry89Tdv6nitZXmd6w0HiPT1uXx8vreftnNNC/ELRun6gZb7ZYhhSyL7huSeqK88LhwfRuR9rlnCv/jLec7Q3o0TNwCMhKqM0pimbvLkqgM4Uwr3oBIlMwJY25QdNo5ZzMgPJUQtJnMaJqCBqmfAfvKsY7Bj7fIy5klJ50DsBQb9D0r/IENi7BGQ6u64j16QhPCtdQP0lFhvPtkfWP4Dt59yzdHX5YBA+A2nxcGs1FuF3MhEZZ3RFWks7BwxQ/toVGlLSzDx2pUWQkoXEmFLndG6Tw7mtDeNtrmWvDcMRdiJ/Mb2zA9+91dMV0qcqxijm6ia7YHd/FGxHZmKk4oSFC5AeJUbYbXBydrHMHM+F9TbDrt+UFZj2jBhNowFz5Pu5vdfofbEjynBg89dI35q7tv8LpjOtXtze5qiF4tt/t/quvBfr2jRqWX0M4cWaBwzZVrcc+C21pcDN9tXB4uu1z0RDPqkjH26oo2dqjtu6bH4EC7Bmfny46OOys4mT6jOkzAePVycd14j479bdzH/NPUzVeOb9Sq3JU0i+WGRICPnxXtY9QUQdcPBXjDiYVzBP4Xjs7JgqFGyWDtpxtqfN0It4n1Vdrz2sbC2yPazgvG/uLz3O2RpPICD+n/3eAD/uKLTVwGgYifXwXljiNoHF/68z8GPP3u +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/forward-work-item.api.mdx b/docs/api/beta/forward-work-item.api.mdx new file mode 100644 index 000000000..4325da99b --- /dev/null +++ b/docs/api/beta/forward-work-item.api.mdx @@ -0,0 +1,83 @@ +--- +id: forward-work-item +sidebar_label: Forward a Work Item +hide_title: true +hide_table_of_contents: true +api: eJztW1tv2zoS/iuE9qEXxHbsONeXRZqmixy0J9lc0Ic0QGmJttlKpA4lJfUG+e/7zZCS5Thpum2x55zCLdBa0nD4zZUzFHUb2Vw5WWprjpJoLxpbdyNd8t66z0elyqK1qJSTItq7jOiWoHtFdLUWJaqInc5pHEadT3Uh9k+ORBheCCluiF6DXpQWl0bdCHtjlOuKQ11OlRPSCJlk2qwJ6wTu0GNtJr24ck6ZUlQFiLKqKEUmPytQYA6n/qhUUXaBK5dOZqpUjtDdRppw5LKc4pHBA1zpBL+LeKoyGe3dRuUsp7tF6TBLdLcWETPtFMQuXaWWZVLi6LWwY8bWSAOW6ovM8pR4qfHGznh3uDHcVrvDza3BaHM02hkOhnJza2N3O9mJ7q78NMD8yiYzgnF/1tiaEuLSI5nnqY7ZGL1PBaG4XcZvR59UXEZt+Jcwkpuo8pj0e0RSxzbLiCmmzx1ZuNSqYCYLhEta+boSdAKeupyRRYOlvVnatu4uaGgQ7/Z31nc2NpOB2uxv7az3N5ONwXhndz2W/c2dPtmhBvskmgNPWND8hTIJ/U+4vFDevRZmP3qWiYkFK2GNuJZetV2ak4b/bks9DvouWrOPrE2VNEvTH0ELZDI/N1y6Nf4hKF3mMJZVWtbGbqDR5R1wQJ2MtA64N16t0d3dHXtokQObN91gfZ3+W8R0VsWxKoo1MapKABKJLKXgQCkrZ1TCwg4fGnmQaoqyQ+cQfh1xGgYI7W0dvFaM4LbEUJtrmeqkG/2Axy66YqJKqdMDm6inLf9GG9WZOKkJoWLIMQYKcLzWCRk4s04Jz7J2V6ZbdEdootsXr2QCeb18B0EYsoWT8Wfw+pbAuDAa40U9BKFBEfHYtGpbydHW+u5gON4aSjnYGfa3N0e7Y7mxsb67ubtLs2cwo5yotiNK5+Rsaep/KfiWjkVqY1jkP1CIUxK6ZwA8OYZoTtRP2oB5fIP+KQ942kbMgFeU6ku5hmh4dXAihtsilWZS8X05uacE07k4o+xcpakcNUGwFkAcOz3R5iEoylQZJbnXh2/2L96e487p4b8vDs/wi3gtrUb7Bt6akFsCKnxham8YcRDgRhaI4BTqQHiIl4HrSwgkTdEm1P6qmBWU2UIkY0SY/YERbdZi7Gy2EEocN19K8Vx3VRcRq3hpK+OpGMkCAyiLgPzlPkI6LztvgyZfiqmSiXIvumI/STQJKVNksxRMMX4GRlhIEwpdz2BcIZQBBsus5axQ6lgt2mKuykVrzBPS27ZRKDiA/Gk/2Y/LCuBYzHYUNt4SIAb7ALPX3CK685bSWKUzU8oYUsg0nUGNqA/ikjOexmIQ0hGZq0DiMTVdk7HaeZbT3TsP5nVp+Vksq+Ib4u4kRfrpsGjNg2sVgo/XJJ+N2Bq1mUJGqlcHGhyoGnPVgS/GWqXJKnZXsbuK3W+M3fsPT0O9FJ5y6dNfLn0ujKygX8eL51Lp49h7UEvVRL7A84bkZiWUSL+9P0dgf1aG6NWXnIrxn1gf+aV8Cfx+Yw9/f0TlR2OsBVsQQNajl2CMTKSSPcY9R8yK8qraWJ4N9ehIw0HNAyUiN2gzWwkJlbnKUPcmJGrRxKrCPCvFVCI/Si5QfQakWU3SyVGSl6tKclVJrlaj1Wr066xGq0pyFbur2P17xu5XK8kGFUdLqJOKKsukm3lPC89JWilAIOqdO9GEHJvqfrVCzERTY0WLlUM0GvRH/fF2rIaJHCZbG7vjQbw1kJvb/e3+aDjYjtpr/eU8jpsgW4yplr29HVnFKOKuUcdVBs5VlNYmi9t/UK9TY0prvI9f183QOVR61dSOg93l2vHcWvFOmlldIRULNaSZ64hyGmgzonU1LQikmCAvGoFUpYGLXElnClwcnEakOtMcvCQF+LpZZ39cQhQfKLWTNbNoE6cVEHImSC1VzRaOpSGkGlPNBw5cwU6QnX9idRpM9EOVvDglid+SxOLwS6wUBXpTuW8+tL97BPCOcsSZN/AjG72+25EGDoCGwOespu5c1eer+ny1xq/W+F9jjV/V56vYXcXu3zN2/4f6PFRDj9fnIPjm+hy03XXR1FJv+GX+/7tM51AJCNi9hY35lEwyr8G5roArEaDcFpxE6DTMXtSj0xkdTjW9W53c9cLRDTocw6WhR1W5FMTTssyLvV7vFsaCke66Mtfd+tyHsTfd2Ga9ETT0QPKhUwI+0IiAzwP5CbqsXqfJg326Y+Ze2eF8RFRA6bwx/FXOdLSHrDizFRIcs1kT8PbgTXwbEHO0Es8Kpu6y9yzJB7kuXHr347J4Ro/I8pD6vjob6AWQ3hORRLgic8HqYMT2ugCeA5+r9isy9OVVm+aManOPcIlyvt5QPzdYAnRMZAPxSkmHxsG/4nj+2/vzF2JCFSlnhKqgYliFo1ziBG7EGW+/3u6nQbwIOVtNpizc/sILFYowMU6hFPHBnCklLo+Con7HUnCK3M1qp0GK0wWNunpeWzBR1yqlVbI71zY5p05MD1rsyYVxL3hF5NZBG/zM/FGgD6YjXmtKVHQGiGmCiNwJisu8lku25PpeEP+ouXU8tw5zK17cQ+FVexn7AzoxwpxYyLRgbX335J5fp8WP+izcIa73MZAmAo7F12BxbbXvxrHAr0P8FnF8MO+nGsvt4jDhs5sosFqmiTgS8dTaQv1TCHIdCpXLSYVI+25YNzRphyOiM1hvQer4KTu6g+KR8b1FYBjvTHJEizfXLhZlnUl82H5kyyIvfERrnYiPCzLz7UussUSZ2Lj4bsw0YYcm7Pg8UQT8fgkjx0JskwycB7wDHMztz5kgAG3lRs/rwczP7Hs8hs9WAipzKfI9f7E3T4Lhl+AHRN3QIFVT7d28GMS1CLxoHVtQVr1rcF+Dy3hTi+Xznt483mbXipbUv5q8JPH+fHPl2KSzn52lH8kkf528+ydlvFWm+RUzTaiGaZPydH70+rDuW5bOQD99Rrl1RPmxI8UPnigOnTM5Ps8bGph2uL0K1eXytiPti08V/sVTzhrcAqDB4paR66k2ozyVJcUX55d4qhVvWORKllSprpGP24xzQu4sJSK0pcxo4kCDBFKggpYjnYIfb6nXM0sOXV8Gk4fRdVFx10RzxVM0wKor3qOHNDEchPpHOhSCZ59saCTP4CMn5GLide12gg5zV4ZOkwN2lQkJ537CNxNdxJVPoWgnjap1YbkIbUbV+YScnkTociflsuJ4THvhaLNbLvjEXPDAImyEQ/VkxfBxwVyQU5UGg6/dazKe4g2/70xVmlMHi/yPUlC1Znh3dL7EEcxMAbli1bVu0guDih7Rggk1c959Nrr97nqHmxvcp4YQPXeLeThnjhK3+a7jvgvezrf//5QPPMLqR21LL6cdOZKk8q2Wb20vo3lriwF7/MFH3d2iF5pSHwyq21vauqF2745uYwbaF7i8mndy3FHBLPQbKWGMlHX/g5C2Op6fhm8vXojHPxN5EH+972hm8y2HCD8/K9qpgADo5wGct5IYlH8Q3l10zmdcWtQDl17KUKPrR/jtqa/SXrW2DE6OaaMuGoWPVDK/++HkDW7Sv3vRB/zFhc2bzyX4/m1U7yWCxvOlP/8Fk9VOXw== +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/generate-digit-token.api.mdx b/docs/api/beta/generate-digit-token.api.mdx new file mode 100644 index 000000000..4a6b20fef --- /dev/null +++ b/docs/api/beta/generate-digit-token.api.mdx @@ -0,0 +1,75 @@ +--- +id: generate-digit-token +sidebar_label: Generate a digit token +hide_title: true +hide_table_of_contents: true +api: eJztG9tu2zj2Vwjtw7RFJMdOHDd5WbhJO8ii3WZzQR+cAKVF2mYrkRqSSuoJ8u97zqEky7HbeNtitztwCyQ2RZ77Xcx9ZAppuVdGn4roKJpKjV/liZoqf2k+Sx3tRJ5PXXQ0is64c3fGCvaOaz6VudQ+utmJhHSpVQXCAAiXM+XY8OyUwa/SScG8YTVUxplAwLAGkNnEWFbUMPMGZsLO5R+lstIxXvqZsepPIpC5FIhlZsKuIyX0UX00JpgxwTxKrQRE11ECdFsAI51/ZcQ8OrqnrwAV2PS2lDtRarRHFuARL4pMpYSl88khH/eRS2cy5/jJzwsJnJnxJ5n6Cm4ANIqARQuSAzEUFkXplXR4plpfnHbeKj2NVsUlWakEcuXxIxxjFd0gO5RQS2JwWn7heZEhwOF4PE8ucuVn0cNOlEk9hU8LfAqYm0q7FmHYjDhbwBN26pmbmTITbCzZxJqcHaD2ui93mNJpVjp1KxOGAISc8DLz7JZnpURNHyRt2l4CQaIMZvVO6dIHmWxAmVe5RJwZoCLuUShtm1Ga5QHiVyjpN8/bFPUfgCSvPEmutuOFkZ9LJz2KsTmw0GBb0As5v1zDISBBNGC4hdEu8Nzb3cVfq5xu4gjRDxjpsjmKhT9vZJIbUNcW7+Huy8Ggu/fQ+Nympm/lRFqpU8lOT2ofaOOuIgd6fwV5yQdkt3cwkKmIJ6k4jPfTwV58mPb7cbfX7/fBMkR37yD6tuofab0tqGi34ita4mtTrIh3f536jzMF8mOvrQXJxhDtfGk1eLsK/Feo2BjiFlq00mDcSvxMa5Ceq+zYCPm0lt4oLeOp5QoplERyCgcZQLxVAk6w3Fj0QwRZq5D2LTkgSiLpsldcUHRH/o4rZlA9lqefAdYmZnOlFZxn9RGmRBMo1qCVA8nHB7uHvf3JwT7nvZf73UF/fDjhe3u7h/3DQ8SeS+fAqNsxilvL5yuof0drVCnLTAoa+RMEAtkGZE8EEHI4orzM3dM6IBgbyJ/iNe1t2KzoZV5+8TuQU18dn7H9Acu4npa0zqePhKDjqwtY0WWW8TEuYQbErEGA31sw+rWBQeoyxyx38vrN8OrtJaycv/7X1esL+ISwVpL/EAO0QLMEUsEWZuaOKK4YuOOOOZmBOKRI2IsK6gtgiGvX3qjCNzeHLJjXMR5OVNjXnGiDDrmr7UrkN188e6YSmexAeoO1nPt0xsYcaxRQIW5/MUxTWfj4bSXJF2wmuZD2ecKGQihkkmch1Tg4P8c8yYVA1w0AJiW4MhADucKUnmnjVSqXdbEQ5bI2FjHqbVsp6BxA+dN2Mkx9CcQRm20vbKylIrHSD9AcJLdM3WVLaCTSufY8BS54ls1BjNaChNkYeFPesSocobocBB5d72siVjv0Urh7F4g58Yaepbx0G/jdWQbhJybWmge3snI+h/VCiEakjVpNVUSCh8g2Ha52NeqqHZ9NlMzE1ne3vrv13Q199/HD86rorZ5S6bO3Wvq8MXasQOp6Td1Dvc/clIyDGmypNWZ37naYMNLp3zybcXB6Dmp2Lrg10C61iAujfm6xvC2PtuXRNsRuQ+y2PNqWR1vf3fruTy6PGqrIW6o6yZV5zu08WFr1HLnlDDaweqbIGpcjVT2uVhAYa2qsaLlyiMa97rg7GaRyX/B9cbB3OOmlBz3eH3QH3fF+bxC1c/1o4ceNky37VEvfQY8kYijibqGOKzUYl/PGiOWZFojXygmGNQw99XwfdAcF3MPNw0OoHfvrxmanoBGLVnoRUHxlfmbJx7gGEuSXInhNU/lsK8RthbjNMtss89fIMtsKceu7W9/9//Td/6BCrKqhr1eIsGHjChH2JrusqaXeoHH91wtFcpWKgvD+3qRpCfIViyqQ6gowJSSoMPTit+D46j3q1PdJ4uYKiMUX+OEKSIde4cLuUIkGCkubwcGZ94U76nTuQXGgsIeEFyqBeAa683Nt7pLU5J0xSGtNIMIXscHpcAPdcAkIEhK1VWjNIfQR8CB4Yg7tFhRAY8pvQtY8J43OTQnBjsDsMLD8yrJoGUgsuJ7/5mh3Qpa0wh/wdWWzhx/nJQD6Ci/rxPdNbLCfAaWPWEQWblBdYAEAiPR1BfQch7g1LFHpo5v2ngus0wOFKzsXuQe7i94KQe9xW4+9ktxCExGuGTz7x4fL5801JcFKh4WxVNhOgH+dgRlR9BvWw2c8RAnJmnI6I+aGS3eV0NvYJAOhsGt9ISUbnVaC+iekhXOI4yR2PCQpdOCpm2e1BoW8lRlmzGQhbTROJXQHpNjhS+eeU3akNkJp+JjTanKtY3aiMGgpzPK4p75PgZN1NipqvniLr+8l4m81tDhAC97onj+iIoh2lIY7ECm4PILgmSNpfTfyAC9uwcOeC1YQ6mMaUBIVHcs3zNJaa99NxxK8GOEt03GtP8wUpN7lYyxEuvr61SlLZ8Y4+XfG0HTQVUbTEjztu8m6Q6QxeUTc222RFAeUsYqhkCT63oJj6GBMfIyJnOoYAyWeFsFtP5JmIS58hDZbsI9LPNPyCPIt7hQmdd9NMyKMEWEc4oSr6A/pDA0LfBt5oDgQDOB4oX+KBBWhrdgYYK2N/AS+U9+0o9uGBMUVR+HL0SII1vfO6AHubvZAqMY6vHlNBd9ZBQtz2pKw6gnCYwmu0psZSKWP5BbobWYomF5/NX6R4+Fi0PJeZ/OfHaW/Ekl+nbj7P4p420jzV4w0VWWMA8vzxfXm1z92bRX6djBfYqNqSdpO86qqEVcHidBtgBzhJzwl36eiHlomagKpKmoDKjLu0UsoSqQzJWkEUUjusd7cQUs1OXl2YQ2GE2g0CdCULnVbEAGHplFlAI9u/9aYOTlgKGbRTvC7K6kPQlzpDFpambAP0BXqFNSMHSFeNIBnn0zVGl6Aps/QUNhJbTxQxOV5qQEb+nmZMw4m+oSFCeXSMgRCaBC1rGVhqJRsTtVRAU0XWUioN7K5ez/B6TY0zi1DegIX2JGrRtsgetQidgbYdjWMnMuMdI77lluFp2CD9cYzmRV0xxzIgg6zheHd6eUKRACmHfAFvb+x0051yHVwLwDBliyYz17STXZjalFgHVs86KJbwH9f+1cDj63wfjHT/5X+9qDKbtiWdAqcviGPZWilQhs7ir7ZxiKf1MhC2zPD9hcO3N/jxAY7uwdcBvfHccDoZtG0UaMEB2hyQ53UZ4kTg+pVQXw5p+xdjQZW34FgLxlOhGnQN/fetDr0s/c4F4vG1d9a5GHYYPkdLOLPo+ga/sMXUwRDxD/IwPX7qB7dwZ4AF//9G7Eeuf8= +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/generate-identity-preview.api.mdx b/docs/api/beta/generate-identity-preview.api.mdx new file mode 100644 index 000000000..38dcb4ad8 --- /dev/null +++ b/docs/api/beta/generate-identity-preview.api.mdx @@ -0,0 +1,104 @@ +--- +id: generate-identity-preview +sidebar_label: Generate Identity Profile Preview +hide_title: true +hide_table_of_contents: true +api: eJztW+tz2zYS/1cwvA95jClLsvz8cqfYTuuOE/tsuZkbx3OBSEhCQgEsQNpRPf7fb3cBviT5USd312Y0nUktEljs87e7IHAb6FQYnkmtjuJgLxgLhT/FUSxUJrPZqRHXUtwEa0HGxzbYuwyKN+zU6JFMhA2u1oJY2MjIFMkAkcFEWlZQsowzpVUIy1hpMxGzgsKByLhMLNPDzyLKWDbhGbuRScKMSI2wMIhxC48FSx0XTI/op3QEJNLOMiOHeSbYzUQoejuW1/BXqhMZzV7UR0RajeSYAW88TRMp4tZH1WeZ/gLDb2Q2YSdnP/27f/Du6D3jeTbRBqWE0Ub8lksDjGeaRRz4y1C+/ukRPijEZFwVfM0KflugNpwsbPZGx7Ng73ZOUTVdOgH9aDaE4cVsXDrYy0wu1gIQIYMpSIlkiMhy658tkrsNbDQRU45/ZbNUwAJOtUAoNWhnVBm+LRhFk5djLehJjWHsSJsphzWCPJcx/BZf+TRNcEg32u3stHc2t3d2N0ad7m67A3/1eptbnd1he2NrK7hbK2n3C73vk9ofZ0ooPkxEnaOh1ongKpj3r6OR9wpyQKYNm4I2gHm0VkGmxrfTXSxGPE8y9xMYLR1jYLiyKLStrc2N4TMgIjPReP6IRkup3/OpWKbcpiQ4as6rZ5XHNnQPhpUJKjgr2D0QI6mkozTvWQMgaAW3KUjByhnkLSyu5q09IpZ7+5gUuBiOKCQp16st1WoIw6NI5yortRXU7bFU3SpPEjRsYU0ex0SXJ6c1jgtL17nrm6EEjsyMfRGz8JonObgOl8Zi+NpMG4zdGZsCGsU84wwYJynKpUu2bysenXkDEZJV1gKrcxMVT9/Nzuln+Zyg1QfP9jbf6W6JrR0IHr4TtSFwYt7hmxvB3R1aV2akocESK9ffH807XDmhSWdhnA/HZWM8Cp05EEI6dwhBNtXKOqt02+1FXztx+F2iNgZiA7Xde4JYhM97/d2y3BaTo9wYzAA+si36z3dGv2Ujl+MzpJEpV3wsTOuZIXIwOClDRC6lKlQ+pfx6cPh+cDT4F6bVKmDKp4Swj693dPDASjU874FL8t7WiPNYiF67szUa9kS7sxN121tdwnP1JCD7OYcFQiMghCBIWSxtmgDyKI9vjzFypoegUQb/k8qSp9+hnsl/+stw4Q/C89OEqKNxVTZQXQKJZSjQNz1TUDwsR2fCl8c961eCIVfyQJETCwNVS8zi3MxFz5Jl/oH/tCI9DQol6dz++rR1EaodBC7IORQjxMJ719ZJfLiwvDBGm3fCWrDpN9gn0VBYPTHTuLElTE/d4iwTX7M1qDXf7J+y3jZLuBrn9JyP53SowovzhYwCsjjCJ0aOpVrGShGhB4dv+xfHA3hydvjPi8Nz+AtpLZTBfagIVYwoBayCuif6hjj2AqDdrUhAHeBM7LWn+hoEAiCvD5Tul51B9UwpFcsYmOFXXzKjTpqNjJ7Sy6K4JBj9mrGXsiVaa2B3izCbRRM25BYmaFdHv+5HkUiz8Nhr8jWbQHgL86rF+mXydc6EUT0DQgyyMhCQjsAoz3JwKMR9nWfQBGQyEk1bVKqcz+9FbjquGwVzFnD+uJ/0oywH5khM7+jkqaW3eBa9fYBnp7kmd4Oa0kilM5XxCKSALDYDNUKGgrwGwcNkZpnPTmguC3GqinFSgY4k4EU95R7W4uYg08H9r46haVqUjyXwGEUjsaxDEjTChF9jKENLIxTVWALbhwcrgqLHW1o3lDWBqwJ8UdBbVgfsQ08F8hP/LGRnAsyv0B1GDffD3gaVVOrluyX2mBrKfR0/AUneSiXCseESOXS+EcFEbCquZYwgPEU0dCQbPtT0EdBEq8Pe8Jj5sonte2FcqR59AVrL+6wmQxdK/pZT7UxTIGWWELdkWbEt+HCrvdvtjbZ6nHd3ep3tzeHuiG9stHc3d3dx9en9sNxc+ifsYWXkYkD+DgqBRA66JwZo8RWSr5B8heRPQ3J4F/HcPiHuThOAn5BEK19cCx981J46NCJrFGbyiAQvqdXGyX5Uaa4i8NlIiiRexe4qdlex+8TYnX9Z1D3+LZU+ncXS50L5HWNMnguljyHvUbrYVv7d7cM5Q67h/qUvkX75MPD70biR+TXFrd/vWB+5VL7AfL+0h3s+LFrQIvVXtkAGSY9OghEgkYj3iO+KY1KUU9XG4mpvtRlKcFC1pEQE1DRspnPGQWUmVwo54XaNxVpY9SJz1S2HiLDWISBt+MZhqqXKVpXkqpJcZaNVNvpxstGqklzF7ip2/5qx+2AlWXJF0eLrJJtPp9zMnKf59ygtZzCAFd/hqu+S5aeGerWCxFhZYwXNyiEYdjvDzmg7Er2Y9+Ktjd1RN9rq8s3tznZn2OtuB/Vcf1nFcRlkzZiq2dvZ0X93NtdQx+UKnMtmWsfN7b8cPxWOENYQesq6GXQOKr0qa8fu7pKv2lqzd/ix1ldItlFDqkpHiGkwdopjTTEWBvDidAhUKcAXupKcCqBCRzgSOZUUvCgF0DWzsD/KQBQXKIWTlatIFSU5cEhIkGismjU4lszKbylmRhXsGND5O1an3kTfVMmzM5T4GCVmh18jITDQy8p9c9n+7hFuJiNGnDsD37PR67odrsABoCFwmFXWnav6fFWfr3L8Ksf/GDl+VZ+vYncVu3/N2P0D9bmvhu6vz2HAk+tzGNtqs7KWektnUv/XZTqFiueA3JvpiE7cxVUNDkqwAh7SSTlY5ALq+n3nyn0o2jEyZaz2iqNdoT+Ou+cOeAVXd1fIJfgiSpRqOsWQcpwYrM9PsvUnxYlz10c4CXOTwLxJlqV2b339FgwPBr9r8VS2iplK3+CppPUhaHsJkOGJAxe0OICOb7sFWmQqIzEaHHQScWc4f2Q4sGBA2mR+kHJx3G2mcwBLIrOGx/68Z9JjYDGFtuSFpdEt8sQF+UCuC5PcfbssjtA9sixT34OrwXgGnM6JiCJcVc5yjjW8W33BZaq8hH1fd2GxExzWZW8EN9BguE8hL3/5MHhVnrOP/RlRIbHVgNg7BRchZOwXnwVwEiUro/PxhBjvNz68YCSyUQICs4/qXAh2WZx2eQ8p4wwwnlSKkwTBCs66ellYJxbXIsFs2qo0iY4H0bAOGlrnjXmvKHNSiyFVeQi79VGF7EAioEmsAHCMF5E6RnaZFnLxmlzPZeJvBbXQUQuJmn01x4VT7WXkDvJEAAdIgieWtPXsxR29sEYP+zF4glTneUBNeD6an8uiwmrP5qNBL0R6TT4+qg8TCWm5OY05EGMWsmoSsyMWTbS24u+MoetgGFyOc4iiZ7N1g4uGFBFht11jKXRLhjKEIpP4O4bAUM6Z+BCTPNU4Gso/FbuQ/ESWhZj/BC14zD41ZKbHl5CLcWSsI/tsnnHBEBcMHQZYz79LdehYENsoA+GAc4D9yv6EBJ7RGu45WktRnciv0xxMDRGwSlRsuud+7FUA5/9i9AJHl2MAhgO6feA/IOJxdE8L811DWcXuwrwGF/lNNKTZOb05fsvdLUy9fzZ5UeJ+tQlzopLZ90bpe5Dkz4O7/yfEWyHNj4g0vmrGzcyz6trfYXV9qH7v7vHLdA/epStvy/nrUMsus13eey/N31e49zJZsZkxf01r/pbWf/s+1BXqE8OXmJo7moyg8cbXv4ubrJauMsC/8JawjxoeXlxEwqqwTihNeEZX1hAlo4kUtD2TCp6hntcwUvWUkA1aFoRTaMKJ0NjAGIBBCzU+H8oE6NEHhGJlTgDkCnWME/xtc3/lVUOIQ7svWuyDcAe2DXbLeAQG3n3Wvm0+B6WeYqCwgyJ4oIidTnOF96eA7XzKOIToIxEWSxvlLhFA86zKS1maSulyVoGKGLooQov6RvCokxHu/MtI1ALpkbUgjqzf9gfVV1dxgkqQM5FQpOO4Zhv0GG2I3nAikhT7dchiAs+nVyu8OxosUARiyrlgS5vxup9k13EsXt7BO8rkPhutTqsdUvuFl2yge4W2tkb8p+La7/x1aFbdmG445G316WN1P7p2v8gjDbaI6ynukqK+c9eyut2Cy2Bht6AGjeV+AXSgE9xkgPG3t7ixhg30HT4GJMZdm8urqjfGX7CO22AjoPwicGPHf9EJBzMqpPwOzuKnKmzZ3Qy3affg2Po+yOkJbl8GQ38dfOr2hAxHf8F/94KP8B/80KmLCRhEz2+DYocVxnwu78jxewo2/weKeXf3H4x2bTY= +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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[]
  • Array [
    • transformDefinition object
    + +The seaspray transformation definition + +
    attributes objectnullable
    + +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
    + +Identity's manager. + +
    previewAttributes object[]
  • Array [
    • errorMessages object[]
    + +A list of errors that may have been encountered + +
  • Array [
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-access-profile-entitlements.api.mdx b/docs/api/beta/get-access-profile-entitlements.api.mdx new file mode 100644 index 000000000..fe9b62873 --- /dev/null +++ b/docs/api/beta/get-access-profile-entitlements.api.mdx @@ -0,0 +1,97 @@ +--- +id: get-access-profile-entitlements +sidebar_label: List Access Profile's Entitlements +hide_title: true +hide_table_of_contents: true +api: eJztXP9z2zay/1cwvDfTRCPKkizHkmb63ii2k9GNE/tZcnt9jqeBSFBCy28lSDs6T/73212AFClKjpx47po+/dBGJoHFYr/hswuAD1YUi4SnMgrHrjW05iIdOY5Q6jKJPOmLszCVqS8CEabKalopnytreGPpNsw0UtZt03KFchIZIyWgM11IxUaXY+ZLlSqWLgQrk2JcqciRPBUuu5fpgnE2l3ciZFXCH8IP4Yil0e/whpoBxSa7uHr76+j03fh9k00urq9OzvK/oiR/MLl+Tc8Yz9JFlMh0yYCfRPyRyQSGTCMmwzsgC4xpPltsHDLuuhL5bwI7pUG30wwylbIFvxOMa76BME51EmWJI2qTxFebpgmCjXnCA5GKBMX7YIXwB0hRuvBKojxjni6sdSGPT1nkEVUnClMuQxnO66TzWVvDNMlE01LOQgTcGj5Y6TLGUVSaQEdoKT7xIPbxUdcZdPrtPj/udw7bgzZvd+BXr9PtDDoD4Tjc+vy5+aA5+yMTyRI6G5Z9Gci0xuk7/omFWTATCXKcCJX5KUkrEWmWhK0P4UQIdvPTIdnMJOWhyxOXnUS+LxykwS4LAd2+WKRprIYHB664Ez7ab0tx6ceRDNOWEwUH0g0PeCwPlKFjOwUdeyXol8wDgwmiRIAxwM+AvKBVkZjHfSVKguketTcIEMYVc5FAT01GPzrswoMAlBJkgTWEfgH/pH8TFVd4HKRAf22VZuR5StTFeUGPgW1jb17m+0aqDF602LXKuO8vmYqFIz2ZG2CDtNNAwcd8LkMwTeifRNlcG6dRzHejjm9QRiH+7cJ3oiysy37ssQY6UoPJFKQKgo+jOPO1KAVr/MOeRin37RPs3UCRxlGoBFsI7oL5F4FggzssOFCMMt9lM2E8AzQnvUJvID/W0DbRYPcCRTUPQWJuCyPlRIaOoCAnVIqhAKMYsMJoIszhoYlVDHREwsH2Moi5kzZxNhQiQWMQol0YOIxStBQlcNQGEfmRZt5AnojbO+5nQksBWwPbmcq5+S4saEtInEWRL3holeyEem61FYi1FLy3h9fP64b0hroU2s8UqgwtI58lU0uI6p+Y7jZDUwj/zSL9m54XcGYbPl+ibt/kT9FkVBbHUYKLHIqfwhGQiu7xNYQe31VktxpnRIkaIoVGQ7qNxpA1xB9gemFDP0NhFk/VvXnKU5DgLEs3vCL7qz92EoGrLr2Yg2378N9cwL/CNAgil8Li9hbRfQgy28SkosV97VVl9SwYZuIP9sEKBHr6hffBqpviNntSKNFH7akU39Blua0E6g2mXTe1CVD7kxsaTnjdzCb62W5GBrog+wHwlou/qeNTkxl7aLKV3isKo352/nKDlm7xkQ7kClXRbbfxn6qUzwHqYjxfw8yIzeAntudx7EuHwtLBbwo7PdT1y5OEoyXIVASq9Dya/QZiQ6yYoJhTqVkBjLjBNtbROJjiiitGuLKG9vrHPc8bdI6OAO0dtQfHLufC6bzqOGhQ2i6fOhD1Kg91zrMQJpxMYYnqIl2jmh1IywBWmgWA53RtkHuucg2XvcKFB3Yq1xjotrttu9O22/1ppz88PBwedVvt7uD/kJfCAL6RGZ+DIZSs6RtYKmz56bJfRaGaFvKIhPEGoCOf5UshjEgus9toevU3KUhp6MpYJ+9/rCi9eXFdeXCRzPGR8uPUhswq0qt28/TkR3w7Kp6MTvGZHzncR8HoKDwh57kgz5gSv7vwrT2JYcMN3DMviQIdH3UaZzy0PKk5YOYY2YgTeQdp1rxiNNvQQ40XkLiGUmvuqViJ7hpaQZ/xo8x9G90JxIfPOy6RZvOcdn3sCqW6sKvmtEn4pSf/IdMxCFmz+ZzCKxOuS67wx41BvTrIiAU8RvF4iRA2xg/2u1ja2uFiLhNVt9KlggWjPO6DRSvj+xyhwu+fyLmRGVPq4P5laTUxnGqKz7f0GA7Hp5tWne6xw/v9I/cYVh345Yhun7fbbTFDNtOdfdqMgQ2bOiHh/j1fKsxJPli6hEMAbMWAfvi0xc0MU4uoF6cTe3Rq68JPPaxC3mARoiQU4PsQerHM87gRTCA183X2fjq9KIAP0clj2EYP+jotabpyhbC2uWWXdz2XOw4/Eoe9I6/Tn3nHg+O2481mfU843adJVA+L7b84sHTpzZJ1HrMNEWKKf2ONT8/eT8fTXzYVJ0Ul+Gusz8YhuASVTaIQ/kctciIVDFphqhgGdUx8ozkgxSvhQYoOOfZpGlkI9NeM4hbDKaBMJ70USSCVAu7UU4DgTuayom1sBiaSYs0AQf4EoPolQvUfFANwwmdciRajMA1/4aT5fJ6IOdUwKeI4GfQOQGM63ujcTqpVoII0LGISS7xxLADfY40BSw93PFkCMkrmAmQ7E+m9APQEEIlklMLCIxEvH+T0VatmyImcL9JNAlqLneD7VMyi5uyFaM1bjFPCoV7qsgVVfeOVYDimEgrUTh1TZDKlLIC7F2AK+WK2rogNhdPJ2fnZyVTbgiazkxPotjR6iS1dC5qDDGEeZjp5QaPKWYmBXyattz/9+l/Tq9H7yehkOr54X7HMlTmQVWK0F3OdqnzZ8laljMfX+TwTGp8q/CcfoYnrJg+XTSwr3S+ks9CaOKsuoxzYmwP6aJUle2N5x7POrM8P7SNPuHbPc3s2d7sDu99td3qic3gsOgPo0R04s1dO+5XdcXnf7h0KbvdnomfPDjvdI6/b63tdbqHrBTykIul1jLDcfUNZ5OPxuWqPp+PJ5fnol1/fj96dPR+QUDoWYh6Rac5Yzim7k7yKOQIMSMxRd7j3EfMUJCpCVyffjL3BYVkAzJjiouF/aZD7AsbQZTtwRWfBw7lg3MOilAcII61mEyYOYEUNC0AgLMA74LxUxr8pq7AoeWrgvHuJAKICPwA/sEsDv2T/zT6iRD4W3Lc2gKvTs8nJ1fiSzP35MF0Zq+4VUlJISTCP6aUUd95t8jZYpzYsjLXdDg11zB6Xqkih0ESuGl0MajEtEC1WiCmp0TD8fAZFrhEnmypq4l/WqbuTUhmBdUULOfC4NlUUV15epW1IwLnFbg9wCJ3C6N4gmfuomuDqbgbPUAwesnI0o0W95FIVza4HPq2yigNq5d+W9V+yR1h1CBD3NhXRTggHsLMkgRnY7Kq0C6J3qCjFYrPIpS1dGYKUJS0VT62zbYnqLti89E8idwf8+kaGwob1WSKHglh2oCOawJ10sTZJuxGaZIHVsV1FoiiJVoe95i7MV8/vxEwGJZhw53egNd4Bx1+HEvqzvEsFzdeHFceCz161B92e96rHebff6xwfzQYePzxsD44GA6qJCaX4XHwZdr0VAHmlwyjNlv8UGI04yJ4YoMF3r2kSjR3zB922mKbhl6XiU4r7+K9PLlnvGIBnOM/oOZ+vCSG0ryebCmGa8AXgLrmx1JHnGadnb0bX51N4cnX2v9dnE/iFtGpZxygEa3XRLCPa9luAe6arCWBYUgIr4+i/DUO1UawWRUOp/9L4m5mFDXqY0Tf0KJNe1Q1yVyK/+ZSyF7IlWk2II1i8pICH2YCbo+IGHiyIU/vcSLJhdjRfttioKCbomAcRiSPGxwMVOs/Qm9TgyoI2QKMsxZgoHVHVxUqU6ytCHkbOy0pB5wDOv2wnIyeF0Ek2UfHCwloMi0Y/wLOWXJW7aUloJFLcNYG8wqGo7EQJpnJsBnPD9MeEI0ocIfCEebsiYlWiI3LzTjOT43KHZ2oHv7v0IfzYNLXixZ0wzkdYQEcjwVY1nzwimeMD1Nm0KtSVO75eLfa+u/fdve/u6LvrL68M/jZvCfp06tDnOjQny3DxrEGfhKwnjPLjZ/8keGMUSWffDET6+89Tc3oN2otPMe5jPiM+0kt5jflRoQ+zi5xvMudL/0oXyCDJUc/Ag0gk3CHxveJYg0QS1WF9NIC3MwkGGm6AiBA1E7aMMsZBZEkW0qk4rprMjYQKf9hwYA9HDV1bg/s9ktwjyf1qtF+N/jKr0R5J7n1377vfp+8+iiQLrshbDE5SWRDwZKktzbzH2XIGDVaV4MLliuM+ZbSCxFiBsawqcrBm3c6s4x07oufynvvqcOB1nVddfnTcOe7Met1jq7zW36z8uHCyqk+V9K31qDfaRXIHOC4LwbhUGkVutfyXYVXbw7CGoafAzSBzEOltgR27gzp2nEYRe8fDZY6QVAVDhisZYUyDtgG2TfK20CC/qwKhSgJfaEp4HMxmePqS0VFtdF6cBdBNlvaIqr3mALgxsmIUGTp+BhxSJPAjRM0RGJbEiq6HmA8oEIKdQ3R+RnRqVPRNSJ5d4YzPccbs7JMjBDp6gdyPNtV3x8B8gjFiohW8pdCrsx0eggFAQqBjVoE79/h8j8/3a/x+jf9rrPF7fL733b3vfp+++wR8btDQdnwODXbG59C21WYFlnpDZ1v+3TCdXMVwQObNIsfJEio35xiczpfBQ5kuaZBrwPUn2pRHANrRM6UbDnU11o71peUhHm/DOFR/AypC0HqLN3ICATZqLq1jcMIr0kProNpDHTxI9/NB+YCVhTwh+NTzzhIfuuVHYh7AHMAMPrd4LFv5gdMwuqdzMXgeZkN4w3MI2pWxAd2a0gO0SIGJRB/RAZWIa3WaA0lWcfTmUcp0KAzsZBllEEKJTBOPqBp7pcfAYgzJyg/6CFmL7LM2P5jXdeJ//va5aEJb5rJJfI+OBu0ZcLo2RZzC7cqE6LqHHr1mSKvVCrPBbm2wC2zWZa8FTyDt0BskL/7+8/QlmyOepXiir8YJiQkIeOQlmAjFy1G+WYCdaAlb3ZkeVbZj0D+Z58OEmbkCOzZCeA8LyRVEfhIpdhIUbLDX7geyeKXflguvH0KbndK5YjzySm3MFPWl4Js4nxcvzetrmfhbTs02jkfU8AJfhQst2ht9zBeva5FYuK9IWl89uKZnl+jZdF7WRqrrPKAkDB/VTTQn19pX81GhZyO9Kh8fwp/pvGu1G9MhjKkFnfQdM2cRRUr8D2NoOugGN/MMvOir2aJDtjZ5hN1tl1iy9ZC2tAF6En/n4BihNiY+w6WfkE8EoDB0tUt+JM2Cz3+k82EfK3OmxzewQmNLN3KecDN0jWcc0MYBbR0DlOFfL4BoWODbOAeKA9oATlb6p0hgGC3FPU1rY1Qn8gfUB5cGB1glKioe6j+GqwBnfjF6ga2LNhCGEbkX24p4ZM/QwlWwIqy85rAuwTq/fgSL75rcNL9FzQsX5D/bfHHGo1VpBo+qP3eU3hJJ/jxx9z8U8faR5q8YaQyWRnOjYU3SUTby1wav1UuFij5NAv+Ht0p//AhgOyRFq6+RlAnFPk/pyiF6tbOQgooMsdCHjpvMXLUETwSMje4PqSQRmtMl7ARY5pAWSh/oURk8H5mTw2hgiXrFv1VmLuNG5nB0i/2Mh/AdUAvmfHiQA979Fpnkr7ixxE5zZQPoCoIsxIthwHYWMA4m9QWLcKVyMh24IAUMRS6LiKBf0Sv3YjQ1nEKLsp8kUBce1q8l3pK0dhwL9J5/DgBEj1o033pYTeRK+GSZ2K4K279EG6zNXgif7iRD1AUAJkojvBtPaxSBWGg+ZREl8wPTSR1gW7wGDpPX5nPY6rTaNqULeOE5UikkYSXidNmn+tWpH9T6RxDWrg0XFfz9h8Ke+KEws3xi3nMQY0EQlZLpPExnwDfWWgYMvYb6iw9lnUBatQBdYvuHB6whYVb4GR/rT5FgagzWhS7vbr42U1bj9/WBr41C/F1gVSb/fpmpu1h0P2V3Ofz/+jLXI3Isvlz2lYLcf2br+/vM1iPmkH9L7SutYf+trL/Wt7IesZTVl9S+0lb2H7va9LGrRyS++tbYSuK3q2LvE5HAiysDnl6y3b5PupGzfCM0XJbZyjkGNENfT9DBnhjUL/TuV6lL7XxIZePg7RniYr6lMmF+DG9wL+NfeiCOYg== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +## Request + +

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[]
  • Array [
  • ]
    • 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.","example":true}}> `description` property.","example":true}}>
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-access-profile.api.mdx b/docs/api/beta/get-access-profile.api.mdx new file mode 100644 index 000000000..c43b14ea3 --- /dev/null +++ b/docs/api/beta/get-access-profile.api.mdx @@ -0,0 +1,121 @@ +--- +id: get-access-profile +sidebar_label: Get an Access Profile +hide_title: true +hide_table_of_contents: true +api: eJztHGtz4kbyr0xxHzZLIczLYFyVumPBcZzyGgfjbN15XckgjWASIRGNtF7i8n+/7p7RC4HNPip3SfHFFtJMT0+/u+fxWAlWIuSRDPwLp3JamYtoYNtCqeswcKUnKrVKxOeqcnpX0e+Z+aAq97WKI5QdyhX2hr7ThVRscH3BQhHFoa8Y91mxE5utmYwUuxjV3/vv/QGLgt+Ezx5ktMCONTaenP88GL29uKqxyfjyrPB8c/vG/LwZ306G6ccgTF4kLRiPo0UQyghGU4DN77EMhQODMZt7HosMnnWY3IqHfCkiEeIUHysS57Hi0QI++fABfkkHnhMYldMojEWtouyFWPLK6WMlWq+wlYpC6c8rT5s0uRixwIURxQYlAKb4yJcrDzu37H7zpHHS7tm82+23nUYTnk6cRr933Gg0O/3K0z2ioFaBr4DwMGqr0cB/xbEGCbmzMezAj4QfYVu+WnnSJk4f/aqww2N5GsHsV2FHlc1ZlHBfhSg2kdTYAIlKlCgLh2CfQgzea/YbTqMrgBjNfr994tpOq9Hrt4gb3Bn73lpz4ylh1UsoXEGrPRA4g//BWgjL4RGfcSUsHM96AHkSJQaXx/Rjz+MzhKRFZUMefDcIl8QFxmdBHL2EzTDwPGAJtgfUgZcy8sQS/iuUZ8TsiDAjOMKgzhLUEV8bGkViDxaNuAGzobQPXLEESK2i8YfmMIawIrncYF+j1bQabavRnLZap+3W6fFJvdno/Gcb25aBI135pah5XEUsAVX/BAxb01bjFJBs7cZQ+MjKPIKzIPAE9wlDl8detJ3P7xYC0A234QzGx4Cts4tt0phrgV99tg5itoxhltK3vdgRjEcMkIAXgS/YWSYT9fxEzRSCB1+EZWMxxtc7tWHTHGRC7XJPiU0DoJuXmSj8eImu42J0djW9mP677DM0Gtivzsh/ABM9R892BgItiYqecCOGOKCxVyJC0X+VAH0FVADKrOIIfAE2f5AKSMQ6jQZ7wx02AdstAJwIQ+j9IAEK2FLgXIFaGY5As30M2oVDygguxtliv3in63LuCNFpNLvurANm7MRuNbrtfmVve/V9vOQ+GR8kPXOkWnl8zfycGSPmghiBAsAXIFiBUsFSRqC0QBwgx/X4ZoovrwfT4fckeUDIGrhjTWzQGHtBMO04DGFq7AP34uJAr1QBiS8it4pXqyCMKk9ADpLfRBgmwhUwvk22SwVxaIttDupLPdANQdahh/6zkIYAZW3kSgW2NAZwk9X9Xq8NjG53m+Cq2q4za8y6jW5TuB2cwUuqoUOXbcGUILUo4lvTBOXeA18r5LfpnsfKvNpbzHCkbbKVTdoMXhhlPLqxBiMrGSzHxUIMonsCTytkTTPvlcOLhyFfv+g5B8yTaPE2nGAOS2JjmYEk64k9RQuDFkwHgchazwsedHA4IwcKGp2JNWiHL4RDvhZjKY6q9IzxBUe8VC/HU7lexqYDY0CH1ErY4MZssnEwU04TqZfEfZdQ7RwFNHc0HWs7mxM+sniXZ2/hP0pgLgbKfdjTHhZHgwj/GVVpQVQrmm3RbLUaffrxnLg+LxfFcfOCXMRgePVtTnDqnX5DuI44ro1vvx2H82GADzci/CBtMRKrqDYafvv9j4MR/vcCyBsKMp4blGT7SacIYPc0ol83XMiBZh8kN2KRvK6zobbY3roGZvw3EqVS5uUH6EoyOAA2gEiHGTsMGsAgbgLjr6JgCelQqjGpVvniITXuQxgOHc840ZQaqEWE2oOjo7JQvLgFDwLHjXNh1SppY7WKPirK/L/2GEp7LvQs5E22hTeaFgavYeC7co7kf8GWFAiImg3dYp0GExkIlVR5n/c9drAkUzRJc8St3N/FboNEFowZO4OE1CNqBw2DfpAOftbDsV/hrXTXRPAMziaJtqmPEUQiPSU0vuTe8POnAVyG7BLwg+ftuD5gGAvjfAVs9Ujcu8HcVXy6H7lEL6JfzRJsgPwrLWwEvIzkTrteFIWECtMXnP7g+vrn8burswm8S/6bGkby8+3ganBOT+fjn84mV4Mr+Hg+Gd9el2OFkZ6NUIS19B0J1I85xYDzMIhX8B68FlkSKiJItAAo5ynnoDESoc5+QsUEtxhiAABt0D2q+nu/Wk2RrlZP2TSJCdMUIisvYGmnWk2bFjKNnLveMAyAzQTETHfOE6MEw4Rum56/ZGs0KENIhPKW+3yewUkjeGM0cyzXXTcpjzAG7Bw57HOIUNk5EremgVFkqYNIILTx5IDbbE3fq9VEOC4cMHdk5gr+qcTmVNaxy2dUGpxknmlUkYCrsVgBZmT/STPzcovYl3DJI9rp2r3+SbNv8W7ftTp93rJmwp5ZTfDxvSYX3a7d3R0QDgrqC+1yDSeJf5IesKVCTvVDoIXqEy38JO24n5Wvv2jm/1S7s4n8wQQdTNDBBP0pJghVLzNASsz3TVc3FXTXksClSWMvRgr/JSPUmISEz4cYHsLnpBiBCxXbqhFy7utaZ0qTu4rbmzVnJ7xtHbvCsTqu07G40+pbJybb6olmH3q0+vasaze6VtPhJ1anLbh1MhMda9Zuto7dVufEbfHK/RPZlQ9SAc4wiyGWmEPJy3XEd8Q8P5PkBejsEiI2CWgh8kGMAWDgl6suNMdyhlCot9Q0EcTHFdgNRIaKo5g9kNbxOUTKCovogcqNhgnIIsBXmKPDr3QuO4sEWxia0vYxWyTDygdaRHshPQeSLlo1yn8dXI02P0NmBKYxjlAoHIyi8+2H46vp4OLqBl5TTgSvQDM4mPynWrHrUpuOl/vf2EEU1YceD3+rPN0jmC9B8OzH28FlHvy5nOHy0SZ6kfDEagH0voqXs33QPG62EL37p5c8bw7Obn+Wonk1nv6c/sgN+/0A/+rZAwtLHuwmTYTT8Uhsr7epQaFWkgyW2JBtPcbpHNCmZmT7xDUrFG+WdjdFqwjTR72YUK2myGNOrUj+obvGscYy4tRYQhtaQQXq1PIJeG7dtJDla0NOaZwkdw76W87NK2LJpVdSqaeU+Z/qSW6omakawKxxyjto8nAUHkV5p5PnaLrikr55gUhAmoxOX0SfdK0nxRS++kHE9NwsJIhD9Xgq8c6oEAAOMdLFSYpc0HGtQkmLYUkpL6W5zUNPiLoNXZp23+3Puq7zL+SD9HkECEAyTsuBqeaXPNqe1cuRcKUPARotGeBMbSPkSTyXMEWLZ2p70ygpCwdeWFg+aP5B8w+af9D8g+b/LTX/oOl/nqbvIPoADQAShrqk+lxnyTIAZqUlYoJGIdXGk1pxrTTZtpHuQqizARiLj3IZL7VEhwK/fhAe5b6p+cBaT7oSVcutiXqCu0BBQLpACIRdkrSn59XxEodt00Lj84tDf12S7EWC1oEEzXTFVq903ZldUmYNOt13cr+jgoQ1IwDQ2bYLc+hJXNY/o+0vFlAM98JmFEuq0bPAod2p0geDJ6mW89mbNYuu0xERGIQhUOdl9f8O3Lk1D7lEDPWOHRs6mgU8JPUyACZokIlP2mL7gRL1ZmH7z9BMBtkRchurm9tLiEWEbn35O5p/04VJx1Tqtw4reoLPuo1+q+N2O5y3TjrN3vGs7/J2u9E/7tNeqyWwjc+3FuyLQ58LEAGITGi1X/4hcBWaK7NUQIPvX4UnGHvuvdFt02kafMH9fYxqEDG9GV6zTo953J/H9J7PN4jgW7c32/yuBjwO5Vw+G0aNzr4b3F5O4c0EXOLZDTwhrFK0NPCpsG+jp0FZWAQPhLGZAO7FVAI3q6K/rBqoVZgQ91W+odS/1BpCmCUzC7zQw4y+pUceNHPDYFlQJdKbjxH7RtZFvQaWJt3OhltgnaT2WEUVXkXWpaFklS0Ed0T4GsyR40icJPd0+KGS7XTccfT+OQTgxqDKuniJG3fBr0t7wz9npNw0sIkducwzBZUDMN/DTdsRLqbQNPNamEqLQdHwB3DWlCtiN80RjUi69iNuwyy4562BjGGIuw0gbqFN+sYc0VICGB4/aZdarMKGGMTmrUZmFAX0zeax2kPvrj0wPxZNLf3wQRjlU2n11iFuJGwyFskETdTZtErZlSh+utBx0N2D7h50dx/d3fw4MWdPzFcKfZrl0OfWNwdv0HmWQp/QZEPJ6Zw/dOCoGUlZmAmRfng3NQeD9MoPJWBfLz7Srrx8eiblx8YifeL6M14ggkRHs5UALJFwTgnvDGMilCZVuzzad0E4kyCg/pYQEaxmSHv+Mf4NY5+2gnFVY04glP8qYgsO9tFsAiQLSAcGHGsVSL0N9RBJHiLJgzc6eKO/hzc6RJIH3T3o7l9Td5+NJFOsSFtMnKTi5ZKHay1p5judhWHQINk9KLLN+enqQj5aQWAsjbEqxcihMms1Z023Z4uOwztOt913W3a3xY97zV5z1mn1Knlff5fpcapkRZ3K8VvzkUgMQRzuh499EC4VBYFTLP8BeUPhollD05PGzUDzOu6KSWLHVr8cO06DAPcRrpMISRViSD+jEdo0aLvEtmHSlo5UzMEu+gxMlQz0Hj25FAAlxFUHTy4lKS/OAuCGa2vg4vkErSiJkKWjmEOpiiyBF+jzHw9cYs3XxZgPIFAEi3u1vmJ0alj0RZE8m+CML3HG7OyjLQQqehq5H2+r717gyRe0ETeawTsKvTrb4T4IACQE2malcechPj/E5wcff/Dxfw8ff4jPD7p70N2/pu5+QnxuoqHd8Tk02Ds+h7b1Bktjqe/ojOefHaaTqhgMSLxZYNPtF04Wg9MZEHiJ50FwkFuI64dalAcQtKNmSsc/1dVYa6X3B5zipR1oh8pf9C7+yj1e6bQUIKPm1i00Tnjv1GnlqNhDHT1K5wn3JFC8qacahx60XETRSp0eHT2CBADnn+p8JevSHMTwgwfcDnQ0A7JvsWj69gOURmxA13bpAerEs1CiWmgbSsA1B81Z3IoCTlK1+VnIyW0S6yAGq0lgaripyYgovQYUV5CfvFLmyD5SvDQ/mNdt6D19+Vw0oB1z2Ua+Z0eD9gww3ZgiTuE+k5rcecGS7GQOChPAVmmwMTZrsTeCh3hanNZEvvnh3fQ1m2MISyYkVhg9m4tyOLsGESETOUjWB7ATea0wiOfm7EthBQZVkrkeTJi992+EYHfJYZ4r8B0TMPZEUuwkyL5gr/tvEu44uKMG3Wo9oyQKHgj/EVDoiBf6vSYXSrmGzO7Cqr/3LTaSob7pSlEbM0V9M8bdKpkXz83rc5H4RwLNMrpG0NTrDSw0ae9svaPHBruAILiniFqfPbiGZ+XgYWIGbxDqJg5ICYNHcd3MTrj22XgU4FkIr4jHe/+dPqJV6Ma01WIK3KvnsAtz0uqfjKHooBrczWPQos9Gi86FWaQRVquRQ8nSQ1rSgmiT8LsExfC1MOnL1CjYCSAO9B2tkr8QZ0Hnf4Fc3GG/FOZMr+/AKWNLJ7DVZ+OMA1o4oKVtgDL4a5+HggW6jXPQN0aQAAwz/pMlMIjm7J6GtdWqE/gj6oOuwQZUCYpaneofp5mBM0+MPmDrtA2YYQzW05VEvB3RwELHVyBWUmbYpGAZXy8Af7tBN41vWuZCH/z/Nl+cce4IMd4D97Wt9A5L8v9jd/9HFu9gaf6OlsaEzyhuNKzJM/JC/sbEa+XqIF3RJfBQ7/UF6SpF6pAHZSd484BWHo9Qqkmr7YUUVFdYCU63HdVQsoIlaSKE1aj+kD0SoDldVBQCytwz576p8p2MzElhdGCJfNV7kvW9PHTMGPJUUWfvINXzbWALpnm4dwO+/RqYfO8GOHONjGWjhNkMr9uJfTwwDWjHS7xV7CWJcKSyY5XcReaLhBa02ZqlvRItRlHDKdDVFiJcqrFr7rfKMf6FsYDvytSrgfR07Ya+FTebyER4+uAMtCuG7S/BBmmzFsJbYaIJVhcCMJEb4e3FtAQRgPl6a3Y9COdHppM6wrZ40AQmr8WnXW/WGxalC3iSPVAR5F054OciKp883xTCx6xO/5e829h4LUw3jlZYekNaxDr90bnmXWUj14Rep9LBfe8LoBk2eHzE8gxmX0/4+vdYYO5/d58lVpSQAk/NTanmgtCdlPwmOUPw+rn7gLfinhQX/XVWV6jA428CyxGANx0m1/Uiwkp/0BWlXJfSmkshGT8/Q8HjO1y/eQAKgHH7L2Weohg= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

+ +An AccessProfile + +
Schema
    owner objectrequired
    + +Owner of the Access Profile + +
    source objectrequired
    entitlements object[]nullable
    + +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. + +
  • Array [
  • ]
    • accessRequestConfig objectnullable
    + +Access request configuration for this object + +
    approvalSchemes object[]nullable
    + +List describing the steps in approving the request + +
  • Array [
  • ]
    • revocationRequestConfig objectnullable
    + +Revocation request configuration for this object. + +
    approvalSchemes object[]nullable
    + +List describing the steps in approving the revocation request + +
  • Array [
  • ]
    • provisioningCriteria objectnullable
    + +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[]nullable
    + +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. + +
  • Array [
    • children object[]nullable
    + +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. + +
  • Array [
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-access-request-approval-summary.api.mdx b/docs/api/beta/get-access-request-approval-summary.api.mdx new file mode 100644 index 000000000..3a9b69b0a --- /dev/null +++ b/docs/api/beta/get-access-request-approval-summary.api.mdx @@ -0,0 +1,83 @@ +--- +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: eJztW21v2zgS/iuE78O2QeTETtpsAhwObpIWWbRNLy8ocElwpSXaZiuTWkpq6g3y3++ZISXLL3lpt7jtFv7Q1BaHw3l9OENTNy2bKScLbc1R0tprDVXRi2OV5yfq91LlRS/LnP0s09NyPJZu0lpvFXKYt/YuWp5MBDpREeatq/VWovLY6Yy4gufZSOdCmSSz2hTCqaJ0JhfFSAlTjvvKCTsQGca1Ga4LyXxUIqRJQPtRxQV98Ys5v1geqLBaW5wqJS5b9tooF+nksiVA4iYik06OVQHufZXaazGwTsiyGFmn/2B1hTYD24ZCNSWpddPSJDLzwJjBCL5W3PEkj0dqLFt7N61iktFYXjgI3rpd1FoJnZBupClzECSD189hTJlCF5OKoqHSEezhVI7xdR7C01LVhqsIRe59wqoRWZ6pWA80zFXxbl8aIcSaOD559d/ewZujt6LMoaeIpcG/NMU0uOZaFyOYezIV6ejAr7l8Pk+HoFYMVBFjKjNqaADTeqUdHHo9UkZUBhRYztiC2CQV87fwxTIBrUknQaeJWBurNTJfJnMOHe2I5xKJ4YjlPhw4O44SWaivceJLTBI0iQQnlfgzhWahx0oQTyioYQQahM/KtCCDwiJ9OGQEGeHOgj6VaULPYBpJosIWR6fH0a/PNzvkwLEsLs2lUV/kOEvVnqil/Wd3s7sZbW5Fnd2zzu7es929Tuc/rVskGVbLrMlVTnp0Nzfpv1np396dXut35VYjDmGo2JoCFibWeJ7qmFNn42NO/G8W7Wj7xJSSyhGuFNpLF5ZvEAIJ1FC51rKsWUCFe9KfXFbp9NXsp1hzL//KUl/N/xHw1brFAojglLjOg+3tLY1uL3PtfqrhF3HoHJIiAgoTNlDmezCZx0BNOclR9x29mqhC6nTfJmoxkxYSSRsVDZ3UJKRiqWNMFKSwZh+PrUN6McsKEpmOBA5pAT4wRrsjXsik3nj2gzJkRyfjT+B1lDws0LnRmC+qKQTVFY4uWVbtKNl/vrnb3R4835ay++t2Z+dZf3cgt7Y2d5/t7tLqY7hYDr1pwtrSOTlZWPqVAhjqWKQWGKz/ULTPSdieBeDFMUUXapw/7APm8Qj7U2B62lrNIK8o1BfsM1K82H8ntndEKs2w5OdyOGcEE52fEqCWaSr79KhwpYLmnvGx00NtlomikBJUMhwcvuydvz7Dk5PDf58fnuIT8VooGHq0OScUlpbzCDDKEgcFrmUucpVyarXFWuC6BoVkqCsCYcDsfJLDmIitgQQ8Y0ZYfcmMJmuP7h7Xfahx3nwpxBPdVu11oDmeAbiB/n2JDQ07FpOvUWmUFdHrYMk1MVIyUe5pW/SSRJOS2L15u8oxf0LbgkwSyl7PYFAimxXvy7YsaMPUsZr1xdSUs96YgsnrplMoOSD5w3HSi4sSwrGazSysoyWIGPwDmb3lZqU7axiNTToxhYyhBUqFCczoHCws+tBNAw0DHJG7cgCPqehqxGpiJCPeGy/MQWF5LJZl/oi8e5cCfiJWrR74rELyIQxsQCP2RuWmgEgYJLV5cqCq3VUlvkDtlSar3F3l7ip3H5m784MnoaYNo1z9dBarn3NTtXJQYqH6ccq3GXP9nnfkOnURoUr67f0ZEvsT+hNqUL9k2qnvWR/5rXxB+F7tD/+8T+VH7awZX5CAbEevwQBIpJI9lnsqMRvKm2prcbWX1vU1AtQsqRK5mZvYUkiYzJXGcK2dr4vEqtz8UoiRBD6G4pUR0DfyEXfyq0pyVUmudqPVbvTz7EarSnKVu6vc/Xvm7r2VZC0VZ0uok8LxuY+0MM6nggIEojpdFXXKsavmqxViJuoaqzVbObT63U6/M9iJ1XYit5PnW7uDbvy8K5/tdHY6/e3uTqu5119M87hOstmcavjb+5FNjCKOfk8oDYIrL6xNZqKVzOvUgGCNoKeum2FzmPSqrh27u4u145m14g39MHBSHVw2a0gztRFhGmjHRFsfcvJJ9xC4aASgSlv/Wwgdm0fC0TF6qseak5e0AF83iXoDOq30iVIFWb2KNnFaQkJGgtRS1WwRWBpKqgHVfODAFewQ6Pwdq9Pgoj9VyYsT0vg1aSwOv8RKUaLXlfuzZUe8RxDeEUacegffcdbrux1pEABoCDxm1XXnqj5f1eerPX61x/8ce/yqPl/l7ip3/565+xX1eaiG7q7PQfDo+hy07U1R11IvKbj+72U6p0qQgMNb2DguHR83VzU41xUIpXALiy8mFSN82fAHsFFwVVRfHtioPkV5fTvLNwNezNKlmD4qiizf29i4gffgtdu2zHS7ujdj7HU7tuONPky2BI3o2oDPPCIQvXdHodtos72dppD2+MfMvfVZQwpeeIFPiu/lTNdzyK0TWwLxmM26QPiH8OLHEDFDb/FLztRtDqcF/aDXuUtv/7wuntEduiwz372rgV5A0jkVSYUrchfCAIzYX+eQZ9+DV68k119cNWlOqVj3Ei5QTjcgavC6CwIdE1lXvFDSoZPwv3k8+e392VMxpBKVIaLMqTpWmnoKJNk7hBFDYK86/6dJvCs5Ww79jafezC8slHJikMIo4tLQvbyLo2Cot9gbTgDmbHaapBg/aNbVk8qDifqsUto221NrU3DqxCDU9YacmfeUt0juJegmH92gwtP2pYnEgSbk0rTVE01QkVtDcZFVesmGXt8qxD8qblFIUuaWP52Twpv2IvaXdmLkPbGgm3JkrW9e3POLGvyo8cIT4jovA1kiyDH7u1hcee2b5ZjhFxG/WTkuzXu+Izc7TXi4q+7GHYl4ZG2u/iX4SielysWwRKZ9s1h8MS/ijIi6mw2RIr9kpCNUkyzfaySG8cEk+7SbczFjUeeZxKftB/YscOEDX//7MKMzP77ApkuUiY3zb5aZFoxowcjjRB7k93saBRZym3RgHPABsD/1PyNBELSBjZ7XUuRn9hs8hy9GQlTmkmd7/sveFATDJ8EDRF3TAKqpGK9/KaQroYEXbWwzxqqOEeYtuChvarGfztnNy1sfY9Ee+6PpSxr3pqctxyadfG+UvgNJfhzc/YsQb4U0PyPShPKYwo2XDX1EM8hfhJpu8fSPjqdHCn8xyrnKlTj6HH/vnaqYJqMslQVFNWd1PNKKzw0yJQuqD9cpsuyYMxG1N6W/Chfohw40SNscdavs65Su39PJdrWy5ITxxSf5lb7nJTcvtFY8Qh+q2uI9WjkTwy3UxtHdDIx9tKGfO4Vn3vFbFAeVs1F0jceloTvwELscC4mQeiAiEp3HpQcudHVGVbawXPrVs6osplAjFdrc0LhxfjygI2l0uw3HP7AW/J6H82iYnrwYruVPFTlRKUcm0c2W9g/xRrRFI5Vm1EgCdVGAqcYKb47OFjiCmcmhFxp264YbYVK+QbRgQi2UD5+tdqe9GXFLgeeZzQu0vg3mr1Txnd5kmY/cm+nh/Y/+Bk3Y1agd2cjo6I1sVfoWyjexF627mthWdX+/0cai6RnB0jTt5oYObaivu6XH/p0Oapbge0pIdMsDcFH3Gm/1Is5f8SLOHXHxSdGRTuONqnBu0+I3dx7v1h/11Zx71W6+hDTV+2p6AMFNP8KfjyI50P1Ef1jZmLXwcx5xqQ+QXh0Cx27/B7gam7A= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-access-request-config.api.mdx b/docs/api/beta/get-access-request-config.api.mdx new file mode 100644 index 000000000..69f2c3d91 --- /dev/null +++ b/docs/api/beta/get-access-request-config.api.mdx @@ -0,0 +1,95 @@ +--- +id: get-access-request-config +sidebar_label: Get Access Request Configuration +hide_title: true +hide_table_of_contents: true +api: eJztW1tz27oR/isY9uEkGVGW5LtfWtlRUp+J49SxJ9OxM3MgEpSQkAALkLFVj/97dxcgRUpyrFzannNGL3FELhZ7/XYXgu4DnQvDC6nVaRwcBRNRDKNIWHsh/lUKW5xolchJ0AmsiEoji1lwdH0fXFlh4E0h7ophWUzhWSBjdcRpZWjc0jCitUdG8Dj4+PCxExR8YpHW7cD8FjaAV7GwkZE5ygFSXE6lZULFuZaqYEYUpVGWFVPBQAgj4Fl7K+a2Kp0iXRDXCJtrZQXsdx8Mej38096jLQQ7aXJgL0XBZWqRU4R6qgIZ8DxPZUQUW58scrkPbDQVGcf/FbNcAF89/iSiAhbmBk1bSCcDrDX6C0/tWWmLYzG6K4RRPG0sHGudCq6CRWOcJqwwpeig/orVfFgGjNhYMPiMmoiYjWdMeL7MzmwhMlRA3PEsT2EH5PLQCXhZ6KHnMlJ8nIp4fSkYVzHzVhfGf/oixS1+MIJ8ZHlWSwt7ZWCwiKfpzMvuiCo9Vkno+Z+rYzHlaXKe+Chc8mHlvHPFHCk7T9qeRPZPOCZN9e3F4o5DNdNKHM/c3/Xsw4mWRVxVFvJhyhJt/NuVDlkpwQho9EyADGdc8YkwawrBMkf+mByQWltTeB1LA+YAilybwi7LBYIVssCPwZJs3h8ou3fjhcikioUZqnhkwdtk/MfcVkUfq1ZRHM3XfasLYz6zV6qQ6ZxFw1gAIQLNt2ist2U2hq11wnA9KzS75RIzCqzkYjSRxqKFnJBdBuZVuv5sKeAr5BGxD/kCsUs6tFJf3ULU0qKK8Agyxcm7PWi6o9cJVJmmmKl1zCC/Y1HcCqEqI9of0Zk41aqBmoVMPNTZb5cu43ffItUZv5NZmTXMtVIQFNdCVcC/aN0aeLw9q1h8yrDAGrcLjvoNNfor1EggM8c8+uziVZgLkawC+va6xeB01PUqWxipJksmuAR9kIKyVisAS0D205ejt5enl//ssksfVFhLQ3zd9EBQ0WFCyvjpzU5jKGhQy5mMW3kf7Pb3Dnr93Xh7kBwc9iLe3z3oD6LD/kHvYHs3HgjcQAG6P73F30uAoRDFRcsA2Ng85TOGi9G/0kvwlGbDVEKdZa+EmZRW4/ZQbGX69P4jJGM8jg3i3jfsyGnHbuJ2/Fu1zGp4GOksaOJiZUeICwFdSSQ+yGL6FlREFCQ5m9TDNaASFVS0IIO/7R5sCUZHc8rVbcyaxW+0tOMapeZVyieuriELcAFrCF7Vna8U9xOdISX1mVCJ1mlB6i0NrcE9I8+F3U4lhJktx5ksCnwDafSIQLFIeJmCjpDeVjQEpM+IrUJJEf9XBDQC3fCD8k0Mrz1VBdV7bEObgPNYYtS117oVJC9xfMyHLmEQlwCSRJYjblAhrPEWXishYhF3b9QZiC5z9IXnX7WpaAkeWpFzCE4gZQh5sFrGNSnW05tmApzfKmFugg48tbo0kWg88G3OTUDNw01wq83nidFlfnQv44eboClL/c6yZxNEcsUhW5l79LzSrbSkQdMFzW1XIP0cNhaF7rDGyk7Vk3Xmkhx5XN3Z2+slO7vxXq+/t9ffjzk/HPR7uwc7LexYTtEKMJoAs2Jwe3hAip1VA9BJKtHNI2MgAkJAEJyyYIoA57rq6hBlrOMZelgqctZPHIliGrJOdLxGPXkllQghTCVKKEjkCBbi8PNFxhi6GbYAjiXiPapAdO0KB5bo9tkxj5uIScqgIQ0Ue+B1ukYNvVIS1rNqCdQXyqRHthX7go/3eoeDnWRvh/PBwU5/f3d8mPDt7d7h7uEh7g4ZYCFImjnMjeGzpa1fC4gpGbFUQ/WQ/xY4gnEskygAbQ5LJEx/9mkfEI81+xNHW6vp5WV4CtCBueP45B3b2WcpV5OSnvPJghFUePV+KYtAc8f43MiJVKtEEQq7tevg5ejV8OrNJTy5GP3javQe/oe8lo4PhgqiNcaw1NRNTvUtSewVuOUW+sgUzIEw9MJzfQEKcX/K4Al9F+9GaeZBAVb43VesaLJmidFZK5Uid2TCnsmu6HYAcuAZtKbRlI05zu/Y4gL5C0zkvAjfeEu+YFNoVYR53mXDOJaoJIAuZGOJ8MqpVYROB1PXMUhKSGUQBroRXRbUQ0ftybNhykVMq9DkTdMpmBwg+RrlJSpKEI7UbGZhHS1eRO8fkNlZri3dZcNoZNKZKnhUHSNE2tDoOgbdJJRWD0foLgvAoyq6GrFaSIrSnDlhXhaa3kW8tGvk3bsU4Cck1eoXX4RPPhqmHBqRNyo3eUTyIwst9lS1u6rEh3lTpPEmdze5u8ndNXN38eWFP/b1b6n16S+3PleKl2BfQ8VzqfUxFD3Y4Hoid/rgHNlhYBDfIv364RIS+7NQSC/uchwTfmJ/5Er58ulZ7Q/3fIztR+2sli9QQLKj0yABJBLxEck9l5gM5Uy1vbzbK23GEgJUrWgRATUNm+mSGndTKkWDje2wWAurfinYlAM++rNHQkB3rB/Suf6mk9x0kptqtKlGf55qtOkkN7m7yd0/Zu5+tZOspaJs8X2SLbOMm5mLNP8eteUMCFh1AYHVKUeuWuxWkBmre6yg3TkE40F/3E/2I7ET8514b/swGUR7A76739/vj3cG+0Gz1l/P87hOsnZONfzt/EgmhibuC/RxJX1bV2gdt4//SjwJThDWEHrqvhlsDib9WPeOg8Pl3vFSa3bG1ay+6dHqIdXcRohpQJshralogYCzCeCiYgBVEuTCUJKZAC54hMxSmcn6JBn4mlk4TPBWgkuUKsjqXaSK0hIkJCRINXbNC9/5mhl1sBNA55/YnXoX/VAnzy5Q4zeoMRvdRXTazurOfXfV+e6p8ldB3jsHP3LQ66YdriAAYCBwmFX3nZv+fNOfb2r8psb/OWr8pj/f5O4md/+YufsN/bnvhh7vz4Fg7f4caLs9VvdSr+hewP+6TadU8RJQeDMd0U3oeN6DU18BoeRvcSOGcLyaHWytvJYd4JVu7AudSKVJgXRaFLk92tq6B0+Bhx66PJfd6gqU0rd4A2prDOZZgTzzW49IwIbvTv1k0SXbGonh67COmDtL1/cswOJ0KvxVztX1sZkuAd2ITQevzflQoscgYg5zxC+WqLsUOkv6gV5XJn34cV0co0d0WWW+r+4G9AwkXVARVfg4v4HfuOqzdA9/XkhwUBssbXaOZAN2LLiBicB9d/Hs1w+Xz9kEW01K9dLSTSCJswEkyzsIEYKyYXWOj4uouhhdTqYk+LD1TQmmDktSUJjdqPdCsOvqptxbwPgLAGUyKS4ShAO46uOzyjux+CJSLH/duSUx8GSstsBCW7y17jmVOpoJpHJ3PfHq240K2Uu64oxXWN0tJ6cijXjsOq/04g29vleIv1TcQp9sxM0+X5DCmfY6cjdvIshfZIGX+dFa37254xc2+IV0oytErosyoCW8HO3vt6LKa98tR4tfiPzactyoD1MJdbS9jDnYYhbKYBqzUxZNtbbir4xh6GAaXE9KyKLvFusWNw0pI8JBryFS6LYMZQhdIcn3BhJDuWDiY6zK1JRo6NdU7FLyN/Is5PxvdO/st5bO9PgaiidSxjqy3y0zbhjihqHDAOvld7UJAwtyG3UgHHABcDL3PyGBF7SBe47XSlQn9lu0BktDBKISF5sfuQ9Hc4Dz/2P0AqlrGoBhbKrrb/zgM/O8HtxPT+bGqo4DFi24LG+qoS4u2M3JWx9HYa38vemLGg/npybnKp39bJR+BEl+P7j7f0K8DdL8GZHGt7kYbrTtwjV8DPJj368tn+JZ+k0P/AtvKVepo4Z5hSYw6mKajPKUFxjVlNXRVAqa/3PBC+z9OtUv2yATq9/fWcdoYoAG0pau9o9l6n9zUO/MKWFcY4l+xc+2pCEE94qmME+KLvsAI5mKwC04juEdC3j3Sfu57D145h39NvJl5WyG99VLhb/qALHLjHEIqSciIpY2Kh1wwVCgRGULTa1fvarKYgw1VIF+ViBMZs8TPFqGqbXh+Cf2Ar9bf64Mpkcvut+TBHNFLoT7SQTStdv2p3hDtIVTkeY4EALqQgMmGjucnV4ucQRmyl3U7moz2fKL7BbSAhMcj1z4bHf73V5I4wI8z7UtYIRtMH8tCva1X5QuxuP9/Gj9J/za1ZcTnAO2cjy7QiFLN5e4KfA6WD0Fwlwx1fiDj+vg/h7PN3AsesDHQIbD8/XH+cSDn4CxO+egsfGzoPmaTkLmI/TydwU4v9TT6esROoI/Ugr9f3Crh4f/AFBRXc0= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get Access Request Configuration

+ + + + + +This endpoint returns the current access-request configuration. + +## Request + +
+ +Access Request Configuration Details. + +
Schema
    requestOnBehalfOfConfig object
    + +Request On Behalf Of Configuration. + +
    approvalReminderAndEscalationConfig object
    + +Approval Reminder and Escalation Configuration. + +
    = 1`"} schema={{"type":"integer","description":"Maximum number of reminder notification to send to the reviewer before approval escalation.","format":"int32","minimum":1,"example":1,"nullable":true}}>
    fallbackApproverRef objectnullable
    entitlementRequestConfig object
    + +Entitlement Request Configuration. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-access-request-identity-metrics.api.mdx b/docs/api/beta/get-access-request-identity-metrics.api.mdx new file mode 100644 index 000000000..cdaf1c214 --- /dev/null +++ b/docs/api/beta/get-access-request-identity-metrics.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-access-request-identity-metrics +sidebar_label: Return access request identity metrics +hide_title: true +hide_table_of_contents: true +api: eJztW9ly2zgW/RUU5yFLiVq9xH6ZUmxnSl1OO+Ol8uB2TUMkJKGbBNUA6UTj8r/PuQBIkZIcu+3U9FLKQyyRwN2XAwi4C3I+NcHhdTCMImEMOxe/FcLkbBQLlct8wT6KXMvIBDetIBYm0nKey0wFh8GVESyfScOGn0Ysz5gWeaEVk2qS6ZTTIMYdzdSRaAetIJsLbd+NYpCYityx9VxLpiXPVjDnmmO60CTjXaDwBfOkHwcirUCSMHOez4JVCT9yxadCvzKsnMBGxySFBjupBUTIdSFagYlmIuXB4V2QL+bEwIC/mgb3rUB85ek8oWf73f5u9G5vEEb9/W64M+Z74VgIHop4MojG3YPe7v4AMyohtdNJxGfjX0SUPyLreTm6NJrMRQrJXyBwPx7vdntjEU66k3G4E0W7Id872A0Hg53eYBDt9t8d9OoCW1LPkZEm/h4pwQMTTe1FZk1E/tYUIbkU9q2MN01uCjU6ZtkEgSjqQvl41FLcCvtOiyhLU6FiF5gIURK4ZqvoYPCu+26wNxjE/d2Dg27PftrrD0TUHezvkmWdHOvyLKmc/Hg5ujw9+Yi/a3ION5pMqCKl7GvOHB4dnVxc/OfT+dmH0ekJHpyf4c/NPQkhc8vKkRuB2rmYBPf3D4lxj7w1Iio0ot+mENJWH2UqF1/zYQEng7mM1aEzXuiDNuRzeOKWJ+ZQCx6D9Q2518wzZZxr+t0u/WnqeFGkKdeL0iGYkBU6qjzDVcyqJ7m8pYSEJ+zYGIET5Zgyz3RuSgokBHI3ZqlLZTJZRMKrnLhDykRG1qWdXwyJcLcedFVsPTnobK3At88ynzk712ZJcIckmObqnHu0t4MHqkgSPiYXuPhfCQAWZYXKH1INQbFig3zGczbjiGCekBcWDPVGsanminJwNeSlYtZ34NaI7XeIjVWdnPH/aK3KGPgCmSC9VciYLJKc9HOR0lBllxIgy3kyqvT5HjpcEkmGTBwLTYosrcW+zDJmZlxDslIlK64VtuoqPmtQDrxHGlL3uhDb/FbweHjLpZejknqcZYngytaLCS8SiD1B3q0LCcGZdFZeGhfVL+IKgYFEKlTcZh9o7kPjVJYvh9ZFJKtASCS8jMvocG3rhZLqTS2DATTUHG3tyZmB+RLBSvbsmOecjZSR0xnCBlmvIA6qhY8L1lR1MyOS3HJjGrK32QjOzV+V31v4AhvlqBiGOkYKnSTs4VmYFj4sBdMiEbdIvbKEwZ6vrDljwiepVOBN1awK6xrsWTV0OebCkkI5nshpYTvni6z9qO2k/eKZVbW3rMkrLnnQrGtRBgtS7D+FPYXgUoRNtlnBTZboSxNmc3SIr9Lkri1RjJTJ2X5KZGGCgJFQDlJpKEIY9IsRIvkmrdYa9wOA957+tYKdTc31KJEYzE60BqcQQJ3gNqRqisnGGRoFpJPKZvOLOmazMSLOYaGjLN6IgprCfkA6hOhUNiuEFTnCRN8fyFxppm3qgGTZPOy4Ji6DJdo99p7H1cLkyCtDJtU8+hW0Rk+AiVdKYj4rp6B2V+G/ga3YF3y81z3o70z2djjvv9vp7e+ODyZ8MOgeAB4S9xRuRHWtdyCuNV+ssf6XUALeZUkWwSP/hUHQzY1DoY7508GJpfEE+19CLze2UtPLywj5tVDW3h99Yjv7LOFqWtjnfLpiBBVeXaw1T2juCJ9pOZVqIyD2oPb45MPw6pQA7fnJv69OLvCJaK2tJIe0aowpLDPbf2fZFyuxV+ALN8wgsyJKLfbWU30Lhbgy9YHSfTMLQxnqqwNmeO4bZtRJs4nO0kYqRQ4ms9eyLdotlHrj2wUbc4MJmcMsbyml53l46i35ls2A1oR+02bDOJakJOAFshFEMZ9gHOMxgSQPeiYFUlnYopsVOZVIuQJ8aqZchTJlXTmtO4WSA5I/HieorgWEs2rWs7CKFi+i9w9kdpZrSndZM5o16ULl1OIwMlnAjNoiwDF0k64fUAaTuwwKjyrHVRWrXi5tufvohDnOM/su4oV5Qt59SlB+Qqta9eJW+OSzDd+jVfJG6SZfkfCS1LaTK0zrbVEmPptIkcTb3N3m7jZ3n5i7qy/P/ZaCf2uhT28d+lwpXsC+2jbPNeijhQOWrBzk9nicI1uEyzxE+uHzJRL7V6yhCb19nUuPQL8TPnKtfE34YeUP93xM8KNyVsMXJKC1o9+lQiUS8aGVeymxA4nWVIN1bh8yPZYIULUBIqJqarbICkbrWV0oZResWObEmTC0mPHLcotybQUkrioO5xkW0lskuUWS22607UZ/n260RZLb3N3m7l8zd7+JJCupbLZ4nGTcj1Mu0vx70pYzDGDlj1usSjnrqlW0QsRYhbGCJnIIxv3euDfZj8ROzHfivcHBpB/t9fnufm+/N97p7wf1Xn+9zOMqyZo5VfO386M1MUDcLXBcoRBcJs+yuLn9V9BPLRMqa1R6KtwMm8OkNxV27B+sY8fLLGMfuVqUCMk0MKRa2ohqGsamNFaXYzGAsynqomIoVRJyUSjJVICKRtCwRKbSJi9pAbp6EQ4nOVRxiVIGWcVFqigpIKGtBElGqDlDYEnadJ8Q5gMFi2CnqM7fEZ16F70IybNz0viUNGYnXyMhKNEr5L67aX93BOE11YgL5+AHNnrdaocrBAAWBK5mVbhzi8+3+Hzb47c9/u/R47f4fJu729z9a+bu78DnHg09jM8x4Mn4HGPbXVZhqQ/2gMD/G6bbVPES2PBmWRQV2m43lxjc4gqEkj8HSzWEzlweBp2Vo3jlKaPQnyfp3C2Pv953qtMJoTMMXq8dPL3vUHh17uj/+4DOAxLAdLoVOgHPWZ7PzWEHQ4SCq+/bfC7bJRuVfWlHWdoZw84bShidNXDpSgPsaWDHoG2dpCXlgSualrhzmT+5ERi4zm4vf5MynVClWFhkBcqkJdOiwz0+Ju1jiDjHguSVsaPbNgbX9INeVzq5f7kujtADumwy3ze5YTyDpCsqkgq145sXhN4d97VDnMuORCu+/hqzMxrWZ+8F11hauB9BXv/w+fINmxJmtTWjsMdY/KkWzj4hRGxNHJY/CNAk26Z0Vkzd+aBh4ycXykE2SaAw+0ldCMGuywMuP6JZnKO6W5PSJGELCs26eV16Jxa3IqE+2l5akgJPxqoDC3V4Y94b2zPt4qJ25rz9kwrZsT1yKKn30xivol0rsut5qRev6fVcIf5RUgt91lpq5s2KFM6015E7whOhEBAJnhhrrWczd/TCGr3Qng4NieqqDGQJL0fzh7Ko9Nqz5WjQC4leU46f1OeZRENuTmOu/jGDfprEbMSiWZYZ8U/GKHQoDa6nBbLo2WJ9IaahzYiw362JFDqWoQwBL618p0gM5YKJj6m9W3STAfip2KXkz9azyPmf7YGxnxs628fX6MI0Ms4i82yZiWFIDENXA4yX3zU5Ciw63wodbB1wAXC09L+tBF7QWt1ztDZWdUu+Y+dQa4ggqqVi5ofuy+GywPlPzL6g0dUYlGFC59VPh/jOPC3qdA1jlfsKqxZclzfJ0GBX7Obkrfa1qOn+2fQljYfL7ZczlSy+d5V+oJL8eeruH1TxtpXm71hpPF6mcLNs/cKiHuTvPV5b3w6019QE/sdbm6sWmmPhszzlXCc0T3hOUW2zOprZG0RazAXPCfu1KLKy1GYi1vyU/nRLgAhNNcYgbQ0wKR/LBPTsVnfJmduEccCS/ErfTWEhOvGKZliYijb7jLWdiuAWWtfRYQ28+yXzC7wLeOYTOZYdl84G6ErTQvm7NEXK6HrFIxERSxMVrnD5w9lOhcxCv2pWmcUUaqRC265wdGrOJrRHjeVvzfGP8ILfjd+g5u5Wgb91tlTkXCQ2MmlcE7Y/RhvRFs5EMqeVJaouAJiocfg4ulyjCGLKXyTI9LTjJ5kOjaWLEFDehc+g3Wt3Q7tcwPN5ZnKshWvE3e58iSXL5XV1MyStbjI2ovJuuVP/vHuUvo/QAqAzp90vkq5wCxK3jrwOHllHgsph4yLl2lKSRmy6xegvCh7av1igzGAVYnh3RzsutL66p8eYSMv565vl0skuOeE1+hxvPrdfN83rc3+j8A178C7nRkuUu4VqsdwoCPDxV0H7CzWtaYn4LHm+fV/zGUKtG/q7y1ZeOnyGdPbt/Q3GuV0z60j3yu2r1Sat/fJEi9hqr+NfJ5SN/AE85D8gaFDx/welJD0v +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 access request identity metrics' (get-access-request-identity-metrics)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Return access request identity metrics

+ + + + + +Use this API to return information access metrics. + +## Request + +

Path Parameters

+ +Summary of the resource access and source activity for the direct reports of the provided manager. + +
Schema
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-access-request-recommendations-ignored-items.api.mdx b/docs/api/beta/get-access-request-recommendations-ignored-items.api.mdx new file mode 100644 index 000000000..a3cdd3501 --- /dev/null +++ b/docs/api/beta/get-access-request-recommendations-ignored-items.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-access-request-recommendations-ignored-items +sidebar_label: List of Ignored Access Request Recommendations +hide_title: true +hide_table_of_contents: true +api: eJztW+tz2zYS/1cw7Ic2GlHWyy/N3NwojtNRxzn7/LjcnOO5QiQooSUBhiBj6zz+3293AZKiJDuOm+k1PX1JLBJY7Ht/CwL3nk5FxnOp1ST0Rt5M5OMgEMaci4+FMPm5CHSSCBXSEDOZKZ2JcJKLxHhtL+cz442uvcl4wuw05uaxlYneTdsLhQkymeJvWOlyLg0bn01YJvIiU4blc8FiCVN1xKRdh3FLNHNEsybRDrCQ8ownIhcZMnLvSSQNg7MFvFPwBn7GMpG5t7r+O37HVJFMRYYLZsIUcQ5MaMdP54O6EIJd/2NATF7kHFbNQnak41gESIOdVUvf/DDP89SMdnZC8UnEqNKO4TJOtVR5B3jekaHa4ancMY6OH1R0/FqEVyzSGUtAdCYV/JmQnCgmakCCRrxRxGMj2p6440kag3j93W7bM8FcJNwb3Xv5IkWZYV0xExnMtGTso0EfHiRSyaRIvBHMS/id/ZuohCLioAX69fDQ3qxNHUVGrKvzlB4D26BBtGRUxLHTKoMXHXZlCh7HC2ZSEchIgnFvZT5nLbJOCxWf8plUPBcwP9PFbE50nGG+GXP8BmNU6n9c+YEu1LruJxFr5VkhWkzmoFVQfKrTIraqFKz1T/9S5zz2j3B2C1WaQvQINhc8BPcnO+DADeEw50BRF3HIpsJFBlhORpXdQH+sZX2ixW4FqsrGLlgMbCZVIMrwlWrGOBgaWGEkCAu4YnP+ScBjsBEpB8fLJOVB3kZppKmDHhZWOkdPMQJXbRGRv5DkLeSJuP3E40JYLeBoYLswJTffhAehPBucaKp1LLjylvyEZj7qK5GMKS1uoGXyDIzhPaw60luaUlm/MGgy9IxSSmYWKofEaadN0RXU76zS76xcwJnv+HyFtn1bPkWXMUWa6iwH9lD9lI6AlL7F15B64tCQ39rSpzMzQgqtlq02HRm2WiPWEh/BA1Wr8Qr1t/5ShkLlMl9MGhO9JZt69RAmPrIPXj847B10D4Z70y7v7h4Mur29af/wMOr3ukFv0Bt+8LzH7GpQsiftupRnMHS4bwTqD/SxbvILoPYHNzgKvGruC/vsecYGm9S2bbMlW4KhKsO0WS4TSFNgslbTeNVc7+EGI9emT4OK73e7+F9Tp+cO0Xw5mgk0lArI8ECSp2ksA3q184tBuvfrBudZxtE1JAGy+rme/gJ6RHiUod5zabmthX3Saa6uJm/WiswlKLaczyZvWM5/LZ2FB2VWq3XmHHx3vzsAf+51u7397rA77e5Fg+FQBIfoiVYfz2H7y9kFDkHzTuOoHqgEyO9SNdnI8GA37Ivd3t5Bt7cbDvrRwWE34L3dgx4ybFlYZ0UoLOHX3vjo6Pji4t9n56dvJyfH8OL8FP7bAH2hMAOJFQ6b/KzRAsXbF4/jc8Tll8jbw8Ozx5NcpeM/qWeYI3wc2tQbWNbv7vu93mXvYDTcHQ32O93Dg389l4dxUHJy7gLrTa5h8gPOH24Kr6NYghuy4yyDePfZ+RIqsYjRhtdUhwvMD1IBJJDhS8LrEX8MRQ557EiHG51htaQq4c8yLpFDQSwHMJEBxU8yRI8kdGBJokOgCDSu6Q6giU6PveZh1WEdOWFQzRkPMBo3x3WToSslYT4rp0BMV3lzw7JiX/DpXvewP4z2hpz3D4a9/d3pYcQHg+7h7iGFMfiO4TNhNuSl5tI/CgUlOmCxDsAi/wGFZIKD7okBWvz5qYxoPEP/GGt2bCWm45fl4g5AJmevj87YcJ/FXM0Kes5nK0pQ/tUFFmDoafi0xGgguSV8msmZVE/lhTfHb8dXJ5eYEI7/fnV8AX8hrbXEMFbgrSG6pSYYPte3ti22AtxyqHYCKyQkL9ZyVFsgEC/7ZztQ2l9mYTDxObwIM9zqG2Ysk2ZRppNGKFHc3OXsB9kRnTZkUngGOSGYsykHcM3AhNRoYJinuX/iNNlyHcarDhuHoUQhAfoTQDcwf4HgnIehBRW2aYRQFtSQ6CJH/C4D0bRFrcqmNepcc7JsFAwO4PzzfgJpCPpT8olGFFbe4lh09gGereaa3F0uKY1UiugJElxArW+gMyg/kJlANglwy6UjAjGQeFQ5rspYyymU0t07y4zNkJDPeGGeEXdnMaQfn0SrXnwSLvhoz8NmI7JGaSaXkVw7T5PdqMpcZeBbmLWN3W3sbmP3mbG7+nIV+yD06a1DnyvFC9BvRsVzDfpk5D1Ks3IQwRtnyDYDhTiI9NP7SwjsX4XC8eIuxY2Ir4iPbClfY35c2cN1k2X/UJb+2hbIIOnRShBBJhLhiPiuObYgkVQ1WF/trc6mEhxUbYCIkDUzttAF46CyrFCKtqZMm4VaGPV97jalLDSnDIirqtC3vesWSW6R5LYabavRn6YabZHkNna3sfttxu6TSLLiiqLF4SRTJAnPFtbT3HvaimQwoP46WIUcmWoVrSAxVmEsr4kcvGm/N+1F+4EYhnwY7g0Oo36w1+e7+7393nTY3/eWa/11HcdVkDVjasne1o6kYgBxnwDHFQqcy+Rah83tvwJ32CNMa5h6KtwMOgeV3lTYsX+4jh0vtWbvuFqUCMk0MKSqdYQ5DcYmODYrx8IAzmaQFxV+1ZTAF7qSTARQwa8wjD6dYvCiFEA3W/jjCD+8uQ+yzsmqVaQK4gI4pEwQa0TNGhxL4tfNCDEfUCAEO4Ps/BXRqTPRb0Ly7BwlPkGJ2fFdIAQGeoXcdzft706A+QxzxIU18CMbvbbb4QocABoCm7Mq3LnF51t8vq3x2xr/56jxW3y+jd1t7H6bsfsF+NyhocfxOQx4Nj6HsZ0uq7DUWzoy9nvDdAoVxwG5N9NBUGS03VxicMIV4Eru+DHmEJ7P4ccOl77dg/WdtfyVIzM77mSNL92BZNsSWGaLLAYi5Rmke7Ah2O6hw1PZKc+xKH1LB5GmoLgNOQkPD9j4wwF05Mku0CGtZxId22ZBIm5t4A7nedVZpycp46EuNO5CF5D3iEwbD4c4J6PHwGIKHcb3hkZ3yKnW5AO5rrL44bfLYgk9Issm9T25GoxnwOmKiCjCDZoLnAEIkb2ugJ8jm8LGBTrA9c3ymAuE7JbDtZF1GcI2r7/G0CkO67PXgmfQT9gvHz/89P7yFZshUKVEYc++CYmdBYTaGbgRJcJx+RUAJ1Ftqg8njxvfWTDwWBSDUpg7azpxivobVIhzSOmkdpwkKIvgrOefkuONeY+cLP2gfPZGZvYQnaExTkR7+vY6LeXiS3K9lInvSmplnBI1PKHX4MKq9jqw53YCCFgkwWND2nrx4paev0QP2y94glRXeUBNOD6aX8eC0mov5qNBz0d6TT4+qPdzCVW4OY3ZpMfMnI5XT1gw19qIvzKGroOhcj0rINJezNYtLupTRPj97hJLvl3Slz5gSuLvBAJDWWfiU6zpBGk0oD0V2rD9mSwLeeFnOjn7c0NmenwNpRdHhjr4gqOfKzzjgj4u6Ns8YRz/trKhY+GBNJCB8oB1gKPa/pQJHKNLudHS2pj5ifwOzcHyEQCrRMWkI/tjVCdB9xejFzi6GgOp2iuPidJmUxwzRwvLW0NZ5WbCqgbX+Y01VNUVvVl+q80srLR/NHlR4nG953Kq4sXXztKPZJI/Tt79H2W8bab5M2YaB5LR3WhZ100sO/lrh+nW9wAN3QGCf+EtxSrhceh26ms/y4TSmOfo1RTVwVwK2j1IBc8RH7bRs3RCkQiNPoY/9IhEaJbBGAhbA7iVT2UM9Gh/u1yZU8BY8Il2xd+moBYG1wrm0I2KDnsPDZ0KwCzYzOEJDXj3i3Zd3QVY5gwNy96UxgbQlSSFwjPpwHaRMA4u9RmPCKUJCpu4oLdTotSFJuhXzSqjGF0NRehQW5Ml5jTCjWnoeZcM/5m1wO7G7UqD6tGK7jJHLci5iN1VyfYKtP8cbfA2fy7iFNtJyLoAwMTSCu8ml2sUgZgyIBe07Tqb7bhJZgfHAhFsoaz7DDq9TtenlgKep9rk0AAvET9xNxzcvdDPXQJd8c77epv+a10HdRUGW4OdFDfDkO/CtjO2rbz2PttW4v5Wo7GENmQOsuPk+3vcTMFO6wEf27s52L6ANTBE6gtdj4r6bd083ajRXwVuT5QXa90GhL2y9Hw9/H9dGX1Cj9WV2hcqcnv/89u7//mEO5SXfF/oDdtLnF/3EucTlqqv2L7QVtvbl4/dvnxC6/UF2FrrN/UmJm0cQsGm5Eal2U6znz2WZq0dDEAq1Vb0j8eAhR7+CyjGmXA= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

List of Ignored Access Request Recommendations

+ + + + + +This API returns the list of ignored access request recommendations. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-access-request-recommendations-requested-items.api.mdx b/docs/api/beta/get-access-request-recommendations-requested-items.api.mdx new file mode 100644 index 000000000..cb13e0a21 --- /dev/null +++ b/docs/api/beta/get-access-request-recommendations-requested-items.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-access-request-recommendations-requested-items +sidebar_label: List of Requested Access Request Recommendations +hide_title: true +hide_table_of_contents: true +api: eJztW+tv2zgS/1cI7YdtDcvxK0/gcHDTdOFFesnlcT1cGlxpibLZlUhVlJr4gvzvNzOkJMt20jRb7G17/tLGEjmc9/yGIu88nYqM51KrcegdeFORj4JAGHMmPhXC5Gci0EkiVEhDyqciHOciMV7by/nUeAdX3ng0ZnYic2PY0lTvuu2FwgSZTPE3rHUxk4aNTscsE3mRKcM4iyVM1BE8ceswbom6B/B/g2gHWEh5xhORiwwZufMkkobB2RzeKXgDP2OZyNxbXv8tv2WqSCYis0uaIs4Ny7Xjp/NenQvBrv4xICbPcw6rZiE71HEsAqTBTqulr1/M8jw1B1tbofgsYlRqx3AZp1qqvAM8b8lQbfFUbhlHxw8qOn4twksW6YwlOhNMKvgzITlRTNSAzAQYKeKxEW1P3PIkjUG8/na37ZlgJhLuHdx5+TxFmWFdMRUZzLRk7KNBHx4kUsmkSLwDmJfwW/s3UQlFxEEL9Ov+vr1emzqKjFhV5wk9BrZBg/lMsKiIY6dVBi867NIUPI7nzKQikJEE497IfMZaZJ0WKj7lU6l4LmB+povpjOg4w3w35vgdxqjU/7DyA12oVd2PI9bKs0K0mMxBq6D4VKdFbFUpWOuf/oXOeewf4uwWqjSF6BFsJngI7k92wIFrwmHGgaIu4pBNhIsMsJyMKruB/ljL+kSL3QhU1VSBxkKwGNhMqkCU4SvVFII8R1YYCcICrtiMfxbwGGxEysHxMkl5kLdRGmnqoIeFlc7RU4zAVVtE5C8keQt5Im4/87gQVgs4GtguTMnNd+FBKM8aJ5poHQuuvAU/oZkP+kokY0qLa2iZPANjePfLjvSGplTWLwyaDD2jlJKZucohcdppE3QF9Qer9CcrF3DmOz5fom3flE/RZUyRpjrDAoLqp3QEpPQNvobUE4eG/NYWP52ZA6TQatlq05Fhq3XAWuITeKBqNV6h/lZfylCoXObzcWOit2BTryLNxCf23usH+7297t5wZ9Ll3e29Qbe3M+nv70f9XjfoDXrD9573kFkNCvaoWRfSDEYO941A9YE6Vi1+DtT+5PZGgZetfW6fPc3WYJLatG22YEqwU2W6NstlAlkKLNZqeffXGKI2TxpUcb/bxf+a2jtz0AVXfQ54CTRUBkjoQJinaSwDerX10SD1u1UD8yzj6AqS8Ff9XE8+gt4QDWWo51xanmvhHnWSy8vx65WacgEilfPZ+DXL+W+lc/CgTGK1fzuH3t7tDsB/e91ub7c77E66O9FgOBTBPnqe1cdT2P56doFD0L3TOKoHEj/yu1A81jI82A77Yru3s9ftbYeDfrS33w14b3uvhwxbFlZZEQor9pU3Ojw8Oj//9+nZyZvx8RG8ODuB/9YgXajDQGKJwyY/K7RA8fbFw4AcYfgF8nZ//+TxJFfp6I/qGeYIH4c29QaW9bu7fq930ds7GG4fDHY73f29fz2Vh1FQcnLmwut1rmHyPc4frguyw1iCG7KjLIP49tnZAgixANGG10SHc8wHUgECkOFzwusBfwxFDnnrUIdrnWG5girhTzMukUNBLAcwkQHFzzJEjyQwYEmiQ6AINK7pDqCJTo+94mHVUB06YVDNGQ8wGtfHdZOhSyVhPiunQExXeXLNsmJX8MlOd78/jHaGnPf3hr3d7cl+xAeD7v72PoUx+I7hU2HW5KXm0r8IBRU5YLEOwCL/AYVkgoPuiQFa/OmpjGg8Qf8Ya3ZsJabjl+XiFjAlZ68OT9lwl8VcTQt6zqdLSlD+5TkWXGhh+KSEZCC5JXySyalUj+WF10dvRpfHF5gQjv5+eXQOfyGtlcQwUuCtIbqlJtQ90ze2lFgBbjhUN4EVEZIXazmqLRCIlzXHDpT2l5kbTHwOHsIMt/qaGYukWZTppBFKFDe3OXshO6LThkwKzyAnBDM24YClGZiQ+goM8zT3j50mW66heNlhozCUKCQgfcLjBubPEYvzMLQgwvaIEMqC+g9d5AjXZSCatqhV2bRGnWuOF42CwQGcf9lPIA1BO0o+0YjCylsci84+wLPVXJO7iwWlkUoRLUGCC6jTDXQG5QcyE8gmAV65dESgBRKPKsdVGWsxhVK6e2uZsRkS8hkvzBPi7jSG9OOTaNWLz8IFH21x2GxE1ijN5DKS695pshtVmasMfAurNrG7id1N7D4xdpdfLmMfhD69VehzqXgB+s2oeK5An4y8R2lWDiJ44wzZZqAQB5F+fXcBgf2bUDhe3Ka47/AN8ZEt5SvMjyp7uO6x7B/K0l/bAhkkPVoJIshEIjwgvmuOLUgkVQ1WV3ujs4kEB1VrICJkzYzNdcE4qCwrlKKdKNNmoRZG/Zy7PSgLzSkD4qoq9G2vukGSGyS5qUabavTDVKMNktzE7iZ2v8/YfRRJVlxRtDicZIok4dncepp7T1uRDAbUHwOrkCNTLaMVJMYqjOU1kYM36fcmvWg3EMOQD8OdwX7UD3b6fHu3t9ubDPu73mKtv6rjuAqyZkwt2NvakVQMIO4z4LhCgXOZXOuwuf1X4A57hGkNU0+Fm0HnoNLrCjv291ex44XW7C1X8xIhmQaGVLWOMKfB2ATHZuVYGMDZFPKiwo+YEvhCV5KJACr41YXRl1IMXpQC6GZzfxThdzb3/dU5WbWKVEFcAIeUCWKNqFmDY0n8mBkh5gMKhGCnkJ2/ITp1JvpdSJ6docTHKDE7ug2EwECvkPv2uv3dMTCfYY44twZ+YKPXdjtcgQNAQ2BzVoU7N/h8g883NX5T43+MGr/B55vY3cTu9xm7X4HPHRp6GJ/DgCfjcxjb6bIKS72hE2J/NEynUHEckHszHQRFRtvNJQYnXAGu5M4bYw7h+Qx+bHHp2z1Y31nLXzoys1WdrfGlO4FsmwLLbpHFQKY8dXQHVgTr3Xd4KjvlSRalb+jo0QRUtyYr4fEBG4E4gA452QU6pPdMomvbPEjErRXcaTyvOt30KGU8xoXmnesCMh+RaePxEOdm9BhYTKHH+NnQ6A651Yp8INdlFt//flksoQdkWae+R1eD8Qw4XRIRRbhGc4E7ACGy1yXwc2iT2KhAF7i6XhxzjqDdcrgysi5E2Oj1Vxg6wWF99krwDDoK++3jxa/vLl6yKUJVShX2tJuQ2FtAsJ2CG1EqHJXfAXASVaf6NPKo8aUFQ49FMSiFucOlY6eov0GNOIOkTmrHSYLyCM56+rk43pj3wFHS98pnr2Vmj80ZGuNEtMdtr9JSLr4g13OZ+KmkVkYqUcMzeQ0urGqvAntyJ4D4RxI8NqStZy9u6fkL9LABgydIdZkH1ITjo/l9LCit9mw+GvR8pNfk4716N5NQh5vTmE17zMzoPPWYBTOtjfgrY+g6GCpX0wIi7dls3eCiPkWE3+8usOTbJX3pA6ok/o4hMJR1Jj7Bqk6gRgPeU6EN2w9kWcgLH+io7IeGzPT4Coovjgx18BWHPZd4xgV9XNC3ecI4/m1tQ8fCI2kgA+UB6wCHtf0pEzhGF3KjpbU28xP5LZqD5SMAVomKSQ/sj4M6Cbq/GL3A0dUYSNVeeaiXtpvimDlaWOAayiq3E5Y1uMpvrKGuLunN8lttZ2Gt/bPJixKP6l2XExXPv3WWfiCT/Hny7v8o420yzY+YaRxMRnejZV0/sejkrxymW90FNHTpB/6FtxSrhMih36nv+SwSSmOeo1dTVAczKWj/IBU8R3zYRs/SCUUitPoY/tAlEqFpBmMgbA3gVj6RMdCjHe5yZU4BY8En2hV/m4KaGFwrmEE/KjrsHbR0KgCzYDuHZzTg3Uft+rpzsMwpGpa9Lo0NoCtJCoWn0oHtImEcXOoLHhFKExQ2cUF3p0SpC03Qr5pVRjG6GorQocYmS8xJhFvT0PUuGP4La4HdjduXBtWjFd31jVqQMxG7u5HtJWj/Jdrgbf5MxCk2lJB1AYCJhRXeji9WKAIxZUAuaNx1Nt1yk8wWjgUi2EJZ9xl0ep2uTy0FPE+1yaEFXiB+7G45VFdBv3Tvc8k/7+qt+m91A9TVGGwOtlLcEEPOC9vQ2Nbyyvtia+nZG1mLzSW0IjOQH6ff3eGWCnZb9/jY3sjBFgYsgmFS3+J6UNjv67rpWp3+JnCTorxN67Yh7EWlp+vh/+ue6CN6rO7RPlORm0uf39+lz0fcobzZ+0xv2Nzc/LY3Nx+xVH2v9pm22ty5XH/n8lGt19dea61f1xuZtHkIBZuSG5VmO81+/FiYtXI8AKlUG9K/HAEeuv8vd8eXhg== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

List of Requested Access Request Recommendations

+ + + + + +This API returns a list of requested access request recommendations. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-access-request-recommendations-viewed-items.api.mdx b/docs/api/beta/get-access-request-recommendations-viewed-items.api.mdx new file mode 100644 index 000000000..23c152100 --- /dev/null +++ b/docs/api/beta/get-access-request-recommendations-viewed-items.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-access-request-recommendations-viewed-items +sidebar_label: List of Viewed Access Request Recommendations +hide_title: true +hide_table_of_contents: true +api: eJztW+tz2zYS/1cw7Ic2GlHWy8+ZmxvFcTrqOLXPj+bmHM8FIkEJLQmwBGlb5/H/frsLkBQl2XGcTK/p6UtikcBi3/tbELj3dCoynkutxqF34E1FPgoCYcyZ+L0QJj8TgU4SoUIaYn6R4laE41wkxmt7OZ8a7+DKG4/GzM5ibhpbmuddt71QmCCTKf6GhS5m0rDR6ZhlIi8yZVg+EyyWMFVH7IaWYdzSzBzNrEmzAxykPOOJyEWGfNx7EinD4GwO7xS8gZ+xTGTuLS//jt8xVSQTkeF6mTBFnAMP2rHT+aDOhWBXvwyIx/Ocw6pZyA51HIsAabDTaunrH2Z5npqDra1Q3IgYFdoxXMaplirvAM9bMlRbPJVbxtHxg4qOX4vwikU6Y4nOBJMK/kxIThQTNSAzAQaKeGxE2xN3PEljEK+/3W17JpiJhHsH914+T1FmWFdMRQYzLRn7aNCHB4lUMikS7wDmJfzO/k1UQhFx0AL9enhor9emjiIjVtV5Qo+BbdAgGjIq4thplcGLDrs0BY/jOTOpCGQkwbi3Mp+xFlmnhYpP+VQqnguYn+liOiM6zjDfjDm+wBiV+h9XfqALtar7ccRaeVaIFpM5aBUUn+q0iK0qBWv907/QOY/9Q5zdQpWmED2CzQQPwf3JDjhwTTjMOFDURRyyiXCRAZaTUWU30B9rWZ9osVuBqpoq0FgIFgObSRWIMnylmjIOhgZWGAnCAq7YjN8IeAw2IuXgeJmkPMjbKI00ddDDwkrn6ClG4KotIvI3kryFPBG3NzwuhNUCjga2C1Ny8014EMqzxokmWseCK2/BT2jmo74SyZjS4hpaJs/AGN7DsiO9pSmV9QuDJkPPKKVkZq5ySJx22gRdQf3BKv3OygWc+Y7PV2jbt+VTdBlTpKnOcmAP1U/pCEjpW3wNqScODfmtLXw6MwdIodWy1aYjw1brgLXE7+CBqtV4hfpbfSlDoXKZz8eNid6CTb2KNBO/sw9eP9jv7XX3hjuTLu9u7w26vZ1Jf38/6ve6QW/QG37wvMfMalCwJ826kGYwcrhvBKoP1LFq8XOg9ie3Nwq8bO1z++x5tgaT1KZtswVTgp0q07VZLhPIUmCxVst7uMYQtXnSoIr73S7+19TemUMun41aAg0lATI5UORpGsuAXm39apDs/apleZZx9AFJuKt+rie/gsIQBmWo4FxaZmupnvSOy8vxm5VicgEaLOez8RuW899Kr+BBmb1qx3aevL3bHYDj9rrd3m532J10d6LBcCiCfXQ5q4/nsP357AKHoHincVQPZHzkd6FqrGV4sB32xXZvZ6/b2w4H/Whvvxvw3vZeDxm2LKyyIhSW6itvdHh4dH7+79Ozk7fj4yN4cXYC/61BuFCAgcQSh01+VmiB4u2Lx1E4wu8L5O3h4dnjSa7Sw5/UM8wRPg5t6g0s63d3/V7vord3MNw+GOx2uvt7/3ouD6Og5OTMxdWbXMPkB5w/XBddh7EEN2RHWQaB7bOzBfRhkaENr4kO55gIpILSL8OXhNcj/hiKHBLWoQ7XOsNy6VTCn2ZcIoeCWA5gIgOKNzJEjyQUYEmiQ6AINK7pDqCJTo+95mHVSB06YVDNGQ8wGtfHdZOhSyVhPiunQExXCXLNsmJX8MlOd78/jHaGnPf3hr3d7cl+xAeD7v72PoUx+I7hU2HW5KXm0j8KBaU4YLEOwCL/AYVkgoPuiQFa/PmpjGg8Q/8Ya3ZsJabjl+XiDsAkZ68PT9lwl8VcTQt6zqdLSlD+5TlWWuhd+KTEYiC5JXySyalUT+WFN0dvR5fHF5gQjv5xeXQOfyGtlcQwUuCtIbqlJrg907e2+7UC3HIoawJLISQv1nJUWyAQL9tkO1DaX2ZuMPE5XAgz3OprZiySZlGmk0YoUdzc5ewH2RGdNmRSeAY5IZixCQcQzcCE1FBgmKe5f+w02XKdxKsOG4WhRCEB4hMQNzB/jiCch6FFD7Y5hFAW1HjoIkecLgPRtEWtyqY16lxzvGgUDA7g/NN+AmkI+lDyiUYUVt7iWHT2AZ6t5prcXSwojVSKMAkSXEAtbqAzKD+QmUA2CbjKpSNCK5B4VDmuyliLKZTS3TvLjM2QkM94YZ4Rd6cxpB+fRKte3AgXfLS3YbMRWaM0k8tIrm2nyW5UZa4y8C2e2sTuJnY3sfvM2F1+uYx9EPr0VqHPpeIF6Dej4rkCfTLyHqVZOYjgjTNkm4FCHET66f0FBPZvQuF4cZfihsNXxEe2lK8wP6rs4drGsn8oS39tC2SQ9GgliCATifCA+K45tiCRVDVYXe2tziYSHFStgYiQNTM21wXjoLKsUIq2oEybhVoY9X3uNp8sNKcMiKuq0LdN6gZJbpDkphptqtFfphptkOQmdjex+23G7pNIsuKKosXhJFMkCc/m1tPce9qKZDCg/gpYhRyZahmtIDFWYSyviRy8Sb836UW7gRiGfBjuDPajfrDT59u7vd3eZNjf9RZr/VUdx1WQNWNqwd7WjqRiAHE3gOMKBc5lcq3D5vZfgTvsEaY1TD0Vbgadg0qvK+zY31/Fjhdas3dczUuEZBoYUtU6wpwGYxMcm5VjYQBnU8iLCr9eSuALXUkmAqjg5xZGn0gxeFEKoJvN/VGEH9jch1fnZNUqUgVxARxSJog1omYNjiXxK2aEmA8oEIKdQnb+iujUmeiLkDw7Q4mPUWJ2dBcIgYFeIfftdfu7Y2A+wxxxbg38yEav7Xa4AgeAhsDmrAp3bvD5Bp9vavymxv81avwGn29idxO732bsfgY+d2jocXwOA56Nz2Fsp8sqLPWWjob90TCdQsVxQO7NdBAUGW03lxiccAW4kjtkjDmE5zP4scWlb/dgfWctf+nIzJY9WONLd+zYdgSW1yKLgUZ51ugeTAime+jwVHbKYyxK39KBownobU1KwrMDNvxwAB1tsgt0SOmZRL+2SZCIWxO4M3hedabpScp4eAttO9cFpD0i08azIc7H6DGwmEKD8b2h0R3yqRX5QK7LLH74clksoUdkWae+J1eD8Qw4XRIRRbhGc4EvACGy1yXwc2gz2KhA+19dL445R8RuOVwZWVch7PL6Kwyd4LA+ey14Bu2E/fDxw0/vL16xKeJUyhP2jJuQ2FhApJ2CG1EeHJUfAXASlab6DPKo8ZkF445FMSiFuSOlY6eon6FAnEFGJ7XjJEFJBGc9/zQcb8x75ADpB+WzNzKzh+UMjXEi2kO2V2kpF1+Q66VMfFdSK8OUqOFJvAYXVrVXgT22E0DwIwkeG9LWixe39PwFeth9wROkuswDasLx0fw4FpRWezEfDXo+0mvy8UG9n0kows1pzOY8ZmZ0inrMgpnWRvydMXQdDJWraQGR9mK2bnFRnyLC73cXWPLtkr70AVISf8cQGMo6E59gSSdEowHsqdCG7UeyLOSFj3RA9mNDZnp8BZUXR4Y6+Iwjnks844I+LujbPGEc/7awoWPheTSQgfKAdYDD2v6UCRyjC7nR0lqb+Yn8Fs3B8hEAq0TFpAf2x0GdBN1fjF7g6GoMpGqvPMpLe01xzBwtrG4NZZV7CcsaXOU31lBUl/Rm+a32srDQ/tnkRYlH9ZbLiYrnXztLP5JJ/jx593+U8TaZ5q+YaRxGRnejZV0zsejkrx2mW90CNHTVB/6FtxSrBMeh2alv9ywSSmOeo1dTVAczKWjzIBU8R3zYRs/SCUUi9PkY/tAiEqFpBmMgbA3gVj6RMdCj7e1yZU4BY8En2hV/m4I6GFwrmEEzKjrsPfRzKgCzYC+HBzTg3a/aNXXnYJlTNCx7UxobQFeSFAqPpAPbRcI4uNQnPCKUJihs4oLWTolSF5qgXzWrjGJ0NRShQ11NlpiTCPeloeVdMPwn1gK7G7cpDapHK7pLG7UgZyJ2FyLbS9D+U7TB2/yZiFPsJiHrAgATCyu8G1+sUARiyoBc0LXrbLrlJpktHAtEsIWy7jPo9Dpdn1oKeJ5qk0P/u0D82N1vsJc/P3XTc8k57+tN+q9059PVF2wMtlLcCUOuC9vM2J7yyvtkT4n90GJXCT3IDATHuff3uJGCbdYDPrYXcLB3AVNgfNSXth4V9Nu6XbpWob8J3JooL8+6zQd7L+n5evj/uhb6hB6ra7MvVOTmjue3d8fzCXcoL/K+0Bs2FzW/7kXNJyxVX6N9oa02VyzXX7F8Uuv1Ldda69f1DibtGkLBpuRGpdlOs588FmatHApAKtU29I9HAIQe/gsA0o7D +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

List of Viewed Access Request Recommendations

+ + + + + +This API returns the list of viewed access request recommendations. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-access-request-recommendations.api.mdx b/docs/api/beta/get-access-request-recommendations.api.mdx new file mode 100644 index 000000000..d92a3a310 --- /dev/null +++ b/docs/api/beta/get-access-request-recommendations.api.mdx @@ -0,0 +1,87 @@ +--- +id: get-access-request-recommendations +sidebar_label: Identity Access Request Recommendations +hide_title: true +hide_table_of_contents: true +api: eJztXHtz2zYS/yoYdm7aaExZku049szNjeJHq44T+2y5uRnHk0IkJKHlqwBpR/X4u9/uAnyJkqy4aS/p6Z/EIoHFvve3IMgHJ06E4qmMo4HvHDoTkfY9T2h9KX7LhE4vhReHoYh8GqKdLSflE+0c3jiD/oCZocyOZfODb7ccX2hPyQR/A/XhVGrWvxgwJdJMRZqlU8G4IaIsEVUnwsaxomE6EZ4cS+Ez6YsolemszYZw3RdjngVpcZXBEq1QtNj9VHpTJiNfejwVZi0vUwqGsUwL1QZhEq54KFKhUKQHRyKTwIaawb0I7sDPnK4rfWdenu9Fug77PCq4G/htw91qvrQ3FSF3Dh+cdJYgFzpVMpoQAyQuXALuHrccXFcqAbYb80CLLUd85GES4Jyed9B91Xm1t9/Z6e50u51Od7+z2xl1Xo53dneFdwDTF4scyFCmDWHf8I8sysKRUCweg5wa2ADuY2tMZLvBTEMOGaViIhSMDWUkwyx0DjvwN/9o/u7uVSTs7j0u4zAej7VosnhOl0G3wBWqdZwFgeWUwY02u9YZD4JZxZnuZTplLZK4hcIkfCIjsAvMV3E2mRIdK2z7fXQlBLv5aYec+CrlYGbls6M4CISHPLCLwqFuv5umaaIPt7d9cScCDLO25jJIYmCvDU6yLf1omydyW1s6rlfQcUvHfEEuFMZKgFzwZ0iOtVDbhek7KzVviJhLO705UxTa7yxVvhdnUVP3gzFrpSpD105Bq6D4JE6ywKhSsNZ/3GGc8sA9wtktVGkC8SHYVHAfXIrsgAMXuNiUA8U4C3w2EtbbMA2MC7uB/ljL+ATEvUBVTSLQmA8WA5vJyBN5gEIUMQ6GBlYYCcI8CM8pv4NExMBGpBwcL8OEe+kWSiN1GdawcBSn6Cla4KotIvJPkryFPBG3dzzIhNECjga2IbItN1+FB6E8C5xoFMeB4FE1D9HMpb4Cqg8yX7ip4pEOaGE3hHzJJ0J/igtxFkjIruAVFUospwRy5XFKTrUwhS7lfZUe7IjFwo1lQKVjeb5+nBfxlKYUrp1p9Ecqb7kr6FmUQqY100bo59Ff7C/fGLmAM9fy+QId9zS/ivGgsySJVQrs5fV5DKTie7wNeTXwNQWlARex0odIodUyxbKN+mu1DhkET6t2A7VHN8RvEHlR/WZFk3byFrPjnGrdqywCIc7eO9yHDPfeWVrvNEqy0o6VpIl5gLtaoL5A/qaJr4DaF25gFHjevFfm2nrGBe1XbbnFavZDcq9nBTIzkVmHRRySkTZrjGZsKidTBE9eHI0RKUH6HUul07bzeIvRaaJao116nQ7+V1f5mc0Na0LJEoyBYWHNFH4iUZ4kAYIyGLz9i0bKD02P4Epx9B2ZilBXrsejX0DRiCkVGiaVht/KWqu86vp6cNzMhzmkHRwXvNdlcj4R79nYWIftZ7B7XLEBqgfqHrpMpXa2FzG8s+f3xF735atOd8/f6Y1fHXQ83t171UWGDQtNVkSEgOXG6R8dnVxdfbi4PD8dnJ3Ajctz+G9B5wEwBEjMcVjnp0ELlG9uLG+JBkBliLw95ulkEWavsvIW8xIWsrL3QVZqnJzA//FMCBcW4SOuBYQq9917BSMbGeepBY/LX0+tSw0amW4CZTbFJM6E5YUhC5TViY2choXaOaPOI2ABx8KvhdV3DmPUeX03FUAN4J8yMKsSrQDSgJ8AuZgxbxoD/sLFzVIwsorSLMKxpR2M9tfwkieeZczcSXH/uTlRwuRq6GoM+aWrF7jr+ckMUqVKAIHz9TxvUMJNxkdxBqhuOpt3QHbP9fIccbD3D3TaWZwpgOdQvAxWJxlt0XHQ4+ZDtSr9GyO4GVfCxzcVfTSzxSq86WzNK7Bg+ObB+VXM4E4pkXKhJLd/6n14dzL4/ofhh9OT/vD68gTzzPH10fDD4O3w5PLi8mTYHw7O3374AQYBRWohaKdlf48UC/U7DbFS3WJRXNNixMtTZkJxYWCeHBZIXDPJH5PssRSt4YZNtsxQAAbKoACf4FS8jE+9wJdLKF4aaYFOKz40bPiIyWprloNjiA8Z4BSctLsIsBwFErd7TpSCkHbZZaWnNUXe5JFR7NN+loxAD5Ii41PhyhK/8InHo9hfo2Cdyki4UA8kciiIZQ8mMqB4J8kg1FsakrkT0bh6KIMm2l32GopIvmF4ZIUxcen9CrQW46Q6Q9eRhPksnwK5sIBHC5YV+4KPXnYOervjl7uc917tdvf3RgdjvrPTOdg7OHgiNc7v+EXQA3ksiD2wyO+gEKgBoHtigBZfP5sSjTX0T9mIxhZiWn5ZKj6mAL7Z66MLtrvPAh5NMrrOJ3NKiNzrK+x4siDgo7zOgOSG8LmSE7kwoec46/jktH99NkSAdfLv65Mr+AtpNYBWP8q3NmPaxJnG98SxFQBzvRbYkgjcCbVUWyAQt9vBdqA0v/RMY4mwrQTMsKsvmFElzcYqDmuhRHHzMWXfybZobwEyhWtQmbwpQ9QCnarZQWhhbCepe2Y12bL7Uy/arO/7EoXkQZ6VQj7DrR3u+6aLM1uOEMqCtrOw3kG5lp6o26JUZd0aZYI5qxoFgwM4f9pP+l6aAXMkZjUKC2+xLOZbz77VXJ27YUVppFJsV6GD9GjjlBKxB5kJZJOpZjYdUdcIiSfKxxUZq5o3Kd3ZjHqcxnTP45leI+4uAkg/LolW3LgTNvgIhJpsRNbIzWQzUl4ucLIdVZir2EGivnYTu5vY3cTumrE7f/PSbtPYuwR9uk3ocx3xDPSrqHg2oI8i74lilg8y8M4YcgsbIAuRfnw3hMD+FfouGC8+Jrh9+xnxkSnlDeb7hT3s9l2+u5eX/tIWyCDp0Ugwhkwk/EPiu+TYgERS1U5ztdNYjSQ4aLQAIuKTQuyKaCdNZVFEDzb0FvNjoaNvU/tIo9Kj46qR75rNwg2S3CDJTTXaVKO/TTXaIMlN7G5i9+uM3ZVIsuCKosXiJJ2FIVcz42n2Pj3aYTCgPFtShByZah6tIDFWYCynjhycUa876o73PbHr813/5c7BuOe97PG9/e5+d7Tb23eqtf6mjOMiyOoxVbG3sSOpGEDcHeC4DPdSdRrHfn37L8NnmGNMa5h6CtwMOscnowV27B0s2MKOY/aGR7McIekahoxKHWFOg7EhjlX5WBjA2QTyYoRnYiTwha4kQwFU8LE3o4M3GLwoBdBVM7c/xpMN9jjP3IEMZs+BaMoEQWw2ce+5xLMxY3p+o2aEYCeQnT8jOs33r/8IkmeXKPEZSsxOPnpCYKAXyH1v0f7uAB+UYI64MgZestFruh0egQNAQ2ByVoE7N/h8g883NX5T4/8eNX6Dzzexu4ndrzN2PwGfWzS0HJ/DgLXxOYxtd1iBpU7p0O5fDdMpVCwH5jxj7NHrGn6JwQlXgCvZN2gwh/B0Cj+2uXTNHqxrreWqxhs1pgkw7GUqgGn5Mc8HsBpY67GNxyzyEz9RfE9nPUegqgVZCI8LmIjDAXSq1CzQJj0ria5s8h4RN1rPXyopjpOupBzZI2x0KseQ2cLjddat6DKwmEBP8a2m0W1yo4Z8INe1Ch7/uCyG0BJZFqlv5WowngGncyKiCLdoLjA/ECJ7XQM/RyZp9TM0+c1tdcwVgnTDYWNkWXiwses1GDrHYT32WnAFHYR51vHdj++GL9gEoSmlBnO8WEg6HcbZBbgRpb5+vu+Pk6galS+z9GtPVjDU2DgApTD7bkJ+6vQt1IRLSOKkdpwkKG/grPUPIvPavCVvIryPXHYslTmnbI7pWhHN2xo3SS4Xr8j1XCa+yanlkUnU8BB0jQuj2hvPnNTxIN6RBA80aevZixt6boWeS0ctXaQ6zwNqwvJRfx7m5VZ7Nh81ei7Sq/PxPnpH78/VpzGT5pie0us4Azz7GGvxL8bQdTBUbiYZRNqz2aKX9lyKCLfXqbDkmiVd6QKKJP7OIDAi40zmbCGBmBjwXeSbsP2ZLAt54Wc6tvpzTWa6fAPFFkf6sfcJp+vneMYFXVzQNXlCW/5NLUPHgthGGSgPGAc4Ku1PmcAyWsmNhtbCzE/kt2kOlg8PWCUqOjk0Pw7LJJgfwqcbOLoYA6nayV+WoO2lIGCWFha0mrLy7YN5DTb5DWKoo3N6M/wW21dYW780eVHifrnLch4Fs8+dpZdkki8n7/6PMt4m0/wdM42FxehutKztH6pO/tpiuuaun6Z3RuFfuEuxSggc+pvyNdEqoSTgKXo1RbU3lYL2CxKBryQE+HJSlsYhRSK09hj+0BUSoYmCMRC2GnArH8kgf6k8X5lTwBjwiXalt5YyalpwLW8K/ados3fQwkUemAXbNzyTAfd+iW0fdwWWuUDDsuPc2AC6wjCL8PQ+sJ2FjINLPeERvtReZhIXdHORyHURE/QrZuVRjK6GIrSpkVGhPh/jVjR0uRXDP7EW2F3bfWhQPVrRvi9XCnIpgqKNqUP7p2iDt7lTESTYQELWBQAmKiu8GQwbFIFYpEEuaNRjNdm2k/Q2jsVD5SC8cZ+ddrfdcamlgOtJrFNoeSvEi9eqnvh8QeM1m2JH/sv7kIEtUthdbCe4g4aiZ6YjMr3ojfN0LwqdyxTUhYMfHnDHBZuzR7xs3pjEjgcMiFFVviu7VEl/2tcRFgpr3rqof63BbiuYNz/XZ3yNLx2sYCH/esIzF///+obBCj0W33h4piI3HyT4+j5IsMId8q9OfH5v+PRvC6xKQKs/ePBM7jefDfizPhuwwpTl5x2eabXNlwA+45cAVpqq/IJDaarbcouYtmUB21Bmr7yjaR4jVWY1DloglWJr//sTQJqP/wUeqHVc +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Query Parameters

+ +List of access request recommendations for the identityId + +
Schema
  • Array [
    • access object
    messages object[]
  • Array [
  • ]
    • translationMessages object[]
    + +The list of translation messages + +
  • Array [
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-account-activity.api.mdx b/docs/api/beta/get-account-activity.api.mdx new file mode 100644 index 000000000..50cf93767 --- /dev/null +++ b/docs/api/beta/get-account-activity.api.mdx @@ -0,0 +1,107 @@ +--- +id: get-account-activity +sidebar_label: Get Account Activity +hide_title: true +hide_table_of_contents: true +api: eJztXOtz47YR/1cw6ofmMqZM6i1/6ehkOVXiV2U5l9TxNBAJyshRpMqH71SP//fuLsCXKNvyxU3SDGduzhQJLHaBffx2AfKhEaxFyGMZ+FOncdRYinhk20Hiw59Y3st40zhoxHwZNY5uGvoJ04+kiBq3Bw1HRHYo10gCCMzvZMSASsQ4i6S/9ATjuhvXFNliwyQ0kE4TiK95yFciFiEO8dCQSGTN4zt45MMD+CUduI7sO7HijaOHRrxZ490oDoF84/GgEYp/JzIUwH4cJqLK0A4OiKT4zFdrD2kJtz1wh512py+GnW6vteguFoNOq8O7vfaw7wwaj7c4TLQO/AiEBiZapol/ykON/OpIweIXYccwmh34sfBj7MXXa0/aNOmHv0TY9aEqX9ZxHeIS0WzDU+C8MgfbIk+PWeCyeKfgcSQ8tyR8yx5aA3PQ7jot0bV6A9PqOu2WOxiaNre6AwunWK1EddzXUbFDwWOxUwA3CFccJqfhQAsjljBcibpp9Q2zb1jW3BocdbpH7X7THA7+iVRXgSNduZusn3geXyAJpRovDzMwzJ7R6s5b5lGrddQaNC2zQ8PYATZ6gv0vGccyDWs4t9pHnSGK0x50i+PASl7FPE5o0bfJP7/8qPER9WXcBcNiOUk0OOEnK7Tmq+vxeHJ1BXdORtPT69kErqbn44uzy9PJHH9cTs6Pp+ffNA5w+Nsi/3nXWMZ0Z7zN9WPK5cuTldMFw5iBMYsoTu0aLkU4dcBwQHuvktWKh5tdRrJN88uNRqJjUuOxSA9Y5NF1Qc2tgdXtumJgm6joeOUMW92F2bZ6z5lLecS/JyvuG2ATDnLOHBmtPb5h2BlZSbkojX7FpXcZSDDpKxHeS1vQTKdNp69yDpmY8R2PleRaYBaKNbg7eByVRret7mLodm2bd3lHDLvDoeDcFL2Oy4cta+E8ZSeLIPAE96u8+A76QQFT7jLueeivRAS/YrGKGBhRmas7fi/YQgifOcIG7h0W+EX+cOkfH3Ol3NYbfMRDCE61QtUK9UYKJcIwCKMCazwM+WaHAhELO/FLNtxNI4LVWONqNAEu+KCJQdgcp1eTz7YgQY/YL/yeNz3uL5tTQBVhmKxhfgrP5xBxgiRmnzjANH9Jkqf4hcUBW8Gk8KVgJnPDYMVsT4JgrNvnHb4Y9g2+aLtGhwvXGLqiZZiCu1bX7redVk+HlJ7JIgE8OlGzcQsyfOKhDwO90URgl8dqy30p/hroBKS20WFnYHc73UHbWrR6nY455ANrIVybLxamaNtd/nYGCoO/euQ0Su4Pq8o8HcMTxn2H4VNiAbQmYjnZfXEYBO8wuOdeDlvAAC9cQvUV3KgxyMn0fHr198kx3JpNvp2M5/pyfj07p8vJD5fTGV1laKQxHp2PJ6d4swJMCvR2YyKaZ84+BeHHdLpT4/4A93D5kX8BAm3DrkfUcxRRRkAT5MgFfUq8nOcCY9fn309m05Pp6P0poiwAXGdTJTfisHQCZj9Wc6vLwuAFaXZkHRVNyjlJxb3ckkSUIBfguZXOVl4XGW3VEUHbHtbmVELHin9E6fCeJrUrzej0eqbb6To90+r1rL7DMVyY3UFHBwzFwvlbGOVruBs5fMW+E+CvHQoOi8DZvMzAWGWG6WC7CE9i9u8EaK84+G34/7NcAbq/l/cc//qwjgy8fRL6HMzYh1CG2gBZNTwUnkByyYphnt9EttAZvIm30KySw1hxZ9+c7bGUN5CwpHv3Unyq0X4Nzt4MnKUqVXuz2pv9xt4sK6vuB4RGxxj3x7PJiEovZxfH05Mf4eJ4oosxx9MrDRgm5/ri+vz0YvwdXOg/s8nZxff44Goyz7BRWeBZZukIGzIemfT3gxGKzVTcrUoxgqeLTOwnABSPQfRFsnvJtsqpaVPMWD7dSfuuyiGVUkX0bFXJAf9kg4uagVsiBwogNdlj/O+xGSGsjOfnhpmD0UUJOK6Rz71NFLObEfk3AFqu9IRhdVtD0zKtodWyWrcqcIAUIvVbry/0nVP/3J5hFdHkVI2DRcADgPls7nbWg/P5K0YdcNSiOQaXEQbIZxQkoS32d4FX1H6vVasWkHtt4Q5oqnod0wQv2Lfapm3alGIoQrpGOPXd4PUuPUtsLqj9/lJlHfOafoX7ruK+p7m37LZldVLut0b+In+e+vFnmdnWxB2Dz5+ozWb+iAq8/7qcXZxMydnMLrTzmU/np5Mz+Ltr7wecaBKGoI4ewqn1OgiRRT02CaDYZThu1GRl57I9ZupnZnn/AvfoeLfW6elkiAGwgGgT2BJ3INgnGd/ptohANIMHzObrOAEPCZAjBuwVqSgGeEm3aFa9X1EZMVxTKeUMukPY4c/YdLZu3HEkCsC9y5KiVsojW94xXMg4RKD0UWwMcmlszWUYHRC88jcMgA84B9/2EgRP2jnYQagKQQ6G/rL8FX8PACiJ4mD1ndhYCAjpB1NjWbinlT5tbT9t0fKEYhXci2MdoF+/i4GRm7gOA1SdMOV3rVwqLqofMC/wlyLE5ZVLwCrod7BPtAbYiBtDmYNs7rPR1DJ1mDfNI/pXDvE7Yh49F5+FnZR3bV6WTxtLnstnVIobNZMfJuPrucreqXTwo7qeT2Zn0/ORqh2k+zbHjVJBJL+dizDZYnWn1r7kVP84Wkv8c98Wmr8X85APdwJohrsDIlCCpIMpgsDAQoDGiMIWWj5cnVXUWcVvmlUU72UKv31c4/ER23V2nU8YqzL/BLcsmMFmIHuIDlOqSU2jAK4Iulbpg32qQxpvdHhBRdVx4OyhcifSF8Yy5BI5pF0WmEpHMKrAkhtYoWEqkqleULtmuYZumk2LvecO05GaaV2i7cCQ26it+xjitS+hP0u7gMLrmsXOYUVf8EXPHLY6bq/DeWvQsfpYTuHttomlFDq5oHZhdm1xlIf+RvgilDZEOhtW5D8EqTjMPTFAgzf23gUhGnvMP8Yn1TYTM901isVnwEqcvR9fsk6f4T5UQvf5cmsSfOP6quIOQXJF+CKUS+k/B0OPJyej69M5Jbf/uJ5cPZXXjjCFpeoSsAq6cBd8Io61AGh7ERg5ZoFN9rWm+jUIxP2o2FCqXzp1coTLEy+GHnr0HT2KpNVmWtGUyG4+x+wr2RTNAwgmcA/cB+RECx5RRYuaf42Z4jo2TvVMfs3uwNWK8F2TjbI4q5AVOpENRigIwHl8dBOErQRrcdvPD2Jpi/Ja5FNZwWHap5wWFwWNAzjfI0u34wSYIzGLVphpi2ZRrw/wrGauzN28MGk0pRs/xpgMLSGVoPAPWQPk4HRyTLsjXK4IHI+ftss8VtFVkrs7U8wcxwE9s3kS7WF3lx64H4NEyx7cC218EQJN5Y1oNdJl0h5Jo1DqrFtly5UaPgN46jm17da2W9vunra7/XCmTzXopwR9rCr0ufZ5AvMbUvCsQJ8wTSXTRqoqqhbyABNPDZG+/TAHw/4ofGwvPq/x2Okb4iMVyqvnSrP1UPcXKb5OQ3++FsggzaOSwAVPJJwj4jvnmCZKTVW7OtpJADkaKKi/AyKC1wzZJkgYhykLE592ojkkb04gIv+vsdq00fkZeUAc1XcMdailRpI1kqyjUR2N/jTRqEaSte3Wtvv/abvPIsmMK7IWjZPSA0Kkafq5Ok8IDfLztZnJZfvMRbSCxFiGsRpl5NBYtKyF5fZt0XF4x+m1h27L7rV4t2/1rUWn1W8UY/1NbseZkZVtqrDeah3VQUgR3gOOS3xQrigOAqdc/ktwu8tFt4auJ8PNMOcwpbc5duxUseN5EINsQBiwY/hEefF6dor0YWgij/Om9ovRaPXuIG65IaREHYaZltEbvkFVQ8caOtbhpw4/NXSsoWNtu7Xt/q+hY+cl6Nh5BXTsMIRYLkKs3xM6OoA7EJq5sCggQ3qOJTtIrquP2uz1gcQU6JVQZGtYRZHzIGBneBZEg6WoVIn0S2+yAXwFhfY36eJHdJaVLcFF+gy8lgzU+QncigdMilvznlxJsmMUCOiGG2NEL7Upm0n1LRtFH0aJyCngYSM62chlnB4OAQpUB12Co37DGqderV9VD2YzlPgUJWb4fqBAm8/qv91dpwTojUJ0F1dqrZ84LqBq5tyHNEJ8Xiv3lUHQGqrXUL0O93W4/3OE+xqq17Zb2+7/p+2+AqprNPQ0VIcGe0N1aNs0WYalTlC5fnPETqaiOSD1ZoFNWN3JMTjhClAl/fUv9CH49a2jxqE+G23w7HNfhw/SeYQWKgtQTCWhB43v4ngdHR0ePsBawRo9NvlaNtMjwX7wqWkHq8MFTNAO34NHTZWdYQM2upzqNKNJsxtKVGDl7Yi4mmuSB1U1/WTGs5TTk8obyECYInOAL6FoZaLbeMYbMom/RtS6ScpTkQ/kug69x18viyL0hCy7pu/Z0aA9A063REQRbnG5YNHpDTNYr+sI34clVzVKcKFvbottrhCaKw4rLfNwg5sCrQpDF9isxd4LHuLxejon89W3H+bv2BIBKTmEBD8Kx4TEDAJM6hLUiBzeKD0zgp0oBoVBslRvrY1Kp3LQwJjrwaSwn/wrIdhN+gbdOUSCGbhumnbsJMhbYK/br9IVdMS98DBINosfW1kdSsc/hFk85KV+7yggUuYgfXX2G9/O+Mk32LFEPyUxsGMbLSIlguxmncrFC3J9KRN/SakZippB1KJ3W1yoqb3RH3OxwcqRBPcimq0vHlzRMwr0MM2CO0h1mwecCc1H+SyVna7aF/NRomcgvTIfP/kf1NuGpW5MOTcWQbD0HDZl9l0QROJvjKHqoKncLBOwtC9mi15xNMgijJZZYMlQQxrSAOxI/J2CYfhKmfgCYzdBl0BVUchsf6aVBb/wM71A8HNJZrp9AyEWWzqBHX0xzziggQMayk9Emn/91hswC7aNMqjXVUgBxvn6kyfQjBZ8o6K10/MT+UPqg+HDBlaJSrQ+Uj+Ocieorxg9wNZZG3DVCL2z02X4DQFNC8NYabLSosH2DFb59QKInlvzpvjNtj4xov7R5EWJR3lt5cL3Nm/tpZ/wJH8cv/s7ebza0/wZPY0GwzJ9q3zrsyKo5O81pqvW+iJ6TxX+h6dkq4S7ATmrV40RxRQJrT0eo1aTVdt3UlCVYC04veR8gJoVrMgSIaFH84dckAgt6ROqIbDMIa+THr7VinXsdGROBqPAJ64r/o4SfaoiAJWErFM02QdI3HxA9yEmbXieF579EujsLf/qzHG62AzfQUt8fL0P2E5WjINKvaARjozsRDku/TE7JUJA0C/rlVoxqhqKQK9Yi3AVXbj6ozeFhX9hLFj3SFefYerpnWP1CeFckJnwSDOxXRnav0QbtM24E94a00bwugDARGGEs+m8QhGI+XrLIwiXh7pTdIht8TMUILxSn3bTapoGpRT4jbEgiiHRLRD/RuBHl0sfX64Unx7yovvrP8KsIwZC/cM1FrGQj0SlJyodvGlU00HoeCQdfOH4DljGNg8PWOvABOkRb0OOj4n0zW2e+1AOAlOK15ByumDk259sLkry1Ux/3Pkd7dbs/pDzTu7TQp2/yXP0Blx+FJjaQz/6HImqvRBT6oGqzhS6VPYvMFvKMuZvJrCUj/8Ft3mLaA== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get Account Activity

+ + + + + +This gets a single account activity by its id. + +## Request + +

Path Parameters

+ +An account activity object + +
Schema
    requesterIdentitySummary objectnullable
    targetIdentitySummary objectnullable
    items object[]nullable
  • Array [
    • requesterComment objectnullable
    reviewerIdentitySummary objectnullable
    reviewerComment objectnullable
    accountRequestInfo objectnullable
    + +If an account activity item is associated with an access request, captures details of that request. + +
    clientMetadata objectnullable
    + +Arbitrary key-value pairs, if any were included in the corresponding access request item + +
  • ]
    • clientMetadata objectnullable
    + +Arbitrary key-value pairs, if any were included in the corresponding access request + +
    cancelComment objectnullable
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-account-aggregation-status.api.mdx b/docs/api/beta/get-account-aggregation-status.api.mdx new file mode 100644 index 000000000..bdc688eba --- /dev/null +++ b/docs/api/beta/get-account-aggregation-status.api.mdx @@ -0,0 +1,91 @@ +--- +id: get-account-aggregation-status +sidebar_label: In-progress Account Aggregation status +hide_title: true +hide_table_of_contents: true +api: eJztW21zGjkS/isq7sMmFIMBYzv2lytik6y3HDsH9qXqHNeumBGgzSCxksY26/J/v+6WZpgBHGezuduXomprgxmp1a9PPxKah5qeC8Od1Oo0qR3VJsL14lhnyvUmEyMm9GTouMtsrVFzfGJrR9e1MISVxtjaTaOWCBsbOce/QdblVFrWe3/KjHCZUZa5qWCWZDE9ZlyxulTR3GgQYm2d8SCVL6U2GE+1mrA76aY03WnHU6ay2UgYFFKvn/c/1OsN+HD8fe/8bf+kDoJUAn+f9M/6l/5vL9iyMfyTMCtVLEja3IhbqUGd6pIwBp8uV3FTbcVSjJtyx6b8VrCREAqk6BgMECBZszE3zY/qo+qtD1basXjK1UQ8pwPjxg+HUWmWwHgJzqqT8bngws5i+dKTsLZ3PEwfLWAtH40mo7jAf4m0DhZwbGz0DAQVKg9jrmAWyLFTfadwcdS0FG12ddpgd1MZT+FhImPuhA2xKbxkvRSGc0ySgoroyrupAFkGBS4Kb2iD1pLfhsExoJ9QyVxLSAgj5tqARK2+KoUqbiOnrbmMzXiuDcTU3WFYY56maFRVGVKyfqHSBeO3XKZ8lAqWzXEcaDPVmWF87LyBlZDGejZPBfipyd7BYqDvXIMqlNn1bqvLziHebzBB64UE7pp1SiYQ/wlUosEXg7c/9k7enZ432PDianDcX/lrePWavkCvnvSG37++6A1OGM8giY10C4y8Eb9k0oDjQWs0c5kcUORzbvgMFDVY6g81iaU8524KjxQ8gL9kAp9tPBUzXjt6qLnFHL+1zkg1qT02arn42pEzmViHBbEpToykinuOboJhnfiw/ar1qntwwPdHrXi/1YZPr9rt7v4I/t8a1R5vcCX0ohUW9ei0WvhPdbWe2rhYnkOjn0XsYN1YKyeUw/l8Pk8xo2HYzs8WhTysG1tMhFQCAHXSqwBijVv3SaM21mbG4UktgVKJnAQ/VoxtddpRqx3tti/b3aPd1lFrr9ludf9TW3Xeh6lQa6lFq4qkib73hm1SQQCeIXgPL3sDwEX4pnd8fHF1fjn88fji7Kx/7L88vnj3noATP/fOj/vwCD8P+peDU/p02R9AevVwyE3ZiI3iquqHtVlUAZOgf4ONMgcYmpl4mSHShfYEGGo9hIZCSjzOri0KwodPySjm+rUw9Qu8KjB6IdwKsNNKhWNWtC9kshf1ubZWjgAbqFKFMdrY+ks/Pffl6nQOgJemHqQzK3z7CN5eGQt4biSOFDGHoQiBkLgKMlHe+tK2GQBx0S3/LY3LAJN7mNK4Dslexm9F/IybTyAd/DwGZMNPhEO7DFe14a/fvCBmZQWCS8kJgComwpRrYa/T2oQYa40f+n6DhZ5PoJ73+5U+rYTHuZEoNWooR495pTIKjTHRwpZ774q4OwGtOVNf1seDSAgxLv+rMJpJZBMogwQpDfrdNcqNMBE+mZZ99JklVpvRHUJEwDdE9fUCgVWKZG7WMT5rDfHzMWrvbYzRV0TnMyzK+86IcQrpZlcY2fNS4GsijAC1nsIJ4qLY7jzFw5YPrjWCYyWBy7KRhcYlkNeGgRY5TirKrGOjR79FELBKpPNA+hQDf3zEYd1We73PXanQ4X8F2yM2yJlfkW8SszqnAb8GSBU8EaaBuvhx7IcPl4FrIOe5n2Mbb367/kiIuKFJsxkEjQP58t+PoGOROn58ucmggrc8lYm3wAPVEem91Jgc5V21u77aG21GMknAxjU/EQCzhc6IgZtMKdSE2wbBgvoupBpkH9LZEjeMPDn8dp5KhAPTjnUiNvXyFYOkEtHEcImGkMsApRPCu1uZoAUzbdC3KDIvBhrXrPi222o12+w1T8AtUAjWseNgDCan4fEnkIXbxOcUulIS5rN8ClC7gLgblxUHgo/2W4ed7ni/y3nnVbd9sDc6HPPd3dbh3uEhrh7yo4xL3Bi+WFv6rVDCyJilGgqYigELHDMFFMjTCQjBzD4fA5LxBf5H7PNjCzPzfHbi3gHcsNfH71n3gKUA8xl9zycrTlDR1RApdpYSgnjuDJZ7wRdGTqT6HK076b/pXZ1dElP711V/CJ9Q1tquvKfyLZsmJIUdHmkcDLiD7m8FQi4UPqsHqXUwiIcdfBgow35+YcGZkFtjnqUOZoTVN8woi/Z7TnxoQqpR3dw79kI2RRPoGX4HlBl2mCOOeB42f7hLFXMXnQVP1gOIvWyyXpJINBJ4AiAE8hKEeGi8PAlbaBQwzqDiBVEWDRQQOr0EmlKJxdKV1WgsEfqsHBQsDtD8+TzpxUSOyMxyFRbZElTMt9RJ8FxVu8uS08ilC+U4EDJsWLCJ1caAh4neSuiPAY4wXBaAR+XjpCIUbVYaTx+1eeeVOXGanhHTfL7u3qcAPxGZVjy4FaH4CCo9GlE08jAFRCIc9bWSjyrClRc+G0uRJtva3dbutna/sHZXHw7CYQk9LbSiagk8yWYz2AMufKaF58S2GQxg+WHL8tSEQrXKVlAYKzhWrcocaqNOe9QeH8Sim/Busr97OO7E+x2+d9A+aI+6nYNauddfL+u4KLJqTZXi7eNILgYSdws8LlOQXNZpnVSyFd0L2wqENTq2y3kz+BxcerPkjt117lgc0gF3NCvcMZd/NThD+bA0iUe/+fMILFpynd+1FDtNcS/tNzyE2lLHLXXctp9t+9lSxy113Nbutnb/19Sx+xx17P4G6uh/B6Uf6v9I6pgA70BqNoaggA1xBu71v0SDKfApnD6GsnfcTIQriF6FRXYO11nkpdbsHVeLnCzZykmkWroL4Q3GznCsycfCAM4mAJGKAWpJYLeYVXjODZwU8oelciapjtEgkGsWUY9+u/E1k+dbsUr4pcMSKNB9C1j3jkv8GWyM9A8k0DnoBID6G55xhmj9rvNgNkCLz9Bi1r+PhcCaL85/9zb9JHwKyhuEi6GPNWX4U2fmXME2QtzPPXwVFHRL1bdUfdvut+3+79Hut1R9W7vb2v1r1u5voOqBDT1N1WHAF1N1GNtssYJLvcHk+r8zdiqVoAGlN9MxcfVkycGJV0AqhevNiCF4m/GothMukUSl6zR250Emjzs2v/HstwNeu8ykMGvq3Nwe7ew8QNAgWI9NPpdNwDKIm1sofdeM9WxnBJ7aAEL+3i0mEA6gayZ+gSa52UjMZA97JNw7nQzDnAXn0zWDz0rGO5oYzQVeRfViGgyyPmQVfY1X1mBL8Z2l0U3KojX7wK4rkz7+flu8oCds2eS+z64G4xloumIimnCD4YLogyCK1xXoc+wxq5dhxK9vymOGyNG9hmsjl30Hfx3orCl0gcM67LXgBi/q0oWZFz98uHzJJshMCRkyi6RYSLruzNl7SCNCvl5+eQQnUTMyOpv4+3O9yvUcrDQ2TsEp7KMaCsGuT4OjzqElDADDye04SRBs4KybF3kEE3ErUuyWzaW3MTllonbAizu8Mu8ldUbaQkjlr6vi9bKPKmInEgELq4PGBBNpR8iu57ldvGTX1yrxj1xa5KVFJM2+XNHCu/Y6TiUCZwzljiJ4aslbX724lxeV5OF+C75Bqas6oCeCHtVLVXEeta/WoyIvQnlVPT6qD3T1vjqNeZTDO/tZmrBTFk+1tuKfjGHqYKlcTzKotK9Wi+77R1QRUadVUinyS0YyAhJJ+p1BYSifTHyETZw4jPbHKVS2P1FkARd+ost4P1Vspq+vodfiyETH9qt1xgUjXDDyOGGD/r6VYWJBbaMNhAM+AY6X8SckCIqWsNHL2oj8JH6H5mD7iEFVfzN8fuT/OFqCYPjE6AGOLsYAVCMHL66Z4UXlIAv7WcVZ+enBqgfX9U01tNEVv3l9i99AsbX+2exFi3vLQxa8afmtUfoJJPnz4O4fhHhbpPk7Ik1gxZhutGzYPpST/HXgdOuHfpauQ1u6TU21SgQctjfLtwDKguYpd5jVVNXxVAo6LpgL7pAfNjCz9IwqMb+6HV4nAErO8czaAm/lI5mCPDrQzlfmVDCefGJc8W+bhesVOtyob7IPsINTQPMN7t7wYi88+1mHbdwQIvOeXjE7yYMNpGs2yxS+3ABqZzO8R/5cRiTSxpkHrvB2hDdBE/UrZuVVjKmGJjRpH2Nm9mKMJ9GwyS0F/pm1IO42HEOD6zGK4d2spSEDkYY3Mxsr1P452ZBt0VSkc9w/AuoCAROlFd6dXq5JBGEq/PahzWQnTLI7OBaE4BbKp89us91sRbSlwNcOtHWw4y0JP12+zcc2vGXKio1ZJSsflufx27dOt2+dbt86/eu9dRqYHG7Bd+Z4yoz4kPljA39ec13bdF4DU4/8+6geGWCDD2XjcPjDA55L4hnGI379Sybw0Ov6Znk8QccEkJD4OakdjaEPr76uWoaWF4NgwUv6ZfXJl1g32pKfq6vF8kitBh8/CTyJg3mPNzDKH5WSXv6BP0wtTVn7uRHPNIoDrrd9ANzH/wJfEVE2 +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-account-entitlements.api.mdx b/docs/api/beta/get-account-entitlements.api.mdx new file mode 100644 index 000000000..9a0c255f5 --- /dev/null +++ b/docs/api/beta/get-account-entitlements.api.mdx @@ -0,0 +1,108 @@ +--- +id: get-account-entitlements +sidebar_label: Account Entitlements +hide_title: true +hide_table_of_contents: true +api: eJztXHtT20gS/ypTuqvahLKMn/hRtXflBZLyFgEOzOb2CLUZSyN7NrKk1UiAl+K7X3fPSJZsAyahLpuc/0mMNNPT089ft6S5s8JIxDyRYTB0rb41EcnAccI0SA6DRCa+mIkgUVbFSvhEWf1Ly9xV1lXFcoVyYhnhZJg6mkrFBqdDFoskjQPFRIECCz2WTAXjenqVsQ/BgCXhJxGwG5lM2cnZ298GB++Gx4ynyTSMZTJnQC8Wf6QyFi4MZQ73fSCiV6kCT0o4KQ4Evu6sCyXi/TBIxG0yAArIq3SDvllQ9WPBXevqHtiOeMxnIhGxookSmY84TKlYAdyAv6SL1J2pmHGrf2cl8wivqiSWwcS6r1gZV1Y/iVOxKoh8n4woiVs+i3wkIbxm1+u1mq2O6LXae41xezzuthot3t5r9jpuF4gbhv5IRTxfcBR6nhKJtbzUCV1mMgDxoHi9FEQUC5X6CYMbVXahUpDanKlIONKTIEiS9o4vZzLZQalGfCIDngiYH4fpZEp0NAlV/RCcC8Euf2mSYs8THrg8dtl+6PvCQR7YaS7Mq1fTJIlUf3fXFdfCR7uqKi79KAT2qk442wV97PJI7ipDx3ZyOvZCKa+ZF8ZsFsYC9gU/Z2SdqO+F2D3uK1EQbG2NumBVMRExzNNE9KVmAy7MZCBn6YzmucLjsFf4ff+Q8ElYK7J/x29ZkM7GIkbjNhJDiWr7/2Zk12h/gfRm/Fb/Jiq5LOGvB6VJjrEizaHHdtCZdphMwEbBjKMwSn1tmILt/NsehQn37X2cvYPijsJACTYFtwYNkFXjwDUamXKgGKa+y8bCKAf8QHq5F4BE2Y72sB12I1B4kwBk6IIOQYsycAQFIqESCACMg5KBFaY93OEBm/JrcHkGWiNh4Xg5i7iTVHA3FMZAhxAIXVg4CBO0EiVw1R0i8iPtfAd5Im6vuZ8KLQUcDWynKuPmm7ApHRZXjGochr7ggVWwFJp5j2E5U6nCCY1aDf8r28ggYDyO+Ry1mwVYUU5TDmYAMC+Yy6PIlw4xu/u7QgJ3qxwRPZgnEzFThevh+HcQBNyIYhRcIjVbEM5X8sG68F/gajkFNJxevVvrdjstz+vV2+1avdOuQeznXDj1vbqD+UV7ynMXolnFpY54GsCG4xEYbgPpOpAEE7HJHuQM7G8KyTlZWuSGK5aRKcQGFy7YiVxioFFr1Ox6za51R/Vuv9nstxvVWqP3H+RlFrqUkL6UGZ+rhOXEvoglngAD4zT5DNnnU1e1MBMYkU48jICQnvk4cxBYkRx9s9V0TDAwqrB0aa394x9LSq+cXJQunMQTvKT8KLEBZ4XalysH+z/i3UF+ZXCA1/wQIBcKRoVp7Ihzcp4T8owR8bsJ39qTGA5cwz3z4nBGF/UazHhocVMTwCURshHF8lr6kJbcDWLKCi8gcR1gl9xTsQLdpRiGPuOHqfs2vBaYNV52XSLNJhnt1bVLlFaFXTandcIvXPlKpmPypmbzJYVXJLwqudwf1wb1pbTCZjxC8XixEDbGD/ZJzG3tcBGXsVq10rmChFFc986C+OO7xxrj0O9fyLmRGdeVuBb3TwvZxHCqKb5c6jEcDg/WZZ1Gx+HdbtvtQNaBX45odHmtVhNjZDPZ2KfNGjiwomEK92/4XCFS+WCdn1yc7R9+sEoM6IvPS25mmZWIenJwbg8O7HMtuZWwCsjTCm8CAK+IAnwfQi/WeY8bwTkANl9XSAejE4I8qG+ik8WwtR70eVrSdKWbL/SQWzZ4w3MB7PC2aLbaXr079jq9Ts3xoHD0hNN4nkT1sjj+yYWlS3fmrP6YbYgAwf+lNTw4PB4NR7+uawuIUvAnFqpsGIBLUGkaBvAPjciIoHurNIrCOCmHxcUyqGPiG80BKZ4JD4A7IO+DJKQqeskorjCcAlh1klMRz6RSwJ16DhDcyFwWtI3NwEYSrCQAOrNzAN+nCL5/UAzACR9zJaqMwjT8hZvmk0ksJoitdMRxUpg9A43peKOoUpFqEagq4CNQYsCNKBKA2LHywILkmsdzQEbxRIBsxyK5EYCeACKRjKBm8SXi5d2MvqquGHIsJ9NknYCWYie1ZKA8ouHslahOqoDN8S4UDlTMUMcmWggGlB7eKFA7TUyQyYSKCe6egClkyWxZEQuTW8SUw6PD/ZG2BU1mIyfQY2n1Alu6QpyADGEfZjtZmVPmrMDAr+fVt7/89vfR2eD4fLA/Gp4clyxzYQ5klRjtxUSXKk9b3qLd9HieP5KKQtPwgLps2QoVzJs8mFew2LyZSmeqNXFYTqMc2JsA+qgWJXtpeZ1xfdzlTbvtCddueW7L5m6jZ3cbtXpL1JsdUe/BjEbPGe85tT277vKu3WoKbnfHomWPm/VG22u0ul6DW+h6UBRTI+oiQljuvsH8qB6Pz2V7PBienx4Nfv3tePDu8OWAhNKxEOuIVHPGMk7ZteRlzDHDgMQcdc3A2yOegEShhtflNGNvcFk2A2ZMy8HwPzfIfQpr6GIeXNGZ8mAiGPegwGYeIIykXE2YOIB19oeAhAV4B5yX+kuXRRXmjRANnDcv+iEq8F3wA7uw8Gv2D/YRJfIx5766BlwdHJ7vnw1PydxfDtMVsepWIQWFFATzmF4KcefdOm+DPLUmMa50lDXUwT4Kl+Um/kITmWoI5qoq0wLRYoWYkhgNw88XUOQScbKpvFP2tE7djZTKCKwrSuT4mKG8VRSX2SybQc5EnJt31IFDmBSENwbJ3ITlAldPM3iGYnCfFaMZJfWCS5U0uxz4tMpKDqiVf1XUf8EeIesQIG6ta6jtEw5gh3EMO7DZWaE3qp8CUInFxqFLD2NkAFKWlCqe22d7IKq7YPPS3w/dDfDrGxkIG/KzRA4FsezARDSBa+liY5Z6lJpkjtVxXEmiKIlqnf3EXdiv3t++2QxKMObOJ6A13ADHXwQS5rNsSgnNry4rOoKP92q9Rsvba3He6Lbqnfa45/Fms9Zr93rUExNK8Yl4Gna9FQB5pcOozJZ/CoxGHGRPDNDim/c0icaG9YMem2/T8MvwoVuFcfbT/ilrdQB4BpOUrvPJkhAC++J8XSNMEz4B3CXXtjqyOuPg8M3g4mgEV84O/3VxeA6/kNZK1TEIwFpdNMuQHgZMwT2TxQYwLCmBvW703x1DdSfPFvlAqf/S+JuZxAYzzOprZhRJL/oGmSs5+gkleyWrolqBOILNSwp4WA24GSreGTiOiBL7yEhyxzzneF1lg7yZoGMeRCSOGJ9x19V1hn4QCK4s6LFImCYYE6UjyrpYiHI5I2Rh5KioFHQO4PxpOxk4CYROsomSF+bWYlg0+gGeteTK3I0KQiORziEhQV3hUFR2whhLOTaGvWH5Y8IRFY4QeIJsXB6xStERuXmnmclwucNTtYHfnfoQfmzaWn7jWhjnIyygoxFpI1OTiUjmES1NNqNydWWOr7PF1ne3vrv13Q19d/nmmcHf5i5Bn/oq9LkIzHsmmDxXoE9M1hOE2csofxK8MYqsIEo1EOnn9yPzFguMF7cRPg59QXykU/nqg9BcH/r6GOFHrqySLpBBkqPegQeRSLh94nvBsQaJJKrm6moAb8cSDDRYAxEhasZsHqaMg8jiNAjoAbmqMDcUKvghMY/GwSOU0hEQVw1cW4P7LZLcIsltNtpmo+8mG22R5NZ3t777bfruo0gy54q8xeAklc5mPJ5rSzP36eU0BgMWneDc5fLXfYpoBYmxHGNZZeRgjRv1cd3rOKLl8pa71+x5DWevwdudeqc+bjU6VjHXXy78OHeysk8V9K31qB+0i/gacFwagHGpJAzdcvsvxa62h2ENQ0+Om0HmINKrBXZsrWLH4zCBvQFhwI7xA+3Fi7OjQjOdo9z0g/8wf/JOvV6ElNTdFbdSJVvouIWO2/SzTT/fTfrZQset725999v03WdBx9ZT0LH1DOjYYgixPIRYXxM6ulJ/2OKBUmAPThrH+mWICLYCv0z30bi9eQMrA3olFNnoraLIURiydzyYZ2BJlTqRwUJcGN5g7AzHxtlYGMDZBEJkgO97SUC3aFX4UQFgUvzAiD4DQj/GDQHdeG4P6J0B83GRsbd8FRk4fgocUlDwQ+y9hmBjEt8L8BD+AQXqg04gUL9gj9No64v6wewMd3yEO2aHt44Q6PN5/7e97i2BITAfY7g417p+4HUB3TPnAZQR4jbS4SuHoFuovoXq23S/TfffR7rfQvWt725999v03WdAdYOGHobqMGBjqA5jqzWWY6k39Ib0/xqxk6sYDsi8WegQVncXGJxwBZiSOQ4EYwgejtG3drOzNHbvpHu/u/TltS4ENF9p7MP47MXnO1AXqOm+yiNZzT4rCsIbevsZ33peE37wbVPtajiAvnbXC1RJwLFEG9YBj4hrcZvXzq38BetHKdOr/6DHORQhTJOp4IdIxp7oMrAYQTHxg/5QoEr2s7I/2NdF7N9/+V40oQf2sk58j64G4xlwurRF3MLV4uwU+qhXr75ygsoim2DPv7Gy2AkOa7CfBI+hLNCvwbz6+f3oNZsg3iR/TxVCXSGxQACPOQUToXg2yF4JwUmUYhanjwxKL92g/zDPhw0zc/zB0AjhGAL9GURmEilOEhQMcNbmr93z0rwHDjv4ENjsgL4eww+baIzZoj4Q4jLK9sUL+/pcJv6WUbM1NZuoqddLXGjRXuqPufCjfBIL9xVJ67MX1/TsAj2bvoqykeoyDygJw0f5VSkn09pn81GiZyO9Mh8fgvf0VVN5GtOxi6kpfc81ZM40DJX4J2NoOugGl5MUvOiz2aJPqWzyCLtRK7Bk6yVtaQM0JP6OwDECbUx8jKmZkEmomyTkkh9Js+DzH+krgI+lPdPlS8igONINnWec6LHEMy5o44K2jgHK8K8TFBoW+DbugeKANoD9hf4pEhhGC3FP01ob1Yn8Ls3B1OAAq0RFRX39R38R4MwvRjdwdD4GwjAi6/zlMfwww9DCLFUSVtYTWJbgKr9+CMlxSW6a3/zJJibMv9p+cceDResEP0h86Sj9QCT568TdrxTxtpHme4w0BuuiudGypigoGvlPBq+ttvIUHUsF/8Jd8lWC1VC0LE6iKhKKfJ7QwRLo1c5UCmoCREJ/WlZh5kAN8ESo19H9odQjQhM6aicGljmUbdIHetSmzlbm5DAaWKJe8W+VmpcmQvMJXJW9x08tAbzHWJPh67pw7/fQFGf5d+nsIFM2gK7ZLA3w839gO50xDib1hEW4UjmpDlxQogUik0VI0C+flXkxmhpuoUrVSTxTJx72lyWehWFtuBboPTv0CUSPWjRnjC02ciZ8skwcV4btT9EGa7OnwqeTZyDqAgAThRXeDUcrFIFYYJ5ohPFk10xSuzgWD/uBzWvzaVbr1ZpN5QIeaxOqBOrYAnFzyGLxW221bIN3i576Vzh60aQcrBV2I2xy4UZSXbvocvHSyspFGN7Xh2AVtwM1yBQ2jgPv7rAhgiXUPV7W58VhHQmqQP9w139JXJTA/9dBiGul/0lgiyI/KNJ0ISz65ndzQX5bpxo+Iojs0MbPlMP2PMJv7zzCR6whO3RyYQ1Xi97LM2PNqzMTGV/TA+PSUa9rWcgeEQTzIgcZazCPTqfRlkO86Bu6L1yYsvLkFDeR9+reHmJG4g/UBOZH/xK7fP8FB6rIsw== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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[]
  • Array [
  • ]
    • 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.","example":true}}> `description` property.","example":true}}>
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-account.api.mdx b/docs/api/beta/get-account.api.mdx new file mode 100644 index 000000000..29e9ac939 --- /dev/null +++ b/docs/api/beta/get-account.api.mdx @@ -0,0 +1,108 @@ +--- +id: get-account +sidebar_label: Account Details +hide_title: true +hide_table_of_contents: true +api: eJztXFlz2zgS/iso7kOOsmQdlGTpZUuxnZRnnDjro1K7TmoHIkEJEwrgAKQdjcv/fbsB8BLlK0nNkdWLLZFAo+/+GiJ448mEKZpyKY5Cb+LNWToNApmJ1NvxUjrX3uTSc1e092nHC5kOFE9wAgy/0IykC67J9P0RSSVRLM2UgEuMhCylPNYkkopQormYx4xQS4nMVoSnmhwdtAn5KKYw9TMT5JqnC3Jy+ua/04O3R+8IzdKFVDyFsRoo/5ZxxUJcJaBxXCzbBkY1CzIcCMzeIE9qX4qUfUmnQAEF4KGYuKX1RDEawpzatSUVdM68T7cgYUIVXbKUKW3IcZQzoUBoxxNwA75xnK+DBVtSb3LjpasEr+pUgZDe7Y6X8+pNUpWxdZ05baLwQIZ9ocskxvks6u9FY7/vj9jYHwx7s8Fstuf3fDoY9sejcM9D5hTTiRSaaVy41+ngv83k5exXFqS4RIDKAIPCUJokMQ+MuXd/1Tj+piIIqPUkMkI7kSwNryrRpVUC6kmh66Tc8gI6abByttIpW7bmTKCLge0ywX/LGEhOZGSc5CRfoK7Dqlp42O31/YFhgoYnIl5Ztd7m5lhf9R1cfQJ9iuPRagHQT9kGMfbxBnwkIdx/kDL4+5KCsj0c3Uo5EF9nvbp8r9PrtzrdVqd/3utOusNJr9f2+73/IEdLGfKIb2LpmOqU2NvBn8EbMJfy1Ax6RTXbl8ulFAepBK7vdx4tMxWwIxNA5qPR/o5HU+BxlqXgTPDFBT5IdoU3Q67pLGY4KZbBZ/NBmJtHITg2Bj6QM85WJq9MBFIpFhubgi6pyMC/V/vViwuqD4URZMlcfqt7dcFuI8xregrG3b3OXn8Q9tigO9zrdAdhvxftjTsB7Q72ut56CjgHIzViwa5l81qRJ1ksxVwTo9mqxu7l5xD+yxUzumwuDNpMYroiohInD6/Nnab/GF3kq9U5go+lTR1fFceZNF2PhiHHdWj8vmLXTVkZ2cjXKWnC+hS+K7g3nys2d35TiHvjRVzp1JrEO4OC915y434xLS9nSSJVah0ZVb8+nOQjMK7qzl/KNJMyZlQ09HckQswBwCuPGuqKlFwSKkiNqLN2VY6Ixhozao1008xrlYZUvueWo0UAiiyOMWwbeQVv3Fai+skysppHZOARIo1XpJImGoK5vPG9lirSUGOhtbz0oBI3un++Zlk5Z6tqnNpcV4u7waA3Gg1Mlqglwk0S15luaAB4QINZZ0J/IhlAqoIpRGlckFzEd/IaQBxMssTKWaKYYb2wznwbWa3l6G90dSHTenZADnhZHxqWyjK+MZc9wT5UI8xlaslFaaP8psNVVSPpOEnbukgH9Qi53VikvsFjobpBEgdcnZN9mn7Wi+M3csKqtCrLOdF5JWKaFnhkPahlZrRuXo784bAT+YNw2OkOh91RSOm41+0M9vwSJB0dHL47Pzr/dwnzpyFdkp+ZANuu0FvXi8smAHy/MxmdlBAcPKrmHlEErHb3un44Ho0CYBA+0c4AiqhPOzTqexXM+7SFhEVZ5VJvIIizWQPInbKIQYoL2EEVcZxcQxrabBiJtx6JIprW8YNBsDfo+2w89sE6bLzHWDQMRgPWG7BZp3ufdTZUz/9LE0XQnGSqBn/urNf2Bom5xlwpoEEX+D21hsSP1oTPADnkZGvA8t301fFhM3PdYmuaM5lXHrgK7PmbetT9mEM8k0OlpCItcmp2DSCEXdrAhoEBizMZmt6fiysa8/BJvez9nmA3J/Zl+AhDvYbk3poranI8MywHMJEAxSseotKWUuX7HXkomHH1/h400e6SVzQEea18+04YtLCiwWegtRler2262HKUT4HkaDZZ7liWjRidDTvjnh8NfUp7e353NJiNI9rvd8aD8dg0mkxrOq/5EFWKrhpLv0FAwgPEP2CR30Eh0D2C7g0DZnHcWYHyvhGN121gaDxC/5hm7NhCTMcvwT2eHUAWr/bfE39EYirmmblO52tKEK2Ls00V1xI+UXzONyJeJrIl9q0Hh6+nF8fncOX08F8Xh2fwCWk1NsSmUFNtFZQmLS7kteHYCXANhVCzGNTBwjZ56ai+BIGo0NWB3H6zWAl8K6JZnMIMt/qGGVXSFnFVQymwG2LkOW+z9g5kZdw/oGmwIDPIKSGRdtPuJQQvS9LWsdPkS7JgNGTqRZtMi1aKQDQCUZi/AkIEeiwMXUsgyjBrGIwosxRBGQ9Y3RalKtc7hDyDHFeNgsEBnD8ivQUpoBzjE7UoLLzFsejsAzxbzdW5O68ozah0BWkyAClKABVAZgLZcAPTpSM0l4bEI/JxRcaqZm+T7t5aZkzyxk0nmulHxN37GNJPy4hW3LhiLviwuLpsZKyRm8llJLiJYpvJblRhrjzwScRZHG5jdxu729h9ZOyu3zx1O/PuroE+3Sb0uRBuLwaLZwP6KGZb2XzD5neLDa0hdwgoxEGknz6cux9NYDz7kuD+6nfER7aUN39bKOxhr89y9JiX/tIWyKDRo5UggkzEwonhu+TYKMqqqt9c7bVUMw4OKjZARLMjsZKZ2ZtTmTDgleodEkqmxTNsOa9M/wn82gyIq4qwlWDLsEWSWyS5rUbbavTjVKMtktzG7jZ2/56xey+SLLgy0eJwks6WS6pW1tPcfZSWEhhA8mdESBFyxlTraAWJkQJjeXXk4M163Vk3GgXMD6kfDvvjqBcMe3Qw6o66M7838qq1/rKM4yLI6jFVsbe1o1ExgLgrwHGZAOfSqZRhffsP1KtYhGnN/FyR42bQOaj0U4kd/Q0PgcgUZAPCgB3VHduLF6fHSB+WNuRRb3YDG4PWqM7+/IuQ0vy8xL5wnW6h4xY6bsvPtvz8MOVnCx23sbuN3b9n7D4JOvoPQUf/CdDRJwixIoRYfyZ0DAF3IDSLwCggg3tCC+RIQBT45HYfXdinVM1ZWgC9GorsjTc84SAleUvFKgdLurYTKUp1YXqDsUscq/KxMICSOaRIQSBrcUC36FV8yRCT4uO6MV9yE8coENBVq9Y0SkEqGzO5vxWrcBHEGXBokgI+VoHrXlOOT1lECP+AgtkHnUOi/o57nM5a37QfTE5R4mOUmBx+CRjDmC/2fwebnhI4AuYVposza+s7Hhewe+ZUQBvBviQ2fRUQdAvVt1B9W+635f7HKPdbqL6N3W3s/j1j9wlQ3aGhu6E6DHg0VIex7Q4psNRrdK4/HLGbUHEcGPcmMjBYPSwxuMEV4EruGCrmEDx1OfF282Oauzc8vPXwuCfiQctKpmIYskjTRE92d2/AQmCZ2zZNeDt/aFzI63Ygl7szUMuGjGOPK6C34ABzktUu0DY6VRzd1uY4Q9xq2EiBDgqaTtyZn7sp52etVtB3EEtmh4CLOxcyl4HFBPqHZ9qMbhuXacgHcl2o+PbbZbGE7pBlk/ruXQ3GE+B0TUTPPhicn849Q7BtV2+c0S0LCG7z9xqLneCwHnnFqIJOwD758vynD+cvKmdkMjxkTBjHngCC5D24iElh0/wpEJxkqoqS2XxhGJ/WnrPBkCFRjCdaPoozxshl5ZQLOYVkbFSKk5iJf5z16XlunZBdsRjLXrvUJDoeD8UuaGiX1ua9MCXO9AJc2JOZcLX9UbTIAcfMw7FU4xgnomntyGWSy0Urcn0tE//IqbUstZahpl+scWFVexnY57YDiFskQfF4N2jrqxe39FoVetg4wRWkus4DasLxUX86Ksit9tV81Oi1kF6dj4/iw4JD/axPIzZdEQ3lLw7JEQkWUmr2T0LQdTAMLucZRNFXs3WNi7ZMRLR6nQpLLbtki7cADRr+jiEwhHUmOsNqbMCItPsiJiR/MZaFmP8FeuWQ/FKT2Vy+hKKJI0MZ6K/mGRds4YItmwO049+9DgCYhdhGGUwesA6wX9rfZALHaCXvWVobs7ohv2vmYGkIgFV7dDeZ2C+TMsG5T8TcwNHFGEjDCKaL58XwDQOOVuVQplVWvg2wrsEmv7GEerimN8tv8WMm1si/mrwo8bTcLcHD4d87S9+RSf46efdPynjbTPMjZhoHb9HdzLKuD6g6+SuH15q7d+YVKwz+wl0TqwZJQ59i35eCKKZKKIlpil5tojpYcGb6/oTRFLHfDnqWXJpIhBYdwx+6O0Nobt5/oYBlCp0aj4Ge2ZnOV6YmYCywRLvid5255yQkuCT0kaxNPkArJgCvK2zD8AlduPerdP1YeWjvIDc2wZdHZAIPdwLb2ZJQcKkHPCLkOshs4oKuTLBcF9JAv2JWHsXoaihC2zQkaqlPItxShm61YvgH1gK7a7efDKpHK7pziKUgp3gQFZMHjKvD9odog7e1FixOsBGErAsAjFVWeHt03qAIxIT7EUOq+a6bpHdxLBDB9si6T7/dbXdapl2A64nUKbSuFeL562IObNSsu99NuYP+V3nZjytB2DvsJrjPZU6S217GdoyXXt4xwvAJD/G9HguQHO/c3OAmCPZQt3gZmn/ssC8/le2RaSvLlxNsOiNf1crzU8fsC1J/s89GPvNdO7EqG3YPPn5m2OcDq9ANA7NmI8YwYm/YrZrKlMaPGdhoFe3zm0P0GHpHzXYfQGjISv8DhAG8PA== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Account Details

+ + + + + +Use this API to return the details for a single account by its ID. +A token with ORG_ADMIN authority is required to call this API. + +## Request + +

Path Parameters

+ +Account object. + +
Schema
    attributes objectrequired
    + +The account attributes that are aggregated + +
    identity object
    + +The identity this account is correlated to + +
    sourceOwner object
    + +The owner of the source this account belongs to + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-active-campaigns.api.mdx b/docs/api/beta/get-active-campaigns.api.mdx new file mode 100644 index 000000000..00d0109f7 --- /dev/null +++ b/docs/api/beta/get-active-campaigns.api.mdx @@ -0,0 +1,135 @@ +--- +id: get-active-campaigns +sidebar_label: List Campaigns +hide_title: true +hide_table_of_contents: true +api: eJztXHtz28YR/yo37B9JOCIFgG/NdDo0RafsyKJLUnVbWZMcgAOJBAQYHGCZ1ei7d3fv8OBLkuWotlNmmlQE7vZ2f/u43XvgrhKtRMwTPwpHbuWsMhdJ30n8D2LAlyvuz0NZOakkfC4rZ9eVgYgT3/Mdas6KFjcnFVdIJ/ZX+AKo/CgSyZzsPeOhy2KRpDH8nSzEkvkh4yzwZVIHKiFbxdEH3xXw2IkFl8JlgfggAhZ5zBUJ9wPmRTET3FnkRJnvZd1cpMmcKI6Fk7DfUhGv68C0FE4a+8kaGL+rXEkRD6IwER+Tfpos4NnNPXG9gk48ESB6EqfipLLiMV+KRMSS+vkoDZEEiiG8gZ+KJRzBAVl45eyukqxX+EYmsR/O4Y0I0yUCNr0YvYGfr68uLio39yeVWPyW+jGO5vFAim3YznHgpR8KyW4XAqSKmQz85QkD6Q9j48sCiT04hQSPgh97E+pTIIsd8ZUrPJ4GCbPFgn/woxjBEx+hf4AyEe/3J/uhACp+UtkW4w3/yAAAG9gHLmMhgToMFWkm6u/DqRDs+h8N1n87YtMEzIPHLhtEQQAaRNN6m2vh5vtFkqzk2empi2KjsdYlSL2K/DCpO9Hy1HfDU77yT6WmU3NyOrVCmz8QNMsoRiuDP5dkwyjqjk5y2a2WsUfJMK6Yixh6KjLqUcOCB6A6f4mah35L/lH9TVQ0xvTr/hCakedJsQvnmB4D24Ag6stLg0CjyuBFnV3JlAfBmsmVcMA9Qcm3frJgVdJOFYFf8bkfgplD/zhK5wttEqSYb0Ydn6GMHP7D4DtRGu5iP/JYFQNDlfkJoArAr6JVGigoBav+szaLEh7UBti7ipCuolAKthDcBfMnPWDDPe6w4EAxSgMXHK9wTwhrmd4walaVTVTZrUCo5iEg5oLGQGcQELAfiCETiDoQUBNkhZEg4P8hA3cW8Bh0ROBgex+igpOcoDTg/RD7ouVShBg5wihBS5ECR60SkT+T5FXkibj9wINUKBSwNbCdyoybb8KCVIjfMSI7igLBw0rJTqjnQVvx/IBmiMNTwOOx/jXRyM0hlahDNJVMbCbXYQKRVHWz0TbC/zHGf1KCAmc1zecPqOzX2VO0IZmuVlGc6LmH4hOQim7xNcSiwFXTv8oyolieIYVq1Xer1TNWFb+BLYZV9QzRzZ/KW/0UWExSWW69MT9hJyZ+Y+9h2gk5xII8L3lfOThvSeT4QQWWAgr6CK9JgbhgpvC4bqdA/ivXLCKwrdepevY0rYI6SGEnDPMSaFnd1UsFc6wsJkoE2TIM/L9NuPqUlGBwzLOWyP4FeJZ19mqd5ydZI0yqSsklxTEVPdH7HczyIJLDKHy1CnSyevqLxKHudvXN45ijZfiJWBKLUSjGHiV/uoXiBdNgPyHRKHnKrGwj4FwrsTft4UQRukFjPEQyp3Z/A1Eng5H42RxtB7yLDJVys43pRacKXhwtKW6rNGGNqqyqFLKKCWbpsU5bKd6rNBhLA8vpmV2j2+6YPSEco2OYHZN3RKPRavFG2+CFe2WeOBEffHG7M6n2gSV8gWyDFcdrgPw7CBOOI6Rk9hrtzYfYrqjUqT93A8iLkQvDMmqmVbNaM6N9Zhjwv7ppNf6dwQyj9y/7Pw4n6NwUOnDEwWz0jyHa5xLEvYyKKmYYcjsoOTJPkwjYjn4VfbT30pt8sqR+cruj9gLFoVUzujXDmlnGmdU7a5l1o90iDnGG3qiigDvTQKtFfUP/7ZcNYCmAZ6ocodQfhhhOJmMUMIgcHvj/yRpjC3yCKIgwey/GsT+nKHg+fN2/upghI1AIodnBsJEE0wcn9jGmQ7BZpmBQlDo4Cz9wYxGC1YQ151BTMKk6mi3ZNxlKR4BdNEzR8Oxus+V4tmh1TdOyebPdaQjRLAxlKngMxUrJl7YC6eZ7NoKZfsccAOxOzWrPzNZZ0zprNkumMB32J4O/fg2WYPbQVq1OHYA5aAmtpxlCCAVADvZDXtkE0Auw++dsGqUxZIFP8EtoyKCDpA6f7ILT8dVkMPxp/O5y0w+nM/DM8wfRVzna7wZ+B7lUlmF261anfRD8zid74bv+5PKFnBAmNcgJbuMI51tKRJSPIY9xLLAAcacZqoPxZDK86M8A2dwsGrYlLPA7yxRdMIOO3XbbvYbbNJ2m0bYaJbOYQPLLMh7K6zqH7cOFgI1xmrMYO0e34ZPCdLPdLdnIZHwx/GkwfvN2PB3NRuPLL+ylYCidmdk5M5pnZq9uWJ3D8foBQzG3vBQXfV5jvf74BP7o3L1v3uaS0QLNzmRtdLrtXpu3Oi1hQAxud912x7Icx7V7nmmY7tet/2x+ezn1LyOXlkoOzNcNFaVV/VPKFgf9N2/7ox8vf3o9uphRbFNowxzXbTccA/5tOt0ub7Q8t+OZHQF/ul6rQHsG1TrbgVxVVFhZyBRS5WRArCdykmeWunSlcDxGvDMt0ZRIxoZLnjhd7nuDeioNuNnkDsBaCtfH+mwivJK4o/Ph5Ww0+1cmZ0c4Vsviju02rWar1eza8Nv1LKvR7Dp2pyTnFBT3FosSNlWlhCqb0HxEjCvNmi/9pMznyKXFZttsuW2j5zktp9tsNO1uu+WJVstqmIAt73q46qzKOt13w1jVHKkBk+/8ZDGOVwsOBkQpN6GbdVxipQSyrzXsGvUllRGVy/FP58PBaAomOi3iqwkK9xzTNBo9s2l7Bm8KsykaZttu847dcb5cMrzpZXuS4SdMwi/jXSoHajTrgNkLelcG+Jd1Kt35Yfu7vnme9b1cho3l/sgVyKUv5Fefa+8YWinfazXqHbP7goamsXtBO9sXiDf1N1QrBbQCsKPqIrp+fkTXAVVH3EoqadXdV6ayppit5FCRawDKSmLuazO//5Lewt2G4zVctwXBummbNnfbzbYrmrbTMu1er1fyFlUfkY4O+0yGOfrK4R5bbtOtmQbllxAErSeUSk9wns8slfb5TkezaDbqPav1kr5Txu2zPehOv9Kpg66JO13Tc1tccMOEOsgyDBf4aphdWot78bj+cKH2aZZ8c4//nFSa+5ZPB4EPfdgwjsEea5BnFFtJapuPtoiYHblrVVdCqeA/a600X7ZcxbjyTDMEsYPFyCByxb519O1tj1DU5hgYgENBLDvQUe9gY21DWzp6aztSIlC7zW3pJq45sFfcZRMt30ALAzBB4HF+BVqYZz7G0FXoQ3+WdWF+seS9Z1jREdyGrNRqeu0m5xbU1p0WlFS80TB6LQglMPoSwh8kIHLPIvP2KQkwZN9hegFBYLnHAXu1i4+Dl9elH9ZBtuTwmLgzkEu1zcXU/DJcjjiBmu7V4C1rdljAw3lKz/l8C4SwdjVFfwZXwJCi3PN+e6Xj8LGIYglkMvz71XAKfyGtnWMkfTy+4KJZRrR3uohuiWMtwC1Uv1Lg5oZw66yqqVZBIK4OmmQN9UEHuZYAZrafAD306Ht6lEmr6rvsSo46ScK+9+uifsJsfLbkCUy+Np3QiNSZi2ofpsJVUrvQSFb1tvAPddZ3XYotPFC7qhL6r3FHlbuu2g9SO/3gyoJ2kaOUVlp9tRhX6KKAclMbxdbCRVkp99mq02N20neSFJgjMctemFuLZlHrBw+W0Dib3M1KoBGkuPHlgBR0XiE7smODbD4eGFIeTPtPEHjCrF0esTAEZmJRuHujmDlPInrn8FQ+we/eBhB+aiRa/uKD0M5HB1WyA0m8UJOOSPoMBnXOT91oLDLHVztkR989+u7Rd5/ou9svJ3rTWL+l1MfcTX2uQsh+F1FMk+dO6hOT9YQRyxqpc4tKkepQnULnb+9m4Ni/Clp3Fx9XmHP+jvmRmsr3bHtn+tAHAbJzAtnUX+gCGSQclQQeRCLhnhHfBccElIKqsTva6yi2fTDQcE+KiMUcW0cp4wBZnIYhnSeSJ8yNhAy/09uBekmKIiCOGro1dezgmEkeM8njbHScjf4ws9Exkzz67tF3v03ffTCT3DxZp/MkmS6XnBa1wdJEsZ7OGTQojnTnLqd32jezFSTG8hyrspk5VGzLtE2v44imy5tuu9HzLKdt8VbH7Jh20+pUynP95gES5WSPnSFBiCGJ+wB5XBqCcckkitzN5b8Uj6R6GNYw9OR5M2BezxYYMXe0eru54yyKcFdtnWVIciOHDAuMMKZB2yW2jbO2dNlnDnExxKPoPvCFpuQvBVDBE7WMzruj86IUQDde1/oeHo7Wp+jzKyx6FD90ghQ4pEgQ4BEZGPeW+3gk3cOcDyhQBjuH6Pw7ZqdaRZ+VybMJSnyBErPhR0cIdPQ8c2/tW98dAfMxxoipUvCBhV5V7fAQDAAKAhWz8rzzmJ8f8/PjHH+c4/8Yc/wxPz/67tF3v03f/YT8XGdDh/NzaPDk/Bza1g2W51Kv6Z7f/zpNJ1fRHKhLTZHjpDEtN2c5OOUVYEr6Nj7GEI431iun+Z0nPCdCuaBiI43xNHp2MewOtANaua/zlV/PzueE0S3dDrMBkj3RxpeZ92EDuoemBqgTnrGPJqviGxFX6Oq7kpX8AtqDlOmiHqhtjVcLFJkTBuatzYce47lqqB2+k9S6TuayIx/IdRUH958viyJ0QJZ98D04GrRnwOmWiCjCTfExgikm2mr0nU8SFJMHFmfWzmBjbGaxV4LHUAWo/Yrv//Zu9gObY3pJ7q0uGwqfvh3A2VswEQpf/WztHjvRjFLcA+9v7I6guzAvAIGZvtarjwOuLyGuTyAQE6TYSZDvY6+nX0vkG/0OXOJ9H9bYuR+rW4uS2mgR1UXn61UmFy/J9Vwm/pRRqylqNaKGVyI3uFDQXjvqtI0DPoskeCAJrWcPrujVSvSwaIInSHWbB0RC87G5p+VkWns2Hxv0akhvk4/34buFD3PnZjemQhWTC7quMGLOIoqk+AtjaDroBtfzFLzo2Wzd4qA18oiaZZRYqqkha34NMkHi7wIcI1TGxG2ciSkRiSBHC13lkj+TZsHnf6Y7yT9vyEyPr2HCxJZu5HzCXdstnnHAGg5YUzFAav7VfISGhefqQAaKA8oABoX+KRJoRktxT9HaG9WJ/Cn1wanBAVaJilydqR9nRYDLbtPSC2ydt4EwjIl0vssHv5mmhZPSBljZEsA2grv8BhHMhVu4KX7zJSicH782eVHifrFSMg6D9e8dpQ9Ekq8n7n6hiHeMNH/ESKNTWz87165rgLKRv9L52u7KnaTPrcB/4S35KmXRUKMUX1gpE1oFPEGrJq92Fr6gmn8leIK53wlaVrQkT4TyHN0fP7iEhOZ0KTAGljlUaX4A9GhVOhuZk8OoxBL1ir9lSoUHjuUsoIYUdfYOyrDQAbVgCYbnKuDdL5GuxYqbUeeZsvEu2DINYTT0y3TJOJjUIxbh+tJJVeCCiiwUGRYRpX55r8yL6T4viFCnYiReyrGHy8lQqZYU/8hYoHep15IBetSiPtFdCDLBE890FfJkK21/jDZYW20hghUWgRB1IQETpRHejGY7FIFYqO8nR/H8VHeSp9gWiGB5pMynUTfrRo3KBXi+imQCZWuJON3ALH/vbMP67orF86/iu2Z6+sG64XSF61soVKrqGFUpXleKShFqjwUIjA/v7nDdA0un+9LdOagfQQWbNwMOyv/1fKBsLwq/inWl9H02vRCgPgPzdCG/rc+XPQBE9nW2Z+Lw//XdsQdwzL/L9kwgjx8R+/Y+IvaAOWRfinumNRw//PU5H/56QC/FV9meqZn/3892PYBq8am0AtWbYiFVX+5UoYqyCdVNbaqUeu0cO0Aq+UL3j0PM7/iBClv/gUPd3/8XHRMI5g== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

List Campaigns

+ + + +:::caution deprecated + +This endpoint has been deprecated and may be replaced or 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. + +## Request + +

Query Parameters

+ +A list of campaign objects. By default list of SLIM campaigns is returned. + +
Schema
  • Array [
    • oneOf
    alerts object[]
    + +A list of errors and warnings that have accumulated. + +
  • Array [
    • localizations object[]
  • Array [
  • ]
  • ]
    • alerts object[]
    + +A list of errors and warnings that have accumulated. + +
  • Array [
    • localizations object[]
  • Array [
  • ]
  • ]
    • 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. + +
  • Array [
  • ]
    • 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 objectrequired
    + +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. + +
    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). + +
  • Array [
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-all-potential-role-summaries.api.mdx b/docs/api/beta/get-all-potential-role-summaries.api.mdx new file mode 100644 index 000000000..05efe16cc --- /dev/null +++ b/docs/api/beta/get-all-potential-role-summaries.api.mdx @@ -0,0 +1,95 @@ +--- +id: get-all-potential-role-summaries +sidebar_label: Retrieves all potential role summaries +hide_title: true +hide_table_of_contents: true +api: eJztHGlz2zb2r2DUD000oizJlq+ZnR3FVlp1fVWSt7trZ1KIhCS0FMgQZBytx/9933sAL11W3Ey3afUlsQjg4d0XAT5WglBEPJaB6nmV08pExB3fvwlioWLJ/X7gi0Eym/FICl2pVWI+0ZXTu0qv02M4xi6lkmpSeVereEK7kQwREsDpiziJlGbc91mYQmMRLtEpPBZPecxmPHan8KdgHxIRzVnIIz4TsYhwPy3cJJLxHPZ8rNxqEZ0FKhaf4k4ST+HZuyfYuLAAZ0ncnkDBegUj8FMHkQUYiQ+JjASQOua+FrBDPPdxyjiIZjAuPoV+4MGDOEpw1J2KGa+cPlbieUiQ4gjprdF8HsMTNwByHC0QjRgAPy2yYgCbs0joxI81SzQsJ2p1zJXHI4/puYr5J2YWjYTHpGJ3/9xnnZseG6STzgLfFy5CZDcZve9eTeM41Kd7e574KHyUZF1z6YeBVHEdENuTntrjodxLN3PcDI6T8+0b5A/g5VgsX9+rezUwz5jUILEwRA56DKgm5McAJnjA4bEUvqdPWbXqRgIZcA7/1Jj0UOTx/CxIVFxj9MMXM/jfPhnDXlMltK6B3LkPU6tV4j+fhSSQAjjg6Wq5jqVv5Vpm+Vt6/gdnukF+ke1v06fbMZ7BFsyYcBDpU4SQSeLNvOdVqyAa8aHG9EONuUF1YcIVILN6SoGhNKE0KBTJhQZ8kLYf24FMqhnQCQxPQN6laWp52zUzM93YBA4YHcUZQmZKOsQ/ipQJ9hFa8jPw3CAEFl+KeBosLNZAG7AEVCQW5ZFU4zsxuIhRYoeBZSWtflViPdDN7kGz4/vKa5Lkq4LogDEw2HJPmseNk8ZRNgXxZ+IDjJ1dX15eX2UDr1QGElAhmKA1r4gFuABd2uvXX84JPq0zy2A81iJesspregyWFgdGlxMIDkb3GQzU2a0GaftzpkPhStBvjz3IeAoqJmcyrjJYFvKJVMAgWB8FycTEDWs+dfBZQvzOVvyaLHMWRALoMjEBJtRXMTlTgsYKlsKuYiKiYmCBR/steDCDEDtLZrTOE2MOtMLfa5lPzFri/SU4O5XMRuAVg3HmGIGjEQXqr4Z3rfZv4N6MfzJ/E5SMl/BrLTddjFZL3OyNWRVto8pkDDpKOU6Y+EYxBav+yxkGMfcdinVVZHcYKC3YVHAPJEBajRNXSARToocg8T02ElY4GJ3GmRWgqVeNhVXZg0DmTRTw0KtT1JbKxXVAhqbwzUHIgAojQpjLFZuCP4DHIDViFs6Xs5C74AWBGog6kcCcBnw8bKyCGLVEC9y1SkD+RpRXESfC9iP3E2G4gLMB7USn2HwVOrXGy40CyFa5qhQ0hVY+YdKZilTjglajgf8tpH2J6woBPKyzL5EMIwkuJr+gjrAXD0NfukTc3i8aN3xcpoBHEUddlrGY6cLzYPQLMA4GwggZHUtDhvRWJboLmu+htiKCZUJKQU40XLftHXnOaHw0dg7Gx01n1OJj5/j4uD1qnHgnJ619zJONjT23JQXK5zfNahZTmDjMYIH7hMVypi/Gy8I6FzEoG0hoFCTx6p3+kryDjShxx4oORky1d7PITphVyvdXeuYyYsOS97Or0QwgD+cLqNZX+fVCRIDtF+uLz8agAOAFODTbBRZ8B5lJiAliop8X0NAUJTDXpvjgf1NAbIKQ2MNUgk9Azw2u9b7S7/542x0Mu+f3FUzv7ivXb4ad3hX+Lsk0fUwGEAUfZZa3Lqt/AQvgRTabyowUqwV+sLMUoZvrYfdq2Otc3Fdq+LN7dd67+s78eNvpXSBmNYMqJKw3F91h975SL+ufWZNbWcYtoTBe3+WbwLN8dgoP/jQ7YSPiGYW9KfMCuIP09Lax3/PMlFIYECHJjYPG9Ho/IpG986s6Y1eY2lKAXOIcxF9tA6VQRUjIEgXr+CgPSjmLWvxgJA7HI3e87x6Iw8PRSZs33GZ7PPbaJ03TdVCaWiVbqb6dzSC6RNJlrxpOs9F4bQhcIe3v5WQKlpKuopiPhuJhEAKazLCGFMXn2LBhfBaoiTa+NDfvzWZ00gAyshJyS0Ky+Z9JSr5ukZhVQoMnlFR4EtMqyDo+YqUFaRNkFJggiU/S5Fs4+xkyj5BMW9huSaSd/Zkkpqu2IRC1EqWYiRjzzIxHmwk6RoIMFYueheLJjKywsCPOrW+w9sFN9wxsvfcfsOiaLXPRtHNzKM9YNnn8a4jQn7CJSDX7GrdnBguZ1up4WUD3N6QAuGPuRqICc1Iki0SejPcPx23RdpoC0oAD4XJn1Dg+ctoHxydtSAWa7lFz+1ygQO23mpmuAK3c5HYGNK1/yQaWTw5rHO01G7gtYH6VzHqZcfdUydFuodqXpjjbOhPYhGqrsaSiFPkSJYZT1OPA97a0NlqELQazCu3bVjXo4REDfORy3zU1XxilbcSb8nYb0G2vwpaEsrkEMWCel6wJ55WFMgf3cINVhkowcGhBCln8f0ZZH7P8p+dhIx6sFaBjK5NTAz6JXFFHdTs95zEfuFJA4Yl/mk4RT7tmpv95li0FPKUOfU79MvwJ2V3Elfap2X5auQhMFXTKLiWfSeQiBCB+wUfC3266B0is2Cdb9g8xp+B/Ve+dYw4y/Pf7znDY7725HXYH9Yvrs86wB+7pKe/A2D2ArLQzC08hbetcDOCZ8cbo5gwK756enp73LQXePlvfpf25VXriQ5z6DBGX8rS7vBt52ORtzt1G8+iw1Wy7B4f8sOW1j2H2iimtViObc9ACgou6sY3bugcfziN3CilvutDUy8AlL3Gpen4Raesd3zMa+7RRZberv1fKx7wVyMl8MQV/DcNZWaDaWDUgT/eC1OT3y0xWl2P9ZVEzM3U9Ymf9bmdIW97enNu/LNt73cH7rBqE8ql/e9V9P/y+3x18f31xXhpKq6z3/esLWHXTvz7rDgam2FocTHcsUZ+jsV4sad1Ves2yooFmhjHnhXETfiEncJMoAlmtiUfr2HPZubql4rFzO7x+378sY52NbtSlHNeNapc3Nc/jYJsWinnBPq88GX0+WNVNPPMlEt2NIvAHju0omsaweQVCDV82Crw51ipSgbFI7yVNwzURyKMO2Rm9FnrOZb+VSjiTiEvEUBDKLiw0xa5HMqVaikCmyTDNK7cFgBP1JnvDIQG19J1ZYpCpEXd/BVjbVO63SsJ6li6BCJG9UF2xrTgSfHTYOGkdjA8POG8dHzSP2qOTMd/fb0DefUK5L8iaT8SqaFze+juhBJZs6Nt8+V9sGAgOvCcEaPPtG7QEY8tM38zNyLT4Mjw8UYO8+s3ZDTs4Yj5Xk4Se88kCE5RzO1iKL0C5AXwdyYlUq1BJLe68+7ZzezGEJ7ZjVakhrKWTIh2VFqYBVQDT4MFEc0PAA9SlWmCjHzvpVQu1CgRBlClOlOaXnmtgJrP5Mqywu69YUQQNpW4wK5mSa06asFeyLuo1KAB02p4fcaoElHnX03FdEcbOheVk1b7keV1nHc+TSCREFVuBz/gcKwnuecaXmbegYMqC3glh71kFsXRFWRY5KxejfepZLopCQeMAzJ/Xk44bJxjykMyiFWbaYlFMGwee5VwZu2GBacRSPFrhAhX0LtcNwF274JmANhlrZt0RnW4Ax6PSeZnHKjpMcneXBpnUmbo80VvY3Y0P7sch0rKBj8IaH735NN6IpJGKyXok+36aFttZmbhSwzfnL3a2u7Pdne1uabuLg337DtWOUurTXE59bhVPgL8RBc+l1Cci7VEBSydRemMFSa8dbIr0w09DMOxfhcL54lOI74K/YH5kQvkS8p1MHvaoWXoSLQ39uSwQQeKjoWAMnkh4p4R3jrFJEolV+8u7vQ2ikQQFVStSRPCaEZsHCePAsihRlDhzXWNeILT6NrbnAsAitDYeEHdVnmNewe8yyV0muYtGu2j0p4lGu0xyZ7s72/06bXdjJplhRdZi8yRte2ykaXYcqeUMJuQHNDOTI1EtZisIjGU5VqWcOVRGreaoOT5yxYHHD7zD/ZNxyz1s8fZR86g5OmgdVYqx/i6348zIyjZVkLeRo33NF32EPC5RoFw6DgKv3P5L8KbJGN0aup4sbwaeA0vfZblj62TFC8AgYJdczdMMSZdySJXzCH0azJ3h3CidSy9rJ+AXFR4slYE56iZneJgM78UwOr2KxotUANxo7nTG+KbDnom1SpbtIpXrJ4AheQI/wKw5AMWSeG5mjDkfQKAMdgLe+Qtmp1ZEvymTZ32k+AIpZt1P5hQoyzL39qr+bg+Qj9BHDIyA1zR6TbXDFSgAFATGZ2V55y4/3+Xnuxi/i/F/jhi/y893truz3a/Tdj8jP7fZ0Pr8HCZsnZ/D3HqDZbnUWzoy93un6WQqFgNSbxa4dGjBy3NwyivMsQe8co8+hOON9soeHmtwzLEGJzuV4tCp4goeZcXs0CCWRD4sSK9NPcJUkNNTnYeynh4XU8ED3Z0aAZNW+B88KGBsDSfQLS2zQZ04HElUYuPxCLjhtz2IWMmuZ22ErOwNlHmQgI8jMDU8ZGMVih7TQWo1/1bT7Dop0BJ9QNdt5D/9dloMoDW0rGLfxt1gPgNMF0hEEt7lny8YYOptdl/6iEEeTrBcay1tdo3TWuyN4BHUBeYNxqsffhq+ZhNMOMngzQV3IbFCAJO5ARUhh9ZJu/m4iGJMfmu2U3pfggbExj4QzOy1PXuud34Fnr4PrplYiosEeQNctf2lPV5at+aS3r1y2LmMzJ0+c3bPkmguMt6FKV28QNdLkfgmheYYaA5Bw0v4JSwMa+9cc/7GBSs2JqmJWy/e3MBzCvCwjIInCHURB+SExaP8lstNpfZiPErwHIRXxuNe/UTXj8rL0jNZeko3VXvMnQaBFn9nDFUHzeBukoAVvRgtuvPkkEU4rUYBJcds6UgHckPC7wIMQxllMrf3KDUJIGtTnjHJn0myYPM/06WGn0s00+M7CKE40wvcz7iJuoAzbujgho7xAdribyIUKhbYNtJAfsAowFkuf/IEFtGC3zOwVnp1Ar9Hayr2XDdB0eGp+XGaOzj7lznijbOzOeCGMbXO3vvhJVULC8NUiVlpU2CRg8v4+gFExwW+GXyzphRGzD8avUhxJ++dXCt//qW99BpP8sfxu/8nj7fzNH9GT2OTXVQ32tZWBUUlf2PzteVenqbPKcC/MEq2Snk1VC35FxSKgEKfx6jVZNXuVArqAoSCx5j71VCzghlZIhTsaP5Q6xGgCX10JQKUOdRtEu/MUZ863ZmTwZjEEuWKv3VCpQhdBJpCVSnq7CcozJQLYsGiDE9awNgvga3OBiCZGxQsO0+FDUnXbJYovGwHaCczxkGlntEIT2o3MY4LajQlUl4EsbmeaVelVoyqhiTQ7TURzfT1GBvMULsWBP/MXiB3bbvLwHqUoj2unxPSFz5pJs4rp+3PwQZtc6bCD7EsBK8LCZgo7HDZGy5BBGDKXs4IosmeXaT3cC4AwfLIqM9+vVlvOFQu0DcAdAyFbAE4voRAHdn8XYZFrXzM2+xf6iNnNrJgSbAXYjML8U1MiWLKwrvKprIQCo0pUIfTHh+x7YF10hM+Nh8zwWIR+I1GkH/9Yi1Ru8+VfcbnylaK7le695J/c872Kir0GbPtBbH7iNnuI2Z/pI+YbdD1/Dt8L9T1v9anwTZwMvt02gsZ+XV952sDI9LPmL2QD7svdH19X+jaoA3pZ9hybXiXd3XpQ7CQA5HoKNsxi8w7n8KqpVMRCCXrw3/XxWSTryn37R+41dPT/wC+M2YK +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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-all-potential-role-summaries)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Retrieves all potential role summaries

+ + + + + +Returns all potential role summaries that match the query parameters + +## Request + +

Query Parameters

+ +Succeeded. Returns all potential role summaries that match the query parameters. + +
Schema
  • Array [
    • potentialRoleRef object
    + +Details about the potential role + +
    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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-campaign-reports-config.api.mdx b/docs/api/beta/get-campaign-reports-config.api.mdx new file mode 100644 index 000000000..eab99d8c9 --- /dev/null +++ b/docs/api/beta/get-campaign-reports-config.api.mdx @@ -0,0 +1,88 @@ +--- +id: get-campaign-reports-config +sidebar_label: Get Campaign Reports Configuration +hide_title: true +hide_table_of_contents: true +api: eJztW21z0zoW/isa74cLTO20odBtv+yEUJjeKRe2L8OH0rkotpIIbMlIMpDt9L/vcyTZSZqUcoHZvTDhAyT20Xk/R89RxFWia2G4k1odFclBMhFuyKuay4k6EbU2zg61GstJspU4PrHJwUUyFMbJscz9ItZS2+RyKylEbQReCLByphH0xOZG1kQK7s+Ey6fCstzzbIJcNtaG5ZENM0FqxoaNMUK5csakY1LlZQNeTCs80EowUYoKr1nKZIF/pZsx7pyRo8aBrBBjqUTBOGQ11ukq8oXksqmUzd7AvA+NNKA1uiTGYzY8PDn7c/D0xdEfjKuCvTx5Hr5lMN6KvDEQAgdcJedWGLjFic9u0LgpOUUW6qC1IY02pMHMAyN4kVxewz8QV2tlBfx4lfS3t+mfZQ+17mTB+2y46CnokZNY5Wghr+syRqH3ztLqq8TCvRWnT25WC/DTo3cidxQ96UqxKsCuSKgNZYSTQcnWuYPWt8PgwAUR3Bg+w0LVlCUfkZB1oS+ldeTk1Wi1MQEL6US1yNqCRE2S661EfIbexPsiGUtjneKVwIKSx4+X1/7PVrK71qulpFw5NAaplsJ01xhKDzlmbiqQGx8aAfVGukC2WWTbR17KIvsefy+7sRCOy3KoC7Fq3UqRIHPTieE+gYVXOcdCBo4fZYEVrNJGsMCSXEomeDpSuHMUeSLbYU94wU6ifcNoDNzkDM/fgxcV/V0KnSuJ9axdghD6kr1FrNgTfPR4e7+/O368y3n/n7s7e49G+2P+8OH2/qP9fZJeCWv5RKzLomXRz4USRuas1Dki8h84BMVkY8/wwtdkzS0x8Dy+wv9nsCvQdmZGfRlV/Bbj7MnwFdvdYyVXk8Y/55MbTlDp+elKTcDywPilkROp1qkiVFNRkj89fDY4Pz7Dk5PDf58fnuIT8bq8qexAIVsLSkuoilyY6k9e42jAJzRAi1aZoyVn7EHk+gAGcWUXCWX4ZmcWzqT2yZvSYUWUvmbFIms2Nmixi6WUh/bI7slMZFtsRM8qju7PRtxiAUJI5A8GeS5qlx5HTz5gUzRLYe5nbFAUkozkJUM1ginWz8CI8aKg0g0Mxg1KGcpIN9WNY0o7mYvlWMxdebNDtT3xeDEoVBzQ/O48GeSugXLezMUq7LIlqhjjA52D55a1O1twmnfpTDmewwpeYqfLNTbBHJ0JtklnWWxHFC6LxqNauq5jUQtszfLt7kVQ5qnT/l3OG/sVdfeqRPtJvWndi48iFh/SQMdu5KPRhil2JLwks/3iSNWFqy18NpaiLDa1u6ndTe1+Ze3efHkSsWR866HPzir0OVccEFUbv3muQB/js0dp1hIFRB4CucXgkAiRfn99hsJ+LxTRi881kPOPxEdhK19RftDFIzwfEfzogrUUC1LQ+zHOFOhEojjwes81TuYo8eGqtGfajCQSVK2BiOiahs10wzhcZhqlSBNut1ihhVW/OTbl6I8cFWFt6IAkVRVpraVyGyS5QZKb3WizG/06u9EGSW5qd1O7P2ftfhFJdlr5aok4yTZVxc0sZFp8T9ZyBgLWnmqyruR8qG6iFWLGOoyVLCOHZNTfGe2M93KxW/Dd4vHD/XE/f9znj/Z29nZGu/29ZHGvv5jXcVdkyzW1EO8QR+9igLiPwHGNQnJZp3WxfPwH9xoxprZGrafDzfA5XDo/Yezvr2LHM63ZC65mLUKySxhSzX1EPQ20FdGalhYEnE3QFxVDq5LQi1JJVgJcDJKGlbKSvnjJCvA1s3QwdjAlFEqbZJ2U7rycOkGpCTVrJJaEkWJMmA8cPIKdoDv/QHQaQ/RdSJ6dkMXHZDE7/JwLQYXeIfdH6853j6C8oR5xGgJ8y0FvmHa4QgJgIAg9q8OdG3y+weebPX6zx/8ae/wGn29qd1O7P2ft/gV8HtHQ7fgcBF+Nz0GbbbMOSz2j5Pqfw3RfKlEDn95M5zldBSnmGNzjCqRSvLBCPYTTNYyk117BsL3lOxjz6w1hBAjKNabEoqlztT3o9a4QM8TqOuO1zNprCkp/ynJd9UZw1JoeRJcFQr0RARu8OoozRua9bCQlcuh6nnnwubeLUha+9+fDX+RM9xsomDPdoM95NlsMSR+Tyj+GijUmit+sp858Eq3YB7vOTXn9/bYERrfYss59X5QGegZNb5hIJlzO792cEvwO0ldu38y3FBrZ+ivCXhJZnz0R3GA2CL9i3Pv99dl9NiHQ6Yu+sYR3haQpAWXzCinim9qgPdGnRX6fMbqZTL3ig6XfTKiI2LiEweyNOhWCXRxFJ/yBbn+C9uxdSouE7wi06vJeG51CfBQlbYTZ3JOUeLJQPXiox5fW3febnp8OpMLHyj/N3qiUPZXUiyRt3kQTTfTDHruoW7v4gl3fqsQ/Wm5p4JZ6bvb+DS2Cay/ycAcnRyUTC15a761vFh74pQv8aJTCE+J6UwfyRNRj+ZeuvI3aN+uxxC8lfst6vFGvpxI76vIyFhoYs9gQy4IdsXyqtRX/YoxSh8rgYtKgir5ZrU8kNPUVkfa3F1RKg8hUpsCHXr9jFIYKycRHtD97eKKB3FQRSvKtjyxq/q2/Gfd2yWb/+ALbKFEWOrffrDMJTElgGnqAjfqHXYoSC7VNNvg+EBJgOI+/7wRR0YW+F3it7eqefc+voa0hh6qei60PwpeDeYOLn5h/QdQdDdowwevutz98Z5EXbVVLzmoPBm56cFXfUmOHvOG3oG93MEW75t/NXrJ4MD8/eanK2Y/u0rd0kr9P3/0/dbxNp/kVO00EvJRuXmycDBaT/EnEa6vneXTgPBX4G299rXpsjcnFz2IexSwyqkvuKKt9VedTKfxJQC24I+y3RZmlK1+JGNqp/DHveUYTAxqUrQUm5SNZgp8/q24lc18wAVhSXOm7bfw4QrLyKSZLkbHXGM5UjrDQYEa3LfDunY4T2iki84oCy562wQboqqpG0XViqN1UjCOl7siIQtq8CY0Ls4ESrS+0h37dqraKKdXIhMyPKKayL8d0yIz5dSHwd8hC3G08YYbrKYr+zjKmn86QE1H6zCS6Zdh+F29kWzoVZU2jIbouAJhYkPDi6GyFI5gpC7swgmsz6cVFtke0YELjUUifh9lOtp36cQHPa20dhtkF5s+FY3feJ1/KyKv5MftP/J8B4kZGE0ivpvMzck8TJqIwiV4k3SSa0LX/dbMoppspXErEV1d03kLD2TU9/tAIGuYvLudzF32DkHDu4ofX98LP+/5kZj7Sr/52QVNUNy0/P6R04LdsyPEDibq+/i8tSJ/F +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get Campaign Reports Configuration

+ + + +:::caution deprecated + +This endpoint has been deprecated and may be replaced or removed in future versions of the API. + +::: + +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. + +## Request + +
+ +Campaign Report Configuration + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-campaign-reports.api.mdx b/docs/api/beta/get-campaign-reports.api.mdx new file mode 100644 index 000000000..9d25ac6fd --- /dev/null +++ b/docs/api/beta/get-campaign-reports.api.mdx @@ -0,0 +1,100 @@ +--- +id: get-campaign-reports +sidebar_label: Get Campaign Reports +hide_title: true +hide_table_of_contents: true +api: eJztW21z2kgS/itTug+bpAw2GL/gL1cE4yxbsfEBvlSdk0oGaQSzK0ZajZSEc/m/39MzIyEZO3ayqdvdFF8SWerp6fd+epBuvDgRKc9krIaBd+LNRdbny4TLuRqLJE4z7e14GZ9r7+Ta64s0k6H0DTkr6LT3bscLRJIKPBBgkqW5oDvaT2VCpOB7JjJ/ITTjUcRSy5iFcco482tMfceUzVbr6+Fp8y3E+T2XKVikcYR/45D1B+Pp+97p+fBih532Jj+/HPXGpztsNH5l7zKuAjYeXI4KMqiihZ+nMltBnRvvSou0H6tMfM56ebYgFWWgTop9G1bQk1TwwHt3Cy0TnvKlyESqzXpJmiUcK3c8hQf4Swa0CVRdcu/kxstWCd3VWSrVHE/EZ/CO6Fbb77aO944PjlozP/TD473WUctv74vOrNNut0Lfu93xUqvyAyadLgQsQ4bIcFUai6z6aSH9RWlnngo2ExCAhcYLQdMjZWDLJFZaaBK0vbdH/9V36KUpX9EGJXPLksWzX4Wf6SY08sl+KqPFPEki58fdXzVxuNk0BSeeWCczsdSV+5YlBZvMjIGK8GI2Dr2qOa49K8iU1kIVRNUoNC5ZX93lW1dtMjplSQxxV+yjjCMbfE47GCaPMlIuSSk7Mikqkm469Ws5s9PpiBET2kKofEkKuTgdDyZXr6ek0zpU6o8QFwiy7yEG0uq+kNw/CFrdFj8+3GsdBO3jzsHBrDNr77c5bW3D/LHNf86XnNKHB3wWCUaLijh9muHXQhH9paVvsX8XK7zb23WkTOLAxsjYrD/NYki6GQB1Z+qMZ7l+gh0NHUnPvyR71ZWTq35/MJngzpve+GJ48QpXg/F4NMb/08EYhag3HZyaP84v3xdPLgcXp0Rbc31x8/aWMrZQuKrtWIQiFcoXT9C5kjSP6k1PrdZl/hX69Xvnl73hq4v3/dH55WgynA5HF+9tkIKqfDoenA9Ohz3zdDLtTa8m9xBtPEBNH54N+24ZSEZnZ8Xjmmm+LEXdVEZlREzEdTbOVS+7T38K15GKVkW1RSFdclB6AdpaI5MI/PtK8DLWFLk+iiAjStN1iBrhLnUR2p84LnPlHFlqUUpRz3Gb4mWPODz2D9pdHwmJK58fht09v7Xf2l+3nbJY9uNlEmtpIrN0XBHrlcishsIjpqwYDW2i1W202o1Wd9raP+l0T/aPmvvHB/8hvW4pJzv39ZF+JMk6gzRFb2pArixPlQiYtCWB6rqAEWdxsGIwmVQfeSSDb+kuDwR+IDIuo34cPCHwz6QSjXnKJUkojMg+FjJw/CgD6qLLGA3VsiyqmqGrFy5YotliLzkgiNOv75Sh0pVy/zfwGj6hkl8pifWsWMJkYHr8A9uKI8Fnh3vddic87HCO+t06Oph1Q76/v9c96HZp96XQms+rTa1sy/WtXwklUumzKPbhkf/CIEgS2N4IYDb/Uiev+8DweIL9Kacsbammk5cRUNtBRXrZv2SdIxZxNc/NfT6/YwTVuKIoV3kUUQeyKU0FwDAepXIu1b34zJW408FZzybiePCvq8EEV8Tr3V1hewrRGlBYQlTEwiL+ZCR2ClDWaxHBHABd7IXj+gIKcaWrhNL+pVcaxkRshZwaIXvhdr9nRZU1C9N4WUsl36Ja9kw2RXMH6A/3UMwACmdcYwFcSOQver4vkqzx2lnyBVugCIr0eZP1gsBUER4xZCOYYv0KjBgPAkpdyyDMkcoQRmaLOM+YijPpi7ov1qase2Ndo19XnULJAckfj5Oen+UQzqhZzcIyWpyIzj+Q2VquLt20YjRj0pXKuA8tACQxgcQpKjsqE3STQNKuHJG7NAqPKujKilWFJabcnVthDCbBM5/n+gl5dxmh/DSMauWDj8IlH8IgdtXIeKNwk6tIeEhqm8WOqnRXkfgslCIKtrm7zd1t7j4xd+8+HLvp2T010Ke1CX2uFM9h39Q0zw3ok5roUTEriOxIYR25w2AQB5F+eTNFYv8mFNGLzwmNwd8RH9lWvjn/l/6w92cEP0pn1XxBAho7Wg1CVCIRnBi51xJXUOL+5m5ncTqTCFB1D0RE1UzZKs7NWQZwtCJJuN5hQSy0+iljC476yJERWtsKSLuqoJHEUmVbJLlFkttutO1GP0432iLJbe5uc/fvmbtfRJKlVCZbHE7S+XLJ05WNNPfcns2CgBW/47Ay5Yyr7qIVYsZKjOXVkYM3a7dmrfDIF52Ad4LD/W7Y9g/b/OCoddSaddpHXrXXX6/zuEyyek5V/G39aEwMEPcROC5XCC6dxXFQP/7L6Rw1pLJGpafEzbA5/WC1xo6dTex4EWfQDYyBHdMHjhevxq+JP7Y27MlucZ76gmC2NR3IeWYgJcUwLC11toWOW+i4bT/b9vPDtJ8tdNzm7jZ3/565+1XQsfMYdOx8BXTsMIJYIUGsPxM6BsAdBM1COIXeHcthXkWwMYEquHKnjy7tM57ORVYCvRqKbHc3UeQ0jtk5V6sCLOnaSaRam4vKG2iXRJsWtCDgbI4SqRiqlgS6paiiFwGASenFgEgupcljUgh801WjF2bQyuZMEW/lLlL5UQ4JTVGIYjp7jRFjEuEkQoJ/4GDOQeco1N/xjNN56w+dB7MxafyaNGaDz74QlPPl+e/BfW8JDCF8SuViYn39wOsC9sycK4wR4nNiy1cJQbdQfQvVt+1+2+5/jHa/herb3N3m7t8zd78Cqjs09DBUB8GToTpom3usxFJnFFz/d8RuUsVJYMKbxb7B6sEagxtcgVByX51QDaEvKU683eJrA717I4Pb3bT8DsUOAVamPI1Au8iyRJ/s7t7AVXDRbZMnsokKBm9lKxV/avrxcncG+9xTeuhNU5tmRMB6l0M3ZTSNcVNJ8WuLnWFuTW3UoUiFyc3LBV/kXLz5vsIAwiybHXr138WSuQ0REwwSP2lD3TSxs6Ef9LpKo9s/rotl9IAu95nvi7uBnkHSOyq6t5yLb20mhLrt7htf3Kw7CZ33tzc2GxFZm70UPMVIYF+BefbLm+lzNiesaXI91wRzhaThANlyiRAxtaxXvA5Ci0x7SeN8vjCC92ov3FDusDCCwuytmgjBrofOCBco8mNUZWNSWiRMIaBV754V3gnERxFR/2uuLUmBJwO1Cwvt8tq656bXmaFAKvuSOe4236oGO5VUgiT1bKJxKpoZj10nhV68ote3CvGPglvDcmsYbvr5HSmsaa99+wK3jwQmFjzSxlrfvLnl16jwowkKd4jrXRnIEk6O+mtSfuG1b5ajxq9B/OpyvFVvzJdU9WXM1i2m0QejgA2Zv4hjLf7JGIUOpcH1PEcWfbNY5vOthsmIRnuvIlLDbtmQDcBCI99rJIaywcRn1JYNKontAYlJyQ/Gs8j5D+bLhA81nc3ta3RPogxiX3+zzLRhgzZs2Bqgnfy2OVFgIbdJB1MHbAD01/43lcAJWql7lte9Vd2w3zVrqDX4ENV+2JOc2D9O1gXOXTHzgKhLGpRhQtXli2P0faLjRR2qZqziPOCuBTfljWI0xjt2s/KWv2pSs/yr6Usa99bHJvQxzPeu0g9Ukr9O3f2TKt620vyIlcbhXAo3s60bCKpB/tLhtc1jPDpnXgj8i6cmVw2kxsBiRjCDYqqMkohnFNUmq/2FFOYAIBE8I+y3Q5EVL00mYlan9MeYZxjNU9AgbTUwKZ/JCPzMEXWxMzcJY4El+ZX+1rl7YSJGSGKgFE32BjOZ8uEWmsfoVV08+zV2g9kEnrkkx7LTwtn0qdoyV9iN8jJfMo6QeiQiAqn93BYujGdKFLaIDfQrVxVZTKFGKjTNZJIu9Siks2WMrRXHP7IX/K7dwTJMT150n9ytFRkL+yko0dVh+2O8EW2NhYgS820ixMJ8V9nhfDjd4Ahmyv2aEafzXbdI7xItmNB4ZMNnv9lq7jXMuID7SawzzLAV5q9Exu58Yq3vxuDN+jz9L/MBv2tENEHsJnTsRerldqKxA+S1Vw6QoD8xX+QXMySmkgVMQUQ3N3Q8QkPVLd3+PRc0e1+/W89LZs6Eq+gaU2qI4nH3I/yqhZ45BYPn5geeb/00/wEVi/M/tVqP/h4ufxN0YgAlMVdDOXOkYwS3D+yhT2XJxs8iNKmVg/irAYUcf6DpuwsYCWXtf65i/JI= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get Campaign Reports

+ + + +:::caution deprecated + +This endpoint has been deprecated and may be replaced or removed in future versions of the API. + +::: + +Fetches all reports for a certification campaign by campaign ID. +Requires roles of CERT_ADMIN, DASHBOARD, ORG_ADMIN and REPORT_ADMIN + +## Request + +

Path Parameters

+ +Array of campaign report objects. + +
Schema
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-campaign-template-schedule.api.mdx b/docs/api/beta/get-campaign-template-schedule.api.mdx new file mode 100644 index 000000000..fb2013f8c --- /dev/null +++ b/docs/api/beta/get-campaign-template-schedule.api.mdx @@ -0,0 +1,171 @@ +--- +id: get-campaign-template-schedule +sidebar_label: Gets a Campaign Template's Schedule +hide_title: true +hide_table_of_contents: true +api: eJztXGlz2zgS/Sso7ofYKVGWZNmONR+2FNvJOus4WR+b2rVSNRAJSZxQoIYg7Whc/u/7ugEesmTnmMyVVdXURCbRjT4fuiFAt14yU6nMokQfh17PG6vsQE5nMhrrCzWdxTJT58FEhXmsvIaXybHxelfegUqzaBQFTCcKAuO9b3ihMkEazegF2L1UmRHZRAnjmIhRkgopAkciMjdJU5ypLE+1wctuqyuiEZGlSkRG6KQiNyprQhCjgjyNsjmEufUujUoPEp2pj1k/zyYkYBTqXjGHX8zRS5UMvfd3LOUsVRBfQecszVXDm8lUTlWmUsM8I5J+JsGt4Wm8wF9RSBNDkKn0erdeNp/RU5OlkR57dw0vVT/nUVpxXLTEBYxwfCgS1mtZf3EzSUzNTFB7qMBYjFRGz0hp9RFUMU3a6g5VGKjtZ3vDsLs37EjVHj3bVcPWcLi9GyrlkY6pMrNEG2VI2k6rRf8sywQ7pkpniw5aKWJTnCvFr95eXgilw1kSgTBMgnwKDjYWiHqawG9OWEOCB+QcnZEAcjaLXdxs/WRIittlmybDn1SQgXCWUnRmkdXBvr1v+fuGPiQnTiOtbOAl1wjvOK70C2SodABtjrUYK01vG4JGZNFUCUwXJaEYRSoOjTBTvFBkD6mtUchL+AgJwEjDRwLKjaJxDsc3xQto7xQHT3HYPz75T31mLSbyWoknkyRPzRMK5oYY5hkiPBNPQjk3T34A2bujo3+upBsm2aQkljp0NEVSKJ1PKfgtPR68fnN68Q/+1D89veyf8MeD/snR6WH/jJK1iihHgzCewlkTs8obi3Y+n6kAGAAz30yiYCIsHQW4rESXiAQZZNE17P1Gx3NxLeMo5CgpRKoG03ymKY5c5PQGeqDfaPFCDdNcpnPW+LVMgwnePLU+ODk+v6A/wDaHJAOvM/Aa+Gd74BH1EZw/F9tOtoYwmUQ0IasiLV5JzVw3fsY/CJl4vvkI3zYxfAo6jMRDsV2xz26SQvmhym4U4uNVHltxD1WgpkOVVpzP+qcvjxZY71mR2517U3QG+itT4AiBYGfLAJ3sp3khIk9bCxbSFH+yWIshwW8QEFbQ2qwyTeV8adJ/W30cwBUGkUaFIrHJo0qxCC9AhVdyiAQFrwgoY1bCainQldcGeGOoM1BtND0aq7SOkZ2Ghyibysy+3u0uCXxcGLrwGic4bO1ggYYZ724B2a/sjKVRSB7KwS9PF1BtmM16rgDybapQejTFxQQP8F8xuV0560hm82WgCcYHTqKBZ7FLTBICsDAajRTjeygzKbDsAbcpAZxL2BtwWcGT49RiQY9ELP0JA30QG21/b5NGOGBZHMIupzHb7YY4wX9+u9ls8vgi13tuXYe4NkBKcUn52CQEZZ/F9QeRUH1wExnVE8fnb/xnu602KUkGjjJgZCbmSqZiY+D5frsD8oHHshT4t0SGkZ1Wp1UbPNCnSUZLnsxKMlgOuW3y2SxJXW1DicKWbHDOl8AWJsowtLvRPJgTzdr9ZoKgQ35fR6EKB5rEfkyVJkPOPXA8zzVZ61PIZYMEVVMCAQEKsTQUEvMFKz/CBFa3bF6kyZQpOi1IC070+RPcliGv07KYd1KHaYZ20dHhI3L4fmvbb3UsGdQvaRoQqNMuKXsrVga8r6i/JbJyuP5OuMpz/T+gKlc5Xw6rRPY4ri5kkFvBJykqW56xKhFGFOnP+q8bWJGDODdg8EhgPltVHxzmZG5UeIbKUWNneCwv9m1a7Nj47mdih+bXSaIttOy8ff2IDDtVIcH/7n3rQLcW+q4jfSm666H/20S6+jiL7OhVbikFogXBpx7lkRzgJZ3aGDmCbC4lMiokymy4iVBCoKOOEw2NRRKgAVxsLgGUHb+177f3RXu7t7PT6+ySHYnvf2Fz2ib4VPRcFHL8AgKKoNy45S7NtaacqO8J2L4p0kg9NGaNokaoJ3DxmRcv8BBYkduUG5QVrGBZRqCCoEED7wDpgURYYMXaV/QCYxaVP6CIXe0yi0jvyRIZjy03Ru7uiKS7qsU+iCOqvo7SFCr6bpMDajgdaRqFxXOYhHMSPtLcIH3DpjlUmYzigyT8jKR/AZjyx6mMSELFIgcgdDUKuY1be8uyyFMet2hEWKLZFs9lCH2tfgdOGYqjVAYfwOtz4uhSR6AXBYlwreMD06o9JYe7rf1Od7TblbLzrNve2xnuj+T2dmt/Z3+fu1vgsBx/Bhi9pByOAuRJAI/8AoOkShq3w8GTr0CdB3zAPD7D/pQ2dmypppNX0OYWbSk8P3grunuouPQ45+dyfM8I2r88p02rPI7lkB7RbhQ0t4zfpNE4Wgk0BZwfHr3oX54woh/96/KIsJ14LW3t9TWiNaSwhKiIhUlyY4tBq8CNpFSMYQ7aGHnquD6FQlKb+sDIbRDODYyJ2BrJPM5A4WZfQVFnbZfpeioFdidQbERN1WwAnPEMCAogXFhMnvaDQM0y/8RZ8qmYKBmqdLMp+mEYkZKAdre2TlHbDoGqYUipaxmMcqSyKit01PlRoBZ9UZly0RsVhJzUnULJAck/HSf9IMshHKtZz8IyWpyIzj+Q2VpuUbqLmtHYpHOdUaGEkehwgiRNYWHenorQ6Dg4sgg7lboYVyLW3V2lFsPdayvMYZbwu0Dm5jPy7m0M+PFZtfLFtXLJZwjZXcdE3ijc5BDJtSNMXPRVhS2KxLcLxTp317m7zt3PzN37L8/cFwvuLZc+7eXS51LLHPZNefFcKn3Kr3aKQfb7A+vIhqCC0Frn1bsLJPYH1I4Yz7Wy+pb1kV3Kl4Tvl/6wz4dF0Vos/ZUvSEC2o/sGBEikwh7LXUnMhrKm2l6eDfXvMEKA6hUlIlAzFfMk5730onyWpsHbS/pJZr8akMgIYywC0qw69PnrmXUlua4k16vRejX6flajdSW5zt117v41c/fRSrKUirPF1Ukmn05lOreR5t7bMwYYIIojLqJMObs5fa9aIWairLG8xcrBG3baw/ZoL1DdUHbD3e39USfY7cidvfZee9jt7Hn1tf6qyuMyyRZzquZv60fPfvWWXqOOyzWCy2RJEi5u/8G8qRoRrBH0lHUzbA6Tvq9qx+5y7XiaZNANjFE7pg9sL16enRB/TM3syW5JngaKymxrOvslZ/mNpfoYmWxdOq5Lx/Xys15+vpvlZ106rnN3nbt/zdz9otKx+6nSsfsFpWNXUIk1ohLrjywdQ9QdVJqN4BQ6Qe/Obad0kt0snL9m+JHpWGVlobdQRXb2VxwFTxLxWup5USyZhZ1IXZmL4A1jpzQ2LcZigBRjQKQuDlBTVNEBANSkdLo9jqYR5zEpBL7p3O/zEQWbM0W8lbPwkRtIyKBARxVo3hsZIZzUiMo/cOB90DGA+hvucTpv/ar9YHFGGp+QxuLoY6AU5Xy5/7uz6pQAHyUhuDi3vn7guIDdM5cabYT6OLPwVZag61J9Xaqvl/v1cv99LPfrUn2du+vc/Wvm7heU6q4aerhUx4DPLtUxttkSZS31goLrd6/YOVWcBBze9ogtH1ooanCuKxBK7sItYQjdNO15W0t3Vs3WbRTebZnqDq5tB6x0eRqDapJlM9Pb2rqF0+Csu6acRU1gGfyWzXVy0wyS6dYQlloBQvaOEQUQDRD9t8eu32iymdOIItnCHjO3RmfFKGZhfD5m8Chnuj9L3pyjFRGWTYPOcbuo4scQcYaW4onh0U2OoiX9oNdlGt/9el0sowd0WWW+R2fDeAFJ76lIKryvbirTYeGpnX3pvnK1ptDOf2dpsjc0rCOeK5nSZVQ+DLPx6t3FZnHSHFlPdwzGQkXUJiBv3iJEGNX6xcEQIuKFJk3y8YQF7y8cvaEsEqMYCouBpqu+V8fOCKeA+zPgM5uUiBRDAlG93yi8E6prFdNK2KwsSYEXhXoLFtqSC3Sb1U3hSNsz7njaHGhfHEYERnR4nscUh+mp2xNXs0IvWdPra4X4W8HNt9x85mY270lhTXsV2KPcAVKZWMjYsLW+enLLz6/xo14KT4jrfRnIEk6OxQNTQeG1r5ZjgZ9P/BblGOh3fI9gkUxYBBMGK2IcimO6Gp0Y9XfBt8QpDa7GObLoq8Xiyws+Z4TfadVE8u2UfuSjQGT5TpAY2gaTHNICzfVJYrdKOCV/ZM8i53/kGwM/LujMj6+wjtLIMAnMV8tME/o0oW8xwDj57TJFgYXcJh0YB2wAHFT+ZyRwgtZwz/JaierMfotpaGkIICpzMbOe/aNXAZz7JPgFjS7HAIapvi6PkNlbpsyL1qoFYxU7A/ctuCxvnGCJvGc3K2/5/SYtm382fUnjfrWBQrfWvzVKP4Akfx7c/YMQb4003yPSuIqXwo2nda1BPcifu3pteUPP8C+O4P94y7nKxTVaF27GuIqpM6KamaKaszqYRIq3AmZKZlT7NSiykilnIrp2Sn93x1qMU4xB2hrUpHIYxeDHm9XFzJITxhaW5Ff62+Tu6ESCkERrqZriHd1SDOAW6szo0C7e/ZS4Fu0cnnnLv5lyWDgbRdd0mmvMRnmZT+le2qciIoxMkFvgQqOmVWELvhAvSqoiiynUSIUm9yjp1LwZ0S4zGtia4z8xF/xu3BYzTE9edL+JUylypmJ347Fxr2z/FG9Emz9R8Yx6Q6AuCjBVm+H18cUSRzDT7nuNJB1vOSKzRWPpuimUt+Gz3Ww3Wz63C3g+S0yGbrbGnH+eSJY/YCSKnzxCG1L71aOFkLytNtp/s183cusMNQhbM9rfIulz27DYTvHKW+4UQdgrf6OIRX9PlxZNRsNvb2lHhLqnO3r8c66o3b56XzVG3FDCJ/QZjekIKHH/R4zqum+cuRuSm/ydzq/8aaOVGhf7fnpetfwePn5QtFMAVe/4ojhv5bD09oXd7KmRLH0dQn1Z2YC/PKIAkw8s8e4DLAUQ+x+Y3A/I +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Gets a Campaign Template's Schedule

+ + + +:::caution deprecated + +This endpoint has been deprecated and may be replaced or removed in future versions of the API. + +::: + +Gets the schedule for a campaign template. Returns a 404 if there is no schedule set. + +## Request + +

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. +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 objectrequired
    + +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" + + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-campaign-template.api.mdx b/docs/api/beta/get-campaign-template.api.mdx new file mode 100644 index 000000000..866505446 --- /dev/null +++ b/docs/api/beta/get-campaign-template.api.mdx @@ -0,0 +1,147 @@ +--- +id: get-campaign-template +sidebar_label: Get a Campaign Template +hide_title: true +hide_table_of_contents: true +api: eJztXetz2ziS/1dQug+JpySZekveD7caW8lq17Gysr2pGSeVQCRkc0ORWj7i6FL+36+7AZDgQ5Ycz9w8TlU7G4sEG41GP37dAMFvtWAtQh67gT91aie1WxGf8tWau7f+lVitPR6LWr0W89uodnJTOxVh7C5dm9oz3TCqfajXHBHZobvGG0DmlYjtOxExzmzViMWKHFts2PSsCVQjYSehG2+A8rfadSTC08CPxdd4nMR32Jvr+Cf68YZ+/CQU3Kl9eKAu16EAXgQwHoeJqNfWPOQrEYswIpousrLmQK1e8+EG/HId7Bh4W/HaybdavFnj1SgOXf+29lCvheI/iRtmFPPDuroTDK5gg/LAXkRqXOIr3PKQbtsetYbWsNNzWqMWH/atVs9pD7u93qLL2532qIbDCEW0DvxIRMhQ27Lwn4pueczZMghZDD/Svlcc5Ays09Vb94vwFQ82itKPkRZfrz01Zcf/jpDgt7IEgsW/hR3XigPWU8wMZViHqDKxKxkGgZbkWKQydViwzDMeZ/Ry4rIGo0V7YPF2v89BXPjXYLBYjPqWZQ1xguQ87urx6s6NzInBp5rsbxz+CthCcHyIgQrfCh+135jO6AU1jvIT+Yb7/FaErCyPh0LXT+XMuLs3g8YzBT41W6mmcN9PuAd6IvnXRJrItw2mRMazi+dTbIgW7yBpmMoqtUC7nPneRlsOcADaCU/jQ43YXRXm2mpbDavTsHpX7fZJt3tiWc1Ov/szMrYKHPAy+3D2hlravzJ3vfaJNWqO+iPiDm3HSbwce4sg8AT3KzoqWILvILfgGV00CFCFsn+8AyVYCLDktKPcHC+5FxHdJU+8WP0GtoJ70JS5WO42anQn1FpapaGPddAXh/QmvZ+qnaGKyzBY5R9kX1wOzl5z3GSk5jCHnsPgD57EAYgbhu55G7YO1olHhHjMbK1bOAfs3o3vpKNIwhD8F0sgLDSf6XRoLFV+ud8f9J2OsMDR9AeDfqvlLBzRbltLnGZJvdyL8JMVRqfp2eTianr1Uzn4XcET2/tOn9vbmV1Aq+303rgRBDymPBRSBc/uervJTrDZdrqrsKm8xl/VxaYdrGoPD+TxuOO5vjhLJHTYx+0JOcMwi27gMCchD3d/59p3+cgQ3QUJaM0CLgXYK+hJnUlzJZUBbYIgdzlrYDhlmoMme3cHJpNXSq2xJg6p53ojByzHArrneditqX7kUtZeEknKTtrbK/CvSix1tGXVFSpyYNPTDrpv6Uda8D9lWalV3MNA3tfett+9r7GX8X3A7oX4HB1J9gASgG2jgCoZ1QLS1Fs9IFHJdasLPzbRUT5KQK/k/xXtfTwG8E3yuQs8A/qEQtqx68sJwuF77mdBIbRuxikGgBCZiN2YWNA+Gi6BT5gtCa8VmdCNLz13xYwnMpB2I00oz6+y3Q/7eY0dDrsEXfZCLKOlvQDEMjCNvGwQqRwlPJkqbyzHj34T8GyM/XPDQ0drYbsQ0pVJoJIQwhPRX1gkpPp+Oi7h5uj4m+s8HGuT+MSE76wDF7UlsJMVqI2cPgQOjojBNRC0KHm/rZDoO5CQIYEcDPo9CiIb+OSLCDcB2KEvhAOOAfEaWMIXV9yDKUB2Ax27oYZcNcNdVsmkEohsFxT4AeUWCfEowk0mAy4Z/iqJYmTJ9UkEyyROQvoVhA7MF/DL7dj9gk1NvQYaIPdNkLA43ORaGUkcxWeeuSK0jQA8DNDW/a15FNeJDjkMyNAE5CXwUNeymAhDaKkznmYl5mr1rloWwMETq9Xs9vo/PxaMK4KMCr7ZsE61u4TUEuaa3JUhmaYR09+ML8avJ3O4cjm7np9OPs7eXcifk/H89G/wx3x2Pvl4OnvzdnY5vZrOLtDLGDahntdB+CLI0uWJzxfbQGMhMFPLiBEJyAeMlFvCegM21opIsIgUgRVEX3PxJfgsxp4X3O/FA7WUwA11G579vr5h+oMVGJVD/EdPF8J0PC333GRj2xbrGKwPfDYTmPe60k1je3D7TgKOYwnQknQfXMlySX4FbyNESEIfI/SSHvL3Rbmk0a7C8IzGiFAXzR8c0RfuJaoNESW3oHpy066BWYAOUg5pmhaEt2Wt3CpcHDQmIuCpkuhpjhb9h0IJ8vFmRQjU5vB2cnE2vXiN+n8Fen0Gf5yOL04n5/Li+PRq+q/xlfFjgi3AOM4n6qr6QY9O5vMZ2hJaEjQ9y5uOeh5hSRAqXHH5lAEWniqG7SbDETLTro1ZtzlN17WfkQEd83MXmJ2rfqU+MUC6rm97CXCVf8J1QNAu4g/2EqipnxtUgyTXbsncmBI/H/2uHSQ+6DZ0AmyBCd4FoYtRCdxoFCShLY5Mp3U6m88n52Mp5OsL42dOwMb1x3P/vVLligIBjIMQ/qN4SefVHcyrW72TVqcJeZf08UHMvVyF0Zx6CNDillKUlB+41GlXBwEkxUA+C5XE5qhKSzPdSZUNaJ5blkVKqXKRX4ZBgzVN+JlMop/3gILJEg9Dvim7doDoEaEpisYRZSb3PPRh+jHP4aiJGLEhj1nJRL2qbxe8YlSVOuRBtwf+rjIZ1eqr3cK78fwC/plevJqVU+ozAWFQRKRYRFFr2UpEEcCsPEAjiiAQL7C55/5Paaq0XPYdApLZE37ItqlfV+wxLGvXAQP9ePqWdQfM4/5tQtf5bR4ECb9xfYnl6sTzMESkzl4SnoXurVuJrbU4zyavxtfnVwhVJv+8nlzCX0irJFF0RzKQBaSHd8G9lK4cAKankfBAHOgJf1BUf4ABcT8yG7ryV7SJQJhMhSx4QvVe8YRJWgdZjJT/SQSopS3XANhLtymadXDKcI2q3GzBI5lUY/MfJABonCtJ/sDuQD9FeARu23FcHKSOyBE8v0Hvzp0S+CNAGyQxoSy7AEgzUeZnI0tMz81JQRcGnO/Wk7EdY02WhqnUWOJirS2KRQ00HCW5QqnXEBqJdAOZi61rbBRcAAItYGxuHDG1HoDTFQGu9HU71wcZuWDgWNbRw5ogN28kM2dxIGs+xcx9jN4Gbz3UdxnQY/Xc74g2bxS5p4abtnXSajf7A1lkroIZB1jxTFixdL0YYuDOgtIZLtKtIIOMVAmQXHFaglPDdspBkMklOPIymaxktzT+SI47ztWfPbEEUwCv+/n7asnY6fQM5/4ewiMheJ1nZl0vBJYgkIG8oVrLhRj2O7YF/3Xt4ZB3ektnsGwNBPzpLHtPyG+NwrKStDFf4zdvx9PXFx9fTc+vKGmdX59PCpNVaPNdJeisZ2PZCZzQK3mdnEWUQHofn1LqF0fztF63M+0zFMMlcEQEUGclSVnisO/A7WNZN5Q+EInnMqYCPNIJE2n5DEvd2otN/WWwW13fqJIKMiDtsriciTMDOmD6gbKqyf6nzm6MRlBCoTT5lC405U1D5OBhEc9ky9qpJG52q+MHOYOCh/bdryUmKqeUBfT0Mo9k06xIr0MRgc4oKywu1mCiejq5vCwmn3TtqRXMM/q1EGp1oMBLk019VXBCOBgB0NIr9RC1ww25Crnitg6iyF14VDo0cgPDz2vAdMy/cJewSN7JXMq+06VPk1Eqw1B5cg/PPF3KwioG2LocVxpfYBS3ATg/n/u2YLdhkKxzqya6FxovwIudKQ15cy6LUuzsakbTKs1azxjJ5/XsX5P5BZYePr6ez67fPkdzNJMvorRHU1OKXWFKYqz0Va/j7RtDjL63bBXp9Yd2rz2ycUlyaNu8vxxZdqvT6jxl70OuI1pbyHX1DqbM5SsG/+J2EDJ30sj9aEc2CL60FUXOpVEoxulHZTG1OC2HySq5sgOcYaNRLgMFEKqwQeWzCL/ID3yin59QRT9pfQVH+ymthoNPetxiJC8FuzFI7ZFXOy5hbu24zTEF2nFXGIEeQo5vHIgaU2EI2738in+dypsty7Ke6vXrNSnvUzDVOOSuv0ct4VUSwlxgRd9JbJWfS/0obviBWRNfUQLoA00ASxngtuk7ktrgBJigSaUg4UlOq6SxJQXZtZpPtnw+eQP/pjHi49v5DIDSRJX9ty/0j4mbfA3CoEd6VJFfVIVLuRsvCGWUPJ+cArA21uG2VS4qIz0uTnKnzQcWt8XA6dHipL1st20+sqyWRXOuO3xMOOPzc1oDkeyU5XCNoBtU3NHgDWCyIL3Yrg/ZMr/UHRUkdV0ABMZkEClYrWbi4SG/Dky8G8P5kGWs44Jal02lkhhKJwSUCigW4jOVFJ4Gh2ZrVYaA5Hvp3iZ6f4DcuEXjRfpUAlQdZLljOcQdYvghhj8aw1GZ9glUqV7qQIUP7oxR4J8CFahUR59oXtMoJYts4Mz+go7MFy55ANQDuFYnXZId8TBLY/ZOW/ZyZqFYCcdF+99zIxyumZulCFzslCRoSxqPPmdFCQ4Y/dYnT9dk81IzHJVaVSHbERzQhVo6dcAYI7J9X6GZYvZGVkRBwBO33GPZSNKk6YXW1hfZNj37LoiEUQHSUIGzOXqWsbOidX82C2/lj/2tbvc+t3PidJ5xeiV98PPsS9ZZpCvSlEtm9rgqPMnMfKO0ke9x62pLLRPutjjkOqSQe8Lq1CJVCimxKBikjJ2FjaIB7rQUmeX+utZZQsz/pDE9M1feGvienzXLYexKmGkKjdDOzkzkX5jUvF/5kJaSoncgxlm4vuP+xCe4QeWqJyzB6eJOwR9I2ItFewAs7P3797WAemHC6AYvs5fmlXQ5g8vCNW6zIcAtN2s5bBzD7CySWBxRHVqs1uA0iBc33Zmc40MVjyt6b7KLxNgNQc+B6ihFS/zPfnDvVz1YGuvL3C9cy9B+dCFAB5T+680ceN/FSVxRlefoGWuTT9tGLKfqyZ5ol3+VJcPq5CJvfrLhd9VsK3i/pEtyR1fFLMmVHcDJuHUnCDeqlqtKuSv1bskumzdCq0wI0oquWbpVe+1kjIz03uD8uohEQ6B1PwUJrauohzOKGrCmhOoq/DYorhqXoaEfZBea7MeNXlOo5znErLOaSxNvQn708WxyOr2czi4uaeX1X7N/TD7OLs5/yl2/mBk/c0A0dwcE/6HogSq3uepNHMYbE8au3g/lNTvzrRXVORmC3jwOf9KSqTaOGij1QtijkdMddbojezjqtRbOsLvsDbnVa7WtWvpild4OOqd5MpijVbh2wxo2rPZVa3TS6p90281+p/2zyfcJLrGW3aScddqroHZdvtDJf2mnpVwAKG5Mr71tdXEFy3w9Qm2Qr0XJeh2E8V/Be8V4qalxVBQEPu12TxNvo4BMghkIu91rc3vhdNvdXq87XMBvByy/0x3ai0EvE8wlEH5L+0svZXeFd0jU5i5zM3YqOimUopBKi2zlpR85eeCbOBf90bDXFsOlGC6w1tMdih44q97Aznik9Rs9g3odZ/sqjnSyW1dTJJdVCwjyzqNJtWyit7LIX5U7g+StrftyFBOPh2nZyE0lu02X82opL5c10lTAlHU5Q9nGUr1pT97evktUyrhi66bSl20bK7U6lVa38wu6j/r1kjuqK+xXdhCLgeh3eyMhnF67O+D2cDEa8t5SOMPWUrQHy0zH5gKVHx27rMds9xSDRntInmJ00rWaVqf3XE8BiFmie82B3K1ycBjPcxgqH/gV/UXKsFqgK4OztI5MOCabYb5wPbpRyxa/pqlAslKa/K3StNpfpcK8xFGesJfva5KgCN/Xjo5qheUA5anKNfObnZXD34OTK65/PNHZ7WNUBSeYbqL/o/pAiZhJgys84WjZbS3s/kgMeLc9ai1GjrD6Hasz6jtWx3Iy4xmfMUVqB1jqgP876fSbw97gaS4QqDPoRSrGVjf35uDl9vFyxqw/39flNoHc6Ipxd2ANHLHglEAC2AZOuqLX649kreGPi6QqVP3ZWKrwas4f1JnM81P3HH+SunCcHFXzRfK/jF95hHrZq0gCf0KnoozgN0iIvm1d1fiF5bQbJqULTDe1Ravn9K3R0u7Zw26nuxj2AfT3eu1Oq7d0+HCJ1QeFqiqUCi89/Na+6VHFfqIFFFxU6S3B/d2UUtHfiZ+SRcBu1aE0p56LG8pprzhrgH/P3nQz9/MvAoc2JqcbzZ9xNk2+eitfzj0NnD1qoa9gjhq3CNCBQ7nZ3oYH8U3BLy5VyFdYaJYkc5vy86sGIIlmi/3IHTZX4ztVg8FKb8jtz0BrukdZ+dp34XmmH2Fu9i5gRbdiIPgCzK3dXfa7nLeH3dagBwGCdzrWqDca0Y4GuV9/9+LDa3zD0bWZejsGBAIuMFIvl1Ln+2+rObwac3g15v/5qzEIJ5JoD7t764H7adDQ0htfhDI+yqelN6LZ0NOkPJJKtulh1SqdLm348nWHg+0ebPdgu09/rY1uztXBFOouQZ9WGfpc++rtKQyeJegjDxzAN65UI7mAKSeSFh8VRPr7uysw7M+4fydi4utav8XyC+EjGcpLzI/T+ZDXF3p7hQ792VwggyRHdfgEeCLhnBDfGce1DCV2yr29CsKFCwrqV0BEPNuLDgqhteDE96lwG9WZE4jIf5HfBE4eEHv1nQYd13JAkgckeYhGh2j054lGByR5sN2D7f4xbfdRJJnfbKVwUpSsVpxWnXEjprwvj7iDBukRaSw1uXR1wEQrSIylGKuWRw61Rbu1aC0Htug6vOv0O6Nl2+63eW/QGrQW3fagZsb6m8yOUyPL25Qx33Ie5euAIsS3/BIflCuKg8DJl/8S3EC3RLdGG5c1bgaZg0g/ZNixW8aOF0EMYwPCgB3DLeXF6/k50oeu5b5okJtcb0KjlccHqjfIRES7+cRXN4oP0PEAHQ/h5xB+/jTh5wAdD7Z7sN0/pu0+CTp2d0HH7hOgY5chxFoixPotoaMDuAOh2RImBd9cUueTpke5mEffolmHtyJOgV4ORbZHZRR5FQS4tX2jwVKUq0T6mbjQvUHbFbYNdVtowNWHVdTJ9ahVeO4YYFI8ishzVy7ZMQ4I6IabxniJJ0JJm9H6lvaSnuiFTsELsPYagI65cfqyU7ihOugtl29r/kJAVR+U+Jx6MJvjiM9xxGzy1RYCbT6t//aqdgngy3whuotLOddbtgvImjn3IY0QX9fSfaUQ9ADVD1D9EO4P4f7PEe4PUP1guwfb/WPa7hOgukJD26E6NNgbqkPbpsVSLPWKDrn8v0bsZCqKA3n+qv7SUYbBCVeAKqlPSaIPwc8vntS2fYelhvuiERlKppIQ94rfxfE6Ojk+/gZzBXP00ORrN90v7gf3uF38eAECqvA9uNVU2hk2YOO3U5VmNEm6oUuflSDtJOJS1urY0FoEMqfdBY9S1keGbPA9G0mmjse0KGWiy7hlGTKJ9PAeeU5yYXwwruvQe3j+WCShLWOpEt+jvUF7BpwWhkjvpWdf7bxE2C17L327MwslWPAvH4E/w2Zt9qPgIX2RBvfAvPz7u6sj4/MbSYQ4V59Twt6CipAzG+v9IPgQxZcwSG7lR8TGuR03aDxs6cGA2Xv/Ugh2o94X3FyAl5+DWyaR4kOCPAE+9eGlnh0Hz5nHANjMJImK5zr+MUjomOeeO6JgR1mB8TWs5nu/wc7oWEBXn/mlPxWGSR67WetxcWNc38vEf2lqDUmtQdSiowIXUrQ3ttzBbYMFIwnuRSSt7+5c0msY9DCFgitItcgDSkLxkd8nZetZ+24+cvQaSC/Px3v/HZ05nX+MScelD6ab4tlKQST+mzFUHTSDm9sErOi72aKDrhtkEY22ZbDUkF023AbgQuLvHAzDl8rEFxiXCZYEskJCJvmJZhZsXh3zkxszXb7Bk5+gpRPY0XfzjB02sMOG9AGR4l99GAuYBdvGMZAfkApwms0/eQLFqOH3JK1Kr07kj+kZDA14/JE8Onl9In+cZA5OHwNON7B12gbcMMLqdOcYHguiaGGIyglLFwSKEizz6wUQGQtyk/ymy5oYLX9v48URj7O6CZ6T80t76S2e5Pfjd38jj3fwNH9GT6OArquPKFAZgankPyq8Vq7jRXTMJvw/3FVnLgKmhowl+/atSQihMmq1/CDfnSuoArAWPEbsV9df1gVLhGQdzV8fhXBL7zWGwDL35GEIG6pR657lMW8SWOK80klwidoxEagT9pvsHSRlvg3TggkZfRwwYP8OVGaWvUZ4picbj1RbJT6eRQhsJyv8xO8ujXDcyE6k44L8zBdaFgFBv/QpbcX0cjsMgY7FFeEqmi2xuAx5qzHxO/qCeY9UZRlEj7OoXgrMBjLHt+joLcN6Abbvog3a1rgT3po+QQRsQYJn9PBmelWiCMR8tZwRhLfH6qHoGNsCEUyPpPp0mq2m1aB0Aa6vA3yX1jeIvxZ49lvVB7ALh/WlNfXaKxEDkjc/kZt9726xUWecqkCBCP94jXUp7D6RGYfM8G5q5QwPHjzBgxDrtTvgFNt8+4blC8x5How3RG8+ZOkMpYEgyfxbjVu5f6lfwj1SXwaJ6Kiu0lDS01orR6LrcP4mS8Fr8OdngZk7DOEB38OXpRViUN6QxRfjkdLyBCZMaUL8eoIzz7fEXvUHnh7y8PC/AYrEkg== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get a Campaign Template

+ + + +:::caution deprecated + +This endpoint has been deprecated and may be replaced or removed in future versions of the API. + +::: + +Fetches a campaign template by ID. + +## Request + +

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
    alerts object[]
    + +A list of errors and warnings that have accumulated. + +
  • Array [
    • localizations object[]
  • Array [
  • ]
  • ]
    • 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. + +
  • Array [
  • ]
    • 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 objectrequired
    + +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. + +
    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). + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-campaign.api.mdx b/docs/api/beta/get-campaign.api.mdx new file mode 100644 index 000000000..8dbd1a242 --- /dev/null +++ b/docs/api/beta/get-campaign.api.mdx @@ -0,0 +1,103 @@ +--- +id: get-campaign +sidebar_label: Get a campaign +hide_title: true +hide_table_of_contents: true +api: eJztXG1v2zgS/iuE78O2he3YsmM3uQ8H13F7XqRJz3GuwGaLLS1RNrcy6RWlpN4g//1mhtSb7bRJW+xtCwNFY0nkcGY4L89QpG5reiVinkitxkHtuDYXyZAvV1zOVa1eS/jc1I6vakMRJzKUPrVjWQNTe1evBcL4sVzhA+g+EUksxbUwTKpQx0vbAX4xrpj4KE0i1Zz5jgBLDV4mC5Hf+smw8UmTDdJkoWP5pwjgSRSJ2LBlahI2E4yzWFxLcSNiopsspMl713GY88mr3wYnr8dndYbjsuFoMrU3mjXkdxULEESAtEmcinrNCD+NZbIGQW9rl0bEQ60S8TFBHuDeuzuQcsVjvhQJ8EGtJMq64vC8XlPwAK5kAL+NvxBLXju+rSXrFd41oA41r93Va7H4I5VxMWpVb1NQwfiE6bCiDJZolDh2SsURxEd4FiFpzz9qP289P+y3Z37oh89b7X7b9zqiO+t6Xjv0a8h3LMxKKyMM8uS1WvinOvKgGE3Pfhd+AoP4qACVYGO+WkVu3g9+N9jjdlvKvGMiE+LtIpJLVrKjQvgrq6+q/HVLCPUcozkm0jIMOt1SJRLjwbmK1rs1OQ42tbiptVb/aOb1W9zr9XgPtAa/+v2j0J+1Wq0+TpWd0U1FTcsTg02abBxa87PyM/gFdpLg+JwlAkYEM6szsxK+5BGz/kAOQFoV5p/MCEG8vj/ISDeyjubgVgZ3B3Oh0D/FeyZUsNJSJSzQfrqE+SmcKxAJl5FpZposaasQ/TVXfA5ek8/L3YbutlX9CQ2UHv09FVEIProW8VorwZQQgcmdioJIwGZrHFjGbGn1Y9XCg0gqsUsnlnu4EwAzjURuWXNVURDQfI2MEI8Z4SZjU1QY0sgjm1SkgjBN0piudBzAfAG/3E/kNTYt2zXQAL2vdcqSeF1pxYtpupHJAq6zcck3dMDXGBrdeCtukjrRuZFRBIrxhbxGIt1Wi4k4hpZZGKnq1Wt5rUar02gfTtut4xb8aze7h71fUINWaw+xKGyBbBViDXUaBagQCMIw1zBHFc0QEypdYjB5PTgbvBpN4M7F+eVkOPrt/O2ZvRwNJsN/w4/J+enot+H56zfnF+Pp+PwMo0zJJ1x/4BhCmozOdJHnRorPIlEOQTOtI8HVlhi2pWFEgqkSje0URZ1DnkZgQiGPjCixQ9fACk8TPRHX+oMYRJG+eRAP1NIw7Iq2DX2/bGyYfr0EpwqIf/N4JYwH4+2RIaP7vlgl4H0QsxkkM8WkDdPYHsJ+kELgCAW3tg+hJAwpruBjuITbSmBop04qJ2xYFhcCFsZ6aYfNQoe1aKkCnA5QCMrYZGh1kEQids2j1LUhojbX2pFkPjQwG0PMIT04ycBg4/m2Vd6rXBQadGsgUqXmcYEW40caxxDlmO3e3JECM3d4Mzo7GZ+9Qvufgl2fwI/h4Gw4OrU3B8Pp+L+DaelihC3AOU5H7q67oK6jyeQcfQk9CZqeVF3H9b9DuAD8obqDi8cIuNFrM203GUrIyn5dmnWf03RdqoIM2Jiq3GB+BbYWOAfpSuVHKXBV7SEDULRE/MGeADV3uUYzSCvtQiYTtuAGvB3irq9TBbYNgwBb3GJXzEoQRo1OY188LQet4flkMjodWCVfnpUuKwou3Uclw5wn4kGA6AEZamipMXz4abzkYnyrM/W84/bhcbvT7LXbNsbrhEeV0qA89ZCgBabTEj9wq+PtTgJIioF+ZuBrmAwqVK2nlcPJLh/IeG63WmSUlHRF8G0YLLGWEf5KJjHOQ2GTlFnicczX26GdRVA44diUjSHIq4Dd8FjB9EOsW3C0RMzYPsCh1PrCjrElREWzC7VXQXcE8S7aZWaZ+WZh4e1gcgZ/xmcvz7cLwRMBaVAYMiyimFnZUhgDMKsK0IgiKCTSUO3JP7emKtPLQ0VAMg+EH7ZtHtcdewwLQKgm2YvhG9bts4ireUr3+bwKgoRqXF5gGZhGEaaIPNhbwuexnMud2DpT58no5eDydIpQZfSfy9EF/EJaWxrFcGQTmSY7XOgbq10rwA3EIiMiUAdGwmeO6jMQiCtTbijtlVkbUCZzKQt6uNF39CiTzpIsZso/UgFm6dtqmT2RTdGsQ1CGe+BN/oLNuMGUbbPkMwsAGqdOk8/YAuxTxE8hbAeBRCGzjAy1PgBULPWDLfBHgFanCaEsfwOQFqqszkZRmJ6WJwVDGHD+eTsZ+EkKzJGYzowtLs6sxbGYAY3Aaa7K3bSkNFLpGioXgOy4wLG26RAg0Axkk4lhrgbH6TKAK1XWTirQkQQHv7srxBohN68tMyeJhmelh1m9N8Bog4/ucq7IW1xdiD9J/Vnlna0w9PrtIyH8Vh9XGHhfdDqHh7zTa/Fi8SMrLSdUVO0IYLbaohDmijHANRCvgOWtAswiqawAsxmo7TW8w2mrR1VGq9n2Or8UtW5RBGQAqwA396N6h9F2YG335D4kbJEyKPFC8NhfbOutL0BNnbbohLPn3UM/nInD5+22N+PdXr8jRLfQm6VQXimpKm7jORurUG9px2u0+g2vN4Xk3PWOu92SZvIq6C9WDGEedn6jHmtWXVBToZ7BCXOkHmBY0JBBB4u3Hm1DG+Vjrq8cR9+vLxthvlBdu9BzBfmBOidQcA0BdWgjs4WaqkY7M094YGReWzwHDfZnvaB31Am6bb/b6nmdkkaRFCvRut/0ctUGuHICPspZjJ01TuoD1NvtPS+pd6sK/2tN0ga97q71z2EkMcxSBGUNMLSi/itnuZkOqArIw+9XrJJWwYpdshrq4AGA5SXouzGPuUQObQryoSPWz9cywAW1pYYcaUlWUlU1FXXR/tkLHoC8Vr6hEwbzRsz9D0BrvLPYqDJ0qST0Z1kXKJhyJLVjWNEXfNZrHXndsNfl3ANj7R/OjkLe6bSODo+OcHSXUj+Pil9h3S995jAjKAQAr3FLLjT4HjDuAeMeMD4QMEI846l5gN+9iSD8NEi0/MG1cM5Hq+s2GtFsZNPkIhI8RLGps2uVT1fm+CyUIgr2vrv33b3vPr7Yo4cT97rGPSXo096GPpeKF6/Zt6CPXYbH5U3XyK6i2omkV+sOIv38dgqO/QFX9A0TH1f4ovcb4iObyne8t87mw96fZTsJstRfzAUySHp0r2QgEongmPguOK4VKLGzPdpLHc8kGKjaAREhasb0+oyDyuJUKXqxaeqAnIVRPxWLc1jsUgTEUVXQoJeYeyS5R5L7bLTPRj9ONtojyb3v7n33+/TdTyLJ6msDh5NMulzyeG0tzT23G7+gQb5xqNhbmK9cltEKEmM5xqpVkUNt5rVn7bDvi27Au0GvcxR6fs/jh/12vz3rev1aOddfFX6cO1nVp0rzbeeRVAwgDvd5pAqMyyRaB9XlP1BvLEIMa7TTKsPNoHNQ6bsCO3a3seOZTkA2IAzYMb5nefFycor0cZ8rkke92YVvdFq7qY7e8yKkRBu2e2n30HEPHffpZ59+fpj0s4eOe9/d++736buPgo7dz0HH7iOgY5chxAoRYv0/oWMAuAOhWQiTglvw3a7dGA8cmcopBQo/PJ6LJAd6FRTpHe04fqI1e83VOgNLprISqQp1YXiDtktsG2dtoQFnc4nbriFqSW0PyeDmT8CkuDU6kktJfowC4SmudWMQJiCV9ZnM3vJR8u2zGBQijWuvGmxM4kGGEOEfUKB10DkE6m+4xpltH/ya9WA2QYlPUWI2+ugLgT6fr/8e7tolMAbmYwwXF3au79kuYNfMuYIyQnxc2fCVQ9A9VN9D9X2636f7HyPd76H63nf3vvt9+u4joLpDQ/dDdWjwYKgObZstlmOpl3RY7q9G7OQqjgMyb6Z9wupBgcEJV4ApuS8iYAzBw/7Htfx0sj2UXMOvByAgtLykcQRtFkmyMscHB7cwRTA1d02+ks3sJJnSN01fLw9moJcdIQd3mFr3wgZs8GbsqosmKTWWdMaSjJKIWxW7U4c1A6qmTQWfpIxbgXHu1rhj2pKp4ylcZ0N0Gw85QQHxk7En3clmtuQDuS7j6O7rZbGE7pFll/o+ORq0Z8DphogowrviYw8XiLbt6FuffCgyCK7zb58HO8dmHnsheEzHs3Hry5Of306fls6i2i9bCIlFAXjJGzARimGDbBsIdqK0Eut0viDGB5WNNugzLIxAYParuhCCXY2dEs4guE8gGpNKsZOgAIC93j3JZifAQ1eY95qFJtHwZKAOQEMHvNLvKeU4KgZKH+5o/qoa7ERi6KETbtjGiUi1HbtaZXLxklxfysQ/MmoNS61B1MzTDS6saq98u3HbB8dFEjwypK0vHtzSa5ToYeUEd5DqJg+oCcdHdXuUn83aF/NRoddAelU+flVvFxISaLUbs/GKmQUdnh8zf6G1Ef9iDE0H3eBqnoIXfTFbNzhogzyi4bVKLDXskA3ZADhI/J2CYyhrTHyG6ZjQiLYLI+SS72lmweff01nG9xWZ6fYVfv4AWgbaN1/MMw7YwAEbNgYYx7/7SgQwC76NMlAcsAYwLOafIoFjtBT3LK2dUZ3IH1AfTA0+sEpUzOrYXhwXAc79YvQAW+dtIAwjms43jME1c7Tu7NcBCmVl6wCbGtzmN9KQEDf0ZvnN32Zikvy7yYsSD4rlEjzQ+q2j9D2R5O8Td/9PEW8faX7ESOPwLZobDesKgbKRv3B4bXv5ztAnaOB/eEq+SlAaChX7oRlEMWVC+BEOtGr7dZoFfsQK18MFTxD71elrJUvyRKjR0f2hvCNCc/o+QQwscyjVZAT0aGk6G5nbD+QQsMR5xWuTuo0SGkwSCknRZG+hFlM+TAvWYfSlHM1+164gu4CZeUPfETrJJhuPxi1ThV98ALbTJcOj9Z+xiEAaP7WBC8oyJTJdaIJ+ea/Mi+mYIohA32oS8dKch7imDOVqaeI/MxbMu3ELyqB6nEV3vK8QZIJHCukUfX0Dtn+ONlhbYyGiFZ3HB7agriuN8Ho83aIIxJR7i6Hj+YHrZA6wLRDB8siaT6fZbrYaVC7A/ZU2CdSuJeKvRFL6dtGm9d0WK+jfwXfmXHLCquJghUtgKHJqqxxbTF7V8mIS2h/LAL+isACl4KPbW1wgwfLqDm//kQqsvq/eFZUTVZwwadUjkvdq7MnEfYPtKb3iedDH5nbKkC32qXVR59fg5weBywMgBRTRIAet3xCP9oFd4Sl12XoHguVZXnW/GqGd8XsyvfuBH+e7u/sfE7/3/Q== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get a campaign

+ + + +:::caution deprecated + +This endpoint has been deprecated and may be replaced or 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. + +## Request + +

Path Parameters

+ +A campaign object + +
Schema
    alerts object[]
    + +A list of errors and warnings that have accumulated. + +
  • Array [
    • localizations object[]
  • Array [
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-client-log-configuration.api.mdx b/docs/api/beta/get-client-log-configuration.api.mdx new file mode 100644 index 000000000..4df25ac67 --- /dev/null +++ b/docs/api/beta/get-client-log-configuration.api.mdx @@ -0,0 +1,99 @@ +--- +id: get-client-log-configuration +sidebar_label: Get managed cluster's log configuration +hide_title: true +hide_table_of_contents: true +api: eJztXFtv2zgW/iuE9qEXRHbsOM3ELws3lyKDtMk6CQpsWmBoibbZypJGlNJ6g/z3/c4hJUtW0rSdwcy08EtjS4fnfg4/0mRvvVzOjDe89l7LWM5UKA6iwuQqM977LS9UJsh0musk9obeK5WLhaMKLNUTI6JkJoIknupZkUmi7HhbXpIq++UkxMCZyg8ireL8NJkd1ElBmcpMLhQLHF7fejG+YIQO8UqT0FTmc29dk5NDkUyF09gpLPJEQFBbHzFNMnDI1O+FzhT0ybNCbXkmX0YkyuhFig9bnvqcRkmIR1MZGSII5mohveGtly9TpswzHc+YUvKYoSedcJh5d/eehJg0iY0yNKy/vU1/mqqfttRrW7KQeTCHKDHTNyoufS1ODiEbY3N4khjLNI10wEy6Hwxxv60p3RRr/S/GRZzrhRLQYkYC1qMRF1EkJ2SadZKzPJl8UEHecOK1F7phr3Vc5LAYb5MkP1U3KqLcSTNKglxbXwQsn7LhUYcgpyy1NfiLzndM77Za2rTkHJb+1rFYWCLKjHvyBYmUwYmaSdV0CtPFRIFW4blReU6eA1GoprKIcrNSUiM2M0XZBmpE0T7a6dfV7vW3tzwooBfFwhvu4rP8bD/3BoPtO85D7QLSMuKoeidCmSufg4kEyufqHkMoWsrkDaf1t/vbfq/v93Yve/vD3s5w50Vne2//v/d4urKhEkWOXgW5pd0Yr1iNiN6TiyhFl1usnvOWe0eel1FE1KYjjvFtQf7VsRVK2stJUjA7zlQeZrZg09TWOvF855WJzBqZd57IKX0pcNdHMT66JI8RQ8goqfH6JETq6Hz5Jvn0/uk8z1Mz7HaDZLEoYjztGKmjNEHwOnjWzXe7NXp/hLQOImW6pQi/EuE7Eb6O/dqQbi79tNv75Zfe9t6zDvcz9gb1sjfHZ40IXY5HB0f3JX5MSXLtnR0f49vx6HJ0ir9H4/HZGH/fjsZv8MdxOzx6efUKfy0vVCP0YOYXuYxDmYU2gggn/Gt91w7na5lSbq0COlmKj2rZEZdwPT4YITNVBSiIpEHj2xIQwMG5kRGyr0FjgwgGiTBKMZW8gac5ZkHpQ1Oy0Fmb+wPxP7Dvf5wEqOKNnl0T5bh0Roenh6PzimuVFnftnizDUFPEZHTeaLlfkWLNeJe5QV4afFjF/S/LxfLFqcvJi1QFmFdXLx5AEXd3RDS4b7p1895RliH6vhirvMhi4Bdte6brkGKShEuhDfICWavDzrdMtOvxSNeikCO8Bwws2kiiqeyxjpU/yzDzQEPFKgcYKMDxRoeUt9wkLcuy7TNdI6PIE52eeClD2GvtO3DGkC8zGXwELzsXf1mhq1hjvCiHCB1y435ArNpTcvJie78/mL4YSNn/ZdDb253sT+XOzvb+7v4+SV8oYwB1TE22zDK5bIl+pWKV6QBZGCAi/4NDMiWNRXNWOCHEXC3M4zFgHl/h/0ueRYm2MtPpK3L1OUdrEy8PzsVgT0QynhX8XM7WnBD7VxctJMWNlhifZXqm43tBpSupw6Pj0dXpJZ6Mj/5zdXSBT8SrhcZHBE9CSkuoilyYJ58cDGADPkmDHhvBHSrsiOeO63MYJGNTJ9T2m1kCYy7KWRojnPR7RtRZi2mWLBqlxHXzORdPdUd1tgCcTG4BrZhIgwEEsED+fBQEKs39U+fJ52KuZKiyZx0xqhpaOYcs5BKMBDodla5lMC1QylBG53PCCXGClqyasVi5soVrq05TCwoVBzR/PE9GQV5AOTazXoVVtjgVXXygs/VcU7vLmtPYpcs4lwGsAC5awo1ZxsATtuncCNeOKFwGjScu6aqOVe+T3O5eW2UO84TfBbIwX1F35xHaj8+mVS9ulCs+QxOv7UYcjTJMriO5WZkHO6oqXGXhi6lWUbip3U3tbmr3K2t3/eXYbTK4twx9em3ocxXLAv7NePJsQZ+MsyfGEs0R2UWXDeSWgEMcRPr17SUK+6OKiZ7XpurPxEd2Km8pP6riYZ9PeM1dBqsRC1KQ/eh2e9CJVDhkvVcas6Osq3ba0rD+nGgkaHwPRETXzMQyKXghkxVxTJpIrETCRJn4SS7mEv1RoiKMsR2QpMahbyH9BklukORmNtrMRj/NbLRBkpva3dTuj1m7X0SSlVZcLQ4nmWKxkNnSZpp7T9ZKAQJR/twlqpLjUK2jFWImKozlNZGDN+n3Jr3pXqAGoRyEL3b2p/3gRV/u7vX2epNBf8+rz/XXqzquiqxZU7V42ziyiwHiboDjihjJZfIkCZvbf3BvpqbU1vhXixI3w+dw6fsVdhy0seObJIdtYAzsmD2wvXg1PrUb15Y9+S0pskARzLauA7nMGVJSDsPTmn+32UDHDXTcTD+b6efnmH420HFTu5va/TFr95ug4+Ax6Dj4Bug4EASxpgSx/k7oGAJ3EDSbIiiwISjg3phgY0qHguD58qyZbT8yo8NoJdBroMj+fhtFXiYJnQJblmDJNHYi45W7qL2BdkG0WUkLAukOi6FraaBbyio6GwRMivwRkV5ormMyCHyzpT+a0pkyWzNlvlVSdBxEBTTkphAl9rzTJ6mrg1DgwPugMzTqP3GP00XrD+0HizFZfEoWi6PPgVJU89X+7+59pwROoHxG7eLCxvqB4wJ2z1zGWEaoz6ltXxUE3UD1DVTfTPeb6f7nmO43UH1Tu5va/TFr9xugukNDD0N1EHw1VAdtZ1tUWOqYT5/+1YidS8VpYA+cJwFj9XCFweEEo/BQ50sWcgWIf2BTeVTkc6pMHcbDTC2SXPn2MgK+SW5DrRf2Soz3nu5/LBQy1F15odZEl1eGXtfdmvHdTQ7TvdXhXTdKZr49sO+RQoQ8rdFFFmFUeSb5FrmAHLjryFR3tDtSHCef+GDyBAG4p7fRUVZbx0QgRucnbhnT4ehlmgrEdlNm3jwvXB1I/iJnuqpDSbLECkdYNlsCxeSSlR9DxRQrlSeGqTucnC37YNdVFt39cVssowdsuc99X5QGegFN10wkE96v8ueCYL2V3sqi1VRFPyj0W8LOiKwvXiqZ8ZF2OmPz9Ne3l8/EjMAsN5PCEI5WmlYfKMdzpAg3y1F53oQG8fyVJcVszoqPGid6qDjFNILB4l18oZS4rh1LF2O0fXYpDVLcaWjU6kR8SAexaYJdOxGPOujCQ13ZGPeMJ9P1qxydd7EvDjX1OE2ggGicibyIFNdpaZes2fW9Svyr5OZbbj5zM8/WtLCuvXZ3jQJ0CGIhI8Pe+m7hlp9f40dLNDwhrus6kCecHs1zWEEZte/Wo8HPJ35NPd7Fb+caM3VzmLAdTBhMtFEoTkQwTxKj/i0EpQ6VwfWsQBV9t1qfSKjPFeH3t2sq+Vakr33gTtbvFIUR22Syd4EY9iR2B4ZL8jeOLGr+N74y8lvDZn58jemZKMMkMN+tMwn0SaBve4Bx+tvZjxILtU021K66Haziz53AKVrre5bXvV2d2Xd5DE0NAVRlLiYd2i/DVYMr71XxC6KuaNCGCbZXJ9PovpXjRVNgw1nlhsO6B9v6YtbS8ZrfrL7Vz6Y0G//T7CWLR6t9mbM4Wv7ZXfqBTvLP6bt/U8fbdJqfsdM4IE3pxmLdiqOe5C8dXmvvExq+/Id/8ZZrlTE7VkS8xmMUU2eURjKnrOaqDuZa8Q5DqiRf9tuizEoWXIlpllD5Yx3JjGZA7bTNbYBJ5URHdLOP9sBLyZILxgJLiit9N4U7kZEgJbFiVR3xFou+OEBYaMFHZ4Hx7kPiVn4XiMw5BVYclsEG6HL3CKkui4WQSKlHMiLUJihs43LXAK0JCUO/alRZxZRqZEKHlz7ZwpxNafMa6+Ja4B+Rhbgbt3MN11MU3fX7lSFjFXFmEl0Ttj/GG9nmz1WU8iVTqIUFZE3C65PLFkcwi93PJUk267pBpku0YELLI5s+O51eZ9vn5QKep4nJscCqMf/K/6hgPS1vV3v43/J/Hbjpg3B/N6XdMFKqsOsQuwC89tYXgBg25P/joLYGxKpiDlOI/PaW9k9oUXRHj38vFC3Or9+v1ju8ToSr6XNY/ZcFD5rzdOwu7j8T3/N/J9xrYrktGC9XOwIePn5UtJEA67Dchkm808Pq2hd2L6g2pPVrSWMh/eqIEkU+MFW7D3ANmtH/AUNDUQE= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get managed cluster's log configuration

+ + + + + +Get managed cluster's log configuration. + +## Request + +

Path Parameters

+ +Log configuration of ManagedCluster matching given cluster ID + +
Schema
    = 5` and `<= 1440`"} schema={{"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}}>
    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). + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-common-access.api.mdx b/docs/api/beta/get-common-access.api.mdx new file mode 100644 index 000000000..89832ed42 --- /dev/null +++ b/docs/api/beta/get-common-access.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-common-access +sidebar_label: Get a paginated list of common access +hide_title: true +hide_table_of_contents: true +api: eJztW+lvGzcW/1eI6Ycmgka+7drAYqH4KFQksetjs4BjbKkZSmI7Iickx45q+H/f9x45oxkdjuMW3birL4nF4/Hd/D0OeR/pXBjupFa9NDqIhsId6vFYq26SCGujduT40EYH11Gv22O+i4W+m3aUCpsYmeN0mHw5kpYJleZaKseMcIVRlrmRYElhjIC2xBPgRIANtGEc+qzTY2E67BJG+lkiZdKJsWUJV6wv2EBmThho5SplVhsn0g47F58KaYRlvHAjbeTvJAazCYjE9IBJLg/8SvFYpyKTanhgBE9BqJwbPhZAEkW7jyRy/6kQZgJ9Cnrgpx4MrHDRrIyn1MxAQE2SDYosA6ZtkTkGHR12ZQueZRNmc5HIgQSe76QbsVYmx9K1GEzL+VAq7gTMN7oYjoiOJ2E7H9WFEOz6X1use9ZjFw4E5iYFzWeZSEi+s4r3m1cj53J7sLaWiluRoSU7lsuM9N8BXa/JVK3xXK7ZQCdOKjrxVAevyRJjbQTIBX+OSZEdkN14FYNnDHhmRTsSn/k4z0A/6+3IJiMx5tHBfeQmOaoMVhVDYWCeJ+KbtjahYSyVHBdjmpeKAQdZ4e+Hh/Zi5ZOy5nT/jn9mqhj3hUHzBo2hRr3TvBjdbe78Ae2N+Wf/N1GpdAm/lmoz0YWa12ZvwFrOFKIFoQY+Cm6c67zIvGMK1vp3fKkdz+JDnN1CdedaWcFGEEJgAfJqHLjAIiMOFHWRpRi704geVFGAYdzyEdZidwKVN1SgwxRsCFaUKsF5IIZ1ELWQJByywkgQygkjfiugGaxGysLxcpzzxLVRGkhDRmCugWQECyvt0EuswFVbROQfJHkLeSJub3lWCK8FHA1sF7bk5kX4FMqzwKn6WmeCq6jmKTRzqa/4TGvnvOWE2isTFxbtguYvRWF2ohwEqJ/WR3urv1hv33nmgbM48PkaDXhStqJf2CLPaf8gHVMGB1L6DrshW2epJef0u6I29gAptFqwsCtsq3XAWuJTm9m7lm834laKO5G+mVxZYcChoDt0+a2nI9P5WaELbRQ6mx1oC+qwd20221mzS31MVHOGqLYA9LGP0fnp2+OP0SIPsm5CU9DPiEaewWa51KGsQ01GS/2HNmfyn2VTa/kNQ5THVqAJwSTRw6zXXQC1b9znUOBZj7vwbU/zNzBh3e5tVvoaUnozYSFwPY5q4CcPkTikCQ+JWH/CPAluE0h2sEZnkVuQqR5u0Bl8Trdopc31dfxvxgAFTBGph1sez3GWSesw3z+K5mDhRMOWBjsPUOV5nsmE8tjarxZJ3887CDeGoyuRXLV23f8V9I6wzaCdnPQMy3SRczX5v1ISHJT1jpDfxRpsaGhnZ4f3t/d4vJ5ubcbbP2xsxfvru4OYp4Otnd29VOzybXRTP39eXwvJ/3ExDhtke0fIgp8xy0BzJCWAVxj8DKzTPTw8vrj4z9n56Unv7fHrKWfVqkIhsriOmiOhA0kg4HfSkZ7qRcIlEnkoM8DXieJdcWbM15Go9wETgMd5v9wRgbK+U8K8fwZrNLFikH71vtpUngga7GGx8nrgIqGeesBkjKH/hEVO35/0zt8dH6FZj47f947JJTJu3VWeUi5dQAOLn1OVTcrkXuVhnBE76SVtbmlLsESdGSSGQAoQkwFgBkWbVgNpxpCQgLtUKCyCgmSByfOwxjO5XGDmBKa5LzBdB0C1oC8B0UL7nIcUCQZ8wDHbi7LkYSaxuj02BgSOQ6b0iNfXdoRkWV+nE9wTpAK4KdPnpMglOSQVDvauQ9q4v+Q7J1KJeGi4RA4FsZzARAYUbyXuGR55epJl2qRxzc0ENNHZYG94SoU4yncYhEFVGp78BrSeEjEhR5dTmJzulQuWFXuC93fX9ze3B7vbnG/+sL2xt9PfH/CtrfX9nf19XH0MhuNDYRfsLc2lfxQQnjJhmU7AIr+DQsCNQPfEAC3+9O2IaDxB/3jK4cdWYgZ+mROfoYDh7M3hGdveYxlXw4La+cxGLlR8dbEoDDzhUyOHcmEiLRP80fFJ9+rtJWb245+vji/gL6Q1d6TTVeCtKbqlphJvpO+I4yDAHUS7FYiKECG0AtUWCMTDyU8YKP0vO7GgzBLSwIyw+oIZddJsYPS4EUoUN58deyU7otOGeg3aIEskI9bnFhOP8kUsBnHu4rdBk61Qvb7usG6aShQSykoq/izMn2Dhx9PUA0l/vAOhLKjY1YXD2lAmommLqSqb1pjmk7d1o2BwAOdf9pNu4gpgjsSsR2HlLYHFYB/g2Wuuyd1lTWmkUkTMAGITOqRKtIFCGTITyCadZSEdEXCFxKPKcVXGqqdJSnfvPDNHTlNfwgv7hLg7yyD9xCRa1XErQvDRkY7PRmSN0kwhI4WDN5ocRlXmKgPfQ+tV7K5idxW7T4zd2c4S+IRegj4b89DnSpWn7yDEHPQx5D1KzxzRe0O2ER4GiPTTh0sI7N+EwvHic45HFH8iPvJb+Rzz3coe4QShPGAot/6pLZBB0qOXYACZSKQHxPeUYw8SSVVb86udaNOX4KBqAUQk7DzRBVXzplCKjj1tm6VaWPW9CweeoarDDOg/tcT+vGKFJFdIcrUbrXajv81utEKSq9hdxe7LjN1HkWTFFUVLwEm2GI+5mXhPC/0oLWcwYPrluQo5MtUsWkFirMJYURM5RP3Njf7GYC8R2ynfTne39gebye4m39nb2Nvob2/uRfW9/noax1WQNWOqZm9vR1IxgLhbwHGFAueyTuu0efxX4LesAaY1TD0Vbgadg0pvSuy4s+iEsQcWMeilF36JJUeNHm9zBSwAJPVRUyGfFUJcIcTVLrPaZf4eu8wKIa5idxW7LzN2vwIhBjS0HCHCgCcjRBjbWWcVljqh78F/NVCkUAkc+Js9OqH70ekUBRKuAFcKV7Ixh3A3gh9r/oJJzMvr2R5yelYKk8GQ8l7TPVgILPPQ4bnsQOICI7mJ0nd0uakPalmQcfDjtI8uHEDXqPwCHdKpkei2PscRca/h8F09qu5PPUoZb1Sg6Sa6gKxGZNp4USW4EDUDizlXk+/9BZEOucycfCDXlcke/rgsntASWRap79HVYDwDTmdERBFu0FxgaiBE9sKrCoc+QXULNO/1TX3MBQJyz+HcyOkmg2XE5hxDpzhsk70R3EC14E/WX/304fI1GyIMpTTg79MJiXUDBNIZuBGluW55yoyTaOeZXlPvNs7xMazYIAOlsHBPthcU9R7y/zkkbFI7ThKUI3DW02/e8ca8JbdiP6qYHUnjL+b5W2hBRH9z+Dov5eI1uZ7LxHcltRCBMVHDW38NLrxqrxN/LySB2EYSPLOkrWcv7unFNXpYXEELUp3lATUR+Gh+fUlKqz2bjwa9GOk1+fioPowk7LHNacynNGZHdDW8x5KR1lb8kzF0HQyV62EBkfZstu5w0ZgiIt5cr7EU+yVjGQNiJP7eQmAo70y8jzs2ARYNWE6lPmx/IctCXviFLgT/0pCZmq9hY8WRqU6+4jrpDM+4YIwLxj5P2MC/37fQsSC2UQbKA94BDqf2p0wQGK3lRk9rYeYn8ms0B7cPfCxDVGx+4H8cTJNgefWUOnB0NQZSdVTeJ6XDjCxjgRZuXg1llUcFsxqc5zfTsGfO6M3zWx2W4D76rcmLEnenJyp4ee3PztJLMsm3k3f/RxlvlWn+jpkmQGB0N1o21Ap1J38TMN38CZ+l90vwL/RSrBLahlpm+mSpTijPuEOvpqhORlLQ2UAuuEN82EbP0mOKRCjjMfyhAiRCQ7pxaoBlDtWczIAePWEsV+YUMB58ol3pnn5BBQqulYyg1hQd9gHKNZWAWbBUwxsA0PerDjXbBVjmjF5THpXGpkeYhYLVMC6LMePgUl/wiFTapPCJCyo3JUpdaIJ+1awyitHVUIQOFS1mbE8HeOwMFW3N8F9YC+xuw5kzqB6tGB6ITAU5Fxl5Jo5rQvsv0QZvi0ciy+k6MbCF93OnK7zrXc5RBGLKglxQlGszXAuT7BqOBSJYQnn32epsdNZjKimgPdfWQXlbI/6jcPjuLDzhTBe/hZh1yvvp2fsLeiQb9i4sOtZyPERDjRS+UPLl6HXULEeheBmBxrDj/h4PWLA+e8Bm/0oIix6wIQbW9AHSUk39fz21Xajt3wQeeVRPkcOpRhRhNfx0Rb6sd7OPKKJ8FvxMPaxevL68F6+PeEP5rPmZ3rB60frtv2h9xPrTh8rPtP/qbemf8Lb0EQNNXwJPDXQzPXml007AC5RbCRn4af5LTG3W3F0FpFKdjv94DADu4b8gXjJo +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-completed-work-items.api.mdx b/docs/api/beta/get-completed-work-items.api.mdx new file mode 100644 index 000000000..287a8379c --- /dev/null +++ b/docs/api/beta/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: eJztHGtz2zbyr2B4H5J4TFmSpfgxc3OnyLKrnCP7bDlp63qmEAlJSCiCJcgkOo//++0uwJcl27LauTQ95YMjgsC+d7G7BHnrqEjEPJEq7PvOoTMRSVfNokAkwv+g4k/9RMy0s+0kfKKdw2sHx5gZvNl2fKG9WEa4GtYOp1IzAKAZZ54KAuHhDabGcGVBsi+4XuJ6NhKBCicynLBEMSGTqYgZ/GE6Ep4cS5icahG/5P5MhiwWv6UyFv6rbabMNC+NYxEmNKkGFEY85jPAESOdt45Ein5LRTyHeyHcgUv1JRQxsLntaG8qZtw5vHWSeYS3dBIDJc7dIk+CSR95QJwEILvIWWGB1Amwg6wgnUIDpzXGeoYnHjLiIaccoMDUnTIDbJYCiBn/JGAGSNGCQb4yzp3DMQ+0uNtezlsgZzJx7pP/jn9lYTobGapjodMA1APyjkWSxmHtl/BSCHb9fpd1zvvsMuGhz2OfdQvtnedivXk5TZJIH+7s+OIz6A7spqa5DCIlw6QGKt6RfrjDI7mjLRy3sAK3UM8rNgZBzFQMkg3h54ysbwmr2474ytFwnMNmu75EaYBXTEQMKw0YM7TbhAGQt5ylM+cQ1s34V/OboPhizEEKdHX3kDTVeKzFojjPaBjIBgmiJsdpEFipMrhRY1c65UEwL9nwFzACtkXa2ULBRxxMnieo51ilkynBsYr5btTxO5SRi/9h4XsqDRdl3x+zrSROxRb4HEgVBB+pKA2MKAXb+tEdqoQHbhdXb6FIIxVqwaaC+2D+pAecuMQdphwgqjTwwYmtZ4Dm5DjXG8iPbRmb2GJfBIpqEoLEfNAY6EyGnshcFoMAB0UDKYwYYR4EgCn/LGAYdETCwflyFnEv2UZuyOFBYzMR+oA4VAlaihaIdYuA/J0430KaiNrPPEiFkQLOBrIhilhqvgsLQn6WGNFIqUDw0CnZiYl6dzcIzahU44JmvY7/VW3kFAPxA/sN0uMpMFKwLVjIoyiQHlG681Hj6ttFcngcczRMAlAaV6OPIAXcdGKUWiINTdJf3FEWzPhoYf9wSnJxmt5BY7++v9v2m6LdeL1fb7T93eZ4/6Du8UZ7v4FbVLbJ4F72DIT5svURHkkdBXw+IEd9CjPunb5ZgJ79OBlv1TRkl+BtU0SY7dQr4Sg4pGXP5o5Wrc5SmZdFhG85GFPBiBcLiFBLGcnDpA8z3EQC/grl9caeW99zG41hY/+w1T7c3avVD/Z/Rqgz5dPush7Yfbf+2m22h836YbN52NyvNeqtnxdSn5W0W4w8btVdEgPjngmJMF2rNIYo+KJz9AJRQ4RJlspfhLhxXDvH/UH/8ofeEQxd9N72ukP7c3h1MaCfvR/P+xf067w3OOoPTuBXtzPo9k5xMISd+qZMUQneIl9EDXLEK/wkMqG1WWJ8SUQD9Yboh4m/GvxrcPZhACMnvUHvot9F2noXw/5xv9sZ9s8GxMq73lE/uzoCsk+yi875+cXZ+84p/HzfPzul4Yve+37vA4wcn128Q6bPTvvdn/LbiOCHzulpb3DSg9/9d+ed7rAz6Jz+dNm/hIHL/sng7PgY5fa+NxjC/+86g6vOKcwyq4e9y6FTkVhB+qLAkPFlFnBfYkMUEAWUmfClKTv+uNhaDQYeLh7bGP/soJDwGEqZ54egClZmoKyJfL2Q9CQBHyHS1nQWoMyEdeP68zDD5iqDju/DRq4Rd2kPXo/X8iZuAkoFXwcyFci7jiAF8RIFKSbiTAD0KE3Emhiz5bbeszwLv4I4mqpQDCjRrOA8y2rt1RDnpflyCaOQyyRVSEgj3wan/P57TBpXw2zyy2fx3G403Xa77TaajSaihSIHhN/3Id+SyXxVSZPCpF2UEbDMiHGbNVYM2O6KSHNRjSxHIgGby6wtVsDYHxxwMrAU8l5oCAXPdne7La6Iz+6hsRhDIQKVBFQt88wbCkoecfmS1/xPXC5c2dNySwM50qrHood6njOVYRdLl7vM59U9pQzWLCuD5P8cYSH1vWc4Jf/qlLyo5Fyr67homy1ouGNN22SLlD5nhdy6mW6j7jYOho3dw9YBJtC7+23KdEHk98NA0b9Y4gB5z8C0LmX4cK7bOAD4Io5VXIb+UCVZ9B1zANf3xAS5helQcF3uK8EVlv5jkJhfc27KOioat3f4b9tpLSuWu4HE9mMPSWUuuyj1PUplGhspf44dChmC1qW/Thn9QIT1yXy6yl/Bco5lKNxJzCVSSNKFIt8XDI1R+rgrUf/BgMxiFc2rVYwCJFFrsDfcB34Nf13LDMov5t4ngLVK1ncVSljPsiXYJB7b/u4StGJP8NHr+kGzNX7d4ry532rstUcHY767Wz9oHxxQUQdxjU/EMqupoj4RUHRKjwXKA438BwQC/oJVJxJAyFdvWRCMFT3XzM3ZtPSyRHxNtiGOvOmes9YeC3g4SWmcT+4JIXSvsPbASMVHWRcIODeAz2I5kUuDeRYhj3rHnavTIUXFf19hgZJFvSqxnRCs1UezVOS0U/WFKLYMkCMJ7GNhm37LQt0ChnioyxOludJzjX5oO1KwwmJfsqIMmo1jNau4EvnN14S9lDVR24Zsinr+iTdlI65hgU3otiAOiihxT60kt2wP81WNwfYnkUnY5Gmz0bB+ju0/7mPn0MalcQquLKjlqdIEw4T0RFUXhSir2iiCyGlZKegcQPnTdgL7fwrEEZtlL8ytxZJo9QM0G8lVqRuWhEYinYcJh8zCo+a6p2LMLhjsuhAhNbPhCNWlIfCE2bw8YpVjI4W7d4aYo0TRPY+negW/Ow8g/LjEWn7js7DOR09VTDQibWRqshHJPjCgxXZWrq7M8RkE9sDf+O7Gdze+u6Lv3r95YR8R2LuU+uwupj7HKh5JkHq4JO+hx7FzlTIOaojTMKQnOnqb+Uro8EVin+WAmrU2bg20i9B3zWOTTXq0SY82IXYTYv8yIXaTHm18d+O736fvPpoe5VSRt9g8SaezGY/nxtLsfdMmhAnFoZrc5fJOaTlbQWAsz7GcaubgjJqNUWO854mWz1v+692DcdN73eTtvcZeY9Rq7jnlvf668OPcyao+VdK30aPpb4r4M+RxaQjGpROl/GpPK6X+OYY1DD08BWuKIVUAmYNIb+7ytllrMXccqAR4A8CQO8YP9MyuLk5Nf96AR7mZx93otCQ609LDlJK6eOKr1MkmddykjpvtZ7P9/GW2n03quPHdje9+n777rNSx9VTq2HpG6thig+y55rdMHX1pTmKPQSn4Qot9WyMWEbACv8wZnMztzRGVPNErskhKP8Di7Ms1GGp4MoWLHXzC61JA2ikec287Br2hP40DmJmd0r4FfYIe72o8krXsjEyovtBR7REIcUl8wge3xhdxAh0KNwhqpIFYopGbiEjAjT7s0WsnPw3+KOTseMgcWGcGzDaeCLQGR8PIIQ/n9lxHjQxsgT/g6yoO7n4/LwbQA7wsE9+j2GA+A0rvsYgs3KC6wDLogBPo6wro6Zpw1klRy9c35TmXmL4bChdmFlsSViPNBYLOcFqTvRE8xvek1CcRspdvPwxfsQkmrRQ0Uo35sn2VirNzMCMKip2sWY2LyGCLV086tvYx5oxOyMYBCIXZNwmyA1wD2C0uILyT2HGRoIiCq1Z/j4BX1j3w3sAvoWvPD0nc/HGOZdG8W3EdZXzxEl/rEvG3DJproLkETb+6R4UR7bVnzkx4sSCx8ECTtNZGbuC5JXhYisEIQr1PA0rC0sErWvMyra1NRwWei/CqdPwSfphK2JGry5iJbExP6eWZPvOmSmnxD8bQdNBVricpeNraZH1BpC55hNusl0hyDUpXupBfEn2n4BihMSY+wv2d0htlwje57a+kWYgLv9L7PL9WeKbha9iGcaavvGe8HHOPZkToIkLXxAlt6Te7HBoWHl0CHigOGAPoFvqnSGAJLcVGA2tp5CfwO7QGtw8PSCUoOjo0F4dFELS/GN3A2fkcCNWYnuePteCaWVi4h1WElTUW7ktwkd5AwUZ7T26G3rzngpvvn41f5LhT9F/OwmD+R0fpByLJnyfufqOIt4k0f8VIYzNhNDdCayuLspG/sTndYj9Q0xue8Bfukq/iUU0oC5Lipc4yoCjgCVo1ebU3lYI6CZHgCeaH22hZakaeCEU/uj/UiwRoQsdOYyCZQ+0nA4BXY8MCMyeHMckn6hWvdWrbuQpMEipTUWMfoLgLPVALFnZ4kADufVS2wrsEzZyjYtlRpmxIumazNMTz7kB2OmMcTOoJi/Cl9lITuKDOC0UmC0WpX74q82I0NWShRpVOPNNn40vInKH+LSn+CVygd2071CB61KJ9Xbdg5EIEZJk4r5raPwUbrM2diiDC0hKiLiRgooThXX+4ABGAhbbWUvFkxy7SOzgXT3AD88Z8dmuNWt2lkgLGI6UTKIZLwPPPHbDStw0W3oXLG/Pf+CsHdvvBumEnwq4ZMpWaWscUltdOUVg65RPUUIhMgXuccXuLrRWste5w2Lx/jQUM6AOdpHhh9xExfOsPIywVxSeBDYjiQw+2yeA4WG6uzt339d2ERySRfRZiTTn8f33w4DGLyj4IsaYgN18v+P6+XvCIOWSfqCis4aZoQVHbB4ItqY7CqllkGtilVQuPeBFK3i086cFOdvdfW/Dh6Q== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
\ No newline at end of file diff --git a/docs/api/beta/get-connector-list.api.mdx b/docs/api/beta/get-connector-list.api.mdx new file mode 100644 index 000000000..72e66f9db --- /dev/null +++ b/docs/api/beta/get-connector-list.api.mdx @@ -0,0 +1,96 @@ +--- +id: get-connector-list +sidebar_label: Gets connector list +hide_title: true +hide_table_of_contents: true +api: eJztXG1T27gW/isa74duMzhAoOXCzJ07aaC97FDg5mW7d4DZVWwlUWtLrmUDWYb/fs85kh3njVK2s7v0+gsksnR03s8jRfKdl/Gx8Q4uvI5WSgSZTo13teHpRKQ8k1odh96BNxZZ+fhEmszb8EJhglQm2AU6vBVZMBGGRfCQ6RELSmIsm/CMTfi1YC+6RydH7d7R4QtmMp7lhuVGqjEbySgTKX7iKmQJH0tFUzcvVZtl+pNQ7EZmE3bWffdr+/D98SnjeTbRqcymTBqWis+5TEUIXVnAowhmhNb2+XET2Ex4ymMB5FHGO08is59zkU7hmYIn8NVOb6DBgAwx9w7uvGya4COTIVve/ZK4NARmNnmUFWJkE4FyqZCnITNTlfFbZocNgTmp2MXPO8gW6xWdOjqKQEtAk52XfF79OMmyxBxsbobiWkRoiKbhMkq0VFkz0PGmDNUmT+RmMZkflHT8mbw/lGr1HZ8vL9WlelsqG5Rk8iTRaQbsjXRKAoyAlL6xVhFRaMgk1hnAmAdIodFAxTUaB6xhbhq2BfVFLeKzawnBJEHhNfOPAp6JsU6n860jAS4BnFJrwBtgD3HL4yRCQ8xRY+Izu/SyNBeXHthmtVUjGctlP30PNlF5PATjgZcW9gPHSQVMjh7XE+JPNtRLUn6sUwFOAh9j6/zAe+HZ3sGIR0ZUFNJ6tbXCXWFeMRYpjLRkbNNOCxpiqWScx94BjIv5rf1MVEIx4qAF+na/Tpt6NDJiWZ1n1AxsgwbJe3IIP6tVBg+abGByiMgpM4kIJHhUaCO5QdZpoOJduAsYn+p8PCE6zjDPxhx/wBil+tcrP9C5Wtb98Yg1MAYaTGagVVB8opM8sqoUrPGL39cZj/wOjm6gShOtjGATwUNwf7IDdlwRDpixb3QehWwoXGRgBhuVdsOk0LA+0WA3AlU1VqCxsImx3JMqEJSWhckorYOhgRVGgkCOVrYecAY2IuVgfxknPMg2UBpK6mCxWKgQJlY6Q08xAmdtEJF/kuQN5Im4veZRLqwWsDewnZuCm2fhQSjPCicaah0JrryKn9DItb4SaSiB4oFaBnMqdL0LoIjDNDqoxAHXyGCONROd7RM++H3i9z/QEPhD6XSU2ubOKfyfYG+BlTPAPx85Do6QWfykIgQSlRwulgtpHxzQsowW5kkCucLlEoAQIzluMvBzpdm15MOo7AsOMpbXQm2Uvu/Ug4MvgV0sDFeob+v0BvXQ2trCf/MMtFkJbNghDNbDj/AFJdIQvxB2MALZkgEZcfOjwWF3y+rlacqnpCURm0p7STBJ0aEyaZmx5lo2zrJ6SijFaExVo9QAOrVEvo4Y9a0S64n0WgbiVN8gSTvw9Alc2ifLzBpLX1n6RbVfocEVHuJQZTGogluG08JZ7PTod1CE0FmKoFq0yAzUlcxdeOfds5+Pe8dnp8en74BG77+nnV8X247a3c6/4cPgtNfvDjr9Qffo8Nd+u/vuqN/zrtC3qyhlTRRXZUP+bAoD5KjzNCDP5szSKYRyj7ylbLGQEshnrRbei4yHPOOr/HChglMzTpVxqEqQrGM3lpG3KoiBIiIHx/jJ5dYqOxAOhUEGx0D06Jf+Tz3KBTzD/Ic1LEC/MYDas0NggKpa4TFVju7R92hx8NV+Z0dVXa5YbxDVTGbU+PNOGfEQ8PDoHp/urkoOnUii+EdpCvR91q1UQotSqMKxoQ5pISIVlCEZNp+QPdZkiRBsIaOODh8RhW/BVv44BSsCh4JYDmAgA4rXMiTLYkWyJDGaUATq15xTGmiiuc3e8BDktfJ1nDCoxJQHn4AWrgq/xNBASRjPiiFMzlYZK6YVe4IPX2/tt3ZHr3c5b/1jd3vv1XB/xHd2tvZf7e/j7LEwho8fkTTeCQVrnMCWC/k7KCQVHHRPDNDkj8/UrqI+yhtdeSrEdPyyTNwCsOHsTeec7e6xiKtxTu18vKAE5Q96SykMJLeEz1I5luqhmn549LY9OOlDS/foP4OjHnxCWleLzLYVeGuIbqkJ+k30DXHsBLjhkGMFIhsAUazhqDZAIK5MtaO038zUgDKLIgwj3OwrRlRJs1Gq47lQori5zdiPsimaG5BroA3gUzBhQw5Jh4EJCdy2g0AkmX/iNNlwqPZlk7XDUKKQADcJFBoYP8WkxcPQLsPtQgULCYFgnWeIGaE0zdtipsrFglJkkpOqUTA4gPMv+0k7yGBNRD4xF4WltzgWnX2AZ6u5ee76FaWRSnG/AYBoQMutQKdUQYYgmwRE79IRLfkh8aiiX5mxqgmS0t17y4zNkJDPeG4eEXfnEaQfn0QrH1wLF3y0zrbZiKxRmMllJFdkaLDrVZqrCHy7KVHHbh27dew+MnYXH3bdkqjAPgh9tpehz0C5PVYsnkvQJyXvgWVZ0YngjTPkBgOFOIj004e+28GF/uI2wcXvN8RHtpSvWNQV9nD7r8X2bFH6Z7ZABkmPVoIRZCIRHhDfM44tSCRV7SzP9lanQwkOqlZARMiaKZvqnHFQWZorQtjcbLBQC6NeuI1xDhFhjM2AOKsKfbvnUCPJGknW1aiuRt9NNaqRZB27dew+z9h9EEmWXFG0OJxk8jjm6dR6mnuO0nIGHWa/SJUhR6ZaRCtIjJUYy5tHDt6wtT3cHu0FYjfku+Hrnf1RK3jd4q/2tve2h7utPa9a6y9mcVwG2XxMVext7Ugqxq1rwHG5Aucymdbh/PYfqDcVI0xr9CNGgZtB56DSqxl23F3Gjqc6A9mAMGDHdM324qB7gvRFasmj3uxeMQat3b6l38AQUtKvX+LWHtGooWMNHevyU5ef76P81NCxjt06dp9n7H4VdNz9EnTc/QrouMsQYo0QYv2V0DGU9hjTCIwCMgQ5qFchbExAFPjkdh9d2Gc8HYusBHpzKLK1v4wi+1qz91xNC7Bk5nYi1UxdmN6gb4x906IvdOD2OA3+5C8B3aJXyVggJsXjZHToC+MYBQK66dRvj/D8qztK5vytnEWqIMqBQ0oKkca9Vw0+JvFc1gjhH1CgfdAxJOpvuMfprPWH9oNZFyU+QYnZ0W0gBMZ8uf/7atUpgWNgPsV00bO2XnNcwO6ZcwXLCHGb2PRVQtAaqtdQvS73dbn/Psp9DdXr2K1j93nG7ldAdYeG1kN16PBoqA59m1usxFJv6WTrn43YKVQcB/Y8uQ4Iq4czDI4HVAU0ymxKkwwA4nesK7fzbIKRKUN1UB5M9S2I9+159gPIbaF3hYfTYwEO6W7XYSbiONjbnF2d8zY8u3yw0uRpBM+LKwp3YGQw7n2TJ7IJuQ/snE2VvqF7CkPQ7IqkhWdUbYBiB7oRYSdokllSOmNv0yQRt0Zyh4y98irEg5Tx3DdafwpSM0tmAw+bOy+kZmAxgSXIC0O9m+R1S/KBXIM0uv/jslhCa2RZpb4HZ4P+DDhdEBFFuJo5Rg/xup19yT1mNQh/KWgtTXaG3VrsjeApLCbs4Zkff/rQf8nGiFIpS9gLh0LisgLi7BxchLJguzhIgoOoMM3uVLXnjupg1LFRBAIzd0Xm2CnhFMpDF/I5qRQHCUohOOrxF2T43Lg1F2Iulc8O6ai7xGqPfZyI9tLQRVLIxStyPZWJHwpqvqXmEzW8FDnHhVXtRWCPfgcQ+kiCR4a09eTJLT2/Qg/XXtCCVBd5QE04PuYPWAWF1Z7Mxxw9H+nN83GpPkwklOD5YczmKmYmdCvsmAUTrY34F2PoOhgGF+McoujJbN3gpD5FhN/aqrDk2yl96QOgJP5OIDCUdSY+xIJOeEbbrRUKyd/IshDzv9FFtd/mZKbmC6i72DPUwVfc+lrgGSf0cULf5gDj+LdlDR0LYhtloDxgHaAzsz9lAsdoJe9ZWiuzOpHfpDFYGgJglaiY5MB+OZgluOI+FD3A3mUfSMOIx8sjZ3hj2tHC2janrGInYVGDy/xGGkrqgt4sv+XvoVhm/27yosTt2YbLmYqm3zpLr8kkf5+8+xdlvDrTfI+ZxiFkdDea1i0lqk7+xuG15Q1AQ1eX4S88pVglMA5Lndlt5Sqh4noZRXUwkYK2DhLBM8R+G+hZOqZIhFU+hj8sEInQGEA47l8bwKR8KCOgR5vbxcycAsYCS7Qrfje5O2qhwSVhKSqa7AOs5lQAZsGVHB7yhWcftVvS9cAy52hYdlgYG0BXHOcKX1sBbOcxwxdjfMEjQmmC3Cau4jogiaAJ+pWjiihGV0MRmrSmSWNzNnL3OiuG/8JcYHfjtqS5vcbo7hbPBOmKiDwT+83D9i/RBm/zJyJKcC0Z4XVQIyozvD/uL1EEYsr9DqLT8aYbZDaxLxDB5ZF1n53mdnPLp+UCtCfaZLD6rRB/J+zq2N0XjFa8x+RuthH/932liStMuKLYTHADDcXN7QrHLiIvvGDuZS4T0AW23t3hzgququ6x2V4dx6UlWAdDZnYvfb1W6jef/BlvPllp408CN1lmr6txGyn2HSiPN+HzegfKA5ooXvHyRD38f7285AE9li93eaIi6zeRPL83kTzgDsXrZp7oDZXfRr71Kz0ezgbFm09mfF/NdgKhzOEbGqzLUc2zo+yPC5VRSz+/z23VvjtCgMLXLBHdB5zq/v5/uvQO9A== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-connector-rule-list.api.mdx b/docs/api/beta/get-connector-rule-list.api.mdx new file mode 100644 index 000000000..bfa3ac1ee --- /dev/null +++ b/docs/api/beta/get-connector-rule-list.api.mdx @@ -0,0 +1,92 @@ +--- +id: get-connector-rule-list +sidebar_label: List Connector Rules +hide_title: true +hide_table_of_contents: true +api: eJztW21T2zoW/iua7Ie+XGySQEthP+yk0PbSgcISmM4sZbaKrSRqbcmVbGguk/++5xzJjp0XoL2du72dfIFEPjo673qOIt+2cj6yrb3L1r5WSkS5NuysSAQ75oqPRCpU3rraaOlMGJ5LrQ7j1l5rJPKKGomPpM1bG61Y2MjIDMmA6EzkhVGW5WPBEiBgesiiag0D02z4QfVYrj8LxW5kPmYnZ2/+2zs4PnzHeJGPtZH5hEnLjPhSSCNiIGURTxJgCaO908MQFjXCZlpZATrctrrtNv5rCtJbtTzMhpEcVYRJPMsSGZGSm58szrxt2WgsUo6f8kkmgBc3hk9gnsxFaheXaljlzEsG5CD0yRCMfCf9vhE8h1lfCkHm9EvqwScgIU2dGdBZiqeiJNloWV2YSOzrWKCvMoPeyqUzCVHOFLC5kWq04Cx0ElKilfAz2geIxFeeZgnOey8GfWGuZSReiqE24qQMiDNHmUp1JNQoH7f2OvCNf62+dV9M51a7TxjOat/rEj2yLCtMpm1TtnMMB3zOYi0w4Hjempb2W1xMqCJFG74sZBIf8wyGKj/0hrkwzhELwwciEUuGj3Ush5P6sLPQIhc3vsjGjVd83h683K/Jhl8ra58afS0tfHCq4LNqCL6fCg0m6eth/vvZcb/GpPlgFbsmVZ3xWW//9akwqbQ4sF/YXKfyD+IBT/u909pafZ79blz5MD46aGjVqvSwvli/iCJh7WuOxrGrps0iktwwH5B3B+zVsgTAQMFwWwj+SjmIKitHikNlE4vZfz4L02GhIoreijxkB0Q8ELYez1JlRc64GRVYai3jKma6yHHwsRzC18mTe0oBcVjMezd8R+Wa56mKJOED1Dc3hfgxZaTUq2HNoTQ2f4f8vrUwIMslpWHpKviAVmoIJGOgg23lrvowb4hFGcA0I8PTFOIpqqJmpSR9x3g6XVLCwW0gDpH1yrlI6EJg7aaf2k3Txs67UA76s2d3Z/C1ML7yuemLyVxSPMj0nrhUNnICzBTthG0qZG6te1meL+NhCNyxD61jE8Jf9hurwuWfZMLSXDUjwCjPYY1BkYsHVaB5VJDyDJVyciIYdDNtXbLbaX31O/DVdON+ARplNka4SCziJdU2fphvDg9WIqwXnc5WvP0iag92O9vDzs5gO3re3unG23E02I2HZL9y/fshlGKH/RP24nm7wy7O91kuU1AalmI3Y0DbeYWYbrhlJde6NO1uJ2jvBN3ueefZ3rPdve7Wf1CAFEGKXC7BPe77FokSDgWhWuteuabTqxU+rzD4dEqBsb2sQdhPJCQ0e2UMdAYBc40LtBvSe8pFDBvomNoRqa55IuPwO9qHKtKa0ROLnMukrCJ3e/a1VCKAsiZRQkEiY3ZisbuWMSZGCmiHOZZlsBFd2DAkWCLssJc8Zj4j2L5XBvPH8Ogz8Dp8QKhdKAnzWTkFajcDvLVqWbEj+OB5e7e7PXy+zXn3xXZn59lgd8i3ttq7z3Z3KcgA/AF4tEvQS3PpN0IJA7U90dAWyj/AIBDJYHsSgBa/C/A0fUA8HmB/LIeOtlLTy8ty8TXfYJwBJmfbOxDEalTQOB/NGUEFF/2FjAHNHeMTI0dyabEvW5eDV697F0fnCMxf/fviVR8+Ia8FVNtTEK0xhiWICrEw1jeuH3cKYKpZaEciyP6QPfVcn4JCvGzcHaF03+zEgjEhtoa8SHKY4VdfMqPOmg2NThupRHnzFSFuKMINNsAx2KajMRtwCxO0IvKnPWgEsjw48pZ8ysaCx8I8CVkvjiUqyRMG2QhMYf4EGDEex5i6jsGwQOhNhwuAqJjSgARE0xczU87Xr7KgHNWdgskBkt8fJ70oL0A4UrOehVW0eBG9f0BmZ7mmdOc1o5FJJyqHtkjiMcgEzGgMWJjBjsokNA++HKG7LBQeVdJVFau+N1K5O3bCHOSankW8sA/Iu9MEyk9AqlUProVPPos7s6tG5I3STb4iwUPqtXCyp6rcVSY+gAmRxOvcXefuOncfmLvzD0vg458S9OksQp8L5U9acfNcgD6Gokfp8jjWHfh4R24wMIiHSG/fn/tzXKAXXzMEzT8QH7mtfMnBbukPNz6gtqB0VsMXKCDZ0WkwhEok4j2SeyaxA4lkqq3F1V5rM5AQoGoJRISqadhEF9BZIrJXeETFuN2gA0n1KGdjDvWR07GWq4C4qoqDTEuVr5HkGkmud6P1bvTr7EZrJLnO3XXu/j1z904kWUlF2eJxki3SlJuJizT/HLXlDAhY+QM9q1KOXDWPVpAZqzBWq4kcWoNuZ9AZ7kRiO+bb8fOt3WE3et7lz3Y6O53BdnenVd/rL2d5XCVZM6dq/nZ+JBMDiLsGHFcoCC6bax03j//AvEYMsaxh6alwM9gcTHpVYcfu7pJfBrXGCxWTEiHZBoZUMxthTQPaFGlNSQsEnI2gLioGpUqCXBhKMhXAxUDQsESmkpIXtQC+ZhLQb6I+Ucogq1aRKkoKkJAqQaLdYfoNl6Ak/VYKEGxCCHYE1fkHolPvoj+F5NkZanyEGrNXXyMhMNEr5P5s2fnuIQhvsEb0nYNXHPS6bocrCABoCFzNqnDnGp+v8fl6j1/v8b/GHr/G5+vcXefu3zN3vwGfezS0Gp8DwYPxOdCGbVZhqdcYXH85TKdU8RJQeDMdRYWh4+YSg+PdFgGDeH8IF7kAXL/vQrlX4JVUvMyh9vCyQZBWt5yD6nLwHlQ3Kkl3ErnB1hVePUgFRK6/GI0li+Mqrc2KOCivG7sOw+lemASIxnme2b3NzVsICQiFacgzGZbXn5S+CSOdbg7AD0tKHN5FcOmMBHgh2rcwITnRSMwTV1SJuXMpmQ0zAlxLx893ci5vZU10AWWU2GzgXSofszQMImbQsDyyRB1SjC7oB3pdmGT653VxjFbossx8d64G9AwknVPRXykpw6iP6N6tvhBMsx0LO8LuwmInSNZlLwU30Hq4H0kev31//oSNENNSTSkswmkhsQmBrDyFEKGa2St/MMBJtI0ZXYzGJHiv8ZMM5igbJqAw+6D6QrDLQ2+Ed7CZnEH1J5PiJEEFB2ddPS69E4trkeA+G84siYEHKbAJFtrkjXlPaE+l5kMq+JjSaPhBBexAYqmTiA2QxqtIvSS7zEq9eE2v7xXiHyW3wHELiJt9MieFM+1l5K74RFAokAVPLFnruxd3/IIaP+zUYAS5zsuAlvByNH9Ii0qvfbccDX4B8mvK8UG9H0vYsJvTmCtYzMJ+m8TskEVjra34F2MYOpgGl6MCsui7xbrBRQPKiKDbrokUuCUDGQD8JPmOIDGUCyY+wO2f0I8GYKhil5IfybOQ8x/pdvTHhs40fAm7NFLGOrLfLTMuGOCCgasB1svvNkEMLMht1IHqgAuA/Zn/qRJ4QWt1z/FaWtWJ/SbNwa0hAlGJi8323Je9WYHznxg9QOqKBsowovfqp0V8P8bzwp2wYazy3GHegovyJho24Dm7OXmrcy/clH82fVHj3ux45kQlkx9dpVdUkp+n7v6fKt660vyKlcbjaQw3WtY3HvUgf+nx2uJxIZ5njwX8haeUqwTdoTFyb/vRfegaoyzhOUY1ZXU0loIOGjLBc8R+GxhZOqVMzIzG9Id2khiN6P6yAZE5tIYyAX50FF6uzClhHLBEv+J3W1C3Q68UjqFxFSF7D72fisAt2PfhZQ549kn7BrAPnjlFx7KD0tkAutK0UPiSIohdpIxDSN0TEbG0UeEKl+8OnAqaoF81q8xiDDVUIaQOyKT2ZOhfaqo5/p61wO/lm45g+tlLIq2ZImciochEuiZsv483RFswFgm9GQVVV+BV69kKx4fnCxyBmXJvTYTajDb9JLuJtMCketOhtRV2wnZA7QKMZ9rm0HLVmONLp6z50qqdj8Hb2bn9X/U+qt9nsEHYzPD0DKUvXMPiGsPL1nxjCK3GGPTDR7e3eLaCndIUh78UAhv3y6tZE4TfgKU7Y6FO8rOg3p5OYWbt++LvFI1W9c0r9A1fsTv6D7jUdPo/RgUU9Q== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +
+ +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[]required
  • Array [
  • ]
    • output objectnullable
    sourceCode objectrequired
    + +SourceCode + +
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-connector-rule.api.mdx b/docs/api/beta/get-connector-rule.api.mdx new file mode 100644 index 000000000..0d62ea60a --- /dev/null +++ b/docs/api/beta/get-connector-rule.api.mdx @@ -0,0 +1,104 @@ +--- +id: get-connector-rule +sidebar_label: Connector-Rule by ID +hide_title: true +hide_table_of_contents: true +api: eJztXOtz2zYS/1cwvA9NcqYsyfJDug83ip207tixz7InM+d4rhAJSmhJggVI26pH//vtLkCKlORH0kwfGX1JJHCx2Dd+C4N68HI+Md7g2jtUaSqCXGl2UcSCnfKUT0Qi0ty72fJUJjTPpUqPQ2/gTUReUSOxt+WFwgRaZkgCBBciL3RqWD4VLKj4auRrMhHISIqQjWfs+Kj1KR2yXP0iUnYn8yk7u/j+f8Oj0+MPjBf5VGmZz5g0TItfC6lhUq5YwOMYOMPo8Py4BWtnXPNE5EKjHg9eCl9ABhnCI4nSZDyfroh4fMRUtE5AWEGLXEtxi3qVC3uDXBdiyzP5LEbuRiYZKS7us1iFMBTx2CBBMBUJ9wYPXj7LiBJ4pRNvjqScJg28g6DTb4u9/YN9znsi7PN+exz2w92dXm+3uxONvfkNLm0ylRphkFm33cb/mjocNiUnA6JGE3kL9jw+AvFAuRx9CHN5lsUyIC9u/2yQwUNN2kc4o3svnCDADkx/FpGVn6A/1ILnMOvXQpgcJjlDqPHPQNKw6bV1liMB46lCB+IQ7QkGyDSGXS6tBaxbl8267FZUHylL5+rCeak0/UcxHgl9KwPxVkRKi7Mysl0gJzI9EekEImbQgW/8vvrWPZgvrfacMJzVvtcl+s6wrNCZMk3ZLjGoyZWhEpg9PMe4sYusLibSIkEbvi1kHJ7yDIYqPwwjyAfriJXhIxGLNcOnKpTRrD5sLbTKxY6vsrHjFZ8fj94e1mTDr5W1z7W6lQY+WFXwWTUE38+FApOMVJT/cHE6qjFpPniMXZOqzvhiePj+XOhEGhw4LEyuEvkb8YCno+F5ba0Rz37Qtg6WZY6GHluVHtYXGxVBIIx5z9E45rFpi4gkNywH5NMBe7MuATBQMNxWgr9SDqLKyEnKoUyL1ey/XIRpVKQBRW9F3mJHRDwWph7PMs2KnHE9KXDPMIynIVNFjoOvZARfZ6+fKQXEYTXv7fAi/LnWHKNL5iIxtfGKZ1rEMR+jvrZkf40yUurVsGYktck/IL/PLQzIck1pWLsKPqCVGgLJEOhgc3yqPiwbYlUGMM0E9s4E4imoouZRSUZuJ5uvKeHgNhCHyIblXCS0IbBx01/aTfPGzrtSDkaLZ09n8C1AMFv57PTVZC4pXmR6R7zAaWGzmnVabSpkdq1nWV6u46EJqbJP3qluwb/sn6wKl3+RCUtz1YwAozyHNcZFLl5UgZZRQcIzVMrKiYDTzjR1yR7m9dWfwFfzrecFaJRZxMUBsQjXVNvwZb5ZwOeVTeag09kJewdBe9zv9KLO/rgX7LX3u2EvDMb9MCL7les/D6EAx47O2MFeu8OuLg9ZLhNQGpZid1PAuHmFmO64YSXXujTtbsdv7/vd7mVnd7DbH3R3/osCJAhS5HoJnnHf50gUcygI1VrPyjWf3zzi8wqDzykuemvbgVhCPrN3WkNH4DPbhEHPJJ2jbMCwsQqpp5LpLY9l2PqcLmE50JrBE4qcy7gsIk879r1MhQ9VTaKEgkTG5MRadytDzIsEwA6zLMtYI7pWw45giVaHveUhcwnBDp0ymD6aB78Ar+MXRNpVKmE+K6dA6WYAtx5bVuwLPt5r97u9aK/Hefeg19nfHfcjvrPT7u/2+xRjgP0AO5o14KW59PciFRpKe6ygt5W/gUEgkMH2JAAt/hTeafqAeLzA/lgNLW2lppOX5eI+32KcASRnvX2I4XRS0DifLBkh9a9GKwkDmlvGZ1pO5NpaX3YuR+/eD69OLhGXv/vP1bsRfEJeK6B2mEK0hhiWICrEwlTdkcROAcw0A91IAMnfYm8c1zegEHeHEI5Q2m9mZsCYEFsRL+IcZrjV18yos2aRVkkjlShv7hHhtkRri41xDHbpYMrG3MAElRL5myH0AVnunzhLvmFTwUOhX7fYMAwlKsljBtkITGH+DBgxHoaYupZBVCDypgYfABVLFQAB0fTFwpTL5ausJyd1p2BygOTPx8kwyAsQjtSsZ2EVLU5E5x+Q2VquKd1lzWhk0lmaQ1ck8SxnBmbUGizMYENlEnoHV47QXQYKT1rSVRWrvjVSuTu1whzlip4FvDAvyLvzGMqPT6pVD26FSz6DG7OtRuSN0k2uIsFDarVwsqOq3FUmPmAJEYeb3N3k7iZ3X5i7yw9L3OOeEvTprEKfq9QdF+PmuQJ9NEVPqsozZXve4xy5xcAgDiL9+PHSHUYDvbjPEDN/RXxkt/IV4YeVP+z4mLqC0lkNX6CAZEerQQSVSIQDknshMRnKmmpndbX3So8lBGi6BiJC1dRspgpoLBHYp3hCxbjZovPI9LucTTnUR06nWrYC4qpp6GdKpvkGSW6Q5GY32uxG385utEGSm9zd5O7fM3efRJKVVJQtDieZIkm4ntlIc89RW86AgJV/jmdVypGrltEKMmMVxvKayMEbdzvjTrQfiF7Ie+HeTj/qBntdvrvf2e+Me919r77XXy/yuEqyZk7V/G39SCYGEHcLOK5IIbhMrlTYPP4D82oRYVnD0lPhZrA5mPRmgR17q9jxg8pBN2AM2FE/crx4dXGC/GFpYo92o6NzhNnWdPSHbfsnbohhsLSkawIb6LiBjpvtZ7P9fBvbzwY6bnJ3k7t/z9z9LOjYew469j4DOvYYQqwIIdafCR1DwB0IzSJwCugQFGDeFGFjBqrAJ3f66NI+53oi8groNVBkt7/meplSeL14VoIl0ziJTBfmwvIGtAnS6pIWCLi74QpVSwK6xaiSiUBMCvHDYplIymNUCPjqmU8X61zOlPFWrSLTIC5AQioKsbI3Mu64hHCiC3eAxmZ0DjqBQv0Vzzidt37XeTC7QI1PUGP27j4QAnO+Ov/dXXdL4BiE11guRtbXj1wXsGfmPIU2QtxntnxVEHQD1TdQfbPdb7b7b2O730D1Te5ucvfvmbufAdUdGnocqgPBi6E60LbarMJS7zG4/nDETqniJKDwZiogrB4uMDhekBYwiJfQcZErgPiHNpSHBb7XhDeC0wHeWPWT6p0/v3opbgDVjUrSk0R20LvB+6uJgMh1rwliycK37wbedkXsIxuz/SDDuYfCIQq1Bih0DJTTPM/MYHv7AeIC4mHe4plslRfpU3XXClSyPQZnrKlzeK3V5jQS4AuCrqVpkSe1xGSxlZWYW7+S7TAtwL90k+FJzuX9/hl0O8yy2cJb+S5waRhEzKBr+c4QdYsCdUU/0OtKx/Pfr4tl9Igu68z35GpAz0DSJRXd5eQylkYI8e3qKxG12LbwjwvdlcXOkKzL3gquof+w921e/fjx8jWbILClwlIYxNRCYicCqXkOIUKFc1jePcFJtJdpVUzsa4/Dxu0eTFQWxaAw+5SOhGDXx84IH2BHuYAtgEyKkwRVHZx186r0TihuRYybbWthSQw8yINtsNA2b8x7TRsrdSAyhY8JjbY+pT47kljvJAIEpHEqUkPJrrNSL17T60uF+EfJzbfcfOJmXi9JYU17Hdjb4gFUC2TBY0PW+uLFLT+/xg/bNRhBrssyoCWcHM07WUHptS+Wo8HPR35NOT6lH6cSdu3mNGarFjOw6cYhO2bBVCkj/s0Yhg6mwfWkgCz6YrHucFGfMsLvtmsi+XZJX/qAQUm+E0iM1AYTHyMGIAik7GkMpeRP5FnI+Z/oPbufGjrT8DVs1UgZqsB8scy4oI8L+rYGGCe/3QkxsCC3UQeqAzYADhf+p0rgBK3VPctrbVUn9ts0B7eGAEQlLiYb2C+DRYFznxg9QOqKBsowQvjqlhq+L+544XbYMFZ5+LBswVV5YwW78JLdrLzVn1BxZ/6r6YsaDxdnNGdpPPvaVfqRSvLXqbt/UsXbVJpvsdI4UI3hRsu67qMe5G8dXls9M8RD7amAf+Ep5Srhd+iOFj/eUGeUxTzHqKasDqb4mxR4CC94jthvCyNLJZSJmVaY/tBTEqMJvQmnQWQO/aGMgR+dh5crc0oYCyzRr/jdFO52hoKQhO5VtNhHaADTANyCzR/eC4ZnPyvXBY7AM+foWHZUOhtAV5IUKf5oB4hdJIxDSD0TEaE0QWELl2sRrAqKoF81q8xiDDVUoUVtkE7MWeRej685/pm1wO/GnWKD6RevG3sLRS5ETJGJdE3Y/hxviDZ/KmJ6xx6qrsCX9hYrnB5frnAEZqn704nSk203yWwjLTCp3pn1dlqdVtundgHGM2Vy6LtqzKs3Bn36CRf6gZXlGHxYHN7/wT/T4rYb7BO2MzxJQyUK27fYJvHaW2oSYdZA0luqU1AWCR4e8LQF26Y5Dv9aCGzlr28WHZH9dRJp8HNY/SzLozZ4deFkfs1e+JMwa/Uozw3T2eLIwIOPvwg8aQAdoB8HLegoiCS0D+xhUW3Kyp9TGh319+8wevgj+7f7ANaACvV/fV4XuA== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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[]required
  • Array [
  • ]
    • output objectnullable
    sourceCode objectrequired
    + +SourceCode + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-count-completed-work-items.api.mdx b/docs/api/beta/get-count-completed-work-items.api.mdx new file mode 100644 index 000000000..68a74c1ef --- /dev/null +++ b/docs/api/beta/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: eJztWltv2zgW/iuE9mHawrIT120meVmkSTvIIDPt5II+pAFKS7TNViY1JJXUG+S/73cOZVm206STXaAzhfuQWtTh4bnzOxRvElsqJ4O25ihP9pKxCge2MvgzLQsVVP7eus9HQU190kmCHPtk7yKhMREHLztJrnzmdEkswOBsor0AFy+kyIiTsCP8qLmJa5qqaaoYqsKasTZjEaxQOkyUE/gjfKkyPdIgrrxyT2Q+1UY49WelncqfdoSNZFnlnAJ7IupCuFI6OcUajkS8STQJ82el3AzvDN7g0V4b5aBmJ/HZRE1lsneThFlJr3xwkCS5XVXn6JDkp/UayQWzoSXnQiV7I1l4dXtJQ760xitPvPtbW/TfMsdj7dkmC0uAU2ZNgDJELcuy0Bl7pPfJ05SbdXGlc5IUi/MX43b4SWWBrOHIr0FHQdgRLTKN1cbKJevOUwunLQmovkhyYbLX372FkYIO9JA00cFBk9zSv04yuEvvg0KTu147Bwem4kSFyhk4WUfzki0VLDO0+UwghLS5koXOu48wzleMkKsgdXFgc7Xu91VDvNFGpWMnNUmoWOQMEwU4XumcYnZqnRKR5TxCmK7bNhZZorstXskc+kb9DmplyIhOZp/BixLvIYHOjcZ8MZ8idC5GdSLcsazaUXL4cmu3Pxi9HEjZ/3mwvfNiuDuSz59v7b7Y3aXVp8p7OVb+jqhaXvoXhXDXmShsBo/8BwZxSsL2LAAv/u2ByDy+wf4UiJG2UbOWVwT1JXRQXF4dvBODHVFIM654XI5XjGDS81NK/qoo5JCGgqsUNI+M3zo91uYuUZSpplTmDl+/2T8/PsPIyes/zl+f4hfxWit5+wbRmlNYQlTEwsRes8S1AtfSC68KmEPlXfGs5voMCknj24Q6PvmZpyqTq5GsioAZ9ep3zGizFiNnp0upxHnzJYgnuqu6HdRbjE1lyCZiKD0mwIVE/mw/y1QZ0uPaks/ERMlcuaddsZ/nmpSUhUA2ginmz8BIyDyn1I0MRhVSGcKghNsqCGODztSyLxamXPbGopIct51CyQHJH46T/SxUEI7VbGdhEy21iLV/IHO03LJ0Zy2jsUlnJsgMWsiimMGM2GgyVCboprGv1eWI3OVReMycrqlY7QLJ5e63KMxhsPwuk5X/hrx7V6D8pKxa8+JK1cnnadOM1Yi9MXdTXZHwktTmyTVV46554gvssUW+yd1N7m5y9xtzd/XlSY326rcMfZ6vQ5831g01rG7uwD0EX8XMVkLCDa4yhnZ36Tsit8qbn4KYSCS9hJu9j2kN2ZXJ09ICxW3g0QYebUrspsT+OCV2A482ubvJ3X9m7t4LjxqpOFtqnOSr6VS6WYy0+j1pKwUIxPwwTTQpx65aRSvETDQYK1lGDsmwvz3cHu1kapDLQf7y+e6on73syxc72zvbw0F/J2nv9ReLPG6SbDmnWv6OfmQTA8RdAcdVBsHlg7X58pkWzOvUiMoalR5ZIZocoAJsDpNe3jbHZoN17Pi7DdANjIEd3VfOzM5Pjok/lmb2ZDdbuUzRUWk0HchlYEhJMQxLax820HEDHTfbz2b7+WG2nw103OTuJnf/mbn7l6Dj4CHoOPgL0HEgCGKNCGJ9T+iYA3cQNBvBKfTpvP667VQJVfCLkVmT9kG6sQoN0FugSIYfiLj6Wz5/Fw8TPPToc27KBanHn3h7zUd5+h7OQkQtKleAfhJC6fd6vRt4Fd687cpSd1Hs4NgwM/a6i+m9IUx5R5Wiz7cxI4lA7L87qrXssh+cplCPdZGZR69wYlNQwzt8uHkvZ/qkT+6ewQAisukIpEUddjxMGkoz+8kzdZfDbE0/6HXuitv/XZfI6Cu63GW+e1cDvYCkKyqSCpfkLsQHGLG/ziHPQSxq+xX5+uKyTXNKID5KuEa52JioJ+mvCfSWyPrilZKOLmfYz8qIJ7++P3sqxgRduXRUnlBzfX9DincIIy6N+/Mja5rEYetsNZ6wcvt1BxSDmlJRjAoYRXwwp0qJi6PaUL9jzzhBkWez0yTFdYVmXT6ZezBXV6qg7bS7sDYFp85ND1bsyaV5TzmHuMfQBj+nPNr9YFJxqKmiaYIARFOryOfx4qKc6yVbej1WiH/NuaWRW8rc/NMVKaJpL7J4cyJzis0iC8/WevTikV/a4kcNGUaI66oMZIlaDrnktWzutUfLscQvJX7Lcnww7yca+/LyNBHrm/DYVotcHIlsYq1X/xaCQodS5WJcIdMeLdY1LZpyRqT9rZZIaVwy1SlQJst3jMQwMZjkkHZ5Bjk2FnFO24/sWdSFj0Ji7OOSzjx8gc2YKHOb+UfLTAumtGAa64Sv5Y97HQUWcpt0iNeBOAAOFv7nSlAL2qqNkdedlZ/Z93gOX6eCqMzFl3vxYW9RBOtfgl8QdUODUk0gvfm4hWdR86KdbMlY8+OFVQuuy1tYbLcrdovyNicvtAX/3fQljfcXpzBvTTH7f1fpr1SSv0/d/U4Vb1NpfsRKU+NhCjdetu4v2kH+qsZ066eCaB2gN/7iLecq3ZlEcxC4o2MU02ZUFjJQVHNWZxOt+DyhVDIQPuxQZNkpZyJaf0p/dI3MaOxAg7T1wK1yqAvw64qzxcqSEyaCT/IrPfuqPtS1CEn0p6or3qPFM8D1jto7uk6Ad59s3eedwjPvyLHicO5sgK7ptDJYjfKymgqJkHogInLtsyoWLnR7Rs1tYRn6NbPmWUyhRip0ud9xU/92dArkjC645fgH1oLf59djYXryYn2Vd6HIiSo4MoluGdo/xBvRlk5UUVKDiaoLAKZaK/x2dLbGEcxM3XFZN+7Vk3yPaMGEWqgYPs+7292tlFsKjJfWB7TELeZ8XVY0l6xF60b1SiTeLA7pv9/d6nr/ocahV9LhGWlVxWYn9pcXyaK/ZIdVJn5gmPeY6EgmMANR3tzQSQs1Xbc0HC9pUycDx1C2zO9T32OJe69l3yntZ0VHBYsb4PVxQJJQrzTv47h3gqB80sMixWnxLKg1a+1rCXFpGu9fXiMcbv8LuXGe5g== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
\ No newline at end of file diff --git a/docs/api/beta/get-count-work-items.api.mdx b/docs/api/beta/get-count-work-items.api.mdx new file mode 100644 index 000000000..4111b7aac --- /dev/null +++ b/docs/api/beta/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: eJztWltTGzkW/iuq3ocJKbcNjhMWXrYIkCm2mAnLpfJAqIrcLdtK2lKPpIZ4Kf77fueobbcvgQy7tTOTch6IW310dO76jlr3iS2Vk0Fbc5In+8lQhUNbmfDBui8nQY190kqCHPpk/zqhMREHb1pJrnzmdEkzMe9ypL3AZC+kyIiBsANxRxM0TRB9VVgz1GYoghVKh5FyAn+EL1WmB1rlovLKvZD5WBvh1G+VdirfagkbybLKOQWmRNSGSKV0cqyCciTYfaJJhN8q5SZ4Z/AGj/bOKAedWonPRmosk/37JExKeuWDgyTJw7ISJ0ckNa03k1wwG1pyKlSyP5CFVw83NORLa7zyxLu7vU3/LXI81X7JEuCUWROgDFHLsix0xubvfPY05X5VXOmcJMXi/Pm47X9WWSBrOHJi0FEQNn+DTGO1oXLJqsvUOleBTn2V47LA3O7eA4wUdKCHZBYTHCHJA/1rJb11eh8Wmtx17BwcmIpzFSpn4GQdzUu2VLBM3+YTgcDR5lYWOm8/wzjfMEKugtTFoc3Vqt+XDfFOG5UOndQkoWKRM0wU4Hirc4rZsXVKRJbTCGG6dtNYZIn2jngrc+gb9TuslSEjOpl9AS/KsqcEujIa88V0itC5GNSJsGZZtatk/832Xrc3eNOTsvv33s7u6/7eQL56tb33em+PVh8r7+VQ+TVRtbj0zwrhrjNR2Awe+TcM4pSE7VkAXvz7A5F5fIf9KRAj7UzNWl4R1NfQQkl5e3gmeruikGZY8bgcLhnBpFcXlPxVUcg+DQVXKWgeGb93eqjNOlGUqcZU3I6O3x1cnV5i5Pz4X1fHF/hFvFYK3YFBtOYUlhAVsTCydyxxrcCd9MKrAuZQeVu8rLm+hELS+Cahjk9+4qnK5GogqyJgRr36mhlN1mLg7HghlThvvgbxQrdVu4V6i7GxDNlI9KXHBLiQyF8eZJkqQ3paW/KlGCmZK7fVFgd5rklJWQhkI5hi/gSMhMxzSt3IYFAhlSEMSritgjA26Ewt+mJuykVvzCvJadMplByQ/Ok4OchCBeFYzWYWzqKlFrH2D2SOlluU7rJhNDbpxASZQQtZFBOYERtNhsoE3TR2s7ockbs8Co+Z0s0qVrNAcrn7JQpzFCy/y2TlvyPvzgqUn5RVm724VXXyedo0YzVib0zdVFckvCS1eXJNNXPXNPEF9tgi3+TuJnc3ufudubv88rxGe/Vbhj6vVqHPO+v6GlY3a3APwVcxsZWQcIOrjKHdXfqWyK3y5qcgRhJJL+Fm72NaQ3Zl8rS0QHEbeLSBR5sSuymxP06J3cCjTe5ucvevmbuPwqOZVJwtNU7y1Xgs3SRGWv2etJUCBGJ6mCZmKceuWkYrxEzMMFayiBySfnenvzPYzVQvl738zau9QTd705Wvd3d2d/q97m7S3Ouv53k8S7LFnGr4O/qRTQwQdwscVxkElw/W5otnWjCvUwMqa1R6ZIVocoAKsDlMevMwOzbrrWLHX22AbmAM7Oi+cWZ2dX5K/LE0sye72cplio5Ko+lALgNDSophWFr7sIGOG+i42X42288Ps/1soOMmdze5+9fM3d8FHXtPQcfe74COPUEQa0AQ64+EjjlwB0GzAZxCH8zrr9tOlVAFvxiZzdI+SDdUYQb05iiS4Qcirv5wz9/FwwgPHfqcm3JB6sTPwa0kLh1lr1wBqlEIpd/vdO7hS/jwoS1L3UaJgzvDxNi7dmbHnT4MuKY20UfbmIdEIA7OTmrd2mx9pynAYzVk5tEXnM4UyvAJH2k+ypk+5JOTJ1BbRDYtgWSog42HIWIpzeQnz9RtDq4V/aDXlSse/ntdIqNv6LLOfI+uBnoBSZdUJBVuyF2ICjBif11BnsNYyg4q8vD1TZPmgqB7lHCFcr4dUSfSXRHoPZF1xVslHV3JsF+UES/++eFySwwJsHLBqDxh5frWhhRnCCMuiAfTg2qaxMHqbDUcsXIHdd8TQ5kSUAwKGEV8NBdKieuT2lC/Yqc4R2lns9MkxdWEZt28mHowV7eqoE20Pbc2BafOTQdW7MiFeVucOdxZaIOfYx5tfzSpONJUxzRt/ERTq8in8OK6nOolG3o9V4i/TbmlkVvK3PzWkhTRtNdZvC+ROcVmkYVnaz178cgvbfCjNgwjxHVZBrJELYdc8Fo29dqz5VjglxK/RTk+mg8jjd14cZqIVU14bKZFLk5ENrLWq38IQaFDqXI9rJBpzxbrjhZNOSPS7nZDpDQumeoU2JLlO0VimBhMsk97O0MbG0s3p+0n9izqwichMfZpQWcevsYWTJS5zfyzZaYFU1owjXXC1/LHHY4CC7lNOsRLQBwAh3P/cyWoBW3UxshrbeVn9h2ew5eoICpz8eV+fNifF8H6l+AXRD2jQakmaD77pIVnUfOi/WvBWNNDhWULrspbWGyyS3aL8s7OW2jj/bPpSxofzM9e3pti8r+u0t+oJH+euvsHVbxNpfkRK02NginceNm6q2gG+dsa062eBaJhgN74i7ecq3RTEi1B4D6OUUyTUVnIQFHNWZ2NtOJThFLJQPiwRZFlx5yJaPgp/dErMqOhAw3S1gO3yr4uwK8tLucrS06YCD7Jr/Tsq/oo1yIk0ZWqtviAxs4AzTtq6ugSAd59tnV3dwHPnJFjxdHU2QBd43FlsBrlZTUWEiH1RETk2mdVLFzo8Yya2sIy9JvNmmYxhRqp0OYux439+8EFkDN634bjn1gLfp9eioXpyYv1Bd65Iueq4MgkukVo/xRvRFs6UkVJbSWqLgCYaqzwy8nlCkcwM3WfZd2wU0/yHaIFE2qhYvi8au+0t1NuKTBeWh/QCDeY8yVZ0bgzvRR/9/MD+f/37el6r6EmoVPS8RhpUMXGJnaQ18m8g2TnUA+JjmMENent/T2dn1BT9UDD8eo1dSowPGXD9Jb0Izo/etl6rYRfFB0AzO91101+klAvNO3TuDeCoHx+wyLFafGEpzFr5RsIcZm10z8fw90P/wGcNYe5 +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
\ No newline at end of file diff --git a/docs/api/beta/get-custom-password-instructions.api.mdx b/docs/api/beta/get-custom-password-instructions.api.mdx new file mode 100644 index 000000000..b3b8bbec9 --- /dev/null +++ b/docs/api/beta/get-custom-password-instructions.api.mdx @@ -0,0 +1,87 @@ +--- +id: get-custom-password-instructions +sidebar_label: Get Custom Password Instructions by Page ID +hide_title: true +hide_table_of_contents: true +api: eJztW2tz2zYW/SsY7ocmGUuyHSfeaLLZUZxH3XESrxNPPtieBiIhCTUFsAAYR/X4v++5AEhRD9uJt922GX5JLBK4uK9zcAECl4kuhOFOarWfJf1kLNxeaZ2eHnJrL7TJ9pV1pkypgU02EsfHNumfJKERq1qxhWZnG0kmbGpkQb8h9cNEWjY43GdGuNIoy9xEsDSIKCoRsiGCjbTxjWwhUjmSIkO7sWD7L7pswJw+F4pdSDdh745e/zx48Wb/LeOlm2gj3YxhLCN+LaVBL6dZyvMcsoIGXdhQcMOnwglDllwmkjQsuJvglcIL/2ss4I6NxKYTMeVJ/zJxs4LeQEWpxngjVDklR6QTrsaiU1nRFwqC659ouNxgJJW0NNYo1xcdK3LhTe6Hv+i5NohCp7TCkDp9+qMDLWSOl9MRj0OkOhMLD86HPP6uRRlhIel63da+rwZefV+rXqpcp+cdnqa6VG6139L72O/siiSGwCR9xFqs5omo4sz06OYMQWR/LYWZUUTFFz4tcopPw/yrjRhb32weXKjGc3FDcK/WqRV61XkZVWtqtME4e753uLPLckS8JDOAli6j3pkY8TJ37DPPS0EJenp6msSH9Gc3uTrz7i4gSFjSaXtzk/5b1ORIjIQRKhVk/m0gIs+kGrFRjiTxoshl6qHe+8WSuMtVF+jhLyF1CkPE4GRQJgJiDQ6uD6CbcAcgFpREygXM+3fkw5DkjHKGUVw2mM+1uSFcZSykEYtpxAgw3RZ6d4Ue+X5vng63B3JNjl/DyyDlHC5lQ25lyn788OaAGk4RfwrjlH+R03LKcqHGoGxk/9bm5iZDdAxPiYYDRtYNdyHB3UMMx5V08rdA6PyzlkgQ53h6jr77owYS5G8+wZkTXxxEpXkJuwDMXKrzDfx7LtjTAfvx6OWrfxHujo8O6L9n3W73aW/wjKVAyDn8wUgETRleASBB+TFISnhF4xkg0bGh0ReUxcEPUGamS3bB8QZ/mNAFSsMI0B6oDxYHK1gmRx7NzvfdYGAwbufNmHTU7jT5eQhCOT9NgvqkVp895WxixKg2IgHXUO76B7ED/mLPaPynPf6MfLxgD2dKXKDXkF1MmuahkfeCyLrsrXYSXHMhfjACduczZsui0KAFuCiMwnhAdqW1d75XpUtEGsl23QRac7ZQa9PvD2dcqOek8ypcW/OQDbWmcx68Fd6V3dWQyRL+kvcCJulpwdVsTnqFhudBud7oTDgQj2XD2Twt67AnpcmRtxPkD0UXxpA5O+vmjL1cUo69NAZCO+zIl2DIQTmKgcP8aJHHOvOlk1Rwmcx+x8kjGLJHpHkr77ySSnTGhkvSUHiViW0ZJH6WGblgqo2IvqEagUzw7RbrAHiiu8We8wz2Bvsq11PUwTvkzq+Z0Y6VRH9WdWFgnioj1wwrdgUfPt58sr0zerzD+fY/d7Z2Hw2fjPjDh5tPHj15QqNPhbVIBdsYmxvDZytDvxZKGPCpzyVPfgYEAXyRAn5wdJFOTO3tMbgeh7cCL+rrKTUiji1DbgnPneP3VG+Vec6H9IhqvZoM3hk5luqmmvrFy1eD44MPeHL08j/HL9/jL5K1sqwYKGRrRmkJVZELE0xBbm7ABagpzMfEZQ+i1AcwiMclSGwowy87s3BmxRzoEUdf06Mpmo0MeKkJJY8bzD/3ZFd0N0D9eIbJMJ3QBIkOcQZ5MEhTUbjOQfTkAzYRPBPmPqbTLJNkJM8DgVn0n9EcwrOMoBsEjEpAWfiFkC4dU56tF2Mxd+ViNObUd9AMCoEDmt+eJ4PUlVDOm9lEYZ0tUcUYH+gcPLeo3YeG07xLZwqTOqzAkg2sp42fB4clzYWWRTqicFkQj6ra1YzVZHRPd2+CMi+c9u9SXtqvwN1hDvrpeNPqF59FBJ9feAQ28tGowhQZKZblvnNsVYerAj5D3ZRnLXZb7LbY/UrsLr88iivl+NaXPg9XS59X2gwlvK7W1D1+6Um1OkcYTKkUze4cNWWmhVU/ODbhAD3WUdAjwBq6C5V1Ci2Va8ujtjxqKbal2O+HYtvyqMVui92/J3ZvLI9qrTxaYp1ky+mUm1nItPierOUMDVj1IYLVkPOhWq5WSBira6xksXJIhttbw63Rbip2Mr6TPX74ZLSdPt7mj3a3dreGO9u7SXOuP5njuAbZIqYa8Q5x9C5GEfcZdVypkFzWaZ0t7mmV9AViRLTmt1zDJ8LfEDvanTy7uqpqx53V2vGtdrANglE7mmv2zI6PDkg+hg47uvCbLk0Kv5nouvAVhEpKymF4WlrXlo5t6dhOP+30891MP23p2GK3xe7fE7vfVDru3FY67nxD6bhDn5eBJ5RYf2bpmKHuoNJshKDAhuqzfn1wJZwnqGAfPm3XhV6ziny07uPrPn0YpoR9H0a75ius8XDjCoWs+FIEANVFUFsstsViO+G0E873MeG0xWKL3Ra7f0/sfkOxGKuh64tFNPjqYhFtu5usrqVexRN1/9+a0UMlahDOFurUV4vZvAr0dQVSKV6lIA6hiwX9pBeOL9ZHBDvNc4y9y3Cu8ArtQ1UaVCxNjq4T5wrb7/UuETlE7KrLC9kFoSF4bqb0RTfV094Q7lrDRHSeL6COGvgrGGGArve1kZTOgfu88OD5cGIRiYsI+K/dN0qmg8cUUn/cNYjZYEj9mFr+cTzp+IP1rbs+lVbsg13HJr/6320Jgq6xZZ37bhwN7Rk0XTKRTDijcCEFIMjH6xj67AXiGpQU9pOzZpv3VKgHDVdazicf2qTeXlHoHTXbZs8FN1hFhAsw9376+OE+G1N56umhtFQZC0nrCQDsEGnk6W9QnWGgTn5GMrocT7xxg7glHlY5BLdwzJ6dKjqherIfHfUW88IRiNy7nToJzx3U6+xeFcFMfBY5TZndubcpOWWmevBijy/0u++nR7+OkCocF8fT7qnqsBfVUeJwEjaa6A9osJOisos37LqrEv+opHWCtI6XZu8vaRFce5KGo7QpME8ieG69t+48eJDXacijRReekNRlHcgTUQ++ELW0itqd9ViQ5683LOpxqj5OJObexW4sUB2zmDrzjO2zdKK1Ff9mjFKHoHIyLoG0O6t1QYN2PCI625sNlTphyI6kmw9evwMAQ4Vk4kOayX0ho8Oq3sP2k48seOGTv5TwacFm//gEEy61zHRq76wzDdihATuBJ2zUP57mhrJJuH/ieSAkwN48/p4JoqINbgyy1jK/F9/zfWj6SKGql2KLfvjRn5NgdSjev6DWdRtQNRXi9WknujMXZdGktuCsagth2YOr+uYac+mS34K+9ac4ml//avaSxYP5Tss7lc9+b5a+hkn+Orz7JzFeyzTfI9PE0pjSzQ8b1xDNJH8ea7rVnT9Ld54E/sVbj1VfhWONE24AUxXTFFTk3FFWe1SnEyn8nkEhuKP6cIMyS089ErG8J/gLGwSNDdoAthZ1Kx/KHPL8VaJqZO4BE4pPiiv9tmX8yq9ZuGzYZR+xjFMpwkJLODpfine/6LiWe4/IHFJg2Ysq2Ci6ptNS0cVlqF1OGUdK3ZIRmbRYT3hnYEWnROUL7Uu/uleFYko1MqHrFzNmat+NaDsaK91G4G8ZC3G3cS8arqcoxuu0c0OORM6re+KLpf1tspFtnYnIC39jDGphSdgY4c3+hxWJdIUtbsFrM+7FTrZHbSGEllAhfR52t7qbHb+koDuQ2josexvCXwvHbrrMTtevDsON1uXUvJzvzP/FbrjHWYqWF72CttHI9jIsicKC9CS5aUEKEf141Q3rlwmcRj0uL2nvhZZoV/Q4XKumdQ/CSNjConcEYlm+1b3opj/+Xt815p8L2oWoL3/HjYbEX7yuVo/faM29oxiE+161u9xcX6tqtS2qZk1FKxNiYK7oTm/Y7fJqh5dhP6zRbeWLEdlb71G8fgm4XP0XXYAkUw== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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."}}>
here\"\n}"} language={"json"}>
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-custom-violation-report.api.mdx b/docs/api/beta/get-custom-violation-report.api.mdx new file mode 100644 index 000000000..f2a58aad2 --- /dev/null +++ b/docs/api/beta/get-custom-violation-report.api.mdx @@ -0,0 +1,104 @@ +--- +id: get-custom-violation-report +sidebar_label: Download custom violation report +hide_title: true +hide_table_of_contents: true +api: eJztW1tz07oW/isan4cNTC5tmra0L2dCW5juKbS7l8ND6RwUW0kEjmQkuyW70/9+viXJzrUUCnPYMOahJPLS0rrrW4p8G+lMGJ5LrQ6TaDcainyvsLke/0fq1A2fikybPGpEOR/aaPcyOjveZyc6lfEkumpEiciMiHkuMDs3hWhEVsSFkfkEtLfRhRVmT6tcfM57RT6i+TJRu1YnzetyhV0jeBJd3TluNjYyo1EIcz6SlvE01TeW5Zol+kalmieMM5uJWA6kSJjiY/yteDHjxGUDbUA2lNeiGjJiIIxQsWi9g1KfCmmEZUangukBOz599d/e/uvDNy1omnEDrrkw1ukgSZaMQ/pGRMvhm2d5KmyR5rAblI5HYsyj3dson2REYXMj1TC6a4DWrVXZZ1FHwQ73SYQcnxZFnVWbJBOf+ThLib8YbDwf7HQ3uttip7u51elv9vvPu50u39za2NlOnmPllZIPZCre0MfvkNlHCCM2ztAkOSPG8yLGjqzpFibnwt6ZVlZYWrKztkb/zTM+FXlhlHUM/5aZ48luZD4KnvQcnc9Bw3MWI7S4DDOWgyCIRFRC5bQezzJErqNqYwUaus8MjQi6jTmmRX2puJlEd/jXiLqrJN9LJVZgB8bAHk3mFUFgytKvnwphc9bXyYQhqKW65qlMviDcB0t8V0in+x9ETPmYGUrdXHp7JgKGSPd0IlZpMi/sS6lEc2hgOEgonMgxJjJwvJYJZrCxNoJ5lmVoOrp5B8MSrXX2Ahl5GvTbC8rATLnh8UfworLykEAXSmI+K6cwmVRxtWJZsS14f2ttp9MdbHU57zzvrm9v9ncGfGNjbWdzZ4dWHwtr+dCbJqzNjeGTpaVfCSWMjFmqY3jkbxgE1Qi2dwK4xTFF5mJsH/aB4/EV9qec97SVmkFeRoWygcr1Yu+EdbdZytWwcON8uGAE1bw4o7Qu0pT3aYgyFZp7xsdGDqVaJYpQxZjK8P7By97F0TlGTg/+ujg4wyfitVSEewrRmlBYQlTEwkjfOImDAjfcMitSmEMkLfYscH0GhXhIy0Ao/Tc7sTAmYmvAUTsxI6y+YsYsazYwSPzZVIr9rsKeyJZoNVifxpCt8Yj1ucUEuJDIn/XiWGR58yhY8hkbYbcR5mmL9ZJEkpI8ZchGMMX8CRgxniSUup7BoEAq+yqki5wpnct4odBNTTnvDSSBzB3F0axTKDkg+cNx0ovzAsI5NWezsIqWIGLwD2T2lpuX7nzGaM6kE9TMGFpgZ53AjAb7NyoTdJO5ZaEckbssCo8q6aqKRSWwVMuVu9demP1cu2cxL+xX5N1JivLTdKpVD65FSD633ftq5LxRuilUJDwktd3kQFW5q0x8FH+RJnXu1rlb5+5X5u7iw9OA18JTB33Wl6HPheJA9tq4zXMJ+hgXPUqzksgjNO/IBoNBAkT68+05EvsjUB7oxeeM4OcPxEd+K18Svlf5w4/3CX5UzprzBQno7Og1GKASiWTXyT2V2BnKm2pjebWX2vQlAlStgIiomoZNdME4TGYKpUgSbhvA/8KqP3I24qiPHBlhra+AtKpKmpmWKq+RZI0k692o3o1+n92oRpJ17ta5+2vm7heRZCWVy5aAk2wxHtMRm4u08Jy05QwErDw5ZFXKOVctohVixiqMFc0jh6jfWe+vD7Zj0U14N9na2Bl04q0O39xe317vdzvb0exefznN4yrJ5nNqxt/ej87EAHHXwHGFQnDZXOtk/vivcGe7VNao9FS4GTaHSa+m2LG7jB3f6By6gTGwo7nnePHi9MifHXv2ZDddmFgQzPam88emBCkphmFpafMaOtbQsd5+6u3nt9l+auhY526du79m7n4TdOw+BB273wAdu4wg1oAg1s+EjglwB0GzAZwCHeIC5lUEGzOogk/h9DGkfc7NUOQV0JtDkZ2dZRR5rjV7zdWkBEt27iRSTc1F5Q20Y6I1JS0IyksVqFoS6JaiSo4FYVLED0vlWLo8JoXA10yavUEOrXzOlPFWrSJVnBaQ0BWFVNPZq0aMSYSTGBD8Awd3DjpEof6BZ5zBW991HsxOSeMj0pgdfI6FoJyvzn83V90SOITwhsrFmff1PdcF/Jk5V2gjxOfMl68KgtZQvYbq9XZfb/e/x3ZfQ/U6d+vc/TVz9xugekBD90N1EHw1VAdta41VWOolBdf/HbG7VAkSuPBmOnZYPZlicIcrEErhYjXVELqLuxu15+4/N/111fbt/K3iu3Z587d9W97avYvofjVhRy92YVKwG+V5Znfb7Vt4E168a/FMtlDk4NB8ovRNK9bjdh8mXFGd6DKqz0QiYL2Tw9CItJz9jaQQ9/XQMffecBpTMMMr7v7BFzm7+7pw8wQ9CvNsGgzpEMLNDUPEDL3GH9ZRt1x4LekHvS5Mevf9unhG9+iyynxfXA30DJIuqEgqXE2vw58RMPerL12Kn2429JNAZ2mxYyLrsBeCG3QN/pbMkz/fnj9lQ4KjrhwUlpCwkNQ/IKFOECKu3PXKGyM0ye1ARhfDkRO8N3cnh9KLDVIozN6pMyHY5WEwwhvsA6co3M6kNEm4WkGzrp6U3knEtUhpi2xNLUmBJxPVhoXafG7eU7cdur5BKn/RGqOtd6rJ9iVVKUnbOtEEFV0byC6zUi8+o9djhfhXya3puTUdN/t0QQpv2svY3/GOkePEgqfWWevRi3t+zRl+1GRhhLguykCWCHLM36SKS689Wo45fk3iNy/HO/V2JLHXzk9jvrQxi60yTdghi0daW/Fvxih0KA0uhwWy6NFi3dCiTZcRzc7ajEhNv2RTNoEcnXxHSAzlg4n3aed2wEX7MxSXku+dZ5Hz79FXJ+z9nM5u+BIbLFEmOraPlpkWbNKCTV8DbJDf718UWMht0sHVAR8Ae1P/u0oQBJ2pe57Xyqru2LfdHNoaYojquNhs13/ZnRa48Im5B0Rd0aAME/Cu7pbhOwu8aBObM1Z5ZLBowWV5U429c8FuXt7qh0/aT/9p+pLGvenJyrFKJz+6St9TSf45dfcnVby60vyOlSZAYQo3t2zoGWaD/EXAa8snfXQUPRL4i6cuVx3qRk/j3wsjFDPLKAOkpqh2WR2PpHBnBJngOWG/BkWWHrtMRDtP6Y9O0L9gZkCDtLXApLwvU/Bzp9jlytwljAeW5Ff6botwp0IjJNFzihZ7i7ZNxXALtWx0mxfPPujQu53BMyfkWLZfOhugazwuFFajvCzGjCOkHoiIRNq48IULHZwSpS20g37VrDKLKdRIhZZrXszYHg/o+Bmd7YzjH1gLfrfh7BmmJy+G1wmnipwK380Q3Txsf4g3oq05EmlGTSOqLgCYmFnh9eH5EkcwU+EHD22G7TDJtokWTKg98uGz0VpvrTVdu4DxTNscbe6s+OUrpeHNwsVXCBfj8XZ6/P7T3k4NmxB1D+2MTsVItcJ3M76/vIxW9ZeYurv03mopNT2sXg1F1zKCqYjR7S2dsFDTdUfDnwpB7fvl1bSfcn0oXEmf0egOUFwWXxidtdqToFzy1P1G9PWvvq5UuzwyVJPpaUGEjx8FHTIsaEsN5aME/eL7ro+QqzL03RVo/RmVM6N/7E+xZiYuvrRKbWV1sPDqgPKD34NQwgd4DDX4f0YZpss= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Download custom violation report

+ + + +:::caution deprecated + +This endpoint has been deprecated and may be replaced or removed in future versions of the API. + +::: + +This allows to download a specified named violation report for a given report reference. +Requires role of ORG_ADMIN. + +## Request + +

Path Parameters

+ +Returns the zip file with given custom name that contains the violation report file. + +
Schema
    + +string + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-default-identity-attribute-config.api.mdx b/docs/api/beta/get-default-identity-attribute-config.api.mdx new file mode 100644 index 000000000..c86c127f3 --- /dev/null +++ b/docs/api/beta/get-default-identity-attribute-config.api.mdx @@ -0,0 +1,104 @@ +--- +id: get-default-identity-attribute-config +sidebar_label: Default identity attribute config +hide_title: true +hide_table_of_contents: true +api: eJztW9ty2zgS/RUU92GSlCnZsnx92VLsJOWpXLy+VB4c1wYiIQkJBXAIMInG5X+f0wBIiZIcezLZnUmKL7ZENhp9x2kIuIl0LgpupVYnaXQYjYU9FiNeZvYkFcpKOxtYW8hhacWRViM5jjYiy8cmOryKKgp2WuiRzISJrjeiVJikkDkxBLuLiTSsELYslGF2IljqmTNZjeUVe5Y4/u/UgFn9USj2WdoJe3P24r+D41cnrxkv7UQXNMSx/K2UhUhByhKeZeCNp4PTE3oAHR42VwfK5LzgU2FFQSrdRJKkzrmd4JXCC3yrhse5VzOWKV6aZCKmPDq8iewsJzID3orMM9LFlFs8KUtQ3m5ElbDRoS1KsWoiwZYtyU6OwUh84dM8I95itL0/Ouhv9/fEQX9ntzfcGQ73+70+39ndPthL96Pba5rG5FoZuAFC9TY36V9zqoGaz1S7lXm/Mj38IBKLaWEbCyIazvM8k4mLju4HQzxuVhWvB8I+iCUrvQRC8WFGSteEQ60zwVW0bIGTkXNXMC/TBZtiYhiTPF2xWTBHZUXnXf8VVq6de1FwZcgJZmFuXhR8BibSisbzO4SXy8H/2sXCqrObmhAV016d1ahrunTKZUbRYStxkXdSSc9p2XMUJEZwk0MLVo9wjqEwr8Zt3KOWf3ufFjQZUVSa1PMtTNVpKMOTRJfK1taKFv2x1tyqzDJybOVNnqaOL89OFyRely+DYighUTFjH8Us/sSzEqHDZWEo9Y3VhWBczRhymqfccgbBnRb11LXYN3MZvXsjETuvILt1WSTV01ezc/e1fu4qZS852Nrf3N/b4/u9XbG7v7mFT8nmcHM75Vt8Zzu6vSXvSussdLHGy4vvV6ptPaDJ566qfOuo+uuy/iiTGMOeFQUsEbMzV41ROqX3LlUnYSwb6tSVVqlgU5l2vl8lSOEKmR3p9AGx91wqEY8LLklC4UROMJCKwyeZUk2Ykoc9yypAHV0zImGJzhZ7ylPo6/U7Csr4lEs+gtdJer9Al0piPKuGIK3riFozrdgTfLi7edDrj3b7nPf2+1t7O8ODEd/e3jzYOTig2afCGD4W66pTc+oXQolCJizTWOLk7zBIgRKAjCcB3OQPL2iOxwNz39PWagZ5mRVf7Abj7OnRKevvsYyrceme8/GSEVR8eb6S49DcM35TyLFU60QRqpwSsDh+9nxw+fICT86e/efy2Tk+Ea8VdIH1TKqUwhKiIhYm+rOTOCjwmRsUzQzmEGmHPQlcn0AhHtBIIJT+m5kZGLOCDRgRZl8zYpE1GxV62kgllzdfLHskO6KzwYb0DMU6mbAhNxgAFxL5k0GSiNzGL4Mln7CJ4KkoHnfYoC6HzFU4g/EzMGKok5S6nsGoRCoLB5R0aZnSViai6Yu5KZcrblVRXi46hZIDkt8fJ4PElhDOqbmYhXW0BBGDfyCzt1xTuosFozmTzpTlCbQApJvBjEUBCzOUOSatYaEckbsMCo+q6OqKtVgoXbl75YU5ttq9S3hpHpB3pxnKT+xUq198EiH53DLjq5HzRuWmUJHw0i2ZNDhQ1e6qEp+NpMjSNnfb3G1z94G5u/zyLPQ64a2DPlur0OdSha6RFs8V6FO46FG6ai1/93jaO3KD+pAAkX59exF6UmpIvuTUzH1HfOSX8tVurfaHfz4k+FE7q+ELEtDZ0WswQiUS6aGTey6xM5Q31fbqbM81cDUCVK2BiKiaBZvpknGYrCiVIkm42WCpFkb9YtmEoz6iCYC8vgK6xi2Ncy2VbZFkiyTb1ahdjX6e1ahFkm3utrn7Y+buV5FkLZXLloCTTDmd8mLmIy28J205AwGrdt3n+4vOVctohZixGmNFTeQQDXtbw63RXiL6Ke+nu9sHo16y2+M7e1t7W8N+by9aXOuv5nlcJ1kzpxb87f0Y9o+LT8BxpUJwGat12tz+g3kLMaKyRqWnxs2wOUx6PceO/VXs+Fpb6AbGwI7FHduLl2cvib/w+7Sc7Ob2Uglme9OBnFsHKSmGYWlpvuPPES10bKFju/y0y08LHVvo2OZum7v/a+jYvw869v8EdOwzglgjglh/J3RMgTsImo3gFOiQlDCvItiYQxV8CruPIe0tL+gkTgX0Giiyd7DmjIPW7BX9dB/AkmnsRKq5uai8gXZKtEVFCwLOxiiRiqFqSaBbiio5FYRJET8sk1Pp8pgUAt9iFg9GFlr5nKnirZ5FqiQrIaErCpmmvVeNGJMIJzEi+AcObh90jEL9Hfc4g7f+0n4wOyONX5LG7NmXRAjK+Xr/d2fdKYETCF9QuTj3vr7juIDfM+cKbYT4kvvyVUPQFqq3UL1d7tvl/udY7luo3uZum7s/Zu7+Cage0NDdUB0ED4bqoO1sshpLPXcnlP/fiN2lSpDAn4DXicPq6RyDwwhG4KG0MzfJJSD+kQ/lQWknlJkyVYfLZ98P4QoCp9d04HwqEIvh0gAVITo1fxh1l8eY7s2aI/S33ZB7cf2yPo0bJ9VVA994eDuURQb2E2tzc9jt3iA8EBa3HZ7LTsVC6c+dRE+7Q/hkTbmj060+tYnAXRfwE3ScQwtJOeMLrGPu3RuOmUcGbnYHGr7KWYUj4DM0Pcyz2aDT1CF+3WOImKN5+cU46o6L1xX9oNdlkd3+dV08ozt0WWe+r84GegZJl1QkFa7nIXVOSN/PvhJY89WLfmPorUz2hsh67KngBdoQf+zm0a9vLx6zMeFbV19KQ9BaSGpIkKGnCBFXPwfVERQa5Ja0QpfjiRN80DjkQ/nKRhkUZu/UuRDsqjpZ/RoLyxlWAmdSGiRc8aFR148q76Tik8hoze3MLUmBh5zpwkJd3hj32K2vrhGRqj6433mnYnYsqexJwglEE1R0fSW7yiu9+IJe3yrEvypusecWO27m8ZIU3rRXiT80nqBoEAueGWetb57c84sX+FHXhifEdVkGskSQo3k0K6m89s1yNPjFxK8pxzv1diKxeDeHMV/qmMHam6XshCUTrY34N2MUOpQGV+MSWfTNYn2mSWOXEXFvc0Gk2E8ZyxhQ1Mn3EomhfDDxIUEBh4S035RxKfneeRY5/x6NesreN3R2j6+wYhNlqhPzzTLThDFNGPsaYIL8fkGkwEJukw6uDvgAOJr731WCIOhC3fO81lZ1x77rxtDSkEBUx8Xkh/7L4bzAVXe/3AuirmlQhiN3YyUcVqPbY4EXrYoNY1V7EMsWXJU301iMl+zm5a1/SaUF+p+mL2k8mG/VvFHZ7HtX6TsqyT+n7v5NFa+tND9jpQnYmsLNTbt0bYuC/GnAa6tbh7S3PRH4i7cuVx2MR5Pk78ISillklGfcumt5lNXJRAq36ZALbgn7bVBk6anLRMBuSn+0lo7RuAAN0tYAk/KhzMDPbYtXM3OXMB5Ykl/puynDIQ2NkEQTKzrsLfpAlcAt1APS8WC8+6BDM3gOz5ySY9lx5WyArum0VHQnEmKXU8YRUvdERCpNUvrChaZAicoW2kG/elSVxRRqpELHdUPF1LwZ0X42WuUFx98zF/xuwmY2TE9eDBeB54qcicxFJtE1Yft9vBFt8URkOXWhqLoAYGJhhlcnFyscwUyFX1B0Me6GQaZLtGBC7ZEPn+3OVmczdu0CnufaWDRrDfHvuQ69HJA38w39H+Aid1ivqNHo5rQjR1YofePjW9Orlavc5L+VHtff776/O0W/M4GRie/NDW32ULt2S49/KwXtJFxdzzsx18EiCMKd6BHK0vLN1kVzPzoLdnnsfq5afz98rcbVTqWazTcpInz8KGhvY52ut9cY5nejnJSe0u9XLfBY+UWnsQXw4hlFLr8DO4QPsAiq4x+HOpT/ +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

+ +An Identity Attribute Config object + +
Schema
    attributeTransforms object[]
  • Array [
    • transformDefinition object
    + +The seaspray transformation definition + +
    attributes objectnullable
    + +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-default-violation-report.api.mdx b/docs/api/beta/get-default-violation-report.api.mdx new file mode 100644 index 000000000..de3c94dd1 --- /dev/null +++ b/docs/api/beta/get-default-violation-report.api.mdx @@ -0,0 +1,104 @@ +--- +id: get-default-violation-report +sidebar_label: Download violation report +hide_title: true +hide_table_of_contents: true +api: eJztW1tTGzkW/iuq3odJUr6AMRB42XKApJgigeWyeSDURu6WbSVtqSN1QzwU/32/I6nbbhtCkknNTFKdB2Krj47OXd+R1beRzoThudTqMIl2o7HI98WIF2n+X6lTN34qMm3yqBXlfGyj3cvo7HifnehUxrPoqhUlIjMi5rnA9NwUohVZERdG5jPQ3kYXVpg9rXLxOR8U+YTmy0TtWp20r8sVdo3gSXR157jZ2MiMRiHN+URaxtNU31iWa5boG5VqnjDOqrnMOPHYSBsMj+W1qIaMGAkjVCw676DEp0IaYZnRqWB6xI5PX/1vsP/68E0HmmXc8KnIhbFOZklrZxzStiKFB/jmWZ4KC8vAUFAynogpj3Zvo3yWEYXNjVTj6K4FWrdWZY9lnQQ73CcRcnxaFnVRTZJMfObTLCX+YrTxfLTT3+hvi53+5lZvuDkcPu/3+nxza2NnO3kekfmgYaaVFZYE662t0X/15U9FXhhl3eLeid6/nT9khkGesxje4jKQrNpZpoIEIyqhclqAZxn4OKouuNDQQ9ZpRfDTlGNaNJSKm1l0h3+tqH+fqHupxArswBj4ts285CJhsjTdp0LYnA11MmOIE6mueSqTLwj3wRLfe6TTww8iphDPDKVDLr0BEwFDpHs6EfdpUhf2pVSiPTYwHCQUTuQYExk4XssEM9hUG8E8y9L7jq7uZliis85eIMhPg357QRmYKTc8/ghelKqPCXShJOazcgqTicuRB5YV24IPt9Z2ev3RVp/z3vP++vbmcGfENzbWdjZ3dmj1qbCWj71pwtrcGD5bWfqVUMLImKU6hkf+gEGQ4LC9E8AtjikyF1P7uA8cj6+wP6WVp63UDPIyqj0tFIcXeyesv81SrsaFG+fjJSOo9sUZ5XyRpnxIQ5TA0NwzPjZyLNV9oghVTKmy7R+8HFwcnWPk9OA/Fwdn+ES8VuraQCFaEwpLiIpYmOgbJ3FQ4IZbZkUKc4ikw54Frs+gEA9pGQil/2ZnFsZEbLnCjRlh9XtmLLJmI6OntVSKfaFmT2RHdFpsSGPI1njChtxiAlxI5M8GcSyyvH0ULPmMTVDAhXnaYYMkkaQkTxmyEUwxfwZGjCcJpa5nMCqQyhBG5hNd5EzpXMai7ou5KeveQBLI3FEcLTqFkgOSPx4ngzgvIJxTczELq2gJIgb/QGZvubp05wtGcyadoWbG0AKb1QxmNNgSUZmgm8wtC+WI3GVReFRJV1UsKoGlWq7cvfbC7OfaPYt5Yb8i705SlJ+2U616cC1C8rkd1Fcj543STaEi4SGp7SYHqspdZeKj+Is0aXK3yd0md78yd5cfngaAFp466LO+Cn0uFAdY1sZtnivQx7joUZqVRB6heUe2GAwSINLvb8+R2B8BiUEvPmeESn8gPvJb+Yrwg8offnxI8KNyVs0XJKCzo9dghEokkl0n91xiZyhvqo3V1V5qM5QIUHUPRETVNGymC8ZhMlMoRZJw2wLEFlb9lrMJR33kyAhrfQWkVVXSzrRUeYMkGyTZ7EbNbvTr7EYNkmxyt8ndnzN3v4gkK6lctgScZIvplI7YXKSF56QtZyBg5VEhq1LOuWoZrRAzVmGsqI4comFvfbg+2o5FP+H9ZGtjZ9SLt3p8c3t9e33Y721Hi3v95TyPqySr59SCv70fnYkB4q6B4wqF4LK51kn9+K9wx6dU1qj0VLgZNodJr+bYsb+KHd/oHLqBMbCjeeB48eL0yB/PevZkN12YWBDM9qbzx6YEKSmGYWlp8wY6NtCx2X6a7eeX2X4a6NjkbpO7P2fufhN07D8GHfvfAB37jCDWiCDW3wkdE+AOgmYjOAU6xAXMqwg2ZlAFn8LpY0j7nJuxyCugV0ORvZ1VFHmuNXvN1awES7Z2Eqnm5qLyBtop0ZqSFgTlvQVULQl0S1Elp4IwKeKHpXIqXR6TQuBrZu3BKIdWPmfKeKtWkSpOC0joikKq6exVI8YkwkmMCP6BgzsHHaNQ/8AzzuCtP3UezE5J4yPSmB18joWgnK/OfzfvuyVwCOENlYsz7+sHrgv4M3Ou0EaIz5kvXxUEbaB6A9Wb7b7Z7n+N7b6B6k3uNrn7c+buN0D1gIYehuog+GqoDtrOGquw1EsKrr8csbtUCRK48GY6dlg9mWNwhysQSuGyMtUQuqi7G3VrV4rb/rpq97Z+cfeuW16ujeieMgFGL2thUvCY5Hlmd7vdW7gQrrvr8Ex2UNngxXym9E0n1tPuEHa7pyTRDVSffkTABieHofvoOKMbSXHti6Bj7l3g1KQIhivcpYMvcqbLyOTbGRoT5tm0GHIgxJgbhogZGozfrKPuuJha0Q96XZj07s/r4hk9oMt95vviaqBnkHRJRVLhan6t/IzQuF995XL5fIeh3wF6K4sdE1mPvRDcoFXwV2Oe/P72/CkbEwZ1NaCwBH+FpKYBWXSCEHE1blBeE6FJbtsxuhhPnOCD2kUcyik2SqEwe6fOhGCXh8EIb1D8T1GtnUlpknAFgmZdPSm9k4hrkdK+2JlbkgJPJqoLC3V5bd5Ttwe6ZkEqf7sao513qs32JZUmSXs50QQVXe/HLrNSL76g1/cK8a+SW9tzaztu9umSFN60l7G/2B0jsYkFT62z1ncv7vm1F/hRZ4UR4rosA1kiyFG/PhWXXvtuOWr82sSvLsc79XYiscHWpzFfz5jF/pgm7JDFE62t+DdjFDqUBpfjAln03WLd0KJtlxHt3tqCSG2/ZFu2ARedfEdIDOWDiQ9pu3ZoRfuDE5eS751nkfPv0Uwn7H1NZzd8iV2VKBMd2++WmRZs04JtXwNskN9vWhRYyG3SwdUBHwB7c/+7ShAEXah7nte9Vd2x77o5tDXEENVxsdmu/7I7L3DhE3MPiLqiQRkmtF1dKMN3FnjRzlUzVnlOsGzBVXlTjQ1zyW5e3urXTtpE/2n6ksaD+XHKsUpnP7pKP1BJ/jl192+qeE2l+RUrTcC/FG5u2dAoLAb5i4DXVo/36Px5IvAXT12uOqiNRsa1Zg7FLDLKgKMpql1WxxMp3MFAJnhO2K9FkaWnLhPRw1P6o/1zjMYGNEhbC0zKhzIFP3d0Xa7MXcJ4YEl+pe+2CBcpNEISjabosLfo1VQMt1CfRld48eyDDg3bGTxzQo5l+6WzAbqm00JhNcrLYso4QuqRiEikjQtfuNC2KVHaQjvoV80qs5hCjVTouI7FTO3xiM6c0c4uOP6RteB3Gw6cYXryYnjBcK7IqfAtDNHVYftjvBFt7YlIM+oUUXUBwMTCCq8Pz1c4gpkKv3JoM+6GSbZLtGBC7ZEPn43Oemet7doFjGfa5uhtF8UvX81cfmFwORBv54ftf9nrnWG3oTahm9GZF+lQ+LbFd4+X0X3dI6burrz4WTWQaEkmsANNvr2lMxPqqO5o+FMhqCG/vJo3S67JhJ/oM1rXESrH8puhi5Z5EhRKnrpffb7+fdF7VS0PAdVs3v9H+PhR0LHBkoZotKGYO+NxQnsifwq0MH35pU/q0KrG/NUBhRp/YLMPH2AflLP/AzuzKrU= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Download violation report

+ + + +:::caution deprecated + +This endpoint has been deprecated and may be replaced or removed in future versions of the API. + +::: + +This allows to download a violation report for a given report reference. +Requires role of ORG_ADMIN. + +## Request + +

Path Parameters

+ +Returns the PolicyReport.zip that contains the violation report file. + +
Schema
    + +string + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-dkim-attributes.api.mdx b/docs/api/beta/get-dkim-attributes.api.mdx new file mode 100644 index 000000000..ce43d869c --- /dev/null +++ b/docs/api/beta/get-dkim-attributes.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-dkim-attributes +sidebar_label: Get DKIM Attributes +hide_title: true +hide_table_of_contents: true +api: eJztW1tTGzkW/isq70Mu5bbB3AZedp1AUsyQhMWweSBURe6WbUFb3WmpIV6K/77fOVK3r0nYTGo3kzI1NbHVR0fnru+o5fuGVXFZaDdpHFzeNy6sKl5mxqnPrlu6EcYaNj8wmdMDHUunMxMlN3ocSecK3S+dsgeFkknj6uGq2chyVTDNcdI4aAyVOwRpt6ZsNBtODi3xfDvD0DYwNVE2LnRO3zH1TGGOulXi8I/jN+LpYTaW2vyhJlYcJ8rQVJWIN1Knz8RUEDHICiHTVEyyshBOGWmcfSK673uid9QTmmc6rWxLnOixdlYUfhmZCpeJzY2NGRoBVUQMbi1IXSibQ05ocHDf6Gxs0D/zAp9o60Q28PLOaRyTMY2jKTLP06Bz+9rSvPuGjUdqLOmTm+QKnGRRyAnmaafGdmY861+r2OFBXpCZSUZ6qpMZGot1zRA06rMc5ykNbXa2+ts7/Y1I4i/q4y+Se0k/wvj2zq7Ef/24sWj+i4vjQyGtzWItHSx9p91IJOwEslRfiVtVsBMaD82GTBIYyH5djhdZvwebj/5h4bU808a14my8tPL5SFVOmAi4MyxaLYHVKPqOjOynalbzfpalShrmN5BlCnsPZGrVjAiuKNXicu9Hyo3gaKyEEPfeG0kLDZURyq/CYeVG2lbCtGsJK3nOsxtl7COcGAzzMCPWZaP8tDneur6+6ezEN8nW3SjdNnuT7d14Z7fYSXflJ/Ap9/Lx1m/XN5N9kEiQWCJJ4uvdwU6aD5lklDOX62uQ3IDkE0juduNrVey4HNIsJRnZ2rHkwamwMtTFZykO3/ZYb+9nH7OVtv+aGes56cpvuL5XxjE5b9X6qDwFbCks8xF6AEur2tB1JNQ+qeKuJY6VCIyb4hViSiVNcapMwvZ9WFyLPbtYKqp18Ln2KEqUdiz2Qu16oL9mY3tV9r9MNSlxVBRgFQlUr7IwMGVQp1CfSoX60M+SiUAcaYOSo5PWd1SHL1SBRDmY4GWWqFWumBf2lTYqGhZQHBIqFjnGRAGOt5rMJ8ZZAR8wS6pppALTtebcCku0NsULmUBfr9/LoAzM5AoZ34DX8crytFBtjMZ8UU2BL0LKrVxW7SnZ393Y72wPdrel7Py2vbm3098fyK2tjf2d/X1afYyokEO1KiPnl36tDAIqFmmGUq//DYNgM4PtWQBe/PGVmHk8wv4U9p62VjPIK2jXbSIuX7w8Fdt7IpVmWPK4HC4YwUQXPYyYMk2pSPnqBs0943eFHmqzMitNOaaac3j0qntxco6Rs6N/Xhz18Il4LdWIrkG0JhSWEBWxMMruWOKgwB3y0qoU5qCUfB64PodCkqrKlFD7b3ZiYUwRajRmhNVXzJhlLQZFNp5LpdhDFPFUt1SridqAsbF08Uj0pcUEuJDIn3dRIXIXnQRLPhcjgBVVPGuJbpJoUhKbP7IRTDF/Mq2C2jMYlEhlxRtgVjraJHSs5n0xNeW8N6aV5GTWKZQckPzbcdKNXUnIhNSczcI6WoKIwT+Q2VtuXrrzGaOxSSfGyRhaANpMYEaU3xiVCboRIArliNxlUXhMRVdXLCqBlVpc7t54YQ5dxs9iWdpH5N1pivITsWr1g1sVko+3I1+N2BuVm0JFwkNSmycHqtpdVeIL7BFpss7dde6uc/eRubv48Cz0POEpQ5/NZehzYSTaxKzgzXMJ+hQcPQaIMhAxvAmObDLw8tb5/f25x6JErz7nulA/Eh/5rXxJ+G7tDz/eJ/hRO2vOFyQg29FrMGDEecByTyX2IJFNtbW82qus6GsEqFkBEVE1C+pbhYTJitIYkkQC2iaZsuaJAwJGfZSMd30FpFVNEvlWao0k10hyvRutd6NfZjdaI8l17q5z96+Zu19FkrVUnC0BJ9lyPJbFxEdaeE7aSgECUZ2+izrl2FWLaIWYiRpjNeaRQ6Pf2exvDvZitZ3I7WR3a3/QiXc7cmdvc2+zv93Za8zu9ZfTPK6TbD6nZvzt/cgmBoi7BY4rDYLLuixL5o//YN5CDais8SFrhZthc5j0qsaOnf1l7HieZeKNNJMKIdk5DGmmNqKaBtox0RYVLZ2giyHqoqHXGhpyUSjpsQKXAkEjUnofQslLWtDLl0nUHTio4hOlCrJ6FW3itISEXAnSjFBzhsDSUFINCPOBAyPYIarzD0SnwUV/CsmLM9KY3wCJo8+xUpToNXLfWXW+ewzhC6oRPe/gLxz0+m5HGgQAGgJfs2rcucbna3y+3uPXe/yvscev8fk6d9e5+9fM3f8Cnwc09GV8DoJH43PQtjZEjaVe8TWN/zVM51QJEnB4iyzmSwjJFIMzrkAohUtMVEMkXYVqtKvrB5G/OUB3Gjzm99KURQqqkXO5PWi37/0VpIeWzHWrumBgsju6+NLuwzIrig7dDvAJRgSie3ocmooWm7XQFLm+zDFzb+Rw46VR3635Kmcjx+y9mWtSTYEoD1HEwxAxRwvxxDJ1i6NmST/odVGkD39eF8/oC7qsMt9XVwO9gKQLKpIKV836sluP8LZffenK23QPoR6ts7TYOyLriBdKFmgG/GuLp7+/P38mhoQyOctLSwBXab5eJMUpQoSrWLc6wqdJvLEUWTkcseDduZcklDVikEJh8cH0lBKXx8EIb1Hez1CP2aQ0SXEJoFlXTyvvJOpWpbTzteZuXLV1YtqwUFvOzXvGuxy3A9rg45hHWx9MJA41FR+6p8c0QUXu7sRlXuklZ/T6XiH+VnGLPLfI3056tiCFN+1l7C/dxEhdYiFTy9b67sU9v2iGH/VOGCGuizKQJYIc86+24spr3y3HHL+I+M3L8cG8H2lsofPThK9YwmIHTBNxLOJRlln1dyEodCgNLoclsui7xbqjRSPOiKizMSNS5JeMdARAyPKdIDGMDybZpw2Z8UgGqGYSn5If2bPI+Y9olxPxcU5nHr6ke1klXQCM7XfLTAtGtGAUboMG+f22RIGF3CYduA74AHg59T9XgiDoTN3zvFZWdWbf5jm0NcQQlbnY/MB/OZgWuPBJ8AOirmlQhglP1y/76E5r4EV705yxqpOARQsuy5tm2BIX7OblrU+iaJv82fQljbvTA5N3Jp386Cr9hUry89Td/1PFW1eaX7HSBIRL4cbLhlZgNshfBLy2fIBHJ8wjhf/jKecqg2m0Kv6OOKGYWUZ5Kh1FNWd1POIr/YXKlXSE/ZoUWQDSlIno0in90eAxo2EBGqStBSaVfZ2CHx9OVytLThgPLMmv9N2W3H/QWvEIraRqiffoxkwMt1AnRtcr8Ow6Cy1ZD545JceKw8rZAF3jcWnoyjHELsdCIqS+ERGJtnHpCxcaM6MqW2QM/epZVRZTqJEKLe5JirF9N6BTZTSsM47/xlrwe/XTApievEgondqdWpEzlYYfVzQXYPu3eCPaopFKc+oFUXUBwNTMCm+Oz5c4gpmx0As9d1YM22GSbRMtmFB75MNnq7XZ2oi4XcB4nlmH7nWG+WvlVvyCYi4E76cH6T/br0TCdkR9RDunYy9SsvR9jW8gLxtLDSRakhHsQM/u7+lUhDqqBxr+VCpquS+vps0SfQNPfzrCHeeN4q6cz0+mjffyGwZqfeqe9vUR+VB+YRcNH2iph4f/AM57Rpg= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +
+ +List of DKIM Attributes + +
Schema
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-entitlement-changes-identities.api.mdx b/docs/api/beta/get-entitlement-changes-identities.api.mdx new file mode 100644 index 000000000..31272ba5e --- /dev/null +++ b/docs/api/beta/get-entitlement-changes-identities.api.mdx @@ -0,0 +1,79 @@ +--- +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: eJztXOtz2zYS/1cw7IcmGlGyZTuuPXNzozhJ60za+Py43IzjmUIkKCElARYg4+g8+t9vdwG+JPkRJ9NrWn1pLBJY7Bu/BRe9CXQuDC+kVsdxcBhMRfFSFbJIRSZUcTTjairscSzwmRQ26AcFn9rg8DI41algx8rK6aywwVU/iIWNjMyRFBCi19K/ZracAh34QzTELSs0mwjG41jELNGGcWZg1oCdzySOjHMtVcGMKEqjLLxNpS2YTpis+YEVWDETNK/PrmUxY0AH/9VlQW/aC/b9Kp4bWLX1llkNE7ibVVphWMQVs0Kw65mMZu1Fr3WZxsR6kogI6ciEpq0nfC2M6Mha6JrpAWg054ZnohAG9XoTSFRfzosZvFLwAn55PYKF+oGNZiLjweFNUMxzfGkLI9U0WPQDI34vpRFgx8KUYtki537JyiogEZATn3iWp0jnh2j7YEs82w9/2Oc83BXxQcgPtiZhfBDv7ezu7o12kgmsspbBlrhfzmRbd1/E4++lMPOGyRm3Ld8Olpf2Xj5nMA7sIzvOim6lNE5q+E94akEAW8yJN/CtjJjNUx2LSrwVTUw02IArWj7hZVp4Qovb2NZJYsUqu2/pMRjTe1NSpinEigWK4LXFgF3YkqfpnNlcRDKR4HcUH71UZrLooRPmfCoVL8A5Z0aX05nzSiJhB+/VGfj+5b932PjkmJ0VXMXcxOxIpyn4PPDATmq/vXoyK4rcHg6HsfgoUkwpA8tlSgE8iHQ2lLEa8lwOracTRjWdsPH/pxSgmTbopKhPSkyDdVqvfWJrjY5hVTEVBuY5Iu7RzggeZFLJrMxoXm2ArVuVT8pa0f3P/BNTZTaBJAHpyGsMNepy1Teju9HeF2gv45/c30Sl1iX8ulWbkS7XBV7CehgsPSYhWUpw41znZeocU7Def8JzXfA0PMLZPVR3rpUVbCZ4LFy2p4FrLIL5vM7WzjguW1dRABplPRdhPZeo5VSBDmOwIVhRqgjngRi2gPwFe0eBrDAShDaIGf8IaZ2B1UhZOF5mOY+KPkoDScQIsCGkEEz8kEHQS6zAVXtE5B8kec/tIMDtR56WwmkBR09oL/LcfBM+9bXSntWGtsRlbzmD57WBS4tWoa23UoidqwLC002aoLXVH6y175B14Cv0XD4l47ln6BG2zHMUzoEeyt1ARl/ja8jTaWwPwTtQDb1eZ/cjzXz5DlTtxbdpPpHpWs2/oud/ct075pe1/6p6+jD9U1pwwFgbe4gUKoOAaez1qlmYvWbvg9dcvQ++poWukJZLdxbfj7a28J+liCijSAjILwN2ehdWvgceY1hHGnI/pGhYg+d5KiMK+OEHiwvdrDLKjeHoObIQmW0915MPYBrEtgbVSKUDvAU0tyLkKgwjs3i+5wgZnV/eN/EXNMPyVF7A4ElZiLXcARyXOJunJx0+l82waJnbSfEwJFqH1DjmGTuDHQcxc5enWID3FoRID4OfSthCwIpWlyYSNiz4LMymQFUhDk6kscUvDUV49EFPztGA6AY8BSOPQZi5ReFS7ayHeEV8kpHGiA8KPxrrs6p6a9V3iwVJu7vOz45SiUj4pTGg5ND7WlP8+G2STXQ8xzCTCvYyGT/GrW5xn1gUkBKOKHLu84ZXUolwarhEDgWxHMFEBhQ/yhhDnbY1RxIDhaIBxw06wQ2aGGyz5zwGeZ18R14YVKbh0W9A6/gBfn2hJMxn1RTw0jr9rFlW7As+ebZ1MNpNnu1yPvphd3t/b3KQ8J2drYO9gwNcPRPW8mnHY6t47C79o1CQ/CKGHpHK/4JCjOCge2KAFn94CBONB+gfCzk3thbT88sK8QnQEWfPj07Y7j5LuZqW9JxPl5SgwoszDCIobfikAheLvmfirZFTqdaxIhTi0svgxctX44s35/Dk9OW/Ll6ewV9Ia+WwYqzAW2N0S034caaviWMvwDUUhFakVOoPWM9T7YFAXNn2QOl+WQhAkTEPdGCGX33NjDZplhiddUKJ4uZTwZ7IgRj0AQzCM8Bg0YxNOKBCpt3pR28MG0BehG+8JnseGj8dsHGd4RyytDB/3pxE+OOTpIRQFvXGAMBTRqJri0aVXWs0GeVN2ygYHMD5/X4yjgooU8knOlFYe4tn0dsHeHaa63J33lIaqRSBCGCDiCrgSBtA4ZCZQDYJyMWnI8ICkHhUNa7OWO1ESenuZ8fMi8Il0YiX9gFxd5JC+glJtPrFR+GDj+pFl43IGpWZfEbyVT1N9qNqc1WB79DKJnY3sbuJ3QfG7vLLU4+u/VuCPtur0OdC8RL0a2jzXIE+hrxHaVYNInjjDdlHyO0h0ut35xDYvwmF46EIwBrhK+Ijt5WvMD+u7eELs6puq7b+xhbIIOnRSZBAJhLxIfHdcOxAIqlqZ3W1V9pMJDioWgMR6Vh9rkvGQWWmVIrOVGyfxVpY9X3hT1MgIqx1GdB9CAhdGbhBkhskudmNNrvRX2Y32iDJTexuYvfbjN07kWTNFUWLx0m2zDJu5s7T/HuUljMY0HzWqkOOTLWMVpAYqzFW0EUOwWS0PdlO9iOxG/Pd+NnOQTKKno343v72/vZkd7QftPf6yyaO6yDrxlTL3s6OpGIAcR8Bx5UKnMsWWsfd478SP88kmNYw9dS4GXQOKr2qsOPeuhPGY7CIQS89c0vcctTo8DZXwAJAUhc1NfLZIMQNQtzsMptd5q+xy2wQ4iZ2N7H7bcbuZyBEj4ZuR4gw4MEIEcYOtliNpV5Rt80fDRQpVDwH5N5MR1Fp6MCzQoGEK8CVfOMx5hDsKj0MhtinGlbdw8Obuv91MWw1LISRa08e3nTaTxdD2e5XdmjVSVGaFKhXnSY3YFww6mLAczmomgaUvqZ2kwlodE2ywu/aLjBxADW2uAUGZA4j0eNdeiTizji+4SmoO1rupEz9JGD1uS4hIRKZPoPo8N5Hj4HFnKv595ZGD8jbVuQDuS5MuvhyWRyhW2RZp747V4PxDDhdEhFFuEJzgZdg8wba6wL4OXK5bVyiZ1xetcecIZZ3HK6MbPYnrEBGKwy9xWEj9lxwA4WGO5R/8vrd+VM2RQRLGcR1OAmJJQfE4Am4EWXIcXVAjZNo02raZ8edTwAYkSxJQSnM9+9VXca/wNZxCrme1I6TBKUXnPXwXijemXdLt957FbIX0rhWKUtjvIiuo/Eyr+TiLbkey8R3FbXQUQuJGnZhdbhwqr2MXEtJBGkBSfDUkrYevbijF7boYV0GT5DqMg+oCc9H98NNVFnt0Xx06IVIr8vHe/WOLhV0pzGXDZmdUcvqMYtmWlvxT8bQdTBULqclRNqj2aKbDCFFRDjaarEUuiVDGQLYJP7eQGAo50x8gps9YR0NMFDFLmx/JctCXviV2uV+7chMjy9hT8aRsY4+o8FviWdcMMQFQ5cnrOffbXnoWNgZBTJQHnAOcNTYnzKBZ7SVGx2ttZmfyA9pDm4fEbBKVGx+6H4cNknQ/8XoBY6ux0CqRqxef8qC38zTwn2vo6zqlGFZg6v8phq22yW9OX7rcxbcgv9s8qLE4+Yw5q1K5187S9+SSf48eff/lPE2meavmGk8ekZ3o2V9mdF28uce060eDlq6VwH/hbcUqwTUoQxqrlK0CeUpL9CrKaqjmRR0rJALXiA+7KNn6YwiMTcaw79qNZ4aGANhawG38olMgR7e7atX5hQwDnyiXfG3Lam2wbUcuh+wd9ilHIFZsMrD5gF490H7cu8MLHNC1wRfVMYG0JVlpcKbXMB2mTEOLnWPR8TSRqVLXFD0KVHpQhP0q2dVUYyuhiIMqN4xmX2b4Ik1FMMtw9+zFtjd+uNqUD1a0fcKN4KcipQ8E8d1of19tMHbwplIc6wzIesCABOtFX4+Pl+hCMSU6zoeaDMd+kl2iGOBCJZQzn12BtuDrZBKCniea1tAZdwi/iNeSmuazu+6cfmkufT5dNlNb5qD/M1d0offJfXbKdZBwxyPBNFIpavdXHF9GXSKa5hz2L5euqa+xiHLFzxbJTYUZDPwAqR8c4PnTVhzLvCxu1eChRz4JSaL5kLErbZ+4C3MtXL+JvDoZOWapz8lCehi6MM5+XtdsLxDofUF1Ecq8tu6LXmHIqrLoI/Uw+ae47d3z/EOb6gusz7SG/529xjvUGVz1/ORytxcTWxfTbxD083dzkbTV81p72du1k9O/UXHp+x87f9dYi0n1XdMNW+zUXHYgJHPc4ElXlb+JxKPYKULehZXMMHlYlKTG+M+qbVmrzSdoH7rzxw/vgQ4vfgfpvt0rg== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Query Parameters

+ +Succeeded. Returns a list of identities with or without the entitlement. + +
Schema
  • Array [
    • attributes object
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-entitlement-distribution-potential-role.api.mdx b/docs/api/beta/get-entitlement-distribution-potential-role.api.mdx new file mode 100644 index 000000000..550026311 --- /dev/null +++ b/docs/api/beta/get-entitlement-distribution-potential-role.api.mdx @@ -0,0 +1,79 @@ +--- +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: eJztW1tzEzkW/iuq3ocBKm3nSkhetkyAqUzBks2leAipQu6WbTFtqUfqJnhT+e/7nSO13b6EQGBnZyjzEOyWdM53rjpHLd8ktlROVtqa4zw5TIaqemkqXRVqrEz1QvvK6X5Nwye2whMti1NbqGQjqeTQJ4eXyXHvWNAj8UYbbYbJ1UaSK585XdIqkDwfaS/GqhrZXDhV1c54oWY8RGnLupBOVxORt/iJgXVCYjSyFY6YaINn/GnM7IRX3mN2B4hK6ST4KEe4bhJNzEtZjTBkMIBvcTIk3Uh8NlJjmRzeJNWk5EGwBv7bjcSpP2rtFPRRuVoty6NWIRCaqKrPclwWRO5ZtnWwqZ7up8/2pUx3VX6QyoPNfpof5Hs7u7t72zuDPpitxFm2df19aHtLGszvVOJ34P+jVm4yE0CbrKhzdWTHY2t6WQb6ySKy5xYIpBE5mSwCuR7BT5QTGS8Ukle2vcWLa10Uok+ewCxyATcxtkraihjIwkMTvpqwKPCkMctWFjZXjZ6WVNoPgJLb2ysi5ktroBiasL25Sf/N4z+rgU4BQUecRreWYixLgDeVDPI81M/JnYkMHhFjWZaFzjhKux89cb9Zhm/7H1VGepB5rmmqLE4cRXelgxRxngbZoXIQE/82kt1Vsh0VmiC/dA7g0igfdK0HoiL3h6aVr0Tf5hOB6Nbmkyx0/l2oyzmscAqpiyM216LPLzrSK21UOnRQORAqhpxhoQDFTzonM4ytUyKQFDaIwPM6cx4PTXS2xHOZQ94g31EUBmqqnMx+By3KkvcBujAa60WzhEKOjHwHW7WvZP/p5sH27uDprpTbz3a39vf6BwO5s7N5sHdwQNzHCAM5nDOjdE5Ollj/qoxyOhOFzWCR/yhKudJHL2PmWKIrNfb324BpfIX+KSGGuVMxI15Rqc/VBrz7+dGJ2N0XhTTDmp/L4YISTHpxRvmjLgrZL2KQQvJA+K3TQ21WQVGmHtM29OLlq97F63M8OX3574uXZ/hEtJZ2ox4StcnJLQEVvjCy14w4CnAtPbJhAXVQXD+JVJ9AIIn4bk3U4ZufeCgTvjWQdVFhReS+YkWbtBg4O54LJY6bz5V4pDuqs4EEh2djWWUj0Zeespzh6U8omZZV+jpq8okYKZkr97gjetOwF4hGEMX6CWVK5APFSZ8IDGqEMsBo7Md1RZlTZ2reFjNVzlsDQUDJDDNet41CwQHk9/tJL6tqgGMx21E49ZYIMdoHmIPm5tGdt5TGKp0g22aQQhbFBGp0DhoWyK1CY7eI6YjM5ZF4TDNvmrEoBTZicbp7E8C8qCyPZbL2XxF3JwXST8qiTQc+qRh8cAMbsxFbozFTzEgYJLF5cZw1NVcT+GKgVZGvY3cdu+vY/crYXRw8jRVdHOXSZ2u59LkwsoZ+HW+eS6WPY+8xVjSTuLyJhtygWjSWSL+9O0dg/64MzUflSYXpD6yPwla+BL43tUd43qfyY2qsOVsQQNZjkGCATKTyQ8Y9QxyKRFbVzjK3V9b1NRzUrCgRkTWdmNhaSKjM1YbLYek3RG6VN79UYiSRH2OBzxmQuJo8LS0K1HUlua4k17vRejf6eXajdSW5jt117P49Y/eLleQUFUdLrJN8PR5LNwmeFsdJWikwQTRni2IacmyqxWqFiIlpjZXMVw5Jf3urvzXYz9RuLnfzpzsHg+3s6bbc29/a3+rvbu8n7b3+chbH0yCbj6mWvYMdWcUo4j6hjqsNnMtX1ubzx39Qr1MDSmuUeqZ1M3QOlV41tePeqhPGY1jEkZeeBRZ3HDWGelsaQEBJGqJmWvmsK8R1hbjeZda7zM+xy6wrxHXsrmP37xm731Ahxmro7goRE766QsTczqaY1lKvyLn+9EKRQyUiYPcWNstqxweeTRXIdQVdAUn4jgnf1qhG+NKl191peP2fxnsIvnszvalx252+GU9pKsYWbkfcdltv2dPZW/a0/ZadrlBwoRlkrF0B3qOqKv1ht3sDejD5bUeWuoOMSOQmxl53Mjvu9qHvFamM3nqHsKUJondyHIvlDhvLaYqHkDyZeDAdq4c8Hybkg84vUqbLFOQTE1sjXTKZDYHYib7JjwGxlGbyi+fZHfbFJfkg14Urbr9flkDoDllWqe+L3DBfAOmCiCTCFZkLPgRCbK8L4DkKma9Xk99cXrXnnFGlHxAuzZztXtSfbC8BekvTtsVzJR3akHBk/+i3d+ePxZDqW84vtefLHJrvpkhxAjfi/Nlrjq9pEW9pztbDEQvXm3tBQPEqBgWUIt6bM6XE5XFU1L+wsZxiJ2C10yLFyYdWXT1qLJirT6qgPbcz0zY5p85NF1rsyrl1j3l/5UZEG7r8wk87700qXmhKexRjPCeKyGfz4rJs5JItuR4K4h8NtTRQS5maf7yAIqj2MgsXTjIkjRDbnrX1YOaBXtqiR10bnhDVRQykiYhj/rVO1ljtwTjm6KVEbx7He/NupLF5zy9rrst57L1FLo5FNrLWq38KQa5DoXI5rBFpD4Z1TUxTjoh0e7MFKQ0sU52iFGV8rxEYJjiT7FMpwJWQRZFo8hC2H9iyyAsf0Kjn4sOczPz4Ejs2zcxt5h+MmRimxDANecJH/GFDJMdCbJMMnAeCAxzN7M+ZIAJt5cZAa2XmZ/JdXsM38ACVqfjyMHw5nCXB+EnwAM2ezkGqpkp++qIL30WkRbvinLKaM4hFDS7jLSw24wW9BbzTUxjaoP9q8pLEvdlRzVtTTH50lr4jk/x18u7/KeOtM83PmGlibU3uxmxjE9J28uexpls+OkR/AbnxF6Mcq1zGo0nito+rmDahspAVeTVHdTbSig8dSiUrqg83yLPsmCOxdJbCX/lAaOgwB2HrUbfKvi5AryPOZ5wlB0woPsmu9N3X3PkQr2yEJlZ1xDv0gSaDWagHpKsFGPtoYzN4BsuckGHFi8bYgq4f14Yu3AJ2PRYSLnWPR6BnyOqQuNASGtXownLpN13VRDG5GonQ4W7Ijf3bAZ1no1VuGf4eXrC7j4fZUD1ZMV6inglyqgr2TJo3X9rfRxvelo5UUVIXiqyLAky1OLw5Pl+iCGLGQy50+9YNu3GR79JcEKEWKrjPTmers5lyS4HnpfUV+uYW8VOF7gvw/ge3/Rdd+Wb2KuDP+7lB3LCo0+iWdCRHaqhDdxSa28tkVXOLpYftHyIs9Lc0vHz//2taXDREI1iB+N7c0GkQ9Xy39DjczqdGCgsoWGd35O/U4w+/nr9SX78rOgJZ/XOBeOSRJNTqNW3oN0rx6DT+KOCx+OLvNlaCa05hzaSNpgE9syF13A+C9I0/zngAyEVPur3CknAUyJoMs8JhYWv90us0MsH0AOfXl0gFt/8FZ8lchw== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Query Parameters

+ +Succeeded. Returns a map containing entitlement popularity distribution for a potential role. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-entitlement-request-config.api.mdx b/docs/api/beta/get-entitlement-request-config.api.mdx new file mode 100644 index 000000000..22463db2a --- /dev/null +++ b/docs/api/beta/get-entitlement-request-config.api.mdx @@ -0,0 +1,99 @@ +--- +id: get-entitlement-request-config +sidebar_label: Get Entitlement Request Config +hide_title: true +hide_table_of_contents: true +api: eJztXFlz2zgS/iso7sMkLlG2ZNmy/LKlJI7LU47t9TF5cFIbiAQlZCiAC5B2tC7/9+1ugBQpyUeO2pmkNA8TiQQafffXEOC7QGfC8FxqdRQH+8FY5Acql3kqpkLl5+I/hbD5a60SOQ5aQc7HNti/DmpDbPCxFcTCRkZmSAVoXE6kZcOzI2ZEXhhlWT4RTMynwHMiyyKiyxJtGGc2E5FMpIjrQ9uwqBVRYWQ+g4XvgisrDLCTiy/5sMgnyIyM1X5tyr4RPIZpi4+nXPGxCD7eA78ZN3wqcmEsEZXIdcaBXCtQ8AK+SSRho4mY8mD/LshnGT61uZFqHNy3AhRBGgEqy00hFjVQ0w87QkriC59mKZLoRoPO3tbeXr+XJIPOzs5Wp7+zNejHnIuos9uJAuTPCJtpZYXFtbtbW/hPc4WhYvVFvKFYZakIdaRynMizLJURmXjzs8XZd8uS6dFnEeUwMTPoELl0a/MoEtY23eDpSRl8v+HpBS7iHvkJ3Bg+Cxa1dWpiAapkqQQJdMLK+czmIrPkHuhBjpfSedrsYJrlM3Y7EYopPZ8k3RA0DnqPzMXUPpdnYS5p1KLBwYCqmJLnn1weXR4fvIN//336/uTgHN5dnF6dvz6ovr4bngwP6dPh6R8H5yfDE3h5eH56dbYcKm/o20i4GJEqljcyLkAKkHlsdJHBc547mcgl5CgVLmBUU09t9gdPQTGMG1AVai1N9a1tf1Af1MbGEtsbG/vs9FYJgwon7VqrI8lzsEPNsdzsuoCPTbzQhYmEm+O1gMPfUeRVE45iCssZiXE70VN6WuYEEHUkQOdsymNPalGNSHPIDtFciqtIsEPUVMsRf4PL3E5kNEFS86QymtH7jY3S0kfxxgaDV2kzPpdsBsE+n7LKNVSRpnyEk1elgqO4lNvzErGSXIsVFjjTKvVuXHdC5H6JlzqjYlvw0d5ON9zb7uyEvd1+Eg5i0Q/7WyLmg36yux3tBffAPRmzmZSGjQilUaaM8WmZ+F16q+QdaZ0Krpai9yip2w/MPC3AjEhfxuAdkOSJIosL1NdiFBO5hBcppKqEp1bURER13uN7JXn6HYzdSHH7MF+keVhjhtytyDOPcUjfH9LxitT5wNDGoLCLLlct8WAOfshgpROuVJp7uZSgrxcT4Mo8Vw8DdPr71tK0hVT4jBnzbPmMwSsCoj4r6O1G/cFeZxDy3UES9ga8G45ENAo7UHX7HS52d6NdKLD3+F8r6K0qrK9TiV5xYAxkpxAKK0IYiFLZcHM20vEMQ1Qq0KOkSvODSm4sci7BcvHKOtRk9q1UIhwbLpFDQSxHMNF7OWVRDeXAkSzzEI1rN3IJaKLdYa94XAcSJAw6rOHRn0BrdfZrMnSlJMxn5RQm46p8r1hW9CGF7W4Nur1kt8d5d68HYGg0SPj29tZgZzDA1cE/LVSPp1HEoYCiBNk11RFY5L+gEACCoHtigBZ/PhogGs/Q/yXI5cZWYnp+GSLUFqSZV6/PWK/PUq7GBT3n4wUlqPDqYqmMgOSO8KmRY6kegyRvDt4Or44v4cn5wb+uDi7gE9JawhoAGRFggFtqqsUTfUscewFuATRYkYI6ADixDU91AwTiHsL7gdJ9szPI9lPmcyPM8KuvmFEnzRKzUPEjB+fZC9kW7RZUf3g25TkU8BF39dFVbkyoWR4ee01usAkAfWFettkwjiUKCVDoxoGgKZ8BIcbjGEPXEUgKCGVgRuYTXeSAGXMZiaYt5qpcLOpl1j6uGwWDAzh/2k+GUY6gjsSsR2HlLZ5Fbx/EwrROk7vLmtJIpTOV8wik4CkgiEgbAxpmI5BN5pb5dEQoCBKPKsdVGatRjJCbd46ZN7mmdxEv7DPi7iyF9BOSaNWLG+GDD9xAz2vu3Ew+I8FLFJsm+1GVucrArzDaOnbXsbuO3efE7uLLc7+d4N8S9OksQ58rxQvQr6HiuQR9DHkPdtp+EMEbb8gWNqweIv3+/hIC+09A1TBefMnKTvwH4SNXypc3RCp7uOejEs6XpX9uC2SQ9OgkSCATiXif+J5zTIpyqtpeXu2tNiMJDqpWQETImobNdEGduCmUorbHtlishVW/5WzCb6ougzIgrqriMNPS7XitkeQaSa6r0boa/RrVaI0k17G7jt2fM3YfRZIVVxQtHifZYjrlZuY8zb+nH3UYDCh/xYAnZciRqRbRChJjFcYKmsghGHU7o07Sj0Qv5r14d3uQdKPdLt/pd/qdUa/bD+q1/noex1WQNWOqZm9nR1IxgLgbwHGFAueyudZxc/uvwF8xE0xrmHoq3Aw6b5cbjIQde8vY8UTnIBsQBuxoHthevDo/RvqwNJFHvdFvKwiznercD0MIKdGHQdPS5mvouIaO6/KzLj+/TPlZQ8d17K5j9+eM3a+Cjr2noGPvK6BjjyHEShBi/ZXQMQbcgdAsAaPgeYMC1EuH3zIQBT753Ucf9jk3Y5FXQK+BIruDZRR5qTUerJmVYMk2diLVXF2Y3mDsFMeaciwM4GwMKVIxyFpSu0MqcioQk4L/sFROJcUxCgR0zSwcJni6w8VM6W/VKlJFaQEcUlJINe69avAxCe4kEoR/QIH2QceQqH/gHqe31nftB7NzlPgYJWYHXyIhMOar/d+dVacEjoB5g+niwtn6geMCbs+cK2gjxJfMpa8Kgq6h+hqqr8v9utz/GuV+DdXXsbuO3Z8zdr8Cqns09DBUhwHPhuowtr3FKiz1lg7Z/r8RO4WK54Dcm+mIsHo8x+CEK8CV/A0ZzCF4W2Q/2KzdMLGbdzK+rz8JvQXDqLyW4VoDx2lhUqAwyfPM7m9u3oEBwXD3bZ7JtvRH5JW+bUd6ujkCra1ISHj+1AUfDqArN26BNqncSPRqlwKJuDOAP8scWDAEHTl4lDLeh0HLzqAtYY5Mi0EEeA+jx8BiBu3Fb5ZGt8mjluQDua5Mev/9sjhCD8iySn2PrgbjGXC6ICKK8HF+9ah2k2XpAtK8vuCvAN2lxU5xWJe9EtxAo+AOxrz4/f3lSzZGBEoZoLAIfoXElgFi6AxchDLcsDwkgpOo6BhdjCfE+LBxDAcjiiUpCMw+qAsh2HV5zeIEUv855GpSKU4SlB5w1scXpXVicSNSrIrtuSbR8WSsNkFDm7wx7yVVQGoVpIKPU3ra/qBC9kZiYpJYyXGMF5E6P3adlXLxmlzfysQ/SmqhoxYSNftygQun2uvIHeuOIKyRBE8taeubF3f0who97KvgCVJd5AE14floHp6KSqt9Mx8NeiHSa/LxQb2nuzDNacxlM2ahOqYxO2LRRGsr/skYug6GwfW4gCj6ZrboAk5IERF2t2oshW7JUIYAFom/YwgM5ZyJj7BYE1bRbtuEQvITWRZi/hO00jH71JCZHl9DTcWRsY7sN/OMC4a4YOhygPX8u5KFjgWxjTJQHnAO8Hpuf8oEntFa3nO0VmZ1Ir9Jc7A0RMAqUbHZvvuyP09w/hOjFzi6GgNpGLF2dZwMvjNPC+tWQ1nlLsGiBpf5TTWUywW9OX6r3zqxhP7d5EWJh/PNlFOVzn50ln4gk/x98u5flPHWmeZXzDQe/aK70bK+Tag7+SuP15Y393D3eSLg//CWYpWANrQx1Jg1LoMioSzlOXo1RXU0kYK2BTLBc8R+LfQsPaVIhA4ewx+aPyI0NjAGwtYCJuUjmQI92rguV+YUMA5Yol3xuy38MQoNLgltpmiz93hLPQKzYJeGB3jh3Wft27ULsMwZGpa9KY3N8HpdofxV1mLKOLjUEx4RSxsVLnFBU6BEqQtN0K+aVUYxuhqK0KZ+xUztaYI7ztDM1gz/xFpgd+u3m0H1aEV/x30uyLlIyTNxXBO2P0UbvC2ciDTDPhGyLgAwUVvh3dHlEkUgpvxvHNqMN/0ku4ljgQi2R859ttud9lZI7QI8z7TNobOtET8U+eN34BveeDffb//Rf6DAVxZsCTYz3N1CfgvXorg+8Tqo94kwZZ/+vsAjrSI0HxOQGKfe3eHeCPZO9/gYhmHjff1x3hZROwkWwc9xdUv1QfFflPdBXzb0R3+oYKUs5X6ems1b+QA+/ilwBwBEgT4Z+KUtGuLFvXCbOLUpSz9zYI9VNdaHB+gs/IFy7T+A3JCQ/gcyxk9Q +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get Entitlement Request Config

+ + + + + +This API returns the entitlement request config for a specified entitlement. + +## Request + +

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. + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-entitlement.api.mdx b/docs/api/beta/get-entitlement.api.mdx new file mode 100644 index 000000000..926e706c9 --- /dev/null +++ b/docs/api/beta/get-entitlement.api.mdx @@ -0,0 +1,107 @@ +--- +id: get-entitlement +sidebar_label: Get an entitlement +hide_title: true +hide_table_of_contents: true +api: eJztXG1v20YS/isL3gFNClEWKcqSDPQOqu0ELpzYZ8kNWidoVuRS2pYieVzSjs7If7+Z2SVFSrKjJL7rC/Qlkcnd2dl5fWbI5b2VpCLjuUzis8A6smYiP41zmUdiIeLcalk5nynr6MaqXVXWu5YVCOVnMsWJMG0yl4qNLs9YJvIiixXjMROrGWy6ZDJX7OykDSSV8ItM5ksge29dK5EdJ3EuPuSjIp/jUjKIj2qTjzLBA5i2fnnBYz4T1ruPwE3KM74QucgUEZXIU8qBXMuK4Qb8JZGE8udiwa2jeytfpnhV5ZmMZ9bHlpWJfxcyEyCDPCvE5v5EYz9nJ0BNfOCLNEIyrj90Bp3BoO+F4dDp9TpOv9cZ9gPOhe8cOr6FPGZCpUmshML13U4H/2uuMmoIDVbwUTDwC0byNI2kT4o6+FXh8PvN7STTX4WPE9MM1ZpLvRjsfWPLn9ohyetzdlhK+nMXoln1pc55EcPGsolQuYt0fTCAXOyyB7kQ7G4uYpavLXLHFSvJtKwwyRYcpGoFcMHO5RoDbsft2E7H7gwmzuCo2z3que2OO/wZeVkkgQzl1zMTcZWzithXscRzYGBa5F8g+2rqphYWYjEV2UWIHlREEZ/iVXQNWPGWR8WOq9FQloTrQmisdfz6u4bSWxfXjQsX2QwvqSjNbV7kyYLcoHVy/B3eHVVXRid4LUp8HqFgVFJkvhiTk1yQZ0yI31341p7EcOAW7lmYJQu6qNdgxhPrm5plSZEiG2kmb2UkZg2jmSZJJHhMa4e8iED1IY/UZuABiTO5yQCE2xrd2rpGRX6UFMHL5FZk8VOvS6TZrKS9uXaD0qawm+a0Tfi1K7+T6WA2gPuazacUXp3wpuQqf1TbgvpasmALnqJ4wkwIG+MH+00sbe1wKZeZ2rTSpcrFor7uvQXxJwpe6xxJv38k50ZmgkDiWjy6rGUTw6mm+HSpx3C4Pa+6fZ8PBr2gD1kHfvnCHfBOpyOmyGa+s0+bNXBgi93JKGI8uuNLxaaCvbXGF9dXx6dvrQYD+uLnJTezzEZEvTgZ26MTe6wltxFWP8IiyV0sMsr2UQShF6HM40YwlkCccgg7mVwwsALSN9EpY9hWD/oyLWm6MqgWesgtXe6GAfd93hNdrxc6g2nYH/Y7fjidDkLhu58nUb0sjv/kwjKgO0vmPGYbIi4WiDTPTk5fT84mP20DtKIR/ImFNjuLwSVAOUuWxPAPjSiJoHurIk2TLG+GxdUyqGPiG80BKV6JUGQi9sVJngDD9+tG8Q7DKcBSP78U2UIqBdzVYwPPMr5EbAx+vUPMeMBcVrSNzcBG8gTAMJMxG3MZXSYyzr9RDMAJn3Il2ozCNPyFm+azWSZmiK10xPELmL0Ajel4g8VAgOOqQNUCH6F6AECtAOQO+2c+VAy3PFsCMspmAmQ7FfmdAPQEEIlklEPikVh9HJT0VXvDkDM5m+fbBLQWO8H3ceN6OHsm2rM24z7eVc/hDofMjxVNuhIMKD25U6B2mpgjkyhfrE0uwBTKZLauiJXJrWLK6fnp8UTbgiazkxPosbR6ja27pIggGYMMYR9mO0nc3sJZjYGfxu2XP/7y98nV6PV4dDw5u3jdsMyVOZBVYrQXM134fdryVhXV43n+XCoKTWcnCv8rV2hh3uTxssXyBNCz9OdaE6fNNMqBvRmgj3ZdsjdW2J860wHv2r1QBLYXBp7NA3doD9yO4wmn2xfOEGa4Q3966HcObSfgA9vrCm4PpsKzp13H7YWuNwhdbqHrQYlZoLdfpwjLgxeYH9Xj8blpjydn48vz0U+/vB69On06IKF0LMQ6otCcsZJTdit5E3MsMCAxX90y8HaoiUGiIg5S9Og2Yy9wWbYAZpS2e8P/0iD3OawRJ1DAoyv6cx7PBOMhFNosBISRN6sJEweA9/bbmIQFeAecV6Eyb+oqLGthA5zfPZvneaqODg4CcSsi5KCtIO5oLv1kcQDF/wFP5QFEBX4AfmDXFn7O/sHeo0TeV9y3t4Crk9Px8dXZJZn702G6OlbdK6SmkJpgHtNLLe682uZtkKe2JMZ17ejyjmG/hEuQXF0KlSZK1RDMVW2mBaLFCjElNxqGn0+gyDXiZFPafnbSabCTUhmBdUWJHHhc2yqKy2yWLSBnIs5VqfAJAACHMClO7gySuUuaBa6eZvAMxeAjVo9mlNRrLtXQ7Hrg0yprOKBW/ru6/uuNx48Nag9V8qbIbvRA6p2LZj31EgebieOyBwnJbfRq5PtJEeemDKrXjw4MoHljP6GJL6NkCjViy0T8WYHY2brvOPxQ9DtTG1Buz/acXs/mPf/Q9oYuH059f+Afeh+rWWOaNLYdu2e7jt3tDXqDwyHMsp1Db9DpwnTPdoedoTPsdboeXO12sR0Yb+FuoaCuuISk68uUR2YLo+vJxasRSnp08vZtc8qqgbNePTtPUT2vu6YCqFaPklazI2KC7Vq/wlzdqDJNPdaiiqUsD/v9XsfzvY4om5I9H1TR9wer7u9pHEwS+AcKMFN/1autOrHeAKU/xA4n/Br2Bp7bFz3P9VbERlAYCzZeSOovG85WGL8Ol24sJ3Dcw1B0bK8nXNvjgDWmYAs27/TFsOt5InQPsfx4EGrs5klNifi6TdsNV23aYdAb+sFqE+tmVDVZH+411rufOMqxO47tDCfO4VGve9TttUHoPwNeRJ/2tvW3jwnAs9Msg9Bjsyt6VoBVhk6rpjfCpkmwxJgpY7BTSRjviRrhASQrGR0nwQ6F5wsZCxuAtUQOBbHsw0SM3bcygBlsASUS0ySrIhvHNUIhSqLtsO95APvV+zs2m8HQl3H/N6B1tkMBfh1LmM/KKY0yfHNZ0Rd8etgZul546HHuDjwwhekw5N1uZ9gbDqmZLZTiM/HpeumlAE+RPiMPl/8RCCM4yJ4YoMUfq0GbOiAaOxb+emy1TcMvw4dFLcbZ98eXzOtDxRjPCrrOZ2tCiO3r8bYOtiZ8AQWT3NqjLBsEJ6cvRtfnE7hydfqv69Mx/EJaG+2CUQzWGqBZAqtgC3PIq/lqA4gnlIhAHJh4vzVUv61gXjVQ6r904cwMIoUZZvUtM+qkVw2/0pV8/WSNPZNt0W4BAMCnDoRUsIwPynL2W0iAAmL8uZHkt2wO1aPInrfZqOoCarACUIJjcc54EOgGARIIC3BlYAZCYlLkCGakL5q6WIlyHcqV+f+8rhR0DuD803Yy8nMInGQTDS+srMWwaPQDPGvJNbmb1IRGIl0CkvRhFwSn/CTDHgwDKEF9CxOOqOMDgScux1URqwFrkJtXmpmyoPZ5oXbwu8sIwo9NW6tu3ArjfATidTQibZRqMhEJblKnAiebUZW6SsfXMG/vu3vf3fvujr67fvPKFM7mLkEfZxP6XMeAn+dJRslzA/pkZD1xwspBBG+MIltYXhqI9MObCTj2b1AmwnjxIcU3Fp4QH+lUvvleQqUPfX2K8KNSVkMXyCDJUe8ghEgkgiPie8UxCUqLqru5GtSlUwkGGm+BiBA1M7ZMCsZBZFkRx8gJVy0WJELF3+RQSkN85OARSukIiKsC7tdV+R5J7pHkPhvts9FfJhvtkeTed/e+++f03UeRZMUVeYvBSapYLHi21JZm7uNuOYMBq0c4lctV7+nV0QoSYxXGsprIwZq6ztQJ+77wAu4Fh91h6PqHLu/1nb4z9dy+Vc/1Nys/rpys6VM1fWs96jdkRHYLOK6IwbhUniRBs/1X4OOoEMMahp4KN4PMQaTvVtjR28SOr5Mc9gaEATtmD7QXr6/Oa0/BOMpNv7GTVK/M0EMahJT0WEZ8kOoJ38bdQ8c9dNynn3362UPHPXTc++7ed//X0NH7FHT0PgM6egwhVogQ6/eEjgHgDoRmISgF9uAXWabfYkphK/DLdB+N25tXJ0ug10CR7nATRU6ShL3i8bIES6rRiYxX4sLwBmMXODYrx8IAzmYQImN8UVMCukWrwtNAgEnBflgkF5L8GDcEdLOlPaKXfbTPlPZWrSJjPyqAQwoKUYK91wRsTOILPSHCP6BAfdAZBOon7HEabX1VP5hd4Y7Pccfs9IMvBPp81f/tbXtL4AyYzzBcjLWuH3hdQPfMeQxlhPiQ6vBVQdA9VN9D9X2636f7v0a630P1ve/ufffP6bufAdUNGnoYqsOAnaE6jG13WIWlXtDRhv83YidXMRyQebPEJ6werDA44QowJfP1CYwh+OGGI+ugfuLl4F4G+P60xv+anSKLYFh5UOEetATa+djmqWyXxwDj5I5OK+AphS1RB18y1R6GA+gDFnqBNsk1k2i6Os4RcS1lc0zEqg5EPEqZjuqA+pZQezBNpoUHB40Z0WVgMYUa4ht9sKdNZrOxP9jXdRZ9/Pq9aEIP7GWb+B5dDcYz4HRti7iFd6tPfdCr+3r1jQ9+rJIItvrdjcUucJjLvhc8g2pAv/3y7Ic3k+dshjCT3LxQiHCFxLoAHOUSTITC2Kh8EwQnUWbJkmI2J8ZHjXdt0G1YGMGG2dt4LAS7OTNCeA3x/QoCMokUJwmKAThr92MyvDHvOaU5qgdkrD/9oM/o2OyETnviQUQaY7ZI5R27Sct98dq+vpSJv5XUbE3NJmrq+RoXWrQ3+vAlfkSDxMIjRdL64sU1PbtGz6ZTjDZSXecBJWH4aL4h5Zda+2I+GvRspNfk4238hk4hNqcxHbKYmtP5yzPmz5NEiX8yhqaDbnCDJ0PEF7NFRx9t8gjb7dRYsvWStrQBERJ/5+AYsTYmPsWMTIAk0b0Rcsn3pFnw+fd0aud9Y890+QYSJ44MEl99Mc+4oI0L2joGKMO/zktoWODbuAeKA9oAjlf6p0hgGK3FPU1ra1Qn8gc0B1MDntAhKio90n8crQKc+cXoBo6uxkAYRkBdvTOGB6kMLUxODWGVrYB1CW7yGyWQE9fkpvmtHmhinvyj7Rd3PFp1TPAA8VNH6QciyR8n7v5OEW8faf6KkcZAXDQ3WtbUAnUj/97gtc0OHraY5wL+hbvkq4SmoVah6otQTJ1QGvGcPgSDXu3PpaDaPxX6KGiLmSN84IlQpqP7Q4VHhGZ0+CsDljlUazICetSdLlfm5DAaWKJe8W9VmHclEnNktc3e4NFoH9SCpRi+pQv3fk1MTVZ9R4KdlMoG0LVYFDF+rgPYLhaMg0l9wiICqfxCBy6ozGJRyiIh6FfNKr0YTQ230KaiJFuoixDbyhJPFVo7rgV6V6anDKJHLZozdKuNXImILBPHNWH7p2iDtdlzEdGXoiDqAgATtRVenU02KAKx2DzISLLZgZmkDnAsnu2EzWvz6baddsemcgE/Q5WoHMrXGvGXIl/7Tt+6Bd6vGumf94k/kysQ5B+k2JRCDgpddOjy7saql3cw5UgGeA5yDmzi3ft77FpgwfMRL0O1jiXxzbtVLUM1IIgRfwfbT+3X+X92Zb7w95yeu9RZp68ObWW57LbFy1WhjV8I+k1gfQ4c0xdadAOF+NE3dIulNmXjIQQWR1XZ+/IUtcwfyLPmB+wdIsl/AQAeX6M= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get an entitlement

+ + + + + +This API returns an entitlement by its ID. + +## Request + +

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[]
  • Array [
  • ]
    • 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.","example":true}}> `description` property.","example":true}}>
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-entitlements-potential-role.api.mdx b/docs/api/beta/get-entitlements-potential-role.api.mdx new file mode 100644 index 000000000..97540043c --- /dev/null +++ b/docs/api/beta/get-entitlements-potential-role.api.mdx @@ -0,0 +1,83 @@ +--- +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: eJztHGlv2zj2rxAaLKY1IvlI4hzAYpEm6SCDdprNMV0gDTC0RNtsZVIjSkm9gf/7vvdIXT4SN+3OTmf9pbUo8t0nRebB04lIeSa1Oou8Q28kslOVySwWE6Eyc64z+E/y+ELHwtvyMj4y3uGNd3Z0xnCIvZVKqpF3u+VFwoSpTBASwLkaS8MmIhvriKUiy1NlmKgBZkOdMs6SAj5LEZpUMEa/JgSXGWEMAAwAdcJTDgBFigQ8eBKxJDwbwysFL+DJTQY+tjwTjsWEe4cPXjZN6GWWIqGzLS8Vv+cyFcBtluZikXCxjAImEar4zCdJjOD2w+5BR/T3/P09zv0dER34/KAz8KODaHd7Z2e3tz0cALKldCZ1oX4dtUcLEoxWCvEr6P89F+m0YkCqMM4jcawnE62OwhDge/OUvdJAAVcsQpU5Qu7HYBAiZSEtZJxWNs3iXsYxG6AlEIqIgZkonXl1QQx5bEASJpsSK2BJE+ItiXUkCjktiHRgCfJmq7gyOiXrmufkEsbBhk0eA325QUaAC2YyriKeRsxMVcY/M7toIEgBN79us6PzM3ZZTDrWcSxChMjOS0O+fTHOssQcttuRuBMxemJguIwTLVUWgJTaMlJtnsh2gcwPSzh+5RA/IOlAl++ofPlBfVCXdoyBH5o8SZC5iLwOiR8CGH2Pr4dSxJE5ZK1WopM85qnMpq0WAkBPiMSQA0SGCBBScxZyimwLFSEonUbAAGvYWTX9G6iw8IpVGhzKeKkGX9P4n1yHlvh5Lb4uRtfTIwMUzEZ0nZpDhNBq8SSJZUgx/hfA1mqBts19y76sed+FGAaqNqGhyDkgzNyzD97RyQfvD9CrHg6NyBbU+o6GQVWZtsLIIXZY4UHMywJ2bXIex1NmEhFKEFAE4SUbs1YsJzJrMViW8JFUPBOwPtX5aExwnPwD8CEh/mAzeEmqnegUQyCKjyQeLBNyqZvOEpECVjESKayzQOzQdg8GMBhP8gmtc/4Nv1cKn4S1IPu34C0qnwzArfSw9CyQqE32343sertfIb0J/2x/E5RSlvC0UpqhztWiNM+GrIW+ARE1synQxk0yTMFa//KvdMZj/xhXt1DciVZGsLHgEHKtVePEJRoZc4Co8zjCrGqVg+FtWHoBRoyW9bAWuxcovJECGUYBZRFIxLgO2DCUTjgoGUhhxAgLIcOP+Z3AUk6kJCycLycJD7Mt5AbCViow4UOSAMSQy9FKjECsLQLyd+K8hTQRtXc8zoWVAs4GsnNTUPNd2NQTBUjNUmjlbHaL0KxKDS7odTr431wZkkO5JECGAbtwBTVnsTQZqvvJ0hopDrXCIQRdi+btjwbhPywSzNOUo+nKTExMbVwPPoKcsCRPUa6ZtFQ3M8kiAyciAwUA1QOdZ2SutRX1XAOeg61ILzzo7nf2+Z442BV90el04Vdf9Dr7/V6nH+5XTnWUJEENVtBdcLBaT8PwLc8g5QzyDFePIPInBmvtx/lDouZT1oIjR6iNR3h7mqtZwdZTuCgNP4FtUTKzOTBPYTmpntCwFpEpyLp8UNl9hbwp9FlD6k+hvWriYdXSOoZCdag7nApD2FPZpvS0aY/fVq5R1J7oSA6nEF9iiBQYo1IyorlC6Wl8R9UCptbTKQEGXDKiSVPKC0vz16JUqxzhVoN5FxlENrqxqpMMlmXCkqKdXSClVuhXdFhcS8n4G6tWWI7XQj6MNW+Io78b9Broz9S7dPTtaEBN6HT0OBHbu8E+EGF0nobY0a9l3mcnhabtunbNcoJlMWNvD0JE2N3pQ8zo9/p7w+3tPu92+mTbkG/lHfBxSbAgOa7rZZD/stwgKQUIFvGMly2GJS5gjP1KiRlEBOkzIaO3zfmxewwejQbFIq8U1LXhI3Eu4FfDeB9RWGInw7I5+3WKmtsMoXKCypPcuDXLxb1M+Us1vpI9MMP+k2EIAtUMJ+0sy+/HsUSTO01TkKrvcrwt1WxTQiUYG+hoijqQCuokGT0nr6/IbxHl52Nq1J4ynNdSCX+UcokUCiI5hIUMIN5J2gygksmCLAMazmtaNkgi6LJXPAJ+LX/HjhmUZcrDTwBrHYe6VhLWs2IJ7oMVBrwErdgTfNDvHPR2hv0dznv7O9293cHBkG9vdw52Dw4Q+0QYNBqzpCBqov5JKOjQQxbrEDTyb4EbntzYdGmRr19DEYw1HdfOLdl09LJMfIbKm7NXx+dsZ4/FXI1yGuejOSEo//pywaaBcwv4XSpHcmmBIBT2PDfeyenro+s3VzBycfrP69NL+IWwFvaCjxRYa4RmqSnvjPU9UewYuOcG+gEsvbG2bTmoLWCIK1OfKO2TmRoQZrE1BSsc9iUr6qDZMNWThiuR33zO2AsZiGALGg0YA3cPx2zADW492qDSwh3OJPPfOEm2XNv1MmBQBkhkEgIOdS0G1k+xY+FRZDeR7L4EuLKgHIuVL0RMGYqmLipRzkeYIqC8qSsFnQMoX6O2CLMciCM2615YWosj0ekHaLaSa1J3VRMaiRR3yyBZhLS7EuoUOjyITMCbzAxz4Yg2rCDwqGJeGbHqcZLC3VtLzEmm6V3Ic7OG353HEH58Yq18cSec89FehI1GpI1CTS4iuR0jWuxmleoqHN9uqW18d+O7G99d03fnX164XQ33lkqf7mLpc614DvJNKXkulD4pWY/SrJhkSzaryC2sQV2J9PP7K3DsT0LhfPE5wd2Zb1gf2VS+QPxRqQ/39aD4uFCk/koXSCDJ0XIwhEgkokOiu6LYFokkqu1FbK91OpBgoGpJiYgtKJvqnHEQWZor+ubGzRaLtDDqR1cKu69uFAGp4o18uym2qSQ3leQmG22y0V8mG20qyY3vbnz3+/TdRyvJkiryFlcnmXwy4enUWpp7T7uaDCZUn0xLlyNVzVcrCIyVNZbXrBy8Qa876A73QrET8Z2ov30w7IX9Ht/d6+51Bzu9Pa+e628qPy6drOlTNX1bPdr9WJHeQR2XKzAuk2kdNbf/cjyLNMSwhqGnrJtB5iDS26J23F22w3gGGknRSi8tihVbjbbe5gpIgJLUek1Z+WwqxE2FuMkymyzz18gymwpx47sb3/0+ffcLKkRXDa2uEGHC2hUizA06rKylXtNJrj+6UCRXcRTYE9o6DPOUNjyLKpDqCryA4dG1DowheA3h0Gvjx3Hfnsn33eUA034or0/M2uV3dB+nwru5Kwuzdu1DuV8eosDgtOXZAtYylqcxICyO4j0AENDzLOCJDIqzK0rf03m8AQh5SfzCT93WV3ECnfyzCALSUCrRCWzEJOBWX+58nVce+XsUcnHqZqpziJEEZouBwziDpGE8vsDV9EdDswMywAX+gK/rNJ59PS8W0ApelonvUWwwnwGlcywiC7eoLjAcOrYD+roGeo5tuDvK0VhubutzLrG8txQuzKxSFjYlvQWC3uG0HnsleAq9h92nf/Hz+6uXbIRFLQUVezJfSLolwtk5mBEFzaNizxoXUR6rTmsfNb4KoJOyYQxCYe646JkT1C+QTS4g/JPYcZGgiIOr1j8syhvrVhwO/aB8diJTe5bUHsd0LNoDtDdJwRev8fVcIn4ooPkWmk/Q8PZAgwor2pvQnjIJIVJYhzYkrWcjt/D8Gjxs1WAEoc7TgJJwdDS/5YSF1p5NRwOej/CadHxQ78cSMnZzWXFDzYzphPQZC8daG/EPxtB00FVuRjl42rPJukekPnmE3+vUSPItSl/6UH8SfW/AMZQ1JntClsofDZWhiqzb/kaahbjwGx3a/q3BMw3fQJrGmZEOv+AE9BzNiNBHhL6NE8bRb7MgGhaejAIeKA5YAziu9E+RwBFai40W1tLIT+DbtAbTRwikEhSTHNqHwyoIlheS8AXOLudAqMbyvfy6Bc/MwcJU2BBWsfEwL8FFemMNGXhObpbecusFs/KfjV/kuHau9J2Kp986Sq+IJH+euPs/inibSPNXjDSuoEZzI7Su86gb+StX0y3uFxq6xgP/wlvyVardoTOqbu7UASUxz9CqyavDsRS005AInmF9uIWWpSfkiUmq0f2LA9yjFOaA2xqoW/lAxgAvYFcVZk4OY4tP1Cs+m5zaHcQVjqFzFQF7j2fPQ1ALNn54ngDefdSuA7wEzZyjYtlJoWyGF4FzhSeHgex8wvDU7RMWEUkT5jZwQR+oRCELTaVfuarwYjQ1ZCGgFiidmHdD3MSG/rim+Cdwgd6N28EG0aMW3fWRipELEZNl4rxmaf8UbLA2fyziBFtPiLpQgIkahrdnVwsQAZhyZ6t1Omq7RaaNcwEItlDWfLaDbtDxqaWgg+4mg2a5BvxCQE8P5H3NBft5m32oNvr/C1f5XQrC3qGd4M4aMpbbfsf2qDfesh4Vlh7WL/nPtan4evFu/cpOFfqaMQgTkT084E4Otm4zHLZ39rAfAvWiz1WXvFZK6Zvfd18qpE8Cty+W37932xUeXdtfn/DN9fYvvt7+iGqqPyLwTHVs7qo/9676I1qp/jDAM7Xy/3XV/BFJllfxnynI7+ve+COCKK7FP1MOmxvf39+N70esobjWX1nDbbWj+4WVxIsLd7P8JaMPKqv+GNFScoqvmGpap6bMTmXx9GXWWiPpC//i0DOInC/hZrewxNo9SdLOsh/bausXjqOgCsoPID+dQlU9+w+wBlz0 +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-evaluate-reassignment-configuration.api.mdx b/docs/api/beta/get-evaluate-reassignment-configuration.api.mdx new file mode 100644 index 000000000..573c91397 --- /dev/null +++ b/docs/api/beta/get-evaluate-reassignment-configuration.api.mdx @@ -0,0 +1,87 @@ +--- +id: get-evaluate-reassignment-configuration +sidebar_label: Evaluate Reassignment Configuration +hide_title: true +hide_table_of_contents: true +api: eJztXFlz2zgS/isobtVOkrJk3YdfthRHTmnWOdaSNw9OKoZIUMKEArkEaUfr8n/f7gZ4WZKvSe3OZPWSWCTQ6BtftwDdOGEkYp7IUE0858hZiGR8xYOUJ+JMcK3lQq2ESo5D5ctFagY6B07CF9o5unA+hfE3Vh7ofDlwPKHdWEY09MjJyGmWLEVlLKtQZX4YM67Y5cSDdzJZX7IkZJ5IRLySSjDps2tcTSZipWkw0tORcKUvhceSdQQfl2EaeGwuWGwXEl6dTXzGGbAhvfvWl0g1VV5OW1pG2F/NyrjCAb5RQC4Iw29phJOkkokEAT12vZTuElZ201jLKxGsmS8Sd/k40XGIEt8TdjnjMZihUEMK/wdMhWwVxiiYToNEMw5/G35Rb2zFv4OyomTJQp9162y25EnGZBJzIACsRnF4BVJ5wDOtB7SiUGkBevfogS8VD0q6K3RgZ1iKgdQJEoxFksY4jhsZL7Ops3DiXeJ64F3JmkwAAjxF+4VlS3ZwaY6xNRnCSPGvVGg0QKYzNnnDrmUQoCOkeid76JmF7Ea0GelKhZ7IKYhVBCKA12u0LJAHz79xzrWIQYQETDZKkyVGg/TUUVwSseaWRTwSNhKcL7cQJRGP+Qq9WxM5ibEScSB04Ch4AZ8yuSEwDxwUUsYCYjSJUwG8gF+tuHN046AyYLROYqkWzu3d+EuVBPWUDInUxHe+igKc1nKHzUFj0B80eb/pefNGc9CcDxvDxrzrdhsdAQS3MmdEm+Haj2duIzeodGV8CZzWBGgeaWgxcGEXUgLYQItAuGhiyhL3OBIKB1TRHKPj4/F0+vVs/I/z8XQ2hTfH47PZ5GRyPJpNPrzHB+9G789Hp19no+nfp5i6Cr1sTgbt0ZvjXHJkf1PhFd5ycSpK564rtD4zfqsLFcPneF3oWHx3g1QD1RMZkKOUNe3zQG9TNY9jjjQoT27xjw1+x9kqEP20jFG8JzWfB4KBn0K2AfuYUCvJZv0ZZtbZxxCe43CKKZOd0LACk3EQXh+xGrucjk9PQKP/nIw/fX0zPh2/JTtcHkGygvCncCORIfY8sPeCaNPaYH6/FosrKa4rPOiKWrfTdzDaskxHGmk1Gvjf9n3qvj0CVnMx5GGfg/k8igLp0ovD3zQSuXm8OcL5b+DQGxExK2fleeityeEz3u5nzWZbaYQsp7qHIxHXrWRP2sqK7dQY35WRxJXBIlyty/uxxsewX/Msb7tbt8+KuQa9YbvVmPfmPb/d4c3ecN5r9gfzJh/0uqLX8zG0Skl5i1KrMpzaRFJWUrarzNeU30F0hhvizr1WqjvZ5a6Sn2BHT/iEDSCySGGFgiH+w9hDZkBlD2AD2GaupCt22ld4T7DwmyyQc1aul6G1oy7v+0n4ZFMVs0/icPXjWfKBaoWpbnPYGfCB3270eEf0+ZD3/IHf9Rrtls+7Q1FmChVLm9VG3FdUb330LtvZjmK3i7PxaDqdvH3/bvx+dgCvR+ezD+8g1xxvffN1PD0enVIqwkc7klR189lKsLQHnd0Ry+xEt8WAU4qbaSIieFx6XoB7k2Nokl2Y3IrADmWydLXisBsVc4rEdI3Q63F4DpimLWEzJWXQo9XlPbfJPbfR7AIGcYeNVttvDJoD5074X3y5pYygFnk+eJBJBOoQZlUjZ3D4hzO4GZUZjU633x00W90u0IC/ho1ex2+354Ohsy1wHrPypmfvchuEFxt8NfoQ0J1hp+m3/c7QbczbvO12hl7TbfaF3xD38vUYaZ7JV7vpDd1eu+l3u31YpsmH7S7nHAK9B+t5/na+niDNM/lq9Yee6DZaouu5HVhk0O0IAMo9v9t3u/3BDr6eIM0j+CL/Ryh0RkjokQFQxk55lYVFz4orvhAx1o9hvGDcgzqbQW7kQR7CBHHEPkb+f2NkF6b+A8fILe14nW0g/zgg/DqOY3D6GmwLtn0h/XInwQBvau1QUVp/Bu7PcWEVtXkigTA4Dj3xMDw6kUrUFhA2yKEgll3sS5guDqJHaggZkhmKonH1Ck4CTdSb7DXHysbId2yFQWAQcxdh8WPw2rlpJWRTAOHn3Zoty4q+4PNeY9jq+L0O561Bp9nvzoc+b7cbw+5wiKuvoAyGHKQfxPZvhRIxFBVBCOlJ/hsUgj5hW2e0+H3YvGoDovEI/c+oKYRjczEtvwy7PgeQW18ff2SdPgu4WqT0nC/uKEHVzrF5oNIgwHLadEgIxiDhD7FcSLWNlQxyvhmfjM5PEfvZVoRzgLQ22qwjyNfKQ7fEdO6zZXhtu1okwDXXeQ+lzl5Zqq9AIK50eaA0n/QaavcVljA8DRKYYVffMqNMmkB6JZRc0yJjL2Rd1A+glIRnK55AcTnn2JkLTQ/v1ch1RZTUTq0mX7Gl4J6IX9bZyPOoiOJB1lxY8TXWpNwrtTL9FEIZe3YJ1KwJgNMEiqaqLQpVVq1RRs0lo2BwAOcP+8nITVJgjsQsR2HuLZZFax/g2Wiuyt2spDRS6Vol3AUpeBCsQY0xlN+QmUA2CVWtTUdoLg2JR2Xj8oxVAf3IzTvDzBuo7PCdy1P9iLj7GED6qZFo+YsrYYNPY/lqe8pojcxMNiPZ2pYm3+08Z4HPfCkCbx+7+9jdx+4jY/fuy6yUt28J+jQ3oc+54inoN6bNcwP6xOQ9UNJng0wJYAx5gCWChUi/fppBYH8TVB6I7xE2o38gPjJb+Qbzo9we5vmcemeZsSq2QAZJj/arNchEwjsivguOnQIltjdXOwnjuQQHVVsgImTNmK3DlDrccaoUcsL1AfNCodUvCVtyyI+mwW8yIK6qvFoUSpXskeQeSe53o/1u9PPsRnskuY/dfez+OWP3XiRZ/VrI4qSi3QyeZt/Tl5sMBhSd5zzk8q5xGa0gMZZjLKeKHJx5qzlv+n1XdDze8Xrtod9yey3e7Tf7zXmn1XfKe/1FEcd5kFVjqmRvY0dSMX6pCjguVeBcOglDr9r+A/XGwse0Rt9pZ7gZdF4vdxhbw03sOAtD9g6/HM9Od1QwpCp0hDkNxq5wbJyNpa+fF5AXFYNUJYEvdCW5EkAlxuZ+IFeSgndG3xon8bo28hMQxQTKxsEuqeg8haZMQF+FwbrXXIKQwkfMBxQIwS4gO/9AdGpN9LuQPDtDiU9RYjb+7gqBgZ4j9+62/u4EmI8xR0yNgXc0ek21wxU4ABQEJmfluHOPz/f4fL/H7/f4n2OP3+PzfezuY/fPGbtPwOcWDe3G5zDg0fgcxtYbLMdSJ+hc/3WYTqFiOSD3ZqHrpjG1mzMMTrgCXMneXMEcgofUj5zD3cfw9eFNcbD+9jA7lH94U5xov3XwmA0CSMN7GgdAc5kkkT46PLwBk4Ipb+s8kvWMlAqv6264OpyDHrekKDxLYMIRB7DRx4ktQepkhFiin5ukSMSNSUhs9GgwDbWP76WMh8bR1uswhTRIZA7wQKP1OXoMLEZQcPyiaXSdfGxDPpDrPA5uf78shtAOWbap797VYDwDTu+IiCJ8Ka5mTBGdm9U3LmgUOw5WdK2NxT7gsBZ7LXgMpYP5kuPFr59mL9kCMSnlhFQjHBYSiwiIqo/gIpTzRlnDHyfRNhSH6WJJjI8qX6lgjDE/AIHZZzUVgl1kB1/fw2ZwBtmbVIqTBCUMnPXlRWYdT1yJAPfJeqFJdDzpqUPQ0CGvzHtJeyIVD1LBnytzXP+zqrE3ElMVHbDHMVZEqgXZRZTJxUtyPZeJv2TUaoZajajpl3e4MKq9cM0RHRcCHUnwQJO2nr24oVcr0cNKC54g1bs8oCYsH9UvwtzMas/mo0KvhvSqfHxWn+jMfXUaM/ktO4k/Ye4yDLX4G2PoOhgGF4sUoujZbNFB/xpFRK3VKLFUM0vWZA3gI/F3CoGhjDPxOW7fhF5CvDTmmZC8JMtCzF/SAcPLisz0+AJ2WRzpha5+Ns+4YA0XrJkcoC3/ZhNDx4LYRhkoDxgHOC7sT5nAMlrKe4bW1qxO5A9pDm4NLrBKVHR0ZD4cFQnO/sXoBY7Ox0AadrK7P9RXCgJmaeFOVlFW1je4q8FNfoMQNtA7ejP85n0r3FT/aPKixKOivfJBBesfnaV3ZJI/Tt79H2W8fab5GTONxcPobrSsLRzKTv7a4rXNdp+mG17wL7ylWCXoDYUNlWqV6zlIKAp4gl5NUe0upaBGQSR4gtjvAD0rXFEkQk2P4S+0IbQAXI7dajpkPpeBxLvBs2JlTgFjgCXaFT/rlKoVXMtdQuEp6uwT1G7KBbNg3YaHMeDdb6Et4KZgmY9oWPYmMzaArtUqVXi5CNhOV4yDSz3gEZ7UbmoSF1QGSmS6CAn65bOyKEZXQxHqVMHEK/3Bn9qbW4XhH1gL7K5tAxpUj1a0F0ELQc6EOZyP46qw/SHa4G21pQgiulUHbOHln2KFd5PZBkUgpjTIBRV6GC8O7SR9iGOBCJZHxn3a9Wa9UaNyAZ5HoU6g1i0Rf9z1xYpL3hRt+P0vCOx/QeBn+QUBC22wJj2MsOGKAZOaGtm0Li6ce1oXQOGo8qsA+U8KwIvSjXwoiJcQhUjt5gY7eFjP3+Jjc8Mcmxr2fndxk3x3/P3JL4hvVfo3gV2yLTfsbUvMoWvjWTvjiRp7cWav6b9kW39+YStHWXderctcZJyWzI4tm2fxsvOXCZ7BT8nbbr/AaNMIJj2ZAaZVXJq68WUqKjhv370d4wbEd5QA9g+6Anr7H3H1kbU= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Query Parameters

+ +Evaluated Reassignment Configuration + +
Schema
  • Array [
    • lookupTrail object[]
    + +List of Reassignments found by looking up the next `TargetIdentity` in a ReassignmentConfiguration + +
  • Array [
  • ]
  • ]
 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-excluded-entitlements-potential-role.api.mdx b/docs/api/beta/get-excluded-entitlements-potential-role.api.mdx new file mode 100644 index 000000000..4d8a6b56d --- /dev/null +++ b/docs/api/beta/get-excluded-entitlements-potential-role.api.mdx @@ -0,0 +1,83 @@ +--- +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: eJztHGlv20b2rwxYLJoIJnXYlg9gsXBsp3CRNF4fzQKOgY7IkTQtNcNySNtaQ/9933szvHTYipPtNl19aSxy5t3n8E0fPZ2IlGdSq7PIO/RGIjt9COM8EtGpymQWi4lQmTnXGfwjeXyhY+FteRkfGe/wxjs7OmP4iL2XSqqRd7vlRcKEqUwQIsC7GkvDJiIb64ilIstTZZhwCJioYWBDnTLOkgIRSxGsVPCM/poQAmaEMQA5ABoSnnKALFKk5NGTiC7h2RheKXgBv9xiYGzLM+FYTLh3+Ohl04ReZilSPNvyUvF7LlMB7GdpLhY5EMsoYBKhigc+SWIEtx92Dzqiv+fv73Hu74jowOcHnYEfHUS72zs7u73t4QCQLaUzqUv3y6g9WpBgtFKIX0D/77lIpzVB65T0ME/NJTwHtZs8BgXnBnFnIE6TcRXxNGJmqjL+wOymgSBSb37eZkfnZ+yyWHSs41iECJGdlyq/fTXOssQcttuRuBMxGnFguIwTLVUWhHrSlpFq80S2C2R+WMLxK9P5DkkHunxH5etP6pO6tM8YmK7JkwSZi8g+kfghgNH3+HooRRyZQ9ZqJTrJY57KbNpqNaRavIA3Xl11Qx4b0J3JprQMYE9oXxLrSBSaXWkEq9QwlPFSNbyl539yRVji51Xxtni6njIYoGA2ounUHCKEVosnSSxDinE/AbZWC1Rm7lv2ZS0GXYhhoGoLGpqcA8LMPfvkHZ188v4Averh0IhsQa0f6DGoKtNWGHkcOyWDi2cBuzY5j+MpM4kIJQgoYvcyG7NWLCcyazHYlvCRVDwTsD/V+WhMcJz8A3AEIf5gM3hNqp3oFGM/io8kHiwTcqmbzhKRAlYxEinss0Dso+0ePMAgOMkntC8SQw68wt8rhU/CWpD9e/AWlU8G4FZ6WHoWSNQmuW9Gdr3dL5DehD/YvwlKKUv4tVKaoc7VojTPhqyFvtFiMgMbBTO2gZMMU7DWv/wrnfHYP8bdLRR3opURbCx4BBogq8aFSzQy5gBR53HEBsIpB8PbsPQCjBgt62Etdi9QeCMFMowCSgVShbgP2DCUEzgoGUhhxAgLuWJjfiewchEpCQvXy0nCw2wLuYGwlQrQIQQYLHmUztBKjECsLQLyd+K8hTQRtXc8zoWVAq4GsnNTUPNN2NSKKDfQUIJw5dUshXbOZrcIzarU4IZep4P/zNUSeRgKATIM2IUrJDmLpclQ3euXlAZpD7XCZ4ikFtfbvxrE9LhIOk9TjkYsMzExted68CtIDGvRFCWcSUt/M6cssnIiMlAF0D/QeUaGW9tRzzrgQ1iU98KD7n5nn++Jg13RF51OF/7qi15nv9/r9MP9yr2OkiSowQq6C65Wq+oZvuUZJJ9BnuHuEeSAxGCR+TR/SNR88lpw6Qj18gRvz3M1K9h6Dhcl5GewLUpmNgfmOSwn1S+0rEVkCvIvH1QeUCFvCn3WkPpzaK+aeFi1tY6hUB3qDpfCI2wmbFt22rTHryvXKGpPdCSHU4g0McQMjFYpGdFcyfQ8vqNqA1Pr6ZQAAy4Z0aIpZYilmWxRqlW2cLvBvItcAmG7LvSyhQqW5cSSop1dIKVqBmp0WFxLyfgbq3ZYjtdCPow1b4ijvxv0GujP1Id09PVoQE3odPQ0Edu7wT4QYXSehtjKrmXeZyeFpu2+ds1ygmUxY28PQkTY3elDzOj3+nvD7e0+73b6ZNuQeeUd8HFJsCBNrutlkAmz3CApBQgW8YyXzYYlLmCM/UwpGkQEiTQho4clkKyP3c/gyWhQbPJKQV0bPhLnAv5qGO8TCkvsYtg2Z79OUXOnAFRYUKGSG7dnubiXKX+pxleyB2bYfzYMQaCa4aKdZZn+OJZocqdpClL1Xba3RZttT6gYYwMdTVEHUkHFJKOX5PUV+S2i/HxMLdtzhvNWKuGPUi6RQkEkh7CRAcQ7GWHFSMWTBVkGNFzXtGyQRNBlb3gE/Fr+jh0zKMuUh78BrHUc6lpJ2M+KLXgAVBjwErRiT/BBv3PQ2xn2dzjv7e9093YHB0O+vd052D04QOwTYdBozJKCqIn6B6GgVw9ZrEPQyL8FHvlxY9OlRb5+DUUw1nRcu7Zk09HLMvEANThnb47P2c4ei7ka5fScj+aEoPzrywWbBs4t4A+pHMmlBYJQ2P3ceCenb4+u313Bk4vTf16fXsJfCGvhNPRIgbVGaJaa8s5Y3xPFjoF7bqAzwCIcq9yWg9oChrgy9YXS/jJTA8JkrpyGHQ77kh110GyY6knDlchvHjL2SgYi2IKWA56Bu4djNuDQezBtg0rrCErwJPPfOUm2XAP2OmBQBkhkEgIO9S8G9k+xd+FRZI+T7AkFuLKgHIuVL0RMGYqmLipRzkeYIqC8qysFnQMoX6O2CLMciCM2615YWosj0ekHaLaSa1J3VRMaiRTPzSBZhHTOEuoUej2ITMCbzAxz4YiOriDwqGJdGbHqcZLC3XtLzEmm6V3Ic7OG353HEH58Yq18cSec89GphI1GpI1CTS4iubMj2uxWleoqHN8erm18d+O7G99d03fnX1648w33lkqf7mLpc614DvJNKXkulD4pWY/SrFhkSzaryC2sQV2J9OPHK3Ds34TC9eIhwXOar1gf2VS+QPxRqQ/3HaH4zFCk/koXSCDJ0XIwhEgkokOiu6LYFokkqu1FbG91OpBgoGpJiYgtKJvqnHEQWZor+urFzRaLtDDqe1cKc/AIY2wEpIo38u3x2KaS3FSSm2y0yUZ/mWy0qSQ3vrvx3W/Td5+sJEuqyFtcnWTyyYSnU2tp7j2dajJYUH08LV2OVDVfrSAwVtZYXrNy8Aa97qA73AvFTsR3ov72wbAX9nt8d6+71x3s9Pa8eq6/qfy4dLKmT9X0bfVoz2NFegd1XK7AuEymddQ8/stxtGiIYQ1DT1k3g8xBpLdF7bi77ITxDDSSopVeWhQrjhptvc0VkAAlqfWasvLZVIibCnGTZTZZ5q+RZTYV4sZ3N777bfruZ1SIrhpaXSHCgrUrRFgbdFhZS72lma4/ulAkV3EUkHkzHYZ5SgeeRRVIdQVeQfDoggPGEJy/P/Ta+HHct1PxvpuKN+3H8t7ArF1+R/dpeKz9ODerP2sXo2d+ffQMUNjq1XKVpzFgKybyHgECKHkW8EQGxeCK0vc0ljcACS8JXvid2zoqLqABQIsgIPWkEj3AhksCbpXlxuy8cvLvScjFyM1U5xAgCcwWA29x1kiPcXaBq+n3hlYHZH0L/AFf12k8+3JeLKAVvCwT35PYYD0DSudYRBZuUV1gNTSzA/q6BnqObaw7ytFSbm7ray6xtrcULqys8hV2JL0Fgj7gsh57I3gKjYc9pH/148er12yEFS1FFDugLyS2IOCT52BGFDGPigNr3ERJrBraPmp8EkAPZcMYhMLc1OiZE9RPkEouIPaT2HGToHCDu9afGeWNfStmRD8pn53I1I6U2mFMx6Kdo71JCr54ja+XEvFdAc230HyChpcIGlRY0d6EdsQkhDBhvdmQtF6M3MLza/CwT4MnCHWeBpSEo6P5IScstPZiOhrwfITXpOOT+jiWkK6b24oLWmZMg9JnLBxrbcQ/GEPTQVe5GeXgaS8m6x6R+uQRfq9TI8m3KH3pQ/FJ9L0Dx1DWmOx4LNU+GspCFVm3/YU0C3HhF5rd/qXBMz2+gRyNKyMdfsYg9BzNiNBHhL6NE8bRb1MgGhaORQEPFAesARxX+qdI4AitxUYLa2nkJ/Bt2oPpIwRSCYpJDu2PwyoIur8YvcDV5RoI1Vi7l5+24DdzsDAPNoRVnDrMS3CR3lhD+p2Tm6W3PHfBlPxn4xc5rg2VflDx9GtH6RWR5M8Td/9HEW8Taf6KkcZV02huhNa1HXUjf+NqusXDQkO3eeC/8JZ8lQp3aIuqCzx1QEnMM7Rq8upwLAUdMySCZ1gfbqFl6Ql5YpJqdP9ienuUwhpwWwN1Kx/IGOAF7KrCzMlhbPGJesXfJqdeB3GFY2hbRcA+4uB5CGrBrg+HCeDdr9q1f5egmXNULDsplA1F12SSKxwbBrLzCcOR22csIpImzG3ggiZQiUIWmkq/clfhxWhqyEJA/U86MR+GeIINzXFN8c/gAr0bd3wNokctursjFSMXIibLxHXN0v452GBt/ljECfadEHWhABM1DO/PrhYgAjDlBqt1Omq7TaaNawEItlDWfLaDbtDxqaWgKXeTQadcA34hoKEH8r7K/fJ5432sjvv/m1faXVLCbqKd4EEbsprbDsi2rDfespYVth7WL7vPda34evGO+fLGFdqcMcgWMT0+4qkOdnIzfGxv8mF7BNpGF6yufq2U1f/pBfClevxN4IFLdVXeHap4dKt+fZFuLnO/9DL3E1qpbs6/UCv/X3exn5BkeVf9hYL8ti5WPyGI4t74C+WwuRL97V2JfsIainvvlTXcVmedn5lUX124q9evGX1nWPU/p1lKTvFxT03r1JTZqSwiPs9aayR95v+B5gVEzpcys1vYYu2eJGlX2W9Qtf0LUxqogvK7wA+nUG/O/gNFsLLW +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-file-from-s-3.api.mdx b/docs/api/beta/get-file-from-s-3.api.mdx new file mode 100644 index 000000000..b6dd6d5de --- /dev/null +++ b/docs/api/beta/get-file-from-s-3.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-file-from-s-3 +sidebar_label: Download definition file by fileId. +hide_title: true +hide_table_of_contents: true +api: eJztXW1v2zgS/iuE7sO1QGTntdn1l0XaJIsUzbaIExSHJEBpaWyxlUgdSSXxBfnvN0NKsWwnsevuXrM5BkWqUORwZjjPkI9eqNvI8pGJeufRu8pYVbBDpQsTXa5FqgTNrVDyKI160QjsocjhUKuivxWtRSXXvAALmtreRhL/wFpDbLwPQyGFa7iPFYXE8pLbDI9TMIkWJZ3DwsOZyhfyQlIZS+8LmROh4d+V0IBqWF3BWgQ3vChz6m+9/okf+NX8oACTZFDwqHcb2XFJ7YzVQo7wzE08UnGt/Kw+0d3C8xPD0TeLzHVVyMi+652ZEhIxHNOhzYBl3GSQMhLI1NAVVWWueIqFJJ5dA+MamAZsDlfYrLOEb7Y2/lh/v3uy+XZn9/iXf/2+u/V+97hTOtuX9Iq3bNYXdeklaWBKJQ0YkrSJ/sb/pi0/AVtpaRj3dtiMWyYMGjIEjaozq9hgzLwLGZcp48aoRHCL566FzZwvHgitREkL0lKHvCxzkbhw7X411OvtE/aRLI7tooGQXI+jO7ROFHwE3a8ljFZtS1797qZtxVViwcZYHXjxvZJI1vZDzt+TDL2s9MSTFDJgLFNJUpH/V/CkGnyFxFIa0JQmrPCjn4LlIn+nUlgUVfuTmqh4AcagB02rFdeajwlPFgpfLqwL6wMy5tg3oCgii4zFqOE6ZXufjmprm6hktWxGcgkwT1uQq4TnMO/FD6686c/5TVrmS6M26kDGZ/1JNw8aXzdDw313H7UYCflYp/4sy1SeGlYqY8QANbniOQ4iJYpMXTulvCx2zQ0zkKNxbmQnmu0fHO6dfThdSrdaI9TQwo2d1+wUSxtn8MRWPGdUsclbfghqz08pcZphK/zH66hcoA3142DiCkuefCOBOBthLFeDTqKKrsE4KpWQtsttzg3W8wfdaxjMZq3jJs6wHGPGVmYmVlEMjEC3EYZFb7Zn1OpP2pKLNOqFutM8+XTUnzY192vELkg6AWYBZgFmfxbMHpufA8oCygLKfhxl37WUDaALoAug+1HQeda3sQzr45XNlBb/cfgM3C8gNyD3OSxKA/cLMAswC9wvoCyg7G+MssD9AugC6H4C99tahvtVBjTDOC0Ejj/GdaB/AbwBvM9hXRroX4BZgFmgfwFlAWV/Y5QF+hdAF0D3E+jf9jL0j2DApLJsqCoZOF9AbEBs4HwBZgFmLxpmgfMFlAWUBc4XQBdA90JA5zjf5q8PuFcpVnA5bt7tM99F8tpAWQYhyyFjGtvT+k7Q3PTXjgbvaZbQae3eHZ2JzCO0TEuMoT7oK9DsYInICAkkJJCfm0CmYT9j3j3QGyObt3SbVqySAkuYSDEOxFC4pDMx89ckXd+C4S/r8IZvb+7A4M1gY2OQDgbrO7tJOtheZHY70axuvMtQO4+8hiwa1BqPWj9m4VGEkBP+f3PCM1hUhMtSAWYBZuGyVEBZQNkLQFm4LBVAF0D3P78stfPYk+g3LdInEhd69CgCv0J7+cBFXeB9AbUBtYH3BZgFmL1YmAXeF1AWUBZ4XwBdAN0LAZ3DnQGMJmHHbhvwM2R574jN3di9yma0rbgpe6SL6RVckvGXtGf0TUw390cYbPVtznig0nHTzVs8jma3z95X15J2w27vDu62k262jk47bqSQSbp3nJ0+3wD1erK3tchFYtMrKVeAzVS95zkBjDbz7kVdsiKedG66t7NbUt91SREsdztZ30XkHLrT6XWpdI5iMmtL0+t2b1FPLu1dh5ei4+/p2rFU1y4mBphd5hzQhB4FKFVwycJ30HFmaEF82icbJ9zH/ZBXOQXCfaA9KZmcQjAYq0ozL2aNcg+m1jwf+2JUseRy/E/jancoFtbm7EO7znR+9+O2eEGP2PKQ+57sDesz1HTGRDLhchLLfZovfO9zET2ZQ2hHtc25zj5StU32FrgGFK++gWSv3n8+fc0wAGlHfUhZZeiGPmASwCqcfcIQUXSNZC9JEOF1I8xANtOqGvmXOPam9m9zj84MczSYXcg+ADs/qp3wB6bTk4P+qXMpNaJiPy9evmpGJ4UryGne6Ew8SYEnUtlFD3X5VLvXtPk6K5TGCUT6xIKlnQsZs32hMVO7PQWoTm0iWcfZednYxVt2rarEPxppsZcWO2nm9YwW3rXnSS5ogks0OLfw3Dhvrdy5lxe35MUjjYETk9RZHcgTtR7Tu+4lzaitrMeUPJfWpvW4kJ8zkWRsuhnzKY2ZTFV5yo5Ykill4DfGKHQIBuejClG0slrX1GnsEBFvrrdUin2XsYgrA06/DwgM6YOJD1Rl/fyvMIfL1EPyixtZxPwX9zGAL1M2u+JzXE9QzVQlZmWdqcOYOox9DjC1/n4RSIFF0yja4PKAD4B3k/F3maBWtJX3vKwHs7oT33VtaGpIUFUnBWdI/0dvkuDqI+ZOUO37OpiGaXnZIIrh36yW5ZbBbWc1q4NZD87rmytcL834zevbtCUtnp29ZPHeZOH/UebjPztLP5JJnk/e/UkZL2Sal5hp6kU9hVubtLaD/G29XpvD1Bk9GpwB/sazDqvuiT/kV5NXUduCypxbimqH6iQT6FSkvSVwS2u/NYosVTgkIscl+CNfdIJGyOtRMKrMcz4QOcrrsNNJz9wBxi8s3edk8G9TOcJMfSUZlyPosM9I9GSCw0L0GoeHzn3FsXSK9nFkPtHAsv1msHHRVRQVLvbHhMuqYBxDakFEpMIklU9ciZISGl8ot/S7b9WgmEKNTHBEH5A1fRz2/X2z1sAv6AvHvXn8G11Po3h/zaIx5ARyF5lUb3rZvkg2RlucQV468o9qSQOtHo6PTuckojBp0K4EOkqPunUj06W6KITokQ+frc5GZz12dAHLS2UsMsa2+ksRwKmQvJ8FaPnexXjz1wQqTyc8sTuPZokdSuk98LUh6sOd8p8+QrqQoY4k4PZ2wA0Q27mjYqSYmujw5YTIOAKIPqRjZJZDRDXM6Xp/GzR6dVJ/1ek1W/ojWQ9a2lyMkuMW0cVDz4vnjCQat5qWf8m3rVYxqfkuFdbMAOXr1nUAolelbTWbu9s8Rf9/P6Bo5o+sJ+oDHGbMmP8FuJPN3g== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 definition file by fileId.' (get-file-from-s-3)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Download definition file by fileId.

+ + + + + +Download definition file by fileId. + +## Request + +

Path Parameters

+ +Returns a file that is referred to by fileID and associated with the formDefinitionID + +
Schema
    + +string + +
Schema
    + +string + +
Schema
    + +string + +
Schema
    + +string + +
+ +An error with the request occurred + +
Schema
    messages object[]
  • Array [
  • ]
Schema
    messages object[]
  • Array [
  • ]
Schema
    messages object[]
  • Array [
  • ]
Schema
    messages object[]
  • Array [
  • ]
+ +An error with the authorization occurred + +
Schema
    messages object[]
  • Array [
  • ]
Schema
    messages object[]
  • Array [
  • ]
Schema
    messages object[]
  • Array [
  • ]
Schema
    messages object[]
  • Array [
  • ]
+ +An error with the user permissions occurred + +
Schema
    messages object[]
  • Array [
  • ]
Schema
    messages object[]
  • Array [
  • ]
Schema
    messages object[]
  • Array [
  • ]
Schema
    messages object[]
  • Array [
  • ]
+ +An error with the item not found + +
Schema
    messages object[]
  • Array [
  • ]
Schema
    messages object[]
  • Array [
  • ]
Schema
    messages object[]
  • Array [
  • ]
Schema
    messages object[]
  • Array [
  • ]
+ +Too many requests + +
Schema
    messages object[]
  • Array [
  • ]
+ +An internal server error occurred + +
Schema
    messages object[]
  • Array [
  • ]
Schema
    messages object[]
  • Array [
  • ]
Schema
    messages object[]
  • Array [
  • ]
Schema
    messages object[]
  • Array [
  • ]
+ +An external service is not available + +
Schema
    messages object[]
  • Array [
  • ]
Schema
    messages object[]
  • Array [
  • ]
Schema
    messages object[]
  • Array [
  • ]
Schema
    messages object[]
  • Array [
  • ]
\ No newline at end of file diff --git a/docs/api/beta/get-form-definition-by-key.api.mdx b/docs/api/beta/get-form-definition-by-key.api.mdx new file mode 100644 index 000000000..c1ddfbb6a --- /dev/null +++ b/docs/api/beta/get-form-definition-by-key.api.mdx @@ -0,0 +1,95 @@ +--- +id: get-form-definition-by-key +sidebar_label: Return a form definition. +hide_title: true +hide_table_of_contents: true +api: eJztHGtz27jxr2DYD5fMSPIjiZPzl44s04l6suVI8rmtnUkgEpZwoUCFIOOoHv/37uLBlyiJTuzm2iofYopY7Av7wAIg7pyYTqRzeOV0EhmHM3ISRjPpfGg4PpNexOcxD4Vz6JzTiM5YzCLy6e4GQI7ZDRccG7vH95+InIZJ4JMZjb0poQQhiJ+CkO5xy2k44ZxFVHXxAeOExScFREeL39gCwOaWFLJ15wj4AeBlogDIkbE5jadOmduTJfoAErEvCY8Y0I6jhDUc6U3ZjDqHd068mCMJGUdcTADyW3MSNg3dkzLd+4bDvtHZPMDWXfOvWfGf/bcR4QfkTc5DIZlEdvahD/wpijRgcRIJuaxcQO+FImYixk50Pg+4p7S884fEnnc5QecRjkHMNR3uL5O5EPxLwsgk4T7hPiDlNwtQComnrEwYh/TBmnioqnVTmcszeEvCm81cnS5U+wbCiA6JFYiUaZZs6hdJcu2VVPMAGzg4zkECI+GtYNHygGkMVYz1scMImslXGiSsdQ3qc89G3dE/SKG5q4Y0RjdjIpmh31tA9PlMhPTtCr6xdxP5yMGuJJWXFJtQxDXGZ+yOQ7DJjTEoXKnl0c0ODe0+BQnHfzAvtiBz6n2mE3w/4fE0Gbe8cLYjKQ/mIRfxjpw3kTW544czytUg8zhg+UFBWRPJ/KPFsrw9LmMUUdOUJJGrXI1cTplgX0EjlMiFjNkMgJmNBg3Vp33eJRGj4OygqSQmcZihkiz6yj2G7yLmhZEPTTRW7QYdl8RLogg0HywMIzxGXXNolQ+xxQslbc4YybW47A9+O+n1L0kR4DKMPt8E4e21GPYvBh231DwMk8hjOVu1aOCV7lA02lzzRqP9QY5+2KTTUcwP+X+PbWuVOBluGkW07OsZEGLqinkSr3YCZaccYSSxqRrt1QObjpmx9CYXMqYCLFnLssZA640GIM28RFF/kjForPGXXMpD+oUoPhwNumdvyQqwoSVn/UODF53CvKvhEjWJVZl+QMcsWJGnN6lYvdrboMSeIlArRyt869Jzm6DTBYz4C8DOPSI9GtBIK5084y0IWaCWMYsaRDPTID7YYIOw2Gs916HTo4KMGZlTCUYONPPRFiWG8AxvCUzNfKVHGpAgnHDvIROBJ/Hc0tBucOGT1HGNF7sBm4H3yNWOLBhENl9rghnoB/rpSa5vzlufyDUNodFKD3UzgCyljdy/j0ipdcS+xdDSf/u25y61hROwOd2vPXDbVX3bEOuuxbvuMcyoyu3vuA+KuBbn7/pnS8jPp6EA3O5pu9srt7lgBAGEErfndpY4HoLwHvB83B4tIT0Gm8d+nVG3v8TOELqBhq5Fp9+7OD0blts7YZDMhMwFJxQcfmrt4INRBDxqieFBCQd/lSCY5RXT8ID8qd+KGXgyZIuxzpBYN+Q5FnHswT9v+ERVTr511PO8fZZDjtNRPXL5JyV/Z8MgeDEUsTHScVb5sGFHY6uKxlv7qmNfqlz6zCom1yPmTQWUwgGB5mLk8LPhWW8suCAB+MHnua9q6oqwN2Qq6uXY+z0FJyrmFYhf3eXQ6ZDjDNz3F92Bq5cCHj/iL7Elgecnyi6GVo2skiYSk1g6NlNW6LhTzqJZDjY5nAZQtsxCn98ssjxMpXqGiofPuUolEjM1iyjYFky7b0G+cpVTXnWZR0xiV7Puksvn2K2YyqIkYH21yBVGa4QYAFgPpaCBhS5M+tpnx2QTcFv416I/2AjXj3IRGBDDr/6gGDT1242zw0fnKm8Qg7zmwCBQk2umGKp5zZxCqjKtOqGr+Q/TloFCZwU4zOfQKqQKWcxvkW4MJhIEOM9jYCqq+o7YDYMqWdfSNDepJc/GC/OEQj0nYWTb7UwGIeJ8WHqOCzVn5xejosaGKftq6gVxt+eeumcroazT5RZ1ECnmUd2xOOD2ZZ2lncdkLj/gWTsOtx6vitiq3pMm4aZoTnuhK69jq5GD18PM9ZCL8tKhHjIcTM9j87hF3oW3uNLSeBBRI2XjWuTolkjS4uCrVyI1DrU0AwMBtCEmSRMNvi9vmWWKe7vmvjEcdcIZoOYyFJURyX1PaoC7XxIaSEJGU1xMSkGI5cG8M75ndEQFVPk0mkAWxbKJIQ4eL4AozEJqED0L48egCyEho9zp16EMIDEkwHWEJaORWo/LG2MIrxm5nTIVUXiMOUUjQiir8rP+6GM9PkADlhWMJnW6dIUXJGAOD2QdHALYZVrdVCysHymepWG6HgfAtGUCp5W1zGs2jxeaRr0OaBq6z/CyDvwQ7CGWlzgpIJ0p8z7LdJSoWQiAPwijZw5UhKpRJmPTatf20OH1q5bWcKpW1DaVrAlzCgnsfLVDXY9DkChjEvRWq5Mr/A1CMYB4fJHqcYeDZBjM5S/3PfxQlWCnj0/KGeChe2Z+qQf31PxSD8NL80s9uPYXPBSz3/s6iW8b8bYRbxvxthHvySNeftqWr4CUhVVXMAUav1s4NcvNtgyqgfQivnECvd7NpVILjXEhXItrkXzsdYejtZhUQVbGJoiq+VGRRqWpu1TUEylGNW9fZm1lwdVaUXqkCM2cvB7KtTXaGj2gBq7FUb/fc9tnK2COwjBgVCxv1DScnKJVeiuWbQ3HNBj8P7iz85+0ia1R1DaKfAhIm9MYsOz/RxS3nCB1YZhKOxRLRVdMIMGzitpQdXiC1b+ClBvW/wZqeQe3Xm5u8OTD6pUeA7Bmic5VEGQehX7igV5gqGi2TLe8SKcxVkfWkVkP0jBoCNBRWQJkEK3vFDPYTMQIwzGiZr8LAMCU9ALlOAi9zy212J6b1bkp8XfcZ4Qcc0nHoAuSW2JGV3vXv6zqNJyGt4S4oqrPcXfYPupV0jJUVpJzz1b11KRWkTTr1lUdB3oH/1r0z3F1v92rAurP9UoqCHxxdNodfTx1h8P220qEw2Q84/EpkxKsM+0AWbd70u201Q7Cyl6QcfmNORWHGw6jj8fuSfuiN/r4e7t3UU2OxcfshiZBrPylHC74RISRdsJ5Es1Dqd3PRHccc4zt79RRFDMwGNbPzINRHC7GGvUgeEEH2Yu8jGoLrMR+MSkY2htTwtYu/3/ssrD/mYW/wvZnMRC2ozGPIxotyIzObbmGSVuFVuiS6JO8ZJzPRRnulrOcXoph2M9J0bOnR8pWWxnpEegXCLPYqXSww/NgHDBsD9gs/Mpym/s1sGtAwLziwMGbvb3dg4P9Xw9evNg7eHPwGlNoxVbuE2ZWrYANudU1KfVp9vdSXmrs8OV29NDU1DmuisMeHd1gV8vxpE3VGUhySyWxSPKjvr+7/6K5+7q5tz/a3z3ce3n46nXr9cuXbw7+6eidRRrj2jn0a8Z8xjYsnRtukGO1ncirWD41LZbngMJsZS3jKa6n49wy9eTnhgbmsDoQQlIvq46rtwVhUQRTIlVk613YLzDdh0mdp86ZoiZqn1vfFEogOgWd0GebDvMfZ5A4vjpo546zpqaczjWtBlwUxkR5O+p4EtGnka9O3mpp7Tl+YnDronxjMIS5Ig0q5qM99d7SM+dziX5bsCQmmhfDTUfodDc8raee+hGf8IpDdL1cK5mGgS8JJBLJMeHqmg2nyJjxlelrFtHG7cZpgTOT0WrxZjhC82XfKo6K4hEWqwzqxQnUYghoV2z0EBjNF5hQSVJXoQpoAzdIx0nD+wavoTF4P8Dph51bNnZKieHU2hnudEJRnciSreKZhAmL8k4Prw5elnf1sr6oogj4At67/iarH1nIY+Wx2mf36vgsTeJpGPF/6Vy/9dyt524996d77os6nptIFuHixYzD+ONixdZ5t867dd6f7rwv6zgvugERIe7TJmLrsVuP3XrsT/PY/V8r1BuGZIanAUxNKx/konlHqeMh9Tyj6NvlI6+2zdLLW4PWNPGwOVJfmZcss4tHpvHo9ZBF+AmqW8MytgFkG0B+bgApun1JvNTRrZB2dcr2Ikn5U9GCmL96/u4LdvNmlx3Ql/uv2PhgvLc39sfj3VevPX/8cpPY+UDz/cKrCPVqxfIbt14rtdfqMduWAduY8P8bE/4Ukwrkg4E14d0Y+DnYBTgoHmfE7/OSeIobyHJ+qFbiD2GWgcJ/wA/DZiyehubmHLRhvPjm0NlRn8Vnuw1yZ/l+HgcpYhDQN+okEX6jOI3juTzc2bmDIEBFfN+ic97i5tIOEd4qRY/BZZ3yTpkdTxx1BFAeqAmgs32lEVe7skozCnluww/VZEdvLWb71cQiTCKi0TTQoc23Xuq1OsYpFr9IBd1CBTeW5AO5LqLg/sdl0YhWyFKlvrXUAJ4ApyURUYQPmYEMMQhr6ktmkgVmXKbdXyLWR7B9csRoBOE/Dj8zQZ797XL0nEyYwIOGzDfXT6QfN52DiaiP7NKdVOykDrZEYTLR1Wm7sCisZpV4YwZ+Ez1kjFzZi1/OIEYN3OFIqRQ74WudZD48s6Pjs68swGDcyjSJhsd9sQMa2qGFfs/VKZtZGOG39dpb8YzPtWiSYx7pL0algjEi6i3rq7mVi+bk+l4m/mKxNTW2psImn5e40Kq98gL15aEHORdR4Dli1NZ3E9f4mjl8zUkEhtNErGUe9EUEio/iUr5nR+27+SjgayK+Ih/X4nLK8TKwQjeig5i9L6xLvGkYSvZXQtB00A2u8Oop9t1s3SLRpvKI5v5ujqWmJtnkzUQyxV8PHENoY6JjvDBHJdWQQOD0tUt+UiMLPv9JHZ7/VJBZvb6CJI2QfujJ7+YZCTaRYFPHAGn41zMrNCzMTSCDigPaADrZ+KtIYBjNxT2NqzKqK/Q7qg+mBg9Y1Z9Nzg/1j8MswJknohoQOoWBMIxztvTMBfwmBhfmuIKybMota3CZXzw9J0p60/zavmof/M8mL0rczmbRfREsHjtKr4gkf564+5Mi3jbS/C9GGjNTRnPLV4J5Iz8y87Uln7qQ6iCOVHeiKV+1X/1na+x5RPOAxurQjvoKeKo+wY3YnNEY534NtKxwpjwRCkd0f2Y+Hpmow0KRvkBozNXHVGSUUabKYfTEEscVf8tEf2yOV1tNqZiwFrmE6kl4MCxYs8LwYNsfMJaK0SGMzDkOLDm2gw2Trtksgem9umcwmREKJrXBInwuvUQHLij8BbO60F+/pL2sF6OpoQiqemZQivRvhvoOudzAb6AF425XRkH1OIrpQoAVZMACc69GozRt34QbrK05ZcFcVdTAFp5HyiicdkdLGAGZ0J91tcJosmM6yR2ExcP2ILw2nxetvdZuU5UL8B6q7xjKsBxyfRXn8k2crbIh3mVrLI9ygarJJFgC7IDN6mI90SWJLgevnHI5CN0Ol+5OhQpjCmIh/N0dHuHEAukeX39JWIRl6Yes9lE1o69P6EL5eQOBgK0R9Jk5Yus/J5XXsFYKYReAxMJJP3twHHOzy/Ldr/cfoM+UUR9vyQTuNFhbfcCfQ7C0rFUoo9+6aCN0RZY2D6AJiEP/BgL0nIg= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Return a form definition.

+ + + + + +Parameter `{formDefinitionID}` should match a form definition ID. + +## Request + +

Path Parameters

+ +Returns a form definition + +
Schema
    owner object
    usedBy object[]
    + +List of objects using the form definition. Whenever a system uses a form, the API reaches out to the form service to record that the system is currently using it. + +
  • Array [
  • ]
    • formInput object[]
    + +List of form inputs required to create a form-instance object. + +
  • Array [
  • ]
    • formElements object[]
    + +List of nested form elements. + +
  • Array [
    • config object
    + +Config object. + +
  • ]
    • formConditions object[]
    + +Conditional logic that can dynamically modify the form as the recipient is interacting with it. + +
  • Array [
    • rules object[]
    + +List of rules. + +
  • Array [
  • ]
    • effects object[]
    + +List of effects. + +
  • Array [
    • config object
    + +Arbitrary map containing a configuration based on the EffectType. + +
  • ]
  • ]
+ +An error with the request occurred + +
Schema
    messages object[]
  • Array [
  • ]
+ +An error with the authorization occurred + +
Schema
    messages object[]
  • Array [
  • ]
+ +An error with the user permissions occurred + +
Schema
    messages object[]
  • Array [
  • ]
+ +An error with the item not found + +
Schema
    messages object[]
  • Array [
  • ]
+ +Too many requests + +
Schema
    messages object[]
  • Array [
  • ]
+ +An internal server error occurred + +
Schema
    messages object[]
  • Array [
  • ]
\ No newline at end of file diff --git a/docs/api/beta/get-form-instance-by-key.api.mdx b/docs/api/beta/get-form-instance-by-key.api.mdx new file mode 100644 index 000000000..c6940afbc --- /dev/null +++ b/docs/api/beta/get-form-instance-by-key.api.mdx @@ -0,0 +1,107 @@ +--- +id: get-form-instance-by-key +sidebar_label: Returns a form instance. +hide_title: true +hide_table_of_contents: true +api: eJztHWtz2zbyr2B0H9rMWPIjiZP6w93IEp3oKkuuJNe9izMJREISGwpUCdKOzuP/frtYgC9RlpLaTe+qfEgocrFY7BMLLJC7WsynqnbyrtZKVBzO2VkYzVXt/V7NE8qN/EXsh7J2UrvgEZ+LWETs490EQDpSxVy6otO+/8jULEwCj8157M4YZ/id+QaAddqN2l4tXIiII66OB9imIj7LITld/iiWALSwnSBBdzUJPwC42B2A+UjQgsezWpnKs1LPABCJ3xI/EtBrHCVir6bcmZjz2sldLV4uEL2KI19OAfJzfRrWTZ9nxT7v92riM58vAvx2YP7UK/6yfzage490qUUolVBIyhG0gH+KgxmIOImkWmHoeMn8WLFPmmVuKGMhY2zNF4vAdzWT939ViOIuN9pFhCKIferQjQSPkSnlTlv0gfmKxTPBPPihH4ok3HIgSyl/KgFHnjdHB0fP6wev6odHo6ODk8MXJy9fNV69ePH6+N8Ahjg4kFpDrPXYB9bsPSgFQwyy3xB8ulwdi18xjE4bR8BZIv3fEsF8D3jkT3wR1b5Ckg+RSMpBEGUiRvCWyChyz4wFBYkNmZDJnN3wIBHX8qo/+PGs27/64PzitC5HnX6P5ZWnZdmAuK/C6NMkCG+dz8JNsM9rOexfDlrO+ibDMIlcZDv2iVa/2h98JCzoBDJeVQJWcgZR15ETla2eZjh5keCH2n0qlVo4/lW4sQVacPcTn+L7qR/PknHDDef7ivvBIvRlvK8WdRSW2vfCOQdHA1j8OCjbcEoEeYYFOJhV8Tv6vbWkOf/sz0HOfB4mMmbhhKEBwCceWwVxuWRjaCAZKPgUHIRqsOYEfW48QywID/9C32DVHmKVmW3e+kGArefhDX4LAWmr2Ws5XafNgGgwY56Afwf34PIgWDbYCFomCpDrljJkQSin8BNw8HEgEAWwBoRvPIBKxnMfbD6UDXaFXZfVGkgjVoDGw9fE82PAOU0pmwqJMQCog3Y08Ei4YVTlQV5Xe5CHLJHYjQJBslqhhP6BWLUqmLPCdysg177hAZLtu0TiPPT8yTLjs7eE/oiHK984YYJR+QsfPA6iBqWCUbsxEMzCJE6BMY7FYl5B3kAsgIfY3OpFRhmG0qL3i5JA9HVwDaMKd26bDgCsi6PigYXW7km7nca1bPbabBNwU3rXsj/YCNePcg4GEMOv/qDoTejtRvfx6FTlFWaQ5xyoDXKyQhxdX2lz1Z8bebEVBaG0LxpVRoK2mPhSkHZolw/4yC2BYaBmKBHAD+E1WCdODUaAgwKD5KBQExEJtDFt18bsFqBN3+NkQD/hoJ6xMLLfAeEcdQghYuHOJPIDJw3PQNqd3sXlqMixYUp+B/FdS/Ac505vLZRD+HOS1kjht2lYFLh9uYXQH5W4vMCz7yhukteqrAiK1Zk/Ib+XtkJzfoisvRw8idm4Fuxfe/xsIoUiQ2G6rljEDfY2vBU3Itr7ok7NKPeuZa7fUpe8KHz9SqbKARREAgQBfes5JXmDgj/2BMzKY8PNh/yvicX3dq6/0R21ILrwyIeZaqVHcn5iW4A7vyU8UAyiGQzcTUGYpcG8M7ZneMQlREgeQRaiQ5FAHH68hE57zjad9sL4MfoFl5D13Opv0zOAxDAteahjJXgE84NCxyBnJWDaPhPao0Bgdi0ihLIs7/VHH7ajAzhgSUFvsk2TjnSDBNThC0kHgwByBbGby6W1I02zMkRvRwEQbYkA9TrfSr3mi3hJfWzXAFWD2gyvtoEfgj7E6go8PWOtmXA/qVRKnJGd4fQNYCAsABCXof4IszHz1fBDocHTqwZxOGUrcpsrUYc5hQJybqyot6MQRpQRCXzbqpEjvQ2DEgDx+EPajjoUkiEwF7+cn+BHz4G/Wn180sYAD52e+aUfnHPzSz8Mr8wv/eDYX/BQjH4/bRP4dh5v5/F2Hm/n8Z7c4+WnbfkMSGtYdQZT6ONnC6dnuUDIcDTo9N6waqAhDZHGo7ugRTFclYAs2wzXIvnQ7QxHD2LSCVkZm2Q8iri2FcPS1Fwq8okUo563r5K2NuFqrEk9UoRmTr4dygdztAf4gBy4lqf9ftdp9tbAnIZhILjMxTfiLwatjNE6vBXTtr2a+WDwFyNZimRjNPsGOrFTiq2VIu8C0s+pD1i1/1PwPR4LacExbVBMFR05hQAvKnJD3eAJ1mQLo8wW4mta7BXLPUqv104m0PcDKz0GoLDWU1ra1RC4TOslLq3k82yZbnWRjjBWe9aRWQ8iGFQEaEhLunaBN8UMOhMJJlBGuYVUUCVasBwHofsJtORtp52b1Tlp5299TzDW9hUu8GpF9D29X4QWMXzbv6pqNJyFt4w5sqpNuzNsnnYr+zK9rO3O6a1rSV2t63Lg/HTZGVQ2HNBW37XsX+BOQ7NbBdRf0EoqDPjy9Lwz+nDuDIfNN5UIh7jkHZ8LpUA70wYQdTtnnVZT72asbQUR15+Y7Tho6ow+tJ2z5mV39OHnZveyujsRt8WEJ0Gs7aXsLvypDCMywkUSLUJF5me8O8ocfTtIEf4xgkG33jMPhnG4GGvYg+AFHmQv8mPEt2Xyi0HB9L0xJOz08q+jl4Wtmcz93est64k/XXWEzWjsxxGPlmzOFzZdw6CtXSs0SaiCgI3zsSjD3aithpeiG/Zyo+jysQiqygAqPT0CfQduFhsVg17TdUEO6LYHAvfedIQxy8+bsRMgYM52qAvoXx8eHhwfH/1w/Pz54fHr41cYQgs75MTLJ4ysxIANsdUxIfVpdl1TWjZQUdzXszuBbR7rAgju2U20i7xS3FfVkGCbXAkEx0h/AyKiPXu7ig8aqDdFY9pM9UwjH7dGca29/ndjJKDPeaHe5RfVi9OmdfzLjVCPx44N95V8W1ZTtc+Zg2jbEfleYTPCS0Fox9OWJ+iJhdmqfNSaiTJddjTGGtbs2Nqvuf3anE/IDWiPKL/VNUm4mw3T7AUMKYXxRQCZ+CQK52mbunFKa3f3qopMzvLT9TUG/Hg1Jqaj6klkjkG5TRR2LUfOLyNW+joSnyFTGPXfvOk6K9/C6TQQ1K45cJpVbZugIHqS2XZ65e8QyoER1/Libb+3gvxiFkqBC1HNTrf8zQHDx+AHmVRrheKh3h6FuN4crSAFe8AYCK1sdUmhoUuBrtXvXp73huXvrTBI5uArsnkUDhx+EnfwwTACHmnE8KAHp9eCYSB6eoRE47QL6NO/W2biZLotTpdMFw8WM+SEXQiZ23oxCgxmk7lR9D4Bhb5aO/NCG/xOy1rHypRup1/b6JeOXFiwt5r95TP8r9x5xeJJytztfLRiV1to/5cj7+cUnGmfV+j83V0OHbkcm0BQ+eLjR/kVshTQ/EQzClsfsHk+kcYkG6OiKIzWRSj9rbzypGNsxkwmCCoNPwFXsa0Fq6qzhCmxXvEF1dZ1XQhFM/6RLe1qsM6kovWMexUd67IxP87iY1oxhhg6PXYx6L8ZQPJhysZuZyIi2txAFzVhmVpaNQDvlTCo10fPStUHtbWxvLDO9buMYE5JUYWETLpE8mGBWeu5FeOGlpv5TLaQH4nVmyKU2bEBRns88ljzokNMYLaulxlKaIl8Y2oShDD6isDe1e/TOU8SRSgCeltglJD1y+EGHplmwCbqrh/5U1+u65S+slmIsyVI65SP6S+toCLrMP/WCkwkoq7aMqYCZSa/3Io2QxHaJQSCKnf5ObbM4G6cgMYgoJ3akQgM5wtE6JSVLFMDbaAG+6mlydYGX8NjsGGAo4d9UKkNjsWq4gPrrT/b7Drd+cOC69D19dScdpHYjyVj+eMXYFO3t40rJSdhHKleZP/SvIxW5kmMpn7OelgqqdJTG52NE18L8x4NcojBkJul4E25FhEJgOum/1lRf6HefJpAjmUygiUuYaS5VOqdnyKpKp5Y0NWpflWR/7n5YvVLh6AHSv1TTE9X6m9J0oWYtn62sjjWfss2T5QNXlnhra58QyIoNc8w6gX0eBYqDGyh/mU8tvZuuKA+8YPAVuuaPRksYzDF0PjFj78sUfyTnUbIq0rKzyxtvIaU3OmNOqN/VUN2NPnxMpc02QbFPCd9u03R57Zd/sGV/ikJm3aXMp3F2lKcFzQDmLIhrtzSY+1kwgMlyr5tWIAnKY1pr45NAj5FBfelh8u2gkpErTsxR69wmeMGhsatEmNlvyrU8N/4PDdnwb4Iw2UHq4YNHo04lMGyiBHwjEWKiva7KJbOx8LzaCeqsE5khmk4Nq7cdyyOepVvl1FQkcgUQQZd68Tw0c5VLXfmfLlCuF7TE3h2SYfSnGtIFLnqKh4VLHUWxwt1sr8/X9bDaNrwjXbK8FbrWOLve/ukW49g0ysDNoyKq2qXY+vEae4eVqQF17I5HHbe9CB5yCu6bto0Z7pwf/xDmgesgHXkhTmgYjcfRlXYaMMhRnSt/vlF16mEalnhAJQ+sNKthMKnIKAYZI8WmHHoIoaU3HQTa6S/pD3js8VfOoyQ4dnop/7XeVfSrPjp/SelQ9ANdvSi6qBj08zJaVpLgRziJCZors54kPCtDzpu2gKKYQSt0BObjoC2M8hSXlkKA7tMcZcp/q5McV1qiD48USVdxfNkUz1zTOfY8Or4RYVtm7bIogjoAtppl+jB4VjItrZYstnDbWyWJzCtjvz/mP2YneXuLHdnud/acp9vY7n6FDDoqTneq3bGuzPenfF+e+N9sY3xohkwGeL5mkTuLHZnsTuL/WYWe/RDBXvDkM3xFJfJadUXmWjeULaxkO0so2jb5asK7LdsczbTBuI0c/FzpO8nKmlmB6+7wCs0hiK6gWmFs4Vm7BzIzoF8WwdSNPvS8FJDt4O0q1O21YZ9nR9c7+C5mLw+EMf8xdFLMT4eHx6OvfH44OUr1xu/2DTsvKP5+sFrD/VyzfKbb61WkdWSzHZpwM4n/HV9wp9iUoF0CNAm3PvEorxLMFA8ho5Vkkk8g3fvsRpvLuJZaC5WRJXFuxFPanoPqm73fdR++eLGGiJHe6frFhPcbkv3tu7A3rmM7xt84a/scI3BOmvlTUwrOhQwAmhjow7Qrm545OuDM5oJGnlhY7SWCupBzPZim2WYRIzQ7KHtmiu59Gt90l4uv1MauoG83FsZH4zrMgruf/9YCNGasVSx78HeAJ4BpaUh4hDeZ7owRH9Lva9oROaDcUX2aKWzPoIdsVPBI7xZLvwkJPv+n1ejZ7kL2mgnNL1/6gJURN+Llh52wUb67GEUJlNKRJuF9V89gcTb/LAIfSgEe2f38HvgjgbOcKRZio3wNcWT999b6XjiRgTodxsZJ1HxfE/uA4f2eaHdM73lPQ/xtj1JhonHMK9lnbX9iEp09Y6wHSKdKnq3sOPiuXF9LRF/s9jqhK2usalnJSqIte9sLSWEV0SBVz0gt766c8JXz+GrTyNQnDpiLdNABQKajuKqvWul9tV0FPDVEV+Rjmt5NfPxlthCM0YOzFYhdJg7C0Ml/sEYqg6awTssqRJfTdYtdlrXFlE/OsiRVKcu6349UULT1wXDkKRMfIw1QDp+hmziS49M8qOWLNj8R10Y9LEwZv36HcRjhPRCV301zdhhHTuskw9Qhn6aRKFiYRiCMdCNrloBWpn8tScwhOb8HuGq9Ooa/b5ug6HBBVLpZrvFCf04yRyceWL6A0KnMOCGcXqWHouD38zgwnBWYJaNrmUOrtKLB5xliW9Er22rK8z+bOPFETezCXNfBsvH9tJrPMmfx+9+I4+38zT/j57GTIpR3fJJX17JT818bcWmLpU9rwBfFdXU0eWs2XJ6HtEi4LEundIXNc70eQc6Sohzvz17oS5YIuSIaP7C3O8z1ScoIyCZB3zs6/uusA7V9sy1wdDEEuWKv1VC9cxYsjfjcioa7AqvhnZBLJiegnjw268gSzoCApK5QMGythU2TLrm80RCb2iXeNcwqNQGjfB85SbKVApKKSwv6IKitJW1YlQ1HIJOlEU0V/0JLvT5eJFmbcu+QO52ERRYj1JMc347kIEIzEGmvdK0fRNu0Lb6TAQLnTwDWVh6lPVw3hmtYARkkm7eaoTRdN80UvsIi/X5MHhSn+eNw8ZBXacL8B4S7XjOZQ75mvvaG2U9vMtWU373tfomiODsfx/UlVLyhLIRygLf1YpZIDQ6KfaExXAzGA3C3t3h4XrMi+7x9W+JiDDxfJ+lPDpV9OjuBK+6nDU/wO/N5QfeM3ZWon8d+XaBRy5r6fGIWs2cnyv/bwD376HFTHAPknKkjICa+lrVXPOVRatC1vzGQbXgawKzecBU+/7+v+IOHTI= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Returns a form instance.

+ + + + + +Parameter `{formInstanceID}` should match a form instance ID. + +## Request + +

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 + +
  • Array [
    • rules object[]
    + +List of rules. + +
  • Array [
  • ]
    • effects object[]
    + +List of effects. + +
  • Array [
    • config object
    + +Arbitrary map containing a configuration based on the EffectType. + +
  • ]
  • ]
    • 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 + +
  • Array [
    • config object
    + +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 + +
  • Array [
    • messages object[]
    + +Messages is a list of web.ErrorMessage items + +
  • Array [
  • ]
  • ]
    • 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 + +
  • Array [
  • ]
+ +An error with the request occurred + +
Schema
    messages object[]
  • Array [
  • ]
+ +An error with the authorization occurred + +
Schema
    messages object[]
  • Array [
  • ]
+ +An error with the user permissions occurred + +
Schema
    messages object[]
  • Array [
  • ]
+ +An error with the item not found + +
Schema
    messages object[]
  • Array [
  • ]
+ +Too many requests + +
Schema
    messages object[]
  • Array [
  • ]
+ +An internal server error occurred + +
Schema
    messages object[]
  • Array [
  • ]
\ No newline at end of file diff --git a/docs/api/beta/get-form-instance-file.api.mdx b/docs/api/beta/get-form-instance-file.api.mdx new file mode 100644 index 000000000..6138bcdcb --- /dev/null +++ b/docs/api/beta/get-form-instance-file.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-form-instance-file +sidebar_label: Download instance file by fileId. +hide_title: true +hide_table_of_contents: true +api: eJztXWtv3LYS/SuE+qEJYO36Gbf7pXBip3AQN4EfCArbQLjS7IqJRKokZXuv4f9+Z0jJK+36sdm0N64vjcCRKXI4M5wz5NGDuo4sH5tocBq9qYxVBXurdGGi85VIlaC5FUrup9EgGoOlM/vSWC4TeCtyiFaikmtegAVNEq4jiX9g3VGr4v4uVhMSS0tuMzxOwSRalCQYC992qp7JM0klTNRFzDXX8FclNKAaVlewEsEVL8qcelqtf+I7fjU/KMAkGRQ8GlxHdlJSO2O1kGM8cxWPVVyr3dUlunnk7NRc9MVjZroqZN6R65mZEhIxmtChzYBl3GSQMhLI1MgVVWWueIqFJJ5dAuMamAZsDhfYrLeAXzbW/lh9t324/npr++CXP3/f3ni3fdArnd0LesRbNuuJuvScNDClkgYMSVpHX+N/XcsPwVZaGsa9HTbjlgmDhoxAo+rMKjacMO9CxmXKuDEqEdziuUthM+eLuYBKlLQgLXXHyzIXiQvU/hdDfV4/YB1J4tguGgrJ9SS6QdtEwcfQ/1LCeNm25NNvbtpWXCUWbIzVgRffKolkbd7l+h3J0MdKT/1IAQPGMpUkFXl/CU+q4RdILEFfU4Kwwo99CpaL/I1K4bGY2p3WRMULMAY9aFqtuNZ8QmiyUPhyYV1Q75ExB74BxRBZRDGRcp2ynY/7tbVNTLJaNiO5BJeHLchVwnOY9+J7V9705/wmLfOlURtzIOOTo2k3dxpfN0PDfXcftBgLeV+n/izLVJ4aVipjxBA1ueA5DiKliUxdOqW8LHbJDTOQo3FuZKea7e693Tl5f7yQbrVGqKGFKzuv2TGWNs7gia14zqhik7X8ENSe7yhxnGEr/MfrqHxEG+rHwcQVljz5SgJxHsJYroa9RBV9g3FUKiFtn9ucG6znD/qXMJzNWQdNnGE5xoytzEysohgYg24jDItebc6odTRtSy7SqBfqTjPkw1F/3NTcrRH7SNIJMAswCzD7u2B23/wcUBZQFlD2/Sj7pqVsAF0AXQDd94LOs761RVgfr2ymtPiPw2fgfgG5AblPYVEauF+AWYBZ4H4BZQFl/2KUBe4XQBdA9wO438Yi3K8yoBnGaSFw/DGuA/0L4A3gfQrr0kD/AswCzAL9CygLKPsXoyzQvwC6ALofQP82F6F/BAMmlWUjVcnA+QJiA2ID5wswCzB71jALnC+gLKAscL4AugC6ZwI6x/nWf73DvUqxgstJ826f+SaS1wbKIghZDBldbHf1naK56a8dDd7TLKHT2r05OhOZ+2iZlhhDR6AvQLO9BSIjJJCQQH5sAunCfsa8W6A3RjZv6TatWCUFljCRYhyIkXBJZ2rmr0m6ugGjX1bhFd9c34Lhq+Ha2jAdDle3tpN0uPmY2e1Es7zxLkNt3fMasmhQazxq/ZiFRxFCTvj/zQlPYFERLksFmAWYhctSAWUBZc8AZeGyVABdAN3//LLU1n1Pol+1SJ9IXOjRowj8Au3lQxd1gfcF1AbUBt4XYBZg9mxhFnhfQFlAWeB9AXQBdM8EdA53BjCahJ24rb9PkOW9ITZ3ZXcqm9GG4qYckC5mUHBJxp/TjtFXMd3cH2Ow1bc546FKJ003r/E4mt08e1ddStoLe7oruNtKutk2Ou25cUIe6d5wdtp8BdTqwb5WIheHTZ+kWgE2U/Ve5wQv2sh7EPXJhrjp2vSvu5tR3/RJCSx1O1jfROQWusfp9ah0jiIya0sz6PevUUcu7U2Pl6Ln7+baiVSXLhqGmFfmTG+CjkKTKrg04TvoORO0ICbt04wT7iN+xKucQuA2xB6UTA4hAExUpZkXs0JZB5Nqnk98MapYcjn52bjaPYqClTn70K4Tnd98vy1e0D223OW+B3vD+gw1nTGRTDifRvERzRS+97lYns4etJfa+lxnH6jaOnsNXAOKV19BshfvPh2/ZBh8tIs+pKwydCsfEP5YhbOPGCKKro7sJBhVpm6EucdmWlVj//rGTmfnNvfQzChHg9mZPAJgp/u1E/7ARHq4d3TsXEqNqNjPiOcvmtFJ4QJymjF6U09S4IlU9tFDfd5p95I2XWeF0jh1SJ9SsLR3JmO2KzTmaLebANWpTSTrODstG7t4y65llfipkRZ7abGTZl7OaOFde5rkgqa2RINzC8+N89bSnXt5cUtePNYYODFJndWBPFHr0d1vL2lGbWk9OvJcSuvqcSY/ZSLJWLcZ8+mMmUxVecr2WZIpZeA3xih0CAan4wpRtLRal9Rp7BARr6+2VIp9l7GIKwNOv/cIDOmDiQ9VZf3MrzB/y9RD8rMbWcT8Z/cRgM8dm13xKa4kqGaqErO0ztRhTB3GPgeYWn+//KPAogkUbXB5wAfAm+n4u0xQK9rKe17WnVndie+7NjQ1JKiqk4Jzo/9jME1w9RFzJ6j2bR1Mw7SwbBDF8G9Wy3IL4LazmnXBrAfn9c0VrpRm/Ob1bdqSFk/OXrJ4Z7rk/yDzyd+dpe/JJE8n7/6gjBcyzXPMNPVynsKtTVfbQf66Xq/NYeqEHgrOAH/jWYdV96wfMqvpS6htQWXOLUW1Q3WSCXQqEt4SuKW13wpFliocEpHdEvyRKTpBY2T0KBhV5jkfihzl9djxtGfuAOMXlu4zMvi3qRxVpr6SjMsx9NgnpHgywWEhYo3DQ+e+4Fg6RY9wZD7SwLLdZrBx0VUUlcTeCJdVwTiG1CMRkQqTVD5xJUpKaHyh3NLvtlWDYgo1MsFRfEC+9GF05O+YtQb+kb5w3JsHv9H1NIq3VysaQw4hd5FJ9brL9sdkY7TFGeSlo/2oljTQ6uFg/3hOIgqTBu1KoKf0uF83Mn2qi0KIHvnw2eit9VZjRxewvFTGIldsq78A9esE5O0cQIv3PkabvxZQeTLhKd1p1KV0KGMw94Whkf/A1aD+uBMShQy1o8bX10NugHjODRUjsdREgc+nFMZRP/QeHSOfHCGeYU7P21uf0YvD+jtOL9lCn8O608Lm4pOctKgtHnomPGMeUbfl9PtHvmO1jEHNN6iwZgYoX7d4P1Gq0raazd1b7tD93/cogvk9a4j6AAcYs+R/AQ3JxCE= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 instance file by fileId.' (get-form-instance-file)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Download instance file by fileId.

+ + + + + +Download instance file by fileId. + +## Request + +

Path Parameters

+ +Returns a file that is referred to by fileID and associated with the formInstanceID + +
Schema
    + +string + +
Schema
    + +string + +
Schema
    + +string + +
Schema
    + +string + +
+ +An error with the request occurred + +
Schema
    messages object[]
  • Array [
  • ]
Schema
    messages object[]
  • Array [
  • ]
Schema
    messages object[]
  • Array [
  • ]
Schema
    messages object[]
  • Array [
  • ]
+ +An error with the authorization occurred + +
Schema
    messages object[]
  • Array [
  • ]
Schema
    messages object[]
  • Array [
  • ]
Schema
    messages object[]
  • Array [
  • ]
Schema
    messages object[]
  • Array [
  • ]
+ +An error with the user permissions occurred + +
Schema
    messages object[]
  • Array [
  • ]
Schema
    messages object[]
  • Array [
  • ]
Schema
    messages object[]
  • Array [
  • ]
Schema
    messages object[]
  • Array [
  • ]
+ +An error with the item not found + +
Schema
    messages object[]
  • Array [
  • ]
Schema
    messages object[]
  • Array [
  • ]
Schema
    messages object[]
  • Array [
  • ]
Schema
    messages object[]
  • Array [
  • ]
+ +Too many requests + +
Schema
    messages object[]
  • Array [
  • ]
+ +An internal server error occurred + +
Schema
    messages object[]
  • Array [
  • ]
Schema
    messages object[]
  • Array [
  • ]
Schema
    messages object[]
  • Array [
  • ]
Schema
    messages object[]
  • Array [
  • ]
+ +An external service is not available + +
Schema
    messages object[]
  • Array [
  • ]
Schema
    messages object[]
  • Array [
  • ]
Schema
    messages object[]
  • Array [
  • ]
Schema
    messages object[]
  • Array [
  • ]
\ No newline at end of file diff --git a/docs/api/beta/get-historical-identity-events.api.mdx b/docs/api/beta/get-historical-identity-events.api.mdx new file mode 100644 index 000000000..795cd30fb --- /dev/null +++ b/docs/api/beta/get-historical-identity-events.api.mdx @@ -0,0 +1,135 @@ +--- +id: get-historical-identity-events +sidebar_label: Lists all events for the given identity +hide_title: true +hide_table_of_contents: true +api: eJztXHtvGzcS/yrE3h9JDEnW07IEHA6O7fQcOInPj+ZwroFSu5TEZkWqy13bquHvfjND7ksPy3aSpklVFK28Sw7nzR+HXN55eioiHkutjgKv741E/G9pYh1Jn4dHgVCxjGeH1/B/41W8mI+M17/00hfMtp15VxUvEMaP5BQpAZ3zsTRsIuKxDlgk4kiKa2EYD0PGfV8YwwTRZEMdsXgsmEwpnorfExlh2wQ6R/IP4o0ZH/hkesheyED109bVsR2/HwkevGDA4ZRHHIYVEfJ550nkZcrjMbxS8AL+kgH8Nv5YTLjXv/Pi2RSfGmBRjbz7ihdZBkAZcZSIRbkKvBIpccsn0xBp7PqNXl3sdHe7nLdF0OO9+iDoBZ1Wu91ptoYDoO44+j0RoLSMpWGkJw8ztciEpj94yKQyMVcxQyLsZiz9MYs16jyJFKm2pPASw816vVutt6r1xnmj1a/X4d//rWSS+p8DY2YZqzyKODaWsZiYJSIsyLCnchFCsCLaloZg2NPkMtQYOxoylYDrgK+IyTSeVciRnAfxSLiWomSOS2+PBN8LAhGQB8Nb++hUTPR1+vBqlcBWb0cg0NeV2tkHaTjZX/LptILPdaLiCiNvC8VE0B+xX6vVXpX0s0JBBcLGUV6trMIg8MKNvVo5oZxIbFgW7x2/BUYmAxGhYBDFSRgXTfmLOhOCXf7cYnsnR+wM/DbgUcD2dRgKn+L8JIvfq5fjOJ6a/vZ2AJYOMU3VDJfhVEsV13w92YZMsM2ncts4OlU/o1PN88AryjETDZJLBT8nlFBqXjHShzw0oqCOZqe+xNowrhiJCHpaMvZRqwkPJlLJSTLx+tBvwm/tb6ISiCEHLdBf96u0qYdDIxbV+YEeA9ugQYzkIdrYapXBixq7MAkYesbMVPhyKEXAbmQ8ZltknS1U/JSPpOKxgP6RTkZjouMM892Y4zOMkal/tfKtp8/rHkJqCyeALYgf0CoofqqnSWhVKdjWf6vnOuZhdR97b6FKp1oZwcYwE4H7kx2w4ZJwGHOgqJMwYIM8GpkcZnYD/bEt6xNb7EagqkYKNBaAxcBmUvnYD8QwMaQZxsHQwAojQZjPFRvza8j7DGxEysH2cjLlPuQPkAZm5kiAxSDWITUypWP0FCNw1C0i8k+SfAt5Im6veZgIqwVsDWwnJuXmu/AgO5UvONFA61Bw5RX8hHre318hNWtSSuwwVeL/Fufh0ty1iGeAtK/BVcHDoDvk9RCAFXbf/s0gjbtHTCpczT4MCc64FnrwG2gF8RimbJxWsqlqzxjtS/DSgCby9R3cXLi0daY+4CGGKW2QxGJ/zNXI6iRFLzIyMf0G+BWJa6kT8zM6DMoScEQ2StykT/4AkhwhTYYnkJ2UurHkcW5KNUiwdJfv1nebu8Oddito77aH9Qb8Eo12s94UzfrOEC0YE6Jp9AjR7J43m/1Wt99q1Xr1BqKaXPaFwdZr6tRG25q2KSzeF1FM6XitVt00Cz8litn0ew0QlHe7w2GzsdOqN7q7zVazyzv1Yb03GFLSiuW1SEfy+o1mt9frgfjSTEM+e29tckZDsPfWKkYnkS8eq0jb2hF6e/B6nx3m2MCwM3qNcuRP960U9YoDTc6sqXigfAjpOHEKR3FTRzmj5wgvFR+EZHhwluwpSGUfzzuMpXxWoPosn4FAeazXLBvx/gohnjMoxcTSSFxIHAAD9wqoj2dNbRoBzq5tuFzeFWBo5iZrFxor7LDaez7L5qtdb9Fqi8r50pFe8UaQ0CKFs55F+Hmqckp30cw6u4+gFmc6zPNAaZCj9ZErGtBD36hsWYpdBv5OrzWsd0V3sNPudFq9neaO3+z0Om2/s9vptL15zb6F6fRM6RvPzk7XUtx8QYIBQEgD7vmOfwJY1f98mjCJ3leWzDTroiGy7f4uoZCq5c+Mg3dccQDPzE1UFpEQdsnM9+jA8Is0nhoYNKX9TQNjAYYsC4wMdzHftloWFgvY7PLzwNnVn47O8kyRI62l6rB5IkobzWvjbi5Pw4O0bfRYd3QdnNle4wprP4fjoNqsYoo8BUGWYtJSETyOYF2RrzBP4a9qw8tdCTuenJx++PnwYGHhiYsK7M7sYxdVnwHhbMbC4WH5EWnQ1BEsm0pe8laPs7CX68eAtVCK6FASomrR0NXSNJfb9Is7Doy3iLqXeU5WtPXTZksiqZzLnoTKSY/IAnPRZmDNLoKDNQizko5ZSliP0ctcchk/nAKfTPGAC8jKM8POeTTi0UwoIk1S5VnwyWTPZxFONcdcKYlBSRYsesyiNb9WslmE8ysyDpVVrLs/lIU3a7k0Ixy+33t9TKmtuJY7ODqzj7/SWm6d0fGfitdeVsjZDyXuPBxGEUCgKqwP8pqcrZfa9cJABzOsnkkFZpdB7RnFnawKADlzii5ul42BiLkM93UgFncR5ieIN1KJ6ijiEjkUxLIPHRlmYRngdEW1MUsSS1MoArWrlXZ/QBO1BnvNg2w9tO+EwWVvxP1PQOsoWM/QhZLQn6VdINVmZbAlw4qu4IOdeq/ZBmty3txtN7qdQW/IW616r9Pr4egT8DvuqkxzVbHy0D9hkpI+C7UPFvlD4GYjNw7L0uBLdmdW2IBoPEL/VPWjtpmYjl8Wi9u4wjh7vX/C2l0Wgi8n9JyP5pSgqhdnGB9JGGKBw1YoQXJL+EMkR1ItY0UoLGxfegeHb/Yujs/hyenhfy4Oz+AX0lrYh8WZTwXolpqK0GN9Qxw7AW64YUZgjVUENbblqG6BQFyZYkNp/zIzg0s0Vy2FHm70JT2KpO3mZDGUKG5uY/ZS1kStwgb4bMJjf8wG3EAHbfcutxBATOPqsdPklquvv6oxQF7S7aRREjbQf4alaY4bfiC12zKBUBZUjtdJjNVr6YuyLXJVlq2R136Oi0bB4ADO1/vJnh8nwByJWYzCzFsci84+wLPVXJm784LSSKUzFXM/xu35EMCMjiLQMAN0Dotnw1w6QnMZSDwqbZdlrPtCSYvS3TvLzEGs6Z3PE/OIuDsJIf1USbTsxbVwwUc7fjYbkTVSM7mM5DazqLNrlZkrDXwGM38YbGJ3E7ub2H1k7M6/PHXbV+4tQZ/GIvS5UOlBGxBiAfpE5D1Kz53GsYas4HkDB5HefjyHwP4kFLYXt1PchvuC+MhO5Yv4PLOHfT5A+JEZq2QLZJD06GpdkIlE0Ce+c45JUVZVrcXR3uhoIMFB1RKICFkzYjOd2BMWCaxucGPWVFighVEvYrcla8sXlAFxVBVU7e7nBklukORmNtrMRj/MbLRBkpvY3cTu9xm7DyLJ8nEHh5NMMpnwaGY9zb2no60MGuRn47KQy3ZrimgFibEMY3ll5OANmo1BY9j1RTvg7WCn1Rs2/Z0m73Qb3cag3ex6xbn+Mo/jLMjKMVWwt7UjqRhA3DXguESBc5lY66Bc/gP1RmKIaQ1TT4abQee1tMBI2LG9iB3f6xhkA8KAHaMV5cWL02OkD0MTedQb1WcRZlvV2dN4CCnpHJ64lXQWYQMdN9BxM/1spp8fY/rZQMdN7G5i9/uM3SdBx/Y66Nh+AnRsM4RYQ4RY3xI6BtJ+UDEEo4AMfgLqVQgbpyAK/MpP2lH64dFIxBnQK6HIZm/JBwdas3dczVKwZEqVSJWrC9MbtJ1g2yhtCw04G0GKVPhliAR0i14lJwIxKX7YQp+fYByjQEA3mlX3hjFI5T5qcf6WjSKVHybAISWFUGPtVYOPSfxCZIjwDyhQHXQEifoL1jidtT6rHsxOUeJjlJgd3vpCYMxn9d/OslMCR8B8hOnizNp6xXEBWzPnCpYR4nZq01cGQTdQfQPVN9P9Zrr/Mab7DVTfxO4mdr/P2H0CVHdoaDVUhwaPhurQtlZnGZZ6Q5/d/tmInULFcUDuzbRPWD3IMTjhCrzAxKNrUTCH4EUifW97nN2QUnWnVCGtbN/J4H47u2XDrgcse0kUQrf06+c7sBpY677Gp7KWnnJV+oY+gR6AqpZkITx0aiMOG9DH1naAGuk5kujKNu8Rcat190mzl31l/SBlPLeO5pzBWoRZMhW8NsK5FT0GFqewpnhhqHWN3GhBPpDrIgrvP18WS2iFLMvU9+Bo0J4Bp3Mi0uc4aC4wPx3CBntdAD/7NmntJWjyy6timzME6ZbDhZb5xIPbA80Fhj5gsyZ7LXgEKwh7Yubl24/nr9gIoSmlhsQgKhYS1xIQXCfgRpT69tLTI9iJZqP8Soe90vkcDDU2DEEpzH2hnx4yfw9zwikkcVI7dhKUN7DX47/P56V+K77H/0VV2YGM7Of79sN4J6K9s+BymsrFC3I9l4l/pNSqllqVqJlXc1xY1V769ry3D/GOJHhoSFvPHtzSqxbo4YILniDVeR5QE46P8qkqP7Xas/ko0asivTIfv6iPdEFQuVt6T5MZ06UUR8wfa23EvxhD18FQuRwlEGnPZotuJapSRFSb9QJLVTtkVVYBRRJ/xxAYyjoTH+AsTiBG23oKhe2vZFnIC7/SPRm/lmSmx5cw2WLLQPtPuHRijmccsIoDVm2eMI5/O5ehY0FsowyUB6wD7Of2p0zgGC3kRktraeYn8tvUB6cPvO+KqJhp3/7Rz5Og+2VvxcLWWRtI1V76sTLtIoYhc7RwQispKy0fzGtwkd9Qwzw6pzfLb7YJinPrX01elHgvr7J8UOHsS2fpFZnkr5N3v1HG22SaHzHTOFiM7kbDzt17gk7+2mG6xaqfoZuT4L/wlmKVEDisb/LLkoqEpiGP0aspqv0xXiCIZXTBY8SHFfQsPaFIhKU9hj+sConQKII2ELYGcCsfyBDoUUU7HZlTwFjwiXbFv03izldo94VfjX2EJZzywSy4fMOTvfDuN+3WcWdgmRM0LDtIjQ2gazJJFH5iCmwnE8bBpdZ4RCCNn9jEBas5JVJdaIJ+Wa80itHVUIQaLWSiifkwxFI0rHILhl8zFtjduDo0qL5wJ0AuyKkIyTOxXRnar6MN3lYdi3CKC0jIugDARPHWgaPzBYpATLnNDx2Ntl0ns41tgQguoaz7tGqNWr1KSwp4PtUmhiVvgfixxC2Owr2Aab3GbngU7mMqueVdXpH/ZndWurkIFxHbUyyUoYSJXfjYJeelt3TJCX379g5Ku+qENcpY41fvl97dHdZWcBl2j4/tlWe4tslu1EnvyHpAHZ9zy+RSoT4JrB646y5decCjS5Iez9bXujjyAYZLV19+Qba/4c2PD0i7eO/lM0X+vm6DfEAj6WWXz9TD3+saxwf0mF1z+UxFbu5k/P7uZHzAHdKbmHJvuMoLgE+crF66OTh4RYcXylc0L+Uh3a9SsyILKW8ysPdEWNchZuwLu0lR6LKwjY9SZIXjnw4Bx9z/H8DRXOE= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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' + +## Request + +

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) + +
  • Array [
  • ]
    • reviewers object[]
    + +The owners of the governance event (the certifiers or approvers), this field should be preferred over owners + +
  • Array [
  • ]
    • decisionMaker object
    + +The decision maker + +
    accessItem object
    oneOf
    governanceEvent object
    owners object[]
    + +The owners of the governance event (the certifiers or approvers) + +
  • Array [
  • ]
    • reviewers object[]
    + +The owners of the governance event (the certifiers or approvers), this field should be preferred over owners + +
  • Array [
  • ]
    • decisionMaker object
    + +The decision maker + +
    changes object[]
  • Array [
  • ]
    • accessRequest object
    + +the access request details + +
    items object[]
  • Array [
    • approvalInfos object[]
  • Array [
  • ]
  • ]
    • certifiers object[]
    + +this field is deprecated and may go away + +
  • Array [
  • ]
    • reviewers object[]
    + +The list of identities who review this certification + +
  • Array [
  • ]
    • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-historical-identity.api.mdx b/docs/api/beta/get-historical-identity.api.mdx new file mode 100644 index 000000000..dc5f213a6 --- /dev/null +++ b/docs/api/beta/get-historical-identity.api.mdx @@ -0,0 +1,91 @@ +--- +id: get-historical-identity +sidebar_label: Get latest snapshot of identity +hide_title: true +hide_table_of_contents: true +api: eJztW21v2zgS/iuE7kNfEDmOY8d1vhzcJN3NIn25NEFxmxYoLdE2W4nUklJab5D/vs+QkizZTptti729hYEilSly5plXztD0TaAzYXgutTqNg8NgJvKfpc21kRFPTmOhcpkvgp0g5zMbHF4F1RDzsxbBu50gFjYyMiMaoHAxl5alIp/rmBmRGymuhWWc2UxEcipFzGRF41z8VkhDbwtMN/J3h4PZCJiYnrIHMlaH1exw7jkeGsHjB4BkRVQYQnd4dRNcWmGOtMrF53wMYgT1zsXBu1ugzrjhgCmMdQQkYc84lu4ECi/wScbEJZqLlAeHN0G+yGjUQiQ1C253AuPhQ225KcS6HsRSUkdKfOZplhCNJ9HeqCsOhk+GnPdFPOKj7iQexYP9fn/Q259OAgIIxWRaWWGJea/bpf++wEJPPogo74BPRHpQOc3nWZbAkjR/94OlRTfrEvmVWJgZcoZcepbAvCb1qpB5E8HpcUvISXQw2p92h2I4OegPBvujg95B1BuMBv1o8GQw6JMKY2mzhC9eOIXfh1m5gJGJyEWaAFrcxzFP2a/4xImPVTyzc53fkwnPBfs0F6pFHt4caROzT9yyCH6Ui7ZRYaJh2N0Pu3sXe/uH3S7+dbrd7q9OTpHA1eJjLPouCMS7pHVv3jyKhLWnuUiPdKHyTYZv8x+zlGeMvIhLBYAOQkRrSeOCR3PmaTIJoljO41jSWp68annQSsQQlhzPkyJvvf8zMGpNNCjdH8BtQ2fewYNeNOoOR5PesMt7Bwf8oLtHT8PhaBpNoMFhsOKkwRmf65SzN0X0EYyCFduqIkma7na3ZVaV8UFPLmTurPnzOXvOFZ8Jg1mJ9vGL8Rf/PcLAVBqbqyYYmsXrsSYyJLk8dbkARO9wBqOJaa96Bw1OZTnidJ0IT6H3xE3xy/ZJl3mJt9oUyj3hvExcpHDM6m9KXUeJxBp2Yow2LMROkBdG0d7gQ5pSq7A5m+gYyROOpq55IuMfmN1iAbdKjnR8j4B8JpUIZwZuCITCQY6wkIHitYzJNVNtELOOZJWV3LxOK0qhic4ee8pjt/ORfEelMKRMw6OPoHV6j7R7qSTWs2oJooJNAeoOtmIo+OSgO+r1pwd9zntP+nvDwWQ05fv73dFgNCLuKSwPh2tGDTeGL9ZY/ySUQHHAyC0T+bugTZ5D9w6AY44llBc2RnjbBo7GPfRP+5yfW4tZ4mW04e+gunh69Ir1hyzhala4cT5bUYIKL1/T3o4A5RMaok37dqcE8dLImVSboAhVpFROHJ88G1+eXWDk/OQ/lyev8US01uqfsYK3xuSWgApfmOtPDnEpAGVwi4wRIWV02OOS6mMIxJVtTpT+k11YKBO+NeVFkmNFyX3DiiZpNjU6bYVS5Ksj9lB2RGeHTWgs5TmS+YRbLNB+q3k8RhbI8vCs1ORjNkfJJMyjDhvXWZYhGkEU6xcgxJB+KXQ9gWmBUAYYiZKuyJnSuYxE2xZLVbatscwoZ02jUHAA+df9ZBzlBcA5MZtRWHtLCbG0DzB7zbXRXTSU5lS6wA4U5VQQJwuo0aAOQGaCbDK3rExHZC6LxKOqeXXGaiZKl+6eezDHuXbvIl7Ye8TdqwTpJ3Si1S+uRRl8cANdZiNnjcpMZUbCSxLbLS5n1eaqAp+hNE/ibexuY3cbu/eM3dWXVd1TvnWlz9566XOpqnYXQqyVPsZ5j9IrPbE35A6DQsoS6Zc3Fwjsj+gQMF98zqgT/YH1kd/K18CPa3v48UlVmFdb/9IWBNDp0UswRSYS8aHDvUTsFOVVtb/O7Zk2EwkHVRtKRGRNwxa6YBwqM4VyLQK3OyzWwqoHOZtz5MeyUXEZkLiqOMy0VD+yT95WkttKcrsbbXejbSW5rSS3sbuN3R9dSdaoXLSUdZIt0pSbhfe08j1JyxkmsOqrA1aHnDPVarVCxFhdYwXtyiGY9PYme9NhJPox78cH+6NpLzro8cFwb7g36ffoZHS5118t47gOsnZMNezt7ehUjCLuGnVcoeBcNtc6bh//Qb1GTCmtUeqp62boHCp9V9eOvdGGL0e0plPURVUh2VYNqZY6opyGuSnNNdVcTOBshryoGFKVBC5yJZkKUDF0Np/IVLrgJSlA1yzC8TSHKD5QKieruUgVJQUQukyQaKqaNRxLQkgxpZoPFFwFO0N2/oHVaWmi76rk2TlJfEYSs5PPkRAU6HXlPth0vnsK8IZyxGtv4DsOen23wxUcAA2Bz1l13bmtz7f1+XaP3+7x/4w9flufb2N3G7v/n7H7J+rzshq6uz7HhHvX5wO6LMDqWuoZOddfXqa7UCkROPdmOooK446bqxrc1RV05StwV8goh9BVqsNgd17fJgvLuxtIK7s3Mr4N6AoXFYceV2ESzJ/neWYPd3dvYC6Y6bbDM9mpLn0o/akT6XR3Ah1tSD90T8CHGk1g41enZXvRcQo2knzYJzxH3KvbiUTeCrW7o+EvUq7uHS10gRTnyOww+HvpT24YEDM0Ew+sm91x/rMmH+S6NMnt98viCd0hyyb1fZEb5jMgXRGRRHi3vHH3mipvz33t3t1yN6FurbfG7CVN67Gnghu0Bf4LjIe/vLl4xGZUb7p4LyyVukJSg4CIeQUXcflsXB3m0yK3xRhdzOYO+Lj1dQnFD5smEJi9Va+FYFfVHZUXSPTnyMxOpbRIuGRAq949rKwTi2uR0B7YWWqSHE/Gahca2uWtdY/cfucaA6nwmLrRzlsVsmNJaUjSvk1zShFdn8euskou3pDrW0H8q6IWemqho2YfraDwqr2K/PWbCEFMJHhinba+mbmnFzboUReFEaK6ioE0UeJof8kVVVb7ZhwteiHRa+N4q97MJd1fay2rrqta7IVJzE5ZNNfain8zRq5DYXA1KxBF3wzrEzENXUSEvW4DUuhZhjJEaejwnSEwlHcmPqGt2VUmGkWbin1IvneWRcy/R+Mcs/ctmd3wFXZQmhnryH4zZmIYEsPQ5wBb4vcbFDkW3UWDDC4PeAc4WtrfZYISaCPveVobs7ojv+vW0NZAl4AdFZsd+g+HywRXPvmrwjS7noM0TJV1/bUfPrOSlruA2FRWdSawqsF1vInG5riiN4+3PpOiDfPvJi9JPF4enbxUyeJHZ+k7MsnfJ+/+jzLeNtP8EzNNWeuSuzm2KxdgycmflvXa+lEenTXPBf7irYtVV1ajaXFtmKtimoSyhOfk1S6qozn9jgKNQyZ4TrXfDnmWTl0kol+n8Eer5wjN3OV0A8gcbZtMQM8dU1ecuQsYX1iSXemzLVwnQryiOZpK0WFv0JepCGahnowuWuDdB102Z69hmVdkWHZcGRtFV5oWii5nA3aRMg6X+opHxNJGhU9caNGUqHShXelXr6qimFyNROi47sSk9uWUzpfRujYM/xVesLstD5eherJieW96Kci5SJxn0rx22f412vC2cC6SjLpCZF1Bt6CXHJ6fXqxRBDFlIRe6b21mu+Uiu0tzQYTaI+8++529Tjd07QLGM21z9LEN4j+JnAE29cPV9XOq4hs/jmi5483yeP2v+8lOuelQt7Cb0TEXiVL47sU3jFfBxoYRa0GVfmw0h+A07eaGDkSohbql4d8KQd321btld+S6ShiGntGXTpEqVn+k01TCw1K0+JH7Sqf9052NwKtTPLVYNvABHj8K6vuxDt0xALuDGQfGv/BHN40la19uUK9Vt9M/nZDT8Du27fIBgiMx/QFeKc0E +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get latest snapshot of identity

+ + + + + +This method retrieves a specified identity Requires authorization scope of 'idn:identity-history:read' + +## Request + +

Path Parameters

+ +The identity object. + +
Schema
    accessItemCount object
    + +A map containing the count of each access item + +
    attributes object
    + +A map containing the identity attributes + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-identities-potential-role.api.mdx b/docs/api/beta/get-identities-potential-role.api.mdx new file mode 100644 index 000000000..02fae86ef --- /dev/null +++ b/docs/api/beta/get-identities-potential-role.api.mdx @@ -0,0 +1,79 @@ +--- +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: eJztXOtvGzcS/1eI7Ycmgley5Vds4HBQnKRwkTSuH5c7OAZK7VISk11yS3Lj6Az97zcz5D708CNO0WtSfUmkXXI485s3Rfom0oUw3EmtjtPoMBoLd5wK5aSTwp5ohx95dqozEW1Ejo9tdHgZHQ+OGT5ib6SSahxdbUSpsImRBdIBKucTaVku3ESnzAhXGmWZrMmykTaMs6KizgzSkgqe0aecqDIrrAVyXVi44IYDOWFw+ZtI4hoFdxN4peAFfAuDQYaNyCYTkfPo8CZy04JeOoNszjYiI34vpREgqTOlWGZbrOIAWAeq4jPPiwzJPUu2DjbF3n78bJ/zeEekBzE/2BzG6UG6u72zs9vfHg1hsZV8Fm1Iv47bwRKC6a0gfgX/v5fCTFtAa0N6WOTmDJ6Drm2ZOctKi2s7gNM6rlJuUmanyvHPzE8aCmL18l/bbHByzM6qQUc6y0SCFNlJrfKrJxPnCnvY66Xik8jQXruWy6zQUrluovOeTFWPF7JXLRYnNZ24MZ0fkHXgKw5cPn2v3qsz/4yBvdqyKFC4lOwTmR8BGX2Nr0dSZKk9ZJ0OwtDpRG3ljHhmQTvWTQlemJ0T3kWmU1HproGfgLxD77chP5LZSuRf0fO/OPae+UX0X1VPH4Y/gyWYj1fa2EOkUCkEVGOvH6GWL9aCHo2scEtKeEuPAVinPetllgWVgA+6LruwJc+yKbOFSCSIk7Jr6Sask8lcug6DaQUfS8WdgPlGl+MJ0QlodcFShfiTlfaUFJFrg8EZ4aM00V0Fcm3dmysghVXFWBiY54n4R9t9eIBRKi9zmpeKEQdZ4fOt4BNYS9i/AdtWZT4EJ9Cj2g8AUZ96vhns+rtfgV7OP/vPRKXGEr7dimaiS7WM5vGIddA3Okw6sFEw40IXZeYNU7DOv+Nz7XgWH+HsDsJdaGUFmwieggbIqnHgCo1MOFDUZZayoQjKwWA0qr0A/bvjPazDrgWCN1aAYdqlWC1VgvNADEtBm4OSgRVGgrCEKzbhnwSWFsIQWDhe5gVP3AZKA0HGCNBhLlQKCyvt0EqswFU7ROQfJHkHeSJuP/GsFB4FHA1sl7bi5puwqVui3FBDjcBV1LIUmjmbXSE1r1KLE/qbm/jfQrIvk0QIwLDLTkN5x1kmrUN131PoIb+JVvgICfOiyGRCkvQ+WKR+s8wuN4aj4Uonctt6rocfACUsEA2iimviW6jXlgL6kpmnyCsaauB3ihWX94z75v4Co1bN5g7GD0snVvLI01QiAZ6dzHG7mHhmLfV5WaJ+crD1bPPZ/n5/q7+33eebW/v9/rN092AbqrVdsdf49ADsRgk2ANeDXDKZxu9ElmD9Oc/bBz08l47y4tmvr9mLyi5JVLA4l5N6ouNzeJJprx+U/D9HGIikse6X9oKYLyMXKGJp6zuD4xqcGcm1s8qYjjIJo9hLY8Ba4mBQPi74DEj+zoY6naIHSwVOKdPHmNEt5pIKB954RFXBfap/JZWIx4ZL5FAQywlMZEDxk0wxKJF/epKVjdC47lwNDkh0t9hznoK8Xr6jIAwCaXjykeC7n6ELJWE+q6ZgE1CVTyuWFfuCD/c2D/o7o70dzvvPdrb2d4cHI769vXmwe3CAq+fQMvDxnG1W/je/9E+geCMThvaRyf8K7PU4YE8M0OIPd1mi8QD8sUXzY2sxA7/Mic8Q5jl7fnTCdvZZxtW4pOd8vACCii/O0GWgRuPDKkrONgITb40cS7WKFaEwwV5GL16+Gly8Rtc4ffnrxcsz+IS0ltrgAbSOKkWz1JQIJ/qaOA4CXHMoegXGeQyknUC1AwJxZdsDpf9mpxbAZCFiw4yw+ooZbdJsZHQ+50rkN58deyK7orsBWQ2eQTJJJmzIIb0xUCGl+gFE+cLFrwOSnZDjn3bZoI5lPkVCt8+nmB4hyPn+whfB4MqCSgJdOsygMhHzumignNdGE01et5WCzgGc328ng8RBvU02MeeFtbUEFoN+gGeP3Dx35y3QCFJspCAtJ1TKJ9pAOQGRCWSTUN+EcES9DAQeVY2rI1Y7SFK4e+OZeeE0vUt4aR/gdycZhJ+YRKtffBLB+ajw9dGItFGpKUSk0J7Q5DCqVlfl+L7bWvvu2nfXvvtA3118eRpK6PCWSp+t5dLnQvES8DWUPJdKH0PWozSrBlF5ExS5wQCQUCL9/O4cHPujUDhefC6wFfgD6yOfypeYH9T6CBtL1b5TlfobXSCDhKOXYASRSKSHxHfDsS8SCart5dVeaTOUYKBqRYkIUdOwqS4ZB8hMqWjnk9sNlmph1Y8utIXgEdb6CIirqjT2Hdi6klxXkutstM5G3002WleSa99d++636bt3VpI1V+QtoU6yZZ5zM/WWFt6jtJzBgGZ/vnY5UtVitYLEWF1jRfOVQzTsbw23RvuJ2En5Trq3fTDqJ3t9vru/tb813OnvR+1cf9n4ce1k8z7V0rfXI0EMRdwnqONKBcZlndbp/PZfiT8vjzCsYeip62bAHCC9qmrH3VU7jMegEYNWeuaXuGWr0dfbXAELUJJ6r6krn3WFuK4Q11lmnWW+jyyzrhDXvrv23W/Td7+gQgzV0O0VIgx4cIUIY7ubrK6lXtGxgT+7UCRXCRyQeTOdJKWhDc+qCqS6As+eRnSeFWMInsE8jHp4/iD2JyPjcDLS9m7qs6OzXn1UIcah8G7hvOas15xuALq+ZPWilCaDJaqTHjcwDTQ76/JCdqszAkpf03GPIcC6ImLhj9veO3EAHSzxC3RJJ0ai2fsYScS9hsLxjag+UXInZRWOLkx1CVGRyGwwcJFggvQYWCy4mv5oaXSXTG5JPpDrwmSzr5fFE7pFllXw3bkajGfA6YKIKMIVqgtMBY8joL4ugJ8jH+AGJZrH5VV7zBkW9J7DpZFNksI2pL/E0Fsc1mfPBTfQbfid+Sc/vzt/ysZYxlIY8cc0hcS+AxzxBMyIwuSg2qXGSZS5msOAg7nfAdAt2SgDUFg4jVQdt/gF8scpBHyCHScJijE46+FnkfjcvFvOHr1XMXshjT+q5M/7BBH9+azLopKLt+R6LBM/VNRiTy0maniUdI4LD+1l4s+VJBAbvAtbQuvRi3t6cYseNmfwBKku8oBIBD7mf71JKq09mo85ejHSm+fjvXo3kZCj56dVx/HthA7gHbNkorUV/2QMTQdd5XJcgqc9mq1rXDQmj4j7my2WYr9kLGOoOIm/1+AYyhsTH2LGp4JHQy2oUu+2v5FmIS78RmcCf5uTmR5fQmLGkalOvuCA3QLPuGCMC8Y+TtjAv897aFh42glkoDjgDeCo0T9FgsBoKzZ6WisjP5Hv0RxMHwmwSlRscei/HDZBMHxi9AJH12MgVGPBXv+eBd9ZoIXJbw6saqthEcFlfjMNOXcBN89vvdmCefivJi9KPGh2ZN6qbPpHR+lbIslfJ+7+nyLeOtJ8j5EmlNBobrRs6DXaRv481HTLO4SWTonDv/CWfJWqdeiFmoPhbUJFxh1aNXl1MpGC9hYKwR3WhxtoWTonTyyMRveHDpIIjQ2MAbe1ULfyocyAXpedNytzchhffKJe8bstqcHBtZIJ9Kqiy95Bu6cSUAu2eniCAN590KHnOwPNnKBim/OxUHTlealgNfTLMmccTOoei0ilTUofuKDzU6LCQlPpV8+qvBhNDUXoUtNjcvt2hNvW0BG3FH/PWqB3G/asAXrUYjge3AhyKjKyTBw3X9rfRxusLZ6IrMBmE6IuFGCitcIbOjI8TxGIKQtyQVOvzbgXJtkejgUi2EJ589nubnU3Y2op4HmhrYP2uEX8VEAXD+w9/jbhosXeNBv7f/itxZB+sG/oFbiPhkKVvtfxHelltKojhamH7fuMC00pvl6+RtjqS6GLmQB0SP7mBndqsFGb4WN/AQS7H1AmelhzY+BWVP52F/tWqu2jwO2T5vJj2CKJ6J7kw8Fc39Vr39W7A+nmsuMjkf57Xci7A8n6wuIjgfy2btfdAUR1efCROKzvxX179+LusIbq8mNjDVfNxuQXpsgnp+H+3VN2ftefEFjJTvXzm5q2uakzTl0HfJm1tlj6wr8T8AgmF6uR2RVM8XZPSPpR/lei1vylcxSognrn/qeXUBzO/gdn828o +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Query Parameters

+ +Succeeded. Returns a list of identities for a potential role. + +
Schema
  • Array [
    • attributes object
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-identity-attribute.api.mdx b/docs/api/beta/get-identity-attribute.api.mdx new file mode 100644 index 000000000..9b728520a --- /dev/null +++ b/docs/api/beta/get-identity-attribute.api.mdx @@ -0,0 +1,99 @@ +--- +id: get-identity-attribute +sidebar_label: Get Identity Attribute +hide_title: true +hide_table_of_contents: true +api: eJztW1lv2zoW/iuE5qELImdp2kz8MnDb9CIX6TJJgz6kAUpLtM1WJjUkldYT5L/Pd0hKlmKnSRfMvS300soSeXj28x2GvEx0KQx3UqvDPBkmU+EOc6GcdIuRc0aOKyeSjcTxqU2GZ0n9jTUfbXK+keTCZkaWRAU03s6kZSBkGVdM1jN4PYNNtGGcTeWFUMyJbKZkxgum+FwMsJQVWWUwActdJqdWmGdaOfHFjSo3IxZkroY10bQ0eiILkTbEh0bwPDm/AlMlNyDphLGelCTWSg4iGwmthV/+P6yYzcScJ8PLxC1Kem9BTE2Tq1XBxFKMe3YN80b8p5JGQJPOVGIjEV/4vCyIZi5tWfDFK1qSuDPCllpZ6A/r7mxt0X+rq63R3mfpZszhW1BglCEjJSlHVHhZFmCKqGx+tETqclVEPf4oMoeJ0CAcwMnASFDMdUWs00NXdqYnnqdVfpO2EiqZe622dHGnxcaVlUpYm06MFCovFt+yaO2zr/RnRv7kZQQX1nGVc5O3WBhrXQiuVng4menPlsmw3NIUcPN7NZV7DF6diwmvCufnh6fhhBe27QjkF1g8LHgnRWPEHSVd+u0ca8tvFWyNs0FCTyq94EUFt/6KYP43qVVwk834uBA/Z/0WvdvVahfWifmdF3aUqbwV/bx761hwM+5YroVlSjs24xfwAGZ1ZTI8qJym0wcE4EROK0OMDu6kJ0/Crsb9kbSODB4HhHSplhxtBLZtKTI5QdwyiOL1521Uu4qpCq++XBjkCbJc1Ag3hi/wU0Jge3tG+D5HDbx3nJMYItdcR365+CrZqOrWtBZVZLsmEoaqKoparyG3JAcYphcCk66uKOqk87ycBPY671bL3pX/vrsuNz8rkIccOzAGxknZsXCVUSKvPZnKgIAVxzpfkBGkgm1kPvh5iToXjsvimc7vYJwXyJ3p1HBJHArPcoaJpNILmWMGm2sjWCBZW9CPG3QsCE0MttlTnkPeIN+zKAyp0fDsE2gd5rczdKok5rN6CqLOO/kNy4o9wcdPtvZ3didPdjnf+efu9t7j8f6EP3q0tf94f9/nOxQHPu24VO3n3aX/EAoBkbFCo3TJ/0IhAAzQvWfAL3730PA07hgcYWwjZuSXEbDZQD55+uwN291jBVfTyr/n02tKUOnpCSEX+HjIrTHjBcKvjZxKtY4Voao5wabnBy9Gp0dv8eb44N+nByd4Ilor4G0EyKZyckuwCl+ok0sU4DOnjFxAHSIfsIeR6kMIxJVtD5ThV0isdWHEjLj6mhlt0mxi9LwTSllAgey+HIjBBhvTuzl32YyNucUEmJCGPxxlmShdehQ1+ZDNAAiFeTBgozyXJCQgi8+UKG18AUKM5zmFbiAwqRDKAWXpylFql5no2mKpyq41lrnkqG0UCg5wfrufjDJXgTkvZjsKG2+JLEb7gOeguS53b1tK8ypdKMczR1ANuCnTxkDDQFSOSSD0mI5CoZ1zVY9rMlY7Rfp09zIw89xp/y3jlb1D3L0pkH5SL1rz4ULE4IMb6JiNvDVqM8WMhI9uFmKlHtWYqw58hkpY5H3s9rHbx+4dY/f6x+PYkcavHvpsr0KfU8XRiWvji+cK9DEiAGJWD/LwJhpyg3qkCJH+fPcWgf0JHSzGiy8ldc0/ER+FUr7C/KixR3g/JvjRGKtjC2LQ6zFIMEEmEvnQ873k2CsqqOrR6movtBlLOKhaAxGRNQ1b6IpxQ2BdKeKE2w3faqh7daeBiLA2ZEBaVeVpqaVyPZLskWRfjfpq9PtUox5J9rHbx+6vGbtfRZINVz5aIk6y1XzOzSJ4WvxO0nKGAaz+2whrQs6b6jpaIWKswVhJFzkk453t8fZkLxO7Od/Nnzzan+xkT3b4473tve3x7s5e0q71Z8s4boKsG1Mtewc7hs1JYS6A4yoF57JO67y7/Qf1GjGhtEapp8HN0DlUer7Ejrur2PGVdpANhIEdzQ3bi6fHR0QfS3vypLewWUpB61V3bfdafJHW9dCxh459+enLz29Tfnro2MduH7u/Zux+E3TcvQ067n4DdNxlBLEmBLH+SuiYA3cQNJvAKJAhq6BeRbCxhCh4iruPMewdN1PhGqDXQZE7+2vOEGnNXnK1qMGS7exEqqW6KL1h7JzGmnosBtTntJC1JNAteZWcC8Kk8B9WyLn0cUwCga5ZpKOJg1QhZmp/a1aRKiuqPB5ZKDTtvWr4mIQ7iQnBP1Dw+6BTJOqfuMcZrfVD+8HsmCQ+IonZwZdMCIr5Zv/38bpTAodg3lC6OAm2vuG4QNgz5wpthPhShvTVQNAeqvdQvS/3fbn/Pcp9D9X72O1j99eM3W+A6hEN3QzVMeDOUB1jB1uswVIv4gnr/y9i96ESOfDuzXTmsXq+xOAeV8CV4j0KyiF03WCYbDb3FZrTqnbzks6hXyV0YJrAYeCrMgXGz5wr7XBz8xLmgpmuBryUg5qG0p8HmZ5vjqGjNeknHGgm16EBbPTmMHYaA69gI8mHQ8LzxIO641nlxELt/oDBVynXh+8XaEJYILNBx3+jP/nXYLFEM3HPxrsRpJ4V+SDXqSmuflyWQOgGWdap76urYTwDp9dEJBHOl/dTTgh5h9VXbqksqwnt+e+sLPaahu2wp4IbtAXhGMz9P9+9fcCmhDd9vNOVhykTkhoERMwbuIjPZ6P6SAhN8iXG6GoaroSMOoduKH7YpIDA7L06EYKdta9CHCMze5XSJOGTAc06v19bJxcXoqAaOFhqkhxP5moTGtrknXkPfL3zjYFUeJz7t4P3KmXPJaUhSXWbxkQRfZ/HzspaLt6S63uZ+EdNLQ3UUk/NPrjGRVDtWRYOcWcIYiLBC+u19d2LB3ppix51UXhDVK/zQJqIfHSPSmW11b6bjw69lOh1+Xiv3s0kiml3Ggu5i1nUwiJnhyybaW3Fvxgj16EwOJtWiKLvZuszLZr6iEh3tlospWHJVKaAhp6/IwSGCs7Ex1SaPTLRYZPEh+QHb1nE/Ad/CeNDR2b/+gwVlEbmOrPfzTMtmNKCacgBNvIfChQ5FmKbZPB5IDjAs6X9fSaIjLbyXqC1Nqt78pt+DpWGDKx6KrYchh/DZYKLT8x/oNHNGKRhQtbN4TH8ZpEWVamOsuo9gesaXOW30CiO1/QW+G3+skkF8+8mL0k8Wm6dvFbF4mdn6Rsyyd8n7/5FGa/PNL9jpolYl9zNL3vtAhU5+dOI11a38miveSbwL776WPWwGk3L8mJrm1BZcEde7aM6m0nhNwFKwR1hvw3yLD33kYh+ncIfrZ4nNDUYg7C1wKR8LAvQ89vU9crcB0wAlmRX+m2reGhCwyXRVIoBe4e+TGUwC/VkdFwX3z7q2JydwDJvyLDseW1sgK75vFJ0hRBsV3PG4VK3eEQubVaFxIUWTYlaF9pDv2ZWHcXkaiTCwHcnZm5fT2h/Ga1ry/C3rAW727i5DNUvb/4mS0GOReE9k8Z1YftttOFt6UwUJXWFyLoAYKK1wsvDtysUQUzFv2hoM92Mk+wmjQURao+C+zwabA+2Ut8u0FVCbR362BbxP4Rjq3fUr3vh5XJX/Qcvq8cCQsh/s6QtK2KrCp1IaP7owvpK84eZQ88x+okZhKBhl5e0uUHt0BW9RlNPnfPZ+bLT8R0ilEzPeXOx9EbJ7h/Hy+gP/J9nvn5xfa0g9Q6dWiyb8wSPnwT19OEe9TnGhW0Xz174FDZmWpNW/nRBnVTTLP9xQC7BbyjK8QGqQNr5H8zHqHk= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 Attribute' (get-identity-attribute)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get Identity Attribute

+ + + + + +This gets an identity attribute for a given technical name. + +## Request + +

Path Parameters

+ +The identity attribute with the given name + +
Schema
    sources object[]
    + +List of sources for an attribute, this specifies how the value of the rule is derived + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-identity-certification-item-permissions.api.mdx b/docs/api/beta/get-identity-certification-item-permissions.api.mdx new file mode 100644 index 000000000..0fc22980a --- /dev/null +++ b/docs/api/beta/get-identity-certification-item-permissions.api.mdx @@ -0,0 +1,99 @@ +--- +id: get-identity-certification-item-permissions +sidebar_label: Permissions for Entitlement Certification Item +hide_title: true +hide_table_of_contents: true +api: eJztXG1z2zYS/isY9W6aKJZsy0oca6bTURwn504S52y5uRsn00AkJKGlCIYgbase//d7dgGSoiQ7iZtpm5y+2CIJLPZ9H4AArxomUanMtIkPw0avMVbZYajiTGezfZVmeqQD9zBT09cqnWprcWUbG41Mjm2jd9aoNbONdxuNUNkg1Qldg+Jgoq3ovz4UqcryNLYimyiRVKSEtNYEWmYqFBc6mwgZC2YgUlP8F8E8faHBhxhKi8a4IlLLz7+34vBpW/RFZn5TsSN6dPz8l/7Tl4evhEnF/sHxwF/JPJuYFNIKcJmqD7lOQTozIpBRBPqO97Y4VudaXajUihEI8P36wAHYlpFd7NggdSSpCki+Ri9Lc7XRsCrIaUyo76pxalW6b+JMXWZ9MEMq1WHcq1HvpUqGjXfXUG4iUzlVGTjh3ppU/CFX6QwjxXiCy5GO+DkGCiZqKhu9q0Y2S+iRzVIdjxvXi0Z6xl2gAJtHmRW5RSvWrs1kHMo0FHYWZ/JSuG5D6EjH4uznHbbsSdFo30SRClgfr0s+392bZFlie5uboTpXEflb20odJUbHWTsw003IuykTvVkM1gpKOq1K3u+cXOCs5fm8/zZ+Gz8r7pIFbZ4kJiVXcmZS+B9F5oIej7SKQrhbDNdhnzep7RGFZjOTKRy/2eyJpvqwIexF091P9XiSWb4fSL7Xh3GZkDiXUa6suAdjGpB0zDnKcWjvC5nCN+GoLR1bFVud6XNVOQ/5BtE7iqOZkIL0HSnRRNcmeWjTpE0B1SQGHVWNONgWUzkTQwUzqbAtDjMxzW3mvM/fxf/sQsH5pXCyFSRIeimcXP7ehohNVnbo+Lu21KCF/p3MzPEz3FaXcppEamNBw5ALWtFhT7z/0VP5wQ31IJAP7v2z09k/PugPDvDj/gNw8sDx9kB9eIBbJ/89aR89+al/OvhXB5fvabDBIn0df94I8w9PDl4c7A/o0XvEhpcBzu81pD6It415Jt42ECg+xBKJ0CwjrBacyJu3RlqRVYroX0yPiyns8GmNOzXaeTza6+50d9Ve9+GjzvDhcPi42+nKh4929nbDxzfxSJnwS7PG2XeBv06wt/146/Gj3e1hMJTD7tY2foVgNdx7tN3p7Fb8LaSpSE911lgc9CWSTJxPh+TuozIhISG78gEXPFHqT8489zkWpgYRrWP8nLI2KLdXChwh/NScXjoPt1aoHuOqsUrR05Fxt3Y6uDHVsZ7m00YP/aby0v1mKqEaSWiBr65v0qYZjaxaVucR3wbb0CAHa44E5rQq8KAtTm2OgjUTNlEBDF0U4SZbp0mKT+RYxyhf6J+afDxhOt4wX405/oAxSvXfrPzA5PGy7g9Hoklx1UTcQKtQfGKSPHKqRLL/T2tgMhm19ql3k1SaAA8pMUGxh/uzHajhinCYSFA0eUSJ3kcGleRRaTfK803nE00B3AJVjWNozOXwEx0HiuGOshllVpQJYkWwIIxlJhLlShJQY+VQez1NZJBtkDQMlmAxILQQA1MBgaegzmHUJhP5gSVvEk/MLZdLpwVXblz1Ym6+Cg/y0G3RiYbGRErGjTk/4Z7XBNYKk1rq0Nnaon91H+mLSKN2w7a3QWLygjHwg8vAnNUDgoxwOlCUSRL5DL35qyWyV8t8yjSV5LFEwM7dN8NfoZ4l3z2BsSOXD54OjkosUE0BhOsIyJWRWxEcPIElXpMlAMBDmUmC6W1BVYSuyGfkeJyqMcs1Ss1UBMAtZgrftjNLfLHbot0oVapFdgEWM5AZD5JEwXzkhuSd5zKdiYjqdjQroUuoRyN4OjlwpPHPbhb0LZk2SclfMu2s4YDBCgUt2IfBvCoQ0z3VHreFZH+CF7FnM56rrAccBrhii+mJAxfsWTIktFd40qIhfFWeL60OsDSQdjxGWdV8uWZ7PFOfZ/l0MYYOIYcXp/D5OmdzDAANPf/5l38MjvuvTvr7g8OjV44bmp3heeUOTzODJ9f0sLvKz/fZIuIgTeFJLUynqpTlygmnIjE04WwO5rXv4OilQ9ftHaoM7rlvQvVxJT7TsWpBU5o4VMxygI4CFM91SPmSU4cjSbFLInC7ds1+0ER7WzyRIeR18u17YUiHqQx+Ay2adn+ModNYo78oughdzW9WDKt2lRw+2trrdEePulJ2Hne3dx8O90ZyZ2dr7+HeHo0+VdbKsfp4ADxXMWZXgYgMJrb6dygE7gLdMwM8+G1JpW4DpvEJ+icndm1LMT2/gqbJG6hLT/Zfi+4uUkA8zvm+HC8oIW6dnlCFBuCRwyKBQ3JH+AgRoOOV4RdT3T9rPD141j99McCd44N/nx6c4BfRWlrf6CMpxyG5peEaPTEXzLEX4EIiRSoqQTRXa3qqTQgk/VqIb6jdlcuEwhcT9PCjr+gxT9rl0/lQCtyagrin26q9gSSJe6hzwaS+fNLsB4FKstYLr8mmhx/326IfhpqEBC7wk10/75Rh6DK+Q5QIZcV1yuQZFXcdqLotKlXWrVElkhfzRqHgAOcf95N+kAG8sk/UorD0Fs+itw94dpqrczeYUxqrlFY6kOEDxsWBSYF0kJkgGxUin454sQGJJy7alRlrPj9yunvpmHEZEvlM5vYT4u51hPTTYtHKB+fKBx9PiFw2YmsUZvIZyWN97uxbleYqAt/N6Nexu47ddex+YuwuPjz26L7APgR9tpehz2nsF5mpeC5Bn5S9JzbFSvTvbqXFGXKD1gI9RPrpzcAvaKO9ukxolvIF8ZEr5SvmJ4U9/MpvsTBclP7KFsQg69FJMEImUmGP+a44diCRVbWzPNozkw41HDReARGRNVMxMzkvrKZ5HPO81W6I0Cgbf5/5GSsiwlqXAWnUOGy5yeEaSa6R5LoaravRN1ON1khyHbvr2P06Y/dWJFlyxdHicZLNp1OZzpyn+eckrRRoUL06KEOOTbWIVoiYKDFWo44cGsPO9nB7tBuobii74aOdvVEneNSRD3fphV63s9uYr/VnVRyXQVaPqTl7OzuyigHizoHj8hjOZTNjwvryH9SbqhGlNUo9JW6GzqHSdxV27C5jx1cmg2wgDOyY3rC8eHr8gujT220iT3ozeRoogtlOdW5JlyAlv6ZQl9pma+i4ho7r8rMuP99M+VlDx3XsrmP364zdz4KO3Y9Bx+5nQMeuIIg1Ioj1V0LHULv9JiPNWxmDPOVX/intsrX45Vcffdj7d+EF0KuhyM7eMoocGCNeynhWgCVbW4mMK3VRekPbKbVNi7aaNly6jRrIWhrolrxKTxVhUtr3w7tzKI5JINBNZ63+iPZl+j0/3t/KUXQcRDk45KQQGVp7NfAxTRtoRgT/QIHXQcdI1F9wjdNb6w+tB4tjkvgFSSwOLgOlKObL9d+Hq3YJHIL5lNLFibP1DdsF3Jq5jDGNUJeJS18lBF1D9TVUX5f7dbn/Nsr9GqqvY3cdu19n7H4GVPdo6GaojgafDNXRtr0lSiz1jHcl/9mInUPFc8DuLUzAWD2sMDjjCriSP3hIOYSOsPQam7VjJ3bzauHAzfWme8/fSvlYXotz0uaV2xx9vZnUDiq6eYMTI08jkC82kV/BurDqdVsmuq39scfYXPBO8iFUuiJb0eZUF5nUgPesuwHabI9Uk8u7/MjEnXX8zvBGuVn9Vsp0qoDMPsOcRTgyGwLh4d2Pb9PhMMw9vrfcus3utiQf5DpNo+s/LosjdIMsq9R362hoL8DpgogkwrvqcOQJAXU3+tIRyar40CuCztJgR9SsI54omWIW4XbN3PvpzeC+GBM85fTgzjgqTfMJBNhruAinv36xg4Q6cUWqTr30a3t0KNzEKILAwh9iKI7OvkJdOEYiZ5VSJ8W5g3p9+hEGWet3w5GFt3FLPNWpO+Hgzux5Ed2xjrOkkEvOyXVXJr4rqLV8/DE1OodZ48Kp9sztwhcBYp5IyMiytu48uKPXmqPX4u3sLaK6yANpwvNR31kVFFa7Mx81ei2iV+fjbfxmolF7692ES3XCTngj/qEIJsZY9aMQ5DoUBmfjHFF0Z7YuaNAWR0SrszXHUssN2dItIEnm7wUCI3bOJIdUyRnIGLemwiH5ni2LmH/PZzLe12Tm22couNQyNMFnnMtZ4JkGbNGALZcDrOff1TNyLMQ2ycB5wDnAfmV/zgSe0bm852itzOpMfpP7UGkIwCpTsUnPXfSqBOd/CX5Arcs2SMMExMu9ZnTk29OiolZTVrGEsKjBZX4jg1q6oDfHb/kilOrr301ekrhfrbTQSZIvnaVvyCR/n7z7F2W8dab5FjONh8bkbjysn0PMO/kTj9eWV/4sHy7FXzzlWGUUjjlOdZJwnlASyYy8mqM6mGjFawaJouN7dMAfQpgpRyKm9xT+mBkyoXGKNnRyD5hUDnUEeryqXYwsOWAcsOSPDuDa5n6PhYFLYg6q2uINpnFxALPQFI529+LZr8bP5coDheJpYWyAruk0j+mDHWA7nwoJl/qIR4TaBrlLXJjRxarQhWHoV/YqophcjURo82QmndqjES1HY6Y7Z/iPjAW7W78WDdWTFf1J4UqQYxX5T6ZsLMD2j9GGt7UmKkpoEomsCwCm5kZ4eThYoghisX8BYtLxpu9kN6ktiND0yLnPTnu7vdXi6QLuJ8ZmmPbOEZ/7BAznxYO5D7Xs179igLnYondeVYvz68/C+NpIk5rNhBbvSOO5m2S5afBZ/TsT5Ci95S9PrJgJU8PyoPD8ZBjTqwlsSqSvrkhdNDu8ptvuQDtNkeFlFPrVCegbTbj+aMz6ozH/Zx+NWRm0vylasau+uuRX5dzXYz49nL6uL5/cooniwy531MP/1ydLbtFj+UmXOypy/f2Rr+/7I7e4Q/GRmcob3lWrtJ9Zuu8de0xzn3eirPgA1UpGijeQ8Wyej5LBBWzyed56K0vVh6fuwJeHQtfv0NL5NmvLPXSvxOa6LW0aITWXrymeHxC6ljesb/gfvTN6wfE/BSeBIg== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Permissions for Entitlement Certification Item

+ + + +:::caution deprecated + +This endpoint has been deprecated and may be replaced or removed in future versions of the API. + +::: + +This API returns the permissions associated with an entitlement certification item based on the certification item's ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-identity-certification-pending-tasks.api.mdx b/docs/api/beta/get-identity-certification-pending-tasks.api.mdx new file mode 100644 index 000000000..963b2840d --- /dev/null +++ b/docs/api/beta/get-identity-certification-pending-tasks.api.mdx @@ -0,0 +1,95 @@ +--- +id: get-identity-certification-pending-tasks +sidebar_label: Pending Certification Tasks +hide_title: true +hide_table_of_contents: true +api: eJztW19TGzkS/yqquYeFFGODMRB4uXKApNgigTNQeSDUIs9obG3G0qykSfBSfPfrbmlsj20CyaZuN7nJA7FnWq3+r1/L0n2kC2G4k1qdpNFBNBTuJBXKSTc5FMbJTCb08lyoVKrhJbcfbbQROT600cF1VKOx0c1GlAqbGFngd2B3OZKW9c5PmBGuNMoyNxLMOu5Ky3TGeJ6zwnNma7f/uTq+Oj66Zdqw25N3v533z970jy8ubteZw2lZBi+4YjLIxxI+LrgcKpbMS9FiPeb0R6HYZ+lG7Kz/5rfe0duTd8j28Lh/Gb7x0o20QTYgoRF/lNKIFAYCVxDKBblbrC8+SfFZGD89Pa9NB/QK9LCLA8FIBTd8LByMBVPdRxINUnA3glcKXsA3mcJnm4zEmEcH95GbFPjUOgMGiR42okqu6MCZUiwbVzxlDHZyFD3cICNbgIOExWk6m5v4X51Zj+XSOnTKcxxSnwTdw/Tgd5E4i4onWjkQCyfhRZEHsvbvFme6X1aYG8MnME46MbZzzz1LtKTBKHXSyw9WWzLWKtuQWGRicQfWyWmqQZLGItvqxNvdnV20cU2Vk2eyruu/MIfItl9m+93t7p7Yh0k6g53B4GW30+U7u9v7e+lLnNVPsTyVUOUYE6t/3Lu4OHnzLroBYp8wXyL3noIHc26CbxdXh4f+03G/f9YnZsIYbewzrD8Lw4VIURPmmTBxJ5LSYbC4yt5rZ0TH8/XWvFGubx5Qa+nIQitLDNaW6AH/bUTdVSF6mEsYxo5xbhZDZmJJgaSVGU2PySIghAc6paSW6hPPZfotAflI4KXCcZkf6nSl6+rCvpZKxEPDJUpI5mIJDGTA8ZOk/BprI5hniWmHKhBdzW5oidYWe8VT0NfrdxiUQXsannwEXs8J2yslYTyrhkDQhoq2clqxJ/hgd3O/0812u5x3Xna39nYG+xnf3t7c39nfx9nHwlo+FKtiqT71G6GEkQnLNdRI+ScYxAgOticBaPLnJz/xeIb9MUs97VTNIC9z4s5tMM5eHZ6z7h7LuRqW9JwPF4yg4itMHlXmOR/gIyzDoLlnfGbkUKovpeXR8eve1eklPOkfQ4pewCfktbRM9qCGQNGFsARRIRZG+jNJHBT4zC2zIgdziLTFXgSuL0AhHpbUQCjDAjuxYEyIrYyXuYMRYfYVI+ZZs8zocS2VKG/uHFuTLdHaYAN8NuYuGbEBtzAAaz+Qv+gliShcfBos+YKNBE+FWYe1OE2lrwcMshGYwvgJMGI8TTF1PYOshFQWtGDr0jGlnUxE3RczU9a9MSsqp/NOweQAyZ+Ok17iShCO1JzPwmm0BBGDf0Bmb7m6dJdzRiOTTpTjCWgBmADWZm0MWJgNQDfpLAvlCN1lofCoim5aseZrJZW7t16YI6fpXcJL+4y8O8+h/MSk2vTFJxGSzyLY8dWIvFG5KVQkeEk1HQcHqqm7qsRnmRR52uRuk7tN7j4zdxdf9gMwD28J+mwtQ58rFfoVXDyXoI+h6FG6amr+9LDUO3ID4XuASL++vwy9kUTwVmBv8R3xkV/KV7QWlT/880EFGKulf+YLFJDs6DXIoBKJ9IDknknsQSKZant5ttfaDCQEqFoBEaFqGjbRJeNgMlMqhZJwu8FSLaz6xbERh/rIISOs9RUQZ1VpXGipXIMkGyTZrEbNavTzrEYNkmxyt8ndHzN3v4gkp1JRtgScZMvxmJuJj7TwnnbhGRCwaouYTVOOXLWIVpAZm2KsqI4cokFna7CV7SWim/Juuru9n3WS3Q7f2dva2xp0O3vR/Fp/PcvjaZLVc2rO396PZGIAcZ8Ax5UKgss6rdP69h+Y14gMyxqWniluBpuDSW9m2LG7jB3faQe6AWPAjuaR7cWr/inyx18EkD3aTZcmEQizvemAnDuClBjDYGlpXQMdG+jYLD/N8vPTLD8NdGxyt8ndHzN3vwo6dp+Cjt2vgI5dhhArQ4j1d0LHFHAHQrMMnAI6JCWYVyFsLEAV+BR2H0PaO26Gwk2BXg1FdvaXUeSl1uwtV5MKLNnaTqSamQvLG9COkdZUtEDA2RBKpGJQtSSgW4wqORaISSF+WC7HkvIYFQK+ZhL3Mgda+Zyp4m06i1RJXoKEVBRyjXuvGmJMQjiJDOEfcKB90CEU6u+4xxm89Zf2g1kfNT5FjdnxXSIE5vx0/3dn1SmBExDeYLm48L5+5LiA3zPnCtoIcVf48jWFoA1Ub6B6s9w3y/3Psdw3UL3J3SZ3f8zc/QqoHtDQ41AdCJ4N1YG2tcmmWOo1Btf/HLFTqgQJKLyZTgirpzMMTrgCQikcXscagkesD6J27Yyubd/L9KFNB8njcMIZaH0/4MUrTQ7DRs4V9qDdvgevgbceWryQreqUtdKfW4ketwdgqhVVCA+d+oxDAjr37idokZ2NxFD2dY+Ye6uTZhi0YH06Z/BFznhyHN05gV6EeTYbDMI+hBU9BhEL6Cl+sUTdojBa0g/0ujL5w1/XxTN6RJdV5vvibEDPQNIFFVGFG3QXuB8Ykb+uQJ5DX7R6Jbr8+mae5gJBupdwiXK28ODPA50lgc6QrMNeCW6gg/AnZtZ+fX+5zoYITak0lBZRsZDYS0BynUMYUenrVadHcBCtRkaXwxEp16udz8FUY1kORmEf1IUQ7Lo6F/0O1oQ+FHEyOw4SVDdw1M1a5cFUfBI5LpetmbUxOGWq2mDFNq+NW6elkXoIqeDj2F+W+KBidiSxYmGSEE1QkVpCdl1UevE5vb5ViH9V3GLPLSZudn1BCm/a68Sf904g35EFzy1Z65sn9/ziOX7YcMET5LooA1oiyFE/VZVUXvtmOWr8YuRXl+ODej+SsO7WhzFf5piFZTNP2QlLRlpb8W/GMHQwVa6HJWTaN4v1GSeNKSPizuacSLGfMpYxoEiS7xQSQ/lg4gNcxQnEaL+fQml7S56FunALPXbKbms60+NrWGyRMtWJ/WaZccIYJ4x9nbBBfr+WYWBBbqMOVAd8ABzO/E+VIAg6Vxs9r5WVn9i3aQwuHwmISlxsceC/HMyKYPjE6AVST2mgVCMIn54zw5tDgRcuaDVjVdsHixZcljfXsI4u2M3LO/0RFNfWf5q+qHFvtstypvLJ967Sj1SSf07d/ZsqXlNpfsZKE2AxhhtNu3DpCoP8VcB0y7t+uC09EvAX3lKuEgKH/sZfp0QUM8+oyLnDqKasTkZS0H5BIbhDfLiBkaXHlInQ2mP6Q1dIjIYGaCBtLeBWPpA58KMd7WpmTgnjwSf6Fb/bMpyv0BCS0H+KFnsPLZxKwC3YvuHJXnj3uw593AV45hwdy44qZwPoGo9LhTcmQexyzDiE1BMRkUqblL5wQTenRGULTdBvOqrKYgw1VKFFjYwZ27MMt6Khy51z/BNzgd9t2IcG06MXw43RmSJ9kYdbtxsL0P4p3hBt8UjkBTaQUHUBgIm5Gd6eXC5xBGYq/PihzbAdBtk20gITbKF8+Gy3tlqbMbUU8LzQ1kHLO8c8XCNmtYt/rLpVXAvF+9ku/P/3NeKwCGL30i5whw5NW/qOy/e61/VLrGjKA7qTWm93oTkagUeQ/v4eN3Ww/3vAx3+UAncMrm9mrR21WBAx+Bl66wxkW7yAPO+htX7QfZ1+lnrGteRHFKs2KNVktjcRwcePArc0QKsHvMTq95xIRv/C70rNDVn63QZ7w+lOwZtjCNyH/wL99fsw +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-identity-certification-task-status.api.mdx b/docs/api/beta/get-identity-certification-task-status.api.mdx new file mode 100644 index 000000000..3191d2e4a --- /dev/null +++ b/docs/api/beta/get-identity-certification-task-status.api.mdx @@ -0,0 +1,95 @@ +--- +id: get-identity-certification-task-status +sidebar_label: Certification Task Status +hide_title: true +hide_table_of_contents: true +api: eJztW19T27gW/yqa3IctHZJACFB4uZMC7WSHFm4C0wfKbBVbTtQ6kleSgSyT777nHMlJnISWUubutuOX1rGl8/8c/Y6Q7ms6E4Y7qVU3rh3WhsJ1Y6GcdJMjYZxMZEQfL7j90nfc5ba2WXN8aGuHV7XSCFu73qzFwkZGZvgbiF2MpGWd8y4zwuVGWeZGglmiwnTCOIsWCTAHPBqsw5z+IhS7lW7Eznpv/+gcv+u+Z9qwo5PeRfjFczfSBoRkwMGIP3NpRAwTWcTTFNh4vg3WEzdS3ApjWQIE6H2ZZ8QV46ldnghKZtzwsXAwF1S9r0lUKONuBJ8UfIBfMoZnG43EmNcO72tukuFb64xUw9p0s1bIVTt0JherxhFMBlMD93HG5VAtSdc9BjpreaOtuj/Mf9X+xPIa59oMfCosUm5tbeF/5fmddbP14LOIHJov0sqBcjiPZ1kaRjU/W5x8vyq2n4l2NxiRTnrWYOMV1dZpQtzJIeIObJnicD6I4rpItlv1nfbuHlqkJHH3kaTLai7xEMnOq+SgvdPeFwfApDXYHQxetVttvru3c7Afv0KunsUqK6HyMaZR76TT73ffvq9dw2CfHl8b/r/Lk8uTY3jRff/Hee/sbe+k34df/cujI/900uud9YiYMEabRWLcGD6BIdKJ8Rom02X9O2rCPBEm7kSUOxhFWUz2fnFG43i60Vg0ytX1FLWWjiz0YDmpTac4rr0uuI5SCbPYCbJmdUhjrB+Q4TIh7hjZwjo20DFVAKlueCrjZ4y7WDgu0yMdr/VcWdg3Uon60HCJEpK1WAQTGVC8kTFabKyNYJ4kFj5UgcaVzIaWaGyz1zwGfb1+R0EZNKfh0Reg9ZiovVQS5rNiCsRsKH9r2Yp9wQd7WwetdrLX5rz1qr29vzs4SPjOztbB7sEBch8La/lQrAulMuu3QgkjI5ZqKKjyLzCIERxsTwIQ8zXR94APiMYj7I9J6sfO1AzyMifu3CYsNK+Pzll7n6VcDXN6z4dLRlD1S8wdlacpH+ArrJmguSd8ZuRQqq9l5fHJm87l6QW86Z1AhvbhCWmtrIkdKCEqxrAEUSEWRvqWJA4K3HLLrEjBHCJusJeB6ktQiIf1MwyUYTWdWDAmxFbC89TBjMB9zYxF0iwxelxKJcqbO8deyIZobLIBvhtzF43YgFuYgBUehr/sRJHIXP00WPIlGwkeC7MBC3ccS18OGGQjEIX5EyDEeBxj6noCSQ6pLGh117ljSjsZibIv5qYse2NeU04XnYLJAZJ/O046kctBOFJzMQtn0RJEDP4Bmb3lytJdLBiNTDpRjkegBQAIWMi1MWBhNgDdpLMslCN0l4XCo4pxs4q1WCqp3L3zwhw7Td8inttH5N15CuWnTqrNPtyIkHwWkZGvRuSNwk2hIsFHKuk4OYyauatIfJZIkcZV7la5W+XuI3N3+WMvQOrwlaDP9ir0uVShucHFcwX6GIoepYsO6C+PSr0jN7FLChDp9w8XoZGSiN0ybASeER/5pXxNU1D4w78fFHixWPrnvkAByY5egwQqkYgPSe65xGQob6qdVW5vtBlICFC1BiJC1TRsonPGwWQmVwol4XaTxVpY9ZtjIw71kUNGWOsrIHJVcT3TUj1nB1MhyQpJVqtRtRpVSLJCklXuVrn73EhyJhVlS8BJNh+PuZn4SAvf/ZY7DGDF5i6bpRy5ahmtIDE2w1i1MnKoDVrbg+1kPxLtmLfjvZ2DpBXttfju/vb+9qDd2q8trvVX8zyeJVk5pxb87f1IJgYQdwM4LlcQXNZpHZe3/8C8RiRY1rD0zHAz2BxMej3Hju1V7PheO9ANCAN2NA9sL172TpE+/vkAyaPddG4igTDbmw6Gc0eQEmMYLC2tq6BjBR2r5adafn6Z5aeCjlXuVrn7c+bud0HH9regY/s7oGObIcRKEGL9k9AxBtyB0CwBp+CJkxzMqxA2ZqAKPIXdx5D2jpuhcDOgV0KRrYNVFHmhNXvH1aQAS7a0E6nm5sLyBmPHONYUY2EAZ0MokYpB1ZKAbjGq5FggJoX4YakcS8pjVAjomkm9kzjQyudMEW8zLlJFaQ4SUlFINe69aogxCeEkEoR/QIH2QYdQqJ9xjzN464f2g1kPNT5FjdnJXSQE5vxs/3d33SmBLghvsFz0va8fOC7g98y5gjZC3GW+fM0gaAXVK6heLffVcv9rLPcVVK9yt8rdnzN3vwOqBzT0MFSHAY+G6jC2scVmWOoNBtf/HbFTqgQJKLyZjgirx3MMTrgCQimcU8cagmeiD2vN0hFd27yX8bSJJ1Th0R+UnsJg3xB4+XKTwryRc5k9bMIgocBd0wbPZKM4k630bSPS4+YAbLWmDOGpU59yOIBOuXsGDTK0kRjLvvARcW92Ug2jFsxPBw2+ShnPeqM/J9CMME9mk0Hch7ii1yBiBk3Fb5ZGNyiOVvQDvS5NOv1xXTyhB3RZZ76vcoPxDCRdUhFVuEZ3gf+BEPnrEuQ58lWrk6PPr64Xx/QRpXsJV0bOVx78+0BrRaAzHNZirwU30EL4IzMvfv9wscGGiE2pNuQWYbGQ2ExAdp1DGFHt6xTHR3ASLUdG58MRKdcpHdDBXGNJCkZhH1VfCHZVnIt+D4tCD6o4mR0nCSocOOv6ReHBWNyIFNfLxtzaGJwyVk2wYpOX5m3Q2khNhFTwOKa3jY+qzo4llizMEhoTVKSekF1lhV58Qa+nCvGfglrdU6sTNbuxJIU37VXkD3xHkPBIgqeWrPVk5p5efYEedlzwBqkuy4CWCHKUj1VFhdeeLEeJXh3pleX4qD6MJCy85WnM1zlmYd1MY9Zl0UhrK/7LGIYOpsrVMIdMe7JYt8i0ThlRb20tiFT3LOuyDjCS5DuFxFA+mPgAl3FCMdpvqFDafiLPQl34BE12zD6VdKbXV7Da4shYR/bJMiPDOjKs+zphg/x+McPAgtxGHagO+AA4mvufKkEQdKE2elprKz+Rb9IcXD4iEJWo2OzQ/zicF8HwxOgDjp6NgVKNKHx20AzvGQVauKKVjFXsHyxbcFXeVMNCumQ3L+/sr6C4uP7b9EWNO/NtljOVTp67Sj9QSf49dfcfqnhVpfkVK03AxRhuxHbp0hUG+euA6Va3/XBfeiTgX/hKuUoQHBocf/kSUcwioSzlDqOasjoaSUEbBpngDvHhJkaWHlMmQm+P6Q9tIREaGhgDaWsBt/KBTIEebWkXnDkljAef6Ff8bfNwwEJDSEIDKhrsA/RwKgK3YP+GR3vh22cdGrk+eOYcHcuOC2cD6BqPc4X3K0HsfMw4hNQ3IiKWNsp94YJ2TonCFpqg32xWkcUYaqhCgzoZM7ZnCe5FQ5u74Phv8AK/27ARDaZHL4Y7nnNFeiINd2w3l6D9t2hDtNVHIs2wg4SqCwBMLHB4171YoQjEVPjrhzbDZphkmzgWiGAL5cNnp7Hd2KpTSwHvM20d9LwLxEsX/hje+GOzG8SlQLyfb8L/3FeGwxKGvUczww02NEzu+yXfql6Vr6CiKQ7pRil1q/grXOyF5mYEFsUZ9/e4K4P92xRf/5kLbPmvruetGbVI4HF8huY4AemWr/su2vhFL2i/QX9XesQl5AdUK3YY1WS+uVCDxy8C9yRAL2xFnyzX+svJTxIlGHWKd2L9HhaZzH/0u1wL01b+DoSt5mzn4e0J5MH0bwokDrw= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

+ +A certification task object. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-identity-outlier-snapshots.api.mdx b/docs/api/beta/get-identity-outlier-snapshots.api.mdx new file mode 100644 index 000000000..1b28fd00e --- /dev/null +++ b/docs/api/beta/get-identity-outlier-snapshots.api.mdx @@ -0,0 +1,96 @@ +--- +id: get-identity-outlier-snapshots +sidebar_label: IAI Identity Outliers Summary +hide_title: true +hide_table_of_contents: true +api: eJztW21z2zYS/isY9kMSjyjJ8lusLzeK43TUceqcJV/uansuEAlJaEiABcjEqsf//XYXIEW92HGcTC9JNdNJLRJY7Ps+CwI3gc6E4bnUqh8H3WAi8n4sVC7z2WmRJ1KYgeKZnercBo0g5xMbdC+Cfq/P/GsbXDWCWNjIyAypAI3hVFrWe9NnRkRCfhCWcWaLNOVmxiKtci6VVJMuy6eCqSIdCcP0mEm3rITh+ZTnLCpsrlN4N+W2sTRW+7UbjKuY3uWzTNTeXKoz8UchDa5d5FNt5J8kI7ORdgOfSC67JZ0w5YpPRAocdI3g8ROQNeOGpyJHCbsXN4FEyf4ohJnBOwVv4GciU5kHy+K/5tc1VoGFIslBJg1/5oVRzUs1EIJd/GuHdDTIQQRuYnakk0RExOSbaumrp9M8z2y31YrFB5GgrZqWyyTTUuXNSKctGasWz2TLejphVNEJ5yI8Y2NtWKqNYFLBnylpowm8G6cnsP2YJ1Y0AnHN0ywB8Tp77UZgo6lIedC9CVDDIB2sKybCwExHxj3a6cCDFOyaFmnQhXkpv3Z/E5VYjDlogX7d3jbWa1OPx1asqvOUHgPboEG09LhIEq9VBi+a7NwWPElmzGYikmMpYvZR5lO2RdbZQsVnfCIVz8FLpkYXkynR8Yb5bszxBcao1O+U7/VNNBqLplgKZB9UqC4fnrMq9pj1iQE1PJZJjv6u1omwwrbNDSQAGCoUcngRnJy+/e+g/7p/0jvrD/8DLwbDs/Oj4flZ7yS4utNh3KKYl+5a4XZZoleOzzIoCwujSLzSXszOIEFdMzdtBM4k1V/sHD85uYCz0PP57FJdqlflUwbZ1RZZpk0O7KEjUVgAKf0RX0MIJLGlzOhyuza2ixS2tkqTvYRg2Nrqsq2JaLBEbAU1Pwvqg9hEsMug0+50wjb8dzDstLvbO93OYXNnb39/93m7s//bZRDcZSGLPN5roZrngoZSHlqBmgDJVo03AGrfuOlQ4GXDDdyzh5kNbLJkpTttsxpqt1f4yGZaWWFR1512G/+3pMYiioSIRdxkZ1SRLEukzal6jn4HmWyTHfNo6n8h3/P6DbE+gZLOphLSaILKQv3nMF9GthXpQoFtahUamJxCQaUqehP8OxzqnCfhEY5b5WyIhRwHlPmd6DXXuU+Z+W4hOwQIKoQjyLMskRGl09bvFqnerE7mxnD0UpmL1NaeO4Gx9ht0AcQi87ePzF6r4GgFrJTKXbD0ElGQcsH29wVSDAPCXKZiNaHD4rErhIKNiuR9xUIM/uuiwnDVqlL7R25ZBIgI47HOHWSE7bC9F7a3h9vPu7vt7s5e8+Cg8xvySRas0OG6YrXEFFl8FdxVMVIhwZS/L4MePV/YvM4UQAu/eL+Cko9YvoZDP5uB9pyFidIUmGvXL8txvbyjI8O6pN4Senu/uL0lNwelr8ZMD4I5w4wS+mjGvDeus0hGtBj01iJ4mjFezqlAlZ1ZiAWMtM+NJR8zjsPddfnmCERROTs2BtR5N5cjHc8w10j1gScy/gJeluMXfBty+ZGO14bNMkBQIpwYaFGAQ0EsRzCRAcUPMkbjE2pzJEtsROOaCwECmmhusxc8ZmdeviMvDJrZ8AgdqR9/mqFzJWE+K6eAe1ZuuWZZcSD4aL992Nkd7+9y3nm+u32wNzoc852d9uHe4SGunoIfQLNj1yTExaV/FgoAR8QSHYFF/gSFQCYA3RMDtPjDcyjReID+MUO5sZWYnl+Wi+scGj724ugN2z1gCVeTgp7zyZISVHg+QBACzs5H+Cg3hQDJHeFTIydS3ZfQXx6/6p2fDOHJ2fE/z48H8BfSWsnlPQXeGqNbakodU/2ROPYCUNwJRAlYa7c81S0QiCtbHyhtLQiZTw8ww6++ZkadNBsbnS6EEsXNdc6eyqZoNtgIn0FpgJI+4hYmgAlx+JbLHeGJ1+QWc6X6WZP14liikJAZIRqBKMyfASHG49gBK9eKQSgLarcgaTOlAQSIRVvMVblojXmuO6kbBYMDOP+0n/SiHLo+8omFKKy8xbPo7QM8O80tcjdczpKIIKEMRtRQRtoYBEAjkE0CrPHpiIAcJB5VjqsyVj2FU7p77Zh5mWt6F/HCPiDu3iSQfkISrXrxQfjgo50El43IGqWZfEby+Zwm+1GVucrAd1BzE7ub2N3E7gNjd/nlme+y/FuCPtur0OdclbuP6wCaIe9RemmL0hmywUAhHiL98nYIgf1eKBwvrjNs+b4iPnKlfBVZVvbwHXUJfcvSP7cFMkh6dBKMIROJuEt8zzl2MJZUtbO62ittRhIcVK2BiJA1DZvpgnFQmSkUbh8z3BWOtbDqSc6mHPIjJ4TrMiCuquLQ9e8bJLlBkptqtKlGP0w12iDJTexuYvf7jN17kWTFFUWLx0nl7jB5mn+P0nIGA1i538+qkCNTLaMVJMYqjBUsIodg1NkebY8PIrEb8914f+dw3In2O3zvYPtge7TbOQjqtf5iHsdVkC3GVM3ezo6kYgBxHwDHFQq/BuRax4vbfwV+2xljWsPUU+Fm0Dmo9KrCjp3DNd8NtGavuZqVCMkuYEg11xHmNBib4lhTjoUBnD5qKAapSgJf6EoyFUAFv0Qx+pCMwYtSAF0zC3tj/IzoAqV0smoVqaKkAA4pEyQaUbMGx5IgpBgj5gMKhGAnkJ2/Ijr1JvoiJM/OUOITlJgdX7vvRKxC7nvr9nf7wLzBHDFwBr5jo9d1O1yBA0BD4HJWhTs3+HyDzzc1flPjf4wav8Hnm9jdxO73Gbufgc89Grobn8OAB+NzGNtsswpLvaITAn81TKdQ8RyQezMdRYWh7eYSgxOuAFfyp4Uxh/B8Cj9a/uBG6BSCKaURONDv2ClMAsPKk1Y3YCWwzm2TZ7JZni5U+iMdtxqBatZkHTwe4CIMB9DBLrdAk/RqJLquy3NE3GnZn7YIqhNd91LGo2tovpkuILMRmQae2PFuRI+BxQx6iCeWRjfJbVbkA7nOTXL75bI4QnfIsk59964G4xlwuiQiinCF5gJzAyGy1znwc+SSVK9AE19c1ccMEJQ7DldGzgsNNnKdFYZOcViHvRDcQMfgvm08/eXt8BmbIBSlVOBO+AmJvQME0xtwI0p1vXKfHydR9Zkf6u0tfEnB0GLjBJTC/Cnf8mz7r1ADziBpk9pxkqA8gbMefhaQL8y740zvpQrZS2nc4Sp3pMiLSC0gu8hKuXhNrscy8VNJLXTUQqKG5xAXuHCqvYjcyZwI4htJ8MSSth69uKMX1uhhgwVPkOoyD6gJz8fi96+otNqj+VigFyK9RT4u1duphDq7OI25tMYslMkkZn0WTbW24h+MoetgqFxMCoi0R7P1ERcNKSLCTrvGUuiWDGUIqJH4O4HAUM6Z+AirNoEWPGetYhe278iykBfe0Unfdwsy0+MLKK44MtbRZxxwXeIZFwxxwdDlCev5d7ULHQtPHoIMlAecAxzN7U+ZwDNay42O1trMT+RbNAfLB17XICo267of3XkS9H+5Sx04uhoDqRpBd/VFEH4zTwsL2IKyyu2CZQ2u8ptoqJtLenP8VttVWEu/NXlR4t58V+VUJbOvnaXvyCTfTt79P2W8Tab5ETONh8HobrSs7xfqTv7CY7rVXT5Lp6/hX3hLsUqIG/oZd20JUUydUJbwHL2aojqaSkH7A5ngOeLDBnqWTikSoZXH8IcukAhN6Ni2AZY5dHQyAXq0g12uzClgHPhEu+JvW7gj/7BWNIV+UzTZW2jZVARmwXYNz2DAu9+179sGYJk3aFj2sjQ2gK40LRTeFAK2i5RxcKlPeEQsbVS4xAXdmxKlLjRBv2pWGcXoaihCkxoXk9rTMW49Q1dbM/wn1gK7W7/vDKpHK/orK3NBzkRCnonjFqH9p2iDt4VTkWTYMELWBQAmaiu87g9XKAIxZUEuaMy1mbT8JNvCsUAEWyjnPjvN7WY7pJYCnmfa5tDi1ojjzczSfaormmxQXTBYcMab+b77D3Jp09czbERaGW6uoZYK1zy5NvUiWG1ToamZgibx5c0Nbr5g33aLj919JmyGwLYYcPNbbXdq8vu6/7lWY+8FbmeU11v9hoW75vVwPfy9Lm7eo8fqYusjFfm4a5j3MORvfj6Snc0dyrvuUN6j8vld1Udq/W97+fEepc6vl86VejXfPKMNq/L+ISVxN81tqNdmrXxyRirVJufPx1CDb/8H+b/xBQ== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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' + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-identity-outliers.api.mdx b/docs/api/beta/get-identity-outliers.api.mdx new file mode 100644 index 000000000..07737b78f --- /dev/null +++ b/docs/api/beta/get-identity-outliers.api.mdx @@ -0,0 +1,88 @@ +--- +id: get-identity-outliers +sidebar_label: IAI Get Identity Outliers +hide_title: true +hide_table_of_contents: true +api: eJztXG1T20gS/itT2g/ZuCxjbAjBVVdXDpAtb0HIgbncHaFux9LYnkSeUTQS4KX479fdM3rzCyEktZfs+kuCpZmefu+nRyPdeToWCU+lVoPQ63kTkQ5CoVKZzk+zNJIiMV7TS/nEeL1Lb9AfsOLyVdMLhQkSGeNsmDucSsP6bwcsEYGQ18IwziJpUqbHTLtZTRZolXKppJqwkKecmSyYMm56TLp1B2EzH87SeSyaLBSpCHARnCGARj6U8TRN5CizF8fldWBETpROYDJXIQtEksqxDEhOJtVYJzP6+706E58ymSCvWTrVifzdjjEB6AUZfya57OXc+zOu+ETMYJVeInj4DHQT84TPgMEENXTnSdTEp0wkc7in4A78jORMpt6iuk74LVPZbARiwjrAQhalhqUa/kyzRLXeq3Mh2OU/u6TT8xQE4UnIDnQUOW28LZa++nmaprHpbW2F4lpEaNOW4TKKtVRpK9CzLRmqLR7LLePo+EFBxy9FeM5ANWwGiqtqqQW8J1ZP4CNjHhnR9MQtn8URiNfZbTc9E0zFjHu9Ow9NBtLBumIiEphpydhL3Q5cmIH1Z9nM68G8Gb+1fxOVUIw5aIF+3d83V2tTj8dGLKvzlC4D26DBdCrYOIsip1UGN1rswmQ8iubMxCIAZxAhu5HplDXIOg1UfMwnUoGHwfxEZ5Mp0XGG+WHM8RXGKNS/XvmBztSy7gdj1kiTTDSYTEGroPhYx1lkVSlY41/+UKc88g9wdgNVGmtlBJtCDIH7kx1w4IpwmHKgqLMoZCPhIgMsB7Ge2w3ju2F9osFuBKqKIj8Ei4HNpApwHohhUsw5HAwNrDAShAVcsSm/FnAZbETKwfFyFvMgbaI0kEkgnekZxHwICyudoqcYgas2iMjfSPIG8kTcXvMoE1YLOBrYzkzOzQ/hQSjPCicaaR0JrryKn9BM8hXnHjS0WfechSIxt3kVzV2k6zy/MqN4bKZWx2MZpegMahWzS9wZKARqAkOFQm++9I5P3/33fHAyOO6fDYb/hhvnw7OLg+HFWf8YS1ch7eLAta5v+TFfws39ovSvrUy5d2cGXRJVkVuRmTmUx1tmp43Q1dUf7DI/WUGBM9/x+Rx993V+FUPCZHGskxTYQ/eidAuk9A3ehtQahYbi0mILnZgeUmg0ynLdaPRYQ3xqMnODkABCTTXsmLFMTHqYV/xDyCE0dgKlPBJuDNZzUEaa5XTcdRf59YtQypMaDa9q/ZKlVihNHPH5G9ADsMXee7/qqXrvFQjCrsjEJ7hFhn/veeucxaB2vsxZKskZ8w33jUCjgJKX/egcyH/nXoQaWPShc3vtcR4EBlvhDM0a5nO2fYRFmytI+TTdu79CK9mSZNAunXYb/1tQeRYEQkANaLEzKkOmBLejD0DVtNgRByxrf+U411TzLuMjSHVFugO2bQWkVWtFcnn9IajIli4Haqj4YCZfW+7vIZd5yIewBHkcRw4Eb30wSPVueTJPEo6OLFMxM5XrViwEvAk6RSqtrmS4ypOXWc9z/TPwVyUhWtyVMcL83AVy2I8VNwlrVt0diW437Ao/2N0J/R0R7vl8vNf1O92X7d2drnjZednFOCm7iMfxNThcqkZUxcFFbdsBHsoxm+XMPYkry8eTi9UKT3BlNNeYySBjUAJaX9ggwSzFwINpCLstP5UzsVJzRIw6sprtbnipuRo7nXZn22/v+u3t4fbL3k67191t7e11/oOMIVT8dpzNtEmpCVVP4q+7zJ8rLGvQUK3CR3zCbqYClgTskljAWFl+CsuPhFA5Sq2yYOFUs5LBVsXfQttTyzaYPWcQ5pjxl3vk6lqQXsrkCHSw1rFzQNRTGPVBj4YyJa2c63F6wwE+HilojgT5f4iFKZ1RVvHy64R37jEbYU4t+baYvmq8caT5siDDipKIBlkpgf4EhBnNSYnlRoCgVVnC8X+oGImesXartV0Vsd3a7wBDkG5I1cPPxOBJ/80FhFvT618MT0/6w8GB11TQRC7F3xFMcCgfIlCOa/aFBsK2mWB7nqUaE39AFzLl550Je4fdAXQGby6Oj5FCPhuyDjrMCt8o2UOe+CgH6hUBvyJqAHPfGBsr4LuKRRwiCEeW/pqvEq5MhDZ4XiwH9wp+/whuvw2vmLldHLhtL6ypeHlnFUQ4gBGQco6SBIzvO5hgu1W7k0BdKBvp0O5QKXAiGWIJ/9IivaYYQ3wAVDvQ4UrNLrYiSviThFN8CWI5gIkMKF7LkBKJC0IgmddIGteqaRM00dpmr3jIzpx8B04Y1F7Cg49A6zHV+MLCgnwKJLACF6xYVuwJPnrR3u/sjF/scN55ubO9tzvaH/Nut72/u7+Pq8+EMXxSy6I5uqkv/YtQkMACFmkIVfk7KCQRHHRPDNDijwdEROMR+sd8Z8cWYjp+WSpuU8C57NXBW7azB+6tJhld55MFJSj/4nxViFnCp4mcSPVQzjs8et2/OB7ClbOjf1wcnQ/XpLw+7pqG6JaatmcgAIljJwDWVCMiqqkt1nBUGyAQV6Y6UNpfZm5AmcztI8AMt/qKGVXSNs1XQ4ni5jZlP8uWaDUh9OEaZA9A4SNuMPyV3YDqA3aPU//YabLhdp6et1g/DCUKCbiaUrqB+XNMzTwMbd9kNxMhlAVtVCGAhxwtA1G3RanKujXKFHJcNQoGB3D+eT/pBykUFPKJWhQW3uJYdPYBnq3m6twNK0ojlWKDGOSlCcptgigCUAKT0FG6dER9GiQelY8rMlY1M1K6O7HMHKaa7gU8M4+Iu7cRpB+fRCtuXAsXfLQXbrMRWSM3k8tIbpuXJrtRhbnywLed5CZ2N7G7id1Hxu7izTO3MeLuEvTZXoY+Fyp/fgZCLEGfRFhku/CQzRqyiVDZQaRf3w0hsD8igDNM3Ma4cfYN8ZEt5UvM9wt7uA2zfD8tL/2lLZBB0qOVYAyZSIQ94rvk2IJEUlV3ebXXOhlJcFC1AiJC1kzYXGcMO64kU9TQcdNkoRZGPUvdwwqICGNsBsRVVejb7bkNktwgyU012lSjP0012iDJTexuYvfHjN0HkWTBFUWLw0n5QwzyNHcfpeUMBpSnRoqQI1MtohUkxgqM5dWRgzfqbI+2x3uB2An5Tviiuz/uBC86fHdve297tNPZ86q1/rKM4yLI6jFVsbe1I6kYQNw14LhM4aO9VOuwvv2X4cOJMaY1TD0Fbgadg0qvCuzY2V/xEFBrdsLVPEdIpoYhVakjzGkwdoZjk3wsDOBsAnlR4WkXCXyhK+G+qc/wQTOjIzUYvCgF0E3mfn+MBxbcQR3nZMUqUgVRBhxSJog0omYNjiXx1MsYMR9QIAQ7gez8DdGpM9FXIXl2hhIfo8Ts6NY+2mUFct9dtb87AOYTzBHn1sBrNnptt8NxyxwaApuzCty5wecbfL6p8Zsa/+eo8Rt8vondTez+mLH7BfjcoaH1+BwGPBqfw9hWmxVY6jUdJf6jYTqFiuOA3JvpIMgS2m7OMTjhCnAl914M5hCeTuHHVuUAn8X6lossieBufn7yDowDRrlv8Vi28tM4St/QIcoRaGRFssFTATawcAAd17QLtEidiUSPtemNiFvlutPYXnFO80HKeEIVrTbXGSQ0ItPE82TOe+gysBhD6/DM0OgWecuSfCDXRRLdf70sltAaWVap78HVYDwDThdERBGu0FxgZSBE9roAfg5sbupnaNnLq+qYc8TilsOlkWV9wf6ts8TQKQ7rsFeCJ/gaEz3S+PnXd8PnbIIIlDKAPbcrJB0V4+wtuBFluH6+vY+TqOiUb6P0aw9QMKLYOAKlMPdyQf7y1htI/WeQq0ntOElQesBZjz/hy2vz1rxK8F757FAm9lyWoTFORPu6xWWcy8Urcj2ViZ9yar6l5hM1PF1c48Kq9jKwB3ICCGskwSND2nry4paeX6GHfRVcQaqLPKAmHB/1x15BbrUn81Gj5yO9Oh/v1bupxNfqatOYzWbMTOl9mgELplob8XfG0HUwVC4nGUTak9m6wUV9igi/066w5NslfekDWCT+jiEwlHUmeyaasAq+9KFCG7a/kWUhL/xGB/B/q8lMly+lIq5DHXzBsfUFnnFBHxf0bZ4wjn9bstCx8EwayEB5wDrAQWl/ygSO0UputLRWZn4iv0VzPDotGdsUY+Ke/dErk6D7y76NiKOLMZCqEWsXDwLhN3O0sG7VlJXvEixqcJnfSEO5XNCb5bfYpcIS+r3JixL3y82UUxXNv3WWXpNJvp+8+3/KeJtM82fMNA79orvRsq5NqDr5K4fpljf3DJ23h3/hLsUqAW1oY8r3PKuE4oin6NUU1cFUCtoWiAVPER8280PUEInQwWP4Q/NHhCYJjKHD4hwaORkBPdq4zlfmFDAWfKJd8bfJ7HF5WCuYQpspWuwddGoqALNgl4ZHL+DeB+3atXOwzFs0LDvMjQ2gazbLFJ6sB7azGePgUp/xiFCaILOJC5o2JXJdaIJ+xaw8itHVUIQW9SvJzJyOcccZmtmK4T+zFtjduO1mUD1a0b2ZVgpyJiLyTBxXh/afow3e5k9FFNOrG8AWdH2VFU4GwyWKQEwZkAv6cZ1Mttwks4VjgQi2UNZ9uq3tVtunlgKux9qk0NlWiOMnCH4RaeFCrPKZgpoj3pVb7X/RLxO42odNy1aM+2+o0cw2WraTvfR05WsOU1A2Xru7w20ZbO3u8bJ9sxH7JTA/xmT5KuNahf9Y3zZYqaiPAjc68k83uK0M+8Ln4/Xw1/oowQN6LD7a8ERFbr4w8ON9YeABd8g/I/FEb3jaRwQe4Md9t+CJ7Gze6v8+3up/wMDlxxueaOPNG/eLb9w/oO3y6weltq/KTV/aaM3ffSdkYafZ5z+VWUsnJJBKsSf/yxFgx/v/AbXqPyo= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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' + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-identity-ownership-details.api.mdx b/docs/api/beta/get-identity-ownership-details.api.mdx new file mode 100644 index 000000000..fd35a76f0 --- /dev/null +++ b/docs/api/beta/get-identity-ownership-details.api.mdx @@ -0,0 +1,103 @@ +--- +id: get-identity-ownership-details +sidebar_label: Get ownership details +hide_title: true +hide_table_of_contents: true +api: eJztW1lz2zgS/iso7sMkKeu0fMgvW4rjpDzlxFnHrjw4rglEghISCuQQYByNy/99vwZ4SnLsHLszSXEeMjTZaPSNryHgxosTkXIjY3UceAfeTJjjQCgjzfL0WolUz2XyTBguI+1teYbPtHdw6eUkUmjvassLhPZTmRAPcHghDCuHMq517EvLnwWOD4tDxhUrpgFbLfwspceDyxvvQov0MFZGfDaTzMxpOhmoA5mTH6SCB97VLeZNeMoXwmAmO1DS7AnHkC1P4QP+KgZBNcziz8WCewc3nlkm9FWbVKqZd7vlpeLPTKYCBjBpJlY1Op8LVnDCA1iJz3yRRMQjDPf7+4P9wSgY8v3+9m4fT3v9QbgdTsOd7ZB7JGgqdBIrDWth8mG/T/9rTvE1ButCAJ8MpAwx4kkSSd8O6H3QxO1mXdV4+kH4BgOTlPxtPUdjq8kKJ1djeJpy8k5T0khqYwWKImZgGOgWZ6kv6oJrFsap/SorJ0sjFvqrRDq3hKvuWhWobjCiZNfSzFcnrxx2dnpy9Mfp21dHZ+T4MozvU5v46UT4MpR+pbOZS12FxpzDVaUjMezBShcsjpy8D6C/3y4yIDc1XGRidj2XftM6DCoUNhTN4O5vD/rbIzHeC/vjER/1x7v+YCoQ1ns74e50PCALuky7Txii+m5xXnBtYtXd7/eDIBzvjvqcBDAPihIbGd8rwOHk5evJ8YtXfxQPFET4D0JIYymO644kZ93Wxju/edPd3T4fbg/D/s50JPqj/cHQ5+O90XS7PxiIfliVrw0KF/raOLaTb5q+LCeT9QRvSrS5AqwlYT1t6llz+T/Q6SpXarSpUB5GErOzozRFhemwM2GyVImAycK1f2YCBWoaB9aRUn3ikQx+YMl0NfkwDh4QdM+lEp1ZyiVJKKzIPgYycPwkA4xgizgVeZkvotPSdRtxB0t0B+wpD6Cv0+8wV4Z8n3L/I3gdP6AmXCiJ8awYgpgvK/WGacWe4NPd/ng4CndHnA/3R4O9nek45Nvb/fHOeEyzL4TWfPaAAvpCICRRO6PYh0f+gkGwkMP2VgA7+cPLpeXxAPvTwu1oSzVzeRnBiy3G2dPD12y0xyKuZpl9z2crRlCdizcUvlkU8Sm9IogAzR3j01TOpNokilDZgsDLs6Pnk4uTc7w5O/rPxdEbPBGvNdw0UYjWgMISoiIW5vG1lThX4BqLixYRzCGCLnuSc30ChTjW2xqhdH/ppYYxEVshzyKDEfnsG0bUWbMwjReNVPIdFmOPZFd0t9iU3i24QdWcco0BtOyC/MnE90ViOie5JZ+wOYCaSB932SQIJCnJI4ZsBFOMX4IR40FAqesYhBlS2a3ecWaYio30RdMXlSmb3qgK4EndKZQckPz+OJn4JoNwVs16FpbRkouY+wcyO8s1pTuvGc2adKkM96EFoNISZkxTWJhNoZs0muXliNylUXhUQVdWrHpdt+XupRPmmYntN59n+gF59zpC+elY1coPn0SefJqWQFeNrDcKN+UVCR9JbTs4pyrdVSQ+C6WIgjZ329xtc/eBubv68SxvD/OvFvoM1qHPheLoh+PULp5r0Ce10aNiVhC5jsg5covBIDlE+v3tORL7o1BELz4n1Pf+QHzklvI14SelP9z7KcGP0lkNX5CA1o5OgxCVSAQHVu5K4hL6jvrb67M9j9OpRICqDRARVTNlyzhjHCZLM6VIEq63WBALrX4zaONQHzkyQmtXAWlWFXSSWCrTIskWSbarUbsa/TqrUYsk29xtc/fnzN0vIslSKpstOU7S2WLB06WLtPy73c5nIGDFDxWsTDnrqlW0QsxYibG8JnLwpsPBdBDu+WIU8FGwuz0Oh/7ukO/sDfYG09Fwz6uv9ZdVHpdJ1sypmr+dH62JAeI+AcdlCsGlTRwHze0/mDcVIZU1Kj0lbobNu8UGo8WOo3Xs+Co20A2MgR3TO7YXL85OiD+mtuyrHWVKWms6kHNjISXFMCwttWmhYwsd2+WnXX5+meWnhY5t7ra5+3Pm7ldBx9F90HH0FdBxxAhihQSx/k7oGAB3EDQL4RTo4GcwryLYmEAVPOW7j3naG57OhCmBXgNFDsfrKPI8jtlLrpYFWNKNnUhVmYvKG2gXRJsWtCDgbIYSqRiqlozdUQ65EIRJET8skgtp85gUAt902ZmEBlq5nCnirZxFKj/KIKEtClFMe68xYkwinERI8A8c7D7oDIX6B+5x5t76rv1gdkYan5DG7OizLwTlfLn/u7PplMAxhE+pXLxxvr7juIDbM+cKbYT4nLjyVULQFqq3UL1d7tvl/tdY7luo3uZum7s/Z+5+BVTP0dDdUB0ED4bqoO32WYmlnlNw/d8Ru02VXAIb3iz2LVYPKgxucQVCKb/AQDWErgEceD1ZXlTo3VSXAW575TFtj24fEEZ04mVphGFzYxJ90OvdwGvw1m2XJ7JbDFfxddePF70pTLWhCtGhU5dxRMAmr4/zhqNr7ZxKCmVX9yxzZ3WrGQUtrG/PGXyRc3GaeolehDk2W3T2PQ8r+xoiJugpftOWumvDaE0/6HWRRrffr4tjdIcum8z3xdlAzyDpioqkwlV1WeQNAXA3+9qVkWpRoa3/4dpkp0Q2ZE8FT9EduNMwj35/e/6YzQh22rTPNCFeIalPQOK8RojYsjYpTobQILvSpHE2c2fIJ42zN5RGLIygMHun3gjBLovz2a9Q789QoK1JaZCwNYFGXT0qvBOITyKipbBbWZICTwaqBwv1eGPcY7vs2f5AKjwu7NvuO9VhzyRVo/JeRq6ibffYZVLoxWt6fasQ/yq4dRy3juWmH69I4Ux76buz3D5ymVjwSFtrffPkjl+nxo+aKbwhrqsykCVyOZonpvzCa98sR4Nfh/g15Xin3tpbB81hzJUwprEkRgE7Zv48jrX4N2MUOpQGl7MMWfTNYtmrDh2bEZ1hvyZSx03ZkR0gRCvfCRJDuWDiU1qhLUCJ3V6JTcn31rPI+ffonwP2vqGzfX2JhZQog9jX3ywzTdihCTuuBuhc/vxmFIRFbpMOtg64ADis/G8rQS5ore45XhurumXfs2NoafAhquWikwP3x0FV4PInZj8QdUmDMkwAuzxDRpelcl60WDWMVWwNrFpwXd4oxhq5Yjcnb/kDJ62b/zR9SeNJtYNyqqLlj67Sd1SSf07d/ZsqXltpfsVKk0NeCjc77crlLwrypzleW9/Roy3nucC/+Gpz1aJr9C7Vvck6oyTihqLaZrU/l8LuBSSCG8J+WxRZ8cJmItp2Sn90fJbRLAUN0lYDk/KpjOjiKu1WFzNzmzAOWJJf6W+d5WcnYoQkekvRZW/RnikfbqHWjE7t4tuHOO/R3sAzr8mx7FnhbICuxSJTdI8PYmcLxhFS90REILWfucKFTk2JwhaxhX7lqCKLKdRIha5tUtKFPg1pmxkdbM3x98wFv+t8jxmmJy/m1+MqRc5E5C7Tgq4J2+/jjWjrzEWUUHOIqgsAJmozvDw+X+MIZir/YSNOZ718kO4RLZhQe+TCZ7s76PY7tl3A+yTWBu1sjTld/q6uwAblxfFGEN5Ue+vfcls8XzQI7fcS2q0iUTLXfbi+79Kr+j4MOKg6P/xVtX5oJubQgOhvbmiDg3qhW3qNxp6658urqs2x7SEsTM/oM0Pk/OpF8bpej87yK+WP7U80zevjGzUoduXUsmrIPTx+FNTH11RA1wvB7YaLFcoRuC2Z2tC1Hy2oeSrb5BdHFAX8jnU4f4ABUGn+C8MxYpY= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 ownership details' (get-identity-ownership-details)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get ownership details

+ + + + + +Get Ownership association details of an Identity + +## Request + +

Path Parameters

+ +Ownership association details of an Identity. + +
Schema
    associationDetails object[]
    + +list of all the resource associations for the identity + +
  • Array [
    • entities object[]
    + +the specific resource this identity has ownership on + +
  • Array [
    • identityEntity object
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-identity-password-change-status.api.mdx b/docs/api/beta/get-identity-password-change-status.api.mdx new file mode 100644 index 000000000..993b27456 --- /dev/null +++ b/docs/api/beta/get-identity-password-change-status.api.mdx @@ -0,0 +1,91 @@ +--- +id: get-identity-password-change-status +sidebar_label: Get Password Change Request Status +hide_title: true +hide_table_of_contents: true +api: eJztW1tzEzkW/iuq3ocBKrZzMSTOy5YJCeupANlcioeQWuRu2Ra0pZ6WOsGTyn/f70jqdvuShGHYnYHqF+i0pKNzP9+R1beRzkTOrdRqkET70VjYQSKUlXZ2wo250XlyMOFqLM4st4WJNiLLxybav4zKYfaGKz4WUyyKrjaiRJg4lxkRBLnziTSsfzJgubBFrgyzE8GMI8X0iHGWlVRitwvm/VYIY9usz6z+LBS7kXbCZGCJ6RslcqZzZvPCWJE42nEqMcx4lqUydqIwXtiJzmkF9ieaMsdkq1nM0xRMeK7aECfjOZ8KK3IS6jaSxHXG7QRDCgP4SyZ4NvFETHm0fxvZWUZvjc2lGkd3G1FJPtoHU+Luit6YTCsjDM3f3tyk/xb1clapgBRyjxKwbayVJcWCQE28zidDVG5XudLDTyKmhVlOdrXS8xAIkoWXBYCYRZryYSo8/6sWvJc/NniF5eILn2a0Otrc6+31eqOtHb436iZ8d2+72+u92OptPd/bHfJhj5RFthfruBCqmJJbDd7+5+T03evTw7MzvD0avB2c/euQ9jnqD47xsOJiJ0vM+R2wlchznZvaXjzP+QyUpBVTs9aUq6J7IiwpaMqDxiLhdJHHYpD8mU2PJRQLv/C0oGLDpHp4Y9BAcDgTlMoI0XpXM89t5OMOs7yOD7yKQUYU3jcet2DQarRPTnN3R1t31/n3gQ/JQ5rMWuzURT8iUHqHLx1oqBMXoVJd81Qm7e/n8YmwXKYHOlnrbIvMHkklWuOcS+LQycdiLGSgeC0TsvtU54J5kmXMunntBf+HJtpb7CVPIK+X7yAIQxbKefwZtNbH4CJDF0piPSuXIP2xEeW89duKXcGHLzZ7293Riy7n23vdrd3nw96I7+xs9p73XNhNhTFI0uscc3Hr1wIJVsYs1ciU8ncoJBccuncMeNuv+vI9NnA0vkL/FGd+biVm4JdZ8cVuoEy8PDhh3V2WwvEL956Pl5SgWhdnK8kMknvC73I5luqhvPPq8Kh/cXyON6eH/744PMMT0VpJN30Fb03ILcEqfGGibxzHQYAbbpgRKdQhkjZ7Fqg+g0A8VL8wUYZaOEMZm8K3RrxIUfaehd3XrKiTZqNcTxdCycXNF8ueyLZob7AhvZtyG0/YkBss0D6JPOvHschs6zho8hmbCJ6I/CkqbpJIEpKnDNEIolg/AyHGk4RC1xMYFQhl4cqyLixT2spYLNpirsrl0lKmqeO6USg4wPnjftKPbQHmnJj1KKy8JbAY7AOeveYWuTuvKc2pdKYsjyEFkMEMasxzaJgNIZu0hoV0ROYySDyqnFdlrHr2denujWfmldVuLOaF+Yq4O0mRflpOtGrgWoTgM4RcfDZy1ijNFDISBklstzjMqsxVBj4bSZEmTew2sdvE7lfG7vLgaUD1YdRBn61V6HOhQvNBxXMF+uTOe5QuO5Tffb/iDblBnU2ASL++Pw8dEOaLLxl1GN8RHwUYt8x8v7KHfz8sUW9Z+ue2IAadHr0EI2Qikew7vuccO0V5Ve2s7nak86GEg6o1EBFZM2czXTAOleWFUsQJNxss0cKoXyybcORHjogwxmdA2lUlrUxLZRsk2SDJpho11ejnqUYNkmxit4ndHzN2H0SSFVcuWgJOMsV0yvOZ97Qw7g/MMYGV58usCjlnqmW0QsRYhbGiReQQDbe3hluj3Vh0E95NXuz0Rtvxi23+fHdrd2vY3d6N6rX+ch7HVZAtxlTN3t6OTsUAcdfAcYWCcxmrdbJ4/Af15mJEaY1ST4WboXOo9GqOHbur2PGttpANhIEd83uOFy9Oj4k+tnbkSW/+VJWC1qkO07l1kJJ8GJqW3/PYvYGODXRsyk9Tfhro2EDHJnab2P1fQ8fuY9Cx+wegY5cRxBoRxPoroWMC3EHQbASjQIa4gHoVwcYMouApnD6GsLc8HwtbAb06iny+7nfqAYyTk8Oe+d3u+cHan9pyBSArvmQ+gCoQ1IDFBiw2BacpOD9HwWnAYhO7Tez+mLH7B8BiQEP3g0VM+GqwiLntTVZhqSNyrv87ZnShEjhw7s107NBiMkeBDlfAlcJNZ8ohdNV3P+qUlytb/nJly9+V7NzK5A6zPBb1jBV5igUTazOz3+ncwl6w012bZ7JdXlNW+qYd62lnCCWtyT904dHHGk1wV5j9Bm2n4VySE/uM54h7fTuZyF2hd/cb94OU6e4yGXIGHMw8mQ0Ghw8O5V6DxYyr2S/GzW47B1qRD3Jd5Ondn5fFE7pHlnXqe3A3zGfgdElEEuGKzAXDg5Cz1wX4OfDpql+QsS+v6nPOCJ57DldmzksOHU1vrzD0jqZts5eC5+gd/G2NJ7++P3/KxgRKXVIoDOFhIamLQFidwI1c0uuXNxdokatDuS7GEydcf+FuCAUZG6VQCvugzoRgl+UN/beoBqdI307ttEi4jEGrrp6UFkzEtUipULbn2ibnlInqQIsdvrDuqSuKrnuQCo9T97b9QbXYK0m5SlJxpzlBRHctg11mpVy8Jte3MvGPklrLU2s5aubpEhdetZfh+n+MSCcSPDVOW9+8uafXqtGjVgtviOoyD6SJwMfijZ64tNo387FAr0X0Fvn4oN5PJCru4jLmExwzKJhpwgYsnmhtxD8ZI9ehULkcF4i0b2brhjZtuYhobW/WWGr5LVuyBfzo+DtGYCjvTHxI9dvBF+17eRe2H51lkRc+ortO2McFmd3rS5RZmpno2Hwzz7RhizZs+TxhAv++ipFjIbZJBpcHvAMczO3vMkFgtJYbPa21md+R77g1VD5isOqomGzf/7E/T4LhibkBml3NQaom+F3dcaJvVwItKmULyioPDpY1uMpvqlFBl/Tm+a1+gKOq+neTlyTuz89X3ql09r2z9D2Z5O+Td/+ijNdkmp8x0wRATO7mtg2dQ93JXwZMt3reh6YAcuNfjLpYddgbnY3/YI9QTJ1QlnJLXu2iOp5I4U4KMsEt4cMN8iw9dZGIpp7CH/2gIzTOMQdha4Bb+VCmoNdm5/OduQsYDz7JrvS3KcJv+zp8KtVm79G8qRhmocaNbpVi7JMOHdwZLHNChmWvSmMDdE2nhaIPCMF2MWUcLvWIRyTSxIVPXOjjlCh1oR30q1aVUUyuRiK0XQuTT827ER1Co7+tGf6RvWB3E06goXqyYvhmcS7IqUidZ9K8RWj/GG14W2si0oxaR2RdADBR2+HN4HyFIoipcPCu83EnLDIdmgsi1EJ599lpb7U3W66lwPtMG4tmt0b8tbCs+q7Pf39anVBXH6IueOTt/Bj+B/joNBQs6jQ6GZ2jkRoK3x35jvQyWt+RYvG+TOgryAm0RvNub+nIhXq0O3oNSaifv7yat1+uDYJV6Rmd7wh5Zvkzz7r6npwG1p+y+1gtDwbVbH4mEOHxs6CjBPCHhhscurMet7sf8KdBtSUrv5dQZ1Z16K8P4TZ3/wUmjS1f +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-identity-profile.api.mdx b/docs/api/beta/get-identity-profile.api.mdx new file mode 100644 index 000000000..0a36001e3 --- /dev/null +++ b/docs/api/beta/get-identity-profile.api.mdx @@ -0,0 +1,112 @@ +--- +id: get-identity-profile +sidebar_label: Gets a single Identity Profile +hide_title: true +hide_table_of_contents: true +api: eJztXFlz2zgS/iso7sMkKVPW6etlS7GdrKec2Cvbldp1UjsQCUqYUACHIONoXP7v290AKVKkj3hTm5kpvSQyCTT67q9BkLeeTkTKM6nVSegdeDORnYRCZTJbnqc6krHwtryMz4x3cO0Vd5i7ZbxPW14oTJDKBCnA/Mu5NCwVWZ4qwzgzUs1iwdYnsik3ImRasZOjzkc1Zpn+LBS7kdmcnU3e/md89O7kPdMpG5+fMJ5nc53ibCL9Wy5TmJtpFvA4ZhkuCMM6wGfCU74QmUiR21tPIkMJz+ZwS8EN+Es6RvzEMuLLEG6aYC4W3Du49bJlgsNMlgLjcCfS6YJncCXPYeTdlles7x1kaS6a0rfIenIEhMRXvkhipC2iwV60PxwMd8X+cLTTn46m071hf8hHO4P93XDPu/uEy5hEKwMaBqb63S7+V19qrJor6emvIshgtUCrDO7hLJ4ksQzIwNu/Gpx6W5EXNHgWkbKc5CWJlaDXVnnAFSgNnCWTli1QSIOri6XJxMKfCYVOBWbKlfwtRx0wHYGtBDsrFlhX9UpDMuz1B8MRMcHDMxUvrbbvCjOur/oern4DfY7j0ZgB0M9EixiHeAN+shDuP0q5dBIc7WdyIRqsV5fvd/sDv9vzu4PLfu+gt3PQ73eGg/6/kaOFDmUk21g65SZj9nbwI3gD5sDXaNBrCN5DvVhodZRp4Pph5ynCF5j+Ii50ngYtvlSTtRmGKo9jPsXF74u6ypVCJ+vh0ak5wbslC3KT6QWLYp4xih+XFNAQ+gY8uMJKKVpzaRr60KLr3NdFtws0ZRYqX1DSPTp+f3ly+a+WXAszinUtf5gVb+YymNu0mIpIpEIFglEWgPWqGigJg7g2ltdZqC+3iuFnLNYP9nt73b3BKOzt9/jeTrc3Cvt7w9FoOpz2B33uVYL7YTb+kS+48tGFUacslCaJ+ZKpSg54Bn8fZBxLvmDwPybJO/T3JJVUdyo8ScirM3CMSmDBpZ1hq2MU8xmMZbyZr2sO2evCim2x0uKD3+ZAF2dXk8Pj7+4+juzGeYDqhI0DNBk7gqwXZDpdUsJsukTNwMyQhck9aJWmg5B27cWJiAAVzCdlai1lnWodC65I2IjnMXhlxGPTzJOQfZiMAJYVNFEuJIrISgkRirDDwC0kIqslAxXOwNmhit/MAZ1xFsy5mgmEbagox/2cGzYVcH/BQ1FViyvZxVqHOreIpBFKTTWB505tTnWzQeOwJuTpqYi1mqF17su21cAc9KsM7VW4GWcg3TTPoJCpSM4ejzKh0GPuU3vN1a0fJQUoS0EzSQLeiFouyKzpqWI6pzZeMHiZcmVQqEqwezxN+RKISEBb5nHmG1K/f1K0VHFV6TIlY3VUu+AyRnfNCnaPRCSVLCp608ZGcJOAFKyc4WDNat7WMzNfc7GskuvK9SpL1bEBDwJ01lJbXtUerepeL/E8DIkuj88rHLeBl3E6lcBRumSfxdL/wmOI0YTL1KCPAz5JIWmoJYO2BnJWxl2yqGD9ku3bFY/WvJ7wySrQ4FCouqvvlq6yFNep8XM5dneX7/V3xM5etwe/gu60Owh5j48GtiQWEPCyxcrV+yfrDldOqNNpjHPhWInU46+BIGVNRKLTbFJk4qeYYc1duPk8EQai7KS1YtWbvTY3kmHpREALsicSaytVO7v7oyDs7vdBjfujcBTthrujwSCMbA+JgtwXgjWIypXKeczsjPZUWYlRN6xNwfdqEcZCBr+ExgBhfYiGaMbriQqx66AkLJh1UljTwXxzLgDpwAhXolYpovTWtkR9f/Va60ooI95hW7wuVbFFcUdONWzrkw+hWquMHacpsOKzCW1NQEmThcqgPYXOaqpD2l+QCqSTYedbmuiHk1QIkSvjQx0+IVW9kUr4s5RL5FAQywFMxFryRYZYQhaYECzJwuo0rp7AQBOdHnvNQzZx8h06YWyGDj4DrfYgqDN0Zdv3YgoGQGHSlmXFruDTHfD6YbQz5BwgWm93NN2P+GDQ3R/t71OHK4zhM9FWzOpLv8U9BBmwWAMakb+DQgC2ge6JAVr86fWPaDyxVNixpZiOX5aJr9kWYKDXh+dsuMtiQEI5XeezNSUo/+qikYtAckv4DECVbG1yC7x+dPxmfHV6CVcmx/+8Or6AX0irgd/HCryV4lITVJrrG+LYCXADuMyIGNSBqO6Vo/oKBIJMXB0o7V+Gtm6YC0KY4VZvmVElzaIUeuhqKFHcfM3YC9kRnS1AbLhxwTOA0uWuHw5/NQ4wJfmnTpOv2BxguUhfdti4rJ421xiYvwRCDMoqhq4lEOUQyoI2DXWeMaUzGaw1+StVrleGIpOcVo2CwQGcP+4ngPYxLZOY1SgsvcWx6OwDPFvN1bm7rCiNVLpUGYc+wqLvQKfYSzDIo0xmhrl0hOYykHhUMa7MWNW0T+nunWWGNmlwt4vn5glxdx5D+vFJtPLGF+GCj1CJzUZkjcJMLiM5WE6T3ajSXEXgs0iKONzE7iZ2N7H7xNhdvzlxTwfcXYI+vSb0uVJuuwGLZwP6pOQ9Shd7Er/b9ssacgvbVgeRfv5w6Z7PYP/6NcHdh++Ij2wpbz7fKO1hr08RfpTGqtkCGSQ9WgkiyEQiPCC+VxyToqyqBs3V3mhow8BBVQtEhKyZsqXOGQeVpblSyAk3WyzUwqifMjbnkB+hZwR+bQakPj/0Ey1VtkGSGyS5qUabavTXqUYbJLmJ3U3s/jlj90EkWXJF0eJwkskXC54urae5+ygtZzCAFedUVtvRZKp1tILEWImxvDpy8Kb93rQX7QZiGPJhuDPYj/rBTp+Pdnu7vemwv+tVa/31Ko7LIKvHVMXe1o7ucUP6BXBcrsC5TKZ1WN/+A/WmIsK0hqmnxM2gc1DppxV2HLacPtEZyAaEATum92wvXk1O7TNESx71Zp+eYdC6B474eAshJfowaFqabzrJs4GOG+i4KT+b8vOHLj8b6LiJ3U3s/jlj95ug4/Ax6Dj8Bug4ZAixIoRYPxI6hoA7EJpFYBQ8DJWDehXCxgREgV9u99GFfcbTmchKoFdDkf39liMxWrN3eNLDgSVT24lUK3VheoOxCxybFmMlHs+aQYpULKGH8eRVciEQk+I54VguJMUxCgR006U/jjKQysZM4W/lKlIFcQ4cUlIojlzdcIknsCKEf0CB9kFnkKi/4x6ns9b/tB/MJijxKUrM8NwDnmtj5f7vqO2UwAkwn2K6uLC2vue4gN0z5wraCPE1semrhKAbqL6B6ptyvyn3f41yv4Hqm9jdxO6fM3a/Aao7NHQ/VIcBT4bqMLbTZSWWesPt6dj/L2KnUHEckHszHRBWD1cYHJRgBFykl3tgkSuA+IfWlcd5NsfIlKE6WH9b9ABfHMFM1HYPzITA9ROeU10I8FP3Oi0mKHwH9cDbXp9jtm9bXki985A7hKFWA3kaw+R5liXmYHv7FhwDHOKuwxPZKWYrfdMJ9GJ7CtZoSXR4rtUGNQ6gl2rtAh0yZSoxWmxqJeLWsO4wrmfAwHSU4UHKxTnkJbQ7zJLZwmP3znPpMrCYQNvyk6HRHfLUhnwg11Ua3/3vslhC98jSpr4HV4PxDDhdE9Gz55ILZ7pAjG9Xb7jUqm7h04V+Y7EzHNZnrwVPoQGxB25e/Pzh8iWrvE2L71MzIbEVgdg8BxehzDkuDp/gJCpmqc5nc2J8XDveg5HKohgEZh/VhRDsujhL/R5KygRqAKkUJwlKOzjr04vCOqH4ImKstp2VJtHxICK2QUPbvDbvJVVWakGkKt/w6HxUvntRSiJCwDFOROoo2XVSyMUrcj2Xib8V1HxLzSdq5uUaF1a114E9Lh5AukASPDakrWcvbun5FXrYr8EVpLrOA2rC8VE/lBUUVns2HzV6PtKr8/FRfaC33erTmE1kzEDVjUN2woK51kb8nTF0HQyD61kOUfRstugVO58iwu93Kyz5dklf+gBCib9TCAxlnYlPEQQQBtJ2O4ZC8heyLMT8L9Cih+yXmsx0+RpqNY4MdWCezTMu6OOCvs0BxvFvSyE6FsQ2ykB5wDrA4cr+lAkco5W8Z2m1ZnUiv01zsDQEwCpRMcmB/eNgleDcL0Y3cHQ5BtKwR682uWNq+PEER+tu9eqpVVax+7CuwSa/sYYyvKY3y2/5DBVL8x9NXpR4vNqkwZfhv3eWvieT/HHy7g/KeJtM81fMNA5Vo7vRsmsvaqGTv3Z4rblpiLvacwH/wl2KVQLw0B7ZL8IgiqkSSmKe0fubGNXBXArabkgEzxD7baFn6QVFIoBqDH9oKonQjL73kQLLHBpEGQM92hAvVuYUMBZYol3xb5OX74Pb15877AN0gCoAs2D3hweD4d6v2rWBF2CZczQsOyqMzfBjGblyXwLIF4yDSz3iEaE0QW4TFzSDShS60AT9yllFFKOroQj0Xp1IF+Yswp1sia9Jek9cC+xu3DY2qB6t6D6asxJkImLyTBxXh+2P0QZv8+ciTrD/hKwLAExUVnh3ctmgCMSUe3ai09m2m2S2cSwQwfbIus+g0+t0fWoX8KMN2mTQilWIvxXZA58iWvfG29U+/o/9mJGrQ9hAbCe4x4bS5bahsQ3ldeNzRmiXRmeK3ziCHmUOisE5t7fIL7ZYd3j5t1xg33/9adU9UdcJhnMvvLd9S6CqpRfFJwle0sOl9u8ftUpT7Cuq5WpLwYOfnwXuRLTJAQ08SEJ7R8SlHWl3lyo0Gs9fak3522P0Nn5PvXc/QCOQ0f4LMv41aA== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

+ +An Identity Profile object + +
Schema
    owner objectnullable
    + +The owner of the Identity Profile. + +
    authoritativeSource objectrequired
    + +The authoritative source for this Identity Profile. + +
    identityAttributeConfig object
    attributeTransforms object[]
  • Array [
    • transformDefinition object
    + +The seaspray transformation definition + +
    attributes objectnullable
    + +Arbitrary key-value pairs to store any metadata for the object + +
  • ]
    • identityExceptionReportReference objectnullable
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-identity-snapshot-summary.api.mdx b/docs/api/beta/get-identity-snapshot-summary.api.mdx new file mode 100644 index 000000000..3d3a917c0 --- /dev/null +++ b/docs/api/beta/get-identity-snapshot-summary.api.mdx @@ -0,0 +1,91 @@ +--- +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: eJztXP9PGzkW/1es3A9tEZOEEMqCdDpR2u6xare9AtfTsUjrzDiJdyf27HimJYv43+/znj2TCQkU6Opu6Y1U0cRjP7/v72PHnsuOzVQuC23NUdLZ70xUcZQoU+hifmxk5qa2OC5nM5nPO5udQk5cZ/+sU/UQf9eusHh0vtlJlItznREhkDmZaidmqpjaRICkE8VUCecJibHN+bv6BDIitiX+UpsULlOxHutY6GqG0VzMrCmmvUTOxQf1W6lz5YQsQTnXvzPfwsWQQdixeKITs18Njaaeuf1cyeSJAPuZzCV4UjkJcdnRxGgmiykeGTzAN53gs4unaiY7+5edYp5RqytybSadq81O7hmAooq8VKtCqwXjTEpdyFmWEo3v4q29vnq++92ulEOV7Mm9/ijZS3a2h8OdwfZ4BOqBo99KxcoOLI0UVKNuZ2uVjUQWSvih4vNUx1PhgjVrK8BAtThNTgf9/m7U3476Wydb2/v9Pv79+0butIE6P8n0Fv5A25QzchuYEN/YnJ3ztWxX5PAh0TGsayaCDA/n4GFd8VKNZZmSQ1nfJPRYGBLLuw6EuYnXQs9U9Ls191YmDRQ0cHn605PDavIst59g+WVF4vmNvKR6povO9cneygsBXY1UTt4MR6+mylVR5qb7kzlWSpz9c1scvD8Sx4U0icwTcWjTVMUcCu9rFz9/Oi2KzO33egniLKUo7zqp08xCyd3YznoIlp7MdM8FOlFc04kWofKMQ3NGjqQNPs445rqdZjCMZepUQ/TBTn+Nism4E5VjpCfjm7YH5BPa6Bk5CcbN5IX/zFQSr3D+dnWTNu147NSqOt9xMzmV5XwzLtM0aFXgQVeculKm6XzhO+KzhkdtsHU2SPGZnGhDsVRMc1tOpkwnGObRmOMrjFGr/2blc/5e0f3RWGxQjtwQuoBWofjMZmXqVanExr+iE1vINDqk0Ruk0swap8QUyRruz3agjmvCYSpB0ZZpggQXIgOWQyRWdoP+xIb3iQ3xWZGqJgYaS2Ax2EybWHHqU44TjIShwUooRLE0Yio/KTTDRqwc6q9nmYyLTZKGEycsNlMGIc/xD09ximbdYCJ/Zck3iCfmFhmtVF4L1Btsl67i5lF4kK92K040sjZV0nQafsIjr67OiZo3qaMBKCr037KPHNS1KEWpJhvX1TOeSjNBodfGlzKu5ROIIDzHxG6M9I/uRFdmWcr1wpreL46IX65yK/OcC5Au1Mw12u3oFyiJ8EFOSi20Z9m792o1W5aBfRQ9iXvoN9cx1RA2eGOw9+K1g71vSOdsrCFpIkKyqohdNcxQMQV1Drai/pBqNBdo/Ov2qU7XUw8wDprkQvSWSX0I9gDJK6I6XGeSw1QTJnuV5/CRCIBrEV0+83HUiJFNGEBog+l08hBr3KD1RBXw6UOb3EH3r7VREZxCE4eKWY4xMFRjCm32ck+SDMSgk/p1lwo1NNHdEi9kwgCT5DsMwpAScxn/ClqEjr/E0KnRGC+qIXDnBdZdnVbtKjl63t8bDMfPh1IOvhtu7e6M9sZye7u/t7O3R7PPlHNyotwaN16e+ntlFIwsUhvDIr9DIYC90D0zwJPf3fOZxh30T9jI963FDPyKQl0gWUrx4vC9GO6KFNFccrucXFOCiU6PqZigNstRlWsguSf8LtcTbW4DlS9fvT44fXOClg+v/nH66hifiNbKiuTAVKDScjmZ2s/McRDgs3RI4ZQtkZjFRqC6AYGkcc2OOqxl5g7KFCHvYUSYfc2IJmkxzu1sKZQ4bi4K8VR3VXcTtQFtSHBA7COJIiFgQi6YB3GssiJ6EzS5ESrls644SBJNQqKEcfBj4QXIjCIjE6pP2gTwg1BWXFhtWVAd0rFatsVClcvWWGSSN02jUHCA8y/7yUFcAGexTyxFYe0tgcVgH/DsNbfM3UlDaazSuSlQkjGCIFxscxRlZCbIpoESQjoiczkkHlP1qzPWVSNBcrp765l5WVh+FsvS3SHu3qdIPxGLVj/4pELwMXYPawOyRmWmkJFCpufB1Qqi0kUV+AKwNE3a2G1jt43dO8bu9YcV8AlPGfpsrUKfU1PtKkGIFeiTs/cYe23ryRtykzYoAkT64eMJAvtXZai/usgIUP+B+MiX8jVQurKHbx8R/KiNtWQLYpD16CUYIxOpZJ/5XnDsQSKrant1ttc2H2k4qFkDEZE1czG3pZBQWV4aw0sstykSq5x5UoTFFSLCOZ8BaVaTRH4d0yLJFkm21aitRt9MNWqRZBu7bew+zti9FUnWXHG0BJwUNjS9p4XnJK0U6LDY5a5Drt4obKIVIiZqjNVZRg6d0WBrtDXejdUwkcPk+fbeeBA/H8id3a3drdFwsNtp1vqzRRzXQbYcUw17ezuyigHiPgHHlQbO5Qprk+XtP6g3V2NKa5R6atwMnUOl5wvsOFzFjj/aArKBMLBjfsP24umHN0QfUzN50pst81gRzPaq8/vqBCl5R11daFe00LGFjm35acvPN1N+WujYxm4bu48zdu8FHYdfgo7De0DHoSCINSaI9b+Ejon2RyPGMApkiEuo1xBszCAKPoXdxxD2hcwnqqiBXhNF7qz7nfqIDoqRwx772W74wdrv2koDIKsuMh9ANQhqwWILFtuC0xacb6PgtGCxjd02dh9n7N4DLAY0dDNYRIc7g8UdOjYoaiz1mo9w/rcxI4dK4IDdW9iY0WKyQIGMK+gySYdvqFAOoXsb+52ev+RB6o7C4VGkld6lTq561Y2HyNUXWDw29YyWeQoC1ZnaS9gPdrvqykx3q2Ooxn7mg7UjKG1NPqIDkD72qAMf4fUTdFnjuSan9hmQiXv9h4Oynfrs7q2Uq7Olc+Bi4clsCgRAcDBuBouZNPMnjnt32aFW5INcp3l69fWyeEI3yLJOfbfOhv4CnF4TkUQ4J3PBEUCI7XUKfg59+jooyfhn580+xwTXPYcrPRcliLaqBysMvaNuA/FCyRxrCX964+kPH0+eiQmBVE4SpSN8rDStKhBm7+FGnAQPqpMMNIjr0uKiwMHSWREKOjFOoRQRzn1X96h+RHX4gHTOaqdBijMIjbr7qW+5NO6GU94/mUi81Lk/FO64TxDRn4Q/yyq5ZEOuhzLxl4pa5KlFTM09u8aFV+1Z7M8ex4h8IiFTx9p68OSeXtSgR0svtBDV6zyQJgIfyyd84spqD+ZjiV5E9Jb5+Ml85Btay8Oq23PIYHTV4UjEU2ud+psQ5DoUKmeTEpH2YLb4WljEEREN+g2WIj9lpCPgSebvDQLDeGeSI6rnDGesX9tz2P7MlkVe+JlvX/y8JDM3n6HsUs/Exve4ynCNZ5owogkjnydc4N9XNXIsxDbJwHnAO8Dhwv6cCQKjjdzoaa3N/Ey+x2OofNBFQ6bisn3/ZX+RBMMnfx2Retd9kKoJjtdnnvBdBFpU2paUVW0kXNfgKr+pRUW9pjfPb/2DHFXZP5u8JPHBYr/lnUnnf3SWviGT/Hny7v8o47WZ5lvMNAEgk7vxtGEl0XTyFwHTre7/Ob6Ph794yrHKWBwrncUVvCahLJUFeTVHdTzVincOMiULwoeb5Fl2xpGIRT6FP9aHTGiSow/C1gG3ypFOQa8rThYzSw4YDz7JrvTdleG3fhvug3XFRyzmTAyz0EKOTpni2S82rOiOYZn3ZFjxsjI2QNdsVhq6Uga2y5mQcKkveESiXVz6xIV1nVGVLixDv3pUFcXkaiRCl5c0+cy9G9OmNNa7DcN/YS7Y3YUdaai+cdFrIcgHlbJnUr9laP8l2vC2aKrSjJaSyLqK7oAtZnh7dLJCEcRM2Ii3+aQXBrke9aXbbRDeu892d6vbj3hJgfbMugKL3wbx77/i6v91X71cbNj/OV8vEKoXLTt6GW2ykU5Kv1Tyy9WzztrlKsbu+zcPXF+xYn0zhVJp5OUl7dDQEu6Kmv0lXFoXwcwUe4tbm7do7QEvBlgr1a+Kth7qVxOE3YUOX3e/Hz9/yI3/W7lsvKLgK/i81zsAbuGm+RKCB7LzuN4ScIsuqpcgPFAP/1/X+2/RY/36gwcqsr2r//ju6t/iDtULGRbecL7YwrtnyXgaamLyTHC2Xnq7zVoeqt+ezLzJQp2ME9rTRVVj12Fm/AP/g0NjyMpP8iRFvQn8/Ssgkav/AE4EdR0= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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' + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-identity-snapshot.api.mdx b/docs/api/beta/get-identity-snapshot.api.mdx new file mode 100644 index 000000000..c6927d63e --- /dev/null +++ b/docs/api/beta/get-identity-snapshot.api.mdx @@ -0,0 +1,99 @@ +--- +id: get-identity-snapshot +sidebar_label: Gets an identity snapshot at a given date +hide_title: true +hide_table_of_contents: true +api: eJztW2tv2zgW/SuE9kMfiB9x7LjOl4WbtjMZ9LV5oNhJA5SWaJutTGooKq0nyH/fc0nKlh9p0kyx0ykEBK1N8V7eN8+lqatIZ8JwK7U6SqKDaCLsUSKUlXZ+oniWT7WNdiLLJ3l0cB6Vj9ivMrfazKOLnSgReWxkRhxAfzqVOZsJO9UJM8IaKS5FzjjLMxHLsRQJkyWPPPBnHH9sIi+FYgm3gh2LPwppiKwAHyP/dOKxPIaoTI/ZA5mog5JNY+pFOTCCJw8YhM244ZBAGBL5KpIkVsbtFI8UHuCbTPA5j6dixqODq8jOMxrNIa2aRNc7kfECwB7WFGJTRbFUwrESX/gsS4nHk3h30Bb7/Sd9zrsiGfBBe5QMkt5et9vr7I1H4L5VItL76zJtyrA0aaBeitFpt/uN9l6jvXu6u3fQbuPv92hdr+sLGskzrXKR05qgov++oq0efRSxbYJVrJXFIM3nWZbK2Pmo9TEnoqtNRTwlecdQwFnpl4T5NpRd19VWJTh6tqLoKN4f7I3bfdEf7Xd7vb3Bfmc/7vQGvW7ce9LrdZ3lZJ6lfP7aWfouiwUCRr6heKsKsLL6MOEz9ju+cVqnjOc7LkKR/nmKmF/Rz4hYm4R95jmLEdFWJLc5ttkm57oISRH1yTMKhr8iAq0deN15bR7HIs+PrJgd6kLZbY5fXX/IZjxjFEVcKgjoRIiJliwueDxlnieTYApyniSSaHn6diWC1hKFZLH4PCrsyvNvEWNhiQqnuwtwXbGZD/CoEw/a/cGo02/zzv4+32/v0qd+fzCOR7BgP1oL0ugln+oZZ++K+BMWitZ8q4o0rYbbzZ5ZN8ZHPTqV1nnz12P2iis+EQazUu3zF+Ov/3uIgbE0uVVVYWgWX4xVJUO9tTNXC8D0hmAwmhbtlM9gwbEMI87WqfAcOk/cFE+2R7a0Qd5y6wk7z3EoXGRwzOpuK12HqQQNe26MNqyBbcUWRtEO5FOaqqHILRvpBHUcgaYueSqT71jdEoGwSg91coeEfCGVaEwMwhASCidyDEIGjpcyodCcaYOcdSzLquTmNVeyFJZo7rKnPHHbKOl3GJQhYxoefwKvozuU3TMlQc9KEmQFG0OoG5YVfcFH++1Bpzve73LeedLd7fdGgzHf22sPeoMBrT6D5xFw1azhxvD5xtK/CCWMjBmFZSr/FAQlOGzvBHCLg4TqwtYMX/WB43EH+9M+5+cu1AzyMiu+2B1AlKeHb1m3z1KuJoUb55M1I6jG2Qlt6khQPqIht8/uBCHeGDmRapsoQhUzwlfPnr8Ynr08xcjx8/+cPT/BJ+K1gbKGCtGaUFhCVMTCVH92EgcFqILnqBgxSkaTPQ5cH0MhrvLqROm/5fMcxkRsjXmRWlCE1bdQVFmzsdGzlVRyefPFsoeyKZo7bERjM25RzEc8B4H2W83jIapAZhsvgyUfsynAmzCPmmy4qLIM2QimoJ+DEUP5pdT1DMYFUhnCSODDwjKlrYzFqi+Wplz1xrKivKw6hZIDkt8eJ8PYFhDOqVnNwkW0BBGDfyCzt9yqdKcVozmTzrEDxdCCp+kcZjTAAahM0E3anIVyRO7KUXhUOW9RsaqF0pW7V16YZ1a7ZzEv8jvk3dsU5afhVFs8uBQh+RAGOlQj543STaEi4SGp7YjDrIW7ysRnQKtpUudunbt17t4xd9cflrgnPHXQZ3cT+pypsneGEhvQx7joUXqtwfaO3GEwSIBIv707RWJ/QoeA+eJLRs3jd8RHfivfEH648IcfH5XAvNz6l74gAZ0dvQZjVCKRHDi5lxI7Q3lT7W2u9kKbkUSAqi0QEVXTsLkuGIfJTKFci8DzHZZokasHlk056mNoVFwFpFVV0si0VN+zT66RZI0k692o3o1qJFkjyTp369z93khyIZXLloCT8mI242buIy08J205wwRW/nTAFinnXLWOVogZW2CsaBU5RKPO7mh33I9FN+HdZH9vMO7E+x3e6+/2d0fdDp2MLvf682UeL5JsNacq/vZ+9D+UCHMJHFcoBFdutU5Wj/9gXiPGVNao9CxwM2wOk14ssWN3Ezu+1ha6gTGwo7nhePHs+CXxx9KOPdlNFyYWBLO96TCdWwcpKYZhaZnbGjrW0LHefurt56fZfmroWOdunbv/zNz9JujYvQ06dr8BOnYZQawxQay/EzomwB0EzcZwCnSIC5hXEWzMoAo+hdPHkPaWm4mwC6BXRZG9bb9TH8E5hgL2xK92ww/W/tSWKwBZ8SXzCbQAQTVYrMFiveHUG87PseHUYLHO3Tp3/5m5+w1gMaChm8EiJtwZLPbo0iNbYKkXFFz/d8zoUiVI4MKb6dihxWSJAh2uoAvykbtuTzWE7oIfRC1/lZ3M3Qh3UFFWWlcyuW6Vtz3xla7tXoPKY1MvaGFSMJham+UHrdYV/Ae/XTd5JpvlbValPzdjPWuNYLQt9YguQPrcowls+PYogN+ms7iRFNS+Ajrm3v5ORwpf+MH95v1VzuWF6jlwMfNsdhgSIASYG4aIGVfzB7mb3XQBtaEf9Doz6fVf18UzukGXbeb76mqYzyDpmoqkwgW5C4FAN8jJX2eQ59CXr2FBzj+/qM45IbjuJdyYudyC6Ki6syHQG5rWYU8FN+gl/O2Nh7+9O33EJgRSXZEocsLHQlJXgTR7izByRXBY3mQgIrcvGV1Mpk654cpdEUo6Nk5hFPZenQjBzssLuq+xOxyjnDuzE5FwFYSoLh6WHkzEpUhp42wurU3BKRPVghVbfIXukdskXTchFT7O3GjzvWqwZ5Jql6TNnuYEFd01DXaelXrxil73FeJfJbeG59Zw3PJHa1J4057H/u5xjMwnFjzNnbXuvbjn16jwo9YLI8R1XQayRJBj9YZPXHrt3nKs8GsQv1U53qt3U0mX91fIyjeCUMGKNGFHLJ5qnYt/M0ahQ6lyPimQafcW6zMt2nAZ0ei0KyI1/JIN2QCedPK9RGIoH0x8RPu5gzPa9/YubT84z6IufEC3nbAPKzq74XNsuzQz0XF+b5lpwQYt2PB1Ig/y+12NAgu5TTq4OuAD4HDpf1cJgqCV2uh5ba38jn3L0dD2Qa9TOS55duC/HCyLYPjkX7qi2Ys5KNUExxd3nvCdBV7u7YuqscqDhHULbsqbauyoa3bz8i5+kKNd9kfTlzQeLs9b3qh0/r2r9A2V5Mepu39Txasrzc9YaQJApnBzy669/UNB/jRgus3zPzQJ0Bv/4qnLVYfF0em43s2hmCqjLOWWotpldTylV1XpSFdwS/hwhyJLz1wmosmn9Ed/6BhN3Jt5BiJz9HoyBb8mO12uzF3CePBJfqXveRF+69cISXSiosneoZlTMdxCjRzdMsWzjzp0dCfwzFtyLHtWOhugazYrFL2ZBrGLGb04e1tEJDKPC1+40NcpUdpCO+i3oCqzmEKNVGi6lsbM8jdjOpRGv1tx/C1rwe95OJGG6cmL4aWxpSLHInWRSfNWof1tvBFtjalIM2olUXUFvQK2XOHV0ekGRzBT4SBem0krEOUtmgsm1EL58Nlr7jbbDddSYDzTuUXzW2H+i7Du+P3WF5jXA/NqeTr/I7wfHTYm6ihaGZ2fkbqF74J8J3oebe1EQXvgX50um1EacRqjd5nCYER6dUWnL9SeXdPwH4Wg1v78Ytl5uQ4IDqXPaILHKDHrL1lXTfYw6Js8ohxbe/V6qzLlkaGaL08LInz8JOiQAXTUUt5bgI33ru8hg6O8vsA8fxblTOIf+dOqCtHG7znUKS5OEH55jjC+/h9VezR6 +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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' + +## Request + +

Path Parameters

+ +The identity object. + +
Schema
    accessItemCount object
    + +A map containing the count of each access item + +
    attributes object
    + +A map containing the identity attributes + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-identity-start-date.api.mdx b/docs/api/beta/get-identity-start-date.api.mdx new file mode 100644 index 000000000..1e4b67d8d --- /dev/null +++ b/docs/api/beta/get-identity-start-date.api.mdx @@ -0,0 +1,95 @@ +--- +id: get-identity-start-date +sidebar_label: Gets the start date of the identity +hide_title: true +hide_table_of_contents: true +api: eJztW2lv27gW/SuE3ocuiLzFaRp/Gbjp8jLITPuyoMBLA5SWaJutTGlIKq0nyH+fc0nKlpc0bWYwMy1UFK0sXV7enedS1HWUF0JzK3N1lEaDaCLsUSqUlXZ+arm2z7kV0U5k+cREg4uoesb+K43N9Ty63IlSYRItC2IBBmdTadhM2GmeMi2sluJKGGaIF0vBjOVjZqeCyYrTifitlBo0vMQgLX93wjCTQDAifiBTNaio46mfd6AFTx8wSFZwzTGd0CTfdSRJhoLbKR4pPMAvmeLaJFMx49HgOrLzgu4aiKYm0c1OpL0A0N7qUmzqU5PVsRKf+azIiMfTpHvQEU/2n+5z3hfpAT/ojNKDdG+339/r7Y5H0c0lsTdFrowwNHmv06H/Nqe43UCYMcmVxQ8ayYsik4kzUfuDoeHXt+pWF7XX6e7Hnd240z3r7g46HfxtdTqd/0c3+LMT9bfJdZhJzMpeaJ1rFsNRttRKpEx6Acluwlg2ylNYxjCprngm09Y9BM5HH0RiyZuawtFKb61UWC6zwzwV25RbFfalVCKeaC5JQuFETjCQgeOVTDGCzXItmGdZ2djRtVYMBUu0uuwZT11gkn6HQRmYyWqefAQvSpW7BDpXEuNZNQT+ZGMIdcu0Yl/w0ZPOQa8/ftLnvPe0393fGx2M+e5u52Dv4IBmnwlj+MSbJszNtebzjalfCSW0TFiWJ/DI74IykcP2TgA3OYZIK2bmbh84Hl9hfwpiT7tQM8jLrPhsdxhnzw7fsP4+y7ialO4+n6wZQcXnp5S4ZZbxEd2ijITmnvFrLSdSbY1zVc6oPD1/8XJ4fnyGOycv/nf+4hRXxGujSA0VojWlsISoiIVp/slJHBT4xFGxRAZziLTFHgeuj6EQV6ZOKP0vMzcwJmJrzMvMYkSYfcuIOms21vlsJZVc3ny27KFsidYOG9G9GbfJlI24wQC4kMgfD5NEFDY+DpZ8zKYoh0I/arFhmkpSkmcM2QimGD8HI8bTlFLXMxiXSGUII1FxS8tUbmUiVn2xNOWqN5AE0jqK47pTKDkg+d1xMkxsCeGcmvUsXERLEDH4BzJ7y61Kd1YzmjPpXFmeQAueZXOYUWtYmI2gm7SGhXJE7jIoPKqiW1QsKoGVWq7c/eKFeW5z9yzhpfmKvHuTofzETrXFgysRkg9hkIdq5LxRuSlUJDwktd3gQLVwV5X4bCxFlja52+Ruk7tfmbvrD08CGgtPHfTpbkKfc1WhUSixAX20ix6Vr0FW78gdBoMEiPTz2zMk9kehiF58Lghm/oX4yC/lG8IPF/7w90cEPxbOWvEFCejs6DUYoxKJdODkXkrsDOVNtbs528tcjyQCVG2BiKiams3zknGYTJdKkSTc7LA0F0Y9sGzKUR85MsIYXwFpVpXGRS6VbZBkgySb1ahZjX6c1ahBkk3uNrn7febuF5HkQiqXLQEnmXI243ruIy08J205AwGr9gXZIuWcq9bRCjFjC4wVrSKHaNTrjrrj/UT0U95Pn+wejHvJkx7f2+/ud0f93n5UX+svlnm8SLLVnKr52/vR700KfQUcVyoEl7F5nq5u/8G8WoyprFHpWeBm2BwmvVxix/4mdvw1t9ANjIEd9S3bi+cnx8QfUzv2ZLe81IkgmO1NB3JuHaSkGIalpbENdGygY7P8NMvPD7P8NNCxyd0md7/P3P0m6Ni/Czr2vwE69hlBrDFBrH8SOqbAHQTNxnAKdEhKmFcRbCygCq7C7mNIe8v1RNgF0KujyL1t76mP4BxNAXvqZ7vlhbXfteUKQFZ8LnwCLUBQAxYbsNgsOM2C82MsOA1YbHK3yd3vM3e/ASwGNHQ7WATBV4PFPToRyBZY6iUF19+OGV2qBAlceLM8cWgxXaJAhyvofGnkjqtSDaHznoOo7Q+HkrnjcHoSZaV9LdObtjtfGaf+NKtHpV7EUmcYOrW2MIN2+xqeg8duWryQreoEpso/tZJ81h7BXFsqER199FlHBGz45ijA3paztZYUzr72Oebe8k47Clx4wL3t/iJnOspKLp0DETPPZoch9ENoudsQseBq/sA46pYLpQ39oNe5zm7+vC6e0S26bDPfF2cDPYOkayqSCpfkLoQAnYQlf51DnkNfuIYluf3isk5zSkDdS7hBuVx8aJO6tyHQayLrsWeCa3QR/tzGw5/fnj1iE4KnrjyUhpCxkNRPIMHeIIxc+RtWZxhokFuRdF5Opk654copEUo3Ns5gFPZOnQrBLqpD1b9iXThBIXdmp0HC1Q4adfmw8mAqrkRGS2ZraW0KTpmqNqzY5ivjHrnl0fURUuFy5u623qmYPZdUtSQt80QTVHQHNNhFUenFa3rdV4j/VNxizy123MyjNSm8aS8Sf+o4Qc4TC54ZZ617T+75xTV+1HThDnFdl4EsEeRYPduTVF67txwr/GLityrHO/V2KrH2rg6rjtIbLJ1Zyo5YMs1zI35ijEKHUuViUiLT7i3WJ5o0dhkR9zo1kWI/ZSxjIEkn3zESQ/lg4iNayR2QyX1X79L2vfMs6sJ79Nkpe7+is7t9gQWXKNM8MfeWmSaMacLY1wkT5PfrGQUWcpt0cHXAB8Dh0v+uEgRBa7XR89pa+R37thtDywd9muC4mGLgfwyWRTBc+Q8YiHpBg1JNQHxx2gm/WeBFi9qKsaothHULbsqb5VhL1+zm5V28iqP19d+mL2k8XO60vFbZ/K+u0rdUkn9P3f2HKl5TaX7EShOgMYWbmzb0EPUgfxYw3ebOH9oD6I1/8dTlqkPh6HFc1+ZQTJ1RkXFLUe2yOpnSN160mSu4JXy4Q5GVz1wmor2n9Edn6BhNNGiQtga4lY9kBn4tdracmbuE8eCT/Eq/TRne8ucISfSgosXeoo1TCdxCLRydL8WzD3no5U7hmTfkWPa8cjZA12xWKvqEC2KXM8YRUndERCpNUvrChY5OicoWuYN+i1FVFlOokQot18zomXk9pu1odLo1x98xF/xuwl40TE9eDJ+wLRU5EZmLTKJbhfZ38Ua0xVORFdREouoCgInaDL8cnW1wBDMVtuBzPWmHQaZNtGBCLZQPn91Wt9WJXUuB+0VuLNreGvNXwoatiy995bYSktfLHfm//ZPCsP5Q49AuaIOMtCp9s+NbzYtoa6uJsQP/teGy20RvMoVBaMz1Ne2rUPt1Q7d/KwU17ReXy87KdThwGF2jvR2jhKx/kFg3zMOgaPqIcmjtM8WtWlSbgWq+3AeIcPlR0PYBxqHJhsBuf8cJ4x/4HaDakI13JNSDLbryVy8QIDd/ALu9ZG0= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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' + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-identity.api.mdx b/docs/api/beta/get-identity.api.mdx new file mode 100644 index 000000000..f592862a0 --- /dev/null +++ b/docs/api/beta/get-identity.api.mdx @@ -0,0 +1,103 @@ +--- +id: get-identity +sidebar_label: Identity Details +hide_title: true +hide_table_of_contents: true +api: eJztXFlz2zgS/iso7sMkKVPW5UsvO4rlZDXj2FlZXteu7aqBSFDChAI0BBlH6/J/3+4GeEnykczUzlF6SSQSaPTdX0OA7z29EAlPpVbD0Ot5U5EOQ6FSmS69HS/lU+P1rj33SArj3e54oTBBIhc4B2aMZ9Kw/schS0SaJcowzoxU01gw6QixDB+wdCZYTpsNBw2gb0SQJbhU7/reuzQiOdYqFV/SfpbOcF0Zql5OpZcIHnq3D8DAgid8LlKRGJookY0Fhyk7noIX8E2GSD2YiTn3evdeulzgU5MmwIj3sOMl4pdMJgIkTpNMrIpUcolkxBc+X8Q4X0Sdw+io2+keiKPu3n57sjeZHHbbXb633zk6CA89ZC4RZqGVAVXBwu1mE/+rk++rUjV68rMIUlglQMlViqP5YhHLgGyy+7PBKfcVWXgcn0ckt5OqIFEKdW31gKpK0L5kOZgLalnj5mJpUjH3p0KhH4iQZUr+koGpBkxHZLTzfIG6GquakWGr3enuERM8PFfx0mr2IbfI6qpn8PQr6HMcj4YLgH4qNohxjC/gIwvh/bOUI53MOSjbw9F+KoH4KuvV5dvNdsdvtvxmZ9xu9Vr7vXa70e20/4MczXUoI7mJpVNuUmZfB78Hb8Ac+BgNesuNONbzuVaDVAPX686Tj8x9H8etug+PJTfr8bQaPv0YQlOhqM6VrLeDkhIGwpH0skwypSh3HGc27mYyJWODx8u4H4YQUi9YdgxkaQbjdkqu6Y1rGaFCkXzvHjQCPcfskcUxn+B757wgfwCUYLmLFATaxER9ziamSiLMpBUPqPKlsjmG7clodD6C7+c/ejtI+LbKsn0JXOUTkafshZrJ53xniInMMKmIC0PxX+Hh8mx08n54MT4ZnQzgce3Lx5OzwfDsPXy66o/O7KfB8KL/9pRe94/Hw3+d4LMT+tgf02OY/WF45r7kIp6eH/8ID2oSumcYVVzxqUhGIqqIVzjr5nQNorlpjQ12qbuypfic4gbjc4Yj0GJy4yq50oaDk7PxcPzvujzFUzLa8+vZnPvISmXEB93WYZN39yPOQyG6zdZ+NOmKZuswaDf32/teJes+vd4/MljAx9yCmmKhNIuYL5lyyfk5RkZ6Ahpl8J9UWKceMOVI88GOrSw/0ToWXK2tfzUT4IKYEQBDFDVRIoZwCyIbXGkaVYmXUEQ8iyFJRjw21XTo4jaG1Au+A1lgtkkLG1PseswgFYZva+HK7rgBsEPEoVxOlithVM3MTb/V8tvtcWuv1233Oq0GlEmqGjwFXiZZWvXGx/y7D8pYsDuZzup8lDSeTqv3N14mwxuvd+NdUYZlV5hhb7ydGy+SiUnR3vTaJmB6EcQ6C22CoVfVrEADnLOc5XPXSOdZ39a+s2w+QdIw8qjbpgGo3oulCgYcZ/Ra3YNmp3t42DzqHDbhNeXyClvfT/EBZupidsm4XfUBVRvLSATLIBZFyn4cMtWTAmXnsxdFDrqHqmCYYlGb4uvgJUjlZ+GyWgbMLC8XYY5iXhwha2uwGfjhRAjFcrIMvIBnqQbfBq3jAyNSbzU6HupIsRR6nb/bEhec1rSao4ini9/pCsOhSMGCBoThKZSfIM7CdalIq1yF7K6aHB6VHSQs5Af8DSnodh3MYGYCsbub0PhxLGEQO0kS0J7PRtTFQFxLa1hUlYA0MNEhZSapPgMMChtfA9mf9jqrlWMdvsDt3kkl/GnCJXIoiOUAJiLE+CxDRBhzneSKzn2TxtUzN2ii0WJveQjyWvmOnTAIGhMefAJawxdUrEuL8PIpkICKXLRhWXEg+GS/edTuRvtdztuH3dbB3uQo4p1O82jv6IhiBKASZP5qXuRJwpdrS7/HjkUGLNbg6/K/oBAoZKB7YoAWhymQFuYbU2zdBkTjhWFvxxZiOn4Z9q07ULjeHn9k3QOoHWqa0XM+XVGC8i8vNoFNS/g8kVOpNrGSY43Bybv+5emYsNk/L08uxgVWXO8zVYhuqamOzvSdzSNWACxjRsSgDhE22BtH9Q0IxJWpDpSmUuGYK70ww62+YUaVNIsSPa+FUmCbfPZKNkRjB8IY2ySeBjM2gTYlZNoC0zf9IBCL1D91mnzDZgBURPK6waAnkCgkjxlEIxCF+UsghMgfQ9cSiDIIZUGFU2cpAxQhA1G3RanK1UxW5L2qUTA4gPMXtEBBChmJfKIWhYW3OBadfYBnq7k6d+OK0kilS5ViMbG5PdBJAhpmgACYTA1z6QjNZSDxqHxckbGqDSGluw+WGUrm2FvzzLwg7j7GkH58Eq148Vm44AM30C4bkTVyM7mMBC9RbJrsRhXmygOfQaMYh9vY3cbuNnZfGLurL0duD9K9JejTWoc+lwrQ4kwnVDzXoE9C3qM0ywfZPSxryB3Emg4i/XA1hsD+BGAMxosvC0SWvyE+sqV8fRe1sId9Psn3mPPSX9oCGSQ9WgkiyEQi7BHfJcekKKuqzvpq73QykeCgagNEhKyZsKXOGAeVJZlSyAk3OyzUwqjvUgCrkB95gJtANgPiqir0F1qqdIskt0hyW4221eivU422SHIbu9vY/XPG7pNIsuCKosXhJJPN5zxZWk9z72nXnsEAlv8aXv7QTaZaRStIjBUYy6sjB2/Sbk1a0UEguiHvhvudo6gd7Lf53kHroDXptg+8aq2/LuO4CLJ6TFXsbe1IKgYQ9xlwXIY/C5pU67C+/QfqTUSEaQ1TT4GbQecNu+3osGN3w2/dOgXZgDBgx+SR7cXL0SnSh6WJPOpNZ0kgEGZb1dldU4SU6MOgaWm+6tzAFjpuoeO2/GzLzx+6/Gyh4zZ2t7H754zdr4KO3eegY/croGOXIcSKEGL9ntAxBNyB0CwCo4AMQQbqVQgbFyAKfHK7jy7sU55MRVoAvRqKbB+to8ix1uwDV8scLJnaTqQq1YXpDcbOcWySj4UBnE0hRSoGWUsCukWvwqMtgEnxB/VYziXFMQoEdJOl34/wQIeNmdzfilXcz/eGkkKsce9Vg49JcCcRIfwDCrQPOoVE/RvucTpr/ar9YDZCiU9RYnbyJRACY77Y/93bdEpgqOhMY8wurK0fOS5g98y5gjZCfFnY9FVA0C1U30L1bbnflvu/RrnfQvVt7G5j988Zu18B1R0aehyqw4AXQ3UY22iyAku9ozPc/2/ETqHiOCD3ZjogrB6WGJxwBbiSuxKHOQTvl/W8XVlchdu9l+GDh5fYEBFaZrIkhkGzNF2Y3u7uPdgIbPPQ4AvZyI9mK32HZ5h3J6CYDTkHj5ja+MIBdLHOLtAgrSYSHddmOSJudexOw3sGdE2nCp6knB9cXkLnwSyZHbzn4JyIHgOLC+ggvjM0ukFOsyYfyHWZxA+/XhZL6BFZNqnvydVgPANOV0T07Nng/M7hBcJtu/razcOyhOBGf3ttsXMc1mZvBU/wgDKdfXn1w9X4Natco6MLP0JiVwBh8hFchJJYPz8HgpOoriQ6m9qj/f3aSRsMGhbFIDC7URdCsOv8PPMZZPcRpGNSKU4SlAFw1u2r3Dqh+CxiLHyNUpPoeDJUu6ChXV6b95qKHHUDUtn7EfC0caN8NpCYeyQWaxzjRKTmjl0vcrl4Ra5vZeJvOTXfUvOJmnm9woVV7XVgT24HELlIgseGtPXNi1t6foUetk7wBKmu8oCacHzUz0cFudW+mY8aPR/p1fm4UVczCRW0Po3ZhMUMFMA4ZEMWzLQ24u+MoetgGFxPM4iib2brDhf1KSL8drPCkm+X9KUPeJD4O4XAUNaZ+ATrMcERbXdGKCR/IstCzP9EZ/1/qslMj6+hbOLIUAfmm3nGBX1c0Lc5wDj+3U0EYBZiG2WgPGAd4Li0P2UCx2gl71laG7M6kd+lOVgaAmDVXi1Z9OyXXpng3CdGL3B0MQbSMMLp4sQYfGeOFpammrLyjYBVDa7zG2uoiCt6s/wWP2dilfyjyYsS98v9ErwF+1tn6UcyyR8n7/5OGW+baf6KmcYBXHQ3WnblshQ6+VuH19b37wxdhoR/4S3FKmFp6FTKC4pVQouYp+jVFNXBTArq/BeCp4j9dvLrahCJ7pY09HdEaEoX/RNgmUOvJmOgR3vT+cqcAsYCS7QrfjeZOymhwSWhkxQNdgXNmArALNiI4RldePezdh3ZBVjmIxqWDXJjM7wlnym8XglsZ3PGwaWe8YhQmiCziQv6MiVyXdhbq8WsPIrR1VCEBrUkydycR7ipDP1qxfDPrAV2N25HGVSPVnR/+KIUZCRi8kwcV4ftz9EGb/NnIl7Yy5QBADBRWeHDcLxGEYgp9zOGTqa7bpLZxbFABNsj6z6dRqvR9KldwNv12qTQvFaIF395Y2DDZtX/7stN9F/1h0dc4UDEv7vA/SlkJ7MdiO30rr2y04MJPUm3IWfAMb67v8ftC+x9HvAxtO3YG1/flm0NtYOgUfwcFveUHxXm1chdyXxdYTV8jNN8v00ty1bbg4+fBHbowCr0scAsbaEQI/aF3WSpTFn7GQIbpKLxfX+CluaP1Fr3AYSGbPI/1sJtzg== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Identity Details

+ + + + + +This API returns a single identity using the Identity ID. + +## Request + +

Path Parameters

+ +An identity object + +
Schema
    managerRef objectnullable
    + +Identity's manager. + +
    lifecycleState objectnullable
    + +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-latest-identity-outlier-snapshots.api.mdx b/docs/api/beta/get-latest-identity-outlier-snapshots.api.mdx new file mode 100644 index 000000000..55846702d --- /dev/null +++ b/docs/api/beta/get-latest-identity-outlier-snapshots.api.mdx @@ -0,0 +1,92 @@ +--- +id: get-latest-identity-outlier-snapshots +sidebar_label: IAI Identity Outliers Latest Summary +hide_title: true +hide_table_of_contents: true +api: eJztW1lz2zgS/iso7UOOMiVZseOxXrYUx5nSlDPO+qjUruPaQCQkYUICGoJ0onH5v+/XDZCijlxOancmq3nIWGCj8fWJbhC8bdmZymWhrRkmrX5roooTWShXDBNlCl3MT8si1So/N3LmprZwrZ1WISeu1b9qDQdDER671vVOK1EuzvWMeIHTxVQ7MXg1FLkqytw4IUVmXYGfMTgLFxgKOxZKxlNhPSdRzGdqxw/F1hRSG20mfVFMlTBlNgIFZmiPTiuHB7IQcekKm+HZVLqdFdrAGOPSJPyMlmg8eWPO1O+lzsFMlsXU5voPVohwsfWED7TU/YpPlEkjJyoDgn6uZPIAKpnJXGaqIEX0r25bBj+gAloHDzWp4/dS5fPWmpICEkIVZJrXgBc6KqwY67QgeQx45B4u7DWWqVM7LRdPVSZb/Vu/ZL/lihxaA6mCHshWJ6ev/30+fDk8GZwNL/6JB+cXZ5dHF5dng5PW9d3dNTF1M2uccsSm1+3S/5bBnpdxrFSikrY4CzZNtWML2tFvKi5cWxyzKfmX0GRzV2aZzOckwkTfKDHVk6lI1Y1KhSugZlfo2HViW5rCNa0FiGR+qISAyNks1TFbpfObIzS360LLPJekYl2ozDXGPRyyUk7OTl6zeHpPla17+5pbVaITyw8ym6W0ygrTO9guGPk5wm4TnLHNMwkltBIQRIXO1LoXYXF6ym40KtN3NYQEPhmzL+fSdGp/ei+diOG7BXyoia7X7e1G3f2ou3ux+1N/r9t/st8+OOj9i3AWtpBpHe4LoBpGmqh8HRTRbwhDAYEYaB2zmXwHUXmMPBvJpwlqv1stPqyD/h7LNzLGVwPoLiBMjOXA+/r1/cymf9cr7HbvaAFdeBfh/Fvl3eBDd/TfDhloPS4HCMsZTCmiEJf4U4+b4rDBHYWvc+MyTedCVnOA3zKpmzvETfsecRfiyyPc25Q5jiAKcv5xnkP1H0c5ssmcsoY2NzLVyTdgWY11xIHU6ZFNNobYMtgX2qhokmPjAULFkGNMFOB4oxNylAyWFJ5llbyZrr0UTNBEe1c8k4k4C/IdBWHI2LmMyemGyecBXRqN+aKaAleuXXjDsupAydHT7mFvb/x0T8reT3u7B/ujw7F88qR7uH94SKtn8ANsYW5D8lxe+mdlVK5jkdoYFvkDCkHWgO4ZAC/+5fmWeXyB/imbedpazIBXFOpDgW1cPDt6JfYORCrNpORxOVlRgokuzzFi4OxyRENFXipI7hmf5nqizaeS//PjF4PLkwuMnB3/4/L4HH8Rr7W8PzDw1oTc0nKYT+17RhwE4LhTKdRBu+bjwPUxBJLGNQm1awQhfGssy7TAjLD6hhlN1mKc22wplDhuPhTioW6r9o4Y0Ri2EWzOI+koDRkmf+xzR3QSNPlYTFHRqPxRWwySRJOQyGKIRjDF/DkYCZkknDeYwbhEKAOMRt1UFsJYbOdq2RYLVS5bo5Hxmkah4ADyz/vJIC5KgGMxm1FYe0uAGOwDzF5zy+guVrPkHDUntkxQIk3GNs+plBlBNo0CJaQjMpdD4jEVXZ2xmomc091LD+Z5YflZLEv3BXH3KkX6iVi0+sGNCsHnqJjy2YitUZkpZKSQz3lyoKrNVQU+ykmVJtvY3cbuNna/MHZXH56Ffik85dJnd730uTRVT7mpQMvZe4xdaTy9IXcEFBJKpF9eXyCw3ylD9OrDjNq/71gf+a18vbKs7eHHR1WZXG39C1sQQNajl2CMTKSSPuNeIPZlLKvqyfpqL2w+0nBQs6FERNbMxdyWQkJleWnoUEBQr59Y5cyDAo0/8qPkCtdnQFrVJNHMosLdVpLbSnK7G213ox9nN9pWktvY3cbuXzN2P1lJ1qg4WkKdVJ0ks6eF5yStFCAQ1cm9qEOOTbVarRAzUddYreXKoTXq7Y52xwex2kvkXvL0yeG4Fz/tyf2D3YPd0V7voNXc668WcVwH2XJMNezt7cgqRhF3gzquNHAuV1ibLB//lfR2aExpjVJPXTdD51DpdV079g7Xa8cLa8VLaeZVheSWakiz0BHlNNBmRJtXtCCQ/HrCCKQqDVzkSjpT4JLTwXqqM83BS1KAbz6PBmN6H+MDpXKyehVt4rQEQs4EqaWq2cKxNIRUY6r5wIEr2Amy83esToOJvqmSF2ck8QlJLI4/+Dc+oq7c9zed7w4BPqccce4N/JGDXt/tSAMHQEPgc1Zdd27r8219vt3jt3v8j7HHb+vzbexuY/evGbtfUZ+Haujj9TkIvrg+B227K+pa6gU513+9TOdQCQjYvYWN4zLn4+aqBue6Aq4ULoxRDpHFFD864XZD5BWClNJJ+TYDSHzt71GVeQrqaVHMXL/TuYWxYKS7tpzpdnULytj37dhmnRE0tCH50C0BH2hEwPfM/AJtVm+uyYN9umPmXtksEPkqlM4Hw5/kTLe4yIpzWyLBMZsduuQTvImHAXGGVuKBY+o2e8+afJDrMk/vvl0Wz+gjsmxS3ydXA70A0hURSYRrMhesDkZsr0vgOfK5alCSpa+umzTnVJt7hGuUi/2G+rneGqBTIuuJZ0rmdPmPX3E8/OX1xSMxoYqUM0LpqBhWmloIxNQruBFnvEF13E+TeBPKbTmZsnCDpRcqFGFinEIp4o05V0pcVfcbf8VWcIbczWqnSYrTBc26flhZMKH7arRLthfaJufUielAix25NO8R74jcOmjjr29htP3GROK5zv19LH8LKYjInaC4mlVyyYZc9wXxt4pb5LlFzM09WkHhVXsV+ws6McKcWMjUsbbuvbjnFzX4UZ+FEeK6ioE0EXAsvwaLK6vdG8cSv4j4LeN4Y15PNbbb5WnCZzfhsFumiRiKeGqtU38XglyHQuVqUiLS7g3rPS0acUREvW4DUuSXjHSE4pHxnSAwjHcmOaLNm2sXug9qEh+2b9myyAtv+YLr2yWZefgKeyxRJjZ298ZMC0a0YOTzhAv4/RZGjkWXFSED5wHvAEcL+3MmCEAbudHz2pj5mX2H59D2QXdxmYub9f2P/iIJhr/8jV2irmmQqqn2rl8M4rcIvGgfW1JWdWqwqsF1vKnF9rmiN4+3PrWiLfXPJi9JPFgcrpyadP69s/RHMsmfJ+/+jzLeNtP8iJkmVMPkbrxsaBuaTv4s1HTrh32OL2zjXzzlWOXCG20NN2pcxTQZzVBKk1dzVMdTrfiYYKZkQfXhDnmWzTgS0dFT+KMZZEYTvumdA7JEY6dT8OOD7GplyQHji0+yK/12pb/Dj7XiKdpO1Rav0bmZGGahro2uYuDZbza0b+ewzCsyrHheGRtFV5aVhr5oAOwyExIu9RmPSLSLS5+40MQZVenCculXz6qimFyNRGhz/5Jn7nRMJ9BobhuG/8xasHv1sQFUT1YMX28sBDlTKXsm0S2X9p/jDW+LpiqdUd+IrIsCTDVWeDm8WOMIZsZBLvTnNp90wiTXIVowoRbKu8+T9m67G3FLgfGZdQU63QZz+jqncp/6Mx3hL5eL8/rThCWfvF2cwv9/fb8Tdj9qWzozOpEjnZa+1fK97VVrrbelbtp3t+iFptANUd3e0tENtXt3NOw/+6EeCi5Bcbr4aOfjmr/XR0EbRXin6FAifIcUTh1aLerdqr6SeznA5wMlBurn+COnxqy1lzLEpT4G+PkY7nn3H/1UFF0= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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' + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-mail-from-attributes.api.mdx b/docs/api/beta/get-mail-from-attributes.api.mdx new file mode 100644 index 000000000..60bd82c86 --- /dev/null +++ b/docs/api/beta/get-mail-from-attributes.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-mail-from-attributes +sidebar_label: Get MAIL FROM Attributes +hide_title: true +hide_table_of_contents: true +api: eJztW21PGzsW/itW9kNfxCRAaVmQVrspLxVX0LIE1CtRpDozTjLtjGeu7aHkIva373OOPZNXoNt2d++t8gUSj33ez/FzHM9ty6q4Mqkbt3Yvb1sXVpm9Qjt147qVG2GsZctdXbh0kMbSpYWOcplm0cAUeSSdM2m/csruGiWT1tXd1VqrKJXhiUdJa7c1VO4E8w8xvdvMbq21nBxaIv52irJtYXmibGzSkr5j+ZnCGnWtxEn36Fgcnr07EROmYlAYIcUwvVZadN/3RO+gJ9JEaQdt2mBSSiNz5ZSxrFtKFH+rlBnjmcYTfE0TfDbqtyo1CvI6U6m1lo1HKpet3duWG5c0y4KlHrbulohXGW2FG0HCX4XUiTj/9VwYFRcmEa4QfSXKyolUi3FRGbH/trcmpBVfVJbRf17XaJYUMK0W1klXkY3UjczLjPj3i77NUzf6h4UtyyLVrh0XeYvMbZQtYToYFeJurq/Tv1khJwwmHhBF/5OKHZjE5GztaJksyyy4ovPJ0trbRVM0C0tDnnap51ybfdFoc3q0lykyb9dz2EVRnDXuJNvnIZD22U4PcxoURftxHhQEohggiILt3Ug6uHGOuahgX/KXFHFlXZEvOI3Fuzljvz8s2Ma6GCiV9GX8ObK5K9uVjZS0Ltpoy1z+zq5cKi/iq44rEjK1og5bCi8vlzJPLAUZhZ7MsuILR1itW0EEFLJF9ItKx4rjFazKDI+dmE5y65l4M8DT1zCFscIqrEAkk7ruxn2Nvtd/s+VgAyLGWZWo3Rkdxb8g5KJjpjLocU0xgpnKkHokqPKLuszHVwT4DaWsMOnvipOStfCqURnzqTnlx5kw6/lsXKajrnIqYacHb/eP3r7BSO9ib++g18OnQ8THwT7Vs4klJvMWAxEV2CDWQu5TSM6WhmtlGt+07hbq0APVMTi/M8kkuC51LNGSynx3R9S3ltWRvSwlEQ+MAeFI+NpHPvHCko+UdYitZEw2T/W1zNKk/eNqTKIcBN4rErXMHbPCHqZaRUMD1SGhYpFjLAyxjBUiLwxSg0nW9uZ57ZnwhSXaG+K1TKCv128vKEMpYJDFoHW0NAdmBbrQKdaLegncwQ66h63aVrL/an1nc2vwakvKzb9ubWy/7O8M5IsX6zsvd3Y4TpW1cqimY1MaI8cLrN8ojfCJRVbE8AglAXZr2J4FYOZYkjqV28d9wDS+wv4U1H5uo2aQVxC2wC4oXu+diq1tkUk9rHhcDueMoKMLSiZdZZns0xBtz9DcE35n0uE920DIzP2Dw+7F8TlGzg7+eXHQwyeitYAyuhrRmlBYQlTEwigUzqDAF0mVL4M5VNIWzwPV51BIhr0/TEz9Nzu2MCZiayCrzGFF4L5kxTRpX4ymUyn2QEw8TduqvQYwgbFcungk+tJiQaF5+vNuHKvSRcfBks/FCGhMmWdt0U2SlJSUmUA2gijWjwmVyCTx5ZQIDCqkMoTBxlxUfiOI1awvJqac9cakmBxPO4WSA5I/Hifd2FUQjtWczsImWoKIwT+Q2VtuVrrzKaOxScfayRhaYH8Zw4worjEqEyExZ0UoR+Qui8Kj63lNxaISWKvF5e7EC7PvCn4Wy8p+Rd6d0r4asWrNg2sVks/WGxbqMnmjdlOoSHhIavPiMKtxV534YpCqLFnl7ip3V7n7lbk7//AsdE/hKUOfjUXoc6GnEOQC9DEcPbpoYCbDm+DINcDTGiL98v4cif0Z3Srmq5uSIO0PxEd+K18Qvtv4w4/3CX40zprxBQnIdvQaDFCJVLLLck8kZkN5U71Y5HZYmH6KANVLICKqpiG0LSRMZiqtSRJp1wBSldVPnBhJ1EeJjLDWV0DiqpPId3ErJLlCkqvdaLUb/TS70QpJrnJ3lbt/ztx9EEk2UnG2BJxkqzyXZuwjLTz3h8+YIOpz/MnJPLtqHq0QMdFgrNYscmj1Nzf6G4PtWG0lcit59WJnsBm/2pQvtze2N/pbm9ut6b3+cpLHTZLN5tSUv70f2cQAcdfAcZWmI2FXFMns8R/Ma9SAT8zdBBLDdwBwd1cNdtzcWcSO50UhTqQe1wjJzmBIPbER1TTMzWmuqediQv1jEEpVCrkolNJcgYpB0IgszVNOXtKCflkaR92Bgyo+Ueoga7iEM2vLlSArCDUXCKwUSqoBYT5QYAQ7RHX+geg0uOi7kLw4I42PSWNxcBMrRYneIPeXy853jyC8oRrR8w6+56DXdztSIwDQEPia1eDOFT5f4fPVHr/a43+OPX6Fz1e5u8rdP2fu/gf4PKCh+/E5Jnw1Psfc9rposNQhBdf/HKZzqgQJOLxFEfMVg2SCwRlXIJTCLS2+LkUXvlqdZRe8Orf1/YE7zPQtgBeuMhkWjZwr7W6ncwufwVd3bVmm7XqJLr7QdY9OH4ZaUoPosoDPN5oguqdHocdos5VNSoHsqx4T9zZnvShk61s+D1Kub/rwXQ9PZk0g6ENQ8TBdhUFH8cTy7DYH0YJ+0OvCZHffr4sndI8uy8z3IDfMF5B0TkVS4WqtueHXI/jtuS/c85tsKdSybS4we0fTNsVrJQ1ftqFfMZ7+8v78mRgS6OSkryzhXZVSl4C0OUWIcFHr1if6tIj3GVNUwxEL3p35zYSSSAwyKCw+6J5S4vIoGOEtqv0ZyjOblBYprgi06upp7Z1EXauMNsLZu1+dNNEdWKgjZ9Y9402Pu4NU42POo+0POhL7KdUivghFc4KK3OyJy7LWS07p9a1C/KWmFnlqEVOzz+ak8Ka9jP0dnBiZTCRkZtla38zc04um6FErhRGiOi8DWSLIMftLV1x77ZvlmKEXEb1ZOT7o96MUO+rsMuELmLDYELNEHIl4VBRW/V0ICh1Kg8thhSz6ZrG+ENOIMyLaXJ8SKfIsozQCPmT5jpEY2geT7NP+zPCkAHLzV+aM+MieRc5/5It3H2d05uFLuszGd9Fi+80yE8OIGEa+Btggv9+lKLCQ26QD1wEfAHsT/3MlCIJO1T1Pa2lVZ/IdXkNbQwxRmYotd/2X3UmBC58EP6DZzRy6CQh43fz2h+8i0KKtasZY9cHAvAUX5c0K7JBzdvPyNgdTtGv+0fQljbuT85N3Ohv/6Cp9TyX549Td/1PFW1Wan7HSBMBL4cZsQ2cwHeSvA15bPM+jA+eRwl885VxlbI3OhXsxRjHThMpMOopqzup4xK8vGFUq6Qj7rVFkFTlnIpp2Sn/0e0xoaDAHaWuBSWU/zegtBjqrrjlLThgPLMmv9N1W3I4Qr3iEzlK1xXs0ZzqGW6gxo9sWePapCB1aD545JceK/drZAF15Xmm65w6xq1xIhNQjEZGkNq584UKfplVti4KhX7OqzmIKNVKhzS2Kye27AR0yo3+dcvwjvOB3G06YYXryYniFY6LImcrCiyRrc7D9MdqItmikspJaQ1RdADA1xeHk6HyBIohpC73Qghdm2AmLbIfmggi1Rz58XrQ32usRtwsYLwvr0MxOEX+jnFj2isZ8HN5ODte/87WYsIUQ9u/w3X8SrPK9iO8BL1vLekAs3W1ukaOtGEEXmnt7Swcd1BXd0bB/w4ZaQ1iXQh4d5gD5rh5Q6OlZuOH/TPx336lZqvtnRV0/vwoUmvoWv1tT92tQ5grT/HkNa+ZX+BOdqVULv3kQlabLfnNAYSTv2cjDB2J1d/dviazF1A== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get MAIL FROM Attributes

+ + + + + +Retrieve MAIL FROM attributes for a given AWS SES identity. + +## Request + +

Query Parameters

+ +MAIL FROM Attributes object + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-managed-client-status.api.mdx b/docs/api/beta/get-managed-client-status.api.mdx new file mode 100644 index 000000000..6488615e6 --- /dev/null +++ b/docs/api/beta/get-managed-client-status.api.mdx @@ -0,0 +1,95 @@ +--- +id: get-managed-client-status +sidebar_label: Specified Managed Client Status. +hide_title: true +hide_table_of_contents: true +api: eJztXG1z2zYS/isY3ocmGVNvlu1YX24U28mp59ipbDcz53pSiIQkJBTAEqBj1eP/frsLkCL1kjhp79pk1KatBCwW+/pgAQG9DyyfmKB3Hbzmik9EzI4SKZQ1wc1OEAsTZTK1UqugFwyFzaS4FaxOyS4st7lhozkbHDeCnUCnIuM4ZhDDqImwnt6RO2ogS3nGZ8KKDGe/DxR8AXIZQ5fE6VJup8GyDINjpsfMTjcJYTWDCWFYJn7LZSZAApvlYicw0VTMeNC7D+w8xYkMKKMmQCnu+CxNsIk7XiD2w8NOKRHRe5l+y0U2XxHqEij+sFgLMX7ur8ywxNWLtKyJypOEj5CHYy5UPkPPHh29gl5iOzi7PBme9U/x4+Cnd//qD38+uYCmYAcHg8uttCREzWeoINjkBuU3qVZGGBS502rhf5ajBCliwz5KO91gjim/BYnJXhN5KxQEDuMqZjgPRlCklQVyZM7TNJERhVPzvcEZ7itG+6SVykjzdtKj9yKqO+E6GOkYHWpqtGiGmYC2WYppkGYY0lY6rWnEprmrMc6Qkkk11tmMFFgjSul10DSBOf4tgHeA4Ya5s7d/8BzNkeQG8oTSqd3Z7WJTNHknIHOhpfgIPXfz37t7+747pYg9Oz87IYvqDyP4pxjUaXXarW6n1e7sHe7th/R1r91ud7t7uzjlVBvr438mJjzVcZgbwY1th0ZEmbBhQdEwXCaplso2Ij2jRAFZFU/eyZTkPWi04O829CQw/kIIFKu932k97+4e7nf3W6iPkSoSRV/3oPW82vZaJok0lZ5ERzw5FrdBb8wTI8h90Qeb8Ug466E74SPGdOlbtMXwNYV+nqN5XS84N87BFwg96KFb/u4WMIm86ikSbtGHi/aggzBnqg273b3GLmkJ7d7LYxgY8QzNCQ3ZrTQ6g+ZcfVD6o0KQKWVbA0s+eUuhr86OT14Ozk6O4fPZ+eW7o/Ozl4NXV0NqKL4MzjDV3/aHZ+7TyXB4DskdvOwPToFwU4K7gD3BKZehx0m4Ht6ChyKil9PBboTENbi1gD6HVP9jHKtm96rgRRfTiqSvI1eexhhZqzq4JIcW7A+RS00xSLBW2GrDn8tWq0d/Gi366z8UB5/wCvQjRXcd2HrhTrJMZyxksELnmQJTS2d5BDrQxgORASy65YmMvwhilxGrDoYx4IlMjnQs1sVwXdiXUolwknGJEgoSOYKBDDjeyhgXhJnOBHMsi+AhukbNlmCJRpu94DHo6/Q78sqgIQEEPgAvBMvPCXSlJIxnxRAmYwZu3DStOBB8tN867HTH+13OO8+77YO90eGY7+62DvcOD3F2iB0D/qsmNM8yvloyvBJKZDJihGTydzBIBugKIYcC0OSIpFbMzOd9QDweYf9L0MvRlmp6eZkVd3aHcfbi6A3rHrCEq0lO7XyyZAQVXl2spOiDh2RxnsmJVJ+CM8Cw/tXpJbQMT366gpwtM7YubF9BtMYYliAqxMJUfySJvQIfuWFGJGAOETfYM8/1GSjElakSSvfNzGEFnUFsjXmeWBjhZ18zosqajTM9q6US5c2dZU9kQzR22AjbIPGjKRtxAwM8ajzrR5FIbXjqLfmMTQWPRfa0wfpxLFFJnjDIRmAK4+fAiPE4xtR1DMY5pLKgIkrnliltZSTqvliYchkwCzQ5rToFkwMk/3yc9CObg3CkZjULy2jxInr/gMzOcnXpLitGI5POFSzSoAVPkjmYMcvAwmwEuklrmIcjdJcB4FEFXYlYVZAkuHvthDm2mvoinptH5N2bBOAnJNXKjlvhk4/qdIdG5I3CTR6RoBPVpsGeqnRXkfhsLEUSb3N3m7vb3H1k7i53Dv0W0/dS6dNeLX2uFM/BvhktniulT0bRozQriKi88Y7cYWAQXyL9+PYSEvsD7EGBXtyluC/8E+sjt5SvCN8v/eHaR8V2uFj6F75AAcmOToMxIJGIeyT3QmIylDPV7upsL3U2khCgak2JCKiZsbnOGQeTZblSKAk3OyzWwqgfLO7VIbwhI4xxCIizqjh0W75tJbmtJLer0XY1+m5Wo20luc3dbe5+m7n7yUqylIqyxddJJp/NeDZ3keb7UVvOgIAVP3awMuXIVcvVCjJjZY0V1CuHYNRpj9rjg0h0Y96N93cPx51ov8P3DtoH7VG3cxBU1/rrRR6XSVbPqYq/nR/JxFDE3UIdlysILmO1juvHf2DeTIwR1hB6yroZbA4mvVnUjt3V2vFMW9ANGEPtmG04XrwaniJ/mJrYo910nkUCy2xnOiDnlkpKjGGwtDR2WzpuS8ft8rNdfr6b5WdbOm5zd5u732buflHp2P1c6dj9gtKxy7DEGmOJ9VeWjjHUHViajcEpoEOUg3kVlo0pqAKf/OmjT3vLs4mwZaFXqyI7h6tV5KXWeA1gXhRLpnYSqRbmQngD2hnSZgUtEHB/UQhQS0J1i1ElZwJrUogflsiZpDxGhfCa2jzsjy1o5XKmiLdyFqmiJAcJCRQSjWevGmJMQjiJMZZ/wIHOQScA1H/iGaf31h86D2ZD1PgUNWYnd5EQmPPl+e/eulsCA38jh104X2+4LuDOzLmCbYS4Sx18lSXotlTflurb5X673H8fy/22VN/m7jZ3v83c/YJS3VdDm0t1IHh0qb6HVzZZWUu9xOD6v1fslCpeAgpvpiOq1eNFDY7XigU0SjunSa6gxD9yodzP7RQzU8aqN3NXTcOI7pCG7p5vD5AtDm7wqv9MQDj6FxyIQ/gcoxc068NM817GD83y+rzbTTjl8iyBAVNrU9NrNu/B5+DrhwZPZQOgENxu50p/xFvjzREYeg2G4ZVVl69IwPpvBn670iAvZRITwaEmMXc+I7tgyBcX0z/JGe+wYzDMYSfDHJsdfGDhg5KaQcQUdiQ/GKJuUBCu6Ad6XWXJwx/XxTHaoMs6831yNqBnIOmSiqjCzSJOLrB8d7OvRMtiScIfDjork50jWYe9EDyDvYW7S/Pkx7eXT9kEi1YCjdxgvSwk7jIg7d5AiBAo9ot7JTiI1qlM55MpCd6v3dzBJGTjBBRmv6gLIdj1wBvhDFaLIcA7mRQHCUIUHHXzpPBOLG5Fggtp/blCExKhCRZq8tq4p7Ro0u6i8nyj8YsK2bFELJO4+CONV5E2i+w6LfTiFb2+Voh/FNxCxy0kbubpkhTOtNcuHVkESIAseGLIWl89uUeFCj/cikELcl2WAS3h5ajft4oKr321HDV+IfKry/GLejuVsCLXhzEHXszAgprEbMCiqdZG/JMxDB1Mg+tJDln01WJ9xElDyoiw06qIFLopQ4nvZUi+U0gM5YKJj3B9p/JGu5MWSslfybOQ87/SK6hfazpT8zUsw0gZ68h8tcw4YYgThg4DjJffrXIYWJDbqAPhgAuAo4X/CQm8oBXcc7zWojqxb9IYXBoiEJW4mLTnvvQWAOc/MepA6pIGYBjL8/IGGnxnnhcudTVjFQcLyxZclTfRsMIu2c3JW/48iqvu301f1Li/OH85V8n8z0bpDUjy98HdvwjxtkjzPSKNL5gx3Ghav7OoBvkLX6+tngfigfVUwL+hl3KVanPY+bjHr1jFVBkVDwkpq6MpvaXORCq4xdpvByNLzygTYdOP6S/8K9oJVOV4nG2gJuUjmQA/OusuZuaUMK6wRL/id5P7mxcaQhJ2pqLB3sLmTkXgFtzY4Z1f6Huv/Q7vAjzzBh3LjgtnQ9E1m+UKZsO8zGeMQ0h9JiJiaaLcARfs85QobKGp9CtHFVmMoYYqNGiLk83M+RgPqSU95HzkXOB340+oeUR7AP9ydaHIUCQUmUhXL9s/xxuiLZyKJMWtJaAuFGCiMsPrweUKR2Cm/M8iOps0/SDTRFpgsngzuttoN1ohbRegPdXGwt6qwvwiFZEcSwiHtQ+bG8vxeL84pH/0W32/aGC130zxrAtFyd3uw+34roOlHR+M6tErfb/pu3GvhZHy/h4PRnAX9IDN7rU8bgXBmhjicflgd6PgT4b+cfZT9gXP6teq8YHeUvsH3X5PHwS47Sm2W18v26P/PwRrJSuOHNW8KlkhMRgXtvJgVTpFIhldhztnqgxZ+SWmtm9/dYLByTeUB/5D7xpPDf4L7SPo5Q== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Specified Managed Client Status.

+ + + + + +Retrieve Managed Client Status by ID. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-managed-cluster.api.mdx b/docs/api/beta/get-managed-cluster.api.mdx new file mode 100644 index 000000000..89dffe55e --- /dev/null +++ b/docs/api/beta/get-managed-cluster.api.mdx @@ -0,0 +1,123 @@ +--- +id: get-managed-cluster +sidebar_label: Get a specified ManagedCluster. +hide_title: true +hide_table_of_contents: true +api: eJztPG1z2zbSfwWj50ObnKh327G+3NCSnCr1qyzH1zqZK0RCEhKKZAjSts7j/367C5AiJVly3D53144yU1ckFvu+i12Q4GMp5hNVat+WTrnPJ8JlHS9RsYhU6XO55ArlRDKMZeCX2qWBiCMp7gTjzAAbWDaas363UiqXglBEHMH7LkyYiLgICBAhj/hMEIH27WPJhwuAlC4MSSQS8nhaWqbc77JgzOKpWCYcBwyIAHwkviUyEkA1jhJRLql47iFiJWch/CiXxEPoBS7cGnNPIYAzFTNeaj+W4nlIkCCcPyFITnPaJW7IgDBPT5+RiAoDXwmF0xq1Gv5vWUUI4Sp2L+PpMrNTfgcUSIyJvBO+0ZkT+LHwY0TGw9CTDimw+kUhxscco0VSS/YCREaQYPRFOEWd3GoFO54EQkMEgwtn8hGsgMhAtDBC08VSywbQz9FLhel3FxS3qK5srLwFIwFtwrkkMTvDCYA9DLazizCbcM/EhAOMlSjBVVxHtEE02YoWYTahdYXPPYnYNMwyuiH4AtoD3XthyMV86fpw7Seex0fewnlXCPrJTFsZwSWXaNJYxnm1GfRITSFD4HZjOUl0uD4r6EUUOEIpVoBmMx6u8TfuuhKHuXdR8KYit085+R7BJYmr3gP8gYmUNsTiouCm7dLBQaVWqUEwlktfxfyCy2iVcRhgIYywcRCtSRlr+C76fpiMIAZ/FnO8WGhep5XNPpbN3OQSFv476r3vn7GL66OTfof93PuFbr6lf/Szd9ZdHiVPTykMp8lsFALu+PVc5nBs4ne/c+rxD/2PrZb18OHBOWp2Phx96V5f+3utAksdVOEYs5d4PU95JC9UYqc3GPaP+x172Mu0mOlweZBcZ31g/GwcCgB4DBRHSawdosj5VSgc5JDZGRB5WscECGb4deujybqbfe9bIpLtiRI8XMVBJIiu+qayxfAlJF6UiomP7Ql5KWlaOttZ3n1smbi26nvNJqo0EpNNaaZImN8rZiZsIp8oC+la9Q1WvSSN6nxBSvtu3yxqOwQ7+6DX9Tpfw2Q1af7t4NKGf338c4R/7Ev77qR5NB81p3snN2fK/cdZ7dd/9O9OZ6d7p8PJ/XnXaf7yZdI8vdkg2cL/ULyCCFuUnB/cxLrN1DSI4jx8WobNzFJszFzRJnblmoAZ4O2l9eOVqZko/BSoeKuIC8jv8V815TDRoskVxwsSt6K49MIAcmTFCWaZlBeglpfxQJAZD4BHTEhQ0MCMx/pWs5Hnar95cPi81UmbtHwvarkVRmJTUWiYrdpeo5lO532h7tBxkpYZevSjDX/6Z8Pe4Mw+wZ/9y3/+ZA8+9q7gVqmMk9dVIRnbT8XFfVkIIMLu9CADA7mYRL9TirsaFXKhhJB1dYJepTMKAk9w8EmPT5j0XcmdGJP4/VQAOSzxmB/ERNp4+5Izg3drCgteDE7qY8Y88eKscsuYo2tgzgsmnc2VmLEiAD4TRc6awvGRfSpFQRCfQL/mfSq14fLGHpx9KpXhF6Ci+woHEHIcBCMe5cHYE3ta4wGbWgzX8HUqfcpK5QUDqx2GFqq/pnA/WZbzB5U68vaewyDFhLjEzQqdbmY/qGc1EGl0Vc/QZEbQgkkCFeMxiM5GYoxrAnSEIiZ3ASBja/V98V5v1MolYEDOMLj24Dd/0L/rrVaNquVQPucbvWyMuVAzWbGciTRHrwqC1hKUExdKa9QaNavegIV6WD9s15vt5n6ldnD46xpNZzJkpCghZkZeTf0wRGx4OI4qwgZ3Xib2jLbMGGqeex5Cqwo7hqsZ6lf6mihyz0dBQugmqG+apsog01jvAyDOT+g9NJz6N4vRfdFwtz0ffuKYWcKBRgoNw30oXiBXzc+C+88/TuM4VO1qFXL+LPHhbnEdqMZ71Ry8ZYNbO55Q1ZSElZGwDAlL+lZuSjXmVlitv3tXrx28qeTzBGTU4/OChYYDu9Nb5/gmG58fH8PVsT2kLNwbDM4h+1IYU34mbN3e0TXmbI0rl5avYu67PHK1BXU+0rpbt76F6FsLg0JGhuqowrCLxTKJwfKZGcjxuFICLAQEyDh33APvK8BoIwKCgCkhCIrfgabJZk6qQ5WikNEq9mfs39Hjfx4HyPXEeVIGS8XunnTtiwxr5hZPL2/DX+BiS62O8Q3UUuvLwu7/MV9MB06MT2LvVaiIdcI/WV5Cn3IbkXxNXrp5fmmHxTw31UC8amFXMY+TNVGUlodmfNOCdnY+OAVFvrrLvqBZGJrM+f2N9bDTsUeNiX3fP7In8F/XPjuafP02/SrfH97XjuxLdQz3ktPL2n3n/pfux8vL7oY+/JWbGTmR4pftXwQjZz88kYn3fhT/WqD7PdReuaXzZVlHvWPbPu/Yl+/s037/qDP5GX737ObNxFcPF3uN0+7kaDj+afC3Pb+1aSOIe2BPI0KRZbhpGrYRbUX4cyZnM+gawPKZl9P0zb530j/tD3vdfw56V+fXg07vatF09N38th6PIj5fyR0nUsWLFkRhguW5QlXGYrZlb/C2VG+0WgAL/9srfcaIEtGddEQnSPw13dcZeAPG9JgZOMWgYMCFIyiQ3l6aZaFdy7dl1K6sK1g7HYbPJ3xvrvsUENWBUoYWmk6Z3Usoa0ZYKs6COxjGJwNYyEBeASaxzfDZqZwsas1O7/0V5qEx1IRqKtbtWy9Sea1gtHS3xYkEmNu116gJ12qs36pUKsZT7M2NV9xz+K1nLpeITav2zqq1ho1au/WuXatX3u3v/fp8f7ClZExC95XswaoeMzP9/5PHZ/tvGMLB1rqHP3o1Yr0ogmXDYgMRJ5GPDqHrcVN9g1e6c7Sv9KEiku53PQLavD/iihhKhw495lp9rlVk9lj6wgKvk8ihIJYdmMgA45100XmpANco05aC4ArVCmqiUmdH3AV5tXwdIwzqMOLOV8Clw2YzQ9e+hPksncKkmzW4a8iKA8FH+7XDRmu83+K88a5VP9gbHY55s1k73Ds8ROozoRSYbnuyei98EUGe9wIIXPkvUAhEgTIdNhFfk7KesQHheIH+h9ShIWwmpuGXxeIhhrKZHXUuWOsAfN6fJHSfT5aU4FvXVyseTkU8Ij6P5ET6ax9xmnKtC8vR9ckQ7gx6l9e9q2G2bVNk1vZpZwTcMqAMOw3uTYtJAmBkKuGBOoRbYW8N1rcgEPdVHlDqKzWHUJqlHSDMMNTXzMijZuMomBVCieLmIWY/yoqolCHLwj2IZWfKRhxTMSZUAH9rO44IY+vEaPItmwruiuhNhdlZsZz2JzM+x3QNVbTO5YhgnEAoi6XUXbTFQpUr+SarYnNGweAAzrf7ie3ECTBHYuajMPMWw6KxD/CsNVfkbphTGql07se4z4ULFRSHQRTRpgbIJmPFTDpCcylIPH4Kl2WsfH6kdHeqmenGAY05PFEviLsLD9KPRaJlA3fCBJ/CtVBnI7JGaiaTkUzHR5MNVGauNPBhCRWeu4vdXezuYveFsbs8ODCvvJhRKn3qq6XPtc8T0G9Ei+dK6ROR9/hQhxsgXetqQ5axyTYl0oebIQT2V0Gb6rTvKf7I+kgv5SvM25k9co1TZqyCLZBB0qPZgYdMJNw28b3gmBSlVdVcpXYcRCMJDuqvKREha0ZsHiS0SRYlvk8tnCozNxDK/yHGV4jAvR16JYMyIFL1XUtvF+0qyV0luVuNdqvRX2Y12lWSu9jdxe6fM3Y3VpIZVxQtpk5SyWzGo7n2NDOO0nIGACx9+ZplIUemWq5WEBnLaqxSsXIojRr1UX184IiWy1vufvNw3HD2G3zvoH5QH7UaB6X8Wn+7iOMsyIoxlbO3tiOpGPefoY5LfHAuFQeBW9z+A/VGYoxpjbam07oZdA4q/byoHVtr9riDGGTDTW0LcKzfXrwenOiHoho96i1IIkdgma1VB+A8ppKSHn+JB0nvBOxKx13puFt+dsvPX2P52ZWOu9jdxe6fM3a/q3RsbSsdW99ROrYYllhjLLH+m6WjC3UHlmZjMAq+vJCAen0sG0N84RQ0X3j/N+bRRMRZoVeoIhuHa56xBwG+RT1PiyVV2In0F+rC9AawM4SNUlh6k0OfX4SsJaG6Ra/Cp/VQk+JLJp6cSYpjFAjPjM4te0znHylmUn/LqEjf8RLgkJKCF+h3ae+5zF6yBQy0DzqBRP0H7nEaa/2u/WA2QIlPUGLWe3CEwJjP9n/31r0l0Pf16TZ2pW39zOsCes+c+9BGiIdQp6+sBN2V6rtSfbfc75b7v8ZyvyvVd7G7i90/Z+x+R6luqqHnS3UAeHGpDrCVGstqqWN6HfY/XbFTqBgO9GGmwKFa3V3U4PTeMtyU8ZyIXEOJ39GubCfx1Hy1oY1vB8fC0q9LwxWnNLQyoM/dlj7j10hmAjzUfGYFUxN+OKVdqpqjuekJbFV9lC4e5dOthZY0iTwATQ+5PIIDgOGfKjyUFWnOqPjBPZ10GYHW1yQ0fH9VBy8CMPuib3qXCpkskhgVOoUS8uIBlOyEy0bMeP4cPWMObQ3TaMp44Np4KN0GFkNoT35QBF0hj1yRD+S6jryn3y+LRvSMLOvUt5EawDPgdElEFOHzwmmusJbX1FdcZ7E+4VOExgqxcwRrsCPBIzojhS/W/PjhZviGTbCCpQySKCyehcSWA2LwAlyEMqSdvmSCk2jRioJkMiXG7cJrPBiRbOyBwOyTfyUEu82dc2IDyPWkUpwkKL3grMURKxdP9uCqunTECpy/Chqq8sK8N7SCLp8NrHzyLdaVmNgkVgIIY0TU32O4DVO5eE6u1zLxfyk2S2OzCJt6s8SFVu2tObzqQFpAFNxTpK1XE9f4rBw+7MvgDmJd5gE1YfgovnzlpFZ7NR8FfBbiK/Lxyb+ZSliei9OYTlv4aYHEc1mfOdMgUOLvjKHrYBjcThKIolezdY9ELYoIq1HLsWRpkpbE8/7E3wkEhq+dSR8upVon0NsuFJK/kWUh5n+jM4i/FWSm27ewJiOkGzjq1TwjQQsJWjoHKMO/XvLQsSC2UYbc2enOwv6UCQyjubynca3N6oS+SnNwaXCCUKcYFbb1RXuR4NKDujSA0BkMpGGs1bPX0fAAr8GF615BWekuw7IGV/n1Alhul/Sm+c2eleIS/L8mL0psLzZjzn1v/kdn6Wcyyf9O3v0vZbxdpvkrZhpTPaO7EVnTZuSd/MjUa6ubg4pOk8NfGKVYpUId2iD9ZT6sYvKIQo/H6NUU1c6UvnIYiVBwOj1eRs8KZhSJof4gmjCf+JvQebkIWObQCEoPj4rjxndKmVPA6MIS7YrXKjGvYQTgktCmigq7gU7Pd8As2OXhC8Aw9iUw7d4VWOYCDcu6qbGh6DIH0zEukxnj4FJbPMKVykl04jLnyrUIAZV+2aw0itHVUIQK9TvRTJ2Pr/TBypzht9ACuyuzXQ2qp/O2+nuPC0EGwiPPRLhi2b4NN3ibNRVeSF8tALaga8xROO0PVzACMt88IwmiSdVMUlWEBSR32XfmmpV6pWZRu0DfF1QxdFU55O9FDEWl0p8CA6conhGsLLvj42LD/iUf0TTLBdb51RC3vOjMpO47dJd3W1ru8mBaW7p4mn5K30e6LT0+4r4I9j1PePtbIrDpvv28aGmoFQRt4m83O8j+LOc/DszHXt6w7d/jXCtDurnnzxd9falE3+Yq0TdAn/CYr96vIeb0gN7RyU1ZeeZRaIff99Dy/Jm11/wARUB2+TestHlm +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get a specified ManagedCluster.

+ + + + + +Retrieve a ManagedCluster by ID. + +## Request + +

Path Parameters

+ +Responds with ManagedCluster having the given ID. + +
Schema
    configuration object
    + +ManagedProcess configuration map + +
    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 objectnullable
    + +client log configuration for the cluster + +
    = 5` and `<= 1440`"} schema={{"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}}>
    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). + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-managed-clusters.api.mdx b/docs/api/beta/get-managed-clusters.api.mdx new file mode 100644 index 000000000..1ee6b90cb --- /dev/null +++ b/docs/api/beta/get-managed-clusters.api.mdx @@ -0,0 +1,111 @@ +--- +id: get-managed-clusters +sidebar_label: Retrieve all Managed Clusters. +hide_title: true +hide_table_of_contents: true +api: eJztPGtz27ayfwXD86GNjijrZTv2zJ07siynSv2U5aStkzmFSEhCQpEMQdrR8fi/390F+NLLjtvbe9KrzNQVCWCxb+wuATxYMZ8o6/DWOuM+nwiXdb1ExSJS1seq5QrlRDKMZeBbh9ZAxJEUd4Jxz2OL3dk4iFg8FcxJokj4MbuIJlU24gr6BD6LxJdEqJg5gR+Lr3HNqlpBKCKOoPsuAJ+I2IDMEKhaIY/4TNDD4e2DJRELgBPNoc2HFngMxmMlYmsR1wt6zaQfB4TVOAGcI6ESL2bQUGM3KgEy5kyFwpFjCVjey3jKKp6cybjCYFjIJ9LnsYDxUZBMpgRHg1C1D/61EOz2XYt1LvvsOua+yyPgRuB5wkEc2GWG+8cfp3EcqsOdHRe45yHdNcWlFwaAXs0JZjvS9Xd4KHeUgWM7GRw758Er4vEsiATQBT9nxD1kJXJXRgL4OOaeElVLfOWz0AP+1KuWcqZixq3DByueh8gymFVMRATjNBD9qtWEFzPpy1kyo3GuGHOgFX4/PlZXM5+YtcT7M/6V+clsJCIWjFOOIUcjESeR/93wrrn7B7g341/1b4KS8RKe1nLTCRJ/mZv9MavEUSIqTMago6DGYRAmnlZMwSq/2MMg5p7dxdEVZHcY+EqwqeAuSIC0GjuukMiUA8Qg8Vw2EkY4YAdynFkBcJRVtIVV2L1A5k184KELMgQpSt8RqWVLf8I4CBlQYUQIc7jPphzdBQOpEbOwv5yF3ImrSI1UMBpkOBO+CxP7QYxaogTOWiEg/0WUVxAnwvaOe4nQXMDegHaiUmy+C51CelYo1SgIPMF9q6ApNHKtroylZ3zkEiwFXtqfWI+LinRCQzLpJwpFhpqRUsnU3I/BdvWwEaqC/xez9B+aLsDMNni+QtmepG9RZVQShkEUA3rpkjMGUME9NoMj91xFequXlyBShwihUsmWG+5VKoesIr5UrIJgrEI7E19Y9mg9fkSBaqtSyOdmvY7/W1wcsQfMTQbHmSdhtQNjKy9qqBy0BIKhAwgehp50aJqdTwrhPCzLk0cRR8nLWMzU8sQLCzF0NOOC0Sfgb0kbby3pIgaeBASG2A0enMk74DwCA0LDCAmPpaYUeq+bz0zH+sf5jEbzilzlph+s8Y+p8j4BkTptgrlAMTvHAQA9DJ5GF/tsgj0TEw59bHArXMUNBBtEkyfBYp9NYF0BaiURmu6zCG4IWozyQI3JBZmPB+tB24cgho/whXErSxP6uOLcmu6SSxRpLOMi2wx4nE0hQqCOYzlJjLKvI/QyChyhFCv1ZjMertA37rpSG9JlSZuW/FNG3wOoJGHV+wp/YCCFhCJ/KKnpobW/X6vX6hZ4R+uzmF9yGS0jDg0Qwsko8xJl+lfgXdb9MBmBbf4s5viQc1478M06lo3cpBI2/jvqvemfs8ubo9N+l/3c+5VeVugf/eydHy+2kqanMwynsKqHADt+OZYFGJvw3eueefxt/127bX99+9U5anXfHn06vrnxd9sllLrIwjF6NfFynIpAnsnEbm8w7J/0u51hL+NixsPFRlKd1Ybxs1Eo6MBjmHGUxGKF273WeYPDOlkn0rSuMRAdDy3QN5oz43U36x4s9snTjhI0XMUYfeC86otK38fPmeJZrpjweNohLzhNW3s727uPbWPXdmO31UKWRmKyyc2UJ+b3GCDSgE3TJ8rGee3GBqleEUe1vyCmfbNulrkdgpx94Otqnq9Acidp/XP/qgP/+vjnCP90rjp3p62j+ag13T19f67cX87rv/3Svzubne2eDSf3F8dO69dPk9bZ+w2U5fq3FPI9weRi4ybUO0xNIeAq9sd1Cn3qzCzFThrekIhducJgBvh6Yf14oWumGX4KVPwkiXnPb9FfNeUw0KbBNccLErcczGZUXgJbnocD9aw+I4fMsNpr7R+slzpxk5bvPJZbQiQ2EYXu8yS3V3Cm231Tiju0naRhhm5914E//fNhb3DeOcWf/at//dQZvOtdwyurioNXRSEZ2o/lxX2RCJiE3elGSvbQiX4jFXd1CuRCCSbrage9PI9JwdjY45Bm+K6ELBWd+P1UwHQY4ukEFUtcRrJlZQbt1jPkuKxL6wrI6TSvannBpLs5EjNShI5rrMhZETg+sA9WFATxKaZlH6xDeHzfGZx/sKrwC0DRe4UN2HMcBCMeFbuxR/a4QgM2pRiuwetM+uSVqjkCyxmGJqq/InA/XaTzB5Uq8tM5hwGKDnEBm6V5jjP5QTyrOxFHl/lMFawZl9RVjMdAOhuJMa4JkB+KmNQFOhlZq2+z90azXqgg7RYqSI12u07RcijX6UYva2MuxEx2LGci9dHLhJiSTYlpzXqzbjeasFAPGweHjdZha69W3z/4bQWnMxqyqcghZkJedv3QRGh42I4swsR3XiX0DLdMG3Iey8vQW9XYyYr6CuOjICFwE+Q3DVNVoGmMy7Cu9n5A7aHmVL9ZjOpLBY2eDz+xzSzhMEfaG5r7ELyAr5qfB/d5UQNrVIkPbxeKGvHuTqG/3QG1djyhdtIp7GwK20xhS98uDNmJuR3uNF6/btT3X9WKfgI86slFSULDQafbW6X4xhtfnJzA00lnSF64NxhcgPclMyb/TNCOe0c36LM1rIJbTss7WoLaH2nerVrfQtStXKDgkSE6qjHMYjFMYrB8ZgJyPK6UAAlhUQaFQzW8ch8tRACA1T9d1+R3wGmSmZPyUKUgZLQMfY38u7r9+1GAQk5cnMpAqXWOT487lxnUTC0en5+GP0PFFlKdtPQHJLQ/5XL/y3QxbTg1Oom5Vyki1g7/dHEJfawWq3rLivx+/dIOi3mxIKh7vGhhVzGPkxVWlIaHpn3TgnZ+MTgDRr44y76kUWiazPnjifWw2+2MmpPOff+oM4H/jjvnR5PPX6af5ZuD+/pR50qdwLvk7Kp+373/9fjd1dXxhjz8hcWMAknx8+oXwcjZC09l4r0Zxb+V5v2W2V5Y0vm0yKPeSadz0e1cve6c9ftH3cnP8LvXab2f+Orr5W7z7HhyNBz/NPjnrt/eVAjiHsjTkFBGGV6mhXwqRfhzJmczyBrww1Gq5TR8s+6d9s/6w97xvwa964ubQbd3nScdfbdY1kvL1AtRnCmD6xEKHSwvBKpZTXt9bfDWajTbbegL/9u1PqJFiehOOoI+eC0Tfp595zL9FIOAAReOoDT106FZ/gG0mJZRurIqYO12ITBlge/NdZ4CpDoQytBC063qj1b0nW0W3JnPzRjIgF8BJDHN8NmZnOSxZrf35hr90BhiQjUVq+rWuSuvl4SWVlucSIC43c4KNuFajfHbDoWK8RRzc6MV9xx+65GLIWLLrr+26+1hs37Yfn1Yb9Re7+3+tj4/eCJkTEL3hejBqh4zM/x/E8e1+Tc0PWJre9W3IL0csV4Uwbphs0Hhy6reQ6D3QowCd44Clj6ERNJ9ybehNQUSV8QQO3QDVyzb1vJnQV/YoHYSMRSEsgMDGUC8ky5qL0XgGmSaU1C/UriCnKg12BF3gV5NX9cQg0yMuPMZYGm72YzQjS9hPEuHMJl/6FsxrdgXfLRXP2i2x3ttzpuv24393dHBmLda9YPdgwOcfSaUAtk97a3eCF9E4Oi9ACxX/hsYAmagTIpNk6/wWWtkQDCewf8hpWjYNyPT4MtwpwzEzeyoe8na+6D0/iSh93yywATfvrleUnGK4hHwRSQn0l+FShqvHcN6dHM6hDeD3tVN73qY1W3KyHZ8Ko04+GEVdWEa3JsckwhA01QCP+sKt8YqBmoFCOK+KnaU+knNwZZmaQoII8zsK0YUQbNxFMxKpmS2FbEfZU3UquBm4R0YszPNdyDRZomO44gwtk8NJytml8SrGutk0XKaoMz4HP01hNHamettRGDKYsF3l2WRs3LJ4WRhbEEoaByA+dN60nHiBJAjMotWmGmLQdHIB3DWnCtjNywwjViKn/wdoII2QzlBFFFVA2iTsWLGHdFXd3A8ftov81hFB0nu7kwjcxwH1ObwRD3D7i49cD82kZY13AljfLR1SHsjkkYqJuORTMpHg02vTFyp4et9AVvb3dru1nafabuLjQOzA8a0UujTWA59bnyeAH8jWjyXQp+ItMeHQNx00sGuFmQVs2wTIr19PwTD/iyoqk6FT/Fnxkd6KV9CvpPJo5A5ZcIqyQIRJD6aEjx4IuEeEt45xjpIJFa1lmc7CaKRBAX1V4SI4DUjNg8SqpJFie9TDqeqzA2E8n+IzcY6h/ZkkAfEWX3X1vWibSS5jSS3q9F2NfrbrEbbSHJru1vb/T5td2MkmWFF1mLiJJXMZjyaa00z7UgtZ9AhP+GQmRyJajFaQWAsi7GscuRgjZqNUWO874i2y9vuXutg3HT2mnx3v7HfGLWb+1Zxrb/N7TgzsrJNFeSt5UgsxgI0xHGJD8ql4iBwy+U/YG8kxujWqDadxs3Ac2Dpxyx2bB6sKI8GAW6AmacRkirFkH7OI/Rp0HeGfaO0LxXhJ+AXfTyZIQEvVCUstNoswu8DdPwDjRepwGNfc7szxtqrOVRilCybRfqOlwCG5Am8QG+DuOcy2x8BECiCnYB3/hOjUyOiPxTJswFSfIoUs95XRwg09Cxy311V3+37emMyu9YCXlPo1dkO90EBICHQPiuLO7fx+TY+367x2zX+77HGb+Pzre1ubff7tN1viM9NNLQ+PocOz47PoW+tzrJY6oR2MvzVYTqZisFA70MNHLrBwM1jcNpyAi9lPKdJbiCu72pV7kDQbg7cHeLGjljYeqcLPHFyQ0sN+siE9RGPlc4EaKi5/QBdE0do1o45VZEenqFTvhRpaiKTyINe6dbEB5A9yPyxxkNZk2ZnoR/c0/7EETB8hS/DTQfabrEDne/VE9RIWpFEg9Dek4CXtw1m+xI3QsZTQ6gU8yABf0lgqnhMxignvQYUQ8hMflDUu0bKuEQf0HUTeY9/nBYNaA0tq9i3cTbozwDTBRKRhI+5vlxjGK9nX9KafGnC1K+5NNkFdmuyI8Ej2tmKX0N+fPt++IpNMHgl56EPcQtJ2xg5uwQVIefYSb8M4CBar/IrLDqlby9ojGzsAcHMnKEv7E5lA3DzxFIcJMiz4KjnH/fmpXFrTsx/8G12LCN9Glzvvjck6lN0t2FKFy/Q9VIk/pFCszU0m6DhQfMSFpq1t+bIgQMeAUFwTxG3Xjy5hmcX4GFKBm8Q6iIOyAmDR/mLmZNK7cV4lODZCK+Mxwf//VTCylwexrTHwgNheG1EnznTIFDivxlD1UEzuJ0kYEUvRuseJ7XJIuxmvYCSrae0JZ7SIvxOwTB8rUz6SACFOQHul3O1Sf5OkgWb/512jv9eople38JyjD3dwPmGOwwWcMYJbZzQ1j5AGfz1aoeKhbvLgIbCiZduLn/yBAbRgt/TsFZ6dQK/Q2NwaXCCULsYFR7qh8PcwaXHK6gBe2d9wA1jmJ59Q8RjFwYWLnklZqUFhkUOLuPrBbDSLvBN45sVuHD1/U+jFynu5HWYC9+b/9leeo0n+c/xu/9HHm/raf6OnsYEzqhuNK3JMIpKfmTiteW6oKIzQPAXWslWKUaHDCi/zqgIKPR4jFpNVu1M6Y6ySISC05mfKmpWMCNLDPU1FsJc0zKhXc4RoMwhB5QeHvDBmnc6MyeD0YElyhWfVUJpDc7lTCFDFTX2HpI83wGxYIKHuzag7VNgMr1rkMwlCpYdp8KGoMscJ0K7TGaMg0o9oRGuVE6iHZc5DaRJCCj0y0alVoyqhiTUKNWJZupifK23wxcE/8RcIHdlKtXA+vzSACsnZCA80kzsVw7bn4IN2mZPhRfSWTNACxLGwgxn/eESRADmK6ALUvkgmuyYQWoH+wKQu+x2kFatUavblC7QrTAqhoSqAHzjPXa1RW18yEv1f/YNeGZlwcedEAtjtClepyg6F7y1lnJByC6mdPT91np4QOiYHD3ia31FFGaIwGTU/Pz+qbUU/f+6J28lw/FUT+EeQVOssCxMRZ/PyO/r0rsNjEjv9HshH7bX1X1/19Vt0Ib0TsIXasP2zrkVd85tYHd+rV/O8I95GQucOx6A07ZCnl4P0wXzwqilT8qlauObHq6ufE1+Y37gVI+P/wNMFQvu +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Retrieve all Managed Clusters.

+ + + + + +Retrieve all Managed Clusters for the current Org, based on request context. + +## Request + +

Query Parameters

+ +Responds with a list of ManagedCluster. + +
Schema
  • Array [
    • configuration object
    + +ManagedProcess configuration map + +
    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 objectnullable
    + +client log configuration for the cluster + +
    = 5` and `<= 1440`"} schema={{"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}}>
    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). + +
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-message-catalogs.api.mdx b/docs/api/beta/get-message-catalogs.api.mdx new file mode 100644 index 000000000..ab4cef034 --- /dev/null +++ b/docs/api/beta/get-message-catalogs.api.mdx @@ -0,0 +1,87 @@ +--- +id: get-message-catalogs +sidebar_label: Get Message catalogs +hide_title: true +hide_table_of_contents: true +api: eJztW1tTGzkW/isqb21NkqJtICQMvGw5QLKeIoE1ZnkAisjdsq1Mt+SVukm8FP99vyOp2902t2WyszMpv4Ddko7O/XxHVt+09FQYnkuteklrtzUW+UdhLR+LPZ7zVI9ta62Vc/zbPW/1uj0WRlk1fLnWSoSNjZwSEZAYTARbJsO6xz1mRF4YZVkWiMR+kA25FQnTiuVYm3I1Lmh0IngijGXSPzfiX4WwOU0cfhFx3gZnU254JnLMAn83LUn7T3k+wZDCAL6FLSKZ4JmNJyLjrd2bVj6b0qjNjVRjjAhVZCSiEbHOMqGwMZ7yOAanUdg5qg9e3q616Lk0AnrLTSHu0kNvn+mR435BZGJefOPZNCU26oRvL4mwnWplhSVWN9fX6d8y8QWStqnGwHSpRewXa5ULlRMxPp2mMnZm73yxRPFmWTncGD7DOpmLzNaee/WT9g05Ty49n6mOOUmzrNxl1isbw7ZfJzKe1HVkGTci+IpIGooS6ur0pAXVl1Ofz+6vYvY0XjFxwYj32S7iU9n+5+bV2UHvw98HV+8PuoPT/sHVcf9o/3RvcNX7NDjoH/cPBt1B7+jT1eHRGUky0ibj+dNY8XMf4uZmfW3t4uKiJTd+VmwiVb7LIHMMs2MmDdz+lZbLBE8kqYJ9lbnXvkXAsJuNpfUUSLQG7iLG2szYSHCYxlNjE34tsFzCaC5Y2mxAX6TyvIJ3TEkYZ6n+ymQ25XFeeqi+RuZJU2ZjbUS7dQtlgCcnRl9YXYDtd4VKUhFSCWnrDleS1mmkjIZSHmnIcmBLJUFvtrFFMz/t5xqjtzRh665420slNMYOjNGGRawfnJPJUSPYhjqZMSf+NU9l0n5G1N3jronIuUz3dPKECHsvlYjGhkviUDiWYyxkoHgtE6xgGTTOPMnSm9y8ZlqCJtob7B3M1w/y7QVhSI+Gx7+CFpWNxxg6VRLrWbkE7kcmuW9bsS348O36zubW6O0W55s/b21svxnujPjr1+s7b3Z2Hon/5tYfhBJGxsxlJ/lvKMQIDt07Btzm/6MM5+ZWYpbemYtv+Rqi4d3eMdvanudBhOeCElSETIcyVqQpH9IjqjGQ3BM+MnIs1UOVbP/gfff0cIAn/YN/nB6c4BPRWirXXQVvTcgtwSp8YYI4zecCfOWWWZFCHSJps1eB6isIxFHIaxOl/2ZnKNEZfGvEizTHirD7HSvqpNnI6KwRSi5uvuXshWyL9hob0jMEMUpFo8y96iLtTPPoMGjyVSh4L9usmySShOQpQzSCKNbPQIjxJKHQ9QRGBSUzlzZ0kTOlcxmLpi3mqmxaY55MDutGoeAA54/7STfOCzDnxKxHYeUtgcVgH/DsNdfkblBTmlPpDMk+hhTIrTOo0aBCITNBNplbFtIRmcsi8ahyXpWx6jnSpbuQKH2GRD7jhX1C3B2nSD+RE60auBYh+OAGOmQjZ43STCEjYZDEdovDrMpcFUYYSZEmq9hdxe4qdp8Yu4uD/dBllNiHoM/GMvQ5VbyAfo0rnkvQxzjvUZqVkwLmc4ZcY1BIgEi/nA0Q2L8KRfPFtyk1Tt8RH/lSvsR8t7KHfz4k+FEZq2ELYtDp0UswQiYSya7je86xB4lOVa+Xd3uvzVDCQdUdEBFZ07CZLnxzUyhFnHC7xhItrPop90jag2ifAWlXlURTDRi+QpIrJLmqRqtq9ONUoxWSXMXuKnb/nLH7IJKsuHLREnCSLbKMm5n3tDBO0nKGCaw872ZVyDlTLaIVIsYqjNVqIofWcHNjuDHajsVWwreSt693Rpvx203+Zntje2O4tbndqtf683kcV0HWjKmavb0dnYoB4q6B4wo67rW51knz+A/qNWJEaY1ST4WboXOo9LLCjps7d5zoa80+cjUrEZJtYEg11xHlNMzNaK4p52ICZ2PkRUXnvRJ8kSvJTICKgdOwVGbSBS9JAbpmFnVHOUTxgTL/kSXsIlWcFuDQZYJUE2rWcCwJIcWIMB8oOAQ7Rnb+jui0PNT+LUie9UniQ5KYHXyLhaBAr5D7m7vOd3tg3lCOOPEGvueg13c7XMEB0BD4nFXhzhU+X+HzVY1f1fgfo8av8Pkqdlex++eM3f8Cnwc0dD8+x4Qn43PMba+zCku9J+f63WG6C5XAgXNvpuO4MO64ucTgUIIVeCjzmdvkFLh+z7tyF6Adzy7pHk4m4G7hWpS7bURDrQ7kUTZ16C4qL990buY3jW7pqpHDkV6EwqRYNsnzqd3tdG5gWVj0tk23RcJFjJnSX9uxzjpDqPOOTEVXCnxU0gR3l8pv0Ha2MJLc3edGR9xbxklPjg0LuVPkBymX9zxmukA2dGTWGEIjuJ57DBan6Dt+sm5227naknyQ69Skt79dFk/oHlnuUt+Du2E+A6cLIpIIl3NvOCGQ7ndf8ol54aHGbnNpsyOatsneCW7QQfjfOl78cjZ4ycYETV1qKCyhYiGpl0BwHcNFXOrrluf+tMhVI6OLsb+Y0238skKhxkYpBGYX6kQIdt4LSviEmtBHEncqpUXC5Q1adfmitE4irkVK5bI91yQ5nkxUBxrq8Ma6l640uh6idqOnfaEiti8pY0kq8TQniOhaQnY+LeXiNbmey8RfSmpRuI/nqNmXC1x41Z7H/qZOjHgnEjy1TlvP3tzTi2r0qOHCE6K6yANpIvDR/D0sLq32bD4a9CKi1+TjQp25i3TNZcynMGZRNtOE9Vg80dqKvzFGrkNhcD4uEEXPZsvd3otcRESb6zWWIr9lJCOgSMffIQJDeWfiQ6riDsRo4DuV+JD87CyLmP/srm19bsjsHp+j2NLMRMf22TzThhFtGPkcYAP/vpaRYyG2SQaXB7wD7M3t7zJBYLSW9zytO7O6I99xa6g0xGDVUbHTXf9ld57gwifmBmh2NQdpmEB49QthuDtHtKigNZRVHh8sanCZX5QsqRb05vmtjq+otv7R5CWJu/NTliOVzr53lr4nk/xx8u7/KeOtMs2PmGkCLCZ3c9uG/qHu5O8CXls+9aNj6YnAX4y6WHUInO76VteL64SmAM/k1S6q44kU7rxgKoCggf3WyLN05iIRrT2Ff3lPeWwwB2FrgUn5UKag5060y525CxgPLMmu9N0WrmmhveIJ+k/RZmdo4VQMs1D7RncyMPZFhz7uBJY5JsOy/dLYAF1ZVijsRnFZZIzDpR7xiETauPCJC92cEqUutIN+1aoyisnVSIS2a2RMZo9GdBSNLrdm+Ef2gt3Le/5QPVkxvAQxF6QvfN9C85qw/THa8LZoItIpNZDIugBgorbDx95giSKIKX+Nu63NuBMW2Q7NBRFqj7z7vG5vtNcj1y7g+VTbHC1vjfgHkVfvncTz11IaPngzP37/Xd9ACcWGuoTOlE7CSITCdy2+Xzxv3dUvYulu7d0UtCATyE2zb26IGeqgbukxtqS+/Pxy3hy5phJ2oc/oTkfIFItvn9TV8aIf3lN56X78efCdlDvFKY//1Gze+bfw0b1CUX/D5pbeivFKczz6Cf7sp7Z06deRRq/94YBcid9TzMMHatBvb/8DB69+WQ== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get Message catalogs

+ + + + + +The getMessageCatalogs API returns message catalog based on the language headers in the requested object. + +## Request + +

Path Parameters

+ +The message catalogs based on the request headers + +
Schema
  • Array [
    • messages object[]
    + +The list of message with their keys and formats + +
  • Array [
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-mfa-duo-config.api.mdx b/docs/api/beta/get-mfa-duo-config.api.mdx new file mode 100644 index 000000000..6e7ff41dc --- /dev/null +++ b/docs/api/beta/get-mfa-duo-config.api.mdx @@ -0,0 +1,87 @@ +--- +id: get-mfa-duo-config +sidebar_label: Configuration of Duo MFA method +hide_title: true +hide_table_of_contents: true +api: eJztW21zE7cW/iuavR8KTGwnTkKafLnjvMBNIU3ISykNmYu8K9uCXclIuyQmk/9+nyNp17u2IUCZ25ZxP1BnVzrnOe/nyPJtpMfC8FxqdZhEO9FQ5EdPevuF3tNqIIfRSpTzoY12LiM8Zv5h4ddHVytRImxs5Nj9uROdj6RlvZNDZkReGGVZPhIsru9hesC4YqDPiF4m8pFO2qzHcv1OKHYt8xE7Pn36397+0eGvjBd4bWQ+YaBrxPtCGpFgKYt5moK459YGSCvighYC6G10YYUB0lzc5D1QIPAyUTvZgLcaYHaM4Ak2L36ZccWHIrq6g5hG2LFWVkARt1F3dZX+Nyv6F0kKbjEhUzmR4ONxKmO3vPPWEp3byMYjkXH6lE/GApR1/62Ic2wcGzJVLj0KAD5yNGtLbW6kIpupIk15P8Wz3BRi1kxHAx7wMMUzgfXihmdjWh4lhW5di350h4eKSNTp97VOBVfRLMHDQU1GslXY2nYrB7xIIe6Ap1bUWBEycBlpm3+9CKRuWPmDMIwIODmYNuzwhPEkgbks6Z/cj4BBcx9kIky7IWr41I51RuLyOMa2Z2LyrWhieD17JyZsACDkurCys64aOucVNrfkvJ9H9f56rbv+av1F2tu8eK/jV+PkYt0cvPtonnX3N7a3JgQVu0A6n/Ry4OsXufh6yMfuA0/bjMB79XmF8ZKokyODj5IAh4Hlr/qalezvFwaeLFNC7EPjpOHBTUA9YuUTACwoPboQUmzq+g4UMR3KD0gYNbdrseC7BGE2dmaVMWVRx+TfVfARjO/IHWCTg9M8n/xxs7aXpC8movvbdd63b836f54lyWRjtyf3fn8bb95QLvE7XsCILw82Nk8fn7/a+nl79Y/f936L7u6gCSjOqQZBOM2ydw2utdCu4rEWjh6lj5vo+vq6XXfkhh9HySP336tooc8E8yy2ThD9saewe79oJNzGotS4l0qwZgfGwHQtdupqA/K49P4WQoP1deLyvFQfeCq/Z6pMRA4593SyME6aYJ9IJVpDwyUhFA5yjI3BvykSMm0E8yTLkHHrmp4PTbTX2C5PIK+Xby8IQz5gePwOtA4XJu8moAslsZ+VWxB8VQgsYCu2BO8/Xt3ubgweb3De/XljbWuzvz3g6+ur25vb28Q9g3ugstkab24Mn8yxfiqUMDJmqUa9lR+hEBRM6N4BcMzJK3KR2ftt4Gh8gf4pG/m1lZgBL6N6vsI42907YRtbLOVqWLjnfDijBNW6OJsLekjuCR8bOZRqERShioy6hf2DJ72L5+d4cnrw4uLgDJ+I1ly/01Pw1oTcElDhCyMkx3wqwDW3KAsp1IFSyB4Fqo8gEA+9UVgo/V92YqFMFiomdgTuC3bUSbOB0VkjlGLf/LAHsi3aK6xPzzKexyPW5xYbYEJa/qiHVDHOW8+DJh+xERoiYR6iIZumYEQjiGL/BIQoN1PoegKDAqEsXNLWBYqwRr0TTVtMVTmbgstE+LxuFAoOIL/fT3pxXgCcE7MehZW3BIjBPsDsNddEd15TmlPpROU8pqqdphOo0RhomCFbMonaHdIRmcsi8ahyXZWx6vndpbsjD2Y/1+5dzAv7BXF3kiL9tJxo1YsPIgSfayFCta1XypCRQkl2m8Oqylxl4LOBFGmyjN1l7C5j9wtjd/blaRgIw1vX+qzNtz4XKoywVDznWh/jvEfpcs796AdHb8gVGmdCi/TLy/MwINNsdTOmMfg79ke+lC/qyIM9/PM+tR+VsRq2IIBOj16CATKRSHYc7ili3yQ6Va3Pc3uiTV/CQdWCFhFZ07CJLhiHykyhFCHhdoUlWlj1U85GHPnRN74+A7oZNGmNtVT5spNcdpLLarSsRj9ONVp2ksvYXcbuPzN2P9tJVqhctIQ+yRZZxs3Ee1p4775dYFjAyq8mWBVyzlSz3QoRY1WPFTU7h6jfXeuvDbZisZHwjeTx+vagGz/u8s2tta21/kZ3K6rX+stpHFdB1oypmr29Hevn9YWCc9lc66R5/Af1GjGgtEapp+qboXOo9KrqHbvbC7580ZodcTUpOyTb6CHVVEeU07A2o7XVkTwW8HCcjFQlgYtcSWYCVAychqUyky54SQrQNZNWb5DTVw8uUEonq7hIFacFELpMkGrqmjUcS0JIMaCeDxRcBztEdv6eXwl5E/2pTp6dksTPSWJ2cBMLQYFede6bi853DwHeUI448wb+xEGvn3a4ggNgIPA5q+o7l/35sj9f1vhljf8xavyyP1/G7jJ2/5mx+xX9eeiGPt2fY8EX9+dY215lVS/1xF2a+X+36S5UAgLn3kzHcWHccXPZg7u+ItxOGAqXQzhdsoo62YB3wn2FTlxeH/Ndv8dTmBTrRnk+tjudzi3MBPPctflYtsvrCUpf0z2GTh+6WZB26H6ADzFa4O6aeQZtp1gjyXd9onPEvZrDDaTIQt3uSPizlMvLMBNdILU5MisMfh78yD0GxDGGiJ+sW912fjMnH+S6MOndn5fFE/qELIvU91luWM+AdEZEEuFqepHujDpuz33uOt20itCU1p1jdkzLumxXcINxwH9x8eCXl+cP2ZD6TBfnhaUWV0gaDBApJ3ARl8d65SE+bXKlxehiOHLAe42vSShu2CCFwOy1OhOCXdbvKJ0iIzuV9moXsbS6elBaJxEfREq1rz3VJDmeTFQHGurwxr6H/jIUDQRS4WPmnrZfqxbbl5R+JNVrWhNEdPMduxyXcvGaXN8K4l8ltZan1nLU7MMZFF61l7G/dhMjeIkET63T1jcz9/RaNXo0PeEJUZ3FQJoIOJpfbsWl1b4ZR4Nei+g1cbxWL0cSRbS5rbwlZlED04QdsniktRX/Zoxch8Lgclggir4Z1jUxbbmIaHVXa5BanmVLttASOnzPERjKOxPvU0l2HYlGs6YSH5JvnGUR828wMCfsTUNm9/gSlZNWJjq234yZGLaIYcvnABvw+8JEjoXYJhlcHvAOsDe1v8sEAWgt73laC7O6I99xe6g0xIDqL5uNd/wfO9MEFz4x94JWV2uQhqmjrr7uo8vAgRZVp4ayyrOAWQ3O4001iuKM3jze6iyKCuXfTV6SuDc9MjlW6eR7Z+lPZJK/T979izLeMtP8iJkm9Ljkbo5tGAbqTr4b+rX5Izw6Yx4J/Iu3LlZdO41hxd9spi6mTmic8py82kV1PJLCDf9jwXPq/VbIs3TmIhFzOoU/RjxHaGiwBmFr0ZPyvkxBzx1Pl5y5CxjfWJJd6W9buAnE/X5ihGFStNlLzGMqhlloFqMLFnj3Voeh7AyWOSHDsv3S2Gi6sqxQdPcbsIuMcbjUPR6RSBsXPnFhKFCi1IV2rV+1q4xicjUSwd3iFiazxwM6V8bIWjP8PbxgdxsOlaF6sqL7nQMGnkqQU5E6z6R1zbb9PtrwttZIpGOaBpF10YCJGoejw/M5iiCmLOTC1K3NsBM22Q6tBREaj7z7rLfX2qstNy7g+VjbHPNrjfje7A9Mmr8umXXH2+mx+l/405xQhWh86IzpvItkK/w44yfHS7rxTuCru+5herwqr7lfRre3dChC49QdPX5fCJq4L6+mkxL9Rb8ncYcjbtz099X98cl07p7/goHmnmqkfXpABuSfKKHhA7G6u/sft1SgNA== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 Duo MFA method' (get-mfa-duo-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Configuration of Duo MFA method

+ + + + + +This API returns the configuration of an Duo MFA method. A token with ORG_ADMIN authority is required to call this API. + +## Request + +
+ +The configuration of an Duo MFA method. + +
Schema
    configProperties objectnullable
    + +A map with additional config properties for the given MFA method - duo-web. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-mfa-okta-config.api.mdx b/docs/api/beta/get-mfa-okta-config.api.mdx new file mode 100644 index 000000000..a43355d30 --- /dev/null +++ b/docs/api/beta/get-mfa-okta-config.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-mfa-okta-config +sidebar_label: Configuration of Okta MFA method +hide_title: true +hide_table_of_contents: true +api: eJztW21z00gS/itTug8LVGwnTiCXfLkySaCySzbZQIqiQuoYS2N7QJoxGolgUvnv93TPSJZsQ4Clbncp7wfWlnp6nn7vHk9uIjtVuSy0NcdJtB+NVXHyZHD6rpAH1oz0ONqICjl20f5lhOfCPyz9guhqI0qUi3M95a/70YuJdmJwdixyVZS5caKYKBE31wg7EtII2kAQw0wVE5t0xUAU9p0y4loXE3F6/vS/g8OT49+FLPE618VMgHGu3pc6VwlIRSzTFNz9dl2gdCouiRBIb6ILp3JALdTHYgAOhF4nZj8byU4LzX6uZILFq19m0sixiq5uIWeu3NQap6CJm6i/uUn/W5T960TFdjFBMwXxkNNpqmOm7711xOgmcvFEZZI+FbOpAms7fKviAgunOVmr0B4GEJ8wzwapK3JtyGqmTFM5TPGsyEu1aKiTkQx4hJGZAr36KLNpyrsBcOeDyvVoFt3ihSE2zT2G1qZKmmiR6fGoIScZLCztMuVIlilEHsnUqcZ2hA67TKwrvl0M0jlMDbCCGLAswubi+EzIJIHNHBmBnJCAQXsfdKLybkvc8Kkb24zElXGMZb+p2feiieH74p2aiRGAkP/C0mxhM2YPVq5w5MFfRvX+equ//Wr7j3Tw8OK9jV9Nk4vt/Ojdp/y3/uHO3i5bBqvAupgNCuAbloX6dsin/EGmXUHgvfq8wmTFlOXI4KckwHHY8nd7Lart7xYG3qzT6BaQQc9P4H+NHHPbIG65dcsXG67oRfE+E11fX3ebRmzZMEoe8H+vopX6qqERuJ1VYX2QaqwSR3kONXTEOSc25CDt1RQsKoY24RylzQeZ6h8Z5YkqAPHAJivN2wb7RBvVGedSE0LFkGMsDGYhA2Y2V8KzrCzNdG2DQRPdLfFYJpDXy3cQhCEb5jJ+B17HK/NOG9CF0VgvqiXwGXanz2yrdpUcPtrc6++MHu1I2f/3ztbuw+HeSG5vb+493Nuj3TNYFlnZNfaWeS5nS1s/VQZ+E4vUolboT1AIkj10zwB4c3KJQmXubhswj6/QPwWRp63FDHgF1aINIcXjgzOxsytSacYlP5fjBSWYzsXzpcCF5J7xaa7H2qyCokyZUaU7PHoyuHj2Ak/Oj/64OHqOT8RrqVgPDLw1IbcEVPjCBDFdzAW4lg7ZLIU6kMHFg8D1AQSSobAHQu2/uZmDMkVI9FgRdl+xoslajHKbtUIp9oVb3NNd1d0QQ3qWySKeiKF0WAATEvmDAaJ8WnSeBU0+EBMUc5XfRzORJNrnNYFoBFOsn4ERFQUKXc9gVCKUFXcctkTtsEjTqm2LuSoX02iVyJ41jULBAeR3+8kgLkqAYzGbUVh7S4AY7APMXnNtdC8aSmOVzkwhYyo2aTqDGvMcGhZIdEKj5IR0ROZySDymoqszVjM/c7o78WAOC8vvYlm6r4i7sxTpp8Oi1S8+qBB8XPlCkSBrVGYKGSlUEl4cqGpzVYEvRlqlyTp217G7jt2vjN3Fl+dhmAlvufXZWm59LkwYv6h4LrU+OXuPsdWM9skPPd6QG9SFhxbp15cvwnBHI8HHKY1wP7A/8qV8Cfygtod/PqT2ozZWyxYEkPXoJRghE6lkn3HPEbOivKq2l3d7YvOhhoOaFS0ismYuZrYUEirLS2MIiXQbIrHKmV8KMZHIj75n9RmQR6ekM7XaFOtOct1JrqvRuhr9PNVo3UmuY3cdu//M2P1iJ1mj4mgJfZIrs0zmM+9p4T2fjAsQiOpYXdQhx6Za7FaImah7rKjdOUTD/tZwa7Qbq51E7iSPtvdG/fhRXz7c3drdGu70d6Nmrb+cx3EdZO2Yatjb27F5zFwaOJcrrE3ax39Qb65GlNYo9dR9M3QOlV7VvWN/b8UPB9aKE2lmVYfkWj2kmeuIchpoM6KtT5JBIMUYedEIpCoNXORKOlPgksNpRKozzcFLUoBvPusMRgWdmHOgVE5W76JNnJZAyJkgtdQ1WziWhpBqRD0fOHAHO0Z2/pG/ZngT/alOXpyTxM9IYnH0MVaKAr3u3B+uOt89BviccsRzb+DPHPT6aUcaOAAGAp+z6r5z3Z+v+/N1jV/X+J+jxq/783XsrmP3nxm739Cfh27o8/05CL66Pwdtd1PUvdQTvuvx/27TOVQCAnZvYeO4zPm4uerBua8IlwvGinOIpAtCUS8byV7jukEvru4/+c7fYyrzFLSTopi6/V7vBqaCiW67cqq71e0CY6/pGkJvCP2sSD10R8CHGRHwZSm/QZeVm2vyX5/smLlXdbg8EzmonI+Fv8i5uscxsyXSG7PZEPD14Ev8GBCnGCR+cUzdZd9Zkg9yXeTp7Z+XxTP6jCyr1PfF3UAvgHRBRBLhan4R7Dl13X73petg80pCk1p/abNTIuuLx0rmGAn8jxf3fn354r4YU6/JsV46anOVpuEA0XIGF+FcNqgO8mkRl5fcluMJAx+0fiqh2BGjFAKL1+a5UuKyeb3mHFmZVTpo3CGy5upeZZ1EfVAp1b/uXJPkeDoxPWioJ1vr7vt7PDQUaIOPGT/tvjYdcagpBWmq2UQTROQZT1xOK7lkQ67vBfGvilvHc+swN3d/AYVX7WXsr97ECGBiIVPH2vruzT2/ToMfTVB4QlwXMZAmAo72D1xxZbXvxtHi1yF+bRyvzcuJRiFtL6vu1TnUwTQRxyKeWOvUf4Qg16EwuByXiKLvhnVNm3Y4Ijr9zQakjt+yoztoCxnfMwSG8c4kh1SWuSuxaNhM4kPyDVsWMf8GQ3Mi3rRk5seXqJ5EmdjYfTdm2rBDG3Z8DnABvy9O5FiIbZKB84B3gIO5/TkTBKCNvOd5rczqzL7Ha6g0xIDKXNx033/Znye48EnwC6KuaZCGqauuf/Kjy6yBF1WolrKq84BFDS7jTS0K44LePN76PIqK5d9NXpJ4MD82OTXp7Edn6c9kkr9P3v2LMt460/yMmSb0ueRuvG0YCJpO/jj0a8vHeHTOPFH4F285VrmlxsDir+ZTF9NkNE1lQV7NUR1PtOIDgKmSBfV+G+RZNuNIxKxO4Y8xjxmNc9AgbB16UjnUKfjxEXW1s+SA8Y0l2ZW+u5KnEL7/P8FAqbriJWYyE8MsNI/RJQu8e2vDYPYcljkjw4rDythourKsNHRtGbDLTEi41B0ekWgXlz5xYSgwqtKF5davXlVFMbkaidDlySTP3OmIzpYxtjYMf8desLsLB8tQPVmRr+lj6KkFOVcpeybRtdv2u3jD2zoTlU5pIkTWRQOmGjucHL9Y4ghmxkEuTN42H/fCItcjWjCh8ci7z3Z3q7vZ4XEBz6fWFZhhG8wPFv9AYuGvIxb98WZ+tv5X/nFJqEM0QPSmdOpF0pV+oPHz4yVdWwdl+8J6mCGvqrvql9HNDR2P0FB1S4/fl4pm78ur+bxE3+gPIviYhIfOd3yR3R+kzCfw5Z8aaPqph9unR2RG+ZlCGj7QVre3/wMJpjow +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 Okta MFA method' (get-mfa-okta-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Configuration of Okta MFA method

+ + + + + +This API returns the configuration of an Okta MFA method. A token with ORG_ADMIN authority is required to call this API. + +## Request + +
+ +The configuration of an Okta MFA method. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-native-change-detection-config.api.mdx b/docs/api/beta/get-native-change-detection-config.api.mdx new file mode 100644 index 000000000..fdedb2d6c --- /dev/null +++ b/docs/api/beta/get-native-change-detection-config.api.mdx @@ -0,0 +1,96 @@ +--- +id: get-native-change-detection-config +sidebar_label: Native Change Detection Configuration +hide_title: true +hide_table_of_contents: true +api: eJztXFtz27YS/isYnocmGVOyZTmO/XJGsZ2MO47t48vkwfG0EAlJaEiABUjHqsf//ewuQIrUxbf2nDYZviQSCSz2vt9CgO8CnQnDc6nVYRzsBmORH8O3G7E34Wos9kUuIny5p9VIjoO1IOdjG+xeBee6MJGwwfVaYEVUGJlP4fFdcGmFgcG5uM0HRT7BoTJWu9YN3zWCx8H1PcyKhY2MzJA4rHsxkZYNTg+ZEXlhlGX5RDBxK20u1ZgpYolFxBOLS6ZYRFwVjn820oZx5lZiNhORHEkRs+GUiI2BgmKH+50vasBy/RW+fJP5hJ2cffxlsP/p8Jhx4FejIAx4MeL3QhqYnmsW8SQBGo7DDigh44anwIWxJLNECTIO0q4FCl7ANxnD55JGsJubQoCioolIebB7F+TTDEfZ3IB4wf2iNkQpBxEStzzNEpzRi3Y23q2/29yKN3Y2+Lu36xtbce9df2tr2Oe9zd5OgKo1wmZaWbAOLNVbX8f/mgscP1uhwEWEZlU5UuNZlsiIRnV/s0jyblE6PfwNyAbzwjnPmVtKKlgsnS3rGXReyCo3BCvw3JmHx4yrmBXWmZhHkS5Uzvh4bMTYEcqMBp+zZDGDfp5LpxOh+DBBu8zrZcBGCR8DNzFJB64nRyt5ATY8oYamcDmvgaHWieCqbkHnCbEY8SIBVY54YgXYv4pCW1MgN4ZPF/R3Ug5lOMzS2t8mMpq8hFGZi9QueiQwrIoUg3ewt3dyeXzxy+Xp/uDiYB/elE/2zg7mnuwfHB3gk+v7msAPkahPgBg7ULnME5GCk9mn2IacAWNT1CYyCM5cRhLiEaJHrVLKw1YisywxEyx2rFWNz0EOChsWuXgew0qrsMb0zHsrcv9TMaxIYLqIH1b44YjNGcULZJkejVxChAybxCyBPG2bViBRny1D6fEr3LLpV6lIh8KcjGB8+fF8wiHffuIyGepbcqtS1KebzYm9avzDKniCXZ+pGKijwiie7OtoCa9HghvFUm0E40NdLF1wIgyFemESmDHJ88zudruxjgpkkTJJx4LGMi1V3ol02rWc2+5EJFnXk7Ndl9w7kzxN0AovMVfCLWCLFCtJNtFKHBdoM/jm6sQFTkV7mRsZiVMggPpJaMb1Pa6JWq1q13J8cn+PI/vLSt5eItEiB8ZACgzZGeEMyIhyRPAAa7WwORvqmOq/VDc8kXHnz9S9ZtGBKgta3tOxWJZvm8x+kEqEY8MlciiI5QgmYkW7kTGmErK5Iwmu6OASjus04AJoorPB3kOtPPPy7XlhUKGGR1+B1mH8OEOXSsJ8Vk4BWEKlZMWyYlvw4dv1nV5/9LbPOQCUje2t4c6Ib26u72zt7ODqKVRmPhaP17uPQgkjI5ZowGHyD1AIFH/rcQItvsQDV9iAaDxB/wjA3NhKTM8vQ2S7BjX0/d4p62+zBNywoOd8PKcEFV6eIyIskgSLr6v9ILkjfGLkWKqHSu/+wYfB5dEFPDk7+M/lwTl8QloL2HmgyhoDrIIvTPQ34tgL8I1bVmbBDnvjqb4BgbjH2X6gdN/s1IIymS8aMMOvvmRGnTQbGZ02QilybQB7JTuis8aG+AwgHgCVIUfURnBOsDeDKBJZHh55Tb6BjMVjYV532CCOJQrJEwbRCERh/hQIMR7HGLqOwKiAUBaE5jEFKg2pVTRtMVNl0xqzrHJUNwoGB3D+uJ8MorwA5kjMehRW3uJZ9PYBnp3mmtxd1JRGKp1CXoa0hn3HFNRoDGiYQTZnEmqMT0doLguJR5XjqoxVT5aU7j45ZvZzTe8iXtgnxN1pAuknJNGqFzfCB5/FvshlI7JGaSafkeAlik2T/ajKXGXgu8LZxm4bu23sPjF251+e+UbfvyXos7EIfS6V39rA4rkAfQx5j9Ll/scfrrl0hlxjoBAPkX7+fOE3TrChvM1wa+MvxEeulC/pokp7uOdD10iJqvTPbIEMkh79PgJkIhHvEt8zjklRTlWbi6t90GYowUHVEogIWdOwqS4Y9BjMFEohJ9yusVgLq37K2YRDfgTIDPy6DEiNdxw6ZN0iyRZJttWorUY/TDVqkWQbu23sfp+x+yCSrLiiaPE4yRZpys3UeZp/j9JyBgNY+ZMTq0KOTDWPVpAYqzBW0EQOwbC3MdwYbUeiH/N+/HZzZ9SL3vb41vbG9saw39sO6rX+ahbHVZA1Y6pmb2dH97uaMDeA4woFzmVzrePm9h+o14gRpjVMPRVuBp2DSq9n2LG/5Ec1nYNsQBiwo1mxvXh5doT0YWkij3pzP4dh0JLq3AYxQkr0YfcbaAsdW+jYlp+2/Pww5aeFjm3strH7fcbus6Bj/zHo2H8GdOwzhFgjhFh/J3SMAXcgNBuBUUCGqAD1KoSNGYhS/qRehX3OzVjkFdBroMjeziKKvNCafeJqWoIl29iJVDN1YXqDsSmONeVYGMD9UTfIWhLQLXqVTAViUjxtkMhUUhyjQEDXTMPBKAepXMyU/latIlWUFDEeI4CkkGjce9XgYxLcSYwQ/gEF2gcdQ6L+C/c4vbX+1H4wO0OJj1BidnAbCYExX+3/bi07JXCo3HELdu5sveK4gNsz5wraCHGbufRVQdAWqrdQvS33bbn/Mcp9C9Xb2G1j9/uM3WdAdY+GVkN1GPBkqA5jO+uswlIf6PTx/xuxU6h4Dsi9mY4Iq8czDE64AlzJX33BHILXOHaDrr+w0r1zHw7j+667hRK6SxNhdWkijMq7Ma4/cOw2T9vegRXBevcdnskOJDc8IjxV+hsdtx2C6pZkJTyE6iIQB9DlGLdAh/RuJLq2y4NE3FnBn/QOqhO9D1LG2ypo3ikIyRyZNbxW4N2MHgOLGfQYP1ka3SG3WpAP5Lo0yf2fl8URWiHLMvU9uBqMZ8DpnIgoQu3e0jkCcrf6wu2lWZHBnwJ6C4ud4LAeey+4gW7BnY559fPni9dsjDCU0kBhEQELiX0DBNIpuAiluUF5UgQnUeUxuhhPiPFB4ywOhhUbJSAw+6LOhWBXh14Jx5D/zyBhk0pxkqAcgbOuX1VnvcWNSLA0zp3zlrHqgoa6vDHvNZVB6hdqt3I6X1TI9qVxPu9unXgRqf1jV1kpF6/J9VIm/lVSCx21kKjZ13NcONVeRe5sdwSxjSR4YklbL17c0Qtr9LC5gidIdZ4H1ITno3mCKiqt9mI+GvRCpNfk44v6TBd/mtOYS2nMQolMYnbIoonWVvybMXQdDIOrcQFR9GK26LZRSBER9tZrLIVuyVCGgBiJv4ULCgRYtNs7oZD8lSwLMf8r3ef6tSEzPb6CwoojYx3ZF/OMC4a4YOhygPX8u7qFjgWxjTJQHnAOsDezP2UCz2gt7zlaS7M6ke/SHCwNEbBKVGy2677szhKc/8ToBY6uxkAaRsBdnSnDy0OeFhavhrLKrYJ5DS7ym2iomXN6c/xWP3hiHf2nyYsSD2Y7Kicqmf7VWXpFJvnn5N2/KeO1meZHzDQeAqO70bK+V6g7+XuP1xZ3+HALeiLgX3hLsUpoG3oZd68aUUydUJbwHL2aojqaSEF7A5ngOWK/NfQsnVIk+mu70AESobGBMRC2FjApH8oE6NHudbkyp4BxwBLtit9t4c9SaH/HucM+Q7umIjALtmp4ihfe/aZ9z3YOljlFw7L90tgAutK0UHgdHNguUsbBpR7xiFjaqHCJC5oCJUpdaIJ+1awyitHVUAS6AClMak9G5+76W83wj6wFdrd+zxlUj1b0N9BngpyJxF8tXrgE+Aht8LYQ7wFiswhZFwCYqK3w6fBigSIQU/6HDm3GXT/JdnEsEMH2yLnPZmejsx5SuwDPM21zaG9rxFfdZd6rXxufd8q72d77d/YXBXz9wsajm+FGGmqlcI2Qa0mvAt+SwujdsinFTY6Hu1LocyagXJx/d4d7Mdim3ePj3wuBjf7V9awDo84VjO9vx1fXh1eo+NWZF+k1/ZpU/4sFS+Uptw/VdLZzEMDHrwI3HGDePd7YdTtCxIp74faMalMWflXBbq7q4z8eoFvyFcDAfwCxIfX9F1Wmdow= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Native Change Detection Configuration' (get-native-change-detection-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Native Change Detection Configuration

+ + + + + +This API returns the existing native change detection configuration for a source specified by the given ID. +A token with ORG_ADMIN authority is required to call this API. + +## Request + +

Path Parameters

+ +Native change detection configuration for a source + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-non-employee-approval-summary.api.mdx b/docs/api/beta/get-non-employee-approval-summary.api.mdx new file mode 100644 index 000000000..709a596ef --- /dev/null +++ b/docs/api/beta/get-non-employee-approval-summary.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-non-employee-approval-summary +sidebar_label: Get Summary of Non-Employee Approval Requests +hide_title: true +hide_table_of_contents: true +api: eJztW1tzEzsS/isq7wOEytixCYTkZcuEQOUUHNhcioeQKuQZ2RbMSF5phuBN5b/v1y3N2BMbAhxql0P5ATAzrVbf+2tZvu7YmXKy1NYcZ52DzkSVf1pzVMxyO1dqOJs5+0nmp1VRSDfvbHe8Siuny3nn4OK6c+6VO7SmVJ/LYVVO8ayjM3NgVF4cOCWzzuXN5XanlBNPr8A3qRmLl3qs0nmaK/FKGjlRhTJlB8SZ8qnTM5IH0pxNtRdO/btSvhRXOs/xn9Jp9UkJKXwQStixMGCtatYyCl0v9F1xNlUOL/CnvLIiDSJXIKm88mJsnSinSryPC1SW4NF7MZPlFH85WahSuQPRZ0YCBnCQltY6Aflo6Ws3EcOs0GZbaCOupjqdilR6JfAO3D3+KeS8UaUlvIRaX1dASO/1xKhMlBZrIVKp0yqXLpJCjtEcj0FlJiRAOZVl8+6eFzrrisF66aVpCG/L/q5TqHcdCG+rPBMjJYhMZxBD+rUGg8yVom3Al70VFzBxI+qVhllbFli8htK6VEVb46kuyIjwYRcR2DjEcwxqihPyFF6pzxI2VHgg0/5ONtiRyZPdvkr6ai9LnvSf7CYPB9lADQbpTn9vHwsMOIG6pQYFeTpVhewcXHfK+YwIPILOTDo3q/GpYFuYExkh7p+fHz/bausDdSm6rqa2WHyg17X2sNRIkdfqwIanzhe21wZiSbaCNplOZRmMuexFMgppoJ1CBpeuUpR1TvmZNQhvUmOws0P/tIX/5vwBf04ZZCiY4HVOgoBJ74MnTterBrOjDyotyVuO6kupgxzRKNkSpamKkSKjr1o2vOIUievuSnTy0EzBUHDWd24Rl33LDk6Rct+vRb3u7j2wCUKKI/kr1fjmhgh31/n2MNcUHkfOIegScaLKylE26RCcdR0a2YxDUBuwRZH4eZ7OVCl1fmgztZpGt630XBuVTJzUJKFikVMsjNWDnFJYlO7Ass4vpuu2kh6W6PbFU6TLSdTvMCpD9nQy/Qhex9ndAp0bjfWiXoIUb3rEmm3VnpKjxzv7g93x410pByg5e49G+2P58OHO/qP9fdq9UN6jy/mlvaVzcr6y9QtllNOpyG0Kj/wHBkEjhe1ZAN4cS7hE3u0D5vEN9qcoDbSNmlFeQX1yG8X66eEbsbsncmkmFT+Xk1tGMMn5KVXUKs/liB5xIdqOQrx2eqLNOlEU8oPQwbOj58Pzl2d4cnL0r/OjU3wiXiuQYGjqSmg5qab2iiWOClyhNXmVc551xYPI9QEUksYvE8bG7ecosAViayyrvMSKuPuaFcusxdjFQl6nUgQV4r7uqu42ijqeFbJELx2hl2bCGiZ/MExTNSuTl9GSD9DWZKbcVhf4IdOkJEoBN1LPkAFtV2bUc3VgMK6QyoqbqK1KlBJAAdX2xcKUbW8sisrLZadQckDyu+NkmDJmYjWXs7CJlihi3amyaLm2dGdLRmOTzk0pU2gBHDSHGdHYUlQm6KaBfGI5Ind5FB5T0zUVa7lWcrl7FYR5Vlp+l8rKf0PevclRfhJWrXnxScXk89R/aywjF26KFQkvSW1e3ECkaIs68cVYqzzb5O4mdze5+425e/vlSUS08S1Dn/4q9Dk3ErOoddw8V6CP4+gxGKMiEcOb6MhtGjMiRPrj7RkS+6MyRK8+zwhd/0R8FFr5ivDDxh/h+YjgR+Osli9IQLZj0GCMSqSyA5Z7ITEbKpjq4epuz60baQSoWQMReT6c24qnZlcZQ5JIvy0yq7y5V4qppCkcGeF9qIC0q8mSmdWm3CDJDZLcdKNNN/p9utEGSW5yd5O7f8/c/SqSbKTibIk4KZ6NhkiL7/kgUoBA1Gerokk5dtVttELMRIOxOm3k0BkN+qP+eC9Vu5nczR4/3B8P0scD+Wivv9cf7Q72Osu9/mKRx02StXNqyd/Bj2xigDg6g64MgsuX1mbt4z+Y16kxfwlSLiAxfAcAd3PZYMfB/ip2PLOWvrqZ1wjJtzCkWdiIahpoC6JtvtAAgRQT1EUjUKo05KJQ0oUCF0eH3LkuNCcvaQG+bp4Mx6VyMVHqIGt20SbNK0jIlSC3hJotAktDSTUmzAcOjGAnqM4/EZ1GF/0lJC9OSOOXpLE4+pwqRYneIPdH6853jyG8oxpxGhz8hYPeMO1IgwDAQBBqVoM7N/h8g883PX7T43+PHr/B55vc3eTu3zN3vwOfRzT0ZXwOgm/G56Dt7ogGSz2n4Pqfw3ROlSgBh7ewKV/vyBYYnHEFQine0OJbMHTfqtNbvkqQ1FcJfC/ap3fdutpywxe4CDAGWSuXg8e0LGf+oNe7hgvhupuunOlufavF2KtuaoveCHZbU5Lo7kBIPyIQwzfHceTostGdprgORZCZBxewmhTBcAUfF3+VM13SId/ObYWyx2y2BXIgxhg/hogzDBj3PFN3OaZW9INe5y6/+eu6BEZf0GWd+b66G+gFJL2lIqlwubhvd0poPOy+cutu0WFoghusbPaayAbiqZIOo0L4UuP+H2/PtsSEMCjXgIqvjilNQwOy6A1ChGvcsD7gp0XcdpytJlMWfNj6CoVySoxzKCzemVOlxMVxNMKfKP4nqNZsUlqkuEDQqsv7tXcy9Unl1Be7C0tS4OnM9GChnmyt2+IeyMOCNvhY8NPuO5OIZ5pKk6ZeTjRRRZ79xMWs1ksu6fWjQvyj5pYEbglz81u3pAimvUjDlZwUiU0skKVsrR/ePPBLlvjRZIUnxPW2DGSJKEf7i6+09toPy9HilxC/thzvzFu+UtheJkI9qy8XHot0aq1X/xSCQofS4GJSIYt+WCy+x5hwRiSDnSWRkrBlohPARZbvJRLDhGCSI2rXjFYsgJzJQkq+Z88i599jmM7E+5bO/PgCXZUoM5v6H5aZNkxowyTUAB/lD02LAgu5TTpwHQgBcLjwP1eCKOhS3Qu81lZ1Zt/jNXztEaIyFz87CP85WBS4+EnwC6JuaFCGCW03XwXShdbIizpXy1j1OcFtC67Km1s0zFt2C/I251TURH81fUnj4eI45bXJ5z+7Sn+hkvw6dff/VPE2leZ3rDQR/1K48bZxUFgO8qcRr60e73m+Lo2/8daHW9SA2hhkwi10QjHLjGa5LCmqOavTKf/QwKmZkiVhv22KLFtwJgJoU/orHxhNHGiQth6YVI50Dn58dF3vLDlhArAkv9L/fcXTCe2VTjFoqq54i1nNpHALzWl0+QLvPtg4sJ3CM2/IseJZ7WyArqKoDN0+h9hVISRC6o6IyLRPq1C4MLYZVdvCMvRrVtVZTKFGKnR5YnGFfz2mM2eMs0uOv2Mv+L2+RA7TkxfjxfuFIicq58gkujZsv4s3oi2ZqnxGkyKqLgCYWtrh1fHZCkcwMx56YSK3btKLi3yPaMGExqMQPg+7/e5OwuMCXSy3vsRsu8T8hSrF6eIWfesHLvVl7eb7kdvBeb04gN/8zmXzO5eV37lEtEAe7M3ozJJisApjZ5j+Lzrrp38qsM0Ptg7aP27BSDlFHNPi62s686KJ+IYeg4oOVC4uF8MuHxIgz+hz1jkYg7f6ShTfP4m/QtliD/wSP4xZa8X6fNjMF0dDHXz8qOhEqW2wm0ssCKd/bI5AE84Hl1avfINGw3tzZvPiiKqQ/AIOjB9genS6/wJN/o9a +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-non-employee-approval.api.mdx b/docs/api/beta/get-non-employee-approval.api.mdx new file mode 100644 index 000000000..cf8c81aa2 --- /dev/null +++ b/docs/api/beta/get-non-employee-approval.api.mdx @@ -0,0 +1,99 @@ +--- +id: get-non-employee-approval +sidebar_label: Get a non-employee approval item detail +hide_title: true +hide_table_of_contents: true +api: eJztXH1z2kjS/ypT3B+bpCyMeDNQdXUPAeJjjxgf4M3t4015B2mA2RUSp5HicC5/9+vuGQkJsI19ruzeHqlUAtJMz697+l0j7grBSoQ8koHfdwutwlxEF4HfW668YC1Ee7UKgy/cK5wUlHDiUEbrQuv6rnClRNgJ/Eh8jdpxtIBrBen6LV94y1YouFv4fP/5pBDxucJbQNBKKLKBnAln7XiCfeQ+n4ul8KMCDHaFckK5QiAAQy8sFOPMh9kimc0NIBaKf8ZCRYz7LoyI5EzC4GghmA+YzDARFgH4iod8KSIRKoIukfyKA+iTgg834Jt04bP4ymER/Modu+SWS9xqVG1h2eLMtRp2o2pVym5ZlMtOyT5rFrYB53hMUcpILJl02Zurq373LUxC2DIUIOkojAVI1VmIJS+07grReoWLqyiU/rxwf39ioAKb4TqHT/qOF7vCckXEpffnGfeUyDCTu7uDcwIiCqa/CCdCwSaIR0aat9LzUJxsKpgh5DJNid0uhM+UiFgUMFqzyN51xYzHXsSA1xhmwA4AV+9yfNLQxxj9jKPVKvCVUHi/XCrhfweLV3ODO+2gRoI2wWwY4kmH1Pr0F4Uk7jIQuOcNZ6QNBoymgcoSojlEUkMBxdgBfFKYBeGSwyoF3NTnKUJuH8uOLSqNxhRUrFazqlPQOD6tOVajeTazy6WqXWs6hfuTQqLMu1IZiZkIhe8I3BNUfq5U4Egewa71XRAF2uvJE0zqu7tsCj9eovW2O53h1cXkpjMcjXqD9qQ/vIDPFx/65zAIbvbG45vL0fBDf9DbXBj1/n7VG09u2pdw64f2QN9BOvjp8nLQ7xAl+NZpf7xs98+zH2+A2KQ3wiu90aT/ITN4cDU2d4YXF73OZDi6GXf+2vvYhku9i0l/Muh97NEq58MfeqOL9kWnd3M+Gl5dwqV+l4b8mPmYgZ5eMuDh0qD/odf5sTPo3Ywn7QkOumyPx5+Go+7N5RB4QEqjIc0eXdF/42Hm1nh4Nerg1Un7XP97A5z0zoejH+nr+G+w1vhqgEuNepfD0WTzHQn90B8OEs6TbWh3Jv0fNA+A42+atV3/6TPcP+PZWTAj9cAtVvilOxkqpuLVKghRV25ltJA+DUnU5iK4BQ8wCznoQ+xEcSiKOeXNiBKG06VuFExQh0Bl9xtOHmKy0rZZ1Ox6o2TX3Ep51miWHG7XGnbZadqNUqNSAw+MvjFdMyGSWsInYAUCGZqN4wSxH12QW3wKjHGAIAuZwDLzGfnVLMAIBhbN3Y19cm8c8ShWj5oSWUOvS9v9PWgvfbzsXXT7F6ggF0NUgHb3R7IF0NzBAEbsbG4PyEEAXIHbRKz+XAe+bJxMw2PigJQGt5FcO486w8cwdLWzMWzAalO4sD9EA+mAxmckZN+jL14ujS9+XPJmIGpl6uhg/jJwMaY/7oBd8HRWJGl/8lQ/YbBCqSSCuOWKeaDMLCGcV+dyyW5apYZVrkzsRqtWbtWaRbte/n+E4kBGE70uEkPyMQzVUqtSK56dIYaMwu9JzvoQW95zhYb3VEDbDflPhNpUjzaBhUINhHq+yQ2/WTxN4EgQ3b3OMtBqs9p6jHLHKPe/EuUyBFMcGciIr2CI1ut2vT6tTUslGz6dOZWymFVsXq9vKodPkPxLvmTjJVCH9fd7HeM3BpDRHuBwXjMI57fmVqMtKo0W3IgM1YELZX3Kd4rRzD1LGIEgcQwdL6JNMWeX9DhBDRUJVGnPpUqzHpHH/5nrRYiuuMpqEfjPx06z8qvU0j8UpKmCD58mjFVnspX9LsV6rBllZqchrCgRfsEaRseXbD4DYMxaeTi/cADoBmSNmdg2DuLQEd+00lO0JAWmXC+hVClV6o2yVRNVblWrszNr6jplq+6Ium2Xa9WmYyN4Pb1/gEPRvIEHy8ZkdG27UjOgtrIM7Q9q9YZTKzedOviDhuPw+gy8kF2xKyTKgzTdIMHBL8Qy0j2K+y3KBy6cufjC9XcJPZRr6ZEHOj3daGhHgH4aR/panoOBVJTx6pGMp0OfxYhBwcOQY5mPPQb1dCZ0mKrn2mF2qVSqWWd2rW7Zdq1kNewz26pNy82yqIhSqVHd3SLNWCoDpmsytQb3vsysPw0CT3B/12GE2E+aafa3pYSNJnAHkHMH4Zrh7lPXaiMjZYSkctuNvalXrCx2UP32JcZeSM+sNU6eTJUnvX9g6tbVqWKabxxYpiJVVH1gB5DuQoYwIVYR7dw+O8ybVpKJeXwqDoiiAxzGXKlWHl+DhQVabFd9BlLer2t5sbVNDKNUAEUlnIUvHe4dlhtgGEynaMdpctbNeuxjrKj/GvsS0iEGlrvXd5lwWvQNlIXwVhPx9YCKG0cybN1nJDFdgxTyCyBYg0EHaVDp0AgqjeaUXHjcEYvAcw/JBP4qQXy0eLTgEaRenqdwA6bB1/zyPR/qOlAQAyGG5EBLLN2qRAJJJaj7zU+6lv6MutQn+y0G6Ca0aKVd12JKCL0nO/4lh+VaY9nWk0RfPx+i4piI3z8wMg1KWA+Mt6MOhlUwsn0RgbuuRHFw73JPlZz25nfqrVRMUy+Ynk75XMsoJ6HiH6kn9pI21qYroQmAcuCgLnjhV+0hacrCWyeNsx0fXy5ZpYpVrk5suwV/q3bRroDbr7VKJYrGEQ+jg2A9nvtqCRP7RBJ9+3bWmWKhosd3X3dZILh/UZsWrf0mHcUnpP/t2oqPAnnIuZhiHD1LEEfZXuPDc7Kjuia3pz5Cdd8zvY4nce96YQg+xGJQDMShj8X/LMfYNHDX6JalTxXjsx70PZ4J6webncA9IHR/kL6w5iGXiFAQZAcmMmRYuuhvlkEokmelJqrTuPxugCSKNnvPXZY8c+0YZjCdCLnzK9A6pA680nExmYJPmZPYvGdZcSb4tF5qlquzepXzcqNqn9WmzRmvVErNWrNJBiKUghI7662T0iK/9LnwRSgd5gUQ0eS/QCCgdyB7AkCLH16NEI0DUyc9NmXT4KVs4gSC0PvOJauegU3685iu8/mWEHzraoz9rtiDAJwpCTThYSjncm/5mcSqbu9DO+ljmuYp0trXl5S+i2oJUEEXFsEtITYMoKkq4YE4wFbZO0P1HTDEfZUdKPU3XTWBbtHDdphhVt8zI0uazcJgmTMlRx/ZYG9kURRPIMlE78UjZ8GmXG3y4XdtysGtgZHkO7YQHLK7t0XWThMH/cwfC7E1ZquQUaDpagKzGFupVMCC76DzGdvp60aU+d3Y+JVBdlMo1z4kuW07UQzgiM2sFabaYiCa/QHMWnK7uW/Wsaq1H3EnwgwOwq0ThCEeoIBMiMlIMeOOcLsUOB4/GZd6rGxTgdzdRw2mGwV0z+GxOsDuLj1wP5bO3JMbX4QxPoUdNO2NaDeSbTIeyRwQoMlmVLpdieFDNi4892i7R9s92u6Btrt9c2ROMpm7lPrYu6nPlc9jkG9IwXMn9QlJe/yAJYP04y29kScMBGJSpO8/TcCwf4VMEMaLryusOl8xP9KhfAd8O90PfX2aVFtJ6N/sBQIkOWoOZuCJhNsi3BvEJCgtqsruah+CcCpBQf09KSI1BdZBzDiILIx9H5FwdcLcQCj/u4gt+BfdUVIqfW4NtYK1CqT/vCNjx0zymEkeo9ExGv2uo9Exkzza7tF2/ztt99FMMkVF1mLyJBUvlzxca00z9/XRChjAkjP1LDU52qrtbAWJsTTHKuQzh8K0bE/t2Zkjqi6vuvVKc1Z26mVeO7PP7Gm1fFbIxvrrjR2nRpa3qcx+630kEdOxj5DFPiiXioLAzbf/QLyhmKFbQ9eT5s0gcxDp5zR3LDd3c8dJEOBbJuskQ1K5HNLfyAh9Goxd4tgwGQsDOJuDX/TxIZwEXKhKcimASghKwzy5lGS8yAXQDddWe4ZPrbShJEqWrmLeqFDkCbwAs+YAFEvi474Z5nxAgTLYOXjnV8xOzRb9R5k8GyHHA+SY9b46QqChp5l7bV9/t49P8NBHjPUGP9Do1dUO90EBoCDQPivNO4/5+TE/P8b4Y4z/Y8T4Y35+tN2j7f532u4z8nOTDT2cn8OAg/NzGFsssTSX+oDK9c3TdDIVg0C/8Rs4ThxSuznJwSmvAFUyb5GjD8G3rFuF0+wpHCs5faNO76R7X8AXyzE71MDi0IMJiyhaqdbp6R3sF+zTfZGvZDE5KO4Ht3iq/XQKQtrjf/CggLY1HMDal31TXxRJwqFEJdYej4hreRNPqK4gd+oNP0o5Obi3DmLwcUTmBM81GoWiy3g6B6qJ75Q5/H9Pb3Rv8Qd8XYXe/X/Oiyb0AC/7xPfoajCeAdItFs2xj+R3AOi4mV5959cANuEEy7XyzmJDHFZm7wUPoS7QTzDefP9p8pbNMeEkg48V5rpCYoUAJnMJKkIOrZ1083ESxZgwiOcLAt7OPS9BA2IzDxhmP/ljIdh19rWfEbhmEilOEuQNcNbnN8nuuOKL8DAIFjeSRMWTrn8KEjrluXlvKeBRZSB9fX4HrhZ/8i3WleiHJAZuHGNYpEKPXa8SvniGr5eC+FNCzdLULKKm3m6h0KK9dvT5GwesGEmASZK0Xry4pmdl6GEZBVeQ6jYGlITBkX/K5SS79mIcOXoW0svj+Mn/tJAQTfPTmHZeTEEw9FzWZ84iCJT4C2OoOmgG1/MYrOjFsG5xUYsswiqXMpAsvaQlLcgNCd8ADMPXysSnGJspNQkga/NdbZI/086Czf9Mv4Dxc45nunwNIRRHuoGjXowZF7RwQUv7AGXw6wiFioWn1YAH8gNaATqb/SdPYIBm/J6mtderE/lTmoOhwQGo+pWKVUt/aW0cnPnE6AaOTseAGy7QCWnz3A8P8RpaGKZywkqaAtsS3MXrBRAdt+Sm8aZNKYyYvzd+keP2pncy9L31a3vpBzzJ78fv/kYe7+hp/oiexiS7qG607NZLuqjk702+ttvLw2bzQsC/cJdslfJqqFqS173yLyevPB6hVpNVOwspqAuwEjzC3O8ENStYkiVCVo3mD7UeEZrTUeAQIHOo26QH9KhPnazMyWB0Yon7it9VrH8YCNZyFlBViiL7BIWZ78C2YFGGJy3g3i+Bqc7GsDOXuLGsm2w2JF3LZezjC50AO14yDir1hEa4UjmxdlxQo/kikUVAqV86K7FiVDVkgd4QEuFSDWfYYJb4wmfhwLVg35XpLoPocRfNO9AbRkbCI83Ecfm0/SnaoG0WvmNDLyYBLCjyMit87E92KAIx37zjE4TzUzNJneJYIILlkVafStEuliwqF/DFm0BFUMhmiJ+L6MFfzJK6O7HvV6HuNn321/zlLRNesC44XWFHC0HHuk7RteF1YX9tCJNb0sW3PBYB/kbFdeHuDpsfWC3d42X9q1hYMoLU0RQ2vzT1IGeTb/PTV3u5/lVgH2Dnt7lMyV8oYGWVVHTPZOvNyLxv9JYd+CNkexEm/Uh/ncWVInexzse3zDi95gUI9Q3dhMpM2XlMg6yljYHzHmo/fyD/MB9a19hS+De12gMm +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get a non-employee approval item detail

+ + + + + +Approves a non-employee approval request and notifies the next approver. + +## Request + +

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. + +
  • Array [
  • ]
    • data object
    + +Attribute blob/bag for a non-employee. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-non-employee-bulk-upload-status.api.mdx b/docs/api/beta/get-non-employee-bulk-upload-status.api.mdx new file mode 100644 index 000000000..474b1aad3 --- /dev/null +++ b/docs/api/beta/get-non-employee-bulk-upload-status.api.mdx @@ -0,0 +1,84 @@ +--- +id: get-non-employee-bulk-upload-status +sidebar_label: Bulk upload status on source +hide_title: true +hide_table_of_contents: true +api: eJztW1tTGzsS/isq78MJKcYGh4TAyxa3pDhFAmug8gDURp6RbSUzkiPNhHgp/vt+3dL4DmRzUnvOSfklsWdarb5+3S2Lu4YdKidLbc1x1tht9FX53pqjYpjbkVL7Vf75Eh9ldl7KsvKN9YZXaeV0OWrsXt01Lr1yB9aU6lu5V5UDPGvozOwalRe7TsmscXN/s94oZd/TKzBOas7iRPdUOkpzJd5JI/uqUKZsgDhTPnV6SAJBnIuBEuZhecTe2bFwqqyc8aIErQ+PbY+/GXWrfCm6WCUqXiY+2a7oWReIhyrVPa0y4W3lUtW8NlBwKJ0sVKmcZxU1iTGUUG69ob5JCKLwoJ3ubL7eeP3y9VZbvdqRamPz9daLdtZup2m3vdnugdiACyh11phX6px3E8eH4tnl5fHhGgic+lJpp+CB0lUKVk4HqpCN3btGORoSG186bfqNe7KnU35ojVee3rc3Nui/uR0eMkMyMcO60D0hzaiJ7VPyIewPRnI4zHXKAdH65Inb3aI0tvtJpSUZy1H4lDrIEqy/KDUsZ6qCQuDs6P3h8fu3eHL8/t9nndO3naPzc3w7OH13dnJ0cXSIz0edzmlnMRQ6U27u2Ty3t2Atvsq8Ul5ok7HQeELvIVYfVoIFHMLDV3lZ22IuFuDy61qo64YolIw7UJxoL75UqkJ8SJOJW6kDfyu6vEOKDVTGHKaUWcYFGeNg3nyElcRidvFY94WlA+mxQhmRWoq7EpLc6nJgq5IcJ5Rz1nnmwTZbWN+TOscaSBx35OWTdabK87hkZjtfdQtdlmEpZ8pUfkySoHbm/T1yXJf87DHwuL8nyq1lAXuQaxhIHJFkIhHB19hfB69RenAI22xEBtUGftfZTwzdTJUw1oHN1LLwnRX2jTYq6TupSUI2JhyUcUx81Rk5uLBOicCyDjyma87YD5Zobop9RGIn6ncQlSGDOpl+Bi9C5acEujQa60W9ROhsjHFLtlXbSnZfbey0t3qvtqRsv97a3H7Z3enJFy82dl7u7NDuBYIFoDydy9I5OVrY+q0yyulU5DaFR/4DgwD3YXsWgDfHEl2qwj/tA+bxHfanohBox2pGeQVVonUhxf7BmdjaFrk0/Yqfy/6cEUxyScBDKSC79IiAF5oHxqdO97V5DMkOj97sXZ5c4Enn6F+XR+f4RLwWYGvP1OAEURELA3vLEkcFbpFzXuUwB9BAPI9cn08lciTUscCNPIyJ2OpJoBpWxN2XrJhmLXrOFjOplIayLZ7ppmquI+/xrJBlOhBdCWQScCGRP99LUzUsk5NoyedigLqu3FpT7GWZJiVlXqNwIQnhhMwySt3AoFchldUYt4wtNZBkxhcTU856Y4IqJ9NOoeSA5E/HyV5aVhCO1ZzOwnG0RBGjfyBzsNysdBdTRmOTjkwpU2ghcwB6agHtKRXXUujSiwhH5C4P4DE13RixpsGS4e5dEOawtPwulZX/jrw7ywE/Cas2fvFVxeTzEfKBRuyN2k0RkSKo8+JINXZXnfgCfVGerXJ3lbur3P3O3J1/2YltenzLrc/mYutzaSRGJ+u4eC60Po6jx1hRE3F7Ex25Tv1tbJF+/3CBxP6M7g306tuQpomf2B+FUr4g/N7YH+F5t+7A69I/8QUJyHYMGoTedJflnkjMhgqmerG42xvruhoBapa0iEBNJ0a2EhImc5UxJIn06yKzypvfSnS3wEeZchvMCEi7miwZWm3KVSe56iRX1WhVjX6darTqJFe5u8rdv2fuPtpJjqXibIl9kq+KQrpRiLT4nrSVAgSiPjAW45RjV813K8RMjHusxmzn0Oi2N7ubve1UbWVyK3v1YqfXTl+15cvtze3N7lZ7uzFd668meTxOstmcmvJ38CObGE3cV/RxlUFw+dLabPb4D+Z1qkewRtAz7pthc5j0Ztw7tncWe8cLa+mXhlHdIfmZHtJMbESYBtqCaF1NCwIp+sBFIwBVGnJRKOlCgYtD0IhcF5qTl7QAXzdK9nolVAmJUgfZeBdt0ryChIwEuQ3nynTEjNTpUc8HDtzB9oHOP7E7jS76Q5286JDGJ6SxOPqWKkWJPu7cXy473z2G8I4w4jw4+IGD3jDtSIMAwEAQMGvcd67681V/vqrxqxr/a9T4VX++yt1V7v49c/d/6M9jN/Rwfw6C7+7PQdvcEONe6g0F1/+9TedUiRJweAub8gWHbNKDc1+BUIo3ivhWDV0ParSMNYmKFwSScK3At+50dj/7ZuquSstPrh5R7xjErlwOdoOyHPrdVusO3oQX75tyqJsAOTi0HBl720xt0erChEvQia4RhEwkAr5JFDZosv2dphAPeMjMgzdYYwpmeIVPjh/lTHeAyM0jKCoCm3WBdIjhxo/pbgdmjd88Uzc5vBb0g16XLr//47oERg/ossx8j+4GegFJ51QkFW4mN8XOqTEPuy/cF5sUGxrm2gubnRJZW+wr6TA1hN83nv3+4WJN9KkdZTioPHXCStP8gIQ6Q4gw3O3VZ/20iCuQs1V/wILvzfyaQuklejkUFtfmXClxdRyN8B51oAPgZpPSIsVYQatuntXeydRXlVOJbE4sSYGnM9OChVpyZt0al0OeG7TBx4KfNq9NIg41oZSmsk40UUUeA8XVsNZLTun1o0L8o+aWBG4Jc/Nrc1IE016l4XZOihwnFjL3bK0f3jzwS6b40ZCFJ8R1XgayRJRj9jewtPbaD8sxwy8hfrNyXJsPA41aO7tMBGgTHqUyz8SxSAfWevVPISh0KA2u+hWy6IfFuqVNE86IpL0xJVIStkx0gs6R5TtBYpgQTLJLlZsbF4uezmQhJT+yZ5HzH/kW28cZnfnxFQosUWY29T8sM22Y0IZJwAAf5Q/1iwILuU06MA6EADiY+J+RIAo6hXuB11JUZ/YtXkOlIYWo4Q7icDd82Z0AXPwk+AVRj2kAw9R4j38VxHcReVERmzFWfWQwb8FFeXOL2jlntyDv+MiK6ulfTV/SeG9ysnJq8tHPRukHkOSvg7t/EuKtkOZXRJrYClO48bZxZpgO8v3Yry2e9NFR9EDhX7zlXOWuGzNNuMRLXcw0o2EuS4pqzup0oBWfEQyVLKn3W6fIsgVnYn37ON4G7jvQIG09elLZ1Tn48Sl2vbPkhAmNJfmVvvuKBxXaKx1g5lRN8QFjm0nhFhrZ6B4G3n2ycXY7h2fOyLHisHY2mq6iqAx2o7ysCiERUk9ERKZ9WgXgwgRnVG0Ly63feFWdxRRqpEKThxdX+NMeHT9jsp1y/BN7we8+nj3D9OTFeK9/okhH5RyZRDfbtj/FG9GWDFQ+pKERqIsGTE3t8O74YoEjmJl4Gdu6fisu8i2iBRMaj0L4vGhuNjcSHhfwfGh9iTF3ivn+1D34+o8mTLznPR+Ld5Oj9z/jDzJi7aGhoTWkwzDSqApDTBgrrxrLxkos3eW/vnhosqRsDrMlppUBTESc7u7oZIWGrXt6/KVSNLZf3UzmKJ4/4UL6jAG3B1BRj1jsWSf+bceaWPKHH0uVq88DzWhyFNDAx8+KThCgE+ZsSMxHPCxNeBEOgaaWLPxMQmPZeDB/e0TxJR+o8PEDNAeG/RcqykeD +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-non-employee-record.api.mdx b/docs/api/beta/get-non-employee-record.api.mdx new file mode 100644 index 000000000..0de4d9207 --- /dev/null +++ b/docs/api/beta/get-non-employee-record.api.mdx @@ -0,0 +1,87 @@ +--- +id: get-non-employee-record +sidebar_label: Get a Non-Employee Record +hide_title: true +hide_table_of_contents: true +api: eJztW2uT27YV/SsY9kNsz1KvfUpfWtm7zmzGid19jGe68UwgEpLgUIAKkLbVnf3vPfeCpERJ+4jjtmlG+eBoSeDi3CfOhaDbyM6Vk7m25jyNBtFE5T9ZczabZ3ah1IVKrEujvcirpHA6X0SDm9vo2iv3yppcfcmHRT7Fs0inZmBUNhs4JdPow92HvSiXE0+vIC6u5Ik3eqySRZIp8aM0cqJmyuQRBqfKJ07PCQZAXE21F0DihRQG01U13TGeFgDNpZMzlSvnGZKmaXMJMHuRwQv8pQl3U24DSpAldCqeXV+fnz7HaKf+WWinYIfcFWovUl8kRpOwXtLvnnRORkdq3E0P9lWni08j2UnUwXGn3zkgEyVTNZPR4DbKF3Oa43OnzSS6I2M45efWeOXpfa/Tof89js2OPqokh+yErA1LYZaczzOdsMPaHz1Nvd1cup44d+TeXIeFYZINeHvR2LqZhOyIzPBEm7Wiu71IJoktTP4T23tTblPOBWyrfK5oNlRBLIlyviCHscCxdv6J4lZhfecFzywFrfrtvc4yLWckPJNfKZsmbhF9OdMINwiG6XX2m6XyrKbEzwFsy5Pkv5XPW4ll+POpNb8dO89qrnJY/0diZ5yG7nHBV1NVO+z8VNgxcvOTzPSKP3MrUBk+YZwXOaXwau4CTLlWE85HCYCpVQTG28Il6nxrlD6oZpjIcbklaw+PTpLDXj85QtaeJIk8Gvc7SXe/u09rpjLfmjkyTTUtJrN3jRxaS+51YMMcL0ZFrsQos6P2SE4E8mutjnGw+1y6/FTmW51a5yTgqTjXCNsHEzNIpmoqWK6geWvG6HT7ceck7u1fdU8Gh73BYb/VPer9g0PYpP8BJJC6FUevcx+OmU31WKuHy9T9QN5PlUHkUZ3iYiM+yzJ9K8FPN0mCnSz/tkhKkQ9hOOgM9g9bx8eEASCQVjxoc0u+u6P3B9t2kleZJuufOYfAi8WFygtnqO6OG4hGNl0IJKk2nMatb7fNpCpHbXtl0yfUq9faqHjipCaEiiEnmCgg8ZNOMQOuc0oEkVR1SAUe1zQjLNHqipcyFeVGI16VypAZnUx+haynVJZrozFfVFOIH1AC37OsOlZydNTp9w7GRwdS9k4OuseHo/5Y7u93+of9Pge18h51b7V6SOfkYmPp75VRTiciswk88i8YBAED2zMAXhxTdK5m/nEfsIwn2J/Kehhbq1niFcTv9lC5Xr56Jw6OkUdmUvBzOVkzgomvL4l4FVkmR/SI6BNtuSz4rdMTbbZBUaaYEUU8PXs9vH5zhScXZ3+/PrvEJ5K1wQuHBtGaUlgCKmJhaj8z4lIByjGvMpgDSSZelFJfQCFp/OpAHf7yC/CRGWJrLIssx4xy9S0zVkWLsbOzRiolgQyLZ7qlWntiRM9QIZKpGEmPCTbUghfDJFHzPH5TWvKFmIItK/e8JYb1bkObKoRi/gKCBLYhSt0gYFwglQEG9MAW4CQ218ladV2asumNZS15s+oUSg4gfzxOhkleAByruZqFdbSUEEv/AHOwXBPd1VpF9AuTywRayCxbwIwOBBOVCbppkP+yHJG7PAqPqcbVFWu1RHK5+zGAOc0tv0tk4Z+Qd+8ylJ+YVatffFJl8nmiNaEasTcqN5UVCS9JbZ5cjqrdVSU+2KnK0l3u7nJ3l7tPzN31lxdl/1y+ZerT3aQ+10YWsK/jzXOD+jiOHmNFNYjpTenIPQGDlBTph/dXSOxfQeEwXn2Z05nAN+RHYSvfAD+s/RGej4h+1M5q+IIAsh2DBmNUIpUOGPcSMRsqmGp/c7XX1o00AtRsoYiomk4sbCEkTOYKYwiJ9HsCfZo33+ViKj9xNwi8oQLSqiaN51abfMckd0xytxvtdqM/z260Y5K73N3l7v9n7j7IJGtUnC0lT/LFbCbdIkRa+T6cd2OAqL7JWX45w65aZyskTNQcK2oyh2jU64664+NEHaTyID3a7497yVFPHh53j7ujg95xtLrX3yzzuE6yZk6t+Dv4kU3MZ/FOFAbB5XNr0+bxH8zr1JjKGpWemjfD5jDph5o79vqb3PHKWvr+blExJN/gkGZpI6ppGDujsa4aiwFSTFAXjUCp0sBFoaRnClIcgkZkeqY5eUkLyHWLeDjOoUpIlCrI6lW0SbICCLkSZJZYs0VgaSipxsT5IIEZ7ATV+Ruy09JFv4vJiwvS+A1pLM6+JEpRotfM/XDb+e45wDuqEZfBwfcc9IZuRxoEABqCULNq3rnj5zt+vtvjd3v8n2OP3/HzXe7ucvf/M3d/Az8v2dD9/BwDnszPMbbVETWXek3B9V+n6ZwqJQIOb2GTpHB83FxxcOYVCKXydh7VELrnNojaq1dK4nA1y7dvdXoX0YU94oYBVuEyDJ/m+dwP2u1beAteumvJuW5Vd3eM/UwXjdojmGhL9aFrAiHTaIAYvjsvu4sW29dpCuFQ71h4sDZrRMEKq/PJ8IOS6YYVuXFhC1Q4FrMnEO5lOPFjQJyjl/jOV3fGYJ0N/aDXtcvufr8uQdA9umwz34OrYbwA0jUVSYUPy/uVl0S8w+obtyyXmwk1a72Nxd7SsJ54qaRDVxC+v3j2w/ur52JCdJPTvfDEdJWm/gAJ8w4hwuVsWJ3l0yTeYZwtJlMGPmx8W0LpI8YZFBY/m0ulxM15aYSfUOcvUJjZpDRJcS2gWR+eVd5J1SeV0RbYWlqSAk+npg0LtWVj3nPe7rgv0CZcu8HT1s8mFqeaqpCmbZvGlCpymydu5pVeckWvrwXxl0paHKTFLM0/X0MRTHuThNs3CXKYRMjMs7W+evEgL16RR00UnpDUdQxkiRJH8zuupPLaV+NoyItJXhPHz+b9VGMvbU4ToXQJj60wS8W5SKbWevVXISh0KA1uJgWy6KthfaZFY86IuNdZgRSHJWMdgxkyvjdIDBOCSY5oZ2ZiYsHZTBpS8hf2LHL+F/TNqfiloTM/vsEGSiNTm/ivxkwLxrRgHGqAL/GH/YkCiy6ZQQeuAyEAXi39z5WgBLpS94KsrVWdxbd5Dm0NCaCyFD8fhD8GywJXfhL8gkbXY1CGiVjX3/rhb1HKok2qYazqSGDdgpt4M4u9cc1uAW99JEX75R9NX9J4uDw5eWuyxbeu0vdUkj9O3f0fVbxdpfkzVpqS6lK48bJlT7Aa5C9LvrZ5kkdHzVOFf/GWc5VZNXoW7sKYxawKmmcyp6jmrE6mWvEZwFzJnLjfHkWWnXEmol2n9Eenx4ImfIPXAbJE16YzyONT6mplyQkTiCX5lf72BTcitFYyRU+pWuI92jKTwC3UktE9C7z7aMve7BKeeUeOFaeVs0G6ZrPC0B17wC5mQiKkHomIVPukCIULHZpRlS0sU796VpXFFGqkQoubEzfzb8d0vIzOdcXxj6wFv/vybBmmJy+WP8VZKnKhMo5MGtek7Y/JRrTFU5XN+accgIUWb2WFH8+vNiRCmAk/DGhZN2mXk3ybxkIItUchfPZb3VYn5naBfmhhfY42dkX49yoHqWzccq9/GNUIxNvlufpTfsNUbhTE8NtzOpmi5YvQcYQe7yba1uNh6kCn9LOpKbDSqNtbOsKgrueOHqN1p/745sOyoeFGELakz+gkx8hu9QD6ZxflT6Gei8d+NLVVi+oUziyWDXiEj78q6tsBHt0t4PPBCkMLL8LRy8qUjS8nqFmq2+Hvz8jr8p59t/wAM6Cy/Bu5dyGj +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get a Non-Employee Record

+ + + + + +This gets a non-employee record. + +## Request + +

Path Parameters

+ +Non-Employee record object + +
Schema
    data object
    + +Attribute blob/bag for a non-employee. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-non-employee-request-summary.api.mdx b/docs/api/beta/get-non-employee-request-summary.api.mdx new file mode 100644 index 000000000..e78d700e9 --- /dev/null +++ b/docs/api/beta/get-non-employee-request-summary.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-non-employee-request-summary +sidebar_label: Get Summary of Non-Employee Requests +hide_title: true +hide_table_of_contents: true +api: eJztW1tzEzkW/isq7wOEStuxCYTkZSuEMJUpGNhcioeQKuRu2RZ0Sx6pm+BN5b/vd47UbbftcJvULjvlB0LSko7O/XxHrb7p2KlystTWnGSdg85YlX9Yc1xMcztT6lT9WSlfnlVFId2ss93xKq2cLmedg8ubzoVX7siaUn0pD6tygmcdnZkDo/LiwCmZda5ur7Y7pRx7GgLZpKYrXumRSmdprsRraeRYFcqUHUzOlE+dnhI7YOZ8or1wgQdxrfMcf5ROq89KSOEDU8KOhAFpVZOO831XnE+Uw0z8K6+tSAOnlcxF5ZUXI+tEOVHiQ1ygsgSPPoipLCf44WShSuUORJ8JCcjtwCStdQJs0dI3biwOs0KbbaGNuJ7odCJS6ZXAGKh7/FfIWSNBi2cJaVp8y+nU2c8ybwQQ0ns9NioTpcVasFTqtMqlEzJNbQVeCtadE8MZRjHZjImPciKboQde6KwrButlkGaZ1LIg7zuFet+BJLbKMzFUgnjUGXiSfq32IEClaDeQZ4vFBTyZ973W0G9LFTS01oRBGiW8rVyqHvqtlmKJYd+FUzbG8uyWmlyHrIgh9UWCqMIDmfZ3ssGOTJ7t9lXSV3tZ8qz/bDd5PMgGajBId/p7+1hgQAmzW1J1Vv1SQa3QJCJBPLy4OHmxtVaOZTuRy11PbBGEigqAooaKTFf7Nux1MVe9NmBDsg9ok+lUlkGXi7YkJRDH2inEcOkqhUhNJ6qQnYObTjmbkkge1M0YM8FFIUs8qSqdiYd61PhD489bnVsKXaf81BoEC5EZ7OzQf21NtIK69vPGtMOPKi2JOY49RDjWw81zkgLrex89EblZ5TWsJNM6Sk+lDiyEECEZm5mmKoZqvYXCEMdaXHeHl1nD0Ri8zIf4edTygEdBRY3P3ZJuiMUf56Ved5+8TBU8A7b9QVbisvvkxMxrxxG5/o+ytMRKal32U5yAFQQnB/7d5ez2lubtrvPro1xTcB07h5BNxKkqK0eZWIcorz19aDMOYG2Q95Bo78/VM1VKnR/ZTK0L4TazL7VRydhJTRwqZjnFwph6ycKFRREMJOtExfO6rRQJTXT74jmSTVSUOIrCkDqdTD+B1kn2bYYujMZ6US9Brmyq7Zpt1Z6Sw6c7+4Pd0dNdKQdI0HtPhvsj+fjxzv6T/X3avVDek2kX9pbOydnK1r8po5xORW5TWOTfUAiQCHTPDPDmWKJLVfhv24BpfIf+yYXD3EbMyK8gxLGNavf86K3Y3RO5NOOKn8vxkhJMcnFG9afKczmkR5TGIXkg/MbpsTbrWFEIHoJXL45fHl68OseT0+N/XRyf4TeitYKpDk1dRyxH3MReM8dRgGvUda9yTlFd8ShSfQSBpPGLEyME8jPEYAHfGskqL7Ei7r5mxSJpMXKxDNahFOEZ6lFXdbdREj3VzRJAZAggklESoOmPDtNUTcvkVdTkI0ACmSm31UXlyjQJCQjFKMQz+AJmkRkBloglRhVCWTEKsVWJhANQpdq2mKuybY15Tnm1aBQKDnD+bT85TBl9spiLUdh4S2SxrvNZ1Fybu/MFpbFKZ6aUKaRAjpxBjYAFKTITZNPI4jEdkbk8Eo+p5zUZazFVcrp7HZh5UVoeS2XlvyPu3uZIPwmL1gx8VjH4PKGXGgjKuZliRsIgic2LG3wZdVEHvhhplWeb2N3E7iZ2vzN2lwdPI5qPowx9+qvQ58JINPPWcfFcgT6OvcegIY2TGN5EQ25TcxYh0u/vzhHYn5Sh+erLlHqTe8RHoZSvMH/Y2CM8HxL8aIzVsgUxyHoMEoyQiVR2wHzPOWZFBVU9Xt3tpXVDDQc1ayAiA9KZrfj8wVXGECfSb4vMKm8elGIiP3OHCH5DBqRdTZZMrTb32TRtkOQGSW6q0aYabZDkBkluYncTu/eNJBuuOFoiTopHwMHT4jifxApMEPW5smhCjk21jFaImGgwVqeNHDrDQX/YH+2lajeTu9nTx/ujQfp0IJ/s9ff6w93BXmex1l/O47gJsnZMLdg72JFVDBD3GTiuMnAuX1qbtY//oF6nRvw6qZxDYtgOAO72qsGOg/1V7HhuLb37mtUIybcwpJnriHIa5hY0d/HFiBRj5EUjkKo0+CJX0oUCFUevCHJdaA5ekgJ03Sw5HJUQJQRK7WTNLtqkeQUOORPkllCzhWNpCKlGhPlAgRHsGNn5HtFpNNFfQvLilCR+RRKL4y+pUhToDXJ/su589wTMO8oRZ8HAdxz0hm5HGjgAGoKQsxrcucHnG3y+qfGbGv/3qPEbfL6J3U3s/n/G7g/g84iG7sbnmPDd+BxzuzuiwVIvybn+6zCdQyVywO4tbMqXY7I5BmdcAVeKN9z4zhBdWOv0Fi8cJDW87kX19G5atwxu+QIc4cXAauVykJiU5dQf9Ho3sCAsd9uVU92tbwcZe91NbdEbQm1rMhJdHQjRRxPE4duT2HF0WedOk1uHHMjEgwVYSnJgWIJPi79KmW40kWlntkLWYzLbAiEQXYwfg8Up+osHnmd32aVW5INcFy6//euyBEJ3yLJOfV/dDfMFOF0SkUS4mt9XPCMwHnZfubU4LzDUwA1WNntD0wbiuZIOnUJ4p/Hw93fnW2JMEJRTQMWX75SmngFB9BYuwinusD7fp0VcdZytxhNm/LD1BoVCSoxyCCzemzOlxOVJVMIfyP2nSNasUlqkOD/QqquHtXUy9VnlVBa7c02S4+nM9KChnmyt2+ISyL2CNuE+GJ5235tEvNCUmTSVcpoTReTWT1xOa7nkglw/y8Q/ampJoJYwNb+1xEVQ7WUabuSkiGsiIXPP2vrpzQO9ZIEeNVZ4QlSXeSBNRD7a773S2mo/zUeLXkL02ny8N+/4OmZ7mQjprL6YeSLSibVe/VMIch0Kg8txhSj6abb4DmjCEZEMdhZYSsKWiU6AFpm/VwgME5xJDqlaM1ixwHEmCyH5gS2LmP+AXjoTH1oy8+NLFFWamdnU/zTPtGFCGyYhB/jIf6hZ5Fh0+xEycB4IDnA0tz9ngsjoQt4LtNZmdSbf4zVUGlKwylT89CD8cTBPcPE3wQM0u5mDNExgu3kTyHfdAi0qXC1l1ccEyxpc5Te3qJdLegv8NsdUVEN/NXlJ4sP5acobk8/uO0vfkUl+nbz7P8p4m0zzd8w0Ef6Su/G2sU9YdPLnEa+tnu55vmuOnxj14Qo6kDb6mHCLn1DMIqFpLkvyao7qdMIfajg1VbIk7LdNnmULjkS08BT+ygdCY4c5CFsPTCqHOgc9Prmud5YcMAFYkl3pb19xc0J7pRP0maor3qFVMynMQm0a3b3A2Ecb+7UzWOYtGVa8qI0N0FUUlaFb/GC7KoSES33DIzLt0yokLnRtRtW6sAz9mlV1FJOrkQhdblhc4d+M6MgZ3eyC4b+xF+zu43kzVE9WjF8pzAU5VTl7Js1rw/Zv0Ya3JROVT6lRRNYFAFMLO7w+OV+hCGIm3MXuWjfuxUW+R3NBhNqj4D6Pu/3uTsLtAl1St75Ea7tA/DdVirP5ZyCtbwnqtyLLPnkzP3bffB60+Tzoez4PiriBrNub0uEleWMVGtBwDHDZWXsMQJm2+fLtoP1JEHrLCRya1t7c0NkXtca39Biz6GDl8mre9fJpAQKOfs86ByOUAPUVv354Gr/l2WKz/GpfGq3VZ31kbGbz06IOfv2k6JCprbvbKywIB4KsmTAnHBkurF55qUYNfXOM89sxZSZ5BzaMv8AKqH7/AfzxBZ0= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-non-employee-request.api.mdx b/docs/api/beta/get-non-employee-request.api.mdx new file mode 100644 index 000000000..3332993cc --- /dev/null +++ b/docs/api/beta/get-non-employee-request.api.mdx @@ -0,0 +1,107 @@ +--- +id: get-non-employee-request +sidebar_label: Get a Non-Employee Request +hide_title: true +hide_table_of_contents: true +api: eJztXGtz2kgW/Std7IdJUhZGPGzDl12CsYcZYljAcWU9KU8jNdAZIbF6JGFd/u97bncLJMCPOJlXilQqgVb37XPf9zaSbgvBQoQ8loHfcQuNwlTEF4Hfni+8YCnEQPw3EVFcOChEwklCGS8LjevbwmUkwlbgx+Jz3EziGcYK0vUbvvDmjVBwt/D+7v1BIebTiC6BnpUSZF05Ec7S8QR7w30+FXPhxwVMdkXkhHJBOIBiNJMRA5SIceZjuUiXhxpQEYgWPORzEYswUpgkrVtwoDko+LiAb9LFZ/GZYzF9LTt1+6R0Mj4SE9utVkTJxqcxLzmielyql6qFTRQ54GZnJl324vKyc/oS02lMhgJyi8NEQEjOTMx5oXFbiJcL2jKKQ+lPC3ckjlBEi8CPRETXy6US/feE/YLxB+Eohh2SOKSFdXyx8KSjtHb4IaLFt5nNuef1JkooBoamQTILSdux1CAgny2oB4VJEM45dikQlw/LJAqS0BEQSTEnaF6qlCpHJ2WrJqrcqlYnx9bYdcrWkSOObLtcq9Ydu3AHcanlnZ0o8rsO9UYdl/EoChzJY+GyTzKesZgsJWcimmpxl+prRydOrVx3jqD6E8fhR5N6ybErdoXQaKN5IhKa/EwsAxFz6dGOOcpP3Dgz+Mz9twnBPuGtMlaXM96vZ3ZlLID2MWPijhMkfnzxJCmauALg0oVJI64ws15JNg/4k/Q8yefFaA4mSW4TGUZP3Chrrj9ETK3cscWV3oKIe/yZtGnhDtLDFDWcE2r/Uqpq1QPy+JcZLzqBgr+YBf6XY1er8rvUVn+I7FwF6/BxwqOZWKmyc8qCCSL4R+7JjKbjgCF/fCT/2TZZgDF75eF84ADoBkJ56qaJZmDtQ90+1H1tqCu4POa7bIq7riQq3OvnrGsj22/y04xxYZzEgo29YHw45lMGy9sobYq0Dnk9DOAunVjMo+0CoSupIIBLmWkMeOeKVjxbVQzAafDwMORLfJUptd/ZR/KwtqovW1ROTsaWLWo1qzoucYuPa451Uj+e2OVS1a7VnbUIdKjZTBoTEQofCkUEIYYzRtExwWXN/D1M6qvbbAo/mVOx2my1epcXo5tWbzBod5ujTu8Cny/OOueYhIvt4fCmP+iddbrt9cCg/e/L9nB00+zj0ttmV18hOvSp3+92WooSvrWab/rNznn24w2IjdoDGmkPRp2zzOTu5dBc6V1ctFuj3uBm2Pqx/aaJofbFqDPqtt+01S7nvbftwUXzotW+OR/0LvsY6pyqKe8yHzPQV0MGPIa6nbN2612r274ZjpojmtRvDodXvcHpTb8HHojSoKdWDy7Vf8Ne5tKwdzlo0eioea7/vQEn7fPe4J36OvwZew0vu7TVoN3vDUbr70TobafXTTlP1dBsjTpvNQ/A8bNmbatdaPqM9Gf6GPIQMg9ScURfTke9iEXJYhGEaQCRvpqSms1F8IlJfxIihYeJEyfhRiDJiDINHqdxMCIbgsnudpw8xHSnTbeoITyX7JpbKU9OEKG5XTuxTQiv1NyyyAWslMjKE67ACpIKuc03LL9yAGNqt8zVbIgaxjxOdkS/jCspb2ifKnX/BOtVH/vti9POBRnIRY8MoHn6TvkCLLfbxYwt5bZBDrFtgf6JsPpTpbldXeE6AEUa3FpyzTzqDB+90M3VNdhtjIEtE0tJB2p+RkL2HbVm87lpzR6WvJm4DuKgReVV4MqJFA8HYGQlYcVS6SdP9Wom/GwKYJ+4qUdTwhs1QsmuW6UTq1wZ2SeNWrlRqxfto/J/CIqDBj7+tkgMyYcwVEuNSq14fEwYdmfoZiY1vuaRdozvxRifYz9mH21AGIdYadIpRP1NlacpC2+ZWuyWIsslq1SxytWRbTfwt2oX7Qp0W2uUSqr2jXkYfwWsXI2hxaxkoOgyWncvoFKpof6uwQjf/R2ggOpuILYCUtsB5A93+Ue09Mf5/YNA1FHZDvdPTyIxAWCru47PWp4kXbTDEAWxxdB8JKFPOW6SQzYOXGThCPle9aVfdLL2cG3pqnanFbhPSMFn0hfWNOSSEAoF2cFCRh4mXQos8yCk1oVIphWNmpcXJyRRtNlr7jIjIdYyzFAYDbnzG2g9pe+89CXWs3QJnXOmjcWObcWx4OOjUr1cnRxVOS+fVO3j2rg+4ZVKqV6r15WFiyhCI58Ny2lHkt/6XPgilA7zAgca+R8EAsOB7BUAtfnTmxhF4wnyp3MKPXfFpsHL6Fj7AN3Z61afVY/hVP40UeN8uiEE37ocYsRPPI+PaYiOgekMSRHuhXIqd7a7aVI6bZ8103rYFOFEa1d9K32XzBJQYQszlKvxmgHytUh4EAecjb0yVF+BIe5H2YlSf4uWETVorpjwxIuxwuy+Y0WWNJuEwTznSo7+DYC9kEVRPGBjGkOkcGZsjAztskDHhFdNxxGL2OoaSb5iM8FRRb0ssuaqo6ZTIhDF+iUIMbTa5LqawCShklwV7kGCGjWI5WarvxZlXhvrYNLNKoWcA8gft5MmugGAU2xmvXBlLQai0Q8wa8nl0Y02ImO09GPugAvuIa86QRhCwmwM3mQcMROOSF0RAo+fzltFrGyJpMLdGw0GPYm65vAkeoLf9T2EH0uxtrrwURjni6jL1tFIaSNVk4lIpgVXi82slbpSx2dIQ56799297+5994m+u3lxYH40NFdV6WNvlz6XPk8g31Alz63SJ1TW4wcsnaSPSbQiD9DRpiXST1cjOPZvKOUwX3xe0G+b37A+0ql8C3xzpQ89Pk7bqjT1r3VBAJUcNQcTRCLhNhTuNWIlKC2qyvZuZ0E4ljBQf0eJiKgZsmWQMA6RhYnvExIeHTA3EJH/Q8xm/KP6eQN4dQSkXX3XWgTS/7LfaPeV5L6S3GejfTb6S2ejfSW599297/49fffBSnKFSnmLqZOiZD7n4VJbmrmub+DABJbevsZWLqdUtVmtEDG2qrEK+cqhMC7bY3ty7Iiqy6vuUaU+KTtHZV47to/tcbV8XMjm+uu1H6+cLO9TGX1rPSoRq5tLQpb4MK4oDgI3f/wH8YZiQmGNQs+qbobMIdL369qxuusGvRi8gTBqx/Ce48XLQZfoY2tFnuSm70Igp1Wiw3Qeq5KSbBiSlupH+33puC8d9+lnn36+j/SzLx33vrv33b+n735R6Vh9rHSsfkHpWGVUYk2oxPozS0cXdQeVZhMoBTw4CcTrx+v7Pszpo3H7mIdTEa8KvVwVWa5vV5GjIKCHX5ZpsRTlTiL9tbgovGHunOaG6VxM4GyKEOkzRC2J6pasSs4F1aSwH+bJuVR+TAyBbri0mpMYXGmfSe1ttYv0HS8BQhUUvIDOXgPYmIQ5iQmVf6CgzkGnCNTf8IzTaOurzoPZgDjuEses/dkRgnx+df5b23WXQAfgQwoXQ63re24X0Gfm3EcbIT4vdPhalaD7Un1fqu/T/T7dfx/pfl+q731377t/T9/9glLdVEP3l+qY8ORSHXOLJbaqpc7IuP7wil25ikGgzJsFjqrV3XUNruoKmJJ5tp1iCD0j3igcZm/attLy+vBWuncFetydikONKwk9zJ/F8SJqHB7eQl1Q012RL2QxfXzCDz7RA5iHY8hoR/ihu021q9EE1ux3TKdRVAIOJdmwDniKuBa3YomsFWJXNxg8SFk9pgc9LtGEME3mgB6BMfakhulebjQTP0TmOVUSzxZ/4Osy9O6+nhdN6B5edonvwd0wnwHpBovmhuH07QRDqrz17lvvKFhnEzrzL29t1qNpZfZa8BBtgb4N5sVPV6OXbEr1pvL3JKJSV0hqEOAxfZiIimfN9JYQWqRSTBgk05kC3szddEP+wyYeGGa/+EMh2HX2GaQBIrMSKS0SKhjQqvcvUu244qPwKAcW15Ikw5OufwgJHfLcupcq36nGQPr6Lm6MFn/xLXYqKQxJyts0x7Co+jx2vUj54hm+ngviHyk1S1OzFLXo5QYKLdprR9/E7cCJiQT3IiWtZ2+u6VkZetRFYYSobmIgSRgc+VulnFRrz8aRo2cRvTyOX/yrmUQyzS9jOnaxCLnQc1mHObMgiMQ/GSPTITe4nibwomfD+kSbWsojrHIpA8nSW1rSQmmo8HXhGL42Jj6m1Kwqk0AfkiiX/FVpFj7/Kxpnl/2a41kNXyOD0kw3cKJnY6YNLdrQ0jEgMvh1giLDgm8TDyoOaANorfWvIoEBmol7mtbOqK7IH6o1lBocQFVUokVDf2msA5z5xNQFmr2agzBMlfXq5jF8Z4aWepQpK6z0TGBTgtt4vQDJcUNuGu/ql01KmH81fonj5vropOd7y28dpe+JJH+duPsnRbx9pPkeI42pdcnc1LYbTwyTkb829dr2UR6dNc8E/sVV5auqrEbTkr5sIf+k9MLjMVm18mpnJoU6BFgIHlPtd0CWFcyVJ6JfJ/dHq6cITdUDYSEgc7Rt0gM9dUyd7syVw+jCkvRK36PE3DQRwCTRVIoiu0Jf5jtQC/VkdLsurn0ITHM2hGb6pFh2miobRdd8nvj0mDNgJ3PGYVKPWIQrIyfRgQstmi9SWQSq9FutSr2YTI1YKKruJJxHvQmdL0t6N0nhiXtB75E5XIboSYvmPVZrRgbCU5ZJ8/Jl+2O0YW3WTHgL9YobwEKPl9nhTWe0RRHEfPOLRhBOD82i6JDmggi1R9p8KkW7WLJUu0AvoAmiGH1shvi5iFFU5h6dXL9XbOPFIKuT9Se9AsykCqrxDxd0OEUAEt1z6DbvurCzzcPahnTp8d4Z4NK021s6xqDG546GMY165Ov3655G9YIQJ31GNzmBg4sH8L8YmJeDvWSPvkdsJx/pUZy/XHfhBXz8TVDzDvRocYFfna4obPqCPn/JLNn6hYIaplVPfN4mzfN7cq/5ADkguvwfMiD0ng== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get a Non-Employee Request

+ + + + + +This gets a non-employee request. + +## Request + +

Path Parameters

+ +Non-Employee request object. + +
Schema
    nonEmployeeSource object
    data object
    + +Attribute blob/bag for a non-employee. + +
    approvalItems object[]
    + +List of approval item for the request + +
  • Array [
    • approver object
    + +Reference to the associated Identity + +
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-non-employee-schema-attribute.api.mdx b/docs/api/beta/get-non-employee-schema-attribute.api.mdx new file mode 100644 index 000000000..be672bbf5 --- /dev/null +++ b/docs/api/beta/get-non-employee-schema-attribute.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-non-employee-schema-attribute +sidebar_label: Get Schema Attribute Non-Employee Source +hide_title: true +hide_table_of_contents: true +api: eJztW1tz27gV/isY9mGTjChL8l0vHSV2Uu04l9rypK3jmYVISEKWArQAmUT1+L/3OwBIURdf6uy2uzt6SWQROOc793Mg8CbSM2F4LrXqp1E3Gov8nVan01mm50JcJBMx5b08N3JY5CJqRFYkhZH5POpe3USXVphXWuXiW94r8gm+i2Squkpk064RPI2ub68bUc7Hlh6BblwSZmdyJJJ5kgn2lis+FlOh8giLU2ETI2eEB2gGE2lZ70OfAZZlnFmHh/ESEBvOWT9lI21YPhHMzkQiR1KkbInXhS5MIvppE/hn3PCpyIWxTgJJXGYc2BuR+MaxQ+CLTnLcPmod7R/tdcTBMRet9tHebiftdJJk2Gl3RlisQAUrKyRQHpTj4EXdmyifz+ixxVM1jm4bkRG/FNIIqDg3hViXEyi9bJWySbBnl5f9k+fY//1IbVDCd8N0dJhMI7KtEXamlRWWqHVaLfrvYdGAISG3gcmxns9mmUycC+58trTppiahTBt2bnMxbUx16ozbSOBbOf4n9I2MD0XWyEUyUSCSvYO0jYnIZgM4ZWOW8URMdJYK0yhF+6Q2qUAPP4skJwcxFBC59CJBzDU1NSL425QDe0TmWbIHT9rtVqu1Hx+29w/idnu/FR+1D9vx/rBz3BG7otU62otW1brB8mQLL3aN/1DrTHC1tn8AUzE5QgggWtZCBN9NuUp5rs2cacV4ljGF8BAhPLDFmdQ265KQ+YGh1Pm9WgBtEedyKtaQfZwI5SNzFdVXblnGbc5KDs1lv261j+PWUdzZHbSPuvud7v5xs33Q+RfpJZj/N4EUaN8HZq/V3d1vHh56MB7BOhKhiiklvcHpPwb486Q3OMV//ZPTd4P+4J/rme4U65kRMwQUwgI0HEaiyvSIQRy+Kf3xJBGz3Fkul7kDe3f2HhBEQHYRswnzMqIzWsZSaRFEc6RU7dV22Q/pdoOvLautlyS6UDmjkHSqqsfow/wpcVRbGGUx0gRBWPBjbwu40FCwQslfEASI3ODNzZWwdFCaKkApE8TDKGglowJX0wSKzmV/mQGBDRhkSgaES5uqLgX2xLmWkR5m/jcJ9Tnm+YTnbCSzzJIBhvrbMvtTJFMDBwkQCtRlr7HKVKUGlpP8g6mlD41TIdgcMaBb0nKc1lOLDLHmbLKWX5awXHksq35S+uv1Y1w8ur0lonubCtGrTMIw7NQYII3ZucgLowBceqciIIKcSadzEkyqLzyTLhM8UKseW0tSkXOZvdLpI5z/tVQiHhsuCaFwkBNsZKD4RaaUHqbaCOZJlnHh1i07BjTRbLOXPIW8Xr5XQRgKSMOTn0GrvzGXLgO69J5VboGXV969ga04FHx40Dru7I0O9jjvHO21D/eHxyO+u9s63j8+Ju5TYS0aP1vjzY3h8zXWb4QSRiYs0/AJ+W8oBEkauncAHHNskSiV9mEbOBqPTD5+bSVmwOvisYFYe/nqA9s7RBFT48J9z8crSlDx5QU1YEUGF64VVU/4vZFjqe6rHSenr3uXZ1Q+zk//fnl6gU9Ea6129BS8NSW3BFT4wkR/dYiDAFTXrMigDhQ29iJQfQGBuLL1hdL/5fsO+NaIF1mOHYH7hh110mxk9HQplBI/GrBnsimaDaRpKvc8TyZsyO2iorzouSoWnwVNvmATzA7CPG+yXppKEhIFANEIotg/p3zP05RC1xMYFQhlgJH5RBc5MlAuVwvAQpXL1lgklbO6UVy1ekx56CV5AXBOzHoUVt4SIAb7ALPX3Hr1KJXmVDpXOU9yyoHZHGo0BhpmSHBMYgwK6YjMZZF4VLmuyliUAkuxXLp768Gc5No9S3hhHxF3HzKkn9jXvvLBFxGCD26gQzZy1ijNFDISHrr+hTaHVZW5ysBHPRNZuo3dbexuY/eRsbv68DyM3+Gpa33a663PpeIF9Gtc8VxrfYzzHqVZuci1N8GQDQaFhBbpx48DBPbPmJ+wXnybUd/2K/ZHvpSvge9V9vDfD8vhqCz9C1sQQKdHL8EImUikXYd7gdgpyqtqd53ba22GEg6qNrSIrq2e64JxqMwUShESbhss1cKqH3I24V/8TGatz4DEVaXxTEtqvbed5LaT3FajbTX6s1SjbSe5jd1t7P4xY/feTrJC5aIl9Em2mE65mXtPC89JWs6wgJU/BLEq5JypVrsVIsaqHita7hyiYac9bI8OE7GX8r30YPd41EkOOnz/sH3YHu51DqN6rb9axHEVZMsxVbO3t6NTMZq4L+jjCgXnsrnW6fLxH9RrxIjSGqWeqm+GzqHS66p37Bxv+KlLa/o1c152SHaph1QLHVFOw9oprTXlWizgbIy8qOgYWwIXuZKcClAxcBqWyal0wUtSgK6Zx70Rnfv6QCmdrOIiVZIVQOgyQaapa9ZwLEkH5iPq+UDBdbBjZOdfsTsNJvquTp6dk8RnJDE7/ZYIQYFede77m853+3QGTjniwhv4joNeP+1wBQfAQOBzVtV3bvvzbX++rfHbGv/nqPHb/nwbu9vY/WPG7n/Rn4du6O7+HAse3Z9jbbPFql7qNTnX/7xNd6ESEDj3ZjpJCuOOm8se3PUVcKVwaZFyCF2O60Y79RsIcbjbtHNT3n+73fFdXFxdY8DD2jW+24guOVIH6cEXJgPRSZ7PbHdn5wY2hS1vm3wmm/6mRz5X+msz0dOdIRS5IUfRZQIfj7TAXWf0DJrOCkaSo/us6Ih7mzi5yaVhG3d+fC/l8nrMHFIyT6ZBt4eC07mvAXGGieMH61Y3nZOtyQe5Lk12+/2yeEJ3yLJJffdyw3oGpCsikgjXizup7jKI5752M3VRcmik66wxe0/LOuyl4Aazg/+V49mPHwfP2ZiaUpcUCkv9sJA0RSCsPsBFXNLrlSf+tMnVIaOL8cQB7y39pkJBxkYZBGaf1IUQ7KoflPAO1eAc6duplDYJlzFo1/Wz0jqp+CIyKpTNhSbJ8WSqdqChHb6077krim56kMrfjMO3zU8qZieScpWk4k5rgohuGGRXs1IuXpPrqSD+UlKLPbXYUbPPV1B41V4l/o5OgkgnEjyzTltPZu7pxTV6NGrhG6K6ioE0EXAs/xKWlFZ7Mo4lejHRW8bxSX2cSFTc5W3MJzhmUTCzlPVZMtHair8yRq5DYXA1LhBFT4b1lZjGLiLiTqsGKfYsYxmjf3T4zhAYyjsTH1L9du2LRmenUh+SPznLIuZ/wnSdsp+WZHZfX6HM0spUJ/bJmIlhTAxjnwNswO+rGDkWYptkcHnAO8Crhf1dJghAa3nP09qY1R35HbeHSkMCqI6KnXX9H91FggufmHtAq6s1SMORu4cYfhukq3KBFpWyJWWVBwerGlzHm2lU0BW9ebzVwRVV1d+bvCRxb3G+8l5l8187S9+RSX4/eff/lPG2mebPmGlCQ0zu5tiGyaHu5C9Dv7Z+3kcH0hOBf/HUxarrvTHZuFnNdTF1QrOM5+TVLqqTiRTupGAmeE69X4M8S09dJGKop/DHPOgIjd3degPIHLOdzEDPnWWXnLkLGN9Ykl3pb1u4cYV4JRNMnqLJPmJ4UwnMQoMb3cbAs886THAXsMwHMiw7KY2Npms6LRS4UVwWU8bhUg94RCptUvjEhTlOiVIX2rV+1a4yisnVSAR3D1+YqX0/okNozLc1wz/AC3a34QQaqicrhhd3FoKci8x5Jq1bbtsfog1vi+kmu7v+D1gYBGsc3vYHaxRBTIWb9NqMd8Imu0NrQYTGI+8+u812sxW7cYGut2ubY9itEX8j8vVXmza8nrXqlzeLw/jf4DWwUGZoPtiZ0ekXgS/8vOLnyKto0xyJrd21N6lqoyQ9r78ThulkApUQuZsbOk+h4eqWvv6lEDSsX10v5iY3b8Jk9Blj7QhJZPUVrLpWnp2Hu/PP3S9C97w/doe85Zmgmi+OAyJ8/FnQKUJdDBoUnw6semPsSTgqdWPypzc3uHt1Apryj/2xVG3j2g83NCJWRwVvTsnX+R3dRvgAqyCf/gckou/W +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

+ +The Schema Attribute + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-non-employee-source-schema-attributes.api.mdx b/docs/api/beta/get-non-employee-source-schema-attributes.api.mdx new file mode 100644 index 000000000..e352de9f4 --- /dev/null +++ b/docs/api/beta/get-non-employee-source-schema-attributes.api.mdx @@ -0,0 +1,95 @@ +--- +id: get-non-employee-source-schema-attributes +sidebar_label: List Schema Attributes Non-Employee Source +hide_title: true +hide_table_of_contents: true +api: eJztXFtzGjkW/isq9mGSlBsDxteXLZI4s0w5l3VwZXc9rhrRLUAzjURa3bFZl//7fudIDd2AYyczO5cUDzPB3dLRuZ/vCInbhp2pTObamn7SOGmMVf7GmtPpLLVzpd7bIovV+3iiprKX55keFrlyjZ2GU3GR6XzeOLm8bVw4lb2wJlc3ea/IJ3h2dXe108jl2OFzA/SikqA40yMVz+NUidfSyLGaKpM3MDhRLs70jPgAF4OJdqL3ri/AjhP5RIlUu1zYkXDMi5ALZsTIZjzCzVSsR1oloragF6GfNMVgojIlJP47ElNpEpnbbF6lJJMEs3MrlIwnwqjrTZSELHI7hcJimabzpugliSauZTrfEQU0IWJpiJQoZkSr3RJx4TClshLxAgE1VJaNJGhmKi8yAw7SlGXZyN7Ipqm9BodDPDbzTWR7uZhal+8IiaVzmZLG2kdVItcaSwzLFVXShDFnMpNTBV4cm1OTBWYShtxpqBsJ8RUedOLj9lHraP+o21EHx1K12kfdvU7S6cTxsNPujDDYgApGuqBxchO2VuPktpHPZ/wOjJhx426nkamPhc4UfC7PCrXuAAt966RB3pQpN7PGwftArdNq0T/1Ob2Fk3iHFTWPjclB4WuYJmezFOajabs/O5p7u86pzDI5r2rgcvFqcPqvAd6kcqjSpUxweBVPDPnFm6CI8sVEpbMBoqP6bJbC8BObJiqrPq6rhQTXuZq6CmN2+LOKc6KQUejm2qsEalpT804DwQFfxZOLi/7Lmj1l3G63Wq396LC9fxC12/ut6Kh92I72h53jjtpTrdZRt7FqllXFClgZtnRzByYr6w+tTZU0a/MHkEnoEXwc7r8aygLPlo5vDUeDQQSqEIGYwi7hmlVJWE87jalNOPo/qwXQVlGuYZ1Vzj5MlPFpZJWra+lEKh1Fll+hWY+LVvs4ah1Fnb1B++hkv3Oyf9xsH3T+Q3qJM4UF/z8sBdqfY6bbOtnbbx4eemY8B+ucKFNMKU0Hr37ZG5zin/7L0zeD/uDf67n5FOORPmYISMQTaDCPRJVCD+KA03WWZRyrWc6Wy3XOzFbrTL3CDIjFu0WErfNc5+iMholEO8TUHPnRerVd9ENt2OBrdbX14tgWJhcct3drgfzQ+pSsFlMEZUHSBLGwXE+8RramxFsY/RFBgMgN3txcCUtmpWkCK8vU8RAXNFJQDa5oApXiol9fgJgNPOiEDAiXzhZFNCxPK9cS1EOL/wO1zC+eT2QuRqgyjgwwtDf15U+p5sFBAgtcMFljC1OVGqgXiQdTSx8ap0KyOWJAt6TFK62nFh1ijW2yll9qvFx6Xlb9pPTXq8e4OEk3lTd9n9zbR3d3tEZ3U117kWrYSZxmGRiPxHmo3D6PKpZLkW/ZZC4YVXySqebE8KU1757Skqhc6vSFTR4RC6+0UdE4k5o4VMxyjIkCFD/phLLF1AKBeZJlmPC4up9AE822eC4TyOvlexGEofjMZPwLaPU3ptY6Qxfe0copcPqFs29YVh0qOTxoHXe6o4OulJ2jbvtwf3g8knt7reP942M2m3IOyNVtAAv1pb9XRmU6FqmFi+j/QiHI2dA9M8CLNx5d3pnGI3ORH7sQM/DL4UnI8PmLd6J7iJpmxgU/l+MVJZjo4j3huSKFR1dqrCf8NtNjbT5XSl6evupdnFE1OT/958Xpe3wiWmulpGfgrQm5JViFL0zstQf7XgAqc06lUAfqnHgWqD6DQNK46kDt//IwBL41kkWaY0ZYfcOMKmkxygCjq6EU+2ZGPNFN1dxB1qbqL3M0BUPplgXmWY+LWnQWNPlMTJREunxa7QoEohFEMX9O6d/3GCHZjAqEMpjR+cQWORISuoqVerBUZd0ayxxzVjUKF6/HVItenBdgjsWsRuHCWwKLwT7g2WtuvZiUSmOVzk0u49AbQY1ZBg0L5Duh0ceFdETmckg8phy3yFiUAkuxON299sy8zC2/i2XhHhF371Kkn8iXwvLFJxWCz1FT5rMRW6M0U8hIeMlwhiaHUQtzlYGP8qbSZBu729jdxu4jY3f15Xno5sNbhj7tdehzYWQB/WZcPNegT8beY6woBzG8CYbcEVBIgEg/fBggsH9BO4Xx6mZGMO43xEe+lG/Yjyjt4Z8Py16pLP1LWxCDrEcvwQiZSCUnzPeSY1aUV9Xe+mqvbDbUcFCzASIyyp7bgje/ssIY4kS6HZFY5cx3uZjIT75Fc85nQFrVJNHMakLiWyS5RZLbarStRt9KNdoiyW3sbmP3rxm7n0WSC644WgJOcsV0KrO597TwnqSVAgNE+b2SWIQcm2oVrRAxscBYjTpyaAw77WF7dBirbiK7ycHe8agTH3Tk/mH7sD3sdg4b1Vp/uYzjRZDVY6pib29HVjFA3CfguMLAuVxubVLf/oN6MzWitEapZ4GboXOo9GqJHbvr2PGNzSEbCAM7ZvdsL16cnxF9LM3kSW/++zkKWlad3/olSEk+DE1rl2+h4xY6bsvPtvx8M+VnCx23sbuN3b9m7H4RdOw+BB27XwAdu4Ig1ogg1h8JHRPgDoJmIxgFMsQF1Gvy5WGOsPsYwj6X2VjlC6BXQ5Gd43UUObCWDvXNS7DkajuRZqkuSm8YO6WxWTkWA6QYI0UaOhuhgW7Jq/RUESaF/4hUTzXHMQkEutk86o3oMIGPmdLfFqtoE6cFOOSkkFrae7XwMU2nMEYE/0CB90HHSNS/4R5nsNav2g8W5yTxGUksTm9ipSjmF/u/+5tOCfTpYAWli/fe1vccF/B75tKgjVA3M5++FhB0C9W3UH1b7rfl/tso91uovo3dbez+NWP3C6B6QEP3Q3UMeDRUx9hmSyyw1Ctyrt8dsXOoBA7YvYWNGasnSwzOuAKuFO7sUA6hGxsnjd3qsdYoHJjfvS0vZdztehQXyfp1HsKMnt0io0sNkzyfuZPd3VtYEda7a8qZbvoDw/nc2OtmbKe7Q6huQ1aiQ6g+AmkA3+PxCzRZ75km1/Z5kIl7K7Ck5MSwBp87+Czl8pT1HHIJT2aHDqEHN+PHYHGGHuM7x6Ob7FZr8kGuiyy9+/WyeEL3yLJJfZ9dDeMFOF0RkUS4Wt6+4jPFfvW1O1jLIkNfBXTWFntLwzriuZIZugV/OubJDx8GT8WYYCingcIRAlaa+gYE0ju4CKe5XnlShCZx5clsMZ4w473aWRwKKzFKIbD40bxXSlz2gxLeIP+fI2GzSmmS4hxBs66elNZJ1CeVUmlsLjVJjqcTswsN7cravKdcBrlf0MZfsMDT5o8mEi81ZSdN5ZzGBBG5/ROXs1IuWZHra5n4W0kt8tQipuaernDhVXsZ+7PdMWKbSMjUsba+enFPL6rQo+YKT4jqKg+kicBH/QRVXFrtq/mo0YuIXp2PH82HiUaNrU8TPqUJhxKZJqIv4om1Tv1dCHIdCoPLcYEo+mq2rmnRiCMi6rQqLEV+yUhHQIzM3xkCw3hnkkOq2AxYrN874ZD8iS2LmP8J/XQifqrJzI8vUVhpZGJj99U804IRLRj5HOAC/75ukWMhtkkGzgPeAV4s7c+ZIDBayXue1saszuR3eQ6VhhisMhU3O/F/nCwTXPgk+AWNXoxBGm7wdZZwpoxuXARaVLxqyiq3ClY1uM5valEzV/Tm+V184Ul19M8mL0ncW+6ovDXp/LfO0vdkkj9P3v2DMt4203yLmSZAYHI3Xjb0ClUnfx7w2voOH21BTxT+j7ccq4y20ctwd8YopkpolsqcvJqjOp5oxXsDMyVzwn475YVwRCLaeAp/vmYNQmO+opmBZYluTqegx7vX5cqSA8YDS7Ir/e2KcJbCwiXRa6qm+IB2zcQwC7VqdIoX7362oWd7D8u8I8OKl6WxAbqm08JgNYrLgm6Ii4c8ItEuLnziQudmVKkLy9BvMauMYnI1EoGvc6ps6t6OaNsZHW3F8A+sBbuX97KherJiuD++FORcpeyZNK4O2x+iDW+L6EIk3yIFW2j9Kiu87g/WKIKYCV902Gy8Gya5XRoLItQeeffZa7abrYjbBbolaV2O9rZC/Iwuoa/dQN/0UwKrnnm73IDf/gLC7/oLCKEIU/e0O6PdQDJt4bs531dfNjb11Zh6svZzB9XWGs3aBOzQ/Ntb2lCiXvOOHn8sFO1WXF4t20huv+HB9Bl9/Qg5dfWHEaou8uQ83Eh9yl+JLX8u4R55yj1QM19ufzTw8RdFuyYLMe6u+Nqx5Hu/YMi/9ttflYlrXxBRY7rYkvj+lCJM3oNxwgf6nZC7u/8B6v3rdQ== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-non-employee-source.api.mdx b/docs/api/beta/get-non-employee-source.api.mdx new file mode 100644 index 000000000..e0e0c2b25 --- /dev/null +++ b/docs/api/beta/get-non-employee-source.api.mdx @@ -0,0 +1,91 @@ +--- +id: get-non-employee-source +sidebar_label: Get a Non-Employee Source +hide_title: true +hide_table_of_contents: true +api: eJztW1tzGjkW/isq9mGSlBtzMbbhZYtg7GWGGJZLXLNOyhHdAjTTqBl1dxLW5f++35G6oRuw4/WkdmemeLGhJR2d+/mOUN8XgqXQPJKB6niFRmEmoutAtRdLP1gJMQxi7YrCUSEUbqxltCo0bu8L41DoVqAi8TVqxtEczwrSUw0l/EVDC+4VPj58PCpEfBbSEMg5KT3WlVPhrlxfsHdc8ZlYCBUVMNkToavlktgAE6O5DBk4CRlnCstFujw0/BTB0JJrvhCR0KFhSdKyJQczRwXxlWO+wIOKWy+fl84nZ27lfFKtlUplfOIV4dbO6iXOy5isQAUzLWFoYJsVqwFmRrT4LZZaQE2RjgWU4s7Fghca94VotTRUIi3VrPBA4msRLgMVipDGK6US/cuTzinGMsCCyS/CjUhAlxQM5WAZXy596RobHf8S0tr7zN7c93tTo4SEC0uDdKTJtpG0PEhvl9OjwjTQC45dCuNx52JH+n0sSq+YUzIvVUvV0/OKUxMn3Dk5mZ45E8+tOKeuOC2XK7WTulsuPBxtVLyHi0d0zngYBq7kkfDYFxnNWUSO8YhH7Ji9dnru1ip197RUxieXn07rJbdcLVeJG2v3Z3JCk1/Iy0BEXPq0Y47yMzfOPHzh/ruE4J4IThmZ4Z1Y78pIgNtvORNcUgefTfRtu3VXhhELpmwz5SglxrXmK3zFHoswo4RHNrGju6oSKl5QZmm2Wr3x9eiu1RsM2t3mqNO7xufry84VJmGwPRze9Qe9y063vXkwaP9z3B6O7pp9DL1vdu0I0aFP/X630zKU8K3VfNdvdq6yH+9AbNQe0JP2YNS5zEzujofJSO/6ut0a9QZ3w9Y/2u+aeNS+HnVG3fa7ttnlqve+PbhuXrfad1eD3riPR50LM+XnzMcM6+tHCfN41O1ctls/t7rtu+GoOaJJ/eZweNMbXNz1e5CBKA16ZvVgbP4Ne5mhYW88aNHTUfPK/r2DJO2r3uBn83X4E/Yajru01aDd7w1Gm+9E6H2n100lT83QbI06760M4OMnK9pObm8qRvZLag45SjQXjEwc0peLUS9kYbxcBjr1dKnMlI6HdIgSdB18YVJNNYc/xG4U6y2Pz6gy9fKLKBiRD8Hx92fBPIvpTkh1Oco15JFSueZVK9NzpBJerp2Xk1xTrXkVkYuslMhATIUWyhU3EAXZj+Zw1w1iFdkS+GQM2Ylskc48hNIhlA6hlAmlReDJqRRPYxsPVdOJ5ELs8HczF1YlhO0Egu4LD5kPfbCU8Ba0KJXrTuncqVRH5fNGrdKo1Yvl08q/SB8usG/0fTlJSD7Fw0mpUa0Vz84sD2pTz1uUOYgZFfs+n9BSC1sT5iTwJXLKDiMj8ACvmghNTpQDGFq4gfbgXEAjvp/gjRBc84i9SfgWngNp37AYTUKSt8Ic/5WMOsBDtQI7mn7hMUhC4xDtZB+GbvkSvsHaWgeaOQxoK9YKzi6nOV1OAg8uGMLZP3PfAthn4+unE6tn8F0r8J6BJi+lEs5Mc0kcCsOyi4WMcJL0sAJOpwmrEck0nM28vANAE8Uye8s9yGvlayXCUNBo7v4KWs8B2mMlsZ6lSxCkDKZ5bFtxJvjktFSvnExPTzivnJ+Uz2qT+pRXq6V6rV6n3RciDMnimb3TSpXf+koooaXL/MCFRf4NhcDVoXvDgNn8+cXN0HiG/smz7dy1mAm/jHrZI3Sbb1t9dnKGDKBmsXnOZ1tKUM54SH1jLqgguSXc03Im9+L7tNJetC+baTFIKhDR2pfcpfLILQMTiHPk6mgjAGWHUPhQB9IDe5NQfQOBuAqzE6X9Fq4Qmgv41pTHfoQVye57VmRJs6kOFrlQcm3jz17JoigesQk9QzC7czbhIRYENou9abquWEZON9HkGzYX3BP6dZE1PU+SkNxniEYQxfoVCDHueRS6lsA0pnpkqlYQR8hDkdzubTaq3ElxSS7pZo1CwQHOv+0nTZRCMGfEzEbh2lsSFhP7gGeruTx3o61cHq5UxF1IgdS5gho1sikyE2STUciSdETmCpF4VDpvnbGyBdGku3eWGRRkM+byOHxG3PV9pB/HiLYe+CyS4IMbBEk2MtZIzZRkJAwagEGLk1lrc6WBz1Azfe8Qu4fYPcTuM2N3e3CQnBwmowb6lHehz1jxGPrVpnjuQB9tvEcFLJ1kewRryCMGhSQQ6cebEQL7V4BPzBdfl3TA+R3xkS3lO8w31/awzycEP9bGytmCGDR6tBJMkYmE1zB8bzg2irKqqu7udhnoiYSDqj0Q0eDUVRAzDpXpWCnihIdHzAtEqH6I2JwjP6IRB782A9KuynOWAdDrAUkekOShGh2q0V+nGh2Q5CF2D7H754zdJ5HkmisTLQlOCuPFgutVcphsx80PDwwTWPobNluHnDHVNlohYmyNsQp55FCYVMqT8vTMFSceP/FOq/VpxT2t8NpZ+aw8OamcFbK1/nYTx+sgy8dUxt7WjkbFAHGfgeNiBecKoyDw8sd/UK8WU0prlHrWuBk6h0o/rrFjpb6LHUdBQHcVVilCCnMYUm10RDkNcxc0V6dzMYGzGfKiYkhVEnyRK8mFABUNp2G+XEgTvCQF6OqV05xGEMUGSupk612kcv0YHJpM4AeEmgM4loSQYkqYDxQMgp0hO39HdJqY6HcheTYgibskMWt/dYWgQF8j99q+890OmNeUI4bWwI8c9Npuhys4ABoCm7PWuPOAzw/4/FDjDzX+r1HjD/j8ELuH2P1zxu5/gc8TNPQ4PseEZ+NzzC2W2BpLXZJz/c9hugmVhAPj3ixw3Vib4+YUgxtcAVdKbiJTDqE7vY3CcfYegpNcPDi+T++UPhToirL+nF4HjrWPRfMoWoaN4+N72Ay2eijypSzK5DKJCr4U3WBxPIGi9uQguixg440msGa/k/QYRaNlLcmRbdYzxK3OjVzkstC9OR9+krK5VgpjriAFs2SO6PpO4lTmMVhcoqP4ITSzi8aJduSDXGPtP/x+WSyhR2TZp74nd8N8Bk63REyue6Q3yocEv+3uO/fKNyWFWrbKzmY9mlZhbwXX6A3srxivfrwZvWYzAp0m6OOQ8K6Q1CUgbPpwEZPUmumJPi0ydUYH8WxuGG/mfjOhIGJTHwKzD2ooBLvN3p8aID0bldIiYTICrfr4KrWOJz4LnwphcaNJcjzpqWNo6Jjn1r02Rc90B1LZezJ4WvygHHYhKRdJKt40JxHRNHvsdpnKxTNyvZSJv6XUHEvNMdTC11tcWNXeuvYOjotIJhLcD422Xry5pedk6FErhSdEdZsH0kTCR/6XLje12ov5yNFziF6ejw/qZi5RUfPLmE1gLERB9D3WYe48CELxd8bIdSgMbmcxoujFbH2hTR0TEU6llGHJsVs60gE+NPx1ERjKOhOfUH028CQAclOeDclPxrKI+U/onj32KSezeXyLMkozvcANX8wzbejQho7NAWHCv61S5Fh0SQ4ymDxgHaC1sb/JBAmjmbxnae3N6ob8sVlDpcEFq4ZKuGzYL41Ngks+MTNAs9dzkIYJXq9/+zOX3iwtc403q6z0YGBbg7v8+gEq5JbeLL/rgymqmn80eUni5ub8pKf81ffO0o9kkj9O3v0/ZbxDpvkrZpoE8JK7mW23bjuTk79N8NrueR4dOM8F/mLUxKrB1uhc0peD8re8lz6PyKtNVLtzKcxJwFLwiLDfEXlWsDCRiKadwh/9niE0MzeQNVjm6N2kD3rmrDrdmZuAscCS7Erfw9i0I7SXO0dnKYrsBs2ZcmEWaszotgXGfgmSDm0Iy/TJsOwiNTZA12IRK7o5DrbjBeNwqW94hCdDN7aJC32aEqkuAgP91qvSKCZXIxGKpkXRi7A3pUNm9K8Zw39jL9g9TE6YoXpz2dq+T7gRZCB845k0Lw/bv0Ub3ubMhb+k1hBZFwBMZHZ41xntUAQxlbwEFujZcbIoPKa5IELtkXWfarFcLDmmXcDzZRBGaGYzxK9EBFCZe/tv/Sro1nts69P157y1mRQKQvjHSzqfou1j23HYTu+2sK/Tw9LG+v1BNA9zcExz7+/pOIN6nwd6jDaeeuXbj5u2xrSD0Ch9Rlc5RYyLJ2R4NUje8XzNsm9+7uU7PX1Tq03jXcDHXwX162t20duCYXOsYpixw/bgJbNw56cJapLWzfBVm6zNH6m3yQcIjozyHxXUnHM= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get a Non-Employee Source

+ + + + + +This gets a non-employee source. + +## Request + +

Path Parameters

+ +Non-Employee source object. + +
Schema
    approvers object[]
    + +List of approvers + +
  • Array [
  • ]
    • accountManagers object[]
    + +List of account managers + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-notification-preference.api.mdx b/docs/api/beta/get-notification-preference.api.mdx new file mode 100644 index 000000000..7d016d278 --- /dev/null +++ b/docs/api/beta/get-notification-preference.api.mdx @@ -0,0 +1,95 @@ +--- +id: get-notification-preference +sidebar_label: Get Notification Preferences for tenant. +hide_title: true +hide_table_of_contents: true +api: eJztW2tT2zwW/isa74deBocQQlnyZSeltMu70LJcpjNLO61iK4laR/Ir2S1Zhv++z5Fk5wr0Ntu3HX+BxJaOzv08R5GuI50Lwwup1WEa9aKRKF7qQg5l4p6dGDEURqhERBtRwUc26l1G8wNs9HYjSoVNjMzpO0iciqI0yrJiLJiaG8rymphlQ21YIRRXRYsxEBQYzgsmh27aRzFlqRZWPSiYuJK22KDHinHWbXfZZ5llbCCYcQuJtAXerEhKI4sp+LuOLqww+1oV4qrol8WYeJap6s0zE88x0zOCp9HbG0iSc8MnohDGOkKS5Mk5SGxECi/wDazhixF/ltIIaKwwpdiIxBWf5Bm9TzJdpu8mXJU8e/dZm4/vZCEm72w5mXBDU20yFhMe9a6jYprTDFsYqUbRzbIez5f1h6VbEXFphM2hemGJSqfdpn/rbDCnca9wUBzJT1DkKt2NKCGNqYKI8TzPwtvND5YoXq/yrQcfRFJEy2wf89wyrthhCmKwyAN8KyDioCy8YQsNO2YwKtPDwCE0ucjSRKSynFhiKzfkoYX00pL6V1S3TnNQep7xYp0Kv8JcMEpgZW5Vbgyfrix69EUSbTDZEi3nztUj9hCmgdONdfrImenzWCbjhdlQoREM4TLI4O7sWJvZ7AmfUjDwNMWSUjnKwxLmFyQpSWPXaUyockKBcXDcPzzC97PjM/w9+eerlwf07ai//y/8Pz/o4zlcDpZ0+jp2q5Jeah1WNN6SsnQKpiku7rPRcRjJUjJSrbeQaqCGCYcrRvQ2LuRELFit0+604/ZOvLVzvtXtbe/22k9ae+29/0Q3NzNWZ7nLPis0XtHL7rpo2c8kfJUdGAPtx+w05JUqG1GwCxh3oNMpkxZK/sQzmX5XzCx6dSoKLrN9nYr7FfdcKhGPDJfEoXAsJ5gI/elPMsUMNiH38CRJsSSCG7fo+dBEa4s95Snk9fLtB2FIh4YnH0Hr8AsseaEk5rNqCpNpnWzWLCt2BR88ae91usMnXc47f+9u7e4M9oZ8e7u9t7O350POWj4S98fcC6GEkQnLdAKL/BcKQSqH7h0DbvE1IXCLDRyNL9A/JRc/thYz8Muo4GwguT3dP2HdXZZxNSrdcz5aUoKKLyjcVJllFNO+jEByT/iVkSOp7oraZwfP+xdH53hyevDvi4MzfCJaK7W4r+CtKbklWIUvjPVnx3EQ4DO3zIoM6qC08jhQfQyBeCjgYaD03+zUQpnwrSEvM1Tux2H1NTPmSbOh0ZOFUEp8dWYPfTYc0DMEPNLegFtM0D6PPe4niciL+Cho8jEbo1QL86jF+mkqSUieMUQjiN6RCIEYkF3LwuXURCzaYqbKRWvMEsnRvFEoOMD5/X7STwrUFOcTC1FYe0tgMdgHPHvNLXJ3Pqc0p9KpKngCKXiWTaFGFJoEmQmyycKykI7IXBaJR1Xj6ow1nx9dujv2zPgEiXzGS/sFcXeSIf3ETrT6xScRgs9ShffZyFmjMlPISHhZjH2sVKNqc1WBz1AZsrSJ3SZ2m9j9wthdfnkaeoR56LO1Cn0uFEeHpI0rnivQxzjvUQDsYZDHst6QGwwKCRDpj9fnCOyP6CwwXlzl1Bv9QHzkS/kK8/3aHv75gOBHbawFWxCDTo9egiEykUh7ju8Zx05RXlXbq6s912Yg4aBqDURE1jRsqkuH002pFHHCgfarLnbMkR85IsJanwFpVZXGuZZogRsk2SDJpho11ei3qUYNkmxit4ndXzN270SSNVcuWgJOqnZLnaeF9yQtbddvs2q3mtUh50y1jFaIGKsxVrSIHKJBZ2uwNdxNRDfl3fTJ9t6wkzzp8J3drd2tQbezG83X+stZHNdBthhTc/b2dnQqBoj7BBxXKjiXLbROF7f/oF4jhpTW3B52hZuhc9qWn2HH7ip2fKkLyAbCwI7mlu3Fi9Mj5rYsPXnSmy5NIghme9X530gIUpIP+19GGujYQMem/DTl57cpPw10bGK3id1fM3a/Cjp274OO3a+Ajl06RIJ4AsT6mdAxle5nf6QOQD3OkhLqVQQbc4iCT2H3MYR9wc1IFDXQW0CRnb1VFHmuNTvmalqBJbuwE6lm6qL0hrETGmuqsZLOz/jjH8haEuiWvEpOBGFS+hE+kxPp4pgEAl0zjfvDAlL5mKn8rV5FqiQrwaFLCpmmvVcNH5NwJzEk+AcKbh90hET9A/c4g7W+az+YnZLERyQxO7hKhKCYr/d/d9adEjgE84bSxZm39S3HBfyeOVdoI8RV7tNXDUEbqN5A9abcN+X+9yj3DVRvYreJ3V8zdr8Cqgc0dDtUx4AvhuoY22qzGks9J+f6vyN2FyqBA+feTCcOq6czDO5wBR3KjdypeMohdBC8F23edo588/qjmN5EdBidAKLnrTQZ5oyLIre9zc1rf+b9psVz2ZLhhLTSn1uJnmwOoKc1KYhOnPpwowGsf3IYuo2WU7KR5Mc+6TniXuVOLPJYqN4dMriTMh1uJ1tO0YiEc/kbDD4ffMo9Bos5GooH1o1uOR9akQ9yXZjs5vtl8YRukWWd+u5cDeMZOF0SkUR4O7s7cEbo26++coNgVlFo37+zstgrGtZhTwU3aA38UZiHf7w+f8RGhDldzJeW4K6Q1CQgak7gIi6n9atjITTJlRmjy9HYMd5fOHhDMcSGGQRmb9SZEOyyOmX/Esn+FNnZqZQmCZcQaNbbh5V1UvFJZFQHWzNNkuPJVG1CQ5t8YZ4/jO6aA6n8gWw8bb1RMXsmKRW5g+k0Jojoej12mVdy8Tm5vpWJv1XUYk8tdtTsoyUuvGovE3+QO0EgEwmeWaetb17c04vn6FEnhSdEdZkH0kTgY/G4VFJZ7Zv5WKAXE71FPt6o1+7OwOK0cKmAWdTDLGWHLBlrbcU/GCPXoTC4HJWIom9my11UiF1ExJ32HEuxXzKWMeCh4+8IgaG8M/EBlWeHTrTfKHEh+d5ZFjH/Hs1zyt4vyOweX6KK0shUJ/abeaYFY1ow9jnABv59kSLHQmyTDC4PeAfYn9nfZYLA6FzeC1eZ1mV1R37TzaHSkIBVR8XmPf+lN0tw4RNzL2h0PQZpmNB1fYAM31mgRZVqQVnVvsCyBlf5zTQK5JLePL/1r5tUNP9q8pLE/dn2ySuVTX90lr4lk/x18u5PynhNpvkdM03Au+RubtnQGMw7+dOA11a382i/eSzwF29drDpojcbFtWIOxcwTolt55NUuqpOxFG4jIBe8IOy3QZ6lJy4S0bNT+KPdc4RGBmMQthaYlA9kBnpuq7pambuA8cCS7ErfbRkOTmi4JBpL0WKv6SJdArNQX0ZHdvHugw4N2hksc0KGZc8qYwN0TSalwmoUl+WEcbjUPR6RSpuUPnGhTVOi0oV20K+eVUUxuRqJ0HIdipnYV0PaY0b7Omf4e9aC3W3YYIbqyYrhwupMkFORhTu7G0uw/T7a8LZ4LLKcOkNkXQAwMbfC8eH5CkUQU+FXDW1Gm2GS3aSxIELtkXef7dZWqx27dgHPc20L9LJzxF+Igs1fOGYn628RL/vl9Wyv/efcSA6ViFqIzZz2v0i+0rc0vpO8jG7rJDG9Rzdd0ZyMoREaen1NuyXUW93Q4z9LQa345dtZ2+TaTVjMXRKNekPkEHGHUh6ehjvMj9zvPeuuya4VodroU9NZjx/ho7uZ6/7e0E1Qv3njePJv/PbO3JyVH0CoF6tb7hcH5FT8lrIePkB+JK7/AUxW8N8= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-notification-template.api.mdx b/docs/api/beta/get-notification-template.api.mdx new file mode 100644 index 000000000..701f3eb8b --- /dev/null +++ b/docs/api/beta/get-notification-template.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-notification-template +sidebar_label: Get Notification Template By Id +hide_title: true +hide_table_of_contents: true +api: eJztW/1z0zga/lc0PmYWmDpN05Re+8PdhFK47hXotekwd6EDiq0kAkfKWjIl1+n/fs8ryY7TuC0LLLe7E6ZDG0d6vz+eV7avIj0TObdSq6M02o/Gwr7SVo5k4q71xXSWcSuijcjysYn2B1H9axNdbESpMEkuZ/QZBPoTaRioGMaZDbuZnXDL5rpgE/5JsKlOQUGkbKRzupozI7FoOGdHaQucZjznU2FFTvyuIoUPICxTfCWJxYzbSXST71HK9AiMBKsLyGoK5OKXQuYCWtq8EBuRsfOMCBuJJbRAfJ5lOsWlEc8MLUgmYsqj/avIzmdupc2lGruV3O3Zj5Kt3aHg2zze2e2mcXdnO4n3RLsbd7ef7IyGox0+ag+j6+sLYm9msJgwRLDTbtOvZRV6C4Pp4QeR2GUDgW+ilRXK0lY+m2VByc0PhvZfrQrM85zPyWwgbGrXPXkydU7ut9JL9VHM79E200X6bspVwbN3lzr/+I4ovzPFdMrz+YpP+vAGaJaOKbWLrjeCU+/i1efmI3vJFR+LnJ0VwwXhJjZEr+Rz+04wnopUFtMm1qtEp8IYEGF+T4u91Hn5wbApn7OhYDxNEclSOc6jwha5oBgWipgMosOXvaNjfD75x+tXh/h99vKM/j/uHfwTv/uHPXy+qKvtN0DQTCc8a7TRqqB+rQsXW5Pbis92A3n49OCEdXdZxtW4cNf5uLVka+FMYwofFne65d9lFj+AhkORvx6dCJViFVndsAcWv/yfVrNE0y7EM+zz4Ordu3GmhzxrIerSIrGv4LPrVqNCQRSWSSVK49bDZyJ4KvImSVWRZXxIovosrySnL4jVLBdIm0UZWGXuibNPPCvA3DClL52FsYldSjsJ8gx1OmeoY1naYkcjSJlkRRqWYI+KiaOnYjZwFR9QA4rMkkKcddvtFqlCZO42+UkmuBFsrMmkzhIU4FMf4I3mc6I1mG2ktf3NzOaJ/yizjXLdmMULsz2o4g1FUWbPsaGXpqBlGm32NqIV+28jSmla1WTAXMyyeV9/Z8anRJX1NXjfFvBL2+5i/gwc5yyVY2Esi5lBu2ByxHyyUoXUhTWWu5R1gWR82aCQ0pcKa/7G2o1y1q40SYj+/O2dshFN4IcXVsdjoQiqiNQFQJILH4+rTKHQlKOORSlWxFZORaNC9AW7nAjSBTyq5ou/A/EWu02Aumaddqcdt7fw02+3991Pq+3+/cd1nAB3fgNJL7lBVYejSx7fQeDrOlIaOExQdc2qK6FlWWl9nw7CPLMam69pf7cJ3RxkkmLxMM8RbjE7FWiVilqnb9rEk0LWly5KPpQA6QT/tajnFnSTCovcOHAI776m+hxpGI9zLklC4UROsJGB4ifpUmdKWMCTLHGHW7dsaapWW+wpT6Gv1+8gKAMz2ZwnH0HrqDE0lgU6VxL7WbmFybTq9g1sxa7gwyftvU539KTLeeev3a3dneHeiG9vt/d29vY8EHIgwTTAxWXWLyiIZOJBhvwvDILkgO2dAI75lyPMHwtq4vOzldZWIavXuRzL5mIasNuzw+e98+M+rpwe/uv88Ax/Ea2VkadH9TClsNSuwk7Q+OxCAUpSIzKYg/LzcaD6GApxZeoLpf9k5gbGRGyNOLoedgTuDTvqpBl1xKVUcnnz2bKHsiVaGwCrVCi4TSZsCDyBeckX8ce9JBEzGx8HSz4OAOhRi6FtSVKSlw35DtTrGjiaC3q4lYlY9sXClDeBRllGjutOoeSA5PfHSS+xGEVcTCxlYRUtQcTgH8jsLbcsXb9mNGfSubI8gRY8Qy9NdJ4TFh1CN4m5NpQjcpdB4VHluqpiUQks1XLl7qUXxldI1DNemC/Iu5MM5Sd2qlVffBIh+Ry89tXIeaN0U6hIJVCkzWFV5a4y8T0IW+fuOnfXufuFuXvzy9NwplNiH4I+W6vQ51wBjU107prnCvTJw7TEykX+5Mo7coPBIAEi/fymj8T+CBSI9eLzjCDad8RHvpU3nEqV/vDXh25wKJ215AsS0NnRazBCJRLpvpN7IbEHic5U26vcnut8KBGgqgEiomq64zDGYbK8UIok4RgSUy2M+sn6cwmOjDDGV0DiqtJ4pqWyayS5RpLrbrTuRn+ebrRGkuvcXefuHzN370SSlVQuWwJOKm+yuUgL35O2dCS+zcq7i6xKOeeqm2iFiLEKY0XLyCEadraGW6PdRHRT3k2fbO+NOsmTDt/Z3drdGnY7u1G91w8WeVwl2XJO1fzt/ehv7Yj8E3BcoRBcxmqdLh//wby5GFFZo9JT4WbYHCa9qLBjZ28VO/a1ptt+8xIhmSUMqRY2opqGtVNam5dr3d2FMeqiYihVUvv7yXTwGjM6Q2WZnMpwJiyIbj6PeyO64xHuF4Ugq7iEOxvGVYJME2rWCCwJJcWIMB8oOAQ7RnX+jug0uOibkDw7JY2PSWN2+DkRghK9Qu47Tee7RxA+pxpx5h18y0Gvn3a4QgBgIPA1q8Kda3y+xufrHr/u8X+OHr/G5+vcXefuHzN3fwU+D2jodnyOBV+Mz3foVjyrsNRzCq4fDtNdqgQJXHgznSRF7o6bSwzucAVCKTw0SjWEHsvcjzZV7fnLuHxUwWxeyfQaqzz894IVeYYNE2tnZn9z8wr+gp+uW3wmWyhjcJmdK33ZSvR0cwgj3fp0iHusCAtY7+QozBctZ+FcUhD7iueIe3s7nShcYXd3Nnwn5fLRQvcgpiezwRDwIaDcZXrQDdPET8atbrkAWtEPep3n2fW36+IJ3aJLk/nu5Ib1DJLeUJFUuCB3wfEg5Px1DnkOfLnqFeTswUV9zRnBcy/hyspFy6GRrrMi0Gta1mFPBc8xO/i7HA9/ftN/xKpnWFhhCA8LSVME0uoEYeSKXq888adNrg/luhhPnHK9pXsqlGRslMEo7K06E4INjoKhXqEbnKJ8O7PTJuEqBu26eFh6MBWfREaNsrWwNgWnTNUmrLjJl/Y9ck3RTQ9S+Qd9cLX1VsXsmaRaRQ9QuzVBRTcMssGs1IvX9PpaIf5SUos9tdhRM49uSOFNO0j8MzoJMp1I8Mw4a301c08vrtGjUQtXiOpNGcgSQY7lO2FJ6bWvlmOJXkz0luV4q95MJDru8jbmCxwzaJhZyo5YMtHaiL8zRqFDqTIYF8i0rxbrkpjGLiPiTrsmUuxZxjIGfnTyHSMxlA8mPqT+7eCLBrJTqU/b986zqAvvMV2n7P2Szu7yAG2WVqY6MV8tMzGMiWHs64QJ8vsuRoFFj7VBB1cHfAAcLPzvKkEQtFYbPa3Gyu/Ib7o91D4SiOqomNm+/7C/KILhL+a+oNXVGpRqgt/VvUF8ZoEWtbIlY5UHBzctuCpvptFBb9jNy1sdXFFX/b3pSxr3Fucrr1U2/95V+pZK8vupu/+nireuNH/GShMAMYWbYxsmh3qQPw2YbvW8jw6kJwL/41uXqw57Y7Lxj8QTiqkTIjhNUe2yOplI4U4KZoJbwocb7sHfqctEDPWU/pgHHaGxe6Y5h8gcs53MQM+dZZecuUsYDz7Jr/S5fA+D3uWYYPIULfYGw5tK4BYa3OhpDHz3QYcJ7gyeOSHHsmelswG6ptNCgRvlZTFlHCF1T0Sk0iSFCa+QKCVKW2gH/apdZRZTqJEKLTfC5FPzekSH0Jhva46/hxf8bsIJNPfvwIT3zhaKnIosvPW2cQPa30cb0RZPRDZz7/VALAyCNQ4vj/orFEFMGeiFEV3n482wyWzSWhChEcqHz3Zrq9WO3UiB6zNtLIbdGvEXwja/Ecee0vt2N8PxanEG/z1e5QvthOaAzRmdcpGQhZ9d/Lw4iJrnRWzelyk9aD6BTrTu6ooORGiCuqbLvxSCpu3BxWI4ckMKbE5/p9VrfLfq9/A0POf+iN3/9mCjJuWpnpovBvoIf7oX6eiNCEzLi5eVBuENu8gf5dS2rNzsoLGqGq9fHMLn1/8DUesgXQ== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get Notification Template By Id

+ + + + + +This gets a template that you have modified for your site by Id. + +## Request + +

Path Parameters

+ +A template object for your site + +
Schema
  • Array [
    • 0","description":"The description in the template"}}>
  • ]
 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-notifications-template-context.api.mdx b/docs/api/beta/get-notifications-template-context.api.mdx new file mode 100644 index 000000000..409f520f7 --- /dev/null +++ b/docs/api/beta/get-notifications-template-context.api.mdx @@ -0,0 +1,88 @@ +--- +id: get-notifications-template-context +sidebar_label: Get Notification Template Context +hide_title: true +hide_table_of_contents: true +api: eJztW21zEzkS/iuquQ8LVMZJTEIu+XJlQqBCZYHLS1F1gaqVZ2RbMJa8kibBm8p/v6dbmvFbAhxwd7uUUyR4ZqRWvz7drZFvMjtRTgZtzXGZHWRDFV7ZoAe64Hv+XI0nlQzq0JqgPoVsIwty6LODy2xhWPZ+IyuVL5ye0DUInY+UMHNDhFfuShdKjKU2Ab9ejFWQpQxSBCsKEAmuLoIIyxNDYsEL64SvJ5NqKqSZCm0G1o3jmLJ22gx5rrpSJoiJsxM55IcdQbzQQrkP1ilxPVL4G0baL9DApVPBaRAo6aKQVYVP77IXle3LSiQVvMvEA9n52JGdu9kkUWjcw444DqJUA23AuoT8QdiBkAFL9GuI8w5zRjKIa11Voq+EvJK6kv1KCVgE5IyEHA+sG0qj/+A1Hnagf68KCBumsMFNdgGtJr56dRiRXXRpDuYZy1v9HTgly+z9LWzllJ9A4wqWvMm6W1v036L9Xn1OtjkpBBRI0k1UQeMT38QojzWBSEsYLdHa/OCJ/k3mi5EaS/oUphOFFW3/gyrIw8h2ygUduZstdddYWZaayMrqzdwseJJadsieeHn2+pWIM6Pm2R08e00SjPhWnySkVbQaOCnhkxeuAoFRCBN/sLkJTkIOs3R0CfFgCW/hZIUdY27fSVPCE2GTgR76qNaBrCtWg5HO2esTO7QXpyfZgamraqNZ45Uck2Bn8IE3FhFClg4gJl25NMHIKx09+9BW1mHS1vb20ZMd0kZBt5/WIcwedreedp8dkVyIvOq5s+NeWUJs39CjSVfqRJuPK1MqO9TmeBYjsvoVE+VQxbm3+IGd4VZBlXPWQSRDB9myBd6OlGFlD2NANc50LRFsichGFhfDcESsyoOGWuZsAt66W/nWTr69e7795AD/dvY6u93df2XgZGxL+OD3slJJH0RL6jsYAkdwDx40H03LkBq1uHNXEB5WmsDsCG7jRC5OVaidIXQaMPNO/V7DGUXfllPBaHYlK13+wOArAdG6OrSl+rJOnwPo8qEDtINDxSwXmEhQfKUpKKBU4G4kSVDIaE3jFqKONNHZFk9lCXmjfIdJGFKok8VH0Dr+CiNfGI35opkidMlgdc+yak/J/pOt/e7O4MmOlN2/72zv7fb3B/Lx46393f19drDo/fNIhJCW05WlXyijHNCwssgi+g8oBP4N3TMDvDimaMDqnaC2aAOm8RX6pywXx7ZiJn4F+dkGUPrp4RuxswcPN8Oa78vhkhJMfnGGOxTdlIoilN5uJCZeOw1AuIsVZeoxZZ9nR897FyfnuHN69M+LozN8Ilor5UEP+RZICbcEq/CFkb1mjpMAFIdeVVCHKjviUaL6CAJJ4+cH6njlpx7KFAlrMSOtfseMedJiADhcCKUGCB7ojupsIC0TFshQjERfekywETYe9YpCTUJ+kjT5SIyQW5VD0u+1GUkgGkEU86ec38uSQjcSGNQIZTCjw8jWgSuJQi3aYqbKRWvMUOVk3igUHAQnX/STXhFqMMdizkdh6y2JxWQf8Bw1t8jd+ZzSWKVTVHXIJFQ1TaFG5yjNIm8LHbxIcETm8gAe04xrEWseLBnuUqJ5Fiw/K2TtvyLu3lSAn5xFax9cqRR8ngrNiEZsjcZMCZHwkMTmyWlUa64m8AVyQlWuY3cdu+vY/crYXX54mlqP9JRLn+3V0ufCSDQ01nHyXCl9HHuPsaIZFPuUaMgNahRTifTy7TkC+6Pi9k59mminfmR9FFP5CvO91h7xfr9tTlPqn9mCGGQ9RgkGQCJVHjDfM45ZUVFVj1dXe25dX8NBzR0lIlDTiamthYTKXG0McSL9hiit8uaXIEYS+CgREd5HBKRVTZlPqAlZV5LrSnKdjdbZ6OfJRutKch2769j9a8buZyvJliuOllQn+Xo8lm4aPS095014gQGi2QQXbcixqZarFSIm2horW6wcsn53u7892CvUTil3yieP9wfd4klX7u5t7233d7p72Xyuv5zFcRtkizE1Z+9oR1YxvTtBHVcbOJcP1paL239Qr1MDgjWCnrZuhs6h0vdt7djdX60dz60Vv9LblFQh+YUa0sx0RJiGsWMa65qxGCDFELho6J2FBl/kSnqsQMXR+4JKjzUHL0kBum6a9wYBosRAaZysXUWboqrBISNBZalqtnAsDSHVgGo+UOAKdgh0/oHV6bjZ1v6OSl6cksQnJLE4+lQoRYHeVu67d+3vHoN5RxhxFg18z0Zv7HakgQOgIYiY1dad6/p8XZ+vc/w6x/8cOX5dn69jdx27f83Y/Q/q81QN3V+fY8BX1+cY29kSbS31nI9b/K/LdA6VxAG7t7BFUTvebm5qcK4r4ErpoBVhiKRDO9nmnQd28qI9dBUbgMhavXAa5SYeuLntyIluT6QYe00HUjb7UNMdCERHBWK00QDRe3OcOowO69hpcuOIeUx84RhL5qH5STqicj9lI8dsyqmtm8NMGwIun1yKb4PFCfqJXzyP7rALrcgHuS5cdfv9skRC98hyl/o+uxrGC3C6JCKJ8H52RuuMiu+4+spJrVlCoYatu7LYaxrWFU+VdHQcjN9hPHj59vyhGFLJySFfe6p2laYeAUHzBi7CkNZr9vNpEmcZZ+vhiBnvLbwxoRASgwoCi3fmTClxeZyU8ApYfwpwZpXSJMV4QLPeP2isU6orVVEa7Mw0SY6nS7MJDW3KhXkPOeVxbzB38K7zzuTimSYkoqOEPCaJyK2euJw0csk5ub6Vib811PJILWdq/uESF1G1l0U8gVMgjomErDxr65sXj/TyOXrUSOEOUV3mgTSR+Fh8z1U0VvtmPhbo5URvkY935u1II58uThMRvoRHOqxKcSyKkbVe/UMIch0Kg8thjSj6ZrauadGcIyLvbs2xlMclc52jOmT+ThAYJjqT7FN25uLEom4zZQzJ39iyiPnf0DuX4rcFmfn2JZIojSxt4b+ZZ1owpwXziAE+8R9zFDkWHSKDDIwD0QEOZ/ZnJEiMZvOnDPkc5V2ozuQ3eQ6lhgKsMhU/OYgXBzOAS58EP6DR7RjAMBXX7Zs/XItEixLVgrKabYFlDa7yyycGl/QW+W23pShn/tnkJYl7s92T16aa/miUvgdJ/jy4+39CvDXS/IxIk8pdcjdeNvUF807+NNVrq7t5tN08UviLpxyrXFmjb+FOjKuYeUJULJNXc1QXIzrAj95homSg2m+DPMuOORLRslP4o9tjQkM+dOzAskTnpivQ453qZmXJARMLS7IrXfs6HSC3cEn0laoj3qI1MwXMQm0ZnbXAsw829WftgW7xrDE2iq7xuDZYjeKyHgsJl/qCR5TaF3UELnQFRjW6sFz6tbOaKCZXIxE63KC4sX89OIvfv5gz/BfWgt192l+G6uP5dT6jPhPkVFXp+x8bS2X7l2jD2/KRqibUGAJ1UYCpuRV+PT5foQhixkMuNODWDTfTJL9JY0GE2qPoPo87252tnNsF3J9YH9DKzhF/oYJY+HZDcyC7+YbHskPezPbY119r+W99rSWlWVpic0J7e2S8OvZrsUu+zD7fJaPvGsHYNPDmhvaBqG28pdu/14o2GS7fzzpCusICcT+I2+qPivcheMdottWw+k6F+ru2i39xRI4q7ykV0gda6vb23+rGydQ= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get Notification Template Context

+ + + + + +The notification service maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called "Global Context" (a.k.a. notification template context). It defines a set of attributes + that will be available per tenant (organization). + +## Request + +
+ +Notification template context attributes for a specific tenant. + +
Schema
    attributes object
    + +A JSON object that stores the context. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-oauth-client.api.mdx b/docs/api/beta/get-oauth-client.api.mdx new file mode 100644 index 000000000..5373539b0 --- /dev/null +++ b/docs/api/beta/get-oauth-client.api.mdx @@ -0,0 +1,95 @@ +--- +id: get-oauth-client +sidebar_label: Get OAuth Client +hide_title: true +hide_table_of_contents: true +api: eJztXG1z2zYS/isY3YfGGVNvlvyiLzeKX1L1HDtny5eZup4UIiEJLQXwANKO6vF/v90FKJKS7Dhuem0z+pLYIrh4drEvz8KA7ms6EYanUqtBVOvVJiI951k6PYylUGltu2ZFmBmZzmu96/valRXmUKtUfEr7MAg+q9mkp/GFIKQ3ejOu+ETgi0sPjOBR7ebhZruW8onFV89RBnMz2Ro8iIQNjUwQDEAZTqVlgMeySKRcxpbpMeOKudec1DpMlHDDZyIVxhJGie8mHNBt1xQ8gN9khHjCqZjxWu++ls4T/NSmRqpJ7WG7ZsR/M2kE6J+aTKziEJU5GYkTn/gsiVGOGO/sjw86O509cdDp7rZH3dFov9Pu8O7uzsFetF9DnY2wiVZWWATQbjbxv+o0FwBC2JTZLAyFiESEuoVobFgHGM2TJJYhrVTjF4uv3K/qpEe/iBCXLTG4rql0EwLiFb2X1RwcoX3TJWUrmrbDg9Z+c3+nG7VFt7W732x1o532eP+gGfJWd7+FthxlViph7RmZfnVSlcUxH6G4x2yNi5ZDyaXRL/33A+8tzE51FkdsJGKtJizVFZj9cCaCSx1zg4CmeiYScMkrE78MTy6AXV2cMm6tDiVPRcTuJFgJcek7JUyOuABZwTRN06TXaMQ65PFU27TXau90uohPPWKoKpA+m2YQWgFGEcJ1Vhpr89SkR2Kmy88elqR+qTX6rPT7ZxTuK3riQyazYLAcLWYFbeRv5MsfQx2JbWbEGEJk+jHVvwq1DWEe+Vc/hhCY8L/kkADGsb6zqAaHGLF2iIP/w2MZQYK6FBAskS1pJSF2JsIALJh5xlP30U57xbjkddls5FbROkGYatw0jEBBKlKYKReKQHYqeST8dotI8GHZEHvdJmUYUu8PBpxb8XcB3t/tNB3kCHJimF4ZWcbIjeHzNZ4iUzGza7Prsg/FErKcdx5IakbfAsJ8NgiygXXusoivVX8hRyiDvn4swG4AwMRwlQ4B1jo9FrirMCkHttlbfJXhuzB0OVgKZz88HRyfDT8eXhwfwf+D/uklPoYVQmRrH/avht+fXwx+7A8H52cfD8+PjuHDi+OTi+PL7z8Oz/91fIYFMZUpyX+ba/CUPV3abtebjBRmCNeuLHsIbj0ShYWrVlwLa60CS1iLmCQjLZsTHTYPJhjAXmkVQ2JnGh14jD9uOZeogK3Y+Pzk5HRwdrxuHbyhz8/8gHxoyYL9AtxDLmEdSEK3ktnYqyQbQfVFvBBrY+kz0lbVC87PTgbeRE/AXBr2/urN6eCwjNXNmWPFpGAULxevkdax4Gq1SCgmVYQkgezK7qYC9FguERUXwMxgHPOwLJ8K8gcbHJ2VlRtD+hUPqAQGffT1wMCCe5mEBUCVp8XcArOCDaHOo39fZkmiTfo1EVgn0jI3C6UbXF7HtdYZIYy5nNk/Egp+DlwbXMynPXzpsv/ulLm5UYD68jS5UABoRBX4wksXlSeCEUEqZ2Jt9cGnVKVxxDaLgAOh1yCOmYwhJVFN2nY4l7S845blCCr0stnaC5p7Qas1bO33Ot3ezl69ebD/I0bBTEdyLP9UyDGHPJsl0Trc+0FzN2h3h+1mr93utffrrWaHcONL0DWtxb1cQv8YParpv1AEfQdey0nCMt2pM+q/cA6bgqYwD1QTpVNsyXIzMHBMcSvMvDxFZoEsbwN1h6qk4jn8E4J0gD33Mn1vMi8lonEWU/i7xDqeg4EAvwynJcFAcAzQHs2Q80Ps8DCVtwImIFWIMTp5BmjvreufnudcNtSJeDnHwUUa8yzGpYOul6TZHo/j1Wp9Sc9WC0y9WoYj0KDHE+l754BE9sbS2JRmW/fULTtU4kpDe+2a30pXVu2JfAdSRfokw36azi4xxwr9qpAEXyFLFa4oL+tT/mrmLVJZKUXkC1omUCIleuSsfeGb8drDA1qrs64d9858bAy4ZcAuRJoZBX4m3dL5mslGOppjDZOKyPRX7NndpschpPHPd4cnsLgB2FkiQkGQKf8juYbFgWCaaYgdJzL3PhpXDRKwRL3F3vCI5bsRh14ZJE2Gh7+CrMEzNhOulIT3Wf4Kk0X3t2ZasSf4aLd50O6Mdzuct/c7rb3u6GDMd3aaB92DAyoA4DbgsesofHXqt5jQgKpRJyB/o96Cg+0JAE1eW43kR9aAZDzD/piW3diFmh4vw70y6GfZm8P3rLMHuVdNMvqcT5aMoIKry5WkgyWEBJ8bOZFre/acVx4dn/SvTofEzf99dXwJP6GslX21ZS4y1XeE2CuAFcKKGMwBKZS99lJfg0Jc2fJA6WnK3IIxmU+B8Iaffc0bZdFsbPSsEkqh21hkr2Rd1KF+4GdQD6EGjLh1tQaHv0Yqn6TBqbfkazYVPBJmq876ESQiUBIYLEQjCIX351gReBRh6DoB4wxCWRBv0lCjoKTJUFTXojDlcgnIE8ppeVEwOAD5M3ZxwjRDeo1qlqNw4S0eol8fwOwsV0U3LBmNTDpXKRZDGAnVMNSGGmmsvxKKpk9HuFwWEo/Kxy0yFqbAXC1Kd+8cmKNU07OQZ/YZcfceUrMKSLXFg1vhgw9Jhc9GtBr5MvmM5OkLvexHLZYrD3wGuT2ONrG7id1N7D4zdpcf5rzHPyXq01qlPlcqbyVBiRXqY8h7gIZX+k2/kNu4Q+Ip0g8fhn4jEnv8TwkS0q/Ij1wpXwHfX6yH+3yE9GOxWJW1QIBkR6fBGDKRiHqEu0BMhnKm2lmd7USbkQQHVWsoImRNw+Y6o7bFZEohEm63qZNS36Vsym+LXTHtWjWhoiDR0nUEGya5YZKbarSpRt9GNdowyU3sbmL37xm7TzLJBSqKFs+TbDabcTN3nuaf0wEeBgNYfhyGLUKOlmqZraAwtuBYtSpzqI3arVFrvBeKTsQ70e7Owbgd7rZ5d6+11xp12nu1cq2/LuJ4EWTVmCqtt1tHMjGQuFvgcZkC57Kp1lF1+w/Ma8QY0xqmngVvBpuDSW8K7thZ5Y5nOgXdQDBwR/PI9iIeOQH5MDWJR7vpzITuD6dkOhjO02JzXnyStEe8oY4b6rgpP5vy822Unw113MTuJnb/nrH7RdSx8znq2PkC6thhSLHGSLH+TOoYAe9AajaGRQEdwgzMq5A2JqAK/OR3H33Yp9zgAYuc6FVYZPtgzaE1rdk7ruY5WbKVnUhVmAvTG4yd4djSiS9ANIEUqRhkLQnsFr1KzgRyUjwVEsuZpDhGhUCumQf9cQpauZjJ/W0xi1RhnAFCSgr+cDb4mAR3EmOkfyCB9kEnkKi/4h6nX63ftR/MLlDjU9SYHX9yh/DZYv+3u+6UwCA/MXfp1vqR4wJuz5wraCPEp8SlrwUF3VD1DVXflPtNuf82yv2Gqm9idxO7f8/Y/QKq7tnQ41QdBjybqsPYepMtuNQJnaX9fzN2ChWPgNyb6ZC4elRwcOIV4Er+pizmELxo2qs1ylddbeNeRg81vDuLpNDhyfD6Id1Ssr1G4x6WCZbnoc4TWXeHntO50nf1UM8aI7DNmrSDp0xdiOEAOjzsJqiTYY1E33WJjoQ7My8OJoO56WDBk5Lzu5dzaD6YE7ONd2K8H9HHADGBJuI7S6Pr5Dcr+oFeVyZ++P26OEGP6LLOfE/OBuMZIF1SEVW4Ka46XyLjdrOvXHguqggu+OrNPH9v7I3gBq930PGXVz98GG6VbuPhWewJExIbA4iU9+AilMf65duGVFqMzibucke/ctjmML/cUWc/qUsh2PXAG+EMEvwFZGQyab9yk+XmVb46kbgVMda+emFJdDwZqQZYqFG9AbNFdY4aAqncHQX4tP6TCtgRnfOWWK9xjFeR+jt2neR6la8VvBTEP3JpgZMWkDS7tYTCmfba3zpdvjr64sn9QfuSvIBOtQcodRmDu8ZEOKpHpBZXcl6MoyIvQHlVHD+pD3RpovoaczkrvzQ9YOFUayv+yRi6DobB9SSDKHoxLLqpEbgU2G6WIAVuykAGQAkJ3ykEhnLOxEdYkomRaLc5QiH5M60sxPzPdKfj54rO9PE1VE4cGenQvhgzThjghIHLAdbj9981AGAhtt19Ywh65wCHxfpTJvBAS3nPyVqb1Ul8g96p+RsKJKW4MVIkOP8Tc/cYtpdulfRqxaEx+J15WVidKsbK9wKWLbiKN9ZQFJfs5vAu/qKJhfKvpi9q3C+2TM5VPP/aWfqRTPLXybt/UsbbZJpvMdN4jovuRtP6ZqDs5G88X1vdwsM95qmwdK2NYpXoNDQrxRXVsqAk5il6NUV1OJWCmv9E8BS53zZ6lp5RJEKfjuEPLR4JmtCNLwOQObRrMgZ5tD2dz8wpYByxxHXF323mD0tocEloJkWdfYB+TIWwLNiL4TFdePaL9k3ZJazMe1xYdpQvNpCu2SxTMBvGZTZjHFzqMx4RSRtmLnFBa6ZEbgtN1G/xVh7F6GqoQp26EjOz52PcV4aWtbTwn5kL1t36TWUwPa6i/xKcQpELEZNn4rgqbf+cbLx0OBVxQjdbARbeoStmeDcYrkgEYcr/JUObScO/ZBs4FoRge+TcZ6feqjcDahfg80TbFPrXkvC3ImXlLwxa9r/7Yh/92d8c5IsEsvtGgttROHXmug3X2F3XKo0dvNOTEV4sxK+YwMf397hhga3OA34MjTp2w9c3RRdD3R8Y0N+bpyvYT2B/deHvbm7Rn1xWv3hoLeh8p03Niya7Bj/+KrA3h/ce8Bsa3OYJAXIP3PZK6ZWVP0BgX7Roed8e4wLzR0qs/wGUhyTyPzm400s= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get OAuth Client

+ + + + + +This gets details of an OAuth client. + +## Request + +

Path Parameters

+ +Request succeeded. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-org-config.api.mdx b/docs/api/beta/get-org-config.api.mdx new file mode 100644 index 000000000..427d13c13 --- /dev/null +++ b/docs/api/beta/get-org-config.api.mdx @@ -0,0 +1,95 @@ +--- +id: get-org-config +sidebar_label: Get Org configuration settings +hide_title: true +hide_table_of_contents: true +api: eJztXOtz2rgW/1c03A/bdmJCCI+Qmc4dAiSlTSDlkUfTTlbYMiixJceyk9BM/vd7jmSMgaRN253dux2+tGBLR+d9fkdIecjJgIU04lK0ndxubsyibjhuSOHycW4jF9Gxyu1e5OAZSR5+2cgpZschj6bw5iE3VCyEVxG7j+pxNMHR3BG7Mhxbtp6hdkNGHSC2/Ningo5Z7ssjkHSYskMeIB/AxQGLCIwkZmRs+CN3PJoQKbwpgbVYKKhHXuEo6vhcvCbUtplSfOQxEoQoVcSZIq4MSTRhBDgOmdBk88BLyFQghWIg3UOuWCjgf4s89NhNzFREVAx0mcMcnGajoCLC0TQIPG5rzjavFE55yCl7wnyKn6JpwICIHF0xO8oty9ccdIntUWXYSxVOHBrRrByjKfCtIumzcC5zKjJ59TnX7R1c1ptH7c7n3GsSgykULDYXH1mB8R3qswxXKgq5GK9wNQA1CRhJpKtVlqiK3VM/8HAetX1mKenRMPcIvsF99kmKFxJWzANNMIfgNPIV5pG7CbcnhCsSSTJiyL2TmgvXJmQwgbcOD2EmWJ26LnxQMI8Jgqp2Yg8JUnWtCA0ZqAgcE9aAmSfU4w6RmgNFbCpwBVfGwiE0IpsjFtHNuS9u3uJwC1mzkDW1IHYd1A+W3hzIEMwvUXbPVo0JFWP2TgoZqr6MQ5u1BAWj7TMaxWFWKyMpPUbFilr2PTpG2R0GlgV7okYYCG80cNjoXzbe1TsHrct33U6317/sd4e9Ruuy1anvHbYu91v1wbDXIi5SATUxvbrznMOn4rjUUwxEoKHfSHwLI/97Nqz3jshsPGk34b2IPQ+XzO1GYcyyCmu2tnda1XLdKu/vV6xSvVK2ys1G1SrsNCulUrGyV6i1coaFPg36UxUxv+0cQUTByuoFvBCPQ2SCm7abnd1dpbXfdlCXwCY8SCgSPyGZ/xa7kMNmFIB20a5t7RR27Gpti9ZKrFzYqtaK2zs7o4JTKVbKNaA0Iw+jt8rlCkiySOHyx2gUL5+isv2DVLYTKl+MXk0qfolRKYwEP0lSGUlHPm9eFvDzzqB3Xi/2q+qOq+bp9dan29LJUWd8e9O64nuT8mXsxo1T5dOib5XP6k1+dbM3LvCrs8PRtCz6Fe/+U+eMjiYHon58wJoHdulk++rjh3Byd2IN302D3qHa+XQ47l7xj51Y1Trc7xfiY+eD9HunlcH+6c3Z1BXnjvVVdMaj0Ul8N5zWDqbNGhs1T973RXRMVXTfv68O7elBfLp343Y+nQfx/YfeKbusDk7OK4Wbw3L5angz/brTKZ0NRyPHvndGnwoxv67EkbV3WyscfRiMPrH7vdPL417pxh63r2lLla7bTBxO9+7FwVd+Lqv1biF6vzM6eNfd2X/fu+ajRlD/2I6qx+3+oawejC/P3NrVVsH5cFM8b46npeB4cPt1220VP707F2eNs9uz/X7duj2h47dvk5Bojl5mOCwWI6pMzv6mwVrDWbQpOQy9l5Hv97tk2Dv8JuFJFAVqd3NzCn5rAX1LKWnFsAIsxyk3CbGBpchN/KvHbOn7TDj6m/qlLNmut8kCcbJE3RSF5/NiNi2iaMC1kk6PBTKMTEXOMkjDkE4RxkDIqadq/GLZtaUX++JllbeTVF0zh0BpDzUTC2Wo322SvViBBgA3aLqPiGNuYqiPzgsU2YaqjvZLV1FkNhtXpJ6XrKo2CIU6GU10VYnCKQ7lvh9HqMk8qZNSoUBYGIJG77iepmIvIm4ofZgJhToCFQURWs2XDnenRvF62T+goDOXC45c5ZctgDy7FIjN6xQXthc7PyvhbDZKiEwYCZ+QAeBBNAnlHcxyQYhUBqDhU4ehLApQ6YzeW80ejp3p8O1bXHu11D4hkgwdFmbk4QAqx/BkIwdO6tPIPNouwgNweO7Hfm63AJ/pvflc3CpVSzvblVJ1WQM95oHr3wLcAimJXmfu+FopecDx+L9KxXa4Cjw6BR15zI2sSFohH09QVCKkcJgN8B28bmzILQhYfNQ4MNL+mY0bALi5x+zLeVPxqJ+XnoLcDY9jZLa0VSyIZgBSAm3nJrYziHwkHeOSQsO2X8LlizELOYZyryGdF8TsPgSiNQ4pRw6NI9kwEXuPW+6gvnwJ6ceQnEFqPW4RVIMm8ltkjzpk1nE0EmFQfSG1r4HWSxDaUHCYT2ZTCJ/nvCeWZVVGR5VCrVhyKyVKizulrWp5VHPp9nahVq7VcHUfMg10aE8lweV+TSBEJp60wSJfQSHoM5CQkQG9+MvzpqbxwqbCjE3FTPgl2ItCDiN7jWNSqhIPgHqsn9OlhoYJa9hfqXCI7zXhLgQCF0+xwgTG4QUg3f368HAAT3qtj8NWHz4hrZWGto5J3UG3BFbBFybyTnOcCHBHVdog5cmbhOobEIhCoGYGcvPN4D6SJBaYkaz+xIwsaZOhs6Fkm8advOJ5lt+AbADPIAFBW4bIAhookzXf1KEnDSLrMNHkGzKBlp6FryGROo5O5dCYQjQCUZg/xbRCnUzadWPsiXQHL+MI8grgzcVcmVHlMt6Y5ZDDrFEwOIDzF2AZO4qBOS1mNgpTb0lYTOyDaVCvs8jdIKM0rdKpiKiNqNmDztSWIfaoZASycehQk3SE5lKQeMRsXJqxsqlRp7sjw0wT20t4Z9NYvSDujj1IP5YWLX1xy5Lg0321yUbaGjMzJRkJXqLYenIyKjXXLPCJy5nnrGN3Hbvr2H1h7C6/7CUbjclbDX22VqHPUGAfLkNdPFegT6i9R0gyG2TaHWPIDQBmM4j0/nQAgX3NNPZl9wEC078QH5lSvsJ8PbWHeT5C+JEaa8EWyKDWo5HAhUzEnF3N95xjrSijqu3V1fZlOOLgoOIJiIg7oAS6Ud35hbEQyAmFhsaRTIk/IjKhkB/NDqvJgLrHcaxAAuJeI8k1klxXo3U1+n2q0RpJrmN3Hbv/ztj9JpJMudLRkuAkFfs+DafG05L3KC0lMIDMfvImachpUy2jFSRGUoyVW0QOuVFxa7TlVm1WcmjJqWzX3KJdKdJydau6NSoVq7lsrb+Yx3EaZIsxlbG3sWPyW3F4CzguFuBcKpLSWdz+A/WGzMW0hqknxc2g8zz+/pVix9IqduzICGTDX4EtoPH09uKwd4j0YWlNHvWmf5ZDmG1UB8NppCEl+jBomqtoDR3X0HFdftbl57cpP2vouI7ddez+O2P3h6Bj6XvQsfQD0LFEEGLpg3b/JHR0AHcgNHM5HvhLz3yELABR4FOy+5iEfUTDMYtSoLeAIou1VRQ5kJIc4UGHBCyphZ1IMVcXpjcY6+PYcDYWz1qQMaRIQSBrcUC36FV4KhIwKfgP8bjPdRyjQEA3nFp1NwKpTMzMjzIkqyRnEpROCp4U+rjMHeXgTsxF+AcU9D7oGBL1X7jHmVjrl/aDSQ8lPkSJSeveHLQl6f5v+alTAm2RHITtG1s/c1zA7JlTAW0Euw9M+koh6Bqqr6H6utyvy/3vUe7XUH0du+vY/XfG7g9A9QQNPQ/VYcCLoTqMzRdIiqX29QnVvxux61BJONDuTaStsbozx+AaV4ArJbfTMIdQvNuQy9zfyeGdNASDhg88gT4/nP4A5gGzPOZpwPOQtcBC0VTIu7wtfX0R6Il0g6dLTWjhAFI/biedRV4rNOTosybBaeJGvckx35wCNesDBd+kPLtqhYfniSGzQcC/E//Rj4HFAJqHP5Qendf+siIfyDUMvcdfl8UQekaWp9T3zdVgPAFOl0REETJXCPuItM3qKxcJ59UD9/iLK4t1cViR7DEa4p0pfezl1fvTwWsyRnyp4zvWJ5cZx4YAIuQYXETnr/rsCAhO0iUllPF4ohmvLxyywXghrgcCk8+izxi5aCdK6EBi70Em1iqtL1yj+fJqZh2H3TIPa15+rkl0PO6ITdDQ5uL1m9e6vulGgAtzGByPyX8WFmnqa3D6WgOOSUTUfR25CGZy0YxcP8vEf2bULEPN0tTU6yUujGovbHNo24agRRLUU1pbP724oWdl6GHXBE+Q6jIPqImEj8WjUfbMaj/NxwI9C+kt8vFZnOr7i0v3p0yuIgpqn+eQNrEnUir2X0LQdTAMLsYxRNFPs6UvTVo6IqxiIcOSZZa0uAVQUPN3CIEhjDPREZZijUSk2RTRIfmntizE/J/6xsefCzLrxxdQMXGkI2310zzjgpa+I2RygEr4NwUJHQtiG2UwF2e0AzTm9teZIGE0k/cMrSezuia/qedgabCBVU1FBbvmy+48wSWfiH6Bo9MxkIYRSaeHxfCGTEILq9KCsmZ7AMsaXOXXk1AMl/Rm+E1/ycQC+f8mL0pcn2+VdIU3/auz9DOZ5P8n7/5DGW+daX7HTJNgW3Q3vWzSBGSdfC/Ba6tbd7i3PGHwL7zVsaphNDQp5o8kIIrJEgo8GqFX66i2J5zppj9gVN/o20DPkr6OROjPMfyZMoTGIYyBsFWASemIe0BPb0vPVqY6YAywRLvidxUnhyQkuCTekc+TU7yGaYNZsAfD47nw7komzVgfLHOMhiXNmbEBdPl+LGA1jMvYxzv73/MIhys7NokLmgLBZrqQGvqls2ZRjK6GIuR1NxL6quvifjK0qhnDf2ctsLtKNpNB9WhFfRUXGp1UEHMhD2+6bizB9u/RBm+zJswL9J8bALagp8uscNQerFAEYiL5BQNao81kktrEsUAE2yPjPtv5rXzB0u0CPA+kiqBvzRDHP7/RXfnzG4pFkb6fv+SND/Pd9L/hD3ckxQa7hM0At7NQhNh0LaYxvMhlGkNoNSYgHz59eMB9DuyUHvEx9PfYRF98mTdB+A2omf0O3UleM91n6x2ReSu9+psBtjRpl3rQQtvQZ6pj8gGXenz8H/KQN5Y= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get Org configuration settings

+ + + + + +Get org configuration with only external (org admin) accessible properties for the current org. + +## Request + +
+ +Request succeeded. + +
Schema
    sodReportConfigs object[]
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-outlier-contributing-feature-summary.api.mdx b/docs/api/beta/get-outlier-contributing-feature-summary.api.mdx new file mode 100644 index 000000000..3ab895971 --- /dev/null +++ b/docs/api/beta/get-outlier-contributing-feature-summary.api.mdx @@ -0,0 +1,100 @@ +--- +id: get-outlier-contributing-feature-summary +sidebar_label: Get identity outlier contibuting feature summary +hide_title: true +hide_table_of_contents: true +api: eJztXFtv2zgW/iuE9qEXRE7iOMnELws3TYsUadPNZfuQBhhaoizOSKSGlNp6gvz3PeeQkiXbubRT7EwLvbSOTJ775SNF+ibQhTC8lFodx8E4mInytCozKcyhVqWR06qUavZK8LIy4rzKc27mwUZQ8pkNxlfB8eSY+fE2uN4IYmEjIwskB8QuUmnZ5P0xMwKmK8s4s44E0wn8EbVYsMTxYIk2jCsmY6FKWcJIR37ALlLB9PQ3EZU0kUtlx+tJKJ4L9rQ0XNmMlyJmpfhSMqCbC2v5TLDfxfzZxgoLFktbZHxO8zcaap94Vgm7+DsWiVQSVQQ5Yya+wBxFFnwEz0Is8SEatSTH8QbjUQQzmCxFDnZLhBEqAmlqysjGk7TeHB/VmfijkgYe8KpMtZF/unE2AueiqZ9ILsdeSxvmIO5M5MBybASPn4A/C25AlhK9OL66CSR6r+BlCl+hkPCXn+0jAWJlI7BRKnIejG+Ccl7gGAuuULPgdiMwTiCIqNJUYjkuDtc5TSJJ8YXnRYa0tkZ7u6Pp3l64v7u3HY62DrbCg1FyEPKpEFv7wyHf5klwe42sbKGVFRYFGW5t4X9dducVmFTEIh6wMx+IVmRgOPDS2vipg9SHolcdxEvBXGSjmwDdVJQhuH5WgTVXuWK4ZjrimWClZpV1kd1yo73PhLdgRJQNnETciiKTEU3b/M0i/ZvVuS4a0JsGk7qUzibRaiK/I58uM32Umygc2o464/B0QkGLnq9D2VeFly7UH8fwuE7IdoJ0mL3RqWLnuYTIBF7dmPSs/kvp2mLGjeFYszCj7MPmiu+XeCHLJIM8Y4epkXZFk44CICnVkHvJ7e4u03Bz6skXNHENAVXlVInfXRy9PjqDJ69OTicX64oxlC5ecoYUsCiUqa9tLJEi62ZfTe2WAtH7/mVT+B525WJszcoT6bKpHV7qkmcMVJlCeYQJ9DijGkVR5ScfLWrtY0SAHpGJboW+R5hJq+mUKS9Zyi0IplleRSkzGOa+NuMXnKVyloK0UQolgAw6FZHOMVegzYmoMo4QlNiSxRVVAWRdKflH1ZCCJ3NWaGt9+mB/+Kqc8TnwxLrWIh9MobdY2d5wJWp2x03z+XZuS8X7IDmId+PdHR5vidEvyZTv7+wOk72YHyTb019mU+oRzgLHkJVndZtbl51dAVyhYced7tjmvZTAkKUZoxJ11A4pqLyCmyh9n/FIpDqDqo6Ngp6xqe/MUK7bzCkViAYMPe2UnhoYuXQZrWtChzBclezIGCAb+kYEwSldQGLDFLZkUx2DNaH9K0hNGQ+C79YGYkqHQx0/IqheSSXCmQGIhelDIkcwkQHFTzLGEM81ISEkWecUjRt04gAsMdhmL3jMzrx+h14ZNKXh0e9A6zFxd+mSpp4C8ea66Xq2Yl/w6d7WwXCU7I04H/4y2t7fnR4kfGdn62D34AC51xhqTaPosn4tlDAycr1c/gkGgYwG25MAxPzxvcXhgYfVbWGHWs0aRiKsBJDIXhy+Z6N9VuMPBoh8yQgqvDxH/FZlGZ/iI4RioLkjfGrkTK6tonVHeXn0anJ5cgFPzo7+c3l0Dp+Q1kpjwbqpYgxLTbU71Z9JYq/AZ76AWwP23FN9DgoBEmoPlO4vO7eY3ICyeZWVMMNzXzOjTZolRuedVKK8AQz+VA7EYAOqMzzLeYkJzi1MABfi8OcTh+ROvCWfM4fyng3YJI6phUFrcosAmD8HQozHMaauI5BUBIw+AyiB8siULmUkur5YmLLrjUU9OWk7BZMDJH84TiZRWYFwbqnRysImWryI3j8gs7NcV7qLltHIpHNYXUWgBc+yOZjRGFxzAQ6ERYllvhyhuywUHlWPaypWu0xSuXvrhHlZavou4pV9RN5BaZYqJNWaLz4Jn3zYmH01Im/UbvIVybdamuxHNe5qFk816ulzt8/dPncfk7vLX575pbf/lqDP9ir0uVT1tgQosQJ9DEWP0kt7F86RGwjCPER68+ECEvt3oXA8YHrcX/iO+Mi18hXhJ40/3PMpwo/GWd3FKQhIdnQaJLT6GJPcC4nJUM5UO6vcXmkzlRCgag1EhKpp2FxXDNGsqZSipYbdYLEWVj3B9cqnxboCKyByVXFYaKnKHkn2SLLvRn03+nm6UY8k+9ztc/fHzN17kWQjFWWLx0n+nYyLNP+9e4sIA1j9Eog1KdfsuLfRChJjDcYKusghmA63p9vJfiRGMR/FezsHyTDaG/Ld/e397elouB+0e/3VIo+bJOvmVMvfzo9kYgBxnwDHVQpfJJVax93tPzCvEQmWNSw9DW4Gm4NJrxfYcbSKHd/pEnQDwoAdzR3bi5dnJ27b1JFHu+nKRLTX6d+t0tY3QkqMYbC0tGUPHXvo2Lefvv38NO2nh4597va5+2Pm7ldBx9FD0HH0FdBxxBBiJQix/k7oGAPuQGiWgFPwEF0F5lUIGwtQBT753Uef9iU3M1E2QK+DIocHa44tac3ecjWvwZLt7ESqhbmwvOHhCBxr6rEwgLMZlEjFoGpJQLcYVTIXiEkhflgmc0l5jAoBXTMPJ0kJWrmcqeOt4SJVlFUgIRWFTOPeq4YYkxBOIkH4BxRoH3QGhfo77nF6b/2l/WB2hhqfoMbs6Is7gsaa/d/ddacEjkF4g+Xi3Pn6juMCbs+cK1hGiC+FK18NBO2heg/V+3bft/ufo933UL3P3T53f8zc/Qqo7tHQ3VAdBjwaqsPYwRZrsNQrDK7/O2KnVPESUHgzHRFWjxcY/BbPobqTwsTk0rp7N0BhUpUpZuZ9NzeCa7wAkQsIRn93B6sQXtsYB5t+UuiPOofOtFCcNm+W73LcBigHAk6na2UyoJCWZWHHm5s3EALg+tsBL+SgPvGr9OdBpPPNKdh9TUnDE6wufXEA3QFyDAbkNCMxL1wRJeLOhWQmzABwJR1auJeyO6Ob4JEIKJtEZgMPt/sYpccgYgELlCeWRg8oJlf0A70uTXb713VxhO7QZZ357uUG4xlIuqQiqnC9CJtzRPOO+0rwLDoUvkcYrjA7xWFD9kJwA0sNd7Tm6ZsPF8/YDDEs1ZDKInwWEhcdkIXvIUSoRk7qYyY4idqW0dUsJcEnnYM8mJMsyUBh9lGdC8Gu6gPn76B5nEG1J5PiJEEFBmddP629E4tPIsO+OlhYEgNPxmoTLLTJO/OeUQ+lxYZU8DGnp4OPKmQvJZY2vHdDY7yK7rj+VVHrxVt6fasQ/6qphY5aSNTssyUpnGmvIncwPILCgCR4Zsla38zc0Qtb9HBlBk+Q6rIMaAkvR/f4VVR77Zvl6NALkV5Xjo/qQyqhQXenMVfNmIX+msXsmEWp1lb8mzEMHUyDq1kFWfTNYn1GpiFlRDjcaokUOpahDAFuknwnkBjKBROfYrsntKPdxgul5K/kWcj5X+ka368dnenxlVQkdawj+80yI8MQGYauBlgvv2t6GFiQ26iDu+9FAXC48D9VAi9oq+45WmurOpHfpDnYGvAaIVGxxdj9MV4UOP/JXTbE0c0YKMOI1psDafA387Sw83WMVe8zLFtwVd5MQ8NdspuTt3lbik34n6YvajxZbMecqmz+vav0HZXkn1N3/6aK11ean7HSePyM4UZs/UKjHeQvPF5b3R7E/etUwL/wLeUqQXVYCNHSjlBMm1CR8RKjmrI6SqWgjYUC8DNivw2MLJ1TJhZGY/rD8pEIzfD2H6StBUzKpzIDerT1XXPmlDAOWKJfOd0+9gcxtL9bOGAfYK2nInALrvPwCDB895v2C75z8Mx7dCx7WTsbQFeeVwpv5oHYVc7wNuMDERFLG1WucMGyT4naFpqgXzOrzmIMNVRhQCsek9vTBPesJV7iCx7JC/xu/YY1mB696C+bLxQ5E4vL0l3Y/hBtiLYwFVmBK02ougDARIvD2+OLFYpATPm3JNrMNv0ku4lj8RouKO/CZ2ewPdgKabmAdyi1LWFh1iL+WpSrPy6AWt5x0Xw5Pm8We/j9byj8ML+h4Ns4yrxZ4GYkBkfl1oNuUX4V3Lkoh/njlZ9YgHVeCsGFE29ucCMLl6m3+PiPSuAuydX1YgVKK3ewCn6Og3EC5Xj5hxfacfXU6xs/Y3f/HMNalepdWDVfbMAE8BGcE6z5nYjb69v6hxNIRDfMbcS1CKy8qupsbbw+wnTldwAm/wHMAS3hfxpuKgQ= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 contibuting feature summary' (get-outlier-contributing-feature-summary)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get identity outlier contibuting feature summary

+ + + + + +This API returns a summary of a contributing feature for an identity outlier. The object contains: contributing feature name (translated text or message key), identity outlier display name, feature values, feature definition and explanation (translated text or message key), peer display name and identityId, access item reference, translation messages object +Requires authorization scope of 'iai:outliers-management:read' + +## Request + +

Path Parameters

+ +Succeeded. Returns selected contributing feature summary for an outlier + +
Response Headers
  • accept-language string
    + +The locale to use for translations + +
Schema
    outlierFeatureDisplayValues object[]
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-password-dictionary.api.mdx b/docs/api/beta/get-password-dictionary.api.mdx new file mode 100644 index 000000000..e629129aa --- /dev/null +++ b/docs/api/beta/get-password-dictionary.api.mdx @@ -0,0 +1,128 @@ +--- +id: get-password-dictionary +sidebar_label: Get Password Dictionary +hide_title: true +hide_table_of_contents: true +api: eJztW21z07oS/iua8IGXid02DZT2zp07oQWmZwr09mX40HROFVtJBLZkJJk2dPrf7+5KdpwmpcBh7jkwLjMltaXVvu+zinTd0YUw3Emt9tPOTmci3CG39lKbdE8m+JibWafbcXxiOztnneola7w973ZSYRMjC3wCRE6m0jKgZFlRDU/r4WysDXNTwbSZcCW/0NrxUA2Y0x+FYpfSTdm7o9d/Dvbe7L9lvHRTbaSbMaBpxKdSGpHCUJbwLAM68HRwuA/zT4DkyuVkJmCwYolWjkvFMqmEhZncMW7EzlBtxPAuz4Vy4V1E/I2lsY4lU2544oTB9R8+eNglWiPBNnrP2amSiU6BPPwqtFQgMS4g1MRNu4yrFFdgcqI0Mp2WRqoJK4xOhLXwcah6MRN5AcLRwkO1GbNMg2SCHiwwQg+Ia+u4gZVIUcOOH//vYQcZBBmtTEVQEXDZoNYlYkZYkps5I7iDcdwyYC/nGSmoVsJQ9WO/ZtAbsu7u0DH9HTHpWF7awKDnT2kVXU6lE7bgiWhoE5WjVTa7c4QlLsHI+lKk/xoqFn5yfiXzMg9aZnpMXBGnoIDVVhkq/Hd4l3fkHNlwtYfk2pCqFet1n66vB6945IeUyqEqGizT6+4tH0L5Gsp/HKMECxyEtVFh1cKnJ6+i500VoIZi5P0BO+Z5kTXU78SVJ4GvLy4u/KhVMtqcQgUNX40PTiPUn6fHd08ET53KkUQvwVekxk+XwrjZUPFRksJv/Bmqiil4zb9c2UsbeILEYUVSYvhC8rjunFphdtHLrtwA4hoTikzVTjU9mq8d5VzxiUCF7oCjpp3zG0gz4LwFeLiAVHTd6a2v43+LqWew0j+recBPcHKciWysFRkoHv+yyVTknJ7PCgGkrMNw7dzAT7fTX7XYbibR4C+NgZQWsSPhSqNAWXIcQu1TiUof6ZSyl1SfeSbTeJELXhSZTCgLrn2wejUvevRBJA4mgkkgXzvpVZAKcJtsF/x8me/bSfkVeGE0MSAtcCiIZYoSoPhZpujS5PaeZBVWNA4ZFlfkfkAHNBFvsBc8BXm9fLtBGFCTA8f9CLSwltzHEIQpzGfVFCbTujSsWFZsCT56tr7d64+f9TnvPe9vbD0dbY/55ub69tPtbVw9h7QKTmMba3Nj+Gxp6ddCCSMTH6DyCygEfAx0TwzQ4jAF/D6399vAh9L94mJ9CgmhEjPwS6EM5YK92D1k/S2WcTUp6Tmf3FKCik6P4Ykqs4yP8JEzpQDJPeF3Rk68M99mRagyx2jbe/lqcHpwAk+OXv739OUxfEJaSxV8oMBbU3RLYBV8YaovfZr1AlxC0bAiA3WINGZPAtUnIBBXtjlQ+r/szIIywbfGvMwczAirr5jRJM3GRucLoZT45MEeyVjEXShw8CznLpmyEbcCKwoNfzJIElG46CBo8gmbQg4R5nHMBmkqKS1kDKIRiFL2h0rJ0xRD1xMYlxDKgkqYLh0WB5mIRVvMVbloDQgC6WjEQdMoGBzA+f1+MkhcyTOf3ptRWHtLYDHYR1RlZpG7k4bSSKUzqDCQDxE1zUCNxoCG2Qhkk87WlV+i7iHzVuPqjIUpsBKL0t0bz8ye0/Qu4aX9hrg7xGQbkWj1i88iBJ9FyOKzEVmjMlPISPASxabJYVRtrirwob6JLG1jt43dNna/MXZvvzwKUCm8JeizsQx9TlVozLB4LkEfQ96jdNW9+SYvGLILnV8Fkf54fxLaPhgvrgps7n4iPvKlfAVIrOzhn4+q3qYq/XNbIIOkRy/BGDKRSHeI7znHpCivqs3l1V5pM5LgoGoFRISsadhMl9TrmFJRl8WhmUi1sOqhY1MO+ZEn2DD6DIirqjSivqZFki2SbKtRW41+n2rUIsk2dtvY/TVj96tIsuaKoiXgJFvmOX6BQJ4W3qO0nMGAetOO1SFHprqNVpAYqzFWZxE5dEa9jdHGeCsR/ZT302eb2+Ne8qzHn25tbG2M+r2tTrPWn83juA6yxZhq2NvbkVQMIO4z4LhSgXNZp3W6uP0H6jVijGkNU0+Nm0HnoNLzOXbsL2PHt9qBbEAYsKO5Y3vx9OgA6eN2MZJHvenSJPgFS1Cd/9oAISVtc4sraV0LHVvo2Jaftvz8NuWnhY5t7Lax+2vG7ndBx/590LH/HdCxzxBijRFi/Z3QMQXcgdBsLPHMCEtKUK9C2FiAKPAp7D6GsHfcTISrgd4CiuxtL6PIE63ZG65mFViyCzuRaq4uTG8wNsexphoLAzibQIpUDLKWBHSLXiVzPJ5iwH9YJnNJcYwCAV0ziwZjPOPhY6byt3oVqZKsBA4pKWQa9141+JgEdxJjOnphZrQPOoFE/RP3OIO1/tJ+MDtCiQ9QYvbyKhECY77e/3266pTAPjBvMF0ce1vfcVzA75lzBW2EuCp8+qohaAvVW6jelvu23P8e5b6F6m3strH7a8bud0D1gIbuhup4tvZboTqMjddZjaVeoXP93xE7hUrggNyb6YSwejrH4IQrwJXCaXrMIRyPunbWVhxz7eABWUSFnqHSZDBw6lxhd9bWrsFOYJ+bmBcyhvQFpnIzpS/jROdrI1DOiryDx0x9jOEAPBofWoyYNGskOq/PdETc65lkQTcFfdPJgq9SVjwnA86g+2CeTJeBowdHosfAYgFdxENLo2NynCX5QK5Tk938dVk8oTtkWaW+r64G4xlwektEFOF8fp75GCG3X33pVPO8jOBmf29psXc4rMdeCG6gH/DnXx798f7kMZsg0KRAL/GCABMSOwMIlUNwEUpkg+osCE6i2mJ0OZkS44OF0zYYOGycgcBsqI6FYGf7QQlvIcMfQUomleIkQVkAZ50/qqyTis8iw+IXzzWJjidTtQYaWuML8x5ToaOOQKox3icI1zoiticx/0gs2DgmiEgNHjsrKrl4Q64fZeJBRS3y1CKiZh/f4sKr9izxp7cTiF4kwTNL2vrhxT29qEEP2yd4glRv84CaCHwsnpFKKqv9MB8L9CKkt8jHUL2fSqiii9OYT1rMQhHMUrbPkqnWVvyHMXQdDIOzSQlR9MNsXeKiEUVE1FtvsBT5JSMZASYk/g4gMMItDD7CmkyQRPvdEQrJC7IsxPwFXbS4WJCZHp9B6cSRqU7sD/OMC0a4YORzgA38+8qEjgWxjTJQHvAOsDu3P2WCwGgj73laK7M6kV+jOVgaEmCVqNhix/+xM09w4ROjFzi6HgNpGCF1fWoMr38EWlieFpRVbQbc1uAyv5mGqnhLb57f+itNrJT/NHlR4sF8z+SdymY/O0vfkUn+OXn3b8p4bab5HTNNALnobrRs6AaaTv4i4LXlPTzcZJ4K+A1vKVYJT0O34q8LIoppEioy7tCrKaqTqRTU/ReCO8R+XfQsnVMkhluVItyLnNDtRgMsc+jXZAb0aH+6WpnuZSoPLKt7mrYMpyU0XsFTExGz99CQqQTMgs0YntOFdx906MqOwTKHaFi2VxkbQFeelwqvqwLbZc44uNQ9HpFKm5Q+cUFvpkSlC03Qr55VRTG6GooQU1ticvtujBvL0LM2DH/PWmB3G3aVQfVoRUTp2PHUghyJjDwTxy3C9vtog7dFU5EV2A5C1hV4726+wpv9kyWKQEyFrzK0mayFSXYNxwIRbI+8+2zGG/F6RO0CPC+0ddDANoi/Fo6tuqF8yw2v5/vp7V3l9q5ye1e5vatMd5UDHmzcC74Jqeo6bOKcdVZt4px3O1PIRfj6+ho3J3FX4wYffyoF7nydnc83LPAvIOs3KWnX56OgzTHaxpzvfy2wcd7YVHr9EjMovwPDhg+4yM3N/wAXsSgU +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +``` + +## Request + +
+ +A password dictionary response + +
Schema
    + +string + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-password-org-config.api.mdx b/docs/api/beta/get-password-org-config.api.mdx new file mode 100644 index 000000000..75d455beb --- /dev/null +++ b/docs/api/beta/get-password-org-config.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-password-org-config +sidebar_label: Get Password Org Config +hide_title: true +hide_table_of_contents: true +api: eJztW9ty2zgS/RUU9yGXMiXfPdbLlGI7KU85Y68vlQfHNYFISEJCARqAjKNx+d/ndIOkKEu2s052N5PSSyKRQOP0Fach+CayY+Vkrq05TKNONFD5ifT+2rr02A32rOnrQbQS5XLgo85lVL0T4U0RZkZXK1GqfOL0mL92ovOh9qJ7ciicygtnvMiHSoyrydYNRMICREucqj8L7ZQXx6dv/ujuvz38fSXMtJnCSCGLfGid/otXEj4BXmH74plOTaeSGENiHCR2nJLpM0D2KimczieAfRNdeOUAOVdf8i7kkSoPzY+ubqESQI2t8Qqa30Trq6v036yap6qvnDKJErm9T8UWsCS0tMlJgByPM52wMu2PnqTcRD4ZqpGkT/lkrCDX9j6qJMfEsSP35DpgSAqf29Gh8bkrEpLgD4zsZSptTO1Z2E2a6K5HDk1Ky8Kg10MFqE4EaVPIuiFX9JWE45SAG1VYoyXOoWCq+rLIcvFZZgW/7cvMqxYvx2+iDj9ZidQXORpngASh6hbv9UDn5/aTMt8C+n2QA3tD0Pvov4pzvwzvt9oUefBAiVfDnQPlIK1v3Ujm4dHG+pwCDKUUQ1F7F742YhSk3wN7iyBjiB4Vo6izhs/yS/i8vdrQZauhx9rqjBZHygwo4p8GPuPZC6Dfg3d7Bu92A+/aLw282w28u7fAm+ucPkfzxee2MfTBFCD/Pei+3YVBWIbBvMG2b28J2eaixN/LNPJZHDiH2IxRw6jKKeRQn8uAQ01TPhc9m07IKtrAQDr9jqUgVbnU2Z5NVWMsjKLNYM6Pr7VR8cBJTQgVQ04wUUDiZ51ihhhZR74kkeRqUoHHEeDa+GSJ1pp4JVOu2aTfXqkMOdDJ5BNkHaaPA7owGvNFNUXoVCAU71tW7SjZ217dXd/sb29Kuf7L5trOVm+3Lzc2Vne3dndp9ZHyXg5mclQ6JydzS79RRjmdiMwm8MhfMAjqPWzPAHhxTNG5GvnHfcAyvsL+nEc8tlazxCtoQ1oRUrzaOxGbOyKTZlDwczm4YwQTX5zhiSmyjAK3LldB8LFD+JpFUJSh5LuM9g9edy+OzvHk9ODfFwdn+ESy5nburkG0VlUXsTC014y4VOBaeuFVBnNQpX1ZSn0JhWS5y5cDdfjmJx7GrOoEZpSrL5jRFC36DltTM5WSsHuL57qlWiuiR89QvJKh6EmPCXAhDX/ZTRI1zuOj0pIvxRD7uXIvWqKbppqUlFkoVx7zJxAkZJpS6gYB/YL3k2sN1lHkwthcJ2rWF1NTznpjWsWOmk6h5ADyx+Okm+QFwLGazSyso6WEWPoHmIPlZtGdN4zGJp2YXKJUYmQ2gRmdg4VFD7rp3IuyHJG7PAqPqcbVFatZnLncvQ1g9nPL7xJZ+K/Iu5MM5Sdm1eoXn1WZfJ7oU6hG7I3KTWVFKrkVTy5H1e6qEl/0tcrSZe4uc3eZu1+Zu3dfnpbtTvmWqc/aPPW5MFVHBiXmqE+g4sbeaduCI1eonysp0m/vzgOVZOr+ZYwW8Hvyo7CVz4Hv1v4Iz3tEP2pnzfiCALIdgwZ9VCKVdhj3FDEbKphqY36119b1NALULKCIqJpOTGwhJEzmCmMIifQrIrXKm2e5GErUR4mM8D5UQG5x0nhswdaXTHLJJJe70XI3+nl2oyWTXObuMnf/mbn7IJOsUXG2lDzJF6ORdJMQaeV70lYKDBDVwbuoU45ddZetkDBRc6xoljlEvfW13lp/J1GbqdxMtzd2++vJ9rrc2lnbWettru9Ezb3+cprHdZLN5lTD38GPbGKQuM/gcYVBcPnc2nT2+A/mdapPZY1KT82bYXOY9Krmjuu789zx3FrxVppJxZD8DIc0UxtRTcPYEY111VgMkGKAumgESpUGLgolPVKQ4hA0ItMjnVeH5ZDrJnG3n0OVkChVkNWraJNkBRByJcgssWaLwNJQUvWJ80ECM9gBqvN3ZKeli76JyYtT0viINBYHXxKlKNFr5r616Hz3EOAd1Yiz4OB7DnpDtyMNAgANQahZNe9c8vMlP1/u8cs9/ufY45f8fJm7y9z9Z+buf8DPSzZ0Pz/HgK/m5xjbWhU1l3rNv/3/r2k6p0qJIFxWsElSOD5urjg48wqEUnkDimqIpCsAUXvBDSG+W0SsMAAqXIaBwzwf+067fQM/wT+3LTnWLZQvuCqfGHvdSuyo3YNxFtQduiAQcowG8OWnsECLLes0BW+odCw82Lm8SRF52JvPhB+UbOSIHTixBWobi1kRCPQykPgxII7RRTzzPLrFgTOnH/S6cNntt+sSBN2jyyLzPbgaxgsgvaMiqXA1vQp2RpQ7rD53IWy6jVCbNn8Z5piGrYtXSjr0A+GXi+e/vTt/IQZENDnRC08cV2m+qSTFCUKEC1m3OsWnSby3OFsMhgy8O/M7CSWO6GdQWLw3Z0qJy8PSCL+jwp+iJLNJaZLiKkCzrp5X3knVZ5XR5teaWpICT6emDQu15cy8F7zRcUegTbgLhKet9yYW+5rqT7gJhjGlitzgictxpZds6PVUEP+qpMVBWszS/Is7KIJpL5Nw7yZB9pIImXm21pMXD/Lihjxqn/CEpN7FQJYoccz+upVUXnsyjhl5McmbxfHevBtq7KKz00QoWsJjE8xScSiSobVe/SoEhQ6lweWgQBY9GdY1LRpzRsTrqw1IcVgy1jE4IeM7QmKYEEyyR3syUxILtmbSkJIf2LPI+Q/omFPxYUZnfnyJrZNGpjbxT8ZMC8a0YBxqgC/xh52JAotuvkGHcKWSA2Bv6n+uBCXQRt0LshZWdRbf5jm0NdAFVZbix53wpTMtcNV9OX5Bo+sxKMNEqevf+/BdlLJoe5oxVnUYcNeC83gzi13xjt0C3vowinbKH01f0rg7PTM5Ntnke1fpeyrJj1N3/08Vb1lpfsZKU5JcCjdetuwGmkH+quRr82d4dMg8VPgXbzlXmU+jW+H+i1lMU9A4kzlFNWd1MtSKu/+xkjlxvxWKLDviTESjTumPHo8FDRzGIG09OKns6Qzy+Hy6WllywgRiSX6l777gFoTWSoboJlVLvENDZhK4hZoxumGBdx9t2ZWdwTMn5FixXzkbpGs0KgxWo7wsRkIipB6JiFT7pAiFC02BUZUtLFO/elaVxRRqpEKL2xI38sd9OlhGz9pw/CNrwe++PFWG6cmLxNKp46kVOVUZRyaNm6Xtj8lGtMVDlY2pHUTVBQFTjRXeHp7PSYQw46EX2m60Ru1ykm/TWAih9iiEz0ZrrbUac7uA52PrczSwDeFvVC7qPys5dgNR/9HJTBjeTM/Tf4S/Lim3Ieof2mM68SLlitDPhN7xMlrUO6IbGcIE9Prmhs5EqJm6pcd/Fooa7suraZ9E3yA2nI1ws/lJcU/OpyfTtnv+9wXqeuqO9s0BuU/es4GWH2ip29u/ASYPRss= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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' + +## Request + +
+ +Reference to the password org config. + +
Schema
    = 1` and `<= 60`"} schema={{"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}}>= 6` and `<= 18`"} schema={{"type":"integer","format":"int32","description":"The length of \"digit token\". The default value is 6.","minimum":6,"maximum":18,"default":6,"example":9}}>
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-password-sync-group.api.mdx b/docs/api/beta/get-password-sync-group.api.mdx new file mode 100644 index 000000000..0df143ca4 --- /dev/null +++ b/docs/api/beta/get-password-sync-group.api.mdx @@ -0,0 +1,95 @@ +--- +id: get-password-sync-group +sidebar_label: Get Password Sync Group by ID +hide_title: true +hide_table_of_contents: true +api: eJztW2tv2zgW/SuE9sO0ReT4FSfxl4XbtEUGaZvJAwU2Dba0RNuckSkNKbX1BPnvey5JyZbtNGkn2JkpBBSpLZGX933PpcmbIM2E5rlM1XEcDIOpyE+5MZ9THZ8vVPRap0UW7AQ5n5pgeBWU7xi9ZPatCa53gliYSMuMyIDIxUwaNjo9ZlrkhVaG5TPBDM2Y0gw2SbV7lIlITqSI2fFRi41Ynv4mFPss8xl7d/b6v6OjN8dvGS/yWaplvmAgqsXvhdSYkKcs4kkCMm6pFpg0IipoIBi9CS6N0C9SlYsv+QgUiHkZq2HmBQiJndCyE8654lMxFyofasHj4PoWEmVc87nIhTaWnCS5Mg5CO4HCC3yTMa0ZzcScB8ObIF9k9NTkWqppcLsTlLwGw1wXYlNHAlKzdMJKllY1BPGgOy3FJ0GSiS98niVEfnBw0JkMep2wN473wn630wsPo/298EC096KoJ3p7cRwQ/1qYLFVGGOKt227Tf3UOzsREaKEiQauRObYwQotHpEWVEwGeZYmMrLfs/mqIys2mBtLxryLKMTHT5Fu5dDxAXRtaWleKU0jdW75D/NJE6xK/xdOtC6xztVxwi8OzDq1QKus0hUYWx98kXKXozE6uLdiNDjsH7YN4v98f83Yk2p39/mBy2BsPuu3+XtuubdJCR+I4NiuLcq35YmPNE2nymo85X4eJLQkDFzSYJHMxN1uduGLsquSsPxi0J/29eNDuDAad/Zjzw26nvXfQB52vD4ETXoNkhCDLxQMURiESYyjjCgEvYTsb7Sth8pkbVpLbCZBW5hx+GtCkkCbUNdvu9sJ2L+wMLtr9YbuNf/+haC6ShI9pBIUp+JunsU1Kj8VgwmGDiugjsQk+c5nXXHSZr1ft5gLvYYFTpbbtXr/N6e/315q7PpYX3ZIC+tuy2otEIlmxl1qjyITszFYgOLx0oUdJWcAe4zS2BUWqTzyR8SPmuVjkXCYv0ljc70CvpBIoQlwSh8KyHGEiA8VPMsYM+I2Gj1mSZfaw4+pVAZpoddhzHkNeJ98LLwz5iebRb6D1kBx1qSTms3IKk3FVrLcsK/YFHw/ah93+ZNDnvHvQ7+zvjQ8nvNdrH+4dHtLqc2EMMs79qeq1UELLiCUpCrv8AwpBYEP3lgG7+JZEdYcNLI0H6J8C2I2txPT8MgIOO4yz5y9OWX8fQaymhX3Op2tKUOHl+bY84gi/03Iq1TZWhCrmFBFHL1+NLk8u8OTs5S+XL8/xiWhtoKqRgrfG5JZgFb4wSz9bjr0AlGqMSKAOEbfYM0/1GQTiHoH5gbLEYwbKhG9NeJHkmOFX3zJjlTSb6HReC6XIoSz2RLZEa4eN6RkSXDRjY24wASak4c9GUSSyPDzxmnzGZgBbQj8F8otjSULyhCEaQRTzFyDEeBxT6DoCkwKhLCw8TIucqTSX0Ro6Wqqybo1lsjxZNQoFBzi/309GUV6AOSvmahRW3uJZ9PYBz05zde4uVpRmVbpQOY8gBYDsAmrUGhpmY8gmc8N8OiJzGSQeVY6rMtZqDbDp7o1j5ihP7buIF+YBcXeaIP2EVrTqxSfhg88QNnTZyFqjNJPPSB442sl+VGWuMvAZyl4SN7HbxG4Tuw+M3fWXZ76X828t9OlsQp9L5XtlKp4b0Edb71Fp2VD/YeGNN+QOg0I8RPr5/YXvxDFefMmoh31EfORK+Qbzo8oe7vmY4EdlrJotiEGrRyfBBJlIxEPL95Jjqyinqt7maq9SPZZwULUFIiJrarZIC8ahMl0oRZxws8PiVBj1U85mHPmRIyKMcRmQVlVxmKVS5Q2SbJBkU42aavTjVKMGSTax28TuPzN2v4okK65stHicZIr5nOuF8zT/nqTlDANY+asCq0LOmmodrRAxVmGsoI4cgnG3M+5M9iPRj3k/HvQOJ91o0OV7+539zrjf3Q9Wa/3VMo6rIKvH1Iq9nR2tigHiPgHHFQrOZfI0jevbf1CvFhNKa5R6KtwMnUOl10vs2N/yK0KaQzYQBnbUd2wvXp6dEH0sbcmT3uwmKMFspzoM57mFlOTD0LQ0eQMdG+jYlJ+m/Pww5aeBjk3sNrH7z4zdb4KO/fugY/8boGOfEcSaEMT6K6FjDNxB0GwCo0CGqIB6FcHGDKLgk9999GGfcz0VeQX0aiiye7iJIi/SlL3halGCJVPbiVRLdVF6w9g5jdXlWAzgbIoUqRiylgS6Ja+iEwjApHQiIZFzaeOYBAJdvQhHkxxSuZgp/a1aRaooKcChTQpJSnuvKXxMwp3EhOAfKNh90CkS9SPucXpr/an9YHZGEp+QxOzll0gIivlq/3dv2ymBYzCvKV2cO1vfcVzA7ZlzhTZCfMlc+qogaAPVG6jelPum3P8Y5b6B6k3sNrH7z4zdb4DqHg3dDdUx4MFQHWNbbVZhqVfkXP93xG5DxXNg3ZulkcXq8RKDW1wBV/I3HCiH0FH+YbC75T6A2b2R8W1A9wkIGzq2Cp1g+CzPMzPc3b2BtWCl2xbPZAtJDAbLFyr93IrS+e4YKtqSfeiwqYs0GmCvR7gFWla/WpILu3xniTttW4nIWaF1e77gq5SVP+C+QA/CHJkdBnf37mQfg8UMvcRPxo5uWffZkA9yXerk9s/L4gjdIcs29X11NYxn4HRNRBLhenn945yAt1t94xLIspjQln93Y7F3NKzLnguu0RW4UzBPfn5/8ZRNCW7acC8MIV0hqT9AwJzCRWw6G5UnQmiSrTDwpunMMj6qnbmh8GGTBAKzD+pcCHZ17JXwFnn+DInZqpQmCZsLaNb1k9I6sfgkEiqBraUmyfFkrHahoV1em/fUljvbF0jlzp7jaeuDCtmRpCwkqWzTGC+ibfPYVVbKxVfk+l4m/lVSCx210FIzT9e4cKq9itwZ7ggxTCR4Yqy2vntxRy9coUdNFJ4Q1XUeSBOej/pJqai02nfzUaMXEr06Hx/U+5lELa1PYy51MYNSmMTsmEWzNDXi34yR61AYXE0LRNF3s/WZFg1tRITd9gpLoVsylCGQoeXvBIGhnDPxMVVmC0xSt0diQ/KjtSxi/qO9FfGxJrN9fIUCSiPjNDLfzTMtGNKCocsBxvPv6hM5FmKbZLB5wDnAi6X9bSbwjK7kPUdra1a35HftHCoNEVi1VEw2dF+GywTnPzH7gkZXY5CGCVhXZ8foCpunRUWqpqxyS2Bdg5v8Jilq45reHL/VD5tUL/9u8pLEo+XOyTuVLB47S9+RSf4+efcvynhNpvkRM42HuuRudlnfE6w6+XOP1zZ38mireSbwF29trFpUjZ7FXcglFLNKKEt4Tl5tozqa0U1V2hoXPCfst0Oelc5tJKJdp/BHp2cJTe19PQ2WObo2mYCe3aUuV+Y2YBywJLvSd1P4MxMpXBI9pWix92jLVASzUEtGp3Xx7tfU92bnsMwpGZYdlcYG6JrPC0X3iMF2MWccLnWPR8TSRIVLXOjQlCh1kVroV80qo5hcjURo2eZEz827CW0vo3NdMfw9a8Huxu8tQ/VkRX8lbynImUisZ9K4Omy/jza8LZyJxF4QRNYFABMrK7w5vtigCGLK/6CR6umun2R2aSyIUHvk3KfX6rTaoW0X6HJsanK0sSvEX4ucbbtVOF6w46N1Z7xZ7q3/VXfJfQGizmE3ox0vEqtwnYzrHa+Cbb0jpg5lTFfiZ9ABjbq5oa0R6qZu6fHvhaC+++p62SjZBhM2os/oUCfIGuvXxVc18uTMM/7U/rjz4EvkW0Uqt/rUYtnlB/j4m6DNAUl3yTHK7d5YPt0Lt7+zMmXjFxDqyKqe+/VLci1+R3H3H6ATpK//AWQ+ZZ4= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-password-sync-groups.api.mdx b/docs/api/beta/get-password-sync-groups.api.mdx new file mode 100644 index 000000000..29180f657 --- /dev/null +++ b/docs/api/beta/get-password-sync-groups.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-password-sync-groups +sidebar_label: Get Password Sync Group List +hide_title: true +hide_table_of_contents: true +api: eJztW3tv4zYS/yqE7o92jcjxK84DOBy8ye4ixT7SPG4PlwZXWqJtthKpktRm3SDf/WaGlGzZTjbdLq7dnouidSRy3jP8DUXeRboQhjup1WkaHUVT4c64tbfapBdzlbwyuixstBM5PrXR0XVUvWT4loXXNztRKmxiZIF0gMrlTFo2OjtlRrjSKMs4y6R1TE9YURGwSGBKBNpsxJz+WSh2K92MvTt/9Z/RyZvTt4yXbqaNdHMG9Iz4pZRGpDCUJTzLmAtc2iCfFUmJA0HGu+jKCnOslRMf3QgooNwyVUcV6xhZx8Q6zrniU5EL5Y6M4Gl0cw/KFNzwXDhhLJGTqNIvpTBzYKTgDfyZyVy6aFXvN/wjU2U+FgZVNcKWmbMor7dD+wd1IQS7/mefjHPhuEo5mOJYZ5lIkAY7q1nffDtzrrBHu7up+CAydFPbcpkVWirXTnS+Czrt8kLu2kAnTmo68UKFZ2yiDcu1EUwq+JmTs9FmlUGjownPrNiJxEeeFxmo19vrgEmTmch5dHQXuXmBOgNfMRUGZnoy/lG/Bw9yqWRe5tERzMv5R/+bqKRiwsEK9Nf9/c5ma+rJxIp1c76jxyA2WNDNBJuU4HVvVQYv2uzKlhAIc2YLkciJhNigAGqRd1po+IJPpeJOwHzw93RGdIJjvhp3/A5n1OZ/2PiJLtW67U8nrOVMKVpMOrAqGL7QRZl5UwrW+ld8qR3P4mOc3UKTFlpZwWaQRRD+5AccuCEdZhwo6jJL2ViEzADPyUntN7Afa/mYaLFbgaaaKrBYCh4Dn0mVCKoGwjqpplBcHIrCSBEoDYrN+AcBj8FHZBwcL/OCJ24HtaFaAh6DrE+BsdIOI8UK5NoiIn8nzVsoE0n7gWel8FbA0SB2aStpvooIQn02BNFY60xwFS3FCc28xypYudTihF6ng/9rxsjo8aoOZBOswhBdMJUXRSYTknX3J4vz79YF4sZwDE3pRG6XnuvxT2AHeFEYtJuTXiqZLo2xzkA0rAfyCQqIobiQLVoyTTQ8OOhOhv1u3B+ne/Gg1+3Hh8n+XnwgOntJ0hf9vTSN7qt0WbXBW3i6kcGqVAuGG9ZQ1kUOlRXPNFhqfvqblKs9UNDkBsNectg96Byk+4PBmHcS0enuD4aTw/542OsM9jrE2+rSJOI0tRu80eT5etXnfg0F3xMJy05P7AYXBg3ulwS7riQbDIedyWAvHXa6w2F3P+X8sNft7B0MgM7jQyAsb4BkAou3E08w2CWYKsUihjXGyVx4FLHwHLvlllXkloorTopxQtOynV4/7vTj7vCyMzjqdODff2NlhYWKj6vEA/lyndL69KUEzDj4oCb6hcQEOZ10jRCtMWB0j//sRINNdeA4k5Dk7IUxUJhidr5U0v1yS6WajXVKQE4qqKcy/Zz68EAdSIWDQnqsU/FpA7+USgD44xIlFCRyAhMZUPwgU1xPqLR6klV20bh2w6ZgiXaXPecp6Ov1Ow7KoB0NT34GWk/J4SslYT6rpjCZUoF/gK3YF3w87Bz2BpPhgPPewaC7vzc+nPB+v3O4d3iI3HNhLWTkp1P5lVDCyIRlGgC1/BUMAoEPticBiPnTazHReIL9McD92FrNIC9DwL4D6/bz4zM22IcgV9OSnvPpihFUfHWxKc884XdGTqXaJIpQiIuuo5MXL0dXry/hyfmL769eXMAvpLXWyIwURGuKYakJw8z0LUkcFMBUtAKXaEADrBWotkAhruzyQGnDAmHBmCwstjAjcN8wY5k0mxidN1Ip8d0N+1a2RXsHAAmWA+6SGRtzQCYMXEgobZQkonDx62DJVoBnz6DjSlOJSgJuInRjYf4ckQ1PERRJFRA3pLIgNKdLh+BHJqLpi4Upm95YFJPXy07B5ADJPx0no8QBuKeYaGRhHS1BxOAfkNlbrind5ZLRyKRz5QAHyoT6hkQbQIJQmUA3CdA0lCN0l4XCo6pxdcVarpFU7t54YU6cpncJL+0T8u4sg/ITk2r1iw8iJB81jL4akTcqN4WKFHohmhxG1e6qEp/BspCl29zd5u42d5+Yu6svz0P3E94S9OmuQ58rFfaocPFcgz6GokfpaiPrV4I3wZE7DAwSINJ37y/DDhiMFx8L7OK+ID7yS/mG/q3yh38+RvhRO6vhCxSQ7Og1mEAlEukRyb2Q2INEMlV/ndtLbcYSAlRtgIhQNQ2b65JxMJkplaK+3u6wVAurvnGho4eMsNZXQOSq0tg3z1skuUWS29Vouxr9ZVajLZLc5u42d7/O3H0USdZSUbYEnGTLPOdm7iMtvEdtOYMBi08rdcqRq1bRChJjNcaKmsghGve64+5kPxGDlA/SYf9w0kuGPb63393vjge9/Wh5rb9e5HGdZM2cWvK39yOZGEDcB8BxpYLgsk7rtLn9B+Y1YoJlDUtPjZvB5mDSmxo79g7XseOl1uwNV/MKIdkGhlQLG2FNg7E5jjXVWBjA2RTqosJPQhLkwlDCvdWYGdxrpe9OmLyoBdA183g0caBK+JoVgqzmIlWSlSAhVYJMI2rWEFgSPw1NEPMBBUKwU6jOXxCdBhf9LiTPzlHj16gxe/ExEQITvUbue5v2d09BeIM14sI7+IGNXt/tcAUBAA2Br1k17tzi8y0+367x2zX+r7HGb/H5Nne3uft15u5vwOcBDT2Mz2HAk/E5jG13WI2lXtJ5m/81TKdUCRJQeDOdJKWh7eYKgxOugFAK50GxhnA8RRntbjhBiUc9PO73EpUmg5HVSac7cBQ46L7NC9mG+gW+cnOlb+m40xiss6Hw4AkBn2Q4gA5WeQZtMq2RGL2+1BFxb+hwfCmqT1Q9SlmFUztzXUJxIzI7DCI9RBI9BhELaCO+sTS6TZGzph/odWWy+9+viyf0gC6bzPcoNxjPQNIVFVGFm8VZ2QvE3J772onZxTqCfVpvjdk7HNZjzwU30BD4Txfffvf+8hmbItKkTC8tglwhsTWAXDmDEKFKNqq28XESLS6Lo5mjxocSzBw2yUBhFk7anQYjvIUSfw41mUyKkwSVAZz19HN2vDHvgXN1P6iYnUjjj+FZGhNU9GcPr4tKL76k1+cK8beKWuypxUTNPluRwpv2OvEHbxJIXyTBM0vW+mzmnl68RA/7J3iCVFdlQEsEOZqft5LKa58tR4NejPSacvyg3s8kLKPNacxXLWZndLj0lCUzra34B2MYOpgG19MSsuizxbpFpjFlRNzrLIkUe5axjAEUknyvITGUDyY+xkWZMIkGuKZSn5I/kmch53+ko14/NnSmx9ewduLIVCe/4fDoiszIMEaGsa8BNsjvlyYMLDw+BjpQHfABcLzwP1WCIOhS3fO0NlZ1Ir9Lc3BpSEBUomKLI//H0aLAhV+MXuDoegyUYcTU9Qc/PO8faOH61DBWtRuwasF1eTMNy+KK3by89W4ULpV/Nn1R49Fi0+SdyuZfuko/UEn+PHX3D6p420rzV6w0AeViuBHb0A4sB/nzgNfWN/Es3YCA/8JbylUC1NCuLC49LBMqMu4wqimrk5kU1P4XgjvEfjsYWTqnTIROHdMfmjwiNKVDyAZE5tCwyQzo0QZ1xZlTwnhgiX7Fv21JPQhdkZpBOyna7D10ZCoBt2A3hkcs4N1POrRlF+CZM3QsO6mcDaArz0uFl65A7DJnHELqExGRSpuUvnBBc6ZEZQtN0K+eVWUxhhqq0Ka+xOT23QR3lqFpXXL8J3iB323YVgbToxfDdZaFIucio8jEcU3Y/inaEG3xTGQF9oNQdQGAiSUOb04v1ygCMeXPv7e1me6GSXYXxwIRbI98+PTb3XYnpnYBT/xr66CDXSL+Sji26YIAnrpfjcW7xa76H3DlLiw92DPsFrjNhQqVvofxDeN1tLFhhBZkBnrj+7s73AnBDuoeH/ubSdhGgicwPRZXWR5U/Ou6c7fRaD8L3FuorhSG3YMownbz6Xb4/7os94gd68uEn2nI7c23r+/m2yPhUF1vXETDzWLrBWoNXh/yrqPC4yf5HdmlWWvfLJFKvUv26gWuCPwBTB5+IKv7+/8CJW+Cyw== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-peer-group-outliers-contributing-features.api.mdx b/docs/api/beta/get-peer-group-outliers-contributing-features.api.mdx new file mode 100644 index 000000000..3d8fd4bcf --- /dev/null +++ b/docs/api/beta/get-peer-group-outliers-contributing-features.api.mdx @@ -0,0 +1,116 @@ +--- +id: get-peer-group-outliers-contributing-features +sidebar_label: Get identity outlier's contibuting features +hide_title: true +hide_table_of_contents: true +api: eJztXG1z2zYS/isY9kMSjSlbsvymmc6N4jipO0nss+XmZhxPCpGghJYCWIKMrXr83293Ab5ZlOOkubbp6UtikcBi3/cBCODW04lIeSa1Og69oTcV2akQ6atU58lJnsVSpOZQqyyVkzyTavpS8CxPhfE2vIxPjTe89I5Hx6xo6l1teKEwQSoTJAkExzNp2Oj0mKUCOirDOIulyZiOWFCjyyJLmOnJLyLIDIt0Ck0NvIrhoSXfZeNZ0YJ6c6nMsOyq+FxslL8+8jgXLFsk8Iz+3mBynug04yqAv0NpkpgvqBN7mqVcmZhnImSZuAHuUjYXxvCpYL+KxTNoXgn1iNZFA2zt3hjH93t1Jn7LJaiQ8Tyb6VT+btuZACyBankiuRw6iY0/5wp6z4XKhqng4RNQfMJTYDpDdQ8vbz2Jav4tF+kC3qE48DOWc5l5923xht8wlc8nIsVxgIU8Bk1n2tmm+16dC8Euf9omg52DpkKehuxQxzFwjkyelkNfPZ1lWWKGm5uh+Chi9KKu4TJOtFRZN9DzTRmqTZ7ITePo+EFJx69EeEaWnmuwmFTw55y00QXeU6sn8MqIx0ZseOKGz5MYxOvvbG14JpiJOfeGtx7aGKSDccVUpNDTkrGPtvvwYC6VnOdzbwj95vzG/k1UQhFx0AL9urvbaNemjiIjltV5Qo+BbdBgBo4Z5XHstMrgRZddmJzH8YKZRAQykuAu1zKbsQ5Zp4OKT/hUKnAk6A8RN50RHWeYb8Ycf8AYpfpXKz/QuVrW/XHEOlmaiw6TGWgVFJ/oJI+tKgXr/Mcf64zH/iH27qBKE62MYDOIIXB/sgM2bAmHGQeKOo9DNhEuMsByMirtBvpjHesTHXYtUFVTBRoLwWJgMwn5haG2hKHMxsHQwAojQVjAFZvxjwIeg41IOdgeUhMPsg2UBvJlKsBiEPMhDKx0hp5iBI7aISLfk+Qd5Im4tamOtICtge3cFNx8Ex6E8rQ40UTrWHDl1fyEepKvOPcAbcd5KPxayvWLlAsdGx7VdKF3MwEekGL2djp2tB5K39Cm8onCq9pkWxLGQK1TU68m9YO8f+9VEZHwbNbo2A8Oevtb+zv7g77YPeBiq7c/2O6H/X4QTPq9flRLXbaOQG1fzdJdnX1rivs1vCzBTIbeqkg1UFyxKH2WNsr0gB7PfSPQk6CyIlc1TZWVe8mM5/CiDN4cAQMFduGkzCwAJ9y4Aj7BSFZ/ckR8h4oBvnzH5TMKTPsMo93kCUoHrGHkUCUBMvqaYJEUcQgYp9OpVNDpeHdXqGTrfQbV2t/awv/uqSYPAiEgiXTZmUNfBfZyMKvLjngwuw+pIDcVKApzHUjBQ55xxifgBTbluPdgDZtRiYlG0l1mB93IpkJXJCmZdds8sygfEAMeByGSzI+5muYQGe10Yx3wGMlj6rN6rILKokmH+N4i4EOx6pAOYdxDEYJ8oHaElYsnSSwDor35i0Embpf78jTlGB0yE3NTe26VjTguRZfKpLUgBFZLeDQlPWxDzDJs5IbdXbG9v9/f93e2env+YI9H/kE/gn/2B4P9vd72Tj/YweCyQfupEVG3BJF1ZD2ztHs1IihFZjFh1A+2WgN5qkljot2SAhXWf5g6vB0fvTo6gycvX5+Mxm2zB8HI9ZBCwYMtdxQZDT4KasXoOLJW4iQimOx4sAW/nniiWPNsFUjsYbJ7ENPsDigal/luTETqjG51D/rAYy2nDR/B3vIAFYF71sF5EuQVhBqQfjUCAs6UmILDfqz4KeX1e3WBa4z6W93eDnBai5zHeUx9hgQgxYEuYCnhBpDJs0YslkmvxbXelvCs5mQGLdwY9OvwVMsHD/FUpTHVyh2oO9ZqSoVIQ6aBAKXXC2S7lpXeFCjlk6mhXf8rGsMM9HEKgYaF37QAnobIFR5Nfah33Z/6H94dHb/6Yfzh5dFofHF29OH07OTFxeH4A8bg2enZ0Xg0Pj55++EHaFTGo2lJjsts2aZQG1Jb4EKnyBV8mpYMW+GaUoRLb2+HhoOynKGZvCvM6WQ1HHjJLKt9bK33/63ea6/dspJbdKo1bmvVskyFhRtbDtrQ0SF0ggnZUZpCsPsOIdnkYGfhNINjEx0uME1IBRqSIcKVz0UCq8IacJWMD3X4iKz6UirhT1NAZ8ChIJYD6MiA4kdJpqIZlyVZuBe16zY8CjTR7bHnPGRnTr5DJ4xNTsGvQOv4EVDkQsnfcvIM6gJJrkyaLcOKPcEnu1sH/UG0O+C8vz/o7e1MDiK+vb11sHNwgKPPl/Nhu7e+EkqkMrCYT/5OEzFuXNamwR+PuixufFzgOoxZiFks+SF23IAC+/zwlA32WIFTWcan95Sg/ItznC7lccwnxbwXJLeET1I5la3FrIBLL45eji5ej+HJ2dG/L47O4S+ktYQ+RlBzIH7BLTVVp5m+Jo6dANcc5hwC5yk4M+g4qh0QCOKr3lDaX2ZhQJnMzcGhhxu9pUedNItSPW+EEsXNTcaeyq7obkCdhGcAcmACMuFQghkCcVy8GVnE/9ppsuOK9bMuG4WhRCGh+Lp8NecLwjdhaKd2diGOgBcu8uCEBWb3MhBNW1SqbFqjyiqv60bB4MApwif9ZBRkOTBnl4VrUVh6i2PR2Qd4tprrLkGMQmmkUpzDwrQyoOVEStEwXYNUx2RmmEtHNJWExKOKdmXGqidLSncu177INL0LeG4eEXenMaQfn0QrX3wULvhoHdlmI7JGYSaXkYpCgp1dq9Jc5RJLAenXsbuO3XXsPiZ27788c2tC7i1Bn94y9LlQxbcnEGIJ+qTkPUrf+0BlDbmB66UOIv34bgyB/atQ2F7cJLjk9xXxkS3lS8yPSnu4Nb1iya8o/ZUtkEHSo5UggkwkwiHxXXFsQSKpant5tJc6nUhwUNUCESFrpmyhc8ZBZWmuFC33mw0WamHUk8wt9ENEGGMzII6qQt+uIK6R5BpJrqvRuhr9Y6rRGkmuY3cdu99m7D6IJEuuKFocTjL5fM7ThfU09x6l5QwaVDsuypArv8nU0QoSYyXG8prIwZv0e5NetBeIQcgH4e72QdQPdvt8Z6+315sM+ntevdZfVnFcBlkzpmr2tnYkFQOI+wg4LsdVVpNpHTaX/3L8uhxhWqPl/AI3g85BpVcVdhwsY8e3OgPZgDBgx3TF8uLF2WukD0MTedSbzlP8pJMWn2XpgytCStqnIG6kydbQcQ0d1+VnXX7+MeVnDR3XsbuO3W8zdj8LOg4+BR0HnwEdBwwhVoQQ66+EjqG023QjMArIEOSgXoWwMQFR4C/e2FOS8XQqshLoNVBk/6Ble5vW7A1XiwIsmcZKpKrUhekN2s6xbVq0hQacTSFFKtxvLAHdolfJuUBMitulaVMzxjEKBHTThT+KMpCq2CGjik3pdhS3adVQUsCNLjjuNZe47zhC+AcUaB10Con6K65xFvsj/sh6MDtDiV+jxOzoxu6NZOX6707bLoFjYD7FdHFubb1iu4BdM+cKphHiJrHpq4Sga6i+hurrcr8u9/+Mcr+G6uvYXcfutxm7nwHVHRpaDdWhwaOhOrTtbrESS72kw1x/NmKnUHEckHszHRBWDysMTrgCXMmdhcYcgoevht5mcSJ387Y8U3W3WT/C7EfV2Wg7MbB85mkM/YujRLdgPjDbXRf38xY7w5W+pvNEE9BZSzrC3ac29LABnVyyA3RJ4alEn7YJkIhb9bsTc155ZOlBysUhjwVMSpgls4GnLpx/0WNgMYHJxRNDrbvkT0vygVwXaXz3x2WxhFbI0qa+B0eD9gw4vSciinCF5gI/wB36aK8LY/cSg9OMcrT95VW9zTmidcvhUsuqAuF3gv4SQyfYrM+eC57CVMJunXn647vxMzZFjEo5wh5hExInFRBlp+BGlANHxTYS7ERlqToxPGps1MGYY1EMSmHuAOixU9RbKA5nkM1J7dhJUALBXo8/7MYb/VYc93yvfPZCpvYsnD1/5US0R2Ivk0IuXpPrS5n4rqDmW2o+UcODdg0urGovA7vxO4DARxI8NqStLx7c0vNr9HDmBU+Q6n0eUBOOj+b2qqCw2hfz0aDnI70mH+/Vu5mEAtzsxmy+Y2ZGZ56PWTDT2oh/MYaug6FyOc0h0r6YrWsc1KeI8PtbNZZ8O6QvfYCTxN9rCAxlncmeNSQ0o+3CCoXtz2RZyAs/0xm+nxsy0+NLqLrYMtTBZ5zgvMczDujjgL7NE8bxb4saOhbENspAecA6wGFlf8oEjtFabrS0WjM/kd+kPlg+8C4IomKSof0xrJKg+8veGIGtyzaQqhGNlxvO4DdztOgkZV1ZxTrCfQ0u8xtrKKj39Gb5Lb+GYpH9u8mLEo+q5ZYTFS++dpZekUn+Pnn3L8p460zzT8w0Dh+ju9GwbiJRd/LnDtMtL/8ZupgD/oW3xl62AFAcJjrVXRx1QknMM/RqiupgJgUtHCSAsBEfbqBn6TlFIszxMfxhekiEpim0gbA1gFv5RMZAj5a2i5E5BYwFn2hX/G1yt9FCg0vCRFR02TuYy6kAzILzONziC+9+0W5Cdw6WOUXDsheFsQF0zee5gtEwLvM54+BSn/CIUJogt4kL5hFKFLrQBP3KXkUUo6uhCF2a0aRzcxLhmrTE88PeI8cCuxu3IA2qRyu6uxsqQc6EOzQP7ZrQ/lO0wdv8mYgTnElC1hV4M0Y1wpvj8RJFIKbcVxCdTjddJ7OJbfH0Ighv3We72+tu+TSlgOeJNhnMfWvEX+E9PM59iqsqntjZ8r3j8ua+a95Wy/Pry6q+/mVVrtTi0JsJLgiiAXM7r7NT68vikhI0zbB+YUn77BrmYjNwAOx4e4uLSTjdvMPH9j4SnMOBwjBPVBeQrDT5t3UnVqs26eRxeeWXW4Dx6JqWx+vh/+syqwf0WF729YWKXN9M9e3dTPWAOxTXj32hN3zVS6YeYPMT12B9Iff/l3crPajn6o6rSqVX1cLlZxafp668hs8sWKju2FrBRPG9TS3qHJSpq6ydd1d3xc1MxJJ9b7+11Hou7UZAWcr171dHgMLu/gu6CI0S +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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' + +## Request + +

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 + +
    + +integer + +
    = -1` and `<= 1`"} schema={{"type":"number","format":"float","description":"The importance of the feature. This can also be a negative value","minimum":-1,"maximum":1,"example":-0.15}}>
    translationMessages object
    displayName object
    description object
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-peer-group-outliers.api.mdx b/docs/api/beta/get-peer-group-outliers.api.mdx new file mode 100644 index 000000000..35d30f985 --- /dev/null +++ b/docs/api/beta/get-peer-group-outliers.api.mdx @@ -0,0 +1,91 @@ +--- +id: get-peer-group-outliers +sidebar_label: Identity Outliers List +hide_title: true +hide_table_of_contents: true +api: eJztW+lz27gV/1cw6gcnHlM+E9ee6XQc5xjvJBvXR9OO17MLkZCEDQlwAdK21uP/vb/3AFKUJSfebKbdbPUlsXA8vPsAH257tlROVtqao6y33xup6lgp98bZunxfV7lWzvfWepUc+d7+Re/o4EjQvOAF4rTCVjXSyvcu13qZKp1KMQBAlasVjfjU6ZKgA3aSiJftErEvTpUSKwSxOWhFnI21FwfHR+Ja57kYKFF7LB1MxFGmTKWriXhjr5Qz0qRK+ImvVOFFZYXm6eEk/lEBI1GNZSWkU8LYSmiT5nUGWNoIaYR1I2n0r0z3ihclkTQiknxfvJiITA1lnVdrYuvZRhckQXOqqp1RWV/829YiBTBfqpTOHqjqWikjNnFCJjY3NjaEqYsBQNvhHGK0cdCBBiaX0slCVcTx/YvbniaelbIaY8pgAr984PcEIz4dq0L29m971aSMc9qMendrPad+qbV7SApnY3AuwgnsBf9SpzAwy4fD2jngnE/WxArjnqsC/68IiMjXZWldFfBWN7Ioc8KhswyIRBJ+qZWbTGnIdaGr3n2s3smbDrOc8mA/SzYwqP+DIW25+Oc2a8dpBQ5Ll4lDm+cqJRjiuOXe5ZNxVZV+f309U1cqJwXve6nz0mpT9VNbrOvMrMtSr/sIJ0lbOMlUCk/F0DpRWAhdG/xZsLoQxVMOD2XuVYcFUJgFssG5aqQcdgYwYWh7CwOFNrqoi94+9hXyJvzNUKIS8q+7h7hph0Ov5tn5noeBNjhYQeDDGuYUuCow0RfnvpZ5Pom6q6EF17oai1WWzioxvpQjbUgpqjEUYjRmOFEw34w4focwWvY/zPzU1mae90dDsUqGtyp0FfxYacs6D6xUYvVfyZmtZJ4c0u5VYmlpjVdirGQG9Wc50MIF5kCO49rWedZ1HUIPW7mR41kNOrEqrhWxamTAsQwSg8w0uU3ilvIVnIWQEDRQEUwIu6SxvFIYhoyYObReF6VM4QtBDSwf7tsWMHDypeRYoSle0amrDORvTPkq4cTYXsm8VoELtDp69IDNN6FBwYXOKdHA2lxJ0+voCe+8u7skaEGknjZsbWzQf7M68lb7alFUWBSuuk4Z56UW+gu1A0xZlrlOmYj1nz0Bvp3HVDonSWc1xcrOuB38DAZR2HHEUMKBZnU2H1Pua/iBqI2GEjVhF7GbOUtaO8VWFIoUuE8hKcD7HFwKTbSCOPMwLBr9kUd/fAyyBPTo5TxIhiUrbBrUlVrIGZllmqDI/HiGR7Pr7ubY4wYaAdZNxEc1SYIFlFI7vwb9z60ZkelFx7yIROIXhVGAanOxdzyJuTua3lmkU4fIoWDFr5yDKBJx0nEPwXWz2YuBzSZkyNoAM519iUo9oDqZqmCUhzZ7hKhfa6OSkZOaMFSMcoqNAhCvdEYMYjMNIBvh8brZjAOc6G+KFzIDvYG+w0gMcdHJ9CNgHT1CTc6DRjdboNqtSi84Vu0qOXi+sbe1M3y+I+XWX3c2d58N9oZye3tj79neHp1eKO/laEZjGlucPfqNMsrpVOQ2hUR+BUOQjYH3jAAf/njzZRiPNLWwtiUz4isqdQNvL8WLw2OxsytyaUY1j8vR/WwvOT+laIjkQg4aZwnKA+D3To+0WYSKMhRjL3ovX70+OH97hpGTV/84f3WKvwjW5ZxBGWhrRmppOR6O7TVjHAm4lkhIFbl7yspXI9RVECSN7y7U4VeoG5okHzvi6Qt2dEGLobPFjCmx3dxU4onuqz4ZN8YQU9KxGEhKrCFCjvgHaarKKnkbObkaQ/3TvjhoPUyIlB77qZAQcD3B+4fsDaasODOwdUUBQqdqVhZTVs5KY+pK3naFQsYBzB/h6tMKiSLrxIwVttoSUYzyAc6Bc7PYnXWYxiydmAo5BXZQDppaFBopPBNo00hzojviOgOOxzTrWo/V9ZDs7t4FZF5WludSWftH2N1xDveTMGntxJWKxsfFR/BGLI1GTNEjRffNm+OqVlyN4QsExjxb2u7Sdpe2+0jbvT95EjPpOMupz+Z86nNuZA3+Og6ec6mPY+0xVjSLOL2JglwTYEhMkb77cAbD/qgMrVc3JVUEXzE/CqF8DvmDVh5hfMDpYSOsGVkQgszHQMEQnkhl+4z3FOOQJDKrtudPe22RnUJBzYIUEV7TiYmtwz1XbQzXiEhbM6u8WalidQiL8D54QDrVZEkoxJaZ5DKTXEajZTT600SjZSa5tN2l7X6btvvJTLLFiq0l5km+LgrpJkHT4jxRKwUWTK/pW5NjUd3PVgiYaHOs3mzm0BtsbQ42h7up2snkTvZ8e2+4lT7fks92N3c3Bztbu71urL+Y2nFrZLM21ZF3kGP4uKfcFfK42kC5fGVtNnv9B/Y6NSS3Rq6nzZvBc7D0ss0dt/bmc8cza8U7aSZNhuRnckgz5RH5NKwtaK1r1tKXVzGCX6QrbaeBF6mSLhSg0OdIwd8wyHiJCsB1k+RgWIGU+GUkKll7Srwk9+wJ6F6Vzr2Wmj4zDCnnAwTOYEfwzl8xO40i+l2ZvDghit8SxeLVTaoUGXqbuT9bdL97BOQd+YjTIOAHLnpDtSMNFAAFQfBZbd65zM+X+fkyxi9j/J8jxi/z86XtLm3327Td35Cfx2zo4fwcCx6dn2Ntf0O0udRr7t34b6fpbCoRA1ZvYdOU2u2yaQ4OJniFQV1N+JBz5PWHQZUPkLRj7JJ6TQoFdYudm+RnqF9wv7dOfQUJ9xUkvm3SXL9tGv/u1mPnySSx0y7PUDkEmmqXA07Td3MLUUPEd31Z6n6z1dhrbr4ZgL8LXBf1GAQzpQXc5hMO6LNwnCb9D86SgQdRxWaaXtvf80nI1IhFOjCxNdwjg1mjFpKoizwMFEsUIiueV/dZ9+boA13nLr/7/bQEQA/Qsoh9nzwN6wUwvUcikXA5VY9TytrD6XNKMo1EVOltzR32npZtiRdKOpQU4ePHk+8+nD0VI8pV2VfUntJkpam4gLUdQ0XYFx40HwJoE4enaaPgwcynFrI9McxBsIh9X00/7/cIEifw6sxS2qTYkdCux3d9yZl9D3R5/WAS8VK70BTmeU0kMXTCXZQNXbJD15ci8ZcGWhKgJQzNP72HRWDtRRpad1I4AAIhc8/c+uLDA7ykA48qMIwQ1Ps4ECciHrMfyNJGal+Mxwy8hODN4vGD+TDWCMSz20TwacKPudXxSKRja736u+COcTKDi1ENK/pitK7p0IQtItna6KCUhCMTnSCtZPzewjBMUCY5oLDOWY1FwmeyYJI/sWRh8z9x9+VPMzTz8AWiL63MbPobWhnv4UwHJnRgEnyAj/iH4EaKRQ2toIH9QFCAw6n82RNERDt+L8Ba6NUZ/DrvodCQAlWG4sv98GN/6uDiX4InaHW7Bm6YsvL2kyF+iwiLItwMs5r7hPscnMc3twis9/gW8G3vsyjY/tHoJYoPptcu700++dpe+gFP8sfxu/8jj7f0NH9GTxPzZFI3PjYWFF0lfxHztflrQM/9+PgXs+EREaXkKHimLfhdQGUuK9Jqtup0rBVfIJRKVpT7rZFm2YItEbU+mT/KRAY04rc1DihLlHw6Bzy+4m5OlmwwIbEkudJvX3MVw09zxihIVV98QE1nUoiF6jlq0sDczzYWdqeQzDEJVrxshI2kqyhqQ2+mgHZdCAmV+oxGZNqndXBcKO+ManhhOfVrdzVWTKpGJPS5snGFfz+ku2mUvR3Bf+YsyN3Hi2mwnqQYH1dMCTlROWsmrZtN2z8HG9qWjFVeUkUJr4sETHVOeHd0NgcRwIwHXajcrRutx01+ndYCCJVHQX22+5v9jYTLBepJt75CDdwB3j5Yax63Cer5v6+Ft9Mb+eXzuM88j4shkmqb9ZIu9Ijxdai1Qtl70VtY9mLvfufl3Hzli1pqDAESgNtbuhSiUvCOhsODH6qHoVJk59MXIg/K8dt6yraQqx8VXbM0L/XiRUqPn/Q9ng//X2/QPsHH9o3eFzJy+aDs23tQ9gl1aF4NTrXhcnqH9Bt9zZOT+HDtKX80/7rvehfS0HxnMZMuCQ1trZu9u8TaoIBMUpgOV+ydjXMfoWeuNN+8ogAtHyiR4h90D3p39x9wPBYC +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Identity Outliers List

+ + + +:::caution deprecated + +This endpoint has been deprecated and may be replaced or removed in future versions of the API. + +::: + +-- Deprecated : See 'IAI Outliers' This API will be used by Identity Governance systems to identify identities that are not included in an organization's peer groups. By default, 250 identities are returned. You can specify between 1 and 1000 number of identities that can be returned. + +## Request + +

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. + +
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-pending-task-headers.api.mdx b/docs/api/beta/get-pending-task-headers.api.mdx new file mode 100644 index 000000000..da8ba50bd --- /dev/null +++ b/docs/api/beta/get-pending-task-headers.api.mdx @@ -0,0 +1,67 @@ +--- +id: get-pending-task-headers +sidebar_label: Retrieve headers only for pending task list. +hide_title: true +hide_table_of_contents: true +api: eJztWm1vG7kR/ivE9sMlglayZSeuDRSF4yQ9H5KL65emgGMg1C4lMdkl95bcOKqh/95nhtS7nLhJgV6uug85a5cznNeHM7O8S7wcuuToOrmU7qN4LY0cqlIZn9y0k1y5rNaV19YkR8m58rVWn5QYKZmr2omBrYUUhXZe2IEg+gsvfRNeVMrk2gyFx2PXSdqJrVQtidVpDmZD5c/CCqL7OXDEqkrWslSefhxd3yWaNv6tUfUY7wze4KcdDJzyyap4b/ix0MZb4UdKDJqiELVyTeEFXnTElWtkUYyFq1SmB1rl4lb7kWgVutS+JUBWyaE20ivQ17YZjphPYOE678yFUuL6H3vi+OxUQFOTyzoXJ7YoVEYyiLOZ7DePRt5X7qjbzWGwglTvOKmLykK8TmbLrs5NV1a66yKfNJvxSec2eMymLG2toBf+LNmAZM1a/dboWsGUA1k41U7UZ1lWBeyz005cNlKlTI7uEj+uyGTYVQ1VDbrAJDza6+FBqY0um5LpcjWQ0BV/TybtzcZnY63Z/rX8LExT9lVNkRAtRhatlW9q88PYrvfkO6xXys/hb+YysyV+3WvNzDZm3ZqnA9HydaNaQnvEKMK4slVThMBUovXP9NJ6WaQnRN0ic1fWuGlehqimhRs8MpLgaJsiF30VnYM80INZFsCiohUyrCVuFRlvaGDDHD6EF7XJiA5qOE/ZLeFkiCJYEZFJI0YSCCGR/jUbi9brspKZb5M22oEaPgTC5NjYWE9R4hTt2mImf2HNWyQTS/tJFo0KVqDVELtxU2l+iJgifTYEVd/aQkmTLEQKU04mN8QtuNQRQW9nh/63Csa0InfB24uI/OpBeDxpg+/+Ot9fLXyJeIc3U+iY6wxh5yIQstvFrXTCNVmmnAPGin7j6TWZxMFFM3L4dSnGzBRNWTOWYH+TZieFJvIXdQ2pU3G+EKSLUvRtPqYdtUGE6Jx8EHcmlrKqChIdLLsfHPG9W3eB7X+Ah+nQqSkivA72zpVHaJzYXC2sdTj7zHAtVV9qo9JhLTVJqFjkDIQCHD9ptjcHS2BJXiEVeB0JPIsRskRnVzyTOfQN+p1EZWAmX8vsI3jRwfk1ga6MBr2Ykgids/fv2VYdKNl/unPY2x883Zey9+f93YMn/cOB3NvbOXxyeEi7l/AzagK3sLesazle2/pvyqhaZ6KwGTzyLxikVhK2ZwF4c5Bor0r3dR8wjwfY/xJ6hbUzNaO8wqvPwBwpnp2cif0DUUgzbPi5HK4YwaRXF4TJKBhkf5qy0DwwflProTabRFGG0P46ef7i5fHVq0s8OX/x96sXF/iLeK0VUMdmmlGWUXlkb1niqADnlSLQAb6JVuTagkLSuMWFOvxyYwdjiggfoIi7b6BYZC0GtS2XUonz5rMXj3RHddrIWjwDsmUj0ZfAWmFD6raOkfOVT19FS7Yi7DzuiOM816QkTgLGawf6MaW/zPN57g8apLJixLIADcC5ztSyL+amXPYGkkB7XvFq0SmUHJD863FynHkUfxwTS1k4i5Yo4hTx8mi5ZekuV1FwbDxONlBQXZnZGmebZ0DUOGynQKjJ9jgJp+tmiDWZzNViuHsdhHnuLb/LZOMekHdnBeAnZdVmLz6pmHxchQU0Ym9M3RQRKdbKTBxXzdw1TXyBWrnIt7m7zd1t7j4wd1dfnseqJ77l0mdvvfR5aeu+htXNhroHUFCLsW2EhBvqxhguv11b5FY585OPhTeXZSGtITtqvjTUuNvyaFsebSF2C7F/GIjdlkfb3N3m7o+Zu18sj2ZScbbEOsk1ZSnrcYi0+J60lQIL5hPQWcqxq1arFWImZjVWslw5JP3ebn93cJCp/Vzu50/3Dge97GlPPjnYPdjt7/cOksWz/nqex7MkW86pBX8HP7KJUcR9Qh3XGBrXeWvz5ZkWzFurAcEaQY9sEE01SgXYHCa9mYT/2olTWVNrP2Y5rsDzJIT5MQgoa3VujmjOl5azzzlHwLs8uaHhYqnAljSmGOdPLkSVdJnC8cSwG6eFKU8LE9qR5A6KN3VBxHGgeodAQABMOrLSHeAjYsGPjb3lqWof1t8AbDS2C0lMC3h+GzbosOtqTdkRoJSZB0fGKWkyG9x+kTNN2ClCUDIDPJlNWyCTYqTyY4hYSTP+yfHqDkfmmn7Q66ouJt+vS2B0jy6bzPfF3bBeQNIVFUmFm3mAXFBNH3ZfC5P5OUVx1lv/nkbLeuKZQsMB9vYj2pJHv7y9fCyGVMkykjSOimilaf6LXDxDiDBSHk/bECLiw2v+Pe04RjV3H4IyUwwKKCziQP80GuFXHCHnwHw2KREphhmievg4Xy7R3TO+f2dS8VzXYdofpuVRxfCJ47qa6iUX9PpWIf405ZYGbilzc49XpAimvc7CNDyrFZtFFo6t9c2bB37pAj/qz/CEuK7KQJaIcsglr2VTr32zHEv8UuK3LMc783akcUwvk4mAXcKN+BvWqchG1jr1VyEodCgNrocNsuibxbqlTVPOiLS3syBSGrZMdQp0ZvleITFMCCbZp0Ofax6LctDkISXfs2eR8+/5s9r7JZ358TXOZlqZ2+w/+Ea1IjNtmNKGacAAF+UPRx8FFn25hA6MAyEATub+ZySIgi7gXuC1EdWZfZdp6GjIICpzcdVR+HE0B7j4l+AXtHq2BjBMNftsYIHfIvKiM27JWNNpw6oF1+UtLE7fFbsFeWenKZ3Ivzd9SePj+VDmjSnG/22UvgdJfj+4+z9CvC3S/BGRJlbKFG68bWw3FoP8WazX1oeEji9a4F+85VylGyDoFfz8bsUio6qQnqKaszob8R2pWlVKeqr92hRZtuRMrGpL6a/iZ/shinIwhsgSDaEuwK8jLuc7S06YUFiSX+m3a7jHob2yEdpV1RFv0fGZDG6hbo9GxHj3wca27wKeOSPHiudTZ6PoKsvGYDfKy6YUEiH1lYjItcuaAFxo/oya2sJy6TejmmYxhRqp0OH2py7dm8EFqmI0xQuO/8pe8LuLY2uYnrwYb83MFTlXBUcmrVsu27/GG9GWjlRRUb8J1EUBphZ2eH16ucYRzIyDXujrbT3sRiLXpbVgQu1RCJ+9zm5nJ+V2Ac8r6zzasAXma/foLNB+7Y4G36vrrMbm3XyK/7338eK5Qg1Bt6IZGUnbhAYltITXyUJLSI3iUlOINmME3WjZ3R1NU6hLmtDjcMmJWkVYm1JgfivmXmX+v27vbbT9R0XzjdntxjjCSBLqSR9uyB/rKt4XDDG9afiNdtheovvxLtF9IRqmNyXn0XAzH68Aa26wMriOgScQhanuAtXad8+ledjPL46fJ6Hz2FR4xz9or8nk3/e2/Vc= +sidebar_class_name: "head api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 headers only for pending task list.' (get-pending-task-headers)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Retrieve headers only for pending task list.

+ + + + + +Retrieve headers for a list of TaskStatus for pending tasks. + +## Request + +

Query Parameters

+ +Responds with headers for List of TaskStatus for pending tasks. + +
+ +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
\ No newline at end of file diff --git a/docs/api/beta/get-pending-tasks.api.mdx b/docs/api/beta/get-pending-tasks.api.mdx new file mode 100644 index 000000000..ec6dd28d7 --- /dev/null +++ b/docs/api/beta/get-pending-tasks.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-pending-tasks +sidebar_label: Retrieve a pending task list. +hide_title: true +hide_table_of_contents: true +api: eJztG21TG7n5r6jbD3fxsMYYEhpmOh0HyA29JHBgmk45pifvyrYuu9KetBviMv7vfZ5H2jevDYTLTC4tX8BeSc/7u7W3Qc5nNji4CsbcfmBvueIzkQqVB9dbQSxsZGSWS62Cg+Bc5EaKj4JxlkibMz1leOYi53lh2VQblgkVSzVjOTy2/WAr0JkwHI+fxABgJvIztwPPWVjPuOGpyIVBCm4DiWh+K4RZwJqCFfiqp1Mr8mCVmFN6zKTKNcvngk2LJGFG2CLJGSz02aUteJIsmM1EJKdSxOxG5nPWS2Qq8x6DYxmfScVzAeeNLmZzguNA2P7P6kIIdvWPXTY6O2HAo4q5idmhThIRIQ3srKL9+vt5nmf2YHs7BvEkyHTfcplkGsjrRzrdlrHa5pncth5OGFVwwloGz0iIqTYC+IKPKYkO5WjEb4U0AoQ45YkVW4H4xNMsAfkMtgIbzUXKg4PbIF9kKDLAKmbCwDkHxD3aHcKDVCqZFimdi8WUA6/webncWi98ElZH9m/5J6aKdCIM2oCXGErUiLww6puR3fD575Beyj+5zwSlkiV82yjNSBeqK82TKevlphA9JnOwUTDjTGdF4gxTsN4/w7HOeRIe4ukeijvTygo2FzwGDZBV48Y1GplzgKiLJGYT4ZUDfiCnlReARFnPeViP3QgU3kyBDGPQIWhRqgjPARs2R7/moGQghREjLOKKzTnFA9AaCQv3yzTjUb6F3EgLp0GHEE9iQKx0jlZiBWLtEZC/Euc9pImo/ciTQjgp4G4gu7AlNd+ETSE/a4xqonUiuAoalkInl8trhOZUavHAcDDAf6uhF3fE1mn74fE30mDMYHMAkGdZIiPiYPtXi1Bvu2RyYzgarMxFartkHIkcxGjJbKLCGADNrEMPxPAy1kZEQEtMV4GM4QGh2QoKJcGm3qFXtL2BMgJA9Us8h4wzKXKBuSIyAnwCoaQ6pogOHxNeKGCi8dEQ26gMt9l/BuhOUHheWAtZjhKQ0TMQP30UJgLUh/4skY8eYzETevnoya9gJe4c7M+l0xnw1pHVxcKCEMOZUJgCwfod0+zkCGWFDotCgg/gJA01GpEBPUCHDSqsFqSgZkHDygDjznB373mwLDetoh/DU0L0+UgURrWr4KfL0fn4X/Dgp7PTQ/x3eXx5fPTv8ejiR5RITYvfuGzptUMQPv0SnL+SMzqF+FoYusZaffsSeEfsXFBB0SSgYa13Muz2fQkyzhykkoDK6Lv2J8xHCeEYAq74JKLCp5Pfg9veCJEh1tIVO0gPcQEFHmP6ejS7VeJFMGEuKRjUdAwHw0E42A93dsbDnYPh7sHO8/5gMCATrGJDh7Y3HGKmW46+MpFV1FpDJK58PcrqyNnVbRVIvzp5dTC/i8o6Mz3S8H0gvCiiyKWI99wot3ZsjMZMMxYmpSYipi9p5hZa8bE8v2xkng7db/0K49bqSFLGqEq7B9N+T/5unPb4VpL0B4GnEx3xRP5HxGPxKa+zdqNZuzcj3pOUgKe0ImCT3E/evT5FoY/O36HEz89Pz9uCpQ3LVXq7PlUuY42UbsRfcdIUCIEWdc2ABLQ59Ts2KZRVEO5ILYoJNBuopsFcI6qs4j817GUz9LyhobWwj9cBxqpB5rReCac0CFhDK+hg/FEsHqC6Ci9HIMt2h7+JiXoPVbHYgBlFIRpJ474y3GTibfUtG0Rc3ZadF7UVwfK6yXntDBXry7rmW1OC44JrUIBOo9Mv7pq+RWOxK7NXTFGt1MRUddzriGptbXIkbZbwBVONGgUpcEweVfg36zfhE5GgtNv0dDCNyuX1OLBFnFIkvavWBUnKfEENcLCqwjbJy2Wra9hMzufnhUrAPI6lM86zhqhd41dRfbtCNg1Z6najm7d8O1Xu+BK1Iuw2mJmW3eZmM363Ed2yTrafTUw9Q6mo2RkM1nsf6GyJK8PB3poiWjPfw7IQAkOMpZuwflJHcwl2A7HNuhQ7LRIGysVl7NktU/VxqINbQxBVjvuo9e6jkPbWtd6HicTjLo6G7LwxRWlSMdHxAjFKBRFCxo9pvjd4sIsGhzoWjb2VttvEvpZKhDPDJVLockoEB9GqPkoaDdA0w4EstUr7+i3LAUn0d9grHgO/jr9Dzwyq0PDoA8A6ie8n6NI1veURJikJb0Ir9gWfvBi8HO5NX+xxPvzL3s7+88nLKd/dHbx8/vLlagm1ElrbqH/AzltGrKoOQFccZE8ECF+/bcgim5P83eyO52XCr9hMG5l6i3H26vCM7e2zhKtZQc/5bEUIKry8wKFhkUCQLWdKZZkjTo2cSbWOlLJuOjp+Pbp8M4Yn58fQtF/AJ4TVmedD2eE9StPYcK5viGLPAPmVwKmYiPus56H2gCGubHOjdN8sDTyYn2/BCY99zYkm6DqVlq5EfvMpZ9/Lvuhvgddi38ZzaIsm3MIB7Vy3NwKfz/LwjZdkz09En/XZqIrQZb5OIdmB+0Porn1/WoArC6qyNQQNpXPol9u6qEXZ1sZK/VQqBZ3Dl6B328koygsgjthsemFlLZ7EMuLFXnJt6sarUXABgTsCLmhOEWmI6FFOAVHmtgqEEmWfclXuqyJWMzxTuPN10VGuaS3ihX2A350lEH5CYq1a+Ci889HPBC4akTZKNfmI5H/MocN+V6Wu0vEZtPdJ/OS7T7775LsP9N3VxXNf9fhVKn12u6XPa20mEqSu1tQ9EAoMW+iCcVCDKZSi34fsFou1sOq73P8yRGWZc2ugXag4dD/CPJVHT+XRU4h9CrH/MyH2qTx68t0n3/02fffO8qiiirzF10m2SFNuFn5279bdFQjYUF/RqVzOzZ9XqhUExqoaK2hXDsFkuDPZme5HYi/me/GL3ZfTYfRiyJ/v7+zvTPaG+0Ez11/Vflw5WdunGvp2eiQRQxH3Eeq4QoFx2VzruD3TAvEaMcWwhqGHF2BNBkoFkHmfhul+cmdFVBiZL4iOS4B56Mx8BAfc1Q91gKPDMK1uFx5AvIuDa7z9kgoA668H0q9MeCjYpgPuJ7xtf68lzP21QUe247swCWwvL/zcgh2A/pd9nsl+OYFV+oZu/UxA+GvimrSln+MGul/kEPRJc0aic7hISsCdHv0tnqC6WHQn5HLQDhUzxE4Cs8XAkbyh0mOct3K1+M7S7j4ZZoc/4OvSJMvfz4sDtIGXdeK7ExvsZ0DpCovIwnVtHxdY0jvsHSup0xSa2bCD7BS3DdkrAf0GgNcfoCv5/u/vx89Y44aNxRpaSBz/giuegYlQoByVXQgeotxV3/cceaN2NwLQMdk0AYaZv3B24oXwDjLIOYR8EikeEhRl8NTDr5vx1rkN18t+ViE7ksbdRnO/iHkW3RW8q6zkizf4eiwRfy6hhQ5aSNDssxUqnGivIjcMj4wgsfDEkrQejdzBCxvwsD2DJwh1lQaUhKeDt7QWlVp7NB0teCHCa9Pxs3o/l5Cl28eYC13MzumO5QmL5lpb8TfG0HTQDa5mBXjRo8m6QaQheUQ4HDRICh3KUIYQnIm+N+AYyhkTn2DOp5JHQzWoYueSv5Bmwed/oft7v7R4psdXkJpxZ6yjz7hDuUIzIgwRYehigPX0+x81gVi8AgI8UBxwBnBY658igSe0EfccrLVRncBv0xlMDRGQSlBsduC+HNQBzn9itIC7qz0QhrFkr+YV8J15WPSbYlNY5bBhVYJdehMNyXdFbo7eKpliQv6j8Yscj+qZzKlKFl86Sm+IJH+cuPuVIt5TpPlfjDS+UEZzI7S+22ga+Stfr3VnhJbuTsBfWCVfpQsy0A3VF8SagLKE53TRCb06mtMbO0ZkgudY+22hZemUPDEzGt1f+GvlM7rVaYBkDv2gTABen41rzJwcxhWWqFf8bgtqcRBXNIduVfTZe2j4VARqwWYPJ8Sw9qv2Xd8FaOYMFcuOSmVD0ZWmhQJs6JdFyjiY1D0WEUsbFS5wQe+nRCkLTaVfdar0YjQ1ZKFP3Y9J7enUX49tKP4eXKB366fWIPr6ak1QM3IuErJM3Ncu2++DDdYWzkVCl2sh6kIBJhoY3p6MOxABmLLAF7T12sy2/SG7jXsBCLZHznx2+zv9QUjtAt4D0TaHLqwBvPFWV/P1AXrFoL9qjLf11P4xr4P55IFV/3aGczC6NO66ENf3XQWNvg+7wVbnB73EHBjAbbe3ODHBVmiJj92bNtgPgkjRzutXMzYy8P/1Ctla2dNNv/oVOz+mCAJsPB8uyG/rfbA7BFG+7vZIOTy9yfXtvcl1hzWUr+vV1nBdz1Ag1lzDTqc6CjzukJvcNk51fttszbx+OMbQzjcU1/4Dolou/wuFvAAu +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 pending task list.' (get-pending-tasks)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Retrieve a pending task list.

+ + + + + +Retrieve a list of TaskStatus for pending tasks. + +## Request + +

Query Parameters

+ +Responds with a list of TaskStatus for pending tasks. + +
Schema
  • Array [
    • messages object[]required
    + +Messages associated with the task this TaskStatus represents + +
  • Array [
    • localizedText objectrequired
    + +Localized form of the message + +
  • ]
    • returns object[]required
    + +Return values from the task this TaskStatus represents + +
  • Array [
  • ]
    • attributes objectrequired
    + +Attributes of the task this TaskStatus represents + +
  • ]
+ +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
\ No newline at end of file diff --git a/docs/api/beta/get-potential-role-applications.api.mdx b/docs/api/beta/get-potential-role-applications.api.mdx new file mode 100644 index 000000000..867de9a8a --- /dev/null +++ b/docs/api/beta/get-potential-role-applications.api.mdx @@ -0,0 +1,79 @@ +--- +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: eJztW+tv2zgS/1cI3YdtjcivPBwHOBzctF1k0W5zeVwPSAOUlmibXZnUklISX+D//WaGlCz5kabp3t2m5y9tLJHDec9vKPI+0KkwPJNancTBUTAW2anOhMokT850IgZpmsiI3ttgJ8j42AZHV8HJ4ITha/ZeKqnGwfVOEAsbGZniSKBzMZGWTUU20TEzIsuNsiybCMYr9JgeMc7SYjlmkOBIG3hIf06JNrPCWhjehOVTbjgQFQaZuA8krpTybAKvFLyAX34wyLIT2Ggipjw4ug+yWUovM4PMzncCI37PpREgcWZyscq8WMcBk0hV3PFpmiC5w6jTb4uDXnjY4zzcE3E/5P32MIz78f7u3t5+d3c0hMXW8plWlfx93A6WVShjJtV6JX4H/7/nwswWAujRyIosWGbmAz2G9TNN9h7lCXAlbJ5kwEPWZJc250kyYzYVkRxJEbNbmU1YI5FTmTUYTEv5WCqeCZhvdD6eEB1HwjY/qXMh2NU/dtng9ISdZ1zF3MTsWCeJiJAHdlr6yPWLSZal9qjVisWNSNDRm5bLJNXAXjPS05aMVYunsmU9nTAq6YQLX3tJTjnVBlSr4M8puS/648IwI55YUVFue41BYVUxFgbmOSLu0W4XHqCVpvmU5sVixEFW+Hu+SfmkrBXdv+d3TOXToTAYWV5jqFEXgM9Gd93979DelN+5v4lKqUv4tVGbkc7VqjZPRqyB4dZgMgMfBTdOdZonzjEFa/wzvNAZT8JjnN1AdaeQ0wSbCB6DBcirceAai0w4UNR5ErOh8MaBOJCjMgpAo6zhIqzBbgUqb6xAhzHYEKwoVYTzQAybYXBzMDKwwkgQFnHFJvxGYG4VhpSF4+U05VG2g9JAajYCbDgVKoaFlc7QS6zAVRtE5K8keQN5Im5veJILpwUcDWzntuDmWfiUS5wrTjXUkCO5CiqeQjPn82uk5kxqcUK33cb/6j5ynkeREKDDJjvzRY6zRNoMzV3PyvbhyhZphaNxiUqJbH2xuM79KuPcGI4uLDMxtZXnevgF9IWl0qB+M+m4h8q1UlhWHD5GrtFl65xjBXKR8jUKv8KoTTTmFWM4foJu1O8ctg97vW6ne7Db5e1Or9s9jPd5r3/Q7XeHiwg9T3j0G/KRyYxKF1ZNBz02oRVYcY6L7q2z23EiYRJ7YwzYJPS2cyHoig2FFhvqeIbBIhX4v4yfYqcN9ohFBo5/rONHaPWtVCIcGy6RQ0EsRzCRAcUbGaMfUSg4koX6aVyzVu5BE80Oe8VjkNfJd+yFQcUa0DDQOnmEo1wqCfNZMQXxBvr2hmVFT/DhQbvf3Rsd7HHePdzr9PaH/RHf3W339/t9XH0KgcDHwq5x8PrSPwsljIxYoiOwyL8EgksOuicGaPHHxwTReIT+EQ26saWYnl+WiTvIqJy9Oj5lez2WcDXO6TkfLylBhZfn6M8Ah/iwSEgguSP8wcixVOtYEQpr2VXw+s3bweW7C3hy9ubvl2/O4S+ktYK7B4BSVYxuqanmTPQtcewFuOUWsg6mVMxZDU+1AQJxD9D9QOl+2ZkFZTKfHGGGX33NjCppNjJ6Wgslipu7jL2QTdHcgQICzyBvRxM25FBJGJiQquoAEmqahe+8Jhu+nL5sskEcSxQSMgpVI2gv+AwrEY+xiEnl8SaEsqDqq/MMi5WMRN0WC1XWrbHILu+qRsHgAM6/7ieDKANoSz5Ri8LSWzyL3j7As9NcnbuLitJIpTOVQd2GGYiaI22gckNmAtkkQAmfjtBcFhKPKsaVGWteSZqU7t47Zl5nmt5FPLePiLvTBNJPSKKVL26EDz7CmC4bkTUKM/mM5DsBmuxHleYqAp9BJ5DE29jdxu42dh8Zu8svzzxa9W8J+nRWoc+l4jno11DxXIE+hrxHaVYMInjjDbnDQCEeIv3y8QIC+zehcLy4SxF1/4H4yJXyFeYHpT3c8yHCj9JYNVsgg6RHJ8EIMpGIj4jvBccOJJKqdldXe6vNUIKDqjUQEbKmYTOdMw4qM7kiPM/tDou1sOqnzHdgEBHWugyIq6o4dM3OFklukeS2Gm2r0Q9TjbZIchu729h9nrH7IJIsuaJo8TjJ5tMpNzPnaf69+5oHAxZb4WXIkamW0QoSYyXGCurIIRh2O8POqBeJvZjvxQe7/VE3Oujy/V6n1xnudXtBtdZfLeK4DLJ6TFXs7exIKgYQdwM4LlfgXDbTOq5v/4F6jRhhWsPUU+Jm0Dmo9LrAjvvrdhhPwCIGvfTcLbFhq9Hhba6ABYCkLmpK5LNFiFuEuK0y2yrzY1SZLULcxu42dp9n7H4DQvRoaDNChAGPRogwttlmJZZ6S1/o/9tAkULFc0DuzXQU5YY2PAsUSLgCD7sFdIQOcwge9zoKWvj1O3Tf+0P/vd+27stjavNW+aE8pKFOcZB6WvdLZ8TmLV4/jOfQq5MqNwmsVpyvuIeJYOR5k6eyCTkQqGQzpW/pkMUQNLwmeeF3bheoOICOc7gFmmQeIzECXLok4s5Y/tBEUJ7jeJCy8gcEZjqHBElkdhhEi/dGegwsplzNfrI0uknetyIfyHVpkvn3y+IIbZBlnfoeXA3GM+B0SUQU4RrNBV4DhMhel8DPsct1gxw95eq6OuYcsb3jcGXkol5hR9JdYegDDuuyV4IbaDzcJv2LXz5evGRjRLSUUXKLYFpIbEEgJk/BjShjDooNa5xERWxxBG9Q+ySAEcpGCSiF+TNAJ15Rv0IpOYPcT2rHSYLSDc56/AkgXpu34cTPJxWy19K4A0LugI0X0Z2KukoLuXhFrqcy8ZeCWuiohUTNvlziwqn2KnJHTCJIEy6ILWnryYs7emGFHvZp8ASpLvOAmvB81D/kRIXVnsxHjV6I9Op8fFIfJxLKdX1acRTYTujY2wmLJlpb8TfG0HUwVK7GOUTak9m6xUVDioiw266wFLolQxkC+CT+3kFgKOdMfIjFn7CPBlioYhe2n8mykBc+00m8zzWZ6fEV1GgcGevoG461LfGMC4a4YOjyhPX8uxKIjoWHHUEGygPOAY4X9qdM4Bmt5EZHa23mJ/ItmoPlIwJWiYpNj9yPo0US9H8xeoGjyzGQqhG7l5+24DfztLAO1pRV7Dosa3CV30RD+V3Sm+O33HfBkvxnkxclrpw6+6CS2R+dpTdkkj9P3v0fZbxtpvkRM41H0+hutKxvO6pO/spjutXNQktns+FfeEuxSsAd2qLFcewqoTThGXo1RXU0kYK2GVLBM8SHO+hZekqRmBqN4Q/NJBEaGxgDYWsBt/KhTIBek10sVuYUMA58ol3xt82p18G1ogm0raLJPkLnpyIwC3Z9eJgA3n3Rvv07B8ucomHZ68LYALqm01zBahiX+ZRxcKmveEQsbZS7xAVNoBKFLjRBv3JWEcXoaihCk/ofM7UfRriDDc1xxfBfWQvsbv32NagereiP8S4EORNJ2cbUof3XaIO3hRORpNh3QtYFACYqK7w/uVihCMSUBbmgv9dm3PKTbAvHAhFsoZz77DY7zXZILQU8T7XNoFOuED8T0NADe997k2nZb+8XO/3/oXtTvhRhD9FKcXsNBcxd3+Ma1atgXaMKU4+qN6o29ao4bvVGU61dheZmAhrFle7vcS8H+7c5Pna3MbApAhtj4C2O729U0//XNaO15vtN4O5KeQ3Lb6AEdGHr8Yp8XneGHlBEcSXqiXrY3vZ5frd9HvCG4krXwhuuFxs/35hrXpz5W0Uv2cVDF0PXslN86VCzKjcFm4vc+m3eWmHpG29/PoHJ5cQ+v4Ypzu9Jk26U25CvzF/5ZI0mKDdJf34DxXf+b6/pPQY= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-potential-role-source-identity-usage.api.mdx b/docs/api/beta/get-potential-role-source-identity-usage.api.mdx new file mode 100644 index 000000000..04b1ac3ca --- /dev/null +++ b/docs/api/beta/get-potential-role-source-identity-usage.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-potential-role-source-identity-usage +sidebar_label: Retrieves potential role source usage +hide_title: true +hide_table_of_contents: true +api: eJztXGtz2zYW/SsY7YcmGlGS5bdndnYdJ+m4TZqsH5udcTNTiIQkNBTAEmQS1eP/vudegBT1sOM4nbZp1Q+tTAIX933PBYFet2ymclloa06T1lFrrIrXtlCm0DI9s6k6t2Ueq9OEnhSzSyfHqtVpFXLsWkdXrdPjU0GjxEtttBm33nZaiXJxrjMiCHIXE+3EVBUTm4hcFWVunHBMUpRE68SWphCPpBOmnA5VLuxIJHLmhDaimCiRSleIwz4/eyxGNhdKxhOhAz80TIqsYljk4KUL/pyKyxzvweN169Kp/MSaQn0sjstigmdvb8BoJnMJzlTueJQmdjOJ952WwQv6q6kIaAd044maytbRdauYZTTEFTnJfdNp5eqXUucKOizyUi3r4XiJSUgAcuqjnGYp0VH9ON5N9pNoONofRTujg61oOJCj6ODgYHfYP0wODwfbWGUtmy6Y6Mv4C1ZZ4msQH24d9A/29/cG/XhrZ6+/hV97+6Pt7T251d8bzXn6pVT5rMlUzqptLjySqcPKrpgxbVhzyotlqU1UxddtInR4vCzwJLbTqYycIgsWIHyzLM05Foe7uTItHPwM09mZXCFNIvNEuJkp5EfhJw1VQm509d9tcfz6VJxXg05smqqYKIrXtau8fTQpiswd9XqJeq9Sip2ukzrNrDZFF4z1dGJ6MtO9arEorulEc5frPRbEJHGGAHFllpG+EvZwYnWESfYDvR5plSbuSLTbiXZZKmc/gERHQEc67TSCqN1eMFw0f3Orjexo5FTRWtbeK34MnRTW81KmadCmwIuuuHSlTNOZcJmKNfhLxAddTEQ71VNdtAWmZXKsDWyD+bktxxOmEwzS/dGcK/U769vnjqnN4eHGOxIGdNe5Z63D/hpnxKpqrPKmN+LR9gAPpkiB03LK8xI1kpAVv29uUz4ra0X3L+GW80xYuTA06pPnV6O7we4XaG8qP/rfTKXWJf66VZsxO/qyNk9Hok1ZpS10AR+FG2c2K1PvmEq0/xdd2EKmkQ8gUndmjVNiomQCC7BX08A1FplIULRlmoihCsahPDKqowAaFW0fYW3xQZHyxgY6TGBDWFGbmOZBDMdZQMLIYEWwICKWRkzke0XFTeWsLBqvp5mMiw5Jg6yRK0qEyiRY2NiCvMQpWrXNRP7JkreJJ+b2vUxL5bVAo4dUgStuvgqfuqU+DC3qqTSthqfwzBsq8pVJHU0Y9Pv0n6VaUcaxUtBhV5wFgCJFqgE7YO4mVKlzcwAfWrnb4EdMaAP+iMVklqU6Zul6Pzta8XpVBJnnkpxZF2rqGs/t8GdoDi+ynDRNS9Jb1Og15XEZeKk5Sjp9uq6oH6KU7+zv4mco6geHO8PdnSTmgjovNp9e7KkfLCgYl9U0W1j6e52/E99blWW0CBexT5N/RsOETBJY091N/x3od98R/X8XiCya2K0GGvuBPJQWbhTHddlpVZVL6BTrw3MngK1DpUzwDzvyKMP7zHC2wGV3XdJrpEtkthbGsRAENz2gXgPFPQS/oX86rZ11Hn2SakwSz/IcmoqCV/vk5MswJx0xtMmM0og2yAw6eYjf3uKfiSqg9xMGdZ+y7XNtVDTOpSYOFbMcY6IAxfc6oczIScKTrFTM47oLhocmulviiUwgr5fvJAhDis1l/A60Tu8ROJdGY76opsCAtcetWVbtKznc6x8OdkZ7O1IODna29neHhyO5vd0/3D08pNWn8FrYzK0J+MWlv1VG5ToWqY1hkV8VtUwSuvd9Dy1+/xzBNO6hf3JuP7YWM/ArqGHqIL89OXktdvbRiplxyc/leEkJJro8p1oMoCiHVaqG5J7wq1yPtVnHijJU5a9aT589P758cYEnZ8/+c/nsHL+I1ko3eWzgrQm5peVYnNgPvkv0AnxAPDpFxYayeTtQbUMgaVxzoPZ/uZmDMkUoG5gRVl8zo0lajHI7XQil2HeX4pHuqm4HOQHPEOloVIcSNVZY38y2j1FqsiJ6ETTZDkDjcVccJ4kmIVFEuE6jaUY+RY1G1vP9iUfiCGXFuMSWBZVxHatFW8xVuWiNeXZ50TQKBQc4/7SfHMcFQD/7xEIU1t4SWAz2Ac9ec4vcXTSUxiqlRgzYIOZ+IrY5MA0yE2TTAFkhHXGHhMRjqnF1xmomTU53Lz0zTwvL72JZunvE3esU6Sdi0eoX71UIPkbfPhuxNSozhYwUeiSeHEbV5qoC3/dwm9jdxO4mdu8Zu8svzwKOD28Z+mytQp9LI0voN+fiuQJ9cvYeY0U1iOFNMGRHQCEBIn335gKB/Q7IDuPVx4z6kd8QH/lSvsL8cW2PsDFV7VtVpX9uC2KQ9eglGCETqeSI+Z5z7EEiq2p7dbXnNh9qOKhZAxGRNXMxs6WQUFleGsMdquuIxCpnvilCb4qIcM5nQFrVJJFvAzdIcoMkN9VoU43+MtVogyQ3sbuJ3a8zdu9EkjVXHC0BJ7lyOpX5zHtaeE/SSoEB848EdcixqZbRChETNcZqLSKH1nCwNdwa7cdqJ5E7yd724WgQ7w3k7v7W/tZwZ7Dfatb6q3kc10G2GFMNe3s7sooB4t4Dx5UGzuUKa5PF7b+SPpGOKK1R6qlxM3QOlb6tsePgcBU7XlgrXkozqxCSW8CQZq4jymkYO6WxeTWWN83HyIuGPm5o8EWupKcKVOiDruAvKBS8JAXo5rPoeFRAlPBdJjhZvYo2cVqCQ84EqSXUbOFYmj5yjAjzgQIj2DGy82+IToOJvgjJizOS+AVJLJ599F8iRI3cd9ft756C+ZxyxLk38C0bvb7bkQYOgIbA56wad27w+Qafb2r8psb/NWr8Bp9vYncTu19n7H4GPg9o6HZ8jgH3xucY2+2LGks955MjvzdM51AJHLB7CxvHZc7bzRUGZ1xBB2hbfDqXcggd/zxq9ei4STTlgwJRfQgloqeud710ePWm588l4E11XvSmp5eO9fqOwctS5inWqE77XIMYTHvTlZlePlDRG0Kva1IWnS3w4UkD+HCRX6DLRsk1+b1Pkkzcmygc4WnVp4rupMwnTmD7GWQSnkxHIEaCD/JjsJihAfnG8egu+9yKfJDrMk9vvlwWT+gWWdap787VMF6A0yURSYS381PO54TW/eorZ53nFYg6vMHKYq9o2EA8UTJHK+E/ejz67s3FYzEmjMo5wp+gVZqaCkTZa7gI58Dj6gMATeKyND/sebzwiYViToxSCCzCabPqRPkPKA5nyOasUpqkOIHQrPufNZML8245W/ajicRTnfujaP4YURDRn7+7yiq5ZEOuhzLxj4pa5KlFTM09XuLCq/Yq9kd2YgS+D1rH2nrw4p5e1KBHnReeENVlHkgTgY/FD2NxZbUH87FALyJ6i3z8aN5MNArw4rTqwoCb8AHLUxFPrHXqX0KQ61AYXI1LRNGD2fpAi0YcEdGg32Ap8ktGOgKcZP5eIDCMdyY5pHLOaMYC6JnEh+RPbFnE/E985vOnBZn58RWqLo1MbPwZByiXeKYFI1ow8jnABf59USPHohNmkIHzgHeAk7n9ORMERht5z9Nam9WZfI/nUGmIwSpTcdmR/+NonuDCL8EvaHQ9BmmY0Hj9qRB/i0CLKtuCsqp9hGUNrvKbWhTUJb15fut9LCqyfzZ5SeLj+XbLK5POfussfUsm+fPk3T8o420yzV8x0wR8TO7Gy4ZGounkTwJeW93+c3wLAP/GW45VhuJodOYH/5uEslQW5NUc1fFEK944yJQsCPt1yLPslCMRPT6FP9pDJjTOMQZh64BJ5VCndBqYtrarlSUHjAeWZFf625XcvdBa8QSNqOqKN+jlTAyzUB9HhzPw7mcbGrpzWOY1GVY8rYwN0DWdlobOf4PtciokXOoTHpFoF5c+caGtM6rShWXoV8+qophcjUTockeTT92rEe1Jo91tGP4Ta8HuLmxIQ/VkxXClYy7ImUrZM2ncImz/FG14WzRRKR82R9YFAFONFV6eXqxQBDHjG6Suzce9MMn1aCyIUHvk3We7u9XtR9wu4Hlm6bC5aRCn7xbkI2755l/zTsGyU17PN+b/qKuToRBRB9HLaLuMz8v7jsY3nletOxpPUDhac2/S9570snFbcbH9REMzgRaJ/vU17chQP3ZDj/1dH2pKYVcKtvnlkFu197e9ArjWfu8UbZfM72SGLZEWXw28v1L/XjcD79BkfXPygYr8uq753aGI6hbjA/WwuaD39V3Qu8MbqluYc294O98d+8wE/ugsXAR8LNZfnl/LR/X1x8yabFT8LRemz3PWBY6a1+UfwEldBW/eYqx3Z1aQf+0/QTQmrnykJ83W28LfPiMgI29pJcMP+t8e3Nz8H8UHJzo= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 potential role source usage' (get-potential-role-source-identity-usage)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Retrieves potential role source usage

+ + + + + +This method returns source usageCount (as number of days in the last 90 days) for each identity in a potential role. + +## Request + +

Path Parameters

Query Parameters

+ +Succeeded. Returns a list of source usage for the identities in a potential role. + +
Schema
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-potential-role-summaries.api.mdx b/docs/api/beta/get-potential-role-summaries.api.mdx new file mode 100644 index 000000000..d8c831bfc --- /dev/null +++ b/docs/api/beta/get-potential-role-summaries.api.mdx @@ -0,0 +1,95 @@ +--- +id: get-potential-role-summaries +sidebar_label: Retrieves all potential role summaries +hide_title: true +hide_table_of_contents: true +api: eJztPGtzGseWf6WLfIhEMQgQSEJVW1tYwgm5egXQZncll9PMNNDJ0IOnZ2xzVfrve87pnhcvYcWVjRO+2GLm9OnzfvRjnkrBXIQ8koHqeaXz0kREd0EkVCS53w98MYhnMx5KoUuVUsQnunT+UOp1egzfsWuppJqU3lVKntBuKOeIBpAMp1KzmYimgcdCEcWh0iyaCjZPMLMQh+sENxsHIePm4YxwMi20BmRVmHbOQw7IRIiTP5UkzjDn0RReKXgBvywwMFApaXcqZrx0/lSKFnN6GYVI5HOlFIoPsQwFsBmFsVglWqyjgEnEKj7z2dxHdGduvV0TJ6fO2SnnTlN4bYe3ayPHa3ut42az1Tgej2AyS+eHWISLHKFBSHzkaRlzXwMxOloQfhDFjCac+4EnElI3cVUheB7BEzcAaTpaoLgiQPy8zOAAJgd16NiPNIs18ohK0RFXHg89phcq4p+ZGTQSHpOKPfzXMevc9dggAboIfF+4iJHdpXp5dzCNork+PzryxEfho0VVNZf+PJAqqgJhR9JTR3wuj5LJHDfF42T6/Q7lA3Q5lsrDR/WoBuYZA5PS8XyOEvTIYJD4MaAJPuHrsRS+p89ZueyGAgVwCf+UywXd5d5sVNFY+lZFRem9ped/cfkZ4pcl+DZ5upsMGUzBTFQIQn2OGFKhvln0vHIZpCw+VJj+VGFuUF4CuAFi1oPkBEoAhZdCWY3BC19UmB/ZF2NgZarAGVOkE3g9iQAkD6Y2Tvsh5r6MFtuHg2DDKCXAgCSv+EeRMG0foRMmTwoWdlAQA9DAHsHKosfSIQr1ICdFoBHeNdx2/azWrp0mEIiZiQ/w6uL2+vr2Jnl+oFJ8EEIRIWjvgEhDcIwSh4dfL648b3KPYDzWIlrxjlt6DBYfBcamYt+3vgKBNKqyew1a8BdMz4Urwc489klGU1C1nMmozGDYnE+kAunA+DCIJ1PCY824CmFAiD/Zmw7JQ2ZBKIAvE2ZtRloRcmoAtTUihVnFRIT5WA2PjhvwAFPNLJ7ROE+MOfAKf28UPglrRfbXEHRUPBtBdArGaYACiZrU+83IrtH6A9Kb8c/mb8KSyhJ+bZSmG8RqVZq9MSujb5SZjMBGwYznwTz2jWEKVv5vZxhE3HcucHQZxT0PlBZsKrgHGiCrRsA1GplywBjEvsdGwioHs8Q49QL09LLxsDL7JFB4EwUy9KqUCKVycRywoSkjclAykMKIEeZyxaYQD+AxaI2EhfByNucuRDvgBqJ/KLBMgFgLE6sgQivRAmctE5L/IM7LSBNR+5H7sTBSQGggO9YJNd+ETW2IcqMACj2uSjlLoZHPz+8Qm1GpxgGNWg3/W6qkYtcVAmRYZX1b3nLmSx2hul9X5LqBwmE4F5/PfekSc0e/aZzwaZUDHoYcbVlGYqZzz4PRbyA4rJpDFHQkDRtQxK6pHZcs30PyV+v0QoITNddteaeeMxqfjp3m+KzujBp87JydnbVGtbbXbjeOsfQ0PvbSlJQkX5407UhM2+EwQwXOM883K30xXlXWpYjA2EBDoyCO1s/0j5QdTBTJiGDwjenl7pbFCVDSw0fRgiLe2si82khl0c+ORgeAepgvkVpdF9dzGQGmp+G+gKAVvY6CHIJX0FBv5UTwA1Qmc4h2UaxfVtDQNAcAa0ttiL8JIjZBTOzTVLpTitwQWh9L/e7P993BsHv5WGIw4rF0+2bY6d3g74JOk8fkAGHwUWIUQbLEqvnnqMDglEBTuZ9QtSQPdpEQdHc77N4Me52rx1IFf3ZvLns3P5gfbzu9K6SsYkiFcvXuqjvsPpaqRfszYzIvS6UlFObrh2wSeJZBJ/jgTzMTLjO8YLB3RVlgyw9Pe7v472XqSgkOyJAUq8Fier2fkcne5U2VsRssbSlBrkgO8q+2iVKoPCYUiYJxfJQlpUxEDd4ciZPxyB0fu01xcjJqt3jNrbfGY6/VrptGXmmwmh1N30LjCkwoXXZQc+q12qFhcI22f5STKXhKMopyPjqKh0kIeDKvNZQoPiQygOCzQE20iaWZe293o3YN2EhbuR0ZSeG/kJVs3DIz65SGa1VYVHgSyyqoOj5iowVlE1QUWCCJz9LUWwj9ApunyKZtOHdk0kJ/IYvJqF0YRKtELaYqxjozldF2hs6QIcPFcmTp5yqZbEaErW7x9sFd9wJ8vfe/4NEV2+Sia2fuUIRYdXn8a4jYgTJbQW0Ie3YFLysh1+fLHLl/oATAGbMwsqbMK4TF9vj4ZNwSLacuoAxoCpc7o9rZqdNqnrVbUArU3dP67rVAjtvvNTOrAjRyW9gZEFj/mg2snBxWOz2q13BaoPwmnvVS5+6pQqDdwbSvTXO2cyWwjdRGbcVEKfPFSgynaMeB7+3obTQIlxjMKPRv29VghEcK8JHLfdf0fPMwWc67K063hdzWOmpJKdtbkE2r0suaNem8tNTm4BxusM5RCQe+WtJCmv9fMNantP7pebgGD94K2HFJkdOadhy6oormdn7JIz5wpYDGE/80K0U8AqMdxZEw65AX6VCgU+q5z2mtDH9CdRdypX1avz4vXQWmCzpn15LPJEoREhC/4iPh7wbuARFr5kmH/UssKPnfVHuXWIMM/+d9Zzjs997cD7uD6tXtRWfYg/D0nK3A2DmArWSFFJ5C2da5GsAzE40xzBkS3j0/P78cW3KyfbG/y3YzVnWcdKA7qrhQpz1kS5Endd7i3K3VT08a9ZbbPOEnDa91BtBrQBqNWgrTbADDedvYJWw9QgznoTuFkjcZaNYeQEpe7Aqzc/QK1jYHvhcs9nmrye7Wf6/Vj1mdz9h8NQf/DMdZ26DaXDWgSPeK0uTPq0zWt2P9VVUzA7qZsIt+tzOkKe/vLu1fVuy97uB92g1C+9S/v+m+H/7Y7w5+vL26LLxKuqz3/dsrGHXXv73oDgam2Vp+mcxY4D4jY7Nakr4L0w08vqY94DULaOZ1skdM6RdqAjcOQ9DVhny0STzXnZt7ah4798Pb9/3rItXp2622lNG61eyyRc3LKNhlCcVsny9Kz8aem+tWEy98iUx3wxDigWNXFM3CsNkCoQVfNgq8BfYqUoGzSO81i4YbMpBHK2QXtC30Ush+K5VwJiGXSKEgkl0YaJpdj3RKvRShTIphgisuC4AkqnX2hkMBavm7sMygUEPu/g64dunc75WE8SwZAhki3dhcM604FXx0Ums3muOTJueNs2b9tDVqj/nxcQ3q7jbVvqBrPhHrsnFx6h+EEtiyYWzz5b9xwUBwkD0RQJPvvkBLOHas9A1syqall0Xic1SBuvrNxR1rnjKfq0lMz/lkSQjKuR+s5Bfg3CC+DeVEqnWkJB532X3bub8awhO7YlWqIK6VcyAdlTSmAXUA0+CTyeaGgU/Ql2qBC/24kl62WMvAELcHRiygNL/0QoMwma2XYYSdfc2IPGpodYNZwZXIbz5H7EBWRbUCDQA8g3LdnbIRp05Amb2ejuuKeeRcWUmW7SbPYZV1PE8ik5BVbAc+4wvsJLjnmVhmdkHBlQXtCeHaswoi6YqiLjJRLmf7JLJc5ZWCzgGUv2wnHTeKMeUhm3kvTK3FkpgsHHhWckXqhjmhkUjxiIMLXNBerhtAuHYhMgFvMtLMhiM6ZQCBRyVwacTKB0wKd9eGmCSYujzWO/jdnQ/hxyHW0hcfhXU+2vk00Yi0kajJRiS7P02DLVSqrsTxzTmIve/ufXfvuzv67vLLvt1DtW+p9Kmvlj73iscg35CS50rpE5L1qIAlQFTeWEXStoMtkX76ZQiO/btQCC8+z3Ev+CvWRyaVrxDfSfVhj3wlJ8KS1J/pAgkkORoOxhCJhHdOdGcUmyKRRHW8OtvbIBxJMFC1pkSEqBmyRRAzDiILY0WFM9cV5gVCq+8jey4APEJrEwFxVuU5Zgt+X0nuK8l9Ntpno79NNtpXknvf3fvut+m7WyvJlCryFlsnabvGRpZm3yO3nAFAdkAzdTlS1XK1gshYWmOVipVDadSoj+rjU1c0Pd70To7b44Z70uCt0/ppfdRsnJbyuf4h8+PUyYo+ldO30aPd5gs/Qh0XKzAuHQWBV1z+i/HyxhjDGoaetG4GmYNI36W1Y6O9ZgMwCNg1V4ukQtKFGlJlMsKYBrAzhA0TWNqsnUBcVHiwVAbmqJuc4WEyvGrC6PQqOi9yAXjDhdMZ406HPRNrjSydRSrXj4FCigR+gFVzAIYl8dzMGGs+wEAV7ASi81esTq2K/lAlz/rI8RVyzLqfzSlQllburXXruz0gPsQYMTAK3rDQa7odrsAAoCEwMSutO/f1+b4+3+f4fY7/e+T4fX2+9929736bvvsF9bmthjbX5wCwc30OsNUaS2upt3Rk7s8u08lVLAVk3ixw6dCCl9XgVFeYYw94mx5jCF5WPy8d4bEGxxxrcOyxBn30lF5efz5Kj6o4BKpzd+9Nc2DIjkMf0CWXqp5gDGjxucrnspocJlPBJ7pZNQIRrolOeIzAeCIC0B0uM0GV5B9KNHETDwm50YY9plhKL29txazs/ZRFEEMEJDQVPIJjzY0e0zFrtfheE3SVzGuFP+DrPvSf/zgvBtEGXtaJb+tsAM+A0iUWkYV3qC4wCzoDDvq6B3ouTDDrxGgKD+/yMAMs3g2FK5BZQsKGr7FC0C2CNdgbwUPoLMweyMFPvwwP2QRLVgoZ5qq6kNhjgNPdgRlRSOwk+wE4iLJUdu+2U9hxQRdkYx+EwuzFP3syeHEDuaIPwZ3EjoMExRMctfu1P14Yt+Ga36Ny2KUMza1Ac/rPsmiuQj7ME754jq/XEvFdgs0x2BzChtfpC1QY0T645gSPC3HA+K8mab16coPPyeHDRgyeINZlGlASlo7iPpmbaO3VdBTwOYivSMej+oUuMBWHJae69JTuuvaYOw0CLf6TMTQddJWHSQye9mqy6NaUQx7hNGo5khwzpSMdqC6JvitwDGWMydz/o+ImgLpPecZtfyXNQlz4la5F/FrgmR4/QBJGSC9wv+Au6xLNOKGDEzomTmhLv8lxaFjg28gDxQFjABeZ/ikSWEJzsdHgWhv5Cf0RjSnZk+GERc/PzY/zLAjav8whcYROYSBUY3Ge7hzCb2ZxYaIrCCtZVliW4Cq9fgD5dUluht50WQtz7l+NX+S4k62+3Cp/8bWj9IZI8teJu/9PEW8faf6OkcaWy2huNK3tK/JG/sbWdKurgZo+yAD/wlvyVarMoe/JvsGQRzT3eYRWTV7tTqWgdYS54BHWhxW0rGBGnggtP7o/dIuEaELfbAmBZA6dn8Rbd7TSnczMyWFM8Yl6xd86pmaGrhJNoS8VVfYLtHbKBbVgW4dnNeDdb4Ht7wagmTtULLtMlA1F12wWK7yuB2THM8bBpF6wCE9qNzaBC7o8JRJZBJG54GlHJV6MpoYs0P03Ec707RiXqKH7zSn+hblA79quT4PoUYv2wH/GSF/4ZJkIVyztX8IN1uZMhT/HxhKiLhRgIjfDdW+4ghGQKXu9IwgnR3aQPkJYQIItlDGf42q9WnOopaCvCOgIWuEcctzGQBvRlAI2fdNh2SqfsoX6r/wRNJtgsDM4muOqGJIdm27G9JcPpXX9JQw9z38ebWOLCQ3JFKSAeJ6ecIEFe65nfGw+m4KNDOgFnSX7zsZG5v+p3xpbq6bf6bJM9u03u8BRom+Q7S7T/RfI9l8g2/QFsi12l33Q7pV298/6ttcWSabfPnulIL+tD3VtEUTyHbJXymH/ia1v7xNbW6wh+Y5aZg3vsoXXL6wbDvr2U16HdJhk4/dY15KTbCWqRZ6aNP+mVdAz3lI2xkTkmfdmGyk3cuWgBfKVLu3/0IWK8vn/AJOcaDY= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Retrieves all potential role summaries

+ + + + + +This method returns the potential role summaries for a role mining session. + +## Request + +

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 + +
    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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-potential-role.api.mdx b/docs/api/beta/get-potential-role.api.mdx new file mode 100644 index 000000000..972352560 --- /dev/null +++ b/docs/api/beta/get-potential-role.api.mdx @@ -0,0 +1,99 @@ +--- +id: get-potential-role +sidebar_label: Retrieves a specific potential role +hide_title: true +hide_table_of_contents: true +api: eJztXOtz2kgS/1emdB822bIwYB7GX66ITXbZ84MDfKk7x5UdpAFmV0iKRkrCufy/X3fPSEggHuuk7nb3+JLI0kxPv/vXoxFPVhCKiMcy8PuudWHNRDwIYuHHknvDwBPWiRXzmbIuHqx+t8/wFruRvvRn1uOJ5QrlRDLE2TB3PJeKLUQ8D1wWiTiJfMU4U6Fw5FQ6LEzpsgipTIMIntLlgggyJZQCShVYM+QRB0oiwpWfLInkQx7P4ZEPD+AvMxiYPrGUMxcLbl08WfEypIdxhBw+n1iR+JjISIBocZSITY5FGQdMIlXxhS9CD8mdO7VOVbTa9nmbc7sh3I7NO9WJ7Xbc5lmj0ayfTSewWCmfYV6bX8dtd12F0mXSL1fiC/h/xPVVGPhAArmrV6v4X5GHUeI4QrjCrbBhZmJPqpgF0zX21G4TO4GPo3EJHoaedMgJT39RuM7TppaCyS/CidE3InTZWGounUjwWLhvlvuHglU3lL6u4/4VChKDXxDhICoosu50aufVTrXdqvEm50611m7Va02n0eKtuts8Rxu6UoUeX96S+fcthw5oJjB0mF2Ld9XcE8vKQIrIEdYzLBXLmJ70QOnx8jLVxNX4rnSh1LuNythkyVwRc+mpCjEufAVkckxLsNBMROVc69HIMF8zfCXPdrt5YoEfLHisCZ7V9Vo5egcpaXVn75JWlsF0vkI37DpOkMA98EFXhDHygENAfwv4/xKfHSi4nywmIkImcgSUDsQdTNVL9SC+OF4C0dTLkdoMOlw2jbHcohD/isUBmwiW0sEljQw8ivgS/pSxWKjSbJPx9mBV27w6aYg6jK+d4QWvWo8wZAoZYe6D3xyonGz8C/1CukL78osMYmZDuL/QHOnyVxK1NElS/1zLEWYU47EeRTGcTTjABlsSVEbvsOTRd9N0URS0EAvg7TyK0V1McioIdiif3HUlzuHeoMDxmk8VnConzz+4l+C42xs2hvTFzij/k4lbz4/5VIYBq/FFv8wWzzkj9d09oYLhscUPvmWM+AcZ6zaX3XflrhH/BKl5LYPZrNo+rVWRIfCYTxLT+CiGJF6ugGwMlVwcty0c13kWEEwo6+Bu3Lsd97vXcG/Qu73q3/4AV5d3N4Pr3rgHl2+7/eveFWLAXNrNTdq0ZwFWDopSgFwfE+4dXn3M6L1ZplatlsV5pLHYQZVHj91fdFL3sNu83bIbjSm3Jy6ALKfVaDUbk1arWevg2goNnFt6EgAp7peuXVzvO8VoMpk0UYXlES8icYP+St0irf8rcL3dIb8eSeGKKzS1D6J2pmetaVM07Zo4rwFEdUB71fO23Wycd5odt1Nz2jXr4GDLSZspjWYCgcTz+CRV2WbkDW/YyOgpF3XA+W2y6Gf1pe8Xu6T9XotBsEgWB1erXazWS506jBJfjOdYgQPPPTCQaBJYyMwycCJRoAlATcgB3nK45yQe5pEwIhIT4Q6Ky+1gt7TU7gqDKU+8eHvHtm5ZHQ5l0eAE4ZYUSY/WrIA4McYedo+zPhVL0AMkQaAO8SQ5umSQAD6voLtdXPGYjxwpfEfgpRJUS9Oq+FZ6MOkym/q03jtAgYy4r1Dx2JtfB7pHuoAOnC8kapHDxGs+Ed5hw11gomSdbNrfxJJ6oNtK/wpT+fifH7rj8bD/5n7cG1Wu7y674/7d7SoOLc+sAWLpfQToWaAf+ft993oE9z5h3afNA80ClPrn/bmlUN4PrtS7cMBBJi7k04f9vd5J2ZB6vZqNadQJHzg5A+9PW+8hh/PImb+3WDoROOYxFnU3cUCG+GWibU98ezz2eafLHoYgS+0zJWIrMV8swf9H4JSiZFOrRpTpsthaz3jDnEJXZYbGbseAo0HvEsBc/1+A8wj73YAEBcBXHLHJHF6Nl5oxVQ5Xh5um1oh1B2OXw153TEveD67MlVF7vzf6cPdm3O3f0t3B8P6292H847A3+vHu+qrwKAWrH4Z31zBrMLy77I1GGuiuP0xXLEi/YmO7WVJ0i+UGbt/Q5mjJrpp+nG6eUvkFTOAkUYR9fnk92qaem+7tPWHw7v347sPwpsh19nSnL6143el2gwxJXsXBS9xvVw/yLf2vVIgihNMR1ijb9Lz0JJqhF0WQoWyz8YkmMthWfIRgjdkkcJdMIpqD8JXuN9zk1Nt0l4F7APZ9K31hzyIukUNBLDswUTeFLnlZEAmz85fCcxpX7GdAE5Uae8MBEhv5Lo0wqMyIO79Sk76foXtfwnyWTsFda53pS5cVbcEnrWqn3pi2GpzXzxu1dnPSmfKzsyp0AtRCLcD7+EyU4YPi0j8IHyqLwzDbevLfAt9LcNA9MUCLH745QzQO7D302ExMwy+LxZf4BJD+m8sBa7SZx/1ZQvf5bE0Jvn0/2qh4ILkmfBfJmSzdOE1j56r3tnt/PYY7Q6gpvRFcIa2NVzZdH7zVRbcMqCeZB581vtACfOaAsYUH6sAN/+8N1e9BIKh7+YFS/6WWCpTJDIKHGWb1khl50mwaBYtCKFHcfInZK1kRlRNoSeAeNBDOnE049SY+Df++6zgijO1ro8nv2VxwV0SvK6yb7VgxXUxh/hJ7G+66OrsigWkCoQzMSMh1Scz8IJbOWl+/UuU6/kgzynXeKBgcwPl+P+k6cYJZEMXMR2HmLYZFYx/gWWuuyN04pzRS6dKPuQNScM9bghqhgDiQmUA2GStm0hGaS0Hi8dNxWcYqvFVAbm40M5TeEcvyRB0QdwMP0o9NomUPPgkTfLRnrbMRWSM1k8lI8BDFpslmVGauNPABOgrqOY+xe4zdY+weErvrD4fmVa95StCntgl97n2egH4jKp4b0Cci7/EDlg4ieGMMeYI7SAYi/fRuDIH9q/BxvPgS4kvub4iPdCnfYL6b2UPfnyD8yIxVsAUySHrUEkwhEwn3gvhecUyK0qo621ztbRBNJDioXwIRIWtGbBkkjIPKosQnKMzVCXMDofzvYjbnkB85RIRSOgPiqr5rh4H04yOSPCLJYzU6VqM/TzU6Islj7B5j948ZuzuRZMYVRYvBSSpZLHi01J5mnusX6jCApYcOWRZyn/RxkSJaQWIsw1hWETlYk3ptUpu2HdFwecNtnXWmdadV5812rV2bNOptK1/rH1ZxnAVZMaZy9tZ2NC8eo0+A4xIfnEvFQeAWt/9AvZGYYlrD1JPhZtA5qPQxw471TskrySBgN9xfpghJFTCkv9IR5jQYu8CxUTqWXh/PIC/6DFKVDPS5ILnAgyMRvrX15EJS8KIUQDda2t0pvnvRgZI6WbaK9Ok4maJM4AWImgNwLAlCiiliPqBACHYG2fkbolNjoq9C8myIEl+jxKz3RR9WZRlyb5bt7/aB+QhzxEgbeMtGr+52uA8OAA2BzlkZ7jzi8yM+P9b4Y43/c9T4Iz4/xu4xdv+Ysfsb8LlBQ9vxOQw4GJ/D2EqVZVjqLR3i+2/DdAoVwwG5NwscOkbhrjA44Qp9EAO/d8Mcgp9sXVineNDC1gcVbHPQQp0+ZZ+aPZ9mpxdsGqoVB6nn9GntO69nCw/jIprUgiSRBwvM4zhUF6enTzAW7Ppc4aGspAfe/OBzxQkWpxNQakm+woMFOjZxAOsO+qYfqZBFIolOrzMkEdf2MUcpLQV2or3knZTTT5CWQQI5kcic4DkN44B0G1gMofv4TtHoCjnchnwg133kPX+9LJrQFlnK1LdzNRjPgNM1EVGERzQXOAodQQd73QM/lzq9dRN0jofH/JgRwnnN4cbIVYnCFrC+wdAdDquzN4JH0GvotyKvfno3fs1mCGIpiSQK8bOQ2HVAGA7AjShJdtM3BDiJ6lYUJLM5CdctvIPBoGRTD5TC3vsjIdhD+kHFLVSPIaR7UjtOEpRhcNbjq9SCrvgkPCyslZW20Tml65+CFk95Yd5rKqLUbUhfn/XFM3vvfZtdScxtGEg0xohIzSN7CFO5eE6ulzLxl5SaranZRE29XuNCq/bB0Wd6HMgMOm4VaevFi2t6do4etmZwB6mu84CaMHwU35w5qdVezEeBno30iny899/NJVTo4rT05JmCAuu5rM+ceRAo8VfG0HUwVB5mCUTai9n6jIvaFBF2vZpjydZL2tIGvEn8XUNg+NqZ+ATrPcGdAJCg7+qw/ZksC3nhZ+jGXfZzQWa6/QBlGUe6gaNezDMuaOOCts4TyvBvPpoEZiG2UQb9ISo5wOXK/pQJDKO53KhplWZ+In9Kcyxzep2oqPBC/3GxSoLmSh9kx9HZGEjVCNezd4nwNzO0sPQVlJVuNKxrcJNfL4CKu6Y3zW+20YVV+PcmL0rcXe3H3Pne8ltn6S2Z5PeTd/9HGe+Yaf6MmcYAaHQ3WtZ0Gnknf2Mw3eb+IG5gzwX8C08pVgmrQydEvR2hmDyh0OMxejVFtTOXgnYWQsFjxIcn6FnBgiIxjAIMf+gfidCMvnCPgGUOvaDETwVp7ztdmVPAaPCJdsW/VULtDX3uNIdOVVTYO2j2fAfMgo0ent6AZ78EpuMbgWUGaFh2lRobQNdikfj4YSKwnSwYB5fa4xGuVE6iExf0fb5IdREQ9MtmpVGMroYi0MFpES3U3RQ3raEfzhl+z1pgd2V2rEH1aEXzUcJKkKHwyDNxXBHa76MN3mbPhRdiqwlZFwCYyK1w0x9vUARivvkEJYhmp2aSOsWxQARbKO0+Z5VapWpTS4GfuwUqhuY4RxxfbKCP7PjVkXWXfFrt23/Lny8xpQV7gtMQd8iQ4UT3MbrXfLDKek2YepH/YZNt7SaOW/9hEehO5qASJP30hPsv2IA94+2PicDmHr9TS3sr6nHAZHgNbfAUksj6p3Z51bwamh8meU1vkLb+ZEqp3On+ob9cbR1YcPkrfTOzEhfbyBex9Bt/F+UFTK7r+hm/69KbWKRJPUpvc+Xmb7wIwhYy23r4oQf+/fwfjEjbpQ== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Retrieves a specific potential role

+ + + + + +This method returns a specific potential role for a role mining session. + +## Request + +

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. + +
  • Array [
  • ]
    • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-provisioning-policy.api.mdx b/docs/api/beta/get-provisioning-policy.api.mdx new file mode 100644 index 000000000..96afe90c4 --- /dev/null +++ b/docs/api/beta/get-provisioning-policy.api.mdx @@ -0,0 +1,96 @@ +--- +id: get-provisioning-policy +sidebar_label: Get Provisioning Policy by UsageType +hide_title: true +hide_table_of_contents: true +api: eJztXG1TGzkS/iuqua3KS2EDxoTgL1cOOJz3CHAGLrUF1K48I9vajCWvNAN4Kf77dbc0b9gOhKRud7PzyeMZqdXvelqj0V2gZ8LwRGrVj4JOMBbJidHX0sINqcYnOpbhPFgLEj62QeciONWpCYUNrtaCSNjQyBl2hY5nE2mZUFFjpqVKmBGJkeJaWJZMBFskyW5kMqFndiZCOZIiYqnlY8G0enDbDcmkYv1IqEQm8yN907xUXZboT0I5St2T/ho7Hhz83N3/0D9aY6fH54O9XvZPm+zG6fk7usd4mky0AWIM+Dbit1QaGCvRLORxDBzAXaDZBNGtCFNsCOLfBedWmD2tEnGbdIECqkRGqjMrCQgaQAk7RvAIuq943LAk1iOtOlOuQCmPkmnwaCpVI7elzTpe3YOlZtzwqUiEsSSDRHvNOHC/Fih4AP8clT5ykuki6CQmFSB+OBFTHnTugmQ+o7ZgWTUO7hc9QGS26u+j4sQtn85i7NIKdzffbrzd2o42dzf52zcbm9tR6217e3vY5q2t1i4QW8oWecQZDrvI1+LgyB/TI1ZWE3Nqcr7VZJeqX3GjNcaZkx3srphNZzNtEnbNjdSprVIqlNtk78GjvHhr7GYCXsjZr+D4wqA78ShyvpQRX3MONeVzBsobj6HZUIPX7g163bMe4ypi5yf7eLlyRNbj4cSHCAkK9EJ4IiOBjsuXSQ29umXxJvxawGBzptLpEHgAXUGoWbGkr4TIjcQIJIpQa2fUjBtBsRnq6RTCtGDGdqCNF6bBKBWUODUi5glmAs1e7IG/J4J1w1CnkCYgMYxkLF6sEd0KG4kA7WLbEegan3LfB8gMgQciFD0wBan5RqdxhG1SC5rB7rlxtMptAsq5VF7rn+f5fBY9l2ff9wWaSokwgdsr3WgV78ByAl4zTIGunauwIsSl6h113x0+JkJP8WH8LdQuiNBStYdPUjtch86L3LMXNh8BaWRWvVT7/dMnCLYv7TeSLHKUniCaj/dYQDgZN31M9TVGPIygDeSOeM5GRk9LvnapftIpBSGQ8FE3gmflIHI6g9lnjg+WZTElRARuU8mtLuyC1Ykasmkaxyhb0Bnx2ELuFJAAcOrK+7o4gAvnTXDh1Y9XvcMePeuenvYPjrD1UX7pKPx8MDg+P8np5H9d1/zvoHfQPz3rDYp+/f3e0Vn/7Keia+lOb79/VlA+Ojze+zf2/Ff36KD38wmw8PF4sI9IZIky6tmhnh3q2aGeHf6eswPkL0qH5zl+vsc6wAg7A8+C8g0midbGBv4sJkoE2sKCnpeUbfugjRtuIRWGUAXaEUws87zWixD0h1gcqQRJ89kM+pA3r/9qkf7d4iSlh7+C51fw/YWD/1i4GIyHRDqOXVGwOL1VRViwbKYd7F2eK/zV0saoa6l4mEjIidLNCMjFw6LnKcyU7vicumzICmvkVsv4chFAQQHqZ0OOHofxozIu52yssUPGPbJclFE1OKjBQQ0OanBQg4MaHJTAwVowkiKObGl+4MZwnJQkcGaXzdfPmZsx1WLLbB7MvbO6XAhymiMkCIwlhisL0k2X8bAkkWfNKYcCAJnjBY5FEpaHycmZNEZkkDNTEijwSedcSQBF7HC/e8K6WTsAVcjCiKcx4h38V6XxeXZzOqX158y/CqmrDHs/hN4/3I2ksQmyed/84S7m/vqHu5R43UP/FOYeIVms0+gDv3VC7E1E+AnYC7Y3Ss9O5e+0UJvfG+RwLMD1VpJV2uJuLt1Qa3BnRQiOR8cqni9foX0fc0QlESFC8EsIBZDU4Nq80knVHcpr8s2gpOQMomQqof/oJSvAzeqZ/jPuVyxwS/sBhpX/5XG6Quavk3GK1BvXRP4Jct4XwfsevXlfJFzGFkA5mKf0cCluxybQpr0M9u/FEnAN6xkDnDbYQCSpgembSacnXxEA8IjodYlUwLL8OrhfTR8RSbKnoydY8T3k/sbYcAQYTBDLIXR0WS9CtU+1QdiNJDNTU7uqmUETzU32jkds4OXb88K4tBN+Alr96HGGfHLIugASz+N4ybBiR/Dhm43dVnv0ps156217c2d7uDviW1sbu9u7+C4kmAK4h+S8LB9Xhz4QMA/KkMU6BIv8DgqBIATdEwM0+NNTONF4YhS5trmYnl+Gr8UQF7/bO2HtHRZzNU7pPh8/UIJqnJ9Wig9MGSC5I3wMSFcuLa+y4mS/9757fnhGdcN/znuncIW0Fl5LdlUWj5pA60TfEMdeAKplRQzqwNn7taf6GgSC/FtuKN0/O4fCeMp8nEIPP/qSHmXSbkovh1Lo3iGyl7IpmmuAD+DelCeA0/OaDpu/BnAiZknj0GvyNZtAkhXmVZN1o0iikDxmlEBcjQBAw5UQ0hEYpRDKgt6R6jTBLCTDB+muUGXVGkU+OSwbBYMDOH/cT7phkgJzJGY5CnNv8Sx6+wDPTnNV7korEk6lc5VgZYuvaaEe1saAhhkkVCYTy3w6QnNZSDwqa5dnrHKapHT3wTHjEiTkM57aJ8TdSQzpp0Gi5Q+uhQ8+gpcuG5E1MjP5jOTxCHX2rXJzZYGfo5U6duvYrWP3KbH78OHAL3aWoc/mIvQ5V34nCE6eC9DHkPconW0X+Z3gjTck7SvxEOnHj2d+Owpug7mdZcj1G+EjN5UvMN/N7eHuD6lYzYxVsQUySHp0EowgE4moQ3wXHJOinKq2FkeD4nYowUHVEoiIJRsWn7TQY1JFpSe3ayzSwqoXiV9AcsuWlAHL24VqJFkjyXo2qmej72c2qpFkHbt17P41Y/ezSDLniqLF4ySbTqfczJ2nZe+VQVrOoAHLXruzPOTIVA/RChJjOcYKqsghGLY2h5ujnVC0I96O3mztjlrhmxbf3tnc2Ry2WztBea6/KOI4D7JqTJXs7exIKgYQh+8lUgXOZROto+ryX4r7ukeY1mh1PcPNoHNQ6VWBHduL2PFIJyAbEAbsaFYsL54PDpE+DO1egILe/Hsf41UHzXlCkJLWU8WttEkNHWvoWE8/9fTz3Uw/NXSsY7eO3b9m7H4RdGw/Bh3bXwAd2wwh1ggh1h8JHSPAHQjNRmAUkCFMQb30OeAMRIErv/qYbXPgZiySHOhVUGRrd8n2VK3ZB9yF5sGSraxEqkJdmN6g7RTbmqytxK03Y0iRikHWkoBu0avkVCAmxV0esZxKimMUCOiaeaM7SkAqFzOZv+WjSBXGKXBISSHWuPaK22MluJMYIfwDCrQOOoZE/Q3XOL21vmo9mA1Q4kOUmPVuQyEw5vP13+1luwT6uKEE08Wps/WK7QJuzRy3KylxO3PpK4egNVSvoXo93dfT/fcx3ddQvY7dOnb/mrH7BVDdo6HVUB0aPBmqQ9vmBsux1Hva8Pn/RuwUKp4Dcm+mQ8LqUYHBCVeAK/ljQTCH4OEMnWDdoXW7fpcdG3G/vng0hcQG+ZdHuA/ZlQiO49TEQGmSJDPbWV+/A0OCAe+bfCab2YdMSt80Qz1dH4L2liQm3IfqghAb4GEdvgZpkuqNRO92qZCIO0P4/bWBBYPQ1oPPUs72qtOuekdmDXcQe0+j28DiDMqMF5ZaN8mzFuQDuc5NfP/1sjhCK2RZpr7PjgbtGXD6QEQU4ao49+QUMbkbfeH0k2KewbcBrYXBjrFZi70T3EDB4DbIvPzx49krNkYkSpkgtQiChcTSAWLpBFyEMl032yyCnWjyMTodu0NjupXtOBhZbBSDwOxSnQrBLkrfabEB5GxSKXYSlCaw19XLzDqRuBYxzo7NQpPoeDJS66ChdV7p94pmQioZpMIt+nS3eakabF9igsLvc6iNF5EqQHYxy+TiJbmey8Q/MmoNR61B1OyrB1w41V6Ebnt3COGNJHhsSVvPHtzRa5ToYX0Fd5DqQx5QE56P6iaqMLPas/mo0GsgvSofl+rjRMI0W+3GXFZjdkKf5vRZONHain8yhq6DYXAxTiGKns3WDQ7aoIhotDZKLDXckA3ZANBI/B1CYCjnTHyIkzZhFu2WTygkfyHLQsz/Qt/6/VKRmW5fwNyKLSMd2mfzjAM2cMCGywHW8++mLnQsiG2UgfKAc4C9wv6UCTyjpbznaC3N6kR+nfrg1BACq0TFzjruT6dIcP6K0QNsnbeBNIyYO99Whp9AeVr0OU5ZWdlqwUMNLvIba5g2H+jN8Zu/88Sp9M8mL0rcLRZV8FOcb52lV2SSP0/e/YMyXp1pvsdM41EwuhsN68uFspO/83htcZEv/1YTnlKsEuCGcqY4+q5MCL/ry79bDCd4ngKumgueIPZbQ8/SU4pEgNoY/lAEEqExfaFogGUOBZ2MgR4tYGcjcwoYByzRrvjfpn47hQaXhHJTNNlH/EA3BLNgtYYbeeEZfmZLjJ6CZU7oXL/9zNgAuqbTVOGBA8B2OmUcXOoRj4ikDVOXuPxHzU4ETdAv75VFMboaitCkusVM7fEIV56hqC0Z/pGxwO7WLzuD6ksfdhaCDPCbYEwe0K4K2x+jDd7WmIh4hvUiZF0AYKI0wof+2QJFIKb8uw5txuu+k13HtkAEyyPnPlvNzeZGg8oFuD/TNoEKt0T8QCSV4zmYP1ZxOGfFd70Lh1Xkq+/f8XGNfqrDGmV9hstudAKGq5lcAXvhjztEg3dKJx8urWGxTXF+BpRFE7AF0ri7w9UbrOru8fZvqcClgYuromCjQjf7Njz/pnOlSV5mH9e+ovdPlaMUlwqVrTiqebHYEMDlJ4FrFLlgWI4+m4v6YIz6YIz6YIz6YIy/xcEYX55ki5nh/goauwV7yvvuuVvSL/VceOmNK235MutBDyEDX1G0+QuYYwCW/g/9+WYQ +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

+ +The requested ProvisioningPolicyDto was successfully retrieved. + +
Schema
    fields object[]
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-public-identity-config.api.mdx b/docs/api/beta/get-public-identity-config.api.mdx new file mode 100644 index 000000000..c1d0a54a2 --- /dev/null +++ b/docs/api/beta/get-public-identity-config.api.mdx @@ -0,0 +1,87 @@ +--- +id: get-public-identity-config +sidebar_label: Get Public Identity Config +hide_title: true +hide_table_of_contents: true +api: eJztW21z2zYS/isY3YcmGVOWFceO/eWGkWVXrWLp9JJMz8m4EAlJaCmQBcgkOk/++z0LkBQpOYmbdO7ajr4kErlY7OuzuxB814gToXkqY9ULG+eNhUiH2SySQS8UKpXpuhOruVw0DhopX5jG+U3DvWb5eykMy0neHjRCYQItE+IGXpOlNAwMDQtFymVkWDxniVsuc/YssIub2EALk8TKCOxy12i3WvRfneFI/JYJkzKTBYEQoQhpGRik4EXUPEnA2ypz+IuhJXcNEyzFitOndJ0IMIlnv4ggbWwLe7ERMUtYGrNnhYprxtNUy1mWQtd0yVP2XkYRm4lclwgEkMcYOYsEm8eacbyu2AfMuFrHSjCpwECwWJNBE02mJwore7lHRVauNV+DVKZiZb6sw9SIkHZb8QQ7bsRmv4q1E0xtlAKdJNdIk0R8zRRfieaOVFhY2daAn1rsbEsq0Q4wHX0stwWh+MBXSURrgzhTqV43Ph40aKuHca0K93n2nYI9+EM9+6weyH6xLg9XolzFoZxLEb5Y32dclUURnxGrVGdiN7oFDK34QmhrW5KtiOpdQzreuzoLla0oq/xOZzC9ntx2BqNRt+9PeoNrfL6+7F2BCC+74/HtcDS47PW7mwej7r+m3fHk1h/i1Su/794QH/o0HPZ7HcsJ3zr+y6Hfu6p+vAWzSXdET7qjSe+yQtyfjvM3g+vrbmcyGN2OO993X/p41L2e9Cb97suu3eVq8Ko7uvavO93bq9FgOsSj3oUl+anysSJ6+SgXHo/6vctu56dOv3s7nvgTIhr64/HrwejidjiADsRpNLCrR1P733hQeTUeTEcdejrxr9y/t9CkezUY/WS/jn/EXuNpn7YadYeD0WTznRi96g36heaFG/zOpPfK6QA5fnSq7QCcrxj5L8fPIkDJxRZHLiYDA6xKklinSMz3Ml3mAFDE5HX8Hpgw1xzxkAVppm0KbqK6YsoiqC/SeEIxhOiV4ZezqEx3EFc5t4Ozo+ctfnwy5zwU4rh1dDKfHYvW0fOg3Tp5evbwPP0+QxZ4WvCQcmUnZaspsdl+soxX3LAuqMGkmrSFwCMxF1qowGpa5OkDUYOn4jCVG8hwy11hwApk64qjYDSI0CPCumlgBK914rWfTdqt83b7vP28edQ6/vcOInwaa0qIIZLj+0pZJ5IgZV2tAR0eGwk4XyFIpJNY55VuFodwnUGQvOOR/LZ6VwckV5I7cfgAF19KJbyF5pIkFFbkAAsZOL6TIVbAwlrkVb4wuqWrex2WaB6xFzxkRSXv5MqQJTUPfgWv3gO8PFUS61mxBEFWQvA924pTwWcnrbP28fzkmPP28+Oj02ezszl/+rR19uzMxvoK9RtQfl/xrW99JZTQaGCiOIBH/gODIPRheyuA3fxz9bruA8vjAfanUuNoSzVzeVkqPqQHjLMXnSE7PmURV4vMPueLLSMobzreDeGDXIiBlgupPlehLrqXfgGiOXITr/tAUaqQwhKiIhaWwLh0o8B7pL0REcyB9o09ybk+gUJcmSqhdN/M2sCYiK05z6IUK/Ld71lRZc3mOl7VUsnmzYeUPZJN0TxA+4ZngIFgyWac+qbYQfMTH71cknr93JJP2BLQJvTjJvPDUJKSPGLIRjDF+jX1gTwMKXUdg3lGOG7RPs5SpuJUBluwvjHldotRwEm/6hRKDkj+5TjxUUIgnFWzmoVltOQi5v6BzM5y29i8MZo16VqlPIAWaGupX9caFmbopGz/mMMRucsAeFRBVyJWFSUt3L10wqCQ2XcBz8wD8m4YAX48q1r54p3Ik8/22A6NrDcKN+WIhJe2MNPinKp0V5H4DPUlCve5u8/dfe4+MHe3X47yAT5/a1ufo93WZ6p4BvtqWzx3Wh9to0dhZM6JXG/tHHmA0blokX54PUFi/yoU0YsPidTfeB5Qz29XyneE90t/uOczaj9KZ9V8QQJaOzoN5kAiEZ5buTcSW0M5Uz3d3e0y1jOJAFX3tIhATc3WccY4TKYzpUgSbg5YGAujvkvZkgMf3cmEQ0DaVYVeEkuV7jvJfSe5r0b7avT3qUb7TnKfu/vc/Wvm7mc7yVIqmy15n2Sy1YrrdX4I696TtpyBgBU/JbEy5ayrtrsVYsbKHqtR7xwas/bR7Gh+GojjkB+HJ0/P5u3gpM2fnR6dHs2O26eNaq2/2eRxmWT1nKr42/nRmhhN3Dv0cZlCcJk0jsP68R/Mq8WcYM3+ilT0zbA5TPq27B3bZ7u94ySO2Uuu1kWHZGo9pNrYiDAtph+NQKsLWhBwtgAuKgaokpCLQonOVD2mETQskitpk5e0AF+99vx5ClVcohRBVu4iVRBlkNAiQRRT1xwjsCSUFHPq+cDBdrALoPMf2J3mLvqmTp6NSOM+acy6H9xPj6zs3J/dd77bg/CaMGLsHPyJg1437XCFAMBA4DCr7Dv3/fm+P9/X+H2N/3vU+H1/vs/dfe7+NXP3d/TneTf06f4cBA/uz0HbbLGyl7qk4Pqft+k2VXIJbHizOAgybY+bix7c9hUIpfwKHWEIT5f4cujuiHmyvA7mBcWNOtf7O6kyHYF6maaJOT88vIOz4KSPTZ7IZnGDQsXvm0G8OpzBQveAD90ScIlGBMwf9vLhomnNqyVFsIM7y9wZ2ypEsQqj24Phz3IuLnWs4wwAZ9kc0H2XPJrsY4iYYJT4zuRXysg4O/pBr6mOPn67Lo7RJ3S5z3yf3Q30DJJuqUgqvCV3wetgZP01hTwdh1V+Rp6+eVulGVNv7iTcodzUG5rn2jsCDYiszV4IrjE4uJ84Hv3wevKYLagjtYiQGWqGhaQRAjk1RBhZxPOL435aZIuQjrPF0irn135QoQxj8whGYW/UWAh2U72UNAJ2W7PTImHhgla9fVR4MBTvRERVsrmxNgWnDNUhrHjIa+se24poRwep3PUbPG2+UR67kARUkio70eQq2kmQ3SSFXryi19cK8Y+Cm+e4eZabebwlhTPtTeAu6ARIc2LBI2Ot9dWbO35ehR/NWXhCXLdlIEvkctR/BgsKr321HDV+HvGry/FGvV5KlNv6MubQjRlUyyhkPRYs49iIfzJGoUOpcrPIkGlfLdZ72tSzGeG1WxWRPLelJz00j1a+PhJDuWDiMyretneJ0dap0KXtz9azwIWfMVqH7OeazvbxDWosUYZxYL5aZtrQow09hxMmlz+/7Qxh6bIZdLA44AKgs/G/RYJc0Ao2Ol73Ir9lf2jXUPkIIKrlYpJz9+V8A4L5J2ZfEHVJA6im3rv8YZBuK+e8qI7VjFWcGmxbcFfeKEb53LKbk7c8taKS+mfTlzT2N4crAxWt/2iU/gSS/Hlw9/+EeHuk+TsiTd4NU7jZbbeu9VKQv8h7ut3DPjqNXgr8i7c2V23jjbHGDmo7V6eTiKcU1Targ6UU9pggETyl/vCAIite2UzERE/pj2HQMlpo0CBtDfpWPpMR3U+mg+xiZ24TxjWf5Ff6bjI7q9BewRJjp2iy15jcVAC30NRGVzHw7pc4H9/G8MyQHMsuCmej6VqtMkXXsSF2tmIcIfWFiAilCTIHXBgclChsEdvWr1xVZDGFGqnQtPOLXpnBnE6gMdxWHP+FveB3kx8/w/TkRXcTvLFRZCQiG5lEV2/tv8Qb0eYtRZTQ3AjURQMmKju87E12OIKZMtAL83msF4f5InNItGBCI5QLn6fNo2bLsyMFniexSTHpVphfiZTV/3ppzco/b6pF4t3m7P33/hVTXjWo3T9M6CSLZMnciOJmwpvGJ2dCTBBLiE00d3d04EFD0kd6jEGfpumbt5v5x84cWGAPPuxQYv9ap+GORjYz9e6PBzSplOPqVRdm/PhfBd3RGg== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get Public Identity Config

+ + + + + +This gets details of public identity config. + +## Request + +
+ +Request succeeded. + +
Schema
    attributes object[]
  • Array [
  • ]
    • modifiedBy objectnullable
    + +The manager for the identity. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-reassignment-config-types.api.mdx b/docs/api/beta/get-reassignment-config-types.api.mdx new file mode 100644 index 000000000..3f2d5b5e6 --- /dev/null +++ b/docs/api/beta/get-reassignment-config-types.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-reassignment-config-types +sidebar_label: List Reassignment Config Types +hide_title: true +hide_table_of_contents: true +api: eJztW1tz2zYW/isY7kOTjCnZihPXftlRFKer1rnUlicPjqeBSEhCQgIsADrRevTf95wDkCIl+bJudttm9JJYJHBwrh++A0HXkS6E4U5qNUyjo2gq3Kng1sqpyoVyA60mcjqaF8JGO5HjUxsdXUTvtfnMmsOiy50oFTYxskBJIOcn4SzjLNFZJhJ8xvSEOZTDvsxkMmPcCMavuMz4OBNMKuZmoiWT+bVLrxw7H3ZAAyuS0kg3By2uo3MrDAxy4qvrl26GmslUHZmGkDhpCsFXaXS5AG2NsIVWFsw6uo56u7v4X9uCE2kdKn2LTpVfElQCvAAyeFFkMqHX3U8WBV1HNpmJnONf6AAQzY3hc5gnncht47kefwJnRau+xGVu1wRdUxiMpJPepMJI7R1VS5eg5FQYGCq+8rzI4NneYoceG8WzNzwXjdHWGamma7ocqzJnWXDNFc9kyr5gNvjQuhl3LOGKjQWzAiMvUjbRBjLhZuVRIZCK4eNJIqw9Fb+XwjryLFo0CQ7FBzlXJc9G3H62mHS1JetTnXT0YpnCqPsArMyiFbP9wz/Z9v5gcHx29tvp8a/nx2ejM3gzOD4dDV8NB/3R8O0bfPC6/+a8f/LbqH/2y1nb+vXJm81Hy1Npi4zP7xfvf5XgcYZ1Q3Ua5jIFk6mioWhRAHOa7J7pL1DpWK1RSz0KDqujs1hZ5i4tXi4/tVaFv30EaPWq8EW6UykKIRjPabzHj6VKVUxYWzdG2DbEwvTBU0ymEDYspcVik1vh8QLf7G8CkUEmMebHxoCsGBZxpQH9mPRGmLDoWKdzJi3AIKVV5wGYUmNHGwdS4QBjBzq9R6xfSSXiqeESNRSkcgITGUi8kinMYLkG1PYiqzjQuLZrwROdPfaCp7VTB8EYdKDhyWeQhbvNXQqdKwnzWTUFIkExuWFZcSD4+PnuYW9/8nyf896P+3sHz8aHE/706e7hs8NDXD2HUPOpsBvAeHX/UsLIhGU6gYj8GxyC2QXphwrQ4rfhdzsGJOMe/h+BXX5sbWbQl+EetwNI8mLwju0fsIyraUnP+XTFCSo+x/JXZUY7a3TkTCnAci/4rZFTubHgKhh6efyqf34ygicBTKIdlLW2wfehMFSKaQmqQi5A5ZPGwYAv3NYo2GFPgtQnYBBXtjlQ+k92bsGZkFsTXmYOZoTVN8xoimYTo/NWKSWeELBHsiM6OwAL8CznDhjHmFuYoD3TeIJlX7j4JHjyCZsBxgnzuMP6aSrRSJ4hyINQmD9HfOFpiqXrBUxKKGVQRrqZLh1T2slEtGOxdGU7GksUOWkGBYsDNL87T/qJgz2QcqJVhXW2BBVDfEBn77m2dqOG08ilc+U4UDUYmc3BjcaAh9kYbJNA5QIcYbgsAI+qxtWI1QRHgrvXXpmXTtO7hJf2HnX3LgP4icm0+sWVCMVnEeg9GlE0qjAFRIKXtDPg5DCqDldV+GwiRZZua3dbu9vavWftrr48Da1TeEvUZ2+d+pwrDk0ZNCG4ea5RH0PZozSrBvmOygdyh4FDAkX6+f0ICvuzUDhefC2kEd+SH/mtfE35fh0P/3yM9KMOVisWqCD50VswASQS6RHpvdTYk0Ry1dP11V5pM5aQoGoDRQTUNGyuS2qYTakUasItMFwtrPrBsRkHfPTdj0dAXFWlcaGhxdkyyS2T3O5G293o+9mNtkxyW7vb2v171u6tTLLWiqol8CRb5jk3c59p4T1ayxkMYNUhPqtLjkK1ylZQGKs5VtRmDtG4tzfemxwkYj/l++nzp4eTXvK8x58d7B3sjfd7B1Fzr79Y1nFdZO2aasTbx5FcDCTuCnhcqSC5rNM6bR//gXuNmCCsIfTUvBl8Di69rLlj73CdO460Zq+5mteHqy0OqZY+QkyDsTmONdVYGMDZFHBRMYAqCXphKslcgBQDScMymUsq3hF9PePMPO5PHJjiC6VKsnoVqZKsBA0JCTKNrFlDYkkwUkyQ84EEYrBTQOdvyE5DiP4Qk2enaPEJWsyOvyZCYKHXzP3ZpvPdYfgWgZ35AN9w0Ou7Ha4gAaAh8JhV884tP9/y8+0ev93jv489fsvPt7W7rd2/Z+3+F/w8sKGb+TkMuDc/h7GdXVZzqVeYXP93mk6lEjSg9GY6SUpDx80VBydeAakUbkohhnC8eBR1b750ZLsuXBPyTYBXrzQZTJs5V9ijbvcaogbRWnR4ITvVfQOlv3QSnXfH4KoNKITXBXzF4QDWfzcMXUaH/GwkprLHPRLuvU6WYdKC9+mE+FbJ1TWPuS4B6UjMDt68CGlFj0HFAnqKHyyN7lAardkHdp2bbPHHbfGCbrBlk/tuXQ3GM9B0xUQ04XJ51+wMCbhffe3G2XJTwaatt7bYWxzWYy8EN9Ad+O8xHv38fvSYTZF2UtmXFhmvkNgnQOG8gxQhWOtXZ/o4iXYao8vpjBTvt741wTJikwwMZh/UmRDsYhic8Abw/hQAmlyKkwRhAs66fFRFJxVXIsOtsLP0JCaeTFUXPNTlrXmPaduj/kAq+DP3N9A+qJi9lMZf9vN3Z4KJ1O6xi6KyizfseqgS/6ikxV5aTNLs4xUtvGsvEn8LJ4FaRhE8s+StBy/u5cUNedhMwROUuqoDeiLo0f6uK6mi9mA9WvJilNfW44N67+9atqYxD2F4WavMUjZkyUxrK/7JGKYOlsHFtIQqerBadMEzpoqIe7sNlWK/ZCxjYIik3wkUhvLJxMe4QxNB0cDdVOpL8iNFFmr+I/TPKfvYspkeX8BGiiNTndgH64wLxrhg7DHABv39PoWJBbWNNhAO+AQYLONPSBAUbeCel7UR1Ul8l+bg1pDowkOMLY78h6MlwIW/GL3A0fUYgOGouvtIR0dZxoIs3KxazqqOBlY9uK5vpmGPXPGb17c+msJ9869mL1rcX56gvFXZ/Fuj9A1I8tfB3T8J8bZI8z0iTaC8mG60bOgNmkn+IvC19RM9PHKeCfgX3lKtEruG3oW6MWIxTUFFxh1mNVV1MpOCzgIKwR1yvx3MLJ1TJULbjuWPvyRAQVOg3nggbYGT8rHMQB6dVlcrcyoYTywxrvjZltSQ4FrJDHpL0WHvoT1TCYQFWzO8bwHvPunQo51BZN5hYNnLKthAuvK8VLAa1mWZMw4pdUdGpNImpQcuaBGUqHyhifrVs6oqxlRDEzrUpJjcvp3gMTN0sI3A37EWxL36hQK4HqOo6N53tDTkVGT19fo2bb9LNmRbPBNZgc0hoC4QMNFY4fVwtCYRhCkLdkETrs20GybZLo4FIdge+fR52tnr7MbULsDzQlsH7WxDOP06Y8O9+vo3GSv3y+tD9v/VL1PCDoOtQbfAoy3Uu/Stim8SL6JbmsQggX7UMANrcfj1NR6GYN+0wMe/lwI77YvLZUuEn2AZfyhCfeVnQc04HZss++31Lxawwalb2Z+OMVL8hr0y/IFLLRb/AesbVOU= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

List Reassignment Config Types

+ + + + + +Gets a collection of types which are available in the Reassignment Configuration UI. + +## Request + +
+ +List of Reassignment Configuration Types + +
Schema
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-reassignment-configuration.api.mdx b/docs/api/beta/get-reassignment-configuration.api.mdx new file mode 100644 index 000000000..e6ede3838 --- /dev/null +++ b/docs/api/beta/get-reassignment-configuration.api.mdx @@ -0,0 +1,119 @@ +--- +id: get-reassignment-configuration +sidebar_label: Get Reassignment Configuration +hide_title: true +hide_table_of_contents: true +api: eJztXGtv2zgW/SuE9sO0ReTYjtMk/rJwk7Tr2fSxiYMCmxZTWqJtTmVKI0ptvUH++55LUi/beUw7mJkWAoLWti4v75vn0qSvvTgRKc9krMahN/TmIjsXXGs5V0uhsuNYzeQ8twTejpfxufaGV97bOP3I6oTe+x0vFDpIZWJIh94LkWmWLUSDjDUYslmcMq6YDPFIZqsOZtAiyFO8xizX3qUWKUZk4ks2yrMFzSxDNUxrHP2gzpEehd77G0iT8JQvRSZSbVhJkinhYLLjKTzAu2JaKI55g4VYcm947WWrhJ7qLJVq7t2s65Ur+VsuSpnxAqNT8VsuUwELZmkudjzxhS+TiNj0g6PeYffw4LDHD3phOO32DnvTo+5Rd7of7HcHM49kTYVOYqWFpvn73S7915z14UaENAGZDD4BF54kkQwM4e6vmlhdb6oaT38VQeatazqB8wrJ2DQOVyyeMX6vP5mG3SJRFyhJKcoyaRUsHzxIglDMpJKGPU2v2LiwPA+COA0xGcvi+yINgfRJBmKLLJsu3ybF+IRmp0lKUTd8vHfY5by7v38IH+MV57Pe0aA76HUpiGzM3TfVv/IlVz4FMZ/ChKHUScRXjAbfMf9bGUWSLxn+JxffYDoYyDwqjOX3SQibKyci46CsScPTlK82hHF0NPEi/sw+U87rRZxHIZtSZFhji7CIwHHlcJmJpX5ohCGddFYG2B1OLARyYZaIQM5kUKUiVyGzKjIz77qz7bOJEek+T5yqfMkiCcEg0yceydAagEZRXeMZC6AzDKFFBN0KM9whP/kMXKmKjY6PTy8ufjk//c/l6cXkAk+OT88n4+fj49Fk/PoVffBy9OpydPbLZHTx7wuqrpW7NwcX3j4uFSTxyeMZT1HSx23G/UUZp+GA7IRnD5DEmB6UbJbGS/Z5IYMFmdlwKLONbG/i0GbYjoegW3KUeo+G+plciqahuv2+3z3w+71Jrzfs7Q17/c7eYP+/JJtQ4TdKFie3CNZhbEzGk5rhDyEklgnix/IHCZMqpGUJqcQZggM+oAiqL+yd+5Xrdrs93/xNut2h+TOK8TyU2WaVuyXkR0SNoK9qS7YQDVFYA2O4pLh1eQswNBMPiPIxJRmPrGmpdpGCMK9QTgJKNvaZa1aw/CZ3OybP2irwp1eBZRxipXpITJxxrDgF+VpkVKFJ9v+2YCimaKPhz46G2sejep2qP2hYzRGcOyQOwtso6ySgGWxrJI4jSX45TVNEkw9nZXlKGE7OXGzV0BhVb2WwT+dbuoqmr22hPY7DBzjiuVTCn6dckoTCiBxgIAPHT9LE3DJOhavdhWsMXafhGlii02PPeAh9rX7HThkyZcqDj+A1fkAQXtrmrxiCRaDMyi3TigPBp0+7R/3B7OmA8/7hoHewPz2a8b297tH+0ZFJRKE1n4v70fgLoUQKtBvFATzyPxiElijXdJnJ78LdTR8YHg9c+C1tqaaTl1FPvoPF+9nxGzY4YBFX89x8zudrRlD+JWFUlUcRpZNtkaG5Zfw6lXOptolSYOWT0+ejy7MJPnGI19shXhsbDiNVoAqI6nqWrFKA1tECqnfYE8f1CRTiStcJpX2nVxrGpMLH8yjDCDf7lhF11hYj1VMpsBsY7JHsiM4OOgaq8DwDhppyjQGxXe6fjIJAJJl/5iz5hC1QgET6uMNGYWhKL7ACshFMMX5FrQcPQ0pdy2CWI5UhjMzQo2VMxRlKbdMXlSmb3qjqyVndKZQckPz+OBkFWQ7hjJr1LCyjxYlYoL7QWa4pXb0bNCZdqYwH0IJH0QpmTLHwoTJBN5lp5soRuUuj8KiCrqxY9TJpyt1LK8xJFptnAc/1A/LuTYTy4xvVygefhEs+TYuerUbGG4WbXEVyK6IZ7KhKdxWJz7AMR2Gbu23utrn7wNxdf1jgHvfUQJ/eJvS5VDyHfVOzeG5An9REj4pZQWQhq3XkDoNBHET6+e0Eif0RXRroxZeE9n3/QHxkl/IN4UelP+znU4O4C2c1fEECGju6TVlUIhEOjdyVxMZQ1lR7m7M9j9OpRICqLRARVTNlqzhnHCZLc2Vaf653WBgLrX7K2IKjPqItgLy2AtKsKvSTWNq2vkWSLZJsV6N2NfoxVqMWSba52+bu95m7dyLJUiqTLQ4n6Xy55OnKRpp7br8XB0H1dXmZcsZV62iFmLESY3lN5OBN+71pb3YQiEHIB+HTvaNZP3ja5/sHvYPedNA/8Opr/VWVx2WSNXOq5m/rR2Ni2ooFjssVgktncRw2t/9y+jJmRmWNSk+Jm2FzmPR9hR0Hm9jxVZxBNzAGdkxv2V68PD8j/pjasCe7xXkaCILZ1nT2K1aClBTDsLTUWQsdW+jYLj/t8vPDLD8tdGxzt83d7zN3fxd0HNwHHQe/AzoOGEGsGUGsvxI6hsAdBM1mcAp0CHKY15zhSaAKXlVHQk35MQfRSqDXQJH9o00UOYlj9pKrVQGWdGMnUlXmovIG2iXRpgUtCDibo0QqOl0kgW4pqugQBTApHaqI5FKaPJ6YEwtZuvJHswxa2Zwp4q2cRaogyiGhKQpRbE87fOYS4SRmBP/AweyDzlGo/8A9Tuetb9oPZuek8RlpzE6/BEJQzpf7v/vbTgmMIXxK5eLC+vqW4wJ2z5wrtBHiS2LLVwlBW6jeQvV2uW+X+x9juW+hepu7be5+n7n7O6C6Q0O3Q3UQPBiqg7bTZSWWek7B9acjdpMqTgIT3iwODFYPKwxucAVCyd0ApBpCN+WG3u7tV+307nV1ge7Go5t7BBWtlHkaYfQiyxI93N29hvPgtJsOT2SnGKTiz50gXu5OYbEtxcjeHKBAIgI2ejN2fUfHmDuVFNG2/Bnm1vhGQYpdOMEcN7iTc3Ggd4WWhFk2O3TBx0WX+RgiJmgtftKGumOiaUM/6HWZRjffrotldIsu28x352ygZ5B0TUVS4X110fKCcLidfeO6ZbW20DcA/Y3JXhNZnz0TPEWTYA/FPPr57eQxmxP6NNmf03VAJiS1C8ifNwgRU91GxQERGmQWnDTO5wsj+KhxBIeyic0iKMzeqQsh2FVxnvoVyv456rQxKQ0SpjTQqPePCu+E4pOIaEXsVJakwJOh2oWFdnlj3GOz+pk2QSp7wB6fdt4pn51IKkoU+obGqWi6PnaVFHrxml5fK8Q/Cm6+5eYbbvrxmhTWtFeBPdIdIKWJBadbLLDWV09u+fk1ftRT4RPiui4DWcLJ0Tw4FRRe+2o5Gvx84teU4516a64iNYcxW8mKm4pjFiziWIt/MkahQ2lwNc+RRV8tlrn/5JuM8Pvdmki+ndKXPoCike8MiaFsMPEpLdQGp8R2y8Sk5AfjWeT8B3PP40NDZ/PxFdZTogzjQH+1zDShTxP6tgZoJ7+79QRhkdukg73BZALguPK/qQRO0Frds7y2VnXDfteMoaUhgKiGi06G9s2wKnDuFTMPiLqkQRkmnF0eJcN75njdmHteNWMVOwTrFtyUN4qxVK7Zzcpbfs9Jy+ffTV/SeFRtpLxW0eqPrtK3VJK/T939iypeW2l+xErjkC+Fm5l27bIWBfkzh9c2N/Zo53kh8C+emlw1IBstjGnKDIqpM0oinlFUm6wOFlKYLYFE8Iyw3w5FVrw0mYjundIfjZ9hNDe3NlOIzNHEyYh+JoM2rYuZuUkYCyzJr/Re5+4IRYyQRIspOuwtujQVwC3UodHhXTz7NXat2gU884Ycy04KZwN0LZe5ogt+EDtfMo6QuiciQqmD3BYudApKFLaIDfQrRxVZTKFGKnRMr5Iu9evZhbsfWDn+nrngd+22mmF68qL7bY9KkXMR2X4FdE3Yfh9vRJu/EFFCPSKqrqCbddUML8eTDY5gptz3G3E633WD9C7Rggm1RzZ89jq9Ttc37QI+T2KdoautMX8hsrt/SKARjdfVXvvX/uyKW0EI+u8mtINFcuW2FbG94JV3Ry8IDsPaz6mgvVhAJxp0fU07H9Qd3dDH6Piprb56XzU+pmGEzek1GtAZqoC4Q8FH5+63Vh6zrT/FslWTYsdOrapm3cPLj4J6/Jrk6Ighu9mMMXJZArtdUxu68YUGdVRlC/3ilEKD37I4uxewAcrP/wEYSuqa +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get Reassignment Configuration

+ + + + + +Gets the Reassignment Configuration for an identity. + +## Request + +

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 + +
  • Array [
    • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-recommendations-config.api.mdx b/docs/api/beta/get-recommendations-config.api.mdx new file mode 100644 index 000000000..82603785b --- /dev/null +++ b/docs/api/beta/get-recommendations-config.api.mdx @@ -0,0 +1,79 @@ +--- +id: get-recommendations-config +sidebar_label: Get certification recommendation config values +hide_title: true +hide_table_of_contents: true +api: eJztW21z0zoW/isa74cLTOK0pdBtv+yEUpje6V26fRlmp3QWxVYSgS0ZSW7JdvLf9zmS7DhJCyzL3L2XyZfiyNJ5P4/OkcVdoithuJNaHefJQTIR7kxkuiyFyv2oPdRqLCdJL3F8YpODq+R4eMxW5iTXvSQXNjOyot+gcyackeJGWJb59XXgwbjD+Kh2eFFbkbPRjGXCODmWWZhglimnYGyErfAowP0u2dnaon+WuR2CxMrKB/mCIF45oRzR4VVVRNaDD5aI3SU2m4qS05ObVQLk9eiDyBwWVoas5WQQpWUozCvBXW3CcFzEjeEzrJFOlN1xC0HUJJmvWuxEWsf0mMkcokk365rKabIWG2vDMl5kdQGB1eTLlgNr8ZmXVSHIaR/06EI6PPeSQocFpI8Q5l8To+sqIXEqblxJhuklPHPyRiTX8zDpNc05FSbDWz4RF1PoOtVF3tFL1eVImGRVrYupYFVYyG54UQvmptzhj1hzWKMZnssaxrC1qbj12sPweZ0Jxtk/j85XFoJlKZUs6zI52MIz/xyet3sJDFZy+DkZF5q7rkW20mdQzdRqWDt9Lgr4943KREefkdaF4GpNoeMxc6YWPWbqQtizRQyERGG3sijYiLQbk5EQ47fSTZkSt6TFxHBIBJcVxYxZzxczWlczrnLYJlo3GMwyGITspcRnxypZiUIq0K+DbGNeF1BxzAsrOgr631BRq2J2Uat7XfZ7qvgDlYJWzscywUw3EoJ4L51O5nOatXsvVhSSYvHIGGRTH0iGxFUQUI5jUH6CdI6NdD5j0jKpIK/M0x8HG7lwXBaHOhfrqLDqiVcwSh8GlSSh8CJnWEhmvpE5YUCpjWCBJKEHqeDnpd1oJ0uk2+wFz6Fv0O8wKkPGNDz7CFrH+dcFulTyE+VwXAK08qj0AFuxJ/jo+db+zu74+S7nO3/d3d57Ntof86dPt/af7e8T91JYC0i5DzqXWb8WShiZMcKvQv4bBjGCw/ZeAM/8HrR9wAeexjfYn9ArzG3VjPIyh8DtAZBeHJ6y3T1WcDWp/TifrBhB9S/PMaLqouAjGqLkmveiEG+MnEh1nyhCEYxdJS+PXg0vTy4wcnb0j8ujczwRrbU9d6gQrTmFJURFLEz1rZc4KnDLbZuOKXsSqT6BQlzZ7kQZftmZhTFZTEasiNzvWdElzcZGl0up5PMGWf5IpiLtATgwBoTIpmzEqQaISPBkmGWicv2TaMknbCo4QOdxyoZ5LklJXjToUfIZIRDPc0rdQGBc0x7ssUjXjikNEBLLvliYctkbC0Q56TqFkgOSfz1OhpmrIZxXs5uFbbREEaN/IHOw3LJ0Fx2jeZPOsNtmDZRm2mDjAzJBN+ksi3BE7rIAHtXMaxGrC5Qe7n4LwgSABJ7x2n5D3p0WgJ++V619cSNi8jW7M9DIe6NxU0QkvCS1/eI4q3VXk/hsLAW2pU3ubnJ3k7vflrurL89ih9QtfbbXS59LxWvY1/jNc630MT56lGbNpFCKB0f2GAwSS6Rf314gsT8KRfPF50oa8SPro7CVrwk/bP0RxkdUfrTOWvIFCejtGDQYA4lEfuDlXkjsDRVM9XSd2yttRhIBqu4pEYGahs10zbjxFasiSbjtsVwLq35xbMqBjxwZEZoXNyWuKu9XWiq3qSQ3leRmN9rsRj/PbrSpJDe5u8ndP2fufrGSbKXy2RLrJFuXJTezEGnxPWnLGSaw5qyetSnnXbVarRAx1tZYyXLlkIx2tkfb471M7OZ8N3/+dH+8kz3f4c/2tve2R7s7e0l3r79a5HGbZMs51fF38KM3MYq4G9RxNZ1rWqd1vnz8V9MHhTHBGkFPWzfD5jDpdVM7PrvvhPEYHjEUpeeBxQNHjaHe5goioCQNWdNWPpsKcVMhbnaZzS7zc+wymwpxk7ub3P1z5u5/USHGaujhChETvrlCxNx0i7W11Cv/Rfj3LhR9qkQJfHgznWW18QeeTRUII1iBQelmnsml9R/KicIQZSPGrufXJAjCLV6xIZzh9CoZrNzaGGTNdZtQnwa5a1Ng7tS5yh4MBndwJ9w4T3kl0+a6iNK3KSgNRrDhPfBEX7JDKtIENjw9jgVw6h1gJMV4AERPPLgjfoZPLNziDy+/SFnx0vt5pmtAoCfTY8iHGG9+GCJWXM1+sX526uNrTT/odWmK+f+uSyD0gC73me+L3DCfQdIVFUmF60UInFNlHrivBcJit6F+YmeN2RuatsNeCG7QNoQj9ke/vr14zCZUj3o8qC2VwkJSA4GMOkWIeLwbNsfNtMhvQUbXk6kXfLh0oE/5xcYFFGbv1LkQ7Oo4GuHv2AjOgNzepLRIeLCgVdePGu/k4kYUtEemC0tS4MlcDWChAV9a99jvh75xkCpcx8Fo+k712UtJMEVB7+dEFf1ZOruqGr14R6/vFeIvDbV+oNb31OzjFSmCaa+ycEEkQ5ITCV5Yb63vZh7o9Tv0qMvCCFFdlYEsEeVY/gyTNV77bjmW6PWJ3rIc79TbqcRmu7yMBdxiFntlkbNjlk21tuJvjFHoUBpcTWpk0XeLdUtM+z4j+jtbHZH6gWVf9lE6evlOkBgqBBMf0dbtKxeNok7lISXfe88i59/7m1Tvl3T2w1fYYWlmrjP73TITwz4x7AcMsFH+sIFRYCG3SQePAyEADhf+90gQBe3gXqB1L6p78gO/hraGDKJ6KrY6CD8OFgAXn5h/QbPbOYBhqrzbD1P4zSIt2sWWjNWcGaxacF3eQmPzXLFbkLc9NaEN9Y+mL2k8XBytvFHF7Eej9ANI8sfB3f8T4m2Q5mdEmlgLU7h5trFp6Ab5i1ivrR/1WboXLPAXb32u+rIbTU24WkpVTJdQVXBHUe2zOpvSTXM0FpXgjmq/HkWWLn0mop+n9Ecr6AlNDOYgbS1qUj6SBeil7GLBmfuECYUl+ZV+29p3KsQrm6LpFCl7i75NZXAL9Wx0FQDvPujYvJ3DM6fkWPaycTaKrrKsFV3rhth1yThC6isRkUub1QG40BQo0dhC+9KvXdVkMYUaqZD67sWU9s2Yzp8lXWpOvpEX/N7cj4fpyYtUpVNj1CpyJor2fvly2f412oi2/lQUFXWNQF0UYKLD4bfjizWKIKYs9EJ3rs1kEBfZAc0FEWqPQvg8TbfTrb5vF+jCurYOfW6H+GvhvnhZPv5ngXhosBqdd4vT+B/6/xriNkP9waCigy8Svg79SmgPr5L1S/2xQUTLMYWeNOfujs5HqGOa0/CnWlDzfXW9aIZ8D4oF/pzEd5Qfhe/P/UnKogVf/9aw1Lm+PiIf8Qd2yfhArObz/wDJYL2t +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get certification recommendation config values

+ + + + + +Retrieves configuration attributes used by certification recommendations. + +## Request + +
+ +Cert recommendation configuration attributes + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-recommendations.api.mdx b/docs/api/beta/get-recommendations.api.mdx new file mode 100644 index 000000000..a1c739cdd --- /dev/null +++ b/docs/api/beta/get-recommendations.api.mdx @@ -0,0 +1,103 @@ +--- +id: get-recommendations +sidebar_label: Returns a Recommendation Based on Object +hide_title: true +hide_table_of_contents: true +api: eJztXHtz2zYS/yoY3ty0yVi0Hn7E/udGsZVWHcd2ZbmejuNJIRKS0JAES5BxdB5/99tdgC9RltUkd9dmNJ1JLRJY7Ht/CwF6cFQsEp5KFQ1959iZiXQkPBWGIvLpqXZ2nJTPtHN86wz7Q7b89m7H8YX2EhnjZ6AwngvWpML6l0OWiDRL4O9k6d2Ea+EzFbEU5ibij0zoFB9Mfhde6rIxPa1P4YlgMvqoPsC4yYINfRGlMl0Mf2Y88ouP5+qexUE2a0mYks55iiwkUnxsEqzxACqZqiSEBx4PvCwwY1xQheXutfIXzvEDfZSJAM2lSSZ2HE9FKSyNr3gcB9Kjmbu/a1TNg6O9uQg5/pUuYgHKMiIC3ThBO6RS6JwsrKIrI3mS8AUMlKkI6Xld62dSp0xNc+2BtOpJWdGia5eXuTb9CgMaiEUzZ5W58/FseArvxScexgFO6XpHvVftV72DXs/v7h8dtTvmL+/gldduT7nzaOR5XiFyA06Gp6gANB/3PKE1Q9I1PaQNR2JgZncTng+6PeG1e4f7yLPho8lPSWVwPh6OzwZv4f8NPvsld9+BnYAGcRBlIcZYfWb/5GRwdfX+cnTxZng2gAejC/jf3SMyIVNaypAbArWRmDrVN/UQHBnPoBHikxdkvhiCsyYxqMf6RSnSRKlA8KjB+8BMhNCrzYTPVrk6ho/wfsreORgS7xwXUgaG/SZz0rmE0E5Bn5MshSeaRSplOhaenErhu8TPlGcBRJgz5YEWNa2bJ+hUEbE5TnikTfC+BR3xmdhExpu5iJgWKboORTWxCYkgACszvdDoVpkWmp6ndg3IFaFdA52K3hWMs4BHswze/UkBTsUkmw0jzEXccPcs9yObY2u+LpJaIkNVVwR8hika8ogRSQtNxFvli8/SIymtIOOPskDoUcnjiYqmcobDoX6USaXwB025PRYgzSxRWQwyAq25CnzwJbAK9zEB6BRG8QRSN5Hb0GeeC5vTVMEgHJb7K7lSt91u5uJV9QpdgjMv06kKReJ8xUphuFlXKTaqNZvk4G1V+HarAjp29cV6SX4dXK20+ZIeWwwGmsRe6r+C/4S/w84vcADm+drjt/1fXw/s1KQoBSJS2WwO4V6kRDRlyD8A+aXFkfL4/ZuL6/PTnIPCIy21qcoiP69DJrFXdG5kPL+Af4gZ+mApgrIxST9VPp8KQavJx1WqCyyCWy6T4lMccBlh7Wl6qgHHtBwKJcIYpUMiqwo8DqF8xyAboQIwF4NKylJMzuAy4c5cMN4tFPFzGAYJKlEfRaGqgAOrByyEFDbX7juH3blseal7GQRsUquPmc6F8AIJy4KfBwrqEgig67ZA743T1pmtmmwOuV0ksMgUzJyWVb2otMsEPR6hfLA+0TUl/PqKDaIZ6Hleo5FzaroTgzIKT791Dvf/SWYxvgOZByakc+MyPBTMFzFP0hDVOOeUThDDkK+jdaSueescihRnc4lOHMbcS/OWA/SbAMRg2lMJhf7B4fp1K3Vw43UD6IeeWXavu35ZVLCl+LUWxVhK10K1PJ5Kszw4HwR0YE4F4rR4LN1fuu9vBsMffoQ4HfTH16MBZsnT65Px++H5eDC6HA3G/fHw4vz9jzAIKH7kQSa0sTNltNyYwNXdxjWUeNmkJsLAvBxVXdAix1qK/TLJHkvRGlpssmWGAmJKDJ7wKVDVU3zqtamtFjvLOq0UoiY6X58YVzGyY1P7wrjjRADkLDYQ3FpVA3xZgcCrURuBZJvAyj2AiZhLyE0UAp6IhN1KwJwIYdKAelZvAHYJRHwZiCrhSz5zGZd0AJfs7R/6r6Y9Pml39g9FTxx0vclet9PzyB4RaRwNsOmqlSkr0BuseNTeb/uTg86hDyu2RXsy7XU7+71X+2IzJNFcEtJDxoMlZTYwBxC3yeNGQA4FI19hDqksAcV7QgC7uUSedu7tVJN/kOZUcMj9okZzZdg3idaJobEE9xCh+BK8A0WyxGE2932JU3lwWXOKOusUI3lns5lkptWBRXwTyozPOLZE7H4uvXk159ZERDwA6obwFD6hbuti/aLj2kwHNn1gMV6oLKmyY4XXz0v/RGol2ivyDPVilvovRaZr8maHQJlOuQye3/vKrbWR0+IINHlp4tJdK2kPOAXj4TarSiqEEenNyKKmZJpHvW6VTGdv1brGFZbqNCUlSoMWadtElDNHyTVSoYz+u3wUeKFeTgo2KiXgTcV+psNe0acsJe51vYzthR+fH1P283urWvgTwpNskCTg0y27g4UAeFoFymyifMLdMgI3lYQcv1Jfb9z1pL7T8oQnvpGRaM0SiHjgUBDLHky0BQp1H6oiAvJyQuPqTS5owu2w1wDabFfITqwwBqB5H4DWJiXkOpIwn+VTwDkKoL5iWXEo+OSgfdTdmx7scd59tdc53J8cTXmv1z6CXhtXD5/GhPWlf4D6nEjP9AHy36CQRHBtOwVafPOdEdNLbJYJbN+Ri2n5Zan4lO4ABn59csn2DottQJby2ZISotY1tptRFgR8go9wywwkN4QvEjmTq3ty262eDt70r89wd2A0+Pl6cAV/Ia3G1zP9iGqThzkAfWEO6DwtBbiHVkyLANQB+Im9tFRfgkDcbiragVJXumZmd9hghl19xYwqaTZNVFgLJYqbTyn7XrrC3QHMBc8gF0H1qn0z83KpNXxpe8MXLusX9SUvSCF0xdDYQeEpe9dpRuUAk5TKUuyCpSfqtihVWbdGmVPOqkbB4ADOn/eTvoE4JGY1CgtvsSxa++C2Ma1T525cURqpdBGlAJ4kblAvTM6FTguqN5OpZjYdobk0JJ4oH1dkrGqqpHRnsXiejj2e6Q3i7hL3KFokWvGCvnnC4KNSlMPlEgbkGSlvNHCyHVWYq9xTlwLQ0DZ2t7G7jd3NYnf55Sro02lCn+uIZ6DfhIpnA/rkW7EsH2R3esiQO7ivaCHSTzdjCOwP0I9L2sPEb8m/Ij4ypbzBfL+wh3k+yXcc89Jf2gIZJD3anUTIRMI/Jr5LjklRRlW95mpvVDKR4KDRCoiI7T92Q3RSIcki2sDleof5SujouxVIHVeN/FasAHxvkeQWSW6r0bYafTvVaIskt7G7jd2/Z+yuRZIFVxQtFifpLAx5sjCeZt+jtJzBgPLIVxFyxS5vFa0gMVZgLKeOHJxJtzPpTA89sefzPf+gdzTtegddvn/YOexM9rqHTrXW35ZxXARZPaYq9jZ2JBUDiPsIOC7DXUidKuXXt/8yPLQwNWfBSkgMtgMA93hXYMfu0Yq9aaXYWx4tcoSkaxgyKnWEOU3hGQcYW5zuhAGczSAvRvg9lVR08imVoQAqCTgNC2QoKXhRCqCbLFr9aQqimEBpHr4zBwY0ZYJAma//7rnE79CniPmAAiFY/GLhK6LT/JvPL0HybIQSn6HEbPDJEwIDvUDu+6v2d+m0AuaIK2PgJzZ6TbfDI3AAaAhMzipw5xafb/H5tsZva/y3UeO3+Hwbu9vY/XvG7p/A5xYNPY3PYcDG+BzGum1WYKk3dMj+fw3T+/ZmCXJA7s2U52UJbTfnGByUoAU8xONTuMi1ptsGSKEPoB2e0Wm/UIC7IdOx0pRoOL5zdpdOeO3mR+aRKsJHw3mWBDB4nqaxPt7dfQCDgiEfXTy7lx+sidS9C6R2J6DFFQlK6jxgcQBdmTMLuGSCRKKXm5RIxI1B8rsNGgxDm8drKUd4iBMsTQd1DJkdPMdiPc6e3wljaDe+0zTaJQ9ryAdyXSfB45fLYgg9Icsq9a1dDcYz4HRJRBThrnSCK8TmZvWGK5T1Bvu5bmOxCxzWZa8FT6BxMF9xfP/TzfgFmyEirZx0FhJbCIipS3ARynj9fLsfJ1ERSug8OzLer32hghHGpgEIzN5FV0Kw2+qdxhHkblIpThKULnDW3fe5dXzxUQRYJd1Sk+h40o92QUO7vDbvBVVEah0qx3fdd1GLnUpMVMUVFisidYLsNs7l4hW5PpeJf+TUWoZai6jpF0tcGNXemgPfzIMwRxI80KStz17c0GtV6GGfBU+Q6jIPqAnLR/1rMC+32mfzUaPXQnp1Pt5FN3Skrz6NmczFNFTLwGdD5s2V0uJfjKHrYBjczjKIos9mi84RtigiWt12haWWWbIlWwAeib8zCIzIOBOfYPEm7KIA1kW+CcnfyLIQ87/Rha7fajLT41uosTjSV57+bJ5xwRYu2DI5QFv+7UlAYBZPvIEMlAeMA5yU9qdMYBmt5D1Da2VWJ/K7NAdLgwesEhUdH5sPx2WCs38xeoGjizGQhhF7F18M2oPySAvrWE1Z+a7Bsgab/AYKyueS3gy/xa4VltS/mrwocb/cXLmIgsXXztJPZJK/Tt79P2W8bab5FjONRcO4STkqf8pgkPct1Z8euK3fVnj+3mZ5bVOuGV/emSyOYldvNxJOe+p+enF/d90F7+VBzUvUjr31vHSjuXr9eqrIKrarquaA1xbONvdCNd0lhX/hLaUy6kvw3lNxJLr+wxQ8RaYo6Xlz+0sNseApQuMdDDwVUqKKE4XZMT9bPUtgDGQ1DZCdT2QA9GifP1/Z/DaGwd3o9vhZZ9TK4VreHLpy4bIbvOfhgddiU4snVeDd78p2t1fguJfo9+w0jwXApGGYRXh/EtjOQobHzZ8JGF9qLzN5HXrcSOS6UISMi1l5ksNIRBFcau+SUF9McYMeev9KXDyzFoSFtrvzoHq0IjYx2DkWgoxEfph8Z6mreY42BGNrLoIYnQSKkrA3r+0Kb4fjBkUgFmmQyxOuSma7dpLexbF4SQuEN+7Tcztuu0XdFF62hw405FGFeH6xny/9BAt7ne+8XKy8ofFQflHxjf82i80m2Mrt0p1ZVGRmWkvTyt8uXU1CB8ibeUg7c2z7YdDDA66I3e0jPob3uFVye1c2rrRjABNoV6tyHdF+jdIaLwjl2G2T5vdD2E+bGWanbO3Y6s7E5QXuGToT+/szoUlcCb9HSeDfY+cd/AcfVFzcc6PnD07xGxTHjqGbw8lVaMr+gWI+Pv4HeWxAmw== +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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[]
  • Array [
    • item object
  • ]
+ +The recommendations for a customer + +
Schema
    response object[]
  • Array [
    • request object
    item object
    translationMessages object[]
    + +The list of translation messages, if they have been requested. + +
  • Array [
  • ]
    • recommenderCalculations RecommenderCalculations
    + +The calcuations performed behind the scenes that provide recommendations to the user. + +
    featureWeightedScores object
    + +The weighted score of each individual feature + +
    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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-role-assigned-identities.api.mdx b/docs/api/beta/get-role-assigned-identities.api.mdx new file mode 100644 index 000000000..28706864b --- /dev/null +++ b/docs/api/beta/get-role-assigned-identities.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-role-assigned-identities +sidebar_label: Identities assigned a Role +hide_title: true +hide_table_of_contents: true +api: eJztXHtz2zYS/yoY9o8mGlEvO3asmZs7xXF67jiNz4/LzTieBiIhCQ0JsAAZW+fxd7/dBUiKkvyIm+s1Pd1MrxYB7HsXvwXB3gQ6E4bnUqvDOBgGU5Gf6ESMrJVTJeLDWKhc5lLYoB3kfGqD4UWAE2xw2Q4ybngqcmHw8U0gFRDIeD6DuQoG4JeM4W8bzUTKg+FNkM8zfGpzI9U0uG0HsbCRkRmyh+eHr5mesHwmGLJgE23Y1UxGM3rEvUislolxI1iu2ViwRNpcIDNxzdMsQS6DaK//sveS777sb/X2erzXh7+2+4O+gH9e9F/CZCN+LaSBdcPcFOK27XX4tRBmXiuRyFTmwbKwb/k1U0U6FgaFNsIWSW5RGiPywqjOB3UqBLv45xYbHR+y05yrmJuY7eskERHSYMeV+S6fzfI8s8NuNxafRYIu6Vguk0xLlXcinXZlrLo8k13r6YRRRSes3fCcbJZqMItU8GdKju00NJ3wxIoFOw1e9Na4CPiKqTCw0pFxj7YG8CCVSqZFGgxhXcqv3d9EJRYTDlagX7d3WVNPJlasmvMdPQaxwYLo7kmRJN6qDAY67NwWPEnmzGYikhMJgXAl8xlrkXdaaPiMT6XiOYTEzOhi6sLGO+abccdvcEZl/ruNH+lCrdr+cMJamAAtJnOwKhg+01mROFMK1vpXeKZznoT7uLqFJs20soLNBI8h/MkPOHFNOsw4UNRFEmOSuswAz8lJ5TewH2u5mGixK4GmmiqwWAweA59JFeE6UMPmUDMYB0eDKIwUYRFXbMY/Q3Fg4CMyDs6XacajvI3aSAurwWOpUDEwVjrHSLECubaIyF9I8xbKRNJ+5kkhnBVwNohd2FKabyKCUJ81QTTWUFO5ChbihFbeGSsTmVBp/4IC/oaWVN4vLLoMI6PUktm5yqFwumVjDAX1O5v0O6cXSBZ6OZ+jb9+UTzFkbJFl2sCGQuancgSk9BUOQ+lJYktx67ZObewQKbRaMm61hqwlfoXQUy33jCeS25+AdzVkr/wQ2FQmq49Vc3IbYr3V2NhwAgywH7UI7nKeRfHvdd5CMcH84KEVaCTcRVf8egrU/uBeRYWXfXrqnj3Oo2BwcGCboQHbrHJbm3k3NVxQD5O9by8xIV1VtGjqQa+H/2pa8QgwChbHRQBTgpoS9ACXSEO5hyoN63mWJTKinO/+YpHIzao/uTEcPS9zkdqF53r8C5hppdiPwBZj3Go91PLxDL+gmHrR5h53geE4S0VZ1TmJiNUnM+gpwoXAEFDemvBqsj0DVjW+K/msAWx8e2fCYV8R273+zmS8LXr9l9Ggt7O1h3FZGf5xHGk662IJN5Q29/HPOyKWaOXbMo0ew2JWwKYDYcdjPgbQChSyhM/Zg9zOZjoF2Q4qlhRnD/M8wGmMxzEEnH2UPn+TflTpK0wpZGYqkA87Y36qCxOt1VcoBBcXwWh//+D09OeTg3+cH5yewcDJu6ODn98evH11cHL698NjbAeWbAOUyjBSMUYxxPtMX+FezSF0IgAYpg44Pc65xExoDPuUqHVakQMW08DJGoVQhAD2t8akylS3+L92sL0uVfcTCbPYgTFQLUJ2sgBcHKgkQMLGOp5jkkgFqEHGnSdkb5WlzZSKBZgj2dfxI6LwDdgtnBpnPkEiR7CQAcXPMsYKRwDCkSwjhuZ1GrYFS3T67BWPQV+n375XBk1oePQJaB0+ItfPlYT1rFzCZF1117AVu4KPd3p7g+3Jzjbng5fb/d0X470J34K27cUepX0Ksc6nwq4pe03WPwgFu3jEEh2BR/4NBoHMBNuTAMT8vkrZ9AHReGQVcHMrNb28LBfXgEM5e7V/zLZ3WcLVtKDnfLpkBBWen+L2DW0P1pGyI/VCvDNyKtV9Cfr64M3o/Igys8wNpLWSliNVpqOmmo4ZmdcKXEFJsgL3V8C8rOWptkAhruziROl+2Tn03SnzkBJWeO5rViySZhOj00YqUd5c5+yZ7IhOG2A3PAN0AtVjzAF/M3Ah9SKjKBJZHh55S7Z8E/K8w0ZxLFFJ6A4Iw1tYP0f8DrXSQRLXV0IqC+pZdJEjxJeRaPqiNmXTG3UdOVp0CiYHSP5wnIyiHFpYiolGFlbR4kUsy2XsLddZ2jdqo5FJEXsBHIqoO460gX4HKhPoJgGs+XJEEAgKjyrnVRVrsTxSuXvrhHmdaxqLeGEfkXfHCZSfkFSrBj4Ln3x0LOKqEXmjdJOvSL7jp8V+VuWuMvEdTNnk7iZ3N7n7yNxdHjzxDYofJejTX4U+54oXYF9Dm+cK9DEUPUqzchLBG+/INgODeIj04/szSOxPQuF8cZ3hWcVXxEduK18RflT5w/eiZatabv21L1BAsqPTYAKVSMRDkruW2IFEMtXWKrc32owlBKhaAxGx42BzXdAZtSmUotMr22axFlZ9n/tzK8gIa10FRK4qDl3nu0GSGyS52Y02u9GfZjfaIMlN7m5y99vM3XuRZCUVZYvHSbZIU27mLtL8uDtBhgn1C8Qq5chVy2gFibEKYwVN5BCMB/1xf7Ibie2Yb8c7W3uTQbQz4C92+7v98fZgN1jc6y/qPK6SrJlTC/52fiQTA4j7DDiuUBBcNtc6bh7/FfhWZIJlDUtPhZvB5mDSywo7DvZWseOZ1uwtV/MSIdkGhlS1jbCmwdwU55pyLkzgbAp1UeGLTwlyYSjJVAAVfIfD6O0qJi9qAXTNPBxN8N2cf2frg6ziIlWUFLE/oU00omYNgSXxBegEMR9QIAQ7her8FdGpd9FvQvLsBDU+Qo3ZwXUkBCZ6hdxfrDvfPQThDdaIU+fgOw56XbfDFQQANASuZlW4c4PPN/h8s8dv9vg/xx6/weeb3N3k7reZu1+Azz0auhufw4RH43OY2+mxCku9oVtlvzdMp1TxElB4Mx1FhaHj5hKDgxGsgIf42h+ZnAOu33ehPALQjpkpYzXESxFhoQC4RZ9EPMQ7HViHVkfARQhaF8YeHiFql7crqb7uNhAvLz6kAhLA38vGyoeXq4dBFwnb7o2Mb7vlmlAuXtV2fYuzaGESWFNes7qBQIMAu+3wTHaWLoZ0x+DdNYUTbzi4IoET6FaXY9Ch0DASs8+VaiLuAsVfMgyq61z3Ui7vy8x1AcWZyLQZZKrPBHoMImbQBn1vaXaHIn9FP9Dr3CS3v10XR+gOXdaZ715uMJ+BpEsqogqXdXCeYs/guK+EaL0PYp85WGH2DqcN2CvBDTQ07tXLsx/fnz1nU0TKVKnc1T0hsbWBIDuGEKFKPCpfQ+Ai2hzrC9SjxosezHw2SUBh5u/DlvdpfoIt6gT2FDIpLhJUxnDV4y/58ca6O26/flAhey2NuwNoaY5X0d0QvshKvfiCXk8V4ruSWuiohUQNLxg2pHCmvYjcxaEIyg+S4Iklaz2ZuaMXLtDD/g+eINVlGdASXo7m67mo9NqT5WjQC5FeU44P6j1d9WouY65+MTujK+CHLJppbcVfGcPQwTS4mBaQRU8Wi+6XhZQR4aC3IFLoWIYyBFBL8h1BYigXTHyMoIIwlQa4qWKXkh/Js5DzH+l278eGzvT4AvZ+nBnr6Aturi7JjAxDZBi6GmC9/G5rxcCC3EYdqA64ANiv/U+VwAu6UPccrbVVnch3aQ1uDRGISlRsNnQ/hnWB838xGsDZ1Rwow9gTVC8s4TfztHB/bRirPM1YtuCqvImGbX3Jbk7e6jQNt/o/mr6o8ag+9HmnkvnXrtJ3VJI/Tt39H1W8TaX5M1Yaj9Ix3Iitb2cWg/yVx2urh5CWvlOC/4dRylVqCKDdqj9NWiSUJTzHqKasjmZS0PFFJniO2K+NkaVTysTMaEx/gOZEaAoYHs/QLWBSPpYJ0KMD9pIzp4RxwBL9ir9tQT0U8opm0A6LDnsPHaWKwC3YTeIVERj7Rfu28hQ8c4yOZa9LZwPoStNC4S1pELtIGYeQeiAiYmmjwhUuaC6VKG2hCfpVq8osxlBDFTrUV5nUvpvgybjES+HBI3mB360/FgfToxf9tyi1IiciocjEeU3Y/hBtiLZwJpIM+1mougDAxAKHt4dnKxSBmLJ0DbyjzbTrF9kuzgUi2B658Nnq9Du9kNoFeJ5pm0MTt0D83gatEYlV8UfU3s3woAxJFq6LcM3bBV29RwMM6ePYdf0bdAQzEAMn39zgwQo2NLf42H3lg10dGAajtf7+a0mS6u3EN/ah6loLfhJ4VFF+h+sPIwL6+Onxdvj/+sL0HjtWX+A+0ZCbz0W/vc9F7wmH8pvgJ0bD5pvP/943n/d4rf4694l+23zT2XrAxPU3tLWJL+tDwi/chp+d+C+2n7Ov8d+5WCt3+eJOzReFLvUBvHF7CbNcHSbx3YB7W7OwZOU+A+pdnUX/cIBoi9/R7/o/hhd49v4f2LAAgw== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Identities assigned a Role

+ + + + + +Identities assigned a Role + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-role-entitlements.api.mdx b/docs/api/beta/get-role-entitlements.api.mdx new file mode 100644 index 000000000..e149a1ae1 --- /dev/null +++ b/docs/api/beta/get-role-entitlements.api.mdx @@ -0,0 +1,97 @@ +--- +id: get-role-entitlements +sidebar_label: List role's Entitlements +hide_title: true +hide_table_of_contents: true +api: eJztXG1z2zYS/isY3s000YiyJMuxpJnejWI7GXWc2GfJ7fUcTwORoISGIliCtKN68t9vdwFSpCQ7cuLpNT19aCODwGKxb3h2CfDOUbFIeCpVNPSdvjMV6YUKxUmUyjQUcxGl2qk7KZ9qp3/l4CPtXNcdX2gvkTEOg0HjmdRscD5kodSpZulMsDIBxrVWnuSp8NmtTGeMs6m8ERFLgFzjXfQuGrBUfYAGegqE6uzs4vUvg+M3w7d1dnF2epL/Von5c3T5kloYz9KZSmS6YMBCIn7LZAKzpIp5PAyBE8NYA9YQ84TPRSoSXMmdE8EfwLr04ZHERcQ8nTmrKxseMxXQgjwVpVxGMpoS29Azn83pp0km6o72ZmLOnf6dky5ipK3TBLpDT/GRz+MQm9per9Vtdvlht7Xf7DV5swW/Oq12q9fqCc/jzqdP9TvDz2+ZSBYw2DIayrlM1/h7wz+yKJtPRIJ8JkJnISpAwc80SyIQ7kgIdvXjPqlnlPLI54nPjlQYCg9psPNCLNfPZmka6/7eni9uRIh20dBchrGSUdrw1HxP+tEej+WetnRcr6DjLsX7nAWgprlKBJMR/JyTdTUqEgt4qEVJMO2D5gYBwrxiKhIYaciYpv02NMxBFfNs7vRh3Jx/NL+Jii8CDlKgv+6VpgoCLdbFeUbNwDZIEJUeZGBERqoMHjTYpc7ArhZMx8KTgcwNukbaqaHgYz6VEZg6jE9UNp0RHauYb0YdX6GMQvz3C99TWbQu+2HAauhINSZTkCoIPlZxFhpRClb7tztWKQ/dIxxdQ5HGKtKCzQT3wfxJD9hxgzvMOFBUWeizibCeAZqTQaE3kB+rGZuosVuBoppGIDGfotNIRp6g4CJ0igGAg6KBFUYLgUgTsRm/EdAMOiLhYH85j7mX1nE1FJpAYxANfZg4UilaihY4a42IfE8rryFPxO0NDzNhpIC9ge1M59x8ExZ0T0icKIidPHJKdkIj77WVQIYUsu8Pr59WDekVDSm0n2lUGVpGvkqmFxDLPzIzbIKmEP3BIv2bWRdw5lo+n6NuX+WtaDI6i2OV4KaJ4qdwBKTULT6G0BP6muzW7N8q0X2kUKtJv1brs5r4DUwvqpk2FGbRqm9tK09BgpMs3fCI7G+92UsE7uL0YAq2HcJ/UwH/CtthrnwKi/f3ULcRyGwTk1pliSdWHlV2z4JhJn5j75y5QE8/C94566Z4nz1plOiD9lSKb+iy3NUC9QbLXje1EVD7kxsaLnjVzEambTsjA12Q/dRZIf66iU91Zu2hzpZ6ryiMxrn5ww1ausYmE8g1qqLdbOI/VSmfAqrEeL4CShGRwU/sz+M4lB6Fpb1fNQ66W9cvTxKOliBTMdeldjX5FcSGCDFBMafSsALIcINtrAJfMMUlV4zQ5Bra6x52gqDXOjgAtHfQ7B36nAuv9aLloUEZu3zsRDSqPNUpzyJYcDKGLaqNdK1qtiAt57DTzAB9pyuT3HKda7jsFT40uKlcYaDdbDfdVtNtdsetbn9/v3/QbjTbvf8gL4UBfCUzIQdDKFnTV7BU2PLjZb+MQmtayCMSxhuAjnySb4UwI7nMdrOZ3d8mHqWpK3Mdvf2+ovT62WWl4SyZYpMO49SFLEmZXbt+fPQ9Ph0ULYNjbAsVJEwoGBOFR+Q8Z+QZY+J3G76NJzHsuIF7FiRqbuIjzcGsh5YXNQXMHCMbcSJvZAiA098CPazxAhI3UGrFPTUr0V1BK+gzocr81+pGID582nmJNJvmtNfnrlBaF3bVnDYJv9TyPzIdi5ANm08pvDLhdckV/rgxqFcnGbA5j1E8QSKEi/GDfRAL1zhczGWi1610oWHDKM9759DO+DZHqPD7R3JuZMb3Jc7Fw/PSbmI5NRSfbuuxHA6PN+067UOPd7sH/iHsOvDLE+0ubzabYoJsplv7tJ0DO9ZNQsLDW77QmJO8c0ZnlxdHJwTAlgyYxsdtbnaatYh6djxyB8fuyEhuLaxC3uAQoiQUEIYQerG487ARjCA1C032fjw+K4AP0clj2EYP+jItGbpyibDuc8s2bwc+9zx+IPY7B0GrOwkOe4dNL5hMuoHw2o+TqJkW+392YunTkwVrPWQbIsIU/8oZHp+8HQ/HP2+qA4pK8DdYnw0jcAkqm6gI/kc9ciIVDFphqpgGdUx8ozkgxQsRQIoOOfZxqhwE+itGcY3hFFCml56LZC61Bu70Y4DgVuaypG1tBhaSYs0AQf4IoPo5QvXvNANwwidciwajMA1/4aL5dJqIKdVEKeJ4GYyeg8ZMvDG5ndTLQAVpmGISq6lxLADfY40BSw83PFkAMkqmAmQ7EemtAPQEEIlklMLGIxEv7+X0dWPNkBM5naWbBLQSO6mgKpjpzp6JxrTBOCUc+rkpW1C9NV4KhmMqoUHtNDBFJlPKArh/BqaQb2arithQOB2dnJ4cjY0tGDJbOYHpS7OX2DK1oCnIENZhl5MXNKqclRj4edR4/eMvfx9fDN6OBkfj4dnbimUuzYGsEqO9mJpU5fOWtyxlPLzP55nQ8FjjP/kMddw3ebSoY1npdia9mdHESXUb5cDeFNBHoyzZKyc4nLQmXb7vHgTCdzuB33G53+653Xaz1RGt/UPR6sGIds+bvPCaL9yWz7tuZ19wtzsRHXey32ofBO1ON2hzB11vziMqkl7GCMv9V5RFPhyfq/Z4PBydnw5+/uXt4M3J0wEJbWIh5hGZ4YzlnLIbyauYY44BiXn6Bt84xDwFiYrIN8k3Y69wWjYHZmxx0fK/sMh9BnOYsh24ojfj0VQwHmBRKgCEkVazCRsHsKKGBSAQFuAdcF4q41+VVViUPA1w3r5EAFGB74EfuKWJn7N/sPcokfcF940N4Or4ZHR0MTwnc386TFfGqjuFlBRSEsxDeinFnTebvA32qQ0b49rbDgN17JstXZFCoYlcNaYY1GBGIEasEFNSq2H4+QSKXCFONlXUxD+vU38rpTIC65o2cnxJWF0qiisvr85hz0ScW7ztAQ5hUKRuLZK5VdUE1wyzeIZicJ+Voxlt6iWXqmh2NfAZlVUc0Cj/uqz/kj3CrkOAuLOpiHZEOICdJAmswGUXpbcg5g0VpVhsonx6lSojkLKkreKxdbZ7oroPNi/DI+VvgV9fyUi4sD9L5FAQyx4MRBO4kT7WJulthCFZYHXsV5EoSqLRYi+5D+s16zuyi0EJJtz7ALSGW+D4y0jCeJYPqaD59WnFoeCTF81euxO86HDe7nZahweTXsD395u9g16PamJCaz4Vn4ddrwVAXukxSrPl7wKjEQfZEwM0+fY1TaKxZf5g+hbLtPyyVHxM64yzl0fnrHMIwDOaZtTOpytCiNzL0aZCmCF8BrhLbix15HnG8cmrweXpGFouTv51eTKCX0hrLesYRGCtPpqlotd+M3DPdLkADEtaYGUc/bdmqdaK3aLoKM1fBn8zu7HBCDv7hhFl0su6Qe5K5DcfU/ZMNkSjDnEEi5cU8DAb8HNUXBt4nohT99RKsmbfaD5vsEFRTDAxDyISR4zPuO+bPMO8pAZXFvQCVGUpxkTpiaoulqJc3RHyMHJaVgo6B3D+eTsZeCmETrKJihcW1mJZtPoBno3kqtyNS0IjkeJbE8grPIrKnkowlWMTWBumPzYcUeIIgSfK+xURqxIdkZs3hpkcl3s801v43XkI4celpRUPboR1PsICJhqRNnI12Yhkjw/QYNurUFfu+Ga32Pnuznd3vrul764+vLD42z4l6NNahz6XkT0lhpvnGvRJyHoilR8l+53gjVUknTizEOmHn8b2mBr0Fx9jfI/5hPjIbOVrzA8Kfdi3yPlL5nzrX+oCGSQ5mhUEEImE3ye+lxwbkEii2l+fDeDtRIKBRhsgIkTNhC1UxjiILMkiOgvHdZ35Sujou9QeggGP0NpEQJw18l0D7ndIcockd7vRbjf6y+xGOyS5892d736bvvsgkiy4Im+xOEln8zlPFsbS7HNcLWfQYVkJLlyuOO5TRitIjBUYy6kiB2fSbk1awaEnOj7v+C/2e0Hbe9HmB4etw9ak0z50ynv91dKPCyer+lRJ30aP5kW7SG4Ax2URGJdOlfKr5b8Mq9oBhjUMPQVuBpmDSK8L7NjurWPHsVLsDY8WOULSFQwZLWWEMQ36zrFvkveFDvm1EAhVEvhCU8LjYC7D05eMjmqj8+IqgG6ycAdU7bUHwK2RFbPIyAsz4JAiQagQNSswLIkV3QAxH1AgBDuF6PyE6NSq6KuQPLvAFZ/iitnJR08IdPQCuR9squ8OgfkEY8TIKPieQq/JdngEBgAJgYlZBe7c4fMdPt/t8bs9/q+xx+/w+c53d777bfruI/C5RUP343PosDU+h76NJiuw1Cs62/JHw3RyFcsBmTdTnpclVG7OMTidL4NGmS5okkvA9UfGlAcA2tEzpR/18aqySwe7vQ/C7+PxNoxD609ARQhaS88+/4SoXeMdnrkAq7bXxzGc4VXqvrOHvfXenfQ/7ZUPYjnIO4JUI58sCaFzfnTmDswGzOVTg8eykR9MjdQtnZ/BczMbwiCeVzAujx3odpWZoEGKTiT6kgm8RNyo3R5ccoojOg9SpsNjYE8LlUGoJTJ1PMpq7ZqagcUYkprvzFGzBtnx2vpgXZdJ+Onr12II3bOWTeJ7cDboz4DTlSXiEq6XpkbXQszsawa33NUwa2yvTXaG3drspeAJpCfmRcqzH34aP2dTxL0Ud8wVOiExUQHPPQcTobg6yF8q4CDa6pZ3qweV1zboxywIYcHMXpUdWiG8hQ3nAnYIEikOEhSUcNT2B7d4Zdw9F2PfRS47pvPHeDSW+tglmsvDV3G+Ll5a15cy8becmmuouUQNL/pVuDCivTLHgfFaF4mFh5qk9cWTG3puiZ5L52pdpLrKA0rC8lF92eblWvtiPir0XKRX5eNd9BOdi60OYyZwMT2jE8FD5s2U0uKfjKHpoBtcTTPwoi9miw7juuQRbrtZYsk1U7rSBYhK/J2CY0TGmPgEIQIhJAXgMfKNS74nzYLPv6dzZO8ra6bmK9jJsaevvEfcIF3hGSd0cULXxABt+TcbJRoW+DaugeKAMYCjpf4pElhGS3HP0NoY1Yn8Ho3BrcEDVomKjvvmj/4ywNlfjB5g76IPhGFE+MXrRzzaZ2nhblkRVl6bWJXgOr+hgk16RW6G36I2hhv3n229uOLBsoSDR9qfOkrfE0n+PHH3fxTxdpHmrxhpLOZGc6NpbXJSNvKXFq+tlxQ1fcIE/g9PyVcJ3kPytPxqSZlQHPKUriaiV3szKagYEQtzOLnO7JVM8MQ4Uej+kHISoSld1k6AZQ7powyBHpXL85k5OYwBlqhX/Ftn9tKusoeoG+wnPKzvgVowN8QDH/DsV2WTxOJmEzvOlQ2gaz7PIrxABmxnc8bBpD5jEb7UXmYCF6SKkchloQj6FaNyL0ZTwyU0KEtK5voswDq3xNuUzpZzgd7zzwaA6FGL9psQy4VciJAsE/tVYfvnaIO1uTMR0t1liLoAwERphjfD8RpFIBbZT16oZLpnB+k97IvXxWHxxnz2G61G06V0AS9GK51CSlYiTpeCMNX6Tq9+ImHlUnFR3/82vthldypMMfZirNHh+jOT8pgU88qhFBP69s2nF8rLh7xlBsLCXnd3WMzBtOsTNptvgmDuCepDn/I3318pS+zb+tLWRtF9EFgeyT8kZgsgDl0U2V4O/1+fyHpAjsUnxL5QkLvvXX1737t6wBzyj5p9oTXsPlr11/po1QOWsvyk2Rfayu6rU5u+OvWAxJcf/VpK/HpZTX0kEnh2YUHLc/bQ50E38pO/h4wWZWZyPgHD0McLTIgntswD8/KpNGTteEalCv/6BOEmvyfhtz/6V/gq4b+hSCME +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 role's Entitlements' (get-role-entitlements)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

List role's Entitlements

+ + + + + +This API lists the Entitlements associated with a given role. + +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. + +## Request + +

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[]
  • Array [
  • ]
    • 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.","example":true}}> `description` property.","example":true}}>
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-role-insight.api.mdx b/docs/api/beta/get-role-insight.api.mdx new file mode 100644 index 000000000..892eeab53 --- /dev/null +++ b/docs/api/beta/get-role-insight.api.mdx @@ -0,0 +1,87 @@ +--- +id: get-role-insight +sidebar_label: Get a single role insight +hide_title: true +hide_table_of_contents: true +api: eJztW21v2zgS/iuE78O2ReTYjpPU+XJIk3aRRbft5QUFLg1QWqJttrKoE6mkviD//Z4ZUrZkO00uW9ztFgaKVBbJeZ+HMzR92zK5KqTTJjtJWgetsXKnJlUnmdXjiWtttZwc29bBZYveivDatq62WomycaFzWol15xNthcqS3OjMCVCxoqAVOqzAw8gUU2Yk8CQkj7fBIZeFnCqnCuJz29JELpdugqEMA/gUiEDArZaNJ2oqWwe3LTfLadC6Qmfj1t1Wq1D/KnWhoIYrSrUqoWqIJDSRU9/kNE+Jzsu4O+iovf3o5b6UUV8lg0gOOsMoGSS7O/3+bm9nNGzdXREbm5vMKktC9Dod+q/J6qyMY6USlbTFqXJlkTXVl0NTuoVlvDUslEjV3CixyZzKHNGWeZ7qmJduf7HE4HbVCmb4RcXkr7wghzrtxYOOK5ZaNszJent0+3v7aq+rolHvZT/q7wziaCh7SRTvxXG3G486g36XrJ6V06Eq3o8u8kQ6zzXwQySosSpWGJ4bJ1Ph1wkzEqVfyYZwFEdkhLosu2ATFwqTkmP8WaeSty7eEKnI6alaZYsAmI8uzH+jCiVSaZ0ILJpytBtG6XV6naizG3UH592dg/7gYGe/vfNy958cfiT1SiwcVtp831E+0h9yFSchT60LdWZG7kZCi9fZWGcKFoc0j/E8k3ui2xuUHsWo/qrO8QMyH1lxMzGYcq1Sk1thg0rEydxkqnj3ePvw/FUrvTLDObWTxxrH03qSicDLaccLaohq6Zn9ExB2JWAoTL/qLKHMqKCKoxH/JF5bg+i1TgKFHwoqP/qQosRwkYw6AexoogDuizQQN9pN8FEJHk7VFP83c+Pw+NgHXkXgI5YcAgnto0Dhx0jxcrfTkOFkmsvYqeSHSeAm0onEiMw4MZHXiqWxuYr1SAM77pOry3I5Qr53ATBP5hweKZxbws2FiE1WnU7nvuir9vV7xvGeRvrrNrWjVIOdeF0UgMcobGzQWI/YBLT5KoDo0CQzClWdXctUJz9wL0uUkzo9MskjYvoNcDAaF1KThIpFjrFQgOK1TrBCTE1BkEQkyZYcUzSvGdOwRLsrXskE+nr9joIyZMBCxsjU8WPQ5CLTWC+qJfBd2GbWslX7Sg73OoNef7TXlxIw093fHQ5GcmenM9gdDIj7FHklx43gkUUhZyusf1XAMB2L1MTwyL9hEOxzNpRhzBxLtFNT+7APmMYjMcXPnasZ5BVOfXNbKHheHX0Q/X3svNm45PdyvGSELLo4oyKwTFM5pFdU1kFzT/h9ocd67d6jkCJUsh6/fnN48fYcb05f/+Pi9RmeiNZK7XqYIVoTCkvDeTUxNyxxUOBGYj9SqSIYaYsXgeoLKCRR2NUmav/JziyMidgayTJ1WBG4r1lRJy1GhZk2Uonz5psTz3RbtbfEkN6hyIknYigtFpiMp78gjM1d9DZY8oWYKJmo4nlbHCaJJiUBG8hGEMX6GQgJmSSUup7AqEQqe2ylwhTIpuOlumdhyqY3Fijytu4USg5I/nCcHMauhHCsZj0L59ESRAz+gczeck3pzmtGY5POMgfUx4o0ncGMRQELiyEV3Sj4AhyRuyyAJ6vmzRGrDo4Md797YY6d4bFYlvYRefchBfxErNp84FqF5EMYmIBG7I3KTQGRMEhq8+Iwa+6uKvEFNpw02eTuJnc3ufvI3F0ePA2tfBjl0qe7WvpcZLKEfQvePFdKn4KjJzOimuS7fO/ILQGDhBLpt4/nSOyvKqP56ltOZxU/sD7yW/maBrTyh38/pPJj7qyGL0hAtmM4pgESqeSA5V5IzIbyptpZ5fbGFEONAM3WlIhAzULMTCmoVy3KLCNJpN1COa1s9kuopyV3DB4B/ZlSxIdKm0pyU0ludqPNbvTz7EabSnKTu5vc/Wvm7ncryblUnC2hTrLldCqLmY+0ME7aSoEJovpSScxTjl21XK0QMTGvsVrNyqE17HWH3dF+rPqJ7Cd7O4NRL97ryd397n532O/tt+p7/eUij+dJ1sypmr+9H9nEKOKuUceVGYLLOmOS5vEfzFuoEcEaQc+8bobNYdKrqnbcXXfCeAKPFBSlZ57FPUeNvt6WGURASeqzZl75bCrETYW42WU2u8zPsctsKsRN7m5y96+Zu/9FhRiqofsrREx4dIWIue2OmNdSbyi4/ueFIqdKkIDDW5g4Lgs+8KyqQK4rEErh2hlhCN36Omht0xftUXVBZ/t2fv3rDnN8+enFKosU0yfO5fZge/sW3oKX7toy1+3w3fgsMzft2Ey3hzDRGvTx1yoocmiCOPxwEurbNtu30BTCHu+YuLc2a0TBCqvz2eR3KdNNFHLjzJRAOCazJRDuIZz4NUTMZTb7xfLsNofPin7Q66JI7/64Lp7QPbqsM993uWG+gKRLKpIKV+QuuB2E2F8XkOfIg9VhSa6+vKrPOaPi3Eu4MnOx4VBL0VsR6D1N64lXShboHPwp+7PfPp4/F2MqSRkSSrpjJ5SmHgJJ5e8dIUAPqxNnWsS7UGHKsb9nctg406cUE6MURhGfsjOlxGW4xDF7h73gFODNZqdFivGCVl09qzwYrjfBIwtrU3DqJNuGFbdlY91z3hK5d6jdHmx/yiJxrAmpNG3tNCeoyMfp4jKv9JI1vZ4qxN8qapGnFjE1+3xJCm/ay9jfEYmR50RCppat9WTmnl5Uo0eNFt4Q1WUZyBJBjuY3MXHltSfL0aAXEb2mHJ+yjxON/ba5THh4ExbbZZqIExFPjLHq70JQ6FCqXI5LZNqTxbohphFnRNTr1ESKPMtIR6geWb63SIzMB5O/fsrFi0FdlyU+bT+zZ4ELn/ma2eeGzvz6EpsszUxMbJ8sMzGMiGHkccIG+f0eRoGF3CYdGAd8ABwt/M9IEAStYaOntRb5mfw2r6HtI4aoTMXmB/7DwQIEw5PgAZo9nwOopuJ7/t0UPotAizayhrGqY4NlC67Kmxrsn0t28/LOD05oT/2z6UsaHy5OV95n6exHo/Q9SPLnwd3/E+JtkOZnRJpQDlO4MdvQN9SD/FWo6VZP+yzfQcVfjHKucuWNvmZxW7ZOKE+lo6jmrI4nWvE5Qa6ko/pwiyLLTDkT0dJT+qMbZEJjvh5fQGSJzk6noNcW5wvOkhPGF5/kV/psS25WiFc8Qd+p2uIjXd6N4RZq2+g2AMa+mNC/ncEzH/gnJMeVs1F0TadlBm6Ul+VUSITUAxGRaBuXHrjQxWWqsoXh0m++qspiCjVSoc0NTDG170d0BI3utub4B3jB7zacP8P0iyv9rYUipyrlyKR5zdL+IdqItmii0pwaR6AuCjBV4/D7yfkKRRDLLPRCg26K8XZYZLdpLohQC+XDZ6fdbXcibinwPjfWodWtEf9VueavU6pL6cuBeLs4e/8jvwYKGwhV/ts5nWqRWKXvVnx/eNlq9IdYc7D4gRDaiQl0oFm3t3T8QR3THb1G20+99eXVohnipgQ2pmd0oSNk/fLPhupaPTsNPzB6Ltb/mGit7NW5XTZbtOwtPH5V1OkvJEdbDNn5RIbl8uP+zKa2cuVbDeqg5n30r6/h3rv/AOG/zus= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get a single role insight

+ + + + + +This endpoint gets role insights information for a role. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-role-insights-current-entitlements.api.mdx b/docs/api/beta/get-role-insights-current-entitlements.api.mdx new file mode 100644 index 000000000..7f3b7daa8 --- /dev/null +++ b/docs/api/beta/get-role-insights-current-entitlements.api.mdx @@ -0,0 +1,79 @@ +--- +id: get-role-insights-current-entitlements +sidebar_label: Get current entitlement for a role +hide_title: true +hide_table_of_contents: true +api: eJztW1lz2zgS/isozsPELlPyIcexX7YUHylP5fD42DzYrg1EQhISCuAAoB2NS/99uhsgRepIlOzUbiall8QkgEbf/TUEPkU6F4Y7qdV5Gh1FA+EudSbOlZWDobPHhTFCuVPlpMvECP600Vbk+MBGR7cRzmTl1Oh+K0qFTYzMkRrQuh5Ky4RKcy2VY0DZMjcU8GZKjPW1YZwZINRi1zDohBmxuyjx+95FDEg4zVJpnVSDQtoh6xs9miX0zG4wrpj0vLAR/WtEokcwmjKeprC6Bazn3PCRgF1QgKdIIp85d0MYUjAAT4EGaGMrsslQjHh09BS5cY6D1hkgFE22IiP+KKQRoDNnCjEvuiChKo4kkhOf+SjPkM6LZOdwWzw/iF8ccB53RHoY88PtXpwepvt7nc7+7l6/B7sEBv8ohBlPOezLjASY3fSM3oPYtshAtYUFVklR1nGVcpMyO1aOf2Z+WU+kwB67/fce616cs6ty0rHOMpEgTXZRaev+2dC53B6126l4EBk6TctymZFtW6DntkxVm+eyXW4WJxWdeKr1XzzzwFkc+Ny4U3fqrHyL9rZFnmvjgD30DhSgD6T0Iw73pchSC7ZOmXdcbewRUtjcRO1sbh6xTfu46d/U1FMONKyAK5h9BH8zd1FUt2mfZxaMat2YJgIfI1qZZzoVpcmXesfkHmnZXCsrLI7vbm/jf01zXRVJIkQq0ha7FK4wCsRiGTg6030WAoCBAnIjYvHZB8DS4AHuEq0cvMaNeJ5nMqGobn+0uNvTPLfcGI5eJZ0Y2dp73fsIZsNYMahiJ70M3vlmZZ31wbeoUuB/Jj4xYiAEvrr8PF2yuDHta1ROpk+VC83Qs7owyQryXNE8FojU9LqMMHdAqFe4FWh3y6nLaD3wrPgmOrRgMbVJzfFLY0bddCQVeBbFUeRNtFpumss9RZZBmq3IyQfQFvi3pfR9nhIv47f6MZrqPmq+rmku4hbSphLpK6OLHDNdUEX07vLVf7onb87fon5IPHhZr1inDaEnKHdnUfQdZxLj69QY0FYcIhAzonc/TAUCQrGn0zHmJKmAA5l+T5wtiadUOMifx5RPvmbhM6lEPDBcIoeCWE5gIaQG/SCxtLGRNoJ5klUE4bxWI+GBJlo77CVPQV4v33EQBrVpePIJaJ2vEKc3SsJ6Vi6B8jb1uvltxYHgvefbh7ud/vMO57svOjsH+73DPt/b2z7cPzzE3UfgKnwg7IIE1dz6lVBQKRKW6QQs8icoxAhuQ0DS5qvnNKKxgv6xnPu5lZiBXwAsn90WZOGXxxesc8AyDiiF3vPBjBJUfHOFRRwihfeyUEVAck/4nZEDuTC3CVWMEG2dnJ51b15fw5vL099vTq/gL6Q1B7u6iINSdEtgFXxhqB+J4yDAI4cKK7AyY+XZDFQ3QSCubH2i9E92bEGZ4Ft9DuUaVoTdF6yok57CtDKUKG4+O/ZMtkRri/Xw3Yi7ZMh63MICMCFO3+xC2shd/DpocpMNBU+F2WixLsA4FJJnPtNZWD8GQojvPJghsFBAKAMz0g114ZjSTiaiaYupKpvWmKaU13WjYHAA5ytk4sQVwByJWY/CylsCi8E+wLPXXJO765rSSKWI2gBIwcxsDGoEZJBAZgLZJICAkI4IOEHiUeW8KmNNapmS0t0bz8yJ0zSW8MKuEHcXGaSfmESrBh5ECD7K8j4bkTVKM4WMBINu6GOlnFWZqwx8D+3WsbuO3XXsrhi7s4OXoecIowR9duahz43iBejXUPGcgz6GvEdpVk7ycNcbcguRcIBIv72/hsD+JBTOh9YIO6e/ER/5Uj7HfLeyR+hiyya3LP1TWyCDpMcA2CETifSI+J5y7EEiqWpvfrczbXoSHFQtgIiQNQ0b64JxUJkplEJOuN1iqRZW/erYkDdAsAvHIbHvmddIco0k19VoXY1+mmq0RpLr2F3H7j8zdr+IJCuuKFoCTrLFaMTN2HtaGEdpOYMJrDz9ZlXIVWeZdbSCxFiFsaImcoh6uzu9nf5BIjop76TP9w77u8nzXb5/sHOw0+vsHkT1Wn87jeMqyJoxVbO3tyOpGEDcA+C4QoFzWad12jz+K/BnpD6mNUw9FW4GnYNK70vsuL/ohPEcLGLQS6/8FkuOGj3e5gpYAEjqo6ZCPmuEuEaI6yqzrjI/R5VZI8R17K5j958Zu9+AEAMaWo4QYcLKCBHmtrZZhaXO0Ln+50CRQiVwQO7NdEI3NNIpCiRcAa4UblHRXSM3hIc2XtCIw0Ug236qLhhN2uGWRyya96s8JvW8FiYDGuXlmycwIZhu0uK5bMnw87nSj3QDpwd6W5CS8NdrH344ge76+A1apHQj0a99EiTi3gQkJnpwecnni5RVuPYx1gWkPSKzxSAGgo/Ra2Ax52r8q6XZLfKpOflArhuTTf57WTyhJbIsUt8Xd4P5DDidERFFuEdzgR2BENnrBvg59hmsW6D9b+/rc64QsXsO52ZOqxD2GbtzDL3DabvspeAG2gl/9P7st/fXG2yAOJXyhL/0JSQ2FhBpF+BGlAe75TE0LqLSZHQxGJJw3cZBP8Yd62egFHanroRgt7VrGuwSMjqpHRcJSiK4avXrYbyxboPqJDUUUuEtK3rbulMxO5HG3x7z95yCiHTGzm7zUi5ek+t7mfilpBZ7ajFRw4tpDS68am8Tf3EkgeBHEjyzpK3v3tzTi2v0sPuCN0h1lgfUROCj+fNMUlrtu/lo0IuRXpOPO/V+KKEIN5cxn/OYhRqapeycJUOtrfgXY+g6GCq3gwIi7bvZesRNY4qIeHe7xlLst4xlDJCS+HsNgaG8M/EelnRCNBrAnkp92H4gy0Je+EA3CD80ZKbXt1B5cWaqk2+48zjDM24Y44axzxM28O8LGzoWxDbKQHnAO8Dx1P6UCQKjtdzoaS3M/ES+TWuwfCTAKlGx+ZF/OJomwfAXowGcXc2BVI2IvPrBCp5ZoIXVraGs8ixhVoPz/GYaiuqM3jy/1WkKFtofTV6UuDs9cnmnsvHfnaWXZJIfJ+/+nzLeOtP8jJkmYGR0N9o2NBN1J38ZMN38ESD0CSA3/AujFKsEx6HZofaNUEydUJ5xh15NUZ0MpaDDg1xwh/hwCz1LjygSoc/H8IcWkQgNDMyBsLWAW3lPZkCPvksod+YUMB58ol3x2RbUweBeyRCaUdFi7/HybQJmwV4OrwjA2EcdmrorsMwFfRJxUhobQNdoVCjYDeOyGDEOLvUVj0ilTQqfuKC1U6LUhSboV60qoxhdDUVoUVdjRvZdH8+lJV3EXXEvsLsNh9Kg+to94qkglyIjz8R5TWj/NdrgbfFQZDl2k5B1AYDVbyq/Ob+eowjElL9L3NJm0A6LbBvn4u1pEN67z15rp7UdU0sB73NtHfS/NeKvhKsu3Ndasdr9+lmPfJqezP+Qn7mEEoW9RTvHwzQUvPD9kG9Lb6NGWwprjupfvizsTKGPGYLycPHTEx7GYKs2wdf+CxXsf0AEjLHpNxRL9bb+XGWlz1UWmvKTwHOV6YdA5fX4CHvNsg/+Rns8uwyfv2yQi85/vrSQk/IcV43rbJQcTl1qcg+T/Qkd8eXH/RlebeXcr1woUHWu8uoUInvyF8BtOP0= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-role-insights-entitlements-changes.api.mdx b/docs/api/beta/get-role-insights-entitlements-changes.api.mdx new file mode 100644 index 000000000..3df884ad1 --- /dev/null +++ b/docs/api/beta/get-role-insights-entitlements-changes.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-role-insights-entitlements-changes +sidebar_label: Get entitlement insights for a role +hide_title: true +hide_table_of_contents: true +api: eJztW1tzEzkW/iuqnoeBVNp2boTkZcskYSpTDGRzWR6SVCF3y7agLfVI6gRPKv99zzlS33whhmV3Gco8AG5J536+c6RWP0Q6F4Y7qdVpGh1GI+HOdSZOlZWjsbMnykmXiYlQzh6NuRoJG21Gjo9sdHgd4UxWTo1uN6NU2MTIHKkBrcuxtEyoNNdSOWaEK4zCBxVJJsNaNtSGcWaAXgfo59zwiXDCIJeHSCKxnLsxDCkYgF9hIYi8GdlkLCY8OnyI3DTHQeuMVKPocTMy4s9CGgGKOVOIefkEsSzFYBLJic98kmdI52WyddATL/bjl/ucx7siPYj5QW8Qpwfp3s7u7t72znAAXIKAfxbCTGsJrTakwCzTC3gOtrBFBmoXFgRlDuSwjquUm5TZqXL8M/OLBiIF4dj1v3ZY/+yUXZSTjnSWiQQpsrPKVrfPxs7l9rDbTcWdyNCvHctlRubvJHrSlanq8lx2S2ZxUtGJa5v/gqKDXHGQ8vmNulEX/hkDj9oiz1G5lLyGwg+BjL7H4aEUWWoP2caGTMnRUtj30o37SSKs3WRonI2NqOmZIc8suMa6KRkdaE7IC3mmU1E6bqmPl5l/KLOF5n9Nz39wB3jhZ13wuny6mhMYsGA+ubWxh0hhY8PbH/xj7zf8k4Z5yoGV3FMmCVJk9p7dRP10ItVN9DXOu0VONtfKAq7A+Havh//MZEwBwSNSkXbYecAQzjJpHdPDJppY5jQbCMbTNJilRpREKwdTkDjP80wmhHjdjxY5PMxLyI3hGE3SiYltPNeDj+AuhCiDpsXwxlEfdLP6zcbeWzQVyIzeasiNQAXI8+Ty03TJ4ta0p6gc17+q0Jmhxx0sHRRuBZX65dRltO54VnwVHVqwjJrVhUlWIHdB81gg0vD4MsKhAswHH9aIT1KR6csy4bCuSZ9gVk8IOxzVxS8GiR99SnRkqIrJAEAKWVYoijBEjKli3QOmzurRaeVl//jYB9Y8DDeEAGASI2H+W1K83Ou1ZDid5DxxIv1uErgxdyzVTGnHxvxOeCjPRSIBBNOlcm2RXE47nr0lHu+GpxWHFYWj1QtFbLPq9XqPyAwFgaXN7ir8Gy0bb3RfZfP1iH82o91FQHmUSWyqToyBII8DWGIB86iBmC4ANQc6nWL4SgW5JtNvgcclEZ4KB+XuiKD/qTh/LZWIR4ZLlFCQyAksZEDxTqZYxibaCOZJVsCH89pxDpbobLFXPAV9vX5HQRk0quEJZO/odAV4vVIS1rNyCfizBot5tmJf8MGL3sH27vDFLufbL3e39vcGB0O+s9M72Ds4QO4TyDU+agVUWVfarH8TCgp7wjKdgEf+AoMYwW1AK2K+eikiGivijJ9bqRnkZU58dptQPF8dnbHdfZZB5BX0nI9mjKDiqwvsuYos44MsFHzQ3BN+Z+RILixJAtIGNxDHJ6/7V28u4cn5yT+vTi7gf0hrbifRVxCtKYalplwb63uSOChwz6EhEthIYZOwEahugEIcmoXGROl/2akFY0JsDTl0V7AicF+wokmaDY2etFKJ8uazY89kR3Q2ofmAZxPukjEbcAsLtKLpG4i7uYvfBEtusLHgqTDPO6yfphKVBCihymdh/bTuYqQnMCwglT3e6sIh2slEtH1Rm7LtjRpZ3jSdgskBkq9QmRNXgHCkZjMLq2gJIgb/gMzecm3pLhtGI5Nikw19L8zMpmBGY8DCDBoAJqGPC3BEfS4AjyrnVYjVBEyCuz+8MMdO01jCC7tC3p1lAD8xqVYN3ImQfNROejQib5RuCogEg6g2LQ6zKneVie878XXurnN3nbsr5u7s4HnYHoZRan225lufK8ULsK+h4jnX+hiKHqVZOcnvBbwjN3GbEFqk399fQmJ/Egrnwy4Wt8DfsT/ypXxO+H7lj3DoUJ5JlKW/9gUKSHYMuxlAIpEekty1xL5JJFPtzHN7rc1AQoCqBS0ioKZhU10wDiYzhVIoCbeb0GILq34NPTanXYRHQH/CF/sjjnUnue4k19VoXY1+mmq07iTXubvO3b9n7n6xk6ykomwJfZItJhNupj7SwjhqyxlMYOWLClalXHW23exWkBireqyo3TlEg+2twdZwPxG7Kd9NX+wcDLeTF9t8b39rf2uwu70fNWv9dZ3HVZK1c6rhb+9HMjE0cXfQxxUKgss6rdP28V+B7x+HCGsIPVXfDDYHk96WvePeohPGU/CIwSi98CyWHDX6fpsrEAFaUp81Veez7hDXHeK6yqyrzM9RZdYd4jp317n798zdr+gQQze0vEOECSt3iDC302NVL/Uag+t/3ihSqgQJKLyZTpLC0IFn2QVSXwGhFC4GIobgLbzDqIsv3+Py9l73obqO99htvHKPk+rGoG9JvaiFyYBEeVXqATwInnvs8Fx2wjv0qdL3dF9qAGZbgEj++gVGE06gm1meQYdsbiSGtcdAIu49QFpiAJdXsr5IWYXLOlNdAOoRmU0GKRBCjB6DiDlX018tze5QSM3pB3pdmezxP9fFE1qiyyLzfZEbzGcg6YyKqMItugtCAQiRv65AniMPYP0C3X9925xzgQ27l3BuZl2EcJuxPSfQO5y2zV4JbmA34U/en/3+/vI5G2GbSjDhr+gJifsKSLQzCCOCwX55Co2LqDIZXYz8fZR+65wf044NMzAKu1EXQrDrcNlj+hbqwzkAOpkdFwnCEFy1+mU+3lr3nMok7Sekwtty9LRzo2J2LI2/6+fvuwYV6YidXeelXryh17cK8UtJLfbUYqKG1whbUnjTXif+3kgCuY8keGbJWt/M3NOLG/Rw8wVPkOqsDGiJIEf77UxSeu2b5WjRi5FeW44b9X4soQa3lzEPecxCCc1SdsqSsdZW/IMxDB1MletRAZn2zWLdI9OYMiLe7jVEij3LWMbQUZJ8byAxlA8mPsCKTg2Nhl5PpT5tP5BnARc+0HW0Dy2d6fE1FF6cmerkK26ozsiMDGNkGHucsEF+X9cwsCC3UQfCAR8AR7X/CQmCoA1s9LQWIj+R79IaLB8JiEpUbH7ofxzWIBj+x2gAZ1dzAKqxIa/eV8FvFmhhcWsZqzxKmLXgvLyZhpo6Yzcvb3WYgnX2R9MXNe7XJy7vVDb93ii9BEl+HNz9PyHeGml+RqQJLTKGG7ENe4lmkL8KPd38CaClu6rwN4xSrlI3Dnud+lZtk1CecYdRTVmdjKWgs4NccIf94SZGlp5QJsI2H9MfdohEaGRgDqSthb6VD2QG9DrssubMKWF884l+xd+2oA0M8vItfIe9x0u+CbgFt3J4QwDGPuqwp7sAz5zRRz7HpbOh6ZpMCgXcMC+LCeMQUk9ERCptUnjggp2dEqUtNLV+1aoyizHUUIUObWrMxL4b4rG0xAvi0Yq8wO82nEmD6eur/FGtyLnIKDJxXru1f4o2RFs8FlmOm0lAXWjARIPDH6eXcxSBmPJ33DvajLphke3iXLxMD8r78NnpbHV6MW0p4HmurYPtb4P4b8I99aHVbEg+1Cfz3/7lVigkuAPo5njiheIVftfi947XUWvvCGsOmx9zLdo+wmZjDBri2ocHPDDB/dQjPvYf/eAmBWyOiVB/sLJUt/UHWPQB1kJPfRJ4tlF/uhbOLyL6ym11E68/slrpI6svuKD+fK12wW19HvCVIf/sPHzO9ZxdLvzmcaEk5XG2mjbFKCWsk/bxFib7g0qSy4/7o8zGyrmXfahQdbz02wkg3OO/AQe9nuc= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get entitlement insights for a role

+ + + + + +This endpoint returns entitlement insights for a role. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-role-insights-requests.api.mdx b/docs/api/beta/get-role-insights-requests.api.mdx new file mode 100644 index 000000000..4721b4519 --- /dev/null +++ b/docs/api/beta/get-role-insights-requests.api.mdx @@ -0,0 +1,87 @@ +--- +id: get-role-insights-requests +sidebar_label: Returns metadata from prior request. +hide_title: true +hide_table_of_contents: true +api: eJztW1tv2zgW/iuE9mHaIrLlS+I4Lws3SQcZpJNsLiiwaYChJdrmjEx6RaqtN8h/3++QlGzFTtvtFLszA78ksnR4+J0rz6Goh0gvRMGt1Oosi46iqbBXOhdnysjpzJor8a9SGGuivSgTi0Kk3AqQ2aIUe5HlUxMd3UU0gFUjonsiNWkhF8QULG9m0jChsoWWyrJC2LJQhmXCcpkbpieMs0UhdcEK4iMDHxC6qVsMcy94wefCioLme4gksV1wO8MjhQf4JTNcm3Qm5jw6eojsckF3jS2kmkaPexFxk8UK+1OIYvvszPEVn/h8kRPDw7QzTMTBID4ccB73RTaM+TAZx9kw2+/1+/vd3mQcPd7TfGahlRGG0HSThP4157wu01SITGQtdrVFJ4oJXuRSPKcWwEq1skJZYs0Xi1ymzoztXw3xf9jUhh7/KlJL6izI6FZ6dBBxQ2NPFRT8gJ1lbAJL8QYoNhUq+FAF7xuUBnkKQe51gj/bEGHiOYe0UQaC2ErYfZsd66fPWPQjNyzM1GrA7CbdJE6GcefgpnN41B8e9bqtzn7yT4KWc2N/9FKKrer6nuA0AfoCvP3kqLOCp8r5WBQXk9sFTWDWACLkxFQUm2C05Tnz48jfSj/SWddSwNbhd215AYQfpZ2xBH6Z4TLP2Yx/EIBaICfYis/HmVCryDHs+OLt5fnpzelJQ5KEwpFyTGY2o6KOxLMTAyDcMl6QnpqgwC7Ix4uCL/FTWjE3WyIfcxnLbbnl2XM+HuiBGGJRfju+Oh1BCNw5+5ldXl38eHV6fY1ftXi4fjM6O8fFPU1YS+pjK0qHnCfdCfz/YJzE/XHajw/74yzudToH/KDT64jBIHri/s9744Yzfo50wzGSNd3fRd102DlMDsWgm4hhf3KYdAbd/V73cJAmvN+f9MEhkAwG3R5Pu4dJIOkMO/v9RCS9mmR4eCD66eH+sJt0DsTBuLMvuJj0+4OUloTKCLUyoScrrfPs5oLj8yYsR6rsb8ucx0iLWElOiwLOGofsKTImJ/ASUTvgWGdL8kKpPvBcZt8xY/o8fayzrXmqCfaNVCKeFlwSQuEgpxiIJU9/kBlGsLmGh3uWFIkkgqNrhj800eqw1zxjlZ8eB2FIkwVPfwOvs69I5bdKYjyrhmCFC0G/dVoxEHx8kAy7/clBn/PuYb8z2B8PJ7zXS4b7wyHNPhfG8Gkj7VRh2ZzaOa1MWa5TWOTfUAhcHrp3ANzkWyL5GRs4Hl+hf0oonrYWM+BlVnyye1jLXh9fsv6A5VxNS3efT58oQcW31y6a8pyP6RYVEbQsOMYXhZxKtQ1KlUFOTt+Mbs9vcOfq9B+3p9e4Il4bpdJIwVszckvtsvJMf3SIgwC0OhiRQx1UNbwKXF9BIK7MOqH0v8zSQJnwrQkvc6TyV2H2LSPWWbNJoeeNUHJx88myF7IlWntsTPew3KUzNuYGA7Ry5K9GKGkWNj4PmnzFZoJnonjZYqMskyQkFh1EI5hi/BKMGM8yCl3PYFIilIVba3SJZUVbmYqmLVaqbFpjlU7O141CwQHkX/aTUWpLgHNirkdh7S0BYrAPMHvNNdHdrCnNqXSpLE8hBc/zZb1cjiGbtIaFdETmMkg8qqKrM9bjWpZ06e6tB3NitXuW8tJ8Rdxd5kg/sROtfvBBhOCDG+iQjZw1KjOFjISHJLYbHKhqc1WBzyZS5Nkudnexu4vdr4zdpw+ruic8daVPZ7P0uVW8hH4Lt3hulD6F8x6lWUXkezJvyD0GhYQS6ad3Nwjs31CtU2v+aUGd8Xesj/xSvgF+VNvD3x9T+VEbq2ELAuj06CWYIBOJ7MjhXiF2ivKq6m3O9kYXYwkHVVtKRGTNgi116ZqLolSKkHCzxzItjPrB+u6GIyKM8RnQb2HEbg9jV0nuKsndarRbjf46q9GuktzF7i52/5yx+9lKskbloiXUSaacz3mx9J4Wnvv3MCBg1ZsLVoecM9XTaoWYsbrGipqVQzTudsadySAV/Yz3s4PecNJND7p8f9AZdMb9Lm13rtb6u1Uc10HWjKk1e3s7OhWjiPuAOq5UcC5jtc6a238lvWyaUFqj1FPXzdA5VHpf147d4ZZdaK3ZW66WVYVkGjWkWumIchpo50RbVLQg4GyKvKgYUpUELnIl2vSPGe3ZslzOpQtekgJ8i2U8mliI4gOlcrJ6FqnSvARClwlyTVWzhmNJCCkmVPOBg6tgp8jO37E6DSb6XZU8uyKJz0lidvrJv/FideW+v21/9wzgC8oR197Az2z0+m6HKzgAGgKfs+q6c1ef7+rz3Rq/W+P/Gmv8rj7fxe4udv+csftf1OehGnq+PgfBV9fnoG0lrK6l3pBz/c/LdBcqAYFzb6bTtCzcdnNVg7u6Aq4Ujp9RDqGjXUdRm04qxNUZmXZVX7cfZPYIKl/+e2BlkWPAzNqFOWq3H2Av2OmxxReyhTQGk9ml0h9bqZ63x1DSlvxDBwV8rBEBG12ehf6i5TRcSHJin/Ecc69vJxO5K/Tu9oY/y5nOqpEhl7pEjnNs9hgcPjiUu02nf9BN/GAcdcs50IZ8kOu2yB9/vyye0TOybFPfZ2cDPQPSJyKSCHQCRMDwYOTsdQs8xz5djUoy9t39Os01lece4Qblasmhlq67AeiCyLrsteAFegf/luPFT+9uXlbH1JAUSkP1sJDURSCsLuFGLumNqh1/GuTWoUKX05kTbtR4p0JBxiY5lMLeq2sh2N1ZUNTPWA2ukL6d2mmQcBmDRt2/qCyYiQ8ip4WytdI2OafMVBtabPPGuJduUXTdg1T+pBnutt6rmJ1IylWSFneiqU7iUTPI7haVXHxNrm8F8beKW+y5xY6befkEhVftXerP6KSIdGLBc+O09c2Te37xGj9qtXCHuD7FQJoIOJpvwtLKat+Mo8EvJn5NHO/Vu5nEitscxnyCYwYLZp6xM5bOtDbi74yR61Co3E1LRNo3w/pIk8YuIuJusgYp9lPGMkb96PCdIzCUdyY+pvXblS8alZ3KfNj+4iyLvPCLO+73S0Nmd/sOyyxRZjo134yZJoxpwtjnCRPwh1OwAIvYJhlcHvAOcLyyv8sEAehabvS8tmZ+x77txtDykQKq42IWR/7H0SoJhivmHhB1TYNUTeV3/W4Qv1ngRUtZQ1nVxsFTDW7izTVW0Cd683jrjStaVf9o8pLEo9X+yoXKl987Sz+TSf44eff/lPF2meavmGlCQUzu5qYNncO6k78ONd3mfh9tSM8E/uKpi1VXe6Oz8ae3qYpZZ7TIuSWvdlGdzqRwOwULwS3Vh3vkWXruIhFNPYW/CMfAp+6kcgHIHL2dzMHP7WVXM4cj2674JLvSb1O6doXmSmfoPEWLvUPzplKYhRo3Oo2BZ7/q0MFdwzKX7ouRk8rYKLrm81JhNorLcs44XOoLHpFJk5Y+caGPU6LShXalXz2qimJyNRLBnTAXxdxcTGgTGv3tmuG/MBfsbsIONFRPVgzfqKwEuRK580yia5b2X+INb4tnIl+4jxIAi45Kr2Z4e3azwRHMlIFcaNF1MW2HQaZNtGBCLZR3n16r00pi11Lg/kIbi2Z3jXn1lQoyDM/gI34DIny6szqY3/DJh9VG/Pf4DiisKdQMtBe01UVIS9/A+KbxLmo0jZH/8id8wnQkMzqLPoNoRPnwQPsi1Eg90m2QUdN9d7/qkVyvAtXTNdrTCZLB02+H1iV8cRW+MnrJvvBF0VZBqp09tVw19REufxO0F4Bx6JiB3m3WOGT+gd/OWRuy8cKDWqu6xf7xFHZ//A8LosVk +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 metadata from prior request.' (get-role-insights-requests)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Returns metadata from prior request.

+ + + +:::caution deprecated + +This endpoint has been deprecated and may be replaced or removed in future versions of the API. + +::: + +This endpoint returns details of a prior role insights request. + +## 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-role-insights-summary.api.mdx b/docs/api/beta/get-role-insights-summary.api.mdx new file mode 100644 index 000000000..b182bf584 --- /dev/null +++ b/docs/api/beta/get-role-insights-summary.api.mdx @@ -0,0 +1,79 @@ +--- +id: get-role-insights-summary +sidebar_label: Get role insights summary information +hide_title: true +hide_table_of_contents: true +api: eJztW21zEzkS/isq34cFKmM7TkJIvmyZEKhssQuXl6NqQ6qQZ2RbMJa8I02CL5X/fk+35PGMbSCX4+52KX8h9ozU/fR7tyxuW3aqCum1NSdZ67A1Uv7U5urEOD0ae3dWTiaymLW2Wl6OXOvwskVvxfx162qrlSmXFnpKFLD/fKydmCg/tpkolC8L48QYa0WurlUuXKAntBnaYsJsBT6JgqjqSJWfSJGWztuJKtrgXig3tcYpQLht9bpd+tNkfFamqVKZytridJVvakvjHVFKrfHKeCIgp9Ncpwyi89ERlduWS8dqIumTn00V6NrBR5V6bJwWpCmvAwZTTgaqeDO8mGbSh0dxgwb9kSpaK5qxXuYi7BN2yCI7caP9WJSRyN1WK5fOv1KGTKKyGlXnC21GIBr0hie0JfF6olY5jZWo3i6p9kYVShATKLk0GWlEfZaTaU5Met1eN+nuJdsH59s7h7sHhzv77Z1ne78TMOhM+1xN8NedmDQvoeoTQ95wL+EBaSF6nRagBWL4EHXy6BouUChAlxnsk7vHDZi7e4DjSZu/RSMc1+jdE4xfskYdUoNbb68LdjrjBTD+OxisD1dz7h9aPkz8BbGFzNeuXX/ObvERAdDUlTSZMNZX2xpI9xhpQzEnFcUHqmUBqcHq4Fn3jngRMuxclzHu7mjF7rpQPco1qIrjokCcJzFcyQGGwgNDof4oFSQf2AyJgnR0LXOdfcfgzZSXOj+ymVoXYU2wL7VRyaiQmhAqhpxiowDFa51hh5hYhFQgSSojEXhdM7agifa2eC4zyBvkO4rCkCILmX4CrZO1Id8EdGE09ov5FpiI8+UX2Kp9JQdPuwe93eHTXSl7z3a39/cGB0O5s9M92Ds4IO4TOLMcNXxEFoWcrbDmxKRTkVtEpf6nohQvXUzhzBxbtFcT920bMI176J+8MqytxIx4hVef/RYKxfOjt2J3H1nNjEp+LkdLSjDJxRmemDLP5YAe+aJUlG2Z8JtCj7RZB0UhEqjovTh+2b94fY4np8d/vzg+wyeitVL9+gbeSjnLWw6fsb1hxFGAG+mEUznUQWXqSaT6BAJJlKvaQh2+uZmDMuFbQ1nmHjsi9zU76qSRPO2kEUocN5+9eKTbqr0lBvQMVSQdi4F02AAT0vInlNimPnkdNflEjJXMVPG4LfpZpklIZAdEI4hi/wyEhMxi7iYCwxKhrDh72dJTqtKpatpiocqmNRbZ5HXdKBQcQP5tP+mnvgQ4FrMehZW3RIjRPsAcNNdEd15TGqt0ZrxMPVWhfAY1FgU0LAaQTSMdx3RE5nJIPGa+rspY9STJ6e7XAOaFt/wulaW7R9y9zZF+EhatenGtYvDBDWzMRmyNuZliRsJLEps3x1WVueaBL4Za5dkmdjexu4nde8bu8svTOKDEt9z6bK+2PhdGltBvwcVzpfUp2HuMFfNFYUAKhtwSUEhskX55d47A/qQMrVefp7pQ37M/CqV8BXy/skd4PqD2ozJWwxYEkPUYRzxkIpUdMu4FYlZUUNXOKreXthhoOKhZ0yIiaxZiZkshobKiNIaQSLclMquc+cmLsUR+lNymhwxIXE2WTC26300nuekkN9VoU41+nGq06SQ3sbuJ3b9m7H61k6xQcbTEPikeogdPi+9JWimwQMyPykUVcmyq5W6FiImqx2o1O4fWoLc92B7up2o3k7vZ052DYS992pN7+9v724Pd3n6rXusvF3FcBVkzpmr2DnZkFaOJu0YfVxo4l/PWZs3jP6i3UENKa5R6qr4ZOodKr+a94966E8YTWKQgLz0LLL5w1Bj6bWkAAS1piJqq89l0iJsOcVNlNlXmx6gymw5xE7ub2P1rxu6/0SHGbujLHSIW3LtDxNp2V1S91Etyrv95o8ihEhGwewubpmXBB57zLpD7Crpy0uILLJRDpB/jS4d+JU/mlx86rrrNElrPAKksciwdez91h53OLSwFC9215VS348/fM2Nv2qmddAZQz5rMQz9ShyijBaL/9iT2tm3WbaHJfUOuY+JB0ywNOSo0zueSX6Vs5IRNOLMlshuT2RJw9ehK/BgQp9LMfnK8us2usyIf5Loo8rv/XJZA6AuyrFPfV7lhvQDSJRFJhCsyF0wOQmyvC+A5ComqX5KZL6/qa86oMQ8IV1Yuig2NE70VQG9oWU88V7LA1BBO2B/98u78sRjN7+SI0lEnrDTNDwiot3AjTnf9+WkzbeIKVNhyNGbh+o3zfAovMcyhFPHenCklLuM9jdlvqAOnSNysdtqkOFfQrqtHcwtmdKOJSmR7oW1yTp2ZDrTYkY19j7kc8txQu3TVfm8S8UJTltJU1mlNFJGP0sXldC6XrMn1UBB/m1NLArWEqbnHSyiCai/TcD8kRYwTCZk71taDmQd6SY0eDVl4QlSXMZAmIo7mrzDp3GoPxtGglxC9Jo735t1Yo9Y2t81v0zmUyjwTJyIdW+vUz0KQ61CoXI5KRNqDYd0Q04QjIul1a5CSwDLRCTpHxvcagWGCM8kBVW5uXCx6OpOFsP3AlkVe+MCXlT40ZObHlyiwtDKzqXswZmKYEMMk5AkX8Yf6RY5FV+UgA+eB4ABHC/tzJohAa7kx0Fqb+Zl8h/dQ+UgBlam46WH4crhIgvGT4Be0ulqDVE2Nd/W7FL6LSIuKWENZ8yODZQ2u4s0taueS3gLe6tCE6umfTV6SuL84WXlj8tn3ztJfyCR/nrz7f8p4m0zzI2aa2AqTuzHbODPUnfx57OlWT/owDkBu/Iu3HKvcdWOmCXdRqYupE5rm0pNXc1SnY634jGCqpKf+cIs8y044EjHOU/jPL7WOCqxB2Dr0rXKgc9Bri/MFZ8kBE5pPsit9dyUPKsQrHWPmVG3xDmObSWEWGtnoJgDefbRxdjuDZd6SYcWLubHRdE0mpQE3istyIiRc6hsekWmXliFxYYIzaq4Ly61ftWsexeRqJEKbh5di4t4M6fgZk23N8N/gBbu7ePYM1fNFc3TyNBdVgpyqnD2T1jVb+2/RhrclY5VP+Z45YGEErHH49eR8hSKIGQe5MJzbYtSJm1yH1oIIjVDBfXba2+1uwiMFnk+t8xhza8RfKb90EX3N/wRYdsrbxRn8f+v/FcRCQxNCZ0onXwS/DFNNmCEvW40ZkkIyTpGYOcYQlJbc3tL5CI1Vd/T4j1LR8H15tZiYeErBBj4n4THmk+L5nE9SFiP46m8NNNtU0+2rYyj+7l+bi3eU +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get role insights summary information

+ + + + + +This method returns high level summary information for role insights for a customer. + +## Request + +
+ +Succeeded. Returns high level counts. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-role-insights.api.mdx b/docs/api/beta/get-role-insights.api.mdx new file mode 100644 index 000000000..6ace0fe21 --- /dev/null +++ b/docs/api/beta/get-role-insights.api.mdx @@ -0,0 +1,87 @@ +--- +id: get-role-insights +sidebar_label: Get role insights +hide_title: true +hide_table_of_contents: true +api: eJztW21z2zYS/isY9kMbjSlL8lvtmZsbx046zqRNLrYvN+d4phAJSWgpgiXIODqP//s9uwApUpJt1cn0mp6+2BIILPZ9n4XA28BkKpeFNulZHBwFY1W8M4k6S60eTwobbAWFHNvg6CqgYVGPX28FsbJRrjNaioUXE23FVBUTE4tcFWWeWhGrQupEYYDWar9WjEwulIwmPNzFFpnMJZaqnDa6DTTR+61U+QzPUjzBVzMaWVUEi7u+4WGQLowoJkqMyiTB9rZMCoEHXXFpS5kkM2EzFemRBi83upiITqKnuugILMvkWKeyUFifm3I8YTqOhO1+SM+VElf/3BHHb8/EeSHTWOaxODFJoiLiQbyteb/+blIUmT3a3o7VR5WQXrsW8mcG7HUjM93WcbotM71tPZ0wqumEcx08YwVNTU4qw8cpW4f0lKvfSp0r2GkkE6u2AvVJTrME+ultBTaaqKkMjm6DYpaRyrCrGqsc6xwRN7QzwMBUp3paTnldrEYSsuLz3d3WauWzspZ0/6P8JNJyOlS5MKNKY6RRZ/6vRneDvc/Q3lR+cp+ZSq1LfLtXm5Ep02Vtno1Ep8hL1RG6gI/CjTOTlYlzTCU6/wovTCGT8IRWd0jdmUmtEhMlY1iAvZomrrDIRIKiKZNYDJU3DuJAj+oogEZFx0VYR9woUt44hQ5j2BBW1GlE6yCGLXQ6FhJGBiuCBRGRTMVEflQYhtVYWTRfTzMZFVskDRJDrmDDqUpjbJyagrzEKtq1w0T+xpJ3iCfm9qNMSuW0QLPBdmkrbr4KnyJ5VjjV0CDjyTRoeAqvZF/x7mFNzplwq+08bW85x6TawKUlq5DxK0GEnaUFwtMtGpK10z9Ya9+QHOAr9Fw+Y+O5MfIIW2YZSRqzdjl3g4y5ocfI00lsj+AdzpvfjC6zGJFg4U6xSgtdaGXfw+OPo0hZjLI//uTnntVTOp2gYZNggdgqA9pixlPJzLw2S0x8vz1tkYPfoGm+kU4eN99LnvQnN6CTZNGEL6vR9YzIucVBDJPbI6IAq2KLTgf2tTcdN2JuUpX/tDTc0Fr14PdbreEA2EDYG/EheGUm6YcgeMik17SRS7KWng96Pfq3EIclPFAhq3XFOw96pEi0LTgBI9ity8yNxCHk0JTFA2goMig9qBDYTGZZoiNetv2LpR1vlzmWeS7JxXShprYxboa/wKgEr3IyAAUEPdXxsrRLxcgxh2hrBVB/d/9A7fdVOBp8vxvu7hxG4VAO4D/7UdTvR6Pe4W4/uNtaCrRVVXUBPXJBmdeu0q30bkUFBMpp8rKHbaJcYVJ8ij+rRKrrNpEKCz1Vy9vCY+unc5NwCUwkrOi3aPPRbSll0Bv0wt5e2D+86O8c7R4e7Rx0d77f+zcpgrlecprjSpqHDeUSymOmYljOU5tMnZtRcSMhxYsU6FZB4+BmHcszuSeavUVprY2aQ80d3yL/IFJuJkb4JIZc40Winep0seY+PH9ZS8/NsKZ2tq5yHK0nqQh7oTDxgmaTRZ/ZPu77ssOQm/6qKZGOKid13qhdfrVmyqXD9WsPOpV7+pigFy0gOa+5VIXqMJhjTn6cKOC7oh0bx6enzvGWi/Y6SeHLcPE9sHiThzNGpir+YhwwZI0NQ1VGwlzJ64bzPr76zNc90GVN5oqFvDlnsb1Vr9e7z/v8//u8E+N39Gh3Vfk7STT2Ey/yHPkx9CXQ9Raui+aeQQxNPCNf1SmAvY6fUuTucWd3wnDC1f4xp36JRBiOc6mJQ8UsR1goQPGjjgmyMMZ3JEmZ7FQ0r+3U0ES3L57LGPI6+U68MKTBXEYI1fE66eQy1VgvqiUwXg2jVmyrDpQc7vcOB7uj/V0pkWf6B3vDw5Hc2ekd7h0e0u5TBJYct7ynQgftrX9QSGI6EomJYJH/0BGNkpRyGY3Q5usDCqaxZlJxc2sxPb+iUJ/QKkrx/OSt2D1A6U3HJY/L8YIS0vDynFrpMknksOq0ILkj/CbXY72y+KiUmvSr4PTFy+PL1xcYeffiH5cvzvGJaC0dZx2n8NaY3NJwYE3MDXPsBbiRKEiKQDNBv46n2oFAMrXNidp9szMLZQrf9WGF333FiiZpMcrNtBVKHDefCvGd7qruFjpjjAHlAD4OJVpkYVJ3XEBJNivC116THX9O8KwrjuNYk5DIG9xmW6yfUYst49j1Ge4gDaHskiuhVaQ2HS0An7kq29aYp5HXTaNQcIDzx/3kOCpKMMdiNqOw9hbPorcPeHaaa3N30VAaq5QaKvQ4ER8HRibPoWExJCQOxOfTEfc0SDxpNa/OWM3syOnuR8fMaWH4WSRLu0bcvU2QfkIWrX7wUfng48Mzl43YGpWZfEbyR5y82M+qzVUFvuu6NrG7id1N7K4Zu4sP3/mm3z9l6NNfhj6XqSyh35yL5xL0ydl7UiOqSa71d4bcElCIh0iv3l8gsH9VKc1XnzI61/iC+MiV8hUdaGUPf8BUnT9VpX9uC2KQ9egkGPEPOkfM95xjBxJZVTvLu700+VDDQdMVEBFZMxczUwpqVvMyTfmA2W4BTyubfusBteSWwWVA2jWNQ3ectUGSGyS5qUabavSXqUYbJLmJ3U3sfp2x+yCSrLniaPE4yZbTqcxnztP8c5JWCkyY/8ZfhxybahGtEDFRY6ygjRyC4aA/7I8OIrUby914f+dwNIj2B3LvoH/QH+4ODoJmrb+ax3EdZO2Yatjb2ZFVDBD3ETiuTOFctjAmbh//lfRb9YjSGqWeGjdD51DpdYUd91adMJ7BIjl56bnb4p6jRoe3ZQoWAEld1NTIZ4MQNwhxU2U2VeavUWU2CHETu5vY/Tpj93cgRI+G7keImLA2QsTcbk/UWOolXz38o4Eih4rngN1bmCgqcz7wrFAg4wq6Qx7wVXTKIbKY4Ms2/dIe6vm1dAc5HStlnmBKde3tFhaCZe66MtNd/4P4LDU3fPdtCLWsyDjuLgV5C03gW3Zugy7rNNfkti7HMXGnYX+FM6iv1z1ImW+fwXQzUyKrMZktARf3LsTDYDGT6exby7O77DJL8kGuyzy5+3xZHKF7ZFmlvgd3w3wBThdEJBGuyVwwNQixvS7Bz4lLUMclmffqujnnnAC543Bp5rzIUBsxWGLoDU0biOdK5ugW3Mn6d6/eXzwTY4KhnAbcdUulqW9AILnLRnDK4+qUmRZx5Zm/EHDcOsensBKjBEoR/kayv7kx+wn5/x0SNqudFinOEbRq/YuZsrXunvvHH9JQnOrc3dt0N+W8iO6O9lVWySUbcj2ViW8qaqGjFjI1uhLa4sKp9ipy90IixDaRkIllbT15c0cvbNCj5gojRHWRB9KE56P960tUWe3JfLTohUSvzceH9P1Eo8a2l1WvxdgJX8I/E9HEGKv+LgS5DoXK1bhEpD2ZrRvaNOSICAe9Bkuh2zLUIRAj8/cagZE6Z3L3UBmwGGC5NHZh+zNbFnnhZ75b9nNLZh6+QmGlmbGJfsdt4wWeacOQNgxdnrCef1e3yLEQ2yQD5wHnACdz+3Mm8Iw2cqOjtTLzM/ltXkPlIwKrTMVmR+7L0TwJ+k+CH9Dseg5SNQHu+vcofBeeFhWvlrKqo4JFDS7zmxjUzAW9OX7rwxKqo382eUni4/mJyps0mX3pLH1PJvnz5N3/UcbbZJq/YqbxEJjcjbf1vULTyZ97TLd8wmf54in+4inHKqNt9DLzK7JNQlkiC/JqjupoohWfDWRKFoQPt8izzJQjEW08hX/1LsOY78TnYFmim9MJ6HXFxXxnyQHjwCfZlb7bkhsU2iuaoNdUXfGebuxGMAu1anQDAM9+Mb5nO4dl3pJhxWllbICu6bRMsRvFZTkVEi71iEfE2kalS1zo3FJV6cIw9KtXVVFMrkYidLlpyaf2zYiOndHRNgz/yF6wu/VnzlD9/B5/MBfknUrYM2leG9o/RhveFk5UklGziKwLAKYaO/x4drFEEcRSC7nQlJt8vO0X2W2aCyLUQjn32en2u72QWwqMZ8YWaG8bxH9QRfs13kUHvJ2fs3/Wy8C+chDk387oCIv4KV2b4prBq6DdDKJ1mIBfenB7S8cb1B3d0bB7+4paDmiQ3Hr+ztC9vP9/vVK8Utu/KjpwqF+59mcKQUC96PqK/LreD35AEdXrz0/Uw+bN3q/vzd4HvKF6ffuJ3rB5c3ftN3cfMML8JeknmmHzBu7nvIH7gGXm7z/PLXM9P3fksz7Ua85tXJndMvc7RGPV0i/1RKU+G/7hBeDL3X8B6IQsaA== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get role insights

+ + + + + +This method returns detailed role insights for each role. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-role-mining-potential-role.api.mdx b/docs/api/beta/get-role-mining-potential-role.api.mdx new file mode 100644 index 000000000..947f05e11 --- /dev/null +++ b/docs/api/beta/get-role-mining-potential-role.api.mdx @@ -0,0 +1,99 @@ +--- +id: get-role-mining-potential-role +sidebar_label: Retrieves a specific potential role +hide_title: true +hide_table_of_contents: true +api: eJztXG1z2kgS/itTug+bbFkYMC/GX66ITXbZ8wsH+FJ3Tio7SAPMrpDYGSkJ5/J/v+6ekZBABtabutvd40sipJmefu+nRyM/OtFSKB7LKOz7zoUzE/EwCsSNDGU4G0SxCGPJA7zlnDgxn2nn4sHpd/sMbzEzzPlw4vhCe0oukQ5QGc+lZgsRzyOfKREnKtSMM70UnpxKjy1TukwBlQpQ1sJLlIxXQP3RuddCXUZhLL7E3SSew70PT7DEkisONIXSNEriQksOz0+cEB7grzy/IA7Q9eZiwZ2LRydeLXGIjhVy/HTiKPFLIpUAoWOViE0JuhtMMonkxBe+WAZI59yrdaqi1XbP25y7DeF3XN6pTly/4zfPGo1m/Ww6cZBrJfQyCrXQyES9WsX/ikuNEs8Twhd+hQ0zXQVSxyyabnCh2TRS8JQ4WpDyGZDWQAi16KHSwhiX4MtlID2y6+lPGtd53FZGNPlJeDFMXCr0glgaLj0leCz8N6v9Q0ErW7rdVGX/CgWJ54IR4UgVFFn3OrXzaqfabtV4k3OvWmu36rWm12jxVt1vnqOpfKmXAV/dkpX3LTeGhewEhn6xa/GungdiVRlIoTzhPMFSsYzpSQ+UHq8uU01cje9KF7LKZ1ZlbLJivoi5DHSFGBehJq/OmJZgoZlQ5Vyb0cgwL4mRjO1288QBP1jw2BA8q5u1cvQOUtL6zt4lnSwVmMBHN+x6XpTAPfBBXyxj5AGHgP4W8P8lPjtQ8DBZTIRCJnIENJPhbqbqpXoQX7wggWjq5UhtBx0um8ZYblEIc83iiE0ES+ngklYGrhRfwU8Zi4UuTSoZbw9Otc2rk4aow/jaGV7wqvMBhkwhI8xD8JsDlZONf6FfSF8YX36RQexsCPcXmiNd/kqiliZJ6p8bOcKOYjw2oyiGswkH2OCZBJXROyx59P00XRQFLcQCeDtXMbqLTU4FwQ7lk/u+xDk8GBQ43vCpglPl5PkHDxIcd3vDxpC+2BnlfzJx6+lDPpWt63m/zBZPOSP1/T2hguHxjB98zRgJDzLWbS6778pdI/4JUvNGBnNZtX1aqyJD4DGfJKbxUQxJvFwB2RgquTjuuXDc5FlAMKGsg7tx73bc717DvUHv9qp/+x1cXd7dDK574x5cvu32r3tXCKZyaTc3adueBXw2KEoBcv2S8ODw6mNH780ytWq1LM6VgVwHVR4zdn/RSd3DbfN2y200ptyd+ACyvFaj1WxMWq1mrYNrazRwbulJBKR4WLp2cb1vNKPJZNJEF5ZHWIjETYkvd4u0/q+x6fMO+duRFK64RlMlILCgvc70rDVtiqZbE+c1gKgeaK963nabjfNOs+N3al675hwcbDlpM6XRTCCQBAGfpCrbjrzhDRtZPeWiDji/TRb9rL70w2K7sd9rMQgWyeLgarWL1XqpUy9VEorxHCtwFPgHBhJNAgvZWRZOJBo0AagJOcBbHg+8JMA8slREYiL8QXG5HeyWltpdYTDlSRCXtzplljXhUBYNXrR8JkXSow0rIE6MsRnc46yPxRL0AEkQqEM8SY4uGSWAzyvobhdXPOYjT4rQE3ipBdXStCq+lQFMusymPm72DlAgFQ81Kh7b3evI9EgX0MryhUQtcph4zSciOGy4D0yUrJNN+5tYUQ90W+lfYSof//Njdzwe9t/cj3ujyvXdZXfcv7tdx6ET2DVALNOaQ88C/cjf77vXI7j3Ces+deGGBSj1T/tzS6G8H1ypd+GAg0xcyKcP+3u9k7Ih9Xo1G9OoEz7wcgben7beQw7nypu/d1g6ETjmMRZ1P/FAhvhloj2f+PZ47NNOlz0MQZbaZ0rE1mK+WIL/j8ApRcm2Vo0o02WxtZnxhjmFrssMjX0eA44GvUsAc/1/Ac4j7HcDEhQAX3HENnN4NV4ZxnQ5XB1um9og1h2MXQ573TEteT+4sldW7f3e6OPdm3G3f0t3B8P7297H8ffD3uj7u+urwqMUrH4c3l3DrMHw7rI3Ghmgu/kwXbEg/ZqN582SolssN3D7hnYZS3bVzON0F5LKL2ACL1EK+/zyevScem66t/eEwbv347uPw5si19nTnb605nWn2w0yJHkVRy9xv109yNf0v1IhihDORFijbNPzMpBohp5SkKFcu/GJJrLYVvwCwRqzSeSvmEQ0B+Er/a+4yWm26S4j/wDs+1aGwp0pLpFDQSx7MNE0hT55WaSE3flL4TmNK/YzoIlKjb3hAImtfJdWGFSm4t7P1KTvZ+g+lDCfpVOgZtlMX7qsaAs+aVU79ca01eC8ft6otZuTzpSfnVWhE6AWagHex2eiDB8Ul/5OhFBZPIbZNpD/FrjBz0H3xAAtfvjmDNE4sPcwYzMxLb8MXxKcANJ/czlgjTYLeDhL6D6fbSghdO9HWxUPJDeE75ScydKN0zR2rnpvu/fXY7gzhJrSG8EV0tp699ENwVt9dMuIepJ59NngCyPAZw4YWwSgDtzw/9ZS/RYEgrqXHyjNL73SoExmETzMsKuXzMiTZlMVLQqh5Jk3KuyVrIjKCbQkcA8aCG/OJpx6k5CGf9v1PLGM3WuryW/ZXHBfqNcV1s12rJgppjB/hb0N932TXZHANIFQBmYk5LokZmEUS2+jr1+rchN/pBnlOm8UDA7gfL+fdL04wSyIYuajMPMWy6K1D/BsNFfkbpxTGql0FcbcAyl4EKxAjVBAPMhMIJuMNbPpCM2lIfGE6bgsYxXeKiA3N4YZSu+IZXmiD4i7QQDpxyXRsgefhA0+2rM22YiskZrJZiR4iGLTZDsqM1ca+AAdBfWcx9g9xu4xdg+J3c2HQ/uq1z4l6FPbhj73IU9Av4qK5xb0UeQ9YcTSQQRvrCFPcAfJQqQf3o0hsH8WIY4XX5b4Lvsr4iNTyreY72b2MPcnCD8yYxVsgQySHo0EU8hEwr8gvtcck6KMqs62V3sbqYkEBw1LICJkTcVWUcI4qEwlIUFhrk+YHwkdfhOzOYf8yCEitDYZEFcNfXcZyTA+IskjkjxWo2M1+vNUoyOSPMbuMXb/mLG7E0lmXFG0WJykk8WCq5XxNPvcvFCHASw9dMiykPtkjosU0QoSYxnGcorIwZnUa5PatO2Jhs8bfuusM617rTpvtmvt2qRRbzv5Wv+wjuMsyIoxlbO3saN98ag+AY5LQnAuHUeRX9z+A/UqMcW0hqknw82gc1Dphww71jslrySjiN3wcJUiJF3AkOFaR5jTYOwCx6p0LL0+nkFeDBmkKhmZc0FygQdHFL61DeRCUvCiFEBXrdzuFN+9mEBJnSxbRYZ0nExTJggiRM0ROJYEIcUUMR9QIAQ7g+z8FdGpNdFvQvJsiBJfo8Ss98UcVmUZcm+W7e/2gXmFOWJkDPzMRq/pdngIDgANgclZGe484vMjPj/W+GON/3PU+CM+P8buMXb/mLH7K/C5RUPP43MYcDA+h7GVKsuw1Fs6xPffhukUKpYDcm8WeXSMwl9jcMIV5iAGfkKGOQS/zLpwTvGghWsOKrjZQQWXPmY6fdz4YOvJweO2iBcNq4kKgMQ8jpf64vT0EcaC5Z4qfCkr6ZG2MPpc8aLF6QTUVpKR8OiAiT4cwLqDvu04KqRzJdGtTQ4k4sYC9rCko8EStFu8k3L6kdEqSiDrEZkTPIlhXYxuA4tL6C++0TS6Qi61JR/Ida+Cp98uiyH0jCxl6tu5GoxnwOmGiCjCh/WHeyME42b1rc/31gUGG7j61mJ3OKzO3giuoFMw7zRe/fBu/JrNEIJSCkg0ol8hsWeAIBqAi1CK66b7+ziJqo6KktmcGO8W3qBgSLFpAAKz9+FICPaQfg5xC7l/CMmaVIqTBOUHnPXhVWodX3wSAZbFylqT6HjSD09BQ6e8MO81lUDqFWRoTuriibv3ocuuJGYmiaUcx1gRqfVjD8tULp6T66VM/CWl5hpqLlHTrze4MKp98MyJHA/i2sSkJm29eHFDz83Rw8YK7iDVTR5QE5aP4nsvL7Xai/ko0HORXpGP9+G7uYT6WpyWnhvTUB4Dn/WZN48iLf7KGLoOhsHDLIEoejFbn3FRlyLCrVdzLLlmSVe6gBaJv2sIjNA4E59gtSawEgGOC30Tkj+SZSHmf4Re2mc/FmSm2w9QVHGkH3n6xTzjgi4u6JocoC3/9pNHYBZiG2Uwn5GSA1yu7U+ZwDKay3uGVmlWJ/KnNMexZ8+Jil5emB8X6wRnr8wxdBydjYE0jGA7exMIv5mlhYWroKx0m2BTg9v8BhHUyw29GX6zbSqsob83eVHi7no35S4MVl87Sz+TSX4/efd/lPGOmebPmGks/EV3o2Vtn5B38jcWr23v7uH281zAv/CUYpWQNvQx1JkRiskTWgY8Rq+mqPbmUtC+wFLwGLHfCXpWtKBIhBYewx+6PyI0o+/TFbDMoZOT+KEf7VynK3MKGAMs0a74WyfUnNDHSnPoM0WFvYNWLfTALNim4dkLePZTZPu1EVhmgIZlV6mxAXQtFkmInxUC28mCcXCpPR7hS+0lJnFB1xaKVBcRQb9sVhrF6GooAh17Fmqh76a45QzdbM7we9YCu2u73wyqRyvaTwrWggxFQJ6J44qwfR9t8DZ3LoIlNoqQdQGAidwKN/3xFkUgFtoPSCI1O7WT9CmOBSLYHhn3OavUKlWX2gX8WC3SMbS2OeL4WgJ9ZMcf39h0ycf1rvuv/ysetoAg8j9d4i4WspWYTsT0gw/Ojn4QKFxs/gkPaDHmIBfOfHzELRDskJ7wNrT+2F/jp2Jp80NNI+gdr6ETnUIm2PzaLS/fq6H9EyCvWfmf+yiVJ927C1frtt2By5/pe5VN/p/wcyWzN0PcmVFm9yY3f+v9BvZWWUf9XQ+dhD9Tpu0F/pWUp6f/AP1SRmA= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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-role-mining-potential-role)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Retrieves a specific potential role

+ + + + + +This method returns a specific potential role. + +## Request + +

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. + +
  • Array [
  • ]
    • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-role-mining-session-status.api.mdx b/docs/api/beta/get-role-mining-session-status.api.mdx new file mode 100644 index 000000000..f1ebaa9d3 --- /dev/null +++ b/docs/api/beta/get-role-mining-session-status.api.mdx @@ -0,0 +1,79 @@ +--- +id: get-role-mining-session-status +sidebar_label: Get role mining session status state +hide_title: true +hide_table_of_contents: true +api: eJztWl9TGzkS/yqquYdNUswYjAmBlysDTtZbJLC2qTwQKpFnZFvJWDMraZJ4KX/37W5pxjPYQC6XuttN+QVsqdXq//q1rNsgy4XmVmaqnwTHwVTYQZaK11JJNR0KY2BiaLktTLATWD41wfF10O/2GVIxRxbc7ASJMLGWOfIBLqOZNGwu7CxLmBa20MowzjQumdMSZhxrZog3m2QaCOLC2GwudAR75Vxz4CA07ngbSGSbczuDKQUT8M2zALF3AhPPxJwHx7eBXeQ0aTVKttwJtPijkFqAclYXYl1SsVEuiVzFVz7PU2T3It472hXPD8MXh5yHHZEchfxodxwmR8nBfqdz0N6fjIPlDe5m8kwBF5SlvbuL/5o7Dos4FiIRScQG3jRNY8DGcaasUBYX8zxPZUwOan00yOF2Xdts/FHEFq2m0Z1Wuv2Rn1iXYHCPHwS6uGE+MIEq5ujy00GvO+qdwcjV5Zn/1D/rvRn1R/3e8P3Fyajbf0Ojl4OrN733o18HveGvF+dnjamLEa7onr8fXJzDqsvBxWlvOOy/ebVhstzxpu6HlRhWWhrZGK0iWC4fIQE7L5dI1dnkpNNUgv1ZT2sIzNA7SiRMTpjFiIGYEsaycZYsGIS6VJ95KpPox7kuEZbL9DRLxHpQ343hl1KJcKq5RAkFiRzDQgYcP8sEvTzPtGCOJcucCkQXNYIcLBHtsROegL5Ov1OvDBpT8/gT8MIq8ZhAV0rCelYugWSiBL9nW3Eo+Pj57lG7M3ne4bz9orN3eDA+mvD9/d2jg6Mj3H0OjuNTZxq/N9eaL9a2fiWU0DJmaRaDR/4UWH842J4EoM1hibRibh73AfH4BvtjDXG0lZpeXmbFV7sDle3k9JJ1DlnK1bSgcT69YwQVXg2xthVpysc4hNUKNHeML7ScSrVJlDJBz3ovu1fnIxgZ9H6/6g3hE/JaK81dqG0qwbAEUSEWZtkXktgr8IVjOUrBHFignnmuz0AhDoWqRijdN7MwYEyIrQkvUgsr/O4bVtRZs4nO5o1Uorz5atkTGYloh41xbM5tPGNjbmABuBDJn3WheuY2PPeWfMZmgidCP41YN0kkKslTBtkITGH9AhgxniSYuo7BpIBUBmEkHE6FZSqzMhZNX6xM2fTGqqKc152CyQGSPx4n3dgWIBypWc/CKlq8iN4/ILOzXFO6Uc1oZNKFsjwGLXiaLsCMWoOF2Rh0k9YwX47QXQYKjyrpqopVL5RU7l47Yc5sRnMxL8w35N1lCuUnJNWqic/CJx+EQearEXmjdJOvSDCJatNiT1W5q0x8NpEiTba5u83dbe5+Y+7enRx4aOpnCfrsrUOfK8ULsK+mw3MN+miKHpWxkojgjXfkDgODeIj029sRJPYnoZBefM0Rgv9AfOSO8jXhu5U/3PgY4UflrIYvUECyo9NgApVIJMck90piMpQz1f76bi8zPZYQoGoDRISqqdkiKxgHk+lCEdrmZoclmTDqF8tmHOojh4wwxlVA3FUlYZ5JZbdIcoskt6fR9jT6eU6jLZLc5u42d/+ZufsgkqykomzxOMkU8znXCxdpfh615QwIWHlJyqqUI1fdRSvIjFUYK2gih2Dc3hvvTQ5j0Ul4J3m+fzRpx8/b/OBw73Bv3GkfBvWz/nqVx1WSNXOq5m/nRzIxgLjPgOMKBcFlbJYlzes/MK8WEyxrWHoq3Aw2B5PelNjxYNMNYx88ojFKh26Le64aHd7mCkQASOqypkI+W4S4RYjbU2Z7yvwcp8wWIW5zd5u7/8zc/Q8QokdD9yNEIPhmhAi00S6rsNRLDK7/OVCkVPESUHizLI4LTReeJQokXIHvIQJ6Y0EPHOwMvrTw9UHofo0P/a/xpnVbPW5YtqpXAQ6MOiELncLimbW5OW61bsF34LNlxHMZQUkD99mFyr5EcTZvjcFgG2oR/mzt8g4JWPey79FuRNbWEgPaVT9i7mxP+mHogg/opvJBzvhSA526yAqod8Rmh0Hw++CiYRAx52rxiyHqiIJpTT/Q60qny/9eF8foHl02me/B3YCegaR3VEQVbtBdEATAiPx1BfKcutLVLdDx1zd1miFCdSfhGuXq+MEGo70m0AWStdmJ4Br6CHfn/uS3t6OnbIoAlQpEYRAbC4kdBaTYJYQRFcBuef+Mi+hM0lkxnZFy3cYNPyYcm6RgFPZODYVg131vqDdwMgyglJPZcZGg6oGrbp6UHkzEZ5HioRmtrI3BKRPVAiu2eGPdUzogqZOQCj7OaTR6p0J2JrFuYZIQjVeRLtfZdV7qxWt6fa8Q/yq5hY5bSNzM0ztSONNex+7FSAxZjyx4asha37254xfW+GHbBSPI9a4MaAkvR/N3mbj02nfL0eAXIr+mHO/U25mE07e5rHz8ZeDwTBPWZ/Esy4z4N2MYOpgq19MCMu27xfqCm4aUEWF7tyZS6LYMZQhYkuQ7h8RQLpj4GM9ygjIZoDyVuLT9QJ6FuvABOu2EfWjoTMPXcOQiZZLF5rtlxg1D3DB0dcJ4+d2JhoEFuY06UB1wAXC68j9VAi9orTY6XhsrP7Fv0Rp6Iweiundh+bH7crwqgv4TowmkrmigVCMUr36pgu/M88JjrWGs8hLhrgXX5U0zOE3v2M3JW12j4An7d9MXNe6u7louVLr40VX6nkry96m7/6eKt600P2Ol8eAYw4229V1EPchPPKZbv/uDBgH0hr8wS7lKOBy6HOrbCMXUGeUptxjVlNXxTAq6NcgFt4gPdzCysjllIjT4mP7QGxKjqQYaSFsDuJWPZQr8IjZa7cwpYRz4RL/id1NQ64J7xTPoQkXE3kIjp2JwCzZx+DYA5j5mvpsbgmcu0bHsrHQ2gK75vFCwG+ZlMWccQuqRiEikiQtXuKCnU6K0RUbQr1pVZjGGGqoQUTuj5+ZighfS0OvWHP/IXuD38tEymB696F9orxQZiJQiE+ma0P4x3hBt4UykObaRUHUBgInaDq/7ozWOwEwZ0Ava9UxPW36RaSEtMMEWyoXPfrQX7YbUUsB4nhkLjW+N+SthH3qzXj6ZbsTk7epS/ke8gvdnCjYDrRyvvVDSwjUwroG8DjY1kLD0uPE+3vWQ0HHMQE1cdXuL9yXYVC1x+I9CYDN+fbPql6hvATfgZ2hbJ1AY7j6fr2v7ZOAf2j9lDz6q36hSed+nFqtWP4CPnwTeEKw0gXYaVKCbHBLPzbu7ntrKtV9DsNeq+u9XPQiE5V8YjCU0 +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get role mining session status state

+ + + + + +This method returns a role mining session status for a customer. + +## Request + +

Path Parameters

+ +Succeeded. Returns session status + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-role-mining-session.api.mdx b/docs/api/beta/get-role-mining-session.api.mdx new file mode 100644 index 000000000..40bcdb8a7 --- /dev/null +++ b/docs/api/beta/get-role-mining-session.api.mdx @@ -0,0 +1,111 @@ +--- +id: get-role-mining-session +sidebar_label: Get a role mining session +hide_title: true +hide_table_of_contents: true +api: eJztXG1z2kgS/itTug+bpCwMGBvjL1fEJlnuiO0DXFu3jis7SAPMrtBw0sgJ5/J/v+6ekZBA2MSX2peU8sEBqaen3+fpQaMHRy1FxLVUYd93zpyZ0EMViA8ylOFsJOIYbjgHjuaz2Dm7dfrdPsP7zBA4dweOL2IvkkvkAOPHc8EWQs+VzyKhIynuRcw4i3DMgsaw2HCtAdsljzhQiwiZPzgSOSy5nsOtEG7AN0sMsh04sTcXC+6cPTh6taSbMAEI8XjgROI/iYwEaKCjRJQJVSIBkz7Tik1EJqqPQokvfLEMkP+p1+jUxUnbPW1z7raE33F5pz5x/Y5/fNRqHTePphPn8Q6nj5cqBLYoXLNex/+KIgyFTqJwhylgUk+FWoQaB/LlMpAeueTw1xhHP2yrria/Ck+jCSN0oJZm7thTeHtzdjQA3WJqClrDRBJHsKmKmJ7LeIdQT89l+az6fpwTjEcRXwGt1GIRl/pqW7RAxvorJCs46dZpep3Gab1Tb580+DHnXr3RPmk2jr3WCT9p+senQF1C0mzWM5pW07kDwUAqCEVZEmFlQn+E2OSRN//osHQgSMw1Ayv5iQc66JepFiZBwCeom4nldTzGKok8UcPUOLvgmo88KUJP4MdYaLQt1yDwJNHinQxApPNtjXb5xzq51D9TYrZW88UaQFzKeBnw1SVl94OThDriYRxwjbnrDJSJ+zOoL3whSSOYcMAnItiP3AdblMyTDfunWMHA/sVlrX/Ruxz3x//+1B2Ph/23N+PeqDa4Ou+O+1eXyMkWoMDOAWqZSqkiuNr71013MIJr9zxIBJVGI8LdI/yDzJGaPLZVS0eUoEABVrtMFv0sLPrhtcIKIHmAg3KekVAZZiLaCkLku0gWLEwWE/BOMchkCKVmmXIkR+Wzpll/xHQmfhPhX0dJKMZz+D5Xgb/H3BgVnlosIdJ89grCYc3rNXwGbhAglt06XNaVJRPk9IgEecH0m7OYSp7Ewn+urGWTt8kKebOfq8QU4T0EWNu9aOe4oN/mDPFQcH/1TeZhn+fSm7M5vzfOCAR6A8qPh6pS2crkaIEcseY6ictXh7Ll0dI/tw4gWcmaM9zBUawZZtVVgI6YQ+fDXnfcu4ArN9cX9pPN035v9Onq7bjbv6Sr18Oby96n8Y/D3ujHq8FF4dbVGEd0B5+GVwMYdT28Ou+NRv3L9yU30xnv8nV2LcbuPCZNnk51Yz4gkf7zS4odxPr7h++e+AQXNoEV88L6aVMQmG/BIRqxeApXy4UojcPsLsSdCHdKyD7zmNkZa1TplC+n8vedPs0GEsBMuE98EuXu8Bxd984hdPo/U2ycX334AEtFIXKKFNuhgZ/GyB0jJ7csZritAKpu7/KgZI/l/9lFpVnfrrbt+lNLwelReYk8faqutfLFxtaHp/LS5ohzUm9OePvo1PWmrVO31elMXN4+rbvtyUl7cjT1GsKbOhvxDHi72XDrHbd+Om6cnDUaZ/Xj2lHr9GdnM/SeorQuz/vvqdweWsDvmOW+VQb5zwNwj2a9KIJ8dpnpAKBAyykhQ2xZBIDDifJXTOKKDVhCUgfyjZoBX2gug3Pll6ZdUdh3MhTuLOISJRQksgcDcTW5lz7myEJFkITEEtciVIHoii0TWKLWYG+5D/oa/c6tMmjOiHu/Aa/+HvXwJpQwnqVDsFczdbF0WtEWfHJS7zRb05MW583TVqN9POlM+dFRvXPc6VBygOv4TJQ1K8Wp34sQMs5jCP0C+V+BrSwH25MANPlu/LzpA+Kxh/2pDSLaTE0rL9Piiz4ANPf2/Jq12izg4Syh63y2YYTQvRltwW/Q3DC+iuRMhmWipPXtoveuezMYw5UhANzeCD4hr60mvwutc+hjWCrCJXP12TQ7RgGswLEIwBxQgNkby/UNKAQgPE8ozbd4FYMxIbamPAk0jLCzl4zIs2bTSC0KqUR580WzV7ImagcAB+EaLC2AkSYccSFWeCB/0/U8sdTuwFryDZtD7RLR6xrr+r5EJQFiGWQP41eIK7nvY+oaBtMEUhmEkXquEs1CpSXU5YIv1qbcbIbSmjLIOwWTAyR/Pk66nk5AOFIzn4VZtFgRrX9AZmO5onTjnNHIpKtQcw+04EGwAjNGEViYQR/JpI6ZLUeMEPyChyldVrHyMIjK3QcjzIVWdM/jSbxH3l0HUH5cUi27cS9s8sUI8E01Im+kbrIVCW6i2jTYUmXuShMf+lgR+FXuVrlb5e6eubt5M8U99i5Bn0YFfSroU5XPqnxW5bOCPlXuVrn7feTuPtDnaBv6vFPRRILVwxLcA6UgYiuVMA5uiJKQ9h55fMB8JeLwB2228rmH+/cmrUF2EfruUslQV/CogkdVia1K7PdTYit4VOVulbt/zdx9Eh5lUlG2WJwUJ4sFj1Ym0ux91JYzIGDpI3QsSzly1SZaQWYsw1hOETk4k2Zj0pi2PdHyecs/OepMm95Jkx+3G+3GpNVsO/m1/nadx1mSFXMq52/jR/MgnYjuAcclIQRXrJXyi3taYN5ITLGsYenhCURTBFABbA4mpceDDHZsbWPHS6VBN2AM2DHasWd2Mxwgf5ia2KPd6GdhhklLpjNPoSGkxBgGS8tYV9Cxgo7V8lMtP9/N8lNBxyp3q9z9a+buV0HH1nPQsfUV0LHFEGJNEWL9kdDRB9yB0GwKTgEdvATMGyJsxMfw4BMhsyztNY9mQmdAr4Aim52Sx3mVYh94uErBUlzYiQzX5sLyBrQLpI1SWnpwfAYlMmRQtSSgW4wqfOwSMCnEDwvkQlIeo0LAN1q53SkeDzA5k8ZbNosMvSABCakoBApQF8z7mUsIJzFF+AccaB90BoX6G+5xWm9t26ebpYa5PsHZs7wppAUbosYD1Jj1vnhCYM47qfWPy57664PwEZaLkfH1jt/AIyp2PIQ2QnxZmvKVQdAKqldQvVruq+X++1juK6he5W6Vu3/N3P0KqG7R0G6oDgR7Q3WgrdVZhqXeYXD97oidUsVKQOHNlEdY3V9jcMIVeNzdobPzWEPw/PqZc4hnk1xzvsi154viw4fsPPsjkJp2wEiXRAGMmmu9jM8ODx/AaeCsxxpfylp6JihUn2ueWhxOwFIlRQgfpDQJhwSse923/UaNzBxJjGRT9oi5MTophjELxqfHDJ7kjGeP0JsraEWYYXOAp6ZsVNFlPHwFLcUPMVHXKIq29AO9bqLg8f/XxTDaoUuZ+Z6cDegZSLqhIqpwh+4C7wMj8tcNyHNualY3QY/f3uVpRojRjYRblOt1B38daG4JdIVkTfZW8AgaCK1+g17s1T9+Gr9mM0SmVBkSPODJhMRWAnLrGsKIKl83fXgEB9FiFKlkNifluva3CNNeYqaxaQBGYR/DkRDs1p4bW13CkjCEGk5mx0GCygaOunuVetAX9yLA1bK2tjYGp/TDQ7DiIS+Me00rI7UQMjQH/vCs+MfQZRcSCxZmB9FYFakjZLfLVC+e0+ulQvwt5eYabi5xi19vSGFMe+uZZ5g9SHdzyi0ma714csPPzfHDfguuINdNGdASVg5e8JqXeu3FchT4ucivKMfH8Cc6Vlwclr7UI4ZVM/BZn3lzpWLxd8YwdDBVbmcJZNqLxaKzzC5lhNus50RyzZSudAFEknwDSIzQBBOf4CJOGEaZ7RRK21/Is1AXfoEW22e/FHSmy7ew1iKlr7z4xTLjhC5O6Jo6EVv5zVKGgQW5jTpQHTABcL72P1UCK2iuNhpepZWf2B/SGFw+8NCoOWK5PDNfztZF0H4y7/1A6owGSjVi8OwxM/jOLC9czwrGSncPNi24LW+gYBndsJuRN/sNFJfWP5u+qHF3vclyFQarb12ld1SSP0/d/YMqXlVpvsdKY1ExhhtNa9uHfJC/tZhue9MPd6XnAv7CXcpVAuDQ3lDDRigmz2gZcI1RTVntzfEVTriLLrhGfHiAkaUWPPdWDHxpBjKa0QnyCETm0ODJAPjRhnY6M6eEMeAT/Yrf48Q+XqEgJKH9FDX2E3RwoQduwe4NH+yFe78q28aNwDPX6Fh2kTobQNdikYQwG+ZlsmAcQuqZiPBl7CWmcEEzF4rUFoqgXzYqzWIMNVShRn1MtIivprgTDU1uzvHPzAV+j+02NJgevWhfhrNWZCgCikykK0L753hDtLlzESyxf4SqK/AU/XqGD/3xFkdgFtrfPlQ0O7SD4kOkBSbYQpnwOao1anWXWgp67UqsoePNMX8v9M4XcBUC8WG9Bf+VbzSzawaC/cMl7mehJIlpUExneOuUdYYw9Gz9rjNoJOYgPRI/POD+B/ZKj3gZ+n5srvHNEGkbRO0IWBc/Qxs6hXzffANaXp9XQ/uutNf0C87+70UrVS3d0AtX617egY+/0XuW1ho94gu2zFYNyWvum82c3Mitnzuwp8oa7Pc9cPjj/wCb5l+b +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get a role mining session

+ + + + + +The method retrieves a role mining session. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-role-mining-sessions.api.mdx b/docs/api/beta/get-role-mining-sessions.api.mdx new file mode 100644 index 000000000..0b5231b64 --- /dev/null +++ b/docs/api/beta/get-role-mining-sessions.api.mdx @@ -0,0 +1,99 @@ +--- +id: get-role-mining-sessions +sidebar_label: Retrieves all role mining sessions +hide_title: true +hide_table_of_contents: true +api: eJztXG1z2zYS/isY9kMbjSXLil9qz9zcKLbSqmdbPkm+3J3tSSESktCQAEOQsXUe//fbXYAU9WrFyfSanr4kMgks9n2fBUE+ejoWCU+lVu3AO/FGIu3qUFxIJdWoJ4yBG8bb8VI+Mt7JjdduthkOYHaEd7fjBcL4iYyRBBDoijRLlGE8DFmCAyMayIyjxdIxT1nEU38MPwX7mIlkwmKe8EikIsG1Sn+c3Dx6EsnSMLin4A78OZShG2z8sYi4d/LopZMYb5k0Qcae5hl7S1NYIkwWpoZlBrlCDkzKVcCTgJmJSvkDs9MGImBSsZt/vGbNqzbr5YNOdRgKH2myq4LPux/GaRqbk93dQHwSIaq0ZrgMYy1VWvN1tCsDtctjuZsvVvULOtWpvN9ZuYCzquPz1a26VW/zq0waZrI41kkK7A11QgIMgZS+x9tDKcIAdK8CZs2qE3OCFCoVwz+JoFI5YRXxsWIvoS7dlR1m7iugTfHAozgkNeJ4Jj6yWy9NMnHrEVWcAkPhYveCOfe49UDZy81kkNG1ZtrxQArwBrgCaop41QhUB4i3aMEeUPuD2w8Fnrdez17bzHZgjYqfCFTAm8kOcz/P4J/KrH2mg0pjVhpCD4dGpN68Rjt0GfSUastNhlFLvEPApjV2bTII5AkzsfAlcBiwe5mOWSWUkUwrDKbFfCQVLA3zE52NbFA78WsgvBC/sw1ekW4jnQiQyzoXDKiB7In4mMkEPOtkyEMjStqsL3FQWFWMRFL2ULj0ugEXMKVFWUTzAjHkICv8flqlfFLWgu4vwFVVFg0gJ+lh4dag0YQy6Deju8bBF2gv4g/2N1EpdAl/rdSmrzO1qM32kFUwT1WYTMFHwY1jHWehdUzBKv+s9nXKw+opzq6gumMoRoKNBQ/AAuTVOHCJRbBe3essDNhAOONgbhkWUYCJsWIjrMLuBSpvpECHQY3CXyof54EYhvIAByMDK4wEYT5XbAy5Fi6D1UhZOF5GMffTHZQG8kYiMDkKFcDCSqfoJUbgqhUi8heSvII8EbefeJgJqwUcDWxnJufmm/AplGeJUw00AAquvJKn0MynpzukZk1qcEKjXsf/5upH5vtCgA5r7EtRCrLva/BxcEVYh8dxKH0SbPc3g4s9LnLPk4SjH8tURKZ0XQ9+A6Uh7klQyam0Ihhf4+15IfpY8fAW+qgMgAGJM1xBQV9ZFKdcOCCo7KRJO0B8BZoD6ggvOBXsLPFFDUPtBAoK7/lSgDviT1s/eAp1e5ClwmKS02Iq8ClNHPLJJYXpowd+mXBlQqrlJ965tvo5AeTII4nVncPEcz4Q4WbDA2BiyTrFtL+JCSaCs8ta+6x12W/3//W+2e9322+u+61e7bxz2uy3O5dIKc/Lbg0QK0dLcLX19+vmeQ+uURQR6LUs3D1BTnrGaDO6fdbyq6Aq2jiUJv0ME9fKNr7xGv7x3o/14/rR4R4/4Nyv7x0dNvYO/P1DftgIDn6E0UuGNBr1Ysx+AwQu+8Yicltk+tYzgif+GNBiPtFGEmgpyHxhKJheIJoCYMIH09RQwqnrPfZprctuFplL7WOR+lTMF0vw/xE4GDkyJYst9Jc9ynRPGEuZEv0xZPKxDoOlaGLREDQJ0aedhbXRFTwGJkG14yWfh76FA3GS9wdXs8utsdHBAowhblcQ2ozvgqPgRSzt1ZfxBH53mUXtIrDa6kpjkZI8RLVvwNqFRWclIFQKU2ioAKbkFMnV1/HYWMpjXOaI8NgGbF0W7Mwub7xZGP/McqYLeG/yxYsCIAMyzy4NwCjNzIoaTveQNjVM64u2d9ptNfutM++5+oNUl4CG7iJ5ZofuLGR1oRCP35SWvL46c79cfmi3eu87b/rN9iVdvepeX7be93/utno/d87PZm51+jijef6+2zmHWVfdzmmr12tf/rTkZr7i3QrJV+YPkmR9irGWKOr3JgqikWVWeletU+C2/e+yIRb0NjvqtHNxAbnzbhlv+Ks/sakPoKIMu9Bkx1C+0nawWb2VQe5AkO+gixlri/qhXxASewrFiDDjA52lazxtdX19FkkQSHB7Eci1VqIzpI27eVfNNdAiiHSaTzrrd2jfYl7ceZ5mxX+nkw88gUCmjO82Vijdz9jsLIuiSWntS0d0GQ8Le5kUp84bnIxsMGGBSEGn5E053vv8jDKbVdEyrmHFxe7HEhqPSAhrMwuqplgD6lq+sAVTkAQ+wZXg+YyEu3orOqoVkn9vmN0LdNlsvvmaa9sKlLCJ/84vQTPXeWOPhk33HlmV1Y929+rro/8s1d6TBSH7yxrD0xCDjrWSBDRbdc2h7fHtbhb17myggwl241IBwpHBS3rAFWnbetSpDjbQ21upRHWUcIkcCmLZh4nOBzCsqde2JPP0QONmegTURG2PveGgTiffqRMGVZlw/wPQ2iQRXSsJ81k+BZNSvru5ZFlxJPjgsH7c2B8e7nPe+HF/7+hgcDzkr1/Xjw+OjwnFgNn4SCxroWaX/kkoCAifISAN5X9AIRCloHtigBbfvN8mGhv6rR1biOn4Zal4SHcAIb05vWL7RyzkapTRdT6aU4KqXvcWHB0kt4Q7iRxJtYyVvMictd42r8/7cKULsLvVg19IayGDNRV4a4BuqSnrjPW9bcGsAPccIk/gng1uilQc1QoIxJUpD5T2LzMxoEzmEgDMcKsvmVEmzYaJjmZCieLmIWU/yJqo7QBgN/luy4ATcrcpsdL0fRGn1XOnyYrbr3tVY80gkCgkQDLbb8D8CSJ/HgR2699uaEMoC9rewwKodCqhWZytEIUq59NOnk/Oy0bB4ADOn/eTpp9mwByJWY7Cwlsci84+wLPV3Cx3/ZLSSKX4jMMHKWhb3tcJlHrITCCbTA1z6YgeNUDiUfm4ImOV0ySluwvLjM2QkM94ZjaIu6sQ0k+VRCtufBIu+GgT21UktEZuJpeR3KMGmpzXrVwXeeDbhyHb2N3G7jZ2N4zd+Ztdtx2eYx+EPnuL0Oda8Qz0m1DxXIA+CXmP0iwfZOGpNeQO4VCrnV/e9SGwPwiF48VDjNv6XxEf2VK+wHyzsId75ps/Es5L/9QWyCDp0UowhEwkghPie8qxBYmkqteLq73VyUCCg6olEJHar4nOGAeVJZmi9oqbHRZoYdT3qXvEAxFhjM2AuKoKqvZpyhZJbpHkthptq9GfphptkeQ2drex+23G7lokWXBF0eJwksmiiCcT62nuPkrLGQyYnrUpQo5MNY9WkBgrMJY3ixy8QWNvsDc88sV+wPeDw9fHw4Z/2OAHR3tHe4P9xpFXrvU30zgugmw2pkr2tnZ025HJJ8BxmQLnMqnWwez2X4anD4eY1jD1FLgZdA4qvSuwY+N4yRMfrdkFV5McIZkZDKmmOsKcBmMjHJvkY+mx2wjyosIzQlLbXX8ZCaCCZyUZHUTC4EUpgG4yqTaH+HjaHW9yTlasIpUfZsAhZYJQI2rW4FgSzwoNEfMBBUKwI8jOXxGdOhN9EZJnXZT4HCVmrQd7oIcVyP1g2f5uG5hPMEf0rIFXbPTabocrcABoCGzOKnDnFp9v8fm2xm9r/J+jxm/x+TZ2t7H7bcbuZ+Bzh4ZW43MYsDE+h7G1Oiuw1Fs6A/B7w3QKFccBuTfTvp8ltN2cY3DCFeBK7n02zCE8HcMfu3j4pWoPv1Tzo95w2+J+y1GWhDAyP/r+CIYCAz3VeCxr+ZkLpe/p/PsAtLMk8eAJARtkOIBO2tsFaqTaRKL32lRHxK2i3ZEKrzhiv5YyvYcFFpzoDJIbkdnBA0vOk+gysBhDG/G9odE18pwF+UCu6yR8+nJZLKEVsixT39rVYDwDTudERBHu0FxgcSBE9roGfk5tnmpmaOWbu/KYHuJyy+HCyGmtwV6uscBQB4c12BvBE2ga7OONH35513/FRohGKRvY19CExPYB4ukK3IiyXTPf6sdJVICmb0c1Zx6mYHSxYQhKYe71DHd8c3IJZaALeZvUjpMEpQqctfnLGXxm3oqXMW5VlZ3JxL67YU9jOxHtCys3cS4XL8n1Uia+y6lVLbUqUcOX5Wa4sKq98e3hHB9C3B7BNKStFy9u6VVL9LDHgitIdZ4H1ITjY/YRmJ9b7cV8zNCrIr1ZPm7VOzoFNjuN2czGzJjeSGozf6y1EX9lDF0HQ+VmlEGkvZgtOnpWpYioNuollqp2yaqsAnAk/s4hMJR1Jnu+kHCLBkinAhu2v5JlIS/8Si9J/TojM12+gfqKIwPtf8YbR3M844JVXLBq84Rx/LuDesAsxDbKQHnAOsDp1P6UCRyjpdxoaS3N/ER+l+Zg+cDz6/b4bXxi/ziZJkH3y760g6OLMZCqEXcXDwXxZSRHC2vYjLLyHYN5DS7yG2oonXN6s/wWO1ZYTv9o8qLEzenGSkeFk6+dpVdkkj9O3v0fZbxtpvkzZhqHhNHdaFnXMpSd/I3DdIsbfYZem4V/4S7FKoFuaGmmb8qWCcUhT9GrKar9sRS0RRALniI+3EHP0pF71UVj+EMjSIRGdKo6AZY5NHUyBHq0iZ2vzClgLPhEu+LfJqM+hd7qGUPLKWrsHXRtygezYMeGxzDg3m/atW49sMwVGpad5cYG0BVFmcLz08B2FjEOLvWMRwTS+JlNXNDAKZHrQhP0K2blUYyuhiLUqHdJItMZ4u4zNLYlwz+zFtjduK1nUD1a0b2ANRWkK+yRcRw3C+2fow3eVh2LMMaeEbIuADBRWuGi3V+gCMSUe91OJ6NdN8ns4lgggi2UdZ/Xtb1avUotBb2AY1LockvE8QkF+sjq92/nPfJxuv/+Nb4w4ioKtgK7Me5wIZ+ZbV9sr3jjLe0VobMYgzh4//ERN0GweXrCy/YtdexIQMHo9dPXmldKsv0kyQafJFlqqw/0yuL0KzBux8J+iWRzA2y/KLJOvdOvt7xQvf9fnxdZo8ni8ysvVOS39a2QNYrIP4XyQj1sv/Lx7X3lY4035J9ymXrD3XRXkXbyoNyS6aiw2kn2YUNp1sLjeKRSbAD/1AJw8vRfYnUAxQ== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Retrieves all role mining sessions

+ + + + + +Returns all role mining sessions that match the query parameters + +## Request + +

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 + +
    oneOf
    + +string + +
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-role.api.mdx b/docs/api/beta/get-role.api.mdx new file mode 100644 index 000000000..d7f1f84e7 --- /dev/null +++ b/docs/api/beta/get-role.api.mdx @@ -0,0 +1,141 @@ +--- +id: get-role +sidebar_label: Get a Role +hide_title: true +hide_table_of_contents: true +api: eJztPWtz4sayf2WK82ETF2DA+IGrUvcSYL2ceI0P4GzlOlvOII1gskLiaKT1ki3/99vdM6MHwl7s7Dl5FFXJGqR59Lt7enqGz5VwJSIeyzAYupXzylzE49AXlWol5nNVOb+t4FdVeV+tuEI5kVxhU2g4XUjFutdDFok4iQLFOMOWbLZmMlZs2K//HPwcdFkcfhABu5fxAltX2Wh8cdftvx1eVdl4dDmwn8NIf53cfE9PGE/iRRjJGIZTMMe/ExkJF0ZjDvd9FpvZ62wYMO66EqGqAgy56R4bb8nXLAz8dXEkJj2G37uOI5Ri11HoSUCcycDxExemlgG0FRpJHsH/SoWO5LGGahImEXTUMy95wOdiKYKY3YfRh3kUJivFQo/dL6Sz0MMUgJNIvqVYzkRUB9KveMSXIhYRMuBzRSK9VzxewKsAXsA36cJnS5XKeRwlolpRzkIseeX8cyVer7CViiMZzCsPm7wb9hEYiw2MJD7x5crHLi2n0zxrnPHTs+ZRo9PgjSZ8ajdbTQH/HzfPKg/vcWK1CgMFYgFztRoN/FOc4VKqGOdAimoBqlacMIiBJNiYr1a+dEjqDn9V2ONzGfpw9qtw4som8F0L9CpC0Y2lBgMoUkK8LLOCSTePe52RHHtS+C5bJgD0TDBfeDELEgD9fgHC5EQCIA3mjAfUB4QVukf3UoEQsHajwb7nLhsDMwT0F1EEsnwvoTeQKfHj+jb6npy2O+7p2dkR0LfNm7zdSOlrebwLMosERK0G8Ll8BmLpSrXyQbpxgA0OL/mnSxHMQYbOm62zPEQk0K3jk1OcmnAVO5CyD80yfbjnitmu1YoXRksOfK648KAWy+WGiDVazVrjqNZoTlut86PW+fFZvdlo/x9JNHdHoJpaogGeZehKYM6LAPI5sMMOUH8GXK1pq3EOoLUeh6swdxk0FB7kiNXMTQne5Fv2+lHFvIkCztAqMCeJVKLYSvg+qJNQIHcskMoHG+pIsD2fJAgy88NILPVzkUgFdGBeohwBFIlmkoGcOGj3wXjKlVQOyveSC0cEQDnoJRngomKJg8OcMC+MCR+gG3xQYPT0OEESOHoWO/GSzxHSyEnYRx5JbB36oO0yTlywocInw5gsmQjkcmNOUE65UvAuFssV9NQQu5Iv7fMwgv/qKKrhfSCibeYiI77HfVWiPuoN9dWkBu3XPeslk6IHLnNXBMkSPeOwP7iaDqc/lZ3jiMbHflsNjJBoQHJ2BiyGAuKCH3llB30FPgp8ziqJf5e9SWEEiu1iIocuMIe8rrvFbvH2ice5K0S70TzxZm3RaJ45rcbJUWd3u/XmyzaL2AOuPSZfXbDIgGu4lHGsHTJn16PJFB9ed6e9N9DFQ0JWIQTRxAZ9Nw4XtCZCh/yR+0lxoleqAMTvIrdKVisQ0coDkAPISM9IGMbCEzC/I5BQnGIMG2LkSMajiK9hQAnyr7bJ9vN9Xubri5FNAWzPA5/UOGueHjfFCXiijoe+qHnS7DQ7wnE4Av2YNmxoF7zFCSNNL2CT0a7n6kG31xtMJnfX49Hr4eXgVdkVF9F5CdeMGhdnQmXOCLPx7msKeRH+An3gg5wHIQa81ggUxazY13jvnMh18wIGokeAF3zSA+JPzdEaP0sGi5gOslFMrEz8YWolHPC8DjEUI0ECaXcj++gsoK796Ugb1xwXycxdDt7C3yIL8y92NILF2WAps8UUdk5Pj8AQHrUazbZoHoHStBod+vKUlDwdGBTnzQtNEYLe1Xc55tXbnYbwXHFcHd18N4rmvRA/TET0UTqiL1Zxtd/77s2/un3864ew6inISm5SkhSMumglohZyhThswvy0PLxDPV2BlsF4VSsFsDCKFxBspPEZSDgoOZiAecQDs4Qyrgcb63WSMQ8KVF5560yiYDZYG0mO5kK3xPWYAZpkjc3lRwDDN6uQbOTnO/nJtHvV74778Mj60rvL4WT6yIoYuzFnAQs4B2H8jTAXJK0aMkQfmJuRGBTEB0JCVMMwxKTmHkRM4T0qUnwfEnYeMAFIoN2LcM9xcW1BO4dFsIvLKUtmInFuBoDLFZ4MzCpWREtDppSS4hOyTAEiOHAB0V1Gh6UduDdjrxCBlFcyYypyQ7hboxNN0UwmcYq36QwTQyD0LXqRoqF+vnD2iQqKWcppvmwgVBKRNEPylJwM/nXTvZzAg6vR9C790htdTbvDK/wIc46nk7t3w+kb+Da46qefARb4dzQui1QX1gPp5AWjZifIU6xn6DJKuwCxPoj100HyNkNE0QqpaM6Qp6EhjwH5WRKD0wVHEyZg+eGReQI6mXcJidJCtyk0KQ9fHHRX0TmPbq6mRM2C8d+IgFLxhRiCLApKaC59k2pBJIzhUhhgZDpBXriEvaqiU7Pop8+AAHnPWsWIA0gYg0Xy1xtuPEVgGxt/EGsr8YZE692yAvkoI4VsAy7kbZaN2kYMytFoi5lBnA5XF0sufYRNUeZruNWtPi1lWWiqs2fMi8KltehBmbibKKBZi/h9UKc4j/KD0tMqjTk9TVwSyJx4bE/GtE69I07JmGNYkDbPWk0IgDvkDLMs263GL8eO949yjihDZPgRFxzPJ86EmpnlCjArxjgWafUFNYy266F1xGkeE+wCuz+MDuO8vUYDbo0HLaZofZyKBKUpfcE9FoQuzEHuQIKIS7Ocsn2xZRiQEGpLVWWZWawyaxWrLGcUNcjWLFb11Gk8bLkATtLG+Ta6WCOdJIkDai2G+kWhdXjkC1F3gGVNp+N1Ziee+78ovjLg6HedcEluZSF9F9Zoz4mFn+bh3t3s3c3e3ezdzd7d7N3NV3E3e/eydy9797J3L39C97J3J3+kO3nYzrpLAWp6VM7+lywzOh7El5xSSrINUdykEVh6xHo0zm++2J23/K5dnXXN9vBS60gk8C3ARnnITEkjkaU4q7nthJRrCoYy1T7c99dVgoFeMIcHuqwHZra+VYNnGvDAZZgSr30Eq83rTxOttSfa84nW1BssNuP78simCxpj9kvJbQeZ3cBdX/iaTxyz6BF3/PxsvzGzd73ReDy47E6Hoyv4fPV6eKE9dH4zMH0wBsswmEzvutfw6sfuZcGZw8PLYY9Gwgiq+/a6O7zIf7yDwaaDMT4ZjKfD17nGlzcT82Z0dTXoTUfju0nvzeBtdyNIqFYuRj8Oxlfdq97g7mI8urnO7VbkNy4y0NNHBnh4dDl8Pej91MO6tGl3io2uu5PJu9G4f3c9AhxwJCxbwz839Gcyyr2ajG7GPXw67V7of+8Ak8HFaPwTfZ38AHNNbi5xqvHgejSeZt9xoB+Ho0uLuWVDtzcd/qhxADh+0KhtiyuRf1bJjBdGFpOm9KcjlWkIVegZL2KF6iq8B7nyIg7ykDhxEolHiigy2e/H4VS7z9K+6h9VZvG0tdphR9oCVUR+ugiXXLEB9NAxOPclV1cvAuJGQby6bcrCjHFdmMkeHtsSSvt90UrbRdKmjQCUZgLNpPgEBlNBPEtxSiGayPYNq7r+wEZjBfNTNorlrSuE0xdz7qxzOARe+PzFTLFMIAhjYGUEHcGG61o3Yi+abXg9FwFoBe4cQvgPjfRGK9j6A5zkgKpnwbCvWYReRAYq5mByAVsVLvVKUlEJzoIDeWbCVmDAMEAxrBjb3MVE/Us9EwVYOHAQMj8M5sD7jW3MOnu3wAIGILuy81GVhorxXyyexVAKgj21CBNAGUBfynmUVt3alS+4rKJLKINTqLAQn6SCdZEH/UDxqS6QvCNbJdEqVOj4KB7jkuZRCQTxemKMLfPSmvKvuJeJepL63OucD0qLL5BPeUsxCwF9HmzbUE+XeXbv3PRGtEECCvBYmfF44semBM7E/RCDa7l6/pwYJ8x0fWXMo3m+pMOW+qhdwNBdTFlOLww8Od+2i7th3wvz0GaznCfG2iMLc1V8lfIWcDECgHCZVrLjdCH0LGrYuqbIWjCsauYyQG3QM+pIDib9CJEQs9OxX+GpifZz45RJVibFBgnBJknu916OBor1CuGDz9thJVsH83wFaPVM3J9gdffWkHBL4bh+NLOzA7lXigI/GqwM1I7lchbr6ReCwNG7K4q63navuhf0qRRelWKQvgbZlHvIwJVA0oRTSRvV/9vlJjPF8xLNNApvyg7uE6Z1RmtsZQ4ZmFoQRccpDg4ItoODczbKSlgLGQ9UV93UgI+N39KBhGjT64Jt/7BBTd11E18co8sukHgBegh2gShV9WD97GQDoJd5z5muZTk4sHQfugcH2v4W3H2JuKnYYJcXJGLSCv802WeHq+oMHq14SMjzIoHQb4mjM0DbJ85p56zZqfGTjldrd3irNhPOrNaEqO20ycXJiXNSLMMrCP/rMKKq7odCuGDtMqzn43XaBA32x1CfkNjBWhqlwxfl5KcdZzcDWv8LW1BT7/1XMaG7gvsftaGb0rE3p3tz+lc2pyjPJWOqxHzXMufszNzTZLEn3IZ9SjLYGSibzIN1Nb8lAZSwkTuIlpwH+jxSSorbinc6a87O+FHt2BNure257Rp3W53amSkvPhXNDvRodZzZidM4qTVdflZrHwleO5uJdm121Gwde632mdfilfebeX5KGNgDMxtJfiQfNG9vO8TX8yUm3wdUPF9jYzromaU1rTuZhS4d0pQB8EYSZi8+6le0MK4AxwB22t1hx+E1rPJrsECjKldd7+9AR2OZabEaRnjUCoe0Er0l3Q6UqDcLhwd6BhkUs4g7qOLb9Wgj1xHQ4SnbBc82aVe7dVpxKvjspNFptb2TNuets3bz9HjW8fjRUaNz3KHED9h+BXbnyw7gApf9oKdU7C1/A4LAql0ZX0+T727laYwd6I9bdbptiqaBl8XiU4xnc7/vXbP2KfN5ME/oOZ9vECGo3Uy2pdT0wKNIzuWT29b9weuuzTCatCaOtS1jKPU+akhWfBHeE8QGATw9qBMImKI4MKMeAEI8UPmGUn9Ta/A0S2YcN/Qws2/pkR9a7xDmVYn05lPMvpF1Ua/Cijs9wjTjKquuPsAV8SquXRpKHrCF4K6Ivs0n+vXmm7JHqLibO8TsJZjkpFRomMSYQ5DORs4zI2WpxNqYj8s8U1A5APIvy0nXidGPE5p5LUylxYBo+AMwa8ptJiUzohFJ1xBDOoAFJbucMMKUGJsBbngY3Zgj8qdgeALbLrVYhfMQCM1bDUw/DumdwxO1g95d+2B+aoRa+uKjMMpHBQg2TsxyQ9YimeQjdTatUnZZxU+9/V5397q7191ddHfz5dhcXWDeUujTLIc+N4G5LwKdZyn0iYTOvdtLJX7TKyjNSKoEMCHSP99NzY0UmLT9tKIagK8XH2lXXgK+m/JjYxFoXX/GCwSQ6GhyAWCJhHtOcGcQE6E0qY7Ks73Gc+AgoMGWEDHB/Z51mNDiK0oCWuRzCJLdUKjgVaw3FkwemSwgJbfd2iqUQbyPJPeR5N4b7b3R38cb7SPJve7udfevqbtPRpIpVKQtJk5SyXLJo7WWNPNen7uGBjZxLbKN64+2tjYfreBgLI2xKsXIoTJrNWdN79QRbZe33ZOjjtdyTlr8+LR52py1W6eVvK+/zfQ4VbKiTuX4rflIJIYgDjc6kgCES8Vh6BbTf0DeSHho1qhWz8bNQHMg6fs0dmx1yrHjNAwxmb62EZIqxJBBRiO0adB2iW1tvYG+AEaf9AdTJUOdqJZLAaNgiQjz5VKS8iIWMG60rnU93HnSimKFLJ3F3PWmyBJgxQolcbnEwkwPYz4YgSLYOVjnrxidGhb9rkiejRHjS8SYDT45QqCip5H78bb87hCAj9BGTDSDH0n06tUOD0AA0iqiNO7cx+f7+Hzv4/c+/u/h4/fx+V5397r719TdZ8TnJhp6PD6HBjvH59C23mBpLPWaanf+22E6qYqBgMSbhQ7deOhmMTjVQcBDLJvHSbAYv6dFuZvgxbC3FekG51goX0sCCNycD8I9xxMDaIfKb/Qtx/l3X35Do73HO4SXAqTa3DiN5gyvNz6vHGJrdfhZug8VBBfjUk2SJPLh/SKOV+r88PAzSApIyEOdr2TdHmYNwns8DXc4A/ZssXxYoqC1HBvQnc96gjrxNqLKeW1raXDNaVOLVVHAccpKPzmyPduwDhOwrjRMFU8NGFGmxwDiCtYxr5S52Q05U8IP8LqJ/Iffj4se6BFctpHvydmgPQNIN1BEFN5n0pWrUyvJWObIcKHYKk02wmYt9r3gEdYL0t7JN/98N/3WnGXIzh6Y2+E4uwYRIVPatfsIH/QhtngRhclcnwnuFnZqUHWZ5wPC7OdgIgS7zR8FGoNTIJJiJ0F2CHu9/8Zyx8XDbuh+6xklUfBA3A+BQoe80O9bcrW0JsmdNaj/HNRYn45uSAwZsI1BUV+geLuyePEcXi8F4h92tJoerUajqW83oNCkvXV05Y8D9gOH4L4iar14cj1eLTdejS7+q+GomzAgJQwcxf01x3LtxXAUxqvheEU4fg7e6fPahW5M2yp7BmXInEUYKvE/jKHooBrczhPQoheDRXViNdKIWquRA6mmp6zJGkSlBN8lKEaghYnPMCqgoCiEeDFwtUr+QpwFnf+FTgH9UsCZHt+C88aWbuioF8OME9Zwwpq2AcrAr30jChboNuKga4ZJAHoZ/8kSGEBzdk+PtdWq0/CH1AddgwOg0ihqda6/nGcGznxi9AJbp23ADGNQn+444gX1Zix0kAVi2XTEJgXL8Poh+OUNuml403QY+uo/G76IcTfL2uD1k1/bSj9iSf48dvcPsnh7S/N3tDQmzJb2ZKdZj+SF/HsTr5WziMqeg4S3pKsU0cN6Sf+oSL7SHAda+TxGqSatdhZSUP5hJTgd8quiZIVL0sRVFKL6218nmdMRzghA5r4plaYMuZ1ZHwXVgSXyVV8woE9m4O+vLGA9K+rsHSwJAwfYgstBrPGAd7+GZl04Ac5cI2NZ3zKb4XmLJMA6eQA7WTIOIvUFiXClchJtuGB1GAhLC7o5gaW9rBajqCEKdIYFb7kdeeYa5BzjvzAX8N3+WAmQno7b6J9cyRAZC58kE9sVw/YvjQ3SVlsIf0XHgQEsWF7mZng7nJZGhMECfSdNPYzmh6aTOsS2MAguj7T4HNWb9UaNlgt4xU6oYliF5Qa/ELG5fXhT8j5nSfz9r/r8B3/Vx7hUXAsdrjB/iIxK9NpML39vK5H5rZxz6WKl/gLYiI8/f8bMEi4IH/DxvxOBaYvb99laj9bIIGbmVPG2X77I8/kbe+jpW1b6MaCtcNpsaLDOEiGVirmQC688eHgPrXSCi2DRL3QKLNeltElUyAVcDFAD+CMxiPkAeIOV/X/qv+lG +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

+ +List of all Roles + +
Schema
    owner objectrequired
    + +The owner of this object. + +
    accessProfiles object[]nullable
  • Array [
  • ]
    • entitlements object[]
  • Array [
  • ]
    • membership objectnullable
    + +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 objectnullable
    + +Defines STANDARD type Role membership + +
    key objectnullable
    + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
    children object[]nullable
    + +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. + +
  • Array [
    • key objectnullable
    + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
    children object[]nullable
    + +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. + +
  • Array [
    • key objectnullable
    + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
  • ]
  • ]
    • identities object[]nullable
    + +Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST. + +
  • Array [
  • ]
    • legacyMembershipInfo objectnullable
    + +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 objectnullable
    + +Access request configuration for this object + +
    approvalSchemes object[]
    + +List describing the steps in approving the request + +
  • Array [
  • ]
    • revocationRequestConfig objectnullable
    + +Revocation request configuration for this object. + +
    approvalSchemes object[]
    + +List describing the steps in approving the revocation request + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-saved-potential-roles.api.mdx b/docs/api/beta/get-saved-potential-roles.api.mdx new file mode 100644 index 000000000..e5b5833c5 --- /dev/null +++ b/docs/api/beta/get-saved-potential-roles.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-saved-potential-roles +sidebar_label: Retrieves all saved potential roles +hide_title: true +hide_table_of_contents: true +api: eJztW+tv3DYS/1cI3YcmC2tffsUGDoeN4xRb2LXPj8uhroFyJe4uE4lUSSr21vD/fjNDSvv0o07Qa9r9kqwlcjjv+Q1F3kW6EIY7qVU/jfajkXDn/LNIT7UTykmenelM2Ggjcnxko/2rqN/rM3zGjqWSahRdb0SpsImRBdIAChdjaVku3FinzAhXGmUZzzJmkSwrKrrMIGH2KjV86Pwfr5uwjhVJaaSbwFp30aUV5kArJ25dr3RjeHZ9DwsW3HBYQRhLoyQu+2spzATmK3gDf1pt6P1GZMSvpTQChBvyzApYwU0yHDLUJof34rbIdAoPnCnxbTIWOY/27yI3KYiSMyjnBo3nDp4kOs95bAWy4YDw/aIKzmFxkN2WmbOstDCdubFg1nGVcpMyO1GO3zI/aQBakYpd/WeT9U777LwadKCzTCRIkZ3W8l6/GjtX2P1WKxWfRYa2a1ous0JL5ZrAWEumqsUL2aoWi5OaTjzVW+s1QyaRM7CWLYsC9ZUykJFYHcIkfYOvh1Jkqd1njUauUwl/pY0GaY3nBamxegxqWG0KPRxa4aJFJZ3QYxDdab9kCU7ilcbgRZNd2hL8ZsJsIRJagd1IN2aNTObSNRhMK/hIKjABzDe6HI2JTtB782d1LsQfrNbXpMBcGwFyeX+BAc1VXlgrsL3C52BVMRJm1ung0WYXHuQQdnmZ07xUDDnICr/vH1I+KWtJ98fgfarMB8IwPaw9FTTqA/ab0V13+wu0l/Nb/5uo1LqEvx7UZqJLtazN/pA1MHk0mHTgo+DGhS7KzDumYI3/xhfa8Sw+wNkNVHehlRVsLHgKFiCvxoErLDLmQFGXWcoGIhgH08WwjgLQKGv4CGuwG4HKGynQYQo2BCtKleA8EMNSsHMwMrDCSBCWcMXGkJbhMViNlIXjZV7wxG2gNJAcjMB8J1QKCyvt0EuswFUbROSfJHkDeSJuP/OsFF4LOBrYLm3FzTfhUw+UgYGGEsVVNOMpNPMeC1JlUosTuu02/rdQEsokEQJ02GRnVVFkmbQOzT1TA4lhTr9ZThUWtG1t4DrBWggeCOR5UWQyIXlaHy2ucbfMNDeGo/tKJ3I781wPPoKu4EVhULdOes7nWF4ugPMSvauZZrMvZkvDKZgA7Hoz1izYEWqNHrobbgRWTZkiFnCTfmqfwXTgY6naXkDoVJoMFGVQpEMs8oAuazavom6y13nT3mvv7nT4NudJu7O70+1sJ1s7fKebbr+B0SuGdLvtesxWN7oGxmjxTEC0uK8n0wxRkO8Fgr3hIM7W7naHk2DDzl66s7MN7Ke1YKuG7CYwRHi5bpOsBOc9nLKySrpHZAgEFoVpPqqTGUnau7w92BKYwzub+IO3ibMafTwG2FJIxbGTkMIXeTziwF9Fg+G4OQfutrvtuL0Xd3YuOm/2t/b2N7vNznb7J2TOl4SnouRHGIUKwPw+DfO5RQhvs7Njdu5tyGLW3m112riIJ76YTM6WDc9o5BzZ08ODfu+o/9Phu2hjiUuhsPJdLYw6ODk+PvkRMT1ZKSzlkT7+ukAq9/erXgfmKSvg03dOw8h7HLy1KiEeZBJ94NAYcOc4JEVf2zyKo5rFBjqdYBWSCgqLTF+SBB9Mdg4qygFB/6es+F4qEY8Ml8ihIJYTmMiA4meZohmoxniSlblp3FxAoiaaHfaWg7mDfAdBGNSp4cknoNVf6czzDF0qCfNZNQVCqYbuK5YVu4IPdtp73a3hzhbn3Tdbnd3twd6Qb26297b39nD1HOzHR+LpsP5eKGFkwjKdgEV+E9jlcUzzyAAt/vyCQzSeoX9KJTS2FjPwy7A33ICK+fbglG3tsoyrUUnP+WhBCSq+PEcoB30GH1SVHiT3hE+MHMmVZa8KlXeH73uXRxfw5Ozw35eH5/ALaS01wD0F3pqiW2oCc2N9QxwHAW44FEGBWAXBQCNQbYBAXNnZgdL/ZScWlMkC6oAZYfUVM2ZJs6HR+VwoJb6RZq9kUzQ3AJlh6uMuGbMBB4jGMIkgXO0BUilcfBQ02Qg49XWT9dJUopAAIAnmQZ/PJwjxeJr6LtY3chDKgmCtLh2iQJmIeVtMVTlvjWliOZo1CgYHcP60n/QSBz0j+cRcFNbeElgM9gGevebmubuYURqpFNt1gJYJtaOJNgCJITOBbBIwekhH1EdD4lHVuDpjzeZLSnfHnhmfISGf8dI+I+5OM0g/MYlWv/gsQvBR8+azEVmjMlPISKHFpslhVG2uKvB9p7+O3XXsrmP3mbG7+PIstIEV9kHo01mGPpeKl6BfQ8VzCfoY8h6lWTWI4E0w5AYDhQSI9MOHCwjsT0LheHFbYDv7FfGRL+VLzPdqe4Tty2p3syr9U1sgg6RHL8EQMpFI94nvKcceJJKqNpdXe6/NQIKDqhUQEbKmYRNdMugmmSkVwWFuN1iqhVXfubC1ARFhrc+AuKpKY7+LsEaSayS5rkbravSXqUZrJLmO3XXsfpux+yiSrLmiaAk4yZZ5zs3Ee1p4j9JyBgOm35jqkCNTLaIVJMZqjBXNI4do0O0MOsPdRGylfCvd2dwbdpOdLt/e7ex2Blvd3Wi21l9N47gOsvmYmrG3tyOpGEDcZ8BxpQLnsk7rdH77r8QP6UNMa5h6atwMOgeVXtfYsbu3jB0vtGbHXE0qhGTnMKSa6ghzGozNcaypxsIAzkaQFxV+G5PAF7qSzAVQwc/+jD7AYfCiFEDXTOLe0IEo4bNecLJ6FaloC9xSJsg0omYNjiXxG9kQMR9QIAQ7guz8FdFpMNEXIXl2hhIfocTs8NZ/yGI1ct9etb/bB+YN5ohzb+AHNnp9t8MVOAA0BD5n1bhzjc/X+Hxd49c1/q9R49f4fB2769j9NmP3d+DzgIYexucw4Nn4HMY226zGUu/p4NEfDdMpVAIH5N5MJ0lpaLu5wuCEK/DMb0RniDGHcDywG7XwvEPsDyvE9enfmA47tehMcISHfhEjevZKk8G06vzXHUwAa903eSGb1XkhpW/oENgAVLUiC+FxAR9xOICOm/kFmqRnI9GVfd4j4l7r4VBXVJ8ze5SyCuc6JrqETEdkNvAMRnAregwsFtBTfGdpdJPcaEk+kOvSZPdfLosn9IAsq9T36GowngGnCyKiCNfTM9rnCMD96ksntadFBZu27tJiJzisy94KbqA78N8xXv3w4eI1GyHspLD3R6eFxD4BAscfJwMn7FV7+jiJKs30+G9v7qsJhhEbZiAwC+cP+0EJP0K+P4METSrFSYJyAs56/ulDPjfvgdOGP6uYvZPGH070x7eCiP5E5lVRycVn5HopE/+oqMWeWkzU7OsFLrxqrxJ/CieBWPaBaUlbL17c04tn6GEzBU+Q6iIPqInAx/y3rqSy2ov5mKMXI715Pn5WH8YSaur8tOragh3Tkds+S8ZaW/EvxtB1MAyuRiVE0YvZusFFY4qIuNueYSn2S8YyBoRI/B1BYCjvTHyAFZoAigbsplIfkr+QZSHmf6FTwL/MyUyPr6CQ4shUJ7/jSO0Cz7hgjAvGPgfYwL+vU+hYeNQOZKA84B3gYGp/ygSB0Zm852mtzOpEvkVzsDQkwCpRscW+/2N/muDCL0YvcHQ9BtIwAuz66x9dQfG0sFjNKavaGljU4DK/mYYauaA3z2+9NYV1888mL0rcm+6gnKhs8rWz9AOZ5M+Td/9PGW+daf6KmSZAXnQ3Wjb0BrNO/jbgteUdPUv3QuBfeEuxSugaepfpVZBZQkXGHXo1RXUyloL2AgrBHWK/DfQsnVMkQtuO4Q8dHxEaGRgDYWsBk/KBzIAe7VZXK3MKGA8s0a74ty2pIcG1kjH0lqLJPkB7phIwC7ZmeN4C3n3UoUc7B8ucomHZu8rYALryvFSwGsZlmTMOLvWER6TSJqVPXNCpKVHpQhP0q2dVUYyuhiI0qUkxuT0Z4jYzdLAzhn9iLbC7DXvMoHq0YrjkMxXkTGTkmThuHrY/RRu8LR6LrMDmELIuADAxs8Jx/2KJIhBTFuSCJlybUStMsi0cC0SwPfLus9nsNNsxtQvwvNDWQTs7Qxw/RaCPPHLrctEl76Y77V96fTOUE+wDWgXuYyGTpe9LfEd4FT3SEWIYUk8IXcYYRMPhd3e484FN0j0+9leysFMEZWMETO/wPCjU3+BC5krFfxK4ATG9Cxs2GSK6q/l89f29rmo+osn6KusLFflt3bt8RBHVtdIX6mF9Y/LbuzH5iDdU12Kn3nA93ZyiS/uQzcl0lLf9JL+BPTNr6RMvUqk3Fb8/xJrJH+hawg9c6v7+f4bvt38= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 saved potential roles' (get-saved-potential-roles)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Retrieves all saved potential roles

+ + + + + +This method returns all saved potential roles (draft roles). + +## Request + +

Query Parameters

+ +Succeeded. Returns a list of draft 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-search-attribute-config.api.mdx b/docs/api/beta/get-search-attribute-config.api.mdx new file mode 100644 index 000000000..702538eed --- /dev/null +++ b/docs/api/beta/get-search-attribute-config.api.mdx @@ -0,0 +1,72 @@ +--- +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: eJztWm1TGzkS/isq34dNUoxtDIHAlyuHkBRbhOR4qXwg1EWekW0lY8mRNBAvxX+/p1sz4xkMGy6butvd4kuCNa3W06/qlnTdsXPlZNDWHGSd3c5EhRMlXTodhuD0qAhqz5qxnnTWOkFOfGf3vBO/i5pARIoiculcrHUy5VOn5/xzt3M61V4M3x8IpzBDXSovpMi1D8KOhay49OR8nuuUeQjpvU21DCBNC+eUCflCpOUyKhPaiIMMozosjuxV96MZimC/KCOudJiKd8dv/j189fbgSMgiTK0DlQAEp74WmmYHK1KZ5yKUwLoQzik/t8YrSHjdGfT79F9bjMPbiGtAjNnfBgWmIAgYIF4N6XqfPTG87vh0qmaS/gqLucIS0jm5wDwd1Mw3xu3os0oDPswdWSvoCNPImWpQeeAyZKg27iNQEe4wVcKoqyV+UKpvcjbPaTK+vJU6r43auQEf7ee5XBw9aJlTsC8nCPOgJY/whdYUrUUbiqrH79RFe/m3cs7GaTiRzoQ0GYHQbulR2RJNtwkHVk931l/0X4y2d8bZYHMw6K9vy/5o43m20R9v7Gy9wCoKtHah1FExGymH6ffM2er3X9Cc0eqcmxsICR9hFdwdajc3TLTZX1/1wjNT+vRvkCQRxyoUzlBEsLadIkc3tnL836Impkpmyq0J60o68euH0zJiQK++zSkufsRj7/FM5Zx1q+CHYqa8lxN4Co+P4EgMJ9I3nYMAXspcZ1GCMfxEZbuMe4k4aopVtbG62mvrRjpDRK7qSRReObGwhZBQmSuMISTSr4nMKm9+CWIqL5WQaQq8lC84VSiTJXOrTfiJmspUgGh7NntAiL3WRiUTJzUJwipDCsqUAMdLnZEEM+tIt8Syij+ma3k6tNXvrouXMoNavhYKaW2vFIZc08n0C3jRbvA9QGdGY76oplDEjQHqnmXVtpKjrf7OYHO8tSnl4MXm+vbz0c5Ybmz0d57v7NDqpX/4O5Jie+k3yiinU5FbpHIOBqekJ08BgMqdHphHmccDU1ykrcWs/Dmob2EN29rLvfdic1vk0kwKHpeTW0owydkJRkyR53JEQ8EVCpJHxu+cnmhzFxRlihntvq/2Xw/PDk8xcrz/r7P9E/xFvFZ23SFC22TkloAKX5jaK0ZcCnAlvfAqhzoQ+OJZyfUZBJLYyhqEOv7yCw9lwrfGssgDZpSr3zGjyVqMnZ3xR1e6GsfNtyCe6K7qrokRjc1kQEExkh4TYEIifzZE7M1Dclhq8lmZxJ52xTDLNAkpc8oQYIr5CzASEsHOtQExGBeIeMUFgS0CcmLQaTvjN1TZtsYyPx82jULBAeTf95NhGgqAYzGbUVh7SwmxtA8wR8210Z02lMYqXZggU0iB0oWKIZRFaRDYNoQOXpTpiMzlkXhMRacNZ9Fup7nt7BOatxHMq2D5WyoL/4C4e58j/SQsWv3hUpXBx6kyZiO2RmWmMiNxHo2xUlHV5qoCX4y1yrPH2H2M3cfYfWDs3v54XLYy/LVGxdFS1km+mM2kW0RPK79z9SxAIKpWSNQhx6a6Xa0QM1HXWJ125dAZDdZH6+PtVG1mcjPb2tgZD9KtgXy+vb69PtocbHeae/35Mo7rIGvHVMPe0Y6sYhRxl6jjCgPn8sHarOWtpF6nxpTWKPXUdTN0DpVe1LXjYGe1djy1Fr2JWVQVkm/VkGapI8ppoJ0RratoQSDFBHnRCKQqDVzkShpNUSLQLSLa9Exz8JIU4OsWyXAcIEoMlMrJ6lW0SfMCCDkT5JaqZgvH0hBSjanmAweuYCfIzj+xOi1N9IcqeXFMEh+SxGL/W6oUBXpduT+/q9U+AHhHOeIkGpjd+r5uRxo4ABqCmLPquvOxPn+szx/3+Mc9/u+xxz/W54+x+xi7f83Y/S/q87Iaur8+B8GD63PQdvuirqVek3P9z8t0DpUSAbu3sClf6WTLGpzrCrhSef9EOUSGKX70ZJrawgTf83xQntRH90la3UrFHiCiK1yOWdMQ5n6317uG0WCsm66c664ub2aMveqmdtYbQVN3JCGYuAxKIuBbq7hAl9XsNHlyTHvMPCqdBSOfhfL5gPh3OVe3IwtbINExmzUBry+9iocBcY6W4hfP1F32ohX5INeZy2/+uCyR0T2y3KW+310N9AJIb4lIIlyQuWB9MGJ7nQHPXsxZw4Isfn7RpDmhGj0iXKFc7jvU1w1WAL0jsoF4Cb9BAxGvOp78+uH0qZhQZcqZofBUFCtNrQRi6z3ciDPfsDr2p0m8GTlbTKYs3LB1sUKRJsY5lCI+mhOlxHnjBlAcI4ez2mmS4rRBsy6eVBbM1KXKabfsLrVNzqkz04MWe7I17ynvjNxCaIM/Zzza/WgS8UpTwuJbSKIpReSOUJzPK7lkQ64fBfGPilsSuSXMzT+9hSKq9jzNNSXOFOFOLGTuWVs/vHjklzT4Ub+FEeJ6GwNposTRvg5LK6v9MI4Wv4T4tXF8NB+mGttue5qIWU547Jp5Jg5EOrXWq38KQa5DoXI+KRBpPwzrihZNOCKSQb8BKYlLJjpBEcn4DhEYJjqTHNEmzjWMRXlnshi2n9iyyAuf+Br1U0tmHj7HXkuUmU39D2OmBRNaMIl5wpf441ZGjoXYJhk4D0QH2FvanzNBCbSRGyOvOzM/s+/xHNo+UkBlLn6+G3/sLpNg+ZfgD0Rd0yBVUw1eXxDSe4KSF+1nLWVVpwe3NbiKN7fYRm/pLeKtT69oa/2zyUsSD5eHLO9MvvjZWfqeTPLnybv/p4z3mGn+jpmmrIrJ3XjZsn1oOvnLsqZbPfSjU+mpwr/4yrHKBTjam/g6iqqYJqN5LgN5NUd1OqUHWmgx5koGqg/XyLPsjCMRnT2FP5pCZjRxoEHYetStcqRz8OMD7WplyQETi0+yK/32Bfcs/ARrivZTdcUHdHAGZb6j7o2eZODbZ1u2cSewzHsyrHhVGRtF12xWGHrUBdjFTEi41Hc8ItM+LWLiQuNgVKULy6VfPauKYnI1EqHLfYyb+XdjOolGk9sw/HfWgt19eQwN1S+fa3WWghyrPD4dA127tP8eb3hbMlX5nPpHZF0UYKqxwtuD0xWOYGY85EKfbt2kV07yPaIFE2qhovtsdNe7/YRbCozPrQ/oeBvMj8tHfI03fCjKlaHjgdilLR9Y3fUmruWs18tj+r/GM8FyO6M+pDenozZSUhF7p9i0nneqppWb07vbVjQ5U2iWqK+v6WyG+rgbGv5aKGr8zy+WLRq3RZjAZzTcN31RfDbApzjL9n/1noOaqbqzfrMPS9/8B7L7xZ0= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +
+ +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-segment.api.mdx b/docs/api/beta/get-segment.api.mdx new file mode 100644 index 000000000..c2e324345 --- /dev/null +++ b/docs/api/beta/get-segment.api.mdx @@ -0,0 +1,104 @@ +--- +id: get-segment +sidebar_label: Get Segment by ID +hide_title: true +hide_table_of_contents: true +api: eJztXOtz2zYS/1cwug95jClLsvz8cqPYTk4dx/bZ8mXuHM8VJEEJLUWwAGhb9fh/v90FSJGW/EiaXtuMOp1WJheLfe8PEKC7lsqF5laqbBi39lpjYc/FeCoy21prWT42rb3Lln9iWldrrViYSMscBwD5aCING5wOmRa20JlhdiKYceTM5CKSiRQxC2f0YiyvRcaGB+3P2YBZ9TP8cSPthJ2cffjv4ODj8JgpTdx4YSdKSztjwF6LXwqpgYtVLOJpCqzcpG0QMeeaT4UVGgW9a0kUKud2Aq8yeAF/yRg+m2gipry1d9eysxyfGqtlNm7dr7VK9q09qwuxqOBcn+EBigCaaimuBc4ubvk0T5GfSDZ2kt3+Rn9b7PY3t3rhZhju9Ht9vrm1sbsd77Tur3Aqk6vMCIOC9Dod/F9zurntI5VZ/AQkPM9TGZGP1n8ySHe3qJAKfxIRDsw1etRKNwtov6D0Ezq+MuiehmadpNtNerwfbEe7/aAfJhsB74VxsN3vbe50ErERxgLt6Mz9ZXOFhZGZMIbh4Oa0nii4nf2K3CMtuBVLlUmUnnIwVCsGisBKEGPZrPiC3Uwg5uoxCpHkWTen73V6naDThX9Hnc4e/dvu0D//QXGmKqbI/j3kKXl/kUAN/l/mBEWPecpqRM25KctLCbXIIY6xHDDvG3WTCb0sFLMiTXmILB5LLRrKVOJy2g1sLwSx47uolciKKdan4cHh8Wg4+vdifToh/jiuzUgLMGwas2lhLAsFE1B94H0qEstQWKw/RlhM81cl01dMZUxmeWHXmELyG2kE46zf6bB3PGZnUD8EsBNaw+gbCVzAPkVqmzasZASDvSQphzGYmCpg3IyDaLe70+H9rYTzWIh+p7uVhH3R6e5EvQ7Umpen4j+KKc8CCP4YfcRiafKUzygVnUe8e9psaNkU3oDBGpZSU2khccA4YI7Tk/MRPjwdjPb/AUMSNOQak9YZGzIimhDPqNAa4+iap0VzIojFuhC/ydymyHOlbesezAFmpGcUDGciETB/JKqmBhTX0shQpmDufeg6QssXVFZxi3lgmgn3CK3rsUo/75QTT8mgipBlatPMA35wfAB/Hf7zYnB0jkE/19s/A524hRnCwr4gEo7R5eWE83F1vqlyDYishZ57XunHsnZJKQQKjIRqahccDQHOR2fD4w/Lpn+C8VMMBxCWABfqAfIvIsJuM5FpDFFSm4VrzWcLkxxJCEWQfO4lAzQQQlPzXRuoorq8qr8/nAdrY9hiemGARhbwYE3OUKlU8GyJoFC4/UsoNjFiIWGwd1L1ftjOXX1JZ8xNALUoc59KKsMmHP7KFBNJ4htOLBIORaS1l/DUiJqC2LnqupQI7f4en/aXgbj9VKIsh1ShAqhYCI2xTrpap30FC1VM+FZmYHtJ7f4bgb5YWC7TfRW/IAreAwALxppLlNAV1QgGMuB4LWMYAXhEQ3cglmW5JrpmwQVLtLuNCr3vlUHjaR79DLyGL2h8F5mE8awcAv1vXgsXpxXbgodbnd1eP9nqc97b6Xe3N8PdhG9sdHY3d6kdTiEk+biec49k8wcBDUJGDItdKn8Fg0B3BNuTADT5y5ObeLwwCx1tpaaXl1lxCx2Us3f7p6y/zVKejQt6zscPjJAFF+cLeAs0d4xPtBzLpbCw7CcHh+8HF0cjeHIGDeTwHD4hrwU4NajyTxFqm6gbktgrcMMRJqZgDkCv7K3n+hYU4n5p6AmlXyjODBiT+dyDEX72JSPqrFmi1bSRSpQ3t5a9lm3RXgOgUiGOkBsYoBzIfjuIIpHb4Mhb8i2bAPoR+k2bDeJYehhMldCUiIfHsYM4yCApIJUFLVpVAUBIWRk9WLfMTfkQ/ZYV5KjuFEwOkPz5OBlEtgDhSM16FlbR4kUs62PsLfcQyc+NRiadZRaLI66rZ2BGKJ0RVCbQTUKZ9OWIEfoHsFjSVRWrUftRmo9OmAOr6F3EC/OCvDtNofwEpFr14lr45DOIxl01Im/IarVCFQleoto02FNV7ioT36H+Ve6ucneVuy/M3Ycvz/zWlX9L0Ke7CH0uMr91h81zAfpoih7AXSURwRvvyDVcPXqI9MOnkd8fBHrA1rg/9w3xkWvlC8IPKn+45yHCj8pZDV+ggGRHp0EClUjEeyT3XGIylDPVxuJs75UOJQRotgQiQtXUbKYKxsFkusgylISbNRYrYbJX1gFYDhlhjKuAOGsWB7mSmV0hyRWSXHWjVTf6frrRCkmucneVu3/N3H0SSVZSUbZ4nGSK6ZTrmYs0/552PxkQsPJLVFalXLXfWUcryIxVGKvVRA6tsNcNu8l2JPox78dbG7tJL9rq8c3t7nY37Pe2W/VefznP4yrJmjlV87fzo/+KTV8DjisyCC5jlYqb238FfpeWYFnD0lPhZrA5mPRqjh37i9jxWFnQDRgDdtSPbC9enB0hf5ia2KPdVKEjQd/ckOmAnFuClBjDYGlpvuE3zyvouIKOq/azaj8r6LiCjqvcXeXu7w0d+89Bx/4XQMc+Q4iVIMT6I6FjDLgDoVkCTgEdyqMz1REsv/vo095yPRa2AnoNFNnbXUSRI6XYR57NSrBkGjuR2dxcWN6Adoq0uqSlUz/uRCdULQnoFqMKD7UBJoX4YamcSspjVAj46lkwSCxo5XKmjLdqFplFaQESUlFIFe69KogxiSe1EoR/wIH2QcdQqL/hHqf31m/aD2ZnqPERaswObyMhMOer/d/NZacEhiC8xnJx7nz9yHEBt2fOM1hGiNvcla8Kgq6g+gqqr9r9qt1/H+1+BdVXubvK3b9m7n4BVPdo6HGoDgQvhuqbeA2CVVjqPR3i/H8jdkoVLwGFN1MRYfV4jsEJV0Ao+UtWWEPwmtJea708lbp+J+N7eO6wvxOl0CmQTKzNzd76+h14CDxz3+a5bEt/QSBTN+1ITddDMMuSioMHTF12IQHdrnITtMmmWmLYuhpHzJ2F/WHYlgFL05mCJzmXVwZmsO5gjs0anln2IUSPQcQc1g+vyrs+aJEF/UCvC53e/3ZdHKNHdFlmvidnA3oGkj5QEVW4QneBq4ER+esC5Nl3BWpQoHsvr+o05wjInYQLlPMmg18F9BYEOkGyHnsnuMZDz3Q65vUPn0Zv2BhhKJUBvE41Lm+1cHYKYURlblCeFMFB1Hm0KsbuPsagcRYH04olKRiFfc7OhWCX5UWUY6j/Z1Cwyew4SFCNwFFXr0sPxuJapNga23NrY3DKOFsHK67zxrg31AZpvSAzd20K7x59zgJ2ILE64Xl6ovEq0vKPXealXrym19cK8beSW+C4BcTNvHkghTPtZeTOdkeQ28iCp4as9dWTO35BjR8uruAJcn0oA1rCy9E8QRWVXvtqORr8AuTXlONz9mkiocc2hzFX0piBFpnGbMiiiVJG/J0xDB1MlctxAZn21WLd4KQBZUTQ69RECtyUgQwAMZJ8R5AYmQsmHmLHJsCi3N4Jpe2P5FmoCz/CejpmPzZ0pseX0FiRMlaR+WqZccIAJwxcnTBefte3MLAgt1EHqgMuAPbn/qdK4AWt1UbHa2nlJ/brNAbbRwSiEheT77k/9uZF0H9i9AKpKxoo1Qi4qzNleNPW88Lm1TBWuVXw0IKL8qYKeuYDuzl5qy88sY/+2fRFjQfzHZWTLJ196yr9SCX589TdP6jirSrN91hpPATGcKNp/VqhHuTvPKZb3OHDLeiJgP/CW8pVQtuwlnE/H4Aops4oT7nFqKasjiZ4WR+3zAW3iA/XMLLUlDIRlvGY/niZDBmN6Sa4BpE5rObowhrtXpczc0oYBz7Rr/i3KfxZCgUhCWtN0WafYLmWReAWXKrhKV5495Pya7Zz8MwpOpYdlM4G0DWdFhle9gWxiynjEFLPREQsTVS4wgUrt0yUtqArs6waVWYxhhqq0KZFi56akwS3nWFFW3P8M3OB343fcwbToxf9LyzMFTkTKUUm0jWh/XO8IdqCiUhzXCxC1QUAJmozfByOFjgCs8x/0aH0eN0PMutIi5cgQXkXPhvtbrsT0JICnufKWFje1ph/EJb5W334QxXDg4cBeDffZ//jf/DCtx9cN6znuA+GShVureNWlJflbyegF/ZkjBeEJ6A1vrm7w00SXGPd4+NfCoEr8Mur+fKJljHgFfwcV9chH7XH6zMv7Bs2mjz1UxlL5S53+bLZfIHfgo8/C9wXANFh9QzC08YNCeZeuK2d2pCFLz9w0VUttz8cQkTc/w9Qf/lt +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 Segment by ID' (get-segment)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get 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. + +## Request + +

Path Parameters

+ +Segment + +
Schema
    owner objectnullable
    + +The owner of this object. + +
    visibilityCriteria object
    expression object
    value object
    children object[]
    + +List of expressions + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-service-desk-integration-list.api.mdx b/docs/api/beta/get-service-desk-integration-list.api.mdx new file mode 100644 index 000000000..d2a27325a --- /dev/null +++ b/docs/api/beta/get-service-desk-integration-list.api.mdx @@ -0,0 +1,123 @@ +--- +id: get-service-desk-integration-list +sidebar_label: List existing Service Desk Integrations +hide_title: true +hide_table_of_contents: true +api: eJztHGtz4kbyr8xxH9amAAMGY3ybpFjbm/OVvfb5kb0re6sySCOYrJAUjWSbuPjv190zeoHA2LuXy+ZIpRI8munpd/f0PJ4qER+pysFt5UqE99IS7Eioz+zEi8Qo5JH0vcqnWsUWygplQH8eVH4UEePMlSpivsPMOByWG3UU+czxQyYeoZv0RmwZeNVgbMAi/7Pw2IOMxuw8HLGBPZEeg+GFUbqVx9HYD2U0ZVKxUPway1DYAIBxyxJKsWgM7cKzA196UaNSq/iB0FOd2ID8SETlGJ8CotA74CGfiEiEyJSnikSCf41FOIVvHnyBP33HUQL7FtlyTs0MZvUBCcGc2HUBQRW7EYMPDXajYu66U6YCYUlHAtZEcNWVExlVkYSAj6THIwHjQz8ejQmOBqEad96VEOz2p102uDhhVxH3bB7a7NB3XWEhDuwixf3T1jiKAnWws2OLe+EiCxqKS1czxfInO9L2dnggd5SBU7dSOPWMB9skxIkfCqALfk6IVcjVhPOVA4e7StQq4pFPAhf406xVlDUWE145eKpE0wBZJpHPIoRxGohu2m1DA8hUTuIJjbOFw4FW+D2b1cqZT8xa4P0Zf2RePBmKEFXScAw5GoooDr1vhnft7hdwb8If9W+CkvIS/iJuGgYqPyTtrhXZu4CTiqaIEU1ZQRQD17ehIQpjUYKjikIw88psXjJXMF0qkFihK0ClTljH1NSLQHh60BBsAkz895XTX5EjgFfdYLl954G66Db0MSoOAuSZTfIkywYw/gN+Bit2bXXAqlXkbrVayclSMzzHeUe6/0XO55QDaJ/wuhJII+C9KJT3hMkfXCyaXfOCeZ+0ricaBlMwHQH8UB0ghGpV2tUqyEz8WgOyqrpNy49aTQuyd7Gf5cYKEMh/KAhd2kz8ytpWv7Xf3B/uCadld3ZFswW/hrxpiU6v2W92Ksvcm+XH3qJ7O3FYFaVfZTKCoAFxJfCD2NWRQrDqv+rXfsTd+iGOrqJcA4isgo0Ft0HOFGawY4mLHHOA6MeuzYbCeEuUtpOGJWRgVYe8KnsQ6M1GHjg1u0F2Ij1LUBgWOs5z8LqACiNCmMU9Nub3AppBBqSg2F9OAm5FNaSGgjgqLIRsmNjzI3TbSuCsVQLyHVFeRZwI23vuxkJzAXsD2rFKsPkmnPwSOx76viu4V8m5bho5m31CaFqkCge0m038X1FHTp/LxwCw5UML6BcM5kHgSou+7fyiEMLTIko8DDkqp4zEhGaG/OXcocTI9PCHvwBPFhS2kLfJDI03Ksl+rBJG3WorKAKr6alqFR6BoxvGEfAAGBKEKLNIao5o65lnyQoscECDXaNNwC82AaMmTfIkaHIjmTTnXDMLX5bJsg/a3xeReAFOuY6rMRiwe3AazEM4y+AhIhrCuhgw7K5dZD0B+8F/uDo6OSu23Hkl2KU6WykOLWNd8glQ9B88EV4K5yXKdY5jgF/SBl2GhQAyq6gOCeGLSJbBObo+J9oRjvAwgbqtnBwdf7g+uf43qlqGf9oKmEt7/RkSTNnJUaPAEB0neGfP4eCpRQfihDPsQLjYt9rNvd0+TpTo9npT2VIFLp9qBS8yXwfLygw1Q0bURqPQN8w+QauJbS8Ux5Ufh6BOZvBrhVGEUiqTw9Obq+vjy6JIksY1JTI3Tbk89js93nMsy7abrR7n3f3+ntN3Os6es7485iZaLpbrkEMOD5Hzp0FBNBrAoR4/L6JFqz5MKUpzoaWGvhUKQMaCcDucskzoNYz/gIxJp4bc+vyAARSiYQADh9IFFd5e7Zoep7/9Nu33+8SPACI7JaAU8ma4QvH4SNiaNFXimjTTTo7UC4kAjbuXCpoBn0Pfc+Sokcx1KRRBBQJVjUH8yKgcYzazHqkLkbBk2VMkN8eV20Svdrt2q9/i+3vNVtdu73e63WGHt3fbyK621d3Lden29rIu/f32bgXFv0jnIhMxqL1Z7PiGGbPMChCKOGzR59iwFXMpKkUkAPJMVzmOpN6gaO0QQSE4Ke6eEf9LNPUqnf1hLACBUJdsimhIlWKiBVkQcZJwajUBR8W0jOHv0J8QVX44ajAGiTPJAjJFA8fO6wPjoAAcVwyQQGakZZlYCAn0uedOE5EWM7O5nC5T8PwciwyAVlA8D9HFVDfB/DmFB80LMOUHss7Ak/iAFqYsWTUJEuR57iMfCdVVqvxCR+/M1+VKkXxlGEj8PmayKptPmfnsVfMlceLq/Oby8LgYJkzbmlECnOhr5p8PI2XmPgRz5+uHkb/HoFJ1VEM+dE2y+kWo/f2SDWARA0uyI0i6LVgVT4thJ1s+aHlXZgvZdnleiX4nEZ3WIFBPbaxG3+0XCqlMKFSl0IiVcBxcqNVt9y3gOPyyOMTtptXabe3mOb6Sw/lAvWK+sylL2IPcy1x9KlBDjKYlxY80wur2SSPglxg2uy34J6sApJBZi6oELwbXhn/KwLV1BgHUeSeejCR35W8ivCJWlEkTXAf8yzPxUZGd4XjQsxQA06OejwyGiytmuoxdodf45JNV0edLD2wk1gt5a8y9kVCrc5G3PzxOXFwqIYTv3rQazTcM6PBt6Pjdm5vr9/X9Nz98f3cX3t15b/9ydH54/e+LY43Exc2705NDdnd3V8mqAnZkY0N5awKHhiPvv8PWY40MAaWxiC19eSfAeMVFjsAcFMbeHmU8+l73ZfnOGs2HsbTGCTNQdVGFdc1LePo3yWwCNDvTxtudPNR0Kq0f37/9y+3h0eB6cKs/yAmuFlhGqBZro/q31d/zWF6ArjQGFpVxLnXI/rLRjfNkM+fFcJLqwevweOl083jq/6K/3mJFknDfKv/nAVlYYySiYj+1tc222VMiNQj2W3NDccx5sLXdgD8h5m+xRawI2xS3xpHWGFaAzObBKgL7PLQz0jK2/bcE0uyrInvs/Q64zvLiYuzTp+/f7hj7uPO0r/f8PPREOot+7YOJIOAu09KVqbeOhUd5aWayFGb4PVo2DCmZwIRUSpo9AU6N1ERnsEp4UW7LEN1plgeU5rXP5bHBIgLHj4E0paUFUj8iQQb9QHh2IUWn7Vik0q5p5GByWH6puYr0GLiszIanphhjgs7N0Yu5mLMMtSfUdWNYMShpC9z+FYgc/B89H6T6ru9h8ssdh1hGIQuXdtKdZ8mKrbWUJ718fnSxuAKbFWqTL6n4ZcMa7CcIp7bO3JCwCMsCEbIOEDOrXGSORJwmIPB5StKoy21b4jfuXuTi79yS9CkJzrC0qVBFHUZ+FtlfSPNwIUZh1HnJkmFZ5Hrt8mBpJCyrF13enM4lmNSy5hpg6VTzNaNmZ18Md+1u1+ryTq+7P7SbPduyhvu9Xqdl9fbXT/YJ/PJKURlGAxlG5BZJMnlFXUwwsIspJNGeQknKP7djMJuRx+uU7TccuhLdznEYQlCrs8vc1lHeiIe+TSc1pHePCt54xS7EknzSxjKOe0hbo89x9j04nPoo1GUfQShDHmiKCuSuaAtHg0zSfupXFAFwotFi77jNErd8aIhBzofc+gywTtbQrhvaaGDJECazLcySaUVP8OFes9/uOHsdzmEp2ep1h32H7+42+90+lYknQilY8ueLU8lKf/74jidCaYGTtCiDt0FWHHivz+vg5CV1riUyIBhr8B/XhrpvSqbBF5apj1ENctR3hxes02PgqkcxtfPRHBO8+s0VLmxi10WVT4OVBnweypH0ylBJ/MHR8fvBzek1tFwe//Pm+Ap+IayF800DXN/YqJa+iUwPhLEh4IEriLi4FSjsBqsaqFUgCONxrqM0YX2qgJnMhFwYYWYvGZEHnZWyElMiu3mM2JZsiEYNYiG0QciCFcCQY60M1/y4Gwx5owii+qnhZNVsA2832CANDXoXVcF4KiJBzNB7/PrgEpiyoF1jP45wkxW8Q1EWGSuL0sicymleKGgcgPnzejKwIsgGSScKVphqi0HRyAdw1pybK6nnmEYsxcMMsHC06PiV5YchFSeANhkpZtwRnScAx+Ml/VKPlfeq5O7ONDLaQ4I/47Faw+4gD5VenUhLP9wLY3wqrbnaJI1ETMYjmSNlNNj0SsWVGL4+8bCx3Y3tbmx3Tdud/3hpTlkkuQ+mPq3F1OfGM4dQMXgupD4haQ+sQpJOOqnXgqzhqVaTIv3j47U5+IpLJL2C+Yr5kQ7lC8gPUnmYw13J2a8k9GeyQATvs2WJA55I2AeEd4axThKJVbuLs733w6EEBfVKUkTwmiGb+jGtYcPYo4SWqxqzfaG8N5E5OWSO9frpyd56erR3k0luMslNNNpEoz9HNNpkkhvb3djut2m7KzPJFCuyFpMnqXgy4eFUa5r5TtsFDDpkR7hTk9Nl2blsBYGxNMeqFDOHyrDdGracniU6Nu/Ye7t9p23ttXm31+q1hp12r5KP9beZHadGVrSpnLy1HInFeP4A8rjYA+VSke/bxfIfnbdy0K3RVmSSNwPPG7oQaXLHTskGih8BbQAYcsdwSXnx5vJUb1Cbnc7QnLzBNNscQqAtF0wp6bg4XUjbpI6b1HETfjbh508Tfjap48Z2N7b7bdrui1LHznOpY+cFqWOHYYrlYIr1v0wdbanv/TkgFKDBioG9HqaNAZCSnHRIzT7i4UhEaaJXyCLb/ZLjhb7Pzrg3TZIlVahEehm70L35dEx8mju84gFGI3CRHl5glJDdolbJicCcFO9f0i1JtGMkCOCG0/rAwYsY5u6l0bd0FulZbgwYklPAcyo47wOXUXK2BSBQHXQEjvor1jiNtL6oHswukeJTpJgdP1pCoM2n9d9u2SkBPFAQoru40rJeclxA18y5B8sI8Rho95WmoJtUfZOqb8L9Jtz/OcL9JlXf2O7Gdr9N231Bqm6yoeWpOnRYO1WHvo0mS3Op93R2+/fO2Af6KihhQOrNfItydTvLwYEJSkCjxHPFMMkNpPiHWpUHcTRGy5S2d2DurNXxzlqd47NeB3gBC33R/NfcgWnd5xMeXZ0I0FfznBc6Ko6wKzvLRuKbO3qxoWmPQxe6Jy+APIFKgCrMGjyQjeSqvuc/0DMgQ5BDiYvTV5ZQPbEDPTiiJ2iQEENJx/rJCAi4FmnyREJ6f2Ql5OQK2hQWOkyDqeEhZ6Oz1EwXlr1p8qIF6egCfUDXTejOvpwWDWgJLWXsWzkb9GeA6RyJFX04OVGjK8zu9ewLypRFLNxXaC9Mdo7d2uyd4CHeMqajNlv/+Hi9zUaY05JP0W8fCYmLELDKC1AR8pmD5NgJDqIwlr3INigc7EEbZY4LBDPzAs2JYcIHCCaX4P2JpThIkMPBUeu/P8ML45a8N4MPdOj7nKjt1MeQqN/kuQ0SuniOrtci8dcEWl1DqxM0fJ+pgIVm7a2lD4pb4CgQBHcVcevVk2t49Rw8XKlBC0KdxwE5YfAoHseyEqm9Go8CvDrCK+Jx532k63nFYUy7LqbG9OjSCbPGvq/ED4yh6qAZ3I5isKJXo0V3AutkEfV2M4dSXU9Zl3VIPwm/UzAMTysTH2L4p+zH14UYMsmfSbJg8z/T1ZqfCzRT8y0+1Ag9bd96waNKczjjhHWcsK59gDL46yCIigW2jTSQH9AKcJjJnzyBQTTn9zSsUq9O4HdoDIYGC1DVd1SDA/3HQebgzC9GH7B32gfcMGbv6QE1eohAw8JIWGBWUneY5+Aivq4PAXiObxrfdPcUg/IfjV6keJCVZ/DVhK/tpZd4kj+O3/0febyNp/kzehqTT6O60bRm4ZFX8ncmX1ssFyp6GRD+C1/JVil1h4VR9hhgHhA+FIFard/RHUtBhYZAcLpcVkPN8idkiUHoo/nj6y0IaAQ5eUSPAHBYGtKzOVQKT2bmZDA6sUS50nXV2BzM8M3V9Qb7KOhmfhziug+PBMO3X3yzALwCyVygYNlRImxIuiaT2MMntQDteMI4qNQzGmFLZcXaccEy0BMJL3xK/dJRiRWjqiEJdMVShBN17piLcjnBPzMXyF2ZAjawHqVoXmXICLkUbrpEKabtz8EGbauPhRvgyhO8LiRgIjfD2cn1AkQA5pldEz8c7ZhBagf7AhDzUgIM2G20Gs06LRfwMrCvIlgr54DTW4PPP+08r5ZPWSn/W3tE2oQwXHvsBFiYQ8bEei2kV5+3leWrT1jPjIGJ2OnpCQs4uBybYbN+/hPXpOYqePZe5FLW/X89NF3KeX1TOX2I21RNKvRgyvqM/LZejV7BiORR7Ffy4f/ujeYVrMyex34lMzdvK3/lt5VXCCt7UfuVwto8rPztPay8Qh+S17MzbfiUVTAhyuL7V1p0FHL1IL2Fkhu1cMigUHH+8RgTK75kaWt+4FSz2X8AdB3Zyg== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Query Parameters

+ +List of ServiceDeskIntegrationDto + +
Schema
  • Array [
    • ownerRef object
    + +Owner's identity. + +
    clusterRef object
    + +Source cluster. + +
    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. + +
  • Array [
  • ]
    • 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"}}>
    attributes objectrequired
    + +Service Desk integration's attributes. Validation constraints enforced by the implementation. + +
    beforeProvisioningRule object
    + +Before Provisioning Rule. + +
  • ]
\\\\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\": \"RULE\",\n \"id\": \"048eb3d55c5a4758bd07dccb87741c78\",\n \"name\": \"Before Provisioning Airtable Rule\"\n }\n }\n]"} language={"json"}>
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-service-desk-integration-template.api.mdx b/docs/api/beta/get-service-desk-integration-template.api.mdx new file mode 100644 index 000000000..b9a0bc817 --- /dev/null +++ b/docs/api/beta/get-service-desk-integration-template.api.mdx @@ -0,0 +1,111 @@ +--- +id: get-service-desk-integration-template +sidebar_label: Service Desk integration template by scriptName. +hide_title: true +hide_table_of_contents: true +api: eJztXOtTIzcS/1cU3wdgCz8xsDibTXmBTUhB4HjU1h1QFXlGtpUdayYjDeCj+N+vu6V52WNe2UqyW86HjfFIrX73Tz2S72uGj3Std1k7E/GN9ATbE/ozO1BGjGJuZKhq1+s1X2gvlhH92audj6Vm/ZMDJpQfhVIZFguTxEozrpi4k9pINWIlejKnx4yYRAE3gg2mzJL9lU9Eg7E+M+FnoditNGN2HI9Y359IxcK4TMt+yxMzDmNppgyYicUfiYyFDwQY9zyhNTPIZMpgo7ZeCyNhGTjwQYaRMI4o0iyIe+64gxkRj4ExI2LUz31NwR8wM2cZhkjUR8TNuDavJFGQjt3wIBEsHAJf4hmqATmAQyCaSlbrmTgR6zVtpgFxIWEkciDuoiD04ashDzQO8MZiwmu9+5qZRjTSxGAOGslpTq/Gz3IZHh6ucRUdhUoLjfM6rRb+ryzOKY3wtTVOQYgF6tsDCbKhOhKeHEqwT8HewJEXwkRlcDUeRYH0iETzd41L3hdE4UFwPCQjOKHCwe/CK+vn0hoIpIlitLWRVhzpz0tzNtWg6vpIKPQJ4CtR8g+wz8FeaqLjdIHFWpR+u7PR3SQmuH+sgqk10sO6c5XZVckRnk+fW/uAmoC+ERVi7OID9BsffeYpysMwnnBQdg1H140kBy6zXly+0+ps1FvtemvjvNPutbd6nU6ju9H5L3I0CX2y5zxLh1wbZh97fwdvwJyRhgZ94FrshpNJqMAZget556lIa1IToyCBCBhwxfjT0brOEm1zj7UUpEGfCV8atiin6saM6xJn6zVuQCGDxIDnkhvfSA2jQUW7oRrK0bxzW4lmjYC5ZwUfrTA3fJrFoJUPHz47GzUeddNPYpCRONs7OCK9DnkSmKqHDyUhqznPBxT4twkUzMPZhEfIez6M8RsuAz4IBJmsIIMG02AxomrwEkEzH+E+GBIG8eCkoHkX5xUmqhZpfuBC03j0OHGspZ6VEaiWTjwqQ9lnINfdQE3jwRFXfCTiivSYMXQ7FkA8tvorcyZ1xtyECLGikFSShTbaBlEQMB0mMVRmNozDCXEcxiMo+gfghBjdTKV0fKg1NPZUDMG0scDp4a3wC6INwjAQXFUkicz3XD3MHNWZrGKNqmo3FLFQyC6Il3Eexs8MGMaO+JSFwBYbFMufHLJZ7aMeidWCdDyO+RTRBRDUj9e/GcMRp8Tos5y9OpnMxnp5jb3z4yx96Hw97dbzH1tPqGRCWPP44nR3H9NZnkfcd2AiW7Ef58JW6hevn1cQb6f9tvV2Y9Nv77T5261We9PvvO1ubg66g85Gh9cKVfxxTn5OwKXq6IaUgJQr8q9n7edT1vcMeAnbg/LgmTCelupaAXhZe9ceXlAXUtNZDwL3tMHq/N1/oZGqjEKIzzJWofHNrbfeZmfHA43DJ49vDXdaXnujvVFbiJtmNOxLDVqbZppesN7RlKXqQe1lD/IgcsJYWTL+yCO8zR3yCPgkBq3NNvxXS9nLKbN2EVY8n1wH/qsi1wFLYlUJuDpQUHV4IP8nYgvWq6xp8QrPzUf7H4bzwc8yAg51P10ZnBYfWek0AQOYMTc2J+tyzpcKYiTxyLe9MVcjoR/HDu9+vJsEDPMhTPlhpd1orcCezQP4qEY/rFycf6y/Xfnx/dVVfHWl3n23d7x7/p+TfcvEycWHw4NddnV1VdNQ/O02zzc+flH9bUqHpqPuf8Bv9y0zRJTmIrf05IOA4BUnBQELVBh7t5fr6L0dy4qDLZu3Y+mNU2Wg66ILa4sQlf1MNiPIPG28axapZktZ/3j/7rvL3b3+ef/SPoAtYBgblgtqzdp48/3jz4tcnoCvNPqeFybKnNqS/edmN47TffaL6aR47nV8vHS5WT7tv5ivV1lZJGwpFP/sUYQ1YINeHqdX19gau0+tBsV+dWYqzjmOVtca8CfU/FU2zxVxm/HW2LMew0qU2SxZTWSfpnZEXsbWvk8pPXxRZvfVX8DrQ9FcjF1fv3/XdPFxpWyuV2GRemqdxRtySJfZZsJmN8C9inBpHrJUZvgNRjZMqVjAlVQCzUpAUiM3sQhWC2WAQhwmo7EF0wUcUIlrn8Kx0TwD+3eRdD27OVE/oUCO/UgovwTRqVOGUvrrljlYXConM6CBAcgCMo9By/Y7N5NqgsXmmMUCxCwDmwklPYQdg5a+wM6cQObg/5j5AOoHoULwy4dDUhmVLC+cRLCNm1EJKQp2KYUmAXy10SkWku0iPjqZ35Q9UJerAkBVd65wPBDsVjXCdgOJttyPY8gUdXZKnU8L7YuaGYQ+dSalgo2r9F/U7Xq8SPvCQG7bpZ7fU9j0I1ixDvJJ5FAQy1Bc3U6NfGCCxrIkUyxF48qQFDTRaLMP3Gepr+86YVDvMfc+A62DZ8D2C9tnS6cw6We7qoplxbbgg63WTqc73OpyDvi8vb052BnyjY3WzubODrWihNawjyqg3mz7VF76J2z2SQ88zyNY5IOtOOieGKDFizuux21ANJ6hfwTcdmwmpuMXsP+dWYfC/2H3hHW3Gfj/KKHv+WhGCap+cYZoMQmoxZFlAEv4OJYjqSr7vQ7H7+1/7F8cnsM3p/v/vtg/g09Ia66t30fQ6KNbhi7cb4ljJ8At15DGAlAH7MTZG0f1DQiESa4w0LXQNPVYmctjMMOtXjGjSDrvD6ShRHFzZ9iqbIjGOiQY7DByA7BqwLEBgRspGP4GirGITP3QafING8OOQcRrDdbPeji2jaRhPu3Mue9j6FoCwwRCWVDXOkwMJCkDSaJsi1yVZWvkueWwaBQMDuD8aT+B/R6UWPKJUhRm3uJYdPYBnq3mytydF5RGKp0qwwGNw8hgCmqMY9rxgWzSaObSEZpLQ+JR6bgsYxVzKqW7I8uMTZCQz3iinxF3UNylqpNo2YMb4YJPZ70tn6yRmsllJHhoe1sw2Y3KzJUGPhtKEfjL2F3G7jJ2nxm7sw9P3eu/IvRpz0OfC+VeumLxnIM+MXkPQLt0kO1xWUOu41tcB5F++XTuXvQi7rSw8AviI1vK55jvZ/aw3w/Sxnla+nNbIIOkRyvBEDKR8HvEd84xKcqqamN+tY9hPJDgoKoCIkLWjNk0TGhjECeKmgVcrzM/FFqtGDbmkB/T19hh9ia7nr3KXiLJJZJcVqNlNfo2qtESSS5jdxm7X2fsPookM64oWhxO0slkwuOp9TT3nHqwDAaw9CAay0KOTDWLVpAYyzBWrYwcaoNOe9Aebnui6/Ouv7WxM+x4Wx2+ud3ebg+6ne1asdZf5nGcBVk5pgr2tna0Z/tEjC3eRIFzaROGfrn9l+ChyCGmNXq/k+Jm0HkDX/Jl2LFb0ZUODcgGhAE7xgvaixenh/atn3t9FLvjDAiz3Ztd6mMjpEQftscyl9BxCR2X5WdZfr6Z8rOEjsvYXcbu1xm7L4KO3aegY/cF0LHLEGINEWL9ndDRlz5BsyEYBWTwElAv3aWJQBT45LqPLuwNj0fCZECvhCI7OxVntsKQHXE1TcGSLnUiVa4uTG8hnb2dFk4EKOBoBClSMchaEtAtepWcCMSkeMQ9kBNJcYwCAd14Wu8PDUhlYyb1t2wVqbwgAQ4pKeDLf1z3lkuTHhgACtQHHUGi/oI9TmetP9UPZqco8SFKzPbvPCEw5rP+72bVKQE8VxBjujiztl5wXMD2zLmCbYS4i2z6yiDoEqovofqy3C/L/bdR7pdQfRm7y9j9OmP3BVDdoaHFUB0GPBuqw9hGi2VY6iMdiP2rEXvfXrkjDsi9WegRVvdzDA5K0AK+lGZKi1wAxN+1rtxPzBgjU/qq5y4C1fEiUJ3jNfYe3mrBXDT7tHA82I65xhOsEwH+6q6vY6LCi+e9WnPRTN1Mbxjp5n1+9fqhhuwiLrUqSeIAqIyNiXSv2bwHTwEPeWjwSDYggYKzmKkKbxteOGkOwDwVmS+/OIsD6LcB7AINsm0s6Qg1xQYRt5ZOL4lmZ/UfpZxe95nC/odZMut4WcO5Mn2NJ4hhH7OiaXSDXHdOPpDrIg4e/rwsltACWarU9+hqMJ4BpzMiuqPLqXedIei3q8/5WF7I8HVDZ26xYxzWYR8Ej/FGJ53AWf3l0/kaK9yDp/ukQuLeBIL1BFyEUmk/PY2Ck6i6pUfZBeuXzvtg6LJhAAKzK3UmBLs8cEr4FWrMKRQFUilOEpSHcNb1amodX9yIAMtvI9ckOh4ESBM01OSleWtUamlPIpU9Ho6Hx69U3d2dwyCgMU5E2mKyyyiVixfkei0T/0qp1S21OlHTazNcWNVeevb8uAf5A0nwQJO2Xr24pVcv0MMNHHyDVGd5QE04PsqntLzUaq/mo0SvjvTKfFypT3QVqjyN2YzGNJThwGcHzBuHoRY/Moaug2FwOUogil7NFt2/qlNE1DutAkt1u2Rd1gGVEn+HEBjKOhMfICogUBTa/gyF5G9kWYj53+gaw28lmenrS/y9Ehjph55+Nc+4YB0XrNscoB3/tjaiY0FsowyUB6wD7Ob2p0zgGC3kPUurMqsT+SbNwdLgAav2PmDUs3/08gTnPjF6gKOzMZCGEdRn59bo0relhQWypKy0HTGrwXl+gxDq8ozeLL/ZS1Ws1f80eVHift61wRvqXzpLL8gk/5y8+zdlvGWm+RYzjYPZ6G60rNuPFJ38g8Nr811EbHOPBfwLTylWCdHDfin/jaIiIYTM6NX256TGUlD/IRLcIPZbR88KJxSJURxi+Av3u0gj+v0XvHDNYccoA6BHHfJ0ZU4BY4El2pWuBibuvEborgk32CdBt6CTGLeDeFIYnv0eun3hGVjmhH51ay81NsOfuUkU/hgWsJ1MGAeXesIjfKm9xCYu2B0qkeoiJOiXzUqjGF0NRaCLeSKe6OOhu0ZXMPwTa4Hdtetrg+rRiu4GfC7IqbD3/3BcGbY/RRu8rT4WQYQbUsi6AMBEYYWjg/M5ikBMuZcpYTxqukm6iWOBiLuVDhM2Gu1Gq07bBbx4GWoDW+gC8Zf+0tmsf97nrf6v9LfVXEnDvUgzwv4dKiqxeyO7Sb2sLdykkke5bSp87hV+YA12PmNQN06/v8cOEG7cHvDrPxKB7YXL63xPRntZd13Xz+7NLtT06qkTbI3eYX2B32qr1ELa61TTvM1Rg4+fBXZHCrLSTz/YNhZJYgfYRldh6tyroFJf4Kd99HO+AGm4D6A1yKX/B0GaC5E= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

+ +Responds with the ServiceDeskIntegrationTemplateDto with the specified scriptName. + +
Schema
    attributes objectrequired
    + +The 'attributes' property value is a map of attributes available for integrations using this Service Desk integration template. + +
    provisioningConfig objectrequired
    + +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. + +
  • Array [
  • ]
    • 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"}}>
\\\\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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-service-desk-integration-types.api.mdx b/docs/api/beta/get-service-desk-integration-types.api.mdx new file mode 100644 index 000000000..c83cd4931 --- /dev/null +++ b/docs/api/beta/get-service-desk-integration-types.api.mdx @@ -0,0 +1,95 @@ +--- +id: get-service-desk-integration-types +sidebar_label: Service Desk Integration Types List. +hide_title: true +hide_table_of_contents: true +api: eJztW1tTG7kS/isqn4dNUowNjhMWXrYcQrbYIpfDpfJAqIo8I9tKZqRZSQN4Kf776W5pbtgGwqbOblKTB2JrpL5362tZc91zfGZ7u2e9Y2EuZCzYa2G/sgPlxMxwJ7XqnW/0EmFjI3P6uts7mUvLxh8OmFBJrqVyzAhXGGWZmwsWF8YIGEuldUxPmS3yXBsnEtbiIGsOzC1yYfuMjZnTX4Vil9LN2XszY+Mkk4pp017qR3nh5tpIt2AgjRF/FtIAD6cZj2NhURYYLyXs9zZ6Ohee30ECSsyEC0SRZkPfExQGphthc60sfN697g03N/G/th2OaEZivbwcRDKGL1Dnhh3SxcMtAFxjDaPKITOe56mM6fngi0WO1z0bz0XG8ROuABmIJayTTmR2WURylRE5KANULeNsnZsZEMhT7gTJ0icDeJticBC3jZ4n/Y5nAqMiiKAnX0Ts4Glu0MROepMpnLVaIOkjBWeU1iqZiisOYpBmxKbiYp2Rata7KQfuIowz2AVPC8GmEDxr6J94nZboN5S8k0s9j3EHqyeFewDX45r6Em9UTjqatyY2g49I9Bv8t9EbrQrNvVRiDu4bA5JE7IjyEwJQemujawWk50QnlD5SgdwyeUwArvF+IhyX6Z5ORGNu0PN2PXkjlYhAQ4kSChI5hoUMKF7IBFawTBvBPMkyYGhe27Zgif4We8UT0NfrtxeUQcMaHn8FWpj89wl0qiSsZ+USJpPKoyvYim3BJy83d4aj6csR58NfR1vbLyY7U/78+ebOi50d5J5BReIzb5pbmdtm/btQwsiYpToGj/wFBjGCg+1JAGLeTPa7fUA0HmD/E9DLz63UDPJCUbhyG1A1Xu19YKNtlnI1K2icz24ZQUWnxzCiijTlExxyphCguSf83siZVKtEEarIsMK83n8zPj08gZGj/f+e7h/DJ6S1tPmMFURrgmEJokIszPUlSRwUuOSWWZGCOUTSZ88C1WegEA/7U5hYJvHCgjEhtqa8SB2sCNxXrGiSZlOjs1YqUd5cOfZE9kV/g01wLOMunrMJt7AAKyxMfzaG3Sl30WGw5DM2FzwR5mkftrVEopI89VXEwvoFEGI8STB1PYFpAaksaMvRhWNKOygTbV/Upmx7o64uh02nYHKA5PfHyTh2BQhHajazsIqWIGLwD8jsLdeW7qRhNDLpQjkegxY8hb0y1rBrxlCZQDcJG1YoR+guC4VHlfOqitUsmlTu3nphXjtNz2Je2Afk3YcUyk9EqlUPLkRIPouwwlcj8kbpplCR4CEVe1wcZlXuKhOfTaVIky53u9ztcveBuXv74VEA5OEpQZ+tZehzqkJngJvnEvQxFD1Kl+3DXx78ekduYKsRINIfH09CN4JtxFWOSPg74iO/lS8JP6784ccnCD8qZ7V8gQKSHb0GU6hEItkluWuJPUgkUz1f5vZGm4mEAFUrICJUTcMWuoCmBnxeKIWScLvBEi2s+sWxOYf6WPZaumq3oqrf6pBkhyS73ajbjX6O3ahDkl3udrn7Y+bunUiykoqyJeAkW2QZNwsfaeE5assZTGDl0TCrUo5cdRutIDFWYaxeGzn0JsOtydZ0OxajhI+Sl893psP45ZC/2N7a3pqMhtu95l5/VudxlWTtnGr42/uRTAwg7gJwXKEguKzTOmkf/xV4dD/FskYH5yVuBpuDSc9r7Dhaxo7vtAPdgDBgR7PmePH06BDpA2sij3bThYkFwmxvOpjOHUFKjGGwtLSug44ddOy2n277+Wm2nw46drnb5e6PmbvfBB1H90HH0TdAxxFDiDVFiPVPQscEcAdCsyk4BXQob3dUdwrC6WP5gzc3M+EqoNdCkcOdFb+na83ecrUowZJtnUSq2lxY3mBuhnNNORdvgbAZlEjFoGpJQLcYVTITiEnxKkMqM0l5jAoBXbOIxlMHWvmcKeOt4iJVnBYgIRWFVOPZq4YYkxBOYorwDyjQOegMCvV3POMM3vpb58HsCDU+RI3Z/lUsBOZ8df77YtUtAbxZYLBcHHtfr7ku4M/MuYI2QlzlvnxVELSD6h1U77b7brv/Obb7Dqp3udvl7o+Zu98A1QMaWg/VYcKDoTrM7W+yCku9weD6vyN2SpUgAYU30zFh9aTG4Hi3VcCgdAticgoQf8+H8rhwc8xMmahd66+eRhAQXyOOd613oaxRLVr9FFyF4HXF88YV57U0mnMCpfObc7QHRH24qY3ljqOEvcG6tXbgwsVt37h4OxYmhUVz53K7OxhcQ3hBWN30eS77UHUhwtxC6ct+rLPBBHy6olzW931xAl179wz6FBBGYs75Ak3EfXiQCzC7IEzoQsSdlMuL0Atompgns4F3h0P80zCImEPz84ul2X2K9yX9QK9Tk978fV08oTW6rDLfndxgPgNJb6mIKpzXIXmMnYLnvhSY9e6Hv1EMl5i9x2lD9kpwA22Mv7bz5I+PJ0/ZDPEx1afCIjQXEhsayPAPECJUf8flFRZcRFui0cVsToKPW5eEMN/ZNAWF2Sd1LAQ7OwhGeAcb0xHsJGRSXCSoeOGq8yeldxJxIVLcs/u1JTHwICMGYKEBb617SvszNTJSwceMRvufVMReSyybGPM0J6hIfSk7y0u9eEOvxwrxn5Ja5KlFRM0+vSWFN+1Z7C+dx1B0kARPLVnr0cw9vahBD7s+GEGqt2VASwQ52le74tJrj5ajRS9Cem05PqmPcwmbf3sZ8wWMWdi704QdsHiutRW/MYahg2lwNisgix4t1iUyjSgjouFmQ6TIs4xkBFCW5DuExFA+mPgEoQQhKe0PdSglP5NnIec/Q6OfsM8tnWn4DN/EgZmJju2jZUaGETKMfA2wQX6/oWJgQW6jDlQHfADs1f6nShAEbdQ9T2tlVSfyA1qDW0Osc19ibL7rv+zWBS58YvQAZ1dzoAxjJ1BddoPvLNDCXbVlrPIM47YFl+VNNWzmt+zm5a1+icUN/t+mL2o8ro963qt08b2r9JpK8u+pu/9Qxesqzc9YaQI2x3AjtqGJaQb5q4DXlo8e8Wx8LuAvPKVcpTYAmiz/ViKimCYhfH0Mo9q/KDmXgg4tcsEdYr8NjCydUSbmRmP6i/B64wzwO56cW8CkfCJToEfH6iVnTgnjgSX6Fb/bIlzy0BCS0ASLPvsIfaSKwS3YQ+L1Ynj2RYdm8hg884FeKH1dOhtAV5YVCl/zBLGLjHEIqXsiIpE2LnzhgpZSidIWmqBftarMYgw1VKFP3ZTJ7PtpePuu4fh7eIHfbTgMB9PXrz/2akWOROobFZjXhu330YZoi+YizbGLhaoLAEw0OLw9OFmiCMRU+AVGm9kgLLIDnAtEsD3y4fO8v9XfjKhdgPFcWwctWIP42rdF6S1ZdigtXfVuxeR1/ZvAj/qqcNjHsAEZ5HjSh9YpfEPkG9Gz3tpGNKy3+IrsHCyKk6+v8WQIe7MbHP6zEHjscHZet134DZj4EyLqXb8KOpmgM6T68GH5V5ZWs/z7PkYDX7Mfhw/I6ubmf6ovuRQ= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +
+ +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-service-desk-integration.api.mdx b/docs/api/beta/get-service-desk-integration.api.mdx new file mode 100644 index 000000000..bb41b8520 --- /dev/null +++ b/docs/api/beta/get-service-desk-integration.api.mdx @@ -0,0 +1,123 @@ +--- +id: get-service-desk-integration +sidebar_label: Get a Service Desk integration +hide_title: true +hide_table_of_contents: true +api: eJztXHtv27YW/yqc7h9NCtuxHTuOs66Dm6Sbh7TJzWPFkBQYLVE2V5nyRCmJF+S733MOqZct57Vidxs8DJtDkYfnfX6kSN05MR9rZ+/SORPRtXQFOxD6CxuqWIwjHstQOZ9rjie0G8kZ/bnn/CBixhUTt1LHUo1ZaaTMR7LRnA0PGowNWBx+EYrdyHjCjqMxG3hTqVgYlYeaVp7EkzCS8ZxJzSLxeyIj4QEBxl1XaM3iCbQL5c1CmKrh1JxwJsx8Qw+YG4vYEkWaRTlqzoxHfCpiEaHAd46CP2CE9OCRRMFmPJ44i9IOD1jow6xitZzAHEwLI1N2nb04SkTN0fE8wCm0nM7gR80Rt7Mg9KDJ54HGDu5ETLmzd+fE8xn1jCNQKfXkNGbP4SjY/f1nJK9nodJC44B2s4n/KzNbLfoBMEi6RynG8hpMMTyAOdwQ+qgYyfDZLJAu9d76TSOtuwJzPAiOfdKZZTMc/SbceElXqzT0SjM9E6707RSNkq4ujSXKxGpmqprDY1DJKIlBalDBLEJzx9LowFhwhRKquMABDXYOasBfbJromI0ES5T8PRGNdNJKM6yKD/YRmbhfUMUzeCp0fJiDAbsW0ZwppLOKHjJiKDyVA4bd9d6VulL1lOzH8ObsYPih3HKlKrjzhM+TIM7p26FVqksfAYvhjRLRqfCf41zHOAb0JT3wWcgPqKyyO6SCLzNZRefg/JhkRzpCJVN0xOHB4cfz4fkv6Go5/1krcA7Z4skzpJxiFiwppO32W7tN3tnxOfeE6DRbO/6oI5qtXbfd3Nnu40Spbz9tKk/qWcDnxsHLyk9mszCKIYOA9WRMbTQKsoJz/xla3QDC4NnmOAuTCNzJDn6pMcpUKm2yf3Rxdn54WjZJ2vhEiyxMU22P3U6P93zX9bxmq8d5d7e/4/f9jr/jP90eCxOtNst5xKXC6vnzoGQaQ2DfjF800XJU72cSMR/q6YNlaiMSwIwL1RQKc270GlTZGJiBdiQx4u6XGx55zA2nUBDlSAbgwpsPp6bb+R9/zPv9PuljFglI82kVBO6nXPGx8IxouiI1GaUND/QzhQCPu5YamoGf/VD5ctxI5zoVmqiCgLrGoH7kUk5EJJ4oKo8iPkd4EIupXrb+/bK4Ba1cpn613fVa/Rbf3Wm2ul57t9Ptjjq8vd1GdbXd7k6hS7e3k3fp77a3HTT/spzLSsSi9mq54ytmw3KelmChScMuPU6sWhNtQFZGoKh0XdBIlg3K0Q4VFIqT5sEH0n+Fp55ls99MBDAQGSRXZgMaUk6MIUsmJjgodGzcBBIVMzaGv6NwSlKF0RgA5xAAG9qCqZSOV/QHxsEBYHh4I7yCaKMwDARXhE24d6yCeWrSrMpZ2JaZuOzgxTmWFQCt4HgK2QXxMs4fc3jwPHD4GGAL+wCZJAS2ELKkxvSY9Nmi9lGPxOpDrvzMRO8vwvVKJl9YBtK8j1Bb5/NpO5/30HxpnTg7vjjdPyyXCdv2xCphoP6z518sI1XhPoJw508vIz8m4FJ1dEM+CixY/VOs/XjKBm4MXsIOAHS7cRjNy2UnXzgYezv3S2i7Gldi3klNZzwI3NMEq/V375lGWrX+MtJXaRxSqNtt913QOPxyOdTtptvabm0XNf6ghouF+oH5PsxZqh7UXp7qM4NaYYwsGX/kEW63Tx4Bv8So2W3BP07KXk6ZtYDpF5Brwz9V5NoGQYB0aqhkLHkg/xDRGamiypqQOuBfnpuP1t4Mx4OfZQSYGfV4ZbBafGCm0wQMEE94bHKyLud8qSBGEpd8251wNRb6YSzy5vvbaYBLJaTw3atWo/mKgRyhBx2/e3Vx/r6+++r7t1dX0dWVevPNwfH++S8nh4aJk4t3R8N9dnV15WguA7PF4MUeNlS3pnRoOOr+O2w9NMwQURqL3NKTdwKCV5wUBCxQYezNQa6jt6YvK3Y2bN5MpDtJlYGuiy4MmlQeCGp+k82mILM/b7zZKlLNpjL+8fbNN5f7B4PzwaV5IKe4WmC5oMasjdffPvy8yOUJ+Epj4LphouJTU7L/3OjGcbrH82w66e7By/h47nSLfJr/Yr7eYGWRcDur+OceRVhjLOJyP72xyTbZXWo1KPYbC0NxzPFsY7MBf0LN32DLXBG3GW+NA+MxrESZLZLVRPZxah/Iy9jmtyml+6/K7KH6C3i9L5qLsc+f377ZsvFxpUyuV2GRemqd5bz20VYQSJfZ1pXJboB7FeHSPGSpzPBrjGwYUjGBLakEmpWApEZuYhCsFioGClGYjCcGTBdwQCWufQzHzpYZOLydSbu1tCTqJxTIsj8TyitBdNqlRSm9mmEOJofll5EZ0MAIZAGZJ6Bl02ZHUk0w2ByzWICYZWQyoaSHsGLQ0hO4KyyQOfg/Zj6A+kGoEPxy3yeVUcnCpZ0MFlVCioJVSs0BwlMem6btdrGQ9Ir46GR5BXZf2pt8zo5fPqzBfoZy6hnkhoLFuC0Qo+qAMbvKReXQBvIUDL4oSVZ1uedJfMaDk0L9XViS3qXFGZY2zjUPEoQ3X0T+F8o8WqpRWHWes2RYVbleujxYWQmr9otOL44WACa1PHENsHKqxT2jZmdXjLa9btft8k6vuzvymj3PdUe7vV6n5fZ2nw72ifzqnaIqjgYyiiktkmWKjroMMLCL3UiitwgVkL/8rgDzHVDsVL1g2A8kZp3DKIKaVmenIk4iZRahxRgehR69v5HqGv278ZyXDQ/DSQ93cYJ9eonymGLfQ76pjyOz6yOIZYCBdk+BstUUNWtIpqif+pUtAJpotNg77rE0K+9bYVDxEXe/AK3hE5zrgt4zsHQIk162/q+YVvQEH+00++2Ov9PhHFaSrV531Pf59naz3+3TLvFUaA0r/uLeVLrQX3xpp0QkXciRLgF4D2zFQffEAE1esc21wgZE4wn6x6Wh6ZuJafmFVeptXAOI+m7/hHV6DDL1OKF2Pl5QgqpfnOG6JgkC9PisVhnCx5EcS1X5As2mg4PD94OLo3NoOT3878XhGfxCWktvNQe4vPHQLUNbmG6IYyvADddQcANQh/Aa7LWl+hoEwnJc6ChtVZ9rUCazFRdG2NkrRhRJ5ztZaShR3NzGbEM2RKMGpRDaoGLBAmDEcasMl/zQ/TXARjGL60dWk6/ZBNa2ItpssEFWGRgleQ3jaQ8JSgaGriHgJxDKgt4ThkkM5TSG5FC2Ra7KsjXynHJUNAoGB3D+uJ8M3BjAIPlEKQozb7EsWvsAz0ZzCzvqBaWRSudQLWHdCD2DOagximhvAmSTsWY2HaG5NCQelfbLMlYxqVK6+2CYMQkS8hlP9BPiDmCoVHUSLXtwLWzw6WzL1SNrpGayGQkeotg02PbKzJUGPvOlCLx17K5jdx27T4zdxYen9lhFEfq0lqHPhbJHU7B4LkGfiLwHFiFpJ4PpjSFreNbFQqSfPp3b4zC4QjILmK+Ij0wpX2J+kNnDtI8QfmTGKtkCGbzOVyU+ZCLh7RHfOcekKKOq7eXZ3ofRSIKDqgqICFkzYvMwoSVslCjCs1zXmBcKrV7FbMIhP6aHfcLsvE89O/CzRpJrJLmuRutq9O+oRmskuY7ddez+M2P3QSSZcUXRYnGSTqZTHs2Np9nn9LaAQQeWHvBlWciZXdkFtILEWIaxnDJycEbt1qjl91zR8XjH29nu+213p827vVavNeq0e06x1l/mcZwFWTmmCvY2diQV4/EDwHGJAufScRh65e0/Om7lY1qjN5EpbgadN8w+pMWOnYr3J2EMsgFhwI7Riu3Fi9Mj837avuiM7MEbhNn2DAK9cUFIiT5szqqvoeMaOq7Lz7r8/GvKzxo6rmN3Hbv/zNh9FnTsPAYdO8+Ajh2GEMtHiPX/hI6e9Aia+WAUkMFNQL0KYeMMREkPOmRhH/NoLOIM6JVQZLtfcbowDNkHruYpWNKlnUiVqwvTW0inxOeFsysKODIX5SBrSUC36FVyKhCTgv+wQE4lxTEKBHSjeX3g4z0MEzOpv2WzSOUGCXBISQGPqeC8N1zG6dEWoED7oGNI1F9xj9Na60/tB7NTlPgIJWaHt64QGPPZ/m+36pQAnieIMF2cGVuvOC5g9sy5gmWEuJ2Z9JVB0DVUX0P1dblfl/t/R7lfQ/V17K5j958Zu8+A6hYNrYbq0OHJUB36Nposw1Lv6ej2X43YB+YmKHFA7s1Cl7C6l2NwUIIW0CjxWDFMcgEQf9+48iCJJxiZ0lN79spaHa+s1Tl+7GMP719hLlp8Wjgvbfp8xpOrUwH+aj/ygYkKP9ex52ytGqm37qR37yBziEKNApIogDGTOJ7pva2tO/AL8If7Bp/JRnpdX4U3DTecbo3AGBV5zlxbQh/FDmxwMrRLmgZZMpJ0tJ8igYgbu6afScjukDxIOb2GNofVDjNkanjQ2TouNdOlZTVPv2pBjrokH8h1EQX3f14WQ2iFLFXqe3A26M+A0wURHXNAOfWlM4T4ZvYlj8rLFr5caC9Ndozd2uyd4BHeNKbzNhs/fTrfZGMEtpRYEo2YWkhciUBonoCLUOIcpGdPcBDVsvSKhWCD0ukeDFTmByAwu1JnQrDLoVXCR6gop1ACSKU4SFDWwVGfN1LreOJaBFhsG7km0fEgHLZAQ1u8NG6TCiutQKQy1xbwKgB+pMPc6USXpz5WRFpQsstZKhcvyPVSJv6TUqsbanWipjcXuDCqvXTNaXEXsgWS4IEmbb14ckOvXqCHyzVoQaqLPKAmLB/lM1luarUX81GiV0d6ZT6u1Ce6olcexkz+YhqKbuCxIXMnYajF94yh62AYXI4TiKIXs0X3AusUEfV2s8BS3UxZl3XAoMTfEQSGMs7ER4gBCAKFZjeGQvJXsizE/K90vebXkszUfInfcIKeXujqF/OME9ZxwrrJAdrybyohOhbENspAecA4wH5uf8oEltFC3jO0KrM6kd+iMVgaXGDV3FOd7Zk/9vIEZ38xeoC9sz6QhhHCZ6fU6GMEhhaWw5Ky0s2HRQ0u8xuEUIUX9Gb4zV6hYmX+u8mLEg/yPRr8csLXztIrMsnfJ+/+nzLeOtP8GzONBdXobjStXX0UnfydxWvLe4a4qT0R8F94SrFK+B1WR/k34IqE8GMR6NXmE3sTKWi3YSY4XTCroWeFU4rEWRRi+OMXXJDQGIB5TB8C4LA+pE/n0H54OjOngDHAEu1KV1YTezojtNfXG+yToNv5SYSLPzwXDM9+C+0q8Awsc4KGZQepsQF0TaeJws9qAdvJlHFwqUc8wpPaTUzigrWgEqkuQoJ+2ag0itHVUAS6ZimiqT727WW5guEfmQvsru0uNqgerWi/zJALcirMvVTsV4btj9EGb6tPRDDD5SdkXQBgojDDh+H5EkUgpuyrkzAab9lBegv7AhH7tQQYsN1oNZp1Wi7gheBQx7BgLhCnjz+u/vzc0mfwsm38v9tnI21lwiXF1gw33VDexCxxzMry0lm5soTxe9LDW6YT0BB2vbvDLRpca91j8++JwPX/5ed8GUXLT3vz28uuYK9U18apFWKTPecTlJVipTuOap5vNjhOevMXBKFPhJhNJGLTPDDbTIUhSy9iSqvyHw7R7/iKym9/gEogt/0P63uHKQ== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

+ +ServiceDeskIntegrationDto with the given ID + +
Schema
    ownerRef object
    + +Owner's identity. + +
    clusterRef object
    + +Source cluster. + +
    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. + +
  • Array [
  • ]
    • 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"}}>
    attributes objectrequired
    + +Service Desk integration's attributes. Validation constraints enforced by the implementation. + +
    beforeProvisioningRule object
    + +Before Provisioning Rule. + +
\\\\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\": \"RULE\",\n \"id\": \"048eb3d55c5a4758bd07dccb87741c78\",\n \"name\": \"Before Provisioning Airtable Rule\"\n }\n}"} language={"json"}>
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-single-search-attribute-config.api.mdx b/docs/api/beta/get-single-search-attribute-config.api.mdx new file mode 100644 index 000000000..263e14c0a --- /dev/null +++ b/docs/api/beta/get-single-search-attribute-config.api.mdx @@ -0,0 +1,88 @@ +--- +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: eJztW1tz2zYW/isY7UOTjHWxrMSxX3aU67iTOFlfJg+uZwuRkISWAlgAtKP1+L/vdw5IirTk2k07221HL4lEHhyc+/kODN10bK6cDNqao7Rz2JmpcKrNLFOnSrpkPg7B6UkR1GtrpnrW2ekEOfOdw4tOfC9qAhEpisirc7nTSZVPnM7562HnbK69GH8+EjJJVB68kEaor0GZVKVC1lyMXCi8SoVTeKSulBdhrkRinVM+tyaFcJvWJc3dez+YsQj2Z2XEtQ5z8enk/b/Hbz4eHQtZhLl1OiwFpHHql0I7sAlWJDLLsFOUsQc9c+kgSlCOtL3pkFzQgv/b6WjSKJdh3rmr5jHJb6csdC2mj7a6R1raPlUZ9qJ9K6E6h8EVaqfjk7layM7hTScscxLBg4khT6ivcpFnLJW6/ih1Vvuic3t7SZzIYF55WjwcDOi/trCnuUr0VCf3SqaNOEqVCTDYsb0m8fAeSgXiJfM80wkT9n/yxPBmXVrpnFySxYJa+MZzO/lJJYHs7CgAg45iRjOv63q/kaH7SvwHrAI+2ueZXB4/apszsC8XxLh8cMtjvKE9RWvThqHq5xtt0d7+o8xpx8ZqoVPODQihnZDe20TL0MyDXlMceD052H05eDnZP5imw9FwONjdl4PJ3vN0bzDdO3jxErso0NqlUsfFYqIclt+z5sVg8JLWTNbX3N5CScQIm2Bz3bi9ZaLhYLQehcdWlFEluoi4lJQt056SQfkgrqUXvkDh8H5aZAKM6bVTlMVmtRyJNKFFoXAGVkH0RiYxD3rki9Fgd12Cc1PWhf9gVVec1AymrW0qouiLuZKpcjvCupJOfP/lrKw6oFdfc0rjb8mZe3JDOWfduvBjsYBZ5Ayxys8nVCG5/DB9MzxJwCuZ6TRqMEWkqvSQ5V5JHH3Fptpb3+2ddROdoias20kUXjmxtIWQMJkrjCFJpN8RqVXefBfEXF4prv/ek6+43KJCdnOrTfgDLZWqANVe2/QRSf5OG9WdOalJETYZwilVAhyvNHebhXVkW2JZV3aia+UarDXo7YpXMoVZYtC+LpWh5HAy+Rm8qMU+JNC50VgvqiWU81MIdc+2al/JyYvBwXA0fTGScvhytLv/fHIwlXt7g4PnBwe0exkffkNZbm/9Xhnl0A4yi3bIyeCU9BQpEKAKp0dWcubxyCIbaWs1q3gOaKA7QopXrz+L0b7IpJkV/FzO7hjBdM9P8cQUWSYn9Ih6JzSPjD85PdNmYws1xYLAzJu378bnH87w5OTtv87fnuIT8VoDMWNTFSiIiliY22uWuFSAyxQ6eYKa3BPPSq7PoJA0vkmo4ze/9DAmYmsqiyxgRbn7hhVN1mLq7KJVHzlvvgbxRPdUbwdFEM8WMgBzTKTHAhsr4bMxY6/uh9KSz8oi9rQnxmmqSUmZUYUAU6xfUjWVaboqpdMCGa8YVFnUYGODTto9p2HKtjdWHeJD0ymUHJD84TgZJ6GAcKxmMwvraClFrBpIWlquLd3Z3aayNEEm0ALwbxlRZhK4v2hA1KqvaLL9QpqKThuuomgojcb3lqT5GIV5Eyy/S2ThH5F3nzOUny6rVr+4UmXycamM1Yi9UbmprEhcR2OuVFS1u6rEF1OtsnSbu9vc3ebuI3P37suTEkTy21oqzpYSJ/lisZBuGSOtfM/4XYCgBqGiTjl21V20QsxEjbE6beTQmQx3J7vT/USNUjlKX+wdTIfJi6F8vr+7vzsZDfc7zV5/scrjOsnaOdXwd/Qjmxgg7go4rsDk6nywNm1FK5nXqSmVNSo9NW6GzWHSyxV23Aj0A3QDY2BHdwc7VvzPTz4Qf2zN7MlutnCJIpgdTQdyGRhSUgzD0tqHLXTcQsdt+9m2n79N+9lCx23ubnP3r5m7vwk6jh6CjqPfAB1HgiDWlCDWnwkdU+AOgmZTOAU6JAXMawg25lAFn8rTxzLtg3QzFWqg10KRw4N1FHlmrfgozbICS751EmlW5qLyBtoF0bqKFgRSzFAijUDV0kC3FFV6oQiTIn5Ephea85gUAl+37I6nAVrFnLl7qIzvSVZAQi4KmaWzV4sY0wgnNSX4Bw58DjpDof4DzzhLb/2u82BxQhp/II3F26+JUpTz9fnv801/MjqC8I7KxWn0NUf4fWfm0mCMUF/zWL5qCLqF6luovm3323b/92j3W6i+zd1t7v41c/c3QPUSDd0P1UHwaKgO2t5A1FjqHQXX/xyxc6qUEnB4C5swVk9XGJxxBUKpvBrG96LCHF/6MkkwZwTfj5ebuvUVlG68QtS/oSszt1gRp4IoZOEyLJ6HkPvDfv8GvoPPbnsy1z1dXjQy9rqX2EV/AoNtqEXwdJmbRMA3yuIGPba20xTQsfox82h71o9CFz7g2wa/yrm67LPERCIimx2B4C+Dix9DxByTxXeeqXscTGv6Qa9zl93+fl0io3t02WS+X90N9AKS3lGRVLgkdyEIwIj9dQ55XsfSNS7I8ReXTZpTgupRwjXKVfuhPxIM1wT6RGRD8Qrhgzki3pt58v2Xs6diRgCVC0Th+bqfpokCKfYZYcQFcFzdIaFF3JOcLWZzVm7cuqVDCSemGYwifjCnSomLxoU2cYJSzmanRYqrB626fFJ5MFVXKqOm2VtZm4JTp6YPK/Zla91TbpA8SWiDj4vqNmJXvNFUtzQ1eqIpVeTBUFzklV6yode3CvGPils3cusyN//0jhTRtBdJpql+Jsh6YiEzz9b65s0jv26DH41deEJc78pAlijlaN+tSiqvfbMcLX5d4teW4wfzZa7pTmZrmYjFTng0zywVRyKZW+vVP4Wg0KFUuZgVyLRvFuuaNu1yRnSHg4ZI3bhlV3eBJVm+D0gME4NJTqiXM5Sx8VSF0/ZH9izqwo98K/DHls78+AItlyhTm/hvlpk27NKG3VgnfCl/7GgUWMht0oHrQAyA1yv/cyUoBW3UxshrY+Vn9n1eQ+0jgajMxeeH8cvhqgiWnwS/IOqaBqWaoHh924wu+Ja8qK21jFUdIty14Lq8mUU3vWO3KG/9p1DqsP9v+pLG49VZyyeTLf/oKn1PJfn/qbt/UsXbVpq/Y6UpwTGFG29bThHNIH9VYrr1sz86nJ4r/Iu3nKuMwzHlxJ8rEIppMsozGSiqOauTOf0qgg7TlQyED3cosuyCMxEDPqU/ZkNmNHOgQdp64FY50Rn48bl2tbPkhIngk/xK331R3rKwCElMoaonvmCQM0D7joY4ut+Ldz/Zcpo7hWc+k2PFm8rZAF2LRWHoVxYQu1gIiZB6ICJS7ZMiFi7MD0ZVtrAM/epVVRZTqJEKPR5n3MJ/mtKBNGbdhuMf2At+9+VpNEy/+vVBZ6XIico4MomuDe0f4o1o685VltMYiaoLAKYaO3w8OlvjCGam/BOIdbN+ucj3iRZMaISK4bPX2+0NujxS4HlufcDg22D+XvHt+PLoyMfp1Fc/9bj/RynrP/Zohe3N6tz+L/djnrLH0XDSz+kYjixXxIEqDrQXnWqg5Yl140iLN4dsY0xAc5idVt3c0PkNDXm39PiXQtHhwMXlan7jOQphQZ8xRk9RqNSvmPbJSanIU/G7f0u0Ue3qjNIsV8cTHXz8WdGpBuuH6R8a8sETSx9fxaOpxqK1P97QaFgfF7x/i7i9/S+X/RI+ +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-sod-all-report-run-status.api.mdx b/docs/api/beta/get-sod-all-report-run-status.api.mdx new file mode 100644 index 000000000..541bada66 --- /dev/null +++ b/docs/api/beta/get-sod-all-report-run-status.api.mdx @@ -0,0 +1,88 @@ +--- +id: get-sod-all-report-run-status +sidebar_label: Get multi-report run task status +hide_title: true +hide_table_of_contents: true +api: eJztW1tz2zYW/isY7kOTjClb8t0vO4qtZN2JY1eSNw9OJoFISEJDASxAOlE9/u/7HQCkRMtJXDfTbTN6SSQSOPfvXCD4JtK5MLyQWp2m0VE0EcVAp90s64tcm6JfqkHBi9JGG1HBJzY6uooG5yfsQmcymUfvNqJU5EYkvBDYXZhSbERWJKWRxRxrb6JLK8yxVoX4XHTLYkr7ZaqOrE7ja6kzx/jICJ5G724dNZsYmdNTCDOcSsuESnMtVcEgmmXFVDDrJGJjbRhnNRVmnMT+cZax3InITKlab1Vf/FZKIywzOhNMj9l5/+X77snZ6esWNMOLXCsroN5N1Nnaov+akngj0EYSYIUnmLCC24/3MQf9hAygCiLL8xxv3ObNXy3RvolsMhUz7t5m2fnY2a2Y5wJ89ehXkRTRXcOQCwKLVVmELbOC2OaGfFtIr5enWFO2hZFq8gjK7GR4zogIsRCqnJFP+72L8/7wfb83uHw1pLAQn/ksz4hR89XtBvz/XcQ4PXEC1Hw6yWH7YOtgezdtH7b5wd5WezftHOzs7o52Rp3tDifWis8eYIP/lDOuYgpKPkK00KbK8w8z/EKoBVZYm/232hHdQpZCFn6JTgPW3P6TQkPS1QBoOtND4AF2rOOWf032ZVcOLo+Pe4MBnrzp9l+fvn6JT71+/7yP/4e9PiDTHfZO3Jezi/fVm4ve6xNa23B99fD2lrBdKbysbV+MhREqEeSdeuNCvyVpgqLNcPLRFG3vj7ZH8HE83j7ciXf2xgcxT3gaj3Y7ne3DvcMx3zuIKvdHZ2As2S+lMHPmhSEJIcDOfdA/ziSwy3rGANsxNhSlUSJl0keEQWYRtmAjnc4Z0pVU1zyT6R+C/dd9nYqCy+xYpw8I3RdSiXhiuCQJhRM5wUYGitcyxQ4200YwT7IKareuGbewRKvNnvOU9YN+x0EZilzDk4+gdfoAIF8qif2s2sJk6nLkF9iKfcFHe1uHnZ3x3g7ngG97f3cE921vbx3uHh4S95mwlk+Wc1rEjeHzFdYvhRJGJizTCTzyOwwCSMP2TgDHnMKnEDP7bR84Gg+w/xB6+bW1mkFeRiVwAzB8fnzBdvZZxtWkdM/55I4RVHxJAa/KLKME5OsqNPeEz42cSHWfKBWCT3ovuh4c/d4vl70BPhGtlfLaVYjWlMISoiIWpvqTkzgo8IlbZkUGc4i0xZ4Fqs+gEFd2eaEMZXluYUzE1phTHmTPAvd7diyTZmOjZw0oJb5fYE9kS7Q22IiezXiRTNmIW2yAC2n5s26SiLyIXwVLPmNTpGxhnrZYN00lKckzBjSCKPbPQYjxNCXoegLjElCGMLKY6rJgShcyEU1fLEzZ9MYim71adgqBA5J/O066SVFCOKfmMgrraAkiBv9AZm+5pnTDJaM5k85VwRNogT5iDjMadGbITNBNonUK6YjcZZF4VLWuzljLVcmluzMvjCtJeJfw0j4AdxcZ0k/sVKtfXIsAPoSBDtnIeaNyU8hIeElqu81hVe2uCvhsLEWWrrG7xu4auw/E7t2X/TDwhLeu9Wmvtj6XimNm08YVz5XWx7joUZpVi3xH6R25wWCQ0CL9/GYIYH8UitaLzzkGse/ZH/lSviJ8t/aHfz6i9qN2VsMXJKCzo9dgjEwk0iMn90JiZyhvqu1Vbi+0GUkEqLqnRUTWNGyuS8ZhMoyEiiThdoOlWlj1U8GmHPmRAxHW+gzox97Yzb3rTnLdSa6r0boa/TjVaN1JrrG7xu4/E7tf7SRrqRxaQp9ky9mMm7mPtPDeH0hiAauO3lkNOeequ90KEWN1jxU1O4do1GmP2uP9ROykfCfd2z4cd5K9Dt/db++3Rzud/Wi51l8tcFyDrImpJX97PzoTo4m7Rh9XKgSXLbROm8d/JR0AjymtUeqp+2bYHCZ9V/eOncPV3nGoNTvjal51SLbRQ6qFjSinYe2M1ppqLRZwNkFeVAypSkIuCiU5E6BiEDQskzPpwEtagK6Zx91xAVU8UKogq7lIlWQlJHSZINPUNWsEloSSYkw9Hyi4DnaC7Pwdu9Pgoj/VybM+afyKNGa9z4kQBPS6c9+973z3FMIbyhED7+AvHPT6aYcrBAAGAp+z6r5z3Z+v+/N1jV/X+B+jxq/78zV219j9Z2L3D/TnoRv6cn+OBQ/uz7G2tcXqXuoFBddf3qY7qAQJXHgznSSlccfNVQ/u+gqEUrjsRDmE072kaLNxJyn2FyMius5EbaGXqDQZVk6LIrdHm5s3cBQcdNviuWwhf8FXxVzpT61EzzZHsM49iYduCHiQ0QLWvTgNg0XLmdZIil6f6hxxb2inDMUpDO4Ohb9KubqwMtclkpsjs0E3dkIkuccQMccY8ZN1q1suclb0g16XJrv987p4Ql/Q5T7zfZUb1jNIekfFcMukun02oJ7bc1+5g7aoIzSndVaYndOyDnsuuMFA4H+6ePLzm+FTNqFO0yG9tNTkCkmjAbBygRBxmaxbHePTJldcjC4nUyd4t/FDCSGHjTMozN6qgRDs6jQY4TVSfB852ZmUNgmXBmjXuyeVd1JxLTKqfq2FJSnwZKo2YaFN3tj31FU6NxJIhY8z97T1VsXsRFICklSxaU1Q0U147Cqv9OJLej1WiH9V1GJPLXbU7NM7UnjTXiX+4k0C+BIJnllnrUcz9/TiJXo0P+EJUb0rA1kiyNH8eSupvPZoORr0YqLXlOOtejOVKKPNbcxnLWZRBbOUnbJkqrUV/2aMQodgcDUpgaJHi/WJmMYOEXFna0mk2LOMZYym0Mn3CsBQPpj4iIqy60k02jWVekh+cJ4F5j9gZE7Zh4bO7vEVaietTHViHy0zMYyJYexzgA3y+9JEgQVskw4uD/gAOF7432WCIOhS3vO07s3qjvym20OlIYGo/j5efuS/HC0SXPjE3AtaXa9BGqaeuv7Bj26MBlpUnxrGqk4D7lpwVd5MoyzesZuXtz6NolL5d9OXNO4uDk3OVTb/3ln6C5nk75N3/08Zb51pfsRME7pcCjfHNowDy0H+PPRrq4d4dMo8FfgXbx1WXUONccUNYK6LWSaUo1umqHaoTqZSuPE/F7yg3m+DIkvPHBIxqRP8MeQ5QhODNYCtRU/KRzIDPXdAXXHmDjC+sSS/0ndbuhmEeCVTjJOixd5gIlMJ3ELTGF2xwLtfdRjLBvDMhfvTgZPK2Wi6ZrNSgRvhspwxjpD6RkSk0ialT1wYzpSobKFd61fvqlBMoUYqtNxcYmb2fEwnyxhalxz/DV7wuw3HyjA9eTFcXV4o0hd+UKF1zbb9W7QRbfFUZDnNg8i6aMDEEoez0+EKRRBTFnph7tZmshk22U1aCyI0Hvnw2W61W1uxGxfwPNe2wAS7RPylKNiMbl/Hd/9wwlZ/ZdKIx5vFyfpf9scgoejQtLCZ0wEXqVL66cWPilfRvaMiho8pNKb3Nzd0BkKz0y09/o2umuP5u8VYRN9A15+FuNnyo3AzuDstWYzZq78n0JBTT7Ave+Qt/oV6GT4Qq9vb/wHdhyed +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get multi-report run task status

+ + + +:::caution deprecated + +This endpoint has been deprecated and may be replaced or removed in future versions of the API. + +::: + +This endpoint gets the status for a violation report for all policy run. +Requires role of ORG_ADMIN. + +## Request + +
+ +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-sod-policy-schedule.api.mdx b/docs/api/beta/get-sod-policy-schedule.api.mdx new file mode 100644 index 000000000..b66c97fa3 --- /dev/null +++ b/docs/api/beta/get-sod-policy-schedule.api.mdx @@ -0,0 +1,110 @@ +--- +id: get-sod-policy-schedule +sidebar_label: Get SOD policy schedule +hide_title: true +hide_table_of_contents: true +api: eJztXOtT20gS/1emdB/yOGRs2bz85coBkniPQA5MpTZALWNpbM9GntHOSCFeiv/9unskWbJNYEn2bh9OJbElzfT089fdI8m3nk6E4anUqh95XW8s0jMdvdexDGdn4UREWSy8DS/lY+t1L7yzkwPmLnpXG14kEiNCngqYmZpMbHhWhJmR6QzG3nrnVph9rVLxJe1l6QTny0h1rY78hGh0jeCRd3VHpGxoZIJ8ABeDibRMqCjRUqUMeLKMM5uIUI6kiBhy4Sg8s8zmXDYu1an4JZNGWJZOBDM6FkyP2Mnpm596B+/6xw2QI+GGT0UqjCUOJS6WcOBtw1NwAY5kBN+R5pR73VsvnSV41qZGqrF3t+EZt0Yp8SLjgvUPcFlkQQ9/FmHKjBgJI1QoWKrhAEiJzwK5EV/4NImRvhi1d0d7nXZnR+x1traD4dZwuNsJOnxru723E+16qCOQLNHKCouMBc0mftSXnysGuMAVQlS/SnEkTxK4QJbe/Nni8NtlOR3HqCiDfpFKt5jTzaI2FoWfO0dpFEYzq5Ke7b/1W1u7nXYrCHbbzdYWKjUERyAvWl5ipM2UgwBeBCP8VBK5ZaXjBXYzEQoUD75TUUTJCpzO16nrPmgGTb/Zgr+DZrNLfxtN+vMReZvqiLzud2euWOg3cVdb7CkGqo6o2akYADIW3H6Z/YprFnNX+c2y8HMRlVMXXGoseZijs+jPhyqbQsQAyljwYhCJwgogBsIpjUGKLEm0AYvOV0FCFrDgUvWiSCIdHrPPPM4AFqZ8xoaC8SiCGVIRsVGWZgasI9OJzlKmdCpDxBIEvQVlCuAGQeyg1z/6EY4/HB7+m768OzkevKVv+72jw+OD3il87R0fn/eO4OxVVa3lnFSmNT0PcDFyN5VOSCU8jk9GBFNfD85vVp2IgSxYea66o/7ZgPk046XT3UvGjQH1IaBwqSzTCvDNgNOC8iJpYQVAOjeWSJz2jt8cPkAjvdH5lC6Nsyk3KeMqQuwvQNRwNRYbYK4wzqz8LH5f26LkcEjc1y2XXyntlmutsJtjY9kOFAI0Fvgq9TPngFQChzIVU7sy45QsXKCjkd8dQNKEKYDtBkgSQmdxzIc46r60VDJRTKPIdmYqXKDOGg4cC1PFOTjVDqo40b6r5cQLN7dUx9WywkCkVTpyfo8ZUnyBIiIVziMEN+Gkwagg0Ar8ltKYoIFFzFuyMFQIuDa6zXURe9dOnpLbUru5MQujXXhtONqGf3vwrxWQeusqvcNTEZ+tQ3Mdmn+z0ESvvycw0eB9CDgkfY1FzLVLcNcbNCp3gBsZx+gB16AkuHI9OD/ED1AWHb09x4/Xp338OOsN4AMd7frs/Ph6xQp5tr1GH59H+soFOQPfGQqDXhfpDIzAfsl0KuwGi+UnYOjSa116uCx8adI3JHrpBbtw0GDsJHGuHM8q9HHAEVxnIVe4SmbBdFTaQ52PX3BkzG2KmitihfDt0XA096YNDxRzHx5B7Jg1IK0B6W8GSOT2JZONlSHlrFKNKUrtu7jMXBnA0hWpLZFuE+QeoxTdxXwgw5avwY7gfwj0RFsrh8sDELCeBc32LrZwrb1Bs91tdbrNnX9iA/dshW8t2mZlh1ntDltAetsPtgZBsxsE3WC30Wp2Plac7wAmDnDeHZ6bio8Qjf1otZwAaFrJEOw9+MhkhGAAHalxAVfogMDVZAoj57n40mC9qTAwafNY3Pz0ozafXgBwAmQrTY3vrxj9oIZy+8YhqTbjZxa6zxHP4rQ2EOG0sUIVS2FYaqFgYH8C/4+1d4+fObS8Wu69/MDt7IQykSBzNbTuC7l7Gt5Ka1+Su7/ZfbhbX6TFDgYnhL2NCg71Dw6PB/3BQqdZnsXoX7l78fByYCHnBWmxoVRxvXCntdvkne0R55EQnWZrezTsCHDIMGhud0ilj983WrEyZIokBqRGIvWl38lwwkXM8k9LBi+NqqPTggpdEFMu48Npks5OhQVnq5pxqHUsuFpiqa8i3CuDXCFHTOBcYI0mMyVctocEQpRFVOVtxGMrih0tbfqPUPz7YicznwOarknbHLVao4B3/J1wr+N3hqO2z4Nh5O90gq3d5ki0h5GobFT9tjWLSU9btK72hV3juzu83lm1T7kfkzMfGgPi+uxUQO5VmG7yNA6xi6g61NEMEUEqAGsZfccNzUhAVRHv6+gR7vlaKuGPDVQhwKEglkOYyIDiZxlhteQKGyJZVCI0ru61oIlGi73iETvN5dvPhUE1Gh5+AlqPMd65kjCfFVMgRCk937Os2BF8uN3cCzqj7Q7nwW6ntbM13Bvxdru5t7W3R64jrOVjsQr46ku/EQqhlsUakoT8FRQCPgu6JwZo8a9hZd0GROMR+sfE5MaWYub8Mry1AM0Ce7X/nnV2oOZW44zO8/GCEpR/fraUU0ByR/jEyLFcuYFa7vkdvu6dH1G5d/if80Ms75DW0p2LHqZFwg5gFXxhom9cO+AEuOGVuoW9zKm+BIG4stWB0h3ZmQVlFmkSZuSrr5hRJc1GRk9roRS6+zDsuWyIxgaAF5yDwiKcsCHH9kW7KvhlLwxFkvpHuSZfsokAdDeQ0r+ljK7ZYq7KpQyfY8lR1SgYHMD5w37SC9MMmCMxq1FYekvOYm4f4Nlprs7doKI0UukMGpAwxaIoxnYEeiJoXoYgm4RkkMMR1TcAPKoYVyJWFSIJ7t45Zg5SV6aEPLOPiLv3McCPT6KVFz6LPPioOXdoRNYozJQjUt6Q0uR8VGmuIvAZ5IA4WsfuOnbXsfvI2F28eJrfnc2vUunTWi59zhXPQL+GkudS6WPIe6BzKga5VtIZkjan8hLphw8DCOxPQuF4ajrF96yPXCpfYr5X2sOdHxZ7RUXqn9sCGSQ9OglGVCl3ie85x6Qop6r28mqvtRlKcFC1okQE1DRspjPGQWXQjCrkhNsNFmlh1bOUTTjgI4eIsNYhoHuiwKdHCtaV5LqSXGejdTb662SjdSW5jt117P45Y/erlWTJFUVLXifZbDrlZuY8Lb+O0nIGA1jxnCArQ45MtVitIDFW1lhevXLwhkFr2BrthKIT8U603d4bBeF2wLd2WjutYSfY8aq5/mIex2WQ1WOqYm9nx/w+k/kMdVymwLlsqnVU3/7L6NlJhDWEnrJuBp2DSq/K2jHYW3E3Q2v2jqtZUSHZWg2p5jpCTIOxUxxrirEwgLMx4KJiAFVSuxuM+BSfzwze1onlVFLwohRA18z83igFUVygFE5WrkJ3JIFDQoJYY9WswbEkCClGWPMBBapgx4DO37E6zU30TZU8O0WJj1BidvglFAIDvazct1bt7/bxBhtixJkz8D0bva7b4QocABoCh1ll3bmuz9f1+TrHr3P8XyPHr+vzdeyuY/fPGbu/oT7Pq6H763MY8Oj6fAtf9WBlLfUanet/XqZTqOQcuGd1dEhPBkbzGpzqCnCl/AUyxBB8p6rrbZbvegGabN7K6G7Tzl8qc9W/4yszMYyfpGliu5ubt2AuMNNdgyeyUTyBovRNI9TTzSHoaAX84HMCLtRwAOu97+ftRYMUbCT6sAM8Iu7UTSKht4LaaWv4q5TxURS040xnAHFEZgMfx8n9iU4Diwk0E89s/uAKqmdJPpDr3MR33y6LI3SPLKvU99XVYDwDThdERBGu5u/24QMeU7f60ht+82yC3VqwtNgJDgvYK8ENPSqLNzCe//Bh8IKNsd6keM8slrpCYoMAEfMeXITwrFds5uMkSjFGZ+MJMd6r3S7B+GGjGARml+pMCHbRz5VwDEB/CshMKsVJgsAAZ109L6wTic8ixhzYmGsSHU9GahM0tMlr815QvqPGoPqG06Xy2YFEGJKYt3FMLiL1eewiKeTiFbmeysQ/Cmq+o+YTNftigQun2ovQPX4TQhAjCR5b0taTF3f0/Ao97KLgDFJd5AE1kfNRv8kVFlZ7Mh81ej7Sq/NxqT5MJCTT+jTmsItZyIVxxPosnGhtxb8YQ9fBMLgYZxBFT2brBhf1KSL8oFlhyXdL+tKH0pD4O4LAUM6Z+BBTM1UmGoo2FbmQvCbLQsxfu4fkazLT6QvIoDgy0qF9Ms+4oI8L+g4DbM6/S1DoWBDbKAPhgHOA/bn9CQlyRiu452itRHUiv0lzMDWEwCpRsUnXHXTnAFc8NUoXcHQ5BmAYK+vyth8cs5wWZqmasoo9gUUNLvMba0iOC3pz/JZ7Upgw/2jyosS9+dbJiYpn3xul70GSPw7u/p8Qb400f0WkyWtddDdaNm8Kqk7+Kq/XlrfyLL04Bf/DVYpVKquhaXFvL2IVUyWUxDxFr6aoDif4kwH4io7gKdZ+G+hZekqRCP06hn/xGuSY3nE3wDKHtk3GQI+2qYuVOQWMKyzRrnhsM/dLBbBWOMF3aBrsA/RlKgSzYE+GD1rAtZ913pydgWXe028zHBTGhqJrOs0UPikObGdTxsGlHvCISNowc8AFLZoShS40lX7lrCKK0dVQhAZ1J2ZqT0a4vwyta8XwD6wFdrf55jKont6Gcb/7MBfkVMTkmTiuXrY/RBu8zZ+IOMGuEFAXCjBRWeFdf7BEEYgpC3JB963NeDOfZDdxLL4oBMI792k3Wo2mT+0CnE+0TaGPrRB/I9JVvyuw6Ia382313+9HNvLkgl3BZoLbWchy5roU1xheeNXGEKZ0y5/dIK6v8GUNm+LA21vc+sBm6Q5PQ8uPffXF1bwPov4RTIDfo/wJ/K+I/TwXIHpBN28e/2sdK8Uq9vLUbN7Ge/D1k8DuH6Ry7+nR9gwx6i64DZzKlKVbHNhxlU31m0N0HX5P8s6/gFIAnv4LMJgxAw== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get SOD policy schedule

+ + + +:::caution deprecated + +This endpoint has been deprecated and may be replaced or removed in future versions of the API. + +::: + +This endpoint gets a specified SOD policy's schedule. +Requires the role of ORG_ADMIN. + +## Request + +

Path Parameters

+ +SOD policy ID. + +
Schema
    schedule object
    + +The schedule information. + +
    months object
    + +The months to execute the search. This only applies to schedules with a type of `ANNUALLY`. + + +
    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` or `ANNUALLY`, 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[]
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-sod-policy.api.mdx b/docs/api/beta/get-sod-policy.api.mdx new file mode 100644 index 000000000..cc21a8f33 --- /dev/null +++ b/docs/api/beta/get-sod-policy.api.mdx @@ -0,0 +1,116 @@ +--- +id: get-sod-policy +sidebar_label: Get SOD policy by ID +hide_title: true +hide_table_of_contents: true +api: eJztXOlz27YS/1cwfB8SZ0xZ9+Ev7ym247rj2Kksv7zWybQQCUpIKULl4Vj1+H9/uwvw0mHJcXpl1EkTSQQWu4s9frskeG+pmQh5LFVw5lqH1ljEV8p9p3zpzK19K+bjyDq8sa4uj5n58eO+5YpZKBweC5gRh4nYtyLhJKGM5zD23rqORHikgljcxf0knuB86QaHkXLtGdE4DAV3rY8PRCpyQjnD9WH14URGDFiIWDQTjvSkcBkuradVPgQD8VsiQxGxUPmCKY9dDk5/7h+/PbuoALczHvKpiEUYER8SSc44cLBvBXABvkkXPkfOREy5dXhvxfMZ/hrFoQzG1sO+FWr6mVyL7Al2dozLxvBJjT4JJ2ah8EQoAkewWMEXICVuBXIj7vh05iN94TW6Xq/ZaHZEr9lq10et0ajbrDd5q93oddyuhZoAqWYqiESEjNWrVfynvHyuCeACV3BQyUGMI/lsBhdoHw8+RTj8fllOzTEqKsRdj6VeDJSypItF0d8V180lq3q1mlfnTbvj9Jp2c+Q1bF4fuXanWW91q55ojFxhoWzcvQz8uVbrQ7odWy46SiIZiChiOKu8vlaHfTf/HXfPgXXIKJcJeyqcctCU5cIIO5ZTsbQa7i5eYJ8nIoAdBlMsaBy+GfJlDurVetWu1uDPsFo9pD+VKv330yrBp8ols/6jeEzpP4vJ0pqbNumSPnCfFX5OXaTguyV+yM8N0yKIEvRoR8FFydGRYDbuKJhJ4vt8hFMMZ+pzIMKB8FYZ9QJbOPJFxKQLHgKRqbJk9nr+RvEMnePhJcORJEiQTDGqnR2fXAzPhj9iTMyFy34FfrdxrUVOl5ys7vRq3Spvtj3OXSGa1VrbGzVFtdZ16lWIINbWDpUu5cpo5vP5Coe6SmYzFcbWA9AEZug3mnUcK1wHYroIYbe1aw7S2PcEM0kppPufxc8yI//78SczYpUd6Cs/JCKcb176SvDQmbDfcPQmy/wPdxwINS+le7hFbBvvsf7FMXvaJG+PYhWYO5g+ROxgjMkSElr0BC0WpzPHzGcv38pYjvWPKdG9soDf8VvBOJvygI9FCNq/leIzqSQOORB0yH9dyL4RfIgYBCW8KkP2wVJJjPrLPfWDxQR8VnMhVu2So0LACUiw797KJ1lJPpVxmluW4jWPABqogBhPsQB+TtnZTyUEKDFRie+CpFOFotNWwVgeY7wMFGZwnfQLsn5SI+YlATFQWSVaFEOM3izP+4kAgkS1EKRFACs5KECIDBRDysnFm8vB0ckx/HRxOfw5+1qKMNmvDylCy/jgYcjny2kDBqXSpXzouFlS64017J/W4Bf4p45LylhMV1jlQ5prVXi2NXZ4YRIocPG1UIRJdk9jIp30pVyUTWEFV7dS+QTEKG72o0iOgymEdnBIT46R00USj8MznlEYJP5Km0uN523/on96MoBfrob94dmRtY8rLaHsYxFzCdGCj9Ch0SQyliNGGRaQtqHF7Cwvoe60T30INH24eAo+BdEcs/ZpqJIZmvSZmVDSbs7bo0md+/6lR+h9l97//PS+aJoPH4sD//u4YT/oysoFIy2qZaQgPPNgidlj4SGqRyRLIZKngWnCIzYSAG8zasU4mYqS1mceT3zAzB73I7Sl7Xb9/eKaEJQ1PBjpxBJiTvXgEqVSkzPoWsUqrGqdnlycDPrnBaPJfzm6vHhzfnY0PLuAEvXo6OTq6ufX/avFWJ6Op3SZLdmnFY+gpBah5I87RtnsfeHFxXmPj97Orl4XC7AsjxitANcwLYFK2JdRXLK2qQrE3IYynPKF5ukcB23KVziIkIaZVGEMKp9Q4D4BdpFUYNQYD1wISXf4pVVllKyY1JgAecGtWsxga/SwzmzytAwuf37yFv61luOpiR1WOUfnM7aMFEuthViBd0iArlTo5Y0GKvbBdcBnlwNJt9XuOq16z2lDIOk6Dm97vapTa9Qa2weS7xKI9DZmNowFpXjyPBb7LmwebE2IOACi0EMRfWRcFXWnVZfK1m7X2u1Ra1QF2WrtjtOoC69R4+123uJZWGL/GVQ7a6mW4uKCs2IbSY4nOy/ceeHOC/86LyxcOlqbWDdBnrwXnuuITLVAkmmaTNekZjgMueV+ItL+6tbVhRa0QN7WFO0LTv3ArMe5oamXNxo3DFzRgd+iM7eiEZcB4/K2rneETFrCk4wEfKzFVO4JlVpAxb7NJiNllwO2eVhnqbWzYUJ3O7q9PWtd8+eP7M0st2L+9B6KaZkUWxzp7SUTAD+W2grbukyxC7DtnM01+mLVXShgv6rtZ0UVK3pBuZYqdQnWlhUbCojFwsCsn6GDRXDwvETwzIgPUXgFiiqxDAb/VXnuPo/nHqUj3LhTAfvI/VWZYLECzr89xao67W7d6/EuWVWj51RbouvVuOc9PaJeQHxZE1FNEtBlscTEh87ADbdrItjRqrb06vBztNjhzePBx5XBouAQVO2Xg8UWuikGCkz6m8OAHmV2I6/sH/EzPYN2q1V3ajV3BKGo0RB202nU7F6zx+1Ou+30WgL+92r5jhmr2ZDtW3atPqz1Dpudw0Z3ZZpfGPHwoI2yueqG8hGAwyBmJ2EIQdtmAxEnYQAxXOo8gDFdQAkwUi51SGQAhizdr3jn2aVO5JFyt0DDb6D4scchl8ihIJYdmMiA4q100d6mCmoTTTJLZTiu3AIDTVRqANZcNjDyHRlhEPeF3PkVaG3TUb4OJMxn6RTI/VlRtmJZ0RF81K726k2v3eS83m3WOq1Rz+ONRrXX6lGXbwqmBPl2cz+fjEU6zFcO7MjvAjMzB90TA7T49kUX0dhC/3jrWY/NxDT8MnzSYx+Ay+ujd6zZYT4Pxgn9zscLSgjs66tVLWBN+BIivlx5yzmtAI9P3vSvzzEmD05+uD65Gq5pcfcDsFYXzRJYBVuYKI2jjACfOUAa4YM6hFthrwzVVyAQwKziQKm/RfMIlMlM3w9mmNVXzCiSZl6opiVXcvRjMeylrIjKPhvhb1MeQ+U2KqKxVxhWZrF9bjT5ik2gChThXoX1XVeae2SUVrApPwdCEERddF1NwEvAlYEZGU8QGAJCW7qFlqty6XaEKX7Oi5uCzgGcb7aTvhMnwByJWfTCzFoMi2Z/gGetucUnBHKlkUrnkHsg4sJIf57eHWQjkE3GETPhCLcrgsATpOOyiFWs6SjcvdXMUNsb+yI8ibbwu3c+hB+bRMsu3ArjfFhmm2hEu5Fuk4lIcJGQPE42o7LtSh2fQSj33Z3v7nx357tb+u7ixYF5jM5cJehTW4Y+1wFPQL8hJc8l6KN7nIFi6SBdoemN3MfbQwYiff9+CI79qwjotv7dDEvgr4iPdCpfYr6f7Yf+fYTwI9us0l4gg6RHLYEHkUi4h8R3znEBJTaWV3ujwpEEAw1WQESImiGbq4RxUFmYBAHdLov2matEFLyI2YQX+gVK9ydFgA+CyiDeIckdktxlo102+nay0Q5J7nx357v/TN99FEmW7/4ZnBQl0ymnZilYmrmO0nIGA1h6oINlLlfoA+doBYmxDGNZZeRgjeq1Uc3rOKLp8qbbbvS8utOu81an1qmNmnW8N5rn+pvcjzMnK/tUYb/1PpKKAcTdAo5LAjCuKFbKLbf/EjrkgmENQ0+Gm0HnFdP01tixuYwdL1QMsgFhwI7hmvbi9eBc37LW5FFvKgnxZmOY3d/GO00IKelek7jTjzjsoOMOOu7Szy79fBvpZwcdd767891/pu8+CTo2N0HH5hOgY5MhxPIQYv2V0NEF3IHQzINNARmcBNQbIGycgSjpYwOZ28c8HIs4A3olFFnvLaPIoVLsLQ/mKViKSp3IIFcXhjcYO8WxYToWBnA2hhAZMIhaEtAtWhUeogVMCvbDfDmV5McoENAN53bfi0Eq7TOpvWWryMDxE+CQgoKvsPeqwMYkmJPwEP4BBeqDjiFQf8Uep9mtZ/WD2QAlPkeJ2cmdIwT6fNb/ba16SuAsMAc2r/Rer3lcwDwXHEAZIe5mOnxlEHQH1XdQfZfud+n+20j3O6i+892d7/4zffcJUN2gofVQHQZsDdVbeOiCZVjqDR0g/bMRO7mK4YDMmymHsLqbY3DCFWBK5m1QGEPwFUqH1kH2AieIJgf30n2w8MVPiAk1O0now7BJHM+iw4ODe9gl2J2HCp/JSnr4OVCfK46aHoxANSuiDj5kqj0MB7D+uzNTYFRIr6FE09VxjohrLaeHcSPQNj1X8Cjl9PjUHGoPpsns48ExY0b0Mz7dDDXEi/SVQ6iVJflAruvQf3i+LJrQGllWqe/R1WA8A04XREQRPubv6bpCwK1XX3pbV55EsNVfX1rsEofV2WvBQ3yzBT398vL798M9NqZnmNHN8ajimAkZ61PW78BEKIz10ydBcBJlllAl4wkx3i89a4NuwzwfBGYfgish2E36WoELiO8DCMikUpwkKAbgrI8v091xxa3wMfVVck2i4Uk3OAANHfDSvD1Kc1QPyEC/hgkPrXwIbHYszVPq+riNEZHKO3YzS+XiBbm+lIl/pdRsTc0matHeAhdatTeOfnbbAd9FEtyPSFtfvLimZxfoYfEEvyDVRR5QE4aP8hNSTrprX8xHiZ6N9Mp8fAje00nH8jSmQ1Z6TumMOROlIvFvxtB00A1uxgl40RezRccrbfIIu14tsGTrJW1pAyIk/s7BMQJtTPoNGwRIlO6NkEv+QjsLPv8LHZ79pSQz/XyDh2thpKuc6It5xgVtXNDWMSAy/Ou8hIYFvo0yUBzQBnCU7z9FAsNoIe5pWiujOpE/oDmYGhxglahEs0P95TAPcOYTows4OhsDYRgBdfbMGHxnhhYmp5Ky0lbAogaX+fUV5MQFvWl+sxuamCf/bvKixP28Y4IvmvnaUXpNJPn7xN2/KOLtIs23GGkMxEVzo2VNLVA08tcGry138LDFPBHwN1wlXyU0DbUKVV+EYoqEZj6P0arJq50JvhgUW+KCx4j99tGy1JQ8Ecp0dH98HQ4SGtOxrxBY5lCtSR9fcITd6XRlTg6jgSXuK36PkuxdAM4EaklRYe+hHAsc2BYsxfApXbj2SZma7Ap25h1uLDtONxtA13SaBPiSImA7mTIOJrXBIlwZOYkOXFCZBSLVhSLol81KvRhNDUWoUFESTqNLD9vK+kjglmvBvkempwyqLxwMzQUZCPM+KxhXhu2baIO12RPhz7AYhKgLAEwUVnh7NlyiqPDEo76RocLxgZkUHeBYfB0YCK/Np1GpVao2lQv0CsMohvK1QPxUxMW3eY7wVVGLNnift9Kf+7Zckz8Q+B/MsFGFXCW6ENEl341VLPlgyqF08ZD2RNFhW+v+HjsZWAQ94M+/6ZOjeHwzrW+oLgTV4uf83OZaiV4ajt09uhez/bt2V8qStuaCeV6VW/DxV4HFPIhCp4x1t4UY1Rd0P6YwZemOBVZSWY18eoImwdckZfMBlAJh5/+Ym5GD +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get SOD policy by ID

+ + + +:::caution deprecated + +This endpoint has been deprecated and may be replaced or removed in future versions of the API. + +::: + +This gets specified SOD policy. +Requires role of ORG_ADMIN. + +## Request + +

Path Parameters

+ +SOD policy ID. + +
Schema
    ownerRef object
    + +Owner's identity. + +
    violationOwnerAssignmentConfig objectnullable
    ownerRef object
    + +Owner's identity. + +
    conflictingAccessCriteria object
    leftCriteria object
    criteriaList object[]
    + +List of criteria. There is a min of 1 and max of 50 items in the list. + +
  • Array [
  • ]
    • rightCriteria object
    criteriaList object[]
    + +List of criteria. There is a min of 1 and max of 50 items in the list. + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-sod-violation-report-run-status.api.mdx b/docs/api/beta/get-sod-violation-report-run-status.api.mdx new file mode 100644 index 000000000..142f9a8f5 --- /dev/null +++ b/docs/api/beta/get-sod-violation-report-run-status.api.mdx @@ -0,0 +1,100 @@ +--- +id: get-sod-violation-report-run-status +sidebar_label: Get violation report run status +hide_title: true +hide_table_of_contents: true +api: eJztW99T27gW/lc0vg/bdnBCQiiFlzsppL3stIUb4PaBdnYVW0m0dSRXsmmzDP/7fkeyHTuBQrudu7sdv4BjS0fn9/mOLF8HOhWGZ1Kr4zg4CGYiO9Px/6RO3L2xSLXJxrk6y3iW22AryPjMBgeXwdnJETvViYyWwfutIBapERHPBGhkJhdbgRVRbmS2xNjr4MIKc6hVJj5nwzyb03wZqwOr4/CqXOrACB4H728cNRsZmdJdsHQ+l5aBL8uyuWDWMcKm2jDOqsnMOEaZyRXLuP2AoTxjc24ZT4jukk2EUEyqK/1BxJ13EOxjLo2wzOhEMD1lJ+OXvwyPXh+/6UDIlBu+EJkw1rEviY2Ug/GtQOEBfvn1xsLmSQbFQd5oLhY8OLgOsmVKI2xmpJoFN1sY69aqVLMunmDHR8QCiVfKIabCCBUJlmn8AClxJYgz8Zkv0oTo98Wz+Fnv2XbYH0yicBD3e+F+L3oa7vHpNJ4M9nYm23FA2oSUqVZWWGKuv71N/5oseOOWLNypVFo/IiuqjGjwNIX53cjub5YIXde0wJPkZOq0V+hDT34TURasi09+lDo/umVhp15nEENumkkvhKe4rumvp8yOzk8YEXGaVfmCHHM8Oj0Zn/8yHp1dvDon316pvPkIlpXxd2Hj+GjNtNE+DPtsZzfu7ff4s6fbvd24/2ywuzsZTPo7fU5Lez+8b/H/5AuuQooAPoGf06TSzA9T/IqpVcCzHqsSRHADXjKZ+SE6Htfi4ijT4HTTAZrG9AH9AD1WTsq/xHvdlGcXh4ejszPceTscvzl+8xJXo/H4ZIz/56Mxgn14PjpyP16f/lI+OR29OaKxDdOXN29uKKRKgevSjsuQJetUE1fy1bgpBG26k/emh4V1lYa8EsLPy9+JMyw8uC2+DxOJmGUjY5A1QzYWWW6UiJksc87HXNiMTTTyJHItsiRPZPxV4f5lG8ci4zI51PEDXPaFVCKcGS6JQ+FYjjCRgeKVjDGDLbQRzJMsndmNa/orNNHpsec8ZuNCvsNCGPJYw6MPoHX8gAC+UBLzWTmFydhVnzuWFXuCT55u7/cH06cDzhG2vb3dyf6U7+xs7+/u79PqC2Etn9VzWcCN4cuNpV8KJYyMWKIjWOR3KAShDN07Btzi5DaZWNj7beBoPED/VI/82ErMgl9G9XsL4ff88JQN9ljC1Sx39/lsTQkqvCBHV3mSUOLxlQ+Se8InRs6kuo2VMnKPRi+GPijGo/9ejM5wRbQ2sMGQanpMbglW4Qtz/clxXAjwCQDAigTqQNFnTwqqTyAQV7Y+UBbgYmmhTPjWlFP+Y0+K1W+ZUSfNpkYvGqEUebDDHsmO6GwBfODegmfRnE24xQSYkIY/GUaRSLPwVaHJJ2yOVC3M4w4bxrEkIXnCEI0givmEYhiPYwpdT2CaI5TBjMzmOs+Y0pmM1nDCSpVNa6yy2Ku6USg4wPn9fjKMshzMOTHrUVh5S8FiYR/w7DXX5O68pjSn0qXKeAQpgB+WUKMBrERmgmwSALBIR2Qui8SjynFVxqpXI5fuXntmXCnCs4jn9gFxd5og/YROtOrBlSiCzxIm89nIWaM0U5GR8JDEdpOLUZW5ysBnUymSuI3dNnbb2H1g7K4/HBddTfHUQZ/eJvS5UBwNpzaueG5AH+O8R2lWDvJI0htyi0EhBUT6+e05AvsDtZCWic8ptXPfER/5Ur7B/LCyh78/IfhRGathC2LQ6dFLMEUmEvGB43vFsVOUV9XO5movtJlIOKi6BSIiaxq21DnjUBn6QUWccLvFYi2s+olabeRHjoiw1mdAWlXFYaqlylok2SLJthq11ejHqUYtkmxjt43df2bsfhFJVly5aClwks0XC26W3tOK534jEgNYub/OqpBzplpHK0SMVRgraCKHYNLvTXrTvUgMYj6In+7sT/vR0z7f3evt9SaD/l5Qr/WXqziugqwZUzV7ezs6FQPEXQHH5QrOZTOt4+b2X+7eO1Bao9RT4WboHCp9v8KOg03s+EZnkA2EgR3NHduLF+NX/r2GJ09607mJBMFsrzr/1oYgJfkwNC1t1kLHFjq25actPz9M+WmhYxu7bez+M2P3q6Dj4D7oOPgK6DhgBLGmBLH+SugYA3cQNJvCKJAhyqFeRbAxhSi4KnYfi7DPuJmJrAJ6DRTZ399Ekedas9dcLUuwZBs7kWqlLkpvGLugsaYciwGczZAiFUPWkkC35FVyIQiTwn9YIhfSxTEJBLpmGQ6nGaTyMVP6W7WKVFGSg0OXFBJNe68aPibhTmJK8A8U3D7oDIn6O+5xFtb6U/vBbEwSvyKJ2ehzJATFfLX/u3vbKYFjMG8oXZx5W99xXMDvmXOFNkJ8Tn36qiBoC9VbqN6W+7bc/xjlvoXqbey2sfvPjN2vgOoFGrobqmPAg6E6xna2WYWlXpBz/d8RuwuVggPn3kxHDqvHKwzucAVcqTj1TzmETrgfBF06lu8OliKbdBtn9EN/xjb0Z1q7181T8DcBHfsn7OjZzk0CcvMsS+1Bt3sNa8KKNx2eyg6SHAyaLZX+1In0ojuBCm/JTnQY1UciDWDD0+OiEek4/RtJLu7zoSPureEkJmeGVdz5gy9SLs9EL9GjME9miw6FF+7mboPFFL3GT9aN7jj32pAPcl2Y5ObPy+IJ3SHLber74moYz8DpmojFQebyK40zAuZ+9Y1vNVbFhl4J9DcWO6FhffZccIOuwZ+SefTz2/PHbEZw1KWD3BISFpL6BwTUKVzEpbtheWKEJrkKZHQ+mzvGh40zORRebJpAYPZOnQnBLo8LJbxBHRgjcTuV0iThcgXNev+otE4srkRCJbKz0iQ5noxVFxrq8sa8x64cur5BKlwu3N3OOxWyI0lZSlJZpzGFiK4NZJdpKRevyfWtTPyrpBZ6aqGjZh+vceFVexn5M94RYpxI8MQ6bX3z4p5eWKNHTRbuENV1HkgTBR/Nk1RRabVv5qNBLyR6TT7eqbdziVrbnMZ8amMWpTKJ2TGL5lpb8W/GyHUoDC5nOaLom9n6RIuGLiLC/naNpdAvGcoQyNHx9wqBobwz8QlVbgdctN9DcSH5q7MsYv5X9NUx+7Uhs7t9iQJLI2Md2W/mmRYMacHQ5wBb8O/rFzkWYptkcHnAO8Dhyv4uExSM1vKep3VrVnfku24OlYYIrPpPPtID/+NgleCKK+Ye0OhqDNIwAe/qbBl+s4IWFbGGssotg3UNbvKbaNTONb15fqsXn1RP/27yksTD1c7KiUqW3ztL35FJ/j559y/KeG2m+REzTQGFyd3cskXPUHfy5wVe29zpo63oucBfPHWx6lA3ehrXpTkUUyeUAkWTV7uojub0TSdtnQueEfbbIs/SCxeJaOcp/NEJOkIzgzEIWwtMyicyAT23i12uzF3AeGBJdqXfNi/OVGi4JHpO0WFv0bapCGahlo1O8+LZb7ro3c5gmVMyLDsqjQ3QtVjkCqtRXOYLRt/U3uMRsbRR7hMXOjglSl1oB/2qWWUUk6uRCB3XvJiFPZnS9jM625rh71kLdrfF3jNUT1Ysvo5bCTIWvoGhcU3Yfh9teFs4F0lKTSOyLgCYqK3w+vh8gyKIqeKFhzazbjHJdmksiFB75N1np9PrbIeuXcD9VNsMbW6N+EuR3f4xri0/xm644/Vq9/2v+Ga6KD/UN3RT2g8joXLfx/jO8jKod5YUp3f3lnh6sPaNNdqVOXREdK6vaWuFuq0buv0xF9S3X75fNVKuAYUN6Rod7hRZZf3L67q+HhWyxY/dy6GHf499q9TlXqFarrYJAlx+ELS7sCYW+nEI5raCHNN+kN8sqk3feJ1C7VvVwL8ckR/yO5BAcQEFIdf9AbLCTHc= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get violation report run status

+ + + +:::caution deprecated + +This endpoint has been deprecated and may be replaced or removed in future versions of the API. + +::: + +This gets the status for a violation report run task that has already been invoked. +Requires role of ORG_ADMIN. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-sod-violation-report-status.api.mdx b/docs/api/beta/get-sod-violation-report-status.api.mdx new file mode 100644 index 000000000..2552b7ee0 --- /dev/null +++ b/docs/api/beta/get-sod-violation-report-status.api.mdx @@ -0,0 +1,100 @@ +--- +id: get-sod-violation-report-status +sidebar_label: Get SOD violation report status +hide_title: true +hide_table_of_contents: true +api: eJztW1tz2zYW/isY7kOTjClZsnyRX3YUW8m6k8Re2d48OJkUIiEJDQWwAOlE9fi/9zsASZGSHTtpZttm9GJTJHBw7uc7IHgT6FQYnkmtTuLgMJiK7FzH/5M6cfdGItUmO894lttgK8j41AaHV8H56TE704mMFsH7rSAWqRERzwQIZCYXW4EVUW5ktsDYm+DSCnOkVSY+Z4M8m9F8GatDq+Pwulzn0AgeB+9vHTUbGZnSXfBzMZOWgSnLsplg1jHCJtowzqrJzDgumckVy7j9iKE8YzNuGU+I7oKNhVBMqmv9UcStd5Dqt1waYZnRiWB6wk5HLz8Mjl+fvGlByJQbPheZMNaxL4mNlIPxrUDhAX7JGNc2mok5Dw5vgmyR0l2bGammwe1WYDz9Sh2rIgl2ckzLkkh6/KuIwLuYCCNUJFim8QOkxLUgbsRnPk8Toi8mOweTfm+nty/6vd297nh3PD7odXt8d2+nvx8fBKQ9SJVqZYUlxrrb2/Svubw3Zrn8vUqktSOymsqIBk9TmNuNbP9qidBNTQM8SU4nTluFLrxUwaro5Dep85s7FhY2TzJnAEM+mUkvhKe4quWvp8yOL04ZEXFaVfmcHHE0PDsdXXwYDc8vX12QLy/V3XwEq8Lq34ONk+OmWbtRv3OwfbCzG3f6HX6wt93ZjbsHvd3dcW/c3elyWtr73UOL/yefcxWSx/Mx/JomlWZ+nOKXTC0DnHVYlQ2CW/CSycwP0bHPDiM3/zjT4HTdAZrG9AH8CD1WTsq/xHvdlOeXR0fD83PceTsYvTl58xJXw9HodIT/F8MRgntwMTx2P16ffSifnA3fHNPYhunLm7e3FFKlwHVpR2W4knWqiUv5atwUgjbdyXtT0BUH8QGsH3Z74yjsxd1O2O9Ee+E+n0zicW9/Z7wdL9OOV0L4efE7cYaFe3fF91EiEbNsaAyyZMhGIsuNEjGT3hMoNwmbsbFGXkRuRVbkiYy/Kty/bONYZFwmRzp+hMu+kEqEU8MlcSgcyxEmMlC8ljFmsLk2gnmSpTO7cU1/hSZaHfacx2xUyHdUCEMea3j0EbROHhHAl0piPiunMBm7anPPsmJf8PHedr/bm+z1OEfYdvZ3x/0J39nZ7u/2+7T6XFjLp/VcFnBj+GJt6ZdCCSMjlugIFvkdCkEoQ/eOAbc4uU0m5vZhGzgaj9A/1SI/thKz4JdRvd5C+D0/OmO9fZZwNc3dfT5dUYIKL8nRVZ4klHh81YPknvCpkVOp7mKljNzj4YuBD4rR8L+Xw3NcEa01LDCgGh6TW4JV+MJMf3IcFwJ8QsG3IoE6UOTZs4LqMwjEla0PlAWYWFgoE7414ZT/2LNi9Ttm1EmzidHzRihFHtywJ7IlWlsAG7g351k0Y2NuMQEmpOHPBlEk0ix8VWjyGZshVQvztMUGcSxJSJ4wRCOIYj6hFsbjmELXE5jkCGUwI7OZzjOmdCajFYywVGXTGsss9qpuFAoOcP6wnwyiLAdzTsx6FFbeUrBY2Ac8e801ubuoKc2pdKEyHkEK4IcF1GgMQaExZJMAfEU6InNZJB5VjqsyVr0auXT32jPjShGeRTy3j4i7swTpJ3SiVQ+uRRF8lvCYz0bOGqWZioyEhyS2m1yMqsxVBj6bSJHEm9jdxO4mdh8Zu6sPR0VXUzx10KezDn0uFUeDqY0rnmvQxzjvUZqVgzyS9IbcYlBIAZF+fnuBwP5ILaNl4nNKrdx3xEe+lK8xP6js4e+PCX5UxmrYghh0evQSTJCJRHzo+F5y7BTlVbWzvtoLbcYSDqrugIjImoYtdM44VIZ+UBEn3G6xWAurfqLWGvmRIyKs9RmQVlVxmGqpsg2S3CDJTTXaVKMfpxptkOQmdjex+8+M3S8iyYorFy0FTrL5fM7Nwnta8dxvRGIAK/fXWRVyzlSraIWIsQpjBU3kEIy7nXFnsh+JXsx78d5Of9KN9rp8d7+z3xn3uvtBvdZfLeO4CrJmTNXs7e3oVAwQdw0clys4l820jpvbf7l750BpjVJPhZuhc6j0/RI79tax4xudQTYQBnY092wvXo5e+XcanjzpTecmEgSzi1ce7i0NQUryYWha2mwDHTfQcVN+NuXnhyk/G+i4id1N7P4zY/eroGPvIejY+wro2GMEsSYEsf5K6BgDdxA0m8AokCHKoV5FsDGFKLgqdh+LsM+4mYqsAnoNFNntr6PIC63Za64WJViyjZ1ItVQXpTeMndNYU47FAM6mSJGKIWtJoFvyKjkXhEnhPyyRc+nimAQCXbMIB5MMUvmYKf2tWkWqKMnBoUsKiaa9Vw0fk3AnMSH4BwpuH3SKRP0d9zgLa/2p/WA2IolfkcRs+DkSgmK+2v/dveuUwAmYN5Quzr2t7zku4PfMuUIbIT6nPn1VEHQD1TdQfVPuN+X+xyj3G6i+id1N7P4zY/croHqBhu6H6hjwaKiOsa1tVmGpF+Rc/3fE7kKl4MC5N9ORw+rxEoM7XAFXKo74Uw6hE+2HQZuO4buDpcgm7RsZ37arQ7ahP2Qb0Hl+Aomev9wkmDfLstQetts3MBvMddviqWwhm8Fy2ULpT61Iz9tj6OqONESnTn3I0QA2ODspOo6WU7SR5Ms+8TniXu1ONPJaqN8dNPgi5fLw8wLNCPNktuj0d+FX7jZYTNFU/GTd6JbzozX5INelSW7/vCye0D2y3KW+L66G8QycrohYnFguP784JwTuV1/7CGNZVWjvv7u22CkN67Lnghu0B/44zJOf3148ZVPCnS7uc0uQV0hqFBA5Z3ARl9cG5dEQmuRKjdH5dOYYHzQO31AcsUkCgdk7dS4EuzoplPAGCX+EDO1USpOESwo06/2T0jqxuBYJ1cLWUpPkeDJWbWiozRvznrq65xoEqXA5d3db71TIjiWlI0n1m8YUIrp+j12lpVy8Jte3MvGvklroqYWOmn26woVX7VXkD3NHCGYiwRPrtPXNi3t6YY0edVO4Q1RXeSBNFHw0j0xFpdW+mY8GvZDoNfl4p97OJIpqcxrzOYxZ1MQkZicsmmltxb8ZI9ehMLia5oiib2brEy0auogIu9s1lkK/ZChDQETH3ysEhvLOxMdUoh1C0X6zxIXkL86yiPlf0EDH7JeGzO72FSopjYx1ZL+ZZ1owpAVDnwNswb8vVORYiG2SweUB7wBHS/u7TFAwWst7ntadWd2Rb7s5VBoisOq/7UgP/Y/DZYIrrph7QKOrMUjDhLCrQ2T4zQpaVK0ayir3BlY1uM5volEkV/Tm+a3ecFLh/LvJSxIPllsopypZfO8sfU8m+fvk3b8o420yzY+YaQrMS+7mli2ag7qTPy/w2vqWHu05zwT+4qmLVQev0by4dsyhmDqhFGiZvNpFdTSjDzdpj1zwjLDfFnmWnrtIRN9O4Y+WzxGaGoxB2FpgUj6WCei57epyZe4CxgNLsiv9tnlxeELDJdFcihZ7i/5MRTAL9WZ0bBfPftVFk3YOy5yRYdlxaWyArvk8V1iN4jKfM/pY9gGPiKWNcp+40KopUepCO+hXzSqjmFyNRGi5LsXM7emE9pnRwtYM/8BasLstNpmherJi8RncUpCR8I0KjWvC9odow9vCmUhS6g6RdQHARG2F1ycXaxRBTBVvNrSZtotJtk1jQYTaI+8+O61Oazt07QLup9pm6GdrxF+KzH3SuPYdpi2/sm64481ym/2v+Bi6KD/UN7RT2vgioXLfx/gW8iqot5CYcug+j17rItGXzKAMmnBzQ5sl1Fbd0u3fckGd+NX7ZcfkOk0Yi67Rs06QPla/o64r5kkhRPzUve55/NfVd4pX7v6pxbLxD3D5UdB+AaRDVw1h3IaOY9Q/8Fs+tSlrL0WoN6va8JdDcjJ+T5kvLqAUJLI/AAD5LMQ= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get SOD violation report status

+ + + +:::caution deprecated + +This endpoint has been deprecated and may be replaced or removed in future versions of the API. + +::: + +This gets the status for a violation report run task that has already been invoked. +Requires role of ORG_ADMIN. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-source-accounts-schema.api.mdx b/docs/api/beta/get-source-accounts-schema.api.mdx new file mode 100644 index 000000000..ae188a9d9 --- /dev/null +++ b/docs/api/beta/get-source-accounts-schema.api.mdx @@ -0,0 +1,95 @@ +--- +id: get-source-accounts-schema +sidebar_label: Downloads source accounts schema template +hide_title: true +hide_table_of_contents: true +api: eJztW1tzEzkW/iuq3ocBypdcDCF52QoBppjitrkUDyFVyN2yLWhLPZI6xJvKf9/vHMltO04IMNTOQPVL0m5J536OviPLl1mQY5/tnWZHtna58tlZJ7OVcjJoa14U2V42ViGO7ee5rU3wR/lETWXWySrp5FQF5YjAZaYNZlcyTDBkMIBPusCzU3/W2inQCq5WnczH9XuXWZhVNMsHp804u+pkhfK50xXxxvvjiRKRtWBC6kJOq5JWPM43dzfUo53HO1IOVLErdzeGxW7xcHsweLi1PRpmV2fE11fWeOgEVlsbG/RvlcFRnUNlP6rLciYK+9mUVhaqEAGMRxqcOlluTVAmsLTqIvRzf07PC1F00SFlO2N9rsxrehrJqS5n/Ki6U6nLTmlztmdnKo0cK9cZO1tXvuODdOGpDJhoCvqfXV3BCoObZD0oNeQQz5yzTnTFoQq1M5BVj1hcMrLyQQxtMRPaC23OZamL3qoKsqpKHWXpf/RE93LdHXb4UeWB/OsoEoKOFixUgC4HtlDrrrvuuefaqO7YSU0SKhY5x0IBiue6wAoxtU6JSFLYqALP6634GZbobYonsoC+Ub+DpAzMFJzMP4EWReldAp0YjfVivgTxJEYQ6ha2akfJ4aON3a3B6NFAyq3Hg82dh8Pdkdze3th9uLtL3KcIHPjSL/GWzsnZGuvflVFO54KCoNT/hUGckrA9C8DMsUQHNfV3+4BpfIX9KXPi3EbNJK+gKO4IKZ4cvBWDHVFKM675vRxfM4LpnhxRKiM75JBeUfpC80j4jdNjbW4SRZl6ShXl6bPn+ycvj/Hm8Nl/Tp4d4YlonV0Xdt8gWgsKS4iKWJjYzyxxUuCz9MKrEuZQRU88SFQfQCFp/PJEHT/5mYcxEVsjWZcBKxL3G1YskxYjZ6crqcR5cxHEPd1TvY4Y0rupDPlEDKXHAriQpj9AXVRV6L5MlnwgJgpVxN3vif2i0KSkLAWyEUSxfgZCQhZUZnQkMKqRyhBGh4mtgzA26Fyt+mJhylVvIAl04Bkvl51CyQHJ746T/TzUEI7VXM7CJlqSiMk/kDlablW64yWjsUlnJsgcWkiqq7l1DhYWQ+imgxepHJG7PAqPmc9rKhaVwLlaXO5eRWGeBstjuaz9V+Td2xLlp8uqNQPnKiUfwsCmasTemLspVSQMktq8OM1q3DVPfOwQqiza3G1zt83dr8zd64OHCaGlUYY+m+vQ58TIGvZ1vHmuQR/H0WOsmE9ieJMc2REwSIJIf7w7RmJ/Uobmq4uKMOkPxEdxK18Tfr/xR3w/JPjROGvFFyQg2zFqMEIlUsUey72QmA0VTbW9zu25dUONADU3QERUTSdmthYSJnO1MSSJ9B0gX+XNb0FMJOqjZEgcKyBxNUW3stqEFkm2SLLdjdrd6NfZjVok2eZum7s/Z+5+EUk2UnG2JJzk6+lUulmMtDRO2kqBCWJ+ViialGNXXUcrREw0GCtbRQ7ZcGtzuDnaydWgkIPi0fbuaCt/tCUf7mzubA4HWzvZ8l5/usjjJslWc2rJ39GPbGKAuHPguNoguHywtlg9/oN5nRpRWaPS0+Bm2BwmPVtgx8E6dnxtA3QDYWBHd8vx4snhS6IP1kye7BYPaClp2XSYLgNDSophWFr70ELHFjq220+7/fwy208LHdvcbXP358zdb4KOg7ug4+AboONAEMQaEcT6O6FjAdxB0GwEp0CHvIZ5DcHGCqrgKZ0+prQP0o1VaIDeCorc2l1HkcfWilfSzOZgya+cRJqFuai8Ye6U5rr5XEyQgr9KF6haGuiWokpPFWFSxI8o9VRzHpNCoOtm3f1RgFYxZ+bx1nDRJi9rSMhFobR09moRYxrhpEYE/0CBz0HHKNQ/8IwzeesvnQeLQ9L4JWksnl3kSlHON+e/D2+6JfACwjsqF0fR17dcF4hn5tKgjVAXVSxfDQRtoXoL1dvtvt3uf43tvoXqbe62uftz5u43QPWEhm6H6pjw1VAdc3sbosFSzym4/u+InVMlScDhLWzOWL1YYHAYwSu81GHGTE4A8Q9iKO/XYUKZqQuzF6F7NyK3PVQ0LkNrA/F2anZ2tZa2T9PdWLgxHvfKdBdYxKWIKliaLrCS1ojtdHGYihpdCN7L+nGh71/q4qofV/n+nExGehBgjbaqXYklkxAqv9fvXyKEEDpXPVnpHioroijMjP3cy+20P4TfbiiJdAM2pj9NEPtvX6Tup8dOd5ryKhZhJh5DgM1MGYRQ4EsPX6RM134ptmbQTEQyHYEcTDHOryFihQbnN8+zexzTa/pBrxNXXv11XSKhW3S5yXxf5Ib5ApJeU5FUOFuEHV8Gj9zXgm+xw9H3EFtrzN7QtC3xREmHViVezbn3x7vj+2JMGJhrUO0JfitNTQuy+C1ChGvs/vyaCi3ibc/ZejxhwfdXLgJRTotRCYXFe3OklDh9kYzwGpvPIXYLNiktUlygaNXZvbl3CnWuStqXewtLUuAhffqwUF+urLvPezA3K9rgccpve+9NVzzVVBo1YQmak1Tk3lOcVnO95JJe3yvEv+bUupFal6n5+9ekiKY9zePF8hyFhUjI0rO1vpt5pNddokedHd4Q1esykCWSHKvXt/K5175bjhV6XaK3Ksd7826iscGvLhOxfAmP/bksxAuRT6z16t9CUOhQGpyOa2TRd4v1mZh2OSO6WxtLInUjy67uAq6yfC+RGCYGkxwSXGC0ZOPBDafkB/Yscv4DmvlCfFjRmV+fYlenmYXN/XfLTAy7xLAba4BP8sdNkwILuU06cB2IAXCw8D9XgiToUt2LtG6s6ky+z2toa8ghKlPx1V78sLcocOlJ8ADNbuagDBPaby604bNItGjnXDHW/JziugXX5S0tNuxrdovyNt+20ib+T9OXNN5fHOe8MeXsR1fpWyrJP6fu/k0Vr600v2KlSfibwo3ZpkZlOcifJLy2frxI598Thb8Y5VxlqI9GiltDRjHLhAhbU1RzVucTrfhgolIyEPbrUGTZKWdi5SylP9pPJjQG2KfTcQ9MKoe6BD0+Op9zlpwwEViSX+mzr9NFDouQRKOreuIdekUDqO6oT6QrxBj7aFPDeATPvCXHiqdzZwN0Tae1ATfKy3oqJELqjogotM/rWLjQNho1t4Vl6NesmmcxhRqp0OOOyU39mxGdeaOdXnL8Hbzgd58OvGF68mL63eJCkUNVcmTSvFXYfhdtRFt3osqKOlVUXQAwtcTh1YvjNYogZtK3LNaN+2mR79NcEKH2KIbPdm+zt9HldgHvK+sDWrdl8b+hXVsJzGYv4N86VnQiRhzq2FTEVu40S60cFu/x7zJTN4enpp9DhzCBWDT78pKOUKjBuaLXf9aK+vPTs0Xvwj0fzEbPaBxHSGS1JljzrUR27zD9oPQ+fwm0/AvRG6Wfn/qZ2aLhz/D4SdE5Adahm4a4fJDDosSBeNSztKT5/Sf1P02X+/szcqS8ZStND1AXxeJ/mT3GnA== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Downloads source accounts schema template

+ + + + + +Downloads source accounts schema template + +## Request + +

Path Parameters

+ +Successfully downloaded the file + +
Schema
    any
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-source-attr-sync-config.api.mdx b/docs/api/beta/get-source-attr-sync-config.api.mdx new file mode 100644 index 000000000..ae5a3621c --- /dev/null +++ b/docs/api/beta/get-source-attr-sync-config.api.mdx @@ -0,0 +1,104 @@ +--- +id: get-source-attr-sync-config +sidebar_label: Attribute Sync Config +hide_title: true +hide_table_of_contents: true +api: eJztXFtTGzkW/iuq3odJUrQNxoTgly0HyAyzJGS5VB5IaiN3y7Zm2lJHUkO8FP99zzlSd7ttEwhJ7UxS/ZJgt3Tul++IFjeRzoXhTmp1lEaDaCLcmS5MIobOmbO5Sva1GstJtBE5PrHR4DLyj230YSNKhU2MzHEzbD2fSsuGb4+YEa4wyjI3FUx8ltZJNWEc6MlR4QSzQHVqtJL/JbYsIQ6FF4KNtWGcWWLCbC4SOZYiZaM5kZvIK6HY0UGHncMnI2yulRVIwnEJLHmW1ZzsBqyYcJNmwlqmx+x6KoCIQUpzJhQfZUAZ+CntOu/VkDn9J1C/lm7KTk5//c/w4PXRG3z+2+Hx24PDs38xXripNtLNGahqxKdCGqDgNEuQsQsG6IC1rEgKXAgWu4kurDBgRyc+uyFQQCvKVA1Q0BitEXt1Y2+JgRE8BRJfWjLjik9E9OEWvJBzw2fCCWOJmURf5BzYbEQKHsAnieRKcaOBM4UACZOpmPFocBO5eY6rLJhNTaLbVb+K0h9ESHzmszzDHb1kb+vF5ovtnXRrb4u/eL65tZP2XvR3dkZ93tvu7UUoXukki6x6m5v4X5PB8BGhAXKg04VySI/neSYTWtX9wyLRm1X99OgPkbhoWb0zH2N+N0ZJM1K/LENt1Muo+rIOQEyS3GCGOekNEBbdK9U5N5CKpd2J611WwnBrMvGklx27zOLg/IThCtTZfR07oYoZ1YKTi9P9Q9SyDorw3S0G8P1CHB08hv1DInAEEchRDJ8E9wnyWwE5FWPqYVlguOmbJPvtlA0TB+WKHUCAJE6beXQL0jjp6HlZX305RTkXwqaWlhvD5yvCfk3GhBqaQPJCtmDtqhkxqaisJr44UfTXwS2dmNlHJFAw1lIezSBJsRGsySe1Rral5CInAmdp84zP3/hPoYRTc0I3rabbw3z/pnT2VKyXpHYrlBSZUY1ckOT+VPOL66i6n9FhyahUsmYy0joTXK1ywSYwkwr8WnY639yIX+0O6FJl86MAaYbQohTYKW4r636VHcsgSBJdKLfAHbrl9VQm0zuMwK54VghowtBQR4vxDdLKMatdXpvKW+rO3KqSJUCZ24W9l2WIBMcu+TV4YcEJvneWBgmsNyoqY2msWxOrg+gVPmFLgTsY88wu0iN8Q4tuP9ytUanILS7pr2up+5kEw7JDY8DBMTslROYt6Ag4fSoEiDPSKUEZqcDqMu18S1dtJl4qAJBl+zp9QHa8gpCNJwYAHEgoSOQENjKgeCVTrBkzbQTzJMv4onXNkguW6GyxlzwFfb1++0EZtKThyZ9A6+gBTelCSdjPyi0QpZQod7AVu4KPnm/u9frj533Oof1s7e6M9sZ8e3tzb2dvD7nPAIECYLu/sv8qlDBQrDMNkJKCHlqSDYWSmH+pMDd9QDQeYH8EeH5tpWaQl2FX2ICe8HL/LevvsoyrSUHf88mSEVR8cYaIs8gyjO2qdnjCJ0ZOpFonSgklDg5fDS+Oz+Gb08N/XxyewU9Ia2XKGEKzUCmGJYgKsTDV1yRxUOCaW2ZFBuYQaYc9C1SfgUI8TCRhofSf7NyCMSG2xrzIHOwI3NfsWCTNxkbPGqlUttAnsiM6G1C64LsZd1DnRtzimOE77bNhkojcxcfBks/YFCCHME87bJimEpXkma+BFvbPsQbyNMXU9QTGBaSyoCFFFw6ru0xE0xe1KZveqMvJ8aJTMDlA8vvjBPBMAcKVSKFKhypagojBPyCzt1xTuvMFo5FJ5zC7AVLCEWoOZjSIlhjUayadZaEcobssFB5Vrqsq1mKVpHL32gtz4DQ9S3hhH5B3bzMoPzGpVj24EiH5LDYtX43IG6WbQkWCh6g2bQ6rKneVic9gis3SNnfb3G1z94G5u/zwNBwkhKcEfbZWoc+FCqc02DxXoI+h6FG6PMoJY5N35Abi5QCRfn93Hs6DEC5/znEQ+Y74yLfy1aOQyh/++xHCj8pZDV+ggGTHMEhBJRLpgOSuJSZDeVNtr3J7pc1IQoCqNRARqqZhc10wDiYzhVJ0iGc3WKqFVb84NuVXBO/xbI0qII0VaZxrqVyLJFsk2Xajthv9PN2oRZJt7ra5+2Pm7heRZCUVZUvASbaYzbiZ+0gLz/3pOCyof+9YpRy5ahmtIDFWYayoiRyiUW9rtDXeTUQ/5f30+fbeuJc87/Gd3a3drVG/txst9vrLOo+rJGvm1IK/vR/97+2EuQIcVygILuu0TpvHf2BeI8ZY1rD0VLgZbN6hA8gSO/ZXseMb7UA3IAzY0dxxvHhxeoz0gTWRR7v5U2FMWjIdLOeOICWdU9Nvi1vo2ELHtv207eenaT8tdGxzt83dHzN3vwo69u+Djv2vgI59hhBrjBDrr4SOKeAOhGZjcArokBRgXoWwMQdV4Kf6NQ4qP/51mRLoNVBkb28VRZ5rzV5zNS/Bkm2cRKraXFjeYO0M15pyLSzg4ZVAqFoS0C1GlZwJxKQQPyyTM0l5jAoBXTOPh2MHWvmcKeOt4iJVkhUgIRWFTOPZq4YYkxBOYozwDyjQOegECvV3POMM3vqm82B2ihofo8bs8HMiBOZ8df67s+4tgSMQ3mC5OPO+vuN1AX9mzhWMEeJz7stXBUFbqN5C9bbdt+3+52j3LVRvc7fN3R8zd78Cqgc0dDdUhwUPhuqwtrPJKiz1CoPr/47YKVWCBBTeTCeE1dMagxOugFAK93ywhuA1kUHU9Wjddm9ketutXsX1F0+S8gKQHwi8fIXJYN/UudwOut0bcBu467bDc9kpX+lV+rqT6Fl3BLZaU4bwrVOfcriA7g15Bh0ytJEYy77wEXFvdlINoxbMTy8afJFy+br1HNRjnswGXnkIcUVfg4g5DBW/WFrdoTha0Q/0ujDZ7bfr4gndocs6832RG6xnIOmSiqjCh/oG0hkicM995R5S3VXw7L+3wuwEl/XYS8ENXpui12Ge/P7u/CmbIO6kvC8sQl4hcVCAzHkLIUJ1bVi+GoKbqNUYXUz8a9/Dxss3mEdsnIHC7L06E4JdHgUjvIGCfwoVmkyKmwQVBdz14UnpnVRciQx7Yae2JAaeTFUXLNTljX1Pqe/RgCAV/Djzdzfeqzhc1JDYv3FNUJHmPXaZl3rxBb0eK8Q/SmqxpxYTNft0SQpv2svEv8ydQDIjCZ5ZstajmXt68QI9nKbgG6S6LANaIsjRfGUqKb32aDka9GKk15TjvXpHFwWa25ivYcxCT8xSdsSSqdZW/JMxDB1Mg8tJAVn0aLHodkJMGRH3NhdEij3LWMYAEUm+Y0gM5YOJj7BFE0LR/rCEUvIjeRZy/iMM0Cn72NCZvr6EToorU53YR8uMDGNkGPsaYIP8vlFhYEFuow5UB3wA7Nf+p0oQBF2oe57W2qpO5Lu0B1tDAqL6+235wH8Y1AUu/MToAa6u1kAZRoRdvUSGtygDLexWDWOVZwPLFlyVN9PQJJfs5uWtfsOJjfPvpi9qPKyPUE5UNv/eVfqOSvL3qbt/UcVrK83PWGkC5sVwI7ZhOFgM8pcBr60e6eGZ81TAv/CUcpXgNQwv/n44ophFQnnGHUY1ZXUylYIOA3LBHWK/DYwsPaNMhLkd0x8v6SGhiYE1kLYWMCkfyQzo0XF1yZlTwnhgiX7Fz7YIL09oCEkYLkWHvYP5TCXgFpzN8LVdePaHDkPaGXjmLTqWHZTOBtA1mxUKr96B2MWMcQipeyIilTYpfOGCoUCJ0haaoF+1q8xiDDVUoUNTipnZkzGeM0u8/hw9kBf43YZDZjB9faMzqhU5FRlFJq5rwvb7aEO0xVOR5TgdQtUFACYWOLw+Ol+hCMRU+M2GNpNu2GS7uBaI4Hjkw2e7s9XZjGlcgO9zbR3MswvE6wu8eKuPVX9koRGEN/XhevvHFRb/uEJohzjHdHM8iEMjF36u8iNteRsfg2JAf7Vg/VQLc9IUnIMbbm7w8AbHvFv8+lMh8GTg8kM9wdHkC8HTvLt5p8uenAYdnpI9F/+EwloFyvNGNa+PGiL48U+BJxSwD+Z4EJeOkEgU/8AfMi1sWfk1DE6D1eD/6yGGNb8DWIQfQG0onf8DYnjbzg== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 or HELPDESK authority is required to call this API. + +## Request + +

Path Parameters

+ +Attribute synchronization configuration for a source + +
Schema
    source objectrequired
    + +Target source for attribute synchronization. + +
    attributes object[]required
    + +Attribute synchronization configuration for specific identity attributes in the context of a source + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-source-config.api.mdx b/docs/api/beta/get-source-config.api.mdx new file mode 100644 index 000000000..6d4268b44 --- /dev/null +++ b/docs/api/beta/get-source-config.api.mdx @@ -0,0 +1,84 @@ +--- +id: get-source-config +sidebar_label: Gets source config with language translations +hide_title: true +hide_table_of_contents: true +api: eJztW2tv2zgW/SuE9oPbIraT1G02QTsLN48iRfrYPLYDJEWGlmhbrUxqRSmJJ8h/33MvKVmyk6bNFDszhb84DkVe3vc9l6auA5OqTOax0ftRsBWMVH5kiixU20YP41GwEuRyZIOt08AN2+DTShApG2ZxSouw5MCYL1YUqZA6EpnKi0xbkY+VsLxChExJDE3Go5n6b6FsrqLyeRwJOcxVJlKTFglY0aNbll/IBMt4D5mmyZRmJVKPCjlSIs+ktglLYTtnui9y80VpcRnnY/H+8PV5f+ft/jshi3xssjifitgyG3EGLnIjQpkk2BKj/Q/7HcicykxOFHgiya+DmMRMZT7GI40H+C+O8N2GYzWRwdZ1kE9TGrV5Br6Cm5WgJB9s5Vmh5lV2DPGOSukx3W8BxWTT2R6JAWPqK/usBEoXEzJORNO0wccwpgUX+MgKkiTHxxd68Pu4ffyRl+AjpuFh5oa33+HvmGbDvCtBSB+fJS1O8BHRN50En25uk8LxSEpkq9AXsp0zWkfsD4U24iKWg6SaCzWP4gulV0Scw0RQfaSGskhyWnwG/s6C4OYTqdCmsCd4guDrq6v0p8lAX8BLtQpzuNaOymWcCDP4jP9JCqNzpXNaRJzFIXtH97OlldeLKq0WphlFRB67fZ0pFhW/qImwYoXXQJlXcpImtOrNzqttcgpbi6xfJ8n9dH99ewBHTaEJiMICCDO8JTgimcvGji/2TDaZsfQOHL1s9cMcehc78EsanIq2/94SEf/12nzZIp9tsRyLq1rCgpXCvmxlKlHSqqglSIqXrXriaImrSaIxaZzn6Va3e3l52bEwUGpinXdCM+le2ahbjZwjO0zO185XOxhu/XKmz/IXe7FKotI3/kPhXzI2jqNI6SabYWKKqI8I39XkbBVTA2PApW65BOLX/CJedJk8f8HWv8yb537bvDl6/+5BxrkOaEf+SyzQl/O6lKBNTGLJuRO0NuAzw7yw9Mhz6+WlkYs6Nch3zibBwANsQvQa7kThd5c/0eSGRy1KML+WHjm/wsPSsWpizRWl8/NcXRHZM7jKWR7c3FB2am5ZGXCmkqYFiSURN0yG3CR9MJTR4x/VLUgLbyjVJuokTYyMvmGzWaZybtGygtajbhIBIXN42aDI1YoYysQyX9rkxFvW2JufYnO3TkV7IGLv99aD2ObknuUyt7mbbKvaXFm4vuMpZf7qyVvkWfboW1Jnc8v3PEw0kZk11euJXys4wWqETVkvTvbp2wDqcGavBYst0tRkwAsn+yC6++vxmyNn7jzOOddVmnUlgB7iaW91bbFgnGiPAX6HBtrikMEKvjonyNj+qFflJBfUYwWFZSsCOvLO8ubjsUcYmK+uUir0nR9Xc1SWwQK3VLuJspbgjhsflEDJzW8UHDCI6I8jJ8EQalHRFvM945gV5VT1dHE35KgBZ59FPZGRMjE1hZBQWVZoNq60KyIyyupWLsYSsS1DwEXrLEy76qjtMs2P01TEFt820TfU6D04XHuUwRUhCKsMrhkpAYoXccTuaTLSrcMRw5lqOw3d9lZXO2viFWL20CFZAiEsDPlkJsMvoLUf3c/QiY6xXpRLCAeXcXjLtmpDycHz1c313vB5T8r1f/bWNp4NNofy6dPVzWebm7S79496OpBZJqcLW79WWmVx6BAZB0OGhEueAgZKd4pzNbH328Cj1G/CSB4BlmKW/ky5fAWJ99X2B9HbqMF6OZpTgm6fHBEcLZKECl+Vih3h91k8ivXXcPLO7l7/5OAYI4e7/z7ZPcI3orXQ0/QR2joitwSr8IWxuWSOvQCX0gqLIhUiLXXEE0/1CQSSvveZYV2uLlM0PJMSy2CF3/2WFXXSYpiZSb1p4mQKZYlHcUd1VpAwMTaReTgWAyqYAiak6U/6iL00bx94TT7xSexxR/SjKCYhZVK2VBM5pcwrIyoLsSMwLBDxihsoU+RUieJQNW0xU2XTGrPEfFA3CgUHl+z7/ATIoABzLGY9Citv8Sx6+4Bnp7kmd8c1pbFKp6hCwBzU6k2hxoxLPAoumhArfDoic1kkHl3OizVn0U5Qrze7xM1bx8xObvhZKAv7DXH3IUH6abNo1YML5YOPU6XLRmyN0kw+I/lKyYv9rMpcZeCjqhOiXMbuMnaXsfttsTv/8NCfOvDTiiuOFo+TbDGZSHQs7Gn+OUkrBSaI8tRidhLh27AmWiFiosJYQRM5BIP1tcHacCNUvUj2oudPN4fr4fN1+WxjbWNt0FvfCOq1/nQWx1WQNWOqZm/fNpGKAeIugOMKDeeyuTFRw1tJvZkaUlrj050SN0PnUOmnGXbsLWLHd2hc9gwIAztmc9ixpH9ySEcbQ2zN5ElvrgWjoHWdQz6WOUNK7oTUFVqYJXRcQsdl+VmWn5+m/Cyh4zJ2l7H794zd74KOvfugY+87oGNPEMQaEsT6M6FjBNxB0GwY06+yIiygXp3P/yhShn0us5HKK6DXQJHrm4so8tgY8VbqaQmWbOMkUs/URekNcyc0NyvnYoJ0vzPSaXMMdEteFU8UYVL4j0jiScxxTAKBbjZt9/lnaBczpb9Vu8Q6TApwyEkhMXT2auBjMdxJDQn+gQKfg46QqH/gGae31h86DxaHJPEBSSx2r0KlKOar899nt/22ug/mM0oXR87W7OF3nZlLjTZCXaUufVUQdAnVl1B9We6X5f7nKPdLqL6M3WXs/j1j9zugukdDd0N1TPhmqI65nVVRYak9cq7/O2LnUPEcuIt2JmSsHs0wOOMKuJK/A0o5hO47bgVdh9Zt9zqObrrVNRDrx9theSXH9QSOxSJLAnfNyG51u9ewHCx205Fp3EFCg/HyqTaXfOVooPh21Hwmgp19ZNIEupfpm44O6zrjG4Uu9zFxp3mWjhy3vMP0Vcp0FYlMOoUkwpFZoVtj3rV4GCym6Ctalmd32JUW5INcJ1ly88dlcYTukOU29X11N8wX4HRORBLhE5kLLgBCbK8T8LPtEhfdKuM7P7U5RwTUHYcLM2fFh34iWF+8BUTT1sUrJTN0Ee7WzKM3H48fixHBU04PhSVkrGLqJxBgH+BGnP765Q0SWsQVKTPFaMzC9Rt3dCjcxDCBUsSZPlJKnO57Rb1DXThEIme10yLFuYNWfXpUWjBSFyqhkjl3Hy6OdBda7MrGusdcHrmPiDVdkuPRzpku77/RNWSe40XktlCcpqVcsibXQ5n4R0mt7ai1mZp9PMeFU+1pmMSUPUPEPJGQiWVtPXhzR69do0dNF0aI6jwPpAnPR/NmVVha7cF8NOi1iV6TjzP9cRyj9jaXCZfqhEXpTCKxL8KxMVb9SwhyHQqV01GBSHswW5e0aZsjor2+WmOp7bZsx20gSebvAIGhnTPJAVVyBjLGnalw2P7GlkVe+I1vv//WkJmHT1FwaWZkQvtgnmnDNm3YdnnCev5dPSPHQmyTDJwHnANsz+zPmcAzWsuNjtatmZ/Jd3kNlY8QrDIVm265f7ZmSbC8Ic4PaHY1B6magHh114yu8ntaVNQayiqPEOY1uMhvYlBL5/Tm+K1+CKX6+leTlyTuz05a3utk+qOz9B2Z5K+Td/+kjLfMND9jpvHQmNyNt/U9RN3JX3lMt3jyR0fTY4VPPOVYZRSOHse9mEQopk4oTWROXs1RHY5jxWcGqZI54cMV8iwz4UhEe0/hj86QCY0yzEHYWuBWOYgT0ONT7XJnyQHjwCe/P4X/beHvWBi4JHpQ1REf0cbpEGahFo5u9+LZZ+N7uSNY5gMZVuyUxgbomkwKTe9Tge1iIiRc6h6PiGIbFi5xldfrWQTD0K9aVUYxuRqJ0OFmJpvY90M6jkanWzP8PXvB7tafRUv3WoB/BWEmyKHy745hXhPa30cb3tYeqySlJhJZFwBM1XZ4u3+8QBHEtP8BxGSjrl9kuzQXRKiFcu7ztLPWWW1zS4Hx1NgcbW+N+GuFtrj5pgmr8taX4uad83p2Nv8zvr/nix11Kd2UTuNIhYXrrFxfe+rf9iHNbPHLfLPWNihfBSqbW7RCY+ifVl1f0zEOdXs3NOze2KMWCh7hXsVxb2h8Rd+1Y7Yf/drcHZJ/UXSOUb1OWL4XxG/Zlf3ndwrx6NDr/zH/fjZ7mfEOFsoDUz2tM1CyRi9B0lsm7gyMWXEP3ClZbcnC70gkQ3Vy8XoXQXTzP480lfE= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Query Parameters

+ +A Connector Detail object + +
Schema
    \n\t "}}>
\\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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-source-entitlement-request-config.api.mdx b/docs/api/beta/get-source-entitlement-request-config.api.mdx new file mode 100644 index 000000000..86f62dead --- /dev/null +++ b/docs/api/beta/get-source-entitlement-request-config.api.mdx @@ -0,0 +1,97 @@ +--- +id: get-source-entitlement-request-config +sidebar_label: Get Source Entitlement Request Configuration +hide_title: true +hide_table_of_contents: true +api: eJztW0tz2zgS/iso7WESlyjZkh3HvmwptuLVVGJn/ZgcnNQMREISEhLgAqQdjUv/fbsbIEWK8iPJ7M5MSpfEBIFGv/trCLxrWRHmRmbz1uH1XevKCnOkVSa+ZIM8m8FYS0bq0OrchMIeGsGjVrs2lHDFp6L1cfGx3dKpMDyTWo2i1mFrKrILmjRUmcxikQiVnYv/5MJmsMVEToFSxqcWN3ETbQuIRMKGRqZIBohczqRlg3cjBtQsy2aCAbcGKDGxpMqMI8tCops7JthEG8aZY7TDiJJ7CGJxI+KV2Xam8zhiPE3juVsax7RhZSPLpKIxT/SD+qAGITBuSxYyzbiaP7Co2Gii41jfwgtgq85JrmKkCKyLlMNYjYW1vAOJSEykEhGwFLBjMKiaMl7jrO22qmngcR3qG2GMBJuQBNNYj3nMtJlyJX+nGev4ISb+pW/hjWmv6nCtAM/kpJDgeW3PB23m9A8q/ywUu5XZjJ2dn/w6OH47Om2zi7Or86Nh8QT29AMXV69ojHFwcI2ej+pD6aUREdovdJZ3jtcBLzXCplpZ8M/Du1Zvexv/q7up819W8XTmXZ0d1QQ9FhmXsUWqIcaZypAYOp0MaUb3k0WKdy0bzkTC8a9sngrYQ48/iTBrrUbIo3vCitRgaGbSSeD8oh6Ka7ZZWZTC8w2PL5AtN+QXcGP4vMHWmYkE6jOWwI+esGI9s5lILQUYOkbdRztsmKRgkNsZGFTp5aKKhVB1MhOJfSrPwlzSrHK2zTA8YLZQeYLZZ3h6Obp8M3wL//969v50eA7vvLcUj28Hp4MT+uvk7Jfh+engFF6enJ9dvWvmrGN6GvuYkSqSNzLKKW7Y1Og8hXGeOZnIseQ4Fi7lqLqeOuwXHoNiGDegKutzhiW/39pqsL21dcjObpUwqHDSrrU6lJBBoqprutVVAR9a6FzbrfFawOlvKe+XC0YRhbjLnLczndBokVNA1LHAlJTwyJNaVSPSHLATNJfiCmLpBDXlssfoGLe5nclwhqRsKkI5kcDbeE7vt7YKS4+irS0Gr2IsU+ILT9IYLd6w2aLdWi5Z5xoqj2M+xsWZycWqhUdRIbfnJWQFuTbLLXCmVezduOqEyH2Dlyqjoi/4+OVeL3jZ39kLdl/sT4KDSOwH+9si4gf7kxf98GVrAdyTMevRP6hFKM0yRYwnRfHFCKrIO9Y6Flw1onc0qdoPzJzkYEakD3kZKlPoKLJoXaXpELkJz2NIbhMeW1EREdW5wPdK8vg7GLuR4vZ+vkjzsMccuVuTZx7ikJ7v0/Ga1LnK4lEDhPhdK5qCKlNFCDWTPgKaFiWrlONORMa8KL44NqvTJSigPqeGjQpEEmv9GfL1Z0Eac7kGeQZlGjcmKDuvlALKcFC8KN9BXqvkbZe4qpn7BvPZA0WoUWauP97vxt5y9/iStyPoC3Xk5SaUoJUoWWxqa6QAAVhBRYtZUEC8nO3ykacVPqS1bxP2rpaWMAm1V6pYvTAtHtBOkbi+UjkJeIlMKzLbB1VUTid8Zqul3j5dWWykPNgLheJG6vZKxPqIx1CnYe+yUw3LoFBMZyVcL9QFc3AphBG8mf/PzNHEDov2V1txZUXrYE/s9V/yftDfDneC3X6fB3yyDQVhLKKD/f54HPZ6rQbNZpX7Xu9YkIfsrkO8R7HERDs0BjJJAMgzyw2gdyZrlYONdUT4WipQrIy+C/fWwV1ESPpIR2uhXZ3Z19BYBFPDsb9gglgOYaEvHARMtMEciSSL0k7zOrXyDJro7LBXPKoibRIG87fh4WegtR5Q1Bm6UhLWs2IJk1GJiNdsK/YBFbzYPujtTl7sct57ubuzvzc+mPB+f/tg7+AAdweHtQDIHgfmJwJwHgCWWEOfI38HhUBXb32los2fDrCJxhP0jwXIzS3F9PwyPGqAYGevjt6x3X0WczXNaZxPV5SggquLBjIDyR3hMyOnUj2E8o+HrwdXby5h5Hz476vhBfyFtBrwfaCKiqYJ3s6oSy8FuOWYWWJQB1Q0tuWpboFAXNnqROme7BwAVFLUX1jhd1+zokqaTcwKiA7duQz0yh3RaQOghrGEZ4CJx9xBTgeGEaOkWfDGa3KLzQSgbvO8wwZRJFFI6C5uXF+R8DkQYjyKMHQdgUkOoSyoGOgcy3kmQ1G3xVKVqzi5ADFvqkbB4ADOH/eTQZhhn0RiVqOw9BbPYoE4Iq+5OneXFaWRSucq4yFIgYUA1GgMaJiNQTaZWebTETUWkHhUMa/MWDUoiNy8dcwcZ5rehTy3T4i7dzGkn4BEK1/cCB98hAhLGLs0k89ImSaxabGfVZqrCPyy7dnE7iZ2N7H7lNhdfXnuz/n8W4I+O03oc6X80SEWzwb0MeQ92AT5Sa4PdIakg0gPkX5+f+mPLmG++JIWLdIfhI9cKW8wPyjt4cbHRYdclP6lLZBB0qPvZCETieiQ+F5y3FqixH5zt9fajCU4qFoDESFrGjbXuesRc6WoP7ZtFmlh1U8Zm/EbUWmYqT8QKgpSLVW2QZIbJLmpRptq9ONUow2S3MTuJnb/nrH7IJKsH9h7nGTzJOFm7jzNv3dHzjCh+GEQRoqQKw8vq2gFibESY7XqyKE17u2Mdyb7odiN+G70on8w6YUvenxvf2d/Z7zb229Va/31Mo7LIKvHVMXezo6kYgBxN4DjcgXOZTOto/rxX44ntxNMa3QzosDNoHNQ6ccSO/YO1vxqoTX+yjgvEJKtYUi11BHmNJib4FxTzIUJnE0hLyoGqUpq94udTARQoTsVsUwkBS9KAXTNPBhM8KcuFyiFk5W7SBXGOV5KwEwQa0TNGhxLgpBigpgPKBCCnUJ2/gPRqTfRdyF5do4Sv0GJ2fBLKAQGeonc99ad746AeYM54sIZ+J6DXtftcLy0Ag2By1kl7tzg8w0+39T4TY3/MWr8Bp9vYncTu3/P2P0KfO7R0P34HCY8GZ/D3M42K7HUa7px9P+G6RQqngN3CUiHdIs6WmJwwhXgSv7iNuYQjve/W11/0bt7J6NFt3qP1xsvCItrUK4VcEzmJobFsyxL7WG3ewe2A5stOjyVHemvCip92wl10h2DwtbkIrw04OIOJ9AdcLeBu8phJDq0y35E3One3+lqWbABnRM/SFnxhIw6BxmZI9Nm4PzeuWgYWEyhs/jJ0uwOOVNDPpDrysSL75fFEbpHlnXqe3A3mM+A0xURUYSP7fLif+VGb+P6/7K0YOvWa2x2htN67JXgBnoE92vGs5/fXz5nUwSfFPw53qFiQmK3AOHzDlyEktugONnHRVRv3EUeZHxQ++0Eg4lNYhCYfVAXQrDr4rrpKWT9c0jTpFJcJCgz4KqPzwrrRHgzCQtiZ6lJdDwZqS5oqMtr655T8aMuQSr4M1leaT+WmJMkFnGc40Wkpo9dp4VcvCLXtzLxj4Ja4KgFRM0+X+HCqfY6dHdxQohod9/Jkra+eXNHL6jQw5YKRpDqKg+oCc9H/RevsLDaN/NRoxcgvTofH9R7uhNcX8ZcIiuuiI1YONPain8yhq6DYXA9zSGKvpktuogcUEQEve0KS4HbMpAB4ETi7w0EhnLOxMdYpwmmaEBwKnIh+RtZFmL+N+iiI/ZbTWYavoZyijMjHdpv5hk3DHDDwOUA6/l31QodC2IbZaA84BzgaGl/ygSe0Urec7TWZnUi36U1WBpCYJWo2PTQPRwuE1xxN5Ve4OxyDqRhhNnlb4B4yc/TwpJVU1ZxQLCqwSa/sYZKuaI3x295QIXV868mL0o8WJ6jnKl4/kdn6XsyyV8n7/5JGW+TaX7ETOOBL7obbes7hKqTv/J4rXmuZ+kOM/wLbylWCWNDB+OuUWeVj2KQUBrzDL2aojqcSUEnAqngGWK/NnqWTigS/RVn6PuI0NTAHAhbC5iUj2UM9OjMutiZU8A4YIl2xWebU1tCH7PNoMMUHfYeP8ILwSzYoOGtC3j3SftO7QIs8w4Ny44LYzO8FJwr/0lPnjAOLvWIR0TShrlLXNAUKFHoQhP0K1cVUYyuhiJ0qFUxiT2b4GEz9LEVwz+yF9jd+pNmUD1aEVE6dkGlIOciJs/EeXXY/hht8LZgJuIUW0TIugDARGWHt6PLBkUgpvy3odpMu36R7eJcIILtkXOffmensx1QuwDjqbYZNLUV4ngr/6kfFa765t3y4H3z/ezm+9k///tZj06wreymeDiKPp+7NtcdM1y3/DEDzD6U9PHe/ScN0LvOIGBw1d0dnqph673AYZiGRzb4zVDRVeMT7OZO1+ho4rOgUx06f1se3DR/ocIeuTwTORlisPN74Jb/A7daLP4LGuVdRg== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +
+ +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. + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-source-entitlements-schema.api.mdx b/docs/api/beta/get-source-entitlements-schema.api.mdx new file mode 100644 index 000000000..c6b1ce29e --- /dev/null +++ b/docs/api/beta/get-source-entitlements-schema.api.mdx @@ -0,0 +1,95 @@ +--- +id: get-source-entitlements-schema +sidebar_label: Downloads source entitlements schema template +hide_title: true +hide_table_of_contents: true +api: eJztW2tv2zgW/SuE98O0hR95OE1jYDFw23SQQfrYPNAPaYDSEm2zI5MaUkrjDfLf99xLSrbjpGk6xc600JfWlsjLc588l6GvWoWc+NbgrHVsS5co3zpvt2yunCy0NQdpa9CaqCK82zeFLjI1U6bwx8lUzWSr3cqlkzNVKEdCrlraYEYuiyleGbzAN53is1N/ltopyCtcqdotH+YPrlrFPKdRvnDaTFrX7VaqfOJ0Tuvj+clUibC8YEHqUs7yjGY8Szb3NtTT3We7UvZVuif3NkbpXrqz3e/vbG2PR5AV8fxZKjdfAAprv6EvDwBC44UdC7WwgvCVFRaofl1I//fE2TJvXZ+T+j63xsO8WGhrY4P+WxV/XCawvh+XWTYXqf1sMitTlYoC+o91RlATawqsyljVZdFL/AV9Xqyt0zap2E61zzM5JwztxClZqLS9tFp7ZlM91ni4pItvM1rfhu9n2nuM863ra5ihfxvcF5kmA+w7Z53oiCNVlM4Arh4zYnK38oUY2XQutBfaXMhMp91VLWSeZzrhSOt98iT3at0fdvRJJQVFmqO4LHQwYqoKqbMXNlXrvrvpulfaqM7ESU0IFUNOMFFA4oVOMUPMrFMiiCQfkwo8rrviW1iiuymeyxT6Bv1eRGVgpsLJ5A/Iopy5D9Cp0ZgvqimIbDEGqDuWVbtKjp5u7G31x0/7Um4962/u7oz2xnJ7e2NvZ2+PVp8hduQkmCauLZ2T87Wlf1NGOZ2IzCbwyH9hEAQIbM8AeHFM0YWa+ft9wDK+wv6Uw2FsrWbEKyiQ20KK5y/eif6uyKSZlPxcTm4YwXROjymHkSByRI+okEDzIPit0xNtboOiTDmj+vZy/9Xw9PAET472/3O6f4xPJOv8JtihQbSmFJaAiliY2s+MOCrwWXrhVQZzqLQrnkSpT6CQNH55oA7f/NzDmIitsSyzAjPi6rfMWBYtxs7OVlKJ8+ayEI90V3XbYkTPZrJIpmIkPSbAhTT8yRB1JC86h9GST8RUoZC4x10xTFNNSspMIBshFPPnECRkSpVGBwHjEqkMMLqY2rIQxhY6Uau+WJhy1RtIAionGHG47BRKDiC/P06GSVECHKu5nIV1tESI0T/AHCy3iu5kyWhs0rkpZAItJJXWxDoHC4sRdNOFF7Eckbs8Co+pxtUVi0pgpRaXu9cBzMvC8rtElv4r8u5dhvLTYdXqFxcqJh/CwMZqxN6o3BQrEl6S2jw5jqrdVSU+NgmVpU3uNrnb5O5X5u7Nl0eRpMW3TH0216nPqZEl7Ot481yjPo6jx1hRDWJ6Ex3ZFjBIpEi/vz9BYv+hDI1Xlzmx4+/Ij8JWvgZ+WPsjPB8R/aidteILAsh2DBqMUYlUOmDcC8RsqGCq7fXVXlk30ghQcwtFRNV0Ym5LIWEyVxpDSKRvg/wqb34pxFSiPkpmxaEC0qom7eRWm6Jhkg2TbHajZjf6eXajhkk2udvk7o+Zu19kkjUqzpbIk3w5m0k3D5EW35O2UmCAqI4LRZ1y7KqbbIWEiZpjtVaZQ2u0tTnaHO8mqp/Kfvp0e2+8lTzdkju7m7ubo/7Wbmt5rz9b5HGdZKs5teTv4Ec2MUjcBXhcaRBcvrA2XT3+g3mdGlNZo9JT82bYHCY9X3DH/jp3fGML6AbB4I7ujuPF06NDko+lWTzZLRwVU9Ky6TBcFkwpKYZhae2Lhjo21LHZfprt56fZfhrq2ORuk7s/Zu4+iDr276OO/QdQx74gijUmivV3UscUvIOo2RhOgQ5JCfMaoo05VMGnePoY076QbqKKmuitsMitvXUWeWKteC3NvCJLfuUk0izMReUNY2c01lVjMUCKCUqkEahaGuyWokrPFHFSxI/I9ExzHpNCkOvmneG4gFYhZ6p4q1fRJslKIOSikFk6e7WIMY1wUmOif5DA56ATFOrveMYZvfWXzoPFEWl8SBqL/ctEKcr5+vx357ZbAgcA76hcHAdf33FdIJyZS4M2Ql3moXzVFLSh6g1Vb7b7Zrv/Obb7hqo3udvk7o+Zuw+g6pEN3U3VMeCrqTrGdjdEzaVeUXD93xk7p0pEwOEtbMJcPV1wcBjBKzzUxZwXOQXFfxFCeVgWU8pMnZpBoO6dwNwGqGhchtZewEFEWc+v19L2ZbweCzeG497le6zxUi4iC9ZG4LDmiO94lZkKG11PHrR6YbLvXen0uhdm+d6yqBbpQ8Q12Kx0GaZNiyL3g17vCqGEELruylx3UWFp3tzYz93Eznoj+O+W0kg3YUMZoAFi+O4gdkFddr7TlF+hGLPwEApsbsokhARffviiZBPvKc+hnQhi2gK5GGOdHwNijkbnF8+juxzba/pBr1OXXf91XYKgO3S5zXxfXA3jBZDeUJFUOF+EH19PD6uvBeFip6O/R2ytLfaWhm2J50o6tCzhis6j39+fPBYT4sJci0pPNFxpal6Qze8QIlxrh9V1FZrE25+z5WTKwIcrF4Iot8U4g8LigzlWSpwdRCO8wSZ0hF2DTUqTFBcqmnX+qPJOqi5URvtzd2FJCjykUQ8W6smVeY95L+amRRt8nPHT7gfTES81lUi67c1joorcg4qzvNJLLun1rSD+VUnrBGkdluYf30ARTHuWhAvmCQoMiZCZZ2t98+JBXmdJHnV4eEJSb2IgS0Qcq9e4kspr34xjRV6H5K3i+GDeTzU2+tVpIpQw4bFPZ6k4EMnUWq9+FYJCh9LgbFIii74Z1mdatMMZ0dnaWILUCUt2dAe0lfEdIjFMCCY5ItrArMmGAxxOyY/sWeT8RzT1qfi4ojM/PsPuTiNTm/hvxkwLdmjBTqgBPuIPmycFFnKbdOA6EALgxcL/XAki0KW6F2TdWtVZfI/n0NaQACpL8fkgfBksClz8JPgFja7HoAwT668vtuG7iLJoB10xVnVecdOC63gzi437ht0C3vqvrrSZ/9P0JY2Hi2Odtyabf+8qfUcl+efU3b+p4jWV5mesNJGHU7jxsrFhWQ7y55GvrR8z0jn4VOFfvOVcZcqPhopbRGYxy4KIX1NUc1YnU634gCJXsiDu16bIsjPOxNxZSn+0oSxowj9Kc4As0VLqDPL4CL1aWXLCBGJJfqXvvowXOixCEg2v6or3xPwTuIX6RbpKjHefbGwcj+GZd+RY8bJyNkjXbFYarEZ5Wc6EREjdExGp9kkZChfaR6MqW1imfvWsKosp1EiFLndObubfjunsG231kuPvWQt+9/HgG6YnL8YfLi4UOVIZRyaNW6Xt98lGtHWmKsupY0XVBQFTSyu8PjhZkwhhJv61xbpJL07yPRoLIdQehfDZ7m52NzrcLuB5bn2BFm4Z/gPbtpXgrPcD/uljTqdjtEoZGovQ0p21YkuHyQP+tWjs6vhoaKmvQ6cwBTyacXVFRyrU6FzT4/BTUer2YDCKYrSNY6SwWoNT/13iy78MvRX1H4rOBFZ+hxpb/xb/XLRqnx4I5NFR/JXtY/571PLPZm+FUR1AmvkygAoe5qGxh6X4TImhhBfh1GlpSv1rVMJeN9u/7VMsyTt28/hhcEZnB/8D9uYqwQ== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Downloads source entitlements schema template

+ + + + + +Downloads source entitlements schema template + +## Request + +

Path Parameters

Query Parameters

+ +Successfully downloaded the file + +
Schema
    any
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-source-schema.api.mdx b/docs/api/beta/get-source-schema.api.mdx new file mode 100644 index 000000000..ef5b6f1d9 --- /dev/null +++ b/docs/api/beta/get-source-schema.api.mdx @@ -0,0 +1,104 @@ +--- +id: get-source-schema +sidebar_label: Get Source Schema by ID +hide_title: true +hide_table_of_contents: true +api: eJztXFt327gR/is46kMTH0u25LtfehhZcdTalqvLpluvjwORkMQNSagE6UT18X/vzADgRZSv6912t3pJZBIYzAzm8mEA4q4m5yLmiS+jrlc7rk1FMpBp7IqBOxMhr23WEj5VteOrmn6satebNU8oN/bn2Am6nIqEJTPBdAOmO7LxgnVPmB+xrieixE8WF/Jb46cICM55zEORiBjJ3tV8pDHnyQxeRfAC/lJECfjZrMXiX6kfC2AtiVOxWVOareO7WrKYU9sk9qNp7X6Zq2HOUfekAZTEdx7OA+zSco+ah9uHO3te86jJD/e3m3te63B3b2+8y1s7rSMgtpotGpvYeoSNZY5XsKU19HK2rpG6mstIwTzA2K3tbfyvOgLyIFQiPDvWN66YSl2YPzVJg2ABLYBhcSs85MGVUQKThLT4fB74LtnD1s8KCd5VhZXjn4Wb4FTGaD2Jr9nxvapCVsnve0xOtMkQ5RfPjpmQ54yFLR8bjbuuTEF0Ipr4t6JHsg2J8EsH0Hph2InJiB5pokwtYDZCeMK1r2iVwizMYUJB9arM1UiJGFnyje84CTAwTpNX8MRtV5YqsIdEMpcHbhpweILv08gHW2F6pIkvYjaRMeORFcaPCgyXuVTOuaPVd4HzgS7oq3nAf012zQjslgfA9bNZhW4JDJ/6aiY8y+0MpOWxO3sbfr/NpBKaL5VPLJPQKjYcKmSRs2zcButF5IuBuOXQFqSdxjKdGxGWjCIU4VjEvQkZRuQGqScuRRz6SgFrqsD6WMpA8KjC+8eAT4EDj/w7mgLHQjMXs0hquzR02TwnzL75yaxo3h5POPYFUabTWEw1sQc0P+GBEsDwRPAkjUWRTR7HfAFtffAMtUrzIkpDzDzOaPipczHstp1hBx63e+eXvUGXfp90+5328Oay0z/vDgbd3sWAHg7avR86/ZtB+1Pn3IEnnQvnwxm2P3cunFN4c9br/W10CQ8uejd95+Kkd37jtNudAXa/7Pf+8SP8P+g4/fYn+DHsnF+e6bFHF2e99t/ox2DYH7WHo37n5Gbo9E87Q+w7+OT0O5e97sXQPNT0fugib92LU/jztN8bXd4sPRz8eNFefnbpDAafe/0TFHnU74MGbgqPgN3eCB71Ls5+vOl3/j7qDHAw5+SkOwQSztmNbZG/BGGd09N+59TBJpaXwc0n54fOzXnn/EOnP9DNCgpdZgveGhEebbNKQSuaVSewooZ+5yPM2GjUPalijx794AGz9qVDrAtBYQz2mM7nMsY0CGgEHmlcAShkgxVt6pihV+uXto9ic65UPZmBP05njKdg3xAgdWYkCpkZru7uynAuFdi2fePGIu9cFXs1FUjTaRyhf50ApnCTgsMbOiVTX00Egp8rbwV6lY0sFDkhwsYK9OLpqKMpald5gBnuIQ1/gso0mZP5iomIjwPQMtCEseg30Sp722rmAim/IlGIeiGP+JRYwmkUMGWxANo0jABEpaPnRAB1IAXj+krHpbnRNMTkZX8mPpYfljjxJFgNxj/DEotBIzJE+QAtkXpwEADGGhq8e88Avc6kB4hqJtPAo85gbZCoUAnYQXyfQ0udvyCUgrJDYoRCS2l0tFSYBoAIIDRnAKi+L0xa05nD2Cz7TAHX2jCb5c03GQwM9hZFMCb0RD4UKBPCuAnd4BGmG2oUNEm2hOwZ80YBcwI4PD7RzBScRkdE/GVDIv7WMfEh+33AZALpftUWk0b6d0PTqkaNpzwjjSBjpC66v8eGPIaZ0qZcCcavoKSzHWpkMAPlXUo/Shqsm4BqQekw65C0fNT4QgMWCDTOySY7O3EuzUDKznwW1CoGMIapJlWR8XyL0ZaNrlSDfeK3OsGC2kyYYz5kV99GOzNXtz7Ghcw8UcvYTIQQuNBlgGlIxhJe88j01IagbVyLW0z8yBr1GBfooxtOtHuaKKv1Z4KsRQQmzlWT3bOEN/HorUQnY1jOsBVGMjqZ7gG2Ry64SCRTFSz0PJoM/EhvTBzfZOwxd8ajKcw/GwCsso21WiNYesVaattcbWo5/SyuSASHY4OEIfaBh/6cRi4qNwdlRZGsjnR+WsIMx7AcDjOWEWupLORhcpiY5GaRrZvGMQJYyx9lzRWg4yGnohUozl6mTeRZpgmjNY2eHO0cD4OWp4l7nm8gQOYxJuQXoM4xczLBye6XY/5Kuy0DoxIrofQEBFmN1jUwVzN/bsAyN48KqwOzHNQdDJCOOUV44Ajzmrb5ahcbNHUnk/nEZELrCcLs1tKz6QPeIGjZjsuyPQLvjllXLw+K/lXMLBEqLTd1Ez8wX1TDB2WxLIpR/qrCHnL6VTasKFeZVdQm8ylrgCmmIeWtVbzpYFXhrsCT0Z4NJQasGFmJOOFJYsrl4Heq0NuaHSb1MQ0NbmOSPDjIV0YLmbLYRt+PA+Y317oNn/9XOi9g2OcsP441W3qxmWVzWLcH3NW57Ml5I5Yf8SbLyxNrnN+Ck1IhYWk9TcEYHutq6Uc9T6sLquVVVqGQZUNzaaCr5aXv4wvLVYvR63uqTk78aaqL1KuqkGU+P8nAQ9i+ABSexJyVums4t8x9yBfMlG1LAtzVyKjOKZgXikSmFFO7B+6yeL2qtFHVYB7ePTHxI8pdkDVmvjtDKw6X6ijLtZEHKq+vq4dmvDxV1kseqIbaAg24mp7Csx79B4gb/v3Q6511nIvqon1IZUdPxMGC0B2VSzVLuqyn1QHBJdP5SaasB2umGRPWnld0prLufbF8X+bMAeoTWGoiXIMIUzARk4wtiJBLxT9T9gv5HN4hX4/Pl1VoVS9WGQYijAVqKGPKyylXJqHdu7iAMNPLyl7XRe1U3lJ1+Xk2Y3jpnmiAmquINgswGsiVJfy9/UN3r3Xk7m834ZfL9ydH225zp7nzshL+LA15VEesjIkjqwBXC+9lJsh1wUWXA9lTQzqVAfPXT3gOAcSS9+QtSeHqPA0S/21KtbnxwZyESLdOVuhV669IfcKhSV6P9VUnR+G/AkPgvAWY/0yWTmnK3piZPF5YkA15mTIuwhe7xvqCm3VfcGn7paSaLyQMYhzTYmMDcu3GBg4Sa0ltiKCADgnblk9yI6Ftzyfkv380cKH15Hn1LtuRLIfqLDhksdBY3A9kGNnQS5OfPTX6NxOSjZJtPFTpV7YGK3FGhxkbEg4P9g+ak8mhu92EX+Nd/Ms98Pa3811W47eVXealpVZVOL3duiSbfWhEwz/vCVRgNVY8MwB6dvepsJtqCKBlY97mCe4ywZN64tNMFKLhdvOo3mzVW7vDVut4p3W8d9hobu/+E2WEdSRuuv0CPgIO6NiSeQE3O81ha/sYGGpZbgoWaDb/7yl67q7aZW5D4Ie1ZSeOwdrrrG9rQLo2lMH2sfQWVI2JIDb5b7nZ7ImE+0Eb1uFP6+4j+GV9GnNyT0Esu9IzlSOqT4YSlyZE0sZ4aleO76CJRpN94B7Iq+VrG2FQdzF3sZLdfcZkjvSmq+2CO+I2aqwYVhwIPt7fPmrtTvZ3OW8d7jYP9sZHE76zs320d0Q74qFQik+fAUJPRSRi38UCLMzIv0EhYMige2KABn8+7CQaz8zium0mpuGXJQDSNyGGfmhfst0DsOZomtJzPl1SQlQf4eZUlAYBpmXjy5uGiV7sT/2V2d3io5POR2d0hsA02xBDWhV06kQ2tQCrYAsz+Y04NgLQSQoRUP28wTYM1Y2sqpo1NJsTZuffRHvoYUZf0aNImk1iGZZcifzme8Le+Q3R2ISchX7PEwDKY44FQoNQNyAhiHlSPzOa3GAzADIift9gTl4ry/AqJT/uebrCiAQmKa3TbbEOEqrvLuGcXJXl2cgDyFlxUtA5gPNnQC83SYE5ErPohZm1GBbN/ADPWnNVFGaVRipdRAl3E1Old2VMFQrIr8ynfTryYCq7QuCJbLssYhXjIoW7c83MSSLpna5ZPOl3lwGEnzqJlr24Fcb5FG0UUTQSxZKmiUhmuUGdTatsuqzjM4j/gbf23bXvrn33mb67/LJvztaZtwR9mlXoM4rwNICMKXlWoI9eFESS2Ua67qQnchOXKAYi/fXzEBz7q4hoB/37HM8MviE+0ql8RYXDzod+PrZnd2zqz+cCGSQ9agkmEImEd0x85xyTorSqdqqjfZTx2AcDjVZARDx9wBYy1XvSaUQ7sFxt0uZM9OeEzfitsLvwFAHppIFXn9Me7BpJrpHkOhuts9EfJhutkeTad9e++/v03UeRZMYVeYvBSSoNQx4vtKWZ9ygtZ9CA2a88WOZyNFXLaAWJsQxj1crIoTZuNcfNyYErdj2+6+3vHE1a7n6L7x00D5rj3dZBrZjrr3I/zpys7FOF+dbzqLc78OxirLfzVCKlVy7/gXpjMaFN/SSHxDB3AODur3PsuFvFjhcyAdmAMGDH+IHy4qh/prejNHnUm96gk3H2MUbpvI/47qtkDR3X0HGdftbp5w+TftbQce27a9/9ffrui6Dj7lPQcfcF0HGXIcSaIMT6b0JHz9df0ExgUkAGe+w8O7Zhqo/G7c2JVwv0SiiydbTiTJWU7BwPAxqwpEqVyChXF4Y3aBti29i2pQ+OphAiIzyT6kv94bIfCsSkuBkf+KGf6O+RBNKNF3VnkoBU2mesvWWjmO8rFQWFQGLtVYKN+XjSa4LwDyhQHXQKgfoNa5xmtn5RPZj1UeIzlJh1vrtCoM9n9d+9VacEuvjhFoaLgZ7rB44LxPbIUBplX05lEHQN1ddQfZ3u1+n+j5Hu11B97btr3/19+u4LoLpBQw9DdWjwbKgObRvbLMNSH+nY8G+N2MlVDAdk3ky6hNW9HIMTrsAPcGt0kRTGELxA6bi2Zb593bqzVzvdb5mbCOCRuVbpHtrrNYFmMY0D6DpLkrk63tq6g5mDGbtv8LnfsPfiRPJbw5Xh1hjUtSIS5VcEYAPmXHbNoqNBuo59+hKNbJWIa82bY9k1BTNAZw0epWw/Q1iAYEyT2Sx8FE6P8S4IWFf8WVHrBplSRT6QaxQH979cFk3oAVlWqe/R0aA9A06XREQRrnG6wASAEM0XXlrU1oHLSXHar66LbehMseaw0jJPPrhF0Kow1MNmLfZB8Bg/mKVTM+/++nn4nk0RnlJ4SBUiY+HjegIc7BLMiMKfY0+QYCfKSPmdB07pjA66G5sEoBT2UzQQgl0V7i5jfQjkpHandBfI9Ts7g564FQGmzEaubTRO34u2QItb5TtE3lN6pHWEH+kz2/oD3bq56iP/mlOLSMtCdjW3cvGCXK9l4k+WWl1TqxM19X6JC63aK1ef+XbB55EEDxRp69WDa3r1Aj1cdMETpLrMg76whPgon6xy7ay9mo8SvTrSK/PxU/RZf5BW6mbvGjAf63eZO5NSib8whqaDrnI1TcHTXs0WfQVXJ4+ot7YLLNX1kHW/DkiS+DsDx4i0MfExZnICMlLXVMhtv9DMQlz4Qt+KfinJTI+vIOFiS0+66tU844B1HLCu44Qy/Ot8hoYFvo0yUBzQBtDO558igWG0EBs1rZWRn8hvUR9MHy6wSlTU/Fj/cZwHQfOL0QtsnbWBUF2ju+DMWTO8UMXQom88i8qyJYRlDVb5DSTk0iW9aX6zjVDMr/9r8qLETl5pwSvK3jpKPxBJ/nfi7n8p4q0jzR8x0hhojOZGw5o1RNHIPxhMV638KfriC/6Ft+SrhMJhjZNfAVMkNA94or8jB692Z3jFJ5bSBU8QH26iZcmQPBGW9+j+wtxZMqXv2WJgmcMqzw+AHlW17cicHEaDT5xX/Ful5oyFNHfdNNhnc2NXjEs4PN0L736WZi03gJmhG5TYiZ1sAF1hmEYwGvplGjIOJvWEReB9ZqkOXOYuCi2CvjAr62W9GE0NRaDPskUcqt4Ey9Gw0i1M/BNjwbwrU4sG1eef3NdyQfoiIMvEdmVo/xRtsLb6TAT00SNEXQBgojDCeXdYoQjEIrMBIuPplumktrAtEMEllDafnUazsV2nJQU8n0uVwLK3QBzv7l1xb++yGd7lVfgXX/drcgaC/a05FrWQk1QvUPTy8Mpc+IuaOy7c/WtWiPTUXr0LC4oZSIGd7u6wGIJrpnt8/K9U4Er76jpfDtGyxN5IV/jw9gHJ3vXN1b3vaTundHvwSilsAS9a5Gv3Gvz8KnDJn0mCi73Xc1G8LPg1XFjN0Wevuj5EetGvdQWp0LGyx4JruGxVjzda3t//B/uXS9E= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get Source Schema by ID

+ + + + + +Get the Source Schema by ID in IdentityNow. + + +## Request + +

Path Parameters

+ +The requested Schema was successfully retrieved. + +
Schema
    attributes object[]
    + +The attribute definitions which form the schema. + +
  • Array [
    • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-source.api.mdx b/docs/api/beta/get-source.api.mdx new file mode 100644 index 000000000..4c0326b7a --- /dev/null +++ b/docs/api/beta/get-source.api.mdx @@ -0,0 +1,136 @@ +--- +id: get-source +sidebar_label: Get Source by ID +hide_title: true +hide_table_of_contents: true +api: eJztPWt32sa2f2UW90OTLsCA8Yvz4S6CiUOPDRwezel1s5xBGkCNkKhGskOz/N/P3ntm9ECyjVOf9HHp6mqJNLNnv18zmnwp+WsR8NDxvZ5dapUWIhz7UWCJUrkkhRUFTrgpta6/lKZSBB3fC8XnsB2FS3hWcmyvJWmwbAWC26UP9x/KpZAvJL5VYGQJHtlCWoGzxkVgicnSkUx4dmXtO17IYEXJOJNrYTlzx2IKInM81rOFF8L6ff+u+rPXZqH/SXjszgmXbDC6uGmfX/X6ZTYeTEedrvmTH5gH4+kbesY4oOsjHQzWDcSvkRMIG4Axi7suCxGb9rBXBYLXPOArEYpAEskOYrvmQGy55MEL+JNjI1+spVjxUutLKdys8akMA8dblO7LJQO+1AqDSOQpF0yxhfXOAZD4zFdrFyE0rLP6ae308Miun9X56XGtfmQ3TptHR7Mmbxw2zkrI2UDIte9J4Cks3ajV8H/ZBdoGvD/7RVghLGGhyLwQh/L12nUsEvXBLxLHf8mTEk9cB6gYoaNWA7pz5CJC3B547qaY2hCodWzmz1kY011E9NHxqXXUOLOAaPhl8eP5Wc2qHzaayFDF9/zS2aXeRSvuVRAdPnMFw0lmXZlf92pjsLnfAvTMdVIvH1mO9B3+xdeWH6x9MDeYC2pihX6wqSIW/p0ngrw8R2IuAuGBQEFdOSxy5wFasWGwgZHW49JTb7eBozbiG0RdTWQzgeADs6qdQI4ZIrxohebdO+/2J73JT2jfCa3xU6CpWGeyOPTODeMcTdMzNKR++NUaYjty7fJNRlMKMbja9BH+/T2sZLmRDJ8UE4LiUvqWA2K2WUdPysso8RXXioiyci807sO3kGHncjqedEdZEZqHz5agFVOaE+Dxcf34eHY0q4EA68cn1mFDzA/r/Pj4RQVYhEAnNjgjCBIltyw/8kJ4GwiXXCLEtrmzeNoE22omS01lam7idL+9NbY7ncG0P7npDEaj7mV70hv04Xf/be8iK9xHxj1b3pqH6NNiTliKi0U2TKHNOjpToe3o9PCkcdJoHvEXVYEdcTo3zpddK4ddOW6cHp98KJLuQwozitwCMWbVheEgQIwDRqA7ts86g6vhZfffaQTLTC79yIVICaEUhM4iCX7jbgm5zkNqitC+C83Y6h+icqPpZTerXPTk2WoUIB+LFOakdmo1TprNWp1+8VN+clwDD/KiCpNbvat+keSU6AEGX2DyGwvhClIpXC/H0beOCy5Gh2UlRztC1JgGklFM0JAVD60l5LqWv0qPuuVuJKT2OOKzI8PU2++kUdODXhKyHlcArUjtEBg1i8IdeNdPW5WZhhgBVWwOaXYBRVWGKkXIw5DIQ5XOmGUC6M6B3NvoOkB1ff9TtKbBCZkmIlczEtLvlaapAV9Jl5meJVAKHoBQyADDYIOch6dzB8jhMdWRpOcJuYG/SpMaY/QA7oA8rKxSjAf1q1D5dvA7iEceKk4sKyeT8jBMOqTvc6W6jkTHIqM5lGIOcGfvW/6rvmUmwJTEMPBvHQlwYaEHxBvHkSDypDGrTucCHASopev6d5Ks0oIkB3zJb9wUJesUbAYowmy1qK5HPI8iIRYoWA/vo8l/WeKq4k7xscSDgKMHd0KxSj//htyHFLDf7UwGo5tx5133qr1VEWy/fbZUdJth59Lu5OTkReVSsP7VZqweklSyEC8h4OLUmHcUitV4zV2ZBnYdo5hjleLUY/2dWeOwwZMOk44fQP7vBTpLgC4CP1qX7j/cY49Lyjs/sIe+ix7+T6aIw/Z4/H4wOr8ZDi57na3mwvbLZ6vhGml+RofhpdWwYP2rDRtqibCher2zQm51GoZpyW6MnlaLFXWbl1mVyhZr8EvMakeHZ6e1RKWSwjqHf/n3rHKCTI9X+VF4NgSn3BKoyXPBwygo1OAs9wb0g7vMzEgqMshAZbQGQpCBsw2mQ1QPVgvMIF90TyfvsN3VaU+68BhLu8G4R7/PeyOw2Jthd3TVG4+hyh7Tw3Fn8GM3ZcbdfvvNJY6/avfbF/DmcjD453QID/qDm1G7fz64uoGSvTvG6cPR4N/IwnG3Peq8gx+TLtSSau1p/3LQ+Sf9GE9G085kOuqe30zao4vuBOeO37VH3eGgB6W/eqjg/dhD3Hr9C/jjxWgwHd5sPRz/1O9sPzNCRZKnoxFw4Cb1yHQYBv3Ln25G3X9Nu2NcrH1+3sNuQ/vyxoxIXgKx7YuLUfeCGhIGl/HNu/aP3Zur7tWb7mishqUYuo0WvNUkPDqmiEEFw/ICzLFh1H0LEptOe+f5PY7nqJxndO5n73uW1qkWlVN6P0TPkQwdeCVcgkdfLGlvA2sY1dYnCLEaFk+HSnPtS9Bt88YClxVPzpNdDCUQQBWllKqVMhTBypGYZkoNJ6PqxUDARVr+raD6WKdFlMNCdRJISmwpbimIylQeQIbbCMOZIzNNrUmbTOiKbdwUgrXoN8HKWlsxcliQIlAoSnUNBihREx9EBtkzeGFcRuBekoN11FwAdJZu9vtrzWnw3Nv2THhsP8xgYvugNZ4fGpRYAByBIhPoE1KxBxdZiFC1G169ZisRLn1bmn4STgZtU2k9TRCf1zBSVdwQyYHZK0KEXEtmddRUEMMtRhggDiL/5w0JhwPUJRSKWmfZe6oijQ6zZTK8jHVJqsJAPCQw0xZqD48sQk9DjgInSZcQPa3e2RIFl6cwSsikjEZ5RPxlXCL+Vj7xIf19QGVc3/qkNCby1O+qgpX3Gk9ZBhRqYRBZaP42m/AANzoVutvO+CsgMZuHnDgyXgLzhriVWmW9MG6sQNBykOO62AdH0z4vs8vz9lAvJI3kY6eWU4AZiJpYRcpzF6Aua17JKnvHb1UPBNim3RzDXoJjvJ2WlSo/Y/VELlPLYQWOC00GkOau9OE1Fqc0UymC0nFF7jpxMIQazZil4KMZzpV5ai+r+Ked7GIRiEXi5/LBbifitT96KdJJGbYjbA6RGE7MeyY3ngUm4vmRdDdKjjoCPzLbZP7MWnJvAfJnYwcbRlodaLQnwB8rqs1wWVZ0OrKwT+1Qg/2XyLOo46AtW2QUy/BIxaetnKHFxv4qRhlzLRm7PAwOcx3c4l2eKIAUOIzxo6hZkHQ8ZFS/RkK1U2NuIs5+FDJqBirhKON4OGl5GrhtOzoFiC1Gu/xUqtNi7Zhw0vttn1+ot9nEKIPKyrcFOFnSU1C61QzC1tJZKxqxfUmPUv1O3UlSE3S9Blk9enjACOOa0vn8FOM01SQd+cR8jkWH6q4aTY/FB7iB04qbwVu0PZLetVjPs1EP0vaVjiweMi1Rde0/MF7k3QdFsdiLUfzKpz1k9EU6LClWreEHUFZmDkUNUMVoRXGrCDflrHLYpXDS3DOuRCcrmlYCrg4ZIFIWB7uTqdlG7TCoz2hpMBsd5MFAPjEqZLJka34/njC/ONeN+/x/xfNUDrtL+dFSaKliM47mgVi73FKx7Em5EcqPWJPB5Yka51tgkumFbNXTZn9EndV5q+SE/ZiknVFYn+Zq6bhg3hq4tV5hARxXtthxMB2vxxtBY3WSTSgvaHphciNBJXQvTFUUkI9XF1XWhsgJeXa8J11m70GDbA4/RGhVIUGas40fkQ2oYg3jCzsXrrNyUOfeOq4JAGUauYpAM6VQZvExNgIuO/L2IwPFDTYsPuuGKvsRz299rLKMOAZr4VG+WNG4Ie9jI3uaD53YHtVTaoVlJc6J9Ep8FiqzQscFK3x6GYx+8wgT3V8j7iLj7UzT7Qd+y5mFsJRpx2FJbnkNB6u5Obe2cJTccemkYjUeWkW2xORlkI73/QobqA8yyBx+VGcVInUg8x/K6GwHgmqgdxhRm7D1B//PoPmltBTcDZedpbA+TZyVgISm1DqslUvYIhjTlmYat+uS5cH8iE4crYBEUHBqO7qgE5MluNql76abq8idBR2uwaqRh+rRYSO/wRpRikHo1hDXeq2ma73YMNTeqs/kJ0ft+ap12RrKxyxd9dq9IgFPcHLUlhROM993oWjIofBebd1GeIo0CWBxkkTHQE0zWrdgzE76MPDnYE5VgjnnkQuEziGWiBRO9Od4bxZVCQ1W9dgf35i9imeweIouawGp+Ijkt++7X2Czpt/ud7rKo2cb77m3z+68J6yi8Kh4tWsfvgH/vGgf/klsrjaFolKteWVom6/UQ870/OSo6IOKhlNxyxAUP9rBE0ItQSP1uQawtKDMFg6VqrGHcTxlv5SSQ722TJreaBgGOdBJSO4yTDHnqicQLm/edduXk3e0ByOxitzBT4NTAvxWaywj7yil0AcQdOeIVobiFBwYu+OSgcsOTZeKlDelLbVGvVI7qzROJ/WjVvO01TirHp6CzhwfH9Zq/5fxyL0dFHUSH1VO4tvOcaq/k1riEpnDirHzJ9+IBFtLHxJclMpWazabJW2lCylcYOhkpxQl7SySuexVksGjE3ydWRefZBmbqe92ZXMq3mbrQycrYtukN5V4YeSG2HEZG4ZWQlA5HWsS70+c1qBSwSyesK1ojUoN/gVFa7aOaq3aYfW0cUIaBrU2ZRsvgRDpegxwF7SalVq90jic1E9btVPArHp6hmjdF54rVsfL09nbh+38utJA7wbTm0UfFnRcPAzEukEAgquwkWmtOfrcg66GZr5NX1k43i2kYnSU5IU+QLBFCElKx7d30O63jicqi4A7iKEglC2YqKpBavuu8PyLAmnskcZlMz/gRLXO3nAb6FX0dTQxWAsE3MINgl30fuo5MJ+ZKehqTC+7YFlxIvjsuHbWaM6Pm5w3Tpv1k6PZ2ZwfHtbOjs7OSPeElBCent77vBAgeXD7rm+BRH4DhoDqA+8JAVp89w1/grGjd1FjYzI1vgw/HyqDz3/TGbLmCai9t4joOV9sMcGrTHHPz4PMHuN4HAwV4EHgLJzCDzZMRnPefdueXuLuYrzPiLByO3VtzwRnQBV0AWITYawJQOOUkJxa1Kr+XkP9Pm5WxwP1no8u83RIhxl69YIZadDJ+UFjSpb61oq9cqqiWoZcDh0EnRadcey76i7c923LEuuwcqk5+T3GUVsEr6GuTFqQ+jzpilPfltu2atyGVDpR+8P0QCHoO9sVUMLKrDQSF3KZFgoaB2C+Q75ihVCxkU5krDDWFo2iSZ5szbksdpMU04ilG4goVqg3P+h0KubCQJtD259kwdTNBsfjmXGxx0qfzCR3d6WQOQ99eqdaQU/a3dAF91Mh0uIXt0IbH53eUN5IpDvF2iPpox00WY+KxWUMHwK0cO297e5td2+7O9ru9suR/pxSv6XUp55Pfaaebj9g8MylPgFpj+ebr0z1wVslSPocVadIP7yf6A9YcZvk8xoztBfMj1QoL/gg1MhDPZ+ZU+sm9CeyQASJj4qCOXgiYbcI7wRjYpRi1WHB5w9+MHNAQb2CFBEPdcRtzCDyaGObyzLteeGZ8yW/FeZwA3nA9FfC+0xyn0nuo9E+Gv19otE+k9zb7t52/5q2+2gmGWNF1qLzJBmtVjzYKE3T75FazmAAMxd7JF+Qk6i2sxUExuIcq5TNHEqzRn1Wn59Yomnzpn18eDZvWMcNfnRSP6nPmg08VJ/E+uvEjmMjy9pUSt5KjsRiOhKKZyNBuWTo+3a2/QfsDcSczkqESUoMsoME7v5Dkjs287lj3w+BNvxmtJKc3NtqL05Hl2o7S4FHvunrTgKz55U9RkWfzu5Tx33quA8/+/Dztwk/+9Rxb7t72/1r2u6zUsfmU6lj8xmpY5NhikXXcvyRqaPtqA+T9H0a5jR/IPTxXt191GavDxKbRC+TRTbOCk5B+XTIamOSJZnpRHoJu9C9+Xj/CowNzFj6jmsBLtLDcyeOry6vwz37CqNPXfWRBHXPCcANNpX2HM9QKpsx+hav4niWGwGG5BRcX90kcsedML6DQd0vwhfgqF+wx6ml9bv6wWyEFF8ixaz72RICbT7u/x4VnRLo4QlKdBdjJesHjguonjn3oIyIP0iLU9B9qr5P1ffhfh/u/x7hfp+q7213b7t/Tdt9Rqqus6GHU3UYsHOqDmOrNRbnUm/pbPi3ztjJVDQGpN7MtyhXt5McnPIK/K65RPeGow/By7JbpQP9SfHBF8e+L+FF4pgOKkyiwIURyzBcy9bBwRcQEAjmvsrXTtVcx+f5d1XLXx3MgCsFDie5YAEH4N3duraoEksDh77jI5Uk4IrB+oh98jnPo5DNSe0NEMIUmHLqk3p6jDdpQPnwndQfNiFDcvQBXdPAvf/9tChAD9BSxL5HV4PxDDDdIhFJ+JDc+04XXqnVc7e/J/EDu/z5r4AGOKzB3gge0CdmePDl1Q/vJ6/ZAjNMsnB1h6JwsCQAGxmCipAHa5tDIDiJgkpyG0Q7c8wGLYbNXSCY/eyNhWDXqTvj2Qh8MbG0nbkl5cMrIx1b3AoXo141/ZHX6sCxvQPg0EH2dpXX6tpLLAVSH1FUf/bM93HJd66KRPWd3vXa0MVTdH0tEv9joFUUtApBk6+3sFCsvbbUsW0LzBZBcFcSt756cQWvkoKHdRM8QajbOKirXAiP7OEoy0jtq/HIwKsgvCweP3vvl461fT2OuYVBX2PQww8ufCn+lzFUHTSD60UEVvTVaN3hohWyiEqjlkKpopasOBVIBgm/SzAMTykTn2EwplxEXzNKJvmRJAs2/5G+ov2YoZkeX0PMxJG2b8mvxhkXrOCCFeUDpMZfhSRULLBtpIH8gFKATiJ/8gQa0ZTfU7AKvTqBP6A5GBosQJWgyHVL/aGVODj9i9ELHB2PATdcosvy9HExvGpGw7pPvhj8Td+ZrLoA2xzM4+v6EA63+KbwjfcyMUT+2ehFittJswT/SoaX9tIPeJI/j9/9gzze3tP8HT2Nzm5R3WhZXQaklfyNztfyzTtJV+vCf+Et2Sol0lCmJJfjpAGtXR6iVpNVW0tHUNm/FjzE3K+MmuWvyBKhQkfzF/o2lwV9xIZf13Mo1BwXL8rGxrRZmZPBqMSSbgkO8KoafUzC17cAVdl7fZdZgFUYHtCFd7/4uhwbg2Tobil2boQNSddqFXl4bTagHa0YB5V6QiPwprdIOS79CZoiQV0lFs8yVoyqhiTQVcQiWMnBHDvKDn5mWtpxLZC71O1kYD1KUV8pmRAy0hdj47hs2v4UbNC2ylK4a6wDwetCAiZSK1z1JjmIAMzTexh+sDjQk+QBjgUgWB4p9Tms1qu1CpULeFurL0OoXFPAL0Ro/pKf2Ub9NUJbf4VN3EH/E/9NSzosYT1xsMbWFxIbqfpGFZHXJV1EwuiWY+MHi0tgBr748gXbIlhW3eNjus8Cnn9IKiaqNM2Vf/F31Q/y6dVI4/qaNnbSf0VTIaKmk+dtkiK+BD8/Caz9AVm6n1Q1ZwgV9UK1b1JTchscWH3FJbW6pZM/EMj1DyAbXNV/AJe5MOQ= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

+ +A Source object + +
Schema
    owner objectrequired
    + +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 + +
  • Array [
  • ]
    • passwordPolicies object[]
    + +List of references to the associated PasswordPolicy objects. + +
  • Array [
  • ]
    • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-sp-config-export-status.api.mdx b/docs/api/beta/get-sp-config-export-status.api.mdx new file mode 100644 index 000000000..dfa248222 --- /dev/null +++ b/docs/api/beta/get-sp-config-export-status.api.mdx @@ -0,0 +1,97 @@ +--- +id: get-sp-config-export-status +sidebar_label: Get export job status +hide_title: true +hide_table_of_contents: true +api: eJztXG1v2zgS/iuE7sO2ReT3vNhfDm7qFinSJhc76GHTYEtLlM2uTOpEqakvyH+/mSElS7bTJN3F7bbwl1aRyOG8zzMMmVtPJyLlmdTqJPQG3kxk4+RYq0jORl8TnWbjjGe58fY8I4I8ldnSG1zdepdGpDAqE1+zYZ7N4Z1nkkFA8wap4CFOKF8suOIz4V3fXe95GZ8ZHD4+9+0yHrwMhQlSmSAXwMNkLg0DRgzL5oIZYoDpiH4SxBT7rKdMhkJlMpIiZNMlffwkw08s4SlfiEykjY9qAi9T8Z9cmIzdyDhmSsBorURBLtJxrG+kmrFCPGYC0IgZfFQ+q4vEqi+cSHteuZwhxUgUIOGgkj1PwQf4SZIygrlYcG9w62XLBN+aLIVlvbs9DxmUqQDtZ2kuNpUh2MmrLeLfzLUptUPCTVHYLE+VCBuwpPjKF0mMa4moexT1e93eoej39g860/3p9KjX6fH9g27/MDzy0DCpMIlWRhhkstNq4X91Vkarxd2yJg8CYUyUx/GytnaAvqEypMGTJJYBeVjzs0FCtxVt8Dg+i0hzqyenIT39LIIMVZyij2bSsgbLo6euK3Jdb5dKgt3BSRg3Rs6AL5Zp0CG4FlCo66fbO+hPjw5Dv3cUcL/X7XP/6OAo8jvtg1ar1Q75UdBGS1mpH157XHPZYjmVL9Dx359NfhtPhheT0St4e/L+t/OLszcXo/EYfjo+e3d+OpqM8HH4/nh0ekqDXg9P8OG6ynM5FPiy3DzE1QS+VnjaY0LCY1r4lE6ZXOBTldnRv8/PLibI5zt6qLHg3t3hu0TaJLKNjUinCw6+4IU8E34mF2KTN+AJP7AcQjoG35bBnBjlYPeIB9nKxfkXLmM+jTF4UxbqGxVrvubwnVan7bf2/XZ70ukMOt1B++BX5DOAOM7EVu95CpNOg+yGG4yENFsPuPvWX+iQEtYfZcBZMeaQ1/IEJ1jnFpu+vZ2VWtq5cjFVOrjzqJpdV8qriIH5XGa0TlE13uopSLoZxNXlqlJdr8d3TeSHfPqMHnjMcihILBSRxECvjGliEiZPWaXOuoJGkzGzST23ojLLs2FRqhdsGCyEP9YxT5nhKpzqr6C9uy2C2+z4GPEDjUtnVn914Vef/kQXLYk+yjO+KZtDA3cVOmVG9triCGoKb/m94ED4vajd8/v7ou+LwzDY73Th03575WSDarZzopbpZgFVBevrQEFpWRfS1SFgh7XZBGp73VNXknVak/b+oNUbdHq/Vhy4Inq3HNBotzu/Vn1726jDRvegS6RWdto+bP+IdAmK6m0rpcexhPLIRmkKnumzC1c6mbSBXWCWqQ6XDCqWVF94LJ9WWb9dRUORQRo91uEjCsdrCCp/lnKKLUEsBzCRAcUvMkTwtNCpYJZkiVRwXN3hQBONNnsJSOrCyXfshMEalvLgd6D1hNpeTMEijxF+z7LiUPDpQavf6UUH4IOdo177cH/aj3i32+rv9/uUmK2/VWs7T1O+3Fj6jVAilQGLdQAW+S8oBJwKdG9TDC4OU2QmFuZhGxCNxxRuTPU0thTT8csQgO8xzl4en7PeIRQENcvpPZ+tKUH5l4gwMJ6weFqwCZJbwmepnMmt+bZAAq9Gr4eXpxibF6N/XY7G8IS0NsD7UIG3huiWwCr4wlzf2FplBaCSKWJQB6Qj9sJRfQECcWWqA6VD/0sDysTMzvM4gxlu9S0zqqRt7q6GUmC7FfZMNkRjD4AEvINsCjBjyg01BTT8xRAQbZL5p06TL9gcoL9InzfYMAylqzYQjUAU5i8JkYQhhq4lEOUQysAMYCudZ0zpTAaibouVKuvWWOXd06pRMDiA84f9ZBhkOTBHYlajsPQWx6KzD/BsNVfnrtYzoUqXKgMABjMQ5Ac6TUHDbAqyycwwl47QXAYSjyrGlRkLU2AhFqW7d5aZV5mmbwHPzSPi7jyG9OOTaOWHL8IFn0H0Y7MRWaMwk8tIDhrRZDeqNFcR+AxyfhzuYncXu7vYfWTsrn+8cBsI7itBn/Ym9LlUPAf9plQ8N6BPSt6jNCsGWUhuDblHTarVztsPEwjs34XC8YT+nrjz8O34tqV8g/lhaQ/7forwozRWzRbIIOnRShBBJhLhgPhecUyKsqrqbq72WqdTCQ6qtkBEaniWOocOGWyeK4WccLMHHbEw6peMzTnkR077M+XOh1Chn2ipsh2S3CHJXTXaVaOfpxrtkOQudnex+2PG7jeRZMkVRYvDSSZfLHi6tJ7mvqO0nMEAVvwqi5UhR6ZaRytIjJUYy6sjB2/aaU/b0WEgeiHvhQfdftQJDjp8/7B92J72OodetdZfreK4DLJ6TFXsbe1IKgYQ9wVwXK7AuUymdVjf/gP1piLCtIapp8TNoHNQ6fUKO/Y2seN7nYFsQBiwY3rP9uLlxSnSh6WJPOpN52kgEGZb1cFwnhGkRB8GTUvabd1Bxx103JWfXfn5OcrPDjruYncXuz9m7D4JOvYego69J0DHHkOIFSHE+iuhYwi4A6FZBEYBGYIc1KsQNiYgCjy53UcX9hlPZyIrgV4NRXb6myhyojV7x9WyAEumthOpVurC9AZjFzg2LcbCAM5mkCIVg6wlAd2iV+HxBMCkeGgllgtJcYwCAd106Q+jDKSyMVP4W7mKVEGcA4eUFGKNe68afEyCO4kI4R9QoH3QGSTqP3GPszyO8Af2g9kFSnyKErPR10AIjPly/3d/2ymBE2A+xXQxtra+57iA3TPnCtoI8TWx6auEoDuovoPqu3K/K/c/R7nfQfVd7O5i98eM3SdAdYeG7ofqMODRUB3GNlqsxFKv0bn+74idQsVxQO7NdEBYPVxhcMIV4EruHg7mELxIMvCaJvHtEeWmPcXcvJXhnYd3chAXWpbyNIah8yxLzKDZvAVLgYXuGjyRDXtTJlsqfdMI9KI5BfVsyTx40NRGGQ5gw/MT12Q0SLepRPe1uY6IW02TNOiooHE6W/BNynQcG0y4hP6DWTJ7DFzduRK9xsO10Ef8Ymh0g1xnQz6Q6zKN7/64LJbQPbJsU983V4PxDDhdE9Edqy7uGI0RdNvVNy5SrQoJbvd3NhY7w2Ed9lLwFDoCewLm2dsPk+dshlCTQj03iHLd9Q7OzsFFKJUNi9MgOImqS6rzmb1oMaydt8HQYVEMArOPaiwEuzpxSngPOf4CkjKpFCcJygM46/pZYZ1QfBExlr/GSpPoeDJUTdBQk9fmPadSRz2BVPaQO7xt4A2sVxIzkMSSjWOciNTisaukkItX5PpeJv5RUPMtNZ+omedrXFjVXgX2/HYA8YskeGxIW9+9uKXnV+hhAwVvkOo6D6gJx0f9lFRQWO27+ajR85FenY+P6gNdzalPYzZtMQNlMA7ZCQvmWhvxT8bQdTAMrmY5RNF3s0X3gXyKCL/TqrDk2yV96QMqJP5OITCUdSY+xapMoETb/REKyU9kWYj5T9Azh+xTTWZ6fQXFE0eGOjDfzTMu6OOCvs0BxvFvaxM6FsQ2ymAvfpADHK/sT5nAMVrJe5bW1qxO5Js0B0sDXWOkKpoM3J3GVYJzT/ayo7dXGQNpGEF1eW4MfnZXIqm815RVbAesa3CT31hDXVzTm+W3/KUm1sq/m7wo8XC1a3Km4uWfnaXvySR/n7z7F2W8Xab5GTONg7nobrSs6weqTv7S4bXNXTxD19rgX/hKsUqIGvoV6sAIxVQJJTHP0KspqoO5FNT/J4JniP320LP0giIRWnUMf2EsoRndE0uBZQ4dm4yBHu1QFytzChgLLNGu+LPJ3XkJDS4J/aRosA/QkqkAzILtGJ7UhW+ftevLxmCZczQse1UYG0DXYpErvIMObOcLxsGlHvCIUJogt4kLGgQlCl1ogn7lrCKK0dVQhAY1JunCnEW4tQxda8XwD6wFdjduXxlUj1Z099xXglyImDwTx9Vh+0O0wdv8uYgTbAgh6wIAE5UV3p1MNigCMeV+maHTWdNNMk0cC0SwPbLu0220Gy2f2gV4n2iTQQtbIf5GZNXr9eVV2LX7qOV++o/1ZwpcucI+o5ng3hgqIbd9j+0y8S84uC6T9ghQAHgYSLqmOgd94ZjbW9xCwc7rDl8Dz9ifX12vmipqRsGe+AydbAQZZv2PGlS1+OzC3Yx9Tr8E+r4/dbBVumJ/UC1XWwMePP4ucEcBxIK+GwSjLR9i2n6wm0KVKRu/NsFWrmzU34zQJ/k9qMA9gIIg7/0PcZVhEA== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-sp-config-export.api.mdx b/docs/api/beta/get-sp-config-export.api.mdx new file mode 100644 index 000000000..86965e4fb --- /dev/null +++ b/docs/api/beta/get-sp-config-export.api.mdx @@ -0,0 +1,113 @@ +--- +id: get-sp-config-export +sidebar_label: Download export job result. +hide_title: true +hide_table_of_contents: true +api: eJztXG1z2kgS/itTug+bpBAYDLbxlyuMsVdZGzjAm8o5LmeQBphEaHQaKTbn8n+/7pmRkHhxHCd1u0mxH7KyNNPT7/30MNKDJUIW0ZiLwPGsY2vK4mHYFsGETzv3oYhiq2TFdCqt42tr2Lf1E+umZHlMuhEPcSJMG824JCzwQsGDmAARSeIZI0yRIBPuMxIxmfgxD6ZkEol5/vEnMSZ3PJ6pexH7T8JkzDzykXsfCQ084om7wBfUk4THJBaEKoLlD8FoOR4I+D4JGMwTASNioohNhO+LO1xTMjeJeLwg0gWB5fGHwCYyPHaVPMcRox7J35jTgE4ZyB7SiM5ZzCLUwIPFUdiQxjN4FMAD+It7cC3dGZtT6/jBihch3pVxBMtajyULGeQRA+XGUcLWFceIc5rym1fITMhUaVJLN2aZKphXhlXZPZ2HPi7HJvtHk2Z9v37ImvXGQW3cGI+P6rU6bRzsNw+9I+vxBjmRoQgkk8hnbW8P/1fkRpscdPh22OsSMf7E3FjiSqCWmAUxzqBh6HNXeUzlk8RpD+vi66noOzxWDGrHIXoBMjCckBPhLaxVnWRP58JjPhgxItosqX5SLZBUImQxjNCTY67F+wIW45o5wxI4JpuyaG21dhJFIBoxM1ZMkRpAC1RQevURxZuD88GNddOXLGB8TkFnlkdjZuPQtcVHcDO/3B2VICvSj1dNXNurVe29hl2tjmq149r+cfXg3+hfYBeqLbO6fnGpLrhrKpyeAz7GIlweY1evLyI+5QFdW1yqC9us9bhC+2tL99QF9UkiWUQ8NuEB+FhuTAVjSRl6GQFFBozjvIXIqJIR6ByZEGqy3OR3RW9g966feGwEg+S61/fUJIIkCDIiMcmM0SZqlqcTFg0gP9hFRwRTQaZQujIM0Cii6NE8ZnO5STMsSOaYTFvtdmc4vO0PemfORQcemBuDzr+uOsPRbbvXPXPO8f5oNLgdvu+2b4e9q0G7k3tyNfr9tjfAy3brst9yzru3QGzUGcCds97g8va0c+Z0nZHT68Kd896fnUG31QUS54PeVR9uOaed7sgZvb/tnbzttHOLZg+W/F04Z532+/ZF53Y4ao3wTrc3cs6cdgvp3446l/0Lfb/fGg7f9Qant/3ehdN+n7+j5EhX71+dwPNbs5bTGS7XH/TUmoMr9b9h5/wSxqirwZ8OCHDaGf5x63RHnfNBy4g37OUW1KqCi1ELyY0Gre4QNaKunfPzDqj06mTYHjh9Mx3Y++PsovcOa9vS7QydR3A2HrzEh8wsDy6e9CDi5MiTmH6Gf8OIucxjgQtxC9mJ5L1453K/qsttHIwOqHNbb5nzih7Y8jxu0qzJi+BGEUAxBX9C5vIJd9OaDnXNxyyPXsqoOyPoPOijWB3yng5Qi/ne0tmyBEuz5fqFVPt0Ik7DwfG2xxD3tgQPn5saZYLnm2Ig0++YNVm1euDZe0esatebE9em48OJPaGNowZrHrhNVs8HvIeFczu3TwT7j+EXix3RiwFbj0tIpe/pwuiopVLfeMzNf9jsUKu2uH6eXm7W1HKtGaxZN48F7jRfKUebEYFEQKB80AUEHhegSNnKXD6voG2K2wY4jZUQWhgIgR2FVtc6FCykZhxoTKiRnKLCA49/4V6CYaZp64Se6CZK/mAoWiC+DYVK5k826aJIfQijyNgX7mctyFxj/QpLQf+SerghpL8G8pwt9H6T5HTUU5WxbBRPwMqultVfQL8G/4RCSj6GNjFrBDcXihJZrRMlgim7RHT+LZEs8ZaUBTd5f2q5OK2kuwr5M1XIFJSVsPf+Hr90TldaLLdZPdo72m941WaVHh3sVRte7ajeaIzr49p+jeKSuuv/jkU9LkOfLlThKC7/+4C03Jh/YeSUA/SLRbSw8ikVA1gT1qnsNBbLJLm1QHksptyXZXKmk5jHQhZ42P4JXe5zwVDeWthx7+Ix/a9k1TftHrR9jtmrE0WQXmxo8uMkwkaPT/I7O2QMPT9mAB58oT73vmt7oZiotKht4T3DQmfQg9rTiKpWlCmWXZgIoFtAekfMNBfQHGuS2aYAjisaDTRRrpIT6oG8Wr62EQYtF1H3M9BynuGnVwGH+SSdAjBIpekty7JDRscHe81afXJQpxS8tHrYGDcndH9/r9loNnF1qM+STtmm8llc+pwFLAJwCLUBLPJfhhsrFHSvO3Jc/KmKW7SBovEM/ePGlx6biWn4JTG7jyF5k5N2n9QPiU+DaaLu0+mKEgL7aog7cYnv0zHeUm5aMkz01GbGUx0RpOLW1QXmMJPhrRLSWtvebAWq7oNbAqvgCzNxpzg2AuCuDdRgUAeDTu6NofoGBKKBzA/k+i+5kAi3PTahiR/DDLP6hhl50suN0zSUVNzcx+QVL7NyCSAo3IMYBzw/plJtharhb1quy8LYvjCafENmjHosel0mua4BohGIwvwFYllIAxrIqn3UBEJZ12aRAOYVMXdXktdSlUVrLNPXRd4oauPq/hnbVpAREWspMfNRmHlL1rQo+wDPWnNF7go7xajSRRBTyLUwEsCHKyLMt2QMsvFYEpOO0FwSEk+QjssyVgHoIjeXmhmVkeGZSxP5jLjr+5B+bCVa9uALM8GnmgqdjZQ1UjOZjAQP9U4eTDajMnOlgZ81b7vY3cXuLnafE7urD9PfIsxTBX2q69DnKqAJ6DdSxXMN+kTKewJB0kG6m9OGLOEGgYFIb9+NILA/s4DoPhh/N/qB+EiX8vWdo8we+v4Y4UdmrIItkEGlRy3BBDIR844V30uOrSVK3F9fDWDomIODBhsgovp9YCESQkFlURIEyAmVJeIJJoPfYjKjkB8pRISUOgPqnx1t9bvjDknukOSuGu2q0a9TjXZIche7u9j9OWP3SSSZcaWixeAkmcznNFpoTzPPUVpKYEB21oVkIadMtYpWkBjJMJZVRA7WuFYdVyeHLqt7tO4d7DcnNfegRhuH1cPquF47tPK1/noZx1mQFWMqZ29tR6ViAHH4c3USgHPJWAivuP2X4KmaCaY1dZgrxc2gc1DpzRI71texY1fEIBsQBuwYbdlevBpcIH1YWp8VA72JJMLf0KNsq3OG+6AAKdGHQdNcxjvouIOOu/KzKz+/TPnZQcdd7O5i9+eM3W+CjvWvQcf6N0DHOkGINUGI9VdCRw9wB0KzCRgFZDBnRUCOEESBK7P7aMJeH3PLgF4BRdaa6yhyJAS5pMEiBUuysBMZLNWF6Q3GznFslI7Fs11kCikyIJC1OKBb9Co8xw2YFA8x+XzOVRyjQEA3WtitSQxS6ZhJ/S1bxRyokiop+AL3XgX4GAd3YhOEf0BB7YNOIVH/wD1OY63v2g8mA5T4AiUmnXuXMYz5bP+3semUgAPMR5guhtrWW44L6D1zGkAbwe5Dnb4yCLqD6juoviv3u3L/a5T7HVTfxe4udn/O2P0GqG7Q0HaoDgOeDdVhbHmPZFjqDJ3r/47YVagYDpR7E+EqrO4tMbjCFeBK5uVizCH4+uyxVcnehTKHZCsP3HuspO92WnisHQGi5i2JfJgzi+NQHlcqD/pFxMcyDXkZMhlYLV4E4q7sinllDHrakILwxKkONxxAWn3HdBtlpeSIox/rpJe9UWmiFj0WVK8OGTxJOTDvWC6gETEvWZbwYK3xKXUbX++EhuI3aU4Ao4rW5AO5riL/8ftl0YS2yLJJfU+uBuMJcLoiIopwg+bSr1gre10BP22dsVoJ2vv6Jj9miAhdc7g2cll18LeB2hpDPRxWIyeMRtA+6OMyr96+G70mU8SlKi8kEiEx49hIQGT1wY1U3mulR0dwkipFkUim+oWDVuFwDsYZmfigFPIhGDJGrh2jqC4UhAFkcKV2nMRU0sBZN69SC3rsC/OxVpaX2kbn5F5QAS1WaGHea1UXVQPBA/2yCdwt40vq+ii4elkGxxgRVT9IrsNULpqT66VM/COlZmtqtqImX69woVV77erD3m7ElFqoL5W2Xry4pmfn6GG3BXeQ6ioPqAnDR/FIlZta7cV8FOjZSK/Ix4fg3YxD0S1OIzrHEQk10/eIQ9yZEJL9kxB0HQyV62kCkfZitu5wUVtFhF3by7Fk6yVtbgOEVPxdQGAE2pnoGEu4QjBCb6aosP2oLAt5QX9f4WNBZnX7GiotjvSEK1/MMy5o44LmvXFp+DdvJACzENsog8oD2gHaS/urTGAYzeVGTWtj5lfkK2oOlg/1pQdVcsNj89mHZRI0V/p7EDg6GwOpGhF4dsgM/jZfjVBYoKCsdO9gVYPr/PoCiuiK3jS/2S+gWFj/bvKixK3lFksv8Bc/OktvySR/n7z7F2W8Xab5FTONwcTobmpZ0zzknfzEYLr1LT+pPhYC/8JTFasKfkNzk3ttMkco9GmMXq2i2p1xpjYLQkZjxIcl9CwxV5EIfT2GP5Oa0FS9jhsByxTaO+4DPbWdna5MVcBo8Il2xb9lYg5XCHBJaD5ZmbyD/i1wwSzYu+GxXnj2SZgmbgiW6avPBZ2mxgbQNZ8nAX6mB9hO5oSCS33FIzwu3UQnLugmApbqQijol81KoxhdDUVQ72KzaC57E9yHhhY3Z/ivrAV2l2YTmuoX78yngJaCDPD1evPmcxHaf402eJs9Y36I3SNkXQBgLLfCpTNaowjEAvPLh4imFTNJVnAsEMleP7b2y9Xynq1aCrgfChlDv5tnP/2sTu4zRPr7N+VVV3xYbsH/ut9+MgUOO5NKiFtvqLZEd1O6ib22siZWbUGYt8qP1Tehsk4W+p4ZKBuHPzzgZg22do94G9jHnYDrm2XXproncAa8hp55Aulp9aNReeW/GpjPS71WPze9+FNSG2VNNyODxXIfwoLLzwy3L0BIaPJBNrW/pPjWD/QOVG7K2m802ApmuwLnHfDTx/8Bm7BdoA== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +## Request + +

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* ObjectExportImportOptions
    objects object[]
  • Array [
    • self object
    + +Self block for imported/exported 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-sp-config-import-status.api.mdx b/docs/api/beta/get-sp-config-import-status.api.mdx new file mode 100644 index 000000000..22cc489e2 --- /dev/null +++ b/docs/api/beta/get-sp-config-import-status.api.mdx @@ -0,0 +1,98 @@ +--- +id: get-sp-config-import-status +sidebar_label: Get import job status +hide_title: true +hide_table_of_contents: true +api: eJztXG1v2zgS/iuE98O2ReT3OLG/HNwkLVKkTS520EPTYEtLlM2uTOpEKakvyH+/mSElS7bTvGzvdrfwl1aWyOG8zzOUmNuajkXCU6nVcVAb1KYiHcUHWoVyejyPdZKOUp5mprZTM8LPEpkuaoPL29qFEQmMSsW3dJilM7hXM/HAp3mDOVd8KmpXd1c7tZRPDT4dnXmWag1uBsL4iYxxUVhyPJOGwbqGpTPBDK3HdEi/JPHAvuoJk4FQqQylCNhkQQ+/yOALi3nC5yIVSf2zeqMTNtcJTFOhTuYkFeMTnaU0Xk++Ch8uF7HAtXjKQKIEqEYLZrKYVnILhpnycTaPQOIdlohQJCzV7HLE+YhZSTKrtqsXszSNzaDRCMS1iFCddcNlFGup0rqv5w0ZqEagfdMwnBvPL09u/OIWFoFn2TMvQZAxcJuIf2fCpOxGRhFTAsRGGUIdRfpGqinL7cGMD2sOPiuPrZlgp1aox5DdJCo85mCxnZqCB/BLBmhcfybmvDa4raF24K5JE1ikdrdTQz5kIsA50iQT68YT7Phwg7luZtoU1iQZJihTmiVKBHVYUnzj8zjCtUTY2Q/73U53T/S7u732ZHcy2e+2u3y31+nvBfs1dKREmFgrIwwy2W428b8qK8fLxd2yJvN9YUyYRWDh8to+uq5KkQaP40j61hhfDRK6LWmDR9FpSJpzerFGQsUmaOlUWoZgUQyfVfWtautCSTAquDLjxsipQqNq0BwEAFCoaqXT7fUn+3uB1933udft9Lm339sPvXar12w2WwHf91toHyvrw2uPKoGVL6eyOYbnh9Pxb6Px8Hx8dAh3jz/8dnZ++vb8aDSCXwen789OjsZHeDn8cHB0ckKD3gyP8eKqzHMxFPiy3DzE1RielnjaYULCZcLENzImBLT1qTKzR/86Oz0fI5/v6aLCgrt3h/diaaNsExs2QcCdgKfCS+VcrPMGPOEDlkHiicCjpT8jRjnYPeQQq4Vj82uIeD6JMEATFugbFWm+4ubtZrvlNXe9Vmvcbg/anUGr9wn59BMBLGz0nqcw6TTIbrhB/8eU8rj15zqgtPpHGXBWjDgkrSzGCda5xbpvb2alkmwuXUwVDu48qmLXpfJKYmDVkSmtk5eyd3oCkq4HcXk5yNTAnKMFWYNK2Gqc5w8e9muMaTeaYbrhUhnGg0DasnJfibqGYgwuZTYGa6G/Q+dgecKF5JhF4I7kfALWikydXKuQ6Qc6V0H0UTa922AOm6nBKA5c3JXoFLm01g0nreZus+O1/G7f6/bgaj/cD7z9/Z5ohT3Ou3uTpXsMynnKiepywdKej9TcihoU1I9qOimEbTfHrd6g2x50+p9K3ljSRqcYUO90Op/KjrphVLdZ32sRpaXlNo9q7pJ2QXXdTcXwIJJQ4NhRkoBgHjt3xY9J61E5uJjoYMHAU6W6BqjztNr4/YpolXmgg0cEyxuphDdNIESAQ0Es+zCRAcVrGSDYIVRnSeZBQeOqLgiaqLfYa7DuuZPvwAmD9Sjh/u9A6wl1Op+CBRsd5J5lxZ7gk16z3+6GvS7n7f1ua2930g95p9Ps7/b7lGStB5brNE8Svlhb+q1QIpE+i7QPFvkPKAR8CnRPDNDiMEWmYm4etgHReFSyEnY9UYiZpy5E+DuMs9cHZ6y7B8ldTTO6z6crSlDeBaIFDBYshBYuguSW8Gkip3JjIc6r+uHRm+HFCUbr+dE/L45GcIW01tqFoQJvDdAtgVXwhZm+sXXHCkDlT0SgDkhQ7JWj+goE4sqUB0rXbywMKBN8K+SQCGCGW33DjDJpFiZ6Xgkl37ZD7IWsi/oOgAK4B/kVIMOEG5gAJsThr4aASePUO3GafMVmggcieVlnw2V1gGgEojB/QegiCDB0LYEwg1AGZgAnYdVQOpW+WCkPhSqr1lhm4pOyUTA4gPOH/WTopxkwR2KWo7DwFseisw/wbDVX5a7S3KBKF1AdoduCkQDTfQ0tGXRpE5BNpoa5dITmMpB4VD6uyFiYAnOxKN29t8wcppqe+Twzj4i7swjSj0eiFQ+uhQs+g0jGZiNRLuIuIzmYQ5PdqMJceeAzSPlRsI3dbexuY/eRsbv68NxtAbinBH1a69DnQvEM9JtQ8VyDPgl5j9IsH2QhuDXkDjWcVjvvPo4hsH8XCscT+Hvi3sH349uW8jXmh4U97P0Jwo/CWBVbIIOkRytBCJlIBAPie8kxKcqqqrO+2hudTCQ4qNoAESFrJmyhM+h2weaZUsgJNzvQ3Qqjfk3ZjEN+5LTDUuxiCBV4duNriyS3SHJbjbbV6KepRlskuY3dbez+PWP3u0iy4IqixeEkk83nPFlYT3PPUVrOYADLX0axIuTIVKtoBYmxAmPVqsihNmm3Jq1wzxfdgHeDXqcftv1em+/utfZak257r1au9ZfLOC6CrBpTJXtbO5KKAcRdA47LFDiXSbUOqtt/Ge6AhpjWMPUUuBl0Diq9WmLH7jp2/KBTkA0IA3ZM7tlevDg/se9OLXnUm84SXyDMzt/G4ntYhJTow6BpadItdNxCx2352Zafn6b8bKHjNna3sfv3jN0nQcfuQ9Cx+wTo2GUIsUKEWH8mdAwAdyA0C8EoIIP7ZA7kiEEUuHK7jy7sU55MRVoAvQqKbPfXUeRYa/aeq0UOlkxlJ1It1YXpDcbOcWySj4UBnE0hRSoGWUsCukWvwg8WAJPiByiRnEuKYxQI6CYLbximIJWNmdzfilWk8qMMOKSkEGnce9XgYxLcSYQI/4AC7YNOIVH/wD3O0nclz94PZuco8QlKzI6++UJgzBf7v7sbP5kD5hNMFyNr63s+F7B75lxBGyG+xTZ9FRB0C9W3UH1b7rfl/uco91uovo3dbez+PWP3CVDdoaH7oToMeDRUh7H1Jiuw1Bt0rv87YqdQcRyQezPtE1YPlhiccAW4kjvogzkEj4IMag0Tu3MpDftdbONWBnc1PPSDuNCylCURDM0Pu9yCpcBCd3Uey7o9m5MulL6hEy8TUM+GzIMfmtoowwFseHbsmow66TaR6L421xFxq2mSBh01P1TzXcp4qgVNuID+g1kyO3jkx7kS3caPa6GP+NXQ6Dq5zpp8INdFEt39cVksoXtk2aS+764G4xlwuiKi+9A6PxM0QtBtV187qbUsJLjd315b7BSHtdlrwRM684RfwLx493H8kk0RalKoZwZRrjuqwdkZuAilsmH+NQhOouqS6GxqD00MK9/bYOiwMAKB2Wc1EoJdHjslfIAcfw5JmVSKkwTlgccftQINNXhl3ksqdasnw+p4ZOpQYgaSWLJxjBORWjx2Gedy8ZJcz2Xil5yaZ6l5RM28XOHCqvbSt99v+xC/SIJHhrT17MUtPa9EDxsouINUV3lATTg+ql9J+bnVns1HhZ6H9Kp8fFYf6ZhNdRqzaYsZKINRwI6ZP9PaiH8whq6DYXA5zSCKns0Wne3xKCK8drPEkmeX9KQHqJD4O4HAUNaZ7LkNAiXa7o9QSH4hy0LMf4GeOWBfKjLT7UsonjgSTwU+m2dc0MMFPZsDjOPfHWMAZiG2UQbKA9YBDpb2p0zgGC3lPUtrY1Yn8g2ag6UBjx0SFRMP7I/BMsG5K3s4EUcXYyANI6guvhuj4y6WFhaoirLy7YBVDa7zG2moiyt6s/wWLzWxVv7V5EWJh8tdk1MVLX50lr4nk/x18u6flPG2meZnzDQO5qK70bKuHyg7+WuH19Z38QwddIN/4SnFKiFq6FeoAyMUUyYURzxFr6ao9mdSUP8fC54i9ttBz9JzikRo1TH8hbGEpnRMLAGWOXRsEs+Y0w51vjKngLHAEu2Kv03mvpfQ4JLQT4o6+wgtmfLBLNiO4Ze68Oyrdn3ZCCxzhoZlh7mxAXTN55nCM+PAdjZnHFzqAY8IpPEzm7igQVAi14Um6FfMyqMYXQ1FqFNjkszNaYhby9C1lgz/wFpgd+P2lUH1aEV3Un0pyLmIyDNxXBW2P0QbvM2biSjGhhCyLgAwUVrh/fF4jSIQU+5lhk6mDTfJNHAsEMH2yLpPp96qNz1qF+B+rE0KLWyJ+FuRlg/IF8daK054u9xP3/5hhP/lH0Zw5RX7okaMe3lotMz2abYrxj9p4ZjCbTiSHy4Gko4Yz8C+OOb2Frd8sFO8w9vAGu4nXF4tm0BqnsH/8Bo67xAy4uqfUShb/cW5O5T8kl5aPe+PK2yULt/PVIvlVkYNLn8XuAMCYt1dwSi7RUVM2wd2E6s0Ze01D7aexcbC2yOMIX4PinEXoCDI0/8FWP3NSg== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-sp-config-import.api.mdx b/docs/api/beta/get-sp-config-import.api.mdx new file mode 100644 index 000000000..fde2803eb --- /dev/null +++ b/docs/api/beta/get-sp-config-import.api.mdx @@ -0,0 +1,133 @@ +--- +id: get-sp-config-import +sidebar_label: Download import job result +hide_title: true +hide_table_of_contents: true +api: eJztXG1z27gR/isY9sMlGVGy3mxLXzqOI6dKHcuV5Mt0FE8OIkEJOQpgCTK2zuP/3l0ApEhJjh3nptdk+CWhSWDfd/EsSOjOkRGLacKlGPpO31mwZBKdShHwxXAVyThxak5CF8rpz5zJpWueONc1x2fKi3mEE2HadMkVgbmKcD2LBDxkJGYqDRMuFiSI5YokS5Y9/izn5IYnS30vZv9JmUqYT7hPqPCJL29EKKkP1BKSSEI1uTqZwuDsGYzWPG54GBJPioRyYakhU0VkUGSYa1kjXHhh6qNUVKwJi2MZ18gNjQXekjE8D2S80oNpSFZMKbpgilClpMcpiplLbojXP4rpRg0jkWAwDocEMgzlDZJWzEtjnqyJ8kCa/kfhEhX1PW3R/ooK4ALGjmhMVyxhMZr8zuFo3YgmS3gk4AH8xX24Vt6SrajTv3OSdYR3VRIDE+e+5qAcPGbgzSRO2a6nGBm+2bKOdsdSqo31tBLzornrwJXd0lUUIjsWtI+DXqfdOWK9TvewNe/O58edVod2D9u9I//Yub9GSVQkhWIK5WwdHOB/ZWlMjOVc301GF0TOPzMvqWVORdP5DK5CsOgjzkUZcRoTCfKiURRyTz9pfFbI8G7XcIYdhjlPtGomxokVbWx1IK+lv3a2rVl6Cr6OSXm2J1fgWW27KEYxE26sYRXZJwf1fW6C77I05SF5LauRvv9UeVfSZ6EWOLNhAGmmwNiQU4bFrtCYGWqPE/cnTMySNBaYp1nyJzSGGgGJEH/hHrARWQKhNkY7GscUxeYJW31V65KdG4NbrcR7w3tHbXu/oPW+6bsK/87Wuyn2EHEYXM6Rq4t/Xow+XHwaD84G48HF6QCuJqPzXwdjTNOE3SZPJ46jt6gLOgdfQXmEWJLhF8zdgMVMeExraCxGZki/Dyk/uJgOp/+G8uf3ScvrNY8Pjr2jziHreb3Dg+ZR58g/7B4ctdst5v1RI1hr+iSG2AXfcR8SCirXNcptcnGvb/aLbicQHmDBxfqLpup/oWHKSER5rOpPjvr7ggXuNqI4qzIv5/6+VAhn2pPW5hsVrnGUrfx74vqDXROqiK4i+keKaA1p9sTzAO9X0VxF8w8VzSYEmW/wzZ6wHmdmVWhsIwhcLilAcXhAvJhp1A42TyNfX87XRfj+DdFd5mwh134GG+LRHoM9FldvpiOCIxCXyaexYSJdoSmzUPo0ev1ucDr9dDq6OBu+hQH5g8vx6Gx4PoBb4yv932R0NT7Fi+n45GJyNhq/19fDt28H40+Tq9eT0/HwcjocXWDntwlxOw2d5D+ukuk6nqpMzsTmQrvrN3tNegy50PVbx51ud96Zt9otiuxNZ/SoTbmKQrrWufMsUf4xJidewiGV30DceomM1w6GaBmJj2wqbIe4Qc8FwJFX6t0gv77f17cVuh8qcvF1pUxNA1Ro6EqilxqOvY7dwPuZravO8P3laDyFaBn8Ohx8yNIzD3tItnmWQwyK1szrddvNdsdzW61Wx+20gpZLjzvMDWjXm8/bvW7voFMjU+yRW9d5mjt9kYbhfe25XOesx5rNQ989OGZNt9MLPJfOjwLketxlvUOvxzKuzR2u10X8N7verJ14vVN5ZlCQ9AKrl6N3cj58SthjYzWn3u9pRG6oIlAKsF3CKGNwwQqVqAbXXO1uaXxGTlnPa0mhh4neduE+8SAcwCqpwk0HXHBAFPbFkMbG12yVlAmw290Af4otne24ziLLGqezr88/DTksUcQgEBeaVAs9eFDcASJz7KJRJQGrD/e/q50vV13j9VPAF4977IwL5i5isD5IqAMCvOHDWhjLL1xvHK3Qb4ZkZlU9rmxNsES9SV5TH/Q1+p1aZbBmxOAGoPWUELoSHOaTbAp6HBHEA2zZEaPzw4NeqxMcdiiFWtk86s57AW23DyAHe8g9A4EF3tnaV2b9lgkWc4+E0gOP/KG3YKiOKBBAM//acln2gabxBPtjqTNjczVXBZhVg3x6fXpJOkckpGKR6vt0sWUE4V5NcM8MshxxmNkMA80N4VHMF1zsEyVbRd8Mzk6uzqe4Rg7+dTWYwBXS2tn5PIGaK3wMS8R0AVnKGy2xVQAzXrEQzMH8Onllqb4ChahQxYHc/KXWCowJsRVQSCqYYbnvmVEkvcHwWSrpvLlNyAteZ/UaVAe4t6KJt4T8xzIhTWl5deJ5LErcc2vJV2TJqM/il3VykiM+orGggvlrLDMABTF1DYEghVRmektUpgkRMoHWoeyLjSnL3tgsnOdFpzwZe8NanIJwWs1iFubRYkW0/gGZjeXK0pW2btGkayi8sMrDyHANZoxxpSdz0I3D0mvLEbpLQeER2bi8YhXxgC53Fma/SaR+5tFUPSHvLkMoP65WLX+gWwhMPg10TTXS3sjcZCsSPNTdHE62o3J35d1fwFnoV7lb5W6Vu0/M3e2H2V66faqhT3MX+lwJmoJ9Y7147kCfWEePkCQbZGC8cWRNv44y1nn3YQqJ/TsTOB6wG6KvPxEfmaV8R/gTsunc8f4c4UfurJIvUEBtR6NBoF/Y9LXcG4m1oYyp2rvczmQ85xCgYg9EhKoZk7VMCQWTxanQO7NU1YgvmRK/JGRJoT5SyAilTAVErsJ3I8lFUiHJCklWq1G1Gv08q1GFJKvcrXL3x8zdryLJXCqdLRYnqXS1ovHaRJp9bj7ZgAEk+86G5CmnXbWNVpAYyTGWU0YOzrzVnDeDI491fNrxD9u9oOUdtmj3qHnUnHdaR05xrZ9t8jhPsnJOFfxtN3DRxPhqEXBcKiC4VCKlX97+S/FToADLmv7sK8PNYHMw6fUGO3Z2seOFTEA3IAzYMX5ge/FqfG5ewhny+sVcGuObzvx1nH5thJASYxgszVVSQccKOlbLT7X8/DTLTwUdq9ytcvfHzN1vgo6dx6Bj5xugY4cgxAoQYv2V0NEH3IHQLACngA5eCuYVCBsjUAWu7O6jTXv7RVsG9EoostXbRZFTKcl7PBZgwZIq7USKjbmwvMHYFY6Ns7EwgJIFlEiBb/m5NO/s+YohJoX4ISFfcZ3HqBDQjdfuSZCAViZnyOYIg+FijipA4mBRCCXuvUqIMZ7k3w7Ea70PuoBC/SfucVpvfdd+MBmjxueoMRnceoxhzuf7v929pwFA+BjLxcT4+oHPBcyeORXQRrDbyJSvHIJWUL2C6tVyXy33P8dyX0H1Kner3P0xc/cboLpFQw9DdRjwZKgOY+sHJMdSZxhc/3PErlPFSqDDm0hPY3V/g8E1roBQsueOsYbgQde+01CRaz5rbpgPYxt33L9vZGdRYaBpBoxsaRzCnGWSRKrfaNyBy8BV93Ua8Xp2MELIm7onV4052GlPCcIvTk264QBycjm03UZdGznmGMem6GnixuRaLYxYML3+yOCrlLOPztfQiBBDpoZf+NuY0rdBxAgail+UHl3XMbSjH+h1FYf336+LIfSALvvM91VuMJ6ApFsqogrX6C5z9Fn76wrkOTUV6yRFf8+ui2MmiNCNhDsjN6sOvhto7Qg0wmEt8prRGNoH87nMi3cfpi/JAnGprgspHnIljGMjAZl1CWGk695J9ukITtJLUSzThTnnfVL6OAfzjAQhGIV8FBPGyGxoDXUBC8IYKrg2O05iumjgrOsXmQd99oWFuFbWN9bG4OS+aIAVG7Q076VeF3UDUTiYXsfT4+YQAsf1HcdYFXU/SGZRphct6PVcIf6WUXMNNVdTUy+3pDCmnXnmY28Pkh1J0FBpaz2buaHnFuhhtwV3kOq2DGgJK0f5kyov89qz5SjRc5FeWY6P4sOSw6JbnkZMjSMK1szQJ0PiLaVU7O+EYOhgqswWKWTas8W6Qaauzgi3dVAQyTUsXe4ChNTynUNiCBNMdI5LuEYw0mym6LT9TXsW6sJv+pcYfivprG/PYKXFkb701LNlRoYuMnRNnVBWfnvyC4SF3EYddB0wAXC68b+uBFbQQm00tPZWfk2+oefg8oG/wKCpqKhv/uhviqC9Mr/TgKPzMVCqEYHnH5nB38TSwtWsZKxs72DbgrvyhhIW0S27GXnzN6C4sP6/6Ysan2y2WEYiXP/ZVfqBSvL/U3f/oopXVZqfsdJYTIzhptlmpwoLQf7aYrrdLT+lT3vBv/BU56qG39DcbH6tpkgoCmmCUa2z2lvq02IxixhNEB/WMLLkSmci9PWY/kwZQgt9WjIGkSm0dzwEeno7O+NMdcIY8Il+xb9Vmp/d85bQfLI6+QD9m/DALdi74We98OyztE3cBDxziY4lbzJnA+harVKBP58DYqcrQiGkHokInysvNYULugnBMltIDf3yWVkWY6ihCvo8MItXahRMzEn4guMf4QV+V3YTGkyPXrQ/2rNRZMxCHZk4rgztH6MN0eYuWRhh9whVFwAYK3B4P5zuUARiwr75kPGiYSepBo4FIthCmfBp15v1A1e3FHA/kiqBfrcovm29ij8YZM79bUfi3WYHvvpVqOJ2w3f9KpRdULETakS41YduSk33ZprmmZM3zU52dBUu+vrXovLOGfqsJTgXh9/d4eYQtpL3eBukxJ0HPPeadYm6W4Pgw2vo0QMoh9s/J1X09ouxPRT6Urvk2T8ytVfXbPNTrDf7Hg5cmjPDoOQ9Hpk2+1mFI8xmx6swZeedELae+S7E2wHkxf1/AcCa1p8= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +## Request + +

Path Parameters

+ +Import results JSON object, containing detailed results of the import operation. + +
Schema
    results objectrequired
    + +The results of an object configuration import job. + +
    property name* Import Object Response Body
    + +Response model for import of a single object. + +
    infos object[]required
    + +Informational messages returned from the target service on import. + +
  • Array [
    • details objectrequired
    + +Message details if any, in key:value pairs. + +
  • ]
    • warnings object[]required
    + +Warning messages returned from the target service on import. + +
  • Array [
    • details objectrequired
    + +Message details if any, in key:value pairs. + +
  • ]
    • errors object[]required
    + +Error messages returned from the target service on import. + +
  • Array [
    • details objectrequired
    + +Message details if any, in key:value pairs. + +
  • ]
    • importedObjects object[]required
    + +References to objects that were created or updated by the import. + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-status-by-source-id.api.mdx b/docs/api/beta/get-status-by-source-id.api.mdx new file mode 100644 index 000000000..1c25baecb --- /dev/null +++ b/docs/api/beta/get-status-by-source-id.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-status-by-source-id +sidebar_label: Finds status of source usage +hide_title: true +hide_table_of_contents: true +api: eJztW21z0zoW/isa74cLTJ00aUtpv+yUttzpnQLdvgwfCjMotpIIbNkr2YVsp/99n3MkO05SKAvs7r1M7gduYktHz3l7dI6i3kaVnLho/zq6KGqbKHHl5ES56N1GlCqXWF1WujDRfnQ51U4cnJ0Iq6raGieqqRKuklXtRDH237yEmiQIbZyeTCsnHMaXYjQTJ0evmiEnR71oIypKZSWJP0mxwERVFyzu+cxDwdONqJRW5qpSljDeRgZfMNbNB2gCV8pqGi0jPjkiYPNVMcCqf9baKixX2VptRC6ZqlxG+7dRNStZcGW1mUR3G5H6LPMyo2fDZG/wbPPZ1k462BvIZ083Bzvp8Nn2zs5oWw63hnvRHYzlVFJbXc0Y5ZVT9rAwlfpcHdRABuvq1OzLJClqU7l9q2QavaNpVrmyMA4GB4bh5ib9b1GLix8ycUIoTEViZVlmOmF79z84kn27qn8x+qCSiuxuyTuV9si8n1fttGzybgwJj7wnDpJElZUcZUrcyKxWTkir9t8aIWJx+Prl2enx5TF9o/9iwXEW4ipXkgNNVkIaIZNK38DEIpWVbNScSidGSplgA2nSZeNgMSFvpM4YwbiwHUP2PIqTVz8Fhymqb8BCo76IJ+oGXgOKHpo6pzDqPJqDRighYCtd8SzvA3aB90B0d0fvt++LrsNMIzzEsbXAEYtzzm2VCu3DjfJFOWhVpDMBe2gDD+r0J0ZWqiqY4rBI1cPR9UIbFU+s1IRQMeQEEwUk3ugUM0RewMBeZJMxPG7RrrBEbyCeyxT6ev0OgzJkRiuTj5BFnPQQoCujMV80U4ROW3/es6zaVXL0dHNvuD1+ui0lKGSwuzPaG8utrc29nb09Wj1XzvPvfG1prZytLP27MsrqRGRFAo/8CwYBqcD2DIAXJ26sVO4e9gHL+Ab7X0IvP7ZVM+AVRHUbQornh2die1dk0kxqfi4nS0Yw8dUFnpg64wTwTAzNveDXVk+0uQ9KkwFHxy8Ork4v8eT8+B9Xxxf4RLJW9qsDg2hNKSwBFbEwLT4x4qDAJ0m0mcEcKu2JJ0HqkzbV24E67HQzB2MitsayzirMCKvfM6MrWoxtkS+kUuL3BfFI91RvA3yBZ7mskqkYSYcJcCENf+JZMz4Nlnwiptg0lH0MPk1TTUrKrOHTXM4gSMg0pdT1AsY1UhlgdDUt6opYRy/zy9yUi96Yc8lp1ymUHED+cJwcJFUNcKxmNwvbaAkQg3+A2VtuEd1lx2hs0pmpiHoxMpvBjNbCwmIE3TSYNdARucuBeEwzrmWsLkUy3b30YI6qgt8lsnbfkHdnGegnZtXaFzcqJB/CoAhsxN5o3BQYCS9JbZ4cRrXuahJfjLXK0nXurnN3nbvfmLvLL89DTR3ecukzWC19roxEbV5Y3jxXSh/L0WMK0Qzi8iY4ckPAIKFE+uPNJRL7I6o+jFefS2ovfmJ95LfyFfAHrT/88xGVH62zFnxBANmOXoMxmEil+4x7jpgN5U21tbrai8KONALU3FMigjWtmBU117a2NoaQSLch0kI581uFyhj8iNYHeD0D0qomjctCm2pdSa4ryfVutN6Nfp3daF1JrnN3nbt/zdz9aiXZouJsCXWSq/Nc2pmPtPCetJUCA0RzuivalGNXLVcrJEy0NVa0WDlEo+FgNBjvJmo7ldvp06298TB5OpQ7u4PdwWh7uBt19/rreR63SbaYUx1/ez+yiVHE3aCOqw2Cy1VFkS4e/8G8Vo2J1oh62roZNodJ37W143BvtXa8LArxUppZUyG5hRrSzG1EnIaxOY21zVgMkGICXjQCVKWBi0JJ5wpSLIJGZDrXnLykBeTaWXwwrqCKT5QmyNpVtEmyGgiZCbKCquYCgaXp5HZMNR8kcAU7ATv/xOo0uOiHKnlxThqfksbi+HOiFCV6W7nv3He+ewLwljjiwjv4Cwe9vtuRBgGAhsBzVlt3ruvzdX2+3uPXe/yvscev6/N17q5z96+Zu/9BfR6qoS/X5xjwzfU5xvY2RVtLvaDg+p+X6ZwqAQGHtyiSpLZ83NzU4FxXIJTCfRq+P0P3T6K+v18Q830E179tLtDc9cPVDrrBQhWiB1fbDJOmVVW6/X7/Fj6Dr+56stQ9UBncVs1M8amXFHl/BEPdw0F0WcDnGw3gi0N+gR5b2WoKZM96LNzbnPWikIXt+Xz4q5LpMhA5cwZlhBezIRD0Iaj4MSCW6Ch+czy6x0G0oh/0urLZ3Y/r4gV9QZf7zPfV1TBeAOmSiqRC58LRBZXffvWVa0fzLYVatuHKYq9p2FA8V9KiN/C/Yjz6483lYzGhopOTvnZU7ypNXQLS5gwhwqR20Jzo0yTeZ2xRT6YM/GDhNxNKIjHOoLB4ay6UEtcnwQivwPbnoGc2KU1SzAg0692jxjupulEZbYS9uSUp8HRq+rBQXy7Me8ybHncH2uBjzk97b00sjjRxkabNm8YEFbnZE9dlo5fs6PW9IP7WSIu9tJilucdLKLxprxN/BydBJpMImTm21ncv7uXFHXnUSuEJSV3GQJYIOBZ/6Uoar303jgV5MclbxPHWvJlq7KiL04QnMOGwIWapOBHJtCic+rsQFDqUBteTGln03bA+0aIxZ0Q83OxAiv2SsQZLKsZ3isQwPpjkiPZnLk8KVG4m9Sn5nj2LnH/P173eL+jMj6+xjdLItEjcd2OmBWNaMPYc4AJ+v0tRYCG3SQfmAR8Ah3P/MxMEoB3e87LuZXUW3+c5tDUkgOovApb7/sv+nODCJ8EvaHQ7BjRM5XX72x++iyCLtqoFYzUHA8sWXMWbFdghl+zm8bYHU7Rr/tn0JY0P5ucnr002+9ks/QUm+fPw7v+J8dZM8ysyTSh4Kdx42dAZdIP8eajXVs/z6MB5qvAv3nKucm2NzoV7Ma5iuoLKTFYU1ZzVyVQrPgkoleR7zRsUWUXOmYimndIf/R4LmliMQdo61KRypDPI47PqZmXJCeMLS/IrfXc1tyO0VjJFZ6l64g2aM5PALdSY0W0LvPtQhA7tAp45I8eKo8bZKLryvDZ0Sxmw61xIhNQDEZFql9SeuNCnGdXYouDSr53VZDGFGqnQ4xbF5u71mA6Z0b92HP/AWvC7CyfMMD15MVzwnytyrjKOTBq3WLY/JBvRFk9VVlJrCNZFAaY6K7w8uVyRCGEmXMQu7KQfJrk+jYUQao98+Gz1Br3NmNsFPC8LV6GZ7Qh/gSxynb+O6F7bX47F2/kB+3/jjyzC3kJNQb+kIy1CXPsmxTeH19FCc4g5+52/rwj9ITqOKdSk0be3dAZCDdMdPUbvTw329bt5L8Q9JNxAn9GKjkEM6itaPzoPf5bxWNzzNxv3KtCc3JnZvGmP8PGjol6/hY++GLj5SIYx+df+0KYzceVnDWqw2kb692OKFPmFvTp8gP5go38DyN30Pg== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Finds status of source usage' (get-status-by-source-id)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Finds status of source usage

+ + + + + +This API returns the status of the source usage insights setup by IDN source ID. + +## Request + +

Path Parameters

+ +Status of the source usage insights setup by IDN source ID. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-status-check-details.api.mdx b/docs/api/beta/get-status-check-details.api.mdx new file mode 100644 index 000000000..22e4bccfa --- /dev/null +++ b/docs/api/beta/get-status-check-details.api.mdx @@ -0,0 +1,95 @@ +--- +id: get-status-check-details +sidebar_label: Get the time check configuration +hide_title: true +hide_table_of_contents: true +api: eJztW21T27gW/iua3A/bdnCANC0XvtxJge6wA9suL9MPlJkqtpKo2FLWkoEsw3/f5xzZTkxIabudu23HXyCRpaPzfp6jyLcdL8eus3PeOVH5lY6V2FPuUhwYr8a59NqazsVaJ1EuzvWUv+50flVe+IkSXmdKxBMVX4rYmpEeF2GFsCPxZ6EKlYiTvYMjzIsvlXddIQbC20tlxLX2E/EmH4tBkmnMz0Vj9zAqCz+xufYzoZ3I1Z+FzkHRWyHjWDkHFjCuTDK12vhuZ61jpyowcJCAy7HyJ176wu0Sh3vKS506zMqVm1rjFIS+7fQ2NuhfU74/mHdetstylYtJSnww2oxZ/kpocHUl00IRdZqijCeicjpNdcwMrX90RPm246CuTC5vuXtff5m80VmRCVNkQ5WLRM6ckCYREBWakqkYQWmse+KmoT09t10wg3CsB5Y9aJHsPc3tlXaYBAILijooNzjSpvAs0uLEI3mzqFRwRe7hZ1MFIezwo4p9WAFTeB10/JkbLemkFhW+kIVJYqj8tYIDBYmCAojHkgPnc2yC7+pGZtMUQ8837h6VYGnne8qHOVj/cD3e8FP79e6wn9eePq90pM7dHU3rP+R8u6mG/4j9PIeBI3GsfJEbeJgesc+RBZXzYmgTjgttoCGddL/E9T5troR53LWJWphbC9pk9rU2KoKvaeJQMcsxFgpWeEKemdlciUCS9Egi8LzuotJIE91N8UomkDfIt1sKQ9rMJXs5RfVjDJ0ZjfWiWiJ0woGyYlu1peTw5cZ2rz962Zey99/+5taL4fZIPn++sf1ie5t2z5Bq5Dioptxb5rmcLW39qzIq17FIbQyL/AWF5EpC98wAb44l2qvMPW4DpvEZ+j+FXGFuLWbJr/Dqxq8JKV7tvhX9LZFKMy54XI7vKcFEZycYMUWayiEN+bxQkDwQfpPrsTYPsaIQHpRI9vZfD84OTzFyvP/H2f4JPhGtpbIxMPDWhNzSckxN7DVzXApwLZ1wKoU6VNIVz0qqzyCQNG5xog7f3MxBmfCtkSxSjxXl7g+sWCQtRrnNGqHEcXPjxRPdVd01pBiMZdLHEzGUDgtgQpr+bICyM/XRYanJZ2KiZKLyp13Uq0STkMhVoRBg/QyEhEwSCt1AYFQglBXXPlt4YSzqomraYq7KpjXmKeVw0SgUHOD8cT8ZxL4AcyzmYhTW3lKyWNoHPAfNNbk7XVAaq3SGchhDCpmmM6gxz6FhMYRs2odiSZlMk+4zaap5dcZazJSc7o4CM3ve8rNYFu4z4u5tivQTsWj1gytVBh8n7ZCN2BqVmcqMhIcMZGhxOas2VxX4YqRVmrSx28ZuG7ufGbv3Hx6XkLt8ytBncxn6nJkS8lPxXII+OXuPsVVf8FdAuMGQa9RDlBDpt3enZZtB/cHNlADvN8RHoZQvMT+o7RHGh1WXUJX+uS2IQdZjkGCETKSSHeZ7zjErKqjq+fJur20+1HBQ8wBERNbMxcwWQkJleWG4X5FuTSRWOfOLFxOJ/Fg1Ubbuo6K6kWqRZIsk22rUVqOfoxq1SLKN3TZ2f8zY/SSSrLniaClxkiuyTOaz4Gnlc5JWCkwQ1eGvqEOOTXUfrRAxUWOsThM5dIa9zeHmaCtW/UT2k5fPt0e9+GVPvtja3Noc9ntbncVafz6P4zrImjG1YO9gR1YxQNwVcFxh4FzOW5s0j/+g3lyNKK3xiXiFm6FzqPRijh37y9jxd+shGwgDO+YrjhfPjg+JPrZm8qQ3W+SxIpgdVIfp0jOkJB+GprXzLXRsoWNbftry89OUnxY6trHbxu6PGbtfBB37j0HH/hdAx74giDUiiPVvQscEuIOg2QhGgQxxAfUago1TiIJP5eljGfZe5mPla6DXQJG97WUUeWqtOJJmVoEl1ziJNHN1UXrD3Izm5tVcut4hxkiRRiBraaBb8iq6TwJMCv8Rqc40xzEJBLr5LBqMPKQKMVP5W72LNnFagENOCqmls1cLH9NwJzUi+AcKfA46RqL+hmecpbX+0XmwOCaJD0lisX8TK0UxX5//vnjolgBfnqB0cRJsveK6QDgzlwZthLqZhvRVQ9AWqrdQvS33bbn/Ocp9C9Xb2G1j98eM3S+A6iUaWg3VMeGzoTrmdjdEjaVek3P93xE7h0rJAbu3sDFj9WSOwaEEpzCo/Yw3OQPE3w2uPCj8hCJTJ2bHhWvAERziMpJ0iXoHaY1z0cNPYSoCrw88X7hEvJLG4pyS0sXdBekDXl9ewaZ0J4nDzvqqtW493OaN+HJt1LhK3iHBCeEG5RZ5CkoT76duZ339Fj4HX7vryqnuIhXD7fzM2OtubLP1IQz9QA6lK7MhX9AEMXh7ULZLXfaSXFMghqzNxIPPsF0o5OA7fEvik5SNzNgZZ+ikRCCzJhC0ZVDwMFicoiP6xfHsLgfBknyQ6yxP7/65LIHQClkeUt8nd8N8AU7viUgiXMz99ITah7D7krfOSyL9cNFb2uwNTeuJV0rm6G3CXZ4nv707fSrGBJo5aRWO8LrS1OUg7N/CRTgpD6p7LbSI62Rui/GEGR80bg5REhCjFAKL9+ZEKXF+UCrhd1SrY5QXViktUpzRaNXFk8o6ibpSKRXy7lyT5HgIk3VoaF021j3los3djTb4mPFo972JxJ6mXEqBwHNKEblZFefTSi65INfXMvGfiloUqEVMzT29x0VQ7XkcbqLHyEREQqaOtfXVmwd60QI9agUxQlTv80CaKPlo3veKK6t9NR8NehHRa/Lx3rybaCCC5jIRsppwKOhpIg5EPLHWqf8JQa5DYXA+LhBFX83WNW0acUREvY0FlqKwZaQj4Fvm7xCBYYIzySHhC4ZXNpz0cEh+YMsi5j/wWyMfGjLz8Dm9d4OZiY3dV/NMG0a0YRRygCv5D1WWHAuxTTJwHggOsDu3P2eCktGFvBdoPZjVmfw6r6HSEINVpuKmO+HLzjzBlZ8EP6DZ9RykYWoP6htw+C5KWlRqG8qqDjbua3CZ39Siwt/TW+C3/nmWqv73Ji9JPJif/7wx6exbZ+kVmeT7ybv/UsZrM83PmGlKwE7uxtuWnc2ik78q8dryeSQdmE8U/uIpxyr3Bui8wjuThGIWCU1T6cmrw2uRE634JGOqpCfst0aeZTOOxGluKfzRrzKhMUA9Hac7YFI51Cno8Vl7tbPkgAnAkuxK311R3vyg9+DQGauueIfm0sQwCzWWdOcYzz7assM8gWXekmHFXmVsgK4sKwy91Am2i0xIuNQjHpFoFxchcaE3MKrShWXoV6+qophcjUTocouVZ+7NqHw9csHwj+wFu1cvc0L1ZEVC6dS91YIcqzR0L5jXhO2P0Ya3RROVTqm1RdYFAFMLOxwdnC5RBDFT/ixj8/F6ucit01wQofYouM/z7mZ3I+J2gV57tM6jL1sg/tibu/f98Xb+I8F3+9ZvWaSou1if0tkeiV6Ebie0nuedla0nhfbq5hPtzAQ6JAq3t3RARN3YHQ1DUDp9OL+YN1r0DTuHgyLuVi8VH1DwUdL8DGL5x5ZGz/zrPtlfrqjA5Qfa6u7ub/dzqrM= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +
+ +QueuedCheckConfigDetails containing the configured values + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-tagged-object.api.mdx b/docs/api/beta/get-tagged-object.api.mdx new file mode 100644 index 000000000..fa64caa4c --- /dev/null +++ b/docs/api/beta/get-tagged-object.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-tagged-object +sidebar_label: Get Tagged Object +hide_title: true +hide_table_of_contents: true +api: eJztW9ty2zgS/RWU9mGSlCXbsnyRXrYU2c5qyom9vlRqynElEAlJyFAgByCdaF3+9z3dIClRkh2vk9qZSenF5qXROH1FNwTe1eJEWZnq2PTDWqc2UumlHI1UeDr4rIK0tlFzKsisTqe1zvVd7cop24tNqr6m3Swd41lNh6aTylHHKhmCvLidSCNHqnZzf7NRw70jUs9ZeNauhjehcoHVCU2PyS/H2gkgcEKK1NPGTCuGsRXpWAmXqEAPNV6k00Q1MF8irZyoVFnHADXxSSSgbdQMXuCOKEmOYKwmsta58w86NZdabUZ4o0w2IXjdXu/o4uLj2fnpcf/kCC+6Z2cn/V73sn/6Dne97tuzbv8NXR69u+xfnhy9xX/c9Q/5/jdcnp/ywIvTw49npxj7G99cnfeOoImNmlV/ZNoqKDq1mVoWX7FYIh4uiJ/GwirAVbcss/oqJ0lEMvB89xsr5dbhI1I/CUz/kKHgKsdh1VBZZQL1MCI13DkYtls7rX3Vbu3uNQe7g8FBq9mSu3s77f3woEYOYZVLYuOUI2DNrS36tzB9Rf7B1CtGmhCgaMKAnNCkNFAmSaQDduHNz45G3y2LHRfunFhy+FT7uf3jczX8Nql/+6d5z7yO54ZUtXZ4ecqKIvPC/CvQVumXDAyzfhnrYIxnCMWZuVnH0MM8imbQ3j7YOtjdOwh2m+1gb2sbV4HcG7a3gu2d7R0C4V3xrmayKJIDGuZ97XFY/8qQPeqUUGiMCLVLIjkVxOw78L7XUaTlROA/ecn9/X2RmUo1SWvllJJYqiZuZdBUgZ7IgYocoRgUc4Z0J40o82cJ4Lr2+urjcf9d912PrHzW6yMnEAadMr5K3r1neK1VodHDLCYVR9YiKdbFuUozazCv9pqhsFYOMROHUwGlaHMrIx3+wKAJVSp11IvDlfFQBXusjaqPrNSEUDHkAAMFON7qECPEJLYwMbMsjMt01bQCTTS2xWsZQl4vXy8XhjRoZfA7ePWf4PJXRmO8KIYIHZaLy4pp1b6Sg72tdrM13GtJ2Txobe/vDtpDubOz1d5tt2n2iXIOS90qP6pO/UYZZXUgojiARf4DhcDFoXsGwJOvcL0HbMA8nqB/SuOethQzxytoEd/ASvu6dyZa+yKSZpTxczlaUIKpX13QulIJYkjuGZ9aPdLmsdR4eHTcvTqhZHd+9O+rowtcEa+l9b9r4K0huSWgwhfG8RdGnAvwRTrhVAR1qLAhXuVcX0Egadw8ofZ3buqgTPjWUGZRihH57CtGzLMWQxtPKqEU+IpHvNAN1dhArOPZRKZIOwPpaJUyTP6qGwQqSesnuSZfiTFSmLIvG6IbhpqElJFANIIpxk85aYQhha5nMMwQygCj03GcpcLEqQ4WlteZKpdSap5GTuaNQsEB5N/2k26QZgDHYs5HYektOcTcPsDsNVdFdzmnNFbp1KQygBQyiqZQo7W8mkM2jSIvT0dkLofEYwq6MmPNZ0dOd289mMM05neBzNwT4u4sQvqps2jli1uVBx9nb5+N2BqFmfKMhJckNg/OqUpzFYEvUJBG4Tp217G7jt0nxu7iy/O8IcjfcumzvVz6XBmJrjO2vHgulT6Wvceg/MqJuLzJDbkhoJC8RPr1/SUC+3dliF59TagL+oH1kV/Kl8B3S3v45wMqP0pjVWxBAFmPXoIhMpEKO4x7hpgV5VW1szzbcWwHGg5qVpSIyJpWTONMSKjMZsYQEuk2RBgrZ35JxVgiP0pEhHM+A9KsJqwnsTbpupJcV5Lr1Wi9Gv08q9G6klzH7jp2/56x+2glWaLiaMnrJJdNJtJOvafl70laKUAgiq1pUYYcm2qxWiFmoqyxatXKoTZobg+2h/uBaoWyFe7ttIfNYK8pd/e397cHreZ+bX6tv57FcRlk1Zias7e3I6sYRdwt6rjMwLlcGsdhdfsv4+16Smu8I1nUzdA5VHpT1o7N9orN9zgWb6WZFhWSq9SQZqYjymmgnRCtLWhBIMUIedEIpCoNXORKeqLAxcJpRKQnmoOXpABfO613hylE8YFSOFk5izZBlAEhZ4Iopqo5hmNpCKmGVPOBA1ewI2TnH1id5ib6rkpenJPEJySxOPoaKEWBXlbuu6v2d/sAbylHXHgDP7DR67sdaeAAaAh8zirrznV9vq7P12v8eo3/Odb4dX2+jt117P49Y/d/qM/zaujh+hwET67PQdvYEmUtdUzO9X8v0zlUcgTs3iIOgszydnNRg3NdAVfKT19RDqFjPJ3apj8DVPeCus078o37zTsd3tPBHi4OPa7MRqAfp2niOpugUwZmum/IRDeQxWCxdGriL40gnmwOoKMV6YfOCfhQIwLRPevn7UWDFWw1+bBPeMzcq5tFIm+F2nlr+FHOxfGNaZwhxTGbDTqtkvsTPwbEBM3EL46pG+w/S/JBrisb3X+/LJ7RA7KsUt+js4FeAOmCiCTCzewU3QVV3n72pbN0s9WEurXm0mSnRNYUr5W0aAv8Dxgvfn1/+VKMqN7keM8clbpKU4OAiDmDi3A+6xab+TSIlxgbZ6MxA+9Wfi6h+BHDCAKLD+ZCKXHdz5XwDon+HJmZVUqDFCcDGnXzorBOqG5VRGtgY6ZJcjwdmk1oaFNWxr3k9Y4bA21wOeGnjQ+mLg41pSFN6zbR5CJynyeuk0IuOSfXc0H8o+BW99zqzM29XEDhVXsd+OM3AYKYWMjIsbaePbnnV5/jR10UnhDXRQykiRxH9UeuoLDas3FU+NWJXxXHB/OeT1pVhwmfu4TDWhiFoi+CcRw79U8hyHUoDK5HGaLo2bD4eFedI6Le3JqDVPdT1nUdpSHjO0FgGO9MckBLM1cmMYo2E/qQ/MSWRcx/4qOEnyoy8+NrrKBEGcaBezZmmrBOE9Z9DnA5fr9AkWMhtkkGzgPeAXoz+3MmyIHO5T3Pa2VWZ/abPIaWhgBQmYtLOv6mM0tw+ZXgF0Rd0iANU2Vd/uyHe5HzolWqoqxiT2BRg8t4oxiL44LePN5yT4oWzL+avCRxd7Z1cmqi6Y/O0g9kkr9O3v2TMt460/yMmSavdcndeNq8KZh38td5vba8lUd7zWOFv3jLscplNZoWbsO4iplnlEQyJa/mqA7GdEodjUOiZEq13wZ5VjzhSES/TuGPVo8ZjSxoELYONakc6Aj8eJu6mFlywPjCkuxK9y4rzyIHYzSVqiHeoy8zAcxCPRkdtMC7z3HenF3AMmdkWHFYGBtF12SSGcxGcZlNhIRLfcMjQu2CzCcutGhGFbqIufQrRxVRTK5GIjS4O7ETdzqk/WW0rnOG/8ZcsLvLN5ehej7X7T81mAlyriL2TKKrlu3f4g1vq49VlFBXiKyLAkzNzfC2f7nEEcyMg1zovmM72swHuU2iBRNqj7z77DS2G1t1bhfwPIldij52jvkblYrKtymLDng321B/1kcq+YpBpf5mQntUhCPzrYfv9q5r1W4Pgzr5hysdHdLx/zFgE93dHW1nUAN0T4/RxlOvfH0z6224J4Ra6Rpd5RCBvvh5x7xAL87zD0Feiid/gbJSoGJrzkxnXXkNl78raubz7xK+A9nTP0d5Bjwo+Z4+0fGbQaxC/8JvF80NWfpBhfq7soV/c0SOKh8oFfILmAvJ8L/usZx6 +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get Tagged Object

+ + + + + +This gets a tagged object for the specified type. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-task-status-list.api.mdx b/docs/api/beta/get-task-status-list.api.mdx new file mode 100644 index 000000000..24f1af5e6 --- /dev/null +++ b/docs/api/beta/get-task-status-list.api.mdx @@ -0,0 +1,111 @@ +--- +id: get-task-status-list +sidebar_label: Retrieve a task status list. +hide_title: true +hide_table_of_contents: true +api: eJztHGtz2zbyr+DYD200pizLTnzRzM2NYjsdt0ns+nG5OSdzhUhIQkMCDEHa1nn03293Ab5Eya/6mianL4mMx2Lfu1gCuPEyPjHe4MI74+YTe8sVn4hYqMz7uOGFwgSpTDKplTfwfhQZ4wyHnWY8yw2LpMm63oanE5FyHHQYwrCJyKoxb2AIjEh4ymORiRRXuvEkgvuci3QGfQp64M9IxhKHNtd8y6+ZyuORSJkes1SYPMoMyzT8zPJUdT+oUyHYxT+22fD4kMGaKuRpyPZ0FIkAYbDjcumPP0yzLDGDzc1QXIoIse4aLqNES5V1Ax1vylBt8kRuGgfHD0o4fkXCMzbWKYt1KphU8DMm2pERqficy1QAF8Y8MmLDE9c8TiIgr/+8t+GZYCpi7g1uvGyWIM2wrpiIFGZaMLZpuw8NsVQyzmNvAPNifm1/E5RQjDlwgf6azzeWc1OPx0a02XlEzYA2cDCbCjbOo8hxlUFHl52bnEfRjJlEBHIsRciuZDZlHZJOBxmf8IlUPBMwP9X5ZEpwnGC+GnH8DmGU7F/N/EDnqs37wzHrZGkuOkxmwFVgfKKTPLKsFKzzT/9MZzzy93B2B1maaGUEmwoegvqTHHDgEnOYcoCo8yhkI+EsAyQnx6XcgH+sY3Wiw64EsmqigGMhSAxkJlWA84AMk0k1ASvPEBVGhLCAKzbllwKaQUbEHBwv44QH2QZSIw3MBomB3whhYaUz1BQjcNUOAfkbUd5BnAjbSx7lwnIBRwPauSmw+So0COlZokQjrSPBlVfTE5q5UlfGMiK3uASWyVIQhjevrQqqhT8QPeeDxWf2wTvNg0AY88FbhnJTC1/TeqXq5AbljWpVsIiZmcrA69ppI9Qj9QfL4zvLFMDMd3g+Q8V4XbSivpk8SXSaAXooO/JlAEpfYTf4rSg0pPQ2NOnUDBBCpyPDTmfAOuIz6K3q2Daj8zQQh0t6FrndHoGiqrd6q+RsENlb5VzzO2hK3DcCWQIkNlXAD1JBrXfK+hTW/JNLGtmyKOdT23Y/KQ/Qw1iGdID7H5Ep1nEaZHG/18P/mnw5oRGgIeRTGylNsUyGyVDpcifyUijbdriPfiHQECzAxwNoniSRDMhjbP5mEP5NW8Q8TTkqg8xEbNoI7YsMmGc1NsjTFECjlBAhcPO8iMYBodCQ+4UnURFomQ0vVxLU7h1qXFMXKAMDqK6LZ6ByozwTqI+VOsU6pJgPPyOeKyCi9jMlsskeqHnRNnA++CDIHvFnkuoJCIJ+CrAule25uYQ+RiiDGabjjx79Brph58H4TFrpAW0tXp3ODDDRnwglyDiYJRoEg7wqZZdNQX1qgk1FAvgAHsbbaBleZVwy3Opv7zxHi7ODFpc/g1Za6OGLKMwgLrxfzocnZ/+Chl+Oj/bwv/OD84P9f58NT39GjlS4uIHzhlxbCGHrU1D+Sk5oFq7XWKGtrOVfT7HukJ0ISjnrCNS09VaC7binQOPYQioQKJW+rX8ivZSQ/kCCI65FkLv07fesba6ESHDVwhRbi+5hBzI8xHTx0eSWAQbB+JkkZ1Dh0e/1e35v19/aOutvDfrbg63n3V6vRypY+oYWbm+4yZjtDr4wkqXXWoIk9nw5zCrP2ZZt6Ui/OHqVM78NyyoyPVLxnSN0WSu0vOepsn0Haaox0pyJNKZtZkh/xIntaPjHYv68FnlaeL91PYwbowNJEaOM6/fG/Y74XZvt1lsI0p8Ezo50wCP5HxGeieusitq14sidEfGOoAQ0xSUCq/h++O71ETJ9ePIOOX5ycnTSZCwNmC/i27apohuzpnjl+iUldYYQaFHlDIhAk1I3YpVAWQnhltCimEC1gd0rqGtAmVX4l5q+rIae1SS0FPbBMsCYNciM+kvmFAoBfagFrRV/FrN7iK5clyOQebOitoqIagzltVjgSBW5aESNu8xwlYo3xVffglzcFLsa2sZD1l2nvDKGkvR5lfMtScaxwxYEAM9Ux09umq4kAhsdSrMXVFEt5MSUddxpiGppbrIvTRLxGVO1HAUxsETul+uvlm/ERyJCbjfxaa00LLqXr4GbpzF50ttyXeCkzGZUcPIWRdhEeT5v7BpWo/PwuFAymIehtMp5XGO1LbSUWN8soE1luGq70Y5bbjtVjHiKXBFGp25bvri5Wb2+HYhmWQXbByNT1ShLbLZ6veXWBzKbY8/Osi3wXiQRK+vFfHZSqxnaei7VAtlIhzNUJanAPmX4mK3vCvuxtrinQ7GsErJYs1LCn6RcIobWowcwEWV6KUOsBVDtzoIseErjug25ASe6W+wVD4FeS9+eIwYZmPLgE8A6DO9G6NxuOYspTFb1iSXLil3BRy96L/s74xc7nPf/urO1+3z0csy3t3svn798uZjALDi2xY8wsO+VAStjM8iKA+8JAeGypxU+fHWIvZ3cs2kRbksy41qc3GCcvdo7Zju7LOJqklM7nywwQfnnp1gOyyNwcUUFtUgyxFEqJ1ItQ6XIWvYPXg/P35xBy8kBbJlP4RfCan2lgqAvVYhqqalIPtVXhLEj4AoithFYiRJhl3Uc1A4QxJWpD5T2L0PlBuaquTDDrb5kRh10FcgKUyK7uc7YD7IruhtshG2QrsOmZMQNTAAR0meAISS1Sea/cZzsuPr/sy4blv6xiJYxhJqRYOA4bfHOftIBUxaU4+o8w+o67FabsqhY2ZTGQvZSCAWNwyWAt+vJMMhyQI7IrFthqS0ORScfwNlyrondWY1pxFKsUgZABVUJAg3+NADPBLTJzDDnjqhYCI5HFeNKj1V3juTuXFayn2nqC3hu7mF3xxG4H59IKzsuhTM++iJpvRFJoxCT80juYxtNdqNKcRWGb8uZa9td2+7adu9pu4udJ67w73op9dlqpz7niufA35SCZyv1SUl7lGbFIFvSsoLcYLiNstz56f0ZGPYnoXC8uE5wO/GE+ZEN5e08u5SH+2pTfNQpQn8lC0SQ+GgpGIMnEuGA8K4wtkkisWq7vdprnY4kKKhakiKC10zZTOeMA8vSXCn6cGw2WKiFUd9n7pMxlWisB8RVVejbb0TrTHKdSa6j0ToafTPRaJ1Jrm13bbtfp+3emkmWWJG1uDzJ5HHM05n7yGD77VkNGFCd3StNzhbKF7IVBMbKHMtrZg7eqL812hrvBmIn5Dvhi+2X437wos+f727tbo12+rtePdZfVHZcGlnTpmrytnIkFkMSdwl5XK5AuUymddgs/+V4fmiMbg1dT5k3A8+7VPUvcsedJZ/pdQa0AWDIHdMV5cXzkzcIHz9QIHjkG53FwjTbss6eFsSUks4Jimt7nnidOq5Tx3X4WYefbyP8rFPHte2ubffrtN0HpY47d6WOOw9IHXcYplhjTLG+ZOoYSnvhYwxCARqK48vl12tXfSzPVacTkZWJXiOL7L9ccnxDa7yTNiuSJdOoRKqKXejeYGyMY9NiLAzg7vA2eC0J2S1qlYwF5qR41o6ux6AdI0EAN535wzHej3CXbpy+latIFUQ5YEhOIdJYe9WgYxJvsIwx/QMIVAedgKN+whrnyvNKD6gHsxOk+A1SzA6uAyHQ5sv67/NlpwQO7YmhiJ1aWa84LmBr5lzBNkJcJ9Z9lSnoOlVfp+rrcL8O999GuF+n6mvbXdvu12m7D0jVXTa0OlWHAfdO1WFst8fKXOo1XQv+ozN2MhWHAal3eW69ysGBCUZAo8xmtMg5pPh7VpWHeTa1tw3VAE+r+nH5UMQAfFrofcSrl7EARXRvQKAH4jjJ26QJprglaPcNlow8jWBAcZf0BqQLUp13eSK7xTFfpa/oQukIWLrEW0lTWC8OoKurdoEuySOVqPLWPxJwKx13Ndsr76zeCrk4zT2DPQuzYDYYmIdTP2rGQ72w9/je0OguqVuLPqDrPI3mv58WC2gFLcvYd+tqMJ4BpgskIgkfK404xUTdrt7Siyr44CeCfmuxIxzWZ68ET2EXYU/N/PDT+7NnrHaNk+4nC4n7CTCwY1ARcn/D4gQJTqKIVD07MWyc0UFzY+MICGbuFYFDx4R3EBdOwJETS3GSIN+Bs+5/k5k35q14M+CD8tm+TO1FZ3vtwpFo31W4SAq6eI2uxyLxXQHNt9B8goa3qBtYWNZeBPbMdwA2jyB4ZIhbj17cwvNr8HDTBS0IdREH5ITDo3myKiik9mg8GvB8hNfE44N6P5UQe5vTmHVWzEzp4YxDFky1NuLvjKHqoBlcTHKwokejdYWL+mQRfr9XQ8m3S/rSh0yS8HsDhqGsMvERRnJKZLStqZBJ/kqSBZv/lS6J/9qgmZovIODiyFAHD7iev4AzLujjgr71Acbh727OALJg20gD+QGrAHuV/MkTOERrfs/CWurVCfwmzcHQEACqBMUkA/vHoHJw7hejDhxdjgE3jIl4edYM/mYOFl1cqTOrKCEscrCNb6Qhli7wzeJbfgjF+PpnoxcpHlaVliMVzZ7aS6/wJH8ev/uFPN7a03yLnsalxqhutKzbQ9SV/JXL19qVP0MX9OBf6CVbpSwc9jjVLeQ6oCTiGd2mRasOplJQzSARPMPcbwM1S8dkibC9R/MX7hWTCT0dkALKHHZ5MgJ4VNUuVuZkMDaxRLni3yZ3Zyw0qCTsQUWXvYdtnApALLiFw9O90Pebdnu5U5DMMQqW7RfChqQrjnMFq6Fd5jHjoFJ3aEQoTZBbxwU7OiUKXmhK/cpZhRWjqiEJXdrMpLE5Grs3GGqCv2MtkLtxtWhgfXV/06sIORERaSaOa6btd8EGbfOnIqIXHMDrQgImaiu8PTxrQQRgyn0A0elk000ymzgWgOD2yKrPdner2/Npu4CXDbXJYN9VA46fLEhHuL1DaJoP8y2841GW4lc/5eciBKb2mwmWsOj5EbvVsNu5C6++nYMNwhSwwuabGyxu4P5mjs32/SPc5AGfUHlXvFJUR+vreu1vKa/ojnf5mKErCHj0LNT9+fD/9UzfLXwsnzF8JCPXb+59fW/u3aIOxcOKj9SG9dt3/9u3726VXfXQ4SOl9//3mt2t/KweFKz4+bEqE0Lk/QhjrSOjMGyn2U8OtVmtj/KNQu6PB5i98BX7R/cDl5rP/wsT6PGK +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 task status list.' (get-task-status-list)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Retrieve a task status list.

+ + + + + +Get a TaskStatus list. + +## Request + +

Query Parameters

+ +Responds with a TaskStatus for the task with the given task ID. + +
Schema
  • Array [
    • messages object[]required
    + +Messages associated with the task this TaskStatus represents + +
  • Array [
    • localizedText objectrequired
    + +Localized form of the message + +
  • ]
    • returns object[]required
    + +Return values from the task this TaskStatus represents + +
  • Array [
  • ]
    • attributes objectrequired
    + +Attributes of the task this TaskStatus represents + +
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-task-status.api.mdx b/docs/api/beta/get-task-status.api.mdx new file mode 100644 index 000000000..c4a995505 --- /dev/null +++ b/docs/api/beta/get-task-status.api.mdx @@ -0,0 +1,95 @@ +--- +id: get-task-status +sidebar_label: Get task status by ID. +hide_title: true +hide_table_of_contents: true +api: eJztG9tS20j2V3q1D5ukkLENhMUvWw6QKWaSwBhTqVpCbdpS2+6J1NJ0S4CX8r/vOadbN8uGwFCV2SlewFafPvdrq33nZXxmvMGlN+bmG/vIFZ+JWKjMu9ryQmECLdNMJsobeD+JjHGGYOcZz3LDpomGBxnumyzs/5OjjrflJanQHHedhLBvJrJqE6ymXPNYZEIj2TtPwReAkiEsSaST8mzurRIfW+wsmbJsLupcZAkDCrBBi99zqQWQzHQutjyTLSLEbGScwoctT9ymURLCoymPDAIEcxFzb3DnZYuUIDMt1YwgOe0ZeBxlWC6vEL1JE2WEwQ39bhf/NXkcEURo2I3M5m1VId+kJFrGbzN5LVRdcUGiMtQ9oOZpGsmAtLj9m0H8dzWGm4SPRMZlZBhXIQtyrQEFM5Yw6Iszk4pATmVApBqaurR6J/m3vFzJ33PxCQ3S1D8ZDbC6JZ6BoiZ5JtCcgRY8E4glTkKgQh8jnitgtvZRk3ioVQvsPgP20jFiYQx4H/mITmagcPoodACkD91eYj/LtTLooc5wyeQ3EWR2H8Bn0loJZGvp6nxhMhH7M6HQR0XIrNA13yJ7ZHNp6gbUIgV+gA/jbd3jLjLs9Xd297xlAbRKfgxPidDjiag8RoP9ejEcjf8ND349Oz3EfxfHF8dH/xkPz39BjVS8OMBlw64thvDpc0j+Ts5oF9JrUGg7a/ntOegO2UjwKFqwOgM1b71XYAv3HGycWUwFA6XTt/1P6GsZCExb4lYEEER/mLa5ESJFqkUotoge4gIqPIT1p4sLWSzmkJ08RONnMhYNPvrdftfv7vu93rjfG/R3Br29TrfbJRcsc0OLtw/cZMwuBz+YyTJrrWESV34cZ1XmbNu2TKQ/nL0qmd/HZVWZnuj4LhGe50FgS8RnrpVdO9Y6wUozFjqWytWlsYhTu9DIj8X+Za3ytPj+6FYYNyYJJFWMsn5/N+9ca77A/gZKzxoitd2O3kqR/iZwd5QEPJL/FeFY3GZV1a71Uw9WxAeKEsgUlwxs0vvJp/enqPTh6BNqfDQ6HTUVSwDLVX7bMVUsY3cUb6RfSlJXCKEWVc+ADDQldRCbDMpKDPeUFsUEug2bc3DXgDqr8G81f9mMPatZaC3u43WIsWuQGa2XyikcAtbQC1oUfxGL7zBd1c8ikmWzCd8kRAVD/auE3lQrStHIGned4SYXb5pvWWOiavqveZSDaFd1yatgKEVfVj3fmqYbFxhhAj51Ej97aDJLnIW2zV5xRbXSE1PX8WAgqrW9yZE0acQXTNV6FOTACnlU0t9s34hPRITabvLTojQsltfTYJJs/kCvC5qU2eIwyWFkWTVhk+XlsjE1bGbn8XWhVDAPQ2md86ymajsLllzfrbA96CJr5bjRrltunCognqNXBGiNlWnZHm4207eAGJZVsX00MxjCMxrFSm563e766AOb4cLuukn3MJLIlE1iPrO2hkQuLT8YHgK6ukkSLtCTpILwlOGjJtz7w8eG4iFN8+3xvcnse6mEP9NcIoc2oQewEU16LUPYAd2nFi66C5USXKdhNtBEp8fe8RDktfIdOmFQf5oH3wDXSfgwQxd24iy2MBmW5wNryIp9wSdvuwf93enbXc77/9zt7e9NDqZ8Z6d7sHdwsNq/rOS11TMcGHtlwMrSDLbioHtiQLjmaUMK31xh7xd3PC+qbSlmXCuTW4yzd4dnbHefRVzNcnrOZytKUP7FOTxReQQZDh9hXBc9hjjVcibV2pMc17QcHb8fXnwYw5PRMUzM5/AJcbUOuaDmSxWiWwKr4Avz5IY4dgLcQME2IgJ1iLDD3jisb0AgrkwdUNpvhk4bwLemPI8y2OGor9lRR13VsSKUKG5uM/ZKdkRni03wGXTrMJNMuIENYEIEfzOEnjbN/A9Ok2/YXPBQ6NcdNizTY1EsY6g0E8Egb2LoWgTTHEJZUIub5BlTSQbDatMWlSqb1lhpXgqjYHC4/u9+PxkGWQ7MkZj1KCy9xbHo7AM8W801uRvXlEYqXUDWDEAKOiQIEkinAWQmkE1mhrl0hOYykHhUAVdmrHpupHTnmpKjLKG1gOfmO+LuLIL045No5cK1cMFHZ5g2G5E1CjO5jASLlORxs4MqzVUEPoPZOgpfYvcldl9i9ztjd3Vx5M733Sq1Pr1263OheA761VQ8W62PJu9RCSuA7ImWNeQWwynKaufnz2MI7G9CIby4TXGaeMb+yJbydptd2sM+n2D7URqrYQtkkPRoJZhCJhLhgPiuOCZFWVXttKm9T/REgoOqLWaP29E6YU5nnxwSRvANfcUImH+hH2fgcvOMjmN2u7v3HpKsvECB/gm9BfwdklSu0PKAo3+wBkeS4CuuRdHBmYYFFSve8VDOBdgYYXUBCwDckQRVyyQkV5cwqvkM3yWwSMaSkgs6MuDVC384haHZ2b8IgpKKVEGUA4eUqaIEbZGAKBJ8XEyxJwUMaCE+g+rxjN6x8fjiEf7BRijxB5SYHd8GQmAiKv1hb93UcGIPECKGZ+Cgjg3jg40hrliuwM1sTi374pf54WV+eOlBXnqQv0YP8jI/vMTuS+z+f8buvfNDyRVFi+uGTB7HXC/cmyW7bi/oAEDVFZYhZ9+OrHQriKzTZWUv9R6dy2s2EN6k35v0pvuB2A35bvh252DaD972+d5+b7832e3ve/WSf1mFcxlrzdCqmd2a04aK44Dcu3yN1aHXOa4NLHp7InJhhD60rjyE6chePlIDPLz24/Le2QByWuhd4Y2rWIAjuhtk9J4TN3nbtMG+RN6+k+HSQzrYUFpZch0B1DzLUjPY3r4DE4Nplx2eyk5x9K+Sm06QxNsT0OualCVNEcIIwIZnJ8wS6JBRtES/t0mSkFsTkRrQw8FUaQLauRdz8YZnkeSQFgnNFoMYcT5Ij/GgHwaQfxiC7pDPteQDuS50tPzjslhEG2RZp757qQE8A05XREQRriq3OMdu3VJvOUdVgXCU7reInSJYn70TXMMoYUfpVzCdvma1q10G22MhcaiAKDsDF6EcOKQX/24TlSWd5DM7Ug4bgzvGHJtGIDD7os6FYJcnTgmfoDiMIJuTSnGToASCu65eFdYJxbWIsG52Kk2i44Hfb4OGtnlj32uqkTRMSGVvY8DTzhflsyOJqUtirUcYJyLNhuwyLeTiNbmeysTfC2y+xeYTNvN6hQur2svAvggKIPARBY8MaevJxC0+v4YPJy94glhXeUBNOD6axy1BYbUn89HA5yO+Jh9f1Oe5hALc3MZsxmIG6mcUshMWzJPEiH8xhq6DYXA5yyGKnszWDRL1KSL8frfGkm9J+tKHdpL4+wCBoawz8QmWc+pmEmj0VGhD8itZFmL+K10c/dqQmR5fQtVFyDAJzJN5RoI+EvRtDjCOf/c2HZjFu0cgA+UB6wCHlf0pEzhGa3nP4lqb1Qn9Nu3B0hAAq4TFpAP7ZVAlOPeJ0QJClzCQhrEbLyKKwXfmcNHL7LqyinOEVQ22+Y0SKKgrerP8lqeKWGT/bPKixMPquOVURYvnztIbMsmfJ+/+oIz3kmn+ipnG9cfobkTWDRJ1J3/n+rX28Z+hSzvwF1YpVqkVh0GnOhivI0ojntENO4zqYC4FHRykgmfY+22hZyUxRSLM+Bj+wp2wz+g6sQaWOYx6MgJ8dLRdUOYUMLaxRLvid5PT9IK0gjkMoqLDPsMspwIwC85xYB5c+y1xA905WOYMDcuOCmND0xXHucJXAsB2HjMOLvWAR4TSBLlNXDDWKVHoIqHWr9xVRDG6GorQoYlGx+Z06u5l1wz/AC2wu3EH0qD66k6XVwkyEhF5JsI12/aHcIO3+XMR0a1uyLrQgIkahY8n4xZGQKYMyAUTe6Jn226T2UZYQILjkXWfnU6v0/VpXMALSInJYPiqIcef+dCFIndPd7JwP05ZudVfnsQ/4odBrlhgl7+d4pEW/TrBTh12vLv0auMd7BjIEC/TzYFNXLy7wyMPHHiW+BhGfZynL6+qWYZmQFAjfg7Ln/ps5P3VyF3le82+4ydGa/kvDu7UoprZPc9d18TfoMBADBLQWQxxZxfsaU1tS+t9RmMG/ukYbc43VF33ATQBeeV/ANHeVA== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 task status by ID.' (get-task-status)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get task status by ID.

+ + + + + +Get a TaskStatus for a task by task ID. + +## Request + +

Path Parameters

+ +Responds with a TaskStatus for the task with the given task ID. + +
Schema
    messages object[]required
    + +Messages associated with the task this TaskStatus represents + +
  • Array [
    • localizedText objectrequired
    + +Localized form of the message + +
  • ]
    • returns object[]required
    + +Return values from the task this TaskStatus represents + +
  • Array [
  • ]
    • attributes objectrequired
    + +Attributes of the task this TaskStatus represents + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden, generally due to a lack of security rights + +
+ +TaskStatus with the given id was not found. + +
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-tenant-config-configuration.api.mdx b/docs/api/beta/get-tenant-config-configuration.api.mdx new file mode 100644 index 000000000..0bd1b5c7a --- /dev/null +++ b/docs/api/beta/get-tenant-config-configuration.api.mdx @@ -0,0 +1,111 @@ +--- +id: get-tenant-config-configuration +sidebar_label: Get Tenant-wide Reassignment Configuration settings +hide_title: true +hide_table_of_contents: true +api: eJztXFlz2zgS/iso7kOOMnVZjmO/bCmxk/WUM8n6KFet46pAJCghoQAOAMbRuvzft7sBSqTkK8fOTFJ8iSUSaPTdX0NAriJdCMOd1OogjXajiXAnQnHlXmqVyYn/t/QDoo3I8YmNds+jM20+sSPBrZUTNRPKRRcbUSpsYmRBQ3ej18JZ5qaCTXI95nljNGvQZVY4J9XEskwbmmLEH6WwTptHQILY6cDiViSlkW4ODFxFp1YYoOLEFzcq3RSZkqnaNbVVYj81TuqL4Yg0urgGfo2whVZWgERX0aDXwz9NGbwq4kuZiofwDzwmyBKoA0jxoshlQiO6Hy3Su4psMhUzjp/cvBCwgh5/FImLVpX39QsXBg3ppJeGl6l0e8Jxmdv7VxvhaJb64TUj1NZt6JDpjHHFgDnl0B6rqycw1Ym0trB1BvhcW/hASSfBN1IYDhRT5uRMsMupUIGDRJuUXXLLKpIbEbA346DgCCfFOAEeii98VuS40qA3GMS97XjQP+n3d/ubu/1BZ3O49Z/oeqPi68X8AQaA5VORSWRwIfBBEJjxBBkDiZjTxOmdNjKfZSLWlCQfoB/k4mAPV8dFFqzWpE12+s97zzef9zjvbW097/XxE+dZf2fYG/Z7KLXioKJ7l/pXOeMqxuDg4xxkl7bI+Zzh5DvWP5N5LvmMwV/08GtYDhREryplxQNkYqZTmcmH+MQht45Vw1c8Y+maqP/vc4ZqidYb/mxvqD0e1fPUNaVPUNaDE1cY6A0yD6Xivqxp2WMx6TAYC6KlXZCNPjxZs0n1psbHWOtccKyEqsxzfBvtOlOKVcZe5Zy8AXKqMDOpBJPZXW4hbcUPAxevFiZ/51UFZOzMJ0YYnCF9+AsFgJwOWbiHfkW0Q1rMeJlD3GQ8t6JmQiRUt08dCwRaC2vdPewoFFcYhyOHN5XXl7lEVveNATlj4N+VRoHYMqujADbW6RwlkOozzyUJ8M1ldsXCJMtLnT4gJF6BFeOJ4RI5FMRyAhMZUPwsKfpn2ohQRasgoXGdRpCAJjp99oKnIK+X72UQBhVqePIJaB08IB2cKgnzWTUFyvEiP96wrNgWfPystzMYZs+GnA+eD/vbW+OdjG9u9na2dnYoJQpr+UTUA48bw+drS78WShiZsFwnYJH/gkIQLICfIQO0OEyRTsxujOGmDYjGA/SP2c+PXYgZ+GUIAjcgUF68fMeG2yznalLScz5ZUYKKT4/Xghck94TfGjmR6iZWhCpnCDH39l+NTg9P4MnR/r9P94/hE9JaA78jCDmVolsCq+ALU31JHAcBENFYkYM6IB7Z00D1KQjEla0PlP6bnVtQJgthCzPC6jfMqJNmmdGzRiglHjGzx7IjOhtsjM+ggCZTNuYWk48HXk9HSSIKFx8GTT5lUygFwjzpsFGaUhEE1AbRCERh/hwIMZ6mGLqeQFZCKAMz0k116ZjSDope0xZLVa6m0iqrHNaNgsEBnN/vJ6PElcAciVmPwoW3BBaDfYBnr7kmdyc1pZFK58rxBKTgeT4HNRqAIJCZQDYJbU5IRz4jQ+Wsxi0yVj1ZUrp745nZc5reJby0D4i7dzmkn5hEW7z4LELwWawEPhuRNSozhYwUsAlNDqMW5qoCnwEgytM2dtvYbWP3gbG7+rLCPeEtQZ/+OvQ5VbwE/RoqnmvQx5D3KM2qQR7FeUNuIEQMEOm3sxMI7E/CI8gvhTTiR+IjX8rXmB8t7OGfj6n3qYzVsAUySHr0EmSQiUS6S3wvOSZFeVVtrq/2SpuxBAdVN0BEyJqGzXXJOKjMlEohJ9xusFQLqx45NuWQH6FBA359BiSkncaFln5TqUWSLZJsq1FbjX6NatQiyTZ229j9OWP3TiS54IqiJeAkW85m3My9p4X3tBfKYACrft5a7tSSqVbRChJjC4wVNZFDNB70x/1sOxHDlA/TZ5s72SB5NuBb2/3t/ng42I7qtf58GceLIGvGVM3e3o6kYtwUBxxXKnAu67ROm9t/oF4jMkxrmHoWuBl0Diq9WGLH4Tp2/F07kA0IA3Y0t2wvnh4dIn1Ymsij3nRpEoEw26sOhnNHkBJ9GDQtrWuhYwsd2/LTlp9fpvy00LGN3TZ2f87Y/SroOLwPOg6/AjoOGUKsDCHWXwkdU8AdCM0yMArIkJSgXoWwsQBR4FPYfQxh77iZCLcAeg0UOdi54RiY1uwNHjAIYMk2diLVUl2Y3mDsDMeaaiwM4GwCKVIxyFoS0C16FR5nAUyKx1tyOZMUxyd0dsSZeTzKHEjlY6byt8UqUiV5CRxSUsi1P3dyySW4k8gQ/gEF2gedQKL+gXucwVrftR/MjlDiQ5SY7X9JhMCYX+z/bt10SuAAmDeYLo69rW85LuD3zLmCNkJ8KXz6WkDQFqq3UL0t9225/zXKfQvV29htY/fnjN2vgOoBDd0O1WHAg6E6jO302AJLvaLzn382YqdQCRyQezOdEFZPlxiccAW4UriNgjmE4/2OqNu429G4kGC7jaseEd4VQazo2SxNDtOnzhV2t9u98kOvO7yQneoKg9KXnUTPumNQ2Q3ZCA+f+sjDAWz07iA0Hh3St5Ho0j7/EXGv/XDGNrJgBTpvcCfl6mz1HHqScOR3g4H7B/eix8BiAb3FI0ujO+ROa/KBXKcmv/5+WTyhW2S5SX13rgbjGXC6IiKKcLG82nOMQNyvvnbBZ1lc8CeAwdpib3HYgL0Q3ECX4E/FPP7t7OQJmyD8pPAvLSJfIbFfgAB6By5C6W1UnRDBSVRxjC4nU2J81DiDg+HEshwEZu/VsRDsvDra/jvk/SNI1KRSnCQoN+Csi8eVdVLxWeRYEjtLTaLjyVR1QUNd3pj3hMof9QlS+bsO8LTzXsVsT2JWouPsOCaISG0fOy8quXhNrm9l4h8VtdhTi4mafbLChVfteeLPdCcQ00iC44Ui0NY3L+7pxTV62FTBE6S6ygNqIvDRPDmVVFb7Zj4a9GKk1+TjvTqbSqitzWnMpzJmoTTmKTtgyVRrK/7JGLoOhsH5pIQo+ma2LnHRmCIiHvRqLMV+yVjGgBSJv0MIDOWdiY+xUhNQ0X7PhELyA1kWYv4DXbn50JCZHp9DQcWRqU7sN/OMC8a4YLigZwP/4QIaMAuxjTL4y2TkAC+X9qdMEBit5b1wS+KmrE7kuzQHS0MCrBIVW+z6L7vLBBc+MXqBoxdjIA0j0F6cJYPvLNDCotVQVrVFsKrBdX5zDbVyRW+e38UPnVg//27yosSj5U7KW5XPf3SWviWT/H3y7l+U8dpM8ytmmgB90d1o2ZV7c+jkLwJeW9/Zw63nqYB/4S3FKqFs6GGoKyMUUydU5NyhV1NUJ1MpaE+gENwh9ttAz9IzikRo3zH8ofMjQhO6QGuAZQ5dnMyBHu1aVytzChgPLNGu+N2W4QyFBpeEHlN02Bm0aSoBs2CLhqd34d1HHXq1Y7DMOzQs26uMDaBrNisV3rUEtssZ4+BS93hEKm1S+sQFTYESlS40Qb/FrCqK0dVQhA41K2Zm32bH4arm0vD3rAV2r66Ag+rRiv6yZbQU5EjkvmGBcU3Yfh9t8LZ4KvICm0TIugKv1i1XeHNwskYRiKnwA4c2k26YZLs4Fohge+TdZ7PT7/RiahfgeaGtg7a2Rvy1cOzrL6Q3XPRquQP/f/iPAULFwVahW+CWF8pR+tbFN4/n0R3NI5m83j5CQzIFLeC0qyvcLMF+6hofw+rYiZ9fLFsl/AbL+U0T6jc/CWrWaVtl2Y+v//CAjc+i1X29jxbkt9TQ8AGXur7+H7mO/kI= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get Tenant-wide Reassignment Configuration settings

+ + + + + +Gets the global Reassignment Configuration settings for the requestor's tenant. + +## Request + +
+ +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-transform.api.mdx b/docs/api/beta/get-transform.api.mdx new file mode 100644 index 000000000..4d5be820f --- /dev/null +++ b/docs/api/beta/get-transform.api.mdx @@ -0,0 +1,328 @@ +--- +id: get-transform +sidebar_label: Transform by ID +hide_title: true +hide_table_of_contents: true +api: eJztfYlyGzmS6K9gORshyUtSpCRLtubNbNCW7JbXOlZHe3YsrwlWgWRZxQK7Dststz5qv2F/bPMA6iApkT5ed0uGIrrNqsKRyAuJRCLxuZbKQVLbfVs7j2WU9HU8Smrv6jVfJV4cjNNAR7Xd2vkwSETn5EDEKs3iKBHpUInUVhDJWHlBP1C+6E3o0yD4qCJxsNe8jDoi1VfwcB2kw1KVWElfyCwd6jhIJwKaj9UvWRBDG6kWngxDaIg7bdbqNT1WsURgDnwAZ6DSHFr4OJaxHKlUxTiOz7UIHqBQ4MOnAKEfy3RYmx7SwZ7Q/alxQM8wwDhQHxWUtwDVdtM4U/Vakk5CbDgJRuMQC6hP41D78Kovw0Ths6Qvu7UNz995Iv3B8MPVB7m59WG40WsPrz4MZZIpD+FKvKEaydru51o6GVOj0G00qN3cvMOOk7GOEpXg941WC/+ZokcOMqO1hHJo3NNRqqIUq8nxOAw8wtz6hwTrfi71DVg+7hPODBS690F56QyuzqH9WI0BLmiWGkPcyUgE0FEcQTOThtCx8LIk1SMVN3zVDyIkpYWzWcHnW6ZRnbut12QKo+9lqSLWG8dI7TTg8TM1p/E0DeFFFPySKYGFmazAOmmJRQrSnAcjlaTwJM612JMp9j8KotcqGgCX7LbhSX6yT49bNwbIhRAgjrAEdZ+TJ+dbhCHKRjh26Xk6i9KOHTR86slEbW/tKQ/ZyT7uR+YR6Akk5B9+gK3JEPsH4J/rEXC/Mk8voEsqiA+Hlus9KKMTtRdIADcFbggPZXyVIETt7a3xUEdYvx/ESfqzDEls4owYPPCB3iCeZVCDyFefgGvgV6I329vb8CuUSXqQvw9VPz2R2Eyo9VU2ph/XKoZ/IwQwDH5VR0AohAAQ5etRJxwP5VEGnBN4+cvSs+qrWEUeC+U4lJ7qhGHxgL+CwdB0mgDHIw4S5FSsnmS9nGbwL7JDNh4TPFmC7DtSL1WEdNL0LgMUvCuzTAW16hOz/J72krsE89hSHoeZxSF8HKbpONldX/dBv4TIGc1EBuFYgxQ1gUjrgR+t+9Dses4/yboumrm5qUjKTN+HKpUNgFUK2dNZWtVtTQG0zVQCIsvSEQZJKoB1rPL2UPulc5kYPvSUUJ+UBx37KMpRFoayh8hh1QgsZBVJkBLO5jD5tI4p64NEZ7FHXFFWB/Q8oxFKZRdKZUfkzGPHx9XxKVEy9oYCxkgfDMgVbfFGx1e+nNRupqFaSh8U6ghat9WFjsrdmUkHZtWmoGk2Geos9AVwm8eavdKKqVS0Rl8/BkkA5GDiKoFszbq5D+JRR9VsOjWD5ymgWRnq3v5J5/T8cP/onEbLHZ3puETDpQb9EfksV8KgsvrBIGMexmleCq57C3IAGwC9uB7CZObjnA66GUtjKR37iqpCLUYZTDEG0ISrQDFgaWTrURamAYxMgAqLA1I2xVg9MD+AlQn+voSSpXfVwe/B+BRoXRhsMfqe1qGS0dcN31QWqyg662Q6rDXFc5izYx0mxUAtbhKA4tbB2dE3xUFfRDoVZuatT1k21wEYVGasiGPqVqxKOzjucq2MJGPU5Aii5wI5p0SAFzhrvA6iq98JO9fDAKSiJDqGoaVpuR/rEQk0NJEzVVMgdqjHfigH2FGiqDZprylUlU3cUqP4SHNk3rsRNlSkdaHQ+gr6IkixedSPRBJ+NL0xRu/ojtuPdNTABrj3r6LsF9DxRRCClC0j2jAQsHjBCEyQWmBuoVgRNDjpoM2C/UcyjvW11a1QGjpNULUtoxny6ZAniSYDV+4WTANUED5LBPeC/CsHMoiStAIO0B27tcjpc2OEMBleywlOhl6Y+aqsGrEDa/fU6UlGE4E2BExX8LoETMJtwdwIs3ePDN4AIRSdo73C8rPzjvoEjIKgGtSgMQYolLBGOo7CifBghoMxmM84uxYcnJDUy4+AH/ywK0RDdCNo/qM6MLB24RV20zHcCesbLOQHYA/JCc5Z0yXwHZWhBkI1gn8TLFRIIVMMBmBVsUIeL09EsKQR5foVNfsvq1UYm2CTxWnyBtYsq5e1R3v7r/fP9/ceXdbW1kpq94Rn+8nXciY8EYcUMzxS0VA/ny4A0yM10vHk9+XNfN4ykqFSoD+skpEnp+f2KaqTXuNhUKsJw1owGjzAb9QKzIlmfBWSrA5inY2TJq4RESroePXzSscH2q7crInffhOh5vWi+NvfxEonQ55dIfIYey05gf61H3inqg9PwyU0f8cy0lCi2vRxRapoxsYpbUqhhXoAxqixgnqIsYbC6jg5o5qNJ6RsDQpg9ZPamdKKLdp8CJkAu9ED2izUhvXcbD29ZYw3uPAZZ2lpsLeulYEMyDGwRh7zWq1s3iAGPPiGvoPAg14nRrHzCLAP0l9mprMKpk8UtRZ6FVc80VBNnHpgqoBxfwRkzJ8rUnkFHZEEYJV8civpvwJeVmzMD1YoAJSPgaQ6F+Sckb5dlZ6UDHVeGeSIz/E2Z2VQXdVMGdq8Mn1vPAZl4792Rg+0MLIEZCrdwKtiLTK1up6mX3V14bjccfk95vLcaeS43HH5A+Ty3Bd6lzeJOHSOL9m8L8Efx3KCrsxUjZJZfriZYX4w8rAKcinVQSPzg8aVoB6QAJT5823tlR6iBAn472wEVm/tnbOjnOzdY9krbT/cJYDFoghnHp0EuAp8bqujA1kNZPXdjLCW2ljCzevRRkiQAH7R8U+LUeaSvg5Dfc2OCqieebAAo5VelzziHaF+Yd/4sy5KEnwzH7pEw679Rr5y2lMwHsyE/KpZCohKsD3NQpj77psCV3a4uOyqX7pmnQZVAuPkw0X/R9xwKQFfWatNw4fSM4vMpZyyDObsjqdZzZcWsaQjUKsY91gFInpxM498/x+hmPFo1fiNU6VOld5XVVrdu71LlVJXZp86UaiCzYPVJ1+vYYumZ/cxDcsUXmmEmEIzdJQEuD2xes6uVsNB11Y4zE4T7gKLIZIOi1t5KKnp3G+1RgEebgfR7SC6HUS3g+h2EN0OottBdDuIbgfR7SC65Zpbrv1plmt5BOjdOytU3ZSdWVZ1rOnK3GwYGV+oIGdkS1hxRoHme3nfwiwzehmIcAPEE0fko1DjR2IMO3kJUkEjbBknlIRUxCOyA0QJQhL4W0gtkyQb0fSM5agoNHVwdvxku9U2nT6au3I7IrDA4mJ3W4GyW9Tvb0VZwX+/UWS2wFhtcQLUVHGE74pa4rfL6DfRsH95tcb0X/UdV7NjEHm17gT+GoeHDd9fOV/56afd0Wg3SZpnZ2f/6MJnVO+2EkxAkS9jvwnv8z9s9fVe50SU/kyrh4e+/9NPoxE0989u5TO2SpWKJvE9tnWyf3zyev/92fGLc9vW4eG6769ji+VWym3RWtwww4nSaNyfaViEw4QC5hO1u39y/Pyn9+cHh/vvX3V+7kDFv4hRwhI8CvwIo6jr4pWMMglKso1mafvpTst0ALYOsxT1xCyMk3coxzRbIrVw0gAdEbCrYnHTs4C9OTja3EDAaPkJvZBztd1qRQtaQ+p8EaDQZiOSkWZYS/0t6oaArhUR/YY34A3SE/4p0Q+eprBefUPDrcabl2uXtdArmMiNUmD5mFZJt6+pzaoPFzlgc6e0gcW+G8TFmEUsEROd2bkFTRJgHcTitB5ie4f96rSyJtsCVzFoRdEoiGZ+0CfPSTqvK9MF2xmoeWa0Hc4jQ1gIwEeY4tgKbYpT9MZYi3imTjIBo+QT9DJgYwfMFyQ1SwVgg/Tg34+Oz/d3pwaRA55gn/gfAY1AVAGX1CL8BvjTAvyL5lmTLJ9QMX74QE61Eay70Wq1G62dRmtLtDd2W092H29zvZwv8+ZOJEfmkx6kr7+CtoUxCPS+oXuOMB8kxRw8gxFERXMNhz1fqZ6SFTmlT2e0J38nhdY8PGz6vngpVmS6IqyuFL+iouzi4JqtnSYMrrMHVkAxxJO9865pZX9/vy4ODw8FzDkrK6jQfhNvcAJ6lYViC96hIFPJITQuZFVtUovi5NAWGYoVvbLiAQqvVoSsi1/hr0vlhObXULie43JPTkIUa8YDt/Ef1E0dx1BVqy3uqo7Ql1CAODg0aHj5UgwZTCmx2xahAEYyMUiYgpcG79PwsaUCgTg7GDxsESawoQJ/wDKtVg5DMav8swozQd2GslvtjdaTx9vVardMctx1wZjnttfmxubjpVr4xz9oory9id28jf+Cv8bKm5Xr60Y2byqjNt5s7DQ2rZbNFeNoZOfA2g3upPN+0h9vbBVLDf6cGlvbWV3O6nJWl7O6nNXlrC5ndTmr62FYXc6L67y498eLixxbipu5M9LFmCRfGupCyQdcrIuLdXGxLi7WxcW6uFgXF+viYl1crIuLdXGrJLdKuh+rJBfr4nZd3K6L23Vxuy5u18XturhdF7fr8mfbdXGxLs7qclaXs7qc1eWsLmd1OavLWV0u1sV5cZ0XdzrWJU8Ls9xOkIl8KcWqAMLNvkgTpSm/x+Ju8zj/zR9enxfidgbde0j0ECd84IZoV+SpZ8T/E0V0jq27n9d9bavgEgX4FOcwXan+t5n6L+f1PaB4hXim+7/PqV50/7JU6zYI/j4NQclse43GGYwH/v/ynP63XzXEXp+7pF4lJeU0rtO490rjun0z58FxHhznwXEeHOfBcR4c58FxHpw/mwfH7Zs5q8tZXc7qclaXs7qc1eWsLmd1uX0z58V1Xtw7vLiHMh0uOIFdupzmGy+uqaw/DHNWpybcm4PJBY9hAVGLA0w6qgsZaqh8DWsVqgjTyrAoQeXNte1NI7B3XV5PkxAOXuwXp/Zq3+f2+nUcUwPh+0v+vZFfx4MyUyiTSF//W/uaDlEB9f2L8VJqY+YUnlUet+gOozWoC5GNcS3n6+uIj6NJfo+U6a53q6fGzNFSaw8U5OYLfy4jcwT1TskqnUHtkl7pct0uikK3pPjuBno1aKpmHff0Io/zE+ABXOkZZYJIX68yUd60zxxGo4XpEj6KLAqMgkTNY2usGcgYzOVAI0x+C3Br1QnmtmO5bp5x88z9nGcUMX2i9gKJZ5uB/cJDGV8lCzcPHcs7lr+XLK/a21vjIej5hSxu2OJUDZaMQlmK1j2Vn3Qv0TqmTizvEnwiykY9dmUYp13uqKXJvQLeLLFhDi0ofHHGR8+LxAqE9nhimmNXBzuTbdog+i7wHt+S/IG18fbg7Fhstre3G20w/MZD2dgwdd+tWutMRc3r4CoYKz+QTR0P1vFpHSq+54rvTcWp+bV2ceYOrTvdcm91CzXwM16muWDh9rtcDVzKSYErMMPa5PakvCaYYKuSaOLt5ykEVXDQ8TAsT+zBGLxUx5PaTHqtWtI5NIlK6MVN/VZSINbu6Ov4KpVz2kcujL6h2Z9OhaHkbNsKcKAnSh3s3dkBupWCQaRjtR/HOk6WUEqSgh1xZccZnFhFxQoXbKhH0EOuxUh/5DRjLHoRLJKNXGMMIwoy9idWw+AKZUccYbahE02eZlgpe4rKrolr9OXjCt3zsri5UCP96Oq2Ir9xFqrqjuUdMhzNTXQXLZlorgh6LudUe6kiANATCAhjNVLKJ/mlyfejvgJk9SZV1FamUNvEcxl6WcgK9RTH9aAoXdbEZsRmkEsQzYanB3RFqckndUTWVlK8OBsrL5Dh86Gkt6GKBnh1+jcQfJRhJjLOYtVTNsPYZe15qDNfnKn4YwCDFXsKNRFdHX2RBiGg47JWIfHC8rWb8hCXi58up74ykfeiO0DUAtlOYbLWozOq3q3AMq8EGzEVrC6Tac5iCFBjwh4uKSr8soa685LvW4aH25xqBhQoW2FAmy8sygmcQ4+t38wn+J8A4IThER4AJL10PuyGLZdjQGqxjxngcP+SnLa0+CDa4fEEQ0w/z/dYaB9eKNDWqNgzrk0rrYUZRxalR9EaEqampG4cwp+CUTYC3g/1NW1JmkCXRGw9bpUGOLUcaLceuNaaFZwvVl8ZGJs/mlJKT22CWJulLrfQprXTHUURIMTeF83WZzIIyeoSF5iwlfLxrUIra9W9k5wlroc6KedKJc99gvSkFHKYpQ7EBfmK8t32lcSdiHoeaYGJVbHB7khGcqDirrhSk2sdswNhAoRGnx0ea9L6Cn3xWBhzya4AablK4WEfKBMPZr5AmVkZbk4J4Yb3tP2k9eTxTmuzvdlut1rtndZWq9fa7m9ubSnv6UMW0Tu5513ZdAxmvt+9Avw26xHkdAILuJFY9aBG2PBkooAFy6bkHOWMejzmgxYVCqsRMPXDIqNzvPxQjhfgOPUJ1mwLEpZnPSNRs/nJ80/LbJbbwtWE5HXz2+xJIqfCUhy1M2WQpRqcnbacP5hAt/zNyYRp6c75z20+aWO4+UXf1RShEpOBvncy7GT4/spwonFzYOG2TD8Pol8gpyXSlnIiA+aVIZvdyMhD5Yus/uTE5WoU0blrog9o32IDEy6fX+tGvnCpbpesquagWQcb+uLssrb2V5GW7Ee7/2IWQBRwb7d3YIGWjYHh2Da0vW1Sb8NYqSX660CHpjKsd9EtwrVp+Ut+ofk1n2y1qGZVqdBgnVJxSuXeKpVQ9dMTuWg75jbf3rLOFVA16IfHtZa5fcAcyTFLPcENFbM8cobJWJA3WcjdFmVjQNQuaY+Ug/eq+wq4k5srjfwoUPn8Q/lMEPaJqdApkE/zclHPGchXBZhBR9BliMaMBGZbvayB3lkrgYdIM6OeUkQPzA3kdNCPpYO0vsrGC1QQndSY1UD8eg7V7xr0LRwhXp0dHwluAXn2Sk0aLBhjCWPkUynwMr+Hyqxx6LIpuoAjTdVonJrdKLrsiANZct6pW19T4eDFh4qq4wbLAmZuVzCpWgwEpnnjdn706AjstkePrHvLylzO41bRYG3uGw81/ZUtrCgvn6IdZWwg9IOb6FnZw91Xwyyla5yYR+3SbQ43M/BoekVXEUabcjgO6DY7BUwJH41sPLZ4QwTZFqccb5/RnEPtRXabRDXy4hRf7B/u4xmxzsUZfj3pPK+Vr0SqAkLM6TSn05z3VHNeq9iFojr2fpjsjVWPcO0fBr86Pnd8/lD5nOMLOuhNOmIv1EJe/6KwBqZ2dQXOHvOJXQQnIGHrJqAauLWIOCgFQFj7lHbEzV1bbH4+4ls+uWUb8iGFTZhoI7WRdMBbyAHwvRfK6MrW58waxg1wR1KN2UVzvq3c3dzo2ua+YwBGd+txq/vjhGA41fMDqh6ndZzWcVrHaZ3fTevYqKEFTr95oXtLB6Qd7JXiOdOpQPIxMrG9vLZED6IxxpZdS76LmS7uDtJhEOHrWHDkQXpLcPm+bfI8/+zk1Mnp/ZXTcSg91QnDP8w73yndeT7XKb8vgdr423BxLu4m4VQ1Bgk5H0kIzRS+eDNMCsY11oYpxreVV73ODYBKwKvLGvxYgR//+z/oq3CeZCfp917SF4h5DKb8J3qXC8ys0HOh5eZoc+BbWrFDARXUQC6+QTRnVjYAVGP83v63bPzaafzzXW1RCp1T6uFZFoQ++RWrqXOo/3arTflyjFgX4/2iaPg5mmVqd4/iFYM08/mK9Rilt7y7SHv+BhMJaLAs8qujFs7CcHrn/uodTCXoApBcAJJTQk4J/VFKKAFUz7sOpqyBfBUGoyAlc4GOJMwqo6LIFxk/5mhsLn2FvJWsoSJ9HS9bgoSz5EwfdS/8j33+0ouVvBKU/w86S6+VghXRtS7OSeQxPhWdU5HuOrO3v4xZt1DTcvoNFbJRJPupEfCqyhtKPG0JsBJtmLUlpUj+K0cNUSsUtdVq9PB0lwncqgOfGh2OR0WqvV0XaXrwUEmL+d+kr76lULsuVOpVba7HlAJjGOvrZQ5CF0kPV5Hn10ml2POQLMazOo9UgElaUVJ21GlUOiSDGGVlwrMV50WMDPCAIM23fvXQckyKHJQxpS1Gc5pRZLMAkm+MtYNpI/dJhzIe2FvWrPfeqlZqxEbWc3JEDqufzTxoI8IO6ExSlh73nxFseY6Oy1o1leHdDUVZGH7VdMfJRgpMAitxW2VSW5eESwniproHMdWlMIB5G31flX1p4bn5PKkSqW+Kr7XBovnNHbHOBkP42g8+Kd9urBUfPHvPITAPywMn1Uecd8BQhX9+VqH2kNnPMUkRdvdaRoMME7dX1DZ3/a+Ywp8ck4vcBGeErMKXL6BYhnNEnlvge6TcNST54d2HVT7Nz5vezao9hRmvZjiVXxdoMybJHE6de8C0tCLTeboRYybl025x0jSffrrUb5dOqvHSrNGeq3ioHKb3L3pq5TjOFV91KmrX86N9OJ5NOnhGDR33+9DdUsOlS2jK5plNsjR3E15TzmGjai3MVh+SpcHYIE4pIURwzkRU/eXEDjoCFU9ma9A3zRkt3WhPBXdvzhusivzvRFMwrYimuca/hapAU8XWdqONSqk8oyD5ZBgaG7I48jw3AJ6kCncRB5SDgjGKTVeInvdcRsX2Laj4faiuKnPgN9Lc4LLAID/P5YC57P5DK0hnd91fuwuaG7kAZsfdD5O7s/HYxec79n6w7J3NTVjsuLu0dntXRmI5+u3uhH2EWMrRC9T/umC/iyj4BbB3sMcDLZ8Yraz+Nzx/54n0B8MPVx/k5taH4UavPbz6MJRJpjyfJdTAsZhmB3PIVIl5xnaKZHgNL1ZEoYKQ5Nz3siTVIxXPfl9IFcT5HIyfKukjPWA4W63WrE/jeRigk5uSM4uGOJ06XIy0URhJrf0J31j6ETO9oJRi7LUJgJCYhcUjqV7/kHC2wsQbqpGcp9+md0lSwMpz7avFpH0Beq0xwJBpZG4CmdKysH6iqHC8n5CbtHxO5aqOH8BEsy2eSV+cmvE9N4NBpoWFzxW0dbA8r9kqIFP5/sacbtWOkr3t1tONrf72lpQbT7baO497T/tyc7P19PFTygw4AgmUg7k5zatd27zFdNVh8KtCt7UE3HO+cuy8dmsa9Jltc7pmcblEelw2H6aBV6TqE55mF8+en4itHREahxvMDlOZt1TUuDiDN+hb53BAm5mVGj6Og6qrpthuN5eD7u2/6Fy8xntAT/f/82L/DH5hW+/m7jyRVGpa0pqrL+0AriU6ZUJAh/Kb4pFp9REMSJpMY6agPd3PCQSN0EEN0/ucGuWmyy4FZjWSm0+p3WHp4Ts+QW/2rdiv9Kjj4f5Hw7ouH4khiLKK15qik8+PNuPSSE4obsr3ixuu+hlmxqQdHtzzgXk8mI6QKlBZpUahR16XiYLCAZAvsennpRnev0k52UtSmHNLvsVoL7UyF31WoDsvIY1QineReqnJ3+npGBPrix6aKWB9GHXEvraRjGy5XGOVJyRSd4cMzF6q6Zsn8WLfhXJ3EoL6adDQ8g8flRE+8pYYa0kUZozVSNbewsqlXbWyICWiH6jQd7LrZNfJ7pKyO/3xVCVjkEX7lUyf9qzpcxHJDPAb0+Q5Y/rEilc/whbiRQsTso7mmjGRXr05B8G+UuS8hmUYmrLf0T7iqXwG+E5OD37fs3tgduovaIEAEh55BH3QRMrfJbgLiAlRjKrN2d5e6LgXAINGc0xETJ5Mwbh4GXOcRWatURe+Vkm0koqhBP0IqzS8ANsmcVGR3+AdMWdJOkvSzUZuNnows5GzJJ3sOtm9n7J7pyWZQ0XSYuykJBuNZDxhTrMJ8fAyOQEFMKqS6otc5IhU09YKNiZyG6tWtRxqvY12r93f8dSWL7f87c2n/Q1ve0M+3mnvtHtbGzu18lz/tpDjXMiqMlWiN9OR70dQMZ40yiJgriTV2q9wK6I3Vn1UaxQPYO1mwHkTL3bIbcetWdvxSKcwNrxeujGTu9C2f3H6WtAhcG4e8ca7Byi0nICRvOFoUtKOBJ3VdqajMx3d9OOmnwcz/TjT0cmuk937KbtfZDpuLTIdt77AdNwSaGLRUfA/0nT0we5A06wfYMRHnhgnP95qvI9G7FM8PJTmhl7Fitx4OmtFnmstDmU0scZSUvFERgW6UL1B2RGWjW1ZDFQWA1CREV6LF2iOsw1GCm1SPCDAJ/V8zukN7caTRoeOorHMFMHephcTBF6+GFIDjwV4qK6P5h+0QH7QASjq7+jjNNT6Jn+wOKUjEThiughZoczn/t/H86IEDvIIBqb1LeEC7DPHW/gi9WnM6is3QZ2p7kx1N9276f5hTPfOVHey62T3fsruF5jqxhq63VSHAkub6lC22RK5LfWCojd/b4u9U4pH5bPv5vpMv7DBAQmJgpd4CzV2glc3P2dW7mSYXwcDdaPdPDh1N1aUsqf6ki9Nrr3DuNSRAs7E8YHRjypJYiu18gnYz4F/U8N+0cDksVWP034GkgOpb5pyHDRt8HKkr+lMbU9RjorbM29hAdE5OTCrlSYRic/9stKkxplk9mqY/NjunS3bNKKUDpSbqQuQGcOTnCVUj8awIFlJqHTTxJNPjQ/GdRGHN98+Fm7olrHMQ9+dvUF5AZBODbHG8caWTc7QeufeZ5ilmJFw32BjprNjLLYhnikZ02lMDKVZffXmfE0MzJ3vvjnjnadGOQEWIZ3YsWElWKl0ShwB71QCd1AGRT+EAYvL6Ewp8dZeUX0Ek8UpaHdCKVZSpFCw1rvVZQ5zA4bWZaXeGs2ZtLgIIj62CG+bl1FD7AWoyvCkN5UxQ+TTk2/HdlyyNK6vBeIvtrUGt9ag1pK1KSgYtW89DgT3QBFgEzJMCFtf3Tm31yi1hysxeIOtTsOAmDBwVMOtPEu1r4aj0l4D26vCcRm9oZMx1WqCFZY9WHEgvKHWifp3IZB1UAzeDjKQoq8Gi47jNEgiGhutEkgN7rIRNMC8JPheg2BEzEyyh9M7WTeaHS0kkl2iLMh8l47bdCtjptdvg4igxrwDXw0zdtjADhusAxIDP09yCV+HimMgPcAM8LygP2kCA2hJ73Fbc7U6Nb9OdXBq8ABUvn16vMsPu4WCs5lc6AOWzsuAGq7RMSETgAbPwrSFM10FWdavMI3BWXjx4E00hTeGN98dxUn3zzZeHHGncL8cR+Hke2vpWzTJn0fv/kEaz2mah6hpjL2M7EbdmoVFmcmfGXtt1h2Y0DFN+D98TTi5CJjmsPApEnOVG8JkNjarm/SGgSJHwlhJSqxdR87SI5JEc5ZPmQxfAzpOFgPIEpZ+QQjtkavb9ixJYNiwpAObMaWw4MALjdkgooFqijeY/8EDsuC6DkN+4dsHbRZ4+eE2sWeJDUbXaJRFeMgQwMabLYClFnCEHyRexooLlnmRsrjQZPrltawUI6vhEJq0woGFxHEffdSw/K0tzsRj+gK6J8ZBDahHKkZ8HrQYyKkKOT1PbdksP7Zt4LbGUIVjXFmC1gUDTJV6ODw4n2kRGovMroiOB+umUrKOZaERXB4x+2w2281Wg5YLmH9UJyksuUqNF4mKehNxsDfNfp8Llzwb/KiHOUInmTplai9OyBMM8l7KwR6o1o6ZDJhj8yq4JLSBQimdHbTnPIm0OCmlplOiHU8+uGpYH6PLDIeU8SqGV4tva8VqESrs8mUQQxg1fvv8GT0quH66wde/ZAqX62/fFUsjWlICVfC3XzpEeQtGVs3hVn8tP0o6lVcRUBWjCN4GvXULRpPCI1CDn1cKHQkAPiy3YQDk6SHg+AP7gkpVZnZLKgvql/vIQfKWOdz8AESAlvo/4ZNgWA== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

+ +Transform with the given ID + +
Schema
    attributes object nullable 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 + +
    + +string + +
    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 + +
    + +string + +
    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 + +
    + +string + +
    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 + +
    + +string + +
    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","enum":["LT","LTE","GT","GTE"],"example":"LT"}}>
    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 + +
    + +string + +
    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 + +
    + +string + +
    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 objectrequired
    + +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. + + +
    **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"},"additionalProperties":true}} collapsible={false} discriminator={false}>
    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 objectrequired
    + +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-usages-by-account-id.api.mdx b/docs/api/beta/get-usages-by-account-id.api.mdx new file mode 100644 index 000000000..fed1f3407 --- /dev/null +++ b/docs/api/beta/get-usages-by-account-id.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-usages-by-account-id +sidebar_label: Returns account usage insights +hide_title: true +hide_table_of_contents: true +api: eJztW21z2zYS/isY9kMTjSjZsmzHmrm5cZyk407S5PxyuRk3M4VISEJCAiwA2tF5/N9vdwFSpF4c1830mlb9kFoksNh99gW74OI2cnxqo9FVdJwkulSOXVo+FTb60I1SYRMjCye1ikbRxUxadvzulBnhSqMs48yWec7NnOkJ42F2ibOZVFZOZ86yiTas4Nax3QHLtXIz24u6kS6E4Uj2NAXCU+H8ms/ngQd43I0KbngunDDI3W2k4AcM5o0REtkquJtFy7yevkCeTl/8VPEFI4z4tZRGwIrOlKIb2WQmch6NbiM3L5C0dUaqaXTXjcRnnhcZPhOTvWeTo+He8FAcDfcPBuP98fjZcDDk+wd7R4fpMxh96/n4tRRmDssEPjOZS7fC1xv+makyHwuD/BlhywxAcjpg2vtZnQvBrv69R0CfO65SblJ2orNMJEiDvatR+fBk5lxhR/1+Kq5Fhpj2LJdZoaVyvUTnfZmqPi9k3wY6cVLTiRfoPiUl5dqg2uDPnDTTayE24ZkVDVwG+ztrAIR1xVQYmOnJ+Ed7A3iQSyXzMo9GMC/nn/3fRCUVEw4o0K+7TWjqycSKVTjf0mNgGxB0M8EmZZYFVBm86IEtlzzL5swWIpETKVJ2I92MdUg7HQS+4FOpuBMw3+hyOiM6QTHfjDp+hzJq+DeDXznQkotNWAcdqcOkA1QB+EIXZeahFKzzn/hCO57FJzi7g5AWWlnBZoKnYP6kBxy4xh1mHCjqMkvZWATPAM3JSa03wI91vE102I1AqKYKEEtBY6AzqRKcB2JYBx4NgcohK8xHqIQrNuPXAh6DjggcHC/zgieui9JAnDMCNJYLlcLCSju0FCtw1Q4R+QdJ3kGeiNtrnpXCo4Cjge3SVtx8Exa0ISSOtc4EV1HDTmjmRlux2lDE3hxeG/aIEPPYCmTdAVd3yzZ2DtRqsygt6hJNphKf2blyEFH9pDHaiPqDsf4OBQa+4sDlU1K5f4Z2ZMuiQEhS0gnFKCCjb/A1xKMstSOwqRTE73Si5sYT47PoDnZhK5LSSDenXfDSCnMC+6j47I5L2Phg3wZGR2GXsyMD3hV9wGmVw1lUwWBnB/+3hO4jd+8E14eIAAR5UWQyIfvqf7RI9XZV8dwYjiYincht47kefwQ8cac3iL+TnlcS/D6zoQGr2QlAKw3wmnISCbEmnkmKm5lMZiCmk9cAJWqGT6dGTNHuei3gBzuDvXhnGA920R597PtSVD0YruVnEdqAJ0shDwx0wRiFDvxZwX/DrecRdYD5lS5NIlr87WKcjpx0xGzIlyh9iu7wv240XKfrk0yCythLYwCMmJ01gqrf8ChYsrFOCRypIKLJ9DHa3qRV4cC9TnS6VrdtZl9JJeKp4RI5FMRyAhMZULyWKboOBTdPstI1jWurEpDo7bLnPAV5vXwnQRiE0PDkE9DCFPRLDF0qCfNZNYXJhTuvWVYcCj4+2DkaDCcHQ84Hz4a7h/vjownf29s52j86wtVzYX2aveom7aV/EEoYmbBMJ6CR/wIg4OKAPTFAiz/cs4jGA/BH2/VjazEDvwwDTxcs8/nJOzY8ZBlX05Ke8+kSCCq+PMd9AVIyPq62GJDcE35r5FSqdawIhZnJVfTi5avjy9cX8OTs5b8uX57DX0hrpSw5VmCtKZqlJleb6RviOAiALmUFBm5wdNYJVDsgEFe2OVD6X3ZuAUwWtjuYEVZfM6NJmk2MzluulPgozZ7Inuh1ISWAZxAwIAqNOeQGTPtI0AEXFoWLXwckOyFBetpjx2kqUUjIXCi/sDB/jrkFT1O/1/mcF1xZUHDRpcP0Qy6FjAaUbW0s4sjrplLQOYDzL9vJceIgvSabaHlhbS2BxaAf4Nkj1+buogEaQYqbOgTBhDL3RBvIxSAygWwStqQQjmhvhcCjqnF1xGqGRwp3bzwzL5ymdwkv7QP87l0G4Scm0eoX1yI4H5VsPhqRNio1hYgUqhGaHEbV6qoc3+/+W9/d+u7Wdx/ou8svz0KGG95S6rO7mvpcKg6Zsja0ea6kPoasR2lWDaL0JiiyywCQkCL9+P4CHPuTUDhefC6wjvqK+ZHfyleYP671EYqcqgaqtv6FLpBBwtFLMIFIJNIR8b3g2CeJBNXe6mqvtBlLMFC1JkWEqGnYXJeMA2SmVIoqa9tlqRZWfe9CTQ0eYa2PgLiqSmNfUm0zyW0mud2NtrvRX2Y32maSW9/d+u636bv3ZpI1V+QtIU8KXzq9pYX3dHDKYMDi40btcqSq5WwFibE6x4ramUM0HuyOdyeHiRimfJge7B1NBsnBgO8f7h7ujoeDw6i5118t/Lh2srZPNfTt9UgQQxJ3DXlcqcC4rNM6bR//lXjcPsGwhqGnzpsBc4D0Q507Do5Wc8cLrdkbruZVhmRbOaRaYIQxDcbmONZUY+m4cwpxUeFHGQl8oSnJXAAV/DjA6MsPOi9KAXTNPD6eOBAlfE8KRlavIlWSlcAhRYJMY9aswbAkfpyZYM4HFCiDnUJ0/orZaVDR78rk2RlK/BolZi8/J0Kgo9eZ+/66891TYN5gjDj3Ct5w0OurHa7AAKAg8DGrzju3+fk2P9/u8ds9/q+xx2/z863vbn332/Td35Cfh2xoc34OAx6cn8PY3g6rc6lX1PHyR6fp5CqBAzJvppOkNHTcXOXglFeAKYX2SYwh2AY5ivqhlSCmTg7bv637Je/6HiOMMthUgmmi57A0Gcys+mFuQXGgsLseL2QP4hnozs2VvqGmmDGgtSYQYceAdzocQO03foEeQW0kWrMPfUTcAx8aiqK67+ZeythghBqd6xKCHZHpMrD8YFn0GFgsoKz43tLoHlnSinwg16XJ7n6/LJ7QBlnWwXfvajCeAadLIqIIjR6gc8zB/eornUCLfQXrtsHKYm9x2IA9F9xAgeA/ZTz58f3FUzbFzJM83/dYCYmlAvjOOzARimzH1bE+TqLNZtEsedz6cIKexCYZCMxC79tpAOEnCPlnEKMJUpwkKCzgrId3Y/HWvA2dbj+rmL2Qxjdr+S6mIKLvBrwqKrl4Q67HMvFdRS321GKihp1gLS48tFeJb8RJwJ2RBM8sofXoxT29uEEP6yl4glSXeUAkAh/tz11JpbVH89GiFyO9Nh8/q/e+Bas1jfkoxuyM2j1PWTLT2op/Moamg25wNS3Bix7NFvV9xeQR8WCnwVLsl4wlREpB/L0Gx1DemPgYN2nKUTSkbyr1LvkLaRZ8/hfqQP2lJTM9voK9FEemOvkNLYZLPOOCMS4Y+xhgA/9+q0LDwvYzkIHigDeAk4X+KRIERhtxz9NaG9WJfJ/mUOMmsEpUbDHyP0aLABf+YvQCR9djIAxH1J8fPgDCbxZo4X7VAqs6HVhGcJXfTMM2uYSb57c+ncKt888mL0p8vDhEeauy+deO0hsiyZ8n7v6fIt420vwVI03IetHcaNlQHjSN/HnI11YP9SzdSYB/4S35KiXYUL4sriE0CRUZd2jV5NXJTAo6DigEd5j7ddGydE6eCJU7ur/wzb1samAMuK2FnJSPZQb06MC6WpmTw/jEEvWKv21JNQmulcygvBQ99h4qNAVpu8HqDFsu4N1HHcq0c9DMO1Qse1EpG5KuPC8VNjYD22XOOJjUFywilTYpfeCCYk2JCgtNqV89q/JiNDUUoUd1isnt2wmeNEMR21D8F9YCvdtwzAzQoxbDpYGFIGciI8vEce20/Uu0wdrimcgKrA8h6kICJhorvDm9WKEIxFRosNZm2g+TbB/HAhEsj7z57PV2ezsxlQvwvNDWQUXbIH5W3Ydb20S/bI23i3P2r3mlLuwqWA70CzzRQl5LX5742vAqateGMGnUvE23KA+h4JiBlDjl9hbPQbBeusPH/rYHFo2AOzrD4irJRiG/rTtva3H8JPBkobrSF84OIrr793Ac/l6X1e7Bsb7M90ggtzfPvr2bZ/eYQ3W98JHW8Le7I3YPlIvbdwswPyxOrX5j4H5yFq4LPmXr7lOv5aP60qLmTSYq/hbbzd0HGOwdkrjy7/0pe2PmyndoFKc++fzhJe7qfENdFf4YXeGZ6f8A1qca6g== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 account usage insights' (get-usages-by-account-id)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Returns account usage insights

+ + + + + +This API returns a summary of account usage insights for past 12 months. + +## Request + +

Path Parameters

Query Parameters

+ +Summary of account usage insights for past 12 months. + +
Schema
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-usages-by-source-id.api.mdx b/docs/api/beta/get-usages-by-source-id.api.mdx new file mode 100644 index 000000000..d2a4e59ea --- /dev/null +++ b/docs/api/beta/get-usages-by-source-id.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-usages-by-source-id +sidebar_label: Returns source usage insights +hide_title: true +hide_table_of_contents: true +api: eJztW21v2zgS/iuE9sO2huW3JE1j4HBI03aRRbvN5eV6QFqgtETbbCVSS0pJfEH++80MqbfYTrNpsbfpej90Y4kczjzzwocUeR3kfGaD8XlwogsTCXZm+UzY4GM3iIWNjMxyqVUwDk7n0rL9o0NmRF4YZRlntkhTbhZMT5l1nQvszKSycjbPLZtqwzJuczYcsVSrfG57QTfQmTAcpR7GIHcmcjfki4XTAJ52g4wbnopcGFTtOlDwA9rauoFEnTKez4Pbih6+RIUOX/7mlYIGRvxeSCNguNwUohvYaC5SHoyvg3yRkeDcSDULbrqBuOJpluCzUbQ3fD54vrUTD/eG/PmzwXAnHj3f3tmZbPPR1mgPWl87NX4vhFnAMF7LRKYyX1LrLb9iqkgnwqB6RtgiAYRy7fHsfVAnQrDzf28RyCc5VzE3MTvQSSIilMGOKkw+PpnneWbH/X4sLkSCgPYsl0mmpcp7kU77MlZ9nsm+9XLCqJIT1tg+JQ+l2qDP4M+U3NJrITbliRUNXEY7gxUAwrhiJgz0dGLco60RPEilkmmRBmPol/Ir9zdJicWUAwr062Ydmno6tWIZznf0GNQGBPO5YNMiSTyqDF70II4LniQLZjMRyakUMbuU+Zx1yDsdBD7jM6l4LqC/0cVsTnK8Yx6NO77BGRX868GPdKGWsT+csg4mUofJHFAF4DOdFYmDUrDOf8JTnfMkPMDeHYQ008oKNhc8hvAnP2DDFekw5yBRF0nMJsJnBnhOTiu/AX6s42Kiwy4FQjVTgFgMHgOfSRVhPzDD5pDRUKRyVIWRISziis35hYDH4CMCB9vLNONR3kVroMYZAR5LhYphYKVzjBQrcNQOCfkHWd5BnUjbC54UwqGArSdYBEttHkUErSmJE60TwVXQiBPquTZWrDZUr9eX10Y8IsQ8tAJVz0Grm9sxdgLSqrAoLPoSQ6Y0n9mFyqGiuk4TjBH1J2P9ExoMeoVey6fkcvcM48gWWYaQxOQTqlEgRl/ia6hHSWzHEFMxmN/pBM2JJ8RnwQ3MwFZEhZH5gubAMyvMAUyi4irfL2DegykbFB3ziMLSjg1kV/ARu5UJZ9EFo8EA/3cL3YfN3BEODwUB5PEsS2RE4dX/bFHo9bLfuTEcI0TmIrWN53ryGeDEad4g/Ll0qpLdd0UNNVgmJoCsNKBrzMkihJp0Jisu5zKaM8hveQFIomP4bGbEDMOu18J9NBhthYPtcDTEcHSlr9bGFaumNtNE8+XiiOpAiTEIZ13gQDVf3Up/ueJFegkqiRDAOXIs55BuFTVkSkvT4aC3vQN5GOQyJ80dcSIaFdzgf91ge5XbDxIJ7mOvjAHZITtu1Fc391HdZBMdE1BSQXGT8UM8v87DIodMO9DxSj+3lX0tlQhnhkvUUJDKEXRkIPFCxphFVOecyNLv1K7tVkCiN2QveAz2OvsOvDGIoOHRF5CFVPRrCp0pCf1Z2YXJOrNXDCt2BZ88G+yNtqfPtjkH5jjc3ZnsTfnW1mBvZw/pY5AK69j2csq0h/5FKGFkxBIdgUf+C4BAtgP2pAANfv8sIxn3wB8D2bWtQ9Hpy7AGdWESfXFwxLZ3WcLVrKDnfHYLBBWeneAUAeyMT8rZBix3gt8ZOZNqlSpCIUk5D16+er1/9uYUnhy/+tfZqxP4C2UtrU72FURrjGGpKd/m+pI09gZccsgrgTUckp51vNQOGMSVbTaU7pddWACT+ZkPevjRV/RoimZTo9NWKkWuYLMnsid6XWAH8AyqB1SkCQeawLRylGk/ikSWh288kh3PlZ722H4cSzQSSAxRDQv9F0gzeBy7ac/RX0hlV0d0kSMTkZFo+6KGsu2Nuoy8aToFkwM0/3qc7Ec5MG2KiVYWVtHiVfT+AZ0dcm3tThugEaQ4v0NxjIjER9oALYPKBLZJqJ2+HNE0C4VHle2qitWsjlTu3jplXuaa3kW8sPfIu6MEyk9IplUvLoRPPlq9uWpE3ijd5CuSX5hQZ9+qcleZ+I4IbHJ3k7ub3L1n7t5+eezJrn9L1Ge4TH3OFAfSrA1NnkvUx1D0KM3KRkRvvCO7DADxFOnX96eQ2F+EwvbiKsMl1XfkR24qX1J+v/KHX++Uy6Fy6q99gQoSjs6CKVQiEY9J71pjRxIJqq3l0V5rM5EQoGoFRYSqadhCF4wDZKZQihbZtstiLaz6OffLa8gIa10FxFFVHLrV1YZJbpjkZjbazEY/zGy0YZKb3N3k7uPM3TuZZKUVZYvnSf6Dp4s0/x6t5Qwa1N85qpQjV91mKyiMVRwraDOHYDIaTobT3Uhsx3w7fra1Nx1Fz0Z8Z3e4O5xsj3aD5lx/XudxlWTtnGr42/mRIAYSdwE8rlAQXDbXOm5v/xW48z7Fsoalp+LNgDlA+rHijqO9Ze54qjV7y9WiZEi2xSFVjRHWNGibYltTtoUGnM2gLir8PiNBLwwlmQqQgt8JGH0EwuRFK0CuWYT70xxM8Z+WfJBVo0gVJQVoSJUg0ciaNQSWxO80U+R8IIEY7Ayq83dkp95F38Tk2TFa/AYtZq+uIiEw0SvmvrNqf/cQlDdYI06cg9ds9LrVDlcQALAgcDWr4p0bfr7h55s5fjPH/xhz/Iafb3J3k7uPM3f/AD/3bGg9P4cG9+bn0LY3YBWXek2HX/5smk6p4jWg8GY6igpD280lBydeAaHkj1FiDcEDkeOg784QhHSow/avy3OTN32HENYYPF2CJNHpV5gE+pUHY67BbeCumx7PZA+qGXguXyh9SadjJoDVijKE5wVcymEDOofjBugR0EZiLLvCR8Id7P5kUVAdwLlTMp40Qn8uwB7mxHQZxL2PK3oMKmawqPjZUusexdGSfWDXmUluvt0WJ2iNLavgu3M0aM9A01smogmNw0AnyMDd6EtHgupZBVdto6XB3mGzEXshuIHlgfuQ8eTX96dP2Qx5J+W9O2wlJC4UIHOOIESoru2Xm/rYiaaa+tTkfuuzCeYRmyZgMPOH4A49CL9BwT+GCk2QYidBRQF73f9YFm/1W3Pk7YMK2Utp3Kktd57Jm+iOBZ5npV28YddDlfiplBY6aSFJwyNhLS0ctOeRO4YTQTKjCJ5YQuvBgzt5YUMerqbgCUq9rQMi4fVof+yKSq89WI+WvBDltfX4oN67w1itbszVMGbndO7zkEVzra34J2MYOpgG57MCsujBatEJsJAyIhwNGiqFbshQQqEUpN8bSAzlgolPcIomhqKBvKnYpeQn8izk/Cc6ivqpZTM9PoeZFFvGOvoDZw1v6YwDhjhg6GqA9fq7iQoDC0+igQ1UB1wAHNT+p0rgFW3UPSdrZVUn8X3qQyc4QVWSYrOx+zGuC5z/i9ELbF21gTKMDLv6/Ae/mZeFs1ULrHJv4DaCy/omGibJW7g5fau9KZw4/2r2osX79RbKO5UsvneVXlNJ/jp19/9U8TaV5kesNJ7zYrjRsH5x0AzyF56vLW/pWbqcAP/CW8pVoteweKnvIzQFZQnPMaopq6O5FLQZkAmeI/frYmTplDIR1u2Y/rDkI0EzA20gbS1wUj6RCcij7epyZE4J44gl+hV/24JWJDhWNIfFpeix97A+UxG4BddmeOAC3n3WfpF2Ap45Qseyl6WzgXSlaaHwiDOoXaSMQ0h9JSJiaaPCFS5YqilRYqGJ+lW9yizGUEMTerRKMal9N8V9ZljCNhz/lbHA79ZvMgP06EV/e6A25FgkFJnYrk3bvyYboi2ciyTD1SFUXSBgojHC28PTJYkgTLnFUU+bWd93sn1sC0JweeTCZ6s37A1CWi7A80zbHNazDeHH/lLcytP0t4Pxut5k/47X6vycgouBfoa7Wahp4RYnbl14HrTWhdBn3LhRVy8NYbExBwuxw/U17oDgWukGH7srH7hgBMwxEer7JGstfFwX31ai+EXgnkJ5r8/vGgR0AfD+OPy9bqzdgWN1o++BQG6unz2+62d3hEN5x/CB0fC3uyh2B5T1FbwazI/1jtUfLNxPjv2dwadsxZ3qlWqUn1jUoqlDrZ6fbG4+QluXjqSTe+121xsdl74/ozHVjucvr3A+52tWVP6P8Tnulf4Py4UZ0Q== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 source usage insights' (get-usages-by-source-id)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Returns source usage insights

+ + + + + +This API returns a summary of source usage insights for past 12 months. + +## Request + +

Path Parameters

Query Parameters

+ +Summary of source usage insights for past 12 months. + +
Schema
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-valid-time-zones.api.mdx b/docs/api/beta/get-valid-time-zones.api.mdx new file mode 100644 index 000000000..6b6264a76 --- /dev/null +++ b/docs/api/beta/get-valid-time-zones.api.mdx @@ -0,0 +1,87 @@ +--- +id: get-valid-time-zones +sidebar_label: Get list of time zones +hide_title: true +hide_table_of_contents: true +api: eJztWltzEzkW/isq78MAm7YTE8gkL1smBCqzsLC5LFUbqELulm0x3ZJHUgdMKv99v3Okbt8SYDPU7gzll6RbfXR07vqOrKuOnSong7bmuOgcdMYq/EuWujjTlfq3Ncp3tjpBjn3n4KLzyo3FoTUjPe682+p4lddOhxm+XHXOvXL4FNSnMKjDhKh1YQ6sG2c5z/AHTskCzFaGsxoz47d31+BaKJ87PSV5IM1zFYQUpfZB2JG4JMFEgGTiM4kmwkQGkUsjhkp4kGojwFpE1nXUynexqFN+ikdoc3DV6W9v07/llU7Ub7XCMr7Oc+X9qC4xLSeNTCBqOZ2WOmeOvQ+eplx1fD5RlaSnMJsqMJHOyRnpGFTlF8Z9cNqMO9fXWx31SVbTUpGBjkLee/7yLHuMGen5rz/T8+kZ/g4q5bBg73CCv2O7MHJmHeTiEa9l77n8LGlW7eDJ3hNXe69KPx/5u1aXsC0tvnuT5oelho7iyDnrRCZOVKidUYXQI9hXCZcMM7TFTGgPG7Mbuncwjx1+UHnAxCkJ5oKO/ihUkLo8tIVaN9lqQDzTRmVjJzVJqFjkHBMFOF7qAjNEZZ0SkSXFDKnAdCRwa3yyRHdHPJGFaBx/mJSBmYKT+a/gRQnxNYHOjcZ80UwRCNARhLplWbWn5PDx9n5/d/R4V8r+z7s7e4+G+yP58OH2/qP9fVq9QvjJsfI3xNVqchgKCFHaHB75DIMgjWB7FoAXvyEUb/EB8/gG+59Br0jbqpnkFZT7W8jWJ4evxe6eKKUZ1zwuxytGMNn5KUZMXZZySEPB1QqaR8avnB5rc5MoytQVJc7To2eD8xeUJCdH/zzndCFea9VjYBCtBYUlREUsTOxHljgp8FF6VI0S5lBFVzxIXB9AIWn8IqGOb37mYUzE1kjWZcCMtPoNMxZZi5Gz1VIq5bFQinu6q7pbKF4Yq2TIJ2IoPSbAhUT+YIBSNA3Zi2TJB2KCMqnc/a4YFIUmJWVJRRFMMX9GVVAWBaVuZDCqkcoQRoeJrYMwNuhcLftibsplbyAJdGCKF4tOoeSA5F+Pk0EeagjHai5mYRstScTkH8gcLbcs3dmC0dikMxNkDi1kWc5gRudgYTGEbjp4kcoRucuj8JiGrq1YVAIbtbjcvYzCPEUxpW+5rP035N3rEuUnY9XaD5cqJR/CwKZqxN5o3JQqEj6S2jw5UbXuahJfjLQqi03ubnJ3k7vfmLurH08S3ktfGfrsrEOfcyMBVq3jzXMN+jiOHmNFQ8TwJjlyC0izgUi/vDlDYv+qDNGrT1Pt1PfER3ErXxN+0Pojjg8JfrTOWvIFCch2jBqMUIlUccByzyVmQ0VTPVxf7Zl1Q40ANTdARILwYmZrIWEyVxtDkki/JQqrvPkpiIlEfZQMrGMFpFVNkU2tNmGDJDdIcrMbbXajH2c32iDJTe5ucvfPmbtfRJKtVJwtCSf5uqqkm8VIS99JWylAIJqTR9GmHLtqFa0QM9FirM4ycugM+zvDndFernYLuVs8frg/6ueP+/LR3s7eznC3v9dZ3Osv5nncJtlyTi34O/qRTQwQdwkcVxsElw/WFsvHfzCvUyMqa1R6WtwMm8Ok71rs2N9fx45n1oqX0swahOSXMKSZ24hqGmgronUNLQikGKMuGoFSpSEXhRIdAmfCIWhEqSvNyUtagK+bZYNRgCoxUZoga1fRJi9rSMiVoLSEmi0CS0NJNSLMBw6MYMeozt8RnSYX/S4kL05I4xeksTj6lCtFid4i90c3ne8eQ3hHNeI0OviWg97Y7UiDAEBDEGtWizs3+HyDzzd7/GaP/zH2+A0+3+TuJnf/nLn7X+DzhIZux+cg+GZ8Dtrutmix1DMKrv85TOdUSRJweAub57Xj4+YGgzOuQCilyxxUQyRdyOj05rcuemzqjEB09jld8ojwPwpWuxITJiFM/UGvdwV/wU/XXTnVXZQxuCzMjP3YzW3VG8JIN9QfuigQc40IxOD1ceovumxhpymIY8Vj5tHerBOFK+zOZ8Nf5GxkxY6c2Ro1jtlsCQR8CigehohTdBM/eabucgCt6Qe9zl15/ft1iYxu0eUm831xNdALSLqiIqmwcPvmlKB3XH3tDs58O6F2rb+22Csi64snSjr0BfEXjHu/vDm7L8YEODnha09YV2nqEJAyrxEiXNAGzWk+TeI9xtl6PGHBB0u/l1ACiVEJhcVbc6qUuDhORvgHKv0JSjOblCYprgY06929xjuFulQlbYLduSUp8HRherBQTy7Nu88bHncG2uCx4tHuW5OJp5rqEN0IYpqkIjd64mLa6CUX9LqrEH9puGWRW8bc/P0VKaJpL/J4/yZHFhMLWXq21p0Xj/yyBX7URmGEuK7KQJZIciz/ypU3XruzHEv8MuK3LMdb82aisZsuTxOxeAmPzbAsxLHIJ9Z69TchKHQoDS7GNbLozmJ9pEUzzoisv70gUhaXzDRdSWP5XiAxTAwmOaS9maGJBWozRUzJ9+xZ5Px7dM6FeL+kMw9f0J00UBY293eWmRbMaMEs1gCf5I87FAUWcpt04DoQA+Bw7n+uBEnQhboXed1Y1Zl9j+fQ1pBDVObipwfx5WBe4NKT4A9E3dKgDBO0bn/3w7tIvGibWjJWcyiwasF1eUuL3XHFblHe9lCKdsw/mr6k8WB+dvLKlLPvXaVvqSR/nLr7f6p4m0rzI1aaBHYp3HjZ1BUsBvmThNfWz/LosHmi8BdfOVcZV6Nr4T6MUcwio2kpA0U1Z3U+0YpPAaZKBsJ+WxRZtuJMRMNO6Y9ejxmNHWiQth6YVA51CX58Tt2sLDlhIrAkv9K7r7kVobXyCbpK1RVv0JiZHG6hpoxuWuDbB5u6s1N45jU5VjxtnA3QVVW1wWqUl3UlJELqKxFRaJ/XsXChSzCqsYVl6NfOarKYQo1U6HJ74ir/akQHzOhdFxz/lbXgd59Ol2F68iKhdOp8WkVOVBmvcYNuGbZ/jTeiLZuockptIaouAJhaWOHl8dkaRzAzHnqh/Uav1EuTfI9owYTaoxg+D7s73e2M2wWMT60PaGQXmNO19ebS+vy6+moUXs2P1b/bRfe0lVAP0JvS6RUJWMeeJPaBF515Hxi73eVOEL3FBAoR4dUVnXRQa3RNw+jwqY2+eDfveugNC8QTD24df1XcafOZyLyZXv/VgHqYtk99fkTOkLdsh+mBlrq+/g+EDhHZ +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +
+ +Request successful + +
Schema
  • Array [
    • + +string + +
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-work-item.api.mdx b/docs/api/beta/get-work-item.api.mdx new file mode 100644 index 000000000..9276cb497 --- /dev/null +++ b/docs/api/beta/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: eJztW21z2joW/isa74e+TEyAQJPwZZcCyaVLSZaQdu9NM1NhC1BrLF/JTspm8t/3HEnGNpCEsJ3tbYd+aECWzvt5dI6Q7xwRMUljLsKu7zScCYs/Cvm1G7OZs+fEdKKcxpWDQwTHlHO95/hMeZJHuAZWDKdcEVimSDxlxGcx5YEiYkwoWSwjIxaIcMLDCYkFYRxmSj1dRczjY858kigmX1J/xkMi2Z8Jl8x/tUeEmeYlUrIw1pNKIFdEJZ2xmEmU7s7hKMefCZNzeBbCE/gqbkMmQaU9R3lTNqNO486J5xE+UrEESZz7ZU26bRQb+d2i4BwF12SQZSqU0xjTQLH7Pcs2ovE048qfYJhRiWXCNhCg5Nxf4zIViVAxhUSr5TL+WfZCXupbsLCmM+E3LCTdNmrgiTAGI+JaGkUB97TX978oJHC3KjWVkqJBufZ7Ni5GX5gXoxckxk7MjVig+orGGygIc9g3OosCXFb1jitH5aODul9l9cqbo3Kl7h9Ux0fHZY9W6keV1IRMxdq5z2C4WLY9wzZXUUDnfe3qpzijQ3yzAGPjcTHeiWlILmbgNWSYhu5GPDIN9bJna6dXba5SXpdVhu8oBFOmiCcZjdlaRcZCzijEouPDDDfmwL8gebly6JYP3UplWDlq1OqNg8NS+fjoD6Q6E76GjO3IHrnlN261PqyWG9Vqo3pUqpRrf6xgwUbezUYej+qWNgOhnicSADGYrkQiPUZeNNsvkLWK4fk6pixMZoi/J91+9+K3ThuGBp13ndbQfhxeDvr6Y+ff592B/nTe6be7/VP41Gr2W50eDoZJEFznJcrRW9VLS2MAPK9PzGO9Nt0eLrTQIL0R+mHhL/v/7J997MPIaaffGXRbKFtnMOyedFvNYfesr1V532l3029tEPs0/dI8Px+cfWj24OOH7llPDw86H7qdjzBycjZ4j0qf9bqt3xePkcFvzV6v0z/twOfu+/Nma9jsN3u/X3QvYOCie9o/OzlBu33o9Ifw932zf9nswSyzeti5GDoFi2WirxoMFV8XAcsWG6KBNKDMmM/Nnvv9sLUIBh4uHluMfzYoxFTCjv58CCpwJYbKlsy3g6QnBfgCSFtSKUCZCdvi+vM4w+bKg6bvw16ukHduD95O1/wmbgClwK/pxbD5kzaUG14soDRCnjGQHiUx25JjuhzqOazlrM7MLzCOpiJk/WQ2gs0hz/MsLTQ3Y7yoS9dbGI2cF6kgQhL5FpwWzz/QINlQ5Ruc+jyd65WqW6/X3Uq1UkW2IUXjd32ot3g839TS2mHcLkoFWBfEuM2aKAZu9xnSDIrI0jbFuI02KUCx7ww4KVkNeS8UQMGz091uixvys3uoZGMGHYEHjcNonmZDJskjKZ/Lmv9LyoUbZ9oi0sCOetVj6CGel0x52tnS9Slzs3mm5MmaZXmS9B+jkidmP3uFk8uvZi6Lcsm1uY+zFm3Fw00b2qZa1OWzwEdbF9BHbqXsVo6HlYNG7RgL6IOjuq50weTLMMChNZzoYn5NAmgoR3PpTpDw8OFat3IM9JmUQuapP9RJZn3xgsDVkpmgtoinNCa3VOUOC/BbKGIyBov5Jec676PUe+AZ/Lfn1Nb1y62A44FCB0UlLhmwOJEhUOaFNo2MhD8nHHUGr3N/mzb6AYQ1ByUt4W8QOSc8ZO5EUo4SausSDxYSDEbu4640EzI9e0mxSs8rFYICLFGqkLfUB32Nfi2rDNpPUu8r0Nqk6rsMOawn6RLYs8AV8iG27JDR0ZvycbU2flOjtHpUqxzWR8djenBQPq4fH+umDnCNTti6qCmyPmXQdHKPBMIDj/wHDAL5gl0nCqCZb35koWlsmLlm7kJNKy+J2bd4D3Dkbeuc1A5JQMNJosfpZMkIoXuJvQciFR3hEJ4AgeaG8JnkE74WzFOEbHdOmpe9oUbFf11ig5KiXlHYZgjR6mNYCp20U3GrJbYK6ERiAZiD+SXy2lJ9DQrRUOUncvNNzRXmoc/GNAliWGG5r1mRJ03GUswKqaTz5ltMXvISK+1BNQVjgGDelIyoggW2oHsNOMii2O1ZS74mU0Z9Jl+VCGx/HJWETV5vNgrWz4EQob6PqWsIjBNIZaaPwEQSI0xwjxV9kZmy6I0MRHp5p2BygORPxwns/wkIp9XMZ+EiWqyI1j8gs7FcUbphzmjapPMwplBZwMxgDmaUWF0Q2HUBIRWxcITuUgA8YTpvgVh5bNRw994I046FfubRRG2Qd+cBwI+rVVs8uGE2+RQe6xo00t5I3WQRCR7qShYX21kLd6WJTwDYA3+Xu7vc3eXuhrm7/HBgfyWwT3Xpc7Ba+pwIOeJg9XBN3YM/sJC5SAgFN8gkDHF3p2qP+IKp8EVMpvRGd2Egh0lrkJ2FvhsJKCF35dGuPNpB7A5ifx2I3ZVHu9zd5e7PmbuPlkcLqXS22DpJJbMZlXMTafa5OSaECSS9hEEWKbc4Kc1XK0iMLGosp1g5OKNqZVQZH3qs5tOa/+bgeFz13lRp/bByWBnVqodOfq+/yvJ4kWTFnMr52/jRnG8yeQN1XBJCcKlYCL94ppXo83OENYQemkA0SSgVwOZ42+R+cWxWW60d+yIG3YAw1I7ygTOzy0HPnM8b8mg383M3Jq02nTnSw5JSn+Kxb1zFu9JxVzrutp/d9vPLbD+70nGXu7vc/Tlz91mlY+2p0rH2jNKxRvrp75o/snT0oe7QP7CCU0CH9P61ZBGoAp/MHZw07c0VlUWhl1WRuvyAiLM3yxFq8Lp0w9nHX3hdDUj7d9y/hyeGsxE9kQFMmsZxpBr7+3fgSnDhfYlGvJRejwnFLV4u2B+B/dZAE/5ma9IQJ5DmedeqVtLGlxzj24ChJm5cobMZIxlcok80H6Wc3gyZg9bEkNnDy4A21vQw/oZPw7m90lHSsbWiH+h1KYP7/10XQ+gBXdaZ71FuMJ+ApEsqogrX6C4ICn23Cfx1CfK0DJI1E3Tw1XV+zgVW7kbClZnZboSNSHVFoDOcViVvGZX4zoD4ykLy8t3H4SsywXpV40WisFS2rxVQcg5hpPGwmZ5T4yIdq1IkE3MzvmnbHhPJmH9kHIBRyKfwgjFyld7d6sNGMQBk12bHRUyDCa66fpl60Gc3LMA9tJRZG4OT++E+WHGfFta90omjGwsemnscMFr6FLr26hDHfR/nWBX1ITy5ilK9aE6vbYX4W0rNNdRcTU29WpLCmPbKM9clPMm0WWigtLW2Zm7ouTl62IXBCFJdlgEtYeWgBa95qde2lqNAz0V6RTk+hR+nHDbj4jJiQI0o2EsDn3SJNxVCsb8TgqGDqXI1SSDTthbrFpm6OiPcajknkmtYutyF0lLL14PECE0w0RFu7bqyEQa5ddp+1p4FXPhMKIx9Luish69gB8aZvvDU1jIjQxcZugYnlJXfvhEEwuKtJdBB44AJgFbmf40EVtAcNhpaa5Ffk9/Xa3D78EBUTUVFDfOlkYGg/UT0A5y9mANQjZX54hct+E4sLdy+CsZKzxSWLbgqbyBgj12ym5F3cdyC++5fTV/UuJkdvZyFwfx7o/QDSPLXwd0fhHg7pPkVkcYWwRhumq1tKvJB/tbWdKtHgdAvgN7wPzzVuYq3NKEjiLP3+/KEooDGGNU6q70pZ/oQIWI0xvpwDyNLzHQmQr+P6Q+toiY00TdOJYhMoe3jAdArkWHGmeqEMcUn+hW/q8Se5AoISWhKWYl8hL4u9MAt2NPhHQJ49kXY5u4CPHOOjiXt1NlQdM1mSYhX3UHsZEYohNQTEeFz5SUGuKDFC1lqC6FLv8WqNIsx1FCFkm5y5EydjS+gcobWN+f4J3iB35U9nAbToxftu56ZIgMW6MjEecXS/inaEG3ulAURdpWAulCAsRyH993hCkUgFto2S8jJvl2k9nEuXt4G5U34HJQqpbKrWwoYj4SKoQ/OET+Fji33iu5y+N1lx/E/5BVfu99go7Af4QkZapGY5sY0kVdO1kTCggb38ZWtKSiKz+7u8AAF26p7HDZvB2OvAqbHfEhf5H1E7UffB14r31eGJwDZq8e2y3f0S7xpp/ZMKV4OUluRte8HPyBKeuQYzvNypCKCraBHB2vpUyQtkXlgzplyS1Z+iUFVFk39aQei7v6/e1mCjg== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
\ No newline at end of file diff --git a/docs/api/beta/get-work-items-summary.api.mdx b/docs/api/beta/get-work-items-summary.api.mdx new file mode 100644 index 000000000..8a5aa51c8 --- /dev/null +++ b/docs/api/beta/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: eJztWm1TGzkS/iuquQ+bpBgbjBMWvmwRkmxxxW5yvFQ+EKoiz8i2krE0K2kgPor/fk+3ZHuMISTc1e1uyvlAPCN1q9+eVrdG15mtlZNBW3NYZnvZSIX31n0+DGriT5rJRLpptpEFOfLZ3nlGQ4LHsouNrFS+cLomWlCejrUXIPdCCh8phR2KKyLRRCIGqrJmpM1IBCuUDmPlBP4IX6tCD7UqReOVeyLLiTbCqT8a7VT5dEPYOK1onFMm8KQOhKqlkxMVlCPRrjNNQvzRKBbYYASP9sooB702Ml+M1URme9dZmNY05IODJNnNbTUOX5HUtN5ccsFsaMmZUNneUFZe3VzQK19b45Un3r3NTfpvmeOR9mHZEuBUWBOgDM2WdV3pgl3Q/eSJ5HpVXOmcJMUi/eK9HXxSRSBrOHJk0FEQ/DatWRqLjZTLVn0Gs9rGsHxEsyyk+iIndQUGvd0bEpkeAmn/fYznhPdw3wLzYIOsvpcxE93DdHvzhtjqQA/ZSkzf0L+NrH+Xww4qTXH22jlEXi6OVWicgfQ6xgUFgYJLB7acCsS8Npey0mXnEV69x3ulClJXB7ZUqwF72yBvtFH5yElNEioWuQChAMdLXRLYJtYpEVnOQpvnddrmIkt0tsRLWULfqN9BUobM6GTxGbwOy4cFOjMa9GJGInQphgnBdyyrdpQcvNjc7fWHL/pS9n7ub+08H+wO5fb25u7z3V1afaK8lyPl74DD8tK/KuBUF6KyBTzybxjEKQnbswC8+LcjiHl8g/0pIOPcuZpJXhHUl7CBbPjy4J3o74hKmlHD7+XolhFMfnZCWaupKjmgV8E1CppHxm+dHmlzlyjKNBPKy69ev9k/OzrFm+PX/zp7fYJfxGslR+8bRGtJYQlREQtje8USJwWupBdeVTCHKjviWeL6DApJ49sTdXzyU0/psVRD2VQBFGn1OyjarMXQ2ckSlBg3X4J4ojuqs4GNAu8mMhRjMZAeBHAhTX+2XxSqDvlRsuQzMVayVO5pR+yXpSYlkQ+ARjAF/RSMhCxLgm5kMGwAZQiDvcc2QRgbdKGWfbEw5bI3FrnkqO0UAgckfzhO9ovQQDhWs43CebQkEZN/IHO03LJ0py2jsUmnJsgCWsiqmsKM2CELZCboprERp3RE7vJIPGY2b56x2imS091vUZhXwfJYIRv/Dbh7VyH95KzafOBSJfB52u1jNmJvzNyUMhIGSW0mTrPm7poBX6A4qMo1dtfYXWP3G7F7e/A4lalplEuf7dXS5411Aw2rmzvqHqq7xdQ2QsINrjGGdnfpN0RplTc/BTGWAL2Em72PsIbsypR5bVHNrcujdXm0TrHrFPvjpNh1ebTG7hq7f0/sfrU8mkvFaEl1UjrSjJGWxklbKTBBzE4BxRxy7Krb1QoxE/MaK1uuHLJBb2uwNdwpVL+U/fLF9u6wV7zoyec7Wztbg35vJ2vv9ecLHM9Btoyplr+jH9nEKOIuUcc1BsHlg7Xl8pkWzOvUkNIapR7ZIJocSgXYHCa9uJkfm/VXa8ffbYBuYIza0d1zZnZ2fET8sTSzJ7vZxhWKznij6TBdBi4pKYZhae3DunRcl47r7We9/fww28+6dFxjd43dvyd2v6t07D9UOva/o3TsCyqxhlRi/ZmlY4m6g0qzIZwCHWaf5Z2qoQp+cWU2h32QbqTCvNBbVJFcfiDi0q0D/qAfxnjo0gfdnBNS18+vIMTFo/SNqzBvHELt97rda3gTXrzpyFp3kOTg0DA19qpT2El3ABPekZ3os21EIk0Q++8Ok3Ydtr/TFOIxHzLz6A0GNAUzvMKHml/lTHcQyM1TKC4imw0BOKRw49f0aVya6U+eZ3c4vFb0g15nrrr573WJjO7R5S7zfXU1zBeQ9JaKpMIFuQtxAUbsrzPIcxCT2X5DPj6/aM85oeI9Srgyc7EhUS/SWxHoLU3riZdKOrpNYj8rI5788/3pUzGikpVTRuOpWk4XTqR4hzDilLg/O6omIg5XZ5vRmJXbT51PDGaCoBhWMIr4YE6UEueHyVC/Y684RnJnsxOR4nxCVBdPZh4s1aWqaBvtLKxNwalL04UVu3KJ7iljh3sLbfBzwm87H0wuXmnKZJq2fpqTVORzeHFez/SSLb0eK8Q/ZtzyyC1nbv7pLSmiac+LeGOicIrNIivP1nr04pFf3uJHjRjeENfbMpAlkhxyyWvFzGuPlmOJX078luX4YN6PNfbjZTIR85rw2E6rUhyKYmytV78IQaFDUDkfNUDao8W6okVzRkTe22yJlMclc52jumT5jgAME4NJDmh35+LGxuTNsP3InkVe+Cgk3n1c0plfn2MTppmlLfyjZaYFc1owj3nCJ/njHkeBBWyTDpwHYgAcLPzPmSAJ2sqNkdedmZ/Zd5mG739BVObi6734sLdIgumX4AGaPZ+DVE3F+fyjFp5F4kU72JKxZscKty24Km9lsc3esluUd37iQlvvX01f0nh/cfry1lTT/3WWvieT/HXy7p+U8daZ5kfMNKkOpnDjZVNf0Q7yl6mmWz0NRMsAvfEXo4xVujOJpiBwJ8dVTJtRXclAUc2oLsZa8TlCrWSg+nCDIstOGIlo+Qn+6BaZ0chhDmDrUbfKga7AryNOFytLBkwsPsmv9OybdJhrEZLoS1VHvEdrZwq4hdo6ukaAsU829Xcn8Mw7cqx4NXM2iq7JpDFYjXDZTIRESD0QEaX2RRMTF7o8o2a2sFz6zalmKKZQIxU63Oe4iX87PEHljO635fgH1oLfZ/d5YXryYrp7vFDkWFUcmTRvubR/iDeiLR+rqqbGElkXBZhqrfDb4ekKR7rEmzot60bdROS7NBdMqIWK4bPd2eps5txS4H1tfUAr3GK+uOotFvfAlyLwenEo//+//J32G2oUujUdkpEWTWxuYh95ni36SIJlUgJ9xxjK0vj1NZ2jUGt1Q6/j3XHqV2B+wsTsmvdX9P7qbfE7Zfys6CBgcTE9NftZRh3RrFvjDgmC8jkOixTJ4klPi2rlWwhxmbfVv76G02/+A12SzW0= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
\ No newline at end of file diff --git a/docs/api/beta/get-workflow-execution-history.api.mdx b/docs/api/beta/get-workflow-execution-history.api.mdx new file mode 100644 index 000000000..71f1a5c58 --- /dev/null +++ b/docs/api/beta/get-workflow-execution-history.api.mdx @@ -0,0 +1,95 @@ +--- +id: get-workflow-execution-history +sidebar_label: Get Workflow Execution History +hide_title: true +hide_table_of_contents: true +api: eJztW21vGzcS/iuE7kOTwCvJsmzX+nJwHKfnwmlyjo0A5xoItUtJbFbcLcm1oxr+7/fMcHe1a8l1kgbXNicgiCVyOJz3F4q87WS5stLrzJwknVFnqvy7zH6YpNnN8UcVFzTxL+18ZhedrY6XU9cZXXYqENe52uokysVW5wQJBD8oL6RIlJc6VYmYhbUim2DUaTNNlbgpVwtV7dAV4t3KoBPSKiGvgUiOsWySWVHkwmfioC8SuXBirDCm8Ad4ARzP9LVKgOtkIhZZIaT3ap57WiHjWDkgXLO38DPpxUwSOmVqNFuM4kanqbAqVhjC6mF/KH7KvHiZFSbpQiAOSKz2CwjltnPhlD3KjFcf/WHhZyQol4+qHUdWyaRzdQeJ5dLKufLKOl5n8AWS0wkQapJhLrH6vmBPEhKin62TH4Ct+rXQVkGH3hYKlPlFSlidnuf4sNVRH/M0SzA0kakjgHim5rIzuu34Rc6Q3kKODCl5zagTb++PldyR0e7+MImGuztxdKD6w2i4s7c7GU925aQ/7twRS1a5HCpTjhAO+n3606b/FJZAHKzRgLpWxjtWMPE3hbDNei5jEq/xhF3meapjttzeL462uF3lSVoryXA1LME1xrPxLyr2mMgt2b/XqjF7n/Jz0EQzRD2TSjIyxbzpCbWzvAUJSQHTB9DqpJfWr586ykjmD0y+ZGdqzJxL92HdTjy+sgmNrsNP4zXqw9jra5jyfdSt8Rp1c7SJujleor5qWtR6Bu4QWvRcOQ+wdRYJy5hLaL2TSK8iAl1xD1JSPStuZsqwLbG+RBbDTS0TuCRl0B8Moj7+7Z8P+qPtndHOdndv2N/b/n5wsPcfogkBxOpx4dVa02nvf5gkmj7KVCyXCelcFmuQlSCU+NmSpCYlt3d3LADfklCt/GOGv7tjqOE61zpKNXF5bC08KBJnyhfWYEsd4gWFBshWjLNkIbQT2lzLVHP8+lx/esBvQrg/4vCyqr02sS+1UdHUSk0UKiY5xkIBjNc6oUg+p6AeUFYhj+G6LfVBEt1t8Vwm4Dfwd1QyQ8K0Mv4AXJTTHiPowmisF9USoZM6Eq3ZVu0rOd7rHwyGk72hlIPvh9v7u+ODidzZ6R/sHhzQ7rBkJ6ctq6kC0f1kaZTVsUizGBr5DQJBkoDsmQDe/NNjF+P4BPmTowTYms2SXkGZawtp7vnRGzHcF6k004LH5fSeEEx08RYjpkg5N4ekA84D4tdWT7VZm1rKsPni+OXhxek5Rs6O/31x/BafCNdKNXFoYK0JmSVIhS3MkA/8koEbZG2nUoiD8v6zEuszMCRRPjQAdfjmFg7ChG1NZJF6rCh3X7OiiVpMbDZvuVIc0rx4oruqu4XKAWOIUPFMjKXDgixEn2eHqDtyH52WknwmZigClH3aFY14AW8EUqxfAJGQSUKuGxBMCriy4tiRFV6YzOtYtXWxFGVbG8uIctpUCjkHKH/cThDJCxDHbDa9sLaWksRSP6A5SK5N3XlDaCzShfESOQKQ6QJiRFSOEZnAm0YFUIYjUpdD4DEVXB2xmoGSw92rQMwLn/FcLAv3CX73JkX4iZi1euJalc7nqGAM0Yi1UampjEiYJLZ5cQlVq6tyfDHRKk02vrvx3Y3vfqLv3p88KxuKcpZLn+3V0ufCSLRameXkuVL6WLYeg/6vBOLyplTkloBAyhLpx3fncOwPKBoBj06JOqmvWB+FVL5C/GGtjzA+pvKjVlZLF0QgyzFwMOHSesR0LykORSKLamd1t5eZHWsYqFlTIiJq2tAzQ2S2MIY7arclkkw58x31x9QAhy6aIyDtapIoz7Txm0pyU0lustEmG3072WhTSW58d+O7f0/f/d1KsqaKvaWsk1wxn0u7CJZWzodfLAAgqqNtUbscq+p+tULIRF1jddqVQ2c82B5vT/ZjNUzkMNnbOZgM4r2B3N3f3t8eDwf7nWauv1z6ce1kbZ9q6DvokUWMIu4adVxhYFzOZ1nSPv6DeK2aUFjjn0Squhkyh0ivlrXjcLV2rH/0QO1oHzhevDg7JfzYmtGT3LLCxorK7CC68FMLlZRkw5C0dn5TOm5Kx0362aSfbyb9bErHje9ufPfv6bufVToOHysdh59ROoZ7JRMqsf7M0jFB3UGl2QRKAQ/8q7mhsjEHK/hUnj6Wbu+lnSpfF3qtKnJwsOYiRZaJV9IsqmLJtU4izVJcFN4AOydYW8ECQJZ3QxC1dBbuw9Cv/ahJYT8i1XPNfkwMAa9dRIcTD66Cz1T2Vu+iTZwWoJCDQprR2WsGG9O+ulgEDHwOOkWg/opnnKW2/tB5sDgjjk+JY3H8MVaKfL4+/91dd0vgBMRbChdvg64fuC4QzsylQRuhPuYhfNUl6KZU35Tqm3S/SfffRrrflOob39347t/Tdz+jVC+roYdLdQB8cqkO2G5f1LXUSzKu/3nFzq5SUsDmXd9wXdbgXFfAlMpb/RRD6Fr5qNOrblZHy6v2vVud3PVm9UX/0A4E6gqbYtXM+9yNer1bKA3KuuvKXHcRy6A3vzDZTTfO5r0xJLUmCNGd0+BwBCAO35yU/UaXxWw1WXIIe4w8CJ0ZI5uF8Pmawe9ipkv0pM0FWhER0GzRre3SqngYJOZoKb5zDN1lK1rhD3xd2PTuj/MSED3Ayzrx/e5ugBeg9B6LxMLV8hkC3aieh91XHiMscwqd/A9WNntNYAPxXEmL5iBchnny47vzp2JKVSd7fUEvOITS1CbAb97ARDiqHVYXQ2gRJxqbFdNw3fmwdfWGvEiQ8XXFz+atUuLypBTCTwj3Z4jPLFJapDgk0KqrJ5V2EnWtUsqE3aUkyfB0YnqQUE+21j3lrMftgTbhDjk9NvnZROKFpmDEr0wIpmSRuz1xmVd8yQZfX0rEPypsUcAWMTb39B4VQbSXcbjKHcOVCYVMHUvrizcP+KIGPuqlMEJY79PAL2wCHe0LU3GltS+mo4UvInxtOn4272YaKbW9TIQIJhwyYpqIExHPssypfwpBpkNucDkt4EVfTNYNbRqxR0SDfoOkKGwZ6QgFItN3CscwwZjkmBI01ydZOCphl3zPmoXPv0f7nIj3LZ55+BJ5lCCTLHZfTDNtGNGGUYgBrqQ/pCkyLPh2eJ0Fpw8GcLTUP0eCktBG3Au41kZ1Rt/jNZQaYpDKWFw+Cl9GywBXfhI8QdA1DMIw1df1FTJ8FyUuylUtYVUnA/cluEpvmiFF3pNboLf+fZPS5l+NX+L4cHmA8tqki68dpR+IJH+duPsnRbxNpPkWI01Z8ZK58bZla9A08udlvbZ6oEcnzjOF/zHLvsrFNVqX5aOtJqI8lZ6sOjwsnWnFRwG5kp5qvy2yrGzOnoiundwfDR8jmlrAwG0dalI51inw8WF1tbNkhwmFJemVvruivDqRwSTRWqqueIfuzMRQC3VmdGkXc79kZYv2Fpp5Q4oVLyplo+iazwuD3cgvi7mg966PWESiXVyEwIVGzahKFhmXfvWqyovJ1IiFLvcodu5eT+iUGQ1sQ/GP7AW9u/KIGaInLZYPY5eMnKmULZPg2mX7Y7hhbdFMpTn1hoi6KMBUY4dXJ+crGIHMlL9rZHbaKxe5HsECCbVHwXx2utvdfsTtAsbzzHl0sw3k9CK6ft1cv+oTy1fVLWu8XZ6x/5+9pS4TH3UsvZwO3EicReigQut62VnTumLliJ9OV90r+qEZlEDgt7d0REPt3B0N/1oo6v8vr5adGne4MBL6nNRvox/UyJOz8pn1U/HIe+y13FSHjGaxPF/o4OMHRccS4ALNO6jncyOmLEyEk6XGkpXfXqgJrLv9H47JmuUD9UT5AVJAxPwvadNoWA== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-workflow-execution.api.mdx b/docs/api/beta/get-workflow-execution.api.mdx new file mode 100644 index 000000000..9852cfc70 --- /dev/null +++ b/docs/api/beta/get-workflow-execution.api.mdx @@ -0,0 +1,95 @@ +--- +id: get-workflow-execution +sidebar_label: Get a Workflow Execution +hide_title: true +hide_table_of_contents: true +api: eJztW21z2zYS/isY3ocmGVHWCyVZ+nLjOE7HnbTJOfZkrq5nApGghJYCWQB0ovP4v9+zACmJlhw7ae7aZtTptDQJLPZ9n4WAmyAvhOZW5uo0CSbBTNh3uf4tzfIPJx9FXNKHoBVYPjPB5DKov5ngqhUkwsRaFm7IJPheWMaZkWqWCfahGsdETaTN2Lutl4ZxLRi/5jLjU0xLc83KgtmcjTss4UvDpgLvBP4Huhgcz+W1SEDrNGXLvGTcWrEoLM3gcSwMCO5Ym9k5t2zOiZxQKzItR+KDzDKmRSzwCrOjTsR+yi17mZcqaUN0AyJa2iXEvwkujNDHubLioz0q7ZxUYopJveJEC54EV7fQTcE1XwgrtHHzFP6AjmQCgpK0VXDMvqvC04TlKZjdpT8M1uL3UmoBM1ldCnBmlxlRNXJR4KEViI9Flid4lfLM0IB4LhY8mNwEdlm4kVZDj24kd3MmQdwdTQXv83AwipIwGvTjcCw6URj1h4N0mg542pkGtySSFqaAyYQhgr1Oh/7X5P/8Ps5jUpmyNIMXRSZj53AHvxqadrPBp4Q5zQbD+fRXEVtQKDT5qZV+dehxh1CPYYadvmiIP+2P+2kkemE0OhyEUTJKQz7tjcI+H04PE5FE8WE3uG0FNaXTz135znpJr9ONB8k4TPqjaRjxHtZLu1E4HEbdKO2Pk8HwkNYjWwtjH7echGPz+DehEizHrMZzIxAqYkwq51xmaaDmNvs3vD/mikG31zIR+AZCIIBhnMWlsflCaGbKosg1QkxiBetCNBHTcjajiCxKXeRwiXZDyKgruj0+ilI+mkZ8yMeHXEC/h6PpMOJxMiUBjeXanksKi20BsciCW1IXtyK0NGqXkunrAX1txowjLZIGS71Orxd28O/ovNeZdPuT3rjdH0Drh53e8GdiKM4gyP+GIRjmIXb63fbwsBd1O93h4OdKP7Y0j40xVg1vbUe6KheUpo5zWtqr5SXyrXs45ioW/vGsVIpmXG2yuZ50C5astO7tdoG4pX9aQbQrKRxnEqHPTrSG54TsTNhSK5Ew6TNd7ZvTPFky+J9U1zyTLvM+Omt8OlkkwkLeY5cYH4qll1KJcKa5JA6FYznGxCpEyOMXVI48yTpZu3F3IqDTaXfZc55AXi/fcSUM6ZECFLQeE9wXSmI+q6cwmbgIvGdZMRJ8OuyMe1GKSOO9w6g7GkzHKe/3O+PBeEyrL1Al+UxsZlmuNV9uLf29UELLmGV5DIv8BwpBeYPuHQNucSpmj0vYjsYj9E/e7ceuxKz4ZVRzW0hMz4/fsGjEMq5mpXvPZ3eUoMKLt3ijysyhCl8uIbkn/FrLmVQ7i2IVKi9OXh5dvDqnoDj518XJWzwRrS3Ec6TgrQm5JViFL8wRkXYtwAfgDYPoii0hlmcV1WcQiAP4bAyUZiMtw7dSXmYWM6rVd8zYJM1SnS8aoRR7gMKeyLZot4B58A7ZK56jShhMyH0ZeHYExFTY8FWlyWdsDvgi9NM2O0oSSULyjCEaQRTzlyDEeJJQ6HoCaYlQBjPSzvPSMpWjRIimLdaqbFpjnUxebRqFggOcP+wnR7EtwZwTczMKV95SsVjZBzx7zTW5O99QmlPpUlkeQwqeZUuoUQMWIjNBNmkNq9IRmcsg8ah63CpjbeZIl+5+9My8sLn7FvPSPCLu3mRIP6ETbfXhWlTBZwjq1gWbr81UZSR8JLHd5GrUylx14LNUiizZx+4+dvex+8jYvfvxrGqFqq8O+nS3oc+F4mgSc+2K5xb00c57FDrXapCDN5UhWwwKqSDSD+/OEdiA9zQePR71gF8RH/lSvsX80coe/v2U4MfKWA1bEINOj16C1MHLieN7zbEHiU5V/e3VXuZ6KuGgagdERNbUvtuHyrTHqYybFktyYdR31NlT6+77f5cBaVWVhEUuld0jyT2S3FejfTX6dqrRHknuY3cfu3/P2P0kklxx5aKlwkmmXCy4XnpPq76TtPRTRZ/Vm/JsFXLOVHfRChFjK4wVNJFDMO11p910FIso4VEy7I/TXjzs8cGoO+pOo94o2Kz1l+s4XgVZM6Y27O3t6FQMEHcNHFcqOJexeZ40t/+gXi1SSmvux5waN0PnUOnVGjtG29hx9XMNsKO+Z3vx4uwV0cfSjjzpLS91LAhme9X5H4kIUpIPQ9PS2D103EPHffnZl59vpvzsoeM+dvex+/eM3c+CjtFD0DH6DOjoT8SkBLH+TOiYAHcQNEthFHdCAepVBBsLiIKnavexCnvL9UzYFdBroMjeeMcP63nOfuRqWYMl09iJVGt1UXrD2AWN1fVYd2ZihhSpGLKWzP1JHjoJAEwK/2GZXEgXxyQQ6OpleJRaSOVjpva31SpSxVkJDl1SyHLae83hY9LWR6JAwe2DzpCov+IeZ2WtP7QfzM5I4lckMTv5GAtBMb/a/x3sOiVwCuY1pYu33tb3HBfwe+ZcoY0QHwufvlYQdA/V91B9X+735f7bKPd7qL6P3X3s/j1j9zOgeoWG7ofqGPBoqI6x7Q5bYamX5Fz/d8TuQqXiwLk3y2OH1ZM1Bne4Aq5UXTmgHEIH4ifBQX22NVxfEji4kcltQCfxCRp6rkqdYfTc2sJMDg5uYCwY6bbNC9lGDoO97FLlH9pxvjiYQkM7kg+dNfWBRgPY0ZvTqs9oO/VqSR7s050j7pXtBCJfhdLd8YJPUqZj/2TFJVoQ5sm0GLy98ib3GiwWaCW+M25023nPlnyQ60Jnt39cFk/oHll2qe+Tq2E8A6d3RCQRrtYXJ94S7varb12fWNcS2vHvbS32mob12HPBNZoCfwjmyQ/vzp+yGaFNF+0l3TlhQlJ7gHh5Axdx2eyoPhBCk1yB0Xk5mzvGjxpHbih6GDldm/2i3grBLk8rJfyENH+GvOxUSpOESwU06+pJbZ1EXIuMKmB7rUlyPJmoA2jogDfmPXXVzrUFUvlz5XQ95hcVsheSkpC7F0NjKhFdl8cui1ouviHXlzLxj5pa6KmFjpp5eocLr9rL2B/hjhHCRIJnxmnrixf39MINetRD4Q1RvcuDuxPk+WgelIprq30xHw16IdFr8vGLejeXKKXNacxnLmZQCbOEnbJ4nudG/JMxch0Kg8tZiSj6YrY+0KKhi4iw19lgKfRLhjIEMHT8vUJgKO9MfEqF2eGS3G+RuJB87yyLmH+Ptjlh7xsyu9eXqJ80Mslj88U804IhLRj6HGAq/n15IsdCbPubYwh67wDHa/u7TFAxupH3PK2dWd2RP3BzqDTEYNVRMcXE/zFZJ7jqibkPNHo1BmmYcPXq6Bj+ZhUtqlENZdU7Anc1uM1vlqM03tGb53f1uyaVy7+avCTx0Xrj5LXKll87S9+TSf46efdPynj7TPMtZpoK6ZK7uWWrlmDTyZ9XeG17I8+4S2T4L766WHWgGi2La8IcitkkVGTcklf7q7BzKdwWQCG4JezXIs/KFy4S0a1T+KPRc4RmGmPonh8wKZ/KDPTcJnW9MncB44El2ZX+NmV1ZCKHS6KlFG32Dl2ZimEW6sjosC6+/ZpXrdlbWOYNGZa9qI0N0LVYlAqrUVyWC0Y3dB/wiESauPSJCw2aErUucgf9VrPqKCZXIxHarjfRC/M6pd1lNK4bhn9gLdjdVFvLUD1ZsbrKuxbkTGTOM2lcE7Y/RBveFs5FVlBPiKwLACY2Vvjx9HyLIoip6veMXM8OqknmgMaCCLVH3n367W67E7p2Ae+L3Fh0sRvE/W3t1Y3szbveDT+8We+qf7M3vKviRl3JQUGbaaSy0ndJvi29DHa0pZg5kQldmJxDvTTo5oY2XahRu6XXv5eCOvrLq3UP5npXmJ+ek9U97Xs1/uSsuvL9lD1wN3ynDPW2oVqudwwCPP4maKMBvKMdB/duJ8hx5j/4vaKNKVu/plB7t+rfvz8hP+X3IIXqAVpALvwvCet0aw== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

+ +The workflow execution + +
Schema
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-workflow.api.mdx b/docs/api/beta/get-workflow.api.mdx new file mode 100644 index 000000000..de4c974d7 --- /dev/null +++ b/docs/api/beta/get-workflow.api.mdx @@ -0,0 +1,107 @@ +--- +id: get-workflow +sidebar_label: Get Workflow By Id +hide_title: true +hide_table_of_contents: true +api: eJztXAtv20YS/isLXoE8YMp6WY4FFK1iK62LJPbZ8uXu3ABdkUuJDUXquGQSneH/ft/MLl+SHDtp7q4tVLQJRe7Oznu+WS574yRLlcosTOJT3xk6M5W9SdJ3QZR8cPacTM60M7x2ilvaebvn+Ep7abikKZjwg8qEFDqMZ5ESH+w4MV2J0G+BglZenobZClRunCut0uMkztTHbJRnc6Ksl8Ni0jBV0nfe3mKJpUzlQmUq1Twvxg8sFfogGNKiS4nZ65yc+iIJRDav2MCQVP0rD1MF0bI0V+AnW0VES4eLJS72HPVxGSU+bgUy0jTAm6uFdIY3TrZa8sgshXA8UvKcoeN1DqdK9qR7cNj33f5Bz3OPVLvv9nuDg2AaHMigPXVuSZBU6WUSa6WJYLfdpr+aXE9q/Ipk+qvyMqzlkZbijIbL5TIKPbbQ/q+a5tzUmJRRdBawkiy7JYllSpbNQrM2dLdFpCYrhZXF6UlLTOahFvhXiqur0xMxUzG5ifJFDoGEB1vRrFZDL3633fEO1JHr9w6nbl8GgSuDTt8dDPqdftA78g8GR84tzYBX0PTjJDdCWsZCSD1TKYgGSbqQmbnV626wSlqL88VUpWzzcKE0LA92S1XOpRZTpWJhFlN+g9UuuAhkGOWp+i/zQKtAa35OKhel5A1u2uCGNaq2Wqnkw8cIlxbaygs9FTL2mZVGHIgPYMQu0LRYt93tuu2O22lPOoNhezDsDFqD3qD3rNPvH/7TKfhK0hpfpYfd4T12xiO4jw8fRvC3NtzRkHqwQ1YkTyZngiaxGNA+5ZDTk/HryenkH5ScKtHKuxDis7x/k38KiKbavMPOs7bsDwIpfaX67c4gmPZVu/PM67YH/S6taZLWF6zqh3oZyZUgAs1lX4XeXKpI2L81cgz+2bsv9h/GCbszRm5JohUHlwr+NV7Ap0nE5AOSwvaUVqoum8tMYKBuEG0JQaOYAEQGs4tQa0yH0mOo+7X4EEaR8KkGLMIYE4mM9DIe0vBtylERLhBkWUKUKFxA/4xo63m4FJ6MkQoEdBbPMAq1KV8iWCges4IJWlaK86uJSFJxPpoc/yiodCidPdx5H+iP2xRPpEjxxoJGaRAsVYFKVewhLzzQi4lYHofgHFosTFn6Rd2Dj+DBzw4Gz7yD7pE3gAc/8zw5CI7aXqfX6T3cg9f9Zstib2DLUC4E/qYCRj7bJHLfGifVL1qGnaHhBNLzEiwW6jlMtOGwsL8inyUHyerO+WGewPtkhlWnqBG68JGWwxwGYRyuMXhH8iMlLOSSmNOZWmpjwWYOJoe2xWjTp3Qm0+zzlc3TyJFp1dYdoSomcGOSiFm7X5gzxBuiYJGkiulak1qhSNFpqFWz1iHgziMlcVsrU3zKzOYnXr6AwhkwkAmKET9dnr0WBsoIBK1Q0pubBYsML32fDSCj85q2DJIrJb2pZyWCRF6JZoEuNZ65bH2iV1qaBk4Tf8U6LZBORnpCvU2TBU3GnGWC2v99edWC8AwqvXAZQqRTv/UNRn7TKisdY1SdG8UOncxqPgbkvYRkRDb3PKU1Y+MIoy6UziOMjfMo2issMzqenJ69ZpvZ4TXXsHc49ztY1cSYVfdJ5bWEtGI5jRqoYpoksFO8YfQxjyS7o/7w5Vq+LnsAyqdxknFKNZiCkydizCxGTmlcHBEkWTaLrUuT8W9iPg1nM/UAcME50gw2XsiOr+9G+9eGYMPkbz83kY//hpSN3+O/T8YXr0cvcXl5/OP45Orl+KSZ3IuRn+Ca1rhdd8EkVgV8t3Ycv4cniYmdNapG792jomooykbEZkGswSyn1jdfIxbHk0uhaIU1ZcFtN7TzxeWmsGpdQaEfD4sgcSsduDbhkmaCMEK1p4C6b1VOHNQDIp8u0WJpTizkFpxko3AR4nIOlGSE1XW2zJgAkoskbvD4Tctwo6+/e/x9q2RSfPuteLSQscTkR0/eOhZyFfb6CKaRoL6qyVRBtFJl3VpcmDfs9bByPSrsxWWE0i7pZsuClV60kqk3d9FauIj7MFg5n1u/R5THKY0Lz7T/Qk6TPLt/6YucYJlhgHsbwwBPTDlx6jV7XKKe+Dmloa9nEC5Shuh2g3hpEl8a0TfMUnv2AOO8l1Hoi+MLOHjl26wSo6WTxNObiHttvFCkbmIyT1ESnXmWLfVwf59YyeS0NcvTfN804oWi2+KpeLrfw38H4impdGOjp6znm3oFXNpSiey4rc+eU+mlNdYf2KrW37ZVchxRzRXjNIXXuuJCZXkaU/UJrD8wXhdU1qmehzErs/U52ymfbqTQjgAJHPN20X2mfIGuxZ2lMiQOFbPsYaIAxfehT5CN8ZUhWWROHteEcdBEqyOeSx/yGvmOrTBcP6X3DrROH5Cqr0zYF1MAgqvo31xWHSo5HbSPuv1g0Jey+6zfOTyYHgWy12sfHRzxNs4C3oakWMcmMk3lamPpH2jzKPRElHiwyL+hEOAG6N6gPlqcNvYytdgKTps2YBoPbEvM2FJMy6+gBLSHqH5+fC76hyJCzs/5vpytKSF2ry5xh6AZQRsDPSG5IXwGBw+3Zr8CQJyMX4yuXhIwuBj/9Wp8iSuitRFboxje6pNbJryZNEeYZZUAtH1jwCJaE/HUUn0KgaTthu3A0PzSK6DohbDwCzPs6ltm1EkLAr6NUCqy9eOwpVp7QHy4t5AZcvEUUN8XXHaVeDoCIl1m7kuryadirqSv0ictMSoRPKU2EMX8FUFHQHsDHIlAkCOUwUyYzaksUJL31vY+KlU2rVGlkJd1o1BwgPMHpFwvy6n4kJj1KCy9xbJo7QOejeaa3E1qSmOVrpBo0YdgZLSCGtOU2nokSxECjdh0RObSSDxxMa7MWPWUyenulWHmJEv4mSdz/YC4O4+QflwWrXzwXtng07xdwtmIrVGYyWYk2yrzZDuqNFcR+EBRKvJ3sbuL3V3sPjB21x9e2BdE9ilDn84m9LmKZQ79plw8N6BPyt4TA6naQWarxRhyj3p6C5F+ejNBYL9TMY0HXiT8+hXxkSnlG8yPSnuY+9Ni57Uo/ZUtiEHWo5HAvDwZMt8Vx2bbm1XV21ztRZJOQzhovAUiImumYpXkQkJlaR7HxInUe8JPlI4fZWIukR8l76+YDEirou8xuz87JLlDkrtqtKtGf5pqtEOSu9jdxe4fM3Y/iSRLrjhaLE7S+WIh05XxNPucpJUCA0RxVKl6gcumWkcrREyUGMtpIgdn2u1MO8Ghp/q+7PuD3lHQ9QZdeXDYOexM+91Dp17rr6s4LoOsGVM1exs7sooB4t4Dx+UxnEtnSeI3t/+g3lQFlNZ487bAzdA5VPq2xI7doy0nF5JEvJLxqkBIuoEh40pHlNMwdkFj02IsHyGYIS/GdAwhTPziXBCo0Nkp82KCgpekAN105Y6CDKKYQCmcrFwljL0oB4ecCaKEUHMCxwrp3VtAmA8UGMHOkJ2/Ijq1JvpNSF5ckMQv+VXM+KOnFAV6idwPtu3vnsb2TcClMfAdG72m25ExHAANgclZJe7c4fMdPt/V+F2N/3PU+B0+38XuLnb/mLH7GfjcoqG78TkGPBifY2yrLUos9YJPYP2vYTqHiuWA3VsknpenvN1cYHDGFXAl+9kJ5RD6rGPo7BcnuvT+TejfOnRSjgCh4aV5pOEGJoJpbltyGZan8OLkA53U259CL1tSjjnuR+5CA8To/NS2FC1WahqS35okx8SNiu1RtupY4CcpF4c0V0mOtMZk9ugMmPUhvk0nKdFAPNL2qLc5yLImH+S6SqPb3y6LIXSHLNvU98nVMF6A0zUR7cGR4qMfOouzMKtvfPpTVRDq0Da/rjijYV3xXMmUTs/xS4vHP72ZPKl/iqL5m4qQmgI6vQ0X4Rw2KjbwaRKXlTTJZ3NmfNR4RUIxI8wBx5/jS6XEdf203AWyMauUJilOADTr7ePCOr56ryKqe63GEdH90I/3oaF92Zj3hGscNwNhbD7qoC9Bfo5dcRJS6uHD7TTGisi9nbheFnLJmlxfysRfCmquoeYyNf1kjQuj2mvPHLnxELhEQkaatfXFixt6bo0edU64Q1TXeSBNWD6aL7a8wmpfzEeDnkv0mnz8HL/h44PNacLkK6FR/yJfnApvniRafScEuQ6FwfUsRxR9MVt8ZtHliHC77RpLrlnSDV3AQebvJQIjNs5kztIxGkkA1GLfhOQvbFnE/C98cu6Xhsx8+xpVk0b6iae/mGda0KUFXZMDtOXfFCVyLMS2+XiQTsOxAxxX9udMYBmt5T1Da2tWZ/L7PIdKgwdWzRH65dD8GFYJzl4JfkCjyzFIw4Smy1d9+C0sLapMDWUV+wDrGtzkN0pQENf0Zvgt96GoSP7e5CWJR9V2yVkcrb52lr4jk/x+8u7/KePtMs2fMdNYfEvuxsvaRqDu5M8tXtvcvuNvaxT+xFOOVYbSaFS49WIUUye0jGRGXs1R7c1DxY3/UsmMsN8eeVay4EhEj07hj/aOCc34640ULEu0amFE36/Q1nSxsuSAMcCS7Eq/7acttJY5LN8Sb9CLxR7MQn0YHa7As18T25BdwjLnZFhxUhgboGuxyGP6/gps5wsh4VL3eIQfai83iQttWawKXSQM/cpZRRSTq5EILe5I0oU+C2hPGe1qzfD3rAW7a7uhLL2sOmDvVIJc0BlxSh4bJ63vow1vc+cqWlIniKwLAKZqK7w6nWxQBLFYQy503Ek627eT9D6NBRFqj4z79FqdVtvldgH3l4nO0LvWiNMH++VZ7ucruNK6B95Uu+j3fd5vqwPB+v0l7UHRmrlpM0w3d+2U3RzGD82HJnNwRY9ubmiHgvqbW7qNzpza3+u3VevCLZ/9IskvPyS6k93HF/ZU/hOx9X8HsJXfYmctXlVNtYPLd4p6cXCMjhU882YJ82MemO2U2pSNFw7UC5Ut7g9jMqq8o6zaC8iOxPEfj6vghA== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get Workflow By Id

+ + + + + +Get a single workflow by id. + +## Request + +

Path Parameters

+ +The workflow object + +
Schema
    creator object
    + +Workflow creator's identity. + +
    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. + +
    oneOf
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/get-workgroup.api.mdx b/docs/api/beta/get-workgroup.api.mdx new file mode 100644 index 000000000..4df76cb85 --- /dev/null +++ b/docs/api/beta/get-workgroup.api.mdx @@ -0,0 +1,87 @@ +--- +id: get-workgroup +sidebar_label: Get Governance Group by Id +hide_title: true +hide_table_of_contents: true +api: eJztW1tv2zgW/iuE9qEXxNc4TuyXhZukhQfpZRMHxSINUFqibbYyqSGlpN4g/32/Q0qyfEmbyRS7M4VfWkc6PPdz+B2avgt0IgxPpVbDKOgHU5F+1Obr1OgsCfaClE9t0L8K3ugbYRRXoWBv6JUNrveCSNjQyITWYuVoJi0bfBgyI9LMKMs421jFxgsmU8uGJ3UwT7jhc5EKQyLuAklcEp7O8ErhBf6SET4b8XsmjYB2qcnEXmDDmZjzoH8XpIuEqGxqpJoG9+saDU+YnrB0JjYUAVfxjc+TmJa3w17rqHm0fxjybre3HzVb+HQUNXuHB81mq9ML7q9JCZtoZYUlue1mk/5blTbYJiXUKhUqJWqeJLEMnacbXywtuds0RY+/iDAl3xiKSyq9QH2rhNlGtqrCeyJ7ZpmMIFOmi/oGI79+3XMP8TkZvWdESXyEyuaUCcOT03ej4ejflABLH5ZPEQQE7dESCk3zjFgPCu90J5xHQnSare5k3BHN1lHYbnb3eyTIJ8ljRUXSJjFfMFq1KusiSxJt0uAePKGMe+ZWnaT6sQZVYu9q5wGDjg66R+FBuxd2YdBRiIyb9Jpha7+17xKdR+9VvPCJ/mgDN0RvWnjyig3CUFi7maPrVfOHpVVerwldvniwDiF9LuZjYY515sskly5RN1Pk/F4w0WbOU/+o26lKaHU7KM+j7uF+s9lcd9+63u8yEkOKeIHIPeV0mq4ZVCelULcKFYalP0GxhxRZCvmOMhtpUUnSslO7RL2nV51trek4ligzdmqMNqzGzl2DFhGTPirUYIVN2VhHaM+kyw2PZVT/ef0rEimX8bGOHpHOr6UStanhkjQUTuUQCxk43sgIK9hcG8E8yyKxHN1q+sET9RZ7xSPY6+07zo0hDxoefgWv4SNK+1JJrGfFEvQshtA/JFYcCj7uNnvtzqTb4bx91GkdHox7E76/3+wd9Ho+5a3l02pHDrgxfLFZbAJdSIYs1iEi8h84BMkA3zsFnHAskamY2x/HwPF4hP9HsMvTlmbm+rJUfEv3sK+/Ov7AOocs5mqaued8uuYEVbu8oG08i2M+pkd5R/OM3xs5lVt7TbHLnJy+HlyejfDk/PRfl6cX+ES8NkDHQCFbI0pL7Upqpm+dxrkBt9wyK2K4Q0R19jLn+hIGcdRchVD6v+zCwpnIrQnP4hQrculbVlRZs4nR85VScnXzLWXPZV3U99iYnqFZhDM25hYLtC/3l9SVk7R2lnvyJZuh2IV5UWeDKJJkJI8ZqhFMsX4BRoxHEZWuZzDJUMpQRqYznaVM6VSG672/dOVqNJZt5KwaFCoOaP7jPBmEaQblnJnVKiyzJVcxjw909p5b1W5UcZpz6UKlHD0RlPECbjQGHmZj2Ea4MW9HFC6LxqMKurJjVbuja3dvvTK+QaKf8cw+ou4+xGg/NWda+eJG5MWHNNB5N3LRKMKUdyS8JLPd4pyqDFdR+GwiRRztandXu7vafWTtrr88zweyKvRpbUKfS8Uz+Ne4zXMD+hiXPUqzgsjBmzyQewwOySHSbx9HKOyvQhG9+JbQPPoT8ZHfyreMlEU8/PMxwY8yWCuxIAWdH70FE3QiEfWd3kuNnaO8q/Y3pb3WZiyRoGoLRETXNGyhM8bhMpMpRZpwu8ciLax6lrIZR3/kfsZwHZCkqqiWaKDjHZLcIcndbrTbjX6d3WiHJHe1u6vdv2ftfhdJllq5aslxks3mc24WPtPy92QtZyBgxVcDrCw5F6p1tELMWImxglXkEIzbrXFrchiKTsQ7UXe/N2mH3TY/OGwdtsad9mFQ3euvlnVcFtlqTVXi7ePoXAwQdwMclykkl021jlaP/+BeIybU1qj1lLgZPodLr0vs2O5tYseR1uwtV4sCIdkVDKmWPqKeBto50ZqCFgScTdEXFUOrktCLUknOBbgYJA2L5Vy64iUrwNcsaoNJClN8oRRJVkqRKowzaOg6QawJNWskloSRYkKYDxwcgp2iO/9EdJqH6E8heXZOFp+Rxez0WygEFXqJ3A+2ne8OobyhHnHhA/zAQa+fdrhCAmAg8D2rxJ07fL7D57s9frfH/xp7/A6f72p3V7t/z9r9A/g8R0MP43MQPBqfg7beZCWWek3J9T+H6a5Ucg1cejMdhplxx80FBocTrMBDmS6ckEtL9ydcKg8A2qkyZaT6t8XtgD7dIAiu6RrTXCAF83te1HvotlU/aJSktnEno/uABBCS9EZkJgbRLE0T22807hBbxPS+zhNZL+7vKH1bD/W8MYZDt/QqulTg65II3C0xL6DuomEkJbzvjo65j42zn1IbMXLnyN/lTLdeKOgLnaEfOjZ7dHspTz73GCommDye2fyODPlywz7YdWni+z9vi2f0gC3b3PddaaBn0HTNRDLhepkPFwTTvfSNrFhuPTTatTcvShFZm70S3GCG8N92PP/t4+gFmxI4dc0hs4SLhaRpAuX1ASnimt+gOPmnRW4/QjZNZ07xwcp3K1RsbBLDYPZJXQjBroa5E95hVzhHG3cupUXCdQ5adf28iE4kbkRMG2Z96UlKPCR8Ax5q8JV1L9zm6KYIqfx9Hbqm9EnV2Ik0xd0boslNdEMhu0oKu3jFrqcq8Y+CW81zqzlu9sWaFt61V6G/qxOi4okFj63z1pOFe361Cj8aufCEuK7rQJ7I9Vj9RiwsovZkPVb41Yjfqh6f1MeZxM67uoz5hsUsNs44YkMWzrS24p+MUepQGVxNM1TRk9W6JaE1VxG1drOiUs2LrMkacKTT7wyFoXwy8THt4w7GaCA8FfmS/Owii5r/jCk7Yp9XbHaPr7DdEmWkQ/tknUlgjQTWfA+wuf5+N6PEottpsMH1AZ8Ax8v4u06QK1rpe57X1q7u2DfcGtoaQqjquNik7//oLxtc/om5F0Rd0qANEwwvvyPE3yznRVvairOKA4R1D27qG2vspGt+8/qWB1i0u/7V7CWLB8tzFrrf97O79AOd5K/Td/9PHW/XaX7FTpMDY0o3JzafIKpJ/irHa5vnfnQwPRP4F29drToMjgnHzWwOxVQZJTFPKatdVYczKdyJQSJ4SthvjzJLz10lYrin8sdc6BhNgcTp2NoCk/KxjOmOPp1pF5K5KxgPLCmu9LfN3NhCssIZJlBRZx8xxKkQYaEBjm5l4N0XnU9yF4jMBwosOymCDdA1n2eK7tlD7WzOOFLqBxkRSRtmvnHl95S9CdpBv3JVUcWUamRC3Y0yZm7fT+gwGnNuJfA/kIW42/wkGq6nKOY/A1kaci5il5lEtwrbf8Qb2VabidhdOUfXBQATFQlvh6MNjmCmLOzCqK7NtJEvsg2iBRMaj3z67Ndb9WbNjQt4nmibYuitMH8j0o2b7/RLmGG0nol3y2P4J/yeJt84CPE3EjrXInUyP4H4Se8qWE56WNCXEf2MYwaN6d3dHR170OxzT48x7tNMfXW9HGvcOAiP0mdMkRPU+PpF+6oJz8/zn+68YN/9Lc5WxYtjO7VYTuwBPn4VNOhDc4zD0N2dxDi9/At/VlNZsvFtxsoc/OaUAs8f2HrzD/ABmst/AZ8ijlE= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 Governance Group by Id' (get-workgroup)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get Governance Group by Id

+ + + + + +This API returns a Governance Groups by its ID. + +## Request + +

Path Parameters

+ +A Governance Group + +
Schema
    owner object
    + +Owner's identity. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/governance-groups.tag.mdx b/docs/api/beta/governance-groups.tag.mdx new file mode 100644 index 000000000..3afb26408 --- /dev/null +++ b/docs/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/docs/api/beta/iai-access-request-recommendations.tag.mdx b/docs/api/beta/iai-access-request-recommendations.tag.mdx new file mode 100644 index 000000000..18d957fc2 --- /dev/null +++ b/docs/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/docs/api/beta/iai-common-access.tag.mdx b/docs/api/beta/iai-common-access.tag.mdx new file mode 100644 index 000000000..dbbfe87e0 --- /dev/null +++ b/docs/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/docs/api/beta/iai-message-catalogs.tag.mdx b/docs/api/beta/iai-message-catalogs.tag.mdx new file mode 100644 index 000000000..dc60ab553 --- /dev/null +++ b/docs/api/beta/iai-message-catalogs.tag.mdx @@ -0,0 +1,16 @@ +--- +id: iai-message-catalogs +title: "IAI Message Catalogs" +description: "IAI Message Catalogs" +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/docs/api/beta/iai-outliers.tag.mdx b/docs/api/beta/iai-outliers.tag.mdx new file mode 100644 index 000000000..8718a2441 --- /dev/null +++ b/docs/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/docs/api/beta/iai-peer-group-strategies.tag.mdx b/docs/api/beta/iai-peer-group-strategies.tag.mdx new file mode 100644 index 000000000..ec04b18af --- /dev/null +++ b/docs/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/docs/api/beta/iai-recommendations.tag.mdx b/docs/api/beta/iai-recommendations.tag.mdx new file mode 100644 index 000000000..7149c8f93 --- /dev/null +++ b/docs/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/docs/api/beta/iai-role-mining.tag.mdx b/docs/api/beta/iai-role-mining.tag.mdx new file mode 100644 index 000000000..d66d5aae8 --- /dev/null +++ b/docs/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/docs/api/beta/identities.tag.mdx b/docs/api/beta/identities.tag.mdx new file mode 100644 index 000000000..46b372d5e --- /dev/null +++ b/docs/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/docs/api/beta/identity-attributes.tag.mdx b/docs/api/beta/identity-attributes.tag.mdx new file mode 100644 index 000000000..9f9308762 --- /dev/null +++ b/docs/api/beta/identity-attributes.tag.mdx @@ -0,0 +1,16 @@ +--- +id: identity-attributes +title: "Identity Attributes" +description: "Identity Attributes" +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/docs/api/beta/identity-history.tag.mdx b/docs/api/beta/identity-history.tag.mdx new file mode 100644 index 000000000..9c3bd4af0 --- /dev/null +++ b/docs/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/docs/api/beta/identity-profiles.tag.mdx b/docs/api/beta/identity-profiles.tag.mdx new file mode 100644 index 000000000..55d065643 --- /dev/null +++ b/docs/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/docs/api/beta/identitynow-beta-api.info.mdx b/docs/api/beta/identitynow-beta-api.info.mdx new file mode 100644 index 000000000..722a62f8a --- /dev/null +++ b/docs/api/beta/identitynow-beta-api.info.mdx @@ -0,0 +1,48 @@ +--- +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 SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; +import Export from "@theme/ApiExplorer/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) generated using either a Personal Access token or through the Authorization Code flow. +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
OAuth Flow (clientCredentials):

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

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

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

Authorization URL: https://tenant.login.sailpoint.com/oauth/authorize

Scopes:
  • sp:scopes:default: default scope
  • sp:scopes:all: access to all scopes
 + +OAuth2 Bearer token (JWT) generated using client credentials flow. +See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information. +- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-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
OAuth Flow (clientCredentials):

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

Scopes:
  • sp:scopes:default: default scope

Contact

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

License

MIT
\ No newline at end of file diff --git a/docs/api/beta/ignore-identity-outliers.api.mdx b/docs/api/beta/ignore-identity-outliers.api.mdx new file mode 100644 index 000000000..57b88e893 --- /dev/null +++ b/docs/api/beta/ignore-identity-outliers.api.mdx @@ -0,0 +1,88 @@ +--- +id: ignore-identity-outliers +sidebar_label: IAI Identity Outliers Ignore +hide_title: true +hide_table_of_contents: true +api: eJztW1tv2zgW/iuE96EXRHbipM0kLwsnTRcZpJNsLuhDGqC0RNtsJVJLSmk9Qf/7fueQkm9J2+kUM9PCKZBG1OHhufM7NH3XsaVystLWHGed/Y4eG+vUcaZMpavpaV3lWjnf2ehUcuw7+9ed48GxaIdvNjqZ8qnTJTHA9MuJ9mJwdiycSpW+VV5IkWtfCTsSDdPjF15oI6qJAtX/auWrDZFOpBmDmgZt5C4qK4ZKBImyJHGqqp3RZgye/c0doUfC12mqvB/VefeNOQcz7WjJuppYp39nrYRPoSGt/0hLvd8wTwpp5FgVEGm/LjNZqUdQMspzYLNpZ/+OH8ERdqlcrTY6qTUVJtArWZa5TnmF3jtPut91fDpRhaS/qmmpYA3pnJyCra5U4efGfeWgRufTsvVOoqV0tJQgU8EKwQRi5GzRWIetSkw2OuqjLMpckXPkMN3qb2dqtPPsOd6MJ3r3l7137/PNrX7n5hN+SEVfWuMVywMz0n+LUvxmRVRUJHBURmpG10T7iA/Sz9leDOuKXkNEeN/MpgcHBr+pbOb0IEGXDLCzubkqwSE0xPQj56yDDOctg9GCFEO4iVbU5lbmOut2/riH7PCdSitMLB3lQaWDXTJVSZ0f2kytem3ZaS+1UcnYSU0SKhY5xUQBjrc6o3AtyHmBJXmXVGC67rzzyBLdLXEgM3Ee9TuMysBMlZPpe/CiHP2SQFdGY75opiCaxAhCPbCs2lVy+Hxzr78zer4jZf+Xna3dZ8O9kdze3tx7trdHqxfwM5LF3xPai0v/RxnldCpym8Ijv8MgTknYngXgxe/Jhgd8wDy+wv6X0CvQtmpGeUWlPqK2SHFweCZ2dkWOGlPzuBwvGcEkVxcYMXWeyyENUcJD88D41OmxNveJokxdUOK9OHo5uDq5xMj50X+vji7wF/FaqY8D02QUREUsTOwHljgqwHmlcphDZV3xNHJ9CoWk8fOEOjz5qYcxEVsjWecVZsTV75kxzzpUkvlU4rz5WInHuqu6G8hajBWySidiKD0m2JC6TwfI+bJKTqIln4qJkplyT7pikGWalJS5QDaCKeZPKf1lls1yf1QjlSGMRoVG0TC20qla9MXMlIveQBLoiilO5p1CyQHJvxwng7SqIRyrOZ+FbbREEZuKl0XLLUp3uVwFp6aSKbSQeT6FGR02vooLoq58Wwg12R47TkPXViyqyI1aXO5eBWFeVJbfpbL2X5F3ZznKT8KqtS9uVUw+3kJCNWJvNG6KFQkvSW2eHKladzWJL0Za5dk6d9e5u87dr8zd5ZfnEfXEtwx9tlahz5Vp0CuUWIE+LcJahLjBkRsCBokQ6dfXl0js98oQvfpYEor9jvgobOUrwg9af4TxIcGP1lkLviAB2Y5BgxEqkcr2We6ZxGyoYKrt1dVeWjfUCFBzD0RE1XRiamshYTJXm9A2+A2RWeXNo0pMJOqjZAQbKiCtarKktNpUayS5RpLr3Wi9G/08u9EaSa5zd527P2bufhZJtlJxtkSc5OuikG4aIi2+J22lAEF7/ibalGNXLaMVYiZajNVZRA6dYX9ruDXaTdVOJney59t7o376vC+f7W7tbg13+rud+b3+epbHbZIt5tScv4Mf2cQAcbfAcbVBcPnK2mzx+A/mdWpEZY1KT4ubYXOY9KbFjv29Vex4aa14Jc20QUh+AUOamY2opoG2IFrX0IJAijHqohEoVRpyUSjpQoGLQ9CIXBeak5e0AF83TQajCqqERFk+CcVzmteQkCtBbgk1WwSWhpJqRJgPHBjBjlGdvyM6jS76U0henJPGJ6SxOPqYKkWJ3iL3Z/ed7x5DeEc14iI4+IGD3tDtSIMAQEMQalaLO9f4fI3P13v8eo//Ofb4NT5f5+46d3/M3P0D+DyioYfxOQi+Gp+DtrspWiz1koLrL4fpnCpRAg5vYdO0dnzc3GBwxhUIJRKotJ6LiKwmeOo11zF64YoD3gTMH6SpXQ6iSVWVfr/Xu4OT4JxPXVnqbnNFwtgP3dQWvSEsc0/RodsBIcGIgG+mhAW6bFanKXJDmWPmwcisCMUojM0Hwp/lbGTB3pvaGoWN2WwIRHmMIh6GiCVaiEeeqbscNSv6Qa8rl3/687oERg/ocp/5Prsa6AUkXVKRVLghd8HbYMT+uoI8h6FGDWpy8PXNPM0FYfIg4QrlbJ+hPq6/ItApkfXFgZIODUP4aOPxr68vn4gxIVGuBLUnEKw0tQ7IpTOEEVe6QXPMT5N483G2Hk9YucHCBymUWWKUwyjijblQSlw3l5Z+wxZwjprNZqdJissEzbp53HgwU7cqp92xO7M2BafOTA9W7MmFeU94J+SWQRv8WfBo941JxAtNBUrTjk40UcVw9em6bPSSc3p9qxD/arglgVvC3PyTJSmCaa/TcDEnRXoTC5l7ttY3Lx74JXP8qL/CCHFdloEsEeVY/Pgrbbz2zXIs8EuI36Icb8zricY2uzhNhKomPHbJPBPHIp1Y69W/haDQoVS5HtfItG8W6wMtmnBGJP3NOZGSsGSiE4BGlu8EiWFCMMkhbdqMWSzgnMlC2r5lz6IuvEVLnYm3Czrz8DX2VqLMbOq/WWZaMKEFk1AnfJQ/bF0UWMht0oHrQAiAw5n/uRJEQedqY+B1b+Vn9j2eQ9sH3fZjLr7cDw/7syIY/wp3Aom6pUGpJszdfiCIZxF50f61YKzmtGDZgqvy5hbb5pLdgrztaRVtpf80fUnjwexQ5dTk0+9dpR+oJP+cuvs3Vbx1pfkZK01EwXQ4eT67Ynz0lRd30YwjTlne2GfMZ8dBBIOrp4N0fD1R+I234R4xIXX0QdzZMfyZZ1TmsqJ04HKQTrTic4VSyYqA5QaFpC04hUtnqW6ge2RGYwca5LsH4JVDnYMfn3w3K0vOtIBaKSDo2dfc3NBa4e53V7xGq2dS+JPaPLq7gXfvbOz3LuDSM4oI8aKJEqC1oqgN3ZOG2HUhJGLxC6GUaZ/WoeKh6zOqsYVlzNjOatKfYpRU6HLD4wp/OqIja3TDcxHzhbUQMD6eV8P05EVqAaiXahU5VzmHNNEt9gRf4o0wTSYqL6nRRLkGclNzK7w6vlzhCGbGQy809NaNe3GS7xEtmFDvFcJnu7vV3Uy4F8E49W1ojeeY0xcBmvBpvxEgjps+biEW72bH9T/6VwTiBkidS6+kwziyTh26rdDVXnfs7GsTsa9FDk+o88XLuzs6rKFG7xMNQzs6Cbi+mfVw3DdhAh/acGP1XtFhQfyUILmc8mYeTwVWP/6g1jLMCAdBn6W9mWvOz07pSKwzjF9/KMI5g5MfMEi/9ztv8A8PtgzhSt+RoPG7TnNqB5rAl37+DxXVrcU= +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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

arrayrequired
  • Array [
    • + +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/import-form-definitions.api.mdx b/docs/api/beta/import-form-definitions.api.mdx new file mode 100644 index 000000000..394840c00 --- /dev/null +++ b/docs/api/beta/import-form-definitions.api.mdx @@ -0,0 +1,127 @@ +--- +id: import-form-definitions +sidebar_label: Import form definitions from export. +hide_title: true +hide_table_of_contents: true +api: eJztPW1z2zbSfwWj50ObGVOWZMmy/eVGsZVGd7LlWnJ9z9mZFCIhiQ1F6vgSR0/G//3ZXYAkSFESncTX9MJ2pqVIYHex2BdgsQt/roV8HtTO7mvnURB6S/bG85dB7d1BzVsJn4e25w6s2lnNXq48P8SPF2JmuzZ+CGoHNV/8OxJB+Nqz1rWzzzVLBKZvr/ArdMK3zA5YuBBMNWQrvnY8brHQYxImmwFQZmWgmp4bCjdEiHy1cmyTCDn8I0Cwn2uBuRBLjk/heiUAEfd9voZ+diiA+PS9N/1DmCF8WPk4nNAW9FW9hqfse9vaHMOtawPhbB7ZFrMtIMqerW13TmPKUV4HROITX64cxN1Q/xgF/4n/gQ6K0iD0ASr8/mTMPcPlS3yZZffgovZ0UJOf8lRewVvmzfZTdbmm73sQIzhElkGSx/kmi+engGnfC7HqDfZQcKG1BEK8R1f4mxMmIRQRNsIOE/jMPnInEvUHYF//ajKY/C/LfB7QlIYoPMKNlqgIcUNUgnQIydstdGNvA+nQ2m5FpY8UP+EQdwifkjtb+PocA8OJLd9c7FDQng42dIiarLj5gc/x/dwOF9G0bnrLw4Dbzsqz3fAwWBlIWnBoeUtu0yTboSP0ScGxRoGwXhcYjKENFgKGKHEGLAq2qRq7WwhXfASOcBasA9B7aCwC+IUtD6hP73oAZoeDsQBORSGanARUIPyPtinwnS9MzweDtOAhfVfgwG6Zke8D5521IsQO67qRKSuLtzRaTRjZg3s3uvnHm+HojmUb3Hn+h5njPT6449HtzXk/93nsRb4pNFmNwcAr2SErtNrnvUL7lRR9tUgns6hP+V9HtiVLains2Cfp2NNGCGngrqJwuxKQnNrYJiDvafuC3KYJMh0KJemG7QYhd0GS5Vh2CGi52QCgqZYQ9heZg4Md+qK5PMSfseLjyc3g6he2pdk4Rhfrh2yeVQr1roRKlERWJPoOnwpni5/ex2J61dzDxCEhKOWjCd4u99xjqHSOYNYaoNsmC0zucF8ynf1s18FkAVumwj9gkpgDZoEMHjARmvVX0nSa3GVTAeu7AIQccOrWFkcM5hneMljaWcRH7jDHm9vmcxYCL6K5uando8JvEsVVWtx3xBK0J9iuyC6se4ElxAmhWj9TT99ofTVtfSHVVIgmWzW0nzZIXdqk/88Jy32diE8hfBn98suwv/HNm4PMyX69m36vqG8PbN2D+3ZwASuq/Pe3tgWMeHCv346uNoBfLzwXYPcve4Nh/lsfhMABU9If9s83KB7D4E2g+aI32QB6ATKP/c4ng9EGOWPoBhx6cM9Hw9vLq3H++7nnREva3cTGCQcOPyV38EExAh7liOGBBgf/p4Gglyei4QHpo99EDDwptFlbp1DsmnKNRJx70M+ZPaedlxUr6rUun3mTUzunHpr/SdB/js0gaPGK+yHiqW3TYUWOhFZkjSv5KiNftF36IAoW1xNhLlzYSjsMPmcth5VOz25h+Yeg1QvovG1xuVvfwDMWZPU08n5LmjOyeRnk9581cNLk1G76v94ObvpgjN69hMXfICsAml/IuyhcJbxK4kiUYzmPPWUBj8/zXjT1wcqHcwe2LUvPsmfr1A/zOBZj2iubXEmAnlr4HGQLlt2PML78LieL+EasfBFgV7n+1P15fSPQ4keOGFEcyfN3DOIGmg1xFNyJW2cWfb2rC7avcc+1HtzRzd52I1+zwAAYfo1uskZTvt27OvzmVOkCcaNzDgQCObljiUGfd6wpAtqmFTt0Wv8IKRk46HQDDus5lIqATJaw6mwQgog4Dq7zBIgK7b59MROwS5Z7aa4tatnP07V6wkG9Yp4ff49XMtgi1M3SKwzUXF3fTrIcGyfk09IL7O6wf9m/2toqVjotqINA0Y/KjtkJj1+WCe18S+L0CU+/43TL+SqwrfSeGcxWm+akF6ryLrIOtPZymlVg1s2HDuWU4WSapliFdfbWe8RIy8GzkKpRHjy4Gt4cSp6dfHrlJsJBoRmYCMANNilQ1uDL/JYKUzzFYe295ujcWwJoO/DcQovU/5WVaN7/d8SdgLHJAoNJSRMW06DeKd1TPOIu7PK5PxcUGWcCYdjhGpDCKqQE0isv/BZ4wSSkmM9HZTBDkxAc4C7EgeA+xeN0YfTgtWCPC0EWxQ7Rp0hA2Cpm+dVo8r4cHcCBmBS0JmW6DFzTiUAcnkk6KASQKyS7ubuO9YhoDhTR5SgAomMicFlZSryWq3AtcZTrgKIh+4zvyrQfgzyEwR0uCtj5QpgfgmSWuAoEwP+wjVw5cNejj0E0VV/j2B4qvHxVlxxO2Irc5oEwYE0RADkf46kuRyGMKCUS+FaqU9+19gxKQItvP6Ry1OEkKQI1/9X/FX7QTvB8hE+kDPAwuFK/6KF/qX7Rw/hO/aKHfvwLHrLe79cyjq+yeJXFqyxeZfFe3OLpyzZ9B0QSVryDyeD4LW5Hq9z0yKC4kQziKyWQ8W47ILbwEAPhcrgxkPfDwXiyExJtyPLQXEZ7fmSkYmmiLgX7iQQirds3Sdu64apv2XokANWavBzInXu0HXxADjy4r0ejYb93taXNa89zBHc3D2oOahqjyb1lt20HNfVBwf/Kk53/pExUQlFaKHQTkHxObEBBnhHHIydwXWimkg7ZrWLfnYODFwV7Q+rwAtG/zCj3xP9uKLyDRy+zGWY+bI/0qAY7QnR9asFWvmdFJvAFpoqnYbrNIJ2EWGxZJyoeJNugIEBHkgTwIJLfCWSQGV8wgXPE1XkXNABRkgHKqeOZH+oUbNdWdf0E+VvbEoxd2AGfAi+YFmJGVXs7uivqNF54j4z13aI+F4Nx7/WwEJfCshVd/2pbT4lqG0oVty7qeCNP8B/c0TVG93vDokajlYykwoBvX18OJu8v++Nx75dCgONourTDSxEEIJ1JB/C6gzeD8x6dIGztBR7XnqmsOjxwmLy/6L/p3Q4n73/rDW+L0YnwQsx45ISkL3lzYc9dz5dKuIr8lRdI9VPWHeccbftbSkVRE4Nm/Uo9KMZhMFaxB5tneJC+0MdIR2A58rNOQeHe6xIqufxx5DJz/pmav8zxZ9YQ9vypHfrcX7MlX8XbNXTaZFqhSySTZdlU90Up7Hpt071kzbCljWIYZ4/kpbbQ0mOjn8DMYqdcYodpwjyg2b4RS++j0A73S0CXDQHyloSDk2azcXzcOj0+Omoenxx30YUWHOW+oGeVDNjjW/vKpb7M+V5CS4kTPu1ED0WN8rgKkj3O5Yc4Wo6ZNkU5kOyRBywGos96q9E6Mhpdo9matBpnzfZZp1vvttsnx/+qyZNFHmLsHPoZob0Ue0LnihqkmI4T7SKSL9WXmGaHw2plJ+EJrJejPCbqxfOGbkSwgkmVJzfCmRXpVuY0Atvgclb4gUrbUs3xMHYufH208Ookv2JV/Z6ecGSZk/QYYjOlRHXqOQ4Dbjiwz4cdfpJRWJNpmrVGR1htYU0Nq8FPjXbTOjW41TCN1uxYwAQIs815yu83o5tLtM2DqwF5YTxYSZLqnwNvL3FZOcsmkCdZ4YoqLUebaDhqt7vWiTBbx41Wu9Ph0+NZU5y0Gye8MWs0Ow09Ffk+gaIlzRKUTqNx0jltm4bFTdNot047xslMCBzT7LjR7naPGm2AtLX/aVd0O7zbMcxmFzgxm5oGb1ncmHZmHJjAT7rtI0p00HJCU2qSPW2cSpNkB+Yc1Nfk8H1tCl9MfZoLd6/E4KhxfNrqtrqn3eOjRreBdGeyy7QEptT1xkN9Y/tgRlTiS60kisYGCpUERUkxtRnCpPqG7Rhl+QNOqRKj05N2s9NutE5Ou52j090I0PRthT/kKfh3TzHb9EyP+3zWhEpHUAkA99mz/CRAEh8Y65lW+mGnjPJrMbRUsNSmujbmtAd9p21C77O7w3gtnY4rWUzUWsdNUKwTVIaT0063QQN8p3k5NO4to9kwGu1J8/Ss1T1rtOvtDpn21LGoVk2jeYwuoN05a7TqzW7rX5JhsuCITMPZjDuBoDfS+tIqCroXJa2EkQ/7UwzgUJUARTRhLbjhmeLCA1maRAboubVIW5Z3wvc9X69NembNkiVgxekUtduSp5drl1ubXUhwaa5YiayvUHwqXDZm8p+xzVN+JdiXg8eSAMXYkWR0VcNV1XAVBp6qGq7vtM6lquGqariqGq6qhquq4apquKoarqqG60essdGMU1XDVdVwVTVcVQ1Xrarhqmq4cgJR1XBVNVwFc1XVcH2Z36pquKqKhqqioapo+MtVNFQ1XJXFqyxeZfF+HItX1XD9SOU6VQ1XJRRVDVdVw1XVylAY8L+sVqaq4ark8nuUy6qGq6rhqmq4qhquv34NVy59J5chjzmY7sz7UUsHBjR2ePnIfTTWPyof7uLhPz3Jsr92o1Hg4lxGhSYyDKT/3R3PpEzob1jRItl57lli34gu0pZogeSyYvdEKh2lwhG1DontEubKWty3KDdcjjYuAWIKtgwb7XXXsJvhTsGOaUjvY3wqg5zJtxlbJ1zjdrzHgqlumE9KTyPfhl3sNqTyK1t4WAoJS53AxiWhjCrgJg7XpGScJYloheOj/Qxlas1VijZFkSae+aSjT2HMDG6GEXcYNoxjinIKFOczRNAyTsZJqNEeapTgl7PrPAT/BO3kw+GjmOb18zKWM7ToVPmVk9ViQ33czlv6tC+yyAe6gPaBtVeP45YXms42y+gsj8KF59v/J1ejleZWmltp7p+uuUdlNDcKhI/htaUdBBROq5S3Ut5Kef9s5W2dFrDX89gST7/VCvl5f3dSV5QyGlJOM7K6nU/xjL/F+HRpkJxmJn72qdw9J5kDTBHGVOOx8LHksl9CMioDUhmQP9eAZNU+N7xE0fN/YzbuxaJ8aWRmmKem1TgSs5OGOObtVkdMj6fN5tSaThudrmlN2/uGrRuaLx88WajOls28HWttILVWzlm1qKhswo9rE76LRQVFiUGa8C4ILH+6BQXF9D2sR4PdOx6YBqszijyfwSoDB0/X4Xwy0EXPQdiUsTKmnrWO0dCf0c6f4QyK/0w2m/nekolP+FEe6YSYuRVfIiQvI9qFLr35h9AidUsRLjy8hQeklVSM41Bqh1SlruE+lNe41JAJaJckysjHMsFFGK6Cs8PDz0AOd8OnOl/ZdVvdm+F6jzT3U7AiGwONRQwFERuQUZAI6kStb9PBKE0WAdfO3HDmYoHaCTkuXFh7kc8kmAO0Marcil5TJqW7/img1nWKxm6MD8Z16ztPXz8WCWjLWIrYtxMbtGdAaW6IOIR3qcyO0S9I7BuSm/oKjEO1NpCNsFmLvRbcB48Ueh+Ey37++93kFQM5w1w/YakbIJL6omsQEapzSw4zsRPllvheNJd7514m6kULXby0AsuSx0Kw+/julSswmzf98YRYip3wtfR7736OZ8cSH4WD/qGechIFz7bcQ+DQIc/0e0WJLkvPx/J2aUAwzebBNdiF7cuizYDaqCHKU+P7VTwuro3rS4n4nxiaIaEZBC14laNCsvbedKj4z4RlAILAVF7k1hcjl/AMDZ4x90FwDISap0HeBUB0ZGOVZjxrX0xHBh5ZrywdD+7dwjYXLNuNScvFgoUXORYbMHPheYH4G2MoOqgG93j7k/hish4RqUEaYbQaGkmGRGnYRhQIom8IiuFKYeJTvLOG/LzHwHpaUiV/p5kFnf+d8td/z4yZXt/DugFbWp4ZfDHNiNBAhIa0AYGiXy72ULDQXcIYyA5IAThP558sgSJUs3sSVqFVJ/CH1AddgwmkysrF1Zn8cZYaOPXE6AO2TtqAGcZlZJL2AL+ZgoVuN8OseBWQ5+AmvZjA5ub4JumN+9JR9Pc2XhxxL13Yj1xn/a2t9BZL8v3Y3T/J4lWW5r/R0qjFO26Qb+SSGFe/fe0mg/xFtuVuZIk3KsndfLnkmsLb8/ZdYFsKd6lLbMtB2riE9jkcUJj/IxfWfvWFRdtvrC052sIbYDcvfM1emiI3ZZmK58w1HHvu0fgG98WmRRjJjbHWF98Yq+fjP+/e2IJEyc1ERy3PcTNNcfNy2e1ZZ9nrZbe1SxK/0hBAktzVQGzoovSAlu4YX6s93oaY3waUPxfQVYY0uviyjvTUUAe0cnhI4kvF+wuqnPfFCsaJ+8UD9Ebekrz3yveQYULVfM2JF75Uo6lNNZBskmLm5GTlZhR9Af4OInlHBN5It+DuHFTuTjDhmiAbGHoDk47f/gD7T4SOwZpfozNgF7GDgI3achm5gA0VLloy0Mp9XsSyAzOSUw0i4YqYF7JoLekVe350TzgECgIKfxmMZmN59aPmLPbgAl8RH/BwadyTeGY8kBvhKD08yG3198EGD2UshLOiwCCQhWmEKYbLwWQDIgBzpQLWPX9+qDoFh9hWTyqsHdWb9YZBIQZ4j2GZJXc14CWDQ7kL5pSpxj3/IQicDBhGMgYhYz73tXzMpxZf3oup+QuMD0Gjz58xVxrDIE/4Gvypj27oXRrhwF8AfCG4ha4uiUydy8C1QRYiNSkbQWwMvMgePbrKYmdbPYR1PaIiM4x34bCWtFOo+fwRjSP896z2AP+SyVOm9LN8j8bbnUcyXinhxvuOomW3esBhPj39P39U6/c= +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +
  • Array [
    • object object
    owner object
    usedBy object[]
    + +List of objects using the form definition. Whenever a system uses a form, the API reaches out to the form service to record that the system is currently using it. + +
  • Array [
  • ]
    • formInput object[]
    + +List of form inputs required to create a form-instance object. + +
  • Array [
  • ]
    • formElements object[]
    + +List of nested form elements. + +
  • Array [
    • config object
    + +Config object. + +
  • ]
    • formConditions object[]
    + +Conditional logic that can dynamically modify the form as the recipient is interacting with it. + +
  • Array [
    • rules object[]
    + +List of rules. + +
  • Array [
  • ]
    • effects object[]
    + +List of effects. + +
  • Array [
    • config object
    + +Arbitrary map containing a configuration based on the EffectType. + +
  • ]
  • ]
  • ]
+ +Returns statuses of those form definition objects imported + +
Schema
    errors object[]
  • Array [
    • detail object
  • ]
    • importedObjects object[]
  • Array [
    • object object
    owner object
    usedBy object[]
    + +List of objects using the form definition. Whenever a system uses a form, the API reaches out to the form service to record that the system is currently using it. + +
  • Array [
  • ]
    • formInput object[]
    + +List of form inputs required to create a form-instance object. + +
  • Array [
  • ]
    • formElements object[]
    + +List of nested form elements. + +
  • Array [
    • config object
    + +Config object. + +
  • ]
    • formConditions object[]
    + +Conditional logic that can dynamically modify the form as the recipient is interacting with it. + +
  • Array [
    • rules object[]
    + +List of rules. + +
  • Array [
  • ]
    • effects object[]
    + +List of effects. + +
  • Array [
    • config object
    + +Arbitrary map containing a configuration based on the EffectType. + +
  • ]
  • ]
  • ]
    • infos object[]
  • Array [
    • detail object
  • ]
    • warnings object[]
  • Array [
    • detail object
  • ]
+ +An error with the request occurred + +
Schema
    messages object[]
  • Array [
  • ]
+ +An error with the authorization occurred + +
Schema
    messages object[]
  • Array [
  • ]
+ +An error with the user permissions occurred + +
Schema
    messages object[]
  • Array [
  • ]
+ +Too many requests + +
Schema
    messages object[]
  • Array [
  • ]
+ +An internal server error occurred + +
Schema
    messages object[]
  • Array [
  • ]
\ No newline at end of file diff --git a/docs/api/beta/import-identity-profiles.api.mdx b/docs/api/beta/import-identity-profiles.api.mdx new file mode 100644 index 000000000..63ddfa7ec --- /dev/null +++ b/docs/api/beta/import-identity-profiles.api.mdx @@ -0,0 +1,135 @@ +--- +id: import-identity-profiles +sidebar_label: Import Identity Profiles +hide_title: true +hide_table_of_contents: true +api: eJztHNlyIkfyVyp6H+xx0AgQOl82EEIytgQsoFF4ZYVc3V1AeZputg9psEL/vpl19I2O0di74yAcMUbVVVmZWXnX8Wj4KxbQiPte3zGODb5c+UHUd5gX8Wg9CvwZd1lo1AyHhXbAV9gRuk0XPCSyb0hWAbvnfhy6a8I+YxNzCFcQ4KMEUQcYEZ2HxvGNocGTBP5tzQjYf2IWRie+szaOHwvzjSqmKEHBKRAKDxiQEgUxqxm270XQDSHS1crltiB15/cQwT4aob1gS4q/ovWKwUQ0COga4PCILcNMu2/9zuyoxIciDil2yQBgAHA44kyAu2dByOXcCjIHBOcsgJ7sM12uXGhrFqf5KEcRP1BwySzwlyRaMBLRYM4iErLgntusbjzVjJC5s5dRn0AvYrm+/YnMAK5cTObsFCiol0iQYBPwYRRwb17mzAZ434XkdDokOLhOZCcCsmTHQQCshPX1Pfhn5Ycht4CfDzxaCDr7p73BtD/95W548lOvO73rDgdn/fNa2j4aD8/6F70aGV/hv5Ph1bgL/5+OO4PJ2XB8WSPUc+DP/vl5b3w3uTqZdMf90bQ/HGieIk5CiJgXL1FOO91ubzLRkOGDahj3/nXVm2gcsH06BZC/DLp3ctrMl6vpj3fDMf7sdi5Hnf754A6ATXtjaEG07k57Z/1BH/GAlvPhx9540BkAiPPx8GoETdWEZz+k+F30z3rdX7oXvbvJtDPFlsFw2j/rdzsI/27auxxdyPZRZzK5Ho5P70bDi373l2yLoEPPPro6ge93aq5+b5LOPx6KOZHd8L9J7/wS+ohf4499IOC0N/n5rj+Y9s7HHUXeZJiZULIKfkw7CC5ZKPG7vErQDOj9fHYxvEZzkSiLhgOCz513yWX/tJ7VQqNlHzUPG4e7e07zqEkP9xvNPad12N7bs9pWa7dFcUqPLt+nDA4PVy5dEwSUn/7HMenYEb9n5BQsmh35wdp4ginB3ki6QYEl4J6Aehr5iJFSdzR4rjsEQ3BTtgSplbyRFNwWlVyysmAx1iFYRXPOPPQYQETscbDZwDfiz4SSDvUERXakVHGn2dpt7wkkqDMEZZemOsPL/KwDaH0DfIr9kQ82wI9YBRld/IDW1IHvb4DcgvU3G3tm63DabB83Do6bB/+GDmA8lxT4bSA4M+IwewVtS9/hM16FzgUNIyI/2381XhlpOqEh6/rLpe+BHJkt4ODzYkPjaOEHPKIooRM/DuwKKcpR+pKSTIHcTIvmQNHF5pXkcg2uI4zAGc5cCm4RfbAKOaCfF7sutbCjWgb/AWT3Zd+IqIiuzyGRB/5aL6l9i7beyLTC5DBCz6s9k08eFtxGTwi+MmAzBs7SZkSENCI8SzmSAH6tQTx9x2Rfz0T+GC+pZ6J8Ik9zZvEd+F1z1+V0SeD/GPE9ocSvAo6Cu66MwRKtgab9dqVg6PEibKLe8wLabMCMVbpSIYNvEyDl9r62+LzRm/6dhafaAQvOyBUfs1nAwsU4MYsJnpbvu4x6AtEZjV2QqBl1Q1ZaLLAchM8ITROmQALFoNhjzGFOncCSgm9wIS4G8ucgqOB7HxbMg2H2gnpzoM4TRIZCtsiChsRi8H1Jnbw4KjOoJ+v6scyNSnpQFnsQO0saRDUa2AWTgtG1mOt7c2TtJlOZ1ardVhahwww2nQjIs+II/JA34/OXzfQpm3EPsADWiKkTHlINCTiwWoHEEFuAjGWmGwJLcfkdNX7hPyD2OrDBNMv2XRflBZwnFYrOKAhNeQLIgr3y2oEm2ywMy7kT81BAK6IA5LBF7U8McpQHMFoqDYIszweE7qkb41RSlJV/29G0ASUKbj0NFDZLYFEYElqmAfVCXKps4vvGhDhZEhBVBU0FNfiBi5/KbpaZWeZXSTQGr7IH2ZixeppUyyH/5y6amgTh0wTV6nUKGQ1XwJXNJGbW4Y3WvTxblLHnyYSFuTLhr22jTif8MrILXLl+1HEEHOqOchhSb53PHhSO5cDw6fapiHgnsDggG6zJJ7Y2hfiSFeVBiHoG4VoAFtdbkyWLaKJhqZXOUvSYoi/X3mCmWLGaIa2dar1cK8eq20U5S7mYgwN62Npn+4eNJvyyG1Zj16FNurcr7bmOgadlCcBIONOjX5THZIjo+FxPadREZJ2Ide+zzQTLxgwzuLF2R1Xr9EK4ScNPYxaCnvcr3XZigeMY/HqVnHEnkTKABaYMgRUSYutw99BhR6ZjHVkmteyZyfbb+6bTnrUO2tRpt3YPkbxAULNJVXPBO/W8mLpEjqj2Oxldlt3qlUuyiZeS4+ASp5ACYZbj4JKUNbvvOZiACaemLC5Oq3KecMQg7IMeyudnXIyW3SrH90Zj/PR0WyZMgdsgieprTxUWVL749CSEETBdgbuTItJqNKrtmVxq4dlFOQF9SmVx9a3F1ER2E6RlvU8iScYKOyJqvsW1T75CbszcTI0SEaUkBCxdtrFIyb2ZX05BYZETcw1StwQfTecM48AoDjyIqjaUVTG+kpNnFvVFz6iplpqvip07cqXIpZy7RLZqz1BdNbxMMNjZl/2JBg6d85p9Nfh5MLwe3I17Z71xD8uP495kePGxNxaekX2OXg8cexegi+gETT+Imu/es0zgPUtr2jcI/zip6NbAJB0TZcHtg/Y+O7KPIEk4aB84+3uNg93dFrP/qAkDcUzADjuwdtqy3hrCJ0XgKV4RtWjU1QARkXvrGsZ2wKrjjP+qP+MxC14x58QSVIxlfi5DKWpaWcGVVDxPSbjFXg808IDzFXJ9Lb9sJXor0d+URLMg8IMKee5h+1aat9L8TUmz3kOV8U2FWCdBqciDJCKqiPIAH4jas8ACRLxyxE9rLbPYN0t3fmYVclVPkAL/kiRVb+diXOa/bppiEfw1e5t6nzHZNXxpv/A9m4SnbyHmTyhonhYqmG9G5aXNQ2mt0mwhL+Iyes4EHImlLgv5rUw12lXZRdfloO5EWnMTAn5lxrlO58SRD2JB/I9VLO6BJnPnXalGcQMK1bMLtvplnp9xj5nzgHLEUJBLbBiI5bZ77ojoCusWEqTOSEW/POuBE/UmOaEOGSv6uooYWWSyPwGs6iw9j9CV3F7VQzBD17lmxbTsgFFrv3HUas/225SC3DUP9qyjGd3dbRztHR3h7NqhVtT38lOfYymU28T1bViRP4AhIHmhqt2JyZ8zPfk1EDBeWeySfRMylxmXVYOk76Q7Iu0D4lJvHot2Oi8wwTOvJlUbfxLwMOBzXrkVqS3Sae+sc3WBxxjUIQ+jhrBKuywdCDhkwcAXNXFRQk4JeKAhxCZYQcb6/Q8K6g9AEPXCbEcu/wrF1jpR1QEYoWavGJEFncZDWpWE3nyOyPe8zuo1YmEb5Lv2glhY+tAbBT90bKyWmBeKkz+QBaMOCz7USSfxnrrsvARDZDECbhVVVwKYxaDK8niOH0fE8yNx+ii7Fikri6UrbYQusovy6jgG7BqWjASZWS1MpEWhqNYHcJacy2M3zTBNsHTtRRQsptxnsf0ArSaxgDYOLlqZI1yuEAyPp/slFitrW4W5UyGLOJSBpxFoHL5C70YumB9TkJZ8EOEYKp8IGqQ1Equhl0lZJLX/IgarXslyJZH0jDPX2eruVne3uvtK3S1+1HVJ9VWEPs1y6AM5ldz1R+dZCn0CIT2eT3QnuYMkF7KG8Z0KkX66noJif2Ke2OX7vMII7SvGR9KVl5DvkDQLwnYLw49ksXJrgQgKPkoKZmCJGKSF2JxiLOvRglW75dnO/MDiIKBeRYgIVjMgaz8mFFgWxJ6octGwRhyfhd53EVlQsI/Uxu1WaQHFbqhjrnzuRdtIchtJbr3R1hv9fbzRNpLc6u5Wd79N3X02kkywEtqi4qQwXi5psJaSpr7L7W/oQPTufnpqRixVMVpBYCSJsYx85GBYrabVnB3YrO3QtrO/ezRr2fstunfQPGha7daBkfX1N6keJ0qW16nMest1VCemgnuI42IPhCuMfN/Jl/+AvQGboVlD05PEzcDzOh4u0rFj66ji/ILvk0s8SqQipDAXQ3opj9CmQd8l9g10X45HKOdgFz2yEuc7hCjxJQMo4iSgy5dcKC9SAXCDtdmZRUCKVBQtZMks3LPd2FFHCvWpyAfK8ZDkDGM+gCAi2DlY568YnaolelckT8ZI8QVSTPAwDZ49JUnkvldV3+0D8gHaiIlc4A2FXpntUA8EABICabOSuHMbn2/j862P3/r4v4eP38bnW93d6u63qbtviM9VNLQ5PocOr47PoW+9QZJY6kwcEP6rw3ShKgoDId7Et8WlfCeNwcXbAtAoLs/BJFcQ13elKHcgaBcnBxzvWJ/xMdVFlWNYCgxOb/F085KBLCJFKz8UVojiQGOnOCjckQcNDJwTg0tJVxy40HsRRavweGfnEZYblvmpTle8riF4/kPd9pc7FvC4wnzhOQOpqtiBdEZ9lZ7UxQIFHHVAGkwBXC6XOrVthLBsorT8LGR9bGPtx2AiBZganpFR8iiaAcUVJCPfherqN7K3RB/QdRW4T++nRQLaQEsV+56dDfoTwLRAoiHPr2sRmWDkLmcvCUrqjTDba5UmG2K3FjlhNIC0Qm6AfP/T9fQDydw+xyPghHFMMEDjRiAiwh529GYADhIuKvDjuXxFopPbbkH9IzMXCCa/ehPGyI0+9j4ARzEGyy5YioOYMCY46vZ7vToOu2cu+tB6ykkUPNCBHeDQDs2N+yD8pUgseHoKvf6rZ6ojOngxTfRRJIo8kdysNF00Q9eXIvEPDc2U0EwBLfxQwEKy9saWx3dsMAIIgrqh4NYXTy7hmRl4mIVBC0It4oCcUHjkN8lsvWpfjEcOnonw8nj86l2LO6L5YUSaLhKCL3Ud0if2wvdD9k9CUHRQDW7mMWjRF6MlLqaaQiPMViODkimnNLkJoaXA7wIUw5PCRC107eoK4wzcqVTJ38TKgs7/Jt49+S1Hs2i+AQ+MPR3fDr8YZ5zQxAlNaQNChb86FwnIgm4jDcIOSAHopusvLIFCNGP3JKxKqy7A74gx6BpsQFVACVfH8o/j1MCpX0R8wN5JHzDDhrgsp7YN8QapgvWUXtiWzNI1hSIHy/i6PjjXAt8kvklNCx3u/xu9SHEnLb3g+xBf20pvsCT/P3b3f2Txtpbm72hpVKyMJcxx+qpZT2c1N5lnwJql57qSA848c4F185FifaK4+sRv9jkg1U8+kFM6Yf/sOyrFZ1OSN0bejGXxQY7scxzNxktPZXxl3mx8x0EmwIVXEg6ffakgudkvx1Zeqr/ZeKFd3ULfeAldl5KKt7uLl7v/7LvSt6+9vJy7jvy6i8P5e8Ply8GVt3jltVnIOtC2i5kL92PRo5yo5Khcd8eNoQWDf+GrcIwiB6Z2lHl4LgNoBbohrt+jC7UXnImK3YrRCBe/hmbcXwq3p16AYKEENBcH9wOwD9SlFncBnthT0jNT4Z1kFodGFP8O4+TJEvnKR51cMwIchiXDAgqeioJvv/uqkjKBlR6hFSWn2rISfNEp9tRjNfGSgGq/ZH4dHoIlEMywfc9jmhe+yLOSUdplol1HEsTVFAZiPpxN5KWsjJV9YS4wsqHaCaI5W5USMmaufLoD+uVz5Jdgg2k3F8xdofxAiAPZDsvMcNmfliACME/qRd0P5jtqULiDfQFIYruN3Xqz3jBFbo6GzA+jJfUywNV15/JzlwU5fEw3wb70ZU1pHzDB3llhZRkRimXCLyssN0apwmLoyxx4VWaB5Rjo9fiIJUgsOjxhM3gvrG/d3Kb1BPwLdVGUIoVRE3fbDLX3ZeIDRGmtq7yph2UOOUKWN5/tm60YjYZY6DUs9ULoUlbPAvqApgP+PTZ+hf/QXa2kqEAn0f5o6Fo09Pk9eQiKbghy1Q8k8+npv0c2fxs= +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Import Identity Profiles

+ + + + + +This imports previously exported identity profiles. + +## Request + +

Body

arrayrequired
+ +Previously exported Identity Profiles. + +
  • Array [
    • self object
    + +Self block for imported/exported object. + +
    object object
    owner objectnullable
    + +The owner of the Identity Profile. + +
    authoritativeSource objectrequired
    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[]
  • Array [
    • transformDefinition object
    + +The seaspray transformation definition. + +
    attributes object
    + +Arbitrary key-value pairs to store any metadata for the object + +
  • ]
    • identityExceptionReportReference objectnullable
  • ]
+ +The result of importing Identity Profiles. + +
Schema
    infos object[]required
    + +Informational messages returned from the target service on import. + +
  • Array [
    • details objectrequired
    + +Message details if any, in key:value pairs. + +
  • ]
    • warnings object[]required
    + +Warning messages returned from the target service on import. + +
  • Array [
    • details objectrequired
    + +Message details if any, in key:value pairs. + +
  • ]
    • errors object[]required
    + +Error messages returned from the target service on import. + +
  • Array [
    • details objectrequired
    + +Message details if any, in key:value pairs. + +
  • ]
    • importedObjects object[]required
    + +References to objects that were created or updated by the import. + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/import-non-employee-records-in-bulk.api.mdx b/docs/api/beta/import-non-employee-records-in-bulk.api.mdx new file mode 100644 index 000000000..c43adbeb2 --- /dev/null +++ b/docs/api/beta/import-non-employee-records-in-bulk.api.mdx @@ -0,0 +1,99 @@ +--- +id: import-non-employee-records-in-bulk +sidebar_label: Imports, or Updates, Non-Employee Records +hide_title: true +hide_table_of_contents: true +api: eJztW2tv2zgW/SuE9kMfiBzbeTX+skiTdOAibbJOsgU2KXZoibbZSqRXlJp6g/z3PfeS8rtt2il2HvAAM6NI5OV9Hh7S5H1kx6qQpbamm0adSOdjW5RvrTnNx5mdKNVTiS1S1zUvq+xjtBU5lVSFLidR5+Y+unaqOLamVJ/Lo6oc4V2kU9MxKss7uTRyqKL3D++3olIOHX2E3LgWLM70QCWTJFPiDTfNlSkjNE6VSwo9JpWg0NVIOzG2rhR3OsuE129L2EJU41SWakssCC28umJgK5MKbUQ5UuL48p+NW9NT/6lULccolfK3gc0ye6fNUNSWCZfAJ51b88Tb4opOUigM9QTmj2Uhc1WqwrEDNKk4ljB9KzL4QB5Mo2UbLm1VJEp0U/H0+rp78gwNCiijCwWXl0Wl4NZkpHIZde6jcjImMa4soFT0sBWpzxLW0TvV2tnf2z9I1YsDtZs224dqv9nfSXaSvb20v7efRuTrwpv50qYTEpdQeOBYPOZVVmoYUG4PbJHH8B4PuDK07X9QSUnGFpQcpVaOvtbtFxXcikiYxABRXxtZTKKHh3nzbny/9w8P/r0bW+O8wHazzXKX4s3xEnfSCZkkalxSoKzoK9FHBiKkyDl6Z+wdZYEshRQZolOIUueqAYXmTJbjcaYTTu/tD44GeLy9COQaa1e1ZbUq5J9MxQfbf+JE96Qxi/QsfO3ksPWi+WJv/0Wy1z5M9pstPCVyf3DYTAb4h4LtOFW6jxy6eyLsgNPY92NHQZ04qGNQGiqUhsPH71artdPaIbV8AazVahp+qsaYYrBW1elXVhd+4gi7qp/rEpIbiyo1W4dx80Xc3rlqvejstTt7h43WfvtfpEpuUz3QP00X5M+8QpkEQnhk+Q6dXCnLyq3TSJkqpyK4OH170n37C9503/77onf+S+/08hJ/HZ+/uTg7vTo9wfNpr3feW0XAniqrwrgltPokM5Q5yiHl/MYb+o4MHqLGHFUG/o+CrxNkKUuBh7e1UreRyJUMI5AjgLjAkApFJgGid1J7+VyEGCHBAPAOSZgzZp0UAGqBSswm6EkiFjtPbV/pOkIk+koZkVjyPpX7nS5HtkKxm4lQRWELxzLYZyv9B1JnHjbCiNx91m8hsHVoCJ9KXfK7uQmQ5r1r9ttr2488jO02m6vIdZxp2CpOaRARCx82aKF9AAIuiz6AmXyjDUKoyRNX/NUDo//MUxTBmAwzWKYdR9KNVYLsT4Ip3ixrFP4VSiYjNDTKG/iTUDBVUCI7tqn6NiS9wuDxsIDSMJs1hBEp58wnnVIC5LZA+bHIOjG53WKpwb2NlniJTK3n7ONgDIWokMlHyHoMRl4bjf6i7iJ0igoqvjSsOlCyv988bO8O9nelbL/YbR3s9Q8Hcmenebh3eMjog2QCV5mvdVkUcrIy9C/KqAKBymyCMP8XDgGEwvesAA+OLrpUuft2DFjGI/xPieTbTs0M+gqiaFuYKV8eX4jdA8CcGVb8Xg6XnGDiawImU2WZ7NMrIiiw3As+L/RQm68h3cnpq6Prsyu86Z3+4/r0Ek8kawXWjkwNXlAVuTDCfF7ODODZQWVwB9BCPA9Sn88Vemio/V9u4uBM5NZAAvXQI4y+pse8aDEobL5Qn4nns+KpbqjGFmAI7zCpoLb6EshFlUbNnx8xOYnPgiefi5GSqSqeNcRRmmoyUmY1SueSEFDINFVTUjqogA9qimvGljpRi7GYuXIxGjOcOpsPChUHNP92nhwlZQXl2Mz5KpxmS1AxxAc6e88tanc15zR26QR4lcAKmQHwQcPBxQF3sE2XTgQ4onA5AI+p29UwuAC/jKFvvDInpeVviazcI+ruIgP8xGza9MMnFYrPhSkBaMTRqMMUEAkfyWzuHFpNw1UXvgD3yNJN7W5qd1O7j6zd5Y+9wHXCV+ZTrVU+dW1kBf8WPHmu8KmCs8dYUTdiehMCyfsDgXe9fneFwv4IMon26vOYlqU/cZXop/IV5Y+m8fDv+zVDr6f+WSxIQfajt8Bz1w7rPdOYHeVdtbM62itb9DUS1KzhnUDNQkxsJSRcVlTGkCbSbYnUKmeelCDbwEdaajvnEZBGNWk8ttqUP9FTGya5YZKb2WgzG22Y5IZJbmp3U7s/m0lOteJqCTzJVXlOP0pwpoXvZK0UaDDbdZuWHIdqma2QMDHlWNEic4j67Va/NThI1G4qd9P9ncNBO9lvy72D1kGrv9s+iObn+ptZHU+LbLGm5uLt48guBon7BB5XGSSXK61NF/cU4d5CDQjWCHqmvBk+h0vfz7jj7ip3fGtL2Ea/lsWQsX7P8rp3RvIxNIsnv/nfG6ho2XV+J50oJeUwPK1duaGOG+q4mX42089fZvrZUMdN7W5q989Zu99FHXe/RR13v4M67gqiWHwg6fekjqlOmZoNEBTYEH6ahx1jmIKnsPsYyr6UxVCVU6K3wCLbh2uO7VhLx7gmNVlyCzuRZuYugje0zaltUbdFAymGgEgjgFoa7Jayig5ogJMif0Smc811TAZBbjGJjwZ05sfXTJ1v01G0SbIKGjIoZNafXqCDDKiiAdE/SOB90CGA+ifucYZo/ab9YNEji8/IYnH6OVGKan66/7u37uhBF8oXBBeXPtZfOIPg98ylwTJCfR57+JpS0A1V31D1zXS/me7/GtP9hqpvandTu3/O2v0Oqh7Y0JepOho8mqqjbaMpplzqFSXX/52xc6kEDTi9hU2Yq6czDs68AqlECtHVCAIRuoPQibbnT3zHnru77XudPix+mTskHtGdDmKNXuGqyCBnVJZj19nevkccEb+HhhzrBuANoSwnxt41Eptv9+G8NbhEZ1t9DVIDcXTRDUuQBnu+0JTcHglZuI8D20ppjHjwyYOvSqa7FhTgCSwUXsyWQCGEROPXdHYYq4wnjls3OLFW7INd10X28Ntt8YK+YMs69311NLQX0HTJRDLh/ewKziVRcj/6ykWc2TRDPwa0VwY7p2Zt8VLJgm5O8PmYp6/fXT0TQyKiDASVIw6sNK0cUEoXSBEGuqP6rAh14rmnsNVwxIofLZzGocISgwwGi1tzqZS46QYnvMUM0ANks0upk2KUoF7vn9bRSdUnldHk2Jh5khJPp2YbHtqWC/2e8UTIKwZt/E0AvG3cmlicaMInTRM6tQkm8gJQ3Ixru+ScXT+qxN9qabGXFrM092xJC+/am8QfGU9Q3SRCZo699cODe3nxnDxaXuENSV3WgTwR9Fg8Q5XUUfthPRbkxSRvUY9b826kMcsudhMe1ITDJJmloiuSkbVO/V0ISh0qg5thhSr6YbXuaNCYKyJuN+dUiv2QsY7BGVm/MxSG8ckk+zRnM2WxfveES/JXjixq/le+JfHrgs38+gZTK7VMbeJ+WGcaMKYBY48BLujvZy5KLNQ22cA44BPgeBZ/RoKg6BzueVlrUZ3Fb3MfmhroLhxLceOO/6MzA7jw5G/MUetpG8AwUe7pqTL8LYIsmr4WnFVvFix7cFXfzGLWXPKb13f6kyfNpH80e8nio9meyrnJJj8bpb+AJH8c3P2dEG+DNH9FpAkkmNKNhw2rhfkkfxn42uoen+MriPgvvnKtMt/GasbfpiIWMy9onMmSspqrOhlpxbsDYyVL4n5blFk250qsb7eFa1lDvjNZQGWJ9ZzOII/3r+uRJReMJ5YUV/rbVeE0hUVKYrWpGuIdFmwmQVhosUbnePHtgw2rtktE5oICK07qYIN05Xll6CIz1K5yuiH7rYxItUsqD1xYuxlV+8Iy9Zv2qquYUo1MaPCypcjd+YA2nrGmnQv8N8ZC3F3YdYbrKYrh/vTMkJ7KODOp3SJt/5ZsZFs8UtmYlotAXRAwNTfCm+7VikQIM+GnDlsMt0Mnt01tIYSWRz59dhqtRjPm5QLe0+oLC9w54V2+oO74BPo13yN1S1fUw4365cScu6r9R7v0HiYpWl1sj2m/jEyv/GrHLzxvonULT3Tt8HX4L649sZoZ0QIWAu7vac+FFmMP9Bpq04L+5v1sncXrU4SYnrH0HQB01Fec+LQXLqE/E2su4K+1qd4pNJPZJkGEx4+K9hY0XbBHK7/5w9r4D+HXhvhqwqyg7rjuvj0tQX0nv6c013zlVxda603X+RfntLsW9cO1/txvWZBglrs1e4TPAsNaRzDCAzV6ePgflQj9hw== +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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' + +## Request + +

Path Parameters

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/import-source-accounts-schema.api.mdx b/docs/api/beta/import-source-accounts-schema.api.mdx new file mode 100644 index 000000000..ddb018283 --- /dev/null +++ b/docs/api/beta/import-source-accounts-schema.api.mdx @@ -0,0 +1,91 @@ +--- +id: import-source-accounts-schema +sidebar_label: Uploads source accounts schema template +hide_title: true +hide_table_of_contents: true +api: eJztXFt32ziS/is42odOcixZku962aPIiqMZ2/Lo0tlet48DkZDEDkVqCNKJxsf/feoC8CLKl6TdszO96oeOTAKFqkJdPhQA3ldiOdOV1nVlGCaRo3TlZqfiKu1E3jL2wqDSqozmnhbtq55Iln4oXS2k0NRWaGeuFlLEarH0ZazE1POViEPhhMHUmyWRSpv+BL0cJ0yCWMg4jrxJEitdq+xUwqWKJA7Uc2Eob7EMo5g5aXN7PaRBoOlSRnKhYhUhu/cVD3lbyngOrwJ4gd1d+B2pvydepIBcHCVqp8JMVlr3lXi1xFYaxg9mlYeynErw0IIIqW8S5MIex07jpK4Oj46PpNxX7ok8qU/cE/dgb3//oLk3nVQebnhcpeP3obvCwdbZAJ3EKojx1SLxYw+kiXenYbSoujIm9kqMhpPflBOj5BGqKfZgduAtarkszk4FiUkYoDLxAhmtKg/0HzKml2GguXOzXsd/ipIPEwdmXk8T31+ZWVauiOc8o5UC83K59D2Hpmz3N43dX845qHUD3+VZ8FwRTml8nvxaYTaazknjuH68d+A2Thry+LDeOHCbx/sHB5N92dxrnuDMskG8ZCxs+dRoxmyZaOzdqT7JNiLC3zsA60VgJxEG9IiJCr3S4EbwRMb02LhWpJYwfaB6XeRqrFWELHkuvPPiVds61ffzlPqjSDTOOriv9J2EHBrfJ4EHhi14pKmnIgGGJmRghfGCHMNFLnX7wnjxJc4HepynIVT8keyaEcSd9IHrF7MK3WIYPvH0XLmW2zlIKyNn/jr8fp2HWjFfOptYEUKryHCokUUp0nFroh+AS0bKV3cS2oK0syhMlkaENaNYqMVERf0pGUbg+ImrrlS08LQG1nSO9UkY+koGJd4/+HIGHLjk38EMOFbMXCSCkO3S0BXLjLD46sXzvHljQMO+IMpsFqkZE3tE81PpawUMT5WMIWPk2ZRRJFfQ1gPP0Js0r4JkgamrPR597F6Oep32qAuPO/2Lq/6wR79Pe4NuZ3R71R1c9IbDXv9ySA+Hnf7P3cHtsPOxe9GGJ93L9vtzbH/RvmyfwZvzfv+v4yt4cNm/HbQvT/sXt+1OpzvE7leD/v/8Av8Ou+1B5yP8GHUvrs557PHleb/zV/oxHA3GndF40D29HbUHZ90R9h1+bA+6V/3e5cg8ZHo/95C33uUZ/Hk26I+vbtceDn+57Kw/u2oPh5/6g1MUeTwYgAZuc4+A3f4YHvUvz3+5HXT/Nu4OcbD26WlvBCTa57e2RfYShG2fnQ26Z21sYnkZ3n5s/9y9vehevO8Ohtwsp9B1tuCtEeHJNpsUtKFZeQJLahh0P8CMjce90zJ46dMP6QtrXxxiHQgKE7DHZImAA+LIZIVxgsFK7dfgncjbVEugV1vQw320WEqtq/Ec/HE2FzIB+4YAyZmRKKRmuLm7EwLY0WDb9o0TqaxzWezNVCIFUgXoX6eANpw45/CGTsHUNxOB4OeEdwq9ykYWipwQYSMAboHLUYcpsqs8wox0kYY3RWVawAfoUQVy4oOWgSaMRb+JVtHbNjPnh+EXJApRbyEDOSOWcBoVTBlATBXQMAqwFkfPqQLqglCrpzkuLY2mISav+zPxsf6wwIkbgtVg/DMsiQg0Ei5QPgBNpB4cZKZihgZv3gqAqfMQkLKeh4nvUmewNkhUqATsoL4toSXnLwilCN2IEQothdHRUmEaACJIRN4AqL6tTFrjzGFsVnyigGttWMyz5jsCBkZQHsCY0BP50KBMCOMmdINHmG6oUdAk2RJhQDZvFDAjgMPjE2Ym5zQcEfGXDYn4m2PiY/b7iMn4ofOFLSYJ+HeNaZWjxnOekQSQMRIH3d8VIxnBTLEpl4LxD1DibIcaGc5BeVehF8Q10YtBtaB0mHVIWh5qfMWABQJN+3RHnJ+2r8xA2s58GtRKBjCBqSZVkfF8jdCWja50TXyUd5xgQW0mzAlYSfmejXZmru48jAupeaKWsZlaQOBClwGmIRmH8FoGpicbAts4i5tP/Mga9Zjk6KMbTtk9TZRl/ZkgaxGBiXPlZPci4U08ei3RyRjWM2yJkZROqnuA7YEDLhKEifZXPI8mAz/RGxPH1zByhTOXwQzmXwwBVtnGrNZAQTxmqW1zvcNyemlcCREcTgwShtgHHvpbEjio3AyU5UWyOuL8tIYZWrD6XaQsI9bSacjD5DA1yc0iWyeJIgSwlj/KmhtAx2NORctlnL1Um8hzmMSC1jQ8Oewcj4OW54m7rmcgQOoxJuTnoE5LtFPBye7XY/5Guy0CowIri9BVEGQZrTMw13NvacCyNI9yqwOzHOQOBkhHkiI8cIR5jW2+3MUGTe5kMp+aTmk9QZjdWno6fcAbBK20IrMm2xPwriV6vDzI+1c+swSotMzUTfzAfFEOH5TF0ihG+asMe8jpN9mwplxlVlE7wqOsAaaYLChvbeKNg1WJuxxPRns2lBiwYmQl4oQniSlHgt/pXG9rdpjUJzQ0uI1J8uAgXwQtZIpiG30/DZhfXes2fP6/0nkOw75k+dFitnixmWZzWLf70uFc9uy8EctPeJPl5Zk1zr+Ck0IhYW09TcEYy4QU2j7wPG2unxZXWblClg3NhYGu15e+Ty8sNy1Gbx6oOknlZsmMlKuQRT4/hj4WsYMVoPA4kqLQneHcOvcLuRKmoFsQ4L5CRnVBwTxXJDKlmAqWX7N694bSRlmDWXh31dQLKHdB1ph7zhyteLFWR1mvjTxSef2xemjKy3NlvfiRaqgt0ICr8RSe9+kfQNzw//f9/nm3fblpxwHLjq6K/BWhOyqXMktc1mN1QHBJdX6aKuvRmmnKhLXnDZ2prPuQ3zQoctYG6lNYaiJcgwiTMxGTjC2ICNeKf6bst5BLeId8PT1fVqFlvVhlGIgwUaihlCk3o1yahE7/8hLCTD8te93ktVN6S9Xll9mM4aV3ygA1UxFtFmA0CDeW8A8Oj52D5olzWG/AL0ceTk/qTmOvsfd9Jfx5spBBFbEyJo60AlwuvBeZINet0BZJgeZzQ7ZLA2avn/EcAogF78laksL1Be4NvU6pNjM+mBPac6qSFbrl+itSn0poktVjPd3NUPgfwBA4bw7mv5ClM5qyV2YmixcWZENepoyL8MWusT7jNt5nXNp+LqjmMwmDGMe0ePcOcu27dzhIxJLaEEEBHRK2LZ9kRvJr8Lz8D08GLrSeLK/agL8eqtPgkMZCY3E/k2GkQ69NfvrU6N9MSDpKuvFQpl/aGizFGQ4zNiQcHx0eNabTY6fegF+TffzLOXIP69kur/Hb9Tk/W1tqlYXjjdg12exDIxr++UCgAqux6oUB0LW7T7yDKL5KLQyBWn5nFttVY49mIhcN642TaqNZbe6Pms3WXrN1cFxr1Pf/F2WEdSRuuv0OPnwJ6NiS+Q5u9hqjZr0FDDUtNzkLNJvyvMG8v2lPuQOBH9aW3SgCa6+Kga0BcW0ohe2T0F1RNSaA2OQRf6+02eyqWHp+B9bhz+vuA/hldRZJck9FLDuhaypHVJ9chLg0IZI2xlO7YnwHTdQa4r10QV6Wr2OEQd1F0sFKdu8FkznmTVfbBXfEbdTYMKw6UnJyWD9p7k8P96VsHu83jg4mJ1O5t1c/OTihHfGF0lrOXgBCz1SgIs/BAizMyD9AIWDIoHtigAZ/OewkGi/M4tw2FdPwK2IA6TsQQ993rsT+EVhzMEvouZytKSGojnFzKkh8H9Oy8eUdw0Q/8mbexuxu8dFp90N7fI7ANN0QQ1oldNoObGoBVsEW5uFX4tgIgD6nlU/185p4Z6i+S6uqaUOzOWF2/k20hx5m9A098qTFNAoXBVciv/kWizdeTdV2IGeh38sYgPJEYoHQINR3kBDUMq6eG02+E3MAMip6WxPtrFaW4lVKftJ1ucJIZ0ISWqfbYh0kVM9ZwzmZKouzkQWQ8/ykoHMA5y+AXk6cAHMkZt4LU2sxLJr5AZ5Zc2UUZpVGKl0FsXRiU6V3wogqFJBfhUf7dOTBVHaFwBPYdmnEysdFCncXzMxpHNI7rlk863dXPoSfKomWvrhTxvk0bRRRNFL5kqaJSGa5QZ1Nq3S6rOMLiP++u/Xdre9uffeFvrv+cmBO0pm3BH0aZegzDvA0QBhR8ixBH14UBKGwjbjuxBO5g0sUA5H+8mkEjv1FBbSD/m2JpwlfER9xKt9Q4bDzwc8n9uyOTf3ZXCCDpEeWYAqRSLkt4jvjOD2GuF/fK4/2IYwmHhhosAEi4ukDsQoT3pNOAtqBlXqHNmeCn2Ixl3fK7sJTBKSTBm51SXuwWyS5RZLbbLTNRn+abLRFklvf3fruf6bvPokkU67IWwxO0sligbc4yNLMe5RWCmgg7J0OkbocTdU6WkFiIsVYlSJyqEyajUljeuSofVfuu4d7J9Omc9iUB0eNo8Zkv3lUyef668yPUycr+lRuvnkeebsDzy5GvJ2n4zB0i+U/UG+kprSpH2eQGOYOANzDTYodmycbdsPCUFzgNq5BSLqAIYNMRxjToO0C20a2LR0VnUFcDPA0gRfylRNvoYBKhGVU31t4MZ8kVUg3WlXb0xhEYUexRpaOYk7Ga4oEfoioOQTD8nCPboqYDygQgp1BdH5FdGqm6HcheTFAic9RYtH95iiFjp4i94NN9d0eHrnFGDHkCX6k0BvZzZ4kSM+8prhzi8+3+Hyb47c5/s+R47f4fOu7W9/9z/Td78DnBg09js+hwYvxObSt1UWKpT7QgY9/NUwnVzEckHmL0KHD/W6GwfFMnIKHXryiQfACcodNuQ2gHT3Tc4MWH3+rMnJr8X2tyg1ej+eLFzDaMtQUgvDmfquyay497N577sOuuXy2a49H4wESgpcsWRL50GUex0vd2t29hwmHiX6oyaVXsxehg/BrzQkXuxPQ8oYAlt0Jwwb0VQMeoEZTFHl09JhMnIjzhJlzOBUNE0fF5Scp23NnK5BMMJmd3C0geoyX/2A58pOm1jWywJJ8INc48h9+vyxM6BFZNqnvydGgvQBO10REEW4yI6EDIjx6yVSyfITrvWZpsD42a4r3SkZ4+4G2QN785dPorZghYqWIkWgEy8qjY11SXIGJUERs2+0A7ERJKrvA1i5suKAHiqkPAotfg6FS4rpnlHAJqWIAsZ1U2i5c7Lx5Y2fHVXfKxyxayzSJhgdesAsa2i1eCH1LGZOWFl7AB3D4tkXV3NvMjuaziLRSFNdLK5fMyfWjTPyXpVZlalWipt+uccGqvXb4AI8DYQBJSF+Ttn54cKZXzdHDdRg8QarrPPDtU+KjuE3m2Fn7YT4K9KpIr8jHr8EnPl1c6GYvjpmbVz3hzMNQq/8WAk0H3eB6loAX/TBbdKS5Sh5RbdZzLFV5yKpXBXBJ/J2DYwRsTHKCyZ2wTQiwL3DZJT/TzILPf6aD/58LMtPja8jB2NINHf3DPOOAVRywyjFAG/45xaFh4XEzkIHiABtAJ5t/igSG0VzcY1obozqR36U+dLYQWCUqetniP1pZgDO/BL3A1mkbCMMV+rCH2TjE27GGFh3YzyvLVhXWNVjm1w8hva7pjflNq1qYcv/d5EWJ21nxBb838dpR+pFI8u8Td/+PIt420vwZI41By2huNKxZVuSN/L3Ba+VioKbju/B/eEu+SsAclj3Zfd48IfzsFl8KAq925p6iMsJSyRix3w5aVrggT4QVP7q/MhdQZ3Q4OQKWJSz8PB/oUaHbjizJYRhY4rzi3zoxXy8KzcXlmvhkPr8Q4aoOj2rAu99Cs7wbwszQdXhxaicbQNdikQQwGvplshASTOoZi8CPUyQcuMzFQhaBv36Q9rJejKaGItAdGxUtdH+KFWpY/OYm/pmxYN61KU+D6rP7U5VMkIHyyTKxXRG2P0cbrK06Vz6dYIeoCwBM5Ua46I1KFIFYYD6yEEazXdNJ72JbIILLIzafvVqjVq/ScgGe40ILVmA54mPzATf7rYf0FnvxO27rZnmfFer/2I/BmYSDK4XdJRbJUIyEVy68XryumPUitG7RV9rMkhF+pYtGWIbMcZEJre/vsaqCq6gHfPz3ROGS/fomWyDRwtJ+lCR39+IR+d8MzHfd3tK+UP57cRu5t4XAYJXVACrw84vC0gH0o8sGXNshVviF2Uyo0n20rOOmL8fhwpE7ccko17y0qVJYiF/16Zs/E/PBugVXJJAw0d3JfoLCDC7aBAvMD2z08PBPAh3y4Q== +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Body

required
+ +Successfully uploaded the file + +
Schema
    attributes object[]
    + +The attribute definitions which form the schema. + +
  • Array [
    • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/import-source-connector-file.api.mdx b/docs/api/beta/import-source-connector-file.api.mdx new file mode 100644 index 000000000..459f6fea9 --- /dev/null +++ b/docs/api/beta/import-source-connector-file.api.mdx @@ -0,0 +1,124 @@ +--- +id: import-source-connector-file +sidebar_label: Upload connector file to source +hide_title: true +hide_table_of_contents: true +api: eJztPWtz2za2fwWj+6FJR5L18kv74Y4iK466tqWV5GZ7nYwDkZDEhCK1BGlHzfi/7zkHD5ISbcupt+32utNpFRI4OO8XAOZbKVyJiMdeGPTdUrvkLVdhFI/DJHJENwwC4cRh9NbzRalcksJJIi9el9pX30qXUkQwIBZf404SL+BZyXODtqSZssLdpRe0lzzgc1H6ePexXIr5XOIoBVuW4JErpBN5K1wclp4sPMmSlR9yVzLOZLJa+WIpgpj7TIFljsGIzQAl9sr3vgj22Z06zI28GxGxzzySr1kc4nya8oNk4yabJs4XEVcZLcF9GTIpAlilNxkzHrisk7hezMQNLCarH4IOQPgiAnbrxQs2GJ1ed07O+xeMA50hMoABlEj8K/Ei4eJiDvd9FiPszrBfBU6teMSXIhaRJF55SN6KA5fKpQBewJ8UdsDycslAKrXjKBHAZmchlrzU/laK1ysaG0deMC/dbTNMMMVN5iEg8ZUvgWXw5sipH9fEweHRIect4R7z49rUPXb3m63WfqM5m5ZQILiukPGb0F3jYptoOCjcIMZXy8SPPaAp3puF0bLi8pjQ20I0nH4G6SD9EWpV7IGY4S3KapuccgmBcVigNPUCHq1Ld/QPIiZXYSDV5Eathv/LU35JWoLMBxaQKsjEAaWSs8T31yRSEHDMUC6rUMYVpVZawqUccRzUzHPIAvY+SwS/O2XA9gK6IsHdQeCvDSfzuCPKnsvCGSGv5JcTXsM5rh/VjvYPjpz9xrFzUKvDL4cfzI5rTr3ZaKEiKC3aXjq/1LsEDLCC6PAp8AgnmXXl9rrna4PNpqY9cZ3MyweWI1uEf/G1E0bgdngMc0EF0cDXVcQivA1EtC3+kZiJSASg92jpsMhtAGixvgsiRfMcGGk9LD31dhM4WhW+QdTVRDYVCD4yq7opZMsQESRL9G79k97FpD/5Bd1bSqt9CjQV60weh/6JYZynaXqChtSb360hridXPl/nNKUQg/P1BcInc3X8RMaPiglBcSlDxwMxu6yrJ23LKPVDV4oIYpke9/H3kGH37HI86Y3yIjQPnyxBx1K6JcCDg/rBwXR/WgMB1g8OnWZDzJp1fnDwrAIsQqBrDc4IgkTJHSdMghjeRsInlwghfubNHzfBjprJMlOZmsvCP84aO93u4PJict0djEa9s86kP7iA3xdv+6d54T4w7sny1jxEn2Y54SguFtnwvls/rjv7x7X6vts42j9qHjYOG619/qwqsCNOJ8b5sivlsCsHjaODw49F0r1PYUaJXyDGvLowHASIccAIdMcNWXdwPjzr/TOLYJnJRZj4ECkhlILQWSLBb9wuIC+7T00R2g+xGVv9Q1RudHnWyysXPXmyGkWJX5wWHNaOnMZhq1Wr0y9+xA8PauBBnlVhtlbvqV8kOSV6ldtHGSGcQyqF621xFOoHcDE6LCs5ugmixjSQnGKChkBa6CyYFzjhMjvqhvuQsWqPI756Ms68hUxfq+lePw1ZDyuAVqRODIyaJvEOvLvIWpWZhhgBVQwS2iKKsO4QCnkYkgSo0jmzTAHdepCxGl0HqH4YfklWNDgl00Tkak5C+r3SNDXgO+ky0/MESsEjEAoZYBytkfPwdOYBOdxSnUh6npIbhcssqRaje3AH5GFllWLcq1+FyreD30E8tqHixLJyMhkPw6RH+j5TqutJdCwymc08xwPuvPiW/6hvmQowJTGMwhtPAlxY6B7x2jgSJYE0ZtXtnlIJCNVfeCvJKh1IcsCX/MpNUbLKwGaAIsxWi+p6xPQZoEDB6v4lmvyHJa4q7gwfSzyKOHpwLxbL7PPfkfuQAl70upPB6Hrcfdc772xUBJtvnywV3WbYubQ7PDx8VrkUrH++HquHJJU8xDMIuDjV8o5CsRqvuSuzwK4silusUpwy1DYpCeZHByoJbu3vT1vTRrPB036Zjh9A/m8FOk2BzqMwWZXuPt5hx07K2zByh6GPHv5PpojDznj8fjA6uR4OzvrdjebC5ssnq+EKaX5Ch+G51bBg/fM1G2qJsKF6vbNCbnQahlnJro2eVosVdZOXeZXKF2vwS0xr+83jo1qqUmlhvYV/+bescohMt6v8LAIXgtPWEqjJM8HjJCrU4Dz3BvSD+8zMSCuyqaD2exghA6dr202vFpjBdtF9OXmH7a5uZ9KDx1jaDcZ9+n3SH4HFXg97o/P+eAxV9pgejruDn3sZM+5ddN6c4fjzzkXnFN6cDQZ/vxzCg4vB9ahzcTI4v4aSvTfG6cPR4J/IwnGvM+q+gx+THtSSau3Li7NB9+/0YzwZXXYnl6PeyfWkMzrtTXDu+F1n1BsO+lD6q4cK3s99xK1/cQp/PB0NLofXGw/Hv1x0N58ZoSLJl6MRcOA688h0GAYXZ79cj3r/uOyNcbHOyUkfuw2ds2szIn0JxHZOT0e9U2pIGFzG1+86P/euz3vnb3qjsRqWYegmWvBWk/DgmCIGFQzbFuAWG0a9tyCxy8v+yfYWz1NULjA69yH4kWV1qk3llN4R0nMkQwdeiRfg0ecL2qnBGka19QmCVcPi6VBprkIJum23msBl2cnbZBdDiQRQRSmlaqUMRbT0JKaZUsPJqXoxEHCRTngjqD7WaRHlsFCdRJISW4pbCqIylXuQ4S7C8GbITFNrQkIrAnTFUIVGuBb9Jlh5aytGDgtSBApFqa7BACVq4oPIIHsGL4zLCNwZ87COmgmAzrLN/nClOQ2ee9OeCY/NhzlM3BC0JghjgxKLgCNQZHLa/yH24CJzEat2w6vXbCniRehK00/CyaBtKq2nCeLrCkaqihsiOe5LESLkWnKro6aCGG4wwgBxEPm/rkk4HKAuoFDUOsveUxVpdJgt0uFl2pVKKwzEQwIzXaH2G8ki9DTkKHCSdIl2u5R650sUXJ7CKCGTMRrlEfGXcYn4W/nE+/T3HpXxQ+eL0pgkUL+rCta213jMMqBQi6PEQfN32YRHICmlylvO+DsgMdybJI6MF8C8YehBrc76sW2sQNDykOO62AdH0zkps7OTzlAvJI3krVPbUoApiJpYRcpzG6Eua17JKnvHb1QPBNim3RzDXoJnvJ2WlSo/rXoil6nlgDveaDL9WO1ULwUWpzRTKYLScUXuKnUwhBrNmGbgoxnOlHlqL6v4p53sfB6JeerntoPdTsRrf/RcpJMybEbYLUQsHMt7JteBAyYShIn010qOOgI/MNtk/sxZ8GAO8mdjDxtGWh1odCDwcAFRbYbLsqLTk4V9ao8a7J+TwKGOg7ZskVMswyMVnzZyhjYbh0uLMuZa0ro8DA4zHdzsLk8SRbjlbfCjqFmQdNxnVHQWAKVnuYk4h0nMqBmohKOM4/6k5XHgruvpFMBajHb5mVSnzTqWcNL7TZ9fqLf5xCiHyjJ0BThZ0lNQuuUUwtbCWykasX1JjzL9Tt1JUhN0vQZZPXp4wAjjmtL57SnGaapJOvKJ2QyLDtVdNZpuxQe4gdOyzeAN2h5I79qsH7ioB1n7ykaWAJmWqrr2Hxgvtt0HRTHrxSh+bac9ZPRFOiwpVq3gB1BWZh5FDVDFZElxqwg35ay2sMvgpLlnXIlOVjStBFwdMkCkHA52JzOzjdphUJ/S0mA2OsiDgXxhVMjkydb8fjhhfnauG/f5/4rnmRx2l/KjrdBSxaaN5pFY+dxRsexRuRHKD1iTweWRGuf3wCTXC9mop83+iDqr81bJCfsxaTujsD7dqqVtwbwxcGO9wgLYVrbYcTAdr4cbQWPIsSFqCeUFTS9MriWohO6FqYoC8vHqvMo6EDkhz7Z70mX2HjTI5fBDxE4VEqQZW4cJ2YAq1jC+sBPhe0sPde4tnQsjLpVp5DIBzZRCmcUnawRcduXNJwaKG62ZPbmHKvsJz299qrKcOAYrEVC+WNG4Ie+tkT3OB3uqkqmn1ArLS5wT6RV7Fiq3QtcHK3x8GYx+6jTcvxLuI+PdXNPtJ37DmYOwlGnbsCQ3vIaH1dyMOxs4Su75K0qv7dAqssWSl0Pa7vsVNlDvZZBSGUefVUjUOdW/KaNzPQiqkd5hRG3C1h/8P4fmt9JCcD9edBfC+TLxlgISmlK7WSuXsEUwpi3NLG5XJSeA+QmdOFoCiaDg1Hb0QScmC3C1i9DPNleRO3M6XGNPM8KjZmN7gzWhFIPQrSGu9VpN13rWMNTeasjkF0/t+ap12QrKxzxd9dqdIgHPo3LUlgxO0zD0oWjYQuG92rpNIAfJBDCbJNGhVtOM1i0Ys5M+jEI8ZlklmDOe+EDoDGKJyOBEf7Z7s6hKaLCqx/7wxuy5ncHsFF3WAlL2iOTv33c/xWbNReei21MePd9433r75M57yioKj4pXu/bhG/DPs/bhH8XmfF0oKtWaV4a2/k495EzPT4+K3qtoOBW3DEHxkx08IdQSNFKfawBLi8ps7lGpaj2MFyj7pZQc6rVF2vRGwzDIgU5CcpdjynhwOQINGE8gXF6/63XOJu9oD0ZiFbmDnwanBPgtV1hG3lJKoQ8g6M4RrQzFKTgwdsslA5cdmy6VyB/7btQa9UrtuNI4mtT3262jduO42jwCnTk4aNZq/5fzyP0dFHVijyqn8W3nOHWxk1riErnDitb5k29Egp1FCAkuSmWjNZvPkjbShQwuMHSyU4qSdRbpXPYqzeDRCb7OrUuH23OMzdV3u7I5E2/z9eHGyX7XpDcVuzByQ+y4jAtDKzGonI41qfcnTmtQmWBmJ2wqWqNSg39B0Vrt/Vq71qweNQ5Jw6DWpmzjORAiXbcAd0GrVanVK43mpH7Urh0BZtWjY0TrrvBcsTpens3ePm7m15VGSV1KaBXdQ+j6eBiI9aIIBFdhI9Na8/S5B10NTUOX7ox4wQ2kYnSU5JkuILgihiSlG7o7aPdbLxCVecQ9xFAQyg5MVNUgtX2XeP5FgTT2SOPymR9wolpnb7gL9Cr6upoYrAUi7uAGwS56fxl4MJ+ZKehqTC+7YFlxKPj0oHbcaM0OWpw3jlr1w/3p8Yw3m7Xj/eNj0j0hJYSnx/c+TwVIHty+HzogkV+BIaD6wHtCgBbffcOfYOzoXdRYS6bGl+EtqjL4/DfdIWsdgtoH84Se8/kGE4LKJe75BZDZYxy3wVABHkTe3Cu8sGEympPe287lGe4u2n1GhLW1U9cJTHAGVEEXIDYRxpoANE4JyalDreofNdQfbbPaDtR7PrrM0yEdZujVC2ZkQafnB40pOerKGXvlVUW1DLkcOgg6LTrl2HfVXbgfO44jVnHlTHPyR4yjroheQ12ZtiD1edIlp74td13VuKVLRQm1P0wPFIK+t1kBpazMSyN1IWdZoaBxAOY75CtODBUb6UTOCq22aBRN8uRqzuWxm2SYRixdQ0RxYr35QadTMRcG2jza/iQLpm42OJ7AjLMeK3syk9zduULmJA7pnWoFPWp3Qx/cT4VIsy9uhDY+Or2hvJHIdoq1R9JHO2iyHmXFZQwfArTw3RfbfbHdF9vd0XY3X4707Uv9llKfesEVzEC3HzB4bqU+EWlPEJo7s/rgrRJkGTNpnSL99H6iL9viNsnXFWZoz5gfqVC+hXzHykM9n5pT6yb0p7JABImPioIZeCLhtgnvFGN7dbVVaxZcfwijqQcKGhSkiHiow7YxoySgjW0uy7TnhWfOF/xGmMMN5AHpAIdbUb23l0zyJZN8iUYv0egvE41eMskX232x3f9O230wk7RYkbXoPEkmyyV++YM0Tb9HajmDAcx8ByS9QU6i2sxWEBizOVYpnzmUpo36tD47dETL5S33oHk8azgHDb5/WD+sT1sNPFSfxvqr1I6tkeVtKiNvJUdiMR0JxbORoFwyDkM33/4D9kZiRmcl4jQlBtlBAnf30eaOjeOC/auQtsfWJkOSuRwySHmEPi3Em7MwNjJj6QTuHPxigDsGXqg+O4Ld1gqjSwq6maxuqALcaF3pzHD3WxmKUTK7ihc4fgIYkifwQ3UH9JZ7sb09p26G8jl452fMTrWIflMmz0ZI8RlSzHpfHSHQ0G3mvl/U3+3j3jf6iLES8D2NXlXt8AAUwB4ltnnnS37+kp+/xPiXGP/XiPEv+fmL7b7Y7n+n7T4hP9fZ0P35OQzYOT+HsdUas7nUWzrV83un6WQqGgNSbxY6dGfCTXNwyivwRgqMx88GohPBrza2S3v6NsjeN/Phxrs99U3Bij08oE5k4GcyMVdUaCaRD7MXcbyS7b29byA9kNpdla+8qvnKShDeVp1wuTcFlhV4o/TeHA7AD0zqaqNK/I48Op5N+krAFff1yan0lOaDkM0BnDXQxhSYcuamFD3GC5JQW/wg9XlV5NYWfUDXZeTf/XZaFKB7aCli34OrwXgGmG6QiCR8TL9qSt8xUKtvfds0DS5YvG0f7hzgsAZ7I3hEJ4dxP+PVT+8nr9kc008yf/VpHOHRJRLOhqAi5N46prePkyjipJf8OrndEzQnNvOBYPYhGAvBrszxzAvw+yNw1MTSTu7y68dXRjquuBE+hsRq9uzucs9zgz3g0F7+0uxr9TUjrBMyZ+OqHwJz7Dm9vqBIVMevr1aGLp6h63uR+B8DraKgVQiafL2BhWLtlaNO4zhg0wiC+5K49d2LK3iVDDwsquAJQt3EQd3QJTzye16Okdp345GDV0F4eTw+BO8XnrN569lcrtO30/p4ji6U4n8ZQ9VBM7iaJ2BF343WLS5aIYuoNGoZlCpqyYpXgUyR8DsDwwiUMvEpRmpKVPTXo8gkP5FkweY/0eWITzma6fEVBFQc6YaO/G6cccEKLlhRPkBq/FW8QsXCU2b42SA0eqUA3VT+5Ak0ohm/p2AVenUCv0dzMDQ4gCpBkau2+kM7dXD6F6MXONqOATdcom+g6F1AvEGsYd2lB8F/1Z/CUy2CTQ5u4+uHECs3+KbwtS0qjJ9/NnqR4k7aScEv7T63l77Hk/x5/O4f5PFePM1f0dPo1BfVjZbVNUJWyd/ofG27syfpi2nwX3hLtkpZNtQw6Z3nLKCVz2PUarJqZ+EJ6gmsBI8x9yujZoVLskQo39H8hb6kO6ezyXhpikMV5/n4/UPsWpuVORmMSizp428R3kBWNz7wE+10ubvK3utPVERYouG5C3j3OdS12hgkQ58MYCdG2JB0LZdJgF9DBLSTJeOgUo9oBH7AI1GOSxcHigT1hQg7y1gxqhqSQF+YE9FSDmbYbvbw9kBpx7VA7uaz5sB6lKL+UlBKyEh/7xDH5dP2x2CDtlUWwl9hkQheFxIwkVnhvD/ZggjAAv0hijCa7+lJcg/HAhAsj5T6NKv1aq1C5QJ+hAtqLihrM8DVh943v/uPV6TSWyK5D5Xbbvtf6a8T0GEN65G9FfbVkFmJqo9UgXql/0IBFG4783cLFNeoUPUssLyFad++YUcGi7Y7fEyXIOH5x7QeozrWfCfGXsa5l+2vRpqS17SnlP37CQrJME3EYJ32D0rw84vAtoMlhT5tpbpDhJB6rbcjKnS9I51e9PcVYLWqJqmmU2b41rYMloW2ETAc0MeYpvqvSViqngYCJrjl9CewTSdjRbmI/oGD7u7+DSa9Y7g= +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Body

required
+ +Uploaded the file successfully and sent all post-upload events + +
Schema
    owner objectrequired
    + +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 + +
  • Array [
  • ]
    • passwordPolicies object[]
    + +List of references to the associated PasswordPolicy objects. + +
  • Array [
  • ]
    • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/import-source-entitlements-schema.api.mdx b/docs/api/beta/import-source-entitlements-schema.api.mdx new file mode 100644 index 000000000..0473a0d14 --- /dev/null +++ b/docs/api/beta/import-source-entitlements-schema.api.mdx @@ -0,0 +1,91 @@ +--- +id: import-source-entitlements-schema +sidebar_label: Uploads source entitlements schema template +hide_title: true +hide_table_of_contents: true +api: eJztXOtz2ziS/1dQug+TpCxZkt+qutpSZMXRrm359JjcnMflQCQkcUKRWoJ0onX5f79+AHyI8iMZz97unObDRCaBRnejHz80AN5XYjnTldZ1ZRgmkaN05Wan4irtRN4y9sKg0qqM5p4W7aueSJZ+KF0tpNDUVmhnrhZSxGqx9GWsxNTzlYhD4YTB1JslkUqb/qSFCmIv9tUC/hUyjiNvksRK1yo7lXCpIomD9VwYzlsswyhmbrpZHz2kwaD5UkZyoWIVIdv3FQ95XMp4Dq8CeIEkXPgdqb8nXqSAZBwlaqfCzFZa95V4tcRWGngIZpWHsrxK8PCCCKlvEuTDHsdO46SuDo+Oj6TcV+6JPKlP3BP3YG9//6C5N50ALcPP3xMVrTKGeOxL/OM7GMH2IpwWNKetFjKu/pJR/89ZFCbLysMNi690/D50VzjUujZgimKgh68WiR97oNR4dxpGi6orY2KuxGY4+U05MU5AhDMWe2As8BYnvSzMTgWJSRigMvECCcp4oP+QMb0MA82dm/U6/lOUe5g4YIh6mvj+yhidckU8ZwOrFJiXy6XvOWQ9u79p7P5yzmF2N/BdNgbPxVnA8dkGawX1N52TxnH9eO/AbZw05PFhvXHgNo/3Dw4m+7K51zzBeWUzeMlYgZnzx0aTjhMmIDoRjb071SfZRkT4ewdgvQjsJMKAHjFRoVcavBqeyJgeG0+P1BKmD72xyNVYqwhZ8lyy1VXb+vf385SGBpFonHWIJtJ3Eoov+D4JPDBswSNNPRUJMDQhAyuMF+QYLnKp2xdtVh95IvqbpyFy/ZHsmhHEnfSB6xezCt1iGD7x9Fy5lts5SCsjZ/46/H6dh1oxXzqbWBFCq8hwqJFFKdJxa6IfgEtGyld3EtqCtBRwjAhrRrFQi4mK+lMyjMDxE1ddqWjhaQ2s6RzrkzD0lQxKvH/w5Qw4cMm/gxlwrJi5SAQh26WhK5YZYfHVi+d588aAhn1BlNksUjMm9ojmp9LXChieKhlDAsuzKaNIYkz3wDP0Js2rIFlgJm2PRx+7l6Nepz3qwuNO/+KqP+zR79PeoNsZ3V51Bxe94bDXvxzSw2Gn/3N3cDvsfOxetOFJ97L9/hzbX7Qv22fw5rzf/9v4Ch5c9m8H7cvT/sVtu9PpDrH71aD/37/Av8Nue9D5CD9G3Yurcx57fHne7/yNfgxHg3FnNB50T29H7cFZd4R9hx/bg+5Vv3c5Mg+Z3s895K13eQZ/ng3646vbtYfDXy4768+u2sPhp/7gFEUeDwaggdvcI2C3P4ZH/cvzX24H3f8ad4c4WPv0tDcCEu3zW9siewnCts/OBt2zNjaxvAxvP7Z/7t5edC/edwdDbpZT6Dpb8NaI8GSbTQra0Kw8gSU1DLofYMbG495pGUv16Yf0hbUvDrEOBIUJ2GOyROwDcWSywjjB2Kn2a/BO5G2qJdCrLQbjPlospdbVeA7+OJsLmYB9Q4DkzEgUUjPc3N0JAXdpsG37xolU1rks9mYqkQKpAvSvU0AbTpxzeEOnYOqbiUDwc8I7hV5lIwtFToiwEaDPwOWowxTZVR5hRrpIw5uiMk3mFB5CUTnxQctAE8ai30Sr6G2bmfPD8AsShai3kIGcEUs4jQqmDBCvCmgYBViLo+dUAXVBINrTHJeWRtMQk9f9mfhYf1jgxA3BajD+GZZEBBoJFygfgCZSDw4yUzFDgzdvBaDleQjAXc/DxHepM1gbJCpUAnZQ35bQkvMXhFKEbsQIhZbC6GipMA0AESQuBABQfVuZtMaZw9is+EQB19qwmGfNdwQMjGuEAMaEnsiHBmVCGDehGzzCdEONgibJlggDsnmjgBkBHB6fMDM5p+GIiL9sSMTfHBMfs99HTMYPnS9sMUnAv2tMqxw1nvOMJICMkTjo/q4YyQhmik25FIx/gBJnO9TIcA7Kuwq9IK6JXgyqBaXDrEPS8lDjKwYsEGjapzvi/LR9ZQbSdubToFYygAlMNamKjOdrhLZsdKVr4qO84wQLajNhTsCizvdstDNzdedhXEjNE7WMzWidgy4DTEMyDuG1DExPNgS2cRY3n/iRNeoxydFHN5yye5ooy/ozQdYiAhPnysnuRcKbePRaopMxrGfYEiMpnVT3ANsDB1wkCBPtr3geTQZ+ojcmjq9h5ApnLoMZzL8YAqyyjVmtgYJ4zFLb5nqH5fTSuBIiOJwYJAyxDzz0tyRwULkZKMuLZHXE+WkNM7RgEb5IWUaspdOQh8lhapKbRbZOEkUIYC1/lDU3gI7HnIqWyzh7qTaR5zCJ8+tvdo7HQcvzxF3XMxAg9RgT8nNQpyXaqeBk9+sxf6PdFoFRgZVF6CoIsozWGZjrubc0YFmaR7nVgVkOcgcDpCNJER44wrzGNl/uYoMmdzKZT02ntJ4gzG4tPZ0+4A2Clu24LtsT8K4lerw8yPtXPrMEqLTM1E38wHxRDh+UxdIoRvmrDHvI6TfZsKZcZVZRO8KjrAGmmCwob23ijYNVibscT0Z7NpQYsGJkJeKEJ4kpR4Lf6Vxva3aY1Cc0NLiNSfLgIF8ELWSKYht9Pw2YX13rNnz+v9J5DsO+ZPnRYrZ4sZlmc1i3+9LhXPbsvBHLT3iT5eWZNc4/g5NCIWFtPU3BGMuEFNo+8DxtLuMWV1m5QpYNzYWBrteXvk8vLDctRm8eqDpJ1W/JjJSrkEU+P4Y+1tSDFaDwOJKi0J3h3Dr3C7kSpqBbEOC+QkZ1QcE8VyQypZgKll+z0vuG0kZZg1l4d9XUCyh3QdaYe84crXixVkdZr408Unn9sXpoystzZb34kWqoLdCAq/EUnvfpH0Dc8P/3/f55t325aQMEy46uivwVoTsqlzJLXNZjdUBwSXV+mirr0ZppyoS15w2dqaz7kN8yKHLWBupTWGoiXIMIkzMRk4wtiAjXin+m7LeQS3iHfD09X1ahZb1YZRiIMFGooZQpN6NcmoRO//ISwkw/LXvd5LVTekvV5ZfZjOGld8oANVMRbRZgNAg3lvAPDo+dg+aJc1hvwC9HHk5P6k5jr7H3fSX8ebKQQRWxMiaOtAJcLrwXmTBbNw/rgey5IdulAbPXz3gOAcSC92QtSeH6AveGXqdUmxkfzAntOVXJCt1y/RWpTyU0yeqxns7tBf4BDIHz5mD+C1k6oyl7ZWayeGFBNuRlyrgIX+wa6zNu433Gpe3ngmo+kzCIcUyLd+8g1757h4NELKkNERTQIWHb8klmJL8Gz8v/8GTgQuvJ8up9ug9aDNVpcEhjobG4n8kw0qHXJj99avRvJiQdJd14KNMvbQ2W4gyHGRsSjo8OjxrT6bFTb8CvyT7+5Ry5h/Vsb9f47fqcn60ttcrC8Ubsmmz2oREN/3wgUIHVWPXCAOja3SfeQRRfpRaGQC2/M4vtqrFHM5GLhvXGSbXRrDb3R81ma6/ZOjiuNer7/4MywjoSN91+Bx++BHRsyXwHN3uNUbPeAoaalpucBZqzAbzBvL9pT7kDgR/Wlt0oAmuvioGtAXFtKIXtk9BdUTUmgNjkEX+vtNnsqlh6fgfW4c/r7gP4ZXUWSXJPRSw7oWsqR1SfXIS4NCGSNsZTu2J8B03UGuK9dEFelq9jhEHdRdLBSnbvBZM55k1X2wV3xG3U2DCsOlJyclg/ae5PD/elbB7vN44OJidTubdXPzk4oR3xhdJazl4AQs9UoCLPwQIszMg/QCFgyKB7YoAGfznsJBovzOLcNhXT8CtiAOk7EEPfd67E/hFYczBL6LmcrSkhqI5xcypIfB/TsvHlHcNEP/Jm3sbsbvHRafdDe3yOwDTdEENaJXTaDmxqAVbBFubhV+LYCIA+p5VP9fOaeGeovkurqmlDszlhdv5NtIceZvQNPfKkxTQKFwVXIr/5Fos3Xk3VdiBnod/LGIDyRGKB0CDUd5AQ1DKunhtNvhNzADIqelsT7axWluJVSn7SdbnCSGdCElqn22IdJFTPWcM5mSqLs5EFkPP8pKBzAOcvgF5OnABzJGbeC1NrMSya+QGeWXNlFGaVRipdBbF0YlOld8KIKhSQX4VH+3TkwVR2hcAT2HZpxMrHRQp3F8zMaRzSO65ZPOt3Vz6EnyqJlr64U8b5NG0UUTRS+ZKmiUhmuUGdTat0uqzjC4j/vrv13a3vbn33hb67/nJgTtKZtwR9GmXoMw7wNEAYUfIsQR9eFAShsI247sQTuYNLFAOR/vppBI79RQW0g/5tiacJXxEfcSrfUOGw88HPJ/bsjk392Vwgg6RHlmAKkUi5LeI74zg9hrhf3yuP9iGMJh4YaLABIuLpA7EKE96TTgLagZV6hzZngp9iMZd3yu7CUwSkkwZudUl7sFskuUWS22y0zUZ/mmy0RZJb39367r+n7z6JJFOuyFsMTtLJYoG3OMjSzHuUVgpoIOydDpG6HE3VOlpBYiLFWJUicqhMmo1JY3rkqH1X7ruHeyfTpnPYlAdHjaPGZL95VMnn+uvMj1MnK/pUbr55Hnm7A88uRrydp+MwdIvlP1BvpKa0qR9nkBjmDgDcw02KHZsnG3bDwlBc4DauQUi6gCGDTEcY06DtAttGti0dFZ1BXAzwNIEX8pUTb6GASoRlVN9beDGfJFVIN1pV29MYRGFHsUaWjmJOxmuKBH6IqDkEw/Jwj26KmA8oEIKdQXR+RXRqpuh3IXkxQInPUWLR/eYohY6eIveDTfXdHh65xRgx5Al+pNAb2c2eJEjPvKa4c4vPt/h8m+O3Of7PkeO3+Hzru1vf/ff03e/A5wYNPY7PocGL8Tm0rdVFiqU+0IGPfzZMJ1cxHJB5i9Chw/1uhsHxTJyCh168okHwAnKHTbkNoB0903ODFh9/qzJya/F9rcoNXo/nixcw2jLUFILwAwKtyq659LB777kPu+by2W7+AgAeIiGIydIlkQ/d5nG81K3d3XuYdJjsh5pcejV7GToIv9accLE7AU1vCGLZvTBsQB9a4AFqNE2RR8ePycyJOE+aOYtT0TB5VGB+krI9e7YC6QST2cndBKLHeAEQliQ/aWpdIyssyQdyjSP/4ffLwoQekWWT+p4cDdoL4HRNRBThJjMUOiTCo5fMJctJuOZrlgbrY7OmeK9khDcgaBvkzV8/jd6KGaJWihqJRsCsPDraJcUVmAhFxbbdEsBOlKiyS2ztwqYLeqGY+iCw+DUYKiWue0YJl5AuBhDfSaXtwuXOmzd2dlx1p3zMpLVMk2h44Am7oKHd4qXQt5Q1aXnhBXwIh29cVM3dzex4PotIq0VxvbRyyZxcP8rEf1hqVaZWJWr67RoXrNprhw/xOBAKkIT0NWnrhwdnetUcPVyLwROkus4D30AlPopbZY6dtR/mo0CvivSKfPwafOITxoVu9vKYuX3VE848DLX6ixBoOugG17MEvOiH2aJjzVXyiGqznmOpykNWvSoATOLvHBwjYGOSE0zwhG9CgH6Byy75mWYWfP4zHf7/XJCZHl9DHsaWbujoH+YZB6zigFWOAdrwz2kODQuPnIEMFAfYADrZ/FMkMIzm4h7T2hjVifwu9aHzhcAqUdHLFv/RygKc+SXoBbZO20AYrtDHPczmId6QNbTo0H5eWbaysK7BMr9+CCl2TW/Mb1rZwrT7ryYvStzOCjD4zYnXjtKPRJJ/nbj7fxTxtpHmzxhpDGJGc6NhzdIib+TvDV4rFwQ1HeGF/8Nb8lUC57D0ye705gnhl8D4YhB4tTP3FJUSlkrGiP120LLCBXkirPrR/ZW5hDqjA8oRsCxh8ef5QI+K3XZkSQ7DwBLnFf/WifmCUWguL9fEJ/MJhghXdnhcA979Fpol3hBmhq7Ei1M72QC6FoskgNHQL5OFkGBSz1gEfqAi4cBlLheyCPwFhLSX9WI0NRSB7tmoaKH7U6xSwwI4N/HPjAXzrk2JGlSf3aGqZIIMlE+Wie2KsP052mBt1bny6RQ7RF0AYCo3wkVvVKIIxALzoYUwmu2aTnoX2wIRXB6x+ezVGrV6lZYL8BwXW7AKyxEfm2/KmYtK+ZXW+ufl1k3zPivY//HfqDOJB1cMu0ssmKE4Ca9geO14XTFrR2jdog/HmeUjVYtyC0hYksxx0Qk97u+xyoIrqgd8zF+Nw2Wl/SxJ7vbFI5I/+ZG4jVx/UVgmKHySzlQDKvTlOLtO+05G3gzMJ+be0hZV/gt6G9mwNclglWfAsgf96N4Dl5mIFX5h9jWqdDUu67jpI3a4fuVOXL3KNS/t7xRqAld9+vzQxHw7b8HFESRMdHeyn63rGwPPNqET8wMbPTz8L7NUVkk= +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Query Parameters

Body

required
+ +Successfully uploaded the file + +
Schema
    attributes object[]
    + +The attribute definitions which form the schema. + +
  • Array [
    • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/import-sp-config.api.mdx b/docs/api/beta/import-sp-config.api.mdx new file mode 100644 index 000000000..7f8b90c6b --- /dev/null +++ b/docs/api/beta/import-sp-config.api.mdx @@ -0,0 +1,168 @@ +--- +id: import-sp-config +sidebar_label: Initiates configuration objects import job +hide_title: true +hide_table_of_contents: true +api: eJztXFtz2ziy/iso7sNOpkRZkuWL9HLKduSsUo7lI8k1O8dyeSAStJFQhJaXODou/fftbgC8iHLsZHLOzkxpHjIyCTQafcPXDQJPjlqKmKdSRUPf6TtysVRxOlmeqSiQ907DSfl94vRvnMmVa57dNhxfJF4sl9gL+kwfZMKWKknZowxDpkkwNf8ovDRhQawWjLP3k9El84hCpsdjgQwFk1Gq4HUqIh6lTXa6Yr4IeBamDSY+i3hlyRHpQMYwivhCTzg8EF9kksroPh8tyZb4UvhsvmLJ0tUjMp7AGHPufcqWbC4CFQuWPghLG9jnaSoWS+jXZFN4YZrivGL1WfpAL1HQhafUL0l5KpgK6I/qpJaxVDFL1Sb9z1yGfA4ThsFh0skS2MX28FcskhQ5kgGLhPA3ePB4BCyz5JNcLs20REpznjniixdmvjilljOHho0zFGp5eEWKSppsGBRSwKmJGJhZCL+hW/t2RqYJiRyGzkVgyA6J7FgkoCWULD5DXvDpezUf+jMHZwAjGN599RiFiiMJliXIOnbZy9Wzp/vuPZVorPdsLyYif6nATpqz6FeVIdFIpczL4lhEaZhbCBkaEr5UkTtYLEO1EoJdyEB4Kw8E/4FH/F4soA/76XJw8eENqDSLPdFkJapZgpYBrNtBUaYoDwYCAV1pTWF35vOUN9ksOofHC9JfhOLUZsDnKtO2oi2TpaulSLQFFZwba81nkEVkFDyU6aoBdhEIMqWbCecTdla2s9ufHtJ0mfT39nxwkxCduJmAiWlBeWqxJ/0IROglewnniVsx0r2/5W7iGsd5A8JFo4vFvzJhPRmtkeYQqDBUj6i4RAD3wB1LPBizP4tc8LK+pt5fkIQhaCx5zBciFTGGjidHYpQAuvEK3kXwBv5cxuKzFI/wIPEexII7/ScHZQSv5kqFgkcOxhkKBU4/4GEi1g0H2ZOx8M2TrZFImzsaOIgC1IhzUOxeftY+DxqOt6jqQT0ysNbcZUxQZI8qC310AU+gozzK9IGa888oDh6tmAgCVLDSzpHy+F6keTwbBtqccokgXzMHvXTmNFik8shlvU1zgEFgGCWp4NY7NWPESGJagwxd+6DUhuIqj3wb1HD6EGNU+FlomxIRdKGpyCgfzzKig48hFWsnJ4o0JGg65dBrAWOCrimI4ANyakVSxNAmA+lVxoIflgeYEIktjlUMgTFJlCc5MoAM0TxgXmZaQLZBU8nHk5EvPU7x7/FBeg+F/EhRZQGCAYkvHAIBGhVK3FnfahMCCz9V/gptbtOAKEAvXHRu0BMaK8RVEGQs51mqozd5BEoEhYHhZJGBx8wxCGI3iH6zaBbd3Q304Hd3+CeD//BtH1ppd7nT0e6utd9tzXsHR+6Bx7nb7QaHLvd5x/X3va53MPdb83av+TFRERiMpmMCep896b9ZsRRMMczMnD67uW0UL2W08XLmTMfDd+8G47vJ9enkbDy8mg5HlzOn3EkLdqTHwl75aPh2e/9Ko9LI/tDXA8Ojdm+/2z3kbdfr7rfd7n7n0D2e8yPXPxRiHvQ6nV73uMxJldAlaARJ3dwW79f257rEvokd49wI9cTzThuMYuzBFs/NbJMdXzeei55otw99t3UsYDK9wHP5/ChwA35wfCB6h15PdGudtVXRWBhrp7G8vxfxzNkyo7JCNlb7PqMYqN+vtclNyOLMCs3OZdn6zIRn6cwBYJVINKg+azeKx6kE2aZAQjPXaXXabuvAbbem7YN+u9fv7De7nYNWF5/2W618XtSXAp7umBAXU/Ok1EjVjAmepl8xXv36m81Xd6sZcJSFoW2wLrOlQwiRLvP1rKToVSLCYHMm9OKVplR0KOwhRXtIrT3UGlqre50LlXuvN5jXU36B/X9Mp1dbuAC9ApAlVjCq1t4jMtFgZRt9aJDFoR7AYphQeTx8gAyiPpqhd5JB1I1SCv0qmuYsXo7uTq6n/9jab84T6WHHghm0gG0tBY9FPFWfRPSq9sjRW5kseeo9fFC+4WXy6+VZVeo1uaN4tXYvc52feLSAjw3ymmTzhYSF298ieVhBl2DL4i3AglBGhsDVtL1FAK+3KvNmaIwLgGOfE0+uWStdBBp8iXkADzfsqvgj/3mbhySnjNjIVhyzZuLSu4DwLAEYpXv5kouPa3hQ2yrCyhhxWSpFQiu3aW9aJTCNCDNWjewQR8qIE+SsrvGUiebrt8UuOVJPCPGXYQTgThO4XmaqHMnq8GJU5AIM1WPHMr18kyxHpczVJLuA6AFdE6YxDPA45jg5CRgv2SYHEWULzNyHbweX0+H017vR6fvB2fTubHR5PnwHDfIXV+PR+fBiAI/G1/S/yeh6fIY/puOTy8n5aPyBfteDGRYDCoxluq1BYOWQ/Xo52EUeM82vSQGgcUEeIPcnBKKx8CB5hpWeKYjarKyJP7bYtrZAIVYWsLoUT3xf6nTRIkKTfVCiZlG4tepYhISyQdKCA25GAeSFgrI4AylCvxBYbug8H+6qYvJfd4gSAHzWDqT/jAHYbCw2BvBNeszl+xqMVjZajTGf5fYrBvtj+CVQqAcDtoCvVKb0Qj8bEGkN8axtrEv9n7Yb1KYubl4nl9uaWG40gx3nlpir4ey64C4ktFfBtlKILhBBTu4/k6UqK9U/qQ9XQHtdNH+AeucwYBUm8TWt1bVaIBbIsB5o64YllTxXsynLiB44ZYPeMOJKgedGL/C3VdPWi/73ZtBOZSWvrtU3t5ur1s2zeq8F5v9rj7tQsWSF2231upvcD7ZyA1T91wbDvEpXzk+perJhzrout15r1WlwSgKB3LFu7CYt/ajmDAEmmh8VdwBkZgh+IG4WdR80rhJYBPgZGvS/R6r8BqT4EQvK2+JElb3rSP4rozo4Bw7uIx2TqHwHFKrlpP3uYW9+fOS73WMPTG6/x93jw+PA7bQPW61W2+fHXhujMu4UZFtjVHXsCbWzBXg7nAljl6Pp3WR6Mp4O3mLsusSo9W48mEzgr7PRh6uLwRQj1tnJ5dng4oIanZ8M8UclRuVN19ZtX+IKHaHEE4QoCT/t6obrXBGbLbODf16NxlPk8wP9qLBgnpFPL6UusX4Vw4O/CxfrEnXesNgKL1gGaWFoioHIKCQUMuDlkmp188XuK1QVmhc72tNOp9/Z77cP/wf59GKBsOn3MmkkyB4hMoNN1OuTz42/UD7AuN/PgNFiyMGhsyV2sJtUNdvezspGcNY+lRu4saiKXgvhlaZxW0R/u8v4Xs0dHUK6rVY9apyFEousA6wXMxfy5DSL0TelnpHdsZgrf6WL/pCkSr9J2ecPCiC+gDwxPINM/2WfOYe83L2PIa8EHqnIDWmLb3fRcO2mzSJN0qqF2lW1ALJottkp9/PKwJmZDLpvDAEYaH1DWLNdML7ZKvaWYcWR4PPDVq8Dq2iX885xt310MO8FfH+/1Tvo9cgmTTG+NLaFZNWh34lIxJCDUH1H/i8IBAwiwa1fhMg4+BYU94wOiMZrYhZaObXNp2n4Zan4AjCLs9OzK9Y9Al+I7jN6zu83hBC51xhcsfyDcUMXL2DmmvAIFkS5NW7ZIPh2cH5yfYFRcDz47+vBBH4hrdrW+UlkNzSAVbAF3D9JiwlQtBAhiAOB2s+G6s8wIR4l5YZS/5WsEszqDDiAHmb0LT3KpIutU+tM5DdfUvaTbIpmA2IoPFtgtQvwIGJ1s9n18wkt4+6FkeTP7EFwX8RvmqyUnII/AlHov6Jg7Je2koMMnFnku2oAMKUnqrooRFnVRhFHLspKQecAzl+2kxMvzYA5mmbZC3NryXNj0g/wrCVX5a6yZ4oiXUUprD3QIwxXIMY4xoxnDnOTsCDZDSOJsl/wyLazMasCjingfdDMvE0VvfN4lrzC765CCD8uTS1/QWkVOh/lrmZPnxVJvY1IZlWgzps7//kunK0R7Hx357s7332N726+HNtSvn5L4KddBz/XEc9AvjEtnjXwE5P1RIrZRvqbBa3IBuFzLZ33v0zBsT8J+iyCIJrGnz8IH+mlvF6gzPWhn89tpd0u/YUukEGSo/k0DCKR8PvEd8ExCUqLar8+2rmK5xIMNNoCEumjj5XKIDkAnWcR1fx50oBkQCTR3+l7DsH0rkee9InId/X3NDskuUOSu9Votxr9ZVajHZLc+e7Od/+cvvtVJJlzRd5icFKSLRb4JQRZmnmPs+UMGjBbt2e5y5GqNtEKEmM5xnKqyMGZd9rzdnDkia7Pu/7hfi/oeIcdfnDUPmrPu50jp7zW3xR+nDtZ1adK+tZ6JBEDiMOd/SwC40pSpfxqATDD71UDDGsYenLcDDIHkd4W2LFbx46XKoW5AWHAjvEzBcbr8YXemNTkabMSvx9HmG13NnFPEyElbZXRZt0OOu6g42752S0/f5nlZwcdd767890/p+9+E3TsvgQdu98AHbsMIVaAEOs/CR19wB0IzQKJx6PsSTyG541EAr9M9dG4vTnLZYFeBUV2eltODymFpwxXFiwllUpkVIgLwxu0XWDb2LbFTwjpmFqEX1hJpY9j4t49YFLcrw/lQuYnVIFuvHJPAjxSpn3G2ls+ivmKKKGgECp9QuuRyzT/JCxeUR30HgL1D6xxGm39rnowG+OML3DGbPDFo2OxLK//Hmz7TmAIzMcYLiZa1898MKBr5jyCNEJ8WerwlUPQHVTfQfXdcr9b7v8ay/0Oqu98d+e7f07f/QaobtDQ81AdGrwaqkPbZovlWOqcvuX//0bs5CqGAzJvpjzC6n6BwQlXgCkhQ3j5DAYRnj7AX6WLRfTnyfBK43/NThaH0MqePX3SJ5fXTb6UTQheoKh0FalHukRjDqLZEnXwM1PtYdiAnVwNTYLRJLnGEk1XxzkirqVszkU4+T0dX6WMX+Cj+laQe5jrJBp4dMaYET0GFpeQQ/w9odZNMpva/GBe13G4/v1z0YSemcs28X11NGjPgNONKeIUblFd+poR0tc18HOmgxSezsWjGuU2EwTlmsNay2Khwe2ATo2hETbrsFM6/2u+kPnp/S/TN+weoSiFAn1jjfnynbMrMCMKdSf2axHsRKtPrLJ7/Q36SeV7HHQtFoQgFDaLJkKwm6ER1CWsAWMI2iT26hnn193wAlLc45V+b2gp3LyQpok3tbyVsb51KKE2ZoqUArKbpZ0XL83re5n4m6XmmpPERC15s8GFFu2Np7/w9mJBYuFhQtL67sE1PbdEDxMseIJUN3lASRg+ql9ReVZr381HhZ6L9Kp8zKJf6NRCtRvTYY0lD3SjyZB5D0ol4r8YQ9NBV7m5z8DTvpstOirhkke4nVaJJVcP6UoXUCPxdwGOEWljKq7JAcRH9RNy299IsxAXfqOjPL9V5kyPb2BxxZZ4GdF384wDujigq+NEYvjXaxcaFvg2zoHigDaAs0L/FAkMo6XYaG7p2Rb5ifwe9cHlA287IirJsq//6BdB0PzSdyJh67wNhGoE3fl3ZXiGz9DCBawiLFsu2JRgnd9Qwbq5ITfNb77piWvpH22+OOOToqoyisLVj47Sz0SSP07c/Q9FvF2k+StGGgOD0dxoWHuqtmTkpwbT1at8dNGdgH/hLfkqIW7IZ4p7uMqEliFP0arJq70HKag+sBQ8RXzYQMtSC/JEc4TT3DDG7ukMWAwsc8joJF5tRxVsOzInh9Hgky4tg7+TzHxPocAkId8UTfYLpGyRB2rBdA2/5IV3H5XJ2yagmSu6re+tVTaArsUii/CqOmA7WzAOJvWCRfgy8TIduCB/iISVhSLol/eyXoymhlOgY9AiXiSjAEvPkNWWFP/CWKD3xNSdQfSoRXPytpjIGC9uoIPGjQ1o/xJtsDb3QYRLTBgh6gIAE6URPgynNYpALDKbHSq+3zOdkj1sC0TMbUjQYb/ZbrZcSingOeZfkOKWiA9B8nirW7JxPaY9ty7zo8CblvlUFOF3N4vubhbd3Sy6u1m0dLOoAYqY4e8tsWqN4SfTVQld/rlxcu1jwVkXgG4bDl4vhm+fnrCsiRWRNT7W15JimQGiJt1rtv1u0VpY2l0zurtm1B7j32qVnwTWYot7bk291aF7NGxhjYpZYJxUSicz1N3M3q071afqbd9tV6ZhyU930hX6UvPaHjYOnVdNr0a4V+HMzU2oC10ARsJEt1H8RCbX638DrWflug== +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +## Request + +

Query Parameters

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* ObjectExportImportOptions
+ +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/lifecycle-states.tag.mdx b/docs/api/beta/lifecycle-states.tag.mdx new file mode 100644 index 000000000..51bf4a31a --- /dev/null +++ b/docs/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/docs/api/beta/list-access-profiles.api.mdx b/docs/api/beta/list-access-profiles.api.mdx new file mode 100644 index 000000000..14b69c5d3 --- /dev/null +++ b/docs/api/beta/list-access-profiles.api.mdx @@ -0,0 +1,121 @@ +--- +id: list-access-profiles +sidebar_label: List Access Profiles +hide_title: true +hide_table_of_contents: true +api: eJztPWtz2ki2f6WL/ZAZCmEQGIyrpu5lbCfjLcd4DZ7sXsc100gtrBkhET3seFP+73vO6YckxMN2UtlJLh8Sg9R9+vR5n9MPPtWihYh56kfhqVs7rAV+kg4dRyTJRRx5fiCSWqOW8llSO7yuyRfMvLlp1FyROLG/wP7Qe3LrJ2x4ccpikWZxmDDOECCLPLbUt/k+fB8OWRr9KUJ276e32K3BRpdvfhsevz09b7DL0dlJ6fP46mf1dTy6ujwyL6NYP9AtGM/S2yj20wcG+MTiQ+bHwoXBmMODgKUKyyZMbcFjPhepiHGCn2o+zuJDJuIHeBfCG/jqRbGVZFPuzuFto5Y4t2LOa4efaunDAt8naeyHs9rjMjFOPbaIozvfFW6DwaRxEBhbKOIAQkQb7jhR7AIExO/+lqeI852f+NNA4CPs4Yeu7/AUupQosWrqp64IU5h5k02g4x0PMoHkRyhmrjiCAJrDJx6aHuz0mIiJTZOFcHweqP71+lzU6w3AzndusXMC1E1veegyT3VAwuIcNLBXCYBTTO62WuxnDrgDIwTMWMRxFEvOKEL4EsF6vUjrer2MMeHk+UIOWkQ8VVQLIyAn0/2RveIjny8C5NKB0x60RK9/0Oe8K9wBH7Sm7sDd73S7+3bHm0JjLSi1Q48HiXhsrJaHwJ/7aW2Z2+dRKiQikiRKEXBac/7Rn2dzRUx8TSAQ4/0W0GgsBLv+tUPtxylQlccuO4qCQDgInF0YGb354TZNF8nh3p4r7kSAqttMuB8sIj9Mm0403/PdcI8v/L1EwbEcA8fKZf1HwmIexSha8HFOBqBZpUGBgvutFbIPw4qZiKGjhCIfdWx4ABzAWdcOoZ+igATiCo9nQYpfHtfROPK8RFSJPKLHgLPSCy8DdY5FAuAYvGiyqyQDQXwoyArZljoRvI7qtOAzP+TEqzjKZrdKIxFE8s3w4jNYYai/nvhOlIVV2oM5q6dxJuoMRPfeB8IvokUWSFKC7v7TmkQpD6wj7F1Hki6iMBHsVnAXFJj4gA3DbD6F72CTFNWl1txHWeCyqSgZBc03tDR1KRN1di+QVLMQKOaShRn7oSPIzIN1QSPEgdGACqOJgGkK2S2/E/AYeETEwfb+fMGdtMGkIsYCODYXIRhrMiMgKYnAUesE5CeaeV0aKsBWqjJRAVsD2lmisfkmJAjns0KIplEUCB7WCnIibeE6WVF+7Tl+8TV1MdzPEvJ96HQ0tZKHMOUfmew2RVEIvzJJ/ybnBZhZCs8fkbev9VPyR9liAW5Q5E7QA1DRPb4G0xO4CcmtjK+iODlECPW679brh6wuPoDohXX5DIlpnib36qkTC/T59GIGkhrAv5mAv0I1mEcuGbn1LaL7ECiwakilLhyiDPVSvUiiLHbEUp+SK0VsmfjA3tfGQNoLJC0bS2K8rz3djyZIvI2iUzBlqJ3cSgSyCGhSlaoxQPuLyxROeFmixvLZ0+QJ+EGi0mBKNBosF4EKixqWfvl0nlD8JWZgCFPLd78UbygSFmBPU9IItJhivkgfGoy7ro+NyGnrGHkpVZBBcASuRMafHOwcTxLwADKmR0qNJc4/gC00jiaPAU6PZb4BeKjJkYVEojtZHMN3GD0L+R1wFRWiofo+SCmCZnkgqkUMxAf8CoWy5UCzNd13Bp69bx10nJ7V7fdsa9DqdyzROfD606nNhd1r2OLAPWgftCy7O3Wsrmu3rUEbmve557nTbr8zbT2Da+D/gswVVhaq6RHLn2Lc0Q1U2PXuVlBuAFJIrlAGSNKbU8oC4T86aycCQgIdCsNW0jyGYcOSVNWR8HxK8gBjKFEokLy+YkIQBCSMqLCVBcrXLRPvBh/JaSRIFbvVwj/luZ+tTlcBPM4WMMEufLEIMB+DLnt/JNjvU5XaPI458shPxTwpPI+mf4BpqIRX5QExM43R0qS+RNZ3V6ngcvYtQNR1tlcBmIuo7QxA9g54H1Iit9UTrTZ8GoB8Oq7d6g9skjzujsLgwYiIFLVtKJyja9iOwAn8jR6EsFwOHognwsLxrHtI2UXFfFTHDCHsRz3VYcyStcljIJCyKEu3YVOw+oA65ZSBQKkj04OY7RFmBEco1JlGHfFV5ng7fY51uFxGh92DcGsgBcsKYwgr9edL7GuBuWh1rFZ7YtuHHftw/6DZbnX/bxXbjAv4LNQCDlqhQTWfgaE9sVuHgKS9HkMRIivd7XZqnZlagTPWNyRYMkAbW+DbkD1EGZtnCeaWZHoYBPmABBqDULCTXCZKlkZNgaKsqi0Z4eO12rBsDnKhVvarbABk8yoTRYiJ3XXt9PjkfHI6+Ve1KCfRwH5YE4KJUzAhZwuJiyoEBcJLGeKAJhmTbBD9VxroK4beMlxkEF9G2PzeTzCfWl3ZobRIGumyazQ4As2eYtBMgcd3V9gv3u15HHJL0W21e960C2bswLFbvc6g9mR79UsGySAZHyQ9c/1kEfAHFhbMmAyh2SkoALwBgpUoFUF+mspokrOL0XiCDy+Gk6NfSPKAkJRhErFBYxwZmqioo1yeo4FeJSUkPovcKqCsQfJWI/nVwnApPMihIQlGQsl4f5WD+lwPNCbIMiCT/1H8tlobIaKLHF8ZwGVWD/r9DjC602uDq+pAhNSa9lq9tvC6OINtqiFLpKuq1YLUooxvQxKUB/f8IUF+q+5FrNSjJ4sZjrRKtvJJq8FLo4yOx9bw2NKDFbhYqtDLnsDTGlnT3HutCEY2e86hqdaXnGABSxNclxlIsq7tqa/jNIqckbWYxchYfSpkuFcQa9COUAiXfK2OKDcZ3yfGU4VeyqbLypDKChyycTBTThNpVsR9nVCtHQU093gykna2IHxk8c5O3sJflMBCDFR48UR7WB7t9Li5QVXsVrsr2h3Rtu3WgL5sEtfNclEetyjIZQyOzn8qCE6zO2gJzxX7jdHVT6N4dhThh7GI73xHHItF2jg++umXfwyP8W8QOTwoyXhhUJLtRxnRq5rFlw4XCqDZnc+VWOjHTXak80RIufmfJErhMpgwQleSwwGwUYjFaJPYU2bvgC+I5pjoao3Ja6Pi3hj3I0x7wPGMtKZAtgyuBrRHrRXJeHEFHgSOK+eCiyqojVi8DKVKSv9fzKLIs1QTKRXeSFoovI6i0PNnSP4ttqREQNRs6JbJlcZ8icQo72bfI2uzKeEgU7qV3F/HboVEHowpO4OElCNKB62W65gejv0BT00ZwMBZJtEq9SkVT/FB6PPg6OXTAC5D1gn4wefVuN5jGAvjfAFs5Ug8GGNOK57vRyiJVpW2vBAnFlLYCHgVybV2vSwKmgqTLU5/eHHx2+jd+cklPNN/1Vqp/vp2eD58Q5/ejH49uTwfnsPLN5ejq4tqrHCs6oaJWY8F6mecYsBZHGULswipagy0fKsWKjU9iQhN9isqZqLqWKrIhwWqet0gjbXXiY4JTQqRlx1kqdY0LWUaBXe9ZBgAm0sQM9m5SIwKDBW6LXv+iq2RoBQhEcpbHvJZDsdE8MpoFlguuy5THmEM2RvkcEjLNG+QuA0JjCLLfBHa1PemD2r5WAvHqQvmjsxcyT9V2GxkHbu8oNLg6nmaqEKDa9CCkLT/pJlFuUXsK7gUEe32nP7goD2weG/gWd0Bt62pcKZWG3x8v81Fr+f01geEw5L6QrtCw0vtn/wA2FIjp3oXSaF6poW/NB2fZuWbW838V7U7y8jvTNDOBO1M0FcxQah6uQFSJf6nqPuygq5bYtZV/NPjBP/oERq4fs9DiOFpq5UsRvjLC06qGkHrS6Vw+Lrm9aft6QHvWPuecK2u53Yt7toD60BlW33RHkAPe+BMe06rZ7VdfmB1O4JbB1PRtaadtr3v2d0Dz+a1m0eyK7jTK8JI9AhLzLHPq3XEd8S8wn6nW9DZOURsPqCFyOMOBcw1qlUXuWBWyRBK9ZaGJIL4iGt0iVoXE5g9kNbxGUTKSaqW4MxomIDcRvgIc3TcWKPnsrZIsIKhhraf8n2IWPlAi+jc+oELSRdtzCu+HZ4fL7+GzAhMY5aiULgYRRfbH43OJ8PT8zE8ppwIHoFmcDD5uKBW7DqXpmN7/7ETpWnzKODxn7XHGwTzOQie/ONqeFYE/8af4rLSMnqpCMTiFuh9TntotqO537YRvZvHbZ63AGe9PzNono8mv5kvhWF/GeL/cvbAwooHG5tE2IxHYnuxSg1KtRI9mLYhq3qMzBzQpuZke+aaFe0ZMt1V0SrF9FEuJtTrBvl6Xeb41F3i2GA5cRpM04b2VQJ1GsUEvLA1tZTlFxZC5d6k1evMYs79oKJSj4b5z/UkY2qmqga4rC6SdA1N7vfivXRpjd0Qxay4mCdbiASkyen0WfQxaz0GU7UpVM7NQoK4DbN/bUqFAHCIab6RgHzkIvZpMUyX8gzNHR4HQjQd6NJ2Bt5g2vPc/0U+4JZCQACScVoONJr/0tXgY+H5IQRotGSAM3WUkOt4TjNFiqexvSZKysOBLQvLO83faf5O83eav9P871Lzd5r+9TR9DdGHaACQMNTF6HOT6WUAffylREzQKKTa6LJRXivV2zbMLoQmG5oTJiTRscC3dyKg3NeYD6z1mJWoRmFNNBDcAwoC0iVCIOyKpD1uVsczHLZDC42bF4e+XZI8iQT2jgRts2IrV7qu1S4ptQZt9p3crKkgYc0IIXRX7dI8Cnxc1z+h/S8WkKx8jkyXo6eRSycA/RAsnk/FnOfu4lyTL7siBYtwBOTZrv+vwZ9bs5j7iKHcsuNAR7WCh7SmoxsSpHZKK4w/UKLZLu3/OVKTQX7E3MHy5uoaYhmhq9D/gPZfdWF+vuN8lc/pCz7ttQZ21+t1ObcPuu3+/nTg8U6nNdgf0GarOfCNz1ZW7MtDvxEgAxCa0HK//2+By9A8UWsFNPjTy/AE44mbb2RbM02FL/i/j2kDQqafjy5Yt88CHs4yes5nS0QIravxKscrAY9if+ZvjKOOT14Pr84m8OQSfOLJGD4hrEq4NAz1Yc+IKti30T1hrCaAmzETgbtV0WHWFdQ6TIiHSbGhL78lDxDDzJla4YUeavQVPYqgmRdH85Iqkd58TNkPflM0G2BqzH423APr6uJjHXV4kVpnipJ1dfzrR7BHZqu/jD8SvZ+Ou67cQCdP9IEqy+ol7twFx+47Sw46J+WyhdWG5KzIFFQOwPwJftpJcTWFplnUQiMtCsX8MK6kXBm7SYFoRFI8d+LALOiIgxPFMW43gMAFzHbClDmitQQwPKFuZyxWaUcMYvNWInOcRvTO4VnyBL27CMD8WDQ18+JOKOVLTPnWFYUTGdoiqaiJOusDzZoWWvHNSsdOd3e6u9Pdp+ju8stLdTZFvaXQp10Nfa5CdbkBOs9K6BOrdEjfgPBvGTlKRlIapkKkv7+bqMsX5NIPZWBfLj6SrryC/NDwY2mVXrv+nBeIINFR7SUASyTcQ8I7x1gGiUSqTnW011E89UFAwxUhIljNmDb9YwAcZyHtBeNJg7mRSMJXqToxLCsoZAHpxIBryVN/u0hyF0nuvNHOG3033mgXSe50d6e736bubowkDVakLSpOSrL5nMcPUtLUezoMw6BBftjbqJxZXihGKwiMmRirVo4calO7PW17fUd0Xd51e52BZzs9m+/32/32tGv3a0Vff53rsVGysk4V+C35SCSGIA43xGchCFeSRpFbLv9leCOEh2YNTY+Jm4HmTdwWo2NHe1CNHSdRhBsJH3SElJRiyDCnEdo0aDvHtrFuS2cqZmAXQ7xyxo/kJj1/LgAK3pEgL4BC5cVZANz4wRp6eEBB3ZajhMyMok6lJmQJgkhdFsZ9LPp6GPMBBIpgcbPWF4xOFYs+K5JnlzjjM7ry6uSjIwQquonc91fVd0/x6AvaiLFk8JpCr8x2ON5AAAmBtFkm7tzF57v4fOfjdz7++/Dxu/h8p7s73f02dfcZ8bmKhtbH59DgyfE5tG22mImlXtMhz68dppOqKAxIvFnk0PUXbh6D0yEQeIgHQnCQK4jrj6QoDyFoR8303fBQVmOthdwgcIi3dqAdqr6R2/hrN3jl01yAjOJMZ3Sf6IIjvNpeuQdddEahppxlFgfQSF/79gmYD0x/bPKF3/TVIYwwuqe736ZA8RXGTN58gIKIDeiWOTlAk9gV+6gR0nwScMk8dQ63Zq6X2whZ3yTxEGVgMAlMAzc0Kemkx4DiAlKTV4k6rv9INzkuzQ/mdRUHj58/FwlozVxWkW/jaNCeAaZLU8Qp3OQCUzgrWBGb3Ddh7mdXBhthM5v9LHiMJ8VpOeSHv7+b/MhmGL2S9ZBXCerbktkFiAhZx6FeGsBO5LDy62SHpcUX1EbmBTBhpm4H1Qd5zsFtXIKdJ5JiJ0GmBXs9/dJBXuq35i7Q96HFjv1Y3nKVUBs1RXkrxvVCz4sX5vVSJP6moVlKzQgaXnhYwkKS9tqRm3kcMAkIggcJUevFg0t4VgEe5mTwBKEu44CUUHiUl8wczbUX41GCZyG8Mh7vw3fyeFapG5MGS9+xd6pOWf0PYyg6qAbXswy06MVo0ZkwizTCslsFlCw5pOVbEGgSfmegGKEUJnmRGsU5EYSAoStV8nfiLOj873Sz4++lOdPja/DH2NKNnGfcpLmEMw5o4YCWtAGJwl+6OxQs0G2cg7wtggTgKOc/WQKFaMHuSVgrrTqB36M+6BocQJWgJItD+eUwN3DqE6MX2Nq0ATOMcbpZRMTL5xUs9HklYukKwzIFq/gGEbjaJbpJfE2FC93vX22+OOPC8WG8A+5LW+k1luSvY3f/SxZvZ2m+R0ujImcUNxpWpRhFIf9ZxWvVwiBdzyXwQO/FKekqBemQAuWnd4uAFgFPUapJq51bX1BJYSF4Ku/LhUlEc9JEiKhR/SFxJEAzuqQoBpR5oM58U9Fbj8xJYWRgiXyV+5HlnTx0xBhSVNFk7yDLCx1gC2Z4uG0D3v0RqVQvv4X6WDOb4VU7WYiHpQHtbI43im2TCNdPnCzR95CFQtOCNloz00trMYoaToGutRDxPBl56m6rAuO3jAV811fLAunpyg15o28+kUsRyEMz0K4ctm+DDdJm3YpggTkmWF0IwERhhLenkwpEABaq67+jeLanOiV72BYPmcDkpfh0mu1my6J0AU+xR0kKKVcBOJ2/r16hu3Stq6nQf4O/G6NcFuYaewssuSEhMpn7yBzzuracY0LWcgukwlefPmFBBpOuR3ws73PGzBOYp65DVbeArqXZ7udl/vs/L7NSCv4UWLhZ+tUgfSKfzvQ/ncnfya/KbKCT/jWdFxLo/9cvwmygo/nFnBcScvfzLt/ez7tsEAf9Gz4vlIbdb7R8k7/RsskfmR/qeaFI7H5gZSN981+zebkB/t5/JGVbuFT64ZkXkvEb/fGSDaRZ/esuOXlu8kUYSCHwrifpkymfkCDkem+hV2VHVGmp7M0J5oZ8TXVOfcChHh//AycfdzM= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Query Parameters

+ +List of Access Profiles + +
Schema
  • Array [
    • owner objectrequired
    + +Owner of the Access Profile + +
    source objectrequired
    entitlements object[]nullable
    + +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. + +
  • Array [
  • ]
    • accessRequestConfig objectnullable
    + +Access request configuration for this object + +
    approvalSchemes object[]nullable
    + +List describing the steps in approving the request + +
  • Array [
  • ]
    • revocationRequestConfig objectnullable
    + +Revocation request configuration for this object. + +
    approvalSchemes object[]nullable
    + +List describing the steps in approving the revocation request + +
  • Array [
  • ]
    • provisioningCriteria objectnullable
    + +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[]nullable
    + +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. + +
  • Array [
    • children object[]nullable
    + +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. + +
  • Array [
  • ]
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-access-request-status.api.mdx b/docs/api/beta/list-access-request-status.api.mdx new file mode 100644 index 000000000..daed83cca --- /dev/null +++ b/docs/api/beta/list-access-request-status.api.mdx @@ -0,0 +1,188 @@ +--- +id: list-access-request-status +sidebar_label: Access Request Status +hide_title: true +hide_table_of_contents: true +api: eJztfWtz4kbW8F/pIh+SoRAGjI3tL08RjCdkbeMX8Ex2Z1LeRmpAGSERXezxMzX//T3ndLfUEgJjj3PZfajKBCOk7nO/9enWl0qwEiGP3cAfOJWziudGcde2RRSNxO+JiOJxzOMkqtQqkbCT0I0fK2cfvlRuIxH2Aj8Wn+NuEi/gWsV1/DNOT1qhfNSK6NmzUHCn8uvXX2uVmM8jvFfOwNQUUQV+ckRkh+4KAQEwJgvB8jcxCQjr3gxYKOIk9CPGGYLLghmTEzM1MZMTi4hNeSQcFvgshgGjlbDdmQsX4K7wka14yJciFmFU/+h3/UcWB5+Ezx7ceME4fOWAWYAoM5v76dgwkhuy4MFXs9RZ13xwOHp71z2/Glwbj7sSMjeEqeMARvM8GMaVyMCFuYgNXFLgZwHMA9OFDL4CkMCEDGRig4u0ImTgNx9+ga8KTuFY8DzyzV6IJa+cfanEjyu8IYpD159XvtYq4jNfrjy81rJPmyeNk05n2poeC95uNOEv+6h9NDvtNNut00qRQReuB1AQWUMRJV4MtH6kr64j/BixRvAfFq69UHdJXrMHEQq25I6os+pSVJnrO67NY8AXbwMZC+F5wrjOrpI4AWI9MvHZ9pLIvReSyNVQzHnoABqWnq6K5NFUrpzNuBeJr7WnSDR9/CspFC94TKTIUeivpEvx6b+AOpmWpnSSUgT6IlxSB4Na8A3ELOYh6hAoz+sR0tCiKpgDx7w2fRZZeRS5cx8ei4O/GT3xd7BkSERJuoG+RVvd90H4iQ1isXyamLsTxA4SP15DYTBj1ThMcJIYuAA2chWsEg8mo7mqv1iTIOae1cOnq4jmKvAjwRbgXgAD4hve6CfLqcRIU4L07CFIPIdNhfIeSA+Y0HOXbqz4G8xmkYAvZKGAYwFgUoJVCQunQeAJ7hNKMw5zpgTIeLqVIgTGGkWu+OcybAKFwm6wueCl5wI9AUjyksfy0mELLixd310my8pZA/7mn+XfraOGgQZ8M5FoNhqbUJDUW8NhSJdBbgBs5M4sAcZKVBj8UGe3kdTATE6lBirOwGMrPnd9KQZhkMwXppTX2bkElejSQJ76QZwN9oo0ytNhExlmpIjRrooOgQuKc9eO3XvQO9S0gcPE7+yjtgHHnU7TPjl2ZmADOmAIxMx2Zkdtu/GxsskKaEkBg+bPpRGIQcLBtrPo0Y9BquRjU1QCn314d0iRyFjf1As8T9g4JrtJA45ff1jE8So6OzhwxL3wMGysR9z1VgGQqm4HywOIAA/4yj3Qk1l2Oo6VBS7fSQqhl1Fwvvnof/Qv9FW0S1GyWgUhWFoKIkhsYKjgAX8GrnpORBorQ9cgjM5whGq1lJjV6hmrit9rgGkNIi34F9eYB58efPrw6UY+yGSNRQ/V3U1YhOBtZbMhS0CcJbcigUQApFAC8nwbw2h/c64hwkWejeW13TgGXKjakArAPTW2DBxSzxor5RkwBuatIj8yVVEPl/DoV7wkvUGEjGg1GviRp/GlCq9TLw5uRix1EA+j2pjPgF+CJ/lq5aGbgycPfovw8S/rfOZhyFEicJjIuB5MfwPyYbAeIrljVwIlBWddSvJQ/pQsuW9hxsSnnmCOG608/kjk0D6awJ4KpGyKSz1HKZk53YQBqJpootCCgON4lTN0sCB+Eoh1YISPpg4StF6vPx7f3YyGF4PLPvwwGtJH/3oymFz2r+CzUsNR1zM3GDFPZkmPAoTF8dcghJTLFiCIjopEzkUMYkuUBHcxnFH+s53iqHaKoduJ3pM3ylBchU0yLHpYQF6nQNFaCeFcYLsoihrJPG6ThZtlossE/gdBR4pOHbWfBi8TmYLvxNu+j9LArb6G4iY+lo9zPhkyvLNucHpwTjz9J+bgGQ7pVQDWdXafIQ0xB+d5okhnxtvHMw5EFuDHjmfTtmg0T+xW4/jwFCfaTUP0VKZq5OcaS1tU+YqC7sZ0jZ46hwAcrmnjs9VmO8BgK3YBoiIA5xiKKNliDxxckeOALHyz3LQazVOr2bJajUnj9KzZOWu26s3T1r8IjzwIoNr3QGqa2sVr3APnQApC9pcb1QoIfRcA5FRkEEl7oUnT26Bp6PoKavkrxi5hGIRXYF/43JTB1BzmH1k3j880m15gc28HscCKkbw39UBLCSTDKhU4GvZj74a1O8zj/jyh63ye54DwrdtxmTGSAw9Dd+7628zmef+ie3s5QXvZ/3+3/fEmI9n1dSIVUGi/CB4IYoUAClUk0AkDp1hVjVoFhLgfmTeqFC56jNAnqKAdnlCzlzxhDs1mYbA0M2Zmy5Ie+8Gti3oNZAYtGI8hWcwV0qroYFaxdakoWVU52Js662YCec89GBSef0QDKJXE9VUSAPmLTLWDJMaI3bULSpyRsihQWm4vTaagqgPkT8sJBBqQb5BMaIdKEp1KiwJRJ7qOolzRxmdEI5JigAYhjE2pjB1AWmyD3QfcXIjoVGRBcRLEEL6+z/WBRi66BMNS9Q39UgZrw08Y0azHkjrO0eVEAt/9X0Akh2dUw1yJ+481JnwKwQSWJ50kTO3VCjQRADzADzeC0fEX+ILBBbkxjJ22hhH9X/q928ng+m2mEXe94dXNZX/SP4drve51r395SX9P+qOrwXVX/gCBwbvBeDC8hmfv3vVHg4tBrzuB73c3/etzPeDP/V7J7RfdgRzxeji5615e3g0m/SuKNeQ99Ft/NBqO1uvOg1x5g/Cj8rJfqDBDwlFlKXZnzJQHrFN9FnaCoXFN11ry40p9hRudAGkaBRDdKcLC9zoOvkauM5YHTk9nWPcApRNtBg6Q0jYPHUpr6gZkqu0HVMABIFdJTM9mvMg/nE4FwrKknBwrKmBvBdVs0Bdi1Io1bgULDfckN9dnmUHaHS1geCrEK0kEhoiVTP1yMgmEfOAupSIwNRibe8gkKfuXlJRysk6HUPwmbewakFKGSsACz6iK+CaCGyXtjA19gRXKJdIoX59UGUjZoDUyHVjrFLIaFRijQK5Fsigimpsk+YyBS5H6HdhUlUtVWYNvyFfOlJk6qg3NSEOI6ZhceDGWgwTqvuaJEZe/zMGD9DxA2pkLxzbV09acPjgENGOmPkjvDyJBeRKyOZ1BOjyiJUVpQHHu0wpLjiS6dBeQa+HecLdoPa2dApuDkJ7MJJcmfGn8ruN2ObJbNnQhS9AG+O0Q1O0aLcHd29Hw9gZ+ep2Af3D+DGCMLKCzJQtot3bPAs4LifEGSPLTX4Ep5sJj6hNCXHS8qoidcnlzermB3w8LrMjeu+IBtRg9p/QVJIBGqP+trHefO+Hr5niS5c8HwuD+YWcz94+ewf0nqiTfAGMX3KLPut4UGIWFHzMyk2UVNIkjNeaPj5uypG/MMSdwkeGihYwetCXTo5Ykjo0Tq3U4aZ6cHbXOjjr1w9OTf5VlMrLctS1mywKs7g16MgqXjFir/8vNYLQWvXVHvZ8GeO+uIZVpsjPXlLfeFGWVhgh5Iw+fXAcAhTBK47Dt8TSqkbZja9iw7l1yQYQizrZnxOcVNQLo0IvLkm3MPwl/W+C2PvOGME4OKLFXXNkN+9BeuPcYcs1wEUHFIjhUTtoy+dB6ccV9SKlwpVCHCxQhUMF0e5Xx5uZu+P66P4Jr4+HtCLyU/nrVve6+pb+w8pheztcN08tGWTK9tub61iTzXJXTozThu3cdTA6BPvMwSFayekLVPKouu1NVXeB+PiYtuJkU9tRyqJvHkiQ7VFH21ZF9dWRfHdmpOrLWRZDLBii3wsU/20uoYgr5ZL4QotoDMM2aC1/QEl29dEnimesJWYVlJeu1aZFYOZpCeDrQ16V1ViiUQRKKJdx2vqH6sq76jm6iCCGvQvOm4qCVXCJC0oP38AJ/jv5DtaswtWK/3kBS3xTEmDFJq2E1OlazOWk0zui/knjka4mJpACllLX6llypW3AVIFFFaplzRZtz06eK1P8xuaoSiCdT1SLC21JXlUk9YOsPAUYQ1DTw2fU0dEihftUMtwDAX5ziPgHNn5njFkB5SZK7eylD93iVTFoUqm/l/Iap/hrG7wjMH5DdFvm+hQPbEte/Sxa6zzr3Weefl3UqV/STG0H28Ph6rj/wnK6K2q5fpMU65pOO/WGhkos0j8x5/zzyFyH3P4FBD8mGiIdXAgRCimeB0fXYu8CLeWV7LLw91Mj12oBhkRnpg+w7L6CdXpc0k2QAqLveK7Rx5I3bLvhvs3D6kY082U6VIo/S4aiEmQWFJqvywL13Pc/lSwafZP4xSZCRPJJ7onzxemqQIm7eLruEGCrzVff6tnt5N+p3x+PB22sssdBiU0Yw2XdNCUthhEzLVQ4hEzt9XzEfwsSTR5/Aw6qAU2fgbog7dhJaWMS1UoyKIbIR30cSxu7tZHjVnQx63womT+IA5GYdToJExd+pAgGgBJZsYpSCSjkTSJVxT24+SHZn7jyRO67qbGIkg1tv1YUC7KXGwlSwAdY8KXU3EGQmLqLxA3xbBREWsh6xe9a3hA9i9YaBoXMDhzwkqEVdE/WuP+51L2mp9q+jZupC4A4QX+5JghQoeaGXR11fKj/ew6dYQNn0UA0Gnkk7+GEsYnLkb71gCviNxNIFyoRysbmfDXATeK4NLsHoqw3sBJGXcOR7ayPOo4OF8FYHek/KgYTgTiwxM60v4qX3hsg97l9egPi+G/Tf3533L/tvX53qej+ILIdhX30o7vH5SHgzSy6ToETC8AhylP3uxglhFzHP/SSy7jKgnexDRVnTAYGEVjWRqJ1yeqllG5fUbNQPkQGU51F6md2ouwP/uZygvXQHGEvfmVQkVnxnzGyt0inekBR8uMkgJFA0X75VFvjqDusyUhq+y+hgReYsbwrOuNTmVWobI+wSQ44R9KZhCuqPFfpSCcXQO2sbKHicsgLPRT5AW6vyoElcyB+zaAWEXzlBHWjmxr4qLfusDS1vy/IoCGZlTzmZyVxLiW60pqpSaY/6DnkkGVSj7VONQyjc08ZQmmG9T/a0dWxPZ1PHcSCLhL/sjn04bTYazYZ07CQ/kw35dZofj7rXkzu5YkLJ1LvhP/rp9/LKe34brYwCzA025ph1lhtSmiHcKRv4YHgW/B4tBaZEnrGvDHJrVUJOu2DQJtAWgTwlCuBvqnPnNitLofvm0PA9du/GhSK2x7Hcv2Pqe1pvHrdKF2D1LoZXhEwNuQ2mduPs8Kje6bT+ZQjQLpWg7vqC+au0pG8a949rUX8Kk5KW9a2FvJPdCzrm1LqItNjcwrA9sN/QkKA5arAXNaskAS4t9bm4NCLBlOUF3aIGQlnfth65oXBYbLZwS8Z8tX6YXSb7Q3thdgLAEKz2FsFqHb9+H8zz4BsFWERk8OH6T4scSdlX2ig5kELSpN2k+kvDNDi9rGzwCrt4dqs0qPXFkk06WMHTOznI0X+bcaaNIRgp4q+5HSKbLHRHLZGhhT46O+zUG6qcIM+OKNM3ZPYQHGw5zl16Tlc6Nel2VbUddaQsYksXbyScO6oRPpn4LggHkxpFO2g0qmvb4dsd0TqaHXY6QDnR4uLE5qJ9fNSY7q4xtBpasqmuZNLfgoVfdwKMYk0NUGIlVyiLvV9l05nOJhM2bBKLAuedG8jMUp2mkteMtb4ICabMiYRvY6TKs75vNh6es3s9IrMXwv6UZQQb9OvJJv7xrY7BZNP8hn1/qsyeREjSckCMLVq35XEdECVJpOSsD+86mlvv8kMzypjKcp90wlnn0Gkei1OLNw5PrPaxfWRNW6B/zVb7WDSPZg4E22XQpEj0cKIRbX7dAJ1P5yhoBkEaF6lkUamiwaN3z+SRalXY9wPt+4H2/UBb+4F2bAeSC1Ebe4JUSxCAmusISjH6kGlaqgZ5qTc4IildSTdoYKWuuEkDYSyzmeQmbM8FelyJGMK8mJcZgSLTs22hNyWO3ziIosDtcOrGIQ8f2SfxaJFEshV3w4gK1Y/yUBZf3FPdT695ZpVFHfxfg34qJUOe0lPmuSuBbyzzabEqYJ4j95cspemuVnKFBcgaxVgcq9Ryv9IpZipemHVOTlvwFx6dcTLtnDi8zQ8bR7xJInRfcL3P6hNaN6fKGqC6mMXNHHqAPDyF51zwJ23+CivNj0+nXCg28t6X5lTZCKXpN/x8dzO8HPQK8aBxfcdwz5iomGw3Zs3mrMXbVsc+bVvt6ezQ4q2pY3XaraOTxkwcTh2xe5RnTLQ5sf4RD9rAlAjvvpHUNk3LOHDkVdWMhtVa+IouXWZBPc3KJ3k0SSNMtdyIwsJd7WzELKa8AWzHAveZwZ8R5G6pxfUJJAwcVbPiPIgziVpbLtkkDTjPNpgLeZe6k3aZbmlQLvZUy9Y8BXo/A313yRefYUpk6y5NdrlOuA3W3yAg4x5mUOhkqd0x7XKkJgawzuBdKRXUqmNslDPPvth2csbw9hr3bY5GfVk7h7+vLwbU21I89kJd0Js9Zd9I91L+guPIhphLtV+S2l+ubrqDt+afdzDYhPrNe/3RJN1cid8vb8fql+H1db83GY7uxr2f+lfdSuEsj63dVNmfBujppTR4q1wOLvq9f/Yu+3fjSXeCN910x+P3w1FqKNKDREa39GHYEL0FAP6YdN/K/98BJv23w9E/6ev4HzDXWEeMN8PRJPuOA70bDNPFCs2Gbm8yeCdxADj+sWEnAPpm4J86CFMLL7KYJBmsonnCDQZiKu4xXR5Y/ZCDPCQ2hmvmCQtgQHRlehczaSrN4LwsET7qdJri1Dk8xDOhDqeH9vT4eHZ8ePqMmqQ5CT2R6yF8ZD+NTOUtGsb+Z7FcZcZEZshkvvYGZm9g9gZmb2Be38B8LdyyVjrLgnrh6D6NHWL6AqfSgzN0TrZSQxn7RPQsz1gZ2Yfpf0qYvlFGjPLdE3JEt/Z0vW7HIq+Td0u5XD5Ka2xmL0DaxUc5vtl88IKjzgLsFRTOOJneLHgkRqo+XJb1r52nJR9lvfE7On06mbIVjpEWmQWt/MuJlRKo9GVzK0+GjOz5UexUhRdsEtBDfCzfs/OxUjg5RU4sj8SAIWZJSN1j5uRkMuEmlWmlDceETl6oyvcJPe+grXVcsymNveVa0m5KOLxh8/gqFLpbZgJB1VyEf8bpd5SGakkFENLOI8DYJshzJNSL2hFT7ciOXHumnfHh09PKoqC8W6vN07P+HCx8dh4IWbxSN2zfYry2m6B07UIPVgpKLLmQx1+P/BKp2TTDExK0SSw2yBE3e2PIMHzDVuMo5uGGtdGS5UBcAVUaqzWQqRFeunsQu6zVqUDfAIQe4jlQtLbtYXzOymO24lhulnR4fnfzU3fc3+mIrWxjhHmQz6ZDtvCgInnfJj0wtsqUw5gNTequF8SeWD28uMWcQx/NtXUFcevsueHWOLHKOb8dljcyJ2dssNQORK3flByGlPOCkXSDJQpO4LPrQHsvbVxNVyDvUo5Rl8ox9n1U+y1haA7//IAti+2LedIUT2Qq2237fDvlRsWXa6RcKW3BU2ZmfW0hjavlHak/L77nA5dH5tjhr0/7BrdO4U0NWYQNtAgjnT8m0s1dSRp5GXZzTTxyED3ZaZR9M+O2fEv6huNtdXeJrFDMAVJ5tDVtvybEhboaEXPnIfc37Trfvte71IRtD1ezHkKEhqduHM/rcBJPdcPStMVNJvKI0gY2FWqLWG8o2yz3hclpX2VzNEaJ6cm5hQU4RZucg9ulJddkzHo3brFBZ3pyeOKIU8uZnk4tPrVnljhuH1tOe9bqtLnTbh1SPry+Pre2CFvwrK+9PqdPGlCvLpDrmun6MS2w4gEmtEiQ12YT4S8VGLYJ89DIeG40fG/p7618clViFSsqR2+XHb/dIyIxWq9lFmh79hIGk+nTwKH35aSLvc8/l3tD/CINWy9wdvALF6CbFiglbZqRq7Y2PKjOcUAqGiY/tzCelyCgRL3JfuROat16ChmkZMjtTzDWLnJ7K5uk9CPYCqOdScm0oiP49Lhx2mrPjtuct07azc7R9HTGDw8bp0endNiyPv3iyQbRt7gC7trGOaK4bSLw5ekLOPnuMeS+PWXfnvJ/uj2FjmLgSXkiVgjOPDA/FqGW/nAvlPJFcv8WhW/r0ZsOUujh9OwZRYv02Bvac7HX3b3u7nV3R90t/jhSLx1Rv1Lo01wPfW599SpAdJ5roU+oj1/SN8lipmRkDVcMVYj08/uJetEgnTBN5zm8YnwkXfka8N2UH/L6VLeraddv1OYAQKKjxED22p0R3BnEla9plHi4PttFACEuCKhfEiLSAupjkFDGFCY+Zc8cYl8nEJH/fay2nMnwliwgzuo7ltyDuY8k95Hk3hvtvdF/jTfaR5J73d3r7n+m7m6NJFOoSFtUnBQlyyXHA62ol0j+TscLMLghexlqqnLEqmK0goOxNMaq5COHyrTVnDZnHVu0Hd52jg9PZy37uMWPOs1Oc9pudSqmr3/JFgha4REh7h9I6HSVOAicfPkvoc1t9PrrOAuJ8SwGapTQsWPrtKQJPwjYFRZB9WvFczGkn9EIbVpAyymP6buC8QbO5mAX/cJhODAKbgBh9D5SVN4JrQnF4aPVpSPL1Ptn02MN1Czp7hK0BNgKSOdtcTfWb0yBESiCnYN1fsXo1Ngr9uJIno0Q40vEmPU/20KgoqeR+1FZfXeALxBCGzGWDN5Q6JXZDvdBACAhkDYrjTv38fk+Pt/7+L2P/+/w8fv4fK+7e939z9TdZ8TnKhraHJ/DDTvH50fYUMHSWOqCWib+7DCdVEVBQOKdblfOYnCKK0CUEKC5IBvC4wV8OZAFWEuxylJHP9cqMvCXICWhB7fqU/O+AKeAQ1/rfOXW9Zk1fvBAx+ZNgTxb2zjwBnoRupygTrQNXRRfaetocElp1YJSSU/m2zqy7tZ7DBKwbjRMDdvulSjRZdzIDHnE95HqXEfKrOEHeN2G3tdvx0UOtAGXMvJtb4BZuQwgLaCIKPyK7AKWw0DylTU0+22EB/iQucJzZkxHgolaa22yId7WYj8KHtIRjrh28cPP7ydvsm316m33wqXGO85uQETIlHV1HR8fIu8iu8GoYyy3UoKqw2YeIMw++mMh2Adz08wIjDKRFB8SZAfwKePMRnEvPHR/hfMaXcc/AAod8Nxzb8jVFfve6x99i527aIHSfn+Fojyi5cNK48UNvF4KxHd6NEspG40WvSlAIUn7QbYn4RlERBaOL84Aar14cjmeZYxnUf+ahaMWYUBKKDjy61u25tqL4ciNZ+F4eTg++u/l0c65x5g0WywCN+g5bMDsRRBE4n8YQ9FBNfgwT0CLXgwWbVuwSCOsVsMAyZJTWq4FUSHBdwmKoTZRyHZLCkoC7FF2pEr+mzgLOv9v2iD+7xzOdPkDtkfCnU5gRy+GGSe0cEJL2oBIwa+aQQFYbDUEHOTOAhKAXsZ/sgQKUMPuybFKrToNf0DPoGuwAVTZZL46k1/OMgOn/mL0A96d3gNmGIPqdMUPvjM11tf0EC1FLF0OKFJwHV4vAL9YoJuENy1Hoa/8u+GLGHezqgmeEfbaVnqDJfn72N2/yOLtLc1/o6VRYS6KG02r8gFTyH9U8dp6FS+i3nT4P/xKukoRNccDQOQh3vmtvSuPxyjVpNX2whWU/68EjzH2q+lDvYWTnroTyYHmdLJgyOiE8qnr4ZGsWKHWM3NSGBlYIl/xe5TI/Q34wukF5JOizt4L+Rb4ENMx7LGA334LVF42Bs7cIGPZuWY2w01jiY9d0wB2ssQXKTwlEY4b2Yk0XJCd+ULTQu65SJ/SWoyihijQTgMRLqPhDEvLLu7rqOw4F/A9UnVlID11ZsvDgzJERkJt0oT78mH7U2ODtFm4HQETQrC6EIAJY4arwWRtRDxxPwK8IPEOwvmBeig6wHtx7zIgL8XnsN6sNyxKF3BXSxDFkMIagxe2TIx1jlXY4JDW0yl5Ln2ITLQ8mQkPw9R7NApbPmQSBzKXq0lkL4aDu8JHtuIhgAe8wheTd/1H5UvkqfD4GndpUkBmsLU/PWQ6PSVezlJnXfPB4ejtXff8anBtPK62x9ELbVCa0A9Stw8iAxcgITVwSYFHDyKFjc6AJ8GSnhFTmoMVluGQ3olMsWRC+6FSntBCirQI8OCKD5UvX5AsmOF9xctEDHl8oxuh+jrlmx5M/ly4HmqxWkCi07bVoVrpGa4IvdwSa5SPItnxjy9TqbPqUlTTIopM8fSroxDhOrtKsBADqav4bHugZfeyHsSqoZjLF61YerrqRup8EljkSPe/WDNaFlDljAptRXxVvGm7DL0txsT7r8J2+vhHILv+ikW9+znSqbGBvDxHJOYhynl+29M30sXgaZXcRdXE/GkqFen6Z9MKf5evS1RkSc+j1lYPt3wz3LLyNKG2I6tfq2HRoYMvxHIwY1WssAIc6py8VbBKPP22zuov1iSIIc3v4UalalZFVEvOaSjhJ8upRFoTS55VQYGnefSeCxPSQrZibzCbRQK+yH1Dcz9QPaVbEKdNUy9H+Yp/LgM3UDA+MTnB/vLJh4QuxmKBKop7noIB36xTZ7eRVI1MyKRqKJrhUgzHdzDGIleQUmjk35XQQGr7QZwN9gRykhnfrDOapjKMIpWJgdn47gyqmX/W6/9yceDDu0Pym2N9Uy/wPJlQsZvUo+8e8OvJLDsdx8oiA0gAEEg0EgpOyk8u9FUq2KcH4ehlpRkMFTzQCQu4lCXfyoMw4GpOdIYjVKulb+moVs9YVfyOLwCuQVwA/+Iaw4jag08fPt0IFztqLHqobueOBDx6OXvGgNPfnDkRgFhkzVhe240xQOyqOuy8lr4so8ZKWVOjknn1CbIjSEWy/5qVxSHOwpMOpEGkoEs+JpfLjKfWGkpwlHQJ420fo3W+oV6i/sCpvn79/wnLtTU= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Query Parameters

+ +List of requested item status. + +
Schema
  • Array [
    • cancelledRequestDetails object
    + +Provides additional details for a request that has been cancelled. + +
    owner object
    + +Owner's identity. + +
    approvalDetails object[]
    + +Approval details for each item. + +
  • Array [
    • originalOwner object
    + +Identity of orginal approval owner. + +
    currentOwner object
    + +Identity who reviewed the access item request. + +
    errorMessages object[]nullable
    + +If the request failed, includes any error messages that were generated. + +
  • Array [
  • ]
  • ]
    • manualWorkItemDetails object[]nullable
    + +Manual work items created for provisioning the item. + +
  • Array [
    • originalOwner objectnullable
    + +Identity of original work item owner, if the work item has been forwarded. + +
    currentOwner objectnullable
    + +Identity of current work item owner. + +
    forwardHistory object[]nullable
    + +The history of approval forward action. + +
  • Array [
  • ]
  • ]
    • requester object
    + +Access item requester's identity. + +
    requestedFor object[]
    + +**Possible values:** `>= 1`, `<= 10` + +
    + +Identities access was requested for. + +
  • Array [
  • ]
    • requesterComment object
    + +The requester's comment. + +
    author object
    + +Author of the comment + +
    sodViolationContext object
    + +An object referencing a completed SOD violation check + +
    violationCheckResult object
    + +The inner object representing the completed SOD Violation check + +
    message object
    + +If the request failed, this includes any error message that was generated. + +
    clientMetadata objectnullable
    + +Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. + +
    violationContexts object[]nullable
  • Array [
    • policy object
    + +SOD policy. + +
    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[]
  • Array [
  • ]
    • rightCriteria object
    criteriaList object[]
  • Array [
  • ]
  • ]
    • violatedPolicies object[]nullable
    + +A list of the SOD policies that were violated. + +
  • Array [
  • ]
    • 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[]nullable
    + +A list of Phases that the Access Request has gone through in order, to help determine the status of the request. + +
  • Array [
  • ]
    • clientMetadata objectnullable
    + +Arbitrary key-value pairs, if any were included in the corresponding access request + +
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-account-activities.api.mdx b/docs/api/beta/list-account-activities.api.mdx new file mode 100644 index 000000000..2d849f1eb --- /dev/null +++ b/docs/api/beta/list-account-activities.api.mdx @@ -0,0 +1,95 @@ +--- +id: list-account-activities +sidebar_label: List Account Activities +hide_title: true +hide_table_of_contents: true +api: eJztPGlz47aSfwWl9+ElKlMmddly1daWRpbzlPhaWc4k67g2EAnKzFCkQpC29ab837e7AV66LB87mcmqKhNTBNDoG91AE58r4UxEPPbCYOBUjiq+J+OubYdJAH9i796LPSEre5WYT2Tl6Kai21ih8Xav4ghpR94MoQCM0Z0n2UTEknFmh74vbGxgocu4Hs2z0Sy+4zGTgIB05/BDsIl3LwL2ZyKiOZvxiE9FLCJZAxzyX4DJ54qHc1E/aAugBX5GAl7IWDiGG0bwWtp3YsorR58r8XyGHWQcecGk8rSMs2CeI4LYi+cKJ8RF4zlnD1yyDDYD2DVWnYoq8wLHs3lMdAhmJ1EEIFgiBXQ4S+KE+/6ciUfbTySQxR68+I5VIzHhkQNoGOmMVSQP4XuRACm43Jfiae85Esfzt1GYE1Sk9a+kbHH0S+mTM2F7rgcUZZQ+eL7PxoIJQFBERExKd8RCeMEjUFVUTsWEkoK+kRkFXawyHjjFd+MXsYZofyEzsMsKo5u/YFrfm3pxZRH4GX9kQTIdIwNd4KZMfLD1OITHOImC2m/BlRDs5ucG614O2FUMlINcWS93BZeZJd9+dxfHM3m0v++Ie+GjM6pJ7vmz0Avimh1O9z0n2Oczb19qOEbuUozcI3yPRsmmYQRKHsDjlFzaClL3KuKRT2c+kFdvmStYCvOKiUDnocCoV406vJh6gTdNppUjGDflj+qZoDjC5cAF+vW0jpuh60qxzM4Leg1oAwdRvdwENFZxlUFDjV1LpWC5disFI+lUkfEzPvEC0E8YH4XJ5E6rOQnmmxHHG4SRsX8988kGlng/cFk1jhI08Vi5ilk4S3zFSsGqvxijMOa+0cPRVWTpLAykYHeCO6D+JAfsuMIc0MM+hInvoPdRloF+yc3kRg5B6USVPQhk1SQAjjkgMZCZF9iZqwIbh7U0RlSYMmabB+yOg6/hDGREzMH+3nQGZr6H1Hi4YoHEpiJwYOIgjFFTpMBZqwTkP4jyKuJE2N5zPxGKC9gb0AYPp7H5JjQI6VmhROMw9AUPKgU9UV5vna64nk9Rxgsc7gkNyaQP6wCIDDUjpZLJeRCD41TDxqgKwRdm6T8UXbjAajy/R9mepG9RZWQym4WRDnKUOwJQ4QM2g+vxHUl6q4LGMJJHCKFaRe5Uq0esKv4E5Qv2IPyDf6CIPvz14W8Afz0ZgGvbY/KhqkbZkQBLc2ggdY7VQByUAlo5cBo65AhfMrKyTtoS6d0o7YL3QYPihhTIVUB9WRGuANpXrgZI8KISXKl326kAMJ0kvse0BPdYLpHK0y3aqHKUEplZN038U+bTKSQaq1MCYLcdgt8Hdw2j+GzmY+wFo/b/kDj087KceBRxlKgXi6ksvA/HfwD5mDpEyC6CDq2es0rGCyvD8bqYEJyrFL5bKTieSt3uWIfmYaPl1EXLah+aVstp1N3Djmlzq3VooZ4odVue92VQNMc3KqkDPYzYm4oydNM6MMwDw7JG1uFRs3XUOKiZncP/Rqip+FaBRQvi49y/Pj/NoWG2jXprVDeP6vWj+mHNMps0DSgpdFqD/mvmsUzD6oysxlGzg+Q0DlvFeUCSYFJxQkJfBL9Z/CNlszCWcRc9ew4S1yARYORxU7m67vX6V1fw5qQ7OL0e9uFpcN67OLs87Y/wx2X//Hhw/kNlD6e/LeKfD4U8hd70FrF+SrF8nlk5XDCYoYoacHyW6wx0QnSVgAMD97fCSBZhvt5owItkCZjUExZxdF1Qc+vQarVccWibqOj45HTqrbHZsNqbzKU8478SCHzAk3EHMWeOJ2c+nzMcjKgUEskC58FpXqLTZFciuvdsQZxOuw5e5BwW9wzIfxLBsAjMwA1CsyzNblutccdt2TZv8abotDodwbkp2k2Xd+rW2FlnJ8UopoRLlptCHAd5AvorIeEX+kLtwgtYUdA4FiKAJcj2MDIMg8pCDPX0lCvlot5gE6XMO4XaKdQ7KZSIojCSK9bzRQVaXN/zaDyb7qZSjImCADQxjGq99Kn/aAsi9Ij9we95zefBpDaAaCOKkhnwp9A+ghUnTCCJ4x6FRkh5lgBCKjUFpvCJYCZzo3DKbN/DTaHWAW/ycefA4OOGazS5cI2OK+qGKbhrteyDhlNv6yWlbUI6Bjg6sla5BRoeeBTARO/ECBzytNxzW4hvCZ0AFOhxSUmbh3ar2TpsWON6u9k0O/zQGgvX5uOxKRp2i7+fgcLkL54525bbOqwq43SMGwaYF2EroVDeMd46DoPFOwohD8/DFjDAC5f2u5fiRh2DnAzOB1f/6h/Dq2H/x35vpB9H18Nzeuz/cjkY0lMWjVR63fNe/xRfLgUmBXirYyK1q8gewuhTyu7UuD/COxQ/4i8o4yrr2RPqOZLoSYAJdOSEriMvx7mA2PX5z/3h4GTQ/XCKURYEXGcDRTfGYSkDhr8uH05cFiYvUBOsCvMXNCnHJCX3coESUQq5erT5Er98ZVS7NhS0bWFtztLSMeWf0rxTg1qVZjTbbdNttpy2abXb1oHDcbkwW4dNvWAoFM7fwyhfgl3X4VP2kwB/7dDiMA6d+fMI9FTGmE62CnA/Zn8mAHvKwW8ztX8r2b13z/FvAHJk4O2TKOBgxgEsZagNkDJDo/AFgkumDLc9apT1o7Tfw1toVMlhTLmzbc72VMobiFjSvXtPPOyi/V1w9m7BWapSO2+282Zf2JtlpQnbBULdY1z3e8N+l7Zezi6OBye/wsNxX2/GHA+udMDQP9cP1+enF72f4EH/GfbPLn7Ghqv+KIuNygQPM0vHsCHDETdytwojFJopueViizkGTxcZ2WsCKB4D6eNktcjKyHbTrpixPNx59t0yhrTFSvuu63eVHPBPNrioIbglcqB0WPT8/D/TmRJGWBnOm6YZgdHJBBxXN+D+XMbspkv+DQIt1/OFYbXqHdMyrY5Vt+q3auEAKkTqt16+0XdO43N7BimiyemyAAk4QDCf8W7lfnDOv+KqA45a1HrgMqIQ8ZRhEtliexd4Rf23ktryBnK7IdxDYlW7aZrgBQ+shmmbNqUYCpDeIxwEbvhyl54lNhfUf3uq8pKTbKYl7FsK+7bG3rIbltVMsV+Y+VX+PPXjG5FZ1MQVk4/W7M1m/og2eP/ncnhxMiBnM7zQzmc0GJ32z+DvquKprMAEj/yzsxg9NxGg0KUCD1ljZeeyOGfqZ4b5+AL2T0vnV4P1yRAeDsFqE9oenkCow2/VFyMQjeAes/ksTsBDQsgRQ+wl1SqW1xvVlr1fURlxuaatlDMYDssO32DTmdy443hIAPcvS4r6zKltNxp7cYSB0icxN9T594x7kdyj8CqY63P5wPYTR53VqfU4UhtBDh3Ml+hf8vcQACUyDqc/ibmFASH90GftFp51pa31xdY6iScS0/BeHOsF+uWnGE5azBCFqDpRiu9MuVQUahAyPwwmIkLxehOsU9C1KMsFVbVtDprqpl7mTfOI/isv8SvWPGoXj8JOyqc2z9OXVmNluXwGpXhQ0/+l37seqeydtg5+Vc+j/vBscN5Vewfpuc1xpbQhkr/OSegvoLpSa59zql+P1hL+WEGi8Xs2D/l4J7J6uiVngcUpY8EUQIEFMC7WceRHaPl0u6xil1V80ayi+C5T+AWHBL2esGNzVeFCT+3z9/HMghlsWKjsKhSXMhQJ+lYvAAP1HPRFL61qWLMFr5bVXuhsoXMnXiCMScQ9xJCOWYCXjmC0BUt+gCqsFMhUMahfrbyJbpo1i33gDtNLNdPKROeBEbdRXbexxOvAg/EsHQIan1WZrJhWHAg+bpudetNtNzmvHzatA9xP4Y2GiXspVLqgjmFWnXGUp/5BBCLybFjqbJDIvymm4sB7QoAmr2x9DEIwtuA/LlCqb0ZmemwUi0cIljj70LtkzQOGB1EJveeTBSYExvXVkj8EyhXgi8ibeMGmOPS4f9K9Ph1Rdvtf1/2rdYltN0gLnUMqZbwLHwhjTQAanxQ+pYE1VtVQq0AQD2Sxo6d+6dxJ19zBCD37ihFF0Oo0rWhKZDePMfvOq4naHqwm8A78ByRFYy5pS0sVa2KqOIuNU83Jqq7S/L7GutlCq0Ir9CJzXKJgBc4XSDfBuJXiWjz3C8LYs0VZFjkrlwIx7VROi0JB4wDMt0jTbSwiJ50oWWGmLRrFtBDd0ZwrYzcqMI1YirVm4NNsKh+m9R/SBkjCsYSJaXdEJV/geIK0X+axir6S3N2ZQuY4DqnN5oncwu4ufXA/BpGWNdwLbXxUN668EUkjFZP2SDoMpcG6Vyau1PBVUdrOdne2u7PdLW13sXGoyxp0K4U+1nLocx3wBPgb0eK5FPpEaS6ZdlLbokqQe5h56hDpx48jMOxPIsD+4nGGxdzvGB+ppXwJ+W4mD117mwbY6dKfywIRJD4qClzwRMI5IrxzjFWQSKxqLM92EkKSBgoarAgR8bshNg8TxoFlURLQUTSH7M0JhQz+GevCfpWgkQfEWQPHUFUtu0hyF0nuVqPdavS3WY12keTOdne2+23a7sZIMsOKrEXHSWmFEGmablcFhdAhL7DNTC47aC5GKwiMZTFWpRw5VMZ1a2y5B7ZoOrzptBsdt26367x1YB1Y42b9oFJc629yO86MrGxTBXkrOapKSBHdQxyXBKBcMg5Dp7z9l+B5l4tuDV1PFjcDz4Glt1nsWO8sx46jMGRnuI2vIyRZiiGDUhEyTAxaHMzTiSWVIehLFMBVeaHa+sZdVIPhN2uMPj9F40UqAG40N7pUj6w/atVKls2izxEkeQI8J6JDae7F6b4+QKAIdgLe+R2jUy2iN0XybIgUnyLFDEu7BRp6Frm3Vu3vUjE4+ogrJeA1G70q2+EBKAAkBMpnZXHnLj7fxee7NX63xv891vhdfL6z3Z3tfpu2+4L4XEdD6+Nz6LB1fA59aybLYqkTunbjS4fpZCoaA1JvFtpULuTkMTjFFaBKiNCEbueZ8fgOfuzrshajdDOBivoVPknkQ7/0UobPICYQz1ONz7xaWsgRhA90M8MYeLPC7WB9gDIx7EB3QKgJasTYyEPdVY6OgCs26ztM8g8dN0JO60vmYQKujcDsYemg1iN6jZU5kET8U1LvGunNEn1A13XkP72dFgVoDS2r2LdxNujPANMFEpGEWxQXyJvqgkFe1xK/YiAv1U1Qxje3xT5XGJUrDJd65isNZnL1JYQusFudfRA8wqIoOtz47sePo+/ZBGNR8gXqMhB9Dxlnl6BG5Ou66UY/DqLlJ7/DqVs6SkHbYq4PTGH6Sp607vkcFoEheG1iOw4S5Chw1PbXhvDSuDUX8PwWGOzYi9StIuqLE02iuqToZpbSxQt0vRaJf6TQDAXNIGh4ZUkJC8XaG/0Jrg0GjiC4L4lbr55cwTMK8DDDgjcIdREH5ITGo3wAZqdSezUeJXgGwivj8VvwUdWIl4Yx5deYvKNbqAbMvgtDKf6TMVQdNJWbSQKW9mq0qDDdIIsw6mYBJUNNaXgGhI2E3ykYRqCUiY9x2aaoJYSALnCU2f5OkgW/8DuVff1eople38Dqij2d0H7BXTgLOOOEBk5oKD8hNf66VhmQxfo0oEEVGZIC9HL5kyfQiBZ8o4K10vMT+H0ag8uHDagSFDk7Uj+Ocieonxg1YO+sD7hqjLqzI0H88kvDwhWsxKx0v2CRg8v4+iEsnAt8U/hm+1W4mH5t9CLF3Xxb5SLw5+/tpdd4kq/H7/5FHm/naf6OnkbHwV76LdDCx6Co5B90TLe8zSfp6wL4P7SSrVLIDUFzfjtiEdDM5zFqNVm1fecJ2iCYCU6fpuyhZoVTskTI5dH8IQ0kQBO6+CoClDmkdJ5Pt7OO8pk5GYwKPlGu+Fsm+kuZEFQSEk5RYx8hZwsgsI8wX8MiDGj7I9SJW/6t8HEqbIaVw0mARdmAdjJlHFTqGY1wPGknynHpK0gUCSGFftmo1IpR1ZAE+jBGRFN54epPlQuCf2YukHt6cRqwnr4UUbfb5YQMhU+aif3Kof1zsEHbjDvhzzBjBK8LAZgozHA2GC1BBGCB+uKtFkaTfT1I7mNf/HgQiFfq06hZNdOglAJvhghlDDluAThdE7fi0ukFNfycb7n/n10/rdcWTAr2Z7jThRgnKpFROeNNZUXOCBnGHZCFrZ8/41YIJlFP+FrdQ4iZCTAatT+/0nIDcX/5PdUr+fBJ4I7B4vXbem+gQh+yvoXIL3ZV9VbE0cXbb6Dt27umeiNbVtza/QbmbLq2egMa1PTqib+tK603sCG9sfuVfPj/dRf1Bj5md3W/kpG7i6W/vYulN6hDenv4K7Vhdzv0V3879Ebx5xeCv1IBdrdCb+RvfgV3zt/b/NSAduohjCbfSAGzGqaOEgujloptEEp2vPNDH5KPp/8FlRTTcg== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

List Account Activities

+ + + + + +This gets a collection of account activities that satisfy the given query parameters. + +## Request + +

Query Parameters

+ +List of account activities + +
Schema
  • Array [
    • requesterIdentitySummary objectnullable
    targetIdentitySummary objectnullable
    items object[]nullable
  • Array [
    • requesterComment objectnullable
    reviewerIdentitySummary objectnullable
    reviewerComment objectnullable
    accountRequestInfo objectnullable
    + +If an account activity item is associated with an access request, captures details of that request. + +
    clientMetadata objectnullable
    + +Arbitrary key-value pairs, if any were included in the corresponding access request item + +
  • ]
    • clientMetadata objectnullable
    + +Arbitrary key-value pairs, if any were included in the corresponding access request + +
    cancelComment objectnullable
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-accounts.api.mdx b/docs/api/beta/list-accounts.api.mdx new file mode 100644 index 000000000..354d8ac0a --- /dev/null +++ b/docs/api/beta/list-accounts.api.mdx @@ -0,0 +1,96 @@ +--- +id: list-accounts +sidebar_label: Accounts List +hide_title: true +hide_table_of_contents: true +api: eJztHGlz28b1r+wwH5JwCIoEL5Ezng4tyS5TWVJ1JE1kT7MEFiRicIFgAcuMRv+9771dXAQly3Ka2Ak7k5oCdt997oHbRhiJmCd+KGduY9IIfJVMHSdMZaIarUbCF6oxuW7kj960Gq5QTuxHOAUmXC59xWKRpLFUjDOcz0KPcTOhzdhrOWVJ+FZIduMnS3Z6/vK/08NXsxPG02QZxn6yZgTi19SPhQtDmcODgCUIeHo2awMZSjgpDgRSbhtXSsQHoUzE+2QKEJA835WTDOMkFtyFOZVnKy75QjTe3AH9EY/5SiQiVgTORy5+TUW8hkkS3sCfrki4HxyLdyJA7M5SrHhjcttI1hG+VknsywW8ETJdIf6L49kr+PPF1fEx4NgU0SEiW/lSKHazFMlSxOwi8FctFsbMlw7Qq4DvALGh6DRylEkUh+98F955MFJwZ5mJFaaBfISRO04GsbcZ4sd5+MoVHk+DhM3Fkr/zwxjFKN7zVRQgB0TpXWs790CbnzQ2uXjF3zNgdw7UA5GxUABdobY0Ee3X8kIIdv19D5XGLhIuXR677CAMAuEgDHaWC/7NN8skidRkb89FrtEE2wqYjkJfJm0nXO2B9vZ45O8pA8dycjhWocBvSTKrMBYgEfi5IkNGVjNzakw8HihR4t0edLaoFPCKhYhhpgajH/VseACa81eoZ5i34u/1b4JiZEx/3d0nzdDzlKiL85QeA9kgQdSXl4LNa6kyeNFmVyoFN1gzFQnH93xQMrlPk7TTRMFHfOFLngiYH4fpYmlMghTzxajjE5SRi/9+4ZO31GQ/81gziVPRZH4CUgXBR2GUBlqUgjX/Y12GCQ+sA5zdRJFGoVSCLSGygPmTHnDgFndYcoAYpoELjle4p+/legP5saa2iSa7ESiqhQSJuaAx0BnEA0GxUKgEYgxE1ARJYdrtHS4ZuLOAx6AjEg6O91cRd5IWckORFDS2EhIDhwwTtBQlEGuTgDwjzptIE1H7jgep0FLA0UB2qjJqvggLQn62GNE8DAPBZaNkJzTzXlvx/ICSwv0B/64cQiEwywRy0sxl4lf2umE74+5+Z38A/9ndQcfr4F/jnjvnXr9vd7qvGzU7fEEYc+NJFWocDSsTElNrmUDc1dPmaEnyD9bIV1osQJll6PwWTeNF9hQtTqVRFMaJSVQUzQBUeIOvIXIFriKz15VGGKsJQmg2fbfZnLCm+BUsVzazZ5lUzTvzHHVUHw3Rz38nZmZO/b0K09gRsy14UumEcSzQ53NM9yZEhcyRZdSs8P7aIA9d6I3cUgJlCtg2rahFSDZN4wJQfuaGgVLZNIsL/exxRgFSB323GAqgxbAOgtEt8H6X8l0TFPIGRa6jr0Ih250O/lOV1XG15mTh/BegFtXlYJkICQCm8CgKfIfCyd4vCufd1pXH45ij3v1ErAgfZOBTj8pEM0LDrljCtTYTrCxjlGbia1p9t07qxVoBaGshpCBjYKn0wdjY7BAZQCGdZghqtWbJZrp2rz8gIrh7KoO1DoJ3mcFuYj2Bpx8Bn+N4NFOjkjrAA3yBZuVizvwQ5NwTcLSV+GTuVdLL6O2O3bM6XavTu7S7k+5wYtvtfs/+CSnKbGOLEXAwAv3a+TNoA+IgBtGg51DPH4DTh/IwCSmoPGQ8WYzCvEM/T3Q84AnQOE8TgYactUoU7zBY+IrPA4GTgtB5Sz+qwRDBkbGZ1g3+Lsc8LKW4pArzoPxwydWRJEaggtD9XtWqc3K3tUOFnHQy7A1cWwy6w/1Od+D2bG9/3HF4d7DfrcW7S1BSzRc0Lt0JZs49h5AlF9h4oD2UJPYgPUfwb7gWJMs6YpBmFPA1BaLH4y5S1R8hiwxblSL4WejU0FUynEnd9Ljr+oiHB2clvWo7r5OR4Slg6qKRQ4HGF4tYLIzd5OzeQh0Vq0SrpHEBieUMEwsaKi8e69ygDRlFvzmcZSPQr6rGv73Cq5T30sUYALRSjVsVlxeHK6hGWAWo0XaZD10rboCuq7mKecpKf2ea47kDSujx0G1rcQVf3JW8+qN5FBWLSMEiZAK9YylM1BgzceP3QpWHoRqijbj0QSFuNf8MZ5E55+uyn+pYV/G7wcAejQYUJSqBcBvHVaK39IukMG1MaE/YI8U5UdgQQv2VsXgS3rQZg0kaWDFL5jO0FVaJbyOplRj9iaaO7VwlOiAFfpEfappKU39rLPsI/XCF61d6uSvXUfbS1FtlJakgStoqDwdVD7nbmqQ+wWIhu0EQF5JlYD9OPpvJ8RMpEWVYGw1tKb/Ua53Lx+eDSmRG7WbpqD8cdrz+wB12usNhd+RyPra7ncF+vyiSZodHJ5ezyx+LRmjq8hX7l5Cg2zVa62Zy2VYAP2xMJJOiNAeLqpiH5wGp3f1u3x2PRg4QCL94ZwBJtM873Os1SjXvxyEyXVeB6iU4cTqvFXLnwhMQ4hxxWK44Tm8gDG1XTIivHllF1LXTdwbO/qDXF+NxH7QjxvtCeENnNBD2QMw73Ye0syV7/i1V5EFzksaV8ufefK1f6G0L7Ba5L7NeGxSJP7UKv4bKIQNbKSxPps+Pj+qR6w5b14zILPPcFa0/EYe7APnOyr1trYJR+X5KeYXRrBbrZeHSlgV7xnBDoglU0eIe9a/lqhBpLXV32NVASzO27P3Ljj3pDib9fnvY7/+0KS89r6hSTLIs5N04Oz/9fnYxOz2ZnbxssZfnp1dn/60+u/jx5GDj0fTq8p9oywfTy6MtLYgplsrBazhyuvt9z4PgBSbHbW/udXoQx0aNaln+ofHDon/KmNmWcLJXefO5KbHhpGu37c7op8IZX4rwHZfSb3f4yOHu0PXqLRo00ifPsoEsH9g6vXq2jFKJ/4bxwoLWFNeP4ne+I1qHB88uhcKdr1Avjk4P8RlwwYO8hSzzPgeO9+e9QcfwLpzBaNzhHEOJTviNW9G3u/se7wOqgW315/OOxXm/a7m26zidfT7i7v5d4w63tl6ADfx/bBb3pJoMN8WwcNHbHmtaTEo+YMkbDYK2l515/+3Ne6PuN3xWS+zs4cd6Av6v1ehvW488CHyQADuKY7Bli52XdoH0Dh3t7rB56NLOty/Btn23/YT1ynuyuvarg9B9RNJ9AYW6tYg51euCSHZgotl7Rvej3RizKW3KGhpX3VEGSbS77Dl3gV/N34FhBrN1zJ23AGv7UkmVoCvdWmRToNDNF5C3oBUjwefDztjue8M+5/Z+vzsazMce7/U648F4TIuGQim+qNQD2UJvFfVLbC59h5G1+b8JDFccZK/33xF5eW34YR0QjEfIH0tGPTZn09DL8IRDC7rE5wdnrD9iAZeLlJ7zxYYQpHV1sa170oBPY3/hb129yM4vHB69mF4dX8KT86N/Xx1dwC+EVTvsMYX+SHc0IZW4y/CGKDYM3EBTowRuFQi3zZoGahMY4lKVB5ozCto/s6MKMMNg3zKjDFp3z2VXcvRxEPaN3xbtFlTYuBbME2fJ5nS2ItTHJZoQCkSUWMdGkk2zo/ttm03zZTG9Iapg/ho3Q7nr6t0VvUmPmYCyV5gmmKcgZlV1UYhyc7UnqwaPy0pB5wDKH1GqOgkEbrKJihfm1mJINPrBMyGEp0rdZUloJFLcRnKAi6IZdiAyAW9+opgJR7SbA4FHZuPyiFWuxCncvdLEUCGOGwg8VY/wu7MAwo9FrOUv3gnjfHTGxJyEYcXqZRaRzPEJmpyflzGyyBxf7zftfHfnuzvffaTvbr48N7uw5i2VPt166XMlTS2OybNW+sRCL0tmi++/6T5fK1Ifh9PS+e6HS3NkEMaL9xHulf2O9ZFO5TXip7k+zLZ6thKQpf5CF0ggyVFz4EEkEu6E6C4oJkFpUfXq2F6E8dwHA5VbSkRaXV6HKe2zxKmkhQiuWswNhZJfJ+YQEHiEUjoCIlbpWnoTf1dJ7irJXTbaZaO/TDbaVZI739357pfpuw9WktX9EFMnqXS14vFaW5p5T+f7GAwoTmPnLmeWhqvVCgJjeY3VqFYOjbndnXe9kSP6Lu+7w97Ys52hzQej7qg779u40Frk+uvCj3Mnq/pUSd9ajyRiXNOEOi6VYFwqCUO3uvyX4gFPD8MabT1ndTPIvJ0tMGLtaI+37DOGIXvF5TqrkFSlhpSFjDCmwdgVjo2zsTCAswXERYmnyH2gC03JXwmAgmcrGB1VR+dFLgBuvLamHp5UNgfg89snBosvnSAFCikS4OYm4r3hPu51eljzAQSqYBcQnX/H6tSo6JMqeXaOHB8jx+zovSMEOnpeuQ+2re/OgPgYY8SFVvA9C7262+ESDAAaAh2z8rpzV5/v6vNdjt/l+L9Gjt/V5zvf3fnul+m7H1Gfm2ro/vocBjy6Poex7Q7La6kXdEXvjy7TyVUMBfq+dOjQmWa3qMGprgBTQoIWdJM34njtvLGXHXDBowZUCmoq0jiAt9ktq1tQDijlrs0jv52d3pDhDV21moNEtgQbfV4YDQUH0KUujaBN4ox9tFgd3gi4Fq655djIb3M9CDm77LAOUwhoBKbFwLqN9dBjIDGC1uFrRaPbZC01/oCvqzi4+3ReNKB7eNkmvgexwXgGlG6w2NAn87IPClxgna2x1z4rUOQO7M3sGrJTHGaz54LH0ATo7Ypvvvvh8tvSIXV9c0/42A6Af5yBiVD0mmZL9ziJEkpxg3ta2RxBb2FegEfKzYXc0jFzdg5xmESKkwS5Ps56/B0/Xpl3z/Xb19Jih36srwAqGmNY1FeUr6OML17i66lEfJVBszQ0i6Dh/cIKFVq0144+bOOAyyIIHiiS1pORa3hWCR72TPAEoW7SgJIwdFS3tJxMa0+mowLPQnhVOl7LH5Y+fhGiMo3pSMXUkk7bzZizDEMl/sEYmg66wfUiBS96Mlk3iNQij7DsTokkS6O0fAsKQaLvGBxDamPic0zEVIeEUKJJV7vkz6RZ8Pmf6X7wzxWe6fE15Esc6YbOR1xc3aAZEVqI0NIxQBn6dTpCwwLfRh4oDmgDOCj0T5HAEFqKexrW1qhO4PdoDqYGB0jVd+eiif5jUgS47Dsd9AJH52MgDGMdnW/y4UdRDKzSrSgtrGwFYFOCdXqDEFLhhtw0vfkKFKbHz41f5HhaLJTg7czfO0rfE0k+n7j7J0W8XaT5K0YaU9miuRFa0wKUjfy5qdfqC3eKPpQC/w9vyVepiIYWpfg2ShlQFPAErZq82ln6glr+SPAEa78WWhae9gVPhO4c3R+/lISAFnSGOwaSOTRpfgDwaFE6w8zJYXRhiXrFv1VKfQd9R2oJLaRosx+gC5NQqsfYgeGxCnj3S2haseLWzGGmbIa3t1OJt6uA7HTFOJjUByzC9ZWT6sAFDZkUmSxCKv3yWZkXo6khC23qReKVOvUu9BHokuI/gAv0nn3kAESPWjSHswtGzvGYMwYPGFct2z8EG6zNWoogwh4Qoi4UYKKE4dXssgYRgEl9Prsdxos9M0nt4VgAgu2RNp9eu9vuWNQuwPMoVAl0rSXg2fUChrcJNo3vtlg6/2O+PWbSC/YFexEuX9E1Td2n6EbwupE3gtBaLIEffHZ7i6sa2Bnd4WP9SRFsD2sXDO7l77P5cNhWGbwV68bmp9JMq9+grx48ntEv69tiD0gj+3TaE+Xw9/oo2ANyzD+a9kRB7r7w9eV94esBc8g+oPBEa9h9Z+vz+s7Wg7ouPsP2RG3vPp2Fn856UMbFB80KGb8pVmOhTMGrnjoYUs2ip+mNmdKs2tEFhJIvlr88wiKR39Ommx+I6u7uf6FEFAo= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Query Parameters

+ +List of account objects + +
Schema
  • Array [
    • attributes objectrequired
    + +The account attributes that are aggregated + +
    identity object
    + +The identity this account is correlated to + +
    sourceOwner object
    + +The owner of the source this account belongs to + +
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-campaign-templates.api.mdx b/docs/api/beta/list-campaign-templates.api.mdx new file mode 100644 index 000000000..ff03d3e3c --- /dev/null +++ b/docs/api/beta/list-campaign-templates.api.mdx @@ -0,0 +1,137 @@ +--- +id: list-campaign-templates +sidebar_label: List Campaign Templates +hide_title: true +hide_table_of_contents: true +api: eJztPWtzG7mRfwXFfLCtIqnhm1Tq6sKVaIc5SVQoaX2J5LLBGZCc9XCGOw/LOpf++3U3gHlTpKTdxN6wKhuLM0Cj0S90NxqYbxVvLXwe2p47tipHFccOwmO+WnN74V6J1drhoQgq1UrIF0Hl6KZyLPzQntsm9WC6ZVD5UK1YIjB9e40vANApAAoYdxxWAFdnlyaMykzusplgvrAiU1jsi81ZEHLX4r7Ffm6xXyPh37M19/kqqN+6t+6wDBhb8dBc2u6ChUuR6VNBlNa+AFwFTC30I1GtBMKMfDu8h7l8q1wHwj/23FB8DYdRuMT52ZZ7ZKoxaqEapIZUOfIFtyofHmCmBF+Ewg8IjI3zpZFhSBfeEB1XdljJE+WMf2VutJoJn3lzmHgQOUCk0IM/w8h3YZaXQrAbmPzwYswuNTGOPccRJlH8Ih76w+tlGK6Do8NDS3wRDrKxHnDbWXu2G9ZNb3UIcznka/tQE7VmxnBqyRTesLnns5XnC2a78OeKWFsH3H3xa2T7SLs5dwIgnvgKlHFges2OAaQ0l2LFK0ffKuH9GucM44qF8KGnBCMftZrwYGW79ipaVY6g34p/lX8TFEvMOVCBfj08VMup6c3ngSiSc0KPAW2gIHJ/HoGESKoyeFFn10EEEnjPgrUwQWpByO7scMkOiDsHSPg1X9gusBj6+160WBIcxZgfhh0vYEZM/s3EN73ILdJ+PGcHqFIHzA6BqkD4tbeOHElKwQ7+t3blhdypHWPvAyTp2nMDwZagRSD+xAdsWKIOSw4QvcixpHVAzQDO2fOYb0A/diBl4oDdCSTVwgWKWWQmLm3XxH4wjSBEw8CB0YAKo4mQ1VnyLwIeA4+IONjeBp03wyrOxg6gN3BsJVwLBna9ECUlEDjqAQH5L5r5AeJE2H7hTiQkFbA1oB0FGpsfQoKUccwL0czzHMHdSkpOqOdGWQk8n8xiCawg9IEZaXlEEvNaIBB1NNEPeRm7BGixWESBNvLxIhHcuyFYVNlphjLi/otp/SecMOBVU1i+IZbLZyhHQbReI0ks4gnZKADj3eFrsEeOFRyBTCHxqsyEBQZaVoF1Fhmrg4NKikWSxJsIP7ed35Dwbwnad056OeU88d/qp7uRn2yJdIE8PzhCCJIfBwfAGfFrlS2ANQs0DG6VOfC3A3+78G9wdyBb29YubQusZOJXdguLocvBTDPtatxWKuhhaHMZIB+bhoH/FP0rtJraWYkhMG/2CxALRcFE3wZsN3Tm67WjvLbDXwKE8K0oKdz3OcqUDbCC1HMJsbAEaF+MaWcMWqx9JGZoS8xtq0wOcwuJhdNA3hSmkqFZ0xwYvcGs2TN4s9vlXaOBf/V6s9mgaxhGH6VYKsO2Ea+WIBp6jFcBw1519lcOf3lguzlJD8jsQriCFCTGLHhFjYN6BrMzxcMiPfKK9VTMUm93RjDVJ4enRitWBu664B8xLYMaSB3xVtZoO87H2BBV3CLhm5eQAeWZWxPXudcrTWyKsFMttFc5XhtNo2a0akbnqtk8arePDKPe6rb/iYhp67gdszNqaf7O2HWaR8agPugOCDvUKStyMuglq2h+oJwmuBZiCzEN+RUgCkXlXoIQzIRwWTxQhsdqXc+t1tWKdweSMhXz7Up9BXJBraVWpuSxSrYyTL+PxS4linPfW2U7UmTHY4zrjMSc7C8aaR6FHvooJrnq2ou0GPhVppYt5EHiM0II54NdQyfLr7/Q6NBc8oam0Tf63W6va7WEAYam2+t1Gw1rZolm05gjmyX04ijCRb/6pjI+GZ1fja/+UYyLr6DH5rHjfjsbs3NcSjbCO4NVAlilLBRCBYtvO9vBjrDZZrgrv66sxl/UQ1y5Kw8PZPG45diuOIlkXmEXsyckh4GLtmcxKyILd7e0zWV2ZQiWOi6A4WBU8pekupLI4HrOxpeTWh/YxjQGdfZ+CSqTFUotsdAlhl/NjEYGWM5F+vYzkRE/MilrJwokZCse7S3YV0WWKuqyGgoF2TOpt4XmW9qRBvxPaVasFXcwkdvKRfP9bYW9Du88CHLE5+BNNRWdIoFKEdUE0tAbHQBRinWjDT/ugzfZVQJGJfuvYO9iMQBvos/Sc5KlCPCUepwKQphjfxZMurspIEyEJiIR2iGhoG00PAKbMJlTliWPhG58CUEhS/VIgpwbqUJZfJXuftjNamwx2AXXZSePZTA3Z+Cx9NJKXlSImI7SPRkrayznj3YTXGHyAHnKQlOiA5Z0pRIU/aLnJ4I/QwArxffTYSHBFRx+s62HQ60SnxjEuuSPM8szI4iDQ8k+dBwsEYJpINeiYP02ukTP8IRSFMi4Qd8jIZKJj75AWOaBHrpCWJTaoxzGF1vcgSrM7nFg29cuVyVlLh+N2NKOyGZCgR1QZpE8HgW4zuSCS4q/igLKT9iuypiFEeUJmOdjWgbw5RBofdFpnNglZEj3ey9ioX+faZUYT7k+88QUoW54YGEAth5vzQMIiRAOGQxfmMKmVEzbMJjwfc+PM0X1Up+r0blqGOAOHhmNervT/edji3HJIqMW32Rax9pciq+hTPdkKFNPrelnw/Phu9EUnlxOrqfHo4+T9+fy52g4Pf4r/DGdnI4+Hk/OLiaX46vx5BytTEonVH+9CJ97SSZ95PLZJqcxtzBTy4ARCMw2JS6udOtTbmMhb5P3FAEV9L6m4ov3WQwxMt4JB2opHTeUbej7vLHjLBvhHzydCOPhuDhynQ1NU6wxkwg2m4kvsPTb0kxjezD7VgSGYw6uJck+mJL5nOwKvkYXQSYc4Sl2cnf1ckmibeXDM5ojurqo/mCIUilCAppLbaqhAVlwHSQd4jDN8xdFqdxIXJw0BiJgqaLgaYYW7YfyEmT3eskSqNXhYnR+Mj5/h/J/BXJ9An8cD8+PR6fy4fD4avzz8Cr1Y4QtQDlOR+qp+kFdR9PpBHUJNQmanmRVR/VHt8TzlV9x+ZQJ5nrll+06wxmytF6nuK72qa7dBAzImJt5wMzMxlhsEz2Ea7umEwFW2R62BYS20f9grwGa+nmPYhBl2s0xKb2U0T83KQEdoP8IaIEKLj3fxlUJzGjgRb4p3qSN1vFkOh2dDiWRr89TPzMETj1/PPbfKVQuSRDAPMjDf9Rf0nF1C+PqRueo0apD3CVtPGbwM5uPadY/stlRsgjQZkCy75DhXCA1LW1OynRA49wwDBJKFYv8NgimUNOAX4gk2nkHIAQlyb6caWeOSizSaizzo3fcd4H9amtGbp5AHLOSgXrZ2BsziFmn28EM8GNxtDYL74fTc/hnfP52UgypTwQsgyIgwSKIWspWIgjAzco6aAQRCOJ4Jnfs/yuwamsSNDcFBLOj+yHbxnZdocdw/7kKPtBPxxes3WMOdxcRPeeLrBMk3Nr1Jeb8I8fBJSI29hLwxLcXdqlvrcl5Mno7vD69Qldl9Pfr0SX8hbAKFEVzJBcyj+Rw6d1J6soJYHgaCEzJoyU8UFAPYELcDdINbfkruA+AmEwtWdBDjV7SIw1aL7LxZh4z5WY9e23XRb0KRhme0f4/m/FABtW0+SgdgNqpouSB2nV8A2bbsmycpF6RsX7gHq07twrOHzm0XhSSl2XmHNKElFluJIHpaZopaMIA8+1yMjRDzMnSNJUYS79YS4tCUTsalqJcLtWbIhqRFLdrTJ1jo8UFXKAZzM0OA6b2CWjHBPxKV7ezXaCRDQqOaR09rRFicyaROQk9mfPJR+5DtDb4CverHlegx/K5z1htzhS4py43TeOo0ax3ezLJXOZm7N2KF7oVcsNue0LpBPf3VhBBBioFSKY4TsGpaVvFRZC8bWVlElrJYWn+gZx3mMk/O2IOqgBW9/Pzcsk46PgEeX8HyyN58DrOTIaeCUxBUFVARgiN+Uz0uy3TgP/aZr/PW5251Zs3egL+tOadJ8S3qcSyonSKX8Ozi+H43fnHt+PTKwpap9enoxyzcm2elYJORk5tO4ERktuy0lgEEYT34TGFfmEwjfN1W8O+lGDY5BwRAJRZCVKmOMwlmH1M6/rSBiLwTMSUc490wERSPsFUt7ZiY3fubRfXM5VSQQSkXua3M5EzIANpO1AUNTn+2Nruo5Erobw02UsnmrKqITLuYd6fUcx8SFHiZrs4fpAcFNw3l78XmSidUiTQ09M8Es10RnrtiwBkRmlhfrMGA9Xj0eVlPvikZ0/NYJ6o0gi1O5DDpc7Grko4oTsYgKOVrWFEUyF33NZeENgz5z5XLpWy89phOuRfuE2+SNbIXMqx463PNKKUhqH05A6WeTxPSumqcl7x+gKzWHhg/Fwqp1r4XrTO7JroUWi+WBe6LaQha85lUoqdXE2IrVKtNceIPu8mP4+m55h6+PhuOrm+eInkaCRfBfGIaUnJD4UhSWqnr3wfb9c1JDX2+CSX/ZRbkp1u3+w0ByZuSfZNk3fnA8NstBqtp9Q+ZAaivYXMUO+BZTZfMfgXy0RI3WWt0U6wA6rs1RFOlpepRDGyH4UlLcVxOkxmyZUeIIdTjTIRKDihyjco7YvuF9mBT/TzE4roJy2vYGg/xdlwLBZ9VGMkLjm9SYHaIa62bPK5teFOz8nThrtECfQUMnjjRNScclPYbOVX/OtYvmwYhvFUq1+tSHofg6qGPrfdHXIJbyMfeOGrAm8VCpJ85At+gGviK1KA6rZSDixFgJvY90ZKg+VR0SUJBRFPYlpGjQ0hyLbdfNLl09EZ/BuvER8vphNwlEYq7b95o39I2GRzECl4JEcl8UXZcqnr1OQqeTo6Bsc6tQ+3KXNRutLj5iS3mrxncFP0rA5tTprzZtPkA8NoGMRzPeBjxBmentIeiESnSIdrdLpBxC3tvIGbLEguNstDss2vDwfQIqnzAkAwJheRnNZqJB4esvvAhHtqOh+SiHWYE+uiqpQCQ+r44KWCFwvrM6UUnuYOTdYqDQHB99xeRLo+QBZu0XwRPqUA1QBJ7Fhc4vZr+H4Nf3QNR2HaZaGK5VIvVNhx6xoF9slTC5Ua6BPxNV6lZJINjNmf0ZC5wiYLgHIAz6okS3Ig7idhzM5hy07GzBcrYdmo/zsWwuGeeToVgZudEgSVpPHgc5KU4OCjL1yydHU2LTTDWaldFdIdwcG7UFunFihjQLrvKm8mH72RFtEi4IgFd1gykzhoeqWl9VVSpmcuvUCkMkDaVeBsipZlaK1o359N/IX8sbvWba9zOyVMpwmmV9IGv0y/ZJ5FmiINuaBmj4vCk9TMTaU2siNu3G2pJMTdtA7ZFgnkjm51rJEqhJS+KJ5IobUzVyjqYaWlSDT399XOgsf8d5rTC2PljQvfy6NmOY1tATOxMLW0s5O0559jataufIhTScF7IOPEXy+5O3LJ3aB01RO24HRyJ2cPpNuLSXtwWNjt7W3Fo1GYSA2Dj9nr9JN4O4PLxDWW2ZDDLYu1LDYMgTuzKBRvKA8tVmswGoSLHVcmZ/BQyeOS0evsPEpVQ1A/EB0laJH72fXu3LKOhbm+zvzCvQxtR2dijmecZDJXFXPgexuZuKIsz5sX7E0+rYxYsurJlmibfZUpw/LgIqt+suGzcrYluF/SI1nRVcIlubODh1cslPt7lctVqdyVOnOyTedTS6sMCOKMbjp1q2rt5BoZ6Nrg7L6I9IZA6v7hRbSvojonELXDGgOqquW3Rutq6jE0dL3kQZ39dK/3FKpZDDHqLMcy7W9CfPTxZHQ8vhxPzi9p5/Xnyf+MPk7OT/+ReX4+Sf3MOKKZN0D4D3kLVFrmqos4UicmUlW9H4p7dsmplYxzJTWhAhI8E+ZgYLUHrfbA7A86jZnVb887fW50Gk2jEh9F07WfU2JKChPacmvWjH7NaF41BkeN7lG7We+2mv9MI3mE+6lFmyhZTIUJqsTylY70C2WVMtufr0KvXDTauF2VPguhquEr6qDYX8BUhfiorp2mwPNcKm2Po+xUtpgI0xNms9Pk5sxqN9udTrs/g98WqHmr3TdnvU5CmEsAfEHFpJdyuNyBEVXJla68jkkniZInUmFHrbjPI5kHhohz0R30O03Rn4v+DBM77b7ogGXq9MwER9qs0RzUmzabt2zUudFNWycSy7LdAvnm0QhaNtF1K/JXaRmQfLWxCEch8fiaLBvZMWU3yXJWLOXjokSmBTBGXXIoqSLVFXry9eaSUEnjkjpNJS+bqijV60eNdN62VJW2z3qi2+4MhLA6zXaPm/3ZoM87c2H1G3PR7M0TgZmKtTruKjMpm9W+V2v2Se0HR22jbrQ6L1V7derfjzGQdSZ77X+Z9itP/ndU/hhhtbVWdKviDDB5IAmH+cx26EUl2bYaxwRJkmDytwqwKn+RAvMaZ3nEXt9WJEDh31bevKnkEvnK7BSz3Tdbc37fg8XK7VzsbLJ20aacKYvr3r9rSzaYtxszszsQPd5uDhqzgSWMbstoDbqW0TKsRPjjzR6kuMqOYCC40YNpgR07anXr/U5vuyl7BHrRWEkAf0BTpST73+BNfNuY//uN6bTdLMWp2JvKrNGxusZgbnbMfrvVnvW7sMh2Os1WozO3eH+OfrqyYiVChY8e/t0G51HBfqIG5AxM4TzN7qZGiej3amuGJ0yF2FuipCfZmLS7BNAZjCJ5utElOtt7RLt4RJJVZJJe7hdlSr1u9L5Qu2f0LDHjlCaCKBswaYMl6A5kRvHHDaFKRP3FQVTuAN6/yP8oFgVn62CfZDNkIV277GqXY8fGamwqtGY1IFtyTCxdDD/zLKrqjau0n37hy4bUpzzZeuxZOyQS3wJ3agv0kQFDWaluQkc8ZvfFpvQy3UQlQWYq2rMpd6BEvcF+4habqvkdq8lgmtTn5meANd4hJ3vt2tCf6S7MTg7SlQwreoLPYAVutufdNufNfrvR64Ad562WMegMBlQOIIvdt2fu3+HxQNtk6mgJEATMVaBOZtLgu9ek7M+V7M+V/IefK8GlPwp20LsLB8xPjaYWv/gilPJRZCutEXFDs0lZJBX2UmfVKmaXVnx5VmCvu3vd3evu08+E0cuputVBvSXXp1F0fa5ddfQIF8+C6yNP6+NxJdVI7v5JRtLOnXKR/vb+ChT7Mxa/BEx8XesjIL+RfySX8gLyw5gf6lpEXZugl/6EF4gg0VHd3ACWSFhHhHeCMRFKkqpVHO2t589sEFC3xEXEi7Holg3aSI1cl3KnQZVZngjcV9kKarKAOKpr1eQljHtPcu9J7lej/Wr0h1mN9p7kXnf3uvtj6u6jnmSMFWmL8pOCaLXitPGLVYzyvbwfDhokN9HHKkesynsrCIzFPlYl6zlUZs3GrDHvmaJt8bbVbQ3mTbPb5J1eo9eYtZu9Snqtv0n0OFayrE6l+C35KM/SCR+PyEUuCFcQep6VTf9FWH02R7NGVb/abwaaA0k/xL5jc1ByeYHnYZHPvfaQgowP6SY0QpsGbVfY1tdtoQFnCxvv1VIXdqIo4XULNYa3YzG6ph+VF2cBcP372nCOB+HV5f9KyOJR4osM0BI4HnrNHgiWHcY1nv49ebALLovUfyPvVN8P8xJPnk1xxqc4Yzb6agqBih577p2y/C7WMPtoIy4lgzckemW0w10QAAgIpM2K/c69f773z/dr/H6N/2Os8Xv/fK+7e939MXX3Cf658oY2++fQYGf/HNrWDRb7Um/pbp9/tZtOqqIwkNdO6QveEx+c/AoQJURoQV8xW3P82Fyl5PppLGYgp1DiE/lYjKO/l/MN2ATseajztR0X5LjeHX00Zwa0KTE7WB8gVQwb0Od55AB1Iqxv00W6JJgEXJJZXZRUib/L8yhkfUjyHmuOJJgqHkxVckSPsbQEgoj4uLK8GS43P5jXte88vHwuEtCGuZSR79HRoD0DTHNTpJM4yQcFL9HjlqMXPiuYrCIYpRUv/Zxgsyb7SXCf7uDGjYvXf3t/9SZ14bD8BpM+mckuQETIjg11Eh870dKSfMdumNkmQb1hcwcmzNRnyVSd9f05GPgpWGQiKXYSZASw1+5fa+KZfhs+Qnbr1tgJXYRi61sO9McR6ENtN2s9L56a13OR+JOGVpPQagQNvxOVwUKS9saUZTcmKC+C4E5A1Hr24BJeLQUPoyd4glDzOCAlFB7ZzS1Tc+3ZeGTg1RBeFo9b9z3dspftxqTN0ldxjPE0uReI/2YMRQfV4GYRgRY9Gy262q9GGlFrGimUanLIml0Dl5DwOwXFcKUw8RkuyeSReOCsuZZUyU/EWdB5dbA5M2d6fINn3aGl5ZlP+ARZDmccsIYD1qQNCBT+6lMAgCzoNs6B7IAUgOOE/2QJFKIpuydhlVp1An9IfXBpwAPf8rK49ZH8cZQYOH3xIb3A1nEbMMPoUcfbfXgQUsF6kFfAJ8TSuYA8BYv4Oh4sijm6SXzjXBQulN/bfHHGwyRlgieDf2srvcGSfD92999k8faW5o9oaZSPa+ujXSoYSAv5T8pfK6bwArpYCP4f3qpbZsCdhmAl+dpXGhB6ySjV8hMkS1tQ8L8WPETfr6q/JQaaCHE6qr8+QragwnEfUOaOPER2T+lpPbK82EI6lshXuvsikp+YgbHknaJ19h7iMdcEtmAsRp9D8dgvngrKknr2E81svERiFbl4+wqgHa3wo2bbJMKyAzOShgtCM1doWnjk+sW9tBZToT9MgS4CE/4qmMwxrwwha4rxW8YCvuvvRQLpkYuqeDuZyBQrn6kavJpz27fBBmmrLYWzpkvXAS2I7VIjnI2vChABmKsOLnj+4lB1Cg6xLQDB8EiKT6veqBs1Chfg+drDwwpuCjh9JLPwxb8gL4bfknT69/HdcrUQYQRxuMaUF04vkhGNDB5vKiXBI4QjS6ABvv32DXMiGE09pM4QQUgJXMlWtW+kxI/1sfJSkn0WmGXQ32JXeYQKfUR3dzr8Z31l/BE6xl9hfyYh958M//E+Gf6IOOjvwj9TGvYf936UusmX1J9J3/03vH+Pb3g/wrHkE+wJxz4kiUl1gYA0ZrQUy25ytyLVq7Cfj1DiDPK7EfpLfEPEqv7AoR4e/h9JnXXq +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

List Campaign Templates

+ + + +:::caution deprecated + +This endpoint has been deprecated and may be replaced or removed in future versions of the API. + +::: + +Lists all CampaignTemplates. Scope can be reduced via standard V3 query params. + +All CampaignTemplates matching the query params + +## Request + +

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
    alerts object[]
    + +A list of errors and warnings that have accumulated. + +
  • Array [
    • localizations object[]
  • Array [
  • ]
  • ]
    • 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. + +
  • Array [
  • ]
    • 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 objectrequired
    + +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. + +
    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). + +
  • Array [
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-certification-reviewers.api.mdx b/docs/api/beta/list-certification-reviewers.api.mdx new file mode 100644 index 000000000..61ac639c3 --- /dev/null +++ b/docs/api/beta/list-certification-reviewers.api.mdx @@ -0,0 +1,99 @@ +--- +id: list-certification-reviewers +sidebar_label: List of Reviewers for certification +hide_title: true +hide_table_of_contents: true +api: eJztXGtz2zYW/SsY9kMTjSXbshzbmtnZVRyn605e68dmd5zMFiIhCS0FMAQZ2/X4v++5FyAlSn4l6bRNqi+2BAIX941zIYBXkc1ULgttzWES9aNUu2Jf5YUe6Zhbj9RHrc5V7qK1qJBjF/XPokYHF71fixLl4lxn9B1ETibaicGbQ5GrosyNE1IQXWFHaAnkxMjmopgoEc8T64iBKOwvyohzXUzE66Mf/jd49vLwlUDn/YOjk/BNlsXE5rq4FJgoVx9KnasEA0Us0xRU/fQdcbQwG9ob06G/ETJ1iwMhq1NxSTNA3qvo1Kl835pCXRQDTE060InpN2j1cyWT6P01ayPLFVoVNFrkpVqLMpnLqSpIjURPk5YyCUprkcEDfNMJTRpP1FRG/auouMyo1RW5NuPoei2qpKwoLmp8QZHi8BnoqQs5zVIipEZbu6O93lZvR+31tp90h9vD4W6v25PbT7b2dpJdTBHY+lCq/HLGV6qnuogW53spL4Qpp0OVe6O6Mi0cGcBbvPPOHCslzv69xW5wXEiTyDwR+zZNVcz8vak18v7RpCgy119fT9RHlZI/dpzUaWa1KTqxna5D1+sy0+su0GnHNZ32TLOP2chTmyuhDT5OvUdF87obwdhqTi/d7Y0btI551VjlGOnJ+KatLhqm2uhpOY36GDeVF/4zU0nUSEIL/O36Nm3a0cipZXW+5mawDQ1STIxKeKPXqsCDjjh1JRz0UrhMxbAxnJ3jo8XWaZHiMznWBi6H8bktxxOmEwzz1ZjjC4xRq/925ce2NMu6PxyJFoVUS+gCWoXiM5uVqVelEq3/tE9sIdP2Po1ukUozJD0lJgh3uD/bgTreEA4TCYq2TBMxVCEyYDk9qu0G/YmW94mWQJ6CqsYGGktgMdhMm1hxelOuQBpAGi2IFcGCcO6ayI8KzbARK4f662km42KNpOHkCItNlUkwsbEFeYpTNGuLifyNJW8RT8ztR5mWymuBeoPt0lXcfBUe5JPjkhMNrU2VNNGcn/DIW31lpNPCL3p35OSmIz3nIbX1S0cmI8+opBTu0hRInH7YkFzB/M4q/c7LBc7agc/HZNvnVSu5jCuzzOZYvOolegRS9pweI/WkiWO/9bjB5q5PFFotnbRafdFSH+B6puXbSJl1qzsPrVCnTuebGysVjRHqg3gXPbXDd9GtC5MjHu+00FzGoCCQbadIE7QsLxnvGNT+5KYjgRcNd+zbHmY2KJwtsiaCBZb0HhF6qTKcI412NzboX1NZg2U4B1IxASQkWHSXWZYGILL+s6MxV8tWknkuyZ66UFM3126HP0N4MjRWQTmcRXWWk/IKreZ6L9t8GRhRD86W1mAJRU47fHbw6uTw5L8dwUiV06RM2vS4oZKqH7kL8Nm9kx0mkJ9RadJpENrefLK7sbmdbHVHu3sbsdzc3t3sxnubuxu7W9tJV9EE3q3vm+KfJbJ8m9glzYhEuyyVl4KDBvbQgYP7JBvAgPDS5yofl87S9OwS989/QN2ETBJ4ifuUGSXP2Bn5Gf9RDXMWjQiCCJk4QoPXe3h4pNBdYVF7i0X2FUQcmIQZQO9rGtC7yTv3U43h4iDPEQdt1ACzdddjIl5PxdAmXD5og0XPG+xTPbj21KZnJqoAj/s2eYA9n2uj2uNcauJQMcsxBgpQ/KgTil1e/zxJ0jeJwP2aHgZNdDbFU5lAXi/ffhCG9JrL+BfQOnyAD58ajfGiGgL71vnkhmnVjpLDJxt73d7oSU/K7m5vc2d7uDeSW1sbe9t7ezT7FJ4ix/NBW4d+c+oflMEiFIvUohrTv0IhcCVyU2KAJ78rWzRtwDQemB9831rMwK+gam8N4Orp/hvR2xGpNOOS2+V4QQmmfXq8lK8guSf8OtdjbW5iRRkCr2fRs4Png9MXJ2g5OvjX6cExPhGtpbp6YOCtCbmlZaA5sefMcRDgXGIVULRyALKJVqDagkDSuPmO2n9zlw7KFAERYUSY/YYR86TFKLfTRijFvjQWj3RHddaQYdGGdTeeiKEEfETe9VB6EMcqK9ovgiZbAUM/RtWfJJqEBLhlCOownlM1Mo1fbH1ZhFBWDLltWRBC1bFq2mKmysXVo0ouL+aNQsEBzu/3k0FcoAJjn2hEYe0tgcVgH/DsNdfk7mROaaxSQhVY6GMu7mKbA64jM0E2DRgS0hEv7kg8pupXZ6z5nMnp7qVn5llh+VksS/eAuHuTIv20WbT6wUcVgo+rep+N2BqVmUJGCgUrDw69anNVge/hxyp2V7G7it0Hxu7iw6OAycNThj6by9Dn1ISdUVo8l6BPzt5jbLV9+qvfKfSGXKMt1gCRfnx7EnZh0V9dZFRq/4b4yC/lN1QVlT1ClVUVYdXSP7MFMch69BKMkIlU0me+Zxx7kMiq2lqe7bnNhxoOam6AiMiaubi0pZBQWV4aw5svbk0kVjnzfRG2XRARzvkMSLOapO1ruhWSXCHJ1Wq0Wo2+mdVohSRXsbuK3a8zdu9EkjVXHC0BJ7lyOpX5pfe08JyklQIdZr9/1SHHplpEK0RM1BgraiKHaNjdHG6OdmLVS2QvebK1N+rGT7pye2dzZ3PY6+5E82v92SyO6yBrxtScvb0dWcUAcR+B40oD53KFtUlz+6+k/f4RpTVKPTVuhs6h0vcz7Nhbxo6vbAHZQBjYMb9le/H06AXRp7MHRJ70Zss8VgSzver8L24EKfm3NnWhXbGCjivouFp+VsvPN7P8rKDjKnZXsft1xu4nQcfefdCx9wnQsScIYo0IYv2R0DHR/tDUCEaBDHEJ9RqCjRlEwaew+xjCvpD5WBU10GugyO7eMoo8sVa8lOayAkuusRNpZuqi9Ia+U+qbV33RQYoxUqSh018a6Ja8Sk8VYVI6vMZHzCiOSSDQzS/bgxEdUAoH14K/1bNoE6clOOSkkFrae7XwMU2nwEYE/0CB90HHSNS/4R5nsNYX7QeLI5L4BUksDi5ipSjm6/3f7ZtOCRyC+ZzSxbG39S3HBfyeuTQoI9RF5tNXDUFXUH0F1VfL/Wq5/zaW+xVUX8XuKna/ztj9BKge0NDtUB0dHgzV0bezIWos9ZyP1v/eiJ1DJXDA7i1szFg9mWFwxhVwJWJozDdw+PpVP1pvXJty61c6uV6fP9bsawHPWpmnGFKd576CxWCp647MdKc60GrsOR/qHkJNN2Qgf0SWvIc68PFxP0GHdZxrcmOf85i413i4shDV58bvpFwdBr5EHSI8mTU6BB1cipvBYoZ64nvHvTvsQkvyQa7TPL3+clk8oVtkuUl9d86G/gKcLohIIryf3ds7JvDtZ1+6vTdbUGjbv7s02Wvq1hVPlcxRGfiTMI9+fHvyWIwJcnLI+zsCSlONgKB5AxfhlDaoToXQIF5lZtexBo1zNxRCYpRCYBFu11Tnnl8h1x8hObNKaZDifECjHn6bQDbG3XKX5p1pi2c695cN/C3JIKK/b3SWVXLJObk+l4nvKmptT63N1OgmQ4MLr9qz2J/jjhHHREKmjrX12ZN7eu05elRIoYWoLvJAmgh8NE9LxZXVPpuPBr020Wvy8c68nWisp81hwqcv4SZ8oexQxBNrnfq7EOQ6FAZn4xJR9NlsndOkbY6IdndjjqW2n7Kt20CHzN8LBIbxziSHtDozOLF+n4RD8ie2LGL+J74r9FNDZm4+wyJKPRMbf8IVmQWeacI2Tdj2OcAF/v0aRY6F2CYZOA94B9if2Z8zQWB0Lu95WjdmdSa/zmNoaYjBKlNxWd9/6c8SXPgk+AH1rvsgDRO4rs+P0d3jQIsWqoayqm2BRQ0u85tarI8LevP81j9u0pr5Z5OXJB7Mdk9em/Tyt87St2SSP0/e/YMy3irTfIuZJsBdcjeeduFSFTn504DXlnfzHN96xl885VhlZI26ZXbReZ5QlsqCvJqjOp5oxfsAmZIFYb818iw75UhEyU7hj2qPCY1z9EHYOmBSOdRpuEFWzyw5YDywJLvSd1eGcxMWLom6UnXEW5RmJoZZqCyjE7t49rMN9dkxLPOGDCueVcYG6JpOS0N39MB2ORUSLnWPRyTaxaVPXKjSjKp0YRn61aOqKCZXIxE6XKDkU/d6RFvMqF7nDH/PXLB7daMSqicrhkuvM0GOVBpev7G2ANvvow1va09UmlFhiKwLAKbmZnh5eLJEEcRM+FHD5uP1MMitU18QofLIu89WZ7Oz0eZyAe2ZdQVK2TniL8K10eZ7ORoV2KJLXs122b+J94qENY2KkfWMNtJIU6UvjnxJehY1S1IM6vPbQWZVKeqcCZRLfa+uaN+FyrRravaXpKlWhbkpBmd35G9V69f1Mo8bFfiLop2M6l0lYa/C3x1/uB7+Wm/huEOP9VtKPlORq1dqfH2v1LjDHar3pnymN6zei/EF78W4wyyzV5R8pmH+qu+8uEOns5eKzHT6fraZ+YkL66OjACEe8yGMG17QdSMr1Y9v5nKej4pFQIHr9+jlkyVz5B/4X1zmhiydSSBR6l3wHw4I6MlbSu3woX9G++f/B4+OY2s= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 certification' (list-certification-reviewers)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

List of Reviewers for certification

+ + + +:::caution deprecated + +This endpoint has been deprecated and may be replaced or removed in future versions of the API. + +::: + +This API returns a list of reviewers for the certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-complete-workflow-library.api.mdx b/docs/api/beta/list-complete-workflow-library.api.mdx new file mode 100644 index 000000000..56220812e --- /dev/null +++ b/docs/api/beta/list-complete-workflow-library.api.mdx @@ -0,0 +1,95 @@ +--- +id: list-complete-workflow-library +sidebar_label: List Complete Workflow Library +hide_title: true +hide_table_of_contents: true +api: eJztW1tT3DgW/isq78Mkqe4GGhIWXrYIIVNMkYHlsnkgVEVtq7uV2JJHsgO9FP99v3Mku2+QMElqd5JtHii3LR2du74jH98mtlROVtqawyzZTXLtq31blLmq1FvrPg5ze32kB066SdJJKjnyye5l0jzxyVUnyZRPnS6JBAicj7UXRMULmeeicno0Us53hExpBF2YTIRFrfNCG1GNFWY0a6ibSjkj81c2xVq3C+T3skzTpcxFZtO6UKZi5sXQOnHdstVJapdj+LiqSr+7tjY3tuelzkurTdVLbbHmpfRrY5WXa+389qrrK1X63rgq8uSuk5TSyQKacaSF20QTR3/Uivk2eMIKLHSVLGrljbwRpi4Gygk7FE75OoeCKovLqnam986cKSUu/7Up9k4OxVkFHUmXiX2b54r1Jk7apa+etFKpTyonVS5IpDOzJku95iOdbtrS6U5FeMo6K6xTMAIui6Ac8O7UH7V2Cv4wlLlXZBNJLpHs9p+vdxKfjlUhyTbVpCSZsa6CkTEzkAm3Nvu4UWiji7pIdjGvkDfhmqlkaiihBf51d9e5X5t2OPRqWZ3HfBtsQ4PkPcMarha0KvCgJy58De+bCF+qVA+1ysS1rsbiGVvnGSm+lCNtZKUw39l6NGY60TA/jDm+wRit+qF8BLFXae10NWG/vvDK7VvQuan26mpMEe/L3SYmdp2SWXJFs6CvEjGtOFD76+vL8XqETEAu30wWHFDgJSX6pqIZsixznbK4ax88TbtdFks6J8kxdKUKXk6ayfGQ2a10Rcpos5LYY91Svgpz7eAD1J2Qky2NPQ8J6nGDj2PaWh59dUd/nWTrPiXs5xqiigPnYOGuOOWYh0/qYfQ6eD3UNLDZRGhKiZ9krrPeV2gpsoNM5cgRK61iDq3gkfs2UzNjPXKzGS3F1mttVHfkpCYOFbOcYqIAxU86w4zgo4EkmZZE4HG9ZMY1SRO9DfFSZpA3yLcfhYGaKifTj6BFe86XGLowGvNFM0XojCPlgWXVtpKDF+s7/a3hiy0p+3/f2th+PtgZys3N9Z3nOzu0eqG8l6OgmgX3ml/6V2WU06nIbQqL/BsKge/7uNvw4rMe+XkbMI1H6P+cdkMe24oZ+RUUkNg/xcv9E7G1LXJpRjXfl6MFJZjuxRllUeRFOaBblasVJA+Ej+Hz2tzHijKUHi6TVwev9y6OznHn9OCfFwdnuCJaS7v9noG3ZuSWlne2MYKkmgpwLT3yMeU6lfXEs0j1GQSSxs8O1OGXnyA9FCLmJsyIq98zY5a0GDpbzIVSGrKXeKJ7qtcRA7qHXJiOxUB6TLABdTzbS1NVVt2jqMlnYozcptzTnpgBGohGEMX8CQgJmWUUuiZuPAhlxZuLrSthbKVTNW+LqSrnrdFp08vRrFEoOMD5l/0ESQ57HPvEXBS23hJZjPYBz0Fz89ydzyiNVToBSEL6THn7TK1z0LAYQDYNwBLTEZnLI/GYZlybsSgFNmJxunsTmHlVWX6Wyto/Iu5OcqSfLovWPvikYvAxbgrZiK3R4sGQkSIk4MlxVGuuJvAFIEGerWJ3Fbur2H1k7C4+PI3QLz5l6LOxDH0ujASCtI43zyXo49h7jBXNoFDLBUN2BBQSIdJvb88R2B+VofHqpiQ4/B3xUdjKl4vN1h7h/oDgR2usOVsQg6zHWI0iE6lsl/mecsyKCqraXF7ttXUDDQc190BEZE0nJrYWEipztTHEiUQxnVnlzS+VGEvkR4mI8D5kQFrVZN1QhayQ5ApJrnaj1W700+xGKyS5it1V7P6YsftZJNlyxdEScZKvi4JeDrCnxeckrRQYIJpDSNGGHJtqEa0QMdFirGQeOSSD/sZgY7idqq1MbmUvNneG/fRFXz7f3tjeGGz1t5PZvf5yGsdtkM3H1Iy9gx1ZxQBxn4DjagPn8pW12fzxH9Tr1JDSGqWeFjdD573mgJGwY39nGTueWyveSDNpEJKfw5BmqiPKaRhb0FjXjMUAKUbIi0YgVWnwRa6kCwUqjs7I+dicgpekAF036e4NK4gSAqVxsnYVbdK8BoecCXJLqNnCsTSEVEPCfKDACHaE7Pwd0Wk00TcheXFKEh+RxOLgJlWKAr1F7s/vO989NOGVlTgLBn7goDdUO9LAAVAQhJzV4s4VPl/h89Uev9rjf449foXPV7G7it0fM3b/BD6PaOhhfI4Bj8bnGNtbFy2Wes3tCf9tmM6hEjlg9xY2TWvHx80NBmdcAVcihkbcnVJK6pJIpm1D03amgPkDN/M9SbcwEoxz15Ol7iF3wU7VxNhr7hkZQDP3JB3qDggBRgO4OyUs0GO1Ok2eG9IcEw9Kjp0eSduW8lnK1HpD1pvYGomNyXQEvDx6Ed8GiyVKiF88j+6x1yzJB7kuXH737bIEQg/Icp/6PrsaxgtwuiAiiTDTB3NGeDusvtQNM91DqEbrL3cn0bC+eKmkQzEQXls8+e3t+VMxIpTJUV57ArhKU1mAODmBi3AW22uO8GkSbyzT7qS9uZckFDWCnK0nYrvSYVTC70jvp8jHrFKapDgF0KzHNyvJuXkPNCe9M13xSrvQy+R5TBSRqztxWTZyyRm5vpaJvzXUuoFal6n5pwtcBNVepqHpJkXoEgmZe9bWVy8e6HVn6FHthDtEdZEH0kTkY/7VVtpY7av5mKPXJXrzfLwzb8caW+j8NBEylvDYAfNMHIp0bK1X/xCCXIfC4HJUI4q+mq1rWrTLEdHtr8+w1A1LdnUXgJD5O0JgmOBMckAbMuMRC6hmshCS79myiPn33C36fk5mvn2JfZNGZjb9Ex14CzzTgl1asBtygI/8h22JHIu66LihFEEfHGB/an/OBJHRmbwXaN2b1Zn8Gs+hrSEFq0zFl7vhx+40wcUrwQ9odDsGaZjwdPuyj/psIy3am+aU1ZwELGpwmd/cYktc0Fvgtz2Jom3yryYvSbw3PTA5Nvnke2fpBzLJXyfv/o8y3irT/IyZJiJccjdeNpYCs07+MuK15QM8OmEeK/zHU45VBtMoVUL/NaGYWUJlLivyao7qdKwVl/6lkhVhvw55li04ElGlU/ijwGNCI4cxCFsPTCoHOgc9PpxuVpYcMAFYkl3pt6+5/qC10jFKSdUTb1GNmRRmoUqM2ivw7IONJdkZLHNChhWvGmMDdBVFbbAaxWVdCAmX+oJHZNqndUhcKMyManRhGfq1s5ooJlcjEXpck7jCHw/pVBkF64zhv7AW7N60WEP1ZMXYTj8V5FTl7Jn3fCrxBdrwti59LUG1ILIuAJiaWeHN4fkSRRAzHnKh5rZutBYn+TUaCyJUHgX32ext9Na7XC7QxxbWV6heZ4hzM3nzdYpou7Kn36fMeePt9Ez9279KiXsJFQFrJZ1ZEYd1KEpC9XeZLFV/qCfGEIKe3d7SkQaVQ3d0O3zmQDUh1Eq+Pm3uf1CGH+sbknsV9lHRIUHziUw8Bki41/7xevj/+vjjM3psP46ZKvJqWjnDu64wNByVsauFWeEwbWbW0usmotIecPx6QAEtH4BU8YKWurv7D39lGSo= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

List Complete Workflow Library

+ + + + + +This lists all triggers, actions, and operators in the library + +## Request + +

Query Parameters

+ +List of workflow steps + +
Schema
  • Array [
    • anyOf
    formFields object[]
    + +One or more inputs that the action accepts + +
  • Array [
  • ]
    • formFields object[]nullable
    + +One or more inputs that the trigger accepts + +
  • Array [
  • ]
    • formFields object[]
    + +One or more inputs that the operator accepts + +
  • Array [
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-completed-approvals.api.mdx b/docs/api/beta/list-completed-approvals.api.mdx new file mode 100644 index 000000000..73962b860 --- /dev/null +++ b/docs/api/beta/list-completed-approvals.api.mdx @@ -0,0 +1,151 @@ +--- +id: list-completed-approvals +sidebar_label: Completed Access Request Approvals List +hide_title: true +hide_table_of_contents: true +api: eJztPWtzG7euf4Wjfkjj8cp62bI9c+eOIsuuWtvyleTktmnGpXa50jarXZ19xNHN+L9fACT3pZUsO26anqOZppZWJAiAAAiAIPdLxV+IgEeO7/WtymnFdcKo688XroiE1VksAv8Td8PKfiXi07By+r7SMU0Rhmwo/hWLMGJpkw/7FUuEZuAsEBiAGs+ckAnPWviOF7FARHHghQwHYL7NTD0I4xpElY2EYHv+vScCw7H2GAwRLNmCB3wOLQM2Ea5/z2w/YDyOZn7g/B8hzhzP9quAY9ISMf1ScRALggG/efALfNXA4UlozsScV06/VKLlAn8Lo8DxppWHIiF9my0CEQov2mfRTDDANRYJQb7nLsuoITyxebgQpmM78JtjAQwnWlZ/9xhje2wwvLjrnF31r1kcAtLM5B78c13oBqy7d6IZ494y6cb6Z3LsTf1hZJ/ZIjKhL0ESGZQcjx74wXSf3c+ExzQ7GIzn+RHCsTT0a98zykYggiVRS7Y3F3sADyYJhAJgOwHCLEEZ2Fo+I64zd6JKkedX/DPz4vkEZh2EBbgfuxEM4Cu2A44oK+/fNlnnps9GEfcsHlis67uuMEkobhJh+PDjLIoW4enBgSU+gQiBwFdD7rgkmFWYugPH8g74wjkIFRzDTOAYqVC9pimd+4EgiQvmJH0oeAFogxMIUCAb2Cz2K+IzR4GonDYOayWSBuOKqQigpwQjHzUb8GDueM48nldOod+cf5afCYolbA5coG8P67jp23YoVtk5oMeANnAQJcCOQTYkVxn8UGW3YQzisswIK4nfHs3OHjJ+waeOxyMB/QM/ns4IjpqYf8x0fMVkJOxfz3zTj71V3oP52IuCGPTEiYCrwPiFv4hdyUqwd/9rjP2Iu0YXe+8hSxe+Fwo2E9wC8ad5wIYl6jDjANGPXQtMo9IMNDN2Mm/APzCoNPl77F4gq6YecAyVHObM8UzsR6YcTB/jMNGACiNCSNln/BMYEAZzRMzB9s58wU0whUANWI1AwIzNwczDwGhBQFLAUsKoewTkv4jyPcSJsJW2k7iArQFtZXL+KRKE9JQI0cT3XcG9SkZOqOdaWbEdlxaqJ6xD59Qlmf04xCmjFUZzK1x6ERhO2W2CouB9Y5b+IOkCzAyF52uc23P9FEUmjBcLP8DFUi+RNoDy7/FnMD2uFZLcSsfED8JThLC3Bx7B3inbE/8C0fP22VTAPxBDF/668NeDv07ogWHbZ+H9nuyjZFtY535QfQ6AuW+ROaSe1DqSPbGXhoQ9ocfaJS5EajfOdcb2oDpxIxTIU0B8VQxGAO07FwIkuCgCI/lsOwE4RfsRCGTAPkvnoPLwAXVTGsgQ2dio1fBPnkOXysdMHNnUTUXlNn2w+GCooR+4Rq5jktof/Bli5y+rc8SDgONsOpGYh5nn/uRPIB39zgBZFTkSJXAuS+Y3MSCVhnnSPK4dN4+aTatxeHJSq8tP5tGxWavZfGUBGWd8OPCs0JVSkrVpGE0yu8amZTARBrIp6yMScMX5jWJqQQsjckpAv0PHMguT3XPwHCXMap4VtXrbqLWNen1cPz5tHZ4229XayfFviISe9RfFQgNlLgcRwY4rCB0jQo3DcaN22micNo6r9VqLEFK2pPtCzKE4ylBAn8Kiw4RFqvOY0CiRBQ9dl/eVi2HnenzX6XZ7oxE8HvbeDn7pJd/R4K3EbirK09gh5Co7kysbueFZmFWWA0mt00hBeRBop1zB+pnAQEUjWRst1T/PgQL6iC+fpEsxQJPyTigPMyxJOQTeXYnalpKMSp6gFLwK06BtRdGjNXzfDu7ZeCD5mpmp/lnvetwf/4rBdMqA5CkQVG5cnkYJ8L4gY2a7flzjrSObg8spWmCR7ElLgC6YjdpR63iTwVk/NMWWMOwsBr8RBJ1bOG3McsKFy5dkffJovAOv0OFzBn/RFIPrVJjcPoAdaoLOIj87wyg9JTa74IpLDsD8Kf0jvUtA4HJU3WToS6EtM/osKXdKYD5HdLSIoJF2njLYy8oTqOqTEcjIVmuDbDWOtpetn9bL0VfgN/QhqIoY/HG8x6UOpUwJHsSGfSkndYrU9ZcaCeUnR9wL683yCVJ0P8Pshuy4QoSi4EUladsB/1Jp2hqJjEQ12+sl6rDx8hL1dBw74BV7rOOibEmpAqTIID5tIdI29CUXIQ3z2yxARQpKFp+TDQaiefKNFp+RjEnW6P8AwRVXnIGcv5XwY5x1arKygiN+49ihb2kPX464ZfAgSSsPHa4zYUMGaK7RFrDPMu1XzFX6rWSkdSKvhVi6inc3w8F5/7KHHu+A/pAQX/au4G/JboWyjtmxcusEwsgKh1oSUKwkRUNhi0B4Zt7x7FJ2LHo8bDRXGiaEFV3ePOZqBKbC2jzatAkD/3Gm4L9AgHeGqUvM0OCvGu7zgjy5j1PGHFTZAcQP5TR3qJ+eL826bW3jltauLGbWi6jCc0uDiD1jzwGRYHL5S6WsxBYet9qicWg3223gnGhwcWxy0To6rE22t4U4YnE9WzPon/7Mq1q+wEUqI99KrNDolQHPBhZZ0VLrZFbuuesObNqR+340YL3gfa17lRFISndlVu6/wpHaNFxRrg5hlThsnJhHsGwcmyY/sk9qZr1Zb24vV2clMvXo8B0LorpfhOcJayldoe/EAJWKu9GgNGNRLjaLYDZH9yrU3mJRORb43I/Dofo5VKNmg80nZht3y8Zu2fhOl42VnQuEDoIV+cFSA9YakWhMojAhiRzI1T0PrJ9kr+erie+qahYRXD/L0HHVm9mBP8eIcL6aXVbIFiX5PODeR3blBDQP4v6FEIn8p6HRcdlb3404afLXWo05xGowvOMKPRz0LpCdPJc8k2wArDvuC+T3x2hEcPt75mCpyxb0g0E5MWrHRqOJBuWwcXrYrjaVQdFd1s7JZq4U5ygBR6mDBJ/CTsum3CdZsjB0ph6yW2f4N+wLZZurfP3v3h676lzfdi7vhr3OaNS/uMbY55R1vAzDZHkBJckKENgMmDkRwtNVISaViOh2QM9kmZe+iIcfYcmj4HtfzrqsCQITBkYMawP8ufA9wYQbilehxLFzOx5cdcb97teiCcuCj3v4K3gSJtzzAZkgUSBAlNDaxxDdl4JK5TEgVZk2ufFgsbSdaSwL5qosnYFHmoK+LLHYAYtw4gUOU45rnpWyhowzS9gOkvEjFlr50HACXcC6eQbVXbzG8gzHl5E+bmlppt71Rt3OJXB2cP33cTMJFaAFiC93JUMKnDwvKcRgfOLH0dpO+wDYlnbw/UhE5H9euP4E6BuKuQOcCWQhQS8FcOO7jglLQman2zdjJF7ikd/tDjkPD2bCXRwoEsIDicGdmEPDsDqL5u5rYveod3kO4vu233t3d9a77F28ONeVroXLEPNbWJAFSyb2D4VrG3L5RIkE8IhymP7uRDFRh8WXH3EvLondYEiaJ5A1XfElsVVFBaqaT6c4N82SGg07ZhDKz1HymN2o1r731JmgOsSDez/4eJflIk3FD5mRjUUyxGuSgvc3KYaEip6Xr5UFvrgLfFdIafgh5YMRZkd5XViMS21emh9ccTpLDDn8uhZMQf3hSbmEog+bZrQKK04uF6roOM87ZI/5eInwq0UQrIOssUqdkKGqtcKt8aFA7y3nFKyrrFqpySrbaA9ioUwQwgXpRT0j3QEZt5IQIJTVsLKVqr0KQQzWLLpgjYEialCsn9gwg52bm+Hgbe+MtuB/7nXH8DEXQWQaZLzpfCn2iLAi92AOZvdM4fg0d4W8fF1/iLKLFbwqTw3D2OjVUUEwc31vikZeGyFl0UtKmtd5bVn/q1FTAV2tdkr//Zan5HaBPZO9tq8Xgr5NIkBl27liA/ITgRhzxoFA9QuiIfkC7AhjDxdr/CqFNQ4CEtavY/v6UVQ1J+CVcBu+I2YULys5y+w2PZPdoW+9dXy5HnYx9v+8ZgvDEhEucnrk0eCMfdId0+p2QNY3HZ4tfX98myPRrXW6MrrV5R694XAwLDtcQBVvUUz45XCDSRXmx/zmjgIH5MexjLxXwTnJVsnbPChGFr1Ms5MB7HbTqh+JE4PXmsdG68g8NCaNOjC/0ToS9UPbmlhUyZcg2UXAQyqPW4ON52Gxr9wrCYQ6gKCL/dLzBkj62xXSN7N/DorOp+LxqNn1wQ3ZMm0g2yZyocZgKF/gE7I33RvWajMX9C2m57wQLoI3e7ta3wM8k4AHgTN1yneWlMyc9c47t5djMq//c9sbjdfVNuGBEQur/mQqaObfE8aKANRAWLlpGaqyPQV1DwjiXpht6IRZh0zZJeihRi/pkQWdREeJSTKlMrIfnaqo7oNrFmKYjQc5JjyEDr60YHu4K7mIjEvFyT1VKP66yjqW5SCRsDhRnXWoww5uWbIOVNb+R3EgyNtDxw38eMcsbIamrFxXbXWZnRR0E5QZeWyHFlxRl2RC65oIAnQqlbQoFNX8YJ0ejVNMTubtOBW8mtplhuAjQJ2ZAG1OFOr8JtWdgtvu6XaOBzyiasqMl9NDbK4kMmU7H/2cFWY2GEisUHU8040trCrylgWKEqs+FZ4IVtKc71MlSzQgL/CZyZBMRgGWY6Az45u0MlnMigNtHcrM4cMHXMRcB1hxBYYd1gxepv88EaGbkpzo2tL0TjBxooCDz/dRLA1Z5L/gThBSjLxUBf/iE4Uc6GOgr5EGNboG5hpUUekTTh/1yp5soBCQLF9mZ7hAaY69X9LdevCgZHIH2BhG6JdX9nO/0vk3lUq128cnDfhk1+rt40n72OIt3qwd8jpJy6fC+rkxfb9qKZWioyZk46gcOUAs9MKaef74crrAqHaLUiOUC9n2uXUkKYTS8hH4+e5mcNnvFnLjmedbpr4zAxULRmp2vW43eMtomyctozWxmwZvTCyj3WocHtds0ZxYYvuMd2ag9cUhb7DMHr1jbH0juZ01GyPfkk9V2hsjQ/iKy7WsIemquXx8jsZJtl2lNlFauKMXEmFHFM2CcZhFYADgY4iBjLamHqEkYxoyPVM/SkVqJTWzThpwnE04F/agVEusu99eFc7y/mUvRT0R/UclX3x26OTSy4QKeQYy7uJu0pKOnUKUkEQ/mIJA5x1Wzlw9Siov2UqTDQFhtzu4vR7fdQfDYU/G6fD5+rx/gQF8sYhFPVDexZ0MFjuX8heEg59ubkDJdMTf7VzddPoX2Y93AGzcG+KT3nDcP880vrwdqV8G19cQnQ6Gd6PuT72rTmW/QM8FBKnD6851t3d3MRzc3sCjzOaX/phBPXmUOGaVy/55r/tr97J3Nxp3xtjopjMavRsME0ORlO0Mb+lPxobgl9thF5+OOxfy/3dASe9iMPyVvo5+gbFG2hu8GQzH6XcE9LY/SBIjeho63XH/raQB8PhFklbmPeL8qTPTWnhxikmSwSpmz7egk6V8muwaB2Y/4CAPsYmuWDUT8IMB0bXr25jJrNL0z8o2BQ/b7bo4sZpNWMnazUnTnBwd2UfNkycUdWcH8XghzLxasp+GWeUtGsbeZzFfpMZE7haS+doZmJ2B2RmYnYF5eQPzUGhSTHhhiU/ixwtL7wo9en6kk1xfgQzX3VSMh6erNcQnnCLZOeXfxClfKxFpIk5JxQa5ocZJTt5oqJounZwfw7I2FUGa1lvJnmw+CWJnDxfoHEMYT+ZOhLout/MiOQjmM/R2KHr2WFeFe3+F3ph5wAsOAswZyYDbiZJ8uCzySi9ySKyNHONVyCxhOiHaIViahJPd8cUFCizOspiW3ro8rSwwlsUlSWpM4VHI/jh58nDHVOFE9PlxoHdR4UFvPEIWyrPQgcxcSJIeKahIKM/zZNNy+8IbPLIgajvWrZ7lLbCtk3CkM0yOQxM71qTiH99eaBi1I6PWHtdPTrFCr1Ztt45/K8XOypX+ZbhJXLbS5KaaV1Uk+s2zVXpfMJdNKzvg89fkldJeJl2eUULLSn78YYMsVdRK2KrVV4X91tOXKAG5Bhtmbg9BNdc7gPmblmSqeR91X7ZjP78bg234COYEb3v6vMCd3Occsl/nf2OicxX5TpJfVdcc6MmS7bOCighSpldSIFO2p4R3inHlIWFVc3W0cx8ExgJjt8on6asv/ZhxYFkQex7doxLuM8sXofcqUuefpVUm/17eimXI0oKX45Tcruv61hbr6zksnMY04FRVJHPJJnRU4o8UUJWHBJnL1OeX4FatVq2zN9xK7gPrKmJQLANufgRY/S08i1tZ5aq74F6c3kgqGVa0BZ8c1U4aLfuoxXnjuFVvH05ObA5O6MnhCR0ZU/LxuE93gXl5x5Q7DaQMWFeCkgIIaHHassp0t1+22y/7j94vo2Wbx+EWenfjgvkxiLTkh09CKV+uSCdd5bVFUnkS6pws2YoXWvHlVRI73d3p7k53t9Td4o9DddOS2tVSWJG2KD8pjOdzjucyKG0lf6eyPwYN0qvsEpWjqSp6KwiMJT5WJe85VCaN+qRut03RAmfZOmqe2A3zqMEP2/V2fdJqtCvZtf452+lUSiQC3JuOqWg48n0rJ63I3kDYaNZU6bb0m4HnVdxY175j46QkpvR9doVlAcpDCnM+pJfyCG0atJ1jW11iig04m4Jd9Ao13gAFiwkY3fOHyotUANxgaXRsrOxVtwcmd+yoUZJKBbQEmHWmYyTcwav4bPT5AAJ5sFOwzi/onWZKjp7tybMhUnyJFLPeZ1MIVPTEcz8suwmsj6kPtBEjOcEk1uuiHe6BAEBAIG1W4nfu/POdf75b43dr/L/HGr/zz3e6u9Pdf6buPsE/V97Qev8cGmztn0Pbao0lvtQ5FT18azedVEVhQOKdlL6mPjj5FSBKiNCUrkFf8GgGXw7y120mp7LwEJdKmkNjGQVI/OLAhX76ZNgXmDaYrocqXzhVfebF8+/paNgEeFVihtLNNWxA1+/KAarE6MBBWZaGj4BLtquKkkpy+mwjZL3ts8RNLwlmHzeAlVzRY6QQgopXodpDfaA7qQv0AV23gfvw9bRIQGtoKWPfxtGgPQNMCyQiCR9wumD+ARDN122Id86Q1cJbHuDZh2ybEXrpEsOVlunKg5FdYwWhATZrsDeCB3SUETc7fvz53fh1WtOt7mHWO6TsBsSIbF9HJ/6xEy1H6eX5ndzWCuoas11gClN3oWcLOoZgxYnt2EmQ4Sicnnzkxmae67fm5vPfPYOdOYG80Fme8VEkUkzI3i80XTxD13OR+EFDM5R2EjS8LTqHhWTte7kbiHeFEFvoDRvArWcPLuEZGXgYccEThFrEATmh8MhviJl61p6NRw6egfDyePzuvZNXHOS6MWnnWDij6//7zJz5fij+m9E7VFBV3k9j0LRno0XFxwZphNGoZVAy5JCGY4AbSfhdgmJ4UpjkWWDyYnw8JmlJtf2DZhbswh+0C/xHjmZ6/B5WW2xp+eYTriEv4IwDGjigIe1EqPBXJ9kAWdzXBhpkaQIJQDedf7IECtGMbZSwSi0/gT+gPrh8mICqPN+2OJVfTlMjqD4x+gFbJ23AVKMXnmwR4ntbFKyH5LIbxSydPyhycBVf14eFtMA3iW+Sv8LF9XujFynupGkWvMvnpa30Gkvy/djdv8ni7SzNv6OlUX4xihsNqwKIrJC/UT7datovpGod+D/8SrpKLjjHwyn6tTRZQAuXRyjVpNXmzBGUMFgITtdk7mfKsvQRMPWaqyndABYwuqlj4rh4ohxT2npkTgojnU+cV/wexvKYTHKMu8reYX21CdOC8RsWZcBvf/oqkBvBzNzQu8jO9GTjGyLmsYfX0gLa8RxPXD8mEZYTmrE0XBDOeULzQl6HkvTSWoyihiRQDa4I5uHAxlw0hLmZiX9kLJj3UCWiubxwVr1YJCVkKNTBbGiXd+0fgw3SZuC9FhhBgtUFB0xkRrjqj1cg4s0zIdAFkbofTA9Up/AA22JVLRAvxadZrVdrBoUUWCjphxHEvBngmfdzrHmrHKOK/5XLZZOU/N/wkjm1CmH4cLDAHBmdKpchj4w231fWRZs0iTrehOhk5uN5hveVL18wrYIB2AM+lq+PwagGJgk1J30P0VpG7F5S9xIvqVszvR8FplAy7w5UeZIKvfJn+0n6Z73VbgMr9Ev7nsmH/6zX0W0SKf26vmcycvduuX/eu+U2iIN+geAzpWH3grjv/AVxGyc/fSPgM6f/P/nFcBs5m75/L+XshzRvTblicMbIJpLbJbvJza1Mr5XyD4SSbDhc9MD9ffh/qjzzrA== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Query Parameters

+ +List of Completed Approvals. + +
Schema
  • Array [
    • requester object
    + +Access item requester's identity. + +
    requestedFor object[]
    + +**Possible values:** `>= 1`, `<= 10` + +
    + +Identities access was requested for. + +
  • Array [
  • ]
    • reviewedBy object
    + +Identity who reviewed the access item request. + +
    owner object
    + +Access item owner's identity. + +
    requestedObject object
    + +The requested access item. + +
    requesterComment object
    + +The requester's comment. + +
    author object
    + +Author of the comment + +
    reviewerComment objectnullable
    author object
    previousReviewersComments object[]
    + +The history of the previous reviewers comments. + +
  • Array [
    • author object
    + +Author of the comment + +
  • ]
    • forwardHistory object[]
    + +The history of approval forward action. + +
  • Array [
  • ]
    • 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. + +
    violationContexts object[]
  • Array [
    • policy object
    + +SOD policy. + +
    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[]
  • Array [
  • ]
    • rightCriteria object
    criteriaList object[]
  • Array [
  • ]
  • ]
    • violatedPolicies object[]
    + +A list of the Policies that were violated. + +
  • Array [
  • ]
    • preApprovalTriggerResult objectnullable
    + +If the access request submitted event trigger is configured and this access request was intercepted by it, then this is the result of the trigger's decision to either approve or deny the request. + +
    clientMetadata object
    + +Arbitrary key-value pairs provided during the request. + +
  • ]
+ +Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + +
Schema
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-connections.api.mdx b/docs/api/beta/list-connections.api.mdx new file mode 100644 index 000000000..b89b2cb83 --- /dev/null +++ b/docs/api/beta/list-connections.api.mdx @@ -0,0 +1,87 @@ +--- +id: list-connections +sidebar_label: List connections for Governance Group +hide_title: true +hide_table_of_contents: true +api: eJztXOtz2zYS/1cw7IcmGlEvv2LP3Nw4tpO649Q+Py5343paiIQkNCTAEqRlncf/++0uwJcetuNmek1OX2KJAhb73t+CQO49nYiUZ1Kr49Db8yJpsgOtlAjwkfHaXsbHxtu79t7rW5EqrgLB3qc6T4x30/ZCYYJUJjgWJl9OpGH7Z8csFVmeKsOQGtMjFlQUGTdGB5JnImRTmU0YZ/OUO7BqwlMei0ykuPa9p+ALLDDV6acxDgFe257ENROeTbx5Ro4PcdVsIpbSTsXvuUwFiJuluWh7JpiImHt79142S3AZk6VSjWGkuONxEuGjQbDbf9N7w3fe9Dd6uz3e68Onzf6gv9vfFUHAvYeH9r3l6PdcpDOY7HjWo5ER2QKLp/SYSZVpYnSURxHozeRRxuCHDrsyOY+iGTOJCORIFupqRTKWWYvBtISPpQJFwnwQbTwhOpaE6fysLoRg1//cIINcZFyFPA3ZgY4iawl2Vqr45tUkyxKz1+2G4lZE6BEdw2WUaGCvE+i4K0PV5YnsGkfHD0o6fmWq12ykUxbrVIBc8DEmv2qqfMQjI2qa7S3RP6wqxiKFeZaIfbQxgAexVDLOY5oXihEHWeHzSuWTshZ0/5MmpfGM+M0Kr0X1xfwO6bNbHuWCfiYSDIZs9b4apW79Aa06DVgipYq3Vus40Lla1PHxiLUwvFoMtDeV4NyJTvLIuqtgrX/5lzrjkX+As1votglkB8Emgocitb6OA1UeD+E7hLPzbGu4qc6jkA2FSzUQHXJUxgaok7Vs3LXYVKDmxgoUGIIBwYQSswEqT5gM4hwyUIasMBKEBVyxCb8V8BhMRqrC8TJOeJC1mfWFVIABY6FCWFjpDKPRCFy1RUT+RpK3kCfi1noTaQFHA9u5Kbj5KhxqRaIcah0Jrryao9DMlb5idEo5/bGkW3onqpj7RiDrUC68h3kfuwBqpVvkBm2JLlOIz8xMZfyO2UlD9BH1J+v6OxQY+PIdl6/J5PYZ+pHJkwRVErpMhCknivQUf4acH4VmD3wKlddmQSpQDW0wXUgFodVqlCga5Rc/Lprz4QYf2TAzqPhBr4d/mjo9wZINhecFNRtmZAJSAdDkSRLJgByr+5tBwveLFudpytE3ZCZiU3uuh7/BwggCUlR8Ji277vECxw6uAG92BAbjPHuIYx4lbn9dQRp949TRxnHtRaCgMGNee/sHB0cXF7+cnZ++Oz45gh/OT+nPxenhL2enJ8cH/6YvV+cHRwifKuMtTMxkRj+U0lkGLnFhCAQZLgudVSioUsx0IoOJLXmpGEFqRBWRtYRZBni2tt8EW4PdYLvXh08B3x7t9oL+Rn8DmbBB/RQbP+SQQSEAeMiHESR0mIR8zZutsfoR/NUzIfyQZ3zIjaD5/jQFX1nIA08xcFh9KxQyv3insXotJcB4cGm0BWR7LD6aISdd4oRICccqK1jtIBZcZT9kvoqsy6e8Dgd0HvO3IBDGnNtadi5upZhShT+dKvr7gSs+JtY/FtB5zu+WEqgLUE6s2DrMNAx5wFGby3LIAXgTVNKjNIWk5rPzWom2EJVWY0MdzjAJSgX1UYYvSSErojkUGSTrAx0+wz3fSSX8ccolciiI5QAmMqB4K0NMxFQqLcnCf2hc02lAE50+e8tD5rSJTkbCoDJTHnwCWsfPCNsrJWE+K6YwWRWHJcuKHcGH273dweZoe5PzwZvN/s7WcHfEN6BP2drdxdVjMDG4gVmSe5tLvxfgNjJgkQ7AIv8BhYCzg+6JAVr8+emaaDxD/5cglx1biun4ZZm4A8TF2duDM7a5wyKuxjk95+M5JSj/6gJRBjRRmGQsYAHJLeHTVI7l0kRRxNHh0bv9q5NLTNhH/7g6uoBPSGuhw91X4K0huqUmTDrRU+LYCTDlUNJFRPHeYS1HtQUCcWXqA6X9ZmYGlMkceIIZbvUlM+qk2SjVcSOUKG7uMvZKdkSnDQATngGIglSPGQmynLKoG8M9yfwTp8mWg9uvO2w/DCUKCTiY0KqB+TNEqjwMLXKyXSqEsiAQoPMMwawMRNMWlSqb1qgyykndKBgcwPnTfrIfZNAQk080orD0Fseisw/wbDXX5O6ypjRSKUJESGoB9dqBTlMslEOQTUK2d+mIkBokHlWMKzNWPVFSuvtgmbEZEvIZz80z4u4sgvTjk2jlD7fCBR8VHZuNyBqFmVxGcvsHNNmNKs1VBL7FkuvYXcfuOnafGbvzP567zqnAPgh9+ovQ50rxHPSbUvFcgD4peY/SrBhE8MYZss1AIQ4i/fjxEgL7k1A4Xtwl2MZ9QXxkS/kC8/ulPVzLXHTURemvbIEMkh6tBCPIRCLcI74rji1IJFVtLK72TqdDCQ6qlkBEyJopm+mccVBZmitF+zSmzUItjPo+czs0BF5tBsRVVejbBn2NJNdIcl2N1tXom6lGayS5jt117H6dsfsokiy5omhxOMnkcczTmfU09ztKyxkMqF6VlSFHpppHK0iMlRjLayIHbzjoD/ujnUBshnwz3N7YHQ2C7QHf2unv9Iebgx2vXuuvqzgug6wZUzV7WzuSigHE3QKOyxU4l8m0Dpvbfzm+vBlhWsPUU+Jm0Dmo9KbEjoPdRex4qTX7wNWsQEimgSFVpSPMaTA2xrFpMRYGcDaGvKjwFZ8EvtCVZCyACr5qsu98MXhRCqCbzvz9UQaiuLeTzsnKVaQKohw4pEwQaUTNGhxL4qu+EWI+oEAIdgzZ+QuiU2eiP4Tk2TlKfEJvuY/uAiEw0EvkvrVsf/cYmE8xR1xYA6/Y6LXdDlfgANAQ2JxV4s41Pl/j83WNX9f4b6PGr/H5OnbXsft1xu5n4HOHhlbjcxjwbHwOYzs9VmKpd3R+6s+G6RQqjgNyb6aDIE9pu7nA4KAEI+ChzGa0yBXg+gPryvsA2jEyZaj2ysO5e3hCwrvB80axABdEQcZ0BJYO6+553XKo6d7XzvQ+dIPG0WPbP1jJ8jSCmcWprHswOBj6ocMT2YE8iEc0ZkpP6WjWELS8JIHhSQMbrDiADoHZBTpkolRiFNiUScStwdyxNq88/fUo5eJwy0znkCSJTBvPDDmPpMfAYgLtyPeGRnfIAxfkA7mu0ujhj8tiCa2QZZn6Hl0NxjPgdE5EFOGmcpILxO529QVXqeoR9nuDhcVOcdiAvRU8hcbCvgJ59ePHy9dsjIiVMoY96SckthgQc2fgIpQR94vXATiJilR1LHq/8cIFI5CNIhCYuROYx04JP0GpOIfcTirFSYLSCc56/plA3pi34rzlz8pnhzItjtjhGCeiPZN6nRRy8ZpcL2Xiu4Kab6n5RA3PIza4sKq9DuwBngDSAJLgkSFtvXhxS8+v0cM+DJ4g1XkeUBOOj+ZrsqCw2ov5aNDzkV6Tj5/VRzof15zGbBZjZkKHjo9ZMNHaiL8zhq6DYXA9ziGKXswWHcrzKSL8Qa/Gkm+X9KUP4JL4O4HAUNaZ+BCLO2EbDbBPhTYkfyXLQsz/Suegf23ITI+voQbjyFAHn3HQdY5nXNDHBX2bA4zj35Y4dCyIbZSB8oB1gIPK/pQJHKO1vGdpLc3qRL5Lc7A0BMAqUTHJnv2yVyU494nRDzi6HANpGLF5+eIQT7o6WljnGsoqdhXmNbjIb6ShvM7pzfJb7mphyf2ryYsS71ebL6cqmn3pLL0ik/x18u7/KOOtM823mGkcWkZ3o2VdW1F38rcOry1uBho6Twz/wq8UqwTMoe2pLsPUCSURz9CrKaqDiRS0jZAIPIUciTZ6lo4pEqHjx/CHZpEIjekeQQosc2j8ZAT0aKO7WJlTwFhgiXbF7yYvT5AHE2hLRYd9hM5OBWAW7OrwqAb89pt27d0FWOYMDcsOC2MD6IrjXMFqGJd5zDi41BMeEUoT5DZxuc7AiqAJ+pWziihGV0MR6MS0SGNzOsIdamh+a4Z/Yi2wu3Hb09zeNnBXVypBzkXEixalCdufog3e5k9ElGBfCVkXAJiorfDh+HKBIhBTBuSC/l2n466bZLo4Fohge2TdZ6PT7/R8ahfgeaJNBp1wjTjd66jf6cDkuOSaxNzJ+nKb/kte7nTFBbuCboIbYshybrsU2yJeV1c9Uct7zYuf9S4R+o4JCItT7u9xGwXbpgd8bK8eYe8I6seYqO41rRTy/+tW5lI7fBK4sVHeWnV7F56HTerzFfmNXLF8REPF1dIXKmh9P/Lrux/5iDcUl2Bf6A3rm4yPare6Nlrp96ba6PrMJP/q3F2MfM0e/48ClnJUvN5Rszo7Baf1QvVwA8NtvBKHdoTd3K/NXXj93dg4fX+EoICvaMvch71r3Kr9LwuKH80= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 connections for Governance Group' (list-connections)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

List connections for Governance Group

+ + + + + +This API returns list of connections associated with a Governance Group. + +## Request + +

Path Parameters

Query Parameters

+ +List all connections associated with a Governance Group. + +
Schema
  • Array [
    • object object
    + +Connected object to Governance Group + +
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-entitlement-children.api.mdx b/docs/api/beta/list-entitlement-children.api.mdx new file mode 100644 index 000000000..1a6442957 --- /dev/null +++ b/docs/api/beta/list-entitlement-children.api.mdx @@ -0,0 +1,107 @@ +--- +id: list-entitlement-children +sidebar_label: List of entitlements children +hide_title: true +hide_table_of_contents: true +api: eJztXHtz2za2/yoY7s400YiyntZjpruj2k7GHSf2teT2dp3MBiJBCS1FsgRpR9fj737POQBfkmzLiWfbdPVHU5kEDg7OC79zCODOCiMR80SGwalrjSxfquQkSGTii6UIkqOF9N1YBFbdSvhcWaNrq/RWWR/rliuUE8sIKUD/6UIqNr44ZbFI0jhQjDMkyUKPcd9nDtJjokSC3rC5vBFB+XkDRlTCSWOZrGDUO+tKifgoDBLxORmnyQI5kW4wKnUZxYK71sd74CniMV+KRMSK+krk7PdUxCugGsAbmuhSJtY6++/4Zxaky5mIka9YqNQHFpPQTKfxIZgIwa5/6tAcJwkPXB677Cj0feEgDXaRD/3x1SJJIjU6OHDFjfBRzg3FpR+FEubnhMsDmMABj+SBMnRsJ6djF1N4zbwwZsswFkwG8HNJ2kIBxeL3VMYC9OZxX4m6JT7zZeTD9Nq9JsjPWYglt0Z3VrKKcM4wrpiLGHpqMvpRpw0PljKQy3RpjaDfkn/Wv4mKKzwOUqC/7u/r26UZep4Sm+I8p8fANkgwWQjmpWADWqoMXjTYlUrBLFZMRcKRnhQuu5XJgtVIOzUUfMTnMuCJgP5xmM4XRMco5ptRx1coIxf/w8J3wjTYlP2px2pJnIoakwlIFQQfhVHqa1EKVvtfexom3LePsHcNRRqFgRJsAV4E5k96wIZb3GHBgWKYgifPhPEM0Jz0cr2B/FhN20SN3QoU1TwAibmgMdCZDBzsB9NQiQzm4P8JssJoIszhAVvwGwGPQUckHGwvlxF3kjrOBkJMLEBj4PUuDByECVqKEjhqjYh8TzOvIU/E7Q33U6GlgK2B7VRl3HwTFoTz2WJEszD0BQ+skp1Qz8JWIg7BMjcV6VpbqKgkBjVY92UG9IBVkyqFfnaKlHL2rLYzbA2ag0G/63nDVq/XbPV7zWHf5Vw4rcOWYz1kvCqMKU4/zFbJQVDn3FYCZZkAl/frHE6AWm6nqULjQhvO9MHUKkggxOtOMzTa4D+s/L/hhIEv23D5mmxQP0PDVmkUoUhcMhIKmkAmvMXXECB9V43AyKVbZyjAOnNg1YPWdbAnlyJonaH46ownIL5ZmsBPsv46U2EaO6Ih3VqtojsiZGf9t5mhSlbUEhVBXSM/dI1VPqRYT/pPKHZDe2+oy59cf3pe6xp8kz3dTYcUITXyCmM1Qgqo1FoNlCt+hyAX1PQzFGbpKSjx1rxBWW62z7W++YqsYDutkmWs9zJhms/8rK95YQyPHs4hLvvw3xysDNrpBplBbWtRsb+cZyZ+Zx+spcAF59z7YD3bFD9iB72OKbS3drOJ/6ta2ZnBoxUU6higy7w4XIJ2ym9hGAeRJ/wCYjyKfOlQyD74VSHFu00L53HM0RdkIpaq9Dyc/QoWBS+iGLWfSM0nhOUtYW8dWYsyU0w+OwAbz3zuQNSrPNQZTwOYcDwFu2gjXWMKO5CWS1iFFyDmZG2QW66yUFYO+C48sBO5xkC72W7arabdHExbg1GnM+q1G8328F/ISx7GvpIZn4OVlGLiV7CU2/fzZV+4xoYWMjfBiAuwGh00C8gWufpuo2lkFHrrQqiMdfT++4rS6+dXlQfn8RwfKT9KbJ4moUY09eOj7/HtOH8yPsZnfuhwHwWjw86EnOecPGNK/O7Ct/YkWuu2cK/dmJYOGoMZDy1Pag75RIRsRLG8kT6AcXcHZLXBC0hcw8w191SsRHcNyaHP+GHqvg1vBGLnlx2XSLN5Rntz7AqlTWFXzWmb8EtP/iDTKS1LLyu8MuFNyeX+uDWoVwcZsyWPUDxeLISN8YP9Jla2driIy1htWulKwYJRHvfOIsDwPsNU8Psncm5kxnUljsX9i9JqYjjVFF9u6TEcnh5vW3XafYcPBj23D6sO/HJEe8CbzaaYIZvJzj5txtD4lZI17t/ylcJ87YM1Ob+6PDohVFAwoB8+b3Ezw2xE1PPjiT0+tidachthFXIqK7wNIGVHFOD7EHqxuPS4EUwgbfV1ZeN4ep7jQaKTxbCtHvRlWtJ0ZQE8H3LLNm97Lncc3hOdbs9rDWZef9hvOt5sNvCE036eRPWw2P7JgaVLb1as9ZhtiADLH9fW6fHJ++np9JdthUZRCf7EQoOdBuASVFIKA/iHWmREKtC8wlQ+DOqY+EZzQIqXwhMACx1xnISUw64ZxUcMpwBQneRCxEupFHCnngMEdzKXgraxGZhIgvUUzH8mkMVcYBbznWIATviMK9FgFKbhL5w0n89jMeeUkGDEcVLovQSN6XijsxGpikCFuSKTMAqAXQGpD9ZfsCxzw+MVIKN4LkC2M5HcCkBPAJFIRgksPBLB9EFGXzU2DDmW80WyTUBrsRN8nwp91Jy9Eo15g3HKxdRrXdJJsNIcFYLhmGEpUDt1TJDJhBII7p6DKWSL2boiCpMrYsrJ2cnRVNuCJrOTE+i2NHqJLV0nm4MMYR5mOlmxp8pZiYFfJo23P/3779PL8fvJ+Gh6ev6+YpmFOZBVYrQXc12Qf9ryiuT78XU+S5NOj6lGn41Qx3WTB6s6ltxuF9JZaE2cVJdRDuzNAX00ypK9trz+rDUb8I7d84Rrdz23a3O3PbQH7WarK1qdvmgNoUd76MwOneah3XL5wO52BLcHM9G1Z51Wu+e1uwOvzS10vSUPqIB8FSEsd99Qcv14fK7a4/Hp5OJs/Mu/34/fnbwckFA6FmIekWrOWMYpu5G8ijmWGJCYo24YeHvEE5CoCFxdl2DsDQ7LlsCMKbwa/lcGuS9gDF3SBFd0FjyYC8Y9LKN4gDCSajZh4gBWG7FkAcICvAPOS584rssqzMvBGjjvXj2BqMAPwA/s0sCv2T/YJ5TIp5z7xhZwdXwyObo8vSBzfzlMV8aqe4WUFFISzGN6KcWdd9u8DdapLQvjxpcgDXWwjsIlSK4shVwTmWp0jazBtEC0WCGmJEbD8PMFFLlGnGwq/17wtE7dnZTKCKwrWsjx+2d1qiiurCC4hDUTcW7+JQw4hE5BeGuQzG1YTXB1N4NnKAaPWDma0aJecqmKZtcDn1ZZxQG18j+W9V+yR1p1isB+92Aub9LsShWkXLuoZlRvsbHpOMk+/8LyNn43dujDjkmEyhlkCxpQv4kTUse3fjiDLLFuYv48RfRs3TVb/FD0mzMbcG7P7rZ6PZv3nEO7O2zz4cxxBs5h9z7vNaFOE7tl9+x2y+70Br3B4RB62a3D7qDZge5duz1sDlvDXrPThaedDhYKgy3cLRVkFhew7Doy4r6Zwvhqev5ujLIeH3/4UO1SlHDW8+fWS+TP686pAKyV46RVrYmYcLtWscjqset5psnI6pSzZAliv99rdp1uU2RlyZ4Dqug7g+J7wUngTkP4B1Iwk4GV8y1N7KmkpfSdK88ysiSjBPLLeOnaarmt9qEnmna3J9p2lwPYmIEp2LzZF8NOtyu89iHmHw9ijd1cqSoQR9dpO15Rpx26vaHjFnNYt6K8yvpwsbFc/sRWLbvZslvDaetw1OuMOr0GyPxfFjo1sNPdVhw/IgjPTuIYgo/NLksfd/WHd6qOsFnorjBqygDsVBLKe26J/AFA5sJyJf0jquk/hbrfyEDYAK0lciiIZQc6YvS+kS5+baGPrJpknmZju0owREk0WuwH7sJ89fyOzGQw+MXc+Q1one6Qgl8FEvqzrEslEd8cVvQFnx02h+2ud9jlvD3ogi3Mhh7vdJrD3nBI5WyhFJ+LpzOmtwI8RTqMPFz+n0AgwUH2xAANvvvnCKKxY+qv2+bTNPwy3KdTZ5z9cHTBun3IGYN5Ss/5fE0IgX012VbD1oTPIWWSW6uUWYng+OTN+OpsCk8uT/7n6mQCv5DWRsFgHIC1umiWIe1mWMDKmhQTQEShBH7vw6W3ZqjWcqCXN5T6L506M4NJoYcZfUuPMumi5Je5kqM3NbFXsiEadYAA+N2BsAom8m6W0NZgARQQ48+MJGtmo8brBhvndUANVwBMcEzPGXddXSLQe2/AlQXt6wjTBOGMdERVF4Uo18FchgDOykpB5wDOn7aTsZNA5CSbqHhhbi2GRaMf4FlLrsrdtCQ0Eil+C3ZgFgSonDDGKgwDKEGVCxOOqOYDgSfI2uURqwJskJt3mpkspXZ4qnbwuwsfwo9NU8tf3AjjfATjdTQibWRqMhHJ7IqizqZVrq7M8TXQ2/vu3nf3vruj766/vDSps3lL0Ke1CX2uAsDPizCmxXMD+sRkPUHIskYEb4wi65hgGoj0489TcOzfIFGE9uJzhLsXXhAf6aV8g/lxrg+zNybbOpMt/YUukEGSo56BB5FIuCPiu+CYBKVF1dkcDTLTmQQDDbZARIiaMVuFKeMgsjgNAtrhp+rMDYUKvkvM3j7wCKV0BMRRAffrvHyPJPdIcr8a7Vejv8xqtEeSe9/d++636buPIsmcK/IWg5NUulzyeKUtzbzXR5ygQfERJ3e5fKdeGa0gMZZjLKuKHKxZuzVreX1HdF3edQ87Q6/tHLZ5r9/qt2bddt8qr/XXhR/nTlb1qZK+tR71HhkR3wCOSwMwLpWEoVst/6X4QcrDsIahJ8fNIPOGLi8a7NjdxI7vwwTmBoQBO8YPlBevLs9K38E4yk3v2QnzTTP0mQYhJX2YEZ+l+pJ9unvouIeO++Vnv/z8OZefPXTc++7ed79N330WdOw+BR27z4COXYYQy0OI9UdCR1fqk7keKAXm4KRxrPcxRTAV+GWqj8btzebJDOhVUGR7uIkip2HI3vFglYElValEBoW4MLxB2yW2jbO20CC7cwCilgR0i1aF54EAk+IJaTrHjH6MEwK68coe03Yfczra2Fs+igwcPwUOKSj4IdZeQ7AxiVt6PIR/QIHqoHMI1C9Y4zTa+qp6MLvEGZ/hjNnJZ0cI9Pm8/tvbtkvgFJiPMVxMtK4f2C6ga+Y8gDRCfI50+Moh6B6q76H6frnfL/d/jeV+D9X3vrv33W/Td58B1Q0aehiqQ4OdoTq0bTRZjqXe0OGG/zRiJ1cxHJB5s9AhrO4WGJxwBZgSMqRPVdGtMiProHzm5eBOuvcHTnFjmE4ENF9p7EP77MzCHagL1HTf4JFsZHt1g/CWDi7ggYUt4Qd3m2pXwwZ044ceoEECjiXasA54RFyL25wYsfKzEY9SplM7oMcVJCFMk6HrVIw90WNgMYJk4jt9xqdB9rMxP5jXVezff/1cNKEH5rJNfI+OBu0ZcLo2RZzCx+K6NdrDr0ffuHStWE2w5t/eGOwcm7XZD4LHkBbobTCvfvx5+prNEW+Sv+trXYTEBAE85gJMhOLZONsSgp1oiSku/BpXNt2g/zDPhwkzc3/TqRHCewj0lxCZSaTYSVAwwF67n5jhlX4P3Nb0IbDZMR38xDOJ1MZMUd9odR1l8+KleX0pE3/LqNmamk3U8OqZChdatNf6HCbep0Fi4b4iaX3x4JqeXaJn04FGG6mu84CSMHxUt0o5mda+mI8KPRvpVfn4EPxMBxKr3ZiOXUwt6CjmKXMWYajEPxlD00E3uMYjIuKL2aJTkDZ5hN1ulliy9ZC2tAEaEn9n4BiBNiY+w6WZkEmoiyTkkp9Is+Dzn+gAz6fKnOnxNayg2NINnWfcarTGMw5o44C2jgHK8K8XKDQs8G2cA8UBbQBHhf4pEhhGS3FP09oa1Yn8AfXBpQGP6hAVFY30H6MiwJlfjF5g67wNhGFE1vnmMTxTZWjhKlURVlYTWJfgJr9+CIvjmtw0v/mXTVww/2zzxRmPi9IJniV+6Sj9QCT588TdPyji7SPNXzHSGKyL5kbDmqSgbOQ/GLy2WcpTdK8m/AtvyVcJVkPSUlylWSYU+TyhO2HQqwE0CyoCREKfCq0zc5YPPBHydXR/SPWI0JyOgcXAMoe0TfpAj8rU2cicHEYDS9Qr/q1Ss2kiNKdXG+xnPCXtgFowJ8PtuvDu19AkZ/mVEuw4UzaAruUyDfBMHbCdLhkHk3rCIlypnFQHLkjRApHJIiTol/fKvBhNDafQoOwkXqpzD+vLEo8XWjuOBXpXprgMokctmtN0xUQuhU+Wie2qsP0p2mBt9kL4dGkURF0AYKI0wrvT6QZFIBaYLxphPD8wndQBtsVDnjB5bT6dRqvRtCldwBupQpVAHlsi/uildevGeFcU11/0QmazqmA6cBBhHQt5TXV6ojPCa6tMCrqM6Jq6nFFIMxYwN2x4d4c1D8yS7vGxvj0SU0WQNrqAu/2cf3lu39ZtzVul95vAKkJ2GXV26JcO1O8uh/+ua5YfkWN+DfUXCnJ/Z/K3d2fyI+aQXYz9hdawv0x458uEH1FCccHzF6phfyvwf9GtwI8YUnGhdGFIH4ty6TOxw6tLc7Pw68rVVXSt+VYmsq96warMQcYcwBy6C06vBMSLfqE/5ZS6bGx2wEnk5fW3Jwgi+QNpvPkxusbC/P8DXHzBMQ== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

List of entitlements children

+ + + + + +This API returns a list of all child entitlements of a given entitlement. + +## Request + +

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[]
  • Array [
  • ]
    • 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.","example":true}}> `description` property.","example":true}}>
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-entitlement-parents.api.mdx b/docs/api/beta/list-entitlement-parents.api.mdx new file mode 100644 index 000000000..acdae2d07 --- /dev/null +++ b/docs/api/beta/list-entitlement-parents.api.mdx @@ -0,0 +1,107 @@ +--- +id: list-entitlement-parents +sidebar_label: List of entitlements parents +hide_title: true +hide_table_of_contents: true +api: eJztXHtz2za2/yoY7s400YiyntZjpruj2k7GHSf2teT2dp3MBiJBCS1FsgRpR9fj737POQBfkmzLiWfbdPVHU5kEDg7OC79zCODOCiMR80SGwalrjSxfquQkSGTii6UIkgsew7/KqlsJnytrdG2VXirrY91yhXJiGSEB6D5dSMXGF6csFkkaB4pxhhRZ6DHu+ywickyUaNArNpc3Iig/b8CQSjhpLJMVDHtnXSkRH4VBIj4n4zRZICvSDUalLqNYcBe6rT9e8oDPhfXxHrgFBvhSJCJWRFQiz7+nIl5BvwDekASWMrHWJ/aOf2ZBupyJGBmOhUp94D0JzUQbH4KJEOz6pw7NfpLwwOWxy45C3xcO0mAX+dAfXy2SJFKjgwNX3AgfFdBQXPpRKGHiTrg8gCkc8EgeKEPHdnI6djGF18wLY7YMY8FkAD+XpEaUXCx+T2UsQKEe95WoW+IzX0Y+TK/da4JgnYVYcmt0ZyWrCOcM44q5iKGnJqMfddrwYCkDuUyX1gj6Lfln/ZuouMLjIAX66/6+vl2aoecpsSnOc3oMbIMEk4VgXgrWoaXK4EWDXakUDGbFVCQc6UnhsluZLFiNtFNDwUd8LgOeCOgfh+l8QXSMYr4ZdXyFMnLxPyx8J0yDTdmfeqyWxKmoMZmAVNEtwyj1tSgFq/2vPQ0T7ttH2LuGIo3CQAm2APcC8yc9YMMt7rDgQDFMfZfNhPEM0Jz0cr2B/FhN20SN3QoU1TwAibmgMdCZDBzsB9NQiQzmEBgSZIXRRJjDA7bgNwIeg45IONheLiPuJHWcDQSfWIDGwO9dGDgIE7QUJXDUGhH5nmZeQ56I2xvup0JLAVsD26nKuPkmLAjns8WIZmHoCx5YJTuhnoWtRByiaG4qEiPnBhWVxKAG677MgB6walKlRYGdIqWcPavtDFuD5sDpdz1v2Op4zVa/1xz2Xc6Hbm/ouNZDxqvCmOL0w2yVHAR1zm0lUJaJQKJrHE6AWm6nqULjQhvO9MHUKkggxOtOMzTa4D+s/L/hhIEv23D5mmxQP0PDVmkUoUhcMhIKmkAmvMXXECB9V43AyKVbZyjAOnNgOYTWdbAnlyJonaH46ownIL5ZmsBPsv46U2EaO6Ih3VqtojsiZGf9t5mhSlbUEhVBXSM/dI1VPqRYT/pPKHZDe2+oy59cf3pe6xp8kz3dTYcUITUkC2M1Qgqo1FoNlCt+hyAX1PQzFGbpKSjx1rxBWW62z7W++YqsYDutkmWs9zJhms/8rK95YQyPHs4hLvvw3xysDNrpBplBbWtRsb+cZyZ+Zx+spcAF59z7YD3bFD9iB72OKbS3drOJ/6ta2ZlBqhV4qiGrYl4cLkE55ZcwioOIFH4BLR5FvnQoYh/8qpDg3aaB8zjm6AoyEUtVeh7OfgWDghdRjMpPpGYTovKWqLcOuUWZKSa3xt+Bjr+9XhF/hdM6bDnobNoxnzsQ9SoPdcbTACYcT8Es2kjXWMIOpOUSFuEFpADJ2iC3XGWRrBzvXXhgJ3KNgXaz3bRbTbs5mLYGo05n1Gs3mu3hv5CXPIp9JTM+ByMphcSvYCk37+fLvvCMDS1kXoIBF1A1+mcWjy3y9N1G08Ao9NaFUBnr6P33FaXXz68qD87jOT5SfpTYPE1CDWjqx0ff49tx/mR8jM/80OE+CkZHnQk5zzl5xpT43YVv7Um01G3hXrsxrRw0BjMeWp7UHNKJCNmIYnkjfcDi7g7AaoMXkLhGmWvuCSGloLsG5NBn/DB134Y3AqHzy45LpNk8o705doXSprCr5rRN+KUnf5DplFallxVemfCm5HJ/3BrUq4OM2ZJHKB4vFsLG+MF+EytbO1zEZaw2rXSlYMEoj3tnEV54n0Eq+P0TOTcy47oSx+L+RWk1MZxqii+39BgOT4+3rTrtvsMHg57bh1UHfjmiPeDNZlPMkM1kZ582Y2j4Srka92/5SmG69sGanF9dHp0QKCgY0A+ft7iZYTYi6vnxxB4f2xMtuY2wCimVFd4GkLEjCvB9CL1YW3rcCCaQtfq6sHE8Pc/hINHJYthWD/oyLWm6ssCdD7llm7c9lzsO74lOt+e1BjOvP+w3HW82G3jCaT9PonpYbP/kwNKlNyvWesw2RIDVj2vr9Pjk/fR0+su2CqSoBH9iocFOA3AJqiiFAfxDLTIiFWReYSofBnVMfKM5IMVL4QkAho44TkJKYdeM4iOGU8CnTnIh4qVUCrhTzwGCO5lLQdvYDEwkwXIKpj8TSGIuMIn5TjEAJ3zGlWgwCtPwF06az+exmHPKRzDiOCn0XoLGdLzRyYhURaDCVJFJGAXAroDMB8svWJW54fEKkFE8FyDbmUhuBaAngEgkowQWHokY+iCjrxobhhzL+SLZJqC12Am+T3U+as5eica8wTilYuq1rugkWIKOCsFwTLAUqJ06JshkQvkDd8/BFLLFbF0RhckVMeXk7ORoqm1Bk9nJCXRbGr3Eli6TzUGGMA8znazWU+WsxMAvk8bbn/799+nl+P1kfDQ9PX9fsczCHMgqMdqLua7UP215Re79+DqfZUmnx1S7z0ao47rJg1UdK263C+kstCZOqssoB/bmgD4aZcleW15/1poNeMfuecK1u57btbnbHtqDdrPVFa1OX7SG0KM9dGaHTvPQbrl8YHc7gtuDmejas06r3fPa3YHX5ha63pIHVD++ihCWu28ot348Plft8fh0cnE2/uXf78fvTl4OSCgdCzGPSDVnLOOU3UhexRxLDEjMUTcMvD3iCUhUBK4uSzD2BodlS2DG1F0N/yuD3Bcwhq5ogis6Cx7MBeMeVlE8QBhJNZswcQCLjVixAGEB3gHnpS8c12UV5tVgDZx3L55AVOAH4Ad2aeDX7B/sE0rkU859Ywu4Oj6ZHF2eXpC5vxymK2PVvUJKCikJ5jG9lOLOu23eBuvUloVx40OQhjpYR+ESJFeWQq6JTDW6RNZgWiBarBBTEqNh+PkCilwjTjaVfy54WqfuTkplBNYVLeT4YbQ6VRRXVg9cwpqJODf/EAYcQqcgvDVI5jasJri6m8EzFINHrBzNaFEvuVRFs+uBT6us4oBa+R/L+i/ZI606RWC/ezCXN2l2pQpSrl1UM6q32Nh0nGSfhWF5G78bO/RdxyRC5QyyBQ2o38QJqeNbP5xBllg3MX+eInq27potfij6zZkNOLdnd1u9ns17zqHdHbb5cOY4A+ewe5/3mlCnid2ye3a7ZXd6g97gcAi97NZhd9DsQPeu3R42h61hr9npwtNOBwuFwRbulgoyiwtYdh0Zcd9MYXw1PX83RlmPjz98qHYpSjjr+XPrJfLndedUANbKcdKq1kRMuF2rWGTl2PU802RkdcpZsgSx3+81u063KbKyZM8BVfSdQfG54CRwpyH8AymYycDK+ZYm9lTSUvrMlWcZWZJRAvllvHRttdxW+9ATTbvbE227ywFszMAUbN7si2Gn2xVe+xDzjwexxm6uVBXIw9/J8jmsW1FeZX242Fguf2Krlt1s2a3htHU46nVGnV4DZP4vC50a2Oluq40fEYRnJ3EMwcdml6Vvu/q7O1VH2Cx0Vxg1ZQB2KgnlPbdE/gAgc2G5kv4RlfSfQt1vZCBsgNYSORTEsgMdMXrfSBc/ttA3Vk0yT7OxXSUYoiQaLfYDd2G+en5HZjIY/GLu/Aa0TndIwa8CCf1Z1qWSiG8OK/qCzw6bw3bXO+xy3h50wRZmQ493Os1hbzikcrZQis/F0xnTWwGeIh1GHi7/TyCQ4CB7YoAG3/1zBNHYMfXXbfNpGn4Z7t+pM85+OLpg3T7kjME8ped8viaEwL6abKtha8LnkDLJrVXKrERwfPJmfHU2hSeXJ/9zdTKBX0hro2AwDsBaXTTLkDYzLGBlTYoJIKJQAj/34dJbM1RrOdDLG0r9l06dmcGk0MOMvqVHmXRR8stcydGbndgr2RCNOkAA/O5AWAUTeTdLaGuwAAqI8WdGkjWzT+N1g43zOqCGKwAmOKbnjLuuLhHorTfgyoK2dYRpgnBGOqKqi0KU62AuQwBnZaWgcwDnT9vJ2EkgcpJNVLwwtxbDotEP8KwlV+VuWhIaiRQ/BTswCwJUThhjFYYBlKDKhQlHVPOBwBNk7fKIVQE2yM07zUyWUjs8VTv43YUP4cemqeUvboRxPoLxOhqRNjI1mYhkNkVRZ9MqV1fm+Bro7X1377t7393Rd9dfXprU2bwl6NPahD5XAeDnRRjT4rkBfWKyniBkWSOCN0aRdUwwDUT68ecpOPZvkChCe/E5ws0LL4iP9FK+wfw414fZGpPtnMmW/kIXyCDJUc/Ag0gk3BHxXXBMgtKi6myOBpnpTIKBBlsgIkTNmK3ClHEQWZwGAW3wU3XmhkIF3yVmax94hFI6AuKogPt1Xr5HknskuV+N9qvRX2Y12iPJve/ufffb9N1HkWTOFXmLwUkqXS55vNKWZt7ro0/QoPiIk7tcvlOvjFaQGMsxllVFDtas3Zq1vL4jui7vuoedodd2Dtu812/1W7Nuu2+V1/rrwo9zJ6v6VEnfWo96j4yIbwDHpQEYl0rC0K2W/1L8IOVhWMPQk+NmkHlDlxcNduxuYsf3YQJzA8KAHeMHyotXl2el72Ac5ab37IT5phn6TIOQkj7MiM9Sfck+3T103EPH/fKzX37+nMvPHjrufXfvu9+m7z4LOnafgo7dZ0DHLkOI5SHE+iOhoyv1wVwPlAJzcNI41vuYIpgK/DLVR+P2ZvNkBvQqKLI93ESR0zBk73iwysCSqlQig0JcGN6g7RLbxllbaJDdRQBRSwK6RavC80CASfGANB1jRj/GCQHdeGWPabuPORxt7C0fRQaOnwKHFBT8EGuvIdiYxC09HsI/oEB10DkE6hescRptfVU9mF3ijM9wxuzksyME+nxe/+1t2yVwCszHGC4mWtcPbBfQNXMeQBohPkc6fOUQdA/V91B9v9zvl/u/xnK/h+p739377rfpu8+A6gYNPQzVocHOUB3aNposx1Jv6HDDfxqxk6sYDsi8WegQVncLDE64AkwJGdKnquhSmZF1UD7zcnAn3fuDKL9JTOcBmq009qF5dmThDrQFWrpv8Eg2sq26QXhL5xbwvMKW6IObTbWnYQO670MP0CD5xhJNWMc7Iq6lbQ6MWPnRiEcp06EdUOMKchCmydBlKsac6DGwGEEu8Z0+4tMg89mYH8zrKvbvv34umtADc9kmvkdHg/YMOF2bIk7hY3ELG23h16Nv3MVWLCZY8m9vDHaOzdrsBwFGEJtdMK9+/Hn6ms0RbpK760tdhMT8ABzmAkyEwtk42xGCnWiFKa77Glf23KD7MM+HCTNze9OpEcJ7iPOXEJhJpNhJUCzAXrsfmOGVfg/c1fQhsNkxnfvEI4nUxkxR32d1HWXz4qV5fSkTf8uo2ZqaTdTw4pkKF1q01/oYJl6nQWLhviJpffHgmp5domfTeUYbqa7zgJIwfFR3SjmZ1r6Yjwo9G+lV+fgQ/EznEavdmA5dTC3oJOYpcxZhqMQ/GUPTQTe4xhMi4ovZokOQNnmE3W6WWLL1kLa0ARkSf2fgGIE2Jj7DlZmASahrJOSSn0iz4POf6PzOp8qc6fE1LKDY0g2dZ9xptMYzDmjjgLaOAcrwr9cnNCzwbZwDxQFtAEeF/ikSGEZLcU/T2hrVifwB9cGlAU/qEBUVjfQfoyLAmV+MXmDrvA2EYQTW+d4xPFJlaOEiVRFWVhJYl+Amv34Ia+Oa3DS/+YdNXC//bPPFGY+LygkeJX7pKP1AJPnzxN0/KOLtI81fMdIYqIvmRsOanKBs5D8YvLZZyVN0qyb8C2/JVwlVQ85SXKRZJhT5PKErYdCrnYUUVAOIhD4UWmfmKB94IqTr6P6Q6RGhOZ0Ci4FlDlmb9IEeVamzkTk5jAaWqFf8W6Vmz0RoDq822M94SNoBtWBKhrt14d2vocnN8hsl2HGmbABdy2Ua4JE6YDtdMg4m9YRFuFI5qQ5ckKEFIpNFSNAv75V5MZoaTqFByUm8VOcelpclni60dhwL9K5MbRlEj1o0h+mKiVwKnywT21Vh+1O0wdrshfDpziiIugDARGmEd6fTDYpALDAfNMJ4fmA6qQNsi2c8YfLafDqNVqNpU7qAF1KFKoE0tkT8sSvr1m3xriitv+w9zWZVwXTgIMIyFvKa6vREJ4TXVpkUdBnRLXUZo5BlLGBq2O7uDisemCTd42N9dSRmiiBs9AB3+yn/8ty+rauatwrvN4E1hOwm6uzILx2n310O/113LD8ix/wO6i8U5P7C5G/vwuRHzCG7FfsLrWF/k/DONwk/ooTiducvVMP+SuD/oiuBHzGk4jbpwpA+FtXSZ2KHV5fmWuHXlYur6E7zrUxk3/SCVZmDjDlAOXQTnF4JiBf9Qn/IKXXZ2OqAk8iL629PEEPyB7J482N0jWX5/wfInspb +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

List of entitlements parents

+ + + + + +This API returns a list of all parent entitlements of a given entitlement. + +## Request + +

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[]
  • Array [
  • ]
    • 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.","example":true}}> `description` property.","example":true}}>
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-entitlements.api.mdx b/docs/api/beta/list-entitlements.api.mdx new file mode 100644 index 000000000..10cf387a5 --- /dev/null +++ b/docs/api/beta/list-entitlements.api.mdx @@ -0,0 +1,99 @@ +--- +id: list-entitlements +sidebar_label: Gets a list of entitlements. +hide_title: true +hide_table_of_contents: true +api: eJztPGlvGzmyf4XQLjCJoJZ12ZIMzFsothNo4cReH5Od5wQbqpstcaavNLvtaA3/960qsi+17MiOMTvJ6sNMZDZZLNZdxeO2EUYi5okMg6nT2G94UiVHQSITT/giSFSj1Uj4XDX2rxqV5o+thhJ2GstkCd9uG5dKxAdhkIgvySRNFthfOsG+KMbsx4I7AG612ecBn4vGxzsA6QhlxzJCbACXi4VUbHI6ZbFI0jhQjDNEj4UuKwFQ7Q/BhyDva/OAzQRLlXCYDFgYCOyfLARLbkLmhp4X3shgzm74Uu0zIeFLzOYiSbCxDBb6xjCjioQtXWmzZpPbdpgGiSWdZrPFwmLYteQ4IU7UbLrSS0Ssmk32IlmESs8b0ppgBbFg4ovtpUpei5eE+SRYMg4kw7ltngDaSfi7CGghNvc8wF0vrQ3Ei3jMfYHwieoSyfQ5FfESvgXwBf4ssIQ2ZS+Ezxv7t41kGeFXlcSAceOuTmvBzEg2PWyzqZutXDitnAFh4C2rROJKhbYktG+AlkToOawtYBMNrc0OeBCECTIlh1j0LdGrBX8oMUe4wrGA+rAEmmupv2GL+Q5flOFBsykDoKcjrDTIRwPxiVIv1EukmvjC/cjD5Qu3P3LHg/5gKMaD3b3ebHc2Gw16A7671x8PnRF0jsXnVMYClMHlnhJ3rfVkXo/pY0gOJI5ioWAg44HDkEbCj5Jli3HHkdgJuL9khj6srH4gIkwL181C2gsSK+CEnAckPkTZc40gkKDU6VoqOfNE1mdq0C74UbAIpeDVktlhcI2dwqBFHa65lyLbfAFERhlVCWIPqob6gj3AKsS4KNCI+CdVzAEAPwRfEYayimnu1rhecJZNEwaqAVwKmfQ8MeceLkwDBqUyuCYLnoAEu0hE+MyZI134Yw2KVVkBNm8sDStYPiAGLezr8wRa7ND3OQzDBYEgfbOEgMYJpdhpHEKLeLSQrBMB9RSW3afE9+hkZ9Ad9obOwBo6411rMByOrdlo3LXGfdsddMV41BuMW7w/HNljl1szLqDTeGBbo85AWLwr+h13b+zuDcabs2uNyVjHslkYeoIHDeSLy1MPmJbEqajx6f1CkBuB1SOlkC7AtggMvtAeSy3C1HNQlxIOmlKatqLWZHbXiTxy/wG6ImdnIXCEz0hYAA8jJ0YX0EmtNZQ/E5kABOAL61Oox6DTIo7DuMIlXPfG5A1dV4mksUqmE2qGKYzwuSl4Nz0xgw9tdqlSEugVOWt60pdJE2U24nMZgLLA+DhM54uM1og7iOq5EOzqlz4FAudol3jssAPw+cJGHNhp7j4/vlgkSaT2d3YccS08DILaiksvCgG9NmjmDsQpOzySO8rAsewcjlW44Zdk9vwQOCADrdnQoV0XxRItO2tEDWYVcxGXzQM09XvQ4MtA+qlP43I57NzdR3wiVo32b/kXFqT+DKXUzbkNFNWu/buhXW/3G6jn8y/6N0HJaQl/3UtNsm01aqKaokY0mUxARkGMozBKPS2YYBT/aV2ECfesAxzdLIzBAkJg4EBuPddwBJ3VDVmLmTDMwUjWzbWAbIHWsCa7EUi8eQA0dCiaPAclx3GwDEWxKQcmAypMh3bosBf8GhwBA64RsbC/9CNuJy1cDTjUWKBnEoEjtM9BnyrIAhGQn2nlTcSJsNVelqhg/AQG3xqb70KmtG3bxPprq3dvSBjGFJk/j/M/B2i5WEC+ALwk75yRUS3BmXxhetBMZzt/LK3/ggsGvCyD5UtiuW5DOVJpFCFJnDw0LNIvsO6eAwkYeCXIL5CALWZDhphguuGHjkk8kHwQ7SRAvlmawE8SNvBrYRrboi0pNyFZ5xDWNpuVwIKgWhmwdSKgkqVnwjefhkZe6IjMy98T6ulo6zGR/msa8idnpl7XKjtfZ62bMZSsk64ohLHaRwjI4WYTOC0+g4EJmroNiVlqBY7emC9Iy3r/XATqn0gk1sPKxaQ+qiI29NF8MFJIjXOwiR78NweRg366QyZQ9/cIbwLgQnXWimTmq2HiM/sAmQa6gRP3Q+PRQvoRB2jvolASe50O/lOVv+M1VROAhOEo/MT+PIo8rD5A/53fFA66rYs3j2OOiiAT4atSezj7DcQJqxMxsj6RGhXprDOA9bJDCStGRYuCTj173B11RqPhwHXH3d3dTne424E8nXNhd/e6NqqaVsvHTkSjylMd8zSABccXIBQ9hGvkYAPQ0scUSwSkEeVJbrjKjFrZ9DvQYCVyBYFep9exuh2rM7rojvb7/f3dXrvTG/8/4pLbsG9ExuMgCCWD+A0o5SL8eNoX0l/jQqYJaG4hO0DtzHMu0vPNZtMhian7laauzHXw7ucK01snl5WGk3iOTcqLEounSahDidbhwc/4dZK3TA6xzQtt7iFhtM05J+U5Ic24IHw3wVtrEnm9NdgzNw597TdoDmY0tLyoOaRFEaIRxfJaehAVOxuENDVcgOI6vltRT8VKcFdCKNQZL0ydN+G1wKD1eecl0Gyewa7PXYFUJ3ZVnNYRv9TyXxKdkk96XuKVAdcpl+vjWqNenWTCfB4hedxYCKxD+Ox3sbS0wkVcxqoupUsFDqM8722DooV3WUAFv38h5UZk8srWacmbGEw1xOdzPQbD6eE6r9Mb2nw02nWG4HXgly16I97pdMQM0Uw21mkzh45kKUviHm4+YKL0oXF+cnl2cESOv0BANz7OuZlpahb15PDcmhxa55pyNbMKyUyDwhWKAjwPTC9uLDwsBOeQL3q6QHN4cZIHgwQns2FrNehpXNJwZRF13qeWPd5zHW7bfFf0B7tudzRzh+Nhx3Zns5Er7N7jKKqnxf5fnTirxbHuQ7IhAqw9XDWmh0fvLqYXvzbW7HiJivHXgSSbBqASVBmjDRjqkQGpxOUVpPJpkMeEN4oDQjwTVP+2xWESNjDPWRGKj2hOIQa1k1MR+1Ip3Lt6TCC4kbgUsI3MwEISLGRg8nMOKcwppjA/KQbBCZ9xJdqMzDT8RWX/+TwWc9p5IotjpzDaB45pe6NTEakKQ4VZI5O4ZxVFAvIeLHxgPeSax0uIjOK5ANrORHIjIHoq9ghsT2K8vJPBV+2aIMdyvkjWEWjFdtJmnmC6O3sh2vM245SIqZe6lkJ7fVFBGI7pFe676R1MRDKhHIE7JyAKmTNbZUQhcoVNOTo+OrjQsqDBbKQEui/NXkJLF6jmQENYh1lOVmWpYlZC4Nfz9ptf/vXXi7PJu/PJwcX05F1FMgtxIKlEa6+r1JtIXpF5P+zns0xoeqjwn2yGFvpNHixbWOvSuyXEiaOqG812TyqV8auGO5x1ZyPet3Zd4VgD1xlY3OmNrVGv0x2Ibn8ourg30Rvbsz27s2d1HT6yBn3BrdFMDKxZv9vbdXuDkdvjDVQ9nwdUB7+MMCx3XlNm/bB9rsrj4fT89Hjy67/eTd4ePV8gobQtxDwi1ZixDFPaAa/EHD4aJGara9yMiHgCFBWBo4sSjL3GaZkPyJiKp8F/aSL3Bcyha4m4Eb7gwVww7mINxYUII6lmE8YOYJkP6xVArNJu31WZhXkdVgfOm5dOwCrwHdADqzTxS/Z/7BNS5FOOfW3HBJh5eHR+cDY9JXF/vpiuHKtuGVJiSIkwD/GlZHfertM28FNrHGNtQ0uHOmZbT1WokHMiY40ukLWZJogmK9iUxHAYfj4DI1eAk0zlhfqv89TZiKmMgnVzQAZ8WnWpSK6sGuiDz6xsHAOGtEl6YyKZm7Ca4OphJp4hG7zPytaMnHpJpSqcXTV8mmUVBdTM/1jmf0kewetQQDxYV0Q7oDiAHeHWKLPYWWlrRm9CUorFZqGzRNLLAKgsyVU8ts52j1V3QOald0C1v6+57tcyEBb4Z4kY0m4uSKkjUASupYP1Wtoi0SDzWL2264uUaHfZK+7AevX6DsxikIIxt38HWNMN4vjLQH7GsxhmSCWar08rhoLP9jrj3sDdG3DeGw26w93Z2OX9fme8Ox5TTUwoxefi62HXGwEhr7QZpdny3wKtEQfaEwI0+eY1TYKxYf6g++bLNPgyPCLXYpy9OjhlgyEEnsE8pXY+XyFCYF2eryuEacAnEHfJtaWOLM84PHo9uTy+gJazo39cHp3DL4RVyzomAUirg2IZ0l7kAtQzKRaAZkkJ3DFA/W0aqM3cW+Qdpf5Lx9/MODYYYWZfM6IMuqgbZKpk6/OE7IVsi3YL7AgWL8ngYTbgZFFxE8+9RIl1bCjZNNusL9tskhcTtM0Di8QxxsfzMzrP0OcQQJUF7cqGaYI2UdqiyouClKseITMjx2WmoHIA5l+Xk4mdpHhqCZdZ1sJcWgyKhj+As6ZcFbuLEtGIpLibZONxQrTKdhhjKsdmsDZMf4w5osQRDE+Q9cstVsU6IjZvNTJZXG7zVG2gd6cemB+LlpZ/uBZG+SgW0NZIlE4zZRbJnBChwaZXzq5M8bW32OruVne3uruh7q5+PDPxt/lKoU+3HvpcBnhAOYzJedZCn5ikJwhZ1onCG8NIOqNrQqS/v78wZ5uhv/gS4S7nM8ZH2pXXkJ/k/DC769nme+b6C14ggkRHvQIXLJFw9gnvAmMdJBKp+vXZILydSRDQYE2IiKdN2TJM6bxenAYBnc9RLeaEQgU/JeZkjj7FSRYQZw0cSwf320hyG0luvdHWG/0w3mgbSW51d6u736fuPhhJ5liRtpg4SaW+z+OlljTzHVfLGXQoKsG5yuXHfcrRCgJjeYzVqEYOjVmvO+u6Q1sMHD5w9vpjt2fv9fjusDvszga9YaPs668KPc6VrKpTJX5rPuqNdhFfQxyXBiBcKglDp1r+S+muEZo1umyUxc1AcyDpxzx27I3rseNFGLK3PFhmEZKqxJBBQSO0adDXx75x1hdvbpird2CqJOCFooTHwSyGR4wZnR9H5cVVANx4aU2o2mtOpRshy2cx10UUWQIvxKg5BMGSWNF1MeYDCBTBzsE6P2N0alj0TZE8O8MVH+OK2dEXWwhU9Dxy311X350C8jHaiHPN4HsKvTrb4XiJBxICbbPyuHMbn2/j862P3/r4H8PHb+Pzre5udff71N1HxOcmGro/PocOG8fn0LfdYXks9ZrOtvzRYTqpisGAxJuFNr1K4BQxOMUVIEqIkD5UF3F8t6Sxs3JLRsf7GpM09qBHdkjlFhgEjLlr80i2syOgQXhDJ1XwhMoag4MnA7RyYQe636UnaBNJY4lSq00cAdcENkeEGvlhmAch0zEt4NwyTMGoERi6SWckiJoBxQjSh5/0oa42SUxtfbCuy9i7+/a1aED3rGUd+R6cDfozwHRlibiE0qs0dAFDz157m6bwH5if9WqTnWC3HnsleAyJgN6yePH39xcv2RwjTNJwfYnPvB/D8TCrIgs2ycr3OIicSnFRfVLZIEGNYa4HC2bmpmz2DsU7MO1nYIuJpJPibRgYtfkRKV4Zd8+92A+BxQ7ppC8eQqU+Zon67vBVlK2Ll9b1VCT+kkGzNDSLoOFFwwoWmrRX+uAtXqAisnBPEbWePLmGZ5XgWXSC1UKoqzggJQwe1W0tO+Pak/GowLMQXhWPD8F7/V5HZRjT1ip7SmLK7EUYKvE3xlB0UA2u5ilo0ZPRomOvFmmE1euUULL0lJa0IBgk/I5BMQItTHyGzphikRDCtMDRKvmJOAs6/4lObH2qrJmar/BxJujphPYj7rCu4IwTWjihpW2AMvhrl4SCBbqNayA7oAXgoOA/WQKDaMnuaVhrrTqB36Ex6BpsQJWgqGhf/7FfGDjzi9EH7J33ATPcoIeazEYfHqIzsNAvVYiVVQFWKVjH1wvBHa7QTeObV6HQRf7Z1osrnhTFEjw8/txW+h5L8uexu/8li7e1ND+ipTHRLYobTWvSgLKQvzLxWr14p+gFE/g/fCVdpUAa0pTi0ZIyoMjjCV0CRK22F1JQ2h8JfQy4xczlR9BEyNBR/SG5I0BzuhYdA8ocEjXp4etbWJjOZuakMDqwRL7i3yo112NDc1y5zd7jsXgb2IJZGB6tgG+/hSYdy+8QscOM2RB0+X4a4FUtQDv1GQeR+opEOFLZqTZckJQFIqNFSKFfPirTYhQ1XEKb8pHYVycuVpQl3ltsbDgX8D27oA+kRy6axyeKhZwJjyQT+1XD9q/BBmmzFsKjW8JgdSEAE6UZ3k4vahABWGCeUgjj+Y4ZpHawL17MhsVr8em3u+2ORekCXkEOVQKZawn4G5Hc+4rjqizeFtX07UuQ9ZcgjW/EpGYnwvobUjzVSZbOZK8alUwWciNAIsH221sszWBqd4fN+oETzG9BRFBvnfW3Uaoc+YHfi1xL29/FsrHyuqYpgTToqsjmtNs+/PhnfPjxAabf+9bnHyMA39W7jg+Qsf5I5hPp9+O+t/gA9da/WflECv5vPcX4AFXzpyqfSMjv613FBwiRPRv5dJO2fRHxO3sR8QFpyJ69fKI0bN8ufNrbhQ/FIPnjkk/kyfYRwu0jhF+Jz/KXLQsR+1js5EGGiK9TaItN6aIepjf2S6NqR98QSr7Z+uYICwz8nhKv+YFT3d39BwNgj/I= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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[]
  • Array [
  • ]
    • 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.","example":true}}> `description` property.","example":true}}>
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-from-addresses.api.mdx b/docs/api/beta/list-from-addresses.api.mdx new file mode 100644 index 000000000..99adaa3fc --- /dev/null +++ b/docs/api/beta/list-from-addresses.api.mdx @@ -0,0 +1,71 @@ +--- +id: list-from-addresses +sidebar_label: List From Addresses +hide_title: true +hide_table_of_contents: true +api: eJztW21v3DYS/iuE+qHNYrW21058NnC4bhw7cOEkPr9cDnAMlCtxd5lqSUWUYruG//s9M6S0r3ZcN+g17RZIs5LI4cwz7yRzG9lcFbLU1hym0W6UaVceFHbcS9NCOadc1I5KOXTR7kX01pZ6oBMe7KLLdpQqlxQ6p2dMPVFlodVnJaQgKsIOhFMmVYVQY6kzIWuSQppUlCOlC/FZFQ1J4UpZVn7JXBZyrEpV0MK3kSb6nypV3OCbwRfmdKzLaJ6JN/JamGrcx6pYH+tVWelEafGzrArT+WBOlRIX/9kUveNDcVqCFVmkYs9mmUqYi+Nm6csfRmWZu921tRRiZQRUx0GS3GpTdhI7XtOpWZO5XnOBTpw0dOKJCM/EwBZibAsltMHPMYvbAe+F+lTpQgH4gcycakfqWo7zDOJ1n6+3I5eMAF20exuVNznJjHXVUBWY6cn4V5tdvBhro8fVONrFvLG89r+ZSqoGEijw091dezmadjBwahHOd/wabANBaEwMqiwLqEK5ZUecu0pm2Y1wuUqgSZWKK12ORIu10yLgcznURpYK8wtbDUdMJyjmm1HH71BGA//94Ce2MovYHw5Eqywq1RK6BKoAPrd5lXkolWj9Nz6zpcziPZrdIkhz+KUSIyXJ6VgPNHCJO4wkKNoqS0VfBc+A5vSg0Rt5aMvbREtcKYJqaIBYCo1BZ9okNA9iuFKbITy+JFYECyISacRIciCAjhgcGq/HuUzKNkmjHWZDY2OKD6kwtiRLoWghWi0m8k+WvEU8MbefZVYpjwKNBtuIFIGbb8KCSJ4lRtS3NlPSRFN2wjPvtZWBzjgsLqHlEH/NMLqbN6QDntJov3KkMrKMWkrhbkyJwOmn9ckUzB8M6XdeLnAWBz6fkW4P6rdkMq7Kc1uUYI/g53AEUvaKPiP0ZKnPLD6h2cLtEoVWi7NPq7UrWupTWwxVW2T4465a0ZR6Ip+j1CfxIfpoR6aTWvUj2M+luSExPkTRfRpxxNODGpmKEGT0MnaKJIcki8o6BbU/uapI4HlFnfp3j1MTVFFrZVEH0d0l+ZEPZo7A7K6v01+zOB2FEmOf9XbKpQOIJRZRGcEU42WeZ6G0WPvoaNLtooZkUUjSpS7V2E29t/2PEJwqkYKAKrVnRadL/c0zvkTvE9l8KfRjeEFw08Tp+ifIsIyKoVxyER3vv311+PY13pye7+3tn57i10Hv8Gj/VXSJgBGVuuS1GBNP7lVpozv6rx1trW8swnhuZFWObKF/hb5icTKVC6A5CnAOAVfUg3yh5jNMW0C9fpz46f0ZIvgvytB4dZ1TDOw8QR33wK6KwhaLzPfEGAWlHKraHWpv8eOn4ScGkUN06iUYACCV7jLfE449UgzV5uJqB7bo6zSFjAs4UTIqxI2thARkRWUMZ0XXFggjznxfhnyYJOBXcC1Fq5o09s739ZBKVQnR9myqlhnSfF4wKh4WUpMgDBkSeKoEKH7WKUnAKc6TJF9roO3MYLu1vt7ZEC9lCli4JED88cKQTRYy+QW0Dpd4zjxD50ZjvqinCD0JIUuWVdtK9l+s73S3Bi+2pOz+Y2tj+3l/ZyA3N9d3nu/s0OrBPtwSj59d+rUycMVEZDaBlZAzFEo6shQwUJvTI4ME03gE/meQy49txKztuVTXqJSkeLl3LLa2RSbNsOL3cjgHgonPKQwYFOayXxcakNwTflfooTYPxZRX+we986MzvDnZ//f5/il+Ea2F7q4H1zYpmaXlWnJkr5jjIMCVROBXlCzg+KIVqLYgkDRueqD2T+7GAUwRih7MCKsvmTFNWgzQm4YOwpsa+811KX7QHdVpozDEO6TaZCT6EhWigAq5Wu7B9/IyPgpItkIQe9YRaHU1CYn6latMh/k3VGGiYfX51Xc+8HjFVbWtSipCdaJmdTGBclYbk8B8NK0Ucg5w/mU76SUlmiy2iRkvbKwlsBj0A549crPcnU2BxpBSIYHcnnD/ltgCFTkKa8imUXmEcMT5HIHH1OO04SjaiWbyDXHzxjPjEw7imazcI/zuOEP4iVm05sNnFZyPQ6WPRqyNWk0hIoWelCeHUY26asf3FcfKd1e+u/LdR/ru/MeTUIvz14Yr9pZQJ7kKTQ1aIra08J2klQIDJhsTjcuxquarFSImmhormq0con53o78x2E7UViq30hebO4Nu8qIrn29vbG/0t7rb0XSuv5j4ceNksz41pW+vR4YYRRwKclFRpe5Ka9MZayV4CzWgsEahp6mbgTkgvWxqx+7OYu14Zq14g1ayrpDcTA1pJhhRTMPYMY0t6rEYIMUQcdHQhooGX2RKeqxAhdpIwbs25LwkBe3D3sS9AfX8YS8oGFmzijZJVoFDjgSZparZwrA0bawMqOYDBa5gh4jOX7E6DSr6XZW8OCGJj0hisX+dKEWO3lTuz5f1iodgvqAYceoVzGZ9X7cjDQwADYGPWU3duarPV/X5KsevcvxfI8ev6vOV765899v03d9Qn4dq6P76HAMeXZ9jbGddNLXUAZ9W/dFlOrtK4IDNW9gkqQrebq5rcK4rYErE0JAPtXNZjvCw5rfbVRqTqcdy6o6DL/09U1WRYXB9WHILXUFHdx2Z6w5CGNRV3hh7xScmfQC0JPZAs8EXaQCfzfgFOoxuocmAfbRj4h7rcP4XNYcyD1Km0ydS4o2tEN+YTFvA2IMx8etwgPW949EdNp4F+SDXeZHd/X5ZPKF7ZFkG34OrYbwAp3MikgiXpC4oHYRYX+fgZ8+Hql5Fir64nB5zSqW553Bh5CTdUDvXXbz/QMO64qWSBfoGf8Lxw0/vz56JIRWkHBD8IZ3S1EHApY5hRhzwevVuP03iHDS5/9CbOU8hBxODDKCIcJx9GIB6i0xwgtDNsNMkxdGCZj3+OE/OzLvn8PqDicUrXfjTPsdjgoj+gP8ir+WSU3I9lYnvamqxpxYzNTpKnOHCQ3uRZJriZQIvJxIyc4zWkxf39OIpetRm4Q1RneeBkAh8zJ6CJbXWnszHDL2Y6M3y8cG8H2lk29lpwgc34UZ8g+NQJCNrnfqXEGQ65CoXwwqe9mS2rmjRmD0i7q5PsRT7JWMdo3Zk/o7gGMYbk+xT7ubSxaKqM6l3259Zs4gLP/Ph/M8zMvPrC6RYGpna5DecUc/xTAvGtGDs44QL/PsMRoZFp/CQgeOAN4C9if45EgRGp2Kjp7U08jP5NZ7DJ/9glam4fNc/7E6CYPgl+AONbsYgVFPp3ZwL4lkEWpTGZsCqNw3mEVzkN7PInnO4eX6bTSvKqH82eUni3mRv5Z3Jbr52lL4nkvx54u7/KeKtIs1fMdKEYpjMjZcNXcO0kb8MNd3iXp/ja4b4P76yr3Ldja5mcrNwmlCeyZKsmr06GfFF4ELlSpZUH7bJsuyYPRENfeLvATOhYYExcFuHulX2dQZ6vI9dryzZYXzxSXqlZ1dxq0JrJSN0naoj3qNxMwnUQk0b3cTAt482dG+n0MwxKVa8qpWNoms8rgxWI7+sxkLCpL5gEal2SeUDF3o4o2osLJd+zazai8nUSIQOty/F2L0b0AY0etspxX9hLei9vtYE6EmL4dbZRJATlYUr2e250v5LtGFt8UhlObWNiLoowNTUCm8OzxYogphxkAvtuS2Ga2GSW6Ox/jqT8+az2dnorMfcUuB9bl2JRneKOF/foovmYvqm+YwJ3k723L/q3fKQS6gJWMtpe4s4rHzj4hvFi+i+RhFtxQiy0JDbW9oEoc7pjl77S4HUjgBdMvnJHdB7pfq2Lqsvxe0XRdsK9V38sHHg70o+Hoe/1y3zB3BsbuE/EcjVlfFv78r4A+ZQ/7uAJ1rD6t73vfe+HwB9csH+ibD//W5wP4Dm5HL8BM3Lyb4h79Uhp3L84ezpp/kThalZC2fuRKXZ5X29j/Lj7n8Kol91 +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

List From Addresses

+ + + + + +Retrieve a list of sender email addresses and their verification statuses + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-historical-identities.api.mdx b/docs/api/beta/list-historical-identities.api.mdx new file mode 100644 index 000000000..7dc21abf0 --- /dev/null +++ b/docs/api/beta/list-historical-identities.api.mdx @@ -0,0 +1,83 @@ +--- +id: list-historical-identities +sidebar_label: Lists all the identities +hide_title: true +hide_table_of_contents: true +api: eJztW21z2zYS/isY3oc0GVOWZcuuPXNz4zhJ607S5GL7MlPXM4VISEJCATyAjKN6/N/v2QVJUS92VDe9a3qayYtELhb7+mAXAm4imysnC23NaRodRZn2xff4a51OZHaaKlPoQisfbUWp8onTOZGC8HysvRipwotirAQNE3YodDNADK3jV0kJbhPlOoKHMKUyqcitNoVILUiNLYQv89y6QiS2NMXfC1cq4dS/SwXqXDo5oeFKFLaQmQhEC/Nd2zJLhVEflRMDGlyUzqhU4IERehhk4XHMT0AWn6tEDzWItOH39Yxv8b92YCrLYgxT/MoGEj6BsWjaRzo1R9Xc03jM9poeOSXTRzCUV0np8CI6uryJLrxyJ9YU6lNxDGZ4Ft05OLq6vdqKCjnyRFYZfyqCP6YR3rHoqlDOM3NNnoDIeLkVGbzBV19IV/j4WhfjuH7lk7GayOjoJiqmeSBy2oyi25VebexTepiG/NjiKbySLhnz46F2vtgSmYTJJFyaap9ncipIEjITmbRWFFKoT3KSZzT9cSox92r5tY9TlUHHdJXgA2szJc2y5KcmRcQW8Bl8fa3EtYSnCyusyaYh6FJ7bUTFuh04UAQB2GkLSOF3j3wyKfRH9YXFC0xJGm2qzzMh15Yu0xNdLCXrK/lJmHIyQGrALQjsMqPEtVWWdH42Z0qJy3/tiuM3p+KsgDOlS8WJzTKVcOi/aQLv6ptxUeT+aHs7RWplBB8dL3XG+dxJ7GQb8b0tc73tKz5x0vCJZwH8mENoYh30NPg44RwjRV3IPsDRUGZetTTv9bsrjI551Ug5jAxswqPdHh5MtNGTchIdYdxEfgqfmUuqhhJW4G+3d1nTDodeLZvzNT+G2LAgxfiwzLLKqkiPoiMufCkzOHYGMJw6T9g7T8jwuRzBzQUQbexsORpX8MOO+Wrc8Tuc0Zgfxr+iOXxujcc6A069bpf+m7f5yzVWGMyRENSagsbLPM8o5zB++70nJjfL4krnJDlcF2riW8/t4D1MhBe5I5PyEoi3Ol0G0cXoaKOeOH02B3yDZP9wd9g9UAeD/b1+f/dwv7ef9PqH/b2k/22/v8fAEVD0Rw7BdSb7LbA7ET/hG6FvxOi9/ixMvt4cxJ0WhfWZ8xLyWd6N6BUAL+NuK7AIJRen0m0UlmbmJix2M/zFarAMt1G1cjzD8FU6GWCAHNT0K91E6X49VmZOQawEXswWvJmyyIKDuLsbd3fOd3aPul386XS73Z8ioFWEkUxU1wiUHacIYby8pfd7q1LoJNOgFs+dg5IxipyqQqqKo7r4GdiUDaLNR5np9CFZdUf2pKoAMp3YdI2oeKGNikdOaq7hWOQEAwU4ftQpRgSsCizrqGG6ubWSLNHZEU9lykUd6XdSKUNmdDL5AF6na6T1hdEYL+ohcGADQCumVQdKDva7h7294f6elL1v93YO+oPDodzd7R72Dw9p9onyXo6UXwFH81N/p4xCPS4yi5pc/wqDoFqE7VkAnnx9BGMea9ifqu1A26hZySuolt0SUjw9eSP2DpC7ZlTyczlaMIKJL86WcoPAgRm/dnqkzSpRlKFl4jJ69vzF8cXLczx5+/yfF8/P8Il4XS0Ke4xUDqltucIZ2+vQlgQFKMW8ojVPpR3xpOL6BApJ49uEOnzzUw9jigpKMKKafcWINmsxdHYyl0pJKPzFN7qjOltoS/AMayLK54Gk2toGLHhynCQqL+KXlSWfiDG6AeUed8RxmmpSEl0PshFMMX5K/Y1M01nfMiyRyoqLDFsWBGA6UfO+mJlyEalqLHnZdgolByT/fJwcJwVqHY6JuSxsoqUSsYbetLLcvHTnLaOxSaemIEBOuIxKrHOwsBhAN43CtYIjbuEAPKamaxCrDZEMd6+CMM8Ky+8SWfo18u5NBviJWbXmxUdVJR/XzwGN2Bu1mypEqkpDHlxRNe6qEx9rqsrSTe5ucneTu2vm7uLLt1XjUL3l0mdnufS5MPVODpRYKn0cR4+xC9s9wZFb3JIH6/zw7hyJ/YE2lLxQn3Jqi75gfRSW8iXhjxt/hOcDKj8aZ835ggRkOwYNhkAilR6x3DOJQ5HIptpdnu2FdQONADUrSkSgphNTWwoJk7nSGJJE+i3exjOPCjGWwEeJjPA+ICDNatI4dKObSnJTSW5Wo81q9JdZjTaV5CZ3N7n7debuvZVkIxVnS1Un+XIykW4aIq16T9pKAQJRb2GLJuXYVYvVCjETTY0VzVcO0aC3M9gZHiRqL5V76f7u4bCX7Pdk/2DnYGew1zuI2mv95SyPmySbz6mWv4Mf2cQo4uhH0tIguHxhbTq//QfzOjUkWCPoaepm2BwmvWpqx97hcu14bq14Jc20rpD8XA1pZjYiTAPthGhdTQsCKUaafq8FVGnIRaGkJwpcHG2e8s8nlLykBfi6aXw8LKBKSJTZr7jVLNokWQkJGQkyS1WzRWBpKKmGVPOBA1ewI6DzF6xOKxf9rkpevCWNX5LG4vmnRClK9KZy76/a3z2F8I4w4iw4+I6N3tDtSIMAQEMQMKupOzf1+aY+36zxmzX+r7HGb+rzTe5ucvfrzN3fUJ9X1dDd9TkI1q7P+/Q7u2hqqRd8muC/XaZzqlQScHgLmySl4+3mugbnugKhRAKN+JRSLumAYbQ9bg5wxrp9gjMU/kGk0mUgrc8O3cBT8NBtR+a6Ux9NMPaaDxANYJ4VyENHBEKWEQEfVQoTdNi2TlP4Bqxj5sHS1emMqDmjdC/n+kjI1JZAN2azJRDqVSjxY4iYo4945Jm6w6GzpB/0unDZ7e/XJTC6Q5dV5rt3NtALSLqgIqlwNTtHekZFd5h96TTpbCGhRq23NNlrIuuJp0o6dATht4tvfnh3/liMqNTkVC89VblKU2+AZHmDEGEoO6738WkQry6zo2rHc7+UUOqIYQaFRXV2rT6Y8iMw/i1AmU1KgxTjAI1a/+SanBt3x0m1n00snmkXDraFw2GVitziicu81ku29HqoEH+rucWBW8zc/OMFKYJpL5Nw8iZB/hILmXm21oMnD/ziFj9qoPCEuC7KQJao5Jj/fSupvfZgOeb4xcRvXo6fzbuxxjo6P0wE2BJ+zEe2T0UyttarfwhBoUNpcDkqkUUPFuuaJo05I+JetyVSHKaMdYyqkOV7icQwIZjkgFZlLkos6jWThpT8hT2LnP+Fzzj/MqczP77E4kmUqU1+w3HMBZlpwpgmjAMG+Er+sDZRYCG3SQfGgRAAJzP/MxJUgrZwL/BaierMfpvH0NJAR9uZi8+PwpejGcBVn8IBeKJuaADDVFQ3v/jhu6h40QI1Z6x6O2DRgsvyZhbr4oLdgrzNdhStlX82fUnj49muyWuTTb80St+BJH8e3P0fId4Gaf6KSFOVuRRuPO3CqVcK8qdVvba8i0fbzGOFf/GWc5UravQr4TA+VTFtRnkmC4pqzupkrBX3/7mSBdV+WxRZdsKZiFad0p/uHBGjkQMN0tajJpUDnYEf71DXM0tOmFBYkl/puy+5CaG5kjH6SdUR79CSmQRuoXaMzljg3Xtb9WVn8MwbvjD1rHY2iq7JpDR0hBhilxMhEVKfiYhU+6QMwIXuzKjaFpZLv2ZUncUUaqRChxsTN/Gvh7S1jK615fjPzAW/+2pfGaYnL1Z3K2aKvFUZRybRzZftn+ONaIvHKsv5wDnEQnvXmuHV6fkSRzAzHnqh8bZutF0N8ttECybUHoXw2e3sdLoxtwt4nltfoIVtMacT157hv3Wae8VFuZvZlvrmztzdd+aq9ZEam+2cNuPI6mVotEJbexmtbmvRKI3hHSK4uaENG+rzbulxuMxDzS7ihZJ4doXlfhf9URfgVir5QU2j1bf2qv2JiK/Kra/Cl7gJd4+kc/fz/jARP3sb7n4Jmxt6DxTw67owd48t6vuAD7TD/9dNt3vs2NwEnBnyarYzBJC5AmnYD2bECaPCjnFr1NJvqsSl2cX77jktWPKOlqH6QFPd3v4HuDmuiQ== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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' + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-identities.api.mdx b/docs/api/beta/list-identities.api.mdx new file mode 100644 index 000000000..0686928ea --- /dev/null +++ b/docs/api/beta/list-identities.api.mdx @@ -0,0 +1,91 @@ +--- +id: list-identities +sidebar_label: List Identities +hide_title: true +hide_table_of_contents: true +api: eJztXG1z2zYS/isY9kNbjShLsmLHnrm5KraSU+vYOVuur2dnrhAJSWgpgCHIODqP//vtLkCK1JtVt9NrWn1JLLws9h3PgiAfPB2LhKdSq37oHXuRNGk/FCqVqRTGq3spHxvv+NYrNb6ve6EwQSJjnAaTBhNpWPddnyUizRJlGGdIh+kRk8W0BhCLecKnIhUJknzwJE7+kIlkBn0KeuDnSEbUX/dMMBFT7h0/eOksxi6TJlKNvce6l4gPmUwEMDzikRGL/LwmGsCNyaLUsMzANJZOBDMpVyFPQmZmKuWfmJ02FCGTit1+v09CXOWDTnQUiQBpsncF4++/mqRpbI739kLxUUSovYbhMoq1VGkj0NM9Gao9Hsu9fDE/KOj4cwV8YQUFznzH59d36k69zlsZqNRkcayTFNgb6YQEGAEpfY/dIymiEDStQmYtqBNzjBRqNRnWasesJj7UQayabUPtFq3m3rXySHKz3DySiUlXz4j4uh6wlYyWm4NIZyGoNM3yhVxHnOhAGDQN9opqZ6CTRETQHC5NSkGV82bwE/GJT+MIHUSGTHxgd95BcNQ8PBq2D5u8fXDAD5ot/Ovw8GgUDJvN5sGdx0Cf8zVwFjkS+NZqrzRoho1eWffARlOeQgs4wZT7RqCxgfoWDnsF5P/g7ooaWHTWK9u2nauCvcgL64y8rs4qnlGxIw3zS/1r7RKKEQd2bNRstI5Q2RTz2MnF5WXvrDvonf7n4vzsB+g5vzjv2ZxGtGDS4pinDdgNMRbDUOJvHjEb3CzV7i/DiHFWKLSB+ltYBwmYklv+LU0yQRGe51WtolkppYKeecp4IkqTiDCKxEINI5ROkSxQmVUo8ShaImRgGzCj2VqWKzYira0zS6AzlXqLSuqPWA1FqjGZsnsJHMQ6zpBrcpjav/yBTnnkn+DsGsZDrJURbCJ4CMq8l+mEBoIlh/Abdpc8ZIj9e51FIRsKJyNGCSwYyakEYih7TY9GRsCPewEqk2OlE6evK6kCnAdiGPJoDqYDVhgJwgKu2IR/BFswiB+KcxwvpzEP0jpKAxGQCIx7oUJYGLUOtjcCV60RETJmrYY8EbcfeQTGJS3gaGA7Mzk3QvzO0f01Re1Uo1qUzWMwAA2+5PeFB6A8KwJuqHUkuPJK8UQzH9f5ChloyVfeQrpbYWftjNv4XLTUftFcoSRYV4wpYRWbBjTtt6FhKpWcYqqCeVP+yf5NVAp9wq+12rQuvqTOC2oGtkGDlJwz8DurVfDStMGuTQYpYcZMLAIJCTu04ZaHD0yL+VgqG6uJzsY2FJ1hPhtz/ApjFOoH5b/HNWx2Mkip3Wzif1Wdn62EwIGG5SA5wnAex5EMiOu9nwzOeVjmjicJR/vKVExpLTDTxYjgsxuhhz+Bbipi31p3ADYBMIF+CbbDXBkus3k1M0DaHwslCK6wTElwKtY/RebRyBf5Akt7agl5tdr7nRfEBA8vYJuyCeIxd8zFVc+h9RfQ5zge9+EA6COmWiJ4gh3oaCH66FOUC0vjaD+VQHyR9fLy7WZ732+2/Ob+oN06bh0ct9uNzn7738jRVIcUMCscALAys93B/4M3YA78jga94kacwPak1WmqadtedJ58pKvzZjhu0X0IuK0CVwtgCOEDpQrnSjYCQElJgQ5dUMwqVr7nOLNxPwFnR9VSSQHQCmJti2UHQJZmIODBKbmmV66Fe7NIvnENmHYwiUJa5MN8d3sk+ctFyiomqnNWMTUngoh+7gFlvhw67V1eXlzC74vvvDoSfl9m2XYCV/lEB4630kw+50tDTGQGawgqMij+Szxcn1/23vSvBr3L3ik0V368652f9s/fwF833ctz+9dp/6r76oy6uyeD/vc9bOvRnwht4RfMfts/dz9yEc8uTr6DhoqErg2jiisOSflSjEriFc66gCvnorlpjRV2qbqypfiU4k4HFwxHlNL4wiq50vqnvfNBf/BDVZ6ilYz29Ho2565ZaR7xQaf1ssk7ByMOwFh0mq2D0bAjmq2XQbt50D7wSll383r/yGABH3MLaoqF0sQRnzHlkvNTjFxqwGcpg/+kwv3rEVOONG/t2DWgsLz+zUSAC2JGAACdr4ZgmucLIhscADKOKsVLFVsuoFJgAo8pwHcgC0w2lurlFLscM0iFYW8lXNk9R7RPxGG7HM4WwqicmZt+q+W324PWi+NO+3i/1YBtknYNngIvwywte+M6/+6CMuJ5+VPwMaexOa0+3HmZDO+84zvvhjIsu8EMe+fV77ziqIe6bQKmjlL1TV3lrEADnLOc53OXSOdZ3+595wTmaeRRp00DUL1XMxWccpxx3OocNvc7L182j/ZfNqGbcnmJrW/G2ICZupg9Z9yu+oiqjeRIBLMgEkXKXg+ZqkmBsvP5VpGD7qFKGKZY1Kb4KngB5PpRuKxGMPs6DnMUs3WELK0BJamBulEolpPFUy2epRqRcGDhPNUC1eh4rCLFudDL/L2f44KzilZzFLF58ztbYDgUKVjQletQckdZuCwVaRXL9ftyclgrO5Y1Odve4/tHAueLYAYzE8rdWYXTTyIJo1gvSUB9PrssnR7YEodOBdhQh5SapILSXYbPwfJr3M6q5USHW/jda6mEP064RA4FsRzARMQYH2WIEIMKIksyd04aV03doIlGi73iIchr5TtxwiBqTHjwM9Dqb7FlXVuIl0+BDFQkoxXLikPBhwfNo3ZndNDhvP2y0zp8MTwa8f395tGLoyMKEsBKkPrNiiKouvQbLFlkwCINzi7/K/B0i4PuiQFavFw3bbYB0dgy7u3YQkzHL0vFp7QOO9erk3escwibhxpn1M7HC0pQ/vXVKrRpCV8kcizVpjPM097r7vXZgMDZP697V4MCLC5sHAq8NUS31LSRTvS9TSRWANzHjIjoPL3Bao5qDQTiypQHSlPa4pjbe2GGW33FjDJpNkr0tBJKFDefUvaVbIhGHeIY6ySeBhM2hDolZNoi01o3CESc+mdOkzV3Evh1g3XnR610kIYAZYaHaAD97fG4PeWAUBa0c+osxXM2GYiqLeaqXExlReIrGwWDAzjfogYKUkhJ5BOVKCy8xbHo7AM8W81VuRuUlEYqxecAQZ7c6dA3gMwEssnUMJeO6DgeEo/KxxUZq1wRUrp7a5mhbI7FNc/MFnH3LoL045NoRcdH4YKPDulsNhLlE3GXkdz5E012owpz5YFvHxjsYncXu7vY3TJ2Fzsv3emk6yXo01qGPtcK4OJEJ7R5LkGfhLxHaZYPsodY1pB1BJsOIn17M4DA/hnQGIwXn2KElr8hPrJb+RLz3cIe7rlo/tg03/rntkAGSY9WghFkIhEeE99zji1IJFXtL6/2WidDCQ6qVkBEyJoJm+mMHsUlmVL0CMnU6RGc+jJ1D48CPAWyGRBXVaFvj7x3SHKHJHe70W43+tPsRjskuYvdXex+nrG7EUkWXFG0OJxksumUJzPraa6fju0ZDJjf4ilCjky1iFaQGCswlldFDt6w3Rq2RoeB6IS8Ex7sH43awUGbvzhsHbaGnfahV97rb+dxXARZNaZK9rZ2JBUDiPsIOC7D54Im1TqsHv9leENvhGkNU0+Bm0HnDXvuaLFj+2gZOw60Zm/xBpZDSKaCIdVcR5jTYOwUxyb5WBjA2RjyosLbRxL4QlfCpxI+wyf2jO5oYPCiFEA3mfndEZ7Fu4tTzsmKVdzJq6FMEGlEzRocS+ItpBFiPqBACHYM2fk3RKfORL8KybNLlPgMJWa9T4EQGOgFcn+x6ny3r+hxdMSurIHXHPTaaocrcAAoCGzOKnDnDp/v8Pluj9/t8X+OPX6Hz3exu4vdzzN2fwE+d2hoPT6HAVvjcxjbaLICS72m6ze/N0ynUHEckHszHQRZQsfNOQYnXAGuhAyN6fpDzNMJ/NiT5ffaLNq3fGRJBP35reQHMA+Y5bHBY9nIL9QofU9Xk4egkxXpBu8F2NDCAXQJ2i7QIIUmEn3WJjgibtWbv29S3H7eSDm/bjLTGaQ0IlPH22nOf6gZWIyhePjS0OgG+cuSfCDXdRI9/npZLKE1sqxS38bVYDwDThdE9OyNDiPAzniTA+11Dfyc2OzUzdC2t+/LY64QjVsOl0bOdxis4NpLDF3gsDZ7JXhC7+/gQ42vvr0ZfM1KF6TpKqeQdDuFs3fgRpTjuvkBP06ibWd+Ub5beYSCMcVGESiFuZvz+U2Vc0j+l5CtSe04SVCCwFnb35vnlXlr7snfKZ+dysReq7c3yJyI9gWY2ziXi5fkei4TX+TUfEvNJ2r4GlmFC6va28BeyQkgsJEEjwxp69mLW3p+iR5WVtCCVBd5QE04PqoPvoLcas/mo0LPR3pVPu7UzUTCBludxmw+Y2ZCbzj1WTDR2oi/M4aug6FyO84g0p7N1j0u6lNE+O1miSXfLulLH+Ai8XcGgaGsM/EhbteEVvA1NxXasP2RLAt54Ue6xfVjRWZqvoVdFUeGOvgFL4Ms8IwL+rigb/OEcfy7O2bALN7zBBkoD1gHOJnbnzKBY7SUGy2tlZmfyO/RHNw+AmDVXhqMj+2P43kSdH8x6sDRxRhI1Yi2i0eB+B6eo4U7V0VZ+TnBogaX+Y00bJgLerP8FudUuIn+0eRFibvz4xR8v+G3ztJrMskfJ+/+nzLeLtP8GTONw7/obrTswjVYdPJXDtMtH+8ZuuYO/0IvxSpBbShk5lfPy4TiiKfo1RTVwUQKOhiIBU8RH9bzi8gQie79Fyj/iNCYXuFKgGUOpZyMgB4dXecrcwoYCz7RrvjbZFSd4FrBBApN0WA3UKupAMyCdRpevoC+n7Qr2K7AMu/QsOw0NzbD958yhRfnge1syji41BMeEUoTZDZxQdmmRK4L+z5CMSuPYnQ1FKFBFUsyNRcjPHOGcrZk+CfWArsbd+AMqkcrujc754Jc4pvemDxgXBXaP0UbvM2fiCi21+QDAGCitMLb/mCJIhBTBuSCilwn4z03yezhWCCCJZR1n/1Gq9H0qaTA96a0SaG2LRGntyErXxapuN/D/Ih9+8+JuE0C0f1ejEdVuHRmKxJb9N16paIPSoQJ8IWtDw94hoFV0CM225dosbQATaH7rnnPv8zl7iMjf6WPjKx0tZ8FnqrMv1jjTk48ejVie0/aff1js4LnH195poL/Kl/n2KDDxQ+lPFOTu094fH6f8NjgFfl3Wp7pDZ/XRzo26CH/Bskz9fDX+rrGBj0WXx+ZK/L9/MyYzmkBg1EuILRlZ9kHSKVZS1cskEpxqP+mB9Dz8X8ygYhp +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

List Identities

+ + + + + +This API returns a list of identities. + +## Request + +

Query Parameters

+ +List of identities. + +
Schema
  • Array [
    • managerRef objectnullable
    + +Identity's manager. + +
    lifecycleState objectnullable
    + +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-identity-access-items.api.mdx b/docs/api/beta/list-identity-access-items.api.mdx new file mode 100644 index 000000000..e539ce45d --- /dev/null +++ b/docs/api/beta/list-identity-access-items.api.mdx @@ -0,0 +1,91 @@ +--- +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: eJztXFlz2zgS/iso7UOOsihZlq3IL1uO7WQ9lcPro/LguCoQCUlIKIADgLYVl//7djdAiZTkM6mdJMWXiQwCjb77a5CY64bOhOFOanWQNLYbqbTuIBHKSTfdiWNh7YETE9tYazg+so3ts0bxlP0HpmozbZyvNRJhYyMzpAI0TsbSsolwY50wI5yR4kJYxhnSZnrIONFlEgizoTbMjQWTBdWhTJ0wImGDKT0oT3bTTLAj8XcuDRLMYQcjvxPzzMYgCFJ/JhO1XZBrjj2T20bw5BkDMTJuOPAmDApz3ZDIcMbdGB4peAB/yQR+23gsJryxfd3ATWHUghxq1LhZaxjPAGjLmVwsC18ShkiJKz7JUqTxKl7vt8VW71WP865I+rzfHiT9ZHOj293sbAwHQD1w9HcuQLMzloiHO5laZoKUdY+2I3YwZEo7lhl9AYPJGsxjiRjyPHWWOY2rda5cRYxi7OYclWEzraywyFWn3cZ/lnlZYXkbAc1YKwec4CKeZamMyZatrxZXXi/Ly43hqBYigONaiY9DMmSYoQdfRYzsgnjE7NyJ/a9Do8HFxFHgm1T+oLUo8mNXZdkjV+wrGpuIR+91pMtCnd/czCxGivITWZB+2Uo7qjBO5qewwrKw2wVPc0Fa9nNOgjXKCkWrYALpxP31V+1Xvd7WhtjqJ/32Ov7qdUS/N2y3t4Zzp7ben8CtdW5i8cGP7nHHj2MpVCzwpxVuNoMSVKfX39AbneQSQ2tBhjI/rMk+afMt4dPWrnTyu1B2LLMgJC6VNkv5tNjVRGzHQFSwIz3iY8Xe76HLz62xSx6/vd5ZQ0/dqywGM9Mv0PpaI3jKbRrGZw9TbQi7hyvVyQtRJGdYk5iIo0QRCRQlP6To1Zq4X4deJVm2Wh1Z9hBVwOpH+xYvm6QUVCv5KAnHoFSR2m9hpjT1EUxxB3l6kDukMDI6z+x8h8Zpdgl2YhM9kCnWjJmHhpinBT8xSkra+PEYIf1i6lmhWGb0g9IITvuB7FHdFXm5WyzMjTeYHrurqtVuKlEx+8ZAqWwC2HC5UYBG5JAKJ9Z+AbVsoBOo7lDJFAglk6fUslkuh4QLEMxJn6gT4bhMd3Uiluv8orBvpBLNkeESORTEcgwLQzWHFeBVRjBPEusvikDzokpBB01E6+w1TwhcoXy7QRhQkzM8/ga00K/uY+hUSVjPiiWAM2aQY8W2oif4YKvd73SHW13OO6+6673NQX/INzba/c1+H3efgMn4yKtmAQRUt34rlDAyZqmOwSLfBUJPDronBmjzMm642wZE4wH6J2hDc2diBn6ZE1duDTDv691D1u2xlKtRTuN8tKAE1Tw9RrfO05QPcAhRJUjuCX80ciTVKlaEyieIx/f23+ycvjuBkaP9/57uH8MvpLWEyiHRSZWgWwKr4AtjfUkcBwEuuWVWpKAOkUTsZaD6EgTiypYnSv+XnVpElAErwoqw+4oVZdJsaPSkEkoUN1eOPZeRiNbYAMcm3MVjNoC8ljAwIU5/idU9c813QZMv2RggvTAvICkliUQhecooxUDzwadAiPEkwdD1BIY5hDIwI6FryB2iXhmLqi3mqqxaY4633pWNgsEBnN/vJzuxy4E5ErMchTNvCSwG+wDPXnNV7k5KSiOVTpXjMUjB03QKajQGNMygzAC+tiykIzSXhcSjinmzjIUpsBCL0t17z8ye0/Qs5rl9QNwdppB+miTa7MGFCMFHLUToLdAahZlCRoKHKDYtLjqQQhdF4ENDKNKkjt06duvYfWDsLj4s2sLwlKDP+jL0OVXFiQoIsQR9DHmP0gvHLt6QawwUEiDSX59OILC/AUyE+eIqw6OSn4iPfClfgTYLe/jxAcKPmbEqtkAGSY9egiFkIpFsE99zjklRXlUby7u90WYgE4TCyxARsqZhU50zDiozuVLICbdrLNHCqmeOjfnF7FiLMiDuqpJmpqVyNZKskWRdjepq9OdUoxpJ1rFbx+7vGbt3IsnqC4aAk2w+mXAzDQer/jm9+WEwYXYYyGYhF84Eq2gFibEZxmpUkUNj0FkfrA97segmvJtsbfSHnXirwzd76731QbfTa5Rr/dk8jmdBVo2pkr29HUnFAOIuAMflCpzLOq2T6vFfjof4Q0xr9JKswM2g86g4YCTs2F3Gjh+0A9mAMGBHc8vx4unRO6QPWxN51Bud7SLM9qqD6dwRpKT3d+JKWldDxxo61uWnLj9/TPmpoWMdu3Xs/p6x+yjo2L0POnYfAR27DCHWECHWPwkdE8AdCM2GYBSQIc5BvfTtRwaiwK9w+hjC3nEzEm4G9MoocnPVe+oDMI5Bhz32u93ywtqf2nIFQFZcZT6AZiCoBos1WKwLTl1w/oyCU4PFOnbr2P09Y/cRYDGgodvBIkx4MFiEuVGbzbDUG3Su/ztmpFAJHJB7Mx0TWkzmKJBwBV6ogPkj+tiT7ixsN1r+ggOquxm+6oe00rqWyU3Lv2NuynCBw+NSz2RuUlg8di6z263WNdgObHYT8UxGxd0ApS+jWE9aA1DYilyEHz/6uMMJbOfwIADfiLRtJDq0z35E3Oue5EPXBRvQ++47KeOnnmjUKWBi5sms4b2G4Fw0DCxmXE2fWZodkTMtyQdynZr05sdl8YRukWWV+u7cDeYz4HRBRBThHM0FTkCfcoO9ToGfXZ+6dnI0/Nl5ec4xQnXP4dLMefnBY+rOEkMfcVqHvRbcQB/hv9x4/tenkxdshACVEkRuERsLiR0FhNghuBElwJ3iKwZcRDXJ6Hw0JuF2Kt+JYMCxYQpKYZ/VsRDsrPhU/QNUhiNI5aR2XCQoe+Cq8+eFBRNxIVIsmtFc2+icMlEt0GKLV9a9oAJJnYRU8HNCo9Fn1WR7EvOWxEKPc4KI9IkGO8sKuXhJrqcy8a+CWjPEIVGzLxa48Ko9i/13xzFEPZLgqSVtPXlzT69ZoodtF4wg1UUeUBOBj+rXPXFhtSfzUaHXRHpVPj6rT2MJ1be6rLg9ZqF4pgk7YPFYayv+zRi6DobK2SiHSHsyW5e4aZMiotlpl1hq+i2bsglYkvh7B4GhvDPxAdZygjLa9/UUtl/IspAXvkCnnbAvFZlp+AxKLs5MdGyfzDNu2MQNmz5P2MC/r2joWBDbKAPlAe8Au3P7UyYIjJZyo6e1MvMT+RatwfKBF+yIis22/R/b8yQYfvlreDh7NgdSdaO4K0Rvs9KUBVpY1irKKg4RFjW4zG+qoZou6M3zO3sZhxX2V5P3xl+HKc5aPqp0+rOz9C2Z5NfJu/9QxqszzZ+YaQI4RnejbUMXUXby1wHTLZ/9QYMAcsN/4SnFKuFw6HKobyMUUyaUpdyhV/t7sWO81ozHuYI7xIdr6Fl6QpEIDT6GP/SGRGhkYA6ErQXcyv01r4idzHfmFDAefKJd8W+bh/f8GlwSulARsU/QyKkYzIJNHH5hCs++6tDNHYNlDtGwbK8wNoCuySRXdKtam3zCOLjUPR6RSBvnPnFBT6dEoQtN0G+2qohidDUUIaJ2xkzsxyEeSEOvWzL8PXuB3W04jQbVoxXDFa+5IEciJc/EeVVofx9t8LbmWKQZtpGQdQXeRJvv8P7gZIkiEFPhEF6bUSsssi2cC0SwhfLusxGtR+0mtRQwnmnroPEtEX8r3C233u3d195nd90XPfZ6fmT/a1+yD7UMm5BWhsdtqKHcN06+cT1rrGxcYe02XZqv9K7Q6YxBvbjq+hrPabCZu8Fhf08eOyQwOEYhNMhDSEGL1/Krmvv5l+NXCvxN4PlEMGRx3ZNuzRc95SM5fx7MkrzA7LHwvxlYyUJxEKqmZRYK1mAdXeD0Z1vEjH/gT79KS5beD6EUsxOJt/sQGjf/A6q8FUo= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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' + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-identity-attributes.api.mdx b/docs/api/beta/list-identity-attributes.api.mdx new file mode 100644 index 000000000..84c755a85 --- /dev/null +++ b/docs/api/beta/list-identity-attributes.api.mdx @@ -0,0 +1,87 @@ +--- +id: list-identity-attributes +sidebar_label: List Identity Attributes +hide_title: true +hide_table_of_contents: true +api: eJztW2tv2zgW/SuE9kOnQeQ8mjabAIuFm6aDDDrTbpNsF0gDlJZom61MakgpqSfIf99zLyVZspPUSTu708Jf2lgiL8998lyJuopsrpwstDVHabQfZdoXR6kyhS6m/aJwelAWykfrUSFHPto/i+qbonX3fD1KlU+czkkOpJyMtRcjVXghRWKzTCV0Q9ih0PV02UzvQbpXSelwGStcRadeuQNrCvW56JfFmFbVqdmvp8a5s0OdqbgRERPqfadkGp1fA0wunZyoQjnP8jRB+r1UboqVDO7gpzZJVqbqeOoLNSEAyVhNZLR/FRXTnAYMrM2UNBGpNpRlVkT7Q5l5dT2v61GQJN5HnoW9j1q6CW1EMVbCKZ9b4xXp6tTvpXYqrQSuR+qznOSZaha4GzE0N8W3QszC/izEXkmXjOUgU69NNv0mkC0EEe5G8p+FPbElW3kOxlCsFa5Ua0IX4lJnmchtXmayULzu2n/iE1vILD6g2WsNDjFGaCqHGcWYB5pyMsBv5AOGQG2PqxISbZmlYkAKFKUzKhUaC2Z6oiFMmlSs2eHQK/y4VE4JPTIWmvXem/fmGOFB86CGL7QZIfEKgiJYEZFII8byQuEy0n1o3UTSeD3JZVKskzZIWKcSO5kok2JhYwsIEF7Rqmss5B+s+RphYrQXMitVsAKNBuzS12iUEmf/fiL6b47EcQHk0qXiYFYI3jQJev7TuChyv7+xkaoLlVEx6nmps9xqU/SAZwOpvyFzveErOfGsoMSzRH8soJSYWDKLYf1owN0BQPrcJyiptNQu9TRhe3OT/uvGyCvUolsqHUQmVNcQWZgm8zzTCePc+Ohp7tUiGOmcpLDUqCy+dd0OPsIGuIFiCJsVOiAK0duM8ljZjBbC+AQhWKhkbLA8nIc5BJgCcxF01DJYVOo0otzUPs/k9LelFxuUXhvlfTx0GhGFHL7HovWO85u9FLQ1sI5AUQfELa5rYzge20sfAlfNVqGYf1RLeSQQP7XD510/FzRYPCy4lKExYklNKykQP8Ha+r6KLUonDVlUzMma3qVYXXhntfXbrN+S92Wzhi106YUL4hnsRZ736CYIXKtSi92BqlRVBL0tHeof1VQdbiAxh3pUOgLaW8pOLMLfXgCqAVyYUH4bROsBts9VoofIWwFV2H6hoFah4sqMzYd9Q1+w5x5WER4WqAF7JzgJEIXmTeJniy+KrUzdmtaSiirYZMK+KbOstmuoLdEhhtmpwqTra8o6XTCW4wCvc22BtdJtGrBzU5U+yFCICnHoHLwTi7etDTcwCN5IxcCmU/KCNnCOTnsPqOC3+CVVBba5A5su4Z2XKJ7xyElNCBVDTjCRbHqhU9rteeMLImsX8rhex4WwRG9LPJcp9A36HVTKkB2dTD5B1lH6ZUCnRmO+qKcg7TjKb1lW7So5eLa5t70zfLYj5fbfd7Z2nw72hvLJk829p3t7XPCwO8hRJ6bqQO8u/bMyyIhEZBZ7l/4DBgHvh+0ZAC++fG6wjCWzI4xt1KzwCmpS1lFQnh+8ETu7IpNmVPJ1OZozgolPj4lfIshDca1KXhD82umRNjdBUSCL1AK9OHzZP311gitvD/91eniMv0jWQu/VN4jWlMLSMsOsq0ulwKWkkkwEClxNrFVS16CQNL49UIdfobLWOyNmVKvfMKMtWgydnXRSKQkdnfhJ91RvHXQR18DSkrEYSPBGUPvAoftJovIiflVZcq0iz497op+mmpQEZ+FSib1NTol3ypQoa0X+hyVSWTHXtmVBtV0nquuLmSm73pgVk1dtp1ByAPmX46SfFCXAsZrtLGyipYJY+QeYg+W66E5aRmOTTk0Blk5cDcQpsQ48HZUJumk0DlU5CjstWH09rqlY7RrJ5e7XAOZFYfleIku/RN69yVB+YlatuXGhquTz1CuEasTeqN1UVSTcLMYhV+pRjbvqxBfYCrN0lbur3F3l7pK5O3/zbdWbVneZ+mwtUp9TI0vY1/HmuUB9nAqMWNSDmN5UjlynJqmiSL+8O0Fif1KGxqvPOfXY35Afha18AXy/8Ue4PiD60Tir4wsCyHYMGgxRiVS6z7hniANJZFM9WVztpXUDjQA1N1BEVE0nprYU0hFbN4afuvh17jXMo7rVQEZ4HyogrWrSODzaWDHJFZNc7Uar3eiH2Y1WTHKVu6vc/T5z904m2aDibKl4ki8nE+mmIdKq+6StFBgwe/HVpBy7ap6tkDDRcKyoyxyiwfbWYGu4m6idVO6kz57sDbeTZ9vy6e7W7tZgZ3s3au/1Z7M8bpKsm1Mtfwc/hqeTyl2Ax5UGweULa9Pu4z+Y16khlTUqPQ1vhs1h0vOGO27vLXLHE2vFr9JMa4bkOxzSzGxENQ1jJzTW1WMxQIoR6qKhF3YauCiU9ERBiqP3jfxWkJKXtIBcN437wwKqVO8a516Fiur1cXjanFlizRaBpenF3ZA4HyQwgx2hOn9Ddlq56KuYvHhLGr8ijcXh50QpSvSGuT+96fnuEcA7qhHHwcG3POgN3Y40CAA0BKFmNbxzxc9X/Hy1x6/2+B9jj1/x81XurnL3+8zde/Dzig3dzs8xYGl+jrG9TdFwqZfV4Zj/LU3nVKkQcHgLmySl48fNNQdnXoFQIkAjxTVE0snRaKM5Ndo5hhVofwBUugwD62NoV/AT/HPdk7nu1ZONveSzaAMY54a6Ew6hUMzQAD71FhbosWWdpuANlY6FBztX50ui5rjbnZLrA1NTW6K2sZh1OrJRBRJfBsQcXcQjz6N7HDgL+kGvU5ddf70uQdAtutxkvjtXw3gBpHMqkgrns+PBx0S5w+oLh4Rn2wi1adsLi72mYdviuZIO/UB4c/HTL+9OHosREU1OdDqmNhJKU2eAVHmDEOFC1q+f4tMk3lucLUfhLGe/856EEkcMMygsqmOQ7eNrb1GS2aQ0SXEVoFnLH4KUnXm3HHp8b2LxQrtwRjKcP6pUDAdDz/JaL9nS66Eg/lZLi4O0mKX5x3MogmnPknDuJkH2kgiZebbWgxcP8uKWPGqfcIWkzmMgS1Q4um+3ktprD8bRkReTvC6O9+bdWGMX7U4ToWgJP+aTv0ciGVvr1T+FoNChNDgblciiB8O6pEVjzoh4e7MFKQ5LxjoGJ2R8r5AYJgSTHNCezJTEgq2ZNKTkB/Yscv4DH5z70NGZL59h66SRqU3ucbJ3DjMtGNOCcagBvsIfdiYKLOQ26cB1IATAwcz/XAkqoK26F2TdWNVZ/AbPoa0hAVSW4vP98GN/VuCqvwTfoNHNGJRhotTN+z78FpUs2p46xqofBsxbcBFvZrErztkt4G0eRtFO+VfTlzTuz56Z0Pn/b12lb6kkf526+3+qeKtK8yNWmorkUrjxsnOHXinIn1d8bfEZnufPU/Av7nKuMp9GtzL7IqUtKM9kQVHNWZ2MteLuP1eyIO63TpFlJ5yJaNQp/dHjsaCRwxikrQcnlQOdQR4/n65XlpwwgViSX+m3L7kFobWSMbpJ1RPv0JCZBG6hZoxOWODeR1t1ZcfwzBtyrHhROxukazIpDR37BuxyIiRC6gsRkWqflKFwoTczqraFZerXzKqzmEKNVOhxW+Im/vWQHiyjZ205/gtrwe/1FyAw/exrjWimyFuVcWTSuC5t/5JsRFs8VllO7SCqLgiYaq3w69HJgkQIM+Gsdc+60UY1yW/QWAih9iiEz5PeVm8z5naBjn9bX6CBbQnn8+43fRY4F4dXswfq9/9AsNo1iO5v5PSAirCUof0IrR59JLjY6qF5GAMx3b66okcY1Ptc0+XwwRc1gLAhBfbsC6FbYd/7W78bYX9S1JfPf4FYdeBRRD3bgyAt9zHfEpDqTwy/EtL9P9a7A9vCx4QPBbf6hO+7+4TvjrCov9OcRcP57DEFsvscI4PrONXDpPDwsjVr4fUeSWkeKP18SNVT3sJfqz9oqevr/wLwQpLa +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 Identity Attributes' (list-identity-attributes)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

List Identity Attributes

+ + + + + +This gets a collection of identity attributes. + +## Request + +

Query Parameters

+ +List of identity attributes + +
Schema
  • Array [
    • sources object[]
    + +List of sources for an attribute, this specifies how the value of the rule is derived + +
  • Array [
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-identity-profiles.api.mdx b/docs/api/beta/list-identity-profiles.api.mdx new file mode 100644 index 000000000..54e7d5578 --- /dev/null +++ b/docs/api/beta/list-identity-profiles.api.mdx @@ -0,0 +1,100 @@ +--- +id: list-identity-profiles +sidebar_label: Identity Profiles list +hide_title: true +hide_table_of_contents: true +api: eJztXOtz2zYS/1cwvA9tNKKsp18zNzeK7fTcSWKfH5e7czNXiIQkNBTAEGQc1eP//XYXIEWRtOI4mbbp6UMbmQQW+8Zv8eCdp2OR8FRqdRp6h14kTXoaCpXKdHme6KmMhPHaXspnxju88fJXrHj3tu2FwgSJjJEGULiaS8MSkWaJMowzJMj0lNV6sgk3ImRasXQumIlFIKcSHrzPRLJkMU/4QqQiMZ2f1Jil+p1Q7Famc3Z28cN/x8evTl8znbDx+SnjWTrXCZKmgd9nMgEyqWYBjyIgDk+xGTyYiXQTRx0QdDUuiHvnSZSIOIJ3Ct6QihYy9apiv+IfmcoWE5Eg7USYLEoNDmpVAVJcCsFu/jkgZi5TrkKehOxIR5EIkAY7L4Z++/08TWNzuLMTig8iQgt1DJdRrKVKO4Fe7MhQ7fBY7hhHxw8KOv5KhGdsCjpa6EQwqeDnguyMYuZq8g6nPDKi7YmPfBFHIF5/1G17JpiLBfcO77x0GaPMMK6YiQR6WjL20aAPDxZSyUW28A6h34J/tL+JSiimHLRAf93ft5u1qadTI+rqPKPHwDZoEP1jmoEtrVYZvOiwa5OBeZclxyHvaJF1Wqj4mM+k4qmA/onOZnOi4wzzzZjjC4xRqP9h5Qc6U3Xdn05ZK00y0WIyBa2C4mMdZ5FVpWCtf/lXOuWRf4S9W6jSWCsj2FzwENyf7IANG8JhzoGizqKQTYSLDLCcnBZ2A/2xlvWJFrsVqKqZAo2FYDGwmVSBoBgXJpVqBtGcIiuMBIGAV2zOPwh4DDYi5WB7uYh5kLZRGsoQYLGFUCEMrHSKnmIEjtoiIn8lyVvIE3H7gUeZsFrA1sB2ZnJuvgkPQnkanGiidSS48kp+Qj0f9BVIkZQWG2iZNAFjePdVR3pBXQrrZwZNRtk+15ZZqhQSp+02QVdQv7FK/2LlAs58x+cztO2L/Cm6jMniWCcpsIfqp3QEpPQtvobUE4WG/NbOpDoxh0ih1ZJhq3XIWuJ9mynRhtkH/kM3VG0Wwe8IfxsFia3NzG3L9kFlr/Xa2DpOJM18pR4tr2R7T4ZMvGf7Qe+gK3b39vc4H4rwgB90J+FBOBoMh6P+YDrxHrK5Qak32ryUgzCsuG8E6hZ0VXeHS6D2B3cGFLjqCpf22eMcAewAdgdDAMU2y+3TZkEiUCltCN6Qpqs207cK2JTFL2v6NfMRFT+n4t2/xUC32dagLfrdLv6zruaXDt/ICozDNBFomDsg5UMnHseRDCiB7PxisOdd3co8STj6g0zFgkaEOfdsStDItdCTX0CNaxnoxroPMBsnaIpUWm5lWGf2cmmAtD8TSpDXsExJcEJ2eowioIbP8gGqjlf28l5/MBwREzw8U9HSpr373JGro76Gp59Bn2N79GdnxTrBI3yBPhniLPkpykXIYGs/lUC8ynp5+H63P/C7Pb87uOr3Dnu7h/1+Zzjo/wc5yt2pwQ04uIF9HfwevAFz4H3U6Dkg/SPIDlodp5qSzSbnyfE8MP1BXOosCRp8aU3WelLCPMknq+mvWqIIVnqS66RaEHTWnODVkgWZSfWCTQEKMWwA8U0N0RAUwyVWCtHqQ1PTTYNWuV8X3Q5Ql1koBH5Qox2fvL46vfp3Q2kGPfJxLX+Ifm7nMpjbOikRU4BciJkoO1Dpt9JAQRjEtbFcZaGCI4+/YLB+cNDb7+4PRmHvoMf3d7u9UdjfH45Gk+GkP+hzrxTcm9n4ewYw0EcXRp2yUJo44kvK0F/A3xtAhJIvGPyLyfMe/b1I1J/C6rvDRsfI+9PsAlh2o0P2ujBiU6w0+ODnOdDl2fXF0clXdx9Hdus8QPWCjQM0GTuGrBcAZlxSwqy7xJqBmSELO/ABo9QdhLRrH16IKYCF+UWRWj+J/WsMQPbBQogXWALlQqIIhpQQUEN1GLiFDKgWBxXOwNmxFp8LBd2COVczUazxWO7n3EAZBe8XUC56lUqlxD+Vl42hVFfTqtR0vUHjtn6bABxEoKkfzLa1IrpgaL/EzTgF6SZZChOZmsrZp6NMKPSYh9ReqbfTeTGZ4LLWApzGQc6cTK2iK0zn1MZzBq8SrgwKZTYBuc3M16R+/ahoKeOqwmUKxtZCAHCmjNBd05zdYzGVSuYzet3GRnATgxSs6OFgzapf+4mZrz5YWsp1xXilodaxAQ9o7aDQlle2R6O6q1M8D0Oiy6PzEsdN4GWcTCRwlCzZO7H07fJEzGVCi42ATxJIGmrJoKCBnJXyolIphi7YvlvxaM3rCZ+sAuUehap7+mrpZpb8Oa0Uuxy7t8f3+7tid7/bg19Bd9IdhLzHRwM7JeYQ8KrByuX3p1WHKzqs06m1c+FYitSTj4EgZV0ILNYu8kz8GDNU3IWbdxdUCZ42zlhF5sgyGTa6EdTfuRMBLVf8Nk1Vu3sHoyDsHvRBjQejcDTdC/dGg0E4RckSEuShEFyDqFypjONKKfZoTpWlGHXNmhT8oBahLWTwKygMENaHaIh6vJ6qEKsOSsLCraHROiDNReZcANKBFm6KWqWIwlubEvXDs1elKqGMeI/VclWq8xyw35NXDZvq5yOYrlXKTpIEePHZRWmV0uqMVh/ZRIe04yAViCfDp1TXD2SpEEJXRkc6fESueiGV8GcJl8ihIJYD6IiTyQcZ4hxCq4WWZG52areewUATnR57zkN24eQ7csLYFB28A1rNUbDO0LWt3/MuGAG5TRuGFXuCT3bB7YfT3SHngNF6e6PJwZQPBt2D0cEBlbjCGD4TTbPZ+tA/4CKCDFikAY7IX0EhgNtA98QADf74CZBoPHKusG0LMR2/LBUf0zaAoOdH52y4xyKAQhk957OKEpR/fVlLRiC5JXwGqEo2Vrk5YD8+eTG+fnkFTy5O/nF9cgm/kFYNwI8VeCsFpiasNNe3xLET4BaAmRG4KoawruWotkAgSMXlhtL+ZWjthrkohB5u9IYeZdJsmkARXQ4lipuPKftedkSnDZANVy54Clh6bY+wNQ4wJ/kvnSZbbsfhWYeNi+nTJhsD/Ze4WA/zql1ItJtIEMqCNih0luJ6vgwqVf5KldWpIU8lL8tGweAAzj/tJwD3MS+TmOUoLLzFsejsAzxbza1zd1VSGqkUV0yhkLDwO9AJFhMMEimTqWEuHdHCJSQelbcrMlY571O6e2WZoVUaXO7imXlE3J1HkH58Eq148UG44CNYYrMRWSM3k8tIDpdTZ9eqMFce+HZpdRu729jdxu4jY7f68sLtGri3BH16dehzrdx6A06eNeiTkPconS9K/GrrL2vINtatDiL9+ObKndjAAvZjjMsPXxEf2am8xvy4sIfbQco3mPKpf2ULZJD0aCWYQiYS4SHxveLYgkRS1aA+2gsNdRg4qGqAiJA1E7bUGeOgsiRTiraqTZuFWhj1Xeo2qSEijLEZkAr90Lf7VVskuUWS29loOxv9aWajLZLcxu42dr/N2N2IJAuuKFocTjLZYsGTpfU09x6l5QwarE4LFiFHpqqiFSTGCozlrSMHb9LvTXrTvUAMQz4MdwcH036w2+ejvd5ebzLs73nluf5mFcdFkK3HVMne1o5uvyH5ADguU+BcJtU6XF/+y/As0xTTGqaeAjeDzkGlbwvs2D9o2M3Qmr3CRXqHkMwahlQrHWFOg7YLbJvkbSXurM0gLyo85Si1XWKWCwFU8AwNo6OUtDMH/ALdZOmPp3gQzx3QdE5WjCJVEGXAIWWCfLfslkvcPJsi5gMKhGBnkJ2/Ijp1JvoiJM8uUOKXKDHDJWvckmQFch81re+eAvMJ5ohLa+AHFnpttcMVOAAUBDZnFbhzi8+3+Hw7x2/n+D/HHL/F59vY3cbutxm7n4HPHRp6GJ9Dg0fjc2jb6bICS73g9mDDbwvTKVQcB+TeTAdBltByc47BQQlGwEM6lwmDXAOuP7KuPAbQjpEpQ3WYnx7x3TGsQzzzh5mo6R2YCYHrWzxisBDgpyjtjK6xxRxpejvVPnSJggCnlTVLImiWX1u4AxcA0993eCw7eVelb+nuwgT03pDS8OyBDV9sQLck7AAdMloiMS5sEiXi1oTuxIRXXI/YSDk/LLLUGaRNItPGs1HOR+kxsBhDgfKdodYd8smafCDXdRLdf7ksltADsjSpb+No0J4BpxURPXt4JHebS0TzdvSa86xmKKwA+7XBzrBZnz0XPIFSw26KfP/jm6tnrHTlga7CCIlFB0ThObgI5chxvkGAnWjaWt1jHK9twWBMsmkEAjN3LS0/8PIaJo8LyPakUuwkKMFgr8dfmuFr/R64hPaT8t1pVolYANs4Ee1FvZs4l4uX5HoqE3/JqfmWmk/U8MLOGhdWtTeBPdITQGJAEjwypK0nD27p+SV6WJnBE6Ra5QE14fhY3zgLcqs9mY81ej7SW+fjJ/WGjiSvd2M2ZTEzp5uYpyyYa23E3xhD18EwuJllEEVPZovOQfsUEX6/W2LJt0P60ge4Sfy9hMBQ1pn4BKd7QjsagKAKbUj+TJaFmP+ZLtn9vCYzPb6BWRlbhjr4jJtgFZ5xQB8H9G0OMI5/O+mhY+GBP5CB8oB1gKOV/SkTOEZLec/SaszqRH6H+uDUEACrRMXEh/aPw1WCc78YvcDWRRtIwx6dP3VbiXjl3dG6X90PsMrK1xmqGqzzG2mYcCt6s/wW61w4Cf/R5EWJx6vlGLyx9LWz9AOZ5I+Td3+njLfNNH/GTOPwM7obDVs5TYtO/tzhtfryoKHPBcD/4S3FKkF1KIRWXwgoE4ojntIhe4zqYC4FLSzEgqeI/droWXpBkQiIGsMfykciNKNLmQmwzKEUlBHQo6XvfGROAWOBJdoV/zZZcWnH3lHpsDdQ66kAzIJ1Hh7egHe/aFfwXYJlztGw7Dg3NsMbjZly17WyBePgUp/wiFCaILOJC8o+JXJdaIJ+Ra88itHVUAQ6/CyShTmb4pq1xLPs3iPHArsbt2ANqkcrurvdK0EuRESeie3WYfunaIO3+XMRxVhpQtYFACZKI7w6vapRBGLKXiLo6GS24zqZHWwLRLA8su4z6PQ6XZ/KBbxZp00KRVeJeP17Mvhdl6oX3q1W6r/xD9O4CQwrj50Yl+FQLZmthGzNeePVa06oYuagOnx5d4dyYRF2j4/tTX+sRMGY7qZS0yWwsga/rW/cNGrsncCFj/wTPm5pw6M7yY/Xw//Xx2k26LH4eM8TFbn90sy396WZDe6Qf07oid6w/VzM7/O5mA0WXX3054k23X7z5XHffNlgg9VHeFY2eLtaFYU5/C3eyaOUSBO67Wa3YUq9agcV1lavfzhBsMYfKJfdDxzq/v5/3Jgl5w== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Query Parameters

+ +List of identityProfiles. + +
Schema
  • Array [
    • owner objectnullable
    + +The owner of the Identity Profile. + +
    authoritativeSource objectrequired
    + +The authoritative source for this Identity Profile. + +
    identityAttributeConfig object
    attributeTransforms object[]
  • Array [
    • transformDefinition object
    + +The seaspray transformation definition + +
    attributes objectnullable
    + +Arbitrary key-value pairs to store any metadata for the object + +
  • ]
    • identityExceptionReportReference objectnullable
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-identity-snapshot-access-items.api.mdx b/docs/api/beta/list-identity-snapshot-access-items.api.mdx new file mode 100644 index 000000000..bef5b73d6 --- /dev/null +++ b/docs/api/beta/list-identity-snapshot-access-items.api.mdx @@ -0,0 +1,91 @@ +--- +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: eJztXOtv2zgS/1cI34c+ED/jxLW/HNKk3cuiu+3lgQKXLVBapG22MqklqbTeIP/7zgwpW7KdpEmL27YQsOjK0nA4b/6GEnPVMJm03Cujj0Vj1EiV88dCaq/84lTzzM2MP0gS6dyxl3PX2Gl4PnWN0UWjoGL/gSHGLhrvdhpCusSqDLkBr7OZcmwu/cwIZqW3Sl5Kx/xMMpyFmQlTBQ9OUzCFczDuGWdTdSk1E9xLNlGpl1aw8YIImF9kkp3IP3NlgR/PYQKr/iIdmEtAH2T9SAk9Kvg3Z0HGkZVcPGKgRcYtB9GkRV2uGgrlzbifwSMND+CXEnDtkpmc88boqoGTwl0Hauhp43qnYYMAYDRvc7mpu1xpR6zkZz7PUuTxLOkOO3J/8GzAeV+KIR92xmIo9nb7/b3e7mQM3LdKhMb4WplcJhM1UVKwyG0lVq/TGTQ7u81O96y7O+p04L//rUT5M5fg46UsNPWtsmzOXXIyi+NXs8NDk2vfuH6HarjMaCcdMgax8H+3mNeMP8jEt4BdYrSHm0jPsyxVCQVF+4PDQVeb0nJrOSpFcYf3jZavJxQRkSLwxrBXnuRcJUO4emMNxKc8iSKTwb5oLGp731FZds8RLzTdm8t7z3Viykq9u75eOosMFQgZUrKKIdhy0IbTDnQRAlmkLRwNElzyNJdly/MyV/QRlqdeMuw+6zwbDPZ35f5QDDtdvBr05HAw6XT2J6sAdSGwIERNbhP5e7h7xD0/TZTUicRLJ/2SgspfbzDcNbs98Qkzdk36ipZN9tbYj4Iv2ofKq7+kdjOVRfVwqHJZyhfFrLbFDiyEKzsxUz7T7LcjjP2Vbw4p9Efd3g7G7VFlMDidrsAHO+tmx2F3GpyI7rA0zX8fG3soz8UKgKXJtjgq2CL9WuKr7L7dMHebdNNCWXaHdYDgVstk2f0jj9/ksFIy3i5WyQAM1kxyzYZsJaJ7yMg9FOhx7pHD1Jo8cyvejfPsE3iRzc1YpatVueqRs22zf6scK1voqzNsw/5Y0m4zPLPmjpqEBF9RiqrzkTi3aoll9xorb3/bGniYKrTTC2uNBT4n0udWw8KuJoSxEAtIgFljIwCBwLKrQR0lHrJMLpcJqNuAFr0Ka4CQnqv00Ai5CQDWlX2ptGxOLVcooSSRExiIK8GlEjACos5KFlgifkMViK5VgQlgiVaXPeeCACDqdxiVATN5y5OPwAvD7C6BzrWC8awYAmiCTUCoG6aVA8nH+51hrz/Z73Pee9bvDvbGwwnf3e0M94ZDnH0OLuPTYJo1fFGd+heppVUJS00CHvlLIjrmYHsSgCYvQ5LbfUA8vsD+CJgC7VLNKC/z8rPfAcT9/PAN6w9YyvU0p/t8umYE3Tw/xbDO05SP8RaiTNA8MH5t1VTpbaJInc+xZTh68fLg/NUZ3Dl58d/zF6dwhbw2GgcogUoLDEsQFWJhZj6FtiEo8Ik75mQK5pCixZ5Grk9BIa5dmVCFX27hMP2FnPA89TAizr5lRJk1m1gzr6QS5c1nzx6rlmztsDHem3OfzNgYypxg4EIkf4pFJ/PNV9GST9kM2g5pn0CNEkKhkjxlVFygP+ILYMS4EJi6gcEkh1QGYRR0Nrln2niVyKovVqasemMF5V6VnYLJAZLfHScHic9BOFKznIXLaIkiRv+AzMFyVenOSkYjky605wlowdN0AWa0FizMYBmCZsCxWI7QXQ4Kjy7olhULS2ChFpW734IwR97Qs4Tn7gvy7k0K5adJqi0fXMqYfBAGJlYj8kbhpliR4CGqTYMj1dJdReJDoypTUedunbt17n5h7q4/LNBZfErQp7sJfc51sesDSmxAH0vRo83a1lBw5A4Dg0SI9OvbM0jsj4AagV5+znDr5Bvio7CUb8GZhT/C/THCj6WzKr5AAcmOQYMJVCIpRiT3SmIyVDDV7uZsL40dK4HIeBMiQtW0bGFyxsFkNtcaJeFuhwkjnX7k2YxfLrdtqALirFo0M6P0gzZcaiRZI8l6NapXo+9zNaqRZJ27de7+mLl7K5KsvruIOMnl8zm3i7jlGp6jtpwBwXIbkC1TLu4GVtEKMmNLjNWoIofGuNcddyeDRPYF74v93eGkl+z3+N6gO+iO+71Bo7zWX6zyeJlk1Zwq+Tv4MbzSk/YScFyuIbicN0ZUt/9y3PyfYFnD0rPEzWDzVrHBSNixv4kdfzcedAPGgB3tDduL5yevkD9MTezRbrTVizA7mA7IuSdIiTEMllbO19Cxho718lMvPz/N8lNDxzp369z9MXP3XtCxfxd07N8DOvYZQqwJQqx/EjoKwB0IzSbgFNAhycG89M1IBqrAVdx9jGnvuZ1KvwR6ZRS5t+099TE4x2LAnobZbnhhHXZtuQYgKz9nIYGWIKgGizVYrBecesH5ORacGizWuVvn7o+Zu/cAixEN3QwWgeCLwSLQtjpsiaVeYnD93zEjpUqUgMKbmYTQolihQMIVeOYD6Kf07SedYhg12uEQBpq7Gb/dh7LSvlLiuu3iURP4iecSrtvhpXNTxUMnAagGqXObAreZ95kbtdtX4Exw4nWLZ6pVHAnQ5lMrMfP2GCy4pTjh15AhEZGAHbw5jki4Rea3CiM8lENiHpxBCmMsg1PoBfitnPHbT/TyAkAyC2x28NRDjDa6DSJmXC8eOaJuUXRt6Ad6ndv0+ut1CYxu0GWb+W6dDegZSLqmIqrwDt0FUUFfhoO/zkGew1DLDnKMhIt3ZZpTxO5Bwg3K1XqE+9a9DYFeI1mPPZfcQmMRPuV4/OvbsydsioiVKkbuECxLhS0G5NwbCCOqiAfFZw04iBYpa/LpjJQ7qHw4ghnIJikYhf2hT6VkF8WX77/DUnECtZ3MjoMklRMc9e5x4UEhL2WKq2hrZW0MTiV0G6zY5pVxT2jFpNZCabic093WH7rJjhQWMoUrP9JEFembDXaRFXrxkl4PFeJfBbdmzEPi5p6sSRFMe5GED5ETKAPIgqeOrPXgyQO/Zokf9mFwB7muy4CWiHJUP/dJCq89WI4Kvybyq8rxh347U7AcV4cVJ96gnOWpYMcsmRnj5L8Zw9DBVLmY5pBpDxbrE07apIxo9jolkZphyqZqArgk+V5BYugQTHyMizthGxMafUrb9+RZqAvvofUW7H1FZ7p9AWswUgqTuAfLjBM2ccJmqBMuyh+WOAwsyG3UgepACIDDlf+pEkRBS7Ux8Npa+Yl9m8bg8oGnAomLy0bhx2hVBONVODuI1EsaKNWN4iQSvd5KUxZ54TpXMVaxq7BuwU15UwPL65rdgrzLt3O45H5v+qLGB6vNl9c6XXzrKn1DJfl+6u4/VPHqSvMzVpqIljHcaNrYVpSD/HnEdJubgdAxgN7wLzylXCVgDm0PNXKEYsqMspR7jGrK6mSGR7Fxf1dyj/hwByPLzCkToePH9IdmkRhNLdBA2jrArTycC2uxs9XMnBImgE/0K/52eXzxbyAkoS2VLfYWOjudgFuwq8NPTuHZBxPbu1PwzBt0LDsqnA2gaz7PNZ5CA7HzOR4KvysihHJJHgoXNHlaFrYwBP2Wo4osxlBDFVrU39i5ez3BHWpofkuOv2Mu8LuL29NgevRiPPO1UuREphSZSFeF9nfxhmhrzmSaYV8JVVfGU2txht+OzzY4AjMdd+WNnbbjINdGWmCCLVQIn91Wt9VpUksB9zPjPHTCJea/SP+tTuqvh+7VajP/u/4LAXFNw2akneE+HFoqDw1U6GgvGls7Whg7Cn88oGhq8U48bl/pa6ELmoHpkdPVFW7qYKN3jbfDaXvsniAYMEOhm55AeVo/01815tYj9lv1+ChxPyJSFMc/6ex90TLec/LH0driCRaHtT99sFWEYuNTL8oiFKLBOOyFHyzAxt85eIAMNJJOkYYdNTJJeBT23EqDNt5KoS2X+yC/vID8u/4bCFl05g== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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' + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-identity-snapshots.api.mdx b/docs/api/beta/list-identity-snapshots.api.mdx new file mode 100644 index 000000000..435a7b900 --- /dev/null +++ b/docs/api/beta/list-identity-snapshots.api.mdx @@ -0,0 +1,91 @@ +--- +id: list-identity-snapshots +sidebar_label: Lists all the snapshots for the identity +hide_title: true +hide_table_of_contents: true +api: eJztXPtvGzcS/lcI3Q9JBK8ky3JcGzgcHCe5c5E2udi+HM41UGqXktiuyO1yN7Zq+H+/b4b70sOPuMW1zi0QJNIuOZz3fKQ4ue7YRKUy09YcR52DTqxddhwpk+lscWJk4mY2c52tTianrnNw3infiX9goE0XnYutTqRcmOqEaIDC6Uw7MVfZzEYiVVmq1WflhIxjkc2UcCVNMbEpP9ElxY/ql1ynNDbH5FT/ylwJF4JDYSfimY7MQTk6mPn1D1Ilo2cCHCYylVhWpcTndUcTL4nMZnhl8ALfdITPLpypuewcXHeyRUJPHVg0087NVif1DEANWZqrdbkavDIpdSXnSUw0vgm39wfq5d43e1KOVLQv9wfjaD/a3RmNdoc7kzGoFxz9kisorWLJZTLN7uZqnQuXqFBPtIoETxeRzNQSO8PBYC8Y7ASD7dPtnYPBAH/+cysL2kBnn2V8BxegbfI5mT+SNHNuDfR6sZG5khw+RDqECc2UzZxKM6W34HYhYHqmUTlBLVI5P2D2bmM61nNNelte/zt5JcDoWKXkL3ClPIajZZb8ME9N7wdzopQ4/9eOOPxwLE4yaSKZRuLIxrEK2dk+VE508XyWZYk76PcjOHBMUdJzUseJBYe90M77cMe+THTfFXSCsKIT1M74gmWc25SEx8c5e3Wv03S3iYydahhwuDvYYAzSzFSlmOnJ+Ec7QzKINnpOFsK8ubzyn5lKpCYSWuBvN7dp004mTq2r8z0/JotYNtIkRxB7rQq86IkzlyOuFw3rXWoYtcvW6ZLiEznVBu6J+anNpzPvCt4wT8Ycv8EYlfpvV35oc7Ou++OJ6FIW6gqdQatQfGKTPPaqVKL77+DUZoiSI5rdJZUm1jglZkiHcH+2Aw3cEA4zCYo2jyMxVkVkUNxNKrtBf6LrfaIrLhWpamqgsQgWg820CWkexHAc3RKGBiuCBRGhNGImPys8ho1YOTRezxMZZlskDcpDqmCxuTIRFjY2I09xilbtMpG/suRd4om5RTrIldcCjQbbuSu5eRIe5OvJmhONrY2VNJ2Gn/DMm5sLouZN6mgCMjr9s+wjh4KqNdm2qksun89lumAWlQxnVb0l/kKkXIwjQjJJYs7O1vR/ckTtep09maac7nWm5q7x3I5/glao5KakxUx7HsulNtWPZcbJMaloicuZMssggDwDFryUToQo7ZmK7qtsvQFXNxQjEOBBq/jlxCvlY6FQjL2h4aNNOj2KNSaLN2kKDQbAJHV4+NTFbi/GNlqQI2sD39TRY7R7ixYjlcEpj2yk7tfjW21UME2lJg4VsxxiogDFzzqi2GQ39STJT0gEHtdb0io00dsWr2TEGIzkOyqEIa2mMvwZtAge3sfQmdGYL8opMGtV4Tcsq/aUHL8c7A9Hk5cjKYffjLb3dsf7E7mzM9jf3d+n1efKOTlVboNbLi/9d2VUqkMR2xAW+VUR+JTQvQ8FWvzhnsw0HqB/wjt+bCVmwa/I1BWynRSvjj6I0Z6IgX5yfi6nK0owwdkJVQMUVzkukwUk94Tfp3qqzV2Q7PWbt4dn707x5OObf569OcEnorWGyw9NCcks14OZvWSOCwEo4pyidIfMKroF1S4EksY1B2r/zS0clCmKxIUZxeobZjRJi0lq50uhxHFzlYnnuqd6W0jueIacitw1lsjywvoM0T0MQ5VkwbtCk92i1L3oicMo0iQkahBXCmw/gDFRJWQUMaIs0AtCWXFltHlGhUSHatkWtSqXrVGnlndNo1BwgPP7/eQwzACU2CeWorDyloLFwj7g2WtumbvThtJYpQuToaZiBmEwpE3kTmQmyKZR5ot0ROZySDymHFdlrGbG5HT3nWfmdWb5XShz94C4+xAj/QQsWvXisyqCj8G3z0ZsjdJMRUYqcCVPLkZV5ioDXwBXxlEbu23strH7wNhdfVkCn+ItQ5/tdehzZsqDFwixBn1S9h5jV05nvCG3aEdfQKRvP50isH8GsMN4dZUQIv4d8ZEv5RuwcGkP/3xcnjuUpb+2BTHIevQSTJCJVHTAfNcce5DIqtpZX+2tTccaDmo2QERkzVQsbC4kVJbmxvAeyW2JyCpnnmXF7ggR4ZzPgLSqiQK/EWmRZIsk22rUVqOvphq1SLKN3TZ2n2bs3okkK644WgqcVBxAek8r3pO0UmBAfUxdhRybahWtEDFRYazOMnLojIfb4+3JXqhGkRxFL3f2J8Pw5VDu7m3vbY9Hw71Os9af13FcBdlyTDXs7e3of2NT6WfguNzAuVxmbbR8/Af1pmpCaY1ST4WboXOo9KLGjqN17Pi9zSAbCAM7prccL559fEf0sTSTJ73ZPA0VwWyvOn8wTpCSj8TVlXZZCx1b6NiWn7b8fDXlp4WObey2sfs0Y/eLoOPoPug4+gLoOBIEsSYEsf5I6Bhpf7dhAqNAhjCHeg3BxgSi4FNx+liEfSbTqcoqoNdEkbubfqc+pmtS5LAnfrVbfrD2p7bSAMiqq8QHUAWCWrDYgsW24LQF5+soOC1YbGO3jd2nGbtfABYLNHQ7WMSAB4PFXbo+KCos9ZbvYP6vMSOHSsEBu7ewIaPFqEaBjCuopQLjp3xVm1sbDjp93wdB6g6KS5RIK/1rHd30XaN/w4NSz2GexphZ3oa9huFgsJueTHSvvIdp7CVfiR1DWxsSEd189EFHA/jyrV+gx6pONXmzT31M3Cu+uOLaqW7d3kmZrkeTRRcAxMKT2RLw/MKz+DFYTKRZPHM8useetCYf5DpL45vfLosndIssm9R352oYL8DpiogkwgWZCx4AQmyvM/Bz5PPWYU5WP79ojjkhnO45XBtZ1x46ox6uMfSehg3FKyVTbCL8tY3n3346fSGmhE45O+SOgLHStJ1AfH2AG3H2OyyvMNAkLkj1Ff/DpUsiFG1iEkMporixXV7R/R5l4SPyOKudJilOHTTr4fe15dK8W+5n/2AC8Vqn/jq37z4qRPR32M+TUi7ZkOuxTPylpBZ4agFTcy9WuPCqPQ/9peMQIU8kZOxYW49e3NMLGvRoz4UnRHWVB9JEwcfy1Z6wtNqj+ViiFxC9ZT5+MJ9mGqV3eVrZPIbURU0KxyKcWevU34Qg16FQOZ/miLRHs3VJiwYcEcFw0GAp8EsGOgCQZP7eITCMdyY5pkLOOMb6TT2H7Y9sWeSFH7lv4sclmfnxOeotjYxs+AVNCCs804IBLRj4POEK/n05I8dCbJMMnAe8AxzV9udMUDDayI2e1sbMz+T7PIfKBzXh+Vv+yYH/clAnweKTb9Wj0dUYpGrC4dVlJ2oDLGhRTVtSVnmCsKrBdX5ji1K6ojfPb/VLHJXXP5u8JPFhfdDy3sSL3ztL35JJ/jx59w/KeG2m+RozTYGMyd142ZX+H3LyVwWmWz/4c9xJh7/xlmOVQTi2OHXzXJNQEsuMvJqjOpxRVzOd5SqZET7cIs+yc45E7O4p/LExZEJTbmNKwbLEJk/HoNcTp/XKkgPGg0+yK313efEjv4VLUuNsT3zCLs6EMAvt4Oh6Kd79ZIut3Aks84EMK16Xxgboms9zQz1VYDufCwmXuscjIu3C3CcubOiMKnVhGfpVs8ooJlcjEXq8l0nn7v2ETqOx0W0Y/p61YHdXHEVD9WTFoi2yFuSjitkzadwytL+PNrwtmKk4oT0ksq6i5q96he+OT9cogpgpTuBtOu0Xk1yfxoIIbaG8++z0tnuDgLcUeJ5Yl2HX2yD+Dtuyh3S9r/rldX0q/4d10hfFiHYR/YQOy0jE3O98/LbzvLNx24m5B77Jvtp5Yp8yg3JoyvU1HbHQVuyGHvs2WNrfwFwUQ3Xf5B0aubX7fSPTP6tFp26yL84AOtxV/mWL/r5d7Xdy2+jHfyTDT6sN/g5VlF3+j9TD/1f/+h16rPr7H6nIthn96TWj3+EO5f84UHvDRX3S9YUZ+XlRa6IX4rRZgrgMbOSh/G3GLJosVNkvojNPFA12HWbGv/AH8o0paz9ZkxTVIenf36Bg3/wXxvvRKg== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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' + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-lifecycle-states.api.mdx b/docs/api/beta/list-lifecycle-states.api.mdx new file mode 100644 index 000000000..e5f467516 --- /dev/null +++ b/docs/api/beta/list-lifecycle-states.api.mdx @@ -0,0 +1,86 @@ +--- +id: list-lifecycle-states +sidebar_label: Lifecycle State +hide_title: true +hide_table_of_contents: true +api: eJztW+lv2zgW/1cI7Ydpi8hXbn/ZdZO08CBNuzlQYJNgS0uUzVYmPaLU1hPkf9/3HilZV46mxXamMDDoOBL17uP3KOrG0wuR8FRqNQ69oRdLkx7LSATLIBZnKU+F8Ta8lE+NN7z0ijvM3bre8EJhgkQukAI8fz6ThgkVLrRUKUtEmiXKMM7i4kmDT3au1JUasVR/Eop9kemMvT19/d/R4ZvxCdMJG70bM56lM53IdMmAYiL+yGQiQniCBTyOWYp8YBkQAvkWPOFzkYoEpbzxJEqy4OkMbim4AX/JUKgUiPmLREcyFr4MvbrsY7eGvbNr2PgQ1uSsvWGaZGLDM8FMzLk3vPHS5QJJmzSRaurd3m60ci4090nzNsY1s34r32tcbBZaGfAI3B/0evi/Ko+aGMAg0CoFhXEpXyxiGVAUdD8aXH/T5KcnH0WQorUTjJlUWm6gT0MmFIiHb1W8zKUXX/l8EeOSQbDf3+vtbW6HA7Hd39nr9bfDzUG0t98LeH97r9+wTjV0mAw73m1u3W9hvLLyCT57pxOsgRgyIE6pCGYKrBOffDPLQvTzCo1m0ghWcCHGLIIsqOcMo+SC//AmpJdIFCzPjBWzQrIpZIsdDktP3B2S1hqlu8QtAKVT8SjXg7RzDmHmhRj+qSQDlOIBAsDvbfuDvfP+1rC3O+zv/udBcRx7hiRJnrkOZSR/nkA5/5VEQvFJXBFoonUsuCozswJVSb+fiXQmEihxoh4CjIor0cUyGUpDv4lfXuEOdGaT2nHFQJmKxCvpDZc2B/cFbn9QF+okm09AJh0xxweyHySEfJzxz6JNVmuEOZfxiU7BNra8vK0H6B1VReEzyzdc8SlV9W814jhidBklUyTe3NJCExJxdBao02blYMbV1Cpg5RjF8SicS/XdgtjWJRgnaown4tuFOVuIAO15YX6QZTIkxIwlC4JIxa6s50ZhCJ3FHAMouPLYRMT6S0Pme+St0ygJy5OEL8uiXkKdNem/8J9OoOcIOuDnYHUBupxMxdy0dMBmcpoURUPFGAkBBicphOkwMMBVmylBQ00UMESqJjK5kR6tPPYNmVI9ObojB2AJDwLM1lGAF0yLeeoa35EtPHi47B+djF4eHzUKmW0CE8hmGTFLBwAZhOlEtJUaJKmyOfqrIHg4PqNf16CR0VkSiHF4rzINMLC1s9OLtrbDnV5/Z6e/G3K+P+j3tve2GuKeEX02RkEaUVAKpkcQvn8JYKgGuM3jyjghDg32ZOH+NmyemVI9tPZhEXSqDMIGjBjFUC8JWdonOuxMCAjGriMAEVhAZ+zxjo+jYKphNSrHDt2BaIIQd+D1ARf8NNtZIXMYjja0bQQzixujA0mNnWaC9q5SskF1UoFbeHOrDf4exBLaFjtKErCrz05pMMFaZ4sugm0oNGyiQ5o3pPrMY0SaPwwmhyKFMnCgw1YIWRX2lVTCnyZcooSCRA7gQQYUP8sQngC4kSAmQ5J536B1nUrKgyU6ffaSh6Cv1e/AKYM2THjwCWiNWzFTVaALJeF5lj8CGIDi8w62YlfwyU5vf7AV7WxxPtjb6u9uT/YjvrnZ29/e3ye8BkEA7bgtRqusXwslEhmwWAM2ln+CQQC1gO1JAGL++DJJNB5hf8xpu7ZQ08kLMP1rugHz7MuDd2xrl8VQ7jO6zqc1Iyj/4gynwCyOsXLaZgyaW8JvEzmV7RXbldfDo1eji+NzuHJ69O+LozP4hbQaiTWCfqVCDEtN+GwGPTpdKfCFQ2sXMZgDcCJ74ai+AIW4MuWF0v5llgaMCbEV8SxO4QnHveWJMmkWJXpeSSXKm68peyY7orMB7QSuAfwMZmzCDTYVCz5eQB0Ti9Q/dpZ8wWaASkXyvMMAOUhUEoYcyMYMCyxfYl+CZm5hChKIMiqvWDB0llJ3hspa8cXKlFVvlApJ2Sk0831NH44TqL0ZCEdqlrOwiBYnovMPyGwtV5XuvGQ0MulSpdiIcZ9jCWZMErAwm4BuMjXMlSN0l4HCo/J1RcWqQA+U5o0V5jDVdC/gmXlE3r2Lofz4pFpx47NwyWdwH8ZWI/JG7iZXkeBmOrO5kq8q3JUnPvRBEYfr3F3n7jp3H5m79ZunbtPP3SXo029CnwvltlKxeTagTyLsRJzvt/5J8MY5cgNRq4NIv78/d/u1uAnxdYF7kz8QH9lW3hB+VPjDXp8g/CicVfEFCkh2tBpEUIlEOCS5VxKToaypNpvcXulkIiFAVQtEpGFyqTNCqkmmFErCzQYLtTDqNwf8Lby1FdDuhPuE59dIco0k191o3Y1+nW60RpLr3F3n7t8zd+9FkoVUlC0OJ5lsPufJ0kaau0/beQwWsPz1MytSjlxVRytIjBUYy6siB28y6E/60W4gtkK+Fe5s7keDYGfAt3f7u/3J1mDXK/f6y1UeF0lWzamSv60fycQA4j4DjssUBJdJtQ6r238ZnlmIsKxh6SlwM9gcTHpdYMfBfhM7nmvN3nC1zBGSqWBItbIR1jRYO8e1Sb4WFnA2hbqoGJQqqe3rIDkXQCXBNwuxnEtKXtQC6CZLfxSloIpNlDzICi5SBXEGElIliDWiZg2BJUFJESHmAwqEYKdQnX8gOnUu+i4kz05R42PUmB19DYTARC+Q+3bb/u44fx1+Zh18x0avnXa4ggCAgcDWrAJ3rvH5Gp+ve/y6x/8aPX6Nz9e5u87dv2fufgM+d2jobnwOCx6Nz2Ftp8cKLPUKg+v/DtMpVZwEFN5MB0GW0HZzjsEJV0AooUBTQTUED90OvW79oK/p3rSc/b3t1s7DwrLmQd1boGsHBqtKlsTAYpamCzPsdm/Aw+DZ2w5fyE7OQ+kveFqpOwGztlQse34Tow0X0Dlny6BDPkkkhr2tkUTceoisgAEOnqLd5Hsp0/lRcP1SZ1AVicwGgxRxIUiXQcQFzB+/mfyYK51erukHel0k8e3362IJ3aFLm/nu5QbrGUhaUxFVuEZ3QagAIfIXHus6sAVulGF4XF6X15whoLcSNlaumhQOgYOGQG9x2YC9FDzBo5r0XuTZ7+/Pn7MpwlgqI5lBBC0knebk7B2EEZXJUf6OAB+izpXobGqPu4wqb2EwLVkUg1HYlcKzQpf5GfUT6B+nUPDJ7PiQoBqDT10/yz0Yis8ixtbaWVkbg1OGqgtW7PLKc8+pjdK8IZU9K4qnfa+Uzw4lVjc8o0ZrnIo0PrLLRa4XL+n1VCH+kVPz3UEhomae16Swpr0M7KmeAGoDkuCxIWs9mbml55fo4XAGV5BqXQa0hJOj+u4syL32ZDkq9HykV5XjSr2fSejR1ceYLYnMQIuNQzZmwUxrI/7J6JgZpsrlNINMe7JYX5CpTxnhD3olkXzL0pc+IE6S7xgSQ9lg4hPs+AR4NGBBFdq0/UCehbrwAebxkH2o6EyXL6Ex48pQB+bJMiNDHxn6tk4YJ7/texhYkNuoA9UBGwAHK/9TJXCClmqjpdVa+Yl8l57B9hGAqETFLIb2j+GqCLpfjG7g6mINlGoE7MXbRDw47GjRUb+ysfKthroFm/LGGnpuzW5W3mKrC/vwX01f1Hi02pHBI+s/ukrfUUn+OnX3J1W8daX5FSuNg9AYbsTWzRrlIH/pMF1zh9AIdyQe7lKuElqHWWh1aLdMaBHzFKOasjqYSUF7CwvBU8SHGxhZek6ZCPA8oDP6ltCUvvFJQGQO06CMgR7tfuecOSWMBZ/oV/zbZDTg0GeC9ig+e4/n2ANwC456eH4D7n3UbuY7A8+8o/PWh7mzAXTN55nC7wBB7GzO8BuXByIilCbIbOGCyU+J3BaaoF/xVJ7FGGqoQoeGnmRu3ka4bQ0TccnxD/ACvxu3Zw2mp09m7PeGK0VORczthwUbNWj/EG2INn8m4gUOm1B1AYCJEoc34/MGRSCm3KF2nUy77iHTxbVABEcoGz6bnX6n59NIAdcX2qQwHpeI176FrIffzWqX/id9a+o6Do4K3QVunaEemR1v7BB62fjaFD0wbP8EtT6H4sqWT0ZhbJlp/ILm0ru5wa0ZnMxu8fIfmcC5//J6NXTR8FN8sTGMoLrUPwMq2/HZqdP4OWv/BLZV5XxPUS1X2wke/PwkcBeiTVkcMZ8kVev3sU8QqsWut/jRit3LIqvZhXa3q0Si8T4I58hiB+L1EQT57f8ALJdg7A== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + + +## Request + +

Path Parameters

+ +lifecycle-state + +
Schema
    emailNotificationOption object
    accountActions object[]
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-non-employee-approval.api.mdx b/docs/api/beta/list-non-employee-approval.api.mdx new file mode 100644 index 000000000..5d2f38e55 --- /dev/null +++ b/docs/api/beta/list-non-employee-approval.api.mdx @@ -0,0 +1,87 @@ +--- +id: list-non-employee-approval +sidebar_label: Get List of Non-Employee Approval Requests +hide_title: true +hide_table_of_contents: true +api: eJztHGlz4kb2r3QpH5KhLAzY+KBqa4vB2EvCGBbweGc9LqeRGuhESIpaGg/r8n/f9163Dg5jx5nNZhK+2KKP1+8+Wt16sIJQRDyWgd9xrYblSRVfBn57HnrBQohmGEbBJ+5Ze5YSThLJeGE1bh6sKyWiVuDH4nPcTOIZtFnS9Ru+8OaNSHDXun283bNiPlXYBQDtFCLryolwFo4n2Dvu86mYCz+2YLArlBPJEDEBPEYzqdhUxIpxhjixYMJ8ACNSMNxgxiLxSyJUrMqAY8gjPhexiBRhKRES9EYL6BOfOcwV0MKdasWtVbh9clgVdlUcu/ZJ9eTQPqi5NVGrOZXq8SlM8AEUjDbwhWtPggj54MzEnFuNBytehDhAxZH0p9bjOgmCSReoA6YxmMvuZ8GcxdBqQLJ7rticu6LMSnNRYtJ3pcNjoWgQcDuCySwBViNtOElGAoQ04Z4Sj3sr9Bl0PTmXsbWKyzv+mfnJfCwiZGQkVOIBa+MAHuMk8ssf/SHw9Ob9AWv2O2wYc9/lkctagecJB2Gwfsba2+9mcRyqxv6+Kz4JD/WnrLj0wkD6cdkJ5vugCvs8lPvKwLGdDI6di+gNMWUeRMAmHx7npIUbSC3IrlavbJAArCumAoWjweimgxo0zKUv58ncasC8Of+snwmKKyYcuEC/Hp/iZjCZKLHOzh41A9rAQZTVJPE8w1UGHWV2pRLueQumQuHIiRQuu5fxjJVIOiVkfMin0gdhw/woSKYzoxgkmK9GHL9BGBn7n2a+EyT+Ou87E1aKowTtBSxIAuPDIEw8zUrBSv+yR0HMPbuFs0vI0jDwlWAzcEug/iQHHLjBHGYcIAaJ57KxMJYBkpOTTG7AP1bSOlFi9wJZNfWBYy5IDGQmfSczbnAJ4LpiRIURIczhPpvxT+C6GMiImIPj5TzkTryH1IDLiwRIDFyiCwv7QYyaogSuWiIgfyPKS4gTYQsOMBGaCzga0AZ3YbD5KjQI6dmgROMg8AT3rYKeaK+3pisFt24iAhAbJ4qJX9hHq9++POtcXny0cq2aSI8CxK/w5Oc0JdOTRKFwUYdSfjC18GNwsXraGJXG/52Z/42mCzCzDZ5vUAvO01ZULpWEYRBBKCNBkeMCUME9doOT8lxFGq4zgiBSDYRQKi0ztlRqsJL4pWRtEYUDOQAskzNd4bJbmV5wF2gB3FYCiUMoa/IYArQ/uDSQ4FVZDHXbyyTRQJPXbNwDm3IpipSA67doTtqnKWRjrVLBf8sc6pqUKcuSZCzmlCI5mLWBW4Up0OlhwgFT9n9SOO9hXTw8ijgKlwDQLM/rTSi9MiOC8U9AP2ZfEfIrlhov6W4V8tVV52zNty8liku4Qya1pGE1pyoOTk7GkL7V6/bhGLI5Pq479snp8aRaqxxW66cOKo4GAuFojUUDMQEHjh7YBHGuVOBIZDjrmLQNltxOpO5dJ1P4GOZurGar1bu6HN21eoNBu9scdXqX8Hx53rmAQdDZHg7v+oPeeafbzhsG7X9etYeju2Yfut43u7oH4eBTv9/ttAgS/Go13/WbnYvi4x0AG7UH2NIejDrnhcHdq6Hp6V1etluj3uBu2PpH+10TmtqXo86o237XplUueu/bg8vmZat9dzHoXfWhqXNGQz4UHguoZ00GeWjqds7brQ+tbvtuOGqOcFC/ORxe9wZnd/0e0ICQBj2aPbiif8NeoWvYuxq0sHXUvNB/74CS9kVv8IF+Dn+AtYZXXVxq0O73BqP8NwJ63+l1U8pTMTRbo857TQPg8YMmba32aPoM5WfKIjQjVA8UscIfZ6Ne0YAxoQD/gkNStbkM7jECRhz0IXEgjRDlJeUtsBKGU9NZHIxQh0BlNxvOShKU1hUrZlGvHp1UqnX3oDY5Oa04vFo/qdac0+pJ5eSgDtWNBQE0WzMFklnCNZDSIX/LHUo3Lsl7P4fMIK2Q8nLHzGfk/osIQnUTl01vbp9pbNlqSmQN7TMS9/egvfRoAjw8XfZQAZpnH8gWQHO7XRixJtw2gIPYEYIPRVxN6FgqLdPyLHNASiOXc665jHWBjl7kamdjyNBZ5hrLUgAsoPEFDlUf9yydAsbPc94MzD09wIL5abjY6oBd8HR2LEk+y1CvZ8Jfq1M9UOYsDi2rc61SPbUrJ3btYFQ9adRrjfppuXpU+zeikmYCXxATA3IbDoeVxkG9fHyMOBQUfsPGRgdiy1uuBGUz2329n882Gl+g6n8VBFPCJdD7uJdtRkTPL70LTbvQ9KcLTQWAGR4FlBE/ywA9OqoeHY3r40qlCk/HzkFNTA6q/Ogor0quoW6WfM6GUNzPYP3NrsIYexfSUBxz+6w/wVEI63BTZt7yJHrsdhRB4m+zQWGXoejoxoG7wEJB+gBUuq/J3J/wC66IoaBpBe4LIvu59IU9jbhEDAWh7MBEhrRKF4MnVfsaZKqNNG5Zq4AT5Sp7y11mmMlahhhkecSdnwFW5wXKdeVLmM/SKaBjWQG1YVlxLPj4qHJaO5wcHXJeOzmsHtfHpxN+cFA5rZ+eUqwUSvFp0WVmJc/y0hfCh0LaYV7ggET+AwyBOAS8JwRo8WKVtF0GBOMF/MctZD02I9Pgy3DrfY9x9rbVZ4fHEJ79aULtfLrCBN++GqLOJ57Hx+meC1CuAfciOZX+tkBx1j5vpr7MOFCEtck3mR3sgLbVZuBq4pwADN1KYKkMsZuVDNQSEMR9VRwo9S+1UFj3mf0fmGFW3zCjCJpNopVddke/p2DfybIo77ExtkH4dWZsDIHfZYH2kKWm44gwtruGkyWzY/imzJquK5FIyNdoww137Re42cZdV+8u6E1gdKfkdIMkxv046ax415yVy9LIXUq3KBQ0DsD8eT1pgicH5IjMohVm2mJQTN8wuIZzy9iNVhIt2kZxgAraynaCKAIOszHQJmPFjDui3QxwPH46LvNYRXdK7u6dRgbiCfU5PFEvsLu+B+7HJtKyjk/CGB+9w9DeiKSRisl4JFPZ02QzKhNXavh6v2Vnuzvb3dnuC213tXNg9iNNL6U+1fXU58rnCfA3ouC5lvpEpD1+wNJBOsXVgtyDQjlNkb6/HoFh/wyVIYwXn0N8sfAF8yMdyteQb2byMNvK6dZBGvpzWSCCxEdNwQQ8kXAbhHeOsU4SiVUH66udB9FYgoL6G1JEfCHMFkHCOLAsSnyfXjWpPeYGQvnfxuYlE1iEUtoD4qq+a+tN7F0mucskd9FoF43+NNFol0nubHdnu1+n7W7NJDOsyFpMnqSS+ZxHC7MXqvvp/QeDAflpn8zkSFSr2QoCY1mOZS1nDta4Vh1XJ8eOOHT5oXt0cDqpOUc1Xj+uHlfHh7Vjqxjrb3I7zoxs2aYK8tZyJBZDEvcJ8rjEB+VScRC4y9t/CR5wmKBbQ9eT5c3Ac2DpbZY71k7Xc8dREODRykWaIamlHNLPeYQ+DcbOcWx6ihIHcDYFv+jjKSUJeKEqybkAKHgcg9FRKDRepALgRgu7OcHjMeaAlUzf2JhVpO94CWBInsALMGsOQLEknlaaYM4HECiDnYJ3/oLZqRHRb8rk2QAp7iLFrP3ZEQINPcvc65v2dzuAfIQ+YqgF/MRGr652uA8KAAWB9llZ3rnLz3f5+S7G72L8nyPG7/Lzne3ubPfrtN1fkZ+bbOjp/BwGvDg/h7HlCstyqXM6Av57p+lkKgYDUm8WOHQrx81zcMorQJUQoSndFAk53oey9otHyuz0eBidgKbEUOOURB6MTc8cP4CoQESPZR7KcnqWzg/u6eDxGPizwfXgGQFtZjiAjjjrBcrE3Eii/mpnR8A1q82Zeis727wVMh6XQBkuggTcG4HZw0MnRpeoGVAMoZD4VtHoMunOGn1A11XkPf52WjSgJ2jZxL6tq8F4BpiukGgOe6T33oaYdevV126/5ZEEK7Xa2mI9HFZjbwWPoCTQLy+++/569IZNMdckW9fn2IXE4gCspQ8qQr6smW7k4yQKL/l9oebSqxK0HTbxgGBmrn8UT/0MwCsTS3GSIEeAs15+4p0vzXvissdH32ZnMtIH4hWNMSTqCzE3YUoXL9D1WiS+SaHZGppN0PC0/RIWmrU3jj5644ABIwiwRuLWqxfX8OwCPKygoAWhruKAnDB4LL/gclKpvRqPJXg2wlvG46N/PZMQSJenMe23mJrRjacOc2ZBoMTfGUPVQTO4mSZgRa9G6x4Xtcki7FqlgJKtl7SlDWkh4dcFw/C1MvExhmXKSgJI2HxXm+SPJFmw+R/pisqPSzRT8w1ETxzpBs6vuMaxgjMuaOOCtvYByuCvgxMqFtg20kB+QCtAK5c/eQKDaMHvaVgbvTqB36c5GBocQJWgqLChfzRyB2eeGHXg6GwMuGHMqrNXfvCbGVgYoZaYle4HrHJwHV8vgMC4wjeNb7YfhcHyj0YvUtzMt016vrf40l76CU/yx/G7/yePt/M0f0ZPY/JcVDdaduWMLir5W5OvrW/jKbqWC3+hl2yVUmooWPKbuEVAocdj1GqyamcmBW0AhILHmPvtoWYFc7JESKjR/KHMI0BTuhUQAcocSjbpATzaok5X5mQwOrFEueJvlVAVgms5MygoRZldQ03mOyAWrMfwkAX0/RSYwmwIkumjYNlZKmxIuubzxDdX/JM546BSz2iEK5WTaMcF5ZkvUl4ElPpls1IrRlVDEspUmURz1Zvg3jKUrQXBP7MWyF2ZjWVgPd1m0Eegc0IGwiPNxHHLaftzsEHb7JnwQqwIwetCAiYKK7zrjNYgAjBfAV1QeQfRdN9MUvs4FoBgeaTV56BcLVdsKhegPQxUDDVsAfiFiFl613Hp3kR2wSZ9CbKqmQ/5LvsrPzZhgglWAfshbl0hiomuSnQReGM9UQRCWTEL8P7IjfXwgPsbWBU9YrO+S4ulIXAXVT6/M70F/S/6oYmNdP0ssKRf/RaGKd4tuj3zcoS/rq9RbOFH+rGNV/Lhr/UZiS18zD6z8UpG7r4J8fV9E2KLOqQf/nilNuw+17Dpcw1bOZ5/FOOVPP8rf5JhK2fzL1/knL3NdzMh1N/CWO2IKO7rafo1R2HW2kEAhJJtPV+0McniT5S55gGXenz8LzQlXdE= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get List of Non-Employee Approval Requests

+ + + + + +This gets a list of non-employee approval requests. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-non-employee-records.api.mdx b/docs/api/beta/list-non-employee-records.api.mdx new file mode 100644 index 000000000..e923501f5 --- /dev/null +++ b/docs/api/beta/list-non-employee-records.api.mdx @@ -0,0 +1,87 @@ +--- +id: list-non-employee-records +sidebar_label: List Non-Employee Records +hide_title: true +hide_table_of_contents: true +api: eJztW+tz2zYS/1cw7IcmGlGW5FesmZs7xXY67jiNz4/LzTmeKURCElISYAAyjs7j//12FyBFSvIzuV7TUz+kMgksfvveBYGbQGfC8FxqdRQHgyCRNv9Fq8M0S/RMiFMRaRPboB1YERVG5rNgcHkTXFhh9rXKxZd8WORTeBbIWA2USNKBETwOrm6v2kHOJxZfAb2wJMiO5VhEsygR7C1XfCJSofIABsfCRkZmCARgnE+lZRORW8YZQmJ6zBSQESUZ44B1AFnGDU9FLowlbBLnfyqEmcE7BW+Iq1TmweIib/kXpop0JAySN8IWCSyYa/iZF0Z1PqgzWOnyH5tseHLEznKuYm5itq+TRERIg51US1+9mOZ5ZgcbG7H4LBIUasdymWRaqrwT6XQDBLTBM7lhPZ0wquiEcxZesrE2LNVGMKngZ0qqQTaN+FRII0BJY55Y0Q7EFw7SAPb6213QTzQVKQ8GN0E+y5BnWFdMhIGZjox7tNmHB6lUMi3SYADzUv7F/SYqsRhzkAL9dXvbXi1NPR5bsSzOd/QYYIME86lg4yJJvFQZvOiwC1vwJJkxm4lIjqWI2bXMp6xF2mmh4DM+kYrnAuYbXUymRMcr5rtRx1cooxL/3cKPdKGWZX80Zq3cFKLFZA5SBcFnOisSJ0rBWv8Mz3XOk3AfZ7dQpJlWVrApOCuYP+kBB65whykHirpIYjYS3jNAc3Jc6Q3kx1rOJlrsWqCoJgokFoPGQGdSRTgP2LC5VBNw6ByhMGKERVyxKf8s4DHoiISD42Wa8ShvIzcQCNDZUwgUMSysdI6WYgWu2iIifyHOW4iJ0H7mSSGcFHA0wC5siea7sCDkZ4URjbROBFdBzU5o5rKtLJH2xmO1oTi5grjNDWinbqAocx5agbzkQOu2hjDgEYn+F6DbtrowkYD0sWiVZ7BcZUiFRe2jkZUCY3amcojBbtIIrUr9ztr5ASUCuEKP8iUZiXuGlmeLLEOZxaRFimpARl/ja4hgSWwHYIUybrO6QFgpkTZLKcmZNow21r9NePkLVCCTNsumWuGsnJv8AGQNL1TsfkSQTmF5IKRjipmtVnBXaBjLxGt3Sf93qbuh0xI1E5/Yh6Af7fVedV9t77yKtvt70U63B78ivjPe60a9zd7mh2BJ328IwB9c405Kizp/Uz59nNYp6LnKSRs7QAqtVim/VguMQnwCRV2hKlyotSj8freL/2tKrVEeubqG6dFHQI6qjLDMgogP03iWJTKi+LHx0eLcm2XFcmM42oTMRWprzx1FLJcM4s6lQyTje2PAxcXRwZKaVwGWcQeNqeYFq+g26Zy6pIBWEAOLUFyWXsTQoolg5TYPk6vD+tE6h/OE6lb+HvKC5CkSLx3xybRx4grSZ5APp+RT6NdPpkqzmhSvHdiORcp/88/R2nEVChtPXoVmNVfZrv5Dsj5kPUz4HByjVNjRARYNHHOvrOmTMrXB9I6VBLhWvYgHMH6tJpyPHADGWiCYKrc8lU03keyyTvuhqIZrxjznqzyHx7HExXhy0vChpZDaBDbM4cWogFJslOjRxohPKKzwhizI2KsEcK9PAjwR5hLM9l7HdJSxvXKJheG8BWF0e3th91XY3zzvvRps9wfbe53eTv9fZMIuA31jJFi1rcLR796Fo8x7zwTyfiqU7yIo2LBr7t23JPx4kfhc/C2ReJL3YdjqDja3O7u7iAFAgFvRoKUmHd7e4oCtVTlmP5Eo/kNjwPJCdlor4+uQRjqeYQKUivy484z8c0eeiUUOwW1fx48IWG+kEuHEcIkIBUGOYCIDip9ljEmYymlHEsMOskDjmnIESXR67DWPmc80bN8zg3I0PPoNaD0mtFwoCfNZOQWCSlUYrFhW7Ao+2unu9bfGO1uc919t9Xa3R3tjvrnZ3dve2yOrFtZC4LMrEndz6Z+EgrIkYomOQCP/BoGAxYDsCQAt/vhcTzQeIX+M625sxabHy3DHB2pd9nr/hG3tgiOpSUHP+WRBCCq8OMPStEgSPiqbGsy5RPidkROpVkERCnvhy+Dg8M3w4vgcnpwe/v3i8Ax+Ia2lnaKhAmuN0Sw19a1TfU2IPQPoZFZgGQhexlqeagsY4srWB0r3l51BQZIy32DBDL/6ihl10mxsdNpwpchtj7EXsiM6bWhCMeTwPJqyEYdulGkXDFrDKBJZHh57SbZ8S/6yw4ZVunEdLWbLGXazkIdc5ex2WcCVBXXwusix4ZXRQnidi7KpjXkwOa4rBZ0DkD9sJ8MoLwAcsVn3wspaPESvH8DsJNdEd74QEqlFgKo9or0iiGxQYUJkAt4k9BQ+HFGVDoFHleOqiFWPkRTu3jowB7mmdxEv7CP87iSB8BMSa9WLz8I7H20SumhE2ijV5COS3/+iyX5Upa7S8V0fsfbdte+uffeRvrv48tR31v4tlT695dLnQvEC5GsoeS6VPoasR2lWDqLyxiuyzUAgvkT6+f05OPZvUMPBePElw+2Vb1gfuVS+BH5Y6cNvmZQ7KmXqn+sCAZIcHQdjiEQiHhDuOWJXJJKoNpdXe6PNSIKBqhUlIkRNw2a6YBxEZgqlaC/Xthk0alb9mPtdXPAIa10ExFVVHLoNmnUlua4k19lonY3+NNloXUmufXftu9+n795bSVaoyFt8nWSLNOVm5izNv3cb3jBg/jm9cjlS1WK1gsRYVWMFzcohGPV7o954NxJbMd+Kdzb3xv1op8+3d3u7vdFWfzeo5/rLuR9XTtb0qZq+nR5JxLQZb1ihwLhsrnXc3P4r8HPtGMMahp6qbgaZg0ivqtqxv7dcO55rjSd6ZmWFZBs1pJrLCGMajE1xrCnHwgDOJhAXFR4DkIALTUmmAqjg12dGZw3QeZELoGtm4XCMHxv9CQZZ7q36VaSKkgIQUiRINFbNGgxL4nGAMdZ8QIEq2AlE529YnXoVfVUlz06R42PkmB1+iYRAR68q9+1V+7tHAN5gjDhzCr5jo9d1O1yBAUBD4GJWVXeu6/N1fb7O8esc/+fI8ev6fO27a9/9Pn33CfW5r4burs9hwKPrcxjb6bKqlnpDZyx/7zKdXMUjIPNmOooKQ9vNZQ1OdQWYEgKa0FHsjOMx/GCjfqYkNLXT+1gWOkSFSWBkeZruBhQFCrrt8Ex2ynM7Sl/TkboRSGdF4METAs7JcAAd3nMLdEi0RqL1ulBHxJ2g/ZHVoDq1dy9lPF2FGpzpAoIbkWkzsHRvSfQYIGbQRvxoy/NidBJ2gT/g68Ikt1/PiyN0By+rxHfvajCeAdIFFpGFq/llizOsud3qS1cu5nkE+7T+0mLvcFifvRbcQEPgPl28+Pn9+Us2wUqTPN2d0BQSWwPwlRMwEYpkw3IbHydRcpkfxx82PpSg57BxAgwzf7r6yAvhFwjxpxCTSaQ4SVAYwFmPP8vJG/PuOEv9QYXsQBp31NPSGM+iO29+mZV88RpfzwXxQ0ktdNRCooanSBsonGgvI3fwJgL3RRI8sSStZy/u6IU1etg/wROkuogBJeFxND9vRaXWno2jQS9Eek0cH9T7qYQ02pzGXNRidkoXCo5YNNXair8yhqaDbnA5KcCLng3rGhcNySPCfrcGKXRLhjKEopDwHYNjKGdMfIRJmWoSDeWaip1L/kqaBZ//lY77/trgmR5fQu7EkbGOnnBAeQEzLhjigqGLAdbjd6kJDQsPmAEPFAecAezP9U+RwAOtxT1Ha2VUJ/IbNAdTQwRQiYrNBu6PwTzA+V+MXuDoagyE4YDuAfgPfvA387QwPzWEVe4GLEpwGW+iIS0uyM3hrXajMFX+0fhFjofzTZN3Kpl96yh9RyT548Td/1HEW0eaP2Ok8VUumhst69uBupG/9vXa8iaepVtv8C+8JV+lghralflFtzqhLOE5WjV5dTSVgtr/TPAca782WpZOyROhU0f3hyaPCE3o9K4ByBwaNpkAPdqgLlfm5DCusES94t+2oB4E14qm0E6KDnsPHZmKQC3YjeERC3j3Ufu27Aw0c4KKZQelsqHoStNC4fl6gF2kjINJPWARsbRR4QIXNGdKlLLQVPpVs0ovRlNDFjrUl5jUvhvjzjI0rTXFP7AW6L28wAKiRy36e0pzRk5FQpaJ45pl+0O0wdrCqUgyusYBsKC7q63w9uh8iSIQU+5SQEebyYafZDdwLBDB9siZz2an1+mG1C7gJQttc+hga8SP8T5y44D7/JZ0wxBv5lvqT7rQ7DMGlvobGe5OIY7CtR6uz7sMVvZ50DlMAS6+v7nBDQxsfG7xsbspht0fCBCten417E7I39f16JVC+03glkB5+9s3/QFdoHu8HP6/7jXfI8fq3vczBbm+pPz9XVK+xxzKm+jPtIb15eD/yuXge1U2v//9TKWtb/g2b/jeK+35fey5tK/mm4qQjq9grItulJvdNPetoTZr6Ws8Uqn2f386xFqH39Ft+h+41O3tfwBABIdk +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

List Non-Employee Records

+ + + + + +This gets a list of non-employee records. + +## Request + +

Query Parameters

+ +Non-Employee record objects + +
Schema
  • Array [
    • data object
    + +Attribute blob/bag for a non-employee. + +
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-non-employee-requests.api.mdx b/docs/api/beta/list-non-employee-requests.api.mdx new file mode 100644 index 000000000..8684dbe64 --- /dev/null +++ b/docs/api/beta/list-non-employee-requests.api.mdx @@ -0,0 +1,95 @@ +--- +id: list-non-employee-requests +sidebar_label: List Non-Employee Requests +hide_title: true +hide_table_of_contents: true +api: eJztPGuT2kiSf6VC+2HGRIvm2Q8iLm4xTfuYxQ0HtH1zbUdPIRVQM0LFqKSxOUf/98vMKgkJ6Id7emfHszgctlBV5TuzMuuhL45aiYjHUoU932k5gdTxlQq7y1Wg1kKMxK+J0LF2jhwtvCSS8dpp3XxxrrWIOiqMxee4ncQLeOdIP2yFIli2IsF95+PdxyMn5nONTQDQTSGyvpwJb+0Fgr3lIZ+LpQhjBzr7QnuRXCElQMdkITWbi1gzzpAmpmYsBDAiBRNZyspA2opHfCliEWkiTiIAaI3W0BZCC/G1lLGzjeUt/8zCZDkVEcKPhE4CwBgreIyTKCx/CMeA6uZdnbWHPTaOeejzyGcdFQTCQxhsmKH++P0ijle6dXzsi99EgGItay6DlZJhXPbU8hgkdMxX8lhbOK6XwXE3LLxiMxWxpYoEkyE8Lkk5yCayLCMBaprxQIsjR3zmIA5gr9asgIK8hVhyp/XFidcr5BnwirmIYKQBY17Va/BiKUO5TJZOC8Yt+WfzTFB8MeMgBfp1d3e0X5pqNtNiV5wDeg1kgwTjhWCzJAisVBk0lNm1TngQrJleCU/OpPDZJxkvWIm0U0LBr/hchjwWMD5SyXxBcKxivhl1/A5lZOK/X/ieSsJd2fdmrBRHiSgxGYNUQfArtUoCI0rBSv/jTlTMA7eDo0so0pUKtWAL8FYwf9IDdtzjDgsOEFUS+GwqrGeA5uQs0xvIj5WMTZTYJ4GimocgMR80BjqToZf5qwzn4NExksKIEebxkC34bwJeg45IONhfLlfci4+QG4gEkQCNQaTwAXGoYrQULRBriYD8B3FeQpqI2t94kAgjBewNZCc6peabsCDkZ48RTZUKBA+dnJ3QyHttxUpd+C4gLmC8B4OOI1CRc5ejxQFIu+EZmPEhcsOEQOx9Wqil9VXCyD5xzZZgWmVWWqJRhr70wBg1dYKZJILBqJWo7NxHvFYRxfQ9grqP7px3ocFwVwtUBAigyBJfrSIFVgIWECf6aCYjmPb4HkbHQEPmCYlG80UGUo0zvQ5jmETMoCm6RfgHm9ffUExAl2upfEVWbt6h6+hktUJB+qQnCssARn3CZgjBga9b6EYwa0OfI7YlGZaJ5ogFPH0C2cvgiK0WKoRf3CMnNE1AbBRfACzoFfr4UCrdq+GZDL5WwwU1apVEnuj5TPzKPjg177x6Vjlrnpx5zdq5d1KpwpPHT2bnFa9ar9Y/ODvqvSQC/uQKNlLaVvFl+vZpSqYgbXI9FekWQiiVUvmVSmAD4ldQ1EdUhZkaNAq/Vqngf0Wp9R9IyJia/gwsUF7mYYYIcxUAALMKMAAAgOOfNUL5sqtiHkUcrUPGYknYIVkYzCinsz0McEz5IuQlloZK6T8YCq6vexc7qi8kpUYQENKQ7FyYqNQr9ZOzmtsUDe42GrNTd+p7NffEEyfVaq3ZOPeqaJGpHPdRsR1PCBGYLNdaeRKdLp18QY8FiRqoRYoes3GkxjjXEynBzs+kZSRiMGfEWID8RMS5l8/EvwvIgYnQgTmJmnNljOnZB7uiUPSwMeXC2ePMjNIJdjMd2vEk2SLBmJBIvixryJoWKLfNvPMoory5fqdNWN6D4r1BgcDTcP3VsHHgHtDjlGqK/l8NlUY9II+/2/cYGRELTS5fjYVGFbE0sz8IdklFZ/Q4YExxUlX2LjDcccwrZU7TlIVGmLrqXZP9DvMfwlUk52cOBPpKkKdum2iOrEOoO4S63xvqHJ/HfJ9Ncd+XCIUHw4J17eRaRX7aMTRME6gpp4GaHk/5nPINXmAAE/oswe6lU/n+DCLtxnDKz3IXm0oAnfclBv9kHymSBeCKdlkV9bOzqVsVzabbmFa4y6dNzz07P51Va5VGtXnubURgQs32pDGDIhmrXLtQkjOKng0uG+bvYdK07rIpQlxKuHHanc7g+mpy2xmMRt1+e9IbXMHz1WXvDXSCxu54fDscDS57/e7mxaj739fd8eS2PYSmd+2+aUE4+DQc9nsdggS/Ou23w3bvTf7xFoBNuiN80x1Nepe5zv3rsW0ZXF11O5PB6Hbc+a/u2za86l5NepN+922XsLwZvOuOrtpXne7tm9HgegivehfU5cfcY4707JUlHl71e5fdzo+dfvd2PGlPsNOwPR6/H4wubocD4AEhjQY0enRN/40Huabx4HrUwbeT9hvz7y1w0n0zGP1IP8f/AFzj6z6iGnWHg9Fk8xsBvesN+innqRranUnvneEB6PiHYW1n2bMdMtSfXZFFD0HzQBVr/HExGeRzfQwgUI5gl9RsrtQnXGWIYAqPEi9Ooq1AkhNlGjwuYjVBGwKT3e84WwtN6ey35RZNCM+VatOv12ZnEKF5tXlWtSG83vRrohCwUiCZJ7wHVnpUpL9k+lUgMIaOZduaD1Gm0n3Qlcgbuhek7h/Aeulx2L266F2hgVwN0ADaFz+SL4Dl9vvQY0e5XQAHsW0FBRbSaivNvUVUFoC0IW4juXaR6hwfg8gv5DVmJW9HZCkApqh/TkLVuyPHLLPFj0vedtwEcYCF6ZXyaWH3wQAMs5JwY7lnueX9QoQ7y0iUj6aAt3KESvXcrZy5tfqketZq1lrN83L1pPa/SIpd0nhJSizIh2hoVFr1Zvn0FGnYP0O3c1Pja66NY/xVjPE59pMuUkYWAIgVO+Ha0Ysqz0AWwTq12B1F1ipupe7WGpNqtQV/G9VytQ66bbYqFcp907WtZ5JVyDGMmEkGBJfhuHsJqlRa9HdDjF1de2FScFF9LyFVIqS5h5A/3OUf0dIf5/cPEnJHO6C77m+nLOyAjt/Yt8DWCSQqoxtFkBG7bJTbc8mTNlX+Glf/ZEiF6XOW3O5JLn2qdzrKf8IcfClD4c4jLpFCQSR7MJChi0kfIwvtfRiQaUpD/YryBEmUq+w195kVEetYZjCORtz7BWA9pfC8DiWMZ+kQSA2yymIPWnEq+PSkcl5rzE4anNfOGtXT5vR8xuv1ynnz/JxMXGgNlXw+LqclSRH1GxGKSHosUB5o5P9AIGA5IHsigJA/vYohGE+QPy5UmL4Zm5ZehvvzR1Ceve4MWeMUvCqcJ/Sez7eEELrXY3gTJkHAp+kOFC4iEeBBJOdyb72bzkoX3ct2mhDbLBxh7Utw7VaQok3GBeSr8YYBdDYtcA0cvI2VLNQSMMRDne8ozS+91lih2d0wGGGx7xmRB81m0dZ2lWcOM7DvZVmUj9gU30Go8BZsClO0z5QJCqW254lV7PatJEt2//RVmbWzktpsP+Lyzxq3HqHWNtsGZkscc3LK3FUS4+6k3K71N6IsamMTTfp5paBzAOWP20kbygEgjtjMe2FmLZbEdKvOt5IrUjfZCo20P+IBF7Sx76koAgmzKfAmY81sOKItCgg8Ydovi1j5HInC3VtDDBQl1ObxRD/B74YBhB+XWMsafhPW+ehEh4lGpI1UTTYi2RqcBttembpSxzebKAffPfjuwXef6LvbjSO7rWhbKfWp7qY+1yFPQL4RTZ47qU9E1hMqlnYy6yRGkUdQ0qYp0g/vJ+DYv0AuB/3F5xXuLb9gfmSm8h3i25k+7H5xWlelU/9GF0ggydFwMINIJPwW0b2h2CSJJKr6LrZLFU0lGGi4J0XEkxVsrRLGQWRREoZ08EYfMV8JHX4X2yM34BFamwiIWEPfNbvTh0zykEkeZqPDbPSXmY0OmeTBdw+++2367oOZZEYVeYvNk3SyXPJobSzNtpsTHNBhc/Y5czlS1Xa2gsBYlmM5xczBmdaq0+rs1BMNnzf8k/r5rOad1HjztHpanTZqp05+rr/Z+HHmZEWfyunb6JFETKdLIpaEYFw6VsovLv8leDR1hmENQ0+WN4PMQaQfs9yxdr6bO06UwvsX6zRD0oUcMtzICGMa9F1i3/TOBXbgbA5xMcQz2xLoQlOSSwFQ8LQto4Ph6LzIBcCN1m57hict7XFzma6xWiwy9IIEKKRIECjMmhUYlsSz2zPM+QACZbBziM4vmJ1aFf2uTJ6NkOM+csy6nz0h0NGzzL25b323B8RHGCPGRsH3LPSaaoeHYABQEJiYleWdh/z8kJ8f5vjDHP/XmOMP+fnBdw+++2367lfk5zYbuj8/hw5Pzs+hb7nCslzqki7E/dFpOrmKpYDMmymPrrf5mxyc8gowJSRoTvdmVxwvTTvH+fM2bppeO3jZGvNCQ1ISBdA1vUv0BTQFGror85Usp4feQvWJLhRNQTx7Ig8eETBehh3o6pJBUCbZRhLN18Q6Am4kbS8YOtmdpQch0+FqUOFaJRDdCMwRHly0pkSv8QQO1BHfaXu74I7uLW7xB3xdR8Hd7+fFALqHl33iexAb9GdA6RaL9phHejd+jEm3wb5zQ34zkWChVttBNsBuNfZa8AgqArN38f0P7yev2BxTTXJ1cz9NSKwNwFmGYCIUytrpOj4Ootllc3m6XdgpQddhswAYZvYubP7k6AiCMokUBwmKAzjq6TfZeGHcPTdfP4Quu5CRueimqY9l0dwOvlmlfPEcX88l4m8pNNdAcwka3qErUGFEe+OZkzce+C+C4IEmaT0buYHn5uBhAQVvEOo2DSgJS0dxf8tLtfZsOgrwXIRXpOND+H4hYR4tDmMmbDG9oOvfPeYtlNLiPxlD00E3uJkn4EXPJusTInXJI9xaJUeSa1C60oWskOjrg2OExpj4FGdlSkoU5Guhb1zyJ9Is+PxPdNnxpwLP9PoGJk/s6SvvK65nbtGMCF1E6JoYoC39Zm5Cw8KTZsADxQFjAJ2N/ikSWEJzcc/A2hvVCfwxjcGpwQNSCYpetcyP1ibA2SdGDdg76wNhGJPqbMcPfjMLiw6g5oWVLgdsS3CX3kDBvLglN0NvthyFc+WfjV/kuL1ZNRmEwfqlo/Q9keTPE3f/RRHvEGn+ipHGprloboR2654HGvlrm6/truJp+kYJ/Aut5KuUUUO9svksSR7QKuAxWjV5tbeQgur/leAx5n5HaFlqSZ4IpTq6P1R5BGhOx3gjIJlDxSYDgEcr1ClmTg5jEkvUK/7WCRUhiMtbQD0pyuw9lGShB2rBcgzPWEDbz8rWZWPQzBAVyy5SZUPStVwmof1URrJkHEzqEYvwpfYSE7igOgtFKgtFqV82KvViNDVkoUyFSbTUgxkuLUu8Ueo8ERfoXdt1ZRA9atF+pWHDyEgEZJnYr5i2PwYbrM1diGBFF5OBLCjvchje9iY7EAFYaK9Cqmh+bAfpY+wLQLA8MuZTL1fLFZfKBbw2rHQMJWwOON01LJx3z33Vaus6Z7ao/nUfoLJzBib7xytcoEJKElN8mFLvxtlf6kHxsACKscOXL7iIgbXPHb42n8rAAhBkiIa9+TbGvUR/W9+z2iu1XwQuC6Sf67KFv0PX9p8uh3+vD1E9IMfsQ13PFOThq1Lf3lelHjCH9NNhz7SG70f2Kz2vaF/3xT4A9SDN25+weibthw85vcSHnB7U1OZ7Xc/U0eFrTMWvMT0o7c23szbS/rhZAoXM4SP0NYGY0ggzzGyN5EbtHB5AKNly9ZsuZmb8ntrYPiCqu7v/BzRPTN4= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

List Non-Employee Requests

+ + + + + +This gets a list of non-employee requests. + +## Request + +

Query Parameters

+ +List of non-employee request objects. + +
Schema
  • Array [
    • nonEmployeeSource object
    data object
    + +Attribute blob/bag for a non-employee. + +
    approvalItems object[]
    + +List of approval item for the request + +
  • Array [
    • approver object
    + +Reference to the associated Identity + +
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-non-employee-sources.api.mdx b/docs/api/beta/list-non-employee-sources.api.mdx new file mode 100644 index 000000000..0d73f7676 --- /dev/null +++ b/docs/api/beta/list-non-employee-sources.api.mdx @@ -0,0 +1,91 @@ +--- +id: list-non-employee-sources +sidebar_label: List Non-Employee Sources +hide_title: true +hide_table_of_contents: true +api: eJztHGlz2zb2r2DYD000oqzD8jWzs6PKsletYml1JNt1My5EQhJbElQJ0o424/++7z2Ahw4rjpvpNl3lg0ORwMO7LwL8aIVLEfHYC2XXtS4s31PxTSg7wdIPV0KMwiRyhLLKlhJOEnnxyrq4/WhNlIjaoYzFh7iVxAu4Z3muvJDCDy4iwV3r/eP7shXzucJHAM9OAbKeNxPOyvEFe8Mln4tAyNiCwa5QTuQtERFAY7zwFJuLWDHOECUWzpgEMCIFozRiFcBsySMeiFhEinDzcP5viYhW8EzCE6Iq8GJrc5E3/AOTSTAVEYKPhEp8WDAO4TJOIln5SY5gpdu3DdYadNko5tLlkcvaoe8LB2GwQbb0+1eLOF6qi6MjV9wLH5laUdzzl6En44oTBkfAoCO+9I6UgWM7GRw7J+E1m4URC8JIME/CZUCiQTIj8VviRQKENOO+EmVLfODADSCv3qyCfJyFCLh18dGKV0ukGdYVcxHBTA1G32rU4UbgSS9IAusC5gX8g74mKK6YceAC/Xp8LO/mZjibKbHNzj7dBrSBg/FCsFni+4arDB5U2EQl3PdXTC2F48084bIHL16wEkmnhIxf8rkneSxgfhQm8wXBMYL5asTxO4SRsf9p5jthIrd5352xUhwlosS8GLgKjF+Gy8TXrBSs9C97HMbct9s4u4QsXYZSCbYAYwX1JzngwB3msOAAMUx8l02FsQyQnDfL5Ab8YyWtEyX2IJBVcwkcc0FiIDNPOjgPyFCxJ+dg0DGiwogQ5nDJFvxewG2QETEHx3vBkjtxGakBRxAJkBg4ChcWlmGMmqIErloiIH8jykuIE2F7z/1EaC7gaEA7USk2X4UGIT07lGgahr7g0iroCc3c1pUctAZldMdIQbg2IGIVFrTg8Y4FVRyBxKzHbe8MxLjguCEeEHkPizAwtkorsAeuWACqVWGlAJVSup4DyqhoEASSCCajVKKK9Vzki+7fTq0go8Cw8Eme7aRh5vM5KpOLkgI7BKVZCMAwMnoOSrkWdLTKcqVCx0PTIrPRkWgHHQZvFUYUm3YI/CmGF7wEKj63lUCFAsEhHbnUcIWyAwEXn2wSOIJ1MytOFJoeMj/VVqZWMoYAqCdN0aTlH2wa3yBrAC/bYPmaLFTfQ7NXyXKJzHNJxyikAJjwAR9D+PBddQEugJjADBfKRhxdt1SyMAdJPZ1CLterVfxvnU+9PekFC6e/ANqUZjiY74DSAQC+XPqozwDg6BeFUD5uy5JHEUc18GIR0OoQ+/ozSlHyKzNWL4O5TITcjD2Nr+fu1Y3JpHu5Jfa1ZEuTAbZaWbN2Xm1UGydndbspjrl9fDw7taeuU7dPHHFSq9Wbx+dODTUt5eUuLDaVjRbqurl1uGlUAUnu4O06RnXnvHZWPWuenDnN+rlzUq3BlcNPZudVp9aoNRAbbU/PxAQHvxCXoYhBmbc8xjMXLtx84frbgCzw8BY4W3q8lZ33QMPI++xXJlDaKLynLPkpE8iHlJ/U4v2L6KfbrBISM5xbq9Vu9yc347t2fzjs9Frjbv8Grm+uutcwCB52RqO7wbB/1e118hvDzj8nndH4rjWAR29bPf0E4eDVYNDrtgkS/Gq33gxa3evi5R0AG3eGeKczHHevCoN7k5F50r+56bTH/eHdqP2PzpsW3OrcjLvjXudNh1a57r/tDG9aN+3O3fWwPxnAre4lDfmxcFlAPbtlkIdbve5Vp/1ju9e5G41bYxw0aI1G7/rDy7tBH2hASMM+zR5O6L9Rv/Bo1J8M23h33LrWf++Aks51f/gj/Rz9AGuNJj1catgZ9Ifj/DcCetvt91LKUzG02uPuW00D4PGDJm2rGGtJhvIzZSIqCvpiFLHCH5fjftFXo6ZDKMEhXZMj3IQPmPxEHPQhcSCybmh8gZWpll/G4Rh1CBR/txfcyH/TbMRz1yA3wY9Ua023UZ+dgSvhteZZzfiaRtOtizXLSoEMxQyyWEhD3wEp4P1wDHco+Ouada8N6YGQ/ZiRB1M6mNLBlAqmFIQuVf97cxsXoqYde1SXrOP3biHkVq3hAz9YCngjtajWzu3qmV1vjGtnF836RfO8Ujup/xv5kebOXxATA3IfDsfVi0azcnqqcZB5PKfqHJGRie/zaV4KbnURtmuZvHJfSzCwdI5cUC7IRqAeTvNaqpNLa/Vgieox47fUGv71rbbF4yM1+J5KSZ6Rjuwie4vMPRhs5b376d+ZimWl235qUHfBpxGWj/ivbB3vqiTavodlbSeKoFyx2bDQKylqyTR0V1jeePKe+zo1/9za4gmeupS5tkP3GXnyFZS79jziHmIoCGUHJjLMAD0XSyzqWWiQqaOiceuqDZyo1Nh33AV6NX1tQwy6g4g7vwKs55QQE+nBfJZOAfeTlX07lhWngk9Pquf149nJMef1s+PaaXN6PuONRvW8eX6OqwdCKdTlHUXZ+tLXQorIc5gfOiCR/wBDwIiB94QALf78sE0wnsF/tFk9NiPT4MuwrV5mnH3XHrDjU/Btcp7QfT7fYIK0JyPsNKy5C6BcA+5H3tzbWbmkOcRl56qVhjkTWxHWrrBlWjghmdgColCcE4B+Twks8MHxsZKBWgKCuFTFgZ7+pVbgdAJmulgww6y+Y0YRNJtFG20mR7+DYK+8iqiU2RTvgZNwFmzKFUwItX8utRxHLGO7ZzhZMn3P1xXWcl0PieS+bhti22qFLUPuuronolvZGGnJc4RJjF1Fb7Nqy1m55byNX+kVhYLGAZh/Wk9aEOQBOSKzaIWZthgU0xabazi3jt14I0pR88cBKqghDy4S/CR4JqDNixUz7oh6MOB4ZDou81jFUE/u7o1GBlINeubwRD3D7gY+uB+bSMse3AtjfPQmRnsjkkYqJuORzEsGmmxGZeJKDV93iQ62e7Ddg+0+03Y3Hw5N/9Q8pdSntp36TCRPgL8RBc+t1Cci7ZEhSwfp6kcLssyAISZF+v7dGAz7V0irYbz4sMRu+RfMj3Qo30K+lcnDNMPTXnka+nNZIILER03BDDyRcC8I7xxjnSQSqxrbq12F0dQDBZU7UkTKwFdhwjiwLEqkpBdmqszcUCj5bWxelYFFKKU9IK4qXVu33g+Z5CGTPESjQzT6y0SjQyZ5sN2D7X6dtrs3k8ywImsxeZJKgoBHK9Mm18/plQqDAfmepczkSFSb2QoCY1mOZa1nDta0XpvWZqeOOHb5sXvSOJ/VnZM6b57WTmvT4/qpVYz1t7kdZ0a2blMFeWs5EoshibuHPC6RoFwqDkN3vf2X4LaMGbo1dD1Z3gw8B5a+z3LH+vl27jgOQ9w2uUozJLWWQ8qcR+jTYGyAY6N0rIcbWubgFyXutfIAL1QlLxAABXeXMNrQhcaLVADcaGW3ZjGQYraJeWm726ziScdPAEPyBH4oaTPNA/dwz9UMcz6AQBnsHLzzF8xOjYh+VybPhkhxDylmnQ+OEGjoWebe3NXf7QLyEfqIkRbwE41eXe1wCQoABYH2WVneecjPD/n5IcYfYvxfI8Yf8vOD7R5s9+u03c/Iz0029HR+DgOenZ/D2EqVZbnUFW1k/6PTdDIVgwGpNwsd2pbu5jk45RWgSojQnM67LDmedbKO1raiq8IRqeg+PYWURD6MTPdJfwRBgYAeK3zpVdKd8zJ8oM3SU+DODseDOwS0keEA2patF6gQayMPtVe7OgKuGW3OBVjZfuy9kGmXLEhwBTQwDaaMu5GMJtFtQHEJZcS3ikbTZonyFn1A1yTyH38/LRrQE7TsYt/e1WA8A0w3SDT7PdITbSPMufXqW+fa8jiCddr2rpM+Dquz7wSPoCDQry5eff9u/JrNMdMkS9d774VHBws4G4CKkCdrpW18nETBJT/z1Fp7UYKWw2Y+EMzMEZbidrAh+GRiKU4S5AZw1vN36fO1eU8cWPlJ2uzSi/QmfkVjDIn6UM/tMqWLF+h6KRLfpNBsDc0maHhCYA0LzdpbR2+8ccB8EQT3FXHrxYtreHYBHtZPcAehbuKAnDB4rL/eclKpvRiPNXg2wlvH4yf5buFBGF2fxrTXYmpBp7a6zFmEoRJ/ZwxVB83gdp6AFb0YrQdc1CaLsOvVAkq2XtL2bEgKCb8eGIbUysSnGJQpJwkhXZOuNsmfSbJg8z/TQbKf12im27cQO3GkGzqfcfRkA2dc0MYFbe0DlMFfhyZULNzzBzSQH9AK0M7lT57AIFrwexrWTq9O4I9oDoYGB1AlKGp5oX9c5A7OXDF6gKOzMeCGMafOXvjRHj4Ni3YlF5mVdgM2ObiNrx9CWNzgm8Y360ZhqPyz0YsUt/KmSV/6qy/tpZ/wJH8ev/s/8ngHT/NX9DQmy0V1o2U3Nm+jkn9n8rXtJp6io8XwF56SrVJCDeVKfpq4CGjp8xi1mqzaWXiCyv+l4DHmfmXUrDAgS4RKHc0fijwCNKcN1RGgzKFg83yARw3qdGVOBqMTS5Qr/lYJ1SC4lrOAclJU2DuoyKQDYsFqDLdYwLNfQlOWjUAyAxQsu0yFDUlXECTSnHBNAsZBpT6hEa6nnEQ7LijOpEh5EVLql81KrRhVDUmoUF0SBao/w84yFK0FwX9iLZC7Mm1lYD1trNbHTnNChsInzcRx62n7p2CDttkL4S+xHgSvCwmYKKzwpjveggjApNlVHUbzIzNJHeFYAILlkVafRqVWqdpULsD9ZahiqGALwOk4zdpZxvxTFBvH8rKW+md9NcJEDEz1j5bYnUI8El166Drv1tpZ50HlsAB08fnHj9jAwMLnEW/rg79Y/QEDUavzk75Povx1fYNiJ9N+FdgSSD+xYYp+i44APJ8P/18fj9jDx+zjGi9k5OFLEF/flyD2qEP6oYMXasOrofnmwGt6p/vFPtqwF+fNz0x8Gdy/6Mca9uK/80sTLyTi8BWGvazOP46R8/d93hKEYPoexmrfRJFVT9NvCgqztt6lI5Sse3vdwUyFP1Ermgtc6vHxv2kVEKk= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

List Non-Employee Sources

+ + + + + +This gets a list of non-employee sources. + +## Request + +

Query Parameters

+ +List of non-employee sources objects. + +
Schema
  • Array [
    • approvers object[]
    + +List of approvers + +
  • Array [
  • ]
    • accountManagers object[]
    + +List of account managers + +
  • Array [
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-notification-template-defaults.api.mdx b/docs/api/beta/list-notification-template-defaults.api.mdx new file mode 100644 index 000000000..fabd8357b --- /dev/null +++ b/docs/api/beta/list-notification-template-defaults.api.mdx @@ -0,0 +1,83 @@ +--- +id: list-notification-template-defaults +sidebar_label: List Notification Template Defaults +hide_title: true +hide_table_of_contents: true +api: eJztW2tz27gV/SsYbmZ24zHlZ+LaH9pRHHvrrR27fjTTsT1ZiIQkbEiAAcg4qsf/vecCIEVZsuI8Nt1slQ+xRAIX933PhYDbSBfC8FJqdZBGO1EmbflKl7IvE/fwXORFxkvxUvR5lZU2Wo5KPrDRzmXUHmaj6+UoFTYxsqDvoHQ+lJYROcvKoWCpJ8DKQNCyyoqU9bVhqk1omdkqGTJumci5zCzrG52zg1SoUpajV/qmAxasSCqDr2DjNrqwwuxqVYoPZbcqh8SaTNVOm2pcrxoHNuyOETyNru/AdsENz0UpjHXkJDH/rhJmhIUU3jit5LKM7kt4xD8wVeU9YZjuMyMsEWalxseyMqpzpc6EYJf/2mDdkwN2VnKVcpOyXZ1lIiEa7KRZ+vqnYVkWdmdlJRXvRUZG6VjIX2ipyk6i8xXItMILuWIDnThp6MRjEZ46jebaCCYVPuZOftKZEe8qaQSM3OeZFcuR+MChFIi3/mwVKk2GUHi0cxuVo4JkxrpiIAxmejL+0cY6HuRSybzKox3My/kH/9lRCep13+7ulmdrU/f7Vkyr89g9BtvQIHlMv8qyoFWGFx12YSueZSNmC5HAtPCeG1kO2ZKzzhIpvuADqWBmzDe6GgwdnWCY78YcX2CMRv0PK78vM+fqMxaxpZFqELVYid6KERPv2FWUZLpK3+RcwQRvbrR5+0Yipt7YKs+5GV1F0d19c+67hZqwqCxoO3vUGmN2pEqEkJ/Wgzml+sbm+cFrA5zFgc+nV+pK7ddPGVKYrYpCmzLkKueYIKVv6DWcMEstwxLMp1Ft7A5RWFqC5paWdtiSeLcMuZDVbpb8i1ykssqbd83zTCc8E+3nEWUn8FUgLQpLhlpfXaU/k4ruuixLKWhWnmW69xvkJoMnlCRVSRR4UWQhN678ZonM7bQ/cGM4eQ5Z2raee4p4URiSupSeOUg835nm+9BUPjiHNOR/DwhGHud9et6a59y+ZUdccUQPO6t64wVmLUf05q3nbTdrxWlaubAWqzI/p8OOKAn4L5blfMR6gvE09W7v8x2qhqDcIBQtchntHXUPDvH95O/Hr/bw9+zojP4/7O7+A3/P97r4ft2W1k8Ao96ZHseoH9t4d8031dNlxtmL3RO2ucUyrgaVe84HnQkVC0Ur2sp7xVxr/FtXbMjfC/bE183j/olQKUaRmSx7UuKP/4hkjjDGrJIyJ3ty++bNINM9nnXgdGmVlK9gqrvOTIECKw8aEn6D0sJ7xFJpKgHuh0ADSK8zmJ8c2hKGXtDqhREIJErkfsA0P544e8+zSlBGUfrGKb0MFSzYv6fTkc8oHXbQh9RJVqV1kVPIW7SipwKUdCPH1REEONtcXe2QIYjMfCucZIJbwQaahUpLaodLuiCZqVHH2py46Gtd/m7q88S/lfoIbs5X35PGFR1C3ceEbpqClp2pu6uIRuxcRRTtNOpT/NKIIhud66/M0ClRZecaPDmFfQpHE/TmcfUSrIxYKgcCxSkGglPQdL8FmHVVuurscIELepeCyBf1jcKYv7LVmQK0njyec7COBsLXhLqnKXVoa6I7+rccbc6qr7uZJN73jAF7MTt14J7Sdj/ASyAsiOj8D+4pFXxMpp3PKLgPFNZUlNDlrk4fkdD3pRLxwHBJHArHcoKJDBTfS6dqB0Y9yVp7btxkUqdwWGMveAp5vXy7QRhSpOHJW9CijvFjDF0oifmsnsLkGEfNWFZsCd57vrq9vtl/vsn5+l8217ae9bb7fGNjdfvZ9rYvwq5A2RlIZXLpnwW8SCa+wMn/QCFo+qB7x4Bb/PHg5tsW1PjibFbsecLHRg7k7OALuOHl3n734vAcT073/nmxd4ZPRGuqRe8qeGtKbqldRA6RWcuxADdowq0g1CyQU5cC1SUIxJVtD5T+mx1ZKLOORcwIq8+Y0SbtO/x2KCW+m2c/yY7oLAMo4RmanmTIepw2DbTP+EvdJBFFGR8GTS6FSvu0w5D/JAnJ64w/B3G5CoFk5PYhEjFpi7Eq71eyOpscto1CwQHOP+4n3aQECnY+MRGFjbcEFoN9wLPX3CR35y2lOZVSR4UmJ3F9cqKNIRzUg2wSLVhIR66pQeJR9bgmY7WTpEt3R54ZJEr3LuGVfUTcnWRIP7ETrXnxXoTgc9DOZyNnjdpMISPViIQmh1GNuerA90VrEbuL2F3E7iNj9/7L07CrEN466LM2DX0uFK+gX+OK5xT0MQGOs3qQgzfBkMsMCgkQ6ZfX5wjst0LRePGhoH2vr4iPfCmfsS9S2yPsMNUbUHXpH9uCGHR69BL0kYlEuuP4HnPsQaJT1cb0avva9CQcVM2AiMiaho3Q+3KozFRKESccXUiqhVU/lr4n5ogIa30GpFVVGvv9rAWSXCDJRTVaVKM/TTVaIMlF7C5i9/uM3blIsuHKRUvASfXvO87TwnuSlvZcN1j9+xZrQs6Z6j5aIWKswVjRJHKIeutrvbX+ViI2U76ZPt/Y7q8nz9f5s621rbXe5vpW1K71l+M4boJsMqZa9vZ29D8rCPMeOK5ScC5bap1Obv9BvUb0Ka1R6mlwM3QOlV432HF9exo7nmtNv1GNaoRkJzCkGuuIchrG5jTW1GPd9vUAeVExpCqp/XauzAWoGPoF0P0+TsFLUoCuGcXdPm2phx8mgpM1q4Stc+syQaYJNWs4loSQok+YDxQcgh0gO39FdBpM9EVInp2SxIckMdv7kAhBgd4g92ez9ncPwLyhHHHmDfzARq/vdriCA6Ah8DmrwZ0LfL7A54sav6jxf44av8Dni9hdxO73GbufgM8DGnoYn2PAo/E5xnZWWYOl9t3P6t8aprtQCRz4AwE6SSrjtptrDO5wBVyJGBq4Y6gFp1PD0cr8E8MRHTsmgOh5q0yGOfUxxFuYDKa66/BCdmQ4rKz0jTuL2IOeZqQgOivgw40GuFOPfoGOU7KR5Mc+6TniXuXhgGfUHHecS7k+0DbSFdKcI7PM4PPBp9xjOmeFhuJH60Z3nA9NyQe5Lkx29+WyeEIPyDJLfXNXw3gGTu+JSCJcj0+JnxH69qtPnRUfVxTq2NanFjumYevsheAGrYH/EeOnX16fP2UDwpwu5v3RViGpSUDUnMBFXE7r1hv6NMmVmfGh5O7ETyYUQ6yfQWAWTim3DryzU2Rnp1KaJFxCoFmPPwTLJ+Y9cCb5SsXspTT+jKw/ixNEdL0euyxquXhLrs9l4oeaWuypxY4aHb+d4MKr9jLxR3ASBDKR4HQtANr67MU9vbhFjzopPCGq93kgTQQ+Jn/oSmqrfTYfE/RiojfJx5V6PZR0G2JiGvP5i1nUwyxlBywZam3F3xgj16EwuBxUiKLPZuuGFo1dRMTrqy2WYr9kLGPAQ8ffIQJDeWfiPSrPDp1oADeV+pD81VkWMf+rOyf964TM7vElqiiNTHXyCSe77/FMC8a0YOxzgA38+yJFjoXYJhlcHvAOsDu2v8sEgdFW3vO0ZmZ1R37FzaHSkIBVR8UWO/7LzjjB1cfT3Asa3YxBGiZ03fz0h+8s0KJKNaGsel/gvgan+c00CuQ9vXl+m30pKpp/NHlJ4u54++RYZaOvnaUfyCR/nLz7P8p4i0zzZ8w0Ae+Su7llQ2PQdvIXAa9Nb+fRfvNQ4H+8dbHqoDUaF3+kmlBMmxChZfJqF9XJUAq3EVAIXhL2WybP0rmLRPTsFP5o9xyhgcEYhK0FJuU9mYGe26quV+YuYDywJLvS9/qIP10TGKKxFB32Gr2ZSmAW6svosAXe/aZDg3YGy5yQYdnL2tgAXXleKaxGcVnljMOlPuIRqbRJZcPtBKVErQvtoF8zq45icjUSoeM6FJPb4z7tMaN9bRn+I2vB7vXdHe6vV4SLXGNBTkUWLmEu34PtH6MNb4uHIivclRGwhT6vtcLRwfkURRBTFnKhA9dmsBIm2RUaCyLUHnn32eisdVZj1y7geaFtiV62RfyQ7iy1r5Cy+lg2a901vXfavNlm/11vl4ZaQ03CSkE7XCRB5ZsW3yteRh/pFdF9DCEyjby9pe0Qap7u6LG/jkcdJIxAkTG+AfigsN/XRdOZ6nOXw5p7tGELgW4Nfooe/r9uiM7RY3OD9jMVubib+cV3M+faZ3zJdmyg6/FGCML/unXp7DLcnYz8Tmlr1tRviUSl2b36eY/yM38AIYcPtNTd3X8Bbx12kQ== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

List Notification Template Defaults

+ + + + + +This lists the default templates used for notifications, such as emails from IdentityNow. + +## Request + +

Query Parameters

+ +A list of the default template objects + +
Schema
  • Array [
    • 0","description":"The description of the default template","nullable":true}}>
  • ]
 0\"\n }\n]"} language={"json"}>
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-notification-templates.api.mdx b/docs/api/beta/list-notification-templates.api.mdx new file mode 100644 index 000000000..a5ef76c4e --- /dev/null +++ b/docs/api/beta/list-notification-templates.api.mdx @@ -0,0 +1,83 @@ +--- +id: list-notification-templates +sidebar_label: List Notification Templates +hide_title: true +hide_table_of_contents: true +api: eJztW31T2zga/yoab2e2ZXAIAcqRP+4mpbDLHhSOl+vcAdMqtpxoa0uuZJfmGL77Pc8j2XGIQ9m229vupcM0iS097y8/yfJtoHNheCG1OoiDfpBKW7zShUxkRBfPRZanvBA2WA0KPrJB/zJo3rfB9WoQCxsZmeNvIHE+lpYhHcuKsWBFRQF+8YJNdMnG/INgmY6BiohZog1eNczKQnSAjxVRaWQxAV63wYUVZlerQnwsBmUxRv4yVn3VkCGsWfSN4HFwfQcy5dzwTBTCWCIjUbL3pTATYKDgDumaySK4L/4R/8hUmQ2FYTphRtgyRU00fC1KozpX6kwIdvnPDTY4OWBnBVcxNzHb1WkqIqTBTmrW10/HRZHb/tpaLD6IFE3dsVymuZaq6EQ6WwNd1ngu16ynE0Y1nXCqwjMyUqaNYFLB14z0RlsZ8b6URoDrEp5asRqIjxyMAer1trpgymgsMh70b4NikqPOwFeMhIGZjoy7tNGDC5lUMiuzoA/zMv7RfScqsUg4WIF+3d2ttltTJ4kV8+Y8pssgNlgQwyEp09RblcGNDruwJU/TCbO5iFxA3MhizFbIOyto+JyPpAL3wnyjy9GY6HjHfDfu+AJn1OZfbPxEphTqLUxsYaQaBXf3HbNPU+oALy2MIstWujM7UQUkg5s2BMdI9Y0N/YPTCyQLvZzPrtSV2q+uMqg0tsxzbQpfSCjEgJS+wdsQTmlsGbBgrsxpY/tIYWXlnZisrPTZini/CnqtMnuz4m5kIpZlVt+rr6c64qloXg8a7g3cNCbes6tg72hwcHgVBFiHQO4cyiQUUHBJr9vFj1lHDKhYYrGp6hjTw1/BFna2NAK7CAuhKpAGz/PU17+1Xy0Sup33PTeGY5TA7Mw2rjv6cCM3aJdCOvHAJvOB01QySnUZv8m4gpR9c6PNuzdI+Y0ts4xTON7vBIIBTVKt0QkwFl3cPsTrnNt37IgrDhnCzsrhlHAbG6RX8Vk8Exg7P7WxnieaCWuBCHNzOuwIM979sCzjEzYUjMexywxX3KBFUA8TCplculCA3yc/H7/ag8+zozP8/3Cw+3f4PN8bwO/rptpuAgjq4u1xgrqxdQJUcmPTXGWcvdg9YZvbLOVqVNJ1PurM2FqQaWzpwuJBt/yr6t9PXJM8Tk6EimEUWt2yJwV8uK9QuSHTYVaBZZI9uX3zZpTqIU87EHVxGRWvwGd3nVaFvCiQGUpUxm2Gzxj6PBTOFkkV9Bc+RFELUzYLMN5AVrkRkDZYot2AeeaOOPvA01JghVH6hixc+N7k5RnqeOIqTIcdJCBllJZx1b4U1DHk6KjYVbg67XtAgLPNbreDqiCZh01+kgpuBRtp5nso2hjijwK81XwkWovZEq2L381sjvi3MltidGsWT832pI43KIoy3YcJgzgGWrbVZlcBjuhfBZjSOKrNgEbk6eRcf2XGp0iVnWvgvSjgZ6Y9xPwlcJywWI4E9JQQIJYCwyUNRKvLgpoutXtKVCobGFL6RsGYv7Juq5yNK20SyvgTvWN9eyj4Bg+3tjfjcHNrIwp3RHcz3Nx4vpUMky2edIctfCGQ4I+XhQ5HQmEPFzEFQARYn+JxnmmNpmIYERYyE60K4Q12MxaoC/Couy9898Q7bJEATc163V437K7D33m326e/Tpf+/Zs6jl/o/A6S3nBYaXFwdMXjKwh810Sxl4QJ6q5ZdyVoWYUsXJ/2wrwsNEy+w/mbbTBnN5UYi3vGQLiF7JRWU9g6E4/nAdKCJq50YfJBCZAk+G9FPQvQTSwKyI1dHT+iqe5DGoYjwyVKKEjkCCYyoPhBUuoQ+nckK9xB42YtjdVqnb3gMejr9Nv1yoCZCsOjd0DroDU0ZgW6UBLms2oKk1O428JWbAs+fN7d6W0mzzc57/1lc317a7iT8I2N7s7Wzo4DQgQSbAtcnGX9EwaRjBzIkP8Bg0BygO1JAGL+eIT5bUFNeHE219pqZHVs5Ei2F1OP3V7u7Q8uDs/hyunePy72zuAb0prb8BhgPYwxLDVV2DE0vmKqACapFbi4wfxc8VRXQCGubHOgdL/sxIIxmV/1wQzPvWVGkzTDjjiTSpHbNmFPZUd0VgGsYqHgRTRmQ8ATsCRyRXxlEEUiL8JDb8kVD4CedRi0LYlK8qohP4B6qYFDc2G4NROJWV9MTXkfaFRl5LDpFEwOkPzTcTKICliKUEzMZGEdLV5E7x+Q2VluVrrzhtHIpLjwhbVoRBsTkTYGsegQdJOwKPPliNaeUHhUNa6uWFgCK7Wo3B05YVyFhHrGS/uIvDtJofyEpFp944PwyUfw2lUj8kblJl+RKqCIk/2o2l1V4jsQtszdZe4uc/eRuXv/5qnf3KmwD0Kf9Xnoc6EAjY21oeY5B32MXy2xahDBG+/IVQYG8RDpl9fnkNjvAAXCePExR4j2FfGRa+Ut21OVP/xGYLVPWLX+qS9QQLKj0yCBSiTiPsk9ldiBRDLVxjy3fW2GEgJUtUBEqJq0HcY4mMyUSqEkHBaJsRZW/Vi4fQkOGWGtq4DIVcWh23ZcIsklklx2o2U3+tN0oyWSXObuMne/z9x9EEnWUlG2eJxUPWSjSPP3UVvcEt9g1WNGVqccueo+WkFirMZYwSxyCIa99eF6sh2JzZhvxs83dpJe9LzHt7bXt9eHm73toNnrL6d5XCfZbE41/O386B7tCPMBcFypILhsoXU8u/0H5jUiwbKGpafGzWBzMOl1jR17O/PY8VxrfOw3qRCSncGQamojrGkwNsOxphpLTxdGUBcVg1IlQS4MJdx4DRnuoTI6kOC2WAXSNZNwkOATD/+8yAdZzcU/2bBUCVKNqFlDYElQUiSI+YACIdgRVOeviE69i74IybNT1PgQNWZ7HyMhMNFr5L7Vtr97AMIbrBFnzsELNnrdaocrCABYELiaVePOJT5f4vNlj1/2+D9Hj1/i82XuLnP3+8zd34DPPRpajM9hwKPx+RY+imc1ltqng5/fGqZTqngJKLyZjqLS0HZzhcEJV0AooUAjOvebczyeHay1H80O8Fw3AkMnU2lSGFudEr0FV4GL7jo8lx2oYOCtYqL0DR0VHYJ9Fh4MoRNFMIAOpToGHTKukRi/rtgRcWdqf5I2qE+jPki5OlVIZzAdmVUGse5jiS7jGTdYSPxoaXSHYmdOP9DrwqR3X66LI7RAlzbzPcgNxjOQ9J6KqML19Bj+GaJux33uMP60k+BKrTfH7BiH9dgLwQ0sCdzDi6e/vD5/xuqjKf7ksZC4OIBsOYEQoVo2qDbycRK1l+np78HMoxLMHZakoDDzx8EPvBFeQZE/hapMJsVJggoBznr8GWU+M2/B4e8rFbKX0rgjzO5MlVeR1njsMq/04g29PleIHypqoaMWEjU8HT0jhTPtZeSO3kSQwEiCp5as9dnMHb2wQQ9XUHAFqd6XAS3h5Zh9wBVVXvtsOWbohUhvVo4r9XosoZHOTmOubjELfTCN2QGLxlpb8TfGMHQwDS5HJWTRZ4t1g0xDyoiw122IFDqWoQwBFpJ8h5AYygUTH2JbJlSiAbCp2KXkW/Is5PxbOsb+dkZnunwJ3RNHxjr6DQfv78mMDENkGLoaYL38rjlhYOFpNdCB6oALgN2p/6kSeEEbdc/Raq3qRH6N5mBriEBUomLzvvvRnxY4/43RDRxdj4EyjKi6fuQHv5mnhR1qxljVfsB9C87Lm2pojPfs5uSt96OwWf7R9EWNB9Ntk2OVTr52lV5QSf44dfd/VPGWlebPWGk8zsVwI7Z+QdAM8hcer81v4+E+81jA/3CXcpUgNSxY3El3RDFNQoiSMaopq6OxFLQBkAteIPZbpfO8GWUirNUx/WGZR4RGdFTZgMgclmwyBXq0RV1x5pQwDliiX/F39XoFvqIxhgWl6LDXsCZTEbgF12N4yALu/ar9wuwMPHOCjmUvK2cD6MqyUgE3zMsyYxxC6hMREUsblda/GaKUqGyhCfrVs6osxlBDFTq0MjGZPU5wbxmWrQ3Hf4IX+N36jWXuXm3xb8xNFTkVqX+VdfUebP8UbYi2cCzSnF7XAbFgfdfgcHRwPkcRiCkLesHKW5vRmp9k13AsEMHlkQufjc56pxvScgGu59oWsIZtED/EV8aaL+Ky5pu6994WqLfVv/zdXN9IcAWwluO2FYpXuhWJWwBeBgsWgLCkGIMeOOL2Fvc2cEV0h5fdy4y4LATLYrhP359cqMn39Zpuq9nodbv6LWS/HxAEuHx8vB3+v96vfcCO9fvHn2nI5fuwX+F92Af8M31Feeqg6+nuBqT/dePFvkv/Nmrgtj0bs+YeDCKVeivqpz0sunwB7PVfkNXd3X8Bk+rBxw== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

List Notification Templates

+ + + + + +This lists the templates that you have modified for your site. + +## Request + +

Query Parameters

+ +A list of template objects for your site + +
Schema
  • Array [
    • 0","description":"The description in the template"}}>
  • ]
 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-oauth-clients.api.mdx b/docs/api/beta/list-oauth-clients.api.mdx new file mode 100644 index 000000000..2b10530c0 --- /dev/null +++ b/docs/api/beta/list-oauth-clients.api.mdx @@ -0,0 +1,83 @@ +--- +id: list-oauth-clients +sidebar_label: List OAuth Clients +hide_title: true +hide_table_of_contents: true +api: eJztXFtz27YS/isY9aGJR5Ql2fJFL2cUX1K1ju1jyc1MHU8KkZCElgRYgoyjevzfz+4CvEmy46Tp6WXUh9gWwcW3i718CwG9b+hYJDyVWg2DRr8RSpNe8CydH4VSqNQ0mg0j/CyR6aLRv7lvXBuRHGmVio/pAEbBZw0T9zW+4fn0Sj/iis9E4/bhttlI+czgmAsczHKZ8CAQxk9kjPPCrOO5NGwmUsM4QwRMT5l9xco0LcAR84RHIhWJISQSX/wtE8kCnil4An9OZUjPm41E/JbJRIBKUx4aAVr4cxHxRv++kS5iHGvSRKpZ42EZyynJYIkwWQiAMgOjWDoXzKRcBTwJmFmolH9k9rWJCJhU7ObHHTa4HLJRPuhIh6HwUSa7LIDfvpinaWz629uB+CBCNH3LcBnGWqq05etoWwZqm8dyO5/M8ws5XmmAb6yigMxzOF++U+/Uaf4pA3OaLI51kgK8qU5IgSmI0nf4eCpFGICxVcDs8uvE9FHC1lbITQqLHGxt9dlWKJogSmVhuAU2FR95FIdou3wQCwXrtrs7XrvrtXvjTrvfO+x391vdzu5PDVx/QBdrZYRBw3fbbfxRN/fZY8vto5epFN/gcRxKn5x0+xeDr92vridPEo6uIFMRmcrnevIL2A/9J0FdU2nByGDVF5ZdYXiMyNB0VXQ1S3T9w85B+2CnF3RFr7N30O70gp3u9OCw7fNO76CD/jVBHxLGnJOTrk6K9uUTFJcmmViNDcHQvXMouTT6A13ORhUzc52FAZuAW6HD6hrMgR8Jb6RDniCguY5EDDF6nYRfhicXwK6vzhg3RvuSo6fdSbAS4tJ3CmLIIS5B1jBhKEAkhNrn4VybtN/p7uz2EJ96xFB1IAM2zyDXQATwAOFaK+XO/sikxyLS1WfL4f+51hiwyt+fUHig6In1IkgsldDE/KkT+Tv5+HtfBxB4iZhC+Mzfp/pXoZoUrPbV9z4kNvgpIbOxKYS0QTW474NXjHHwjzyUAWTskYAgCqrBAGlGzEQCsGDmiKf2o53uinHJ67JoYlfRWEGAgdlpGIGClK0wexSKQNqpeCT89QGR4MOqIfZ77QdMDaTenww4t+IfAnywt9u2kAOoKX56nUizJvMse8pyJnqs4gyKmkeuEEOi+gAI89kgyIbGuksRX6v+Qo5QBX3zWIDdAoBZwlU6Bljr9Chw12FSDuyy1/gqw3dh6HKwlM5+dDY8OR+/P7o6OYafw8HZCB/DCiGytQ8H1+PvLq6GPw3Gw4vz90cXxyfw4dXJ6dXJ6Lv344sfTs6ROKQyJfmvcw2esqdN291Wm5HCDOGalWX3wa0norRw3YprYa1VYAlrGZNkpGVzosPmwQQD2AutQkjsTKMDT/HXl9YlamBrNr44PT0bnp+sWwdn6ItzNyAfWrHgoAT3kEtYB5LQrWQ29iLOJlCVES/E2lS6jPSy7gUX56dDZ6InYC4Nu7x+dTY8qmK1c+ZYMSkkileL10TrUHC1WiQUsLMAyQPZld3NBeixXCJqLoCZAemjMED/8qkgf7Dh8XlVOSKWD6gEBn3w9cDAgjuZhAVAVafF3AKzgg2hzqN/j3Ki9/UQOO4IJJJmoXSDy2s52Doj+CGXkfkzoRAFB3YLCdqmPXxpNHhzxuzcKEB9fposFAAaUQdeeGlReQIY4aUyEmurDz6lKo0jmiwADoRegzgiGUJKoprUtDiXtLzjhuUIavSy3dn32vtepzPuHPR3e/2d/Vb78OAnjIJIBxKI/F8JGfsAlsXBOtwHXnvP6/bG3Xa/2+13D1qd9i7hzpuH55CtP0ePevovFUHfgddykrBMd1qM+lScA9qzKIZ5oJoonWLrmpuBgWNCb5csqlNkBshyE6g7VCUVLuAfH6QD7IWT6XqTRSURTbOQwt8m1ukC+7a7ufTnFcFAcBKgPZoh54fY4dAoQl+5sKoQY7TyEqC9wClaz3Yu4+tYfDnHwUWacmhM8aO4T9JMn4fharUe0bPVAtOql+EANOhDZ+x2GTwS2Z/KxKQ027qndtmhEj9UNwRusPdb6srqPZHrQOpIn2TYT9PZJeZYo181kuAqZKXCleVlfcpfzbxlKqukiHxBqwRKpESPrLWvXKPeeMD/mo3ddb268+aTJAG/9NiVSLNE4f6HXTtXNNlEBwssYlIRm/6SZv6Rpj0QKZfhEeTxT7eHp7C6HhhaIkJBkKkAILuG1YFoijQEjxWZux+Nq0cJWKLVYa94APpa/Y6cMsiaEu7/CrKGz9hNuFYS3mf5K0yW7d+aacW+4JO99mF3d7q3y3n3YLez35scTvnOTvuwd3hIFQD8Blx2HYevT/0aMxpwNWoF5O/UXHCwPQGgyZ+/cUIynmF/zMt2bKGmw8tw9xAaWvbq6JLt7kPyVbOMPuezJSMo73q0knWwhpDgi0TO5NqmPSeWxyeng+uzMZHz/16fjOA3lLWyAblMRub6jhA7BbBEGIH7cJBD2ZaTugUKcWWqA6XjKQsDxmQuB8IbbvY1b1RFs2mio1oo+Xarlb2QLdGCAoKfQUGEIjDhxhYbHL6FXD5OvTNnyS02FzwQycsWGwSQiUBJoLAQjSAU3l9gSeBBYLcuaWswg1AWRJw0FCmoadIX9bUoTblcA/KMclZdFAwOQP6MbRw/zZBfo5rVKCy8xUF064ObjjRPHd24YjQyKe7R+shYQyiHvk6ok8YCLKFqunRE26SQeFQ+rshYmAJztSjdvbFgjlNNz3yemWfE3SXkZuWRasWDD8IFH7IKl41oNfJlchnJ8Rd62Y0qlisPfLuRu4ndTexuYveZsbv8MCc+7ilRn84q9blWeS8JSqxQn4S8B3h4reF0C9nELRJHkb5/O3Y7kdjkf4yRkX5FfmRL+Qr4QbEe7jur/CutvPSXa4EAyY5WgylkIhH0CXeJ2JJEMtXO6mynOplIcFC1hiJC1kzYQmfUtySZUoiEmya1UurblM35h3JbTNteTajAs9+QbZjkhkluqtGmGv1rqtGGSW5idxO7/8zYfZJJFqgoWhxPMlkU8WRhPc09R205gwEsPyvDipCjpVpmKyiMFRyrUWcOjUm3M+lM932xG/DdYG/ncNr197q8t9/Z70x2u/uNaq2/KeO4CLJ6TFXW264jmRhI3AfgcZkC5zKp1kF9+w/Mm4gppjVMPQVvBpuDSW8L7tg9XPN9o9bsDVeLnCGZGodUpY0wp8HYCMdWvqwDU84gLyoGqUoCLnQlGQmQQhv6oYwkBS9qAXKThTeY4mkvGyi5kxWzSOWHGSCkTODO1YBjSVBSTJHzgQRisDPIzl+Rnbol+kNMnl2hxmeoMTv56AuBgV4w9966/d1h/mXnyC7wIxu9ttvhChwAGgKbswreueHnG36+qfGbGv/vqPEbfr6J3U3s/jNj9zP4uWNDj/NzGPBsfg5jW21WcKlTOgbx/6bpFCoOAbk3076fJbTdnHNw4hXgSghoJiiHcLzS0diu3uewV0CQD1ooGR4ab+T3GO5hhWBlHlo8li17VCVdKH1HlxkmYJY1GQePBtjowgF05MNO0CKbJhLd1uY4Em4tXBwnye9LPCk5PzG/0BlkNRLTxJOMzoXoY4AYQ//wraHRLXKZFf1Ar+skfPjjulhBj+iyznxPzgbjGSBdUhFVuC1v7IyQbNvZV+7tlAUE13r1PLU77ftK8AQP5dF3Fi++fzt+WTlDbe/GCEnn9ji7BBehFDaonhGnqpLobGaP5A1q35Ac5UfyWuydGgnBbobOCOeQ268gGZNJB7Xzh8+/RVM/t/iSShz1AlLZk2Xwaeud8tgxnc6RWKpxjFORWjt2E+d6VQ+DfSmIb3JpnpXmkTS8v1NDYU174+4KLB/4/+LJ3fGoijyPziJ5KHUZgz18Sjjq32sVBym/GEdNnofy6jjeqbd01K3+GrPpKr/qMmT+XGsj/sMYug6Gwc0sgyj6Ylh0vs6z2a/brkDy7JSe9IANEr4zCAxlnYlPsBoTGdHA01RgQ/JnWlmI+Z/pJN7PNZ3p4xsomjgy0P5nXA1bwowTejihZ3OAcfhtTULHgti2t0Qg6K0DHJXrT5nAAa3kPStrbVYn8dv0Tn6ujKSU5/zKBOd+Y/b0WXPpLGC/UX7TB38zJwsLU81Y+TbAsgVX8YYa6uGS3SzeYhsKa+TfTV/UeFDullyocPG1s/QjmeTvk3f/ooy3yTT/xkzj6C26G03r+oCqk79yfG119w63l+fC0GFkilVi0tCnlBcLqoLikKfo1RTV/lwK6vtjwVPkfk30LB1RJEKLjuEP3R0JmtE53QQgc+jUZAjyaGc6n5lTwFhiieuKf5uMmg+cy59DHyla7C20YsqHZcE2DM9WwLNftOvHRrAyl7iw7DhfbCBdUZQpmA3jMosYB5f6hEcE0viZTVzQlSmR20IT9SveyqMYXQ1VaFFDkkTmYopbytCtVhb+E3PBuhu3nwymx1V0l7xLRa5ESJ6J4+q0/VOy8aj4XIQx3UcAWHjyuZzhzXC8IhGEKQN6QcOtk9m2e8ls41gQgu2RdZ+dVqfV9qhdgM9jbVJoXSvC6cJz/T78yh3UYhP9eTfjXY1Acr8d40YUzpzZZsO2dDeNekt3iwfeTYoP7u9xkwJ7nAf82N6ox0YPbOUuNrkr9I+C3FyZf+zK/NqV+VXgFkP5/ypw2wgNujGf94ywBHiD0O4Q0XrY1+weUuWtlW9ZUErR178+QVfmj5AJ9wtO9fDwPxnJB48= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

List OAuth Clients

+ + + + + +This gets a list of OAuth clients. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-outliers-contributing-feature-access-items.api.mdx b/docs/api/beta/list-outliers-contributing-feature-access-items.api.mdx new file mode 100644 index 000000000..7e195a509 --- /dev/null +++ b/docs/api/beta/list-outliers-contributing-feature-access-items.api.mdx @@ -0,0 +1,96 @@ +--- +id: list-outliers-contributing-feature-access-items +sidebar_label: Gets a list of access items associated with each identity outlier contributing feature +hide_title: true +hide_table_of_contents: true +api: eJztXG1z2zYS/isY9kMSjSTbshPHnrm5cRyn444T5/xyuRknk0IkJCGlQBYgE6se//d7dgFSlCXZjttrm5z6oZFJYLHY12dBAFdRlisrC52ZwyTajVLtiuOySLWybj8zhdX9stBm+ErJorRqL46Vc4eFGruoHRVy6KLdi+hw71BUnaIP7ShRLrY6J6IgeTbSTuy9PRRWgYRxQgoaRWQDUYyUUMbqeKQSIZm20ERcSOeyWMsCz7/oYiSUjEdi4JkQA50WyuJVf8IkGj1FMcmVEGd4mvU/qbgQMWYhtXG7oRkxf5i0RaJdnsqJMHKsxOPCSuNSHq9Ql2DOijEay6ESv6jJEzSfzukerf1QZ+ClLVxW2li9wTBtgcZWjVU6OZFWvTcn6tdSW4XplsUos/o3VoRwMZRC8nmkpd7NgmQ7Y2kwwliZYtcqmTyCBnJpQbcgue9eXEWa5P1rqewE72hirNGxLqKbSnktL4Upx31laRywUKaFE0UWlNR9b06VEhf/3mTNnRbSJNImYj9LUwiVmHxbD/3h8agocre7tpaozyolg+o6qdM806boxtl4TSdmTeZ6zQU6nbim05lO4YkYkCAzaFgb/ByzNLrg3Xo5wUAHMnWqHalLOc5TTK/3dL0dOdjPWEa7VxFpH7PDuGqoLHp6Mv7RZg8PxtrocTmOdtFvLC/9b6aSqIGEFPiv6+v2Ymlmg4FT8+I85sdgGxIkixyUaRqkKvCiK85dKdN0IlyuYj3QlVm3WDstEnwuh9rApNDfZuVwxHSCYr4ZdfwOZdTiXy78OCvNvOwPB6JV2FK1EAAgVQg+z/Iy9aJUovWfzllWyLSzT71bJNI8M06JEXwI5s96oIYL3GEkQTErU0QaFTwDmtODWm+Qn2h5m2iJL4pENTSQWAKNQWfaxNQP03AURBH5CmJF8ERELI0Yyc+IXwI6YuFQez3OZVy0aTYInFZBY/D5BAObrCBLcYpGbTGRf/DMW8QTc/tZpqXyUqDWYLt0FTffhAXRfBYYUT/LUiVN1LAT7jm1lVwWo4af+qCJnLaAmENaM8PousmHH/dm5kIU9oSEJko1l1Ev3tl4vv786fOtnnq2I9X6xvOtzV7S68Vxv7fRG0RL+Irncyplhlu4xKiGXOQisjLRsUw/IgHoIuVE8LFyiUXPEN4+fkImgn4+OthrKq0uyJ3GkORHetsvTZIqdDBxaa0yMb11GBUPmxTrdp5wrpRNkd8+IlFZFX24lyA5z8K5mhKoMvqMaOensiweTLPsIpO6Re3z3DFsAHdNKEHGS4FBJ8zSpLaFRVPoCsQhcrncZp/RI2EHriFPms7M8eDN2eHZ0cFr/Lt0di6znNi/YmqNEEtRQ3acIm8ETqFZT4cP2CdY3qw0TjFsHQFLMgYWQuXpwk2Apy4DHupTODR/clj5gSQDvjqByycc3fwzCpmuzHOSXVJrcAAy2RfWllZpAizYajVk0GpF1x9IzD4zOBJsb32d/pm3lAq7NuEqhTQyCtgJdZJ5nsJTqdPaJ0c9r+ZVJq2VpG0m0HjuYSt5mSUJFdrzg/izQN3z7B2+rIB1g8GboWsToWvz2eZm0nu6s7O+wb+e9TZVvL65/ZQdpGEgdw5Lg82g6TsY2CPxQDsnyilpget9VTHnmHeN+7IByeeH7M6O6V8wwA2jNlJSW6SyXxl9m7O611ehY+arEWkWBeiFfn1bmFnEa4jysyT29vcPTk8/vj05fnV4dIAHJ8f4hyLutKy4nSUY40I/ZxamVZYn5/UHMIHYpS5h6c4HjkbVco+kPJfOZ0e2oAIfkkHrGIADPsHo+1We1/RfO9pa5KL7IABsdWAtfL8DG5uCNg+oGYyJfpZMKFZoA8Skk4c48BJHTRTKzXQ/S+7hOa+0UZ2hRXkKDhWzHKNjyCEUrxg8eZJ1wUztZq0bkuhuiBeSfMrPbz9MhoRrZfwLaB3eI4KcG43+ouqC1FfH0AXDqm0l+8/Wd3pbg2dbUvaeb21sP+3vDOTm5voOIguNHupityDyzQ79ozLK6likGTCO/g0CQZEL2TMDPPj9gyXTuIf8OZ5z23qaVR1PdT0igXix/1ZsbSM+mGHJz+XwhhBM5/yUsjZKPtmvbB4z94SPrR7qhcGscviXB6/2zo/I2U8O/nV+cIpfRGtuHWXPwFoJARYZVymj7AtzHCbwRSLzKcqWwPuiFai2BIE912yo/V9u4gjkBM9FjzD6gh5N0mJgs/GMK7HfXBbise6qbhslB54hciLC9iVqDwEVch1GHpwXnaMgyVYowJ50xV6SaJokKiOuXxz6T6h2kUniAYavqXnxh+o1ADHCWjpWs7qYinJWG9MIc9RUCjkHOL/bTvbiAuV7WOtpeGFtLYHFoB/w7CU3y91ZQ2gsUkJSADcxrwwASltar0LUQ/R1IoQjBjQIPKZqV0esZuDkcPfaM/OyyPhdLEt3D797myL8dHhq9YvPKjgfZ8yAaEkblZpCRAqrHdy5wr2VLCrH95Br5bsr31357j199+bLk1CYhLcMfTbmoc+5qZaRMYk56GPZekx2Y63ZK7JNS9gBIv307gyO/Ysy1F5d5lR5/oH4yKfyOeb3an2EyrIqPKvUP9UFMchy9DMYIBKpZJf5nnLsQSKLanN+tFeZ7WsYqFkAERE1rZhkpQBMFbY0hlfuUBYkmXLmURHW7OqCoqDvG8okHV/HrpDkCkmustEqG3032WiFJFe+u/Ldb9N3b0WSNVfsLQEnuXI8lnbiLS285+VugQbTj6e1y7GqbqIVIiZqjBXNIoeo39vobwy2Y7WVyK3k2ebOoBc/68mn2xvbG/2t3nbUzPUXUz+unWzWpxr69npkEQPEfQaOKw2MyxVZlswu/5X0jWNAYY1CT42bIXOI9MMUO27NY8c3WYG5gTCwo12yvHh+ckT0MTSTJ7n59VVyWr8vhT/XEqTkr0a82LqCjivouEo/q/Tz3aSfFXRc+e7Kd79N3/0q6Lh1F3Tc+grouCUIYg0IYv2V0DHRfsfdAErBHPwOKYKNOW0hgOT96mNw+0LaoSpqoDeDIns7C7aSZJl4Lc2kAktuZiXSTMVF4Q1tx9TWVm3RQIohQqShrYMa6JasSo8VYVLa+cj7E8mPaUKgayedvUGBWYVdj8He6lG0idMSHHJQSDNae81gY5q2EA4I/oECr4MOEaj/wDXOoK3ftR4sTmjGRzRjcXAZK0U+X6//Pl20S+AQzFsKF6de10u2C/g1c2lQRqjL3IevGoKuoPoKqq/S/Srdfx/pfgXVV7678t1v03e/AqoHNLQcqqPBvaE62nbXRY2lXvEW0D8bsbOrBA7YvEUWM1ZPphictssqPKTjDzTIOSD+vjflvbIYkWfedtIu+kDbw8cKxkhTGvIBMD7XsRutVZ3WruozJ9dr4VBAx4sL75ac+7he8/sIOjocqfS1hxdFaVMMUO2Zv4KFwDKuuzLX3epIgsm+8Mb5PsZZEPFog6v3bmrAW/T9AF3WqdXkNj7GMnGv4bCVN6r35t9KudrxPUHdIzyZNu1zDibMj8FijvrlkePWXTbZuflhXuc2vf79c/GElsxlkfhuHQ3tBTi9MUWawoepVZ0S2Pejz9nWNIHRZ4be3GDH1KwnXihpUYn4nTePf3p39kQMCeJyiPHnMJSmmgRO+hYmwiG03tZOnTirTc8O7s3s8yGXFYMUExbhKNhhEMIb5JYTJAMWKXVSHH+o1/1PbMiZfksOfr03HfFSW3+gw3GbMEV/OO4ir+YlG/N6KBM/VNQ6wceYGp0WmeHCi/Yi9vvGY8QNIiFTx9J68OCeXqdBjwo3PCGqN3kgSQQ+ZndnxZXWHszHDL0O0Zvl4715N9LI37PdhA92wo349OOhiEdZ5tQ/hSDTITe4GJbwogez9YUG7bBHdHrrDZY6fsiO7gCNMn9HcAzjjUn2CQ0wGMr8ugy75M+sWfj8z3x04+eZOfPjCyRtaplk8VccQ7rBMw3YoQE7Pga4wH8I8mAWvk1z4DjgDWB/qn+OBIHRRtzztBZGdSa/xn0oNdCpcKbi8l3/x+40wIVf/uw4ta7b0Nmz6qwcf41MUxFoUWKcEVa1DHFTgvP8phny8Q25eX7rj6mUo/9u86UZ701Xa45NOvmjo/SSSPL3ibt/UcRbRZrvMdIEeE3mxsOGOqRp5C8CXptfPXR8RB//x1v2VUbyqJOmp/KbhPJUFmTV7NXxSCted8gBpwn7tcmysjF7Ym4zcn9Ul0xoCBRPi98OmFT2dQp6vDJejSzZYTywJL3S364M+zQymCTqWNUV7+i2khhqoTKQdgjj3acs1IOn0MxbUqx4WSkboGs8Lg0dHQbb5VhImNQdFpFoF5c+cKFmMKqSRcbQr+5VeTGZGk2hywWRHbvjAS1po1puKP6OsaB3F9azIXrSYjiBPJ3IiUrZMqndLGy/izasrTNSaU6FKKIuAJhqjPD68GyOIoiZ8BEls8O10MmtUVsQofLIm89md6O73uFyAc/zzBWo2xrEf1RF87KZu++XuddB75tWfDX9ELC66uZ/eNVNSM/ExFpOa5Ck9NLXeb4Wv6hufSAr3W3eAHGjHKfXyy9imKnIUeONYFhE/OqK1rioRL2mx/60PtXpEC/Fn+nx/KX28W3durNQ4lB6NL1UKKwLRXyJwf3l8P91Xc4tcqyvE3qgIFd333x7d9/cYg7VBSsPtAZKBX/KRSa3TGHmTpYHzuP/8wqSW8U6vQxmKtMP03XPr8xDj0M2Tp54+NC842ghE9UXQTNpclBHsTrVfp2eb7Bxxw1BD2BsWZK/pgs0fAxkyfnW/qNVg87cto6ZzwA/HhB2lUtWD8KP3Qv6BPFfsHCaLQ== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 associated with each identity outlier contributing feature' (list-outliers-contributing-feature-access-items)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Gets a list of access items associated with each identity outlier contributing feature

+ + + + + +This API returns a list of the enriched access items associated with each feature filtered by the access item type The object contains: accessItemId, display name (translated text or message key), description (translated text or message key), accessType, sourceName, extremelyRare +Requires authorization scope of 'iai:outliers-management:read' + +## Request + +

Path Parameters

Query Parameters

+ +The list of access items. + +
Schema
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-pending-approvals.api.mdx b/docs/api/beta/list-pending-approvals.api.mdx new file mode 100644 index 000000000..bd259c907 --- /dev/null +++ b/docs/api/beta/list-pending-approvals.api.mdx @@ -0,0 +1,139 @@ +--- +id: list-pending-approvals +sidebar_label: Pending Access Request Approvals List +hide_title: true +hide_table_of_contents: true +api: eJztPWtzIreyf0VFPiRLeTAvG9tVt24RjB0S23AB796c3S1HzGjMZIcZzjzWy9nyf7/dLWleDBh7ffM4h6psDDNSq9Uvdbda4mvFX4qAR47vDazKWcV1wmgkPMvx7rvLZeB/5m5YOahE/D6snL2vdE1ThCEbi3/GIoxY2uTjQcUSoRk4SwQFgKZzJ2QAaOk7XsQCEcWBFzLOcADm22wpB2Fcg6ixiRDsQ8V/8ERgONaHCoNBghVb8oAvRCQCNhOu/8BsP2A8juZ+4PyLEGeOZ/s1wDJpibh+rTiIB8GAdx68ga8aOjwJzblY8MrZ10q0WuK7MAoAo8pjcSoDwDYQofCiAxbNBQNsY5FMyffc1fpsCEtsHC6F6diOsJhjAQQnWtU+eIyxKhuOL++659eDGxaHgDIzuQf/XBe6AekenGjOuLdKurHBuRx5W38Y2We2iEzoS5BEBiXHowd+cH/AHubCY5oYDMbz/AjhWBr6je8ZZSPQdOWkVqy6EFWABywCoQDYToAwS1AGcgcgM04gQMhsQEY8HpQzyHUWTlQpsuCaf2FevJiBEIDsADNiN4IRfcUFQBqF5/3bFuuOBmwScc/igcV6vusKk2RklMjGxx/mUbQMzw4PLfEZJArkvxZyxyVJrZn+4tCxvEO+dA5DBccwEzhGKmNviMcLPxAkgMGChLFkqgcV8YUvli5Mr3lULxE8GFfciwB6SjDyUasJDxaO5yziReUM+i34F/mZoFjC5kAF+va4iZq+bYdinZxDegxoAwVRJOwYhEVSlcGLGrsNY5CfVUZ6SR6rxJ0qEn7J7x2PRwL6B358Pyc4ijF/G3Z8AzMS8m8mvunH3jrtwZpUoyAGxXEioCoQfukvY1eSUrDq/xpTP+Ku0cPeVSTp0vdCweaCWyD+xAdsWKIOcw4Q/di1wFIqzUC7Yyd8A/qxqpSJKnsQSKp7DyiGWg88czwT+5FtJ2sGjAZUGE2EtH/OP4NFAXMXEHGwvbNYchMsI8wGzEgggGMLsIYwMJoUkBQwnDBqlYD8F828ijgRttKUEhWwNaCtbNDfRYJwPiVCNPN9V3CvkpETafU2yYrtuLRuPWNZuqAuCffjEFlGS46mVrjyIjCcstsMRcH7g0n6nZwXYGYoPN8gby/0UxSZMF4u/SAC9PSaaQMo/wFfg+lxrZDkVvopfhCeIYRq1bGq1TNWFf8E0fOq8pmSXWFd+EGtrMHCt8ic0Zt7kFoX/t0L+Av/VMvKJh6FiOVWHmVsBqoBN0KBtACE1tk3AWh/cebhhIusm8hnuzHuDPU+EEiAA5bSvvL4EXVKGrYQydis1/FPnkJXylVU/mjqbaJKmj7YaTCv0As8HNcxSVkPfw+x69d1DvEg4MhLJxKLMPPcn/0OE0fnMUBCRY5ECDzEEu4mal9pmqeNk/pJ68hqiqPG8Um9cWS1mvbJad3kjaOTxprZn2ZcMXCQaigQUq62DTMq+JWMupTBxhdIrKzLR4Mo+m8VVgtaGJFTAvod+olZmOyBgyMoYdbyJKk3Oka9YzQa08bJWfvorNWp1U9P/oFIaN6/KhYaKHM5CAp2XEPoBBFqHk2b9bNm86x5UmvU24SQshS9VyIOhUWGAvocEh0lJFKdp4RGiUx46Hi8r1yOuzfTu26v159M4PG4/3b4Sz/57oEjtxaKqaBNY4eQa+xcrkvkRGdh1lgOJLVOHX+1/qO1cgUbZPx8FVxkLbA0AnkKFNBHfPksXUgBGjWTKI8zJEkpBL5ZifqWThmVPUEp+D5MY7A1hY820H03uOfToaRrhlOD8/7NdDD9FWPjlADJU5hQuZF53kyA9gUZMztgmXj72ObgMIp2vXFsz9oCdMFs1o/bJ9sMz+ahKVSEYecxeH0g6NxCtjHLCZcuX5H1yaPxDnw6hy8Y/EWTDI5PgbkDADvWEzqP/CyHUXpKbHfBkZYUAP4p/SO9S0DgolTbZvBLoa0y+ixn7pTAfInoaBFBI+08Z7DXlSdQ1WcjkJGt9hbZah7vLls/bZajb8Bv7ENIFDH443hPSx1KmRI8iOwGUk4aFGfrL3V4R6L/PJOjteU1zY2G+ceYmuIMSszM6RZRaJ3+QWZmIn3QDZweIriibRlK/q25m9Ps8pUVOhzxm73FFnqLx62W1Tw6PQVi0Sfz+MSs121eYo20LydH3NFdlFNjN2VO4k3GQcwAzTXaAfZ5pv2aiUu/lYy0SeS1EEun4G40Hl4Mrvro2wzpDwnxVf8a/pakmZVFzY6VswgIIyscSvlRrOSMxsIWgfDMvIvRoyxG9HSgYK41TCZWdG7ymKsRmApk8mhT9tzBfLmC/wqu/DmmmDCSxrca7svceZl+LyMOquwQPMXyOXepn+aXJt2utnFHa1cWHemFV+G5o0HEnrHngEgwuWymUlYWDLY7onlktzodoJxocnFictE+PqrPdreFOGJxLdww6O/+3KtZPojtY1a+lVih0SsDnnUhs6K1DMRnx4/B5f7siAcI/hWcsMQN2zGE3mvGXjP+opqxloxD6CBYkR+sNGCtESzQKqHZEpLIgVw98MD6SfZ6uZr4riUTWyK42YkS5wUqcNWb2YG/YA9z+N9aqkQhW5Tki4B7n9i1ExAfxMMrIRL5z0Oj67K3vhtx0uRvtRoLcEdheMcVejjoXZh28lzSTJIBsO66r5CsmqIRwZ2YuYPbsDvMHwzKqVE/MZotNChHzbOjTq2lDIruspEn26lS5FECDjmU4lNIG24L5MmShaFz7yG5dbpqS7Iz21wlnz54VXbdvbntXt2N+93JZHB5g+7dGet6GYLJnS6K+AoQ2ByIORPC0xuUJu1W6nYwn9kqL30RDz/BkkfxxYHkutyvBhMGRgy3qfyF8D3BhBuK70OJY/d2OrzuTge9b0UTlgUft5PW8CRMuOcDMkGiQIAooXWAUYgvBZV2akGqMm1y48FiaTv3sSzlqLGUA080BX1Z4b4b7gfHSxymHNc8KWV9A2eWsB2cxg9YBOBDwxl0AevmGbQF+AZ3Ch1fBjOYn9VEvetPet0roOzw5s+jZuINQQsQX+5KghQoeVGyJ8j4zI+jjZ0OALAt7eD7iYhov+TS9Wcwv7FYOECZQO5p9VMAI991TFgSMps3vhnj5CUe+Q2ckPPwcC7c5aGaQngoMbgTC2gY1ubRwn1D5J70ry5AfN8O+u/uzvtX/ctXp7rStXAVYgiPtQGwZGL/ULi2IZdPlEgAjyiH6Xsniml2IXOdT5hYTtxTGJL4BLKmiw8ktmqfTFWaqPZbuaRGw44ZhPI8Sh6zkWrte8/lBNXIHD74wae7LBWJFd9lRjaWyRBvSArej1IMCRXNl2+VBb68C3xXSGn4LqWDEWZHeVNYjEttXpoCWXM6Sww5vN0IpqD+8KRcQtGHTYP2woqTS/eoeVzkHbKnfLxE+NUiCNZBbvenTshYbfvjPs9YoPeWcwo2bfKvlQeU7RoFsVAmCOGC9KKeke6AjFtJCBDKSi3ZSpUBSEQH3ijwMUe1vvx25Y4wrRegdKpaA/SIHmLwpOZ+QPKnFBcRwCIMsOhOOIfWqp/UOFx6JNiViGpbxKE7Go2Hb/vntDn1c783pY8Xw/G77vgcPudCk0xjzc5C9aGci3Q7FmDOMVbbMVrQJTWoA1ilplJ6ANdG75CK3pjre/e4WGhjplaGkrK9Td5f1o9r1lVgWK+f0X//yGN+u8SeSQL624VpYJMoUWFibgcOpwdzMecc5qdeIBaSLECNMPZwzcevUubjICCZfx6VN0NV9UggVQlx4TtiQmG2CrO0BX85dUPfeuv4chntYcrgy4bkriUiXBv1yJPhOfusO6YFm4CsbzqccsAZh3h7EBdGGwimtWJyq7c8++PxcFxWL0u1H1FM+OVwAyYK81M+7a3AwfTjWAbs6+CcJIn8Ng+K0UJQpsPJAHanZTWOxanB660To31sHhmzZgOI32wfi8aRbc0sqmlJkOwh4DEVimzAxvOwXE1mkQOhKmp12QuYOxgYiY5Tf7s29e3kX4Be83vxdLDt+uC97CjZsm0iF2oMhvIFdpP92Buxdoe5oF8xPeeFKBOc4Nv1PW6gmQQ8DJx7pzznrmTmvH/Rvb2akiH9n9v+ZLppfx8roC2sgJEZpLn/QBirCaAGwoJPq1eNVRXUKkyIe2G2oRNm/ThlhqCHGr2kRxZ0ElQlFsiUysh+cGqidgAeXYjROdYmz3ioVyPBqrhfs4yMK0XJqip1fFNjXctycJKwSlOlYKijFW5ZsiJKVq9GcSDISUR/D9YwxyxsE6Wk3FRxcJVlCnoXyow8tXcFHqxLMqF1TQQB+qJKWhSKij9Yq0LjFHOaKdGIpFj6ZWpPG2KWAHVmBnNzolCnRakCC7x9T7dzPKARVRZlnKM+YnMtkSnLCQ9yVpjZYCCxVsvxTDe2cGfdWxVmlFj1e+GJYC07+j5VskQD8gKfYYYkMgqwHANdEN+klchiVhxo61BmDh8/4qLlOkCKazDssGbwMv3niQiNSlKpG4sru8HMiQIOruInsTJkmeqSO0FIofVKlayKzxSpoEuBrkUaC+lqghtQRaVPyD7qla3NpciRLF9mz6ww0xx5v6b7mOAhyZwQkDGM0J2vHOTe0oEOlYG1OyenTfhk1xudk1nnxOJt3qof8QZJy+fC+rk1679uKZWioyZkw6/cdGCy0AurPvnTy+kSg+FVGTsLNZQgF7LtS3fYUwilG+vw+m40vBr0Cin1zPMdM+aZgYpb6XW70bCbvG10zNO20Z7ZLYM3Z5bRaTePTuq2aM0ssXuiPDPQ5m3zH7HgFJ1hbD2S1M6ajYlvyacqW44BJXzF5VrurvcUL5/m0TRJ0quMKEoLd/RCIuyIghAwDvMIDADGIxj/aGvqEUoyFCLTcw8hSiJSaxmdTdKA42zDubB1pVpiBeruqnCe9y/7KeqJ6D8p+eKLQ7X3rxMZ5AnIuIubUCs6RwVRQRLsYOYCnXdYOXM79am8ZPfgt4R+vd7w9mZ61xuOx30Z3sPnm4vBJcb9xe199UB5F3cyFOxeyTcIBz+NRqBkOlHQ616PuoPL7Mc7ADbtj/FJfzwdXGQaX91O1JvhzQ3EocPx3aT3U/+6W6gpOKhcQgg6vune9Pp3l+Ph7QgeZfbM9McM6smjxDGrXA0u+r1fe1f9u8m0O8VGo+5k8m44TgxFUtAwvqU/GRuCX27HPXw67V7K/9/BTPqXw/Gv9HXyC4w10d7gaDiept8R0NvBMMmnaDZ0e9PBWzkHwOMXObUy7xH5pw4BauFFFpMkg1XMVnqjk6V8muwaB2Y/4CAPsYmuWC0TzoMB0fWbu5jJrNIMzsv2Eo86nYY4tVotWMk6rVnLnB0f28et02cUNmYHUQXV6TDXK/bTOKu8RcPY/yIWy9SYyE1GMl97A7M3MHsDszcwr29gHgtNigkvo5nx44WlN5OerKHuJuexkeC6m4rx8HyghviMSuq9U/6HOOUbJSJNxCmp2CI31Linc2+F9oVMfEWJYbveWF+abj19JB902GDjzOFT3IzV2fb8uX2Z5znAlUG2Yz+/m8Ka8Ul42F58WeLuy0tOe21a/DDLULJfkiQ31Gk7nXeQ7bM8QgQpzSJnIPMlZ4R3inHlMSFVa320Cz+YORbYtnU6yYVy5ceMA8mC2PPo8Fd4wCxfhN73kTqAIzcyaHGVtywYcjvw9Sglc+U939pBuC9Aao37gFMlgEzkmNBRbWXhDGhnVoLMpcny8t+u12sN9iO3kvslemoyKJQBNz8BrMEOan0rK9N0F0yE6yxuybCiI/jsuH7abNvHbc6bJ+1G52h2anNYAU6PTqmSXcnH0wb1EpNijinTfKQMuBeMkgIIaHHasTJsn6zeJ6v/o5PV+M7kcbiD3o1cMD8GTS158Vko5cttrKcJYW2RVJBCnVWrhF1a8eVZxr3u7nV3r7s76m7x5Vgd+FcpZYUVaYvyk8J4seBYS00xo3xPpToMGqQ3oSQqR6wqeisIjCU+ViXvOVRmzcasYXdM0bZ424Kozm6ax01+1Gl0GrN2s1PJrvUv2cuifXwR4MZQTIV+ke9bOWlF8gbCRrOmyi2l3ww0r+GulvYdm6cluy2+z65xT055SGHOh/RSGqFNg7YLbKvLwrABZ/dgF71CXSZAwZ08RtfEoPLiLABusDK6NlbjqctnkkPeapRkmxAtAaZ8qPSbO3iTi40+H0AgD/YerPMreqeZ/f4Xe/JsjDO+whmz/hdTCFT0xHM/KruQYgDIB2gjJpLBJNaboh3ugQBAQCBtVuJ37v3zvX++X+P3a/y/xxq/98/3urvX3b+n7j7DP1fe0Gb/HBrs7J9D21qdJb7UBe04/tFuOqmKwoDEO6k7S31w8itAlBChe7pFc8mjOXw5zN/3lJykCA/VPbDQVMYAErs4cKGXPsvxFZgGzHqs8aVT09Xlnv9AhzlmQKkSIyTPPKMAYQO6A04OUCMyBw5KsjR7BFwSXW3mVpLzIlsh6yOCKz8GQ0dgDnDvRUkVPcZiNQgpvg/V9sUjXWhYmB/M6zZwH799LhLQhrmUkW/raNCeAaaFKeIUPiK7gPsAiPh1G+IFEGSz8Fw2PPuYbTNBH11iuNYyXXcwrmuuITTEZk32o+ABHT7CrY4ffn43fZOWU6rLAIUjT7GxEYgRWb6uTvtjJ1qM0ptXu7mNFdQ0ZrtAFKYu0szupY7BhhPZsZMgs1E47/TEtYE812/DtZkfPIOdO4G8VVCW16spyqtF3y/1vHhmXi9F4jsNzVC6SdDwysIcFpK072XZKJ7uJ7LQfc1ArRcPLuEZGXgYb8EThFrEASmh8Mhvh5maay/GIwfPQHh5PD547+Sh5Fw3Jq0cC+d0d+yAmXPfD8V/M7qRG1Xl/X0MmvZitKjuzyCNMJr1DEqGHNJwDHAiCb8rUAxPCpM8vUc+jI+Hkiyptr8RZ8Eu/EZ1g7/l5kyP38Naiy0t33zGXZgFnHFAAwc0pJ0IFf7qEAkgC7qNc5D1PCQAvZT/ZAkUohnbKGGVWn4Cf0h9cPkwAVV5tGR5Jr+cpUZQfWL0AlsnbcBUow+ebBDiLeAK1mNyPYUils4eFCm4jq/rwzJaoJvEN8le4dL6V5svzribJlnw9o3XttIbLMlfx+7+SRZvb2n+HS2N8opR3GhYFT5khfxH5dOtJ/1COoYI/4e3pKvkgHOsC9d3mmcBLV0eoVSTVptzR1C6YCk43d11oI+j4zlVdfpC/WjCPd3ZEzA6Wz9zXDy7iQltPTInhZHOJ/IVv4exrFBPTkzW2DssbTSBLRi9YUkGvPvdV2HcBDgzol+2ONfMZngBSezhXXmAdrzAw45PSYTlhGYsDRcEc57QtJAXGCS9tBajqOEUqPxNBItwaGMmGoLcDOOfGAv4Hqo0NJe34KnbrdOJjIU6Ewnt8q79U7BB2gw8iY7xI1hdcMBEZoTrwXQNIt4VEcK8IE73g/tD1Sk8xLZY0AaTl+LTqjVqdYNCCryuyg8jiHgzwJNLojf8QgmjUtu1++6SdPyf8oMlahXC8OFwiRkyOtApQx4Za76vbIo1MRxV0SbEJnMfC4nfV75+xZQKhl+P+FjeYI4xDbAI9Sa9wn4jIfY/d/IaP3dSytpPApMnmd+gURmSCt05vzuL/l4/h7KFFPrXXl5Ih/+s3zHZJlL6d15eSMj9j5L8/X6UZIs46F+eeaE07H9Z5P/pl0W2Mi39CZgXsu0/+RdFtlI2/eGWlLIf01wz5XfBhSJbRs6S7Ca3ozK91go2EEqyRXDZB5f18f8AVwyKtw== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Query Parameters

+ +List of Pending Approvals. + +
Schema
  • Array [
    • requester object
    + +Access item requester's identity. + +
    requestedFor object[]
    + +**Possible values:** `>= 1`, `<= 10` + +
    + +Identities access was requested for. + +
  • Array [
  • ]
    • owner object
    + +Access item owner's identity. + +
    requestedObject object
    + +The requested access item. + +
    requesterComment object
    + +The requester's comment. + +
    author object
    + +Author of the comment + +
    previousReviewersComments object[]
    + +The history of the previous reviewers comments. + +
  • Array [
    • author object
    + +Author of the comment + +
  • ]
    • forwardHistory object[]
    + +The history of approval forward action. + +
  • Array [
  • ]
    • 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. + +
    violationContexts object[]
  • Array [
    • policy object
    + +SOD policy. + +
    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[]
  • Array [
  • ]
    • rightCriteria object
    criteriaList object[]
  • Array [
  • ]
  • ]
    • violatedPolicies object[]
    + +A list of the Policies that were violated. + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-personal-access-tokens.api.mdx b/docs/api/beta/list-personal-access-tokens.api.mdx new file mode 100644 index 000000000..3603ff378 --- /dev/null +++ b/docs/api/beta/list-personal-access-tokens.api.mdx @@ -0,0 +1,87 @@ +--- +id: list-personal-access-tokens +sidebar_label: List Personal Access Tokens +hide_title: true +hide_table_of_contents: true +api: eJztW21z2zYS/isY9kMajyhLsvymLzeO7XTcSRtfLF/mansmEAlKaEhAB5B2dB7/99tdgKQo0S9JO9deT19siQQW+77PQsB9oOfC8FxqdRYHoyCVNj8XxmrF06MoEtaO9WehbNAJrIgKI/NFMLq6Dy6tMMda5eJLflTkM3gW2PkoW4RzPznkNDvMafrICB4jjafGZFzxqXCjeJo+T+qJQZ7WzcNNJ8j51CKDpVzMCca8ZDAiFjYyco5aAB2MZ9Kyqcgt4yzSaSoifMF0wsrFmFuMucUYt1ZHkuciZncyn7F8JpgmajD0k75TwoQy/tRl7F+FMAs254ZnIhemy84SGl0PWh3CgBedyRyIdxgI/BgPLNEG+M2F4ioHNmDkRDAjciPFLc6dFDktFQERIJsVNmczfivo4SsZq+d0/ooZOZ3lXdB9xZ0lZ5CoNeIb3il4A19LgYJ17QomY6FycCV2doJqJX3heHY301Y8JqKd6SKNUSz0UhGDPkF910EmroPOsmx+YCVdAkbUd1JNnQQjJ+7TzvrqWgFxroCHvABWHH/IL5hkzWht5mJS0TAjQDU277CvZ/E5i3QZcblEd8ZtGz1Sj2IuKuKX+vGSgGsOVSrRUXySS3AB1IE0AjJMwlMrIHqjmch4MLoP8sUc/cUCXTUlb0l4kebBSBVp2gnEF57NUxwxiA77B72Dvf3Jbi/uHRz0+vBpd7i3N0gmg4O+CB4eOu2+mMiUfPUr+HhYddu3RAPkt8CcZYVF3aKmbc5VzE3M7ELl/Atz0ybO/lf/2GFH52fsohx0XOeT8yqIbr6f5fncjra3Y1Btihm5a7lM51qqvBvpbBtUvc3ncrtcLKzzUlgH43dOUOAs9Hy+vlbX6m35FJ3TFvO5NmhiTBhNV0mkSGNwAxUzVxW0sSOksLWVcptDzo+3tkZsKxUdIIX22QqWLVQOYqlgg95gJ+wNwt7uuN8b7R6OBvvdQX/4S4AZGbiba2WFRcUPej3811T3O4jwxzMu5qAIq4/KcSqfz1MZURHb/tXi/Pt1w3JjOPqEzEVml57rya+gSExqBoXOpeMKMlerc66msjqDtbLKvs81xk2BavGxCZ8NeiZZ4A23MmJYQ193G8o82Ev6cbSXiINkdzjsDw93e8PdYTSZ9PuD/YOEo4s6/34Jm7TeU4x22TFXSufILLk1TgCGNXwxjyUMzA+QkBdQeFCopgA/61j8eMHOwExThzCQZRvpuWgxC3oTn+DE3BRi3Uzr+QERAFGzmCfXI/aC3q0J3ZR6meMrIJDpUWsqC2mlUSKNzYmJZwYCWNIqBvzRcZWwzeGa7J63ug9NfmWritldc1RH9TkfeJr6yfg9w/mkDlVkqIuzk9Ofx2fjfyI+qo1aPQXBXhIiL5MKoqjpOy7X8+FewnksxLDX30smQ9HrH0SD3t7O4cud/2kGZgUUsBCrFPoei6Wdp3xB0dJk6MKlTawxAXBMz855/p5sC88ioJGLVoVAlGcc/TWGEWEuM9EaofiWUi+O6LAYWARmyXczKL7SeVQHIJJAXAGpvD3h3EHQem5WdAoFM+zth/3+uH8wGu6Odva7vcODX5D9MnO38b8amX+APMieS6FAYSoU1ibhwNlyBiPgjstBmczmsCSEP6Y0wPKsmMcEbKDwQo0FhH1+NAaSAF4cNNYqXcCfCMgC6wtPzIfaAuCV8mk8KVJK3M53kwUWzruZjGZIEYqngWSrWarVFPImgEcJFX3h8z9owxMykEBuv8ZCHmgtGWiidSq4Wk6JHtRUFP33pnEQMKIhndKdkuFDiQ0hm6ONLgB/nCP+YBAROdq8Q/xLp9JbaSVGjMe4mP3hM8CMhEeiy96CgjwXHfZRm88JQAzrUKRzzuewKKoYqVrsCco5dyWlLgVijeauAuo0KCWUNabMvHVw3tSx+4Noa3M/eFwC1B9wgWEbNDlOJVienRoDLIbsg8gLg2XQdwUe7rOJjheoLalueSrjb4Esj0CTWORgnGMor8+nv7dSiRDKr0QOBbEcwUR07FsZo+9mGjzWkSxrJY1ruiZootsHsBKDvE6+Yy8MJkTDo89A6+wFBeFSSZjPyikQRhUQbVlW7As+2esdDobJ3pDzwcGwv787OUz4zk7vcPeQ6gCEO4axbQEVzaV/wMQBYCvV0CzJf4NCwC9A98QALf5yeEg0Xoi93NhKTM8vw70TiCn25vicDfchx6lpQc/5dEUJKry8WEvEmLWJ8Hvo8KRqY6Us5Senb48u343hyYfTv1+eXsAnpLW28XEEiUDF6JbAKvjCTN8Rx14AzMRWYNuBvfeWp7oFAnFllwdK980uoEvPmM9OMMOv3jJjmTRLjM4aoRS5jSb2veyKLqRrfAYlCFLuhFuX03H4FkbyPA/feU1usRkUdmFed9lRHEu/HwPRCERh/gLzMI/julNPCghlQb2vhpIAeU5GKzigVuVqWSwzy7tlo2BwAOfP+8mR22UgMZejsPIWz6K3D/ZYtE6Tu/GS0kil2JJCCcLNAahh2hjQMJU7CT2sT0fUFULiUeW4KmMtgx1Kdz85Zk5yTe8iXtgXxN15CuknJNGqF7fCBx8mfJ+NyBqlmXxG8oiBJvtRlbnKwHd96yZ2N7G7id0Xxu7qyxL4+LcEffrr0OdS8QL0a6h4rkEfIxw6ZOUggjfekJ2ljdMfP45r3Cm+zBHD/Y74yJXyNeaPKnv4LbpyB68s/bUtkEHSo5MggUyEO574uObYgURS1c76aoCAJxIcVLVARELLC11Qs2AKpZATbjvUsahXfl++wsMOqAsVh25DcIMkN0hyU4021egvU402SHITu5vY/d+M3SeRZMUVRYvHSbbIMm4WztP8e5SWMxjAyp8GWRVyZKpVtILEWIWxgiZyCCaD/qSf7EdiGPNhvLdzmAyivQHf3e/v9yfDwX6wXOuv6jiugqwZU0v2dnYkFQOIuwUcVyhwLptrHTe3/0C9RiSY1jD1VLgZdA4qvamw4+BwHTuOtWY/cbUoEZJtYEhV6whzGozNcKwpx8IAzqaQFxXurUrgC11JZgKo0L55KjNJwYtSAF2zCI8S/HHbBUp9bsGvIlWUFsAhZQLc2MZ177jE3woTxHxAgRDsFLLz74hOvYl+E5JnH1DidygxO/0SCYGBXiH33bb9XfzB0mCOuHAGfmSj13U7XIEDQEPgclaFOzf4fIPPNzV+U+P/GjV+g883sbuJ3f/N2P0KfO7R0OP4HAa8GJ/D2G6PVVjqLR1Q+G/DdAoVzwG5N9NRVBjabi4xOOEKcCVkaCooh3A80B5st59pxfMFBAwdT4VJYWx5fvPenb9+6PK57Janm5S+o0OcE9BPS+rBMwIuzHAAHRd1C3RJuUai/7pkR8SdqqtDcOU50Scpl8f/Frow/ox4B098eV+ix8DiHBqJV9Yff3qg87Qr8oFclyZ9+O2yOEKPyNKmvidXg/EMOF0REUW4qS8uXCDqdquvXV+oKwl2aoO1xd7jsAF7I7iBlsAf7fzx4/h1dRwp9meChaQTk5ytXjfwJ8+wvBhdTN01gaPGTyUYOwwPuODB7gsh2NWZV8LPkOQ/QFYmleIkQYkAZ7389DBvzHtNtY6aAqncoS542r1WITuRxh0ududwvIjU47Gr1gM738rEd+1B9nqFC6faq8gdvYkggJEETy1p65sXd/TCJXrYQcETpLrKgzuRRHw0f+CKSqt9Mx8NeiHSa/JxrT7SCbPmNObyVnmX4IxFM62t+Btj6DoYBlfTAqLom9miY20hRUQ46C2xFLolQxkCLCT+3kFgKOdMfIJlmVCJBsCmYheSn8iyEPOf6BzZp4bM9PgKqieOjHX0FUfiV3jGBUNcMHQ5wHr+XXFCx8IjmXiGDIPeOcBxbX/KBJ7RpbznaLVmdSK/TXPKo2dEpT6dXCc4/4mVB9SaJ5gBVVc/+eFNH08LK1RDWeV+wKoG1/lNNRTGFb05fqv9KCyWfzZ5UeKjetvkvUoXv3eWfiST/Hny7h+U8TaZ5q+YaTzORXejZX1DsOzkbzxeW9/Gs3QhBP7CW4pVgtTQsNSXHZcJlceFKaqjGV4Wg6ZhLniO2K+DnqUzikTo1TH8hXWEpnRK1wDLHFo2meJtB9yiLlfmFDAOWKJd8bstqAvBtaIZNJSiyz5CT6YiMAv2Y3jIAt79qn1jVp9qPimNDaArywqFtxCA7SJjHFzqGY+IpY0Kl7igPVOi1IW7LFPNKqMYXQ1F6FJnYjL7PsG9ZWhblwz/zFpgd+s3lkH1aEV/ua0W5INIyTNxXBO2P0cbvC2ciXROVwGALTwCXa/w09l4jSIQUxbkgs5bm+m2n2S3cSwQwfbIuc9Ot9/thdQuwPO5tjn0sEvE6aLXIzdzV1zxvt5W39zRffaOrq+U2OJsz3FfDvVfuJbLdbhXwSMdLvRMMzAUjri/x80bbPke8LG7WIl9L7gOxnPcfsmgaarNhd//uwu/rd73WeCu0tLNcL91FAS40/Byj9rcxX3sLu4Taq8vQddav6k3ZSCo8bKi24ulCHfT3G7t0qy13zORSrWD9sMp1gr+CFr3H3Cph4f/ABiVWkc= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Query Parameters

+ +List of personal access tokens. + +
Schema
  • Array [
    • owner objectrequired
    + +Personal access token owner's identity. + +
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-provisioning-policies.api.mdx b/docs/api/beta/list-provisioning-policies.api.mdx new file mode 100644 index 000000000..0ddf57580 --- /dev/null +++ b/docs/api/beta/list-provisioning-policies.api.mdx @@ -0,0 +1,96 @@ +--- +id: list-provisioning-policies +sidebar_label: Lists ProvisioningPolicies +hide_title: true +hide_table_of_contents: true +api: eJztXGtz2zYW/SsYbWfyGEt+xI5jf9lRbCWrrmN7/dhMx860EAlJaChAJcjYqsf/fc+9AClSj9hJM9s2o0+iSODivnEuCPCuYccqlZm2phs39huJdtlpaj9phzvaDE5toiOtXGOtkcmBa+xfNc5tnka482GtESsXpXpMvdH3YqidUCZujq02mSBSTsgkEdlQiUVEhTaiGyuT6WxybG9a16YtMvtRGXGjs6Fon3bXhE3Fydnbn9uH77rHQubZ0KZoLTBSqn7LdapidBGRHwZ30akFZp2KcmoIhu8al06lB9Zk6jZrgwIJoWOzP66wBJ7B02Q/VTJG92WPR9LIgWp8uIfwY5nKkcpU6ngQTSoYS5Bfaxg8wD/HmuoSwYLZxn6W5gr8RUM1ko39u0Y2GXPbLMU4jft5pSrhNS40EVK3cjROqMdWtLf5auPVi514c29Tvnq5sbkTb73a3tnpbcutF1t7DWIyVW5sjYO5MNTWxgb91Ac4gpmE7c8baHIIxdreryrKyPwRKdBkRECOx3jOTrP+qyMqd/MCyTSVE1Jlpkauct9TrKnkyiuMdJqSO2ba8+vVOKuiWQ2Rd1VtJbytBPeuKixcLWzch59pI6NMfyJFs08SF7P2eAwzlTuk2CX81Vhj113EVwSHzBApMkLIOdGTDg4PutIUXE7EwFKHgntiOXfw0gtmdJ5hkyeJ7NGwfZk4+KIy+YiMcHDWaV900OLy9NBfdI7br4/o4rB7Xlx1jjr8rH1+3n17TK2Py0tP4ee3ZyeXpyWd8q/vWv4967ztnl90zqb9uoed44vuxU/TrpU7ncPuxZTy8dHJwb+p57/ax287P5+ChfcnZ4fkQ1OtlgLNhxQphYyzSOesvZa4Nt1aeloTUviIRroxwuXjsU0z8Umm2uYz1iuTqmuJN3CtwNOauBkiu0nxK0ymUspiMo59CiuIr/k8NpITAYsNBmjWs8iGXhgYPhZeOctHFB0ZDb0YXlDQQ/g6eAzlS7lIavRqV8UbSgSCNAijfNQDD96R3SJXpkweqz4kiklrF9xMpoo9P7KjEfx1yozbR5sgTFPwnFHhNFUJ+zsU8uSAfV+0o8jmmE+QoPo6UU/W5iMKKWZM/TiM6akMfUCmp0IQxTOmYDXf2DyJqU1OgUXdS+NQlAWNQDnXJmj98zxfjuOv5Tn0fUKmMkiRuL3UjZbxDpYzeE0vB103MVFNiGvj4/kBETqGssM3ULtiQgvVHj1K7biOvBf5Z09cOQLRKKx6bUJ6ekCwQ+2+kWSxp/QI0UK8JwrhlHrUMrKfKOIxgk2ROxJMPqkdVXzt2vxkcw5CkAhR18ezahB5nQH0TOjBwulPqRhuQ8BNZ5wOL8tZAVNEX6skdl8yX3/N3EyplloW82Dpna3a9Ac502MiCMayVBoH6UaLeFiQyIvmnEMBTCZ0QWOxhNVhSnJpnhAyKJmpCNQISefS6N9yJY4O26eiXbRr3DMc6Ms8IRxE/+o0Ps9uSaeCXQv/mkpdZzj4IXr/cNfXqcuIzfvWD3eJDNc/3OXM6wH5p0rvCaolNo/fyVsvxMFQRR/BXmNno/LsXP/OILK8d1bCsQZBVJZVu+ndUrqetXBnwwhOxicmmRSgti7um0QSKokZKcIvEQqQNCVEb2xWd4cqnm81KkouIEqhEv5PXrIE3Cyf6T/jflPsrd07DKv/K5N8icx/TMYRUW9+YvKPkPN+GrxvyJsPVSZ14gDMYZ7Kw4XYnZpQo+1FqP8g0QA2opOmYLUpzlSWp5i/hfaKIlso1AU9G3OtpQ141szyl9YBS/JHzKIc2PgRZnyD5N8cpJIQhlDMcoSOPu3FpPeRTQl3E8nC1tyubmdoorUpXstYnAX5DoIwPu9EH0GrGz/MUMgORRdA8TKQFwyrdpXsvdzY29ruv9yWEjXa5u5Ob68vX7zY2NvZ26PRR0D3yM6LEnJ96LcKE6GORGJR8yKGY9hKQvfMAA/++BzONB4ZRr5tKWbgV1BNTcD49cGp2N4ViTSDnO/LwYwSTPPyvFZ9UM6A5J7wCaCuXlhfFdXJYedN+/LogguH/1x2znFFtOZWIdqmCEjLqHVob5jjIMCNdMKpBOqg6ft5oPocAiEBVxtq/89NHJQpQqCiRxh9QY8qaT+nV0Mp8gsQ4qluqdYaAALujWQGoF4WddT8OdCJGmfNo6DJ52KILKvSZy3RjmNNQspEcAbxRQKQhq8htCfQzxHKildQbJ5RGtLRTL6bqrJujWlCOaoahYIDnD/sJ+0oy8Eci1mNwtJbAovBPuDZa67O3UVFaazSicmotKU1HhTENk2hYYGMKnTmREhHZC6HxGOKdmXGquZJTnfvPDM+QyKfydw9Iu5OE6SfJotWPvikQvAxvvTZiK1RmClkpABIuHNoVZqrCPwSrqxidxW7q9h9TOzOPjwLa50F9iHoszkPfS5NWEamyXMO+qTsPcYWa82/M7wJhuTl6ACRfnx/ERaradX7dlxA12+Ej/xUPsd8u7SHv9/jarUwVs0WxCDr0UvQRyZS8T7zPeXYg0RW1Yv50VDd9jQc1CyAiFSzUfXJKz1pbrj2lG5NxFY58yQLK0h+3ZIzYPXtwApJrpDkajZazUbfz2y0QpKr2F3F7t8zdj+LJEuuOFoCTnL5aCTTife04sUypJUCDUTx1l2UIcemmkUrREyUGKtRRw6N3tZmb7O/G6ntWG7HL1/s9beil1tyZ3dzd7O3vbXbqM71V9M4LoOsHlMVe3s7sooB4ujFRG7gXC6zNq4v/0G9qepTWuPl9QI3Q+dQ6Ycpdtyex47HNoNsIAzsmC5ZXrw8OyL6GNq/AYXewoufNKgOzWXGkJIXVNWtdtkKOq6g42r6WU0/3830s4KOq9hdxe7fM3a/CDpuPwQdt78AOm4Lglh9glh/JnSMgTsImvVhFMgQ5VCvIdg4hii4CquPxT4HmQ5UVgK9Gorc2ptHkRfWine0DS2AJVdbiTRTdVF6Q9sRtU2Ltpr23gyQIo1A1tJAt+RVeqQIk9I2j0SPNMcxCQS66aTZ7meQysdM4W/lKNpESQ4OOSkkltZeLXxMw51Un+AfKPA66ACJ+huucQZr/aH1YHFGEh+RxKJzGylFMV+u/+4s2iXQpR0llC7Ova2XbBfwa+a0X8mo27FPXyUEXUH1FVRfTfer6f77mO5XUH0Vu6vY/XvG7hdA9YCGlkN1NHg0VEfb1oYosdQb3vH5/0bsHCqBA3ZvYSPG6vEUgzOugCsRQ0DplEPoPNt+Y92jdbd+Vxxpu1+fPx7njwn6ssBzmacJeg+zbOz219fvYDwY7b4lx7pVnF4y9qYV2dF6DxpbkIxo76kPPGpAp/tC3dFidaeaPNqnPybulR821TYcjMDbDT5LudigzlvpPZk12jYcvItvg8UxSosnjlu32Jvm5INcl2ly/8dl8YSWyLJIfZ8dDe0FOJ0RkUT4MD0oeU443I8+d1xyOrfQG4CtucFOqNmWeK1kiiLBb4p5+uP7i2diQOiToz93BHyVpnIB8XMKF+Hs1i42iFAnnnBSmw+GzHi7tgWHokn0Ewgsrs25UuKqcjhLnCFPs0qpk+LUQL0+PC2sE6tPKqEZsTXVJDmejs06NLQua/2e8ezHZYI2tC+f77auTVMcakpKdCiH2wQRueoTV+NCLlmR62uZ+EdBrempNZmaezbDhVftVeS3dEcIaSIhE8fa+urBPb1mhR7VVLhDVGd5IE0EPuobp6LCal/NR41ek+jV+bg274caU2u9m/CZTLghn8fpimhorVP/FIJch8LgapAjir6arRsatMkR0dzaqLDU9EM2dRNAkfk7QmAY70yyRxM14xTrl0w4JH9hyyLmf+EDfr/UZObbV5hPqWVsI/fVPNOATRqw6XOAC/z76YocC7FNMnAe8A5wMLU/Z4LAaCXveVoLszqTX+c+NDVEYJWpuPG+/7M/TXDhSvADal22QRomnF1uJaNzT4EWn8GpKqtYIZjV4Dy/icVUOaM3z2/5npOmz7+avCRxe7qQQudvvnWWXpJJ/jp590/KeKtM8z1mmoB8yd142FAiVJ38dcBr8wt75QFNPOVYZZCNEsZ/woJQTJUQHeYrDytGQ614SWCsZEbYb408y444EgGvKfxR+DGhAR9LTMGyRBGnE9DjRetiZMkB44El2ZX+uzxsobBwSZSYqiXe06ncCGahCo027+IZna1lRs9hmVP+dMdhYWyArtEoN/SVAbCdj4SESz3gEbF2Ue4TVzjJ7EWwDP3KXkUUk6uRCC2uVdKRO+nTajMK2YrhHxgLdi8+UQHVV05zTgU5o4PAlDzQrg7bH6INb2sOVTKmGhFZFwBMVUZ4172YowhiJrzfsOlgPXRy69QWRKg88u7zorXZ2mhyuYD7Y+syVLUV4kf8CZUl32OZ+S5Fuc7+l/oOS5iSqJZYH9OSGH+ewtc2vri8Cp9JIZH2K19MWVxfomIZQk3U7e6OFlOo4Lqn27/liir1qw/TWopr0OKsdnnGcqnenhaHXZ/x66DqV1cWilGs/5nJtPRv4PKjohWDUhRU12CaF3aYIf/YL/1UOs69HKHqrCzH33bIzeSSiT5cQHiksv8BGMgcMA== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

+ +List of ProvisioningPolicyDto objects + +
Schema
  • Array [
    • fields object[]
  • Array [
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-reassignment-configurations.api.mdx b/docs/api/beta/list-reassignment-configurations.api.mdx new file mode 100644 index 000000000..0ec01d46b --- /dev/null +++ b/docs/api/beta/list-reassignment-configurations.api.mdx @@ -0,0 +1,119 @@ +--- +id: list-reassignment-configurations +sidebar_label: List Reassignment Configurations +hide_title: true +hide_table_of_contents: true +api: eJztXOtzEzkS/1dUcx8WqIxjOw4h+XJlkrDnvfC4xCmqLlCLPCPbgrE0K80AvlT+9+tuaV6284BQsFBTlQJnptXqt34tS7kMdCoMz6RWozg4CBJps1PBrZUztRAqO9RqKme5o7DBVpDxmQ0OLoLX2nxgdcrg7VYQCxsZmSIt8PpdZJbxJGmQsajOkU21YdlcsCg3Bt9qM+vALFbAA5ktYabL4NwKA3Jk4nM2zLM5zi5jdWBqXMMGV3wVB2+vQCIjbAqCC5D5Muh3u/hfU8ohQ52ZnjbFbCpOcnKF4oF0EQoDGgMvnqaJjIho+71FhpeBjeZiwfFTtkwFTMGN4UsYJzOxsLXnevJeRFmwarcx2KOQm010vETh+A3iOemYlWqWCCZjIEDbbQWpQe9m0qlfvriTBLGYSiWJPU6v2MgPZzyKtIlhMpZpct4NkoHrPspIbJClJoXNDHDbKMXoCGfHSUpRxWe+SBMc14/2e0+6T3aedDnv7u4+6fbwE+fT3v6gO+h1g6utQPGFuH2qf+ULrkIMGz4BE8bSpglfMhx8w/yvZZJIvmDwP7r+CqYDA9GrwlhhH4Vw0XkkMg6UGwKjKYynw4nn+hP7hJlm5zpPYjbByHDGFnERlKPK4V8UYX/lAgK/CLAbnFgI5MMsFZGcyqgMNJAh9mnNaN5VZ7t3YxLpNk8cq3xRZuRHnsjYGQBHWXAEhwoCOoMhrEhAt8IMN8iPPgOuWDeGh4fHZ2d/nh7/5/z4bHwGbw6PT8ejZ6PD4Xj08gU+eD58cT48+XM8PPv3Gda0yt3rgwtvH5YKovjo8YybmchGbcb9oIyz4IDsiGd3kIRMD5RsavSCfZrLaI5mJg5ltqHtKQ5dhm0FEHQLDktAgEPDTC5E01Ddfj/s7oX93rjXO+jtHPT6nZ3B7n9RNqHie0qm02sE6zA2QuNJy+AHQkgsUogfxx9ImFQxLleQSpxBcIAPMILqS2nnduW63W4vpJ9xt3tAP6QYz2OZrVe5a0J+iNQQ9FVtyeaiIcoKVnBJce3yFsFQKAe3m3WEScYTZ1qsXaggmFcoLwEmG/vELStY3svdnsnTtgp89yqw0DGsVHeJiRMOK05BvhIZVWii/e8XDMUUbTR872ioPR7W61T9RcNqnuDUI3EgvI6yToJEg019xmEi0THHxkA4heCtLDcI4uTUB1cNjmH5VgR+Ol/RbpQ2ajrbVdpDHd/BE8+kEuHMcIkSChI5goEMOH6UFHQLbYQv3oVviK7T8A1YotNjT3kM+jr9Dr0yaEvDow/Aa3SHKDxXEsazYgisAmVabphW7Ak+edzd7w+mjwec958Menu7k/0p39np7u/u71MmCmv5TNwOx38XShiAu4mOwCP/A4PgGuW7Lpr8JuDd9AHxuOPK72hLNb28DNvgLVi9nx6+YoM9lnA1y+k5n60YQYXnCFJVniSYT8FBZnIBmjvGL42cSbVJlAIsHx0/G56fjOGJh7zBFvJa6/OHqoAVIKpvWrJKAVxIC6zeYY8810egEFe2Tijdb3ZpwZhY+XieZDDCz75hRJ21A0n1VIrcngF7IDuiswUtA5Z4ngGImnALA7Rb7x8No0ikWXjiLfmIzaECCfOww4ZxTLUXwAJkIzCF8UvsPXgcY+o6BtMcUhmEkRk0aRlTOoNa2/RFZcqmN6qCclJ3CiYHSH57nAyjLAfhSM16FpbR4kUsYF/sLdeUrt4OkkmXKuMRaMGTZAlmNLDyQWUC3WRmmS9H6C4LhUcVdGXFqtdJKnfPnTBHmaZ3Ec/tHfLuVQLlJyTVyhcfhU8+i6ueq0bkjcJNviL5JZEGe6rSXUXiM1iHk7jN3TZ329y9Y+6uviyAj39L0Ke3Dn3OFc/BvoYWzzXoYyh6lGYFkcOszpFbDAziIdIfr8eQ2B+gTQN68TmVRnxLfOSW8g37w4U/3PMJQe7CWQ1foIBkR78rC5VIxAckdyWxA4lkqp312Z5pM5EQoGoDRISqadhS54yDyUyuqPfndovFWlj1W8bmHOoj9AUgr6uAOKuKw1RL19e3SLJFku1q1K5Gv8Zq1CLJNnfb3P05c/dGJFlKRdnicZLNFwtuli7S/Hv3xTgQVN+XlylHrlpFK8iMlRgraCKHYNLvTXrTvUgMYj6IH+/sT/vR4z7f3evt9SaD/l5QX+svqjwuk6yZUzV/Oz+SiXEvFnBcriC4bKZ13Nz+y/HbmCmWNSw9JW4Gm4NJ31bYcbCOHV/oDHQDxoAdzTXbi+enJ8gfpib2aDedm0ggzHamc9+xIqTEGAZLS5u10LGFju3y0y4/v8zy00LHNnfb3P05c/eLoOPgNug4+ALoOGAIsaYIsX4kdIwBdyA0m4JTQIfi6KwRKagCn5ona91JtBLoNVBkf38dRY61Zs+5WhZgyTZ2IlVlLixvQLtAWlPQAgFnMyiRCo8XSUC3GFV4igIwKZ6qSORCUh6P6chCZpbhcJqBVi5ningrZ5EqSnKQkIpCot1xh09cQjiJKcI/4ED7oDMo1N9wj9N76177wewUNT5Bjdnx50gIzPly/3d30ymBEQhvsFycOV9fc1zA7ZlzBW2E+Jy68lVC0Baqt1C9Xe7b5f7XWO5bqN7mbpu7P2fufgFU92joeqgOBHeG6kDb6bISSz3D4PruiJ1SxUtA4c10RFg9rjA44QoIJRQIUDrWEI433ILt62+34e0D1wk4wXKTwIB5lqX2YHv7EvwFfrrq8FR2irPySn/qRHqxPQEjbag/7rYAxg4SsOGrkW81OmRhIzGIXcUj5s7epBOGK9idThjcyLk4xLuELoQ5Nlt4qccHFD0GEVPoJn6zRN2hAFrTD/Q6N8nV/XVxjK7RZZP5bpwN6BlIuqIiqvC2us54htDbzb52qbFaTnDTv7822Usk67OnghvoC9w5mAd/vB4/ZDMEnJTwOV4BZEJihwAp8wpChArasDgTgoNojTE6n81J8GHj1A0mEJsmoDB7o86EYBfFGeoXUOlPoTSTSXGQoGqAo94+KLwTi48iwUWwU1kSA0/GahsstM0b4x7SgkedgVTuUD087bxRITuSWIfKq5deRWr02EVa6MVren2tEP8ouIWOW0jc7MMVKZxpLyJ3ijuCLEYWHG+ugLW+enLHL6zxwzYKniDXVRnQEl6O5lmpqPDaV8vR4Bciv6Ycb9Rrun7UHMZc8SpuJ45YNNfain8yhqGDaXAxyyGLvlosuvMUUkaE/W5NpNBNGcoQsCHJdwKJoVww8QmuzQRNtNsloZR8R56FnH9HdzveNXSmxxewhCJlrCP71TLjhCFOGLoaYL38/qYTCAu5jTq4W0sUAIeV/6kSeEFrdc/x2ljVif02jcGlIQJRiYtND9wvB1WB858YvUDqkgbKMELr8vQYXtz2vK7oblfNWMWmwKoF1+VNNKyOK3Zz8pZfbeKK+XfTFzUeVnsnL1Wy/NZV+ppK8vepuz+o4rWV5lesNB7sYrjRtCsXtDDIn3q8tr6Xh5vNcwH/wlvKVcLV0LVQH0Yops4oTXiGUU1ZHc2loF2AVPAMsd8WRpZeUCZCw47pD70eMZrRTU0DInPo22QC/GifupiZU8I4YIl+xd9t7k9NaAhJ6CpFh72GxkxF4BZsyvC8Lrx7r313dgaeeYWOZUeFswF0LRa5wkt9IHa+YBxC6paIiKWNcle4oDlQorCFJuhXjiqyGEMNVehQe2IW9uX0zN8JrBx/y1zgd+t3l8H06EV3qy+oFDkVSdmiNGH7bbwh2sK5SFJsC6HqCrxNV83wfDRe4wjMlP9KQ5vZth9kt5EWmGB75MJnp9PrdENqF+B5qm0GjWyN+Qn+sYEb/vbHajxeVhvs9/kTJ34dwQZgO8WtK5Qudw2JawIvgpuaQGgr5qALkl1e4iYHdkVX+Biae+ygL95WDQ/+BuzdZgd1jR8ENdm0HVL10etfGGD7Uraovx+jH/g1K6H/gFNdXf0f+LqH3g== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

List Reassignment Configurations

+ + + + + +Gets all Reassignment configuration for the current org. + +## Request + +
+ +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 + +
  • Array [
    • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-requestable-objects.api.mdx b/docs/api/beta/list-requestable-objects.api.mdx new file mode 100644 index 000000000..b952f10d1 --- /dev/null +++ b/docs/api/beta/list-requestable-objects.api.mdx @@ -0,0 +1,84 @@ +--- +id: list-requestable-objects +sidebar_label: Requestable Objects List +hide_title: true +hide_table_of_contents: true +api: eJztXGlz27oV/SsY9UNfNKJsyXa8zHRaxUuqjhOnttO0dTJ9EAlJeKEIlkscN+P/3nMvwE2L7TiZNn5PXxKLxHL3ey4A4kvLxCqRmTbRMGgdtEKdZufq37lKMzkK1dnoF+VnaavTyuQkbR1ctWovRfH2Q6cVqNRPdEzjYJTLqU6FioLY6CgTicryJEqFFDS6MGMhfd9XaSp0pmapyKYys//4MhIjhQ48hwrwNDH5ZIr/lRjYPo6Acvi0W7yxo8lEiZlMPqL3tc6mYvC3wfB08OL0uCPeHL8+Gr5+KUwiBhcXw5evj49sm0SlMTgRmeGZdKCiTGc3Ik7MJ/wIRJ7qaCLaxQtPB20BMhI0kYmcdd9Hg+hGyBy90cCXTLv5qCJmyZdhiIHrMsFMqVI0m04KflmmssYLOHOjMJVn5y//NTh6NXzNE5mEKMSY1FsnPOGKmawC6vJHK/xHvK6aW4whJWpgkgkJjH7KyOBJUsqnC7tg/lWmErKOLy1N6mfJ4F2EN/hZkxoeFuS2DsYyTFWnlfpTNZOtgy+t7Cam9mmWQNqt205LfZazOKRnalfJ0fPN/f72+Pm2lP297d7uzmh/LLe2Nvd39vdb8yY4HEN7KsXMHWbjkwxzVZqiicKbBuvGmnLJNdmDHmtItWT2fSTaYhDMdARzAL9zqmUVSVhBaT3DIzur7fnaRJ6c681k2KluRHum2iTpWKapMwxzHa0aDvzJkWVviX+BqLu4y1Qko6wrzmj+eaJm8iP4z31ww+x1xTCyLPoS+uIB5CepQxq6I2JYGtTVESBbTyJIzJqRIpGADtgM+bSM8Af7hY6c4aV5mHWh5uVWQ8aQLqj1RIdka7UR0sJrK5VR1w3u3xHXMFgllAQ79IQcxkSKhHR+dnrMoeDw8Pji4l9vzs9OhqfH3bpkWbk0DkcVK2cVdMVFHscmyaxTBIEm4mTRdCZvmOEgqJgd5+iq2EZMnpFMtK+6D/IGmSSSxMJeueglcJIon1FkbvKBF8Qg/jt+fTm8PD1+hf+XRWol/DxJwC6ZouULdC9aj+WuK1p1t1yYE5bKLxZyyCVRfdvwaaKvszCC+hyHJlBOICutQyWzRweTEw3z95U4N/i5EDgyUru5ThGgZeJPKfCvDJLW6SkJZBoGMJMZ7MxYnROlZF+14dm4iHQywyK5sEfZLu0xm3cjt1BstZ4Eo4KDGbC72mtAZAZXfojjLPqN7bxRjNFwHvuw5j61vFok0w6x65IsWM2oNQKKShKKO6aMdBxM6sxZr4AGyzYkdXRtZtyyCxJj5XUFuf8/xyskgWeOe/xVCKXVifIwXHC8CydPBE/ABWKX4+pIhxTrKYZHhak566sysvNHQ9zOZKDE6IYkbwg8TWU4LnJ7mToqFaNlQ6Zd0S7JbxfUqLQ+DymxCPcWTTA56OmYXd0vj6qeI+VLqKlJ2FRS2nIppGQUuhuHejKlOQoxfsMkMkyUDOxk/MINhChnQnZRJ2h4JBxQsZc2LQ/TUB6r5PgTxwj8wSnc5oEyjT5zLu18pnDeuqS5B2dpzmHdZlStGdTKgOoeWDtykbUeOWsDXtWMsbTQD6tCSKhnOluIH6/kZwF7H8FfYV211GuzIkDJBfDs1d+2xODNUICqKJBJIA5NGIJYjCHelEjxw0/TLIvTg42NQH1SIVUg3RQqZMDa9c1sQwfRhow1hSIex/PLcbwKcT5jMc4QEaFT/DnjOmapd5ey6O9sLvF1zKsmKkFPO4x9tNXHA2hVz8jR0W8mP9u/eZRAjSWkwL9uV0nTjMepWhTnGT8G2S4Ij/PSGJB3YPhv0xz2UXddzjVt1k6bBB/LCfJYphpFUmFPT0Ud36CMUvyrhe+bPFqUPXl3luRA2zqzzhmbOA+tKOGmf/cuAVVD75B6t7k4NBGCyhRRxKUrm+AX3YGK2GuTh4EtYy1eFHpc6g3yE21rE21xTdm1SOnvI+hMEyxxYZBTIBQNUgQzwuh8Kj8pDpkJC4fa61ksfaBVndlyEBqbIaJiYopZXGnSrG0e5A/MeZtoYmptXVRH6ghhjponYUHEzxIjGhnEdhm1anZiAeUqW7HQi4DTgzAko7v0WrzHTKP3rRV4q7QMu4DAcKuQZHoTZQiqttvIQpb/rbh/Z3kGZZ6j8xnp/aR4SuZUlQQF/BgbSn30GmEpDFK2abuKZJL0gEZoI3u22weirf4Ns4za9hmJrPa0A/HhzaJyV2JbouNODdUiBjmB9FJF3IJ6Ut5qG7IzLEA0KvF+bAWSSObVd2GfPUx50IbTCzRx+4GEZKMdI97+5ib91xTLqVtkWLLAABH6BtEbQRfdZByHDG5NtPFLSn2/PBxl2xFpgSkh8WTaUqSDZVqfi+/BssWtAjBmqQrHDbjV9/d7e5t7WztBX+30nu9t9naCrf54b3/Tl72dvR7ZjjXB+2b+c46I7BHa5CkDncYhihJbCa4iqQn9SGbQ17my1adb2yQSfIxLlnyX1Qdo4WWajbnG4GZv19vc9Xq9y97ewfbOwdZud3N/758L9NNqAPWmwi9aJcFrwOiCFpA1MwHjE6KLKh1qWkTlr6dzz9t87vV3LvubB/3+QX+v29vc/gY6QwlbLSm8nRvnPnUeVb9Wq28OuttKgnGx02Atk3VA0KgIKR0OnNYhUJVyDdAU4G0hwae96GMjb1WrUGgIw7MxLxivi+p1Uf3DFtWd+ZB2i6q53M9wjYcPSUngveEEzH2p686cHnSZwWSaGl+zXCFPrgKA9fUnt/syH3BLdukFSDXXkUrO1XhZYp3v20y0qwLPkkBMy+rlbgZUMjzi6POPruB9QK5JZODR64ZGinYtlulD8rqzPR00VbssadeT+ndL4OVe0D2cDUINvCNOVDLJU8OFwwzedP/8x9SMVjATcp2vmFHyjN2xnfFPRbfU4CHwJK8PFVY/LO0XzRUqyHeoaF+DxUEUMAG1kH3ItWSWnpfYeWmFVefh3VTxLmEtXeLXLEcMckvewnej2vxdq3erINTQcFG5rXZcMHhLDbaXIdZDQCo4zjGvQ3vAVlVdXiNSjEzAG6o6QlFsbexr0ewK1BqoDGI95MW5+0zgREfKmyRSE4V26dxHRyc7EhLXx3bIIkxwu6ZTQBLdnnghg3LH/NAxQ3JMpP8RYz0kdr2NNPqLogsFpyJpLpn23o1agowwbjmpx5myDGhO/VIhfGlfhMaHRv7DEEWSZxEBPPnDKwce44EhzbYt2XT0ikx9pk1B8eLwjdjeBZaLJjk/l5M5IUTe24tlcM4OfJboiV6KPwv0c3R8Mnh7ekl47vivb48vLlcAnkFUZA7DC1FTc80UOwYIAqPcgTho17LtRm2DIRml9Yba/kpv4Ksz4VZM0MPNvqRHfWgxTsys4UrsN58z8ZPuqm4HSYFgOG+OjWTKCd4utRFcjjPv1Emy7dbYnjU2eHiJ6iu3dypdVKJcqE5cMDmtK4WcA5TfbycDP8tpz5fYrHthaS2OxAoYWck1qbusCY1FSmsKPh0hocVf3wCkA5CNci5chQtHXNoj8ERFuzJi1WMkh7tXlpijzPA7BnL3+92bEOHHY9bKF5+Ucz6ubopIXtv9dhHJLWhz5/L8jJNF4fh28WHtu2vfXfvuA313/uW5W6dzbxn69Bahz9vInRWj5LkAfRJli7DiQNl/GN44RfJuvoNIf3l36U6i0dGyz7HmQwjfDR/ZVL5A/KDUh1tjLSBikforXRCBLEfLwRiRSAUHTHdFsQWJLKqtxdlOTDLSMNBoCUSkClTcmNyeA8qjiDdn0o4IjEqj32duW6Zc/CmO4Hl2RXeNJNdIcp2N1tnoV5ON1khy7btr332avnsnkiypYm9xOCnNZzOZ3FhLc+95N0WgQXU+pnQ5VtU8WqHBRImxWk3k0Br1e6PeeNdX24HcDp5v7Y/7/vO+3Nnt7fZG2/3dVj3XX1V+XDpZ06dq+rZ6ZBEDxH0CjssjGFeaGRM0l/9y2u0f81HSrILE0B2dUv9QYsf+/iJ2vDRGvKLD/w4hpQ0MGVUyopiGtjNqmxRtNX2bMUFcjOhcjzZ29Z/2Nz1BpxcEHx4i5yUuMG5y4w3GtKrqjiRVR+rtLDrywxwUciQIDaFmA8PSdL5nTJgPIzCCnSA6f0d06lT0TUhenBPHp8SxOP7sK0WOXiL3nWXru0MQn1CMuLAKXrHQa6sdGcEAUBDYmFXizjU+X+PzdY5f5/hfR45f4/O1765992n67lfgc4eGVuNzNHgwPkfb7qYosdQJH5r+X8N0dhVHAZu3MD4fVQsqDM64AqZEBE3424pYZlP82KgdYPOqI6kW9luC8iREw+L07Rf7IextV8a6W5yZiMw1H8EdQThL4o49hUE2Qw34sK+doMuSTTTNbiMdD27l7I6gt8pTvneOXJw3uTF54j7W7dA5G2dI/Bgkxqgifp9y6y4bzgJ/4OttEt5+Oy92oBW8LBPfnbOhvQClcywSCx9IXVA4BmJ9vQU9hzZMDXJS8tWHepsLguWWwoWWVaqhUq6/QNAZNeuLF0omdFqFdzd++su7y2diQmCUg4E99a00H2iR4g3MiINdecyTOnH+qd1T0NhLIecS4xBCEe6LiuL4zWtkgXOEbRb7oLo6AL0efj5cNvqt+H7ifeSJI53Y4+P2K3DHov3G5Cou+JI1vh5LxO+K0Tw7msej0dn0BhVWtFe+PZvjw8NpCBmmLK1HT27H82rjUYmFJzTqPA0kCUdHcwfML7T2aDoa43k0XpOO99G7qaZv7BvdhA1sIp3yR0RD4U+NSdUfhSDTIVe5muTwtEeTdU2TeuwRXn+zRpJnp/S0B9zI9J3CMSJrTHJEeZthiwGiiwLrtj+zZhEXfuajzD83eObHV0iv1DIw/ld89DBHM03o0YSejROpo99mLzIs+DbxwHHAGsBhpX+OBI7QWmx0dyAsi/w8/Ab3ofThm9iGmDQ+sD8OqiDo/hL8glqXbRCqCXaXe4J0MtWNRSmsIaxiwWBegov0hgaZc05ult5ywYqy6Y/GL3E8qNZV6OKJ7x2lV0SSHyfu/p8i3jrS/BojjQPCZG487dzZXjLyFw7TLa7z2cP8+Bdv2VcZc0v6aKb4uLU+UBzKjKyavdqfasUrBLGSmb0CBkyYGXsiivny7hcMNOHPhBKQLEP3FQavYRczS3YYCz5Jr/Q7zcsvMfwpKk7VFe9QtEU+1EIFG53CwLtfjKvcLqCZN3zT0VGhbEGnlvOIjoqD7HwmJEzqHosIdOrnNnChfotUIQt741HZq/BiMjVioculSzJLz8a0+Iy6tqb4e+aC3osv5iB6/n7KfuhYMXKuQrZMateE9veNDWvzpiqMqWRE1AUAU7UZXg0vF0bEYFEKvlCam2Sy4TqlG9QWg1AJZc1nq9vrbnpcUuB5bNIMRW5t8CVXhAn6aHDeDr9Ui+7rG8N+OzeGuXxPhdpGTMuPZEW5LS5tIX/VWlbIo+ybwtbo9ZcvtEBFle0tPbbfCVO5COunPtUnvisNbn0/2BO5H2yFwXxUtN7VvFrOrWu1+MOth5vCr+1OsTvkVVyq9khJPY27se6WgL047LuZym/7Fq07BF27ieyRwn5aVw7dIYriRqVHyuG3dVfQHXIs71J6bPhaX/zz5C7+ucMcitudvimW/+AXvPwgN/TcoYXq3qRH6uE3d83O3WmzvOSoEueHajOON8BQCHFE4pLHdrNb9LVeC4fYaJRy2/TlMWr62/8CAO9JAg== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Query Parameters

+ +List of requestable objects + +
Schema
  • Array [
    • ownerRef objectnullable
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-roles.api.mdx b/docs/api/beta/list-roles.api.mdx new file mode 100644 index 000000000..86bb5effc --- /dev/null +++ b/docs/api/beta/list-roles.api.mdx @@ -0,0 +1,141 @@ +--- +id: list-roles +sidebar_label: List Roles +hide_title: true +hide_table_of_contents: true +api: eJztPWtz4sayf2WK82ETCmFefuCq1L0EWIcTr/EBvHtznS2fQRqBskIiGslesuX/frp7ZvQAbGPv3mQ3lw/JYmke/e6enp7Rp1K4FBGPvTAYOKXTku/JeBT6QpYqpZjPZOn0uqT+fl8pOULakbfExtB0Mvck61wOWCTiJAok4wx7s9Bl1KP6a/Br0GFx+EEE7M6L59i4woajs5tO783gosJGw/O++R1G6s/x1Y/0hPEknoeRF68YTBOJ3xMvEg6Mxmzu+yzWk1cBziWP+ELEIkJoP5U8BO73REQreBfAG/jTDSNLJlPuLOBtpSTtuVjw0umnUrxa4nsZR14wK92v4zhw2TIKbz1HOBXmej5OAnMLjTMARChz2w4jB0ZA+O7mPEaYbz3pTX2Bj7CHFziezWPoUsRz4IggBjSrbAKtbrmfCCQhdkkRw+EEUBB+8SDtwQY9ohs2lUthe9zX/cvlhSiXKwCKZ8+xswRSxnMeOMzVHZCKCLAZ7JWE4aqsw1q1GvuRA5RAcgG4iSgKI8UDjbKnoCuX81Qtl4vgEkCuJ9SMeahjTZ8gBMIx0x8ZKT7yxdJHfhzWj05q9UOn2XBP2jWb1w9P6g27XT+pnTQPnYaAxkYkSqcu96W4r2znvO8tvLi0zteLMBYKEEUPLcmI1oJ/9BbJQlMSX9MQCPFhDWR6LAS7ftuk9uMYSMojh3VD3xc2Ds4uU2l8/908jpfy9ODAEbfCR0WrSu75y9AL4qodLg48JzjgS+9A6nEsOx3HyqT6e4JiEUYoRPBzQepa3aRBjoKHtS1SDtOKmYigoxpFPWo24AFwALEunUI/TQE1iCNcnvgx/nH/EI1D15Vik8hDegwwaw1wE1DcSEgYjsGLKruSCUjhKicrZCbKRPAyKs6Sz7yAE6+iMJnNte7hEPKb4cVnsCKl/sPEt8Mk2KQ9GK5yHCWizEB07zwg/DJcJr4iJeju/1iTMOa+1cXeZSTpMgykYHPBHVBg4gM2DJLFFP4Gg6SprrTmLkx8h01FwSgYvqGZKSuZKLM7gaSaBUAxhzzC2AtsQQYdrAtaIA6MBlAYIQJ2KWBzfivgMfCIiIPtvcWS23GFKUWMBHBsIQIwy2RGQFKkwFnLNMgPhHlZGSqAVqkyUQFbA9iJNNB8ExKE+GwRomkIfpYHpZycKFv4kKxoD/YcD/iauqTcTyR5OfQ4hlpyFcT8I1PdpigKwZ9M0n8ovAAyS8P5PfL2tXlK/ihZLsEHiswDujBUeIevwfT4jiS5VdFQGMlTHKFc9pxy+ZSVxe8gekFZPUNipk/lnX5qRwK9O72YgaT68N9MwL9CN1iEDhm5h1uEdwFQYNuUWl04xBP6ZbngL3PvmfidkRTs7iMlEuZRsciZKdQ8bkmB5Ad8NyVmDKN95fKCCK9Ly1g9201WgAUkBhWm2V5hGXsLnKFWlnm5O08othIzMHKx5TlfijcUzwqwlTFJO1pDsVjGqwrjjuNhI3LIJtKlOF4FsCE4BxVOcrBcXEqw6SoeR/qMFaTfgXVLXUfm1Qc9tRiA2TVKZPOQ1HYSRfA3zJkE/BZ4iSJc0X1XSnagWRZaGsECoQFPQcFpMXSsTQ/ttts4tE6a9pHVOj5qWO3acdMSzRP3eDptcNE4qjTEiXMC0aTVaE1tq+U06la7Ds2Pues609Zxc1p7Bq/Ao/mJI6wk0OgRo3cx12jYN5j0bi4o1AfZI+emQh7ln2m5AdE8ul87BEICHXLT6pUXQ/e/JkFlJDefEu9hZM32HKHLW9AAZy6VNXmS8NpnrZPsPT5SwEukRaNWw3+KGJ/n140wKGIG82NDvlz6uG6Chge/SWz9aZOyPIo48sOLxULmnofT30D5N4KjDk2EK8cIbUjsKdA8Z5tyrS96wW07ZoGGw+C6DShLdoEtEknxhS/cGGInCDju5rD6JSNBsU5AfWDZhhy+8yTGOdtXXBSuKKIXBVyvg46OW23n+OSkWasft3idt2qi3qgf1k9Q65Vg7oLMPIEACwwhd8h5OJ5c+nzFcIA8liVaFpyLYBbPS6f1xkkeImzAGodHxzi1NohPz94zwSh1vwNBM11zFs2BB1bsLUSRBDVQ2FrTqtUnjcZps3F6eFKt11r/SyrLnWHgr1LdSk3vCwDyObDDDFB9BlyNSaN2CqA1HoarMPcmaCg8yBET/K1L8DrfstdrbMugu4oCztCMotWVCVhVAc4RNE2C3LHAkz4YBtvTK2DAHmLUhXouEk8CHWAJJyEYh+B16jGQExuDJXAd3tKTNsr3ggtbBEA56OUxwAVCfBwc5oR5YUz4Ad3gBwTgepwgCWw1i5l4wWcIaWQnELpHHrYG/+vZXpw4YH6EL9A6wRpdwEppbU5QTm8p4R2YgiX0VBA7Hl+Y5+DZ0XQBCyje2mYuMuJrq7apN9RXkRq0X/WsbpgUNfAmd0WAC7zr0qDXv5gMJr9sZteGND7222pgdDYoszNgMXCxDf74lRn0FUMfGyyT+LPsTQojUGwXE5kmejxni93irSOXwxpTtGr1I3faErX6id2oHTXbu9utn562WSqUZgOQO3hTsMiAawjr1FhFnpxdDscTfHjZmXR/ItcJhKSVJhEb9N1WAY2OVYo5OprolSwA8Vnk1sFnCRZxJSAjPSNhGAkX1tKwGEZCcdsWUl5GIYRqeVF72hU+3+cNegbZDs3K9LQFsF0XfFLtpH58WBdH4InaLvqi+lG9XW8L2+YI9EPasKZd8FYlHIhewCatXc/Vg0632x+Pby5Hw9eD8/6rTVdcROclXNNqXJwJlTkjzNq7LynkRfgL9IEfOumSGoGimBX7au+dE7lOXsBA9Ajwgk+6R/ypOVrjZ8lgEdN+NgpTMahKC+kFhE0MBZSVzO9uZB+cBdS1Nxkq45rjIpm58/4b+LfIwvyLHY1gcbZBb1sI1z4+boIhbDZq9ZaoN0FpGrU2/fGYlDweGBTnzQtNEYLuxQ855lVb7ZpwHXFYGV79MIxm3RB/jEV069miJ5Zxpdf94ad/dXr4rx/a3C/ISm5SkhSMugTmDeXcWyIO6zA/Lg/vUE/1MrWSLiN15jGNzzxamIIJmEWclj7wl3Y92FitVbV5kKDy0l1lEgWzYWqIo7nIVrUaaJI1NvNuAQyzo5WN/HwnP550LnqdUQ8eGV96cz4YTx7YUsNuzJ7DitdGGP8Qascp1maRE/rA3IzEoCCY5ICohmGIuZaxiO9Cwg7T76sst0EJLgPaKRvo7SlNZiJxbgaACxatXqCcJsC10GRKKSk+IsskIEJL/Tyiu4wOSz5wb9pe5dIHNoQRKVORG8LZGp0oimYyiVO8SWcYawKhb1GLFAX184WzR1SQzFBO8WUNoQ0RSTdZH5OT/r+uOudjeHAxnNykf3SHF5PO4AJ/wpyjyfjm3WDyE/zVv+ilvwEW+P9wtClSnYBlkxeMmpkgT7Gupssw7QLE+iBWjwfJ2wwRRSukojlDnoaGPAbkp0kMThccDSX+4ZF+AjqZdwmYq0ehWxealIcvDror6JyHVxcTombB+K9FQKn43uncDEoolzK0PdrSTbUgEtpwScqSpDpBXngDe1mhrWONfvoM0zM5z1qh9A9mMW+Fv1pz4ykC29j4s1gZidckWu2WFchHGSlka3CpvW5PB8fbiEG5G2UxM4jT4apiwT0fYZNhEtlisNWtPi5lWWg6pjGYG4ULY9GDTeKuo4BmLeJ3QZXiPKowwE0jVGncElbEJYHMicf2ZEzj2G1ySsYcwoK0ftKoQwDcJmeY5cSuFX45drx/kHNEGSLDW1xwPJ84Y2qmlyuYqMU4Fmn1hBpG2/Uwy+d6ykKDXWB3B9FBvJbuTe0NLaZofZyKhEdlIoK7LAgdmEMXA1RMUUHaF1uGAQmhslQVlpnFCjNWscJyRlGBbMxiRU2dxsOGC+AkTZxfyH+qrcXtSWWbR74QVRtYVrfbbnt65Dr/jeKLu9PQ2A4X5Fbmnu/AGu05sfDjPNy7m7272bubvbvZu5u9u/ki7mbvXvbuZe9e9u7lK3Qve3fyV7qT++2sO8dKq+Zm9n/DMqPjQXzJKaUkWxPFdRqBpUesh6P85ovZecvv2mFluqnMJh2JBL4F2CgPmSlpJLIUZyW3nZByTcJQuVqnCsFAL6j2NMQEKsxsfKsCTzfAmilMiVu3YLV59XGiNfZEez7R6mqDxWR8P6fGJzL7peS2cwcQVAVTIXHMogfc8fOz/drM3nSHo1H/vDMZDC/g98XrwZny0PnNwPTBCCxDfzy56VzCq7ed84Izh4fngy6NhBFU581lZ3CW/3kDg036I3zSH00Gr3ONz6/G+s3w4qLfnQxHN+PuT/03nbUgoVI6G77tjy46F93+zdloeHWZ263Ib1xkoKePNPDw6Hzwut/9pYvHWyadCTa67IzH74aj3s3lEHDAkfD0C/5zRf+Mh7lX4+HVqItPJ50z9f8bwKR/Nhz9Qn+Of4a5xlfnONWofzkcTbK/caC3g+G5wdywodOdDN4qHACOnxVq2+JK5J9RMu2FkcWkKb3JMF8ViiWO2osYoboI77CcO+IgD4kdJ5F4oIgik/1eHE6U+9zYV/2ryiwet1Y77Einh5kKIE3m4YJL1oceKgbnvsflxYuAuJIQr26bsjBjXBV6svuHtoTSfk9aabNIWrcRgNJUoJkUH8FgSohnTTlsrvQ1NWUVVX9gorGC+dk0iptbVwinL2bcXuVwCNzw+YuZYpkAlpg64GtsLMJVtW7EXjTb8HomAtAK3DmE8B8aqY1WsPVlnKQMQVLAwLCvWMTpRANWXtuIrQwXQhcQYwkOnemYClOBAcOo0vCNXUzUv9QzUYCFAwch88NgBrxf28assndzLGAAskszH1VpyBj/fxdGHzCUgmBPV80C6AtvRvXRiEm68gWXVXQJm+AUKizER0/CuggrxHPnOLjPlkm0DCU6PorHuEfzyASCeDWxPu6RSmvKv+JeJupJ6nMvcz4oLb5APuUtRb7AeFtBcX7vXPfWRcYFeIzMFI6UVPJnDF4yJ8YJU1VfGfNoli/pMKU+chcwVBddltMNA9ebbdvFXbPvhXlos9mbJdrap0cAU/15vGZKnT2K5ShdCD2LGqauKTIWTNdxozaoGVUkpw+eMjMd+w2epkXx6TibJNskxRoJwSZ53O++HA0U6yXCB7+3w0q2Dub5AtCqmbg/xqrvrSHhlmJyfbokO3wilqp0nQbbBGrHcjmD9eSJIHD47oKirjedi84Z/doIrzZikJ4+ECPT48JA0oRTSdssCpNlenJWF9TT6WJ9utYQiTCtMlpjS31UQ9eCqDMY5TLBhqeIhlkJayHjgeqqmmrwsfEbHvBZ1jyNPhb8wxo1Vdd1fHGMDjtD4gV0ou8MUaqowSjvkR1WTr3ndKVPGhu6D5xyWdnfgrvfIG4qNtjlBYmYtMI/TfaZ4Soqg0crHhLyvEgg9Fvi6AzQ1pF93D6pty1+1HatVps3rKmwpxYebj6uc3F0ZB8Vy/AKwv86jKiq+74QLhi7DOv5eJU2QYN9G6qTEztYS610+GIz+WnG2c2AVr9hC6rrvb8VE7oruP+nNnRdOvbmdG9Ov2VzivK8YUz1kbhdMlLZUerHyWJOvQ16lGQwM1A2mQerSn5LwpNp5G7OXhaC5euSezytT0940zp0hWO1XKdlcafRtk50efGxqLehR6NtT4/s2pFVd/iJ1WoKbp1MRcuaNuuNQ7fROnEbvPR+Pc9PCQNzYGYtyY/kw/atbSf7ur6H2fc+Vc9bbLR2h4jxJ9PQoXtevACY4xFqzz0D+ICJcQR4BjDUzg5bDq9hmW/BCo3KXFXBvw0dtWmm1Soe21dDGpHekm8HSlTrhdMDXY0MylnEbdTx7Yq0luwI6PSU6YKHm8yJ5C3TimPBp0e1dqPlHrU4b5y06seH07bLm81a+7BNmR8w/hIMz9Me4AzX/aCoVO3t/QEEgWW71M6eJt/dzNMYO9Af9+pU2xRNDS+Lxce4wjj7sXvJWsfM58Esoed8tkaEwLoab8upqYGHkTfzHt237vVfd0yKUec1caxtKUN9pU9IZnwe3hHEGgE8PqgyCJijKOtRy4AQD2S+oaf+kitwNQumPTf00LNv6ZEfWm0R5lWJ9OZjzL7zqqJagSV3eoZpymVWXl3GJfEyts41Jcv66o/v85l+tfsmzRkq7jjZ/pmbYJaTcqFhEmMSwbPXkp4ZKTdqrLX9OM8zBZUDIH9aTjp2jI6c0MxrYSotGsTsyiVFufWsZEY0IineS2ADFpTtssMIc2JsCrh5sWTaHJFDBcMTmHapxSociEBo3ihgenFI72yeyB307tIH82MRaumLW6GVjyoQTKCYJYeMRdLZR+psrq0ytDCKn7r7ve7udXevu7vo7vrLkb7PQL+l0Ke+GfpcBfoKO3SeG6FPJFTy3dxz94daQilGUimADpH++W6i79DDrO3HJRUBfLn4SLnyDeA7KT/WVoHG9We8QACJjjoZAJZIOKcEdwaxChKJVM3N2V7jQXAQ0GBLiJjghs8qTGj1FSUBrfI5RMlOKGTwKta3RakEL1lAym47lroVZh9J7iPJvTfae6O/jTfaR5J73d3r7repu49GkilUpC06TpLJYsGjlZI0/V4dvIYG2bVgqcrdmuLafLSCg7E0xioVI4fStFGf1t1jW7Qc3nKOmm23YR81+OFx/bg+bTWOS3lff53pcapkRZ3K8VvxkUgMQRzudCQBCJeMw9Appv8SvDHQRbNGxXombgaaA0nfp7Fjo70ZO07CELPpKxMhyUIMGWQ0QpsGbRfY1hQcqBtg1FF/MFVeqDLV3kLAKFgjoi7/ReVFLGDcaGV1XNx60jelaiFLZ9GXqEmyBFiyQllc7mFlposxH4xAEeyMq0uPv1B0qln0WZE8GyHG53Tdcf+jLQQqehq5H27L7w4A+AhtxFgx+IFEr1rtcLyrLi0jSuPOfXy+j8/3Pn7v4/8ePn4fn+91d6+736buPiM+19HQw/E5NNg5Poe21RpLY6nXVLzzZ4fppCoaAhJvFtp05aGTxeBUCAEPsW4eJ8Fq/K4S5U6CN8NelzwnOMVKeSsJIHCzPwjnFI8MoB3afLOgMpj8u6ff0Gjv8WLhhQCpRtrM6OsTS44QlA4ifYuwWnMoaiSRD6/M9eGfQEhAOO6rfOlVzUHWILyjO8SnwJktRg+rE5SCYwO6rVxNUCW2RlQ1r8wsDa6YrOuwSuk15Y+ObM41rMIEDCsNU8ETA1qK6TGAuIQlzCupb3W7p9v+1/ADvK4i//7zcVEDPYDLNvI9Ohu0ZwDpGoqIwvtMsHI1ahvilfkwXCM2NiYbYrMG+1HwCGsFadvku3++m3yvzzFk5w7M53TYJYgIWdGO2UL4oA6w5T850ils0qDWMtcHhJn+gkT+GNAI/AGRFDsJMkHYa/fL63mh3wPfi/g1sFiPjm14GC1gG42iujzxemnw4jm8XgrEP8xolhrNotHw4vwCFIq017Yq+rHBdOAQ3JdErRdPrsazcuNZdOmfhaOuw4CU0HAUt9Zsw7UXw1EYz8LxinD8GrxTZ7UL3ZgyU+b8yYDZ8zCU4r8YQ9FBNbieJaBFLwaLasQs0girUcuBZKkpLc+CgJTgOwfFCJQw8SkGBBQPhRAqBo5SyX8TZ0Hn/00ngP5dwJkeX4PfxpZOaD/jiwxrMOOEFk5oKRsgNfzKLaJggW4jDqpemASgm/GfLIEGNGf31FhbrToNf0B90DXYACqNIpen6o/TzMDpX4xeYOu0DZhhjOfTzUb8FJkeC31jgVgmE7FOwU14/RBc8hrdFLxpJgzd9NeGL2LcyRI2ePXkl7bSD1iSr8fu/kUWb29p/o6WRkfYnjnVqZcieSH/UcdrmwlEac5AwlvSVQrmYamUfZElP9DS5zFKNWm1PfcEpR6WgsfqCyyARLggTVxGIao/nauEgWZ0fDMCkLmvy6QpOW5mVsdAVWCJfFWXC6hTGfj1xjksZUWVvYPVYGADW3AliOUd8O63UC8Jx8CZS2Qs6xlmMzxrkQRYIw9gJwvGQaSekAjHk3aiDBcsDANhaEG3JrC0l9FiFDVEgc6v4A23Q1dfgZxj/BNzAd/NB0yA9HTURn0jJkNkJHySTGxXDNufGhukzZoLf0lHgQEsWFnmZngzmGyMCIMF6j6aahjNDnQneYBtYRBcHinxaVbr1ZpFywW8XieUMSzAcoNTrbr5PMvapyvS/P3X80lQ7X9w4XCwxDwbYpWohYxaJl6XIvNZ0zlgiw8+fcLcC66b7vGx+sgPLh6B/vqo7bbPQeQJsP9e6J/5vdCtXKb7vdY/+KrTLqUSrpV3Z+ff5DOhj9DJfB71hQT6//WJz0fomH4C9YWE3H+v89v7Xucj4mA+yvpCadh/dPPr/ejmY04n/bzqC/m+/3Tmo/TNvlP6civ79/z85VORUOFDoi8k3jf1WcpHCLL9a50ZUd5nWyAQ/b+HfsrJ0lJADaF2ZXO9NuqWCttTZ31cmfEHcmP6B051f/8fYqD/Sg== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Query Parameters

+ +List of Roles + +
Schema
  • Array [
    • owner objectrequired
    + +The owner of this object. + +
    accessProfiles object[]nullable
  • Array [
  • ]
    • entitlements object[]
  • Array [
  • ]
    • membership objectnullable
    + +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 objectnullable
    + +Defines STANDARD type Role membership + +
    key objectnullable
    + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
    children object[]nullable
    + +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. + +
  • Array [
    • key objectnullable
    + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
    children object[]nullable
    + +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. + +
  • Array [
    • key objectnullable
    + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
  • ]
  • ]
    • identities object[]nullable
    + +Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST. + +
  • Array [
  • ]
    • legacyMembershipInfo objectnullable
    + +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 objectnullable
    + +Access request configuration for this object + +
    approvalSchemes object[]
    + +List describing the steps in approving the request + +
  • Array [
  • ]
    • revocationRequestConfig objectnullable
    + +Revocation request configuration for this object. + +
    approvalSchemes object[]
    + +List describing the steps in approving the revocation request + +
  • Array [
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-segments.api.mdx b/docs/api/beta/list-segments.api.mdx new file mode 100644 index 000000000..08b2bfcd2 --- /dev/null +++ b/docs/api/beta/list-segments.api.mdx @@ -0,0 +1,92 @@ +--- +id: list-segments +sidebar_label: List Segments +hide_title: true +hide_table_of_contents: true +api: eJztW/9T4zYW/1c0vh+2y+CQhAALMzc3WWC36bALB6F7d5S5KracqLUl17KBlOF/v/eeZMdOAmR3e9fSS6fTElt6et/f58nSvadTkfFcajUIvQMvlia/EONEqNx4m17Ox8Y7uPKqR9ebXihMkMkUp8CE4UQa1j8bsEzkRaYM4wxpMB0xHsfMuImtH1Sf5fpnoditzCfs9Pz9v/tHHwYfmc5oOi/yic5kPmVALxO/FDITIcxgAZLJ3Sot4CnlGU9ELjLk7N6TyMUvhcim8E7BG5Iikbk3z+oHfsdUkYxEhtxlwhRxbnAJyzqweCEEu/p+mxi6yLkKeRayQx3HIkAa7Kxa+vqbSZ6n5mBrKxQ3IkYltgyXcaqlyluBTrZkqLZ4KreMo+MHFR1/JsJrFoECEp0JJhX8mZApUMxSB95BxGMjNj1xx5M0BvG6O+1NzwQTkXDv4N7LpynKDOuKschgpiVjH2134UEilUyKxDuAeQm/s38TlVBEHLRAvx4eNpdrU0eREYvqPKXHwDZoMJ8IFhVgKKtVMHveYpemANtNmUlFICMJ5iTTb5B1NlDxKR9LxXMB8zNdjCdExxnmxZjjK4xRqf9x5Qe6UIu6H0RsI88KscFkDloFxac6LWKrSsE2/uEPdc5j/xBnb6BKU62MYBPBQ3B/sgMOXBIOEw4UdRGHbCRcZIDlZFTZDfTHNqxPbLBbgaoaK9BYCBYDm0kVCApgYXKpxpAPcmSFkSAQzYpN+I2Ax2AjUg6Ol0nKg3wTpaHwB4tB2ghhYaVz9BQjcNUNIvJXknwDeSJub3hcCKsFHA1sF6bk5kV4EMqzxIlGWseCK6/mJzTz4eEaqVmTGpzQbbfxf00fOVmShoFWoME3waVgPE/TWAbE4NZPBifdL3LBs4yjP8pcJKb2XI9+AuExH2eorFxaVmRYG2PyDFxgwXuH4HmOo1eGDY5QO5UyvHbU6URd3vP3gv2e3xtF2z7vjkJ/r9fdedOOxPYoFN5DGSCft9aoMFIJYxhObi7rBvl301+RepAJiKalwlQhHcIIP5fAxrJV8QW7nUDFy2c8oHs70s3lu+1u22934N9hu31A/7ba9M+/kJ1Eh5RC/xv8lLQ/i6EG/c8zgqbHkBJqg5prE6goOcxECs6O3sucbfStgty6xBUVlCA+moXUIhc0FaOCEIWd2FpwYkt3USqhMHFfeYOj44/DwfCfi3DolOjjvBYjKUCxkEqTwlBiEpB44X0sopwhs4h+sIhChntVEn3FIDFJlRaQDzUOv5UG82Wv3WZvecjObW5lIst0ZtOeTd5NHVY8gsJWCcpBCCom/BU2/SDY77xp895uxKF2iF67sxuNeqLdeRN027vb+6uH4rcFJHsfnD9EG7FQmjTmUwpFaxFnnhYb5CyBN6CwhqY01J8ci5ECdZydXgzx4Vl/ePgtTIlQkVRBSNkQEYGtcUGRZehHtkzUFwJfrDPxVeo2RZrqLPegkHugRnpGznAuIqiRUOQqDA0jbqSRIxmDug8B84pM8uczq7jDODDNgHtkrAX1OnveKKduJJUt1ExtmZnD9z8ewa/jv1/2Ty7Q6Wdyu2cgE89hhVGRr+AJH9Hk5YKzeXW6sbaFibSFlnte6MeidkkqhBFUGsulrXM0GLgYng8+vl+2/BOEnyLYLxAQNRzkexqE1WYi4xC8ZEndXV7UZ1Yyq9fmF6ygatTVdf398cxZG9MWwwsdFLDaTZ3POsBa6GndS0g2IWIkYbB2UvaeL+c2v0CjYxeAXKTsXxXsspBXaSaiyBWcJqSbA4N1WVzaAPke8HFvGdQ7jCUyc0wpyoeUNUPttqOyKWykQ2qvpQLlS6r3n4sGH/GsUOSAlQ91uIIbvAME5o8zLpFDm1UDmMiA4o0MsWUg9GxJlvmaxjUzLmii1Wmk6EMnDGov48HPQGuwQuW7VBLms3IKFMBZMlxcVuwJPtpt73d70W6P8+6bXmdvZ7Qf8e3t9v7OPtXDBHySj+tB90g4vxdQIWTAMNvF8ldQCJRH0D0xQIuvHt1EY8UwtGMrMR2/LBd3UEI5e3t4xnp7LOZqXNBzPp5TgvIvLxYAF0huCZ9mciyX4sKyoBwdv+tfngzhyTlUkOML+AtpLeCpfhWAmmDbRN8Sx06AW444EbswgK9sw1HdAIG4MvWB0v4yUwPKZC74YIZbfcmMOmkWZTpphBLFzV3OvpEt0doEpFJBjhGH5hMhHDXi/SAQae6fOE1uuA78dYv1w1A6HEyp0JSQh4ehxTh2UwVCWVDDrosc+1sZzDUuM1XOw98yhZzUjYLBAZw/7yf9IC+AORKzHoWVtzgWywQZOs3NQ/mZ0kilU5VjdgxoayjQkDsDyEwgm4Q86dIRI/gPaLEcV2WsRvJHbj5YZo5yTe8CXpgV4u4shvTjk2jVixvhgo/2BG02ImvIql2hjOS2u2iyG1WZqwx8C/vXsbuO3XXsrhi78y/P3QaXe0vQp7MIfS6V+3KAxXMB+mTkPQC8ykEEb5whN7F9dBDpu09D93kCxgO4xo263xAf2VK+wHy/sod9PkL4URmrYQtkkPRoJYggE4nwgPiecWxBIqlqe3G1dzobSXBQtQQiQtbM2FQXjIPKskIp2ro1myzUwqhXudu0hYgwxmZAXFWFvt0fXSPJNZJcV6N1NfrTVKM1klzH7jp2X2bsPokkK64oWhxOMkWS8GxqPc29p+1PBgNmX8+rkKs2POtoBYmxCmN5TeTgjbqdUSfaC0Qv5L1wd3s/6ga7Xb6z19nrjHrdPa9e669mcVwFWTOmava2dnTf2LIbwHGFAucyudZhc/uvwI9pEaY1TD0Vbgadg0qvK+zY3V/EjkOt2QeupiVCMg0MqWY6wpwGYxMcm5Vj6YPNGPKiwq/+EvhCV8LvkT7L8NACHS3A4EUpgG429ftRDqK4AwvOyapVpAriAjikTBBrRM0aHEviR7YIMR9QIAQ7huz8G6JTZ6KvQvLsHCU+QYnZ8V0gBAZ6hdx3lu3vDoD5DHPEhTXwIxu9ttvhChwAGgKbsyrcucbna3y+rvHrGv/nqPFrfL6O3XXsvszY/Qx87tDQ4/gcBqyMz3fwBBursNQ7+v7+v4bpFCqOA3JvpgM6QRDOMDjhCnAlZGhMJ69Tnk/gx1btHKfF+paLIovhbXmA9R6MA0Z5aPFUtqQ71qX0LZ1iHYFGlh94cMGHA+i8rF2gRerMJHqsTW9E3CrXHWHwqoOyT1IuD3pNdQEJjchs4kkT5z30GFhMoXV4VZ7QfKCD0XPygVyXWfzw9bJYQo/Iskx9T64G4xlwOiciinCN5gIrAyGy1yXwc2hzU79Ay15d18dcIBa3HC6MnNUX7N+6Cwyd4rAueyt4hkdV6JPGN999Gr5mY0SglAHwEOy4PIvI2Rm4EWW4frm9j5Oo6MxO5fcbH1AwolgUg1KYO2RdHh/8CKn/HHI1qR0nCUoPOGv1I9a8Me+RI9U/KJ8dycyewDY0xoloj51fpaVcvCbXlzLxl5Kab6n5RM28nuPCqvYqsAdyAghrJMFjQ9r64sUtPb9GD/sqeIJU53lATTg+mp+9gtJqX8xHg56P9Jp8/KA+TSSU1+Y0ZrMZMxO6VzBgwURrI/7GGLoOhsrVuIBI+2K2bnFRnyLC77ZrLPl2SV/6ABaJvxMIDGWdiY+wWBNW0QDjVGjD9keyLOSFH+mqw48NmenxFdRUHBnq4DPuDczxjAv6uKBv84Rx/NuShY4FsY0yUB6wDnA4sz9lAsdoLTdaWkszP5HfojlYPgJglaiY9MD+OJglQfcXoxc4uhoDqRqxdvUhkG4XWFpYtxrKKncJ5jW4yG+soVzO6c3yW+1SYQn9o8mLEvdnmymnKp7+1ln6kUzyx8m7v1PGW2eaP2OmcegX3Y2WdW1C3cnfOky3uLln6PIb/BfeUqwS0IY2ZnbfrU4ojXmOXk1RHUykoG2BVPAc8eEmepZOKBKhg8fwxyPASGhM93cyYJlDI0fHjGnjulyZU8BY8Il2xd+moN6ELrROoM0ULfYJOjUVgFmwS8OjF/DuJ+3atQuwzBkalh2VxgbQlSSFwisawHaRMA4u9YxHhNIEhU1c0LQpUeqCLjqwalYZxehqKEKL+pUsMacR7jhDM1sz/DNrgd3La2agerSiu8k4E+RcxOSZOK4J7Z+jDd7mT0ScYp8IWRcAmKit8GEwXKAIxJQBuaAf19l4y00yWzgWj66D8NZ9tludVtunlgKep9rk0NnWiNPJ+9rV6LkLUNX2+u9wI9rVGmwStlLc70IJCtvY2M7xyjO1G9wTEA6f3d/jNgi2Ug/42N48xf4E1I0xMLuq+KiwL+tO9VJF/SxwY6G8Mu62DjwP+87V9fD/dRn6CT1Wl8W/UJHrm80v72bzE+5QXl+fecP1bA+G9j0gHZHpKPHYSXY7tjZr4YMlUqm2yN4fQyp/+A/muV8j +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Query Parameters

+ +List of all segments + +
Schema
  • Array [
    • owner objectnullable
    + +The owner of this object. + +
    visibilityCriteria object
    expression object
    value object
    children object[]
    + +List of expressions + +
  • Array [
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-sod-policies.api.mdx b/docs/api/beta/list-sod-policies.api.mdx new file mode 100644 index 000000000..a3d76bd98 --- /dev/null +++ b/docs/api/beta/list-sod-policies.api.mdx @@ -0,0 +1,104 @@ +--- +id: list-sod-policies +sidebar_label: List SOD policies +hide_title: true +hide_table_of_contents: true +api: eJztHGlz2zb2r2C4H5poTFm3Lc/s7Cqy47rj2KmtNG2dTAuRoISWIlgedtSM//u+9wBeOiw5To90tdNtZRJ4ePdFAB8tFYqIJ1IFZ651ZPkyTq6V+1r50pEitvashE9i6+jGur48ZvR4br3fs1wRRsLhiYBJSZSKPSsWThrJZA5jP1pvYhENVZCID8kgTaY4X7rBUaxcOyQYR5HgrvX+nkDFTiRDRAEQGE1lzCYiiRmiwpTHuO8zXDw0ONXfBVfit1RGImaR8gWOubw6/Wlw/OrsAhAOecRnIhFRTKhIhPpbKqI5vAvgDVE5k4m1uPQr/oEF6WwsIgQJ4FMf0EgU/EzSKIB1r4VgN9+12eD1GbtOeODyyGVD5fvCQRjsdb70+2fTJAnjo/19V9wKH5lcj7n0QyWDpO6o2T7wY5+Hcj82cGwnh2MXJDxnnorYTEWCyQB+zkhUdcA90jwA/nvcj0EA4gOfhT6Q1+o2QBzOVMy4dfTRSuYh0gzriomIYKYGox+1W/BgJgM5S2fWEcyb8Q/6N0FxhceBC/TX/f3eam4qz4vFMjsv6TGgDRxMpoJ5KQhSc5XBizp7E6cg2zmLQ+FITwqX3clkymoknRoyPuQTGYCSwfxIpZMpwTGC+WLE8QRh5Oxfz3xHpcEy7888VkOzrDGZAFeB8aEKU1+zUrDa9/ZIJdy3hzi7hiwNVRALNgWrBPUnOeDAFeYw5QBRpb7LxsJYBkhOerncgH+spnWixu4EsmoSAMdckBjITAYOzgMy4kQGE8ZB0IAKI0KYwwM25bcCHoOMiDk4Xs5C7iR7SA24B/A8ajYTgQsLBypBTYkFrlojIP8mymuIE2F7y/1UaC7gaEA7jTNsvggNMg52UYnGCrwfD6ySntDMtbriSZ/c4gpYcRKBMKz7RUV6SVNy6acxigw1I6OSxfMgAcepp41RFYI/maX/0nQBZrbB8znK9mX2FFUmTsNQRRCuiP3kjgCUusPX4Hp8Nya91cFQRfERQqjVpFurHbGa+K2m/0ZGVp8Aakn+yCoJDQIeE7+xd9bY6fXbXuNAHIx7nW633e+1ek6r2+92nO5ht9t5Zy0LH+NiZpQxiqnVaOB/qsI5XxchAaCD0Rc8A0ziYQjPSc/2f4lx5sdlBeBRxFFVZCJmcem5Gv8CDMewGiFzEqnxke6y8izqjs4W2NlxvcKXhtdsei3esQ+cfsfujL22zVtj1z7otLqHDU+0x64gjnD3MvDnWv3vMyXectExaqqIY4azquvrBMT+MP8d1d2BdSiLWQacu2YXRtiJnIml1UagSPiC3U1FAGoFmpYLYo56Z8BXMWg1Wg270YR/Ro3GEf1Tb9D/flxF+Ey5FB7/KBwz+E9CsrLmJiFd0g9w+qXHqMholwVuVXwoMTRIiyBOMf0DHwGqTRECZqNEQU0gzeDjzG0CZuouENGV8FYp9QJaOPKrmEkXLAdS2fqS2uv5G8kzcI5HlwxHEiEBxvQb6+z45GJ0NvoBk+iCuPwp4LuNaS1iumRkLaffPGzwTs/jENFFp9HseeOOaDQPnVaj1+5bWxtUtpQr49Dn8xUGda19qwVxxwJk6BnNOk4UrgNFgIhA2to0QRKQE4DIHqEmGYRM/lEGo4rI9z/8aEas0gP95lsKiRuXvhY8cqaMAugmzfwvdxxwNc+ke7SFb5s8Z4OLY/a4Sd5z8lWg7qD6HPMmrK6g+okfwcXydOaY+ezZK5nIiX6YAX1eJfBrnZBBKsYnlAzcSnFHLEkiDgB1YHchi4/hR5yFWBlB9FMphajCUt9ZTMBvNRdilZQcFUU6wg/cW/koLSmmMk5zq1S84JD1MRXoIsIUjvg7Q2cvoxDShSlluJGYKSSdRKWTSXBCmERm8bpE6y9qDDVO4GT53BJplCpspuftVABAnaQUTlpgsuggAREiUHYpJxcvL6+GJ8fw6OJy9FP+Z8XD5E/vs5J+KfQvhA0YlCdLBg/tNytsvbFGg9MmPIH/tHDJxQQiyyyzWKuis61zh69MAAUsPlcWYYLd45DIJn0qFlVVWIHVrVQ+JWjkNwdxDCUTFDgJGKQnJ4jpIoiH0zOeQ7hK/ZU6lynPq8HF4PTkCp5cjwajs6G1hysttWWORQKZOSTJYzRoVIkc5ZhRhIV6ysBidh6XkHfapqDWIvjw8hRsCrw5Ru1TKOtDVOkzM6HC3QK3B4M6pL+XHvV6duH9zw/vi6p5/7488LuHFftel6IuKGmZLeXKtqqFHmb1mMmSi+SZY5ryGOp6SG9zaGU/Wa2jF4rlvS2l/nZxTXDKOj0Y68ASYUz14JVua+iYQe/q5RLdOj25OLkanJeUpngyvLx4eX42HJ1dnP40GA5Prq9/ejG4XvTl2XgKl/mSA1pxGEmsevnDhlFVe194SXnew6O306sX5QIsjyOGK4A1TEudhJq8FW2bqUDMbRno2kzjhHXuxniVFcPZpDpjUPlgmyXG3EVSgdGkKn/GP+Af3QajYIUdC0QOcalvXwKvU5siLIPJn5+8gv9ay/7U+A6rGqOLGVt6irPjLIvRWGIv7G4qnaku9PJEmVETQGA7e4UjOez2Dp1uq+/0wJEcOg7vef2G02w329s7kq9T8PQ2Rjb0BRV/8jQUBy62RGFVzAPAC92Xs48cqzLvNOsy2nq9Zq837o4bQFuzd+C0W8JrN3mvVzTGFpbYewLUg7VQK35xwVjhTSQn050V7qxwZ4V/nRWWXg3XBtZNKU/2+XRuLTKJMN+2ZNDYl9CwNVT7glOTL29cbujUFd3DDQNXfIfdot22oruWZ7tVWa3X7pxaShIZEfhQ36ja6Kn0dcrNmE2axy6v2OZhB0v9mg0TDreD239urevo/JENl+X+yp/eGDF9kHLfIttkYLza+0qvYFuTKZf2287ZXHgvltKlqvSz6n5eKbGyFVQLpErpv7ZW2FAVLGb7Zv085C9G/Kd59ye6cXCtK1KjCsqg8J8V58On4dynGIMgFmvX4q/HqM5B77Dl9fkhqU677zS64tBrcs97vNu8ACeyxm0aT68LWokRCzWeG2zXuKnhqobyah8zXOzNFkb/fqVHKGm9+Rxe9ghb8KbsDTBcb7Z1PcpIo6jJHzAmPYOk1W05zaY7Bn/Tbgu747Sbdr/T5/ZBr+f0uwL+7zULiZ0KwID7G0J61262Rs3+UefgqH24MpYvjNCaZ3VWfSweQlYXJOwkisAx2+yqtHND76qhHRlsrFxqbcjglvvS/ZRPyWsydZdaiEPlbpHGvoSqxZ5EXCKGglB2YCIDiLfSRXWjHRQaZB6ucFy1dwWcqDfZC+6yK0Pf0BCDCVvEnV8B1jat4DeBhPksmwLxPa+mViwrDgQf9xr9VsfrdThvHXaaB91x3+PtdqPf7VN7bgaaBDF1cyOedEU6zFcOSOR3gdGXA+8JAVp8+2qJYGzBf/xmrMfmZBp8Ge7p24Pk5MXwNescMJ8Hk5Se88kCEwL7zfWq3q0GfAleXa78VpyVbscnLwdvztHvXp18++bkerSmNz0IQFtdVEtFW5WmSudKhoA7DmmLwG0jwq2zmoFaA4IglSoPlPqveB4DM5lp2MEMs/qKGWXQzIvUrGJKjt4AyZ7JuqjvsTE+m/EESq5xOeOqoVcJE/vccLJmdmE9r7OB60rzcYs2MWE3fY4bmLjr6p02emMdmLKgTVuY/EEWtvTtq2Dl0ncEU7Wcl4WCxgGYb9aTgZOkgByRWbbCXFsMikY+gLPm3OKn/YJpxFLcUgQO16HtgSaasDHQJpOYGXdEu3rA8QTZuNxjlYsxcnevNDLUr8aGBk/jLezutQ/uxybS8he3whgf7QvV3oikkYnJeCSz5ZEmm1G5uDLD1/uOdra7s92d7W5pu4svr8wWOfOWUp/mcurzJuAp8Dei4LmU+ujmZKBYNkhXYVqQe/hdx6RI37wdgWH/KgL6Hv8hxDL3M+ZHOpQvIT/I5WG2WGY7MLPQX8gCESQ+ago88ETCPSK8C4yJUZpV7eXVXqpoLEFBgxUpInjNiM1VyjiwLEqDgL5zxXvMVSIOvkrMxl3TE1C6sSgC3PKPGzp3meQuk9xFo100+sdEo10mubPdne1+mbb7YCaZY0XWYvKkOJ3NOPVKQdPMezp8wWBAcYIqNzkS1WK2gsBYnmNZ1czBGrea46Z34IiOyztur933Wk6vxbsHzYPmuNPCj5pFrL8p7Dg3sqpNleSt5UgshiTuFvK4NADlihOl3Gr7L8VPOB66NXQ9ed4MPK/r9qLOHVv95dxxpBR7xYN5liHFlRwyKHiEPg3GznBslI2FAZxNwC8GePJLAl6oSnhuwWYRHlyj42VovEgFwI3m9sDDw0nm0JpRsnwVGTh+ChiSJ/AVZs0KFEviCTAPcz6AQBnsBLzzZ8xOjYielMmzK6T4HClmJx8cIdDQ88y9u6q/exaYPfLXWsBrGr1mK0YACgAFgfZZed65y893+fkuxu9i/D8jxu/y853t7mz3y7TdR+TnJhtan5/DgK3z8y5uiWN5LvWS9uz/2Wk6mYrBgNSbKcdJI2o3Zzk45RWgSojQhG7fCDletGLt55es6PtbdL6vMUkjH0Zkp+4/goBAMPd1Hsp6dtQkUHd09H4MXFnhcHBngDYuHECH/PUCdWJpJFFrtYsj4JrB2dGH/HT/g5CzzapzlYJTIzB7uE3XaBA9xh0pUD58lR3w1jtuFugDut5E/v3TadGA1tCyin0PrgbjGWC6QCKS8L64Rucac229+tJlOkX8wPqstbTYJQ5rsReCR3iOkD5ZPPvm7eg5m9C+E7RwfZODkOZMy2tQEfJgg6x9j5MoqBQ3rwwqH0jQYpjnA8HMXKSRHeK6ANd+Bb6YWIqTBJk/ztr+zgdembfm2ox3gc2OpdlZpPdBGhL11SI3YUYXL9H1qUj8K4Nma2g2QcPbJipYaNbeOHrDjQNmiyC4HxO3PnlxDc8uwcO6CZ4g1EUckBMGj+pnLSeT2ifjUYFnI7wqHu+Ct7SvvDqNaW+VbSA9Y85UqVj8hzFUHTSDm0kKVvTJaNFmdpsswm41SijZeklb2pAMEn7nYBiBViZ9npFyEQVpWuBqk/yZJAs2/zMdVfi5QjM9vsGjDDDSVc4jLjJZwBkXtHFBW/uA2OCvQxIqFtg20kB+QCvAsJA/eQKDaMnvaVgrvTqB36c5tMcOUCUocXik/zgqHJz5xegFjs7HgBvGXDr/0If3jxhYGJcqzMq6AIscXMbXVxAOF/im8c27UBgi/270IsWDolmCx3o/t5de40n+Pn73L/J4O0/zT/Q0JrtFdaNlTRlQVvIXJl9bbt7FdMEZ/Bvekq1SIg1lSnGnWRlQ6PMEtZqs2plKQWV/KHiCud8eapaakSVChY7mj4ePEdCEtupGgDKHQk36eJwcG9PZypwMRieWKFf8O07zk1fOFMpIUWdvoRILHBALVmG4tQLe/aJMOXYNknmNgmXHmbAh6ZrN0gCPhAPa6YxxUKkNGuHK2Em144KiLBAZLxSlfvmszIpR1ZCEOtUj0Sy+9LCjrLdxb7kWyD027WRgfWnHfkHIlTC3B8C4atq+CTZomz0Vfoh1IHhdSMBEaYVXZ6MliAp3qQNdUG+raLJvJsX7OBYvXwDitfq06816w6ZygS6MiROoXEvA6XRj+aatRQX8WLTQP8NNliZ+YOK/H2KPCrFKdSGiq70bq1LtQf0wVXT+wfr4EdsXWP7c42N9ExzWgMBG1O1iX/1aAr6s+zBXMutXgQ2B7LpPU/JbdMBjez78f11k+QAf84s+P5GRu1spv7xbKR9Qh+zq0U/Uht3Vko+8WvIBURQ3exbCeF80sfCUFYzVdkRRQE/TPe3SrKWvvggl7zOenmBs5WuqG/MDl7q//x/3xwhD +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

List SOD policies

+ + + +:::caution deprecated + +This endpoint has been deprecated and may be replaced or removed in future versions of the API. + +::: + +This gets list of all SOD policies. +Requires role of ORG_ADMIN + +## Request + +

Query Parameters

+ +List of all SOD policies. + +
Schema
  • Array [
    • ownerRef object
    + +Owner's identity. + +
    violationOwnerAssignmentConfig objectnullable
    ownerRef object
    + +Owner's identity. + +
    conflictingAccessCriteria object
    leftCriteria object
    criteriaList object[]
    + +List of criteria. There is a min of 1 and max of 50 items in the list. + +
  • Array [
  • ]
    • rightCriteria object
    criteriaList object[]
    + +List of criteria. There is a min of 1 and max of 50 items in the list. + +
  • Array [
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-source-schemas.api.mdx b/docs/api/beta/list-source-schemas.api.mdx new file mode 100644 index 000000000..2a332ff66 --- /dev/null +++ b/docs/api/beta/list-source-schemas.api.mdx @@ -0,0 +1,91 @@ +--- +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: eJztXFt32ziS/is42odOfCxZkuXryxzGVhzN2JZXl872uHMciAQldihSA5BOtD7+71tVAHgR5Wt7Znp69ZLIJFAoFOryVQHgXS1eCMmTII56Xu24FgYqGcapdMXQnYk5V7XtWsKnqnZ8XdPPVe3Ldm3BJZ+LREh8cVcLIui64MkMWkfwAv5S1Bhobtek+EcaSAHkE5mK7ZoiyrXju1qyXFDbRAbRtHa/XfOEcmWwQHbg+WgmmB6UBV4DKIkffL4IsUvbPWodNg9397zWUYsf7jdbe177sLO3N+nw9m77CIgZtv6RCrnM+QoiN0w9UcehVYk5n4fqJdz1fKZEwpKY/TSVcbr4aZslMxHhP4y7bpxGCdPEWKCYH4QgLuExHnksjsIlo06mhWJcCiZFkspIeA3Wxwac3fIwFSz27QhISAo3nkbB/4oViVCL2v0XnJJaxJGC6cEk2s0m/rdGsGbg78AVU6kLK6v8NIRxgQ0ZiFs9gBtHiYgSpMEXizBwSVd2flNI6K4qLS4lR3EHiZirwvN48ptwE3ixkKhxSaDZC7yqpNepQeChGJKM7xdrg1n/54yFLR8bzSyuJpoEt6JPcxsR4ZcOoOXCsBOoBT3SRJlaKpAhPOEJPTa6JMUCFhiWRJW5GishkaXAg3dBsnQSYGCSJq/giduuLFWgsaDhLg/dNOTwBN+nUQBWxfRIfiAk82MJim0nE0QFhstcKufC0eK7xPVAowrUIuT/THbNCMaans0qdEtg+DRQM+FZbmcwWy7d2dvw+30WK6H5UvnCshhaScOhQhY5y8Y1vkGKUNzyiNxPyZGU5zAX84mQfZ8UQ3u+KyHngVLAWtE8J3EcCh5VeP8Y8ilw4JHdR1PgWGjmJItirZeGLlvkhNn3IJkV1dvjCce+MJXpVIqpJvaA5MkRA8O+4OAPhXqGd8kkL6J0jrHKGY8+dS9HvRNn1IXHJ/2Lq/6wR79Pe4Puyejmqju46A2Hvf7lkB4OT/o/dwc3w5NP3QsHnnQvnQ/n2P7CuXTO4M15v/+38RU8uOzfDJzL0/7FjXNy0h1i96tB/39+gf+HXWdw8gl+jLoXV+d67PHlef/kb/RjOBqMT0bjQff0ZuQMzroj7Dv85Ay6V/3e5cg81PR+7iFvvcsz+PNs0B9f3aw8HP5yebL67MoZDj/3B6c45fFgABK4KTwCdvtjeNS/PP/lZtD973F3iIM5p6e9EZBwzm9si/wlTNY5Oxt0zxxsYnkZ3nxyfu7eXHQvPnQHQ92sINBVtuCtmcKjbdYJaE2z6gJWxDDofoQVG497p4hWyirdpx88ZFa/tIt1wSlMMBIuFrFMwI9MlugnNI5p/BptsaJOHTO0av3S9lFswZWqJzOwx+mM8RThQGIiJlHI1HB9dzeeL2IFum3fuFLknavTXk9Fowi0r1MANm5SMHhDp6Tq64mA83PjW4FWlUEU9JzgYaUiDENeR1PUpvIAM9xDGoGPwrSwCGCMiPgkBCkDTRiLfhOtsrWtZy6M429IFLzenEd8SizhMool4SgR0TAEt8h7+gJB1WgG4wZK+6WFkTT45FV7Jj5WH5Y48WLQGvR/hiUmQSLxHOcHKIrEg4NMRaKhwbv3DNDyLPYUU7M4DT3qDNoGgSo0mFD8WEBLHb/AlYKw58QIuZbS6KipsAwAERA3MgBUP5YmrOnIYXSWfSaHa3WYzfLm2wwGBn2LIhgTeiIfCoQJbty4brAI000jU490Cdkz6o0TzAng8PhEM1MwGu0R8Zd1ifhb+8SH9PcBlQlj95vWmDTSvxuaVtVrPGUZaQQRI3XR/D024hJWSqtyxRm/gpKOdiiR4QyEdxUHUdJgvQREC0KHVYegFaDElxqwgKNxTrfZ+alzZQZSduUzp1ZRgAksNYmKlOe7RF02slIN9onf6gCLmYd2cyyA6BpYb2fW6jZAv5CpJ0oZm4k5OC40GWAagnEMr3lkempF0Dqup1sM/Mga9ZgU6KMZ+to8jZe1mQ45WYsIjJ+rBrtnTd74o7eaOinDaoStMJLRyWQPsD1ywUSiOFXhUq+jicCP9MbA8T2WHnNnPJrC+rMhwCrbWIs1gpRM6lnb5mpbzzPI/ApllhODhMH3gYX+lkYuCjcHZcUpWRnp+LSCGY4h/Z5nLFPKnLk8DA6+CW4W2bqplAhgLX8UNdeAjoeMCrIKwty5NJHnOE0Y5TR6cbRxPAxanibueYGBAJnFGJdfgDrHzMkmTnq/6vPX6m0ZGJVYmceeACer0boG5moWLAxY5uZRITsw6aDuYIC05OThgSOMa1rnq12s09SdTOQTvk/5BGF2q+nZ8gFv4LRsx9W5PQLvjllPpwdF+ypGlgiFlqu68R8YL6rug6JY5sUoflVhDxn9Oh3WVRSTRW2zgKIGqGI6p7i1jjftrCrcFXgy0rOuxIAVM1ciTniSmHI52J0q9LZqh0F9QkOD2ZggDwbyjVEiU562kffjgPnNpW7d5/8rmRcw7HPSj2PNlk42s2gOeXvIXR3Lnlw3YvkRa7K8PJHj/Cs4KRUSVvJpcsbwWFdnP+p1Wl/ALWdZhUKWdc2lga5XU9/HE8t1yeiXe6pa+sE01YXtdVXIMp+f4tBD2L4EFJ5IzkrdNZxb5X7Ol8zUjksTuNOF2Aty5oUikSnF1O6Bu8xfryttVCWYu3dP+EFEsQuixixwZ6jF85U6yjMrr6+rh2a8PFXWSx6ohtoCDZiaXsLzPv0HiBv+/dDvn3edy2rSPqKyoydkuCR0R+VSzZIu62lxgHPJZH6aCevBmmnGhNXnNZ2prHtf3Bcoc+YAdR9STYRr4GEKKmKCsQUR8Urxz5T95nwB75Cvx9fLCrQqFysMAxEmAiWUMeXllCuLcNK/vAQ308/KXl+K0qm8pery83TG8NI71QA1FxFtIqA3iNeW8Pf2D9299pG732zBL5fv+0dNt7Xb2n1ZCX+WznlUR6yMgSOrAFcL72v3UO5XHdlTQzqVAfPXT1gOAcSS9eQtSeDqIg2T4G1KtbnywZrMkW6dtNCr1l+Rus+hSV6PDVQ3R+H/BIbAeAsw/5ksndGSvTEzub+wIBviMkVchC82x/qK25lfMbX9WhLNV5oMYhzTYmsLYu3WFg4i9UytiyCHDgHblk9yJfk1enr+9486LtSePK7eZRuzZVedOYfMFxqN+5kUIxt6ZfGzp0b+ZkGyUbKNhyr9ypZhxc9oN2NdwuHB/kHL9w/dZgt+TTr4l3vg7TfzTV1jt6trfraSalUnpzekV+ZmH5qp4Z/3BCqwGiue6QA9u/ukdxDZd66YIYCajXGbJ7jLBE/qSUArUfCGzdZRvdWutzujdvt4t328d9hoNTt/xzlCHombbr+Dj5ADOrZkXsDNbmvUbh4DQ23LTUEDNX10nvi002xVg9U4wpp4LHHzmtXZwBaBdHFIm0YUM9tIo68Z+FQht9FQdTv2188jCB/fIE/BrPbHArfvX7NV/UCgFVLGcl2cnwul+NQ694ndwdLti/JCBsGvBp6egc+DUHjHxHfOsZYUiWq3OtrHWE4Cz4M5VuRENXi2jFNdmU0jqkNytU0liuinhM34rbC1aIIdVG/36guqRL6dpDyRwNROYu8ZUfkj+Ln6VHJydyQyQNmeqcRRvXceY6pHJG3MpHbleNlpNhst9oF7IBad5p2YyaAuSu7izkDvGcYx1pvYtgueMLBeeM2w4kDwyX7zqN3x9zuctw87rYO9yZHPd3ebR3tHdMLA6MfToP5MREIGLha0QUvQGMAxKNQUYMCq0zNhPNF4JirSbbNpWn1OIOnZhpj04eSKdQ7AO0TTlJ7z6YoQovoYN/uiNAwR5hjfuG2Y6MtgGqxFSxZvnnY/OuNzBPrZBiPSqqB9J7KhGlgFXZjF34ljMwH0YUqEtB/RYFuG6lZWpc4ams0ec5LCRE/oYUZf06NImvky1smVrSiQ3fxI2LugIRrbgAHQj/IEEo8Jx4KrQfxbEGDFIqmfG0luGSf2vsGcvPaY4X8CExyM3bPHEfyU6h62+AkAJXBXcGMuyvJq5A75vLgoaBzA+TOgrJukwBxNs2iFmbYYFs36AM9aclVUa4VGIl1GCXcTs+vhxpIqPoBXWED7nmTBVMYGxxPZdkFEXrRRijNd5OZCM3OaxPRO14CetLurENxPnaaWvbgVxvjIVWpvJIolYuORTPpGnU2rbLms4TOIp6G3sd2N7W5s95m2u/pyYM4u0tuMK7IWg5NUOp9zudSaZt7jbDmDBsyefWSZydFSraIVJMYyjFUrI4fapN2atPwDV3Q83vH2d4/8trvf5nsHrYPWpNM+qBVj/XVux5mRlW2qsN56HXXSjzv4Uhe1VBLHXklbUbxS+FTaTnJIDGsHAA6ykQw7dqrY8RLy2Y+Q4CHGlivY0dIfD851UUaTR7npMlUssyOJpV0v8SNQyQY6bqDjJvxsws+fJvxsoOPGdje2+59puy+Cjp2noGPnBdCxwxBi+Qix/p3Q0Qv0OVIfFgXmYA9fZZsXpvpozN6c+7BAr4Qi20drdhbjmF3glrgBS6pUiYxycaF7g7ZzbCttWzp2OwUXGeHJjCDW13eCuUBMiiXpMJgHiT6VK5CuXNYdP4FZaZux+paNYm4ZKHIKYYy11xh0LMD9Th/hH1CgOugUHPUb1jjNav2uejAb4IzPccas+8MVAm0+q//urbuh1cPjy+guhnqtScMfqpnzCNKI7PxwBkE3UH0D1TfhfhPu/xzhfgPVN7a7sd3/TNt9AVQ3aOhhqA4Nng3VoW2jyTIs9ZEOz/yrETuZiuGA1JvFLmF1L8fglaMr54EyR/XtPX0qx1IVNjtYCICPjnBkH0mIWM/c/r6MvzeIc7zbAvQA+qNjwk80HNd2zLWSnTv7lYb7HZV97kFnF3qyqQyh/SxJFup4Z+cOdADW/r7BF0HD3jOPYCQ3nu9MQPBrfFp+5Q4bMOeqZ9KXBq2aDOhkN2k9EddraI451RSsJZ1aeJSyPda3hNkwTWa7cMmKHuPdSshQflLUukFKWZkfzGssw/vfPxdN6IG5rBPfo6NBewacrkwRp/AFlwuUCQjReuFHAE60C3RSXOvrL8U2pEuaw0rLPIzhZkO7wlAfm7XZB8ElXkCh8zfv/vp59J5NEeiSo0kVYmwR0Mk6zq5AjciROvYsCnai2JbfIXRKp33QcJkfglDYr9FQCHZd0Gg2gJBAYndKd2u/vLMr6IlbEWLwbeTSRuUMvGgHpLhTvpP7ngItZSRBpM9A6QsvdXN1Nr8doadICSa7Xth58cK8XsvEf1lqdU2tTtTU+xUutGiv3TBAP+yC90ASPFQkrVcPrunVC/QwfYMnSHWVB30BmPgon9Fy7aq9mo8SvTrSK/Pxa/RZH/AudbN398zltx5zZ3GsxF8YQ9VBU7mepmBpr2aLTpXXySLq7WaBpboesh7UAZMSf+dgGJFWJj5BTECQKNbVGTLbr7Sy4Be+0t2Lr6U50+Nr8ODY0otd9WqeccA6DljXfkIZ/nVkRMXCE38wB/IDWgFO8vUnT2AYLfhGTWut5yfyO9QHw4cbL7SLUYtj/cdx7gTNL0YvsHXWBlx1jb6tYk6t4QVlQ4vuTBSFZYsRqxKs8hvGEJVX5Kb5zbZUMVL/0eaLM3bymg1+8uOtvfQDnuSP43f/TR5v42n+jJ7GgGxUNxrWZCNFJf9gMF21hqjoBDX8C2/JVgnPQ7aUX6kuElqEPNH3ssCq3Rl+SguL8oIniA+3UbPiOVniQsZo/sLcAZ7S+XAJLHPIF4MQ6FF93I7MyWA0+MR15fTlLnNaIzZ3xxvss/kChsRkEM8Jw7vfYpMVDmFl6IsE7NQuNoCu+TyNYDS0y3TOINF4SiPw+yCpdlzmbqeegv4ARdbLWjGqGk6BrjkJOVd9HwvbkDMXFv6JsWDdlalqg+jzK2y1fCIDEZJmYrsytH+KNmhbfSZCukQAXhcAmCiMcNEbVSgCschspcRyumM6qR1sC0QwhdLqs9toNZp1Sing+SJWCSTQBeJvlOqtv7CE+H5ngRUxHDzVOYlOA6/NN/pQWMeFz/XZTBDyhhkwiw3v7rB6gqnRPT7Wn9TDfMN+uqVwQ6XERbYF8cf4Wt5aoXwTWGZY/S6gKSjU6It6Nrd74ZzfDczHBd/TLlfpU4ZrWbF1zWhZ5MCymK0R3UbRBSviSL/WJa1Cx8qmD04lqwjgh6bu7/8PcRCA7w== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Query Parameters

+ +The Schemas were successfully retrieved. + +
Schema
  • Array [
    • attributes object[]
    + +The attribute definitions which form the schema. + +
  • Array [
    • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-sources.api.mdx b/docs/api/beta/list-sources.api.mdx new file mode 100644 index 000000000..4ddd507eb --- /dev/null +++ b/docs/api/beta/list-sources.api.mdx @@ -0,0 +1,137 @@ +--- +id: list-sources +sidebar_label: Lists all sources in IdentityNow. +hide_title: true +hide_table_of_contents: true +api: eJztPWlzGkmyf6WC/TBjBWBAtzZevMAIy8xKQg/QePbJDrnoLqDHTTfTh2TGof++eVT1CRLyeA7PsrG7wt1VWVl5VWZWVvXnir9QgYwc3+vZlZOK64TR0I8DS4WVaiVUVhw40bJycvO5ch2qoON7kfoUteNoBs8qju2dhNz6JFDSrrx/eF+tRHIa4lsDBx7ZKrQCZ4HDwCCjmRMK5dm1he94kcAxQyFdV0QzJTQ84XiiZysvguEv/fv6O++d1xaR/1F54t6JZqI/OLttn170Lqti2L8edLqFfw2vX+kHfiAG/fP0iZCAvo/zEoBHoH6JnUDZAFtYjAQ8bV/16kCAhQzkXEUqCIkEDmL/S6yCJbzz4A1RbO5EleIUL+Qn4cXzsQqEP4ExwtiFOcIQgYriwIPpDJUSNz/u4khiGEnPloEtOr7rKgthiKtk6Pffz6JoEZ68fGmrO+Uiw+qhdFyiXt3y5y+BDy/lwnkZajg1K4FTS6fwQkyAFHM/UEBc+DkntuM0DQ0qJxPphqpaUZ/kfOHC9Fr7DRADa6bmsnLyuRItFzhnGFdNVQA9GQw/2m3Bg7njOfN4XjmBfnP5iX8TFFtNJFCB/vXwUF1NTX8yCVWZnH16DGgDBVFIJjEwiqkq4EVdXIcx8G4pwoWynIkD7CQh2SHu7CDhF3LqeDJS0D/w4+mM4GjGfDPs+A3MSMi/nviWH3tl2vcmYicKYrUjnAioCoRf+IvYZVIqsfNTbeRH0q11sPcOknThe6ESMzAIIP7EB2y4Qh1mEiD6sWuLsdKaAZxzJgnfgH5ih2ViR9wrJNXUA4rZZA+GjmcpUmAVRo43FRIYDagImghosydm8k7BY+AREQfbO/OFtKIqzobUHzg2B2MEA3t+hJISKhx1h4D8D818B3EibO+kGyumArYGtOPQYPNNSBDOZ4UQjX3fVdKrZOSEeq6VlYnjkllcASuMAmBG5SEzKvUS6hfxrtKFJ/5SqfBdpSRqrwloIh9xiEylRcHQM1x6EZhW7jZGYfH+YKL/g2cOmNU0ni+Q+6/NUxSqMF4s/CAC9JBBZLAAlH+Pr8E4uXZIks1Lrx+EJwhhZ8exd3ZOxI76BYTTq4qpgv+BoLrw14W/Hvx1Qg9MX1WE9zvcBwlLvSy/KkzP8D7tnfbSPZBLK8dZCd+/94BQX4LZRElQaBUydrIKWqnfWOArAHE0SP1w7ttkuAtPpSenCvQzeusHH6dguRdZZAwiiNSjyGTkLOmcvDT+AKjPXUqaEuHAoLnRbEkNci9AYKI4fD6FLN/zWL5GWZ5sPCnd3w8ujRAUuxe6VdZpc4jS+qg2Z1YXNJiyFirUCWBjWdFLej0E8H9xrUYKFHV6yM8202igPqkWyDmLd1UYkQY+wDDgiJIu8W8tTFXBwgNsgmYZqpnW+FhatBZ1/CBQLtl48MMnzvTxlzwOK1CQeT2IXVVnTNe8RLBrXjHQnMKYtkUlRYXPyGfyz0Tc10ojkLgWxmNpg//ynAVm3XrCnp72LjDaQCfExBmGn44ONjIu5HhJbxIpqYr7mWPNUB64B8IBJyPpmvg6AaymxUCkLl4tkQZ32BgZjA3ZnwA7R06GZzsWiE6YR4jHwUcQjQXwEH2OAH1WTaMQOLAUvgf+752j7oUOvDS20HEpJPgIcgxIgX9DfYAKKvgnRV0+tAjSTujbgF/DyxxQwY/BSZtB2EWBUUIM0gp0vXtl3PCdLM5fjAHQBHQzZHc8xDYwf5geU4E5kR0DJE3sNXbFaz8YOzbQgz025mS9gsGmcTdDlI9Wo4F/8kJwrhnOExT++GcQQjR1Fgaz4PBCD7lYuEh66PHy5xC7fS6LnQwCiVLqRGoeZp4zRIwWA7Q/kcPIOPYqK4phch84ZTyxPK6pWOEvxriSFfOWddw8ahztHxxZ+61j66DRhF+WPJgcN6zmbmsPlYK1qDx0fqg3MahtDdEhuSAHTY8blse9WBpsHgqAnjlO5uUjw1GGQKuZ5QdgejHcsMGlRXOyrCMWZB/L7B6oCYgtOvoo6h6aUTTSJpcg+oZbj3OP3xaBjwAffIOoc0dQFQQfmFHtFHJCEOVhDHZT6Z12L0e90b8xI5LONXkKc1otM4V47NQQzliIZ0hIc/eLJcR2woULdiYrKSsxuFiiva88QOxQsdwYDc0TbEJQYA98y8GFU3R0pzKP0rjmxlh8J6H4+z+Ch53z6+GoO8iz0Dx8NgetZKYlBh4cNA8OxvvjBjCweXBo7bbUZLcpDw6+KgNXIdBJFM4wgli5ztF4WgXb3FNkugruK/w/TxvbnU7/+nJ02+kPBt3z9qjXv4Tfl697Z3nmPtLu2fzWNESbllDCYiqu0uF9u3nctPaPG819u3W0f7R72Dps7e3LryoCG+J0aoyvuGGDXTtoHR0cvl/F3XUCgy7kU+IisBEnWzCBY/ui07+4Ou/+lEUQ3OYZ5Y3I6dFZGPZS1okpQvsuzdj8KSI3uD7v5oWLnjxbjAKk4yqBOWwcWa3Dvb1Gk37JI3l40AAL8lUFpjR6l38R55j15ejhAlwsHK9EUe2j87LMfLRjSqRoIDnBBAmBIBR9cA+Cu2wr8iFDbXHUJ4czgvrtd6ER05e9dMl6XAC0ILUjIBS4rhvQ7jKrVaYbYgSz4lRdeUZ1MUrCgAmMhyKdU8sUkPHMiUYA1fX9j/GCGqfTNCtyPcch/Z4ljRt84bySqCQ3wVDJAJjCYUKwpADfhxACpiOTWaeBv55u4M+zU00wWoM7IA8js4uxVr5WCt8GdgfxKEPFjlU2MhkLI0KH5J1DJEywgGEJ48nEsRygzta2/K62ZaxAldRV4N85IcCFgdawN1lHghhCZK1Wnc4Z5V4lZm84+rfAyQFb8qs0QckiA1sAitCbB9XxiM5qYICCO4bb1eR35jhH4tmQ+5mh+O8SCPQvL7udUX9wO+y86V60CxFB8e2zuaLTDxuHdoeHh1+VLyvGv1gO+SFxZXWWJaEdLcXcPpNzSYDdJCiWSMWUMrPdJSdYHh2wE7y3vz/eG7d2WzLNF+r1g/KJvw3oOAVKaczKw/sHrAIIw3s/sK98Fy38X0wQr9rD4dv+4PT2qn/e6xSSC8WXzxbDBc75GRmGry2GK8a/WIorzRFxxa83FshCpuEqy9mlkdP6akEt0jIvUvlgDX6pcWN/9/iokYpUGliX8K/+llEOkejJKD8qz4bFqTQESrLZk1shwYWCC/ohXWF6pBEZeKDpbsh4ie4QxYP1FWpQDrqvR28w3dVpj7rwGEO7/rBHv097A9DY26vu4KI3HEKUPaSHw07/x25GjbuX7Vfn2P6ifdk+gzfn/f6/rq/gwWX/dtC+PO1f3ELI3h1i96tB/yck4bDbHnTewI9RF2JJHvv68rzf+Rf9GI4G153R9aB7ejtqD866I+w7fNMedK/6PQj9+SHD+7GHuPUuz+CfZ4P+9dVt4eHw35ed4jPDVJzy9WAAFLjNPDIZhv7l+b9vB93/u+4OcbD26WkPsw3t81vTIn0Jk22fnQ26Z5SQMLgMb9+0f+zeXnQvXnUHQ26WIWgRLXirp/Bom1UEWtGszMASGQbd18Cx6+veabkq7Dki5xmZe+ftiKxMnVA4xS9Nn5A2G2qm7gc3rzCG4XQ/QUjEcHV3iDQXfgiybd7QDp/pXJ72aii8b4FmnVMpVyqYOyG6maGGkxP11UDARFr+HRcaaLeIfFjcdeGiAlq3GCKryhpkpE1bm7SBZWJNKstDU2xj0RyMRb8JVl7bViOHASkChaBUx2CAUphuQIEVxmFoV8nBOGqiALrIJvv9haY0WO6iPhMexYc5TGwfpAbrcjRKIgCKQJAJ81MhkwcHmaqI0w3fvxBzFc18OzT5JF3Uw249dVCfFtCSI25dRkSIkGnJjY6SCmzAgiPc2oKV/9OSmCM93mLTMiveUhRpZFjM0uZV2pBLIwzEA3f3bGX2FkEjdDekKFCSZAnRy5S1pQDM7iYjk1Eatoj4y5hE/M02cZ38rhEZ17c+ssTEHv+uM6yy1XhKMyBQi4LYQvW3xUgGwCkW5ZIx/gJIwpaRJIoMZ0C8KyoREL0oSazAouVYVEZIwT4YmvZpVZyftq/MbrHhfGLUSgIwBlYTqUh47gOUZU2rsC7eyDvOgQDZtJnDejTXMdZO84rDz0Q8kcqUcsA9dlQZQFq6oQ+vMTilniwILOM83UVqYAg16jHOwOdaO1JPbWWTXXI0stNpoKapnSsvdhtNXtujrzV1EobiCltCJIGT0B5rTCxQEc+PQ3fJfNQr8CO9jecvrJn0psB/wTWHpngAW3vqjmrWYNameVjleTrhyjy1Qwn2n2OPq1mSqoHslAyNeH0q+AwnYujPE5TR10oqVAQuDhO9uBXrBgx+tGqucDrWKVVaYGmoiThjYQAlA5k5rBzrnZangdu2o12ARGO0yc+4OieinUyc5L5o81fKbd4xyqEy920FRpbkFIQOi1TDmbPgOWL6kh5l8p06k8QddLwGXv2MKk1Qz7TMl7sYo8md9MqnJhMMOji7aiQ9YR/gBkYrSQYX5vaIe3cieplyEq1f2ZXFQ6Kloq7tB64XZfNBq1hixWj9Krs9pPSrZDiktWoBP2BmpvAWRDGe07q1Cjc2ViXsMjhp6hlTop0VPVcCzkUGiJQlQe/CTG8jdriojxVX5QR6kQcF+SgokMlPW9P7cYf5q1PdmM//KppnfNhNwo8TRouDzWQ1D9TClRavZU/yjVB+RJsMLk/EOH8EJrlcSCGeNvsjXKvzmvmUK5S7WRmflmLpJGAuNCyMtzIATiJbzDiYjNfjiaChrrljK2hyYeEyBJHQuTCOKMAfr0/rom1h5aFI9qSrAisPbQk/VGTVqSht6cekAxys0emAU0XnCgDKa8c1C0CVWs7jkI6SEAIfEiWQYSe8+yCoQDFT+wYi+wHrtz7URY4d/YXyyF+sadyQ9omSPU2HTqKP/JRSYXmOS5p6LamFyo3QcUELnx5mpI/QLGFi0uVix2zS7Qd5J4WFsFi1k2UpLFgNPHsSTKRVwDFbgaub1pEsyfRySCf7fisTqGsJxCJj6VqFmA+x/ZOVznZgUQ30DiNKE6b+4G8Ozc8VLsLtzJT1ceTMFTg0lZPdRrWCKYIhbWlmcbupWFiOGlPF0RymCAJOaUcXZGI0A1M7891scvWRkzmFDVY+GkPoNhDXZqOhY71EMXhv1RfhR4f3fHlcsYDwMT+vZuOBp5CU6K456JFF4S1v3caqUIWqnSSquzTJaJ2CMTvpV4E/AXWqV4qHRzI48WESszebKxV+YmP2Iukhki5pqWhSIvnH593PMFlz2b7sdNmi5xPvpbfPzrynpKLlkWm1aR6+Bf/5qnn4J7G5WK5kFafmdbX7F8qhNNXyaanoWkHDrrhlSFX1T8+8revvdV0DaFpQFVOHQtXEwmQOV6Enfz9Lk96oGAY5kElw7nJEMSXQI1gub9902+ejN7QHE2IUuYGdBqME+M0XGEbSWQNTgKAzRzQyBKdgwMS9DAWY7MhkqUh4M9LSaDVrjeNa62jU3D/ZOzppHdd3j0BmDg52G43/z1nk3gaCOkpKldP1beN16nIjscQhcsWKifHnk4MwYWvmg4OLXCmkZvNeUsFdyOCiTyNshowxFmlf8X3qwaMRfJEbF5/kCZuL7zYlc2a9zceHTp7FtnFvasnAfBRls2FsaFqLQORMuX9i/YnSGlRmMUs6FAWtVWvAf0HQ9k72GyeN3fpR65AkzJyI+RoIkawnADdBa6/WaNZau6Pm0UnjCDCrHx0jWg8r64q5vDzrvb0v+te1Flo37L+36uBBx8VqINENAuBcTQwy51v5RAqHQ2PfpoPojkeHIeqV559MWLPq2SoCL6Xj2xuI92vHU7VpIB3EUBHKFnTkcJDyvnTOlEEahaR2edcPKFFvilfShvny/Dp6MhgMBNLCHYJNBP/ac6C/MF3Q1phk9oph1aGS44PGcWtvcrAnZetor3m4Pz6eyN3dxvH+8TEJnwpDWJ+e3vw8U8B6sPuubwFHfgWCgOwD7QkBGnzzHX+CsaF54bbJNDW+Am9cwJMwrzpXYu8Q5N6bxvRcTgtE8GrXuOmH5/1wIU9WQwbcD5yps/LEhnFpTruv29fnuL2YbDQirNJWXdszq7NPB7phcSKM9QRQO0Pl0r5EXexoqDtJtjppqDd9dJyn13TooUdf0SMLOi0gNKpk8fUU4nunrupVcObQQlC56Fhi4lWn4XbalqUWUe1cU3JHn1V/AYFlmoPUBaV4tApieGnbnLnl6wco/2GSoLDqO8UQKCVlnhupDTnPMgWVAzDfwGGxIgjZSCZyWphIi0bReE+2plweu1GGaERSPIBpRXr3g8pT0RmGuTm0/0kazCe+wBE07RKLlS3NJHN3wcicRj6941zQk3p35YL5qdHUkhd3Sisfnxoja6SyqWJtkXRtB3XWrRJ2GcXnk5pb3d3q7lZ3N9Td4suBPm6p35Lr0yy7Pteezj/g4llyfQKSHs8354h15S0zku7r0S7SD29H+sof3Cf5tEAX7Sv6R7yUl5BvJ/zQB9JN2bpZ+lNeIIJER54Bnm5V9gnhnWLMTiKRanfF+YfkbGvZRaSztCaPGcQe7WzLsEqbXlh0ztebcHUDWcDsxUpbT3LrSW5Xo+1q9PdZjbae5FZ3t7r7beruo55kghVpi/aTwng+l8GSJU2/pxtX6E6Q5J65ROWIVUVvpZK7P6SS9xwq41Zz3JwcWmrPlnv2we7xpGUdtOT+YfOwOd5rYVV9utbfpHqcKFlepzL8Zj4SiakmFIsjQbjCyPftfPovxquRJlQsEaUuMfAuwhtOUt9xr+w7XvoRzA0PjdZy1+dl4V8Pznk/i8Ej3fRFKIHZ9MrXUdHZ2a3ruHUdt8vPdvn52yw/W9dxq7tb3f02dfdZruPeU67j3jNcxz2BLhbdy/Fnuo62wyeT9IUappw/ULq+V2cftdrrSmLj6OW8yNbxijIon6qslsZZCnOZSC8lF5o3Hy9ggbaBaUsHuaZgIj0sPHF8vr0ON+1rgs666poEvugE4AbLWnuCRZT6gmgtb8kojme5MWBIRsH1+SqRe+lEySUMfMGInIKh/oo5Ts2t35QPFgOc8TnOWHQ/WUqhzif53/1VVQI9LKFEczFkXq8pF+CcufQgjEhOpCUu6NZV37rq2+V+u9z/PZb7rau+1d2t7n6buvsMV117Q+tddWiwsasObesNkfhSr6k4/I/22ElVNAYk3sK3yFe3Ux+c/Ao82Aztp/Slm4XEjylVXoaZzy6hJ8hIxIELL80l95+BN8CTh7pcOHVzFZ/n39NN92MgyApbk16ugA3oTn0eoE7UDBw6w0fSSMCZtrq8Pj3K8yhkU6W9hDkIBlPNHKenx3iLBkQO34X6UNMDfVukMD+Y13XgPvz2uTCgNXNZRb5HR4P2AjAtTBGn8D79ShZddsWjl76VlS4dmOAvnwDqY7OWeKVkQMfLsObl+x/ejl6IKTqXpNx8f6JyMBoA9bgCESHj1Tb1H9iJ1pP0Joh2rsIGlUVMXJiw0N+ryXxiSwzADBNJ27kbUjb/xEL+ZpU1X6d555mzcekZV54in9G7WZh5ycy8vhSJfxhoNYZWI2j4eYccFkzaG4srti3QWAQh3ZCo9cWDM7xaBh6GTPAEoRZx4GtcCI98XZRluPbFeOTg1RBeHo933lv6VEC+m7mBQV9h0MPDFn6o/lcIFB1Ug5tpDFr0xWjR9wlqpBG1ViODUo2HrDk18AMJv3NQDI+FSY5xHSY3RF8xSir5gTgLOv+BTtB+yM2ZHt/Acoktbd96xndDCjjjgDUcsMY2INT482qEggW6jXMgO8AC0En5T5ZAI5qxewxrpVUn8C+pDy4NFqBKUMLFCf/jJDVw+pegF9g6aQNmuEIX5elKMbxmRsN6SE8L/qrvS+YEQJGCZXxdH1bCAt0Y32QbE1fHv9p8ccbtNE+Cn2P42lZ6jSX569jdP8nibS3N39HSaMcWxY2G1RFAVshfaX+tnLcL6Vpd+H94S7pKPjREKOnFOFlAC1dGKNWk1dbMURTxL5SM0PejbxP5c9JECM5R/ZW+yWVKB9jwZL2EGM1x8ZJszEmbkSUpDDuWdENwgNfU6AoJX98AVBdv9T1mAQZgWJsL7372dSQ2BM7QvVLi1DAbnK75PPbwymxAO54LCSL1hETgLW8xGy59/IynwNeIJb2MFqOo4RToGmIVzMP+BJPJDh4xrWw4FvDdfBMHSI9c1NdJphMZ6EuxsV3ebX8KNkhbbabcBYaAYHXBAVOZES56oxJEAObp7Qs/mL7UncKX2BaAYHjE4rNbb9YbNQoX8KZWP4wgaM0AP08+Lrvmw7JFgfycZtO/oQ/V6nULA46XC0yLITViDoA4wLypmAATQpYZ0Akfff6MyRKMuB7wMX+HC8NOc/dfcsB6LY2+rS/drqTTR4XpB/MhX51gqNClrJvT4b/rE7WP0DH5hO8XEnL7vdlv73uzj4iD+ajwF0rD9pOw20/Cbj8J+zt+EvZR5U2/8vyF6rv98uv2y68rvvz6qNClHyP+bWsGe0/bz77+3T77+rjFyn87OJWg9+kGEUQ47/lSKhs/TQnhDvflreJMr1IxFUJJtu/4kwByTeZQ/8ChHh7+Aw2IN3k= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Query Parameters

+ +List of Source objects + +
Schema
  • Array [
    • owner objectrequired
    + +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 + +
  • Array [
  • ]
    • passwordPolicies object[]
    + +List of references to the associated PasswordPolicy objects. + +
  • Array [
  • ]
    • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-sp-config-objects.api.mdx b/docs/api/beta/list-sp-config-objects.api.mdx new file mode 100644 index 000000000..e3b959661 --- /dev/null +++ b/docs/api/beta/list-sp-config-objects.api.mdx @@ -0,0 +1,111 @@ +--- +id: list-sp-config-objects +sidebar_label: Get config object details +hide_title: true +hide_table_of_contents: true +api: eJztXG1T27gW/isa353ZbYckQGm58OUOpbTDDi3cANMPlLmr2EqirSN7JZs2y/Df73OOZMdOQul2e+92O+6HQmTp6LzrOScyt1GWKysLnZnjJNqPUu2K8/wwM2M9OR39quLCRRuRU3FpdTGP9q9uo0unLCYU6mNxUBZTjEUu3495yb5VMqEF9cBMGjlR0fXd9UZUyImj6ednPb9DhMFEudjqnDjA/hdT7cREFU4UUyWIG5GNRcacCE+y9Ow68WGq46mQVon3JvtgRJHxokIZaQqhPuaZLQZ6Rj8EeL7RseqL07WkiqnksUJqI95FftGlTd9FQpoEI55aGMGO8kbqVI5SJcaZbe/Vh/xWuRx0FcS9jbY3N+lHW9D1fFhVlNaoRLgyjpVz4zJN50SQeFOmIDoyz1Md84LBr46I3UYunqqZpN+Kea5AXlor51inCzVjJgpdpGqx72FzX/E6S1QaLdtiGIQQM3rMgsIya41BLIad/WN8zi25VqG9EvzwBc+puXSF1WaysvEFrBh2oYmwDpyitZ/AAPihbdVHOctZtIvh8atXR8P/nF8+Pz8cHp9dHJ++ie7YGFl6o57PjxMYcNUUGGQr/1YqOxe5tHKmCmUdOdRIidLBHvg1kPHcMF8LzxzNxXGyTgmV2od+sRWXwxPxMrMz+BspdJ05+ivKK9eyDUpEgn1e2oZplEnyTJuiwVCt6YW6EGT7gwHGJxNle64c1cTd4AedkOZYI6s7H5j5GmVRCFFoGKUSaKxiDWyuU4yBZ1P8RPuFLVWDL3pwd9c02xtsEQx3r3d/JbW35QwLYGbboOPupeA6w5Hh/hfRZbCqT5LVibgz+zdmdm+ZoZ5Mi4dTPE9z1d4wMG2tzU32HtqG5l3e8wl/4MnimchsgofwlTC0xlXaB4JOzH6tLw8A2nrzcKXm/UTPdJN3mERhLWiO2SX80JPtFWnO5EQbfzClREMQEnALwYK5Aw9B1WC+cci1ON/aBE81COk8/RvzdG+Zr+7pAao2PT0MfQVPj+HqhYpq7r8tX7dqrKwysTr6WFgZF5l1a477Zcu0GTsJxQJhYpi/mKJC0Nja4PgJKQNcBjYwb6FUdhCrcgQBMLaomQmuQ6YLp1UIE4Z6y+Aj2P+uIdtV9EMflQnUeo1hpydQXGnVUP1WaquSxuJRlqVKGtb2WJYp9D+WqVsR8hh8k+xrz8kPOk2Jy5/fngvaDGzTyRtLY7KCHgDI67EmWynYRYlFwVKzzLve+X8b0c660uUw1aSmI2th254YVjWLHrMDWEinYIpRlswJp8PXZaqTL6li7qklEoU6LT1EVfJw+L3URvUmFnUdOFTMcoyFAhRvdIIVUAo04Ul6t1B+XjvCoIn+lnguEzEM8h0GYaAm8tn3oHWcPMzQpdFYL6olQi8S0ppt1a6So2ebe9s742c7Um7/c2dr9+lobyyfPNnce7q3R7vPUCiixl4XMe2tXym4oo5FmsWwyO9QCJICRQvXsLT5pzB12wZM4zNrOT+3FjPwK6iDsCGkeH54JnZ2RSrNpORxOVlSguldnq/EPyT3hE+R+LRZx4oy5Yyi8MXRy4PLkwuMDI/+fXl0jt+I1kr34QCFpUnILTPOzdPsg+9DeAE+SIe8lkIdyADicaD6GAJJ45oTtf/k5g7KFCGisSLsvmZFk7QY22zWCqXYt1vET7qv+huIXowhR8dTMZKUemFCmv74II5VXvROgiYfiynwjbKP+uIgSTQJKVOBaARRrJ9TSpAJHUvaExiXlJ44bWYlEl9WUM+kZYuFKpezcQVJTppGoeAA5w/7yUFclGCOxWxGYe0tgcVgH/DsNbfUAmgojVU6NwWOE6xI0znUaC3XE5BNF06EdETmckg8pppXZyxKgZVYnO5ee2ZeFBk/i2XpPiPuzlKknx6LVj+4USH4uBDy2YitUZkpZKS6qYXFYVZtrirwBXJ6mnSx28VuF7ufGbvLD6teZ3jK0GdrTWVjZAn9Wj48V6CPZe8xmagmeZjsDbkBVF9BpJ/fXiCw3yvuYwKaEhj8ivjIH+WrxVFtDz8+IvhRG6tlC2KQ9eglGCMTqWSf+V5wHC1Q4pPV3VBbjjQc1KyBiMiaVsyzkqsyWxpDnEi3IZJMOfNjIaYS+VFyC9xnQNrVJL26eOyQZIcku9OoO42+j9OoQ5Jd7Hax+/eM3U8iyZorjpaAk1w5m0nqXpOnheckrRSYIKqrA6IOOTbVMlohYqLGWFEbOUSj7a3R1ng3VjuJ3EmePdkbb8fPtuXT3a3drdHO9m7UPOuvFnFcB1k7phr29nZkFVOLFziuNHAuV2RZ0m7/ldxJpbRGqafGzdA5VHq9wI47q9jxTVZANhAGdrT3tBfpSwbu1Hry3JotbawIZle9ZureEqQkH4amtSs66NhBx+746Y6f7+b46aBjF7td7P49Y/cPQcedh6Djzh+AjjuCINaYINZfCR0T4A6CZmMYBTLEJdRrGl/Fh+5j+ypJBfRaKHJ7bxVFXmSZeC3NvAJLrtWJNAt1UXrD3BnNtdVcujcgJkiRRiBraaBb8io9U4RJ4T/+9gPFMQkEunbeOxgXkMrHTOVv9S7axGkJDjkppBn1XjP4mC6qb+NBgfugEyTqr9jjDNb6U/1gMSSJ+c6IOPoY+7ssdf/36bpbAsdg3lK6OPe2vue6gO+ZS4MyQn3MffqqIWgH1Tuo3h333XH/fRz3HVTvYreL3b9n7P4BqB7Q0P1QHRM+G6pjbn9T1FjqJV8N/X8jdg6VwAG7t8hixurJAoMzroArEUNA6ZRDJL0cGA0WF5z9j17WeK+QoKHnim+SR9OiyOny961/i++uL3PdRw6DvYq5yT7042w2GEFDa5IP3TX1gUYTxMHZcagz+qxeq8mDfbpj4l7Z4bZt5KB0vl7wScr0HgpZcY4SJLxpuEHXcIM38TBYzFFK/Oiqt1agnBX5INelTe/+vCye0D2yrFPfJ3fDfAFOl0QkEa4Xr4GeE+72u6+8DLo4S6jjv3p9/JSmbYvnSlq+4k6XYH76+e3FIzEhtMnRXjoCukpTeYB4OYOLcDY7qC6E0CI+YGxWTqbM+EHryg1FjxinEFi8M+dKiavjoIQ3SPND5GVWKS1SnApo1fVPlXUSdaNSOgH7C02S4+nEDKChgWyte8SnHZcF2vjb8/S2xTvTEy80JSF+tdO/PskicpUnrvJKLtmQ60uZ+EdFreep9Ziae7TEhVftVeyvcMcIYSIhU8fa+uLNPb1egx7VUBghqss8kCYCH+2LUnFltS/mo0WvR/TafLwzb/1Lw61lwmcu4XASpok4FvE0y5z6lxDkOhQGV5MSUfTFbPGbyj2OiN72ZoOlnt+yp3sAhszfCQLDeGeSIzqYGZdkvkXCIfkLWxYx/wvf7v+lJTMPX9ErJJiZZLH7Yp5pwx5t2PM5wAX+/fFEjoXYJhk4D3gHOFzYnzNBYLSR9zyttVmdyQ94DR0NMVhlKi7f9x/2Fwku/Cb4QbTRmIM0TLi6vjqGzyLQojOqpayqI7CswVV+0wxH45LePL/195p0XH5r8pLEB4vGyalJ5187S9+TSb6dvPsXZbwu03yPmSYgXXI33jaUBE0nfx7w2mojjzrNU4X/8ZRjlUG15Be3Co9imoTyVBbk1RzV8VQrbgHkShaE/TbIs7IZRyKqdQp/5V94ExN+1c+CZYmiTaegx03qamfJAeOBJdmVPrsyXJnI4JIoKVVfvEVVZmKYhSoyuqyLZ79moTQ7h2XOyLDiRWVsgK7ZrDTYjeKynAkJl3rAIxLt4tInLhQHRlW6yBj61auqKCZXIxH4tU1lZ+50fO7fM2wY/oG9YHcXWstQPVmRUDqVPbUgQ5XWr7u2YftDtOFtvalKc6oJkXUBwFRjh9fHFysUQcyE7zMyOxmERW5Ac0GEyiPvPk/6W/3NHpcLGM8zV6CKbRB/paq/yVFdfwnxs+yIt4u2+vfy51bCYUZVyCCn5hmpKLya7MtQ+hs1oQz1xm8WoihtptAnzbq9pS4LVWZ3NBxeM766XhRd9AnUfbeFK9f3iqt87scsCvnVbyyohKpr5FdH5AvyntM4/EJb3d39F7bmIlM= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +
+ +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. + +
  • Array [
  • ]
    • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-subscriptions.api.mdx b/docs/api/beta/list-subscriptions.api.mdx new file mode 100644 index 000000000..bd3d7821c --- /dev/null +++ b/docs/api/beta/list-subscriptions.api.mdx @@ -0,0 +1,99 @@ +--- +id: list-subscriptions +sidebar_label: List Subscriptions +hide_title: true +hide_table_of_contents: true +api: eJztXHtz2zYS/yoYtjNNNKJsybIde6bTU2ylUevYPkturuN4WoiEJDR8KAQZW83ou9/uAnyJtK04uV6T6p/EIoHFvvHbJcgPVjgXEY9lGAxc69DypIqHyVg5kZzjRWU1rZhPlXV4ZY0iOZ2KSFnXTcsV2RCY9aOIFeMMJ7NwwrjnsVgPZqpIrAXU5jzivoiRzuHVB0vi/HeJiBZwL4A7xIQvY2t1kVf8lgWJPwaisEYkVOLBqnEIf8ZJFLTeBEMh2NUvO6x3PmDDmAcuj1x2FHqecJAGO8+Wvn4yi+O5OtzacsV74aEOWopLbx7KIG45ob8l3WCLz+WWMnRsJ6Nj5yI8ZZMwYn4YCSYD+NMnTaKYkXiXyEiATifcU6JpiVvuzz0Qr7O73bSUMxM+tw4/WPFijjLDugL0BTM1GX1ppwMXfBlIP/GtQ5jn81v9N1FxxYSDFujXctms12Y4mShRVecZXQa2QYPxTLBJAlbTWmVwo8UuVQKGXDA1F46cSOGyGxnPWIOs00DFz/lUBjwWMD8Kk+mM6BjDfDHm+ARjZOq/W/lOmARV3Q8mrBFHiWgwGYNWQfHzcJ54WpWCNf5jj8KYe/YRzm6gSucQPYLNBHfB/ckOOLAmHGYcKIaJ57KxMJEBlpOTzG6gP9bQPtFgNwJVNQ1AYy5YDGwmAwfngRgqlsEUojpGVhgJwhwesBl/L+Ay2IiUg+OlP+dO3ERppILZYDFfBC4sHIQxeooSuGqDiHxPkjeQJ+L2PfcSobWAo4HtRKXcfBEehPLUONE4DD3BA6vgJzSz6isV0sZ5JtKjPFlDXEF+DabWctWzXtCUzB0ShTZEV0nFZmoRxJBJ9bQx+kbwF+v4Gy0XcGYbPp+isV+kV9GHVDKfh1EM7KE9KD8BqfAGb0Mu8lxFjqw3rzBSh0ih0ZBuo3HIGuJdQ/82u9Bg9TIo0VxpMk80rII1Leky8Y69sdodZzLZ3923nW1n2+62d8b2M+7u2x3e3T/Y3XPb4tnBG8u6K/IVsk/Gq5j3LmsW0g1GELeVQK2BFqqGHgL5v7mZUQOrRh7qa+uZGAyUW7CZQopToN8om6xwx1peo8Z1wlSo4872Nv5XVt+JgSoVeOKEkPshZcMMPp970qEEsPWHwmkfqqbjUcTR6jIWvipcD8d/gEZK1r8C10I4lUqEf+Ng4zLNkhggXsDHnnCtXJxjSP+eDAQCsHmEhomllhEI13jTiscURGWD41ZJg9uTdnsCnm3vOwdduzue7Ni8M3bt/W5n99n2ROyMXYFOqJ37o5bCKeXFeo4jlEp3mZINKo7+UUsVbt23Irgc7klgMna7+BOXzG3y4IKDY/SbFXg7JpKtlTwSHHJa187WLax1upYmDeYmJa65rpH1orQmLVJdTAQIZa6sl6PROfzs/9I/HT2/GBz/2Idfg9OTwSn+MTy6GJyP4I/XZxc/vzg5e12tAEpmwFVaELunZ6M+bPSAdvAKxnxhgSaGfMAgxQTx80i6U3EUBhM51QhCx0yrOBd5NJMwQdWMLqnBiBTLmH4WGRyhFpY1cfWgOdKRlLIgFcJSlM4u+v++7A9Hv130h+dnp8N+ZicZvA91CmkCn3NYEcTV2XgwPLOf7W23mZvoAozp7F8W43zUflmEEPoCMJ/roJrdjG5SxSDUQnWUIi3TK6GtNBcVElc5wySR97B6Li9OyEkhl4tb2AMC7m05iYpDnxGkjng1NNPN5ubmpmWu4iaTings1ZzHzuxV6K5hH5Iyg8s+zFGASlvgjcNfT4+arKf/A+Md/3raezU4ahWCAO/Bz57534xAX8+5NfdSr3q5yqHhupegn8Zm9xjdEX2rvjUBz1KkPZKjTMREVc91Jf4ESE7AWTGfLxA0c9fVfqWLOQD+gjA01hqnZ7/1LkcvG7TtCtyqBeynQYhWingR6WocPkb0y15mHpYRet4bDo7qaOVjNQUoI7zEFew5V9JBQbKbULpcKnQNSGgI4c65UjchgBEO9EgzKl+u37voX/w2Ovu5f7rugoJHIhqFb0WwuixdzJcpmt4oCK7kEuKPwvo656VRmE/IfaM0teghNd4AfjIuq6YOO6yEoFp715hREaWVDFsdzxlY2Ypx1L9Wwm5uLFK3TpB4HsKStOqprpvOrqzLzoIsNDGPgzkJ5mm7UpmI1NFA+GcYm/IVbjrwlyoxjiOXy4f4qcmDuZFKuc9Ya8VdyUx1DvWwsQrTPl6P2olBDTj7s0hdcOSiVTDiUzV8DvtkeqxV2nJZhsO4p9Rk+ety9OSmqGCFtXa+Aub4lA2Q3yhAVtTOeTD+eq+HzAxmp7pH86TdsV05lbFp2jzVzY8Z1wm/n4uGpVgcwBS6xoZhEjkC4JyiP8rh2+7sdHf39p8dbLc7qCFg8kJM1wLOyKMe+1hOGLZnsloxdFQLlm9xn/8JezzWiVMBkwECYGNLxVvTaCuCjC9as9j3CEFx3XXM+sbvocxEvzZb22qqsm+AjN2u+FHBNEUVFPyoX/GcZV5g1bdsirp6PROgmnIzm6kZtdki4Qj5Hntm3LNjiQm3gv0UIg6IGNjYRljx1I2AgGHcu+ELxQxjQHIK1bWHaJ5QFfhqmBU32V6kU0CpGwXC6R7Lw27w0/Ds9JzD7qgnYGhDCZxiDG9BPL7Nhboh0H6LSFahFgSaCu2LM3HtstG+vfrhybct6WK+iRcDl33/PXsDJXl7p7M/cXnb6Xb3t7vc2W63n7XFwd6O293bcd5YT6+JjMaQx+Bb1VBf5Rw8MPFhHdInzCbEaq3Ty0Df3aLkYhsx1Vbeo6IbCpxuWV9NkDsaiYlNAm+lEXCRPFo/8XDXrbezXtJ9BXMlru8rdUuVbn2FulKgVsvJLFGaCqtciJS1vgrq6zB9iqnvws1lXFWDmnJcVIUzRTST7p5Z3OvISSPlU3x1eQ10NWhXi8C5y/ofvgiDVsvitAr9ZFP3vgZbA9niJvkPiPRyX6gWhhXhURmWlFBJcRf/X0XiklJ1t67te+RJRDL9KIIN2QZR8+dj+tmlVvs4dBeIDGHv4550H9MXvgNFuiKG7edorWbGC4g9expxiRwKYtmBiQwovpcutp3oOZUmmfVdcFx5DwZNtNpQibupadmREYa6kdx5C7TWaX1eBhLms3QKk3nrvmZZsS/4eG/7oNOd7HU57zzrtvd3xwcTvrOzfbB7cICr++BwfCqKjfO0ob56wgCgpHSYB3jJk38SOOJK98z04vf14Ms2IBprVtF6bCam4ZfFAE2aAF+fH52z7j7zeDBN6DqfrighsC+HlXoPJNeEzyAAZS1YTzsTx/0XvcsTbL6aHqPVRFqVBmwPCjmAbQ4+DUNfmIU3xLER4IbnzZMWaxiqDRCIB6o4UOpfagEZwGcGZMIMs3rNjCJpNolCvxRKFDe3MXuCXbgmG+M1H3cEBtkdJoS6YdXA5DOP7ROjyYZ51v304zpe1OgJkxjBtlwtlnJVrtbPKaw7KRoFgwM4X6OScuIEmCMxi1GYeYth0dgHeNaaK3M3KiiNVIoP8BzcHhGFO2EEhQZkJpBNxoqZdKRrc58H6bgsYxXRKqW7V5qZ4zikew5P1Bpxd+5B+rFJtOyGLnYUFi14CISyEVkjNZPJSOZgCU02ozJzpYGvWwyb2N3E7iZ214zd1ZsXKVzXdwn6tKvQ5zLAvl8Y0eZZgT4ReU+gW7Y4SPcGtSHpgYmBSD+9Hum+JI4Xt/P0wdtnwkd6K68w38vsYQ40pOcd0q0/twUySHo0z9QgEwn3kPjOOSZFaVXtVFd7EUZjCQ4a1EBErDrYIkyoXxMlQUCHpFSTuaFQwXexOR6loTRlQFw1cG3dctggyQ2S3OxGm93oq9mNNkhyE7ub2P0yY/deJFl+pmFwkkp8n0cL7WnmPj25YzAgP3iThVzW9y6iFSTGMoxllZGDNe60x+3JviO6Lu+6ezsHk46z1+G7++399rjb2beKe/1VHsdZkJVjqmBvbUdSMYC494DjkgCcS8Vh6Jbbfwk+255gWktPMRBuBp230gYjYsfOQRU7jsKQveLBIkVIqoQh8yfslNNgrI9jo3QsDOBsCnkxwPP1EvhCV8KHijbDg8CMDvFj8KIUQDda2L0JPv0yrwYYJ8tWMcdiFGUCL0TUHIJjSTxnP0HMBxQIwU4hO39GdGpM9ElInl2gxCcoMevfOkJgoGfIfbeuvzsI9BNDNtQGvqPRq6sdHoADQEGgc1aGOzf4fIPPN3v8Zo//Ovb4DT7fxO4mdr/M2P0IfG7Q0N34HAasjc9hbGubZVjqBZ0z+6thOoWK4YDcm4WOk0TUbk4xOChBCbgo4wUtggfLj7Qr47ERjEw1PzSnHGwE/eBudumdr0NIcK51jW+N+QK8EmWb0uvSc44UrK1s+spr8bqG0NKVj8J8AKODsZctPpfZKYYgvKEDZ2PQdE0Sw9MGOmBxAL2mpxdokZkiiZGg0yYR10ZLj6NnZ9rupZy+RLQIE0iURKaJp2CNV9JlfKkFSpLvlHlva0mvq67IB3JdRt7y02XRhO6QpU59964G4xlwuiIiinCdO8oQ8bteveIu+Z6ENV+nstgZDuuw4vFs9uSn16OnTB91xayh38UUkg6McnYOLkJZsZc+EsBJtFHl78z3Sg9dMArZxAOBmXkFemCUcArbxQXkd1Jp+fzU+m9tlo9/3/HC85vAZscy0i91KhpjRNQvhV/NU7l4Qa7HMvFNSs02h5SIGr4xWuJCq/bK0Yd4HEgFSIJ7irT16MU1PbtAD2sxuIJUV3lATRg+yo/KnNRqj+ajRM9GemU+3gSvZxK25JXz+zptpceRB8yZhaESPzA6no1hcDVNIIoezdYNLmpTRNid7QJLtl7SljYATOLvBAIj0M7Ex7jBE74JAfoFrg7J38myEPO/08s/v5dkpstXsA/jSDyU+2iecUEbF7R1DlCGf73NoWNBbKMMlAe0Axzl9qdMYBgt5D1NqzarE/mt9IUN5QCrRAW2H/3jME9w5i9GN3B0NgbSMOLz7OEhfkjF0MK9rqSstLOwqsEqv14IW+yK3jS/WWcLt92/m7wocS9vwJwF3uJzZ+k7MsnfJ+/+nzLeJtN8jZnGIGZ0N1rWlBZFJ39u8Fq1Iajo0zTwL9ylWCVwDqVP/jWaIqG5x2P0aopqZyYFtRLmgseI/ZroWaFPkQhVP4Y/FIxEaAp4HPvZCjApH0sP6FGzO12ZU8BoYIl2xd+AzLGeoXdXZlCaihZ7DdVd4IBZsLLD4xpw74/QlHhDsMw5GpYdp8YG0OX7SQCrYVwmPsM3oh7wCFcqJ9GJCwq9QKS6CAn6ZbPSKEZXQxHoVTMR+epsMtQVifXwaypmLbC7Mi1qUH3hhYJckAvh8bREWe8VmJQ2eJs9E94ca0vIugDAiq8svBqMKhSBWGBeBguj6ZaZpLZwLBDB8ki7z06r3dq2qVzAF0xDFUM1XCBOn+NY/e7Yyncgsr78R31uzGwViPG35tjiQgbMy+y6wruy6is8qBlmwCgO+PAB2yBY8izxsv7SC9Z9oDpzgt182uVOnr+sr5fVau2twMZC+nE20zrQH8BZXw//rM+O3aPH7LNsj1Tk5htiX943xO5xh/T11Ud6w+a7X4/87tc9Jsk/v/ZIo2y+0XWfevMPpOXqvc77g7C/4kuVOl3RZqun6UcQhVmVh/SlXu6PfYQt/I7C0fyBSy2X/wXPU7+0 +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

List Subscriptions

+ + + + + +Gets a list of all trigger subscriptions. + +## Request + +

Query Parameters

+ +List of subscriptions. + +
Schema
  • Array [
    • httpConfig object
    + +Config required if HTTP subscription type is used. + +
    basicAuthConfig objectnullable
    + +Config required if BASIC_AUTH is used. + +
    bearerTokenAuthConfig objectnullable
    + +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-tagged-objects-by-type.api.mdx b/docs/api/beta/list-tagged-objects-by-type.api.mdx new file mode 100644 index 000000000..1d6145d3a --- /dev/null +++ b/docs/api/beta/list-tagged-objects-by-type.api.mdx @@ -0,0 +1,85 @@ +--- +id: list-tagged-objects-by-type +sidebar_label: List Tagged Objects by Type +hide_title: true +hide_table_of_contents: true +api: eJztW+tz2zYS/1cw7IcmGlO25VesmZsbRbZ76jixz4/LdZxMC5GQhJYEGICMo/P4f7/dBUiKetiO02kvPX2xRQJY7Bu/BYG7QGfC8FxqNYiDbpBIm1/x8VjEZ8NfRZTb19OraSaCjcCKqDAynwbdm7vg2grT1yoXn/NekU/gXSBj1c35uGsEj6F7+Zhyxcci+HD/YSOAZ4td3QTMzxBASyxsZGSGbAATVxNpWe98wIzIC6Ms4wz5YnrEeJKw3A3XbjgbTlkOLLbfq/eqp6aMA0NC5TLiOfTK9W9CsZRP2VCwwtIbFhEZP0sbuM244anIhbEknkQuMg6CbQQKGuAp91qIJiLlQffOvegGNjdSjaFFqCJF4Xr9/vHl5c/nF2cng9NjaOidn58O+r2rwdlbeOr33pz3Bj/gz+O3V4Or0+M38B+eBkf0/BP8vDijgZdnRz+fn8HYn+jh+qJ/DHrcCIz4WEgjwFy5KcSi8gTpA7XV0BQKDgo1UnwSKLP4zNMsQRlovvsNL/fHQphpLXgiU5kH87O84Z8ZCDwUBucxwhYJmMLNACYDY1wKwW7+tUN2vMy5irmJWV8nCbACNNh5pfIPLyZ5ntnu5mYMrCXokG3LZZJpqfJ2pNNNcKZNnslN6+mEUUUnrE33ko20Yak2gkkFP1NyaxS11tiIJ1bMyN7Z21piVJhXjIWBkY6Me7XTgRepVDJFS8O4lH92v4lKLEYctEBP96u0qUcjKxbVeUavgW3QIHgvGxXgoE6rDBra7NoW4LNTZjMRyZEEo97KfMJaZJ0WKj7jY6nA5WG80cV4QnS8Yb4Zc3yFMSr1r1Z+pAu1qPvBiLUwkFpM5qBVUHymsyJxqhSs9e/wSuc8Cfs4uoUqzbSygk0g0YH7kx2w45JwmHCgqIskxuTjIgMsJ0eV3UB/rOV8osVuBapqrEBjMWWzS6kiHAdi2ByyDOTBHFlhJAhkMcUm/JOA12AjUg72l2nGo3wDpYEEZwRYLBUqhomVpiRgBc7aIiJ/I8lbyBNx+4knhXBawN4+ZzpuvgkPcilxwYmGWieCq2DGT2jkSl8ZyYSWg9Up/37ekU5oSGX9wqLJ0DNKKZmdqhwSpxs2RFdQf7BKv3NyAWeh5/Ml2vakfIsuY4ss0wYXT1Q/pSMgpW+xGVJPElvyWwcctLFdpNBquVXmQozaMm61uqwlPrbmW1CDZVtjCZodzMRH9j7oRIfbr7Ze7e2/ivY6h9H+1jb8ivj+6HAr2t7Z3nkfLPoBgowyPi1arLO1hf+adjpdjSVQ4DrFEqyAWSJEOpA5gBLPsgSRBVDa/NUiubtFB+HGcHQlmYvUzrx3syDcMKi8XDomK9kf7+pa/zTwMWuxmSFN9R5dnZHmMEBkvIzbufx7RFAF3KzGKbcTGU0cQjNiBHkRExvpXtiG3zzmJciEi+i7QMGiyod1kniYrX8UkE5DRLM4hsXSZgmgSCT2Ffy+g8wqecrgP3rPPeQfD4sf9Z5VaeeUD0VC2GtYzkkgF1aHs9KLKgZugtfXP58M3vbe9tHK5/0BQErkQebE3yz2R+6wbXdZEPVhGliDjo2BkAnZxczi5oAHLVpsqOMp5hSpYGWR8XOiaUUoxCKH/NfX8dKAmM/MSoRjwyVyKIjlCAYyoPhJxpjXaJFxJEvrUr8mUAZNtLfZax6DvE6+vhcGVWh49BvQGjzB56+VhPGsHMJknWuXTCsOBB/ubx12dkf7u5x3Xu1uH+wND0d8Z2frcO/wEGdPhbVQaC1zpObUPwgFmT5iiYYqSP4HFAI+DronBmjyp2cuovEE/WNN4vpWYnp+GZaQG4BgXvfP2e4BS7gaF/Sej+eUoMLrS1yfG1EMkjvCZ0aOpXooNx4dn/SuTzHbXRz/8/r4En4hrYXqs6fAW2N0S01obqJviWMvwC2HFVLgygq4iLU81RYIxJWd7Sjdk51aUCbzsANG+NmXjJglzUZGp41Qily9zV7ItmhvQLDDO0BEkHeGHOtaMCHh1V4UiSwPT70mWx6ovmyzXhxLFBIQJOE8W9bFPI4dGHG1B4SyIFyrixxhoIzmCsZalQs51eeR01mjYHAA54/7SS/Kocwhn2hEYeUtnkVvH+DZaa7J3dWM0kiliLoi3BDACirSxmDWHoJsEpZ8n44I+EDiUWW/KmPNpkdKd28cM0e5praIF/YJcXeeQPoJSbSq4ZPwwUfp22UjskZpJp+RfFVIg32vylxl4Dtoto7ddeyuY/eJsTvfeOFLB99K0Gd7EfpcK9xi1IYWzwXoY8h7lGZlJ4I33pAbDBTiIdKP76787iT0F58zrGN+R3zklvIF5nuVPXwVWhap5dJf2wIZJD06CUaQiUTcJb5rjh1IJFXtLM52os1QgoOqJRARsqZhU10wDiozhVK0w2E3WKyFVd/nfm8DIsJalwFxVhWHruZdI8k1klyvRuvV6C+zGq2R5Dp217H7bcbug0iy4oqixeMkW6QpN1Pnab6dNqUZdKg/MlUhR6aaRytIjFUYK2gih2DY2R5ujw4isRvz3Xh/53DUifY7fO9g+2B7uNs5CGbX+ps6jqsga8bUjL2dHUnFAOI+AY4rFDiXzbWOm9t/oF4jRpjWaEuyxM2gc1Dphwo7dg4XseOV1uwNV9MSIdkGhlS1jjCnQd8U+5qyL3TgbAx5UeHHMQl8oSvJVAAVg9/26AscBi9KAXTNNOyN8PuN/67nnayaRaooKYBDygSJRtSswbEkfiQbIeYDCoRgx5Cdf0d06k30VUieXaDEpygxO/4cCYGBXiH3vWX7uwNg3mCOuHQGXrHR66odrsABoCBwOavCnWt8vsbn6zV+vcb/Ndb4NT5fx+46dr/N2P0CfO7R0Gp8Dh2ejM+hb3uLVVjqhE4e/dEwnULFc0DuzXQUFYa2m0sMTrgCXAkZGtMBRTr+2g023QmZ0J+Q2bxD37gP8Dww4kLHUmES6FqeULoDS4GF7ts8k21IYGCsfKr0LR1TGoJ6lmQePCLgogw70IEoN0GbdGskuq/LdUTcadqf5Aqqk1APUi6Pbkx1AdmNyGzgSRXvSvQaWMygjvjeUu82uc6CfCDXtUnuv14WR2iFLMvU9+Bs0J8Bp3Mioggf6uPblwi63ewLh7jrhQQLtc7CZGfYrcNeC26gInDfLl78+O7qJRsj1KRQd6fehMTaAILlHFyEUlmv3MfHQbS61KdUe40vJRg6bJSAwMwfOhx4JbyFHH8BSZlU2quPecOop5+P441xK44YvlchO5LGHZ9zx8K8iO4Y5k1WysVn5HouE9+V1EJHLSRqeDKvwYVT7U3kTt5EEL9IgieWtPXsyR29cIYeFlDwBqnO84Ca8Hw0v29FpdWezUeDXoj0mny8V+/olFVzGHNpi9kJnbMdsGiitRV/ZwxdB8PgZlxAFD2bLTraFVJEhJ2tGZZCN2UoQ0CFxN8pBIZyzsSHuCoTKNGA11TsQvIXsizE/C90hPKXhsz0+gYWT+wZ6+gLDn3O8YwThjhh6HKA9fy7tQkdC2IbZaA84BygX9ufMoFndCbvOVpLszqR36QxuDREwCpRsVnXPXTrBOd/MWrA3lUfSMMIqqsvfnhA09PCBaqhrHI7YF6Di/wmGtbFOb05fqvtKFwr/9fkRYl79a7JmUqmv3eWXpFJ/nfy7p+U8daZ5q+YaTzMRXejaX09MOvkrz1eW9zFs3QZBP5CK8UqIWqoV+r7H7OEsoTn6NUU1dEEr1xBzZAJniP220DP0ilFIpTqGP5Q5RGhsYE+ELYWMCkfygTo0Q51OTOngHHAEu2Kz7aoziFHE6gnRZu9g5JMRWAWLMfwjAW0/ap9XXYJljlHw7Kj0tgAutK0UDAbxmWRMg4u9YhHxNJGhUtcUJ0pUepCE/SrRpVRjK6GIrSpMDGpPRvh1jJUrTOGf2QusLv1+8qgejrT7W5r1IJciIQ8E/s1YftjtMHbwolIMiwIIesCABMzM7wZXC1QBGLKglxQeGsz3vSD7Cb2BSJYHjn32Wlvt7dCKhfgfaZtDiXsDHG6kdC8FYnXGv3Ny4Yr3tW76n/CPUm/8mDJsJnhNhfKU7gSxhWMN0GzYIRBXRoFNcgEBMced3e4F4Il1D2+djdvsI4EU2B81Nd6Vor+bd0/XKq23wTuLpTXK/3+QUD3MJ+uh/+vi4MP6LG6WPlMRa5vAX57twAfcIfyquczvWF9le9Lr/I9YIv6KmVtjQ/1TtgXZv4XF/7O30v6cv+kq+5LmSu/4ajpLGcl0+4GG163dxFOXLomt3U/M2jh4zaKV22n/nCMyIGvqN38j+4NbsT+F5Ak8CI= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 by Type' (list-tagged-objects-by-type)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

List Tagged Objects by Type

+ + + + + +This API returns a list of all tagged objects by type. + +Any authenticated token may be used to call this API. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-tagged-objects.api.mdx b/docs/api/beta/list-tagged-objects.api.mdx new file mode 100644 index 000000000..3bed00553 --- /dev/null +++ b/docs/api/beta/list-tagged-objects.api.mdx @@ -0,0 +1,85 @@ +--- +id: list-tagged-objects +sidebar_label: List Tagged Objects +hide_title: true +hide_table_of_contents: true +api: eJztW21z2zYS/isY9kMbjSnb8lvsmZsbRbZ76jiRz5Yv13E8LUSCEhoSYAAyjs7j/367C5CiXuy4TqbX9PTFFklgse/7LAjeBToXhhdSq34cHAWptMWQj8ciHox+E1Fhg43Aiqg0spgGR9d3wZUVpqdVIT4V3bKYwL1Axuqo4OMjI3gMw6vLjCs+FsHN/c1GANcWhzrSrKINT2JhIyNzZACWH06kZd3zPjOiKI2yjDPkiOmE8TRlhZuu3fT2O/VOddWUcWBEqEJGvICnhX4vFMv4lI0EKy3dYRFN99TbwGXODc9EIYwlsSSu/qEUZgrPFDwhXWSyCBZZfM0/MVVmI2GQKyNsmRYWl3AsA1OXQrDrf+2QHJcFVzE3MevpNAWmgQY7r5e++WFSFLk92tyMxUeRoinalss011IV7Uhnm6DMTZ7LTevphFFNJ5yJ8IIl2rBMG8Gkgp8ZGRTFNOJDKY0A0yY8tWIjEJ94lqcgXmdvC0wbTUTGg6O7oJjmKDOsK8bCwExHxt3a6cCNTCqZlVlwBPMy/sn9JiqxSDhoga7u7zdWa1MniRXL6hzQbWAbNAhWZEkJhnJaZfCgza5sCbabMpuLSCYSzHkriwlrkXVaqPicj6UC08N8o8vxhOh4w3wz5vgCY9Tqf1j5kS7Vsu77CWsVphQtJgvQKig+13mZOlUK1vp3ONQFT8Mezm6hSnOtrGATCHRwf7IDDlwRDhMOFHWZxhiELjLAcjKp7Qb6Yy3nEy12K1BVYwUaiymqL6WKcB6IYQupxpAHCmSFkSAQzYpN+EcBt8FGpBwcL7OcR8UGSgOBbgRYLBMqhoWVLtBTrMBVW0TkbyR5C3kibj/ytBROCzja5w7HzTfhQSjPCicaaZ0KroKGn9DMB30lkSmlxRW0bGHAGMH9oiOd0pTa+qVFk6FnVFIyO1UFJE43bYSuoP5glX7n5ALOQs/nC7TtaXUXXcaWea4NFhFUP6UjIKVv8TGknjS25LeuZGpjj5BCq+Xq0YVI2jJutY5YS3wAJ1StxaeoxeXnUNTeAI/NB0HDrIF/zsQH9i54dfXLaf9N903v5F2w7A1YaqsotWi3ztYW/pu31tnDFRVIRljcIVnANJ7nKRZVmLb5m8W5d8s+wY3h6D2yEJlt3HcksdIa1FchHUe1Nj4/1D1ddD5QjcLEdx10e72Ty8tfzi8Gp/2zE3jQPT8/6/e6w/7gDVz1uq/Pu/0f8efJm2F/eHbyGv7DVf+Yrn+GnxcDmng5OP7lfABzf6aLq4veCWKTmQ0aU+Z1eTwcMOLvHoHPKm4XUu4xah49ywmNWel2IqOJAydGJJAKMZeR7oWd84ROdLj9cuvl3v7LaK9zGO1vbcOviO8nh1vR9s72DjLhgvguUFBH+WiWFx5n6x8lZNAQARzOYbG0eQoACol9Ab9vIZlKnjH4j95zDynHI8HPes9DmeaMj0RKcGtUrUn4DgrCoPKimoHrRrjA/fNeH9Ao8iAL4q8JdJE7fLa7KmJ6sAyUnRNjIC2E7KJRzxzWoDrFRjqeYhqRCoqJjJ8TTQ+EQiwKSHk9Ha8MiMVkrEQ4Nlwih4JYjmAiA4ofZYypjOqKI1lZl8a156wHmmhvs1c8BnmdfD0vDKrQ8Og90Oo/weevlIT5rJrC5Cy9rlhWHAg+2t867Owm+7ucd17ubh/sjQ4TvrOzdbh3eIirZ8Ja6C1WOdL80j8KBck9YqmGBkD+BxQCPg66JwZo8adnLqLxBP0PQS43thbT88uwa9oA0PKqd852D1jK1bik+3y8oAQVXl1iSZ6LYpDcER4YOZbqsdx4fHLavTrDbHdx8s+rk0v4hbSWGq6uAm+N0S01AbiJviWOvQC3HIqiwGIKUIi1PNUWCMSVbQ6U7spOLSiTeaQBM/zqK2Y0SbPE6GwulCLXYrIfZFu0NyDY4R6AIMg7I44tHZiQIGo3ikRehGdeky2PTV+0WTeOJQoJoJGgna1aQh7HDn+4dgNCWRCU1WWByE9GYt4WM1Uu5VSfR86aRsHgAM4/7yfdqIDOhnxiLgprb/EsevsAz05z89wNG0ojlSLQirAXxqYp0sZg1h6BbBKQmU9HhHUg8ahqXJ2xmumR0t1rx8xxoelZxEv7hLg7TyH9hCRa/eCj8MFH6dtlI7JGZSafkXwjSJP9qNpcVeA7NLaO3XXsrmP3ibG7+PDC9wn+KUGf7WXoc6Vwd00bKp5L0MeQ9yjNqkEEb7whNxgoxEOkn94O/cYcjBefcmxaviI+cqV8iflubQ/feFZ9aVX6Z7ZABkmPToIEMpGIj4jvGccOJJKqdpZXO9VmJMFB1QqICFnTsKkuGQeVmVIp2tSwGyzWwqrvC7+dARFhrcuAuKqKQ9fmrpHkGkmuq9G6Gv1lqtEaSa5jdx2732bsPooka64oWjxOsmWWcTN1nuaf0w40gwGz90p1yJGpFtEKEmM1xgrmkUMw6myPtpODSOzGfDfe3zlMOtF+h+8dbB9sj3Y7B0Gz1l/P4rgOsvmYatjb2ZFUDCDuI+C4UoFz2ULreH77D9RrRIJpjbYkK9wMOgeV3tTYsXO4jB2HWrPXXE0rhGTnMKSa6QhzGozNcKypxsIAzsaQFxW+D5PAF7qSzARQMfg6j166YfCiFEDXTMNugq9s/Ks872T1KlJFaQkcUiZINaJmDY4l8b1YgpgPKBCCHUN2/oro1Jvoi5A8u0CJz1BidvIpEgIDvUbue6v2d/vAvMEccekM/MBGr+t2uAIHgIbA5awad67x+Rqfr2v8usb/NWr8Gp+vY3cdu99m7P4OfO7R0MP4HAY8GZ/D2PYWq7HUKR02+qNhOoWK54Dcm+koKg1tN1cYnHAFuBIyNKYziTnHo6zBpjsOE+rG2VcEhI6X0qQwpjqNdAcmAtPct3ku25C5wErFVOlbOpI0Ar2sSDl4NsCFFw6gw09ugTYp1Uj0W5fkiLhTsT+1FdSnnh6lXJ3ZmOoS0hqR2cAjKt6H6DawmEMD8b2l0W3ymSX5QK4rk95/uSyO0AOyrFLfo6vBeAacLoiIItzMjipfItp2qy8dWJ5VEOzQOkuLDXBYh70S3EAr4F5a/PDT2+ELNkaMSTHuTrgJiU0BRMk5uAjlsG61gY+TqKzMTqR2516RYMywJAWBmT9g2PdKeAPJ/QKyMam0OzvaDLOefhaOz8174DjhOxWyY2ncUTlLY7yI7sjldV7JxRtyPZeJ7ypqoaMWEjU8hTfHhVPtdeSO3EQQuEiCp5a09ezFHb2wQQ87J7iDVBd5QE14PuZfbEWV1Z7Nxxy9EOnN8/FOvaXjVfPTmMtXzE7oTG2fRROtrfg7Y+g6GAbX4xKi6Nls0ZmukCIi7Gw1WArdkqEMAQ4Sf2cQGMo5Ex9hOSY0ogGoqdiF5K9kWYj5X+m45K9zMtPta6iaODLW0e844LnAMy4Y4oKhywHW8++KEjoWxDbKQHnAOUBvZn/KBJ7RRt5ztFZmdSK/SXOwNETAKlGx+ZG7OJolOP+L0QMcXY+BNIxoun7Vh8cwPS2sTHPKqvYBFjW4zG+qoSAu6M3xW+9DYZH8s8mLEndn2yUDlU6/dpZ+IJP8efLu/yjjrTPNXzHTeHyL7kbL+kag6eSvPF5b3r6z9OEH/IWnFKsEpaFRmX3r0SSUp7xAr6aojiZSUOOfC14g9ttAz9IZRSL06Bj+0N4RobGBMRC2FjApH8kU6NHWdLUyp4BxwBLtite2rA8gRxNoJEWbvYVeTEVgFuzD8HAFPPtN+4bsEixzjoZlx5WxAXRlWalgNYzLMmMcXOozHhFLG5UucUFbpkSlC03Qr55VRTG6GorQpo7EZHaQ4J4ytKsNw39mLbC79RvKoHo6zO2+zJgJciFS8kwcNw/bP0cbvC2ciDTHThCyLgAw0VjhdX+4RBGIKQtyQcetzXjTT7KbOBaIYHvk3Genvd3eCqldgPu5tgX0rg3i9N3BwheACy54N9tG/wO/BfSVBluEzRz3s5D/0rUsrjO8DhY6Q+g1JiAgPrm7w80ObJXu8bb7mgb7RVA5xsHsU50HRf22vilcqa73ArcPqk8m/QZBEGBf+XQ9/H99DPiIHuuPJZ+pyPWXfd/el32PuEP1+eYzvWH9ed5X/zzvEWPNvp+cmetmtiUGpeEGxrpIozrhprk98saspbfISKXet/zxBCs1f6BX8j9wqfv7/wL6RWXg +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-transforms.api.mdx b/docs/api/beta/list-transforms.api.mdx new file mode 100644 index 000000000..5bd94d91c --- /dev/null +++ b/docs/api/beta/list-transforms.api.mdx @@ -0,0 +1,328 @@ +--- +id: list-transforms +sidebar_label: List transforms +hide_title: true +hide_table_of_contents: true +api: eJztfYt227aW6K9geGYt2xpJlmwnTnxuzyw1dlJ34tjjR9M5caaGSEhiTJEqQcZWU3/UfMP82OwHwIck20rSm9YJstY5tUgC2NhvbGxsfPAyOdTezhvvNJWxHiTpWHtvm16gtJ+GkyxMYm/He6EyLaSIQp2JZCBkFAkt36tAZLaRSPrvlJ/p9nncE1lyqWJxFWaj8gPdotapkoGQeTZK0jCbilDDk1/zMMW+EuFjz9kInvaO9tte00smKpUIxH4AYGAPFTCb3kSmcqwyleIMPnghwvprrtIpvIvhDfxMBgOtMm92Rof0WIQxjJqNlBjkMHKqdB5lAl60xZnOAZip0BPlh4MQ4KP5NKJwHGYNBHYih2EsMwXt0yQfjqgf7gLRcKKUePPTJs5EnGQyDmQaiGdJFAGaAAZxVMD+dnWUZRO9s74eqPcqwjm3tQyjSQLgtf1kvB4G8bqchOva9NPyi35aJQ7WBOBFjJNUwbwQRYQ5RKPFsbczkJFWTU9dy/EkAvx0mp72R2osvZ0PXjadIMpgVDVUKbTjTvjR5gY8GIdxOM7H1C5QAwlzhb9vbpqLkU/ImsP9gbwWcT7uqxSZyWAMMZqqLE/jB4O7jUefgb2xvOa/qZcCl/DrVmz6SR7PY3N/IBpZmquGCDPgUWDjSTLJI2ZMJRo/t06TTEatZ9i6geieJLFWYgSSCBRgKYUPF1BkJKHHJI8C0VeGOCAH4aCQAsCoaLCENcSVQuQNY8BhADQEKoaxr0i+lc7CeAgaJENQBE0EhD0WI9Ai8BioRsjC78PxRPpZE2dD2gFoOFZxAAPHSYZcohWO2qBOvqOZNxAmgva9jHLFWMCvAexcW2geBE/hfBYwVT9JIiVjr8Ip1JJ4xbAH/adZ55w6q7yCL5DASO5Sc7PgpSHMVQzSZEyvUdUuhFRnU4STmNtbAKmGnuKhV5mSt8d/FZobwehubHpV4AdhRGr8Tvif00cFf+YamQqhtXQQehpnoF24WR+ZNf7CRP8bzwQgaxk415D7ntunyNQ6n0ySNAPwkEHI/EBXyRW+BlMTBZoki41fkuod7KHRQM2SxjJqNHZEQ/3a4KeIQPOkKfRVYwmiqetJlAQFt5WUwr6E+lWce2cTGNyXWp17d1D55uYtjsYaReP7jU4H/1OnW6/wHEp3QIA0+CNLwGH4HjwGaIJIksh4fgKzBXUHncnJJAp9Ep71dxp7/DAPkUxTiRwDPYwJErDehwNyC8wX7KHMMdUpWe0JzAKGo0HIxYmFRXc0bQkgk5/rLBmrtAUSGMZV36cuJ2+sINKwTU9mgKt+ninyqyYpUjULGVvM/POyU4fwLA5BHkRcSC+wUDF4TdJOwzGoWvglThOxCyaAjc5LFQ+zkbfTJbNjf4GlMUDeCwHiCL+okVAUzhnCEKMte+NJn/Ryz04aXvWBix5v7YIiD8qfe7H5CXQG0vIfQYi9yQjHB+CfJWAKUmV+PWdryj8OJMwAoQTBnCRa7YYSmQe4JDqQ6SXqEdV9vDUZJTG2H4Spzn6SURggqfKI9GQA9AYftApqCHbmGrgG/tLJZvfxY/grkjrbL55HapAdSewmSpLLfEJ/XJG5jxHAKPxNoX5DCABRQTLuRZORfJUD54R+8bDyWw3AboLho78nkfRVL4rKH/hXOByZQTVIAuJAI6dic533C5rBf5EdchRd/K9G9h2rFypmPYLPckDB2yrL1FCrrpnldxNfz4txocDFoaU8TjNPI3i5jPYMoNv1UgWsJ2U3YAuqkjI39oHKZAtglUL2kzyrm7C2+AntvkZtT9JB6gZYx3rvvjBu/jwTwwvwEtS18mHgAEU5hqWA7JfGGFjIKpIwI5wtYPJZHVPVBzrJU5+4oqoO6PecRqh8e69U9kTBPHZ+3Jy9JJn6o8LAGJBr2uJ1kl4GoDRvZqFaSh/EFWeiaC6SuDpcxakXp0gYPSJ3knQ/e53VXkyjsjd6+z7UIZCDiUsOXcq6eQDi0UTVbAY1k2fT0K5NdXfvqHd8erD36pRmywOdgA0uabjUpNm/tEoYVNYgHObMw2jYpeC2tyAHsAHQi6sR2LoAvQVcEBgLmKQB+wfkgBtX2wCquQl8BiyNbD0GvyKEmQlQYWlIyqacqw9rbGDlqq9YPKtPfhfmB840Tnaxq/nR0zeNxSqKzjp5H2ttcLgAzCTS5UQtbjRAcevk7OzbAtY46M4by9uccWDJ3TdzRRzTsGJV2snxkGtVJBm/aMaZLpBzTAR4jlbjZRhffiHsXI1CkIqK6BiGlqZncs5RoKGLgqnaArFDIw4iye6lotakvWZQxZzFhKh0Si4ozrYY3QgbKtKmUOicwRKLl2SoH4kk/NOMxhi9YzjuPwZnGTvg0T+Jsh9BR/a6lxFtmAh4xeAEaqQWLj9ArAgaNDros+D4MXiZyZXVrTbWI5bTDIU5ZCPRNquZyrDo9ON6lSWCR6F181CGsc5q4ADdcViLHF51MMJkdCWnaAz9KA9UVTXiANbvadIvGU8F+hC4SAeyl8Bo7gtsI1jvPjm8IUIoeq92S8/P2h11HfIS36Cm8OTP48M4mgofLBzMwbxG61pysCapl+8BP/hiR4iWuIih+/dq38B6AY9wmJ7hzv1d+igIwR+SU7RZs1/QUhe/oQ4iNYb/avyolEKmGEzAqmLFYYTSEI2kFtX2NTX7L6t1GNvgk6WZfh1mo9Vzr7G793LvdG+3ce6trVXU7hFb++mncmaomUNKC49UNNQvzAVgeqzGSTr9srxZ2C0jGSqjyEsPeXLWts9QnfRasXQWUjOsJaPBDxMlYk4086uRZHWYJvlEt3HtiFDBwKsfVnoB0HblZk38/ruIEl5Hiu++Eyu9HHl2hchj/DV9BOMnQegfqwH8Gi2h+XuWkTD+BAsIXKkqstho0mYUWpQMwRk1XhAF1VoKm6NxRjWbTknZGhTA6iezltKKLfp8CJkAv9EH2tyrDZuF23p8yxxvcOEzybPKZG9dKwMZkGNgjTzhtVrVvUEMYFQP4wuhD6NOjWLnGeAYpL+MpbMKZkAUtR56HVdsaKglmh4wFTDv94CMxbYik5cwEEkANimMW0X/lfCyYmN+sEIBoLwPJbU5ox0IGdhV6VHFUZ8JnJRRiPmVQX1VM+No88r0FxMxqDr/3gn9oIWRJSBT6YbiZvbZzOp6ln711YXjcsflD5jLi6CR43LH5V8hlxex0LuiScShC2LJ5vkdEfF6rzdzzA9OHjZBLqU26GS+S3AlmAxJAKr8+cb7MRmhBAn438kYvF7vrfOjnOw9YNmrbD/cJYDloggtT6JDXAU+s80xgKyGsv5sTlgrfSwR5vVpIyTUgF8M/NNilLmE9w212QRNcx8WYLTSu6CIeA838+iv7y9QkuCdeXFBNLyw7yhWTnsKJoKpKa6aZ4Aojf0lLIRF7L4tcGWHi8sL9etFsVWJzEVBPlz0v8cNlwrwtbXaLHwoPfPIXCooy2DOb2yb1XxlEUs6ArWKCY/VIKIHN4vI9/8RirmIlsdPnCp1qvShqtL63u1dqpSGMvvUWqEKNj+sPvl0DVt2Pb+PaVimjEoHkndnAAId4vbE6imHWtVMEpTZacJdYDFC0uHnVh4qarqIW61RFqPbQXQ7iG4H0e0guh1Et4PodhDdDqLbQXQ7iG655pZrf5nlWpEBevfOCjU33y7I8jauK3OzYWR8oMKCkS1hxUmIE98txhZmmdHPQYRbIJ44I0qQx5fEGNZ4CVJBY0qmB7WiSUU0yA8QFQhJ4G8htdQ6HytzxIW9EOhq/+TwyeNO1wzaWLhye0VggcfF4bYSZbeo39/LbwX/+50yswXmaosjoKZKY3xWthK/n8e/i5b9VzRrzf6rP+Nmdg6iaHYxhX+tg4NWEKycrvzww854vKN1++Tk5OcLeI3q3TayRxva8Lz4h72+3O0dico/0+vBQRD88MN4DN3986L2GnulRmWX+Bz7Oto7PHq598vJ4fNT29fBwXoQrGOP1V6qfdFa3DDDkUrQuT9JYBEOBgXcJ+p37+jw2Q+/nO4f7P3yY++nHjT8mxhrluBxGMSYRd0UP8o4l6Aku+iWdp9ud8wA4OswS9FIzMJovCM5IWuJ1EKjAToi5FDF/V3PA/Z6/9XmBgJGy08YhYKr3U4nvqc3pM5HAQp9tmIZJwxrZbz7hiGgvTKj3/AGPEF6wn8q9INfM1ivP6Hp1vPNq62rWuhHMORGKbB8zKqk29fUZtWHixzwuTPawOLYDeJiwiKmxTTJrW1Bl8QcH5rVQ+zvlOdxMvItcBWDXhTNgmgWhAOKnGSLhjJDsJ+BmmdO26EdGcFCAF6CiWMvtC2OMRpjPeK5NuZw00QO1eKTZagH//Hq8HRvZ2YSBeAax8T/EdAIRB1wST3C3wB/VoJ/1j5pk+cTKcYPn9epd4JtNzqdbquz3epsie7GTufJzqPH3K7gy6K7I8mZ+aQH6e1voG1hDgKjbxieI8yHurTBcxhBVLTpfNVipXrMB3rr+nROe/J7Umjtg4N2EIgXYkVmK8LqSvEbKsoLnFy7s92GyfV2wQsop3i0e3phetnb22uKg4MDATZnZQUV2u/iNRqgH/NIbMEzFGT6cgSdC1lXm9SjODqwn4zESrKy4gMKL1eEbIrf4N8FfScSfgwfNwtc7spphGLNeOA+/oOGaeIc6mq1w0M1EfoKChAHBwYNL16IEYMpJQ7bIRTATKYGCTPw0uQDmj72VCIQrYPBwxZhAjsq8Qcs0+kUMJRW5Z91mAnqLny71d3oPHn0uN7sFiPHQ5eMeWpHbW9sPlqqh59/JkN5exc7RR//Bf9aK69Xrq5a+SJTRn283thubVotWyjG8djaQO8Gd9J5P+nPd7bKpQa/zoyv7bwu53U5r8t5Xc7rcl6X87qc1/V1eF0uiuuiuA8nioscW8mbuTPTxbgkH5vqQsUHXK6Ly3VxuS4u18XlurhcF5fr4nJdXK6Ly3VxqyS3SnoYqySX6+J2Xdyui9t1cbsubtfF7bq4XRe36/JX23VxuS7O63Jel/O6nNflvC7ndTmvy3ldLtfFRXFdFHc216UoC7PcTpDJfKnkquC1bbwv0kZpKu6xuNs9Lv7mFy9PS3E7geF9JHqEBh+4Id4RRekZ8f9EmZ1j2+4VbV/aJrhEAT5FG5bUmn831/7ForGHlK+Qzg3/jwXNy+FfVFrdBsE/ZiGouG0v0TmD+cD/vzil/9urO2IvT11Rr4qSchrXadwHpXHdvpmL4LgIjovguAiOi+C4CI6L4LgIzl8tguP2zZzX5bwu53U5r8t5Xc7rcl6X87rcvpmL4roo7h1R3AOZje45gV25nOYzL66prT8Mc9ZNE+7NgXHBY1hA1PIAUxI3hYwSaHwFaxVqCGZlVH5B35tr29tGYO+6vJ6MEE5e7JWn9rw/5vb6dZxTC+H7W/G+VVzHgzJTKpM4ufq37hUdogLqB2eTpdTG3Ck8qzxu0R1Ga9AQIp/gWi5IrmI+jib5OVLmYv2ifmrMHC21/kBJbr7w5zw2R1DvlKzKGdQL0isX3PYCReGiovjuBno1bKt2E/f0Yp/rE+ABXOkbZYJIX68zUdF1wBxGswVzCS9FHodGQaLmsS3WDGQM5nKgESY/B7i1uoG57ViuszPOzjxMO6OI6bXaDSWebQb2iw5keqnv3Tx0LO9Y/kGyvOo+3pqMQM/fy+KGLY7VcMkslKVo3VfFSfcKrVMaxPIuwSfifNznUIYJ2hWBWjLuNfDmiQ02tKTw2QkfPS8LKxDa06npjkMdHEy2ZYPovcB7fCvyB97Gm/2TQ7HZffy41QXHbzKSrQ3T9u2q9c5U3L4KL8OJCkLZTtLhOv5ah4a/cMNfTMMZ++qdnbhD6063PFjdQh38hJdp3rNw+yJXA1dqUuAKzLA2hT2prgkW2KoVmnjzYQZBNRz0fEzLE7swBz9L0qk3V17L070DU6iEHtw0byUFYu2OsQ4vM7mgf+TC+DO6/eFYGErO960AB8lUqf3dOwfAsFI4jJNU7aVpkuollJKkZEdc2XEFJ1ZRqcIFG+oRjJAnYpy85zJjLHoxLJKNXGMOIwoyjidWo/ASZUe8wmpDRwlFmmGl7Cv6dk1cYSwfV+i+n6ftezXSt65ua/Kb5pGq71jeIcPxwkJ38ZKF5sqk52pNtRcqBgB9gYAwVmOlApJfMr7vk0tAVn9aR23NhNounsnIzyNWqMc4r6+K0lVNbGZsJrkE0Wx6ekhXlJp6Uq/I29Llg5OJ8kMZPRtJehqpeIhXp38Gwcc5ViLjKlZ9ZSuMnXvPoiQPxIlK34cwWbGrUBPR1dFnWRgBOs69Gonv/d67qU5xufzpaukrk3kvLoaIWiDbMRjrZHxCzS9qsCz6gp2YGlaXqTRnMQSoMWkP55QVfu6h7jzn+5bhx21BNQMKfFtjQFsvLC4IXECPvd8sJvhfAGDN8AgfAJJ+thh2w5bLMSD1OMAKcLh/SUFbWnwQ7fB4giFmUNR7LLUPLxRoa1TsmtCmldbSjSOP0qdsDQmmSTdNQPg6HOdj4P0ouaItSZPoosXWo05lgjPLgW7nK9da84Lz0eorB2fzW1NK2bEtEGur1BUe2qx2uuNTBAix91HW+kSGEXld4gwLtlI9vlXoZa2+d1KwxNUo0dVaqRS510hPKiGHVepAXJCvqN7tQEnciWgWmRZYWBU7vBjLWA5VeiEu1fQqSTmAMAVCY8wOjzUlySXG4vFjrCW7AqTlJmWEfahMPph5A9/My3B7Rgg3/KfdJ50nj7Y7m93NbrfT6W53tjr9zuPB5taW8p9+zSJ6J/e8rbqO4dz7u1eAn+c9gpxOYQE3Fqs+tIhavtQKWLDqSi5QzqjHUz5oUaOwGgNTf11kdIGXbyrwAhynrmHNdk/B8rxvJGq+PnnxapnNcvtxvSB50/xt9iSRU2EpjtqZKshSC65OW60fTKBb/uZiwrR05/rntp60cdyCcux6iVCJxUB/cTLsZPjhyrBOcHPg3m2ZQZFEf4+cVkhbqYkMmFeGbHYjo0iVL6v6UxCXm1FG547JPqB9iw0suHx6lbSKhUt9u2RVtYftJvjQZyfn3trfRVbxH+3+i1kAUcK93d6BBVo+AYZj39COtkmjjVKllhivBwOaxrDexbAIt6blL8WFFrd8stWhlnWlQpN1SsUplQerVCI1yI7kfdsxt8X2lg2ugKrBODyutcztA+ZIjlnqCe6otPLIGaZiQdFlKXdbVI0BUbukP1JN3qvvK+BObqE0iqNA1fMP1TNBOCaWQqdEvoSXi8mCiXxSghkMBENG6MxIYLbVcw/0zloFPESamfWMIvrKwkBOB31bOihJLvPJPSqITmrMayB+vIDqd036Fo4QP54cvhLcA/LspZq2WDAmEubIp1LgYXEPlVnj0GVTdAFHlqnxJDO7UXTZESeyFLzTtLGmMsCLP2qqjjusCpi5XcGUajEQmO5N2LnReAV+W6Nhw1tW5goet4oGW/PYeKjp7+xhxcX3GfpRxgfCOLjJnpV93H01zFK5xol51C7dFnAzA4+uV3wZY7Ypp+OAbrMmYEb4aGaTicUbIsj2OBN4+4DuHGov8tskqpHnx/hg72APz4j1zk7w7VHvmVe9EqkOCDGn05xOcz5QzXmlUpeK6tj762RvbPoK1/5R+Jvjc8fnXyufc35BD6NJrzgKdS+vf1RaA1O7vgLniPnULoI1SNi6SagGbi0zDioJENY/pR1xc9cWu58NvuWTe7YpH1LYgok2UxtJB7yFHADv+5GML217rqxhwgB3FNWYXzQX28oXmxsXtrs/MAHjYutR5+LbScFwqucbVD1O6zit47SO0zpfTOvYrKF7gn6LUveWTkjb363kc2YzieQTZGJ7eW2FHkRjzC27knwXM13cHWajMMbHqeDMg+yW5PI92+Vp8drJqZPThyunk0j6qhdFf1p0vle583xhUH5PArXxb8PFhbibglP1HCTkfCQhdFPG4s00KRnXeBvmM76tvB51bgFUAh6de/DHCvzxv/+DsQoXSXaS/uAl/R4xT8GVv6ZnhcDMCz1/tJyNNge+pRU7FFBBHRTiG8YLrLIBoJ7j9+a/Zeu3Xuufb737Sugc0wjf52EUUFyxXjqHxu92ulQvx4h1Od+PyoZfoFlmdvcoXzHM8oCvWE9Requ7i7TnbzChQYPlcVCftXAehtM7D1fvYClBl4DkEpCcEnJK6M9SQhpQveg6mKoGClQUjsOM3AU6kjCvjMpPPsr5MUdjC+kr5a3iDZXl63jZEmqukjN71L2MPw74TT9V8lJQ/T8YLLtSClZEV0l5TqLI8anpnJp0N5m9g2Xcuns1LZffUBE7RXKQGQGvq7yRxNOWACvRhllbUonkv3PWEPVCWVudVh9Pd5nErSbwqdHheFSkPtpVWaYHD5V0mP9N+epbPuo2hcr8us/1iEpgjNLkapmD0GXRw1Xk+XVSKfY8JIvxvM4jFWCKVlSUHQ0aVw7JIEZZmbC14rqIsQEeEJTwrV999Bx1WYMypbLF6E4zimwVQIqNsXYwfRQx6UimQ3vLmo3eW9VKndjMei6OyGn185UHbUbYPp1JyrPDwfcEW1Gj49yrlzK8u6M4j6JPMndcbKTEJLAS91UltQ1JuJIgztR9FaYugwks2uj7pOpL956bL4oqkfqm/FqbLFrc3JEm+XAEbwfhtQrsxlr5wrf3HALzsDxwUX3EeQ8cVfjPTypKfGT2UyxShMO9lPEwx8LtNbXNQ/8rlvCnwOR9YYITQlYZyxfwWY42oqgt8EeU3DUk+ebDh3U+Lc6b3s2qfYUVr+Y4lR+XaDMuyQJOXXjAtLIiS4pyI8ZNKsxuedK0MD8XNO4FnVTjpVmru1Dx0HdY3r8cqVPguFB8dVPUbRZH+3A+m3TwjDo6HAxguKWmS5fQVN0zW2Rp4SZ8QjWHjaq1MFt9SJ4GY4M4pYIQwTUTUfVXCzskMah4clvDgenOaOlWdya5e3PRZFUc/EE0BdeKaFpo/FuoCjRV7G23uqiUqhYFySejyPiQ5ZHnhQnwJFW4izikGhSMUey6RvRi5CoqHt+Cii9DdVWzgZ9Jc4PLEoP8eyEHLGT3b1pBOr/r4fpd0N3YJTA77v46uTufTFx+vmPvr5a984UFix13V9Zub6tIrGa/3V2wjxBLNXqB+p+W7HcWh78C9vZ3eaLVE6O11f+GH2w/kcFw9O7yndzcejfa6HdHl+9GUufKD1hCDRz302x/AZlqOc/YT1kMr+WniihUEpKC+36us2Ss0vn391IFcb4A48dKBsTQ1arViMb75t80xdU8vNdNZ9BYnCZ0413J+kFxLd6c0FUuRYUPD+iOsxbeNNYU1XvOvNmrXj38Bm8lOziok8CEWi3w0aXUT4LRu63+ZS5hAtvbwzAcbUdbUo9GJfBHwNzh9cl89KAaUKhDbmIFHbO+3KxBQVVE36I68LY6nfkQ0bMoxD0DqnUtWuJ45qw2srrCxPQkmPIFsO+xcA4qPUxlN/kkEova+KQk199pLv6o/ZEay0XmYnbTKQMme5YE6n5JeQ5mojXEDHTUFQQyVblhdU9J9njdI3dp1QZ9V4+jASbaXfG9DMSxmd8zMxnUAbCOvIS+9pcXXdsEVFSxXbRgWLWtZP9x5+nG1uDxlpQbT7a624/6Twdyc7Pz9NFTKrQIrKvlcGGJ+PrQtgw03RwZ/qZwF0AC7rn8Ow7u3VpVfi4LgW6tXCYuqswNl8U0DbwiU9dYHEB8/+xIbG2LyMQvwdjOFDJTcesMpQi3Kji70ha6pY4P07Ae+SqzF8xdq7t7z3tnL/Fa1eO9/zzbO4G/sK+3CzfySMklFCEwN4naCVxJjHFFgA4VtEXD9NqACUlTuM18aIslcD1Go8OghRl9QYtq19UIDbMayc11Zjes+viMCxKYbUAO0zV6Pm4ntWwkuCFGoBlVutYWvcLdsAWsxnJKaWhBUF4YNsix0ChtmOEWGrhF4WzCWYnKOjVKtfyyShQUDoB8iT1UP8vxOlMqcV+RwoJbih1be0eYuTe1Bt1pBWmEUrza1c9MOVQ/SfGeAtFHrw+cOaOOOHQ5lrH9rtBYVftO6u6AgdnNEnrnS7wn+V65O4pA/bRoasWL98oIHwWfjPMpSq/QaiTrvmLjyiZlVZC0GIQqCpzsOtl1sruk7M6+PFZ6ArJo35Lr0513fc5imQN+UzKec65PqngxKexHvAZkQjbR+zUu0o+vT0GwLxXtBcCqFlcGf6B/xKZ8DvheQQ9+3rdbitb0l7RAAAmPPIMBaCIV7BDcJcSEKEbV5vxo4Oz2Q2DQeIGLiLWoKbcZ77ZO89gs3ZoiSJSOVzIxkqAfYdGL94nbmjjgqbZ4g9F5ks6TdNbIWaOvxho5T9LJrpPdhym7d3qSBVQkLcZP0vl4LNMpc5qtL4h38wn4AJNUqb0oRI5INeutYGei8LG8uufg9Te6/e5g21dbgdwKHm8+HWz4jzfko+3udre/tbHtVW39m1KOCyGry1SF3kxHvm5CpXhwK4+BuXSWJEGNWxG9qRqgWqP0Cus3A87bHoUXje+4Ne87vkoymBve1t2aKwVp+z87finoTD13j3jjzRgUWq5nSZsL6FLSBg8dfXeuo3Mdnflx5uerMT/OdXSy62T3YcruR7mOW/e5jlsf4TpuCXSx6GT9n+k6BuB3oGs2CDGBpqgzVJwWNtFHI/YZnsXKCkev5kVuPJ33Ik+TRBzIeGqdJV2LRMYlulC9wbdj/Da132LetxiCiozxlsEw4bTlcKzQJ8XzFnzwMeAS6dBvOm316GQfy0yZO29GMTn11Xs2E+CxEM8oDtD9gx4oDjoERf0HxjgNtT4rHiyO6YQJzpjulVYo80X899GiLIH9IiGEaX1LugDHzPFSw1hdT1h9FS6oc9Wdq+7MvTP3X4e5d666k10nuw9Tdj/CVTfe0O2uOnywtKsO37Y7ovClnlMy7Jf22HuV9F4uJWBuIw1KHxyQoBU8xEu9cRC8CfsZs3Ivx3JFmPcc7xS5vjupogpI9Yd8B7X3FtN8xwo4E+cHTj+qJIm9eJUDxR4Oib4lT6t+MPkDUBuofNOWk7Bt08Dj5IpOJ/cVVfu4vYYZfiB6R/tmodIm+vAJataX1DlTy16yUxyAvrNnW5CVCqtyN00B4mLYkeutJuMJrEVWNH3dNpn5M/ODeZ2l0c3nz4U7umUui9B352jwvQBIZ6bocea25ZATdNx59Dk+KY0RbhlszA12iJ9tiO+VTOlcK2bRrP74+nRNDNFdJXXBp+WLIjNHwCKkDns2owQbVc7bI+C9Ws4Oip8YRDBhcR6fKCXe2Mu+X4GdOAbFTijFRop0CbZ6u7rMsXjA0LqstVsjc0nrijDmA6DwtH0et8RuiFoMz8zTN2aKfA71zcTOS1bm9alA/M321uLeWtSbXpuBglH7xucccB90AHYhI03Y+uTBub9WpT9chMET7HUWBsSEgaOeaeVbqn0yHLX+WthfHY7z+DWdMao3E6yr7BGVfeGPkkSrfxcCWQfF4M0wByn6ZLDoYFOLJKK10amA1OIhW2ELPEuC7yUIRszMJPto2cmxSTjGQiJ5QZQFmb+gg0sXtTnT4zdhTFBjBYdPhhkHbOGALdYB2sDP9k3zxbI4B9IDzADPSvqTJjCAVvQe97VQq1P369QGTYMPoPI93pMd/rFTKjhbE4de4NfFN6CGPTpwZXLP4LcwfaGRqyHLhhRmMTgPLx5himfwxvAWG6Nob/9q88UZ98rIy2EcTf9oLX2LJvnr6N0/SeM5TfM1ahrjKiO70bBmTVFl8u+NvzYfCdR04BX+H95qLtMCXjmsecoSZ9WOsCyQrY8n/VGoKIYwUZJKlDeRs5IxSaI5FalMrbQhHcxLAWQJq74wgv4oym1HliQw7FjS0deUioFwzkWCdTXioWqL11hJwwey4JIOs33h3bvErO2KY4Ji1xIbnK7xOI/xuCaAjXeEAEvdwxFBqP2cFRes8GJlcZGQ61e0slKMrIZTaNPiBtYQhwMMT8PK17u/ppEZC+iuTWwaUI9UNOfwyokcq4gLHXnL1kuyfQO3tUYqmuCiErQuOGCqMsLB/ulcj9BZbDZEknS4bhrpdfwWOsHlEbPPZrvb7rRouYCVXBOdwWqr0vnLUFeueNCz7PehjMZ7L1SmTWlCWtKiyZDv60c9iR00KNOeUf/Mo0X/LWqNq0CbG5TRcUF7UpZIij1T8jcQjWjGRgdXC+sTjJLhVHJevfAC8Y1XmQIsOUYwT3z64QOGT3DFdIOPf81VygtVwDyKQ1A5cnrLrLn4THmkfJBTrRtN0q2ytjjTOS3i7BUcpmhtg3aKGhS3k0M8Ga5qKw/uAlFFBu+nTTJxJxmIlkwDkIooYlskjmQKtMKKNcvrSm36AWfW9tOaFP3cYgJvQ/WlwoBGwlV4ipiFR0eel0fkgbyulOEx0+cS57g39HAQQYT9dDzsD0QD42kNEZrblCfJJI+YP5Ro/Nw6TTJYkD3Ds/+NMmZkNhgLpb8Al3Q/86LblC0zot5uMCEb4oq24YZxgiEdNO0nYewX0TVebWYICt+STMUY+IgG7o0StvD7cDyRWI00zFiQAftjFWPMETd56U4KHLVBnXxHM2/wNiBAa0qDIhbMtVVYQYmheRjcQNP6dG54Vbmqp1bbFsiXkvEuYsWoOu8BxpR++ERYnocROgCWncrqgxZtHG29tjvHHFb+sjQCtw+BBMhaBk7ySp/bpxTqzSeTJKU4u9mQGCR48Ri+pk0QTYLAlQmTVO/QpWYNG+1sNHZEQ/3a4KeIUvOkKfRV424CMHS6RoO3ZegNbM9b+JZFmQwRN+OwfqXV3MZ3LTb6Yg89AnnLmsz8gUPd3PwfAzNXwA== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Query Parameters

+ +A list of transforms matching the given criteria. + +
Schema
  • Array [
    • attributes object nullable 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 + +
    + +string + +
    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 + +
    + +string + +
    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 + +
    + +string + +
    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 + +
    + +string + +
    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","enum":["LT","LTE","GT","GTE"],"example":"LT"}}>
    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 + +
    + +string + +
    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 + +
    + +string + +
    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 objectrequired
    + +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. + + +
    **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"},"additionalProperties":true}} collapsible={false} discriminator={false}>
    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 objectrequired
    + +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-trigger-invocation-status.api.mdx b/docs/api/beta/list-trigger-invocation-status.api.mdx new file mode 100644 index 000000000..2fe166b5b --- /dev/null +++ b/docs/api/beta/list-trigger-invocation-status.api.mdx @@ -0,0 +1,97 @@ +--- +id: list-trigger-invocation-status +sidebar_label: List Latest Invocation Statuses +hide_title: true +hide_table_of_contents: true +api: eJztXOtz27gR/1dQ3oe7aERZr8SxOp2O4zg3ziSXNJabTp1MDyJBCRcSYAjSturx/97dBfjSw3Z86fVyVT7EEgks9r2/hUBeezoVGc+lViehN/FiafJpJudzkZ2oCx3QndOc54Xxul7O58abnHtuhPE+dr1QmCCTKY6D+T+K3DDOkAzTEYt5LuCTrEgxQ7SE6X1wZIXBgaYIAmFMVMSNwUApE4xfcBnzWSxYpDNWpCzXbDhmC11kpseaRCIYKMJ7ERg/dQQ+qOlCGiZUmGqpcpbwJdMqXrJI5MGiXK7f7zfJdhlXITNAIQ6Z0jmbCZZnAoQNGUf5M5FmwgiVW6GBt3wByxdxzGC1XGdLvNag2APtpjzjichRr5Pza0+iPj8XIlvCPQV3yDyJzL1Vpb/mV0wVyUxkSBUWLmKwAvCdibzIFKpaCHb+9xE7fHuCGlMhz0J2pONYBMTg22rpjz8s8jw1k729UFyIGL2jZ0B/pJ1eoJM9Gao9nso94+j4QUXHr0V4RMpONOhfKviYkJwoZiY+FzIT4G0Rj43oeuKKJ2kM4g0f97ueCRYi4d7k2suXKcoM6wpwNphpydhLoyFcSKSSSZF4E5iX8Cv7maiEIuKgBfp2c9PdrE0dRUasq/MNXQa2QYOV2axWGdzosTNT8BhcxKQikJEEo1/KfME6ZJ0OKj7lc6nAHWB+pov5gug4w3wz5vgVxqjUv135gS7Uuu5PItbJs0J0mMxBq6D4VKdFbFUpWOcf/lTnPPaPcHYHVZpC9Ai2EDwE9yc74MAN4bDgQJEidiZcZGCyiCq7YUx3rE902KVAVc0VaCwEi4HNpApwHohhcqnmEOU5ssJIEBZwxRb8ArINAxuRcnC8TFIe5F2UBrJMJsBiCeQaYdMGeAokCVi1Q0T+QpJ3kCfi9oLHhbBacEkGMp3j5pvwIJRngxPNtI4FV17DT2jmVl+JZExpccNaa8RNnoF1vJtVz3pBNCp3KAzaEF2lFJuZJeTrK2anzaiQ/MY6/s4KCpz5js9HaOwX5VX0IVOkqc6w0qA9KD8BKX2JtyEXxaEhR7ZlXWdmghQ6EFS2qIedzoR1xOeOvWyKWaWk+p7XsKFXzWTiM/vggSQTTsXad8Hgh0uwkwx8nqaZvhDZB8/bZkmDrH+ZJRupBqOH+0agxkAD60Y+BfK/cxOjBlYNfGqv3c+8YKLaml3WtOBPsEiXBRaJwAeNJoSPnbZF3QDv5iOawWZQg4oHnIN/2jp9dTeWA+qBhsoACR2mgxvE0g7Z+8Ugjet14/Is4+gXMheJaVzXs19AZy3/OAefQ/BZygyf226LF3Ke5TViPVFpgUSIaHs46gj5dToAFYDTgjVzaXUAa21wwZUqVevg5HlLtf1oMIiGfOzvBwdjfzyLRj4fzkJ/fzx8/LQfidEsFOi2tTB3LubA9upK63FoA2JFNXeSP22Mf7A0tMJdKz0XkVTCkFM3NIiTejYbTY9Pp1D/pguE01bqS8DTzuVKcI1u2GUCSj3cv5CcCJJvNmVnsyLP4Q9EON4/O2G6Hk3uwlb9GbKAY+Td8eGrf01PXh+vcNNaAKI1lljxId222ZwtqQcAcAC5QuEa7CSEDzJf/qQvMVyEQqQEnRRIDF+r9dAfa/27uzCPvq52ZFNU903ty7elzhBG+Lkk39/qzI4Qw3GgoiTtsZPTN/7TJ/0BynA2Peq1/GPYH/b9/sgf7k+H/cm4Pxn0e/ujp/8kpsrk8xXYKknVjP2ZiSTNl2XFA5gFeLxhSonm8KNYzhc5Gh7xU0Xmy6QaTgbjSqqNeWYtZT7nOdo/tsrUzt2wC3R+VHPaK7NUI/W1E9J/L1XIkvtVBqqpmA6t39LuwLA/GA33o5APgvF4vz/mQX8weDoQB09G4fjJKFgvyNNKYFgK2qJlrDnqH8qzLQloqZASQ1iGaqkkuiytkm6qCvPSVZRbeL7U2acIaibyPBiOxmtcvTx98xN0+mm7CWdQoTk4JPdubuqgO91k8YZ/f7EzIOB/oCvEMDKW/xbhcZbpbJMWVkp3OZ4JnAACGsPnArmQKsQajf3K2rYJBoydAJ0IV8veSjkmNjBiHb31IupGrOnitWOgorDqz7XTHirHwwJSqw6CIoPV/4SaL1fdSj0XV/mttI83EW7YvNKbo4ir6iK/O1ocAi5B7dZwsMRsl9fIbgvRdIcHRElDhqMt/tkcs7bFd4P/ut54Ew48iiXWMqs7n71rdNB2d4MyC5vpcGnTL7SvMnwINtzi/SGEp4yPdHgPrPECVOXPM04as34UwESG5pEhgmnqZC3Jcn+OxrVrAWiiN2DPeAjyWvmOnDAE4njwCWjdJzWfKQnzWTmFyRrgb1hW7As+e9I/GI6jJ2POh0/Hg/3Hs4OIj0b9g8cHB40wMBtA9eqerILuMWBV9kBoAronBmjx23D4tsC+oxItyiCvxEwa0dmFtPPs6C0b70NboeYFXefzFSUo/+wUW8cipu1bu58AklvCbyAApNrESgmunh+/ODx7ZfHV384ISyGttU3rQ1WmQ01bRgt9SRw7ARDbGYGtHEKHjqPaAYG4Ms2B0n4zSyiwCXN7GzDDrb5hRpM0izKdtEKJ4uYqZz/Inuh12QyvAWwKFmzGDUzQNhN0DqG2p7n/ymmy43bDHvXYYRhSagAkSptJhva3Z5D1w7BOJVEBoSxo8wwSE2IlGYi2LWpVtq2xkjNLo2BwYBK+008Og7wA5kjMZhRW3uJYLMtV6DTX5m7aUBqpFNt86LwD2qYNNGT4IMeGgElIqS4dUbcNiUeV46qM1UyRlO5cGXiea7oX8MLcI+7expB+fBKtunEhXPDR/rzNRmSN0kwuI7mtZ5rsRlXmKgPfgt9d7O5idxe794zd1Zvv3O6Xu0vQZ7AOfc4UL0C/GRXPNeiTkfcozcpBFkRbQ3aZhdGoiJfvpxDYnwS1p+IqRTz9FfGRKJuCFTNV9nDbnuWuaFn6a1sgg6RHK4FtDCbEd82xBYmkqtH6ai90NpPgoGoDRISsmbGlLuhX2axQin5GMV0WamHU97n7AYU6VZsB7S+zvt1k3SHJHZLcVaNdNfrDVKMdktzF7i52v83YvRVJVlxRtDicZIok4dnSbW3a+ygtZzCgPslShRyZahWtIDFWYSyvjRy82XAwG0T7gRiHfBw+GR1Ew+DJkD/eH+wPZuPhvtes9ed1HFdB1o6phr2tHUnFAOIuAMcVCpzL5FqH7e2/An+Aj+hIXl5DYrAdALibjxV2HB6sY8ep1uw1V8sSIZkWhlS1jjCnwdgEx2blWBjA2RzyosITOFLbXXaZCKCCxwUYHfPB4EUpgG629A8jPBPiDg85J6tWkSqIC+CQMkGsETVrcCyJJ3EixHxAgRDsHLLzV0SnW/e3vwDJs3co8SuUmB1fBUJgoFfI/fGm/d0TYD7DHHFqDbxlo9d2O1yBA0BDYHNWhTt3+HyHz3c1flfj/xg1fofPd7G7i91vM3a/AJ87NLQdn8OAe+NzGNvrswpLvaDjzb81TKdQcRyQe1fnHGoMjoeZBFyU+ZIWOQNcf2Rd+RBAO0amSSfulIGPoB/cza+PJ/j29OcEkhwdwLzPWDAjHRfBg6eJAD9GbczpEYyU45reXkmk8WzMnimfP7Kth1VKkcUwvjyUew2+Aj5y0+Op7JVnlpS+pJO5MzDQhtyHhxRsnOMAOgNsF+iRdTOJAWSzLRG3tnYH1r3q8O+tlPHYMzrRUheQX4lMF088Omemy3gABDqZ7w2N7pHzrskHcp1l8c2vl8US2iLLJvXduhqMZ8Dpiogowsfav04R9tvV17ysLmXYKg7XFnuDw4bsmeAZ9CT215MfXr6fPmJzBLuUbOxBb3cglLO34CKUTA/LXxJwEtW3+mGcw9ZvNRi8DI+M9Zh7tqJxXpO9g7JAKsVJgjIRzrr/kXDemrflSYoPymfPZWZPjBsa40S0T5ucp6VcvCHXQ5n4rqTmu5OBRA2Po7e4sKo9D+zZnwAyCJLgsSFtPXhxS89v0MMWDq4g1VUe6Kk9y0f7F7agtNqD+WjR85Fem48P6v1CQiVvT2M2d5UPAJ6wYKG1EX9lDF0Hw+B8XkAUPZitS1zUp4jwh/0GS75d0pc+4FLi7xUEhrLOxGeICwgWaUCMKrQh+TNZFmL+Zzqp/HNLZrp8DuUbR4Y6+ILnHFZ4xgV9XNC3OcA4/m11RMeC2EYZKA9YBziq7U+ZwDHayHuW1sasTuT3aA6WhgBYJSpQieyXSZ3g3CdGN2y1cmMgDSOsr35zhO/M0cIS2VJWuSGxqsF1fmMNlXlFb5bfakMMq/XvTV6U+LDet3mj4uXXztJbMsnvJ+/+jzLeLtP8ETONA9robrRsee624eTPHF5b30c09Mwr/A93jT2zDZgeOqb6MdcmoTTmOXo1RXWwkIJ2IFLBc8R+XfQsnVAkppnG8Ic+kwjN6amPDFjm0DPKGOjRHnm5MqeAscAS7YrfTUFtEK4VLKCjFT32HppCFYBZsCHEUx5w7xftOsNTsMxbesD+eWlsAF1JUiiJT3HorEgYB5e6wyNCaYLCJi7oD5UodaEJ+lWzyihGV0MR6GS9yBLzJjq1zUnD8HesBXY3bmcbVI9WdI8y1oK8w8P9mDxgXBu230UbvM1fiDjFlhSyLgAw0Vjh9cl0jSIQUwbkgtZfZ/M9N8ns4Vgggu2RdZ9Rb9Dr+9QuwPVUmxy6rwZxeqzvlX2mr/GsTfk+hVV3vK739ncvefgVL3lwdRQboL0Utw3ROoVtyGwPfO5t6IE9evQIu2DoqxZgTBx3fY07TNgW3uBl+6gt9sbgXqiK+tnarab8tl4dsVF5nwTu2ZRvxnC7MvYJ5Pvr4f/rnQ+36LF6J8YDFbl7gcO39wKHW9yhfEvHA71h99KFL3rpwi2GqF+B8UBT7F6NsP3VCLfovX5hRa33j/WWKpTbjzDWZi+qvXaa/bGnMWvtOERrD/zHY0R6fEuv7T7gUjc3/wFZKqkv +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Query Parameters

+ +List of latest invocation statuses. + +
Schema
  • Array [
    • startInvocationInput objectrequired
    + +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-triggers.api.mdx b/docs/api/beta/list-triggers.api.mdx new file mode 100644 index 000000000..9cad41467 --- /dev/null +++ b/docs/api/beta/list-triggers.api.mdx @@ -0,0 +1,423 @@ +--- +id: list-triggers +sidebar_label: List Triggers +hide_title: true +hide_table_of_contents: true +api: eJztHGtv2zjyrxDaA3Zr2M6z7TXA4ZDmsZdF2+TiZHtAHGxpiba5lUmVlJL4Av/3mxlSsuR3Htdtd/2ljSly3jOc4es+0IkwPJVanUTBXhBLm14Y2esJY4N6kPKeDfaugqLpuh5EwoZGJjgEBvwsUss4w3FMd1nqO7K0z1PGjWD8hsuYd2LBpIJWwVKhuEqbAD3hhg9EinD3ru4DifC+ZMIM4ZuCL0TPQKbBJNL3/I6pbNARBnEaYbMYqEg1/JlmRjXbqiUEu/p1h+2fnbBWylXETcQOdByLEGGwswL19U/9NE3s3sZGJG5EjOJoWiA50RKoDPVgQ0Zqgydyw3o4jbCA0xiz8IJ1tWEDbZBR+HNAQkU2jfiSSSNAvF0eW1EPxB0fJDGwt/1ysx7YsC8GPNi7D9JhgjwDXgEyhJEOjGva2YaGgVRykA2CPRg34Hfub4ISiS4HKdCv0ag+W5q627ViWpyn1AxkgwRRQ90sjr1UGXxoskub8TgeMpuIUHaliNitTPusRtqpoeAT3pOKp6DdvtFZr09wvGK+G3U8QRmF+OcLP9SZmpb9SZfVUpOJGpMpSBUEn+gki50oBav9p3GhUx43DnB0DUWaaGUF6wsegfmTHrDjDHdAD7zVWRyxjvCeAZqT3UJvID9WczZRY7cCRdVTILEINAY6kyrEccCGTaXqgZenSAojRljIFevzG3BwBjoi4WB/OUh4mNaRG2lhNGhsIFQEiJVO0VKsQKw1AvIP4ryGNBG1NzzOhJMC9gayM5tT811YEPIzw4g6WseCq6BkJzRyrq10ZZy6CDyFawq4hZiresFo0rKOCUZhDplFHaKp5GwzO1QpRFI3rIO2ob6yjH9wjAJlDU/nC1T2cd6KNmSzJNEmBfJQHxSfAJS+xc8Qi+LIkiG7eUwbu4cQajUZ1Wp7rCa+1FlP1FksakFJUYGMmPjC2vC/2uNhKKxteFNvJBr+4UliNNhjOwjmKckiVQ9TUimKoGPwhhUoDGBuWn8tAP+Naw8lMKm7lmtbTXOgIFBUnaFEa1UFkZBH1yhcF/IsinN7cxP/q0rq3UTygT4aagjcEG+hM6gyliF578bvFkfcTyuIG8NRtzIVA1tq153fge+Kjq/AaHIrqLt+ME4lWdpyUAs2TrARcyawJRByKh0TMHyGZVR5ulQSzI3JCJjAKZdCO6VPjsnmhDVPWXE0BAJl6A0ZZrBRbrjLUPtkj32A3lU0+4SCnTsU7NChYPslFA70fWnQ+dG/L49aF7+dH7XOTj+0jnKZzcePXEKPkkqJDIVz7dUseMcn50e/7X84/O349PznowuUeCpTwu6ZuUCMky62qiAOx61VeeQd0Lx7IvWzpJc8yyXfRMRl+1iOGCTwS+v0A3Nmmqs+4cNY88jP7DhLwgwJ8ynMlMOybTCfx9msk8cGK8yNDCfUed/G+QiyGERr20BXO8AZ20R7TtNe0V7PuZrJql1vZAP+ans3aQf1duEo0H7VDngZ0ElU9IBfIjrWptpwgt5XbXo7bIM+AVAUEZ08Piucqe1n3HbJwRxhU2gr1Dqxt0Evk8Rgt78Z0aVuP2yUxLPhJVPuf0LemQ7PccBoBiMVrBRiiDk5/roislOSr8MzmhTPA+C8HVZp9sAWc7aapqVTLsYY+sONeLjq5CJtOehzP/vGmZ9nslqS6zwudeJod1yWHJW+uvw2dYyuIhCC6Evury2eCvHYSytxiqxflUcoKP+w/0wo18vEXOVvbp9Cbo8lY6Y6J8x7NcMt9FJR2MM1s0Qqj1acY3Wxg68Qr0c4DVUSk6lEal8x3yGfcmgWep55h5RMCz353LwsnSgShZlJ2ESI91/zAFb+ScG43PB2GFxjVj+HkDMoADwVPH5eKiAxT7MH0QLl5/+HlCVEUJG/3+sZ0SNfhlICDQNLlcVkWJ2ZEFNim/MKfxg3LizBEMZoqp5uuVFg6b5naueQkoKVdbJUWHbQ56q3lA7pIwGCzUniYb4KExKMObgOtDEi5st5XYyDFyTPRGPz6swXSCVh/zEivlThczBegX0A4YTLnmL7UD3erAA59APmgDnCtaSngfhZKGEeTwmG/K6vJ1kLvoP6TrvdZcDKw6oQ8ynrSSY+054LyAdGPEyp80y3gHgoVokFK0CEmfVGWhAKFk+rxpjU8PAzDPhAq56FEbqYFspECueAziJ9SJxA3OI3oLmW4CbsF4iX4O3KWHxwdb++BSs6GnAZ5z/8h3yVyBJk3+h+nLt1EvxNdtPauTTxBFXECCsi0YqKo/UIcDBxUiwYFFKhqcD96anJ1UJf8h/+2zw9TRC2qv6/OmGXSfRtSexBKiwvKYXFwFArBUNoEuf0/yxED1JJGVFUDFwN0YNEXEY00BFtHy3H9Os+O4gziwvYLmXyEZEd3TjXXhhrqxKvl1cA4Vdf8DjtH/RF+Nk5ZIALdOJG6sz+a+rbNZY8gc7Sp6/fFJs3cxPp6cw5z6nzFFuqEhjNOGTsKJEmYxd9aZlW8ZARu4I2RPk4N/crap8m188+YXKOxRZu0uZbGE9eJDolgVVKmqu8pquPi7FVq+ZvaRnhadVYLphyOebanq8ee7wZzTCF56jbJmEujBPPVQ45cnxOPPAZQU4juvVoapmY1AvNu7O2GQ5iTCvYESbVrAEkjXdUnXc7Ejs6GuLuh1RAo4wesxlR8FPdN4hECunGgY5WWMQ/lko0eoZLpJDqABbCQIbsywhzLdrZdCBz66J+1TVikERzi70Fa8tVcOCZQen5NOxk9Q2NfAiT412hGWjFa8E7rzbfbO92X+1yvv333a3XLztvunxnZ/PNyzdvEPsADIP3RHm3Jt/FmTyjAtkZGGisQ9DIf0EgMEGA7IkAQh4s2Pip6oBgrLKJAny5vgWbnl6Wiru0DpH57cEZ233NYpjXMmrnvQkhqMZla8p7gHMH+BRsVs7cxsi3Sg6Pjvcv311Aiw/6QR1hTR3igTgjVYRmqWmfqa9viWLPwC23EEdcpdpkNQ+1BgxxZcsdpftlhzBxD5jf64YRHvuMEWXQrGv0oOJK5Dd3KftJNkWzDlEO2gY8hXy9wy0M0O5EUQ2DRJI23nlJ1vzpiBdNtl/MGe5wgYXxQwyXMJm4LVN34AVcWdBhCpjo8ezB1F7JWJSTsSwPIe/KSkHnAMqX2wmUxRkQR2yWvbCwFk+i1w/Q7CQ3sRFVEhqJFPeGoeAO6dgOVfUhRCbgTaaW+XBEW7QQeFTer4hY5chI4e69I+Yw1fQt5Jldwe/OYgg/DWKt+HAjvPNReuKiEWkjV5OPSPl8hYN9r0JdueO7TeS17659d+27K/ru5MdznwT6r5T6bE2nPpeKZyBfQ5PnVOpjyHoUpJG+k1sbc4qsMxCIT5F++XgBjv1ZKOwv7hJM1Z4xP3JT+XQWXejDn5XJj9LkU/9YF0ggydFx0IVIJKI9ontMsUsSSVQ709iOtelIMFA1I0WEqGnYUGd0MNZkita8uK2zSAurfkz9gTqX8lIERKwqariTOetMcp1Jrmej9Wz0p5mN1pnk2nfXvvt9+u7CTLKgirzF50k2Gwy4GU6ta3IGHcbLkYXLkaomsxUExoocK6hmDkFne6uz1X0dit2I70avdt50t8NX2/zl663XW53d7ddBea6/Gvtx4WRVnyrp2+mRRIxLqpDHZQqMy6ZaR9XlvwxPbXcxrNHKap43g8yb7tySyx2330znjhdas/dcDfMMyVZyyOqSLSAGK4a+Ju8LHTjrQVxUeCNDAl1oSnIgAArudzO69oHOi1wAXDNs7Hdxi8VfJvFGVmCRKowzoJAiQawxa9ZgWBJvZnQx5wMIlMH2IDo/Y3bqVfSkTJ6dI8fvkGN2dBcKgY5eZO4vZ63vngDxBmNEyyl4zkKvq3a4AgOAgsDFrCLvXOfn6/x8Pcev5/g/xxy/zs/Xvrv23e/Tdx+Qn/tsaH5+Dh1Wzs+hb3OTFbnUMXcHbL5umk6u4ikg82Y6DDNDy815Dj7CU3nQiMcTEckl5PUHzpT3IWmnc7bJnj8w0fDnKBr+aAUZht2DABfhUQKkF6wSeevRBfuEI4RgIx2/peDKBsdQZmL4mt/CvHdPIoyaPJHN/HCZ0rd0FbMDwp0Rt/CAgfNR7ECXPh2CJmnGSDR+FykJuNOTv3wcFLc9F0LGQxloAEOdGf9sQx3PEXlDpGY8bgxVyI+WejfJ8Kb4A74uTTx6Oi8O0BxeZolvITboz4DSCRaRheuxbdCZL4d9ykLG0xCWedtTyE6x2zZ7K7ih2xG48/HTLx8vXrBefgbZ3+wVEisLcLUzMBEKhPv5LgAOorlp/LDCfmWfBR2PdWNgmPl78vkp3Q8wQ5xDSCeR4iBBUQRHrX4HmFfGzbkV31YNdiiNuyJs/YVIYtHdibxKcr54ia/HEvFDDq3hL70SNLx/XKHCifYqdOd2QvB+BMFjS9J6NHIHr1GCh+UXtCDUSRpQEp6O6u5YmGvt0XRU4DUQXpWOtvrYlzALV4cxF6mY7dPTECcs7GttxT8ZQ9NBN7jqZeBFjybrFpE2yCMa25slkhoOZUM2IKck+t6BYyhnTLyDczqlNBqyPRU5l/xEmgWf/0SX/D9VeKbmK5h6sWekwwdcbJ+gGRE2EGHDxQDr6XczGxoW+DbyQHHAGcDBWP8UCTyhpbjnX7qZFdUJ/AaNwakhBFIJCsw47sfeOMD5vxh9wN5FHwjDmJIX+4Xwm3lYOL1VhJUvJkxKcJreWMOsOiE3R2+xmIUz7bfGL3K8P15zOVXx8Lmj9JxI8u3E3T8o4q0jzZ8x0vgkGc2N0E5cAUIjf+vztek1QDrlLuBf+Eq+Svk4VDvjJ4vKgJKYp2jV5NVhXwpaPUgETzH3q6Nl6QF5IhT66P5QIxKgHp31N0Ayh3pPxgCP1rdzzJwcxiWWqFf8DTk8ljCIy12barKPUNCpENSCxRye0IBvv2tf1bVAM2eoWHaYKxsvDA0yhTehgOxswDiY1BKLiKQNMxe4/O0Hx4Km1K8YlXsxmhqy0KSyxgzsabflipCS4pfgAr1bvyoNokct+rdrxoyc430/DB7Qr5q2L4MN1tboizjBchKiLiRgooTh/cnFFEQApty1mqY2vQ0/yG5gXwCC5ZEzn53mVnOzQeUCtOODPFAAl4DTiy+ld+omnvUoVuGf9DydnzUw3d9IcIELaclc+eHqO7yINn4Yrw9kYtv9Pa57YMEzwmZ3HwyrPhAcYho/EzSX7O/rgbuZgvoscCUhf7/PrxW4x5RWl8Nf62W6BXIsXu57pCDXz8x9f8/MLTCH/Ib5I61h/TTc9NNwC6Q9fo3vkfL+Sz7ltkCg45fzxgK9Hi/1wWSJdy5d7KGZ0w1zGwilUVNb7JWVWHwJzBXBs2pA/weiGo3+B0XKmYA= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

List Triggers

+ + + + + +Gets a list of triggers that are available in the tenant. + +## Request + +

Query Parameters

+ +List of triggers. + +
Schema
  • Array [
    • exampleInput object required
    + +An example of the JSON payload that will be sent by the trigger to the subscribed service. + +
    oneOf
    requestedFor object[]required
    + +**Possible values:** `>= 1`, `<= 10` + +
    + +Identities access was requested for. + +
  • Array [
  • ]
    • requestedItems object[]required
    + +**Possible values:** `>= 1`, `<= 25` + +
    + +The access items that are being requested. + +
  • Array [
  • ]
    • requestedBy object
    + +Access item requester's identity. + +
    requestedFor object[]required
    + +**Possible values:** `>= 1`, `<= 10` + +
    + +Identities access was requested for. + +
  • Array [
  • ]
    • requestedItemsStatus object[]required
    + +Details on the outcome of each access item. + +
  • Array [
    • clientMetadata objectnullable
    + +Additional customer defined metadata about the access item. + +
    approvalInfo object[]required
    + +A list of one or more approvers for the access request. + +
  • Array [
    • approver object
    + +Identity who approved the access item request. + +
  • ]
  • ]
    • requestedBy object
    + +Access item requester's identity. + +
    requestedFor object[]required
    + +**Possible values:** `>= 1`, `<= 10` + +
    + +Identities access was requested for. + +
  • Array [
  • ]
    • requestedItems object[]required
    + +**Possible values:** `>= 1`, `<= 25` + +
    + +Details of the access items being requested. + +
  • Array [
  • ]
    • requestedBy object
    + +Access item requester's identity. + +
    source objectrequired
    + +The source the accounts are being aggregated from. + +
    stats objectrequired
    + +Overall statistics about the account aggregation. + +
    identity objectrequired
    + +The identity whose account attributes were updated. + +
    source objectrequired
    + +The source that contains the account. + +
    account objectrequired
    + +Details of the account where the attributes changed. + +
    changes object[]required
    + +A list of attributes that changed. + +
  • Array [
    • oldValue object nullable required
    + +The previous value of the attribute. + +
    oneOf
    + +string + +
    + +boolean + +
  • Array [
    • + +string + +
  • ]
    • newValue object nullable required
    + +The new value of the attribute. + +
    oneOf
    + +string + +
    + +boolean + +
  • Array [
    • + +string + +
  • ]
  • ]
    • identity objectrequired
    + +Identity the account is correlated with. + +
    source objectrequired
    + +The source the accounts are being correlated from. + +
    account objectrequired
    + +The correlated account. + +
    attributes objectrequired
    + +The attributes associated with the account. Attributes are unique per source. + +
    source objectrequired
    + +Reference to the source that has been aggregated. + +
    stats objectrequired
    + +Overall statistics about the account collection. + +
    identity objectrequired
    + +Identity the account is uncorrelated with. + +
    source objectrequired
    + +The source the accounts are uncorrelated from. + +
    account objectrequired
    + +Uncorrelated account. + +
    campaign objectrequired
    + +Details about the certification campaign that was activated. + +
    campaignOwner objectrequired
    + +Details of the identity that owns the campaign. + +
    campaign objectrequired
    + +Details about the certification campaign that ended. + +
    campaignOwner objectrequired
    + +Details of the identity that owns the campaign. + +
    campaign objectrequired
    + +Details about the campaign that was generated. + +
    campaignOwner objectrequired
    + +The identity that owns the campaign. + +
    certification object
    campaignRef objectrequired
    reviewer objectrequired
    + +A reference to the reviewer of the campaign. + +
    reassignment objectnullable
    + +A reference to a reviewer that this campaign has been reassigned to. + +
    from object
    + +Previous certification. + +
    reviewer object
    + +Certification reviewer + +
    identity objectrequired
    + +Identity whose attributes changed. + +
    changes object[]required
    + +A list of one or more identity attributes that changed on the identity. + +
  • Array [
    • oldValue object nullable
    + +The value of the identity attribute before it changed. + +
    oneOf
    + +string + +
    + +boolean + +
  • Array [
    • + +string + +
  • ]
    • newValue object
    + +The value of the identity attribute after it changed. + +
    oneOf
    + +string + +
    + +boolean + +
  • Array [
    • + +string + +
  • ]
  • ]
    • identity objectrequired
    + +Created identity. + +
    attributes objectrequired
    + +The attributes assigned to the identity. Attributes are determined by the identity profile. + +
    identity objectrequired
    + +Deleted identity. + +
    attributes objectrequired
    + +The attributes assigned to the identity. Attributes are determined by the identity profile. + +
    recipient objectrequired
    + +Provisioning recpient. + +
    requester objectnullable
    + +Provisioning requester's identity. + +
    accountRequests object[]required
    + +A list of provisioning instructions to perform on an account-by-account basis. + +
  • Array [
    • source objectrequired
    + +Reference to the source being provisioned against. + +
    attributeRequests object[]nullable
    + +A list of attributes as part of the provisioning transaction. + +
  • Array [
  • ]
  • ]
    • searchResults objectrequired
    + +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 objectnullable
    + +A table of accounts that match the search criteria. + +
    Entitlement objectnullable
    + +A table of entitlements that match the search criteria. + +
    Identity objectnullable
    + +A table of identities that match the search criteria. + +
    attributes objectrequired
    + +The attributes of the account. The contents of attributes depends on the account schema for the source. + +
    attributes objectrequired
    + +The attributes of the account. The contents of attributes depends on the account schema for the source. + +
    attributes objectrequired
    + +The attributes of the account. The contents of attributes depends on the account schema for the source. + +
    actor objectrequired
    + +Identity who created the source. + +
    actor objectrequired
    + +Identity who deleted the source. + +
    actor objectrequired
    + +Identity who updated the source. + +
    application objectrequired
    + +Details about the `CLUSTER` or `SOURCE` that initiated this event. + +
    attributes objectnullablerequired
    + +Custom map of attributes for a source. This will only be populated if type is `SOURCE` and the source has a proxy. + +
    healthCheckResult objectrequired
    + +The results of the most recent health check. + +
    previousHealthCheckResult objectrequired
    + +The results of the last health check. + +
    exampleOutput object nullable
    + +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-work-items.api.mdx b/docs/api/beta/list-work-items.api.mdx new file mode 100644 index 000000000..a578ce914 --- /dev/null +++ b/docs/api/beta/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: eJztHGtzGjnyr6jmPiShPBgwxI+qqzuCsZccxj6Mk931umrFjAAlw2h2HnE4l//7dbc0L4NtzKZuN3vkgwMaqd/d6u6RuLNUIEIeS+X3XOvI8mQUf1Th514s5pG1Y8V8GllH1xaOMT14s2O5InJCGeAqWDOayYhNRRwxzhzlecLBB0xN2C2ukriKjYWn/Kn0pyxWTMh4JkIGf1gUCEdOpHBZEonwNXfn0meh+C2RoXDf7DClpzlJGAo/pklVoCvgIZ+LWIRI3Z0lkY7fEhEu4JkPT4iVuYyth8Se8a/MT+ZjQA8EhiJKPCAcaApFnIR+9Rf/Ugh2/WGPtS967DLmvstDl3Vyvi4y1DevZ3EcREe7u674AvyBJKsRl16gpB9XHTXfla6/ywO5Gxk4di4fO2fhDZsAm3MVCiZ9+DgnfSCbqSCsown3IrFjia98HnjAXqNV27EiZybm3Dq6s+JFgDwDXjEVIazUYPTQXgMGQK5ynsytI1g351/1Z4LiigkHKdC3+/ud1dJUk0kklsV5TsNANkgQ9TRJPM9IlcGDKruKEu55i4Keb0H5rELaqaDgAw5mwWMB60OVTGcExyjmu1HH71BGJv7Hhe+oxF+WfW/CKnGYiAq4GEgVBB+oIPG0KAWr/GiPVMw9u4OrKyjSQPmRYDPBXTB/0gNOXOEOMw4QVeK54LfGM0BzcpLpDeTHKtomKuxWoKimPkjMBY2BzqTvCPJiEcXo8xwUDaQwYoQ53Gcz/kXAMOiIhIPz5TzgTryD3EBACQVobC58FxD7KkZLiQRirRCQvxPnFaSJqP3CvURoKeBsIBtChaHmu7Ag5GeFEY2V8gT3rYKd0MrHHfXWFyHE8hWwojgEZVj3S4Z0jMpHU8gCNiMwKyi+v8EhbUkRwm7UavhfGWIftpHyBgCQHAUOAXYMs3kQeNIhqex+inDJ3TK5PAw5MqbX5+Nq/AkkjptAiBqKpSZEususrsGpVdCB1XAO6we1g72W2xCt+tuDWr3l7jUmB4c1h9dbB3WUnTFrEvILEGbLNkd4LKPA44sBKfo5zCPA6eoFaBlPk/FezXx2CZ49Q4SpCa2FI+eQlr2YO1q1PktFXpYRvudgTDkjTiggGq5kJAvJLsywYwn4S5TX6vt2bd+u10f1g6Nm62hvv1o7PPgZoc6VSzvZZmAP7Npbu9EaNWpHjcZR46BarzV/XvLJtbSbjzxt1R0SA+OODr8wPVJJCBH3Vfv4FaKGaBavlL/wcZO6tk56g97lD91jGBp233c7I/NxdDUc0Mfujxe9IX266A6Oe4NT+NRpDzrdPg76kBXcFCkqwFvmi6hBjniJn1jGtDZNTy+JaKBeE/048VeDfw3OPw5g5LQ76A57HaStOxz1Tnqd9qh3PiBWzrrHvfTbMZB9mn5pX1wMzz+0+/DxQ++8T8PD7ode9yOMnJwPz5Dp836v81P2GBH80O73u4PTLnzunV20O6P2oN3/6bJ3CQOXvdPB+ckJyu1DdzCC/8/ag6t2H2bp1aPu5cgqSSwnfVlgyPgqC3gosREKiALKXLhSJ/3fLraWg4GDiycmxr84KMQ8hILi5SGohJVpKBsi3ywkPUvAJ4i01SgNUHrCpnH9ZZhhc5Ve23Vh944Qd2EP3ozX4iauA0oJXxuyIsjxjiF5cGIFKQrijAH0OInFhhjT5ZDfYVppeBZuCXEwU74YUFJbwnmeVrrrIc4K49USRiEXSSqRkASuCU7Z8w+YoK6HWeeyL+K5VW/YrVbLrjfqDUQLBRUIv+dCviXjxbqSJoVJsyglYJUR4zarrRiw3eeRZliOLMciBptLrS1UwNg3DjgpWAp5ryIIBS92d7MtronP7KGhmEDRA1ULVEiL1BtySp5w+YLX/E9czl/b0zJLAznSqqeih3qZMxVh50tXu8yX9T2lCFYvK4Lk/xxj0fa9ZzgF/2oXvKjgXOvrOC/wljTcNqats0VKnxU+2jiBPrDrNbt+OKrvHTUPMYHeO2hRpgsifxgG8l7JCgfI+hO6lSj9x3Pd+iHAF2GowiL0xyrJvCDOAFw/EBPkFrobwqNiDwu+YZthAhJzq9ZNUUd5+/Qe/+1YzVUVcseT2M/sIqnMZsNCj6VQprGxchfYDZE+aF261Q3K6EcirEvm01HuGpZzIn1hT0MukUKSLnNgIUNjlC7uStTr0CDTWEXzqiWjAElU6+wdd4FfzV/HMIPyC7nzGWCtk/Vd+RLWs3QJ7FnUcXkErdgXfPy2dthoTt42OW8cNOv7rfHhhO/t1Q5bh4dU1EFc41OxymrKqE8FFJ3SYZ5yQCP/AYGAv2DViQQQ8vVbFgRjTc/VczM2Db0sFl/jHYgj7zoXrLnPPO5PExrn0wdC8O0rrD0wUvFx2nECzjXg81BO5cpgnkbI4+5J+6o/oqj47yssUNKoVya27YO1umiWipx2pm6JYsMAOZLAnplwq6xioFaAIe5HxYlSf4sWEfqh6X7BCoN9xYoiaDYJ1bzkSuQ3X2P2WlZFdQeyKRiDCObM2JhHsMAkdBWIgyKI7b6RZMX0S99UGWx/EpmETZ42mwjWL7DVyF3sUpq4NEnAlQW1V1USY5iQjijrIhdlWRt5EOkXlYLOAZQ/byew/ydAHLFZ9MLMWgyJRj9As5ZcmbpRQWgk0oUfc8gsHGrkOyrE7ILBrgsRMmImHKG6Igg8fjovi1jF2Ejh7kwTcxwreubwJFrD7y48CD82sZY9+CKM89EbHB2NSBupmkxEMi8naLGZlakrdXwGgd1zt7679d2t767puw8fDs17AfOUUp+95dTnRIVjCVL3V+Q9+H6XLVTCOKghTHyf3h5FO8xVIvJfxea9Eag5irRbA+3Cd239imabHm3To22I3YbYv0yI3aZHW9/d+u736btPpkcZVeQtJk+Kkvmchwttaea5bhPChPwAT+ZyWae0mK0gMJblWFY5c7DGjfq4Ptl3RNPlTfft3uGk4bxt8NZ+fb8+bjb2reJef537ceZkZZ8q6FvrUfc3RfgF8rjEB+OKYqXcck8rof45hjUMPTwBawohVQCZg0hv7rO2WXM5dxyoGHgDwJA7ho/0zK6Gfd2f1+BRbvp1NzotiU639DClpC6e+CqjeJs6blPH7faz3X7+MtvPNnXc+u7Wd79P331R6th8LnVsviB1bLJB+l7zj0wdXalPfU9AKXitxFz/CEUArMAnfQYndXt9RCVL9PIsktIPsDgkXx9iCXg8gy+7+IbXTk8ma6Sa6iT04Hl6DvwOtAjau6/yQFbTkzG+uqXD4GMQ3YqohK9rtQfiBDp2rhFUSe6hRNPWcZCAay2Yw91Wdt78ScjpoZAFMMw0mB08B2jMjIbx9T33F+Y0R5XMaok/4Osq9O5/Py8a0CO8rBLfk9hgPgNKH7CILNygusAe6FgT6OsK6OnoINZOULfXN8U5l5i0awqXZuYbEdYgjSWCznFag70TPMTbSuqz8Nnr9x9Hb9gUU1UKFUmEWbK50MTZBZgRhcJ22qLGRWSm+eWWtql4tBGj67GJB0Jh5q5CemxrAHvEEII6iR0XCYojuGr9mwq8tO6Rmwm/+LY5NSRxy8c5hkV9e+M6SPniBb42JeJvKTRbQ7MJWvTmARVatNeOPinhhILEwr2IpLUxcg3PLsDDAgxGEOpDGlAShg5e0pqTam1jOkrwbIRXpuMX/+NMwj5cXsZ0PGPRjK7n9JgzUyoS/2AMTQdd5XqagKdtTNYtIrXJI+xGrUCSrVHa0oaskujrg2P42pj4GHd1SmqUDtrktr+SZiEu/Eo3hn4t8UzD17D54kxXOS+4fvOAZkRoI0Jbx4nI0K/3NjQsPLAEPFAc0AbQyfVPkcAQWoiNGtbKyE/gd2kNbh8OkEpQouBIfznKg6D5xOgBzs7mQKjGpDx7mQXfmYGFO1dJWGk74aEEl+n1FGyvD+Sm6c06Lbjl/tn4RY7bedfl3PcW3zpKPxJJ/jxx9w+KeNtI81eMNCb/RXMjtKaeKBr5O5PTLXcBI7pDCn/hKfkqHtCEYiDOr40WAQUej9GqyaudmRTUPwgEjzE/3EHLUnPyRCj10f2hSiRAUzpsGgLJHCo+6QG8KhvlmDk5jE4+Ua/4PUpME1eBSUI9KqrsI5R0vgNqwXIOjw/As0/K1HWXoJkLVCw7TpUNSdd8nvh4yh3ITuaMg0k9YxGujJxEBy6o7nyRykJR6petSr0YTQ1ZqFJ9E86j88klZM5Q9RYU/wwu0Ht6cRJEj1o0lzxzRobCI8vEeeXU/jnYYG32THgBFpQQdSEBEwUMZ73REkQA5psKS4XTXbMo2sW5eG4bmNfms1etV2s2lRQwHqgohhK4AJyuhxZ+UmDp8lvWif9DflzA7DdYKOwG2BxDLhJd3Oj68doq1I9QbcyARRy9u8OuCRZU9zisr+ZilQJCR0/I7/0+yvD39QMFK0X1WWAfIv39BdNpsCysPteXw//XLws8Icfslxc2FOT2ZwK+v58JeMIc0t+C2NQanrrr/5QVZj8rkCO+yVtA1HaBOEg2QxFPL9Nt48KqpRerCCXr0Z12YSe5/y/LEn+V +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
\ No newline at end of file diff --git a/docs/api/beta/list-workflow-executions.api.mdx b/docs/api/beta/list-workflow-executions.api.mdx new file mode 100644 index 000000000..b96190264 --- /dev/null +++ b/docs/api/beta/list-workflow-executions.api.mdx @@ -0,0 +1,105 @@ +--- +id: list-workflow-executions +sidebar_label: List Workflow Executions +hide_title: true +hide_table_of_contents: true +api: eJztXPtv27YW/lcI74e1RuR34sTAMKRpM2Ro1948bu9dGqC0RNncZFEVpSS+Qf73+x2Sejh22jTr3dZeAcOqSIeH582PNMmblkpEyjOp4qOgNWlFUmdvVfp7GKmrF9fCz+mLbm21Mj7Trcl5q/ioWxdbrUBoP5UJ0aDt6VxqRgw0y+aCibI5C1XKOJvJSxGzK8egwwpWdUqeCsYvuYz4NBKmXZ6wTLG9Hgv4UrOpwDuBf2Q8A7E/B8+gw54tWSBCnkfZFluqnPk8ZjORodMFv5aLfMFUyAbbvVpXHcZOlSGqdZ9wnRnhQ5niiVqkwldpoCu+gbIUKoLsEGPC3sX9DjvTwrw//wksSytdPJlnWaIn3W4gLkVExu5oqJcoGWcdXy26Moi7PJHdqch4l6znFRbST5mIA0NJJiBRIUNaWhAqvIsHHfbT3Q/s6DkLU7Uw8qRCJ1BNEPGww/7ttMAno4qQeErJPGtKvYsZ89ihjDIQQIBQxgHYReKSQ6Krde91qMUhfCau+SKJRGWz0DIhf4bQXgSbmk/Y+59enLJuqV93UjwePe9WdD9abvoHnfEs10x8YO9ah4btu9b7Qu5C0YTPZMwzck6q8tmcDII40ewKmhul36sw1CJ7D9KULwRYk63u0QTsKlYrAcXgW/uZw065CQeOEERQsyu+LFyYKecWE1YbIs52fixCa/XzN1YBCvhjK/rDgwoWigOeBp4Pxwqf5PRKLfV3Scnac1Z5any0oByTMR4XpjQwPlW5FfNDLtJlZSldGsYorBhHSkKowuxo3GEoHxpWSmW2RAm5aSFV0gMVZ+I628+zOZUVnZS+nqSCB62LW9SXqhvTLsYfqDMyAENJFSfhaH23DB0FRTQXHEGSig+5TAVKXJbmAvJky4h4aUnuBYG4TiIV4FXII00E/lwseGty08qWiaHMUtjJUJqQwCu/P54KPuTe9ngUeKPtoe/tid7IGw13tsNpuM3D3rR1e7t1Y6U1pgMDp0YkFzJbk/4Vv2ZxvpjanCxiFYZNRZanMVLsRKDI/HPI9t8csRPnX3ZQ+pe9KY32peJkc1B0VszqzFYaB4G8wYjoV8xEipaWjX01HODFQsZUqFsTtHNF23Fxld38da81bQ6vmfO1eQ2xXdqFeRQ5qzJ8oLKd8yhaMp0IX4aSKhPVhbbxTpsMv1ZAXFUlx3w17vgDzijNf7/xfZXH67Y/Clmbsq3NJIYLCcMnKskja0rB2v/yTlXGI++AWrfLgYrNkf8I/7I+b0gHKqxXKo8CIAGXGfCcDEu/UQlu25hosytBpprFsFjQofHhRMY+tYMa2hRWDkdDFGYUMeVszlHEONV0YxyiR6ngPgAGtAHQoQK+WGCARsexMnVdC+q1bZj8YDRvk0xG2kse5cJagaghNgqmk+ariCBXN+8G0VSpSPC4VYsT0/LeWHGDd+v+Entbr7Gbxvi1SHMYpQiPXJNPKXQKMzC9jDNUVttsSrES/8k2/84qXh9ryfmHxVuKKZ0niUoziEf+WQFkwAciAl6gwLaQXaV6QhzabXScZqdygXibsLb4sMUIBxNqmeHfmWiXZDClo2mvO5tG3CIJNbll0OvRP6u2fgmISrm4AcCVUq8iffTk02iPEgFuPEki6ZuA6/6mieXNeiTwNOUUMzITC117r6a/wbD4kKRkhExaQYEINgzUd2cnYoPMgMorQ/p0uDcMR2Lgjca7294oGIcenw7G3pDvTHeR6iN/t08BWgLTz+35Tn/BoNf3t4M9LxiOp96ID9Bf2B95Ozuj/igc7gXbO7vUn6tVD+sOkTTl/u9UjTATyFI8GxBayOCYUQ6YJFlqmLmaGsC2lzKgIg1GYAAyzvxcZ2qBJHMxyjKJHjLj8kBM89mMgjTJ00QhejorSo76oj/g41HIx9MR3+F7u1zAvrvj6c6I+8GUFCxjeJOC5fgUYPDwMqLaZGT62qWvK+iPGdYiWBFp0BsMvB7+G58OepP+cDLY6wy3YfXd3mDnVxLIj6DI/0YgM2h8XJxhv7OzOxj1e/2d7V+dfZC86+l4T1g78q119BrTsH7eOlDUtTWLrat4OKBxzj4e53FMLS7qYlaNUN5bmczM27X1Any9JYLRpvpxEElUAvYiTRE5HqY01eBtgZWNzakKllQSZYyRUwadRxSRe4pFgIm2jA4M2P9ULh3KWHizlEuSUBiRfTR0KUIRbwZRy7KYdhi6OxnQ63X67BkPoK/V78ApQ3akBAWvhyT3WSzRnhVNmKyGig3dirHg053e3mAUItP4YHfUH29P90I+HPb2tvf2qPeF0BqTVr2h+q52/ZOIMVD5LFI+PPIfQWsBHLY3ApjOH16wDY8H2J+i29KWajp5Gc0et1CYnh28YaMxi3g8y817PrtjhNg7OyH8AehPq0oWykBzy/h1Kmcy3jjRc6ny/MXh/tnLU0qKF/84e3GCJ+K1tv61HyNaAwpLZdDqHBmZVQpccQzwgoABrVi1Hdc2FOKxrhNKXSvLxboWWrjeN7Sos66v/NhQ8+1Umz2RHdHZAvTEO1Qvf45RAhiUKTsMtPd9XySZ99JZsu2A+NMO2w8CSUoCIRscq9F+SRiWB4HFUnZuhVQWBrfTagFgrvTFqi8qU656oyomL+tOoeSA5J+Ok30/wzTOxMRKFpbR4kR0/oHM1nKr0p3WjGZMSqAROM43M0RfpcD8qEzQTQJlunJkcBsKT1zQlRWrXiNNuXtlhXmeKfPN57l+QN69iVB+PKNa+eFSuOQzSwPFgM0rN7mK5Ga9prGjKt1VJL5Flk3uNrnb5O4Dc/fux2M3a3JfDfTpr0Ofs5jnsG9qBs816JOa6IkVK4js0qt15BaDQRxE+vntKRIb8J7oxXVCU7gviI/sUL4m/H7pDzeJLubYxdBf+YIENHa0GtgV/4mRu5LYgkRjquF6b4cqnUoEaLwBIqJqpmbZmX4sSi1OZVxvsUAJHX+fubUbZITWtgJSr3Hg2Sl7gyQbJNmMRs1o9M2MRg2SbHK3yd2vM3c/iiRLqUy2OJyk88WCp0sbae47acsZCKof0cqUM666i1aIGSsxVmsVObSmg/60H459MQr4KNgZ7oUDf2fAt8f9cX86Goxb9bH+vMrjMslWc6rmb+tHY2KAuEvguDxGcOlMqWB1+Q/mTUVIZc3sKihwM2wOk15U2HG0jh1/URl0A2Ngx/Se5cWz45fEnzYwEHuym8pTXxDMtqazP9sRpDQ/2IlrqbMGOjbQsRl+muHnmxl+GujY5G6Tu19n7n4WdBx9CjqOPgM6jhhBrJAg1l8JHQNpd16Zfcm0QwHmjQk2JlAFT2710aV9xlPaflsAvRUUOdjb8MO6UuwVj5cFWNIrK5FxZS4qb6BdEG1a0Jo9E3YbDKqWVHZPKu0EACalHXBmnxrlMSkEvunS2w9pE5Pb/ebirexFxn6UQ0JTFCJFa68KMSazYks8OJh10BkK9Rdc43Te+kPrweyYNH5JGrMX174QlPPl+u/2pl0CRxA+pXJxYn19z3YBu2ZOu49jcZ3Y8lVC0AaqN1C9Ge6b4f7bGO4bqN7kbpO7X2fufgZUd2jofqgOggdDddB2eqzEUodmf/6fjdhNqjgJTHgz5RusHlQY3OAKhBIJNDPHeMzRrkmrdhjwRga3tVOALTpURtjQipWnEciLrfo38Ba8dNvhieygiMFh2TJWV2a/Pp203FB9aLOpzTQiMCcDbAcdY99UUgjbemeYW2u7Mw+t8kjARznTGQhyozmuadlsMYS7CyfzGiImmEt8rw11x4TPmn7Q6yyNbv+4LpbRPbpsMt9HewM9g6R3VCQVLqozgCcEvG3vaycBq8GElvwHa529JrIBeyZ4ao5H0i6YJz+/PX3KZgQ3Tbrb4x/uYCtnbxAippztFztCqJEZYarzXPsre24ofZg9pOyO5xw5I/yCOn+MwmxMSo2EqQXU6uEHRfhKu3sO47yLPfZcpvYciT1a4VS0B5bOk0IvXtPrsUJ8V3DzLDfPcKMjKitSWNOe+3YPt48cJhY80sZaj+7c8vNq/GgShTfE9a4M5lC4lWN1p5RfeO3Rcqzw84jfqhzv4rdzibF0tRmzpYvpuTmRdsT8uVJa/MgYhQ6lwfksRxY9Wqwr6tQzGeENejWRPNulJz0gQyPfSyRGbIPJntk1wMSd3TYp+d54Fjn/3pwler+is3l9jgGUKAPlf8bppzsyU4cedejZGqCd/HZ8osBCbtuLBJD0NgAOKv+bSuAErdU9y2tjVTfsu6YNDQ0+RDVcdDKxf0yqAueemPlA1CUNyjAB63LvGP5mjhcNUivGKpYE7lpwXd5IYWy8Yzcrb/nDJo2Xfzd9SeP9auXkdRwtv3SVvqeS/H3q7l9U8ZpK8y1WGgd1KdxMt25OUA/yZw6vra/k2ftF8H98NblqUDXmLNVJ6TqjJOIZRXX9UoZUJIJnhP22KLLUwmQipuuU/sJdiTFLQUMH/YBJ+VRG4GdWqYueuUkYCyzJr/S3zt2eCYWQxJxSdNhbTMtiH26hKRnt1sW335Sbm53AM2/MxSbPC2cDdC0WeYzeKC/zBeMIqU9ERCC1n9vChRlaLApbKAP9ylZFFlOokQodMzlJF/p1SMvLmLnWHP+JvuB37daWYXryojvXXClyLCJeTFFWYfuneCPavLmIEpoUouoCgIlaD6+OTtc4glnsftBQ6azrGuku0YIJTY9s+Aw7/U7PM9MFvE+UzjCNrTE3x3rLG3lWrv5ZicObalm9ufDHvG8u/Gku/Gku/Ll74Y8DiDSz7ya0Ik1lJ7crDXZt57w8RE9FZiLtieiy7lxsteaoUkR3c0OLl7TecUuv7YUStOiDukllo7qt4t5S9XVdq7PReL8LWg4sbg1yC36tFi0OPdwO/1/34XzEjuV9QY80ZHO5zdd3uc1HwqG4weiR0dBcQPOoC2g+4pDqmqDKJRfV2vVnlv8nx+6qm6ds4/VwGwUpfmWNl3UpCgExXt1egMomtJHHfrA/rdWarG0+IUXKnzuAgFp2YWnTuop7mJzTDyX/BbSSVuE= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-workflow-library-actions.api.mdx b/docs/api/beta/list-workflow-library-actions.api.mdx new file mode 100644 index 000000000..e54d92e9f --- /dev/null +++ b/docs/api/beta/list-workflow-library-actions.api.mdx @@ -0,0 +1,87 @@ +--- +id: list-workflow-library-actions +sidebar_label: List Workflow Library Actions +hide_title: true +hide_table_of_contents: true +api: eJztXHtv2zgS/yqEukC3ge04ztv/HNw8iiySNpfHFrg0d0tLtM2NRKqilMQX5LvfzJB6+RU3Xexd91wUiC2Rw3nPbyjRT56ORcJTqdVJ4HW9UJr0s07uBqF+OJX9hCfjno93jdfwUj40XvfGywcY77bhBcL4iYxxDMy/GknDkIhh6UiwBzeScUuE8XsuQ94PBUs1G+usBWTFYyoSxcND7QP5pwmKvSCQ+JGHLNB+FgmVErtsoBMmuD9ytIFQloQwYZSmsemur9dGtwysG2up0pavo3XDuVkfiTBezzk0xaemSUVsWqM0Ct84tr3nhhfzhEcCOEUVPHkSefuaiWQMCyu4Q8qLZOpNquSMPzKVRX2RMD1giTBZiNrR8DHNEtX6oi6FYDe/brLe+Qm7TLkKeBKwAx2GgpZn58XStz8X0ol7EaLtJiSTgVrnsVw3jk7TL+g0SxHekfYinQgmFXyMrJKA90R8zWQiwBcGPDQCrcOjOATxOtvthmf8kYg4WikdxygzrCuGIoGZloy9tNmBC5FUMsoirwvzIv5oPxOVQAw4aIG+PT83ZmtTDwZGTKvzE10GtkGD6GKDLAydVhncaLFrk/EwHDMTC18OpAjYg0xHbI2ss4aKj/lQKp6CD44SnQ1HRMcZ5ocxx3cYo1D/fOUPZEiuPoODqVVNmkg1xBipW+qYaBQenxkYRarOlcHMGMLzkdlpfbCUVH+y5t9YQYGzpuPz3Rf1RR3nVxmkM5PFsU5SYA+tRD4HpPQD3gb/CgNIaypgNpHqxHSRwtqaDNbWumxNfF3zKmbzZMDEV/bFM3HXTwR4YdOHW1wO1RfPe4aEaoSfJTIdU5q5NiI50GDWx7SXpSPMvjAxT1VdIBB4tzgLuI8hUwnKoJ12ezqRnkJWxgw0mZOBOx9XUCnO4XEcSp/8b/13gxOfpi3Ok4Sjs8hURLRgKlMSLq8MrJfnZDdD938H3cP3OEE9pdIyKoNpP5p0I0uKnRy2GFUX+M/RhVLpM/RWE3MfbHNyWJinKAil1qe1jf5qnX1JBj7i4CrNAyLIDlCcgdMZO6iQt2SXJE+DquR7B1cnnz5OhdWS5A4rF6tUPwiFbipQiX6N81wxLVwS88cx+fYMs08kZCVYmb3ijEo/TyuWgD++iFNT85iFfoGl+Qp8/mVxD13uMC4wk8jGJKYSvHJ9UhP/Ci6h1bEMDOU9/U3RqxboAvCKCJdQPBtlEVcMY5IQDq1jfRIWeJG13HOsoy3tnYVEENpIlUzAeAqj+1ladynlKJc5vaDe1zoUXM3Qr9LoLXLgxLASoPvkVGYvRtWiEgTTXOOdnOtSO1iDoKSjBr1ummRY8xQWrhsPsyCmFPjDQcvwseQaEpQMHQZECoi34AOlMEhwI+Hf9fWjuxJzSKWYaUPrfBEkfnllAzDILBzGhfRwGOI1GUB2hJR8Lv07IjvU9whZlS8+AIKIi+uFjQq/zmMGsnpCaOZOjH/lYSbOuaT6SowXBHhwj1SDK7v0bdV6JP4zqnQi2zqgflzGLI6S5nAMBpf+5WT6nm9rKHoAFMDcDyMBZrHpNLBkmM5SdC1bDdAFLIC1ZTsOIQvn1rRh/9bUp2D+Lqk5MrZXUFCUXUovE0EDbt6JygUkz8v6RT4DjELeoT6Avo+4YYEcDOCqSl15poUNdCMSoGKfKN6DSYOcF4KLfW7gCiarokUpndK0Zrm2lW5KvYXtJ7U7INWigmp6aWBwcTVu5HkTo8smTuA0yHxRXx5jCUhJW727T8+T2ZNnqb4Q9/pO9BCn2Dj/CWut92a6EK5PD69ARBeBdm1sfUj429IJZ82e8DMqYTwIQfzFnBSjKgx4Xm15wDaddnOj0+xsX7V3uu02/G9t7ez9A2OlQL0Bkk0lFWwIduwv4eo/W2s/eSXnldUWI9nFLFfr7FyuexAs91I8oAsDYE3GWom3hgqjMaw/Rq+QUES54gDgWyjMAr6rS06xTgnloy6r2ZFCb37BCebO+hZfWEBk2iUs8l7MlRszGza+NA1agEUmEW2o01zs7O9td8TeQOz19/hmsLUntn2xu73rL7SBDGapPq91L3LmwN5c3g56Z+e9kw8f/3V8cnp1dLGQFUdrgplKmSiUWM9PWCJe0ONiBXb8/Y299t7O7sa+EH57t72xu8F3xebm9jbf3GnzVygwhzzzWVIWhc9l6sxGELugcFvIgiM1xUQioH+MBHSNlGGXCp85c74leOokFkXOy272kn+d9T72PnyvX83oqaZ8zP1reFuzWtKDUGKVPkoSQMlNsFmOJwZuS+ZrJqBp7etgjHhDqnseyqD1io51Tp8RiBQy1oEOlgDax1AqmsOES+RQEMs+THRoAjcDqAWyJHMkRONq1Rs10dpg73kA8lr5DpwwqNuE+3dA62SJxvhaSZjP8ilMlhsUM5YVu4L3d9r7na3Bzhbnnb2tjd3t/v6Ab26297f393F1aKYNRM/LPR91kQDWQg3gSf4bFAKOYPJNWVx8+V6PaCzZ6NixhZiOX4bIuAHQ8P3BOdvaZSFXw4yu8+GEElTz+nKqw8Aejwh/SuRQzuyx8xbk8Oi4d316BVcujv5+fXQJn5DW1D54T4G3BuiWmrZ9R4BX01KAB0CptvsQQYutOaprIBBXpjpQ2m9mbECZzMUzzHCrz5hRJc0GiY5qoeTbvST2s2yJVgPAMFwDyAToucC/OHytRx1789Rpco2NACyJ5F2LVfbj77GPMTB/jKiaB4EoettBBqEsaOcVsC7ge4D2om6LUpWT/V6eYE6rRnm2jd9SGyAZMEdiVqOw8BbHorMP8Gw1V+fuqqI0UiluVQIot82CrxNI15CZQDYJ/YtLR7RbCIlH5eOKjFXNm5Tuziwzh6mmez7PzBJxdx5C+mmSaMWNe+GCjx4quN4GrVE8NrEZye2X0+SiA3K6yAO/aMFXsbuK3VXsLhO7kzcv3Ea8u0vQZ2Ma+lwraJxHOqHiOQV9EvIepVk+yG5LWkM2cLvVQaRfPl9BYN8JhePFY4z7cX8gPrKlfPqZbGEP9+gmf7KTl/7SFsgg6dE9tIVMJIIu8V1y7JUocXN6tWOd9CU4qJoBESFrJvgcmXFQWZIphZxw02CBFka9TdmI34u8zc73egFjN+2DohWSXCHJVTVaVaO/TDVaIclV7K5i98eM3YVIsrp/95TjJJNFEU/G1tPcffuQDAaw/JUQVoQcmWoSrSAxVmAsr44cvH5no78x2PXFVsC3gp3N/UHH3+nw7d2N3Y3+VmfXq9b6mzKOiyCrx1TF3taOpGIAcfeA4zIFzmVSrYP69h+oNxEDTGuYegrcDDoHld4W2LGzP+M5s9bsjKtxjpBMDUOqUkeY02BshGOTfCwM4PSagGKQqiTwha4kIwFU8CUKRu+UYfCiFEA3GTd7A3zpyQZK7mTFKlL5YQYcUiYINaJmDY4lQUgxQMwHFAjBDiE7/4Ho1Jnou5A8u0CJT1FidvToC4GBXiD37Vn7uyfKvtnJLq2B52z02m6HK3AAaAhszipw5wqfr/D5qsavavxfo8av8Pkqdlex+2PG7jfgc4eG5uNzGLA0PoexrTYrsNQxPdL/s2E6hYrjgNybad/PEtpuzjE44QpwJWRoSC870ouWXa88WxPaVxXXy3fPLfa3XNUP8DyBscBIzy0ey1b+CqbSD/R6fx80NCP52PfD0XFwAB0ksAu0SL2JRA+26Y6Iu7fp3FsSxQmChZTzt23HOoMER2Qa+DKr8ya6DCzG0Eq8NTS6Rd4zJR/IdZ2Ez98viyU0R5ZZ6lu4GoxnwOmEiChC5XQCvfVoV586o1DWEuzVOlOLfcJhHfZe8ARfMaXHFz//8vnqHRu6t9MDd1pESHoLlbNzcBHKZr18Kx8nUYEpj/D0ag9LMHoYOl2LuTM9J04JHyHNX0BeJpXiJEGpAGctf66E1+bNOcHzRTXZoUyEO/2GY5yI1OWxmziXi1fkei0Tb3JqTUutSdTwREuNC6vaG9++fONDCCMJHhrS1qsXt/SaFXrYQ8EVpDrJA2rC8VF/xOXnVns1HzV6TaRX5+OL+jySeGywNo3ZzMUMVMIwYCfMH2ltxN8YQ9fBMLgZZhBFr2brARdtUkQ0O+0KS027ZFM2ARgSf6cQGMo6E+9jYSZcogGyqcCG5G9kWYj53+jo0W81menyDdRPHBlo/xsOS03wjAs2ccGmzQHG8W/LEzoWxLY9CQpBbx3goLQ/ZQLHaCXvWVozszqRX6c5WBp8YJWomLhrv3TLBOc+MbqBo4sxkIYRVxcP/eA7c7SwRtWUle8ITGpwmt9QQ2mc0Jvlt9iRwnL5vyYvStwrN04+qXD8R2fpOZnkfyfv/pcy3irT/BUzjUO66G7Vo49VJ3/v8Nr0Rh7uNNNZFLhLsUqgGtCwPaSMKKZKKA55SqdQMKr9kRS0BRALniL2a6Bn6YgiEbp1DH88uoOEhvRibgIsc2jaZAj08lMwtDKngLHAEu2K301GfQiu5Y+gpRQt9hm6MuWDWbAjw9cs4N7v2rVml3hwCQ3LDnNjA+iKokzBahiXWcQ4uNQLHhFI42c2cUGDpkSuC03Qr5iVRzG6GorQot4kicynAe4uQ+NaMfwLa4Hd82OvoHq0ojv2XApyIUKetygTvyvwAm3wtiaeX6Sjg8AWdHiVFc5OrqYoAjFlQC7ovXUyXHeTzDqOBSLYHln32WxttNpNahfw0I82KXSxFeJ0xLc4g+uOhbHyBxwmTrUUW+uv+tkGVz0Q9q/HuFuFPGW2DbF934032ffBtLzzg15iBALgqKcn3NbAVugZL9uj6NgPgkrdu/fu7PlcAX6sH1mYqbo7gRsF+W9IuK0Az8O+cXk9/H/9OsICPRa/HvFKRa5+vKD88YIFai5/J6LU8225OwFRfAtj7bYkhbSdZjcuK7OmHu0hlWIz6cMRJk0+B7a6D7jU8/N/ALaLysc= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

List Workflow Library Actions

+ + + + + +This lists the workflow actions available to you. + +## Request + +

Query Parameters

+ +List of workflow actions + +
Schema
  • Array [
    • formFields object[]
    + +One or more inputs that the action accepts + +
  • Array [
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-workflow-library-operators.api.mdx b/docs/api/beta/list-workflow-library-operators.api.mdx new file mode 100644 index 000000000..9ea3fde77 --- /dev/null +++ b/docs/api/beta/list-workflow-library-operators.api.mdx @@ -0,0 +1,87 @@ +--- +id: list-workflow-library-operators +sidebar_label: List Workflow Library Operators +hide_title: true +hide_table_of_contents: true +api: eJztW1tTGzsS/iuq2a06ScoeAyFh4WXL3FKkSGDBbB4IVZFnZFthRppIMxAv5f++3S3NzTbBh5PaPSflPARbI/VNffla1jwEOhOG51KrkzjYCxJp80/a3I4SfX8qh4ab6RlN0MYGnSDnYxvsXQflFBvcdIJY2MjIDGkAhcFEWoZkLMsngt37mUyXZBi/4zLhw0SwXLOpLoCuFVFhZD4F2g/BlRXmQKtcfM/7RT5BfjbbKwntGcHj4GYGjI2wmVZWgEgPwdbGBv5pC3MKcjA9WiIFMI2Qh8pxFc+yREZkht5Xi0sfAhtNRMrxUz7NBBDjxvAprJO5SIllLvMEH5TWYKWp0FJujR5+FVEO3zODrHPphJVxg67NjVTjYN6QJTF2chjCQ/GdpxmxA2NEOs24Ed2h1ongKph1AsVT8TuIjowUKk6mjNY1yR842mzf0Wb/5kkBUs9KneZtXJGkx50FAWrKZ+dHF/3B2QXSatF4SurD+hvuJvqVrk29KHp+r5k3Dbsj8RlXMYtFJGNwyQnP2QS2XCjLhtyKmAFdJAoOVSR5iPKNtEmPpUhiu8QD5gygQBzDUg2cpcoK8nxg0RST8SgSWW5b7vNDF5mIJBtACKxqnaFwAYeCsxFKDsLQyNVJy0gDGMJNx+gbyzv6m2PQRsh85MOARTCfy7Eia0C4iuRpSfpsUqRgcwxRCnDiM0LfQAZPinbgebKP6JQrO3WlkfcN2gTGc5g9LPK2dytP2YhvhTSiGYdlMC3aV+kcrCtHXg2nAfgUK6ksZzbiiRWPxg1KjU9KqWvrAA1VJJQig73cFAJoqiLFRIhJEWMM/oCjc/hYSw3ZSibwtzAJUUiHAsOD8hlku4mIbof6ux/JOGRWTLyJc74UHF8OXATHhasIyEiPxwmOQeAoyHfTcxndEtmxvhNGcRWJd0YXWTVe7VHl12XUQJI3AgduxZSSyjmXlIhJ8IoAj++QajxwrG+au0fqz9Ckc6nX16rjOmpnjXXX87Y/gsxvyOrvL88+noMtMAq4SxaQG3XacCR4EpWJRUM6NJJ8ex+zch2lQVCFSVDN6QelDwd3fqwf/j1oup/bX++CTr9OM/qDS9oiSGCsKtVhg9dZOVizauRGTRpbMkG54uhbAY4JD0lbGPCZ3o+7yrpUPO8tKODPt2d/BXvuL9pzf86eFHSLBl0m7wB0w8x9jEueyf1J3jcz968TbC9DKAcJ1OGcHRkDgnTZhcgLoyChyJGvSN+geuVQzeIpphypwKQyDp8BXx6pM7HIIfoOdLxCoj2WSnTHhkuUUJDIESxkQPFOxrDCFUFHssxrNK+NYMAS4Sbb5zHo6/Q78MpgaBse3QKtkxUw0pWSsJ6VS5iMfbVZylbsCD58u7G7tT16u8351j+2N3feDHdH/PXrjd03u7vIPRXW8rF4uuq/E0oYGbFER7Aj/wGDQD4G25MAxHz1Wk80Vix0bm6lppeXobN1IOL2D87Z9g5LuBoXNM7Hc0ZQ3avLhQqDNZ4Inxk5lkshWVmCDo+O+1enAxi5OPrX1dElfEJaC41AX4G3xuiWICr4wgQAcl4rcM8tc/lExCF75am+AoW4ss2J0n2zUwvGBN8accRo7JXnvmRFk3SdfMpQilxrwV7IUIQdNsSxlOfRpI0FX/UJsXVPvSVfsQmgGmFehqwfxxKV5EmJLlM+BUKMx7GosM2ogFAGYWQ+0ZD1AEPISLT3ojblfL0v69tpc1NmrvCvgMOiHFI5+UQrCitv8SL6/QGZneXa0g0aRiOTTlXOI9CCJ9A3RNoYrEsAepgEyOvTEW6XhcSjynlVxmqWbUp3H5wwh7mmZxEv7Apxd55A+umSatWDO+GDz2JFcdmIdqPcJp+RCOm6WClnVdtVBn4Fwdaxu47ddeyuErvzDy/8uYx/StBncxH6XClegH0NFc8F6GPIexSgSD/JtaVuIzsI2zxEev9pAIF9KxTOF98zhGI/ER+5Ur4gfL/aDzc+RPhRbVZrL1BAsqPTYASZSMR7JHctcVCjxNeL3KCvGUpwULUEIkLWNHiMxhBQm0IplITbDou1sOo3POqA/IjnD9ZWvb5QcTfTUuVrJLlGkutqtK5Gv041WiPJdeyuY/evGbs/RJKVVBQtHifZIk25mTpP889RW85gAit/IWRVyPkzzzZaQWKswlhBGzkEw63N4eZoJxLbMd+O377eHW1Fb7f4m53Nnc3h9tZO0Kz113UcV0HWjqnGfrt9JBMDiLsDHFcocC6bax23j//AvEaMMK3RwWqJm8HmYXXECNhxa3fJ7wxasw9cTUuEZFsYUtU2wpwGc1Oca8q5MIHTz0SKQaqSIBe6kkwFUDHgNCyRqaTgRS2Arpl2+yM8XXWBUjpZxUWqKClAQsoEiUbUrMGxJCgpRoj5gAIh2DFk55+ITv0W/SEkzy5Q41PUmB19j4TAQK+Q+5tl57sneNKMOeLSbfAjB72u2+EKHAAaApezKty5xudrfL6u8esa/2vU+DU+X8fuOnb/mrH7O/C5R0OP43OYsDI+h7nhBquw1DE61/8cplOoeAnIvZmOosLQcXPjZ/5UgCuhQGO67EIXbfaCXnkFsZu4qyq95lVEh/6dXHh9Zy+Y5Hlm93q9B9gu2KZZyDMZlpdwlL4PI532hmCjJekH7wm4UMMJrH9+4tuLkAzsbi64hEfEnblJJfRWMDsdDf+QcnnfaqoLSHFEpoPXmbw/0TDd8lDT3yzNDsl/FvQDva5MMvvjujhCj+iyzHw/5AbzGUg6pyKqcFNfV71E5O24L1xarasJdmtbC8zOcNoW2xfc4NUZ+gHjxftPg5dsjHiT4r2wCHWFxAYBIuYcXITyWb88zMdFVGKMLsYTErzf+rkE44eh24Xss7oUgl2feCN8hER/AZmZTIqLBCUDXHXzotydWNyJBB01rC2Jjidj1QML9Xhr3Uuqd/4eJF5nc5eVPqsuO5SYhvAqEs3xKlKfx66zUi/e0Ou5QvytpNZ11LpEzb6ck8KZ9jpy128iCGIkwRNL1no2c0ev26CHXRSMINV5GdASXo72j1xRuWvPlqNFr4v02nJ8Vp8mEoppexlzuYtZqIVJzE5YNNHain8yhq6DYXA9LiCKni3WPTLtUkR0tzYaInUdy67sAjQk+U4hMJRzJj7E0kzIRANoU7ELyS+0sxDzX+h275eWzjR8DRUUZ8Y6ss+WGRl2kWHX5QDr5XcFCh0LYttdhoegdw5wUO8/ZQIvaCPvOVpLszqR79EaLA0RiEpUbLbnvuzVCc5/YvQAZ1dzIA0jsq5+9oPvzNPCKtUyVnkmMG/BRXkTDcVxzm5O3upMCgvmn01f1LhfH52cqWT6s7P0I5nkz5N3/08Zb51pfsVM47EuulvzTZimk+97vLZ4lIdnzRMB/8NTilWC1dC0UBtGKKZJKEt4TpfjMaqjiRR0CJAJniP266Bn6ZQiEfp1DH9o9YjQ2MAcCFsLmJQPZQL06Ji65MwpYBywxH3F77agToQuKU+gqRQh+wR9mYpgW7Anw4sW8Oyr9s3ZJV5dx41lh+VmA+hK00IBN4zLImX4uskTHhFLGxUucUGLpkRpC03Qr1pVRjG6GqoQUndiUns2wvNlaF0bG/8EL9j38i0oMD3uor/bXCtyIRLu7o935mD7U7TB27p4m5peHgGxoMdrcPhwMligqPF1HNALum9txj2/yPZwLhDB9si5z+twM9zoUrsA45m2OfSxDeL0zlf1SpZ/MaB6NcvOu+NDfbz+vHfXGre9exkeWaFYhetEXPN3Hcw3f0GnuqRPr9BNQAuc9/CApxvYD81wGLp6bJ2vb+pWB7/N8KY6nnJQv3grqLumc5C6gV78pQAbl6o3fXeEO8AfqYH+A7Kazf4LInOqFg== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

List Workflow Library Operators

+ + + + + +This lists the workflow operators available to you + +## Request + +
+ +List of workflow operators + +
Schema
  • Array [
    • formFields object[]
    + +One or more inputs that the operator accepts + +
  • Array [
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-workflow-library-triggers.api.mdx b/docs/api/beta/list-workflow-library-triggers.api.mdx new file mode 100644 index 000000000..012fd59e4 --- /dev/null +++ b/docs/api/beta/list-workflow-library-triggers.api.mdx @@ -0,0 +1,87 @@ +--- +id: list-workflow-library-triggers +sidebar_label: List Workflow Library Triggers +hide_title: true +hide_table_of_contents: true +api: eJztW+tTGzkS/1dUsx92Q2EbDITDX+4IkD22yON4bO4KUrXyjGwrzEgTaQbwUfzv192S5mEb8LFbe5s9p1KFPSO1+t2/lqX7SOfC8EJqdZxEgyiVtvikzfUo1bcncmi4mZ4bOR4LY6P1qOBjGw0uozDCRp/Xo0TY2MgcSQCB84m0DKlYVkwEu/UjWeGpMH7DZcqHqWCFZlNdAllxVwijeHqoYyB/P0NxP0kkfuQpS3RcZkIVxC8bacMEjyeBNlAqTQozJkWR20Gv1xretbBurqUqurHOepZz25uINO8FFm31qWMLkdvupMjS7wLf0cN6lHPDM1Hgt8HlfSSRu6+lMFNYWcEb0l8mi2hWKe/4HVNlNhSG6REzwpYp6kfDx6I0qnulzoRglz9vsf2Px+ys4CrhJmEHOk1FTLJ+rJb+/EMlnrgRKZpvRjSZqB7PZc96Op24otOpRXhF+su0EUwq+Jg5LQHvRnwtpRHgDiOeWoH24Vmegnj9nY31yMYTkXG0UzHNUWZYVzj1OzLu0VYfHmRSyazMogHMy/id+0xUEjHioAX69vCwvlibejSyYl6dH+gxsA0aRCcblWnqtcrgRZdd2JKn6ZTZXMRyJEXCbmUxYWtknTVUfM7HUvECnHBidDmeEB1vmG/GHL/CGJX6H1f+SKaFC/s5DuZWtRAmaowx0rbUW6JReXxpYRSpOiiD2SnE5x1z04ZgKal+Z81/5wQFzjqez1dX6kq9DU8ZJDRb5rk2BbCHViKfA1L6Fl+Df6UJ5DWVMJdLtbEDpLC2JpO1tQFbE1/XoobZIpkw8ZVdwV81kAkkKFlMO7wAHQ7LQthOPOFqLJKrKHqA/GpFXBoYQTnnwgpzoMHGd8V+WUwwGdt8EBLXwAieRJ9xFoiSa2UFJdT+xsZ8Xj2BJI3paC5FA68xLqEKnMTzPJUxeWPvi8WZ9/P258ZwdB1ZiIxWBJFI1FAp2HmVo/0UPfwCpoDvuUG1FdKxKpN5t5qrMY4WOz7sMqo38J+jSxUyZui9Nucx2Or4sDKXl607Y4cn9Y/u7BiZVV1ggN4CRYVRdRkd/Xz0/hy+nx38/ejw4uToED4f/fP86PT9/glWynplN/IhxNqyAr/H0U06x557tl9xzw5q7ltUll3ksPG0udYHJViVosK6tdaY11oXF5b2cAqiyfhs1lOGWqeCq7nVDzEWIUMBoduJAJM5uyWODNNlkZeQ3Ykc2ttVTpcv8hTMja6MMzjF9/e2PQUdpabmyTiYoiAbeN+pXXEdXl6LxgMkz+tYweSKjIIuCILQ9wm3LJGjETxVhc8LtLAFICShRg2J4g1oLwm8UJ0acgtPILvV4IgIehJNM1AGRg0rEO4oPL2fi6q2dv3AEAZQ/qap5qA8EMrFN6yJqR8qKX0cFKYUzyGzkEFqbAc5EGwgDSP2vJ7tPDB7ImEDaLM9eK+KTqDbq9SCviVqoZ3LOTRWeSKskwhI7wVCP5RJ3P7M0xKfZ9xci8I5v06T8NjyVCDAaxPJuOIuY9UUXH6KhNh9vbe5u7W1uTfc3kw29+JYxK/j/tbOdn+rv/U6rqtoBs7eHZfTOvEdH0LsH5//C2WpmViO8u6wpqxkLB6jPCsLWEGmbV180RPVTbT42xjfofrbSqneT3RRjcDKEmL/OZ4F3+mP2iwHmgtZfnCQ5S35/ILaMuubM5iwmZ3Q+bD/4EUz+UNqiEVe2GY4XX5uFq0nKxM2C+cQEM9n0kMPZqxHCiGSMVfhk4vjVmLFzIQKQlw6ljf0t8CyFuPiI198WQzjuRwrSrCgCZE+z8k+m5TgxwxxAaUVWscVRVjgWdYO/Jqu8ixfr4JEPie7bFA7ZHMJ5SnXIHOJWqE0Vhw58mI4CRAEBCqLFwvJ85Gqjq4CbwLXtXYWZUZf8xGJoTvDHw5aho811yHqMPkhBWwA4QOhKMBYExFfD/Wdf5JzgHOI9lLnfBkgUXnuAEZSuhYdF9LjMaXqEIYfZXxNZMf6BnO1isWP0NLk1fPKRpVfh4gCZGmovboWUwr7j1wS/CPGKwI8uUGqyblbugVkSHwM3VnA5zcP3tYR/eD/rUfbi+DoQSqxah4ZA97ZYadVfR/53gzaEyg3Q51M0dRS3fBUJt0XgNVH4jsRBUh9oJMlHPwtAJXO2HCJHApiOYaJvrpjV0CJyJEM/kTj2ggUNNHdZG+gEp96+Q68MKhSw+NroHW8BCS+UBLmszAFAFoFfRcsK3YFH77e2Otvj15vc97/y/bm7s5wb8S3tjb2dvb2cHVA0ZaPxaJM3F76R6GgT4pZqgHMyH+DQiAObNifwcWjpXMs0VgywbixlZieX4YeuQ6Z4M3BR7a9y1JACCU95+MZJajOxdlcZGNuJcIfoGjIhbA5hP7h0dv9ixME/KdH/7g4OoNPSGtuS2xfgbcm6Jaa9n8m2GvVAtwCanRRD+CZrXmqawyRg20OlO6bnVpQJvMdPMzwqy+Y0STNRkZnrVCKXR/JfpBd0V0HcArPMl4Amq3wKA5f26ey2TnxmlxjE6gmwrzqssbW3A3mDwvzp4hyeZKIqqaMSghlQVswgMkBbxeIXFq2qFU5m2dDXjlpGuXBJdwl6l9clMAcidmMwspbPIvePsCz01ybu/OG0kiluGcBbYYD77E2BjTMoNgwCbDDpyPaNoDEo8K4KmM10yWlu3eOmcNC07uYl3aJuPuYQvrpkGjVixvhg492F32vgdaodlBdRvIbZzS56ki8LkLgV6VvFbur2F3F7jKxO/vy1G/C+bcEfTbnoc+F4iXo11DxnIM+hrxHaRYGuXbAGXIdmx4PkX76dA6BfS0Ujhd3OeLg3xAfuVI+//NMZQ+/hxu2eEPpr22BDJIe/e83kIlEMiC+a46jGiVuza8GeHIowUHVAogIWdPgL0oMgDgzpVLICbfrDDpOq74v2ITfCGoCra16LKGSjtuAWCHJFZJcVaNVNfrTVKMVklzF7ip2v83YfRJJVlxRtHicZMss42bqPM2/dz9awQAWfg5mVcjdhN8dmmgFibEKY0Vt5BAN+5vDzdFuLLYTvp283tob9ePXfb6zu7m7Odzu70bNWn9Zx3EVZO2Yatjb2ZFUDCDuBnBcqcC5bKF10t7+A/UaMcK0hqmnws2gc1Dp5wo79vcW7O9qzd5xNQ0IybYwpKp1hDkNxmY41oSxMIDT9rxikKok8IWuJDMBVAyeJKHDJRi8KAXQNdPO/ghPP7hACU5WrSJVnJbAIWWCVCNq1uBYEoQUI8R8QIEQ7Biy82+ITr2JfhWSZ6co8QlKzI7uYiEw0CvkvrNof/dYuZ8S2Zkz8CMbva7b4QocABoCl7Mq3LnC5yt8vqrxqxr/56jxK3y+it1V7H6bsftf4HOPhh7H5zBgaXwOY7sbrMJSb+kQ7+8N0ylUPAfk3kzHcWlouzlgcMIV4ErI0JgOGdABh0FUn7JP3RGBXuPcqQP/jq32kbF7sBZY6aHLc9kNZx+UvqVzY0NQ0YLs406GoufgADpS7Bbokn6NRBd2+Y6IO237g9FRdTTtScrhmMtUl5DhiMw6niLx7kSPgcUceonvLY3ukvvMyQdyXZj04dfL4gg9Issi9T25GoxnwOmMiChC42gynfJ0q88dUK6LCTZr/bnFPuCwPnsjuMEzn/T7xQ8/fTp/xcYINync3blxIelYKGcfwUUone2HvXycRBWmPsy/3/q1BMOHodd1mT/dH47Ovoc8fwqJmVSKkwTlApy1/Alz3pr3yFn+K9Vhh9K4A+h0+CqISG0eu8yDXLwh10uZ+C5Q6zhqHaKGZ9tbXDjVXsbu9E0MMYwkeGpJWy9e3NHrNOhhEwVPkOosD6gJz0f7N644WO3FfLTodZBem48r9WkioZa2pzGXupiFUpgm7JjFE62t+Ctj6DoYBpfjEqLoxWzd4qIdiohOf6PBUsct2ZEdQIbE3wkEhnLOxIdYmQmYaMBsKnEh+QtZFmL+FzqA+0tLZnp8CQUUR+LZ2hfzjAt2cMGOywHW8+/qEzoWxLa7FYZHc8kBDmr7UybwjDbynqO1MKsT+R7NwdIQA6tExeYD92VQJzj/idELHF2NgTSMwLr61Q++M08Li1RLWWFLYFaD8/ymGmrjjN4cv9WWFB3W+4PJixLv1zsnH1Q6/a2z9COZ5I+Td/9HGW+Vaf6MmcZDXXS35rWnppO/8XhtficPt5rpcgi8pVglVA09i7uuiCimSShPeUFnkjGq44kUtAeQC14g9ltHz9IZRSK06xj+eJcGCY0NjIGwtYBJ+VCmQC9cS6GVOQWMA5ZoV/xuS2pEcC13y6LLPkFbpmIwC7ZkeM4C3n3Rvjc7wxPDaFh2GIwNoCvLSoXXhIDtMmMcXOoZj0ikjUuXuKBDUyLoQhP0q2aFKEZXQxG61JyYzH4Y4fYydK7R87dN/Fpg93DlDVSPVvS3FWpBTkVKnrn8TZZAG7ytgxcH6Mw+sAUtXmOFd8fncxSBmLIgFzTf2ox7fpLt4Vgggu2Rc5+t7mZ3o0PtAt5N1raANrZBnG7nVPfv/HnscA/Pznrjfb25/qI73L58IO7v5bhfhUyVrg9xnd9lNNv5UePq2YFuYgIi4LD7e9zZwGboAR+7a6nYEYJScdH6HuqjEnxbF64X6u5a4F5BuE/udwMiuqW0vB7+v25KP6HH6ib5CxW5ushcX2R+Qs31nfFaz5/r/Qm8bwVj3c4khbSb5vYuG7Pmft1DKtV+0o9HmDb5I8DVf8ClHh7+Ayg8fN4= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

List Workflow Library Triggers

+ + + + + +This lists the workflow triggers available to you + +## Request + +

Query Parameters

+ +List of workflow triggers + +
Schema
  • Array [
    • formFields object[]nullable
    + +One or more inputs that the trigger accepts + +
  • Array [
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-workflows.api.mdx b/docs/api/beta/list-workflows.api.mdx new file mode 100644 index 000000000..5c7a33cde --- /dev/null +++ b/docs/api/beta/list-workflows.api.mdx @@ -0,0 +1,107 @@ +--- +id: list-workflows +sidebar_label: List Workflows +hide_title: true +hide_table_of_contents: true +api: eJztW41v2zYW/1cI3YB+IHJsx3GaAMPmJu6WIW1yiXO9u6zAaIm2tcqUT5Sa+oL87/d7j5Qs2U7jdr27bfCALrZEPr7v93s0eeclM5XKLEr0aegdeXFksrdJ+n4UJ7fG2/EyOTbe0Y23ePZuxwuVCdJoRpMw5QxThIxjcVuMEZEW2USJTGmpswbIGBXkaZTNQerOuzYqPU50pj5mvTybEHkzOypmH6VKht67e6yTKjNLtFHg4M5rN5v0Z83ayWixNNYKiLTOaLCczeIoYOl2fzU0484zwURNJX3K5jMFGjJN5RzzokxNeSXIcj5iTt2IZPirCjIMmaWkrSyyHEVhhYrJ0kiPvWXlFHoTpycNMZhE0I0RUlxfn56IsdKkehWKHGKKAILTLNKX+iins5johu1mK9hXh364dzD0O3I08uWo1fG73U6rM9o7DPe7h949zYCKafpxklvhHWMRtDFWKYiOknQqM/tor73C6gAW0/l0qFLSaBZNlYEVwW6hXDGRRgyV0sIupsIaq21wMZJRnKfqv8wDrQKthTmpXJSS17hpghvWqFprpZKPECN8WmgtL/RWSB0yK+zTJSO3YMQtULdYu9lu+82W32oOWt2jZveo1W1097p7L1qdzsE/vYKvJK3wVXrYA97jZjyB+4TwbURSY8UdLamNHXJB8mRwLmgSiwHtU0CenvTfDE4H/6BwX4hWPoUQn+X9q/xTQNTVFhy0XjRlpzuSMlSq02x1R8OOarZeBO1mt9OmNbWcfpmIYWRmsZwLIlBf9nUUTKSKhftrvHv6b+ex2N+ME3ZnjGRnrjhPjYMrBf/qT+HTJGJyi6SwmuiIUqm6bCKR9W61qRFtCEGjmABEBrPTyBhM53x8evJG3EbI0qHK6I3GRCIjg4yH1HybclSMDwiyLCFKFC6gf060zSSaiUBqpAIBnekxRg3nyGEIForHrGCClpXi4nogklRc9AbHP4pU/StXJtvceTf0x3WKJ1KkeGtBqzQIlqqRSpUOkBc29GIilusInEOLhSlLv6h68CE8+MV+90Ww3z4MuvDgF0Egu6PDZtDaa+1t7sHLfrNmsbewZSSnAn+psJHP1ok8tsbJ4htXUFJPzQlkECRYLDITZVYdFvZX5LPkIFnVOW8nCbxPZlh1iBphCh9peMzhKNLREoMPJD9SwlTOiDmTqZmxFqznYHJoV4xWfcpkMs0+X9k8jRyZVm08EKpiADcmiZi1x4U5R7whCqZJqpiuM6kTihSdRkbVax0C7iJWEo+NssWnzGxhEuRTKJwBA5mgGPHT1fkbYSGOQNAKJYOJXbDI8DIM2QAyvqhoK0tzVZH0rpqVCBIFJUIEVDN457P1iV5paRo4TMI567RAOhnpCfU2TaY0GXNmCWr/9+WnBoT3COsF0SyCSKdh4xuM/KZRVjrEKPScW8UeeZnTvAZ+vIJkRDYPAmUMA80Yoy6VyWOM1Xkc7xSW6R0PTs/fsM3c8IpruCec+z2samPMqftk4bWEtLQcxjVUMUwS2EmvGL3PI8nuqD/8cSlfl6ia8qlOMk6pFlNw8kSM2cXIKa2LI4IkyzaSsamajL8T82k0HqsNwAXnSDvYeiE7vlkuVJSyo5TkvbEEayZ/97mJvP83pGx87/990L980zvDx6vjH/sn12f9k3pyL0Z+gmta437ZBROtCvju7Nj/AE8SAzertxi984iKFkNRNmI2C2INZjl1vvkGsdgfXAlFKywpC267op0vLjeFVasKikJ9VASJv9CB7xIuaWYUxaj2FFCPrcqJYyazCfLpDI2X4cRCbsFJNo6mET5OgJKssKbKlh0zguQi0TUev2lYbszNd0+/b5RMim+/FU+mUktMfvLsnecgV2Gvj2AaCeqrmkwVRBeqrFqLC/OKvTYr173CXlxGKO2SbtYsuNCLUTINJj5aCx9xH43m3ufW7x7lcUrjIrC9tJDDJM8eX/oyJ1hmGeDexjLAE1NOnGbJHleoJ2FOaejrGYSLlCW63iBBmugrK/qKWSrvNjDOBxlHoTi+hIMvfJtVYrV0kgRmFXEvjReK1E1M5ilKojfJspk52t0lVjI5bIzzNN+1jXih6KZ4Lp7v7uHfvnhOKl3ZOinr+apeAZfWVCI3bu27l1R6aY3lF66l8TrrdlCOYyq6op+mcFtfXKosTzWVn5FzCAbsguo6FfRIszYbX7DP8kAnhX4EUOA4CTcItFdoW/xxKiPiUDHLASYKUPwQhYTZGGBZkkXq5HF1HAdNNFripQwhr5Xv2AnDBVQG70HrdINcfW3jvpgCFLwI/9Vl1YGSw27zsN0ZdTtStl90Wgf7w8OR3NtrHu4f8j7OFO6GrFgFJ8UGVX3pH2j3KApEnASwyL+hEAAH6N7CPlq8uqf1aRswjQ37Eju2FNPxKygD7SCsXx5fiM6BiJH0c34ux0tK0P71FZ4QNiNsY7EnJLeEz+Hh0dr0VyCIk/6r3vUZIYPL/l+v+1f4RLRWgqun4a0huWXCu0kTxFm2EID2byxaRG8injuqzyGQdO2wGxjZb2YOGD0VDn9hhlt9zYwqaUHItxZKRbp+GjVUYweQD8+mMkMyHgLrhyKxm6fPe4Cks8w/c5p8LiZKhip91hC9EsJTbgNRzJ8TdgS2t8iRCIxyhDKYibIJ1QXK8sHS5sdClXVrLHLIWdUoFBzgfIOcG2Q5VR8SsxqFpbc4Fp19wLPVXJ27QUVprNI5Mi0aEYyM51BjmlJfj2wpIsARl47IXAaJRxfjyoxVzZmc7l5bZk6yhN8FMjcbxN1FjPTjs2jliw/KBZ/h/RLORmyNwkwuI7lemSe7UaW5isAHjFJxuI3dbexuY3fD2F1+eel+N3JvGfq0VqHPtZY59Jty8VyBPil7jwZUdYPsXos15A419Q4i/fR2gMB+rzSNB2AkAPsV8ZEt5SvM90p72OfDYuu1KP0LWxCDrEcrgf315Ij5XnBsQSKram91tVdJOozgoHoNRETWTMU8yYWEytJca+JEmh0RJsroJ5mYSORHyRssNgPSqmh87PbPFklukeS2Gm2r0Z+mGm2R5DZ2t7H7x4zdTyLJkiuOFoeTTD6dynRuPc29J2mlwABRnGBa/ILLplpGK0RMlBjLqyMHb9huDVujg0B1QtkJu3uHo3bQbcv9g9ZBa9hpH3jVWn+ziOMyyOoxVbG3tSOrGCDuA3BcruFcJkuSsL79B/WmakRpjXdvC9wMnUOl70rs2D5cc3QhScRrqecFQjI1DKkXOqKchrFTGpsWY/kMwRh5UdM5hAh8uYNBoEKHp+wvExS8JAXopnO/N8ogig2UwsnKVSIdxDk45EwQJ4SaEzhWRD++jQjzgQIj2DGy81dEp85EvwnJi0uS+Ix/i+l/DJSiQC+R+/66/d1T7X4KuLIGfmCj13Y7UsMB0BDYnFXizi0+3+LzbY3f1vg/R43f4vNt7G5j948Zu5+Bzx0aehifY8DG+BxjG01RYqlXfATrfw3TOVQcB+zeIgmCPOXt5gKDM66AKxFDY8U5RNIVC2+3ekXCgn3LRv04w529s3HfkLOoPIGnk1s6pbc7hErWZBt71I88hQaI3sWp6yYarM80Ipe1+Y2JW+26Y2yLI4GfpFwc0JwneerulezQ+S/nPvyYTlGid3hi3DFve4hlST7IdZ3G979dFkvoAVnWqe+Tq2G8AKdLIrpDI8XtGTqHM7Wrr9yhWRQPas5Wb1ac07C2eKlkSifn+PeKpz+9HTyrXkMxfJ8ion6ATm7DRTh99Yq9e5rEFSVN8vGEGe/Vfh2hcBH2cOPP+kopcVM9KXeJRMwqpUmKY59mvXtaWCdUH1RMJa9ROx66G4V6FxralbV5z7i8cR8QaXuhg26B/Kx9cRJR1uGD7TTGichtnbiZFXLJilxfysRfCmq+peYzNfNsiQur2pvAnrYJELNEQsaGtfXFi1t6foUeNU14QlSXeSBNOD7qv2kFhdW+mI8aPZ/o1fn4Wb/lo4P1acKmKmFQ+uJQnIpgkiRGfScEuQ6Fwc04RxR9MVt8XtHniPDbzQpLvl3Sj3wgQebvDIGhrTPZc3QMRBJgNB3akPyFLYuY/4VPzf1Sk5kf36Bg0sgwCcwX80wL+rSgb3OAcfzbekSOhdi2iZxOwrEDHC/sz5nAMVrJe+4q3rqszuR3eQ6VhgCs2uPzsyP75WiR4NwnwS9odDkGaZiAdPkrH10IdLSoKNWUVWwBLGtwld84QS1c0pvlt9yCovr4e5OXJO4tdkrOdTz/2ln6gUzy+8m7/6eMt800f8ZM46AtuRsv63qAqpO/dHhtdeeO79Uo/B9vOVYZRaNH4a6LUUyV0CyWGXk1R3UwiRT3/DMlM8J+O+RZyZQjEe05hT86OyY05psbKViW6NKimO6u0K50sbLkgLHAkuxK3921FlrLHpRviLdow3QAs1ALRucq8O7XxPViV7DMBRlWnBTGBuiaTnNNd6/Adj4VEi71iEeEkQlym7jQkWlV6CJh6FfOKqKYXI1EaHAzkk7N+Yi2k9GpVgz/yFqwe3E7WwbZ4nC9txDkks6HU/JYOWX9GG14mz9R8YyaQGRdADBVWeH16WCFIohpA7nQbCfpeNdNMrs0FkSoPbLus9doNZo+twt4PktMhra1QpyvoFevzC+d4i83zze6KO/KA+H63RntP9Giue0zbCd3491W7+JPwBA9vLujfQlqbe7pMfpxanpv3i26FvoGYnZ/glu/94r7Yt7BWLS+q3v81IOUXeUPfVKmfKCcuQ+01P39fwAhEXxl +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

List Workflows

+ + + + + +List all workflows in the tenant. + +## Request + +
+ +List of workflows + +
Schema
  • Array [
    • creator object
    + +Workflow creator's identity. + +
    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. + +
    oneOf
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-workgroup-members.api.mdx b/docs/api/beta/list-workgroup-members.api.mdx new file mode 100644 index 000000000..8f3692724 --- /dev/null +++ b/docs/api/beta/list-workgroup-members.api.mdx @@ -0,0 +1,83 @@ +--- +id: list-workgroup-members +sidebar_label: List Governance Group Members +hide_title: true +hide_table_of_contents: true +api: eJztW+tv2zgS/1cI7YdtDcuvOElj4HBIk7TIoq/L43qHbIClJdrmViK1pJTEF+R/v5khJUu2k6ZpsbfteT9sHYkcznt+Q5G3gc6E4bnU6jgORkEibf5Rm09To4vsrUjHwtigHeR8aoPRRfBaXwmjuIoEe40jbHDZDmJhIyMzpAEUzmbSsv0Px8yIvDDKMiTJ9ISljhrj1upI8lzE7FrmM8bZMtUOrJhxw1OR4/Kji9tAwR9A/LpkDZhtBxLXy3g+C5aZOD7EFfOZWEvbiD8KaQTIm5tCtAMbzUTKg9FtkM8zXMbmRqopjBQ3PM0SfDSI9vovei/47ov+Vm+vx3t9+DXsD/p7/T0RRTy4u2vfOo7+KISZw2TPs55MrMhXWHxPj5lUuSZGJ0WSgM5skeQMXnTYuS14ksyZzUQkJ7JUVyuRqcxbDKZlfCoVKBLmg2jTGdFxJGznV3UqBLv45xYZ4zTnKuYmZgc6SUSEPLAPlYovn83yPLOjbjcWVyJBl+hYLpNMA3udSKddGasuz2TXejphVNEJF6Z6zibasFQbAXLBz5Qcq6nyCU+sqGm2t0b/sKqYCgPzHBH3aGsAD1KpZFqkNC8WEw6ywu97lU/KWtH9O01K4znxm5cei+pL+Q3SZ1c8KQS9JhIMhmz3vhulbn+FVr0GHJFKxdv36zjShVrV8fGEtTC8Wgy0dy3BuTOdFYlzV8Fa/wrPdM6T8ABnt9BtM62sYDPBY2Gcr+NAVWDawHD2nu0Md62LJGZj4dMMRIecVLEB6mQtF3ctdi1Qc1MFCozBgGBCidkAlSdsDnEOGShHVhgJwiKu2IxfCXgMJiNV4XiZZjzK28z5ghFgwFSoGBZWOsdotAJXbRGRv5HkLeSJuHXeRFrA0cB2YUtuvguHuidRjrVOBFdBzVFo5r2+YrXJXUm5P+lW3okq5qEVyDqUi+Bu2cdOgVrlFoVFW6LLlOIzO1c5v2Fu0hh9RP3Juv4JBQa+Qs/lczK5e4Z+ZIssQ5XEPhNhykkSfY2vIecnsR2BT6Hy2iwyAtXQBtPFVBBarUaJolFh+XLVnHeX+MiFmUXFD3o9/Kep0zdYrqHwfGG9jjRkF0gDQI9nWSIjcqru7xaJ3q5amxvD0S9kLlJbe67Hv4MSV7NJDMRlPsc8UIEAzyLBBYMmyqWo0Vr1rCbNj0t0mCwXOTx7z3AuUhYKc+EFQIqjd2fHZ/9GxLPQefUUfFPGX7Pm8WFnCXDsAuDgw50Jh4Qohr3+zmQ8FL3+i2jQ2xkOcEUXVE9fM5Y2S/icIZ3m6m9lNOMiYf5fC/CG/msHw3VOc5BIIMmOjAEvDtlJLSc7TEK5lo11PEevlwoSooyf4jeVfzQtHoscovNAx4/QxyupRDg1XCKHgliOYCIDilcyxsij3OhIljiSxjV1BJro9NlLHoO8Tr4DLwyoKTc8+gS0jh/hFOdKwnxWTgH7VNlgzbJiV/DxTm9vMJzsDDkfvBj2d7fHexO+BcB0e28PV0+FtXxaD4Yq4JpLvxZKGBmxREdgkf+AQiDJgO6JAVr8oRht2oBoPEL/ZyCXG1uJ6fllubiBEsvZy4MPbLjLEq6mBT3n0yUlqPD8FMsKoGY+LisUSO4IvzdyKtVaRO/D+fDo1f75mzN4cnL0j/OjU/iFtFbamX0F3hqjW2oCITN9TRx7Aa455HCBeR/KOWt5qi0QiCtbHyjdX3ZuQZnMV0uY4VdfM6NOmk2MThuhRHFzk7NnsiM6bUAU8AyqZjRjYw7QgoEJCWbtR5HI8vCN12TL46vnHbYfxxKFBOBD8MTC/DlCEx7HrlS6tgRCWVDm10WO6EVGS7liocqmNSAIZE4j3tSNgsEBnH/eT/ajHDog8olGFFbe4ln09gGeneaa3J3VlEYqRUwAZTqi5irSBqAcZCaQTQKI8OmISjMkHlWOqzIWpsBSLEp3bx0zh7mmdxEv7CPi7kMC6Sck0aoXV8IHn6XmjrIRWaM0k89IvmGkyX5UZa4y8B142MTuJnY3sfvI2F1+eeKhsn9L0Ke/Cn3OFS9Av4aK5wr0MeQ9SrNyEMEbb8g2A4V4iPTLxzMI7E9C4XhxkyFu/4b4yJXyFeb3K3v4HqlsocrSv7AFMkh6dBJMIBOJeER8LzgOFihxa3W1V9qMJTioWgMRIWsaNtcF46AyUyhFjblts1gLq37OfUsOEWGty4C4qopD15FtkOQGSW6q0aYa/TDVaIMkN7G7id3vM3YfRJIVVxQtHifZIk25mTtP8+9RWs5gwOLbSBVyZKpltILEWIWxgiZyCMaD/rg/2Y3EMObDeGdrbzKIdgZ8e7e/2x8PB7tBvdZfLOK4CrJmTNXs7exIKgYQdwU4rlDgXDbXOm5u/xW4Wz/BtIapp8LNoHNQ6WWFHQd7q9jxTGv2lqt5iZBsA0OqhY4wp8HYFMeaciwM4GwKeVHhNx0JfKEryVQAFfy24D7yYfCiFEDXzMP9SQ6i+M9R3smqVaSKkgI4pEyQaETNGhxL4redCWI+oEAIdgrZ+RuiU2+ir0Ly7AQlfkOfNY9uIiEw0Cvkvr1uf/cYmDeYI06dge/Z6HXdDlfgANAQuJxV4c4NPt/g802N39T4H6PGb/D5JnY3sft9xu4X4HOPhu7H5zDg0fgcxnZ6rMJSr+jAzJ8N0ylUPAfk3kxHUWFou7nE4KAEK+ChzOe0yDng+gPnyvsA2jEyZaxG1UGMEWSzOLjEAyapABdEQaZ05pFOZ46CbjXUdm9rhzjvuml1xtT1Dk6qwiQwqzyCcwvGBiPfdXgmO+XhBaWv6RzOGDS8JnnhKQMXqDiATvy4BTpkHiMxAly6JOLOWP4MU1Ad9XmQMh6bQC+Y6wISJJFp47kR7430GFjMoBX52fpDFnd0NGpJPpDr3CR3Xy+LI3SPLOvU9+BqMJ4Bp0siogiXCwc5RdzuVl9xk0Utwl5vsLLYexw2YC8FN9BUuM8fz375ePacTRGtUrZwx7qExPYC4u0DuAhlw/3yUwBOogK1OAO73/jYgtHHJgkIzPxxu/I00TsoEyeQ10mlOElQKsFZjz8Axhvz7jlc96sK2aE07nyYpTFeRHcA8SIr5eI1uZ7KxE8ltdBRC4kaHj5rcOFUexG5wzsRpAAkwRNL2nry4o5eWKOHPRg8QarLPKAmPB/NT2RRabUn89GgFyK9Jh+/qo8zCaW4OY25DMbsjE6YHrNoprUVf2cMXQfD4GJaQBQ9ma1rXDSkiAgHvRpLoVsylCEAS+LvDQSGcs7Ex1jYCddogHwqdiH5G1kWYv43OvT6W0NmenwB9RdHxjr6glONSzzjgiEuGLocYD3/rryhY+G5TZCB8oBzgIOF/SkTeEZrec/RWpvViXyX5mBpiIBVomKzkftjtEhw/hejFzi6GgNpGHF59dEQjzV6WljjGsoqdxSWNbjKb6KhtC7pzfFb7Whhuf2ryYsS7y82Xt6rZP6ts/Q9meSvk3f/Rxlvk2l+xEzjkTK6Gy3rW4q6k7/0eG11I9DSNQj4P7ylWCVQDi3P4uZDnVCW8By9mqI6mklBWwiZ4DlivzZ6lk4pEqHbx/CHRpEITenQuAGWOTR9MgF6tMldrswpYBywRLvi37agPgbXimbQkooO+whdnYrALNjR4TENePe79q3dKVjmAxqWHZbGBtCVpoXCQ8bAdpEyDi71GY+IpY0Kl7igwVOi1IUm6FfNKqMYXQ1F6FBvY1L7foK709D41gz/mbXA7tZvTYPq0Yr+nsJCkBORkGfiuCZs/xxt8LZwJpIMe0rIugDARG2Ft8dnKxSBmLIgF/Tu2ky7fpLt4lgggu2Rc5+tTr/TC6ldgOeZtjl0wTXidIh/+Zg+W9znazjj7WJr/lvd3vMFBTuBboYbYMhm4ToT1xJeLO7yIUOj5s2+siuEPmMGwuHw21vcMsE26Q4fu3sl2CuCujEGFpdW7hXu/+vK3VobfBK4iVFdSfT7FEGATenjFfmD3J97QEPlvcEnKmhz+e37u/z2gDeUNxyf6A2ba2oPandxJ3Ch38vFxtYXJvlnJ/7W23P28C3wtRyVn3LUvM5OyWm9SN1dwnAXr8ShG+E28mtzVz51NzZJXx8hCOD3tGH+x+gCt2X/C50NX84= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 Group Members' (list-workgroup-members)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

List Governance Group Members

+ + + + + +This API returns list of members associated with a Governance Group. + +## Request + +

Path Parameters

Query Parameters

+ +List all members associated with a Governance Group. + +
Schema
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/list-workgroups.api.mdx b/docs/api/beta/list-workgroups.api.mdx new file mode 100644 index 000000000..0840b63c0 --- /dev/null +++ b/docs/api/beta/list-workgroups.api.mdx @@ -0,0 +1,87 @@ +--- +id: list-workgroups +sidebar_label: List Governance Groups +hide_title: true +hide_table_of_contents: true +api: eJztW/9v2zYW/1cI7YethuXYjuN8AQ6HNEmHDN3aa5zrHdIAoyXK5iqRmijF8QX53++9R0qWLTt1s2K39jxgWyyRj+87P496fPB0KjKeS60uQ+/Ei6XJ3+vs4yTTRWq8tpfzifFObrwf9Z3IFFeBYD/ad7dtLxQmyGSKs2HuaCoNO317yTKRF5kyDIkxHbHm3LaX8ownIhcZUn/wJBL4vRDZHN4peAM/dRQZkXury7yhx0yqXLN8KlhUxDEsaYo4Z/Ciw65NweN4zkwqAhlJEbKZzKesFctE5i0G01I+kYrnAuYDP5Mp0bEkTOeDuhKC3fxzn2S5yrkKeRayMx3HIkAe2NuK99sfpnmempO9vVDciRh12TFcxqkG9jqBTvZkqPZ4KveMo+MHFR1/oYMXLNIZS3QmQC74MyGLdED2TPxeyEyAbSIeG9H2xD1P0hj00217JpiKhHsnD14+T1FlsKqYiAzmWSL20X4fHiRSyaRIaF4oIg6ywt+Pj+31yidlNXT/iyal8Zz4zUuDo/oSfo/02R2PC0GviQSDIQfdr0apB39Aq04Dlkil4oPNOg50oZo6voxYK88K0WKgvZkE5051WsTWXQVr/csf6ZzH/hnObqHbploZwaaChyKzvo4DVZGM4TfEn/Nsa7iZLuKQjYWLUogOGVWxAepkLRt3LTYTqLmJAgWGYEAwocQQRuUJk0s1YRyCCVhhJAgLuGJTfifgMZiMVIXjZZLyIG8z6wuZAAMmQoWwsNI5RqMRuGqLiPyNJG8hT8St9SbSAo4GtgtTcvNVOBTKs8alxlrHgiuv5ig0c6OvRDKmZLmGlskzMIb3uOpIr2hKZf3CoMnQM0opmZmrnN8zO22MrqD+ZJV+Z+UCznzH5wu07avyKbqMKdJUZzmwZ5MOZpc41jN8Dek9Dg35rd3IdGZOkEKrJcNW64S1xO/geqrNzKxln6NCqzdmhm9bXs1ipHF4wT54I/DzD17TvpuMZJDNJ41USyEYB9w3ApUBwjXtdwXU/uLWQ4FXbXdln21nOTADGaTNgkygGtoQXyHt2mAY+LemklbTTG2/HL3GSLf4yCZHg5bod7v4v2Ulv34CowQaEj9kaJjE0zSWAcX73m8GZz40bcyzjKM3yFwkpvZcj38D1SHoyVDVubT86JmCTWXNsBW8g8O+N6AN4EXm806DkJ3fdLX1dM5HbxiORDpC4X51412eX/wyuhz9G0HdQsPVU3BNGW6/QskpuzzvLJmsHxz3jrp8MIw47FVi0O0No/FAdHtHQb873D/GhWwobbtUKE0a8znDWctrXVnf8yCjesAMPaNZ57neVqCaUxAg3iDQ0cHwKDjoHwdDEOgoCPgwOu4Gvf3ePnklD9+oeG63gq0FbCzdlPD8JTsNAmFMw3kbueSzV6u9Xll08QLDBmN63eqJQPBBEOWTQGo4qK/QGw56g+Oj4eF+t9tdVV8Dj1YYxy5oMAciT5MVgTrIFMSzsjnsCzC2iZHFIk8w03CLmpNW5Rc5Kv7T9gbrUtdZLCHO2EWWQXL12bsanrP1DOE0NtbhHJOxVACmZNh5RmLbkMBCkcOmcabDLfz5lVTCn2RcIoeCWA5gIgOKdzLEDYFwlSVZehaNW/Y/0ESnx17yEOS18p05YVCFGQ8+Aq3LLWL7WkmYz8opkLSqTWrNsuJQ8PGwe9wfRMMB5/2jQe/wYHwc8f397vHB8bH1eWP4pJ6Sqx1hJdoEpCEZsFgHYJH/gELAG0D3xAAtvv0mQjS20P8I5LJjKzEdvywX9wDPOXt59pYNDlnM1aSg53yyogTlX18h2oGKm49LdAuSW8JvMjmRa5NNuc2cX7w6vX49gifvLv5xfXEFfyGtxknCqQJvDdEtNcXUVM+IYyfAjAO0EAhHoBRgLUe1BQJxZeoDpf1l5gaUyRzShhlu9TUz6qRZlOlkKZQobu5z9oPsiE4bqhF4BtkimLIxh7KEaRvvLUzLae6/dppsudrsRYedhqFEIaFootLGwPw5ljU8DC2Cs0caEMqCSjld5Fj5yGA1+VeqXLbGIo+8rhsFgwM4/7SfnAZ5AcyRmPUorLzFsejsAzxbzS1zN6opjVSKUBWSYkAHM4HOoAyEzASyScC2Lh0RYoTEo8pxVcaqp0dKdz9bZmyGhHzGC7NF3L2NIf34JFr14k644DN0METZiKxRmsllJHfYRJPdqMpcZeBbTLuL3V3s7mJ3y9hdffnOFWwl9kHo02tCn2vFC9BvRptnA/pk5D1Ks3IQwRtnyDYDhTiI9NP7EQT2R6FwvLhPsXr8gvjIbuUN5k8re7jSvazsy61/YQtkkPRoJYggE4nwhPhecGxBIqlqv7naK52NJTioWgMRIWtmbK4LxkFlWaEUHeoZqLq1MOr73B3n2SKDMiCuqkLfHhTskOQOSe52o91u9M3sRjskuYvdXex+nbH7JJKsuKJocTjJFEnCs7n1NPcepeUMBiy+q1YhR6ZaRStIjFUYy1tGDt643xv3osNADEI+CIf7x1E/GPb5wWHvsDce9A+9+l5/s4jjKsiWY6pmb2tHUjGAuDvAcYUC5zK51uHy8V+BH5EiTGuYeircDDoHld5W2LF/3MSOI63Zz1zNS4RkljCkWugIcxqMTXBsVo6FAZxNIC8q/B4sgS90JZkIoIKfvGyDAAYvSgF0s7l/GuEnS/cp2zlZtYpUQVwAh5QJYo2oWYNjSfwuHCHmAwqEYCeQnb8gOnUm+kNInr1DiV9TS8TFfSAEBnqF3A/Wne9eAvMZ5ogra+ANB7222uEKHAAKApuzKty5w+c7fL7b43d7/Lexx+/w+S52d7H7dcbuZ+Bzh4Y243MYsDU+h7GdLquw1CtqtvuzYTqFiuOA3JvpICgyOm4uMTgowQh4KPM5LXJtsIGCXPkUQDtGpgzVyaxsDzjBFgLvFtucEgEuiIJMqF865Tjc25vVG7ltlWD5L7IY3pc9YA9gVjDnY4enslP27ig9o0awMehyTZrCfgIbkjiAWs7sAh0yRCbR121iJOLWLK7T0at6zZ6kTH14YO+5LiAVEpk2di45v6PHwGIKRcf3xvXHPFID5Yp8INd1Fj/+cVksoQ2yrFPfk6vBeAacroiIItwuXOEKEbpdveEQi10Hq7p+s0kKh/XZS8EzKB/sh44ffno/esEmiEspL9i+QiGxkIDIegsuQnnvtDz0x0m0FS065U+XPqtgnLEoBoGZa8q9dEr4BTaEd5DBSaU4SVDSwFnbdyDypXkbWnA/KJ+dy6zsu8ExTkTbpnyTlnLxmlzPZeK7kppvqflEDbsfl7iwqr0JbJtOAMGOJHhsSFvPXtzS82v0sNqCJ0h1lQfUhONj+WNYUFrt2Xws0fOR3jIfH9T7qYRNd3kas7mKmSn1oV+yYKq1EX9nDF0Hw+BmUkAUPZutGS7qU0T4/W6NJd8u6UsfICTx9xoCQ1ln4mPcwgnBaAB3KrQh+StZFmL+V2ox/nVJZnp8Azstjgx18BlttSs844I+LujbHGAc/3YjQ8fCzjSQgfKAdYCzhf0pEzhGa3nP0lqb1Yn8Hs3BrSEAVomKSU/sj5NFgnN/MXqBo6sxkIYRgVefB+E3c7RwN1tSVnl2sKrBJr+xhk10RW+W3+rsCjfWv5q8KPHp4ogFe/u+dJbekEn+Onn3f5TxdpnmW8w0DhOju9GyrnioO/lLh9eaR36GLkvBf+EtxSrBbyhuFvej6oTSmOfo1RTVwVQKOixIBc8R+7XRs3RCkQh1PYY/lIREaEK3FjJgmUN5J2Psz8fj7HJlTgFjgSXaFX+bgioWXCuYQvEpOuw91G8qALNg7YYNGfDuN+2KuCuwzFs0LDsvjQ2gK0kKhT32wHaRMA4u9QmPCKUJCpu4XI+yFUET9KtmlVGMroYidKiKyRLzJsJzaChxa4b/xFpg9/IeBagereguyiwEeSdi8kwctwzbP0UbvM2fipjazSHrAgATtRV+vhw1KAIxZUAuqNJ1Ntlzk8wejgUiWB5Z99nv9Dpdn8oFeJ5qk0O9WyNOl0bW3RhZabqvTt8/726s2y8Q6O+leJKFXBS28LC13Y1Xq+2gWpgCi/j04QGPOLDYecTH9noSVnygNPTkxQW1jZz+f12vXavqjwIPHarrx+5cwfOwtNxekd/IXdknNFTeEX6mgnYXXb++i65PeEN5m/mZ3rC7rfo5t1WfsMPipvAzLbG7d7rm3ukTCl/c+l0o/HZxcgj77y2MtVmLNmM7zX5+qM1qfKBfOtr98QIBDd9QUro/cKnHx/8CxwjS/Q== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

List Governance Groups

+ + + + + +This API returns list of Governance Groups + +## Request + +

Query Parameters

+ +List of Governance Groups + +
Schema
  • Array [
    • owner object
    + +Owner's identity. + +
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/managed-clients.tag.mdx b/docs/api/beta/managed-clients.tag.mdx new file mode 100644 index 000000000..3f2f14d9e --- /dev/null +++ b/docs/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/docs/api/beta/managed-clusters.tag.mdx b/docs/api/beta/managed-clusters.tag.mdx new file mode 100644 index 000000000..caa92bd5f --- /dev/null +++ b/docs/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/docs/api/beta/mfa-configuration.tag.mdx b/docs/api/beta/mfa-configuration.tag.mdx new file mode 100644 index 000000000..7e2e38e1c --- /dev/null +++ b/docs/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/docs/api/beta/mfa-controller.tag.mdx b/docs/api/beta/mfa-controller.tag.mdx new file mode 100644 index 000000000..cad325952 --- /dev/null +++ b/docs/api/beta/mfa-controller.tag.mdx @@ -0,0 +1,20 @@ +--- +id: mfa-controller +title: "MFA Controller" +description: "MFA Controller" +custom_edit_url: null +--- + + + +This API used for multifactor authentication functionality belong to gov-multi-auth service. This controller allow you to verify authentication by specified method + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/docs/api/beta/move.api.mdx b/docs/api/beta/move.api.mdx new file mode 100644 index 000000000..6b5422d1d --- /dev/null +++ b/docs/api/beta/move.api.mdx @@ -0,0 +1,103 @@ +--- +id: move +sidebar_label: Reassign Certifications +hide_title: true +hide_table_of_contents: true +api: eJztXG1v2zgS/iuE7sO2Rez4LXHsLwfXcXteJE3Oca64S4MuLdE2t7KkE6Uk3iD//Z4hKVmynZd2i73dwggQWBQ5nBnOyzOUqHtHCTeNZbJ0ulf3zqUScT8MEnGX9NJkjjZHekHXFXEip9LliQyD7i26C+f64XrPCSMR68ah53SdRXgjnD0n4TNFI/vFUazPFxGXs0A5GOcJ5cYyohsYN55LxXrnQxYLrhT1YclcMBUJF+OFx0rzKzaNwwULA8GkJ4IEvLMkZDwIMSiush6uvoiA3cpkzs5G7z/3jk+HH1gYs/5gNLZXHNKFJDbD1LH4bypjzAMyLvd9zG4YqjrEahQLzCwgYRKnYs+JeMwXIhGx0jqTJELEoa09J8ANXEkPv5U7FwvudO+dZBlRq0piGcychz0nmzCjuK4OUZYYTBndseExCIs7XPpEUUybR9NOq9lqi07r4LAxOZhMjlqNFj84bHba3pFDa0STCZW8Db0lMbM+t0vLHSR0i0eRb6fc/1URL/ebUoSTX4WbgI0optVPpFB0t8Tw0NNtZbFOpEpYOF0TbXisSO3ZypP5mHl4HPMlLmFrC7VViwsZDM3NOi74nb1oHNQKOrpyOJR00GkdttrtTqtdb9TrKyXxiVvHHM90aTzfpQl/IFUbKcbh8wqDjWwItc0SchsfHpOibufSnWv3iMWNFLdkvxOBwcxMLbzqV5pIpvGXMEM9aA1pfvADiW7An5kySBek7uHx4MN4OP43ufmKjbz14cHqyZjX01P2w8UC0pPc4i7yuYRXz5d69rIV3XKVm5DwSgpYNbMpYoAKF4LZ+YkVqFZ363kwp5FW6SizxQfLrIoQdcyqNWqNTcsez0U+O0u4+gIOecLmnJYGkUilk4VMEqOn7+RvLzUfrJJdr7LGiM2ypTTcTv2odnTYrneEcGvtWr1d523RbB4c8OZhjX+7pWyZmZ2GsWA33EdoYgu+hKIY92BKDGtMY6ZpksaiaFijQe/iYvj+A5p0DP9caOifnZ6fDMaDzxTih++G/d54eEY33g0/DC/+sdG86t87Pe9Zov3x8F+9clv283Mfk40HxZbjAREoW/kaX6QwHs9EMv5qtVHUM1aU+7fJtdAQdDhZmhylje12Hiq90GhQSRivlGhmH8LypfBLXrqhkEzmkjx5ay7J8KvNTkvytAQvt8OjZsslZlTCk3RLVtjGiumbsZPPZxXxz8vB5YCyKhbufHT2fjS4uMDVxWW/b34NRqOzkY7uIo7DuDjpYynqEZf1Q4CLF9qB6asjFnG9EErxGbgHMNtjnL3tn7NWm/k8mKW6nc/Wwn5QuSTug9T3+YSaKNtDCEP4LJYzuTUAZ3o5HrzrXZ6M0TIaQEcX+EW0NrBbL4CxeeTbYBU6noe3mmMrAAVmJXyoA9GPvbFU30AgblGe7Sgt5lsqshdPTHnqJxhhZ98yokjaQEKTFTXaYa5BseyVrIrqHgwQbQueIHdOuDImSN3f9FxXREnlxGryDZsL7on4NXCk50kSkvvPxykNNsM0YQCh0hXltVipsrwaq+RzUlwU8jVw/ryd9NwkBXNaTGvd2kRza7Es2vUBz0ZzZe7GBaVplS6DhLuQAkB4CTXGQL8Jm0A2mShms5cONchTQdZPBtCRRIgp5tQBcXNqmDlOQufxW4QNN+VjvoWMxvOyrHojTFoVgRumYIcC3mRZ8G7M4yIfa8j+Emfz0BX1A/C/BDggOGFBVh5hoRdLkZQHr4QpYTANrNCgcgCrNWqVWqfSaI3rR916rdtqVw87zf+UdFMqjsaYhLjOaZj8/nxKztHyRkYsJh6nkNFWYfz5QLuKs6swmQXBq+uCkp8SmYRu1WqbqKnvS7IkbQmswkYCjkQoTU5LjjxB3ULmllvYd4NQnki49Puh94KY/E4GojKLgUDBofEyFwMtAqbktiBAY0iWvLHsbdBEtc7ecg/yGvn6VhiyjZi7X0DrJUn2MpAYz7IhKBPyZLFlWtEWfHJY6zRa08MW542jVr19MOlMebNZ6xx0OrqcMt64LcGVp34vAhFL10QT+RsUYvC0ZkBPvsuJu5y4y4kvy4mUrHiqXuB351QAV7Ro+Y2brJjVuyi2HqfVyJbJRiTc1PmRBmdVe6aLzPFNlbDz3Z3v7nz3hb67fnNk94rsXQ196pvQ5zKw+8+UPDegT6ytJwizTerfzL6JWcg92si2EOnnj2O7143+4i6ibd3viI9MKt9gvpevh2mfEPzIF6u0FsSg1qORYIpIJLyu5nvFsVaUUVVzc7Z3YTyRMNBgC0RE1IzZMkwZh8riNAjMNuge80Khgp9srcDhEUqZCEizBl4lCmWQ7JDkDknustEuG/042WiHJHe+u/Pdv6bvPokkc660t1icpNLFgsdLY2n2PknLGTqw7Kkly11OL9U6WiFiLMdYThk5OJNGfVKftl3R8njLO2x2pg33sMEP2vV2fdJqtJ1irr9a+XHuZGWfKqy3WUfzfEbEN8BxaQDjUkkYeuXtP6g3FlMKa/otjww3Q+dQ6fUKO7Y2seOHMIFsIAzsGD+yvXg5OiH6IjbkSW9hGruCYLZRndl2JkhJNgxNm73qHXTcQcdd+tmlnx8j/eyg4853d7771/Tdr4KOreegY+sroGOLEcSaEsT6f0JHD7iDoNkUiwIZ3BTqDQg2RhAFv+zuo3V78wQ8B3olFNnobHm7LwzZKQ+WGVhSpZ3IYKUuCm/ou6C+cdYXHTibIUQGDFFLAt2SVdF7BsCk9N6BLxdS+zEJBLrxstKbJpDK+Exmb/ksMnD9FBzqoOCHtPcawsYkzElMCf6Bgt4HnSFQf8c9Trtav2s/mI1I4hOSmA3uXCHI5/P934NtbwkM6QUPChcXZq0feV3A7JnzAGWEuItM+Moh6A6q76D6Lt3v0v2Pke53UH3nuzvf/Wv67ldAdYuGHofq6PBiqI6+1RrLsdQ7Mq4/HLFrV7EcaPNmoauxurfC4BpXwJSIoSjUG636aF3X2c8Owan9e+k97BdOjJkywHCVxj46z5MkUt39/XssFhbpocojWc1OUgXhbdUNF/sTaGhL8KF3TY2jUQd9LtFMUNXqjSVZsAl3mrhRthaIbBVK168XPEmZzgnSKi5RgjBDZo/Oflhr0s1gMUIp8ZPSvavaejbkg1yXsf/w+2UxhB6RZZv6npwN/Rk4XRORRLjey0+cXhDuNrNvnDtd5RLa8W9sTHZG3RrsreAxigLzEsyrnz+OX7MZoU3t7akioCsklQfwl3OYiI5mveyFEBqkE0wcpjNzqK5XeuWGvIdNfQjMPgUXQrCroVXCB4T5EeKyVikNEjoU0KjrV9nqeOJG+JQBqytNkuFJL9iHhvZ5adxrne10WSAD84o5Wqufggo7lhSEzNlX9LEi6iqPXUWZXLwg17cy8beMWsVQq2hq6vUaF0a1V655hduFCxMJ7iutrW+e3NCrFOhRDYUWorrOA2nC8lF+UcrNVu2b+SjRqxC9Mh+fgo/6hEB5GDORiylkQt9jQ+bOw1CJvzNGpkNucDVL4UXfzJY+llDRHlFp1AosVcyUFVkBMNT8ncAxAmNMfEKJWeOS0GyRaJf8Ra8sfP4XffThl5LMuvkK+ZN6eqGrvplnmrBCE1ZMDFCWf5OeyLDg2ySDOUWsDaC/Wn8dCSyjhbhnaG2N6pr8vh5DqcEFq5qKirrmorsKcPYX0zeod94HYZhwdf7qGJ0Kt7QoR5WUle0IrGtwk18/RGpc05vhN3+uSenyzyYvSdxbbZycBf7ye0fpRyLJnyfu/p8i3i7S/IiRxiJd2oAcrb7OMFid/tr8msIf9x2D9c8Y6JNoz35GID+Jtjrpvzrn/+Qh/D2H3E6r35ZGRWd/a3Hr5oYm7bjPBf7jro5ZurhA6Wa+/EForkgo8nlC3q2jmzuXQm+FRIInhIH3yMPChY5IURxSGETBqwnN9Ck3MA1szifSBz29WZ/NzHXgMACb7JuuVWpfHQnhmiitRZV9FObAYkyVKb20jHu/hrZEvYCFnpOBs+PM6Bl9/CAN6MsPYDtdMDr7+IxneFK5qQngKFQDkelCfxmF5aOyaEYuRyJUdY0WL9TZlHbZUcAXHOCZuWD/ym6xQ/W0ivYbKCtBRsI3H25Bv3L58hxteF1lLvyIjATZB0BUFGY4HY43KIJYYJ/rhPFs3w5S+9QXRKhMNObTrNartYoum9BOpSaq+QLx7CMQrHRQU62b4f3q4cKf+zM21jupwtrXX9IgsVNT8ZkK+8rJK2z07+pv2ORFNqLCnMpx9Lq/px0kqjofqBnhi7Yn6DxoVlDqQhxrSL8RPKaIrusfuSnq7dXIMv5aPwN76tM3W6XINkGD5Wr/w8HPL4K2TSDHA53eN/tamjVzwz5IqegzsquBG0+IqOo2I8xe2ZN9rwv7F+dntGvoTOyHdxZmKybmt6RY/O86n/Dn0FeUjG2hk26/d7KNTfQxdDPQuQ1z2R9YAnT7H2jRdYg= +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Reassign Certifications

+ + + +:::caution deprecated + +This endpoint has been deprecated and may be replaced or removed in future versions of the API. + +::: + +This API reassigns the specified certifications from one identity to another. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + +## Request + +

Path Parameters

Body

required
    = 1`, `<= 250`"} schema={{"description":"List of certification IDs to reassign","type":"array","items":{"type":"string"},"minItems":1,"maxItems":250,"example":["af3859464779471211bb8424a563abc1","af3859464779471211bb8424a563abc2","af3859464779471211bb8424a563abc3"]}}>
    reassignTo object
+ +The reassign task that has been submitted. + +
Schema
    errors object[]
    + +A list of errors that have been encountered by the task. + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/non-employee-lifecycle-management.tag.mdx b/docs/api/beta/non-employee-lifecycle-management.tag.mdx new file mode 100644 index 000000000..73f9ce4de --- /dev/null +++ b/docs/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/docs/api/beta/notifications.tag.mdx b/docs/api/beta/notifications.tag.mdx new file mode 100644 index 000000000..ac2c40aac --- /dev/null +++ b/docs/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/docs/api/beta/o-auth-clients.tag.mdx b/docs/api/beta/o-auth-clients.tag.mdx new file mode 100644 index 000000000..c97b2f1aa --- /dev/null +++ b/docs/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/docs/api/beta/org-config.tag.mdx b/docs/api/beta/org-config.tag.mdx new file mode 100644 index 000000000..85bc228af --- /dev/null +++ b/docs/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/docs/api/beta/password-configuration.tag.mdx b/docs/api/beta/password-configuration.tag.mdx new file mode 100644 index 000000000..519fb6269 --- /dev/null +++ b/docs/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/docs/api/beta/password-dictionary.tag.mdx b/docs/api/beta/password-dictionary.tag.mdx new file mode 100644 index 000000000..cf79ae7a4 --- /dev/null +++ b/docs/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/docs/api/beta/password-management.tag.mdx b/docs/api/beta/password-management.tag.mdx new file mode 100644 index 000000000..07f739c1d --- /dev/null +++ b/docs/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/docs/api/beta/password-sync-groups.tag.mdx b/docs/api/beta/password-sync-groups.tag.mdx new file mode 100644 index 000000000..7225d1112 --- /dev/null +++ b/docs/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/docs/api/beta/patch-access-profile.api.mdx b/docs/api/beta/patch-access-profile.api.mdx new file mode 100644 index 000000000..98c06b58e --- /dev/null +++ b/docs/api/beta/patch-access-profile.api.mdx @@ -0,0 +1,146 @@ +--- +id: patch-access-profile +sidebar_label: Patch a specified Access Profile +hide_title: true +hide_table_of_contents: true +api: eJztPWlz20ayf2UK70NiPoLipYOqyr5HS7KjlC1qKWldu7IrGQIDchIQ4OKQzHXpv7/ungMHQUk+XnaTYrnKIoGZnr67p+fgJydeiYRnMo7OfefYWfHMW4w9T6TpZRIHMhRO28n4PHWObx31nOkXqfOh7fgi9RK5wv7Q+3ohUza+PGf5yueZSBmPmPgo00xGc1bt3WHXC8GCOAzje3wbSBH60CERjHDgs1Acv49arYgvRavVZq1WaSz1QETYyldf4vtIJOpjIv6ZizTDl+oBp6Gn6vFJHAVyblrexb+JhhepmC9FlKVmoExmoSg9WSXxnUwBE8D9JJGZSCRvtd5HY5YBwIjdy2yBnGizyfT1z+PTt+cXbXY1uZmenJlvcWIeXN28pGeM59kiBmhrBnxEKmQifIDIPB6GLNPc7bDziHHfl8iJNuMbYJZ8zeIoXLM8FbYXgiHO1gSRsvuFhKfIeZ6msSdBcr4i4CrOE2gLMMRaNQCWIiDuL2UEchVJ5330F0ayXPKPcpkvWZqvVnGCMEIRzQFKAJQCBFaSnxI3UtnvdrsMxJ1wD6ClHfYmjuYiKTcGDCWQPwPNSEQqkjsAjTCtZinxwltFUJst4ntxJxLgTbRmkbivtwBC2b0AmDylJkZdgTILtBGBUC5lpkRSR/x9hJz4e5yDsCLFfpARSjkRq5B7YkOPgCk8UwNCe2JRSgxXL/B7FW/kF88y7i0IhY4dTckZRwgRWG0YEfmrWEaZkqlqB+AQa3gLqp+sQTMSsDN4hKTNRQZaRaDigPE7LkMSfBmuwbiK4XepJkGzg12ixiE7se0dD3OBIBUOFTMtNIJYVygRStrL0yxeAr5Mm3xBCkpX2y87AcRAI9kEXiT3MhVtZJdYrkigQNgy9mWwViahxgOFykOgRoJFsSFIVCRJnHTA6VmOoOv75KAbAg8nfXglI+UpF07dAZ6fGvKqRmaND3oYu3aOsyQXbScFcS65c/zJydYrHCPNEsAXWoqPfLkK8VHfG/WOukf88Kg36I66vNuDT8NevzfqjYTncefh4YOCDHx4GftrBOfFwI4ow498tQqlR25+79c0jlxC5r/xI77eQIEnCV8jpcC9tPQ8nv0qvGyD7DH76WpyQbJmExNP0Lh8EcgIxDVbs9vpqxN2MOr2mUutlWp8+H6RZav0eG8vi+Mw7UiRBZ04me8tsmW4lwQe9nhR4dothCySD/AfiAbNgxEzKQhPeNXAyHqUAiW0WIJk0LOIBBRtKVC8IsqXOAyYLw28jO8EfSAzhk/6gRevkEfgODJEpJCWafmgsXwSozFTLzRj0FgF+Q30d1Fm7CfjCZomwiQnDMFVWaMmggcBSEexOysTWdGlvfLYgCJZJfEuEpOAlH27Il6AuZX7A/noEorGD23bHakAV17uP+h2ix7mfamL1S/Txj6wIECZMxhqlmdK4towVwsZyhXYQQma0WIDTH1/aEhbjG9SfAR36tuoZZnYLiIyvnuP+vHeASn48FmLHL7b9umjjAM8LV4/gRmSNVjbode6M1E5hlByVnK/+KymQxhsIoEBZxknNWcNdCEtEAmMf0Lv7ljh3yrL0SqvlNbZK4OotJV+4ZP2Dw/7+15vOACfdNjno8FsBn+HfQSk5XB2cX1+/ebsLfyFh1pg41N2A8GcvU7iHOT2Af61nfMIHmVlSpsJRdUv2jAdLWdiLiPMyAyR5TafS/Be1ynZxv8DxUTwVOcGj8vWtMIssCJXCoOcgqAJ11uFRvQWTuzfJ+QpedTHhazboBADmVRzGgzW21XY+ustQgUU0EnUwjA9SFdgtcreILtrQgpb+GmRfdSiPEQ8lUr6HYoPW+NvY9DdFlwrYzj1iIdiek7E25aaNOcZvVHX7x4IEHdvNBocBZ7f7x6O+hQGuT+BFM3yTYn6KRQuoNUzEDiDv/FaCBe4yGc8FS6O597jFAuDVQXo5phRHlKqanKrWnYWYYzXyckszrOnsDmB6SmIBNvXLAs9KmK2R5gpZ6NRZwZ1xNeDRpl4hohOuQZTU6l70CkDpO0o/KE5KpmbyWVNfN1+z+0O3G7vut8/HvSP9486ve7wH01io1xYfi1qIQfbNKA6n4Fh/7rfPQYk+9sx1Ll+CcEZ5IiCR4RhwCFxb5bzu4XAGUATztJOIWAW3ZipFy3wbcTWMMdawvwDvI4X5r7AYANI0Jyt4sQ6ZUI1CVSU2HQkE3y81Rrq7qBQ6oCHMKmpOQDVvCFp02ns+Sm55r9vlmsUGtgPqzF2TkTUQhokJHExFEHGEAdMLVJByeZ3Buh3OA+U0SrP2iw20y49lXrJfTs1o2mVmkarKVeFWwWOwLPnOLRzn4xxzWg+VvdffHgQcO4LMez2DoLZENzYkdfvHgxGzrP91Y/5kkfkfGjq68sUAueaRSU3RsIFNcqo4ILVgTKn4qXMMBenmeXl5OoaH16Or09+JM0DRraZzBSzlzRzQpheniQY4ipTZRoIptZlJL6K3Xp2XUlCSRmmIhAwvpq7qJl8U4D62gik6koqjKr/qATVbI1FUapB1KPDwwEIenDQg1A1CPxZd3bQPeiJYIgUPGUaqnDWVMcUZBZVfNuKoTy85+sU5a27l7HSj56tZjhSk26VKnFq8Mook9Mrd3zqmsFKUqyUblVPkKlD3rSaYdbmSI9HznFjerlRL9wUIOm68afoYdCDqQIMiharv6qcNqMAChZdqDVYRySET7EWcymOpvSI831mseKskkmiT6caIktXwoMw5pGPw7oXEdLZUPdtSrV1FLDc0+uJ8rMl5SsnzJXyQfnFM/1hdbTz084jptLv9oaiNxC9fr87oi+PqevjelEdt6zIVQxOLn4oKU5nOOqKwBf77cnND5NkfhLjhyuR3ElPnIpV1j49+eHHv45P8W8Yezys6HhpUNLtB1v5Uoh+23ShBJrdSW4Knvpxh50ojx2u2+DGfyNViupgohhDSQFns8r5TcucKl9swENPF1VwwSowWmOrpSZUz6iJ1tObhnUVKsk87ksqDETLhm65rsapqgvyx1aCHo09XrwkVzS1s7lG6W8Tt0aiSMa0n6EaAo2oAjQt9/j4Wg3HfoWnMlibypyGU2dRk/loRSTW04Qmkjw8+XIyQMowuwT84HMzrveYxsI43wBbNRIPr3DuKj4/jrzBKKIezQw2wP6VUjYCvonkVr9eVQXDhesngv748vLnybuLsyk8M3/1Cpr5+nZ8MX5Nn15P/nY2vRhfwMvX08nN5WaucKqoUatkQIYvgfs5pxxwjmUPtZpDnoQKDBI9AOq5lRw0RiZ02N/QMFO9FKcXR3FlqdWySLdax7TaFlemEEV5AdddWi3btDLTKIXrmmMAbKagZqpzmRkbMHTqVo/8G75GgdKMRChvecTnBRybwWunWRK56lrnPMIYs9co4YhDhqpqSm0FjDJLlUQCo3UkLwrhrZZRjnPfLDVV4tOGmK2uY5cvqDTYOqvNKgy4tiovk/8nyyzrLWK/gUsZ0eGBdzg66o1cfjAK3OGI992Z8GZuD2L8YY+LgwPvYHtCOK6YLxXLbcOpiU8yBLE4FFTvYqVUn+nhp7bj87x850k3/7v6nTryOxe0c0E7F/S7uCA0vcIBmU04zzD3uoHa1cgmRwB8OT9N8Y8Zoc1kgDtB2pg+m2IE7ptpqkbIeaRqnZYnt05wOOvNjvjA3Q+E7w4Df+hyvz9yj/Rs61D0RtCjP/JmB173wO35/MgdDgR3j2Zi6M4Gvf5+0B8eBX3u4BpJ0/6izTriOxJeVGjyAmx2CRmbBLQQ+TgvbdWoVF3Unp+NGUKl3tJWTBAfcR0akaHiKM4eyOr4HDLlFIvocVoaDScgixgf4RwdNz4YWrYWCRoEWlrvLZaxj50JekRvIUMfJl160ad4O744rb+2i8VYksYsutz+ZHJxPT6/uCpWkRywDA4uH1eRy12XynU83f/Ki7OscxLy5Ddcamp/HYJnf70ZvymDfy1nKS3bVztmIhSrBfD7Il/OnoPmfq9vluMeD2klONvjmUXzYnL9s/1SGvbHMf6vqAcRbkSwKzsRLpbPUW0vm8ygUisxgxkf0tSjtKzeLrPtM9esUL2Z7a6LVrj7Qy8mtFoWeZxTp2o5PmAKxzYrmNNmhje0DRC40y5PwEub/yqzfOXIaRonKZzjMvjG3NwRSy7DDZMq7/T4vEhypfam2B0SSPIWntzvJXtZOeiUJWpXXIrNN48zCVhT8Omr+GPXeiym8DaKM6Zoc5EhPtXjzU4/SFghIOq9fpS5YOBaJZIWw0wpz/Lc40koRMeDLj1vFIxmB4H/vygHGfEMEIDJOC0HWsv/0q1Wp7SjKlVLBkipp5Xc5HNGKHpfkzEHmyUV6cATC8s7y99Z/s7yd5a/s/w/peXvLP33s/Rt237RASBjqIu15w4zywA4K91gJlgUcm0ybVfXSs22DbsLocPG9lAGaXQi8O2dCGnua90H1nrsSlS7tCYaCh4ABwHpCiMQ9oamPTxujm9w2AEtND6+OPTHZcmzWNDfsaDnVLdf3updUnoN2u47+bClguSo/ZvDph2aJ6HEZf0z2v7iAseyPIkKjplq9Cz26YiVjMDhya/brFkNnb7IwCGcAHeeNv9XEM7decLphITaseNBR72Ah6ymjdwKpN3SvOn7gROdXmX7z4kmBsWRcA+rm80lxCpCN5H8J7p/3YXJYhd8U8g5FHx20B31h8HBkPP+0bB3uD8bBXww6I72R7TXagli4/PGgn116NcCVAAyE1rtl/8SuArNU71UQIM/vwpPMJ6590a1tWRqfCH8fczwZN3Lk0s2PGQhj+Y5PefzGhMi9+aqKe4qwJNEzuWjadTp2avxzRvcMj2FkHh2BZ8Q1ka2NI6osO9hpEFdWMT3ahO0IgD3YqYipOMfHdbSUFtAEI/SckOpvqVrSGGWTC/wQg89ekOPMmgWJPGyYkpkNx8z9r3siE4bPI3dzoZbYH1Te2yhCa8y943mZIstBPdF8gLckT7JyEOVfqRmOx33fbV/jnaB52DKqniJG3chrkuvFp8LVtYdrPEjb8pCQeMAzJ8Rpr0MF1OIzLIVWm3RKGr54MFHGqeK3XWJacTSdZRxD6jgYbgGNiYJ7jaAvAW8dsq0O6KlBHA8kWlnPVZlQwxi81Yhc5rF9M7jefoMu7sMwf24RJp9cSe08aW2eusLe+AUOKE9kk6aqLNuZcVlDN8udOxsd2e7O9t9ju3WX071uRT9llKf3mbqcxPp0+MYPDdSn0TPhswR83+pxFEJkmZhOkX66d21PsKuVn5oAvbt8iMVyjfPdFl51BbpTegvZIEIEh/1VgLwRMI/JrwLjIlRilWDzdFexclMgoJGDSlijseVcM8/5r9Jro6T8bTN/Fik0XcZW/A7e+qZPCAdGPBdOmK9yyR3meQuGu2i0Z8nGu0yyZ3t7mz3j2m7j2aS1fsFdJ6U5sslT9ZK0/R7OgvDoIHZPSiKzfl2daGcrSAwZnMsp5o5OLN+b9YLDj0x9PnQPxiMgr530Of7h73D3mzYP3TKsf62sGNrZFWbKslbyZFYTLcEJSyPQLnSLI79avkP2JuIAN0a3aNh8mbgeUefD6fcsT/azB2v4xj3Ea5NhpRWcsio4BH6NGi7xLaJaUtHKubgFyO8cUTGao+eXAqAkuCqg75gSN2OBXCTtTsO8HyCMhSjZHYUfSg1JU8Qxur8xz2XWPMNMOcDCJTB4l6tb5idahF9VSbPpkjxG6SYnX30hEBDt5n7flN99xxPvqCPuFIC3lLoVbMdvBgpggmB8lk279zl57v8fBfjdzH+zxHjd/n5znZ3tvvHtN3PyM91NrQ9P4cGz87PoW2ny2wu9YrOeP7eaTqZisaA1JvFHt1+4Rc5OJ0BgYd4HgQHwbukTpQqj3O83enWkX50rKqxrr6D8ljt1Xc+4EVvSwGaaC+2dYpboap90r1P0n/AvQeUVyqS8iSEluZ+wk8gaZDwQ4evZEfqAxdRfI/bfvZmwN4Gz6VuOUCtwwZ0C6saoEOySSSqv/KVBFxJSp+5dVKQGFWVH4Vsbo1Yxzl4RwLTxs1LWhXpMaC4gnnId6k+mq9uyavRB3TdJOHD19OiAG2hpYl9j44G7RlgWiMRSfhQaEfpXOCGjhSBCCd6/Y3BJtisz14KntD1p7j28f1P765fsDmmquQq8hSzZH0hDmeXoCLkCsdmHQA7UXRK4nyuz7hUVlrQ9FgQAsHsfXQlBLs1h3YuIEZMwakTS7GTID+CvYrbMX3cOYPhs1NwEhUP1H8POLTHK/1eUKikOYUs7rzqvI9cdioTdaNVSm00ieoGjNuVoYuX6PpSJP7LQHO1rRG09EUNC8XaW0/t3PHA/hEED1Pi1hcPruC5JXg4AYMnCLWOA3JC41FdH/OM1L4Yjwo8F+FV8XgfvVNHsSrdmPJbLIUwGvrsXJ+o+h/GUHXQDG7nOVjRF6NF579csgi33y2h5KohXelCVkn4vQHDiJQyqUvTKKmJId+LfGWSv5BkweZ/odswf6nQTI9vIfhiSz/20i/GGQd0cUBX+YBU469iGyoW2DbSoG6GIAU4KeRPnkAjWvJ7ClajVyfwe9QHQ4MHqBKUdHWsvhwXDk5/YvQCW9s24IYxKbcrhniJo4aFAa7CLFNOqHNwE98whrha45vC15azMNb+p9GLFJeOCuN9b9/aS2/xJP85fvff5PF2nubP6Gl0mozVy2lx/feZPZm89d7X6i3O5lzoxjXFH/C68yAmkvRcpWxAL3UuuFlhVFfS48Hgy3PyA5Ttw1yqOAVcBgToZWgx5DG8hRRUm1gJTjcmtVFr4yVZOaTs6FqEvoZ1TpcdJcAOHuqz41Q9NyNzMkaVtKLOqH3N6m4fOqoMc13RYe/wtmAPRI5TRdz/Ae9+jfWc8QqkTrdys1OjSAyv7MkjPHQNaOdLvJnsKW3zZerlqbnPLBKGF7Rhm9lexkOgGiMJdD2GSJbpJNB3ZJWU6omxQKdSXfMG1tPVHepm3oKQqQjtfdXVKcFTsEGT3YUIVzhZBY8OyZ0ojfD2/HoDIgCL9A8E4CXvulO6h23xsAoQr9Rn0Ol1ui5NRfA0fJxmMKsrAVd3zfPSEZSNM021q2Jt2X/3KyW7XynZ/UrJ7ldK/hS/UqKTZqx27K2wwo/uMlfVFxXpb51aqQt6HUsfj9cswK1ig0+fsAqMxZ8HfEy8hucfiroOJRLg9vWFzPoe4q0e9ntzVOnF1mvHy7+I0kiEWcyI1qX0BD7+JrD8CQTQ5RWqPk3oqRd6QdSlK5iKjo/9AArWwlRnVf5+pJtTqSnSbb7QeqZ/cGWpyqsJv4eH+P+x8x7+OXgbh4qw0Iief3LMYgW0UYDNXLBpKqQ/gEig2f8B08lYSg== +sidebar_class_name: "patch api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Body

arrayrequired
  • Array [
    • value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    oneOf
    + +string + +
    + +integer + +
  • Array [
    • anyOf
    + +string + +
    + +integer + +
  • ]
  • ]
+ +Responds with the Access Profile as updated. + +
Schema
    owner objectrequired
    + +Owner of the Access Profile + +
    source objectrequired
    entitlements object[]nullable
    + +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. + +
  • Array [
  • ]
    • accessRequestConfig objectnullable
    + +Access request configuration for this object + +
    approvalSchemes object[]nullable
    + +List describing the steps in approving the request + +
  • Array [
  • ]
    • revocationRequestConfig objectnullable
    + +Revocation request configuration for this object. + +
    approvalSchemes object[]nullable
    + +List describing the steps in approving the revocation request + +
  • Array [
  • ]
    • provisioningCriteria objectnullable
    + +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[]nullable
    + +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. + +
  • Array [
    • children object[]nullable
    + +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. + +
  • Array [
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/patch-campaign-template.api.mdx b/docs/api/beta/patch-campaign-template.api.mdx new file mode 100644 index 000000000..6c9aca5bd --- /dev/null +++ b/docs/api/beta/patch-campaign-template.api.mdx @@ -0,0 +1,178 @@ +--- +id: patch-campaign-template +sidebar_label: Update a Campaign Template +hide_title: true +hide_table_of_contents: true +api: eJztXel328iR/1d6sR9sTUQKvEnlw4aW6AlnZVGhpPglkp/dBBoixiDA4LCs9dP/vlXV3bgpUtZk51i+HBaBPqqr6/hV9YFvRrAWIY/dwJ/axrGx5rG1POGrNXfv/CuxWns8FsahEfO7yDi+MU5EGLuOa1ENpgtGxodDwxaRFbprfAENjT0vuI9YsrahqH/HXN92v7h2wj3muMKzIwb1ObNUCyxWfbEkwuLxUrCbny5n5+wCKfrwehnH6+j46CgOAi9quiJ2mkF4d7SMV95R6Fj9kdk+YFHMfZuHdtNActahADoFDCsOE3FoRMJKQjd+gHF8M64jEZ4Efiy+xuMkXuLYXNs/1vQ0ND3HNAJhfHiEIa55yFciFmFEbbi+5NgSuvPhBfxybfg7spZixY3jb0b8sManURzCoIzHQyMU/0rcMKOpyLQrGPX0lAUOjb/Km4VA3qwCG6ZA0CjFVyjkYR9ta9QamsNOz26NWnzYN1s9uz3s9nqLLm932iMDB4Ddiyh+E9gPSN7T1IyZ50YxUpNSIpnBUpmJGLesILRpyoKXztqtf+sjC5wAhQfbVKLCQ8FIMvnCE8e3/g8M2Y3/5iiWP7ntub44TSR9+Cwl/jX3UuGLlzymZjl2JWxmJzhFzAoFDPDg1gfeWigefoyM4uu1p4T+6Oco8BtEzZ/wT3xdmXAehvwBmnBh6qLc82Dxs7Bio8ppZBrxjM00bxmPYDwOjMZmiwd2M397wpBhrMGey2IjL3g3oPLGoZRblOkQZzN2BdEJrypiWyelqQTgtC9gdkToBOFKoPgLP1lhN9y2qeNV8EXQHyDEFv6lHljBGnkUg0AiIZko65KPisqtFI2ZfKEYE7gwcSEL0QJEMIPaoMQ8vBMxStISyeY+E55YQQE1CO44MDuS3XF+kAVFO8r3DSR+4V4iiHe+mDlkGMrUZpXPxX1eZnH4buwVbERaHUdxJ8J8/Y5pZjX0+1yVVL50mfRB2gQIcwxdLZJYzrgyXOul67lr4/Ex15qWYt2Y/P1YsfUoEMQFxcckAh6COBSZeMi0DNK7W5SPWwNmwYa/1ZTD78y2PMk4oDOl6ydQQ9KGVHfodVr5Rsp1TgKlWBWnMp1J45qsnJ3v7z+Iyxta0RbmyHE9ELwjcgK6MccBq9watno9Rwwtc2jKv+xRu7cwO60+8BOZDs1Gaxi0nJS2aeI/RTZPwYWiQ4uIrxfjq5O/5vQwSixLCFvYh8TSUMRJ6Mui2n+8ipgPbEz1gio2n7Z0teZtgxnTcIDlgEPRvABntirz1N7oAMsOzxyMFu2Bydv9PgeHh38NBovFqG+a5hB1Uwr3doPmRgUmQa0m+yvYXx/lmZNpARbfCR+5DZKhKYteUeGo6IrfcZ+DYrIqPx5LXT+XstzbnQnM1SnRqclKdZX7PgK0laJfN9JEuqVn3GH+TrAgSqSECk4NG1DauT3zvQeNPNB5cBBAAys1YndVmmuzbTbMTsPsXbXbx93usWk2O/3uP5EwDYe2U/aOSlr/Zup67WNz1Bz1R0Qd6o6deAXyFuCqBfdrOtqk8C4qBIhCFRIuQQgWQoD+644Kc+xwL6J2HZ54sfoNZAX3IClz4WxXavL2WFpqZU4epaGJ8+9TscuJohMGq2JF9sXlgP01xU1GYk7IjMEfPIkDYDcM3fMe2DpYJx41BIjN0rKFc8DuXXTkaCiSMEQ3Do4nbL7Q6NBY6pB1vz/o2x1hgqHpDwb9Vste2KLdNh2cZtl6jedXWGh6Ojm/ml79oxooXUGNzX2n9XY2ZudQanN77wDRw1QpC4WtgmV3ve3NTrDY5nZXYVNZjb+oh00rWBGcMMqgfDeESTMMs+gGKTi/X7rWsugZomWQgNQA6IDuoNcY/Z9UVxKZCFHe9HLWwICIaQqa7P0SVKYolFpio1xYeljojQywHAvIHgQT0G1e/MikrL0kki3baW9vwb4qthyiLquuUJADi2rbaL6lHWnBf5VmpVpxDwO5NS7a7wEgvY7vA3YvxOfoQJIHzhx0m6KXOkI1g3TrrR40UUt1qws/HqKDopeAXsn+q7Z3sRhAN/FnGXiZKwI6pR67vpwgHL7nfhbkQg/zfoqJ2GrmgKe20fAIbEIRZFcg76XnrliuRj7yIRUq0qt0txIJ1VuNLQa7Al12Qiwjx1oAYhnklbyqECkfJTyZKmssx492c81DitZ5zkJHa2G5mHORKoFCQghPRH9mkZDi++mokvWIjr659uORVolPTPj2GsMqZgdWstLYkYCDLWIwDQQtNsc9ZUj0HUgox4ECDPotMiIb+OSLCB8gMgTkLTDvQAFSKL644j4NNN1QQy4jZy7reFILRDYzCuyAMouEeFTDTSYdLin+KoliJMn1iQVOAmED/QpCG+YLw2Qrdr9g0bxcQxvA94cgYXH4UCiVy+mRf+aZKULdCMDCQNu6vzWP4kNqhwxGKCzhfsFGuqbJRBgGGMbLwKhZi7lavauWCXDw2Gw1u73+P59yxjVORjnfbFgn2lyKrxAS2WSucpxp5nz6u/H5+MfJHJ5czq7nJ5OPs/fn8udkPD/5K/wxn51NPp7M3l3MLqdX09l5Mc2h62snfB5kqdWJj6muetBYcsxUMmLUBMQDufSshPU52GiUkWAZKQIpiL7m4kvwWYxlamwHGlSyF6uibEPd7+sbpj9YgVLZMgHwfCZMx9Nqz002htB4HYP2gc1m4gu4fleaaSwPZt9OwHA4AC1J9sGUOA7ZFXyNEAEiafTQDlXyd0W5JNGuwvCMxohQF9UfDJFMmFAZapTMgurJTbsGYgE6SD5kKZXwriqVG5mLg8ZABCxVEj3P0KL9UChBVm/WuECtDheT89Pp+Y8o/1cg16fwx8n4/GRyJh+OT66mfx9f5X5MsAQox9lEPVU/qOpkPp+hLqEmQdHTouqo+ghLglDhisvnDLBUq+y2mwxHyPJ6nZt1i9N0XftZMyBjfuEBsworJalNDLBd17e8BKgq1nBtzFUi/mCvoTX18wHFICmUc5gbU+DnB5R/T/xYLqf4qILLIHTRK4EZjYIktMRB3midzObzydlYMvn6PPezwODc86dj/51C5ZoEAYyDEP6TeEnH1R2Mq1u941anCXGXtPFBzL3CalR+6rPUaUoPPOq0650ANsWAPwsVxBZalZqWNyd1OqBpbpkmCaWKRX4ZAnOk6YZfSCTaeQ9ayJOks72bFoHIG0cUmdzz0IfpV8soS44eG+KYlQzU6/reuBBSBN0e2LvaYFSLrzYL78fzc/hnev52Vg2pTwW4QZUmpRa1lK1EFAHMKgI0ahEY4gUW99z/qUzV1rWc0hCwmR3hhyyb2nVFHsNFyUPAQG9OLlh3wDzu3yX0nN8VQZDwG9eXuPiYeB66iNTYy4ZnoXvn1mJrzc7Tydvx9dkVQpXJ364nl/AXtlVdzfW1IwtIDpfBveSuHACGp5HwaPGkyX5Qrf4AA+IqBa0KuvJX9BABM5lyWVBD9V5TI9+0drKCqXVMZskVXPbabYrmIRhleLaiZbQFj2RQjcV/kACgcaY4+QNbgnyK8ADMtm27OEjtkSOo/0CLQXYF/BGgDZKYUJZVAqQZK4uzkQWmZ/lJQRMGlO+wtmXFmJOlYSoxlrhYS4siUQMNW3GulOrNMY1Y+gCRi6VzbORcAAItYGxuHDG1HoDTFQGu9HU51wceuaDg+dWXCVLzThJzGgcy51OO3MdobfBV3WJVUYGeyud+h7d5p5p7rrtpm8etdrM/kEnmOpixhxUvhBVyuWx7QukUt1ysIIKMVAqQTHGaglPDtqtOkNC2sjIZr2S3NP5Ijjsu5J894YAqgNX9/H255GwXxz24R0LwOs7MupZbOZCAoqKazkIM+x3LhP91reGQd3qOPXBaAwF/2k7vGfFtLrGsOJ2br/G7i/H0x/OPb6dnVxS0zq/PJqXJKpX5rhR01nNu2QmM0Fv5nIxFlEB4H59Q6BdH8zRftzXsywmGS+CIGmC0GopNyhSHtQSzL+QuEp0MLERMJXikAyaS8hmmurUVm/pOsF1c36mUChIg9bK8nIkzAzKQtwNVUZP9T+3tGI2ghEJpspZONBVVQxTgYRnPZJuUsoXz7eIoF68jwcNs39gvzSZKp1QZ9Pw0jyQzn5FWK+FKC8uLNRionkwuL8vBJz17bgbzlH4thFodKNHSZFNfJZwQDkYAtPS2FfDa4QOZCrnitg6iyF14co9KFhvk7LwGTEf8C3cJixSNzKXsO136LO1oUenJHSzz1JGJVXSwh3JcqX+BUdwFYPx87luC3YVBsi6smuheaLy4NWtbSEPWXO/XOr2a0bRKtdYzRvz5cfb3yfwcUw8ff5zPri9eIjmayFdR2mNeUspdYUiSW+mrX8fb1Yfk+p6e1m726/WHVq89snBJcmhZvO+MTKvVaXWes/eh0BGtLRS6eg9T5vIVg38j2lgDTZNE7tZ2ZAHj0winOJe5RDFOPwpLXorTdJjajiX1AGc4V6gQgQIIVdigti7CL7IDn+jnJxTRT1pewdB+SrPhYJOe1hhJS0lvck3tEFfbLmFubbjzYwq04a5RAj2EAt04EDWm0hA2W/kV/zqVL1smbit7ntU/NCS/T0BV45C7/g65hLdJCHOBGX07sVR8LuWjvOEHZk18RQ7Q1uEcgKUIcNP0HUhpsAMM0KRQEPMkpXXc2BCCbFvNJ10+m7yDf1Mf8fFiPgOgNFFp/80L/WOippiDyLVHclQTX9S5S7n7KwillzybnACwzq3Dbcpc1Hp6XJzkdpsPTG6Jgd2jxUnLabctPjLNlklzrjt8ijnjszNaA5HkVPlwjaAbRNzW4A1gsiC52CwP2TK/lB3lJHVewMXt5ORESlqriXh8LK4DE+254XzIItZxSayrqlLbGHInBJQKKBb8M6UUngeHZmuVhoDg23HvEr0/QG7covFi+5QCVB1ksWPVxe19+N6HP+nDUZh2cVSpXGpHhRW3+iiwT4FyVKqjTzSvqZeSSTYwZn9GQ+YLlywAygE8OyRZkh3xMAtjdg5bdjJmoVgJ20X933EjHK6Z51MRuNgpm6AtaTz6nCUlOGD0O58sXZPNK8VwVGpVhXRHcEAXaunUBmWMSPd9hWbK0RtpETkBT9xxj2UjSYOmV1paX2Xb9KxlEIlcBkhDBc7maFnG9orW/dksvJM/dte67fvczojSeUbplbTBL9Ov7LRMxoOKmj0tCs9SMz+X2ij2uHG1xciYu8kPwWg/7A6rU41UIaTEoqCQ0neWNooGuNNSZJr779XOCmL+G43phbHyRsf38qhZDmNbwExTmHPt7LR0FCE/qUW78iFNJUXvgY2zcL3k/sQnuEHpqmcswenkTskeSNiLSXsALOz29tYIqBcmct3gY/Y6/yRdzuAycY3bbAhwy81aNhvrgyIHlIcWqzUYDaLFLRxFSOlQyeOa3pvsPMnthqB6IDpK0BL/sx/c+3UVK2N9XfiFaxnaji4EyICSf72ZA9+7OIkryvIcvGBt8nnbiOVUPdsSbbOvMmVYH1wU1U8W/K6cbQ3tl/RI7uiqmSW5sgM4GbfuBOGDyuWqVO5KnS3ZpvM51yoDgjSjm0/dqr120kdG6cG9wrqIREMgdf8IElpXUZWzFjVgTRs6VO63QX419xgK+kH2oMnePOg1hcMihRh11lOZx5sQH308nZxML6ez80taef377L8nH2fnZ/8oPD+f5X4WgGjhDTD+Q9kC1W5z1Zs4cicmcrt6P1TX7PKnVlTnpAh68zj8mZ59Q+UwQKgXwhqN7O6o0x1Zw1GvtbCHXac35Gav1TaN9Jis3g46p3nKEUercO2GOWyY7avW6LjVP+62m/1O+595uo9xibVqJuWs014FtevylQ7+Kzst5QJAeWO6cdHq4gpW/niE2iBvRMl6HYTxX/C8Ij5qahwVBYFPu93TwDuXQCbGDITV7rW5tbC77W6v1x0u4LcNmt/pDq3FoJcx5hIapvOL7FJ2VzpDojZ35Tdjp6yTTCkzqbLIVl36kZMHtolz0R8Ne20xdMRwgbme7lD0wFj1BlZGI63f6BnU6zibV3HU4etNqymSyroFBPnmyaBaFtFbWeSv2p1B8tXGfTmKiKfdtCzkppzdJMtFsZSPqxKZF8CUdDlD2cZSvWlPvt68S1TyuGbrppKXTRsrtThVVreLC7pP2vWKOTpU2K9qIBYD0e/2RkLYvXZ3wK3hYjTkPUfYw5Yj2gMnk7G5QOFHwy7zMZstxaDRHpKlGB13zabZ6b3UUqhz7GFKgdytsjcYLzMYKh74N9qLlGC1QFcFZ2kemXBMNsN84Xr0wsgWv6YpQ7JUmvytwjTjL1JgXuMoj9lrOsQMDYrw1jg4MErLAcpSVXPmN1szh78FI1de/3imsdtFqUpGMN1E/3u1gRIxkwTXWMKR020trP5IDHi3PWotRrYw+x2zM+rbZse0M+UZnzLV1Baw1AH7d9zpN4e9wfNMILTOoBcpGBvN3Lu9ldvFyuVm/eW2rrAJ5EZnjLsDc2CLBacAEsA2UNIVvV5/JHMNv18kVSPqL8ZSpaM5v1NjMi9O3UvsSWrCcXJUzheb/2XsyhOtV62KbOAPaFSUEvwKAdG3jasavzCftsOkdIHpxli0enbfHDlWzxp2O93FsA+gv9drd1o9x+ZDB7MPClXVCBU+evy1bdOTgv1MDSiZqMopwd3NlBLR34idkknAbt3dNSeeixvKaa84a4B9z0665ffzLwKbNianG81fcDdNMXsrD+eeBPYOudC3MEeNOwToQKHcbG9BRTwp+MW15RVsoVDnfQub8ourBsCJZou94Tabq/GdqMFgpjfk1mdoa7pDWvnad/+FtyupKszNzgLWdCsGgi9A3dpdp9/lvD3stgY9cBC80zFHvdGIdjTI/frbFx9+xBOOrsXU6RiBNwvxSB0upc5331azPxqzPxrz//xoDMKJJNpB7y48MD8NGlr64otQykfxtLRGNBt6mpRFUsE2VVal0unSii+PO+x1d6+7e919/rE2ejlXF1OotwR9WlXoc+2r01PoPCvQR144gCeuVCG5gCknkhYfFUT66f0VKPZn3L8TMfF1rU+x/EL4SLryCvHjdD7k84XeXqFdfzYXSCDxUV0+AZZI2MdEd0axkaHETrW3t0G4cEFA/RqIiHd70UUhtBac+D4lbqNDZgci8l8VN4GTBcRefbtB17XskeQeSe690d4b/XG80R5J7nV3r7u/T919EkkWN1spnBQlqxWnVWfciCnfyyvuoEB6RRpLVS5dHcijFWyMpRjLKCIHY9FuLVrOwBJdm3ftfmfktK1+m/cGrUFr0W0PjLyvv8n0OFWyok7l5lvOozwOKEI85Zf4IFxRHAR2Mf2X4AY6B80abVzWuBl43pT3ZCvs2K1ix/MghrFBw4Adww3pxev5GbYPXct90cA3ud6ESiuvD1QnyEREu/nEVzeK99BxDx337mfvfv4w7mcPHfe6u9fd36fuPgs6drdBx+4zoGOXIcRyEGL9mtDRBtyB0MyBScGTS+p+0uJHTVK1V5/80UCvgCLboyqKvAoC3Nr+oMFSVMhE+hm70LxB2RWWDXVZFz9pdufiBbPq5nqUKrx3DDApXkXkuSuX9BgHBO2GD42xgzdCSZ3R8pb2kt7ohUbBC+RXtu65G6eHncIHyoPecfdlX3Ip3cGmLkp8ST6YzXHEZzhiNvkqv03D0vxvr/4LNzGeNffYpZzrDdsFZM6c+xBGiK9rab5SCLqH6nuovnf3e3f/x3D3e6i+19297v4+dfcZUF2hoc1QHQrsDNWhbNNkKZZ6S5dc/l8jdlIVRYG8f1V/6SjD4IQrQJTSDw8b1W8qlr7EYuDOaMSGkqwkxN3i+hOo32C2YJYem3ztpjvG/eAeN4wfLYBFNdYHN5tKTcMCbHwxVYFGk/gbuvRhCZJPalxyW10cakTAddpf8GTL+tKQBzxpI5s5xItalDjRY9y0DLFEen2PvCm5ND4Y13XoPb58LLKhDWOpY9+TvUF5BpSWhkgn07OvLl8i8Ja9V769nDkTTPlXL8GfYbE2eyN4SN+kwV0wr396f3WQ+wCH/G60vqmEXYCIkDkb6x0hWIk8TBgkd/IzYuPCnhtUH+Z4MGB2618KwW7UicGHc7DzczDMxFKsJMgWYK3sA7w23jSPLrCZcRIFz7X9I+DQES/UOyB3R3FB7ntYzVu/wU7pYkBX3/qlPxaGYR67Wetx8dy4vpeI/9StNWRrDWotOihRIVl7Y8k93BboMDbBvYi49d2dy/YaufYwiIIn2GqZBuSEoqO4U8rSs/bddBTaa2B7RTpu/fd063SxGpOmS19NN8XblYJI/BdjKDqoBjd3CWjRd5NFV103SCMabTNHUkN22XAbgAyJvjNQDF8KE1+gZyZgEsgcCankJ5pZ0Hl10U9hzPT4Bu9+gpJ2YEXfTTN22MAOG9IGRIp+9Wks+V1tHAPZASkAJ9n8kyVQhObsnmyr1qpT80dUB10DXoAkL09eH8sfx5mB0xeB0wssnZYBM4zAOt07hheDqLbQSRWYpVMCZQ5W6fUC8I0lvkl604VN9Je/tfHiiMdZ5gRvyvmlrfQGS/Lbsbu/ksXbW5o/oqVRUBczkCqv9yawHybf+3XyypfQAWS5+gIEFW/kFeiNwoLVLGFEl3jC/8NbdaMjIHaIh7Iv6+YbQhiOGiM/97d0BeUX1oLHiCsP9Xd7QcvXYYCmRV+0cEenJkNgB/fkVQsPlAHXPctL5CRoRZmhe+YStR8jUPf3N9l7CPl8C6Ycwz369GDAfg5U3JcdUjzVgoQXtq0SH286BLKTFX5AeJu02W5kJdIoQvTnC82LgGBlWktbCDo6D0OgS3dFuIpmDqauISrOCdWWvkCmIpW3BtbjLKojh9lA5nhGj84wHpZCgm1tgyQ3lsJb0weOgCwIH3M9vJteVVqExny1WBKEd0eqUnSEZaERDL2k+HSarabZoFAEnq8DPKnr5xq/Xtvye5B1X9gu3QaYJu31pwQTrEypa4jnv7g2xv6UgZJfJKn5ELacEBSFm58uZ+fsAgPKzLzEQeBFTVfEDg1rGa+8o9Cx+iOzfYAft/NtHtq5u5MxODlaY1INR5fIYEkq5o1RDU6h4jHe4nhoLIERWObbN8y9YLj2mDveevMhi8RI9WGiikcyN3LmtT5BfECrR9nNl1VeyI+L6NPJG0elE4r+Q868wJ+fBaYgYDiPeKGAzBERsfKFWpRoqDvndMXyakuDQvo/0cILxrKyskxBPVGN7FmaFrgYX9ElIHgwlBamZIoj5Hg5AP7/sXEL/zHwLmd1yvebfP7N0AlDKPNzeu0t3wBl1B94Hcvj4/8C3gtdvA== +sidebar_class_name: "patch api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Update a Campaign Template

+ + + +:::caution deprecated + +This endpoint has been deprecated and may be replaced or removed in future versions of the API. + +::: + +Allows updating individual fields on a campaign template using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +## Request + +

Path Parameters

Body

arrayrequired
+ +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) + + +
  • Array [
    • value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    oneOf
    + +string + +
    + +integer + +
  • Array [
    • anyOf
    + +string + +
    + +integer + +
  • ]
  • ]
+ +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
    alerts object[]
    + +A list of errors and warnings that have accumulated. + +
  • Array [
    • localizations object[]
  • Array [
  • ]
  • ]
    • 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. + +
  • Array [
  • ]
    • 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 objectrequired
    + +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. + +
    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). + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/patch-entitlement.api.mdx b/docs/api/beta/patch-entitlement.api.mdx new file mode 100644 index 000000000..44e5d1a6b --- /dev/null +++ b/docs/api/beta/patch-entitlement.api.mdx @@ -0,0 +1,133 @@ +--- +id: patch-entitlement +sidebar_label: Patch an entitlement +hide_title: true +hide_table_of_contents: true +api: eJztXAtz2ziS/iso3lVN4hNlSZYiyVV7V4rtzGrKsb1+7NScnZpAJChhQhFcgrSjTfm/b3cDfEmyLTu+m50pTdU4FAk0uhvdja+bIL45KhYJT6WKxr6z78Q89WZHUSrTUMxFlDoNJ+VT7exfO5W72vnUcHyhvUTG2BU6Xs6kZqOzMctin6dCMx4x8VXqVEZTJsquLNN45/qni9MTdoajfXozS9NY7+/upkqFuilFGjRVMt2dpfNwNwm8d8NW5y3TiyjlX5s30U10ORMsUGGo7pBUIEXow3iJYMQ9n4Rin+3sJOIfmdAp/tzZacCNOJG3MhRT4ZvfWkxJGPNL3UUiMZcRn9suFRnxBo98uDnnUcbDcHFFkvofaPydHeTs55mI2EJlP+TMIINEucFUFC7MNUsXsSBi5qf02TzTKZtAp0TdSl/4TXZKj5AVBppVxAMPDQ8yZXcq+oF6zJUvQQXQYxywFDSjah1zgg3spGcqC33mqSQROlZAKVXUJxE8pC5NhspdZtXLoEOUwk2dxbFKQGqkPT48OrkcX/5CkzICWl9A+juZztjp+Y+/jg4/jk+YStjF6dX5wZH9zbN0phKZLpAATpFMBLHhgUqBF2NFTbA7LWBYaAi298250iI5UFEqvqYjoID2KP1ov2JY+zAtfCqcT/dgmzFPQJhUJJp6o2Rgo9IHsjIyZj5zlk14fMiUUWHVXoE1mklonrPr7KdJJoBDbybm3Nn/5qCWgIJOE5hwaCm+8nkc4q2ON2wPWgPeH7T3WsMWb7XhqtvutAX832sPnHvk19rqe+UvkJyHkoLzwSWP41B65KC7v2kVucTMf+ElPl5hgScJX6CYqZjryn01+U146YrMI4aOSH7ITvNIwLhmvghkBDMzWbDr8w8HDJ2Quey5blvT2jUEG6dhlI+TlGDsSaUgPuHRGkUuBxmwzYJLmBn0GJEEKpkLnFsRZXMchvs+DTxXt4Iu4pB7eGVveCpGHUGYSpGRcrbylveWyyc5GjHzwCpGSZi4BOw6BgdDK4InaFApT6YiRUOaIdsYG0vzAiF4EMDsGHWnVSFrtrRbHRtYvOVhJkh3kTgNyNIfNsQTcceq/UF8tPGy8X2j6I5STEVS7b/XapU98ueVLoV95W2KGwUJMOYUhppkqZlx65XxTIYyBj+oUMutOCdmft+vWXUEIy1YPWYadAjmUFdioww0+OwG7ePGoUh6k085/C7a60cVB3wWfP0EbkjeUPgOzkvR99qYdcUAjVU5u5XFySkmEqPK/aeSAGnpI/8iyGAqManSm6QoVzYmI4jegqIp9l6zSFviuBjcaQZ/YPEJU4m37FI65wtSplnfTETnDNft0C5rRL9Zcv4SQRsP9inFWaObkdZyGi1rBJ2K2QV9Y7mhExiMlQgpPEka/ROMJ3dre/cHXArzpbTSFe7nGIORBa/RmAlVueR58123bOkE/Ul7MuB7bi8QvtsN/K7L/c7QHXRa7a5o7/VFe+gs6cYu3mpJmFdQzQOUlzRDrUB+GQVqjWaeVAT1dyohzgaGHHLgCueXy2tvsNfu9Ya9XqsNV8PeoNvpi16308XlFRRzbmys5B/jwCupJilp1+fejAR6MS1erppVD3ll9VzA2lSdyxzhFiHABIbnqEgDyRWNPEDXhHBtAo3Rqw0bTfZ384jmCwDiEgWKgHnUshBax8IjRIyx0IBbS+sDEImAPYK36Z2qyWypWIBLSHSfHY4vzo5Hv/x6Mvp4RJH28Oji4Hx8djk+PdlootbmCtWJq46Q48rKIDbwGe/2fZKnMgWvacfggBDolok/13HrECMPYVF9DV1H2UQwoyd6RhnMK8pnLGbVKCnt2WQuCa+UMlWNB+WjxyAE/oeYExMsbdbwTqu1yva5ScGs2S+nHQDBrZM0CbA+mBCszQIK8FXH2BgTNsHYVUYoaVrJZwb9bhAM2xhR+r3WsO9zLrz2u7aH+McAu+cOZNVbDnXMswgESy7BeTtI14M0NRWbyCDBdO4wF19W6x3oNSfTcDBx4KBVBxXtpnKJgU6r03LbLbc1uGwP9vf29nudZqsz/F/kJU+7v5eZkEPUKoh9F0sFun6+7ouuq7MwF/OJSCC9gHnNwpCAnAVwK8vPI6MZlL6aX9fGOjj5S23SG6dXtRunyRRv6TBOXZ6lam7g/eHBX/DpqLgzOsR7oQKUiorRKks8cUFOckqecUn8bpRuUntTBllTHQgSNTdQkMZg1hOrQk0TlcWUUZawthx6Asmz4BGNHXAA4s5+wEMtVngBjTO5ygCVeCpwuRjXTpEXqsz/EdLeJHrtcYk0m+a0V8euUVpVdt2c1im/umT8PqZTTV9eVXn1vGhZc/VE+akSzpzHqJ4gEcLF+MG+iIVrHC7mMtGrVrrQqZjXc3PCPycmJadrQl4UVwDWm+rjWWU1sZwaiq+39FgOx4frVp1O3+ODQc/vw6oDV57oDHir1RITZDPd2KftGNiwAasvwEoe3vGFRvR445hy5Y1TY8DcfN7iZodZiainhxfu6NC9MJpbCauIHgy+x9U+DOuVnQeM4EICcYN6Dy9PyxIIpSA2hq31oJfNUlG3XgfkahPHO4HPPY/3xF63F7QHk6A/7Le8YDIZBMLrPE+jldL2UwNLn54sWPsx28gLhkXetLbCVA3+xEKTjSNwCUpETDKBLXIi6N5FnbzGVDFMtYZEhf5zEYhERJ44TBWV1ZaMArGxLxOYxjORzCVk41imenHZ9wFzKWlbmwFBUpWYVOqCy5AKnICZAZzwCdf2dQH+QqH5dJqIqUnsMOJ4kJGpOcyYiTfavLvQZaBqgI8widWROBY84SA/8wCg3/JkAcgomYoQK1HpnQD0BBCJdJTCwiOpSJLT180VQ07kdJauU9BS7KR3DpAiUnP2RjSnTcY9KgK+hSfcJIJYZM4Vw/G9EyT3UaWwSzVm7p+CKeSL2fJErKnIXhwdHx1cGlswZDZyAltLxtErbN3Rm50p6BDksOKoqLmGswoDv1w0f/z7r/95eT46uRgdUL5ZtczSHMgqMdrb+tQGlldUlZ9Y54+lptA0PtT4Tz5CA9dNHi0amLrdzSTmcDgTR/Vl1NSlTJJUll03K5k1nM7Qm7zzWu/cts8HbndPcHcwEV13stfu9IJOdxB0uIOutz6NfzQ+1+2xnua/FpAwySvlEXlFpSiQ3Epexxxzqmt4+hbfyZmsWER+jB7dZOwDDsvmwIw2dm/5X1jkPoMxIoUFFnBFb8ajKb61wJcdASCMevkojwPAe/MmImUB3gHn1TiZ19UpzNNkC5zLl0q+uBUhctDUEHcMl56a70o/2uWx3IWowHfBD9zKwG/Zf7PPqJHPBffNNeCqVl55NUxXxarbCalMSEUxj81LJe58XOdtsE6tWRiXZ8ekdwzrJVyC5jaoajaZUYhRK8SU1M4wXL7CRC4RJ5sy9rPRnPobTerjZdJHq6T/F2XRSlqxcX2zMv/V/SemmtZdV0A7IBjAjpIEBHDZuUgzTERz57QZFpsonzYbyAiULF+znOaDycvwQPkbwNcPMhIuLM/0Ul0Qyx50tPsz8N3AHIAWMyQLqI7tagpFTTTb7D33QV4j34EVBhWYcO8L0BpvAOOvIvkPfG9qu9TA/Oqwoi/45F1r2OkG77qcdwbddr83GQZ8b6817A2HVBITWvOpeBp1/SgA8UqPUZYt/ykwGHFty8I0+GNItj4HRGPD9MG0LcS0/DLcVNJgnL0/OGPdPuDOaJrRfT5dUkLkXl2sq4MZwqcAu+TaSkeeZhwefRhdHV/CnfOjv10dXcAV0lpJOkYRWKuPZgmsgi1QObsUAKOSFiHtGGiyHUt1p1gsiobS/DLwm9l1DXrY0df0qJIuywa5K3lmBw57I5ui2YAwgrVLineYDPg5KN4ZeZ6IU/fYanKHzQCDiuRtk42KWkL+0se+bOa+X76xCTJwZUGFcZWlGBKlJ+pzUapyeUHIo8hxdVLQOYDzDTZ0eClETrKJmhcW1mJZtPMDPBvN1bm7rCiNVIqb1yCt8Cgo0/4rWKUmIBtmPzYcUd4IgSfK2xURqxYckZuPhpkclns80xv43VkI4ccl0YoHt8I6H0EBu1uMlSWfPCLZF5XUOd9Tlusid3yzWGx9d+u7W9/d0HeXH55b+G2fEvRpr0Kfq8juo8TFcwX6JGQ9kco3W/7T7JczE9lAkGoh0k8/X9pdm/QGNcYtUq+Ij8xSvsL8qJgPc3+S74zIl/5yLpBB0qORIIBIJPx94rvkmBRlVLW3Ohqg24kEA43WQESImglu16XNw0kWRcgJ1w3mK6Fxf+2MQ3zk4BFamwiIo0a+a7D9FklukeR2NdquRn+a1WiLJLe+u/XdP6bvPook61vKLU7S2XzOk4WxtHz/HEjLGTQoC8GFyxW7fapoBYmxAmM5deTgTDrtSTvoe6Lr867/bm8YdLx3Hd7rt/vtSbfTd6pr/XXpx4WT1X2qMt9mHs17dpHcAo7LIjAunSrl18t/GRa1AwxrtMsxx82g82a+XY+wY3cVO56oFGQDwoAdkwfKi1fnx5VaOke9mff+qnjxTqVehJRU3KWv4rbQcQsdt8vPdvn50yw/W+i49d2t7/4xffdZ0LH7FHTsPgM6dhlCrAAh1u8JHX3AHQjNApgUkMF+7l5+xstrH63YDVg50KuhyM5wzfcpSrGPPFrkYEnXKpFRqS4Mb9B2jm2TvC004GwKITLC7V4S0C1aFX5TAJgUP2gJ5VySH6NAQDdZuCPaMmB8pvwKyo4iIy/MgEMKCqHC2qsCG5O4LSBA+AcUqA46hUD9ijVOO1vfVQ9m5yjxMUrMjr56QqDPF/Xf3rpdAmP8IhvDxYWZ6we2C5iaOY8gjRBfYxO+Cgi6hepbqL5d7rfL/Z9jud9C9a3vbn33j+m7z4DqFg09DNWhwcZQHdo2W6zAUh9og/T/N2InV7EckHkz5RFW90sMTrgCTKk4zMwpP+Cu7pzf/Sb9ewe/aEBUaBjKkhCa5Ruev8E8wfzcN3ksm/nnRJG6o13PuNt5TdzBbabGx7ABnYdmBjAfmCcSjddEOiJu9Gy3mzvFxupHKdOWf5jABWQfzJBp4AdI1pDoNrAYQxZRfN1uDtdZkg/kukrC+++XxRB6QJZ16nt0NGjPgNMlEVGET+WhYPQxrxl95WiwchnBYn9nZbBTbNZh7wVP6CQT3P/y5qefL9+yKQJNcnRzSp2QmBmAq5yBiVAgG+V7QbATrS2Jyqbm8/1RbbcNOg4LQhCY3UQXQrDrsVXCCUT4cwjJpFLsJCgKYK/Nt9vzWr+3tNBRRoDHiiTzfK+/yw7pqzH8oInaWBEpwWPXcS4Xr8j1Uib+I6fmGmouUdNvl7iwBwCaj7jwY3xSCw81aevFgxt6boWeS19DuUh1mQfUhOWjvkfKy2ftxXzU6LlIr84HHhKIXzPVuzETtPIT+sbMmymlxf8whqaDbnA9zcCLXswWfULlkke4nVaFJdcM6UoXMCHxdwyOERlj4hNck+1pGlQdIZf8TDMLPv+Zdv9/rslMt6/xHCpo6StPv5hnHNDFAV0TA7Tl36xMaFjg2ygDxQFjAAfl/FMksIxW4p6htTaqE/ld6oNLgwesEhUd75sf+2WAs1eMHmDrog0dveWUu8bwgwxLC5enmrLyYsCyBlf5DRWsikt6M/wWrzRxpfx3kxclHpU1E/wQ8bWj9AOR5N8n7v5OEW8baf6MkcaCXKw9npenhh5915GDeCpqoEgKm1xUfea9hX+rJUFNJzXBX3hKrk/wHJKf8kyjKiHgKKXzKTBIeDMpqJgQC/OFWoPZczkEHmioMJrkZ4JN6cSeBDTAIf2TIdCjcnc+Mif/MzgVzQR/68xuvlD2S7om+xm/2PRgljG3w22/8Ow3ZZO84vN2dpjbDmC4+TyL8BQBYDubMw4W+oSB+VJ7mYmDkOpFIteFIiRZ9MqDAlouitCkLCeZ69MA69QSj9RwNhwLzEjbIjWoHmfRnqxZCnIuwuJky3oW8BRtMF53JkI6wAaCOOA5URnh4/hyhSIQi+ybETwO1nbSu9gWzwwC4Y357DXbzZZL2QeejqN0Cvlwhbg5lXbp9K+VU2WK2vz2COrtEdSvfAS1RSiYWu7GWAxFQ81MqmvC6nX1GDj0rn3p4yEiM7BmfPrtG1bLMM2+x9tgDliKuf5UZtAUssHb8Npf/8151cjfnFuG37Inz6tey35e8Y0W5SqAZ918EVgjAu7prBFTxCPezAP71silk7PKjo8dT40lB9PZ1Agf6UZH+xZ1m7PR5cFfofXEHoc9NzWohN/BTfy779w4dECPsUlz4gfe/+bkFV1oYwjnkHsd4rQXMB/Q7F+mcCCq +sidebar_class_name: "patch api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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**, and **manuallyUpdatedFields** + +When you're patching owner, only owner type and owner id must be provided. Owner name is optional, and it won't be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY. + +A token with ORG_ADMIN or SOURCE_ADMIN authority is required to call this API. + +## Request + +

Path Parameters

Body

array
  • Array [
    • value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    oneOf
    + +string + +
    + +integer + +
  • Array [
    • 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[]
  • Array [
  • ]
    • 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.","example":true}}> `description` property.","example":true}}>
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/patch-form-definition.api.mdx b/docs/api/beta/patch-form-definition.api.mdx new file mode 100644 index 000000000..ff4597180 --- /dev/null +++ b/docs/api/beta/patch-form-definition.api.mdx @@ -0,0 +1,99 @@ +--- +id: patch-form-definition +sidebar_label: Patch a form definition. +hide_title: true +hide_table_of_contents: true +api: eJztPGlz2ziyfwXF/ZCkSpKPZJwZf3mlyPJEu7LlkeTx7rNTCUTCEicUySXIOFqX//vrbgAkSFGHPfab2V0lVQkFNPpCH7jvnZRPpXN87XQymUZzdholc+l8ajiekG7ix6kfhc6xc8ETPhepSNiX+1sAORG3fuhjZe/k4QuTsygLPDbnqTtjnCEE83IQ1jtpOQ0nikXCqYkHGGOEPS2hApjY0EGe7p0QfgBslSIA+qHCMXOqrJ4uEQeQRPwz8xMBhNMkEw1HujMx587xvZMuYiQh08QPpwD5vTmNmpruaZXuQ8MR3/k8DrB2X/9p1vxj/mxE+EnxJmT6IfIWyFBZGixlvmTpTDANyGK+CCLusTRicb3GGwzkc78es1maxvJ4b+83GYUE23KjOTDlRmEqwhTp8TgOfJc6hsCwzFKPn5KwF0QIGOEhixJPgC6ZGwWBcEnJ0S0bmO6VraU+eWxr3Sk8SfjCsXQOJhHFUJGIOOCuIIMBEzh29mx6DecbDzJCwEJxx+w6VLifCrBxS7icOLHIJFhCINhfR4PzpuJcpiJuMJmhri2IV9zzXrHcri3Oo8lvIBv8BgjqER5cJAiY+kJaZpfDxXbtw4M2m5i7X/kUAad+Ossm2Ht74hsP49l36qwmdarzBPgn6zQFE2yWVYr8Fh52ywMpqETG0J9K3kPwhSXjHoo0S0Jl3NWYkcUeTwHdI2y1pEPH95YJXoY+uBCbZr7HfA+Q+rcL6Mo6BlrOE3z9scFEVVW5PIdS9ImNXJ0tqH4DYUSHxEpEqjQrUfOVtL2mliorm8c6Dk5sa4FEcBeKZLnDFIY6xgbYYAzVjIywdQPq656Pe+N/sFJ1j7o0pZARZnNMawYQU1ohQl66gm9sTTZuwa4kZUuKVSjiGuPTdudDLrX6GBROanl2s0NDe1iOS6vDheR+EEd+mO7JuImsyT0vmnOfOlkHzFwVKGsmhfehJnX1fchVIKKiKVkmV7kau5qJUHwDjUBoXUCwnQOwkDqvNahN+6IHCZCDs4OmshSTX45KiuSb7wosS4QLCQaqeEr1Gh3EdTdLEtB8sNCM+CnqOs8F29riJUlrGSO7Ca8Gw7+d9gdXrAxwFSVfb4Po7iYcDS6HnW6lehRlCcVbY6sGDRSpBmWjtao3Gu3v5Oh3m3Tei3aX//vYtlKJ87A0ErGpF0CIqRfGWbraCchOfYSRzKRKtFcXbDoV2tKbfihTHoIlK1nWGOh2vQFICy8h6i/SB401/mKlPKRfiuKj8bB3/jNbATYy5Ix/KPCyU+iyLVxiS2J1ph/wiQhW5OlNKqaigw1K7BOBrXI04VuXnttmdOotALvvMunygCdK6ey134KQBWqZiARGtMRMg+FQq8FE6rbeqNDpwkB9ImB6IcHIgaYdbVFiCM9QCmP40AxvWRBNffcxA4EX8dxK125w4dPccbUXdwMxB++Rqx05hOEvqIQ0ITT0I/301GpreesLuaYmNF7pod0CoEhp4+7fx6xSOxbfU6gZ/Pxzv7tUF03B5lS79rDbrmvbhlh3E37sncCIqlr/0fdAETfhxcfB+RLyi1kUAu7uWbvXr9Z1wQgCCCXdfrezxPFI4BTzJjxpj5eQnoDNY7vOuDdYYmekZqY3YWfQvzw7H1XrO1GQzUNpBScUHH4q7eCHVgR8Konhg4SD/0kQzPLENHwgf/SbmIEvTbYc6zSJdV1usYh9D/55609p5lQ/D62GHKdDLaz8k5O/N2EQvDjmSYp0nFU+rNlR2Oqi8c6+trEvmi59FTWD67FwZyFMhQMG1eXI4RXds95Y/iZo9AI+73tq7WWZzkhQ1LPY+zUHZxTzSsSv7y10KuQ4w+4vl71hVy12PX/EX2JLAs8vlF00rS2ySp5IdGLpmExZo+NONYsWOVjncB7AtGUeef7tosjD3KwKun7sUyqRmKlFwsG2YNh9B/JVZznV9Zc4ERKb6hVEK5+3qotSTpIFQq2URckaIYYA1kcpeGCgS4O+9vkJ2wTcDr2bcDDcCDdIrAgMiOHXYFgOmqp04+jw2bmyDWJoaw5XxuD3miEGVa8ZU0iaptUndBr/CGUZKHQxAYfxHFqFpJAlvBbrpWAiQYDjPAGmQrPvRNwKmCWruTS3BrXs9WShv1CoNyxKTL0ZySBEaoelN7hQc35xOS5rbJSzT0MviLv97ln3fCWUcTprUQeRYh5VDcsdbgq3Wdp5TubsDi/qsbtVf9XEVipnTebrSXPeCl15HVsNC151s94iCKtLh6rLsDNdV8Rpi32M7nClpfEoolrKxk1o0a2Q5OXOp6IwNw5amoGOANoQk6SOBk/LW3qZ4sFsKW0MR51oDqh9GYW1Ean7C9sCvPvPjAeSsfEMF5NyEGZ40GXa97SOeAizfJ5MIYvitEkgDj9dAFEYhWxB9DxKn4MuhISCcmewDWUASSEBriMsBU9oPc42xgiKBbubCYoofoo5RSFCKKPy88H483Z8gAYMKxhNtmnSC90gA3N4JOvgEMCuUOrm4cL4EfEsNdPbcQBMGyZwWLmVec3jdKFobNcATUO1GV1tAz8Ce0jlFQ4KWAd3B2XeS1wvBMB/CKNGDjyMqFJmE11r1vbQ4VVRS2k4Vytqm0vRhDGFBHa+ma7ejkOQqGAS9LZVo27obRBKAMTzi7Qdd9hJmkErf3V/gR80E+wM8IucAT565/oXfXTP9C/6GF3pX/TRNb/go5z9ftkm8e0i3i7i7SLeLuK9eMSzh232DIgsrH4GU6Lxq4GjUW6xZVAPpBbxtROo9W51oCPlKS6EK3ENks/93mi8FhNNyKrYQkZzflSkVmnuLjXziRwjjduXWVs54WqtmHrkCPWYfDuUa+doa/SAGrgJPwwG/W77fAXMhygKBA+XN2oajqVoSm/laVvD0RUa/+/c2fn/tImdUWxtFHYIyKvzGFBz4o3jlhOkLgxTeYPyVLEbTiHBi5q5ITV4gdW/kpQb1v+GtLyDWy+3t3jyYfVKjwZYs0TXJQgWJ5GXuaAX6CpeLNMtL9IpjPWRdazXgxQMHR8UCVkCZBCl7xwz2EwimMA+4nq/CwDAlNQC5SSI3K8tWmy3RnXdnPhH3xOMnfiST0AXzFpiRlf7OLiqazSaRXeMdcO6Nie9UftDv5aWprKSXPd8VUtFahVJvW5d13CodvBvwsEFru63+3VAg1itpILAlx/OeuPPZ93RqP1zLcJRNpn76ZmQEqwzbwBZt3fa67RpB2FlK8i4/q0+FYcbDuPPJ93T9mV//PnXdv+ynpxIT8Qtz4KU/KUaLvxpGCXKCeMsiSOp3E9Hd+xzjO0f6SiK7hgM6+f6QysOF2O1ehC8pIOiwJaRtsAq7JeTgqa9MSXs7PK/xy5L+59F+Cttf5YDYTuZ+GnCkwWb89hM1zBpU2iFJpk+Djyxc1GBu+6gbzkMe5YUfXN6pGq1tZEegV5BmMVGlYMdrgv9gGF7KObRN2Ft7m+BXQEC5hUHDn48ONg/Ojr86ejt24OjH4/e52eQy1u5L5hZlQI25NauTqkvs7+X87LFDp+1o4emRue4ag57dFSFWS3Hkza1553vuGQGid3rh/uHb5v775sHh+PD/eODd8c/vG+9f/fux6P/ddTOIk9x7RzaNVN/LjYsnWtukGPaTvTrWD7TNYbngMNoZS3jOa6X49ww9eLnhob62DoQQlLv6g6ut0MmkgSGRDTJtu9mRC6dM33UufVNoQSiU9CJPLHpuspJAYn9q4K2fdvAmPLSBYguCqOjvOl1PIno8cSjk7dKWnOin2ncalK+MRjCWJEHNePRPpUbevp8LlOlJUsSYfNytOkInWqGp/Xoa5D4U7/mEF3fqmWzKPAkg0QifUy4as6GQ2TM+GT6ikW0cbNxWuJMZ7SteNMcofmK7zVHRfEIi1EGd9MM5mIIaFZsVBdozZeYoCSpZqEEtIEbpOOsv2JSeA1PwfsBTn3s3YmJU0kMZ8bOcKcTJtWZrNgqnkmYisR2eig6elfd1SvaoooS4At473mbrH5sIE/IY5XPHmzjszxLZ1Hi/0vl+p3n7jx357l/uOe+3cZzMykSXLyY+9D/uFixc96d8+6c9w933nc759057855/y2d9/CnGvVGEZvjwQA9vZWPclHbUbbxkO08o+zb1dOvps7Qs61BaZq5WJ3Q1fOKZfbw9DSewh6JBG+jdrewjF0A2QWQPzaAlN2+Il7u6NVHREwrllVvjZbE/Mn19t+K2x/3xRF/d/iDmBxNDg4m3mSy/8N715u82yS2HWieLjxFqB9WrMT5xmul8lrVZ7tBxS4m/PfGhD/FoAL5EGBN+EwG3gy7BAfFk414VS/DJ2auHRkf06L8MYwyUPhPeEfsexNT9BSMTQer5iTyFoYMvZOEWk/xfBpdqALcdElubcviBRvCgITmIp1F+WNUTvHyDV3GL/Y45N7yo1cOCofxRtHPErwZaZ5bugfeeJg+tHjst3z9VEgY3VGfTiA6ONX9OWM6aGAIQM6uCLSI9cSnvWDqBEJubTNijxhDWYvZ3NVYRFnCFJoGxg59w4yK6fBouHglCbqFfdlYkg/kukyCh98vi0K0QpY69a2lBvAMOK2IiCJ8KmxxhPFeUV+yyCIH4OLw4RKxAYIdsg+CJ5Bp0uirCNnrv16N3zAwOjzeKDz96EV+peoCTISu9uX7t9iIjtMkUTZVc+J2aSmaBrD4TgfexB4Jwa7NczPnEA6H3dGYVIqNsFjls0+vTe944psIMO63Ck2i4fleuAca2uOldm/obM88SvBGvwoMeLLoJmyyEz9R91QlwWgR1Ub5dWzk4pZcT2XiLwZbU2FrEjb5psKFUu21G9B9RxfSO6LA08uorScTV/iaFr7mNAHDaSLWKg/q+QPio7yB4JpeezIfJXwUysp83IRXMx/fICs1YyqMmUf4esydRZEU/8MYmg66wTU+eCWezNYdEm2SRzQP9y2Wmopk029mUhB/fXCMUBkTn+AzPZS/IwaB01Mu+YV6Fnz+Cx3Z/1KSmYqvYTyAkF7kyifzjASbSLCpYoDU/KtBHBoWpkGQgeKAMoBO0f8UCTSjVtxTuGqjOqHfozaYGlxgVV3WjI/Vj+MiwOkvRhUIncNAGMbhYX7SA34zjQvTaUlZJrtXNbjML57ZCyt6U/yatrT7/meTFyVuFwP2QRgsnjtKr4gkf564+wdFvF2k+U+MNHpQjhPfYfHoaPeZX9cEY7antLYLfdCjwSWPvZR0uEjSO28UCcxLBsW+gY0IGEzpIBLdbJ7RtWJgW/AUR5YNtNtoTn4OM2AMLkJfiJnSAahEPYo08emCGBsXlDm5oxq2otXgb5mpC/T4XNeMh1PRYlcwDQxd6HScfEPnY91vYCnE6Aj6/QLNhp0YU4Ih3XyeweSB3k7M5oynbJO9eb50MxUW3SgMhdGFutGTtzIxAg0ZRaBlAAFzqsHtSL2LZ5nVBlpgVWaJF1SPvZivaBhBhiLQb4U0KpOCTbjBlpszEcS0NABs4RmrgsJZb7yEEZCF6qpaK0qme7qR3ENYvEAAwivzeds6aO03aTIC5XEkU5hPWsgv6p/JXXqo9r5YK3qWJ491msL5xR6YrFp0yNR8R/nWtVOda0Kz46UHj8GvZiAVwt/f46lUnH09YDG4cYLT60/FxIo82VOHjs17rGsEfa1PDXtvWO3bybVCmIWscGEFBEc/VrP8YPPDJ2gzE9zDhz/z6XpH8dCk87pWXKku0uEEVLVo0ysGa2Htef1Fe9z5CNAT/bbynIZMTsLvoBD/PXZu4K+DLwko5eM7J1iOrx2F00wtyCjEZgBWN/7QH9ANAPZ/alYSsQ== +sidebar_class_name: "patch api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Patch a form definition.

+ + + + + +Parameter `{formDefinitionID}` should match a form definition ID. + +## Request + +

Path Parameters

Body

array
+ +Body is the request payload to patch a form definition, check: https://jsonpatch.com + +
  • Array [
    • property name* object
  • ]
+ +Returns the form definition updated + +
Schema
    owner object
    usedBy object[]
    + +List of objects using the form definition. Whenever a system uses a form, the API reaches out to the form service to record that the system is currently using it. + +
  • Array [
  • ]
    • formInput object[]
    + +List of form inputs required to create a form-instance object. + +
  • Array [
  • ]
    • formElements object[]
    + +List of nested form elements. + +
  • Array [
    • config object
    + +Config object. + +
  • ]
    • formConditions object[]
    + +Conditional logic that can dynamically modify the form as the recipient is interacting with it. + +
  • Array [
    • rules object[]
    + +List of rules. + +
  • Array [
  • ]
    • effects object[]
    + +List of effects. + +
  • Array [
    • config object
    + +Arbitrary map containing a configuration based on the EffectType. + +
  • ]
  • ]
+ +An error with the request occurred + +
Schema
    messages object[]
  • Array [
  • ]
+ +An error with the authorization occurred + +
Schema
    messages object[]
  • Array [
  • ]
+ +An error with the user permissions occurred + +
Schema
    messages object[]
  • Array [
  • ]
+ +An error with the user permissions occurred + +
Schema
    messages object[]
  • Array [
  • ]
+ +Too many requests + +
Schema
    messages object[]
  • Array [
  • ]
+ +An internal server error occurred + +
Schema
    messages object[]
  • Array [
  • ]
\ No newline at end of file diff --git a/docs/api/beta/patch-form-instance.api.mdx b/docs/api/beta/patch-form-instance.api.mdx new file mode 100644 index 000000000..dd2bd154d --- /dev/null +++ b/docs/api/beta/patch-form-instance.api.mdx @@ -0,0 +1,115 @@ +--- +id: patch-form-instance +sidebar_label: Patch a form instance. +hide_title: true +hide_table_of_contents: true +api: eJztPWt32zayfwWH90Obc0z5kTRJ/WH3KBKdaCtLriTXu9fOSSASkthQIJcPO1of//edGQB8ibKU1Nn03lV7TkuRg5nBYB4YYADfWymfJ9bptdXJkjRcsrMwXibW+wPLE4kb+1Hqh9I6tS54zJciFTH7eD8DkJ5MUi5d0es+fGTJIswCjy156i4YZ/id+RqA9bot68AKIxFzxNXzAFuEkGclNAARGQrIzb0l4QdAVmkBmC9V+4VVZ/GsRhYAYvHPzI8FkEzjTBxYibsQS26d3lvpKkL0SRr7cg6Qn+15aGuaZ1WaDweW+MyXUYDfjvQ/dsN/zD9b0L1XfIkkfRN6K2Sm2g98y/yEpQvBNCCL+CoIucfSkEVNUj5g0DP30ylbpGmUnB4e/p6EkiBbbrgEhtxQpkKmSI1HUeC7NBgEhu9KgvFT6ugFkQE2uGRh7AmQInPDIBAuNmThjA3NkCattbH40tZ6OHgc85VVkjcoQhjBh1hEAddqAkN/ah2W6R1YtzzICAGT4o6Vv6G4/VSATpc6lxMnFlkCOhAI9rfxcGArzpNURAcsyVDSJYgfuOf9wHJdLnEeTn+HvsFvgPDxGw8uYgRMfZGUFC6Hi8pfHx60ykTc/cTnCDj300U2xdE7FLdcRovPNFg2Dar1FfA7yBR0KRUlaY4v35z3JhMHbWBjI9TDLk950Q5UzP4kVvYxDohNL+H5QL89Mcaofj63To8fHt6jBAprnfEgEfQmiUBDlARPwLLWjGUk0iyWyliqfieLPOiN9yW6XxkTy40FIVij2VEfjI0imQb6d6g4SeLPJTFRuJCTo5Pn9tEr+/hkcnJ0evzi9KdXrVcvXrx++b8Ahjg4sGohVjv1l6LQsUZnpZnBEdYMv1mt98Vv6Eavq7Q/kz44GeZ7ICN/5ovY+gqH9xiLyocqiDoTE3ir2KhKT/eFTVcMGzIhsyUjVbqRV8PRL2f94dUH5+9O53LSGw5Y2cd2jBgQ91UYf5oF4Z3zWbgZ0ryR4+HlqONsbjIOs5g0HGliZFynBx8VFgyUhawaARslg6htlERjq2/TnfKQ4Afr4WHdfW32Kgn3gyj0ZXqYRDYOVnLohUvuo/s1frWRCeV8IrDs9eF36L2xpCX/7C9hnPkyzGSKUQINAD7x1CiICwFlCg0kAwWfg39IWqw9w3lJukAsCA//B9pg1R5ilYVt3vlBgK2X4a2gWMpZpz3oOH2ny8j3MZ7BHAjcg8uDYNViE2iZJYCcWsqQBaGcw0/AwacQDwAFiAYGX3uAJJsufbB5CA3sCknX1RpYU6KgyMgziBWAc55zNhcSYwtwB+1Ux2PhQgRt8CCvmz3IY5aoxI0Dgmx1QqliVbI+MGeV72aAXPOGB8i27yoWl6Hnz1aFnL0V0FMyXPvGzcTG9SMfPA6iBqWCXsPUQM5ZmKU5sFUK3XW3H4EMsbnRi4KzVj26WnEWCBXyw7jBnZumIwDrY694YKDJPZHbad3I9qDLtgG3pXcjh6OtcMO45GAAMfwajqreRL3d6j6enKuywozKksOADL8bhqPvJ2Su9LlVHrbqQCTkiyaNkaArZr4USjvI5QM+5ZbAMFAzEoHTR+G1WC/NDUaAgwKD5KBQM5hloo2RXWuzi0CbfoQYop6wU89gPmq+A8Il6hBCpMJdSJQHg1nJMxjt3uDiclKV2Dhnv4f4biR4jnNnsBHKUfhLI01I4bduWB1w83KHQX9S5soDXnzH4VbjtT5WCorZzJ8pv5e3QnN+jK2DErwaZu1akD55/GIihUOGg+m6Ikpb7F14J25FfPBFRHUvD25kiW6NJK8OPr2SuXIAB7GAgQDazE8T7Q0q/tgTkLymWpqP+V8dix9MPrzVHXUguvDYh5lqo0dyfmU7gDv/zGA+zSCaQcfdHIQZHvQ7bXtaRlxChOTxXKQUigTi8NMVEB04uxAdhOlT0AWXUFDuDHehDCApTEseI5wIHsP8oEIYxjkRMG1fCPIoEJhdgwihjMgHw8mH3fgACRhW0Jvs0qQn3SADdfhC1sEggF2hxM3lytgR8ZxopnfjAJg2TIB6ne+kXssoXSkauzVA1VBtxle7wI9BH9LkCjw9Yx1c5kjyUYLMnOwMp28AA2EBgLgM6SPMxvRXLY8EDV69aikJ52JFafNE2DCnSICdWzPUu3EIPSqYBLnt1MiR3pZOCYB4+i7txh0OkmawFL+cX+HHwIH/dIb4RMYAD72B/kUPzrn+RQ/jK/2LHhzzCx6q0e/XXQLf3uPtPd7e4+093jf3eOVpWzkDIg1rzmAqNH4zcDTLBUbGk1Fv8JY1A41VF1V/iIRemU5xMcJ01yD50O+NJ49iooSsjk0yWl9HQWqR5ubSkE/kGGnevs7axoSrtSH1yBHqOfluKB/N0R6RA0rgRr4ZDvtOe7AB5k0YBoLLUnxT8sWgVQiawls1bTuw9AeNvxrJciRbo9l30Im9UuysFGUXkH/OfUDDxh34Ho+FasExb1BNFR05hwAvGnJDavAN1mQrvSwW4vO9tvpyT0LrtbMZ0H5kpUcDVNZ6aku7BIHLtF7mqpV8XizTrS/SKYzNnnWi14MUDO2Cilgt6ZoF3hwz6EwsmMAxKi2kgiqpBctpELqfQEve9bqlWZ2TE3/ne4Kxrp/gAi8pou/pfUowtXfDq6ZG40V4x5gjm9p0e+P2m34jLU1lIzlnsKmlIrWJ5Mj59bI3amw4UntsN3J4gTsN7X4T0DBSK6nQYdoB/HDujMftt40Ix7jknZ6LJAHtzBtA1O2d9Tpt2s3Y2Aoirj/T23HQ1Jl86Dpn7cv+5MNv7f5lMzmRdsWMZ0FK9lJ3F/5chrEywiiLozBR5qe9O445+nYYRfifHhh06wP9oAWHi7FaPAhekUHxotxHfFtnvxoUNO2tIWGvl/89elnZminc3wNtWc/8+bojbMdTP415vGJLHpl0DYM2uVZokum6hmk5FhW4myoWqm7YK/Wiz6ciaKqWafT0CPQDuFlsVA16bdeFcUC3PRK490YRRi8/b8euAAFzsUNdQf/6+Pjo5cuTn18+f3788vXLV3kxhdkhV7L8hpFVCWBLbHV0SP02u645L1u4qO7rmZ1Aqt/A8ojm4pWHplIrbFMqgeAY6W9hiNSevVnFBw2kTdFUbaZ6upGPW6O41m7/RRsJ6HN5UO/Li+rVadMm+ZV6SP0xfcN9JepVr6EI4qwK0TU98r3KZoSXg6gdT1OeQBMLvVX5pDUTdb5Mb7Q1bNixNV9L+7Uln1Dq0IHi/I7q9nA3G6bZEXQph/FFAJn4LA6XeRtbO6WNu3tNRSZn5en6BgN+uhoTTah5ElkSUGkThd3IifP3Cat9nYjPkClMhm/f9p21b+F8HgjVrj1y2k1t26AgNMnsOoP6dwjlIIgbefFuOFhDfrEIpcCFqHavX//mgOFj8INMqrPG8Zi2RyGutydrSMEeMAZCK1NdUmnoqkDXGfYvzwfj+vdOGGRL8BXFPAo7Dj+VdPBBCwIeVY/hgTpHa8HQEZoeIdM47QL+6HdHT5w02ep0SZN4tJihNNiVkLmrF1OBQW8yt6reJ1Chz+oWXmiL3+kY61ib0u31axf9osgFIaEh+ytn+F+58/qLWOnM3cxHG3a1Bfm/Enu/5eCMfF6F+PV9CZ1yOSaBUFW+Tx/l19hKgOdvNKMw9QHb5xN5TDIxKo7DeFOEom/1lSeKsYUwmVBQefgJeJKaWrCmOkuYEtOKL6g21XUhVF68qkq7Wqw3a2i94F4DYSob89MiPuYVY4ihN2AXo+HbESQfumzsbiFixZsbUFETlqnlVQPwPhEa9ebo2aj6oLYmllfWuf6QESxVUtQwQjpdUuPDAr3WcyemLRo3/VnZgtVQV12F0js2IGiPxx5rX/SUEJgp62WaE7VEvjU1CULofUNg79P7fM6TxTEOgXpbEZSQ9uV4i4x0MxCTIjeM/bkvNxFVX9kixNkSpHWJj+mvWkFF0WH+TQqsWERdNWVMFc50frkTb5ojtEsIBE3u8nNqhMHdNAONQUAztVNDoCVfYYJSVmWZBLSFG6RjPV65XvganoINA5x6OASV2uJYjCo+st76m8mu850/LLgOXZ+m5moXif1SM5b//AJs7vZ2caXKSWhHSovsX5qXqZV5ffRC1c8ZD6tKqmhqQ9m4kmtl3kMgWLg/5nopeFuupZgEwE3T/+LsS6XefJ5BjqUzghUuYeS5VO6dv0VSVT3YQ9WpflOR/7n+YvSLQtAjpf45pm9X6m9YokJMUz/bWBxrvhWbJ4kJXkXhLVW+IRMqNS8w0gJ6uggTDGwh/dIem7wbLqjP/CAw1bp6TwbLGHQxNH7x0y9LFP9kpxHKqpLLs0gbbyAldwaT3uQfzZA9Yj9dlZIm06Ca5+Rvdyn63JXkf7jSP2dh2+5SobNYW4rzgnYAUzbEVVp61Md/6r5tXIFXozRVe3VsFvA5KrgvPVy2FapE1LgTfTwRlzluoWvcKDFW9ieVGv5bn5fmLEhLYbjsYdWwxkOIQxmsqhgBz1TkqNR+l4qly6nwPLUTVVkn0t3UEps27jtWe70ut8s4aEhkqiCjvnFi+GjmqkY6S75aY5zW9ASeXaJQWnINWaJcdZOMKpZqDiIuV3YYz1u+1k4Z3pGOZf6hd6h06wlseq3DWlBpU+1yapy4mruHDWnBjWyPx723A0geyopOTdv6TBfuj3/I84A1sJ680AdUzObDpAmb2nBIEV1neH7RdxqhOmZwAIoOrPQbofApCFQMMkcLdD+oiCFnN9/EmtCXnDI+G/y1wwgFnq1+6v+67GqalX57/6nSISCDhF40nXNs6zm5mtaWjwaHLmU8X3TQcdsWUAo96ISe2HZSultA1vLKWhjYZ4r7TPEPZYqbUkP04VlS01U8TzanmWM+x4ZXL1802LZuiyKKgS/gXe0SPdodA9kli1U2e7yLzfIMptWx/y+9H7O33L3l7i33e1vu810sl04Bg57q473J3nj3xrs33u9vvC92MV40AyZDPF+Tyb3F7i12b7Hfz2J//pLkVmvriiqZwE7NgackDfexd2/Je0v+jpZ80mDJkzBkSzyPqQ04+SITLRvKLhaym2VUbbt+6Yj5VpRZFNqgJA2+x0OPhBeN1TSzhxfX4GU4YxHfQoLg7KAZeweydyDf14FUzb7WvdzQ61dQmlZbdmh/dr2j52L2+ki85C9OfhLTl9Pj46k3nR799Mr1pi+2dbvsaL6+8+ShftqwkO4bq02U1aox2yf0e5/w3+sT/hSTCuRDgDZhFQOW116CgeKFEljvnOFto9fvsa72s40ReQ66pX2TPQ29lcFKl+qikFO8BYAKfa91deWjLYtrTwkDElqKdBHm9xVb1TtPbbNZnBzWb0S2sB/oWhTtDPfo8w3xe+CLy/ShxSN/bVt8Kugi1Zp6aS1BXUIAsmtFoEVsxz6dtiN5E/JKNYWV68SjmM1tWKswi5lCc4BuQt/jR6/peg65+iEh6BYO28Fa/6Bfl3Hw8Mf7ohBt6EuT+B6lBvAMOK11EbvwvlC7Mbp2RX1N+Qp3j9s4J2vEhgh2wt4IHuN1lOEnIdmPf7uaPCvd6qjKJ/JL6y5ARegyxfyEHDaiA8txmM1VLtyubBrRXBWvAMWTK2Mh2LUp/BmA5xs54wmJFBvhaxW63v9oRscTtyJAF98qJImK53vyECR0yCvtnlGdzDLEKzql8gHwtnUjbdb1Y1XXT2UkpovqKOJ1ZPrFS/36Wib+x2CzFTabsCXPalwo0V6bAmyI5IgC74dBaX01cYXPLuGz5zEojo1Y6zyoqiLio7rV55pR+2o+KvjIjVX5uJFXCx+vq640Y8qFmdKlHnMXYZiIvzKGqoNmcI11mOKr2bpDojZZhH1yVGLJViRt384SQfz1wTCkUiY+xcJBCtUhm/nSUyb5kUYWbP4jVRN+rPSZXl9D6EdIL3STr+YZCdpI0FY+INH8q/kaKhZGPOiDugaaFKBTjD95As1oye8pXI1endAfUhsMDS6wqq7DjE7Vj9PCweknRh8QOocBN4wzwfwsLfxmGhdGzoqwTCCvS3CdX7wVQdbkpvg1baks9c/WX+xxu5ibD2WwemovvcGT/Hn87nfyeHtP8//R0+j5N+a4o+KvUzhP/IcYQJnL2WvZhN7o2eCaxV4m5ggVfE1Uma+6L7rYLygjAgZTquaku2MXdARLnW7GmeWBueMb7BySXXQuQm8qzOlQdwwC4QGf+nQFH5bGG8qczFFNW1Fr8HeSqSMWWEW84HIuWuwKb6t3YdAxz4bBx2+/g6aoU2kw7heoNqxrVAmmdMtlJoEaWj1ef56ybfrm+YmbJbp4WUphZKHuTMtbGR+BioxdoIxfxMtkOMMVSx/v9rV2pAVaZVZzQfQ4ivnihenISAT6bOVBLSnYhht02V6IIKJVAGALqyELCue9yRpGQCbVZYCtMJ4f6kbJIcLikSHovFKf563j1pFNyQi8j8IkXXJZQn7R9PdU1v6iyX2xKPSH/xaODlCYWRyCsqqVhUxlOsqqrq1qhgmNTquUsDp3AX1B2Pt7vO0Dc64HfA3GG2P+/L5Ip8h+PXWZi9dcX1/u4I/6NhbvGTur8b+JfbNOJVclJ2DpA731v+Lz8B5aLAT3RFxKzjuKvk0nFkqepL4ChymnatGmm6EfhS1n8RftSecdQE/1n91Z0iTJivkdvMT/nlo38K+FtzPnR4TpPZ4Hl/NMrbYoxGbK1TTj0A+4XPHw8G9CEO7u +sidebar_class_name: "patch api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Patch a form instance.

+ + + + + +Parameter `{formInstanceID}` should match a form instance ID. + +## Request + +

Path Parameters

Body

array
+ +Body is the request payload to patch a form instance, check: https://jsonpatch.com + +
  • Array [
    • 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 + +
  • Array [
    • rules object[]
    + +List of rules. + +
  • Array [
  • ]
    • effects object[]
    + +List of effects. + +
  • Array [
    • config object
    + +Arbitrary map containing a configuration based on the EffectType. + +
  • ]
  • ]
    • 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 + +
  • Array [
    • config object
    + +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 + +
  • Array [
    • messages object[]
    + +Messages is a list of web.ErrorMessage items + +
  • Array [
  • ]
  • ]
    • 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 + +
  • Array [
  • ]
+ +An error with the request occurred + +
Schema
    messages object[]
  • Array [
  • ]
+ +An error with the authorization occurred + +
Schema
    messages object[]
  • Array [
  • ]
+ +An error with the user permissions occurred + +
Schema
    messages object[]
  • Array [
  • ]
+ +An error with the item not found + +
Schema
    messages object[]
  • Array [
  • ]
+ +An error with the request property conflicts with stored + +
Schema
    messages object[]
  • Array [
  • ]
+ +Too many requests + +
Schema
    messages object[]
  • Array [
  • ]
+ +An internal server error occurred + +
Schema
    messages object[]
  • Array [
  • ]
\ No newline at end of file diff --git a/docs/api/beta/patch-non-employee-record.api.mdx b/docs/api/beta/patch-non-employee-record.api.mdx new file mode 100644 index 000000000..36c3beea7 --- /dev/null +++ b/docs/api/beta/patch-non-employee-record.api.mdx @@ -0,0 +1,123 @@ +--- +id: patch-non-employee-record +sidebar_label: Patch Non-Employee Record +hide_title: true +hide_table_of_contents: true +api: eJztXGlvGzkS/StE74fEWbcuy4f0ZVdxnF0HHtvrAwHWCTBUNyUx09f0YUdj+L/vqyK71W3JVybYmQmUAEYfZLGqWMcriuxbJ05UKnMdR4e+M3QSmXuz4zg6CJMgnit1prw49Z1NJ1Nekep87gyvbp3LTKX7cZSrr/moyGd45mg/GkYqCIehjORUOZ/vPm86uZxm9BIE3ZKiONIT5c29QImfuGmootxBY19lXqoTYgWMXMx0JlL1a6GyXNzoIBDMmpAiAjFVEkuZvxYYTGQqQ5WrNGMWdWSkmeFVhBe40yRHc5TjZVpC++L15eXhuw20JgZ0qqCZPC3UpqO+SrQmYj1v0N3r7I131KTr97dUp4ursex4qr/bGXT6pDJvpkLpDG+dfJ5QnyxPdTR17kg1VrS3sT+nFk22RiLQEDueNIUtEl/mSlQzlgnpEcsgKvJY5DMlrj6cnxyLU1LV59ezPE+yYbudx3GQtbTKJ604nbZneRi004m3M+j0NkSWy8iX0KEY5eBvXOQKdFNSB/Hr5coX47koMOWC5GiJk5sI12Aui4vUU8KTUcmainxBF2iUTmWkf2M+hfRDDW5rDSUmVF5LHcgxDGGiVeBnrRUK98jKYB9QkUySQHtMsP0lg17YIP5Ol/R6SdsyTeUcJHWuwqz2PB5/UV6+ZAojQapjzYmTUsNCZsJXEx0ZJVydvd8XpDbhipcquiHcFdyObRb2CWNIUprTXCvmE6+WbGbZPWp2QJM/VgK3kzgNFZm5ioqQhpG+zwOH8bXiiySQHl3ZB16ckI4w5+yDC/suW95ZLp/kaCTMC6uYWGPiUhhRAjvCDLKNgulcplOVkzPPiG1YhAo4BFgh5ATRwdpcXhfSqXPXro8NFq9lUCjWXaROJhwA7nO76HysbkS9P8TXeVB30M2qO0kxVWm9/1ans+hRvq91qeyrbFM9qEjAmCtfozsboJKZDnSC+FCjVlpxSczc362Il0qwFqwe4a++gDk0lbgpShvkd5/IPj45mAUf13bKcb+IMI8qDnxWfH2AG7I3VL7Dr6vOV8auaxZozMppI2a8Q0hwarPY63QHbmfP7W1ddPeG/c5wa7u1u9v7rzOMiiBA/CQVgVSWgEWjwl6nsyqOcoyAtA8kjUfCy8qYUk1l02ORWVb4BzmjBG2HssnK1HOwlHpaZM0U1YsoP2areMrvzkwiUdSb/CyfC9tfkFkxwYlOs2eSq7P1KhPc0xKqm8JHZGQtQyIeyG+kTR1XkD4PNQyDbCdEfngxVe7VpHhjmG1lRPmf9nnLi5n9ZIaY8eJRuFdzlO3qH5E1MCh9XiQvJ+zwHaVVSY6sa/MJj0b2vVaUjXLCRXVrBjN2rCY7XyQY9GOO4CZRH6600kfFtBle+03aFvxs7+x5272BtwPws+d5cmcy6Hjdre4WjYk0v9JzEHE0DSaD04YP3cNIS+mlDJhiHMTj9lhOOYI14SAbOwBNmnNEecwnCYW4uQ7V445pKHN+YroG3TSV0QhW273h9qDV3UGwIhO2se37clKhrHt89DoP8RHGvgbIejxMPczIx5mKOJFUgFxa9y0JP18lXqowznflxJJ8jIdaDqlnreVK545TS39VNtkPNGn/IE1heK44U3mREjDUkwZHY0B6ASfVEbvxd0wzvsoR2/Zj/xnx6j0wqztNJUNXxSx76ChA8VpzxRDGAPmGJEUdEoHbNdUITbS64q30hU00Yt8KQ2pMpfcLaD0nslxG+ldCJ7YLlVklPFkxrNpVcrzTGfT6k52+lL29fnd3ezyYyK2tzmB7MGCjVlmGuFePHiVaag79L4WCRXsiiD3MyG9QCAwGumcGePDHyoTmHDCNZ+ifwrppW4lp+RVUNm8icr3dPxX9XfhRNC34uZzeU0LkXp5T/QrQQ3WSKYoo5TLhk1RPdbSKlRL9vzt4P7o8usCTs4P/XB6c44poLYHHUQRr9cksYy7sZvENc2wFIB/LANMJl7fEG0v1DQSSUVZvqM1dNgceCalwkkWQo4cdfUWPOmkxSeOw4UqeWWMQr3VLtTYBaynicIU2loRvYxML3ow8TyW5e2Q1+UbMlPRVuoGatso2Bh1TspxzneH75LqGwKSAK4MZwIO4ACaJc+3di64LVTZnYxFLjuqTQs4Bzp9RNnl5AeZYzLoXVtZiWbTzA56N5prcXdyLiNk8yqUHKVBnz6HGFAATkQmy6TwTNhzRdGUIPFHZropY9RDJ4e4nw8y7POZ3niyyZ/jdaYDw47Jo1YtrZZ0vI1hjohHPRjlNNiLZ9QzubFtV01U6vlk3WPvu2nfXvvtM373/8szW0PYtQ5/uMvS5jGQB/aacPJegT8rWE8WibGRWpcxEbgooxEKkDx8v4Ni/AMKhvfqa0ELEd8RHJpWvWAUo58M8H5drUWXqX8wFMch6NBJMEImUP2S+FxyzooyqtpZHex+nYw0DjVZARF5EnceFWV8toog4kdmmQJ2WRa9yMZPXXA2CXxMBadTIdxNaTlsjyTWSXGejdTb6cbLRGkmufXftu39N330USVZcsbdYnJQVYSjTubE0+96sd6OBKH/NEZXLVT8H1dEKERMVxnKayMEZ97rj7mTXU31f9v2drcGk5+305PZud7c77vd2nXquv1r4ceVkTZ+qzbeZR1Yxr8WnoohgXFkex35z+Q/qTdWEwhr/wFniZugcKv28wI79Zex4HOeQDYSBHdMHlhcvz46IPoZm8qQ3s0hPTsuqQ3OZM6QkG4amdZavoeMaOq7Tzzr9/DDpZw0d17679t2/pu++CDr2n4KO/RdAx74giDUhiPVHQkdf+wzNJpgUyOAVUG+ULzbL2dVH6/Z2y1wJ9BoosjdYRpEXcUxba+clWMoaK5HRQl0U3tA2pLZp2RYNpJgiREa0oVAD3ZJV6VARJqWtm4EONfsxCQS66dwdTWivn/GZ0t6qUXTkBQU45KAQxGav6o3UMCc1IfgHCrwOOkWg/o5rnHa2ftd6sDgjiY9IYnHw1VOKfL5a/91etUvgkPY9Urg4N3P9wHYBs2ZOG2Ij9TUx4auCoGuovobq63S/Tvc/RrpfQ/W1765996/puy+A6hYNPQzV0eDZUB1tWx1RYan3ZFz/d8TOrmI5YPMWscdY3V9gcMYVMKXq8JyzONlQ35rsmi3+WftW+3cOnacjdGgYK9IAzctDRLeYL8zTXUsmulXuAY/iG9qw3h5DSSviD203Nb5GDcTo9NCWGi3WcKrJiE3EY+JG3ywTmSv0zjsMHqVMO/VpIueoQoQhs0knwqxB8WOwmKCaeJWVZw/4KMs9+SDXZRrc/X5ZDKEHZFmlvkdHQ3sBTu+JSCJ8Xhx/PCfobUZfOgS5SCe06N9bGuyEmvXEWyVTOkvH+2Bef/h4sSGmBDjZ4YuMsK7SVCHAZU5hIhzQRuWeEOrEOSaNi+mMGR81dt2QA4lJAIHFp+hcKXF1aJVwjEh/htDMKqVOiqMB9VocYfPVtQooCbYWmiTD037UhobastFvgxMeVwY6Mtu38bT1KXLFO01xiE8pUhsrIhd64iop5ZI1ub6Vib+V1FxDzWVq2cY9Loxqrzyzi9uDFxMJGWSsrW8e3NBza/SojMITonqfB9KE5aO5V8orZ+2b+WjQc4lek49P0ceZpgO0jW7CBC+RIRkGvjgU3iyOM/UPIch0yA2upgW86JvZuqFBXfYIt9epseSaIV3tAhsyf0dwjMgYkxxTbmZoEptVEnbJn3lm4fM/85G1nxsy8+MrpFBq6cde9s0804AuDeiaGJBZ/k2GIsOCb5MMHAeMAewv5p8jgWW0FvcMrZVRncm3uQ+lBg+sMpUsGZqb4SLA2SvBL6h11QZhmKB1tXuMzthaWpSmGsoqFwXua3CZ3yBGdrynN8Nv9dMmZcw/m7wk8WixdnISBfPvHaUfiCR/nrj7B0W8daT5ESONBbu0Bnm2+HbBwdPne5tHrS3cXz5LDJBFpswi2Yqj7kBvLRZcXiekheyZwl+85TjAmB0VEdd4jJDqhMBeTh7DEcObacUrDImSOeHKTbLaOGQvT9KYQgvqSCY05VNmKdQhURPqAPR4DbwcWbIzGtBKNkP3WWF3ZMQwd1SsqiU+0lcSPEw5FXy0FxjvvsS28jvHrPPRefGuNCQAujAsIjoHCraLUEiY6xPW5uvMK0xQRP0XqVIXMcPKqlcZIciMSYQWlz5pmJ1MaPEadXHNqJ4YCzaV2ZVrqJ5m0R5qXwhypoLqUHmzJHiKNizZnakg4ePGYAsFZG2Enw4vliiCWGR/LqEvMdhOWZva0vcCILwxn61Wt9VxuRShw8BxlqNIrhE3H4RonMSsvonSMMTbxar9yz9eYlMS1RLthFbBiJnC1DbGj66cVdUkug61T19umIFzanV7S8slVF/d0WOwQLX41edF6cS+Cs3SNarWCeKIekSW12f2iwEb4qmvpayUolzxi+Y178flL4rWCMA8Kmmwz4s4zJp5YX81cC/mSe3TAI9+BIRKTdPZrBE90o3DTVW3n44u9v+N1mP7MZbQrEGk8gYP6e/Q+YT/uIkTY8BoxM9vnXJFD20M4RJqrUIa9gLTgWb/Awaf1sU= +sidebar_class_name: "patch api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Patch Non-Employee Record

+ + + + + +This request will patch a non-employee record. + +## Request + +

Path Parameters

Body

arrayrequired
+ +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. + +
  • Array [
    • value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    oneOf
    + +string + +
    + +integer + +
  • Array [
    • anyOf
    + +string + +
    + +integer + +
  • ]
  • ]
+ +A patched non-employee record. + +
Schema
    data object
    + +Attribute blob/bag for a non-employee. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/patch-non-employee-schema-attribute.api.mdx b/docs/api/beta/patch-non-employee-schema-attribute.api.mdx new file mode 100644 index 000000000..cbe8bf54a --- /dev/null +++ b/docs/api/beta/patch-non-employee-schema-attribute.api.mdx @@ -0,0 +1,120 @@ +--- +id: patch-non-employee-schema-attribute +sidebar_label: Patch Non-Employee Source's Schema Attribute +hide_title: true +hide_table_of_contents: true +api: eJztXGlz2zgS/Sso7gcnWVOXZTvWly3FcXaUco71Udldx1UDkZCEGYrk8Iijdem/7+sGeEmK7XgyV0qVKkcigEbf/QABvHWiWCUy01E48p2BE8vMm72NwpN5HEQLpc69mZrLYZYlepxnytl1UuXlic4WzuDq1rlMVXIchZn6nA3zbIZnjvbDQaiC+WAuQzlVzvXyetfJ5DSlRlB2C9LiVE+Ut/ACJd5w17kKMwedfZV6iY6JJ3B0MdOpUKHvxpEOM8EMqlRIkcbK0xPtiZR5FLJgUkyiBO0h5lLFXOdRnnhq5Lc+hpAhlomcq0wlKUuhQyP5DE0hGvCtJAatQGaewRncOtkipuYUreHUWe46ifol14mC7rIkV7uO+iwxJ/XpeUfd553n4wM16fr9PdXp4tNYdjzVP+wcdfrOuqTg08hSKlyMfPHk8nL08ikm28hpaiX7fdnkSYX2HbIuEVdp9iLyFzR5s/tQBDrNRDRZt1Me+xL/lR4Iq3pelPjgWWSRyDDR1evzd2/FezL69ZNZlsXpoN3OoihIW1plk1aUTNuzbB60k4l3cNTpPRVpJkNfJn5LEKOTKAiiGyIYJzRPpsl3EiUkPVc++4rlY2ewI3YCOVbBzq7YmakgvoBf0+c4kJ6aRYGvEvpaKHOnBeV45P5wXAgu4zjQHovS/imF+7Gz/p0+UvOaeWSSyAVI6EzN09rzaPyT8rI1xQ8FKYN1Id4VOhMyFb6a6BCyjBfi6uzVsSBFCFd8reqcuptcITFwpMDXYOJKe8QnmtacbJOblJYlc46VwFfoe67IWVWYz2ka6fs88Tz6pPgDKxuf7AMviklHGRyMGKkct+i5tFzey9FQmAarGEonKhEgk6gUFmSvA9OZTKaKE82M2JahUAHnJiuEnCBtZUbdWV1Ip85duz43WPwkg1yx7kL1bsJpZ5XbavBbdSPq4yG+zoJGRJfDSYqpSurj9zqdakTRXhtS+lfRp3xQkritMiBb3CabeKYDHTvLZY1a4cUFMfN9uSGRK8FasHrMUxt+DSXuisIHue0j+cdHB1bw8dmaHN+rnHGn4sBnyddrhCFHQxk73FwOvjJ+XfNA41ZOm3OCU7NhiGmqNGaaB2EeBMvl9XIt2/KDNAavRpe9Tmc9TW5M/jcI7jT3PJWmE1Bf2Orn35N3Niab0sbNUEYK3xA4FKUStB0qPQ0NS6/b7XQ6++5hd//A7Xb3O+7z7mHX3R/3jnoK5aPzfL1kbKhqFBPpIkXmq80/RnZSMlzPJdCi0BN4CrDAWhnBsznl/CxKFoIyYhA0ij+GcLlKW3VJrGXmkQ8Qoe7WApUHN9NztcbZh5kK2YHXuCLbBRKVr5ihMTucoHvkdp67vb2L7vPBfm+wf9TqHvT+S3rxEoUJfxuWLO27mOl3Bnv7rcNDw4zhYEO2svn74uTfF/j6cnhxgv9GL0/eXowu/rOO407Qf0OyBVXCBhBHEqZbZRmAQMUZW66I4y+j0wtiESzbgLyvHpxSN+HrFPG+QL6JjNouRzYrbfC1ptqGQCs56sJbSo6kKuXNQgRiwA8eVCHLIYIyLGmCWKjmE29yuBBly1ADZFEFtd7cWglLZqUVWlYK9HI/F9RTEICvaQKV7XLUnICYtTxonwwIl07K9G2n51pcYaX7J/+BID1Pns1kJiY6CFIywDj63Jz+hGu1LFhA7UiMxkpTFRpoot17U8sIGidEvDliQLdRjtZTi7axxjZZyy/LJqRiXlb9pPDX64e4OJVeEO1vKiHHgSaUcpIk4NQVZyrLE4KF2jiVRenQrb8gwXSIeqa/ZS3xVSZ1cBz5D3D+V0Cs7jSRDFwVs+xhIMH0T5pXAPMIMN2QLOKC+zUdA5podcUL6UNeI9+xFYYCMpHez6A12phLmwxdGs8qhsDLS+/eMK06VHJ80Dnq9ScHfSl7z/vdw/3x0UTu7XWO9o+OaPY5yjaWtekGxN+c+p8qVAkWskEEn9D/g0KQpKF7ZoAnv2uR0LQB03hg8jF9SzEtvxyPu4i1F8fvRf8QRSyc5vxcTleUELqX57QSBTaR41pRNYTfJXqqw7tqx8uTV8PLUyofZyf/ujw5xyeitVY7hiG81Se3BKvwhVl0wxxbARgmAaQTKm+JZ5bqMwgksaasddTmm8EdtGySeZBhhJ19w4g6aTFJonkjlDyz9SGe6JZq7SJNU7nn9dlYplVFeTbkKuaeWk0+EzMlkR+ftsTQ9zUJiQLA6JKgzIJXGb5PoWsITHKEMpjR2SzKM2SgTK8WgEqVTWtUSeW0bhSuVg8pD0Mvy8Eci1mPwtJbLIvWPuDZaG69ehRKY5Uuwkx6GeVAoFqs+RNoWCDBCZ2lwqYjMleKxBMW/cqMVYf1nO7eGGZeZhG3eTJPHxB37wOkH9fUvqLhk7LBl9IyxWQjtkZhJpuR7P4ED7a9SnMVgY96pgJ/G7vb2N3G7gNjd7XxzC6cbStDn+469LkMZQ79Jlw816BPwt4TRqLoZPakjCF3BRRiIdLrDxcI7J+xfqI9588x4bZviI9MKd+wQ1rYwzwfF4ujovRXtiAGWY9GggkykfIHzHfFMSvKqGpvfbZXUTLWcNBwA0RkWL2Ict4hTfIwJE5kuiv8SKXhTiZm8pNZk6WpyYD1vfktktwiyW012laj76cabZHkNna3sfvXjN07kWTJFUeLxUlpPp/LZGE8zbaTtFKggyh+whFlyJU/B9XRChETJcZymsjBGfe64+7k0FN9X/b9g72jSc876Mn9w+5hd9zvHTr1Wn9VxXEZZM2Yqtnb2JFVDBD3CTguD+FcaRZFfnP7D+pN1ITSGv+8WeBm6Bwqva6wY38dO76NMsgGwsCOyRe2Fy/PTok+pmbypDdzWICCllVn9noJUpIPQ9M6zbbQcQsdt+VnW36+m/KzhY7b2N3G7l8zdr8KOvbvg479r4COfUEQa0IQ64+Ejj5wB0GzCYwCGbwc6g2z6vSG3X20YW8PzBVAr4Eie0cbjjpFEZ34XRRgKW3sRIaVuii9oe+c+iZFX3SQYooUGdJhCA10S16l54owKR3jDPRccxyTQKCbLNzhhE4PmJgp/K2cRYdekINDTgpBZM6e3khNxy4mBP9AgfdBp0jU33CP01rrV+0HizOS+JQkFiefPaUo5sv93/1NpwRGdJKC0sW5sfUXjguYPXMZYhmhPscmfZUQdAvVt1B9W+635f77KPdbqL6N3W3s/jVj9yugukVDX4bq6PBgqI6+rY4osdQrcq7fHbFzqFgO2L1F5DFW9ysMzrgCrlRe7nOqew31k6yuPSPfvi0ulC3bBse51U2Q9m3tXtzSocuAhCEN+3kSgGhx0egWVoU1ly0Z65Y5MZwtwuim5UXz9hiq3JCl6FCqiUjqIIbvR3ZB0mI7JJpc3eRFJm6swpKTU8M6fA7hTsrFMesFpBSGzC6dQrdux4/BYow1x07KvVv2usuKfJDrMgmWv14WQ+gLsmxS352zob8ApysikgjX1d1NPlRsZl+7wVkVHfppoLc22Tvq1hMvlEywejCnZZ68/nDxVEwJlnJayFNCxErTOgKB9R4uwmlvWJwcoUFciZIon86Y8WHjbA6FmZgEEFh8DM+VElcjq4S3qAdnSOCsUhqkOGfQqOqam68+qYBKZavSJDme9sM2NNSWjXFPuSzy+kGH5oYFnrY+hq54qSlb8d1E6mNF5OWguIoLuWRNrscy8beCmmuouUwtfbrChVHtlWfOenuIdSIhg5S19ejJDT23Ro8WW3hCVFd54DuTho/miSqvsNqj+WjQc4lek4+P4YeZRs1tDhMmxYkUJTPwxUh4syhK1T+EINehMLia5oiiR7N1Q5O6HBFur1NjyTVTutoFgmT+ThEYoXEmOaYKzgAmMnspHJI/smUR8z/ytbYfGzLz4ysUWurpR176aJ5pQpcmdE0OSC3/po6RYyG2SQbOA8YBjiv7cyawjNbynqG1Masz+TaPodLggVWmksYD82VQJTj7SXAD9S77IA07fJ/FnjGjKxeWFhWzhrKKrYNVDa7zG0SooSt6M/yWP4BSXf2zyUsSD6sdlndhsPjWWfoLmeTPk3f/oIy3zTTfY6axkJh2Ks+qtxac3H8HuHkd2y4K1u8bA2SRK7NIdl1SD6AXFguu7ybSdvdM4S9aOQ8wsse6iVeCjJDqhMBeRhHDGcObacX7ELGSGeHKXfLaaM5RHicRpRasNpnQlO9/JlCHxMpRB6DHO+XFzJKD0YBW8hn6nub23EYEd8e6VrXEBywNQw8mp2UhnRhG20+RXR+ew+p8vV68LBwJgG4+z0PMRjGfz4WEu97jbb5OvdwkRawSQ1XoImJYWY4qMgS5MYnAd0VVMk/fTWiLG6vnmlPdMxd8KrX721A9WdFefK8EOVNBefG8uSS4jzY82aXblnxFFWxhmVmb4c3oYo0iiIX2RxV6W4MdlLapL71TAMIb99lrdVsdl5cidAUzSjMspWvEzUsjGm9fMa/wwBpn9XL2qm/eVtv9v8nLWGwhoxVIO6YdNhIhNysiE31XzqaVKoYO1l5+UlusUnv9NS4IzRkUQ+Rub2nPhpZvS3qMPEAbAlfX1cqMUwEMR5+xdJ4gTak79PLkzN7yfMq/Ot3xFpcvyFvsO4aLWnbBx58V7VTUxaCl6OMZK9/b8ig+SnUvr/mOseRLvtCUaba/pLgX5pprMfyu16KQNGaw2Te7Yxgn13Iv4/3w4vgH9B7bl87Mzb5MIm/wkP4OnI/4hy9RbMIVnfj5rVPscqKPIVwAy024yn6Ad6Db/wGF13rU +sidebar_class_name: "patch api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + + +## Request + +

Path Parameters

Body

arrayrequired
+ +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'. + +
  • Array [
    • value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    oneOf
    + +string + +
    + +integer + +
  • Array [
    • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/patch-non-employee-source.api.mdx b/docs/api/beta/patch-non-employee-source.api.mdx new file mode 100644 index 000000000..ebe2d6d05 --- /dev/null +++ b/docs/api/beta/patch-non-employee-source.api.mdx @@ -0,0 +1,115 @@ +--- +id: patch-non-employee-source +sidebar_label: Patch a Non-Employee Source +hide_title: true +hide_table_of_contents: true +api: eJztHGlz2zb2r2C0Hxp7TVmndXzZUWQ5VapYWh3JdJ2MC5GghZaHCpJxtB7/933vAaRISXHcNLM9RtMZlySAh3dfAvJQCtdC8ViGwdApdUtrHtur6zAY+Gsv3AgxCxNli9JZKRJ2omS8KXVvHkqLSKh+GMTiU9xL4hV8K0kn6AbC87s+D/idKH14/HBWivldhIMA0EohspF0hb2xPcHe0FRfBHEJJjsispVcIyopIoyzAJaKdGlE2JTZiwlXseQeW6wdHosTxiY4nS8BqCuF53TZ6WnAfXHGclDPGF+vVfhRqAgebTtMglijoKLTU6BxzRWsieGVqJQGjxUMITB40wgAp3bR1XxiNKLEr4lUAtgZq0SclcQnDgTg8prdqbYr7eWFcKtOoy4qVXha8ootGq1Kp9JAPtsr4fNS96EUb9a0ZaxkcFd6RH4iZBHFL0NngzOKKPSYJ6OYhe4hnrGEOMUyaUfEAeUAbBaHLF4JdvN6Nr7WnPzwYhXH66h7fh6HoReVpYjdcqjuzlex750r177oVGonLIp54HDllA9QbaN+gGQBT2C7J23a9vznCJAj4f4TH3F4j2SuFN8ASBkLP8p9D5c/Czve432PIeKENxun9DEegexdGQiHLTfsZnrVZ4g0s9hvJbNA3A0YDKkKqAVIBPQJdoylIDxhaE9wu9jOVzkpIOuXgsGrGypfoPaIIPFxG+5oXfJBYelh7XGyRPPBDtfIoxj0ARHZKlk689Fg+UWMekwPGMaEEgSnGIBRIgIJkoYA0jFXdyJmCBPR5gETHhmvIYK7YNexZnecJ7KUx+48vzeg+JF7iSDeBWLskt3tYrtdfC3u8waN5MvYy1vJWbYcqQDLzq+vVyrbFel4bkmmX+mc7EMGApQ5hq2WSawlbvzCeiU9uQYjzUFLtTgFpt8f9zwdKgRxwfAxiYCHoA5FJp6xVAdp7D3qx/sSSMGBZyNyeN/a95OMAzwzvF6DGZI1ZLZDw9niG63XOQ3UalU6J+JzIgxgF82QIPE84sVnVmaOeLv8xnjHjtuq1JfLeotXqq1Ko8Jrrmi3Gm27BXMb7WXVbVzU7Y5oN2otZ9nkzUqrunTa1U61sWxj2EEhwJbRGpighVSrVA65S/JCwM9D7lJLvlx60o8VnRf3vKICZ9pTdBLSOWSSaP8cdiktFsPLPRMtBFCDoiS3u5Uxr9Qr9Yt2zWqKBrcaDbdlLR27Zl3Y4qJarTUbHbuKFpfFsC86hiyogTONQltytO57ifa/ktHB0Fw6EO6aF227WevYFxDu2rbNL9xOxa7Wq3XERuvLMzHByV+Jy1TEXHq4YwHyMzfOffzK/fcBFYxwL+UaQfA76JuKyrQ1pD0FH5lsIG9rzw2wxU306AHHbEJVr98fL67nt/3xdDoY9ebD8TU8X18NX8EkGBzMZreT6fhqOBpsP0wH/14MZvPb3gSG3vZGegTh4NNkMhr2CRK89XtvJr3hq/zjLQCbD6b4ZTCdD69yk0eLmRkZX18P+vPx9HbW/37wpgefBtfz4Xw0eDOgXV6N3w6m173r/uD21XS8mMCn4SVN+TH3mEM9+2SQh0+j4dWg/2N/NLidzXtznDTpzWbvxtPL28kYaEBI0zGtni7of7Nxbmg2Xkz7+HXee6X/3gIlg1fj6Y/0OvsB9potRrjVdDAZT+fbdwT0djgepZSnYuj158O3mgbA4wdN2l7Y6UH8BvmliQgoCgV5EHGEL5fzccSiZL0OVarpMqApQweTgnhzHd4zGbiKgz4kdpyoHY3PsTLV8ss4nKMOgeIf9oJFFNOdwNUVIDfBj1SqTadec9vgSni12a4aX1NvOjVRsKwUyFS4QonAFu+AFPB+OGenCHjChvRE5qczj6Z0NKWjKeVMyQ8dCaX307kNlqBWLClrLOL3biU0S0yJy+6hfvOAHywFvJNaVKodq9K2avV5td1t1rrNTrl6UfsP8sNWAqPzt8TEgHwKh0alW2+WWy2NQ7CN5330HJQeQ1KMLYq0Qt4rVPbrAtCqJdRiuzW9Eli6g3JBNuJ5Jt+IAGses1ODt3AsoPYUywll/FZUwL+WYwfgUK9h+fLhiZQEx4G0xqFsuu9JrAQHSkFxYjHIthKFpbd0C7xchg6oYATKDlm/TmCfnV8/7Vgdyu/6ofOMbPJKBsK6U5yaA4JQtmEhwzxJUkfEDxXmaggyNWeaV1QA4ES5yl5yB+jV9PUNMWg0itu/AKznJNqLQP6K9Z9ZAkaaFYAHthUtwZcXlU6t4V40OK+1G9VWc9lxeb1e6TQ7HdzdF1GEEj/QVSlu/UoEQkmbeaENEvkvMARUHXhPCNDmzw9uBOMZ/EfN1nMzMg2+DFuKZ4yzl/0Ja7TAAwR3CX3ndztMCKzFDL4UjQoo14DHSt7Jg/l9GmkvB1e9NBiYCISwDjl3GTioliEZ4gp8dbwlAL1DJDzqfJTZqYF6CgTxIMpPlPot2oBp+tia4okXwwqz+4EVedDMVaFfMCVb91/ZC1kW5TO2xG8+9cCWHDsIofZipz3bFuvYGhlOnrKV4I5QJ2XWcxyJRHJP9x8iWL+hTo7joOlqAG6C8YiiVpjE4IdiuVvbbFm55+KMLxnlhYLGAZg/ozEFoRCQIzLzVphpi0HRyAdw1pwrYjff8eXRJoi5DVSA69wAGxV4U/BMQJuMI2bcEYorAscTpPMyj5UPiOTu3mhkICDTmM2T6Bl2N/HA/VhEWjbwURjji7AVpL0RSSMVk/FIpl9Li82sTFyp4es++NF2j7Z7tN1n2u7u4NT0EM0opT7V/dRnEfAE+KsoeO6lPoq0JwhZOknXCFqQZwwYYlKk1+/mYNi/QPIJ88WnNbZ6v2F+pEP5gS5oKg/9fZl2+9PQv5UFIkh81BS44ImE0yW8txgTozSr6vu7XYVqKUFBgwMpIuWpmzBhHFimkiBATHh0xpxQRMF3MVtx8I9QiAO+2gPiroFjrfEHi2Mmecwkj9HoGI3+PtHomEkebfdou39N230yk8ywImsxeVKU+D5XG9NM1uP0wwODCSz9NZtlJpf95p7PVhAYy3KsUjFzKC1r1WXVbdmi4fCGc1HvuDX7osabrWqrumzU8Of1bay/2dpxZmRFm8rJW8uRWAxJ3EfI45IAlCuKw9Aptv+AvUq46NboCEmaNwPPgaUfstyx1tnPHedhiAfGNmmGFBVyyGDLI/RpMNfHuSqdCxM4uwO/GOBhGwl4oSpJXwAUhQejPOlLMl6kAuCqjdVz8RyMNpRUybJdZGB7CWBInsAL9Smqey6BSOFizgcQKIO9A+/8DbNTI6LflcmzKVI8QorZ4JMtBBp6lrk3D/V3h3gmCH3ETAv4M41eXe3wABQACgLts7K885ifH/PzY4w/xvi/R4w/5udH2z3a7l/Tdn9Dfm6yoc/n5zDh2fk5zC1XWJZLXaFy/d/TdDIVgwGpNwttO1HUbk5zcMorQJWyKyGl3Knf3EkEyxw9OH9IT5U+lvCuiPqYXqJIlAeL0mP2DyA1kNZjma9lWZrjJEF4X7ZD/3wJrDrghfC4gLY4nMB6k6GpMsrEZyVRlbXfI+Ca60QZKi1wnzrET0Kmg6Ugzg1QwTSYMzzAY9SKPgOKa6gpvotodtkc9t6hD+haKO/x99OiAX2GlkPse3I3mM8A0x0SzYGP9GrPDBNwvfveBZ9tUMGirba32Rin1dhLwRVUB/p3jBev381P2B2mnWT2SYQZr5BYJ4DhTEBFyK310p4+LqJIo8LkbkWI9wq/mqAZMdcDgtn7YCYEu8mfoJqCgyaW4iJBPgFXbS95OOKj8DAUlrecRMWTTnAOHDrnhXUnFPaoPpCBPikDX8vvA4tdSvRGdIsG5xgSqdxjN+uULp6j62uR+EcKzdLQLIIWnexgoVl7Y+tTODbYMoLgXkTc+urNNTwrBw+LKfiCUHdxQE4YPIq/ddmp1L4ajwI8C+EV8XgfvFtJvC5WWMa0C2MRhETPYUNmr8IwEv9iDFUHzeDmLgEr+mq07nFTiyzCqlVyKFl6S0takCESfiMwjEArE19ihKYEJYTcLXC0Sf5EkgWb/4kudfxUoJk+30AgxZlOaEdfjTNuaOGGlvYBkcFfxylULDwmBzSQH9AK0N/KnzyBQTTn9zSsg16dwJ/TGgwNNqBKUKJ1V790tw7OPDEawNnZHHDDmGBnv/7RsTcNiw7y5pmVtgZ2ObiPrxdCjNzhm8Y3a01h3Pyz0YsU97YdlHHgbb61l/6MJ/nz+N0/yOMdPc3f0dOYlBc7kdPtFdvBl2/AFS8jmqR//7YdJFmoykTSzllqNKCXJhfc7xZiO3sl4C+Mkh+gzB3qovTqUfEMOaAXo8WQx7BXUlCfYS14jHnlGWpt6JOVr1WIrgWqSQJ0R+ebFbCDQ2UoPYBHnfB0Z07GqJNW1Bl8jxIqdnAvewV1qyizd1D6BTaIHMs+PMsBYz+Hpv6bgdTpcim7TBUJEjrfTwI8lw5oJz7joK5f0DZHRnainSJUgYFIeRFSWpmtSj0EqjGSUKYCSPnR2MUWNlTHOaX6wl6gU5HpXwPrc9c+t4RMhZdduyyWBF+CDZpsrYS3xsITPDokdyK3w5vhfA8iAAvMFTO8q2wWRec4F2/UAvFaferlarliUSmCl4HDKIZSOQd8Yu7YF24XZjf+d+7JZd37P+RqvolrWJCcr7GhhhQlukDSxnhTOlSYwtJuduERzHAFTMC5Dw/Yf8FS7RE/g81jcX/zYVuFkdmDkPAZymAXXJJ4gikvpuZ67gnL/1sAB/FO24XBJuc04PEXgQ2GDF0oxgFh6gMRMnrY/PBg0e2P7fKn7thjnaoX6zbTE8vIV2Wl/6Q3738Ps5fmHxzwdRtD8Xv4iH+7pffwH7yEa639MIm+P5TSpiDM0YDTPO1QmmIeQAAw7X/UIepC +sidebar_class_name: "patch api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Patch a Non-Employee Source

+ + + + + +patch a non-employee source. (Partial Update) Patchable field: **name, description, approvers, accountManagers** + +## Request + +

Path Parameters

Body

arrayrequired
+ +A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +
  • Array [
    • value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    oneOf
    + +string + +
    + +integer + +
  • Array [
    • anyOf
    + +string + +
    + +integer + +
  • ]
  • ]
+ +A patched non-employee source object. + +
Schema
    approvers object[]
    + +List of approvers + +
  • Array [
  • ]
    • accountManagers object[]
    + +List of account managers + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/patch-oauth-client.api.mdx b/docs/api/beta/patch-oauth-client.api.mdx new file mode 100644 index 000000000..c521e82e2 --- /dev/null +++ b/docs/api/beta/patch-oauth-client.api.mdx @@ -0,0 +1,137 @@ +--- +id: patch-oauth-client +sidebar_label: Patch OAuth Client +hide_title: true +hide_table_of_contents: true +api: eJztXOtz2zYS/1cwvA+Nc6YsyfJLX24UP1rlHDvnx2WmdiaFSFBCSwEsQdpRPf7fb3cBvvSwkzS9thlNZhyJBBaLff6wAvDg6USkPJNaDUOv7yU8CybnPM8mh7EUKvM2PSOCPJXZzOvfPHjXRqSHWmXiYzaARvDMM0lfYwc/oB79KVd8LLz3j+83vYyPDbY5x8bMkjQevAiFCVKZ4Lgw6tVEGgZ8RDqdGsZZxtOxyETI8iTkmWCZZtlEsEiKOHxhNpiOGFfMErWjtm7Vhfg1FyZj9zKOWQpfZCqAVsE+MwFMFbveKp+tYHoTBJDyKYydGpqvVFYoE3il4AV8kyEKJZiIKff6D142S/CpyVKpxt7jpueGBmlmaS4WpyoajDMiJz7yaRIjHRFt70cHve3enjjo7ex2Rzuj0X6v2+M7u9sHe+G+h2JN7VRf6XCGLDw94oDFEsQCE2+M60Rbqh/kHgQ6DWEWhbxvXl+en7G3aBLvX0yyLDH9ra1M69i0pMiilk7HW5NsGm+lUbB70O5uMJNxFfI0BHXcKpxqpONY3yNNUh4MAkohI+OjWPRv1UuWCcVVhp9GuZFKGHMGgsbvEz0VCajlOo3xq3KPa9PDr8A29LnSvwj1Xx7LEHR9KQKtQoNvUxGlwkxWvw5BckF2nUr6Pk6BlytQqamRhq/4DfgEnkP8CNrWaozivMyTRKeZfRzEXE5N7RGoNkBvAUcCPfEkiWVA0t762WjlkyD+iR/x9YJN8TTlMyAhMzE1ted69DOw7C0qGvVF6mLnhVoZNyCwCOQastGM3VycHDLUFfPZ52rXq9v2DQQOchdwDbDIJEVDyqQgPuHVgmcsc4TS+NDiRqIIAYJcQuVTHIaHIQ081XeCPiQxD/CTewBejTLKwB+QkcqTipaPjstnORow+8IJRktQXAoWkoABgQbJMYBpG5zQiCfINgQiEYspupSdBI8i0I4Vd1afZMPPt+pjA4t3PM4FyU6J84hizzy3VeczcV/3Apy+zOJGGCq74yzGIq333263qx7F+1qX0r6KNuWDkgQYcwZDjfLMatzFxmQiY5l4j481aoUVF8Ts98clSUAwkoKTY25AhmAOTSFuFqHdvrtF+7j1QAshfHYqh+9VWHtScMBnyddrcEPyhtJ36HXZ+cbadc0CrVl5W0uigVdqFEMySmNF33rMqzp5PJgK3+iYg2Leozihq0lgOlbc3XYb/2sKcKhCjC7CkMTeDq4Of6h5mMkhmIlQhJskrFRkeaps03pe+M4wBUIqrZ46t56OY0uDV2kzzdAA6e5ZRxweYbaa56yhyG5w0Nlv72/vhF2x09ndb3d2wu1utH/QDnhnZ7+DLtUQ7ZJBVR7HGNFXJ2q06oKVghp9GbwdOjTDzETnMTi7iDVlzgabA1TjpVXjplfLZ1/GT0GAXV+cQmA3OpAcI829xFiEbnKvIGQ5jismGzxhqIdIH+uAxxNtsn6nu93bQf7UCkHNh8lJDnDJTwUPkV0rpcJRVwx6BPG7/u5xjurnSmNQd+NnJjxQ9KbAPfWwghBQp/I3suUPgQ7FZoEYPmQIGayz2K4fAog6mAh4bFgEsMbgNFbDj9qsqiCM+Y1n9tF2d2lWhMQ3slo0lhDmGDsMI6bYWCh063IigJ5rFgnf7pATfFkXxN5Om+LISkD0FRkupPi7GN7f7bUtyxVIWwKP5i1lHi5V0HwVMCZTSCBQ3YmwhITgZENjzaX0r0V7IUOoM32zysHeAwMVvHwK5jXZpBjYZd9jV4Z9MZeuhAaHp8Pjs6sPhxfHR/D/cHB6WcNSS18Orq9+OL8Y/ji4Gp6ffTg8PzqGhxfHJxfHlz98uDr/9/EZ4qoiS35fzOApedqw3W21LZ5myK5ZUHsAZl3keZRwU4pL2Vo6gTleK58kIc2LEw22cCZowF5oFUNgZxoNOMKPG9YkGsw2ZHx+cnI6PDtepgcn6PMz16BoWpPgoGLusaCwjEnibiGysRdJPoLsi/yCr0XSRaSNphWcn50MnYieYHOu2dvrV6fDwzqvdsyCVwLEiteT1wjWC4KrxSShmLRwhOTK7icC5jGfIhomgJHBLWwNK4ZCLDg8OqtPLoLwKxCY2eXY12MGFO5oEi/AVH1Yi+O8ZVjvq3FgLEnj1pcUblC9wcL6oRDC3IrzD2AFnxuRgom5sIedLgdvTt1qFwmozw+T5QQARjQZL620zDxYqPAzSQB50U+ojIFZGltsshAwUFHAmMoYQhLlpE3L59ws72F1XHDQgJftzp7f3vM7navOfr+309/ea7UP9n9EL5jqUEbyT2U55qYo4Czwve+3d/3uzlW33e92+939VqfdI76x07VZzvd8Cv1j5tEM/9VE0HagWwES5uFOi1F9EMcwGcwUxoFsonTGcB3uxMDAMMWdSGf1IXIDYHkToDtkJRXP4E+AJcGQzxxNtzaZ1QJRlMfk/jawRjNc9t9PZDCpEbZlLKUZYn7wHR5k8k7AADQVQoyWni1bhK1PNi4qUn45xkElRTyPUXUm6RM10+dxvJitL+ndYoJpNdNwCDPo80S6QqlPJPuRTI0tQC17a9UOmfixWTGiUufcgre+JnIrkCanTyLsp+HsHHJswK8GSHAZspbhqvSyPOQvRt4qlNVCRKHQOoASGcEjK+0Lt6rHkglIq7dsXe+M+ThNwSx9dkErd7AzaVXnciYb6XCGOUwqAtNfcc0eiozL+BDC+POrwxNQrg9ypoKjIJYp/iO4llRcnmrwHUuysD5q13QSkESrw17xkBV1/UM3GQRNKQ9+AVrDTygmXCv5K9aUXBcmq9XfkmHFnuCj3fZBtxft9jjv7vc6ezujg4hvb7cPdg4OKAGA2YDFLoPwzaG/x4AGUI1WAvI3WltwkD0xQIM/Vdxt6oBofIL8MSzbtuU0Hb8Mf7SB9Sx7dfiW9fYg9qpxTs/5eE4Iyr++XAg6mEKI8Hkqx3Lpmr3AlUfHJ4Pr0yvC5v+5Pr6ET0hroeQ3j0Um+p44dhPADGFETNXUFnvpqL6ECXFXuXINpYMpMwPCZC4EQg83+pIeddIsSvW04UqB/YWLvZAt0YL8gc+mVFcfcWNzDTZ/iVA+yfxTJ8mXbCJ4KNKNFhuEEIhgkoBgqaRnoP+MqsNhiK5rCUQ5uLIg3KQhR0FKk4Fo6qIS5XwKKALKaV0p6BzA+SdUcYIsR3iN06x7YWktjkWnH+DZSq7J3VVNaCTSmcowGUJLyIaBTmkhjflXQtJ04QjVZSDwqKJdGbHq5VgKd28sM0eZpncBz80n+N1bCM3Kp6mVL+6Ecz4EFS4akTYKNbmI5OALdXatSnUVjm9/y1r77tp31777ib47/7LAPe4tQZ/OIvS5VsVSEiaxAH1Ssh6A4Y31plPkJlZIHER6/e7KFSJxjf8xQUD6FfGRTeULzA9Kfdjno+IXxCL1V7pABkmOdgYRRCIR9onvimMSlBXV9uJoJzodSTBQtQQiQtRM2UzntGxJc6WQE242aSWlvsvYhN9VVTFtl2pChX6CP4KukeQaSa6z0TobfTvZaI0k17679t2/p+8+iSRLrshbHE4y+XTK05m1NPeetpAyaMCKfTWsdLlyK1YdrSAxVmIsr4kcvFG3M+pEe4HohbwX7m4fRN1gt8t39jp7nVGvu+fVc/1N5celkzV9qqZvq0cSMYC4O8BxuQLjMpnWYbP8B+JNRYRhjbalFbgZZN6ye4gcduwtYsczncHcgDBgx3RFeRG3nAB9GJrIo9x0ngb2h1MSHTTnWVWcFx8l1YjX0HENHdfpZ51+vo30s4aOa99d++7f03c/Czr2noOOvc+Ajj2GECtCiPVnQscQcAdCswiUAnMIchCvyuY2e5du7w46FECvgSK7B0s2rWnN3nA1K8CSaVQiVSUuDG/Qdoptazu+gKMxhEiFx0AkoFu0KjkViElxV0gsp5L8GCcEdNOZP4jwhIb1mcLeylGkCuIcOKSg4DZng41JMCcRIfwDClQHHUOg/oo1Tqet31UPZhc441OcMTv+aPfts7L+u7N897/bMXdpdb1iu4CtmXMFywjxMbHhq4Sga6i+hurrdL9O999Gul9D9bXvrn337+m7nwHVHRpaDdWhwSdDdWjbarMSS53QXtr/N2InV3EckHkzHRBWDysMTrgCTKm8tMGrzpTWbzYwWw8yfPTwGgeEhZajHA8gesWZ7wd7Av+xxRPZstues5nS961AT7dGIJ0lgQf3mVonwwa0fdgO0CLRphKt14Y6Im4FXW5NBoHT1oInKRenL2ew/HC3BGziqRhnSfQYWExgGYGnVqF1y508npsfzOs6jR9//1wsoRVzWSa+J0eD9gw4nZsiTuF9devGJWJuO/rC3RtVHkGFL57NcyfHXgme4gEP2gDz4vW7q43aeTzcjT1mQuLSAHzlLZgIRbJB/bwhJZdU52N7vGPQ2G5zWBzvaLFbdSkEuxk6IZxBiL+AmEwiHTTOslQ3DoTiTsSY/VqVJNHwZKi2QEJbzTMwG5TpaEkglT2lgOeT8UqPI9rpTTdZYBs3RVrhsZukmFf9YMGXMvGPgppvqflEzWzMcWFFe+POnc4fHv3iwd1W+xo9n/a1+0h1ngd7kIn4aG6SKg/lfDEfDXo+0mvycave0bGJZjdmo1ZxbHrIgonWRvyLMTQddIObcQ5e9MVs0VkN34bAbrvGkm+H9KUPoJD4OwXHUNaY+AiTMmESbcsj5JI/kWbB53+iUx0/NeZMj28gd2LLUAfmi3nGAX0c0LcxwDj+bWpCwwLftieOwemtARxW+qdI4BitxT1La2lUJ/Jb1MdzZxSISnVmpApw7pO9PwdbN86V9L1q2xh8Z44W5qeGsIpqwLwEF/mNNaTFOblZfsvfNDFV/tXmizMeVEWTcxXPvnaUXhFJ/jpx90+KeOtI8y1GGodysfh4Ud13dfz8dSzN02PFjSoLV7+8x+NekaYpuaVG3YFeOSy4WCDECvZEGDo0R3GAwDoshaoDsHVCwF6GHkMRI5hIQaWFRPAMceUmWq2ekpcnqcbQAgtIIjSm82QpiIPDYlDGQI+K38XInJzRgla0GfxucrcVQ4O5w1JVtNg7WO2pAFSOKz3cBAzvftZuyXcJWqebjthRYUgA6KbTXOGVacB2PmUczPUZawulCXIbFGHhp0QhC02wsuxVRAg0Y5xCi9Y86dScR1i1hgVxzaieGQtsyriSNYgetejuIKomciHi8g6g5pLgOdp4pHEi4oTOzQJbeEKvGuHN8GqBIhBT7ncSvDjLdTJb2Bavd4LJW/PZbnVabZ+WIngzlTYZrI5rxN39XbUL8+Yt8KGq0/+Vbs5zWQ6XJ1sJVtRwfrldLlnXvPEaK1Po05chno3EWzLw9cMD1lxwrfaIj4ErXNDfvK+WYeT3oCV39J9OkT8hnhcX7vjpBv1qtHjx3lKmi2KhmtXiB3z8RWB5Afo94iUTtv5DDNkX7gcH3x0pLa9yeuLWN1ys2s62vPRENwpY5ZKfbneC1iN3BeDUli9Sjofs8W/fu4V/8EUn1gWgET1/8IpiILSxhAuwtgyruA+gBGj2P8L1k4I= +sidebar_class_name: "patch api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +## Request + +

Path Parameters

Body

arrayrequired
+ +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 + + +
  • Array [
    • value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    oneOf
    + +string + +
    + +integer + +
  • Array [
    • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/patch-org-config.api.mdx b/docs/api/beta/patch-org-config.api.mdx new file mode 100644 index 000000000..6cd3f0f86 --- /dev/null +++ b/docs/api/beta/patch-org-config.api.mdx @@ -0,0 +1,119 @@ +--- +id: patch-org-config +sidebar_label: Patch an Org configuration property +hide_title: true +hide_table_of_contents: true +api: eJztXH9T2zi3/iqa3D92uy8OIQRCmOncCUmgaWnCJqTQ0g6r2HJisC1j2UDa4bvfc45kxyEp0O7OfXd3Mp2hiS0dnd/nOYrsbyUZiZgnngy7Tmm/FPHEnvbjSUuGrjcpbZQSPlGl/YsSXGPm4peNkhJ2GnvJDO58K42UiOFWIu6TZppMcbTnhPsynlg2zVD7AQ/5RJS+PMBcRyg79iJcEhY8wQWZHpdqRph0WTIVDJaIRZgwIMRS5YUTNk2SaH9z80rJkBgt2zLYZGoWJvy+zIC/IJChP4PRwmGujJk95eEEZyK9xAsE+ypDgQvwEOmWQcJY3KRCJQfSAXG+PWKvyXxPJThB2VMRcMaTJPbGaSJYGjkc/sv1pxi3bRk7tJykFS/eDvs9RiJ++RWZV8B9IqWvyp5I3DJwsDlNAn8zdu3dRqX6iqmEhw6PHWTMRp2GCTLFo8j3bFqGpLdI/P/gR7ytecNPySwSwDaPYz4DEl4iAlW4LsdXwk5Kj43QZMioNkU/k4dxxRzheiHocjxjF4PDFkMmmcV+VCyjZS8WDnqHjOACSDBFV4pi1GDiCeITbs25VaDqcLLE7em0oHVU9Vgw+Ar2DoD+RkmEaYDLcMehhQN5K+hD5HMbP5kLtoxQRwkYHxkR9zyIfFw3G/lguHyWoybTN4xipAeGixmQiYUCC+YOyOOJSBjSRLbBBYUvAnRxLQR3XbCOVndSFLJU5G6zuDaweMv9VJDuQtF3KSIfczuf3BN3rDgfxPcSvzD4YSOfjlJMRFycv12pzGdk9wtTcv/KxuQXchLgzFkIkcVDHuDAaOr5XlR6eChQy7w4I6a/L+cQdAjSgtFjHv4LStxgmQ/Svc/oH59LYAUHPhuTw/d5PD+pOOAz5+sthCFFQx47dDuffKH9uuCB2q1Km5iSPoHdSrkZS81AxBDqm6cyhviXIC7SmodPEqeCLqgIeNQ6rFYqy6kLtYJZ+w7iWKW2LZRyUx+yI+UO8VyKWZlXvpM/2qd9ZvtcKdJsXj4YJEiOWRGW9sa+QL+2U5VIEJFBtRBxyH1K79wJvJD9+rnUHxxdNtvvu73PpVdoxxit8ChFxJMe+cxL8gR6V1ZPTL6f25TbgbCU9Dn6cCm3xYsIKwhditV5VbmbepA/PbXSC2Ftxk6ncNcBO9oJ2EGHu4J5IqTy4qQ+EuTqGmpJLEBFUGZhDZj5gfueA76pC40NqQNWcGUKzssTtjkWCd+cF9zNWxxuIWsWsrboyksetlHybdXCUineyFDGaijT2BadkIPRDgVP0riolTFkesHDJbUc+pwqnyPAsmBP1IgA4bUGjlvDy9abZu+oc/mm3+sPhpfD/mjQ6lx2es2D487lYad5Ohp0mItUQE2CVp9rsIAGFqzocl9hQPA4aBnfQiTzbMoevGfZeNZtw/0QggOX1CFWVFi7s73Xqe80rZ3Dw12r1tzdsXbarbpV2Wvv1mrV3YNKo1PSLAx5NJwpqLpd5z1EFKysXlI+MpDRbff29xVpv+ugLoFNuGAossCQLD/FLmSbjALQrtqNrb3Knl1vbPFGTexUtuqN6vbe3rji7FZ3dxpAKSMPo7d2dnYpnxcpXP4YjerlKirbP0hl21D5ovWqgeVLjMphJNZcncpYPvL75hWR97F3OvjYrA7r6s5T7bPrrU+3tQ/ve5Pbm86VdzDduUzdtHWmAl4NrJ3zZtu7ujmYVLyr8+PxbCcc7vr3n3rnfDw9CpsnR6J9ZNc+bF/9/i6e3n2wRm9m0eBY7X06nvSvvN97qWr0vGBYSU+cdzIYnO2eHp7dnM/c8KNjfQ17k/H4Q3o3mjWOZu2GGLc/vB2GyQlXyf3wvj6yZ0fp2cGN2/v0MUrv3w3OxGX99MPH3crN8c7O1ehm9nWvVzsfjceOfe+MP1VS73o3TayD20bl/bvT8Sdxf3B2eTKo3diT7jXvqNp1V4THs4P78Oir91HWm/1K8nZvfPSmv3f4dnDtjVtR8/duUj/pDo9l/Whyee42rrYqzrub6sf2ZFaLTk5vv267neqnNx/D89b57fnhsGndfuCT169NSLTHLzMcFosxVzpnP2mwziiLNiVHsf8y8sNhn40Gx08SzrDsDPzWAvqWUtJKYQVYzuOeTogtLEWu8a+BgBYEIJxjIMOfyZLdZpctEGePqOui8P28WEyLBiYo6QxEJONEV2T1Iz3CYtm1pZ8G4csqb89UXT2HQWmPiYmFMjTst9kB9nWADhjRXcA5zyqyC1Ud7ZevouYAD1bkvm9WVRsE8pIpVZUknuFQLwjSBDVZZk1Wq1SYiGPQ6J1H01TqJ8yNZQAzZ9jziSAilB5Ix3M1OtfL/mKaJA+5Kj+2APLsciA2r1NeaPup87MSZrNRQmRCS7hCBoAHyTSWdzCLmt1MBqARcIeQsoJeJKP3mtjDsZkOX7/GtZdL7QqRoOmFNmB/ReOAPRlP9KXtKrZeoKkA2zPoIwJ+rz9Xt2r12t72bq3+WAMD4YPr3wLcAikZrTN3fFJKGbp+/F/lYjueApg9Ax35wk2sRFqxN5miqCyUoSPsWHDaTSByCwJWi6i+GDcAcKk1yW/Ot0ge6HptFQJv+R5GZoesYkE0A5DCbtpzje1o44GNpaNdMiTY9qdw+WLMQo7hnt+Szgti9hAC0ZrEnPp97Ug2TGRA8dajTY1AQvrRJDNITeMWQTVoorzFDrgD8mr5WkYYVF/M7Wug9RKENgq9G2zpzBTmzXPeimVFXfDxbqVRrbm7Nc6re7Wt+s644fLt7Upjp9HA1QPINHwiViXBxaWPRIgQmfnSBot8BYWgz0BCRgZo8ZfnTaLxwqZCj83FNPwy3FmDHMYOWiesVmc+APWUrvNHDY0IrdFwqcIhvifCfQgEL1zFSrZl0u4cNkfHp3Bl0Pl91BnCJ6S11HE3Mak76JbAKvjCVN4Rx0YAajlNg1Rmvxmqv4FAHAK1MNDT3zTuYyaxwAyz+ooZRdI6QxdDydbbkOxXryzKG5AN4FpA21qILKCB0lnztyb0pFFiHRtN/samApJi/AoSqeNQKofGlDpyTJcz2pxxCmnXTbEngpSTTGWaQF4BvLmYKwuqfIw3shxyXDQKBgdw/gIsYycpMEdiFqMw9xbDorEPpkFaZ5G704LSSKW4h2ojasYdAlvG2KOyMcjmQYdq0hGaS0HiCbNxecYqpkZKd+81M21sL+GezVP1grg78SH9WCRafuNWmOCjvlpnI7JGZiaTkcyWK002o3JzZYHPXE/4zjp217G7jt0Xxu7jmwOz72juEvTZWoY+oxD7cBlT8VyCPjF5TyhZNki3O9qQGwDMMoj09uwUAvtaEPYV9xEC078QH+lSvuJHn8we+vo428DPSv/cFsgg6VFL4EImEs4+8T3nmBSlVbW9vNqhjMceOGi4AiLiDiiDbpQ6vzgNQ+SEQ0PjSKHCXxI25ZAf9Q6rzoDU4zhWhL9BrJHkGkmuq9G6Gv17qtEaSa5jdx27/8zYfRJJ5lxRtBicpNIg4PFMe5q5T2d3GAxg2S/gLA+5/CREEa0gMZZjrNIiciiNq1vjLbdui5rDa87udsOt2rtVvlPfqm+Na9V6qVjrL+ZxnAfZYkwV7K3taH4rjm8Bx6UhOJdKpHQWt/9AvbFwMa3RqZAMN4POy/Trf4Yda8vYsScTkA1/BbaAxurtxdHgGOnD0kQe9UY/yyHM1qqD4TwhSIk+DJr2VLKGjmvouC4/6/Lzryk/a+i4jt117P4zY/eHoGPtOehY+wHoWGMIseig3X8TOjqAOxCauR4e+MvPfOQnjM3uowl7c844A3oLKLLaWHFSVEr2Hg86GLCkFnYiw7m6ML3B2ADHxtlYPGvBJpAiQzyF7QG6Ra/CU5GASfGEvO8FHsUxCgR045nVdPGAtI6Z+VEGs4o5k6AoKfhSH6e/4x64k3AR/gEF2gedQKL+C/c4jbX+1H4wG6DExygx69zbQmDM5/u/O6tOCXRDcxB2qG39neMCes+ch9BGiPtIp68cgq6h+hqqr8v9utz/O8r9GqqvY3cdu//M2P0BqG7Q0PehOgx4MVSHseUKy7HUIZ1Q/f9G7BQqhgNybyZtwurOHIMTrgBXyp+2Lc0fB5s/wVPCZ2wRDmpO8Az6/Hj6NzAQGOahzCOvDHkLbJTMQnlHj8Pio0ArEg6eL9XBhQNY86RreosyqTT20Gt1iiPiWsHmoG9JgaLpSMGTlLOHrfD4PNNkNhh4uPEgugwsRtA+/KJodNk88PdIPpBrFPsPf14WTeg7sqxS35OrwXgGnD4SEUUoPBI9RKytV196MHpeP3CXv7q0WB+HVdmB4DE+NUUHX359e3b6ik0QYVKE6yehhYctAcTICbgIZbBmdggEJ1FRiWU6mRLjzYVjNhgxzPVBYPY5HArBLrpGCT1I7QPIxaTS5sKDNPMHfR1xK3yseuW5JtHxPCfcBA1tLj6A84oqHLUCXqiPg+NB+c+hxdr0IBw92IBjjIjU2bGLKJOLF+T6WSb+J6NmaWoWUVOvHnGhVXth62PbNoQtkuC+Im399OKanlWgh30TXEGqj3lATRg+Fg9H2ZnVfpqPBXoW0lvk43N4Rk8wPnqCSmcrpqD6+Q7rMnsqpRL/yxi6DobBxSSFKPpptuixSYsiwqpWCixZeknLswAMEn/HEBihdiY+xmJMWETqbREKyT/IshDzf9AzH38syEyXL6Bm4khH2uqnecYFLXpKSOcAZfjXJQkdC2IbZdCPzpADtOb2p0xgGC3kPU1rZVYn8ps0B0uDDawSFRXt6y/78wRnPjG6gaPzMZCGEUvnx8XwGRlDC+vSgrKyXYDHGlzm15dQDh/pTfOb/5aJJfLvJi9K3JxvlvRDf/ZXZ+nvZJK/T979L2W8dab5N2Yag25x03Ewf6dK5/m3ICy+kCJ7EcLSGxe+4MNzriSRTItRDKADgwWXNwZx53oq4C/cpTxAIB1aIGrqCCEVCQF7CUYMZQx76gnaUogEp+cFN9BrZUBRDt0/phahNKFJDGMgJSjAu3zs+UCPNr2zlTkFowat6DP4XaXmCIbUL6sRZXaGD3naYHLs8PDwL9y7kqbVG4LV6QUjrJ05Er33Jg1hNYz5NMA3AjznbY6n7FQnRWg4QpHpQhKszGdlGQLdGEUoU68TB6rv4m41NMIFp3pmLfApZbaqQfVoRfPqj7kg+nE//eqNxZbgOdrgydZU+BG9zADYgo6xsML77ukSRSAWmt9H8H01ZpLaxLH4VhUQXrvPdnmrXLGoFcEXwkiVQFdcIK5fm8NDetnG4ouMzO7Q0sbVt/mG/d/gBUim2mGbshnhjhrKmeq2SYfoRanQmUIYTkEJePXbN9xqwVbtAS9DzGMff/Fl3oXhN6Cmt1woB1wLbPXNHr91OouKLz956j1H2CfqyXpH54lplCvyLvukedp6A6PH5g1Pgd4xiPkdXMS/+6XP8A++mPdr4CC6/q2U7b/BGE04w0mrYIL5gCI/PPwfb6M64Q== +sidebar_class_name: "patch api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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

arrayrequired
+ +A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +
  • Array [
    • value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    oneOf
    + +string + +
    + +integer + +
  • Array [
    • anyOf
    + +string + +
    + +integer + +
  • ]
  • ]
+ +The Org was successfully patched. + +
Schema
    sodReportConfigs object[]
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/patch-personal-access-token.api.mdx b/docs/api/beta/patch-personal-access-token.api.mdx new file mode 100644 index 000000000..10e1a09b6 --- /dev/null +++ b/docs/api/beta/patch-personal-access-token.api.mdx @@ -0,0 +1,128 @@ +--- +id: patch-personal-access-token +sidebar_label: Patch Personal Access Token +hide_title: true +hide_table_of_contents: true +api: eJztXOtv2zgS/1cI3YdtepFjO87LXw5p2u6laJtcHijukgJLS5TNrUxpSSqpL8j/fjND6mWrSdotbncLo0BqS+Rw3vMbWtRdkOVCcyszdRwH4yDnNpqdCm0yxdPDKBLGXGSfhAo2AyOiQku7CMZXd8GlEfooU1Z8toeFncG1wOTj+SLM/dyQ0+TQ4mwznnPFpyL4eP9xM7B8anBCuQxz6zBayAQwIhYm0jJHroCni5k0DOgmmZ4bxpnleiqsiFmRx9wKZjNmZ4IlUqTxM7PBsgQGdRLvgRg513wO07UhQaRyUs/gloIb8E3GKG00E3MejO8Cu8jxqrFaqmlwvxlo8VshtQB1WV2IVW5F9+KM6IrPfJ6nSFAk2/vJwWh7tCcORju7w8nOZLI/Go74zu72wV68H6CucC1h7IssXiAvDy99yFJpLMp/gkZhUSqFsqWaKkODDqMo0zGIU+ru6s35yXt2isb/+GxmbW7GW1s2y1LTk8ImvUxPt2Z2nm7pJNo96A83mLFcxVzHvWt1rVDmJEvT7BZpkiFgES0YuROfpGJ8rZ4z1C/+byLg5Rp9KkIXUhZF43meyogY3PoVtBfS3L/jR7y9Yg+uNV8ACWnF3DSuZ5NfRWSDVd2giCQhOyk1wbhhsUikAmeaLNjV2esjhuKxkH2tQoKmX1xBVJGrgVuBEXONurdSEJ9wa8WrupyoshcaaSLKCBDkRaqY4zI8jmnheXYj6EOe8gg/+QugaNSRBRdCRmrnK0feey4f5eiQuRteMZkEw2kGZLQwYEHyJWDaxSbafYZsc8VEKubohU4IniRgHadu2xSyFRpbzbWBxRueFoJ0p8RJQnG7zG09+b24Zc35IL60aSuEq+koxVTo5vztfr+eUd5vTKn8qxxTXahIgDNbWGpSWGdxn1fymUxlHtzfN6iVXlwSc9/vO3KgYKQFr8fCgA7BHdpK3GSlD9K9a/SP6wCsEMNnb3L4XmeCBxUHfFZ8vYEwpGioYoduV5OvnF83PNC5VbBFwlcmpEXoEirhC1MoP9RzqLTQNTPmaYpFBHUIE00OMjgdD/t9/K+ttWMVY0oRhtR0enhx9M9GWJkCsrOIRbxJGtLCFlpVQ38yTAGvlYfTnN7DOaszUVX+0U4DUA2elAaOX2JCR6bK0spcaWVUWtmzhkNwxz181qhjcoIX3MiIYT3Y6LXMvb+bDOJoNxH7yc5oNBgd7PRHO6NoMhkMhnv7CcfAc577FDZpvYcY7bEjrlRmkVkcZHACMJzBF909BW7e+tTMSai2AO+zWLw5Z8cYo6VPYuFG51mtE6pIU6xEZelcrhsN2RJepBYvtdzuflnsc7q3InRb6ibHV0Bgno07IVJIK40TqY0rXo8MBDSWqRhiYTNAJenHK+Bpp/vQZPB1GWMWt4veiqM6qo/5wMPUX16cMJzfa9Su45ev3l8cX/y7XZiqqyDYU0LkaVJBFLV9ZxgdDPb7fLSbcB4LMeoPdpPJSPQH+9GwD/jr6c7/MAOzApBvqAWP0fdYLA0kuwVFS5uh8yLPM21bSRcS7gnZFq5FQMOKToUgKuDorwjzQisp365GKIFATHQ4YpPFwGIJ/+YyBeRIHrXJbmfAv/WYu0O0Wwhaz82STvuDvbC/Fw4GF4P98WhnvL3X6x/s/wfZT7mx0DN08r8cmX+APMieS6FAYSoUlggkvpTBqBPB5QD9znNYEsIfUxpCHoeyYwaFRdwIvcAaAiSh69lkgATgerqAPxGQBdYXnpgPtQWLYDGXxpMipcTtfDdZILS6nUnArUDRwWqVsTRTAEyAPytvBFB2+R+04Qk5TPgVFnIdWtNAE4C7gqtmSkx4akSDov++VHUhIaIhndKdkuGDX6BEfudcpgQjGUSERZu7MiydSm+kkRgxUlUljRHmTAAr9NhrUJDnYpN9yPSnBJoPw27B8N45q/W+UFpQxUgVJs2ycs5tSakX3N+3ET11bx7MlADFZd46OD/WsfuzsB1t9JmHLAgCgf6oC7Qcua7tldbAYcjOCJaAHNLVGd8Rsgm0hKgsqQAmyfg7IpNYWLDNEVTXx7Pfa+idQqi+1EIJYjmCiejXN5I6zHkGDutIlqWSxrU9EzTRGwBWiUFeJ9+RFwbzoebRJ6B1/IR6cKnkb4iS/RSIogomdywr9gSf7PYPhqNkd8T5cH802NuZHCR8e7t/sHNAZQCiHaPYdGCK9tI/Y94ArJVmEVjkvwIhJQfdEwO0+EPtatsGROOJ0MuNrcT0/DLcm4GQYi+OTtloD1KcmhZ0nU+XlKDCy/OVPIxJmwifaDmVqouVspK/fPX68PLtBVw5e/Wvy1fn8AlprTQxh5AHHCIHVsEXZtktcewFwERsoF3E/rDHnnuqz0Eg7mG5HyjdN7MwoEzmkxPM8Kt3zGiSZonO5q1QitxGFnsme6IH2RqvzWmnYMKNS+k4/DkGcm7Dt16Tz9kM6rrQGz12GMcShYQsQ00LZrsF9btxjKHrCCQFhDIwI+0sg4oAaU5GSzCgVuVyVSwTy9umUTA4gPMntO+RLYA5ErMZhZW3eBa9fYBnp7k2dxcNpZFKF9AXQQWCkVCCokxr0DBVO2kN8+kIzWUg8ahyXJWxmliH0t07x8xLm9G9iBfmCXF3mkL6CUm06saN8MGH+d5nI7JGaSafkTxgoMl+VGWuMvDdhtY6dtexu47dJ8bu8s0S9/i7BH0Gq9DnUvEC9KupeK5AHy0cOGTlILeN4wy5yRAyO+28+XBRw07xOUcI9x3xkSvlK8wfVvZw1yflnmhZ+mtbIIOkRydBAplIxGPiu+aYFOVUtb26GgDgiQQHVR0QkcDyIiuoV9CFUsgJN5vUsKifLJtxyI8VHHY4Xag4zBGPr5HkGkmuq9G6Gv041WiNJNexu47dv2bsPogkK64oWjxOMsV8zvXCeZq/754JgQGs/NGQVSFX/bjcRCtIjFUYK2gjh2AyHEwGyV4kRjEfxbvbB8kw2h3ynb3B3mAyGu4FzVp/VcdxFWTtmGrY29mRVAwg7gZwXKHAuYzNsri9/Qfq1SLBtEY/tJe4GXQOKv1YY8fRKnZ8n1mQDQgDdtRf2F68PHuL9HF/FMmj3rJCRwJhtlMdDOe23gMXnyX9crWGjmvouC4/6/LzY5SfNXRcx+46dv+asftV0HH0GHQcfQV0HDGEWAlCrD8SOsaAOxCaJWAUkCEqQL3KLj3SVoW9f3SzBHotFDk8WEWRF1nG3nG1KMGSae1EqlpdmN5g7BzH6nIsDOBsCilS4Q/0EtAtepWcC8Sk+FN8KueS4hgFArp6ER4m+Mypi5nS36pVpIrSAjikpIBPR+C6t1ziA2cJwj+gQPugU0jU33GP01vrd+0HszOU+C1KzF59dg8lsmr/d6f70UaLD/ml7NzZ+guPC7g9c66gjRCfc5e+Kgi6huprqL4u9+ty/2OU+zVUX8fuOnb/mrH7FVDdo6EvQ3UY8GSoDmN7fVZhqdf0lOv/G7FTqHgOyL1ZFhFWj2sMTrgCXKk6oxnUx2W6j1xu3cn4PsBjm4gPHWuFTmFCeZztDiwGlrrv8Vz2yiflVXbbi7L51gTU1JGB8IFTF204gB2eHvtmo0c61hLd2OU8Iu40Xh2oAM3TMwYPUi6PkiygD2GOzCaeHvAuRZeBxRz6CTykQ4/Su0NVS/KBXJc6vf/9sjhCX5ClS30PrgbjGXC6JCKK8LE+ZXuO4NutvnLWti4ouO0/XFmMTn8O2QvBNXQG/pjQmw8XG9Wj7TErDKJdIbFH6Dgu608xYJXRWTGdEeOHreduMIQYPizdY9fqXAh2deyV8B5y/RkkZ1IpThKUD3BWfZgyFjcixTLYqzWJjidjtQUa2uKteRtU8qg3kModEMDjWNcqZC8lZiI614pjvIjU6rGrzoe/v5WJv3VH2sYSF061V/70bQRxjCR4akhb37y4oxc26GEjBVeQ6jIP7ul24qP9tFRUWu2b+WjRC5Fem49r9YFOK7SnMZe+mIFymMbsmEWzLDPiH4yh62AYXE0LiKJvZouOSIQUEeGw32ApdEuGMgR0SPy9hcBQzpn4BKszgZPM7ZNQSP5CloWY/4XOJPzSkpkuX0ERxZFxFplv5hkXDHHB0OUA4/l3NQodC2KbziNg0DsHOKrtT5nAM9rIe45WZ1Yn8lu2PNFPB9iomlYn3eoE5z+x8rBD+zQcgOvq+TH4zjwtLFQtZZXbAssaXOU3zaA+LunN8Vv9uIk1888mL0p8WO+enKh08b2z9BcyyZ8n7/5BGW+daX7ETOPhLu5CntVvv3j1+Enz9qH/5oHz1ql2AFnoyiSS7zmaAfTCY8HVnUJDB5fhL9ylPECoHXoi6vIIITUJlcfaKGNEMylojyEX3CKu3ESvzeYU5bnOMLUI4whN6TSZBnVw6ApliqdycRe8XJlTMDrQij6D303hn8nIwN2hZxU99gHaPhWBybHlw6eB4d6vme/96tN3L0tHAkA3nxcKT8sC28WccXDXR7wtliYqXFKEDlCJUhfuUHc1q8wQ6MYoQo+aHz03JwluX0Nn3HCqR9YCnzJ+7xpUj1b0r1eoBTkTafV6g3ZL8Bht8ORwJtKcjqwCW3hUr17h3fHFCkUgpvwPJvhOED/JbOFYfHMFCO/cZ7s36PVDakXwpRuZsdAmN4i7V5N0vjlm2RXv6p377/xyHF+xsNXYynGbDHktXOvjwuwq6AbBMHks6QTkDETDcXd3uKOCDdg9XoZIxnb96mPdW1Ewg+rxc9x9mLQp6rMzfxxzg34TeuAlO51ilHuCatHIDvDxk8BdBJh3j4fp3TYPceZu+N8VwotF850UD76uBltRN9ntIj0wjdJR1dnTGypg9MS/7mfudik0v4WL+HccXMM/+JLlzsFhEF2/C8o9PxjjCJdQrAuJ+A9gDRj2P9jnyGI= +sidebar_class_name: "patch api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Patch Personal Access Token

+ + + + + +This performs a targeted update to the field(s) of a Personal Access Token. + +## Request + +

Path Parameters

Body

arrayrequired
+ +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 + + +
  • Array [
    • value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    oneOf
    + +string + +
    + +integer + +
  • Array [
    • anyOf
    + +string + +
    + +integer + +
  • ]
  • ]
+ +Indicates the PATCH operation succeeded, and returns the PAT's new representation. + +
Schema
    owner objectrequired
    + +Personal access token owner's identity. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/patch-potential-role.api.mdx b/docs/api/beta/patch-potential-role.api.mdx new file mode 100644 index 000000000..87dd56409 --- /dev/null +++ b/docs/api/beta/patch-potential-role.api.mdx @@ -0,0 +1,123 @@ +--- +id: patch-potential-role +sidebar_label: Update a potential role +hide_title: true +hide_table_of_contents: true +api: eJztHGt32sj1r8xRP2ziWryMIfhDezAmu6Q2UMDd09o5ySANoF0hafVITH347733zugF4rFO2t1Nac/JYunOnft+zIzmWXM94fPQcp2eqV1pHg+NxdANhRNa3B65ttDOtZDPA+3qQeu1ewwfsTvLsZy59v5cM0Vg+JaH42H0ZCHYUoQL12SRZ/JQBIw7TDxZQQjwzIvxMh+xRAE8LD06jw6Om7m27X5GsJklbDNgBgydAj7XtOCJeYWAZ+xjZsaP6pHDlyL+HfBPwqQ/Hp2/nJ31B5PuFWvbNnPDhfAzuB03zKIvnZ09OsCrx33AFgofOX7WLEcKZQGvcBr4KxBBIMV1rgXGQiy5dvWshSuPXoY+SmZ9rvnil8jyBQg19CNRJCkSwpJEyRRSZiFW8cSXno3o3hjVVkU0mvqbJud6XZgtnbcqU91smZcX9fpl7WI2hckK6fSyWvxyajeUF0TLJfdXLyP4vZxQBOG1a66QoM35DdfB6fAV9zzbMshEyz8FrqOTjf4Zf+LrLaa47/MVEGWFYhkQAtsezEibCsKd/iSMUNvkss3ejQf9IWJng9grGA+YKWaWI0w2XbGH0dsOa7QqNaYTNCPw968WYegFV+Vy6Lp2ULJEOCu5/ry8CJd22Z8ZOOK1lhXzAzgemRuoDMTh+eiHoSWIYni1paQinSS+y0IXjRn+nLn+UpBOnGiJ03DTpImX7idBPzybG/hLPTBcD6UFvhoiIakqY8i1ovIgRW0mXyjBuBao0GeAxhcBmg68AR9kIffnImSIE8nGAGGLJQAoJvhsBtqR4g6zTOYMrZydG0j8xO1IkOwckdd2Qm06uC8+s+x4YN8K7ZxHJMORi7nws+MvKpV0RPw+MySxrxgmeZCgAKsMYappFEqNxz67sGzL09brDLbYnmNk2/btrAo5LmBim8h1VucPWqVSBdSVSo3+vdDer9eFUZ7ErRQWBaAssLu8ts5ZbOz07hEN8VEDdZvwW9kW/J3AB3s1BAJJBPAOPJ/cLnFS4uK/50JbzlPsJ6i1jCwlDelg6USbhptAxW5ZBJaYt9Y2jJD1IPgkOZoychbRxnSUEPdNJAHSKWbcDvYhJFPdg4/ep+jyhDJgwI0oGIDSSGIQHTxQv1RbrVLB/+T1NI4MQwgTkjQbiTDynYBMbUdGmnK0R1RoFkYmQQZG8slCTNreHFOYWBIvTjxv80XeBA1fQAlkXq8Og0IWPWitvRvmzogpQuzmQpJWM1rVN5VWpdmo8kvOjUq12ahVL416gzdq5uUbjJGmFYCyVn2KNcc4hxrAUKX7Jm8HC1usSkNL+OQIqa92QfjhqhNL4mYyKJwoLn+UyDD0myLkFuRSIlw4AaDJEJ1G5QKqJTQSzDeMpJQlu3l5rqGv81AivKjJuTL4jhJS+uTglJvegJEx9QhA5YVIA4KEMil28N2RjEO4mkLGBSIyCAJmOfuJqhXKQTwZdgSe0s2g2nZNnNaG8n5jUigLAxVQYzw45a4KbasczWakJq9M6wITUvUCf/AKZCWgGOLGwgG7OVI4CfwL7QKihrTlFylEjQZ3f6E64ulvrEDWDco+N2KEgmJJdYE+nAw4Qgc7AlSC77jgAZFWhYs8ozlfAGvnfojmooJTjrFj6YSywsIx3B7mKN6wqY3UnPDzD5Wm+ndsAuGLXVBiIBU3MEGloQwdVja+vSJdrDNK6pkHXAXdY4cdfE0fcY5SVj8T3ffFrjEWChuFB1QilWa5WqEuAXMrhvFxCEG8WAAJDDW9CLfLHbeqd1WMDaGj70967Vt4Nuz2b3r97+FXZ3A3vO1OuvDzbbt3273J12jZQdv6zK13DPNcAF+/RNw+Pvso6INRpopNxLaf+7JZPyrzSNjDSSc2D73Jmw29Xp9xfWpCU2406o3L+rTRuKy2cG5ZCaZTT6GZFdwpnDs/33cBo8Gk0ijITY8NPSKXKb7YLOL8n66+7DbIL6+kcMa0mipYhslJrzW7aMwuxaVeFW+qel0YIL3Km6Z+WX/TumyZrarRrGpHO1uG20RoqmJ2Itvm01hk2543umNjJaeM1wHl/WjZS/JLz8kv3x22WnSCZbQ8OlvtI7VWaNSeHzlissAM7NrmkY5Eg0BDalS22YSqCSnARwa3jcjGOILLDIBiKsxhfro95Bam2n1uMOORHe5eJNvUrHSHIm8wXG9HiKRXG1qQ3bUVHDLW53wKeoAgCNjBnyyOJulGUJ+X0NyubnjIx4YlHEPgz0BQLo2z4lvLhkGdZOjzZu8ACdLnToCCx2XjW1c2T1fszuJLC6XIYeAtnwr7OHATiCiYJxn2N7GiHqhf6t1gKJ/880N7Mhn1ru8n3XHpdtBpT3qDfuqHmq3mALZkjw89C/Qjf79v347j9pRWtSUJshc9FFty6f3oTL2vDjhKxbl4+nC41zsvAqnVKglMvUb1gZFR8OGw9QgxnPvG4lFj8UCgmIeY1M3IELIrfwFruwPfAYtd7zXZ4yrIQv3MCFnK5os5+P9wnMIqWeWqMUW6xLc2I94oI9A0zRDs7hpwPOx2oJjr/QvqPKr97oCDXMGXh9gmDn9NVpKwoLhcHW2rWlasewjrjLrtCU15P7xRv5TYe93xh8H1pN3r09Ph6L7f/TD5YdQd/zC4vcm9iovVD6PBLYwajgad7ngsC93Nl/GMOe5TMnarJa5uMd3A4zvatitYe5Ovk209TL9QExiR72OfX5yPdonnrt2/pxq8fT8ZfBjd5alO3u61pZTWvWY3TCrJm9B9ifnt60G+pv0VMpEv4dbSxepFa6Md20I9dH0fQpSu1kdRR6q4ldtsbOqaK2ZhOQf+a33Z8mc+Kcp1uo5rHlH8vrUcoc99Trtpgkg2YKBalSUzc32hlv7i+pzg8g0NSKJUZdccamLFX0cxg9L0ufEzdemHCbp3rF9wH0MNgaSVbGQUTCuagk8blVatPmvUOa+9qVebl9PWjF9cVKAVoB5qCebH56KoQMhP/b1wILUYDMOtbf0bBOILDrInAmjy41dnCMeRzYeETdhU9LJQPIXnUOpfd4as3mQ2d+YRPefzDSE4+v14K+UB5xLxwLfmVuHKaew8N9237fvbCTwZQVLpjuEX4traZmo7YK0mmqVLTcnC/SwLDMnAZw5FtrBpq7DEzhTWM2CIq/0BBWjJv4JVAMJkqoSHEWr2ghFZ1Gzmu8ucK5HfPIXslVUSpXPoSeDZkjaNczsPZ23DEF6o3ypJnrGF4KbwX5dYO1mykvtoAYxf0danacrwighmEbgyEGNBsItC5rihZWw09qkoNwuQOKTcZpWCzgGUH7GTa4QRhkFkM+uFibUoEpV+gGYpuTx1k4zQSKQrJ+QGcMFtewVihAxiQGQC3qwwYCocoboCCDxODJdErNy2AlJzJ4mh+I7FLI+CI/xuaEP40Ym15MUnoZyPFq3VHhFLVxbjiAQvaQcbB8c7SbEsYseXR0xOvnvy3ZPvHum7my9HakdYvaXSp7pd+tw7PAL5+pQ8t0ofn6zHcVkMJHf5pSLPcQlJlUjvfpyAY/8sHIQXTx4eWfiK9ZFM5VvEtxN9yOfT+HhMnPpTXSCBJEfJwQwikTCviO6UYlkkkqgutmd76/pTCwzUKSgRIWr6bOVGjIPI/MihWpgH58x0ReB8F7IFh/jIwSOCQEZAnNUxdQ9P+JwqyVMlecpGp2z07WSjUyV58t2T7/4xfXdvJZlQRd6i6iR1alBamnovd9QBgMVnE1nicsk542y1gshYUmNp+cpBm9aq0+qsaYi6yetm46I1qxmNGr9sVpvVab3W1LK5/iH148TJ8j6V0bfUo9p59D9BHRc5YFxB6LpmfvkPxOuLGYY1OnMd180g85I8h6lqx/p27dh3Q+ANEEPt6O9YXrwf3SJ+3LdH9Cg32rnBMluKTu4UYUmJNiy/CTmVjqfS8ZR+Tunnm0k/p9Lx5Lsn3/1j+u6vKh3rh0rH+q8oHesMS6wZlli/ZeloQt2BpdkMlAI8JDv88fd7avVRub36ii8u9HJVZK1VcLLNddkdd1ZxsRTkViKdVFwY3gB2ibB+DEunEOcQIh38QMty5fFya4nnj308/GdbS4v8GBkCvP5Kb8/wCI/0mdjeklksh75KCCgo2C6uvbpgYxZ+EzzD8g8w0DroHAL1V1zjVNr6ovVgNkKOb5Fj1n2SX0axZP33suiUQA8/xcRwMZa63nFcQK6ZcwfaCPHkyfCVlKCnUv1Uqp/S/Sndfxvp/lSqn3z35Lt/TN/9FaW6qoZ2l+oAcHSpDrClCktqqbf0Lcj/umInV1EUkHkz16Ba3UxrcKor5HleeaOPln6ejyd2dXniVVcndoPyc3KpzbqcHIPVCVSKDoJP+XnjY/q1hl91YT0pWYl8GyaIb0J5BljQ7LrEPasUfznhuJ9LhrssT0GsBRELD6hK70QA1h72VHNSIp34Fpq9jJGEXGpIfZOjBaApOpOwF3P8LfsK+hYm0ZzjgV9lgvQYSPSg//guIOiSuo9jgz/g696311/Oi0S0g5ci8e2dDeAZULrBIrLwHtUFpkLfMoK+7oGejgxw7QiN4+F9FmaMBb2kcAsyTVK4lVDbImiAYDV2LbgP3YY8XfPq3Y+T12yOZSyFEbr+iQkL+w5wxCGYEYXJdnzSBAdR5vLdaL4g5tq5szzolmxmg1DYozMWgj3EX+b2IX+MIOCT2HGQoBiDo9K7ekzxSdiYWkuptNE4LdMpgxTLPDfuNaVR6jcsR340hh9/PDo6u7EwuqEjEYxikdpH9uDFfPEMXy8l4k8xNl1i0wlb8HqDCinaB0OeDTcgNki/DUhaL55c4tMz+LA5gyeIdZMGlISiI38Cy4i19mI6cvh0xJen49H5cWFBjs4Piz9hCCDF2ibrMWPhuoH4K2NoOugqD/MIPO3FZH3GSXXyCL1WyZCkyyl1S4eKk+i7BcdwpDHxKWZ8KnhcufZCbvuRNAtx4SNdmfMxxzM9foDEjJCmawQvphkn1HFCXcaJQNGvbt94TXeiIQ/yRhMygE6qf4oEitBMbJS4CiM/oS/TGE19BklYAu9K/nGVBkH1S34RidAJDIRqLNiTM2nwN1O4MPnlhBUvNWxKcJte24WcuyE3SW+yYYp5+PfGL3LcTldkBo69+tpRekck+f3E3d8o4p0izbcYaVQJjSubo/Sawu72zV7H3dm1dZcZFFloysSS6mOyDnSt6sXt1UdcHl8I+BfeUhygTgD6LOocqULKIgLyQvQYihjGwhK0buEJHmLteY5W6y7Jyz3fxdAC3SkhmtM1TD6Ig0OnaeF9FrSyHs/MyRllYYs2g38HkTrn4YK5Qx8sSuxHaCUdA1SObSSeMIZ3P7mqnxyD1umOQHYTGxIUdMtl5ODtGUB2tGQczPWAtZlWYEQyKEJX6YhYFvK6z2RUHCHQjJEF+rpP+MtgMMMlcei2M0Z1YC6wqUCth4PoUYvqy9mUkZGwk0vt8m3DIdxgyfpC2B42shDRobgTmRnuepMtjIDMUZsweOWkGhSUERYvRgTmpflclKqlik7tCt7J4AYhtN4Z5Pd0ZWvRdQ8bd2IlOwHfwoWvKkVib1P2cK0PhRPJfkz69YNW1DPD0KvsVbC72maE27yKFQLAAsSPqJ+fcSUJG8k1PoZog8sUeHFD3CNSwAHzwN/Q0NP1fHtU8mqkrl18TXthOy+ZLeQ7Xgl1Vpn4BT9/po/IU3axHX4xSftukn0BVZvCXePNBnL9jUQnodSGjz6RX5bHWPZdLotMysFyeW/PMIrpyZLLsD3p/ADQU3W57VIuH/n8MzzEf6+0R/i/hh/YyygBQPT8WYsXYwFGIsb//QctPBT5 +sidebar_class_name: "patch api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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.** + + +## Request + +

Path Parameters

Body

arrayrequired
  • Array [
  • ]
+ +Succeeded. Returns the potential role summary based on the potentialRoleId provided. + +
Schema
  • Array [
    • createdBy object
    + +The session created by details. + +
    identityDistribution object[]
    + +Identity attribute distribution. + +
  • Array [
  • ]
    • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/patch-role-mining-session.api.mdx b/docs/api/beta/patch-role-mining-session.api.mdx new file mode 100644 index 000000000..616deb24a --- /dev/null +++ b/docs/api/beta/patch-role-mining-session.api.mdx @@ -0,0 +1,123 @@ +--- +id: patch-role-mining-session +sidebar_label: Patch a role mining session +hide_title: true +hide_table_of_contents: true +api: eJztXG1z2zYS/isY3ocmOVOSZSWO/eVGcZI7Z5LYJ9uTD7JnCpGghJYkWAB0rPP4v9/uAnyTZDsvnWubUzvTSuRise/7AAJ8G6hCaG6lyo/j4DAouI0WE5WKDzKX+fxMGAOvgp3A8rkJDqfB8fiY4XvmCIKrnSAWJtKyQB7A4XwhGMuEXaiYlUXMrTCM50zcSGNhANM4OKPBzDj2rDT47XR8fvSvHjsri0Jpa5gqmMzZ7WWgRZHySFwGd8ApZtGC53PgahUrdJmL84UWZqHSGN/2lUbuH8vsOBa5lVYKc5yfKotfeIqi9xjKWFSPSCKDU9mFNBvlg8d2IXKmRRjxNCpT0CrugVUKrjnoKjTa5jaQuTPhAl7l8AK+eRZg3J3ARAuR8eDwNrDLgl5ajTa82wEVfyulFuACq0uxyaYb5YrRCDNQBt0mcA5xw7MiReYvo92DgXixH77c5zwcifgg5AeDWRgfxM/3RqPnw71kFtxdubmFsa9UvETZHhZl4nzxbZZHI2/Qo8cuKFCY4dciZsZyW4L7tf+OlmQJfOUbB4PSkcpxFpSeF0UqIwro/i9G5SGZ5u/4EV+vuYBrzZfAQlqRmdZzNftFRDZYVX/M3p2dfDxFnuykyhzGDYtFInMQdrZk08nbI/biYDBkIVEzIr96srC2MIf9vlUqNT0pbNJTet5f2Czt6yTCEU+DdihMITkpyCCgwE+FxlxFs6Kc8GotkDbFTZ3fVagIDbbMXLDkZYbT8DimiTN1LegD+Rg++QeRKtBGkMoWBWlirKK881I+KtGYuRfeMEqC4zTkVQGBhHECbyDTmOV6LiyG9QLFxvqRigwIvBI8ScA7zty2rWQnA/rtuUHEa56WgmyXi5OEMnZV2mbwR/GZtceD+tKmnayth6MWc6Hb4/cGg2ZE9b41pI6viqZ+ULOAYLYw1ay0zuO+ohQLmcoiuLtrcauiuGLmvt9tLM5kBW/H0oANMbU6RtxhVQzSu0uMj8uAam+rGDf05kHDgZy1XO8gDSkb6tyh1/XgqYvrVgS6sAr63XoT1M4MXu6RWe8Z9khBavHZHTzEhypRizrhqREPDSBnNfSTD8z3UigKg/3+7qA/HDbjXQJ+3dgrjACY2RTgARchw8EQ/7eSclEkCsyVkE2ELTVWKZmQx33lZ5+hgJkS6IxJyjRdMl6NgchVRGqWBirkI8V2Y4X1gX1H4o4Gg3UJj1KJqf1Ga4i2+6WcQYPCVixzsIyMv0OW1VoaC8tleqRi8XgFewtlPpxrTtVekMgRDISGqK5ljAUsU1owx5IppwLR9TppApbo7bJXPAZ9nX5HXhnMF82jX4EXYrLHBLrI5W+Y0H4IgoIqozdMK/YFn70YHAxHyYsR58OXo93957ODhO/tDQ6eHxzg7BnEAZ8Ls6FNdqf+p8iFlhFLFcAi+R8wiBYcbE8C0OQPddauD4jHF9gfS5ijrdX08jIrbuwOoIRXR6dstM9SgIklPefzFSPk4cUZYjQIdj7DRwh1QHPH+ETLucw3iVI1zNdv3o4v3p/Dk8mbf1+8OYNPyGut3o4Bo+UxhiWICrGwUJ9JYq8A5R10NmxlPfbMc30GCvHctAkdAPVJiFiDl6mFEX72DSParFmiVdZJJcqbG8ueyJ7o7UAngGcZgZoZx5aAaAHIn7naEb73lnzGFoLHQj/tsXEcS1QS8DPVKQPjl9Sa45jqBjFISkhlEEbCcqC0LFdWRqLri8aUXW80TeN92ymYHCD5FyCNyJYgHKnZzsI6WryI3j8gs7NcV7rz1Sq5zC2PQAuOZTJSWoOFGbRoJmHF4ssRustA4ckrurpitXshlbsPTpjXVtG7iJfmC/LuNIXyE5Jq9Ytr4ZPPL4ywGpE3Kjf5iuTrOQ32VLW7qsRniRTUZLe5u83dbe5+Se6uvpx4XObfEvTZXYc+Fzkvwb6amuca9NEUPTksgDyRW8g5R+7gCtlDpHefziGxfxW0VSFuCsTuvyM+cq18HVnW/nDPZ9XyrWr9jS9QQLKj0yCBSiTiQ5K7kZgM5Uy1tz7bW6VnEgI03wARoWpqtlQl42AyWCnQBgE3OyxWwuQ/WbYA/E6o1hhXAXHWPA4LXIFukeQWSW670bYb/TjdaIskt7m7zd2/Zu4+iCRrqShbPE4yZZZxvXSR5t+jtpwBAat2CFmdcvU+eButIDNWY6ygixyC2XB3tpvsR2IU81H8Yu8gGUYvhvz5/u7+7mw03A/avX7a5HGdZN2cavnb+ZFMDCDuGnBcmUNwGatU3N3+A/NqkWBZo98EKtwMNu+53VCPHUfr2PGjsqAbMAbsqO/ZXryYvEf+MDWxR7upUkcCYbYzHZBzS5ASY9j9pLmFjlvouG0/2/bzw7SfLXTc5u42d/+auftV0HH0GHQcfQV0HDGEWAlCrD8SOsaAOxCaJeAU0CEqwby5bc6X+N1Hn/b+lEkF9DoocniwjiLPlWIfeL6swJLp7ETmjbmwvAFthrS6ogUCzuZQInM8gyMB3WJUyUwgJsXTT6nMJOUxKgR89TIcJ3g8xuVMFW/1LDKP0hIkpKKQKtx7VRBjEsJJJAj/gAPtg86hUP+Oe5zeW9+1H8wmqPF71Ji9uYmEwJyv93+fbzolcIxHhbBcnDlf33NcwO2Z8xyWEeKmcOWrhqBbqL6F6tt2v233P0a730L1be5uc/evmbtfAdU9GrofqgPBF0N1oO0NWI2l3mJw/c8RO6WKl4DCm6mIsHrcYHDCFXiLJPC3UoLmgCxeAwjdNYDQXwMw/dv6qsUdkLoFgZOv1CmMqo7f34LbwF13PV7InnQng5e5+tyLVNafga02lCE8depSDgnY+PTYrzh6ZGgtMZZd4SPmzuykGkYtmJ8OGjzIma45gD+XsBhhjs0Og7j3cUWPQcQCFhU/GaLu+UPgK/qBXhc6vft+XRyje3TZZL4HZwN6BpKuqIgqXKG7wP/AiPx1AfIcuao1LtHj06s2zRmidCfhGmXTefD3geGaQCdINmSvBNewhHBHZp68+3T+lM0Rm1JtcLeRhMTFBGTXKYQR1b5xdXwEB1E70qqcL0i5ceeADuYaS1IwCrvMz4RgU38CffkRmsIEqjiZHQcJKhw4qrkgEotrkWK/7DXWxuCUcd4HK/Z5Z9xT6o20iJA5Xu2gp73LPGSvJZYszA6i8SrSmpBNi0ov3tLrW4X4W8UtdNxC4maerkjhTDuN3IHvCBLencU3ZK1vntzxC1v8cMUFT5DrqgxoCS9H91hVVHntm+Xo8AuRX1eOy/zTQkLj7Q6rbssZ6JtpzI5ZtFDKiH8whqGDqTKdl5Bp3yzWZ5w0pIwIh4OWSKGbMpQhwEiS7z0kRu6Cic+wjROKUW5DhdL2Z/Is1IWf6ULIzx2d6fEUui1Sxioy3ywzThjihKGrE8bL75oZBhbkNupAdcAFwFHjf6oEXtBWbXS8NlZ+Yt+nMdg+IhCVuJji0H05bIqg/8ToBVLXNFCqEYXXB83gO/O8sKN1jFXtH6xacF3eVEEjXbGbk7f+FRSb659NX9R43GyznOTp8veu0vdUkj9P3f2DKt620vyIlcbjYtyunDSXdt88fnuue5Gxuli2dlMPQBaGMqnkFyftBHrl8eL6liLueS8E/BfeUh0geA+LJ1oOEkJqMwLxLGYMVYxoIQVtRhSCW8SeOxi1KqMsL7TC0gJLTmI010ADJcEAJuYzmQI/2i6vZuaUjA7YYszgd1P6wxvK3xzvsU+wPswjcDmuDfHYMLz7RflF4hl4nS6mstdVIAGgy7Iyh9kw58uMcQjXR6ItliYqXVGEpWIuKlsogpX1qKpCYBijCj1aJenMnCS4zw1L6FZQPTIXxJTxm9xg+taV0UaRiUjrK5vdZcNjvCGSw4VIC1ydQkUHcCdaM3w4Pl/jCMxy/8sK3nP2g0wfafE2Lijvwmevt9sbhLRcwYvEylhYT7eYu+vWG29/r4bibbPF///1lwh8Q8WVUL/A7T40ZelWb64KTINNy2YYetj8jQIoAAswPxLf3uL2EC4k7/AxVBvce5heNWtEKjgQHvgZVul0JfYBdzyZ+EvFT0nrL/x7Bhv1qjY782WrmsHHXwVujzTq3F0BsdvGImHde/+7SXi+LNrXbB/6ywG4ynaD3S7ZA8OoitY7FxRJQD3zf1whc7swmn+Gh/jfw+AS/oUvqnB5CUT0/Dao9jSBxjHGf/4LG/ShKw== +sidebar_class_name: "patch api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Body

arrayrequired
+ +Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session. + +
  • Array [
    • value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    oneOf
    + +string + +
    + +integer + +
  • Array [
    • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/patch-role.api.mdx b/docs/api/beta/patch-role.api.mdx new file mode 100644 index 000000000..01434e2ee --- /dev/null +++ b/docs/api/beta/patch-role.api.mdx @@ -0,0 +1,163 @@ +--- +id: patch-role +sidebar_label: Patch a specified Role +hide_title: true +hide_table_of_contents: true +api: eJztPWtz2ki2f6WL+yEzXsCAiW1cNXWXwSTDjGO8gCc110llG6kFPRESVw87TMr//Z5zultqCTnGzuydR1E76wipH+f96m7pcy1ci4gnMgxGbu2stuaJs5yEvqjVawlfxLWzmxr+jGvv6zVXxE4k19gYms6WMmb9qxFL1y5PRMx4wMQnGScyWDDsw9IYL29+nI4v2RUO/P6bZZKs47PDwyQM/bgpReI1w2hxuExW/mHkOce9VudbFm+ChH9qvgveBbOlYF7o++EdDuVJ4bswUSQYAcrnvjhjBwcBX4mDgzpcWSCqGyLARq76Ed4FIlKX3HFEHF9FoScBO3VvJVZzEcVLuVa/I/G/qYgTHMDuNFG3B2HgyYVpeRt+FBUPYrFYiSCBCd4FfZZAo4DdyWSJhKuz8eT1h/75m9FlnU3GF0NzHUbq5/T6e7rDeJosw0gmGwYkR6hkJFwYjTnc91miGdFko4Bx15WIfZ1xe7qHxlvxDQsDf1MciUmP4e8+4csMlZgMHD91YWoZQFuhuIzc4HEcOhKkgKCahmkEHdXMKx7whUAisLsw+riIwnQds9Bjd0vpLNUwBeAABM4UK5pKAFb8k1ylKxan63UY4SS+CBYwtgeUwgEsrisZwUE6rVaLgYxE3EmAq012EQYLEdmNEURAcw7iFIlYRLcwNI6ZiXGEol9ny/BO3IoIaBpsWCDu1H3Amt0J6M9jemD0ACiQDVA5mS9XUpOqDCSo3Rp+rAT+AuX7XEPZBm2TLjySgVLRZa2sjKNzJGnGExiZFATaGXGpnSVRKuq12FmKFa+dfa4lmzWOHCcRQAotxSe+Wvt4q+P02qetU35y2j5q9Vq81YarbrvTFvD/l+3T2v39ezUyiPv3obvB4ZwwSIDLeMnXa186ZFUOf43DoEHA/AMv8fEWCDyK+AbxS8Qqtu6H81+Fk2wh22doUsiisLExX8gFV3gyAMLON+xm8mrA0JywBnuqASpQ7QYsJHEFqA5IryM0mIkUBCc8qiBk2U4KlhlZ5AyKm4hAzlYCmSqCdIXTgObSxKvwVtDF2ucOXukbTrhGGoGEJQhIzi3T8l5D+ShEfaYeaMKEEhgXgV0hJQhIblGSEh4tRIKCtESw0bz7SpEVEtzzgDuK3ImNZEGWDu25AcRb7qeCaBeIsUci/rAgXoKu2f0BfZn4VuP7etYdsQD9tvsftVp5D/Pc6pLJl2mT3ciGAGFOYKp5miiOa3VcL6Uv16AH1mhGis1g6vd9heMUjKig6ZjG2uwUiFjPDT0+e4fy8a4GXHDhWrMcfmft4y8SDuDM4PoR1JC0IdMdeqw7E5Zv+Efgr7Ilk9wL0uxD8qhMJugFxoFgA3AV2KkiPNBjshgsaIxmlK1SP5F4S/tydEBIA7KdrnIZnGHg4GsnT64JDaOWnBuldpaCKKmvHVr+Om+OVg+Z9EAfHR+U2r8HevTjWC4CQwVUADZV3vwRZMHKpyCeyhcsib9onBUyOM6DA6MmoQPXCqjvvogZmHdoZ8w73DBxBSMhq6COsiYGS9P8sJG3rHkn8/b8lB81XnrCbXQ9t9vgbqfXOO202l3RPjoR7V6NSDEFM4CTv8kCJIDNB01BizaAQEJEkitMLsDxIbYjFy2JsZM7iQb0VwZckwbQNBHZGikDpvdWEnE4uNDyNKgvnohE4GQWSUZAuHgn0clDv5plorRij86Hl7PR7JcPF6PpDN2UhRsMKd3cZfZOjjzRax074DK7neNOq0fEdHtkduyWx/bTrgeM6J4ctzveEZL8qVSfJqCZPALl/IRGPJbK0X4t2WFGFcNPZ/3L8/7knDl6Woo1KVx0eCzqeeRhYpxFxAMd42AkmfNJx31Lfiuo18EwWMDkAs35AcuMLfOicEUNZOBiLAFjqbjy6/lpsEGnqvFRztyYw7PaeIIPwci7IFF6ovzp8F/X/YsptPgoNta4JCUXwzfwby2LFDaojAarpoIL/B4EYoTNyBKJ05OTVtubo0x02kcQaxkBQb+pHN7PWnctopG8KIvlusBDNP0Dn6PV4coADRAP1BZw4UMTmX6lyHCaiyjEHDWbjhGyCcoyA4/MTI8arJx/h6b7oWGHbcRKfLk8n354O5r9sMUao8IP8QXiUelvk/mfWtU3QXjXdMIVBr736PRLYTXdiNfghZW9g7B+m5gTauHqvCjPn2Lj/ZoU5T0YRVeGzg+GyDqJL8araIB2iVela6cTTUZyoDKrFfg2SmKEl7AgBd2+W0KW6USCE9tBBLAPZLHQPbqTKIasC1nO99w1sQQTUQQxDdkKoBuEBM2q/OP4pNtzT05Pj9CY8jbvtrL8o64DsV2QWaaQgzYAPpcCF1fGYC0gj4MBbCwx0uafLiizrJ21O6c2RMSpzsvjE5yacBU7kPIcmlmmEThtutZrGP9z4HMNWd9I5EoUSdDqtButo0arPet0zo46Zy9Pm+1W938oM+DuGHL2TPRWoSuBOc8CyOfADjNA8wlwdWad1hmA1nkYrsLc26Ch8FCspjPTsgSX+WYl+UW25dBdRwFnmD0zJ43iNIZEy/dBnUQMcscCGfssjBypKwqAfQj5lrovUhkDHZiXxo4AikRzycirgHUBayfXMnZQvldcOBA0xthLMsAFrB0ODnPCvDAmXEC3FGM0V48TpIGjZjETr/gCIY2cFFKBSGLr0Adtl0kKEY5JtNIVE4FcleYE5ZTrGJ5BtryGngpiV/KVuR9G8F8TRZUqXlXmIie+x/14i/qUtGJfRWrQftWzuWVS1MAVSZxOazPLu5UHjWl87FdpYIREA2LZGbAYsaDk84UZ9AUDYZDBOk2+yt5kMN7XdzKROprZMKrKlO0W7x57nLtCdFvtY2/eFa32qdNpHR/1drdbPzxus4g9EIclJocqUCpcySRRlTrOrsbTGd686s8GP0AXDwlZxxSOiL1SmQmMCVoTYR6i0lN7IogKbSC+ity6jldISkkYJiaCR0IVK7RPqRY93efl5bNiybMAtueBT2qdtk9etsUxeKKeh76ofdzutXvCcTgC/ZA2lLQLnuKEOmEFNmnteqoe9AeD4XT64WoyfjW6GL7YdsVFdJ7DNa3GxZmKBajSs99TyIvwF+gDF5BGh1ggMUagKGbFvtp7WyLXtwUMRI8AL/gkrIoE1Jyy5+dXLIf5KLqIrtLYeC0c8LwOMRQDdAJpdyP74CygruezsTKuFhftDKXAQvvBjkawONvovCqE652cHIEhPNIVhVJK85CUfDkwKM5rC00RgsHldxbzmt1eS3iueFkfX383jhaDEC+mIrqVjjgX66R+Pvjuh3/1z/FfP3S4X5AVa1KSFIy68hQT64IlmL8sD29RT3W5tW6kgMpFPMnjMxnrCqGVTG8l0to8xKDysbfJJSrLulCnqSUu1GigSdbYQt4CGNullKc7eSujLhZLqlcNsVu+6iF/04WyRJvFqjpETJUPiGoYhpjUPF8XTO5Cws4DJmzyZaIzXEE0oJ2xkS4kaDITia0ZZL5+gMtbIlppMlXkrzhwAdFdRofUDtybtleIQMarvKBE3BBuZXRiyk9GJnGKvDY01QRC36KSlLyy8TThPCcqxHkCT3wpIbQlIlYe/rCcZIWTy/HsQ/ZjML6c9UeXeAlzTmZZDm/n8wAL/B1PtkWqHzyw9JBNYFPMFM6s4ne5WFARJFcZIopWYlWAy1iZhYZZbaGOTixMwfLDLX0HdNJ2CbQCIIMtocl4+Oygu47OeXxNBamS8S9FQJn4QgxBFgUl1FrXzbQgWyfSK/5GJ8gLb2Ef19GpGfSze7jIanlWLN4iCROwSP6m5MYzBKrY+JPYGInPCzu7VAXsKCOvOhbhQt7my9RVxKAajbKYOcRVZaWs2PdUd5eHpqr8qQqj2qIH28Qto4BmLeJ3QZPiPFpPkp5SaVzsV8QlgSxUL6uKMZ0T74hTMeYlJKTt004bAuBerVgOu1H4Wex4/yDntgpuTyXOVK1jZqtpuDhKtHpEDaNqPTSOONvgAHaB3R1Gh4ltr9GAG+NByZSqgxuRoP0LvuAeC0KXSuMcuVAnshfWgjGrDkgIlaWqs9ws1pmxinVmGUUFsjGLdTV1Fg8bLoCTNHG+iS42SCdJ4oBai6F+UWgdHvlCNB1gWdvpeb35sef+E8VXBhz9LlU/7Zr47rHwl3m4dzd7d7N3N3t3s3c3e3fzu7ibvXvZu5e9e9m7lz+he9m7kz/SndxXs+5CgJoebVf/tywzOh7EV+96ybZCFUSxTCOw9Ij1eGIvvpiVN3vVrsn62U530pFI4FOAjeqQuZJGIi9x1q3lhIxrMQyljwFw39/UCQZ6wBweqP3+MLPxrQo83QB3eGJJvHELVps3v0y0zp5oTydaWy2w2Nsjn7sNPtvxqPde5evSAf20C8d0ZqHKHT+92q/N7IfBeDIZXvRno/ElXF++Gr1WHtpeDMxuTMAyDKezD/0rePRz/6LgzOHmxWhAI2EE1X9z1R+9ti8/wGCzIW7KGwwns9Erq/HF9VQ/GV9eDgez8eTDdPDD8E2/FCTUa6/HPw8nl/3LwfDD68n4+sparbAXLnLQs1saeLh1MXo1HPwywAMrs/4MG131p9O348n5h6sx4IAj4XkW/Oea/pmOrUfT8fVkgHdn/dfq7wfAZPh6PPmFfk5/grmm1xc41WR4NZ7M8t840M+j8YXB3LChP5iNflY4ABw/KdSq4krkn1Ey7YWRxaQp57NxbB2wwS1q2osYoboM70CuvIiDPKROkkbigU0UueyfJ+FMuc+tddU/apvFl63VDivSBqgi8rNluOIxG0IPFYNzX/L48llAXMcQr1ZNWZgxaQo92f1DS0JZv0ettEmSyjYCUJoLNJPiExjMWN4Ksw89jybsLdi0/8BEYwXzs20Ut5euEE5fLLizsXAIvPDpyUxxm0AQJsDKCDqCDVd73bLTDPB4IQLQClw5hPBfnWhRy64HOMkBbXUGw75hEXoRGcQJB5ML2MbhSmWS6hgDbWmeC7MDA4ZRm6e3VjFR/zLPRAEWDhyEzFcn1ErLmE32dokbGIDssZmPdmnECf7FU3W0AXuDO3RTQBlAX8lFlB3HM5lvGJVcwjY4hR0WtJU3puMnoPi0L5C8I1un0TqM1Qk4jNolzROnEMSrifUWX+sUTeVWetSTzOdeWT4o23yhDmfk/echoM+DqgX1LM0za+e6N6INElCAx8iMx1M/0Vvg7rMTbUqunj4nxglzYZ+dyrZ0mK0+8S5gVBwzrVrFLdn3wjy02CwXqbb26nRRtouvtr0EXIwAIFymTHaSJUJPoobZ1xQZC4a7mrkMUBvUjCqSUyc68LGajv0Kd3W0b42zTbJtUpRICDZJcn/wfDRQrNcIH1xXw0q2Dub5HaBVM3F/iru7K0PCIpB0yEbdmpvZgdzrmAI/GmwbqB23yxmsZ48EgeO3lxR1velf9l/T1VZ4tRWDnCuQ9XYPPNgBJE05bWmjg8Em3WR6N71EM43Cm7GD+4Rpk1GOHevTx3ovSExnxg8OCLaDgzM2zrewFioeqK6qqQYfG7+hk8pR2euCbf9YoqbqWsYXx+iz10i8AD0Ee40oqbMxqu6h6hyAXu499dnJgwND95F7cKDsb8HdbxE3Exvs8oxCTLbDPyv2meHqqoJHGQ8JuS0SCH1FHJ0D2j12Tnqn7V6DH/e8RrfHO425cOaNNkRtJ20ujo+d4+I2vILwvwoj2tV9XwgXjF2GfD7ZZE3QYN+G6oTEDtZSKx0+2C5+mnF2M6DNv7AF1fu9/yomdFdw/6M2tCwde3O6N6d/ZXOK8rxlTM0h4R0qUtnp+0fIkp0GPqcig5mBqsk82NTtJQmghInc1QlpdR4pI8XNbgeW67VOz5kfO63jRtvlp43ukeCN07noNuZH7c5Lr9M99Tq89r5c56eCgTkwUyry19SZv27Vqb6BL7H4PqTN8w02EUkaBXlZ07iTeejS21tkALyRX3fUr2hhXAGOAey0u8OKwyvI8huQoNEuV7Xf34GO1tHqVRjhUSsc0kh0RbkdKNFsFw4PDDQyKGYRd1DFq/WoVOsI6PCU6YJnm8ybECqmFSeCz49bvU7XO+5y3jnttk9eznsePzpq9V72qPADtj8Gu/O4A3iNaT/oKW32lr8BQSBrj7Wvp8l3t/I0xg70x6U61TZDU8PLEvEpwZf2fD+4Yt0T5vNgkdJ9vigRIWhcT6tKamrgcSQX8ovL1ufDV31TYdRlTRyrqmKoz16HZMXp5G+OAJ4eVAUELFEc6FEPACEexHZDqX7FG/A0K6YdN/TQs1f0sIfOD4JbkRkSi30jm6JZh4w7O8I053G+u/oAM+J10rjQlDxgS8FdEX1rF/rV4lv2GgruWm838lIsclIpNEwTrCFIp1TzzEm5tcVam48LmymoHAD5Dm9ocRL044SmrYWZtGgQ87PxinLlomRONCIpvlfLASyo2OWEEZbE2Bxwk0nMtDkifwqGJzDtMotVOA+B0LxRwJwnIT1z8BT443p35YP5aRBq2YNboZWPNiCYODGvDRmLpIuP1Fm3ythlFD/z9nvd3evuXnd30d3yw4l+l4F+SqFPezv0uQ70i+TQeW6FPpFQtXfztrnfVAalGEk7AXSI9OPbmX5VHb1sYk17AH6/+Ei58i3g+xk/Skmgcf05LxBAoqOuBYAlEu4ZwZ1DTIRSpDranu0VngMHAQ0qQsQU13s2YUrJV5QGlORzCJLdUMTBi0QtLOg6MllAKm67jTW+uWsfSe4jyb032nujv4832keSe93d6+5fU3e/GEkW3zGp46Q4Xa14tFGSZl41RueuoYEpXIt84Tp78ZcdreBgLIuxasXIoTbvtOdt78QRXZd33eOjntdxjjv85Un7pD3vdk5qtq+/yfU4U7KiTln8VnwkEtPrgyOWBiBccRKGbrH8B+SNhIdmjfbqmbgZaN5UL3BTsWOntx07zsIQi+kbEyHFhRgyyGmENg3arrCt2W+gXgCjTvqDqZKhKlTLlYBRcIuIeRsx7vzAl30m0abR93DlSSmKEbJsFv0SaPUmONyxQkVcLnFjpocxH4xAEewCrPPvGJ1qFn1VJM8miPEFYsyGnxwhUNGzyP1lVX13hC/HRRsxVQx+oNCrsh0egABku4iyuHMfn+/j872P3/v4v4eP38fne93d6+5fU3efEJ/raOjh+Bwa7ByfQ9tmi2Wx1Cvau/P/HaaTqmgISLxZ6NAbD908Bqd9EHATt83jJLgZf6BEuZ/ii2FvatINznCjfCMNIHBzPgr3TH3kBC2ReVZ68h4/A7ASIKPZV3Zq1ovrcU/34Wfp3tdweowzFYpp5MNz882Kz8B54Ph9k69ls/Rm4sM5kLvCkuGWA6W12IA+7qImUK9gjmgnvLKdNLjinN5bVYuBg1Rl/uLI5qzCJkzBWtIwdTwFoEWTbgOIa8hLXsT6TW3qywkl/ACv68i//3pc1EAP4FJFvi/OBu0ZQFpCEVF4n0uLte9sS2Zyx4SJX2drsjE267DvBY9w/x+thXzz49vZt/psQn6WQL/tjbMrEBEyjX2zLvBRHUpLllGYLtQZ335h5QVVkXk+IMzeBVMh2I19tGcCRp5Iip0E2RXslX8xxcXDa+hOmzklUfBA5A+BQoe80O9bcp2UY1hnB5rvggY7p6MYEkMAbKNRVC9EvFkbvLiF13OB+C8zWkON1qDR4m9LUOjvVDlqJ48D9gCH4H5M1Hr25Gq8hjVeg17k18BRyzAgJTQcxfUyx3Dt2XAUxmvgeEU43gVv1fnrQjemrJU5UzJizjIMY/HfjKHooBrcLFLQomeDRfu+GqQRjU7LAqmhpmzIBkSZBN8FKEaghInP0cvrl9B74FmVSv6bOAs6/2861fPvAs50+wacMbZ0Qyd+Nsw4YQMnbCgbEGv4la9DwQLdRhzUHmASgEHOf7IEGlDL7qmxKq06DX9IfdA1OAAqjRKvz9SPs9zA6StGD7B11oY+0FLLVxDxiwx6LHR4BWKZ8kKZgtvw+iH42RLdFLxZeQt9758NX8S4n1dh8HWSv7eVfsCS/Hns7h9k8faW5u9oaXTYjNXMSf5JuGG2b/fBj7TY6pV/lmjr01Xv8cN3+hSozl1sBfpex4LbFcfYnJmEp2QHKPqH3Cr/Aoc9EICXoMaQxXCWUlCtYi04HQiso9SGK9LydRSiaTGfOFzQcc8IyMF9va2aqulmZnVsVAWtKDPqZQTqFAd+xHEJua9osreQPgYOsBxTR9wPAs9+DXUOOQWu05fa2LkRJIZnM9IA99QD2OmKcRDXR6TNlbGTKqMImWQgDC3oLQss62UsBIoxokDnXfCNuGNPvzLZEqpH5gKZinUNHEhPR3PUN9RyRCbCz75hVkwJHhsbJLmxFP6ajg4DWJCKWjO8Gc22RoTBAvX+Gvrwn+4UH2JbGARTLyU+R812s9WgVARfxxPGCeRy1uDq+4PcOnygP0dR+uxFVvzffzF1/8XU/RdT/wNfTNVhG+bbh2usOaPCpir/V77mpkbzQ9sz6eLpjiWoM97+/BmrkVh0uMfbII1Y6rp5n9cTyIGBudEn0au+lmLr+DfmoNy37OFvslYCbErpwcZyhjX9Njd8XwZ940tVRwko9UAvxzX0izZMxy99ghUrL6qzKr5+oVutULei74dA67n+5OtKFfcifgc38e9Z7R38D36EioHYiO5/rplSObRRA5vMoyrw1hfACGj2f6ezXVE= +sidebar_class_name: "patch api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Body

arrayrequired
  • Array [
    • value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    oneOf
    + +string + +
    + +integer + +
  • Array [
    • anyOf
    + +string + +
    + +integer + +
  • ]
  • ]
+ +Responds with the Role as updated. + +
Schema
    owner objectrequired
    + +The owner of this object. + +
    accessProfiles object[]nullable
  • Array [
  • ]
    • entitlements object[]
  • Array [
  • ]
    • membership objectnullable
    + +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 objectnullable
    + +Defines STANDARD type Role membership + +
    key objectnullable
    + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
    children object[]nullable
    + +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. + +
  • Array [
    • key objectnullable
    + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
    children object[]nullable
    + +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. + +
  • Array [
    • key objectnullable
    + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
  • ]
  • ]
    • identities object[]nullable
    + +Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST. + +
  • Array [
  • ]
    • legacyMembershipInfo objectnullable
    + +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 objectnullable
    + +Access request configuration for this object + +
    approvalSchemes object[]
    + +List describing the steps in approving the request + +
  • Array [
  • ]
    • revocationRequestConfig objectnullable
    + +Revocation request configuration for this object. + +
    approvalSchemes object[]
    + +List describing the steps in approving the revocation request + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/patch-search-attribute-config.api.mdx b/docs/api/beta/patch-search-attribute-config.api.mdx new file mode 100644 index 000000000..97bd47663 --- /dev/null +++ b/docs/api/beta/patch-search-attribute-config.api.mdx @@ -0,0 +1,117 @@ +--- +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: eJztXFlz2zgS/iso7sMkXl2WFTv2y5biJLNOJXbWR+XBdm0gEpQwQwIcAIytcfm/b3cDpEhLPpJJ7cyklFQlEtlo9N0fYMA3kS6E4U5qdZBEe1HBXTw7EdzEs7FzRk5KJ/a1SuU06kSOT220dx7596wmYJ6i9Hyiy06UCBsbWdDXveh0Ji0bfzxgZZFwJyzjiolraZ1UU/Ywsx47nQmW6izTV0idSpElwMAIRqLySSb2LtTGhuK52NjosI2NRNoi4/PD+gEvikzGxK6exW5sXKgxc/pXodiVdDN2dPzzf8evPxwcMl66mTbSzRmIbcRvpTQiAVIW8yxjLijTA4MU3MAsThg0y02EMoC69F8nksrbcxbdtQeKxnQKrMQj6uOspCfOVokS7TlTik5k45nIebR3E7l5gRNb4KHQUeKa50WGjwqjc+1E8oHLrJ4jur299OyEda90MkcesVZOKIcfGwbr/2K16pII/8SP+HppXm4Mn6PGTuS28VxPfhGxW1J/zN6dHB1+RJ7sqIo+xi1LRCoVmHoyZ+fHb/fZ9u5gyLpEzYj88tnMucLu9ftO68z2pHBpT5tpf+byrG/SGEc8b5nqHAKcPAV+AKXBHjCjk4LkhFcrrHc3eMFXtZTgjwmEnjCpNjnwB1urMsdpeJLQxLn+IugDBGGMn8KDWBdoIwg9h4IsXFRR3gYpH5VozPyLYBgtwXEGArUwwoIH8Q1GluNmKhyGzwzFxpzLRA4EQQmepuAdb27XVLIVQP3m3CDiF56VgmynxFFKYX9/9B2KK9YcD+pLlzWIbzv1cNRiKkxz/NZgsBhRvW8MqeOroqkf1CwgmOuUx28hRYuZzGQBedDgVkVxxcx/v11RzQQjKwQ7lhZsCOHQNmJnUTnw3QXGx0UEXkjgc3A5fK/p7YOGAzlrud5BGlI21LlDr+vB5z6uGxHowyrqh8IUXBgpcVWXBCxJZNp7hjaKapsDq+3LAg1TLV4+Lyo+K2tx1AirYby7+XLwcrKzmybD0XA42Nzhg8nWi2RrkG7tbr8EJgL01HMhDst8ggFxe4n6t6sjPbAF2NX7fTgY4H9tTx4TBbQTagBPqMZQo3wLS3qU0fdWzJVlso7OdhHyIflY0jd7RsvsrbiBN3cqPfBpuO5J1a7px8enxFDFOVlr0tV+frQ1fOAFztgYzWRCSQNCSAMOsDqW6ICFNL12vn99AHXuG7M9GLzEMZNVQdfIyNV46ZZoRqsCbz+TWIffGAOlocuOhSsNNj7pjR06M5tAa0YMIhWkh/yeMZcIBy7b18kTQuIt9OTu1HBqzYJEjmEgA45fZILdJtcAxzzLKl6IruUZtERvk73iCejr9dsPyqApDY9/BV4IQh8T6EzJ37D6hiEYIVX5XTGt2BF8sj3YHY7S7RHnw5ejzZ0Xk92Ub20Ndl/s7uLsubCWT1sBWnWD9tQ/CyWMjFmmAQvK38EgRnCwPQlAkz8Eg9o+IB5PTElPW6sZ5GVOXLsO4+zV/kc22mEZV9OSnvPpHSOo7tkJPFFlliFkroukZ3xk5FSqlUgyoJvXb96Oz96fwpPjN/85e3MCn5DXUnMcQ8KqBMMSRIVYmOkrkjgocAUV1AIMQdzRYxuB6wYoxJVtEkr/zc4tGBOBIS8zByPC7CtGNFmzFGBvK5Uob64deyZ7oteBtg3PckKgE479G6EdkG+M41gUrvs+WHKDzQRPhHneY+Mkkagkz3z3tzB+TjgqSTB1PYO0hFQW1FB06ZjSTsbtCtUwZdsbi3ryvukUTA6Q/AmwMHYlCEdqNrOwjpYgYvAPyOwt15butGE0MulcOR6DFrD2mYMZjQELMyhzTDrLQjlCd1koPKqiqytWs0xSufvghXntNL2LeWmfkHcfMyg/XVKtfvFFhOSztEqiakTeqNwUKhK8JDiMgwNV7a4q8f26cp2769xd5+4Tc/fuy+MAt8Nbgj6by9DnTIXtFWyeS9DHUPQoXe3B/O4xoHdkh4FBAkR69+k0bN4AvbguEPl/R3zkW/mS8OPaH/75pFprV61/4QsUkOzoNUihEolkj+ReSEyG8qbaWp7trTYTCQGqVkBEqJqGzXVJO2GmVAol4bbDEi2s+smxGYf6yCEjrPUVEGdVSbfA7YI1klwjyXU3WnejH6cbrZHkOnfXufv3zN0HkWQtFWVLwEm2zHNu5j7SwnvaN2RAwKqNX1anXL273EQryIzVGCtqI4doMtycbKY7sRglfJRsb+2mw3h7yF/sbO5sTkbDnajZ688XeVwnWTunGv72fiQTA4j7AjiuVBBc1mmdtLf/wLxGpFjW6Ac4FW4Gm4NJLxfYcbSMHQ+1A92AMWBHc8/24tnxe+QPUxN7tJsuTSwQZnvTATl3BCkxhv3PbNfQcQ0d1+1n3X5+mPazho7r3F3n7t8zd78KOo4eg46jr4COI4YQK0WI9WdCxwRwB0KzFJwCOsQlmFe5xWGgsPsY0j4cCaqAXgtFDneXUeSp1uwDV/MKLNnWTqRamAvLG9DmSGsqWiDgbAolUuGBKQnoFqNK5gIxKcQPy2QuKY9RIeBr5t1ximeZfM5U8VbPIlWclSAhFYVM496rhhiTEE4iRfgHHGgfdAqF+jvucQZv/aH9YHaMGr9Hjdmb61gIzPl6//fFqlMCB3iuC8vFiff1PccF/J45V7CMENeFL181BF1D9TVUX7f7dbv/Mdr9Gqqvc3edu3/P3P0KqB7Q0P1QHQieDNWBtjdgNZZ6i8H1f0fslCpBAgpvpmPC6skCgxOugFCqr+FEjWPTcQwrDWf7lo6aduvDr92YDpv2b/Cw7i2M8OsCL2ZpMhhcXZm4Ae+B1257vJA9KGrgQDdX+qoX67w/AZOtqEZ4+NRnHhLQHR4/QY/sbSSGtK9/xNxbnzTE4AUv0HmDBzlXx4znsCZhnk2HQfiH8KLHIGIBa4ufLFH3wsH9O/qBXmcmu/3junhG9+iyynwPzgb0DCS9oyKqcInugjAARuSvM5Bn3xevcYmOP79s0pwgWPcSLlEuGhD+mGC4JNARkg3ZKwgfWEn4kzPP3n06fc6mCFGpRJQW0bGQuKaAJPsIYUQlcFydIsFB1JWMLqf+wPy4dU4HU46lGRiFXagTIdj5QTDUIfSGYyjmZHYcJKh+4KjFpZ5EfBEZts3ewtoYnDJRfbBin7fGPacWSWsJqfA6jr8wdqG67LXEyoW3KogmqEhLQ3ZeVHrxhl7fKsQ/Km5dz61L3OzzO1J4057H/tx3DHmPLHhmyVrfPLnn123ww4UXPEGud2VASwQ52qer4spr3yxHi18X+bXluFCfZhL6b3sY8+WOWWifWcIOWDzT2op/MYahg6lyPi0h075ZrCuctEsZ0R0OGiJ1/ZRd2QU0SfK9h8RQPpj4BLs5gRnt91UobT+TZ6EufKb7CJ9bOtPjc2i6SJno2H6zzDhhFyfs+jphg/y+p2FgQW6jDlQHfADsL/xPlSAI2qiNntfKyk/s+zQG20cMohIXW+z5L3uLIhg+MXqB1DUNlGoE4/V5M7wpGXhhY2sZq9pGuGvBZXkzDf30jt28vPUPQ7HH/tX0RY3Hi92WI5XNv3eVvqeS/HXq7p9U8daV5kesNAEe467l8eLW8pvHbzy2L59W1xaXblde4m3tVJNKYY3STKBXAS8u7yzi1vdMwL/wluoAoXxYQy2uFDYZgXgOM4YqRjyTgvYkCsEdYs8ORq3OKcsLo7G0iHA3cWqABkqCBUzMJzIDfrRrXs3MKRk9sMWYwe+2DGc4NIQ7rHFFj32CZaKClYTBJSKeHoZ3v+iwVjwBr9NlYva6CiQAdHleKrwKD2KXOeMQro9EWyJtXPqiCGsTJSpbaIKV9aiqQmAYowo9WiyZ3B6luN0NK+lGUD0yF8SUDXvdYPrGNd+FIsciq6/ZtpcNj/GGSO7ORFbgIhUqOoA70Zjhw8HpEkdgpsIPWPBuehhk+0iLN6hBeR8+W73N3qBLyxW8/K2tg2V1g/kZ3TUl54Sk9MtfW4hYpjKGRTGkG+5I+GVh4y4u+LQReL27kdu47v/j/naG0GtxkdQvcEMQrVz6hZ0vEOdRtbCmlfPKpTW82SN/QJGYgYtw1M0N7iThYvMWH0NFwm2K88vFOpKKEuiKn2FBn0LBFA/44NlxUOQ5+8ZfDrFS2WqPVM0b1Q8+/ipwV8Xf074EOr/xRTL7V+EnLd3TedG87/3QL4bABbkf7PfVHhhGBbfe6/g4Pt3/N1BPwi+iyP2+jeFX8BD/3Ysu4C980YVPYSCi5zdRtQsKNJ4x/vkfMXwE/Q== +sidebar_class_name: "patch api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Body

arrayrequired
  • Array [
    • value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    oneOf
    + +string + +
    + +integer + +
  • Array [
    • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/patch-segment.api.mdx b/docs/api/beta/patch-segment.api.mdx new file mode 100644 index 000000000..ee9f3ef6e --- /dev/null +++ b/docs/api/beta/patch-segment.api.mdx @@ -0,0 +1,121 @@ +--- +id: patch-segment +sidebar_label: Update Segment +hide_title: true +hide_table_of_contents: true +api: eJztXOtXGzcW/1d0vB+SsIwxxkDwh93jAGnpIcDyaM4u4WzlGY2tZmY0K2kgLof/fe+90ryweeSx2zbHbZraI+nqvu9PsjS3HZULza1U2UHUGXZybsPpmZikIrOd1Y7lE9MZXnb8E9O5Wu1EwoRa5jgEBlwYwexUGjY6OWBWsSKPuBXMuAEsliKJDBvPWGFkNoGugl3+dHZ8xE5wpquXU2tzM1xbs0olpiuFjbtKT9amNk3WdBxu7fT6r5ixPIu4jrofsr+trBwpK4YrK2x3yrOJMDgrryZM+YxZ/hE4UClwJvEvxXKtcj5BxrBzkjAZQWdppTBAcwRPP4qM3Ug7ZcenP/x7tPfu4IgpTULxwk6VlnbGQEot/lNILSKkEyKhUvYuaCvnmqfCCo06u+3IzCl0Ck0ZNMA3GcFnE05FyjvD246d5fjUWA266dytdkrynaHVhbiv6/NprdiDPWQhVZGMZzi3+MTTPEFqIt54He8MNgbbYmewudUfb47Hrwf9Ad/c2tjZjl537q7cRMLYNyqaISOPzztiiTSWqbia3Vu58h3DeBgqHZGJ1ddb+UOGssYqSdQN0vRuxLVg5KF8nIjhh2yFoV7x/w2G8au6yYTGD9fSyLFMwHq7YEKhJcenPLTyGsaB3kKVWfR1UALP80SGJM/ar0ZlAU31V/yIzXNm41rzGZAAuqlpPFfjX0VoO3d3lVWo9UxY9nPFDiv5waa2urEjarDmnYVl59XONU8KQf6lcuisRZ7wUJD3gacNO2vzItejboGjXAtjpJPJGVBpNPLRHqpjKpNIi8xPULXu/+NidHgGHbgFZx0XFgVNlNNWk77Xwdn56cHRD3VD5wQI80gk+RT4AdU8TT0SEE/WJ6In6f94ClSv7tx/dxRKJgfHdLrv93rzej7IIjQ3ZhDQ9snofPfH2qOZKcJQiEhEqwzcEgLfFjpzXX0UvDAsEzfQghqF7zSu+7hPLXQk7zBgQo3zY1bCVkgWcznikZQA7BzstVNBL15fj/t8EGyHO4NgMI43At4fR8H2oL/5uheLjXEkMO247PR5c40xoYMnUQi2p/Wdgk+z35B6qAVoeaEwsdIpt2hs6BFgtl44K6Xxmymk6Ib6MR170u3p+71+L+itw5/zXm9If7o9+udfyA7lTPm/4aek/VkMteh/nhEUPeZJM/+15z7H+lRyWLmqYd42lCgXuWJWJAlm2YcrEQ3FokAl0A3szjmxozsvlciKFJHFwd7+0fnB+T/nkcUx0cdxXUZSUBFgaQGlaCyYgGIN7YmILUNmsVwbzJyKvSiJvmAQyDLLC7vKFHa/kQBXOBv0euwNj9ipq4JMaA2jbyRQAf0UiW3rsOIRFPacoDxw4AIAQ9T2g3Bn/XWPD7ZiDqlQDHrrW/F4IHrrr8N+D4rz80PxxyLlWQDOH6GNWCQNVIEZhaKziDdPlx04SAQKa2lKpdJC4IByQB0nx2fn+JBSIAzBOg8ak9YpO8UySDTDQmv0I0q6rYnAF5tMfJW6TZHnSrsCCmqkZ+QMpyIWMH8oKjgKPRaUuycza7sIPt63LlNPGeXY9wTcokkzjWlqh3d11le8q6bc/tldqww+NekRmrycsB7XpFuV6bv5OvqA0A9F7YJUCD3QE6qpnXO0GPDFesH0jxB+jOAI3BLQddNBfqZOd00EMwfU2pMcekxbW8k8DOa+IwVVvS6vmu37tbO2hs2HFzooAegGn2MA9oJnCxiFxO0bIdmUgAtqJ2Xv++Xc5Zdk5hE65KLMfSp7GTbl8C1TTMSxLziRiDkkkc4w5okRDQGxcjVlKde1DiAOFmHC3UQiL/uUoQLIWIj6ME+6XOeXTSBRRMtBmYHuZfQNQV8kLJfJroqe4QVvAYAFE80lcuiSaggDcbV7LWktlipYMTmSZbqmfu2EC5rorrcy9K4XBpWnefgRaB08o/BdZBLGs3II1L86F85PK7YFH2/1dvqDeGvAef/1YH17c7wT842N3s7mDpXDFFyST5ox90A0/yCgQMiQYbJL5G8CETsH3RMDNPnzg5toPDMKXd9KTM8vs+ITVFDO3uyesME2S3g2Keg5n9xTQhZcnM3hLZDcET7WciIXwsKynuztvx1dHJ7Dk1MoIPtn8AlpzcGpURV/ilDbVN0Qx16AG44wMQF1AHplK57qCgjE/arHd5R+DTQzoEzmYw9G+NkXjGiSZrFWaSuUKG4+WfZSdkV3FYBKhTjG3MAA5UD2ygiWY7kNDr0mV9gU0I/Qr7psFEXSw2DKhKZEPDyKHMRBAnEBoSxoj0cVAISUleG9dUutyvvot8wgh02jYHAA50/7ySi0BTBHYjajsPIWz2KZHyOvuftIvlYaqXQGS05IjrgNNQM1QuoMITOBbBLSpE9HjNA/gMWyX5WxWrkfuXnnmNmzitpCXphnxN1JAuknINGqhmvhg8/4vTfIRmQNWa1WKCP5nSIa7HtV5ioD36H+ZewuY3cZu8+M3fuNp34nzLcS9Fmfhz4Xmd/pxuI5B300eQ/grrKT2yVzhlzF1aOHSD+9P/fb6dAfsDVuK39DfORK+Rzzo8oe7vm4/LGhLP21LZBB0qOTIIZMJKIh8V1zTIpyqtqYn+2t0mMJDpotgIiQNTWbqYI2q3WRZcgJN6ssUsJkL6wDsBwiwhiXAXHWLApyJTO7RJJLJLmsRstq9P1UoyWSXMbuMnb/nLH7KJJs/7rtcZIp0pTrmfM03067nww6sPI3WVaFXLXf2UQrSIxVGKvTRg6dcX99vB5vh2IQ8UG0tbET98OtPt/cXt9eHw/6251mrb+s47gKsnZMNezt7Oh/YtPXgOOKDJzLWKWi9vZfgb+lxZjW6EBJiZtB56DSqxo7Duax45GyIBsQBuyoH9hevDg9RPowtTvcAnpThQ4F/XJDqoPu3BKkRB8GTUtjl9BxCR2X5WdZfr6b8rOEjsvYXcbunzN2Pws6Dp6CjoPPgI4DhhArRoj1e0LHCHAHQrMYjAIylEdn2qcFq7C3XE+ErYBeC0X2d+ZR5LlS7B3PZiVYMq2dyKxWF6Y36JtiX132pVM/E0iRGYOsJQHdolfhoTbApHiwN5GppDhGgYCungWj2IJULmZKf6tmkVmYFMAhJYVEuVPAN1ziSa0Y4R9QoH3QCSTqb7jH6a31VfvB7BQlPkSJ2f4nd+aTVfu/m4tPjoIuMF2cOVs/cFzA7ZnzDJYR4lPu0lcFQZdQfQnVl+V+We6/j3K/hOrL2F3G7p8zdj8Dqns09DBUhw7PhuqbeA2CVVjqLR3i/H8jdgoVzwG5N1MhYfWoxuCEK8CVqguSnfq2VXkude1WRnfw3KF/x0yhE+hS3n27BRuBbe66PJddf/9wlqmbbqjStTEoZkHOwSOmLr6wA11HdBN0SataouO6LEfEnY79cdiOAV3TqYJHKZeXBmaw8mCOzCqeWvZORI+BxRxWEC/K2z53dIPrnnwg14VO7r5eFkfoAVkWqe/R2aA/A07viYgiXKG5wNhAiOx1AfzsuhQ1KtC8l1fNPmcIyR2Hcz3rMoM/BvTnGDrGbn32RnCNx57pfMzLn96fv2ITBKKUCNwNWX+vhbMTcCNKdKPyrAgOotqjVTFxNzJGrdM4GFgsTkAp7EN2JgS7LK+iHEEFOIWUTWrHQYKyBI6qb2dG4lokWBy7tbbROWWUrYEW13hr3CsqhLRikJm7OIW3jz5kAduTmJ/oXij28SLSApBd5qVcvCHXlzLxl5Ja4KgFRM28useFU+1l6E53hxDdSIInhrT1xZM7ekGDHi6v4AlSvc8DasLz0T5DFZZW+2I+WvQCpNfm40P2fiqhyraHMZfUmIEimUTsgIVTpYz4O2PoOhgql5MCIu2L2brBSQOKiKDfa7AUuCkDGQBmJP4OITAy50x8jDWbIItyuycUtr+QZSEv/EL3MX9pyUyPL6G0Ys9IheaLecYJA5wwcHnCeP5d5ULHgthGGSgPOAfYre1PmcAz2siNjtbCzE/k12gMlo8QWCUqJh+6L8M6CfpPjBqwd9UHUjVC7upUGV5N97SwfLWUVW4W3NfgPL+Jgqp5T2+O3+onT6ykfzR5UeJRvadynCWzb52lH8gkf5y8+ztlvGWm+R4zjQfBuDd5Wr84Yr+6SHaLMAmdkZjya4lmCLzxiG9+B5BeHyLgb2ilSCY0Dmsd9zYOxDhNQnnCLfo8xXw4lYL2DnLBLaLHVfQ7lVKcwjIfkwNeNkNCE7oprkEgDqs9utBGu9vlzJzCyUFTtDp+N4U/a6HAYfFdI132HpZzWQhGw6UcnvKFtl+VX9Odgd1O0Oxsr3QFgGRpWmR4GRjYLlLGweGe8JdImrBwaQ1WdpkodUFXalk1qoxxdEQUoUuLGp2a4xi3pWHF23CLJ+YCrzB+TxpUj1b0LyypBTkViXvVB/RrA/+naIMvBlOR5LiYhJwM8Ew0Znh3cD5HEYhl/ocQfE2IH2TWsC9ekgThnftsdNe7vYAWHPA8V8bC8rdB/MK9p6R+oc29u/bVJvzyPTaN99j4Iomrm7Uc9+tQuYVbkbl172X5jgf0hqGM8CLzFLSPLbe3uJmDK8E7fAzpAncKLq/qRR4ttsA78HNUXdt80DQvTz2zr5j7fW3xG3AWcl3uRWazehuiAx8/Cty9AMZhjQ+s0/YSseUa/O8ZwfmMcEc58LE3xOCC2A12u1ePDKM38FQ7CnTrHnqP/bt4Urc7ovkNPMS/h50P8C98cW97oJxNz2875V4j9HGE8Z//AoU9sjQ= +sidebar_class_name: "patch api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 Segment' (patch-segment)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Update Segment

+ + + + + +Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +>**Note:** Changes to a segment may take some time to propagate to all identities. +A token with ORG_ADMIN or API authority is required to call this API. + +## Request + +

Path Parameters

Body

arrayrequired
+ +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 + + +
  • Array [
    • + +object + +
  • ]
+ +Indicates the PATCH operation succeeded, and returns the segment's new representation. + +
Schema
    owner objectnullable
    + +The owner of this object. + +
    visibilityCriteria object
    expression object
    value object
    children object[]
    + +List of expressions + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/patch-service-desk-integration.api.mdx b/docs/api/beta/patch-service-desk-integration.api.mdx new file mode 100644 index 000000000..0116512d6 --- /dev/null +++ b/docs/api/beta/patch-service-desk-integration.api.mdx @@ -0,0 +1,156 @@ +--- +id: patch-service-desk-integration +sidebar_label: Service Desk Integration Update PATCH +hide_title: true +hide_table_of_contents: true +api: eJztPP1T4ziy/4rW74eBecQkISGEm92tDDC3bDEDL8BNXSVTNYqtJNpx7JxlA1mK//11tyR/5IvATt3dbmXuinVsqdXf3Wp9PDrRVMQ8kVF47jvHzpQn3vhaxHfSE6dCfTsPEzHS3509J+Ej5Rz3HNOAYQtWbPJlz/GF8mI5pZ/Hzu3U54lgPGTiQapEhiO2HDobzNj5KbuXyZhxdtW5OfmFxeJfqVCJCyNPecwnIhExjv/ohPADoEsfPslQ4z125gcHeNGQJWPBSgjLwqhJxFJCETrjcDIWwIYkTsWeo5JZgKMoOZkG2EA8TIPIh1dDHihs4I3FhDvHj04ym1LLJAYKqSWnPscOR74+PX3R4IGa95E/wy7zo5VR77AA2IXoX5+efzQ4skxWinHPi2If+QkkIIm9X68vP7ErlN+XnXGSTNXx/n4SRYFypUiGbhSP9sfJJNiPh95hu1rfZSrhoc9j3+2H/fAyDGbsayymAffE19JIscDRxDQRPkopGUvFROhPI2Ak9e2wRvWAfYjigfR9EbKzOI5iYLMvPcBaQQ+esFmUMp4kYkJwAGktY54PpdsB8DBKGA+C6F4gbsBOLwKRhQmyjU+nAYKF9vu/qSiskMb+Lz7i5wWRRIPfhJcsqEaHIbuIW8yPvHQC4BlXzBdDGWo6e90PJww5xSrspbx1GXstQ1HZY2ydSKGQkLwn/iqTcZlDBY4OAC6yR6BZGPp5HPMZWglwXr2MLxnw78iYkpn1gDaybbDdL4tkLzOsMrY3Y1FUH+IA/BxG8YR4IMJ0gsNw36eBJ9GdNnQSCjyZF140RR6BriaISG69tuWTwfJZjDpMfzCMQYmKGBzZNBYKVIzsFZBOeDwSCUOYiDa6x0CQDhoxDocgHaseBSJLvmW/ODageMeDVBDvQnE5JEe52jF9Eves2B/Il0lQaPy0l3UnjyniYv+DajXvYb8XumT6ZdtkLzIQYMwJDDVIEy1x49SnYxnIKfjMAjSrxRaY/v20EG5QIYgLho+pAh6COpSZuMesDtK3PupH3wEp+PBsRA6/C4a3jnGAZ4bXr+CGyBoy20E6norde/2QsUf8g//6oOd957g47l7+DfVDf92P7kMRd8Ww9J1IxQYZPP1e+rpX3WvXjqpHhy2/2hzU661qDZ7a7XqN1+FFwy8A0x2R3brr+enZp5vzm38uNEEp6SadcCSCqM7QbETcd2y7J3yAP19IhkCYmgIPtYzr1eqiF1ueEZyiYSgT+vz1UaDs+iF2lNV/hbNblRW8UUxNhSeHZgh3zmuRopaBGX+7V1TpBZemFXwF9cuwwA4uQ6XGJzZJISVArQ4lpBJu7uSXmPeqFI19QiSe5ljxApwKDddj0GF3Ip6xEOGsgoeIaAibYsCwuTrGtKNiwX6K7jFLKr/ph0uwgyjG0yDJ4Zuuy1hnPwGK1vheolyX2Af4JX30+8lsMbBbwtdHFAvn9OaSaHcLcc0aaTloZW8Bc8iQNx7BYgp5uFtiiHYjvHE45NwXolGtHQ4HDVGtHXn16uFBGweyur3ZUL5U4O1mWsHLzE+n0yhOSl6VeoE7AIcPb70gRX/zQnFcR2kM6mQ6v1YYZShLZXJycXt9c9Yti8S+3FAic8Msl8dRo8VbQ8/zfXDrnDeP2ofD9rAxPBxuLo+5gVaL5SbmMsTs5R+dkmg0gBPdf15Ei1Z9klGUReWVhr5jIiIlQbnQMXgnnHJRBDHg3rd7mMQwL5pAuJQDSB6S2e561/Qw+/33WbvdJn5AauZRhKGJGGA/4SEfCV+TtiTpNkw7P1UvJAI07k4qeA34nEThUI5cO1ZXKIIKBKo9BvEjp3IsYL6wGamrkv0so1sgt8CVntWrg6Zfa9f40WG11vTrR40mpAq8flBHdtW95mGhSbN1mDdpH9UPHBT/Ip2LTMSg9max4RtmzHJmQzDNH0FF6XNq2Ep5HeQHGYAi01WBI5k3KFs7RFAITooHH4n/SzT1Ohv9fiwAgVhP08powAuLiRZkScS2fqHVBBwV0zKG33E00SlpPIKp4vmQkSxg4mvg+EV90BNGMx/OSRvANEvwkHIT7uN0My8lmChn6hSZiMsKXhxjkQHwFhQvRHSBvAzz5xQeJ/gB6BeQ9RE8SYSzYEhZrDB9JodsnvvIR0J1nSq/0NEjos8j+cowYP0+1mdUPp4y4/nrxrNx4vrytntyVg4T5t2GUUKXt148/nwYWWbuAzB3vnkY+SUFlaqgGvJBYJLVP4TaL13W8RLQEnYKSbeXRPGsHHbyGYOWN80Fl4ty0e9Y0WkNAvXUxmr03X+hkFbVHDX1yzgOLtRr1tsecByePA5xu+rVDmoHRY6v5XAxUK8Z7+OMWfaUJqG5ERliNC0ZfqQRXrNNGgFPYlBt1uCfY9HLIbNacda/Obg6/FsGrq4zCKAuPA9lInkgfxfxNbFimTTBdcD/eS4+qqcw7A96lgFgutfzkcFwcc1I3RQEQKVK8smq7PNlCDaSeqTb3pjDFFmtz0Xe/fwwCXCqhBB+fFNzq28Y0BFhbffHN7c3HypHb37+qd+P+/3w3Q+nlyc3/7w600hc3b6/OD9h/X7fUVwGun7oJz6+WP7WwqHuyPsf8e2ZRoaAUl/Elr68F2C84qpAYAEKY+9Ocx79pNuyYmON5v1YemPLDFRdVGFF5RYR6meS2QRoHs7cd/tFqNlQWj9+evdD7+S0c9Pp6Q9ygrMFlhOqxeq+/dv670Usr0BX3I7nRWmYdHXI/mO93az682I4tnrwOjxeOtw8nvov+usdViaJ1hsKP4/JwtyRSMrt1M4u22WPVmoQ7HfmumKfy+nOrgs/IebvsEWsCNsMN/dUawwrQWbzYBWBfR7aR9Iytvs3C+npuyJ7Fv4bcH0qiouxL19+erdv7KMfal8fRkXoVjqLfu2TiSDgLrPSlfZukPeGlJfmJkthht+hZUOXJQOYkEpJcyjAqZGa6AxWUXl7HEfpaKyT6UIesDSvfS6PnS4icPYwlaa0tEDqZyTIoD8VoV9K0WkJBqn09zRyesFD0wzZwABoAZrHwGX9zvSkmKBzc/RiAeYsA+0JJX2EGYOSvsBis0Dk4L/o+SDVD6IQk19d61c6ZOHUTgbzLMnr77i0wRP96qBeDCStYn50tTgDe9qbK7dvXPHLu7nsHxBOfZ25IWEJlgUSZB0g5uXrFbRiiusZ85RkUZf7vsRvPLgqxN+5KemjDc4wtTGrG3vON5H/QpoHCzEKo85LpgyrItdrpwcrI+GyelH39mIuwaQ3G84BVg41XzOqNo7E4MBvNr0mb7SaRwO/2vI9b3DUajVqXuto82SfwK+uFC3DqCPjhNwiSaaoqIsJBjYxhSRaNl+S8pcXCcwKS2PZysJJINHr6AXpCuuKJI1DPQkt2vAg8meMHNId6rf7ksWG9emkj1Wc4IR2DTzH2A/gbyqjWFd9BKEMaaCpKZC3miBnNUib9VO7sgSAE26Nvec+s175xBCDjI+59w1gnW+gXLe0zsBsFybztbQlw4qW4IPDarveGB42OIeZZK3VHLSH/OCg2m62qUo8EUrBjL9Ym7IT/fLQf4fwEUsPfKRHCbwPsuLAe0KABl+3pl2WAcHYgP84NdRtMzINvjBLfUj2IEV9f3LFGi0GnnqU0ns+mmNCWLm9xnlNGgSo8Vms0oAvYzmS4dIdI8YdnJ596Nxe3MCb7tn/3Z5dwxPCWljp7IR2g0VkAtM9YWwIuOcKAm5Ai8gue2ugvgWCMBwXGkoT1WcKmMlMxIUeZvQlPYqg80qWNSWym4eE7UhXuHsQCuHdhLYTDDiWymibh2BvO7QBonJhOPmWjWFuK+Jdl3WyyKCXchX0pxoShAw0XQ1gmIIpC9ovFKUJbhkB51CWRc7KsjRyn3JRFAoaB2C+wRq/l0AySDpRssJMWwyKdgOMbzg3V1EvMI1YOoNoCfNGaBnMgI1xTLUJoE0mihl3hOJS4HhC2y7zWEWnSu7uo0ZGO0jwZzxVG9gdpKEyrBBp2Yc7YYxPZSVXn6RhxWQ8ktmIRJ1Nq0xc1vDZUIrA39ru1na3truh7c5/7Jr9FMXUp7aY+tyGPAX+xhQ8F1KfWOiNdsw20jm9FuQew+17mju/fr4Bw/4maLHDTGC+Y36kQ/kC8p1MHvr9wG6csqE/lwUieJfPSobgiYR/THjnGBOjNKsOFkfLdy4upojgNWO9dxFYFqch5bNc7TE/Eip8k7Axv9Pb+ZTSHlBv5qtku/m2meQ2k9xGo200+mtEo20mubXdre3+OW13bSaZYUXWYvIklU4mPJ5pTTPfabWATnzYnb0sM7lsB3oxW3FKp0OccubgDOq1QW3Y8kTD5w3/8KA9rHuHdd5s1Vq1QaPecoqxvpfbcWZkZZsqyFvLkViM2w8gj0tDUC6VRJFfLv/RdqshujVaibR5M/Dc1XVIkzs2lqyfRAnQBoAhd4xXlBdvuxd6fdosdMZm4w2m2WYPAq24YEpJh1/orNQ2ddymjtvwsw0/f5nws00dt7a7td0/p+2+KHVsPJc6Nl6QOjYYplhDTLH+k6mjL31KzYYgFKDBS4G9YZKf7DTVR2P25nynTfRKWWS9vWR3YRSxjzyc2WRJlSqRYc4udG8R7RKfFfauhIDRCFxkiKdfJWS3qFVyIjAnxXPjgZxIsmMkCODGs0pniOcwtM1YfctGkaEXpIAhOQXcpoLj3nOZ2K0tAIHqoCNw1N+xxmmk9YfqwayLFF8gxezswRMCbT6r/zaX7RLA/QQxuotrLesV2wV0zZyHMI0QD1PtvrIUdJuqb1P1bbjfhvu/Rrjfpupb293a7p/Tdl+QqptsaHWqDg02TtWhrVtlWS71gbZu/7sz9o4+CUoYkHqzyKNc3c9zcGCCEvBS4rZiGOQWUvwTrcqdFC956TnSD4/NkbUKHlmrcH8iw2N9cBK90fz3wo5p2+oL7l6dCNDZ7GItx14j4+yv6q32H6X/5CCKmItqNqRxAH3s/TqPoB2gFU8un0rXHtoPo3vXiyb7AxDJEm+nDy+hpmID1rk6NxMbl+QZS9rgT/ZAwLV07WUJ2UmStZDtYbQZzHmYBrOH252N+tJrOroczuzdFuaWlzn6gK7bOHj647RoQCtoWca+taNBewaYzpHo6G3KVqOuMdHXoy/oVR68cImhvjDYJTars/eCx3jemHbd7Pz6+WaXjTC9JfeSKsyshcT5CF6UBipC7rNjd6BgJ4po9qCFYJ3SHh80VzYMgGDWD6+FYL1zw4RPEFe6EAiIpdhJkO/BXvntTr64EwGGXDfnJCoemMQ+cGifl/rtUnileYgM9eEFPBCAV3Xok52o8tTGkEjTStabWrp4ga7XIvE/FlpFQ6sQNLU7h4Vmbc/Te8Y98BkIggeKuPXqwTW8SgEeTtrgDUKdxwE5YfAo78zyrNRejUcJXgXhlfHoh5/poF65G9MejCkIvYHPzpk3jiIlfmYMVQfNoDdKwYpejRadDqyQRVTq1QJKFT1kRVYgEyX8LsAwQq1MfICZACVCka7JkEl+JcmCzX+lQzZfSzTT6x4EbGzpR556Nc44YAUHrGgfoAz+Oh6iYoFtIw3kB7QCnOTyJ09gEC34PQ1rqVcn8PvUB0ODB6jq06rTY/3jOHdw5onRB2ydtQE3jIl8tleNriTQsDAolphlSxDzHFzEN4ggFs/xTeObLaRifP5voxcp7uSVGrw/4Xt76RWe5L/H7/6HPN7W0/wVPY1JrbHi2c2vOj3Lz/IVL7Ls6QseC1cx2sS4fKuamWosXrqHlwSgZhOFZrpTtKf3JjVcLFJiFX0s4C98JbdAEwaYjunLZzFhKgLC2ynQgMiBeGMpqLwxFZxOtO2hEkcTMvppHKGnwStjENAohjZ08wCHCSnd1UMFeDsyJ9vUOSyqEJ2RTc12kMicl3fZZ0HXAaQxzjZxIzJ8+y0y085rUAK6ZJKdWr2C/G4ySUO8xwvQTieMg/Y+o3y+VF6qfSRMPkNheRFRlpn1sg4DtRpJoHOdIp6oy6E5nVfQsWfGAhVTpmwOrEcpmqsgckK6IsiuXyzPEJ6DDYpdGYtgivNdcPCQ64nCCB/PbxYgArDQrNXgnaWmk9rHtnizpr6eATocuDW3WqGZCZ5AjlQC070C8JX37pmbkOnW23mlfMyXD77bjckmiOHsY3+KVTrEN9WzIW1rPWflJBT6H0sfj6WOgUJs+viINR2clj3haxgGCwa9L/mMi4zaHBX3szPbK+nc6ZobFXfZC+9pXkqZrVKGs4LXcOxpYaCFPIYuPBGm+oNZ6ajc6Nsbbcd1twzjhFV31nWtNd2cUgnAin5gboCe6LpJzO/hJf49dvrwP/gRTY2bfNTvHx1bhYQ2GrBN2JblK+YBpAPN/h8K1QOU +sidebar_class_name: "patch api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Service Desk Integration Update PATCH

+ + + + + +Update an existing ServiceDeskIntegration by ID with a PATCH request. + +## Request + +

Path Parameters

Body

required
+ +A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +Only `replace` operations are accepted by this endpoint. + +A 403 Forbidden Error indicates that you attempted to PATCH a operation that is not allowed. + + +
    operations object[]
    + +Operations to be applied + +
  • Array [
    • value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    oneOf
    + +string + +
    + +integer + +
  • Array [
    • anyOf
    + +string + +
    + +integer + +
  • ]
  • ]
+ +ServiceDeskIntegrationDto as updated + +
Schema
    ownerRef object
    + +Owner's identity. + +
    clusterRef object
    + +Source cluster. + +
    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. + +
  • Array [
  • ]
    • 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"}}>
    attributes objectrequired
    + +Service Desk integration's attributes. Validation constraints enforced by the implementation. + +
    beforeProvisioningRule object
    + +Before Provisioning Rule. + +
\\\\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\": \"RULE\",\n \"id\": \"048eb3d55c5a4758bd07dccb87741c78\",\n \"name\": \"Before Provisioning Airtable Rule\"\n }\n}"} language={"json"}>
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/patch-sod-policy.api.mdx b/docs/api/beta/patch-sod-policy.api.mdx new file mode 100644 index 000000000..6085bf716 --- /dev/null +++ b/docs/api/beta/patch-sod-policy.api.mdx @@ -0,0 +1,139 @@ +--- +id: patch-sod-policy +sidebar_label: Patch a SOD policy +hide_title: true +hide_table_of_contents: true +api: eJztPGl3GzeSfwWv90Msj5riLVFfdmlKdpQnSx6JXu+M5JeA3WgSSbPB9KFj9Pjft6oA9MFDpGzHM8mjLVtkN1CoKtSN48lRMxHzVKrozHeOnRlPvcm18j+oUHqPzr6T8nHiHN8415cnzDz8vO/4YhYLj6cC+qRxJvadRHhZLNNHaPvkfExEPFBRKh7SfpZOsL/0o+NE+e6MYBzfQ1vhfJ4TrMSL5QxRAAT6YajuE5bNfEAqGrNiXBZIEfoJU+lExCyd8Ijd3ALcW2f/1vFigdgUn1V8pr/pAf+eifiRvqePM3HrfGZZguABFrv56frygn1Ayj+/mqTpLDk+OEiVCpOaFGlQU/H4YJJOw4M48Lq9enOPJSmPfB77tdvoSvyeyVgkLFahYCpgl1fvfu6fvD+7gJfDiUyYiPyZklHKPMBYReEjIyazweXF2/OzwfDsAjoMBqfX1z+/6V+fnjDEkBHaUiQ1dqJYpFLAVwC2ZXipMpDGIoI5DPM+zGW+QuoSxe5lGLJRJkOfwfD9D2dMPHiCuF2D6Z3xmE9FKuKEJk5GWgYm8CqCF/BN+vA58SZiyp3jJ2IfPE3SGAZw5vtOrBmQC0J1OofA37MT5AtyGidTzwcbCURwqnwJ0+ojKuKBT2chAm96vcZR/ajV8Ru9Bj/q1hsdv3nU7nRGbd5sNXsOig2OK5L0jfIfEa/n0eizUCYpolGSJ5IxmDOrAAnjnqdin+RCfb1o4PwLFiiUaIRp5JfHQs8bH4Xi+DZ6zZDT+LuEM35V9zCtVyLAz6BJIo54qFGHhyIWkUe9PDWdiSghdUGlA0FM9PMYdBSB9f07qdsCdil9QLXG33dShUT8JQ7WTxI5jqYiSgFQIMfUBabez0LQLYIZBYAADtX3PJEkA9TjWPLbCGbQQ5WPUpwOPptBO4J88GuiIpco/ht+xNdL8sTjmKO5AWjTpPRcjX4FGpz5PJcPejso8GAaEfaGJ8K3Jgqa3PEwEyTUagaAYjELuSdI5NEiOQdlCdm3zZ33RiLLkwFivhbKWo4chCJI8y+kTMUoUxWJR1dGrlWALxsiluNJPkYB/snqrh5GZWkxDsySaX8OGkH8Maw+vRieDc9P38NvnAi/UMTD7lEz6JEido9aPa/eqfe8Bh81QRHn8LPvvDMW6A9iP4wyn5OtSWagp1oGmvU6/qoq+lnko9iBDUT1/dAfDn4sFJwlGfBP+MLfB2Pos1ikWRwlC6bph4RF4h5egotLQJy5tZXPiPdKmTayCyTHiEIqNd7I2UU7umivjIU6O6kaxnrQaARN3nYPvV7bbY+ClsubI989bDc7R/VAtEY+shj8n38Jjkbbwrk15VsOOkLPiBqFvarjawa5D4//QstvfO4qwIGKpxw45aCFdVNJwr/sGfAFu5+ISHu2knuAbwb8gmuoN+tuvQE/w3r9mH5qdfrzz1WE52L/B+G4xn+9DMnKmJsm6ZI+gKqVHi+71yo+FIYYpMFTZBiuoNcIJQcfgr1xRkFMsjBEp5RjZj3QKqFeQAtbguZIHzQEwsDaktjr/hvJM3BOhpcUBxEhUTbFEPLshEzUPzAALYjLn873t1KtRUyXlEwbPd7uBpz7QrTB6AWjtqg3jrxmvdvqOVsrlB3KlwlYv8cVCnWdzWYq1v4NkKFn1OskVQ75vJVu/wViYiHY+Y8tjCoi//ePf5oWq+SgFENvHvpa8BiC0t+x9SbJ/B9ODu2V9I+3sG3jPda/OGEv6xTska1aESS9gIvl7hgEUX/26r1M5Vg/tED3qgT+yO8E42zKIz6GrCUWdxJ8C7IkjTkApPgMdNmTCUWgYJTwrYzZrQN+G/lXaOqtwwR8Vo9CrJqlxYDvRfTZroxT3yoVOrZSESFuEx38bNHZtxQmLJmoLETfOlVIug7OIFtL0V5iImMj9RKtv6oRC7LIs552iTSKWzfT82kiTHIoSkZaRDCShwTEiEDZpJxevL28GpyewKOLy+HP+deKhcmfzm06vBS2LrgNaGSps3hou1lh640z7L9rwBP41cQhF4Nfm2RZX4s57bZu/AfjQAGLbxVFGGf3MiRspy/FoioKK7B6PoOhYHgBxPPhGc8hXGXhSpmzwvO+f9F/d3oFT66H/eHZwNnHkZYqGici5RKsBR+hQqNI5CgnOseDXNHAgszd+iXkndap20jDh5fvQKfAmqPXfherbIYifWY6VLhb4PasU+dheBmUk4Cde/+O7n1RNDHPKRr+7/OCPddVGUrNS7iOFJhnHi0heyICjOoxkiUTya1hmvCEjQSEtzm0sp20pNiiSsCzEGLmgIcJytJ2s/5pcUwwyjo8GGnHEpcLC9Zn0LuaUxrVeXd6cXrVPy8JTfFkXTmtKk62PbnLNWn184pRFftykr859dtOrt6UE7DcjxiuANbQLfNSqmhVpM0WFXRuVk7yN/irc1Mbs51qjEHmEwucJ4hdJCUYDUqZp/wBv3TqjJwVkzomQFxq68s32xqLwi0XpYhle2psh1P10UWPLS1FUZbUWGLN734iIXSlRC8PlBkl+1hRUKuqlJ3ukddp9jwqjnge7wa9utdoNVrbG5IfM7D0Lno2tAUVe/J1KPZ9mDyYmhjjAGdeqqJtV/jpdhvd7qgzqgNtje6h12qKoNXg3W5RHl4YYv8roB6uhVqxiwvKimWhShlsp4U7Ldxp4ffWwtKrwVrHuinkKRYev7jer+urW2cXmtASeFdDdC90wT6vcW4o6hWFxg0NqzK3sty9su6Wx8HVWVwv9zlxFD4youe5ilK1BFSp+JTLNJtkkl1esc3NDpcqOZuWGvacdUWcP7LGslxS+e61EFP6KJcq7Jq8MWSfK+WBbUW/nM1v22dzrr2YPZcS0W8q1HlyxMriXc2JKtn+2vRgQyKwGOBXVtbKC3hfsrC23rJ/pQmnRbmlsOh7rgrOn1sVXFy1+2ozuIyLOAoaPAhebgYvwHasMYMme9Wpq0TnNLXrg+ut02BV6Xi1aRksVmELXf+80hCUhJ0y8qoh2II3ZSOAjnmziutWZjaK7PsZHdI9aLY6Ta/R8EdgZlot4ba9VsPttXvcPex2vV5HwL+gUcyYEZ8NHrnjNprDRu+4fXjcOlrpihdazM1icnvV+vEAArgoZadxDAbZZVe0QgyCKbWNN5tO2Ej5VMWQEUi09L/h6rBP1cKB8reIWN9CguKOYy4RQ0Eoe9CRAcQ76ev9NZA/aJC5m8J21TIVcKLWgIDKZ1eGvoEhBmOzmHu/Aaxtqr4fIwn9me0CgUCeOK0YVhwKPurWe8120G1z3jxqNw47o17AW616r9OjStwURAl86eaaOwmL9FioPJiRfwn0uhx4TwjQ4NsnRgRjC/7j8rBum5Np8GW49W0fgpI3gw+sfchCHo0zes7HC0yI3I/Xq8q0GvAlGHG5clnYZmknp2/7H8/ROF+d/v3j6fVwTRm6H4G00uYIQBVkYaJ0jGQIuOcQrogQ2CH8GnttoL4GgrjZIWEaSv0teUyAmczU5qCHGX1FjzJoFsRqWlElT+8TZK9kTdT22QifTWlb26gcab1GszJL3XPDyddsApmaiPdqrO/70qxjkX/BwjluMAMj6qPqagBBBqoMyMh0gkEfRF9Ly1wFK5eWDEyCcl6eFFQOwHyznPS9NAPkiMyyFubSYlA08wM4a84truIXTCOWPoLvAYsLLcNHu4LHRkCbTBNmzBFOVwKGJ7LtcotVzrvI3L3XyFBpGmsXPEu20LsPIZgfl0jLX9wJo3wJ7VEka0SzYafJWCSzyY46m1b5dFnF17vmdrq7092d7m6pu4svr8yuOfOWQp/GcujzMeIZ8Dcm57kU+ug6ZKSYbaSzLz2R+7iEY0Kknz4NQbF/ExEtvT/MML39hvGRduVLyPfz+dDPR3Zzt3X9xVwggsRHTUEAlkj4x4R3gXEpSmwtj/ZWxSMJAhqtCBHBasbsUWW0zzfOooiWtJJ95iuRRD+kbMJLtQCV7+l2aVP3LpLcRZI7b7TzRn8db7SLJHe6u9PdP6fuPhtJVlfoTJyUZNMpp2IpSJp5j9RyBg2YPb/BcpUrFYSLaAWBsTzGcqqRgzNqNkaN4NATbZ+3/W6rFzS9bpN3DhuHjVG7ieuXha+/KfQ4V7KqTpXmW88jsRiCuDuI47IIhCtJlfKr5b8Ml24CNGtoevK4GXhes6dVKHZsL8eOFyoF2gAwxI7xmvLix6tzvayswSPfVBbjVv04X4PGVSQMKWkdSTzobQi70HEXOu7cz879/DXczy503OnuTnf/nLr7otCxvSl0bL8gdGwzDLECDLH+naGjD3EHhmYBTArQ4GXA3ihdOFacq33K47FI80CvEkU2e8tR5FAp9p5HjzZYSiqVyKhgF5o3aDvFtrFtCw04G4OJjBhYLQnRLUoVHnSFmBTvRAjlVJIeI0EAN350+0EKVGmdsfKWjyIjL8wAQzIKodIXKNxzCeIkAgz/AALVQcdgqL9hjdPM1lfVg9kVUnyOFLPTB30+nOX1387qU+bmUOW1nus12wXM3t0I0gjxMNPmKw9Bd6H6LlTfufudu/9ruPtdqL7T3Z3u/jl19wWhuomG1ofq0GDrUL2DByNYHku9pUOe3ztiJ1UxGJB4M+VRrO4XMTjFFSBK+QV5TnGNUX6nHdiTgyfpzx28Cw+jQo1QFofQzF4d9gTzBPMzr/GZrNkjypG6r3lqejAC5qywO7jNVOsYNqAr3PQANeJsLFF4taUj4JrP9shsAvymnQXPQraHnB4h+2AazD4e7zKCRI9xfzNkET/Yi4GQL0v0AV0f43D+9bRoQGtoWcW+Z0eD9gwwXSARSfhcXF14jSG3Hn3pAsPCjWCxv7k02CU2a7I3gsd4/wTtf3n106fhnrmcDxVd3zgoZKrPQn8AESFD1rd7QbAT+ZZYZeMJId6v7LZBxWFBCASz2+haCHZjD/9fgIW/ApNMLMVOgqwA9iourvPFnQjR+dUKTqLgST86AA4d8Eq/PXJ0lBHISF+WhEdSbiOXnUizT10fpjEkUoLHbmaWLl6i60uR+C8LzdXQXIKW7C1goVl74+nd2x5oL4LgYULc+uLBNTy3BA/TJ3iCUBdxQE4YPKp7pDw7a1+MRwWei/CqeNxGn+g8YrUb00bLnkI6Y95EqUT8N2MoOqgGN+MMtOiL0aJDkC5phNusl1By9ZCudCEmJPzOQTEiLUz6HgwKSZSujpBK/kIzCzr/Cx1x/aVCMz2+wSOw0NJXXvLFOOOALg7oahuQGPy1Z0LBAt1GGsgOaAEYFPNPlsAgWrJ7GtZKq07gD6gPugYPUCUoyexYfzkuDJz5xOgFts7bgBnGkDrfNQbfmYGF7qnCLFsMWOTgMr6hAq+4wDeNb76kiZ7yP41epLhf1EzwOphvbaXXWJL/HLv7b7J4O0vzV7Q0JsjF2uNVca3uaXFIHcMkFEZCyuQKZRV4Y6K55Qof3Vos4H94S5pM0TbkMpSdUYxTBjQLeYoyTzrvTaSg2sBM8BQjw32UOzUlPYU0Ho0DXmmDgMZ0LCwGgjhkczLES4qwem1H5qROOuzEWcfvSZaf5/cmkGuKGvsE6VrkwaRhqoa7eOHdr8rkbNcwbx/o6uUTKwoQkk2nWYQXDQHa2ZRxELgN8uLLxMu0WYPMLRKWF/pi67yX1XEURCShRklLPE0uAyw76yODW44FUpGYmjOwvnQWtCDkSpg7qaBdNajfBBtk0Z2IcIbJIthkCM9EaYT3Z8MliApPROqFDrxB2XRKDrAtXukFxGvxadUatbpLyQRdQ5ikkN6WgNPNzBB0FvcLLkrgU1Fo390t/n3vFje+GJOogxmW/XAOM53U6fT5ximnz9DlWPp4nH2i6BCy8/SEdSFMKOf4+Hd9DhcPw9pckXJsEET8XJyCXSsBrwxL/T1a2dryZvKVhNgqZ/RYFDgc+PibwLoI0EFnsHXhirDUL8xKiTvUd6fYjs/dl41ptu6s62LPdKOb0fNaBV1/DK1H5o70qa67xPweHuL/x84t/IUvaqZVHxrR8yfHVjGhjQZsw8xVUZb5ADMDzf4fDBcFpg== +sidebar_class_name: "patch api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Patch a SOD policy

+ + + +:::caution deprecated + +This endpoint has been deprecated and may be replaced or removed in future versions of the API. + +::: + +Allows updating SOD Policy fields other than ["id","created","creatorId","policyQuery","type"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +Requires role of ORG_ADMIN. +This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. + +## Request + +

Path Parameters

Body

arrayrequired
+ +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 + + +
  • Array [
    • + +object + +
  • ]
+ +Indicates the PATCH operation succeeded, and returns the SOD policy's new representation. + +
Schema
    ownerRef object
    + +Owner's identity. + +
    violationOwnerAssignmentConfig objectnullable
    ownerRef object
    + +Owner's identity. + +
    conflictingAccessCriteria object
    leftCriteria object
    criteriaList object[]
    + +List of criteria. There is a min of 1 and max of 50 items in the list. + +
  • Array [
  • ]
    • rightCriteria object
    criteriaList object[]
    + +List of criteria. There is a min of 1 and max of 50 items in the list. + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/patch-subscription.api.mdx b/docs/api/beta/patch-subscription.api.mdx new file mode 100644 index 000000000..3400c2696 --- /dev/null +++ b/docs/api/beta/patch-subscription.api.mdx @@ -0,0 +1,133 @@ +--- +id: patch-subscription +sidebar_label: Patch a Subscription +hide_title: true +hide_table_of_contents: true +api: eJztXI1v27YS/1cIvQFrM8uOHTdpAgx7buKu3tIkz3ZeMCTBRkuUzVUWPVGK4wX539/dkfqy3Xy0xdtWGAUaSyLvjvfFH0+k7hw1EzFPpIp6vnPgzHjiTQbpSHuxnOFdp+YkfKydg0tnGMvxWMTaua45vihaHDjDidSsc9Zj6cznidCMs8Q0ZrpEi8mI9XwRJTJZnKh5jaVaRmNorEXCVACPdRKnHjbVLFFsqnwZLPB5mciMx4nkYbios+FEsECFoZojnUCK0AfesWA0DD4KxcFVdBVtbUV8Kra2amxrqyS4uSEibOebi2Qxs+0CGSYiNr9joWcgkjgS3A9lZFtMkmR2qKJAji2hGxjZm1j6Y1G+PVfxhwAkzO6BQmEEIE+Cqjy4vHNkZBQ/gUcoKFxJH35rbyKm3Dm4c1AsuAvagXE69zUnFn+kMhZgMVCYWDZH7wi1mYByypZEjZJegLS45dNZiDS3g2YzaPG2u+ftt932KNhxeWvku3vt1qvX24HYGfnCub82LIVO3ih/gSItS+CpKIHx4yM+m4XSI59q/K5V5BLX7/AnPi6GVZX6NHNEsv1IMKIjUBN2/DyO+QIuZSKmuqQXNfpdeImzrIYO+2lwenKGzFlOnHHNfBGAFX02WrDL/ttDtru/3WIutWbU/PoFGlcfNBqJUqGuS5EEdRWPG5NkGjbiwMMeL52yHS4hkMi0YEbQ1izGuEqkIDnh0YoVV2NIsDwWrQbgMlDxlHQgonSKbLjvE+OpuhH0YxZyD3/ZG56aLVCCwsRZk3sr3qOidJh5YDWiJJg2ZkAGAgGjF56gcyU8HkPgIk2Ul0dMhGIKDTL7BQGYxeg5KY+u4oCNMm8Q8YaHqSA3ihanAQXIsvvnd1AwSDLlW9YXSneM19yvSVqCETMrbqpBVFB3VdYay2xMz65Q/1cODNaH31azcJ2315XBnYg5q4zv/r70+NJ4RsmGxj5VneQqAbtEy/RqHyVBmWS5L91EVUAKJgHLCYJcv2/CHCWlPGMyH3lxa3t7NWrPKeP7lRRddx7MB9UksBzD5ZCiNGhnkl6eCGyWzJ+cmCubyJ1C6ixfrwYkEH40Ciq5s3dU/4S0meXzZ7HCLlVmHc8TWjObgSuqRh4VWs9iVXr0EEcwL4SIhrTLbhd/IsvCJo8ytJNRFQ6MiGSVp/SjA0583ZxvidfJkzRpMQop8Yl87Vj7FZ7EZJVZloTfDYdncNn9b/dk+KbfO/qxC1e9k+PeCf4YHPZ7Z0P4cXHa//nt8enFKmKqTszApQ5Q4eR02N3aYr2A7jDAVCUGNcxLkGKXUQY2y2KmXu6LMtpOBVSptK6owQ5pXWIYohbu18TVo+bIWlLu9BSyoumj3/3PeXcw/LXfHZydngy6uZ1kdKO8PPHaCQeMhshxcOq+3t1uMj+1kyTOjTypDuNs2HxHYgQ8DZPsBghf6GA1iVnd5JleBqS9Ku7M9IrzRL0AJXniqmaYNA4fV895/zhDauIW5tiIhw0v1YmaMprazDirA8yQyXw+r9u7ddBsNsQjqQluvVf+E+xDo8zMinhb6BqTdfDGwS8nhzXWMX/AeEe/nHTe9w7rpSDAZ3DZsX9tiyr2sM8yr3q3LKGVupOinyZ2lhh+JPqWfQtRnCbt0TiqRGxUdXxf4iUPzWSv2ZQvCJ34vvEr7B+kSRqLOi4WIIIgEH/tnA/fbaG5NYAaRDE1Fim0Usyhk/E85DKXYYjkgNC73MNyQm86g97hOlpFW0NBRl6Y+oK94Vp6OJD8IYCrc42uAQkNUccZ1xrWFD4CWaMZXbDrdvrd/q/D05+7J09lKGC9FA/VBxEts6WbBZuy6a2C4E4xQrwo8Tc5L4vCokPhG5WuZQ9Z4w3gJ6OqatZhh6UQ1E+eNSYE/4ySEcoWAixNxdjq30thN7MWWccnSsMQYcn6hRryzXqv8GWnUR6amMfBnLTCNXYlkI3U0UD4UyXQGrw4goce/NIVwbElArqH5VmTBwsjVXKftdaSu5KZ1jnU48YqdXu+Ho0Tgxqw9xcZdcmRy1ahIoZVw5ewT67HtUq7v6/CYZxT1mT562r0FKZYwQpPmvlKmONzJkA+14CsVGrWAI8sOC8GzDZmJ+l0BLZ80Wy5vhzLBJSIN16ChnnCJtwk/G4xNMiIcRJBF7rHBiqNPQFwTtOPavg2WzvtV7t7r/e3my3UEAjZF+MnAWeU0bT9VEnYQAiWTd++8nQd2Nf5lP8JczzkksZYQGeAACHW0JLGOG7EkPFFHasOhKA4TFTgUaHUVC/jN1ySX9upbTlVuXMg4zZX/KhkmrIKSn7UXfGc+2KBVahqpFQoeLSiq4uJANUsFf/0RKUQHbHwhLwR8JeHbiIx4a5gP42IAyIGJrYhrnjWtcAyHw/nfKGZFQxIjnnsh4jmCVWBr6p8cZPPRSYF5HrCSxicqfc97ga2pDRhpgOGNix1M4wRLkjGD8Wg5gTabxHJatSCQFNRjRR6Iu+q0b65/OHFN3Vpi6Q9n33/PbuClXdzp7UX+Lzptdt7223ubTebr5tif3fHb+/ueFfOy2siYzDkEfjWaqgvSw4emGK1JivJEGLN4aUPySPEeK5rcLIZ1oDIR2GVRr7boOTi2mHqhiEKGnPpgTaljnWrCVtaaK+rJhyGEiOnG8fgAC6EDiZMk5Yw1rIV8Ej5C8xEoGseSv+z6g3VrOWLBIZ7+CTw/BbgpwsYnWqJgkT2oCMDijfSx2XOVIGTGpI5zsd2VZuDJupNQH5+tgZlh3YwtPrl3geg9ZSl9nkk/8Bylu3CZFHPWsNW7Ak+2t3eb7WD3Tbnrdft5t6r0X7Ad3a291/t7yP3KXgtH4tysTUrwlZZ/4ipS3oshPgM5Z8UjFybNZph/lDdtmoDovFE1Gba5sO08rIEQqEG6fLN4Rlr77GQR+OU7vPxkhIi93ywgi9g5IbwKbi3XDs5ZEj4qPu2c36Mi327pnVqSGtlwd/Btx8+uiWICr4wUXOS2A5gzguwXmdbluoWDIhHutxQmiu90KBMZpMa9LDc1/Qok2ZBDGvLcihR3Nwm7AWu+mqwkoF7UyqZA96GDsoskLawSjJL3GOryS02gaU9TMvPW2HRwkKlCSZ3uTw5F6pcxmtZGjkuGwWDAyR/wsztJSkIR8MsR2HuLVZEax+Q2WiuKt2wpDRS6QJSp4eoELO+p2KY2CAzwdhkoplNRwYLTnmUtcszVjk7Urp7b4Q5ShQ983iqnxB3ZyGkH5eGlj8wk6u2L1JMNiJrZGayGQknoImJlaxVbq4s8A2k3cTuJnY3sfvE2F1+2M+qpuYpQZ/mmhcpEa4zVUyT5wr0icl7IlMiwEZmLWoMSQU6C5F+uhiadTC2B9yZFXq/ED4yU/mK8J3cHub+KHtHmE39hS1QQNKjreFCJhL+AcldSEyKMqraWeX2VsUjCQ4arYGIWKBhC5XS+iBOo4h2GOgawF2ho29x3Qb50bxnMBkQuUa+ayDuBklukORmNtrMRl/NbLRBkpvY3cTuPzN2H0SSuVQULRYn6XQ65fHCeJp9TpViBg2KF715yOWbrcpoBYmxHGM5VeTgjFrNUTPY80Tb521/d2c/aHm7Lf5qr7nXHLVbe055rr8s4jgPsmpMlext7EgqBhB3AzgujcC5dKKUXy3/pfguJcC0lr01I9wMOgeVXhfYsb2KHU9UAmMDwoAd44+UF/G1PNAH1kQe9WZK+Ri0pDrzCgAhJb3YEbdSJxvouIGOm+lnM/18NdPPBjpuYncTu//M2H0WdGw/Bh3bz4CObYYQK0CI9VdCRx9wB0KzAIwCY/BSUG+UFHtK8x2k5aMMcb5ppIQiW/urKHKoFHvPo0UGlnSlElnsC6L0Bm2n2DbO2kIDzsaQIiM84SEB3aJX4VYIwKTgPyyUU0lxjAMCuvHC7QT4zt7ETOZvORe7mU9TUggV1l4V+JgEdxIBwj+gQHXQMSTqL1jjtNb6rHow6+OIj3HErHvrCYExn9d/X63bJdCLzD4HNjC2/sh2AVMz5xEsI8TtzKSvHIJuoPoGqm+m+810/3VM9xuovondTez+M2P3GVDdoqGPQ3Vo8GSoDm3r2yzHUm9pd+z/G7FTqFgJyL2Z8gir+wUGByVoATdlsiAmeBzm0LgybpbHyNSzA7sT1UX8D+7mlvce6wMwCwLVazz7OhXgl/nHDpziyGxOoty1cSf9ewdFQKxphlndKnsH1ger39f5TOZbdyM1p/2yI1D5mmyGm1dN5GID+naCYVAne8USQ8LkTyJurJedpsm35D5IOTsDuYA1DTNkariJ37on3cYzebA2+VbbY6eo7ZXxwbjO4/D+88diCH1kLOvU9yA3aM9A0qUh4hCuC48ZIJA33Ff8ppic8BVCa4XZKTZrsfLpEvbip4vhS2Z26mP6MJ+wEBLXGxCAZ+AilB472Q4T7EQzVqzS8YQE71T28GA4MvxCRJ1dRXhE4LL0jQzWh0RPKq0eiiq+UPDQRm3QUKN6euUlTZ+0ziidYqtfRS47kpjVaG89trFDNB/ouJxl4+KlcX2qEP/KqLn2vC9R0y+XpDCqvfTMnnAPcgKS4KEmbX0yc0PPLdHDRRncQarLMqAmrBzVnVdeZrVPlqNCz0V6VTmuoouJhLl56fiRyV7ZaYoe8yZKafEDo9MlGAaX4xSi6JPFmiNTlyLCbW2XRHINS1e6gDRJvmMIjMg4Ex/hTE9AR5maC4Xkb2RZiPnf6Ozib5Ux0+1LmJCxJZ4p+GSZkaGLDF2TA7SV38x36FgQ2zgGygPGAQ4L+1MmsIKW8p6htTarE/lGdt5MeyAqUYF5yFwcFAnO/mL0AFvnbSANI1DP96LBNbO0cNKrKCsrMSxrcFXeUMFcu6Q3I2/+ohTn37/beHHEnaIScxqFiy+dpT+SSf4+efcvynibTPM1ZhoLnbGi2S++3dT9G3x8BiOANGGXPeW4e2Mh5GqxEqvpEwH/w1NKH7RwgGWZOa2OwKpMCERKMNAo0XgTKajMMRM8QThaQ2dXU0oOs1hhRoLFLBEax9AGDy8CTOYjGQI9KsRnnDnFsMG66Gp4DSsGsy1EQZTAslnU2QWsPCMPPAVXnbghGZ79ruzycwDOQt9VYkeZ/wEOnE7TCLhhqkinDM+YPuKkvtReanIpLEIjkelCERrNe2WJBb0fh0CHd0U81afBwKyWnMcP/lle4Irals9B9WhF+8myYiB9EeafQnraocKMNgSAOxHhDNe9MBEAJhQlDu97wxWKQCyy72zw+1y2k25gW/yYFAzeuM9OvVnfdmkFg0f2lU5gSVgibj4TxtnSt++Wvq2TvzXYfPLueZ+8s1M4rr0aM6xBohXsN1JM0rh01i6/oe+B9PFs8gRshs3u7rBahQvSe7wNmQ1LIZfXxVqTkhv4lD2uHEDiXT70Xzbli749G/2SPf7lvLUDyUqu0aKU9ODnB4FFGhD//ho/dEJVNBLOPLCvbdyh+apV1vGh7+dhzjWdTZHugW5OpdZx1hke4nc2Rvb7fVNTBIr5HG7i/wfOFfyDC2UVD43o/p2TlVShjSGcodN14Mz+AINAs/8BsT6usg== +sidebar_class_name: "patch api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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** + +## Request + +

Path Parameters

Body

arrayrequired
  • Array [
    • value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    anyOf
    + +string + +
    + +integer + +
  • Array [
    • anyOf
    + +string + +
    + +integer + +
  • ]
  • ]
+ +Updated subscription. + +
Schema
    httpConfig object
    + +Config required if HTTP subscription type is used. + +
    basicAuthConfig objectnullable
    + +Config required if BASIC_AUTH is used. + +
    bearerTokenAuthConfig objectnullable
    + +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/patch-workflow.api.mdx b/docs/api/beta/patch-workflow.api.mdx new file mode 100644 index 000000000..11cf2d861 --- /dev/null +++ b/docs/api/beta/patch-workflow.api.mdx @@ -0,0 +1,127 @@ +--- +id: patch-workflow +sidebar_label: Patch Workflow +hide_title: true +hide_table_of_contents: true +api: eJztXAtz27gR/isY9mbyqKm35dgznZ5iOz3f5GLXlpu2TmYOIkGJOYpUCTKOmtF/77cL8CXJj6Rpe73RXC6hSGCx2Oe3IMDPTrJQqczCJD7znSNnITNv9jZJfwmi5NbZczI51c7RjVPc0s77PcdX2kvDBXVClwuZZqGMoqXIF77MlJCxUJ9CnYXxVBT9RK7p582PV+dvxAUN8v7pLMsW+qjdzpIk0q1QZUErSaftWTaP2mngDQ87vWdCL+NMfmqBFa28PA2zJdj57FxrlR4ncaY+ZaM8mxGLenF0a0c7mstYTpXzfgVuFzKVc5WpVHPPGD/AdeiDZBibKc+c9Umd+SIJRDZToiaMVP0jD1MFOWVprsBRtoyIlg7nC1zsOerTIkp83ApkpKmBN1Nz6Rx9drLlgltmKcTALSX3OXK87sFEyb509w8GvjvY73vuoeoM3EF/uB9Mgn0ZdCbOiiZCwyudvUz8JZFc58YjccQZPZKLRRR6rNX2B53ELqv193RJjzfYkmkqlySPTM117X4y+aC8bEM4I0FqZC2K88J8hNTCV0EYK19MluLm8tWxIBUKV3yp0huivoGFOntGS6TNlAw2CxXziUdbhNvkdgwllkYuskRMlMDPIEnnioxAxfmchpG+zwPPk4+KLxaR9OjK3vCSBckogwqIkUqDRcuV5fJBjkbCPLCCSUIoLhUgkyoNDdITsrxMplOVCaJJbJNbRWqOBnYSMgigHSPurD7Jhn2162ODxY8yyhXLLlbnAbvE3cb5Rt2Ken9MP8yiWuPVXtmdZjFVab1/v9OpehTPa11K+yralDdKEjDmDENN8sxo3LrvYhZG4QJ+UaNWWHFBzPxebQQsMgiWgpVjriFDmENTiHuisEF+9o7s450DLfi4tirH77K9vldw4LPk60e4IXtD6Tv82HbmWV7bSBpFgl1XTiIlglBFPj9uzucEJhtDH9RjhlCLWdlIrCQ8dI2ACGMB1YuL0fj4B2FjCsVXaxg3xqtq9m+M2mmz6Mt2zpWCKE7nMoxYpXd0Sm5jtonS7Kyyzk5O34zPxn+jqEOJp+cddl90XuwPX3j7vUNv2OniypPD4LDjdfvdPtpZ1b8NoyiUc4F/tRHdnYM3TbfBOHkT8U7SIr2HPnlethS3s+SJFpXRCQgvniq/dd8sVUwC9qtBOAHcyxkiZdhkDIEZLp81RCvGFG4o1agFq74mdfINr8zcSH8IHr7Ls0KPpttMOGnA9EMt8EeKzNAN0mROndFnQXHo+/Kq5eEJhUEvXISQzZnf+g4tv2sVkmpxCtW5cdkjExhhxzFy8hXYJbK55ymtOXlHaHWpdB6hbZxH0V7ptl4RmormtQBq76xW96kZE51Ot1rZ6V9gZRvCYIML/fiomIpbPXetumnI9yseFyPqBTzMdO51OpsuOK4BBVEGsXsycjMNw8+bobgk0Ux3xPhDyaVk4+ykJSp9X1+fnYipiiniIKTlmJDwUsUctRqhy+91ut6+OnT9/sHEHSDLuDLoDtzhcNAdBP1Df3946HC8AiCj7sdJbia5kQgox8rM3Or3tmZmJN8Jkh+BrXAOb8uI4wLHiRlAxUQpApQ0GHlhjdUeuAhgr3mq/sM80CiQmp9z2i5n3uCmA25Yomqrlko+KDK7NNBWXiyC9pkVjkwlI7dgxA7Q1Fiv0+u5na7b7Yy7w6PO8Kg7bA37w/6L7mBw8Hen4CtJH4Z2pfXYHgiFpb9vmKMh9WiDrEiejM8FdWrV4FeZEBrYqry72vsy69/knxyiKTbvAClHDoaBlL5SA6ScYDJQne4Lr9cZDnoczDjnfMWofqgRppaCCDSH/SlEiFGRsP+a4LYNFDWF/ThO2JzRsqhebqvqpeKgkbkdk6G3hrRSdNlMZgINdYNoSwgG10QAUwaz81BrwkIEMs5O3ohb5GrgoIyeAHPcEhkT75uUOEZFuICTISFbeA7650Rbz8KF8JCxAdZseCbMyyCnAMvMBA0rxcX1WACxbQCcxxnvI+1xm+CJFAneaNAIDRNLVaBSFXuUVB5nxUQsj0NwDikWqtzExg+Dpkdb8LrdbBlsA3et1og8NMZJ9YuGYWNoGIH0gDmQJ/VM6U2D/SrE5tSA1oPBj4QwlwtijvGW0WAzBpNB22S0aVMWv32psLkbGTKN2rrDVQ0SXNWg4P2TOYe/wQvmSaqYrlWpnRQJOg21auY6ONxFpCRua6Uaqx/CT7ycas+yii5acA1roAwXSlxz8IBFhEfhxAqQ0UVNWmbRolbn/faQ7eh4fHb+5hHItiwNC3GfVFZLSMtWF1XvSZJAT/GG0k+5Jekd+Ycv1+J1uY5H8TROMg6pBlNw8ISPmcHIKI2Jw4Mkz80uapUqszWOU8DvR/mXbWyskA1fryeq+toPE2yofGMN6KFAXtQAp38dn16+Gb3G5dXxD6cn169PT5rBvWh5D9c0xmrdBGsrKVaPpx9pmWZse42q1nsPiKhqirQRsVrM0s+Ztc038MXT8ZVQNMKasGC2G9L56nRTFVWVgB6smeB2YYRsTw710KgcOHhxS32ilS/NgYXMgoNsFM5DXM6AksxkdZ0t0ybAzMXaetd3LcONvvnj0+9bJZPiD38QT8yycPrk2fti5ajQ1ycwjQD1TVWmCqKVKOva4sS8oa/HpetRoS9OI8Xa1ZYBK7loJVNv5qK0cOH3YbB0vjR/jyiOUxgXnll5F3KS5NnDQ1/mBMsMA1zbGAa4Y8qBU6/p4wr5xM8pDH07hXCSMkS3K8RLk/jKTH1DLbVnj1DORxmFvji+hIFXts0iMVI6Sbwt63hr7YUicROTeYqU6BQr58RKJietaZ7mbWdVF3RHPBfP2338vy+e8wrGnZXKplxbzrZMZNttfcZvImiM9Qc2qw22LZUcR5RzxWmawmpdcamyPKV3BmFg7YHxuqC0Tvk8jFmYrS9ZTrm/kEI5AiRwzO9pHlLlK1Qt7jSV/FZDMcseOgpQ/Bj6BNkYXxmSReTkdk0YB0m0uuKl9DFfM79jOxnOn9L7BbTOHhGqr43bF10Agivv3xxWHSg5GXYOe4NgOJCy92LQPdifHAay3+8c7h/yMs4c1oagWMcmxUJ6c+g/0eJR6Iko8aCRf0IgwA2QvUF9NPh9b5CaOmAajyxLTNtympZfQQFoD1798vhCDA5EhJif8305XRNC7F5f0fIxoBlBGwM9MXND+BwGHm6NfgWAODl9Nbp+TcDg8vTP16dXuCJaG741imGtPpllwotJvBZfTYCWbwxYRGkinluqzzEhaath2zA0v/QSKHouLPxCDzv6lh510oKAb8OVimj9NGyp1h4QH+7N+eXdRNKrD067SjwfAZEuMve1leRzMVPSV+mzlhiVCN68ONHov+RXUL5vgCMRCHK4MpgJsxmlBQry3traRyXKpjaqEPK6rhRyDnD+iJDrZTklH5pm3QtLa7EsWv2AZyO5JnfjmtBYpPTuGXWIx2+3vSRNqaxHsBQh0IgNR6QujcATF+3KiFUPmRzufjLMnGQJP/Nkrh/hdxcRwo/LUysffFTW+TQvl3A0Ym0UarIRyZbK3Nm2KtVVOL55LbTz3Z3v7nz3kb67/vDSviCyTxn6dDehz3Usc8g35eS5AX1Stp4YSNU2MkstRpF7VNNbiPTj2zEc+xcVU3vgRcKv3xAfmVS+wfyo1Ie5PylWXovUX+mCGGQ5mhmYlydHzHfFsVn2ZlH1N0d7laSTEAYab4GIiJqpWCa5kBBZmscxcSL1nvATpeMnmZhJxEfJ6ysmAtKoqHvM6s8OSe6Q5C4b7bLRbyYb7ZDkznd3vvv/6bv3IsnmnkCLk3Q+n8t0aSzNPqfZSoEGotiqVL3ALbdE1dEKERMlxnKayMGZ9LqTbnDgqYEvB/6wfxj0vGFP7h90D7qTQe/Aqef6m8qPSydr+lRN30aPLGKAuI/AcXkM49JZkvjN5T+IN1UBhTVevC1wM2QOkb4vsWPvcMvOhSQRP8l4WSAk3cCQcSUjimloO6e2adGWtxBMERdj2oYQJn6xLwhUeIslv5gg56VZgG66dEcBbeA1jlIYWTlKGHtRDg45EkQJoeYEhhXSu7eAMB8oMIKdIjp/Q3RqVfRvIXlxSTN+za9iTj95SpGjl8h9f9v67lls3wRcGQXfsdBrqh0ZwwBQEJiYVeLOHT7f4fNdjt/l+N9Gjt/h853v7nz3/9N3vwCfWzR0Nz5Hg0fjc7RtdUSJpV7xDqz/NkxnV7EcsHmLxPPylJebCwzOuAKmVB4edapzGcWeLt3+HPorh/bKESQ03DQ3NXyGkqCcVUsuwnIfXpzc0l699gSS2RJ0zIY/MhhqIEYXZ7aoMKeZ0pAs14Q5Jm6EbDezVRsD76VcbNNcJjkCG5PZo11g1or4Nu2lRAnxRNvN3mYry9r8MK/rNFr9+3MxhO6Yyzbx3Tsa2gtwujZFu3WkOHFLu3Hm9mDa+rnbKodQjbZ5vuKcmvXESyVT2j/Hry2e/vh2/Kx+GIXPBquQygLavw0T4Sg2KpbwqRMnljTJpzNmfNR4SUJeI8wWx3fxlVLipr5f7hLxmEVKnRSHAOpVHUb11UcVUeZrNTaJtkM/bkNCbdno94yzHJcDYWyOddBZkHexK05CCj68vZ3a2ClydSduFsW8ZG1eX8vE7wpqrqHmMjX9bI0Le+zaM5tuPLgukZCRZml99eCGnlujR7UT7hDVdR5IEpaP5qstr9DaV/PRoOcSvSYf7+K3vIGw2U2YiCU0MmDkizPhzZJEqz8KQaZDbnAzzeFFX80W71p02SPcXqfGkmuGdEMXgJD5ew3HiI0xmd109gRngCRoXPJn1ix8/mfeO/dzY858+4aOdKKln3j6q3mmAV0a0DUxQFv+TVoiw4Jvm08A0H44NoDjSv8cCSyjtbhnaG2N6ky+zX0oNXhg1WyiXxyZH0dVgLNXgh9Q67INwjDh6fJlHx2ZtbQoNzWEVawErEtwk98oQUpck5vht1yJojT5a5svzXhULZicx9HyW0fpOyLJryfu/o8i3i7S/BYjjUW4tPB4WX1947SoRe4+K7/95PnGVwHe0zdIgoSnZMuMugO9tFhwc3GQT+4o/I2nHAcYqKMM4sKOEVKdENjLyGM4YnizUPGywkLJjHDlHlltMmcvX6QJhRYUj0xoymdDUohDohAMIzodQwvfxciSndGAVrIZ+m0PztBYZit+S7xFpRd7UDlVebR1A88+JLbcu4LW+SMY4qQwJAC6+TyP6XQX2M7nQsJcH7A2P9ReboIiir5YFbJIGFaWvYoIQWZMU2hxvZPO9XlAK9YohmtG9cBYsCltl6ull1Xb951qIpe0Az00n4dolgQP0YYluzMVLajOREQHuFO1EX46G29QBLFYY16o5+mbKraTblNb+vIHJm/Mp9/qtjoulyL00ZJEZ6iMa8TNp11qX75ZOydQrs//1z7+Y9MX1R3tBS2TEeO5qYOMz904ZbmJ9kfmLMwMU6NHnz/TIgoVYCu6DU+mCv3mfVVbsTPbQ1N+edbpznk/vbQHB56JrZ8K2spvsfgXL2sxAZe/KFouAMcoqsEzr+cwP+aBfYHgjs1ZqKLjfR/5oQLUdDbLRfd04yBUlvB8aBatJ/YjQ3OzHJFKPpiFv4+cd/gPP5KFMWs04vufnWJxD20+lCdE5R34w15AB2j2Lwvy7gc= +sidebar_class_name: "patch api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Patch Workflow

+ + + + + +Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + +## Request + +

Path Parameters

Body

arrayrequired
  • Array [
    • value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    oneOf
    + +string + +
    + +integer + +
  • Array [
    • anyOf
    + +string + +
    + +integer + +
  • ]
  • ]
+ +The Workflow object + +
Schema
    creator object
    + +Workflow creator's identity. + +
    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. + +
    oneOf
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/patch-workgroup.api.mdx b/docs/api/beta/patch-workgroup.api.mdx new file mode 100644 index 000000000..b82dcaf19 --- /dev/null +++ b/docs/api/beta/patch-workgroup.api.mdx @@ -0,0 +1,113 @@ +--- +id: patch-workgroup +sidebar_label: Patch a Governance Group +hide_title: true +hide_table_of_contents: true +api: eJztW21v2zgS/iuE7kNfLnZsx3HifDm4SdpL0Ta9vKA4JMEtLdE2txKpJamm3iD//WaGlCzZbpp2i7vdwi0QyNJwOO/zkKLuIp0Lw53U6iSJDqKcu3j2QZuPU6OLPNqKHJ/a6OAqeqU/CaO4igV7hY9sdLMVJcLGRuY4GsZezKRlo/cnrMgT7oRlXDHxWVon1ZRNF+OJNRvP2clRm12ri5lgE52m+hbpJlKkCQ5NmB7/KmIH10YwkouPU3FwrRh7zhTPhL+qyeBv6FslzDX8GDGnPwrFbqWbkVzasNOzV/8ZHb09ecd44WbaSDdnILURvxXSiARGsJinKXNBlzaYIOcGZnPCoCHuIqm8nWbwCMWAXzKB65JHdOBMIbYiG89ExqODu8jNc6SyzoCG0f2y3U6OmJ7AjGDZJSMDV/GZZ3mKw3vxsLvf2d/Zi/lgMNxJOl242k86w73dTqfbH0b3N14IYd0Lncxx5lgrJ5TDS57nqYzJ09u/Wq1aZNK/4yU+XpGWG8PnIIB0IrO1+94r0bISI/b6/PTde+TJTsuQYtyCfyZSgWXB31dnLw/ZYNjpsRZRMyK/eTpzLrcH29tO69S2pXCTtjbT7ZnL0m0ziXHEs4aBryBqyTHgBFA6NxjETgqSEx6t2Hw1VAWrAh+dPoYQE2aiTSbQl0IVGU7DE+/ZDBxDF3nKY7wKN2Kdo40g2B0KsnBWSXkfpPyqRCPmHwTDaAmOMxCXuREWPIhPMEIcN1PhMB1mKDZmWCoyIAhK8MkEvOPN7epKNkJpuz43iPiJp4Ug2ylxOqEoX5Z2MfiduK0nHaovXdoI8Go4ajEVpj5+p9NZjCif14ZU8VXSVDcqFhDMDqYaF857PGRhPpOpzKP7+xq3MopLZv73/ZraJRhZIdixsGBDCIemEbcWhQKfXWN8XEdUrK5Ll8Pvit4+aDiQs5LrNaQhZUOVO/Q4DCYtzzx/dlQX/G5Jj5KodheLC18pLVjYgtuvfM7UotuHbDNMKvKVVsBUU7E22Pce/2HC2BzM4BXodTqrAo/WSvZA3VpbrKoYWSoF2Aq+XrtOkeyJZTLBTHPz9gojP/5rOVzyObo4ZUjZrlWSk6PjdxcnF/9ulonqLtgKmsijZyglxRa6pknw/mDCeSJEv9MdTMZ90enux73OYGeIE/l0eexUibQQFnPquM25zos818Y14phGHTn9WIVeLcOC9Qrt7w72493eMB6AQvsxdMDJsBN3d7o7VJV5cqrSuW+8j1ZwZepVDY9esFEcC2tXO/NyF//m2RoJ05i0mbprcQHMnolsLMyhLnyarBRc7GXc+VuDfn2G7qAPcGF/sAeluLNsvmW53xU4DQriJ4TYUyTTMqBro1CQtwoyDIb+AMG+JMhikgeEWQmLWpBW+JYClQpVf11tOkwldtZjY6DYt9iZcIVBKCO9VwLWYmMAWwgipYIKKZMfWL8S4bhMD3XyiHB+CSirNTWcwJYgkWMYyIDjJ5kgfsi0wcaALMvAIrpm+IEl2l32giegr9fvMCiDFjQ8/gi8Th6R2pdK/ob9NAyBmlU11DXTij3Bx4POsNefDPqc9/b73b3d8XDCd3Y6w93h0Ie8tXxar8hVf19KNgFVSMYs1QDm5e9gEAgGsD0JQJM/BGybPiAej7A/IghPW6kZ5GVOfHZb0INfHL5n/T2WcjUt6D6fLhlBtS7PcVlRpCkudqqK5hmfGjmVa2tN2WWOjl+OLt9cwJ2z439dHp/DFfJagTsjBdGaYFhqSqmZviWJgwK3gNstAEtEkm32PHB9DgpxyLkaofS/7NyCMRHq8yJ1MCLMvmZEnTWbGJ01Uony5rNjT2VbtLcAiMG9jNYUY46ITPt0f45VOXetN8GSz9kMkl2YZ202ShKJSvLU4zkL4+eEjJMEU9czmBSQyoJWhrpwTGkn4+XaX5my6Y1FGXlTdwomB0j+CKAfuwKEIzXrWVhFSxAx+Adk9pZrSndRMxqZdK4ch5qIi9c5mNEYsDADhMwkrKBDOUJ3WSg8qqSrKla9OlK5e+uF8QUS6hkv7CPy7n0K5adFqlUPPomQfBahta9G5I3STaEiwUNa4ODgQFW5q0x8vzuwyd1N7m5y95G5u/zwLKzI6tCnuwp9LlXYH8PmuQJ9DEWP0uUm2u9+H8U7cgv32QJEev3hImzCAb34nOPS+QfiI9/K16wpS3/4++Ny96Rs/QtfoIBkR6/BBCqRSA5I7oXEZChvqp3V2V5qM5YQoGoNRISqadhcF7SHaQqlUBJut1iihVVPHJtxqI/crzGoAuKsKmnluAG0QZIbJLnpRptu9PN0ow2S3OTuJnf/mrn7IJJsvqoIOMkWWcbN3EdaeO7fRgABK98NsCrlqtdQdbSCzFiFsaImcojGve64O9mLRT/h/WSwM5z04kGP7+5197rjfm8vqvf6q0UeV0nWzKmav70fycQA4j4BjisUBJd1WifN7T8wrxETLGv0Sq7EzWDz6k0IYsfecBU7XmjN3nI1LxGSbWBItbAR1jSgzZDWlLRAwNkU6qLCl5cS5MJQkpkALgaChqUyk5S8qAXwNfPWaILvFX2ilEFWzSJVnBYgIVWCVCNq1hBYEpQUE8R8wIEQ7BSq8w9Ep8FFfwjJszPU+A1qzI4/x0JgolfIfXfd/u4JvmPFGnHuHfyFjV6/2uEKAgAWBL5mVbhzg883+HzT4zc9/ufo8Rt8vsndTe7+NXP3G/B5QENfxudA8Gh8DrTtDquw1EsMrv85TKdUCRJQeDMdx4Wh7eYSg4MRrICb0s1pkkuL5ycolEcFHni6imSiDm7L0wEHt0Aqohs8LZYJiMHqgGy0OCJVUdvtO5ncRzgHgkmvR2FSICrPN96Be8Gt922ey3Z5hEfp23ass+0x2HRNucJzBT41kYCOsfoJ/AEuIzHmfYEk5t49ZAKMbnATbSU/yBkPvqDf57qAkkhstvAAU4g/ug0i5rD4eGLDMRl/ym5JP9Dr0qT3f1wXz+gLuqwz34OzAT0DSZdURBVuFiFxjkjdz74SGIvug6u73upZKSTrsReCG1hG+BceT19/uHjGpohPqT4UFqGxkLiggAx7DyFC9W9Ubv7jIGpJEE3TGQk+arxewXxjkxQUZtfqXAh2dRKM8A4awxlUcjIpDhJUPHDU4nRtIj6JFHtme2FJDDyI+W2w0DZvjHtG/ZEWElL5Izt4UulatdiRNOXxG6QJKtK6kF3lpV68ptf3CvG3klvLc2sRN/tsSQpv2qvYH9eJIemRBU8tWeu7J/f8WjV+uOqCO8h1WQa0RJCj+VIsLr323XI0+LWQX1OOa/VhJqH5NocxX7KYhd6ZJuyExTOtrfgHYxg6mAZX0wKy6LvFusVJW5QRrV6nJlLLT9mSLYCSJN8bSAzlg4mPsZUTktEA8lTiU/IX8izk/C90mvaXhs50+wo6LlImOrbfLTNO2MIJW74G2CC/b2gYWHhADXSgOuAD4HDhf6oEQdBa3fO81lZ1Yr9NY7A1xCAqcbH5gf9xsChw4YrRA6SuaKAMIxKvXhPiFwqBF3a1hrHKPYRlC67Km2popkt28/JWe1jYYP9s+qLGo8VWCx7x+9FV+guV5M9Td/9PFW9TaX7GShOwMW5Zni0+HzouVzHf+nnAymcOALIwlEmlsECpJ9CLgAVXtxVx33sm4C88pTpAEB8WUP6TLkRIdUYgnsOMoYoRz6SgDYlccIe4cgujVmeU5bnRWFpg2UmMpgZooCRYwLt8LFP8BAC3zMuZOSWjB60YM/jbFrQqog/GZrDAFW32AdaIKgaX4/oQD33As191WCieg9fpqx52VAYSALosKxQe4wexi4xxCNevRFsibVz4ohiOQXsVNMHKalRZITCMUYU2rZRMZk8nuNcNy+haUH1lLogpGza6wfS1720WipyJtPrepbkk+BpviOTWTKR0oh0qOoA7UZvh7cnFCkdgpizoFQv6SCwMsttIi58ygfI+fHba3XanRUsR/ApLWwdr6hpz/63a6pcxy3FY+4rup/3EMTROXPFs57i1hyYr/ArMZ/tVtFjpwoADmeCXLDOwKj67u8OdH1z73eNtKCK4rXB1s1jWUR0Br+M1rKMnUOOWvzWoG/rpWRD3GXvw88i1gpc7l2peK0tw+VHgXgdIfn8DVH4ziuTyD8Lbj9bFnOBIOfChDydxDewH+72uB4ZFjW2E96OLw38C9Th8qJn5vRTDb+Em/j2IruE//NC5zywgovt3UbkzCTSecYkB10GgcAG+ALL/ApxO5Fs= +sidebar_class_name: "patch api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 Governance Group' (patch-workgroup)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Patch a Governance Group

+ + + + + +This API updates an existing governance group by ID. +The following fields and objects are patchable: + * name + * description + * owner + +A token with API or ORG_ADMIN authority is required to call this API. + +## Request + +

Path Parameters

Body

array
  • Array [
    • value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    oneOf
    + +string + +
    + +integer + +
  • Array [
    • anyOf
    + +string + +
    + +integer + +
  • ]
  • ]
+ +A Governance Group. + +
Schema
    owner object
    + +Owner's identity. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/peek-resource-objects.api.mdx b/docs/api/beta/peek-resource-objects.api.mdx new file mode 100644 index 000000000..ab158e39c --- /dev/null +++ b/docs/api/beta/peek-resource-objects.api.mdx @@ -0,0 +1,100 @@ +--- +id: peek-resource-objects +sidebar_label: Peek source connector's resource objects +hide_title: true +hide_table_of_contents: true +api: eJztXG1z2zYS/isY3ocmHVOWZMm2PNO5U+yk444T5/wy+eB4rhAJSWhIgAeQcVSP//vtLsAXSbRju5lrm1HaSSQSWOz7PgsRvA10JgzPpVbHcXAQZEJ8OhNWFyYSp5PfRJTbYCvI+cwGB1fBOV23wfVWEAsbGZnhRJh2JnIjxWdhGWeWp1kimJ6ymOecGZEXRomYTY1OGY8iXaiccRWzmdFFxvhsZsSMOICx/y2EzW3noxqzXH8Sit3IfM5Oz37+z/jo7fE7xot8ro3MF0xaGi4NkM41i3iSsHwOV8fvjzvAsxVRgQOB79vg0gpzqFUuvuRjoICyyFgdODnDSCsFkmpzkHLFZyK4vgMJM254KnJhLJGQKGfGYfJWoOAGfHPTQW+wWjQXKQ8OboN8kdE9UIiaBXdbQcllcJCbQqxq7mIu2PERaiuHT07BQE98IS3CgEhMd4Tod3vxZDTYi4ajXn847HV7wwnvRrt7owB59Yp7peMF8rC6ZISiqxxv8SxLZETq3v7NIgu3DearZW8DTda/cNIY7xLAWcq/HKIJg4NhF6Tz4rrR6CoyJ7ZLJ2Lei9iZYzFYdx26zlIdi4RNtWHog6xckWk/n9zHX6sMZtHSmUEfziU45grfq9ZoUz6OQPWvLQhOJXOMDbj0WZgOzZ7yIgHRA+/HS5Yif0aL1yqqGJBggJkwrRzAcJkWKVNFOhHmMbxQ+LjAWmKrP2zw0+t27+gPuofNtLJOQf1uF/9Z5uNEgglaV57znN1w0L/IwU18GKOvrtoCOXm0oz3BbRzrLX7jbnwzx5Hx1x2mjlS7Hqn9aNTb7+4Pd/ejYX8U7XZ78Cniu9NRN+rt9HYCNASPT1WycIF5V2aSry37DkY9sPDp0Xk4PgovMIyufE4b0Z/rtjWdYp7iobVnLruFMKLyi8mC2Ftyh4pFdMw1PkTCMyvitzJJpH0yJylNE7BebJnNwOsYVBBkAT5C8iuLyRIfve6wjROzUvFqXrgxfAEUIPpS+wTHbXHXDFYB1lyl88Z0ZNjNXEZzV9GaxfIxTqtszlUk1iP6OEY9TKXTFnlOJiK4ELFyEqyLFqSq6TkBHiXQwYVWXXJNa5JWyBfra78DIT8LVg5YkVaqRq1rW6n27MN3P425AX0dgiG2Ti9/ysGiva2jQ/rQLz+0cVcULqCXObtUwJixPGGFkuAfnsemmp7O5S2fTPcm8WgS7u5PBuEg7vfC0WSvG+7vdaPhvphM9weDuzYmwSc+S13Y40erkgKvweYcUnNJJVk8ym5lzlle6EjaLOELhncpmzbc4mHxawvdn23KerwS0b72PmaVuuKuO6KKNI7KW5YYs2nCZ2DNmIqRmpUaBOHgf65YPbvkgwFcjNEBKGLAVyIOtbOKlkZEkvqhOLu4rdCtVKDA1EU6kgFkbIBMNic6WLxrC1rIZLN5zpRGY4KpOav4sYKKMkLbCjjnoJpJAV7fYZgQ6+/OY+tQvoEECYyBUaOSa+OAQIxqWJ0o2IlUn7YYXAJemIYrhi41RxLNCZCaczUTccNiE60TwVXTZFOeWNFuLiNSTIXJM+1VTvd8VHa78KOshOrADcGm2roomQQNJlazFHi1dTB95gnUCtK1WrAUwJQM6Vr8gILtXBdJjOpIhQFtuF6FKtAXgFPIu6fbUDADEIeahaWVt44TsjGLxtHU5ykY8NCTY6GRTiYC+i5HI27oFH0RVsEwgNsap8Mg6PCaHVzp23WE2CLLtAE3j4FeVBY/5dKaW8U+T0zwAgDD94qJDK+LKlZs0jCvKUs0akTNfGDjGktGq2/yGPRzLnJPH/UEHEsiXvmoC1O/qCv0HNIIT274wlKivc/dOIEYXL+BuqGpNciiI/g8xaXSWkyvLZpLfB9QsUH1wEcKMoRpCqRLitilyGaVqHyF/KSwZUicvz2s3AEdhLIIjcF+gQOVj655sh+DhkT3Ya+6ta4kvSKZ3kiRgKTUpZZfL250cN2ig1rPLWqobUCYQFIb0kCIDSYrINhonXPw6myulXhHaBVG9frhi53B8OXu3n446vb61EdLSH/ltH8hjOlAqkLg6CrxO7fJ0Kiudy1yTKXiyWUW87aAP1ZsXAfnFnmbzbixFXxwsYqFhUq+xqTqSw2EfMQVglEPPtCxC1opRiN7T3B+/rxacHe3CpPf+G5iqXm7r9tco0YEB2397SGEJQj52hgQMwRzepwtHebzvQKb6Jh2lqSC+JLxH2ppl4E6ZD8w+CH0ql9v995IJcKZgcAADgWxHMFEwHn6s6TinWqDyRNJlrCVxi01O6iJTo+94nG5+cIOvTC4cWN49AloHT+i7b10WLmcAg7hEWLrsmJP8Mlud9QfTHcHnPf3B7294WQ05Ts73dFwNKItEmEtn4m2Vmt56Z+FEgZ6lkRHYJHfBe57cNA9MUCLP9SdLduAaDxyW8iNrcT0/DLcQdwCiPbq8D0b7LEE4EdB1/lsRQkqvDzHrcIiSfgEL/mAdYRPjZxJ1caKgBYXE9rR6zfjy5MLuHL2+t+Xr8/hE9Ja23odq7LKaWph5vqGOPYC4NaNhXwUUTH/0VP9sQJA1UDpvtmFBWUyv6UEM/zqLTOapOtALUMpctut7IXsiA7AStrj4xDdbMKxMvhm/cdxFIksD0+8Jn9kc4hqYV522DiOJQoJKcmXzxT6E4BbUHfL4gMWKiCUBRUaTdA1l65fq21Rq3LZGnX3ftI0CgYHcP51PxlHeQHMkZjNKKy8xbPo7QM8O80tc3fRUBqpdAE1EYAS7mgvHGiHRO3Aq2U+HTlElnJVjqsyFqbAUixKd28dM0e5pnsRL+wj4u59AuknJNGqGwiEKPgI/bhsRNYozeQzEtxEsWmyH1WZqwx8NsXqvIndTexuYveRsbt6s9wB93cJ+vTatrz8j2ZYPNegjxEOy5W/rP3u+jhnyC0GCvEQ6ZcPF/4nORgvvmT4+9I3xEeulLd0JKU93PVJ1Sz70l/bAhkkPToJppCJRHxAfNccBzVK3Flf7Y02EwkOqlogImRNwxa6cG1ZoRRtotgtaIWFVT+UmzcQEda6DIirqjjMoFXON0hygyQ31WhTjb6farRBkpvY3cTu3zN2H0SSFVcULR4n2SJNuVk4T/P3aZ+YwQBWPl/CqpAjU62iFSTGKowVLCOHYNLvTXrTvUgMYj6Id3dG03602+fDvd5ebzLo7wXNWn9Vx3EVZMsx1bC3syOpGEAcPj9TKHAum2sdL2//FfgL+BTTGu3vl7gZdA4qva6x46Dlh1qdg2xAGLCjuWd78fLsBOnD0kS+8ayKqTdkeU6QkvZX6SehDXTcQMdN+dmUn++m/Gyg4yZ2N7H794zdJ0HHwdeg4+AJ0HHAEGJNEWL9mdAxBtyB0GwKRsFntfzzGGb5+c4y7HNuZiKvgN4SiuyPWp6I05q9xWeQPFiySzuRqlYXpjcYm+LY8tgEDuBsBilSMchaEtAtepVMBWJSfHg8kan0T/UIpGsW4Xiag1QuZkp/q1bxT3pYSgqJxr1XDT4mwZ3EFOEfUKB90Bkk6m+4x+mt9Yf2g9kZSnyCErPXXyIhMOar/d9h21MCx8C8wXRx7mx9z+MCbs+cK2gjxJfMpa8Kgm6g+gaqb8r9ptx/H+V+A9U3sbuJ3b9n7D4Bqns0dD9UhwGPhuowttNlFZZ6Q2cT/9+InULFc0DuzXREWD2uMTjhCnAlOvisaaOVDvgeBNsOrtvt2/KM79129ejpNp4zDEtIH+rqmLTrEBzDhcGne+d5ntmD7e1bsCPY767DM9kpz/IofYNP/G5PQHkteck9So0+hQPwWLNvQTqkeSPRuV0mJOLODuUBVQv2oCcPHqSs/MHCBYjCHJktPBHrHY0u4/kJ6DJ+sDS6Q461Jh/IdWmSuz8uiyN0jyxt6ntwNRjPgNMVEVGE6/qE+DlCcrf62jnxuszgjwH9tcVOcVifvRLc4PkAej7mxS8fLl6yGQJRSgQFPmzPhMTOAULpPbgIJbpx+awITqLaY3QxcydIxktP42BgsWkCArOP6lwIdlUeGHsHFeAMUjapFCcJyhI46/pFaZ1YfBYJFsdOrUl0PBmrbdDQNl+a99IdSsCOoXGOqfNRhexIGneEwx1c8CJSA8iuslIu3pDruUz8o6QWOmohUbMvV7hwqr2K3NPdEUQ3kuCJJW09e3FHL2zQw/YKriDVVR5QE56P5WeootJqz+ZjiV6I9Jb5+Kg+uAMlS9OYS2rl+aRjFs21tuKfjKHrYBhczQqIomezRadYQoqIsN9tsBS6JUMZAmYk/k4gMJRzJj7Bmk2QRbvdEwrJX8myEPO/0tmQX5dkpstXUFpxZKwj+2yeccEQFwxdDrCef1e50LEgtlEGygPOAQ5r+1Mm8Iw28p6j1ZrVifw2zcHSEAGrRMVmB+7LQZ3g/CdGN3B0NQbScEBnH/1TZXgU0NPC8rWkrHKzYFWD6/wmGqrmit4cv9VPnlhJ/2ryosTjek8Fj3586yx9Tyb56+TdPynjbTLN95hpPAjGvcmz+g0yr5/8Ehj0V+LbtxvNKHnlAd/6JqGlY8nwN9x1rzhBwM7p6LI/SNsklCU8x7CgtBDN8XVDuOsueI7gcQtdU6cUypnRmD/ovDIQmhkYA3FvAdTyiUyAHm2AlytzijiHTNEx8Lst/OMY2p8x7rAP+GaJCDSA3R4+CAz3ftPlawLAtO/RM9hR6S2A2tK0UHhoH9guUsbBJ7/iUrG0UeEyn283nAjuNHY1q0wD6KsoAp29Eya1p1PcuZb4PojgkWuB41i/bQ2qRyv6txvVgpyJhFwbxy3j/q/RBncN5yKht+JA2hb4Ipd6hbfHF2sUgZjyv5VoM9v2k+w2jgUi2F8599np9DrdkPoNfJECtG/QITeIv8eXwayeGvzBrr0fZtUvb+sd/L/ia618ocMOZTvDPTeUvnAdk2ter/x7qVCyg8YrqiolYJvb2sFCTzTHNhhI3N7izg22dHd4GfjHbYGr67pboy4X7Iyf4+qA572qfHHmpXpJvz21vPKqVbJyz1Et6u2GAD5+ErhLUUkHHT3wTptJxJe77X+9CCl/1dPXfpbBftbNcBtUD469bmwavD/Frbpg4l+7lbr9D8Nv4CL+fRB8hP/gi85c/MAgun4blLuJMMbRLeFcG5rxH0D/MOx/x5c6uA== +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Body

required
+ +List of resource objects that was fetched from the source connector. + +
Schema
    resourceObjects object[]
    + +Fetched objects from the source connector. + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/personal-access-tokens.tag.mdx b/docs/api/beta/personal-access-tokens.tag.mdx new file mode 100644 index 000000000..4a11a5bb9 --- /dev/null +++ b/docs/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/docs/api/beta/ping-cluster.api.mdx b/docs/api/beta/ping-cluster.api.mdx new file mode 100644 index 000000000..bd2b90ae8 --- /dev/null +++ b/docs/api/beta/ping-cluster.api.mdx @@ -0,0 +1,96 @@ +--- +id: ping-cluster +sidebar_label: Ping cluster for source connector +hide_title: true +hide_table_of_contents: true +api: eJztW1tz2zYW/isY7kOTjKmbZTvSy45iO7vu+FbL3jw4mS1EQhIaCmB5iaN6/N/3OwcQRVlykqadbZNRHhyJBA7O/XwHAu4Dm6pMFtqakzjoB6k2k8OkzAuVBTtBISd50L8NhrbMIpUH73aCWOVRplOagOHXU50LZeLUalOIDzLRsSxULoqpLPBHicjREiMFwqLMVSxGc36TM02B+ZmS0VSOEiXGmZ2Jk1iZQhfzc3vXeGsGorDvlRF3upiKi6t//XdwdHZyLmRZTG2GUY7Ar6XOQLqwIpJJAvp4Org8aUCGXEUlDYQc98FNrrJDawr1sRiAAsmmY9N3vISRNUZFhc36M2nkRAXvHiBxKjM5UxAiZxKa5E4lJu8EBi/wzU2H/rBaNFUzGfTvg2Ke8rsig+TBw06w4DLoF1mp1jWpxMmRsGNWjlM46KmPcpYmRChS412lOq12POp1D6K9Xruzt9dutfdGshXtH/QC4jVTeWpNDlOBg06rRf+tr4NRZVLQWmRuMoyXHEOcomsGqpRCyoxId6YgsjJNEx2x5zR/yYn2/br0dvQL5pIn6YKlGBayKHNx5fkMHqth8ULMbKwSMbZZnTeQj97v0JOxnpTObQX8rRDSxCwMCfWY8Zw4TzNy9EI71eh43USPWVlaI1+3RifqtV+2Xu7tv4z2Or1ov9XGp0juj3utqL3b3g3IFjK+MMnc2fth4S2fW/Ycoz6x8MXRMBwchdck9K332x7/e7dpzZz1vWlVZcoZx/bN4eHxcIgnrwcnpzdXx5uiHKw4w3nGpkomcBO2R2OFvyW5NV5UIlMkgDOdJLrOElKHmnC+WV8WTI6QPrDsjKcpWDXORZ7CCwUZH2MoXWSKswC0ssJOu9VqbeAkVoXUSb7JUddZiG1Uzmg5cn6pTc6LuhjarJC3hjXGweAGIB1VZGIF5iGD554YqHktpUgQWNNfTaj7AIOuT4evbXby01BlHzR8pD+WSY5RtSf3AQaJS5shXqGFxvnxtTg8vRL/QSpz4nUbrcZua7fda3SRLFpYdMgKltncUxl6/wmuSmOc4ziCe6090Py3zfE5GNxcX5wNrk8uzuGbGHLu8uKSlxpfGyg+XrQ+NTwxcD0TqXZYDcOUpQzVSDFUadhpdVou6buhFbPtneBiKAZZNNUFLF1mtMrg7Gi/i+EXrgYifQznKFeIi+BMR5nN7bgQb7SJ7V0uaBm4IjJwR1x1BOSgFSjpT/VkCs87ssW5KurafSmQvxLpiumrUiexuNasmlav2ek0iVvR2u/vdsXgTIRQaYsqRSXSYaLhMVSpjg0VyLgys3f2y8yiLsNlLmjBdrPdI5pt0e53D/rtrrg8Cx7cv52gu6kcuBXEcZaB0xB5GZoxqKR67L2clxEjG3Ol1YZr/B8qBauZ2IXiIbL951Pja21UOMkQg+BQMcsRJgpQ/KBjMt/MIhE4kovI5HGrOQqaaLTFKxlDXiffoRcGaioyGb0HrZMvKBE3RmO+WEwROuaK9cSy6kDJ0X6r1+mO97tSdl522wd7o95Y7u62enu9Hq0+gzWBPOqpSWaZnK8t/S9lVKYjkVggHv0bFIJ8Ad0zA7w4psDVZxuz3KoNmMYX6J+ymhtbien5FYSodoQUrw4vRfcAPm8mJT+Xk0dKMOENVQdTJgm5dJWTHeGLTE+0+VS9Ojp+Pbg5vcaTq+Ofbo6H+ES01orWwMBbY3JLy/Vjau+YYy/AnUQVUQnUgXwrXniqLyCQ9BneD9TuW86JAb41lsj7mOFX3zCjTtpB2nooRQ5+ime6oRo7AMZ4NpNFNBUjSfDYl4UXgyhSaRGeek2+oBITq+x5QwziWJOQMiHEDaKYPwchIeOYQtcRGJeU5BjO2bIQxhZIKKu2WKpy1RpLuHZaNwoFBzj/vJ8MkF/BHItZj8LKWzyL3j7g2WlulbvrmtJYpXOUX+BAQvhzqDHLoGExgmwaddinIzJXjsRjFuOqjEUpcCEWp7szx8xRYfldJMv8C+LuMkH6CVm06sUH5YMvpw7EZSO2xsJMPiPhJVd8muxHVeZaBL4Ya5XE29jdxu42dr8wdh+/XPSQ/i1Dn/Y69LkxfhOBiuca9MnYe4xd7DT85ppNZ8gdwnUeIv345tpvUdBWyMeUWvw/ER+5Ur7G/KCyh3s+IvhRGWvFFsSg35khCcbIRCruM99LjoMlStxdXw2dxkjDQc0GiIismYm5LYWkHsxheiHzHTQ8Kjc/FGIqkR9lRDjVZUC3ZRTyntEWSW6R5LYabavR91ONtkhyG7vb2P02Y/eTSLLiiqPF46S8nM1oR5I9zb8naaXAALH4OUZUIcemeoxWiJioMFawihyCUac9ao8PItWNZTfe3+2NO9F+R+4dtA/ao27nIKjX+ttlHFdBthpTNXs7O7rtfbe5WRo4V15YG69u/0G9mRpTWqPUU+Fm6BwqfbfEjt117HhuC8gGwsCO2RPbizdXp0QfSzN50pvbDaegZdW5XxQJUpIPQ9M6L7bQcQsdt+VnW36+m/KzhY7b2N3G7rcZu78LOnY/Bx27vwM6dgVBrDFBrL8SOsbAHQTNxjAKZIhKqNcQbEwhCj753Ucf9oXMJqqogN4Kiuz0NhxbslacSTNfgKV8ZSfSLNVF6Q1jZzQ2W4zFACkmSJFGIGtpoFvyKj1ThEnhPyLRM81xTAKBbjYPB2M6t+ZiZuFv1SraREkJDjkpJJb2Xi18TMOd1JjgHyjwPugEifpP3OP01vpD+8HiiiQ+JYnF8cdIKYr5av93b9MpgRMwn1G68Gcgnjgu4PbMpUEboT6mLn1VEHQL1bdQfVvut+X++yj3W6i+jd1t7H6bsfs7oLpHQ09DdQz4YqiOsY2WqLDUa3Ku/zti51DxHLB7CxsxVo+XGJxxBVyJL4RY3mjlCw/9oOnget68X9x5eGhW5+ybdAA/jKrbI64xcHyWWYLp06JI836zeQ/zwWwPDZnqhvb3PYy9a0R21hxBZxvSEZ0+daFHA+h2h+88GqzwTJNPuwTIxJ36WUTyXpiBDxx8krLxZ+/nEE44Mjt0QNv7Fz8Giymaix9yHt1gf1qTD3LdZMnDH5fFEXpClk3q++RqGC/A6SMRSYR3y4syQ0LibvW16zLL6kK/AXTWFrugYR3xSskMbYI7FvPsxzfXz8WE8CfHf5kT9FWaGgZE0CVchPPbYHFEhCZxyclsOXF3UQYrh3AonsQ4gcDirRkqJW5rd4bEFTI1q5QmKU4ONOvds4V1YvVBJVQTG0tNkuPp2DShoaZcmfec6x83Ctrg44yfNt6aUBzpzF1MyXmMF5H7PnGbLuSSNbm+lol/LKiFjlrI1PLnj7hwqr2N3KHuCEFNJGSSs7a+enFHL6zRo64KT4jqYx5IE56P1aNT0cJqX83HCr2Q6K3y8da8mWoU19VpwuUykaM2JrE4EdHU2lz9UwhyHQqD20mJKPpqtu5o0ZAjIuy0aiyFbslQh4CKzN8pAsM4Z5IjKtWMVKzbNOGQ/Jkti5j/me80/bwiMz++RUWlkbGN8q/mmRYMacHQ5YDc8+9vxjznGygkA+cB5wCHS/tzJvCM1vKeo7UxqzP5Js+h0hCBVaaSp333pb9McP6T4Bc0uhqDNExIuzpMRpf9PC2qWivKWuwRPNbgOr+JRbF8pDfHb/VLJxXQv5u8JPFguZVCd4X+7Cz9RCb5++TdvyjjbTPN95hpPPYld+NlfZNQd/JXHq+tb+3R3vNU4S/ecqwyzEYTs7xRWyeUJrIgr+aojqZa8aZAqmRB2G+HPMvOOBJTf8crd4QmmaILZWBZoo3TCejxtvViZckB44Al2ZW+56U/RGHhkmgyVUO8oXuTEcxCPRod38W7X6xv1oawzCVf6T5aGBugazYrDd24BtvlTEi41Gc8ItZ5VLrE5ZsEJ4Jl6FfNWkQxuRqJ0OBuJZvlF+PlhcAvXAt2z/1mM1RPVvR3tJeCXKmEPZPGrcL2z9GGt4VTlaTUJSLrKrrAvFzh7OR6jSKIGf8Lh80mTT8pb9JYEPlQ3RXcbbQbrZDbBTynpgt9bY34pcvG7jI9JcbHl5wfO+T9csP9W7il7wsWdRrNlLbMSA2l63xc73nrr9mT2fq1G/d1Daw0oGhppnw99Ta4v6f9FurIHujxr6WiZv723bLZ4iYVdl69ZfmkRp9deWGe8y9GGy7ubxRosVNo5stNggAf3yvaW6iEQh8O3nkLiPlyr90mUW3i2s8o1MVVjfvlBW2XMfrZhAj8BygBOe9/0c/9cg== +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/ping-verification-status.api.mdx b/docs/api/beta/ping-verification-status.api.mdx new file mode 100644 index 000000000..819eb2153 --- /dev/null +++ b/docs/api/beta/ping-verification-status.api.mdx @@ -0,0 +1,83 @@ +--- +id: ping-verification-status +sidebar_label: Polling MFA method by VerificationPollRequest +hide_title: true +hide_table_of_contents: true +api: eJztW1lz2zgS/iso7oOTlCjZshNbetlSfGQ969geH5sHx5VAJCQhIQEuQNrRuPzfp7sBUqQk53BSM5mUKlWORDQafeNrCLwLdCYMz6VWh3HQDzKpxv8TRo5kRA/Pc54XNmgFOR/boH8VvD4YsF2tcqOTRJjguhXEwkZGZkgNDC4m0rLB6SHLgIDlE8Hq7E7h4Zn4fyFszkba0LjNRAQEImbIOxX5RMdtNmC5/igUu5X5hJ2cvXo32Ht9eMx4AcNG5lMGyxjgJA1MzDWLOC3nFm+DwFZEBRKC0HfBpRUGpRaf8gFwQEVkrPrpiPdRzuD6HhTJuOGwvDCW5khUJ+NA3QoUDMA3JxwyjyYi5UH/LsinGY7Y3IDlYER84mmW4CP9MefhDSo/De5bQSls0M9NIRbNJhguwvSIjFI3BY6BLkaoPJkyW2SZNjlo7cZpmmXcCLZWW3KtxdbiQoe3YogfPw75WmuNTIpfjeVrAepsnDNe6niK2swLGaHNVI5DPMsS78XOB4tC3y2aQQ8/iCgHM2QG4yqXwpZsYRWMsEWLqSJJ+BBNNuKJXbBMPXyYZ8QO44ap13d6O73eaGOT74y2Yr69093q9V5s9Dae72wP+bAX3DcccFUTCGyQy5y4PBCo6LxqqYYuX7OuW9lmWllni+76Ov7XVBLd/VCeWEpBxlU9KIK/2jcPBe3NA1JXntr7Rk9Bcrmasyy5VJGi+073j/cOj1/Bk/PL3d3983P4dDA4PNrHxY5Odv97cnkBn45PLt7tH59cvvrPu73BxWCxWKFBsR6AGcsIs2XBm8lcroFxYIw2326ofZwGrrOWjyFXR0an5MybJbHdWPpSIVOqb1opcB/buzxh58LcyEiwuMDVG1wo0pcF9JmPwe+J5plrah7wJgl8rG8tC+/dRIKJmTNDyM5EXhgFFUy6YlfGyhCqENZ1qW54In9kkMci5zLZ1bFY5rymsAdSiXBsuEQJSTswfiwYcLyRMRo81VBsHcuyXhNdu+E7sER7g73kMStzYtcrgy4yPPoIvJanXVOgSyVhPiunMBlXe+eSZcW24MMX673u1ujFFufdna2N7efD3ohvbq73nvcow8pIrK3NjeHThaVfCQUxFLFEw/4q/wCDGMHB9iSA83wrkLlI7Zd9QDy+wv5YVRxtpaaXl+H+3WKcvdw9ZVvbLOFqXNBzPp4zggovzxfSEjR3jE+MHEv1uQqzt38wuDzCInK2//vl/jl8Ql4LFWSgIFpjDEsQFWJhom9JYq/ALbfMigTMIWAjf+a5PgOFuLJ1Qum+2akFY0JsjXiR5DDDr75kRp21qyj1VIoc2GFPZFu0W2yIz1KeRxM25BYmgAuR/NkgikSWh0feks/YRPBYmKcAwOJYopI8YZCNwBTmT4ER43GMqesYjApIZUEoTRc5UxoKqWj6YmbK+SJZ1qmjulMwOUDyL8fJIMoLEI7UrGdhFS1eRO8fkNlZrindRc1oZNKpynmE20ECYCvSALug6g5BN5lb5ssRustC4VElXVWx6uWXyt1rJ8xermks4oX9irw7TaD8hKRaNXAjfPJZ3A9cNSJvlG7yFQkGUW2a7Kkqd822ICmSeJW7q9xd5e5X5u78YAmo/ChBn41F6AMIzrWsuHkuQB9D0aN02df+4aCgc2SLgUE8RPrtzYVviIFefMqwkfmB+KjCtXNuqvzhng8RflTOavgCBSQ7Og1GUIlE3Ce5ZxKToZypNhdXO9BmKCFA1RKICFXTsKkuqM81hVIoCbctFmth1VrOJhzqI4eMsNZVQFxVxWGmpcpXSHKFJFe70Wo3+nV2oxWSXOXuKnf/mbn7WSRZSUXZ4nGSLdKUm6mLND+O2nIGBKw8XmZVypGr5tEKMmMVxgqayCEYdjeGG6PtSGzFfCt+sdkbdaMXXf58e2N7Y7jV3Q7qe/3VLI+rJGvmVM3fzo9kYgBxN4DjCgXBZXOt4+bxX4HHxiMsa1h6KtwMNgeTXlfYsdtbxI4XWrPXXE1LhGQbGFLNbIQ1DWhTpDUlLRBwNoa6qBiUKglyYSjJVAAXA0HDEplKSl7UAviaaTgY5aCKS5QyyKpVpIqSAiSkSpBoRM0aAkuCkmKEmA84EIIdQ3X+gejUu+i7kDw7Q42PUGO2/ykSAhO9Qu7Pl53vHoLwBmvEuXPwAwe9rtvhCgIAGgJXsyrcucLnK3y+2uNXe/yvscev8Pkqd1e5+8/M3W/A5x4NPYzPgeCr8TnQttdZhaUOMLj+cphOqeIloPBmOqLLR/EMgxOuoJtQ/SDTdGWB7kn1g0464p07N3jfoatVeBMLQaGTpzAJkE3yPLP9TucO3ATuuW/zTLaheoGn8qnSt+1Ip50h2GZJ2cH7AS7FkICumrkF2mRYIzF2XaEj5s7MpApGKZibjoQ/y7m8iTXVBZQ2YtNiEOc+jugxiJhBE7FmibpNcbOgH+h1aZL779fFMXpAl2Xm++xqQM9A0jkVUYXr2cW5c0TcbvWF63OzXQS7tO7CYidI1mUvBTfQDrgfLp789ubiKRsjzqQ8LyxCXCGxMYBMOYUQoTo2KA/xcRJtLUYX4wkJPmj8TIJ5w0YJKMzeqnMh2NWhN8IxFPgzqMhk0uYNn+snpXdicSMS3PvaM0ti4MlYdcBCHd6Y95T2OWoIpIKPKT1tv1Uh25NYfiTu10jjVaT+jl1lpV68ptdjhfhXyS103ELiZp/OSeFMexW5azcRJC+y4Iklaz16cccvrPHD7gmeINd5GdASXo7mj1tR6bVHy9HgFyK/phxv1ZuJhE20Oa28L2lhD0xidsiiidZW/JsxDB1Mg6txAVn0aLFucdGQMiLsrtdECt2SoQwBEpJ8R5AYygUTH+KWTIhEA1hTsUvJ9+RZyPn30DDH7H1DZ3p8BTsnUsY6so+WGRcMccHQ1QDr5XcbEwYW5DbqQHXABcDuzP9UCbygtbrneC2t6sS+Q3Nwa4hAVOJis7770p8VOP+J0QBSVzRQhhFRVz/34eVfzwt3p4axyrOAeQsuypto2BTn7Obkrc6icKP82fRFjQezI5MTlUx/dJV+oJL8PHX3b6p4q0rzK1Yaj3Hx6PFsdj9+/7F3wKH3hsAlBXxbUU+Xlx75LR4G4mn1RMBfGKWsJ2AObY97KQLxUJ1RlvAc84PqQzSRgo4RMsFzRJEtjFGdUk5Dx4+FBJpFYjQ2QAMFwAK65UOZAD866C5X5pR6DqJihOB3W1AvQzeTJ9CWijZ7A52disDB2NXhVQ0Y+6B9e3cOPj7FEGF7ZdgAfEvTQuG7HCB2kTIOwfmF2IqljQpXAssL0aSCJhBZzSrrAQYtqtCm/sak9mTk707XQugLa0EEWX88DaZHL/qXQWaKnImEYhzpmg3Al3hD3IYTkWQYJFC/BV7Qnq3w+vBigSMwUxb0gv5dm3HHT7IdpAUm2Gi58Nlsb7TXQ2o84Dm2adAJ15jjZX200eylAjacPvQSwnxw3s2O63+eN378ZoddSifDYzVUvHBdk+tPrwLoT4GyX73I497+aQUTbGNh/O4OT16wZ7vHxyA3tvVX17N2jNpY8B9+jpe/s1K3zpMzL/JT9ne84/OAVcojSTWdnUYE8PGjwEMMbx1o98EwdNJESrtB/9NGeDEljFJOXvjNBrthN8OdXn2W9rp2onB6gud4wdC/kpS6wxHDb+Eh/u0Hb+EffNGZSzosyPj8LiiPGoHG8S3B4DIs5D+Ac4HsT7mgMbM= +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Polling MFA method by VerificationPollRequest' (ping-verification-status)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Polling MFA method by VerificationPollRequest

+ + + + + +This API poll the VerificationPollRequest for the specified MFA method. A token with ORG_ADMIN authority is required to call this API. + +## Request + +

Path Parameters

Body

required
+ +MFA VerificationPollRequest status an MFA method. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/post-external-execute-workflow.api.mdx b/docs/api/beta/post-external-execute-workflow.api.mdx new file mode 100644 index 000000000..7184e70a3 --- /dev/null +++ b/docs/api/beta/post-external-execute-workflow.api.mdx @@ -0,0 +1,83 @@ +--- +id: post-external-execute-workflow +sidebar_label: Execute Workflow via External Trigger +hide_title: true +hide_table_of_contents: true +api: eJztW1tz27gV/isY9mGTjKmbZbvWS8dxnI53kib1ZfLgeGYhEpKwoQCWIO2oHv/3fucApKhLLnUz7e5WuzMxRR4cnPuN4ENkc1XIUltznkajKLeuPPtcqsLI7OyzSqpSfbDFp0lm76O9qJRTF41uovqWi273olS5pNA5oQCCq5l2Qpk0t9qUQmYEJaRwqrjTiRK2Kp1O8XcizlNlSl0u/mbvRWmFNrrUslQAvg/oRTmTpaiccrhS4mNUUyauCj2dquJjJFyp8o4QV3iu6qf1Zvc6y4D3zn5SQNCm616XM8apTV6VIpWlFBq3pSkdEeMASX8JpKFGG/49tumiA2E4SKcA/RDIQ3SNPU+tKUHDSVXOSEguH9VLY+VFOapJjG4fIblcFnKucMcxDoMfkKBOgVyTLHMJTOsCPk9JeG3CAFKof1S6UNBgWVQKtJWLjHA5Pc9xsRepz3lmU9yayMwRQDJTcxmNHqJykTNkWWgzZUjJa0ZR0j8aK7kv44OjYRoPD/aT+Fj1hvFw//BgMp4cyElvHD0SI7S9cuVLSIZQLqkJuyUkGVPSM5nnmU7Y4Lq/OuLoYZMYO/5VJSWIyQsyz1IrR09ZWdvA1k2w1uvEFuuSath7iJLKlXZ+UoLzMZTTx9I7mVW42Ft/NqifDcAw/0dMu9wa50kb9Hr0Z5OQ2lVEQ+wPEkbNk/fS4L+b6tykqLFnVa8UbHJLxfdUv5+oiYyPD9VRPBwfHsXHvbQX9w4Pxkk/lQdHB/sRJDBXzsmp+va2J0aoooAywgqhJ0Kahb/phE3gSWQvbSIawd1LJ4wtA7kqbfw8W3TE6Uwln+DXcpzhySSTUwF+GhZTNeG4AipqtQ23aeo001CJOGMiY3GhyqowQKi9pwX7ZtcXiCOIKTLTaefHaTNVpdTZKbvot6T5WhsVTwupiUIv1wQLBTDe6RQrxNwWSniUdbBguM6KhCGJTl+8lCn49fydBmYgprKQySfg+h6rujYa60W9BObUeN6WbdWRkuPD3vFgODkcSjn487B/dDA+nsj9/d7xwfFxy7Jca29ZFHKxsfVflVGFTkRmE2jknxBIoSRkzwTw5hRMSzV339YB4/gO+ZMTediGzdquKf7vIYO9PH0vhkcik2Za8X05XROCia8vccdUWUa26wM3OPeI3yG/abM1PJtqTtnl1dnrk+s3V7hzcfb367NLXBGujXwM19MmJbMEqbCFGafVhgFyLqcyiEOlHfEiYH0BhqRxbUDtf7kFEu6c/EpWWYkVYfctK9qoxaSw8xVXSnyyFM90R3X2xJjuzWWZzMRYOiywPtm+OEkSlZfxmyDJF2KmZKqK5x1xkqbs2Uj4HJod1i+ASMg0Jdf1CCYVXFlxwkftQYEElcGqLpaiXNUGnECXDPGmrRRyDlD+HVEvKSsQx2y2vXAZBU2oQVg/oNlLbpW6q5bQWKQLU8oEXFAAhBgROBNEJvCmUbuEcETqcgg8poZrIhaFwJotDndvPTGvSsvPElm57/C79xnCT8ysNQ/uVHA+LqF8NGJt1GoKESnUVbw4QDXqqh1fTLTK0p3v7nx357vf6bvrDy9CfRqecunT3yx9ro1Ew2ILTp4bpU/B1mOsqIG4vAmK3BMQSCiRfv5wBcf+pAzBo9ug+v8H1kc+lW8Qf9Low98fU/nRKGtFF0Qgy9FzMEEkUumI6V5S3KoS9zd3e22LsYaBmi0lIqJmIRa2EhIiKypjiBLp9kRqlTM/lWImER8lPMI5HwF9PxpzQ7qrJHeV5C4b7bLRHycb7SrJne/ufPf36btfrSQbqthbQp3kqvlcFosw6vPPiVspACDqSelyBsqqWq9WCJloaqxotXKIxoP+uD85StQwlcP0cP94MkgOB/LgqH/UHw8HR1E7198s/bhxslWfaunb65FFTG8OUMdVBsblSmvT1fEfxFuoiX8hsSyJoTsUcI+3Te04ON4yC7ZWvKWZZ6iQ3EoNaZYyopgG2DnBFjUsAKSYIi4agVClrX8HoOcKWAp6aZLpuWbnJS6At1jEJ5MSrHhHqY2s2UWbJKtAIUeCzFLVbGFYGkyqCdV8wMAV7BTR+QdWp62R8ZMreXFBHL8hjsXZ50QpcvSmcj/YNt89N+HV0KVX8BcGvb7bkQYGgIbAx6ym7tzV57v6fJfjdzn+j5Hjd/X5znd3vvv79N1/oz4P1dCX63MAfHd9DthOTzS11Gsyrv96mc6uEihg826ODyxrcK4rYEr1iSYKInSWZhR166MBrhvOE3Tr4wTdB50+8rkeKhE9dVWRYdGsLHM36nYfoDQo67Ejc93R4fiSsfedxM67Y0hqSxCi0wLe4QhAnLw/D01Gh8VcaLJkH/YYuRc6M0Y2C+HzgPirmOngEGlzYSsEOkazJ2D1war4NkjM0VL85Bi6w1a0wR/4ui6yx/+cF4/oC7xsE99XdwO8AKVrLBILt8tjWJdUf/vdNw5jLXMK9WyDjc3eEdhAvFSyQHPgX2M8+/nD1XMxpaqTvb5yVPAqTW0C/OY9TISj2kk90qdFnGgKW0396bKTlZcm5EWCbK8jPppLpcRN+wjcBeIzi5QWKQ4JtOr2Wa2dVN2pjDJhZylJMjydmi4k1JUr655z1uP2QBtczvlu56OJxStNwUhT9iaYwCJ3e+Imr/mSLb6eSsSfamyxxxYzNvd8jQov2pvEH8JJ4MqEQmaOpfXkzT2+uIWPeincIazrNJAkAh2rr7qSWmtPpmMFX0z4Vun4aD7MNFLq6jLhI5hwyIhZKs5FMrPWqb8IQaZDbnAzreBFTybrnjaN2SPiQa9FUuy3jHWMApHpewPHMN6Y5JgS9Myf2ZwgKXqX/IU1C5//Be1zKn5Z4Zlv3yCPEmRqE/dkmmnDmDaMfQxwgX6fpsiw4Nv+ZCod8GMDOF3qnyNBILQV9zyurVGd0Xd5DaWGBKQyFpeP/I/RMsCFK8EPCLqBQRim+rp5+YffIuCiXLUirHoysC7BTXozixS5JjdPbzOZorT5W+OXOD5ZDlDemWzxo6P0FyLJbyfu/o8i3i7S/BEjTah4aRB5sTyIfbY86Nycm37qiWc6jz6xzFPoO9oe9DIUg5vTQhpnzxT+xVPnD/mj1kZftDyA30aUZ7Ikl+GQkcy04jlDrmRJheUema2ds5vnhaXYgm6SEU0LwCAmOBS8cqwz4ONJeL2zZG/0VSsZDf12FTc7tFcyQ9+qOuIDWj+TQOfU9tFZDjz71Yb+7xJqf88fD7yqLQkV3XxeGexGTl/NhYS9fsPcUu0gaRYGukCjallYriubVXWIIDsmFjrcABVz925y6b9uaFnVN/aCUbkwv4boSYvhS4MlIxcqY7MnuNWe4Fu4YcrxTGU5NZ4I6ajuVGuHt+dXGxiBzDjwhQbfFtNuWOS6BAsk1Ht589nv9Du9mHsR3Kc+Dq1yC3n4PmV5xP5OS7H+ici6UT4s5/j/R9+qhMRKHVE3p4EeSbTyHZrvjG+aDwocDzZYtHwVvljZi0Y6pe99ZtRQA/7hgWZA1C8+0m0EHhow3NwuW0FuoWEofDi/+Rjki+p4dhG+G3kutn7kspWJenZpFsuxRYTLT4qmHaD48RZQfhzF9PgH4f1HfLXg0qVeuPFih5pkv8KPuL4Ke9saO7x/R8O+aBw+iZn7CUoh+Wsd/DuKPuJ//LC5dzz6bobuP0T1PBIwHm9dI24rkcIF5A6wfwFChuLE +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Body

+ +The Workflow object + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/post-workflow-external-trigger.api.mdx b/docs/api/beta/post-workflow-external-trigger.api.mdx new file mode 100644 index 000000000..c2fb6318a --- /dev/null +++ b/docs/api/beta/post-workflow-external-trigger.api.mdx @@ -0,0 +1,83 @@ +--- +id: post-workflow-external-trigger +sidebar_label: Generate External Trigger OAuth Client +hide_title: true +hide_table_of_contents: true +api: eJztW1tz00gW/itd3ocBKvItjh37ZcuEMJWpMLAhKR4CVbSktt0gtzRqKcGbyn/f75yWZMk2JMtQuzOUXxJZ6j73a+vorhUnKpWZjs1Z2Jq0kthm7+L08yyKb0+/ZCo1MrpM9Xyu0tZBK5Nz25pct8oVtvXhoBUqG6Q6IRAAcJIqmSnxeppnCxFEWplMnL04KC+tClKVHQhpQhHIKPJl8FlcXZyLWZyK3CqhDZ4JVaAWmcPdFuJ045YVtzqKhFEqFNlCW+wEjCWzIrJYzJUhxhSBk0GgrMXdz4qfSRAHanRAz/Ebv5rUEHk295c6E7JEKBK5imJJ2GTmkGujM80wAOC2EEobggKbeaqzFYR117qyKj2JTQamSCokQJtMyuWTpTRyrlof7iHLRKZyqcCo5Z0GPyBTHQKkJukmEvs3RX4WinjWIAFLUvVHrlMFnWZprkBRtooIltXLBBcHLfUlieIQt2YysrQgWKilbE3uWtkq4ZXg28x5peQ9k1bQG/lKHkrvaDQIvcHRYeCNVXfgDQ6HRzN/diRnXb91T4ykyiaxscoSwH63S/+aVF8uSis5caYR+59UkAFfQLIyGW2RSRKRlrCl88nSvrttQquNSUrGnGmHFVLbwUyTiA0zZSskQVZmd8mWZWEFV1d4XhpVKHKwJwIydkBqN6TUk0fHQfdQDv3ZcBAG/ePRcDYcHx8HQ9UPRv6odc8GAj94JIEndd9p4up2g6A/kKOZOu51Z6o7lKPAPzz2g97wWKpedxCOuofBSPp+fzycjccDEDQ8VsNxGPpHo2OfaMnT6GFCSh8l6Wx6J7mQNjfwrgZtiyxL7KTTgTKlydoy0W0dkttlKwM3CeJlx1eZ7JRWazvqC/wmU50SQeeRBofIpDPGWUammtzwnFYMdhlhIdnTNAVrnrhQWZ4aaFc7fyInUjYTfhyuBIeYGxnpsP3jjDSEAHR0wo74kApeaqO8eSo1UaiY5AAbBSDe6BA7xDJOlXAgy5DA65o2A0m0e+I5ItlFwd9JwQwJMkUMBKyzR3jPldHYL8otQodrE9lGq0ZK+sPuuD+AW0jZPx70Rkf+eCYPD7vjo/GYsC8RphEMbQ23TFO52kL9KzmiDkQUI27rf0MgcEXInglg5BQyM7W0D+uAYTxC/hSx3NqKzYJeQbEdSU08P3kjBiMRSTPP+b6cbwjBeFdvccfkUSR9ukXhGZw7wK/hUNrsDMImX1LmeHH6cnp1fok7F6f/ujp9iyuCtZWHpwbWGpJZglTYwiK+ZYoLBm6lRTyJIA4VtsWzAuozMCSNrS/U7pddWQgTtjWTeZRhR4F9x446aDFL42XDlQKXCMUT3VbtA+HTPSTtYCF8abGBkjeWP5siZSeZd15I8plYKBmq9GlbTMNQE5OIP/BGAMX+FQAJGYbkug7ALIcrgxidLeI8EyZGtldNXaxF2dTGOpqc15VCzgHKH7aTaZDlFByJzboXVtZSkFjoBzQ7yTWpu6wJjUW6MpkMqGaJohXEmKaQsPDBm86sKMIRqcsi8JhyXRWx6kGSw90rR8yLLOZngcztI/zuTYTw4zFr1YMbVTgfVVhFNGJtlGoqIlJRaPHmYlWlrtLxxUyrKNz77t539777SN/dfHhRlN7FUy59etulz5WhLihOOXlulT4pW49xrRItcn2VU+SBgECKEum3d5dFX4X16Cmo5/iB9ZFL5VvETyt9uPs+lR+Vshq6IAJZjo6DGSKRCidM95piFpQT1eE2tpdx6msYqNlRIiJqpmIV50JCZGluDFEi7YEIY2XNL5lYSMTHqgF1raoyoZfE2mT7SnJfSe6z0T4b/TzZaF9J7n1377t/T9/9ZiVZUcXeUtRJNl8uZbpyllY8J26lwAJRHgKvj3ZZVZvVCgETVY3ValYOLb/f83uzUaAGoRyEw8PxrB8M+/Jo1Bv1/EF/1Krn+uu1H1dO1vSpmr6dHlnEKOJuUMflBsZlszgOm8d/EG+qZhTWyrcHXDdD5hDph6p27I93HHPHsXglzaqskGyjhjRrGVFMw9olrU3LtfQ2RMwRF41AqNKxO+nXSwUo/HIj0kvNzktcAG668qazDKw4RymNrMKiTRDloJAjQRRT1RzDsDSYVDOq+QCBK9g5ovMPrE4LFf2pSl5cEMfnxLE4/RIoRY5eVe5Hu853z0xxUv3WKfgrB72u25EGBoCGwMWsqu7c1+f7+nyf4/c5/ufI8fv6fO+7e9/9e/ruf1GfF9XQ1+tzLHh0fY617a6oaqmXZFz/8zKdXaWggM1bxEGQp3zcXNbgXFfAlMpJJgoiNDEzadWGDO50eL+eMIipmvfcBIjlyR0qFB2NPBhRjTHcuTmG+68OMuwIRW54hMyIFojpm7Oi1WizsFNN9uyCHwN3omf2yHKhAj4m/iZkGhIina7iHOGOwRwI2H5hW3wbJCZoLH6xvLrNtrTFH/i6SqP7P8+LA/QVXnaJ75vYsF6A0g0WiYUP60Grt1SFO+xb41brzEK67u+esemL50qmPMtCLzOe/Pbu8ml93MdS2as0NQvwnjcwEY5t0/pkGaebNM7nCyZ82nh1Qr4keD5MvDdvlRLXZ4UQfkfQv0CUZpFO16Np2PXhSamdUN2oiPJhey1JMjwdmg4k1JGNfU8593GTUBuLa783nnihKSRpyuG0pmCRez5xnZR81SfmvpeIf5TQPAfNY2j26QYVTrTXxRBWAIcmEDKyLK3vRu7geTV41FHhDkHdpMFNHzIdzRdeQam176ajAc8jeE063pt3C43E2twmXBwTFnkxCsWZCBZxbNU/hSDTITe4nufwou8m65aQei769bs1kjyH0tMeykSm7xyOYZwxSZ/SNFcpMQo4EzqX/Miahc9/5MnJjw2e+fY1simtDOPAfjfNhNAjhJ6LAbag3yUrMiz4tptLhdM7AzhZ658jQUFo61HjaQy+w3soNQQglaHYZOJ+TNYBrrgS/IBWV2sQhqnKrl4B4rcoYFHGagirPB/YlOA2vVGMRLkhN0dvdT5FyfOvxi9xPF0fo7w20epHR+mvRJK/Ttz9P0W8faT5GSNNUfeSuTHaokGoG/nzol7bPtazPLqOv3hq3Rgv6mI0MNyScRVTB5REMiOrZq8OFlrxgUCiZEa13wFZVrxkT0TvTu6vrAM0568CUpAs0cLpCPD4yLrELNlhXGFJeqXfNueuhHAFCzSYqi3eoUczAdRC/RkNXeDZp7ho1N5CM29IseJFqWwUXctlboCN/DJfCgmTesAiQm2D3AUutGtGlbKIufSrdpVeTKZGLLS5U0mX9vWMzprRxtYU/wAu6N0WB80QPWmxGPxfM3KhIrZMWtcs2x+CDWvzFipKqENE1EUBpmoYXp1dbkEEMGPBFzrxOJ13ik22Q2sBhNojZz6H7V6763G7gPvUcKGnrQH/tfwEo/p2o/iUpDH4v2mVd+sT9/3XJPw1SZEYqaPpJHQsV5vad/3tdavqb7F+wh+MlFzjstnkom1aUHOMXXd3dJ5DXd893f4jV3RYcP1h3dBxIwxbouuw+ljkqwp7clF8d/JU7PwsZScr5TmkWa2PIFq4/Kzo5ALMoL8HzXy0xPS4B+7wqbZl6/UMdYjVgcCb13QMx5XVrmqjuADziKf/ASi7luU= +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

+ +The OAuth Client object + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/public-identities-config.tag.mdx b/docs/api/beta/public-identities-config.tag.mdx new file mode 100644 index 000000000..ccaa0408f --- /dev/null +++ b/docs/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/docs/api/beta/put-account.api.mdx b/docs/api/beta/put-account.api.mdx new file mode 100644 index 000000000..c89563c2b --- /dev/null +++ b/docs/api/beta/put-account.api.mdx @@ -0,0 +1,98 @@ +--- +id: put-account +sidebar_label: Update Account +hide_title: true +hide_table_of_contents: true +api: eJztW2tv2zgW/SuE9sO0QWwnjvOwP+yu26SDFOlj0wTFIgm2tETbbCVSS0ptPUH++55LUvKzTdspttNCCBBIFHl53zyXJm8jnQvDC6nVaRINorwshnGsS1VE21HBJzYaXEWhxUY321EibGxkTgPQ/dIKVkylZcOXp6zQrMwTXgjGFeN+DPsgiynj7OXlBTPiv6WwRZtdqwsaI1SSa4k+thxlsrCLwwKhgtt3aE4wtiiNspgsNJ4etxkIDTHrO6H8NC/Of//P8PjZ6XPGy2KqjSxmDPPQvNKIhBiMeZrWHLev1d+3tp6/uDgZsH/rEh8V0yqdsbISi9iu2VyQLyiEjY3OmNWliYVleuzYu46ORSohkEieyFRcR6yY5aK9tQWNWhGXxBa0ekvKM4+1KsTHYgh+SdMyUYOK+CDjik9EdHMHtefc8EwUwlg3VJLyc45B25HCB7zJhOjHU5HxaHAb0ZxotYWRahLdbUeVFqJBYUqxashgYlIryIiPPMtTGi/Ge0fjfm+vdyj6vf2D7mh/NDrqdXt8/2Cvf5gcRcRcMOwjncxo6tWZYpIRDoVPPM9TGTt367y1NPPtOs969FbE5H9zQlcRLyDJqCyE88LckNsWEm9Edf4Nb8uCXcAifgZWd2PveQqG2VgbZzE+9/gVDmpF3EaxM1s0LG0B7UN/0uYpnz332n+qp4oda4EPcB4TWt8mrsUOnwX9Vu2+Z8ZlSm8Y20bPf1q8O1drxzqL7u5gtUIWzg5h/HAu6Z37boTNtbJe8u5Od10BQztTsY+ZRBSYwZKFv9gmG90EoeqoVrMzIselgqtVkyCQmC24QRSEzrAZosSu2BVue7Ou92X7os8aJzKp4o1Em5suOPyiD3fj/u7RzlHvsHdwtJfwg51dejro78VdPPf3ow2Ktk5t58KWaRFU3dvZWWfjcSqhRnZiDHypxc5dmoLI0vMWIoONEBqUiqSC68nkqyzwed14dT/WiViP+tUgfyKVaE0MDAUOhWM5xkCyzHuZkPEybUSwYKVe1285KUAT7V32iCeQ18v3OAhDijQ8fgdap8n9DF0qifGsGsJg1ComN0wrDgUfHez0u73xQY/z7lFv93B/1B/zvb2d/n6/T7Nn8DAkTbswNzeGz9am/l0oYWTMUo0lQf4haInh0L1jwE2OIcjhmb3fBo7GF+ifcpHvW4sZ+GW0CGxjnXz0+CXrHbKUq0np2vlkRQmqdfmKsn6ZpnxETZRkIbkn/MLIiVSbWBGqzCjgjk+eDC/PLtByfvKvy5NXeCJaa0v7UMFbE3JLsApfmOoPjuMgwAdumRUp1CGSNtsKVLcgEA/LdOgo/ZudWSgTvjXmCCmMCLNvGLFI2q+wi6EU+xWTPZBt0d5mI2rLeBFP2YhbDIAJqfsWAlnkRessaHKLTQVPhHnYZsMkkSQkT6uFIOMzEGI8SSh0PYFxiVAWDljosmBKFzIWy7aYq3LZGvNscrZoFAoOcH6/nwzjogRzTszFKKy9JbAY7AOeveaWubtYUJpT6Qw5OoYUgEAzqNEYaJhhMWGEvUI6InNZJB5V9asz1mKSdOnumWfmuNDuW8xL+wVx9zJF+mk50eoP70UIPksYy2cjZ43KTCEj4aNL+DQ49KrNVQU+G0uRJk3sNrHbxO4Xxu7qx/OA6sJXB31216HPpQpVFi2ea9DHOO9RuirF/nDwJhhym0EhASI9fX0RajgqCT/mBAy/Iz7yS/k6kK3t4dtHBD9qYy3Zghh0evQSjJGJRDJwfM85doryqtpbn+2JNiMJB1UbICKVC2yG6pNDZaZUDkRzu81QEVj1W8Gm/L0rUcCvz4C+dG75SqFBkg2SbFajZjX6ZVajBkk2sdvE7s8Zu59FkjVXLloCTrJllnEz854WvpO0nKHDfH+xDjlnqlW0QsRYjbGiZeQQjbq7o93xYSx6Ce8lB3v9cTc+6PL9w93D3VGvexgtrvVX8ziug2w5phbs7e3ot5iFeQ8cVyo4ly20Tpa3/6BeI8aU1ij11LgZOodKb+bYsbeOHZ/rArKBMLCj+cT24uX5GdHH1I486c39JkEw26sO3XnhICX5MDQtbdFAxwY6NstPs/z8MstPAx2b2G1i9+eM3a+Cjr37oGPvK6BjjxHEGhPE+pHQMQHuIGg2hlEgQ1xCvYpgYw5R8BR2H0PYF9xMRFEDvSUU2e1vOAahNXvG1awCS3ZpJ1LN1UXpDX0z6muqvujA2QQpUjFkLan9b+8yE4RJ6UBMOO/SZiQQ6JpZazguIJWPmcrf6lmkitMSHLqkkGrae9XwMQl3EmOCf6Dg9kEnSNTfcY8zWOtP7Qezc5L4jCRmJx9jISjm6/3f/U2nBE7BvKF08crb+hPHBfyeOVcoI8TH3KevGoI2UL2B6s1y3yz3v8Zy30D1Jnab2P05Y/croHpAQ5+G6ujwxVAdfds7rMZST8i5/u+I3YVK4MC5N9Oxw+rJHIM7XAFXCgfqKYfQUe1B1KnOdnduZXIX0XlwwoOeldLQYeBpUeR20OncwkKwzF2b57KNxAUjFTOlP9DR4M4IatmQceiAqY8u6uDO5PsJ2k6nRpLb+hzniHsNOynIQavTx5+lTKfNyXQz1B3Mk9mmA+7BhVwzWMxRP/xmXe+2c5k1+SDXpUnv/rwsntAnZNmkvs/Ohv4MnK6ISCLczI/vvyKw7WdfO8Q/X0Bom7+7NtkL6tZljwQ3qAT8yZcHT19fPGQTgpguxEtL6FZIqgno8gRcxKWwYXUKhAa5VcXocjJ1jA+XztlQyLBxCoHZtXolBLs6DUp4jtx+jmTsVEqDhIt/GnXzoLJOIt6LlJa99tKZ9I5MVAca6vClcQ/dEudqAanwmLnW9rVqsWNJmUfSUk19goiutGNXeSUXX5DrW5n4W0Wt5am1HDX7cIULr9qr2J/bjhG3RIKn1mnrmyf39FoL9KhwQgtRXeWBNBH4WD4dFVdW+2Y+lui1iN4yH9fq9VRi/Vwexny6YhbLX5qwUxZPtbbiH4yR61AYXE1KRNE3s/WBJm25iGh1dxZYavkpW7IFNOj4O0NgKO9MfESrsQMj2u+LuJB84yyLmH/jrga9WZLZNV9h0aSeiY7tN/NME7ZowpbPATbwHy44gFnENsng8oB3gMdz+7tMEBhdyHue1sas7sh33BhaGmKw6qjYfOBfBvMEF56Y+0C96z5IwwSm6/NidOEp0KKFaUlZ1TbAqgbX+U011sMVvXl+6x8zaY38q8lLEg/nuyUvVDr73ln6E5nkr5N3f1DGazLNr5hpArylXcfz+a2/k/k1ueW7eD/g0hwqecSC00koUhYj8FEAk+tbi+7Kp8B/fHWJxMF8FFH+bilBrEVCEKOgkHMpJ55K4TYlcsELAqbb5PY6c2ki3HtD6ekITQz6IKdYAGY+kinouW3zambuotmjXnI6erdlOMShES8ockWbvUadqKAeQzUiHR/Gt7c6FIuvoJOX7s7qceWJQIRZViq6Egu2y4xx+Ps97gprxaXPqigZlah0oR0urUdVKYbigERou2rJZPbFmPa7UUoveOU9c8EpbdjshurJiuF661yQc5G6sKF+yzXFfbQRCq2pSHOqUrEkAB2KhRmenV6sUQQxFX5h0WbSCYNsh/qCCNVu3n322rvtnZarZdCea1ugrl4gfukvDs/vVi953+18d7+5Uv2VV6rDOk4FWCenzUIyQOkLQl92X0UVcXQf+AunU1iIvtze0k4SFaJ31Axt0jbF1c28xnS1OTyInlHQj5FwV29PL5rvwXlQzcPK2OFO9UY+q61PNZvvekR4fCcobYLVuxv08rtZjhH/Ifx80rqYOTBUDVz7XYjKbj/C75B9tu/Nwq4FjIS+o3ChO/P7L4Z/QCP9H0TX+MOLzn0kopNrv42q3UxK0Y5sBTo3Ya7wAH2j2/8AUz6EtA== +sidebar_class_name: "put api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Update Account

+ + + + + +Use this API to update an account with a PUT request. +This endpoint submits an account update task and returns the task ID. +A token with ORG_ADMIN authority is required to call this API. +>**NOTE: You can only use this PUT endpoint to update accounts from sources of the "DelimitedFile" type.** + +## Request + +

Path Parameters

Body

required
+ +Async task details. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/put-client-log-configuration.api.mdx b/docs/api/beta/put-client-log-configuration.api.mdx new file mode 100644 index 000000000..6a324e908 --- /dev/null +++ b/docs/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: eJztXG1v27YW/iuE7oe1RWTHjtss/nLh5mXIkLa5ToICNw0wWqJttrKkiVJS3yD//T7nkJIl2+nbhm0thAGrIx0envfzkCZ97+VyZrzhtfdKxnKmQnEYFSZXmfFudrxQmSDTaa6T2Bt6V2kocyUWjjCwhD8ZESUzESTxVM+KTDLxjpekyn4+DTE0LfLDSKs4P0tmh2uUqczkQvGUw+t7L8YfGKFDvNI0bSrzubcuy+mRSKbCyexEFnkiCivjhkRimmRgkqnfC50piJRnhdrxTL6MaDajFyk+7HjqYxolIR5NZWSIIJirhfSG916+TJkyz3Q8Y0rJY4aedPND04eHGzuJMvnLJFzSwKbg281A4omZvlXxmk6YCHrkGEKsZJpGOuAR3feG+N3XJNw2kRgXca4XSmDGGQQX69aPiyiSE9LDWsSpmUzeqyBvWOzaC92wVzoucmXobZLkZ+pWRRQtaUZOzzXeQJqA5yfvr0t2tu4chJClFqdH3s6nLe2YPuxsSLMxz1FpXB2LhSViO28GBwIngxE1k6rpFKqLiQKtwnOj8pwsB6JQTWUR5WYlpIZvZuwmUC9kbh/t9eti9/q7Ox4E0Iti4Q2f47P8aD/3BoPdBw467RyyocRx9U5QZPvsTIR+Pt8W5S70Gkbr7/Z3/V7f7z2/7B0Me3vDvRed3f2D/26xdKVDNRUZeuXkDenGeMViRPSeTEQhutxh8Zy13DuyvIwiojYdcYK/FmRfHdtJSXo5SQpmx5HKw8wOdJra3Cae77wykFki884TOYUvOe76OMZHF+QxfIg5Smq8Pg0ROjpfvk7ubp7M8zw1w243SBaLIsbTjpE6ShM4r4Nn3fx5t0bvjxDWQaRMt5zCr6bw3RS+jv3akG4u/bTb+/nn3u7+0w7XL7YG1a7XJ28aHrocjw6PtwV+TEFy7b05OcFfJ6PL0Rn+PR6P34zx79vR+DX+cdyOjl9e/YJ/LS9kI+Rg5he5jEOZhdaDcCfsa2236c5XMqXYWjl0shQf1LIjLmF6fDBCZqpyUBBJYxQ8hAnYObcyQvQ1aKwTwSARRimmkrewNPssKG1oShY62+T+iP8P7fvvJwAqf6Nm16ZyXDqjo7Oj0XnFtQqLh82aLMNQk8dkdN4ouV8QYk1/l7FBVhq8X/n9L4vF8sWZi8mLVAVooqsXj6CGB6JpNnN+YNIkNtYY/d3dLfWKKUIj7nQ+d2CBIE/bk9ue3Pbktie3PbntyW1P/uaeDKLBtrbr+t5xlsH7vhirvMhiNF5ta6arkGKCFbPQBnGBqNVh52sa7bo/0jUv5HDvIa/sN5fyTWFPdKz8WYbOAwkVixxgoADHWx1S3HKRtCzLss90jYgiS3R64qUMoa/V79ApQ7bMZPABvGwv/rRAV7HGeFEOETrkwv3ItGpfycmL3YP+YPpiIGX/50Fv//nkYCr39nYPnh8c0OwLZQwAjanNLbNMLjem/kXFKtMBojCAR/4Hg2RKGoeNeHLapcnVwnzeB8zjC+x/yV2UaCs1nbwiVx9zlDbx8vBcDPZFJONZwc/lbM0IsX91sYGkuNAS4zeZnul4666OS6mj45PR1dklnoyP/3N1fIFPxGtjT2xE8CSksISoiIV5cudgACtwJw1qbARzqLAjnjmuz6CQjE2dUNu/zBIAc1F2aYxws28ZUWctplmyaKQS583HXDzRHdXZAXDCM3T0YC4m0mAAASyQPxsFgUpz/8xZ8pmYKxmq7GlHjKqCVvaQhVyCkUClo9S1DKYFUlkxnCacECcoyarpi5UpN3BtVWlqTqHkgOSfj5NRkBcQjtWsZ2EVLU5E5x/IbC3XlO6yZjQ26TLOZQAtgIuWMGOWMfCEbjo3wpUjcpdB4YlLuqpi1eskl7tXVpijPOF3gSzMF+TdeYTy47Nq1Ytb5ZLPUOO11Yi9UbrJVSTXlXmwo6rcVSa+mGoVhW3utrnb5u4X5u76y7HbbHBvGfr0NqHPVSwL2Dfj5rkBfTKOnhhLNEdkF13WkTsCBnEQ6de3l0jsDyomel6bqj8TH9lWviH8qPKHfT7hNXfprIYvSEC2o9s7QSVS4ZDlXknMhrKm2tucDevPiUaAxlsgIqpmJpZJwQuZrIhjkkRiJRImysQ/5WIuUR8lMsIYWwFp1jj0LaRvkWSLJNtu1HajH6YbtUiyzd02d7/P3P0kkqyk4mxxOMkUi4XMljbS3HvSVgoQiPJrL1GlHLtqHa0QM1FhLK+JHLxJvzfpTfcDNQjlIHyxdzDtBy/68vl+b783GfT3vXqvv17lcZVkzZyq+dv6kU0MEHcLHFfECC6TJ0nY3P6DeTM1pbLG31qUuBk2h0lvVthxsIkdXyc5dANjYMfske3Fq/GZ3bi27MluSZEFimC2NR3IZc6QkmIYltb8vU0LHVvo2Laftv38GO2nhY5t7ra5+33m7ldBx8HnoOPgK6DjQBDEmhLE+juhYwjcQdBsCqdAh6CAeWOCjSkdCoLlq5NbXH5kNlN5BfQaKLJ/sIkiL5OEznotS7BkGjuR8cpcVN5AuyDarKQFgXQHxlC1NNAtRRWdDQIm5VPpeqE5j0kh8M2W/mhKB9dtzpTxVs2i4yAqICEXhSix553upK4OQoED74POUKj/xD1O560/tB8sxqTxGWksjj8GSlHOV/u/z7edEjiF8BmViwvr60eOC9g9cxljGaE+prZ8VRC0heotVG/bfdvuf4x230L1Nnfb3P0+c/croLpDQ49DdRB8MVQHbWdXVFjqhE+f/tWInVPFSWAPnCcBY/VwhcFhBKPwUOdLnuQKEP/QhvKoyOeUmTqMh5laJLny7WWEob186t3QPcuFQiC626VUgeie6NDruvupvrufarr3OnzoRsnMt+fyPZqXAKbVrcgijCqPHt/D5XD1Q0emuqPdyeE4uePzxxPYeUsJoxOrNl2JQIzOT91qpcNOyjTlgS2azLx5LLg6d/xJznQrlmJhiYWMsGx2BHLGxSQ/hogpFiQ/GabucAxu6Ae9rrLo4Y/rYhk9oss2831yNtALSLqmIqlwswqTC0LvdvaNYFl1JPreoL8x2Rsi64uXSmZ8cp2O0jz59e3lUzEjzMo1ozAEl5WmRQay7hwhwjVxVB4roUHcprKkmM1Z8FHj4A7loJhGUFi8iy+UEte10+dijOrOJqVBigsKjVodfA/pvDX10bWD78iDLizUlY1xT7lnrt/Y6LyLfXGkqZRp6v18i8mqyGtFcZ2WesmaXt8qxL9Kbr7l5jM383RNCmvaa3elKEAhIBYyMmytb57c8vNr/GglhifEdV0GsoSTo3ncKii99s1yNPj5xK8px7v47VyjITeHCVvBhEE/jUJxKoJ5khj1byEodCgNrmcFsuibxbqjSX3OCL+/WxPJt1P62ge8ZPnOkBixDSZ75YfRTWI3Wjglf2PPIud/45shvzV05sfX6MJEGSaB+WaZaUKfJvRtDTBOftvkKLCQ26RD7Ubb4cr/XAmcoLW6Z3ltrerMvstjqDUEEJW5mHRo/xiuClx5fYpfEHVFgzJM6Lw6gEbXqhwv6nQNY5X7CusW3JQXXUvHa3az8lbfjlLT/afpSxqPVtsvb+Jo+WdX6UcqyT+n7v5NFa+tND9ipXF4mbYxx6tfFzle3V5b3eytXcjdch+X773W77Z+6ipq7ZJpdVmtcVPxq+7MPdDvuUwTNptbGNWT9KXDm5vbmYbvKOL/eMu1hpcWWLjZW9yEwuqM0kjmlJVclYK5VrwRkirJdxJ3KDOSBVeSNEuofCl3HXyWgQZlxwBTy4mO6AIibdWXM0tOeAuMKS7pb1O4gyMJUgoLa9URb7E2jQOEFa1L6cgy3r1P3AL1AhY7J4uJozJYARrddUeqK8VCSKTEZyI61CYobOF1lrcqJAxdq1FlFaJUIRU6vELLFubNlPbYsXyvBe5n5kLcGrfBDtOTF90v9awUGauIo4romsuOz/FGtvhzFaV8FxZiYZ1bm+HV6eUGRzCL3bc6STbrukGmS7RgQss7Gz57nV5n1+flDp6nicmxQKwx/6pfNWpE5v3q24av4+J6IC1euint3JFkhV1M2VXstbe+isWwIf8mUm0hi6XRHPoQ+f097fXQyu6BHqNE0EbC9c1q0caLXdibPofV7xs9qtCTsfuRgafiG39raauW5S5mvFxtYHj4+EHRvgcUfLgBld2YYontC/dNiH+5ZBhSDtz4iocWvHaE3ez6JG19C+H8ikJs4n6yaWG3UjJ5R1UQ/x967/CfRz9rZQMcRPz83is3JkFj2ZZwbxvacR/gGJD9H5H2TDU= +sidebar_class_name: "put api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Update managed cluster's log configuration

+ + + + + +Update managed cluster's log configuration + +## Request + +

Path Parameters

Body

required
+ +ClientLogConfiguration for given ManagedCluster + +
    = 5` and `<= 1440`"} schema={{"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}}>
    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). + +
+ +Responds with updated ClientLogConfiguration for given ManagedCluster + +
Schema
    = 5` and `<= 1440`"} schema={{"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}}>
    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). + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/put-entitlement-request-config.api.mdx b/docs/api/beta/put-entitlement-request-config.api.mdx new file mode 100644 index 000000000..3eca983db --- /dev/null +++ b/docs/api/beta/put-entitlement-request-config.api.mdx @@ -0,0 +1,103 @@ +--- +id: put-entitlement-request-config +sidebar_label: Replace Entitlement Request Config +hide_title: true +hide_table_of_contents: true +api: eJztXOtT20gS/1emdB82oZDBxmDMlysnkBRbBDgDmw+Euh1LY3t2pRmdRoL4KP736+4ZvWzzyKNuNylVKoktzfT0u3890vje04lIeSa1Og69Ay/JsyOVySwSsVDZWPwnFyZ7q9VUzrxNL+Mz4x1ce7UhxrvZ9EJhglQmSAVoXM6lYaPzY5aKJOKBMCybCyaqOXCD6LKACLOpThlnJhGBnEoR1od2YFUjgjyV2QJWvveujEiBn0x8zkZ5NkduZKgOalMOYq74THg3D8BZwlMei0ykhmYr+AIcyhDISuQ14UBjWYCaeOz4EG4jvzIVoKAszQVwFMxFzL2Dey9bJEjQZKlUqCHxmcdJhJd6wbC7v73PB/vdne3hNt/uwqd+t9cV8He3u+89IH9OE290uEByywsFKKnK8BZPkkgGZKmtPwzyeb/Kh578IYIM+EhStGsmhaG5AVjBNK35/KQEvt/y6AIXsZfcBJ6mfLGitbM0FMA6iyRYVk9ZMZ+ZTCSGjIx+YHkpXKDDjuIkW7C7uVBM6WqStENQGegDMhOxeSnPIr2kUWvMo/KYHPj08vjy5OgD/P/vs4+nR2O4d3F2NX57VH79MDodvadP789+Oxqfjk7h5vvx2dX5qscf0reJ83SpQnkrwxykAJlnqc4TuM4zK5NJtDJyEgnr9qqppw77jUegGMZTUBVqLYr0nel8Up/UxsYK2xsbB+zsTokUFU7aNUYHkmdgh5oX29l1AZ+aeKHzNBB2jtMCDv9AYVVOOA4p5hYkxt1cx3S1iGwQdSJA5yzmoSO1rEakOWLv0VyKq0Cw96ipTUv8EJe5m8tgjqSq1DBZ0P2NjcLSx+HGBoNbUdiIvhWbPWx61ZR1rqHyKOITnGxDr2nh47CQ2/ESsILcJssNcKZV5Ny47oTI/QovdUbFjuCT/d2ev7/T3fX7e4OpPwzFwB9si5APB9O9nQBTBeReNGYzOY0aEUqj0iLG4yJ/23RSyjvROhJcrUTv8bRuPzBznIMZkb4MwTsgVRNFFuaor+UoJnJTnkeQqqY8MqImIqrzAe8ryaNvYOxWirvH+SLNwxoL5G5NnnmKQ/r+mI7XpM5HhjYG+T0YZi1CEW/zU297G/9rSjimEaFhdzKbP1crISfkSYhxiiK19aGtD219aOtDWx9+xPpQW+LRHPyYwQonXKs0e3MlQV8vJ8C1ea4eBuj0D5sr05ZS4QtmVNnyBYPXBER9ltffCwbD/e7Q53vDqd8f8p4/EcHE70LPNehysbcX7HkPNw+2APfX1dy3kUSvOEpTyE4+G4ssTxVEqWy4OZtAX4YhKhXoUX7PkhuKjEuwXLi2DjWZfSeV8Gcpl8ihIJYDmOi8nLKohnJgSRZ5iMZ1GrkENNHpsjc8ZM7N2FsnDDpsyoM/gdb67Ndk6EpJmM+KKUyGZfles6wYQArb2x72+tO9Pue9/X53sDsZTvkONMa7wyGuDv5poHo8jyLeCyhKkF0jHYBF/gsKSQUH3RMDtPjL0QDReIH+L0EuO7YU0/HLcB9iE9LMm7fnrD9gEVeznK7z2ZISlH91sVJGQHJL+CyVM6megiSHR+9GVyeXcGV89K+rowv4hLRWsMZIEcAAt9RUi+f6jjh2AtwBaDAiAnUAcGIbjuoGCMSVqQ+U9ptZQLaPmcuNMMOtvmZGnTSbpksVP7CbNuyV7IjOJlR/uBbzDAr4hNv6aCs3JtQk80+cJjfYXABESF932CgMJQoJUOjWgqCYL4AQ42GIoWsJTHMIZUFYWucZYMZMBqJpi0qVy0W9yNondaNgcADnz/vJKMgQ1JGY9SgsvcWx6OyDWJjWaXJ3WVMaqXShMh6AFDwCBBHoNAUNswnIJjPDXDoiFASJRxXjyozVKEbIzQfLzGGm6V7Ac/OCuDuPIP34JFp541a44AM30FXNrczkMhLcRLFpshtVmqsI/BKjtbHbxm4buy+J3eWbY7fT4O4S9OmuQp8rxXPQb0rFcwX6pOQ92Gm7QQRvnCE3sWF1EOnXj5cQ2H8Cqobx4nNSdOLfCR/ZUr7C/Ki0h70+KeB8UforWyCDpEcrwRQykQgPiO+KY1KUVdXO6mrvdDqR4KBqDUSErJmyhc6pE09zpajtMZss1MKoXzI257dll0EZEFdVoZ9oaZ9rtEiyRZJtNWqr0c9RjVok2cZuG7s/Zuw+iSRLrihaHE4yeRzzdGE9zd2nhzoMBhRPMeBKEXJkqmW0gsRYibG8JnLwJr3upDsdBKIf8n64tzOc9oK9Ht8ddAfdSb838Oq1/rqK4zLImjFVs7e1I6kYQNwt4LhcgXOZTOuwuf2X4/O3KaY1TD0lbgadd4oNRsKO/VXseKozkA0IA3ZMH9levBqfIH1Ymsij3ujZCsJsqzr7YAghJfowaFqarIWOLXRsy09bfn6a8tNCxzZ229j9MWP3i6Bj/zno2P8C6NhnCLGmCLH+SugYAu5AaDYFo+D7Bjmol17bSkAU+OR2H13YZzydiawEeg0U2RuuoshLrfHFmkUBlkxjJ1JV6sL0BmNjHJsWY2EAZzNIkYpB1pLavqQiY4GYFPyHRTKWFMcoENBNF/5oim932Jgp/K1cRaogyoFDSgqRxr1XDT4mwZ3EFOEfUKB90Bkk6u+4x+ms9U37wWyMEp+gxOzocyAExny5/7u77i2BY2A+xXRxYW39yOsCds+cK2gjxOfEpq8SgrZQvYXqbblvy/3PUe5bqN7Gbhu7P2bsfgFUd2jocagOA14M1WFsZ5uVWOodvWT7/0bsFCqOA3JvpgPC6mGFwQlXgCu5g5CYQ/B44IG3VTuQYbbuZfhQv+I7C/pBcU7StgaW0zyNgMI8yxJzsLV1DwYEwz10eCI70r0ir/RdJ9Dx1gS0tiYh4funNvhwAJ2stAt0SOWpRK+2KZCIWwO4d5k9A4agVw6epIwHI9GyC2hLmCWzySACnIfRZWAxgfbiF0OjO+RRK/KBXFdp9PDtslhCj8iyTn1PrgbjGXC6JCKKcFMdMK2dZFk5ZlrVF3wK0FtZ7AyH9dgbwVNoFOyLMa9+/Xj5ms0QgVIGyA2CXyGxZYAYOgcXoQw3Kl4SwUlUdFKdz+xRoFHjNRyMKDaNQGD2SV0Iwa6LYxankPrHkKtJpThJUHrAWTevCuuE4lZEWBU7lSbR8WSotkBDW7wx7zVVQGoVpIKPMV3tfFI+O5SYmCRWchzjRKTOj10nhVy8JtfXMvGPgppvqflEzbxe4sKq9jqwr3UHENZIgkeGtPXVi1t6fo0e9lVwBaku84CacHw0X54KCqt9NR8Nej7Sa/LxSX2kszDNacxmM2agOkYhO2bBXGsj/skYug6GwfUshyj6arboAI5PEeH3tmss+XZJX/oAFom/EwgMZZ2JT7BYE1bRdtuEQvJ3sizE/O/QSofs94bMdPkaaiqODHVgvppnXNDHBX2bA4zj35YsdCyIbZSB8oB1gLeV/SkTOEZrec/SWpvVifwWzcHSEACrRMUkB/bLQZXg3CdGN3B0OQbSMGLt8nUy+M4cLaxbDWUVuwTLGlzlN9JQLpf0Zvktn3ViCf27yYsSj6rNlDMVLb53ln4kk/x98u5flPHaTPMzZhqHfnFTclz9IsXRs6fTXnDE7LnDXC874Hjz+NHFJ0/ClUf3MJJIo64DqsfvGwdFV/ctcWN9LuBfuEtpiHoI6NCqs9p1QknEMwxYSljBXAra8UgEzxDWbmLQ6JiSDCgAFSrcoe9ZCmMgIxmA23wiI6BHe/LFypxygcXM6LL43eTuDREN0QYdtOiwj3h0PACPwwYU302Ge39o14legNOdo8+yw8KPGeorV+6Ubh4zDtHyjLOH0gS5zcnQ7yhR6EITqi1nFQkKowhF6FArlsbmbIqb6dCn13z6mbXApY3bSQfVoxXd77hUgoxFREGH45odyXO0IZD8uYgSbIGhoAC2FLUVPhxfrlAEYso9vtHpbMtNMls4Fohg52fdZ6fT7Wz71AnB9USbDJr2GvGx/X2c+kns+k677SUbHnlfPU747j+z4yontjxbCe7eIdO5bcFsH3zt1ftgmHJAP6TzRCsMYTsHsXHq/T3u/WBv+ICXYRhuLFzfVG0fZQ8wC34Oy1O4j8r/qojy1w0F0g/2rJWl2K9Ui2qrwoOPfwrc4QBRHm5glN2CIl7sDffMw6d8Vk1ceZiDzbCdYbe1nhx7U9tqOL9CH5u4nwCK7aZJyu/gIv574H2CP/BFJ9bD8VQwXr/3ii1IGGPJFlBwHRJyH0DlMOx/NoXTRQ== +sidebar_class_name: "put api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Replace Entitlement Request Config

+ + + + + +This API replaces the entitlement request config for a specified entitlement. + +## Request + +

Path Parameters

Body

required
    accessRequestConfig object
    approvalSchemes object[]
    + +Ordered list of approval steps for the access request. Empty when no approval is required. + +
  • Array [
  • ]
+ +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. + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/put-identity-attribute.api.mdx b/docs/api/beta/put-identity-attribute.api.mdx new file mode 100644 index 000000000..9fa5378f1 --- /dev/null +++ b/docs/api/beta/put-identity-attribute.api.mdx @@ -0,0 +1,103 @@ +--- +id: put-identity-attribute +sidebar_label: Update Identity Attribute +hide_title: true +hide_table_of_contents: true +api: eJztXFtv2zgW/iuE9qEXRM6labPxy8Jt00UG6bSbC/qQBigt0TZnZEpLSmm9Qf77fueQkiXbadJOsTtTCAVSWSQPz/XjOTTpmygvlJWlzs1xGg2joiqPU2VKXS5GZWn1uCpVtBWVcuqi4WVUt4mm0UVXW1GqXGJ1QVRA43ymnaiKVKJVSCPUF+1KbaZC16NlPXogxFv5O7WhX/NWOCVtMpPjTAmr/l1pC0LlTJb4o8Qnt3Clmn/awlMpTSptimc8iE/zKiv1J1FYEqrUGDUmYhiXi4nMnBpAFqeSyoILyHMTXThlX+WmVF/KUVXOSEadmmHNaQxSE52puOFtmFgFwaKrW8hdSCvnqlTWMTFN0hcSZLYigwZ84v8wZzJTcxkNb6JyUdB7B3JmGt2u604t9fAIUqtkZnQiM0GUiP2gEBirtJXaitQXOS8yoplqV2Ry8StNSdxRT+XKl3m6oJlXByYktimpSRZFhkmIh+3fHDFys85yPv5NJSU4WKqXWr2gq4Jtkqsri8gnbM51p4jaQlU6ZS21ZHvQZOPKaaOciydWK5Nmi2+ZtHbzX/PPgjyEZQQXtb+1WBjneaakWePhbJZ/dkL76Zaejch4VFN5JHIrUjWR8Foe75+G7KktdshcmNxP+CBFo8cDJV36IcfOtwq2Tp0kZFLxtcwqeNtXBOPPpNYm3H/M/C1696vVo8mDJy4J3NiKPO7RJhYYqtIc8GPyUszkNTxAuLyyiWKc0r4BATjR08oSo4MH6YlJcNR1WTsBwJLBQwcxgWO1AXXLs+0KlegJwSJEYf2xjWpXsVXG6kuV1ddsuaARaa1c4KOGwO5+RPg+R/W8d5yTGCLX3ER+Ofk62aDq1rAWVaBdEwlDU2VZrVePLdERuuULhUG3txR1umRezjx7nXfrK+Utt2O5KnLjPLt7OzvrBjvf7LufZb1wpsJVCUzpJuCQdN+jdY/WPVr3aN2j9Y9G6/1NAP0qAw6V4shaGCcWp6qsrAEqB08OqbUYI7cmI2gD2+h08OOAOlWl1NmrPH2Acd4AO+OplZo4VMxygoGk0mudUnU1z60SnmRtQe436FgQmhjsipcyhbxevldBGFKjlQlVasfp/QxdGI3xoh6CqGMnv2NadaDk+MXO4d7+5MW+lHt/3989eD4+nMhnz3YOnx8eMt5hcZDTjkvVft6d+p/KICASkeVYuvR/oBDUa9A9M8CTPzw0mMYDg8P3bcQM/AoqLFGcipev3ov9A5FJM634vZyuKMHEF2dUN8LHPbYGxPOE31k91WYTK8pUcypbXx+9GV2cnOPN6dG/Lo7O8ES01qrzkYG3puSWYBW+UINLEIBSEKcyqEOlA/E0UH0KgaRx7Y7af/LAWi+MGBFm3zCiTVpMbD7vhFLiq3DxWA/UYAuFO97NZZnMxFg6DIAJqfvTEdKiooxPgiafipmSwMAnAzFKU01CImVhpMTSJhe0AyDTlELXE5hUCGUwo8tZXpUE7TpRXVssVdm1xhJLTtpGoeAA5/f7ySgpKzDHYrajsPGWwGKwD3j2mutyd95SGqt0YUqZlJSqIW9KcmuhYWRUpdClEwGO/EI7l6bu1yBWGyIZ7t56Zl6XObclsnIPiLv3GeAnZtGahmsVgs/RBoxHI7ZGbaaASGgsZz5W6l6NuerAF1gJs7SP3T52+9h9YOyuNp6GsjS0cuqzu576XBhZQb+WF8+11McqnxCLuhOnN8GQW1QjhRTplw/nCOzflaH+6ktBW48/MD/yS/ka86PGHv79mNKPxlgdWxCDrEcvwQRIpNIh873kmBXlVfVsfbY3uR1rOKjZkCICNa1Y5JWQlpJ1Y3iX221xqWEe1ZUGF/keAWlWk8ZFrk3ZZ5J9JtmvRv1q9POsRn0m2cduH7t/zdj9aibZcMXREvIkV83n0i68p4V2klYKdBD1FySiCTk21Wq2QsREk2NF3cwhGu/tjncnB4naT+V++uLZ4WQvebEnnx/sHuyO9/cOovZaf7mM4ybIujHVsre3o9+cVPYaeVxl4FyuzPO0u/0H9Vo1IVgj6GnyZugcKr1a5o7767njr3kJ2UAYuaO9Y3vx4vSE6GNqJk9685ulFLSsupXdaz5q0aeOferYLz/98vPTLD996tjHbh+7f83Y/abUcf++1HH/G1LHfUEp1oRSrP9n6pgi76DUbAKjQIakgnoNpY0FRMFT2H0MYV9KO1Vlk+h1ssi9ww0HifJcvJVmUSdLrrMTaZbqInhD3zn1tXVfdJBiCog0Aqilkd2SV+m5opwU/iMyPdccxyQQ6NpFPJqUkMrHTO1vzSzaJFmVhiMLWU57rzl8TMOd1ITSP1DgfdApgPoH7nEGa/2h/WBxShKfkMTi6EuiFMV8s//7fNMpgWMwbwkuzryt7zgu4PfMpUEZob4UHr6aFLRP1ftUvV/u++X+51ju+1S9j90+dv+asfsNqXrIhu5O1dHhwak6+g52RJNLvQknrP+3GTuHSuCA3VvkCefq6TIH57wCrhQuyhGG0GWvYbTd3BdrTqu67Rs6h34b0YFpSg49X5XN0H9WloUbbm/fwFww0+1AFnpQ0zD550GSz7fH0NEG+PEHmsl1qIMYvT8OlcaAFWw1+bAHPCbu1R3OKkcOaucDBl+lXB++X6AIEZ7MFh3/Df7Er8FigWLikQs300g9a/JBrgub3f5xWTyhO2TZpL6vzob+ApyuiEgiXC3vB55R5u1nX7sluFxNaM9/b22yd9RtT7xU0qIs8MdgHv/y4fyJmFK+yfFOVx6mQmkqEBAx7+EijGej+kgIDeIlxubVdMaMjzqHbih+xCSDwOKjOVNKXLavQpwCmVmlNEgxGNCoq8e1dVJ1rTJaAwdLTZLj6dRsQ0PbsjPuCa93XBhog8c5vx18NLF4rQmGNK3b1CeIyHWeuCxquWRLru9l4m81tdhTi5mae7LChVftZeIPcScIYiIhM8fa+u7JPb24RY+qKLwhqqs8kCYCH92jUkltte/mo0MvJnpdPj6aDzONxbQ7THjsEg5rYZaKY5HM8typfwhBrkNhcDmtEEXfzdZnmjTmiIj3dlosxX7KWMdIDZm/EwSG8c4kx7Q0c2aS+00SDslPbFnE/Cd/tbcjM7++xApKPdM8cd/NM00Y04SxxwAX+PcLFDkWYptkYBzwDvBqaX9GgsBoC/c8rY2ozuS3eQwtDQlYZSquGPoPwyXAhSfBDdS76QMYpsy6OTyGzyLQolWqo6x6T2BVg+v8ZjkWxxW9eX6bbzZpwfyzyUsSj5ZbJ+9MtvjRKH0Hkvx5cPf/hHg90vyMSBNyXdqCPF3+hsDR8k5W+HEDuu25ctlz82XM9l3MUFytFE/hPmO4S9e+Yuj71/f+6g713brLJsb5+tlqVf/wy2NXEJjii/W8cmOMZHkZEtT1vUvaXJ8p/EUrgxPXEajSuO7ktK1NCLoqKYwZxpKZVrzrUShZkrxbFEr5nKEHohDeobZlQlP+4QkLG0nUqToDPd6Xr2eWjBA+kyZHps+uCqdEcsQgqmg1EB9QiJoEaqAilM4no+23PFSjZ3DF9+TJ4nXt3cgy5/PK0J1JsF3NhUQM3RMCcImk8kiNmtSoWhc557rNqBq2KLZIhAGXY3bu3k1oQx21esvT75kLju7CbjpU33LSpSCnKuNQpH7dOuU+2giveKaygspgLDPIONth8Pb4fI0iiJnwFU5up9thkNumviBC9aB3n2eD3cFOzPUR3Z3MXYnCvUX8gq+DNx4k2r/K0nHEm+U3CX/2X2AJEUvl1HZB+4AkeuXLO19R06+wrFXUGDlkraBIm0FR1O3mhnaMqMa8pdcAK9qOuLxalo+METAkPacNgNypusen4WdSnvB3Xl//LZaNgtTbnmax3PGI8Pi7oo0Sfzmd0MbvZTF7vil8eRKfLzj7qYeufStEdbYf4ffHvtr3qrVn8f6CHHUcfg9m7ndfrPyMl/R3GH3EP3zICx8m6MTvb6J6LxN9PNk6y9yUZIUHWAHd/gtxBGU4 +sidebar_class_name: "put api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 Identity Attribute' (put-identity-attribute)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Update Identity Attribute

+ + + + + +This updates an existing identity attribute. Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false. + +## Request + +

Path Parameters

Body

required
    sources object[]
    + +List of sources for an attribute, this specifies how the value of the rule is derived + +
  • Array [
  • ]
+ +The identity attribute was updated successfully + +
Schema
    sources object[]
    + +List of sources for an attribute, this specifies how the value of the rule is derived + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/put-mail-from-attributes.api.mdx b/docs/api/beta/put-mail-from-attributes.api.mdx new file mode 100644 index 000000000..41d87b36b --- /dev/null +++ b/docs/api/beta/put-mail-from-attributes.api.mdx @@ -0,0 +1,83 @@ +--- +id: put-mail-from-attributes +sidebar_label: Change MAIL FROM domain +hide_title: true +hide_table_of_contents: true +api: eJztW/tv2zgS/lcI3Q+7LSI7SdPmEuBw5+axyKJpc3GCLpAGKC3RtnZlUUtSSb1B7m+/b4aULD/SZrvdV2G0aG2KHM57vqGpu8iqpDKZm0b7V3fRpVXmQBdOfXC9yo0xFtlyv9AuG2aJdJku4onM8nho9CSWzplsUDll929BQUXX99cbkS6V4ZknabQflZU7xYJjzO8106ONyMmRJeqvW6RthOWpsonJSvqO5QdjWYyUcGMlTnsnr8Tx+ZtTkWrwUAg9FLIQvbd90T/qC0V8iSxVhYMweJKK0ugbDPjVP/DQxQ8XwqhEm9QKp8VAiTKXiUoF6NG0ROa5Mt9Ycfi6Dy6N+rlS1r3UKdRzx18zoyCXM5XaiBLSVOHokSzLPIjR/dES73eRTcbgij65aakgjR78qBIHuuAMWnIZVIGnNdOtmRaqKkaYqT7ISZnT0Es96E8yN/6PhaClzgrXSfQkWtTYBaRotKBNrSyZpkZZG91vRJNgj0N+8vFNw6fOp/cs1O1KE7kWPx1xWllHWpfCVoMHJkX394sbzAjPfE4MIZ2sd+o268m5MsfcL3veodOkgkbAtvIf1vCixh5Qy/09cQ41l/Blb9rtzU367yFpZoyJ2rfILW+UyYZT75AcANEf7GsDPejYRzrbfOD9Wgcbav0Y55ITxfFem9uNpaPoX4j6CmoXEn9FAkfTkyWPZPY+nHMG+DhjW5tiqFQ6kMlPsZ24slPZWEnr4q2OnMhf2MIr+UWm8RnGM5m1TAvGPV91iiFjI+PoW7Z1LZsmAiq7UWKgqyJRnLmwFVIVlCTa2dj6TbwaQr4zVliFFVNdkbjug3uMvDf/suVwCywmeZWq/TkZxf/A5LJhmlz6GEkp0A2YI/GIUeUX9XgfzuBYL1FztMl+8WHAUnjRqN6QQKZtxzk36zvpKrtSxqKaUKk5O3p9ePL6O4z0Lw8OjvqU4I/hH0eHVHdmmpjNW3ZElEoDXxOWd6tT18zLOHKDbX7PPBZyzc6q9HKQZ8TikTEgHItz5SpTkE08s6GmwbfSKek8K25knqWdL5djUuXA8IFO1SpzzDN7nBUqHhmIDg4Vs5xgYfBlrBATbRAaTLLWN8/rzLkvNNHZEi9lCnm9fAdBGAoBgygGrZOVMTDP0GWRYb2ol8AcbKAHtlW7Sg5ebO5t7wxf7Ei5/c+drd3ng72hfPZsc+/53h77KequHKm2b0pj5HRp6+9UAfdJRK4BQzgIDDIOooMY4M2xBDhrYj9tA6bxCP2TU/u5jZiBX0EgcAOe+fLgTOzsihyFqOJxOVpQQhFfUjAVVZ7LAQ0RPILknvAbk40eKAMhMg+PjnuXry4wcn7038ujPj4RrSU02CvgrSm5JViFL4xD4gwC3ErKfDnUodKOeBqoPoVAkhNlMzHz3+zUQpnwraGscocVYfcVK9qkfTJqh1LiEbP4NuuozgbwDcYm0iVjMZAWC7QHl097SaJKF78KmnwqxkoiJT7piF6aZiSkzAWiEUSxfspAKU1n6HRYIZTBDAqzrnwhSNS8LWaqnLfGLJm8ahuFggOcf9pPeomrwByL2Y7CxlsCi8E+4Nlrbp67i5bSWKXTwskEUqC+TKFGJNcEmQmyZc6KkI7IXBaJp6jnNRmLUmAtFqe7U88Mozw8S2RlHxF3Z1RXYxateXCjQvDZumBRJyFnZgoZCQ9JbF4cZjXmqgNfDDOVp+vYXcfuOnYfGbuLD89DUxWeMvTZWoY+l0ULQS5BH8PeU+gGZjK8CYbcoGY5QKTv314gsH9SBc1XH0qCtF8QH/lSvsR8r7GHHx8Q/GiMNWcLYpD16CUYIhOpdJ/5nnHMivKqera827E2gwwOWqyAiMiahtC2kFCZqYqCOJF2AyBV2eIbJ8YS+VEiIqz1GZB2LdLYd3FrJLlGkutqtK5GX001WiPJdeyuY/fvGbsfRZINVxwtASfZajKRZuo9LTz3h8+YIOrjfdGEHJtqEa0QMdFgrGgeOUSD7a3B1nA3UTup3ElfPNsbbicvtuXz3a3drcHO9m7UrvVXszhugmw+plr29nZkFQPE3QDHVQUdCTut0/njP6jXqCGfmLsZJIbtAODurxvsuL23jB0vtBanspjWCMnOYchipiPKaZg7obmmnku/RokR8mIhkKoy8EWulE0UqBg4jcizScbBS1KArpnGvaGDKD5Qaidrdgln1pYzQa4JNWs4Vka/NA0J84ECI9gRsvMXRKfBRL8JyYtzkvgVSSyOPiRKUaA3yP35qvPdEzBvKEf0vYEfOOj13Y4s4ABoCHzOanDnGp+v8fm6xq9r/NdR49f4fB2769j9e8bur8DnAQ09jM8x4dH4HHM7m6LBUsfkXH84TOdQCRywewud8BWDdIbBGVfAlcJtOsohkm7mRd1VN/Hw2ON+z1FlcswcO1fa/W73DoaCge47ssw69T2DQt/SHY/uANpZkXjohoAPMpogemcnobHosGpNRt7rUx0T94pmYchP66s9H6VcX+/hCx6ezIaApwdP4mG6/4I24hvLszvsOUvyQa5Lk9//dlk8oQdkWaW+j+6G+QKcLohIIlxvNPcv+4S5/e5LtzBndYT6tO2lzd7QtG3xUknDN2zop4tvv3978USMCGlypFeWQK7KqDVArJzBRTiT9epjfFrExcXoajRmxntzP5RQ5IhhDoHFu6KvlLg6CUp4jRR/jpzMKqVFitMArbr+trZOqm5UTtVv/sJXN0uLLjTUlXPrnnCl45YgK/BxwqOdd0UsDjNKQHz7ieYEEbnDE1dlLZdsyfW5TPyjphZ7ajFTs08WuPCqvUr8xZsE4UskZG5ZW5+9uacXt+hR/4QRorrIA2ki8DH/81ZSW+2z+ZijFxO9eT7eFW/HGcro/DLhs5awqIJ5Kk5EMtbaqn8LQa5DYXA1qhBFn83WLW0ac0TE25stlmK/ZZzFAIXM3ysERuGdSQ6oKDMm0YBr/p6cEe/Zsoj593zb7v2czDx8RTfY+AJaYj+bZ9owpg1jnwNs4N+XJnIsxDbJwHnAO8DBzP6cCQKjrbznaa3M6ky+y2uoNCRglanYct9/2Z8luPBJ8AOa3cyh63/A1M0PfvguAi2qT3PKqk8DFjW4zG+uURYX9Ob5bU6jqFT+1eQliXuzQ5M3RT790ln6gUzy18m7f1LGW2earzHTBJRLh4/nsxcujn6fO/rozeHWLF5oO9rB9DLgwuXDQsvvkeBfPOWcwMAdbRE3eoyW2oTKXDqKHs4eyThTfMxQKukIY26QB4NRivjSaEozaCaZ0MhgDtKDBfaVgyzn1yYuZjtLDkwPYMl/6LutuNehvfz7Ah3xFp1fkcD81PXRVQ48+1GH9q8PlZyRSsRh7VQAd5NJVdAlerBdTYSE637C89LMJpVPkGgCC1XrQjPEbFbV2YJcmkTocP9jJvbNkE6w0Ry3HOwTe8G/bDi+hurJitQNUGvVCHKu8vA20cZCe/Ap2vDqeKzykpwE2R1AT7V2OD25WKIIYoWFXOjvtRl1wyLbpbkgQm2Yd59nna3OZsxtCcZLbR065Rbx8J7T0usKC254Nzu4/7NfjQqljnqULr+YQIJVvmfyDepVtLJBRcszhvz0/O6OTl6oY7unYYQ+tfVX17NmjL6Brj+B4Y72J0VpIBz5xxdTrtyhxV/+LYN6RL/Cn+p8dO51q9M+uyRrD8KLXxN/ZmDkLQbp3/3oHf5E9Lab9zV6O4zG76L6BA5zPNkaIa0CCOEDSXl//38Yv3or +sidebar_class_name: "put api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/put-native-change-detection-config.api.mdx b/docs/api/beta/put-native-change-detection-config.api.mdx new file mode 100644 index 000000000..0c792d4b9 --- /dev/null +++ b/docs/api/beta/put-native-change-detection-config.api.mdx @@ -0,0 +1,97 @@ +--- +id: put-native-change-detection-config +sidebar_label: Update Native Change Detection Configuration +hide_title: true +hide_table_of_contents: true +api: eJztXFtz2zYW/isY7kOTjCXZshzHftlRbKfjjmN7fZk8OJ4WIiEJLQWwAOlE9fi/73cAkKIuvqa7bTNMZjwSCByc+42AbiOdCcNzqdVhEu1GWZEf49uN2BtzNRL7IhcxPdzTaihH0VqU85GNdq+ic12YWNjoei2yIi6MzKcYvo0urTCYnIuveb/IxzRVJmrX+um7RZbwXETXd1iXCBsbmRF47HwmspRjCsvHgimHA4sdEiwpsWCxQ6PwCLOhNm62B85sJmI5lCJhg6kbHwGGYof77IvMx25kfn1m9I1MMF8q99SI3wthczbQybT9WTH8+6z6LNe/AYyDcXL248/9/Y+Hx4yDOE1UM2ndQmkAKNcs5mkKaBjtnx62wbGMGz4BBcY6BkkiNuNgzVqk8ADfZILPJYxoNzeFAFfjsZjwaPc2yqcZzbK5kWoU3S0y7mLGAQdIfOWTLKUV3Xhn4936u82tZGNng797u76xlXTf9ba2Bj3e3ezuRCSFQPR70EybLaIRkyxVTo94lqUydqzr/Gpp79tlLPXgV8gqWkTSq8sC/6WCBCczWXrNY171WKV74CbPPZt5wrhKWGG9kHkc60LljI9GRowqoUKLrOO8IeXOJdQUCArFBykRdruAW58NUz4CNomjTuHj8F5cgEYA5FDmgfW0XeDAQOtUcFWXhGdlIoa8SMHKIU+tgBwr07M1BnJj+HSJfyflVEbTrNv7y1jG45cgKnMxscuaBYRVMSGL7e/tnVweX/x8ebrfvzjYx5NyZO/sYGFk/+DogEau72oEPwSivgC2cqBymadiAiWzT5GNUwayMVFbyGBkuYwl7EqQNd/DlIel5MSyQkzY7FirGp79HAwbFLl4HsJKq1YN6Zn2VuD+p2RYkWK5SB5m+OGQLQglEGSZHg69Y4OPTROWSpvbeSk4Up9NQ6nx96jlvF5NxGQgzMkQ88uP52MOh/WRy3Sgvzq1Kkl9utg82ffNf5gFT5DrMxmD4CmM4um+jlfgeiS4UWyijWB8oIuVG46FcaZemBQrxnme2d1OJ9FxQSg6T9K24FimpcrbsZ50LOe2MxZp1gngbMc79/Y4n6QkhZeIK+UWCQWiHLzxWCtxXJDM8M3HiQtaSvIyNzIWpwBA/Endius72pO4CuAPJSV3dzTTCJvBk3rhdtfXl/l26XKP5BnJRek0oyYONnGwiYNNHGziYBMH/+ZxsLcq9O2lkiRyYAxcYIudibwwigrf4VLhS+KV6oanMml/S9ybDzqIsuDynk7EKn87j+wHqURrZLgkDIVDOcbCUK6TK3Ey9yChio4EN689V/6CE+0N9h6x8izQtxeIIYYaHv8GWIfJ4whdKon1rFyCMrtqPazYVmwLPni7vtPtDd/2OEfBvbG9NdgZ8s3N9Z2tnR3afYLIzEfi8Xj3o1DCyJilOoZE/gBDEPxtyBPc5is08B4ZOBhP4D81FPzcisyAL6O2zhpi6Pu9U9bbZinUsHDjfLTABNW6PKcOR5GmFHx97AflHvCJkSOpHgq9+wcf+pdHFxg5O/jP5cE5PhGspbZRX5UxBqhCF8b6i8M4EPCFW1Z6wTZ7E6C+AUFc2fpE6b/ZqQUzWQgaWBF2X7GiDpoNjZ7MmVLse2DslWyL9hob0BhSPCQqA05Zm/Ytpzf9OBZZ3joKnHwDj8UTYV63WT9JJBHJUwZrBFCsnwIQ40mtZzUsYMrCdafIBSoN1yrmZTFj5bw0Zl7lqC4UMg5g/rie9OO8AHKOzLoVVtoSUAzyAc6ec/PYXdSY5lg6hV+GW6M+2hRsNAYcZvDmTCLGBHdE4rJwPKqcV3msurN07u6jR2Y/1+5ZzAv7BLs7TeF+Wo606sGNCMZnqc8XmockjVJMwSPhIZHtFi+2GEvD94Gzsd3GdhvbfaLtLj48CwV/eOpSn40VVb8KrXoKnkupj3Hao3TZz//DF5dekGsMDAkp0k+fLsKLACoov2bUI/8T8yMfyldUUaU8/PjAF1KiCv0zWRCCjo+hjwBPJJJdh/cMY8coz6rN5d0+aDOQUFC1IkWE1zRsqguGGoOZQinChNs1lmhh1Q85G3P4R6TMwNd7QFd4Jy2fWTeZZJNJNtGoiUbfTTRqMsnGdhvb/Wfa7oOZZIWVs5aQJ9liMuFm6jUtPCdqOcMEVr56YpXJOVEtZisEjFU5VjSfOUSD7sZgY7gdi17Ce8nbzZ1hN37b5VvbG9sbg153O6rH+quZHVdGNm9TNXl7OfpzIsLcII8rFJTL5lon8+0/sNeIIbk1cj1V3gyeg6XXs9yxt5w7HusctAEwckdzT3vx8uyI4GNrB5745l+HkdE61vkGMaWUpMPgtLR5kzo2qWMTfprw892EnyZ1bGy3sd1/pu0+K3XsPZY69p6ROvYYpVhDSrH+ytQxQd5BqdkQQgENcQH2KkobM5BSvlKvzD7nZiTyKtGbyyK7O8tZ5IXW7CNX0zJZsnOdSDVjF7k3zJ3QXFPOxQQeDn3Da0lkt6RVciIoJ6XTBqmcSGfHRBDgmmmrP8xBlbeZ2TnwsItUcVokdIwATiHV1HvV0DEJdRJDSv8AwfVBR3DUf2KPM0jrm/rB7IwoPiKK2cHXWAiy+ar/u7XqlMCh8sct2LmX9T3HBXzPnCuUEeJr5t1XlYI2qXqTqjfhvgn330e4b1L1xnYb2/1n2u4zUvWQDd2fqmPCk1N1zG2vsyqX+uBOH/+/M3ZnKgEDp95Mxy5XT2Y5uMsroErh3if5ELqWuBt1wm3Nzq3/cJjcdfyliZa/NNGqLk204vJiqK8PPLrzp21vIUVI767NM9mGc6MjwlOlv7jjtgOwboVXokOo3gJpAl2lDAVI2/HdSFJt7wcdcC+FcNI7qk70PgiZbl+SeKcgknkwa3StIKiZGwaKGWqMH6yb3XZqtUQf6Lo06d230+IB3UPLKvY9uBvmM2C6QCKRULu0e04Jud996eruLMjQq4Du0mYnNK3L3gtuUC340zGvfvp08ZqNKA11bqCwlAELSXUDDOkUKuLcXL88KUKLXOQxuhj5W7r9ubM4ZFZsmIJg9lmdC8GuDgMTjuH/z+CwHUtpkXA+glZdv6rOeosbkVJoXDjnLRPVAYc6fG7daxcGXb1Qu5XT/qxabF8ar/P+1kkg0ZV/7Cor6eI1ul6KxL9KaC0PreWg2dcLWHjWXsX+bHcM2yYQPLWOWy/e3MNr1eBRcYURgrqIA3Ei4DF/gioupfZiPObgtQjePB6f1Sd38Wd+GfMujVmEyDRhhywea23Fvxkj1SEzuBoVsKIXo+VuG7WcRbS66zWUWn7LlmwhY3T4LV1QcAmL9r0TZ5K/OMnC5n9x97l+maPZDV8hsNLMRMf2xTjThi3asOV9gA34+7hFigXbJhqcH/AKsDeTv/MEAdGa3/OwVnp1B77j1lBoiIGqg2KzXf9ld+bgwifmHtDsag7cMCXc1ZkyujwUYFHwmmNW2SpY5OAyvqlGzFzgm8e3euFJcfTvRi9R3J91VE5UOv2zvfQ9nuTv43f/Io/XeJrv0dOEFJg6k2ez38A4KIuV2kVZX0DVb6k+6V7nimud4U7igzcpw5zV1xSfcvHvKff+vvFG2lpEVuqkFUqsum94H9Lc5cYode7HAn/x1Lk4V6SgBJz9REsdUJbynJyBc4bxWArXUskEz0kya2SQeuIcWLjtjMLZARoZzIG3s0jl+UCmgOea/uXO3PkZn4+TOdB3W4QjKDpcDW+zT6hyVQxtpgqXDj/j2a86lLrn4Pcp2QPbL20EuepkUij6VRigXUwYhyU+YkiJtHHh/T1qKSVKXmiXMVerSudHFkokuHujwkwsxO9lVLOXR/aCudjQqgfrSYrhh2hmhJyJNOj60t3JR2DDSFt0fZJqbAQr5K2itsPHw4sliACmwvshbUadsMh2aC6AUFXp1WezvdFeb7kqC+OZtvmEqxpwf8H/3pvge/VL94u6eTt7c/H9/hRRSBSowutk1LEkPha+4vS1/1UUan/M3i2rf+omPVz+w+eMIQ5af3tLTS+qh+9oGGRQR+XqelbquhYB1CV41+qe9j3SeHUWSHrtXtvVf+poJT1ln1ZNZy2aCB9/E9TZwbo78l++9eZQ8Q/Cu55WcHzlwqWXWFT/+xW+nffg3Otai+X0klR/EH5naeKbRYZ/wSD93Y0+4z/53ywEmVs/fhuVrVfM8WDL7HdV8hc+gOOY9l9cJJ70 +sidebar_class_name: "put api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 Native Change Detection Configuration' (put-native-change-detection-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Update Native Change Detection Configuration

+ + + + + +Replaces the native change detection configuration for the source specified by the given ID with the configuration provided in the request body. + +A token with ORG_ADMIN authority is required to call this API. + +## Request + +

Path Parameters

Body

required
+ +Updated native change detection configuration for a source + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/put-notification-preference.api.mdx b/docs/api/beta/put-notification-preference.api.mdx new file mode 100644 index 000000000..ddb8d456e --- /dev/null +++ b/docs/api/beta/put-notification-preference.api.mdx @@ -0,0 +1,95 @@ +--- +id: put-notification-preference +sidebar_label: Overwrite preferences notification key. +hide_title: true +hide_table_of_contents: true +api: eJztXN1u2zgWfhVCezFtETlO4jYb3yzcNN3NbNJm84MCmwYtLdE2pxKpJaWm3iDvvt8hKdmKnaTtDHZmCqGAa1Hk4fnnd2gyN5EuhOGl1OowjYZRUZVvdCknMnFtJ0ZMhBEqEdFGVPKpjYaX0XIHG11tRKmwiZEFPYPEKMv0tWU8zaWyrNRMFyWTyn0zTFcl0xOWCFNyNKplWmyCDuVMSHQz0x47nwmWigmvspLZkpeCSUvURAp6Pfbxk5h/DE0YzjM2BnE5YbKk1sLozzJFX65Slmph1U8ly3mZzGgOhsGOK3y9OD3coC+KcTbo99m1zEBLoMnoa9WD6FYklZHlHOLfRBdWmH2tSvGlHFXljFQiUzVcFiUuGsXZYWIEeI+ubqGqghuei1IY60hJUljBQWQjUniBJ/CFByP+U0kjYJLSVGIjEl94XmT0Psl0lX7Iuap49uFam08fZCnyD7bKc25oqE1mIufR8CYq5wWNsKWRahrd3jUUqXeZaVJJLyIuaXZhy5c6nROdu8wkJLwq6RUviiwM3/zFEtmbVQb0+BeRlNHd+Y95ATdR7DAFMSj3JzyV4BVW9OaBx3CWSes8xmsUXLR5zkUqq9ySkWBw+HIphaW5SY8rOlinAmivyMi5VnXxDXqHdgMrS7NyY/h8ZdKjr5Jog8me6Dm/rJvYE8QHvGem06cuVq5nEt7cjiFuBBOKjzOR9tixNovROZ+TV/M0dQHkKE+qsjKCJCVp7DqNCVXl5OMHx6PDIzyfHZ/h8+Qfb98c0NPRaP+f+P/8YIR2+A4s6fR17GYlvTQ6rGlckbJ0CqbJpx6z0XHoyVIyUqO3kJSgBsQ0utHbuJS5aFltu7/dj/vP463n51uD4c7usP+it9ff+3d0e7tgdZHl7KtS4xW9NMIW0Kd3pu1+n/5bdZ6lOGfX+MJsleC7nVRZNmdGwLMSkW64HARXF8lMkwikeiWuW8PJcBaRwMY8+US+n/AsE4Zs0wVcF3A/fMAN1sXYfiYpJA6MgfZjdiqgPUXa9DEUFio2xkpFa75Un3km018VM22vTgVwSravU/G44l5LJeKpAa4Bh8KxnGBgQCIYwXJyD0+yTgOuX9vzoYneFnvJU8jr5dsPwpAODdIDaB1+hSUvlMR4Vg9hMq0h1rppxa7g4xf9ve3B5MWA8+2/DrZ2n4/3Jnxnp7/3fG/Ph5y1fCoej7m/CyWMTFimkcbkf6EQoCDo3jHgJl8TAvfYwNH4Cv1TcvF9GzEDv4zAGrIwe7l/wga7LONqWrl2Pr2jBBVfULgpJHCKaY95ILkn/NbIqVQPRe2rg9eji6NztJwe/Ovi4AzfiNYqTFbw1pTcklDxhM30teM4CHDNLVaDDOqgtPIsUH0GgTih6kVH6Z/s3EKZNVzGiDD7mhHLpNnE6LwVSolHtuyJz4ZjavOoecwtBmifx56NsM4VZXwUNPmMzQRPhXnaY6M0lQGQIxpB9IFECKyN7ArYTjk1EW1bLFTZtsYikRwtG4WCA5w/7iejpMSa4nyiFYWNtwQWg33As9dcm7vzJaU5lc5VyRNIwWnpTzQWmqT0JUlpWUhHZC6LxKPqfk3GWs6PLt0de2Z8gkQ+45X9irg7yZB+Yida8+KzCMHnyrFQF5E1ajOFjISX5czHyqJ6CrqoA59hZcjSLna72O1i9ytj9+7L01BZLEOfrVXoc6F4Bf0at3iuQB/jvEcBsIdOHst6Q27QTkuASD+/O0dgfxKK+osvBRXyvyE+8kv5CvOjxh6+fUzwozFWyxbEoNOjl2CCTCTSoeN7wbFTlFfVzupsr7UZSzioWgMRkTUNm+vK4XRTKUWccKD9ektoxpEfuavafAakWVUaF1qqskOSHZLsVqNuNfpxVqMOSXax28XunzN2H0SSDVcuWgJOqndLnaeF9yQt/dC1w+o9btaEnDPVXbRCxFiDsaI2cojG21vjrcluIgYpH6QvdvYm28mLbf58d2t3azzY3o2W1/rLRRw3QdaOqSV7ezs6FQPEfQaOqxScy5Zap+3tP6jXiAmlNbeHXeNm6Jx+0Fpgx8EqdnyjS8gGwsCO5p7txYvTI+a2LD150puuTCLcD5pOdejOSwcpyYehaWnLDjp20LFbfrrl54dZfjro2MVuF7t/ztj9Jug4eAw6Dr4BOg4YQawJQazfEzqm0v3sj9RBRzFYUkG9imBjAVHwLew+hrAvuZmKsgF6LRS5vbfmLIjW7JireQ2WbGsnUi3URekNfXPqa+q+kk6eTZEiFUPWkkC35FUyF4RJ6Uf4TObSxTEJBLpmHo8mJaTyMVP7WzOLVElWgUOXFDJNe68aPibhTmJC8A8U3D7oFIn6N9zjDNb6VfvB7JQkPiKJ2cGXRAiK+Wb/9/m6UwKHYN5Qujjztr7nuIDfM+cKZYT4Uvj01UDQDqp3UL1b7rvl/sdY7juo3sVuF7t/ztj9Bqge0ND9UB0dvhqqo2+vzxos9Zqc6/+O2F2oBA78zQ+dOKyeLjC4wxV0KDdyF1Yoh9AVimG0ed8djM2bT2J+G9FFDgKInrfKZBgzK8vCDjc3b2AymOq2xwvZk+GEtNLXvUTnm2PoaU0KohOnPtyoAxudHIZqo+eUbCT5sU96jrhXuROLPBaqd4cMHqRM10LIlnMUIsyT2WDw+eBTrhksFigofrKud8/50Ip8kOvCZLe/XhZP6B5Z1qnvwdnQn4HTOyKSCFeLezdnhL797Cu3bxYrCu37b69M9pa6bbOXghuUBv4ozJOf350/ZVPCnC7mK0twV0gqEhA1J3ARl9NG9bEQGuSWGaOrqb9ANGodvKEYYpMMArP36kwIdlmfsn+DZH+K7OxUSoOESwg06upJbZ1UfBYZrYO9hSbJ8WSqNqGhTd4a5w+ju+JAKn8gG6299ypmrySlouY2VRDR1Xrssqjl4ktyfS8Tf6mpxZ5a7KjZp3e48Kq9TPxB7gSBTCR4Zp22vntyTy9eokeVFFqI6l0eSBOBj/ZxqaS22nfz0aIXE702H+/VO3dnoD0sXCpgFuthlrJDlsy0tuJvjJHrUBhcTitE0Xez5S4qxC4i4u3+EkuxnzKWMeCh4+8IgaG8M/ExLc8OnWi/UeJC8qOzLGL+o7vH8rEls2u+xCpKPVOd2O/mmSaMacLY5wAb+PeLFDkWYptkcHnAO8D+wv4uEwRGl/Kep7U2qzvym24MLQ0JWHVUbDH0D8NFgmvuIdIL6t30QRomdN0cIMMzC7RopWopq94XuKvBVX4zjQXyjt48v82vm7Ro/tHkJYlHi+2Ttyqb/9ZZ+p5M8sfJu79TxusyzY+YaQLepW3I08Wt3IO6MgnX7h6/FdzclWvuhC1fCXvg2hYqd7i6EzkUJcsB9jJgxdWtRNrrngl84q3LEw7Wo2hyZaBDUMuE6EYgRZTLKMlMCrcJUQheEu7cIK/WucsChdGUeujCJRGautvVBuriKBtlBnpum7yembtg9aDW3cJ0lzTDoQ2NcEBRK3rsHV3iS+ASVBPScWG8+0WH4vAMXnFCTsVe1Y4GwJfnlcJslBOqnHG48yPemEqbVD5pokRUotaFdrCzGVVnEHJzEqHnqiOT27cT2t9G6bzkdI/MBZ+zYXMbqicrhmvmC0FORRau8m/cKRkeow1Pj2ciK8hJkPEB/sTSDMeH5ysUQUyFX1S0mW6GQXaT+oIIlWbefXZ6W71+7EoVtBfalvDtJeJv0fUalUH7Bu66C6Utt7xZbPP/kH+nIKyxVBxtFrSzR9qrfLHma+TL6L4aGcOHlEyQGGbQN3W9uaF9IKoab6kZ6Yc2GS6vFgWhK6ThD+76azScIDuKB3T+5DT8KYGnTmnr7LVWhHoLU80XuxcRvvrkR5+3dMfVb0s5nvyb8DtIfD53IKYeufIDD5XLfoTf6nqw79XS9sPJBTn5OPyhhNxvpBh+jUb6HEbv8Q8P3vQu57v2m6jelkQfT7YGi+uwUvgC1aPb/wBtMaDn +sidebar_class_name: "put api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 preferences notification key.' (put-notification-preference)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Overwrite preferences notification key.

+ + + + + +Allows admins to opt in to or out of certain notifications for their org. The default state is opted in. `key` is optional but if it is provided and doesn't match the key in the URI, then a 400 will be thrown. + +## Request + +

Path Parameters

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/put-password-dictionary.api.mdx b/docs/api/beta/put-password-dictionary.api.mdx new file mode 100644 index 000000000..32d3bc0f3 --- /dev/null +++ b/docs/api/beta/put-password-dictionary.api.mdx @@ -0,0 +1,132 @@ +--- +id: put-password-dictionary +sidebar_label: Update Password Dictionary +hide_title: true +hide_table_of_contents: true +api: eJztW21v27YW/iuE96EvsJzEdZsmFxcXbtoOGdo1Ny/ohzhYaYm2uUmUSkpNvCD//T7nkJLt2GnabrjbCqVA6kjk4Xk/D4/J605eKCtLnZvDpLPfKarySDp3mdvkpY7psbTzTrdTyqnr7J936pdi6e1Ft5MoF1td0BMQOZ1pJ6oikaVyoqhnJM0MMcmtKGdK5HYqjf6dl++NzFCU+W/KiEtdzsS74x9/Gb58e/izkFU5y60u5wJkrfpYaasSDBWxTFPQwdPh0SHmn4LkxuV0qjDYiDg3pdRGpNqAs3ImSyGt2h+ZnR7eZZkyZXgXMX8TbV0p4pm0Mi6VpfUf/PCgy7TGSuz0n4szo+M8AXn8KnJtSidoAWWm5awrpEloBaGnJiemk8pqMxWFzWPlHD6OTL8nVFZAOF54ZJ70RJpDMsUPVhjhB8y1K6XFSqyoUceP//eoQwxCRqcTFVQELpeodZmYVY7lFqVVMBE4dALsZTJlBTVKGJlBz68Z9Easl3fomP+OhC5FVrnAoOfP5Ca6nGn4QiFjtaRNUk5u0vmdIxxzCSPnlyr518iI8JPJK51VWdCyyCfMFXMKBWy2ysjQv6O7vCOTxEbZeEiWW1a1Ef3u0+3t4BUP/ZDKlKSKJZb5dfeWD5F8S8p/1CMJVjgIa5PC6oXPTl9Hz5dVQBrqEe8/iBOZFemS+kt15UnQ6w8fPvhRm2R0GYcKGb4eH5xGmV/OTu6eCE+d6bEmL6FXrMaPl8qW85GR4zjBb/oZmZopvJa/X7lLF3hC7nAqrih8kT+uO2dO2QPysqtyiLimnKITs19PjxZr72fSyKnqXNwgwVDYg/sXeQIy1506C3T2S1up9fzzmTzgg6Iq0lwmKumBv+D0RDer0lIXcN0tpKgsQgaT9NjFM5Xxp3JeKKyQj39VcYm50A/yZ6mVo7e0wNIoV1K0YxQRk1igM9acMW/4h6RyBcLVT+5vb9N/q6KcVDFlikmVIk58SgXPmNrf3lkffeADmgcMNpE7SDX55ytrkYEjcazKyhrYVk9CZmAtizHUTKGkzSeZ6ttKkkWR6piT9tavjuh+uYYSBS9PDxCWm/S0yuxrBE00tYgKcKiYZQ5qUPykE4pAjlJPss4CPI4YVlccLaADTfR2xAuZQF4v30EQBmoqEWe/gRZVv/sYQlbBfFFPETppKtmGZdWukuNn23v9weTZQMr+88HO7tPx3kQ+ebK993Rvj1bPYFv4uFtaW1or52tL/6iMsjr2+UT/DoXA1NA9M8CLYwrCNHP328BH/v3iUhiF/FWLGfjlzIPqJl4cHInBrkilmVb8XE5vKcFEZyd4YuDAckyPKGAhuSf8zuqpNptYUabKKDm8fPV6ePbmFE+OX/337NUJPhGtNcwxNPDWhNwSrMIXZvmlrwpegEvUOKdSqAPhIR4Hqo8hkDRueaD2f7m5gzLhWxOJlIAZYfUNM5ZJi4nNs5VQin2uEw91T/W6SD14hlwQz8RYOkUFkIc/HiLOizJ6EzT5WMwU8pN91BPDJNGcwVKBaARRLlbIYTJJKHQ9gUmFUFZccfOqpFqmY7Vqi4UqV62BINAlj3izbBQKDnB+v58M47KSqa9Gy1HYeEtgMdhH1VVxlbvTJaWxSucoiEjdBPLmUKO10LAYQzZdugaoaNI9CkU9rslYlF5rsTjdvfXMvCxzfhfLyn1B3B2lSD8Ri9a8+KRC8DkqJj4bsTVqM4WMhJckNk8Ooxpz1YGPmqTSpI3dNnbb2P3C2L398jiAqPCWoc8GbHRmwj6Siuca9LHsPSavN5t+TxoM2cVGtYZIP70/DbtUjFdXBaHQPxEf+VK+xvywsYd/Pq63YnXpX9iCGGQ9egkmyEQq2We+Fxw3CHSw/WR9tde5HWs4qNkAEZE1rZjnFW/NbGV4Uyix90ly5cyDUswk8qNk1OozIK1qkoi3YS2SbJFkW43aavT9VKMWSbax28buPzN2P4skG644WgJOclWWUQOPPS28J2mlwABRt/NEE3JsqttohYiJBmN1VpFDZ9zfGe9MdmM1SOQgefZkb9KPn/Xl092d3Z3xoL/bWa7154s4boJsNaaW7O3tyCoGiPsEHFcZOJcr8zxZbf9BvVZNKK1R6mlwM3QOlV4ssONgHTv+nJeQDYSBHe0d7cWz4zdEn7rbRJ70llc2pu+Dgur8txwEKbkrr660K1vo2ELHtvy05ee7KT8tdGxjt43df2bsfhV0HNwHHQdfAR0HgiDWhCDWXwkdE+AOgmYTTUdcRFxBvYZgYwFR8Cl0H0PYl9JOVdkAvRUU2d9bR5GneS7eSjOvwZJb6USahboovWFsRmNtPRYDpJgiRRqBrKWBbsmrdEanaSz8R6Q60xzHJBDo2nk0nNCRFB8ztb81q2gTpxU45KSQ5tR7zeFjGu6kJnxSxM65DzpFov4Te5zBWn+oHyyOSeI3JLF4dRUrRTHf9H+fbjolcAjmLaWLE2/rO44L+J65NNhGqKvCp68GgrZQvYXqbblvy/33Ue5bqN7Gbhu7/8zY/QqoHtDQ3VCdjgJ/KVTH2N62aLDUa3Ku/zti51AJHLB7izxmrJ4sMDjjCrhSOP9POUTSydzO1oZTuR06z0uo0DNU2RQDZ2VZuP2trWvYCfa56clC95C+YKpybvLLXpxnW2MoZ0PeoWOmPsZoAJ3kD1uMHmvWanJen+mYuNczy0JuCn3zyYLPUjYyYwPOsfsQnkxXwNGDI/FjsFhgF/HA8egeO86afJDrzKY3f1wWT+gOWTap77OrYbwAp7dEJBEuFsevTwhy+9XXDmEvygg1+/tri72jYX3xQkmL/YA///Lwp/enj8SUgCYHekX3GYTStDNAqBzBRTiRDeuzIDSJa4vNq+mMGR+unLahwBGTFAKLkTlRSpwfBiX8jAx/jJTMKqVJirMAzbp4WFsnUZ9USsWvt9AkOZ5OzBY0tCVX5j3iQsc7Am38AW1/CyUSLzXlH00Fm8YEEXmDJ86LWi65JNe3MvFDTS3y1CKm5h7d4sKr9jz2p7djRC+RkKljbX3z4p5etESPtk94QlRv80CaCHysnpGKa6t9Mx8r9CKit8rHyLyfaVTR1WnCJy3hUATTRByKeJbnTv1HCHIdCoPzaYUo+ma2LmnRiCMi6m8vsRT5JSMdARMyf28QGOHSiBxTTWZIkvvuCIfkB7YsYv4D3wv5sCIzPz5H6aSRSR67b+aZFoxowcjnABf495WJHAuxTTJwHvAOcLCwP2eCwOhS3vO0NmZ1Jr/Fc6g0xGCVqbhi3/+xv0hw4ZPgFzS6GYM0TJC6OTVGt1UCLSpPK8qqmwG3NbjOb5qjKt7Sm+e3+UqTKuXfTV6SeLjombwz6fzPztJ3ZJK/T979izJem2m+x0wTQC65Gy8bdgPLTv4i4LX1Hh41mWcKv/GWY5XxNHYr/nYjoZhlQkUqS/Jqjup4phXv/gslS8J+XfKsPONIDJdAVbjGOeW7WxYsS+zXdAp63J+uV+ZrpMYDy/paqavCaYmcbgyaqeqJ99iQmRhmoc0YndPFu1/zsCs7gWWOyLDiZW1sgK4sqwzdrgXbVSYkXOoej0i0iyufuLA3M6rWRc7Qr5lVRzG5GonQ422Jzdy7CTWWsWddMvw9a8HuLnSVoXqyIqF02vE0ghyrlD2Txq3C9vtow9uimUoL2g4i6wKAqaUV3h6erlEEMRO+ysjtdCtMcls0FkRoe+Td50lvp7cd8XYBz4vcldjALhE/4yt9YtO16lueeL1oqbcXrNsL1u0F6/aCdX3BOqBC4naroAY05ZrKtxd8K+e8s6mVc9HtzJCR6PX1NbUoqbdxQ48/Vor6X+cXi7YF/QWyvlXJvZ/fFLXIwndj0emcMW7ohW28SU0NFT/Jd0CXhq99R0idi6YrdXRGKXgcLn9nvr9GdJlsd/HR8yjvQMvhAw26ufkfgpiLgQ== +sidebar_class_name: "put api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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' (put-password-dictionary)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. +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 + +``` + +## Request + +

Body

required
+ +The password dictionary file to be uploaded. + +
+ +Successfully updated. + +
+ +Created. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/put-password-org-config.api.mdx b/docs/api/beta/put-password-org-config.api.mdx new file mode 100644 index 000000000..305a12a06 --- /dev/null +++ b/docs/api/beta/put-password-org-config.api.mdx @@ -0,0 +1,85 @@ +--- +id: put-password-org-config +sidebar_label: Update Password Org Config +hide_title: true +hide_table_of_contents: true +api: eJztW2tv2zgW/SuE9kMfiJzYeU38ZeEm6SCDdJLNA8UiCba0RNtsZUpLSk09Qf77nnspyfIjSZt2d2cKI0BgieTlffPca/ouSDNlZa5TcxQH3SAr8lPp3G1q4xM73E/NQA+DtSCXQxd0r4JqTPiRwq8MbtaCWLnI6owfu8HFSDvROz0SRRbLXDmRj5TIqsWpHYqICYhBaoXLVKQHWsUC/5LYtcQJptvySdzqJBGflMqwTg+1kYn4LJNCta7NP9NCjAuXC6dy3uJDhKd0fGRcbouImHGHRvYTFX/w5ESeiusAg+o6oM99JWiYPhZOCb98yqluEGqJa3Om/l1oC3lOzn79V+/g3dHvayymTUEDosgiH4HLP1gtwkVQrkgH4oWOTbciGkL80IvfvbU6Vy+gYKeiAp8nUPJdcOmUhYJz9SXvgSAp/lECwc09LGDBm3L5mzQGlTt+BKswKkm7FkRE0OQ0JLMs0RHzuP7RkcHuAheN1FjSp3ySKZgw7X9UUQ7WMksukmvlaPRBBTeW9lOoQ5pg3iuOTEzbQk+3I8UmfkzfYqBkXlgl4ErK79ESFzByrAaySHLvBTQ6kIlTLd6OR4Iuv1kL1Bc5zhLlVXCPcfhPfpF+UuZ7mL72dOAzIAQ3+m/yeVCG2DttitxboORXw5xDZUENMTSWuX+12VkQgFkpyZAzzrOvjRh76g+wvU0sY4oeF+Og28Zn+cV/3tloyLLdkKO9MSPFsTJD8uPnMZ/w6iWsP8Dvzgy/Ow1+2780+N1p8Lt3D35zndPnYDEB3jem3i3zIh9ij5it3bm/pz2QOzL4trdkZ2OD6c1IfKYGyioTcU56IG2SgKt4XsXzKp5/RDw/EgJfEddLvXB+XaWwHZ8FtpYF/n6iEc/i0Fr4ZijOFJzQABTpAaeB8ngXfZzvpBVtoCAd/8BUEKtc6mQ/jVVjLpSizXDBjm+1UeHQSk0cKmY5wkIBip91jBVinFqyJZEkU5MIPI8YrpVPmmi1xRsZi7NSvv1SGDKgldEn0DqKn2bo0misF9USoWPGlg9sq3aV7O9s7HW2BjtbUnZ+2Wrvbvf3BnJzc2Nve2+Pdh8r5+RwJkaltXKysPWvyiirI5GkESzyBxRilYTumQHeHEsA08buaRswja/QP8cRz63FLPkVBBvXhBRv9k/F1q5IpBkW/F4O55RgwstzvDFFkpDf1unKEz5htL2MFWUo+K6Cg8O3vcvjC7w5O/zH5eE5PhGthWqgZ+CtVdaFL4zSW+a4FOBWOgD4BOqgTPu6pPoaAknjmhO1f3ITB2VWeQIryt2XrGiSFgOLo6kZSpHH2OKlbqnWGmoBvEPyikaiLx0WwIQ0/XUvilSWh8elJl+LkZKxsq9aohfHmoSsahKH9RMuKuKYQtcTGBR8ntxqFAdFLkya60jN2mKqyllrTLPYcdMoFBzg/Gk/6UV5AeZYzGYU1t5SsljaBzx7zc1yd9FQGqt0YnKJVImZyQRqtBYaFn3IpnMnynRE5nJIPKaaV2esZnLmdPfOM3OQpzwWycJ9RdydJkg/IYtWD3xWZfA5gk8+G7E1KjOVGanEVry4nFWbqwp8XzGuYncVu6vY/crYnR88K8udcpShT3sR+lyaqnECIRagj4fiJp3rrnhDrlHbpYRIv72/8FCSofuXjNofPxAf+aN8gflebQ//vk/wozbWjC2IQdajl2CATKTiLvM95ZgV5VW1ubjb29T2NRzULIGIyJpWTNJCSKjMFsYQJ9KtiThVzrzIxUgiP0pEhHM+A3KJE4dZCrS+QpIrJLk6jVan0c9zGq2Q5Cp2V7H714zdR5FkzRVHS4mTXDEeSzvxnlaOk7RSYIKoGu+iDjk21TxaIWKixljBLHII+p12vz3YjdRWLLfinc29QSfa6cjt3fZuu7/V2Q2aZ/3VNI7rIJuNqYa9vR1ZxQBxn4HjCgPncnmaxrPtP6jXqgGlNUo9NW6GzqHSmxo7dvYWseNFmop30kwqhORmMKSZ6ohyGuaOaa6t5mKCFEPkRSOQqjT4IlfSYwUqFk4jEj3WedUsB107CXuDHKL4QKmcrN5FmygpwCFngiQl1JzCsTSEVAPCfKDACHaI7PwD0Wlpou9C8uKMJD4micXhl0gpCvQauW8v6+8egXlLOeLcG/iBRq+vdqSBA6Ag8Dmrxp0rfL7C56szfnXG/xxn/Aqfr2J3Fbt/zdj9BnxeoqGH8TkmfDU+x9zWhqix1Fv+7v9/DdM5VEoO/GWFNIoKy+3mCoMzroArlbcqKYdIugIQrC+5xxfQDUBChZ6hwiaYOMrzzHXX1+9gJ9jnviUz3UL6gqnyiUlvW1E6Xu9DOUvyDl0Q8DFGE/iOot+gxZq1mpzXZzom7vVc3qQIHPTNPeFHKRs5ZgNO0gK5jcmsCTh66Uj8GixmqCJeOJ7dYsdZkA9yXdrk/vtl8YQekGWZ+h7dDfMFOJ0TkUS4mV7YPCfI7XdfuLY5PUaoTFu8DHNC0zrijZIW9YD/5uLlb+8vXokhAU0O9MIRxlWabypJcQoX4UTWq7r4tIjPFpsWwxEz3pv5noQCRwwSCCyuzblS4uqoVMLvyPBnSMmsUlqkOAvQqpuXlXVi9VkldPi1ppokx9OxWYeG1uXMuld80HFFoI2/C4S3rWsTigNN+cffBMOcUkQu8MRVVsklG3I9l4m/VdRCTy1kau7VHBdetVeRv3cTIXqJhEwca+vZm3t6YYMelU94Q1TneSBNlHzMfrsVVVZ7Nh8z9EKiN8vHtXk/0jhFZ5cJn7SEwyGYxOJIRKM0dervQpDrUBhcDQtE0bPZuqVNQ46IsLPRYCn0W4Y6BCZk/o4RGMY7k+zTmcyQJAVaM7EPyQ9sWcT8B1TMsfgwIzO/vsLRSTPjNHLP5pk2DGnD0OcAV/LvTyZyLLr5Bhn8lUp2gP2p/TkTlIw28p6ntTSrM/l1XkNHA90jZyou6/qH7jTBVffleIBm13OQhglS19/34VmUtOh4mlFW1QyY1+Aiv0mKU3FOb57fuhlFJ+WfTV6SuDftmZyYZPKjs/QDmeTPk3f/TxlvlWl+xkxTglzqPZ5Nf3py+Kx7td9w4XZj2b3aPTBCfs/yl2VJM9relMBxsZlI3e6Rwn+MctJgYI+yiQtBhlNNQlkicwovTi/RSCtuQ2RK5iTAGrl4OuaUkNmU8pByntDQYg7yhwM4ln2dgB43yqudJUeuR7jkYPTsCq6FaK9ohLJWtcR7VIYmgn9QVUhXPTD2MS3Lw3O4yCl5mDiovA7obzwuDHajBFGMhYRvP+GasXYwHSsD1YlRlS5SxqD1qiqdkM+TCC2uj+zYnQyow43iueGBT+wFB3RlexuqJytSuUClVy3ImUrYE2jebP3wFG24fThSSUZ1KdI/kKBq7PDu6GKBIogZB7lQ/6NGWy8XuXWaCyJUp3n32Wy1Wxsh1y14n6UuRyXdIH7JP38T9c/mTuxQ1D+qm/HEu2lvf/XruW/99Vx5gFPltZ5Rr5CsUfhK0FfdV8Gyqht13Ag2o+G7O+omURl6T6+Rz6hVcXUzrTDpCWR9V4nL9E+Kuhnl1xjhxYThSNm2WPx+hgpfv8J3qh6de9PoHpxekof2y9/1jX0fxMpbvKT/3eAaf3hIMx8f9OM/en8XVF1FzPFkK9i3DPWUH0jK+/v/AKWIbgA= +sidebar_class_name: "put api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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' (put-password-org-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. +You must set the `customInstructionsEnabled` field to "true" to be able to use custom password instructions. +Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' + +## Request + +

Body

required
    = 1` and `<= 60`"} schema={{"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}}>= 6` and `<= 18`"} schema={{"type":"integer","format":"int32","description":"The length of \"digit token\". The default value is 6.","minimum":6,"maximum":18,"default":6,"example":9}}>
+ +Reference to the password org config. + +
Schema
    = 1` and `<= 60`"} schema={{"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}}>= 6` and `<= 18`"} schema={{"type":"integer","format":"int32","description":"The length of \"digit token\". The default value is 6.","minimum":6,"maximum":18,"default":6,"example":9}}>
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/put-policy-schedule.api.mdx b/docs/api/beta/put-policy-schedule.api.mdx new file mode 100644 index 000000000..e221ef64a --- /dev/null +++ b/docs/api/beta/put-policy-schedule.api.mdx @@ -0,0 +1,132 @@ +--- +id: put-policy-schedule +sidebar_label: Update SOD Policy schedule +hide_title: true +hide_table_of_contents: true +api: eJztHGlz2zb2r2C4H3KsKUuUfOnLjmI7rbqOnbXlyTS2p4ZISEJDESxAxlE9/u/73gNPST5ydDdt2ca2RAIP774I8NZRsdA8kSoaBk7fidPkrQqlvzjzZyJIQ+FsOAmfGqd/4ZydHDB707nacAIRa+HzRMC0RKdiwzHCT7VMFjD21jk3Qu+rKBGfkkGazHC+DKK+UYEbE4z+DYwVztUdwTK+ljFiATiMZtKwNA4AtmEmw4NNlGacmVj4ciJFwBAbC6l1GZ2K31KpYbhWMFRN2MnpD78MDt4Mj1tAQMw1n4tEaEOoSVwk5oDUhhPBDfgmA/iMS8250791kkWMV02iZTR17jYcbeEXpC4jLNjwAJdN4FOJGEtURgeTSUkKoiQ+8Xkc4iJi0t2d7PW6vR2x19va9sZb4/Fuz+vxre3u3k6w6yCDcH1hklcqWCB+y+j4yOgowVs8jmFpEujmrwbRu10lTI1/FX6CnNEo/kQKg3ctM5bJX6a2VINSODSzStXZ/o9uZ2u31+143m633dlCLvpaWH1ZXQKkO+dAgIPcchNJ4Fa5jDfYzUxEwGlQkgqrC1TgcrZOnc9e22u77Q78G7XbffrXatN/7xG3uQpIr/5w5PKFPgu72mJfIqDqiJqcquaVYftp8Tuumc9dpzerxJckRpZdcKu1omEWzu3S/MMonTON/sSAFgNJZEfgTDR8DYGKNI6VBomWqyAgA4Z/GQ2CQCIcHrKPPAQrYXO+YGPBeBDADBkRsEmapBqkI5OZShMWqUT6Auaje1tipgBs0F0dDIZHP8P3d4eH/6YPb06ORz/Sp/3B0eHxweAUPg6Oj88HR3D1qsrWYk4ikxqfR7gYqVuUzIglPAxPJuSXHjbOr2adCAEsSLlk3dHwbMRcmvHS8u4l41oD+9ChcBkZpiJwpxqUFpgXSAMr+EnGZwJxOjj+4fARGMmNyqb0aZxJuE4YjwIm4CfzmppHU7EB4vLD1MiP4o+VLVIOXwn7uuSyO4XcMq7lcrNorMqBTIDGAl4Ff0oMiCXwFULe3KwNMQUKF6hopHcHEB1hCvh2DSDJQ6dhyMc46r44VCCRTyPLtmLKVaCOGg6cCl31c3Cp61X9RPeuFgQv7NyCHVerDAOS1vHI6j0GRvEJ0gWIjKQRgmt/1mIU+VUEekthTNDA3OYNSRhyAFwb1eY6t71rS0+BbcHdTJi50C6cLnzbhp89+Ol4xN46S+/wUsAXjWk2pvk3M03U+nsMEwU+BIND0NeYxFzbAHe9QaMyBbiRYYgacA1MgjvXo/ND/APMom8/nuOf16dD/HM2GMEfVLTrs/Pj6zUrZNH2GnW8tPS1C3IGujMWGrUuUCkIgf2WKqgeNlgoPwBCl07n0sFl4UObPiHQS8fbhS8txk5iq8rhogIfBxzBfebzCFdJDYgO+KPFBJaCDzgy5CZBzuW2Qv7tye6o1KYNBxhznz8C29GNQ2oc0t/MIZHaF0i21pqUlUrVpii07+IyJTMApStiWyxtr+MeoeTVRTmQYcnXYkfYi0igQDJGjlcHoMN65rW7u1jCdfZG7W6/0+u3d/6JBdyzNbq1LJu1FWa1OuwA6G3X2xp57b7n9b3dVqfde19RvgOYOMJ5d3htLt6DNQ6D9XSCQ1OR9EHeo/dMBugMoCLV1uByHpBz1WmElvNcfGqxwVxomLR5LG5++VnpDy/AcYLLjhQVvr+j9QMbigaN9aRKT58ZqD4nPA2T2kB0p601rFgxw4ILOQL7M/g9Vc49ema95dVq7eV6tpXjy1gCzVXTus/k7il4K6V9Ae7+Yvfxan0ZFjsYnZDvbVX80PDg8Hg0HC1VmsVVtP613YvHlwMJWS1IFmx4sNSY8Hc6u23e255wHgjRa3e2J+OeAIX0vfZ2j1j69L7RmpUhUsQheGoEUl/6jfRnXIQs+2tI4IVQVXCaQ6EbYs5leDiPk8WpMKBsVTGOlQoFj1ZQGkYB9sogVsgJEzgXUKPJLBI22kMAIcgiqOI24aEReUdL6eETGG87Ms+y7hT42eFBjdr2pNOZeLzn7vh7Pbc3nnRd7o0Dd6fnbe22J6I7DkSlUfV5a+aTvmzROtuX+sN3d9YOTawiYxXfa7dXHU9F/ONczZq+ZdO3bPqWTd+yqUWaWuT7rkWavmVjmo1pfpem2fQtm75l45Aah/TdOKSmb9n0LZu+ZdO3bPqW33/fsreuVbkfkjIfag3kuuxUQOyNMNxkYdxuxmRjFSzQI8gInLUMvmFDMxCQVYT7KniCer6WkXCnGrIQwFAQyj5MZADxowwwW7KJDYHMMxEaV9da4ESrw17xgJ1m9O1nxCAbNfc/AKynCO88kjCf5VPARCk837Os2BF8vN3e83qT7R7n3m6vs7M13pvwbre9t7W3R6ojjOFTsc7x1Zf+QUToalmoIEjI34EhoLPAe0KAFn/IV9ZlQDCewH8MTHZsQWaGL8PNz1AssFf7b1lvB3LuaJrSdT5dYkLknp+txBSg3AI+0XIq1zZQi57f4evB+RGle4f/OT/E9A5hrWytHmBYJN8BqIIuzNSNLQcsATe8krewlxnUl0AQxxy3HCjtN7MwwMw8TMKMbPU1M6qg2USrec2UfLtTnD2XLdHaAOcF1yCx8GdszLF8UTYLfjnwfREn7lHGyZdsJsC7awjpX5NG12RRsnIlwme+5KgqFDQOwPxxPRn4SQrIEZlVKyy0JUMxkw/gbDlXx25UYRqxdAEFiJ9gUhRiOQI1ERQvY6ANd5xn7ojyG3A8UT6u8FhVF0nu7o1F5iCxaYrPU/MEu3sbgvtxibTixkeRGR8V59YbkTRyMWUeKStIaXI2qhBXbvgMYkAYNLbb2G5ju0+03eWbp9kD2uwupT6d1dTnPOIp8FdT8FxJfTRpD1RO+SBbSlpBUnMqS5F+ejcCw/4gIhxPRaf4lvmRDeUryA8Kedjr47xXlIf+UhaIIPHRUjChTLlPeJcYE6Msq7qrq71WeixBQaM1KSJ4Tc0WKmUcWAbFaISYcLPBAiVM9CxhMw7+kYNFGGM9IK4a4dkoaUuyJpNsMskmGjXR6K8RjZpMsrHdxnb/nLb7YCZZYEXWkuVJJp3PuV5YTcvuI7WcwQCWbxVkhcmRqJazFQTGihzLqWcOztjrjDuTHV/0At4Ltrt7E8/f9vjWTmenM+55O0411l+UdlwYWd2mKvK2csyeM+mPkMelESiXSZQK6u0/YK8WE3Rr6HqKvBl4Diy9KnJHb2/N0wyl2BseLfIMydRyyKjkEfo0GDvHsTofCwM4m4JfjBi4KqnsA0bcxecyjY91QjmXZLxIBcDVC3cwSYAUayi5khWr0BNJwJA8Qagwa1agWBKIFBPM+QACZbBT8M7fMDvNRPRVmTw7RYqPkGJ2+MkXAg29yNy31vV3h/iADX3EmRXwPY1eW+3wCBQACgLrs4q8s8nPm/y8ifFNjP9rxPgmP29st7HdP6ftfkZ+nmVD9+fnMODJ+fkWHvVgRS71GpXrf56mk6lkGNi9OsqnnYFBmYNTXgGqlL3fCn0Ivvyp72wWb6MCb7J5K4O7zeLwCL7OCpNDi1eqQxg/S5LY9Dc3b0FcIKa7Fo9lK9+BEqmblq/mm2Pg0Rr3g/sErKnhADZ4O8zKixYxWEvUYevwCLhlN5GE2gpsp9bwg5BxKwrKcaFScHEEZgO342T6RJcBxRiKiWcm27iC7FmhD+g61+Hd19NiAd1Dyzr2PbgajGeA6RKJSMJV+fYx3OAxt6uvvIOsjCZYrXkri53gMI+9ElzTVll8gPH8p3ejF2yK+SbZe2ow1RUSCwSwmLegIuTPBnkzHydRiNEqnc4I8UHtcQnaD5uEQDC7jM6EYBfDjAnH4OhPwTMTS3GSIGeAs66e59IJxEcRYgxslZxExZNBtAkc2uS1eS8o3lFhUD3hdBm57ECiG5IYt3FMRiLVeewizuniFbq+FIl/5NBcC80laObFEhaWtRe+3X7jgxEjCB4a4tYXL27huRV4WEXBFYS6jANyIsOj/pDLz6X2xXjU4LkIr47HZfRuJiGY1qcx67uYgVgYBmzI/JlSRvyLMVQdNIOLaQpW9MVo3eCiLlmE67UrKLl2SVe6kBoSfkdgGJFVJj7G0EyZiYKkLQqsSV6TZMHmr+0m+RrNdPkCIiiODJRvvhhnXNDFBV3rA0yGvw1QqFhg20gD+QGrAPul/MkTZIhW/J6FtdarE/hNmoOhwQdUCYqJ+/ZLv3Rw+a5RuoGjizHghjGzLh77wXeWwcIoVWNW3hNY5uAqvqGC4LjEN4tv0ZPCgPm90YsUD8rWyUkULr61l77Hk3w/fvf/5PEaT/NX9DRZrostyNPyfaGH5dmD7GWnq2fcK0fcHzzRXT1u/sjApT3U9xzXXntauziEXB42/oxzkfkhyM85u1QcVPrM0xn1oxkPH3cojzasHgio7+4vj0kVm+TtHvnHN7UXL7Rd3YN+tXarOW0Ir+0Hf9re6vp+7idvAkdXSHzOCtaqA36V1RKrbWZDh/rgN9ylOEIygILanqzFDLsKKA55gh6XIo4/k4IaVDFQiHXJBno9NacoEWuFoSk/ojslI9BgTjzkYxkCPHqEkq/MyZnbogd9Dn43KVXJuBZwOpqKFnsnmIh8UCnsF+AmILj3q8oaB2cggrfodNhB7oigIJjP0whPMQDa6ZxxcHePeKtAGj+1QdVXUSRyXigqS4pZeYRBN4gktKhy1nNzMsFnH9IXFaf0yFrgk0z24ANYX/EnJSGnIiRbwHH1kvIx2OAJ3ZkIY1QS8A5QHFQ91pvhaAUiAIsM0OWLltLTzWyS2cSxeIgNiLfq0211Wm2XSlm4HiuTzHlUAX5u39C85u0Ty5p4Wz71+fYvqc5MHovVzRi7rIhtaotn26+4cKr9CpjSL15bTdheoSMzCQ68vcWOHNbwd3gZggG2ey6uyvKc3AxwHz8HhR+4l9znGfLBC3qm+Jlvu15LW95njhZli8mBjx8EdqaANHuGlFqHhK29kT2rckeV03kIZvkhHLY17Azbjnxw7FWlRfT2HJVtnL1qe26bXZrfwEX83Xcu4X/4omKr6jCIrt86eesYxliweVK/LqfNPoBQYNh/AXGxFTg= +sidebar_class_name: "put api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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' (put-policy-schedule)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Update SOD Policy schedule

+ + + +:::caution deprecated + +This endpoint has been deprecated and may be replaced or removed in future versions of the API. + +::: + +This updates schedule for a specified SOD policy. +Requires role of ORG_ADMIN. + +## Request + +

Path Parameters

Body

required
    schedule object
    + +The schedule information. + +
    months object
    + +The months to execute the search. This only applies to schedules with a type of `ANNUALLY`. + + +
    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` or `ANNUALLY`, 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[]
  • Array [
  • ]
+ +SOD policy by ID. + +
Schema
    schedule object
    + +The schedule information. + +
    months object
    + +The months to execute the search. This only applies to schedules with a type of `ANNUALLY`. + + +
    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` or `ANNUALLY`, 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[]
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/put-provisioning-policy.api.mdx b/docs/api/beta/put-provisioning-policy.api.mdx new file mode 100644 index 000000000..1cd92b26a --- /dev/null +++ b/docs/api/beta/put-provisioning-policy.api.mdx @@ -0,0 +1,98 @@ +--- +id: put-provisioning-policy +sidebar_label: Update Provisioning Policy by UsageType +hide_title: true +hide_table_of_contents: true +api: eJztXW1z2zYS/isYXmfyMnqxFTuJ9eVGsZVUPcf2ydZlOranhUhIQkMBPIKMo3r83293Ab5JVOI4mWubcm6mJ5PAYnex++ABCCC3no5EzBOp1Sjw+l6UJmex/iANPJBqfqZD6a+8lpfwufH6l965TmNfGO+65QXC+LGMsCpUvFhIw4QK2pGWKmFpFPBEGJYsBItKAllEEtmNTBb00kTClzMpApYaPhdMq7XHhlpkUrFRIFQik9WJvulcqYuYKzPT8dIwnys2FSAAiku1tc1EMz8WoBbjTIkbxpMkltMU/k4WPGErnULr4QregZwgjalqSQ40OhYzEaOgy1Lz0GTZZ4ycJoW5frxIksj0u91AfBAhOrpjuAzJQx1fL7syUN1A+6ab5NK681SCZ0tP2lK1y2q0Iyf/CYP3bKlj9A4WpW4ELQeg4XuhrJMHZ6MWOx2/+WVw9HZ00mLnp5Px4TD7CwS4B+eTV/SM8TRZ6Bj8zKBHY/HfVMbgD3QeD0NwFTwFmR0ICiP8FAtCYNx6EyPiQ60S8TEZgAQMFjCvv6n5qr/kCroaBGwp0LZ93ubBEmzPA9RkFa/vIPwiHvOlSERsqHmJQRhxaLjlKXgBf1kpENYtLzPD6ydxKkBzfyGW3OvfeskqorIJdrd3txnWgtmYZ6MjtFl85MsoxCo9/2D35c7LZ/vB7sEuf/l8Z3c/6L3c29+f7vHes94BCKtVi+L8Apvd1GuzcdSP6VltQJOkDrtSo0pytCC+XdZgZpg0inScsA88ljo1VUmFczvsNQSDM6/FbhYQQJz9BrEKEQ99zoPAhkEmvGVjYckhs2I5n0OxqYaAOxwPBxdDxlXAJmdH+HNri2zI/YVLfDIU5PnwBjIAY47XWQ21BmXzFvwDJLSCtE2XU9ABfAUAYOogAHKGBWIGFgXotQsqxmNBiAH5uATwKZQxfSjjjGkzwreSprEILcBp9ujQosrA93UK2AdgMJOheNTaRKJEgHexLGYuvuWuDogBBLPwFKx1Bbn5RqdhkKMcVs87R6u8T8A5V8p5/dM6TwigH6Szq/sIu0oJP4HHW8Nom+6qhL5mpfyKEVdqeDJ4dfw5E4aKT8Nv4XZBgmrd7t/L7fDbt1Fk3z0yeQsoI+vVK3U0Or+HYUfSfCPLAivpHqa5fA8FpFNskX+pP2DGQws6BuyAkXEW62Up1q7UzzBmYhKCCJd1M3hXTiLrMxg4VviiDsVwuIWwqWCrTTtvO1ADmqZhiLZ5/RkPDWCnAADAUSeva/MAfthogh/O/fhreDykd4Pz89GbEyx9kv+0En55Mz6dnOVy8j9t1fzP8fDN6PxiOC7qjY6GJxeji5+LqqUnw6PRRSH55Pj08F9Y88fByZvhL2egwrvT8RHSqxpnNKNDMzo0o0MzOvw9RwfAL4LDSc6f73AegBRamOSVDlY4TKwzah+nJCrBVzyKQCQFYvc3gxh6uzm+6OlvELQVan5pmTvOOWIM5QSQAmtYPr85MlVhettslGqXYd79qi2MbpKK+4kEOJMWzFGL9fnKfZQpPXFwWNdkRTWKiDq9bPBSPAtj2JRjsGDoq0zLFZtrrJBpjyoXM6BmXG/G9WZcb8b1ZlxvxvXSuN7yZlKEgSmNDzyOOQ5KEjQzdeP1Q8ZmhFosmY2DeXRWV/rAzvgEBYJi+bpsnQ41QJ4VJwwFAkLL0NgWWVhuJhcXpyEyg1yZkkGeA52JksB62PHR4IwNsnLAh1CFGU9D5Dv4V1XGp9XN5ZRWfbP4KqyuKuziEGr/cDuTsUlQzbvOD7chd79/uE1J10OMTxHfgQA/1Gnwln+0RhwuhP8e1PP2d0rvzuXvtMaaPxvndMxDYke2SlM8za2bag3hrIjB8eBUhav6xdXXIUdWEhAjhLiEVABLY1wRVzqphkN5JbzjlZycUZTMJfQ3RskWcrN9pP9E+BVr09K8hWblf3iYbrH562xcovT2BxJ/DzvviuR9jdF8JBIuQ3OUaOie0svNL0quyB12kolgALEB2tvZwf/b9FKtBHbDDfAcop4zYI0r6CMIR9/q3hD/hvg3xL8h/g3xb4h/Q/wb4t8Q/4b4N8T/z0P89+q4/mEogdewYRyDpm02FkkaK9zVZf3k1vqBeAS0O0kqUFl+Hd2vwkdAlhzq4B69+Bqwvz2PORIMJkhlHypa1AvQ7bQ3y4rMuprKVbsZPNHZZa94wMbOvkNnjIUd/z3IGgWfV8iBQ1YFmHiexzXNiheCT5/vHPT2Zs/3OO+93Nt9sT89mPFnz3YO9g9w/5K3BHIP4FyHx9Wm3wgYB6XPQu1Dj/wODoEkBN+TAtT4/SGcZNwzi2zZ3EynL8NdaMiLXx2esb0XLORqntJzPl9zgmpPziuTD4QMsNwKPgWmK2unV9nk5Gj4ejA5vqB5w78nw3P4hbI29kcOVJaPmkjrQt+Qxs4AmsqKENyBo/dTJ/UpGAT4Wy4o7V9mZcCZzOUp1HCt19Qoi7ZDejmVfLtljz2WHdFpAT+AZ0ueAE/P53RY/CmQExEl7WPnyadsASAr4icdNggCiUbykBGA2DkCEA07hXAbMmcppLKgLYk6TRCFpL8Gd4Urq71R4MlxuVMwOUDzz8fJwE9SUI7MLGdhHi1ORdc/oLP1XFW7i5LTyKUrleDMFndFwnxYxzF4mAGgMpkY5uAIu8sA8KisXI5YZZgkuHtrlbEACXjGU3OPvDsLAX7aZFr+4oNwyUf00qIR9UbWTQ6RHB+hyq5U3l1Z4udspcndJneb3L1P7q6/HLsVzjL12d2kPhPlNl7j4LlBfWKKHqWz3dm/E71xHUnbuB1F+undhdv9jfvxP0YZc/1G/MgO5RvKD/L+sM+nNFnNOqvSF6gg+dFaMAMkEkGf9C40JkdZVz3bbA0mt1MJAapqKCJO2WgrPy70xKmiqSc3LRZoYdSjxC0g2WVLQsDyuYWGSTZMshmNmtHo+xmNGibZ5G6Tu3/N3P0kk8y1omxxPMmkyyWPVzbSsu/KYC1nUIBl39pZnnLUVetsBYWxnGN5VebgTXu7093ZC1/sBXwveP7sYNbzn/f4/ovdF7vTvd4LrzzWXxZ5nCdZNadK/W37kVwMJA6/S6QKgsskWgfV5T9wbyxmCGu0up7xZvA5uPS64I57m9zxRCdgGwgG7hhvWV6cjI9RPjRtP4CC39x3n9i5jtGJUaSUtJ4qPkqTNNSxoY7N8NMMP9/N8NNQxyZ3m9z9a+buF1HHvc9Rx70voI57DCnWDCnWH0kdA+AdSM1m0Clgg5+CexXSxghMgV9u9THb5sDjuUhyoldhkb2Dmj2pWrO3uAvNkSVTWYlUhbsQ3qDsEsvGWVmJW2/mAJGKAWpJYLcYVXIpkJPiLo9QLiXlMRoEcuNVezBLwCqbM1m85a1I5YcpaEigEGpce8XdsRLCScyQ/oEEWgedA1B/wzVO11tftR7MxmjxMVrMhh99ITDn8/Xf/bpdAiPcUIJwcW77est2AbtmjtuVlPgYWfjKKWhD1Ruq3gz3zXD/fQz3DVVvcrfJ3b9m7n4BVXdsaDtVhwL3pupQtrPDci71mjZ8/r8ZO6WK04DCm2mfuHpQcHDiFRBK7n5CxBC8UK3vdS1bN93b7Kq3u27tTXnd2/zkEe5DtlMEq3EahyApu6jvFjoSOvCuwyPZyQ4yKX1Dt/VNwXs1wIT7UG0SYgG8G8/NQTrk+lhidFsoJOG2I9z+Wi+/EPCTkrO96rSr3opp4Q5iF2n0GFSMYJrxyFDpDkXWhn1g1yQO777eFitoiy117vtka1CegaZrJqIJ18U1g+fIyW3rG5cNFuMMfg3obTR2isV67JXgMV3giBtkHv/07uIJmyMTJSRIDZJgIXHqALl0BiFCSDfINotgJRp8Yp3O7fWVg8p2HMwsNgvBYHalzoVgl6VzWmwMmE0uxUqCYAJr3e+aSPBQl1fqbb3+sc2OJAIUns+hMs5EmgGyyyizi5fseqgS/8ikta20NkkzT9a0sK699O32bh/SG0Xw0JC3Hty4ldcuycP5FTxBqes6oCecHtVNVH7Waw/WoyKvjfKqelypdwsJw2y1GrOoxsyCjuaMmL/Q2oh/Moahg2lwSZeBPlitG2y0TRnR7u2UVGrbJtuyDaSR9DuGxFA2mPgUB23iLNoun1BK/ko9Czn/K531+7ViMz2+hLEVS+KNpg/WGRtsY4NtiwHG6W+HLgwsyG20gXDABsBh0f+EBE7REu5ZWbWoTuK7VAeHBh9UJSkm6ts/+gXAuV+MXmDpvAzAMHLufFsZHoFysug4TtlZ2WrBugc39Q01DJtrfrP65t88cSj9s9mLFg+KRRU8ivOtUXoLkvx5cPcPQrwGab5HpHEsGBcnx8V1Z8PiPJ47JPiQmwQ2bwr4dkf+Kyf+i2Pv2RnPy9viTmR30LL+nOVXHYxcOwr5B55cbG1MXtfO9dnTddd44A+QhdR1M8Mynr1y1HxzPTc/lgtvCZZpbgWdUdy3XhaEjsiPqPoLKWglKAJ/Is1vIYjoJYEuxAN2OvQ+CZqTz2OITg5zdxmCPPpWkbXMCRvtHAJTGP82qds5owF9uMKbDN7hWWwfMhAn5rhnG97hiWpS9ByS8Izukj/K8hr49XIJfZNQNKdLxgE9PpP8gTR+ascod37dmqCJ5ee1MsBGVEETOjRFjZfmdIYfGaQvSjn+mbYgxY37wgCuL4VqYcgYj3/jOIEpUsGPz8kGYGkvRBhhNEFaAtcuA8Db0cWGRBCm3GctHc+7rpLpYlkQgjNhGz7POrudnTbNDOF5pE2y5Kok3N0hsHnX/YpNV6w4xb1xNUn+raX5VwL+hv9KgMM8nKt3I1x+pptg7NqBXci5dFf1Yzb0S7f219qDZYpR5brlLSBQUcbtLQ5JuLpxh48Bp3GJ7PK6WLigESe7IyE/27w1WB9nAP6EvsNW/hmAWqOylXe1KhbdPPj5XuBaXW4YLss8WIvmgpjmgpjmgpjmgpi/xQUxXw6yxchANNp+uCLct+/dTom2IypZ/Y0tIIjRtob9GPbJstelDxRnE2RgU3cb9dJ+aon5DTzE//a9K/gf/KEjy/+gED2/9bIPl1DGis0WjurWTdwPGN6g2P8AbRwRhw== +sidebar_class_name: "put api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Body

required
    fields object[]
  • Array [
  • ]
+ +The ProvisioningPolicyDto was successfully replaced. + +
Schema
    fields object[]
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/put-reassignment-config.api.mdx b/docs/api/beta/put-reassignment-config.api.mdx new file mode 100644 index 000000000..7ebfdd07f --- /dev/null +++ b/docs/api/beta/put-reassignment-config.api.mdx @@ -0,0 +1,107 @@ +--- +id: put-reassignment-config +sidebar_label: Update Reassignment Configuration +hide_title: true +hide_table_of_contents: true +api: eJztXOtv2zgS/1cI3YdtC8uxnaRJ/OXgJumd99LHJQ4KXBpsaYm2uZVILSk19QX5329mSFmSH0n6QPdxRovWscjhPH8zQ5G5DXQmDM+lVsM46AdZkZ8Lbq2cqlSo/FiriZwGrSDnUxv0r4J32nxk9RHBdSuIhY2MzJAIkDgXWcIjYZn4LG0u1bQxnkVEsnBrsok2jCsmY3gk8zm7kfmM5TPBlLhJ5iwz+hM8i5uz2sCQFVFhYAYwdRtcWmGA1Vx8zgdFPkNGZaz6prZu2KDQL7KY5yK4vgP2M254KnJhLBGTKETGgUwrUPAAfirZAxXBytFMpDzo3wb5PMOnNjcgZXC3rIhCyd8KUckmcbYRvxXSCNB1bgrRCsRnnmYJkulFR93DzuHBYZcfdON43OkedsdHnaPOeD/a7+yJAHnF6cLmL3Q8Rw6WqUWoBDAKPOJZlsiIpN351SJDt6us6/GvIsqDZc5HYAC/EhvDUmSmCNRJNoPPTn1MTxhvWvd41brMgnaSmh64itkN+hExAfo36IO5FNaJ5MiJ+KXRKTrlsqLXcVtTMss1K4mQb+UiZROgFXyZtls1Vkb6ezGS68eysQtscGTDee6Iln6IhVNVpCyBuEPbfOKJrKnaQmBxCEBgZSyYFQmYHkLLGWmzFZFfoIpBNTg+Pr24+OX89N+XpxejC3hyfHo+Gr4cHg9Gwzev8YtXg9eXg7NfRoOLf10gNlSirk4GPdGT44WAyD6KbHNu8hOM0EcpnZwRTcxuZjKaoeKJwkL9iEKkB7SBBRogdMohTgKcGuYyFU2zdHq9sHMQ9rqjbrff3e13e+3dvf3/IG9Cxd/Imc42MNZmbDgBK0nL4C/YSRVJwhx5GMGkijGkwZKcQcikXKG16jDX3iQbUuJjFG4Fd7ysu51R96Df6cDfdqfTAVnvlk3kPWIIvJ47eIBBdxQpNtPKugjudTr433JW2IgSDkwQHL8rfDmOHH59FVCtQNPiwaM4iMVEKukQc4LGHC4AMIq0idGm4A6Y7O7hDDLbJxmtwqR8JB4NT3B1XGTB6gr67B52OO/s7x8C+sAnzifdo73OXreD7u5S4ENL/bMAZwzBE2N0MhZLC0XAnOHke9Z/J5NE8pTB/2jiusOVygp7FQSeiJzDyBo33Bg+X2HGj8OFZ/rGxZed6SKJEfgqVC+rj2FlcIcPX54gYal7jFgy5N0sE5GcyKiZEZ2I63Pi/2EGAPieiny4jbjfKeK2GdhlYJFm4D/fJQVXwkF67Yb0d0T5tk/pthXwIpb5KsptcPkBjganr7Aln4kGK0vNlguKjemNCnzxCC8fYpDxxKkWsQsFBPUK5TnAYGM33LKS5DeZ2xN5sUWBH44CqY4hUz3GJ844ZJxy+JJnVK6J+v82ZyiX2HrDj/aG2teDOk5tbBP8gHNfiQd3DzQU1TAYt7euiThOJNrm1BjwqBAMlhcG6zg58f5Vq8gQwRXVP+1v6Sya9nZge6zjRxjjpVQinBoukUNBLEcw0e9pod+l2giP36V5aFy7YR7QRLvLXvCY+Z6LHXthUJ2GRx+B1mO2Jy7dflQ5BXcoyshcs6w4EHz8vHPU25s83+O8d7jXPdgfH0347m7naP/oiIJRWMun4uGK/B9CCQMVb6IjsMh/QSGYpnzjRYvfV3s3bUA0Hpn83diFmJ5fhhuFLUjgL47fsr0DlnA1Leh7Pl1SggovL1a6Z5DcEX5j5FSqdayU9fLJ6cvB5dkIvvFVb9BCWiubpgNVVhbAqu9b8koAzKVlud5mzzzVZyAQV7Y+ULqf7NziZhOAHy+SHGb41dfMqJN2dVI9lCK3q8qeyLZot6BrQJTnOdRRY25hgnYp/9kgikSWh2dek8/YDEBImKdtNohjgl+oFyAagSjMn2P7wWPc2JWOwKSAUBa0/auLnCmdA9w2bVGpcnkvo8SUs7pRMDiA84f9ZBDlBTBHYtajcOEtnsWy8ou95prc1TtCUulc5TwCKXiSzEGNBpIfIBPIJnPLPByhuSwAjyrHLRCrDpUEd68cMye5pmcRL+wj4u5tAvATkmiLB5+EDz6Lic/vsKM1SjN5RPJZkSYv9uG9LsrAZ5CKk3gbu9vY3cbuI2N3+WFZ9/inVPp0V0ufS8UL0K+h5LlS+hjyHqVZOciVrc6QLXxj40ukn9+NILA/Qqcm8QVdhi+PvmN95FL5CvODhT3c92OquktjNWyBDJIe/cYsIJGI+8R3xTEpyqlqd3W1l9qMJTioWlMiAmoaNtcF46AyUyhq/7ltsVgLq37K2YwDPkJrAPw6BMRVVRxmWrrWfltJbivJbTbaZqO/RjbaVpLb2N3G7p8zdu+tJBdcUbT4OskWacrN3Hmaf+7ejcOA6pX5IuTIVMvVChJjixoraFYOwbjXHXcnB5HYi/le/Hz3aNKLnvf4/kH3oDve6x0E9Vx/VcXxIsiaMVWzt7MjqRi3Y6GOKxQ4l821jpvbfwW+kJkgrCH0LOpm0Dmo9HpRO/aOVmvHkdbsFVfzskKyjRpSVTpCTIOxKY415VgYwNkUcFHhuyEJfKEr4RZ4yAxuiScylRS8I9pvzs08HExyEMUFSulki1WkipICOCQkSLTbq77hEoQUE6z5gAJVsFNA5+9YnXoTfVMlz85R4jOUmJ1+joTAQF9U7vvr9neHwLxBjLhwBt6w0eu6Ha7AAaAhcJi1qDu39fm2Pt/m+G2O/2vk+G19vo3dbez+OWP3C+pzXw1trs9hwKPr8308wMsWtdRLdK4fXqZTqHgOyL2ZjqLC0HZzWYNTXQGu5C+eIIbgtYt+sLP55obdua1uY9wFeBEES0XHZWESmD3L88z2d3ZuwXhgtLs2z2S7nKT0TTvS6c4YNLYGjNy5L3QkHMAGb4e+2WiTuo1Ej3bwR8Sd8klA9F0wAm0U30u5PI4x1wUAHpFp4fFM7130NbCYQWvxk6XRbfKmFflArkuT3H27LI7QBlnWqe/e1WA8A06XREQRrqt7OxdYh7vVV27vVLkFe7feymJvcFiPvRDcQJPgXmc8+fnd6CmbYvVJ0V/gYW4mJLYLED9vwUUI3Qbl1j5OooRjdDF1d44GjZcnGE1skoDA7L26EIJdladhXgPsnwNOk0pxkiBowFnXT0rrxOKTSDAjtitNouPJWO2AhnZ4Y95Tyn7UJkjljkfhRaf3KmQnEkEJXZ/GeBGp62NXWSkXr8n1tUz8raQWOmohUbNPl7hwqr2K3GGcCEIaSXA8gwja+urFHb2wRg97KvgGqS7zgJrwfDRfeUWl1b6ajwa9EOk1+Xiv3tFB0uY05pCsPGc+ZNFMayv+zhi6DobB1bSAKPpqtuj0akgREfY6NZZCt2QoQygUib8zCAzlnImPMVFTnaKhhFOxC8kPZFmI+Q90Su9DQ2b6+gryKY6MdWS/mmdcMMQFQ4cB1vPvz6wCs3gYEGRw50/JAY4r+xMSeEZruOdorUV1Ir9DczA1RMAqUbFZ3/3QrwDOf2L0AEcvxgAMY529eAnI8RKOo3VHp3Rryip3CJY1uMpvoiFVLunN8bvYocL0+UeTFyUeVBspb1Qy/94ovQFJ/ji4+zsh3hZp/opI4ytf3JA8r27znpY9yrobsA/fVl29rPrw1dLmzdI1t3Nqd0A2n8muXce45yphK8DwIjUvHS3GoH7h69PVjUzcaZ8J+BeeEjZRUwEtW3VTvE4oS3iOUUwoFs2koC2QTPAca90WRpJOCXkyoxHuoNElQlO6Y2DARByaVpkAPdqkL1fmBBCukEY/xp9tQX0YrhXNoKUWbfYOulIVgRtiR4rHTODZr9q3phfgiW/RkdlJ6dxQZKZpofA4OrBdpIxDCD0QAbG0UeGAGuynRKkLTaXuYlaJWhhaKEKbejOT2jeTC3+avXL0B9YCP7d+ax1Uj1b0F+MrQc5F4vozGNdsUx6iDdEVzkSSoZNAlhF4Brxa4dVwtEIRiCkLckWirc10x0+yOzgWiGA76Nxnt91td0Jqj+D7TNscuvga8Ut3jf3em28Nh7ytXi/8oN9z4HMsNkc7Ge7xoSSFa9Zct3wV3NMtA4V+7bcXQAM2Ay3gpNtb3BvC/vEOvwYgwo2Hq+uqNaSWGqyEnwFQJoCT4h59PDn3v4zgKVv7mw/WSlLuaap5tZ0RwMePAndBapzfXcNot11FfLkB/v1IOHK3JksCKy9+sHl2M9wW2L1jr2vbEm8v0f3G/tctpG6DxfAbBFz4tx+8hz/wg86cuhG+8fvboNyuhDGObFk6rquc/AdQPwz7H23cfeU= +sidebar_class_name: "put api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Update Reassignment Configuration

+ + + + + +Replaces existing Reassignment configuration for an identity with the newly provided configuration. + +## Request + +

Path Parameters

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 + +
  • Array [
    • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/put-service-desk-integration.api.mdx b/docs/api/beta/put-service-desk-integration.api.mdx new file mode 100644 index 000000000..4f2fb8b07 --- /dev/null +++ b/docs/api/beta/put-service-desk-integration.api.mdx @@ -0,0 +1,155 @@ +--- +id: put-service-desk-integration +sidebar_label: Update a Service Desk integration +hide_title: true +hide_table_of_contents: true +api: eJztXXtTIzcS/yrK3B8LW9jYxsbY2STlBfZCil04A9lKwVZFnpHtyY41c/MAHIrvft0taR722Biylcfe5K4SPJZa/VL3T62R/GDFfBJZ/WvrQoS3ri3YkYg+sxMZi0nIY9eX1qcdyxGRHboBfexbV4HDY8G4ZOLejWJXTlihs5t1ZqM5Ozlid248ZQl1c9gt9xIBjdhPF2cf2NgPZ4xHLJ4KFor/JiKK2ch35nXGBiz2Pwupep+FEzZwZtDND4vDqac8iad+6MZz5kZEyA1hrNhn3LZFhPThuZBO4AN7dWvH8gOheDxxQKYgiTVRpJkXf8cKeMhnIhYh6unBkvABergOfOWiPgIeT61FJYHU/pikWqkbYE7pBDobjq1+HCZix4riuYejRO4s8LCBuA8834FHY+5F2MCeihm3+g9WPA+oZRyCJaglpz59i6Nsj4+fFHnQ7FtQLHYpsnoJTEaBsN2xa0eG61WM2j58IWOkwoPAc21qsvtbhKQecmxxzzsbk8I0g/7oN2HHS4papZ5XUcoUfa4XtHStzFAktqOG2rF4DMoYJbGI0HuDEG0du/Cpb8y3qIM1XGCHOkMl4V9slqCHCpZIF3RaN4OWGmDVnGIfkInHBVU8g6dcw/UcDNitCOdMIp1V9JARRWFTDhg2j/o38kbWDNkP/t3F0cn74pMbWcKdI8Y88eKMvu5apjrzFbDo30kRDsX4Oc51hn1AX64DPgvBAZVVdAcj+DKTZXSOLs9IdqQjZDJDRzw5Ov5weXL5C7paxn/6FDiHULHxCIZTCJv1gkJadq950ODt/THnjhDtRnN/PGqLRvPAbjX293o4kPHtzYZy3Cjw+Fw5eFH5SRD4YQyxA6znxvSMeh3FvvX4CZ7aHkyDZ5vjwk9CcCfd+aXGKFIptcnh6dXF5fGwaBLzcEOLLAxTbo+Ddpd3x7btOI1ml/POQW9/3Bu3x/vjze2xMNBqs1yG3JWYbn8eFEyjCByq/osmWp7Vh6lEmH3X56itUAAzNqRSyOSZ0XcgxcbADDxHEiNuf77jocNsfwbZ0B25Hrjw9vrQdD///fd5r9cjfQShsBEdqPwH3M+45BPhKNGiktCklHZyFD1TCPC4WzeCx8DPoS/H7qRuxhqKiKiCgNEOg/yRSTkVodhQVB6GfI7YIBazaNn6j8vi5rRybfxqr+M0e01+sN9odpzWQbvTGbV5a6+F6mrZnf1ck053P2vSO2jtWWj+ZTnLM/+r5YavmJ6Wc5OChQJoNn2daLUmkUJYKYG80qOcRtJoUJztkEEhOUXce0/6L/HUi3T0u6kABkIF44pswAPDiTJkwcQGVCo3gUDFlI3hc+jPSCo/nADaPAHcg7Zg0tBx8v7AODgAdPfvhJMTbeT7nuCSsAl3zqQ3NyZNs5wGbKmJiw6eH2NZAfAUHE8iuyBeyvlTDg+eBw4fA2xh7yGS+MAWQhZjTIe5Y7aofdQjsbrOlZ8Z6MeLWL2UyRemARP3EbFG2XiRHs9ZN57JExdnV8PD42Ka0M82zBIK5z97/MU0UjbdRzDd+eZp5McEXKqGbshHngarf4i1H4dsYMfgJewIQLcd++G8mHayBZOyt/W4hLbLcSXGHWM65UHgnmqyan93nmmkVYsvJX2ZxiGE2p1WzwaNw182h7zdsJt7zb28xtdqOJ+o14z3fs6MelB7WahPDaqFUbKk/JFH2J0eeQT8JUaNThP+sQx7GWXWBKZfQK4F/5SRaykEAdLJE+nGLvfc30V4QaoosyaEDvg/z8xHC2+G/cHPUgJM9Xo6M2gtrhlpmIAB4imPVUyOijHflTBHEpt8255yORHReizy5of7mYdLJaTw3atmvfGKgRy+Aw2/e3V1+a528OqH729uwpsb+eabo7PDy1/OjxUT51dvT08O2c3NjRVx11P1BSd28EH5U0OHuqPuv8Onx4oZIkp9kVv65q2AySvOcwLmqDD25ijT0feqLcs3VmzeTV17apSBrosuDJqUDgiq/iabzUDm8bz+ZjdPNR1K+cf3b765PjwaXA6u1RfuDFcLLBNUmbX++tv13+e5PAdfqQ9s209kPFQp+4/1rp+ZAs+z6Zjqwcv4eO5wi3yqf2O83mJFkbCWlf/YpxlWn4i42C7a2mbb7MFYDZL91kJX7HMWbG3X4SPk/C22zBVxm/JWP1IewwqU2SLZiMg+Te09eRnb/tZQevyizB7LP4HXx7y5GPv06fs3u3p+3EgV66Wfp26ssxzXPugMAuEyLV2p6Aa4VxIuzaYspRl+izMbupQMoFMqgWYpIKiRmygEGwkZA4XQTyZTBaZzOKAU1z6FY4NlBo7vA1eXlpZE/YgCafYDIZ0CRKcSLUrp7CjmYHBYfimZAQ2MQBaQeQpaLlaMMScobI5RzEPMMlKR0KUvYcUQuY7AkrBA5uC/GPkA6nu+RPDLx2NSGaUsXNq53qJKSFGwStmxsGbNY/Vor5VPJN08PjpfXoE9FmqTz6n4Zd3q7GdIp45CbihYjGWBGFUHjOlVLpVwkacZGHxRkjTrcsdx8Tvunefy78KS9MEkZ1jaWFS8h56fRfYJZR4t5SjMOs9ZMqzKXC9dHqzMhGX1ouHV6QLApCcbrgFWDrVYM2q0D8Roz+l07A5vdzsHI6fRdWx7dNDttpt292BzsE/kV1eKyjgauGFMYZEsk3fUZYCBTXQhifYPSiB/rpxNLZFgcReDHkQBeKiyW6vRWOnyyxRxU0hvGVXbDtW2Q7XtUG07VNsO1bZDte1QbTtU2w7VtkO17VBtO1TbDtW2Q7XtUG07VNsO1bZDte1QbTtU2w7VtkO17fD/tu0AFNtlOwuHnotR5zgMIafV2FDESSjVInTxsAmjgHSL/l1/zmbDejjpYBXHO6RTG08p9h3Em9okVFUfQSwDDNQ1BYpWM9SsImlQP7UrWgA0UW+yt9xhJiofamFQ8SG3PwOtkw2c64r2GZjpwlwnXf+XDCu6go/2G71We7zf5hxWks1uZ9Qb8729Rq/ToyrxTEQRrPjztSmz0C8O/W9IH6FrQ4y0CcA7YCsOuicGaPCSMtcKGxCNDfSPS0PVNhVT8wur1Pt4ByDq28Nz1u4yiNSThJ7zyYISZO3qAtc1ieehx6e5ShE+C92JK0tP7OhwcHT8bnB1eglPhsf/uTq+gL+Q1tIBrAEubxx0S18npjviWAtwxyNIuB6oQzh19lpTfQ0CYTrONXR1Vp9HoEymMy700KOX9MiTzipZZirRvLmP2ZZbF/UdSIXwDDIWLABGHEtluOSH5q8BNoogrp1qTb5mU1jbinC7zgZpZlDHxCLoTzUkSBk4dRWBcQJTWdC5MD+JIZ3GEByKtshUWbRGFlNO80bByQGcP+0nAzsGMEg+UZiFqbdoFrV9gGeluYWKek5ppNI5ZEtYN0JLbw5qDEOqTYBsbhwxHY7QXBEEHmnapRErH1Qp3L1XzKgACfGMJ9EG8w5gqCtrJFr6xa3Qky9KS64OWcOYSUck+BLFps66VWouM/HZ2BWeU83dau5Wc3fDubv45VC/T5GHPs1l6HMl9XFYTJ5L0Cck74FFiGmkML0y5A6er9UQ6aePl/oILq6Q1ALmC+IjlcqXmB+k9lDPRwg/UmMVbIEM3markjFEIuH0ie+MY1KUUtXe8mjv/HDkgoPKEogIUTNkcz+hJWyYSMKzPNphji8i+SpmUw7x0Rww9tMzxrX0kHGFJCskWWWjKht9HdmoQpLV3K3m7j9z7q5FkilXNFs0ToqS2YyHc+Vp+nvaLWDQgJk3e1k65VRVdgGtIDGWYiyriBysUas5ao67tmg7vO3s7/XGLXu/xTvdZrc5are6Vj7XX2fzOJ1kxTmVs7eyo7raRIS4GZFIcK4o9n2nWP6j163GGNZoJ9LgZtB5XdUhNXZsl+yf+DHIBoQBO4YryotXw1O1P603OkP94g3CbP0OAu24IKREH1Z36lTQsYKOVfqp0s9Xk34q6FjN3Wru/jPn7rOgY/sp6Nh+BnRsM4RYY4RYfyV0dFyHoNkYjAIy2AmoVyJsDEAU86JDOu1jHk5EnAK9Aops9UreLvR99p7LuQFLUaESKTN1YXjz6S3xee7dFQkcTSBESgZRywV0i17lzgRiUrym0XNnLs1jFAjohvPaYIznMNScMf6WjuJK20uAQwoK+JoKjnvH3di82gIUqA46gUD9BWuc2lp/qB7MhijxKUrMju9tIXDOp/XfTtlbAvg+QYjh4kLZesXrAqpmziUsI8R9oMJXCkErqF5B9SrdV+n+60j3FVSv5m41d/+Zc/cZUF2jodVQHRpsDNWhbb3BUiz1jl7d/rMR+0CdBCUOyL2ZbxNWdzIMDkqIBDx08bViGOQKIP6hcuVBEk9xZrqO7OsjazU8slbjeMF4Xx2cxGi0+H3ujWnT6hO+vToT4LP6cnEMVnhNeN/aXdU32n1wnUcLGUQkqpSQhB70mcZxEPV3dx/AN8AnHus8cOvmyL707+q2P9sdgUFKYp06uoR+ig3Y4PxEL2vqZM3Qpdf7aTYQcWVbc1VCeo5kLWVzFG0OKx6myOzgy87aeekxHVyWc3OzBTnrknwg11XoPf5xWRShFbKUqW/taNCeAacLIlrqJWXjTxcI89XoS16VpS7cYGgtDXaGzVrsreAhnjamd262fvp4uc0mCG4puCQR4mrh4moEpuc5uAgFz4F5/wQ7UT4zxywEGxTe8MHJysYeCMxu5IUQ7PpEK+EDZJUhpAFSKXYSFHmw16ctYx1H3AoPE2490yQ6HkyIXdDQLi/026bkSqsQV6qjC3gcAC/qUOc60eWpjRaRFpXsOjBy8ZxcL2XiX4ZaTVGrEbVoe4ELpdprW70xbkPEQBLci0hbLx5c0avl6OGSDZ4g1UUeUBOaj+J7Wbax2ov5KNCrIb0iHzfyIx3TK3ZjKn6xCBKv57ATZk99PxI/MIaug9PgepLALHoxW3Q2sEYzotZq5FiqqSFrbg1wKPF3ChNDKmfiI8QBBIN8VZGhKfkrWRbm/K90xObXgsz0+Bp/OwJaOr4dvZhnHLCGA9ZUDIg0/yobomPB3EYZKA4oBzjM7E+RQDOai3uKVmlUJ/K71AdTgw2sqrOqQV996GcBTv/F6AtsnbaBMIwwPn1TjS4kULQwJRaUZQoQixpc5tfzIRMv6E3xm26jYnb+u8mLEg+yOg3envClo/SKSPL3ibt/UcSrIs3XGGk0sMZ65zD7oZnj7CSfPum//l6ypeXXJneIpYcLl+70yt/bpdukl2MV7ihYc7dVekdBejPV4hVUmrK546l4+cHqS5pSwoW7lVbdnlN6Z8vf/B6HNdc4mGsWqusPqusPqusPqusPvuT1B6svP1AVwSeuDegunZR/6hD6ujPoOqDSmW4dTp88ip2G083OUiPEo6F01S8PLN/qGsnyXh1uJk8F/Bu+pQhEdTNux+q39rBykCeElzTR7/TRz+lNXUFV/kBwYmYH0Zw/I/QL2kLIjTenIaFJCG3oAh7ucXVlHe1Dm5E5gVRVzMGYSFdFJPqtSF/HzTr7KCgtJCEWXfE8Dnz3m6+rrxcw1c9xqgM40ACLHfqzWSLxOktgO5kxDjDuCRQGsdlO1GLB9qUURhc+lVvSXgY5I7xDEeh6AxHOorOxRiA5sPXEWIC1Ir17DKrP4aRMkKFQ90Fgu2Kp7CnagPBqU+EF6KGw0hEyyiOx9yeXSxSBmNSvLPjhZFd3inaxLRDRaRo67NUhU9eoRIeQxY9iACg54ub3IdehtoUbaNMd9K/kxyX1zMcC4G6A22SoqUQVJFUd+NpaWQeG/n0IFgChpqBbbPrwgJsqWBl9xMcgCFbsrz9lRU/CgxpfOOmlKSu1vDXUQmyzZ/5QZalkZptQzrMdAiuNlCAL3euldn6IU/WFftWgdqmuTzYdl96hQHCqeqjdpLVt84X38yt085H+1cuZ2qsI+R08xH/3rRv4H64VAqV4aETPHyyz8wdtFFlTJimrEug/wCDQ7H/r+v9q +sidebar_class_name: "put api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Body

required
+ +The specifics of the integration to update + +
    ownerRef object
    + +Owner's identity. + +
    clusterRef object
    + +Source cluster. + +
    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. + +
  • Array [
  • ]
    • 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"}}>
    attributes objectrequired
    + +Service Desk integration's attributes. Validation constraints enforced by the implementation. + +
    beforeProvisioningRule object
    + +Before Provisioning Rule. + +
+ +ServiceDeskIntegrationDto as updated + +
Schema
    ownerRef object
    + +Owner's identity. + +
    clusterRef object
    + +Source cluster. + +
    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. + +
  • Array [
  • ]
    • 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"}}>
    attributes objectrequired
    + +Service Desk integration's attributes. Validation constraints enforced by the implementation. + +
    beforeProvisioningRule object
    + +Before Provisioning Rule. + +
\\\\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\": \"RULE\",\n \"id\": \"048eb3d55c5a4758bd07dccb87741c78\",\n \"name\": \"Before Provisioning Airtable Rule\"\n }\n}"} language={"json"}>
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/put-sod-policy.api.mdx b/docs/api/beta/put-sod-policy.api.mdx new file mode 100644 index 000000000..fce0e30ed --- /dev/null +++ b/docs/api/beta/put-sod-policy.api.mdx @@ -0,0 +1,132 @@ +--- +id: put-sod-policy +sidebar_label: Update SOD policy by ID +hide_title: true +hide_table_of_contents: true +api: eJztXVt32zYS/is43IfEPaasuy2/7Cq2k7rHsVNZ3mzXyWlBEpSQUoTKixM1x/99ZwbgTZItOXbSy7KXRCKBwQww881ghqA+W2ouIp5IFZ561qE1T5NL5b1RgXQX1q6V8ElsHV5blxfHzFx8v2t5Yh4JlycCeiRRKnatWLhpJJMFtP1sXcUiOlJhIj4lwzSZYn/phYex8uw50Tj8CG2F9f6WaMVuJOfIAAw/nsqYpXMPaMeMs3guXOlL4TFkQHduvAtH4rdURtAiUoFgymcXo1c/D49fn543gOc5j/hMJCKKiRuJdOcc+Ni1QrgB36QHn2N3KmbcOvxsJYs5Xo2TSIYT63bXijT9XLplHgU7PcZhE/hUMMYSZVhHLsQnPpsHSFf4nQN/0O1098Wg2+u3nZ7jHHTbXd7rdwb73oGF04BDijh5obwFsrTMgYvTGSZ4i8/nMBqt2N6HGDn6vCqLcj4IN8HJiHB9EylivAuCr8i7LJ5eZpCwKkXTb7X8Nu/a++6ga3cdv2PztuPZ+91276Dpi47jCQvl4N5FGCw047fZlG85qJPGMhRxzLBXdXw9x/anxe+4Qi6MQ+q3SthX0YzDTFm4EnYiZ2JlNFxBvME+TkUIqwg6V1pG+GbIVzloN9tNu9mC/8bN5iH912jSP/9dJ/hMeaS6X4vHjP6jmKyMuWmRLugDD1jp8qoZVPkhgzZMizBO0WpdBTclD12yXVxRUJM0CLiDXQxn6mMoopHw1yn1ElvY8lnMpAcWAhjUWFF73X+jeIbO8fiCYUsSJExniF+nxyfn49PxT4h+hXD5VeB3G9Na5nTFyNruoHXQ5N2+z7knRLfZ6vtOVzRbB267CWhhbW1Q2VCejOcBX6wxqMt0PldRYt0CTWCGrlGv40ThOIDeIoLV1qYJKyEiAUv2ADXJKGTrH2U0qoz856f/mhbr9EDf+TEV0WLz0JeCR+6U/YatN2nmv7jrAtQ8l97hFtg22WHD82P2sE7+DmEVqDuoPiB2OEG3CE4rfsAslrsz1/Rnz1/LRE70xYzoTlXA7/mNAB864yGfiAhm/0aKjzQlScSBoEv264GHjeFDzACU8K6M2DtLpQnOX2Gp7ywm4LNaCLFulVwVQUSABIfejXyQlhRdGae+VSle8BjcvwqJ8czf4+eMnd1MwpjFU5UGHkg6Uyg6LRW05QniZagSlrnVkqwflMP8NCQGGutEixPA6M3yvJ0KIEhUSyAtQhjJRQEiZKAMKSfnLy9GRyfHcOn8Yvxz/rWCMPnV2ywWy/ngUcQXq24DGmXSZXxo3KxM67U1Hr5qwRX4q41DQjw2W6OVt5mvVdHp1rHDM+NAgYuniiKMs3sYE1mnL+WiqgpruLqRKqBAjHBzGMdyEs4A2sEgfTlBTpdJ3B+e8ZzCKA3W6lymPK+H58NXJyO4cjkejk+PrF0caSWcPhYJl4AW3EGDRpXIWY4ZeViIpg0tZud+CedO29S7UNOHm6/ApgDN0Wu/ilQ6R5U+NR0qs1vwdq9T50Fw4VOEXrv3b+/el1Xz9n254b/vV+xbvXvyQEnL0+IogGcerjB7LHyM6jGSJYjkGTBNecwcAeFtTq2Mk5ko2R7M52kAMbPPgxh1abtVf7s8JoCyDg8c7Vgi9Kk+3CJXanwG3WtYpVGtVyfnJ6PhWUlpiitHF+cvz06PxqfnsA09Ojq5vPz5xfByGcuz9uQu8yGHNOIRbogjye83jKraB8JPyv3ub72dXr0ob8ByP2JmBbiGbqmbsEDGSUXbZioUCxu22uQvNE9n2GiTv8JGFGmYTg3GYOcTCVwniF0kbTBajIceQNIn/NJrMnJWTOqYAHnBpVr2YHfMw11qU7hlMPmzk9fwt7WKpwY7rKqPLnpsiRRF+kBziamDj1MJoStt9PJAmdFmH0wHbHYVSA56/QO31x64fQCSA9flfX/QdFudVmd7IPk+BaS30bMhFlTw5HEsDj1YPFiaCOMAQKHbcvSRc1WeOz11mWz9fqvfd3pOE2Rr9ffdTlv4nRbv94s0ztIQu4+gun8n1QouLhkrporkZFpbYW2FtRX+cVZYunV0p2PdFPIUWe9ijkhVSySZpsn0ntQ0hyY3PEhFll/denehBS2RtzVF+5xTPjDPcW5I6hWJxg0Nqzr32nRjx6XLa/NueRxcXcW79T4XjsJHRvLcl1GqpoDW50u+ZjpjNXvxzdMOJstQzgpktReDGe8rO/Fttay8cd62z+Zt7fJGtbTne1L9yfchrKxJ1e1HZWN9ZyS+IeZejqXN+LlDXfanj8POR4IkANeawKPCMij8k/J88DieB4TguHCvBKwjD9aB5xPD037/oO0P+AGpV2fgNnviwG9x3384PJ0D0OTwVElIm29mSynRaaBVcMPtHVB2tC6lux6HjpazowUwvF+LGiXLoJ1yFTW2mJsyYqDD3IwHupVZjWJXfI/B6R60Wr2222p5DmBSpyPsrttp2YPugNv7/b476An4328VK2bUZ4On7Nmt9rg1OOzuH3YO1rrIpRa3t1o7IxHPwXdox99uNlfVsiiEMwcTPFZdm61rs3Vttk7e1rXZujZb12br2mxdm61rs3VttnbvdW22rs3WVaG6KlRXherabG2FtRX+n1phXZt9VG22fPnPUJutFj9KGZdNOskuRmxzs/2VTM6mutR2dAc7dxdj6rpyXVeu68p1XbmuK9d15a9VV+6uKyUfQVAYJuwkigC9bTYSSRqFoJhSOwRzIpg5yqPMiAxBoyVlPp6o4uxRBvJIeVtEwS9h02NPIi6RQ0Esu9CRAcUb6aG+zRTsSTTJ3Kdhu2rqC2ai0YIgzWMjI9+REQbjvYi7vwKtbTLJV6GE/izrAkFAvhlbM6zYF9zpNwftrt/vct4+6Lb2e87A551Oc9AbUHZvBqoEjndzHp+URbosUC6syO8CXTSHuScGaPDtN1tEY4v5x5KzbpuLafhleM5+FyKYF0dvWHefBTycpHSdT5YmIbSvLtelfjXhC4B+ubbUnO38jk9eDq/OEJxHJz9enVyO70htD0PQVg/VElgFXZgqHVAZAT5yiG1EANMhvAb7zlD9DgSCeKvcUOpv8SKGyWQm3wc9zOhrepRJMz9Ss4opufqlBOy5bIjGLnPw2ownsGNzymHZdwgr88Q+MzP5HZvC7k9EOw029DxpamPkXzAZvwBCAKIemq4m4KdgysCMTKYYIUKotlI6K6ZypQxhNj1n5UVB4wDON+vJ0E1SYI7ELFthri2GRbM+wLOeueUnA4pJoyldgO8BxIWWwSKrCjIHZJNJzAwc4XLFADxh1i5HrPJejuDutWaG0t2YD+FpvIXdvQkAfmwSLb9xI4zx4fbaoBGtRrZMBpHgJoX02Nm0ypcrM3wGUB54te3Wtlvb7pa2u3xzZB6gM3cp9Gmthj5XIU9hfiNyniuhj85thopljfRWTS/kLpaFTIj0w9sxGPavIqRy/qc57oWfMD7SrnyF+WG+Hvq6g+FHvliVtUAGaR61BD4gkfAOie+C41KU2Fkd7aWKHAkKGq4JEQE1I7ZQKeMwZVEahlQmi3eZp0QcPkvYlJcSB0rnJUWIr+GRYVJHknUkWXuj2hv9fbxRHUnWtlvb7l/Tdu+NJKtVPxMnxelsxilZCppm7qO0nEEDlh3lYLnJlRLCRbSCxFgeY1nVyMFy2i2n5e+7ouvxrtfvDPy222/z3n5rv+V021gTLXz9dWHHuZFVbaq03nodaYohiLuBOC4NQbniRCmvmv5Lsc7jI6wh9ORxM8x5w2S/dezYXY0dz1UCsgFhiB2jO9KLV6MzXarW5HHeVBrh4/9RXtfGkhOGlFR0Ep/0ow116FiHjrX7qd3P38P91KFjbbu17f41bfdBoWN3U+jYfUDo2GUYYvkYYv2RoaMHcQeGZj4sCsjgpjC9IYaNcxAle2wgN/uERxOR5IFeJYpsD1ajyLFS7DUPF1mwFFcykWExXQhv0HaGbaOsLTTgbAIQGTJALQnRLWoVHp6FmBT0hwVyJsmOUSCgGy3soZ+AVNpmMn3LR5GhG6TAIYFCoDD3qkDHJKiT8DH8AwqUB50AUD9hjtOs1qPywWyEEp+hxOzkkysE2nye/+2te0rgNDQHNS/1Wt/xuIB5HjiEbYT4NNfwlYegdaheh+q1u6/d/d/D3dehem27te3+NW33AaG6iYbuDtWhwdaheg8PW7A8lnpJB0e/dcROpmI4IPVmyqVY3SticIorQJXMb/EghuBP1xxae/nP5wCa7H2W3q2FP7uDMaFmJ40CaDZNknl8uLf3GVYJVue2weeykR16DtXHhqtmew5MzRrUwYdMtYVhAzZ8c2o2GA2a10ii6mqcI+J6lrNDuDHMNj1XcC/l7NjUAvYeTJPZxQNjRo3oMj7dDHuIZ9mrhnBWVuQDua6i4PbxsmhCd8iybvruHQ3aM+B0SUQU4X3xK0mXGHDr0Vd+K6lwIpjqb68MdoHN2uyF4BG+0YKefnn+w9vxDpvQM8xo5nhEccKETPTp6jegIgRjw+xJEOxEniVS6WRKjA8rz9qg2TA/AIHZu/BSCHadvU7gHPB9BIBMU4qdBGEA9nr/PFsdT9yIAF1fo5hJVDzphXswQ3u80m+H3BztB2SoX7+Ep1fehTY7luYpdX3uxohI2zt2Pc/k4iW5vpSJf2TUbE3NJmrxzhIXemqvXf3stgu2iyR4ENNsffHgmp5dooebJ7iCVJd5wJkwfFSfkHKzVftiPir0bKRX5eNd+JZOOFa7MQ1Z2YGlU+ZOlYrFPxlD1UEzuJ6kYEVfzBYdq7TJIux2s8SSrYe0pQ0RIfF3BoYRamXSb9aggETp3AiZ5C+0smDzv9Ch2V8qMtPlazxUCy095cZfzDMOaOOAtsaA2PCv/RIqFtg2ykA4oBXgqFh/QgLDaAn3NK21qE7k96gPugYXWCUq8fxQfzksAM58YnQDW+dtAIYxoM6fGYPvzNBC51SZrCwVsDyDq/wGCnzi0rxpfvOCJvrJP5u8KPGwyJjgC2aeGqXvQJI/D+7+QYhXI83fEWlMiIuZx1Hxi4cn2WYkP21YeqPk2mhri7cWbn2i7553/uTnw/I39jz+pPRXfKFdfcZ5+Yzz0pvUvs0J5Acp1D2Hjrc68vitzxh/63dLbDqR/JcXEDUA3S+plcmNlJ3+C7N/Xa1oYMltKuBPuEuxC2UXwJgpG0UWVyY0B9VHL09RjjuVgnKhc8ET3AvvoqdVM4pM5pFCJcPXgiGhCR2DjQDCecAdGeCL3rBal43MKYDQG230c/g9TvN3orhTHk5Eg70FAAhdcFOYmsJTC3DvgzI5qkvwVG/Q0bHjzPnBJnQ2S0N8WRuwnc4YgMImD+nJ2E11IAc2E4psLhRthfNeWVSDrhdFaFCSJprFFz6W2TSMbTkW+MHY1Nhg6kv6WQgyEua9ftCumsbYRBu8rz0VwRwdDwAAQHvZS74+Ha9QVIj/urCrosme6RTvYVt8LSIIr9Wn02g1mjalT+hVrnECoFwifkU/ZVx+sXH2wuulFxPn1cUn+fVmY2OYENmbYwIfuUt1gkanwq6tcioMuhyCCQK4TxUZv/X5M2Z4MTl0i5d/0y4Yj7VneR+CCJhi/FycZ79TrOeGY2+HatSbf/t5rQxZqSJcFFlKCz7+KjBAABEI7HT2mRjUN0y50x7rlyplHVfquIhPuofOaN/b9n0py/jmCpXIMT88PdP50oh/hIv456H1Dv5F9zfXKgyN6Do4HpMzhzaabLZBXLc/Mh9gHaDZ/wBdTxDc +sidebar_class_name: "put api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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' (put-sod-policy)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Update SOD policy by ID

+ + + +:::caution deprecated + +This endpoint has been deprecated and may be replaced or removed in future versions of the API. + +::: + +This updates a specified SOD policy. +Requires role of ORG_ADMIN. + +## Request + +

Path Parameters

Body

required
    ownerRef object
    + +Owner's identity. + +
    violationOwnerAssignmentConfig objectnullable
    ownerRef object
    + +Owner's identity. + +
    conflictingAccessCriteria object
    leftCriteria object
    criteriaList object[]
    + +List of criteria. There is a min of 1 and max of 50 items in the list. + +
  • Array [
  • ]
    • rightCriteria object
    criteriaList object[]
    + +List of criteria. There is a min of 1 and max of 50 items in the list. + +
  • Array [
  • ]
+ +SOD Policy by ID + +
Schema
    ownerRef object
    + +Owner's identity. + +
    violationOwnerAssignmentConfig objectnullable
    ownerRef object
    + +Owner's identity. + +
    conflictingAccessCriteria object
    leftCriteria object
    criteriaList object[]
    + +List of criteria. There is a min of 1 and max of 50 items in the list. + +
  • Array [
  • ]
    • rightCriteria object
    criteriaList object[]
    + +List of criteria. There is a min of 1 and max of 50 items in the list. + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/put-source-attr-sync-config.api.mdx b/docs/api/beta/put-source-attr-sync-config.api.mdx new file mode 100644 index 000000000..2a272747f --- /dev/null +++ b/docs/api/beta/put-source-attr-sync-config.api.mdx @@ -0,0 +1,113 @@ +--- +id: put-source-attr-sync-config +sidebar_label: Update Attribute Sync Config +hide_title: true +hide_table_of_contents: true +api: eJztXOtTGzkS/1dUcx82SWEDBkLwlysHyB5bScjxqHwA6laekW3tzkhzkgbio/jfr7uledkmPLJ1m81NUpXYM1Krn79utUdzG+lcGO6kVkdJNIzywp3qwsRi5Jw5nat4X6uJnEZrkeNTGw0vIn/bRldrUSJsbGSOk2HqichTDneYmwnGYbocF04wC0RmRiv5H1qFxUSw8GuyiTY03hJVZnMRy4kUCRvP6fpUXgvFjg7YjXQzutKenxt9LRMYLxXdNeLfhbCOjXUy77NjlXoyl5FQfJyK5DJiQD5NmJ7QjWuewvhy9mVU8W1hJDeGz5m0LCsczu4z0IrIQGA1ZU6zeMbVVDANU00tsWUgE08SpsRNSR8G30v/RqYp8G2L1CEfXDFhjDb9S8Xgz6UawezfQQmkgeOTn/81Ovhw9JHxws20kY4YRLGlATUgVxzouRlcHX066oPlrIgLHAjWu43OrTBgUye+uBFQQIvKRA2Rrx6aquct0fNqHmZc8amIru7A3Dk3PBNOGEuUJBo950BjLVJwA77JBD6XvERDZwoBy8czkfFoeBu5eY6jLKhATaO7RQc6q/2ACIkvPMtTnDGI9zbfbLzZ2kk29zb5m9cbmzvJ4M32zs54mw+2BnsRshdM/xYsj4stshGj0MrhLZ7nqYzJgdZ/s7j27TKXevybiF20yOSp91A/G72o7ekr3JsHoVqquYiqi7VLYEyBQ0NAOgnfkCs/6EGuzriZCldqj1a9LwDRI9qLeNKL5llc4uDsmOEIipynLSdUkRF0HJ+f7B+ilLVpwzVwBrD5g0wAEDxj+cf40Rj8iCMb3pUfYuQfBURGzwieIDAwnPRNnP3jhI1iB2DHDsBBYqfNPLoDbpx0dL+EY4++yGfDbWpuCVGWmB09AYwDAscQghAtCC8NYAswGXv8IO+vnVsCNNpnBFBQ1kIcZRCkCLMr4kmt4G0huMiIsLK0kJPmH/23kAIol6GZlsPtcbb/WBp7JlZzUpsVIEWmhHQNTh4ONT+49qqHFzosFyqFrBcZa50KrpZXQSjPpAK73swE5TDQrtJuIYFDIglEvYO0XajJBQLtXaXdJ+mxdII41oVyjdUhod3MZDy7Rwk+wfocOm76N5YEE1abvFaV19S9sVUFS6h87hpzL0oXCYZdsGuwQsMIPvWUCglLr1VUJtJYt8JXh9E7vMMWHHc44alt0qPqiAbdXd0vUSnIHQ6BQiPXynp/H2xs4H9ts5znCXegvqeUcA0Y6PJsl2e7PNvl2S7Pdnn2/zjPbq9KrfupBMWyQ9zfsx47Ea4wymtwsXmB7iAVaF0m/W/Jqu3AS4QD1ezr5BHR8Q5ctjc1XCKH1JIAkEhEaLkgZmTaCOZJlv7lWxctPwBN9DfZW56AvF6+/SAMatLw+HegdfSIpHSuJMxn5RTw0qp9tGJZsSv4+PXG3mB78nqbc0g/m7s7470J39ra2NvZ28PVM2Etnz4C2X8WShgA61THYBF0ekhJNgAlLf41YG7bgGg8Qv/YDvFjKzEDvwyzwhrkhLf7n9j2Lku5mhZ0nU8XlKB656fYnynSFH27wg5P+NjIqVSrWClLiYPDd6Pz92dw5eTwn+eHp/AJaS01/0aQLFSCbgmsgi/M9A1xHAS44ZZZkYI6RNJnrwLVVyAQV7Y5UPpvdm5BmeBbE16kDmaE1VfMaJJmE6OzViiVKfSF7Iv+GkAXXMu4A5wbcwsTtM+0r0ZxLHLXex80+YrNoOQQ5mWfjZJEopA8LZt5GaQMwECeNPqOkwJCWVCPThcO0V3Gom2LWpVta9Rw8r5pFAwO4PxhP4F6pgDmykqhCofKWwKLwT7As9dcm7uzhtJIpXPlOFRK2E2cgxoNVksM8JpJZ1mAIzSXBeBR5bgKsZooSXD3wTNz4DTdi3lhHxF3n1KAnx6JVt24FiH4qK0aGsBojdJMAZFCz5UmL7aJy8D3zeAudrvY7WL3kbG7ePMkNBTCXSp9Nld0FVT4wQKT51LpY8h7lC5/1QjbJm/INayXQ4n0y+ez8HMIlstfctyI/IH1kU/lS8yPKnv462P6Aag0VssWyCDpMWykAIlEMiS+a45JUV5VW8urvdNmLMFB1YoSEVDTsLkuGAeVmUIp5ITbNZZoYdVPjs34NZX3wK9HQNpWJL1cS+W6SrKrJLts1GWjHycbdZVkF7td7P41Y/erlWTFFUVLqJNskWXczL2nhfu+Ow4DWPnTFqtCjky1WK0gMVbVWFG7cojGg83x5mQ3FtsJ305eb+1NBvHrAd/Z3dzdHG8PdqNmrr+o47gKsnZMNezt7eifchHmGuq4QoFzWad10m7/gXqNmCCsIfRUdTPovE8NyLJ23F6uHT9qB7IBYagdzT3txfOT90gflibyqDffFcagJdXBcO6opKQ+tfgiretKx6507NJPl35+mPTTlY5d7Hax+9eM3SeVjtsPlY7bTygdtxmWWBMssf7M0jGBugNLswkYBWSIC1CvwrIxB1HgU/vp+vC4TFnotarIwd5yFXmmNfvA1bwslmyrE6lqdSG8wdgMx5pyLD7EHh7cB9SS2j9sLzOBNSn4D0tlJimOUSCga+a90cSBVD5m6mf5wypSxWkBHBIopNo/fH/DJbiTmGD5BxSoDzoFoP4De5zBWt/UD2YnKPF7lJgdfomFwJiv+r87q54SOALmDcLFqbf1PY8L+J45V7CNEF9yD19VCdqV6l2p3qX7Lt3/GOm+K9W72O1i968Zu08o1UM1dH+pDgMeXarD2P4Gq2qpd+hc//OKnUIlcEDuzXRMtXpS1+BUV4ArheO3iCF4qHIYrftq3a7fyuRuvXoU1x/TjMtzuX5D4PkrTArzZs7ldri+fgtmA3Pd9Xku++UjvUrf9GOdrY9BVytgCJ869SGHA/AEadhx9EnRRqIve+Aj4l7tJBp6LaifHjT4KuXyces5iMc8mTU88hD8ii4DizlsKn6yNLpPfrQkH8h1btK7b5fFE7pHllXq++pqMJ4BpwsioghX9WHcU6zA/epLR3LrrIK9/8HSYsc4bMDeCm5ge+Afh3nxy+ezl2yKdSfFfWGx5BXS0dlk9glchHBtVD4agpMo1RhdTP1j36PWwzcYR2ySgsDsUp0KwS6OghI+AuCfAEKTSnGSIFDAWVcvSusk4lqkmAv7tSbR8WSi1kFD67w17yXlPdogSAUfM39241L1wkENifkbxwQRab/HLvJSLt6Q67lM/K2k1vPUekTNvlzgwqv2IvYPc8cQzEiCp5a09ezFPb1egx7upuAKUl3kATUR+Gg/MhWXVns2Hy16PaTX5uNSfaaDAu1pzGMYs5AT04QdsXimtRV/ZwxdB8PgYlpAFD2bLTqd0KOI6A02Giz1/JI92YMSkfh7D4GhvDPxMaZoqlC0b5ZQSP5KloWY/xU20An7tSUzXb6ATIojEx3bZ/OMC/ZwwZ7HABv494kKHQtiG2UgHPAOsF/bn5AgMNrAPU9rJaoT+XWag6khBlb9+bZ86L8Ma4ALnxjdwNHVGIBhrLCrh8jwhQKBFmarlrLK3sCiBpf5TTUkyQW9eX6rXzgxcX5v8qLEo7qFgq+U+KNR+h4k+X5w909CvA5pfkSkCTUvtiJP6ld2HJa7kxWHccPZVX909eHDpdXrSFYe9myf6PyuT5qBwBCTpIiwg2oiwdtQ1C73PbExPxPwL9wlQKM9COzw6rfoNAkBkw5Dn6AvnklBHZNccHrpzRqGn84IrnKjESPxJCMSmhoYA9hmoXDnY5kCPerplytzQhVffaPz43dbhCdMytfn9Nln2MSqGIyOG1h8thnu/abDTvYUFPwJvZ8dlBEBlWmWFQrPJwLbRcY4xN0DYQO2iAuP7rBzUqLUhX93TzWrhDqMRxShT1s5k9njCTbjJbpl9Mi1IDhs6MSD6utjr1EtyIlIKXxxXHtv8xBtCMneTKQ5+jOkJqhSRWOFD0dnSxSBmAo//2gzXQ+T7DqOBSK4h/Tus9Xf7G/0aE8F13NtHWz6G8T9+wFYfdgZT0Cy6j1RLV+8rX+I6N4P9b2+HyqgLO4/13NsoKLdC78f9q2I8i0K6KdDejfT6m4E7G9n4C844fYWm264Pb/Dy6B17OhcXNU7bwJf8Oc2Et7rPi9Oggwv6WfD5ouiVgpQ9onVvG4RRfDxd4GdJZhHAOtbf8SKvxF+a+qdzalILCcu/YiGmO9n+HbiV8deNVo8n84xNsfhLVWZb1YZfgMX8d9hdAl/4YvOPTLAILp+G5WtXxjjyZbF+KpaNHwAjcOw/wLNmkr3 +sidebar_class_name: "put api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Body

required
    source objectrequired
    + +Target source for attribute synchronization. + +
    attributes object[]required
    + +Attribute synchronization configuration for specific identity attributes in the context of a source + +
  • Array [
  • ]
+ +Updated attribute synchronization configuration for a source + +
Schema
    source objectrequired
    + +Target source for attribute synchronization. + +
    attributes object[]required
    + +Attribute synchronization configuration for specific identity attributes in the context of a source + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/put-source-schema.api.mdx b/docs/api/beta/put-source-schema.api.mdx new file mode 100644 index 000000000..b9945d8b3 --- /dev/null +++ b/docs/api/beta/put-source-schema.api.mdx @@ -0,0 +1,116 @@ +--- +id: put-source-schema +sidebar_label: Update Source Schema (Full) +hide_title: true +hide_table_of_contents: true +api: eJztPWlz2ziyfwWl92GTlCVb8hX7yyvFVhLt2pZXx+TN87gciIQkTihCyyOJ1uX//voAeIj0EY93d2Yed6syMgk0uht9oRsAbxt6pUIZezrou43jxiqJRzoJHTVyFmopG1uNWM6jxvFVgx9HjeuthqsiJ/RW2Am6jBdeJLqXffHN833h6OXKV7Hy1yJUK186SshAqO9eFHvBXDBYaBovRLxQIkqmSy+OlStWcu1r6bbESC+VmHnKdyOhZ9TK9HJkEOhYTJVIVq6ETi0xXqgobS1DJXwYCKBNla+/tX4J3gjPxX8DuVT4XydU2BF/LrXrQUf43Q3WQgISy1UsYs0v1jhwBppoC1WU+LHwAiIpDHWIj1Y6gHZEkRRRLOMkAi64CpHf29lpAQ9XMoTxYxUiJ28bHrJtJeMFvELE4K+IuAtTsNUI1T8SL1QwG3GYqK1GxDNxfNuI1ytqG4fAysZdeSKAUwRH9E9xWPVd4mTAq45z1H6783Z3320fteXbg532vtt5u7e/P92Tnd3OEQCrRovGJrQeQGMT4wq0eAJ/HK1rhq6i+J121zj65mCODmIVxPhKrla+55Awb/8a4eC3ZbT19FflxDgpIYp+7IFMw1vPLZNWRYnnFoXyh/lsWPuUsbDlQ6NJx9EJkE5AY++rGhBtYwL8owMwXwR2EjqgRwxURGtQqSU8kTHrLE8mqDdIP7A+KmI1iVSIKHkuvPPidTcGBKZJ/AycpO0qkgiUGnTTkb6T+KDC9D4JPJANwSOBpoZiBjoJymmI8YIcwkUso+55l9l3gfOByuRFYK/+leiaEcRX6QPWT0bVZduZeNFCuRbbBVArQ2fxMvh+W2iwYYRXlE2s0NAqNBhGZPdEOm5LDAIy8r76KgMynPNQJytDwoZQLNVyqsLBjAQjcPzEVZcqXHpRBKhFOdSnWvtKBiXc3/tyDhi4pN/gSL4tFCMXCvQJSI6BK1YZ4MzRGDaD25DYF0iZz0M1Z2D3cH4m/UgBwjPwGUmo8mjKMJRraOuBZkRVnFdBskS32Z2MP/Yuxv2T7rgHj08G55eDUZ9+n/aHvZPxzWVveN4fjfqDixE9HJ0MfuoNb0YnH3vnXXjSu+i+O8P2592L7gd4czYY/G1yCQ8uBjfD7sXp4Pyme3LSG2H3y+Hgf36G/4563eHJR/gx7p1fnvHYk4uzwcnf6MdoPJycjCfD3unNuDv80Btj39HH7rB3OehfjM1DhvdTH3HrX3yAPz8MB5PLm42Ho58vTjafXXZHo0+D4SmSPBkOgQM3uUeA7mACjwYXZz/fDHt/n/RGOFj39LQ/BhDdsxvbInsJxHY/fBj2PnSxicVldPOx+1Pv5rx3/q43HHGzHEM30YK3hoQH21QxqKJZeQJLbBj23sOMTSb903LgNKAf0hdWvtjEQpSDIU6UrFY6pFhmjXaCIwQKafIydYwhkHlp+0QQTEVRM16APs4hKklAvsFAsmckCKkYVnfHIE5HINv2DYVNtnOZ7GoooQKqAtSvU3DYTpxTeAOnIOrVQMD4OfqrQq2yloUsJ1jYECK+wGWrwxBZVe5BRroIw5shM43nFBC5qkBOfeAywISx6DfBKmpbNXK+1l8QKFi9pQzknFDCaVRrCkZVQMMoCFfYes4UB60wrhexXVoZToNN3tRnwmPzYQETV4PUoP0zKIkQOKKXSJ+KmD04yFzFHBq8ei0gDl1oiGijhU58V5iAGhwVMgE7qO8raMn+C0wpMHtJiJBpKYyOkgrTACECEC0FBFTf18atsecwMis+kcG1MiwWWfMtIWnREAQwJvREPCJgpqus6QaNMN2Qo8BJkiVEz4g3EpgBwOHxCSOTUxq2iPjLmkT8zTbxPvm9R2R87XxhiUkC/t1iWGWr8ZhmJAF4jMRB9XfFWIYwUyzKJWP8DEjs7ZAjowUw71J7QdwS/ZhXMzDr4LQ85PiaAxYwNN3TLXF22r00A0V25lOjVhKAKUw1sYqE51uIsmx4FbXER/mVHSywzZg54YF39ay1M3P11UO7kIonchmbqSUYLlQZQBqcMazNIDYwPVkQWMaZ3LzjR9SoxzQHH9VwxupprCzzzxhZGxEYO1d2dk8i3tijlyKdhGHTw5YQSeGkvIewPXBARQKdRP6a59F44Ad6o+P4pkNXOAsZzGH+xQjCKtuY2RoosMdMtW0ebTGdXmpXNAaHUxMJg+0DDf01CRxkbhaU5UmyPGL/tBEzHHNWwKCMsVaUmjx0DjPj3Gxk6yRhiAGsxY+8ZkXQcZ9S0YoTZy/lJuKsk1jQmoYnh5Xj/qDlceCu65kQINUYY/Jzoc6x6KaEk9xv2vxKuS0GRgVUltpVYGQ5WufAPFp4q8jmMPhRbnVgloPcwQTSoSQLDxihX2OZL3exRpM7Gc+nZjNaT1DMbiU9nT7ADYyW7bhJ2wPh3bHo8/Igr195z0LJo0zUjf1Af1E2H+TFUitG/qsc9pDSV8kwp6LMKmpLeOQ1QBSTJfmtKtzYWJWwy+FkuGdNiQlWDK0EnOJJQsqRoHdRrrcVO3TqUxoa1MY4eVCQL4IWMkWyDb8fDphfnOvWfP6/4nkuhn3K8uOY0eLFZurNTb6VfNmj80YoP6BNFpdH1jj/DkwKiYSN9TQZY3jMec/3PE/VqdHiKiuXyLKmuTDQ1ebS9+GFZdVi9PqOspMzb55whr0qC1nE86OmPHawhig8DqUodOdwbhP7pVwLkxMtEHDbIKE6J2OeSxKZVEzjDrBL7XVVaqPMwcy8u2rmBeS7wGssPGeBUrzcyKNs5kbuybw+Lx+a4vJYWi++JxtqEzSgajyFZwP6D0Tc8O+7weCs172oqnZg2tFVob+m6I7SpYwSp/WYHWBcUp6fpsy6N2eaImHluaIzpXXv8on4ImZdgD6DpSaGa2BhciJinLENIvRG8s+k/ZZyBe8Qr4fnyzK0zBfLDBMiTBVyKEXKzSCXJuFkcHEBZmaQpr2u89wpvaXs8tNkxuDSP+UANWMRFQvQGujKFP7+wVtnv3PkHOy04ZcjD2ZHO057t737Yyn8RbKUQRNjZXQcaQa4nHgvIkGqCyq6acgeG7JbGjB7/YjmUIBY0J6sJTE8Ok/82HuZVG0mfDAnS4TbJCl0y/lXhD6T0CTLx3pRL4vC/wUIYXUvG+CJKH2gKXthZDJ7YYNs8MvkcTF8sWusz1gJ+4xL288F1nwmYjDGMS3evAFf++YNDhIypdZEkEEHh23TJ5mQ/BI8Tv/dg4YLpSfzq7dpbbFoqlPjkNpCI3E/kWCkQ29MfvrU8N9MSDpKWngowy+VBkt2hs2MNQlvDw8O27PZW2enDb+me/iXc+ge7GT1UqO3m3P+YWOpVSaOa5kbtNmHhjT8846CCi5iP80Cubb6ZEvvMrJVcJRs9NsyxioTPGnGHs1EzhrutI+a7U6zszfudI53O8f7b1vtnb3/RRptAf35ePgSomML5gew2W2POzvHgFDHYpOTQLNz4Y6sp63Pk+fq7OxUO64cSlFCqdNZ4mc7GAi1us5c15nrOnNdZ67rzHWdua4z13Xmus5c15nrOnNdZ67rzHWdua4z13Xmus5c15l/9zyv68x1nbmuM9d15rrOXNeZ6zpzXWeu68x1nbmuM79AnXmvqrR8AoYf1pY9OineFEObA+LcUBq2T7W7pmxMALbJe8lis6ti6fknsA5/nHfvQS+b81CSevLhdjrFTssWyk8uNS5NCKS18dSuaN/xyHtbvJMu0Mv0nRhikHehdDCT3X/CZE646Gq7YEXcWo2KYdWhktODnaPO3uxgT8rO27324f70aCZ3d3eO9o+oIr5UUSTnTwhCP6hAhZ6DCViYkX8CQ0CQgfeEAA3+9LCTYDzRi3PblEyDr4ghSN8CG/ru5FLsHYI0B/OEnsv5BhOC5gSLU0Hi++iWjS5vGSQGoTf3Kr27jY9Oe++7kzMMTNOCGMIqRafdwLoWQBVkYaG/EcaGANpIoXzKn7fEGwP1TZpVTRua4oSp/BtrDz3M6BU98qDFLNTLgiqR3nyPxSuvpVpb4LNQ72UMgfJUYoLQRKhvwCGoVdw8M5x8IxYQyKjwdUt0s1xZGq+S85OuyxlGBDBLaJ1uk3XgUD1nI87JWFmcjcyAnOUnBZUDMH9C6OXECSBHZOa1MJUWg6KZH8CZOVeOwizTiKXrIJZObLL0jg4pQwH+VXhUpyMNprQrGJ7AtkstVt4ukrk7Z2ROY03vOGfxqN5d+mB+mkRa+uKrMsoXUaGIrJHKpzSNRTLLDepsWqXTZRWfb/OodbfW3Vp3n6i7my+HZkOdeUuhT7sc+kwC3A2gQ3KepdCHFwWBFrYR5514IrdwiWJCpL9+GoNif1EBVdC/r/DilxeMj9iVV2Q47Hzw86ndu2NdfzYXiCDxkSmYgSVS7jHhnWFMjGJW7ZZHe6/DqQcCGlSEiLj7QKx1wjXpJKAKrIy2qDgT/CUWC/lV2So8WUDaaeA2V1SDrSPJOpKsvVHtjf403qiOJGvdrXX3j6m7D0aSKVakLSZOipLlUoZrljTzHqmVAhpkVy+mKkdTtRmtIDCRxliNYuTQmHba0/bs0FF7rtxzD3aPZh3noCP3D9uH7ele57CR9/VXmR6nSlbUqdx88zxyuQP3LoZczotird1i+g/YG6oZFfXjLCSGuYMA7u46ix33yrHjhY6BNgAMsWN4T3pxMjzjchSDR75xgU6H6WGMwn4fuqyzDh3r0LF2P7X7+dO4nzp0rHW31t0/pu7+UOi491jouPcDoeOewBBrhiHWfzJ0dD0+QTODSQEa7LbzdNuGyT4atTc7Xm2gV4giO0cVe6q0Fue4GdAES1EhExlk7ELzBm2X2Da0benA0RxMZIB7Uj3NB5e9pcKYFIvxvrf07GXtCDdcN7uzGKhinbHylo5izldGZBR8jblXDTLm4U6vGYZ/AIHyoHMw1C+Y4zSz9ZvywWKIFJ8hxaL33VEKdT7N/+5X7RLo48EtNBcjnut7tguEdstQEqQnp9IQtA7V61C9dve1u/9zuPs6VK91t9bdP6bu/kCobqKh+0N1aPDkUB3atnZEGku9p23D/+6InVTFYEDiLbRDsbqbxeAUV+AB3AZ9bQltCH5y57ixbc6+bt/ajwHdbZubCOCR+RDPHbTnNQGjmIQ+dF3E8So63t6+hZmDGbtryZXXsvfiBPpby9HL7Smwq8ISZVcEYAP6kBMP0CJehx6dRCNZJeDMebMtuxHBDNBegwch22MIayBMMJit3KFweox3QcC64i8RtW6RKJXoA7omoX/322lhQPfQUsW+B0eD9gIw3SARSbjG6QIRAEA0X3hp0Qkbrm6C0351nW9De4oZw1LLzPlgiaBTQmiAzTrinZIhHpilXTOv/vpp/FrMMTwl85BEGBkrD9cToGCXIEZk/rp2Bwl2Io+U3XnQLezRQXUTM/y4lvglGCklrvqGURfgF4ZgyInt3cJdINev7Ay66qvy0WW2Mm6jcHpusA1c3C7eIfKa3COtI7yA92zzAd2mueojO83JJNKyUFytLF0yR9dzkfgvC63J0JoELXq9gQWz9srhPd8O6DyCkH5E3Hr24AyvmYOHiy54glA3ceALSwiP4s4qx87as/EowGsivCIevwSf+EBaoZu9a8Ac1u8LZ6F1pP5bCBQdVJWreQKa9my06BRckzSi2dnJodTkIZteEyJJwu8MFCNgYZJT9OQUyGjOqZDafqaZBbvwmc6Kfi7QTI+vwOFiS1c70bNxxgGbOGCT7URk8Gd/hoIFuo00kB1gATjJ5p8sgUE0ZxsZVqXlJ/Db1AfdhwOoEpRodcx/HGdG0PwS9AJbp23AVDfoLjiz1wwvVDGw6Ixnnlk2hbDJwTK+vgZfusE3xjcthKJ//b3RixR3s0wLXlH20lb6Hkvy+7G7/yGLV1uaP6OlMaExZiyH2Qcfe9kp8/wJufvvvUxPyNk7K6uurOSrIytvjiyfFixf11hxUWL1PYn5Q4FVlxGaM4XZtX8vcRlAxV0AjxzQL57Prw9O/saDk7lzk/cfa8yfanzguCHKzUwTB8yiOm/135lFTjkVHtERSPgX3pLzomUpLPqzO5HygEDAY75YAdycA6JMSbQVUIELpi00tXpJrmkVavSHylziMydKQ9Bh6cup5wM8+01eGlmSB+HVGBo6/DtKzKYjbS5/aolP5gq7EHMauN0d3v2qTXJjBKaKrhQTp9b6wSpkuUwCGA0dVbIUEmzsIyYSL/hL2JOby1mYBL5BLu1l3RraXiSB7ikApY0GM6zPeI7KWcJHxgJDGJniDLAeZ9FIYUbIUPmkptiuuNZ9DDaY3+ZC+STMEIbAikTlRjjvj0sQAVhgKoI6nG+bTtE2tgUgmFNg8dlttVs7TVpjw/OVjuKlDHLAJ/T1ZfutYXPO9tX7xPdfb4ribVaaqj8U/fiHoo2dw0X/9gqT2zgBCScqOE10ZT4VjQJznPtqtMkU0VP70WYwRQuYPOx0e4tJUcyd3OFjcLCYcbu6ztIiZPntzZS5A/j3TOarofkO82sq6xa+O11JhU3kB+ssh9eAn18Upv5SStAzPB+L/Gemn4OF5Rwdf+c8MfGFX5vCZJOiiKx7qeKKNHAPzj0/2PY6lw+8nKDWTs2Xrpec2QzlN3iI/x43foH/wx96xTYDGtHz24atE0AbBov/+z9sgISP +sidebar_class_name: "put api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Body

required
    attributes object[]
    + +The attribute definitions which form the schema. + +
  • Array [
    • 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. + +
  • Array [
    • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/put-source.api.mdx b/docs/api/beta/put-source.api.mdx new file mode 100644 index 000000000..511f63b26 --- /dev/null +++ b/docs/api/beta/put-source.api.mdx @@ -0,0 +1,190 @@ +--- +id: put-source +sidebar_label: Update Source (Full) +hide_title: true +hide_table_of_contents: true +api: eJztPWt32kiyf6UP98MkOYABv7kf7iGYOMzaxpfHZOc6Pk4jNaAJSKwedpgc//dbVf2QhATGGW9mJqvdOTNY6kd1db26uqr0teQthc9Dx3O7dqlZWkbhwIt8S5TKpUBYke+Eq1Lz5mtpFAi/7bmh+BK2onAGz0qO7TYDahw0F9zlU1G6fbwtl0I+DfC9HCgowSNbBJbvLHEamGQ4cwLWuu6yaGnzUASMMzkOc1zWtYUbwqxX3kOZRYHjTuH1JJrPmTf+TVgh88XSFwE0IqirrOsyL5wJnz14vh2UGfxm4osThNhVwvDRtTx34kwjuVIG01veYjkXoZivcMA5t4Rd/eh+dAfeQrCJI+Y2gOUDRItFFPLxXDDu2sziruuFbCyYNePuVNhlFkTWjPGgiZ3fMMfGf4erpcD/csCUByiEWe/pAYDhwho8P/VHe86DAJ8s4b+4imtv7liOCHDMVhiKxTIMWOixhWc7kxWuMDBAPjiAGkBINA8RfZwd1GpM+L7n03pa0O+zcKFZOGO9/vld6+yye1Vmg96o3+7ovzxfPxiM3tIzA/sKseWLf0WOL2wEwuIwYai2EOYASllyny8AmX5AtOLgJi85UEm55MIL+MuxkaCsmVjwUvNrCREET4PQh00qPZZLeoJSM/QjkSUYoXaS0UDiC8fdgzcN67R+UjvZP7Trp3V+clSrH9qNk4PDw/EBb+w3TktIkDi4CMK3nr3CydfnspCs3RBf8eUSME9EsvdbgHN/zUIt6RCX7SPzhLBR+BYgy6wM5+Z2z52v8heGtOrYzJsQ1RrOy6zv8OjEOmycWrA++GXxo8lpzarvNw4QdxLF2anTU72PgEcrCA5RM3bS8wbZeS9XGprHtYGeOU/i5ZbpSCLAP/ja8vylB4wKfWGXkD9WVYTCe3CFj/On5+uLifCFC6QBtMlhkgcXGV+LEdbTu7V99+Tb9cGR8PANgq7Ez1jg8L6e1Y5HNggRbrRAAdg961wNu8NfUQLGazVPYU35NJOGoXumEeeoNT2DQur730whthOAXFylKCUXgsvVFY7/+AgzWfMoCJ/cJhwKRJ1nObDNNmurTtk9iln1Ri6iLCUJtbv9HnvYvhgNhp1+egv1w2fvoGVWmtnAo6P60dH4cFyDDawfHVv7DTHZr/OjoxfdwDwA2obh9EbQVnLL8iI3hLe+mJNIbJMSfZoFW7InS3Rlsi/z/jxubLXbvdHV8K7d6/c7F61ht3cFv6/edc/Tm7ul3bP3W+EQZZrBhDRFcnmYtJh1eCq12OHJ/nHjuHFwyF+UBHaE6UwLX3YjBXblqHFydHybt7ubCKYfzXO2MU0uDBsBYDxE64rZHmv3Lq8vOv9MAghm1syL5qApQZWi+RUFIDceZmDYbCJTHO2nULet/ikk1x9ddNLERU+eTUY+4jGPYI5rJ1bj+OCgVqdf/IQfH9VAgrwowWRm78hftHNy66X57yc24RJMKZwvg9F3zhxEjFLLch/tCEFjapAUYaLRy0OwsB0w4RfJVvd8DkadkjjG3ldvfwo0me51Y5W1nQAUIYG97TvjKNwBd1dJrtLdEKIIzXOwqXNWVGVIUgQ8NIlcJOkUW8YDkWWvaR1GnXve52hJjeNlao1cTe2Qei8pTTb4xnXp7ukFBoL7sCnEgKG/QszD04kDy+Fm1fLwFsbL9b1FcqkGog2wA/AwszQxNtJXLvHtIHcQjuyo2LEshUxCwrDAIXqfSNJ1AhQsQTSZ4CHNDQvZ8m+VLWMBrCSufe/eCWBcmGjD9ho94kduoNmq3T6nkzscWr2HgLjSAiMHZMnvXB9KlomxGYAIveWk6jyijunkNoBxCm3yb95xeeJO4LHEfZ+jBHdCsUg+/47YBxPwqtMe9vp3g/b7zmVr7USw/vbZu6LcDDsf7Y6Pj190X3Lmv1wN5EPalfSIF6BwsavBHali2V5hN0gOdmNAzKBKYmqbK2fc2G/w2Jmk9Acs/48OOo4HnfpetCw93j6iOyvthvtrEeJ1azD40Ouf3V33LrrtNefC+stnk+ES1/wMD8NLk2HO/Jcrdq12hF3L1zsT5Jqn4Tq5sytNp9V8Ql3HZZqk0oc1+CXGtcP905NaTFLxwToDf/mPzHKMSDez/CJcG5RTZgqk5IngYeTnUnAaez36wedM94hPZGCBBtESFoIIHK+Ms76awwbZQ/do+B7dXe3WsAOP8WjXG3Tp91m3Dxx7d93pX3YHAzhlD+jhoN37pZNg485V6+0Ftr9sXbXO4c1Fr/eP0TU8uOrd9VtXZ73LOziydwbY/brf+yeicNBp9dvv4cewA2dJOffo6qLX/gf9GAz7o/Zw1O+c3Q1b/fPOEPsO3rf6neteF47+8qEc75cuwta9Ooc/z/u90fXd2sPBr1ft9Wd6U3HJo34fMHCXeKQ9DL2ri1/v+p3/HXUGOFnr7KyL3obWxZ1uEb+ExbbOz/udc3JIaFgGd+9bv3TuLjuXbzv9gWyWQOg6WPBWLWFrmzwE5TTLbmAGDf3OO9ix0ah7lr0Feg7JuZrm8JYkSVNNOk6p2yPVJ6B7lEo4A4k+ndFFBp5hpFufRjBkmN8d74a8AGhbv7FAZJnO2WXnj+ILWBWZlNKVci38hROgmRmocVKknj8IiEjLuxd0PlZmEdmwcDrxAzJsSW/JESWrbACG2ziGM0Fk6rMmGLTCRVFs4w0QzEW/aaw0t+UDhwdSHBQOpeoMBiCRE39Fd2cghXEagRdHdDU1ETA6Szr7vaXCNEjudX4mONYfpiCxPaAavJBTIDEfMAKHTFifCCR6cJKpCKW74dVrthDhzLMD7U/St3lk1lMH8WUJLeWJGzQ5IHtBgJBoSc2OlArbcI8aBhYHmv/LijaHu/JCUtEs+0CnSE3DbBY3L+O5JHHCQDgCQKYt5IUdcYTqhhgFTBItIXiKvNNHFJye1CgBk2AaKRHxlxaJ+FvKxE30u4Fk5p71WVJM5MrfVTlWVmo8xRlwUAv9yEL2t9mQ+7BTkpQzwvgbRmI2DzlhZDAD5F17DpzVWTc0jhVQWg5iXB32QdC0zsrs4qx1rSYK9M4boZYhgDFsNaGKiOfBR1pWuAqq7D2/lz4QQJsScwx9CY6Wdmqv5PHTkCdimVwOCxBcyDIANJ8HHrzGwyn1lIQgaVwudxkLGAKNeowT4yMbTiR7Kikr8aeE7HTqi2ks57LKbqfFK3n0UksnYljXsBlAzDgG9yxYuRawiOtFwXwl91Fp4C29teWvrvdhGQMHHUaKHKi1K0Aey1Xr5hR1IIVanp/aIQf7b5FrkcdBcbZIEZbGkdRPazZDk1FYggIZba3AiDxUDhOl3MwtT+SDCRwa+Ehr5hgdm5iKrssp8kJjE2H2opCRM1BujmSOzUbL04PbtqNMAMMxSuQnTJ0ma5mFE92vy/xcuk0bRilQFp4tQMgSnQLRLcagtmbOUq4R3Zf0KOHvVJ4k2UEHoXCS8AAR6jVJ89kuWmjKTkrzickEDx3Su6op3WwfwAZCyziD19a2xbxrsq5rIx0k+SupWShyJSZ1JT9QX2TFB2kxI8VIf2XNHmL6PBqWkTMqSqfMHNIaQIrRgvRWHmxSWGWgS8CksKdFiTJW1FppcBlkIMN0gO+CRG9NdqjUxzQ1sI1S8sAgnxkdZNLLVvjebjC/ONa1+PyPwnnCht3l+NGUYMnDptHmOowLddmT+0Ygb+EmDcsTZ5zvAUnKF7J2ntb3IzJW553cJ/THxO6M3PNp5ixtDsxrDdfmyz0Am5Mtehy0x2u7I2gANjZoLSGloPaFBasASEL5wuSJAuzx6rTKWhZG0DFzJ11mH4CCbA4/RGhVwUCasJUXEQ/IwxqFDZ6JubNwkObeOXOtAMrUchEBZQZCssUnwwQ8aAf3nxgQrr9iJqwNSfYTxm99qrLUdvSWwiV7saJgQ9wbJnsaD23Dj/IpucLSO85p6RUTC5WagSIHn54GtR+GUK5gYXyOiLdTTref+T1nFo4lWduopWBNajh4mptwaw3GgDvzJZnXpmkV0WKWlwLa3PvlOlA3IkiSjMVSoZz/LZnOdkCp+uqGEakJXX/w3xSYX0szwefhrD0T1uehsxBg0JSa+7VyCV0EA7rSTMJ2U7IwuDGiiKMFLBEInNyOGDc6nIGonXnzpHMVsTOl4Bo8NfJQPtpvZC9YIzIxCNwawlqv1dRZzzCGvFv1WPDZkXe+cl62hONjel312qNcggk1TcA09rw5HBoyIHyQV7cRxtzGCswYSRTzqZ3RygWjb9KvfW8C7FSlMSc8msNCJ6BLRAIm+tvczSIpIcNKH/v2i9lL04OZLupYC0CZEMnv73c/R2fNVeuq3ZESPe14z7x9tuc9RhWpR4mrXf3wDfjfi/rhn4TmcpW7VdI1Lxlt9Y10yJnqH4eKbiQ07IpXhkD40Q6SEM4S1FLFNQCn+WU2deioaiSM40r+JZMczmuzVSJCPTDAAU2CcZdCig6iHoK6vHvfaV0M39MdTICnyB3kNAglgG+xxGPkA5kUKgBBeY5oZjicggBjDzxgILJD7aUSa5HRtUa9UjutNE6G9cPmwUmzcVrdPwGaOTrar9X+LyWRuzsQ6tCEKsf6bWc9dbUTWeIUqWBFI/xJNuKCrZkHBi7uypprNm0lrZkLCVig6XAnEyUpLOK+7FVswaMQfJ2aF5+kEZs63+2K5oS+TZ8P14LfbW3eVMzEiA2x4zSYe1EJgeSUromlP2FaDZVQZqbDOqE1KjX4BwjtoHlYa9b2qyeNY6IwSlhwXgYgonUz4C5gHVRq9Upjf1g/adZOALLqySmC9ZgbVyzDy5PW2+26fV1poHSj7sESjkdS1zRqtayqGVFmi62zFrQDoOWuYqeRNF3IU4TsLk3hGbnN/dUSe1vOcib8CibdlFOedTxU2oKaVUiEpxNnwJbzIrsy5uh9Qhe1Y4mgjIIi1Uon+GCQvjN1q6UiF6LIhShyIYpciCIXosiFKHIhilyIInq1yIUociGKXIgiF+IvIluKXIj/tB0vciGKXIgiF6LIhShyIYpciCIXosiFKHIhilyIIheiyIUociGKXIgiF6LIhShyIYpciCIX4gfCeZELUeRCFLkQRS5EkQtR5EIUuRBFLkSRC1HkQhS5EEUuxF81F+IgL/2hPcdgINbBz1CAPdjXrjVHxT2o09DYs+nzEo57D6aY/YIJCLYIwUhpe/YO1P3OcUVl6nMHIaQvZwDV2cohR27fBca/yCE1P8ovbKSwDJio1tlbbsN65fraajF4FvC5hRcEu9D9yHWgP9NdUNRoX3bOtOJY8PFR7bRxMDk64LxxclA/PhyfTvj+fu308PSUaE8EAainp+8+zwXsPIj9uWfBjvwOCAHSB9wTADT57hf+NMaO0kW2NctU8DKV+cLetq/ZwTGQvTuN6DmfriHBrYzwzs8Fyx71uFGGcuCe70yd3IQNbdGcdd61Rhd4u2juGXGszE1dy9XKGUAFWtCJO2oByJwBGKcWuarfqFHfGGe1aajufNQxT6l06KFmz+mRHDqOH9SsZMlv87BXTlVUy2DLoYCgaFGZBaS8cG9aliWWYeVCYfIN6lFb+K/hXBm7IFU86YKT35bbtnTchnR0IveH9oGC0nfWT0AxKtO7EYuQi+SmIHMA5DvYK1YIJzaiiRQXGmpRIGrjyVaYS0M3TCCNULoCjWKF6vKDolPRFoa1OXT9SRxM3mwQPK5uZyRWMjKTxN2lBOYs9OiddAU9yXfXcxA/lOgVZwndC8V8FL0hpZFIeoqVRFKhHdRZtTLbpRlffi2o4N2Cdwve3ZF311/2VdKnekumTz0n89NV7gdUnhnTxyfqcT39eS0VeCs3kr7DpUyknz8M1Ze78JrkyxIttBe0j6QqzwDfMvshn4911LpW/fFeIICER7mCCUgiYTcJ7hhiQpRE1X5O+oPnjx0gUDfHRMSgDuPG9COXLrZ5UKY7L4w5n/F7oYMbSAJSAIddkb63wpIsLMlCGxXa6IfRRoUlWfBuwbt/T97dakkaqIhblJ0URIsF91eS0tR7XC1+3XWf6fIjcQY5bdW6tYKDMWNjldKWQ2ncqI/rk2NLHNj8wD7aP500rKMGPzyuH9fHBw0Mqo91/U3Mx4bJ0jyV2G+5j4RiCgnF2EggriD0PDvt/ovwa74TipUIY5MY9g4MuMfb2HY8yNqOV14Ia8Oc0UocubfmXhz1L+R1lhwe8abKsfj6zisdRkWps4XpWJiOhfop1M8Po34K07Hg3YJ3/568+yzT8eAp0/HgGabjAUMTi8py/Jmmo+3IxCRVT0NH8/tChfcq76NiexVIrA29lBXZOM2JgvIoyGqljaUg5Yl0Y3ShePOw/gq09XVbyuOagoh0Me7E8WTxOryzrzBKdVUhCbLOCYzrryqtCcZQSp7R9GZmcVxrHgGEJBTmnqwk8sCd0NRgkPVF+BQE9Qv6ONVu/SF/MOvjii9wxazzxRICed74fw/zogS6GEGJ4mIg93pDuID0mXMXjhEmIc2YoIWpXpjqhbov1P2Poe4LU73g3YJ3/568+wxTXVlDm011aLCzqQ5tqzVmbKl3FBv+vS12YhUFAZE38yyy1e3YBie7AvOaof0yIhnCwxn8sadSive+OvYjPJamv4Qk8ufQYhaGy6C5t/cVNgg25rHKl05Vl+NzvYeq5S32xoCVHIETF1jABqx13VVniyqh1Hcoj49IkgaXCFYh9nE6z9aRdaT2ChbC5DDlREo9PcZKGnB8+ClQiU2IkMz6YF0jf/74x9ciB9qwljz0bZ0N2jOAdG2JuIRb3C5ZRpwKXsnZRwGWEiQp1Ypwj2P9gV7+bBZQD5s12FvBfUoxw8CXVz9/GL5mU7QwicNlDUXh4JEAeOQaSIQkWEsHgWAnUipxNYhWKswGOYZN5rBg9tEdCMFukuXQ+yCLCaWtVJWU21d6d2xxL+ao9arJJK/FnmO7e4ChvXR1ldey7CUeBRJJFNWPrs6Pi/Nc5RJlnt7NUq+LJ9b1rUD8lx6tIker0GjB6zUoJGpvLBm2bQHb4hB8HhC2vnlyOV4lMR6em+AJjroOgyzlQnCkg6MsvWvfDEdqvAqOl4bjo/th5ljr5XF0FQZVxqCLCRdeIP6HMSQdZIObaQRc9M1gPeCkFeKISqOWAKkip6w4FTAGCb4LYAxXEhMfozImW0SVGSWW/EQ7Czz/ibJoP6XWTI9vQGdiS9uzgm+GGSes4IQVKQMCBb9USUhYwNu4BpIDkgDa8f6TJFCAJuSeHCtXqtPwe9QHVYMFoNIowbIp/2jGAk79YvQCW5s2IIZLVCxPhYthqRk11mOcMfi7qpksvQDrGMzCO/dAHa7hTcJr7jJRRf7V1osrbsXOEvwkw0tL6Q2S5K8jd/8kiVdImh9R0ijrFp2OypX31rNXnTjZWpUnjL8kss3Yyv3oR+KbH4pHzbcz1qokbvz4RTkGQ36kIvWJCl08VH3OIT3o5g8y5BR4NF9O2P7dBDXhlk8MbCv/mPwigIHheXX6t1XpV8BRUeE1MDZWBjZgpKv4PlERPltq3VT9zi1Ynqxnvrna94vCv7nq9ItOY0od/23q4+aVx/1xaqYmS6Z+19Ippu5AtqRIqqJINs86Ww5kh3ocG8tx/PESGTkVMuq1TIEKlce/oT6EwkWmqMIOYp8qISTE/oYqBYkaBdJ3pysI5OfwmxT+J/Pq19Lqt+6XTIvPpqtns9VlavnWzPL1dPBENvjmHO1kivaWlGnAO5iVtDPK3Zc0Zt8qv0z2ki6gEvrwb3hLNjk5zAAlcRG85EBLEOhovZL1bs0cQe79JawCfTxltCC9BVncS99DM1+oqm1TWilW0eFzPnbm+EEMvIDWM3MyjKUDib4G4GNJOhUO6alqf1X2QdUs9dHbiok48O43T7ldB0DeVEOSnWmjDnTrYhG5+HkMADtaMA6m4xOWH1Z0jeQBRW2mXIIsGWp6aWsdTUpcAn1yQPiLoDcZyI/bJQy8J+YC+y5Q18aA+oRtFi+kr3Qptku7554aG6zKykzMiaVAiAo3SFl/3WFmRBjMVbEKnj/dU52CPWwLg6AbVJLPfrVerVXILYhV2b0gBHGRGFx+cFB/b/DVu2g+f71Og1/j23JpcOKhK6KOQaKqR+pTgmWFe05Fk0zJv1T4RZV1XbVnpgKkiL9DI2H66KaKFdEHJDxk3FDMV6ZMWBWPIFTgkS6gFLUCYRHVq+Jqrq5US6Rql4F88UgVNLHzG+ZQjUcUm/jflKzFB0ZspP4gdYFP1jU6jgliXiyWIREqyYiVYmUFJNVdAoTgiYCCQg5qNXX1Tt3VUZlou9c/v2udXXavykxJV/UX1mZV4nb0lp4Z2FeyBpGs00Dcguf5UG1hlU5CSk2gy3VvibeDSCeRdAFLP/tNSfnZoXUTdAfo2RnQEb74+hVvjtDz/IiPqeQXPL+Nncpk2OiqyEZlbSSvV30F7WuKfVFk6dibANWXne4qvucowc/PAq9HoB+VcJf3VwSKfKECJiqkGOKOmUgQtJdkD3kntrXtbeKe4nqEPIt1KihORt64+PwBHuK/m6WP8H88nC2lxIBG9PxrSd9fQhs5rPYz5blZ1A/AODT7f3puZsQ= +sidebar_class_name: "put api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + + +## Request + +

Path Parameters

Body

required
    owner objectrequired
    + +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 + +
  • Array [
  • ]
    • passwordPolicies object[]
    + +List of references to the associated PasswordPolicy objects. + +
  • Array [
  • ]
    • 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 objectrequired
    + +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 + +
  • Array [
  • ]
    • passwordPolicies object[]
    + +List of references to the associated PasswordPolicy objects. + +
  • Array [
  • ]
    • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/put-tagged-object.api.mdx b/docs/api/beta/put-tagged-object.api.mdx new file mode 100644 index 000000000..01ddf757d --- /dev/null +++ b/docs/api/beta/put-tagged-object.api.mdx @@ -0,0 +1,83 @@ +--- +id: put-tagged-object +sidebar_label: Update Tagged Object +hide_title: true +hide_table_of_contents: true +api: eJztW21v2zgS/iuE7sO2RewkjvNifzm4TnrnRdrk8oJikQa7tETb7MqUjpTa+oL893tmKMmW7aS5tLjdLYwCjSQOhzPDmeEzNHkXJKmyMtOJGURBN0jz7EqOxyo6G35UYRZsBU6FudXZLOje3AXXTtl+YjL1Jevl2QTfAh2ZbibH3ak0cqyC2/vbrQDvjto8K+F5uQAtkXKh1SmNh9GuJtqJPI1kppyQIvPkCZOLUWJFNlHCpSrUI42GbJaqJkRKpZVTlSnrWChNrFIJcbYCgwa8ESXJHk7UVAbdO/+hG7jMajNGizL5lCTs9fsnl5e/nl+cvRmcnqChd35+Ouj3rgZn7/DW77097w3+QY8n764GV6cnb/EXb4Njfv8Fjxdn3PHy7PjX8zP0/YVfri/6JzDGVmDVv3NtFYyb2VytWkCxWiIZLamfJYVlSGP1RU7TmDTg0e631mqto0d0fpIog2MWBE+FFFaNlFUmVA/Jo0Z7R6NOe699qDrt/YPWcH84PGq32nL/YK9zGB0F5A80sHLZ6ySakWDLcoTkUSajJpmmsQ7ZH7c/OpLrblWjpPTN1JL3Zlo5avWfL9To66S+9Q9zi0UDLnSpz8fx1Rm7Bs0cZnaNtHX6lbnDjH2e6HCCbwiz+UyyjWGHRSlaYWf3aOdo/+Ao3G91woOdXTyF8mDU2Ql393b3SAjvZXeByeNYDqmbn77HxfpnjszQsEpG1EdE2qWxnAli9g3yvtdxrOVU4C95yf39fZl1KjNJa+UMnXSmpm5tPNQFPZVDFTuSYliOGdGbNKJKhpUAN8Hr61/fDN713vVpls/7AwQ7yaAzlq+WRO9ZPKtcmhjnHbC1s0N/liKwlgCGM58ZpIkQlxR1mzjZxMmPHyftdaHRxygmEyfWAhU0xIXKcmswrvaWKRYYMcQKI2AUbT7JWEffMWgilUkd95NobTzUhX2jjWqMrdQkoWKRQ3QU4PhJR+ghponFFDPLcnKZrr62whLNXfFaRtDX69cvlCELWhn+Dl6DJ7j8tdHoL8ouQkcVulozrDpUcniw02m1RwdtKVtH7d3D/WFnJPf2djr7nQ6NPlXOAe6t86P60P9QRlkdijgJMSP/gUHg4rA9C8CDr3G9B+aAeTzB/oRkPG2lZiGvIOS6Baj5un8u2ocilmac83c5XjKCaVxfErSqBTE094zPrB5r81hqPD5507s+pWR3cfKv65NLPBGvFQzcM/DWiNwSosIXJslnlrhQ4LN0wqkY5lBRU7wquL6CQtK4RULt39zMwZjwrZHM4ww9itHX9FhkLUY2mdZCKfQwX7zQTdXcQqzj21RmSDtD6WiVMkz+qheGKs0ap4UlX4kJUpiyL5uiF0WalJSxQDSCKfrPOGlEEYWuZzDKEcoQRmeTJM+ESTIdLmHMuSlXUmqRRk4XJ4WCA5J/3U96YZZDOFZzMQorbylELOYHMnvL1aW7WjAam3RmMhlCCxnHM5jRWl7NoZvOnCjSEU2XQ+IxJV2VsRazI6e7t16Y4yzhtlDm7glxdx4j/TRYtarhkyqCj7O3z0Y8G+U0FRkJjaQ2dy6oqukqA1+gIoujTexuYncTu0+M3eXGi6IgKFoZ+uyuQp9rI3PY1/LiuQJ9LHuPAfwqiBjeFBO5JWCQAiL9/P4Kgf27MkSvvqRUgH9HfOSX8hXhe9V8+O9Dgh/VZNXmggRkO3oNRshEKuqy3HOJ2VDeVHuro71J7FDDQc0aiIisacUsyYWEyWxuDEki3ZaIEuXMT5mYSORHiYhwzmdAGtVEjTTRJtsgyQ2S3KxGm9Xox1mNNkhyE7ub2P1rxu6jSLKSiqOlwEkun06lnXlPK9pJWylAIMqtaVGFHE/VMlohZqLCWEEdOQTD1u5wd3QYqnYk29HBXmfUCg9acv9w93B32G4dBotr/c08jqsgq8fUwnz7eWQTA8R9Ao7LDZzLZUkS1bf/cv7FitIa70iWuBk2h0lvK+zY6qzZfE8S8VaaWYmQXA1DmrmNKKeBdkq0tqQFgRRj5EUjkKo05CJX0lMFLhZOI2I91Ry8pAX42lmjN8qgig+U0smqUbQJ4xwSciaIE0LNCRxLQ0k1IswHDoxgx8jO3xGdFlP0TUheXJDGp6SxOPkSKkWBXiH3/XX7uwMIbylHXPoJfmCj11c70sABUBD4nFXhzg0+3+DzzRq/WeN/jDV+g883sbuJ3b9m7P4P+LxAQw/jcxA8GZ+DtrkjKiz1hpzr/w7TOVQKCdi9RRKGueXt5hKDM66AKxVHDimH0Em2brDtD8E1vKJu+4584377Tkf3AZ1FJHDo5cptDPpJlqWuuw06ZTBN902Z6iayGGYsm5nkczNMpttD2GhN+qFzAj7UiED0zgdFedFkA1tNPuwTHjP35maVyFthdt4afpRzeXxjluRIccxmi06rFP7EnyFiimLiJ8fUTfafFf2g17WN779dF8/oAV3Wme/R0UAvIOmSiqTC7fzo6CUhbz/6ygHS+WpC1VprZbAzImuJ10palAX+B4wXP7+/einGhDc53nNHUFdpKhAQMedwEc5nvXIznzrxEmOTfDxhwXu1n0sofsQohsLig7lUStwMCiO8Q6K/QGZmk1InxcmAet2+KGcnUp9UTGtgc25JcjwdmW1YaFvW+r3k9Y4LA23wOOWvzQ+mIY41pSFN6zbRFCpynSdu0lIvuaDXc4X4W8mt4bk1mJt7uSSFN+1N6I/fhAhiYiFjx9Z69uCeX2OBH1VR+EJcl2UgSxRy1H/kCstZe7YcNX4N4leX44N5zyet6t2Ez13CYS2MIzEQ4SRJnPq7EOQ6FAY34xxR9Gyx+HhXgyOi0dpZEKnhh2zoBqAhy3eKwDDemeSQlmZGJglAm4l8SP7GM4uY/42PEv5W05k/32AFJcooCd2zZaYBGzRgw+cAV8jvFyhyLMQ26cB5wDtAfz7/nAkKQRfynue1Nqsz+23uQ0tDCFGZi0u7/qU7T3DFk+AGoq5okIYJWVc/++FdFLxolaoZq9wTWLbgqrxxgsVxyW5e3mpPihbMP5u+pHFvvnVyZuLZ987SD2SSP0/e/YMy3ibT/IiZpsC6tAV5Mb8DcVJWJevPYi+cdKbzzF8/c1xdAFk+7Tu/ibPmFC64Iwp43KJWWYy91wWMXN1hpC3wicL/aOUUwmgftRRXhwyuFhmlscwo2DjZhBOteG8iVTIjSLpFDp9MOUGkNqGshAqUGY0taJBNHKCyHOoY/Hj3vBxZchx7vEvuRu8ur45IhxPUuqop3qNcNCG8hUpFOv+Bto9JUTNewmHOyd/EcemDwILTaW4wGqWLfCokPP0rjhppF+Y+n6JyNKq0RcKItOpVJheKAFKhyUWTnbqzEW17o6Je8MevjAV3dMWeN0zPx829D8wVuVAxBwzR1auJr/FGEDQmKk7Jg7AYABeqhRHeDq5WOIKZcdArVM3EjreLTm6baMGEqjbvPnvN3eZOg6sYfE8Tl6G8XmB+zXeMRO3m2LIP3s23+p97hawINapDtlPaQCNpcl8X+VL0JqiXoujULa6VdRGWKG8mEJ7o7u5or4Wqs3v6jDCnQv7mdl54ccEK49IzInqELLR8/WpRpxcXxQWpl+KJ98PWqlPuGprZfMMgwOPvivYZiisT3yDXUy+LPUM4GPieMpTfpWLz+YbiZ5HGlZ+JsuPK7z2kmO/hd74epb1d2I04vybnHhY31aZ+X8XKz/hI/3eDD/iHlyT1oUXX2ej7XVDuUoLmY3XXQj4An4oHeAnI/gv7Ee17 +sidebar_class_name: "put api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Update Tagged Object

+ + + + + +This updates a tagged object for the specified type. + +## Request + +

Path Parameters

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/put-tenant-configuration.api.mdx b/docs/api/beta/put-tenant-configuration.api.mdx new file mode 100644 index 000000000..bbde93e6b --- /dev/null +++ b/docs/api/beta/put-tenant-configuration.api.mdx @@ -0,0 +1,103 @@ +--- +id: put-tenant-configuration +sidebar_label: Update Tenant-wide Reassignment Configuration settings +hide_title: true +hide_table_of_contents: true +api: eJztW2tv2zoS/SuE9sNti8ivJE2TLwsnaXdzkW6zeSDApgFKS7TNW5nSJamm3iD/fc+QlC3ZbpKmRbe3MAqkljQczgzncYaibqO8EJpbmaujNNqLitKeC8WVPcjVUI5K/yjaiCwfmWjvKrrM9Ud2KrgxcqQmQtnoeiNKhUm0LBzpXnQqiownwjDxWRor1Yh5lvGNTEVjLGvMwoywRG7YjbRjZseCKXGTTVmh808Yms4IWhDIiKTU0k4h1G10YYQGLys+235pxySoTNWers0VWy9EUp9yryxSbkV0fQcttPizFMbu5ymY3rpLqQWsYnUpNqKE+ENfPOJFkcnEcWj/YUjp28gkYzHh9MtOCwEz5IM/RGKjRet8pS0wHupjjawUhrh7+Q+F5TIzD08XCFk+ZFxNmX3U7IY9E6MWA+0gE2k7lcb9eL4kTPWkJscgzzPByWVUmWX0tDJgU7A3GR8xm7NUWKEnUgkmh/cZRJpKHpZrVk3MhrjgQa0WY5djoeA5IB4Sf/wPQ9I0ToQH+FdMW86KQ15mWO0hzwyEF5/5pKh0ubtDQEhLl9GKcKkW5wGyU+9vICNCLUwBy3u79jodZ95v9JyfxGV5mUr7aI/tEzW5hfNbWl/KBPVQZo0Y9q7NIJyylA+WAgZDbcNFjdWQc2niIyWt5BmjjACOKbNyItiN9yiSIMl1ym64YRXLjQjiTTgMHNGgmAZENV/BOvZ6cWcn7nXPu9297uZet9fa3Nr+T4QFD0z2p49YAEwPh5Qk4Ezho6Aw4wkJRnmW/Hz8wBrpTzIRS0aSj7APSXF0SLPTJDNRa9omu91XnVebrzqcd7a3X3W69IvzYXd3q7PV7ZDWisNED071z3LCVQwDpRSQFJgoKVNGg++Z/1JmmeQThv/Jw+vhVxkr7pEQkzyVQ/kYnzjmxrKKfMEz5q5J9v82Z6imWHvDj/aG2u1+PU/dbaxL7S9Uan1xDbV2a1V5Pcgkifpaa+gZQ35bagW15TBEuavWbAB4SBpI9Yln0inw5DK7sMJOl4M8fURIvMEqxiPNJUkonMgJBgaoTNE/ybUIVbQKEkfXagQJLNHqsn2esoBG2EFQhgyqefIRvI4ekQ4ulMR4Vg1BOZ7lxxXTih3BBy87u72t4cstznuvtro724PdId/c7Oxu7+66lCiM4SNRDzyuNZ8uTf0PoYSWCcvyBCvyXxiEwAL8jARwk2OItGKyMoaba+B4PML+lP087UzNIC+jJmQDgbJ/cMK2dljG1ah09/lowQgqvjhbCl5o7hm/03Ik1SpRhCon1OIcvn7Tvzg+x53T1/++eH2GX8RrqSHrI+RUSm4JUeEL4/zGSRwUIERjRAZzIB7Zi8D1BRTiSE81QumvzNTAmCyELUaE2VeMqLNmQ51PGqGU+I6NPZMt0dpgA7qHApqM2YAbSj4eeL3oJ4kobHwcLPmCjVEKhH7eYv00dUUQqA3RCKYYPwUjxlPqF6VnMCwRysJ1lXlpmcotil5zLeamXEylVVY5ri8KBQckf9hP+oktIZxTsx6FM28JIob1gczeck3pzmtGcyadKssTaMEztMeo94AgyEzQTVrDQjryGRmVs6KbZax6snTp7q0X5tDm7lnCS/OIuDvJkH5ip9rswScRgs9QJQiNO61GtUwhIwVs4gbP2vtgiyrwGQBRlq5jdx2769h9ZOwuPqxwT3jqoE93GfpcKF7CvtoVzyXoo533qJxVRB7F+YXcIIgYINLvl+cI7I/CI8jPBe2efUd85Ev5kvD92Xr4+wPX+1SL1VgLEtDZ0WswRCYS6Z6Tey6xM5Q31ebybG9yPZBwULUCIiJrajbNS8ZhMl0qRZJws8HSXBj1m2VjjvyIBg3y+gzokHYaF7kEpF4jyTWSXFejdTX6ZarRGkmuY3cdu3/N2L0XSc6kctEScJIpJxOup97TwnO3F8pAwKrXW/OdWrdUi2iFmLEZxoqayCEa9LqD7nAnEVsp30pfbu4Oe8nLHt/e6e50B1u9nahe66/mcTwLsmZM1dbbr6MzMW2KA8eVCs5lbJ6nze0/mFeLIaU1Sj0z3Aybw6TXM+zY213xAi/P2VvaGg4IyTQwpJrbiHIaaCdEqytaEHA2Ql5UDKlKQi5yJXoRETNNLyYyOZEueM/drr/V07g/tFDFB0rlZLNZpEqyEhK6TJDl/o3BDZdQUgwJ84GDQ7AjZOfviE7DEn0TkmenpPExacxef06EoECfIfftVfu7RxBeU4448wv8hY1e3+1wBQdAQ+Bz1gx3rvH5Gp+va/y6xv8aNX6Nz9exu47dv2bsfgU+D2joy/gcBI/G56BtddgMS71xb+5/NEx3oRIkcO7N8iQptdturjC4wxVwpXCqlXIIp5OhUbtxKrRxlMy0G4dEIzplSljRi1nqDMPH1hZmr92+9aR3LV7IVnX4TOU3rSSftAcw2YpsRMcGfOQRAeufHIVuo+XsrSW5tM9/jrm3fjgdERmsgtspvpdzdSpmmpc6HNbYYHD/4F7uNkQs0Fv8Zhx1y7nTkn7Q60Jnd9+ui2f0BV1Wme/e2UDPIOmCiqTC9fxQ8BkBcT/70tHgeXGh5q23NNk7IuuxfcE1ugT/PuPZ75fnz9mI4KcL/9IQ8hWS+gUE0AlcxKW3frW3T4NcxdF5OfJnmfuNtycUTmyYQWH2Xp0Jwa6qQ0n/Qt4/RaJ2JqVBwuUGGnX9rFqdVHwSGZXE1tyS5HgyVW1YqM0b45678uf6BKn8KTXcbb1XMTuUlJXcQSSiCSq6to9dFZVevKbXU4X4W8Ut9txix808X5DCm/Yq8adxEsQ0seB0FBTWevLknl9c40dNFe4Q10UZyBJBjuY7r6RatSfL0eAXE7+mHO/V5ViitjaHMZ/KmEFpzFJ2xJJxnhvxd8bIdSgMrkYloujJYt3QpLGLiLjXqYkU+yljGQMpOvmOERjKOxMfUKV2QCUHhlOpD8kPbmUR8x/cYckPDZ3d7SsUVKJM88Q8WWaaMKYJw9F+E+QPR4chLJ3JhA7+GLBzgIP5+rtMEASt5b1wvm1VVnfs224MlYYEojouptjzF3vzBBd+MfeAqGc0SMMEtGdvAXHNAi8qWg1jVVsEixZcljfLUSsX7OblnW1RUf382fQljfvznZR3Kpt+7yz9hUzy8+Td/1PGW2eaXzHTBOhLO5Kn8++ZXldNyorvh+YHi6vztuSrTuaF49IUIfsB7C1vC9K+9VjgL566QHcQHQ3Q/HOuOqMi45ZCwqWEZCyF21AoBLckzQa5ZT5xYYzen3KHCN+Fjdx3Exr6crSAMgM/t+VdzcxdtHlUSk5B16Z0XQ3NlYzRoIoWu0SPpxKsKfV3dGgDz/7IQ6N3BuOckFeww8pTgNgmk1LREXuIXU4Yhz8+4E4wbVL6rAezK1HZIne4cTaqSgHkp6RCy3U6emLeDc/CCf251zwwF5ym+vIHpqdV9Gfso7kipyLz3Q7ompj/Id5w1XgssoI6TKRsQSeq5zO8PTpf4ghmykAvdPK5HrXDINMmWjCh3sq7z2ar2+rErtfA/SI3Fj1xjfmF+1Dva78kXPTS2/kO/g/6TDFUMWo/2gVto5F6pW+HfEN6Fd3TkDpPqLekaHLGMA4Nu72lDRjq0e7oNoKduvur63n7RVeYzm/EuB72o6ANgLDzH59PXa0Onf7yKw3qCv0Iv7lzL+11reE+uSBXGIQvKSd+60DzG9ykv3vRe/zDRV54LelzS7p/G1UbcaDxbCtMtAoShB+k5d3d/wBwn6tk +sidebar_class_name: "put api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/query-password-info.api.mdx b/docs/api/beta/query-password-info.api.mdx new file mode 100644 index 000000000..b68c9e738 --- /dev/null +++ b/docs/api/beta/query-password-info.api.mdx @@ -0,0 +1,95 @@ +--- +id: query-password-info +sidebar_label: Query Password Info +hide_title: true +hide_table_of_contents: true +api: eJztW3lz27YS/yoYvj/aOKZuWZZnOm/oI44c35Li+JoGIiEJFgnQPCwrnnz3twuQFGnZsZumfWlHbaeWSGCx2PO3K+DBkD4LaMSl6DjGhnEbs2B2TMNwKgOnI4bSWDUiOgqNjUsjfUwOqKAj5jERGderhsNCO+A+kgACvTEPiXXcIfAnDplDIkkUUeKn0wPm0gjecCAfeGrtErkSV8KCwRMmyJRHY3KJRGgcjWXAo9n1r+Mo8sONctlhd8xFpksh5a4vuYhKtvTK3BFl6vMyTgHOuK0I/8d2OXwz7YA5+JS6oTkKKDwZunL6BpYFPgN2G/NA82pT1yVRsokSIVdGgY8rA0YPWRDiWJrwG41pRKRwZ2RM4cWYwSy97u+5dWHqlVBrk2jms1VChYODgZ4MGBES5RUQW4qI3UclYpFL2GUoBXUJtW0Whnq57xZFSs3U1ExFLUQZyCDby4gJtAcQhtICbuYy2f0XReZ3Wzrsu3kokDKR1CN1zAUEDIAqVlYOj3orKwQsZwIy1qphwlEraRlS8rlRqZN3MhhwB6T9GVQU+lKEoAehiAwYPIriQDCndCXApFHjLIw2pTMzNh6M1ACMjSiI2aqhdADWDa+o77sJ8+WbEE38wQjtMfMofkI+wejl4IbZEdD1AxRFxFmIb1Gfh9RjuZFhFHAxMha9hhFXjrggAsYTOVSCx/kwlN1Tz3dxtjUYzEpdDxRjfF01QhkHNnv9Ag4PfZfOCktoGoVFDmamtW18hQUiHqkn+Xhwgr683TtCBrI5+a3mmSzymFFG2qmKlKBqlQr+KbJ8in7GhM3Q1ZDXLIBg4CgZP0xNXHloNMMAuCjHuWBqdru6XllvthqNIbMb9Uq11VgbtmlzYLPGWqU518krKdVx/lqjZieU2pX19UalWqNIyY8HsKMP7EW2DmsH1aPeHj/Y3YkOtvfci26lcnHWr+/3JrPz3k50eGM1z71O8/Bsp35x9nFcIP6y5fRBs7+ERM8gEzbTgWGThmytAZ4IPvyYo4NOZ7NzYx1ujia34wnfbU8rm9bJzjvLOtqyTtYtfL81+gCfd6x4993kjNf2Ws3el8gf0OMPTn1tsCc6m/W99dHFWt+W3bbsbp+Ht5tfjv1eOLz4dE53ho3zxuaH3dFe55O3U3an42l80/L6VR45F7XbXvfwXSQ+WevvRKtp1/v9yeTt+O3UuRhM4q5364Z7sn5aPRJ7k+lkbzSyrVl7727SvnHt4HD/TAb+SXXaDmj/7j66G44mXee22qx/uJdgbSfV9zbvzi4qwip/mFb6NLb3xViu3zuncnoRVqt0+Gn3k9Xu9Nrv17bXe2tf+k7Uvfdg/Oz9W8+NPdrcd3pDetCsnNXd8v76bXPtY3Dr3df8iw6fOvflyttR/fzt25uPrcoX6VUuNidb1QOvK/cPgpPz3eZRZ+vwJmjVhq31zdox3f00pMHJ+1vrdP/mg3/wMWqfd04629aJtYmahlgvYxGFOUXTIKCzBT1beqByrixFJ8mbY7ZOvESF3Cxs8Ih54csulnDxtCk/zUdnO41RyeQSUdgC/gt9ZvMhMgVLpK+JdnfgPxfYMJsO+SgOEpTRifK4BAJiBCzEPBynVMISOcBsrKRgU4GpYwgvHIKJmqRZDzKcFwuQxqOsFzXLnUROh3JqbkkhQBwyCMvv4asjzY4Ju+UjAdI1qTCTVU0agTAGMT6EvDxmZiIFs7NtAjowaTmipl9er9SblYKrbR3+hvGWqHi7etT/zYpxT+qTB4qzaYift5knV7e3fgNf5viX2h7Dv8Bzzkhel0q2n0gjf6WKnl/sp9IUCg91pTXValQq68/m7mdya0JKvfclhNvEe77ptxkqBzmCxihHZ190zESZ+ax9aaQZ9ZT5DP19a0wDlH4dHTh5d8CF5fpjis+rxef7TIwgFcCLZvHFYaxsT0+5fm67jyBEPg2/kGurVSOfal/Ip2p0IZ3+0ZxpGYWUaVjLBPdzJLh8frsspJkfERkfBcaCC1/nXfTv8yT0pcZTaHlL1ZtkJwigmDPJaVLuEK5jZlLwkAFUPEiMizvqcucHomiHRRBgt6CiezmFvONC1X0cOWSKZSwFCVC84wgniYehXZNMw74aVyrEVJBEqQpQ1IH96v1tJZvBkBNQewK0XgM6+oLDfJJOAbADuSR4blnWYnSwVmnXGhBtKK2tN6qt5qA9pPV6pd1st3F1DypsOnpF/N7Fghs07EobNPKFYX+EguwVA2rx18MsRePV5SaOzbaZ8Euw9wBlNdncOiaNFnEp4CP1nI4eCUGY/S48EbHr0gE+wtoZdq4JHwUcytknKxcRe+gy2xAv+/s9eHK6c9Lf6cInpLXQUbIEWKuDZgmsgi2M5VRxnGxgSgFtMBfEAcU9WUmorsCGqAjzA7n+Fs5CECbY1pDGLoCIlWT1J2bkSZNhIL2CKyWNGvIrL7HSKsAPeObRyB6TAUX0IjXKWYGszvzI3E8kuQL4hDoseFMiluNw3CR1CXgjEIX5M8Qx1HFUf0wRGMbgykxVXTKOiJARt1lRF3NRFrUxz7v7eaWgcwDnr8HiUQzMqW3mvTCzloTFRD/As5ZckbteTmhKpDMRURtbQq47AzEGAUiYAKYiPApJEo4UiITAI9JxWcTKwwkV7g40M9uRVO9sGoevwU0uhB9TbS17cccS51PtPR2NlDZSNSURKWlIqMnJqExdqeMTQL+us/Tdpe8uffeVvvv45WnSI0zeKuhTXYQ+fZF2lWETC9AnUNYjJCm0nhNFrhIQSAKR9s56SQ8cO8z3PjaEfyA+0ql8gXkr04d+PkD4kSmroAtkUMlR72AIkYg5G4rvOcdKUFpU9cXVsh75ExBR/fowkzGhILIgFgI5AZBMHMlC8UtExvSOzX+JyDrxpi6ql0hyiSSX2WiZjf412WiJJJe+u/Tdf6bvfhNJZlwpb0lwUhh7Hg1m2tKS97hbSvBsQXagIHM5parHaMUonEMwisjBGNSqg+qwZbOGQxvOWr09rNlrNdpsVVvVQaPWMvK5/nLux5mTFX0qp2+tRyViAHF3gONiAcYVRlI6xfYfiDdgQwxr6gBLiptB5iDS6ww71tqL2LEnJZ78maUIKSxgSDGXEcY0GOvh2CAdCwMoGUFcFPiLEAe+0JS4x4AKnjchLve4cl7cBdANZqY1jGAr2lFSI8tW4cJ2Y+BQRQJXImqWYFgcNqkP1AAFhWBHEJ1/IDpNVPSnkDw5xR3v447Jzr3NGDp6htybT/V3O8B8gDGiqxX8TKNXVztUgAFAQaBjVoY7l/h8ic+XOX6Z4/8dOX6Jz5e+u/Tdf6bv/gF8nqCh5/E5DHg1PoexpQrJsNQ7NK6/HaYrV0k4UOZNpG3HgWo3pxhc4QowJWTIl6EKIjQaw7eyOk1vpmcETK4P6WvcrzmKAxcGpiegHkBRoKCvJerzUnrIRsipOgY1AOk8EXj0IS40GhygzvPrBUpKtAFH69WhThHXglabQTtNT1p9k3J6pGsmYwhuiswqHvxOLEk9BhZ9KCN+CdXokrKchf3BvvqB+/XP70UTemYvT4nvm6vBeAKcPtoibuEa1QUaB0JKX3jEdkvHKStGJV9e58d0EZdrDhdGznMN1nK1BYaOcFiNbDIaQNGgf974de+s9yZ30D8OEQgzjuUD+NNxeunAyl06ICoBBTIe6TsBVuHHFPQugif48R5HlzFymTtbR04hbiuxW4W7AN97h+CNyoZeevYvvUFyJUyyzTFIcczqOCbZoqoC/6bLFI+40KK91JdBSO4yiJLWX3Sp5QlJJHwUfwKzU639Rbc58ErP2ZhDqi1OIzqykRAypeuQDrHHUobsv4Sg6aCrXI5i/icumUxxUVN5hFmr5Fgy9ZImNwE4Kv72wTGENiY6wMStcIsESCcc7baflWYhLnxWJ58/F/asHl9CfsWRjrTD7+YZFzRxQVPHiTDhX6cvNCzwbdyDigPaALbm+leRIGE0Fxs1rScjvyJfVnMwfdjAqqIS+hv6y8Y8CCafiHqBo7MxEKoRd2c/CuLtqYQW5rCCsNKOwWMJLvKrrsI8kpvmN+tYYTr92faLO7bmjZUj4c5+dJR+JpL8PHH3/xTxlpHm3xhpEiSMDcrT+Y29ne+7dgb1OUJlZD8pPfLOsplgw8WGIXa0xwz+D2+VzyvwDqXR/IZknpDv0gi9Q0UHe8yZajXgqWDEmatoodJTHu0HEsMIFJSK0CjAk8MBbJ1CcchdvLOAzfB0ZaocT4NYde0RvoexqnfUxdUxlK6sRM6YupQVB1j54XEOeHcjkxKwCxo+RgMh26nRAHhLbkigf8ceoRF5ybIcHtqxDoC2vjihtyAVhMxmpdEATRa3UFI1UOCFR0PsYkOBnDOgF9YC+wmTFjaIHrUotHbnGznFS0sYhGBcsUR4iTZYrTlmro9GAtEbgBzLrXDQ6S1QBGJCG1lJBqNyMiks41gggqWYNp96qVqqmKo0Ubc6wgiq5RxxdZ+SZJc4kivXBRN8mDful9erl9er/wHXqxO0g4Iu+9h9RduPdWmt2xiXxlNtDCh6x9jsgNcPD9ifw7r+Kz5Wo7EwnpfsqkyGCapPp+roibqck/wwZPZmCrsljaDFX7ywk6Bn6N7fN8de5/oxx0fYBTUGyeVxT7eWAjqFh/j/DeMK/oUv0tfhCG+Y4/MHI23UwhhNF//5H2Qb7Fw= +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/reject-access-request.api.mdx b/docs/api/beta/reject-access-request.api.mdx new file mode 100644 index 000000000..1b3fc8db5 --- /dev/null +++ b/docs/api/beta/reject-access-request.api.mdx @@ -0,0 +1,103 @@ +--- +id: reject-access-request +sidebar_label: Rejects an access request approval. +hide_title: true +hide_table_of_contents: true +api: eJztW2lv2zwS/iuE9kMPRL7iJE2+LNwkXeTdXpsmKHbTAKUl2mYrk3p1NPUG+e/7zJCSzzTpgX3bQm1R2NJwODefocnrwKYqk4W25iQODoJMfVBRMYgileen6s9S5UWwFRRynAcHF4F7LvwLMUjTzH6SSR5cbgWxyqNMp8QJfM4mOhfKxKnVphCOay6kEdKxyDwL6Vm0xCuTzEQxUcJeGZUJO+Iv1XsMjYWMp9qIMlcZWGV4mST2SsWisAJKjGw2xRjMKyOSogXBU5nJqSowAOJfB5pES2UxwSuDF/hWTQDtt4I8mqipDA6ug2KW0tu8yLQZBzdbAQmsMwUbFVmp1tVVQserQpME6rOcpgnx6kX73SedJ8O93n5/qOR2p4tPO7tPIvzrdHoquLl008AuT208IzGWZzlVn7S6UtmDXER2OlWmoBnmko3gCogWWVPgHY2HJImO2L3tDzkxuV5X0g7JO2StjIKh0Cqnt36KdWvAdmWSyCFptckYh26g8HIsW4EDg3w0VwHWlWUxsdndMrm36wItC3B09koQReUPPxNI4ST6UMxYKFNOKapPjo5fnp2c/ZuieC5o/RTi6fjuSU+O7ppuNRLI9zu9/Wi308WnSO6O9jtRd7u7TVO68LxTU52niZwJor739INYTsU/lTEKQXZzg8miTMlCbVSSskoiCIIYFGGhIdWaEHjD+Ulvq+nFlUSUOr4r2iPww85e2O2edZ8c9HcOtvdanf0n/wlIEkjLRD6Gjgob9khGzsA8tSZ3gdDr9Nbzg8pTivlEiBJVlBkUFNoZpao3JFVecg0aIYhnXI94DOqUZdJ8lhdqSjJ/YyI5cfudzrqEh4km2xxnmc2+IOUQ6U9Jog2qiI6/Q5bVBIpVIXVyaON7BNczbVQ4zqQmCRWLHGGgoOKmY4qvqUUVdiyr6GO6ZYfDEq2ueCrjeuE49MqQwzMZfQSvk3uk2LnRGC+qIVRxEZ63Tav2lBzudvZ7/dFuX8rek353b2e4P5Lb2539nf19mn2KOJDjxdoSyCyTs7Wp/6GwKOlIJDaCR/4LgyC0YXsWgCfHEI24ye/2AfO4h/1pUXG0tZpeXlGoz8UWaujTw9eivycSacYlP5fjFSOY8PzNWsWG5o7xq0yPtdkkSlUcj46fDc6fn+HJ6fG/zo/f4BPxWlvwBwbRGlNYWl68J/aKJfYKcN6pBOZAORCPPdfHUEiafJFQ5wtJiNgayTIpMMLPvmHEImsxyux0KZU4bz4X4qFuqdaWGNIzFLRoIoYyxwC4kMgfu9oRPveWfCwmSsYqe9QSgzjWpCRACLIRTDF+BkaAIzHXDWYwKpHKEEZjISsLYWyhI7Xsi7kpV9fPquo9X3QKJQckvztOBlFRQjhWczEL62jxInr/QGZnudWFeaVKzkxBQAqUKJORzTJYWAyhmy7yam0nd+UoPKaiqyvWYjHncvfCCYOKzu8iWeb3yLvXCcpPyKrVLz4pn3w5Iz+uRuyNyk2+Ivl6zoM9Ve2uKvHFSKskbnK3yd0md++Zu6svTz0u828Z+nTXoc+5cSCfF8816JNx9BgrKiKGN96RWwIG8RDpj7dnSOyPyhC9+pxS5/MD8ZFbyteRZe0P93xI8KN21pIvSEC2o9NghEqk4gOWey4xG8qZant9tmc2G2oEqNkAEan7FTNbcgOclcaQJDLfErFVuXlQiIlEffRdNldA14iH3Ik3SLJBks1q1KxGv89q1CDJJneb3P01c/eLSLKWirPF46S8nE5lNnOR5t+TtlKAQFQ7hKJOOXbVKlohZqLGWMEycgiGve6wO9qLVD+W/Xh3e3/Ui3Z7cmevu9cd9nt7weJafzHP4zrJlnNqwd/Oj2xigLhPwHGlQXDlhbXx8vZfST+ZjKisUempcTNsDpNezrFjfx07vrQFdANjYMfslu3F89PnxJ9+RiH2ZDdbZpEimO1MB3JZMKSkGIalNf8O1EDHBjo2y0+z/Pwey08DHZvcbXL318zdr4KO/bugY/8roGNfEMQaEcT6K6FjDNxB0Gyk6WCMiEqYl0/apFAFn/zuo0/7QmZjVdRAbwlF9vbXUeSZteKFNLMKLOVLO5Fmbi4qb6CdEm1W0YJAijFKpKFzOdq6gzF0OACYlA4LJHqqOY9JIfDNZuFgVEArlzNVvNWzaBMlJSTkopBY2nu1iDGNcFIjgn/gwPugYxTqH7jH6b31XfvB4pQ0fk4ai+PPkVKU8/X+786mUwInED6jcvHG+fqW4wJuz1watBHqc+rKVw1BG6jeQPVmuW+W+99juW+gepO7Te7+mrn7FVDdo6HboToI7g3VQdvqiBpLPaPg+r8jdk4VLwGHt7ARY/V4jsEZVyCUSKDU8kYrn1E/CNrud/zQ+yqsDpbn7ev5ufWbtjtej2GuN3CillkCDpOiSPODdvsaHoTnbloy1a3qWLCxV63ITttDmG1DRXIHtSmaiEAMXp/45qPFNs80hbWrgczceYC1pACGJ/jMwRc5VweXZ+hLhGOzRWe3fYjxY4iYor94kDN1i0NqTT/odZ4lN9+vi2N0iy6bzPfF2UAvIOmKiqTCJbkLoQBG7K9zyHPoCtigJO9fXC7SvCHA7iRco5wvQvRTQW9NoFdE1hNPlczQTbjTMw//eHv2SIwJpnKZKHNCyEpTX4FEe40w4jI4qE6S0CBemTJbjies3GDprA6lnRglMIp4Z94oJS5OvKFeYn04RUFns9MgxTWERl0+rDwYq08qoaWzNbc2BaeOTRtWbMulcY94meR+Qht3Rp2ufLwzoTjSVL00LfdE41Xk9lBcpJVeckGvbxXibxW30Ocpc8sfrUjhTHsRubPfEXKfWCCL2VrfPLnjFy7wo+YLT4jrqgxkCS/H8gmrqPLaN8uxxC8kfstyvDNvJxpr8PIw4UqeyLGEJrE4EdHE2lz9XQgKHUqVi3GJTPtmsa5o0pAzIux1FkQK3ZShDoEoWb7nSAzjgkkOaUVnQGPd3gqn7Xv2LOrCe77o8H5JZ358gYWXKGMb5d8sM00Y0oShqxO5l9+taxRYyG3SwV3Q4QA4nPufK4EXdKE2Ol4bKz+zb/MYWj4iiMpc8vTAfTmYF0H/SfALoq5pUKoJkNdnzvBdeF439eUeb6xqK2HVguvyJhZr6ordnLz1D6K0zv5s+pLGg/mOC11r+9FV+pZK8vPU3b+o4jWV5nesNB4i087l6fx25HHVzCxcVNx0uXDD3cL6Zp+72Hf3dbz6sujyzbmFe3NfuNSGSZAoPL3vghbT86lHo+t7l7S5PlH4H2+5ynAfgS6N+07GX4uM0kQW7gYs6lE00Yp3PVLIR8h2i3LCTrmGoG+gwoXelhmNWYcMxpboU3VC1wVpX76aWXKqO9jMl3DxPS/9KRGLZEIXrVriLRpREyGgqAml88l498H6bvQNYuo13wQ+qsJU0A2/0mA2qijlVEgkwx2xHOs8Kl3JRU9qVGULy6C1HlXVH0oSUqHF7Vg2zV+NaEMdvfpCyN4xFyI297vpMD150YfCXJFTlXBOEd1yU3IXb+RJOFFJSkGC9QLQUS3M8OLkbI0jmBn/E47Nxm0/KG8TLZhQ8+fCZ7vVbXVCbobwnLpKNO4LzE/vvpG9GpLX898Ufpbr3T6hqRNqp7TzR8qWrntzLfRFcFsLjeEHS5e/fReNnmtCTTiGXl/TvhG1lTf0GAxoU+Lict4xcucGd9Ln+QXsW8328NTf1X7Ev3xtvjG+Ualq09PM5vsdAT5+VLRNsqDHzSWo3X4WC+cI/A8o4dmMoUzFYO2XIWqs3Qi3R/ZF2suFfYvXr2i3MBj6e+tTtwWTySsyLP4/CN7hL77Y1OUKiPj5dVBtaILG8aU//wOaBYNo +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/reject-approval-item.api.mdx b/docs/api/beta/reject-approval-item.api.mdx new file mode 100644 index 000000000..d7db2b935 --- /dev/null +++ b/docs/api/beta/reject-approval-item.api.mdx @@ -0,0 +1,75 @@ +--- +id: reject-approval-item +sidebar_label: Reject an Approval Item +hide_title: true +hide_table_of_contents: true +api: eJztW21z2kgS/itT3Ie8lAVIgA18uSMYZ8kR8GGc3J7XVTtIA0wiNNxIcsK5/N+vu0cCCbCNudTu7RafENJMv/cz3aPRfUEthOaRVEHXKzQLWnwRbtRaLLS64343EvPCSSHi07DQvCl8Vvorw3th4fak4InQ1XKBU2HiaCZD1rrsMkMhZDxgKRmaU2QdGc2Exgfcm8vghCnN4A5T3wIZTEturLUIIhaHMGgehxGb868CRgBhLf4dizAqgjALrvlcREKjSPcFicwXPJrBowAewD/pwXXozsScF5r3hWi5wLthpIFL4eGkgMSkFqBupGOxrYhg3XOmJiTbN1RZGjOI73y+8JGWmFTqk0a1Uj0TjWrt1BnXxuN61any2mmlcebVgctOyXjGrt0fKGVKlyQt5kS1Hdseu5xX4NcZu2JyajsO98aODdc2dwsPt8grXKggFCFK4pTL+JPn11pbImSeiLj0Q6bG6Grk56ogAt/hPJDFly5FVOlLiJPvt9U0M9GbGuMvkoY1eG7LFJuaP+cbx23Y9XK9UvMcUbNP62W75lWcSb1Rdrldq9upbSGchO6+iOFq2uEMz2W48PmyT/HwHGd0smcmYAA9LcYHNQvY1RxyDBlCTu2nXT6QaNqLtaNZ+6uU1WWb4QcOQbNWxNWCR2KnIhOl5xxiruDBCCuSwD8nedk+s8pnlm2P7HqzWmtWzorlRv1fSHWuPDmRh5KtW+VTy6mNnHLTcZpOvWiXq0Q2p+te3l3feTqq22QGxl1XxYCRMDxUsXYFe9U6f4Wswwie72IqgniO4H3R7Xevfuqcw61h50OnPUouR9fDPl12/nnZHdLVZad/3u2/h6t2q9/u9PBmEPv+bVaiDL1tvUga1Ijn9IlkRHNxIUEMvCKhQXoj9OPCX/f/3h987sOd951+Z9hto2yd4ah70W23Rt1Bn1T52Dnvpv/OQez36Z/W5eVw8KnVg8tP3UGPbg87n7qdz3DnYjD8iEoPet32z6vHyOCnVq/X6b/vwHX342WrPWr1W72fr7pXcOOq+74/uLhAu33q9Efw+7HVv271YJSZPepcjQo5i61F3zYYKr4rAjYtNkIDEaDMhSfNuk0L8g/B1jwYuDh5kmD5i0Eh4noqopdDUI4rM1QOZH4YJD0rwBdA2mKYApQZcCiuv4wzLKLSb3kerNch8s6stYfpml2sDaDk+LXcSN4Jdg51iBspvSSeEZAex5E4kGM6nY0FjE91Fl6O8WKmAtGP52NYHLI8B2mxuh/jVW2728Jo5KxIORHihZeA0+r5J+7He6p8h0NfpnPNdqxarWZBxeYg24Cj8bse1FUyWu5raXKYTCalAuwKYlxmTRQDt4c10gzzyHJuar0k2lbV6w8EnFzx+ioEKHhxuifL4p78kjVUi4mAhsMVHhsvt8voJ1I+kzW/ScoFe2faKtLAjjTrKfRQL0umLO311N0pc7d/pmTJmmlZkvxv46Kr5n/0CieTX9neOpNc+/t4xW7bw60ktE21SOWzwkcHF9B1yy5bdmNkV5rVBhbQlXqNKl0w+SYMSGgBp1TM70gAgnI0l+kgZfB4rWs3gL7QWuksda41X8IwucF13TCvCNxsmAlqi2jGI/aNhyxcCJegl/4FKmITsJhXLNxmfZR6DzzzgPeru1riti9xu6KDkjKLDUUU6wAIy1yXxsbKWzKJKoPTpfcDu2XThreVt0fgXMhAWFPNJUpIxmUuTGQYi9LDRWmutEg6+xSqaFx+OwEsUbTZO+6Bvka/dqIMmk9z9yvQ2qfouw4kzGfpFFiywBP6MbbiTPDxabnhVCenVc6detU+q40bE16plBu1RoN6OoA1PhW7gibP+r2AnlO6zFcueOQ/YBBIF2w6UQBiviPOHvEB0dgzcc3YlZqJvCwS36MTgJF37UtWPWM+D6Yx3efTDSME1jW2HghUfIy3cGcINDeEB1pO5U4sTwHyvHPRuu6NCBT/cY39SQp6G5s9AUSrh2GpKGdn6htJnChAeSR8MIfwiuxtQvUtKMSDMDtQmn/hMsQ09MSEx34EMxLuO2ZkSbOJVvNcKlHefI/Ya1kUxRMopmiPMHJnbMxDmJDUc28BBsUisnqJJd+ymeCe0G+KDFY/iUrCGk9rTQjzl0CIcc/D1DUEJjGkMggDy72KI0QJ6Yq8L9amzHtjjSG9rFMwOUDy5+MElv8YhCM1s1m4ipZExMQ/ILOxXF66UcZoZNJlEHEoLGCkvwQzaiwuGCy6AJAhS+AI3RUC8ATpuBViZaGR4O6jEeY8UvTM5XG4R95d+gA/Fqm2enAnkuSDMFAJGpE3UjcliAQPqZDFycmolbvSxGeA6753zN1j7h5zd8/c3Xw4TF4EJE+p9Klslz4XSo8lWD3YUffQ65ulihkHN+g4wHc7jIcnzFMiDF5FbMbvqAkDOUxag+wi8KyFggryWB4dy6MjxB4h9s8Dscfy6Ji7x9z9Y+buk+XRSirKlqROCuP5nOulibTkudklhAEsPWfBVim32ijNVitIjK1qrEK+ciiMHXtsT85cUfV41TutNCaOe+rw2pl9Zo+rzlkhu9bfrPN4lWT5nMr42/jRbG8KfQd1XBxAcIWRUl5+Tyum7XOENYQeHkM0aSgVwOZg0tuHh7R2rG7Xjn0VgW5AGGpH/cie2fWwZ7bnDXm0m3nbjUlLpjM7elhS0iae+C7D6Fg6HkvH4/JzXH7+NMvPsXQ85u4xd/+Yufui0rH6XOlYfUHpWGX99LXm71k6elB30PtVcArokJ7u1mIBqsCVOYKTpr05obIq9NZVJJUfEHEo/kJRkUdnqpuFEr7htQiRSvfSeyiZk+el+/wp6weYYUQyOsXah8mzKFqEzVLpHnwMvn0o8oUspsdmAvUNDx2UxmDYHZiFL3NNfuIAOvRuGBTJK1pi4BuUJOLGR5TmGOLgK9rqfJJyemJkCeZghswJHhJMgpBu47t9HiyTox5FCrot/UCva+0//O+6GEKP6LLLfE9yg/EMJN1QEVW4RXdBtNCZJ/DXNcjTNhDXitHxN7fZMVdY0hsJt0aulynsUJwtgQY4zGHvBNcQsJH6KgL2+sPn0Rs2xUKWgCQOsYYWyacL7BLCiICylW5g4yQKYq3i6YyUayX9kAlxTEw28cEo7JfgSgh2k57p6sMKMgTIJ7PjJEEog7NuX6ce9MSd8HFxLa6tjcEpvaAEVizx3Lw3lFHUccjAnO+Au8VfAis5UiSxIMAxiYq0O89uFqlePKPXoUL8JaVmGWoWUQvfbEhhTHvjmnMUrhZkFu6HZK2DmRt6VoYetmdwB6luyoCWSOTgOa+5qdcOliNHz0J6eTl+CT7PJKzS+WnMoB0LYZH1PdZl7kypUPyVMQwdTJWbaQyZdrBY35CpRRlhOeWMSJZhaUkLak6SrweJEZhg4mNc86nkUQbSKW1/Jc8CLvzKONz7Nacz3b6BpRlHesoND5YZGVrI0DI4ESbyJx+igLB4mgl0IBwwAdBe+5+QIBE0g42G1k7kJ/IlmoPLhwuiEpVw0TR/mmsQTK4YPcDRqzEA1Viyr151wX+W0MJ1LWesdLNh04Lb8voKFt8Nuxl5V/swuCD/v+mLGrfWezKDwF/+aJR+BEn+f3D3d0K8I9L8GZEmqY4x3Iht0m1kg/xdUtNt7xGG+GEl1OH4lHIVT29CqxBRf0dVTJbQwucRRjVltTuTgnYXFoJHWB+eYGSpOWUilN6Y/tBDEqEpnUTVIDKHflD6QK/IRmvOnBLGFJ/oV/wfxskWr4KQhG5VFNlnaPgCF9yCzR4eLoBnX1TS9V2BZy7Rsew8dTYUXfN5HOAReBA7njMOIfVMRHgydGMDXND7BSK1haLSbzUrzWIMNVShSN2PnoeDyRVUztATZxz/DC/we5jsWoPp0YvJh6JrRYbCp8jEcfnS/jnaEG3WTPgLbDcBdaEAExkOH7ujLYpALEj6L6WnpWRSWMKxeKgblDfhUynaxbJFLQXcx7YMGuQM8SF1YlufAG+G4f16v/63+344WWywSygtcN8MVYhNZ2M6y5vCurOECU36ntiIhX83PuKFXmSGfSlMu7/HHRdstx7wNrDEdv7mdt1JUUcDDsJr6GgnABmbn/ZmjfJ6mHwE/AZz5pHPkncqlG4XBsv1TkEBLr8K3GAAjbBV/AGCbH15fIA0GwaFzh9MSntTZC4zyOxeZaZvvd/BrnC1VXA5uIKYffgvrg2zpw== +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
\ No newline at end of file diff --git a/docs/api/beta/reject-approval-items-in-bulk.api.mdx b/docs/api/beta/reject-approval-items-in-bulk.api.mdx new file mode 100644 index 000000000..a5765c795 --- /dev/null +++ b/docs/api/beta/reject-approval-items-in-bulk.api.mdx @@ -0,0 +1,75 @@ +--- +id: reject-approval-items-in-bulk +sidebar_label: Bulk reject Approval Items +hide_title: true +hide_table_of_contents: true +api: eJztW21z2kgS/itT3Ie8lMU7NvDljmCcJUfAh3Fye15X7SANMInQ6EaSE87l/37dPRKSANuYS+3ebvEJIc30ez/TPRrdF5QvNA+l8vpOoV3Q4ouww47va3XH3X4olkHfexe5XwsnhZDPg0L7pvBZ6a+MHhVuTwqOCGwtfaQA8ycLGbDOZZ9NYQ4z1OBGTM/MKrKeDBdCM+4x7iyld8KUZnCHqW+e9OYlO9JaeCGLAhi0jIKQLflXASOAthb/jkQQFkEen2u+FKHQKNV9QSJ/n4cLeOTBA/gnHbgO7IVY8kL7vhCufLwbhBq4FB5OCkhMagGKhzoS27oI1j9nakayfUOtJcgPJMV3vvRdpCVmteasVa/Vz0Sr3jitThvTabNerfPGaa115jQLD7fIJvCVF4gAhaiWy/iTZ9VJyQfMESGXbsDUFK2HmtrKC8EgOI/7vittcljpS4CT77c1NDPRRBrdG0rDGsyxZYVNpZ9TuGq3Ks1ys9ZwqqJROW2WKw2nVp01W2WbVxrNSmJW8JHQ/RcxXE87nOG5DHyXr4bk/uc4o38dMwHj5WkxPqiFx66WELjIEAJ1P+3yMUTTXqwdzdpfpawu2ww/cAiaVBFbCx6KnYrMlF5yiLmCAyOsUAL/nOTlyplVPrMqlUml2a432rWzYrnV/BdSXSpHzuShZJtW+dSqNibVcrtabVebxUq5TmRzuu7l3fTO01HdJTMwbtsqAuCB4YGKtC3Yq875K2QdhPB8F1PhRUsExYv+sH/1U+8cbo17H3rdSXw5uR4P6bL3z8v+mK4ue8Pz/vA9XHU7w25vgDe9yHVvsxJl6G3rRdKgRjynTyhDmosAjUh7RUKD9Ebox4W/Hv59OPo8hDvve8PeuN9F2XrjSf+i3+1M+qMhqfKxd95P/p2D2O+TP53Ly/HoU2cAl5/6owHdHvc+9Xuf4c7FaPwRlR4N+t2f14+RwU+dwaA3fN+D6/7Hy0530hl2Bj9f9a/gxlX//XB0cYF2+9QbTuD3Y2d43RnAKDN70ruaFHIWS0XfNhgqvisCNi02QQMRoCyFI82ySAvdD8HWPBjYOHkWY/mLQSHkei7Cl0NQjiszVA5kfhgkPSvAF0DaYpAAlBlwKK6/jDMsotLtOA6s1wHyzqy1h+maXawNoOT4dexQ3gl2DiWIHSq9Ip4hkJ5GoTiQYzKdTQWMT3QWTo6xv1CeGEbLKSwOWZ6jpBbcj/G6dNxtYTRyVqScCJHvxOC0fv6Ju9GeKt/h0Jfp3KhUrUajYVWqlSqy9Tgav+9AXSXD1b6WJofJeFIiwK4gxmXWRDFwe0iRZpxHlnNT68XRlhbdPw5wErIEea8CgIIXp3u8LO7JL15DtZgJqOJt4bDpKsmGVJInUj6TNb9Jynl7Z9o60sCONOsp9FAvS6Ys7XTq7pS52z9TsmTNtCxJ/rdp0VbLP3qFk8mvbOuaSa79fbxmt+3hThzaplqk8lnho4ML6KZVKVuV1qRSa9dbWEDXmg2qdMHkmzAgoQWcUzG/IwEIytFcpoOU3uO1bqUF9IXWSmepc635CobJDa5pr7wmcLNhJqgtwgUP2TcesMAXNkEv/fNUyGZgMadYuM36KPEeeOYB79d3tcRdV+IeQA8lZRYbizDSHhCWuS6NTZWzYhJVBqdL5wd2y6YN7ypnj8C5kJ6w5ppLlJCMy2yYyDAWpYOL0lJpEXf2CVTRuGIuJsASxQp7xx3Q1+jXjZVB82lufwVa+xR9156E+SyZAksWeEI/xlacCT49Lbeq9dlpnfNqs145a0xbM16rlVuNVot6OoA1Phe7gibP+r2AnlPazFU2eOQ/YBBIF2w6UQBiviPOHvEB0dgzcc3YtZqxvCwU38MTgJF33UtWP2Mu9+YR3efzDSN41jW2HghUfIq3cFMINDeER1rO5U4sTwDyvHfRuR5MCBT/cY39SQJ6G5s9HkSrg2GpKGcX6htJHCtAeSRcMIdwiuxtTPUtKMS9IDtQmn/BKsA0dMSMR24IM2LuO2ZkSbOZVstcKlHefA/Za1kUxRMopmjjLbQXbMoDmBDXc28BBoUfWoPYkm/ZQnBH6DdFBqufRCVhjae1JoD5KyDEuONg6hoCswhSGYSB5V5FIaKEtEXeF6kp895IMWSQdQomB0j+fJzA8h+BcKRmNgvX0RKLGPsHZDaWy0s3yRiNTLryQg6FBYx0V2BGjcUFg0UXADJgMRyhuwIAHi8Zt0asLDQS3H00wpyHip7ZPAr2yLtLF+DHItXWD+5EnHwQBipGI/JG4qYYkeAhFbI4OR61dleS+Axw3XWOuXvM3WPu7pm7mw/H8YuA+CmVPrXt0udC6akEq3s76h56J7JSEePgBh15+MKE8eCEOUoE3quQLfgdNWEgh0lrkF14juUrqCCP5dGxPDpC7BFi/zwQeyyPjrl7zN0/Zu4+WR6tpaJsieukIFouuV6ZSIufm11CGMCScxZsnXLrjdJstYLE2LrGKuQrh8K0WplWZme2qDu87pzWWrOqfVrljbPKWWVar54Vsmv9TZrH6yTL51TG38aPZntT6Duo4yIPgisIlXLye1oRbZ8jrCH08AiiSUOpADYHk94+PCS1Y327dhyqEHQDwlA76kf2zK7HA7M9b8ij3czbbkxaMp3Z0cOSkjbxxHcZhMfS8Vg6Hpef4/Lzp1l+jqXjMXePufvHzN0XlY7150rH+gtKxzobJq81f8/S0YG6g96vglNAh+TItBY+qAJX5ghOkvbmhMq60EurSCo/IOJQfF9RkUdHqNuFEr7htQiRSniY2zKHuUv30nmAUUYMo0ekXZiwCEM/aJdK9+BX8OdDkfuymByV8dQ3PGhQmoIxd+AUvsA1OYkD6AC5YVAkT2iJwW6QkYgbv1BqY1iDf2h780nKySmRFZiAGTIneDAwDjy6je/zubeKj3cUKdC29AO9rrX78L/rYgg9ossu8z3JDcYzkHRDRVThFt0FEULnnMBf1yBP18BaJ0Jn39xmx1xhGW8k3BqZLk3YlVS3BBrhsCp7J7iGIA3VV+Gx1x8+T96wORavBB5RgHWziL8BYJcQRgSOnWTTGidR4GoVzRekXCfugUxYYzKymQtGYb94V0Kwm+Qc1xBWjTHAPJkdJwlCFpx1+zrxoCPuhIsLajG1NgandLwSWLHEc/PeUBZRlyE9c6YD7hZ/8az4GJHEIgDHxCrSjjy78RO9eEavQ4X4S0LNMtQsoha82ZDCmPbGNmcnbC3ILNwNyFoHMzf0rAw9bMngDlLdlAEtEcvBc16zE68dLEeOnoX08nL84n1eSFiZ89OYQTgWwMLqOqzP7IVSgfgrYxg6mCo38wgy7WCxviFTizLCqpYzIlmGpSUtqDNJvgEkhmeCiU9xnacyRxkYp7T9lTwLuPAr43Dv15zOdPsGlmMc6Sg7OFhmZGghQ8vgRBDLH398AsLiCSbQgXDABEA39T8hQSxoBhsNrZ3IT+RLNAeXDxtEJSqB3zZ/2ikIxleMHuDo9RiAaizT16+34D+LaeFaljNWssGwacFteV0FC+6G3Yy8670XXIT/3/RFjTvpPszIc1c/GqUfQZL/H9z9nRDviDR/RqSJK2IMN2IbdxjZIH8X13Tb+4IBfqEItTc+pVzFE5vQHoTU01EVkyXkuzzEqKasthdS0I6CL3iI9eEJRpZaUiZC84/pD30jEZrT6VMNInPoAaUL9IpsknLmlDCm+ES/4v8gird1FYQkdKiiyD5Dk+fZ4BZs8PBAATz7ouJO7wo8c4mOZeeJs6HoWi4jD4+9g9jRknEIqWciwpGBHRnggn7PE4ktFJV+61lJFmOooQpF6nj0MhjNrqByhj444/hneIHfg3inGkyPXoy/BU0VGQuXIhPH5Uv752hDtFkL4frYYgLqQgEmMhw+9idbFIGYF/dcSs9L8aSghGPxIDcob8KnVqwUyxa1FHAfWzFoijPE36Xf0258TrsZiffpNv1v+jluvORgr1DycccMFYlMf2N6yptC2lPChExXCf/a0sHvuRbYhMLI+3vcXsE+6wFvAxfs3W9u0xaKWhnwDF5D+zoDrNj8hDdritfj+GPfN5gsj3zYu1OHZG/QW6XbAgW4/CpwNwHEhmYaBKftHhLKPDAbQpkpW69MsOlad9+XoysIiYf/Av8QRTM= +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
\ No newline at end of file diff --git a/docs/api/beta/reject-non-employee-request.api.mdx b/docs/api/beta/reject-non-employee-request.api.mdx new file mode 100644 index 000000000..342bf9cbd --- /dev/null +++ b/docs/api/beta/reject-non-employee-request.api.mdx @@ -0,0 +1,87 @@ +--- +id: reject-non-employee-request +sidebar_label: Reject a Non-Employee Request +hide_title: true +hide_table_of_contents: true +api: eJztG2tz2kjyr0zpPmySsjBg4wdfrgjGPnYJcDziyjkp7yANMLtixGmkOJyL/37dPSMhAbG92dTd3h6VKkea6enp92MYPTrhUkQ8lqFq+07dicQvwou7oWotlkG4EmIg/pkIHTtHjhZeEsl45dTvHp2xFlEzVLH4EjeSeA5jjvRVXYlgUV9wxWfC+bT+dOTEfKZxEjC6KUrWkVPhrbxAsHcEuhAqdgDYF9qL5BKJAVJGc6mZUP4ylCpmDzIImKGOccX4chmFn3nAZCwWME5EwoTPVBjL6YolQGAJqF7yiC9ELCJNdEvEvORA8ZGjYALepO9sb12gtriV9Nmr8bh99RoW4bYyEiC3OEoESMibiwV36o9OvFoiah1HUs2cNUrC0vg29FcIsb3WQ2GCGGAKNgykRzo5/kUjQY+7qMMJigIZjFCDsRQaZ71wsbBoijRss9g0gCxULJ5vMYlyW/AvHaFmqNrTcrm8XufZvcv2QRXLOBBGaBujQeIaFueV8KTGXddrg0YvQ6UNvdVyGf97sfgN20jgiwXGg6A3JeU/LTqwgz1Sm4bRgsMuDir9txkKQIsvHGYRYdWriJOLi4lbEbWaezopc5dPap57cXk+rVTLp5XapeeAdAwSEe1KZSCmIhLKEywOjc60Dj3JY+Gztg+iQN88eoZJM7vLplDJAvXaaDZ74+7ovtkbDFqdxqjd68Jz97p9A0Aw2RoO7/uD3nW709oMDFp/H7eGo/tGH6beNzpmBvHgU7/faTcJE7w1G+/6jfZN/vEekI1aAxxpDUbt6xxwZzy0M71ut9Uc9Qb3w+bfWu8aMNTqjtqjTutdi3a56b1vDbqNbrN1fzPojfsw1L4ikA+5xxzp2ZAlHoY67etW80Oz07ofjhojBOo3hsPb3uDqvt8DHhDToEerB2P6b9jLTQ1740ETR0eNG/P3Hjhp3fQGH+h1+BPsNRx3cKtBq98bjDbviOh9u9dJOU/V0GiO2u8ND0DHT4a1nUjZUAz1Z+M4C6dkHqhijS9Xo55mOlkuwwht5UHGc2m8PjWbbvjApJpGHOwh8eIkEqWC8eZEmXr7VRyO0IbAZPc7TpHEdKdtt6hVzi7KlZp/Up1eXJY9XqldVKreZeWifHFS86uAf73ZM0WSecItsAJpC93G88JExV0K6c8RY3MayEKmZNn1jHJCnsAYAEt2duOfPBjGPE70k65E3tC6InX/CNZLj/1W96rdRQPp9tAAGlcfyBfAcjsdgNhRbgvQQYJbQthEWtWMNKcg8Ig08GTpLw1A2hC3kVyjSHWOj17km2Bj2YDdJjCwY2Ip6pDgcxKqrI9ennW8NOtMWRboYP0i9OVUiqcDsA+Rzo0l6aeI9XYujD2ngnjgmgVgzCxFXDTnarly6ZYv3OrJqHJRr1XrtctS5az6DyTFiwRG1O9JiUX5FA2n5fpJrXR+jjSs96bUVAFtyC1vuUbHey6hqd0q7tn64XcnwZRxCfyus6qnYGKH1HRITf8vqSmHMKMjRzLS51ikZ2eVs7NJbVIuV+Dp3DupiulJhZ+dbVqVW2iCJF+w4QKwO+uvhArr7B0oQxFmf4mejye2MD/dV4s3A4kBuxVFYcRcNhCgAoWZc1qIcxNoaxj0a1IBTun/pgL96bDgi5jLoBn6L0js11IJdxZxiRQKItmDhQxZlT7mzkUYCWZQpsZIcEWjAkmUKuwt95mVJWtaZlDiEfd+BVztF9jWWElYz9Il2D1CLP3atuJc8MlZ+bJ6Oj075bx6cVo5r00up/zkpHxZu7ykVCm0hpY5X3nwKOKrna1vhBKR9FgQeqCRf4FAIA2B7IkA2hztD7Svn9cB4XiB/EfAl4HN2LT0MjwpOGKcvW322ek5ZGc1S2icz7aEoNzxEE0+CQI+wSFskIFzg7gXyZlUT+WJq9Z1Iw1lNn4irn2hSSofzRJIBVuYQ6SJNwxg5tYiAHFA6mZvLNY3wBBXOg8ozZteaWz7fDHlSRDDCrv7nhV51GwahYuCK3nmWIW9kiVROmITHIPs683ZBPK+n3bsbxqeJ5ax27GSfMPmgkNt9rrEGr4vkUko18AbASmsXwEixn0fXdcgmCYYTSnmhklM5ybeVnDdiLKojU1E6eSVgs4BlD9vJw0I5EAcsZn3wsxaLIlWP0CzkVyRutFWnaVXKuYecAEd/wrEGEV4WDQB3mSsmQ1HqC4NgUelcFnEykdTCnfvDDGQTmjO44l+gd/1Awg/LrGWTXwW1vk09u4mGpE2UjXZiGQbe1psoTJ1pY7PoJ4N/IPvHnz34Lsv9N3tyYE9gbSzVPpUdkufseIJyDei5LlT+kRkPSpkKZCpcI0ij6BPTkukH29H4Ni/QmOI59lflniE+h3rI5PKd4hvZPow45P05CBN/RtdIIEkR8PBFCKR8OtE94ZiEpQR1cnubtdhNJFgoGpPiYgn8WwVJoyDyKJEKaSE6yPmh0KrH2I25xAfOXiE1iYCmnN/lw7+D5XkoZI8ZKNDNvrzZKNDJXnw3YPv/m/67pOVZEYVeYutk3SyWPBoZY9CzTz9/MEAgKW/hbPM5UhV29UKImNZjeUUKwdnUq1MKtNzT5z6/NQ/O7mcVr2zKq+dV84rk9PquZPP9XcbP86crOhTOX0bPZKIoYj7DHVcosC4dByGfvH4D8QbiSmGNQw9Wd0MMgeRfspqx+rlbu04CkO8B7JKKyRdqCHVRkYY0wB2gbBRCgsAnM0gLioGoUoCXWhKciEASwRGwwK5kOS8yAXgjVZuYxoDK8ZRUiPLdpHKCxKgkCJBEGLVHIJhSWBSTLHmAwxUwc4gOn/H6tSq6HdV8myAHHeQY9b64gmBjp5V7rV957ttID7CGDE0Cv7KQa/pdrgCA4CGwMSsrO481OeH+vyQ4w85/s+R4w/1+cF3D777v+m7v6E+t9XQ1+tzAHhxfQ6wpTLLaqlrNK7/eJlOrmIpIPNmoeclER03pzU41RVgSkjQMqR73XQbuu4c56+Uuen1MH38KP31sbl47eAlcKwSDYFJFMC6eRwvdf34+BH0Bvpal/hSltJ7dSp8KHnh4ngCwtoTh/DCgPE5BGCNftv2GSWSdCTRmE3kI+RG7sQbmi3In86In8SMVydQoaswgVhHaI7wAoo1LBoGEpfQVfygCbpEhrTDH/A1joL17+fFIPoKL/vE9+RuAM+A0i0W7cWP9M7+EEtws/vOzf1NWsG2rbqzWQ/Bquyt4BH0B+aXjFc/3o5esxkWnuT4icaaV0jsFMB1+mAiFNga6ak+LqJcE4XJbE6ENwq/m6AjsWkADLOPaigEu8vfABpAiCaR4iJBUQFXfXqVascXn0WAybC0kSQanvTVMUjomBfWvabERx2CVOZyG4yWPiqXXUmMRxITOMJYFqnhY3fLlC+e4+tbifhLis012FzCpl9vUWFEe+eZezgeeDOiAM8kaX3z5gafm8OH7RSMINZtGlASlo7ir11eqrVvpqOAz0V8RTo+qtu5hKxaXMZMEGMakmLgszbz5mGoxV8ZQ9NBN7ibJeBF30zWA27qkke41XKOJNds6UoXakSirwOOoYwx8QnmaCpRQqjelG9c8mfSLPj8z/SFys8Fnmn4DlIpQvqhp7+ZZtzQxQ1dEwO0pd9kKjQs8G3kwXwpQgbQ3OifIoElNBf3DK69UZ3QH9MaTA0ekEpY9LJuXuqbAGefGE0gdAYDYRhL7Oz3P3hnFhemq4Kw0sOBbQnu0huEkCW35GbozQ6nMHP+0fhFjhubM5SeClbfO0p/JZL8ceLufyniHSLNnzHS2KIXzyIHmy/wWptLudm3C9nXetBwg3ESkVu3e9El3trqbvcEEI+o5wL+wix5NlXj0OtQ97Zzq3kZ8Bh9gGKAN5eCzg6WgsdYKR6hHYYL8lsoxTFYQIdIiGb0PUEEDHLo9mQA+Oh0O92Zk3uZMhStAN91Qg0M7uXNoRcVJXYL7ZzyQInYyuH9DJj7JbQ93RD02KcPL69S02D4yWCi8KY0kJ0sGAcDfMZ+fKm9xIQ56OyUSGURUqGYrUp9Hg0TWShRUxMtdG+Kx9LQ8ebM5Jm9wEq0PZMG0dN3EOby9IaRgQjIjhGuWOQ/hxts052LYIlGAjEayjWR2+Fde7SDEZApDXxB0x5Gs2O7SB8jLCDBZsqYz0mpUiq71FzAOPZm0P7mkA/st6+s8LnF5vPcgjE+bs7kv9N3tDb7YNtwvMSDL6QyMW2M6SDvnP0dJCyu09V620RCWzLHzhMWPD7iYQl2VWschs2xE7/7tGmYqNEE6eMz9KxTwCee4PXVwH6j+pq98BvevXylx35qten4HXj8VeBBATAD7TRwQSc5RKGZsD8duPT1wWbhzm8i2FyaFeZ06EnYT7mOvd+jr0Em9hvihTl8iPgDShf+1p2P8A9ewqWxbwCi8UcnPcoDGIM3ra32lRb2ATQBYP8G3yxrgQ== +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Reject a Non-Employee Request

+ + + + + +This endpoint will reject an approval item request and notify user. + +## Request + +

Path Parameters

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/reload-account.api.mdx b/docs/api/beta/reload-account.api.mdx new file mode 100644 index 000000000..74887e1d7 --- /dev/null +++ b/docs/api/beta/reload-account.api.mdx @@ -0,0 +1,96 @@ +--- +id: reload-account +sidebar_label: Reload Account +hide_title: true +hide_table_of_contents: true +api: eJztW1lz2zgS/iso7sMkKUuyZfmQX7aUa8pTzrE+Kg9OagORkIQJBXAA0onG5f++XzdAnXacZFI7kxRfEppsNPrG1xBwndhCOVlqa46z5ChxKrcyG6SprUyZbCWlHPvk6DKJb3zybivJlE+dLmgMRpxPtBeD18dC+plJJ84aW/l8JgInL8qJEjKMFpl2Ki3xceTslL+k1hi8sk5IkwmIMrJu6oUU1qhWqacYOx47NWYJReFsqrxvC/HWDERpPygjPupyIl6d/vrfwdMXxy+FrMqJdbqcCYjl1B8VpsxAKlKZ55gyCNuGal6lFRFCvevkwiv3xJpSfSoH4EAq68wcRcF9y5eyVEdTaeRYJe9uYIVCOjlVpXKeGWiyRSExdCsx+IC/dEazpBM1lcnRdVLOCnrrS6fNOLnZSmrpkqPSVWrTrgu7MSf1SU6LnFio0e7hqN/b7R2ofm9vvzvcGw4Pe92e3Nvf7R9khwnJ55QvrPHK09zd7S79tzrDgBwmSuk/iEyVUuces6RkBLge1LIocp2y5Tu/expyvaTOGq9oqBAFop6c/AvOBhrXc8CzAtZ0JdwSiKNXk2WLkPkp1qLR7PB3RAkoQIsgKXVQCzQbkuhM2BHHFmmWbK3ZfdmO3bS/c7h92Dvo7R/uZnJ/e4ee9vu7aRfP/b3kBl4qdcnEtYZstVPlq7zEd6LobW9vivEk1zCjeOYcYrslTlVZOQOVdZCNNFW+FEObcaRqcyVznbW/xgOft00w9xObqc3gW4+15xrZNnZwFCRULHKKgeSZK52R86bWqejB2rxM114xKCzR3hGPZQZ9g35PojJkSCfTD+B1nN0v0IXRGC/qIUgAgcJw17TqQMnh/na/2xvt96TsHvZ2DvaG/ZHc3d3u7/X7NPsUEYbc9UtzS+fkbGPqX5VRTqcit6gY+k8YxCkJ27MAPDmG6FJN/f0+YB5fYH/K9UA7VzPKK6gibaEePn7yWvQORC7NuOL3crxmBNO6OKPiU+W5HNIrqirQPDB+5fRYm9tEUaaaUsI9ffZ8cHFyjjenz/5z8ewMT8Rro+APDKI1o7CEqIiFif3IEkcFPkovvMphDpW1xaPI9REUksYvE+rwl595GBOxNZJIKYyIs98yYpn1YgmpUykN5Vs80G3V3hJDejeVZToRQ+kxAC4k8kdIZFWUrZNoyUdiomSm3MO2GGSZJiVlLpCNYIrxMzASMssodQODUYVUVrzu2KoUxpY6Vau+WJhy1RuLanKy7BRKDkh+f5wM0rKCcKzmchbOoyWKGP0DmYPlVqU7XzIam3SGGp1CC6yQM5jR0SIthtBNo6DHckTu8ig8pqabV6zlIsnl7kUQ5mlp+VsqK/8Fefc6R/lpsWrzD1cqJp+nFTxUI/ZG7aZYkfCRCz4NjlRzd9WJL0Za5VmTu03uNrn7hbm7/vE0orr4laHPzib0uTARhNPiuQF9HEePsTVS/zNA++DILQGDRIj025vzCPFBrz4VBAy/Iz4KS/kmkJ37I7wfEvyYO2vFFyQg2zFoMEIlUtkRy72QmA0VTLW7Odtz64YaAWpugYiomk7MbCUkTOYqwyBa+i2RWeXNL6WYyCtuESBvqIA0q8lahdWmbJBkgySb1ahZjX6e1ahBkk3uNrn7Y+buZ5HkXCrOloiTfDWdSjcLkRa/k7ZSgGCxvzhPOXbVOlohZmKOsZJV5JAMuzvDndFBqnqZ7GX7u/1RN93vyr2DnYOdYa97kCyv9ZeLPJ4n2WpOLfk7+JFNDBB3BRxXGQSXL63NVrf/YF6nRlTWqPTMcTNsDpO+W2DH3iZ2fGlL6AbGwI7uju3Fi9MT4o+pmT3ZzVYuVQSzg+lALkuGlBTDsLT2ZQMdG+jYLD/N8vPTLD8NdGxyt8ndHzN3vwo69u6Djr2vgI49QRBrRBDr74SOGXAHQbMRnAId0grmNQQbC6iCp7j7GNO+lG6syjnQW0GR3f4mijy3VryQZlaDJb+yE2kW5qLyBtop0bqaFgRSjFEiDZ3d0Db89k7HNoBJET8i11PNeUwKga+btQajElqFnKnjbT6LNmleQUIuCrmlvVeLGNMIJzUi+AcOvA86RqH+jnuc0Vt/aT9YnJLGJ6SxePYpVYpyfr7/u3fbKYFjCO+oXJwFX99xXCDsmUuDNkJ9KkL5mkPQBqo3UL1Z7pvl/udY7huo3uRuk7s/Zu5+BVSPaOhuqA6CL4bqoG1vizmWek7B9X9H7JwqUQIOb2FTxurZAoMzrkAokUCF5Y1WPjJ8lHTqk8ada53ddMLh6YQOKRMuDCJVLgflpCwLf9TpXMNT8NBNWxa6jQIGZ5UzYz+2UzvtDGGeWyoPHTQNWUYEfGo7TNBm2zpN4RtqHTMPlmZtKFBhcT5b8FnOdPiZXDhD/yECmy2BUI+hxK8hYoE+4hfP1G0OnQ39oNeFy2/+ui6B0R263Ga+z84GegFJ11QkFd4tzpSfEegOs2+cLF8sJLTd392Y7BWRdcVjJR06gnAC5sFvb84fijFBTU71yhPKVZp6AyTLa4QIl7JBfRqEBvHq4mw1nrDgg5XzNpQ6YpRDYfHWnCklLo+jEV6ixp+iKLNJaZDiOkCj3j2ovZOpK4Qolr/2wpIUeDozHVioI1fGPeSljnsCbeiEP79tvzUt8ZSvBGhasokmqsgtnrgsar3kkl7fKsS/am6twK3F3PzDNSmCaS/TcH47Rf4SC5l7ttY3Tx74tZb4UQOFN8R1XQayRJRj9ZRUWnvtm+VY4dcifqtyvDVvJhrr6OowEcqW8FgG80wci3RirVf/FoJCh9Lgclwhi75ZrI80aYszotXdXhKpFaZs6RZQIct3gsQwIZjkkFZlBiU27I9wSr5nzyLn3/OtkvcrOvPrSyyeRJnZ1H+zzDRhiyZshRrgo/zxogOERW6TDlwHQgA8WfifK0EUdKnuBV63VnVm3+ExtDSkEJW5+OIo/HG0KHDxSfAHop7ToAwTqJ6fG6N7MZEXLVArxqq3A9YtuClvbrEurtktyDv/UZPWyn+avqTxYLFr8srks+9dpe+oJP+cuvs3Vbym0vyMlSbCXAo3njb2A8tB/jjitc1dPNpmnij8i6+cq4yo0a+EW36EYpYZFbksKao5q9OJVtz/F0qWhP22KLLslDMxXjFDl8eMxg40SFsPTCqHOgc/3qGuZ5acMAFYkl/pb1/F8xIWIYl+UrXFG7RkBrDdUTtGJ3Xx7Xcb+7IzeOY1OVY8rZ0N0DWdVoYuJ0LsaiokQuqeiMi0T6tQuOJdyaCCZeg3H1VnMYUaqdDmxsRN/asRbS2ja11y/D1zwe/1TUCYnrwYLzQuFDlVOUcm0a3C9vt4I9paE5UX1BCi6gKAqaUZXhyfb3AEMxN/zLBu3ImDfIdowYTaoxA+u+2d9naL2wW8p/4KLewS81NuqsTicutK9F0vNtJ/3Dutcc2iZqNT0AYZWaIKzU/oNC+TutME+RFfLI3NJtqXCfWkILm+pm0U6r5u6PUflaIe/fLdorHihhQ+pWd0syNUmfUbrMsGfXAapX7IPwSt3Gu9VeZ668/MFl1/gscPijYLMA4tNeTl3RyWJXwI+z1LQzZ+EaEubd6Dv35FO1+Mbm5b8eMDFEdN+x9RTV3W +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

+ +Async task details + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/requestable-objects.tag.mdx b/docs/api/beta/requestable-objects.tag.mdx new file mode 100644 index 000000000..73415f57f --- /dev/null +++ b/docs/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/docs/api/beta/role-insights.tag.mdx b/docs/api/beta/role-insights.tag.mdx new file mode 100644 index 000000000..9391ab42b --- /dev/null +++ b/docs/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/docs/api/beta/roles.tag.mdx b/docs/api/beta/roles.tag.mdx new file mode 100644 index 000000000..0600aa51c --- /dev/null +++ b/docs/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/access/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/docs/api/beta/search-attribute-configuration.tag.mdx b/docs/api/beta/search-attribute-configuration.tag.mdx new file mode 100644 index 000000000..3de8cde31 --- /dev/null +++ b/docs/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/docs/api/beta/search-form-definitions-by-tenant.api.mdx b/docs/api/beta/search-form-definitions-by-tenant.api.mdx new file mode 100644 index 000000000..c13eac572 --- /dev/null +++ b/docs/api/beta/search-form-definitions-by-tenant.api.mdx @@ -0,0 +1,95 @@ +--- +id: search-form-definitions-by-tenant +sidebar_label: Export form definitions by tenant. +hide_title: true +hide_table_of_contents: true +api: eJztPGl3Ezm2f0Wn5kMDx3YWIHTnyzsmccDTTkzHTue9l3BouUq21ZRVplRF8OTw3+feK6k2lxdoMjAz5gMpl5a7b5JK917CJ9o7vvFOUp1EM3YWxTPtvW14gdB+LOeJjJR37F1EbM5jPhOJiDWLxYdUxiJoeQ0vmouYY69uAP204LE/xUlOxVgqiQ365WIoFFcJ9M4nAZj3noIfMCoaj7XAZomwPqQiXnhVDPrU51bdqq5KxETETM+FL8cLqSYsmQpmJoE/9GssY50AojoNEzaOgTJ8OxITqRSOsN38KAyFjyBabAi/dcJVwOOA6YVK+CdmcBiJgEnFbn5/ytpvumzgOp1ko9mbjLC3j6ZJMtfHe3uB+ChC5E9LcxnOI6mSlh/N9mSg9vhc7jlgzRyLZs6gv805IAusVZOmoUM/bt2qYU7qRx6mgkmUhx/BNCOuRdBgKkpAWBPhfgMQolWqQHxCCuNEM56wfRSf9qdixr3jey9ZzFEW0nAXmsYgRZ6YV0fPSCBjDmh4x/sN71NzEjWt+IxovM8NT3zis3kI7w6fQx+nJt7xmIdarBiUaUEoZ3KDEvSwyxodmPFPcpbOmEpnI2gFIRvWaJZE8JiksUJBcqZhRChImj4Pw38X4XfHTCYocZSxoV2SiJmVDSMmYo9UG/v8EgED+3pCTZKpFeBMKvd7vyB+aivKksTyhfJ3YzLxj2VIfmGtApxRJ2vXSKST/I8kO0NJUXSosmfuLUpHp/N5FCeAHgjBOCyYKrrDZhBpCBqLZmucaxTrY5zhyRNk1ZMnx+yJ+NBgk6TB9F0DCHxiWgusWt3JjwUHuKs7zKKAtKquR50+6QSJ8srSPbPCLOoECRpmYrfebIF0z249b4OW5PNkeqKRb5v0ZACdfnAtQTqqOjIw77bTEBAPKUSDFWhvMCvgBssFuVZsmVkbBpf5P7DMXpLjJsFlA99iRz2HNEBoBH+4v49/yuK6JNcMOg/+S1MMR/VAp+ZyCDZasMRlEX4EPgyeYB4+n4fSpwRk70+Nk90XaJ3HKJ9EGtB+lJpBZeAn+LoUMkgg6Dwzmg9qvOWSPy3ST5Mi2+xsy2B7ltJysnRpeQV+XswIB3pYJkYGy1NeKQnmwCapBIUOgEOF0FhhaIk6b9/+a9b85/7lFNdbfImM7inSbpqqWF6gG3Bp2jqszo2X2AAYp0NgJSBVmGdlOD/pos3UQi122IDBaaEnIBLdKVCHJYGZGeoQ6+OAITSbjA7j/GnnYtgd/h8rNXdJpAl6OwHqilm764gZe05C9nYF3ji6iXgU+q4EVaQUm5DENcpn9U4aW3IyBoYTW7652qGifc66RKM/wdG6LnPuv4c8GN5PZDJNR+SdM1+9p+dNRE3vBdGMSxKyTEJRFArSionUy8Vq+zUwi1GmqtTseioUBIsYE8+FBnvG7Ay9HfZs0BgMPOC4wXMBp9IE89VsKi3ij9IXJofFdBaaIH+ngGamg3jhp3EMnA8XFhGZrHEeq3XxiqgtKCO7Vdf9y1/Pev1rVu5wHcXvxxCRIGz1ry5POpXmQZTGvijoqpsGXpkBZaUtNG9U2r+I0V9W6UyKRZH/++i2YYmXz83jmFdtPe+EM3XVPK2Jnb1iuJbYJ18dQH01yYjV9KZUmBOBJhtavi66FaSRZ0YO+oPIoLHGXgohD+GXvPhgeNm9eMVWdBs4cM4+TPeyUdh3W5jElsDqVD/kIxGuiNObWEyvDjYwsUcAtorRNN+68Nx2tXuwgNmlzzQU8Dy2iyGPZAtclsnloGohZCA/Bh1sMJH4rcfGdfpcsZFgc6415f5Fb4sUp5iAKQZ5ZkB85CELo4n0vyQReBDLrYh2gwmfZYZrrbgTihlYz5psVAlta44ZE7b3F9rpWWFswVofyDQtoOFKC+3kHfKQNuz875BVWofiUwIt/Vevep2ltmgCOmfGtS877bqxbfB1t+p19xQyqmr7axkAI27Vm9f9i6XJ30wjBXN3ztvdXrWtA0oQgivp9DonSxgPBNaVt+q0PVya9BR0HsedDLv9JXQGphy9VSf93tX5xaDaDpVvOlO64JyQcPhpuIMPlhHwaCiGByIO/hIhGOUJaXhA/Og3IQNPFmzZ11kQ60ReQBFlD/Y5lhMqAwNnqG+K+ll1OVCW4YhC/MnA3zs3CFYMVXqCcLxVNpwVeQS/xhvv9Gsb/aJy6b2oSa6Hwp8qqOtDBs1lzxHk4lmvLL8Kyl7A5mVACwQ1bm8gshrcovd71j0vwTPgN/eF6YzL8S47v111LzuntNTx7T3+Elp6gMvmDxJdLKwtokoWSGxgOXGRsobHJ9UomsdgG8N5CGULLVct8jjMNT1DxSPnkkKJxkgtYu7TGtkd0FetcqqrSvNYaBxq8s9iPMdh5VAWp6Ho2/XWNURcQrceUsFD17uU9LUvTtmmzm0V3Kr+5cZ+/bjggWFi+NW/LDtN83ZjdvjNsSoqxGWRc7jkBb/XpBjUvCan0FSm1Qd0yn+E0QwkOi/AIZ9DrdDkskTQYt0EVCQMMc8ToCpUfcdiLKBKNrU0LyS17NFoYZ+QqMcsil27y2Qe0QpkwS3RhszFm6thmWODDH1KvcDv9jrnnYuVvZzRFRZ1cFKMo2ZgWeDu5TZLO98SufLibiYhELeRV41vpfesyaQtmrNRaMrr0GoU+hsxSyNyVV06NCJDYfq+mCct9jq6w5WWxhcBtVQ2blUBbgUkLwufXqlMOcz2YiwBNvgkbb3B18Utu0zx2e2tb3RHJ9EMppY6UrUeqfMb26J750PKQ83YcIqLSVmXbAvKvrO2Z3lEW8s8nkAUxbJJ4BwyWQBQyEK2AHoRJd8CLriEHPJJfxvI0CWBALgOsDnLUAYMctZCsLupII8iE4wpZiLs5Vh+0R++2w4P4IBDBb3JNkO6yg9TUIcvRF3S3rEw7OZq4eyIcNYW6e0wAKQdEphWbqVes3myMDC2G4CqYcYMrrfpP6BzDdeYFLCTqfDf60xK3C4EuLMPlDlwFVGjTke21a3t0S4lvWoZDmdsRW5zLZqQU2hA56MT9XYYAkU5ksC3rQZ1VLCBKAE9vj1J22GHQrIIFuJX5zf4QZXgSR+fyBjgoXthf9FD59z+oofBtf1FDx33Cx7K0e+3bQLfzuPtPN7O4+083oN7vNKBtkIFRBpWX8GUYPzu+lGWm28Z1Hcyi/jWCLLDf8gWnuBCuCHXTfKu1x0M185EBVl1NsWo5kdGWpZm5lJTT2QzUt6+jNrKgqu1ovTIJrQ5+XZTrq3R1vABOXCrXvb7vU77YkWfl1EUCq6WN2oaXoHRFN7KZVvDsw12/r+4s/Ov1ImdUmytFEUXkDVnPmDZ/l/ioVwGoQvdVDagXCp21AQCvKipDWnAA6z+lajcsP53Scs7uPUyHuPJh9UrPbbDmiW6DvVg8zgKUh/4AqLi+TLd8iKdmbHesw7tepDpg4oAA0kTIIIoe9zbLVOCQgsmUEY8P2MHqmQWKEdh5L9v0WJ7IavrZMBfy0Awdio1HwEvWGGJGU3tdf+6btBgGt0x1lF1Y067g/bLXi0sC2UluM7FqpEG1CqQdt26buCl2cG/Vf03uLrf7tV16s/NSioQfPXyvDt8d94ZDNqvaiccpKOZTM6F1qCd2QCIut2z7kmbdhBWjoKIK8f2iB9uOAzfnXbO2le94bvf272renAiOTWnGslequ5CTlQUGyOcp/E80sb8rHdHmaNvf01HUaxg0K1f2AfLOFyMtezB7iUe5C+KNNIWWAX9clCwsDeGhJ1e/vfoZWn/M3d/pe3PsiNsxyOZxDxesBmfu3INgza5VhiSmi922KgYi/K5W95yeCm74aBARc+dHqlqba2nx04/gZvFQZWDHb4PckC3fSlm0UdR2NzfYnbTEWZeceDg54OD/aOjw1+Onj49OPr56AWG0Jqt3AeMrIYBG2Jrx4bUh9nfy3DZYoevsKOHqmYOldeUM6bBrZbjSZu6M5Dsjmt3Mr0k9cP9w6fN/RfNg8Ph4f7xwbPj5y9aL549+/no/73CkWuctplIOna+buncYoMYu9Pvyyif2xaHc8ghW1mLeDbXw2HukHrwc0PugPmmJM8eW//26GByuOIDwRy3zwj3Wd2nAm3FRBxDukYLAGaH+AOUIpBw+nQGFqW09QcCm9wceM7wJArEpu9dTvOeqHsmoBSO2mY8zvJgx44OEmMjkNPI7DMVPBVsqHXfUDA7t1kw2OioIY/lYU2u3KP3Dp49O8zM25KWC9W8Gmw63meG4UlCeurHciJrDvj1Cq1sGuFHThDktMRkwNSTmL5jNkJmaVBE+3ObuiXMbLTdCjeLEeqy+FRzjBWP1zhmcD9JoU7Ejm41yYjAcr6EBAVwUyFTpw3YIBwvCz0bTIgn4Jmgn3nYuxMjrxK0zp2e4S4sFPyprujqmm/9SjuO+VhkUQx4Ae7dYJPWD13PU7JYY7MH29gsT5NpFMt/mDxkZ7k7y91Z7ne33KfbWG6qRYwLKzMJ8seFlJ3x7ox3Z7zf23gPf6lhbxSxGe572gxZf5GJFg1lGwvZzjLKtl093OfaHLyiNhhOMx+bzVUOFc3EOyFiPGQ6EDF+bNfZQjN2DmTnQL6vAymbfYW8zNAdka7WdaNYWv0orkTmL36w/1SMf94XR/zZ4XMxOhodHIyC0Wj/+Qs/GD3bRHbR0Xw98eShnq8o5qWzWm2s1shsl1TsfMJ/r0/4IZIKxEOANuEtAPjhyxUYKB7cwi+RUrwS6MbT82Na5DuGLAOJf4ufwMwElPZ4F9hEmBu/sK+3Rx8AFy708HB6tHhzE1ga46dX7mqVe3PVx+cWn8uWtHcRqOiOuDoC+1zaAHDCM7d8JZzMzQBAy/rIY0mbTcQGc49Ivo+BPHGiWjuzOwy+iNLYXkfSQOu1n7DQazqdphY/aerdQm42lugDuq7i8PNfp8VMtIKWOvathQb9GWBaIRFJeJtrwwA9roG+pBO5F8YVnsMlYH3sdsheCh6Dr0+i90KxR3+/Hj5mE6Hw/JQI7Ff12Tcbb0BF6NuhbIMIB9F+fRylE1OVtkvrSZRC4kUA+KnnQAh24+6zuACHdNkZDImlOAhfm4iy/cU+vDTuMR0emEUxfjJsTBOPLtyqJjuVsfkQTlMfS6LZibuZO7p4ga6vReJvbramma1Js+GlQiUsDGtv/JA+qPIhwOIUeDwSufXVwM18zcJ8zUkMitPEWas4mO+rCY/yKqDvpPbVeJTma+J8ZTxu1fVU+lNWHsaMx2J6GqVhwLrMn0aRFv/DGKoOmsEN3qgjvhqtOwTaJItoHu4XUGoakE3ZTLUg/HpgGMooEx/hPSAUQSMGbjMwJvkHSRZs/g86E/xHiWZ6fQMRGXsGkf8Ft1VVcEaATQTYND5AW/xNGoWKhYEIaDA3K5ECnOTyJ09gES34PTNXrVen6fdoDIYGH1A1X4PNj82P49zBucvuqAF7Z33ADWOClm0lw29m58KAVmKWi69VDi7ji4eCVIVvBl83lrb3fjR6keJ2njL3Vbj41l56hSf5cfzud/J4O0/zn+hpbFqM6lYs+4pK/tLma0s2daXpfIGmq57IVt3HzPnaenGiecgTOotAHzdO6cvCWMwFTzD3a6BmRTOyRKgS0fyFPRM/oTMQsbkXZSTpGxG83tRB5mQwJrFEueJvnZpvaPHGnilXE9Fi11AqKR/EggUqiAfb/gRZEqIDkMwbFCw7dcKGpGs2SyG5p+vT0hneMLtJIwKp/dQ4LqjylXC8MIf6s1HOilHVkAQqlQXUHf3xwFyNVRD8Blggd7cMCqxHKWZVvyPkUoTclSjltH3T3KBtzakI51Q+A1p4lCGHcN4dLs0IkynztUoriid7dpDew754hhiIN+rztHXQ2m9SuQDvodROoOYqTN75hLdFrrk2sVXVyPt8ZWXN9c42UGCGvwcqaQrv1FQcprS78ZZKOygWpoAhtt3f4yEzrHU+42tzWycWfIE5NZjfHrkSud3Nzw9y83OtZOkyjvw+bnuG3aP7V7eX2O6a5i++pnmNNNy92F8pjN2Vyd/7yuQ1ss0vvf5K6e4uOq5cdLyG2fnN0Tmz3+braRCW3kLfqeAB3t8KMcoMa9PVEoVRS9sQpWXPVx0M83xFoWUfENTnz/8EaZlYAg== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Export form definitions by tenant.

+ + + + + +No parameters required. + +## Request + +

Query Parameters

+ +Returns a list of form definitions by tenant + +
Schema
    results object[]
    + +List of FormDefinitionResponse items. + +
  • Array [
    • owner object
    usedBy object[]
    + +List of objects using the form definition. Whenever a system uses a form, the API reaches out to the form service to record that the system is currently using it. + +
  • Array [
  • ]
    • formInput object[]
    + +List of form inputs required to create a form-instance object. + +
  • Array [
  • ]
    • formElements object[]
    + +List of nested form elements. + +
  • Array [
    • config object
    + +Config object. + +
  • ]
    • formConditions object[]
    + +Conditional logic that can dynamically modify the form as the recipient is interacting with it. + +
  • Array [
    • rules object[]
    + +List of rules. + +
  • Array [
  • ]
    • effects object[]
    + +List of effects. + +
  • Array [
    • config object
    + +Arbitrary map containing a configuration based on the EffectType. + +
  • ]
  • ]
  • ]
+ +An error with the request occurred + +
Schema
    messages object[]
  • Array [
  • ]
+ +An error with the authorization occurred + +
Schema
    messages object[]
  • Array [
  • ]
+ +An error with the user permissions occurred + +
Schema
    messages object[]
  • Array [
  • ]
+ +Too many requests + +
Schema
    messages object[]
  • Array [
  • ]
+ +An internal server error occurred + +
Schema
    messages object[]
  • Array [
  • ]
\ No newline at end of file diff --git a/docs/api/beta/search-form-element-data-by-element-id.api.mdx b/docs/api/beta/search-form-element-data-by-element-id.api.mdx new file mode 100644 index 000000000..fc869bd88 --- /dev/null +++ b/docs/api/beta/search-form-element-data-by-element-id.api.mdx @@ -0,0 +1,68 @@ +--- +id: search-form-element-data-by-element-id +sidebar_label: Retrieves dynamic data by element. +hide_title: true +hide_table_of_contents: true +api: eJztW1tv2zgW/iuE5mHbIvIttuPkZTdtmkUG6bZo0ulDHKAURdtsJVIVqaaeIP99zyFFS7KVS9MALXbdh5lIPCS/c/kOD2nqOjB0roODi+BVoY1KybHKUx1c7gQx1ywXmRFKBgfBO5rTlBuek0/XMxA5kdpQyfjJ0c0noheqSGKSUsMWhBJsJ6IUICdHnalc7/464SmX5tbe3LVDZ0INMQtOYmoo0arIYUim5EzMi5wiuE6wE6iMu4eTGLBqTnO2OK6mOYK+L5erOaFD5vGg6teBhAfo2FQMxASqnlGzCNbtcbymIwjk/Gshcg4ITF7wnUCzBU9pcHAdmGWGw2uTCzkHye/hXIXlnMfNOW92Av6dplmCbb3yX9jyH//vvuEaytVNcI9ulQd+SrVqxrpm/bsFV5gTkQrjsX4teL7cAHuKIlM5lSfS8DkEmM44E7MlwLFxk9LvIi1SIos0glY1IzlnKo81MQr+NEUuwY8Qdxp6JJwcvjshjCZJh5xDbzRkTPOY6KU09Dtxc0c8xj4Xf+1a8TMv9EolCWcIjKwCXl8+WxiT6YNuN+bfeIKh2tFUJJkS0nSYSrsill2aia6fLGSrccIqUP/I6FxIiHI5D3Oui8To58CskxkRhghNpDKl7oLHO6BQzGcUpIg1IkoUmsfIlg3vCWc6aMIgoca9Gg/hBZjvlMs5RMnBYNSDZyH9cw9dYaco2+outW5p+NyKVIE0o4nm7X2qkBWJpeidAXBshUhpElDSe/538p3TpO46DNlj/xa9o4ssU7kBeOAEq8AMhlJX2AwuTSBiYQriUp3K9QGO8OLFN5oU/MWLA/KCf90hku+Adi9cU0IjnrQ36SI6bWtti452bpeuaeQrOyHRV2QapEtin6ZBcI/XVyNdoqDOlNRc4/QDSG7wv6a333NAA77QJF7CAIK5hQG4TIV1LHAbCG6SJfyFsJAvQAYwk4jd2hItN9aYWQ4r360rDGgAzwZkEQ/NskQw29D9rBHUdc1mWY4OMsKpUDq7TQ0XrQtl/Qoc1QZz09qidWbRvLJg3tq+GtjOU6REZfbrqZ9oiqvZNCgtfzANDpMZ2J0MRiO+149nbMynwc408O6vyXRqMv8yXJsU4rwjYkAizFIrWGjBoLa3DTnbdcD2+5PeZDgZ9CfDPTbq9SeDwR7j8YD3x+O98RTZ3MQj/uaER3Q/HrJ4sBfTNjwg06nLPAGeGeJhm3ikURKyKun1Z+N9tsvb8JQynZXMU+DZBzx8E08e8yShZNDnexPG+6NRCx4n06lknsJfY8BDW/BImsSKxJPRZBCNeX+vDY+V6VQyP49ndzgYjyct8VPkPBGU0BgWogH0m7TgcTKdSuap4nm4geclzSPI8mRvwOiwP5nF8SaeUqZTyTxF/ERgn96teDjv08Fwd8xb+O7xVDJPYZ8R2GfSgmeZcE7Go0G8B3MNZrtteFCmU5P5UTwjh2cyqPBMojHlm/x6mSv2hfC9cTSC9mE83G/BgzKdusxT4ZkBnssbLGdsDq+WWBV9hjUL9yWN5cPi3lw8LFQsGVx9C4ueW3hhEYyFzhK6xD+xESq+nFwtuCSa26rElkbQU2Xlwra+xlerSs7nsKpoLGRQ/ZAyBo8hruX42AP3j+J4HO72RuNwuNuj4QQsFs4YY7v7oygas9FazWBxY8Xgzb2p2lnZ4rUDyU3l4FFd2WbXBAaIoXSUhRHfsOxbJlZPRRY8yVZlH4GqyrlvtnywEdY08PBQCev1TQ3+wtcevpVBJJoCMooVHAEE+dI5ZeUi5x39YFgcV4/hcDiBVXLIaD+ivSHnfH9/n05muyxeg20xBTc35duMsi90jg1zYRZFZAvZVVnb1VmI9ZHuxgqDC4EIk6zt026pTtAwJWya53S5BqQseyyU9dD/OWinUEDdvuN/X9aVMDFOPWyrLA/BNXkOQXIFM1vXlKFOFGNFjuXrD9SBdxM75gZ0eqVifl+dfVRJAvAUGAjmqacOb+YqpZQWeY3KvHEdVnTyux3c+jhtfclNyrEJjtsJNv2zlpoUbJJbwv/UvvfzWbtBie3eNkNYhh/OWoK8kTBcN1DcTfc2F3Mhb5vUtZYldaYgdUVJSUGNtfXCJw0H8Qro6HhnPVshO3p9fPjh9PxB2EpEGM78u9lEdg5vvTEoMwWFRIavAA6+ci4oLd8AcY6ZQLiEgUL3oMF5HkxwahKqQc790b3iUXDTHO6NjzNM1oaaQq/F6h0nBo18WfVFE+WAC7DjId3dUX/uJY8sYx1n+w/hLC3MQuXib8vLLXO3zN0y99czd/chzLWFEMRpKmzRqbfk3ZJ3S95fT97hQ8iLNLC/QMxUIbeM3TJ2y9hfxtjBfot5lSIplUu/p9U/RNE6UR7CkIcxo8ntJt6KzX6+ejQ4SxOGze4n3LXIxN+C8VSanPH8G5QVrx8QGdsEsk0gvzaBNGm/pt6K6F5Jfzrle5FCiq949OjOOIVNOpWa+yzu7fLZpMfHdDgY8Wgc9ftRHEW90R6Lo+F9atcTzeOVtxlqdMvxm/Cs1Y61zmfbbcA2J/z/5oTfoqhAHByiSZilvS73AQj6Crn43RwWeBXo4hJvb6TcLBRewJtzG7J4t+wg6CLG0F+V093164NdvHcRunsX3bXLgQFOjLnAXdMr8gQG9FdyriEXUGluOjQTqx/mpLqy9o6AucH6VSHvVnQ+ClgiugmQc99oLihErSOyHdzFVHnJKVg58c6R0YoYYktQibhhdpDXAq+VLd1rvJsC5dg/tJXuoJ13NvQDvT7kyc3P6+IGukWXNvPdORvIE0C6piKqcFnFyRnmYjf7RrRU+RlPawcbk71FsQF5yWkOq4BRX7gkz/78eP6czLnE2088Lq95cSAYiFDyDkJE4dJxaH+lLDvZe1S5KuZuk3rYOBu2xeUsAYXJVJ5xTi5OSiP8B1LV+9dn59ak2Alfu7Xm4RfCaKPfc3upK1U5JGfpSItXV6cyJEcid/fFtJUpVXS3li4yrxet6fVYEH/40fxvuXY0vIrWQOFMe8ESgYsHg6UXh6CJttZ69ORuvLA2XjjPIXBCHHUdA1qixNE80Wfea4/G0RgvxPGaOKby40LgTeRGN+KSm7+sfELYQinN/0kIhg7S4GJeAIseDesKJw0tI8JBrwYpdFOGIiw0t/hOgRjSBRONVGHc2qrITMjYUfKT9Sxw/pO9M/ipobN9fQFrNUrGiv3ALcc1zDhhiBOGLgfoEr8rsDCwcIkCHWwecAHwqvK/zQQl0Frec2O1ZnU7fNf2waWBAVQ7is4O3MNBleD89VfbgNIrGUjDWLp5RhF4JuVYuNQ1jOVX3nULbuJNFNQia3ZzeH1fRPHb6YsaH1bF9FuZLJ86S9+SSX6fvPuLMt420/wvZpqyYMZwq28I60H+sqzXNjj1AQ/PFlzbzxAsV+2eGPYu1VF7faAsocbeZUZWswVejIYtZcahoobabwcjS6WWibB/RPrDXswONM9BBi8eQU1KI5HAePaDBz8ztYRxhSX6FZ91YTejOBdbUDnnHfIRNlGSgVtw6wruwbbP4EsL9Aw88w4dS468s6HoStNCwmzIyyLFj3vui4hYaFa4xAX7f8m9LZQt/Va9PIsx1FAFu4nmearfzvAQUDBec/w9c4Hf/QEpmB69uDoP8Iq85wl1N5521sr2+8aGaAvxYprdWAMsvJZUzfDm5HxjRBhMuv1RR+XzbtlJd1EWL6KB8i58djv9Ti+02wV4D5twk1JZG/yWy/PR0t+F76xH5HV15vKbfwJWLla4y+gCLdyxQOF2PW4nehE0d6LQ6WDji6/aZtS3V18mwf5mAUbFoa6vI6o5bs9u8LX7NAX3qOBm5F71rcOt9tx+ufTDXy61OvkLB8uvPhUrr2UG9juihztj+xXR035FdIenqq+6Kl9dVicWP8iiZ+/Lj4uek5ZvMlth+LNbuaxjWMHb/ILy8WgaX1E+Ekzty8hL6LDgNOa5tZKTwSOPrB76G2fjjcO5f7/GFYbeUuOXf+CJ3s3NfwG/Zd1U +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Query Parameters

+ +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 + +
  • Array [
  • ]
+ +An error with the request occurred + +
Schema
    messages object[]
  • Array [
  • ]
+ +An error with the authorization occurred + +
Schema
    messages object[]
  • Array [
  • ]
+ +An error with the user permissions occurred + +
Schema
    messages object[]
  • Array [
  • ]
+ +An error with the item not found + +
Schema
    messages object[]
  • Array [
  • ]
+ +Too many requests + +
Schema
    messages object[]
  • Array [
  • ]
+ +An internal server error occurred + +
Schema
    messages object[]
  • Array [
  • ]
\ No newline at end of file diff --git a/docs/api/beta/search-form-instances-by-tenant.api.mdx b/docs/api/beta/search-form-instances-by-tenant.api.mdx new file mode 100644 index 000000000..1a01fed0b --- /dev/null +++ b/docs/api/beta/search-form-instances-by-tenant.api.mdx @@ -0,0 +1,107 @@ +--- +id: search-form-instances-by-tenant +sidebar_label: List form instances by tenant. +hide_title: true +hide_table_of_contents: true +api: eJztPGtz2ziSfwWl+7CTKkt+JJNk/GGvZJlJdCNLHkke712cykAkJHFCkRqCtKNz+b9vPwC+RFlKJt7M3SofHIpoNLob/UADDd43EjnTjdP3jU6qk2gh3kTxQjc+HDQ8pd3YXyZ+FDZOG/1ILGUsFypRsRax+iP1Y+W1GgeNaKliiVBdD+C0krE7RyTdUCcydJU+W41VKMMEYGOll1GoFQx43zg5OsL/yuMMVZLGoRZSBL5ORDQVU8AlfItMTFYisejcKITnBLHI5TLwXaLj8HeNqO4b2p2rhcSnZLVUgDya/K5c7LiMkerEZ0LcKGUkZVI6+FqE6WKiYiRkqHQaJBq6G3Q+jD5TMbxAGmXCr16+gBfqs1wsAwA6Pmh8bs6iZgiiszgbDyQJQlYjAGoQ8yjwimIoinRoxCj8RC0KBMk4liv4ya8BdYXPWMlEeTWccoPwtUjmSnjwgx5Kohd3EujR2p+FgKPAIkzkyfPm0avm8cn45Oj0+MXpj69ar168eP3yf4qiQazNxAcxZPTqJPbDWaMiIkMlCMkQfLZa58WvYaN7jhxIkYb+HykIxwPd8Kc+zVBO7ZH516z5Y/9tIbF7jtQxRJWIMbxlMsrSM7yQ/iKIAsUStzJI1U14PRj+/KY3uP7o/MPpXI27g35pujtWDIj7Ooo/TYPozvms3BTHvAlHg6thx9ncZRSlsYtixzHR1NfHg0bGgpafy6oWsFYyiLqJkqjt9TTsFKcEGxoP2azkpk5AS+l+kjN8P/OTeTppudHiUEs/WEZgsYd62cTJ0odetJB+iDz6CQmglgicfPV5CQ5wffodem8taSE/+wuYZ7kgXwJmjAYATTKxCuLKUEygQyhAwWfgFnRLtKfgZQEKsSC8jx5XgjfzEGuY2+adHwTYexHdYlsESDvtfsfpOecCiAYzlik4dXCLrgyCVUuMoWeqATn1DCMRRCG4MMQhJ4FCFCAamHzjAXQ6Wfhg81HYEtc4dFWtgTQWBWg8tKaenwDOWUbZTIUYHoA66MeMx8qN4joP8rregzxmiSxunBAkqxOFMD4QW+NX35Ta7QS59o0MkGzfZRIXkedPV7mcvRWMxzJca5OMCbjylz54HESNkSGWbgIEiyhNMuCib666/SXIELtbvcgpa61FrDgN1IDibhTXBS7TdQhgPeRKBhaa3BO5ndZN2O6fi23A7dC7CQfDrXCDuOBgADH8GgzL3oTfbnUf35yqosIMi5LDOAy/a6ajZ6IuNbc2h1RNvmhcGwnO1dQPFWsHuXzAx24JDAM1Q6sAfsAqSnSTzGAUOCgwSAkKNVWxQhsjuzZmtwRt+gFiCD8hU89EFNt2QLhAHfqBVknuPER5iE9q9Qxmu9u/vBqXJTbKyO8ivpsQPMeF098I5TD+wkwTUvhtOpYn3L7cYdK/KXHFCc/bcbp5vtbniqFEU/hT9ntZLzTnx8g6KMDzNBvXguOTx88XUjhlOJmuq5ZJS7yL7tStig++aFDD5cFNWBi3MqQsTz69CjPlAApiBRMBY8MCUhtvUPLHnoLFfmKk+Zj/NbH4waYBW91RB6KLjH1Yodd6JOcXsQO480cqAy0gmgHjbgYiLA3mnbE9IyMZQoSU8UwlFIoU4vCTFQzad3YZtB8l32JccAn5yJ3BLiMDSALLkscG5rSrPDDMs1awbJ8r8igQmF2LCKGsyPuD8cfd6AAJWFLQm+zSpRu6QQrq8IWkg0EAuYrFLcOVtSOiWRuid6MAiLZEgHpd7KRei2Wy4jF264CqwX1G17vAj0AfEn0Nnl6Izly5n3Q2S1KwneHyDWAgLACQDCNqhNWYaTXy0Gjw/KrFEs7EitKWWjVhTaGBnFs71btRCBzlRILcdurkhN4WphRAfHuWdqMOJ8kQWIhfzi/wo+/An84An8gY4KHbN7/owbkwv+hhdG1+0YNjf8FDOfr9skvg23u8vcfbe7y9x3tyj1dcthUzINKw+gymNMavFo5WuUDIaDzs9t+KeqARs8j80BC8KYa7EpBlG3Ytko+97mj8KCZKyKrYQkE7nihII9LMXGryiQwjrdvXSduYcLU2pB4ZQrMm3w3loznaI3JACdyEZ4NBz2n3N8CcRVGgZFiIbyxfDFq5oCm8ldO2g4ZpMPjLkSxDsjWafQed2CvFzkpRdAFZc+YD1u3/DHyPJyLecMw6lFNFJ5xBgFc1uSF1eII92RKX+UZ8dvpR3e7RtF87ncLYj+z0GIDSXk9la5cgcJvWS13eyZf5Nt36Jh1jrPesY7MfxDCoCNCRt3TtBm+GGXQmVkLhHBU2UkGVeMNyEkTuJ9CSd93zwqrOyQZ/53tKiHNf4wYvKaLv0TkZWsTo3eC6rtNoHt0J4YR1fc67o/ZZr3YsM8rG4Zz+pp481KYhh84vV91hbcchH0XehINLPGlo9+qABkveSQWGr84uuuOPF85o1H5bi3CEW97JhdIatDPrAFG3+6bbadNpxsZeEHH9qTmGhK7O+OO586Z91Rt//LXdu6ofTiXnairTICF7qboLfxZGMRvhMo2XkWbzM94d5xx9O8wi/GcmBt163zwYweFmrBEPgpdkkL8o8ohvq+SXg4IZe2tI2Ovlv49elo5mcvf3QEf1U3+27gjb8cRPYhmvxEIubbqGQZtcK3RJubhATIqxKMfdaqyHl7Ib9gpc9OREBYWCgExraz09Av0N3Cx2Kge9tuvCPKDbHio8e6MIY7aft2NnQMCcn1CX0L8+Pj56+fLkp5fPnx+/fP3yFYbQchEByfIJIysLYEtsdUxIfZpT14yWLVSUz/XsSeC5TKjwQ3r2EO2yqBQP1Tl5Y/oUSiAkRvpbmCI+s7e7+KCBdCia8GGqZzr5eDSKe+3NvxsjAX0uTup9cVO9vGzaJL8Ch8SP5Q3PlXxbcVN3zlmAOLcc+V7pMMLLQPjE05Yn0MLCHFV+05qJKl2WG2MNG05sbWvhvLbgEwoMHTDld1EaeHSaDcvsJbCUwfgK62mmcbTI+jSNU9p4uldXZPKmuFzfYMDfrsbEDFS/iCwIqHCIIm7CsfOPsai0jtVnyBTGg7dve85aWzSbBYr7tYdOu65vGxSEFpnnTr/aDqEcBHETXr4b9NeQX86jUOFGVLvbq7Y5YPgY/CCT6qxRPKLjUYjr7fEaUrAHjIHQy1aXlDq6HOg6g97VRX9Ube9EQboIdWEdhYzDT5YOPhhBwCNzDA/EHO0FAyO0PEKicdkF9NHvjlk4mWHLyyUzxKPFDIXJLoXMXb0YBwZzyNwqe5+AQ1/jPPdCW/xOx1rH2pJur1+76BdFLggJNdlfMcP/ypPXn9XKZO52PVpzqq2y0kFD3q8ZONcOlgZ/f19Axy7HJhDgjD48RZRfI0sDzU+0orD1AdvXE1lMsjEqjqN4U4SiturOE8XYXJhCMVQWfgKpE1sLVldnCUti2vEF1aa6LoTiFf/Ylna1RHda03suvZqBqWzMT/L4mFWMIYZuX1wOB2+HkHyYsrG7uYqZNjegoiYsU8uqBuC9Vgb15uhZq/qgtjaWl/a5/pQRLDgpqpkhky7x/GS1tHdq0qJ5M81ZHW3GidWbMpQ5sQFBezL2RPuyy0IQtq5ZGEp4i3xrahJEwH1NYO/R+2zNk8YxTgG/LQlKhc2r0RYZmW4gJh5uEPuw9Nw0KLea6mNI67SP6S/voKLoMP8mBWYSUVdtGVOJMpNf7kSboQjtEgJBnbv8nFhhSDdJQWMQ0C7teAqM5EtEUMrKlklAW6jBcRpZsrXF18gEbBjg+OEQVGqLY7Gq+Mh+6682u85O/rDgOnJ9WprzKZL4uWIs//oN2Mzt7eJK2UkYR0qb7F+al/HOPE+jqZ/LrwVgEy1tKBtnuZbWPQRyjMFQmq3gbbkWEwmAm5b/tiC4Um8+SyHHMhnBCrcwslwq885PkVTl1JArxOpUv67I/8K0WP2iEPRIqX+G6elK/S1JfCHC1M/WFsfatvzwRNvglRfeUuUbEsGpeY6RNtCTeaQxsEX0y3hs8m64oT71g8BW65ozGSxjMMXQ2OInX5Yo/sVuI5TvjxjJ5GnjDaTkTn/cHf93PWSXyE9WhaTJdijnOdnbXYo+dx3yX1zpn5Gw7XQp11msLcV1QTuAJRviKmw9Nk6nMtCq6ttGJXiepQmf1YlpIGeo4H7o4bat4hJR6070PNvmuAXWpFVirOzXpRr+W18W1iw4FmO46mLVsMFDiKMwWJUxAp6JylDxeRfH0sVEeR6fRJX2iQybRmKT2nPHMtfrcruKg5pEpgwy7Fknho92rWqls5CrNcJpT0/h3SUKpQXXkGp21XUyKlnqPEmW+vTwcLFqRvGs5RvtDKM70rHUP/QOWbe+gU2vMWwEldTVLifWifPaPapJC27C9mjUfduH5KGo6NS1be504fn4xywPWAPrhpfmgoo9fBjXYeMDhwTRdQYXlz2nFqpjJweg6MJKrxYKn4KAY5C9WmD4oCKGjNzsEGtMLdnI+GzxVy4j5Hi2+qn/67KraFby9P6T06HGQ9Vf8qXHXdfYm0fDU/viiNkl03zoBxzlRd0d07ZJB3hFzWsICNGYG7qUbKHMvtHdUk8lwE4n8lTdwVBROOc5ZCWlrUSgfZK6T1L/VJK6KSvF8JHqiq4+csm56lZMXxRRDHQB7XxA9Sg7FvKcLJZt9ngXm5UprOhj/3/NUdDecveWu7fc7225z3exXLqADHpqbhbrvfHujXdvvN/deE9+qhFvFEE+Ha7sCll/kYkWDWUXC9nNMsq2Xb1zbdvyU6ZcG1jSwsXmmD40U9HMLt7bx28BjFR8C07K2UEz9g5k70C+rwMpm32FvczQLZM217W9tmxQ/+R6R8/V9PWReilfnPyoJi8nx8cTbzI5+vGV601ebGO76Gi+nnnyUD9uSOZ9a7WarZbnbL+o2PuEf1+f8JdYVCAdCrQJD3GwuugKDBTv02K5F2TvuJ2rl6e0xXcKqwxk/gPWGS0UpPb4NbmZIh2WCNug3fVm9iW4BiJHe9eEO8Vzg2yT/p6/EffQkkt/bat+AtbZqJ7G2KnDCUYAMjYeAO3qVsY+3QAgIfAH6IonPI1soh7FbL/QsYrS2HzH7gBt13xbiF7TleFw9TdN0C2U5cEaf8DXVRw8/HleGNEGXurE9+hoAC+A0gqLyMKHXBdG6G959DWNyH0w7u+crA02QLATcaZkjJ/Iij6pUPzwX9fjZ4UvTfGRTvYhnUtQEfrAU1a1j53oElUcpTPOSdul3SRaQOJnybCadqSUeG8PI/vgjobOaEwixU74muPJhx/s7HjqVgXod1u5JFHxfC88BAkdylK/Z3R2t4jws2EhGybeJ7sJm+Lcj7nWkI62LIt8PeL90vIlC3x9LRH/YbE1GVuTsOlnFSpYtO9tURiEV0SBd9ZRWl89OONrFvA1ZzEoThOxVmngk06io7wH6NpZ+2o6SviaiK9Mx014PffduSh3E+yv7HFqV7jzKNLqP4VA1UEzeI+1IeqrybrDQZtkEc2TowJJTR6y6TdTrYi+HhhGyMokJ1jMQPEzElM/9Ngkf6OZBZv/jSocfivxTK/fQzxGSC9y9VfTjAM2ccAm+wBt6OdFFCoWhiHggT9NSQrQyeefPIEhtOD3GFetVyf0h9QHQ4MLpPInupan/OM0d3DmSVADQmcw4IZxeZbd74HfwuDCcFYSlo2uVQmu04s3NcOK3Jhe25dKZf5q/CLH7XzBPAiD1bf20hs8yV/H734nj7f3NP8fPY1ZFKO6FZO+opKfmfXamk1daVt4Da2ai4P4K5P5znoR0TKQCdWA0Bfn5lS4zXeicO13YL8MCpYIOSKavzIfKpnRVbAYSJaBnPj04R4sqLMjSzIYXljivOJvnXJhJtYezWU4Uy1xjd+4dWFaMD2F6cG232EuuZYdZuYSJ1ac28mGRddikYYwGtolfjQVVGqLRni+dlNtSp7CUFlZ8JdWsl7WilHVkAVKlBVkHYMpbvT5+EXAxo5jwbzbTVAQPc5ilvNbRoYqMDcyDirL9m24QduacxUsKXkGsrCQIR/hojtewwjIQv6EUCuKZ4emkz5EWCw0BuZZfZ63jltHTUoX4D0k2glkXAXk9B2EUs1Q4Vvbrao23ud7Ko98GtwECVzdH4I6csqdcrbBSd37RiWpgzRhDrRhy/093vnFLOcBX/+RqhjTyA95AoO/AONcSQ+yWswC6c4BXc9dJo2sznp916eUZb51UK5yQ2QzDzjUw8M/AZ6uxyM= +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

List form instances by tenant.

+ + + + + +No parameters required. + +## Request + +
+ +Returns a list of form instances by tenant + +
Schema
    results object[]
    + +Results holds a list of FormInstanceResponse items + +
  • Array [
    • 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 + +
  • Array [
    • rules object[]
    + +List of rules. + +
  • Array [
  • ]
    • effects object[]
    + +List of effects. + +
  • Array [
    • config object
    + +Arbitrary map containing a configuration based on the EffectType. + +
  • ]
  • ]
    • 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 + +
  • Array [
    • config object
    + +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 + +
  • Array [
    • messages object[]
    + +Messages is a list of web.ErrorMessage items + +
  • Array [
  • ]
  • ]
    • 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 + +
  • Array [
  • ]
  • ]
+ +An error with the request occurred + +
Schema
    messages object[]
  • Array [
  • ]
+ +An error with the authorization occurred + +
Schema
    messages object[]
  • Array [
  • ]
+ +An error with the user permissions occurred + +
Schema
    messages object[]
  • Array [
  • ]
+ +Too many requests + +
Schema
    messages object[]
  • Array [
  • ]
+ +An internal server error occurred + +
Schema
    messages object[]
  • Array [
  • ]
\ No newline at end of file diff --git a/docs/api/beta/search-pre-defined-select-options.api.mdx b/docs/api/beta/search-pre-defined-select-options.api.mdx new file mode 100644 index 000000000..53c2890ce --- /dev/null +++ b/docs/api/beta/search-pre-defined-select-options.api.mdx @@ -0,0 +1,59 @@ +--- +id: search-pre-defined-select-options +sidebar_label: List predefined select options. +hide_title: true +hide_table_of_contents: true +api: eJztWm1v2zYQ/iuE9mEtENlJmnZrvgxpkg4e0iaIHRSDG6C0dJbYSqRKUklcw/99d6QUWX5JsrRAis1A0UoUea/Pc+SxngaWJybYHwaHpbEqZ2+Vzk1wuRXEYCItCiuUDPaD94oVXPMcLGjDNHwthYa4E2wFqgDNaVYvxnkGuI7SMw1HMBYS4j5kENlTJ8bgbA2mwCdAldNgd3ub/mlrOgdbamkYZ5kwlqkx41dcZHyUAStQp5fLjBPM1K3kSEkL0pJAXhSZiJxR3c+GpE4DE6WQc3qykwJQjxp9RgG4sNDkghXeJjSwzKxZZZf7wFKVxfPWrfaVCQs5mVVp41rzCb764cYKY7WQSbAY7jVC0f9wbQDghudFRkJ7R8fvB73B3zh4EyYqLHj0hSf0JRE2LUedSOVdg0EtlJC2a4pwTFnvxirnQpLRwjpBq80IZpVciXhoIhPMZt+r7wRjenab4xZ2zivgoBbSs7cKOgeSgdZKs2tUy2wKDqhAeYqiUqPgH4eTGCw6dKhiWJXN+fAcNTPR8ByMwdjMY2AZG1U4jsmZd34BE8Z5ZCyXMdcxOzjrVd7WnGKVbEZyOw321niQqYhnsBzFEzde63Nxk5b50RbMQIYX/UbNSuerZei4V3eqRSLkOqX+a0WxQhkjiPVXPMMkEtdSde2M8rLYNTcVDVxmG8uOjt8eXJwMHmRbZRFaaOHGLls2wNE6GDyyJc8YTSRzaMinoIp8y4hBiqvwD69QeY81pOfBFOI24wbn+YfuNYwWSfmuxhmOI2ZsaRawimIgAbKKyMitH3q1t2BWv1lLIdJoF9pOtf5u1A/qmUeOsZ6zOw/hLC9tqrT45ni5Ye6GuRvmPj1zXzyEuaUBzRCnucD8I6435N2Qd0PeJyfv7usV4VWK5VxO6hPyv+ug5onyEIY8jBltbrftbdhc65tHg480i+izdv3jAjJ76JmWiKE+6CssUscPQMamgGwKyNMWkDbtF9y7JXrtZN3r1qtYKQWOMBEjDsRYuKLTuPk6irdfwPj3bXjF93ZfwujVaGdnFI9G2y9/i+LR3n1uzxeaxzvvKtTLNc28qFlrPGt9zjaHik1N+P/WhJ/iUEF2AKJJ2EmwP5wGF0jQQ+LijT3A7p2uk02x7y759vGUQc5fzi6JMNja0zVxAg7DnOYGXZro7zWFu+vrNve8ocdE2Fxz+lpgnN5SZ7g+tbYw+93uFGsBl3bW4YXo+KpnJ1Jdu3iPkLlL16x1Win5NMER0Ssgzl1xLeje2RPZCfeYGvMyoyDfJvFOyRRFgthElZp5MVvEayxXWTbxw2higcexX42b3aE4by35h35d6Gz2/b54QWt8WRW+O7XhfIaWLrhILlw2OOlTLfbal9DS1Ge6+9ldUnZK03bZG+AadwGrvoBkz/76MHjOEpD0vw8QY+9JWx4gwXAKZ2cIEUVbx0EUIXuqRchum2pVJr5fPWjdNLnD5ThDh9lH2Qdgw14VhPdYqs6P+wMXUlpEw36vuXxWZyeGK8ioJneaSBLwRCy7GKEub617zsZUapTG4iw9aXG081GG7EhoRLzrn2lO5SJ5x9mwqP3ic3491ohfammhlxY6aeb5ghU+tMMoE7R5RMRNFMEz46L1aOVeXjgnL0w0AickqYs2UCQqO9r3g1GdtUfb0ZIXkry2HR/lh1REKWsvY76WMZOqMotZj0WpUgb+YIygQzQYJiWy6NFmXZPS0DEi3N2eMyn0KkMRlgacfSdIDOnBxEeqtH5vVQwraOwp+cllFjn/CbewmH1q+eyGh7hX08xYRebRNpPCkBSGvgaYyn5/wCJg0RaFPrg64AFw2OTfVYLK0Lm652WtrOpOfNetoa0hQlOdFNx9/Mt+U+CqJ+Y+0OzbOViG6ehWM4rhO6tk0VbXCla98y5GcNneTOFZZCFu3t56LVnx0/lLHh80h+lTmU1+dJVeU0l+nrr7RBVvU2n+i5WmOjAT3OYbwnmQv6nOa0ucuqDLsxTwb/zquOp6Yuxdmlv3eUFFxi2h2rE6SgUGFVvKArils98WIUvljonYPxL9sRdzghKNc5C2Bs+kfCQylNdhg0Yzd4TxB0vKK72b0jWjpCtKuUygwz5gEyUjTAu1rpge+vYZc+kM7WNmziix7KhONh668rzEY/+EeFnmjCOk7kFELExU+sKF/b+EOhbKHf1uV9UsJqiRC66JBuxITsd0CSgimEv8Pbow7/UFKYaesnh7H1A7cg4Zr1uU9rH9PtmItjCFrHCNNZpFP3JoNLzrDZYkojBp0K8IOkon3WqR6dJcFELtkYfPi85OZzt07QKOYxNusRubE06/t1j/o5rOIhynzYXLHT8IqnYJOt53EY++Hy99u+E7vmGw2PG5C411PR92ESmaTuum0xE3QE3QjIa/lqCpA71s+ht6Q30p8BgbYmoSv8CErpNwtyusa4Sy0t3ULF4YtRrUP48p7HzNxlc9kKrZ7B+H5Shx +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

List predefined select options.

+ + + + + +No parameters required. + +## Request + +
+ +Returns a list of available predefined select options + +
Schema
+ +An error with the request occurred + +
Schema
    messages object[]
  • Array [
  • ]
+ +An error with the authorization occurred + +
Schema
    messages object[]
  • Array [
  • ]
+ +An error with the user permissions occurred + +
Schema
    messages object[]
  • Array [
  • ]
+ +Too many requests + +
Schema
    messages object[]
  • Array [
  • ]
+ +An internal server error occurred + +
Schema
    messages object[]
  • Array [
  • ]
\ No newline at end of file diff --git a/docs/api/beta/segments.tag.mdx b/docs/api/beta/segments.tag.mdx new file mode 100644 index 000000000..2c8161ffd --- /dev/null +++ b/docs/api/beta/segments.tag.mdx @@ -0,0 +1,37 @@ +--- +id: segments +title: "Segments" +description: "Segments" +custom_edit_url: null +--- + + + +Use this API to implement and customize access request segment functionality. +With this functionality in place, administrators can create and manage access request segments. +Segments provide organizations with a way to make the access their users have even more granular - this can simply the access request process for the organization's users and improves security by reducing the risk of overprovisoning access. + +Segments represent sets of identities, all grouped by specified identity attributes, who are only able to see and access the access items associated with their segments. +For example, administrators could group all their organization's London office employees into one segment, "London Office Employees," by their shared location. +The administrators could then define the access items the London employees would need, and the identities in the "London Office Employees" would then only be able to see and access those items. + +In IdentityNow, administrators can use the 'Access' drop-down menu and select 'Segments' to reach the 'Access Requests Segments' page. +This page lists all the existing access request segments, along with their statuses, enabled or disabled. +Administrators can use this page to create, edit, enable, disable, and delete segments. +To create a segment, an administrator must provide a name, define the identities grouped in the segment, and define the items the identities in the segment can access. +These items can be access profiles, roles, or entitlements. + +When administrators use the API to create and manage segments, they use a JSON expression in the `visibilityCriteria` object to define the segment's identities and access items. + +Refer to [Managing Access Request Segments](https://documentation.sailpoint.com/saas/help/requests/segments.html) for more information about segments 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/docs/api/beta/send-duo-verify-request.api.mdx b/docs/api/beta/send-duo-verify-request.api.mdx new file mode 100644 index 000000000..37532339d --- /dev/null +++ b/docs/api/beta/send-duo-verify-request.api.mdx @@ -0,0 +1,83 @@ +--- +id: send-duo-verify-request +sidebar_label: Verifying authentication via Duo method +hide_title: true +hide_table_of_contents: true +api: eJztW2lz2zgS/Sso7odJUroPy/KXLcVH4oyvseV4axzXBCRBCQkJcADStuL4v283AErU4TjjeHdnU6pUORIJNPp6D90QeefJlCmacSn2Q2/L00yEO7l8zxSPJqfsz5zpzKt4GR1pb+vSO9wbkG0pMiXjmCnvquKFTAeKpygApg/HXJPByT4Z5NmYiYwHNGOawGeSa6bINacExFcvmE9QVsKysQxrsIJmQa54NoFV7rxzGIvLsNsMBeHKPBRbSUS3ro1m3tU9rK2sfq9lCNPuzFeuGJiRqZxVvAAliAxv0TSNURfQsv5Jo6p3ng7GLKH4KZukDJSX/icWoLWpQqdknGm8i4qjb6bjdKa4GME4kccx9WO4FtFYs0VnoBWEhySSihiHOg2I0xvNZrc0SVGC1wr6zc1Gv9OLGizqbHQbzV7UanYDP4jCRqPje/fgJD4SLDxlOpVCs/+4SoPz4duvYSvW/nZ37L95l/ridvds+PvR4V769mw4/vW396cXw/fp70eNw+77f93cHn0Z3B5+Ov9yuDPqfo2aUTfaDFjY9dudRtQO24223+iGYB5tsE7b36CbUb/X2BqcnDxlldbRp93u18DvdIKo02l321G32eqxMKCs3fSbIW20u6BAr93thX7Lu7+vlDLksgjrklMhrzKeGfsLIDgnFXC4L/lolh6PB3A5fj+bh62PrXUGO61GA/9bJAlGdEazXBMZkesH0vCZ0OskPgZgyxjLepa1OwHSczlQKEr2d+YQ09jsb/b7UbMNju+EtLfZ6vT7G81+s7vZ86nfNyA2pq9Sh4k8wdQ82T3a2T96A1fOzre3d8/O4NPeYP9gFxc7ON7+9fh8CJ+Ojod/7B4dn795+8fOYDhYZmNk2BIRo4Pd4mWdizUwrZWS6q87ahenAZdrTUfA9pGSiWH3VaGdW/pcoFCSSQLRFhA+snN+TM6YuuYBI2GOq89JMSgu4DmPTYepeXCWov94bGahKfnducRz2d1ZldDbMQcXE+uGKjllWa4A54RHZucrcsWHfYrA/sjFNY15+IxJHrKM8nhbhiv3hHll97hg1ZGiHDU01oHzQ0ZA4jUP0eGJVOB8IxIBiiaYcfObA3ii1iSvaUgKTGw7YzBEigafQdZq2C3sSYLDfFJMKbanB5ZlPUb9jUa/1Yk2OpS2NjvNXtfvR7TdbvS7fYOwIhNLa1Ol6GRp6TdMQA4FJJYBROQLOEQxCr43CtjIVzyesUQ/HgMj4zv8j6xix07NdPoSrHcqhJLX2yek0yMxFaPcXKejBSeI6vnZEizBciv4WPERF99imJ3dvcH5AZLI6e5v57AXeBWUtcQgAwHZGmJagqqQC2N5YzR2BtxQTTSLwR0srJFXTuorMIgKXR7I7Tc90eBMyK2I5nEGM9zqK2aURVtGKUMpsMUhecFrrFYhPl5LaBaMiU81TIAQ4vBXgyBgaVY9cJ58RcaMhky9rJFBGHI0ksYE0AhCYf4EBBEahghdKyDKAcqgDIcyNc+IkECkbD4WM1cukmTBUwfloCA4QPPH82QQZDkoZ8wso3CaLU5FFx/Q2XpuXrthyWnGpROR0QC3gziegBuVQtb1wTaeaeLoCMOlgXhEMW7KWGX6NXR3aJXZyaS5F9BcfwfuTmKgn6oxbXrjmjnwadwPLBuZaBRhcowEN9FsM9mNmoZrtgVxFodr7K6xu8bud2J38WZRULm7pvRpLpc+UMFBgSmV2TyXSh9lskdIUgyypaANZIWAQ1yJ9O5iCMD+zASOZ7cpNmnPWB9N69qFME3jYa/7WH5MgzUXC1TQ+NFaEAETsXDL6D3T2DjKuqq9vNqeVD6HBBUrSkRzODKROaHgMpULgZpQXSGhZFr8kpExBX6kgAitLQPiqiKsppKL52yX1pXkupJc70br3WhdSa4ryTV219h97kpyqpVBi6uTdJ4kVE1sprn7aC0lMIAUB8pkCjkTqsVqBYWRaY3lzVcOnt9q+s2oF7BOSDvhRrsftYKNFu32mr2m32n1vPJefznD8RRk85gqxdvG0R5qM3UNdVwuILl0JmU4f/yX47FxhLSG1DOtm8Hn4NKrae3Y6q84MpeSHFIxKSokPVdDipmPkNNgbIJjVTEWBlAyAl4UBKiKg16YSjxhIEVB0pCYJ9yAF60AuWpSHUQZmGKBUiTZdBUugjgHDQ0TxBKrZgmJxcFIFmHNBxJMBTsCdn7G6tSF6IcqeXKKFh+gxWT3NmAMgT6t3Lurznf3QXmFHHFmA/zAQa/tdqiABICGwHLWtO5c1+fr+ny9x6/3+J9jj1/X52vsrrH7/4ndv1Cfu2ro4focBnx3fQ5jaw0yraX2MLn+62W6gYrTwKQ3kUGQK3PcXNTgpq7A59JgfCrNIwspxafQvHoS0XqYy+oN8+vuSTR8dA2rQqtQrmIYN86yVG/V63cQJ4jPfY2mvAb0BaHKJkLe1AKZ1H1wzgrewQcELMZwgHmYzi5QM55VHJPXMp0Rbv1sbME0BX+bM+FvShY0MQGcyBy4zYipEEh0l0jmMqiYQhfxizajayZxluwDu85VfP/jtlhBD9iyyn3fXA3GE9B0wUQ04Wr2pOEZltx29aXnDWfbCLZpraXFjnFYi7xmVEE/YH+5ePHuYviSjLDQNEDPNda4jGNnAFA5gRQxRDYoTvFxktlblMxHY6P4YO53EgQOiWIwmHwQZ4yRy33nhCNg+FOg5MVnLWHW1YsiOiG7ZjFufrWZJzHxeCjq4KE6nZv30mx0piPgAj4m5mrtg6iSHY78w3HDxjHORNPgkcu0sIuW7HqqEv8opFWttKqRpl8uaGFdexnY524CQC+KoLE23nry4lZetSQP2ye4glIXdUBPOD3mf90Kiqg9WY85eVWUN6/HB3Ex5rCLzk9zD9MSDZtgHJJ9Eoyl1OyfhGDqIAwuRzmg6Mlq3eCiVYOIaqtRUqlql6zyKtSERr8DAIawyUR93JNNSSKhWhOhheRHE1nA/EfomEPycc5mc/kStk4cGcpAP1lnXLCKC1YtB2inv92ZMLEA22iD4QGbANuz+BsmcIqWeM/KWsnqRnzdzMGtIQBVjRSdbtkvWzOCc5+IuYGjp2OAhrGknv7eB9+Jk4Xb05yzisOARQ8u6xtL2BUX/Gb1nR5G4U75d7MXLR7MzkyORTx5bpZ+gEn+Prz7P2K8NdP8jEzjilw8ezydvUKxu36mfcUz7RUPUWmi45qmMhe8dmXt8lEnnsWPGfyFu4bSTNsBTZ1pU02xVxaUxjRD8BvyC8acmUOSlNEMS+QKAlAmhrBSJZEloRU2gkYKxgC7aSjdqc9jkGeO8YuVqeEVW39j+uN3nZtOzTx3PYamm9XIBfStIoDsxZ4VH0SBe5+ka17PIIFPMP/JToEJqE2TJBewGtJXnhAKyHsEOCHXQW75vXjc25ggTYU8nVWQHSISTaiZ7k0l+jhyT4aX8PHIWgAP7Q7fwfUYRWxmsDGcGnLKYgNgHDff3TwmG0BZHbM4xSSBzYm5V3LcCof7wyWJIExosCtgNalGdTdJ13EsCMEu0qZPu9asNaqmq4Lr2IRCn18Sbt/PMhX4PDO7F6wcQy+m5d3sZ4gfeFXLbbrYLdVTPN9DHXPbvdlG+dKDRhkXt62yZ0wzr21VvDF21DDi7g4PgbB7vMfLQEN4wnB5NWsM8RtItodBprv+zPAQwv36UB1OTBXhThuWf1bBftXOsAdM3xx7VWr6T47xqM3z3XtliT2/UPQGLuLfLe8D/IMvMrWZg28a4PU7rzgNhDFWblGurapW3Ac08/7+3261UQc= +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Verifying authentication via Duo method' (send-duo-verify-request)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Verifying authentication via Duo method

+ + + + + +This API Authenticates the user via Duo-Web MFA method. + +## Request + +

Body

required
+ +The status of verification request. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/send-kba-answers.api.mdx b/docs/api/beta/send-kba-answers.api.mdx new file mode 100644 index 000000000..391c8a701 --- /dev/null +++ b/docs/api/beta/send-kba-answers.api.mdx @@ -0,0 +1,87 @@ +--- +id: send-kba-answers +sidebar_label: Authenticate KBA provided MFA method +hide_title: true +hide_table_of_contents: true +api: eJztW1tv2zoS/iuE9uG0hWXHbprEeVk4t25O0yYnly0WaXBKS7TNU4nUklJSb5D/vjNDSpZsN2nTYLctjAKpLA2Hc/uGMxR1G+hMGJ5LrQ7jYDuwQsVvhnyg7I0wNmgFOR/bYPsyeHswYLta5UYniTDBVSuIhY2MzHAoDDyfSMsGJ4dsUOQToXIZ8VywwgrDpGJvdgYMOaQin+i4DXytiAoj8ynwvg0ugAyZi885Dsf5ZKy20xEPPw35Nq+xDK7uYG4j/l0Im+/oGBjc0k9pBCiQm0K0ggh5qRwf8SxLcCBI2fnLoqi3gY0mIuV4lU8zAcLr4V8iykGqzKA5ciksjfVWgEtVJAkfJkA84omFKfxIbgyfwkCZi9Q+zJGk9rauaG1upBoD7cIkTRP/4QczGN0KxGeeZkgbrG31t/r9Ufcl3xqtx3xzq7fe7290+91XW5tDPuwHdy2vyiMmHSjmxrKRNgz8QL4s9WjI8S9dGE8c3N21al65rCteCQN+zGVOQ6uQO3WOPQRzothNWYCK8Soyq4kvm3Z92B4zczRlbs0z2th8DKNucHc1r38p9j06o76VTrXg+zHVcwraTCvrQru3tob/zXkMYqWO3pjZnOeFxQzwRCCFBIE549TLcjgHxBKg3xMt0v5TGDmS6EoCCaagJ0a8S1zzObWJNia/Hfh12av5h1ongqulAox4kYBT8MG8PKciL4xiSMnkiF2XjGsy4TMMjXqQz3mHcoMLg2UmEapIETEn++/2Dt+9hjtnF7u7+2dncHUwODza34OLo+PdN8cX53D17vj8z/13xxev//Hn3uB8sLgw4bJTW5PQjH7yuinL2e6RfQ6fS+LuUcF1uBBcCzi9j0nMt+aYkAuuZiau6YbarS/D6W4iwT5s3xhI8iFzjga0gpcx5fvllg1hvWWwzkt1zRMZPyGKY5FzmezqWCyLiaawB1KJcGy4RAkFiRzBQAYcr2UMI1iqjWCOJdNOBaJrN3wOlmh32Q6Pmc/AVOCgMhgEhkefgNdy3DYFulASxrNyCMC0WiyXTCs2BR9urPV766ONdc57W+vdzVfD/oi/fLnWf9Un1KbCWj4WyxJZc+rXQoHjI5boCDzyHzCIERxsTwLQ5F9fnBCPr7A/piVHW6np5WVYwbUYZzu7J2x9kyVcjQu6z8dzRlDhxdlC/gHNHeNjI8dS3Zce9vYPBhdHmAFO9/+42D+DK+S1AH+oX6SKMSxBVIiFib4hib0CN9wyKxIwh4jb7IXn+gIUgsWuTijdLzu1YEzm0ySM8LMvGVFnzUZGpw0oRa7cZc9kW7RbbIj3Up5HEzbkFgaAC5H8xSCKRJaHR96SL9hE8FiY5202iGOJSvKEARqBKYyfAiPG4xih6xiMCoAyCCOh8C5ypjRkQdH0xcyU86tBmQmP6k5BcIDkD8fJIMoLEI7UrKOwihYvovcPyOws15TuvGY0MulU5TzCXJ4kUzCjMWBhNgTdZG6ZT0foLguJR5V0VcaqJ3hKd2+dMHu5pmcRL+xX4O4kgfQTkmrVg2vhwQdhoH02Im+UbvIZCR6i2jTYU1XuKoHPIJcn8Qq7K+yusPuV2J1/WFZm/imVPt3F0udCYYOiDS2eC6WPoehRmpVEroJ0jmwxMIgvkX5/fw7A/iQU0ovPGTZ+T1gfuaV8QfhB5Q93f4jlR+Wshi9QQLKj02AEmUjE2yT3TGIylDPVy8XZDrQZSghQtaREpJ2eqS4YB5OZQimUhNsWi7Ww6recTTjkRw6IsNZlQJxVxWGmpcpXleSqklytRqvV6NdZjVaV5Aq7K+z+nNi9t5KspCK0+DrJFmnKzdRFmn+O2nIGBKzcJ2cV5MhV89UKMmNVjRU0K4dg2OsOu6PNSKzHfD3eeNkf9aKNHn+12d3sDtd7m0F9rb+c4bgCWRNTNX87P5KJoYi7hjquUBBcNtc6bm7/gXmNGGFaw9RT1c1g87Z/KUC1Y6+/WDuea83ecjUtKyTbqCHVzEaY04A2RVpT0gIBZ2PIi4pBqpIgF4aSTAVwMfiiMZGpJPCiFsDXTMPBKAdVHFDKIKtmkSpKCpCQMkGisWrWEFgSlBQjrPmAA1WwY8jOT1idehd9VyXPTlHjI9SY7X+OhECgV5X7q2X7u4cgvMEcceYc/IWNXtftcAUBAA2By1lV3bmqz1f1+WqNX63xv8Yav6rPV9hdYffnxO431Oe+GvpyfQ4EX12fA217jVW11AGdlPhfl+kEFS8BhTfTUVQY2m4ua3CqK/CkHdBn2lIS4XiuLuikI975NOSdxpk6PI6HdaETqTAJUE7yPLPbnc4teAo8dNfmmWxDAoMx+VTpm3ak084QzLMk8+ARAYcyJKBjgW6CNtnWSAxfl+uIubO0P3kSWLA47Qrfy1nxlFw4xZNJjk2LQaj7UKLbIGIGfcRvlqjbFDoL+oFeFya5+35dHKMv6LLMfPfOBvQMJJ1TEVW4mp2ePMOi282+cIZytpCgr3sLkx0jWY/tCG6gI3DvLp79/v78ORtjqUlQLyxWuUJibwBgOYEQoVQ2KPfxcRCtLkYX4wkJPmi8KUHosFECCrMP6kwIdnnojfAOcvwpJOX5U6Mw6upZ6Z1YXIsEl7/2zJIYeDJWHbBQPYxh3HNa6qgnkAouU7rb/qBCticxA0lcspHGq0gtHrvMSr14Ta/HCvG3klvouIXEzT6fk8KZ9jJyJ28iwC+y4Iklaz16cscvrPHDBgruINd5GdASXo7m+62o9Nqj5WjwC5FfU44P6v1EwjraHOYPCDMLy2ASs0MWTbS24u+MYeggDC7HBaDo0WLd4KQhISLsrdVECt2UoQyhKiT5jgAYygUTH+KqTEWJhnpNxQ6SH8mzgPmP0DPH7GNDZ7p9CYsnUsY6so+WGScMccLQ5QDr5XdrEwYWYBt1oDzgAmB35n/KBF7QWt5zvJZmdWLfoTG4NEQgKnGx2bb7sT1LcP6K0QOkrmggDWNRXb3xg9/M88IFqmGscjtg3oKL8iYa1sU5uzl5q+0oXCt/NH1R48Fs1+RYJdOnztJfyCQ/Tt79P2W8Vab5FTONL3Nx9/F09jHI/s9yfh7afQAKGcx3MnV47vhKc3H/ETfIJwL+wlPKMtQLQKdFvSPVX3VGWcJzxCPlo2giBe1cZILnWLW2EBM6pRySGY2JC/pTYjQ2QAMJx0I1zYcyAX60t17OzAnqriTGiMTftqD2CeeKJtAJizZ7D82kikB3bCTxdAg8+0v7jvIMYuoEQ5LtlWEK5WKaFgpmw4xSpIwDGB6I5VjaqHApF/pKJUpbaCpaq1Fl/kFHoAptaqlMao9HuCkO/XYtZB+YCyLW+h1xMD19HwT9BXZrlSKnIiFMIV2z4XiIN+AknIgkw1YW1guBR89nM7w9PF/gCMyUBb0i0dZm3PGDbAdpgQk2di58Xra77bWQGh24j50hNN815o1vt/DLg2rTavbx1nxM3s5eDHzzR2B+6cOepZPhPhuKVbgeyjWslwE0rEAJLWvgaobZh2CtYIK9LdDc3uJ2DHZxd3gbUIq9/uXVrEHDX8DbbctQTvgkcDvAvwcIz6e0mvu+f/EFB4LfjXBbPffSXtXa75Nj3PQKhv5LtdTtJBh+Azfx73bwAf7BD525cMHP2fD+bVDuywGN41uWTcuqBn+Bat7d/RfChGaU +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Authenticate KBA provided MFA method' (send-kba-answers)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Authenticate KBA provided MFA method

+ + + + + +This API Authenticate user in KBA MFA method. + +## Request + +

Body

required
    answers object[]required
    + +Kba answers + +
  • Array [
  • ]
+ +KBA authenticated status. + +
Schema
    kbaAuthResponseItems object[]
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/send-okta-verify-request.api.mdx b/docs/api/beta/send-okta-verify-request.api.mdx new file mode 100644 index 000000000..4aea47766 --- /dev/null +++ b/docs/api/beta/send-okta-verify-request.api.mdx @@ -0,0 +1,83 @@ +--- +id: send-okta-verify-request +sidebar_label: Verifying authentication via Okta method +hide_title: true +hide_table_of_contents: true +api: eJztW2tz27gV/SsY9kMeo4ctO7HlL63ix9ZbJ3b9aD44ng1EQhISEmAB0o7q8X/vuQBIUY/E2ayn3d3RZCaWSeDiPg/OheD7SOfC8EJqdZxEe5EVKjn9XPB/CSNH03Px71LYImpFBR/baO86ens0YPtaFUanqTDRTStKhI2NzEkC5l9OpGWDs2M2KIuJUIWMeSEsw2dWWmHYreSM5Lf9AozkZaKY6KTDwmrM4Kc0mMXZRPAEs2KO1RL2zKZ50R5pc8dNItX4WYtxlTBZsKzEvBh6cakwzYhMF4Idn7FBkkCSZXrkhZgOjLEiLo0spjDoPrqCWmSR+FKQzmSkTNReNuJ7t07H6OYBZhqv3BudYNp9FHSEywpTilZEa8NcesXzPCWz4ZDuJ0teuY9sPBEZp0/FNBfwkx5+EjE5NjcUgEIKS2/JRxSHepwtDAzFOFWmKR+meDbiqRWLficrmEzI4yOJj3AScy4OmrCgf4ddIhS3PC0F+aSKyzM4u8BSw7IQ5CHxhWc5LVZ9+lvGZdqJdRY9PLQa1l9XKsNFhSzclDp/wtpVFj005M5MXbWCX8PmWlnvl97GBv1YzDXBbMGL0oX3dpW10ZNFJkh8LDg+G5b1bGp3htpp5jr9PD6Y8/rGbn+33x9tbvHd0XbCd3Z72/3+683+5qvdnSEf9smX3vRV6ghVZhSas8N3B8fvfsKTi6v9/cOLC3w6GhyfHNJiJ6f7/zi9usSnd6eXvxy+O7366e+/HAwuB8tFTUXaqGdycFi8qXO1BoXZGG1+vaMOaRrgwFo+RvmPjM4cQKwK7dzSV4qEskITBiiEjx1cnbILYW5lLFhS0upzUlwWV/k6n6s+6xaStRH9x2MzC03D78ElUcju7VUJvZ9KuJh5N7SBh0VpFHBP+kKtcmUIDGKAWalQxzJ5wiRPBAA03deJWBW8eWWPpBLtsQHgQkNnHZyfCAaJt5LQmWXawPlOZIU1btw8wMATnU32hic1/u8HYyhEhsefIWt12S1AoJKYz6opQEOHgl9ZVuwIPny90e9tj15vc97b3d7ceTXsj/jW1kb/Vd9VWJWJjbW5MXy6tPRPQiGHYpZqbDLyP3CIERy+dwr4yLciWYjMPh4DJ+M7/E+o4sfWZgZ9Ge1l2BrZm/0ztr3DUq7GpXvOxwtOUO2ri6WyhOVe8KmRY6m+hTAHh0eDqxMCkfPDf14dXuATyVpCkIFCtiaUllAVuTDRd07jYMAdt8yKFO4Q4AEvg9SXMIgr2xwo/W92auFM5NaIlyn2tJdh9RUzmqI9ojRLKfYbP3suO6LTYkN6lvEinrAht5iAENLwl4M4FqAeJ8GTLwMxedEhgiHJSJ76XdVi/hSCGE8SKl0vYFSilKGMBNMpC6Y0gHRho525chEkK5w6aQaFigOaP54ng7gooZwzs1mFdbYEFUN8oLP33Lx2lw2nOZdOwbVi2g7SdAo3GkOoC/oANmZZgCMKlwXwqGpcjVhN+HVw99Yrc1Bo9y7mpf2OujtLAT9tZ1r94laE4rO0H3g0ctGowhQQCS/JbDc5jKrDNduCpEiTde2ua3ddu99Zu4svK0IV3jrqs7lMfcDgQDC1cZvnEvUxLnuUZtUgTwV9IFsMDgkU6ef3lyjsz0LRePElpyblCflRzWsXwlTHwz8fEv2ogzUXC1LQ+dFbMAISiWTP6T3T2DnKu2prebUjbYYSCapWUETXY091yThcZkqlSBNuWyzRwqpnBZtw4CNHRVjrEZBWVUk711I9Zbu0ZpJrJrnejda70ZpJrpnkunbXtfvUTLLWylVL4Em2zDJupj7TwnuyljMMYNWBMqtLzoVqka2QMFZzrGieOUTD3uZwc7QTi+2Ebyevt/qjXvy6x1/tbO5sDrd7O1Fzr7+e1XFdZPM11Yi3j6M/1BbmFjyuVEguW2idzB//lXRsPCJYI+ipeTN8Dpfe1Nyx119xZK41e8vVtGJIdo5DqpmPCNMwNqOxphrrvlsZAxcVA1RJ6EWpJDMBKQZJw1KZSVe8ZAXkmml7MCpgSvgeJyRZvYpUcVpCQ4cEqSbWrJFYEkaKEXE+SHAMdgx0fkJ2GkL0m5g8OyeLT8hidvglFoIKvWbur1ad7x5DeUMYceED/JWDXt/tcIUEQEPgMavmnWt+vubn6z1+vcf/Ofb4NT9f1+66dv+Ytfsr+HlgQ1/n5xjw3fwcYzsbrOZSR5Rc/3Oa7kolaODSm+k4Lo07bq44uOMVdLUJ43PtrizknG4YRd1sxLuarkH5K0bdcNOIriYRM/RKlSbF2ElR5Hav271HrBCjhw7PZcff9CmmSt/RlZnuEA5agT10ScDXGQ1w97L8Ah3nXSMpgT3aOeHe184eSlX43J0Lf1Oy4pkL4lSXwDcnpsWQ7CGZ3GOomKOTeGbd6I5LniX7YNeVSR9+uy1e0FdsWeW+b66G8QyaLphIJtzMbpJdEO32qy/dJ5ttJdSq9ZYWO6VhPfZGcIOewH978fzn95cv2JjIpiv20hLPFZK6A5TLGVLEgdmgOsmnSW5/MbocT5zig7nvSqh42CiFweyDuhCCXR8HJ7wDyp8Dlhev7WHWzfMqOom4FSltgJ2ZJynxZKK68FCXz8174TY71xVIhY+Ze9r5oNrsQBIGSdq0aUww0TV57Dqv7OINu35Uib9U0tpeWttJsy8WtPCuvY793ZsYFUwieGqdt354cS+v3ZBHLRSekNRFHcgTQY/5b7jiKmo/rMecvDbJm9fjg3o/kdhJ56eFO5nMYiNME3bM4onWVvyVMUodKoPrcYkq+mG17mjRtquIdm+joVLbL9mWbfBCp98JCkP5ZOJD2pcdLdFgbCrxJfnRRRY1/9HdB/04Z7N7fI3tk0YmOrY/rDMt2KYF2x4DbNDf706UWKhtssHhgE+A/Vn8HRIERRu452WtRHUnvuvm0NYQQ1UnxeZ7/pe9GcCFT8y9oNH1GMAw0er6Oz/8zoIs2qLmnFUdCCx6cFnfVGNnXPCb17c+kKLd8vdmL1k8mJ2bnKp0+tQo/RUk+f3g7v8J8dZI82dEmkB06fzxfHZF/vC77nmj20aWOm1DI9GsjTeB5i0f/9H59ETgf7x1Je6oOBod17o58tMUlKe8oGJwYBBPpHAHB7ngBVHGFiWkzlwBo8cn1EB76ASNDcag2i2oLB/KFPLc0Xa1Mnd15vkopQP9bkvXvbi7yBM0oqLD3qOXUzGiSX0cXc7Au086NHQX8MYZ5QM7qHIEXC3LSoXVqJzLjHFk4iOJlEgblx7vqivQzgTtGGM9qyp+ylAyoeM6GpPZ01G4Ld3Il0fWQrrYcCAN11MUidxTs1Qbci5Sl9A0bp7tPyYbSdqeiDSnJAFYC7qSPVvh7fHlkkQIUxZ2oWPXZtwNk2yXxkIIdVU+fbY6m52Ntusy8JwaM/S+DeH+L1McI51HqupvVwJkLebl/exs/o/xZzBhw6NOpZvT+Rr5o/Sdk29UryM0qhjZaFUj50r3ZzGtaEJdLUbd39NBDHVvD/QY+lOXf30za8zoN0j3hrju9rOgg4DwDUD7cup28dDxL3+1Qf2in+EPeb459qbReJ+d0nFXNAx/t5P5MwTD7/CQ/t+LPuAf2Zj7TKXb/vT8PqpO5DDGy63o0iq2ED6QmQ8P/wXMZ6y/ +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Verifying authentication via Okta method' (send-okta-verify-request)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Verifying authentication via Okta method

+ + + + + +This API Authenticates the user via Okta-Verify MFA method. Request requires a header called 'slpt-forwarding', and it must contain a remote IP Address of caller. + +## Request + +

Body

required
+ +The status of verification request. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/send-test-notification.api.mdx b/docs/api/beta/send-test-notification.api.mdx new file mode 100644 index 000000000..33aacd9d2 --- /dev/null +++ b/docs/api/beta/send-test-notification.api.mdx @@ -0,0 +1,95 @@ +--- +id: send-test-notification +sidebar_label: Send Test Notification +hide_title: true +hide_table_of_contents: true +api: eJztW21z00gS/itTug8LVOzEjiGbfLkyIdyFC5DLS/EhpGAsje0BeUY3IxF8qfz3e7pnLFt2QoClbhfKSy3YUk9Pv/fTY+k6sYVystTWHGbJXuKVyc6UL1/ZUg91yjeSjaSUI5/sXSSLl31yuZFkyqdOF0y2l5xitZCCGIglDk79p8LlpzabJnvX/FU7hS1LV6mNJLWmVKakW7Io8rhu84MnvteJT8dqIulTOS0UdrKDDyotwbdwpECplae7H9V0gciXTptRsizl2ViJUk2KXJZKmAUxBZa3Qa4+S9wlDmluq+zdRJpK5u+urPv4TmPlO19NJtJNk5uNZKIyXU2+btPGXmFhW/xTelFaMVDCGvw/FCUohzbP7RX4CGWqifgkcxiPRTO02UVy8LJ/eITvp0f9/X/h37OD/svT5PImWvJzeZutmhL1xQtYV4S72FWWIlMQUXkWIfIRvlApSU1ClguWayc32K3UJRvq9Ja4OQkuf1ZaMlRt1Oil+2w7N22t7IJqMMNAudfDY+wLM51J/xEBkPRAZa+MchzM3a3OdndnmMlO2uvtbPVkutXp/N5Ru0+2s96T7RQa3JASTvkC8RxCqLvVo3+atnplRYxQ0RIaW0LDaKcY2OIKfvRVmirvh1UuBhXZVDkltIfj6+XB1U6VlTMqA6/IJEjQJkv1trZWJdjPNS0/cM46yHBSMxg2pBggv2hHbRAzOmsnPyy1MlVKne/bTN0f7M+1Ua2Rk5okVCxyioUCHD9p8peYWFgmsJzFPNM10w+WaHfEU5mJGEtiPypDoedk+hG8yNX3CXRuNNaL2RKhM6SYu2tbtaPk4MnWbrc3fNKTsvt7r7PzeLA7lNvbW7uPd3dD3nsvR8E0cW/pnJyubP0PhXBE+uQ2hUf+C4M4JSnxSADeHEso8v39PmAeX2F/KjaBtlYzyisogTZQo5/uH4vejsilGVV8XY6WjGBa56e4Yqo8lwO6RJUamgfGr50eaXObKLMS9ezgef/86AxXTg7+fX5wik/Ea6Vp9M0soyAqYmFsr1jiqADnlcphDpW1xaPI9REUksYvEurwzU89jInYGsoqL7Ei7n7LikXWYujspJFKswL4QLdVewNZi2sTWaZjMZAeC2xI3Ud95HxRto6iJR+JsZKZcg/bop9lmpSUeazgWD+l9JdZNs/9YYVUhjC6HFsUDWoSqWr6Ym7Kpjfm9fdo0SmUHM0WcEec9NMSxZdjopGFdbREEWcVL4uWa0p3tlwFp6aUKbSQeT6FGZ2jBkMFUZe+LoSabI/qP6OrK9ZiW+Fy9zIIw32EGpys/Ffk3XGO8tNi1eobn1RMPm65oRqxN2ZuihWpbnVYHKlqd80SXwy1yrN17q5zd527X5m7yzdPIuqJdxn6dFahz7mRFezruHmuQJ8aYc2IArwOjtwQMEiESC/enCGxPypD9OpzQePHD8RHoZWvCN+v/RGuDwh+1M5q+IIEZDsGDYaoRCrbY7nnEgfMyqbaXt3tuXUDjQA1t0BEVE0nprYSEiZzlTEkifQbIrPKm99KMZaoj5IRbKiAtKvJWoXVplwjyTWSXHejdTf6dbrRGkmuc3eduz9n7n4RSdZScbZEnDQ7VuRIi/dJWylAUJ+/iTrl2FXLaIWYiRpjJU3kkAy6nUFnuJOqXiZ72ZPt3WE3fdKVj3c6O51Br7uTLPb6i3ke10nWzKkFfwc/sokB4j4Bx1UGweVLa7Pm8R/M69SQyhqVnho3w+Yw6eUcO956xllCNzAGdnR3HC+enxwRf2zN7MlutnKpIpjdOEgGpKQYhqW1L9fQcQ0d1+1n3X5+mfazho7r3F3n7s+Zu98EHXv3QcfeN0DHHj0TgXwCxPozoWMG3EHQbKj5YY20gnkNwcYCquBTPH2MaV9KN1JlDfQaKLK7u4oiz6wVL6WZzsCSb5xEmrm5qLyBdkK0bkYLAilGKJFGoGppoFuKKj1RhEnpcY1cTzTnMSkEvm7a6g9LaBVyZvn3dHxP8woSclHILZ29WsSYRjipIcE/cOBz0BEK9Q8844ze+kPnweKEND4ijcXB51Qpyvn6/PfxbU8JHEJ4R+XiNPj6jscFwpm5NBgj1OcilK8agq6h+hqqr9v9ut3/Gu1+DdXXubvO3Z8zd78Bqkc0dDdUB8FXQ3XQtrdEjaWeU3D93xE7p0qUgMNb2JSxejbH4IwrEEokUGH5oLWQ5RjfNulBblQzX7ZM80HsMAUEoSqXg3ZcloXf29y8hq/go5u2LHQbJQzuKqfGXrVTO9kcwEC31B561DTkGRGI/vFhHDPabF2nKYBDtWPmwdasD4UqbM5PF3yRs5ETduIUE4gIbDYEgj0GE1+GiAUmid88U7c5eFb0g17nLr/547oERnfocpv5vrgb6AUkXVKRVLgkd8HpYMT+Ooc8+6FU9Svy88XlIs0pQfMg4QrlvN3QjwLdFYFeE1lXPFXSYW4Iz8k8ePHm7KEYESDlglB5fiJd0wSBlDpGGHHB68+eGaFF3IOcrUZjVq7feCqHEkwMcxhFvDWnSomLw2ioV+gEJyjdbHZapLha0KrLBzMPZuqTyqlJtufWpuDUmdmEFTdlY91Dbog8OWiDjxO+2n5rWuKZpjpFLzEwTVSRB0FxUcz0kgt6fa8Qf5txawVuLebmHy5JEUx7kYanvFNkObGQuWdrfffmgV9rgR+NWbhCXJdlIEtEOZrPUqUzr323HA1+LeLXlOOteTPW6LbNZSIUN+HRLPNMHIp0bK1XfxeCQodS5WJUIdO+W6wr2rTFGdHqbi2I1ApbtnQL2JHlO0JimBBMckC9m6GLDaconLbv2bOoC+8xWWfifUNnvnyBFkuUmU39d8tMG7Zow1aoEz7KHzoYBRZym3TgOhACYH/uf64EUdCF2hh43Vr5mf0mr6H2kUJU5uKLvfBlb14E4yfBN4i6pkGpJuhdP12G7yLyojbWMNbs0GDZgqvy5hbdc8luQd76p0/qqH81fUnj/vxs5bXJpz+6St9RSf46dfdPqnjrSvMrVpoIhumM8mT+ouHBj3zljPhTOLNacSpZTKKnETOuniXSYfdY4W/c5VrAuB5TE8+BjJIWGdHbdZQ1XDXSsVZ8ClEoWRL+3KDItRPO9MJZKi+YNZnRyIEGZcEDF8uBzsGPz8lnO0tOyABuKW7ou6/iUxsWIY+pVrXFGwyGJoXbaSik54Vx74ON0+EpPH9MgSOezYIJoG4yqQx2o7yvJkIiZO+JuEz7tAqFERY2amYLy9CyXjWrEhTKpEKbxyM38a+HdMCN2XkhsO7ZC3Hlo0Nhen6HEJMCTV61Iicqj2+2biyNDvfxRjS3xiovaCxFVQfAUws7vDw8W+EIZib+pGLdaDMu8ptECyY0ooXw2W532lstHllwnaY8xO8Cc37n9rY3bhtReD0/1v/SW7qx+1DIbxZ0IEZ7VmHUCZPlRXLHZIk5ZEwjKCiur+nUhEatG7qMfKSR/OJyPkXx5IIFfHrCo01I0Hhc3zqbcjuN4/nq7xA03IUV4UTmi7SXC1Py8Ws6m0oG8TXkSRj4nbzCRfp7L3mLP/hiixAJIOLrmODjoQ9oAl/6738EkGzg +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/send-token-auth-request.api.mdx b/docs/api/beta/send-token-auth-request.api.mdx new file mode 100644 index 000000000..e005e994d --- /dev/null +++ b/docs/api/beta/send-token-auth-request.api.mdx @@ -0,0 +1,83 @@ +--- +id: send-token-auth-request +sidebar_label: Authenticate Token provided MFA method +hide_title: true +hide_table_of_contents: true +api: eJztW21T2zoW/isa74e+TJxAoGXhy04Kocu9QFhIth8o0yq2kqjXlrySDc0y/Pc950h27CQtXS6ze28n0xnql6Oj867nKPJ9oDNheC61OomDg8AKFQ/1b0L1inx2Kf5VCJsHrSDnUxscXAdnxz12qFVudJIIE9y0gljYyMgMGcDw4Uxa1rs4YThcqFxGPBessMIwqRgxZsgjFflMx23gbEVUGJnPgft9MAJCZC++5sgAZ5SxOkgn/OBWGDmZBzcPMKdxcr3TMQy7p1tpBIifm0K0ggg5qBxf8SxLUAaQrvPFooj3gY1mIuV4lc8zAULr8RcRoZaZQWPkUlh6i9LihSqShI8TIJ3wxMIEfpzNjVTTYMUGpOUtTwoB78RXnmY4Ntju7uy+CR5aAZqjl0hun8AcLcQ4DmYTo1OW41hms/yTjNHe+ZxNpEhipngqYvYC/3vREONOJkmbJ2OpUJZYJBJMOx/SrD8gjlBFin65Orv6dNG/vBqc907h8T8HJ4f9+gN8/2Fw+Wv1zt/0z3onp82batRqOJEpSxkZyVLXpcbs4aFVC4Rr7726sZeUhcnAXMRmJeAfapNUgeAd2PBf3ZrLxmxK5+SzmVbWhVd3awv/W6cwryVPzGzO88JirjxTYDuGNboV5170z49Ozt+jG0eHh/2rK7g6BmX6R3BxOjj8dTAawtX5YPipfz4Yvf/7p6PesLfqP0z1WiWAh16bhhfL2dBEa1zibLbkk1KH2mAcvrvOqIeJBAFY3xhtWMguRV4YBYaVEwaiMV9N2BjKCYPyJRXkroyf0eCxyLlMDnUs1hm9KeyxVCKcGi5RQkEiRzCQAcdbGcMIlmojmGPJtFOB6NoNo4Il2tvsHY+ZD2qq26gMWtnw6DfghSX/MYFGSsJ4Vg5hMmYTEOob04o9wcdvt/a7u5O3u5x3/7q7vfdmvD/hOztb+2/293H2VFjLp6IegdwYPl+Z+r1QUPUjlugIPPJvMIgRHGxPAtDkMETmIrWP+4B4/ID9h6CXo63U9PIyXJZajLN3hxdsd48lXE0Les6nS0ZQ4QhTZlFMcWECzR3jgZFTqb6Xf0f9497oFFPssv+PUf8KrpDXSn71FERrjGEJokIszPQdSewVuINVwooEzCHiNnvtub4GhbiydULp7uzcgjEhtia8SHIY4WdfM6LO2q9EtVSK3BrOXsq2aLfYGJ+lPI9mbMwtDAAXIvnrXhSJLA9PvSVfs5ngsTCv2qwXxxKV5IlbSS2MnwMjxuMYU9cxmBSQyiCMBDRR5ExpKDOi6YuFKZveWJSa07pTMDlA8sfjpBflBQhHatazsIoWL6L3D8jsLNeUblgzGpl0rnIeYbFMkjmY0RiwMBuDbjK3zJcjdJeFwqNKuqpi1SsolbszJ8xRruldxAv7A3l3kUD5CUm16sWt8MkHYaB9NSJvlG7yFQleoto02FNV7ioT30GUTe5ucneTuz+Yu8svS1jk3xL02V6FPiOFWFIbWjxXoI+h6FGalUQOojlHthgYxEOkXz4MGaFgpBdfMwTZz4iP3FK+Inyv8od7Pkb4UTmr4QsUkOzoNJhAJRLxAcm9kJgM5Uy1szrbsTZjCQGq1kBEamDnumAcTGYKpVASblss1sKqFzmbcaiPHDLCWlcBcVYVh5mWKt8gyQ2S3KxGm9Xo51mNNkhyk7ub3P1z5u53kWQlFWWLx0m2SFNu5i7S/HvUljMgYOWmJqtSzm19L6EVZMYqjBU0kUMw7m6Ptyd7kdiN+W78dmd/0o3edvmbve297fFudy+or/XXizyukqyZUzV/Oz+SiQHE3QKOKxQEl821jpvbf2BeIyZY1rD0VLgZbA4mvamwY3d/3batZmdczUuEZBsYUi1shDUNaFOkNSUtEHA2hbqoGJQqCXJhKMlUABeDv58kMpWUvKgF8DXzsDfJQRWXKGWQVbNIFSUFSEiVINGImjUElgQlxQQxH3AgBDuF6vyM6NS76HcheXaJGp+ixqz/NRICE71C7m/W7e+egPAGa8SVc/A3Nnpdt8MVBAA0BK5mVbhzg883+Hyzxm/W+J9jjd/g803ubnL3z5m7/wU+92jo2/gcCH4YnwNte4tVWOoYg+t/DtMpVbwEFN5MR1FhaLu5xOCEK/D4ENBnmo4nZRwPCwWddMI7tE/dqR+hCPCUESJDJ1RhEqCd5XlmDzqde/AV+OihzTPZLs/QKH3XjnTaGYOB1tQePCTg8gwJ6LyTm6BN1jUSA9hVO2LubE36YKiCzWlf+Luc8eAOOnGuC6hvxKaFB2B8MNFjEDGDTuKFJeo2Bc+KfqDXyCQPv18Xx+gbuqwz33dnA3oGki6piCrcLA6FXSHsdrOvHA1bLCXo6+7KZAMk67J3ghvoCdyvFy9/+TB8xaYINinZC4s4V0jsDiBdLiBEqJj1yp18HETri9HFdEaC9xq/lWDysEkCCrOP6koIdn3ijXAOVf4SyvLycTgYdfOy9E4sbkWCC2B7YUkMPBlDCGeyHsYw7hUtdtQVSAWXKT1tf1QhO5JYgyQu2kjjVaQmj11npV68ptdThfhLyS103ELiZl8tSeFMex25szcRZDCy4Iklaz15cscvrPHDFgqeINdlGdASXo7mL1xR6bUny9HgFyK/phwf1YeZhJW0Ocyfe2QWFsIkZicsmmltxd8Yw9DBNLieFpBFTxbrDicNKSPC7lZNpNBNGcoQcCHJdwqJoVww8TGuywRLNCA2FbuU/EyehZz/DF1zzD43dKbH17B8ImWsI/tkmXHCECcMXQ2wXn63OmFgQW6jDlQHXAAcLvxfndAbNeqe47W2qhP7TnlA0EYgqjsXlx24m4NFgfNXjF4gdUUDZRhhdfWbH9wzzwuXqIaxyg2BZQuuyptoWBmX7ObkrTakcLX8o+mLGvcW+yYDlcyfu0p/o5L8ceru/6nibSrNz1hpPNDF/cfLxWn3/vMeSoa2HMKZuPmOo55E7zweXN0nxI3smYC/8JZqAWF26IioxyOUVGeUJTzHrKGqEc2koB2GTHA6vN7CyNUpZXpmNJYX6COJ0dQADZQFC5iXj2UC/GgPvJyZU0I64Ipxg/e2oDYH54pm0LGKNvsATZ+KwO3Y8OEpDnj3RfvO7wo8f4GBw47KYAJQl6aForP02hQp4xCyj0RcLG1UuMII/Z8SpS00QctqVFklMJRRhTa1Pia1gwluXkNfXAusR+aCuLJ+5xpMT4f3oQvArqpS5FIkFPlI12wLHuMN0RzORJJhkEBVF3gCezHD2clwhSMwUxb0gtZem2nHD7IdpAUm2H658Nlpb7e3QmpH4Dl2cNAk15g3Ph1xB+Kr7aXFtyPLUXm/2MJ/wlcofpHC7qKT4Z4Yfafhuh3XXF4H0FyWS2/g1veqwYSWZYadKFDd3+PmCXZcD/gYUhc78+ubRTOFd8DdbaJQR/qbwObd79qHQ/eVg+/SV3+OwB7PjXAbM9+lvak1yxcD3KIKxv6zmdT1/YbfwUP8exB8hH9wozMXNPhtDT6HRt7v/QCN41tCnHUrvL9ANR8e/gPl1Uu8 +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Authenticate Token provided MFA method' (send-token-auth-request)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Authenticate Token provided MFA method

+ + + + + +This API Authenticate user in Token MFA method. + +## Request + +

Body

required
+ +Token authenticated status. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/service-desk-integration.tag.mdx b/docs/api/beta/service-desk-integration.tag.mdx new file mode 100644 index 000000000..07c77c709 --- /dev/null +++ b/docs/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/docs/api/beta/set-access-request-config.api.mdx b/docs/api/beta/set-access-request-config.api.mdx new file mode 100644 index 000000000..e4859dc6b --- /dev/null +++ b/docs/api/beta/set-access-request-config.api.mdx @@ -0,0 +1,108 @@ +--- +id: set-access-request-config +sidebar_label: Update Access Request Configuration +hide_title: true +hide_table_of_contents: true +api: eJztXG1v2zgS/iuE7sO2heXYznu+3DmJu5dF0/TSBMUhCa60RNtsZVJHSk18Qf77zQwpWbKdxH3Zu91CKNDYIjmcGc48M0ORvg90KgzPpFYncXAQWJH1o0hYey7+nQubHWk1kuOgBQ1RbmQ2Cw6u7oNLKwy0ZOIu6+fZBJ4FMlYHnEaGxg0NIxp7kKcxz0Rw83DTCjI+ttjbzcH8JDaApljYyMgUOQE+LibSMqHiVEuVMSPShMMIlk0EAz6MgIf12ZibLXeytK9Vn2X6s1DsVmYTdnb+67/6x6cnbxkHfjUKwmACHCuNiKEri3iSAH142n930gaJPeFDHYPQ90HRNzjITC5aQYTyqwybeJomMqKJNz5Z5P8+sNFETDl+ymapAIn08JOIMqCbGlR5JoX1Y43+whN7msNcYnCXCaN4Uhk41DoRXAWLKjoZMeIElaJYSYdNgRAbCgbfUUEg3XDGhKfL7MxmYoryiTs+TRPh5HloBaAZ3fdUBooPE5R1XS4YVzHzGhPGf/sixS1+MYIWzvJpyS3MNQWFodJnnnfXqZBjFYee/pk6FBOejM5G3jqByzpT3q7YmWKuKzsbsaOagQD5ZxYmSfTt+eKMfTXTShzO3N/19MOpLxiYKjTkbZeNtPGtKxdkJQcD6KNnAng45YqPhVmTCTZ13R/jAyx/YwLNMRh5RC6nTWaX+QLGMpnh12CJN78eyLtfxnMxlSoWpq/igYXVJuU/tmyF9bFiFNnRfNzXLmHMZ/ZSZTKZk6goC4BFoPoWlfU2nw5haj1iOB6h4ZZL9CjQkrPRkTQWNeSYbDNQr9Lld0sGX8CRiL3JE7RIB2HqySlEyS2KCI/AUxy/m73qcnRagcqTBD21tBmkdyiyWyFUoUT7PTITpVI0EDOTIw919uu5m/K7r+HqlN/JaT6tqGslI8iuhViBf1G7JfB4fRa2+JxigTROFxx0K2J0V4gxAs8c8uizs1dhzsVoFdDXxy0ap+tdjrKZkWq8pIILkAd7kNdqBWAJyH5yPHh7cXLxzza78EZlBI9DbK6uQFD0Q4eU8fOTncQQ0Cg0xjW/D7a7O3ud7na82Rvt7Xci3t3e6/ai/e5eZ29zO+4JnEABuj8/xd9zgKEQ2UXNANhYiOwzhoNxfaXn4DnJ+omEOMteCzPOrcbpIdjK5Pn5B9iN8Tg2iHtfMSOnGdsjN+PfimFWw8NIT4MqLhZ6BLsQkKpE4gPkIG9BRERB4rPau78GVKKAigZM4W89N1uC0cG8Z5FhfVPwGyzNuEaoeZ3wsYtrSAKWgFUYL+LOE8H9SE+xJ+WfLt1af0qXouGckafCbicSzMzmw6nMMmwBN3qEoViMeJ6AjODeVlQYpO+IrUJJEf8uDBqBy/Cd/I0NL1eqMKr3mIZWAecxxyhjr3UjiF+i+NgaOodBXAJIEtMUcYMCYYm30KyEiEUM6fgpsC5TXAtPv0hTURM8tCLlYJzQlSHkwWgZl10xnl5XHeDsVglzHbTgqdW5iUTlgU9zrgNKHq6DW20+j43O04N7GT9cB1VeyjbLXowRyRUHb2Xu0ctCttySBNUlqE67AunnsLHIdItVRraKnKw15+TA4+rWzk5ntLUd73S6Ozvd3Zjz/V63s723VcOOZRctAKMKMCsKuoeHB/I5m0Igd/bR63RWpGS1Qq0OI+xYZABmlAc01VBTDTXVUFMNNdVQUw011VBTDTXVUFMNNdVQUw39maqhrVUF0FEicZkHxoAFhIAgWW4UVBGwuC66OkQZ6pjeKElFi/UDS6KYiqwjHa8RT15LJUIwU4kcCmI5goFY/HyRMZruFFMARxLxHkWgfvUIB5pod9khj6uIScKgIg0Ee6B1skYMvVQSxrNiCMQX8qRHphW7gg93Ovu9rdHOFue9va3u7vZwf8Q3Nzv72/v7ODt4gAUjqfowN4bPlqb+VYBNyYglGqKH/I/AEoxjmEQGaHIYIqH6s8+vAdFYMz9xfUsxPb8M35W2oO44PHrHtnZZwtU4p+d8vKAEFV6+X/IikNwRPjNyLNUqVoTCbO0qOB687l++uYAn54N/XA7ewyektfSKta/AWmM0S03Z5ETfEsdegFtuIY9MQB0IQ6881VcgEFe22tFn8a6UZh4UYISffcWIKmk2Mnpac6XIvVhmL2RbtFsAOfAMUtNowoYc63dMcaH7K3TkNAvfeE2+YhNIVYR52Wb9OJYoJIAueGOO8MopVYRMB13XERjl4MqC3g/rPKMcOqpXnhVVLmJagSZvqouCzgGcrxFeoiwH5kjMqheW1uJZ9OsDPDvN1bm7qCiNVDpTGY+KbYRIGypdhyCbhNDq4QiXywLwqKJfiVg1JEVuTh0zx5mmtojndg2/e5cA/IQkWtnwRXjno2LKoRGtRrFMHpF8yUKDfa9yuQrHh3pTJHHju43vNr67pu8uNp77bV/fSqlPdzn1uVT+sAwGz6XUx5D1YILrO7ndB7eQLQYK8SnSbx8u/FEcPNJzl2KZ8APzIxfKl3fPyvVwz4eYfpSLVVsLZJD06CQYARKJ+ID4nnNMinKq2lye7bU2QwkGqlakiICahs10Tom7yZWiwsa2WKyFVb9kbMIBH/3eIyGgO/oU0tmnJpNsMskmGjXR6OeJRk0m2fhu47t/Tt99MpMsuSJv8XmSzadTbmbO0nw7SssZdGDFAQRWuhwt1WK2gsRYmWMF9cwhGPa6w+5oNxJbMd+Kdzb3R71op8e3d7u73eFWbzeoxvqruR+XTlb3qcp6u3UkFUMS9wXyuJze1mVax/Xtvxx3gkcIawg9Zd4MOgeV3pS5Y29/OXe80JqdcjUrT8PXckg11xFiGvSdYl9T9IUOnI0BFxUDqJLAF5qSnAqgglvILJFTWe4kA10zC/sjPJXgHKUwsnIWqaIkBw4JCRKNWfPCO18zowx2DOj8A7NTv0Tflcmzc5T4DUrMBncR7bazMnPfXrW/e6L8UZD3boEf2eh11Q5XYABQEDjMKvPOJj9v8vMmxjcx/ueI8U1+3vhu47t/Tt/9ivzcZ0OP5+fQYe38HPq2O6zMpV7TuYD/dZpOruI5IPNmOqLLovE8B6e8AkwJGUpzwhCOF1iDjZWXVwO8+Ip5oWMpNwl0nWRZag82Nu5hpWCFHto8le3iCJTSt3gCamMI6lmBPPNTj9gBr5r6yqJNujUSzddhHRF3mi7PWYDGaVf4ScrF8bGZzgHdiEwLj815U6LHwGIKdcQvlnq3yXSW5AO5Lk3y8P2yOEKPyLJKfU/OBv0ZcLogIopwM7+nXDnqs3RbeR5IsFDrLU12ht167FBwAxWBe3fx4rcPFy/ZGFNNcvXc0kkgibUBOMs7MBGCsn6xj4+DKLoYnY8nxHi/9qYEXYeNEhCYXav3QrCr4qTcW8D4cwBlUikOEoQDOOrmRbE6sfgiEgx/7bkm0fBkrDZAQxu8Nu4lhTqqCaRyZz3dNemQHdMRZzzC6k45ORGpxGNXaSEXr8j1rUz8paAWemcjavblAhdOtVeRO3kTgf8iCTzMj9r65skdvbBCL6QTXSFSXeQBNeH5qL/fiopV+2Y+avRCpFfn41p9mEiIo/VhzMEWsxAGk5idsGiitRV/ZQxNB93gapyDF30zW7c4aUgeEfY6FZZCN2UoQ8gKib834BjKGRMfYlSmpERDvqZi55IfaWXB5z/SubOPNZnp8RUET+wZ68h+M884YYgThg4DrOffxSY0LPBtlIFwwBnA0Xz9CQk8oxXcc7RWojqR36AxGBoiYJWo2PTAfTmYA5z/xKgBe5d9AIYxqS7f+OEvD3haD+7qyVxZxXbAogaX+U00xMUFvTl+y+0ojJV/NHlR4v581+RMJbMfjdKPIMkfB3f/T4jXIM3PiDQ+zcXdx/P5T5gMioLkiUt2rmhaefPNNT1x5Wy9C2J+hnWvchVXv9a8PrXqglPnsVtAncULON3nrrKUF0jc/ZHn74EU10AWL2iU9zPWukfx1FWHR28m1NZr+ZC+PzT/2Bl+3/zkEfrf6zA3wiQpfeH6CILzoa8zlnefLd1Fg/+hlWIMVYJQZ7vf/8Hsu0ooBfNANKZoFE2koH2rVPAM7b1V3MiECFLcG7WO0NhAHwg3ZGFDmfi7MuXMnIDeFUSIR/jd5lQ8048MTbgaizb7IJhQEagLtxHwbBC0fdJ+P+E92MY7+t2j4wKkGK5RrvA2ErCdTxkHKHwGyWJpo9wFXChmlSh0oalkKUcV0QchEkWg6zDCTO3ZCF+JyEhUAOuZuQCvrH8fAqrHVfQOMBfkXDjPxH71cvM52oCS4UQkKW5kQLYAhYOozHB6crFEEYgpZ5NtbcYbfpDdwL5ABMt6Zz6b7W67E1KZC89TbTOw3grxS/oJK/bUZehFk7yfvxX6I/yYlYcwrIE3Uty3RUFzV5O7HZCrYPUOCNTUE42QchXc3+PeHm4JPOBj6IYbR1c382ofvwFht8dHWyafBe4t+ZdK4cWMUkO/ibT8tgw3IdwIt2/4ZN+byl7Ou0tc/qH/ra6p25Uy/BYe4v8HwTX8gy86dcYHnej5fVDs8UIfR7ZIwVdloP4DSvnw8F886khg +sidebar_class_name: "put api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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' (set-access-request-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +
    = 1`"} schema={{"type":"integer","description":"Maximum number of reminder notification to send to the reviewer before approval escalation.","format":"int32","minimum":1,"example":1,"nullable":true}}>
    fallbackApproverRef objectnullable
    entitlementRequestConfig object
    + +Entitlement Request Configuration. + +
+ +Access Request Configuration Details. + +
Schema
    requestOnBehalfOfConfig object
    + +Request On Behalf Of Configuration. + +
    approvalReminderAndEscalationConfig object
    + +Approval Reminder and Escalation Configuration. + +
    = 1`"} schema={{"type":"integer","description":"Maximum number of reminder notification to send to the reviewer before approval escalation.","format":"int32","minimum":1,"example":1,"nullable":true}}>
    fallbackApproverRef objectnullable
    entitlementRequestConfig object
    + +Entitlement Request Configuration. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/set-campaign-reports-config.api.mdx b/docs/api/beta/set-campaign-reports-config.api.mdx new file mode 100644 index 000000000..c929a6d61 --- /dev/null +++ b/docs/api/beta/set-campaign-reports-config.api.mdx @@ -0,0 +1,92 @@ +--- +id: set-campaign-reports-config +sidebar_label: Set Campaign Reports Configuration +hide_title: true +hide_table_of_contents: true +api: eJztW21z27gR/isY9sMlGVOyHSeu/aWjKM6Nb5Kz65fJB8fTQCQkISEBFgDtqB7/9z4LgJQoyUmapO1dRnczjkQudp99xS4M3yW6EoY7qdVxnhwmVrghLysuJ+pMVNo4O9RqLCfJVuL4xCaHV8lQGCfHMvOLWENtk+utJBeVEXghwMqZWtATmxlZESm4n9wIc2ukE5Zlnm0dRLOxNiyLnJgJgnvvAOGftTSgNrrAz+HR2cU/Bi/fHP/OuMrZydmv4VsP6KzIanCeAeFdcmmFAW4nPrlB7aaEWubqsJGQRglpAHHoISXX99DAQKKw7oXOwenOfwWAB9RpdGfBVGy4qBMwZQRBOWLEq6qIJut/sLT6LrHZVJScPrlZJcBPjz6IzJGppSvEqgC7IqEy5D4nhSU2Moc02GDgnJGj2omhLupS2QUR3Bg+w0JVFwUfkZB1ihXSOqbHrGHIeMMRfgsstxLYrFxkbUGiJsn9ViI+ATfxvkrG0lineCmwoODx4/W9/4+sbSutbEC/u71N/3SRXEwFg4YWgETONgb/ToPvrbPxsJCQyo6MQRamUN3VRsHacswczB9Tgo2QE0xaJtUNL2Te+x57d82YC8dlMdS5WNVu2VKvpBLpxHBJCIWHnGEhA8cbmWMFK7URLLAkk5IKno4At4YiS/R22Aues7Oo3zAqAzM5w7OP4EUl8UuALpXEetYsgQt9NXtArNgXfPR8+2B3b/x8j/Pdv+7t7D8bHYz506fbB88ODkh6KazlE7EuirqifxVKGJmxQmfwyL9gECO4jeXUC18TNQ/4wPP4CvtTQgbaVs2Il1G53WKcvRiesr19VnA1qf1zPlkygkovz1dyApoHxidGTqRaB0WouqQgf3n0anD5+gJPzo7+fnl0jk/E63oZ7EAhWnMKS0BFLEz1rUccFbjllllRwBwi77EnkesTKMSVXSSU4ZudoQqViK0xrwuHFVH6mhWLrNnY6LKTSlnYm9gj2RO9LTaiZyV32ZSNuMUCuJDInwyyTFQufR0t+YRNBc+FedxjgzyXpCQvGLIRTLF+BkaM5zmlbmAwrpHKACPdVNeOKe1kJrq+mJtyuUI1NfH1olMoOYD8y3EyyFwNcF7NxSxsoyVCjP4B5mC5LrqLBaN5k86U4xm04EUxgxkN2g1UJugmnWWxHJG7LAqPaujaikUlsFHLl7s3AcxLp/27jNf2K/LutED5Sb1q7YsbEZMPYaBjNfLeaNwUKxJektp+caRq3dUkPhtLUeSb3N3k7iZ3vzJ3l1+exc4yvvWtz85q63OpOOYDbfzmudL6GB89SrOGKAwrwZFbDAaJLdJvby+Q2B+FInrxqaKR4Qf2R2ErXwE/aP0Rno+o/Wid1fEFAfR2jOMWKpHIDz3uOeJk3iU+XZX2SpuRRICqNS0iqqZhM10zDpOZWilCwu0Wy7Ww6hfHphz1kSMjrA0VkKSqPK20VG7TSW46yc1utNmNfp7daNNJbnJ3k7t/ztz9bCfZovLZEvskW5clN7MQafE9acsZCFhzxsnalPOuWu5WiBlre6yk2zkko92d0c54PxN7Od/Lnz89GO9mz3f5s/2d/Z3R3u5+srjXX83zuE2ybk4t+Dv40ZsYTdwN+rhaIbis0zrvHv/BvEaMqaxR6Wn7ZtgcJp2fMO4erDnF1Zq94WrWdEi200OquY2opoG2JFrT0IKAswnqoqKjYAlcFEqyFOBiEDSskKX0yUtagK+ZpYOxgyohUZoga6VIlRU1EPpKUGjqmjUCS0JJMaaeDxx8BztBdf6B3Wl00Xd18uyMNH5NGrOjT5kQlOht5/5s3fnuMcAbqhHnwcEPHPSGaYcrBAAGglCz2r5z059v+vPNHr/Z43+OPX7Tn29yd5O7f87c/Q/689gNPdyfg+Cr+3PQ9rZZ20u9ouD6n7fpPlUiAh/eTGdZbfxxc9OD+74CoUSAqtrXEE53YJJ+c//F9rsXYObXG8IIEMDVpsCiqXOVPez37+Az+Oq+xyvZa64pKH3by3TZH8FQa2oQXRYI+UYEbHB6HGeMnreykRTIoep55sHmXi8KWdjenw9/ljPdbyBnznSNOufZbDEEfQwq/xgQK0wUv1hP3fNBtKIf9Lo0xf336xIYPaDLOvN9VhroGZAuqUgqXM8vPZ1T+x2kr1x9mm8pNLLtrgg7IbJd9kJwg9kg/Bbj0W9vLx6zCTWdPulrS/2ukDQlIG1OESK+qA2aE31a5PcZo+vJ1AMfdH5nQknExgUUZu/UuRDs6jga4XdU+zOUZ29SWiR8RaBV148a7+TiRhS0EfbmlqTAk7nqw0J93ln32G96fjqQCh9L/7T3TqXspaRaJGnzJpqooh/22FXV6MUX9PpWEH9puKWBW+q52cdLKIJpr7JwBydDJhMLXlhvrW8WHvilC/xolMIT4rqMgSwRcXR/05U1XvtmHB1+KfHr4nin3k4ldtTuMhYKGLPYEIucHbNsqrUVf2OMQofS4GpSI4u+GdYtCU19RqS72wuQ0iAylSn6Q4/vNRJDhWDiI9qffXui0bmpPKTke+9Z5Px7fy3xfUdn//gK2yhR5jqz34yZBKYkMA01wEb8YZeiwEJukw6+DoQAGM797ytBBLpQ9wKvtVXds+/7NbQ1ZIDqudjqMHw5nBe4+In5F0Td0qAMU3vd/u4P31nkRVtVx1jNwcCyBVfxFho75JLdAt72YIp2zT+avqTxYH5+cqKK2Y+u0g9Ukj9O3f0/VbxNpfkZK01seOkc8mx+dfuoGU0+d0X3wbuymMYRvV6LOGgs5syL2P6tHg/S+fVU4Cfe+tT3rToGIT/a+aZokVFVcEdJ4otENpXCHyxUgjtqJbcoUHXpE7symqoJxkfPaGJAgypg0eLykSzAzx99N5K5z7/Qp1KY0Hdb++mGZGVTDKqix95i1lMZvExzHl3ewLsPOg5853D0KcUJe9nEDnq4sqwV3U4G7LpkHBH6hQDLpc3qUAcxaijR2EL7TrJd1RQFilxSoecnHlPakzGdWWMcXoijL8hCGNl4YA3Tkxe9WzFMtYqcicIHOtF1p4Av8UbwplNRVDRpooijnxMLEt4cX6xwBDNloRcmem0m/bjI9okWTGjaCuHztLfT20799IHnlbYOs/EC83Phlu+/r15P70Tk3fzU/r/5lxdx46KJo1/ReRnhr8MEFCbPq6SdPBO69L9u9sQ0M4XORHx3R+crNIzd02NkNQ3vV9fzOYu+QUg4Z/HD6kdB83082E8vZn5TjoP86m8saPwLK8LZzWdprxfm6dNL8vAo/nVIGU4GDL8ltfDzMHmH//FFVyG+6E9I6DlG/Xg6BJrAtml+1u398QNpeX//bx0CKpc= +sidebar_class_name: "put api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Set Campaign Reports Configuration

+ + + +:::caution deprecated + +This endpoint has been deprecated and may be replaced or removed in future versions of the API. + +::: + +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/set-campaign-template-schedule.api.mdx b/docs/api/beta/set-campaign-template-schedule.api.mdx new file mode 100644 index 000000000..9862f3601 --- /dev/null +++ b/docs/api/beta/set-campaign-template-schedule.api.mdx @@ -0,0 +1,171 @@ +--- +id: set-campaign-template-schedule +sidebar_label: Sets a Campaign Template's Schedule +hide_title: true +hide_table_of_contents: true +api: eJztXPtz2ziS/ldQvB/ipERZkl+x9ocrxXZ2Pec81o9L7VmuGoiEJM5QoJYg42hd/t/v6wb4kuRHMrmZnZxqMolENhrdje4P3S2Cd14yV6nMokSfhl7fMyo7krO5jCb6Us3msczURTBVYR4rr+VlcmK8/rV3pNIsGkcBjxPFAOPdtLxQmSCN5nQD7C5UZkQ2VcI4JmKcpEKKwA0RmZukLU7HuF6SyThVMlwI9SUymWmJKBO3URyLkRLJZ5XeplGWKY1r2ZT5a3UrEq3aENKoIMftBQS9866MSo8Snakv2SDPpiR8FOp+Mb9fzN9Pc+3d3LMC81RBMwVzZGmuWt5cpnKmMpUaZhmRYnMJZi1P4wa+RSHNC9ln0uvfedliTldNlkZ64t23vFT9M4/SimPTSJeQ//RYJGPWZMU00BlsStOEpKP6AqqYJunsjlQYqJ3XB6Nw92DUk6o7fr2vRp3RaGc/VMojnWh+ZbI3Sbgg+QIyiM7oo5zPY7eO278YEuduVZFk9IsKMkw7T8lbskiZ6u6yusvaHZPlZpFW1hFo9SQWslzpQIZKB+QAWkyUprstQRRZNFMC00VJKMaRikMjzAw3VApGUltjTRMDNyAJwEiTe0C5cTTJYe22eAtnc6YCT3E8OD37R31mLabysxIvpkmemhcCzt8SozwTOsnEi1AuzIu/YNink5P/WjtulMD7isFSh24M8eFF0vmMHM6Ox4V3H95f/o0/Dd6/vxqc8cejwdnJ++PBOQVPtaxuDHxnhsWamnWrsRRqcxUgJmHm22kUTIUdR15VD6sU/wdZ9Bn2/qDjhfgs4yjkoCxEqohpPtMWJ1Yo0x/qof6gxVs1SnOZLljjdzINprjzyq7B2enFJX0BWzicGHq9odfCPztDj0afYPEXYsfJ1hImk/AmOHekxU9SM9etf+IfuEy8ePkI3y4xfIVxoMRFsVOxz26TQvmRym4V/OOnPLbiHqtAzUYqrTifD97/9aTB+sCK3O0tTdEb6m8MgRM4gp0tS4ThdVoUIvK0NWchTfGVxWq6BN+BQ1hBa7PKNJWLlUn/2+rjUKUwiDQqBFDyNVWKNQMaYBRuyRECFLwioI9Zi2WlQNdeF4gJUmegGjVdmqi0DlS9lgcvm8nM3t7fXRH4tDB0sWoc4LC1gwUiM959A06v7YylUUgeisGvDxeM2jIv67ESGRcqFB5tcTnFBfwpJrc7WR3JbLwMNeH50Ek09Cx2iWlCABZG47FKYW3Ml0mBvUbpkALALQmvBpas4Ml+arGgTyKW6wkD/Sq2uv7BS6JwwNIk4SUnmp1uS5zhj99tt9tMX8R6X0SWduhgphSXlI9NQlD2LK5/EcBC7MuRUX1xevHBf73f6ZKSZGBs0glQdaFkKraGnu93exg+9FiWAv9WhoGy1+l1asRD/T7Bfgj0z8phsBxi2+TzeZK6XIMChS3Z4pgvgS1MwJWg3VEzMQeatfvtFE6H+P4chSocas4tHlGlzZCzBI4XuSZrPYVc1kmQqSQQEKAQS0MusWhY+REmsLpl8zZNZjyi16FMKOHPT3Bbhbxex2LeWR2mGdpFT4ePyOH7nR2/07PDoH45pgWBet1yZH/NzoD71ejviazsrr8TrvJc/x9QlbOcr4dVGvY4rjYiyO3g01QpHmqqFGFMnv568A61gA7i3IDBI475el1+cJyTuZHhGUpHjZ3hsbg4tGGxZ/17kIk9ml8nibbQsvfx3SMy7FWJBP978L0d3Vroh/b0Fe+uu/7/jaerL/PIUq9bllIg2hB8qlEeiQHe0qmMkWPI5kIio0SijAauajV2gERDY5EEKF6bFR6Asud3Dv3uoeju9Pf2+r19siPx/R/YnMr2p7znspDjXxhAHpQbt92h7NUUE/Ua3dZNkUbooTBrFTlCPYDLYpSYgYfAjtyl2KCoYAXLNAIZBBENvSOEBwKhwYq1r8YL0DSVPyKPXb9kFpFuyBIZ05aNisrL2AXf0fYXc+XbNMt5rk3hzN097J8k/drNs0UCItrbhavUbF5VdcsY6SKxCDc4/MG6DHWVbA9kpPUH2B/QSdnGA9IrBsyidupCdAg6i0IdTabZOmlrleeT4naeJS1yAGzkXSfy34vq7UFzs0quyBNbqlESviyWYxyl0KWRc1oX+a06dZ+3Aky1Unqvo6sD2A6b4B9YLuSk0MQhQSCO3Xzr/c9mTd1eo0QVe2VQWRtxzvm7aM9ZXbeHa5yqdyp3xMrVdMrUAzq5aE5qzYLua4oiSujXqFD2QL6bClw5dHp+9zXLfn9vQcTMsQdYVOh1dlelf58I1xwTPhAwpNaYw3HXQxO3EpiWBwESiHEec7uIKh+GRV0NB+SNaFCWp7QvRtoxsRK0CaN2O51VCY7iiIafpCkw2BfnJYNxQ4pREi5oxkhzB4f84jt19UKVySg+SsJnZCVvkUf5k1RGJKFikQMMdEUU7SuzBJaxLItoZromysMS7a54I0Poa/U7csrQRpfK4Ffwes5Gd6UjjBfFEOF6Ww9Mqw6UHO13Dnu74/1dKXuvd7sHe6PDsdzZ6RzuHR5y+w3rLCfPyJb+SkkGwiJOAqzIv2CQVEnYngXgydekRQ+sAfN4hv1pX7e0pZpOXkEdb+p5vjn6KHYPsKvpSc7X5WTJCNq/uqBWdh7HckSXqEcNzS3jD2k0idZmQkW+eXzydnB1xinnyd+vTigQidfKbwEDXUQURIUvTJNbW61aBTiuVAxzUOf2leP6CgpJbeqEkftFYWFgTPjWWOZxhhFu9jUj6qxtHVEPpcD+PCC2orZqtxC1uIYUD4jcyHZfDRDz88w/c5Z8JaZKhip92RaDMIxISeSeLvmfIX9A+MswrGJ/nCOUVdlC0EkWBaq5FpUpm6tR5Thn9UWh4IDkT/vJIMhyCMdq1qOw9BYnYoF4obNcU7rLZRRc6IwqOVBiuwuSNIWFGRCjzJRAyCngTOqCrkSs+/tKLYa7d1aY4yzhe4HMzTPi7mMM+PFZtfLGZ+WCzxAOu5YOrUaxTA6RXL+EBxeNn8IWReDbTHYTu5vY3cTuM2N3+ea5y3rcXU59uqupz5WWOeyb8ua5kvqUGVZBZH98tgvZElSxWuv89OkSgf0rilvQczGvvmd+ZLfyFeEH5XrY66Oiqi62/motSEC2o9VgDCRSYZ/lriT2iqR1t7OzOhsK9FEEB9VrUkSgZioWSc4/9hX1vTQt7n/rF5n97VJyBmsRkGbVoT9PUMlsMslNJrnZjTa70Y+zG20yyU3sbmL3zxm7j2aSzS6/y5NMPpvJdGE9zd23D0GBoOy/iTLkylZkPVshZqLMsbxm5uCNet1Rd3wQqN1Q7ob7O4fjXrDfk3sH3YPuaLd34NX3+usqjssga8ZUbb3tOnr22YD0M/K4XMO5TJYkYbP9B/OmakywRtBT5s2wOUx6U+WOa3ucGXQDY+SO6QPtxavzM+KPqZk92S3J00BRmm1NZ5/CKB+p4Oc0N6njJnXcbD+b7eeH2X42qeMmdjex++eM3a9KHXefSh13vyJ13BWUYo0pxfojU8cQeQelZmMsCh25yVN+8Dil8y0Gn1z30YV9JtOJyspEr5FF9g5Xs8jLJBHvpF4UyZJpdCJ1ZS6CN9DOiDYtaCN6kmACiNTFCQ/yKnpCCTkpnXmJo1nEcUwKgW+68Af8DJWNmeXf0+0zgZCQQYGepaJ5b2UEd1JjSv/AgfugEwD1d+xxutX6Tf1gcU4an5HG4uRLoBTFfNn/3Vv3lAA/60ZwcWHX+oHHBWzPXGqUEerL3MJXmYJuUvVNqr7Z7jfb/Y+x3W9S9U3sbmL3zxm7X5Gqu2zo4VQdBM9O1UHb7ogyl3pLzvW7Z+wcKk4Cdm97BoAfWrivnl2dKbgSCTTPGUPo/Hnf2145yG6276LwfttUh/ZtOWCly9MYo6ZZNjf97e07LBoW674t51EbWIZ1yxY6uW0HyWx7BEutASF7CJIciAjE4OOpqzfso8lpRJ5sYY+ZW6OzYuSzMD4/ZvAoZzpVT6u5QCkiLJsWHTRxXsWXIeIcJcULw9Rt9qIV/aDXVRrf/3ZdLKMHdFlnvkdnA72ApEsqkgo31esL6DTDzM6+8hKDak+hzn9vZbIPRNYTb5RM6bQ8Pwyz9dOny5fFURhEPR2CmggVUZmAuPkIF2FUGxQPhtAg3mjSJJ/YtywMGo/eUBSJcQyFxVBfKCWuT50R3gPuz4HPbFIapBgSaNTNVrE6ofqsYtoJ25UlyfGiUG/DQtuyMe4l73pcHkTaHsLB1fZQ++I4IjCi0z1MU5z2oWpPXM8LvWRNr28V4j8Kbr7l5jM383JJCmva68A+yh0glImFjA1b65snt/z8Gj+qpXCFuC7LQJZwcjQfmAqKVftmORr8fOLXlGOoP/FBp+YwYRFMGOyIcShO6d0NiVH/KQS5DoXB9SRHFH2zWHy6yueI8Hudmki+ndKPfCSILN8ZAkNbZ5Ij2qA5P0lsq4RD8mdeWcT8z3wo4+eGznz5GvsoUYZJYL5ZZprQpwl9iwHGyW+3KXIsxDbpwDhgHeCoWn9GAidoDfcsr7Wozuy3eQxtDQFEZS5m3rdf+hXAuU+CbxB1SQMYpvy6fITMHoNnXrRXNYxVdAaWLbgqb5xgi1yym5W3/H2Tts1/N31J40HVQKHXanxvlH4ASf59cPcPQrwN0vyISOMyXmpEnlcvLjopapMyrMr36nz1Ob3e844ALg95ztm05TH108Rrj/I2T/LaA6/EZJzwTK4uqkf4G5esrnYzqd0+VfgbdxmoWBbUbdWLsuqMqGCgkGZIC6aR4j7IXMmMEt8WhVUyYxiapwlhn3sDhpikoAFmGSTkchTF4Med+mJmyWhhs2pyavpucvfcSIJ4RF2t2uITnSEPYFQqS+mJZdz7JXH16QXc8iN5tTguPB0Z52yWa8xGoJTP6JzhU+EQRibILWqjStWqsAW/rkSUowoIozgjFdpcoKUz82FMLXZU7zWvf2IuOL1x/XWYnlbRvSasUuRcxe48emupZnmKN0LNn6p4Tk6CLQfZp6rN8O70coUjmGn3o06STrbdILNNtPQyAChv3Wen3W13fK6VcH2emAylfI05v8xNlq97E8UL4lCD1d4R13DJ2rvG/pB3wblApcppe06NP9Ist5WcLaGvvdUSGgP75SvdWK0bCn6TEfndHbWKqKy8p8vAJ+pDXN9UFSNX2lgv+oyQHgM+l9/5VrfL1rk72/6Sf+z6yjfBrdWwaIDqRdX78PDxV0UtE6h2z6/04J4WS2tvuB9R/MvaOxGIzfKvQ1Rp2xG2T/Yo7U2td/Hxitxz5F5DN7NdmFTe4iL93feG+A9fkrkNDhDx9Tuv6GmCxrIt8sx1aZb7gEUB2f8ChufhCQ== +sidebar_class_name: "put api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Sets a Campaign Template's Schedule

+ + + +:::caution deprecated + +This endpoint has been deprecated and may be replaced or removed in future versions of the API. + +::: + +Sets the schedule for a campaign template. If a schedule already exists, it will be overwritten with the new one. + +## Request + +

Path Parameters

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. +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 objectrequired
    + +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/set-identity-password.api.mdx b/docs/api/beta/set-identity-password.api.mdx new file mode 100644 index 000000000..dace028d2 --- /dev/null +++ b/docs/api/beta/set-identity-password.api.mdx @@ -0,0 +1,124 @@ +--- +id: set-identity-password +sidebar_label: Set Identity's Password +hide_title: true +hide_table_of_contents: true +api: eJztXHtT4sgW/ypd3D9WR8JbELembvEeVHzwUFGn1iZpIBLSmE5EnJrvfs/pTkIAnXF2Z/fubrG790qSfpzn75zTnc6XGJ8xh7omt5tG7DAmmNs0mO2a7uKcCjHnjhGLx1w6ErHD21hwi7SoTUdsCg1jn+MxgwndMWc4CAzRHZuClM6bBP54ghnE5QSGJZTMgu5D7hBqE9OfKUHu7Du7tLxBdHiqj6k9YsQdM9MhfG4vu+9QQebMsgj8pfaC8KHfiuo692xX/BK2FbvElE8XSAvQ4PIJs8mI2cg1EDdY+H2b1VNs4sSJ8PSxHJrcgmwEt6mFIzMhVO/PO2PXnYnDZNJgT8xCASYENa0ZN203ofNp0jTsJJ2ZSerB2MCRLgX8n2A0TY2mydGAQpDG7V0MG3PHfJFtf9O5we5ixGCO+QRknpXg6R+cfmUCDSfQRg61XW1o8fluQurAl8/chNluUYl+J3fxu6fVLROuNN1hUrvUEtFppaoHLLQUX+sfPoBiP3wILeIXsVQ/iAsmiFwPI1YQ7RGYg7Sv2Ao3IFqHDUEfOGdgFe6YuoTb1oKMQf042F1MUf9bhHroKukn7mLGpNT63JNsoIW5aP3MNqRYcPDA1NDg75mtO4sZ2F3gSfdkp90pkfA+jGHaIzLzBpapH7PFLtLe5cQAH+JxcBwLhIakwVTCZaAPJCCdID24cXvhMWdBQi9t2kP+frU9ZZOP2F8LBKuZ0H9X8eBKcajpkUB85Eylgg/JfSDzpnEfJ/eCe47O1O+QkbVLvAjUA7+pbcBDDs9MJu4VHmQSpDLmXEjJ+W3J0OFTpX2HPZncE6BGMeO2lDxobwGqmJsADTOHPwFZCiLCuYAKIB1bOdAR2BVuCE92RAuBCBQlWV+8HWjWXJpXIOcfEjFMFQp4V/IdUCqNdylWycqI+yxLihl1wBodItWUIF3wMkINQ9kc+jPyss5boLtN5qTp3N/fP9Anemeb0xl3XIIXzwnZlCcq5mzMnF9XHiYE0z10oQSosU51lzuLt1qcB+p+q4GYMT1xvZ8q1myk34CmHbi12px4rmklylSwfO5XpLnjOmiDPkc7/mVoW3Hi33F5TTUBIx47fC5I7VlnMk6RL3c2AfB32e3nZc8yXAvykai5EiC6KkO6nJ3dhCF/7Sw989fICKFwgxH8G21Bd1ZHjy+pwvHlvZ27WK9b1w7uYrtqVIe5nmNHyFDiQTKY/NXlisWd1Ymx91eU0AyiBmLOKnlIzassx4OGIW1quDfEFqqVTOB/H8nSEJDWpi1causMuAJoA54SAQSqfjs2m5NNna/JyZdEoEkAXLF0jY9Ejp2sVcrJ8+NKJ30ObgDt7mKykzJboqs/H/3rFdpWB1RzqfYJ0zbdnXQceVvRhv/Y4HUTYvjOmqiU5MGbCPyDKmjafix4ptOZxQDvwh73kdgjscyiAEoue3aXQQ29nzoMoclFCSBSYFgNdAn34sHNKK6uDx2qagVOJJibDiBEgBT4WAC0KcQLIpqcEcPabQNgJAwsFRWk237fjktdT/wQDI4iMKipmK8JOcyuygKYPlmN8n5iENCrGgMIhrEROZh68CgKqPd+ewT+TSBdCwHR+VAOkPn6LcrcWMQOv8hLE1KB2KHreCwe07ntYhIMj+hsZvkpT/JBYCb8JSaAjynFX5grQG7MBw9Md2FcoBHk40K0w6fL+BlpK6TpxzbT62WOA0mrCns+mcx4TWYwhG+E0P2AHqQKRk4vZPX93P5+OpVWv4YpmkplhsPYV2i9nqW8j6rVRGa2LB+Ws1+/nO7158cjJ1PZa9qTVr/eKjeyPfehVZvv3zQfreR13brmB/rRKRPWdDKznvNPdm5i5JK5bLNe7HTLk/22/dLOX08fZrWzvfr8U5Wb5Xn/pjQp3Rwnm2L+PMmdGYtBI9/PtTruUeWsYh4fcHHsZPebrVbnMjkdnOXmJWa5vDIpGLR79dJtnJjNfI92993hXj1TGxkPRzeF/mPr4OrAKdDelZhmZ5lrN5Xu5/I37efUBW0V0xeOZzafM06tUu9mZr2z1NzZK/CLQuFhMSt1F42rtluqCi/b158qk2S+t996rNjXrZfjst6monBq3xidk6Sx/yndGFmXjZfs5cl5i5pPjVySn+T08VlrWq+0reTLpWg83xTb49MD51m0G/X6sb3njGvPXXNvQJ+zpY8fUWuRVOt9+gqQBAAVcbxZXVFV/+oic/pwkWt1m+7NQz91WkmlWle155Or+kPrYeKeNU6nrZdetp+5tE4fJhkkIcyyvk9AyU/owIL9xD1I8WT9CP9hbmAOTTQlFpZ2RLkUJnHYR6WakPvYQ3PkqTo2QZputPY0TIFo6ZliHKkIWtxR6VZQgAzhgUEA4RkJcAwwa+rZMk9ZwTF3Pxmkgad8rlW4bTMMfyL5CS4NrjU1YNYc2RDzNGpr/qwadUEWAw9vQvE3ZpovBK1Z1SAWaTTpUm2WPEhl91MruqicfiwNoFLtTKEui5/1PpY85En+mkKFqFOBv6tsyuPVykeoYk38S/Upw79AM2onyMvfZx1LxfhCxqJ9PjahNg7hxxQB8sgg/Tuhx8gN8qlMLh/7CkTCuLJxAD0q1PiRRoJTMN4qbH4f2F7FtVijWTovdGlpVOhnakdunT/wSbn69OkiaV7Xs4+T1Etqj5144vG61ZnUxqWhk801Fkb9ZLFXbmW8m3Ixp88H3f6xWXTaTqXdNsYH+XTqkj3O2tWHsadnDuyz8/5j9+jsOVVsNo4M58CwctPBuJIeZtJHlcdWuezUO6Xc5cXFk5E/a10KnfHr7kO1maLHdNzunz5YLUucebTZu2GnF89X5YVx4rXzT/1G9rF0XDuvvPRvBk+LvlfuLazeVckZPs4vc8ZoftyojqqT7kl5ctErnlx6WUcIfa98Tdlz3sof6eWqeT4qzJ+Oq+lG1rrZK9OG05rYg+fsQ6qb6ZlPo71Pz/PusHA+dUsezZ8VW4V68QCEXDxu7Yl+vdvLFlolw7q68ZL6Ym+eqRqfLo3KCBBpDZB+HE9W4ORnuEDUA95jjGiOQXUpw3QmlcE/q77SxnwLLIuFKdeqCyRiPy1NCHOZ1zzY9iyLDtAxVGqy6dFvpVJrwJ86KB4Ui8N0lh4McwYtHGRyxWI+XUzvHxQGdFCUUALZF3uNCmZ7U1wpbJ7+dt4+a7RrnQ7crTdPm51PNZynXmqewI+NVcPzNeLUDN9CBKWYCCRIGa2Pg7HExpRwBKqULZ6o5UnafSbWaI0I+R2i+KrMJJdKbVpGRS4dkZrjAHJqkC1jGQExSS1IhuIfQG6pyATKTOMn2ovBXIhbFSiyvg/5UNTI5UATKWSSZLmioJJphPcpRkw1ZBAZZLvEivWAJBJpqFyNsDqo+MygKh2qT2Cs98Sgnm1CfxJ0gaAjI9Ab07ICo+C4xUxumM9RmjnIpQv7g+KQZrOp4n5RGu0UDICOlGj8uanj0MXG1A2sV02dWFwHjbyAQBxGQfaSADk5dDFdNhXf14Ec4x3yRwdVbUM2fXplYQi1HilXzkmuQCywa0/ep6M1Idhar7MBBcC5GvjMMUem/S2vrdbqpd5JF+60axe9Wgd+4VgbzopL9baBZgmkgi2M1ZpkwMCcQvbGLBAHgzrqgz/qB2AIiu5oQ1NdiQWULlOwrSH1LKhAP/izv9IjOvSylA1cSfoNVNE7ZoIl4pDVwT2o8CFlGVDMBrnKGj9A3sVmrnbiS/IDpH3UYM5ugpQMw0QmqUUkTgjov8D0kBoGuq4aYOiBKzO5Ss49l9jcNXW2qoulKNeBOcCzk6hS0DmA8vfkza4HxEk2o14YWotPoq8foFlJbpW6bkRoUqQL26U6Ltlb1gLE6DggYQKpKjFdQXw4kkk5AI8dtAsRKwrTEu5aipiqy+UznXriHX53jusgmmQtfPDEfOeTSxrhqu5STT4i+cFXLaKoVqG6AscnUE1YxtZ3t7679d13+u76wyDt8p/K1Ce9mfr07GCzEZjYSH0caT02Jys7kr4i47i/56dIR1ddf2tOLqTOcOntJ+ZHKpRvEF8K9aHuD4LiNgj9S10ggVKOioMhIBEzDiXdS4ojWWJ2c7Y6dwYmGKj9SoqI+9HhSrDj2bZcCRZxYnAm7F9cMqZPbLk3HW4+amqtYptJbjPJbTTaRqN/TTTaZpJb39367j/Td7+ZSa6u4fl5kvCmU+oslKX5z+XLXgQaLN/7CV0uXNiLZis4GAlzrNhq5hAbZNKD9LCgs5xBc0Y+Wxxm9HyG7hfShfQglynEorH+dunHoZOt+lRE30qPUsSQxD1BHufZYFzC5dxYXf7zcPt2iLAm30UL8maQOYj0c5g7ZoqbuWOXc3wVcxFkSGIlh7Qj70YBpkHbKbZ1grbQgJIR4KKNO2wml2/SueaUwSjyjTXLnJrSeeXuLnOdhVYausCKcpTAyMJZTFu3PKBQIoHF5Rs4YFgmMMmGmPPBCDKDHQE6/8Ts1FfRH8rkSRs5PkGO5esuDB09zNz3X1vfbQLxDmJERyn4jYVeVe3g64E2FAQKs8K8c5ufb/PzbYzfxvh/R4zf5udb39367j/Td38gP/ezobfzc2jw7vwc2iZSJMyl6mhcf3maLl3Fp0CaN+G67jlyuTnIwWVeAaaEBM24kCBC3TFcrbzUj6+ZyHxQkeI5FrQI3ij7AhoCzXxN0JmZCF5fsvlcvlY2ALG8gjjqbTi0FmwgT1apCRJSpo6JZqswTg6uJCy5QAMN3lz75sg2nUrVybdj1TBxPN/im5C8DSTOoH74RcjWCWkyG/wBXz3H+vrHeVEDvcHLa+L75mzQngClaywiC59RXeo0gtRXD+ipKIDCI1dw73O0TQcTckXhRstlkMEiLrNBkDzDlSFlRh2oFtS+xs7RVXc3chxNHf9hJtYN4EjnwfmzUuT8mToA5XBvNJbMlVZ2UdCtCB6twjeYO4yR28i7iqQNgC3FXlo5pPV7D3ftyjA4Dd6l9F+nT9zZGqmaiE4mhnNs47Moy7+/6FzdGhVKtLfqQBeJHOiS0vqTjre9IgmfjtW9Lz3Q2p90ug9f6r+SL2+udiMK0oiAEGkZpEl0eeTqv4Sg6aCr3I488LTfTZZ8Y1STHqFlUhGSNDWlZmqQMUr6TsAxbGVMdIARWyYsHHI521Buey81C7hwr06MrfAsb99CYMWWBtd/4EDCGs04oYYTagonhE+/iltoWODbyIPEAWUAlaX+JRL4hEawUY31KvLL4ZOyD4YPHUiVo4jZobo4XIKg/4vIB9g6bANQjQl3uBsI18QfC4PXirCCpYJ1CW7Sa3GImWtyU/SGS1UYR/9u/CLHpeWKypltLX42Sr+BJH8f3P0/Id4Waf6NSOOnwLgy2V4eiqr93Lfxt+eD/qTzQf/4t/HjMQQ6afB+lRqF17JfTWyuLcuD4XhaHp7KKCHrPKii1TcOMH+ODjSzqIt4KuOJPjaZXJWaMepiZRJHTONTGQNmDsfAw4QaaORAGwgYAiomOjAt+VmL7nJmKqFalT2IKPJspydL4+VnDxLkSh7LAsHgIgG++QPPHri/WtABTDiX3xWoBjAD6b5/Rgkjgjcl1CXfwyLDFLqnQqauji4pFrgsOsJeQfxAkEMWErJcdqbibIgbHqbOIpDznbkAcYS/2wGiRy1iDYmVeMhIm1kSE7HdalH5vbEB57Qxs2ZoJGDiDE8FLGdoNbsbI8JgtrK+BHdGSb+TSGJbGASLd2U+2UQ6kdJkMYsn7KDqn1I7MvgbXwRYN8Mvy32e7edRtp9H+YFsavt5lO3nUbafR9l+HmX7eZTt51G2n0fZfh7lb/Z5FH8pDXWTlGrCNNlT+zZqc+w2trI59jkeG+PeGdz/8gW3e3G36CvelqiN2y3LjSC5+QId5Lav3J0Bo8PqUyXTWnchVwT9fcXNF6hwf0r1UFvJ32z7ObK9d36Gm+qxgf/Vl6naqXToHG7i/x/G7uBfuOAzVbLg4Wy8/yUW7PtDGzUu/vM/rWyhug== +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/set-mfa-duo-config.api.mdx b/docs/api/beta/set-mfa-duo-config.api.mdx new file mode 100644 index 000000000..76443db0b --- /dev/null +++ b/docs/api/beta/set-mfa-duo-config.api.mdx @@ -0,0 +1,91 @@ +--- +id: set-mfa-duo-config +sidebar_label: Set Duo MFA configuration +hide_title: true +hide_table_of_contents: true +api: eJztW21z07gW/isa3w8LTJ20aUu3/XInfWG3QLelLwu7pXNXsZVEYEtGtimh0/9+nyPJjp0EyhZm2d0JzHQcWzrv59E5snwT6EwYXkitDuNgJ8hFcfSkv1/qPa2GchSsBAUf5cHOZYDbzN0s3fjgaiWIRR4ZmdmfO8H5WOasf3LIQCVnxViwqDmB6SHjioE4I2KpKMY67rA+K/Rbodi1LMbs+PSn//X3jw5/YbzEYyOLCQNRI96V0ogYQ1nEkwTEHasOJMxFVNJASHkTXOTCQMxCfCj6oECSy1jtpEMetoTZSbniIxFc3UINIi/yYlfHIHITVNyCncKUYiWIiJ4q6BHPskRGlkL3TU5a3wR5NBYpp6tikgnYQQ/eiKiAZJkh6xZS5PQUMhxZnRtD88JIRWZWZZLwQSIqnm3LHg25txdTPBUYLz7wNKPhQVzq8FoMglvcVESiSX+gdSK4CmYJHg4bPiAL+6kdO3LIywTqDnmSiwYrkgxcxjov/rwK5wgH+Oa9MIwIWD2YNuzwhPE4NiLPKT4oaEgwWO69jIXptFT1V51Ip6QujyJMeyYm95UmMqJgb8WEDSEIBRy8bL2rRszHRE4h93mp3l2v9dZ/W3+R9Dcv3unotyy+WDcHbz+aZ739je2tCYmKWSBdTPoF5BuUhfjzIh/bC550GAnvzOcMxiuiVo8UMUoKHHqWv+hrVrG/WxlEskxIYpctJ60IbgvUJ1YubeFB6aTzKc+moW+FIqYj+R5p3gi7kPnYJRFmc2fWGFMWTZncs1p8JONbCgf45OC0KCa/f1jbi5MXE9H79boY5G/M+s/P4niysduXe6/eRJsfwEi6GS/gxJcHG5unj89/2/pxe/X3V3u/Bre3sAQMZ02DJJwC422LayO163xspKOT0uVNcH193WkGciuO7w6mhbHk3bbYa94ka713UPA0iS5+fvk0lUfvJnuvDtfL4ydbB3z/6fkgFsfZ44Pe7t0mIaMgYTOtcseht7o6Hx7k6C/A/2CJr0t8XeLrEl//Inx9ZP99DY46Cl+IkxuLoHEvkWDNDoyB60J2KorSKFS30sWbTw02QD1K2CHVe57IbwmVsSig556OF+ZJW9gnUolwZLgkCYUVOcJEH9+UCak2gjmSVcrYce3IhyU6a2yXx9DX6bfnlaEYMDx6C1qHC8G7LdCFkpjPqilIvjoFFrAVW4IPHq9u9zaGjzc47/24sba1Odge8vX11e3N7W3iniI80AzkDd7cGD6ZY/2TUMLIiCUaXYj8CIMYwWF7K4BlTlFRiDS/2weWxhfYn9DIja3V9PIy6nJWGGe7eydsY4slXI1Ke5+PZoygwouzuaSH5o7wsZEjqRaJIlSZUg+1f/Ckf/H8HHdOD15cHJzhimjNtYB9hWiNKSwhKmJhDHAspgpc8xzLQgJzYClkjzzVR1CIq7w5ULpf+SSHMZlfMTHDc18wo0maDY1OW6kUuZaQPZAd0VlhA7qX8iIaswHPMQEupOGP+oCKrAife0s+YmPBgeEP0aZOIRjZCKKYPwEhwmZKXUdgWCKVhQVtXWIR1ljvRNsXU1POQnAFhM+bTqHkgOR3x0k/KkoIZ9VsZmEdLV5E7x/I7CzXlu68YTRr0okqeESrdpJMYEZjYGEGtGQSa7eHI3JXDuBR1bgasZr4buHuyAmzX2j7LOJl/gV5d5IAfkKrWv3gvfDJZ0sIv9o2V0qPSH5JtpP9qNpdVeKzoRRJvMzdZe4uc/cLc3f24alvCP1TW/qszZc+F8pv7NHiOVf6GBs9Sle7fx9d4+gcuULtjC+Rnr4899uG1Ft9yGi77hvWR24pX1SRe3+4+wMqP2pntXxBAlo7Og2GQCIR71i5pxK7ItGaan2e2xNtBhIBqhaUiEBNwya6ZBwmM6VSJAnPV1isRa5+KNiYAx9d4esQ0PagcZhpqYplJbmsJJer0XI1+vesRstKcpm7y9z9Z+buZyvJWiqbLb5Oyss05WbiIs0/t28XGAaw6tUEq1POumq2WiFirK6xgnblEAx6a4O14VYkNmK+ET9e3x72osc9vrm1trU22OhtBc21/nKax3WStXOq4W/nx+Z+fakQXHmhddze/oN5jRgSrBH01HUzbA6TXtW1Y297vnY815odcTWpKqS8VUOqqY0I0zA2pbH1ljwGcL+dDKiSkItCSaYCVAyChiUylTZ5SQvQNZOwPyzo1YNNlCrIai5SRUkJCS0SJJqqZo3AklBSDKnmAwVbwY6Azt/ylZBz0VdV8uyUNH5OGrODD5EQlOh15b65aH/3EMIbwogz5+BPbPS6bocrBAAaAodZdd25rM+X9flyjV+u8f+ONX5Zny9zd5m7/8zc/RP1ua+GPl2fY8AX1+cY21lldS31xB6a+avLdJsqXgIb3kxHUWnsdnNVg9u6wp9OyEqLIZyOngbddMi7/rxCN6pO1Lqq38lTmgTjxkWR5Tvd7g3cBPfcdngmO9XxBKWv6RxDdwDbLIAdOh/gUowG+OO3xKBjDWskxa4DOkvcmdmfQApymNtuCX+WcnUYZqJLQJsls8IQ5z6O7G2ImKGJ+CG3ozs2bub0g14XJrn9el0coU/ossh8n+WG8QySzqhIKlxNjxefUcXtuM8dMp6uItSl9eaYHdOwHtsV3KAdcC8uHjx9ef6QjajOtHle5lTiCkmNATLlBCFicaxfbeLTJLu0GF2Oxlbwfus1CeUNGyZQmL1WZ0Kwy+YZpVMgsjVpv3EQS6urB5V3YvFeJLT2daaWpMCTserCQl3emvfQHYaihkAqXKb2bue1Ctm+JPiRtF7TGK+i7e/YZVbpxRt63VeI/1TUQkcttNTyhzNSONNeRu7YTYTkJRI8ya217s3c0Qsb9Kh7wh2iOisDWcLL0X65FVVeu7ccLXoh0WvL8Vq9HEssou1p1SmxHGtgErNDFo21zsV/GaPQoTS4HJXIonuLdU1MQ5sRYW+1IVLoWIYyRElo5XuOxFAumPiAlmRbkWgUayp2KfmH9Sxy/g80zDH7o6WzvX2JlZNGxjrK7y0zMQyJYegwIPfyu4WJAgu5TTpYHHABsDf1v0UCL2gD9xythahuyXftHFoaIojqDptlO+7HzhTg/BWzD2h0PQYwTBV1/bqPPpHwtGh1ahmr2guYteC8vInGojhjNydvvRdFC+XfTV/SuD/dMjlWyeRbo/QnkOTvg7vfCfGWSPNvRBpf49LW4+n0S6mD+x3P/R6fPnyz08p4jpyztvcdUTPTd33ROr+PSRvtY4G/eGoBy/YU6Njc8W4q5ZqEsoQXlNoW2qKxFHYHJBO8IIuuUHrp1MJRZjQZEH2uJTQyGAPsylGY84FMQM/u0VecuUUNV11TcNPvvLRtmP20boyOWnTYSzSlKkJsUkNKp0zw7I32nekZzH1C0c32q4hH5ZmmpaID8BC7TBlHXt2RFrHMo9KhNzynRGULbevfelYFZZRvpII9yi5Mmh8PaXMdfXsj+u/gheDP/c46TE9etB97oOurFTkViU1PGtfuXe6ijZQLxyLJqCXG0oMqVDQ4HB2ez1EEMZVDr0h0tBl1/aS8S2NBhHpEFz7rnbXOamh7JtzPkEdo4hvEz0RRf1XT+uJmNhBvpm8VvtfHmn4Fptapm9FeH6lUulbOdc2XBCckeQ0kvnO+qjDkMri5oQ0haiVv6TYwiXYbLq+mXSL9om9p7MaQbbVdYvs3EeH5xJYUfudh/hULNa9uhtts+uzYq8YGwMkFeXrgPyVN3VaG4de4SX93gtf4jx86c3FG35vS/Zug2hjEGEe2Kt0WVS7+grS8vf0/2APb7g== +sidebar_class_name: "put api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 Duo MFA configuration' (set-mfa-duo-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Set Duo MFA configuration

+ + + + + +This API sets the configuration of an Duo MFA method. A token with ORG_ADMIN authority is required to call this API. + +## Request + +

Body

required
    configProperties objectnullable
    + +A map with additional config properties for the given MFA method - duo-web. + +
+ +MFA configuration of an Duo MFA method. + +
Schema
    configProperties objectnullable
    + +A map with additional config properties for the given MFA method - duo-web. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/set-mfa-okta-config.api.mdx b/docs/api/beta/set-mfa-okta-config.api.mdx new file mode 100644 index 000000000..9deb42b09 --- /dev/null +++ b/docs/api/beta/set-mfa-okta-config.api.mdx @@ -0,0 +1,83 @@ +--- +id: set-mfa-okta-config +sidebar_label: Set Okta MFA configuration +hide_title: true +hide_table_of_contents: true +api: eJztW+tz07gW/1c0vh8WmDpp00K3/XInlLLTXbrt9jEMUzoXxVYSUVsykk0Jnf7v93ckObGb9EGX2QcTmIFEPjo671fkq0gXwvBSarWXRtuRFeX+6/7BRcl3tBrKUbQSlXxko+2zCOvML1Z+Q3S+EqXCJkYW7ut2dDKWlvUP9xjQWFaOBUuaG5geMq4YYWeELRflWKcd1melvhCKXcpyzA6Ofvlf/9X+3u+MV3hsZDlhwGrEp0oakQKUJTzLgN2f1QGJViQVAYLMq+jUCgM6S/Gl7AMDkS5TtZ0PedyiZjvnio9EdH4NPgi9sOVLnQLJVVSfFm2XphIrUUL4VEmPeFFkMnEYuh8tsX0V2WQsck6fykkhIAg9+CiSEpQVhuRbSmHpKWjYdzw3QG1ppCI5qyrL+CAT9Zlt0e4PeZAXUzwXgBdfeF5k7jQINP4sjBxOoms8UISmecZA60xwFd1Eujds6IGkHLZ2HOSQVxlYHvLMisZxRB1OGWtbfjsbJ7AJ6AfEMkLgeGHasL1DxtPUCGvJSMhyiDBI77NMhem02A2fOonOiV2eJNj2m5g8lprEiJJdiAkbghAyOmjaaViNWLALS2Z3N1WfLtd66+/W/8j6z08/6eRdkZ6um92Lr+a33quNrU2nGewC6nLSL0HfoCrFt5N84D7wrMOIeC8+LzBeI3V85LBTYmAvHPm7vmT18fczA2uWWXQNkgHvVmB/jahw3QBumXXLFhum6FnxNhNdXl52mkps6TBKLzY3f75LkAvlOCWZiIYdFVpZ73S91VX674Y7gfWHxKZo6ftL31/6/l/m+8/cn3cP8PGNRW69k0nsYrvGQAwxOxJlZRSKBunFFDTKBkjzZPJSfeaZ/J5enooSJO7odKF628S+lkrEI8MlUSgcyQk2BrWQAnNtBPMoa007uLbCIInOGnvJU/Dr+dsJzJAODU8ugGtvYdxpE3SqJPazegtsxpnTLceKTcEHL1a3ehvDFxuc937eWNt8Ptga8vX11a3nW1t0eg7NosayjbO5MXwyd/QvQsFuEpZpFHfyKwRiBIfsHQHucDKJUuT2fh04HA+QPzmRh52yGehlVDyuMM5e7hyyjU2WcTWq3Dof3RCCik+P5xwXnHvEB0aOpFpEilBVTqXpq93X/dM3J1g52v3jdPcYnwjXXGndV7DWlMwSpMIWxvDpcsbAJbeIZhnEgQjOngWsz8AQV7YJKP03O7EQJguBHjvC6Qt2NFGzodF5y5USX2mzJ7IjOitsQGs5L5MxG3CLDVAhgT/rw8uLMn4TJPmMjQVH6HmK6j9NpY9rDN4IpNg/ASJKCuS6HsGwgisL1yLoCrlDI0yLti5morwZRutA9qapFHIOUH6/nfSTsgJxjs2mF06tJZAY9AOaveTa1J00hOZEOlElTyjZZNkEYjQGEmYIdEwi5YRwROqyCDyqhptGrGZ8duFu3xPzqtTuWcIr+wC/O8wQfmLH2vTBZxGcz2W+kCRIG7WaQkQKmcRtDlBTddWOz4ZSZOnSd5e+u/TdB/ruzYdHoZkJT13pszZf+pyqMC+h5DlX+hhnPUrXQ5WvvunxilyhKjyUSL++PQnTGGoJvhQ0BfmO9ZFP5XPE96f68OsDKj+mymrpggh0cvQcDBGJRLrt6J5R7ATlRbU+f9prbQYSBqoWlIiImoZNdMU4RGYqpYgSbldYqoVVP5VszBEffc3qI6BrndK40FKVy0pyWUkus9EyG/042WhZSS59d+m7/07fvbOSnFLlvCXUSbbKc24m3tLCczcZZwBg9VidTV3OqepmtULI2LTGitqVQzTorQ3WhpuJ2Ej5RvpifWvYS170+PPNtc21wUZvM2rm+rOZH0+drO1TDX17PTbHzJWCcdlS67Q9/oN4jRhSWKPQM62bIXOI9HxaO/a25mvHE63ZPleTukKyrRpSzWREMQ2wOcFOJ8kA4GyEuKgYQpUEXWRKMhfAYmA0LJO5dM5LXACvmcT9YUkTc+cotZFNT5EqySpQ6CJBpqlq1jAsCSbFkGo+YHAV7AjR+Xv+muFV9KcqeXZEHL8hjtnul0QIcvRp5f580Xx3D8QbihHHXsG3DHp9t8MVDAANgY9Z07pzWZ8v6/Nljl/m+B8jxy/r86XvLn333+m731Cfh2ro9vocAA+uzwHbWWXTWuq1u+vxV5fpzlUCBc68mU6Syrhxc12Du7oiXC4oKhdDON3oi7r5kHcb1w26SX1b0Vf+nqbKZIAdl2Vht7vdK6gKKrru8EJ26tsFSl/SNYTuAPJZEHrojoB3MwIIVxvpgI4TrpFkvz7YOeRe1OHyTGQhcjcWvhNzfY9joiuEN4dmhcHWgy25ZZBYoJH4yTrojrOdOf7A16nJrv88Lx7RLbwsEt+dpwGegdIbLBIL57Obm8dUdfvT5+5vzjIJdWq9ucMOCKzHXgpu0BL4Hy+e/Pr25CkbUa3pfL2yVOYKSc0BvOUQJuJiWb8e5NMml16MrkZjR3i/9VMJ+Q4bZmCYvVfHQrCz5vWaI0RlJ9J+4w6RVudPau2k4rPIKP91ZpIkw5Op6kJCXd7a99Tf46GmQCp8zN1q572K2StJIUhSziaYwKLr8dhZUfPFG3w9loj/1Nhijy122OzTG1R40Z4l/upNAgcmFDyzTlqPPtzjixv4qIPCCmG9SQNJItDR/oErqbX2aDpa+GLC16bjvXo7lkik7W31vTqLPJilbI8lY62t+C9jZDrkBmejCl70aLIu6dDYeUTcW22QFPsjYxmjLHT0vYFjKG9MfEBp2VUlGgWbSr1LfnCahc9/QNOcsg8tnt3yGbInQaY6sY+mmQ6M6cDYxwAb6PfJiQwLvk08uDjgDWBnpn8XCQKhjbjncS2M6g591+2h1JCAVIfFFtv+y/YswIVPzD0g6CkMwjBV1dOf/Oj2ecBFGaolrHoecFOC8/RmGonxhtw8vdN5FCXLfxq/xHF/NjY5UNnke0fpWyLJPyfu/k0RbxlpfsRIE+pcGj8ezV5C2X38Ddvbb9fee035zlu3eAiXcKIJTUvTEV+GmnJ+1Eiz8LHAv3jq4okr+9FU+fd9qNJqIioyXpLnuciTjKVwQ4pC8JKYXSHr17mLFoXRxBtaUYdoZACD0GJRN/OBzIDPjdHrk7lzal/8ku3Rd1u5Tsm9VDRG0ys67C36RpXAdKhnpIsgePZRh+bxGJI4JONjr2qDRGGY55Wiq9Ugu8oZh9nfY7WptEnlgysaFyVqWWhXnk531ZGG3IFY6LjuyeT2YEjzb7TWDeO85yzYpg3Db4ietOheJUBjNmXkSGTOewiu3VrchxseEY9FVpCRIDOgSBSNE/b3TuYwApmy4CsRHW1G3bDJdgkWSKiF8+az3lnrrMaupcF6ARNHn91AfizK2UsbrTc6blri1Wzy/7e9qBZSJPU23YIGcsRU5Xst39qekb8Dsu3pob09r538LLq6oskN9XvXtIzAQWOBs/NZK0ff6F0NN8Fx/fCFiwLhJ4P4ZOLyfhgRzP8WQh2m3+GnQnfCnjc69cNT0vcgvEqX+5mD4ZdYpH+3o/f4SywW3trofTtav4rqCR5gPNq6vlpUXoQPxOX19f8BMA7fZQ== +sidebar_class_name: "put api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 Okta MFA configuration' (set-mfa-okta-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Set Okta MFA configuration

+ + + + + +This API sets the configuration of an Okta MFA method. A token with ORG_ADMIN authority is required to call this API. + +## Request + +

Body

required
+ +MFA configuration of an Okta MFA method. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/set-tag-to-object.api.mdx b/docs/api/beta/set-tag-to-object.api.mdx new file mode 100644 index 000000000..79ed8a901 --- /dev/null +++ b/docs/api/beta/set-tag-to-object.api.mdx @@ -0,0 +1,85 @@ +--- +id: set-tag-to-object +sidebar_label: Add Tag to Object +hide_title: true +hide_table_of_contents: true +api: eJztW21vGzcS/iuE7kObwJJt2bFjfzkostNT4cQ+W0ZQOEZL7VIS011SJXeT6Az/93tmyF1pLTnJpbm7thACOFrucPjMK2co6q5lZ8rJQlszSFvHLa+KoZwM7fnonUqK1hYGktLpYt46vrlrXXvl+tYU6mPRK4spxlo6NceFnBzn0siJat3e32618OzpHThNVCoCL9/Cm1T5xOkZLYfFhlPthUxT/BGYIworpBGWyTtvzVvTM3MhsZAyhU5kAV6F/VUZkcu5GClReh4RicwyURCz3sWgA9BO/VYqX7ywKXDf8aN2CvIVrlRbrYREMAW9krNZRqwBaPudJ1R3LZ9MVS7pUzGfKeC0lTJmjrRVaOXpbRi+VOPPk4a3NZUvnDYTUClT5qSpXr9/enX188Xl+cvB2Sle9C4uzgb93nBw/hpP/d6ri97gB/p4+no4GJ6dvsL/eBqc8PNP+Hh5zhOvzk9+vjjH3J/44fqyf0qKVx9lPsto7aUpTWucDM8F47vfglXXoW3SD06EHUPtKlqMLPFhqpNpMIVTY+WUSZRgHUMPyyi6ydHu853nzw6eJ8+6R8nBzi4+JfJgfLST7O7t7hEII3NWmimzTI5oWjDfp2H9o4Qrtp2SKc0RqfazDO5CzH4H3jc6y7TMBf4nL7m/v6/cvFaTdE7OMUkXKver6rt/CPRMjlTmCcWoWjONIVBHXw3gpvXi+ueXg9e9132y8kV/gFAjDLpgfCHU4rx7hueUn1njgwN2d3bpvyaCPrSEoOoQtv2dnTUEwGQKceqcdaItLlVROgOUOugxhpkYIc4EVKjNe5nplCLwG4VYqgqps75N10ZPE+xLbVR74qQmhIohJ5gowPG9TjFD5NbBIZhl5QpM12mYGpro7IoXMoW8Qb5+FIb07WTyK3gNviBAro3GfFFNEToVY4B6ZFl1qOToYOeouz8+2Jey+3x/9/DZ6Ggs9/Z2jp4dHdHqufIeWXad1zWX/kEZ5XQiMovcqP8FhcDU0D0D4MXXOOojNmAeX6D/IeQKtLWYEa+gDWMLSf5F/0LsH4pMmknJ43LyQAmmfX2FkWbIQ/LA+NzpiTafSqQnpy9712eUGi9P/3l9eoVPxGtl6+kZeGtKbgmo8IWp/cCIowAfpBdeZVAHwkM8jVyfQiBp/DKhDk9+7qFM+NZYllmBGXH1NTOWWYuxs3kjlJKwu4rvdUd1tpAZMJbLAklqJGm3gwmJ/GkvSdSsaJ9FTT4VUyQ85Z50RC9NNQkpM4FoBNNqt8RGS6EbGIxLhDLA6GJqy0IYiw1WNW2xUOVKAo5J52zZKBQcQP55P+klRQlwLOZyFNbeEiFG+wBz0FwT3XBJaazSuSlkQmVCls2hRucoxY8gmy68iOmIzOWReExFV2es5VzK6e5VAHNSWH6XyNJ/QdxdZEg/bRatfvFexeDjXB+yEVujMlPMSHhJYvPkSFWbqwp8MdYqSzexu4ndTex+Yew+fHkZy6L4lkufNbXRtaHGwzrePFdKH8feY6yoiLi8iYbcElBILJF+fDOMPQvo1ccZtSHfsD4KW/kK+F5tjzA+ovKjNlbDFgSQ9RgkGCMTqfSYcS8Qs6KCqvZWV3tp3UjDQc2aEhFZ04m5LYWEylxpDCGRfkukVnnzXSGmEvlRIiK8DxmQVjVpe2a1KTaV5KaS3OxGm93or7MbbSrJTexuYvfPGbufrCRrVBwtsU7yZZ5LNw+eFt+TtFKAQFQHdKIOOTbVw2qFmIm6xmo1K4fWqLs72h0fJmo/lfvpwd7RuJscdOWzw93D3dF+97C1vNffLOK4DrJmTC3ZO9iRVYwi7j3quNLAuXxhbdo8/oN6nRpTWuPzy6puhs6h0tu6duwerdaOQ2vFK2nmVYXkGzWkWeiIchpoc6J1FS0IpJggLxqBVKWBi1xJ5wpcHJxGZDrXHLwkBfi6ebs3LiBKCJTKyepVtEmyEgg5E2TW8HcSH6SGkGpMNR84cAU7QXb+htVpNNHvquTFJUl8RhKL04+JUhTodeX+bN357gDgHeWIq2DgRw56Q7cjDRwADUHIWXXduanPN/X5Zo/f7PF/jT1+U59vYncTu3/O2P0P6vNYDT1en4Pgi+tz0HZ2RF1LvSTn+p+X6RwqEQG7t7BJUjo+bq5qcK4r4EoEaGY9JxFJ13ha2wXfH2jbeFWH7v1QRRjAlC4DzbQoZv54e/sONoJt7jtypjtIXTBTMTf2Qyex+fYIilmTc+hyQIgvIqBrOrGn6LBWnSbHDVmOmQcdsxzkotA1nwd/knN1w2NuS+Q1ZrNFF1qiE/EwIM7QQXznmbrDTrMiH+S6dtn975clMHpElnXq++RqoBdA+kBEEuF2cU3risrtsPrKZa3FFkItWndlsXMi64oXSjr0AuFbi+9/fDN8IiZUZHKQl57qW6WpK0CYXMBFOIn1qhN8msT7irPlZMrAe43vSChoxDiDwOKtuVJK3AyiEl4ju18iHbNKe4trX5h1+31lnVS9VxltfJ2FJsnxdGq2oaFt2Zj3hDc57ga0wcecRztvTVucaMo9mjZrookicnMnbmaVXHJJrq8F8beKWztwazM3/+QBiqDamyTcuUkQucRCZp619dWLB37tJX7UOmGEuD7EQJqIOJrfbCWV1b4aR4Nfm/g1cbw1b/gyVnOaCAlLeGyAWSoGIpla69XfhSDXoTC4mZSIoq+GxTfA2hwR7e7OEqR2WLKt26gHGd8ZAsMEZ5Ij2o+5HLGo1EwaQvIXtixi/hd0y6n4pSEzD99g2yTK1Cb+qzHTgm1asB1ygI/4w65EjoXYJhk4DwQH6C/sz5kgAl3Ke4HX2qzO7Ld5Dm0NCaAyFz87Dg/HiwQXPwl+QdQ1DdIwldP1d310azPyoq2poazqIOChBlfxZhY74gO9Bbz1QRTtkn80eUni3uK85Nxk82+dpR/JJH+cvPt/ynibTPNXzDSxwKVzx8vF9e/TqhVZf1176TI0XXn+/LXk6lbyyoXgxa33NRd1wR1RwOvGBmU59l7EMnL1WJHOvacKf/GWUwiX+GiguCXk4mqZ0SyTBQUbJ5tkqhUfSMyULKgk3SKHtzkniJmzlJXQdjKjCV8EdtCkRAupM/DjI/NqZclxHOpdcjd69mV9izqZosFVHfEGPaJJ4C3UH9KlD7x7Z2OjeAWHuSB/EyeVD6IWzPPSYDVKF2UuJDz9M46aap+UIZ+iXTSq0oXlirSeVSUXigASocOdksv9+ZjOutFGL/njZ9aCO/p40A3V84304AMLQS5VxgFDdM1u4nO8EQTtqcpm5EHYDFAXqqUVXg2GKxzBzHjIlaiOdZPtOMlvEy2YUNcW3Gevs9vZaXMXg3Fq+NBTLzHvpakYhp9d1BfOGw54tzjc/+/9ViNGIrUp2zM6VCOwZWibQnd603rQnaLfmVL7ijd3d3TiQu3aPQ0j7qmdv7lddGL0BI7h5IXb2V8VdfzxqL89nPO2HVv71e8wqEEMM8Jpzidpb5c67ItzOtdqjeKPUPJwWODkBwzS3+PWW/zDg50F16FfqtA4uv94YASad/XPDeQj5UH8QGLe3/8brdMR/g== +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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
+ +Created. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/set-tags-to-many-objects.api.mdx b/docs/api/beta/set-tags-to-many-objects.api.mdx new file mode 100644 index 000000000..764a83b3e --- /dev/null +++ b/docs/api/beta/set-tags-to-many-objects.api.mdx @@ -0,0 +1,89 @@ +--- +id: set-tags-to-many-objects +sidebar_label: Tag Multiple Objects +hide_title: true +hide_table_of_contents: true +api: eJztW21v2zgS/iuE7sO2he0kTpo0+XJwHLfnRVL7HAfFIg1aWqJtthLlI6Wm3iD//Z4hKVmK3abX7d3tFkaBRhaHw3l9OEPTd0G6EJpnMlX9KDgJjMjGfGbG6QVXy8HkgwgzEzTwOsy1zJbByfVdcGWE7qYqE5+zTp7N8S6QkTrJ+Owk4YrPRHBzf9MI8NnQGPjNRMQKZhiJhAm1XNCiWHI8l4Z1hn3Go8gwmsWylCV5nMlFLFjq5rXeqreqg5GPQrFbmc1pSoN1e6Pxu87ZRf91gw1Gr4rHUW84WA2MBue92vPl1an/eDm4GnXLwVQXLwoKxqFhSqozSKnFv3KpoQwEDHkcs8zL3oKNaFCY7DSNYKa7oKANTjKdi4dKX+aLRaozsHL6sWy5EIZxLVin2+1dXr4bjgYv++e9BtgPz/vdzrg/gITdzsWw03+Fp97rcX983rvA3wbrn9mPvzn9SK2zd8MBpv1WqEgShuQ0lZF0fLGIZWj9vvPBkEh3gQnnIuH0RMJASCcaJi40RUkmhaFR93okpqZCy7XmS5DKTCTmcR5utKQymZZqBiqh8oSCpm4EDFSsgE+FGfBYsQM+FYbAI1kCf1amsB/IFhSD4jNPEF5YuzKl7qOz8cC6JbiHWtEmaev0/TOWThESovTp3MbMVGihQsGszQVFd1Bdvx0e773YffH88EX4vH0cHu7u4Snkh9Pj3XBvf2+fllc82WgulccxnxCbTUH2jxz52NSCR0TDImkWMV8yYvZdkr6RcSx5wvCXQuYegmUys0MuyV2On2GaHbMA8GiEeGXuH0p/zicipkybFALZvHMSt6qCXQenV+9e9l93XnfJ48NuHwjUWCHbVwNtOOy9PsOLi97oVc+h05QDfEBcjj3w85S5kYZDK0paCChU5CQku8bSZNbGRDAFrqyM3WIddrC7y4TWeG/tnuVaYa6cOkfcpnkcERyyKHdpKkpcrPAhRIQsVvCKKInQhLcWI4lafIYsUNpStNhZnSXNMDIGLMSAuJlKAVk143rDVJ19mscfqw7HIA1rYRapMi7B27u79KduuZGDSGbyMBQicittUWmLSltU2qLSfwmVDjYBURd+UxnrWWWbbFTTVTBfyrEJajmyhVSfeCx/JFpFIuMy7qbRxgSqC/tSKtGcaS5JQuefEBMZOH6SEdkwgX2YY1mkkKWrmwyWaO2xUx6xAoe7XhmyoubhR/DqfwOkXCmJ+ayYwmRUBtOGZcWR4JPD3eP2wfTwgPP2i4O9o+eT4ynf3989fn58TKsnwhg0DpsSs770K6GEliGLU9Tf8ncYBEAC21sB7OLfjvaWxzfYf0yZY2lLNb28jHqgBuPstDtkB0cs5mqW2/d89sAIqnl1uQaN0NwxHmg5k19FhLPey87VOW0mo94/r3qXeCJea91URyFaIwpLiIpYmKe3LvWdArfcMCNimAMJxZ55rs+gEFemSijdJ7M0MCbz6IMZfvUNM6qs2VSnSS2VQtcwsieyJVoNoCfeJTwL52zCDbVBypI/66AyWGTNc2/JZ2yOjULop8CnKJKkJI8ZshFMMX9pYTgiiJOOwTRHKguLM2meMZVmMhR1X6xM+XCjKqDkvOoUSg5I/nicdMIsh3BWzWoWltHiRfT+gczOcnXpxhWjWZMuVcZDaIF+cwkzak1b4wS6ycwwD0fkLgPgUQVdiVhVhLRwd+GEKbbDkOfmG/JuGAN+mla1cuCT8MlntwCHRtYbhZs8Ivn9wU72VKW7isRnUyniaJu729zd5u435u7DwZFvv/yoLX321kufK+WPtGjzXCt9tI0elRbnXr/b8sY70h6Q+RLp1zdjfxgHevF5IfUP7ebcVr4mfKf0h3s/sRVk4ayaL0hAa0enwRRIJKITK/dKYmsoZ6r99dVepnoiEaBqQ4kI1NRsmea2VNW5UiQJNw0WpcKoXzI258BHjowwvkKmVVXUXKRSZdtKcltJbnej7W708+xG20pym7vb3P1r5u5XK8lSKpstvk4yeZJwvXSR5sdJW85AwIovAliZctZVD6sVYsbKGiuoVw7BpL032ZseheIg4gfR4f7xtB0etvnzo72jvclB+yio7vXXqzwuk6yeUxV/Oz9aE6OI+4Q6LlcILpOlaVQ//oN5tZgSrBH0lHUzbA6T3pS1Y/t4vXYcpymj79CLCsnUaki1shFhGmgTotUFLQg4mwEXFQNUSchFoSQTAS6aTkljmUibvKQF+OplszPNoIpLlCLIylWkCuMcElokiFOqmlMEloSSYko1HzjYCnYGdP6B1al30R+q5NmIND4njVnvs/viiJWV+/NN57t9CK8JIy6dg79w0Ou6Ha4QAGgIHGaVdee2Pt/W59s9frvH/xx7/LY+3+buNnf/mrn7H9Tnvhr6cn0Ogm+uz0Hb2mVlLfXSXkD4X5fpNlW8BDa8WRqGubbHzUUNbusKhBIJtEiNBRFON1ODnczeCGj6W6Q7kzz+2EQoBnSnlUpDJ1WuYxDPs2xhTnZ27uAsOOm+xReyBQyDv7KlSm9bYZrsTGChDeBDtwRcohGBvc/qFmhZ82pJEezgzjJ3xi7udBgY3R4Mf5VzcUVmmeYAOMumQXeBfDTZ1xBxgVbiF2OpWzZ61vSDXlc6vv/jujhGX9Blk/m+uhroGSR9oCKpcLO6gnxJdbdbfe0i8movoV6tvbbYgMja7FRwjabAfX3x5Nc346dsRtWmzfbcUKErJLUHyJchQsSiWac4yqdJdoPRaT5zl1k6tS9LKHvYNIbC7K26FIJd970RXgPmR8Bla1KaJCwU0KybJ4V3IvFJxLQDtlaWpMCTkdqBhXZ4bd5Tu9vZtkAqPCb2beutarIzSSAkadcmGq+i7fLY9aLQi1f0+l4h/lZwazpuTcvNPH0ghTPtdegu34RIYWLBY2Ot9d2LO37NCj/qofCGuD6UgSzh5ah/xRUWXvtuOWr8msSvLsdb9WYusZXWpzGHXMzM7f2qPgvnaWrE3xmj0KE0uJ7lyKLvFuuWFm3ajGi2dysiNd2STdlEYWjlO0diKBdMfEIbs61LUpRsKnIp+d56Fjn/Hm1zxN7XdLavr7F/EmWUhua7ZaYFm7Rg02GA8fK77YkCC7lNOlgccAHQXfnfIoEXtIJ7jtdGVLfsd+wc2hpCiGq5mMWJ+3CyAjj/xOwAUZc0gGGqq8sv/egnAp4X7VE1YxUnAg8tuC5vnGJrfGA3J295IkXb5Z9NX9K4szo4Gah4+aNR+gtI8ufB3f8T4m2R5mdEGl/p0gHkaPVbo17Rk9SvwF+XWVa5SU73xR+/2V1c7F67WV35Udf61ebazebiei6WRHJYI/kGppqSp766XD92pHPxucD/GLXIYlsANFirC8RVRouYZ5SDFoPCuRT2wGIheEaVaoPyIE0sbix0SmCFttQymmnQAGQMKmg+kTH42SP1YmVu09uVwRSF9l5y7m+np0ggNMCixd6gh1Qhgoj6R7oUgrEPqW8kLxFHQwpDdlaEJkrEJMkV/aoMYucJ40iAR+I3kibMHcyinVSisEVqC9VyVoE5lBikQst2UjoxgymdhaPNroTpI2shSo0/CIfpyYs+MFaKjERsXU509SbjMd7IjeZcxAsKEuwRKBdFZYWL/niNI5gpA71C0Ur1bMdPMjtECybUzLnw2W/ttXabtrnBe2oI0XNXmI/5jF0Uvy9c/cixFoN3q/P/n+YXih4QqF/aWdAxH5knd/2b65evg3q/jEllx4wMn1NvDaK7OzoOohbynl4Di+is4fpm1R3SJzB3x0IWjT4KOo7w30M0x0tbSvhzh/UvWKhpdTPcUdNXaW8q7f9wQIduwcT/CjNxJxma3+Il/X8SvMW/gNDKxS39VJPe3wXFuSBoHN+iZttUsvgHUvP+/t8AeoBL +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + +
    objectRefs object[]
  • Array [
  • ]
+ +Request succeeded. + +
Schema
    objectRefs object[]
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/show-preview-data-source.api.mdx b/docs/api/beta/show-preview-data-source.api.mdx new file mode 100644 index 000000000..4c81e30c7 --- /dev/null +++ b/docs/api/beta/show-preview-data-source.api.mdx @@ -0,0 +1,71 @@ +--- +id: show-preview-data-source +sidebar_label: Preview form definition data source. +hide_title: true +hide_table_of_contents: true +api: eJztXOtz27gR/1cw7IdePKZelmRZX1rHj6k7TuxaymU6lqcHkpCEC0UwBGlb5/H/3l0AfImUJed8TeaqfIgtYLH4LfaBXQjwkxXTmbSGt9ZJImOxIOciWkjrbt8SIYtozEVw4VlDS87Fw3XE7jl7OKUxHYkkcpm1b4U0ogsWswh5PFkBfADqKTA5ZVMecMXgFAh5AO0hjefwu8ekG/EQ+6ARZyReRk0UecS+JjxiMHUcJWzfku6cLag1fLLiZYhTyDjiwQwoH+2ZsM2856vzPu9b7JEuQh97W+afXfNf+m8zw0xIny94nEr2NWHRsiLaJZJMgklwEcRsxiIiQ+by6RKQk3jOyII+8kWyIEGycKBXTEnEXBF5ksQCfo2TKCA8IJRIGOEzcnx9QVzq+w0yhtEypoFHI4/IZRDTR6LndpiHY25/PlDko5ToRPg+c9UKX2dKu/tpHsehHDabHrtnPuq8ISn3Q8GDuOGKRZN7QZOGvJlOZrsZHztX/l9COuMBmEswsyMmEz+W7xog9pTwmHBJAhEb2Tnz9kEg0DcFKqIWESkSybyGVaNorpcOutCqaKyb+l1ogOW7ZMEMbGrY6bXgMw/Szy1UhZrCGrZbZaUqrZRMAylyi5tSX7L6IbmFc18Z/YvqP1dExCwIiJjq/UfSnJakqDg02PO0FXUjkzAUUQzwQAVKgCmwEg/YDQr1wV5hCqIjhojkEDns7d1TP2F7e0Oyx77uk1m8T+TDPki4p7t96jB/fbdMnMt1FHV2Uh8QjJpKcUBNDKzIxFosifo0sawNFpBzymwgVfoLFvAvbEV5Rgpdyf8FUWMInVEeyHhrmRTPskRGQZtkMCPvNBmT8XvhLXG6MmhsRbWjog0hCenSF9RD1G7EaMzAh6crgdtbwjzcJUaMfcsV4LtBjDPQMPS5q/aT5q8Sp3kqiBtGaDsxZ1KhyTeYSh+wnPJZtZ3OZhGbKf7vE/cLi8/RLquyHdfSpdIWuBBHdWv7JmoBiytOY1CNk8RMNlxfJB44a5zIBhC4qIaX9FcPARXKA4+7Zg1KqC90B8KkEDJBH7BVGGpUCQTPIrpbi3uw7lwtDmibx2yhuDLYaLCbujBQwgqC8zMMYtAgEghFEB3u9TBghxx8toCfKs7lLKHv3rRGQjPYw3lqpcY5bRQHV600LxkxGrlzEI49Hquea9MzCSqAVoix8zjrnARFsEXSs0L7JMhlKNJcZK3A577C4V6PVZIWO26EQrpXbPvMfc+FWIvaNKtBo4guV0zA6BOphPMrxOSxol1V+1XWpzUPCZhKRpg3YhjJrxQhUXEWNtvTs4/ji/G/15AZKSEaHZ+cnI1G/7m+uTq/uDxbQ15SCMSvq083MGoNsfZWWIybq7UMcbkmgYJ4efYBfq6hK2hMGaG22FQ4aCrDhwaDDX7D6eFHYRI0y9xrC1w22uqfcjmLRphbF9qh3r8qJqi2DG19MXuMSzFwb0OgM9tN7gra1lOqkLpf6AzbZzyeJ45KWrIUpilDGzcY2fTEAjZInAsFMUn5mRbpVG85eUlyovcHmDPfReqd67TUr0Usci53Gx8bjY/HFyfr6XAb4C744sfx2c3H48v1lFgRRAH1gefZ8c3JP17gqcJLwRc0CGhIZ0EfUEzK1p7RbbT17ypW0WTKJP9j2/ljpzPV841OqGCu50q2plpkKAKpk4AO1KMVu71RZSFaa6g5Yi5Qk4yBWESmZfrWmVh5rkrFf2Pg5emh+SyBO3GWpIk47ByHbD6tHgY8NxGbrbERFnhqEfEsoZTRmWqkbgF0OTUXqvDI8qFaS9PxQIdCyJ9UIlT0kadJOtEEDzAmlikHhhPr2J+Cakin12OHbW/q9tnE2p9YaV1SoGkUaP4OKWEMVuA3TLKxlEIEaDBqtI4jOLTjHrUHrUF30GkPuodur9UedDqHLvM6rN3vH/YnWGqU8fDfYL0ceuR1Xa9z6NE6PEDTKNK8AZ4p4nGreIJYBFD0k1Z72j9yD1gdHkPTyGjeAs8R4GFVPJHHfJ+STpsdDlzW7vVq8GiaRk7zFvrqAx5agwfioCeIN+gNOk6ftQ/r8CiaRk7z+/EcdDv9/qDGfpKI+ZwS6i140IFxgxo8mqaR07yVPXcreN7TyKERJYcdl3bbg6nnVfEYmkZO8xb248D6tNbiYaxNO92DPqvx9xRPTvMW69OD9RnU4Fn6jJF+r+Mdwlyd6UEdHqRpFGhei6en8Qw6OZ6B06es6l/vI+F+Ieyw7/Sgv+t1j2rwIE2jSPNWeKaA5+7ZKhSzqzt1eftQuKubh4Ka7l64WevzHyyiPS5Dny7xV+yEmjoiD3MWwN6mjs3U2R2MFJpXNa3KdxWo72FXkXjShuLbuu61zWGK3QL19zyvbx+0en27e9Ci9gBWzJ66rntw1HOcvttbSYwUbkxr0+WuijYyPal0QFkVDj6KB9Wtu2ABPA6+nkApjeeSS9+cTc2ZH2bnkkRERKtvutx6EVYkSOGhEErrVQl+xuYUvqJBJJICMopHjJAsxFCNKKVkKtLakVvDYrh7dLvdAeySXZe2HdrqMsaOjo7oYHrgeiuwFSaVGb5d4lmfnWw4MzBpzx+QpK7N8jBJhdm6dWnoMWgjisAuHmCy0lGhcN0kwqT2FWnny77ssRjEOBEe23Q2eppTAvAFOB2sSDFapCubRxGzCGcozAc9IPOg9AQej+O1tFnCa3gT5NuwqipZiUbCpX6NxV+q9nQ+tW6QR+vWstUG9qfRhnrbDAPB9XRXEZ/xYN2kutdk0aGAaOX4xuskptPzNE5oiA/ggdrVlGZzZKdn58efLsdbYTOI0ILxMKGCbAyt2VmsGyfUV6cOCAebtArMypdAjNH5uY4RSLQBDc6ztU/T2KcS6PQvzQfmWM9ldh9SO8P4rA6CV2z1he+wSiEyH4tLFAEuwH7hbbL6cUp5qjxW+2x7G5+lSTwXEf9NH3nvPHfnuTvP/e6ee7CN56rcB+x0wVWeKXfOu3PenfN+f+ftbuO86AbqTsxUJMHOY3ceu/PY7+axnaOa5RWCLGiwTGta+SoXLTrKNh6ynWeUfXvlu8ysL52vaA16pYmL3fpS4Yplpl/akRGL7iGtONvCMnYBZBdAvm8AKbv9iniZo69eZEtHkSTgX/G0UR9rchV0cjGPXK91wKaDFuvTbqfHnL7Tbjue47R6h67ndDeJXQw03y68ilC9NcdvPPVaqb1W62xXBuxiwv9vTPghkgrEwcCaeLxUjyI+gYOeoC8+xscJXk6/tWQ4VIfxQ8gyUPg7vJRbe/fipYsdaPkLFs8FvtAAI1KWj08shtZr72FYiBnDiH7HkUQ+MElvmD9BGKFB/NygIc++xgvEg1KVA05vrYJPLQLtBgmUD+sJEPQ9jTh1fBMbFHNtjubGvpXp/0XOqAC0ziWIQDSbfQwJHN9ILHUzQAwhk/urVNQNde+mIh/I9Snyn3+/LJrRGlnqlu/F2YCeANIVEVGEu9zERhjG9ewVQ8tDOx70diqTXSFZh7xnNIINJBZfWEB++ufn8TsyYwFe5meeebXAwDeBhJJrMBGBu46+0WgGqWcBkUhmur49Lh0rq7x06oPAZBKMGCO36eXJjxDlbs5GY7WkOAib9Ta1/fsGWhr3Tr1RWIgI4nqg/R1aG5PAJqc80s8fpKIxIqJ0lNyGqVy0INe3gvhLyi395ldxw5cVJRR6aW9dn+O+48KujSyoL9VqffPkmp9d4GfPIjAcG7muYsCVMDjKXwa4qda+GUeJn438yjgmwec5d+ekPIzoiEbkXCS+Ry6IOxdCsr8RgqaDbnA7S8CLvhnWA05qK4+wO60CJFtPaXM7kUzhuwTHCLQxUUcksd6WBYEg6mmX/EVpFnz+F/UE5peSzKr5FrZ5pPSE+4pHOyuYcUIbJ7R1DJAGv87N0LBwdwMZ9CMJZQAnuf5VJDBAC3FP86qN6op9U43BrcEFqIoLbFz6wzAPcOlbLtWB1BkNhGErvfWP6wafieGFu2RpsdJNe3UFq3h9AWnMyrppvOlYRPHDyYsSH+d5+FXgL986Sq+JJD9O3P1OEW8Xaf6Mkcbk2ljP3uTv2c7SsmT1IVn+dGzdY7FNr7qy91mrD6yKj3iKj0zMowprr+5BQno//1m9/JqKYj1cdNT3JuesxIVPeHY4Z1K9C1bxRh0JANb8m4Yio9CnsaomMDK5cw6GARV1yAAX5K/76B1ioaIJlM8YwqAUVYxm6sVfBMtOfepwH/ipF8jpzFQ5vU6O0Tbxs0zUmqgHg3MazFiDfMbb3i6sAFbuYGLY9yvYowI6Auu6RuMkp6nBQuK4WCRQriwxtiQLQsEtNli1x6Wb6OAL+g5YuhZCpa/ZqDQSobugCOoMgUFBdjXFM1COFmNtORfYbno+jGYyzN6H5oLcMJ/qO177K6XHJt7gMTZexVPnCgALb2XlM3y4GFc4ArPAlIcimjXNINlEWrx6B8Jr8zlotBstW5U80I7lIxSjBeZbFqAlm8y2MqxBmmBw+rwh0TWRrk1vrdXaFLgMa/5kQLE8BSebY4ELo5+eHCoZ1mvP2Gx8DIpWWDM05Pzt6wq07Dxs9y7/9e/ya/X6hWF0S/8QgrnVaak30tsrY/dK/o97Jf+C1vK/YPCNenvd2/YXkKRP53Mcd/mxyis9+6cb86TqHan9uyK1MNLT6aCEIluoyt8AuYMxc0Y9Fil0muxEY7DV5p6zqZy84yLrEXiCEsYv0t4VDviur0YY7R3zZn+h6iUrog/QiP8PrYml/o6BMPeJ8REVtuNl+GCW6ENWzTetvuqKD/PL8PYOyP4LbZ5xXA== +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Preview form definition data source.

+ + + + + +Preview form definition data source. + +## Request + +

Path Parameters

Query Parameters

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 + +
  • Array [
  • ]
+ +An error with the request occurred + +
Schema
    messages object[]
  • Array [
  • ]
+ +An error with the authorization occurred + +
Schema
    messages object[]
  • Array [
  • ]
+ +An error with the user permissions occurred + +
Schema
    messages object[]
  • Array [
  • ]
+ +An error with the item not found + +
Schema
    messages object[]
  • Array [
  • ]
+ +Too many requests + +
Schema
    messages object[]
  • Array [
  • ]
+ +An internal server error occurred + +
Schema
    messages object[]
  • Array [
  • ]
\ No newline at end of file diff --git a/docs/api/beta/sidebar.js b/docs/api/beta/sidebar.js new file mode 100644 index 000000000..9ff160714 --- /dev/null +++ b/docs/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/update-access-profiles-in-bulk","label":"Update Access Profile(s) requestable field.","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/set-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":"Access Request Identity Metrics","link":{"type":"doc","id":"api/beta/access-request-identity-metrics"},"items":[{"type":"doc","id":"api/beta/get-access-request-identity-metrics","label":"Return access request identity metrics","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":"Account Usages","link":{"type":"doc","id":"api/beta/account-usages"},"items":[{"type":"doc","id":"api/beta/get-usages-by-account-id","label":"Returns account usage insights","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":"menu__list-item--deprecated 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":"menu__list-item--deprecated 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":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"api/beta/start-campaign-remediation-scan","label":"Run Campaign Remediation Scan","className":"menu__list-item--deprecated 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":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/beta/start-campaign-report","label":"Run Campaign Report","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"api/beta/get-campaign-reports-config","label":"Get Campaign Reports Configuration","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/beta/set-campaign-reports-config","label":"Set Campaign Reports Configuration","className":"menu__list-item--deprecated api-method put"},{"type":"doc","id":"api/beta/list-campaign-templates","label":"List Campaign Templates","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/beta/create-campaign-template","label":"Create a Campaign Template","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"api/beta/get-campaign-template","label":"Get a Campaign Template","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/beta/patch-campaign-template","label":"Update a Campaign Template","className":"menu__list-item--deprecated api-method patch"},{"type":"doc","id":"api/beta/delete-campaign-template","label":"Delete a Campaign Template","className":"menu__list-item--deprecated api-method delete"},{"type":"doc","id":"api/beta/start-generate-campaign-template","label":"Generate a Campaign from Template","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"api/beta/get-campaign-template-schedule","label":"Gets a Campaign Template's Schedule","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/beta/set-campaign-template-schedule","label":"Sets a Campaign Template's Schedule","className":"menu__list-item--deprecated api-method put"},{"type":"doc","id":"api/beta/delete-campaign-template-schedule","label":"Deletes a Campaign Template's Schedule","className":"menu__list-item--deprecated api-method delete"}]},{"type":"category","label":"Certifications","link":{"type":"doc","id":"api/beta/certifications"},"items":[{"type":"doc","id":"api/beta/submit-reassign-certs-async","label":"Reassign Certifications Asynchronously","className":"menu__list-item--deprecated 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":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/beta/list-certification-reviewers","label":"List of Reviewers for certification","className":"menu__list-item--deprecated 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/create-form-definition-file-request","label":"Upload new form definition file.","className":"api-method post"},{"type":"doc","id":"api/beta/get-file-from-s-3","label":"Download definition file by fileId.","className":"api-method get"},{"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/get-form-instance-file","label":"Download instance file by fileId.","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 Governance Group by Id","className":"api-method get"},{"type":"doc","id":"api/beta/delete-workgroup","label":"Delete a Governance Group","className":"api-method delete"},{"type":"doc","id":"api/beta/patch-workgroup","label":"Patch a Governance Group","className":"api-method patch"},{"type":"doc","id":"api/beta/delete-workgroups-in-bulk","label":"Delete Governance Group(s)","className":"api-method post"},{"type":"doc","id":"api/beta/list-connections","label":"List connections for Governance Group","className":"api-method get"},{"type":"doc","id":"api/beta/list-workgroup-members","label":"List Governance Group Members","className":"api-method get"},{"type":"doc","id":"api/beta/update-workgroup-members","label":"Add members to Governance Group","className":"api-method post"},{"type":"doc","id":"api/beta/delete-workgroup-members","label":"Remove members from Governance Group","className":"api-method post"}]},{"type":"category","label":"IAI Message Catalogs","link":{"type":"doc","id":"api/beta/iai-message-catalogs"},"items":[{"type":"doc","id":"api/beta/get-message-catalogs","label":"Get Message catalogs","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":"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/list-outliers-contributing-feature-access-items","label":"Gets a list of access items associated with each identity outlier contributing feature","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":"doc","id":"api/beta/get-outlier-contributing-feature-summary","label":"Get identity outlier contibuting feature summary","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":"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":"doc","id":"api/beta/get-all-potential-role-summaries","label":"Retrieves all potential role summaries","className":"api-method get"},{"type":"doc","id":"api/beta/get-role-mining-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-saved-potential-roles","label":"Retrieves all saved potential roles","className":"api-method get"},{"type":"doc","id":"api/beta/get-potential-role-source-identity-usage","label":"Retrieves potential role source usage","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/get-identity-ownership-details","label":"Get ownership details","className":"api-method get"},{"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 Attributes","link":{"type":"doc","id":"api/beta/identity-attributes"},"items":[{"type":"doc","id":"api/beta/list-identity-attributes","label":"List Identity Attributes","className":"api-method get"},{"type":"doc","id":"api/beta/create-identity-attribute","label":"Create Identity Attribute","className":"api-method post"},{"type":"doc","id":"api/beta/get-identity-attribute","label":"Get Identity Attribute","className":"api-method get"},{"type":"doc","id":"api/beta/put-identity-attribute","label":"Update Identity Attribute","className":"api-method put"},{"type":"doc","id":"api/beta/delete-identity-attribute","label":"Delete Identity Attribute","className":"api-method delete"},{"type":"doc","id":"api/beta/delete-identity-attributes-in-bulk","label":"Bulk delete Identity Attributes","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/sync-identity-profile","label":"Process 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-okta-config","label":"Configuration of Okta MFA method","className":"api-method get"},{"type":"doc","id":"api/beta/set-mfa-okta-config","label":"Set Okta MFA configuration","className":"api-method put"},{"type":"doc","id":"api/beta/get-mfa-duo-config","label":"Configuration of Duo MFA method","className":"api-method get"},{"type":"doc","id":"api/beta/set-mfa-duo-config","label":"Set Duo MFA configuration","className":"api-method put"},{"type":"doc","id":"api/beta/test-mfa-config","label":"MFA method's test configuration","className":"api-method get"},{"type":"doc","id":"api/beta/delete-mfa-config","label":"Delete MFA method configuration","className":"api-method delete"}]},{"type":"category","label":"MFA Controller","link":{"type":"doc","id":"api/beta/mfa-controller"},"items":[{"type":"doc","id":"api/beta/send-okta-verify-request","label":"Verifying authentication via Okta method","className":"api-method post"},{"type":"doc","id":"api/beta/send-duo-verify-request","label":"Verifying authentication via Duo method","className":"api-method post"},{"type":"doc","id":"api/beta/ping-verification-status","label":"Polling MFA method by VerificationPollRequest","className":"api-method post"},{"type":"doc","id":"api/beta/send-kba-answers","label":"Authenticate KBA provided MFA method","className":"api-method post"},{"type":"doc","id":"api/beta/send-token-auth-request","label":"Authenticate Token provided MFA method","className":"api-method post"},{"type":"doc","id":"api/beta/create-send-token","label":"Create and send user token","className":"api-method post"}]},{"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 preferences 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/put-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/put-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":"Generate insights for roles","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"api/beta/get-role-insights-requests","label":"Returns metadata from prior request.","className":"menu__list-item--deprecated 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":"doc","id":"api/beta/get-role-entitlements","label":"List role's Entitlements","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 Segment by 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 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":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"api/beta/list-sod-policies","label":"List SOD policies","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/beta/get-sod-policy","label":"Get SOD policy by ID","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/beta/put-sod-policy","label":"Update SOD policy by ID","className":"menu__list-item--deprecated api-method put"},{"type":"doc","id":"api/beta/delete-sod-policy","label":"Delete SOD policy by ID","className":"menu__list-item--deprecated api-method delete"},{"type":"doc","id":"api/beta/patch-sod-policy","label":"Patch a SOD policy","className":"menu__list-item--deprecated api-method patch"},{"type":"doc","id":"api/beta/get-sod-policy-schedule","label":"Get SOD policy schedule","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/beta/put-policy-schedule","label":"Update SOD Policy schedule","className":"menu__list-item--deprecated api-method put"},{"type":"doc","id":"api/beta/delete-sod-policy-schedule","label":"Delete SOD policy schedule","className":"menu__list-item--deprecated api-method delete"},{"type":"doc","id":"api/beta/start-sod-policy","label":"Runs SOD policy violation report","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"api/beta/get-sod-violation-report-status","label":"Get SOD violation report status","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/beta/get-sod-violation-report-run-status","label":"Get violation report run status","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/beta/start-sod-all-policies-for-org","label":"Runs all policies for org","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"api/beta/get-sod-all-report-run-status","label":"Get multi-report run task status","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/beta/get-default-violation-report","label":"Download violation report","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/beta/get-custom-violation-report","label":"Download custom violation report","className":"menu__list-item--deprecated api-method get"}]},{"type":"category","label":"SOD Violations","link":{"type":"doc","id":"api/beta/sod-violations"},"items":[{"type":"doc","id":"api/beta/start-predict-sod-violations","label":"Predict SOD violations for identity.","className":"menu__list-item--deprecated api-method post"}]},{"type":"category","label":"Source Usages","link":{"type":"doc","id":"api/beta/source-usages"},"items":[{"type":"doc","id":"api/beta/get-status-by-source-id","label":"Finds status of source usage","className":"api-method get"},{"type":"doc","id":"api/beta/get-usages-by-source-id","label":"Returns source usage insights","className":"api-method get"}]},{"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/get-native-change-detection-config","label":"Native Change Detection Configuration","className":"api-method get"},{"type":"doc","id":"api/beta/put-native-change-detection-config","label":"Update Native Change Detection Configuration","className":"api-method put"},{"type":"doc","id":"api/beta/delete-native-change-detection-config","label":"Delete Native Change Detection Configuration","className":"api-method delete"},{"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/set-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 by Type","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/put-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/set-tags-to-many-objects","label":"Tag Multiple Objects","className":"api-method post"},{"type":"doc","id":"api/beta/delete-tags-to-many-object","label":"Remove Tags from Multiple Objects","className":"api-method post"}]},{"type":"category","label":"Task Management","link":{"type":"doc","id":"api/beta/task-management"},"items":[{"type":"doc","id":"api/beta/get-task-status","label":"Get task status by ID.","className":"api-method get"},{"type":"doc","id":"api/beta/update-task-status","label":"Update task status by ID","className":"api-method patch"},{"type":"doc","id":"api/beta/get-task-status-list","label":"Retrieve a task status list.","className":"api-method get"},{"type":"doc","id":"api/beta/get-pending-tasks","label":"Retrieve a pending task list.","className":"api-method get"},{"type":"doc","id":"api/beta/get-pending-task-headers","label":"Retrieve headers only for pending task list.","className":"api-method head"}]},{"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":"Work Reassignment","link":{"type":"doc","id":"api/beta/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"}]},{"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"}]}]; \ No newline at end of file diff --git a/docs/api/beta/sod-policy.tag.mdx b/docs/api/beta/sod-policy.tag.mdx new file mode 100644 index 000000000..0ed5eaad8 --- /dev/null +++ b/docs/api/beta/sod-policy.tag.mdx @@ -0,0 +1,46 @@ +--- +id: sod-policy +title: "SOD Policy" +description: "SOD Policy" +custom_edit_url: null +--- + + + +Use this API to implement and manage "separation of duties" (SOD) policies. +With SOD policy functionality in place, administrators can organize the access in their tenants to prevent individuals from gaining conflicting or excessive access. + +"Separation of duties" refers to the concept that people shouldn't have conflicting sets of access - all their access should be configured in a way that protects your organization's assets and data. +For example, people who record monetary transactions shouldn't be able to issue payment for those transactions. +Any changes to major system configurations should be approved by someone other than the person requesting the change. + +Organizations can use "separation of duties" (SOD) policies to enforce and track their internal security rules throughout their tenants. +These SOD policies limit each user's involvement in important processes and protects the organization from individuals gaining excessive access. + +To create SOD policies in IdentityNow, administrators use 'Search' and then access 'Policies'. +To create a policy, they must configure two lists of access items. Each access item can only be added to one of the two lists. +They can search for the entitlements they want to add to these access lists. + +>Note: You can have a maximum of 500 policies of any type (including general policies) in your organization. In each access-based SOD policy, you can have a maximum of 50 entitlements in each access list. + +Once a SOD policy is in place, if an identity has access items on both lists, a SOD violation will trigger. +These violations are included in SOD violation reports that other users will see in emails at regular intervals if they're subscribed to the SOD policy. +The other users can then better help to enforce these SOD policies. + +To create a subscription to a SOD policy in IdentityNow, administrators use 'Search' and then access 'Layers'. +They can create a subscription to the policy and schedule it to run at a regular interval. + +Refer to [Managing Policies](https://documentation.sailpoint.com/saas/help/sod/manage-policies.html) for more information about SOD policies. + +Refer to [Subscribe to a SOD Policy](https://documentation.sailpoint.com/saas/help/sod/policy-violations.html#subscribe-to-an-sod-policy) for more information about SOD policy subscriptions. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/docs/api/beta/sod-violations.tag.mdx b/docs/api/beta/sod-violations.tag.mdx new file mode 100644 index 000000000..d5e477b79 --- /dev/null +++ b/docs/api/beta/sod-violations.tag.mdx @@ -0,0 +1,38 @@ +--- +id: sod-violations +title: "SOD Violations" +description: "SOD Violations" +custom_edit_url: null +--- + + + +Use this API to check for current "separation of duties" (SOD) policy violations as well as potential future SOD policy violations. +With SOD violation functionality in place, administrators can get information about current SOD policy violations and predict whether an access change will trigger new violations, which helps to prevent them from occurring at all. + +"Separation of duties" refers to the concept that people shouldn't have conflicting sets of access - all their access should be configured in a way that protects your organization's assets and data. +For example, people who record monetary transactions shouldn't be able to issue payment for those transactions. +Any changes to major system configurations should be approved by someone other than the person requesting the change. + +Organizations can use "separation of duties" (SOD) policies to enforce and track their internal security rules throughout their tenants. +These SOD policies limit each user's involvement in important processes and protects the organization from individuals gaining excessive access. + +Once a SOD policy is in place, if an identity has conflicting access items, a SOD violation will trigger. +These violations are included in SOD violation reports that other users will see in emails at regular intervals if they're subscribed to the SOD policy. +The other users can then better help to enforce these SOD policies. + +Administrators can use the SOD violations APIs to check a set of identities for any current SOD violations, and they can use them to check whether adding an access item would potentially trigger a SOD violation. +This second option is a good way to prevent SOD violations from triggering at all. + +Refer to [Handling Policy Violations](https://documentation.sailpoint.com/saas/help/sod/policy-violations.html) for more information about SOD policy violations. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/docs/api/beta/source-usages.tag.mdx b/docs/api/beta/source-usages.tag.mdx new file mode 100644 index 000000000..47ffa1c4d --- /dev/null +++ b/docs/api/beta/source-usages.tag.mdx @@ -0,0 +1,23 @@ +--- +id: source-usages +title: "Source Usages" +description: "Source Usages" +custom_edit_url: null +--- + + + +Use this API to implement source usage insight functionality. +With this functionality in place, administrators can gather information and insights about how their tenants' sources are being used. +This allows organizations to get the information they need to start optimizing and securing source usage. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/docs/api/beta/sources.tag.mdx b/docs/api/beta/sources.tag.mdx new file mode 100644 index 000000000..4b778b80a --- /dev/null +++ b/docs/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, mapped 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/docs/api/beta/sp-config.tag.mdx b/docs/api/beta/sp-config.tag.mdx new file mode 100644 index 000000000..122e290dc --- /dev/null +++ b/docs/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/docs/api/beta/start-campaign-remediation-scan.api.mdx b/docs/api/beta/start-campaign-remediation-scan.api.mdx new file mode 100644 index 000000000..fcf5d735a --- /dev/null +++ b/docs/api/beta/start-campaign-remediation-scan.api.mdx @@ -0,0 +1,104 @@ +--- +id: start-campaign-remediation-scan +sidebar_label: Run Campaign Remediation Scan +hide_title: true +hide_table_of_contents: true +api: eJztW1tz2zYW/isY7kOTjCVZihLHftlxnKTjNrf1ZfLgZDYQCUloKIAFyCRaj//7fucApETLjnObtsmwDylFAAfnju8cg+eJLZSTpbbmMEv2El9KVx7IRSH1zByphco0Dx6n0iRbSSlnPtk7Sw6UK/VUpzwm6vk+ebOVZMqnThc0AHq/6/SdF3Y6FW5FTHhQE6X078TUOiFF2iKXRnL91+Dgz0o75YWzuSI64uDx0cl/9x89O3wupMnEi6Nfw6+Edi6cAg0FQUpXqa3Eq7RyulyC5fPk1Ct3YE2pPpb7VTknMXRm9urdek4V1pV7rjLJmwsIUkgnF6pUzvNyTeIUEgu3EoMB/NIZnn06VwuZ7J0n5bJQrEKnzQwj6iNI5/RqlO4OH2w/uLcznKTTdPpge7gzTEd31XgyHo2G0zS52EpcELXhva3Hk7kSh49IASWeap5ZfR/mOp1vqld7MVFgRECgfkICQY+FNV55Yna0PaL/tXfZT1NVQH+iJ45UWTmDRx22JPaUL8UH6YWvMM/7aZXnSyHrNdqUlqf6pS/Vog8NpKRuU9JGsijyaODBH552O99UnZ38odIyucB/W8l4e3uTw4Ncg6B47Bwkv57Lic2WpAFt3stcZ9/AC/zAUYiUOugtU6XU+YHN1FUmbzP7RBvVmzmpiUPFLKdYKEDxvc7INgvrlAgka9vyvH7LfaCJ/lA8lJk4ivIdRGGgptLJ9B1oUfjexNCp0Vgv6iVCZ+xB12yrdpSc3N/eHY2n98dSjh6Mhzv3JrtTeffu9u693V3afQE/kLOgmri3dE4uN7b+VRnldCpym8Ii/4NCnJLQPTPAm2OJht/4m23AND5D/xQ0YW4jZuRXUBbYQuZ5ePBSjHdELs2s4vdydkkJpnd6TCEPZ5cTekXhCckD4RdOz7S5MvpNtaAc8+jxk/3Tpyd4c/T4P6ePj/FEtDYy5T5C1mTklmAVvjC3H5jjKADHncqhDpX1xZ1I9Q4EksavT9R+LQjhW1NZ5SVWxN2vWLFOWkydXbRCKQ0pU9zSfdXfQk7Bu4UskXIm0mMBTEjT74Tc0XsaNXlHzJXMlLvdF/tZpklImQtEI4hi/RKEhMwyzhtMYFohlMGMLue2KoWxpU5V2xYrVbatgSDQJc94um4UCg5wfrOf7KdlBeZYzPUobLwlshjtA56D5trcnVzOkktTyhRSSEqTqXU4nJCZIJsuvYjpiMzlkXhMPa/JWJQCa7E43T0LzDwqLY+lsvKfEXcvc6SfHovWDLxXMfjgBjZmI7ZGbaaYkWI+58VxVmOuOvDFVKs862K3i90udj8zdi8PHkVcFkcZ+gw3oc+pkYCt1vHhuQF9HHuPsaKeFKBgMOSWgEIiRPrt1QkC+51ihKg+FoQ5vyM+Ckf5JrJs7BHeTwh+NMZq2YIYZD0GCabIRCrbY75XHLOigqrubu72xLqJhoOaKyAisqYTS1sJCZUBGxviRPotkVnlzS+lmEvkR8kIN2RA2tVkvcIC4XZIskOS3WnUnUY/z2nUIckudrvY/TFj95NIsuGKoyXiJF8tFtItg6fFcZJWCkwQdYdQNCHHprqMVoiYaDBW0kYOyWQ0nAynO6kaZ3Kc3b+7Ox2l90fy3s5wZzgZj3aS9bP+bBXHTZC1Y2rN3sGOrGKAuPfAcZWBc/nS2qzd/oN6nZpSWqPU0+Bm6JxaoSvsON7Ejs9tCdlAGNjRXdNePD16SvSxNZMnvdnKpYpgdlAdpsuSISX5MDStfdlBxw46dsdPd/z8NMdPBx272O1i98eM3S+CjuOboOP4C6DjWBDEmhLE+juhYwbcQdBsCqPQFYQK6jUEGwuIgqfYfYxhX0o3U2UD9FoocrS7iSJPrBXPpFnWYMm3OpFmpS5Kb5i7oLmunosJUsyQIo1A1tJAt+RVeqEIk8J/RK4XmuOYBAJdt+ztT0tIFWKm9rdmF23SvAKHnBRyS71XCx/TcCc1JfgHCtwHnSFRf8ceZ7TWN/WDxRFJ/JQkFo8/pkpRzDf933tX3RI4BPOO0sVxsPU11wVCz1walBHqYxHSVwNBO6jeQfXuuO+O+5/juO+gehe7Xez+mLH7BVA9oqHroTomfDZUx9z+tmiw1BNyrr8csXOoRA7YvYVNGatnKwzOuAKuRAwVlhutfFF3LxnUN2X94FxnFwNX0T3f5qZsz4drzaEkCBxWLsfCeVkWfm8wOIfhYLCLvix0H/kMtiuXxn7op3YxmEBbVyQiuncago4miP2Xh7Hm6LOqnSZvDqmPiQfFs3DktzAAXzX4JGW6gUwWXaIcEYHMloDnR8/i12CxQFnxi+fZffakDfkg16nLL75dlkDoGlmuUt8nd8N8AU4viUgivFld6z4mDB5237jcvTpXqPs/2tjsBU0biYdKOhQI4ULMrd9endwWM0KeHPmVJ9CrNJUKiJ2XcBHObPv15RBaxIeNs9Vszozvt67fUCSJaQ6BxWtzrJQ4O4xKeI6Uf4QczSqlRYrTAq16c6u2Tqbeq5xOw/5Kk+R4OjMDaGggW+tu88nHJYI2eFzw2/5r0xOPNCUkTSc4zYkicsUnzopaLrkm19cy8a+aWi9Q6zE1f/sSF0G1Z2m4zp0inImEzD1r66s3D/R6a/SonsIbonqZB9JE5KN9aSqtrfbVfLTo9Yhem4/X5hXf2m8vEyGLCY9TMc/EoUjn1nr1byHIdSgMzmYVouir2eJPBXocEb3R9hpLvbBlT/cAEpm/pwgME5xJTuiQZoxiQ7uEQ/ItWxYx/5a/xHjbkplfn+EspZmZTf1X80wb9mjDXsgBPvIfjipyLMQ2ycB5IDjAwcr+nAkio2t5L9C6Mqsz+QGvoaMhBatMxRd74cfeKsHFJ8EDNLuZgzRMGLu5RobfItKi86qlrLo7cFmDm/zmFsfkJb0Ffpu/cdLR+U+TlyTeXzVRXph8+b2z9DWZ5J+Td/+mjNdlmp8x00TUS+7G28byYN3JH0a8ttnUo67zXOFfjHKsMsBG+cIFGaOYdUJFLkvyao7qdK4VtwMKJUvCflvkWXbBkYjKncIfRR8TmjnMQdgCZKOA0znoccO63llywARgSXal376K1ycsXBLlpeqLV6jQTAqzUHVGF3cx9oeNZdoxLPOSDCse1cYG6FosKoPdKC6rhZBwqRs8ItM+rULiQrFmVK0Ly9CvWVVHMbkaidDnOsUt/IspdZpRxK4Z/oa9YHcf28xQPVkxflW4EuRI5eyZNK8N22+iDW/rzVVeUH2IrAsAptZ2eHZ4skERxEz824Z1s0Fc5Ac0F0SoPAruc7c/7G/3uFzAeyq3UNGuET+qVh+EirUvSEX8hLTljOerNvtf+qloPHWoXBgU1PEiWapQvoTS8SxpSkfM3+NPPa+sHlGPzKnmxIrzc2qTUDl1Qa//rBTV4GdvVpUSV5gwEj2jWp0ibVz+1HNdJbeiUNlt/kPPt3wAeo3MdS/QLFdtgASP7xR1DyA1amwIyO0dZj4MhAbQ2pKNP5FQndYU5S9fUCuM8c1VZ358gKaQ1f4PKxAr+A== +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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' (start-campaign-remediation-scan)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Run Campaign Remediation Scan

+ + + +:::caution deprecated + +This endpoint has been deprecated and may be replaced or removed in future versions of the API. + +::: + +Kicks off remediation scan task for a certification campaign. +Requires roles of CERT_ADMIN and ORG_ADMIN + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/start-campaign-report.api.mdx b/docs/api/beta/start-campaign-report.api.mdx new file mode 100644 index 000000000..20ea175f8 --- /dev/null +++ b/docs/api/beta/start-campaign-report.api.mdx @@ -0,0 +1,104 @@ +--- +id: start-campaign-report +sidebar_label: Run Campaign Report +hide_title: true +hide_table_of_contents: true +api: eJztW1tzE7kS/iuqOQ8LlC+xMYT45ZTJZY+3EpzjJMVDSIE8I9uCsTRIGsCbyn8/3S3N2BPnAoE6LNTsAzsetVp919eK5jLSmTDcSa2GSdSPrOPG7fJFxuVMjUWmjYsakeMzG/XPo11hnJzKmOhZQWaji0aUiMwIGBDAxZlc4BsbG5khKTAe58oyzgyxZFNt4EdcYRcHdq03sPDHXBphmZsLoE1T/VmqGTM6FbbPdvfHp28He0fDVw22Nzj5z8vRYLzXYKPxn/4t4yph4/3jUUHWAhWsiHMj3RLUuIzOrDC7WjnxxQ1yN0fVZKL6hQRNL2Xf5Cq6uALlMm74QjhhLE2XqFDGYWIjUjAAv2SCa8RzseBR/zJyy0yQNQ3IDSPiC7BO8VU33um82HrxbLsziafx9MVWZ7sTd5+K3qTX7XamcXTViIxX/xZLnoJNhntMT8k6hcxk0s9zGc8LG0vLJoLMlqsWsL1RbhL0Lsmra+MorsxZGRtC5QuKjcHR8WD456u3u6Oj49HJ8HQ4evXWewGoytHx/tH+3nBAoyeng9OzkxuINgbA48OD4W6YBiSjg4Ni+GLdvHdL4aQjKi/8Kar6VeYu1EaDB+s6Hex6gQxsppUVFg3Y3eri/6pMBnEsMsgN1gTDudwoeJQFv4+5sI595pbZHOisneZpumS8mCMVLIakdmmdWGA0xxi8yuFCPMvSkELt9xZXu9x0p568F7GLruC/RtTb2tqUcDeVwJDtGwNxdLuUE50sMbKk+sRTmXyHLJBVBmuPk95uiXBcprs6EfeH4YFUojkzXKKEgkSOYSIDjp9kgjG/0EYwz7JwHNG1KskIlmh12EsO5SLotxuUATM5w+MPwAvr4n0CnSkJ81kxhcmE8vGWZcW24JPnWzvd3vR5j/Pui15n+9lkZ8qfPt3aebazg6svIA74zJsmrM2N4cuNpf8UShgZs1TH4JG/wSBGcLA9CUCLwxQJcWPv9wHx+Ar7Y0542lLNIC/DmtqA+vBy95j1tlnK1Syn93x2zQiqeXaChQiCnU/wFWYfaO4Zj4ycSXVjLQ0FZ2//YHB2iGk93v/v2f4JPCGvi+vCDhREa4JhCaJCLMz1Z5I4KEB5J1Iwh0ha7Eng+gQU4squE0q7loQQW1Oepw5mhNVvmLHOmk2NXlRSKfYbEHskW6LVgFoN7xbcQQGfcAsTwIVI/sTXjuZhsOQTNhc8EeZxiw2SRKKSPGWQjcAU5i+BEeNJQnXD7585pDIII91c544p7WQsqr5YmbLqjVXFPFx3CiYHSH5/nAxil4NwpOZ6FpbREkQM/gGZveWq0p1er5JL5XgMWnAsk7E2ADygMoFu0lkWyhG6y0LhUQVdWbGwBBZqUbk78sLsOU1jMc/tV+TdcQrlp0mqlQOfREg+i/uDr0bkjcJNoSKFek6TA1XpriLx2VSKNKlzt87dOne/MnevD44DLgujBH06m9DnTHFoArShzXMD+hiKHqVZQeS7Fe/IBgODBIj01+tTSOwPQiG9+JIhpPyB+Mhv5ZvIsvSHfz9B+FE6q+ILFJDs6DWYQiUSSZ/kXklMhvKmerq52oE2EwkBqm6AiFA1DVvqnHEwGWBjhZJw22CJFlb94dicQ33khHB9BcRVVdLMNCDcGknWSLLejerd6PfZjWokWedunbu/Zu7eiSRLqShbAk6y+WLBzdJHWhj3J6VAwIoTQlamHLnqOlpBZqzEWFEVOUSTbmfSmW7HopfwXvL86c60Gz/v8mfbne3OpNfdjtb3+vNVHpdJVs2pNX97P5KJAcR9AhyXKwgu67ROqsd/YF4jpljWsPSUuBlsjkehK+zY28SOr7QD3YAxYEdzy/Hi2fgQ+cPSxB7tpnMTC4TZ3nRAzh1BSoxhsLS0roaONXSst596+/lttp8aOta5W+fur5m73wQde/dBx943QMceQ4g1RYj1M6FjArgDodkUnIKXPHIwr0LYmIEq8BROH0PaO25mwpVAr4IiuzubKPJUa3bE1bIAS7ZyEqlW5sLyBrQLpDUFLRBwNoMSqRhULQnoFqNKLgRiUogflsqFpDxGhYCvWTYHUwda+Zwp4q1cRao4zUFCKgqpxrNXDTEmIZzEFOEfcKBz0BkU6h94xhm89V3nwWyMGh+ixmz/SywE5nx5/vvsplsCQxDeYLk48b6+5bqAPzPnCtoI8SXz5auEoDVUr6F6vd3X2/3vsd3XUL3O3Tp3f83c/QaoHtDQ7VAdCL4aqgNta4uVWOoAg+v/jtgpVYIEFN5Mx4TVkxUGJ1wBoYQCZZoOWun6cD9qF/eObftSJldtkxe3ptuXGCdXEV65RozoxctNCrPmzmW23wYSocBbVy2eyRYUM3CcWyr9uRXrRXsCprqhCuGlU59xSMAGx8PQcLTIzkZiKPu6R8y91UkzDFqwPt0zuJMzXopGdy6hF2GeTQMv/4awotcgYgY9xR+WqFsURhv6gV5nJr36fl08o1t0ucl8d64G9AwkvaYiqnCxuiF/ggDcr75xT361qeDRf3djsRGSddlLwQ10B/42zKO/Xp8+ZjOEnZT2uUXEKyT2CZA4xxAiVNYGxc0QnEQ7jdH5bE6CDyp3bzCN2DQFhdkbdSIEOx8GI7yCej+GAk0mxUmCagLOunhUeCcRn0SKW2FrZUkMPJmoNliozSvzHtO2R/2BVPC4oLetN6rJ9iRWI4nbN9IEFandY+dZoRdf0+uhQvyr4Nb03JrEzT6+JoU37Xns73LHkMvIgqeWrPXgxT2/5ho/bKbgDXK9LgNaIshRvTEVF157sBwVfk3kV5XjjXpNH0BUpzFfwpiFLTFN2JDFc62t+DdjGDqYBuezHLLowWLRVxdNyohmd2tNpKZfsimbgBBJvkNIDOWDiU9whyaAov1ZCaXkO/Is5Pw7+ozlXUVnen0OGylSJjq2D5YZF2zigk1fA2yQ3+9TGFiQ26gD1QEfALsr/1MlCIKu1T3P68aqTuzbNAe3hhhEJS426/sf/VWBC0+MBpC6pIEyjAC7vEMGv1nghZtVxVjF0cB1C27Km2rYI6/Zzctb/oET981/mr6o8WB1gjJS6fJHV+lbKsk/p+7+pIpXV5rfsdIEyIvhRsuG3mA9yF8GvLZ5oodHznMB/8Io5Sqha+hdqBsjFLPOKEu5w6imrI7nUtBZQCa4Q+zXwMjSC8pEaNsx/aHjI0YzAzSQthYwKZ/IFPjRaXWxMqeE8cAS/Yq/bR7uTmgISegtRYu9hvZMxeAWbM3w1i6MvdehRzsBzxyjY9le4WwAXYtFrmA1zMt8wTiE1D0RkUgb575wQaemRGELTdCvnFVkMYYaqtCiJsUs7GiKx8zQwa45/p61wO82nDGD6dGL4UPHlSJjkVJkIl0Vtt/HG6KtORdphs0hVF0AYGJthaPh6QZHYKbCHza0mbXDJNtGWmCC7ZEPn6etTmurSe0CvMdeC9rZNebjfPW97erby0oIXq5O1n/617Zh/8HGoZ3hwRdqlftGxneQ51HZQQJ9n76fXTWR+Ip4QF8yx8YT6C8v8awE26orfP0xF9iIn1+sOibqNMFZ+Awt6xTKx/XPOdeN9Cgonjymv/Z8+ze1t+hZHAOq5eoEIILHDwIPDkBTbBgfLOYd36I+SB4ahYYfDE1nTWREP+RPo9Ymbfy9BvvG8oTgeITncoS3bsIg4QE8BlX2f4dYwtY= +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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' (start-campaign-report)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Run Campaign Report

+ + + +:::caution deprecated + +This endpoint has been deprecated and may be replaced or removed in future versions of the API. + +::: + +Runs a report for a certification campaign. +Requires the following roles: CERT_ADMIN, DASHBOARD, ORG_ADMIN and REPORT_ADMIN. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/start-campaign.api.mdx b/docs/api/beta/start-campaign.api.mdx new file mode 100644 index 000000000..9d91c721f --- /dev/null +++ b/docs/api/beta/start-campaign.api.mdx @@ -0,0 +1,108 @@ +--- +id: start-campaign +sidebar_label: Activate a Campaign +hide_title: true +hide_table_of_contents: true +api: eJztW2tvGzcW/SvE7Ic8akm2LNuxviwcxylcJHXWDwSoY2ypGUpiMhpOSY4T1fB/33MvOaOXHSdpsW0DoUA6mrm8vG+eS5M3iSmVlV6b4jhL+onz0vpDOSmlHhXJRuLlyCX9y+RQWa+HOmVKURO45GojyZRLrS7pAxicVYOJ9k5I8d4MhDdCpl5fS6+EHyuRxoHio/ZjfjPS16oQx1lbnM9/n1TOi4ESkGeksva74lT9VmmrnLAmx79mKA6PTs//e/Di9fHPQhaZODn9MfyC1E6lldV+Cslvkgun7KEpvPrkDyo/Jm10VvTrqfpVmUG85OqWdSmtgpIKtvC2UhuJxbzK+ecmA7ebJWVP+EHmbXE8FIURXk/U76ZQQjvhSpXCYirbYD2hSJFJm4mL88MFusqpTDzWbdWmTz9sbvY3N5+0xUHux6YakZFAlMpCePlBQdNpMzow1tCsyMDjWuYVcwyGznNlH7mGONg3OoN8SB+ILK1y0lcMrZnMeaQRcSKnIIOUiw7MlMxyje/MB36GsyYmixoPKi+0h5fzXFg1kTp4HP8jJsbqkYbZBBk+CDabLjoepJJU0pk4PjsRz3Y3t8TQ2In07SR4BdEALw1l7uCmlBxceHKRLMs8BmrnvSM/3SQuHUMKevLTUsFzZvBepR6cSksJ4LVy/BVi/AIx5iidt7oYJctx/rVCi/NI7Iiq+SqtgoEQdA7SwwvScYA8Xnr36JdHT2A2ekQkmOHQKR88BupgwfolT8cBA4F+6LTG4/5kshGe6AFc+LnNKg1llcNqyS/4pT7BuTnp3NrcQRQmt7coANrzq4OYxnXqh9B3oCGqUlo5UV5ZxymnyUKlRLJtJAU+4JfOKC+X3RCNezvv0ZB3q9ZuQo9ZzYRVw+1nw/3edm9P7fd2druDncHgWa/bkzu72/t72bOEEhvGLCFu8HJ3s7uaywdpqkoyd0ucKl/ZAo96yPEaa4D4CPO7CnTODas8nyKd4hgkoQlpPnVeTci23xiRwZ49WH9FwsNcg6E4shY+vF/KAUoVlQFdcCT+AVmWsyNTXur80GRfkB8vURtaI4vMh4SKRU4xUIDjtc4wAtUCsR9YUjknFZiuveBdWKK9JZ7LTJxG/Q6jMhScVqYfwIuWrocEuig0xot6CKKIcuW+adWekoPdzf1ub7jbk7L7rLe1tzPYH8rt7c39nf19mn2COMDq5ObmltbK6crUP6pCWZ2K3KDe6t9hEKskbM8C8OQYohE37mEfMI8vrE+BtlEzyitoJdxAoXp++Eb09kQui1HF7+VoyQhF6+KMUhjBLgf0inITmgfGJ1zG7xJFFdWE1tkXRy8PLl6d483p0X8ujs7wRLxWQMMBkrrIKCwhKmJhbD6yxFEBzjuVwxyAAuJp5PoUCsnCzRPGxS8koYjVDSPi7HeMmGc9WwLrVEoDbAjLM1Y1eofqmo7FQNKybcJ69jTUjtaraMmnYozVUVlaxrNMB4wQ1mfH6ykqs8wyrhvMYFghlRUvkQYrZ2G8TtWiL2amXPTGrEK/mncKJQckfzhOUNcrCMdqzmdhEy1RxOgfyBwstyjd+XKVnBaesAbBEMAHY4GqfEQFTsRyxCgJhaeo6ZqKNb/wcLl7HYR54Q1/YzzycN69yVF+Wqxa8+FaxeRzBFpCNWJv1G6KFSnWcx4cqRp31YkvAHbybJ2769xd5+4X5u7yx9OIy+JXhj5bq9DnopBo3dA3/H4XQLMcPei/aqLQ4QRHMuKNEOmnt+dI7A9ob0CvPpUEOP9EfBSW8lVk2fgjvB8Q/GicteALEpDtGDQYohKprM9yzyRmQwVTba/O9tLYgUaAFndARFRNK6amCm1HVRQkiXQbIjPKFY+8GMtrxajWuVABadYia5UGCHeNJNdIcr0arVej72c1WiPJde6uc/efmbufRZKNVJwtESe5ajKRdhoiLX4nbaUAgah3CEWTcuyqZbRCzESDsZJF5JAMuluDreFeqnqZ7GW72/vDbrrblTt7W3tbg153L5lf6y9nedwk2WJOzfk7+JFNDBB3DRxXFQgu543JFrf/YF6rhlTW+M8vNW6GzWHSqxl27K1ix5+Nh25gDOxo79levDh9RfwxNbMnu5nKprSrH00HcukZUlIMw9La+TV0XEPH9fKzXn6+m+VnDR3XubvO3X9m7n4VdOw9BB17XwEde4Ig1pAg1l8JHTPgDoJmQzgFOqQVzFv42UGEuPsY095LO1K+AXoLKLK7v4oiz40Rr+mgSgRLbmEnspiZi8obaCdEa2taPkMRzqCgammgW4oqOmQCTErniHI90ZzHpBD42mnrYOihVciZOt6aWXSR5hUk5KKQG9p7NYgxTSc2hgT/wIH3QUco1H/iHmf01h/aDxanpPEr0lgcfUqVopxv9n937jolcAzhLZWLs+Dre44LhD1zWaCNUJ/KUL4aCLqG6muovl7u18v997Hcr6H6OnfXufvPzN2vgOoRDd0P1UHwxVAdtO1N0WCpl3xM9v+N2DlVogQc3sKkjNWzGQZnXIFQIoFKwxutfPC2n3TqA7Ouc6Oz2059ED+h8/EEDYNUlc1BPPa+dP1O5wbOgpNu27LUbdQw+MtPC/OxnZpJZwAL3VF86KxpSDQiEAdvjmOf0WbzWk0RHModMw/Grk8eOxidjxd8ljOdIiYvTtGCiMBmQyDaYzTxa4hYopV45Ji6zdGzoh/0urD57R/XJTC6R5e7zPfZ2UAvIOmSiqTC1ew6wxnh7jD7yqWG2VpCO/7dlclOiKwrnitp0RSEQzCPf3p7/kSMCG1ytleOgK7S1B4gX94gRLiaHdQHQmgQLzA2Xk1Q4mDhyA1ljxjmUFi8K86UEpfH0Qg/o8yfoi6zSWmQ4lJAo64e197J1LXKaQVszyxJgaezogMLdeTCuCe82nFboItw7h1v2++KlnihqQjRAXWmiSpylycuy1ovOafXtwrxr5pbK3BrMTf3ZEmKYNrLNBzhTpHCxELmjq31zZMHfq05ftRD4Q1xXZaBLBHlWDwoldZe+2Y5Fvi1iN+iHO+Kt2ONpXRxmAiVSzishHkmjkU6NsapfwtBoUNpcDmqkEXfLNZHmrTFGdHqbs6J1ApTtnQLwJDle4XEKEIwyQEtzIxLTNgi4ZT8lT2LnP+V7xv9uqAzv77E+kmUmUndN8tME7ZowlaoAS7KH5YnCizkNunAdSAEwOHM/1wJoqBzdS/wurOqM/sOj6GlIYWozMWV/fCjPytw8UnwB6JuaFCGCVc3R8fwW0RetEYtGKveEVi24Kq8ucHSuGS3IG/zd01aLv9u+pLGB7ONk5Min/7ZVfqeSvL3qbt/UcVbV5rvsdJEpEsbkKezC5lHdU8yf3GvubyGNhvRGT6GDmI+J55HeLe67xduOuJffOXUZgwO9Dy7tDrPqMylpyQId13HWvGOQamkJ6i4QYFoJpy4aO6pWqAvZEYjCxpkuQOElQOdgx/vadczS86vgEMpDOi3q+IJC4MIRgeq2uItmrgihRepgaOzvfj23sRO7gyOfENxIF7UsQGMNplUBWajNK4mQiICHwigTLu0CnUO/VyhalsYRorNqDrpKTJJhTa3MnbiToa0GY0+dy5OHpgLYeLiTjRMT16MFwlnipyqXIZLiBtLKP8h3gjO1ljlJQUJijTwmpqb4fXx+QpHMCvinz+MHXXiINchWjChbiqEz3Z7q73Z4u6C7kWiI0PTO8e8vkcJIDp3zXohBG9m++9/j+vUcc2iZqNT0h4ZqVaF5ic0m5dJ02yCvs83NJt+Ex3MmDpTUN3c0GYKNWC39BqZTJ365dWst+KeFH6i59n13nvt8zgqkj1ZVJgluFPuegewmM6a/wSPHxTtGWAcOmsIzJs6LEz4EP+K0DqfMhCoB678eYRazjAibBR9lvZqrnl/c0JbZskgXjSfhH0IKz/iJf3bT97hP/ww8eYtiPj9TVLv6oEm8K0R112AIz7A6CD7HwtCUrg= +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Activate a Campaign

+ + + +:::caution deprecated + +This endpoint has been deprecated and may be replaced or 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 + +## Request + +

Path Parameters

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/start-generate-campaign-template.api.mdx b/docs/api/beta/start-generate-campaign-template.api.mdx new file mode 100644 index 000000000..014b475b0 --- /dev/null +++ b/docs/api/beta/start-generate-campaign-template.api.mdx @@ -0,0 +1,91 @@ +--- +id: start-generate-campaign-template +sidebar_label: Generate a Campaign from Template +hide_title: true +hide_table_of_contents: true +api: eJztW21TG0cS/itTe5WK7UISCDAv+XAlA3bIYfAJiCuFqWS0O5LGXu0oO7tgHcV/v6d7Zt8kgYmTuktS+mKj2Z6efu9nZmfvAjNVqcy0SY6jYD+wmUyzNyqhMXUgJ1OpR8mFmkxj/A7WgkyObLB/FRyoNNNDHfJMURDa4HotiNQ0VXigwC9Lc7UWWBXmqc5mmHgXXFqVHpgkU5+zXp6NiZmOkv3Qs2hlfrH9NE+C63tmaMNUT2klSFgIZ4UUiboVxUQxTM0EY+XvglH7Q3IxVtW4GXxUYSZCyCB1oiKhQQuCgl6MpRV2qkItYzE06URmmU5GQk6nsQZ5ZoTOrEjkRAmZRKImnhhqFUeWOJo0UinRRipT6QQL8SIjL31UyvOtY9WpsWmLd7EM1djE4GGdfMaqgrtMVSEX+NzqbMysYeNUJZmISAcSLNOQMJ9CLL8qsf6QNHjDClbbTJghTIdICImDZXOaODa3WGAww6NYYbEUokTsc5jjdixBOTZ5DBKFJ/Ar5PmORBPqM7SL1Zr4EHzz04cAQsaxJ2nIOlMy/W6Z09gmEaYflO4F229mxIuXLAxZnxzKOF6c1F3vrmPaM2ltPiHJSQBaWECByjLOXNoy/XPY6UcZ60hM69Yiy9NsMnGH6WG/Gzyh+TYfDvVnEY5lKsOMyG0+nRoyCtnw6qO8ke0803H7tXdeev1snGVTu9/pRCa0bYOJsWqHZtIhYqs6u/ygI6eaRzo0vVNOb4+zSUyi9tWvuU6REqmJ8e9Z/83PvcO3x6dtZOwU4kwoBi2nn6Ycmkok3lpANsYvHeFvG47VRAb7d0E2myquBCmMFdyvBanjXqZzMx8pt44PKYCyepaVjkQK5JYDth6GWNHHCFh0w72N3fXdze1oY29D7r5c39iOurtb29uDLdnd7O4FVAWgHkLZKksydtfX6b+mJMcuOLkylHLcUjLnYaisHeZxPKtlIBeMbAyXF8Kucd6kKsvThLikaqgQpyFrQerVCw7pQEUEcUyycHlw9bDz0ZJAd4tGdbUnqNv0ytmffbHm6MC3qLzuZ11PWhTJQ+JG55nMcouhCeSWmUlnB2YygUA+IOhPKsnTlKp8pp3xsN6Cm5d5NU/0r/ky5za9p4abu8O9rc2tHbW3tf2yO9geDHa3ulty++Xm3k60SyHkIu0pi3JZfXS9MrlPiem9t9kS5irJJ9yrem/f9Y7fnAYLvYQWpFm0oG8LGZU1hMRAUakoAyCak6FgeT/nq0fEeNs77b056mPk/Oyyf3D089n7U/fzqNc/+P5x6R42R8H2fm76U4xdb13zCWxVRmWLxmSEuomCb0SYKk4dnZEQCRJKDkgKVxgqoXqPsWajzcfwQjZzz56jWrCEOEuQ0nV7ls/Q22RCnekyqdi0RS9pDIiwAWQqkEB8dRLGOaRqztARskpTMoln4OZ/ziho8gbdEGZiMJEYIcPQ5AlgAxaBWBLIxwASYdUbJazJ0Xift+sxe9bvH530Lo4OMXh5Wvt53YjDavz+8SrwxXg4LHCKhacVrJzC/MzG9b2iYnElj4COqOlZEeXEbc6MqbrR6ta2xU8mZzf4yRVHYoJuXTFao0nmk2qx5WvDIExMNdAWr+jxUOZxttaUMDHZA1LWLds7Ofn58Ojg+Pz47PQc4/2jH8/+heA5PfmpMX56VvvZMHrjyT0VIJ01KlO/qBp4Ss+3lnWrA4BJIKCjNIWkLdHnpuPChkKcFFEAZgMTcWjp5IbwyO9qOs02AGAqdXxgoidU5teIi9YodXhZscghJgpwvNERBcDEpFRPiGWRpUzXLFawRHtDvJKR6Hv9DrwyZEbAn0/gdfyE/nTpelMxBVnIHn9gWbWj5ODl+l53a/hyS0pgi42d7cHeUG5uru9t7+1x8gAhyJEzjV9bpqmcLSzNGxAditgAb+r/KAIM0hoHNnlxTNGAFPbLPmAeT+yMjrZU08sraCMF3CJeHbwTWzsilsko53E5mjNC0ro8X6ja0NwxPkv1SC/tG0XmHB697l2eXHDO/Pvy6Bx/Ea+FvkVF0UExiIpYGJtbltgrwIhMxTAH1eMXnusLKCRRT2qE2v2yMwtjFjmPGX71JTPqrAt4V6VS6Had4pluq/YaWgPGAKTDsRgAa0dUmon8RQ9ocZq1TrwlX4ixkoD/z9E8okiTktgYIhvBFPNn1GNkFFUbyWGOVFa8MTN5RmVJh6rpi8qU8z20qCUndadQckDyL8dJL8xyCMdq1rOwjBYvovcPZHaWa0p3UTMam3SGrXIILSQBaG5xQEoD6EYbYV+OyF0WhScp6MqKVS+RXO7eOmEOM8PPQpnbJ+Qd9q2ajgegWvngRvnks4TQXTVibxRu8hXJw3ee7KlKdxWJ77bXq9xd5e4qd5+Yu/MP+36P7p8y9NlYhD6Xice/1DwXoE/K0UOY2RM5TOkcyXjQQ6Qf3l8gsT+phOjV5ynhvj8QH7lWviB8r/SHGx8UR0pF6698QQKyHZ0GQ1QiFe2z3JXEbChnqs3F1V6bdKARoMkSiIiqmYoZEDbD8zxJ+JQSkDkyyibf0t4D9VHy2YergLRqErWmRifZCkmukOSqG6260d+nG62Q5Cp3V7n718zdR5FkKRVni8dJNp9MZDpzkeafu9eYIBDF2yJRphy7ah6tEDNRYqygiRyCQXdjsDHcCdVWJLeil5t7w274siu3dzZ2NgZb3Z2g3uuvqjwuk6yZUzV/Oz+yiQHiboDj8oTeMGbGRM3jv5zONIdU1qj0lLiZT+Dvr0vs2N1bcoJujHgrk1mBkGwDQyaVjaimgXZCtGlBCwIpRqiLCb0X1pCLQoneebYEv3iN9URz8pIW4JvOWr0hvSR2iVIEWblKeZpOlSA2hJoNAktDSTUkzAcOjGBHqM5/IDr1LvpdSF70SeMT0lgcfQ6VokQvkfv28reRsAXViHPn4AcOet1uRyYIAGwIXM0qcecKn6/w+arHr3r836PHr/D5KndXufvXzN3fgM89GnoYn4PgyfgctO11UWKp1xRc/3OYzqniJeDwFibkG4xRhcEZVyCUSKCpsVxE6JbdftBZuNpqO3c6uu8UN9ECuiFLGNGJl6cxZhUXA+/gNXjrvi2nul3cNUnMLd8SHMBUS6oQXRdwGUcEovfu2O8y2mznVFMou7rHzJ3VWTMKWlifT4gf5Vzc05qZHJWO2azRbSUfVjwMEafYU/gbrm0OowX9oNdlGt//fl0cowd0WWa+R1cDvYCkcyqSCtfVheZzAuBu9YVrzVVToU1bd2GxMyLrildKpnxRmN5jPPvh/cXz2g3F3BLiVZpv40jxDiHCZa1XnOnTJO40qclH7hpwr/HWhNJIDGMoLD4k50qJq2NvhFPU+z4KNJuUJimuCTSrdi1V3aiYWmG7siQFno4SvpQqG/Oec9vj/YFO3A1ld+W4JQ41VSO+MVS/CUrbPXE1LfSSNb2+Voh/FNxajluLudnnc1I4016F7hZOiFwmFjK2bK2vXtzxa9X40WYKI8R1XgayhJej+a4rLLz21XI0+LWIX1OOD8n7sUZPbU4TroQV17qPRTg2xqp/CkGhQ2lwNcqRRV8t1i0t2uKMaHXXayK13JIt3QJCZPlOkBiJCyY5oA7NAMUAuyWRS8lf2LPI+V/42u4vDZ15+Iou4oOSLlF/tcy0YIsWbLkaYL38rk9RYCG3SQeuAy4ADir/cyXwgtbqnuO1tKoz+w7PodYQQlTmYqf77sd+VeD8X4IfEHVJgzJMALt8+0e37TwvalYNYxVHA/MWXJQ3NuiRc3Zz8pZHU9Q3/2z6ksa96gSFbo3+0VX6gUry56m7/6eKt6o0f8dK4yEvhRsv6/cG9SB/5fHa4ome5a9o8C+ecq4yusbepfqYqc6IMDNFNWd1ONaKzwKmSmaE/dYossyEMxHbdkp/usJMjEZ8Wz2FyBK7Nx2DH59WFytLThgHLMmv9Nvm/jsAQ1/yJCPVFu+xPUtCuIW2ZnTfAs8+Gr9HO4dn3pFjxWHhbEHXr/OE7oRD7HxC3xl9KSIibcPcFS7s1BJV2MIw9CtnFVlMoUYqtHmTkk7s2ZCOmbGDrTn+C2vB79afMcP05EX/PVClSJ+uslPxAF0Ttn+JN6KtNVbxlDaHqLoAYKq2wtvjiwWOYJa4i/Btk446fpLtEC2Y+K+sMGGzvdFeb/F2AeO018J2tsb8TfVlWPUdGJ0y1D5jnPtSojxnX31duPq6cPV14W/4utCjJ9r2dqZ0bEs5mbttuDv/uAoWzz8wcZ+/eiuPQLCpHtOpCcjv7uigj84E7mn411zRKdLVdbXd52MSVBr6Owr2h+h9858l1nP6mVcges6vKr/qY8WlehaH2MmsOr8K8OcnRcdeUPD+GlTuXJJldg/cyWVtysK7PTpjKE+T3p3RGS5j82V41f8BA6Ej/xeX+7Oi +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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' (start-generate-campaign-template)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Generate a Campaign from Template

+ + + +:::caution deprecated + +This endpoint has been deprecated and may be replaced or removed in future versions of the API. + +::: + +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/start-identity-processing.api.mdx b/docs/api/beta/start-identity-processing.api.mdx new file mode 100644 index 000000000..d8b25c3f5 --- /dev/null +++ b/docs/api/beta/start-identity-processing.api.mdx @@ -0,0 +1,105 @@ +--- +id: start-identity-processing +sidebar_label: Process a list of identityIds +hide_title: true +hide_table_of_contents: true +api: eJztW21TGzkS/iuquQ8bUswYjA0xX64cIHvskoXjpVJXQGXlGdlWMiPNShqIl+K/X3dLY3swSUg2dbubm0oVsTWaVr/r6bZ0F+lSGO6kVodZtBtZx407zIRy0s1OjE6FtVJNovXI8YmNdi+j8FAKG12vR5mwqZElvg9v/0dXLNVVnrHKCuam0jKhslJL5ZjTu1dqM2F7PE+rnDvBZFiGceeMHFVO2HUmVZpXGSzJeFnmM/ygDTOVUjSmZvA5FxYHneHKjrUpLHsmkknC0jnpIzkW6SzNBTtz+J07xhnxEUsVO1nA6u4H4O5DKVInMuCOpVOuJmItuVLdhB3c8LzCN40GIhyUMFEFsAsc5oITf/DKYpzpMVPilqZbYDNjRhQaiOAD8UFah6/QU1hgCxZQwHkqWGn0jbSgPnwOQySipwts8RQNABTdFESY8huhfnBsJIRi4yofyzyHSV74MZd5ZQTLKoGsWV0h+anguZuiUL2EnYqFhgqu+ESAZkVO1rdTWSJr/YSdaIeG4Xk+Y6BCruKqXBirnDsFE8ZoAxoBdquCVDIVfhBYtZ5NI6zOb0QGpK/UuUbtGcUKbcQ6PBsDB8Asvnf52AqZTitUL7F4/WzqXGl3O53GcGJBcrJtkuqiYzm3nanIy44Vrio7Ndm3C7LJ1BX5GnE0hOXfA5u30k3Z8emPb4f7rw9/Qe/618HRyf7B2c+MV26qDTIG7mzEb5U0wWFAQ97JhyeHQA2CxIq0wqkQKHfRhRVmTysnPrgh0MDgkZnarRna9SaIru8hjpCusO6lzuDdu6heJtp1phLrUYpklMNHGBYyJck77yyG3V1k06koOH5ys1JAIOrRO/BrYAiEhvimaIWn9dKHmV2azI3hM5gLJjx0ooBHm/CFfwhfuv2Nh3F+BP6Mjg1+AXqACQv3ONy3OBaUnQBZ6cnMl7MQ7JRRxAdelDkOifHWi/Ggt9XbEYNef7s76o9GL3rdHu9vbw12shfR/f09ZCDpaHZIS4tEdOqVh7PuUZW2BH/2Enc3uvhfk/1j0g5DpXKpasfdPz9myCI7H579/Pb04Ozi6JwiGR++0yOQkQIUvzpu30ffzCz+6aqCmlzTusgfKL6W0YeQUKlo6HNJggg0IrMnUgepwIANUjsvdra2+v3teCD4Vtwb9wfxaLw9iEU/zQbd0cbm5qiHayhePFUGXAWns2dKO9wpMsj6zd0Cckp+y2eWqSrP1xoM4Ui07A7nQO9U2Cp3p0ErwRF6Gxurtt/LJabrA8pSMaREVxnMtHJMhg1xyEYQiBjvUkEOl1ny7YydCXC6fE9nT1DXK6lEPDHgpMChT6wpvOg3DdqEMJEyTxL9Yp6Ak4bOQBPJJnvJMxZChe0FYVCPhqfvgdbhE7zkQsnfcH8JryyHxCPLih3BR9sbg25vvN3jvPuit7nTHw3GfGtrY9AfDHD1AiIZsuBj+ai59I9CCSNTlmvIu/J3gTssB90TA7T4I7nmIzYgGk/Q/znI5efOxQz8Mszq4KXs5d4J6+2wHLBDReN88kAJKr44gxH0Wz7CIUzpILknfGzkRKpH06OqCtwz9g9eDTGQ16PTg39fHJzBJ6S1Ar6GCrw1Q7cEVsEXpvqWOA4C3MKObEVOcCdhzwPV5yAQoKjlidJ/szMLygTfGnMILXgjrP7IG8uk2djoohFKqd8C2TOZiGQdUAGMFdylUzbiGPta0fTnQ8A6pYuPgiafI3bJhFlL2DDLJAoJaAphGcChgs+AEONZVicPsFDlEP/gTq4rxyC3yFQ0bbFQZdMai2RytGwUDA7g/PN+MkxdBcyRmMtROPeWwGKwD/DsNdfk7nxJaaTSGexPKUjhkZg2BnctwMmAXS0L6QjNZSHxqHrePGMt50hKd689M/tO07OUV/YJcXeSc4TMKNr8wY0IwVfv9ZCNyBq1mUJGCtCOXg6z5uaqA5+NpcizNnbb2G1j94mx+/BhjXvCU4I+m6vQ50KFUgY3zxXoY8h7lK7rnd8J3gRDrmNFFCDST2/OQ9EkqYDGOuUb4iO/la8wP5zbw4+PGvVmwxbIIOnRS4CFsch2ie8Fx6Qor6qt1dVeaTOS4KDqEYgIWdOwma4YB5XNGxNQBmdaWCzPsUwPlbvPgB7Yxr5GbZFkiyTb3ajdjb6b3ahFkm3strH794zdTyLJOVcULQEn2aoouJl5TwvPUVrOYMKiLzkPOTLVQ7SCxNgcY0VN5BCNupujzfFOKnoZ72XbW4NxN93u8v7O5s7mqNfdiZb3+stFHM+DrBlTS/b2diQVA4i7ARxXKXAu67TOmu0/UK8R44p+ellAYvzVCFR6vcCOvVXs+It2IBsQBuxoPtJevDg98q1bT55+JaHfazBofXeafvFBSIk+7H9CaqFjCx3b7afdfr6b7aeFjm3strH794zdL4KOvc9Bx94XQMceQ4g1Roj1Z0LHDHAHQrMxGAVkSCtQr0LYWIIo9eGUpRMDZiLcHOg1UGR3sIoiz7Vmr/EsUABLttGJVAt1YXqDuQUdjarnwgTOJpAiFYOsJQHdolfhsSfApHj8J5eFpDhGgYCumcXDsQOpfMzU/jZfxR/LgsDBpJBrf/zplks8jDRG+AcUqA86gUT9DXucwVp/qB/MTv2RMJCYHXxIhcCYn/d/+4+dEjgE5g2mizNv648cF/A9c66gjJifJJtD0Baqt1C93e7b7f772O5bqN7Gbhu7f8/Y/QKoHtDQx6E6THgyVIe5yQabY6lX6Fz/c8ROoRI4IPdmOiWsni0wOOEKcCVkqNTUaC05ntiO6uPjkEw64UxzhMe8ERV6hiqTw7z6ZPod2Ansc5/wUib1oWilb+lo+giU80jewWOmPsZwAh4mDyVGQpo1Ep3XZzoi7vVMsqCb1qffP0mZztuCAWdQfTBPZh1PEwdHomFgsYQq4gdLsxNynBX5QK4Lk9//cVk8oY/I8pj6PrkazGfA6QMRUYTrxan8M4TcfvWVs/mLbQSb/d2VxY5xWpe9FNzQnQU8//Lspzfna2yCQJMCvfK3IiRWBhAqJ+AilMiG9VkQfIn2FqOryZQYHzZO22DgsHEOArMrdSYEu6zv4vwCGf4UUjKpFF8SlAUe3IsQNyLHze/BnQiZqQ5oqMMb763RRkcVgcTbKIW/TnGlYrYvMf/gtRCaE0SkAo9dlrVcfEmur2XiHzW12FOLiZpde8CFV+1l6k9vpxC9/oqKJW199eKeXrxED8snGEGqD3lATQQ+mmek0tpqX81Hg16M9Jp8XKk3Uwm7aPM15pMWs1O6c3XI0qnWVvyTMXQdDIPLSQVR9NVs3eKiMUVE3N1YYin2S8YyBkxI/B3N7/UwPsI9mSCJ9t0RCslfybIQ87/SrYpfGzLT8CVsnTgz06n9ap5xwRgXjH0OsIF/vzOhY0FsowyUB7wD7C3sT5kgMLqU9zytR7M6ke/QO7g1pMAqUbHlrv+yu0hw4ROjBzh7PgfSMELq+akxvFsUaOH21FBW3Qx4qMFVfnMNu+IDvXl+5z9p4k75V5MXJR4ueibHKp996yz9kUzy18m7f1LGazPN95hpAsjF3uPp4qbhQV2OPLgZePn5C3nXeK0MnJeECLXFcsi8DOhvtSNIF4MF/IWnFPmEzqH28XcwERMtEypz7jBGKEekUymol1AK7hBJrqOf6oLiOsBzqBiJ0MTAHEgCFhAuH8kc6FG3u16ZU/h5mIpegt9tFc5e1LeBE/YGyjuVgpGxtMNTv/DsnQ413hnY+YRuN+/XrgMQrigqhVchge2qwKvHn/OvTNq08mkQKj0lal1oApLzt+qcgI6LIiRU5JjCHo+xTQ0V8JIbfWYt8CIbetSgerSiv8AXLQQ5rW8Gw7xmEfA52uC7Md7AxeIScrjAK3mLFV4fnq9QBGIq/DCizaQTXrIdnAtEsNjy7rOVbCYbMRUfMI61GpTDS8TD3VCAqXm4o7rs2Q+c8W7Ro2+vrrdX1/+/r64HYIUVcafEHi4GWOUrdN8MuYwWzRDfZqV2CBTYU+yZwPO7O2zzYX/gHodho8Ee0uX1ovTHb0DXt/uof/JeYJsp/L4Un88IJ4Z+0uoPZ9iR8G/4FuIn514vtXVOjrGZGo3CBfvCd6gMv4VB/LsbXcE/+KJLn/RgEo3fRXW/F+Z4ujUgfwyPhg8o5v39fwGBRJsi +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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). + +A token with ORG_ADMIN or HELPDESK authority is required to call this API. + + +## Request + +

Body

required
    = 1`, `<= 250`"} schema={{"type":"array","minItems":1,"maxItems":250,"description":"List of up to 250 identity IDs to process.","items":{"type":"string","example":"ef38f94347e94562b5bb8424a56397d8"}}}>
+ +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/start-predict-sod-violations.api.mdx b/docs/api/beta/start-predict-sod-violations.api.mdx new file mode 100644 index 000000000..7ed173ee9 --- /dev/null +++ b/docs/api/beta/start-predict-sod-violations.api.mdx @@ -0,0 +1,121 @@ +--- +id: start-predict-sod-violations +sidebar_label: Predict SOD violations for identity. +hide_title: true +hide_table_of_contents: true +api: eJztXP9z2rgS/1c0vB/u2gkECCEhMzdvKCEtdzRwQNrppJ2csGXQ1dh+lp2Uy+R/f7sr+RuE5svduy99ns402JZWu6vdz65Wsm8rfiBCHknfG9iVk4qKeBiNQ2FLK5r69jvpu/RQVfYqEV+oysllZTo6ZbkHn/YqtghCYfFIAIkojMVeRQkrDmW0hva3lQslwp7vReJL1I2jJdKQtneifLt6ndA5CQW3K5/uiJqyQhngXeBotpSKdccDBn9iJWwW+cxaCuszkw5bhNyLpLdgyl8Jxm1bYi/uMm5ZQimh2I0fuzazOHRl0VIwFc9/FVaEVOaCSY+lHDDfYdxbMxQv8F1pSaFqbCKiOPQU9U2b4iWPDG0gQ+Tt2kfvo9cFyp+Fx25ktGSjyeur7unbwTnzQ5KBg/g+6gWlCcV/YhkaibjrAlEtag2UjQ+Fil75NujwtpK0TfRroTq9CB/xIABmia/9XxXq7LaiQEMrjr+Kyux6TNrQDzkgDjlTIiLJSWFGLaBIGGovNyrOmO43wAe69UQ4NP3ROhBA3CfNwtMgRKOKQH/IQa7jFj+DhBlpm6FpakGXlZSsikKYYbgWX/gqcPFW0+o0juvHh+1j67DZsdr1BvyyeNvp1K3GQeOgcldgcWvYGUymKxUJTgy4YgV/SXzQrAKWQ+bAnAW+UnLuFqYebIYzsPdr7HltOM7xy8OQr+FSRmJFY2+qp8hLPxsfSFtubKM9w7wEwpKOtIoTVNtSr6Z+u6WtnaN8p9jpbMSwPVITXrzC+e2fzwazYf8t/MU5zZSdfwB6lfZTRxuc1u6Zvc7R0YEtxEGz3miJxoFoNJv1Dl3gKB5fPVkqW6rA5WuGfYsj9s5/yE1zrdWpC8cWh3ujix9G4aLn44+pCK+lJU5FEO2d9n5483P3FP+6Prhm5e7uLkfvMuUrrxutmsQ2j9rHTafDj8k2DzpW/bB+3G7weaOSCIdcDTywspWGny5NMLISgeMnf6tK84W8zOC6wNXe8xjpWMBIcycjM2EtPd/1F+snMfMJdURKzjn2ewCZc3GjZavklVgEhodduujR5RTsmAKchFCoAJBK40OzXt8GwDR8MxOXMb4/P6ZoaEPojLj0NH4hvuIvgC6MnRhVs1ALwV4hltoigo4QAudrHf1SMM2HHhMLwU4eDDbpEKlcGYgkwFxkf2jiwL0q2YnhxVEpXaA4DWF85OTNcwfqp0nG+rmInlG4F87h8dV4NBz0PhTRPHf/kWCeG2gTyetOo+E0eat6ZHVa1dbcOajy5tyuHrWah8d1RxzM7SegeW6g3VD+KlbSw0wFW4+13vPAA0mrvnsa+Xnv3DFzu3S9S2G7JMnad9m1CNfgC76bSEOdwDPvyW0FTZxCA9QcKshQg8AP0SkwA8kpJctBdtvMk6L5LnYybh7HDIEOOL8DT9DnNYz2IM8VoSTE8GLX5XNkwOGuEg95sSucKN/9660t0xI9+dHuLr5Ygu6xpHuNgfyhwMycs5Wk9UADVgQ2W/EveHFYZ4QHmAFGJoOs5UFit/M/0ujM5HV7vdHF+eyqN5pM+sPubDA6h9/nZ4PX0Age9qfTq/FkdDYY9rMbk/7PF/3p7Ko7hkfvukP9BOngr/EYLJgowVWv+3bcHbzO/7wCYrP+BO/0J7PBWa7x8GJqnozOz/u92WhyNe296b/twq2iNb0evetPzrvnvf7V68noYgy3BqfU5EPuZ4719JZhHm4NB2f93ofesH81nXVn2GjcnU7fjyapF+5VJiPqPbmgPzkHxYuLSQ/vzrqv9f9XIEn/9WjygS6nP8FY04shDjXpj0eTWXaNhN4NRsNE8mQaur3Z4J2WAfj4SYu25csQBnH+zGI6CXupdwNG510bF1/GjJJU6dy/ActyQg72EFuw6txAvpwqE7ADjJuhDT0SyQenCVt+ugi+WUprqWNvKBywf8+C9R+Gf6GevOZ6HM6/iVfcq+J6HyGhgPW/gz/IoN4INzgV6vPTEjigoVOVHOdzQG/BvS3W3y8FsBcWKgnpgpq7KNOaLbmt6wNmTQ3A6flRnllcwyNmbliQbp6JqVfopqiBqjFssYRj5rh8gVqSno3pGnTJMWiGv+EKOkTci3KW00/gL4HZJEN/boy6zleK/pzYRDrO24X9jHVau91ot+eH8zrYc6N9ZB00hXPQ4O12JW8YNGGPSfV3kTsqkKMgWFwwbU0IWmYoF8syEJaBsAyEZSAsA2EZCP9PA+F9TzfWmPk27zZqQFoZW0/NLhdqVZfNWvdVynrgX17E+mEI81s120Ew3VL7pylNgUHatKcjvWvuStq+eHQ57esx0hYRl27Ptx8BKGfSE9VFyCVyKIhlCzoyoHgtaV9h5UNg1yQTiKF2RYQFTdQa7BW478TI1zPCoCJDbn0GWoNHAO2FJ6E/S7rgNg/6yY5hxZHg83a902w57RbnzeNW4+hw3nH4wUG9c9jp4OgrmHW+EA/X9V4LDyzDYoRu8jdQiC46EgM0+OPre0TjEfqnfSVqm4pp+GVoiHuQT73qjVnriLncW8R0ny82lOBVL6ZYGE5LJtrnDBMjyAml97Wk6bR/1k3iukkmkNZ9cdqgJbAKtrCEsBtlAiBaKuFSebbGXhqqL0EgbrZDTUOpr9RagTLBthweuxH0MKPf0yNPmjmhvyq4kqW9ln0va6K2x+Z4b8UjCH5zjvu/vs4WXiICBFF1aDT5ki0h6IjwRY11s31g8EYgCv3X6b5mkrU6MaYWFFv8OMLIBJGxOBeZKouzkaHJMD8p6ByINw/aSReyGmCOxMx7YWothsUkmtlGc0XuZjmlkUrXXsQB0HAvGQuQYYjBYQ6ySYhUBo5wuhQAj5e0SxGrALPIzVvNDBVSscCHm9wP+93YBfipkmjpg2uRVvwhRms0KmzXG0SCh5QrYmfTKp2uxPGZI4Vrl75b+m7pu4/03c2HE7M/aJ5S6tPYTn0uPHNcBYPnVuqjCwSen5xp+U0v9/RE7mGub1KkH9/PzJkYifl3gLt6f2B+pEP59q5kOh/6/hzTj3SyCnOBDJIetQQOIJGwT4jvjGNSlFbVwfZoZ344l2Cg3j0pIqBmyNZ+zDioLIw9vT+q9pjtC+V9F8Ey6Vrkzt/QEk94djXwpReVmWSZSZbRqIxG3040KjPJ0ndL3/1n+u5XM8mUK/IWkyepeLXi4drsC+jndJyVQQOWnFRjqcvRVG1mK0iMpTlWpZg5VObNxrzhHFmiZfOW3T7oOE2r3eSHR42jxrzVxIpjFusvMz9OnazoU7n51vNIKsbKOeRxsQfGpSLft4vlP1BvKByENYSeNG8GndfMsTydO7a2c8dzPwLZgDDkjuGO8uLFZKiru5o86s2PQ0tgmp0vAmNKiTasC+Nl6limjmX4KcPPNxN+ytSx9N3Sd/+Zvvuk1LH1UOrYekLq2GKYYjmYYv2VqaMNeQemZg5MCshgxaBeD9PGAESBX6b6aNw+4uFCRGmiV8gim517XmnzffYWX180yZIqVCK9TF0Ib9B2hW3DpC2907YAiPQYoJaE7BatSq4E5qR4nMKVK0l+jAIB3XBd7ToRSKV9JrG3dBT9Jhs4DoKC63t0OOOGSzAn4WD6BxSoDroAoP4Da5xmtn5XPZhNUOIhSszwvIFAn0/rv4f3nRIYAPMhwsVUz/WO4wLmUJ0HywjxJdDwlaagZapepupluC/D/bcR7stUvfTd0nf/mb77hFTdZEO7U3Vo8OhUHdrW6izNpc7QuP70jJ1cxXBA5s18i3J1O8vBKa8AU0KGAp8KrQHHD5tU9gsfNVH7gT5kWsEvomBmqJmKQxfaLqMoUCf7+7cwVzBHdzUeyFpyiNrzb2qWv9qfg4LuwR48aqr9DBvQt0X0ADXSbijRgDXaEXGta5IHTRV0TqcLvko5OYe+hhUI02T28OixMSa6DSwGsJL4TplXdVE3W/KBXBehe/f7ZdGEdshyn/q+Ohq0Z8DphojmRd3kAzZTTLv16FufsclCCRb8m1uDjbBZk70SPMST6HQG5vsf389esAUmm+Ts+DrzggmJqwNwlzGYCIFZNzkPgp0ovoR+vFgS493CiRt0Hua4IDD76E2FYJf5FykmAMukUuwkCAmw16fvk9mxxbVwMQDWMk2i4Unb2wcN7fNCvxcU7GhVILPvFdQ+elV2KhGD0OqpjRFRfwzgMkjk4jm5nsvEvxJqVU2tStTUiw0utGovLX2C2wJPRBLcVaStZw+u6VVz9Kr0GaIqUt3kATVh+Ciek7KSWXs2HwV6VaRX5OOj955eGSl2Yxq4mFrSx4sGzFr6vhL/ZgxNB93gchGDFz2bLXpPpUoeUW3WcyxV9ZBVWYW8kPgbgmN42pj4HOMypSW+rpCQS/5CMws+/wu9f/ZLQWa6fYnvp0FL27fUs3nGAas4YFVjgDL86+iEhgW+jTLo1+zIAHrZ/BMSGEZzuKdp3YvqRH6f+mBosIBVoqKCE31xkgGc+cXoAbZO2wAMY1qdnhzDb0gZWhiiCspKCgKbGtzm1/UhMm7oTfObbmtitPy7yYsSd7O6ychz1380Su9Akr8P7v5FiFcizbeINCbRxfrjJPsYXb/8ftP/8vtNMDCQoWne+JIWgsorkx9v10311w3hf3iq9IuQsIaBFaJ+dxKzxjyhANYnyC2hqLWUgiougeAR5tp76Mn+ipAvCP3kS4pIaBFCG4BJBfzyuXSBHu0JJCNzAiidyKMf4XXuk4vWElbwosbewyLYs8ANcAGMZ6Ph2a++WQlPwRPG6EjsNHEuSHJXq9jDl0uB7XjFOLjwAx5oS2XFKvmmnycSXfiUaqe9EtRE10YR6Et+IlypkWM+CZdztAfGAj9LPqQFqsdZNOaRCTIR2duhxWXSQ7TBu6tL4Qa4BIcoBwmvyI3wdjDbogjEPLN95IeLfdNJ7WNbIILLUW0+B7VGrV6l5RncxxXtins54uZVyY33WykkJSBQ27TJ22xD4//1G54GWHDBuB9gmRO1G+sFrK4XXFaK9QKqRuqKAaxBl1hagDa3t1gNwyX0Hd4GLMZSy+WnbHWMV0BbV8UIXT8LrMaYbZgqvRyfll2295cQBnUPXWn7attPuerHeEQfK5ibz5SudCEn5DdwE/8/qXyEf3DhB1pAaET3bytJWRTaaLpJznpfymZ+oJh3d/8F8ze65A== +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Predict SOD violations for identity.

+ + + +:::caution deprecated + +This endpoint has been deprecated and may be replaced or removed in future versions of the API. + +::: + +This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused. + +A token with ORG_ADMIN or API authority is required to call this API. + +## Request + +

Body

required
    accessRefs object[]required
    + +The list of entitlements to consider for possible violations in a preventive check. + +
  • Array [
  • ]
+ +Violation Contexts + +
Schema
    violationContexts object[]
    + +List of Violation Contexts + +
  • Array [
    • policy object
    + +SOD policy. + +
    conflictingAccessCriteria object
    leftCriteria object
    criteriaList object[]
    + +List of exception criteria. There is a min of 1 and max of 50 items in the list. + +
  • Array [
  • ]
    • rightCriteria object
    criteriaList object[]
    + +List of exception criteria. There is a min of 1 and max of 50 items in the list. + +
  • Array [
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/start-sod-all-policies-for-org.api.mdx b/docs/api/beta/start-sod-all-policies-for-org.api.mdx new file mode 100644 index 000000000..829cd5cda --- /dev/null +++ b/docs/api/beta/start-sod-all-policies-for-org.api.mdx @@ -0,0 +1,88 @@ +--- +id: start-sod-all-policies-for-org +sidebar_label: Runs all policies for org +hide_title: true +hide_table_of_contents: true +api: eJztW21z2zYS/isY3oc2GVPWq2X5y41iOz13ksiV7csHx9NCJCihoQAVIOPoPP7v9yxAUqKkJG6auWs7msw4ErnY9108C1IPgV4IwzOp1UUcnAQ24ya70vEwTS91KiMp7EttRmYaHAQZn9rg5Da4Gp0xd3MZ3B0EsVgYEfFMYHlmcnEQWBHlRmZL0D4EN1aYU60y8TEb5tmM1stYnVgdhx+kTp3kk3uQi+Du0bGzkZELugx1xrmybJ6nmQwXTiIzYqFNxhJtWDYTTJtpg10kjLPafSzSRoCCK9ZrNpuskmUP3LqCzVwod5EoM3ejImSpnMuM3XPLxMdIiFjEhVRQemFOsuf2Wy5sxiRo54tsWZNhyAZaydPUL4RTG2wEEnMvrdhNrFW6dDcSmWbCQHhhYCohaGH0BwmNGu/UGLKlEZYZncIfCRuNf/h5ePb64k0DMSs0e6FjhOPBfQUxQpXwFKKDiEKjMrrHFwsIcLYf/mrJ/Q+BjWZizulTtlwIBERPfhVRBsbQAImTwRS6Wyrp0+IVVFxbw43hy2AztK93RPVewkUTQV4ofA2POoNhl4wtmCBR5naNuc2MVNPg8fERCSqzVJSsvSpjb3+Au+Ijny/o/m51b4PJ8dFxFHebYZLwbtjtdPrhIGr2wxbvtY67R1HCB11ocNThzT7vT8LOgMiOOQ8HvaM47DWj43Y/FhPe5shlpxHiskB6eSe1m036byPDRQJNVIRk1RsJuEoJlnH7nsL55HAh10aJK8DNwNXFUy0XMdgWLCwc2dgKtue4GYHfz5mdXY8YMSERQuVzCsL4/HI0vv55fH518+qa+ksVto1b8K6Mv4kaF2dOgUpOOxq0jpvHnV7cGrT48VGz1Yvbx91eb9KdtDsILkQrPn+CD/6Vz7kKjeAxn6A4aRFlMoX5aY5fKbVquqzF/l2uCNbTHm177BiM3fqzTEPTL1UuGn6W7yioLT86OtKef0739VBe3Zyenl9d4crb4fjNxZsf8Ol8PB6N8f/1+Rgdanh9fua+vL78ubxzef7mjGhroS8voqjuVgavW1vV0Uapl/ZVLA5KQ+vp5LMp6PQnnQliHCadAYr7KDkOecTjcNJrtzuDo0HCj46DMvy+0bCfcmGWzCsT+Lrv7ir101Sidtm5MWhtIRZkuVFo7LK+iUzQq2knkeoDT2X8u8r+87GORcZleqrjJ6TuS6lEODVckobCqRxhYbHzYIXfYT3LMqkdXT1v4YlGi73gMStaMTstjKHMNTx6D14XTyjkGyWxnpVLsB1UIGCHWNEXfHLUHLS7yVGXc5Rvq9+bIHydTnPQGwxI+lxYy6frPe0TW9UPQgkjI5bqCBH5DxyCkobvnQJO+I6N6RMxcDye4P9r2OVpKzMLfRlhqQOU4YvTS9bts5Srae6u8+mGE1R4Q+Wn8jSlBuQBGiz3jEdGTqXapUpZwWfnL4e+OMbnP92cX+ET8dqCaUOFbI0pLQm5JGym753GhQGEoaxI4Q4gFva84PocBnEHvSpC6b/ZpYUzkVsJpz7InhfSd6xYZ80So+e1Uoo88GTfy4ZoHABZ4NqcZ9GMTbjFAoSQyJ8Po0gssvBV4cnnbIaWLcyzBhvGsSQjecpQjWCK9UuCKDwmQCg9gyRHKUMZmc10njGlMxmJeixWrqxHY9XNXq0HhYoDmn85T4ZRlkM5Z+Z6FVbZUqhYxAc6e8/Vtbtec5pz6VJlPIIVwBFLuNEA4qMzwTYJbF20IwqXReNRJV3VsdZ3JdfuXntl3JaEexHP7RPq7jJF+wmdadWND6IoPkuAqcDBFI0yTEVHKtCUW1yi5dIXZeEDW4s03tfuvnb3tfvE2t28OS4GnOKugz6tbehzoziGf23c5rkFfYzLHqVZSeQRpQ/kAWb8EiL9+PYahf1eKDdpf1zQKPsN8ZHfyreUH1bx8NcnBD+qYNViQQo6P3oLEnQiEZ84vVcaO0d5V3W2pb3UZiKRoGoHRETXNGypc8aNG5IVacLtAYu1sOq7jM04+iNHRVjrOyBJVTHGbKmyPZLcI8n9brTfjf4+u9EeSe5rd1+7f83a/SySrLRy1VLgJJvP59wsfaYV9/2BJAhYedTOqpJzodpEK8SMVRgrqCOHYNJuTVpJPxLdmHfjo84gaUdHbd7rt/qtSbfdD9b3+ttVHVdFVq+ptXj7ODoXA8R9AI7LFZLLZlrH9eO/nA6AE2pr1Hoq3Ayfw6V3FXZsD7ax47XW7DVXyxIh2RqGVCsfUU8D7ZxoTUkLAs6m6IuKoVVJ6EWpJOcCXAySxj8Ro+IlK8DXLMNhksEUXyhlklVSpIrSHBq6TpBqQs0aiSVhpEjc8zmzdAh2iu78DdFpEaI/hOTZmCx+5Z4BnpfP/yrk3tt1vnsB5Q31iCsf4E8c9PpphyskAAYC37Mq3LnH53t8vt/j93v832OP3+Pzfe3ua/evWbu/A58XaOjT+BwET8bnoG00WYWlXlJy/c9huiuVQgOX3kxHUW7ccXOJwR2uQCqRQgttXRPh9IZbcFh7uy30b0YcmpzGDQ/+vVq5SUE9y7KFPTk8fEC0EKXHBl/IBpoYApYtlb5vRHp+OIGLdnQfek3AVxoRsOHlRTFdNJx/jaQU9v3OMffedhZRssLr7mT4s5zLt1aWOkeHc2wO6LWdIp3cZai4wCzxnXXUDZc+W/bBrhuTPv5xWzyjT9iyy32flQZ6Bk03TCxeNSnfZbwi4O2lb73RuNpMaFhrbwkbEVmbvRDcYCrwzy++//Ht9TM2Jbjpyj23hHSFpPkABXOJFHHtbFie5dMit8MYnU9nTvFh7WkJlQ9LUhjM3qkrIdjtReGEN+jzYzRm51JaJFwvoFV335fRicUHkdIW2Fh5khJPxuoQHjrktXXP3Hbn5gKp8HHurjbeqZCdSepC7qVKoilMdGMeu12UdvE1u75WiX+U3ELPLXTc7LMNLbxrbyP/9k2EGiYWPLXOW18t3PML1/jREIUrxHVTB/JEoUf9GVdURu2r9ajxC4lfXY936u1MYi+tL2O+dTGLrTCN2QWLZlpb8U/GKHWoDG6nOaroq9W6J6Ghq4iw3VxTKfQiQxkCGTr9XqEwlE8mPqGd2QETDcymYl+Sv7jIouZ/wdwcs19qNrvLt9hAiTLWkf1qnUlgSAJD3wNsob/fnyixUNtkg+sDPgFOV/F3naBQdK3veV47u7pjf+jW0NYQQVX/Ut7ixH85WTW44hNzN4i6okEbJmBdPfWj94wLXrRJ1ZxVHglsenBb31Rjb9zwm9e3OpKi/fLPZi9ZPFydnIxUuvzWXfoTneTP03f/Tx1v32n+jp2mgLp0Ajle/Zjg/Esv0xeD0B29po1MdRoX48R6fbwooN72ISCdUs8E/uKuK3MHyDHuuAHOAaB1RguAbSoI1xCimRTu+GAheEaw8YCSUs9dEWPSp86BIdExmhrQoOIt4CyfyBT83AF3KZm7WvOYlFKCvtvczTAkK5phHBUN9hYTnYoQUZrm6BUN3PtVF2PdFYJ6STnBzso8AV6bz3MFaVTS+ZxxZOMXkimWNsp9z8Nwp0TpC+1QY7WqbACUpWRCw801Zm5HCZ1MY+hdy5kvyELK2OJYGq6nKBavPq8MGYvilzWgqyP+L/FGooYzkS5onkTuALuJNQmvL663OIKZsrALc7s208NikT0kWjChycqnT6fRajRDN2ngOo1nmIDXmLsfFq3/IMf/6MZsje4PqyP5/a+R/uivkYodmEanwwUd+VFwcj/K+dkZjWPH7IylND1jHptp314eHuhsiMbJR7r8G72Cj+t3q0mRvoG7PyNy4/Z7QWcTxUOJ8HrpYEVxCLH9tIUGWL/Cnzt9lvZu7SzgckQncMGk+MnV3B9rGH5PVuDvSfAO//BFL3zZ0O+y6PpDUB4SgsbzLfHbLvhSfCAzHx//C3bDggw= +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Runs all policies for org

+ + + +:::caution deprecated + +This endpoint has been deprecated and may be replaced or removed in future versions of the API. + +::: + +Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided. +Requires role of ORG_ADMIN. + +## 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/start-sod-policy.api.mdx b/docs/api/beta/start-sod-policy.api.mdx new file mode 100644 index 000000000..ff69e86a7 --- /dev/null +++ b/docs/api/beta/start-sod-policy.api.mdx @@ -0,0 +1,100 @@ +--- +id: start-sod-policy +sidebar_label: Runs SOD policy violation report +hide_title: true +hide_table_of_contents: true +api: eJztW1tz27YS/isYnocmGVM3yxf55YxiOz3uJLGPbJ88OJkWIkEJDQWwIOhE9fi/d3cBUqTkW9LMaZvhi80LsNj7fguBN4HOhOFWanUSBwdBbrmx5zo+06mMlsFWYPksDw6ugvPTI+YfftgKYpEZEXErYI41hdgKchEVRtoljL0JLnNhDrWy4rMdF3aO82WsDnIdh9dSp7TcwScYLoIPt0Quj4zM8DHwcDGXOZPqWn8UOcuMjkSeSzVjOmHVbGZEpo1liTZsJq+FYshgRgx22EnC7Fz4Wz80ZwttBDzniu30er0VrXyLRnuKRtjCqJx9knZeWy+VC2mZ+BwJEYuYLYAnPhOd92oifiukAU6NTgXyeDr58efx0ZuTtx1QX8YNXwgrTE6KkShfxkElW4GCF3AnY7jOo7lY8ODgJrDLTJAdDIgc3G4FxtGvFL2uK1GTnJ0cMauZKRSuLT7zRZYiNZFs7yej4fZwT4yGO7uD6c50uj8cDPnO7vZoL94P0AggQwbKEDmyMej18F9zsYlIhBEqErgIqmzDHLAyszz/iMtH6ADKIhmeZcAejez+miOtm5rIPE1PE1KPF15PfxWRDdZlrcm5ubDIi9SSxg16tJVODkdxXa1fTpkdXZwyJEKKVcUCfXpyfHY6ufh5cnx++foCw2Kl8eYrMCOY+VuwcXLUtOwgGvX3e/vbO3F/1Of7u73+TjzYH+7sTIfTwfaA49LO0R5b/D/FgqvQCB7zKTgyTkJvtk0He0DxK6ZWuYL12f/KGcEt8GKldUN0PCECE5p/ZDVwuukATWNCcrJF/gQ90jjknj/Ee92U55eHh8fn5/Dk3Xjy9uTtj3B1PJmcTuD/xfEEonl8cXxEN2/Ofi7fnB2/PcKxDdOXD29vMapKgevSVnGE1qkmruSrSGyVgjbdyXlTMBD78T5YPxwMp1E4jAf9cNSPdsM9niTxdLi3Pe3FqzzjlBB+Xv6OnMHCw7tC/DCVELPs2BhIrCGbUDKEfCcTnyN/K0Ru2VTHS+ayNE9l/EXh/rCNY2G5TA91/ASXfSWVCGeGS+RQEMsRTMSacS1jLBmU8h3J0plpXNNfQROdPnvJYzbx8h16YdBjDY8+Aq2TJwTwpZIwn5VTmIypQN2zrNgTfLrbGw2Gye6Qcwjb/t7OdJTw7e3eaGc0wtV9nak7PTeGLzeW/lEoYWTEUh2BRX4HhUAog+6JAVoc3caKRf64DYjGE/SPxceNrcT0/DIs/VsQfi8Pz9hwj6VczQp6zmdrSlDhJYadKtIUE48rcyC5I3xq5Eyqu1gpI/fo+NXYBcXk+L+Xx+dwhbQ2UMVYgbfG6JbAKvjCXH8ijr0An3jOcpGCOkTcYS881RcgEAcwUBso3V2+zEGZ4FsJx/zHXvjV75hRJ80SoxeNUIocTmLPZEd0ttgUny24jeZsynOYACbE4S/GUSQyG772mnzB5pCqhXneYeM4ligkTxlEIxCF+UsgxHiMUEU6AkkBoSwI1ujCMqWtjETTFitVNq2xymKv60bB4ADOH/eTcWQLYI7ErEdh5S2eRW8f4NlprsndRU1ppNKlsjwCKQA/LEGNBhApZCaQTQLY8+kIzZVD4lHluCpj1asRpbs3jhkqRfAu4kX+hLg7SyH9hCRa9eJa+ODLESi5bETWKM3kM5JHUTTZj6rMVQY+S6RI4zZ229htY/eJsbv+cuIbG/+WoE9/E/pcKg69qjZUPDegjyHvUZqVgxySdIbcYqAQD5F+encBgf0ROlIYLz5n2Lt9Q3zkSvkG8+PKHu75FOFHZayGLZBB0qOTIIFMJOID4nvFMSnKqWp7c7VX2kwlOKi6AyJC1jRsqQvGQWXQDyrkhEOPHWuRqx8sm3PIjzzCrt5lQFxVxWGmpbItkmyRZFuN2mr0/VSjFkm2sdvG7j8zdh9EkhVXFC0eJ+XFYsHN0nmaf+82ImEAK7fYWRVyZKp1tILEWIWxgiZyCKaD/rSf7EViGPNhvLs9SgbR7oDv7PX3+tPhYC+o1/qrVRxXQdaMqZq9nR1JxQDirgHHFQqcK7dax83tvwI3fhNMa5h6KtwMOgeVflhhx+EmdnyrLcgGhAE7mnu2Fy8nr5E+LE3kUW+6MJFAmO1Uh7/jWIKU6MOgaZnbFjq20LEtP235+W7KTwsd29htY/efGbtfBB2Hj0HH4RdAxyFDiJUgxPoroWMMuAOhWQJGARmiAtSrEDZmIApc+d1HH/aWm5mwFdBroMjBaBNFXmjN3nC1LMFS3tiJVCt1YXqDsQsca8qxMID7Y0OQtSSgW/QquRCIScF/3GkfjGMUCOiaZThOLEjlYqb0t2oVqaK0AA4pKaQa9141+JgEdxIJHTsyS9oHnUGi/oZ7nN5af2o/mE1Q4td0vum4PN9U7f/u3HVK4ASYN5guzp2t7zku4PbMuYI2QnzOXPqqIGgL1Vuo3pb7ttx/H+W+hept7Lax+8+M3S+A6h4N3Q/VYcCToTqM7fRYhaVeoXP93xE7hYrngNyb6YiwerzC4IQrwJWQoUzTRiudYT8Iunikn06WQjrp3sj4tludsg3dKduuKXAL23UFjsnCpDB3bm2WH3S7N2A7sNlth2eyAykNzGeXSn/qRHrRnYLC7shFePTUxR0OYOOzE992dEjbRqJDu+xHxJ3uST50XbABnTZ4kHJ5AnoJHQlzZLbwCLh3LnoMLGbQWfyQ0+gOOdOGfCDXpUlv/7wsjtA9stylvgdXg/EMOF0T0R9bLj/nOEcY7lbf+KhjVVrwB4DBxmKnOGzAXgpuoEdwZ2Ke/fTu4jmbIfik4C/oyw4hsVuA8DkDF6HkNi7Ph+AkqjdGF7M5MT5unMDBYGJJCgKz9+pcCHZ14pXwFrL+BNI0qRQnCcoMOOvDs9I6sbgWKRbEzkqT6HgyVl3QUJc35j2n4kddglRwuaCnnfcqZEcScxJ+TuI+SnEiUtPHrrJSLl6T62uZ+FdJLXTUQqKWP1/jwqn2KnInuiOIaCTB05y09dWLO3phjR62VPAEqa7zgJrwfDTPTUWl1b6ajwa9EOk1+Xiv3s0lVNbmNOYSGcuhMKYxO2HRXOtc/JsxdB0Mg6tZAVH01Wx9wkVDiohw0KuxFLolQxkCTiT+XkNgKOdMfIp1mmCKdjsmFJK/kGUh5n+BLjpmvzRkpsdXUE5xZKyj/Kt5xgVDXDB0OSD3/LtqhY4FsY0yUB5wDnC4sj9lAs9oLe85WndmdSLfpTlYGiJg1X3gkR24m4NVgvNXjF7g6GoMpGGE2dVJMrhnnhaWrIayyg2CdQ1u8ptqqJRrenP8Vj9zYvX8u8mLEo9X+yinKl1+6yx9Tyb5++TdvyjjtZnme8w0Hviiu9GyvkOoO/lLj9c29/Vw43ku4C+8pVgljA0djPusFFFMnVAGiBm9mqI6mktBOwKZ4Bax3xZ6ll5QJPrPYYX/PnVmYAyEbQ6YlE9lCvRoz7pcmVPAOGCJdsX7vPAnKDS4JHSYosPeQZOmIjALNmh4dhfe/ap9p3YOljlDw7Kj0tgAuhaLQsFqGJfFgnFwqUc8IpZ5VLjEBf2aEqUuNEG/alYZxehqKEKHWhWzyE8T3GyGPrZm+EfWArvnfqcZVI9W9N/CrQSZCP8NMIxrwvbHaIO3hXORZtgiQtYFACZqK7w5udigCMSU/3lDm1nXT8q7OBaIYHvk3Ge70+/0QmoX4Dl2XNDU1ohPCkh2D3zYuO6PN6vN9u/q42pf2LAj6Wa4r4bqKlyH5BrUq6DeoMKUA/rcer1HhUfYpULfM8f2Fqbd3OCODLZtt/j4t0Jgu3/1YdWRUScLzoDX0BgnkJ7Wv86u6/2ZFyV+Tr8p3ffN9p0ilRuKarnaSwjg8qPALQiQCBp1YJ32iIgt98LtItWmbPzOgp1e1dmfneJ+GiGku1CDvwAdQF78A8LMYOg= +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Runs SOD policy violation report

+ + + +:::caution deprecated + +This endpoint has been deprecated and may be replaced or removed in future versions of the API. + +::: + +This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. +Requires role of ORG_ADMIN. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/start-test-trigger-invocation.api.mdx b/docs/api/beta/start-test-trigger-invocation.api.mdx new file mode 100644 index 000000000..fbc194baa --- /dev/null +++ b/docs/api/beta/start-test-trigger-invocation.api.mdx @@ -0,0 +1,87 @@ +--- +id: start-test-trigger-invocation +sidebar_label: Start a Test Invocation +hide_title: true +hide_table_of_contents: true +api: eJztW1lz2zgS/iso7sMkKVPWFSvyy5ZzbTmVxFkflQcnVQFJUEJCAhyAtKN1+b9vdwOkSEk+cuzsJKWZGo9IAo2+vj5A8CrQhTC8lFodJsF+YEtuylNhy1MjZzNhDtWFjulxsBOUfGaD/fPAP7PBx50gETY2sqAR+8GhkqXkpWCclUCEiQuhSpZqw3iWMVtFODiCqUynrJwLZgsRy1SKxA8tHekeY4c0wAAp+E/pzuRSr0z205hU9KAUiqtyB38rnNvi5VICIxHMhYseyGTEnxU8faqTRbB/RZfSCFBFaSqxE8RaAbESH/GiyKTTxe5ni+JeBTaei5zjr3JRCFCAjj6LuAS6hUHFllJYeuq1mbSGWripZjBUfOV5keEtmah9HsfC2tDzFRYa/sDSRl/wLFjVt7cEO3weXO8EUhVVuYmZZoUrWALEkeWCrD3sD0bDSZrwQTweT/pjHvcHgycDMd0bJeO9UYxEuwu+0fEXRuugESoryLikX9m4CljvdC4tyyu4zROyojeZm+rUxhKRSgXWq63mhYkE6IXIfRFJ7QlAzqt0weC3zmVZisSbGGcDMV5ljQcxSyKzgi8yzZMVu183ln3lLXmLyi61+ZJm+hJVNhiOxmtKeXVy9JblvECnXmqB5aLkCS85Lefdt3BIs60luTF8ASvKUuR23T+uW7ycB/10MEiHfBxO4uk4HEfpKOTDKAkn4+HjJ/1UjKJErMPySGULlDzx6GjQUAOpxRz4kmWZtGWt+7aqb0ISElpBOEh9vdPC03kLBF3tA7vgkQQAjDytkLOUnRSDT1nt8peynDNyx8Pa7QEhlViB2wZMCWSgwco3A2LFcda8A8U+QV0Tu6AYjdo/UoKdNNr5Vm7vWnODf93XV67pH7SULbSyTtPDfh//txJsSJ4m0tZWgnA85yWb8wsB7gBopBwCsMbIsAzRbQYf2Ie94NuD601IuSHoyo3RdjVhNXCFGNqOxffSHujt1tB+Y7S+PeqDzdGkIjaivJvsmZIwqx153MzeijzTybQ/HIb9J5EIx+N0GEZ76TScjKYjEU9GIplGf3lcvF5Cvw1755HD/njdCd9q5jlkIRBN0GmEpdjklccuuQVvI4WmFYQozFWUgyBvqOV0QGaEk8rKtJJQDQMK2uNNMHiWSZz+whjw75AdNwTSDhcRVBS4IgjOM5l8j7/f4NcJ6E9mz3Qi7vaNl5Bgw5nhlGcFsRzDRMylFzLBPJtrg8kTSdZFGY3reg9oojdgTyGRHnv5nnlhCAI8/gK07oMB76z1FCZdnLhhWTERPNrrT4fjdG/M+fDJeDB5HE1TPhr1p4+nU1w9BzvzmdiUUrtL/0soYWTMMvCzTP4HFGIEB90TA7T4/WML0biH/k9BLje2EdPzC6n0K5SonD199o6NJyzjalbRfT5bUYIKz07gjqqyjEd4C2tTkNwRPoKoItUmVoSqckwEz1+8PDh7fQp3jl/8++zFCfxCWmtlwoGqEQWsgi/M9SVx7AUgXIkM1IGlwSNP9REIxJVtD5Tuyi4gkuV1YQYz/OobZrRJs9TovAMlws3Xkj2QPdHbAdTCvZyX8ZxF3MIE7aD76AAwX5Tha6/JR2wueCLMwx47SBKJQvKMUdqF2pQvEP48SZbYTyuAsqDKQkPQULqUsejaYqnKrjWWcex12ygIDuD8bj85iMsKmCMx2yhsvMWzWEe8xGuuy93pahRcqJLHIAXUZgtQozGgYQqIsrRNIJSo+xwaJj+uiVjt8Ezh7o1j5nmp6VnMK3sP3L3LIPyEJFrz4EJ48FEz56IRWaM2k49IvkClyX5UY64a+AzqiyzZYneL3S1274nd1YfHvurxT6n0GayXPmeKV6BfQ8lzrfRpKqx6kCv3nCF3GCjEl0iv3p8CsL9AqwDjxdcCG8SfWB+5VL7G/EFjD3c/wvKjMVbHFsgg6dFJkEIkEsk+8b3kOKg7p3F/tL7aS20iCQ6qNpSIEDUNW+iKtrZMpRRywu0OS7Sw6g/fS7mWwEVAXFUlYaGl27XaVpLbSnKbjbbZ6PfIRttKcovdLXZ/TezeWkl2t+99nWSrPOdm4TzNP0dpOYMBzf4bayDX7JO3qxUkxpoaK+hWDkE0HESDdBKLccLHyd5omg7jvSF/PBlMBtF4OAnauf58ieMGZF1Mtezt7EgqhiLuAuq4SoFz2VLrpLv9B+o1IsWwRi9H6roZdA4qbXbdx8Ppho12rdkbrhZ1hWQ7NaRa6ghjGozNcaypx8IAzmYQFxWDUCWBL3QlmQugYvDdbCZzSeBFKYCuWYQHaQmiOKCs7oTCdZxVwCFFgkxj1azBsSQIKVKs+YACVbAziM4/sTr1JvqhSp4do8SvUWL24mssBAK9qdwfb9rfPQTmDcaIE2fgGzZ6XbfDFTgANAQuZjV157Y+39bn2xy/zfG/R47f1udb7G6x+2ti9xvqc18N3Vyfw4B71+cwttdnTS31Ep3rLy/TCSqeA3c6TMdxZWi7ua7B3UGLyshyQYucQV3/zLnyARTtiExb7PtTHiEW/eBu4fI4Q2hLXlZ2H0yDxerH64/INfgmSoin9zAqcSQU7NZUWodndvFEVYA8YLHp5KxMBqPnZVnY/d3dK3ea8brHC9mrTyspfdmLdb4bgc43hDM8d+CgiwPYwbtD3670yGBGIiZcACXiznykIvR+MCNtNd9KWfGc/GKhK7M8cbkovH/SbWCxgObkD0uje+SPa/KBXGcmu/5xWRyhG2TZpL5bV4PxDDhdERFF+Lh0mROs5N3qa46zzE7Y/Q3XFjvCYUP2VHADbYZ7IfLg1fvTh2yG9SvFj8pi6SwkNhyAwHfgIhQfD+qXAziJUpbR1WxOjB90Xr8gHhke0+mxD+pECHZ+6JXwFhLHMUR6UilOEhRccNbHB7V1EnEhMsypvaUm0fFkonZBQ7u8M+8h5U9qNKSCn7k7D/pBhey5xLBG58VwjBeR+kZ2XtRy8ZZc38vEP2pqoT9VRdTswxUunGrPY3ecJ4aggCR4Zklb3724oxe26GFXBneQ6ioPqAnPR/elWVxb7bv56NALkV6Xjw/q/VxCcu5OYy50MQu5NUvYIYvnWlvxT8bQdRAG57MKUPTdbF3ioiEhIhz2WyyFbslQhlBqEn+vARjKOROPMNVTpaOhCFSJg+Qnsixg/hM04gn71JGZbp9DRsaRiY7td/OMC4a4YOhigPX8u4SHjgXYRhkoDjgHeLa0P0UCz2gr7jlaG6M6kd+lOZgaYmCVqEAichf7ywBXn3umBzi6GQNhGCv15jUiHdB1tDDrdZRV7zGsanCd30xDsl3Rm+O32ePCBPx3kxclPlhuxeCJ6J8dpW+IJH+fuPt/injbSPM7RhpfO+OW5vHyG5oXy+PBtx9rX/uw5X93IP9HDscjX6kmcepzyi0UP/UF6freJ27OzwX8hacUjKgPgS7PfbeAZVqbUJHxEmFLYSueS0G7JoXgJRa3OwgdnVOoAX2hGqE3JkIzA2PwaxcounkkM6BH+/r1ypwigquc0XHxGrSBrRuuFc+hCxc99h4aWRWD32ETiydT4Nln7bvZE3C9d+i57HntzVBV5nmlYDUMPFXO8AOAO1w+kTauXGQGiylR60JTbdvMqsMUYglF6FE7Z3J7lJ645qvl2XesBY5t/W48qB6tiG0IdoqNIMcic40YjOv2JXfRBjiFc5EV6IKQVqDCFK0V3hyerlEEYsqCXLHoaTPb9ZPsLo4FItj/OfcZ9Qa9fkj9ENxHpEB32SJ+gl9YQN1MX2R0PtHruOHV8j3EL/hlnk/L2E/tFrixiLqoXH/nGurmk6J2Q03uAi01NGlz7L5h1NUV7kBhj3mNtyH+4PbG+cdl+4hXQN3tRFEP/kXgDoh/9RGeLqjW8Fsd6+90sKt1M9zu1q1j2xsE745wny+I/OeHuds8MfwSbuLf/eAD/AsXunDSwSC6fxXUW5EwxtGti7pNNY3/gWJeX/8XQIhEdg== +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/submit-account-selection.api.mdx b/docs/api/beta/submit-account-selection.api.mdx new file mode 100644 index 000000000..25d924366 --- /dev/null +++ b/docs/api/beta/submit-account-selection.api.mdx @@ -0,0 +1,79 @@ +--- +id: submit-account-selection +sidebar_label: Submit Account Selections +hide_title: true +hide_table_of_contents: true +api: eJztG2tz2kjyr0zpPuRRFi+DDXy5IxhnyTnYh3Fye46rdpAGUCI02hnJDkfx36+7RwIJsI251L6KpCoR8+h393S3RnNLhkLxyJNB17Walo6HUy9qOY6Mg+ha+MLBKevIivhYW81b67NU31g3ElNt3R1ZrtCO8kJa07QGE0+z1lWXGSiacQOH6RSQLrCOF02EYjxg3J16wRGTisEIkw+BF4yLTqyUgC2xhkXTWEdsyr8JWAGglfg1FjoqADkhV3wqIqGQqLnlIfqQRxOYCmACfnkuPGtnIqbcas6taBbiqI4UYLEWRxYC85QApiMVi01WBOueMTki2h6QaQ+YBpDiO5+GPsISo+P6qFE9rp6KRrV2UhnWhsN6tVLltZPjxqlbtxZ3Bg3Q/E66MyRjHasjgwjYxSkehr7nkCqKXzVSMd+kXw6/giSBDO66Hi7l/pVCFUae0AboIkPj3Bp5wnd7RiT0/In7sbAWi8U6y4nS2VLr7IxHHMQfHrFvYiZcBkMrcCRCHYJOEfHcqpRK+N8azJXoNHNFxD1fM8MDanFv7sMMz3NU9YaG17l7TpkVp1Gul+rHNbciauWTeqlcc48ro3qj5PByrV5OTQZ0KVT3RQiX2/ZHeObp0Oczo8fnMKPtumYD+sLTZHyQk4Bdg7dOECE44W7c5f2Dtr2YO9q1O0tZXjYRfuBgNCtGHCV4JLYyMpJqysHmLBdW2JEH+HOUl8qndunULpcH5XqzWmsenxZKjfp/EOpUuh54wJ5g63bpxK7UBpVSs1JpVuqFcqlKYHO87qTd1cjTVt0mMSzjMCzXMlaOYK9aZ68QtY5gfhtSEcRTjPfn3V73+qfOGQz1Ox867UHyOLjp9+ix8++rbp+erjq9s27vPTy1W7125wIHg9j377IUZeBt8kXUIEc8x0/kRbQXzx48eq6JaKDeEP048Te9f/YuP/dg5H2n1+l320hbpz/onnfbrUH3skesfOycddNfZ0D2+/RH6+qqf/mpdQGPn7qXFzTc73zqdj7DyPll/yMyfXnRbf+8nEYEP7UuLjq99x147n68arUHrV7r4ufr7jUMXHff9y7Pz1Funzq9Afz/sdW7aV3AKrN70LkeWDmJrUjfFBgyvs0C1iU2QAFRQJkK1zPHPZ3hPyS25oOBg5tHSSx/cVCIuBqL6OUhKIeVGSh7It8vJD1LwFeItAWdBiizYN+4/jLMcIh6fst14bzWiDtz1u7Ha/awNgElh68F6cO9YGeQ6DiRVDPCGQHoYRyJPTGm29lQwPqUZ+HmEIcTGYhePB3C4ZDFeZnmuLshXqbE2yWMQs6SlCMhDt0kOC3nTca1E+Z7XPoynmvlil2r1exypVxBtAFH4XddyKu8aLarpElhXrIpJWCbEeMxa6wYsC1WkaafjyxnJtdLrE1JYOwHB5wULIW8VxpCwYvdPTkWd8SXnKFKjARUKA7kw8NZ6g0rSp5w+YzX/CYuF+zsaUtLAznSrqeih3yZM2Vhr7Zud5n73T0lC9Zsy4Lk/xgWHDn9s2c4Gf9qZbwo41y763iJblPDaeVnskVKnyVO7Z1A1+1yyS43BuXjZrWBCfRxvUaZLoh8PQx4UAKOKZnf4gAUylFcpoL0gsdz3XIDC1+lpMpC50rxGSzz1rCu+gBLALdrYoLcIprwiD1wzXQoHAq99CuQERuBxNyCdZfVUao9jeU1jFe3lcRt38P+RgcpZTbriyhWAQD2clUaG0p3xjxkGZTuuT+wWjZleFu6OxjOuRcIe6y4hxSScJkDGxnaoufioTSVSiSVfRqqaF0hZxMgiUKZveMu8Gv4ayfMoPgUd74BrF2SvpvAg/0s3QJHFmhCPYZWnAo+PCk1KtXRSZXzSr1aPq0NGyN+fFxq1BoNqukgrPGx2GY0edTvBdScnsN86YBG/gsCAXfBohMJIORb7OwRHRCMHR3XrF2ymdDLIvE9OoIw8q59xaqnzOfBOKZxPl4TQmDfYOmBgYoPcSjpEhnAl8obe1tjeRogzzrnrZuLAQXFf91gfZIGvbVmTwDW6qJZSvLZiXwgihMGyI+otyTcAnubQH0LDPFAZxd65peeaXRDV4x47EewI8G+ZUcWNBspOc25EvnN94i99gqicATJFDUVI2fChlybthYufwthUISRfZFI8i2bCO4K9abAWstmmzlrNOyfASDGXRdd1wAYxeDKQAwc9zKOMEp4jsjrYiXKvDZWMeQiqxR0DqD8eTuB4z8G4ojNrBcurSUhMdEP0Gwkl6dukBEaiXQWRBwSC1jpz0CMCpMLBocuw+ZuEo5QXRoCT5CuW0asbGikcPfREHMWSZpzeKx38LsrH8KPTawtJ+5F4nxgBjKJRqSNVE1JRIJJSmRxc7Jqqa7U8U1P8+C7B989+O6Ovrs+2U9eBCSzlPocb6Y+51INPZB6sCXvofc9MxkzDmpQcYAvgxjXR8yVQgevIjbh91SEAR3GrYF2Ebh2KCGDPKRHh/ToEGIPIfavE2IP6dHBdw++++f03SfToyVV5C1JnqTj6ZSrmbG0ZN50CWEBS+9ZsKXLLRul2WwFgbFljmXlMwdrWCkPy6NTR1RdXnVPjhujinNS4bXT8ml5WK2cWtmz/nblx0sny/tURt9Gj6a9KdQ95HFxAMalIyndfE8rpvY5hjUMPTwGa1KQKoDMQaR3i0WaO1Y3c8eejIA3AAy5o3qkZ3bTvzDteQMe5WbedqPTkuhMRw9TSmriie+ejg6p4yF1PBw/h+PnL3P8HFLHg+8efPfP6bsvSh2rz6WO1RekjlXWS19r/p6powt5B71fBaUAD+l1cCVCYAWezBWc1O3NDZVlorfKIin9AItD8kNJSR5dD29aRXzDa1NEKs49d1E0l9Xt5H6HrTOX3g1NhqlY+bB7EkWhbhaLc1AyKHdR4KFXSO/NBPIBbx0UhyDZLUEL3+YaB8UF5qI8ISiQWpSHlm/CJAE3SiI/RxsHZVGv80nI6ZWRGciDGTBHeEswsUIaxpf7PJgldz0KZHUb/AFfN8pf/P+8GECP8LJNfE9ig/UMKF1jEVm4Q3WBudClJ9DXDdDTNjGuFaPmb++ya64xpzcUbqxcnVNYolQ2CLrEZRX2TnAFFhvJbyJgrz98HrxhY8xkKZLEGpNokXzswK7AjChSttIONm4iK1YyHk+IuVZSEBkbR89kIx+Ewr4E10Kw2/RSVw+OkD7EfBI7bhIUZnDX3etUg664Fz6eroWVtNE4PTcoghSLPLfvDbkUlRxeYC54wGjhS2And4rw4w1ak7BI7Xl2G6Z88Qxf+xLxtxSabaDZBE2/WaPCiPbWMRcpHCVILNzXJK29kRt4dgYe1mcwglDXaUBJJHTwnNacVGt705GDZyO8PB1fgs8TD47p/DZmwh3TcMr6LusyZyKlFn9nDE0HXeV2HIOn7U3WAyK1ySPsSilDkm1Q2p4NSSfRdwGOERhj4kM89CnnkSamk9v+QpqFuPAL4zD2S45nGr6FsxlXutLRe9OMCG1EaJs4oRP6ky9RgFi8zgQ8UBwwBtBe6Z8iQUJoJjYaWFsjP4Ev0h48PhwglaDosGl+NFdBMHliNIGrl2sgVGPOvnzXBb9ZAgsPtpyw0m7DugQ36fUlnL5rcjP0LhsxeCL/0fhFjlurpsxl4M9+dJR+JJL8ceLu7xTxDpHmrxhpkvQYm5v91ceJneUngzCHpkgkJaVI1gHeJfneZgNR42eakKTjLPkxXu2EOiKi4o8ynCyg0OcRWjx5vDPxBLUeQsEjzB2P0OrklLw0VBJDAxSYBGhM11QVsMOhWPR8gFdggxVmTs5kElPUOf6GJN/0fyWYK5SyosA+QzUYQM6vsBLEmwcw91UmJeE1aO0Klc7OUkOAhGw6jQO8Hw9kx1PGwdyesRbX005sghoUhoFIZSEpLVzuSj0czRBZKFBppKb6cnQNWTUUzBmjeAYX2IROWtogetRi8kHsipG+8MlqcV0+7X8ONliiPRF+iLUoRGRIzkQGw8fuYAMiAAuS4kyqcTHZpIu4Fm98A/PGfI4L5ULJpnIDxrFmg+o5A/yayjS28ZWqXjfE+aqd/1t+kZwcRlhFFENsrCEbsal8TOl5a61KT9jQNF8oP1Z9Qq0ywcIVts3n2JLBcmyBw4AS6/3bu1WlRRUPKAmfoeQdQUhZ/6Q5K5bX/eQz5DfoN4986LyVobSfGMxWrQQLHr8J7EAAR1CAA+HUIiKizETyTsKm79BWGzdetmAhanaYttOTa+8yNf7VJTbgrGHymfXUdDUUf4BB/LdpfYG/Fn69YIwGFtH43Ep7hLDGwMU//wOYF9FL +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
\ No newline at end of file diff --git a/docs/api/beta/submit-reassign-certs-async.api.mdx b/docs/api/beta/submit-reassign-certs-async.api.mdx new file mode 100644 index 000000000..86ef42077 --- /dev/null +++ b/docs/api/beta/submit-reassign-certs-async.api.mdx @@ -0,0 +1,99 @@ +--- +id: submit-reassign-certs-async +sidebar_label: Reassign Certifications Asynchronously +hide_title: true +hide_table_of_contents: true +api: eJztXG1v2zgS/iuE7sO2hWUnjtM0/nJwE7fwomlyjoNikQYtLdE2txKpI6Wm3iD//WaGlG3ZbuN0i9vdQiiQ6oUczgzn5eGY1F2gM2F4LrUaxEE3sMU4lflQcGvlVJ0Ik9uenasoaAQ5n9qgex3gQzmREXWywU0jiIWNjMzwHkiMZtKy3sWASSVzyXNhGWc5t59YrpnxlFmR4e3h3h6TsVA5tIR22jCZi9RCV8ZV+WbOIp5mHHtFq2MjAa50PhMG6H6W4laYJhvNBPtYaRfi4PYj8RQB2bFghRUxdp+KHAcqshj4jJnNeV4AG0AaqBDPXMUsFrkwqVSC3c6Ee1fKkQKHDOSNdJol0KzJekD3E7S6lfmMnQ9ff+idng3eomgn/eHI3/Ein2mDokFfI/5bSOMYiniSwABOg0029GJZNgEC9LyqApSHJ3a9Y4CTkhkRoVhBNzeFaARWRAWOCZN4F1xZYU60ysWXvAfM4MTKWHUr1Lu30FwEN/cwxxk3PEU9WOoucaYzDh0bgYIXcCdjuLbRTKQ86N4F+TzDpzY3Uk2D+0ZQilmys2414sH5HpzCCOILR1VDFzE5eDE57hx0jsRx5/B5e3w4Hr/otDv88PnB8VH8IkC+cVRh85c6niNX60xEqAKV4yueZYkfqfW7RabuNsXR499FlAMbmUHHQat1ZJ05rLTkxvA5NCSDfpgCaG9Dadt0NDhlekJeQt5SamwsoMPCKkXcfKSmGn7oXVjAFrszoYoUjWvUG77ujz5cXp2d9Ya/wYvBqH+G/532344Go98Wb25WGadG9xXjuXaGRmxCWxiYWpYhaygmwggVCd/NPR3px2g3X7VFcMrbmYxm9LRqj+S7pbCPVjh21Wo3vlxbjDIUcDAY3M7mlUjEbrllKY9FhZElf9TJ6rQktqHWhQ1X1Lbgs6JrjEqlxoGQI2UzyAfOmtt7e/hfVZDeevjG+OrcwYe3tbjq9O5DNrixkaUYFKfRvH6Q/+7qfcSyrM41H0dxKCb77fAAphpntiLmYEfSa6b1eHv6mgOXHjjs9y4vB6/fQjyHOE0a/Fbz/1z1r/oYcAdvP1wMz18P+5eXcHd5dXLirvrD4fmQiAljtLE7xL5lMlizDDVnjggTXyBL5RhHFin4yTm148nTSlS7vkGzK21y4P21gk5G0N2bZ2ebRZ4kEu2sj0OzELJtXhh0FTnxxki5g40heaCzS/WZJzL+gXYHyILL5ETHO4TeVwBAwqnhEjkkbUE8iAUDip9ljBpLtRHMkSzDGLWrJgPQRHOfveQxyOvkO/HCoDoNjz4BrV2s9kpJ6M/KLmCzCzfeMqw4Enz8fO+43Zk873DeftHZPzocH0/4wcHe8eHxMY6eCmv5VGwzperQr4WCaBCxRAPukX+AQnyERAZo8N0zL9HYMfW5tgsxPb8MUVQDUO7LkwvWOWIJV9OCnvPpmhJUeIW+o4ok4WN8hDAEJHeEz42cyq0pofTK0/6r3tWbETwZ9sFDL+EKaW2A8B6EEBWjWQKrYAszfUscewEwV1iRgDogS7NnnuozEIgru9pQujs7t5jsYzHhRZJDDz/6lh6rpNnE6LTiSpGDnOyJbIpmA+I6PEt5DmF+zBGTe+j9rBdFIsvDN16Tz9hMQGozTwFfx7F04YCBNwJR6I/Qg/E4Rtd1BCYFuLIgEK6LnMEqQUaiOhdLVVZnYxlT3qxOCjoHcP6wnfSivADmSMxVL1xYi2fRzw/w7DRX5W60ojRS6VzlPAIpAOcDQNbGYNocg2wyt8yHI5wuC4FHle0WEWs1VFK4O3PMnOaa3kW8sDv43UUC4Sck0RYvPpeIwiJWctGIZqOcJh+R4CWFdOzsWy2mq3R8NpEiiWvfrX239t0dfXf95dDjcP+WoM/+JvS5Ur4GgclzA/oYsh6ly0LFHw6Vuols0KLPaefXdyNf75CI3TJcTPxAfORS+ZaVRDkf7vm4xItl6l/OBTJIenQSTCASibhLfC85JkU5VR1sjvZKm7EEA1VbICJETcPmumAcVGYKpZATbhss1sKqX3I24xAfOXiEtS4C4qgqDjMtVV4jyRpJ1tmozkY/TzaqkWTtu7Xv/jN995tIcsEVeYvHSbZIU27mztL8e5SWM2jAyoowW7gcTdU6WkFibIGxgipyCMbt/fH+5CgSnZh34ucHx5N29LzND4/2j/bHnfZRsJrrr5d+vHCyqk+tzLebR1IxgLjPgOMKBcZlc63javkP1GvEBMMa/eRY4mbQOaj0ZokdO5vY8a3OQTYgDNjRfKW8eDV8g/TxVz4kj3rThYkEwmxfHs9nPCdIiTYMmpY2r6FjDR3r9FOnn58m/dTQsfbd2nf/mb77KOjYeQg6dh4BHTsMIdYEIdZfCR1jwB0IzSYwKSBDVIB6FcLGDESBK1999G6fc4M7z0qgV0GR7eNNFDnSmp1xNS/Bkq1UItVSXRjeoG2KbU3ZFjfTsSmESMUgaklAt2hVMhWIScF+WCJTSX6MAgFdMw97kxykcj5T2ttiFKmipAAOKSgkGmuvGmxMgjmJCcI/oEB10CkE6h9Y4/Sz9afqwWyIEr9BiVn/SyQE+vyi/nu4bZfAAJg3GC4u3Vx/ZbuAq5njbkIlvmQufC0gaA3Va6hep/s63f8c6b6G6rXv1r77z/TdR0B1j4a+DtXx+MauUB3aNvfYAku9QuP6vyN2chXPAZk30xFh9XiJwQlXgCkhQ5mmQisddOgGrcoeXdu6k/F9q9yxHHJ/TsatCByDhUmg3yzPM9ttte5g3mC+7ps8k81yg7nSt81Ip60xKGtLHMJtp87nsAGdYXEDNEnTRqIxu8hHxJ3eSTY0W9A/7TT4JmU8wIETOofVCHNkGrjL3xsWPcYDLrCq+MVS6yYZ0oZ8INeVSe7/vCyO0Fdk2aa+b44G7RlwuiYiinCzPBVziRDcjb5xNmaZVrD4394Y7BybtdlLwQ2sD9x+mCe/vhs9ZVMEnuT4hUXMKySuFMB1LsBEKLD1yr0h2IlyjdHF1B036FV236AjsUkCArP36lIIdl1uen4LEX8IIZpUip0ERQXsdfOknJ1YfBYJJsPmUpNoeDJWLdBQi1f6PaXERysEqeAypafN9ypkpxLjEXoAtfEi0oKPXWelXHxFru9l4l8ltdBRC4mafbrGhVPtdeR2c0fgzUiCJ5a09d2DO3rhCj1cTsETpLrOA2rC81HdMxWVs/bdfFTohUivysd79Y4OSlS7MRfEmIWkmMRswKKZ1lb8mzE0HXSD62kBXvTdbNHpjJA8ImzvrbAUuiFDGQJGJP7egGMoZ0x8jDmaIIp21RJyyY80s+DzH+nE3ceKzPT4GlIptox1ZL+bZxwwxAFDFwOs599lKjQs8G2UgeKAM4CT5fxTJPCMrsQ9R2trVCfyLeqDqSECVomKzbruprsMcP6K0QtsvWgDYRgh9mIXGZ7187QwXVWUVRYH1jW4yW+iIUuu6c3xu/iJEzPn301elLi3rKGcq2T+o6P0VyLJ3yfu/kURr440P2Ok8aAXa5HD5WnZfrk8WT3deu2Oyj18Hq08juZPcN5Uj2Lu0r88HvnNI4yw8AcnIWWtnQND13zpUeZmJRJL5TMBf+EtRRhaFcCayx3bRuy1SihLeI6+SLEomklBNYxM8BwRawP9QacUPzKjMWjBSpUITYFRLKRbQNJ8LBOgR1X2cmRObu7gMFoj3tvC7/nQ4EiwJhZN9g6WlSoCY8IlJe42hne/a7+2vAR7ukBzZKeliQJUTNNC4fFVYLtIGQdHeMCOY2mjwoVbWGEqUerCna9f9CpjDzoIitCkxZVJ7fkEy+Ow8l4x1wfGAmu1vjYOqsdZ9EfJl4IMReK/M9BYW2w8RBt8JJyJJEMjgVwBsFGsjHA2GG1QBGLK/yCjzbTlO9kWtgUiuKhz5nPQ3G/uhbTIgee4RoRl+Arx8mQsq34qgdGXFADeK13YZKNYdrf8kaD+hsLf4xsKPobhQrCVYSkT57twC1NXE7iuHvZFM+3S2d21sgAEwBnWEqDD3R2Wv3CdfI+P8VwzfpLhZrkEpjgLdozXEG0nwNz69xJWjeXJ0Av/lCZup68obJWsLOWq+bKKE8DlJ4HFHxDrHk/7uuoc8ehe+J+DwtGcYFzZceN3LiwYuB6u4vfNtjcrVZiLc6x9BmP/DYfUFZQMv0U9w99u8B7+wY3O3CRgzsLnd0FZnoU2jm6Jl7fBRX9BJ4vv/wdl2xGp +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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' (submit-reassign-certs-async)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Reassign Certifications Asynchronously

+ + + +:::caution deprecated + +This endpoint has been deprecated and may be replaced or removed in future versions of the API. + +::: + +This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the reassignment is complete. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. + +## Request + +

Path Parameters

Body

required
    reassign object[]required
  • Array [
  • ]
+ +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/sync-attributes-for-source.api.mdx b/docs/api/beta/sync-attributes-for-source.api.mdx new file mode 100644 index 000000000..cd2991dc0 --- /dev/null +++ b/docs/api/beta/sync-attributes-for-source.api.mdx @@ -0,0 +1,100 @@ +--- +id: sync-attributes-for-source +sidebar_label: Synchronize single source attributes. +hide_title: true +hide_table_of_contents: true +api: eJztW21z07gW/isa3w8LTJ23Bvry5U5oCzdMabtJO8y9bQcUW0kEjuS1ZGi20/9+zzmSHSdpaekyu8CYDyWxjo7Ou56jyNeBTkXGrdSqHwe7gZmrqGdtJke5FeaVzoY6zyIRbASWT0ywex64Bya43AhiYaJMpjgZpp5OpWFCxWGqpbIM2I51NjOMF+wYMp9mWsk/aUEG44wzIxIRWREzQ5wbF6rHrP4kFPsi7ZQdD16/7+2/7R8xoB4enw32Dvx3ntupzqSdM1g4E3/kMgMuVrOIJwmzKE7vpN8A2VOe8ZmwIkMNrgOJ4qbcTmFIwQB8kzF8NtFUzHiwex3YeYpPDUiuJsHNRlCwD3Ztlot11QVzdmHA6OYS6U2qlQE7AbdOq4P/Lc/pFTOGYBX2UY9AgEgrK5RFYp6miYzITs2PBmdcr8unRx/BdKhghm600q0HMqzpsCryGz1i/X00jrjiszRB0ta43R53eDfcina6YXc03gx5ZxSHW93O8+3WWGyOYoHGMJbb3Ny/BpoFFGOOntZS+QyD6Pezg7ODfXjQP3p/Mjh+PTgYDuHb8Gxvz306GAyOBxhjC+mqpDfo03miebxuWNTMDy6pV0o7/O/R3n8Gx0f9/x28LwLq9HTQf3l2eoBrx9zyN2Ty4PoicFHZjy+C3YugE+20t1vbm1vdF+MX3U7UauOnnZ3W9na31e7wi+AGZfu6e9zofcY7cSowpFp209flv6kq8PhFHqX5UqKcu7Ur4oA7rbROB+KNoe9FWJvsMtJF2sLbt7IAj6PaFU9jBjwsnBfRvBKLlfj6m+IG/20E3VZrPab3Egl1gR1kGRTBkA2EzTMFxU6Ooc4JKn7CWDbSMRVDqT7zRFL4f6eSEgvLZbKn4wdE7iupRDjJuEQJBYkcwUQGHD/LGGawmc4EcyyZdioQ3XIIgiUabfYSwnPg9dvzymCKZTz6BLz6D6h1Z0rCfFZMgRpNW88dy4otwUcvWjudLriK8852t731fLQz5pubrZ3nOzu4+kwYwyfVdA54lvH52tKvhRKZjFiiYVOSf4JBMsGN3/tocZgirZiZ+31APB5gfyy7jrZU08vLrLiyG7Dnvtw7Yd0tlnA1yek5n6wYQYVnGNMqTxI+wke474HmjvFxJify1vpSVPj9g1e9s8NTeDI4gGo/hE/Iaw019BREa4xhCaJCLEz1F5LYK/CFmxIgNNgzz/UZKMSVqRJK983MDRgTYmvM88TCDL/6LTOqrNk407OlVKK8ubLsiWyIxgYb4bMZt9GUjbiBCeBCJH/WiyKR2vDQW/IZmwoei+xpg/XiWKKSPGGQjcAU5s+BEeNxjKnrGIxzSGVBUEfnliltZbRSihemXPbGohQeVp2CyQGS3x8nvcjmIBypWc3CMlq8iN4/ILOz3LJ0pxWjkUnnyvIItAAQNgczZhlYmAH+Y9Ia5ssRustA4VEFXVmxsAQWalG5e+uE2beaxiKemwfk3UkC5Sck1cqBz8Inn0GQ6KoReaNwk69IMIhq02RPVbqrSHw2liKJ69ytc7fO3Qfm7urgwLdIfpSgT3sd+pwp3+fh5rkGfTKKHqWLZtB3ls6RG9gyeoj05t2p7yqxS71KEWZ+R3zktvJbmrzCH+75COFH6awlX6CAZEffG0MlEvEuyb2Q2IFEMtXm+mrQro8kBKi6BSJC1czYXOeMg8myXCmUhJsNFmth1G+WTTnURw4ZYYyrgNVuvkaSNZKsd6N6N/p1dqMaSda5W+fuz5m7X0WSpVSULR4nmXw249ncRZofR205AwJWHNazMuXIVatoBZmxEmMFy8ghGHXao/Z4KxLdmHfjF5s74070osOfb7W32qNuZyuo7vXnizwuk2w5pyr+dn4kEwOI+ww4LlcQXMZqHS8f/4F5MzHGsoalp8TNYHMw6eUCO3bXseORtqAbMAbsmN1xvHg2OET+sDSxR7u5nzAwacl0QM4tQUqMYbC0NLaGjjV0rLefevv5ZbafGjrWuVvn7s+Zu98EHbv3QcfuN0DHLkOINUaI9U9CxxhwB0KzMTgFdIhyMK9C2JiCKvBpcTOHyg/PJsKWQG8JRXZ21lHkqdbsLVfzAiyZpZNItTAXljegnSFtVtACAWcTKJEKbw9JQLcYVXImEJNC/LBEziTlMSoEfLN52Btb0MrlTBFv5SpSRUkOElJRSDSevWqIMQnhJMYI/4ADnYNOoFB/xzNO762/dB7MBqjxIWrMDq4iITDny/Pf57fdEuiD8BmWi6Hz9R3XBdyZOVfQRoir1JWvEoLWUL2G6vV2X2/3v8Z2X0P1Onfr3P05c/cboLpHQ3dDdSB4MFQH2kaLlVjqFQbX347YKVW8BBTeTEeE1eMFBidcAaGEAqWaDlrpUvtu0HRw3TSvZXzTXFy7F2F5GR8v1bqWwEmYZwlMnFqbmt1m8xocBw67afBUNqCege/sXOkvjUjPmiOw1i2FCO+duqRDArx673uOBpk6kxjNrvQRc2d4Ug7jFhxAVw2+yhlv66NH56Afc2w28PKyjyx6DCKm0Fb8Zoi6QZG0ph/odZYlN39dF8foDl1uM99XVwN6BpKuqIgqXKK7IAKAEfnrDOTZc3Wrl6PTzy+rNEPE6U7CNcrF3oO/EHTWBDpGsg57KXgGTYS7NPPkzbvTp2yC6JSqQ24QGAuJ7QTk1wmEEVW/XnGBBCfRhpTpfDIl5XpLV3Qw29g4AaOwCzUUgp33vaGOYFsYQB0ns+MkQaUDZ10+KTwYi88iwR2zsbA2BqeMVROs2ORL857S7khthFT4Wgo9bVyokO1LLFoSd3mk8SpSV8jO00IvXtHrsUL8q+AWOm4hcTNPV6Rwpj2P3JXvCFIeWfDEkLUevbjjF1b4Yc8FT5DrqgxoCS/H8sWqqPDao+VY4hciv2U5LtS7qYStd3kac5WOGdg5k5j1WTTV2oh/M4ahg6lyPskh0x4t1hdcNKSMCDutikihWzKUIQBJku8QEkO5YOIj3MgJx2h3pEJp+4E8C3XhA7TZMfuwpDM9Pof9FiljHZlHy4wLhrhg6OqE8fK77QwDC3IbdaA64AJgb+F/qgRe0EptdLxurfzEvklzcPuIQFTiYtJd92V3UQT9J0YDSF3SQKlGHF5eNcO3tTwv3NOWjFWcIKxacF3eRMNWumI3J2/5Oyhurz+avqhxb3HQcqyS+feu0ndUkh+n7v5DFa+uNL9ipfHIGMONlvUtRDXIX3pMt37whyfTUwF/YZRylUA4tDjuXVREMVVGacItRjVldTSVgo4MUsEt4sMNjCw9o0yE7h7THxpDYjTJgAbS1gBu5SOZAD861C5W5pQwDnyiX/G7yf0VCw0hCS2oaLB30MWpCNyCHRxe7oWxj9q3ckPwzAm9irtfOBtA12yWK3xlFsTOZ4xDSN0TEbE0Ue4KFzR0ShS20AT9yllFFmOooQoN6mWymTke42k0NLoVx9+zFvjd+KNoMD160b+lu1BkIBKKTKRbhvb38YZoC6ciSbGHhKoLAExUVnjbP13jCMyU//1DZ5Omn2SaSAtMsIVy4bPZaDdaIbUU+IIqtGTQ9VaYDxeNGENjQXfqL9As2rLGalBeL47kf+RXrP1mhV1GM8XDNDRB7joj15We+1ci0WW77u3O2xtTaGOm2M7CjOtrPIHBTu0GH/+RC2zvzy8XTRg1Q+Bb/AyN8Biqzerr2VULPhl4JZ7Sb0iLl7bv0KA4NFTzxXlBAB8/CTxmoJe9gcqdA5EobsCdFFWmrP2Wgs1a2b2fHA8hlG7+D7uUGFA= +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

+ +A Source Sync job + +
Schema
    payload objectrequired
    + +Job payload. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/sync-identity-profile.api.mdx b/docs/api/beta/sync-identity-profile.api.mdx new file mode 100644 index 000000000..fd46f8114 --- /dev/null +++ b/docs/api/beta/sync-identity-profile.api.mdx @@ -0,0 +1,101 @@ +--- +id: sync-identity-profile +sidebar_label: Process identities under profile +hide_title: true +hide_table_of_contents: true +api: eJztW21z07gW/isa3w8LTJ20adrSfrkTWtjpToHevgwfSuei2HIicCSvZAOh0/++z5HkJE5SytvsLoz3A+taR0fnXc9R5JtIF8LwUmp1nEYHkZ2q5DgVqpTl9NToTOYi2ohKPrLRwVVUj7AwZKPrjSgVNjGyIBZggJFEWMukJ5XCskqlwrByLFjhp71Wr9WAlfqdUOyDLMfs5dnv/x8cPT9+wXhVjrWhJaRlRvxZSSNSkLKE5zl44O3g9LgDmQpu+ESUwpBkN5GkxQtejjGkMIC/ggjTOCwbyxSDNhmLCY8ObqJyWhCZLY1UI4xk2kx4iTdVBcrbjahePzooTSWWNb2AQssGYcdHJOzQqUp2ELSk+MgnRU5riWz7cbbf3+7vif3+zm5vuDMcPu73+nxnd3t/L30c3V7TsrbQysK6ELK32aP/NZceJIkoShgmZmeirIzCo8yciUlmYUv2gVtmq4RkyKo8nzJez5EKEhKpndpSTMiWiVYlFKGFeFHkMnEB0X1rabWbVZPp4VuRlNEt/tuI+pubqxIe5hIM2VNjtPmMlEOdOk9L9Z7nMv0OWRAQhkKZIs6LU3KZH+pUrHN1U9hnUol4ZLgkCYUTOcFE8uF7mWIGm2gjmGfJtFfB0XUa3oUlOlvsCU+hr9fvMCgDM5WGJ+/Ai9LsPoEulcR8Vk9BMjEE513Lij3Bh7ub+71+ttvnvPe4v7W3M9zP+Pb25v7O/j6tPkEc8JE3TVibG8OnK0v/LpQwMmG5RsbJTzCIERy2dwK4xTFFIm7s/T5wPL7A/pRJnnamZpCXleJjucE4e3J4yvp7LOdqVLn3fLRkBBVfnlPuI9j5kF5RzkJzz/ilkSOp1okiVDWh2nb09Nng8uQCb86e/u/y6TmeiNdKgRsoRGtKYQlREQtj/cFJHBRweSdymEOkHfYocH0Ehbiyi4TSLiQhYivjVV5iRlh9zYxF1iwzetJIJZc3H0v2QHZEZwMlCO9QzpIxG3KUIQYXEvkjXzvik2DJR2wsOOrzww4bpKkkJXnOkI1givlTqmU8TV3dcAyyCqksXN3WVcmULmUimr6Ym7LpDSSBLB3FyaJTKDkg+f1xMkjKCsI5NRezcBYtQcTgH8jsLdeU7mK5Sk5VyRNowalMJtoYWJgNoZssLQvliNxlUXhUTTerWFQCa7VcuXvuhTkqtRtLeGW/IO9Oc5Sf2Kk2G3gvQvJZ2lR8NXLeqN0UKlKo525yoJq5q058lkmRp23utrnb5u4X5u7y4FnAZWHUQZ+tVehzqQKI/bQOoBkXPUrXSPeTgzfBkRsMBgkQ6Y9XFwEig158LAiI/kB85LfyVWQ584d/PyT4MXNWwxckoLOj1yBDJRLpgZN7LrEzlDfV9upqz7QZSgSoWgMRUTUNm+qKcZjMVEqRJNxusFQLq34r2ZijPnKHcH0FpFVVGhcaCLdFki2SbHejdjf6dXajFkm2udvm7s+Zu59FkjOpXLYEnGSryYSbqY+0ME7acgYCVp8QslnKOVctoxVixmYYK2oih2jY2xpuZXuJ6Ke8n+5u72e9ZLfHd/a29raG/d5etLjXX83zeJZkzZxa8Lf3ozMxQNx74Dh3BGxLrdPm8R/Ma0RGZY1Kzww3w+Yw6fUcO/ZXseMLXUI3MAZ2NHccL16enRB/LO3Yk910ZRJBMNubDuS8dJCSYhiWlrZsoWMLHdvtp91+fpntp4WObe62uftz5u5XQcf+fdCx/xXQsc8IYmUEsf5J6JgCdxA0y+AU6JBUMK8i2FhAFTyF08eQ9iU3I1HOgF4DRfb2V1HkhdbsOVfTGizZxkmkmpuLyhtoJ0RraloQcDZCiVQMVUsC3VJUyYkgTIr4YbmcSJfHpBD4mmk8yEpo5XOmjrfZKlIleQUJXVHINZ29asSYRDiJjOAfOLhz0BEK9Q884wze+q7zYHZGGp+Qxuzpx0QIyvnZ+e/OulsCxxDeULk4976+47qAPzPnCm2E+Fj48jWDoC1Ub6F6u9232/2vsd23UL3N3TZ3f87c/QqoHtDQ3VAdBF8M1UHb2WQzLPWMgutvR+wuVYIELryZThxWT+cYHEawAi9lOXWLXALiH/pQHlTlmDJTpupg+d7ugREZbDGOrul27EQgGEmlQrujWnfn9yDqLs+y3Zs1F4Bvu+Fibjy/oByRWIQ/veqVycFvXJaFPeh2bxARiITbDi9kp2ao9IdOoifdIdywpsLRhVafzURAF5ZDM9NxPjSS0sTXVMfce9RZjRICnnV3GD7Lme44U6hM0ecwz2aDIaVCyLrXELFAv/KbddQdF6Ir+kGvS5Pffr8untEduqwz32dXAz2DpEsqkgrX8yg6J3DvV1+JpfmGRT8r9FYWe0lkPfZEcEO3091Nmwd/vLp4yEYEaV1JqSyhaSGpB0FSniJEXMkc1LdOaJLbxYyuRmMn+KBxr4dSlGU5FGav1bkQ7Kq+Mv4Ce8kZir8zKU0Srt7QrOsHtXdS8V7ktM125pakwEOadGGhLm/Me+i2VNd7SOVvs+Nt57WK2ZGkSicJGhBNUNG1kuyqqPXiC3p9qxD/qbnFnlvsuNmHS1J4014l/p54gjpBLHhunbW+eXHPL17gR40a3hDXZRnIEkGO5m2spPbaN8vR4BcTv6Ycr9WrscR+3ZzGfHFjFtttnrJjloy1tuK/jFHoUBpcjSpk0TeL9YEWjV1GxL3NBZFiv2QsY6BPJ98JEkP5YOJD2v0d+NH+HMal5BvnWeT8G/TmKXvT0Nm9vsImTZSpTuw3y0wLxrRg7GuADfL7PZACC7lNOrg64APgcO5/VwmCoAt1z/NaW9Ud+66bQ1tDAlEdF1sc+D8O5gUuPDE3QNQzGpRhAu+z+2n0/UrgRRthw1j1scOyBVflzTX23yW7eXlnP57Snvxv05c0HsxPZ16qfPqjq/QdleTfU3f/oYrXVppfsdIEOE3h5pYNfcdikD8JeG31tJCOs8cC/2LU5apD7uiL/Nd4hGIWGRU5LymqXVYnYyncOUMheEnYb4MiS09cJtYfvVnPaGRAg7S1wKR8KHPwcyfh9crcJYwHluRX+ttW4V6GRkiibxUd9gqtn0rgFmr76EYwxt7q0P+dwzOn5Fh2VDsboGsyqRR9lgexqwnjCKl7IiKVNql84UIXqERtC+2g32xWncUUaqRCxzVAZmJfZnSEje54wfH3rAW/23B+DdOTF8N3i3NFzkTuIpPomrD9Pt6Itngs8oIaT1RdADCxsMLz44sVjmCmwo8m2oy6YZLtEi2YUHvkw2e7s9XZjF27gPfUhaFVXmB+5xegxex70kY83syP8P++r0fDrkPtQregozTSpfLti+8or1a+HyUvrDSn/qPSNU0l2pQxdahgdHNDxzLUZd3S6z8rQT3/1fW8gXKNJ3xHz+htM1ST5e9NF8304Czo9tD9sPRlX6GuVbk+Y1TT+fFChMd3gk4l1imLZh6auXMkJ7Wn9CdNCzxWfotp9O6nL+nMzeGddRggPMBEqHJ/AVmdN9g= +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 identities under profile' (sync-identity-profile)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Process identities under profile

+ + + + + +Process identities under the profile + +A token with ORG_ADMIN authority is required to call this API. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/synchronize-attributes-for-identity.api.mdx b/docs/api/beta/synchronize-attributes-for-identity.api.mdx new file mode 100644 index 000000000..46f841c78 --- /dev/null +++ b/docs/api/beta/synchronize-attributes-for-identity.api.mdx @@ -0,0 +1,99 @@ +--- +id: synchronize-attributes-for-identity +sidebar_label: Attribute synchronization for single identity. +hide_title: true +hide_table_of_contents: true +api: eJztW1tTG7kS/iuqOQ+bpBjfcAL45ZQDJMcpAhxjKrUHqESekW1lx9LsSJPgpfjvp7s1VxtCwqZ2N6nJQ7BnWq2+62tZuvF0LBJupVaj0Bt4ZqWCRaKV/EMMrU3kNLXCvNLJKBTKSrvytjzL58YbXHjZIymMd7XlhcIEiYyREbCZLKRhQoV+rKWyDKaY6WRpGM95snIimpzBe8aZEZEIrAiZzOZrsclCICfHKOCKTQX8iSIg0ioQTCrW7cDAQKvQ4EyVsUNm9W9Csc/SLtjJ+PX74cHb0TGDqYanI8ZTu9AJEDIQNhG/pzIBplYTe2ZRBSBrgcoxT/hSWJGg4jeeRBVjbhfwSsEL+JbPCUbc8kywEEvuDW48u4rxrQGt1dy73fLyabyBTVKxaTbBckuDGt7tFY4wsVYGrAz8ep0e/qmPGqpy0BmYlX3UU5ACDGLhKdLzOI5kQIZufzQ46GZTSD39CLZHbROMCXIsvAUxNhRZl/uNnrLRAVpKXPNlHCFpZ9btznq87+8Ee32/P51t+7w3Df2dfu/5bmcmtqehQIsYy21qHp4DbQOKMUdPc6l0iYH43/PD88MDeDA6fn86Pnk9Pjw7g29n5/v77tPheHwyxiAtpauS3qKDV5Hm4aZtUbPsZU29QtqzX4/3/zM+OR797/D96ODweDKa/Pp+OJmMRy/PJ4c4e8gtf0NG924uK4Fy6Q0uvV6w193t7G7v9F/MXvR7QaeLn/b2Oru7/U63xy+9W5Tvyy5ybx8y4KlTgyFV3VUP6XBbVeLx0zxS+1rWXLjZKwKBW4Gjc2rGHZMgE2NjuKQEdTFX+v0eJuB9VL7idcyGh0M7nAXlLIO1uKzE2l8YQ/hvy+t3Opsxvh9J4McOkwQKo8/GwqaJwho8gyIoqDIKY9lUh1QppfrEI0np8J1KTCgsl9G+Dr8iil9JJfx5wiVKKEjkAAYy4PhJhjCCLXUimGPJtFOB6OrBCJZoddlLCNRxpt9+pgymW8KD34DX6Ctq37mSMJ7lQ6Bs01p2z7RiR/Dpi85erw+u4ry32+/uPJ/uzfj2dmfv+d4ezr4UxvB5NbU9niR8tTH1a6FEIgMWaVixYMUOwVfcZIspTQ5DpBVL87APiMdX2B/LsKMt1MzkZVZc2y1YxF/un7L+Dou4mqf0nM/XjKD8c4xqlUYRn+IjXAxBc8f4JJFzeWelySv+weGr4fnRBJ6MD6H6n8En5LUBQ2BllCrEsARRIRYW+jNJnCnwmZsCcbTYs4zrM1CIK1MllO6bWRkwJsTWjKeRhRHZ7HeMqLJms0Qva6lEeXNt2RPZEq0tQDTwbMltsGBTbgjYEPmzYRCI2PpHmSWfsYXgoUieArIJQ4lK8ohBNgJTGL9CaMTDEFPXMZilkMqC4I9OLVPaymCtKJemrHujLIhHVadgcoDkD8fJMLApCEdqVrOwiJZMxMw/ILOzXF26ScVoZNKVsjwALQChrcCMSQIWZgAombSGZeUI3WWg8KicrqhYWAJztajcvXXCHFhN7wKemq/Iu9MIyo9PqhUvPoks+QwiSFeNyBu5m7KKBC9RbRqcURXuyhOfzaSIwiZ3m9xtcvcrc3f95TjrmrK3BH26m9DnXGVNIC6eG9AnoehROu8Us1bVOXIL28gMIr15N8k6TWx7r2MEm98RH7mlfLPvK/zhnk8RfhTOqvkCBSQ7Zs02VCIRDkjuUmIHEslU25uzvdLJVEKAqjsgIlTNhK10yjiYLEmVQkm42WKhFkb9YtmCQ33kkBHGuApY3R5okGSDJJvVqFmNfp7VqEGSTe42uftj5u4XkWQhFWVLhpNMulzyZOUiLXuP2nIGBCzfv2dFypGr1tEKMmMFxvLqyMGb9rrT7mwnEP2Q98MX23uzXvCix5/vdHe6035vx6uu9RdlHhdJVs+pir+dH8nEAOI+AY5LFQSXsVqH9e0/MG8iZljWsPQUuBlsDia9KrFjfxM7HmsLugFjwI7JPduL5+Mj5A9TE3u0m06TQCDMdqYDcm4JUmIMg6WlsQ10bKBjs/w0y89Ps/w00LHJ3SZ3f8zc/Sbo2H8IOva/ATr2GUKsGUKsvxM6hoA7EJrNwCmgQ5CCeRXCxhhUgU/lUR8qPzyZC1sAvRqK7O1tosiJ1uwtV6scLJnaTqQqzYXlDWiXSJvktEDA2RxKpMJDQhLQLUaVXArEpBA/LJJLSXmMCgHfZOUPZxa0cjmTx1sxi1RBlIKEVBQijXuvGmJMQjiJGcI/4ED7oHMo1N9xjzPz1p/aD2Zj1PgINWaH14EQmPPF/u/zu04JjED4BMvFmfP1PccF3J45V9BGiOvYla8CgjZQvYHqzXLfLPc/x3LfQPUmd5vc/TFz9xugeoaG7ofqQPDVUB1oWx1WYKlXGFx/OWKnVMkkoPBmOiCsHpYYnHAFhBIKFGvaaKUT7wOvLYuD/+2b8ijqbbtyd8AvDvrjKVvXHThh0yQCHgtrYzNot2/Ah+C72xaPZSvnpfTnVqCX7SkY7o6ahEdQXf4hAZ3kdxO0yOqJxMB2VZCYOx+QnhjC4As6dfBFzniqH527gs6EOTZbeKI5CzJ6DCLG0GH8Yoi6RUG1oR/odZ5Et39eF8foHl3uMt8XZwN6BpKuqYgqXKG7IBjwrgf66xzk2XclbJii/y+uqjRnCNmdhBuU5TKEPxb0NgQ6QbIeeyl4Av2EOz/z5M27yVM2R6BKhSI1iJGFxM4CUu0UwogK4TA/S4KDaG1KdDpfkHLD2mkdTDw2i8Ao7FKdCcEu8hPex7BCjKGkk9lxkKAqgqOunuQeDMUnEeHi2SqtjcEpQ9UGK7Z5bdxTWiipo5AKr7zQ09al8tmBxPolccFHmkxFahDZRZzrxSt6PVaIf+XcfMfNJ27m6ZoUzrQXgTv9HUD2IwseGbLWoyd3/PwKP2y/4AlyXZcBLZHJUT9jFeRee7QcNX4+8qvLcaneLSSswvVhzBU9ZmARjUI2YsFCayP+zRiGDqbKxTyFTHu0WJ9xUp8ywu91KiL5bkpf+oApSb4jSAzlgolPcU0nSKPd7gql7QfyLNSFD9Bxh+xDTWd6fAFLL1KGOjCPlhkn9HFC39UJk8nvVjYMLMht1IHqgAuA/dL/VAkyQSu10fG6s/IT+zaNweUjAFGJi4kH7sugLILZJ0YvkLqggVKNkLw4dYa3ujJeuLzVjJVvJqxbcFPeSMOqumY3J2/xkyiutP80fVHjYbnncqKi1feu0vdUkn9O3f2bKl5TaX7GSpOBZAw3mnbt+hgG+csM023uAeIm9ULA//CWcpXwOHQ77qoqopgqozjiFqOasjpYSEG7B7HgFvHhFkaWXlImQqOP6Q89IjGaJ0ADaWsAt/KpjPIbtfnMnBLGgU/0K343aXbaQkNIQjcqWuwdXsENwC3YzOE5X3j3UWdd3Rl45pRu5x7kzgbQtVymCi+kgtjpknEIqQciIpQmSF3hgt5OidwWmqBfMSrPYgw1VKFFbU2yNCcz3JiGnrfi+AfmAr+bbFcaTI9ezG7zloqMRUSRiXR1aP8Qb4g2fyGiGNtJqLoAwERlhrejyQZHYKayn0J0Mm9ng0wbaYEJtlAufLZb3VbHp5YC765CdwYNcIX58Iu3rNF8uM+R35Jej86bcpv+Z7vHna102KK0Y9yUQ/ulrq1y3e2FV3a3MGBQv9d9d4ML7dACO2QYfHODmzrY8d3i499TgTsGF1dlM0dNFcQIfobeegZVa/0aeNUBT8aZPk/JgNXL4feok+9EqlW5CeHBx98E7l1U9IFOHwSnTSYSyhG4bajK0I0farD9K7YGTk/OIDhv/w/A0V4W +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

+ +An Identity Sync job + +
Schema
    payload objectrequired
    + +Job payload. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/tagged-objects.tag.mdx b/docs/api/beta/tagged-objects.tag.mdx new file mode 100644 index 000000000..a57b27a85 --- /dev/null +++ b/docs/api/beta/tagged-objects.tag.mdx @@ -0,0 +1,73 @@ +--- +id: tagged-objects +title: "Tagged Objects" +description: "Tagged Objects" +custom_edit_url: null +--- + + + +Use this API to implement object tagging functionality. +With object tagging functionality in place, any user in an organization can use tags as a way to group objects together and find them more quickly when the user searches IdentityNow. + +In IdentityNow, users can search their tenants for information and add tags objects they find. +Tagging an object provides users with a way of grouping objects together and makes it easier to find these objects in the future. + +For example, if a user is searching for an entitlement that grants a risky level of access to Active Directory, it's possible that the user may have to search through hundreds of entitlements to find the correct one. +Once the user finds that entitlement, the user can add a tag to the entitlement, "AD_RISKY" to make it easier to find the entitlement again. +The user can add the same tag to multiple objects the user wants to group together for an easy future search, and the user can also do so in bulk. +When the user wants to find that tagged entitlement again, the user can search for "tags:AD_RISKY" to find all objects with that tag. + +With the API, you can tag even more different object types than you can in IdentityNow (access profiles, entitlements, identities, and roles). +You can use the API to tag all these objects: + +- Access profiles + +- Applications + +- Certification campaigns + +- Entitlements + +- Identities + +- Roles + +- SOD (separation of duties) policies + +- Sources + +You can also use the API to directly find, create, and manage tagged objects without using search queries. + +There are limits to tags: + +- You can have up to 500 different tags in your tenant. + +- You can apply up to 30 tags to one object. + +- You can have up to 10,000 tag associations, pairings of 1 tag to 1 object, in your tenant. + +Because of these limits, it is recommended that you work with your governance experts and security teams to establish a list of tags that are most expressive of governance objects and access managed by IdentityNow. + +These are the types of information often expressed in tags: + +- Affected departments + +- Compliance and regulatory categories + +- Remediation urgency levels + +- Risk levels + +Refer to [Tagging Items in Search](https://documentation.sailpoint.com/saas/help/search/index.html?h=tags#tagging-items-in-search) for more information about tagging objects 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/docs/api/beta/task-management.tag.mdx b/docs/api/beta/task-management.tag.mdx new file mode 100644 index 000000000..a5b64c2a2 --- /dev/null +++ b/docs/api/beta/task-management.tag.mdx @@ -0,0 +1,16 @@ +--- +id: task-management +title: "Task Management" +description: "Task 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/docs/api/beta/test-external-execute-workflow.api.mdx b/docs/api/beta/test-external-execute-workflow.api.mdx new file mode 100644 index 000000000..0507e4ae8 --- /dev/null +++ b/docs/api/beta/test-external-execute-workflow.api.mdx @@ -0,0 +1,83 @@ +--- +id: test-external-execute-workflow +sidebar_label: Test Workflow via External Trigger +hide_title: true +hide_table_of_contents: true +api: eJztW1tv28gV/isD9mGTwJR8keNaL4XiOIUXSeP60jzYBjIiR9Ik1AyXQ9pRDf/3fufMkBIlJXazQbsbKAESijxz5txvHN5HNleFLLU1J2nUj0rlyuMvpSqMzI6/qKQq1QdbfB5l9i7aiko5dlH/KqpvuehmK0qVSwqdEwog+JfMdCpLJaS4C1DiTpcTIY24jmrU4qLQ47EqriOR4EGhEqVvldAmr8qOEBcThXsut8bRzSSrsIkoJwECV7Lkn80WAUO6Je4mOpkw1qESlVOpKK24ralqVnpE2uGilEmJZcoIXQKRTCZhsxp7B6w7yKLQ5Qzs30eXThVH1pTqSzmoygmJxOX9GjxWXnB9FbiNbh4gp1wWcqpwxzEOgx+Ql06BXJPkcglMy+I8SYUdtYgBSKF+q3ShoK+yqBRoK2cZ4XJ6muNiK1Jf8symuDWSmSMAsDSVUf8+Kmc5Q5aFNmOGlLymHyU7B0Ml92S8f9BL497+XhIfqu1e3Nt7uT8ajvblaHsYPRAjtD3M5JVNZ4RyTk3YLSHJmJKeyTzPdMLm1f3kiKP7VWLs8JNKShCTF2SMpVaOnrKG1oG1JUS2QlYbNDqyxbK4Gh7v2byxZqKyzBJIloIl/kNseYPjzXe3t+m/9lZnDJE6b9Bla+Poh/Gdy1lmZfo0zhf84U66xg2eznVvHaNHmQYj4rgoIM1YnKmyKgw8SXtTDAYghrAA70LsX50fJ4NUlVJnR2zDq0bbJvaNNioeF1IThYpJTrBQAOOtTrFCTG2hhEdZexPDdVoOAEl0dsQrmYJfz99RYAZiKguZfAauk/Rxgi6NxnpRLxE6baxyzbbqQMnhy+3D3d7oZU/K3b/2dg72h4cjube3fbh/eEi7T5VzcuxFE/aWRSFnK1v/XRlV6ERkNoFG/g2BIJ5B9kwAb07RplRT97gOGMcT5E9m6GEbNgO9ggLkFjLBq6NT0TsQmTTjiu/L8ZIQTHx5jjumyjI5pFsU2cC5R/we2UKbtfHLVFMKv6+P3wwu317gztnxPy+Pz3FFuFbS0wBB3qRkliAVtjBB7ijnDJAPOZVBHCrtiBcB6wswJI1bBNT+l5s5CBO2NZJVhsz1Iuy+ZsUiajEq7LTlSonPJuKZ7qjOFlIX7k1liUw2lJTDoEICfzFIEpWX8dsgyRdiomSqiucdMUhTTUwiucIbgRTrZ5QDZZqS63oEowqurDiAWQQOY0udqLYu5qJsawNOoEuGeLuoFHIOUP64nQySsgJxzOaiFzbWEkgM+gHNXnJt6i4WhMYinXH+xoosm0GMBUIgIhPl9tKJEI5IXQ6Bx9RwTcSiEFizxeHunSfmdWn5WSIr9wS/O80QfmJmrXlwq4LzOapAfDRibdRqChEJD30qweIA1airdnwx0ipLN7678d2N7z7Rd5cfnoXyLjzl0mdntfS5NBIVvS04ea6UPgVbj7GiBuLyJihyS0AgoUT69cMFHPsz9RROoBynAvkH1kc+la8QP2j04e8PqfxolNXSBREYuiLiYIRIpNI+0z2nOJpXiXuru72xxVDDQM2aEhFRsxAzWwkJkRWVMUSJdFsitcqZX0oxkYiPEh7hnI+AtKtJ49yiIdtUkptKcpONNtno58lGm0py47sb3/1z+u43K8mGKvaWUCe5ajqVxcxbWnhO3EoBgPlku3E5VtVytULIRFNjRe3KIRru7gx3RgeJ6qWyl77cOxztJi935f7BzsHOsLd7EC3m+qu5HzdO1vapBX17PbKIUcTdoo6rDIzLldam7fFfRePyEYU1Cj1N3QyZQ6Q3Te24e7haO15YK95JM6srJNeqIc1cRhTTADsl2KKGBYAUY8RFIxCqtPVDcj1VwFLQmD/TU83OS1wAbzGLB6MSrHhHqY1s9R0DRYLMUtVsYVgaTKoR1XzAwBXsGNH5B1anQUW/q5IXZ8TxW+JYHH9JlCJHbyr3/XXz3RMTXsOcewV/ZdDrux1pYABoCHzMaurOTX2+qc83OX6T43+OHL+pzze+u/HdP6fv/hf1eaiGvl6fA+DJ9TlgO9uiqaXekHH9z8t0dpVAAZu3sElSFTxurmtwritgSkRQbh0HETps0o+69TEJ1w2HVrr1oZXuvU4funx0gE6/UJ3oSayKDCsnZZm7frd7D81BYw8dmesOAhqUV86MveskdtodQlxrIhEdGfBeRwBicHoSOo0Oy7rQZM4+9jFyL3nmjgwXGuAp8Tcx0/EaUunMVoh2jGZLwPSDafFtkJijr/jFMXSHTWmFP/B1WWQPv58Xj+grvKwT3zd3A7wApUssEgs388NK51SE+91XjizNEws1brsrm70nsF3xSskCHYJ/l/Hs1w8Xz8WYSk92/cpR1as09QpwnlOYCIe2QT3Xp0WcbQpbjf2RmUHrzQm5kuAzVuLanCslrk6CEP6BmH+GIM0ipUWK4wKtunlWaydVtyqjdNiZS5IMT6emCwl1ZWvdc0593CNog8sp3+1cm1i81hSRNKVwggkscssnrvKaL7nA1/cS8ZcaW+yxxYzNPV+iwov2KvEncRL4M6GQmWNpfffmHl+8gI8aKtwhrMs0kCQCHe33XUmtte+mo4UvJnxtOq7NBz7H114mfBgTDmkxS8WJSCbWOvU3Ich0yA2uxhW86LvJ4sODMXtEvLu9QFLst4x1jCqR6XsLxzDemOSQsjQXKRb1m0m9S35kzcLnP6KHTsXHFs98+wrJlCBTm7jvppk2jGnD2McAF+j3uYoMC77tT2vC6b0BHM31z5EgELoQ9zyutVGd0Xd5DaWGBKQyFpf3/Y/+PMCFK8EPCLqBQRimIrt5A4jfIuCihNUSVj0eWJbgKr2ZRZ5ckpuntxlPUe78o/FLHA/mU5T3Jpv96Cj9lUjyx4m7/6eIt4k0P2OkCWUvTSPP5seVj+dnYueni9cdjqUj2SPLj0Nnseger0KltzoPpIH1ROFfPGUv59qcz5fXR4YXEeWZLMkfOB4kE614kpArWVLVuEU2aafsw2j6KXCocPZ4XAAGDu9QzcqhzoCPZ931zpJdzZekZBH021XcztBeyQSdqeqID2juTAKFUmNHpzXw7JMNHd45dHpKJiFe12aCcm06rQx2I4+upkLCGB+xpVS7pPIhD32eUbUsLBeNzara/8lIiYUOtzjF1L0f0ZAa/e+CyTyyFyzGhQk1RE9aDIft54ycqYxtmuDaBf9juGGnMYwlp9YS8Rqlm1rY4d3JxQpGIDMOfKGFt8W4Gxa5LsECCTVW3nz2Ojud7ZgbDdynTg3N8ALyC2qn628vxK2WYvl7imWLvJ+P6X/aLzNCgqTOppvTdI6EV/lOy7e5V1HT5vKUghtdvgrfZ2xFff4Og2MB+qcJNclYdn9Pcx1q/x7oNuIIDQ2ubuadHXfEMA26nn8B8VUdPDsLH0s8F2u/7FjLSz2PNLP5KCLC5WdFEwwQjj4fNPOIienxD8I7jfhixpVIvXDlZQ31vH6FH1t9E/ZmYZRw+p4GeNEwfAcy9VORQvInKvi3H13jL37Y3LsafSxC9++jesYIGI+3LvnWVTzhAnIH2H8ASSR+DQ== +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Body

+ +Responds with the test input + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/test-mfa-config.api.mdx b/docs/api/beta/test-mfa-config.api.mdx new file mode 100644 index 000000000..6b378bf75 --- /dev/null +++ b/docs/api/beta/test-mfa-config.api.mdx @@ -0,0 +1,84 @@ +--- +id: test-mfa-config +sidebar_label: MFA method's test configuration +hide_title: true +hide_table_of_contents: true +api: eJztW9ty2zgS/RUU98FJypRsx4nXetlSfJnylD3J+lJ5cFIbiIQkJBTAAUA7Gpf/fU4DIEVd7GQy2d2ZlF5skWg0+nK60Q1Bd4kuheFOanWSJ73ECevOjvsHWg3lKNlMHB/ZpHed4B0LL6tAnbzfTHJhMyNL/9hLLsfSsv6bE3bDC5lzcGJuzB3+CJa1pzLQeRrGVc5uZVGw0pAYxZTxCuTKyQzzMeTGfjqtDpIbmQvD8AcEQylyNpj64YlwY52zkoO85IbjWZjOO9VnTn8SKvB5ff7Tf/qHZye/+DW0kW5KghjxayUNeDnNMg5RXFSjA+2tyCoihAXukisrDEzgxGfXBweyisxVbzLk6Zx6PSN4jsmrBydc8ZFI3t/Dfo2s1i8gyYqkBCYrDOApaEaSZGMx4UnvLnHTkkasM1KRh8RnPikLeqU/OZ7eCCOH0+R+M6k1S3rOVGLZW4LRIkwPGxOH1TqMxqC4gZ3hEluVpTYOJop2pmmWcSPYRmvJDe/NjbzS6a0YbHQS0tAIW2plhSXJd7a26N+yHKCqCkeSzOOEwMiG2ixhgHyTkSuUI468LAtCDOZ0P1pie9cy2Px651EiNtG5KDz3FYtCFM5G8gbgmRmGwiEYXw8+iszhOeDWyaCgdUDtSh+pakJ4ubg6ODi6uMCb4/7J6dHhqiBaDBYvT7BQZ87dM2YEuNeqmAZPw/XCGG0eBwupdRb8Cbzn0vJBIXJaYVkgzw5GsBbQpUCRKg8RSo4ZcllURqx2X2dZPMjnpAtCDHlIKpcgrT1D2G3kbIzaUjdqp6qiuL8ndrurgHVQSMCDHXnZU3YuXGUUQCwD3ik6yLIDnfs8IJVPSX8IWY+jIRcOljkAzFZ5Yl7YY6lEOjJckoTB3BkmRsBjBuAKEweWdch6unlMwBKdbfaK59A36HcQlSGrG559Ai9K9F8S6EpJzGf1FCTdJhBXLCv2BB+83Nrf2R2+3OV855+723svBvtD/vz51v6L/X1aPcLHttbmxvDp0tI/CYWEkrFCIx/L32AQAAi29wIE3yO5OjGxX/aB5/EV9ieUB9pGzQbuyPebyAavDt6w3T1WcDWq/Hs+WjCCSq8InoRLCqYmGgPj10aOpHosOxweHfevTi/x5vzo31dHF/hEvJZyRF/VAQhRgYWxvvUSRwVuuWVWFDAH4pk9i1yfQSGubJtQhic7tTAmsDXklGPYs7j6ihlt1mxo9GQulLKwObInsiM6m2xA7ybcZWM24BYTKCWA/Fk/y0Tp0tNoyWdsjAQhzNMO6+e5JCV5QQUCmGL+FIwYz3MK3cBgWDnKN7Sr68oxpVEuiHlfzEw5741Z6jltO4WCA5J/GSf9zFUQzqvZjsIGLVHEOkHm0XLz0l22jOZNOlWOZ1T0FNhvM42dN0Nmgm7SWRbTEbnLIvGomq7JWO2M6tPdWRDm0Gk/lvHKfkXcvSmQflKvWjNwI2LwWUr7cfslb9RuihkJg6S2nxypGnfVgc9QshX5OnbXsbuO3a+M3cXBukSKo7702V4ufa5UbHFo81wqfYxHj9J1H/RbqNaCIzcZDBJLpJ/fXsYGCvTic0nNxHesj5oidcFNjT/C+wGVH42z5nxBAsZmkzSgQlTkPS/3TGJvqGCq58urHWszkACoWlEiImsaNtWVb3VMpRRJwu0my7WwasOxMUd+5IgIa0MGpFVVnpZaKreuJNeV5Ho3Wu9GP85utK4k17G7jt2/Z+w+Wkk2UvloiXWSrSYTbqYBaXE8nIuCgNUHu6wJOe+qxWqFmLGmxkrmK4dksLM92B7uZWI357v5y+f7w53s5Q5/sbe9tz3Y3dlL2nv99SyOmyCbj6mWv4MfvYlRxN2gjqsUwGWd1vn88V9Fh6tDSmuUepq6GTanE+ymdtzZX3F0rTU742paV0h2roZUMxtRTgPthGhNTQuC+ogZqUpCLoKSnAhwMXS2WsiJ9MFLWoCvmab9oYMqIVBqkDWrSJUVFST0maDQVDVrAEtCSTGkmg8cfAU7Qnb+jtVpdNGfquTZOWl8Shqzo8+ZEBToTeX+YtX57gmEN5QjLoKDHzjoDd0OVwAAGoKQs5q6c12fr+vz9R6/3uN/jD1+XZ+vY3cdu3/P2P0D9Xmshh6uz0Hw1fU5aDtbrKmljglc//My3YdKlMDDm+nM3z/JZzW4ryv8LYxeMhI+h9BNmV7SnQx59y6M3XfpzoG/uEM1YRCnMgXIxs6Vttft3sFL8M59h5eyE64SuanSt51MT7oDmGZF1qHrASHCiMDfcQoLdLxdjSTohjznmQcre00IpLC2PxF+lHN9F2eqK2Q2z2aTAeYRRv41RCzRQ2xYT93xsFnSD3pdmeL+z+sSGD2gyyrzPboa6BkkXVCRVHg/u2d1QQV3WH3pttVsE6EmbWdpsddEtsNeCW7QDYTvLZ78/PbyKRtRmenDvLJU4QpJfQEC5Q0g4tNYvz7Dp0l+ZzG6GoW7Z/25b0kobNiwgMLsnboQgl2fRCP8gvx+joTsTdqfXWPDrPdPau/k4kYUtPV1ZpYk4MlcdWGhLp+b99Rvc74fkAofJ/5t551K2aGk7CNpuyaaqKJv79h1WevFW3p9qxD/qLmlgVvqudmnC1IE015n4dZNhtglFryw3lrfvHjgl7b4UfOEN8R1UQayRJRj/rutrPbaN8sxxy8lfvNyvFNvxxJ76Py0+sacxRZY5OyEZWOtrfgXYwQdCoPrUYUo+maxbmnR1EdEurPVEikNS6YyRUXo5TtFYKgAJj6gHdkXJBq1mspDSH7wnkXMf/BX+T7M6exfX2PjJMpcZ/abZaYFU1owDTnARvnDvkTAQmyTDj4PBAAczPzvM0EUtJX3Aq+VWd2z7/o5tDVkEDVc1yt74aE3S3DxE/MDRN3QIA1TQd1820d3RSMv2pzmjFUfBSxacFneQmNPXLBbkLc5iqJ98q+mL2ncn52Y0O2+752lH8gkf528+3/KeOtM8yNmmljiEtz8srEXaIP8VazXlk/wrL+Ii78YteF+Lqpp9CqzG/RtRmXBHaHaR3U2lsL3/qXgjmq/TUKWnvhIRJtO4Y8OzzMaGdAgbC1qUj6QBfj50+l6Ze4DJhSW5Fd6tpVvQPz1+jF6SdFhb9GOqQxuoVaM7ldg7KOOPdkFPPOGHMsOa2ej6JpMKkUX9iF2NWEckPoCInJpsyokLnRmStS20L70a2bVUUxQIxU6vikxE/t6SMfK6Fhbjv/CWvC7jWfKMD15MV7inylyLgqPTKKbL9u/xBtoS8eiKKkZRNYVdE96tsLZyeUSRzBTFnqh6dZm1I2TbJdowYTaowCf553tzlbq2wW8L7V1aF/bzJsL8Gg8XDxCaP0QZAGOd7NT9R/xJyFxe6O+pFvSORoZrQp9UuhIrxN0pKDszX41QE0p2pwxbEvjd3d01EJd2j29/rUS1Mdfv581YL5xrS/lJ70hstHiLzjadn5yHkV+6r8s+u/+ruMBG9Qnjmo6O2xI8PGToDOKaAt08zCDP0jyKobBcNTUmrb0ZQw1iU37/9MRoZ0/UG/EDzAnMurvQ1qKrA== +sidebar_class_name: "get api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/test-source-configuration.api.mdx b/docs/api/beta/test-source-configuration.api.mdx new file mode 100644 index 000000000..cbf7efffe --- /dev/null +++ b/docs/api/beta/test-source-configuration.api.mdx @@ -0,0 +1,96 @@ +--- +id: test-source-configuration +sidebar_label: Test configuration for source connector +hide_title: true +hide_table_of_contents: true +api: eJztXFtz2zYW/isY7kOTjKmbZTvSy45iO113fKtlbx4czwYiIQkNBbK8xFE9/u/7nQOQoi5O0rSzbbLyQyKTwLlfPkCAH7w4UanMdWxOQq/v5SrLh3GRBuowNmM9Kew7b8fL5STz+reefZt5dzteqLIg1QkP6HvXU50JZcIk1iYXoDqO01kmpJjFqRKhyqWOVCg+yEiHTFTEY5FPlciY4g+ZCOos8UrmIpD4IN8rEcVmolJ6aHhSpCfTHA/uFX0QQapCZXItozoDJwS4juY8K5iq4D00MyrgAYPLk8ZbMxB5/F4Zca/zqbi4+vE/g6Ozk3Mhi3wapzqfCyiWql8LDSYYCqGiCOTwlObDNpkKChoI+zx4N5lKwSJXH/MBKJDNdGj6Vks/sMzjtD+TRk6Ud/cISyYylTMFfTImocmeicTkHc/gBX6z0+EjcIMWM+n1H7x8nvC7PNVm4j3ueKWUXj9PC7XuISVOjkqzW0eCnvooZ0lEhAI13lWq02qHo173INjrtTt7e+1We28kW8H+Qc8jWVOVJbHJEAKQoNNq0X/rfDCqiHLmhZCCeM7NojLAirvZ+CVtMU7jmdA5GTcgW5qc2MgkiXTA45u/ZMTrYd0a8egX0KeI1TlrNcxlXmTiytH2Vs1SvkCghioSYytaGSIcMjursQmdhDShSEgzKLmqXEaSJyklV66tqXS47rJVURbeyda90wl67Zetl3v7L4O9Ti/Yb7XxKZD7414raO+2dz3yjQwvTDS3/n8so+dzbM8x6hOML46G/uDIvyalb10c9/jnbhPPjO29iasyxYxryM3h4fFwiCevByenN1fHm6oJRLGOc4JNlYwQIuyPxpJ8C3JrsqhIJpkKz3QU6bpIKFEK9WTNEsQWQo5QWcB2xtMUvBpmIksQhSK25YdqTaq4KsAqS+K0W63WBklsAcw2Beq6CGEcFDNiR8EvtcmYqc2pzQZ5a9hinAx2AMpTRSZUEB46OOlJgFrUFrAQCKzZr6bUg4dB16fD13F68vNQpR80YqQ/llGGUbUnDx4Gics4Rb7CCo3z42txeHol/o3SZtXrNlqN3dZuu9fooni0wHTIBpbp3FEZuvjxrgpjbOBYgnutPdD8V5zhsze4ub44G1yfXJwjNjHk3NbJhSw1uTZQXGVan+qfGISeCVTbr4ZhykKHaqQYqsTvtDot2wTs0ErY9o53MRSDNJjqHJ4uUuIyODva72L4he27KB/DeZYr5IV3poM0zuJxLt5oE8b3mSA2CEVU5I646gjoQRyoCUzR9hB5R3F+rvK6dV8K1K9I5hzcrwodheJas2lavWan0yRpRWu/v9sVgzPhw6Qt6hyVSoeRRsRQ5zo2chRRL3FudsF+mcbo/wiZC2LYbrZ7RLMt2v3uQb/dFZdn3qP92fG6m9qD5SCO0xSS+qjLsIxBZ9VjF+XMRozikDuvNtzR/1ArWK7ENhUPUe0/Xxpfa6P8SYochISKRQ4wUYDiBx2S+2rwpsxMHrdco2CJRlu8kiH0tfodOmVgpjyVwXvQOvmCFnFjNOaLcorQIXesJ9iqAyVH+61epzve70rZedltH+yNemO5u9vq7fV6xH0GbwKJ1EuTTFM5X2P9ozIq1QGwGBCQ/g0GQb2A7VkAZo4pCPXZxiq37AOm8QX2p6pmx1ZqOnkFIawd4MtXh5eie4CYN5OCn8vJihGMf0PdwRRRRCFd1WRL+CLVE20+1a+Ojl8Pbk6v8eTq+Oeb4yE+Ea21pjUwiNaQwjLm/jGN7y1YtQrcS3QRFcEcqLfihaP6AgpJV+HdQG1/y7gwILbGEnUfMxz3DTPqpC14qqdSYOGoeKYbqrEjRvRsJvNgKkYSiVy2hReDIFBJ7p86S76gFhOq9HlDDMJQk5IWX4Mo5s9BSMgwpNS1BMYFFTmGcnGRCxPnKCjLvliYctkbC7h2WncKJQck/3ycDFBfIRyrWc/CKlqciM4/kNlablm665rR2KRztF/gQEL8c5gxTWFhMYJuOs+EK0fkrgyFx5TjqopFJbBUi8vdmRXmKI/5XSCL7Avy7jJC+fFZterFB+WSL6MVia1G7I3STa4i4SV3fJrsRlXuKhNfjLWKwm3ubnN3m7tfmLurL8s1pHvL0Ke9Dn1ujNtUoOa5Bn1Sjh4TlzsPv9nFpnXkDuE6B5F+enPttixoy+VjQkv+PxEf2Va+Jvyg8od9PiL4UTlryRckYG0fZsxbP32WeyGxt0CJu+vcsNIYaQSo2QARUTVTMY8LIWkNZjG9kNkOFjwqMz/kYipRH2VAONVWQLs15fPe1BZJbpHkthttu9H30422SHKbu9vc/TZz95NIspKKs8XhpKyYzWhHkiPNvSdtpcCAxVcoVcqxq1bRChETFcbylpGDN+q0R+3xQaC6oeyG+7u9cSfY78i9g/ZBe9TtHHj1Xn+7yOMqyZZzquZv60e7vW83NwuD4MryOA6Xt/9g3lSNqaxR6alwM38r9Hi3wI7ddex4HufQDYSBHdMnthdvrk6JPlgzebKb3Q2npGXT2W8gCVJSDMPSOsu30HELHbftZ9t+vpv2s4WO29zd5u63mbu/Czp2Pwcdu78DOnYFQawxQay/EjqGwB0EzcZwCnQICpjXEGxMoAo+ud1Hl/a5TCcqr4DeEors9DYcY4pjcSbNvARL2dJOpFmYi8obxs5obFqOxQApJiiRfAxNA91SVOmZIkyK+BGRnmnOY1IIdNO5PxjTkTabM2W8VVy0CaICEnJRoONwxPdeaoSTGhP8AwXeB52gUP+Je5zOW39oP1hckcanpLE4/hgoRTlf7f/ubTolcALhUyoX7gzEE8cF7J65NFhGqI+JLV8VBN1C9S1U37b7bbv/Ptr9Fqpvc3ebu99m7v4OqO7Q0NNQHQO+GKpjbKMlKiz1moLrf47YOVWcBBzeIg4Yq4cLDM64AqFEAiUxb7TyBYi+17RwPWs+lHcgHpvVOfsmncT3g5W7KnZ5YKUt0ghEpnmeZP1m8wFOhPMeGzLRDc1XRvK5ie8bQTxrjmC5DUWJzqDaBKQBdOfDrT8abPZUU2TbMsjErRNYUYphOIOPHXySsnEn8OdQUVgyO3RM20UZP4aICZYYP2Q8usFRtaYf9LpJo8c/rosl9IQum8z3SW4YLyDpioqkwt3i+syQ8LjlvnaJZtFj6JuAzhqzCxrWEa+UTOmaEB+OefbTm+vnYkIolKtAkREAVpqWDcijS4QIV7lBeVCEJnHjSeNiMmXBB0tHcSirxDiCwuKtGSolbk+cEc5R/q9Qr9mkNElxiaBZd89K74Tqg4qoMzYWlqTA06FpwkJNuTTvOXdBXi5oQ/eY+GnjrfHFkU7t9ZSMxzgVefUnbpNSL1nT62uF+EdJzbfUfKaWPV+Rwpr2NrBHuxe3sTK21lczt/T8Gj1aW+EJUV2VgSzh5Fg+QBWUXvtqOZbo+URvWY635s1Uo8UuTxO2ookMHTIKxYkIpnGcqX8KQaFDaXA7KZBFXy3WPTH1OSP8Tqsmkm9Z+toHYGT5TpEYxgaTHFHDZrwS260TTsl37Fnk/Du+2fRuSWd+fIu+SiPDOMi+WmZi6BND39aAzMnv7sc853sopAPXARsAhwv/cyVwgtbqnqW1saoz+SbPodYQQFSmkiV9+0t/UeDcJ8EvaHQ1BmWY8HZ1pIyuADpa1LuWjFXuFKxacF3eKEbLXLGblbf6vpPa6N9NX9J4sNhQoRtDf3aVfqKS/H3q7l9U8baV5nusNA4BU7gxW7dUqAf5K4fX1jf4aAd6qvAv3nKuMtjGUsbeqSUUUyeURDKnqOasDqZa8dZAomRO2G+HIiuecSYm7qZXZglNUkXXyiCyxGJOR6DHm9clZ8kJY4El+ZV+zwp3lCJGSGKpqRriDd2eDOAWWqnRIV68+yV2S7YhPHPJF8iPSmcDdM1mhaF72BC7mAmJkPpMRIQ6CwpbuNxSwaoQM/SrZpVZTKFGKjR4zZLOsovx4lrgF/KC3zO35QzTkxfdze2FIlcq4sikccuw/XO0EW3+VEUJrRVRdRVdY15wODu5XqMIYsZ9zxGnk6ablDVpLIh8qG4M7jbajZbPywU8p6UXVrc14tduU6F2+5nK4+qF59WwfFhsvv8//2UA1w5pHdNMaFuOjFzYdZVd3966q/0UFP3aLf+6ZTcscrFsmvJF2Fvv4YF2dmjV90iPfy0UbRvc3i0WdLwQRiwt3+d80l/PrpxKz/m7qQ1/MmCjWuWepJkvtiM8fHyvaBejUg0rfsjOm00sl31tt6NqE9e+sKGVYrVFcHlBG3OMsDahDvcBRkBd/S9AqlH9 +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/test-source-connection.api.mdx b/docs/api/beta/test-source-connection.api.mdx new file mode 100644 index 000000000..a854dff87 --- /dev/null +++ b/docs/api/beta/test-source-connection.api.mdx @@ -0,0 +1,96 @@ +--- +id: test-source-connection +sidebar_label: Check connection for source connector. +hide_title: true +hide_table_of_contents: true +api: eJztXFtz2zYW/isY7kOTjHW1bEd62VFsZ9cd32rZmwcns4VISEJLASwvSVSP//t+5wCkqIuTNO1s24z84MgkeO6XD0dEHgKbqFTm2pqzKBgEucrykS3SUB1bY1RIN4K9IJfTLBjcB+5WFrzbCyKVhalOeMEguJ3pTCgTJVabXLyXsY4kaIl8JnP8UiK0ZqKnRaoiEeKXMrmWcSZkqtxqIU0kPug4FklKIsULIQs8iHUhKOFWPmNCGYsgNJOYaNAbL2o3ziKRSCxNZCrnKldp860Zitz+rIyjcXXzr/8OTy7OLpm+TXW+EJA9Vb8UmqTLrQglxMhJo+H1WRPqZyosaCFM8BDcZSqFcXL1MR+CAplFR2bg2DdCZzabDubSyKkK3j3CWJU0GZPQZDISE7QNbuCvUnriFs7UXAaDhyBfJHwvT7WZBo97QSllMMjTQm06QYmzE2EnbA/nKxJffZTzJCZKoZrsK9Vtd6Jxv3cUHvQ73YODTrtzMJbt8PCoH5CwqcoSazK4GSJ02236Z5MRVhVxTswgbvgzBBRhFTJkxZqzKqM4F5QMxCS1c6FzkjEki5qceMkkicnpoNP6KSOGD5s2seOfQJFCU+es2iiXeZGJG087WDdOeUPMbaRiMYEwNXlZh70qSqVTAsnAcZmQdtB0XZ2MJHfxmmtnLx1tOm5dlKWPHMEVF3XDfudl++XB4cvwoNsPD9sdfArl4aTfDjv7nf2AHCSjKxMvXBQ8ljH0ObaXWPUJxlcno8bwpHFLSt/7aO7zz7ttPDO29zauyhRzLhZ3x8enoxGuvB6end/dnG4rGxDFOc4LNlMyRoiwP1Zjd0luQxYVyyRT0QXKh66LhFqkpirdsASxhZBjlRLbOT+m4NUoE1mCKBTkfKyhEpMqrg2wyoo4nXa7vUWSSOVSx9m2QN0UIbJhMSd2FPxSm4yZusTabpC3hi3GyeAWoEhVZCIF4aGDl54EqEVtAQuBwIb9ako9BFh0ez56bdOzH0Yqfa8RI4MJCjVW1a48BFgkrm2KfIUVmpent+L4/Eb8BwXOqddrtpv77f1Ov9lDBWmD6YgNLNOFpzLy8RPcFMa4wHEED9oHoPlvm+FzMLy7vboY3p5dXSI2seTSVculLDW5tlBcZ1p/tHFmEHomVJ1GtQyPLHWoVoqRShrddrftWoFbWgnb2QuuRmKYhjOdw9NocST3xclhD8uvXHdF+RgtslwhL4ILHaY2s5NcvNEmsh8yQWwQiijLXXHTFdCDOFArmOnpDJF3YvNLldet+1KgfsVojBTcrwodR+JWs2na/Va32yJpRftwsN8TwwvRgEnb1D8qlY5jjYih/nVq5DimjuLd7IP9OrVo9AiZK2LYaXX6RLMjOoPe0aDTE9cXwaP72Qt623qE4yBO0xSSNlCXYRmD/qonPsqZjRjbiPuvNgwDflcrWK3ELhWPUe0/Xxpfa6Ma0xQ5CAkVixziQcIi73VE7ptbFAJHssxMXrdao2CJZke8khH0dfode2VgpjyV3CfPvqBF3BmN50X5COAOd6wn2KojJceH7X63NznsSdl92escHYz7E7m/3+4f9PvEfQ5vAo/US5NMU7nYYP0vZVSqQxFb4CD9KwyCegHbswDMHI8g1Odbq9yqD5jGF9ifqppbW6np5RWEs/aEFK+Or0XvCDFvpgVfl9M1I5jGHXUHU8QxhXRVkx3hq1RPtflUvzo5fT28O7/FlZvTH+5OR/hEtDaa1tAgWiMKS8v9Y2Y/sMRegQ8SXUTFMAfqrXjhqb6AQtJXeL9Qu78yLgyIrYlE3ccTnvuWJ+qkHXiqp1LoQKl4ppuquSfGdG0u83AmxhKJXLaFF8MwVEneOPeWfEEtJlLp86YYRpEmJWVMoBxE8fwChISMIkpdR2BSUJFjKGeLXBgLiL6GM5emXPXGEq6d151CyQHJPx8nQ9RXCMdq1rOwihYvovcPZHaWW5XutmY0NukC7TekjUaMbUdo0xQWFmPoptGHfTkid2UoPKZcV1UsKoGlWlzuLpwwJ7nle6Essi/Iu+sY5afBqlU33iuffBkhaleN2Bulm3xF8nCbH/arKneViS+wWYqjXe7ucneXu1+Yu+s3yz2kv8vQp7MJfe6MHy1Q89yAPilHj7Hl/OFXt9l0jtwjXOch0vdvbv3ggmYrHxPa+P+B+Mi18g3hh5U/3PUxwY/KWSu+IAH9qIc0mKASqWjAci8lDpYocX+TG3YaY40ANVsgIqpmKha24CFR6jC9kNkeNjwqM9/lYiZRH2VIONVVQDeDavAQaockd0hy14123ejb6UY7JLnL3V3u/j1z95NIspKKs8XjpKyYz2kiyZHm75O2UmDB8iuUKuXYVetohYiJCmMFq8ghGHc7487kKFS9SPaiw/3+pBseduXBUeeoM+51j4J6r79f5nGVZKs5VfO386Mb77vhZmEQXFlubbQ6/oN5UzWhskalp8LN/K3Q47slduxtYsdLm0M3EAZ2TJ8YL97dnBN9sGbyZDc3DaekZdO5rygJUlIMw9I6y3fQcQcdd+1n136+mfazg4673N3l7t8zd38TdOx9Djr2fgN07AmCWBOCWH8mdIyAOwiaTeAU6BAWMK8h2JhAFXzy00ef9rlMpyqvgN4Kiuz2t7zLZK24kGZRgqVsZRJpluai8oa1c1qblmuxQIopSqQRqFoa6JaiSs8VYVJ6by3Wc815TAqBbrpoDCc5tHI5U8ZbxUWbMC4gIReF2NLs1SLGNMJJTQj+gQLPQaco1H/gjNN763fNg8UNaXxOGovTj6FSlPPV/Pdg21sCZxA+pXLh34F44nUBNzOXBtsI9TFx5auCoDuovoPqu3a/a/ffRrvfQfVd7u5y9++Zu78Bqns09DRUx4IvhupY22yLCku9puD6vyN2ThUvAYe3sCFj9WiJwRlXIJRIoMTyoJWPQQyCloPrWeuhPAnx2Kres2/x28/l2Qp3JMVtDpysRRqDxCzPk2zQaj3AhXDdY1MmuunOieQLYz80QztvjWG3LSWJ3kB16UcL6NyH33002eipprh2RZCJOxewmhTBcAW/dPBJysa/f7+AgsKR2aOXtH2M8WWImGCD8V3Gq5scUxv6Qa+7NH78/bo4Qk/oss18n+SG9QKSrqlIKrxbHqEZERp33DcO0iw7DH0P0N1gdkXLuuKVkim2Cu7VmGffv7l9LqaEQbkGFBnBX6Vp04AsukaIcI0blq+J0EPcdlJbTN2RouHKiziUU2ISQ2Hx1oyUEvdn3giXKP43qNZs0uHydBKeeves9E6k3quY+mJzaUkKPB2ZFizUkivPPeceyJsFbfBxzlebb01DnOjUBXvGa7yKvPcT90mpl6zp9bVC/KOk1nDUGkwte74mhTPtfehe7K6f4iJrfTVzR69Ro0c7K1whqusykCW8HKuvT4Wl175ajhV6DaK3Ksdb82am0WBXHxOunokM/TGOxJkIZ9Zm6p9CUOhQGtxPC2TRV4v1gZg2OCMa3XZNpIZj2dANwEWW7xyJYVwwyTG1a0Yr1g1OOCV/ZM8i53/kc00/rujMl+/RVWllZMPsq2Umhg1i2HA1IPPy+9Mxz/kUCunAdcAFwPHS/1wJvKC1uudoba3qTL7Fz1BrCCEqU8mSgftjsCxw/pPgG7S6WoMyTGi7eqGMjgF6WtS5VoxVzgnWLbgpb2zRMNfs5uStvu2kJvpX05c0Hi7HKXRe6I+u0k9Ukr9O3f2TKt6u0nyLlcbjXwo3Zus3CvUgf+Xx2uZ4j+bPM4XfuMu5ylAbG5nlweg6oSSWOUU1Z3U404oHA4mSOWG/PYosO+dMTPw5r8wRmqaKDpVBZImtnI5Bj0fXJWfJCeOAJfmV/s4K/yKFRUhio6ma4g2dnQzhFtqn0Su8uPeT9Ru2ETxzzefET0pnA3TN54Whs9gQu5gLiZD6TEREOgsLV7j8xsCpYBn6VU+VWUyhRio0eceSzrOryfJQ4Bfygt8zP3CG6cmL/vT2UpEbFXNk0rpV2P452oi2xkzFCe0UUXUVHWJecrg4u92gCGLGf8th02nLP5S1aC2IvK/OC+43O812g7cLuE4bL+xta8SPaXtVPw5NxXH9sHNzPSoflpP3b/z8v294tFNpJTR2IzMWbufk9q/3/gA/uX1QO8tfWY8+r29isS2a8THX++DhgeY2tKt7pMu/FIqGAvfvlhs23ugiVlZPaz7pkGc3XqHn/M3Ttv8WYKtW5cjRLJbThgAff1Y0pKg0w4YewvMsiQVzt920qfbgxvcxtBWsJgDXVzR3Ywi1DVb4D7ACCuf/AMnqOzE= +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/test-subscription-filter.api.mdx b/docs/api/beta/test-subscription-filter.api.mdx new file mode 100644 index 000000000..ad469f9fc --- /dev/null +++ b/docs/api/beta/test-subscription-filter.api.mdx @@ -0,0 +1,84 @@ +--- +id: test-subscription-filter +sidebar_label: Validate a Subscription Filter +hide_title: true +hide_table_of_contents: true +api: eJztW2tv2zgW/SuEdoBpi8iOHTeZBBgMkjZdpGgn2Ty2H5IApSXa5lQmtaKU1Bvkv++5l5Rsx06TPtDtFMYAHUciL8998lyavolsrgpZamsO0mgnKpUrT6q+Swqd08NXOitVEa1FpRy6aOc8Oi30cKgKF12uRalqxmHqv2WmUwkBQorXJ4d/HslyJAY8X6iPeaGcw0Ahh1IbV2JQXtgrnapUjG3yQWiTV2Xrwhyr/1QAIQr8XxcszamkKnQ5ES4BWmEHOwKICj9wz6aTaOcmCuOhRFlUai1KrCmVKemVzPNMJ6xk+y9HYG8il4zUWM5PPI8YBGR72KRjOckVlLP9v1RCbwAaBiu1cjTXj8eHu8PmTfO2UVCUVqgrmVUw1P3GaUGC+ijHeaZ4lRSKQH/2UHe9s9HdGqSyk/R6W+s9max3Or911PbmRtrb3Eii29sG/xSYKwtthgvA7voJ6GC3VNNrmWUTgL6yH5QovdfF9UiZWby1Ko5mkt3nkEe/nP/x5JfWFL74/Xdx8aAGF9HTSxYDREDx0iZs608jT21SjbEOexmzqyLDqFFZ5m6n3U7VlcrIcS0ndZZbbcpWYsdtnZo2Zro23psyDmq6thcKi8X8wsGosCqUYLXqSPfJcUB+fVna6HbeaXVofKb3ps77GvPdMmC4KbfG+Vjtrq8vmnHP2kxJQ44tRzCjy1WiBxpJuRic2okr0rxJYcwIaRt9Rr49kFGOrTszsO8hcuwOZJVhiYHMnLoby+8oNssRUAJ/lhJcrgQM83O1aRxJImDJAKuOuu8Cr3IIQJQ/D5OWFjnWXg6PUO1/1K78ntCoFmBJ+rwc2b1Jc1iVy7Omdr8v4gtmrx/PqOsXoqV6yyL8RaYRlmK/KGwhYnGsyqowiG89YPXCLiL62EZIMxQ8WvEbRnSqStScFzZVD9fjV9qoeFggIIFQMeQEE8NWSXYe20IJLxIbIavA4+YLLyzR6og9mYp6O30RlCGPFDL5AFkH6cOAzozGfFFPEQjEAUDds6zaUrK/ub7d7Q02e1J2f+t1tp73twdyY2N9+/n2Nq0+RhTJoTdNWFsWhZwsLP1PZVCCE5HZBB75LwxSKAnbMwBeHFN0qcbuYR+wjEfY/xR6+bGNmgGvKLEfrSEb914cid6WyKQZVvxcDu8YwcRnJ3hiqiyT/Zkk9YIPscdoswyKMtWYSMjL/Ve7Z29O8eR4/19n+yf4RLIWCNcuUhF7NcISUBELI3vNiIMC19KBOWUwh0pb4lmQ+gwKSeNmB2r/l5s4GFOEUoEZYfUlM2ZFi0Fhx3OpxHnzsRRPdEu11kSfno1lmYxEXzpMsIaHP9tNEpWX8ZtgyWdipGSqiqctsZvWFISKH4Ri/gSChEyJL2ovYFAhlQFGlyMLZmVsqZM7BGRqynlvTMvSm1mnUHIA+cNxspuUFcCxmrNZ2ERLgBj8A8zecvPoTmeMxiadgL8k0IKpV2KLAhYWfeimSydCOSJ3ORQeU49rKtZsteVy99aD4SqLd4ms3CPy7ihD+YlZtebFlQrJx0QvEHfyRu2mUJGIBY58rkzpfbBFnfh+k1nl7ip3V7n7yNy9+/I48PrwlqlPZ5H6nBlZwb4Fb54L1Kfg6DFW1IOY3gRHrgkYJFCk1+9OkdgfFDM/8EBqlr8hP/Jb+QL43cYf/nmf6EfjrDlfEMArTy9JgwEqkUp3GPcUMRvKm2pjcbVXtuhrBKhZQhFRNQsxsZWQMFlRGcPc162h51TO/FqKkUR9lMgI5/tgYtLKpLHvM1dMcsUkV7vRajf6aXajFZNc5e4qd/+euftJJtmg4mwJPMlV47EsJj7SwnvSVgoMEPUJs2hSjl11l62QMNFwrGieOUT9bqffGWwlqpfKXrq5sT3oJptd+Xyrs9Xp97pb0exefz7N4ybJ5nNqxt/ej2xikLgr8LjKILhcaW06f/xX0TdOAyprVHoa3gybw6SXDXfsbi9yx1NrxVtpJjVDcnMc0kxtRDUNY8c0tqjHYoAUQ9RFI1CqNHBRKOmxgpSCviXK9Fhz8pIWkFtM4t0BHcn6RKmDrFlFmySrgJArQWaJNVsEloaSakCcDxKYwdK59zdkp8FFX8XkxTFp/IY0FvsfE6Uo0Rvm/nzZ+e6B8V8TiRPv4HsOen23Iw0CAA2Br1kN71zx8xU/X+3xqz3+59jjV/x8lbur3P175u5n8PPAhu7n5xjwaH6Osa110XCpV3xb4HvTdE6VgIDDW9gkqQo+bq45OIxQXwfjRc7A61/4UN6t6IbAeeTynXCRJybSj3CL3cyVNrcDtxBRvby9JMSIS9Iut44rEl8ziNqNhNmZ7XDKrOJBfS/OtxVe4fk7RzeIA/j/tiVz3VziMfaaLx71YfwldY0uIPgcpgFi9+gg9C0t9lyhKTl8JWXh3o/hbkfU3G36pGQjxxwgE1uhdrKYNYFECoHKjwExR5fyq+PRLQ7MBf2g11mR3X69Ll7QPbosM98nV8N4AaR3VCQVLqexc0KU3q++EEHTbYrawO7CYoc0rCv2lCz4yhx9M/Lk9bvTp2JIRJYLib8gozRfqpLiCCHChXK3/paAJvHeVdhqOGLgu3Pfw1BiikEGhcWFOVFKnB8EI/yJHeQYJZ9NSpMUVxmadfnkMTfeYKG2nJv3lDdS7ji0wccxP21dmFi81FTfKPp5TFDR30w6z2u95IxeXwriH7W02EuLWZp7egeFN+154u/1JKgOJEJmjq31xYt7efGMPGrP8ISk3sVAlgg45r89S2qvfTGOOXkxyZvHcWHejTR26flpwtcx4bDJZqk4EMnIWqf+EIJCh9LgfFghi74Y1jUtGnNGxN31GUixXzLWMTgn43uDxDA+mGSf9nymPBZs0KQ+Jd+zZ5Hz79GRp+L9nM78+BxbM42ky5lfjJkWjGnB2NcAF/D7nY8CC7lNOnAd8AHwYup/rgQB6Ezd87KWVnUW3+Y5tDXQbWWWgh3J/7EzLXDhk7/TTKObMSjDRNmb7xPxtwiyaPubM1Z92HDXgot4M4td947dPN7msIt24h9NX9J4d3omc2iyybeu0vdUkh+n7v6fKt6q0vyMlSaQaDrbPJ7+gmL/h7m4vhZRJrBFQiM0m397gUouHl/S+fpI4V+85TLCrQQaNW49mWDNCsozWVLCccFJRlrxwUeuZEm0dI2C3o65SOSFpcqE9pYFDQuMoZvyoMuyrzPI46P5emXJuew5L4Uc/Y0mgrov/nnFCI20aol36EVNgoihPpQul+DdXzY0pCcImiOKOfGyjkPwwfG4MvQrGMCuxkIi2h8I1lS7pPI1FW2pUbUtLLPSZlZdYCgLSIUWd2TF2B0OTnz/FD38S4qwFkLShQN1mJ68SA0ENXuNIscq46ShcY/7lUYtG4kQj1SWU5BgQwA3VDMrvD04XZAIYcZBr0S1bDFsh0muTWMhhDo3Hz4brU5rPeZOBs+pF0STOCO8vr0O0jv78yjR/D5qLhpvpt8ofPefRYVdkdqZdk4HfKRQ5dsr39yeR0ubW382MNfeomEaUVuMKTc3dCxE/d4tPQYYOnM4v5y2cvQXlvLHQ9wPf1B0LBG+j4hPJ7zvh/OHxS9aqMP0M/yR0yfHznbuR4d0+Bb1ww/Bxv5Eo5DXeEj/7kQX+A9/2KAo/eiLnt9E9fkgxni5NcFaxi/CB1Lz9vZ/mvlWOg== +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/test-workflow.api.mdx b/docs/api/beta/test-workflow.api.mdx new file mode 100644 index 000000000..153845982 --- /dev/null +++ b/docs/api/beta/test-workflow.api.mdx @@ -0,0 +1,85 @@ +--- +id: test-workflow +sidebar_label: Test Workflow By Id +hide_title: true +hide_table_of_contents: true +api: eJztW21v2zgS/iuE7sO2QWTHb/E5X+7cNF1k0d320uSKQxqgtETbbCVKK0pNfUH++z0z1ItlO02vW9ztLtwCgU0NhzPDmeEz9OjOS1KVyVwn5jz0Trxc2fxtkn2cR8mtd+jlcmG9k2uvGrLezaEXKhtkOqU5mHGJGUKK25JC3Op8KfKlEmmWfNKhCoU2aZGLUOayI8QlnjQDwi6TIgpFpqyKZ5Hiie5xvpQ5f80zvVioDIyjSFhlQh6t1gPLN8rNu1aflMlr+jAJihgDrNzNk2Wep/ak2w1BFZHSHSt1lCba5J0gibs6NF1MsV3m4pdcbFd+ApmEbE/FPMmENEJ9lnEaVXLS4LqYLLc2OtcSxsRXbRth35lL+g4leGGnU6byIjOOswoKElecPz8Ut0sdLEWA8ZkShYUl80RESfKxSEWcZCQAFo9ZPyFnSeHs1TAprDYLHnv/o6JNqrZRnFU072tZINvBAUvHQgUSK2JKpD8pkRVGJPOW3Wvxqv0rIlJbFAa8wBPSxkmo5zpg+SzJvkqKDJr9IkAgseLBAVzMQpJM5yu42Z13ZVV2moDB53xa5EtyPZueVGv6TjV1gscqMzLybu7hj6nMZKwwYpmHwRf4pQ7BXJOHphKcNt32PNzUCCSZ+rXQmUIg5FmhIFu+ioiX1bThIFCf0ygJMTSXkSWCYKli6Z3cefkqZUq4gVkwJTsJhoLeeKbkQPqj8TD0h6NB4E/U0dAfDo5H89l8JOdHM++eFKHlEU3PknBFLDelCcgwJqdHMk2j0rLdD5YUutuWJZl9UEHeUuvaY6elKEZ4IghyrSxNccM75m4EOzk6BXzb92v/hh73te7M+DyEyNheMc1hmllBMXG6lGZB4txtbcqDxOKyjK9zlvTQ+ySjQrVE1+Vs9xnslBofT3rjwaA3mQ17YW8SBCo4DpQc9ef9wXgGLqWzfEiWphMmtMWlAc6fn/1yeX75Lw/6BCyC8y5ZSQaaUMH1csoxmJdE4T+dSJ6VpDyYq9tqKJbZR5WTa9wftpnE0kjo1eLwZfn7g9GwP2grYHSgOotitVuBRpCv43wcNJxjJc1DnDd1gf/pqG2LyrJ/XyY5PaVc2zZNTbGon9/f3Lt/5Ls2RfpwztQ/Otp2GvLJOrHVfvvNwdKOi8qz64R5Hu6K9m2J6vOwSceckZq8cKR6vUDNpT85VmN/ODse+5Oj8Mg/Oh7Ngl4oR+PRwKvMMNyl+Wmk6cA7yzLEoS8u+ByhA9cltjKdiBnyiUBe1wYxo8PO97NOqHJs2SlnxMeM8kIb5S8yqUlCxSIHmFjCBDqo+ExzLKvczHSdltlgiU5PPJMh9HX6nZbKwEx5JoOP4PU1u3RlNOaLagq2p85nO5ZVYyVnx0eT/nB+PJSy/9dhbzyaTeZyMDiajCYTWj1W1sqFM025tswyudpa+kdlVKYDHOYBduTfig5QCduzALw4nV25iu3je8A8vsL+5JSOtlazlFfQcXuIs/7Z6WsxHIsI2a7gcbnYMILxr95Q9BYRQyJ3MkFzx/gVUrQ2O09DU8R0+jw/ezG9enmJkYuzf1ydvcEn4rUFKqeIFhOSW0JU+MISgZQ3CtxKCyQYwRwq7IiDkuuBoFxl1wm1+2ZXFsaEb80lYApmlKvvmLHOWsyzJG6FUuCwiXiiO6pzCFyGMQAw4KCZJICGLSTygynyaZr7L0tLHoilkqHKnnbENAw1KSkjwSeYxfwVATwZOqzMDOYFQlkxliZYZ5Kc8ntrLxpTtncDQaBzpni5vikUHJD8cT+ZBnkB4VjN9SisvaUUsdwfyOws15bucs1obNIVgHgALWQUrWDGLIOFBY4NoXMrynRE24U6ANCwpKszFqXASi1Odz87YZ7nCT9jtPp43L2OkH58Vq1+QPCWg48halm00G5U21RmJDxkmE+T10qb9UCyYq5VFO5jdx+7+9j9ytjdfHhR4r3yKUOf3jb0uTIS9WGS8eG5BX0y9h6TiIrI1chuIw8FDFJCpJ/eXiKwPypD9CjuqEr6jvjIHeVbwk/r/XDjs6pMr47+Zi9IQLaj02COTKTCE5a7kXgNJQ62V3uRZDMNBzU7ICKyZkZluZAZV/mGJJH2UACPW/NDLpYS+VEiIqx1GdDdXvjuymCPJPdIcn8a7U+jP81ptEeS+9jdx+4fM3a/iCTbl9IlTrJFHMts5Tyt+lUH2koBAlHdPDZ3ivWV8zpaIWaixlheGzl4s35v1puPAzUM5TA8Hkzm/eC4L0fj3rg3G/bH3vpZf93EcR1k7Zha22+3j2xigLhPwHGFgXPZPEnC9vUfzJupOaU1Sj01bobNO/VNK7Bjf7LjbjVJxM/SrCqEZFsY0jQ2opwG2phos4oWBFIskBeNQKrSifvJRccKXDI4jYh0rDl4SQvwzVb+dJ5DFRcolZPVq2gTRAUk5EwQJYSaEziWhpJqTpgPHBjBLpCdvyM6LbfoNyF5cUEavySNxdnnQCkK9Bq5j3bd754b9zOXeOM2+IGLXlftSPrtDQWBy1k17tzj8z0+35/x+zP+z3HG7/H5Pnb3sfvHjN3/Ap+XaOhhfA6Cr8bnoO0ciRpLvSDn+p/DdA6VUgJ2b5EEQZHxdfNat0Os4EokUJpYTiLUunTidatuAtu90+F9l1pwPGqdIljoJCqyCIRVk9ud67C678hUd6q+GJPccqfbDNbZkXioQ8AFGRGI6evzsrDosGkzTd7rUh0zd4ZmZchPq2a6L3KmnhLaQe4Ec2wOBTy99CQehogpyogfLFO7lqIt/aDXVRbd/3ZdHKMHdNllvi+uBnoBSTdUJBVumk63N4S53epb/W7NOUJ1Wn9rsVdE1hfPlMyo15B/unjy09vLp2JBSJMj3bX9KU2lAWLlNVyEM9m0usanSXy4ZEmxcM2a09YPJRQ5wnVXvjPUXnlddWb9ghR/gZzMJqVJitPA17dYwkJd2Zrn+io3Gxo774wvnmtKQNw+SDSlilzhieu00kuu6fWtQvyl4uY7bj5zs083pHCmvQ5c402A8CUWMrJsrW9e3PHz1/hR/YQR4ropA1milKP981ZQ7do3y9Hi5xO/thzvzFtu+mxPEy5rVb285yJYJolVf3OduRQG14sCUfTNYnGnqc8R4feP1kTy3ZK+9gEKWb6XCAzjnMl1xDImSQDXTOhC8j3vLGL+PUrmULxv6czD1zg7iZK6gb9ZZlrQpwV9lwNsKb87msixENuupRpB7xzgtNl/zgSloGt5r2yc3ZXVmX2X59DREEBU5mLTE/flpElw5SfBD4i6pkEaJkxd/+Anqefa8aLzqWWs6jZg04Lb8kYJjsUNuzl569soOip/b/qSxtPm0uSViVbfO0s/kEl+P3n3/5Tx9pnmz5hpSpRLl48XTa/7WVWPNL3cREVOycKVRcN6KDwrUd32VZ/ld0HwF085ohl2o6hpXkxZZ5RGMiff59gPllrxJUGqZE4I8ZD8L4k5XlHPU5JQ1jFaZKBBcFsgVznTEfjxNXa1suSwcvCTdp++24IrFVrLtZR3xFvUbSbA5lHNRo0YePYhKYu3N9i/1/yeyPPKJQDN4rgw1CMPsYtYSDjeI34TahsULr2hhDOqskXCALGeVcU6OSSp0OHqJYvtqzndP6O0XXOPR9aCd9jy8hmmp10su8kbRS5U5N4MAV0b3D/GGz7pL1WUUtWI3AyYptZW+Pn8cosjmBkLvVCdJ9miW06yXaIFEyqinPsMOr3Okc9FBcapCEOdu8acX3aqm82freBLmy5411y579+N2r8b9ZvejSpRBpWH3ZRuNMkrC1euuquB6/oNBYqjE37FgG8HUG8u6Q4BFHd3dO1F5fI9DSPv0p3K9U1TCfMNAsKLPof1y00PuvWTi/KFoqdi52tUO8WurmvNqrmp8fDxo6ILHgh+fwMqdwPH8rgH5U8+/uWKkVs1ceu3LLojcDPcrd4XaW/Wblpev6L7TW9WvnQVu0ujTPL7YPh74r3Df3xJUpeu6M0sGr/zqitY0Di+FUTehRDLD7A7yP4D6h8k0w== +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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.** + +## Request + +

Path Parameters

Body

required
+ +The Workflow object + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/transforms.tag.mdx b/docs/api/beta/transforms.tag.mdx new file mode 100644 index 000000000..ed1019308 --- /dev/null +++ b/docs/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/docs/api/beta/triggers.tag.mdx b/docs/api/beta/triggers.tag.mdx new file mode 100644 index 000000000..4cbc4df17 --- /dev/null +++ b/docs/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 Decision](https://developer.sailpoint.com/idn/docs/event-triggers/triggers/access-request-decision) | idn:access-request-post-approval | FIRE_AND_FORGET | After an access request is approved. | +| [Access Request Submitted](https://developer.sailpoint.com/idn/docs/event-triggers/triggers/access-request-submitted) | 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-completed) | idn:post-provisioning | FIRE_AND_FORGET | After a provisioning action completed on a source. | +| [Scheduled Search](https://developer.sailpoint.com/idn/docs/event-triggers/triggers/scheduled-search) | 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/docs/api/beta/un-ignore-identity-outliers.api.mdx b/docs/api/beta/un-ignore-identity-outliers.api.mdx new file mode 100644 index 000000000..4a942cfec --- /dev/null +++ b/docs/api/beta/un-ignore-identity-outliers.api.mdx @@ -0,0 +1,88 @@ +--- +id: un-ignore-identity-outliers +sidebar_label: IAI Identity Outliers Unignore +hide_title: true +hide_table_of_contents: true +api: eJztW1tv2zgW/iuE9qEXRHbipM0kLws3TRcZpJNsLuhDEqC0RNtsJVJLSmk9Qf77fudQki07aTudYnemcAqkEXV4eO78Dk3fRbZQTpbamqM02o8qczQx1qmjVJlSl7OTqsy0cj7aiEo58dH+VXQ0PBLt8M1GlCqfOF0QCzC4mGovhqdHwqlE6VvlhRSZ9qWwY9EwPXrthTainCpQ/adSvtwQyVSaCahp0NbcRWnFSInKxJqFSuPYqbJyRpsJ2A42d4QeC18lifJ+XGW9a3MGftrRqlU5tU7/zqoJn0BNEuGJlnq/4R/n0siJyiHVflWkslRPoGct0iubzqL9O34ERxindJXaiBJrSkygV7IoMp3wCv0PntS/i3wyVbmkv8pZoWAQ6Zycga0uVe4Xxn3poEZ0v2zA49pYujaWIGvBEK0VxNjZvLER25b4bETqs8yLTJGL5CjZGmynarzz4iXeTKZ695e9Dx+zza1BdHOPH9LSF9Z4xSLBkvRfV5DfrKh1FTHclZKmtYNqE4lP0i+YX4yqkl5DRMSAmU8PbgyuU+nc9UGCHtlgZ3NzVYIDaIjph85ZBxnOWgbjjhQjeIpW1OZWZjrtRX/cSXb0QSUlJhaO8qHUwS6pKqXODmyqVh237Lc32qh44qQmCRWLnGCiAMdbnVLE5uS8wJIcTCowXW/ReWSJ3pZ4JVNxVut3UCsDM5VOJh/Bi3L1awJdGo35opmCgBJjCPXIsmpXydHLzb3BzvjljpSDX3a2dl+M9sZye3tz78XeHq2ew8/IF/9AdHeX/pcyyulEZDaBR36HQZySsD0LwIs/kBCP+IB5fIP9L6BXoG3VrOUVpfqMCiPFq4NTsbMrMlSaisflZMkIJr48x4ipskyOaIhyHpoHxidOT7R5SBRlqpwS7/Xhm+Hl8QVGzg7/fXl4jr+I10qVHJomoyAqYmFqP7HEtQKcVyqDOVTaE89rrs+hkDR+kVCHJz/zMCZiayyrrMSMevUHZiyyDpVkMZU4bz6X4qnuqd4GshZjuSyTqRhJjwk2pO7zIXK+KOPj2pLPxVTJVLlnPTFMU01KykwgG8EU82eU/jJN57k/rpDKEEajSKNoGFvqRHV9MTdl1xtIAl0yxfGiUyg5IPnX42SYlBWEYzUXs7CNllrEpuKlteW60l0sV8GZKWUCLWSWzWBGh+2v5IKoS98WQk22x6bT0LUViypyoxaXu7dBmNel5XeJrPw35N1phvITs2rti1tVJx/vIqEasTcaN9UVCS9JbZ5cU7XuahJfjLXK0nXurnN3nbvfmLvLL89q1FO/ZeiztQp9Lk0DYKHECvRpEVYX5QZHbggYpIZIv767QGJ/VIbo1eeCgOwPxEdhK18Rftj6I4yPCH60zur4ggRkOwYNxqhEKt1nuecSs6GCqbZXV3tj3UgjQM0DEBFV04mZrYSEyVxlQufgN0RqlTdPSjGVqI+SEWyogLSqSePCalOukeQaSa53o/Vu9PPsRmskuc7dde7+PXP3i0iylYqzpcZJvspz6WYh0ur3pK0UIGjP30SbcuyqZbRCzESLsaIucohGg63R1ng3UTup3Elfbu+NB8nLgXyxu7W7NdoZ7EaLe/3VPI/bJOvm1IK/gx/ZxABxt8BxlUFw+dLatHv8B/M6NaayRqWnxc2wOUx602LHwd4qdrywVryVZtYgJN/BkGZuI6ppoM2J1jW0IJBigrpoBEqVhlwUSjpX4OIQNCLTuebkJS3A183i4biEKiFRlk9C8ZxkFSTkSpBZQs0WgaWhpBoT5gMHRrATVOcfiE5rF/0pJC/OSONj0lgcfk6UokRvkfuLh853jyC8oxpxHhz8yEFv6HakQQCgIQg1q8Wda3y+xufrPX69x/8ce/wan69zd527f8/c/QP4vEZDj+NzEHwzPgdtb1O0WOoNBdf/HKZzqtQScHgLmySV4+PmBoMzrkAokUCF9VxEZDnFU7+5kdGvTLjkgHcB9Qd5KpeBbFqWhd/v9+/gJrjnvicL3WvuSRj7qZfYvD+CbR4oO3Q/IKQYEfANlbBAjw3rNMVuKHTMPJiZVaEohbn5SPiLnI3M2X8zW6G0MZsNgTiv44iHIWKBJuKJZ+oex82KftDr0mX3f16XwOgRXR4y3xdXA72ApEsqkgo35C74G4zYX5eQ5yBUqWFFLr66WaQ5J1QeJFyhnO801MkNVgQ6IbKBeKWkQ8sQPtx4+uu7i2diQliUa0HlCQYrTc0DsukUYcS1btgc9NMk3n6crSZTVm7Y+SiFckuMMxhFXJtzpcRVc3npN2wCZ6jabHaapLhQ0Kybp40HU3WrMtofe3NrU3Dq1PRhxb7szHvGeyE3Ddrgz5xHe9cmFq81lShNezrR1CqG+09XRaOXXNDre4X4R8MtDtxi5uafLUkRTHuVhKs5CRKcWMjMs7W+e/HAL17gRx0WRojrsgxkiVqO7gdgSeO175ajwy8mfl05rs27qcZG250mQl0THvtkloojkUyt9eqfQlDoUKpcTSpk2neL9YkWjTkj4sHmgkhxWDLWMWAjy3eMxDAhmOSItm1GLRaAzqQhbd+zZ1EX3qOpTsX7js48fIXdlShTm/jvlpkWjGnBONQJX8sfNi8KLOQ26cB1IATAwdz/XAlqQRdqY+D1YOVn9n2eQ9sHXfljLr7YDw/78yJY/xUuBhJ1S4NSTai7/UgQz6LmRTtYx1jNecGyBVflzSw2ziW7BXnb8yraTP9q+pLGw/mxyonJZj+6Sj9SSf46dff/VPHWleZnrDQ1DqbjybP5PePDb7y6i3Ycccry1p3GYna8qsHg6vkgHWBPFX7jLSc5Y3V0QtzbMfxZZFRksqR04HKQTLXik4VCyZKA5QaFpM05hQtnqW6gf2RGEwca5LsH4JUjnYEfn303K0vOtIBaKSDo2Vfc3tBa4Q54T7xDs2cS+JMaPbq9gXcfbN3xncOlpxQR4nUTJUBreY7OoZxRQle5kIjFr4RSqn1ShYqHvs+oxhaWMWM7q0l/ilFSocctj8v9yZgOrdEPL0TMV9ZCwPj6xBqmJy9SC0DdVKvImco4pImu2xN8jTfCNJ6qrKBWE+UayE0trPD26GKFI5gZD73Q0ls36deTfJ9owYR6rxA+272t3mbMvQjGqXNDc7zAnL4Q0IRP+80AcTnv5DrReDc/sv8JvixQ74LUvvQLOpMjE1Wh5QrN7VVk59+haNtbpPKUWmC8vrujUxvq9+5pGCrSkcDVzbyV4/YJE/j0hvurj4pODeqPC+KLGe/p9fHA6ucg1GGGGeFE6Iu0Nwtd+ukJnY1Fo/qrEHk4cHDyEwbp9350jX94sEWIWvq+BI3fRc3xHWgCX/r5Lxe0tGE= +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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

arrayrequired
  • Array [
    • + +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/unlock-account.api.mdx b/docs/api/beta/unlock-account.api.mdx new file mode 100644 index 000000000..72c04c4e7 --- /dev/null +++ b/docs/api/beta/unlock-account.api.mdx @@ -0,0 +1,96 @@ +--- +id: unlock-account +sidebar_label: Unlock Account +hide_title: true +hide_table_of_contents: true +api: eJztW1tv2zgW/iuE9mHaIrbjSy72y8Jt2kEGvWTTZPuQBltaom22MqkVpaaeIP99v3NIyXbsJG1nsDMtjAKFIh0enju/Q5PXkc1ULgttzXESDaLSpDb+NIxjW5oi2okKOXHR4CIKb1x0uRMlysW5zmgMRpxNtRPDk2PhytFMF05IUUj3SRRWeGZCGiH9cDwmIldFmRsniqnylMdHTSHemyGGfFJGXOliKt6c/vqf4dGr49dClsXU5rqYC8yTq/+WOlcJcY9lmoKJn70JWZ2KSyKEvNfRuVP5M2sK9aUYggPpoBMzCIK4hitkoQYzaeRERZc3UCuTuZypQuWOGWhSLpMYuhMZfMBfOqFZ4qmayWhwHRXzjN66ItdmEt3sRJV00aDIS7VuKFXbgTmpL3KWpcRCjbuH436v2ztQ/d7efme0Nxod9jo9ubff7R8khxHJR9yVK57aZE6z354sJmXhM3ySWZbqmJ3a+uho8uslsVelOvVcRelg1bHNaxG98ygEvJp29FHFFBJZTiFTaOWIG+yrciPTf6tcj8OkFEm35zkeC6eKHQqGaogAp1g5Jz7LVCdwB8WELDgwIE4uriQ8Ra5mQsjHocEuD8ZoLuQLblg2a3fcbx/uHnb3ko7aa+8f7rb3km5nfNjfjWV777BNPvNqHh+9rmL+TslJLNAtfOiCjSCYHEMlpriy+adxaq9EbEkKKLUk48jaVEmzLORYpk5BDpg+Vie5/awdpiVN7hQkW6ISZVZZbhFdsoAtRmWBN96azpbgjiwTnK2WObIC5PWrKbJueTw+GFsINzexTzVlXJkrT1PzpuE8efI1GkLFQhfslmDpczZeiL/o5uaGM8hl1jgfWp3dzroRhiSVrxuJKqROXfTdsV8VNSGZaTW5IHZSs3nDHALmQsXIC/I1E4fYjZaznkoMFcj7M0ZvyA6dCDuuK+K9Qd2JOah7B739w24i93fb9LTf78YdPPf3og2mdmy1U+XKtLJ0b3d3XYxnqYYZxfM8RyFoiFOu1FBZe9lC0okRShC5XxvO3Oa3eOB+23hzP7OJWi+wt+vpC21UY5LDUZBQscgxBvr0SMh5M4ug9Swr8zJdc8WgsESzLZ7KRFS18FlQhgyZy/gTePmSdr9A50ZjvKiGoMhzQb1jWnWg5Gh/t9/pjfd7UnYOe+2DvVF/LLvd3f5ev0+zzxBhWJ/c0twyz+V8bepflUH9jQUyCh75XdEqK2F7FoAnxxBdqJl72AfM4yvsT+uZp63VDPIKWnVR6sXTZyeidyBSaSYlv5eTW0YwjfO3tMCWaSpH9IoWM2juGb/J9USbTaIoU84o4Y6evxievzzDm9Pn/zp//hZPxGsNpQxR7kxCYQlREQtTVOhiocCVdKitKcyBaiaeBK5PoJAMSCUQav+XmzsYE7E1lkgpjAizbxixzFqMcztbSaXYQxTxSDdVc0eM6N1MFvFUjCTVZusr8xMkssqKxstgySdiqmSi8sdNMUwSTUpiPUU2ginGz8FIyCSh1PUMxmVBFZwWUFsWVN41FoQVXyxMueqNRTV5uewUSg5I/nCcDOOihHCs5nIW1tESRAz+gczecqvSnS0ZjU06R42OoQVQ4BxmzHNYWGBhEoRBQzkidzkUHlPR1RVruUhyuXvlhTkqLH+LZem+Iu9OUpSfBqtWf/isQvJV0AXViL1RuSlUJHzkgk+DA1XtrirxxVirNNnm7jZ3t7n7lbl7++NpQHXhK0Of9jr0OTeh0aTFcw365MqD4qob/Z3hTXDkjoBBAkT67d1ZaGNBr75kBAz/RHzkl/J1IFv7w78fEfyonbXiCxIw9FukwRiVSCUDlnshMRvKm6q7PtsLm480AtRsgIjct81tKSRMlpeGQbR0OyKxyplfCjGVn7nRoL6PKyDNapJGZrUptkhyiyS3q9F2Nfp5VqMtktzm7jZ3f8zcvRdJ1lJxtgSc5MrZTOZzH2nhO2krBQgW+4t1yrGrbqMVYiZqjBWtIodo1GmP2uODWPUS2Uv2u/1xJ97vyL2D9kF71OscRMtr/cUij+skW82pJX97P7KJAeI+A8eVBsHlCmuT1e0/mDdXYyprVHpq3Aybw6SXC+zYW8eOr20B3cAY2DG/Y3vx/PQl8cfUzJ7sxvvXBLO96fzvBAQpeaNafdGu2ELHLXTcLj/b5eenWX620HGbu9vc/TFz95ugY+8h6Nj7BujYEwSxxgSx/kromAB3EDQbwynQIS5hXkOwMYMqeAq7jyHtC5lPVFEDvRUU2emvo8gza8UraeYVWHIrO5FmYS4qb6CdEW1e0YJAiglKpBGoWtr63971TBEmRfyIVM805zEpBL75vDHkAx4+Z6p4q2fRJk5LSMhFIbW092oRYxrhpMYE/8CB90EnKNR/4h5n8NYf2g8Wp6TxS9JYPP9Cp2xgwnr/d2/TKYFjE87vvPW+vuO4gN8zlwZthPqS+fJVQ9AtVN9C9e1yv13uf47lfgvVt7m7zd0fM3e/AaoHNHQ3VAfBV0N10DZ3RY2lXlBw/d8RO6dKkIDDW9iYsXqywOCMKxBKJFBmeaOVj8UPolZ1mr51rZObVn1i3PcAXqQyT0E5LYrMDVqta3gKHrppykw3UcDgrGJu7FUztrPWCObZUHnooKnPMiLwVw14gibbNtcUvr7WMXNvadaGAhUW57MF93KmA/7kwjn6D+HZ7AiEegglfk0HutFH/OKYusmhs6Yf9DrP05s/rotndIcum8x372ygF5D0loqkwuXi3sRbAt1+9rXbE4uFhLb7O2uTvSGyjniqZE4H4fkEzKPf3p09FhOCmpzqpSOUqzT1BkiWE4QIl7JhdRqEBvHqkttyMmXBhyvnbSh1BJ2ub4r35q1S4uI4GOE1avwpijKblAYprgM06vJR5Z1EfVYpLX/NhSUp8HRiWrBQS66Me8xLHfcE2uBxxm+b701DHGmqQJqWbKIJKnKLJy6ySi+5pNf3CvGPilvDc2swN/f4lhTetBexP78dI3+JhUwdW+u7J/f8Gkv8qIHCG+J6WwayRJBj9ZRUXHntu+VY4dcgfqtyvDfvphrr6Oow4cuWcFgG00Qci3hqrVP/FIJCh9LgYlIii75brCuatMEZ0ejsLonU8FM2dAOokOV7icQwPpjkiFZlBiXW749wSn5gzyLnP/AtqQ8rOvPrCyyeRJnY2H23zDRhgyZs+BrggvzhogOERW6TDlwHfAA8W/ifK0EQdKnueV4bqzqzb/EYWhpiiMpcXDbwfwwWBS48Cf5A1DUNyjCB6vrcGN39CrxogVoxVrUdcNuC6/KmFuviLbt5eesfNWmt/LvpSxoPF7smb0w6/7Or9B2V5O9Td/+iiretND9jpQkwl3YfTxe3LJ9XDcndtxwfvmK46YYh34jbeOWvug1Igc8GCJ3Jcro9DchxfT/R8RU9/I+vXDUY26Nzqi5OKrHMKEtlQfnF9SWeasU7EZmSBaHQHYpxO+OaEC67od9kRpMcNCggDuhYjnQKfrxXXs0sOXU9xKUIo79dGU5uWCQHOlvVFO/QHBqYJKfGkM4M49tHGzrEt4iREwoxcVSFHeDfbFYaugoMscsZ3W58KDYT7eLSl1D0iUZVtrAMQutRVT2hoCcV+EajymfuzZg2udE/L4XgA3MhAqs7iTA9eTFcH14ocqpSDiGiW20gHuKNuG9MVZpRa4r6DyiolmZ4dXy2xhHMTPhZxeaTVhjkWkQLJtSo+fDpNtvN3QY3LnhPnR6a6SXm/r6mWNwNX4m+68WW/t/oSnhYDqmPaWW098ZXfn1f5ZvYi6hqYkE+4HvZoY9FZzSldhck19e0Q0ON3Q29RoWg9v/ictGzca8LJ9FzUmf4nRZ6dBqkfsy/Ma1cC98oc7WraOaLDYUIj58U7UNgHLp1yMsbRSyL/xB+mWiczRlfVAPXfnKhTtaP8JtP99JeLm0InLyhbbhoFC6lz/zeRi6v8JL+H0Tv8Q9/+DvHXI/5/XVU7RSCxvOtgNwmHBMeYHOQ/Q91m5W7 +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Body

required
+ +Async task details + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/update-access-profiles-in-bulk.api.mdx b/docs/api/beta/update-access-profiles-in-bulk.api.mdx new file mode 100644 index 000000000..dd0cfe30a --- /dev/null +++ b/docs/api/beta/update-access-profiles-in-bulk.api.mdx @@ -0,0 +1,93 @@ +--- +id: update-access-profiles-in-bulk +sidebar_label: Update Access Profile(s) requestable field. +hide_title: true +hide_table_of_contents: true +api: eJztW1lz2zgS/iso7kMSl6grih37Ybdsx57RVDL2+qg82KkNRIISJiSgBcgkGpf/+3Y3QIqk5CNOdndmSpOqKYsEGn1+fZC8CfRcGJ5LrcZxsBcU85jnYj+KhLWnRicyFXasDor0U9AJcj61wd5V4G6z8n7woRPEwkZGzpEOULmYScv2T8dMKplLIGgZZxMgwhx9phOWSJHGzIh/F8LmfJIKlmjDtIKbhmXaCNY6pnutrtXfGRsnjKsFkshnAk6IZQQk4/ZyBiyIr9Lm8JdiJ2bKlfydBO3APgWbtV05g32RacomgvE4BpKwcWvLsRxvbV0rBv+lQLI83Ag718qK7lldDBLMrVhzQsbNJyDNLZDOTSG2tlDgra2EpxZ+PEFKpXMWa+H++CEiA6FjXSiQeb249wpV20ykkSsg79XYJen2Wa4/AUdfZD5DR+mwk7Of/rX/5t341w47P7k8Ozwqf4Fy/IXzywO6xngBkhiZL1B69CBp4PBcs4jDebl3vi4bKxRKkgLAAdtkMg76VemCFaCVcheS8U66oqiZjGaMg2dya3UkyR4kwbkuDKxFJS3cAnQEoMTjDELA5sJ0IX68sx/oeBHs3QQl58Ee+kEniLTKhcrxFp/PUzQ4cN77zWJM3QQ2momM41/NYHvrLeTZnZfswvE1tWP4LuYC1nNj+AJ+ylxkFsn563rym4jyoB3LTS08s2zCrYxYLHIuU4t04UTAkFwKoibjGk2bG6mmD9Bk4zdIRnzl2TzFXaPtERc7kyTc2R2IcLSbxOFkZ7Qd9rf5UIz46+C20iUqunbeROtUcPXQgd5tyogFFwMnbfBA0Xh7e1u7dOVke5i7FnOO1IdOzd5XSKm5DO7nMifxG+iL0HtJNvQYEzyFp93tl6/u4IuELCObLDjs79ztZd6fAJxiiuzydxusgyf7c8tWB7W0UQHQN3jzOu9sHjiOgUsJsG1qYVS5imokLq/BGgOViy/9dxjtDF73+Wg74TwWYtQfbCeTkegPXkfD/vZouMZ/71XBel9dcfmW83aANZ4XdpX8tboANP/54uK00ihza1mkYzwvL4wCo2JG5oqyz2cZFzxtayef8bwWTX6L11VcoGbamb8sN3yiG/YHkFTDFnohzdKzbEG3kiJNF37TqD9atwn9McHUA8vuN1B/gDZoaKWtpJ+LDEQ3gsekd6+f2hoKAfRxDhCPcvpUA1oiz/8KmlGgjoy71RNd5KUwaMYE8LMA/TORRw8xjEJ/k4bORCKMUNEyMst9lLDGMbt+0E2vA/aF26ZWb28fwLHK6+4CNAdmYwjXJyHZ8gBnxnWg9gD6r1VbcPsYBHbB8j0Q/N9inmB81O+vOvJhKgHf2JEx4HQheIYPblkWdcQBm0BVgk4l1WeeyvibAPx+zHWlwiEgy8OVwbFUIpwaCCngUBDLBElAERAIw4xaA0eyrEtpXauE6Pe7A3bAY+bTJjv0woCacsOjT0Br/IhS5VJJ2M/KLUw6iLvjWLEj+GS7vzscJeAOfPh6NNh5NdlN+MuX/d1Xu7t4egZm41NRT1ZlEmse/ZNQwkCplWqoa+XvArslDronBujwx+c9ovEI/WNicGsrMT2/DBENy+iDw1M22mEpV9OCrvNpSwkqvDyHKwp80zk21rcguSN8YuRUqnWsCFVkCCpvjo73L99ewJWzo39eHp3DX0hrpc3cV2VjpCl1z/QX4tgLgOBlRQrqgPqXbXmqWyAQV7a+ULpfdgEZLAPfSniR5rDDn75mR500S4zOGqFUwv9z2RXdDlThcA2yADQPUDvDBq1o+RaG9jwP33pNbrEZZBthXkB/tcwlEI0FdViLRpOGBJICQtkhOuYWAGoZiaYtlqpsWmOJdW/rRsHgAM4fU8HnWA6QmPUorLzFs7hsXJ3mmtxd1JRGKl1ANo1ACujjFqBGY0DDUD5AJs0t83CE5rIAPKpcVyEWQmApFsHdO8fMm1zTvYgX9hFxd5oC/IQkWnXjs/DBR32VQyNRT/kekeAmik2b/arKXGXguwnBJnY3sbuJ3UfGbvtmWYn5u1T6DFZLn0vlR0WYPFdKHyPc9KycJ7lRmTckDZ58ifTL+ws/r6KZ4hyL3x9YH7lUvtoEVvZw1ydYflTGatgCGSQ9OgmwsxDxHvG95JgU5VT1cvW0Y20mEhxUrSkRATUNW+iCRlumUK7dsR2aOqpnOZtxwEfuClVCQDxVxeFcS5VvKslNJbnJRpts9NfJRptKchO7m9j9c8buvZVkxRVFi6+TbJFl3Cycp/n7KC1nsGA5QK9CjkzVrlaQGKtqrKBZOQST4WAySHYiMYr5KN5+uZsMo+0hf7Uz2BlMRsOdoJ7rr5ZxXAVZM6Zq9nZ2JBVDEfcZ6rhCgXPZXOu4Of4D9RqRIKzRg8uybgad+/Giqx0Hw9Xa8RQMpJXzVXZMxWejilRLLUFFuX867h0LTk5LT6wVOmT1sEHXHlv/wNLR6++7yux7WYf62LSYr5Q23F0990Jr9g4f8fuy0t6lMkwEsDbDtaZcCws4m0IyUQyElNq9cCAzAVQMPmdJZSYJ8dD0QNcswv0kB/s7dCkjc2kYFaUFcEjwmWrUgYZolPjsPsFCGShQ2T+FlPZHs8sZSvwWJWZHXyMhEB0r7b9aNxQfA/MGgfXcRcUd03HXIoJXFgq6KAf0VbG+aWo2Tc2mMNoURn+NwmjT1GxidxO7f87Y/YamxldDdzc1sODRTQ2s7fZZVUsdo3P9z3sbChXPAbk301FUGJrRl40Lvgwl4KLMF3TIJTRDh86V96HTcW+yqD03wg79qzJ7YAgsTT/gqyGZAE9EeebaEgZx3Bb0mltsD991Ct1LGmHrvRiqNJ2QhUlh8yzP53av17sB24PNb7t8LruS3kbLF0p/6UY6601A4WuwTNoytnEBvbnqDuiStYzEUx16EnFnO9IPuj7YkIbz91JWPCOnoNbGkekwCB7vnHQZWJxDZ/LM0mrqeTor8oFclya9/X5ZHKE7ZFmnvntPg/UMOG2JiCJ8WPrLOZbx7vQVr1mmJuyXhyuHneCyITsQ3ECP4R4hPf/l/cULNsXilcCjsFg3C4ndBoTfKbgIgeN++TgFN1G+MrqYzojx/cYDKwxGlqQgMLtW50Kwq7FXwq+QNc4A5kmluEkQsuCuD89L68Tis0gxoXaXmkTHg4DogYZ6vLHvBSVP6jJqb7d1r1XI3kjENIlFAK7xIrpXAK/mpVy8JtdTmfhbSS304UfU7IsWF061V5F7ASoCREASPLWkrScf7uiFNXrYksEVpNrmgd6HdHw0HzNGpdWezEeDXoj0mnxcq/fujfXGNuaQjFlIrGnMxiyaaW3FPxhD18EwuJoWEEVPZotekw8pIsJhv8ZS6I4MZQh1JvH3FgJDOWdyr0dSmaOhAlSxC8mPZFmI+Y/0uuXHhsx0+QrSMa6MdWSfzDMeGOKBocMA6/n3b7m/oNczUQbCAecAh0v7ExJ4Rmu452itRXUi36M9mBoiYJWo2Pme+7G3BDj/F6MbuLpaAzCMZXr14BU/f/C0MOU1lFUOGNoaXOU31ZBpW3pz/FZTQcy+fzR5UeL95RzmRKWLH43SdyDJHwd3/0+It0GavyLS+MIZ55lnyy+Xjn7Y9zDoxySPb13q0XPgC8HVgSN9q0Uf1p2OCQSo+IfWyr3ZjuVRndA85TmGC8FFNJOCRhVzwYmbDrqszijEoYRHXKEv4oDQ1MAawAMLxS6fyBTo0TC9PJkb93EIMooOg79tQf0SfYo2g9ZXdNl76B5VBPbGzhHfoYF7v2nfQp6DyU/RY9ib0ougmsuyQuHHbcB2kTEOvvqAq8XSRoVDRGgklSh1oammrHaV8IA+jCLQRyTCZPYkwSk4NNg1j3rgLHAo60fgoHq0Ipb/2J5VgpyJlFwe1zX7gYdogxuHM5HOsXcFOBf4yv3yhHfjixWKQExZ+givq8205zfZHq4FIth3Ofd52R10+yH1IXAdezlo8mrEL9d9+vfcvmh+qIoDqm7bNW+WDwQ2H8BuPoDdfAC7+gGsr8Owge7NcYyMQVi4ht4NVK6C1kAFdt01UoEUMsNhDGy6ucHxI84YbvEyrMHZ1tWH5fgAf8FhbgxJyeuTwPGXf+4VXiyo1vRzrtUHejjVcDvcaPPetfV50ekJDnmDif/oN3OTM8O/YF6E/+8F1/APfui5Q0v8Mhiv3wTlHBrWOLplUb+upvV/oJi3t/8BhU5KUA== +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 Profile(s) requestable field.' (update-access-profiles-in-bulk)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Update Access Profile(s) requestable field.

+ + + + + +This API initiates a bulk update of field requestable for one or more Access Profiles. + +> If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** + list of the response.Requestable field of these Access Profiles marked as **true** or **false**. + +> If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. +> A 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 update Access Profiles which are associated with Sources they are able to administer. + +## Request + +

Body

arrayrequired
  • Array [
  • ]
+ +List of updated and not updated Access Profiles. + +
Schema
  • Array [
    • 201 - Access profile is updated successfully.\n\n> 404 - Access profile not found.\n","type":"string","example":"201"}}> Access profile is updated successfully.\n\n> Referenced Access profile with Id \"2c7180a46faadee4016fb4e018c20642\" was not found.\n"}}>
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Precondition Failed - Returned in response if API/Feature not enabled for an organization. + +
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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/update-account.api.mdx b/docs/api/beta/update-account.api.mdx new file mode 100644 index 000000000..1a64c0f67 --- /dev/null +++ b/docs/api/beta/update-account.api.mdx @@ -0,0 +1,109 @@ +--- +id: update-account +sidebar_label: Update Account +hide_title: true +hide_table_of_contents: true +api: eJztW1tv2zoS/iuE9uE03diOHedivyzcJD0nRdpkc0EfkmJLS5TNVia1JNXUDfLfd2ZIydckbU+x57QQCqSKNBzOnd8w5F2kc2G4k1odJ1E/KvKEOzGIY10oF21Gjo9s1L+OwhsbvduMEmFjI3McAyOurGBuLC0TKsm1VI45zTwbxhXjfiC7lW7MODsbXB78wYz4byGsa7IbdTkW5a9sUsCP3OhPMoGx7NXF6Zsz7uIxy/k00zxp3qgBcP8olGd3ev77fwaHr4/fMF64sTbSTRkIguykEQkKEvMs8+INzo6boJAVcYGEoNQdym4OtHLisxsAB1RUJqofZLb9CVd8JKJ396B1zg2fCCeMpaESdc85DNqMFHyA32SC/OOxmPCofxe5aY5vrTNSjaL7zaiUK+o7U4hlOwYLs+NDFFN85pM8w/Ei3d5Pe93t7p7odXd2O8Od4XC/2+nynd3t3l6yH6FwwYIvdDLFqZ+YiWUSDK3TyjnBXVUoWPpiEhAcjejAR9foDUbuePds7Fxu+62W0zqzTSlc2tRm1Bq7SdYyabzb2+psMOu4SrhJUJ0YjQwBBbLxPM9kTNO0PlitGjny/Cc+4ucV+3Fj+BRYSCcmdu69Hn4QsYvu7+eMBX7ROXwzIs94LKJN76F+1IKIUg7cfow++sSzAll04l57f2u/u5O0RSJisdXeSTp7vLe309vfFp02mPb+nhxnczCKoOk7Wx38b8V5IncQcg12LlxhFDzKlAxXBvctt8wWQGdtWmTZFE3sx0DOeBvbqQUln7DXWiNVxkBxu1tbqxIeZBIYsiNjtHlEyiFEEOaQVGAk+ZTvHpMFbG8woJz0dkuE4zI70IlYTY7lCH0plWiMDJcooSCRYxgYagNG5UQbwTxLDGRUgegWcwcs0WyzFzwBfb1+B0EZMJMzPP4IvLDuPSXQlZIwnpVDmExYCkI9MK3YE3y4u9XrdNPdLued/W57b2fYS/n29lZvp9fD2ScQB1Bb7JpIX5z6d6GEkTHLNNQy+QUMYgQH25MANPnDybHsA+LxFfbHouxpKzWDvAxr5SYU5xcHZ6y7xzKuRgW956MlI6jG1QUWRwh2PsRXWItAc8/41MiRVOtEEaqYYCU+PHo5uDq5hDfnR/++OrqAJ+S1sgANFERrgmEJokIsjPUtSRwUoLwTGZhDJE32PHB9DgpxqHNzhNLOJSHEVsqLDJao52H2NSPmWbPU6MlCKsV+YWHPZFM0N9mQVjhazobcwgBwIZI/97WjcRIs+ZyNBU+E2WiyQZJIVJJnjEqWhfFTYMR4klDdIAZpAaksaEXUhWNKOxmLRV/MTLnoDUgC6YjiZN4pmBwg+dNxMohdAcKRmvNZWEVLEDH4B2T2lluU7nK5Sk6V4zFowbFMwjpkwMJsCLpJZ1koR+guC4VHlXRVxcISWKpF5e61F+bQafoW88J+Rd6dZVB+GqRa9eGTCMlncVmskMrMTaEihXpOgwNV5a4y8VkqRZbUuVvnbp27X5m7yx/PAy4LXwn6tFehz5UK7cGXdQDNUPQoXfYQXwjeBEduMjBIgEiv3l6G5gObnc85AuwfiI/8Ur6KLCt/+PdDwuSlsxZ8gQKSHb0GKVQikfRJ7pnEZChvqu3V2V5qM5QQoGoNRISqadhUF4yDyUyhFErC7SZLtLDqN8fGHOojJ4TrK6BvChvUFdZIskaS9WpUr0a/zmpUI8k6d+vc/Tlz91EkWUlF2RJwki0mE26mPtLCd9pCZUDAyh1CVqVc2GNcRCvIjFUYK1pEDtGw0x62071YdBPeTXa3e2kn3u3wnb32XnvY7exF82v99SyPqyRbzKk5f3s/kokBxH0CHFcoCC7rtE4Wt//AvEakWNaw9FS4GWze9LuhATt2V7HjG+1AN2AM2NE8sL14dX6C/GFqYo9204WJBcJsbzog544gJcYwWFpaV0PHGjrWy0+9/Pwyy08NHevcrXP358zdb4KO3aegY/cboGOXIcRKEWL9ldAxAdyB0CwFp4AOcQHmVQgbc1AFnsLuY0h7x81IuAroLaDITm8VRV5qzV5zNS3Bkl3YiVQzc2F5A9oJ0pqSFgg4G0GJVAyqlgR0i1ElJwIxKR5xyOREUh6jQsDXTBuD1IFWPmfKeKtmkSrOCpCQikKm/XmIWy4hnESK8A840D7oCAr1D9zjDN76U/vB7Bw1PkGN2dHnWAjM+Wr/d2fdKYFjEN5gubjwvn7guIDfM+cK2gjxOfflq4KgNVSvoXq93NfL/a+x3NdQvc7dOnd/ztz9Bqge0NDDUB0IvhqqA21zi1VY6iUG1/8dsVOqBAkovJmOCasnMwxOuAJCCQWiY7jR7MRseQi6dSeT+wgPTiMi9MIUJgOS8hTwHfgIfHPf5Llslgdtlb5txnrSGoJh1tQcPGLq8wsJ8HB2aC+aZFUjMXB9lSPm3sakB4Yo2JpOFTzKGY9lo/Om0Hkwz2aTQZCHIKLXIGIOHcRvlqibFDQr+oFeVya7//O6eEYP6LLOfI/OBvQMJF1SEVV4NzvnfoFw28++ctp9toTgRn9nZbJTJOuwF4Ib6AX82Zdnr95ebrARgkxK8sIivhUSuwI83w8hQkVsUJ4DwUG0rhhdjMYk+GDhpA0mDUszUJjdqAsh2PVxMMIbqO7nUI7JpDhIUAXAUbMz6In4JDJc+JozS2LgyUS1wEItvjBugxY56gakgscJvW3eqAY7lFh76PQ70gQVqblj13mpF5/T63uF+EfJreG5NYib3ViSwpv2OvYnt2PIXGTBM0vW+u7JPb/GHD9sneANcl2WAS0R5Fg8HxWXXvtuORb4NZDfohw36u1Ywgq6OIz5gsUsLIBZwo5ZPNbain8xhqGDaXA9KiCLvlusW5y0QRnR6GzNidTwUzZkA/AgyXcCiaF8MPEhrscER7TfGaGUfE+ehZx/D91ywt4v6Eyvr2HZRMpEx/a7ZcYJGzhhw9cAG+T3qxIGFuQ26kB1wAfAwcz/VAmCoHN1z/NaW9WJfYvG4NIQg6jExeZ9/0t/VuDCE6MPSF3RQBlGOF2dGMO7OoEXLk0Lxio3ApYtuCpvpmFFXLKbl7f6cyaukn83fVHjwWy/5FRl0x9dpR+oJH+fuvsXVby60vyKlSYAXNx3PJ9djzua3RVDmITBSEKFPmE+BV4ENLe6u0dXHgX8hK+UyYS0oY/x9xIR48wzyjPuMOYp5+OxFLQvkAvuEBluYtzpCeUptPBYHKD7I0YjAzSQ1BYQKx/KDPjRznU5M6d08rATvY6/2yKco9AQsNBniiZ7C62aAjRvsE3DE7zw7YMO/doF+O2M7m0elqEAkGwyKRRepwSxiwnjEHBPxEsibVz4sgZdmxKlLTQBw2pUmeMYiKhCkxoWM7GnKW45Qzc7FxZPzAVRYcN+M5gevRguYs4UOReZv9AIdIug/ineEIuNschybBShJgM8E3MzvD6+XOEIzFT4IwdehgyDbAtpgQk2Tz58tpvt5laDmgl4n2vroLWdY37lb2POLuEuRN/dbIP9Z7t7G9YxbEBaOW6Xof6Fb4h823kdlW0nkPdlgteNx2Ag/HJ3h3sp2Ijd42sQGxv163ezHot6U3AgPkNLm0LBWb78Om+9Z+dB2A22ePl2rZzl5p+azvr+CB4/CtwuAFGhqQZhaT+HBPEfwh8QGpdTAgPlwMduwWIH6gf77aJHhtHl36qFJwcD9TBcA5747QjDb+El/uxHN/APftG5zwogovd3Ubm5BzSecYnA1gGQ8ADGB7L/AW9Vu7k= +sidebar_class_name: "patch api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Update Account

+ + + + + +Use this endpoint to update an account with a PATCH request. +The request must provide a JSONPatch payload. +A token with ORG_ADMIN authority is required to call this API. + +## Request + +

Path Parameters

Body

arrayrequired
+ +A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +
  • Array [
    • + +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/update-campaign.api.mdx b/docs/api/beta/update-campaign.api.mdx new file mode 100644 index 000000000..c16d5cde8 --- /dev/null +++ b/docs/api/beta/update-campaign.api.mdx @@ -0,0 +1,124 @@ +--- +id: update-campaign +sidebar_label: Update a Campaign +hide_title: true +hide_table_of_contents: true +api: eJztXG1z2kgS/itzug+b5ACDwBBzH64IJrtsObYP40vVOqnNII1gNkLDaSQ7nMv//bp7Rm+AHTtJ7UuK2q0YSTM93T398vRIM7eOWomYJ1JFY9/pO+nK54kY8uWKy3nk1JyEz7XTv3KGIk5kID1qyrIG2nlfc3yhvViu8AFQGIShutGMCMlozmTky2vppzxkgRShrxn058yzFFiqsVWyEOzq54uzU3bOE2/x/tkiSVa6f3CQKBXqhhRJ0FDx/GCRLMODOPC6R033OdMJj3we+w0HuVjFAtgTIEYSp6LmaOGlsUzWwP6tc6lFPFRRIj4lgzRZoEjSj/oZG30jONCp3I0F9533dyDkisd8KRIRayInUdQVB0I1J4IHcCV9+K29hVhyp3/rJOsV3tVJDPI5dzUnFv9NZVywV1XbFBQwPmYqIFXk2knEchUCY2wmUE1L5cMkCBJYfIJGIY7heketl82Xh73WzAu84GWz1Wt5blt0Zh3XbQWegwLg8EInr5S/RvYe5mbAQqkT5KaYJ1IQy81FM+55KvZp9tTXTuC7CBVgDSRZ8AQGjkBotkJqwmcgdyBiNuMaLsCCcDzonaR6U2dA6100Ni1eXEwHP46OX9imNboZKDRR5NuOVx2q/y56wXBO8W9JLXgJFqaWSxH5RgWjiM9C4ZuG3A9lRJ3AAmR4qgp/KbXjaaIm4lp9FOQoeLPgdjCcjv8zejq3xeBgFx5aeZTgJPPVKrQsHPymVVSnTv/An/h4y1h5HPM1+gCYnS7dV7PfhJc4d3clqwMnUCt4FgswUA89h9yh7xyQP9Scax6mgixbasM7W3ANrIvMmPy/gV9YMp5a4chBrJYlGhnJsnXevb+7I3fSK5gCQXy6zSb+qRrxGCIPBgRNejwfTIc/FebLdOp5QvjCrzGwQZjZJI0jXbGkHzSLxA08gsiiQaXUsfGwinfq1eoPoqlMyGMvQrlkpShbeOOVY0Uvy1IzhDAMxShBIo3YEHK2Ig0S4/5ZFK53u/bY33SYzVjS7B3N3F6Tu90u70IsgV+93lHgzZrNZg8jmQl4m+qeluMWNmmwMQ4Es2/kZ/ALwiiFFZ5HthrTK+FJTA8qXvKEkgZpVeh/Mi0E8frhICNdzzrqg1vp3x3MRYRTKj4wcMuVklHCfOWly2y+kCw4SAIuqRuZJkvaKkR/wyM+hxiTz8vdhu62Vf2ABkqP/pyKKAQfXYt4rSIB1i4w/CqML7G4lgLiE5utcWAZs6XRj1GLCTi7dGK4hzvo4vVEbllzVVHgZBBTgRHiMSPcYIziBuWcZQq5CFiSJkwGKbgqXUH6gfkCfrmXyGtsWkkEDPW+VilL4nWlVQl+3MhkAdfZuOQbyudroJ2Nt+I6qRGdGxmGmAOEvEYinWaTiTiGllkw2sjLTbdZb7brrcNpq9lvwv+tRuew+wtq0GjtMRaFLcqZuMGGKoVgCgoBMANzDXNU0QwxEaVLDCZvBqeQACdw5+LscjIc/Xr29tRcjgaT4U/wY3J2Mvp1ePbm/OxiPB2fnWKUKfmE7Y+R/56sVpJiBrle8GhLDNNSm8TIohINMkpyjVI08kXA0xBMKOChFiV26BpY2Uqij+DB4lLsirYNfb9s7N0Q4AlKGA/G2yM32ADS0SoB74OYzcQ1JElpwjS2h7DvpxA4AsGN7SPqCSiu4GO4xOyFyCigTlFOWLMsLvgMk6sZNoeVZNHSJkpGMjYYWh0kkZBRCjdtiCiFBTuSzIcGZmOIOaQHKxkYbDzftsp7lYtCg24N7nlaoMX4kcYxRDkLmxo7UmDmDuej0+Px6Y9o/wQM4cdwcDocnZibhL8G09LFCFuAc5yM7F17QV1Hk8kZ+hJ6EjQ9rrqO7X+HcAH4Q3X7F08RcKPXFs5lKCEr+3Vp1i1KvIwKMmBjUeUG8ypFXR4TFdKVkRemwFW1h/RB0RLxB3sG1OzlGs0grbQLmEwI70WKCoU0SkzlF6ELLhQUZjAqhFGt0tgTz8tBa3g2mYxOBkbJl6ely4qCS/dRyTDniXgUIHpEhhoaagwfPoyXbIxvtqeu228d9lvtRrfVMjFeJTysFM7lqYcELTCdlviBW213dxJAUgz0MwNfw2RQoWo8rRxOdvlAxnOr2SSjpKQr/G/DYIm1jPBXMolxPgQKekeBcl+1StlYE6C/4XEE02+ryQXHjO0BHEqNL+wY+56qZxN0hxDvwl1mlplvFhbeDian8Gd8+vpse5nkWEAatKUJUcysbCm0BphVBWhEERQSKo+H8n9bU/WZwm1LBCTzSPhh2uZx3bLHcCEFKif2anjOOj0W8mie0n0+r4IgEdUvL3CVJA1DTBF5sDeEz2I5lzuxdabO49HrweXJFKHK6N+Xowv4hbS2F56iLJEpssOFujHaNQLcQCzSIgR1YCR8Yam+AIG4LftsQ2mu9FqDMplNWdDDjr6jR5l0lmQxU9KCC/PMqhN7JhuiUYOgDPeWWIdXFzNeGABQP7GafMEWYJ8ifg5h2/clCpllZA391xjdub8F/gjQqjQhlOVtANJCldXZKArTk/KkYAgDzj9vJwMvwfU9EtOascHFmbVYFjOg4VvNVbmblpRGKl1D5QKQHVpCPqLkAhBoBrLJRDNbg+N0acCVUdZORqAjCQ6OiwSZWCPk5o1h5jhRzl35YVbvDTDa4KNimYO8xdaF+NOuaZjKO1t36/ZaR0J4zR6uu/GeaLcPD3m72+TF2mBWWk6oqNoRwEy1RSHMFmM/0AIbsLxVgBkklRVgJgO13Lp7OG12qcpoNlpu+5ei1i2KgAxgFeDmflRvMdoOrG2f3IeEDVIGJV4IHnuLbb31BKip3RLtYPayc+gFM3H4stVyZ7zT7bWF6BR6MxTKKyVVxW08Z+MoUFvacevNXt3tTiE5d9x+p1PSTF4F/c6KIczDzm6ip5pVB9RUqGdwzCypRxgWNGTQweCtJ9vQRvmY6yvH0ffry0SYL1TXLvRcQX6gzgkUXENAHUrLbKGmqtH2zBUuGJnbEi9Bg71Z1+8etf1Oy+s0u267pFEkxUq07je9XLU+rpyAj3IWY2eFk/oI9Xa6L0vq3arCf1+TNEGvs2sVdRhKDLMUQVkdDK2o/8pZbqZ8qgLy8PsVq6RVsGKWrIbKfwRgeQ36rs9jLpFDk4I86Ij187X0zRsUyJGGZCVVVVNRB+2fveI+yGvkG1phMG/E3PsItMY7i40qQ5eRhP4s6wIFU46kdgwreoLPus0jtxN0O5y7YKy9w9lRwNvt5tHh0RGOblPq51Hxj1j3S49ZzChwjZtru+RCg+8B4x4w7gHjIwEjxDOe6kf43XkI4adOouUProV1PlpdN9GIZiObJhuR7ItU6mxb5dOVOb55l7b33b3v7n336cUePZzY1zX2KUGf1jb0uYzsUiUmzy3oY5bhcXnTNjKrqGYia/T+yGjn57dTcOyPuKKvmfi0whe93xAfmVS+xfwgnw9zf5Z9ZpOl/mIukEHSo30lA5FI+H3iu+DYKVBie3u01yqeSTDQaAdEhKgZ0+szDiqL0yiiF5u6BshZ6OiHYnEOi12KgDhq5NfpJeYeSe6R5D4b7bPR95ON9khy77t73/1r+u6DSLL62sDiJJ0ulzxeG0uzz82HX9Ag/3CI5S6Xr1yW0QoSYznGcqrIwZm5rVkr6Hmi4/OO320fBa7Xdflhr9VrzTpuzynn+qvCj3Mnq/pUab7NPJKKAcThdx5pBMalE6X86vIfqDcWAYY1+tIqw82g84b5YtNix842djxVCcgGhAE7xvcsL15OTpA+DE3kUW9m4Rud1nxUR+95EVKiDYOmpU720HEPHffpZ59+vpv0s4eOe9/d++5f03efBB07n4OOnSdAxw5DiBUgxPojoaMPuAOhWQCTgp/g2692q9trcrdPeDwXSQ70KijSPdqx/UQp9oZH6wws6cpKZFSoC8MbtF1i2zhrK3FP4lziZ9cQtaQym2Tw40/ApPhpdCiXkvwYBQK68bo+CBKQyvhMZm/5KPnnsxgUQmU2yd1wiRsZAoR/QIHWQecQqL/hGmf2+eDXrAezCUp8ghKz0SezS4rl67+Hu/dagS4wXFyYub7ncwGzZs4jKCPEp5UJXzkE3UP1PVTfp/t9uv8+0v0equ99d++7f03ffQJUt2jofqgODR4N1aFto8lyLPWaNsv93oidXMVyQObNlEdY3S8wOOEKMCVkiM4UcIq9+vkeNNqW7OA5HAgJDTdpHEKb7GyIW5gkmJy7Bl/JRraXLFI3DU8tD2agmR1BB78xNQ6GDdjgfGzriwapNZa0y5LMkogbJdt9h44GZdNnBQ9Sxo+BcfbW+M20IVPDfbjWiug2bnOCEgLPCMC97mQ1W/KBXJdxePf1shhC98iyS30PjgbtGXC6ISKK8L44NuUC8bYZfevwlCKH4Er/9o6wM2zmsleCx7RBGz9+efbz2+nz0m5Uc/CLkFgWgJ+cg4lQFBtkH4JgJ0ossUrnC2J8UPnUBr2GBSEIzN5FF0Kwq7FVwimE9wnEY1IpdhIUArBXcTKJj9uuMPM1Ck2i4Uk/OgANHfBKv+eU5agckJHZEIdb+99FdXYsMfjQHjdsY0Wk6o5drTK5eEmuL2Xi7xm1uqFWJ2r6+QYXRrVXnvl02wPXRRI81KStLx7c0KuX6GHtBHeQ6iYPqAnLR/UDKS+btS/mo0KvjvSqfLyL3i4kpNBqN2YiFtML2j4/Zt5CKS3+xRiaDrrB1TwFL/pitm5w0Dp5RN1tlliqmyHrsg6AkPg7AceIjDHxGSZkwiPKLI2QS36gmQWf/0C7GT9UZKbbV3gAArT0lae/mGccsI4D1k0M0JZ/e07EczpRBmWgOGAMYFjMP0UCy2gp7hlaO6M6kT+gPpgaPGCVqOhV31z0iwBnfzF6gK3zNhCGEU/nn4zBNbO07sz5AIWyspWATQ1u8xsqSIkbejP85u8zMU3+2eRFiQfFggluaf3WUfqeSPLnibt/UMTbR5rvMdJYhIsLj5Pi1LRRcfIVwiQ0RmLKFgplF3hl0dz28p6mI2rgX3hKnkxQGwoZcxANYpwyITykA23enF6zkIIWBlaCJ4gMa3SayZL8FGp4DA5Q/hGhOZ1fEINAHEo5GQI9WrrORubmAB2CnTjreK1T+yGFAoOFQlM02Fuo1SIPJg3rNDpJR7HflC3YLmDezumcoePMFHDr3DKN8EQIYDtdMtx6/xl78aX2UhPWoGyLRKYLRcAw75X5OG1jBBHoLCcRL/VZgGvOUM6WzOIzY4FVaLvgDKrHWbTb/wpBJrjlkHbZ1zZA/edogy3WFyJc0X59YAvqvtIIb8bTLYpALLJvOfCIPNtJH2BbIILFkzGfdqPVaNapmID7K6UTqG1LxC/NGX383l2Lt8Ui+x92UKPNSVhMHKxw7QtlSU1xY2rIKyevIaF9X/p4fMICpMVHt7e4MoJV1R3eBvfEsvvqfVEwUaEJs1HdG3mvHp5N7OFrz+ndztMOYdwpTLbcF62LSt+Bnx8FLhCAOFBGg0C0gkPMmgf2lUF9ul6Vz8976BA/LDlNZ7NA9EA3OgQyL9rpNDxoPbPHQS7NAkTMcQ8x/tt33sF/cKFW+WETdP/WyZbzoI0hnEGuXYjD/oAJgmb/B8XURD0= +sidebar_class_name: "patch api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Update a Campaign

+ + + +:::caution deprecated + +This endpoint has been deprecated and may be replaced or removed in future versions of the API. + +::: + +Allows updating individual fields on a campaign using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +## Request + +

Path Parameters

Body

arrayrequired
+ +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 + + +
  • Array [
    • + +object + +
  • ]
+ +Indicates the PATCH operation succeeded, and returns the campaign's new representation. + +
Schema
    alerts object[]
    + +A list of errors and warnings that have accumulated. + +
  • Array [
    • localizations object[]
  • Array [
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/update-common-access-status-in-bulk.api.mdx b/docs/api/beta/update-common-access-status-in-bulk.api.mdx new file mode 100644 index 000000000..a8021f16d --- /dev/null +++ b/docs/api/beta/update-common-access-status-in-bulk.api.mdx @@ -0,0 +1,91 @@ +--- +id: update-common-access-status-in-bulk +sidebar_label: Bulk update common access status +hide_title: true +hide_table_of_contents: true +api: eJztW1tv2zgW/iuE92HaIrIT5zbJy8JJ20UG6TabC/rgBigtUTanMqkhpbaeoP99v3MoyZbtNJm22J0WbtE0pg4Pz53foei7js2Vk4W25izpHHfKPJGFOrXTqTWDOFbeXxWyKP2ZOSmz952tTiHHvnM87JwNzkQgE4Guc7vVSZSPnc6JG3hdT7QXvhxNdeGFNCLwFk79USpfiMKKYqJEHJhIZiJknmc6Znm6YgAi4lHoqSJap4TEP2NFLp2cqkI53xWX4KedwtyymFin/+TZwsfQTNhUaKmPA/doahOVaTM+DqJAnUqYE5vMOsd3SwqcWpNqNxXWiUSZmdBGjGCFNWLrBFJOZMHyPQE9/je/FE/bZNV6EBamLlyptjqxNYUyBa29oHrvd08C3HV8PFFTSb8Vs1xBJOmcnIGPLtTUL4zb0e8qLvAgd+TQQit+GgcNVHKW+FX9zjXcAAs1VKtadcnlX17aFw4mxYPUuqksKIhKnXQ+f6Z4MPqBtQPJ910YKxe6yBS7cB7JZ89DLBMF0SBmcmt8sFR/u78qJM3LC4gXIcqK0hn8qlP2fx3FHyXFOPNPyyybsQo8R5sqwv3MQ3JS6K96u/JqEHdve3tNiGYaDMUL5xB090s5QnwLZJI2H2Smk2+QZTnCElVInZ0isdZ5pi3sS21UNHZSk4SKRY4xUYDjB51ghpha5E9gScFBKjAdCaw+yWnOToUlujviRCac+6TfaaUMed7J+D14UTl7SKAbozFf1FMQdwKxdN+y6lDJ0cH2UX8vPdiTsv/r3s7h/ugolbu720f7R0e0+hRxIMfKr0nZ9tL/UkY5HYvMxvDInzCIUxK2ZwF48cdnOfN4hP2voVegbdSs5BWF+lRsCSlOTi/E3qHIpBmXPC7HS0Yw0c0VRgyCXY5oiAoZNA+MXzs91madKMqUU9o4nr94Obg5v8bI5Yv/3Ly4wm/Ea2X3GBhEa0JhCVERCxP7kSWuFOC8UxnMoZKueFZxfQaFpPGLhNovJCFiK5VlVmBGtfqaGYusRerstJVKnDefCvFEd1V3S4xoDNUnnoiR9JgAFxL5s1A7ovPKks/ERMlEuafY1pJEk5IyE8hGMMX8GRgJmSRcN5hBWiKVIYzGplYW2PQKHau2L+ambHtjXv7OF51CyQHJH46TQVyUEI7VXMzCJloqESv/QOZgubZ018tVcmYKGUMLSWUyts7BwthQC0H4oCpH5C6PwmNquqZiLVZ1LnevgjDPC8vPYln6R+TdRYbyE7FqzYMPqko+T6AkVCP2Ru2mqiJV9ZwnV1SNu+rEF6lWWbLJ3U3ubnL3kbm7/PCywmXVU4Y+O6vQ58bUgH8dQHMcPWgV2l1BcOQWQfoKIv325hqJ/V4ZolefckLn3xEfha18FVk2/gjjI4IfjbNaviAB2Y5BgxSVSCXHLPdc4oBp2VS7q6u9tG6kEaBmDURE1XRiZktuXVxpDEki/ZZIrPLoYcREoj5WwJwrIK1qkii3QLgbJLlBkpvdaLMb/Ty70QZJbnJ3k7s/Zu5+EUk2UnG2VDjJl9OpdLMQadVz0lYKEIj6hFA0KceuWkYrxEw0GKvTRg6dUX9ntJMexmovkXvJwe5R2o8P+nL/cOdwZ7TXP+ws7vXDeR43SdbOqQV/Bz+yiQHiPgDHlQbB5Qtrk/bxH8zrVEpljUpPg5thc5j0tsGO/aNV7HhtrXglzaxGSL6FIc3cRlTTQDslWlfTgkCKMeqiEShVGnJRKNF5fiQcvQ3I9FRz8pIW4Otm0SAtoEpIlDrImlW0ibMSEnIlyCyhZovA0lBSpYT5wIER7BjV+Tui08pF34TkxSVpfE4aixefYqUo0Rvkvr/ufPcMwjuqEVfBwfcc9IZuh96xGDQEoWY1uHODzzf4fLPHb/b4n2OP3+DzTe5ucvfHzN2/gM8rNHQ/PgfBo/E5aLvbosFSLym4/ucwnVOlkoDDW9g4Lh0fN9cYnHEFQokEyq3nIiKLCT71wg2JKBzE9sIFlsiHCw1bnYD/g2SlyzBhUhS5P+717uAwOOpzV+a6izoGnxUzYz92wbA3gpXWFCC6KRCSjQjE4OKsajC6bGKnKYpDyWPmweCsFMUrDM+Hw1/kbOSUPTmzJYocs9kSiPgqongYIuZoJ37xTN3lCFrRD3rduOzzt+sSGN2jyzrzfXE10AtIuqQiqXBL7oLnwYj9dQN5TkO9GpTk7OHtIs0V4fMg4QrlfM+hnq6/ItBrIuuLEyUdmofwmuPJb2+un4oxoVKuCqUnQKw0tRHIqwuEEVe9QX3kT5N4I3K2HE9YuUHrpQplmUgzGEW8NVdKieFZZah/Yzu4RP1ms9MkxSWDZt0+qT2YqA8qo52yO7c2BadOTA9W7MnWvKe8K3L7oE24+UOXxd6aSDzXVKw07e5EU6nI3aAY5rVeckGvrxXiHzW3Kh8j5uafLkkRTDuMwyWdGKlOLGTm2VpfvXjgFy3wo14LI8R1WQayRCVH+1VYXHvtq+Vo8YuIX1uOt+bNRGPLbU8TocIJjx0zS8SZiCfWevVPISh0KFWG4xKZ9tVifaRFI86IqL+9IFIUlox0BADJ8p0jMUwIJjmiDZzxiwW0M0lI23fsWdSFd2ivE/GupTMPD7HPEmViY//VMtOCES0YhTrhK/nDNkaBRffcoEO41scBcDr3P1eCStCF2hh4ra38zL7Hc2j7oMuSzMXnx+HD8bwIVr+FK5VE3dCgVBP+bl4O4rOoeNFe1jJWfXKwbMFVeTOLLXTJbkHe5uSKttW/m76k8WB+wPLaZLPvXaXvqSR/n7r7f6p4m0rzM1aaChHTQeXl/J72i7p3GS7fbx52dlP56356sBcRbI/29g/60Wg3jaN+fHSwmx4cyFQehIvqzcXkx04iSEaBzwaompjFdDup0OXq0aPny+v4iadcNbgNQJPFbSPjqUVGeSYLyi+uL/FEKz60yJUsCKluUYzbKdeE3FkqRGhNmdHYgQYFxANBy5HOwI+P1euVJadugMEUYfTZl9w50VrxBE2w6oo36CNNjAChHpIuhuDZ77ZqJq8QIxcUYuJ5HXb8NYDSYDWqEOVUSAT3A7GZaB+XoYTChUbVtrAMQptZdT2hoCcV+FK4clP/OqXzcLTaCyH4wFqIQF8dhsP05EXqKahRaxS5VBnnCNG1m4yHeCPuo4nKcupiUf8BBdXCCq/Orlc4gpnx0CtWXevGvWqS7xEtmFAzF8Jnt7vT3Y64ucE4NYXouxeY0/cy6q9WtG/RN81hKx7v5u8DfohvaFRbJ/U8vZyO9MgMZejTQm887LR6YzJ1qztG4k6olwbh3R0d/1C7+JmGoSadLQxv550gd1+YwMdAXGPeKzp+qN47RNczhgTVOcPqCxVqUMOMcLT0RdrbhXb/4jUdsnVG1TdRpuHkwsmPGKSfx523+IsPNg8xCiIev+vU54CgCXzpz38B+Hsxug== +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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

arrayrequired
+ +Confirm or deny in bulk the common access ids that are (or aren't) common access + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/update-connector-rule.api.mdx b/docs/api/beta/update-connector-rule.api.mdx new file mode 100644 index 000000000..25064c013 --- /dev/null +++ b/docs/api/beta/update-connector-rule.api.mdx @@ -0,0 +1,116 @@ +--- +id: update-connector-rule +sidebar_label: Update a Connector Rule +hide_title: true +hide_table_of_contents: true +api: eJztXP9T2zgW/1c0vh9oe0lIQoAm98NNgHaXDhSOwHTmKHOr2EqiXVv2WTaQZfK/33tP8rckEOgyt9uOpzM0lqWn910fyZIenIRPtTO4dg5DpYSbhDG7SH3BTrniUxEIlTg3DccT2o1llMhQOQPnKvJ4IjTjiol7qROppszNm8fY/E4mM5bMBAuVYFEc3kpPeEwqKovFf1OhEzYOvXmLfQ4TAcU8oXcTKXxPsy3pbTXYluKBgP+58thWMo/EFuOxYDII0oSPfdH6qoYsCX8TynR4dvHTf4ZHp8efGU+TWRjLZM6kpv5kDP0nIXO570NHUDo8P245DSeMRMxRsGMPREtJtFwXqAqoE/EYGElEjJp6cJArqCs9eCVRIRFPZs6ylo6PWDghmZZ0A1yYbqBJxpozSOJUNBydzH2krWUQUdfiPvJDD4om3NdYwZ2JgDuDBwf1gTWTGPTvLLAqp0YD573b6bfF3v77fc57wuvzfnvs9b3dnV5vt7szGTuLG9M1WOEAjIDkqsxfrrJNGjaMewz+cuAOqiToItCeR5EvXdLk9q8aiTyUmK1Sr+jXeNOF4QZogoHOJqRnK2E4/hUqV5R1jcoHGcCzwHyJFBo7gbIVvSxbBe1RWGbFHiUddjo7Xu+92x73O71JZ3/cc/fa+12v57njvjcRzmKxaDwp2GEsKoI9JQ65lK0CRg7T2AUvBLuvCGmc7zliYs2yoBXxvojxSMS30hUHYhLG4iwLA+vygVQnQk3BrwcdeOL3+VP3/WKpt03McFZ6LnO0pVmUxlGoq7xdYniSabwQ0gzmBvRv08lqZ0KlAerwIJW+d8ojKMrtMJxA1BpDrBQfCV+sKT4NPTmZl4uNhlapmPJVMqY8p/Pp6OCwxBs+5to+x9So4YcRBd/lRfB8LkJQySicJD9fnI5KRKovHiNXrVUmfDE8/Hgu4kBqLDhMdRIG8neiAW9Hw/NSXyMe/Ryb8SBLiFT0WK/0stzZKHVdofVHjsrRjzUrPJLMsOyQTzvsyhiFLoaOgu624vy5cOBVWk4VT9JYrE+C1k0nqXLJe/PqLXZElcfkoXlFqaI0gVFqmuLYqWnoCtMEC9/ICTzO325IBURhTXKj4sL9eRxz9C6ZiECXynOaKvV9HCSzoeU10kgmV0WbExnr5DPSe2liQJJrUsPaXgw4gJ4qDAGsUAkM80/lh2VFrPIAqpnCCB+AP7m51zzKyciOuIs1KRzMBuxQtWHWFisaF6jN9Jc206Iy8q6kg1Hx7ukIvgWgaDKfab4azFmNZ6neVi7QpFfNZp1WmxKZ6Wsjyct1NGIBOU2xr85p3IK/7O8sd5d/kAozdZWUAKU8gT7GaSKelYGWUUHAIxTK8IkwzLTUZc4eFuXen8BXi5tHqlXx5WJhHEJHodKG7W67vT73Z2C3CoRfCfZeWBYqiLdGkzWarNFkjSZrNFnDlBpNft9mqtHk94wmG5sZWFqOBFhIJF5tYfKFy5FF/5shlGLHozP2fq/dYVeXhyyRAQgNXbG7mVBmedys+XLNMqplbtrdTrO93+x2Lzu7g93+oLvzb2QgQJAi13OwwXwv4cjnkBDyvjbytXh0apBjcDMr6K2bCBz6EuKZfYhjwP9NdkGujd8yJivfMvBbg1S33Jde6yWzhGVHqzqPJxIu/SyJPG3Yj1KJJmQ1iRwKYhmD036BwbgIAOwwQzLzNarXqugRNNHqsAPuMRsQ7NAKg+ETc/c3oHX8DE+7UhLas6wJpG4GcOuxbsW+4OO9dr/bm+z1OO++73X2d8f9Cd/Zafd3+33yMcB+gB31GvBS7fonoUQMqd0PXbDI76AQcGTQPTFAnT+Fd6o2IBrP0D9mQ1M3F9PyyxJxnzQYZwDJWW8ffFhNUyrn0yUlqObVaCVgQHJD+CyWU7k212czl6MPH4dXJ5eIyz/86+rDCH4hrRVQO1TgrR66JbAKvjAL74hjKwBGmobZiAvB32LvLNV3IBBXulxRmic916BM8K0JT/0EWtje17Qok2aTOAwqoURxc48ItyVaDTbGMhil3Rkbcw0NQvMV8d0Q5gFR0jyxmnzHZoJ7In7bYkPPkygk9xlEIxCF9nMgxLhX+gw5SRF503ctAFRMhQAERNUWhSqX01eWT07KRsHgAM43+8nQTVJgjsQsR2HuLZZFax/g2Wiuyt1lSWmk0rlKYFYk8RvnHNQYx6BhBgMqkzB3sOkIzaUh8aisXp6xykMjpbtTw8xREtI7l6f6GXF37kP6aZJo+YtbYYNP48BsvwejNTIz2YwEL2mqhY2XvxpngW8+EdexW8duHbvPjN3llxnusW8J+nRWoc+VstsocPBcgT4xeY8Ks70WZr3HGrLBQCEWIn36cmk3aUB9cR8hZn5FfGSG8hXmh7k9TPmYZgWZsSq2QAZJj0aCCWQi4Q2I74JjUpRR1c5qbx/DeCzBQdUaiAhZM2bzMKW9K3GqcIWKcd2g9Ui1lbAZh/zIaVXLZEDsVXnNKJQqqZFkjSTr0agejX6c0ahGknXs1rH7fcbuk0gy54qixeIknQYBj+fG0+x7lJYzqMCyD/EsDzky1TJaQWIsx1hOFTk4425n3Jnsu6Ln8Z63t9OfdN29Lt/d7+x3xr3uvlMe66+LOM6DrBpTJXsbO5KKAcTdAo5LFTiXTsLQqy7/gXpjMcG0hqknx82gc1DpTYEde6vY8XOYgGxAGLBj/Mjy4tXFCdKHrok86o2WzhFmG9WZLdT0iRt82GzMrqFjDR3r4acefn6Y4aeGjnXs1rH7fcbui6BjbxN07L0AOvbwjBnEE0CsPxM6eoA7EJpNwCggg5uCehXCxghEgV929dGGfcLjqUhyoFdBkd3+mu1lYYiH9uYZWNKVlUhVqAvTG9QNsG6c1YUKnE0hRSoGWUsCukWvkoFATAr+w3wZSIpjFAjoxvMmbayzMVMc7bO9SOX6KXBIScEPzY6MOy7BnWjDHaCxOa2DTiFRv+Iap7XWH1oPZhco8QlKzD7cu0JgzOfrv7vrdgkcA/MxpouRsfUj2wXMmjlXMI0Q95FJXzkEraF6DdXr4b4e7n+M4b6G6nXs1rH7fcbuC6C6RUOPQ3Wo8GyoDnVbbZZjqY/oXP93xE6hYjkg92ahS1jdKzA4bpAWUIib0LGTK4D4h8aVhymea8IdwWqAO1abQX6TRjM/SDYwhc4Nbk0NBDglioZ7+hvmMomBs51XbiIZvf0gvYWD/SLANLKlsQ81Z0kS6cH29gOYHEy9aPFItrI98iq8a7lhsD0WdGHDcgrDHasmXLEC3olhZystMlIsMQ5M0iTixmSkFvR4MB1tUniScrZ1fw4TGWbINHDDvfVJKgYWI5iQbGmq3bKXKyzJB3Jdxf7ij8tiCD0iyzr1Pdkb1GfA6ZKIdt9x5iYjRO+m9xVnKUYk/G7QXensDKt12YHgMUwtzFaaN5++XL5lU8SslDNSjXBZSJxkQNSdg4tQThxm20qwEQ1TcZhOzd0sw8rGHYxBNvFBYPZVjYRg18dWCZ9hsLiA7E4qxUaCEgq2unmTWccTt8LHcbRVaBIdD+JgGzS0zSvt3tKYSZMLqeBnQKWtr6rJjiSmMoljP9axItJckV1HmVy8JNe3MvG3jFrTUGsSNf12iQuj2mvXbAR3IREgCe5r0tY3d27oNUv0cCYGJUh1mQfUhOWjut3Kzaz2zXxU6DWRXpWPr+rLTMKAXG3GTNZiGsZT32PHzJ2FoRb/ZAxdB8PgeppCFH0zW3fYaZMiotltl1hqmi6bsgnwkvg7gcBQxpn4GId3QjehWWihkPyFLAsx/wsdofulIjMVX8MojDW90NXfzDN22MQOmyYHaMu/GeTQsSC2UQbKA8YBDgv7UyawjJbynqG1NqsT+W1qg0ODC6wSFR0NzMOgSHD2F6MXWDuvA2kY0Xm+AQ2vSLK0cKSrKCtbV1jW4Cq/fggD7JLeDL/511EcdP9q8qLEw2L55Uz589fO0o9kkr9O3v2TMl6daX7ETGPxMi5jXhRXjn3Ij+TR6bjN59sa2bVrm+4aWAPUlk7/5+ctS8fSKwe37eno4qq34rTrumN7T5xQzbvKzo/elE/vvjr1lTOn+dFQOtdZHOvccERz6Swm0sV0QW5jJ4blJHVg8fbqci5+b5gJ+AtvKdfS1AomrsUNgWVCkc8TzEqUld2ZFLQQFAlO1/01MDOEAWXSKA4xfYNJidCUDinG4HIcpu7SB3r0qSLrma4NVGZigHGJzzq1G2dCSClcTUWLfYG5uXJBgzgvxy3b8O7X0E7QRxBZ5xiY7CgLVgDNQZAqvGcQ2E4DxiElbIhoT2o3NQOPneIZEUKC7nmrLAtjqkARWjRDjQN9NrHuXwrcDX1B3Gr7gQFUX/K8QpAL4VMQYb3qtGsTbcgWzZnw6foDGDUFnqcsejg9vlyhCMSU/aoVxtNt20hvY10gUvjsTgu8tknTPSiPQp3AvLlE3FztAvOC6uWVy274UHxa+bHurrTRjzPJ7QiXUVFNqZnZmmWEa2dpGQFaDczdiTNQJ1Z4eMClNpxYL7AYxMN1nOubYs5srqaRGn97+U2Uj6r4zYXl+S171h2Ya6XIlozVvFgtcuDnbwIXmUCCxQ3UMquAxJ95YT87NS/N1TdZw5Xvabi6YFqYlcUn65bXaM6v0J/H9tLMwKxbxfwOCvHvwPkK/xy8VtREE1Si8gcnWwWGOoZshq3XQUv7A8wA1f4HSH/pHQ== +sidebar_class_name: "put api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

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
  • Array [
  • ]
    • output objectnullable
    sourceCode objectrequired
    + +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[]required
  • Array [
  • ]
    • output objectnullable
    sourceCode objectrequired
    + +SourceCode + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/update-entitlements-in-bulk.api.mdx b/docs/api/beta/update-entitlements-in-bulk.api.mdx new file mode 100644 index 000000000..8dcf6b00c --- /dev/null +++ b/docs/api/beta/update-entitlements-in-bulk.api.mdx @@ -0,0 +1,109 @@ +--- +id: update-entitlements-in-bulk +sidebar_label: Bulk update an entitlement list +hide_title: true +hide_table_of_contents: true +api: eJztW+tv2zgS/1cI3YdtA1t23DyafDk4abpIkTa5PNAPTnClJcpmK5FaUkriC/K/38yQkiU7r+0We7s9t0BricPhPH8zpKS7QOfC8EJqdRgHu0GZx7wQB6qQRSoyoQp7qPbK9FvQCQo+scHuKGgOBledIBY2MjJHFsDgfCotG54cMp7nqRSWccUcU1ZoJq6FmTEx58B0woqpYKm0RXipLtU5XKgyGwuDQw1Ki/M9J1gilZksRIw3N/sMfmaWZfxWZmVW8/lgtTrhRTSt5iU6TfWNpRVHH86OPzEavno1LYrc7vZ6hdapDaUoklCbSW9aZGnPJNHWTn/wmtmCq5ibOGQc2cDite0s22Vra3fsEsx5GezC/0bkKY/EZdCBi5wXU3e7lxt5LVMxEbEbuuZpKXBsDEsLMNb92hp7IS8jfisFSDVOcewRXmiMIZjpm1DsRhZTdnz667+H7z4efmLaOE+VxVQbWczQrshTGmfYCPQEWzmHhhACfsE9Hc+C3bugog12C1OKThBpVYCncIi8H5Ftel8tRsZdYKOpyDj+Kma5gFjR468iKoBvbtCSBYQLjjacfhjbBj03hs+CxYg7gtBZiBUm40a4wAyIjEMMkWB3s98JpPtZ87WFkWoS3HcCccuzPBUY5oNoZ/1t/y3f3hpsbG+u8/46/ErWd+Ktrc3BoB8D18dJtiMgEU+S7AyAJAmuYNWvVZw+oOuirLXN2kYYMgxnF+zHVVQyblksEqnAneMZG52+32cYyqzLfm/we+c7b48gMtFrEIkIAG3vwdCSZZdBQsxzBx01FgwuE20ygYYVgAC4DI9jWjjT14J+UB6gP92NSOdoowJiEgWpvVdT3nspn5VoyNyAN4yWEMkGkiE3wmJgwQiCRsHNRBQMeaLYkGLCR5xTgicJeMeZu2gqGTSl6zXXBhEpb8l2ShwnoPiytPPJn8QNa84H9THsm2FcT0ctJsI057/p9+czqvHGlDq+Kpr6Rs0CsruApcZl4TyueIaE+VSmMg/u7xvcqiiumLnr+weqhmBkBW/H0oINIRzaRuzM0QnHLjE+LgPwQtwEyQYqP2k4kLOWq64Ude600cCFdSMAXVQ14Tyo/Zjw1Ao0wiNzGrC9OOnq/r5l6EUo/PNgqYVKf6L+bZxZ0L8p1NXce42OBHuVC0L9U7cKxiMxtTkEhAvYQX8D/2uH4Ceod65+ATxKFWP1Eq5V8AKzG8BTW0aRsDYpUwYJgMOG+hE1n+5C2IiiNIi8UnkmToIQI2uj31+WYB/6JZh+YAwEd5ed1gySlhRjqL64olRgOhmHwQ8rvLEouEz3dSyeB8z3UFW6E8OpuAgSOYKJDDheyxjxMtNgGcey6vKILmxlJVgiXGd7PGbeYWzfK4PpaXj0DXhha/qcQBdK/ob44adAC1ADyAPLim3Bx1v9ncFGsrXB+eDtxvr25ngn4W/e9Hc2d3Zw9Qz8zCfi+Q7kV6GEkRFLNXRM8j9gECM42J4EoMWfKuRtHxCPF9gfEdPR1mp6eVkhbosO42xv/4RtbLOUq0lJ9/lkwQiqe3EGd1SZppSN1MeB5o7xsZETqR4SparP7w7eDy+OzuHO6cG/Lg7O4BfyWoL3oaoySlNbP9U3rut3ClBeQSHFyhmyNc91DRTiyjYJpbuyMwvGxNaGl2kBM/zqD8xosmaJ0VkrlShvbgv2SoYi7EDWwr2MeqgxxwqkXequDSHn86J75C25xqaCx8K8DtkwjiUqyVNXv3ATMqNOII7nuZ+UkMqC2m8NoKF0ISPR9sXclG1vzFHuqOkUTA6Q/AWNTVSUIByp2czCOlq8iBXixd5ybenOF1FwpgoegRawQ5iBGY0BCxMgStioVUAo0fYZVxVdjVjN0ktw99EJ867QNBbx0r4g705SgJ8uqVYPXAuffLQBcGhE3qjc5BEJBqmhw8meqnZXlfgskSKNV7m7yt1V7r4wdxcHT33X40ep9Vlfbn0ulD+EwOK51PrUHVZF5PaNzpEdPMbwLdKHz+f+pAPoxW2ObeQP7I9cKV8Sflj7w90fV7vFqvTPfYECkh2dBgkgkYh3Se65xGQoZ6o3y6u912YsIUDVAy0ioKZhM10yDiYzpVIoCbcdFmth1S8Fm3LAR04drENAXFXF3Rw3vKtOctVJrqrRqhr9PNVo1UmucneVu3/P3H2yk6ylomzxfZIts4ybmYs0P47acgYE9fkbq1OuPnZvdivIjNU9VtDuHILxYH28nmxHYiPmG/HWm51kEG0N+Ob2+vb6eGOwHTRr/Wiex3WStXOq4W/nRzIxNHHX0MeVCoLLFlrH7eM/MK8RCcIaPYKo+mawOZj0qu4dBzvLveO51uwjV7OqQ7KtHlLNbYSYBrQZ0pqKFgg4mwAuKnxYI0EuDCWZCeBi8PGqfyYbMtQC+JpZd5jgcxSXKIsnoXAdpSVISEiQauyaNQSWBCVFgj0fcKAOdgLo/AO7U++iP9TJs1PU+Ag1Zge3kRCY6HXnvvnQ+e4hPlNCjDhzDn7koNftdvCxuYINgcOsuu9c9eer/nxV41c1/ueo8av+fJW7q9z9e+bu7+jPfTf0eH8OBC/uz4E27LO6l3qPwfWnt+mUKl4CCm+mo6g0dNxc9eDUV0AooUC5tkXjDYjma429cZl+69Zvqrnm34lVmhSoq9ez7sBb4KX7kOcyBBBDHjOlb8JIZ70xmOgB9MHXBFymIQG97ecWCMm+RmIIO7wj5s7apBEGK1idToaf5Iyv/6AbZ7oEhCM2HQbh7sOJboOIOewlfrFEHfqXhBb0A70uTHr/x3VxjB7R5SHzPbka0DOQdEFFVOEK3QVuB0bkrwuQZ9+B1bBET4+umjRn2Jw7CZco5wUHN3SDJYGOkWzA9gQ3sHNwzzheffh8/ppNsCUlSCgtdsNC4h4CkuoEwoggb1id9+MkqkJGl5MpKTdsPVHBFGNJCkZhl+pMCDY69Ib6BLXgFMCbzI6TBOEFzpq/QBiLa5FimQzn1sbglLHqgRV7vDXvNZVE2jtIha/+0d3wUnXZO4lIRe/VIo1XkbaCbJRXevGGXt8rxD8qbl3HrUvc7OsFKZxpR5F7QyeCPEcWPLVkre9e3PHrNvjhRgvuINdFGdASXo72c7Co8tp3y9Hi10V+bTku1eephHrbnsYcvDEL5TKN2SGLplpb8U/GMHQwVUaTEjLtu8W6wUW7lBHdQb8hUtct2ZVd6B5JviNIDOWCiY+xelPzoqGvU7FL2y/kWcCFL/TC4JeWznR7BEUWKWMd2e+WGRfs4oJdhxPWy+9qGAYW5DbqQDjgAmB/7n9CAi9oAxsdrweRn9j3aA6WjwhEJS4233UXu3MQ9L8YDSB1TQNQjc13/WQQ3/z2vLCQtYxVHRssWnBZ3lRD/Vywm5O3PrbCmvpX0xc1Hs5PV45VOvvRKP0Ikvx1cPd/hHgrpPkZkca3w3hKeTr/hOTg//s9Z0w+coLfRTVTfs93uMtnn3g4PxXwL4wSctE+BHZ57uMe7OmajECmAnOcMC6aSkGnJrngJFYH80xnhEu50QiGsDcmRhMDNABiFrp4PpYp8KNz/WplTvDhWnGMcry2JW3d6NOhKezCRcg+w0ZWRRCkuInFN1Ng7Kv2u9kziFP61IK9q0IfWtAsKxV+jARilxnjkGDP5EcsbVQ6GIc9rRKVLTQ1wvWsCtMw8VCFkLZzJrPHCR7Iw16/kQbPrAVZYP1pPJi+8RHEXJFTkdYfIbQ3Os/xhtzrTkWa4zYaahC0o6KxwsfD8yWOwExZ0CsS9OWOn2R7SIvfl4DyLnzehOthv0sbLPw0BnalsPFvMMfX56uP5fDjlsYnVfiF3mI43s2fR6w+/PuZP/zzbQ/uV3s5nsVi+JRuj+3grvWtBsZ881gDUHaKJyBAdXeHh3a4z7/H26AHngiNruZbeNo2wwQ6vCNM/ibw0Mg/Leqez/IGni4/BkNEdjPcgeCTtFeNQ5qTYzwaDcb+68bMnTcZfgM38d/d4BL+woXOXWLjJ5B4/y6oTm+BxvHFP/8FIFOdag== +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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
  • Array [
    • value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    oneOf
    + +string + +
    + +integer + +
  • Array [
    • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/update-entitlements-potential-role.api.mdx b/docs/api/beta/update-entitlements-potential-role.api.mdx new file mode 100644 index 000000000..fa9b8d8b7 --- /dev/null +++ b/docs/api/beta/update-entitlements-potential-role.api.mdx @@ -0,0 +1,99 @@ +--- +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: eJztXOtz28YR/1du0A+xPQJf4kPSlw4l0QkTSWRJqp5W1jhH4CgiAQEEB8hmNfrfu7t3AAECfIRx2ySlPWODwN7dvve3h8eL4Qci5JHje33buDDiwOaR6HmRE7liIbxIDv0I/nO4O/JdYZwYEX+SxsWD0e/2GZ5it47neE/G44lhC2mFToCTwVSTuSOZ8OzAd7yIcduWzA9ZKBb+s8ALqyXYLPQXjHtMfLHcWMJw5joyYjOg5yxIGGAhLFcBFgIe8oWIRIiMvBgOrhbwaA6XPLgAv6SQUol0YkhrLhbcuHgxomVAF6MQGX49MULxS+yEAgSPwlgUBRC0JFuQhExPyhycVXzhi8DF6c6s+nlNtDvmWYdzsynsc5Of16amfW63TpvNVuN0NoXFSvkMssr9bdx21xQFbDLHA/2ViHAA/49qfSGjS99eIn/55UclisrYqci95XvILs7Eg8B1LHLC6k8Sp3sp6sGf/iSsCK0fostGjpB41bFlkRm0HHmQP8s6GqhEsshnU8GE7UQC9a1n52HIl/ATzi5kifZfUWPgnLbIXJz6IDRHbeaX788YyYhOn10z590VBmQz7kqgU0FBpBQK0bxArVnQRtNyPxggVd+uoz3xoIFRmPKJPMAgEl9bSMVqLqR7oIlsvMNCr+RsMvA9qZTcqNWLSu7ujug1l/wmR1SQ8Kv5hBUKSGL25XIf9ykau2DOa/QjtAlN7Ie58GlY5/Wz2nmt067zFudWrd5pN+otq9nm7YbdOsPItR0ZuHx5R0G/azl0Xj2AYZrYtnhXzl2xrAwdEVqCXCSxNpl0eZVo4noyKF0oCVWtMjZdMltE3HFlhRgXnoRpMkxDLhdPIiznWlEjw2VpO2W70zoxILcveKQmPG2otTLz7aWk1ZmdSxqpz6uihaWla1l+DOcgY9kiiJCHjHte4bU9BffixVSEa9lGqvS7halGqR50/Nq5oDwkxel5KvtnuQxvD0atw2vTpmgAff0UD3jNeASSGaSGuQd+s6dyUvoD/cKxhfLlgwyiR0O4H2iOZPlrB7U0jRP/XMsRmorxSFFRDKcD9rDBhgSVzrdf8ujbSbrIC5qLBfB2HkboLjo55QTbl08obg6O4e4wx3FZ5UycKiPP37kbI93dLZtA+mKnlP/JxO3Xx9fSwtUvs8Vrxkj9XWgAw2ODH3zNGPH2MtZdJrtvy11j/gypeS2DmazWqdZryBB4zLODaXwcQRIvV0BKQwAN6TaF4zrPAoIJZR0OJr27Sb97A+eGvbvr/t23cHQ1uB3e9CY9OHzf7d/0rhUESdNuZtAOIDLMSwFy/RJzd//qo6l3Zpl6rVYW56FC4HtVHkW7u+gk7mF2eKdtNpszbk5tgNZWu9luNaftdqt+jmtLNPAewHJScBSAVDSYTBrL3PIa/yWYv9QtilB9s0P+diSFK67Q1K7G5Hx22p61RMusi7M6NCYWaK921jFbzbPz1rl9Xrc6dWPvYMtImyqNRsIEsevyaaKyYuSNbtlY6ykTdcD5Xbzop/Wl7+Vb5d1ei0GwiBd7V6ttrDZKnToIY09M5liBfdfeM5BoEFhIj9JwIpagCUBNyAGesrhrxS7mkSCkKabCHuaX28JuaandFgYzHrvR5j593bIqHMqiwfKDDSmSLq1ZAXFihBsZO5z1JV+CHiAJwuwQTw5Hl/RjwOcVdLeLax7xseUIzxJ4KAXV0qQqvndcGHSVDn1Z7x2gQIbck6h43K+58VWPdMFuHb5wUIscBt7wqXD3I7eBiZJ10mE/iCX1QHeV/jWm8sk/PnUnk1H/8n7SG1duBlfdSX9wt4pDw9VrgFhqbwl6FuhH/nbfvRnDuWes+9S7KhYeqd3clVty5X3vSr0NB+xl4lw+fdjd652UkTSgfU5omg3CB1bGwLvT1kfI4Ty05h8NlgwEjnmERd2OLZAhOky0zYlvh8e+bnXZ/RBkqX1mNNlKzIMl+P8InFKUrGvVmDJdGlvbNuxWZYZoN2PA8bB3BWCu/0/AeYT9bkGCHODLUxSZw6PJUjEmy+Fq2VaiIt3M2NWo153QkvfDa32k1d7vjT8NLifd/h2dHY7u73qfJt+NeuPvBjfXuUsJWP00GtzAqOFocNUbjxXQXb+YrJiTfsXGZrMk6BbLDZy+FdHct4taGKvLbEHXVfkFTGDFYYh9fnk92qSe2+7dPWHw7v1k8Gl0m+c6vbrVl1a8bnW7YYokryP/EPfb1oN8Tf/bvTWqt0KbtVqR/yvXQTP0whAylMlGIopDD02ksa3aK2dT314yB9EchK9jf8VNTrVNd+XndqQ3FJH3jifMp5A7yKEgli0YqJpCm7zMD4Xe+UvgOdHl+xnQRKXOLjlAYi3flRYGlRly62dq0nczdO85MJ4lQ/Behcr0pcuKjuDTdu280Zy1m5w3zpr1Tmt6PuOnpzXoBKiFWoD38SdRhg/yS38rPKgsFsNs6zr/AoWEgoPuiQFafP/NGZpjz95D0aZian5ZJL5EJ4D0L6+GrNlhLveeYjrPn9aU4Jn340LFA8nVxIPQeXJKN06T2Lnuve/e30zgzAhqSm8MRzhX4b5d1wNvtdEtfepJ5v5nhS+UAJ85YGzhgjqEXWHv9KzvQCCoe1lCR/2SSwnKZBrBwwi9esmI7NSrGyFJKFHcfInYG6ciKifQksA5aCCsOZty6k08In/XtSwRROaN1uQ7NhfcFuHbCuumO1ZMFVMYv8Tehtu2yq44wSyGUAZmHMh1ccQ8P3Kstb5+pcp1/JFklJusUTA4gPPdftK1ohizIIqZjcLUWzSL2j7As9JcnrtJRmmk0qUXcQuk4K67BDVCAbEgM4FsTiSZTkdoLgmJx0vo0oyVu6uA3NwqZii9I5blsdwj7oYupB+TREsvPAsdfLRnrbIRWSMxk85IcBHFpsGaKjVXEvgAHQX1nMfYPcbuMXb3id31iyN9z1dfJehTcuP33uMx6Dek4lmAPiF5j+ezhIjgjTbkCe4gaYj0/YcJBPbPwkN68SXAhwO+Ij5Spbx41zq1hzo/RfiRGitnC2SQ9KgkmEEmEvYF8b3imBSlVHVaXO29H04dcFCvBCJC1gzZ0o8ZB5WFsUdQmMsTZvtCet9EbM4hP3KICClVBlTP05j0QM0RSR6R5LEaHavRn6caHZHkMXaPsfvHjN2tSDLliqJF4yQZLxY8XCpP09fVDXUgYMnThywNuWf1uEgereBkLMVYRh45GNNGfVqfdSzRtHnTbp+ezxpWu8FbnXqnPm02Oka21j+s4jgNsnxMZeyt7KhvPIbPgONiD5xLRr5v57f/QL2hmGFaw9ST4mbQOaj0McGOrbIdxj5YJEQvHaslNmw1KrzNPWABIKmKmhT5HBHiESEeq8yxyvw5qswRIR5j9xi7f8zY/RUIUaOhzQgRCPZGiEBbqbEUS72nx8j+20CRQkVzQO7NfItu5NsrFEi4Qj0KYAS+pCSC74pdGFW812+qe+Wmvtcvqy/pO26v1fQGuomkcG3tvbLXKr7vZGZfTjDwwVDElUqkOHRhpXkUBfKiWn2B0WDh1woPnEry8JXnf65Y/qI6BfWWZC68ya2iFAlYd9jX2LhCtgkddH+VK2lyZSn9WJ8hwWK0r7l15uR1mKUfQ3akaU7wmQHtinQaWAy4t/xGEnWFXK8gH8h1H7qvv10WNdEGWcrUt3U1oGfA6ZqIKMIjmgtchh6HBnvdAz9XKtF1Y/SSh8cszRiBveKwQLkqVtiONAoMDZCswS4FD6HrUDv0b77/MHnLnhDOUjqJJSJp4WD/AQE5BDeidNlNdqtxEFWw0I+f5iRcN3c/AMOTzVxQCvvojYVgD8nD/XdQR0aQ+EntOEhQrsFRj28SC9riWbhYYisrbaNzOrZXBS1WeW7cWyqn1Hc4nnruFJ8f++iZ7NrBLIcRRTRaRNqKZw9BIhfPyHUoE39JZjPVbCbNJt+ucaFU+2Cp50ssyBEqkiVp6+DF1XxmZj5s0uAMzrrOA2pC85G/i2MlVjuYj9x8Js6X5+Oj92HuQK3OD0uegpJQal2b9Zk1930p/soYug6GysNTDJF2MFufcVGTIsJs1DIsmWpJ0zEBeRJ/NxAYnnImPsXKT8DHB0zo2SpsfyTLQl74Efpym/2Yk5lOP0CBRkrbt+TBPOOCJi5oqjwhNf/6BT5gFmIbZVAvRZIDXK3sT5lAM5rJjWqu0sxP01dpjKGfpKZZZHChflyskqA+Ug9VI3VKA6kagXt6Xwt+Mz0XFsGcspIth3UNFvl1fai9a3pT/KabLliPf2/yosTd1c7MwHOXXztLb8gkv5+8+z/KeMdM82fMNBpK4w7naPW9gt4hL86jyxLrum/JBsqlxoXF3UaJr84I+BeuUrwT8oe+ijpFQkLZiQKXRxgZlBmsuSNonyIQPEKMeYLe6S8omoPQxxQC3ShN9ERvbIcgNofO0sFX3ypsslqZU9ApAIu+gb9lTM0Svb4zh75XVNgHaB09C0yLbSM+jQDXfvJ1/zgG6w7p8x3XicMAcFssYg9ftAO24wXj4JY7vMp2pBWr5AddpCcSXfgEH9NRSSZAd0UR6EFgES7kYIZb4NBdZ5xnx1rgO1Lvf4Pq0Yr6IfuVICPhkncjXb492DU3eKw5F26AjStkbgBxIrPCbX9SmBEm8/QrFX74VNWDZBVpYRJsw5T7nFbqlZpJbQm+vgV9ILTamcnxaw1rX1oo+UgKalp7M5P+QuRGrLvsy+ouwX/wmy26mmEbUg1wew7li1XrpPrcB6Osz4WhF9mvuay1uni5+BGVYrcL4T3HphpWeXnBfSBs/17xNOQI3GTAN7aSzo46LDA2HkM7rj7SsVlpb0b60yZv2aT8tUb1yZhSFST7mN5ytYVhwOHP9PbISnJsYg9i6Vd+F+YAJtf1/4pvOKnNNNKkotJ3b8yJesMkmaVwWwoFVSPUBt1W2sfMpslwgFuVxlR/nmah9n9C/hlO4r8Xxkf4a+DLNSrsgYjOvxjJbirQqHnxz78BPWht1w== +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

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. + +
  • Array [
  • ]
    • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/update-identity-profile.api.mdx b/docs/api/beta/update-identity-profile.api.mdx new file mode 100644 index 000000000..7739a87e5 --- /dev/null +++ b/docs/api/beta/update-identity-profile.api.mdx @@ -0,0 +1,140 @@ +--- +id: update-identity-profile +sidebar_label: Update the Identity Profile +hide_title: true +hide_table_of_contents: true +api: eJztXOtz27gR/1cw7Ie7pKasp2X7S0dxnJ4zSezK9mRaJ9ODSFDChQRZPuLoPPrfu7sA+BDpR3I3vUc1N5OTSWCx2OdvQQB3TpyIlOcyVme+c+wUic9zceYLlct8fZHGgQyFs+fkfJk5xzeOfcPMq8z5uOf4IvNSmSARIHG1khnTdDKWrwTLEuHJQAqfbffufVAzlsefhGK3Ml+x8/nf/z17+fbsHeNFvopTbArEUvGfQqbQP4+Zx8MQqMLT2cUZPtAj0UAt8uwyjgSDoUM/Y3FAjS69lYg40FEqztlCGAJ+j12tRFa25qlgoczgBbQJ41tg9TmTPv6reCTw/14qsCP+jGKfZgiSSngK73ORorzuHIkiSXi+glfYEf6Shk030Wy6EvtlxJdzfOfk6wSbZXkq1RLeBHEa8RyVU0DLzZ5j5eEc52kh2vJvS4KdvQRC4guPkhBpi2B0GByNR+OpOBpPDoaLyWJxOB6O+eRgdDT1D53NRz2MyPIXsb9Gth4edUbSQiG3xjYaKg0NhOt5cerD7FCBqJSb15fn79gFz73Vx+9XeZ5kx/v7eRyHWU+KPOjF6XJ/lUfhfhp4B0f94TOW5Vz5PPV7MC8vVjmMiUzyJAmlR8Ps/5TFyk2Q5l/xJ75uCZmnKV8DCZmLKKs9jxc/CS932rNERolPdm7nw3jGfBFIhbayZjfzVycMmWQu+9ppOXXl3oBvkkGB8YA6wFpgxFwK4hNedZhK2xJKqaOowdrhT7QnMlWhigiH4b5PA0fxZ0E/kpB7+Ms88OIEZQT+nCMjlRnZlhvD5aMczZh+YQQTS1BcCv6dpOB6YDVoEcB0ztOlyBnSRLa5YiIUETQwk+BBANrR4s7rk2wY+X59bGDxMw8LQbJT4jwg79zmtur8Ttyyen+YvszDWuPNXtkdZ7EUab3/qN+vetj3tS6lfdk25YOSBBhzDkMtilxr3ESPZCVDmTibTY2atWJLTP+96QjNgpEUjByLDGQI5tAU4l4VcPHdB7SPDw5owYffRuXwd+XPDwoO+Cz5eg1uSN5Q+g69Np1pljCWW87bzVOuMrRXct4iini6RjPyfTSKsh2r2pVqvtE+Yoxbm6ezb2PvzHY9iVUgl/slqStLKdvvOzWbaXV8p9URxp61vJKJlxgMpJZ5pSOIeYXKy/7QoanfLC5Sz5I9BYHEayGyerP2kLoPZe6hdzQ47B8eTg8XU/9gtOgPpofewUEQeL439sQYLWbzEf+hDJIloDg98LDfx/+1TcVkxnZefTjmNgMt5Oums5WWXo90ZNytIAfprsXY5RqScuQuhUITAu4KJSFPQYazGf689K17vVv6g+FoPCEmuH+uwrXOahubpLdHRdF/BX1OqgJqBiO0CZ7gCwzLOjc+QrmEANjazWUkWqzXhx/2hyO3P3D7o6vh4HhwcDwc9saj4b+QoxKqtFh6wyGB69feb8FbLVC84Bl4ZhTF6mUed8bNuvFYsAhMfxaX5BJtW2rMtR35VRGGfIGD34epak+sTLoco5rp2zXziiyPIxaEPGeEhQzkQ0XEt2DBj0MOSuLY9KFBt7lvTl0P0JHtTP4/e3n67urs6p8dWB562HE1f5g5blcS8A+B8FQEIhXKg5yMUUA0c0FJGKarfflheFD58DcMZgLgaOIPjgb88KA/mPjDw/FkshgvhqMhd2rO/TAbPxQRVy6aMMqU+TKDnLcm3P8L+Hsvw1DyiMH/M0p8iJpSSVVOjacKTJSOBY8Oxp2GYftTooaM+KBBDvowYpevdNjg1xnQ5fn1/OT0VzcfQ3ZnPEB1zmYeqoy9hKjn5THgIDSgtkk0FMw0QDAYD0ZpGwhJVz+ciwCAwWpehtZyrguoWQRXNNmAFyFYZcDDrB0nIfowGTDOLE2cFxLFOl4J4VOhvU4k1vEA3lO5BGOHLH67EgDomLfiagkSUnrlQHO/ggJrIeB9xH1RF4tJ2XasEwRYna7UFhNY7kLHVNNb0moFz6ncryrTLo+qO+ZoWGfosMbNFsR83MuEQou5T+wNU9d2ZJIJA+VGYDRYPYGULZktOdVUZ8TWgXm/pjLehmqd+Pgxb6njqtJkeA0j19YsIi5DNNd7cHZbx5ngWQKzqMoDA2uqfnvfGPnag+W1WFeOVxuqiQ1a1cBmuxzY5ms7xUNdQ3R5eFHjuHNpJl1I4Chds09i7er6L+EyzdDGAZ+kEDTUmkUih5iV86ogfKgkNbWIcEkre83q5e3aZJauCmU65YfDA3FwCBUKP/T6i/7I5wM+GemUaCHgVYeW6+/Ptg2u7NCk02pn3LHmqadfPEHCmoskTvO5jcRPUcOWufDs01xk4GVnnRmruZTXZUbSL40IaEH0RGJdqepgejTx/P7REMR4NPEnwdSfTkYjP9ArhDiR+1ywAVG5UgUPme7RHSprPmqadQn4XilCW4jgV1AYIKz3URFtfz1TPlYdZslYGymMaWB+diEA6UALk6Jqpb+11q5AfX/22qpKKCJucMFke1Z2CVzXzeOuUvkEsrXK2WmaAisum4u8SHEtUFqR0TIqW8Q+rWZLBbOTjy1cdq5W3hOkfPBcGZ7E/hNC1SuphLtMOa1WCmLZg46YSz5LWpKNMCBoklbr1K4ZwEASvQF7wX02N/M7MZPREdr7BLS6naDJ0LUu320XdACr0o5hxVTwxQFY/Tg4GHMOEG0wnSyOAj4a9Y8mR0dU4Yos40vRlcyaQ/8d1xCkx3BBJZQ/g0AAtoHsiQEa/On5j2g8MVXotuU0Db8sF1/yPcBAL04u2HjKQkBCBT3nyy0hKPf6shWLYOaa8DmAKtlZ5Fq8/vL01ez6zRU8mZ/+4/r0En4hrRZ+nymwVvLLmKDSKr4ljs0EbgGXZSKkpdgee26oPocJQSSuN5TmQxAt3TDjhNDDjN7Ro06aBSnU0HVXIr/5krPvZU/09gCx4cIFLcovMMJY+Ph85mFIct8YST5nK4DlIn3WY7Mye+pYk0H/NS0t+z66riYQFODKgr5NxUXOVJxLb6vIr0S5nRlsJHlTVwo6B3D+hJVyL8ewTNOse2FpLYZFox/gWUuuyd1VTWgk0rXKOdQRGn17cYq1BIM4ymSeMROOUF0ZBB5l25URqx72Kdy91czQIg2udvEie4LfXYQQflyaWvniszDOR6hERyPShlWTiUgGllNn06pUl3V8/Q1v57s739357hN9d/vl3HwgMG8J+gza0OdameUGTJ4t6JOS9ajYrkn8rMsvrcg9LFsNRHr9/spsA8D69UuCqw+/Ij7SqbzF/KzUh36+sJ8fbeqvdIEMkhz1DAKIRMI/Jr4rjklQWlSj9mivYijDwEBVB0SEqJmydVzQroO0UAo54dke82ORqe9ytuIQH6FmBH51BKQ633cT/IK6Q5I7JLnLRrts9OfJRjskufPdne/+MX33QSTZ3OtjcFJtX49i5j3OljNowOxWlWo5utyTU0crSIyVGMtpIgdnMRwsBsHUE2Ofj/2D0VEw9A6GfDIdTAeL8XDq1HP9TeXHpZM1faqmb61H87kh/Qw4rlBgXFkex35z+Q/Em4oAwxrtabO4GWQOIv1YYcdxx+6TOIe5AWHAjuk9y4vX8zf6G6Imj3LTX8/Qac0HR/y8hZASbRgkLbN8Bx130HGXfnbp50+TfnbQcee7O9/9Y/ruV0HH8WPQcfwV0HHMEGIFCLF+S+joA+5AaBaAUnAzVAHiVXl1PsKsPhq3N6ckLNBroMjhUceWmDhmb3GnhwFLWWMlUlXiwvAGbSNsm9q2ErdnLSFEKjxDImO9T0FGAjEp7hMOZSTtOSqkm67dWYDHO7TPWHsrR5HKCwvgkIKC3XJ1yyXuwAoQ/gEFWgddQqD+Fdc4jbZ+0Xowm+OM3+CMGe57wH1trFz/nXTtEjjDoy4YLi61ru/ZLqDXzLmCMkJ8SXT4KiHoDqrvoPou3e/S/Z8j3e+g+s53d777x/Tdr4DqBg3dD9WhwZOhOrTt9VmJpV5xvTv2f4vYyVUMB2TeLPYIq/sVBgchZAIe0uEeGOQaIP6JNuVZgWdRbxzpq+PtuwCOQRUITj/iXtRIgC3ijOgQu9M+xWp7Zft3HZcKbBzkAcGmnmeRhtDZHkO/A/WD2jc9nsie7a3i254XR/sLkHlHOMPdq9p1sQHdwKAH6JHCUok+oQMoEdfqM1tunQzUSBsWHqRsdxuvoahhmswebq439kmPgcUEipPvMmrdM4eht+YH87pOw80vn4smdM9cusT34GjQngGnW1N09O5jazJ0SYUevWU4VXbCbwjD1mDn2GzIXgieQpmht9V8//r91TNWOzObIXQWEgsO8MALMBGKjzO7xQQ7UcpK42K5IsZnjU086I8swIsx2Ad1KQS7sTum30HimEOkJ5FiJ0HBBXtVlyD44rMIMaf2Kkmi4YFP7IOE9nmj3zPKn1RoSFWe4+h9UK45DoWn0KmNmSLVjewmsfPitXl9KxN/sdRcTc0latmzLS60aG88vSncg6CAJHiYkbS+eXBNz63Rw6oMniDVbR5QEoaP5tYrz2rtm/lo0HORXpOPD+o9nWlrdmM6lLEMcmvoszPmreI4E39jDE0H3eBmWYAXfTNbdJDOJY9wh/0aS64e0pUuQE3i7w04htLGxBeY6gnpxHrRhVzyR9Is+PyPdOnBj4050+MbyMjY0o+97Jt5xgFdHNDVMSAz/OuEh4YFvo1zoDigDeCk0j9FAsNoLe5pWp1RncjvUx9MDR6wqm8eSI71H8dVgDO/GL3A1mUbCMMOHWAym9HwQh5Da1MdMNXCsmsM2xJs8xvGkGy35Kb5Lb+UYgL+vc0XZzyrlmLwyPuvHaXviSS/n7j7G0W8XaT5M0Yag51xSXNe3T91aqsce6tLdUeRxcTNy3pM9dC+jQZAFpoyTWnrqBc60AuDBdvLjhndMQb/wluKA1QCQIGlry5DhFQnBOzldAIUI4a3koIWLBLBc8SVe2i1cUReDoAdQwuUpURoSTeGpCAODiWmDIGevZqMRubkjBq0os3g31lRnijXB6h77D3UkMoDlWP9iFuL4d1PsSkkL0HrdPkSe2kNieF1G4UydwkUEeNgro9Ymy8zr9BBEcpJJawsYoKVZS8bIdCMcQp0Mk+kUXYe4Fq4xIOWzhPHApvKzEI4iB61aK5FqiYyF2F5LVGzJHiMNliyuxJhghUsRHQAd6I2wtuzqxZFIKbM1xe8y8t0yvaxLd44BZPX5jPqDXp9l0oRvPYhznIo9GrEr++/xW7bFO+qzwD/73ftmRSLtdF+gouEKNxC12o6Lty0bttDs2iV3XgFH0SGFegF+9zd4doSVo8bfAxhCBcubj5WhSFFIrAbc2K/6zKEup6+t3cqPKOvY93X83XOxi6MqnUtqsHPTwKXUrrmsfmIB25p8Yu41C3N1xYXr+SoUXrovjysqXVnvbb2QDensVxxMbs6+QFaL8zNgZFeu0n5LTzEf4+dD/Af/BEn2lOhET2/c+xKKLT5qbwmhd8DqcwP0Aw0+y8VcuGU +sidebar_class_name: "patch api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +## Request + +

Path Parameters

Body

arrayrequired
+ +A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +
  • Array [
    • value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    oneOf
    + +string + +
    + +integer + +
  • Array [
    • anyOf
    + +string + +
    + +integer + +
  • ]
  • ]
+ +The updated Identity Profile. + +
Schema
    owner objectnullable
    + +The owner of the Identity Profile. + +
    authoritativeSource objectrequired
    + +The authoritative source for this Identity Profile. + +
    identityAttributeConfig object
    attributeTransforms object[]
  • Array [
    • transformDefinition object
    + +The seaspray transformation definition + +
    attributes objectnullable
    + +Arbitrary key-value pairs to store any metadata for the object + +
  • ]
    • identityExceptionReportReference objectnullable
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/update-lifecycle-states.api.mdx b/docs/api/beta/update-lifecycle-states.api.mdx new file mode 100644 index 000000000..9c8896d98 --- /dev/null +++ b/docs/api/beta/update-lifecycle-states.api.mdx @@ -0,0 +1,118 @@ +--- +id: update-lifecycle-states +sidebar_label: Update Lifecycle State +hide_title: true +hide_table_of_contents: true +api: eJztXFlz2zgS/itY7sMkWeu0Dssvu4rtzDrl2FnbqVSt7NqBSFDCDAVqCNKOxuX/vt0N8BJp+UhqjpQyqYxEAI2++wMI6M4JlyLisQzVsefsO8nS47E4kb5wV24gLmL4pp0dJ+Yz7exPnKyF2abrHccT2o3kEmkAhcu51Gz88ZgZUppJ5ckb6SU8YEE2WuNo5ksReJolWqoZi+eCTd5fnJ2yjzx259ev5nG81PutVhyGgW5KEfvNMJq15vEiaEW+Oxi1u6+RkPJ45DWv1JUaszj8RSh2K+M5Ozv/8X/jww/HpyyMiCGexPMwkvGKAYeR+DWRkfBgBHN5EMD0hm8gBPIuecQXIhYRSn3nSJRsyeM5NClogG/SEyoGYo1lFPoyEA3pOeu6OLZ92EfThx0fQp90amc/jhKx42h3Lhbc2b9z4tUSSes4AoU49/c7tTNnWmyQFusmXjPTc+e9Np2Fjt+G3gp7rI8tTzcGy+qYhX7FwsYJWOZkmnHXDSOPDB5+C5tfAgk/DILwFmlaj3K5YtN0dm//Sr1hQvFpIDz8WGAevyJHiYrHLjFonwitrdGOPXoGqpLBaRhLX7okypklAJp1QxWDpVFRfLkMbIfWzzpUjSUK9g/8iM0VnfMo4isgIWOx0IXn4fRn4cYVw44ZaouUxc5SpTKuQSZfKnDn6YpNzt8dMNQUa7Dn6rbkJhNIDhQL4H3gEuDoMGMsBfEJTRXPqeaCgunR3mAT+OqH0UKg0wqVLHAa7nk08SK8EfRhGXAXP9kHbrhEHUE2iZER8YUvlgHOm/a8t1w+ytGYmQarmFCC4SJIBstIaIxVm4diHs1EzJAmsg3eJAKxgA5WCO6Dm8dG3XFRSKfIXas4N7B4w4NEkO6UOPMpsaxzmw8+FbdFR0XxZRwUw3QnG45SzERUHL/bbucj0vbCkMy/0j7Zg4wEOHMMU02T2Fjcpp/lXAZyCVmiQC314pSY+X5fUxwEIy1YPSYadAjuUFbiTp6dse0K/ePKASt48NmaHL7nSWWj4oDPjK/3EIYUDVnsUHM2eGL8uuCBxq3Kpsws6XwyCaY4399Iyw9QWU8sOamJ03VHnb323nDY6075tNNvd4a9XnvI99r+bqfbRzKbu/R853rz3IU0V5gZ7Oxa+xydjt+eHEGbDpPIJQ5zznoD3vX3uv603Rnw3l7H7QALg7bbzzl7qItrOMvmOTy+2DDR3mDE2+5otAdURrzbHnb7e/3Orj8FKpskfCBFO4XIU9i6+sAVn1FtN9XMPB0HwdhbSNDNvs8DnT2/WAoXSX7SNMS20WRjz4PEoU+g+gH/11A5MSyANb0EHZuw6bbb+L9yIKSOs1bLm5uLSW0FyQK3nJ8BFdRkw0hw70wFq1TyPGys7nf7Xlf0OwPQfd/bBWOO2i7v9Pc6lVRaLvVMek3McSZJPGfiHKuc4tgHoYzREMMJaKZYuHMF2glOnz1lxvpliUZdtspmoYkpH61hnCYjyAt/sZEKioLukNqIzRLJTQk/E/SwlGoeAnZGG4VWms0FoWPxJNNjFebgZg56YiOWpICCP4ADNNr9RnfvstPbbw/3O8P/PsqOnZ555Mv3WMA9CJ0/jqF0/pwjiwMLDE0BDwleKt11IPfzXECVMqVqHeaC8S1dXGx4UtNnmi9dJxxg8i3MmtfsTG54tNvd5Lid7jpTp8liCjwB8rbzQPQDhxCPc34j6ng1SnggUz6aVdbz53OVeOwzeoycKWJvYWihCok4GgvEqdOyO+dqZgSoZOyvY8QsAAHXETXGI/F8ZtbKxNdrJkFCTBuywIhUAH/Wyw7goKmAxU+F5w38VktXBcjliIhQ97/wn6YbLiwK7+YPrqtrlwygVoLTLBJRMLOeAoUTF0I3GSjgqk6VhPRoAQEuUlaRTpX0ZOELWPDogRiALmtQ6RmrtXK0pHhnU9rPIFdZV6YITHH/xGeGDruV4KaAmmtSTWExlRFMQRZApiLMeliYChjoDQZtv9f3BgDEBp2hx/mo22n393oVdi+IPjtGRipeUHCmJxDe3AXAVGVVkfqVtkwcaqzJwn7XbJHoQj40+mE+VKoE3AaU6AeQL2l/xoxosgshwBlblgB4oFDeEheLVOPtPJaCLrvVuOg71FIB/Y/70++vO8NkupmFOjRlBCOLax26kgo77azVV5WCDsr7h7hUhMZeHQ4+CCSuqo+iCPTaYOcCNIrbGNIkXbsLxaahR7t2UgGSR6T5zWCyJ2JIAwehVwshy8y+k0o0ZhGnjRZBLLswkAHFG0lbWoswQkyGJNO6Qf2apZAHTTQ77C33QF4j34EVBnUYcfcXoHVci5nWVhFK/opraTsEMEC2mK6ZVgwFnw7aI1goDnqcd/d6nWF/OvL57m571B+NCK+BE0A5rvPR8tQ/CiUi6bIgBGwsfwOFAGoB3RMDNPnT0yTReIL+MaZN30xMyy/A9C/xDuPs7cFH1huyANJ9Qs/5bE0JqvHpAvdSkyDAzGmKMUhuCJ9FcibrM7ZNr4dH78afTi7hyfnRfz4dXcAnpFUJrLGinW9wy5Dw2RxqdJwLcMuhtIuAdpGa7I2l+gYE4koXO0rzTa80KBO3+XgSxDDCzl4zokia+VG4KIUSxc2XmL2STdHcgXICzxa0nzjluBsTGvDxBvKYWMaNE6vJN2wOqFREr5sMkINEIWGRQ+tqSLB8RbtinmdgChLwE0qvmDDCJKbq7IqyLXJVlq1RSCRFo9Ca70v8uJ9A7sW3DSRmMQozb7EsWvvgMpzmKXN3WVAaqXSlYizE+LZgBWqMItAwm4JsMtbMpiM0l4bEo9J+WcYqQQ/k5oNh5jAOqc3liX5C3H0MIP00SLSs4UbY4NO4rWayEVkjNZPNSHbDnQbbXpm50sA3O+jb2N3G7jZ2nxi7643ndvfPthL06dRsASr7QhKLZwX6RMKsiNO3lr+ZdyjGkDuIWi1Eev/50r71xE2IL0vcNv+G+MiU8grz48we5vk0fXOSlv7cFsgg6dFI4EMmEt4+8Z1zTIoyqtqtzvYujKYSHFTVQERaTK7ChJBqlCiFnHC9w7xQaPWDBf4G3poMSJs1XoPw/BZJbpHkthptq9H3U422SHIbu9vY/WvG7kYkmXFF0WJxkk4WCx6tjKfZdtrOY9CBpe+hWRZy2YvwIlpBYizDWE4ZOTjTbmfa8Yeu6Hm85w12R37XHXR5f9gZdqa97tAp1vpJHsdZkJVjqmBvY0dSMYC4G8BxiQLn0nEYeuXtP1BvJHxMa3QcJ8XNoHNQ6XWGHbujKna8DEP2gatVipB0CUOqXEeY06DvAvtGaV/owNkM8qLCg0syNK+D5EIAlQjfLARyISl4UQqgG60aYx/PFJlASZ0sm0UqN0iAQ8oEQWiOwd1yCUIKHzEfUCAEO4Ps/A3RqTXRVyF5do4Sn6DE7OiLKwQGeobc+3X7u8fp6/ALY+AHNnrNaocrcABYEJicleHOLT7f4vNtjd/W+O+jxm/x+TZ2t7H714zdZ+Bzi4YexufQ4cn4HPo22yzDUu/QuX53mE6hYjkg92ah6yYRbTenGJxwBbgSMkQXH5z8dO76hRnduqu5Q3PfWjsSC92qF17uga5ZMhhhkiiAKdILDndgY7DtfZMvZTOdQ4W3eF6pNQXF1uQsc4IT/Q070H0hM0GTrBJJdHyTJYm4sRHpAV0cbEX7yRsp0wlSMP4qTCAvEpkdBkFinZAeA4tLWIH8oNODrnTMfk0+kOtTFNx/vSyG0AOy1Klv42zQnwGnayKiCNdoLnAWIET2woNdBybFjRN0j8l1sc8FQnrDYaVnXqZwGditMHSG3brsreARHtakNyOv3n++fM1mCGQpkZgLZ0LSeU7OPoIbUaIcp28JcBDVrihMZubAy7j0HgYDk/kBKIVdKTwtNEnvep1CBTmHlE9qx0GCsgyOyq/geOJGBFhcm7m20Tmlp1qgxRYvjXtNhZRWHFKZ06J43vdKNdihxPxGF6uwjxWRFpBsskzl4gW5XsrE31NqDXtUiKjp12tcGNVOXHOux4XsgCR4oElbL57c0GsU6OHyDJ4g1XUeUBOWj/LbMze12ov5KNFrIL0yH1fq81xClS4PYyYpMg1FNvDYMXPnYajFPxkdNMNQmcwSiLQXs3WLkzYoIhrddoGlhpmyIRuAOYm/EwgMZZyJT7HmE+QJAQ0qz4TtT2RZyAs/0ZWbn0oy0+MJlGbs6YWufjHPOGEDJ2yYPKEt/6byoWNBbKMMlAeMAxzk9qdMYBkt5EZDqzbzE/kWjcHy4QKrREUv982X/TwJ2k+MGrB31gdSNUL27H0iHh22tOiwX1FZ6WbDugar/AYhVN01vRl+s80urMR/NnlR4nG+J4OH1r91ln4gk/x58u4flPG2meZ7zDQWROPe5nl+A/vopfcTK3ch8bQ+uDKJZFcyxQB6a/Fidf9RC3vgHlopD9BaAFZa+ZHgIiFgL8aIoYzhzqWgnYul4DFizx302nBBUQ7Q36UbAIbQjG4QRaAODmtNGQA92ltPZ+YUjAbYos/gd53Q8omu8puD/uwznpJ3weS4kMTTIdD2c2hXlBdgdbr6yw5TRwJAt1gkCu/qA9vJguENmke8zZPaTUxShHWlEqkuQoKV2ag0Q6AbowhNWlJFC33m46Y4rLcLTvXIXOBT2u6Ig+oLl3JzQc5FkF2KLS8bHqMNntyYi2CJS1nI6ADuRGGGD8eXFYpATNkj83iT3A7SLeyL951BeOM+u81Os92g5Qpe1Q51DIvvAnFzHZKt/WzBuhfe5a8CvpOfmbBFElc3rSXu96F6ErMiM5E9qfzQBBp2v/7XJ9aXztiz5tciIAnMQ7qx6tzd4X4SLibv8TFkHNysmFzn60RKOtk1k/T264N2eXVuJX7N6n/9olbkdCNUrQrJCz7+InDrpE5YXBW/iKvan8Z4AVM1esXLyY7ZgCOtmY72jU/jckXIKiW06YciUDgz2OzvbRhGKT3bc/k4vjz4N/Se2p/tWJj9o4jfwkP8d9+5gv/gi7lSRVWJnt856W4s9DGE8c//ARJFXWE= +sidebar_class_name: "patch api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + + +## Request + +

Path Parameters

Body

arrayrequired
+ +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 + + +
  • Array [
    • value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    oneOf
    + +string + +
    + +integer + +
  • Array [
    • anyOf
    + +string + +
    + +integer + +
  • ]
  • ]
+ +Updated lifecycle-state. + +
Schema
    emailNotificationOption object
    accountActions object[]
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/update-managed-client-status.api.mdx b/docs/api/beta/update-managed-client-status.api.mdx new file mode 100644 index 000000000..05e1a5cd1 --- /dev/null +++ b/docs/api/beta/update-managed-client-status.api.mdx @@ -0,0 +1,95 @@ +--- +id: update-managed-client-status +sidebar_label: Handle status request from client +hide_title: true +hide_table_of_contents: true +api: eJztXG1T27gW/isa3w/bdnCIkzgvfLmTAm3TS4ENYTuzlGEVW0ncOpbXsoGU4b/fc45kx04Cpd2d7m43fYFElo7O63OOZMt3Vsqnytq7sN7xiE+Fz/bDQESpsi53LF8oLwniNJCRtWedxz5PBeNMpTzNFPNFyoOQxVwpGBZEbJLIOUtngnlEwtqxZCwSjsMHPhDIiICZR09zRqSgZ8wTPhepSJCXOyuCLzAi8OFSgJPHPJ1ZqxwNDpic0IxV5pkmy1LJ9JwwMhG/Z0EigI80ycSOpbyZmHNr785KFzHOpdIkiKbQU9zyeRxiE9fkgPn7+0tNQqj0pfQXOG6VoiejFMWGSzyOw8AjyXc/KuT1rjRhVYiNrAMbhi05/ii8tCLAhTVGFkCGSl/4FcyBP+AejRcnqP00EArnHBumN85dtgXDnmDNiUzmJMAGVgoNgaQhzPE/AbQtNBWa2W13uvDZCzMF9iTLO41mC5u86RU4zRRa8o9w5XbxueW2zeWYrH18cnyIDVJ+GsP/fFCj3nDqrUbdabg9t23TV9dxnFbLbeKUM6lS4zlzMeWx9O1MCa5Sx1bCS0Rq5z1qClw3lkGU1jw5JycDXiMeXgUx8dup1eGvA1dCGH8mBLLltBv1bqvZa7fadZRHBZEn8mutTr1bbnsXhGGgSldC6fHwQFxbexMeKkHm8z6lCfeE1h6aEz5GWRgWtkVdDN/1j+BylqF69VUwrp+BLTBE0ELX/OoaYoesanqEPEUbLtutBkakKjc0W26tSVJCu7HyBAZ6PEF1QkNyHSiZYPBGnyJ5E0EkLHnbEDtRNkcHLZg+Pz44fDU4PjyAz8cno6v9k+NXg9fnQ2rIvwyOX8O39/3hsf50OByeDOH3q/7gCDpeomenFJEbHPYQp1xFBgNRG9HBus89ejUcsPWBMTuPwMT+PjKNaudjbNBwkKtCX/2lDz8Gx6PD4THpZTD4+epNf/jL4Rk0WTs4+CExRzjxfTm61xnPLzEZEfdVHCxAcFUGHeTQgtdtpFIRDAKsbtcd+Deq1/foX61Of34lP3jEKnAdeyRCxTJSGoMa9fo660Pq4St2E6Qz4l1z62/G9Jr1LwXanC5BrOM2NMSa9FRqKYGu22xiZCfTkSabAs+EFQcQyKHk/nkSQvMsTWO1t7ur4tQbZ/Y1t4M5MKtqqlnjc/5ZRvxGIUzuwiUAB6BS+wwwWcz2Vo73ZYYGccg4k2Ca6bSPDJtOhgf1u9rXDcvxh7cae4nrhtdzuvVut9P2/U7PAbDvtCcdt8snnbbruV0K9XGG6YBgFL0YsDxLxGgG3jaTIVKpQ/N0np5MJkqgf9uYX9Ax/CwU5/E04b4oUSjDJ3yxV7MHpBsbwL/jtppuC2l/lGMj0C/9q/PT18P+QTlhPYnKPSkrAkvL5AyB1hO6+NFZtFVv95Brk9AOI38k4YfdPziTWeIJqzT8CvMamhJ+1YzTmMS27BPLBPs0u71K8zNgOBQ8eg5snp0dFdmp6PEqQJWhv7wJFHxf6BRzv1PmtLuJ089glUfY1YlqlcHV1jX+Vjo8gb2OU9/A3kksoqOD/ukmRTqY/Ru1dut7abDjNJcsHizgQ+D9LU3dcTY55Vt/7D3GLenTrTndzvfjs/MAn9/fHyGmlQ7wQYU7ysq6rLXrDbvujhqNPbe757i/IqwFoUbteQwFpNOpN9uu03Tr9abTq7vzhfo9tItZ7Y8cEKeLNatT+wjl2/0lLlkApzSm6OLR6nYa43ajMbFdPnbtVrfZtntOp2GL5njc6Uzq7rjhVXHsiSNM7WpBrTc4e0PVXboBIFOeTEUlY811ZjxNJMCf2l/LHjOe6E9LgIaqlVaMsCKEhJIX8rum60opqK3jCwh2X0QeZWntK7jeqBJuOe6V221edXpY/W+cw5t+xQQpeMpY3lYnaW+im/d8Ou1JmJkaaEnaLfGsr0PK/gqakAbBFqtUKTjXOC76PpU8LaFhAZ1ROfPAMg2G8DCww5vUNsWBbcqYREw1O5mysa/tYAKdc1y4RTzyiOpNEPnyBoMGSnAYpL9DvZWko2C+jLWO3egVJe2vRUdTmWzo6uw13b1Ga9n1VRAFarahZysnqgvg7VJpu1T6wlKpP50OzTLJOE1r00LJ8HmYJDJhNhuKNEsi3HjTRjCbU2ZVoWBhcQ2R5H/Veml1+VFd2ej9vn3pi03uXGUWwkPYUGUHyKEglj0YyIDideDDCDaXici3EI0fUb9aRa2giZrDXnIf5NXy7RthUKcJ9z4BLUwnX2LoPApgPMuHsMBnYNGHphUdwcfteq/RmrRbnDe6LafjjnsT3mzWe26vR9AD6QqXSaW5eZLwxdrUr0UkksBjtP8TfAaFJABg4H3IAE2O+0+Q5tWXbUA0nqD/Ecil+xZiGn5ZKm7THcbZy/1T1uqwkEfTjNr5dEUJkX1+that92YjS5wkwTSIHkM2gLP++dEIWoaHP59D+BbBW2W2H4G3+uiWwCr4wkzeEMdGgBuumBIhqEP4NfbCUH0BAvFIlTsG+ptaAIjPwbcmPAtTGGFm3zCiTHq5fZ2HEsXNbcqeBTVR22FjbAMM8GZszHHL2wDIi77niTi1j4wmX7CZgOVl8rzG+r4foJA8ZBCNQBTGL4AQ476v98yRwCSDUBa0ASKzlEUyhUqxaoulKlexMweWo7JRMDiA8y/7Sd9LM2COxCxHYeEthkVjH+BZa67K3aikNFLpIkq5B1LwMFyAGpMENMzGIFuQKmbgCM2lAHiivF+BWGW8JLh7p5k5SCVd83imnhB3pyHAj02iFReuhQk+ujmg0YiskZvJIBJcRLFpsOlVmCsPfDYJROhvY3cbu9vYfWLsrl7M6x5zlUofZ730OY94BvpNKHmulT4JeU8kWd6JyhtjyB0GCjEl0tv3IwjsTyLC/uI2xk3eP7E+0ql8jfl+YQ/dPsbyozBWxRbIIOlRS4D7msLfI76XHJOitKqa67O9ksk4AAeNNpSIgJoJW8iMcVBZkkURcsLVDvOlUNFPKZtxwEfu4UJcIyDOGvm2vlG2rSS3leQ2G22z0Q+TjbaV5DZ2t7H7z4zdRyvJgiuKFlMnqWw+53g3Bj3NXEdpOYMOLH9QgRUhR6ZarVaQGCtqLKtaOVjjhjN2Jh1PtHze8tvN3qThtRvc7TgdZ9xq4C2fZa6/WMZxEWTVmCrZW9uRVIx3kqCOyyJwLpVK6Ve3/0C9iZggrCH0FHUz6LyG94SK2rG1XjseyxRkA8JQOyYPbC+eD4+QPkxN5FFvdDsNy2ytOujOUyop0YdB0wE9dbAtHbel4zb9bNPPj5F+tqXjNna3sfvPjN2vKh1bXyodW19ROrYYllgTLLH+ytLRh7oDS7MJGAVk8DJQb4RlYwyiwCez+2jCXj+yUxR6lSqy0VuvIkdS4hMBi7xYUpWdyGipLoQ36DvHvkneFzpwNgWIjBigVgDVLXpVMBdYk+LxkzCYBxTHKBDQTRZ2f5KCVDpmcn8rZgkiL8yAQwKFUOLeqwQfC8CdxATLP6BA+6BTAOo/cY/TWOsP7QezIUp8hBKzw1tPCIz5Yv/X3fSUwMCcY2Bn2tYPPC6g98x5BMsIcRtr+CpK0G2pvi3Vt+l+m+5/jHS/LdW3sbuN3X9m7H5FqW6qoYdLdejw5FLdxac3WVFLvULn+u4VO4WK4YDcm0mPanV/WYPjE8YCGoNUHzM4hxJ/X7tyP8Mnti/wgOieecje1gfGbP3Ir2m16KDAXIBDolixpO1a87z3bnWk2r0L/Pvd4jicXlCYEwaVw2R39FR2el/jcVADNATLp4tI3tA5sjHoegOM4VOrOmSxA+ufDsyKpUaGSgKMBQ2cRFybjVRjlR5Nf5QyPneO/rCAxQzTZHYYxI3xS2oGFmNYlPykqHeN/HBNPpDrPAnv/7gsmtADsmxS36OzQX8GnK6IaOmn73NXOcMKXs++5jDLrIT3Dhprk51gtwZ7KXgCywv9OM2zt+9Hz9kU61bCjUxhySwCXGhA5J2CixAu9vNHS3AQpapEZlN96rNfeXgH45BNQhCYfYjOhGAXA6OEY0gYQ0B4UikOEgQqOOryWW4dX1yLEHNp9Zz3LsTCLmhol1fGPae8SQuM0nHM2ofIZgcBwlmA+R/7GBFpvcgu4lwuXpLrW5n4T07N1tRsoqaer3ChVXuhw5F5AAZIgoeKtPXNkxtgKNHD1Ri0INVVHlATho/qI1debrVv5qNCz0Z6VT4+RO9nASTl6jCm0YspyKmhzwbMm0mpxH8ZQ9fBMLiYZhBF38zWDU5qU0TYjXqJJVtPaQd4goX4O4LAiLQz8TGmeKpwpN5soZD8jSwLMf8bLMB99ltFZmq+gEyMPX3pqW/mGSe0cUJbY4Ay/OtEh45l4SkieaP0KV10gP2l/QkJDKMl3NO0NqI6kd+lMZgaPGCVqKh4T3/ZWwKc+cToAvYu+gAMY4VePIQG35mhhdmuoqx8b2FVg+v8hhKS7IreNL/FHVJMvH83eVHi/nIL5iQKF382Sj+AJH8f3P2LEG+LND8i0piaGbcyh8u3+Ryuv2Zh+16bf9t7bTaxZobqc4mlQ4WPH/dDrU8kubVZvJZB9KVZD6xvOeM9kZmAn3CVcgEZDxbXy3ejlAnlmqCs4c0CQZtVseApri12ELnknJA+1oerhXnJyjSBPpAWFNiNj4MQ6NHtlHxmToCsFy6IG/hdZebhHgmQx6OpqLH3gonIg7DHvQN8rByufZRmE+EM/PAU/ZAd5GACRf18nkUwG+J+NmccIOsLiOMHyst0YjRH3bUIkpYWxag8SyCUoQg1WkUnc3UyMW/WKAHLF+YCXFHmJgj30tJZ5aUgQxES8mG/6rLwS7QBzeyZCGN0EsjqAs98Lmd4NxitUQRikbnzJpPprhmkdrEvHtlenoqvObW6TctRaMdlPKzdS8TfgClDkb+8Ld/CoY2w4n1tFYe8W94I+pZ3v6X5S2du090Yt1aRrUyvdPXuwoW1srsAo/bolW8mEi819GHPuzvch8MV972lz5HTixUul4tp2oQAPeNnv8CiByV6NjSv+XnOvuY1chulyreVo8VyRwmB7xPlD5Do/hJ66Z1CYlNfMLem7JF+qVA+cO2eG+4+6BF69/HRvuW9nNMT3Ictctpcb24l/AYa8eee9QH+IkrG2p2hE7XfWflWMfTRdPPie1PtaT6AOaDb/wFaTJXE +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Handle status request from client

+ + + + + +Update a status detail passed in from the client + +## Request + +

Path Parameters

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/update-non-employee-record.api.mdx b/docs/api/beta/update-non-employee-record.api.mdx new file mode 100644 index 000000000..97e5862a4 --- /dev/null +++ b/docs/api/beta/update-non-employee-record.api.mdx @@ -0,0 +1,107 @@ +--- +id: update-non-employee-record +sidebar_label: Update Non-Employee Record +hide_title: true +hide_table_of_contents: true +api: eJztXOtv2zgS/1cI3YdtC8uxHeflL3dpkx6ySNtcHihwaYClJdpmVyK1pJTWG+R/v5khJUu282g2d93tabsIbIkczvM3M7Som0BnwvBcanUUB6OgyGKei/daHaZZoudCnIpImzjoBFZEhZH5PBhd3gQXVpg3WuXia75f5DO4FshYjZRI0lHKFZ+K4Or2qhPkfGrxJhAMS4rsWE5ENI8Swd7R0FSoPIDBsbCRkRnyApycz6RlRvxWCJuzLzJJmOONcaaAmiipGWKwCxxm3PBU5MJY4lEilYwDd51AwQ34JlGQ5jLvV2kxGbMXFxdHBy9hNHIgjQDd5KYQnUB85TAaiQ2ivf5ub3e8LSb9eLgpen34NOa9SAx3enu9IeosmomUB6ObIJ9nOMfmRqppcIu68bK91vEcRzzMVmQEGarSyhimdtl+DkTHRS4s4wYH4yJRLmI2nrMCDMVw8S778EXBZz1hVhcmEiziqlSpUDHDDzDITLmSv7t1eJxKZesDOZiBX3OZ8DGYbyJFEtvuGi1F6BtgVZCLZ1kiIyK48dmicDeretHjzyLK0YYG/TGXwtLcKNKFyt+T9ZaVuGzJU6cVgfaDtcFVmZ/P0PzI5sJ46FCSp12bSnCQ204wkcY+cqG6M/9kGc1cs8RHtwQST/gTaePENaTPSq5BizL5Zqo06x59/MNf70aa2M9mWn077zSrucpW9R+SdUBhHiZ8PhOVKY8O0IU5u+aJrFk61ww8/RrGWZYjctQxApjxazXZ+cyBwVgLZMYFBWLgN4rpo0nGTdoeHba2d6OtwV60DeiwG0V8e7LXi/qb/U1cE0JqbRDwOJa4GE9OGuGwBCLLjFVAwMaJHm+M+ZRNtFnCyw7r9xhfQIZEfQnQz1eZFimz8nfBbJFl2kAkdUkzOTf5AUT/OtXAAimHOEdZRJhL8PH79MUcG4j4jOg62Glqrjfohb3NcDA87/VG9H/Y24K/5PAq/i+wUuHfMiN9YmRrhZHbOuRdNnCqDiW1yC9jtYymhfvXfK+u7IWsmEdlTiw1EvMifdzeOo5sppV1vjIANleyyn4J5PFdOfSZgFuujaPKQphc7zdOlYnJBZ83D7Ro36L9/wnafycA7++Fvd1wsHne3x1tDUZbe93+9uDf3wG/e3fxkepYQvl6P0zdzcjHmVCUN6sGhfvwLQk/XiVU1j8vJ57kfTwMe6PNre7ODvJwe0eCoc7P5ZbhunTyJpGo/UNjwPFCdirywijE3UmDI2xTsM6QisL4GdNMLHLAtjc6fgRevZVKhFPDJXIoiOUIJjKgeC1jmAGmg/bJkUTUQRFoXFONoIlun73mMfOJhr3xwqAaDY9+BVqPQZYLJWE+K6dg14kBfMeyYkfw8XZvbzCcbA85H+wO+ztb470J39zs7W3t7ZFTC2sB9+rowY3h85Wl/ymgFZQRS3QEFvkdFAIOA7onBmhxmCJzkdqHbUA0HqF/hHU3thLT88twG6EDyPX6zQkb7kAcqWlB1/l0SQkqvDjDdr5IqAN17SamXCL8wcipVOtYEapIsVA7OHy7f3F8DldOD/91cXgGn5DWyuYDFEpSxeiWmlrmmf5CHHsBMMasSAR22V32ylN9BQJxZesDfXVt51CPpOBbE14kOczwq6+ZUSfNJkanjVCK3J4LeyG7otthY7wGCBHN2JhbmKAdFrzajyKR5eGx1+QrNhM8FuZll+1X2QaTKhCF+XMgBM1+jKHrCEwKCGVgBsoDXUBNonMZLaHrQpVNayyw5LhuFAwO4PxhP9mP8gKYIzHrUVh5i2fR2wd4dpprcne+hIh2rnIegRQ8SeagRgMFJiATyCZzyzwcobksAI8qx1WIVYdIgrt3jpmDXNO9iBf2EXF3kgD8hCRadeNa+OCzWNY4NCJrlGbyiAQ3UWya7EdV5ioD3+3ItLHbxm4bu4+M3eWbp76J9nep9Omvlj4XihegX0PJc6X0MeQ9SrNykNtPdYbsMFCIL5F+/ngOgf0rlHAwXnzNcEPhGesjl8pXtwEqe7jrYyw/KmM1bIEMkh6dBBNAIhGPiO8Fx6Qop6rN1dXeajOW4KBqTYlI29NzXbid60Ip5ITbDoM+zaqfcjbj19QNAr8OAXFVFYeZlipvK8m2kmyzUZuNfpxs1FaSbey2sfvXjN17K8mKK4oWXyfZIk25mTtP8/fdfjcMYOXPOawKOTLVcrWCxFhVYwXNyiEYD/rj/mQnEsOYD+Ptzb3JINoe8K2d/k5/PBzsBPVcf7mI4yrImjFVs7ezI6mY9uINKxQ4l821jpvbf6BeIyYIawg9Vd0MOgeVXi1qx+G6xyBykA0IQ+1o7thevDg9RvqwNJFHvblNegxaUh0M5zmVlOjDoGlp87Z0bEvHNv206eeHST9t6djGbhu7f83Y/abScfhQ6Tj8htJxyLDEmmCJ9T1Lx1jGVJpNwCggQ1SAehWWjRmIAp/87qMP+5ybqcirQq9RRQ72VqvIc63xUeN5WSzZxk6kWqgL4Q3GpjjWlGNhAGdTgEjFALUkVLfoVTIVWJPiQ7GJTCXFMQoEdM083J/kIJWLmdLfqlWkipICOCRQSDTuvWrwMQnuJCZY/gEF2gedAlA/4x6nt9Yf2g9mpyjxMUrMDr9GQmDMV/u/W+ueEjgC5g3CxZmz9R2PC7g9c3zUWImvmYOvqgRtS/W2VG/TfZvuf4x035bqbey2sfvXjN1vKNV9NXR3qQ4DHl2qw9huj1W11Ft0rv95xU6h4jkg92Y6olo9XtTgVFeAKyFDWUEYgmfwRsFG/cHk0D3gbzduZHwb4OlCrA0dW4VJYPgszzM72ti4AWuBlW67PJPd8glwpb/g4+obY1DRGvSR1bkWHMD2T458o9El/RqJLuzwjog7bZNE6KygdXq+4F7K+Jw+mnEOPQhzZDp40s67E10GFjPoJX6y5ckD0M6KfCDXhUlu/7gsjtAdsqxT372rwXgGnC6JiCJcLQ6DnmHh7VZfORK6SCa45T9YWewDDhuw14IbPKNIT8G8+Pnj+Us2xXKTwr2wWOkKif0BBMwJuAjB2X75RAhOogxjdDGdEeP7jWduMHzYJAGB2Sd1JgS7PPJKeA84fwrATCrFSYKwAGddvSitE4trkWAK7C40iY4nY7UBGtrgjXkvKd1RXyCVe3gbrnY/qZAdSEQhiWkbx3gRqc1jl1kpF6/J9VQm/lZSCx21kKjZl0tcONVeRu4Z7ghiGEnwxJK2nry4oxfW6GETBVeQ6jIPqAnPR/NJqai02pP5aNALkV6Tj0/q40xCLm1OYw66mIVUmMTsiEUzra34O2PoOhgGl9MCoujJbH3BRUOKiHDQq7EUuiVDGUJlSPwdQ2Ao50x8jJmZChPt9kgoJH8hy0LM/wJ9c8x+achMly8hgeLIWEf2yTzjgiEuGDoMsJ5/l5/QsSC2UQbCAecAbxb2JyTwjNZwz9Fai+pEfoPmYGqIgFWiYrOR+zJaAJz/xOgGjq7GAAxjYV09O4Znlz0tTFINZZVbAssaXOU30ZAbl/Tm+K1+2MR8+WeTFyXeX+ycfFDJ/LlR+g4k+fPg7ndCvBZpfkSk8aUu7kDWTuIelk3J0rsLlt430DiAWh0drZ8c9Yc+qzOf9xzZrE5s1g9c1s5bLg4+1s89PnxksTqx2DxCeM/57NrxvvsOT3cCDFIylu+k6tDw2le5q/ufuEE/E/AX7hLCUS8CnR71rlT71QllCc8RCwgLo5kUtHOSCRAKKuYOxqNOCb8yoxE0oT8mQlM6PWfA0Bx6XZkAPdrbL1fmBDOuHMdowO+28E+aaAhk6MRFl33E92qADxhsZPEZZ7j3WfuO9gyseoLhwA7KEIFSNU0Lhedbge0iZRwC8YE4iqWNCgf30NcqUepCU8FczSqxDwMURehSS2dS+2GCm/LQ79fC5YG1IFqs35EH1aMV/ctVFoKcioTiGcc1m52HaEOMhjORZHSMGtiCxri2wruj8xWKQEz5n4G0mW74SXYDxwIRbCqd+2x2+91eSE0WHnLWNocIqRG/cG84aRwxrV5+0/DEm8XPEU94S41Pt9gnbWS4v4fsFK5vc53yZbCuU4apIxnjywBmwDuOurnBjSDsHW/xMvCAuwyXV4u2kNpp0C1+hpifAEaKe4R5cerfafCSPfRanLVSlHuZar7Yxgjg468Cdz+A+dsrGOW2p4g1d8P/HhKez6miKSeu/NCDvbOb4ba87h17VduGOLlAvxn7F+2kbkPF8C9wEf+Ogk/wD77ozHktDKLrN0G5PYkoSmTLynFd4eQ/gAVg2H8AxaNqsQ== +sidebar_class_name: "put api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Update Non-Employee Record

+ + + + + +This request will update a non-employee record. + +## Request + +

Path Parameters

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. + +
+ +An updated non-employee record. + +
Schema
    data object
    + +Attribute blob/bag for a non-employee. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/update-password-sync-group.api.mdx b/docs/api/beta/update-password-sync-group.api.mdx new file mode 100644 index 000000000..eb9d2217b --- /dev/null +++ b/docs/api/beta/update-password-sync-group.api.mdx @@ -0,0 +1,95 @@ +--- +id: update-password-sync-group +sidebar_label: Update Password Sync Group by ID +hide_title: true +hide_table_of_contents: true +api: eJztXGtv2zgW/SuE9sO0ReT4FSfxl4XbtIMM0jabBwpsGuzQEm1zRia1otTUE+S/77kkJVu206SdYKdTCDMoHIm8vM/Dc2nJt4FORcZzqdVxHAyDIo15Lk65MTc6i88XKvo500Ua7AQ5n5pgeBWU9xjdZPauCa53gliYKJMpSYKci5k0bHR6zJxAw/KZYCYVkZxIEbO0FGJIyJSEtNiI5fp3odiNzGfs/dnP/xkdvT1+x3iRz3Qm8wWDyEz8t5AZJOSaRTxJINct1IKKRkQFDYSat8GlEdkrrXLxOR9BAqkuYzUsVw5p5dCuHM654lMxFyof3mC+CK7vYFDKMz4XuciMlSfJrJRD0k6gcAN/yZgWjWZizoPhbZAvUrpq8kyqaXC3E5TKBsM8K8SmiwQ7PmJ6ss0bZJ9zHRkmPvN5mpDwwcFBZzLodcLeON4L+91OLzyM9vfCA9Hei6Ke6O3FcUDa09rC5C91vCDd1lWJyDMqp1s8TRMZ2RTY/c2QarebRunxbyLKoUqaUcLkUhi6Cw9sGL5up7PRxr8y7xtsKr1+uyb+Ha5uXWBdq+WCW1KYdWiFMhCnGh5ZHH+VcVUQUzu5tmA3OuwctA/i/X5/zNuRaHf2+4PJYW886Lb7e227ttFFFonj2KwsyrOMLzbWPJEmr6WNy1+kjxVhkFUGk5DIc7M1LyvFrkrN+oNBe9LfiwftzmDQ2Y85P+x22nsHfcj58pB2G9WCfMoEcvURDqOsp7RmXKGIJWJnK3gl82+4YaW4nWCiszlHngY0KaQJdc+2u72w3Qs7g4t2f9hu4/9/U4EWScLHNILSHfrNdWyR56kUTDhiUAl9IjWhZy7zWoouEXg1bq7wHlc4FVpty/pusC3pH87XWro+VRbd3VnMNKlWxsFLF9c3Cv5MTEQmVCQII2uVt7KZBA3ENRDXQFwDcd8hxPW3odqrRAKs2Oss0xkL2ZnIi0wh4aUrPU/n2Bh8jniwVJ94IuMnxLlY5Fwmr3QsHk6gN1IJcGcuSUNhVY4wkUHiJxljBvImQ45ZkSV62HF1NgtPtDrsJY9hr7PvlTeG8iTj0e+Q9RiMulQS81k5hcmYIV3vW1bsCz4etA+7/cmgz3n3oN/Z3xsfTniv1z7cOzyk1efCGCDOw1D1s1AikxFLNPoR+QccgsKG760CdvEtQHVPDKyMR/ifCtiNrcz0+jLqd3YYZy9fnbL+PopYTQt7nU/XnKDCy/NtOOIEv8/kVKptqghVzKkijl6/GV2eXODK2et/Xb4+xyeStdEKjhSyNaa0hKrIhZm+sRp7AwhqjEjgDhG32Asv9QUM4sqsDpS+iVwYOBO5NeFFkmOGX33LjFXRbJLpea2UItccsmeyJVo7bEzXAHDRjI25wQSEkIa/GEWRSPPwxHvyBZsJHovsORrWOJZkJE8YqhFCMX8BQYzHMZWuEzApUMrCdrW6yJnSuYzWurqlK+vRWILlyWpQqDig+cN5MoryAspZM1ersMoWr6KPD3R2nqtrd7HiNOvShcp5BCvQfy/gxiyDh9kYtsncMA9HFC4D4FHluAqxVvcAC3dvnTJHubb3Il6YR9TdaQL4Ca1p1Y1PwhefIW7o0MhGowyTRyRPHO1kP6oKV1n4DNteEje129RuU7uPrN31m2e+l/N3LfXpbFKfS+WP+Gjz3KA+mc0epctzwD8svfGB3GFwiKdIv3y48AeIGC8+p3Tc9YT8yG3lG8qPqni462OiH1WwarEgBa0fnQUTIJGIh1bvpcbWUc5Vvc3V3uhsLJGgagtFBGpmbKELxuGyrFCKNOFmh8VaGPVTzmYc+MhREcY4BKRVVRymWqq8YZINk2x2o2Y3+nF2o4ZJNrXb1O7fs3a/yCQrrWy1eJ5kivmcZwuXaf4+WcsZBrDyWwVWlZwN1TpbIWGs4lhBnTkE425n3JnsR6If83486B1OutGgy/f2O/udcb+7H6zu9VfLOq6KrF5TK/F2cbQuBon7BB5XKCSXybWO68d/cG8mJgRrBD0Vb4bP4dLrJXfsb/kWQeewDYLBHbN7jhcvz05IPpa24slv9hCUaLZzHYbz3FJKymF4Wpq8oY4NdWy2n2b7+WG2n4Y6NrXb1O7fs3a/ijr2H6KO/a+gjn1GFGtCFOuvpI4xeAdRswmCAhuiAu5VRBtTmIJP/vTRl33Os6nIK6JXY5Hdw00WeaE1e8vVoiRLpnYSqZbuInjD2DmNzcqxGMDZFBCpGFBLgt1SVtETCOCk9ERCIufS1jEZBLnZIhxNcljlaqbMt2oVqaKkgIYWFBJNZ68aOSaRTmJC9A8S7DnoFED9hGecPlp/6jyYnZHFJ2Qxe/05EoJqvjr/3dv2lMAxlM8ILs5drO95XMCdmXOFNkJ8Th18VRS0oeoNVW+2+2a7/zG2+4aqN7Xb1O7fs3a/gqp7NnQ/VceAR1N1jG21WcWl3lBy/d8Zuy0Vr4FNb6Yjy9XjJQe3vAKpRAqlhcUQegFpGOxueY3J7N7K+C6g16CIGzq1iizB8Fmep2a4u3uLaCFKdy2eyhZADAHLF0rftCI93x3DRVvQhx42dZVGA+w7XW6BlvVvJimFHd5Z4c7b1iJKVnjdPl/wRcnKP+C+QA/CnJgdhnT36WQvQ8UUvcRPxo5u2fTZsA92XWbJ3Z+3xQm6x5Zt7vviahjPoOmaiWTC9fKttXMi3m71jXfXlpsJHfl3NxZ7T8O67KXgGboC9xTMs18+XDxnU6KbttwLQ0xXSOoPUDCnSBELZ6PyiRCaZHcYZNN0ZhUf1Z65ofJhkwQGs4/qXAh2deyd8A44fwZgti6lScJiAc26flZGJxafREJbYGvpSUo8GatdeGiX1+Y9t9ud7Qukcs+e42rrowrZkSQUkrRt0xhvom3z2FVa2sVX7PpWJf5RSgudtNBKM8/XtHCuvYrcM9wRaphE8MRYb33z4k5euCKPmihcIanrOpAnvB71J6WiMmrfrEdNXkjy6np8VB9mEntpfRpz0MUMtsIkZscsmmltxD8Zo9ShMriaFqiib1brhhYNbUWE3faKSqFbMpQhmKHV7wSFoVwy8THtzJaYaHdGYkvyVxtZ1Pyv9q2IX2s228tX2EBpZKwj880604IhLRg6DDBef7c/UWKhtskGiwMuAV4t42+RwCu6gntO1lZUt+J37RzaGiKoaqWYdOj+GC4Bzn9i9gaNrsYAholYV8+O0Zu3XhZtUjVnlUcC6x7c1DfR2BvX/Ob0rb7YpP3ye7OXLB4tT07eq2Tx1Ch9D5J8P7j7FyFegzQ/ItJ4qksnkGfL19ZfP/mrYJ3g+3kVbOV9wvtenVu+0Ld9BFxGFWoj5duoVVx46Snu5uEnnc7PBP7FXQtvthFBm+d+eoGI36qgNOE5AYEFwmgmhT02SaE90eUdKkY9t+CVZpoQE82xFTS1FmaIMkejKxPIswf75crcYozj4lQK9Lcp/GMmGlWMNly02Ad0sipCBKiLpQecce837dvZcyTzKdUCOyrrAzx1Pi8U/WIE1C7mjKMKHyiiWJqocFiPplaJ0hfasuVqVgl8VJ1kQsv2c9ncvJ/QiTya/ZVaeWAtlIrxx/FwPUXRp+7SkDOR2GKmcfVO5yHZKNBwJhL7TiUSHZxVrKzw9vhiQyKEKf8dkM6mu36S2aWxEEIdpUufXqvTaoe2w6L3ibXJ0fmvCL+0P1vBthXgeMGOj9bz8Xb5jcRf87MhftOmbms3pVNCsqtw3Z/rt6+Cbf02pg6BTCjlGZxAo25v6TiJOtA7ugwoo7OKq+tlc2mbcgSJPqOwJ0Da9R8GWfXHszOv+HP7hdgjfy5kq0Hl4ahaLM9FAnz8XdBxiqRfDcEod95ltXQ3/Bcs4cXCUqRy4sY3R9SMuxnuDO2LY69XzjVOLykXx/53SubuhCbjN7hI/w6Dj/gPf+jUVQIG2eu3QXneiTFObElFtzEx/wHBwLD/ASMcYnQ= +sidebar_class_name: "put api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/update-provisioning-policies-in-bulk.api.mdx b/docs/api/beta/update-provisioning-policies-in-bulk.api.mdx new file mode 100644 index 000000000..76132cfd3 --- /dev/null +++ b/docs/api/beta/update-provisioning-policies-in-bulk.api.mdx @@ -0,0 +1,96 @@ +--- +id: update-provisioning-policies-in-bulk +sidebar_label: Bulk Update Provisioning Policies +hide_title: true +hide_table_of_contents: true +api: eJztXHtv2zgS/yqEboE+EDuJmzRN/jm4idv1XprknOSKRVLs0hJtcyuROlJq6g3y3W9mSL1s59G0uN0WQoFUlsjhzHBm+Bu+rgOdCsMzqdUwCvaCPI14Jk6M/iQtvJNqeqJjGUphh+p1Hn8M1oKMT22wdxGc6tyEwgYf1oJI2NDIFKkAjbOZtEyoqJNqqTLmSFrGWSxtxvSEpTXyLPX0mVYsmwlmUxHKiRQRs9QAk4oNI6Eymc2P9FX3UvVZpj8Kxa5kNmP9k+Ea04Ydj97+1j94NzxiPM9m2kBpBmwY8d9cGiCWaRbyOIYm4C1U6oIkVoQ5FgRproNzK8y+Vpn4nPWBAkooI7VX57VDvM73Eq74VAQfbkD0lBueiEwYS1QkKiDlUH8tUPABfjkxQLtrQcFNsJeZXAAD4UwkPNi7DrJ5SmUzA+0EN8sqFezUqyNC1sVnnqQxVumFu5uvNl692I42dzf5q5cbm9tR79XW9vZ4i/de9HYD5BIbFjZ7raM5trbIR4hyqww/8TQFGckg1v+w2Pj1MpvcGD4HLmQmElt7r8d/iDBrCHrh1ICaMmhqGXQ11nDKWRR8UW40iGVrmTOqXdeCf1pZeALmIRUPM/kJ1UemhFwsavkhzNTeoCXfwl+DNbK4VXyFRjjHCMGNLBtzC3YKdLkquJyzqcYKBffIcm7B9s6I0WWGVR7HfIzNTnhsoWeFyhPshP3RoH82gBLnJwfuYXDUf32IDwfD0+JpcDigb/3T0+HbIyx9VD46Cr+9HR2fn5R0yp+uavlzNHg7PD0bjKp6w4PB0dnw7Neqau3N4GB4VlE+Ojze/xfW/Ll/9Hbw2wmw8P54dIA2VGm1FGjZUVApq8PMnJH2uuxSDRtRZQ2ikw83Iajf5mmqTcY+cSN1vtB7ZcC0XfYGTMvztMauZhCUOPsDukwYDD48ilzkKYivufCT8DmDHptOodhYQxBzwkDHR8wp5/YW2YCHMyeGExTogftasBgMc3yV1FCrXxdvxsERuAI3ypMx8OAM2a4yZQzMkZiARBFq7YyKcSPI8kOdJGCvFTN2D8p4YTqMxoEap0bEZO+gkCf7ZPusH4Y6hzECBpyJjMWTtWWPghCTYj1yY/zKfR0gMxbeiaKFriA1X+k8jrBMjo6F1cvOQS/zGgHlXCqv9bt5PqeB7FE8+7pPsKsUhEh4fasZ3cY7sJyB1YxzoGvnKmwIcamcP98jwkBhdPgGahdEaKXawwepHZ5DZ0Xu2xNbtoA0il69VD483SPYgbTfSLLIUXqAaN7fYwHuZBzYSPQn9HhoQRuIHTEMPkYnNVu7VL/qnJwQSHivm8C3uhM5nQFWmeOHlcOfEBGYDYIxmVE4PC9HBRgiAD3Fkf2S8foxYzOGWixZjIOldTbxCchpjpAgMJYZrixIl6ziYUUgL4pTDAVgMscHbIskrDdTkjN5jMigZKYmUOCDzrmSgIbY4UH/hPWLcsENwYEJz2PEQfirSeNudks6NchZ2FcldZNhb4dQ+6friTQ2QzZvuj9dx9w//3SdE6/7aJ/C3ACBMNZ59I5/dkLsz0T4EdgLtjdq307ln4QMy3ejEo4FCPhIVmmrt6V0Y63BnBUhOB4dq3heQMSmuG9ijqgkIqQIdgmuAJIaBOJKZ01zqMPwblBTcgFRCpXQb7SSW8DN7SP9HeZXIWpp30Gz8j88zm+R+etkTJB65xORf4CcN5XzvkFrPhAZl7E9yDR0T+3jUi4290WwkBE2hRHEWWhvYwP/WzDMMutChlcSY1fcAuQhFDoBADmH7gLLDJ0YbW7Q5gZtbtDmBm1u0OYGbW7Q5gZtbtDmBm1u8B3kBlur0oH9WAKwYQNjgNUOG4ksNzB+M+kU5dcJAHlEtHwiFfAsH5UH3BI/IhJlX0cP6MY3EPw7U8MRYTBBLIdQ0YW9CPWeaIO4G0kWfU3lmv0Mmuhustc8YiMv374XxsWd8CPQGkb3M+SjQ1EFoHjpyCuaFTuCj19u7Pa2Ji+3OO+92trc2R7vTviLFxu727u72HoC6B6i86qA3Gz6rYCBUIYs1iH0yJ+gEPBC0D0xQI0/PIYTjQe6kStbiun5ZbhMhsD49f4J29phMVfTnN7z6YISVOf8tJF9YMwAyR3hY4C6cmV+VWQnB4M3/fPDM0oc/n0+OIUnpLW06thXhUNqQq0zfUUcewEoxxUxqAOH7+ee6nMQCAJwvaB0v+zcgjKZd1So4VtfUaNO2o3pdVcK3Zoieyq7orsGAAHeJTwDoF4mdVj8OaATkWadQ6/J52wGUVaYZ13WjyKJQvKYUQRxSQIgDZdDSEdgkoMrC1oU1XmGYUiGC/GuUmWzN6qAcljvFHQO4Px+O+mHWQ7MkZh1LyytxbPo+wd4dpprcndWUxqpdK4yTG1x2RYSYm0MaJhBRGUys8yHI+wuC4FHFeXKiFWPkxTu3jlmXISEeMZz+wC/O4kh/HRItPLDJ+Gdj/Cli0bUG0U3+YjkAQlV9qXK7iocv4Qrre+2vtv67kN8d/HjyE+CFtgHoc/mMvQ5V35nCA6eS9DHkPUoXWwf+ZPgje9I2mHiIdIv78/8/hPc5fI5LaDrN8JHbihfMY1b9Id7P6ZsteisRl8gg6RHJ8EEIpGI9ojvimMHEklVL5Zbg+x2LMFA1QqIiDkbZp8002NyRbknt2ss0sKqJ5mfQXLzlhQB67uBWiTZIsl2NGpHox9nNGqRZOu7re9+n757J5IsuSJv8TjJ5knCzdxZWrGwDNJyBgVYsRzPSpejrlpEK0iMlRgraCKHYNzbHG9OdkKxFfGt6OWL3UkvfNnj2zubO5vjrd5OUB/rLyo/Lp2s6VO1/nb9SCoGEIcLE7kC47KZ1lFz+g/Ua8QEwxpNrxe4GXQOKv1QYcetZex4pDOQDQgDdjS3TC+ejw6RPjTtVkBBb37hx3jVQXGeEaSkCVXxWdqshY4tdGyHn3b4+WGGnxY6tr7b+u736btfBB237oOOW18AHbcYQqwJQqy/EjpGgDsQmk2gU0CGMAf1KoSNKYgCT372sdjnwM1UZCXQa6DI3u4yijzTmr3DbWgeLNnGTKSq1IXhDcomWNYUZSXuvZlCiFQMopYEdItWJROBmBS3ecQykeTHKBDQNfNOf5KBVM5nCnsrW5EqjHPgkIJCrHHuFbfNSjAnMUH4BxRoHnQKgfobznH63vqq+WA2QokPUWI2+BwKgT5fzv9ur9olMMQdJRguTl1f37JdwM2Z434lJT6nLnyVELSF6i1Ub4f7drj/MYb7Fqq3vtv67vfpu18A1T0auh2qQ4EHQ3Uo291gJZZ6Qzs+/9+InVzFc0DmzXRIWD2qMDjhCjAlZCjVNNFKV1jsBesOrtv16+IWi5v15RsxINSsj/P4Y8dd9RHgzRqIGx3LuYmB0izLUru3vn4NPQk9eNPlqewWR5mUvuqGOlkfg/pWRCbciOq8EAvg7R0+CemS7o1E83axkIi7nvA7bAMLPUJ7D+6kXOxWp331jswa7iH2pkavgcUU8ownlkp3ybSW5AO5zk188/WyOEK3yLJKfXe2BuUZcLogIorwoboI5RRBuWt96TqUaqDB5YDeUmPHWKzHXgtuIGNwO2Se/vL+7BmbIhSlUJBbRMFCYu4AznQCJkKhrl/sFsFKNPoYnU9nxHi/sR8HXYtNYhCYXapTIdhF7aQWG0HQJpViJUFxAmt9eFr0TiQ+iRiHx26lSTQ8Gal10NA6b9R7RkMh5QxS4SZ9etu9VB12IDFC4QkdKuNFpBSQXaSFXLwm12OZ+EdBreOodYiafbbAhVPtRej2d4fg30iCx5a09ejGHb1OjR4mWPAGqS7ygJrwfDR3UYVFrz2ajwa9DtJr8nGp3s8kjLPNasyFNWZndDhnyMKZ1lb8kzE0HXSDi2kOXvRotq6w0Q55RKe3UWOp45rsyA6gRuLvEBxDOWPiYxy1CbRoN39CLvk79Sz4/O902u/3hsz0+gIGVywZ6dA+mmdssIMNdlwMsJ5/N3ahYYFvowwUB5wB7Ff9T5HAM1qLe47WyqhO5NepDg4NIbBKVGy6537sVQHOPzH6gKXLMhCGEXSX+8rwEJSnRQdy6soqpgsWNbjMb6xh3FzQm+O3XPTEsfTvJi9K3K9mVfAwzreO0rdEkr9P3P2LIl4baX7ESONhMM5Ojqq70gZFwnJRnhN8zGUCy5cFfLtT/41D/9XJ9+KYZ8V4edZy9VHLrzobuXAa8i88vLi2lL4uHO1zB+zo6j6MLcSvTw7rEe21B+fLU7rl0Vz4SoGZ0ivoDXcfIULWOiHURHlMNZxJQZNBKSgUgf4ahhGdUNgFg8Beh+4nQlNSugH75JC+yxjo0XJF0TKn6OiyCHRi/G1zv3lGQ/zhCm8zeI/nsUPwQczNcds2fMNT1cToKbjhCV3SeFB4NiDsJIHOycic84RxiB/3uH8kbZi7UcqfYXciaML5Za0iZGNcQRG6lKWaxB5PcJ1BhqLm5fe0BU5u/SIDqL5mq5UgIzwCjiMF+kgjgtxHG0JLZybiFM0J/BLQtqi18G54tkQRiCm/sqXNdN1XsutYFohgLuzM50V3s7vRodwQ3mOynXBVI453bDJ/mUD9dCcrruFcNMjraqHl+7l40/soJpfrKU6Y0uUlLtl1Mw8X/tpMlHevdoPmyskHeF+ffgDXnuEsBhC5vsYYivn4Db6GwIKzOhcfqlSbQmRxrr88j3urip8WEecZLR027uRcKVUxWazm1TxRAI8fBU4vlZJBRAKuaRaQOHKf/bJTh6J7VX1pPQ2nIVwNN7N4Z9kPtdmek2OcYw3G/l7QxE1cGX4FL/HvXnAJ/+CHTp0rQSF6fx0U08BQxtEtUPgqEOofQPNQ7H8nyDox +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Body

arrayrequired
  • Array [
    • fields object[]
  • Array [
  • ]
  • ]
+ +A list of the ProvisioningPolicyDto was successfully replaced. + +
Schema
  • Array [
    • fields object[]
  • Array [
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/update-provisioning-policy.api.mdx b/docs/api/beta/update-provisioning-policy.api.mdx new file mode 100644 index 000000000..a0d794a41 --- /dev/null +++ b/docs/api/beta/update-provisioning-policy.api.mdx @@ -0,0 +1,122 @@ +--- +id: update-provisioning-policy +sidebar_label: Partial update of Provisioning Policy +hide_title: true +hide_table_of_contents: true +api: eJztXHtz2zgO/yoc3c70cX7k2Tb558ZN3G56aZJzkuvsJJ1dWqJtbmVSJ0pNvZl89wNAUg9beTTbud3tqZ1pZYkEARAAf4AoXgc6ESnPpFYHUbAb5EnEM3GS6s/SwD2ppic6luEi6AQZn5pg9yI41XkaChN87ASRMGEqE+wNfc9m0rDByQEzIhZhJj+LeMEsQcO4YuKLNBlQZFXyzNJnucEfnL07PT464Vk4YwlfxJpHvUt1lnJlJjqdGxYCnbGA1iJiUrFsJlhSpZZYaplmYSpgYKCoxBXjWZbKcQ6/sxnP2ELnTCvgTgmgE+Upda3QgUFHYiJSJHRRGR6GXGVeCvPx6SzLErPb70cCxEad9gyXcaKlynqhnvdlpPqRDk0/K6j1p7kEDVbudKXqVtnoJo7+MwbP2VynAljApjRjwOUAOPwkFLuS2Qx132HHo7c/D/bfHxx12Onx+Whv6H8BAXfj9Pw13WM8z2Y6ldmCwcyl4j+5TEEfqDwex6AqO589mHwjwhwbggFcB+dGpHtaZeJLNgAKaBQg3u4q54tdO/3BxxuwloSnfC4ykRqiItFmEg79O4GCB/DLkGmBIXYCz02wm6W5AAbCmZjzYPc6yBYJtc1w1oKbVSsUzJookxGyLr7weRJjl41wZ/3V2qvN7Wh9Z52/erG2vh1tvNra3h5v8Y3NjR0g1shWbvhUnOGwq3ytDo78MT1ptEui1GOX6kCxg0ioDFR6pK86YKZWdjJwkyeJTjP2madS56ZOqfBX02NvYE6deB12NQM74OxXMDkwXJg6HkV2Nj3xjp3SOQcHSeV0Cs3GGuxmbzQcnA3BRSN2frKPl7eOyIYcXJPEsIICvRCegCGj6fAmqaHXoCrejH8Gv1Tgffl8DDyArsCPTZMng+mzSExAogi1dkbNeCrI8cGt5lpVmDG70MYJ02UUjiqcpiKmSAQKebJng8MgDHWuMvTpiYzFk85qQMkEaBfbogPiU+76ABkIRDbKREtTQWq+0nkcFcEKuxeTo1UxJ6CcS+W0fjfP5+RKj+LZ9X2CU6UgNMPtW83oNt5VJYiahQprQlyq4dHg9eF9IgwVH8ffQu2CCDWqPXyQ2uE6tFZknz0xxQhIw8/qpdo/OH2AYPvSfCPJIkvpAaI5f48FuFNqA/hcf0aPhxF0CrEDFrhJqucVW7tUP8HSh04IJJzXTeBZ1YmsziD+L/BBUxTDVRPMphZbrdsFtwdqiKZ5HKNswe6ExwZip4AAgItH0df6AVxYa4ILp368Gh4O6dng9PTg7RG2PiouLYWf346Oz08KOsVP27X4ORq+PTg9G47Kfgf7w6Ozg7Ofyq6VO8P9g7OS8tHh8d4/seePg6O3w59PgIUPx6N9REMNymhXh3Z1aFeHdnX4/1wdIH5RODwv8PMN5gEIoYXJXutogcvE/Yh6JSe0IoJKbHpBirLrDgL+EFMTlSFtniTAE1ly/1ejIbtCMn/HS3y8slbxNOWY60rQkqnc1+NfwTFWAvqgwtqxdxnGi6jExgt2MXqzx17srG2AkWBrRs3LhDHTOjY9KbJJT6fT/iybx/10EmKPZ7V84wJS9aBjUxPMplJ00gxiIPIJjxpW3FVVFo7tDAp+YjopMOXyyzGsDDQw2gtdgEWGeOVuhDqhegDMYX3Z8y1vHJf3cgSBnx44xWCyDMYKZFIwPUW1ApzajKdTkTGkSQuWYiIWc1F4BZ9MYHasurOqkDWE0q+ODSx+5nEuSHdKHE8oJV3mtux8JK5YtX9p3EUeWnRHKWD1rPbfXFsre/jnlS6Fffk2xY2CBBizj7A04y43TWYylgk4VoWat2JPzP6+aSjYCEZacHosYmJNiZ2yMoDPLtE+LgPCA5d+yuF3uWTcqTjgs+DrHbgheUPhO/TYdSYpYazuRIo4InfN53OeLtBwIkQT9AB5R37HYiqVRSSEGFgsDSrQTfOF9RFn3NY8gz5RMP21oGIOTrEQGGSMSvTVmYo5SwfOBn5GoF3j7FgiKFTtMfyWZlR4toPDy9Ynzfs8zuS/kTHfCgLoDf5BtzQJKNsOt7G2hv+tTu9qJW8f9HUFIcrkYSiMmQAo91W66J7o2RgyC0utRioSfyVIWaXcFxRuq+lR76ppuavGxmipUnGqQjI3XcjFcrnoIcxU7njbahiyxhotyE18WexAcAKUz8YcXQ7XDOW5XLCpxg6ee2S5LEC1aVWbVrVpVZtWtWlVm1ZV0qpOYJHM16Qyj1mbMdRiS78OFtZZf9ECcqZHSPCmGT/dkk5RIPfNKYYCAFl4gGdhYA0RO3JpHt+KwFzQOVcSkk52uD84YSVquyE4MOEAsxCVLcO0+7K/om0dIWdVMZYYdnYIvX+4nsjUZMjmTe+H65i76x+uc+J1D+1TpDcIyWKdR+/5FyvE3kyEn4C9YHut8uxU/kavuIp7JbwMMK8mWaugs5BuDAmo4IoQHI+OVbxozsTfxBxRSUSIEOwSXAEkTfG9otJZ3Ryq7xN7QUXJHqJ4lVhQ67HvQ8zPr/R3mF/5anAJQjfI/PtknCP1LqUOD5Gzkvu8QWveFxnkBwYgOSVwxcNG1B5Y3L/VBPX3Yonp8DBNgdMuG4ksT7H+IK2eXMUFgEdEr3qlApbl74P79fARkSR7OnrALL6B2N+dppwqJIJYDqGjjXoRqp1edFuSfqqpXX2aQRO9dfaaR2zk5NtzwtiwE34CWgfR/Qy54OC7ABIv/LhhWPFS8PGLtZ2NrcmLLc43Xm2tv9we70z45ubazvYOvkUO5gDuITg3xeP60G8FrIMyZLEOYUZ+A4WAE4LuiQEa/OEhnGg80Its20JMxy/DV/qIi1/vnbCtlyzmaprTfT5dUoLqnp/Wkg8MGSC5JXwMSFc2plc+OdkfvhmcH55R3vCv8+EpXCGtlRrFQHl/1ARaZ/rKZvdWAMpkabsJrt7PHdXnIBDE32pDaX+ZhQFlMuen0MON3tCjStou6VVXCu3+B/ZU9kSvA/gA7s2pEFjkdNj8OYATkWTdQ6fJ52wGQVakz3psEEUSheSxLcLYHAHLWZRCuN0tkxxcWdD+Dp1nGIVkuBTuSlXWZ6OMJ4fVSUHnAM4fUJ0LsxyYIzGrXlhYi2PRzQ/wbDVX5+6sojRS6UJlmNniFhPIh3WagoYZBFQmM8NcOMLpMhB4lG9XRKxqmKRw994yYwMkxDOemwf43UkM4adLohUPPgvnfAQvbTSi2fDT5CKSwyPU2bUqpss7foFWWt9tfbf13Yf47vLDkStwVqHP+ir0OVduFxsunivQJyXrUdpvdfvNvvywE0l74hxEevfhzG2lg/biS+KR6zfCR3YpX2F+UMyHvT/2rzz80l/OBTJIerQSTCASiWiX+C45JkVZVW2ujgbJ7ViCgaoGiIgpG+2LxEJPmttKOjcdFmlh1JPMFZBs2ZIiII6qoq7d4tgiyRZJtqtRuxp9N6tRiyRb321996/pu3ciyfr+AoeTKjsLlK//o7ScQQPmX7WzwuWKzQJVtILEWIGxgjpyCMYb6+P1yctQbEV8K3qxuTPZCF9s8O2X6y/Xx1sbL4PqWn9R+nHhZHWfqsy3nUdSMYA4fC+RKzAuk2kd1ct/oN5UTDCsUXXd42bQOaj0Y4kdt1ax45HOQDYgDNgxvaW8eD46RPowtH0BCnpz731Spzr7+Q1CSqqn0hdBLXRsoWO7/LTLz3ez/LTQsfXd1nf/mr77VdBx6z7ouPUV0HGLIcSaIMT6I6FjBLgDodkEJgVkCHNQr8rKPdmu+ui3Odid2R7o1VDkxk7DllSt2XvchebAkqlVIlWpLgxv0HaObVPfVuLWmymESIX71iWgW7QqOReISXGXRyznkvwYBQK66aI7mOCWcusz3t6KUaQK4xw4pKAQa6y94uZYCeYkJgj/gALVQacQqL9hjdPN1u+qB7MRSnyIErPhl1AI9Pmi/rvdtEvgADeUYLg4tXN9y3YBWzPH7UpKfEls+CogaAvVW6jeLvftcv99LPctVG99t/Xdv6bvfgVUd2jodqgODR4M1aFtb40VWOoNbfj8XyN2chXHAZk30yFh9ajE4IQrwJSQIfruNSg/fLN43fSv/ZE7N/3Gg4f618W3R7gT2SYJluc8jYGS/4z1GqYSpvCmxxPZ858yKX1Fhx+NQX8NoQl3olo3xAbu6CgcoEfKTyXatw2GRNxOhdthGxTnK91J2e9Wp331lkwH9xA7W6PbwGICicYTQ6177mPKJflArvM0vvn9slhCt8jSpL47R4P2DDhdEhFF+Fie2nSKqNyOvnJ2U7nS4PuAjZXBjrHZBnsteErnYeEWmafvPpw9Y1PEohQL7OFdQmLyAN50AiZCsW7gt4tgJ1p+Up1PZ8T4oLYhB32LTWIQmF2qUyHYReVLLTaCqE0qxU6CAgX2etipW6ChPq/1u/U0rS7blxii8AsdauNEtEeTXSReLl6R67FM/M1T61pqXaJmni1xYVV7EdoN3iE4OJLgsSFtPXpwS69boYcZFtxBqss8oCYcH/VtVKGftUfzUaPXRXp1Pi7Vh5mEhbbejdm4xsyMPs45YOFMayP+wRiaDrrBBZ2t9mi2rnDQLnlEd2OtwlLXDtmVXYCNxN8hOIayxsTHuGwTatG2gEIu+QvNLPj8L/S13y81men2Bayu2BIPiHs0zzhgFwfs2hhgHP928ULDAt9GGSgOWAPYK+efIoFjtBL3LK3GqE7k+9QHl4YQWCUqJtm1P3bLAOeuGD3A1kUbCMOIuouNZfgRlKNFH+RUleXrBcsaXOU31rBwLunN8lu89cTF9M8mL0o8KMsq+DHOt47St0SSP0/c/YMiXhtpvsdI43AwlidH5bEzQ5+x+FMhyjNOPECuH/bhMoHV0ywAZKEpk0guGak60GuHBVdLiMWXoPCU4gDBeUiW7FGeiJCqhPCrweKryHAmBRUfEsEzxJUdtFo9Jy8HGI+hBVJMIjSl7x9TUAeHdFHGQI/K435kTs5oQSvaDP42udusocHcIZkVPfYBP/8NYcoxF8RtwvAMP+IlRk9h1unwFrbvDQkA3XyeKzzOANjO54yDud5jbZE0YW6Dovtk2oqgCVYWvXyEQDNGEXqUFaVzczzBujakzBWjumcssCnjitqg+spno6UgI/ziWNpjTeopwX20wZK7MxEnmI1CRAdwJyojvD84W6EIxJR7k4JnAblOpo9t8cQaEN6az2ZvvbfWpVQED9vRJoP8uUL8hKfoav58JEgOGs7cXTbK67K4357l+x2f5euQBKaA/QTrmnTEiE1Jbfi7cCfxos3vVg7lbZQH25QHlEBAnIE5Io3rayyPYdJ8g7ch+mLt5eJjmQ9TAPYf3xcfzd5qlE/918vP6AVf7ZTfRqF8SVctKjEcLj8JLAIVgmG2/2gu2pNH2pNH2pNH2pNH/i9OHvn6IFuuDDcfobF9I0Jx3z53r+C77nh13/+ugxsxXNvO9oXLHd0IoBdF8JPB2d6P0HrsTp6c24J+yq/gJv67G1zCX/ihEwv5oBHdvw786zFoYwn74kRTbu4uYK2DZv8FAs8Vkg== +sidebar_class_name: "patch api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Body

arrayrequired
+ +The JSONPatch payload used to update the schema. + +
  • Array [
    • value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    oneOf
    + +string + +
    + +integer + +
  • Array [
    • anyOf
    + +string + +
    + +integer + +
  • ]
  • ]
+ +The ProvisioningPolicyDto was successfully updated. + +
Schema
    fields object[]
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/update-public-identity-config.api.mdx b/docs/api/beta/update-public-identity-config.api.mdx new file mode 100644 index 000000000..5bbf6b2fa --- /dev/null +++ b/docs/api/beta/update-public-identity-config.api.mdx @@ -0,0 +1,91 @@ +--- +id: update-public-identity-config +sidebar_label: Update Public Identity Config +hide_title: true +hide_table_of_contents: true +api: eJztW21z2zYS/isY3Yc2GVOWFceO/eWGkWVXrWLp9JJMz/G4EAlJaCiQB5JxdJ7893sWAClK8tulnbu2o3bGEcnFYnex++wuCN7V4kRonslYdcLaaS1PQp6Jfj6JZNAJhcpktmzFaipntb1axmdp7fSqZh8z91yKlDmS671aKNJAy4QYgt1oLlNmeaYsmwsWiozLKGXxlCWWi3SzsMDwqGMeLf6VizR7G4fL2umduZRaQLxM52KvBsIMY+gRTxLwMOLv/5rSlHe1NJiLBadf2TIRECKe/CqCrLYp29lKlDxhWcxeFxotGc8yLSe5lZpn7FZGEZsIJ3MEgiAQaSonkWDTWDOOxxVzgBlXy1gJJpVRO9Zkv0STsYnCyF7OUZGVa82XIJWZWKRP6zBORUizLXiCGVdis09iaQVTK6VAJ7OUhTJNIr5kii9EfUsqDKxMm4Kfmm1NSyrRDDAd/SynBaH4whdJRGODOFeZXta+7tVoqudxrQr3OPtWwR78oZ65t+63fjHOeSdRLuJQTqUI3y7vM67Ko4hPiJX1tE1nFjC04jOhjW1JtsJ7tw1peW/rLFS+oCDyW63e+HJ00+oNBu2uP+r0LvH78rxzASI8bA+HN/1B77zTba9uDNr/GLeHoxu/j0fv/a59QnzoV7/f7bQMJ1y1/Hd9v3NR/XkDZqP2gO60B6POeYW4Ox66J73Ly3Zr1BvcDFs/tN/5uNW+HHVG3fa7tpnlove+Pbj0L1vtm4tBb9zHrc6ZIfm58rMiennLCY9b3c55u/Vzq9u+GY78ERH1/eHwQ29wdtPvQQfiNOiZ0YOx+WfYqzwa9saDFt0d+Rf27w00aV/0Bj+by+FPmGs47tJUg3a/NxitronR+06vW2heLIPfGnXeWx0gx09WtS088xWj9XOIWTgoLbHBkbNRL2VpniSxzhCYtzKbOwAofPIyvgUmTDWHP+RBlmsTgiuvrpiycOqzLB6RD8F7Zfh0FJXhDuIq52ZwcvCmwQ+PppyHQhw2Do6mk0PROHgTNBtHr06eH6c/5IgCTwseUqxshWw1JFbTj+bxgqesDWowqQZtIfBATIUWKjCaFnH6TNRAftnP5Aoy7HCbGDAC0brgSBg1IvSIcN00MILXOPKar0fNxmmzedp8Uz9oHP5zCxEexpoSYohEizSJVWpxoNlo0D/rQg9shoOvII+IUIRkrF1e2+W1XV7b5bVdXtvltT9kXju8L5W1IglS1tYa0OGxgcDiKziJtBK7Xo5N0MwxNINSfeaR/G35bh2QbEvZisNnLPG5VMKbaS5JQmFEDjCQgeNnGWIELKyLLrUwuqFbX3VYon7A3vKQFZm85ZQhS2oefAKvzjNWeawkxrNiCJyshOB7phXHgk+OGifNw+nRIefNN4cHx68nJ1P+6lXj5PWJ8fUF8jeg/L7kuz71hVBCowGP4gAr8m8YBK4P2xsBzOSP5ev1NTA8nmF/SjWWtlTTycsy8SXbY5y9bfXZ4TGLuJrl5j6fbRhBeePhtgvvOSF6Ws6keixDnbXP/QJEHXITr/tAUaqQ3BKiwhfmwLhspcAtwj4VEcyB8o29dFxfQiGu0iqhtFfpMoUx4VtTnkcZRrjZ7xlRZc2mOl6shZKJmy8Z+17WRX0P5RvuAQaCOZtwqptiC80vfdRySeZ1nSVfsjmgTegXdeaHoSQlecQQjWCK8UuqA3kYUuhaBtOccNygfZxnTMWZDDZgfWXKzRKjgJNudVEoOCD5037iI4VAOKNmNQpLb3EiuvWBzNZym9i8Mpox6VJlPIAWKGtpv0lrWJihkjL1o4MjWq4UwKMKuhKxqihp4O6dFQaJzDwLeJ4+I+76EeDHM6qVDz4LF3ymxrZoZFajWCaHSHhoEjMNdlTlchWBz5BfonAXu7vY3cXuM2N38+HANfDuqSl9DrZLn7HiOeyrTfLcKn208R6FltkR2draLuQeWueiRPrxwwiB/UkoohdfEtrr/h3rI5vKt4T3y/Ww9ydUfpSLtbYWJKCxo9VgCiQS4amReyWxMZQ11avt2c5jPZFwUHVPiQjU1GwZ54zDZDpXiiTh6R4LY5Gq7zI258BHuzNhEZBmVaGXxFJlu0pyV0nustEuG/11stGuktzF7i52/5yx+2glWUplosXVSWm+WHC9dJuw9jlpyxkIWPEqiZUhZ5Zqs1ohZqyssWrrlUNt0jyYHEyPA3EY8sPw6NXJtBkcNfnr44Pjg8lh87hWzfVXqzgug2w9pirrbdfRmBhF3GfUcbmCc6VZHIfr238wrxZTgjXzFqmom2FzmPS6rB2bJ9u14yiO2TuulkWFlK7VkGplI8K0mF4agVYXtCDgbAZcVAxQJSEXuRLtqXpMw2lYJBfSBC9pAb566fnTDKrYQCmcrJxFqiDKIaFBgiimqjmGY0koKaZU84GDqWBnQOffsTp1S/SbKnk2II27pDFrf7GvHllZub++b3+3A+E1YcTQLvADG7222+EKDoCGwGJWWXfu6vNdfb7L8bsc/9fI8bv6fBe7u9j9c8buf1Gfu2ro4focBM+uz0Fbb7Cyljon5/qfl+kmVJwExr1ZHAS5NtvNRQ1u6gq4EgmU5AZDeDbHxb49I+bJ8jiYFxQHw23tb6XKdQTqeZYl6en+/h0WC4v0tc4TWS9OUKj4th7Ei/0JLHQP+NApARtoRMD8fsc1F3VjXi3Jgy3cGebW2EYh8lUY3WwMP8q5ONSxjHMAnGGzR+ddnDeZ2xAxQSvxXeqOlJFxtvSDXmMdff3tulhGD+hyn/kenQ30DJJuqEgqXNNyYdXByKzXGPK0LFb5Oa301XWVZki1uZVwi3KVb6ifa24J1COyJnsruEbjYF9xfP/jh9ELNqOK1CBCnlIxLCS1EIipPtzIIJ5fbPfTIJOEdJzP5kY5f+2FCkUYm0YwCvuohkKwq+qhpAGw25idBgkDFzTq+vtiBUPxWUSUJesra5NzylDtw4r7fG3cC5MRTesglT1+g7v1j8pjZ5KASlJmJxqnoukE2VVS6MUren2rEH8ruHmWm2e4pS82pLCmvQrsAZ0AYU4seJQaa33z5JafV+FHfRbuENdNGcgSTo7112BBsWrfLMcaP4/4rcvxUX2YS6Tb9WHMohtLkS2jkHVYMI/jVPydMXIdCpWrWY5I+2axbmlSz0SE12xURPLslJ70UDwa+boIDGWdiU8oeZvaJUZZp0Ibtr+YlQUu/ILWOmS/rOlsbl8hxxJlGAfpN8tME3o0oWdxInXyu691ICwdNoMOBgesA7RW62+QwAlawUbL617kN+z3zRhKHwFENVzS5NRenK5A0P1i5gFRlzSAaqq9yxeDdFrZ8aI8tmasYtdg04Lb8kYx0ueG3ay85a4VpdQ/mr6ksb/aXOmpaPl7o/QDSPLHwd3/E+LtkOaviDSuGqZNysHqg8R20besf+hw5b4wKL8OKA4dr87zXz9wSr9yNJrOQT99oLlkvXH2uHq6+OGzv3TcGhFkBNg4qUxx+9aVqdv7l7TBPhf4i6cGfkwvgU7N9J5bp8GTiGcUqAaogrkUZucjETyjknePggXSE7gkOiZEQ39rGM00aIBEKUpxPpERHbmmvfliZm4wwNbT5Kp0neam/aK5gjk6aVFnH9CMKqyGpkaUTpfg2a+x60iHcLY++So7K/wXdeRikSs6YQ6x8wXjiJInnByGD3KLxeiFlChsEZtqthxVABNFD6lQNy2ZXqS9KW2qo1+v+PITc8GVU7ejDtPTKjpnWCkyEJEJNqJb71ae4o0A8uYiSshJkEhQU4rKDO86oy2OYKZS6BWIeqxn+25Quk+0YEJdoXWfV/WDesMzXRLuJ3GaoXmvMB+bj4TZ+qfFy+LD4g1nvFu9UfjGT4xd7FEvs5/QNh1Jldv+yza8V7UHG15E8hwKEM3dHe3mUAf4lW4DJmir4Op61dyZhgoDzK5OBSjcawTPfANRbhtsvx+hntOOsDtFj9JeV7r3/piWa+I+ol7YfQjNb3GT/p7WPuJ/XMSJdRYQmft3tWJXDzSWLf33H5oYes8= +sidebar_class_name: "put api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Update Public Identity Config

+ + + + + +This updates the details of public identity config. + +## Request + +

Body

required
    attributes object[]
  • Array [
  • ]
    • modifiedBy objectnullable
    + +The manager for the identity. + +
+ +Request succeeded. + +
Schema
    attributes object[]
  • Array [
  • ]
    • modifiedBy objectnullable
    + +The manager for the identity. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/update-recommendations-config.api.mdx b/docs/api/beta/update-recommendations-config.api.mdx new file mode 100644 index 000000000..5bfd51c20 --- /dev/null +++ b/docs/api/beta/update-recommendations-config.api.mdx @@ -0,0 +1,79 @@ +--- +id: update-recommendations-config +sidebar_label: Update certification recommendation config values +hide_title: true +hide_table_of_contents: true +api: eJztW+tv2zgS/1cI3YdtC1tO0qS55MvBTdNFFt1tNg8UhzS40hJls5VILR9JvYH/95sZUrL8SNrLFXu7PaNAalPkcJ6/maHou0TXwnAntTrJk8PE1zl34kxkuqqEyumBPdKqkOOklzg+tsnhVXIyPGFLc5LrXpILmxlZ43cgdUmkLMtotQ+bMO6ckSOPD7wVORtNWSaMk4XMwgSzSDeFbY34zQvrXup8mhze0VdpBLDrjBe9BDZwQjl8xOu6jIQGHy2ycZfYbCIqjp/ctBbAmB59FJkDurVB4Z0UNpCNGwvzWnDnTRiOi7gxfAprpBNVd9yCOGqczJalfyOtY7pgMgfWpJt2BXcaZWeFNizjZeZLYFiNH9YDbC0+86ouBRrgox5dSAefe0mpwwKURwjzr7HRvk6QnZobV6FiegnPnLwRyfUsTPoR55wKk8FTPhYXE5B1osu8I5fy1UiYZFmsi4lgdVjIbnjpBXMT7uCPWGJ4Lhl8rjwow3pTc0vSg+JznwnG2T+Pz5cWwpaVVLLyVXK4BZ/55/B5u5eAwioOdk6KUnPX1chWugeiGa+G3ulzUYJ936pMdOQZaV0KrlYEOikYeREzvhT2bO4DwenZrSxLNkLpClQSeOytdBOmxC1KMTYcOAKTleWUWdoXZrSmZlzloJuo3aAwy0AhqC8lPjtWy1qUUgF9H3gruC9BxIKXVnQEpO8golbl9MKrtSb7I0X8hkKBVI58+TBZxJTA3iunk9kMZ8GONURCCMudrS38b1HSI4igFT+8D3544YRhAfCSDYpsUGSDIv8PKLK7FjhKib54bAxEUx9qGwhcBQzKIjolFSBsBBUIk5ZJBfzKPP12sJELx2V5pHOxigrLlngNSumDQiVyKIjlDBaimm9kjhhQaSNYIInogSLQvLTr7aiJdJu95DnIG+Q7isKgMg3PPgGtk/zLDF0q+RvGcFwCaEWodM+2Yl/w0Yutg53d4sUu5zt/393e3xsdFPz5862DvYMD3L0S1gKkrIPOxa1/FEoYmTHEr1L+DgoxgoPuiQHafA3a3mMDovEV+kf0CnNbMSO/zIHj9gCQXh6dst19VnI19jTOx0tKUP3LcxhRviz5CIcwuGa9yMRbI8dSrWNFKISxq+TV8evh5ZsLGDk7/vXy+Bw+Ia2VKnyowFtzdEtgFXxhom+J4yjALbdtOKbsWaT6DATiynYnyvDNTi0ok8VghBVx9zUruqRZYXS1EEoUNxDlT2Qq0h4AB4wBQmQTNuLYF0QkeDbMMlG7/puoyWdsIjiAztOUDfNcopC8bNCj4lNEIJ7nGLqBQOExBxMWae+Y0gBCYtEWc1UuWmOOKG+6RsHgAM6/7CfDzHlgjsTsRmHrLZHFaB/gOWhukbuLjtJIpVPItlkDpZk2kPgAmUA26SyLcITmsgA8qpnXIlYXKAnufg7MBIAEPOPefkXcnZYAP30SrX1wI2LwNdkZ0Iis0ZgpIhI8RLFpcZzVmqsJfFZIAWlpE7ub2N3E7tfF7vLDs9gudUuf7dXS51JxD/o1lDxXSh9D3qM0ayaFUjwYssdAIbFE+undBQT2J6Fwvvhc4wHNN6yPQipfYX7Y2iOMj7D8aI21YAtkkPQYJCgAiUR+SHzPOSZFBVU9X93ttTYjCQ6q1pSIgJqGTbVn3FDFqpATbnss18KqHxybcMBHDhERmhc3wV1V3q+1VG5TSW4qyU022mSj7ycbbSrJTexuYvevGbsPVpItVxQtsU6yvqq4mQZPi89RWs5gAmsO7lkbcmSq5WoFibG2xkoWK4dktLM92i72M7Gb8938xfODYid7scP39rf3t0e7O/tJN9dfzeO4DbLFmOrYO9iRVAxF3A2+FMBzTeu0zheP/zy+XSgQ1hB62roZdA4qvW5qx711J4wnYBGDXnoetrjnqDHU21wBC1CShqhpK59NhbipEDdZZpNlvo8ss6kQN7G7id2/Zuz+BxVirIburxBhwldXiDA33WJtLfWa3gj/0YUihUrkgNyb6Szzhg48myoQlGAFDEo3pU0uLb0oRwpDKBth7Hp2jYyAuyHTtSec4fgoGSzd2hhkzQW8UJ8Gvr0pYe7EudoeDgZ3YE4w4yzltUyb6yJK36ZAaTACHa6BJ3yTHUIRJ7Dh6UksgFMygJHo4wEQiXgwR3wNn1gwCx1ePkhZ8YrsPNUeIJDI9BjEQ/Q3GgYWa66mP1ianZJ/rcgHcl2acvbfyxII3SPLOvU9uBvMZ8DpkogowvXcBc6xMg+7rzjCPNtgP7GzstlbnLbDXgpuoG0IR+xPfnp38ZSNsR4lPPAWS2EhsYGAiDoFFyG8GzbHzbiIUpDRfjwhxocLB/oYX6woQWD2Xp0Lwa5OohJ+gURwBshNKsVFgsACV10/aayTixtRYo5M55pEx5O5GoCGBnxh3VPKh9Q4SBWu48Bo+l712SuJMIVOT3OiiHSWzq7qRi7ekeuxTPytodYP1PpEzT5d4iKo9ioLF0QyCHIkwUtL2nr05oFev0MPuywYQarLPKAmIh+Lr2GyxmqP5mOBXh/pLfLxXr2bSEi2i8tYwC1mIVeWOTth2URrK/7BGLoOhsHV2EMUPZqtW9y0TxHR39nqsNQPW/ZlH0pH4u8NBIYKzsRHmLqpctFQ1Kk8hOQHsizE/Ae6SfVhQWYavoIMizNzndlH84wb9nHDfsAAG/kPCQwdC2IbZSAcCA5wNLc/IUFktIN7gdZaVCfyA1qDqSEDVomKrQ/Dl8M5wMVPjB7g7HYOwDBW3u2LKfjOIi3MYgvKas4MljW4ym+pIXku6S3w256aYEL9s8mLEg/nRytvVTn91ih9D5L8eXD3f4R4G6T5HpEm1sJ4RHk2/xXHcdO13HNf+vFXk790M3kr3Vt7wzdeKl1zMba5M4sRQ5qLfU83Tl/GknP1tNLi1WYBf+EpwQ11DsBtuB2LhViXUF1yh4FJwJRNpKBzjhoUg+VrD4NDVwQmtdGIYNDNEqGxgTmAPBbKaj6SJdBL2cV8Z04xH2pjdE38bj01W7hXNoG+WaTsHbSeKgPPwrYTbzPAs4869p/n4Fyn6JvsVeOvUDdWlVd4Mx3Y9hXjEBVfcOpc2swH7IW+RolGF5qq13ZVA0QYLShCSg2YqezbAo/QJVot+cq9wHVtPD8H1aMVsdHA3q4V5EyU7RX5xc7jS7QhYPoTUdbY+ELigBpSdHb4+eRihSIQUxbkykSqzXgQF9kBzgUi2OEF93mebqdbfep48M69tg5a9Q7x8BOrB6/8x98/xKOPZQe9m79T+Ia/14qpEnucQY2Hd8i9Dz1XaHGvktUfJsQmF0J4AoLinLs7POPBrm+GwwAfeIBwdT1v6KiPhgV01kNd8SeBZwzx5UL/YkrZPx4mrL41wT4zrAjnRw/O7fbrp5do1lH8RVoVTicMv4VB/HuYvId/8EXXQTxEOhy/S5qzPpgTyDZV1roiI35AKWezfwOsoqlN +sidebar_class_name: "put api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/update-source-entitlement-request-config.api.mdx b/docs/api/beta/update-source-entitlement-request-config.api.mdx new file mode 100644 index 000000000..081b78727 --- /dev/null +++ b/docs/api/beta/update-source-entitlement-request-config.api.mdx @@ -0,0 +1,105 @@ +--- +id: update-source-entitlement-request-config +sidebar_label: Update Source Entitlement Request Configuration +hide_title: true +hide_table_of_contents: true +api: eJztXG1z2zYS/isY3ocmHlGyJTuO/eVGsR2fOont80vzwfE0IAlJaEmAJUg7qkf//XYXIEVK8kvj3F3b4WTGkcjFYl+fXYCg7j0jwiKT+czbv773rozIDrTKxdd8WORTuObJSO0bXWShMPsJV3wivJv5TcfTqch4LrUaRd6+V6QRz8UF0R2pXOaxSITKz8VvhTA5sBzLidfxcj4xyNQSGg/4RMKEmUyRE/C5nErDhmcjlok05kDC8qlgIGEG3JhYcAYCYs1C4l1YWdhYZ4wzK2+XETf7xY/FrYiXqM1UF3HEeJrGMzs0jmnC2kSGSUXXHNPP6rMahiCZqUTINeNq9sigcqKxjmN9BzdArKYkhYqRI4guUg7XGiKslR1YRGIslYhAJJ8dghPVhPGGZB07VcMCT9tQ34osk5Gz/STWAY+ZziZcyd+JYp08JMS/9B3cyTrLNlyrwCs5LjV43ZjzUZ9Z+4PJfxWK3cl8yk7Pj38eHn4cnXTYxenV+cFR+Q386S5cXL2ja4xDUGuMdjQfai8zEaH/Qut5G3xdiFRnmnc6gsy490pabz/PCtHxQkwSleMtjB4ZknC9XwxG8b1nwqlIOH7KZ6mAuNbBLyLMveVwr6UKc7nCDurqwog0w1TLJaQLzkYObubVmmmWBqXw/ZbHFyiWveQG8CzjsxWxTrNIoGFiCfLoMSvHM5OL1FCmoIebwdZlR0kKlr2bgmeUXgyqmRotK3ORmOfKLLJLoqqoTY5xDtRCFQlCydHJ5ejyw9FH+P/n008nR+dwz7m9/PpxeDI8pk/Hpz8dnZ8MT+Dm8fnp1dkqAB3St8AFv1SRvJVRQQnAJpkuUrjOc6uTSbUyMoiFxQ7VtFOX/cRjMAzjGZjKuOQ3FMAbGytib2zss9M7JTI0OFnXGB1KgIKI1cLEjq4r+NhAi7N2jLMCkn8kHK8GjCLKVQuBd1Od0NUSHEDVQCC2JDxyrJbNiDyH7BjdpbgCvDtGS1kYGB3iNHdTGU6RlUlFKMcSZAtmdH9jo/T0KNrYYHArjtC9X3mSxujxFZ/NO95iyLrQUEUc8wAH22RtengUlXo7WUJWsuuwwoBkWsUujOtBiNKvyFIXVAwED97u9P23g60df/vN7tjfi8Suv7spIr63O34zCN96c5CenNnM/mEjQ4kqK3M8KSupBaBK30DrWHC1kr2jcd1/4OakADcifwBYKDGh5ciidSWjS+zGvIgB3MY8NqKmIppzjveV5PELBLuV4u5hucjyMMcMpVuDM49JSN8fsvEa6FwW8WClm3Cz1iwF5aJe6hsufaIDmleiEsZdiLL22lJWQ026v2K+OgHhSgmsNtcsxKCojmsIoBRAoAuy2i3i0SNFZKVMXN/MUbllMbUSlRhrxFQwrRGYZAZEiRe0/x0Zl0tFE/2xVX0ok0p0WBvNLpLWqJ9A5Mm0ptc6Xy2MUJFTN2Pq9dQ8aRE2Uq4jCoXimdSdpWxw2YRpRJddpznRMAxAeDKtetrSSkCDQyFE4c7sO9l8tQrPO084ZvX+GnStA723tyN2Bm/5wB9shlv+9mDAfT7eBKgNRLS3OwiCsN9/ucPnc4u+VN1tnvY3N1ddbFOdPdnCsUORcxkbtHTbNrZtY9s2tm1j2za2beMfaRupJG2vq0IHsUTlj7IMJvWhGuRFpiAYZcObLNAR7XlIBdEioxfVoibgRlTdDnS0Fm6bwr6XSviTjOOeDxMkcggDnTMJLDSgnmVZphvRdRspA5bobrF3PKpXP1IGbZrx8FfgtT7JmwJdKQnjWTmEyaiqUmumFbuQqW829/rb4zfbnPffbm/t7gR7Yz4YbO7t7O3h7FAnDYDk08XyWAD2AojEOgSP/A4GyQQ3Lnpo8ucXPeLxDPtfgl6WtlLTyctwyxd6S/bu4Ixt77KYq0lB1/lkyQjKv7pYQUvQ3DI+zeREqscq7+HR++HVh0u4cn7076ujC/iEvFZK6lBRHYWw1FRyprRzWilwx7GRjcEc0B+wDcd1AxTiytQJpf1mZgBqCXMQACPc7GtG1FmzcbZU2EK7P85eya7odqDIwbWE51CnAm7LgC1QiBtp7n9wltxgUwGVMHvdZcMokqgkVPxbW+sTPsOOn0cRpq5lMC4glQUtOXSRQ2uUy1A0fbEw5XLtKoHlQ90pmBwg+dNxMgxz7F1IzXoWVtHiRHT+wZaP5mlKd1kzGpl0pnIegha47gAzZhlYmAWgm8wNc3BExR6AR5V0FWI14Bml+WiFOcw13Qt5YZ6Rd2cxwI9PqlU3boVLPkLpqrQs3OQQKdekNg12VJW7ysSvWpE2d9vcbXP3Obm7fPPcrb3dXWp9tlZbnyvlHudg8VxpfTKKHlxQOiLbm1lH0sMh1yL9+OnSPU4CevE1LRec36k/sqV8Rfhh5Q97PSi71rL0L3yBApIdXXcJSCSifZJ7IbFXblxsbw5WZ3uvs0BCgKo1LSKgZsZmurD7iYVS1LOaDou0MOqHnE35rag1sbQdJVTkp1qqvO0k206yrUZtNfr7VKO2k2xzt83dv2buPtpJNp+9uj7JFEnCs5mNNHefnl0wICg36+FKmXLVs7J6t4LMWNVjec3OwQv6W8HWeDcU2xHfjt4M9sb98E2f7+xu7W4F2/1dr17rrxd5XCVZM6dq/rZ+JBNDE3cLfVyhILhMrnXU3P4r8EHhGGGNTquVfTPYHEx6U/WO/b3V3vFSa9z5n5Udkmn0kGphI8Q0oE2QNitpgYCzCeCiYgBVUttddJkI4ELn3GKZSEpe1AL4ZjN/OMbtZ5soZZBVs0gVxgUeFEMkiDV2zRoCS4KSYow9H3CgDnYC6Pwdu1Pnohd18uwcNf6AGrOjr6EQmOhV576zbn93BMJniBEX1sEPbPTa1Q7Hg4SwILCYVfWdbX/e9udtjW9r/N+jxrf9eZu7be7+NXP3D/Tnrht6uD8Hgmf350Db3WRVL/WeTgH8r9t0ShUnAYU30yG92RItenDqKyCUUKC0IAzh+B6O13Pv4PTuZTTv1d+tcM7zw/Jogl0KWCGLLIbB0zxPzX6vdw++A5/NuzyVXemO7yh91w110gvAYGuwCA8N2LxDAno3x05gTw5mEgPaoh8xt7Z35yw8Az6gfeJHOSuekFNnoCOzbDoMgt8FF10GEVNYWfxgiLpLwbSiH+h1lcXzl+tiGT2gyzrzPTob0DOQdElFVOGmU72AVTtlt/Ia1qK04NKtvzLZKZL12TvBM1gj2KcZr378dPmaTbD5pOQv8DQuExJXC5A+ZxAiBG7DcmcfB1G9sedGUfBh49kJJhMbx6Aw+6wuhGDX5RGwE0D9c4BpMikOEoQMOOrmVemdCM+/YkHsLiyJgScj1QML9Xhj3GsqfrRKkAo+JovXjA4lYpLEIo40TkVa9LHrtNSL1/T6ViH+UXLzLTefuJnXS1JY016H9ixOCBltj9castY3T275+TV+uKSCK8h1WQa0hJOj+cQrLL32zXI0+PnIrynHZ/WJzuk1hzELZOWJ5BELp1ob8U/GMHQwDa4nBWTRN4tFhwN9ygi/v1kTybdT+tKHPpHk+wCJoWww8QDrNLUpGjo4FdmU/EKehZz/AqvoiH1p6EyXr6GcImWkQ/PNMuOEPk7oWwwwTn5brTCwILdRB8IBGwAHC/8TEjhBa7hnea1FdWLfozFYGkIQlbiYdN9+2V8AnPvE6AZSVzQAw9hmV88A8Uy544Ulq2GscoNg2YKr8sYaKuWS3ay81QYVVs8/m76o8XCxj3Kq4tn3RukHkOTPg7v/J8RrkebviDSu8cX9yPPFa7dH5RLlJe+lPPVKyfMOX7/wlZKOh5lEFnWLn3r+vnOt6OqWJe6pTwX8hbsEQ7R8gMWZfQ+pfgYfGaUxzzFhCbDCqRS02ZEKnmNb28Gk0QmBjHtZCJa0xGiSAQ0gkoF2mwcyBn60HV/OzAkLbM+MIYvfTUErLnp3egqLZ9Fln/Cd7xAiDteeeKAE7v2i3SL0AoLuDGOWHZZxzNBehXJvEBQJ45AtTwR7JE1YWEyG9Y4SpS00dbXVqBKgMItQhS6twrLEnI5xHx2W6LWYfmIuCGnjNtHB9OhFXIDgAq9S5FzElHRI11yRPMUbEsmfijjF1S8UFOgtRW2Gj6PLFY7ATLmfItDZpOcGmR7SAhNc+dnwGXS3ups+rYTgeqpNDuv1GvMr+skG9tzXmJbD837xWKH91Yb2Vxv+HL/a4PovXDj3Utz+xdAv7ELebqRce24jBaj3Jb0y9PBeCuD+FPIGR93f474hbi7M8TKQ4abU9c1i34Bel4UBtH9ItehXgftW7oGVTxWp2qBafRKH2xl2hN2TfJT2prZPdHaFKBG4X6pI7I5Xxu/gIv7d9z7DPw9/scViFBDR9Xuv3D8GGsu2bObX9bLug30p+D9yrcDH +sidebar_class_name: "put api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +
  • Array [
  • ]
+ +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. + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/update-source-schema.api.mdx b/docs/api/beta/update-source-schema.api.mdx new file mode 100644 index 000000000..a42b134c9 --- /dev/null +++ b/docs/api/beta/update-source-schema.api.mdx @@ -0,0 +1,156 @@ +--- +id: update-source-schema +sidebar_label: Update Source Schema (Partial) +hide_title: true +hide_table_of_contents: true +api: eJztPWlXG0mSfyWf9sPYHiSQuIy+7JNBxvQAYiXR3l7wg1RVSqp2qbK2DmMtj/++cWTWKQ4z3pnpXvmDkfKIjIiMKyMP3Td0qCKZeDo4cRvdRhq6MlEjnUaOGjlztZCNjUYiZ3Gje9Xg4rjxZaPhqtiJvBD7Qa/LWIlk7sWid3EiEi1i5Ssn8b4pfykYopCBUN+9OPGCmWDAIo3xixS/jAbnFzJx5iKUS19LtyWug+tgPFdiqn1f32GzmPtMPeW7sZCREt5ikSZy4iNsVzgyCHQiJsoM6HYRRlN4Lv4fyIXCv06ksA4/LrTrATQXm8FggPSdhzgAotJxdBokQiZJ5E1SwB5okmIW6TQUKki8xFcL+LshljoVgVIuNpjLb8iFItJeIEJfOsrgcuvF/bx3VyRRqm6x4iyNE+GqqRcAMRmpOiJwPCzSeCVdV3gJDoYVMU3HlzfzJAnj7uamq4DhOJ2tWHp+qL0gaTl6sem5waYMvc2JSuQmc6DJfZs81FtgG4xmWIeII3jA9hiHvhVTX85aQnwEhNR3uQh9tSHmCqcg5pYzblfnW6Sm0C5weKINYclcWmrjnELg0e3t7e+xBlbdXwcC/l03aN4aXfhEbeLrxoatSpahqRqNhyfnx4UqHgcrDaBqj8PB+Xn/cDwY3owOP/XPellfbggyQ806zkH7/db79/t7++3p9L2z1YZPkx385uy7e1uVbhVkrxtc+ZDhVVAabje2xMcbItI+sEMlTosZZFmnMrayIOjJ76BbRU548VnqJx6CRIkqlBekbUXtMWPJ5dfBA03AdQAKH8oIaElUhGp/3/BQx0OZzKEKiYRvLD9gMjYakfrv1IsUWA+Cb7jf6N4Tw7EtSEMwazxUrQZSzyYFtLQFkIxwQZXh/Pau2z5oy/d7W+1dt/N+Z3d3siM7250DALYaLRqb0HoCjSrGK9BiSf1xtL4wdBUnH7S7xNGfH6xm/8AyskkxtpOUnTBCdBwdJDChCFuGoe85ZL03UXOaIYL5K37E6hoLZBTJJYDwErWIC+UsU40qcr0CagPrJoSMjfK6YrIUV8OPh2LvYKsjmtRaUPPcKCVa+3HLU8m0paPZ5jxZ+JvR1MEeb0vCcwWeiEQP5hO4GEZoyRJPEZ5QVZvIVazMnBlyD3wBfAXDtlAoECpIFzgMGFEaeKG/KfpAJho+mQJHh8ijBOYQEcln37Z8MFg+i1FPcIVhDBpkFYFih5GK0Y0YQ5vIaKYSgTDJ0YCnZJ01RMjpFGaH2Z0UiSzJ5mZxbEDxm/RTRbwL1GBKelzFNu98ru5EsT+Qj4ajqDVZd6RipqJi/+2trbyHrS90yeTLtskKMhAgzNZr0IwbhQ7nnu+FjYeHAjQrxRYYf3+oRSUoEMQFw0fSKutVMyaC5TUySHXXKB/XDfK313bK4XvWPn6ScYBnhtcvoIakDZnuUHXW+YrluiCBLFYwlV4MRcue5UijMJ2Bumua+mbGskY3SH3/4eELMgoAxiEgyozsbG3hn0dt3B3oc5w6ENfFU4BhAzb3GVOz0r5k01rWXs99mfZ6rtBTmp1RZu1+yCcYqXnJWNjyqdGM02WgGMoOiLYxAf7RAZgvAjsJtE1UjUBFvIzBFrPHz818biPiMlYQaKNiAUcpDC1IyA/jlAdp1ts40ndS3zqcNPDAjwkeCQLliNQDjJMhxgsqfinHMu6d9Zh95zgf6PirAv3T0TUjGIV/MaouL0lSL54r12I7B2pl5Mx/Dr53cx0bQxTnEys0tIpsNIcoSpGN2xKDADQxAj/wTbIf4OCPSagIxUItJioCG4+CETh+6qoLFS28OCZzlaM+AV+sZFDD/SPE94CBS/oNTulurhi5SOCaCskxcNGhWsAC1kvzoniD2ZDYF0iZzSI1y5cSKzg/lX6sAOEpLEfSSMUviFJyv2U8ee9y/Kl/Pj457I37UHw4OLsYjE7o89HJEAL8m4v+8OxkNDoZnI+ocHQ4+LVvo34o6Z/3Ppxi+7Peee8Yak4Hg79dXkDB+eBm2Ds/Gpzd9A4P+yPsfjEc/Odv8HfU7w0PP8GHcf/s4pTHvjw/HRz+jT7AcuTycHw57B/djHvD4/4Y+44+9Yb9i8HJ+dgUMrxfTxA3WL3A1+Ph4PLiplI4+u38sFp20RuNPg+GR0jy5XAIHLgpFAG6g0soGpyf/nYz7P/HZX+Eg/WOjk7GAKJ3emNb5JVAbO/4eNg/7mETi8vo5lPv1/7NWf/sQ3844mYFhlbRglpDwpNtVjFoRbP6BNbYMOx/hBm7vDw5qmckBvRB+sLKF5tYB4wCRAJxGoY6MiEVFPFqpnUdvBNFmeqKcbbMtn1iiNPiuJnMQR9ncyFTkG8wkOwZCUImhqu7w4o81DHItq2hFbntXCd7NZRIAVUB6tcRhC5OUlB4A6ck6quBgPFzIOaN8vxKTJYTLGwUUwTEi1OCyKryCDLSpXTHtJg98WA1G2B+xkVDAmPRZ4JV1rbVyPlaf0WgYPUWMpAzQonyBUtK/8DSGIdRGLiR9ZwqgA6gYFyTl9Ch4TTY5Ko+Ex7VwhImrgapQftnUBIRcEQvkD6IlYg9lLxQCYcGb94KWDPPtQvx1FynvitMQgocFTIBO6jvIYfyYNHN2oQQIdNSGh0lFaYBQgQgWgoIqL4vjVtjz2FkVnwmg2tlWMzz5hsCBgZ5CwIYE3oiHjEwE8y4Md2gEaYbchQ4SbKE6BnxRgJzADZ2ZmQKSsMWET9Zk4if2SY+Jr+PiIyvna8sMWnAn1sMq241ntOMNACPkTqo/q4Y0yKLRblmjF8Bib0dcmQ0B+bR4q4lThJgLTAdZh2cloccX3LAAoamd7QhTo96F2ag2M58ZtRqAjCBqSZWkfDcRSjLhldxS3yS39jBAtuMmRMeeFfPWjszV988tAuZeCKXsRktMVFlAGlwxhqqZWB6siCwjJvVacHxI2rUY1KAj2o4ZfU0Vpb5Z4ysjQiMnas7uxcRb+zRzyKdhKHqYWuIZHAy3kPYHjigIoFOY3/J82g88BO90XHc6cgVzlwGM5h/MfIwv2fEgVoH6hulCIBq2zzeYDq9zK5oDA7tghZsH2jo72ngUN4jC8qKJFkesX+qxAxdMdKLDGWMteLM5KFzmBrnZiNbJ40iDGAtfuQ1VwQdjykVZccoIWy5iTjrNCmm1lk5Hg9angfuup4JATKNMSa/EOp0RS8jnOS+avNXym05MCqhstCuAiPL0ToH5vHcC02wLE1RYXVgloPF3C44GrLwgFFgtx3iehdrNLmT8XyKckXs/jJJz6YPcAOjlaXpK7Q9Ed51xQkvD4r6VfQstPmSi7qxH+gv6uaDvFhmxch/1cMeUvpVMsybP2YVtYHbIR4GBnG6IL+1Cjc2VjXsCjgZ7llTYoIVQysBDzn3STtNoHdxobcVO5NmgqFBbYyTBwX5KmghUybb8PvpgPmnc92az/9XPC/EsC9ZfnQZLZO5td7c5OjIlz07b4TyE9pkcXlmjfOPwKSUSKisp20ek/doPvI8rd7GKa+yCoksa5pLA11Vl75PLyxXLUa/PFB2curNUpNafXY345OmneNgCVF4EklR6s7hXBX7hVza7HCJgHve4TsjY15IEplUDKV5y+nsSmqjzsHcvNPmCvku8Bpzz5mjFC8qeZRHd3DKmdfX5UMzXJ5L6yWPZENtgoZ3ZqHgdEB/IOKG/z8MBqf93nl90T6mtKOrIn9J0R2lSxklTusxO8C4ZDw/ypj1aM40Q8LK84rOlNZ9KG4aVndy8u1Yu/vOImKcsQ0idCX5Z9J+CxlCHeL19HxZhtb5YplhQoSJQg5lSLk55NokVDe7y5tatVrKLr9wt41xOTniALWwYx2aUFyvTOHv7r13djsHzt5WGz45cm96sOW0t9vbP5bCn6cLGTQxVqZTIDYDXE+8l5Eg1aUdpTLM53fzqgPm1c9oDgWIJe3JWxLDeQf/56Rqc+GDOVkg3CZJoVvPvyL0qYQmeT62dGjg/wAh3N3MB3ghSnRS4Wcjk9sLG2S38NCRxwsxu8a6pUM6uLQtn965JWIwxjEt3r0DX/vuHQ7CJ2Oy8y52t9ymT3IhuQ6ep//hScPVqGwo2nMQZVOdGYfMFhqJ+5UEIxu6MvlZqeG/mZBslGzjoQ6/tjVYszNsZp49Y5Of7TB6W53z48pSq04cn7uo0GYLDWn49YGCCj4h9jILlJ3OKOylGgAo2ei3ZYK7THjkKvFoJgrWcKt90Gx3mp2dcafT3e50d9+32ls7/4U02tNpr8fDlxAdWzA/gM12e9zZ6gJCHYtNQQLNkcAHsp47q3aWD8Hww9qyH0Ug7U0xtDkgzg1lYftEu0vKxgRgm7yfudnsqkR6/iGsw5/n3UfQy+YskqSeilB2tGsyR5SfXOCxOAZpbTy1K9t34ESrLT5IF+hl+g4NMci7SDqYyT55wWRe8qar7YI74tZqrBhW7Ss52ds66OxM93ak7Lzfae/vTg6mcnt762D3gHbEFyqO5ewFQeixClTkOZiAhRn5H2AICDLwnhCgwV8edhKMF3pxbpuRafAVCQTpG2BDPxxeiJ19kOZgllK5nFWYEDQvcXMKD0CgWza6vGGQGETezFvp3W18dNT/2Ls8xcA02xBDWLXotBdY1wKogizM9R1hbAigcxR07hVzqu8M1HdZVjVraDYnzM6/sfbQw4y+okcRtJhGelFSJdKb74l447VUawN8Fuo9ndmaSEwQmgj1HTgEFSbNU8PJd2IOgYyK3rZEL8+VZfEqOT/pupxhpGOtKa3TbbIOHKrnVOKcnJXl2cgNyGlxUlA5APMXhF5OkgJyRGZRCzNpMSia+QGcmXP1KMwyjVi6DBLpJCZL7+iIMhTgX4VH+3SkwZR2BcMT2HaZxSraRTJ3Z4zMUaKpjnMWz+rdhQ/mp0mkZRXflFG+mDaKyBqpYkrTWCSz3KDOplU2XVbx+cj0WnfXurvW3RfqbrVyaM7TmVoKfdr10OcywNMAOiLnWQt9eFEQaGEbcd6JJ3IDlygmRPrl8xgU+6sKaAf9e4hHE39ifMSufEWGw84Hl0/s2R3r+vO5QASJj0zBFCyRcruEd44xMYpZtV0f7aOOJh4IaLAiRMTTB3Sxgvak04B2YGW8QZszwV8SvmhhduHJAtJJA7fJNx7WkeQ6klx7o7U3+tN4o3Ukudbdte7+MXX3yUgyw4q0xcRJcbpYyGjJkmbqkVopoIGwNztEpnLZvZBitILARBZjNcqRQ2PSaU/a031H7bhyx93bPph2nL2O3N1v77cnO539RtHXX+V6nClZWacK883zyNsdeHYx4u28ONHaLaf/UrrgSJv6SR4Sw9xBAEe3WEzsuFOPHc91ArQBYIgdo0fSi5fDU96OYvDIN96g01F2GaN03ofuJq9Dx3XouHY/a/fzp3E/69Bxrbtr3f1j6u4PhY47z4WOOz8QOu4IDLGmGGL9M0NH1+MbNFOYFKDBHjvPjm2Y7KNRe3Pi1QZ6pSiyc7DiTJXW4gwPA5pgKS5lIoOcXWjeoO0C20a2LV04moGJDPBMqqf54rK3UBiT4ma87y28hO8jKYQbLZu9Kd7+Z52x8paNYu5XxmQUfI25Vw0y5iX2aRaAQHnQGRjqn5jjNLP1d+WDxRApPkWKRf+7oxTqfJb/3V11SuAEL26huRjxXD9yXCCyR4bSILs5lYWg61B9Haqv3f3a3f853P06VF/r7lp3/5i6+wOhuomGHg/VocGLQ3Vo29oSWSz1kY4N/6MjdlIVgwGJt9AOxepuHoNTXIEXcBv0YJuDL7bZt47M7dfNe/uk3MOmeYsAisxzbg/QnlcFjGQa+dDVPjF2D3MHc/bQkqHXsi/jBPqOHj/ERw9X2KL8kQBsQO9W8gAt4nbk0V00klYCzrw3B7Mb2fuKT0K2FxGWQJhgMBuFa+FUjK9BwMriLzG1bpmHrir0AV2Xkf/w99PCgB6hZRX7nhwN2gvAtEIikvAFpwuEAADRfOGzRYdsunopTvvVl2IbOlXMGNZa5u4HNwk6NYQG2KwjPigZ4ZVZOjfz5pfP47dihgEqGQh+aFR5uKIAFbsAMSID2LNnSLAT+aT81YNe6ZQOKpyY+sAUcR2MlBJXJ4ZR5+AZhmDKie290msgL3+Zs/yKyFtykLSS8AI+tc1XdJvmsY/8PieTyK9rXoWWLlmg67VI/JuF1mRoTYIWv61gway9cvjUtwNajyCkHxO3Xj04w2sW4OGyC0oQahUHfrKE8CifrXLsrL0ajxK8JsIr43EdfOYraaVu9rUBc13/RDhzrWP170Kg6KCqXM1S0LRXo0X34JqkEc3OVgGlJg/Z9JoQSxJ+p6AYAQuTnKAvp1BGc1aF1PaWZhbswi3dFr0t0UzFV+BysaWrnfjVOOOATRywyXYiNvizR0PBAt1GGsgOsAAc5vNPlsAgWrCNDGul5Sfwm9QH3YcDqBKUOOzyl25uBM0nQRXYOmsDprpBr8GZ02b4pIqBRbc8i8yySYQqB+v4+hq8aYVvjG+2FYoe9l+NXqS4l+da8JGyn22lH7Ek/zp2959k8daW5s9oaUxwjDnLYf5scP8FL4SWHms1y4P6a6Rf8EXAqSaSzAqlqEAfTLxYzyvSg+4K/odasgMU48MKKn9gpggI0Ev4ljpYDGfuKcpIhErSA+0bKLV6QVoeRhpNizIvoszotlwE7JCwhvR8gEc5czsyPfQecGCLMoPf49Sc4NDmJZ2W+GzeA4twgYhnh6Hud21WiiOYdXqfSRxZQYKAbrFIAxgNdT5dCAni+oy04WtpKRtF89IFk8DPcWW9rIVAMUYS6NK3ihbxYIrJblhHF4TqmbFApmKT6QbW5xf6GzkhQ+Vnz9KWlw3PwQZJbs6VT1cqwaJDcKcKI5ydjGsQAVhgtlfwLWfTKd7EtvjiMBDP4rPdare2mrRcwceSdZzAoroA/JLftTaPf5tLi28uZIQK+LYqjfd5qn/9SwPrXxpY/9LAn+iXBkzYiOv9zRAz22gwUs5RsK+7Mr81gAauW/jZAZMkolL76j+4uzkYG+x0f48ZUUybPGAx+FZMt119yTMi5F7ts5SF2/ePWJ43Q/NM+Fva0y39cMFKKmwWP1gWPDR8/Kow75dRgvme12NR/J2C12BhOUd33zlJTHzharMr2aTnUfLuT/3sAJLDnTkH/UQ3Ck+yvOBFb0yP6k7M7yYsOMcZyTsoxP+7DZBzRF2H7PCgEZXfN+yOAbRhwPjvfwFyjJyE +sidebar_class_name: "patch api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 +} +``` + + +## Request + +

Path Parameters

Body

arrayrequired
+ +The JSONPatch payload used to update the schema. + +
  • Array [
    • value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    oneOf
    + +string + +
    + +integer + +
  • Array [
    • anyOf
    + +string + +
    + +integer + +
  • ]
  • ]
+ +The Schema was successfully updated. + +
Schema
    attributes object[]
    + +The attribute definitions which form the schema. + +
  • Array [
    • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/update-source.api.mdx b/docs/api/beta/update-source.api.mdx new file mode 100644 index 000000000..58ac6d9da --- /dev/null +++ b/docs/api/beta/update-source.api.mdx @@ -0,0 +1,175 @@ +--- +id: update-source +sidebar_label: Update Source (Partial) +hide_title: true +hide_table_of_contents: true +api: eJztPWt34kaWf6WW/ZDuLGCM394Pe2hMu8nYxgs4PVl3H7eQClBaSEQl2SE9/u97H1UlCWQbd5znMJmTYKket+773rpV+lKJ5jJ2Ej8Ku17luJLOPSeRgyiNXVmpVpR009hPFpXj6y+VKyXjdhQm8ueklSZTeFbxvfBYUWN1PHNCZyIrH+8/ViuJM1H4ngdSFXjkSeXG/hxngnmGU1+J1mVXzJ048Z0gWAieWglH8IjCD0XXk2EC819Ed1WRKj+cwOvAV4mIxtA1cafCwg89XTeKPWyURCKZyg/h9XeD3oW4xIYfX02TZK6Ot7aSKApU3ZfJuB7Fk61pMgu24rG7f9RovhYqcULPib36h/BDOIhmUox9GXgweAwQzWZp4owCKaCRcJ0wjBIxksKdOuFEelWhUoDIUccfwm+F7+G/k8Vc4n8dwFgEqARQb+mBG0tYLrWZRZ4Ps9BvNwpD6SZRXPijHThK4ZM5/PcOFnkZBb7rS4VQtpJEzuaJwlXTUAtcvLKQ3/lBIGKp0iBBnDpit9EQMo6jmBbZgn6fZQjNkqno9U9vWifn3YuqGPSu+u3O0l+Dqzf6QRQT/cy6FgIIGsufUj+WHkLiAlEBDiYzTATcBLR2ZjKRsSJ+8pERgIhTeBXCC/jL95Dp3KmcOZXjLxVEHjxVSQxErdxXK2aCynESp3KVqaQYaN7BgeTPzmwe4AhN92j7sHG4s+dtH207h/uN7T2vebi7tzfadZo7zaMKMi0OLlXyJvIWOPnjc7UsGyLXpWGi+fcxfhS/gh1FK1xY6muGY6ZU6WjmAwt4wHhiHjh+WEMRJRaVoRsv5vgunUch0MeVsIIlyaoDqlyU6zDBdTvzOfAWLWHrRxWFNZKz/8Kf+HqFOk4cOwsYwgcuVLnn0ehH4N3KKuIQCYQD0TO4QtA9OfZDgHS0ENf9t22BCBA18VyUVfJccg3qjRgPmAwoPI+ROgnIDcIJr1Z4rIylLEWRjCDt8Oc4imeSWCxMZziN43k08Sy6lfQDCEEaVD9wozniCPRbgoBknGla3mson4SoJfiFRkzkA+FioOwcJBxJitwGQCdOPJEJ6sgpgu2EQgZyBg30IpzxGKjD6E7yiyzIzVZ+bgDx1glSSbgLZW9MUrwMbdb5Qt6JfH9Yvp8EBYG23XEVExnn++80GlkP8z7XxfKXaWMf2CGAmROYapQmTHGtZeZTP/Dnlfv73GiGi81g/Pd9ieGSgrCg8ZgqwCGwQxGJ1UwV4rsPyB8fKiSSHwzJ4e9MVzyKOIDTwvUdiCFJg5Udeq070yo7np8QONqOFhbwpcwQ695CTaM7JeBfuDiJwzglg6C+0IxwzVKU43dm4iLj2OaVcHllHwH2ZXjdIFXA018Pqx4AWdv31oJW99gis2GA1Ubj4HB7xwHN0mhsw6/xzvhw72Bnf7S7l4NeTzwGk57GTIVHQAd7DNPF5O3gAhZRis6EsSB6MJXO51GMImqHXWMlJW0rl63B4H2vfwLPLvu977uDbu+ie3EKf3YuWm/OOvCjdTV817kYdtutYQddOFhYm2xMKQew+6OxDMakF0rRBnu/Nslm4Iv4+Ei7KDNnQcJECPDYFYGJQUlAG/bz0J94Sc6r/hbM0PLACsOiAkSM1tPa9ltfbm0kGbZw8oPCaH7oRjNyhdnzANOZxkbvG2/EmUxiOWGzBWYPnHBVF92Q2pipRjJAv9oBz8J0S6ZOIrwIGBNd26lzi64u6KwZaitUZKjGfB7G99i1RGuiZ5Nl4sa20WLX4KFlVfMWr21gTIjB+X+8QvlF1wScGvVKg/Ea/vnXv8TqS49fMiWuWJbsbMJaAtLIai5d8LndvHEnQ/BM2miRRXTsgF/GJsggSE9OJLCubzbjECasC5qA8MhOnQB1Mo6jGfK/dv7EJI7SeYGkaNJLHkc88QdyNAAd5OMZu4/rW0cXlhAoW8mlXchWc6uwlBzhTgmwVgZYjRwfIAz+D90jBe6oYkUJsrSK9iutCbQ7z3gtOsEaa1EIsaMiOzBlQmROr+vPpzImd7iKLia8XZDPjMztSWpWo3iu6BGDbotSrzZy0LhD1Hvrg/xU0fErtDLRMSoWfxI+4UeXOs/WZym6pqB6ShxBiBi9Hiy3PCLRIgkRSWLjoLIgaG//0N1rHrkQBMEv19kfHzXc7Z3mLjp47CE95YO+SyHYryE4hDzsZOZVq/OeLww090sDPXOevAV6eDoSKF9pCYzBhqKEeuCMIVMv6ghFdBeWORh9OZYxsI/ULjM0Q71qaC561uV8lHoPaRJJMoigaz0xkjh8bGb1spEzd1oHGN0TNM/DH4rRg30KayrnmSIM3RODOF+v6Rkcsr3z1Rzi+QrUzKLAKaUQnC8ucHzSEg/6gQUykdFTKnJ9Uhht3WmVRvmokBZR5XQDtVsJDn8LGrbPrgbDTr9IQvPw2RR07UpXCLi/v72/P9obgZcCvw7cnaYc72w7+/svSsAyANpW4AwhiJTavYC3sQxIJbajcOxPnhbBlnZMcl0F9xXRHyeNrXa7d3UxvGn3+v3OWWsIDjX8vnjbPS0S95F2z6a3cdHcHCZcxmKZDFOqy9074lTX3uHOQfOgubvnvCgLrAnTiVG+4poVdm2/ebh/8LGMug8xTD8NSshYZBeBjdiHRefMi0S7d3551vlnHsAqegtp4LHnYEL4u6kMxUNsiqN9k5i29T+E5fpXEKgVmIuePJuNYsRjGcMcNA7d5sHubmObfjmHzsF+AzTIizLMyuwd7VoTeYn0vI8Q54hwDq4UzreC0bccE7FZZjrqUEgPUmBMTI9TKGkDKNOK/FZl8mQ/+yrJvf1GGTbd6mYm63EG0IxkPeincXeRlyobqgBEqeKIpWRFGDyYbNQY5vOM/2+DQDuQCdQIRzBqEEWfwUXHxtkyjUWuFyik3zOncYOvXJfpXlygkk4MRCEBTOKFDpnHfohRr1k17/0k2XIxQsot1UL0AOy5DNr5g/xVynxr6B2EY3VU7FhlJZPTMEL5M058EOv6ChWLSsdj3M4Jk41u+U11y0iCKMnLOLr1FYwLEz1AXmtH4jRURqza7VPKfDlBgHkAlEoXnBzQJb84JiiZ58bG3RjozZMWk0AYoGBGa2NNfmOKc8Sd35d6cr/qdwgEehcXnfaw178ZtN91zltLEcHy22dTRacZ1g7tDg4OXpQuJfOfLwb8kKhSHPFM76Ra3JEp5vYau4UNkmzXaQVVjKnH9ntHzZ2mk+04a/uR31j6ykFH2aCUmOM85PKG/Z+LEc3OwM1l76zbXkouLL98NhvOcc3PyDC8NBuWzH++EJdmE/2SX6/NkEuZhss8ZReGT+vljLqMyyJLFYM1+CVHjb2do8NGxlJZYL0Cf/XXzHKASLezfC9DD4zTyhTIyfnNrSUOLmKvRz+cwO5bZRHZKL+tNVrYzaV6iRisBt35PapqBUO73qBLv0+6fZDYm8tO/7w7wO2tAT0ctHvfd3JibLe7zlsXrVN4c9br/ePqEh5c9G76rYuT3vkNhOydwYC3yv6JKBx0Wv32O/gx7EAsyXNfXZz12v+gH4Nh/6o9vOp3Tm6Grf5pZ4h9B+9a/c5lrwuhPz9c3Xo77feuLm+WHg5+uGgvP8vt3rWv+n3AwE3ukckw9C7Ofrjpd/73qjPAyVonJ13MNrTObkyL7CUstnV62u+cUkLCwDK4edf6vnNz3jl/0+kPuFkOoctgwVu9hEfblCGopNkqAVfQ0O+8BYpdXXVPVsvJnsNyoeE5rKfK89QxhVPF3VdF2w21ZAoafTKlaieMYTitTyNYNizvDpHmPFJ+tq1LdV+m8+qyy0eJJayKXEpOpVzKeOYrdDOVHqfA6uWDgIp0o1tJ8bF2i8iHhegkVuTYkt3iEVlUHgDGoaImf4zINLEmbpOFqIo93CiEueg3jVWUtnLgMCDFQSEo1TGYKuzYgBbGaSSWVFAR21jC6CKf7I/mGtOguZflmeBYfliAxG56apBEDBjBbTgX904JPTjJRCacbnj1WsxkMo08ZfJJphiQ3Houv/p5zkU2YD101RABQqqlMDtyKm40oYWBxYHl/3lBxHFg1CluJjPPivcURRoeFtOseRXjklyEgXDgzroneT+dJEJ3Q4wCJomXEDzN3sUQxVS1MDA5oWGNiL+MSsTfrBMf4t8HWCaI3M/MMWnIv+s81qrWeEoyIFBL4tRF8ffEkMqfmJVXlPFXjCQ8J3EII4MpII/Kruqim9jEChgt3+U6VsWKpnVSFWcnrUs9kTKUt0pthQFGQGpCFTHPXYy8bPb46+Kdc8s5EECbVnMCcwm+0XaaVhx+WvZELFPKATeBUWQAaCdQEbzG4JQ3/IkRmMd13VimYLgGAXuMcuOjGI5ZPLWWZfxpJZtt/dKyV43dWovX+uillk7MsGxhVwCx42T1FWoRuiAiYZSqYMF01Bb4kd7LxZp1MfAxYaTZgVqH8paK92DVdlu7yuv0VWme2qcE+49pyHUFWrJlgbEMjtg+LfkMx4KqmjXI6Gspq/LQOIy1cbO7PGkcY/mAgY+sZonT8ZBQUU1toVoFYY7SJF+cwMLxsNPy9OCe52sXwEqMVvk5V+dYtOzCC4UuBgGlfFt0jAqgzCJPgpLlQoyZnI3AbE39uTIVTPwol+/UmSTuoOM18OpRwwNEoSnqUKtdjNI0pRBcmEJVnGz+LKdb8gFsoLRKKoIMah5yt45FN/SQD/LylbcsVPiesbrWH2gvVtUHWTGrxch+rbo9JPRlPMw1zrq4tYrFMT46Biqdkd0qg42V1Qp0OZg09owq0c6KXisNnitzc0DuVK63YTtdAApTg9hoIw8C8llQIFNctsb34w7zi2PdqM9/K5znfNh1wo9jBkvX6hlrrquiyJY9STcC+RFpMrA8EeP8HpAUciFL8bTZH+FanbdMp8p9Pp1RGp+uxNI2YF5quDRfaQBsI1vMOJiM1+OJoAGX8knWgiYXphYKWELnwjiiAH+8PqmLlotHcITdk66K98BBngM/ZOLWwUEaU3kfygAHa3Tq6EQG/sxHnnvrB8YAVKnlLAXOVJLF4pMVAke11e0nAYwbL7ICQGTZT1i/9akuCuTozWVI/mJNw4a4L1SNPo6HtpVHfkqpsCLFHVp6zdZCFWagM0brnYgYp+jo/pQ6AZ1bKiTdvnNuHeHiWCza1iypJa1BBxfGjrsEo3L8YE7utW1aR7TY5RWAbhXq+x8/eZJDkKn+5FqFlIsY/5uFzvPBqMZ6hxG5CVN/WKqZB/NLZSqdIJm2p9L9PPRnEhwaPLJQrWCKYEBbmnnYrisuViOnVHE0gyUCg1PaMQCeGE5B1U6jIJ9czQ5EYNToJPxop7m6wZqSi0HgNhDW7UZDx3pWMHhvNRLqs897vjyvmEP4WFzXduOel2DPquVgGkVRAEHDCgjvees2xTLKzIBZJ4kOhplktE7BmJ30yzgagzjVacyxkwaw0DHYEpmDif62e7PISiiwnGN/fGP23PYQtosOawEoWyL5++fdTzFZc9G6aHdYoxcT7ytvn515z1BF5pFxtW4evgn/e9E8/JPQnC9KScWpeRa0xVfyoSN0/6xU9EFGw664ZQiMn66hCfEkFrbUdQ0gaXFVTHwKVa2G8UOWX12dfTdd5A64Kgsc8CQ4dwWkmBOXQzCXN+86rbPhO9qDURhFrqGnQSkBfLM5FUeTS6ELEHTmiGaG4BQUmLhzlACVnRTPtmXc0mhu1xpHtebhcHvvePfwuHlU3zkEntnf32k0/q+gkbtrMOrQlipn9m1tO3WxFlviFIViRav8STfigt1pBA4uUmUpNVv0kpbchRwspvB9LWCMssgdCniVefCoBF8X5sUnRcQW4rt10Zyzt8X4cOmErGfcm5qdmA8orzcNVuvXEmA5bWsy7U+Y1kPljJntsMxozVoD/g+Mtnu81zhu7NQPmwfEYeaU9EsARLxuB1wHrN1aY7vW3BluHx43DgGy+uERgnVfWlfM5eV57+3jsn9da1b4LMRu2fGHdoDFQKKDh7TBH+yb1Jqv6x50NDSKPDp37Ye34Ip5L3gAwZMJOCntyFuDu9/6oaxNYodO79K5cuA6TyfkKO07w/oXHtLII58/L2AZMFHfFm8cD9bL62vrxWAsEDsubhCsw/dXof8THtDUXVDVmFx2ybTyQDqj/cZRc3e8v+s4zcPd7YO90dHY2dlpHO0dHRHvSaXAPD2993kqgfKg9oPIBYr8AggB1gfcEwA0+fob/jTGmtqF29planiFPvki3rQvxe4BsH04Sem5M1lCQli7wj2/EDx7tOPWGPLAvdif+KUHNoxHc9J527o6w91Fu8+IY63s1LVCY5wBVOAFc3BHLwCFU4Fz6lKq+ls96rc2WW0b6j0fHeZpkw499OwlPfJDZ/WDRpRcvthCvPLrsl4FXw4VBFWL8ikgnYX7tuW6cp7UzjQmv0U76sn4NcSVWQpS15PqU42O53HiNqHQidIfJgcKRt9fjoAyVBapkamQszxRUDgA8jX8FTeBiI14oiCFllvMuT7tPHkac0XohjmkEUoXYFHcRG9+UHUq+sKwNp+2P0mCKZsNiic07azGyldmkro7Z2BOkojecSroSbm7zO49sC9upRY+qt5gbSTzmWKtkXRpB3XWrSy5jODzQdWN7G5kdyO7a8ru8su+PvSp35Lrs11y8jPU6Qc0niuuT0zcE0bm3hldeMuEpEtptIv03fuhvteGzu/O0UN7Qf+ITfkK8C1LD34+MlXrxvRntEAACY+8gjFoIukdE9wZxIQoRtVOyfGHKB75wKBhiYuIRR02jRmnIW1sO6pKe15Yc85nu7m4gTQgFXB4Nc69bTzJjSe5sUYba/S3sUYbT3IjuxvZ/WvK7qOeZPHuK+0nqXQ2c+IFc5q5vQXv6hPQQJjrR7IT5PZes7y3goMJ62NVip5DZdTcHm2PD1y56zm73v7O0bjp7jedvYPtg+3RbhOL6jNbf53JsRWyokzl6M10JBRTSSjWRgJzqSSKvGL6D9AbyzHVSiSZS4xXyNTNZSvkO+6u+o4XUQJrwzOjtaxybym9eNU/4+0sHh7xpq9jic2eV7GMio7OblzHjeu4MT8b8/O3MT8b13EjuxvZ/WvK7rNcx92nXMfdZ7iOuwJdLLqW4490HT2fDybp+zRMNb+9L1hnH7XY60Ji4+gVvMjmUUkVVERFVgvjLKlCJjLM0IXqLcL7V6BtbNrSOa4JqMgQ6078iC+vwz37mqCjrrokge85gXHjRa01xhpKlhnDb3YWP3SD1NO3qgYR3yRy5/iJvYOB7xdxJqCoXzDHqan1q/LBoo8rPsMVi87PrpQo8zb/u1dWJdDFCkpUFwOm9QPlApwzx8sqQ3sgzbqgG1d946pvzP3G3P89zP3GVd/I7kZ2/5qy+wxXXXtDD7vq0GBtVx3a1hvC+lJvqTb89/bYSVQ0BMTeInLJV/cyH5z8CjzXXKHP5rj43Rxzabc+VLz1xffuK/jdJnQIGZY0DqCF+XTKFyARkOa+7sz9urmQL4zu6m402xoBXkpUTnbFAjagz/7wBHzZe+zTST5iShqcUayL7LMDPY+ObGq1F7AQwcNUc4fq6THepQEBxDdKH23iD3gsrQ/WdRUH979+LTzQA2spQ9+js0F7AZAuLRGX8DH7zBZdecWzr3xsK7MgmOdfPQfUw2ZN8UY6MR0yw9KXV9+9H74WE/QxScb5FkXpY1AAUnIJLEI6rGXKQLATmZXsPohWodAGZUaMA1iw+BAOpBTX+QvR+6CNCaWtwj0p2Yd7PHkrA7R79fwxr9mW74VbgKGt4v0qr/niSwwGcsco6h9Cc0IuO+nKS+STetdzsy4nt66vBeI/zWg1Hq1Go6nXS1Awaq9dLtx2QXBxCCdQhK2vnpzHq+XGw8gJnuCoyzDwZS4ER7E8yjVU+2o4CuPVcLwiHB/C91PfXb4gx9zDoC8y6OKRi0jJ/xECWQfF4HqSghR9NVh3OGmNJKLWbORAqvGUNb8G7iDBdwaCETIzOSM0x/rTMZQYIZH8RJQFmf9E52g/FdZMj6/BamJLL3LVV8OME9ZwwhrrAKXhZ6OEjAWyjWsgPcAM0M7oT5pAA5rTezxWqVan4beoD5oGF0ClUdT8mP84zhSc/iXoBba2bejzLpWsYAwvm9Fj3WdnBn/RtyZzHmAZg6vwBhEYxCW8Mbx2NxON5J9tvbjiVpYuwY8yvLSWfkCT/Hn07h+k8Taa5u+oabR/i2nHfvYZxk7uIsVnfe1p5Qtq4GQhK9OSdJCRF6A32hdcTQ0qurgX/g1vFX99Cdx0CIKyq3fyAwF4CUoMaQx36ktKKsylQ58NrSLXRjOScv1RJqnvipnQETk8u+9AGOgHeA03pr3NzPT50ZCdVrqDmL/8yEUYkb5jqC7e65vSYozxsPwX3v0Y6WBvAFSnm6vEiWEkcOhmszTES7kB7HQmHGDXJ7gN75FLWSnqA268BL6ozPYyGgLZGJdAFx3LeKZ64wF/UifHVE/MBTyldLIaUI9U1BdWZgvp62u3sV0xJHhqbODk2lQGc4wyQaODcydzM5x3hysjwmCh3iHB70/qTmoL28IgGHox++zUt+uNGoUieBdspBKIi3OD669U6a8cvbrkj+G+XmbDL1mafvPl3H/HL+dqpwKjwS36xCuyU8rRKWvC64pOAUDrY9/DA6dTYDd88eULprUwKL7Hx3QfCTz/mMW7pGDNlY32XPyDLPiqr6F9TRtz+U/ulgJqMrHhIqei4ednibkb6Ef3y3JyjUDhF3o3p0ZnrLOOj32fFvMB3Jlzd490I5tg8ymXrSFdWTPSH/+dcW4odu7gIf77uPIB/oE/ojlrGWhEz79UTKYV2vDAxh8ucwf1D0A/NPt/XXat1Q== +sidebar_class_name: "patch api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + + +## Request + +

Path Parameters

Body

arrayrequired
+ +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. + +
  • Array [
    • value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    oneOf
    + +string + +
    + +integer + +
  • Array [
    • 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 objectrequired
    + +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 + +
  • Array [
  • ]
    • passwordPolicies object[]
    + +List of references to the associated PasswordPolicy objects. + +
  • Array [
  • ]
    • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/update-status-check-details.api.mdx b/docs/api/beta/update-status-check-details.api.mdx new file mode 100644 index 000000000..b985ecee0 --- /dev/null +++ b/docs/api/beta/update-status-check-details.api.mdx @@ -0,0 +1,99 @@ +--- +id: update-status-check-details +sidebar_label: Update the time check configuration +hide_title: true +hide_table_of_contents: true +api: eJztW21PG7kW/itW7odtKyZAoOXCl6sU6BWrdtvlRf1AkerMOImXGTs79hSyiP9+n3PsmbxBod3qbluNqqLEc3x83v0cx3PT8XLkOnvnnRNVftKpEgfKXYoj49WolF5b07lY62TKpaWe8Ne9ztkkk14JP8Z/XSiRjlV6KVJrhnpUhUnCDsWflapUJk4Ojt6ALr1U3nWF6AtvL5URV9qPxdtyJPpZoUFfigUBwqis/NiW2k+FdqJUf1a6BEdvhUxT5RxEwLgy2cRq47udtY6dqCDAUQZBKxb0xEtfuX0S8kB5qXMHQmKmnH9ps2ln72ZJQdKssJkealrtHhXBBN+9Mp4YyMkk1yk/WP/DEZebjsOsQq6y31+2VCGvdVEVwlTFQJUik1MnpMkElIJNZC6GMA+LoM1o0U565qhgcOFY3agi2YucOyntJ+1ABAZz9jiKC7zRpvKKJs0TvpHX87aDVBQLfjpRUMIO/lCpDzNgdK8xHZo+cqEVmzSqwutFIBID5a8UQiVoFAxAMkYJnC+xCL6ra1lMcgxtbdw+qMHKykvGhzvY/ggyXvBz6/VusZ7Xnj53fudw54WCg+tguyWqmTN8WSkecBNrXLBFb2NjVbD7GArpRIjsrI3BNgYfG4Mg274rzPZzjfgRh2UJByfiWPmqNKh7esgVPhZKMUClpCqsDSyks+6XhN7n3ZWxjPs2U3O0jaKLwr7SRiWINU0SKhY5xUTBBs8oMgtbKhFYkh1JBabrzhuNLNHdFC9lBn2DfvtRGbJmKTnKaQ95SKAzozFf1FOEzjhR7llW7Sg5eLGx29sevtiWsvfv7c2d54Pdodza2th9vrtLqxfY2OQomCauLctSTleW/q8yqtSpyG0Kj/wFg5RKwvYsAC+OKdqrwj3sA+bxCPufQq9A26gZ5RVeXfs1IcXL/Xdie0fk0owqHpejJSOY5OwEI6bKczmgoVgSA+O3pR5pc5coCulBheTg8FX/7PUpRo4Pfz87PMEn4rWCU/oG0ZpRWFrOqbG9YomjAleoo07lMIfKuuJZ5PoMCknj5gl1+OamDsZEbA1llXvMiKvfMWOetRiWtlhIJc6bay+e6K7qrqHEYKyQPh2LgXSYABcS+bM+QM7EJ6+jJZ+JsZKZKp92gY4yTUqiViEbwRTzp2AkZJZR6gYGwwqprBhp2coLY4HC1KIvZqZc9MaspLyedwolByR/OE76qa8gHKs5n4VNtEQRo38gc7DconSnc0Zjk06Nlym0kHk+hRnLEhYWA+imvROxHJG7HAqPqemaijVfKbncvQnCHHjLz1JZuUfk3bsc5Sdh1ZoHn1RMPi7aoRqxN2o3xYqEhwybaXKkatxVJ74A7MyzNnfb3G1z95G5u/zwOILr+JShz+Yq9DkzscGkzXMF+pQcPcbWXehfAeEGR65Rxxoh0q/vT2NTS93o9YQA7zfER2ErXxG+3/gjjA8IfjTOWvAFCch2DBoMUYlUtsdyzyRmQwVTba2u9sqWA40ANXdARFTNUkxtJSRMVlaGUC+alDWRWeXML16MJepj3bLbpmtPmra9RZItkmx3o3Y3+jl2oxZJtrnb5u6PmbufRZKNVJwtESe5qihkOQ2RFp+TtlKAQNTHvKJJOXbVMlohZqLBWJ1F5NAZ9DYHm8OdVG1ncjt7sbU77KUvevL5zubO5mC7t9OZ3+vPZ3ncJNliTs35O/iRTQwQ9wk4rjIILuetzRaP/2DeUg2prPHvLzVuhs1h0osZdtxexY6/WQ/dwBjYsbznePHs+DXxx9LMnuxmqzJVBLOD6UAuPUNKimFYWjvfQscWOrbbT7v9/DTbTwsd29xtc/fHzN0vgo7bD0HH7S+AjtuCINaQINY/CR0z4A6CZkM4BTqkFcxrCDZOoAo+xdPHmPZeliPlG6C3gCJ7u6so8tRa8UaaaQ2W3MJJpJmZi8obaAuiLWtaukwkRiiRRqBqaaBbiiq62gNMSreZcl1ozmNSCHzLadIfemgVcqaOt2YVbdK8goRcFHJLZ68WMaYRTmpI8A8c+Bx0hEL9Dc84o7f+1nmwOCaNX5PG4vA6VYpyvjn/fX7XLQG+PEHl4iT4+p7rAuHMXBq0Eep6EspXA0FbqN5C9Xa7b7f7n2O7b6F6m7tt7v6YufsFUD2iofuhOggeDdVB290QDZZ6RcH1f0fsnCpRAg5vYVPG6tkMg8MITmFQ+ykvcgaIvx9CuV/5MWWmzsyeC9eAEwTEZSLpyv4enEHwdG31+dw14Zrq4vaCtEHMkuaTiouVJP6d9fvmuvVwFzfhq7HJ8p380IsE01RlDk5j7ydub339BhGDSLntyonuopAiaPzU2Ktuaov1Adx0RwWkC68h24lA9N8dxWanyz4uNaVRqLnMPHicrUoJA8/zHYfPcjay4FCaog8Sgc2aQMrFkOZhiDhBP/OLY+ouh/CKftDrrMxv/74ugdE9utxlvs+uBnoBSZdUJBUuZlF2QuA/rL4Sa7MNjX526K0s9pbIeuKlkiU6k3AT58mv70+fihFBXi45lSO0rTT1KEjadwgRLqn9+lYKTeJdrrTVaMyC9xfu/VAKi2EOhcUHc6KUOD+KRvgNe80xNgc2KU1SXI9o1sWT2juZ+qRy2oa7M0tS4CFN1mGhdbkw7ylvudybaIOPBY92P5hEHGiqhJQITBNV5FZTnE9qveScXl8rxL9qbkngljA393RJimDa8zTcI09RR4iFzB1b66sXD/ySOX7UyGGEuC7LQJaIcize1kprr321HAv8EuK3KMcH836ssZ8vThOhqgmH7TjPxJFIx9Y69R8hKHQoDc5HFbLoq8W6okUTzoiktzEnUhKWTHQCdMryvUZimBBMckDogMGRDec0nJIf2bPI+Y/8zsfHBZ15+Jze0QJlZlP31TLTggktmIQa4KL8YY+kwEJukw5cB0IA7M/8z5UgCjpX9wKvO6s6s1/nObQ1pBCVubjJXviyNytw8ZPgB0Td0KAME7hv7q/hu4i8aKNcMFZ9LLFswVV5c4v9ecluQd7mx1Xas783fUnj/uz05q3Jp9+6St9TSb6fuvsPVby20vyMlSbCbToFPZ69lHpYN0aPf51ta+PhF896WIkCmxWMHdB8Or2MyHD13NLxC7/4i6dcFbiHQIcW3uQlvDTPaJJLT/kTXtYda8UnHhMlPaHMNYphW3DOQ2QqNOhrmdGoBA0KhAP6lQOdgx+fydcrS07NAGEpgui7q+INEXpfDh206or3aEJNigCgBpTuJuPZHzZ2oieIgXcUQuKgDivAu6KoDL1qDLGrQkgE7wOxl2mXVqFEogsxqraFZZDZzKrrBQU1qdDlVqws3NthfI1yLsQeWAsR5uJJOkxPXqR+gLq8RpFjlYc+CXSLDcJDvBHXyVjlE2qBUd8B9dTcCm+OTlc4gpmJP9/YcrQeJ7l1ogUTasRC+Gx1N7sbCTcm9HqkdR4d4BzzR7xSvhySN7PfE77nN9LjpkjdzPqETgLJAFXorkKre965t9WlUnJ/s4v2aQxLEoebGzpOou7vloahKJ1VnF/MGjv6hpXDsRJ3x5eKjjPi7xjJ6ZRRQDy3WP2BhvrNMCMcVX2Wdr6rf3dGcTOIL9oX4SCklFcYpL97nQ/416FX94PKIOLxm059rAiawLZGW3eBjfiBtLy9/R8XgcxA +sidebar_class_name: "put api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/update-subscription.api.mdx b/docs/api/beta/update-subscription.api.mdx new file mode 100644 index 000000000..8004ca71a --- /dev/null +++ b/docs/api/beta/update-subscription.api.mdx @@ -0,0 +1,136 @@ +--- +id: update-subscription +sidebar_label: Update a Subscription +hide_title: true +hide_table_of_contents: true +api: eJztXQtz2zYS/is4Xm8u8Yh6WbFjz3R6iq00ah3bJ8nn6dieFiIhCQ0fOoK0onr83293Ab4k2VYe1zQZTmZqkQQWi33h2yXA3lnhXEQ8lmHQd61DK5m7PBbDZKycSM7xtlWzYj5V1uGVNYrkdCoiZd3ULFfkLQ6t0Uwq1j3vM91fMc5i3ZipAi0mA9Z3RRDLeHkaLmosUTKYQuNJ4nksHP8unJhFYh4JBY2IqzrrByyMZ0BpEUauqjH4zcR7qWLoeh0wNiwNoJgT+nNPxMJbIimPO8KtsxF0moSeFy5wwIkUngtMRoJJ309iPvbE4XWA/xjbYdJNf5lJ9N30YTeOhT+PFYtD5oeunCyRHyVSksB54sU4z06zWQfZzXnEfeAmQgneWRKlNefxDB4F8ACupAu/lTMTPrcO76x4Oce7CoYOptZ9zYrEfxMZCdBOHCViVfKl2fePgZR4z1EA8Kw5abUmbd6x952Djt0ZT3Zt3h679n6n/eJlcyJ2x66w7m/0EELFr0J3iSysjuiEQQz6wEd8PvekQ5pp/K6Qg7t13rUicfIRWlcshcKner6rM3x0QtilXppT13GEQjkTxyXrQmGVaH3QUIVHj40oXFS9krFg75d/4JB6jPWxRJD46DVvRqNzuOz9p3c6ejXoH//Yg6v+6Un/FH8Mjwb98xH8uDwb/Pz65Oxy3blKbOIodbazc3o26u3ssP6E7qDdFwYgJwmYuAWtvYqkOxVHYTCRU2yWKrde7Is8mk6zOJ5vaF0SiZkSuDFdFhkcoRTIatU8DJQ4Ftz1ZLCF4tOW4KdR6sTorIPevy96w9Gvg97w/Ox02MsiiwxuQ22KtTxogH4wyAzP7Jd7zRZzEx3ckKjP4/I0zketN8TGhIPTpjeA+VwGyHaZTSObVDBMTkh65TiXyjVRWnSPO0YSeU+L52JwwsKJiX4QTwLuNZxExaEPE47FVM+zPEGchzpsNBaLRd3crYNk0ykeSwWhyJm9Dd0t9EOzTNWKwU9AMJZ1sMbhL6dHNdbVf0B5x7+cdt/2j+oFJ8BncNk1f00LtPWcW/Mstao3qxwarrsJ2mlsotDoAe9bta0JWJYi6dE8ykSMV3VdV+Il99gt98Dbmc+XbCwYd11tV9h/ksRJJOq4HoAHgSP+2r0YvdlBdSvhgX6FW2NBiFqKOHTSloejLCSsckAOCL3JLCwj9Ko77B9topW31RRk4HiJK9grrqSDE8kexjN2odA0fOA5cNk5VwpXTcaBHklG5cP1uoPe4NfR2c+9020HFLBiRqPwnQhWh6Wb+TBF1RsBwZ18hnhRGF/HvNQL8w65bZS6Fi1kgzWAnYzLonl6bQJHjU63Wp8QSSSpkGEp4DkDK0sVtvrXitvNjUY2jRMACEIksnmhx3HT3mvjsrMgc02M46BOAiRarzG2R+qoIPwZIsoCKw7goQO/VIlxbHl//xQ/G+JgrqRS7DPaWjFXUtMmg3paWYVuHy5HbcQgBuz9WWZdMOSiVgwcJTF8Dv1kctwotPsSUryiNWVDlL8pe0+uijWssNXKV8Acn7IA8oUClBUmGmM+7n/dyyEzjdlp4o9Bl89abduVUxmDEPHGc5Awj9mM64Dfy6cGETGKA+hC99gwTCJHsIFQ9KPsvq32bufF3v7Lg2arjRICJgdiuhWwRB5124/lhA2FYOny7YaOqsPwde7zP2CNh1jSmAroDBDAw3QrbkyjRgQRX9Rnse8RgjJJlQeJEuIGfssl2bVZ2lZDlb0AMnZrzY4KqimKoGBHvTXLQXMKcKximBuHoSd4sCary5mg7K5kPmoWJuAdkXCEvBXwl3t2LDHgrmE/hYgDPIYWthHmBJvaYKrHvQVfKmZYA6JTHrkeYnvCVWCtYQb/s9VIB4FMUngJ05tIDyDY04bw0/Ds9ByyPaY7oHNDMpWiDMhQkcd3+bQWBNvfI5ZVKAeByqKEGnri2GW1fXf1w7Pv6tJk1H2Xff89u7bazdZue3/i8pbT6ew3O9xptlovW+Jgb9ft7O0619bzGyKjUeQxWNe6s69yDjaY+GlSDr0Js2YA04Xw4aFH1xWY2TwEREpWKt2ArLdB4cU201QNTRQkZtMDBWZ3vzmfOE/igc68yKz01IlfwnGlSgXcJOPOk81H08U1r30s0ctCmMl9yilCWRqrcHsT2k7R7kOItox4NuCZHLGsA40izrDEIJ52/rG3TPp/I+/OXFObdmrKn2JMSFbDarUMnC+nlPWkM83xPlld3W9NX8W16M9XWLkashF8FEFBeTEurcXFtev/JKz7+/tCRYOCT7vZXI+ZF1T8dEvywYD90fWz4kJMZcKsHplK0lQRsyen+ioVwwaXuFkFX3JjMvJolbG8Cm1XZqx9s/W/TCdPDtg/JqhRroyPiWR5TFg3DzmNa2fjFsbaMlM141Cmut24Zq6D0phVfbOqb1b1zaq+WdU3q/pmVd+s6ptVfbOqb1b1zS9Q36yqm99addPSpYXOpmrCkSfRc3pRBAZgg+tgwNRhCX0tzYDHobvESASy5p50P6neUI5arohhukdbgefXAD9twOgSORTEsgMdGVC8lS6mOX4IRqpJZjgf25V1jrumWoD83DQHZUdmMpT9cucd0Nom1b4IJPRnaRcmXYoaDwwr9gUf7zUP2p3JXofz9stOa//F+GDCd3ebBy8ODnB0H6yWT7VozNg8ivhybegfMXRJh3ngn578g5yRK52j6cGhi4yFr57WAdHYErXpttk0Db8sBleoQbh8dXTOOvvM48E0oft8uiKEwL4YruELmLkmfAbmLTcuDikSPu697l6cYLJvclqrhrTWEv4ubgR00SyBVbCFWbggjs0EFjwH63W2Y6juwIR4oIoNpb5SSwXCZCaoQQ8z+oYeRdJsEkFuWXQl8pv3MXuGWV8NMhm45yO0YIC3oUOoE6QdrJLMY/vESHKHzSC1h2X5wzIsSizCJMbgLlcX51yUq3gtDSMnRaWgcwDnW6zcTpwAczTNohdm1mJYNPoBnrXkytyNCkIjkS4hdDqICjHqO2EU4UbOMcxNxoqZcKSxoM+DtF0WsYrRkcLdW83McRzSM4cnagu/O/cg/Ng0teyBXlwVLpKwxuhoRNpI1WQiEi5AM+0raatMXanja0hb+W7lu5Xvbum7qw8HadVUPyXo09rwIiXAPDOMaPFcgz4RWU+gSwTYSOeiWpFUoDMQ6afLkc6DsT3gzrTQ+5nwkV7K15jvZvrQ98cIPzJllXSBDJIcTQ0XIpFwD4nvnOPsBVSnubs+2uswGksw0GADRMQCDVuGCeUHURIEtNle1QDuChX8E/M2iI/6PYOOgDhq4Noa4lZIskKS1WpUrUbfzGpUIcnKdyvf/Tp991EkWd4YaHCSSnyfR0ttaeY5VYoZNMhf9GYul216KqIVJMYyjGWVkYM1brfGrcm+Izou77h7uweTtrPX5i/2W/utcae9bxXX+qvcjzMnK/tUQd9ajyRiAHG3gOOSAIxLxWHolst/Cb5LmWBYS9+aEW4GmYNIb3Ls2FnHjqdhDHMDwoAdowfKi/haHujD0EQe5aZL+ei0+sAmvQJASEkvduhoZgUdK+hYLT/V8vPNLD8VdKx8t/Ldr9N3Pwg6dp6Cjp0PgI4dhhBrghDrS0JHF3AHQrMJKAXm4CQg3mD1QxuZ28c8moo4A3olFNk+WEeRozBkb3mwTMGSKlUi831BFN6grY9to7QtNOBsCiEyYBC1JKBbtCrcCgGYFOyHedKXcfoJD6AbLe3uBN/Za59J7S0bxWzmUxQUvBBrryHYmARzEhOEf0CB6qBTCNSfscZptPVJ9WA2wBmf4IxZ770jBPp8Vv99sWmXQD/Q+xzYUOv6ge0CumbOA0gjxPu5Dl8ZBK2gegXVq+W+Wu6/jeW+guqV71a++3X67gdAdYOGHobq0GBrqA5t602WYanXtDv2z0bs5CqGAzJvFjqE1d0cg4MQlICbMl7SIHgc5kibMm6WR89U80OzE9VG/A/mZhf3HqtDUAsC1Rv88psvwC5xdvOEAhJ+me7QamQEih0bd9K9t5ABRJp6kuWNsnege9D5fZ3PZbZxNwgXtFt2DALfEMtw66r2W2xAHxHUA9RJW5FEh9DRk4hr3aVnabINuY9STk9ALiGjYZpMDbfwG+Ok23giDzKTfypz6BRlvTY/mNdF5N1/+lw0oQfmskl8j44G7RlwujJFnMJNbi9DhPF69DWryZcmfIHQXhvsDJu1WfFsCXv20+XoOdP79DF46G85ConZBrjfOZgIBcduur8EO9F6FYXJdEaMd0s7eNAZ2cSDCbPrAA8IXBU+FskGEOZJpOUjUTfPttmmDRJqlM+uPKfFk7KMwhm2+nVgs2OJMY121mMbM0X9pcqreTovXpjXxzLx95SabU77EjX1fIULLdorR+8IdyAiIAnuKZLWRw+u6dkFepiSwR2kusoDSsLwUd535aRa+2g+SvRspFfm4zq4nElYmVcOH+nYlZ6l6DNnFoZK/MDobAm6wdU0AS/6aLYWOKhNHmG3mwWWbD2kLW3AmcTfCThGoI2Jj3GdJ5gT6ooLueRvpFnw+d/o5OJvpTnT7StYjrElnij4aJ5xQBsHtHUMUIZ/vdqhYYFv4xwoDmgDOMr1T5HAMFqIe5rWxqhO5BvpaTPlAKtEBVYhfXGYBzjzi9EDbJ21gTCMMD3biQbXzNDCJa8krLTAsCrBdX69EFbaFblpfrPXpLj6/tXmizPu5nWYs8Bbfu4o/UAk+evE3S8U8apI8y1GGgOcsZ45yL903EtTnK/6u0R/1meJ6PjwIyeaS2eW07PGf+3v+tQsDEBkiCbnLIa9VwbBr1eK8VUGffMbnlL0pqwNcmL9qQDEtUVCc4/HGOcozjszKajGNBecPjtew1gT+hSb51GIRiWUJjSNoA2eHIUshY+lB/ToLUg6Mn2+PNCpBno6XoPN6j05IQQpHkxFnV1C2h+AvCNM+XE3ODz7PTS5/xB89RxdnR2n7g8w3PeTAEbDSJ34DA/4PhEjXKmcRC9lThgEIpWF/nB71iuN6xh8cAp0clpEvjqbDHWqaj196tKMBZFAmXcXIPqCF+cTGQhPH5C1tj3RmdKG+GPPhDdHI4F1GCB5MU687Y/WKAKxwLwwC6Npw3RSDWwLRDBh1uazW2/VmzYlkPi9hFDFkI8XiOuPSEGmMXwk/Nzl72yqb+8/+O19E4QxzW3MsdiLEjcfo9GVjitrY6UD+h5KFw+Bz0A/2OzuDsuCmPvf420I+lhzurrJ03oqh4D9mDg1gTVu9esKRa09G5hD6M/Zyse1HmI8rWUHy7yMZcHPdwKrX8Du/Q1+QYbKk8SMfmDeh9kj/bmwtOPaiz6sdugeuuT5aNti5ej8Ar1hbP7fAb5eliK+wHUP/ntoXcM/uAiNbKER3b+z0vI0tNFkU6y/CeqaHyBzaPY/GuVS0A== +sidebar_class_name: "put api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Body

required
    httpConfig object
    + +Config required if HTTP subscription type is used. + +
    basicAuthConfig objectnullable
    + +Config required if BASIC_AUTH is used. + +
    bearerTokenAuthConfig objectnullable
    + +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 objectnullable
    + +Config required if BASIC_AUTH is used. + +
    bearerTokenAuthConfig objectnullable
    + +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/update-task-status.api.mdx b/docs/api/beta/update-task-status.api.mdx new file mode 100644 index 000000000..a98ed1afa --- /dev/null +++ b/docs/api/beta/update-task-status.api.mdx @@ -0,0 +1,135 @@ +--- +id: update-task-status +sidebar_label: Update task status by ID +hide_title: true +hide_table_of_contents: true +api: eJztHGtTGznyr+jmPmyS8wtDwuEvVw6QPbLZwBpTqTqgbuUZ2dZmRpobzUB8lP/7dbc0L48NgaUuuyl/AXvUanW3+m1p7ryUz4w3uPTG3HxmP3PFZyISKvWuW14gjJ/IOJVaeQPvIg54KhhnfpYkAMFwxnnK08ywqU5gIEUUk4X9f3LU8VqejkXCEcFJACgyQlHOA4CYJzwSqUiQiDtPwRcAlAEMSVw15uncWyVlbBdgesrSubDr3c61EVWaUs3sejA9Ef/JZCKAhjTJRMsz6SLEdYyM4hABxJc41AE8mvLQIIA/FxH3BndeuogJMk2kmhEkpzkDjyNTy+W1RS9M+lYHC5zia5WiCOEjj+NQ+iSB7m9Gqzbw48//hh9xuLGMnvwm/LTB8JC9Pz/9eIZzWaD9DHeIccMCMZVKBCj0y9G7Q/bmoNdnbQJmBH39Yp6msRl0u6nWoelIkU47Opl152kUdpOpjzNe4j4kuFWpFAapKbaNvtVpOS3GUMQT0AjkUeCOOSZ4kvAFbmAqIvM45grkz8tduf+XwBupHajVdZPtdTu+onugcIV4nATgK1hARDIQKotwGR4EtHCkb6wGxiH38ZN74OsYZZSC3iAhpVrlkEtH5YMUDZkdcILRErQvYYAmEQb0BEeslSQzkTLEiWRzxURIpp5v43QKu2PFnVaZrCl9t7o2kHjDw0yQ7JQ4nZINb7aYj+KWVecD+zINK8DLVjEduZiJpDp/t9crZ+TjlSmFfuUwxYMCBVhkCktNstTuuPM38VyGMgZjrmDLtThHZr8vG34RFYKk4OSYGZAhOsSaEFss10Eau0L9uPJgFwL47LYcvlcM7z7BAZ0FXe/Bl5A1FLZDfFRmX14pxu6u1FXKYDEdX3mD6qKtfARVw45Vd7kCQGxaiCFTdZquPFxleaWuvTW0WZLqbpgemBh4tXvR7/Wa3mZEEIFhtxL1FkRqnXqwGn7KQJADzuSNUNVgdI9frjvjOglHIuUyNLRXeewzdmEIQJyZWPhyKn1aasXZyMIttrxMSQgTH1Hj6jpEURCwuqGKhgLNiUBuyW8EsAp9DHmmgNjKx4TYw/22wO4zYC8ibSSMgeBurLOfgejpo0h8WPrQzSXy0ywB/btuNeyq7i2Bt4aszhcGnH57JhTqIuySZXo1WKdzaaobWDgrU0aRNf5DBjv93b3X6Hcs0OryY3hKCz1+Eee2f7kYjsb/gge/nJ0e4r+L44vjo3+Ph+c/1d20A1zW9rVBED59Ds7fyhnNwvVqKzSVtfj2HOsO2UjwMFywKgEVbb2XYQv3HGSc8SLjRAIKpW/qn0hupE+uWHwRPhjR717b3AoR46q5KTYWPcQBFDglyE9mF1MIDt7JQzTtVEaiRke/1++1e/vtnZ1xf2fQ3x3svO70ej1SwcI3NGj7wE3K7LD/jYksvNYaInHk21FWes7m3haO9JuTVzrz+6gsI9MTFd85wvPM922I+MQTZceOk0RjpBmLJJLKxaWxiGI7UPOP+fxlJfI06P7ZjUC2b7QvKWIU8furaW/UG81q0c12660E6c8CZ4fa56H8rwjG4ktaRu1KgfpgRHwgKAFPUUHAJrmffHx3ikIfjj6ixEej01FdsASwXKW3aVP5MGZH0cb1C06qAiHUoswZmpWSg9i0oazAcE9ogQIE1YbNodTTPmVWwV8q+rIZe1rZobW4j9chruTMhXByhYAx1ILGij+JxVdsXdkSQCTLeldjExMlDOWvVLUpctFIWl55fV1JXU33yy6Krc2W11XOS2MoWF+WOd+a9BsHbH0DdCY6enbTZHZxqCUozV5RRbWSE1PW8aAhqrW5yZE0UPIsmKrkKEiBZfKoWH/z/oZ8IkKUdp2exkrDfHj9GkzSnj+Q62Ltni4OdQYly+oW1kleLlsrde0Gch4fFwoBQ70qrXKeVURt22mV8rpO9qCHpBXlRjNuuXIqh3iOXBGgE4xMy2Zxs3l9C4hmWQbbRxOzpmWx0+uttz4siGFgb13NexhKJMo6sTazew2OXFp6XLeRTXSwQE2SCsxTBo+qcO83H2uKh9QQfaj79E4q0Z4lnDp11qH7MBG39EYG2HyKdCKcdeciJbhObdtAEp0d9pYHwK/l79Axg/JLuP8ZcJ0EDxN0YSvOfAqTZTdmzbJiX/DJm95Bf2/6Zo/z/t/3dvZfTw6mfHe3d/D64GA1f1nxa/Wlf8SyV/qsCM2wVxxkTwQIlzxt7IpuirAP9yMtbMFmVAmTLcbZ28MztrfPQq5mGT3nsxUhqPbFOTxRWQgeDh+5/oxFfJrImVRrm+EuaTk6fje8+DCGJ6NjqJjP4RPiavTKIOZLFaBaAqmgC3N9SxQ7Bm4hYBsRUhuyw145rK+AIY7d5hJQ2m+Gug3YJ+ZZmMIMt/qaGVXUZRzLTYns5kvKXsiO6LTYBJ9F1JCecGznYacXwF8NIaeN0/YHJ8lXbC54IJKXHTYs3GMeLCOINNhWDQI0XYtgmoEpC0pxdZYypVMoVut7UYqyvhsryUu+KWgcLv97oEvspxkQR2xWrbDQFkei2x+g2UquTt24IjQS6QK8pg9cUJPA1+BOffBMwJtMDXPuCLfLgONROVzhsaq+kdydS0qOUk1jPs/MV9jdWQjup02sFQM3whkf/UxhvRHtRr5NziPBIDl5nOygiu3KDZ9BbR0GW9vd2u7Wdr/SdlcHR67T70Yp9dlppj4Ximcg34SCZyP1SUh7lGY5kO1o2Y1sMayirHTefxqDYX8WCuHFlxiriWfMj2wob6bZxX7Y55P8p7c89Jd7gQSSHC0HU/BEIhgQ3SXFJCgrqt3mau90MpGgoGpNigheM2ELnTEOIksyhf0bxk2LBVoY9UMKpTH4R04dGusBcVUVtGP89XCbSW4zyW002kaj7ycabTPJre1ubffPabv3ZpIFVWQtLk8yWRTxZOF+Y7Dj9qgGALD8zAkrTK44w1TNVhAZK3Isr545eJP+zmRnuu+LvYDvBW92D6Z9/02fv97f2d+Z7PX3vWqsvyztuDCyuk1V9tvuI4kYkrgbyOMyBcplUq2DevsPxJuIKbo1Os+V580g8w41/fPccW/Nr/Q6Bd4AMeSOyYb24sXoA+LH3ycQPcpNZ4kvMM22ogNwnlJKiToMkpYm3aaO29RxG3624ee7CT/b1HFru1vb/XPa7qNSx72HUse9R6SOewxTrCmmWN8ydQwg78DUbAqbUrm5U/x47bqPxfFpuiGQJ3q1LLJ/sOb0htZ4Y2iRJ0um1olUpbjQvQFshLBJDgsA3J3RBq8lIbtFrZKRwJwUj9qFMpJkx8gQ4E0W7eEUrzZYm8n1rVhFKj/MgEJyCqHG3qsGHZOgTmKK6R9goD7oDBz1M/Y4Nx5XekQ/mI2Q4w/IMTv+4guBNl/0f1+vOyVwYg8Mhezc7vWG4wK2Z84VlBHiS2zdV5GCblP1baq+DffbcP99hPttqr613a3t/jlt9xGpusuGNqfqAPDVqTrAdnqsyKXeoXL93zN2MhVHAal3cWy9zMFBCEbAQ5kuaJELSPEPrSoPM7wmjJcN1QAPq7aj4hr/4BYmCO8ar61GAjQR+aE76F5+vdjr0hx7b6R7J4Olh0thTmnZyZIQoPKb1newy7C7yw6PZSc/7av0bcfXUXcCol3jtaTJrRgB2PDsxBUoHdqXRKLqWz9JyO0ukSRQyWG36FzCvZjzQ90LqF2YRdNiYCZODekxnu2FGuQHQ9Add993hT/g6yIJl7+fF4toAy/rxHfvagDPgNIVFpGF61IzzjFht6s39KMMQvhTQb+x2CmC9dlbwROoJuzpmRfvP41fssptToMZspBYV4ChnYGKkBsc5idJcBJFpkRnM3uNZ1g7q4Nmx6YhMMyu1LkQ7PLECeEjxIcROHQSKU4S5ENwVnnPPxA3IsTQ2SkliYoHqt8FCXV5bd5LCpNUT0hlL2DB086VarMjid4LL1oTjGORykN2Ged88QpfTyXirzm2tsXWJmzm5QoVVrSXvj377YPtIwoeGpLWkxe3+NoVfFh8wRPEukoDSsLRUT9h5ee79mQ6avjaiK9Ox5X6NJcQg+vTmPVZzEAIDQN2wvy51kb8gzFUHTSDy1kGVvRksm5x0TZZRLvfq5DUtku2ZRsySqLvAxiGssrEJxjRKaHRtrdCJvkr7SzY/K90V/zXGs/0+BICL0IG2jdPphkXbOOCbesDjKPfXaABYsG2kQfyA1YBDsv9J0/gCK34PYtrrVcn9F2ag6HBB1IJi4kH9sugdHDuE6MBhC5gwA1jQl6cOYPvzOGi+ytVYeWthFUJNukNNcTUFblZeosfRDHO/tH4RY6HZcflVIWL5/bSGzzJH8fvfiOPt/U036OncSkydi5H5duYjr/hO1BQ80kCrqyp2ttblzo2m5GGrgzCXxglt0GFAZRd5b3oKiIgP6X7vehg/LkU1MaIBU8xDW2hkuuInEKcaPREwr1JZUYvM0hAehwKTxkCPmq05ytzsl2b46KK4XeTuWMfGqwDymLRYZ+gslQ+aAhWlXjgGMZ+0668PAclodcRsaNc7yD/i6JMwWroIrKIcdDuB5QzkMbPrA+FIlOJXBaastBiVu5QUOuRhQ7VV0lkTqfurRAVHXxgLVBB49rjIPryRqlXMjISYfGinnoF8RBuUPz2XIT0TgkIAJALisoKP5+MGxgBmXK/yeDbrdwk00VYfAcTMG/VZ7ez0+m1qXLB64/apFAKVpC7d7jRjUb3ooDJgp0creph5R1mT3vvmwtiWH10Y+y20YtSbDVky85Lr1J2woyBDPBe7xxoxsG7O+zGYCG2xMdg0VjqX16XNRbVpiBT/BwUL27byMaLkbtV/JI9+vVxa7nJO4xqUTYXPM/dI8eX40DlDvxQ04hotQPuV4r22L5eIJ9434visEi1k21P6p5pXq3QPxuOD/8J0BP3YrrI9jwSfgsP8e/AA5eFROvY6jIA0fM7L+8gAoxFnCdp63IU9wH2B8D+ByMk+tI= +sidebar_class_name: "patch api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 task status by ID' (update-task-status)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Update task status by ID

+ + + + + +Update a current TaskStatus for a task by task ID. + +## Request + +

Path Parameters

Body

required
    operations object[]
    + +Operations to be applied + +
  • Array [
    • value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    oneOf
    + +string + +
    + +integer + +
  • Array [
    • anyOf
    + +string + +
    + +integer + +
  • ]
  • ]
+ +Responds with the updated TaskStatus for the task with the given task ID. + +
Schema
    messages object[]required
    + +Messages associated with the task this TaskStatus represents + +
  • Array [
    • localizedText objectrequired
    + +Localized form of the message + +
  • ]
    • returns object[]required
    + +Return values from the task this TaskStatus represents + +
  • Array [
  • ]
    • attributes objectrequired
    + +Attributes of the task this TaskStatus represents + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/update-transform.api.mdx b/docs/api/beta/update-transform.api.mdx new file mode 100644 index 000000000..318f30a24 --- /dev/null +++ b/docs/api/beta/update-transform.api.mdx @@ -0,0 +1,564 @@ +--- +id: update-transform +sidebar_label: Update a transform +hide_title: true +hide_table_of_contents: true +api: eJztfYt22ziy4K/gavYc21lJlmzn5dmePUrsdLtvnHj9mMxOnG1BJCQxpkgNH3HUaX/UfsP9sVsPgASph+Wkp7vthudMWiTxKKAeqCoUCl8amRyljf33jfNERukwTiZp40Oz4avUS4JpFsRRY79xqqah9FQqsrESmSko0qnygmGgfDGY0adR8ElF4uhAXAfZuFZ4msSfAh/KBhF9SdS/cpVmYhD7s7Z4G4XcxGVDZlkSDPJMpZcNAa2HUCUVkzyTg1C1RS/L1AQAi0Yii4U3ltFIiRiqJtjFVCVZAIBuqs9taCuSEwWtyMiHh2w2hYctAC4Mofs0DzMERkZCJUmctC+jHjR5BSNg8AvQr5MgU0Lm2TiGXzMEB6EPEhgNwiChvWwMb3snR+1Gs4FQSJy6Ix8mL5/6MlPF9ML3qUwArkwlOPFfCEgoF/jwKcDpnsps3KjjAGY1HtbmFDrn1qG0gaixnyW5ajbSbBZis2kwmYZYQH2ehrEPr4YyTLGAN1YT2dj/QhODJWHeo1HjBotKqrTf2PH8p8+kPxp/vPood/c+jncG3fHVx7FMc+X5jZsP3DEg8gXgERurQn0O8DKIvgV3PPiovKwtjvMUUeCFua8KbDULVDU14uYpIm0KeF6MYCAVaDWKgbSUmMQ+USiixYujTEUZAimn0zDwCEfbH1OE9Mv8fDCUc4g4J+KdAgFBY9QEIgaoKIDmkwiIYdYScSI8ACOeqKTlq2EQ2eNvV9D1ngmgyd02rdEiI5Y0jZAxqdQxVofwIgoAJQILM80AaWYW/ZXoPQ8mgDp4EuexOGBCmgTRaxWNgAT3u/AkP5unx50bDeStEOAcYQnqvkS74QuEIconOHbpeXEeZT0zaPg0kKl6snegPKRW83gY6UfAIiCOf/gBtiZD7B+AfxlPgLWUfnoFXVJBfDg2LOVBmThVB4EEcDOggfBYJlcpQtR9sjcdxxHWHwZJmv1dhsSTSU78A8IryoD9bVCDyFef3w7xVxrvdp88gV+hTLOj4n2ohtmJxGbCOL7Kp/TjWiXw3wgBDIOf1RtAFEIAE+XHk144Hcs3OVBO4BUvrWc1VImKPOZ5ksu9MCwf8FcwGutOU6BznIMUKRWrp/mgwBn8F8khn04JnjxF8p2o71WEeIrpXQ5T8MEmmcrUqs9M8gexly5g/gLzbw3mcZh5EsLHcZZN0/3tbV99UiFSRjuVQTiNgYvagKTtwI+2fWh2u6CfdDsum7m5qXDKXN/HKpMtgFUKOYhBVFQEZ1sAbkFo8VoE3BEGIDKAdMyS5qFozRYSMXwAuaI+Kw86JrkS5WGIa5ORvEBCgHqU7EAuNGcLiLwuY2x5kMZ54hFV2OKAnj/cNMtma4xSbXK+YMFCywsWzLUKvE80d1VQqsy4qjYsQyA6U5YCwIpQ6xNwrq6O06lGsvqu0lOV0Vf1REyshVqqEEL9wGRE9P2VABQMsHwqLamz5nRUe1khqZZ3asuw5aUq0u2umNbS0CLyFQ3QevWVq9g5MmbAOme5lClB4gk4FAGBFxLWeqX8VDNmEH0CFa7QSBcve6aJlzL08pDX8FMc100BfnoCJUB58E7VEJ7GFryDOA6VjOYA7gmaL4YJVgZUMEDGXI8VaadV1S2MRwBAOo5z0G8HqFG0FFYnTQlEYjLDfyNUc2UqgNozM36zDkEVggzVXtDNU3uEpOKhiDRY0yPWg1wDaZYWS+sc6WiwCg1Qay1enKG4lOHLsaS3IWsK34JwUt5keC1nKU5LqjJE7GXjZRjnvjhTyacADZEDWOzi2QRmQlxkAaxxs8tGBcW3lkdcl0NcS6MpiiNI8JsQ2R/xcqlOaaE+o+r9CiyLSmD3tVm9ncLKGcIlKCCyArUXVh1Qe2P8TYiHBwDQUGCFAEdmba8SoNHBowLBBfTY+s1ihP8BAE4ZHrQDE+lli2HXZLkeARqjNhXj+Bo6RTsTNX7CHRipBpm+4FZs6XMZ4f/+9ubt+aE4QEkQl9xarOOCtBJYjqC+BG0HbBnsABTtYJJPgPZBP0R1QksTAGnvccca4GVUIa5u54FLrXnGubP40krsn0ooZafGUDiqGy516bSiKAKEs3en1foMFPkTVOTFBZgUAhVXsQmtbGlSq5PE9Rj0HItBoBloHPGJ7NRLBbEL0hXCKIZKZnmimmIW58IDwxsMF2qwP5GRHKmkL67U7DpOyDvjzwDRqD0B76IJJvIpFUZrZwNQy1XIgwCvI+DvjHlBf4Ey8zzcrjHhjve8+6zz7PHTzm53t9vtdLpPO3udQefJcHdvT3nPHzKLrqSeiuq4yIK+XXustFDY1Svtp8LGrVYuTPTlqnFprq/qwOg5lZrGvF9VkXyY9XrsDVgOE07DG+MrWF10oQfhtuJrlbS8DqsGiIK2Ws/yUNxxZkqHxqqKiRqpz6X7A6VprZnSG3JXnBrvyap6vgqDSZARYog8a00Yx8td7ayKo2ZF3YEaBTXbUft1lmPTeHxWlMgXGIfAzRbnlx5t22NcuLMXuRZ1cxULuurECaJpnulv+43j4+OW77dm8NcUP/ywP5nsp2n77OwM1/c8s4timW3f3z4+btzgH05SOgUli9vd6XTmfURHhSititBrEIxp7qHsG+a4bhgPNi4SiYLFJ4JFIUtB9buuuYLv5GeGNWmJDe08zs7j7DzOzuP8R/A41yWCVfZWruyJgnjM+Lg6PqVKJt5YwBjpgwa5Ii3excmVL8ksqkK1ljywvYaldRFHdncICIv0tmD7nzVnoDZvPOd7NJXK1ujrpyAN0GLXW9tI1iybh8AeTRTNulM9eF4C2pWhHhye9E7Pjw/fnNNouaOzOLFwuNagLRMLRgMiaxiMcm0hBmhKGbfFwsnBHeWUPDAR2GAwApDNgXaBgEGlqCrU4inDJZEBTbkK2iOKyHqSh1kAIxMgwpJAVYyIhpcoXE8J/qGEkta76uAPYHwKpC4Mdh1v0xrD15XFJrLONtkzW23xEtbsJA7TcqBmblKAYungzOjb4mhIW8565W3WNQoMOdBjxTmmbsWmNIPjLrfmLC1rgtjyKibnlBDwCleN10F09RvNzvU4AK6wWEcTtNQtD5N4QgwNTZTGssDZoR6HoRxhR9qDQtKrNlVGv8oKcKlRfKQ1suhdMxsK0iaZtCIYglaGzaN8JJTwo+6NZ3RFd9x+FEctbIB7/yrM3gGPr4IQbYf1/CvlZpEAdQvZiqDBRQd1Fuw/kkkSXxvZylEuKYq2dSRDsRzqAA0Gzu4WNWAQED5zBPdCroSRDKI0q4ADeMduzeQMuTGaMO1LM15cSzRiB0bv4fgPGc0E6hAYZgJoL4FJuS1YG2H1HpDCy+E8vTcHVbcYtq8+A6EgqHpqUBmDKZTty4iCjzxY4WAM+jM5YMvVnrhefoL5wQ/7QrREP6JNQuPz6MMr7KanqfPogAr5AehDcoZrVr0EucWwDDUQkuWaYqGSC7XbJy5EsUIatxeiMZgqdv2KmP2PzSqMbdDJkix9F2TjzcvGo4PD14fnhwePLhtbW5bYPeHVfva1lAlPRCHlCo9Y1NgvlguY6YmaxMnst6XNYt3SnKGyNvkYkSbra3sN6yTXeBjaeUawloQGD9r/ypSox1dByeYoifNp2kYbEaGCjje/bPR8wO3GzZb45RcRxmwviu++Exu9HGl2Y+th+Q/r0rD0KZwuGSNtQIG5v050FvuhgXviKdtqtnqDM4AuYwyGCzzodaYFO48A++D9GV7pjIAZEkaNhl6dK15oqCYuPbBUmFDHhWtFJq8UOQ+4SrG4WfKvhJcFG9ODYQoA5VMgqc4FhRtK31ilJ5aizpaB5ZfR87bAMqhaNTVFmy3Tn7THwFb+G2f00LCdQowl9L+sGaZSty4clTsqv8dUviTGylG5o/IHQeV3ChCsU71+b8GfJHKGrsxMTdJ5eriZI35Q8rAKUinVQSXzY4yWYDwiBrDp833jx3iMHCTg/2eTgHd3HO853ru3vPdvjLGtM6vVxhpuXo82QoIU5hcd/2SMMpUMYwxoYkcFVM89jN1AUu+TR7wn1L/YN/6ij5wE3/SHPuGwb76Rr5z2FLQHMyW/Ku0CptgenwEqffdtgZYdGpd99a++MEG/JkglRqP/E264WMBXbLU6fMg985O5XpAOgTl/gEdb85YRSzKCtiTZPVaBiF7cLELfvxGKOY8Wx+w5k9SJ0nsrSn+XQwR1CVs2veDYXBlNx15phJgOG8ZRGuD2xOY5u1o1BV0b5tA7TbgLLMaIOixu+MES04XfaouOLLodRLeD6HYQ3Q6i20F0O4huB9HtILodRLeD6Mw1Z679Ycy1JUeu67ZFJYC8blb1jOqqj9YxIeMLfTZRu0EIseKMMqccFH0LbWYMcmDhFrAnjshHpsaPRBhm8RIkgibYMi4oKYmIR6QHCAtCYvglqJZpmk9oecZyVBSaOjp7++xJp6s7fbTQcntDYL2kA4a5Z03ZEvH7S1lW8N8vFJktMFZbnAA2VRLhu7KW+OUy+kW0zF9RrVX/q77jamYMoqjWx+j9FgX7b5xv2IH+/+jDZxTvphIsQJEvE78N74s/bPX1Qe9EWH+61eNj3//hh8kEmvtnv/IZW6VKZZP4Hts6OXx78vrwp7O3r85NW8fHeLoAW7RbsdsiW1wTw4mKUbk/i8EIhwUF1Cdq9/Dk7csffjo/Oj786cfe33tQ8S9ikjIHTwI/wijqpvhRRrkEIdlFtbT7/GlHdwC6DpMU9cQkjIt3KKe0WiK2cNEAGRGwq+L2pucBe3f0ZncHASPzE3oh52q304luaQ2xcydAoc1WJKOYYbX6u60bArpRRvRr2oA3iE/4j4U/eKrNevUNDbcab27XtqXQj7CQa6HA/FEXScttam31oZEDOndGG1jsu8G5mDKLpcWBRq2SAOngLNblEOs77Fcny5p0C7RiUIuiURDO/GBInpNsUVe6izIf15y0w3UEj0DDR1jiWAttCzrsZzTiuTrpDJSSz9DLiJUdUF8Q1cwVeDymOB+9XxtEAXiKfeL/CWg6llkBXFKL8Bvgz0rwL9pnbdJ8MEcYNs25yKqNYN2dTqfb6jxtdfZEd2e/82z/8ROuV9Bl0dyJ5Mh8koP09WeQtjAGgd43dM/RzAdpuQbPzQhORXsLh71YqJ5yHrKqPJ2TnvydBFr7+Ljt++J7sSGzjeJQlPgZBWUfB9fuPG3D4HoHoAWUQzw5OO/rVg4PD5vi+PhYwJqzsYEC7RfxDhegH/NQ7ME7ZGQqOYbGhayKTWpRnBybImOxEW9seDCFVxtCNsXP8NenciLm11C4WczlgZyFyNY8D9zGf1I3TRxDVax2uKsmQm9NAc7BsZ6G778XYwZTSuy2Q1MAI5npSajBS4P3afjYUjmBuDroedijmcCGyvkDkul0ChjKVeWfVZgJ6i6U3evudJ49flKttmSR465Lwjw3vbZ3dh+v1cI//kEL5fIm9os2/i/8tTbebVxft/JFSxm18W7naWvXSNlCME4mZg2kg721I3i/n7JVmhr8OdO6ttO6nNbltC6ndTmty2ldTutyWtfD0LqcF9d5ce+PFxcp1oqbWRnpolWSu4a6UPIBF+viYl1crIuLdXGxLi7WxcW6uFgXF+viYl2cleSspPthJblYF7fr4nZd3K6L23Vxuy5u18Xturhdlz/arouLdXFal9O6nNbltC6ndTmty2ldTutysS7Oi+u8uPVYlyItzJ1uTLNiVcpb3NrITcU9FqvV4+I3f3h9XrIbXpvnIdJDXPCBGqJ9UaSeEf9LlNE5pu5hUfe1qYImCtAprmFxpfp3c/W/X9T3iOIVkrnu/7agetn991atZRD8rQ6Bpba9RuUMxgP/fn9O/xxWFbHX5y6pl32xm5O4TuLeJ4nr9s2cB8d5cJwHx3lwnAfHeXCcB8d5cP5oHhy3b+a0Lqd1Oa3LaV1O63Jal9O6nNbl9s2cF9d5cVd4cY9lNr7lBLZ1Oc03XlxTsT80cVaXJtybg8UFj2EBUssDTHHUFDKMofI12CpUEZaVcVmCyutr29uaYVddXk+LEA5eHJan9hq/zu312zimFsL3l+J7q7iOB3mmFCZRfP0/u9d0iAqw719M1xIbc6fwjPBYIju01KAuRD5FW86PryM+jib5PWKmv92vnhrTR0uNPlCimy/8uYz0EdSVnGWdQe2TXOlz3T6yQt8SfKuB3gzaqt3EPb3I4/wEeABXelqY4KRvV4moaNpnCqPRwnIJH0UeBVpAouQxNbY0ZAzmeqDRTH4LcFvVBWbZsVy3zrh15n6uM4qIPlUHgcSzzUB+4bFMrtJbNw8dyTuSv5ckr7pP9qZjkPO3krgmi1M1WjMKZS1cD1Rx0t3CdUKdGNol+ESUTwbsytBOu8JRS4t7Bbx5ZMMaWmL44oyPnpeJFWjak5lujl0d7Ew2aYPou8B7fC3+A23j/dHZW7HbffKk1QXFbzqWrR1d98Om0c5U1L4OroKp8gPZjpPRNj5tQ8WfuOJPumJtfW1cnLlD60623FvZQg38HS/TvMVw+02uBrZyUqAFpkmb3J6U1wQTbFUSTbz/Upugyhz0PAzLEwcwBi+Lk1ljLr1WI+0d60Ql9OKmuRQVOGsr+np7lckF7SMVRt/Q7A+nQmNyvm0FcxDPlDo6WNkBupWCURQn6jBJ4iRdQyhJCnZEy44zOLGIShQabChH0EMei0n8idOMMetFYCRrvsYYRmRk7E9shsEV8o54g9mGTmLyNIOl7CkquyWu0ZePFrrn5Un7Von0Zxe3Ff5N8lBVdyxX8HC0MNFdtGaiuTLo2c6p9r2KAEBPICA8q5FSPvEvLb6f4iuYrMGsOrWVJdQ08VKGXh6yQD3FcT0oTNuSWI9YD3INpJnw9ICuKNX5pN6QtpWWL86mygtk+HIs6W2oohFenf4NCJ/kmImMs1gNlMkwdtl4Gca5L85U8imAwYoDhZKIro6+yIIQpuOyUUHxreUbN/YQ14uftlNf6ch70R/h1ALaTmGxjidnVL1fgWVRCVZiKrO6TqY5M0MwNTrs4ZKiwi8bKDsv+b5leFjmVNOgQNkKAZp8YVGB4AJ6bP1mMcL/AACnDI/wACDpZYth12S5HgFSi0PMAIf7l+S0JeODcIfHEzQy/SLfYyl92FCgrVFxoF2bhltLNY40So+iNSQsTWlTO4Q/B5N8ArQfxte0JakDXVKx97hjDbBmDnQ7D1xqzTPOncVXDsrmn00oZacmQazJUldoaHXptKIoAoSzd6fV+kwGIWld4gITtlI+vk1oZau6d1KQxPU4Tu1cqeS5TxGflEIOs9QBuyBdUb7boZK4E9EsIi0wsSo22J/ISI5U0hdXanYdJ+xAmAGi0WeHx5ri+Ap98VgYc8luAGq5SulhHykdD6a/QJl5Hm7XmHDHe9591nn2+Glnt7vb7XY63aedvc6g82S4u7envOcPmUVXUs8HW3UM5r6vtgC/TXsEPp2BATcRmx7UCFueTBWQoK1KLhDOKMcTPmhRwbCaAFE/LDQ6x8ufyvECFKc+g812S8LyfKA5aj4/efFpnc1yU7iakLypf+s9SaRUMMVROlMGWarB2Wnt/MEEuqFvTiZMpjvnPzf5pLXi5pd9V1OESkwG+pPjYcfD95eH0xg3B27dlhkWQfS38KmFWisnMsy80mgzGxlFqHyZ1Z+cuFyNIjr3dfQB7VvsYMLl8+u4VRgu1e2STdUetZugQ1+cXTa2/ioyS380+y/aAKKAe7O9AwZaPgWCY93Q9LZLvY0Tpdborwcd6spg76JbhGuT+Ut+ocU1n+11qGZVqNBgnVBxQuXeCpVQDbMTedt2zDLf3rrOFRA16IdHW0vfPqCP5GhTT3BD5SqPlKEzFhRNlny3R9kYcGrX1Efs4L3qvgLu5BZCozgKZJ9/sM8EYZ+YCp0C+WI2F+MFA/mqADPoCLoMUZmRQGyblw2QO1sWeDhpetQ1QfTA3EBOBv25ZFAcX+XTW0QQndSYl0D8egHWVw16CUWIH8/evhHcAtLslZq1mDGmEsbIp1LgZXEPlbZx6LIpuoAjy9RkmundKLrsiANZCtppGl9T6eDFh4qo4wZtBtO3K+hULRoC3bx2Oz969Ab0tkePjHvL8FxB40bQYG3uGw81/ZU1rKgon6EepXUg9IPr6Fk5wN1XTSzWNU5Mo8Z0W0DNDDyqXtFVhNGmHI4Dss0sATXmo5FNp2becIJMizXH2xdU51B6kd4mUYy8OsUXh8eHeEasd3GGX096Lxv2lUhVQIg4neR0kvOeSs5rlbhQVEfeD5O8seobtP3D4GdH547OHyqdc3xBD71Jb9gLdSut3ymsgbFdtcDZYz4zRnAKHLatA6qBWsuIAysAwuintCOu79pi9fMR3/LJLZuQDylMwkQTqY2oA9pCCoDvg1BGV6Y+Z9bQboAVSTXmjeZiW7m/u9M3zf2KARj9vced/p8nBMOJnj+h6HFSx0kdJ3Wc1PnNpI6JGrrF6bcodG/tgLSjAyueM6sFkk+RiM3ltRY+CMcYW3Yt+S5murg7yMZBhK8TwZEH2ZLg8kPT5Hnx2fGp49P7y6fTUHqqF4a/m3e+Z915vtApfygB2/hbU3HB7jrhVDUGCSkfUQjNlL54PUwKxtXahi7Gt5VXvc4tgErAq8sG/NiAH//1/9FX4TzJjtPvPaffwuYJqPKf6V3BMPNMz4XWW6P1gW9p2A4ZVFADBfsG0YJVWQNQjfF7//9k6+de658fGrel0DmlHl7kQeiTX7GaOof673a6lC9Hs3U53jtFwy+QLLXdPYpXDLLc5yvWE+Ree3eR9vz1TKQgwfLIr45aOA3DyZ37K3cwlaALQHIBSE4IOSH0ewmhFKZ60XUwtgTyVRhMgozUBTqSMC+MyiJ3Un700diC+0p+s7ShMn0dmy1Bylly6kfdS//jkL8MEiWvBOX/g86ya6XAIrqOy3MSRYxPReZUuLvJ5O2vo9bdKmk5/YYKWSmSw0wzeFXkjSWetgRYCTdM2pJSJP+Vo4aoFYra6rQGeLpLB241gU61DMejItXerss0PXiopMP0r9NXLynUbQqVeVWd6zGlwBgn8fU6B6HLpIebSPPbJFLMeUhm43mZRyJAJ62whB11GlmHZHBGWZjwasV5ESMNPExQzLd+DVBzTMsclAmlLUZ1mqfIZAEk3xhLB91G4ZMOZTIyt6wZ770RrdSIiazn5IgcVj+fedBEhB3RmaQ8ezt8QbAVOTouG9VUhqsbivIw/KrljpONlDMJpMRt2ag2LgmXEsQtdQ9iqctgAIs2+r4q+9Kt5+aLpEokvim+1gSLFjd3JHE+GsPXYfBZ+WZjrfzgmXsOgXiYHzipPs55DxRV+M/fVRh7SOznmKQIu3sto1GOidsrYpu7/h+Ywp8ck7e5Cc5oskpfvoBiOa4RRW6BXyPlrkbJn959WKXT4rzpalIdKMx4NUep/LqcNq2SLKDUhQdMLYssLtKNaDWpWHbLk6bF8tOnfvt0Uo1Ns1Z3oeChcpjev+ypU8xxIfiqS1G3WRztw/Hs0sEzaujtcAjdrTVcuoTGVs9MkqWFm/Ax5RzWotbAbOQhaRo8G0Qp1oQIzpmIot9O7BBHIOJJbQ2GujktpVvdWnD37qLBqsj/lXAKqhXhtJD4S7AKOFWsbbe6KJTsFQXRJ8NQ65DlkeeFAfDEVbiLOKIcFDyj2HQF6UXP9lQ8WTIVvw3WVWUN/Eac67ksZ5CfF1LAQnL/UwtIp3fdX70Lmpu4AGZH3Q+TuvPp1MXnO/J+sOSdL0xY7Kjbst0+2JNoR7+tTthHE0s5egH7XxfsdxEF/4LZOzrggdonRivW/47nP30m/dH449VHubv3cbwz6I6vPo5lmivPZw7VcNyOs6MFaKrEPGM7ZTK8lpcowlCJSHLue3maxROVzH+/FSs45wtm/FRJv3JPD0/ibaNv6tRqDbzVLc2grjiP6b67kvD94lK8OZazrkSFgsd0w1kL7xlrCvuWs0b9otcGlsE7yY6PqwgwQ4SXe53OvGvmZRigr55yTIuWOK2dkUYSUxgQHvszvnj1EyasQWGDIeQ6jkNiMhmPhNP2x5STLqbeWE3kIjFd3+zJALkvY1/dTqGvQDy3Rhj5jTxKIFN2GRazFNyO1yxyk4ZdqVzVfwUz0e6KF9IXp3p8L/VgkPfAfruCto7WZxlTBURDsU2zoFv1VMnBk87znb3hkz0pd57tdZ8+Hjwfyt3dzvPHzynBIRBNKkcLU7NXuzbpl+nGxuBnhd53CXPPadex88bSbO5zu/90W+Q6/kilb5YshqnhFZn6jIfyxYuXJ2LvqQi13xAWuVoCMRW1LpB+cYuAoxpNgllq+G0SVD1OZdSAvuP04PBV7+I1Xmd6evh/Lg7P4Be29WHhBhoJl5gsc32DpxnAtUTfUgjTofy2eKRbfQQDkjphmi5okhRwHkQtO6CG7n1BDbtp2zPCpEZ88zkzG0UDfMeJAPT2G7vHHvU83MZpGQ/sIzEGiaSSrbboFcu8SRw1kTMK//L98qKuYY4JPmmjCreuQB0J6oFe5VRWsVGKw9c2UpA5API19i69LMdrRCm1vMWFBbUUO6Xmbi59X2kFunNr0mhK8UpVL9NpSL04wfsBxAC1LVCitDhil+FERqZcIbHsdZXE3TEDc5DF9M2TeD/xrXx3EoL4adHQig+flGY+cvpopU+U2piRSEZtxMrW5qDNSKkYBir0He863nW8uybv1j+eqnQKvGi+kurTnVd9LiKZw/wmtHjOqT6JYiNOmEJsezEim6h1ahXpx3fnwNhXinzwYE2iRv4r6ke8lM8B3yvwwe8HZivPLP0lLhBAmkcewRAkkfL3Ce4SYpoonqrd+d5AzRwEQKDRAhURc0BTTDHeKZ3kkTaZmsKPVRptZGIsQT6CsYn3eJtcNCryW7yx5zRJp0m61citRg9mNXKapONdx7v3k3dXapIFVMQtWk9K88lEJjOmNJPXD+/EE1AAg0OpvihYjlBV11awMVHoWI2q5tAY7HQH3eFTT+35cs9/svt8uOM92ZGPn3afdgd7O08b9lr/vuTjgsmqPGXhm/HI1zyoBA9M5REQV5rFsV+hVpzeRA1RrFFYg9GbYc7beD9FoTvuzeuOb+IMxoa3ZLfmUjCa9i9OXws6y87N47zxJggyLeeRJKc+qpS0sUJHzp3q6FRHt/y45efBLD9OdXS863j3fvLunVTHvdtUx707qI57AlUsOtH+e6qOPugdqJoNAwxcKfL7FKd0tfdRs32GZ6CyQtGraJE7z+e1yPM4FscymhllKa14IqNyulC8QdkJlk1MWYy3FiMQkRHe7hfEHC4cTBTqpHjOgQ8c+pyaHNpNZq0enahjnilj1nUvOpbdvt8yBhoL8GzgENU/aIH8oCMQ1L+ij1Nj65v8weKUTnbgiOk+Z4U8X/h/Hy+KEjgqAjEY10vCBdhnjpcJRurzlMVXoYI6Vd2p6m65d8v9w1junarueNfx7v3k3Tuo6lobWq6qQ4G1VXUo2+6IQpd6RUGov7XG3rPCavkIv74F1C91cJiEVMFLvEwbO8EbqF8yKfdyTBOE8cbRfhFju8/XPDc+YCTtRAER4lAw/huz+2CFhn1m90vg3zSwC9QleRjVA8BfALuA1Zu2nAZtE24dxdd0CnigKKvG8lxhWED0To60YdImfPBJZZaP1Dhjx1xmUxw0XtmySXxKCUy5maYA9tDkx3lN48kUbI+NlEq3dQR8bXwwroskvPn2sXBDS8ayaPpW9gblBUBaG2KDI6QNRZyhos69z9FFufjgFsHOXGdvsdiOeKFkQudHMWpm88d351tipG+p9/Wp9CKZywmQCIm/nokgwUrWuXYEvFeJ0UF2E8MQBiwuozOlxHtzqfYbWBdOQZDTlGIlRbIDa33YXOf4OczQtqzU26LlkeyIIOKDlvC2fRm1xEGAUgvPplMZPUQ+7/l+asYlrXF9LRB/Ma21uLUWtZZu1aDgqX3vccy3BzyPTcgwpdn66s65vZbVHhpd8AZbrcOAM6HhqEZWeQZrXw1Hpb0WtleF4zJ6R2d5qtUECyxzFORIeOM4TtX/FgJJB9ng/SgHLvpqsOgAUYs4orXTsUBqcZetoAWaJMH3GhgjYmKSA1zJSZGJ2adCLNknzALP9+mAUL8yZnr9PogIasyU8NUwY4ct7LDFMiDV8PN6lvIFrjgGkgNMAC9L/JMk0IBaco/bWijVqfltqoNLgweg8n3Z031+2C8FnMk9Qx+wdFEGxHCDDjbpWDN4FrotXNQqk2VcCPUZnIcXjwpFtXljeIuNUFxf/2jjxRH3Sk/L2yic/dpSeokk+ePI3d9J4jlJ8xAljVaN0WOp/YAvYn92WB4Q+6ajX5UDle/i5Monb0L9EObB4Unv9Pz48A3q9PoI51mcWMc49xv6EFy1wAHwuIo406Y+CKe/shf3FZ7ufB1EV/XPr4KQcvE1/mMTD6B+Uoar2zDIJEvfgaq2edkAs/r14fnhwaPLxtZW2bU+iTorWtkcgd42Tdv6CpK0F4abXzZ6/iSINm62xC+/kIFI/PLdd2Kjl+NFABvY4tKToRre+sHgf8cB1xs6XTeMqRttRNpS7oVW2OddvymdLIZ/4WvK+XBgQsDILXPJ2Q1h/iWTiFB640CR02gKiEXlv4miJZ6QKNbHT5VOSjci5CdAsxLM/CBEROG2hulZksRky4LOGCeUdYWDbGJMYBKNVFu8w5QlMH8J2vAY3g3fPsbamC/OY4oDw+2gdU8meYTnYgFsvIwFZMotIsEPUi/nlQuoIVJmLmLS/YtaRoyjrMEhtMmaBUvy7RD3IwJPNW5PHqX7AsZP9WYETL3FtOVATlXIGaUa6yamMm2DuGmNVThFLwIsu6CB22Lh+Oh8rkVoLNI7YHEy2taV0m0sC42gfczks9vutjstshcxZW6cZmBzW41fTFG0gGFhH3ytUOCXcgemccrptNPamWhzzUeRDpO3zI4OShItC9cdkvZR0bZAbYNeX1o8h7fVoreSLqfNiZDboseX/Qa8h8bkpymg9FyKTfUZtAoaLbSCdHtJbI6JdXV+IMzDSDt9kd5MuYx6Wnth8Mvj92DHKhPFltHBVnOWmmBANYqOKQC1tUvhjXbu9hT9uYiDnO1u9m+8b5T+DaiwzxeujAFN+O3LF3T3ocV/g69hntCX9P5DacyTEwTICH/71kHlJfjb1AfI/a3iuHYtd2lO9LAMdiMgo1nprGrAzyuFPi4A/uYDlGInJIHGH/SuV+t8RnqoqTi3nYceD67Bjs2VZW2X0ckFsghSEG12stsskdco/OHf/cYl3hbRbHBCB04XgO+/NIwTGspws0bfX6Tu6h+AASj232Bp/Ho= +sidebar_class_name: "put api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Body

+ +The updated transform object. Must include "name", "type", and "attributes" fields, but "name" and "type" must not be modified. + +
    attributes object nullable 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 + +
    + +string + +
    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 + +
    + +string + +
    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 + +
    + +string + +
    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 + +
    + +string + +
    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","enum":["LT","LTE","GT","GTE"],"example":"LT"}}>
    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 + +
    + +string + +
    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 + +
    + +string + +
    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 objectrequired
    + +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. + + +
    **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"}}} collapsible={false} discriminator={false}>
    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 objectrequired
    + +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 nullable 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 + +
    + +string + +
    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 + +
    + +string + +
    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 + +
    + +string + +
    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 + +
    + +string + +
    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","enum":["LT","LTE","GT","GTE"],"example":"LT"}}>
    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 + +
    + +string + +
    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 + +
    + +string + +
    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 objectrequired
    + +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. + + +
    **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"},"additionalProperties":true}} collapsible={false} discriminator={false}>
    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 objectrequired
    + +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/update-workflow.api.mdx b/docs/api/beta/update-workflow.api.mdx new file mode 100644 index 000000000..6cc777508 --- /dev/null +++ b/docs/api/beta/update-workflow.api.mdx @@ -0,0 +1,127 @@ +--- +id: update-workflow +sidebar_label: Update Workflow +hide_title: true +hide_table_of_contents: true +api: eJztXAtv28gR/isL9oA8YMqSLMuxgMOdYjs9H5LYteWmrc/ArcilxYQiWS6ZRDX83/vN7PIlKbHjyz16FYIkErk7OzuPb2b2oRsnSVUm8zCJj31n5BSpL3P1JsneBVHywdlycnmtndGlUz7SztWW4yvtZWFKvdDnVGVBks2FFEERRcKQEEmABx9sr44Qk5myr/zqsUimb5WXi1CLTOVFFuNdGIscTTOl0yTWqgMetPKKLMwX4OPGudAqO0jiXH3Mx0U+I950OiopjuYyltfKuboFm6nM5FzlKtPcM8YXsBv6IBkS46lE/+XZHPvEOrHQkEKm/l2EmYKE8qxQ4ChfRERLh/MUH7Yc9TGNEh+PAhlpauDN1Fw6oxsnX6TcMs/C+JpbSu4zcrze3lTJHenu7g18d7C747n7qjtwBzvD3WAa7MqgO3VuaSI0vNL588RfEMllbjwSR5zTK5mmUeixPrffaprQzSovRurgJc1I+3moNL018lnluC0f0iO1LKX0oZZSPbVzFfviaC7DyLndcpIPscqI8iql0AfjUC1IyVygoW4RtXbDBB5pAWbnodborslOjg9fiw8hTM4nJc/DGB2JjPRybtKkRDYmI3yAieUJUSKbBf0Toq1nYSo8GYupEt5MxtdoNV0Ye4UQmBIzQcNKcXoxEUkmTseTgx+EVU5nRZ5GjmssIC7mZLbHh0evJ8eTf5JH1aKrnq4TPJEiwVu/YaGx8wQqU7EHk4C4YeD30mIRh+AcUixVWdlFzU3f2+896z7bHT7zdvv73rDbwydPDoP9rtfb6e3QeA+zmzWDvYEuQzkX+J9M9/b2donIXWMc1t9oGDaGlhFIz0swWKhnUNGKwUL/imyWDCRvGueHWQLrkzlGnRa50qWNdBzmMAjjcInBanarQpjLlJjTuUq10WCLRTZo9RGQl6tVm9K5zPIvFzZ3I0OmUTufcFUxgRnTjJi1uydzAn+DF8yTTDFdq1I7KRJ0FmrY7AwW2nDo00hJPNZKtVBW+IlXzCFwBi9SQdnix/OT18KAmIDTCiW9mRmQ+KPZSN9nBcjotCEtA47VTG+aqERQ6VVRDwFE453L2id6laap4ZRhFzLFPAhFRE5y2nKCLJlTZ/RJkzDOv68+dTB5jhpemIaY0rHf+QYtv+mUFtXhIKQLI9iRk1vJx4hq55gZkS08T2nN4S9CqzOliwhtY8TYrVIz44PJ8clr1plt3jAN++SW/QijGh+z4j6srfaWIElOI9XEjWmSQE/xitKPuCXp3Q81f1zC6ypRIDyNk5whNVMc9wk84WNmMDJKY+LwIMlzs8GzUhl/J+az8PrahJC7/cs2NlbIhq+XA1UdQC8NwZbKr74UyI/+DsjG96N/TI7OXo9f4uP5wQ9Hhxcvjw7b4F62/AzXNMbtsgkmsToJOIkp9Xj0HpYkJrbXuG69dYeI6qYIGxGrBb4GtRxb23wNXzyanAtFIywJC2Z7dbvV4OIjAi/c7qsyokqipdrbPHC4aXFxDmzwCzKpr8cGA44hup4NL0vic2MJnGy2qVaotsoRgsYaf7Tt1r7jvM+4cZkWs1X0u931WdWbdn7tfEGKiByptLTPJov3STIqNo4PO6KGz4sLpBzXKqa6A+ItMCGDEOjVjk1+v9vzdtW+6+/sTd2BDAJXBr2BOxwOeoNgZ9/fHe4zfHG4RPeDpIib4RFYrIzqKNuTuXm0018fMIv5FJqikBnOlW4HLjGTGlCm4jI2+y1W++AiAPwXmfqVeaBRIDW/IJGLauYtbrrgxmLuOi1VfFA15tJAa3nhMk4iZFKLpSQFjNgB2hrrd/t9t9tze91JbzjqDke9YWe4M9x51hsM9v7llHwl98DyynpsD2RgVfi8d659J8nDyUmVRtwzMb9niv0Z/skhltLsPaTZcjAMpPSVGiDNDqYD1e098/rd4aB//zR7zagI1GkkF5wQtod9FSKRVZGw/5tcgZF1UyhuCsVNobgpFDeF4qZQ3BSKm0LxIYXiQ0qGteGmLsBqAYV+PCqdxK1l4FrAJckEYYRoTw5116gMHLQbADxNUWJpBhYyCwbZKJyH+DhDlmQmq5tsmTYBZi6SuMXjNx3Djb787vH3nYpJ8e234pHZp8gePblybMr1u5fUD0vzxqW+OIwQ7JJs1gxYy0UrmXkzF6WFC78Pg4XzpfF7TDhOMC48sxUk5DQp8ruHPisoLTMMcG1jGCi3nAAuekkfv/viwrJaGu/uoZz3Mgp9cXAGA69tm0VipHSYeHo1415qLxSJm5gsMoREZ5bnqR5tbxMruZx2rous2DaFeCnorngqnm7v4O+ueEoi/S2WSK5WX9ioNli3VHIQUcwVR1kGq3XFWbUFGVh74HxdUFineB7GLMzOlyynfL6QQjmCTOCANw7vUuULVC3udSZD4lAxyx46ClB8H/qUsnF+ZUiWyMnt2mkcJNHpiefSx3zN/A7sZDh+Su8daB3fA6ovjNuXXZAE196/OqzaU3I67O73B8FwIGX/2aC3tzvdD+TOTnd/d5+XceawNoBiMzeRWSYXK0P/lRaPQk9EiQeN/AcCQd4A2ZusjwanLd5czdcmp20dMI17liWmbTVNy68gANqCVz8/OBWDPREB8wt+Lq+XhBC7F+d4QqkZpTYm9cTMDeETGHi4Fv3KBOLw6MX44iUlBmdHf7s4OscnorXiW+MY1uqTWSa8mDSDm+X1BGj5xiSLKE3EU0v1KSYkbTVsG4bmm14gi54Lm36hhx19TY8maUGJb8uVSrR+HHZUZwsZH57NZQ4sniLV90ViNv+fjpGRprn70kryqZgp6avsSUeMqwyeoA1E0X9BqSNS+/r0QFDAlcFMmM8oLBDIe0trH7Uo29qoIeRlUynkHOD8HpDr5QUFH5pm0wsra7EsWv2AZyO5NneThtBYpAsALeoQtIwWEGOWUVkPsBQhshELR6QuDeCJy3YVYjUhk+HulWHmME/4nScLfQ+/O40APy5PrXrxXlnn07xcwmjE2ijVZBHJlsrc2baq1FU6PrIoFfkb39347sZ37+m7yy/P7AaRfcupT2819bmIZQH5Zhw8V1KfjK0nRqZqG5mlFqPILarpbYr045sJHPudiqk98kXKX79ifmRC+Qrz40of5vm0XHktQ3+tC2KQ5WhmYDZPRsx3zbFZ9mZR7ayO9iLJpiEMNF6TIgI1M7FICiEhsqyIY+JE6i3hJ0rHj3Ixk8BHyesrBgFpVNQ9ZvVnk0luMslNNNpEoz9NNNpkkhvf3fju/6bvfjaTrLhib7F5ki7mc5ktjKXZ9+bcPxpUJ/jrDVxW1XK2QsRElWM57czBmfZ7016w56mBLwf+cGc/6HvDvtzd6+31poP+ntOM9Ze1H1dO1vaphr6NHlnESOLeI48rYhiXzpPEby//QbyZCgjWePG2zJshc4j0qsod+/trTi4kiXgl40WZIelWDhnXMiJMQ9s5tc3KtnyE4Bq4GNMxhDDxy3NBoEJnp8zGBDkvzQJ0s4U7DnJMxTjK8l0KfPeiAhwyEkQJZc0JDCukvbeAcj5Q4Az2Guj8FbNTq6JflMmLM5rxS96KOfroKUWOXmXuu+vWd49juxNwbhT8iYVeU+3IGAaAgsBgVpV3bvLzTX6+ifGbGP/niPGb/Hzjuxvf/d/03S/Iz2029On8HA3unZ+jbacrqlzqBZ/A+q3TdHYVywGbt0g8r8h4ubnMwTmvgCkRQ2nBGEIXfEfOdnmiS2/fhP6tQyflKCE0vLSPNNxARVDNbUemYXUKL04+0Em97SnksgZyzHE/MhdqIManx7ak6LBQs5Ds1oAcEzcitkfZ6mOBn6VcHtJcJAVgjcls0Rkwa0P8mE5SooB4pO1Rb3OQZWl+mNdFFt3+8rkYQp+YyzrxfXY0tBfgdGmK9uBIeQGczuLMzegr18DrCEIV2urtihNq1hfPlczo9BxvWjz+8c3kSfMqiuY7FSEVBXR6GybCGDYuF/CpE4eVLCmuZ8z4uLVFQj4jzAHHn+JzpcRl87TcGdCYRUqdFAMA9bp6XGrHV+9VRHGv0zoiuh368TYktC1b/Z5wjONiIIzNpQ66CfJT7IrDkKCHD7dTGztFru3EZVrOSzbm9VAm/lJScw01l6npJ0tcGNFeeubIjQfHJRIy0iytBw9u6LkNelQ54QlRXeaBJGH5aG9seaXWHsxHi55L9Np8/BS/4eOD7W7C4JXQiH+RL46FN0sSrb4TgkyH3ODyuoAXPZgtPrPoske4/W6DJdcM6YYu0kHm7yUcIzbGZM7ScTaSIFGLfeOSP7Nm4fM/88m5n1tz5seXiJrU0k88/WCeaUCXBnQNBmjLvwlKZFjwbfNTFHQajg3goNY/I4FltIF7htZaVGfy29yHQoMHVs0R+nRkvoxqgLOfBL+g1lUbwDBl09VWH74LS4siU0tY5TrAsgRX+Y0SBMQluRl+q3UoCpJ/tPnSjMf1cslJHC2+Nkp/Akn+OLj7OyHeBmn+jEhj81tadjyrfwzmqL6yYn/cpnFzpXGdzvpc48YYncW/+85WeWVr5cLVsts+9FbU8qUoe2tp5a5R46rR/+3dnMblG3v9ZfW2S3ltpD13VvZdFyaa9yW+5OaCQxDILNjitAm8z20NsbqkzPe9FP7FW44fXN5BnbwcwPbTJJRGMucfmaJI481CxYtRqZI5iWSL0C6Zc3RIs4QkBitjQtd8oyiDG8lITsOI9EbbJeXIkkHcFDuENfTdqpTGMmLoiDdKqNgDVNDaAB34wbu3iV0kOIfJnJLJiMMSgFAIzOdFTNYPtos5rF/chVJ+qL3CBFMviWNVyiLhcqTqVUYWgj+aQoer5GyuTwLa5wg91QCjO8YCFmm7ySG9vIEj9UTO6N4CBTRn+fT/XbSBgO5MRSlZNjIBFAVNpHp1PFmhCGKxxrw81Umy623bSW9TWxChkt2Yz06n1+m6XMLieZroHFbZIH5hfoOs8QteS9dLqm2dX//Xy6xrUqW6ndKyKrFcmMrZLFBcOtUCBdqPzN2pGSZFr25uaNGNSvZbegzspxWdy6u6GudVDHvJrgaHT0748Zm9aPJErP2ts7X8lovF8aJeJ3Lw8Z1aMLbQIgx45vU/5se8sBtO7sTcnSs7ruyk0TqF6WHWFD/b9qqxznN6QVY0tT+MNjcrVpnku3v4d+T8hD8UClNjw2jEz2+ccv0Xbd5Wl4jlJ5JU+wFiR7P/AgV7l70= +sidebar_class_name: "put api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Update Workflow

+ + + + + +Perform a full update of a workflow. The updated workflow object is returned in the response. + +## Request + +

Path Parameters

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. + +
    oneOf
+ +The Workflow object + +
Schema
    creator object
    + +Workflow creator's identity. + +
    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. + +
    oneOf
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/update-workgroup-members.api.mdx b/docs/api/beta/update-workgroup-members.api.mdx new file mode 100644 index 000000000..e29228313 --- /dev/null +++ b/docs/api/beta/update-workgroup-members.api.mdx @@ -0,0 +1,91 @@ +--- +id: update-workgroup-members +sidebar_label: Add members to Governance Group +hide_title: true +hide_table_of_contents: true +api: eJztW/tv2zgS/lcI3Q9tg8ivKHHsA+7gNmnXi7bJJQ6KQxLc0hJtcyuROlFq6g3yv9/MkJLlRx5N9+52C2OBriNRw3l+85Gibj2dioznUqth5PW9Io14Lj7p7PM000X6QSRjkRlv1zMiLDKZz73+5a13YUT2RqtcfM0HRT6Da56MVP+mfKx/A0OFd313vevlfGpwwDv9RWSKq1CwdzjGeHAzEibMZIrTw+SjmTRscDpkPIoM00ownbFEZ4IlVg+Wa8bZqqQGYwO481kodiPzGUrYZSdn7/41OPow/Mg4aKhRdQbSM/HvQmYiQkkhj2OWuzkbV+pK/Y2xnZ23Oo71jVRTNpEijpiesGEkVO4kcMU0KcxjN0AqkCJItDB5Y2enEqV4InZ2wHspz+Bnjq5E/+F1sLfyF7h+15PogpSDO1f9MjxCJXCONdNhbGmS18+zQkCkwplIuNe/9fJ5itOYPANrYKT4ypM0xkudsNc+bB3y7mF7r9Vr8VYbfgXtTrvX7okw5N4dhs5Z9FpHcxS3rNR7aXJUS1rfSEHRGQsMnvXveqSqOMbw8CbdQ0wqleNsPE1jGVJmNn81OOVtzbRv0gWyKBMJ6PJUtZzjeJbxOUYmF4mpOVSPfxVhvh4mlyUvDBtzI0MWiZzL2KDENMM6Q80WctYDdK+8o9EJw8EoSqgiwYIaHh1/HA1H/8Q6WkS2unoHekdPn4QNjxorKdKFFOHBwYTzSIig1T6YjAPRah+GndZB0MEJbB5/gx2RNGnM5wwfXJ7ugwxnXMTM/d9ABt7V7l9Wk1QGWvu84CDgojuedHttEfQm0bgbHLQOeEcE/LB3sLfvlWp6gyiSgp0ngBEeIZPMaerXRfx5FfHObOqjFneYpibVytjgdVrd+zPQJhxXEVM6d3/VslIqSMDH8++ZZYCG4Jz3T3DmDPmWJF9OXZtTmwIMYJjVinCOuDhGjezkpFiJkYvpN4DToxGFiJic54VZV+VKjQAmfxqNTlkZNGbHslBHCNJ5kSkIygRAAaBcqkh+kVEBYO7UzGc8LzsFqFoOhdzBKVhUoL4AIuPS2VUDpRbCnj3/WtDWlIhELKqJsMV0Wm3GmL/cn2zOYaI9nGdWRNDqrYuIM8GjeekRiOl647lSD8YQNMMwLQVnNVY/FQl4AKfi47hyU20M1RHWApeKnO6CAM4KLfsAO8ExCbejx7rImSnCUBiDoD8B9C0gDEzk4WMKoy++w40XimyA0UbkzIHITKZL7OHK2+sEQbQ/6UStIAi6Qe9wv9Oa7AfhQfewx8Xe3pXHNk145U0OW+MxP9zze4dh4Aci7PiH7fDQ3+vuha2W6B0c7I2vvL86IhKTQ2j+MpbiKyhr0AsW0Mq+i8zNq+qphooriAjgOQSE8FZA+akQXNYrJca9PaiiDo8g5N39eiIGgq4l0DkAD1qt9fx7E0uYlx1nGeSKD9joSlNO6nyOjYH+YEZI9YXHMvomfH4YSy0/eAO48HgTfSuV8KcZVAJoKEhlAhSQCPiB1UFE2Yos6SKNW+6z4IlGm73mEXMtjr1xxoCb8oyHn0HW8AnE4UJJeJ6VjwDsE0bdM63oCj4+aPU6wQSShXcOg3Z3f9yb8D3gn/u9Hs6eQNnyaZ0hVc1peep3QokM+FWsgcLL3wT2FQ6+JwVo8qf3M5LxBP8jrNuxlZlOX4ZAtAsd4fWbUxZ0WczVtKDrfLriBOVfnCMfKeIY4cKyXrDcCj7J5FSqjcTdUb6j47eDi/cjuHJ2/I+L43P4hbLWFlID21ggLTXB90zfkMbOgBtuAKZicIeIGmzHSd0Bg7gy9YHS/mXm0IISyK0JL+IcnnCzb3iiLppNMp0slVKJ2i9lQzR2gaDDNQDvcIaEGYm6XUntDADC09x/7zy5w2aAYSJ71WCDRQuAagSh8Px8wfTdUmxSQCkLWg1iSwAqJsMVvrlw5XI0FsDyvh4ULA7Q/PE8GYQ5NnMys16FVbY4FV18QGfruWXtRjWnkUvn0ARDsAKWrHNwY5aBh4GCQAPMDXNwhOEyADyqHFchFkJgaRbB3QerzFGu6V7IC/OEujuNAX58Mq268UW44qMll0UjUe/UDpHgJppND7tRVbjKwrfr6W3tbmt3W7tPrN3VmyXvcXeJ+rTXqQ/QVbsrhs1zjfpklD1Kl1tnv1l+bQO5i8zaUaSfP43cxhuMF19TpJS/Iz+yrXxN+UEVD3t9jPSjCtZSLFBB8qO1ABcEIuqT3guNyVHWVXvrs73V2VhCgqoNFBFQM2NzXTAOLssKZVcpZpdFWhj1ImczDvjI7YKEEBBnVZGfalhZbJnklkluu9G2G/043WjLJLe1u63dP2ftPsgkK62oWhxPMkWS8GxuM83dp3cgDAYstr+rkqNQrbIVFMYqjuUtMwdv3GmP25NuKIKIB9HBXm/SCQ86fL/b7rbHQafr1Xv95aKOqyJbrqlavG0cycVA4r4AjysUJJfJtY6Wt//AvZmYIKzR28OSN4PPcSOy4o6d3jp3HGnNPnA1LxmSWeKQauEjxDQYm+DYrBwLAzibAi4qBlAlNb2KzmUiQEoGScNimUgqXrQC5GZzfzDJwRRbKIsX024WqcK4AA0JCWKNrFlDYkkwUkyQ84EEYrBTQOffkZ26EH0Xk2dnaPF7tJgdfw2FwEKvmPv+pv3dISifIUac2wDfs9FrVztcQQLAgsBiVsU7t/x8y8+3PX7b43+MHr/l59va3dbun7N2v4GfOzZ0Pz+HAU/m5zC20WIVl3qLyfU/p+lUKk4DSm+mw7DIaLu55ODEKyCVUKFUGwIRPE3Z95rVQUvTvK0durxrumMFTTzM40Ny4kkFIotWzyKL4fFZnqem32zeQvggbHcNnspGecpJ6ZtGqJPmGHy2AY7w3IAtPRxAh1vtBA1yeCYxpy0AknDrfjIRsxfCQFvFD0rG420Y17kuAPJIzC6eFnT5RZdBxRQWFy+MO3qH7lqzD+y6yOK777fFCrrHlk3ue3A2GM9A0xUT0YTrxbnkc2Tidva108mL7oKrt87aZCc4rMNeC57hATB6ofHy50+jV2yK/JPqvzBIfYXEBQNU0CmkCOHboNzcx4eo5UBuTWek+GDp9QnWE5vEYDC7UudCsMvy3MtHAP4zQGpyKT4kCBzwqeuXZXQi8UXE2BMbC09i4slINcFDTb703Cvqf7RQqB2Ralwpnx1JhCU8H0RjnIn2UNtlWtrFa3Y9V4m/lNJ8K80naebVihbWtZehPY4TQlGjCB4b8tazJ7fy/Jo8XFXBFZS6qgN6wumx/NIrLKP2bD2W5Pkob1mPK/VpJqG5Lj/GLJYxA70xjtiQhTOtjfg7Y5g6WAaX0wKq6Nlq3eCkPlWE32nVVPLtlL70gSqSfu+hMJRNJnvGjpiKBhKnIluSv1BkoeZ/oTN7vyzZTJcvoaPiyEiH5tk644Q+TuhbDDBOf3fQ+hWd8UMbCAdsArxZxJ+QwClawz0rayOqk/gmPYOtIQRVSYpJ+/aP/gLg3C9GN3B0NQZgGJl29RoQvztwsrBrLTmr3CNY9eC6vrGGZrniN6tvtUeFDfSPZi9aPFhspZyoeP57o/Q9SPLHwd3/E+JtkeZHRBrHfXFL8mzxwc7xf/PLCUxtMtEtSOoF9dpxw/VtRNznngn4F+4SLhClhwWT/WwLGVNdUBrzHCuIECScSUEbEKngOfLMXcxinVDVp5lGqIFlJgmaZjAGIMIA/+VjGYM82iIvZ+ZUnJbEYg7h36agVRB9FjaDBa1osE+wJlQhpACuB/GQB9z7VbuF4TlkwSkmETsqEwsIXpIUCs8xg9pFwjik7yPZF0kTFhYkYXmoROkLTTSzeqpEDExrNIG+nxBZYk4muLcNy+Zakj0yF+SYcRvb4HqMogvywpCz8gA5jFteIjwmGzLbn4k4xRUpILzAE9iLGT4MR2sSQZgyYBes/HU2bbqHTBPHghBcitn02Wu0Gy2fliZwHRd4sIauCYccrX8muHqCfDUdbxdb+z/wd4eu8nEp1ExxTw99V9ilmV0cXy6+QsRw95e/SUyq7z+rFTKU/wxX1/Dk7S1uCOGS8Q4vgxq423B5vVgNEvxAcuBvgJwJQKN4IBAvz5ybXrGHv3ncaFe5o6nmi80MD35+FrgHUjfs7hqG290q0tCOcK9H/NGc+EwpYe29D66c7RN2B+zBsde1XYnTE9wL9Mbue8rEbrBk/AYu4r997wr+gz9soAn/6fqtV25XwhgrtySOm3iT+wGRgGH/AYFO3z0= +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 members to Governance Group' (update-workgroup-members)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Add members to Governance Group

+ + + + + +This API adds one or more members to a Governance Group. A token with API, ORG_ADMIN authority is required to call this API. + +> **Following field of Identity is an optional field in the request.** + +> **name** + +## Request + +

Path Parameters

Body

arrayrequired
+ +List of identities to be added to a Governance Group members list. + +
  • Array [
  • ]
+ +List of added and not added identities into Governance Group members list. + +
Schema
  • Array [
    • 201 - Identity is added into Governance Group members list.\n\n> 409 - Identity is already member of Governance Group.\n","type":"string","example":"201"}}> Identity is added into Governance Group members list.\n\n> Unable to set Membership of Identity \"3244d5f2d04447498520f54c6789ae33\" to Governance Group \"f80bba83-98c4-4ec2-81c8-373c00e9663b\"; the relationship already exists.\n"}}>
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/validate-connector-rule.api.mdx b/docs/api/beta/validate-connector-rule.api.mdx new file mode 100644 index 000000000..beceab64a --- /dev/null +++ b/docs/api/beta/validate-connector-rule.api.mdx @@ -0,0 +1,88 @@ +--- +id: validate-connector-rule +sidebar_label: Validate Connector Rule +hide_title: true +hide_table_of_contents: true +api: eJztW21z27gR/isY9kNealK24sS1+6GjOM6Nr0nsynbzwfY0EAlJyJGACoC2dR799+4uQIqUFCvxZXp3GY1nPBK4WOzrg10IvI8cH9no4DI61EqJ1GnD+mUu2Huu+EgUQrnoeivSE2G4k1odZ9FBdMNzmXEn6ik4I9qKMmFTIydIB1R94UqjLOMsl9YxPWTS2lJYdivdWCrmxoKlOhPMaTaUd1tMDhlX0+RK9WDoF6GIkJ30f/pP78374w+Ml26sjXRTYMSM+G8pjchwdsrzHNjBaO/0OAFB8KGw7rXOptHBfVTRRgfOlGJRzvOGHJVmwCPVyqH2MJ9PJrlMSf/OZ4uT7iObjkXB8VOb25kuTQqWyZCHm04EjOnBZzBTkMsLchndCGNxylbkp6OZJwYN7aSwyLiigI+BkXVGqtGSpdGSgRjNXBkW6MQdLyY5Tt1JtqNZvdZaluereBjyKLuK3psE/rO/gt+MdR94If4ezYC7k44IG0aYzfCBEXailfV6dbe3l+2GC1rHXWmbKjyxTORyJAcyR79zjKa0DlTjw+6RnmpF77+94+FJP4i6xn0oq495x2Vul73nCVYYWqiyQA4n/4QvR/3+SR8nz63sh2Zz1nMe3Bg+hVnSicKu0igTR8Zo84ZmrtEgl8pbLy8LDMNCWAspv6wJEc6FkGDtkTArQwZJGeg3EIbdjoUR5EnKe6bTtDS4dkPZ7qwWYP0CPiiQ+FuWeDnzqpFua+Oes8b3KhI98wZktbKiLwp9IwCQhiCMSglHkkykZjpxTyn+G5mxLug89e6qDDnMJUQ5IwezmHl4BQCUXsiAeWwAoIcAKRWBWfItCbIYLu048PFIWb3Wjm8hEOKR4RIlFCQyYSxwvJEZzGCFBtd5lpWdiS5pGRcskeyw1zwDfb1+h0EZNKrh6S/ACzeldQJdKAnzWTWFyYwNQagvLCv2BB+82t7v7g5f7XLe/dvuzt7Lwf6Qv3ixvf9yfz+a1fmyKj/bS/8klDAyZbmGjUr+CgYxgoPtSQBavJnSD/uAeHyF/SkZibZWM8jLnLhzW4Cjrw9P2e4ey7kalTTORwtGUPHFGYyoMs/5AIdw+wTNPeMTA8C8cneqEO7N0dvexbtzGOkf/evi6Aw+Ia/rRWF7CqI1w7AEUSEWxvqWJA4K3ALsW5GDOUSWsOeB63NQiEN50SCU/pudWjAmxNaQl7mDGWH1FTOarNnQ6KKVSpQ3d449lYlIttgAxwru0jEbcAsTtEeE5700FRMXvwuWfM7GgmfCPEtYL8skKslzLC2w+Cn4FBgxnmWYup7BsIRUFlTu6NIxpZ1MRdsXc1O2vTFHlndNp2BygOTr46SXuhKEIzWbWVhHSxAx+Adk9pZrS3feMBqZdKocT0ELKMymYEbA5BSQCXSTzrIAR+guC8CjKroasZqASXD33gvzxml6lvLSfkXeneYAPzGpVj8goMbkswjTHo3IG5WbAiLBQ1SbJgeq2l1V4kP1I/Jsk7ub3N3k7lfm7uLDqu4JT6n02VkufS5U6P1w81wqfQxFj9JVg/grlTfBkVsMDBJKpJ8/nofOEujF3QQr4e9YH/mtfEn4Xu0PPz7A8qN2VssXKOBNXRSyISCRyA5I7rnEvqQkU71YXu2tNgMJAapWlIiAmoZNdck4mMyUSqEk3G6xTAurnjg25oCPHDLCWo+AuKrK4omGmnxTSW4qyc1utNmNfpzdaFNJbnJ3k7t/ztx9sJKspaJsCXWSLYuCm6mPtPActeUMCFh1Qs3qlCNXLVYryIzVNVbUrhyiQXdnsDPcS8VuxnezVy/2h930VZe/3NvZ2xnsdvei5l5/Oc/jOsnaOdXwt/ejPyUX5gbquFJBcFmnddY+/gPzGjFEWEPoqetmsDmY9LquHbv7K87gtcbffaZVhWRbNaSa2wgxDWgLpDUVLRBwNgJcVAygSoJcGEqyEMDFQNCwXBaSkhe1AL5mGveGDlTxiVIFWb2KVGlegoSEBLnGqllDYElQUgyx5gMOVMGOAJ2/Y3VaHYT/lkqe9VHjd6gxO7pLhcBEryv3l6vOd49BeIMYceYd/IWDXt/tcAUBAA2Bx6y67tzU55v6fLPHb/b4H2OP39Tnm9zd5O6fM3e/oT4P1dCX63Mg+Or6HGiTbVbXUm8xuP7vZTqlSpCAwru+mTCvwfEyjoBB6aa0yAXU9Yc+lHtQtGNmykwd4B2XuKgvY8X17ZcDQDeCpAeJ/GB0PbtGnSByUf+JtoRZHJeJOjV1jHxsp3EJyvca3gqlyYF67NzEHnQ69xAcEBSzhE9kApgJ8eGmSt8mqS46A/DICrDDWwk+sZEAL2uFZiYhdxqJGePhlZh755IBMTfAyXQQ/SBnxQuKmqkuAVCJzRaD7ArRS8Mg4gRalyeWqBOK1iX9QK8Lk89+uy6e0Rd0WWW+B1cDegaSLqiIKlzPA+oM63y/+lJYzfcu7A27S4udIFmXvRbcQBPify55+vPH82dshNUtoUtpsbAWEtsRyM9TCBFCz1710wFOog3N6HI0JsF7rR9nMFvZMAeF2ZU6E4JdHgcjfIBtpQ/7AJkUJwmCHpx1/bTyTiZuRI47bjK3JAYeJEMHLNThrXnPaHelNkQq+FjQaHKlYvZGIuhJrBKQJqhIXSW7nFR68YZejxXiLxW32HOLiZt9tiCFN+1l6i/7pAAZyILnlqz16MU9v7jBD3s2GEGuizKgJYIc7Z/U0sprj5ajxS9Gfm05rtTHsYStuz2NeehiFnbePGPHLB1rbcU/GMPQwTS4HJWQRY8W6xYXjSkj4u52Q6TYLxnLGApRku8dJIbywcQHWAhQHYRXWFXmU/ITeRZy/hO06Rn71NKZhi9hv0bKTKf20TLjgjEuGHsMsEH+cG0QhIXcRh0IB3wAHM79T0gQBG3gnue1EtWJfYfm4NaQgqj+puPkwH85mANc+MToAVLXNADDWMfXPzLi3d3AC/fElrGqE4hFCy7Lm2vYihfs5uWtT8Bwe/6j6Ysa9+YHNScqn35vlP4CkvxxcPd3QrwN0vyISBMqazzw7M9fAjiqeqDGpXq6ET+/EL/mcjvU2RDBpEnoapp58zqUgMtnkZauJ8N/eErpT30BdF3+5QYsjJqMJjl3mCgEFOlYCjrFmAjusJzcwmDVBSX3xGhElPA6BRtBN4BH6RbKXO5vy9M5e7Uypxz0tSqGCn63JbVS9AbFGLpikbCP0FiqFDyNTSXeFIFnn3XoLs/A2acYK+xNFT9QxxVFqfBuPohdFoxDlK4JskzatPRYGDoPr4KmarKeVQEDRi+qkFB7ZQp7MsQDcui9G7G0Zi0IJRtOx8H06EUs/LFzqxXpi5yCHenancA63hDA8VjkEwwSAHKB17jnK7w/Pl/iCMyUpVckEm1GnTDJdpAWmMxD9EUCQRpTBwLj2LZBP9dgHi6QC9Z+eWcxDO/nvwv8nm/lhB0NW5HOBE/sUKnSt0a+F72MFnpR3+b7bhT6mzE2rkB1f49HO9iezXAY8hzPDS6v550XfgPu/oiH2tdfBB4thN8U4vMpbdPhDGH5xxJsCP0Mf2z0IG2ztz49wQO0aBBePSr8qYThtzCI/w+iK/iL8JUqH274fhKO30fVGR/QeL5VPbSqHAgfUM3Z7H/kDtms +sidebar_class_name: "post api-method" +info_path: docs/api/beta/identitynow-beta-api +custom_edit_url: "https://github.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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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[]required
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/beta/work-items.tag.mdx b/docs/api/beta/work-items.tag.mdx new file mode 100644 index 000000000..7c1958248 --- /dev/null +++ b/docs/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/docs/api/beta/work-reassignment.tag.mdx b/docs/api/beta/work-reassignment.tag.mdx new file mode 100644 index 000000000..e1eecc52a --- /dev/null +++ b/docs/api/beta/work-reassignment.tag.mdx @@ -0,0 +1,30 @@ +--- +id: work-reassignment +title: "Work Reassignment" +description: "Work Reassignment" +custom_edit_url: null +--- + + + +Use this API to implement work reassignment functionality. + +Work Reassignment allows access request reviews, certifications, and manual provisioning tasks assigned to a user to be reassigned to a different user. This is primarily used for: + +- Temporarily redirecting work for users who are out of office, such as on vacation or sick leave +- Permanently redirecting work for users who should not be assigned these tasks at all, such as senior executives or service identities + +Users can define reassignments for themselves, managers can add them for their team members, and administrators can configure them on any user’s behalf. Work assigned during the specified reassignment timeframes will be automatically reassigned to the designated user as it is created. + +Refer to [Work Reassignment](https://documentation.sailpoint.com/saas/help/users/work_reassignment.html) for more information about this topic. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/docs/api/beta/workflows.tag.mdx b/docs/api/beta/workflows.tag.mdx new file mode 100644 index 000000000..8cfe099a3 --- /dev/null +++ b/docs/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/docs/api/iiq/accounts.tag.mdx b/docs/api/iiq/accounts.tag.mdx new file mode 100644 index 000000000..e46dbcae5 --- /dev/null +++ b/docs/api/iiq/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/docs/api/iiq/alerts.tag.mdx b/docs/api/iiq/alerts.tag.mdx new file mode 100644 index 000000000..10bd4ac12 --- /dev/null +++ b/docs/api/iiq/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/docs/api/iiq/applications.tag.mdx b/docs/api/iiq/applications.tag.mdx new file mode 100644 index 000000000..7d52457a6 --- /dev/null +++ b/docs/api/iiq/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/docs/api/iiq/check-policy-violations.api.mdx b/docs/api/iiq/check-policy-violations.api.mdx new file mode 100644 index 000000000..27bd55cab --- /dev/null +++ b/docs/api/iiq/check-policy-violations.api.mdx @@ -0,0 +1,64 @@ +--- +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: eJztWl9v3DYS/yqEnu62zjrJPVywDwU2iR/80MZnO31xjANX4u6ykUiVpNYWDH/3zgwpiStpZcepUxRwEgSWRM785v8M6btEl8JwJ7U6zZJFkm5F+vVM5zKtf5M6pw82OUoc39hkcZV8wO8iY34Ji9ZcHyWZsKmRJT4DqZ8vt9IyW60K6SzjzArH9JrxNBXWMulEYZnTzIg/KmEd4yrrFpVIXgpaQJAYXzthmNuKhkBp9E5aYCXVhiEjWVSABbBJxbTJcLVmmYBthVSCyUC1ZrsWNLvRVZ6xlWCpEbR3Ve8TjhgS4jk7dQA5FXInUKiS17nmGazjDhineQVKWDD2RX1RP89mS8VkJpSTrl7MZuyzBRbcElUgIksJ39hamwEfphW9C1IBmnlLcx9hmXOFtC81syXQXNe0Md1ytfEKXIlOOXkkn1cVLqZXGT4HsJ0ALJd2zyTIa8QqHVBa3EfIbkBsXpa5BC6wHbe0zA4aLNLKxnDlOsQRu5RXFgRV4mZo4KC0T+STPAfpa13BDgWGs2i/RjrunJGrygl7hAYClzSgKW54AS+8DoN1M8DKxG34eW10EcxpS2AoYDW5vXAuOCZJnfJVLsCogACl1yXLxU7kEV9km4m1jMxiQckFZ7PZrDJqIYVbLzykhU1lsfCf4YHLvNRSucWb+etFiNBeDM+BSGvU33guM7bjOQTebLaA17PZq9bAs9kXxfBFY5/2BRqyfeiU3L7Kxdq9r1SWR0SM3Gy7l8AKkkkI+fc6q5PFHT1KIyD9OFOJoyTVYGnl8FPQHbI5/t1iWrlLvNj4k6tLAYlGr34XqQO64HWQzBzIgF8b+PjzfmaKopKC72YLRmyizzYZCS0dhUfjzZ3nYVr0CCwYUW3gWdzyoszFPvvkvOZqfl5ZK/I8ub8HoKDIEVgjYQPhANbtZaIoaw7SRAfqgFrI7A9rD1jpSjkbreTG8BoWUoJ6mIIuhyJeAta24KAc8DNYoBjT9HxKv8kvOoNUl4AypbKOqzSWaWS9qkD3/RK1xBB3MgXdGdbQIVgNDh/Nrd6RX+ST0yyXqYMq8f+P4Nup06YesEdtRNR8EdE3yg7LQcgIwewEo80cP9ZEEaxpCy2zDHEqXohxLri11xHs6X6a/MboqixWBnm0Pj1kguyRSQ/6NzD6rOTtMoOSBKXCawViuP3T7JxyhDiLtcl67m0yP4tc/gxC/ifKc5gkQj4eSxT9otxVZMxno6WwZ7+4C1jV/V6jU8ghjwpi3kdyXiUXnz6GzhB2nGD6y0WBLU778hzaPF34x1+1O7kFQZDOdaPNpo4Sr7ev3wylPxcOymFcvCMhV9z6vN21g10696Inf3OFwU7o+UtMAYXjYQlA27oyqbgMPrwvxWRYjPcZCRmxM8hUbtqHIjp3GXN5xWh/E8rxalbZXis7VORTPZq/5bCUv13B/yuhoD8DdNdNdNa/Hkxucd4JsUjpHVxvDU9o+hvptsNMP9Ke95pdag564T2dwqK4bKGPmzzOyz8I+r/svx9Ej7D3gI7hjt704Me8/LzQJr2RdDiA/gA8kVYGAx34yw1kni0NlUo7Gix1saKenlTGozqyE1haC2ktTSooImgYv0F1OOxYfsiTKesWt77/lxlrWmJ2esnAKK/evPkvoo7a/nHIuKCZ7PcCtzfvBPz7grWTYZg4NxwbNcZBv1v4MEYWMy7oHRI79nNPLmaNXZcm3cKO1LFXIDlFfzzVjMtMK/55QmOzw6JuB4gGoSmxh5FzXOSLD6e/NDMrojl4VvR4cLHXffcM7Eevg10VBVfv+IkyxV5v1cQVZrImnh5Zwn9YK/UyYIbpJYwuXZv1KIu9DJ6PKYk/bAR9DiM+ejaNleD5/uVT6ZBFOGp+8lT6XDNpR59SMJ7U4qUADCIoF52ZJo1SY+c4Gk5UXc47NNpGJ6MQF1JliFbAJAWuOnp+SqvoWLY7LfGzJLA5gLFyW3XGrb2BgvstMJs9VBKQCpbiEJqTzD5bYej5G5g1e76FWXNAvfwbrBB4D8/GD6LNtf5ale/9ODWCc6V1LrgaAqUrJviHzXZzjOytDy+FysirjwIIPDbALEI+TifzdFLS6xLoIgrpQUB2m1pZIBtZ0I3AfJ3zWpg5a0BIBb2ZdPHq99wKbIvOw5xNxGXXV+idMAbGeFoMjSGvckCWhWMMr5Yj2gQ7EC+6QfyRiofg2RFel5B/qBpQc9vkSki0a54S0aCnEswBHjSP08Ga51bcX9OxwVbjRWCpLSVr7rbwdDzeUZFTCbNr8kBlcli8da5cHB/nOuX5Fsgs3r1+9/q4OayQfxxj53a8ezsoS6dhyen/Qi9JpElexEF6oB9Ac8uzU6hB18jft+kEAJbKdFkh5qvr+OsFupSvONGa1sEQcuN45HC4hvpFzHzn3X3Fydjpy8RJTNeKtdWga3yufPlrWoq4o2jahr2aP1bY4xrc0MPq1sZWW5HagjRaO0BbXeF4SnWIW+vvbV+lWuth4Yzc4/zk4pKdhPhmpwoqEXi5YB91WiEbH8kYD+hIdOmETurpvJv/B0srQhpxOiIN3uVPSqwrvPmCNi/jxNIeMvZuo0fvun0YY/L204TtprqxW++9e1C6/By7jg4X2HSk4e+ww+HH+G1oP+LuupPQl+v6l+v6l+v6l+v6kev6UBOcuHXHQFNSH0al/i70B1cHbgPot4KwBcAld3dYyD+b/P4eX/sWEGtWJi2qOwttyESOep7p4ICEX0XdH2OaAkqN7ONhT00L08x788kT+U8NEA/zj0aWJ/J/rnFiEvvoBPREAV7GjO8aMyas1Jv8Ovtc44ORaCDq5SGPAH9hKGP4vR+8fV7RTVa3d3Cji7b2O5ZQnEo3uTaegc4+XVzivV/4PaVCZ7jH8Bv8HSb4f5F8gb/woMv2spPe3yWQejcV3+D67uzkT3VVuT4= +sidebar_class_name: "post api-method" +info_path: docs/api/iiq/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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** + + +## Request + +

Query Parameters

Body

required
    plan object
    + +A provisioning plan detailing the access to request on the simulation + +
    value object
    accounts object[]
  • Array [
    • attributes object[]
  • Array [
  • ]
  • ]
+ +Returns a list of violations based on simulated requested access + +
Schema
    meta object
    violations undefined[]
  • Array [
  • ]
    • plan object
    + +A provisioning plan detailing the access to request on the simulation + +
    value object
    accounts object[]
  • Array [
    • attributes object[]
  • Array [
  • ]
  • ]
\ No newline at end of file diff --git a/docs/api/iiq/checked-policy-violations.tag.mdx b/docs/api/iiq/checked-policy-violations.tag.mdx new file mode 100644 index 000000000..e5baa9967 --- /dev/null +++ b/docs/api/iiq/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/docs/api/iiq/create-account.api.mdx b/docs/api/iiq/create-account.api.mdx new file mode 100644 index 000000000..5ed9974ce --- /dev/null +++ b/docs/api/iiq/create-account.api.mdx @@ -0,0 +1,79 @@ +--- +id: create-account +sidebar_label: Creates an Account. +hide_title: true +hide_table_of_contents: true +api: eJztW21v4zYS/iusPrW5+C1xbFc4HOBmc4CLyzbdJLgPm3ygJMpmVyK9JOVsYPi/3wwp2bIlO86m2/YKZYGFJZLDeZ9nJGrpyTlT1HApJpHne6Fi1LBxGMpMGO/UM3SqPf+jl9/R3uOpFzEdKj7HNbDibsYIE9FccmFIpllEjCSODKGC5AuJYlpmKmRtggsU+5xxBXPn9DmRNCIxZ0mkSQgrIh7HTJFIUW14SJPkmURsDltwMSVSEAPrx/N5AmPIQhu4nFNFU2aYQl6XHke+PmdMPcOYgBG4pMYoHmSGabinwxlLqecvPfM8x1ENg2IKI+wLTecJ3oq4nif0+T0sP6Wh4QvmrXZlH5NQpiltaYYcGJAn4doQGZPNdqgOxUymBOGOeVDFXAptVcE1sYyStQhEZ2AR0CMsZV/CJItYNF5TOyVakrmSC27VgeQ0rNvs973+AXcMpJmRJ54kuFuWmGLvrXkBQxqOORa1Qb563VXZ+BN0mDNBYiXTHTWe3MqyCqwbCWlAvrUG2yfeClwX/Y5p85OMnpHzwg0936iMnXqhFIaB38MQ3XhYR4c8/cdvGtldluQGM4ClDAd1wBWPYCU3O3Q/eguaZKw+bEKpnBDWlvcajC+D31hopbdu7oLHuvjWZhBn6r01zrKGbsEKQfvt0LLbIMH9VvuJqgBM0f6ZgXaFtdjGjvU75hNokLC3bUo2mzrFVbab5MJNfs3lhNShSCzVKzcMu3Q4HI6CIYuHPTb8cdQbMjbsswHtxd1+v48sKBbXy3v/YVKIeHs5uV5nN/gxh9/IVh6dxzM0M2budzqJhJw3k9r4o+6o2+H8s/W/zuKsgzR052XGV8B6yX+/2iNLWfZYx3yzp+xk9v3qupbhp/Ls3pt95uit/2DXOZqvlz2oROpYRxIU8/aklN2qMhWcZoJDfi3rmGotQ27T+hOHkoRyOYqk5KF5JbQggMAPnqaZQRc5LC/tBWfh+VEJqsbVoJRm3O5iPSEnYUuNiFqYYfVrUxYX2lAR7kvL+WhZPzvx9HV6SCEUJsXWK4RDWj9JFdWzUYxW1GHBG+AEB95gXJFwRsV01x8LAjm367qLHD8pblhLCgBtVEQOgQi2AEkDtkYauAnd1O+DsgFTt0ZJMb15inpn59+hfGEGWUqYm4Ni5pP+BuICEZ8zE/sWI2ofg9l3MAQuKE8s9vZ77a5fim//1s7wxzc3/5lcju8mv7wn78fXVz7NwX1FazcWVrI8Rl28lEuAmVFTqhAWlRlUSaEpkHN3ty2PRnhFIQqwL8jrCaggC0FNLMf4aLEqxndbl41ik4cFhu1/BqrzL/vflVOjT8jbVHZycv28VVpOTgqt+WRJHkBvQNekwOyD58P15O7BW23s6mSDaxpFHAnQ5KZUJRFrYoV2gLhihn8ndIqq5VCEQ+yirI5poWPoCgSmBOuwkLTs75JTBVImjIqyV+UbQl34xGqi5cUN3cI2GYv13RQyJbh4JtwYCZ6JZiYvXVtRAoRjmmh2SuDSNng5NK+upG4msVXcehcwfoRoq9MtfLNG4tsoqFLKvllkPSJHJ52Tpl1o2oWmXWjahaZdaNqFpl1o2oWmXWjahaZdaNqFarvgeHIRb4HRWbdX1fylTT26/FoN04hLHLp4KZIlkNlNGXPtea3x8huNF6BRDbw7hIKC/sVgRPsxgIaLUdg/7wN8GEa9ODC9i0FgC+JB2ND0P03/8wf1P02r07Q6Tavzf9/qiCxJEBFndaXMutz95N2rqtgy/hH/4rgVd7vdFvhC0AoGlOGv8ygahNGARasGhjcwvIHhL4qWUpHh+a5L9M4EU+FrxZxRDUwxQQpSztMtreLI0/3kKGaA1BUm8oShh+iv4UQKhuZNpcIjcWtapZNJx1mcavOBxRCwsyoX72Bnw9NSUcxRiEtiuBaG7OK8jG9CvS61wZyUQlrxIiDcQspezsIdVVNmxtOpYtM9wOgAM5YRY0mAKeiGyi64OJ6plBla5eEa7sI0WgsdqjAsf3xzQBarsTX2eAK75muO5LRcLs66Z2et7lmr17vr9vzzvt/tt7vDfqt74Xe7novuA6CzGC1kK4v1JrCTn+bsHNOUoSWvZYRV+bDa2LbWrAek+cI366478vsX7dFgsNHdAnDIXtXlg3u9Yr/6/vvg9QZ9UEvvrN8HYz14DrW6tXd2Xd2Oa+GR9OEtivO1FkbmBa6eaD4ISWchk8Umqe2ThypF8VEFNyzV1cOZqxIXH18FUdYngt9WpHd7k+2HIFYfEOYziWeR5+C7GL/UQB701k4LtwCBLorDvplK9vt8js03ru/tvsYqNUBWp440CSieRwVYjg9Y7A/I/OMbKCV4jFSzMFMW8wMDMJWH4wyZ/PhYHrUiu6xTmrM2CbLs5ea3BQHneKgBfDDzYXNS9aqw2PZb481Djd1HEDuofxeOr5vBl9u1vFv7HZvtaqu9xWq1d/0m3L6y26v2ekWH9aKqN43P9nuX8muX6mP8mpcWdZO+WY9RArruZHSBQnOIwkUsDz5M+HB1e0euis8CJsIwFVPIje9kmKVrnIBQAKPuwTplkc69URsVa/FTTYRa0hCK9tUVWBegH7KSn1WvPiNt78b8cvNA9C/x9UKeDwz7YjrgSly49jGxT2Rt8tv+/gJdGu8tl5il7lWyWuFtd2gfM1LRX3i+w/D7xf+bfcCwR5efmI3Y8tcLRU6x3zz8/vp688cKByWp/R5jI9EjXiiOItmSBB7DaMSU9Q1H4dJJ1LJoZrO2/qMHVJFbBl7I5mbPAjf3sVTAb365vYPJQf61BWBBXKPoE2Zq+N/3HuAfXEiralsp7f0lgE4xzegU5zu6+Pc/zQVIzg== +sidebar_class_name: "post api-method" +info_path: docs/api/iiq/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Query Parameters

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 objectrequired
    + +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"} + +

    Example: urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:**My Application1**:account: { \"department\": \"IT\"}","type":"object","additionalProperties":true}} collapsible={false} discriminator={false}>

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 objectrequired
    + +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"} + +

    Example: urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:**My Application1**:account: { \"department\": \"IT\"}","type":"object","additionalProperties":true}} collapsible={false} discriminator={false}>
+ +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"} + +

    Example: urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:**My Application1**:account: { \"department\": \"IT\"}","type":"object","additionalProperties":true}} collapsible={false} discriminator={false}>
    meta
    + +Metadata of the SCIM resource. + +
\ No newline at end of file diff --git a/docs/api/iiq/create-alert.api.mdx b/docs/api/iiq/create-alert.api.mdx new file mode 100644 index 000000000..26b2c8bb0 --- /dev/null +++ b/docs/api/iiq/create-alert.api.mdx @@ -0,0 +1,71 @@ +--- +id: create-alert +sidebar_label: Creates a new Alert. +hide_title: true +hide_table_of_contents: true +api: eJzdWutv47gR/1dY4T6029iW/LY/1ZdkW7d5NXEQFLtBQUtUzIss+kgqWcPY//1mSMmSbVmO77K7aLPAwhIf8/7NcKiVIxZMUs1FPA6coeNLRjUbRUxq58TR9Ek5w0+OeVbO44kTMOVLvsD5MHsyY4TFwULwWJNEsYBoQewWhMbELCOSKZFIn9VhwwWVdM40k7jtyuG4ya8Jk0sYi2EEHqnWkk8TzRS8U/6MzakzXDl6ucBRBYPxE4ywL3S+iPCVWfd1m7UR8cV8TmuKIU0NrEVcaSJCkhNAbiXTiYwJj4kGYYDXhYgVq5PJjCtiWCNrpolKQFkgJixlX/woCVgwWu92QpQgCyleeAAsmu0UrMvp/Vn9BSlOhZ6RVx5FSC2JdEZ7Y96U4R6WORbUQb5ybe2ycYTWTghdLCLuG/P/fhWmPJBQivmWFj98uBNFFSji0zgWGuRba7D+4YPzFVxLMpBN6Z9FsETW8ZFLBk6pZcJOHF/EmsUahwpcN5TP53/9RSHDq4LgYAcwleagD3gKuFpEdHlldLbaEvPMDhLUCAqHEhjPRYfdr8BTEYc8AI44jchHHjFyvWBgK9SjXbVNaAJvjyBATRDCboWI2NlzVGaTPTSolBRdh2s2V7tKembLEp6LjklgSjXPgAHyYxJFV2lMvtAoKdPExq5mUvW+k/O7SWMUx6w+krGIQMnwd2JVdAauWU7C4g+OTzh6u8aY9kUSBWRGXxgJeBgyCSYkc0ZjoKnIlCKKCRuROjUY3WesUMg5BZd0AqBR00Bkg+um22zW3E7NbU+81rDZHrqDerfrwauh66J6YvDhF4bAu83+fcwhGsjYOFjIAXuKRs0gw64naqnApNUabLY6XrPV7nitZrvTag+Mm1L5xPRR5O0SIqa/MF+T1xn3ZxDSFvrf5tZNf+AOvKDZDruddr8buh7+6vanrN123bCXMzYpj6KCYe4oj24w+VxbfgocclXNhhVNL3NyZ1UgcQ+ODQDHIdtFSxKUQMaGZqppbzjySRHOysX1hbSQahLLKJ+e2WFPwNtRTLtvR8OJcastJCzSrJPrm8n4+mp0ASk+ILfno7Pa9dXFf6pF/ufZz6dnAOe+TmuJanAoykiVEj43+eeVQ+p8o5/1Qhf/vL7b7HtB2OubX9OQBZ7r9ptd5OAnycJyBu5vx5kG7k7Hl+siBn4s4Df4DjCXZnmrooIVqxmbab0YNhqR8Gk0E0oP+27fbfDUH/mvJqU1XpqNghJU47A46R8mUpt+jbGbrrcr4akp0VReo6ElbbGhsgwOlQkFZFxrek/+PZR6+X504eXgVq0936V91xv4vZB5XrfX73v4qz/otwHg2r2ehdUyz77a9moofxItak+QtW15M13mBr9j8oXJal7c7M8zxdM3KDL+waJIkAcho+BP71ZY3DA550qlNd93qi7eqxL4u6T+c8Q69QnUinVMAOb0UYdSFaV5jyJmSue2frE1xndG52+LiiMfK4b/WigWcvl9UHAt6rdHwQNxeDi9Hak+4yK+4a4EcuCkw+YLvSQcQsjMIq8UIJY+szirMo8MpD0QUCxXLSFYg/UpOAhQpNlh8yBMxMkcj/wP17f/+nhx/QCvTs9vJ+OP49MRpn14vrouPD4W1bNetK7NWchjjuwcY458FbykUNZJ/vQEhbqtMa141XaKxOsdA/wGVxpt8uHYBAmqKKt7AUnBDyIo8VKbZt0MOLNjmjJ+DCd9Sny0SJg6zRiODJK8CvkcAuVxqcZTqxjT/57KxffcAaNer93MRShX6ISqZ3Jbae4DPlaeQLeNVaQDnlZEgT0mAsYzJb3NHx7S2ba5xOMdGqBPYMJqo1qrF6eX5Aa7M5j4UmZikduwPHzzYex0AOIB3M4gdukmF3CuXJcR76lmH5sMTwm6/gavRt8bHFgVHDj0gCYvICwis7Io3XH1S5mxN/g7gossSuItbqCY5NEoCGBYVZcmZiah2dS1nfLi9lgG6RzqYVqXQqm/BWwu0hGsMSD0IVOwOqgg2B5bl+D/M62JVq3lTbz2sNMctt16s9vJWxMRVRrCxUedlgEl8JBxnwUrLiFIyeKdkRCz3SLbJhUzEGAlbAJyKJl8RFfTKzVNDLCeeM4stidB/jEZ3R/Sfmk33SmbhtOa3+/RWtvthrVBy/VrzQGD32za7k39H9aSKZypOl6v45ozVbfVpt2p53o97zu1ZE6LKfVH9GUuaUyhziA7jMyZpru0L+EteB7dxMO3w78tLUpMvQ4sk2pyt8NgShe9Vzi0iyEv9h1z7m8vEFbf6E5vL+1NK6jxliM9YsulCNDxqxQGNreqMlg0Nwv2I/4fxUgoMFWpviwP6XC1sh4+O16347odd+B6Ta/32UnLO3PQKo+32+wYlgUdGmaeeaNK3tKCtJcLJlXZ1k1ljjUAbafZUmxdf6gqf99L/5OTyHjImQ6H5nZNDdEnhimJocqO9UOv7g4NnXG8SPAEeew65zHPyaCimcBbzgV4pbmN1DN4Sv0QL85M08feTSYyOsKXne3Ls6y/PP63PTrbrU0SR7Km42Z+QFyNbsZ1cwWmmJ/gmcUwAFO5P0qQxU+PxdE7lNZCSGHOWtvIcnYJaNsZMMdB+bFXd5vfsp1n1thqCe+/2sotnV4QF5tHn9IrpM1LoHWbt+QO53GjTDpwXVJM17u3GcXMefiKYTOd5XcBpSlno12/2w/amLrT5s7FP9i6yBox365BDJEZh2I3zgu+egtGIufZlf441kyGFJDmTPjJ3PZ7oCrD6Eev/hw7BRR0+vUWqpDrjRuWLALM1uDqiG8YgFBk54egvCVNYvaaZ5kNRld5E/r4Tw9Sz9Xsi26AxbhJ7CbIVykQFL9zQL3jm9UKI/ZeRl+/4mt7+46uDnan0wiTUUgjxSo4/T/7EmGPJm3ob3y8kXm++Xjh/fX1Dp8dVMpS+mlFLtMjPkiOQhmABp9hNGCyAISnVqaagZl8bfnnC6gku2zk+2yh9yywcx8Lyezm+m4Ck6fpdxNQ9OAaSV/hJf4/dD7DP3gQi3Wfw7xfQVUVPyVQ8sIcuy/+/QbQL0kM +sidebar_class_name: "post api-method" +info_path: docs/api/iiq/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Creates a new Alert.

+ + + + + +The endpoint used to create an Alert resource. + +## Request + +

Query Parameters

Body

required
    attributes undefined[]
    + +A list of attributes of the Alert. + +
  • Array [
  • ]
    • 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. + +
  • Array [
  • ]
    • application object
    + +The corresponding Application object of the Alert. + +
    actions undefined[]
    + +Not empty if action was taken on the Alert. + +
  • Array [
    • result undefined[]
    + +The Task Result of the Alert. + +
  • Array [
    • notifications undefined[]
    + +Notifications to send when a Alert action is generated. + +
  • Array [
  • ]
  • ]
  • ]
    • meta undefined[]
    + +Metadata for the Alert. + +
  • Array [
  • ]
\ No newline at end of file diff --git a/docs/api/iiq/create-user.api.mdx b/docs/api/iiq/create-user.api.mdx new file mode 100644 index 000000000..8e9c493fc --- /dev/null +++ b/docs/api/iiq/create-user.api.mdx @@ -0,0 +1,147 @@ +--- +id: create-user +sidebar_label: Creates a User. +hide_title: true +hide_table_of_contents: true +api: eJztHQ1v27j1rxDCgPQyx7FTJ84ZKDA3yXAuLtcsSXcb2mCgJTpmK4k6UUrqCwLsb+zv7ZfsPZKSKEu25SQ33Dq16J0lku89Pr4vPj5JD46IWEwTLsKJ54wcN2Y0YR8ki52Ok9Bb6Yw+OngpnZuO4zHpxjzC3tD3es4IC71I8DAhqWQeSQTRAAglOIjETIo0dlmXQOcYbuO/JIn5NE2YJAGNv8AwKslOzJI0DuFChP6CTBcw9JeUyWSnQ2TqzrHP7m4sfCZ3dzvkfs7hXpDKhEwZiWJxxz0NKKJxQsSMJEDc7m6Ba3eXALx4gR1owBIgjodExB78ALIBCg9dP0UocB9HA+2RCCXrAifyQciPB4fj9BU4aAuhBS4LVHBPunMWUGf04CSLCFslNIa30MK+0iDy8RZwLP4JxnZCYP8dm3gsTHiycB6X+TwmrggCuicZkpEAhT6XapIWK2EOmoUV8oH1XFYmL1NYd1gzGMq+6omPc2jAc2G4ClQrcBLGFfheye8U10QyJ/fc9xFb6icZ7lK/KUMY2fp2YX71DKySsS0jAxqm1PcXJyKOmY+cejozDTVkFotgiZ+7VyIoibFLw1AoSczm0N11HkFfjAy/Fd4Cp4CXPAaqRkmcso7jijCBRccmGkU+d5Ue7kuXB3/8LJHcB4sBsB6wZAkHvsBVNmn8XZ7hh5ADVsKVPM04rPVMxGoKqJIgDosIMAGbcp31gCg3gRs0hW4wykUVhga18Cy+426uZADgjILuKfU+/3B1nekNqHwowj0WRImCrKgjd9RPMxG0KFIDgV+pppW6sZBSocMuMWJVa6IsjxmeM9zitzun4S0KVWeNfJwL90tXmbTHTNiWeYamDOQCFhjwy8x+4Jh///NfEtae+gRHdsmFYQMar0Wmcp/REOGIWerrjmiKKJFAig+TUTRlygGrEcBcgPUyne7ls+oQvUoLcj7+ewUwDz0OeEG8CzptEUxlpqigkkq9LdCyFjYqb5dMZlqL72jMKc4dTXSmrB096OqH9x9+PEV+a65NS0YBpwsWmQOQ8vQUH5BwlGsYMRf3qkftBORcpL6n1lQEgEAvalnmc9D1C5gzv2NkEpGCoJOAe56vCQVWgJH18f80xBWYzfhXQI/LFSE24AKuRTELVB6Py8iniw1iBoL6lsZTMCvkHXnHwFaEHTKZTFDsZjTg/qJeYRXtql2zzJI+tXA/UhCCnzQzSSDg4mcwKgyW0AfpT+mtspSrCdOkIBW34GfC1USo5noa/szj5xFhOOM8PqJJ1vxcTUmVBpnyhE59Zq+HstOht5dmVsIMLGSprJMWQOOVjDxvsiD5suacRJTXqn8d+QipTL6xfYtMc5R/ggFyziOgJblnTFsHEd/SkP+qGpWI5oZ7LYVgdn2xYAxpoy7GE1XKxuStgACKhtoq26pZsnbUC3gITjFWcQlYL5qk0kI/1VBs/OjPHjFMkvIeYqp6riCCHfSWkoH7DSVX4F2AFSfsa0Ky0RV7j74DPaWn3RX6DamjPUoCoEQ5bBkxFxgMPIPOABosZQYQwkXgropMlUkgIbvXUiBiHTihu4GB7CtMG7sYUldSpGKekN0pQcrNJaoGLcWN5QUDDoEv576s8ucM7wPnPRgtwR5lLjvVLntuPKllisEJihAdOf8VMEPAjN2vjLPOvFSHsO5tt0Omn5Xk/sksWBdsLBAL+ks9lNOs+exv4/OLH8+6J+/Pu+QkQ4ARg8GvXCNw5EsHrDkaWpRQ5XGs2dI4phjX8YQFshq5JPVqY1SG2Ywgr2xcCs936/UA+yOfFbVVLCclppVw1cHVXkCpF/SsMwnddxXGInpwI7C3WWytg2YcYXsl0pQAZG2FFGoQO6h8OzqkAh8G2gSBGJjoGM0fIBKhy9Zrr4MQ0DKjYYvDEWfJbKS2CnKEwehIB6FwAUSp7d6o3+2NVEhVWV6XRnTKfZ5dLy9A0QoKLPltqJU6QQVbsnMVQaqqUz6Fj5+cqwUIdDAurJeIPzk3yiLa9+qNU2lYZrsvL8ZoIjKtGruuSMOkzj6pXasJ4tFLccvVKG8AfQDa/luB4WUOshrjbHSNme+zPVqFeCQ8NQYuo54a6td7OjElVwHEcmuUCKngXob76mRynu/z4UeE1jTMJfrlSHN7dAh/6HA2HAwHA++4P2TDwcztH7w+OnCPhu+R5D/EbLbC+1xOXpLkcROS50kSjfb3fQEWZw4x0+i4d9zb5/wXtcfbvzvYVxuc/U1T01GTFLPkHsLzv8IQrneH1Wlmncid7mWJshK+9QQPu6+1l4omNU78zAQZuPqgu8LlagNtQv+q/tYg6E8P6GtXbctrJnCq3W/K5TzbP2hH2Ai2G77Jxbcj0jdm5yoRW8xuV7JMtxVYUFct07Qe6ThgMei8heT9fchWGBkF/X4uiLgPpYkDDW6aaAJysXyFnTF74ovwVho6trAVpzV2wmATSOH6ab0TbEs70By225sODo+O6WAGQn547A5eDxgbDr3+bJr0D4+mq/UYdRgaWMzAp9UhLhKOL6SXmyhFvUQwyUrpylqfKF9XcING4MwdC9NWImYR0EzIDDECokI3eb7Q5fgbiMb27mcb6NrMHk+HbDbss+H3aGZhYdkR7c96g8GgqeCZzFgZ9YuL3iZaUfROMYuZBCaJuLQWedsTRe9SKRbE/++zIwJl5Vyg2gWodRJ4gokB3SgrWG1/8bQo76NzctLrQ9/T096BcwNNn8VU5XOqpLwDUVJNJq2xIsasmfcEycd5j1OPJ+SchvQWk4cbw2PYxOK2VoQjxQEI2CUbHViR8pI7zTtpLl0pMLDxEmFCudHeQGO3swlVR2A6VVGcl0entaO31miD7qVVuRFYF6Kk1wMMlRjoxdH3vSHqxeHsEIwyhEvD1Tp8uay/GWtfWHE3Eviod1rFacDHIpt/gy27+7tt6r9N/bep/zb136b+29R/m/pvU/9t6r9N/bep/zb136b+29R/m/pvU/9t6r9N/bep/zb136b+29R/m/r/VlL/uk3nENT6HIDIVzVNPWIjs2dscB+u0xBZXIGPYlDQ/UxiVjxnsOkRA14TB2ZPqUz+Yq1eg/isgd//vzrWOGnPMdpzjPYcoz3HaM8xfl/nGG2Wvs3Sf2tZ+qUZerC10bs7y3nVh3IrEgEmaVujJlccKS4Sq2aXbHLVehh5hR6Bh1++I5cm/kbhai6gT0uUN8yBd182B948vf2U5MSW2e2XSVwbMM0SFWhSQxWvYDqizrBarSUpBOEozlazXZE+beGz7PUA0FrEjTuFPO8sP/DeXLrWLLvWZ0OkRfh6jt7GIo2CqYrdjWQ2F9vGWH5gfnTKpDKuKyy45dYtsOSVddEhFywOuMRUBvimxO1usOdFd+W3i+3l5qhoXHTW+RmbKAWJyc1J+FPcGwEoHTYoyVxtGEyHKrp7iJ612njqkf/1SE9+elOOpzrvP7y5pjxiHH+NJad7F9SFnaHbOT15YwbiT+N+XkKbG0vGZo22dbDRiRTmKfBdHDWpFry9Qo8ruvu713GczXrmeoDYBRLVvJ+k4ZtxqGh/j0yum+k2AiSvJtcd8hb5BvFJI03miVahLDVVSf3oSAhWV++C8VgbMaHqZKO6ZJylmMHHnxrebNBgM+JZ9uNevV6mIMpVB4gbFXms9hn/OFXpIhEvGhmRmqhiiR3/Y5ZkswRuNiFK/pvajt9joUjM5ZcrF0/bao42gkhIwEAuoRNRvTRrq/RgtdqtentSjrd/cAjwuTxflapf3nOo0zo0LOBaQX11RYl9oFKTL6/ZNcyoL1lbAtOWwLQlMG0JTFsC05bAtCUwbQlMWwLTlsA8qQQG9I/K5JLNYKXnNfyGySU8WJX6xbEoQzh4s1fL0/oeQN1DsN9CCU796K0tinlA5TeqxNkQHeYnbL9xxc52Met2VL1sOU/HCVhCaxYf7oL40sJRFwZy6bEJVc9TE3HmOlV2W5hhMGMaKo89+4PewcFe72Cv37/u9UevB6PeoNsbDvZ6h6Nez2nu0Gum9d8IObQZOhcelt2s5xkrs0yZoMAMfDbjesejwWH3+OioYNzdup3J0oakGdt+/uT0jwbAkf7BYACL9MnRgXZxaFaPrKwuSflwbUWC0eyytDFdsbvSjYSHd8K/K96UXEL3VN+27bnmBm+AOZrC+j/LddxkZXuD3vd1tYVZBntWFImBumJ5ly4Ge0YJ3srlUCy/Muuhqt6sBPqLLgGN+ChgUmJ5jOLJWRyLWIUf2L5CCE0qGmYz9Vmgg2/1iKWunDCZ/fVSqbmH+Wv9GucEj/irfvwreMhQ26SsKEOf1GvUeVVXI5zZgTShPlhYb2GIHpUK8HQ5SZWUH66vL0ytCXGFZ+3RVj0WaqNG6Xp8LHzKXOAL2SOwlugxKPjwkaPNJFzj7j57G3ka+6tNrKnXLCyts/xGbKukU0mVBk2mFF+RDbzDChL1A2LI8cWkq95sLZmbxvi2ciQAunJ3nCKFH2/sViWgWpKtPrkQIsmOsTkqh4l9HJw+6sVl8fLss4xJ9ssvrKLIoibSqq9bU81WLmbLqstKxWVFtddSrddyJZVdSFXUMBUlTPpV38Xj0dbSm1KjjzlDVHFMHqitK2GxKlhMccjNk0pDypn4NRnyujRymS15qFlMYHPSMov/XjBZWJMqVJm9PLGXpeF0Fm514qzImxV5rmqaq8SEInFkM2FDTPMEHjSIkvIozkqi1OVQGi7imr34E9dwfSbC3tvX7sXLW/GlvbG9NV6zo33eftLe923m4qbNxPZcbLA9AccfzsTaMv7Ls6trcpZ9xkPxakbBAZ4KNw3ybTx6VvQOn9Dg5YGuc6z0Kmf0kidRoMFlqII7mAkwDEkx33soP8bQXfZLD0XM9P/0pRHjCfCtGPsgUlyX6sYq8NFBgPU9FhQPvPHwgN76Q+w/PuJt/WEN9Csgl3gg55nDwDUs/sY+MrKCkV8YOszSp1oyBVXfJXl5fj37OyJrZ1L7zZRiRjd4EXOckgrNQGIgqFX28sFAONEz2lMBTDG2/nskyCI9bOy6LEpWDNB9b6wo9uL91TV0npoPocAuHMfE9B4dKvx35HyCv3AhIm3doZO6/+BktfnQR8PFP/8BoBIxcw== +sidebar_class_name: "post api-method" +info_path: docs/api/iiq/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Query Parameters

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. + +
  • Array [
  • ]
    • 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. + +

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. + +
  • Array [
  • ]
    • 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. + +
  • Array [
  • ]
    • 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. + +
  • Array [
  • ]
    • entitlements undefined[]
    + +Entitlements of the User. Returned in response only if requested using the 'attributes' query parameter. + +
  • Array [
  • ]
    • roles undefined[]
    + +Roles of the User. Returned only if requested. Returned in response only if requested using the 'attributes' query parameter. + +
  • Array [
  • ]
    • 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/docs/api/iiq/delete-account.api.mdx b/docs/api/iiq/delete-account.api.mdx new file mode 100644 index 000000000..bcb9bddd8 --- /dev/null +++ b/docs/api/iiq/delete-account.api.mdx @@ -0,0 +1,39 @@ +--- +id: delete-account +sidebar_label: Deletes an existing Account. +hide_title: true +hide_table_of_contents: true +api: eJytVE1vGjEQ/Ssjn1qEWJoiEe0tajggtVIb6CnlYLyzWauLvfEHAa32v3fG7CaQpD0VITG2x+M3772hFbZBJ4O2ZlmIXBRYY8AbpWw0QYxFkA9e5Pei3/FiM6Ycr5xu+A7dWFcIaIrGahMgeiwgWDiVAWmgvwgOvY1O4QRGo3WlPdDXWN7fo/N6W+NkNKIHG+nkju46frYVhhb0iDxVIYhjofnVRoaKYq8q3EmRtyIcG070wWnzQCd4kLum5i01V3P6qDmW8zlyOEfkSH4qp7PZTHTvtaQLsCUEivoOJlTU4WPUDomo4CJ2G97xjTUePWO4ms7457LYHYbojAcJdAxPOlTUNwz3YGuLI+hyYOxJevBRKfS+jPVEdASO6KjsiziJJOo+F9mgStY+E9QxK+j2A4HR1ZRZhdDkWVZbJevK+pBfT6+nmS7QBB2O+jHzSu+y/ZV4TcWyT1n+gNWX5Tc4lYat9MggSOECUkCi33xfEuANv6+io0sJAKVqdRMZ8P3m/HTF2p2IO8t5VpIhDwrzOuUkPrQp7Vuez5DeLVZrWAyeXBpyUykVwq1VcUdZye5QWpd6+mXomWTCVOd68pl9r0Myz+v+U2lqlE3TEJE7aRhKb9PbJJBn3+NB+0BWPLfPBeBWKEvIaMr++wz1DAY8hKypJQ0MoU1GaHvrnA30WOQv00XysD04oW1Z5J+u7jrefozoWFAK99JpuWV6SN5Ce47JnqWsPf6jyQ93/fR8hL8O2LvI+01pjiyUrCOvKPyNx4u/hm5zPiy3i6+L9YIM8wcydqig +sidebar_class_name: "delete api-method" +info_path: docs/api/iiq/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Deletes an existing Account.

+ + + + + +The endpoint used to delete an Account resource. **This is not reversible.** + +## Request + +

Path Parameters

+ +Returns a 204 with no response body if delete was successful. + +
\ No newline at end of file diff --git a/docs/api/iiq/delete-user.api.mdx b/docs/api/iiq/delete-user.api.mdx new file mode 100644 index 000000000..5a91f862c --- /dev/null +++ b/docs/api/iiq/delete-user.api.mdx @@ -0,0 +1,39 @@ +--- +id: delete-user +sidebar_label: Deletes an existing User. +hide_title: true +hide_table_of_contents: true +api: eJztVUtv2zgQ/isEL20Jw0q7ARwI2y6yjQ8Gtottkp7aHGhqVBGhSYUPJ4bg/74zlOQqTnoosCh62CBIJHI4/B4zo467FryM2tlVxUtegYEInwJ4PuNRfg28/MzpNfCbGe4G5XVL0Rh73QADW7VO28hSgIpFx/oETDI6xDwEl7yCORPiutGB4a91Ede3mFKvDcyFwJta6eUGz3m6r+MWX/ACzOkR1Yxruq6VscHnoBrYSF52PO5aigrRa/sVd+BBblpDS2qhFvijFlAvFkCPCwB6kq/rk9PTU75/jouumKuPca9qhG6cu03tn7u/EZcQRCJAJLZCRJ9wacYisSOI7MCFhcYlU7E1jOERbxGCaA2Z8D5aozvnyMDDXdIe0AhKu591PfO7BH6H24MsUzTPCbJ2zoC0U0VqaQIQ51omE4f3JyKcs+Eo20qTAKHJiIYilY22gOZ9Q3tQiN1rY4giocISSC1b79hIkWkbIsgsbO8me9nn1vZYrRd9wItXc3YFMaKnvaiZ/SSOdER1+ouVxFMZVZ+2TcYgitq7TV4dkx5fhkkQc/QgI4bLgAV7wHzfgEXHpFcNgaidz6kONfH72hfv8h8hlr3CQpQsKL0ptm+K3C2FEB+cup3TixB/PC6ht33R8P0NWR5aZwMEMvDNySn9e+zKJcTkLSHEbWSNPKxj4zm0rNqRM0Pj3SOXkJSCEOpk5nyPLiPlxn3r7txv2EslH7B2vUh7Kibw27ELkzcY08TYlkVhnJKmcSGWZydnJ4WuwEYdd/quGHjz42paDSGrj+zq/eoD61OztQyQzZC26l1BL87/Wc2zHAFU8ngoA8BQrc4TQf18M929opLvJZvEHBqAII+NkRuCYrIS2tbuqcITpJfLq2u2HIfaymKt1BKr/MKptMGoPClzSRCnL9RkeZLlPGfz32hq6piH0DH/nBqJ0vBpUcgNtmh5mHUX2Rp02TJ40CGX/zgWHqHtuHIIy8b/dgIP0kV4iEVrJM4dhJkroBuqZfwOzHg5DGZ0hCqCtrqOfP3kzX5Py/3EIg8rHSReUk1m0HfI/D99fu70+Y7nt7B7+o3J9HA59+hWek2e/qC/Ly+Hr9sr9mt8bZ+lPyxKu5vSHmUZCn9/M52qF8u/ltdLnC//An3AMKo= +sidebar_class_name: "delete api-method" +info_path: docs/api/iiq/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Deletes an existing User.

+ + + + + +The endpoint used to delete a User resource. **This is not reversible.** + +## Request + +

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/docs/api/iiq/entitlements.tag.mdx b/docs/api/iiq/entitlements.tag.mdx new file mode 100644 index 000000000..3d8b95697 --- /dev/null +++ b/docs/api/iiq/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/docs/api/iiq/get-account-by-id.api.mdx b/docs/api/iiq/get-account-by-id.api.mdx new file mode 100644 index 000000000..d151045e1 --- /dev/null +++ b/docs/api/iiq/get-account-by-id.api.mdx @@ -0,0 +1,71 @@ +--- +id: get-account-by-id +sidebar_label: Returns an Account resource based on id. +hide_title: true +hide_table_of_contents: true +api: eJztWm1v2zYQ/iuEPrVZbMuOY7vCMMBts8HDkmWJg31o8oGSqJitJKoi5dYw/N93R1EvtmXXqYcOGJwPrWSR9/Lw4d2RuKUlEpZSxUU88S3HemZq7Hkii9XbBfxwbin6LC3ng2V+ldbTueUz6aU8wUkwZTpjxHwlKZMiSz1GvnA1IxFV3ozHz4T7hEv4qLI0Zn4bxCY0pRFTLEXhSyuGFxBFczFaMUfZCVUzeJbejEXUcpaWWiQ4UKoU5MIX9pVGSYg/eUNvCH/ekAXDIcPHIWP4RLuB3e/3rVWT4WCZCIiqXEDjUvY54ykDPFSasdX5Mjfmc8bSBXwujFVghJspJg+00OcyCeniBqafU0/xOdu2aUw8EUW0JRkipJhPQi4V2lipI0oYLAmPte0AeyJiydpkOgOgtaGkhJjIDNZYMtBE2FcvzHzmj0tp50QKkqRizn1cKhQnYV6l75V8jRpdASv6hYchastCVeheG+cylFEt9C7sts34DzA0RpAgFdEGjGf3og6BJB6NY6HAvxLB9pm1ekKu5HMk2t2zbfxv3Zw7jYYklEjwJmzYLC6FxSEix5Pr/eGJWLFYoTSaJCH39BbtfJQoclmDClYOFlfx3ADub+uf+CCIq8Xkr2a279lSttu/HIxoP2DD/uXI61/0cUv53cBV3cuBi9BzI31bL24vT6Q5QJpbDxLIKNyPzFMNdqx7ksHYG02WJrmFVoJ82pCl1ex37C1NXaBG+3cGKxdrBlW8atZoBlAXFvAopaRSOqdh1qBubcHwMeCAWyDSFyr0bApBcORiROyy4ZtRFyNinw1qETFlQbO/D3eTwsX7d5PriqwpS+AZzTLR4nCDZkolTqcTCo+GMyGVM7JHdofzzx3p8agz73VQhux82/AVmF7bF4eQb1wNP5SDR5OipnM/MtfC+1Qf3T2aHger/sEsOdiub5OlJupQzsQUU8Zkb8wqLM1iDlmrjjGVUnhcZxRd36BfuURSI6NJwjAj1GUPj6JMIUX2+0u7bs+7OCgWNVANsnjGtRbNBCNCZ7nYb2EwlS+NTjyWisberghsvtbx2dhP34VDnIUhKM+yplSmKfcwef+iLLYM3uBfELQC27ZbwAW35Q4ow6cL3x94/oD5K/QY0rTDmQocXTpJB4nm5KkWXigPE8Fj5XTbtlPjnnOvRzjj29s/Ju/G08mfN+RmfH3lmGp2241bXW0xw598LevhSc2oqkUvXawoxLKgJpRem9rW0MbqgXKsOcpYB8BkHhQiELRYApyARSsqji3V9f2qia3rpfbPbtr5Rf9zlYPrEHIcZGdn14u1sHd2VqDmkCV5BNxArorA2EfLgffJ9NFaVaud+wbv1Pc5CqDhbS2C59W7ZerErWX4NaTPCC2HBAH6WY4xLTCGYjlGukLNpDeUfq5RzRUiZDSuc80ohJj1iTXQ95sK84ltMo7LXyPYxVB1ZnH+jbgLIpkyYRVnFzUqCg5oKNk5gVcsWImpWLdn0nwk0RlGswsMP8i1iMYZDcPFO2RniKHwpW7OqASjWEwKUTnTtaziTPEwOcgYEHWFgTxkyBD5PZaImOHyRgI2Bqtk1Ur/w1acSnXHAtiws20r3oNmxaNaUjRVSB7EcC580pNNGq+2elNogzFwssbDEAhuoWTLmDClKR7gn59T9ryjMNpjjDZEaRGwFLSSsllcHG4UnD/ptg3X8CsMo42lw3YZ5qWsmWilLxqx6u4B1tXMOdDSerro2b1ey+61ut2p3XUu+o7db9vDfsu+dOB0l+/uPUVn8bXwre7WUcWOuX/pHHIow5W8Fj5m5f2wsXXUNAMiM/Fo7OyR079sjwaDCrs51CE7oTMfd7JiN3x/P1rdQR9g6fb6fVisRyuvWvO5Uz2vSWPpPIrer8Lgn5eRJsE1CzUfIejMRTivgtouf2iaUrwa4YpFcvv2Y1Wz4sOLShRj8bF1zebZpKxrnlab5zDN1p9OlxSnS4rTJcXpkuJ0SXG6pDhdUpwuKU6XFKdLitMlxemS4nRJcbqkOF1SnC4pfvwlhcYDtvlMmB4n3YGkIAxaFWeXZfcRJm8oRudFd1KWhrvpb8r0ahdYm/0otbOQhjcXrbs+0Aiof3yiHyAJjG8hq2BfiWReluryHwyAodwbZ2jwh6f6V+19HoBqY8rVQZOLxhqdG3CMtdJ1cyD2ntruru6n5Cr2NepkEiuWBhRI+F54WVQGZIy56NMj5pty31ij9gVSBxNVg/9aNDiKrEkASMixaIppDSrbZeI9jTJ5k8ya8cuqZ+b7WtIMZop9VR04l/A4r7ZDfYGlyVLrgju3nJIu2BKHhMAByyXa+JCGqxX+nLc94RIWtZnl5PXPbuP/Zy1gO4D9xBbWRg+duUqwdNfYv4/X0e1eez1p7GirPHrCl5SjSy+kw6s70434muxsWGy0q4jc8aJuSYl8yd7VE1apjPos1abl30E6S1Rt5lYbGvpUxtTfrqYQV/4BQficbw== +sidebar_class_name: "get api-method" +info_path: docs/api/iiq/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Returns an Account resource based on id.

+ + + + + +The Account resource with matching id is returned. + +## Request + +

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"} + +

    Example: urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:**My Application1**:account: { \"department\": \"IT\"}","type":"object","additionalProperties":true}} collapsible={false} discriminator={false}>
    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"} + +

    Example: urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:**My Application1**:account: { \"department\": \"IT\"}","type":"object","additionalProperties":true}} collapsible={false} discriminator={false}>
    meta
    + +Metadata of the SCIM resource. + +
\ No newline at end of file diff --git a/docs/api/iiq/get-accounts.api.mdx b/docs/api/iiq/get-accounts.api.mdx new file mode 100644 index 000000000..a91844331 --- /dev/null +++ b/docs/api/iiq/get-accounts.api.mdx @@ -0,0 +1,75 @@ +--- +id: get-accounts +sidebar_label: Returns all Account resources. +hide_title: true +hide_table_of_contents: true +api: eJztWm1v4zYS/iuEvlwvF9uS49iucDjAzaaFi2abywv6YZMPlETF7OptRSrZwPB/vxlSb7ZkRVlfe4fC+dDKojjzzMzD4XCWayNOWEolj6OlZ9jGE5ML142zSArj1JD0SRj2J6N89XhqeEy4KU9wBnx/t+KCsMhLYh5JkjKZpZEgNAhIPgfeiThLXSaGIDChKQ2ZZCmKXRscRXzJWPoKYxGMwE+fBzAOv4W7YiE17LUhXxMcETLl0ROMsK80TAJ8RZMk4K6CP3ymQcYI+0IejJlv4p81Nyfw57M5PJ1bDjxb+MJ9MAiNPOJxkQT09SMoJuIF5v30YBibXRMXQRC/COLHKVFQiUYIVoKFqQeQiIzJzY8Xg9l0Mjklt8zFmeRsOBmOh2MyIFEslUtKV8PcFFRmSRKnknlDUNruDAHjP7z2dEbNnL1WoECFeMUwMlkgBXFeCS3D9DfAJkG2k0kMWRewX1Ovd6AQDNBEv/aYT0Ezxq982wD8AWkS8ogJ8rKiksSoDT2NqkvsPOrAKGkql5HHvraBBL6yJ4W/RDk+s85q6KwuTOhApQC9yVEJif2aW4lgcj80tTR6orLMOiagdQPWbcJc7vMcVZSFDngK0BROAtqRhD6x/XiqkL+fa6cU+P7cRjnixmFIB4Lhsgeek4ALicAqdRhQnTXAiYX7ElghbEhUbtFLrswbuGhg7THQRNhXN8g85i1KaadADpKk8TP3CpILXNylvu/E31GjE8sVeeGwJPNg5bq3vnMYytDgutZoE8b/wIc5COKncbjjxpPbuO4CQVwaYUZyWOnB4YmxgdRezBGIe2ya+L9tODdvJXg3BgIDtWFmLTePfhc4fV1zC0QJAim5ViZjSYMbTdem1o8loxs6y/jgbrV3CRnW/BR9W8sIDSV3XQtaKcMlrdw/JBc0Qv+JfOF5QCZgVCV+l7bDTniYaLRnWoy/vVhekVs1SjIgvtqIyuhWcmmaUmQllywUTeJtavo+GeAymzPp2wqhsIXLQ5sm3A6ZEJAphD0emvYvYOtNrsl4BAk3hdtr8ht6tyPLvaZJSw8owuXr8t+Ee4WX89DWLGpZMq7pTM6ncwp7+mxyPncnZxPGZjPP8h1pnU8dNJPn0ttDDFu2dp7KEPcCeeX8Dlt2C45tS8D5qdpbW+UWWglmhR1ZSk23YT/Q1IFQDH9m4OtI5YHabt6qMf+AOgE7TCmplKoa6o2A4SNwPlVEfJ9C16Sz2WzuzJg/s9js+7k1g/BN2JRaPpZqCCFlfru99zfLwkS1JsplmbIEnhFWnvP7A1pJmdijURC7NFjFQtpzc26OOP8ywhUxeh6PUIYYvQ18A9BrGa8P+RbV5305eDApajq7PXMVu5/rX1sH06O36j+ZJb1xvU2Wmqi+nIkobvzLzpxVIM0iDvtK3cdUiNjlqi5QO5Cq/5REUj8a6VIKZgQegQcehplEinTbSy1n7J71ykUtVINaLONKi2JCLkLVKpE3wGQq3pudeAQ7bOTuy8D5aN0/O+vpm/wQZUEAyrOsbStTlLtffnjXLrb2v8c/3x/gOXUAXHAGzpQyfDrzvKnrTZm3QYtb9+m8VLAF5YE6d9sWbNY17tm6XLAX19e/LC8Wd8tfP5KPi6tLm2p0TTOuVc3Mcv7oWNbTk8QTWJW9VMkp0ZcFNaGA3tW25W2sCynHyrHMdeCYzIXiDZIWS4ATEDQS6zq8obq+XhWxVdU7/KeTjv6l/nOpnWsTcpjLTk6uXrfS3slJ4TWbrMkD+A3kyhDAPhg2/F7ePRibKtraNvhNPY+jABpc1zI4mMxwo9DVfiMMPwZUNROg/ET9TPuYFj7GTgvSFWomtaDUc41qThwHjEZ1ruUKIWd9Zi30fVOhnjgki6h8G8Iqhto3i/QYtg+gMM7TKq+1D1CwTwPBTgn8xGMHyc8dzZlUf0l0EwfZBcB7mRbSKIPjyOsFsjPAVPheM1dUACgWkUKUZrqSVZwM75e9wICoS0zkAUOGtFTzbyOJI4bhDWNYGKyStdWV6RNxirW7Dwt21UTxATRLHtY2xbwK0UkM58KQmpxv49VSb0tt8E1IsZ/jgeABSjZyCHc0xZbi01PKnvYURh1gFBCpREAoaCVlt7joDwqOY7SJ4Qrewme0tXRolmFuytqJVtqiPFbWHi8Q13xOT6T17WJsjscDczywrDvTss8mtjkZmrPJwDy34YyuV3dH0VmM7h5nDy528qbwqM+hDCN5FXvqsNzpNrbtNcWAMJ94sO/MuT05H86n08p3z1CH7HVdPriXFfvd99uDYU0n4BZrPJlAsHRjuZh7p+a1aSyNR9HdKnL/6zJyb/tAtTX0ICSd5zh4rpLaPnsObyXs2W/dou952Ca9ezYp65rHjf7bOoopwv7jj+9Adfd4DOvcNI9NqP92E6rpvi1SV9Gp9rHiX6u6YB97WMce1v9Hd+LYwzr2sI49rGMP69jDOvawjj2sYw/r2MM69rCOPaxjD+vYw/qL97CUS2Clr+L8Xi6uYCohExolbeEV1KDPxXXaLA32sz6vzivyG7t3zWpHIOVVLZo4FC+fQWGOV2bVA+T+xTVsJnhnTDA3S1XVDwDgU+4uMgT56bE+qozWeaf2TRkUhGzkBFBbAn5jbFS57Medh7Wby9s7cllcQF5GkqU+Be59iN0sLPMwplq06QG3mXK5GPPhGTIG96cW+5VoMBTJkoAjYWtFKPm1vzevwm1BXlc34957Zzr3kWRf5QiOHzzSRXWg+lSKENsXtDHm+G69xsjdp8Fmg6/1rUWMUlF1GbaubPYj/TOuPu8x8DMDsNVl8PzUbqhbmO824L23njsxlXeyvxFT/4vNb8IobmAfjqTfdeZuQPXr1t+IqP9N5k4oRYr+Vtb8tS4ud7pq6+b3H+yvgy8pd1rSeg+7sugRf6QcTVK7EyRKRnH5YErUEiCLsqTOm8YVZpRS7sk/Xd7BHvUfKLS50w== +sidebar_class_name: "get api-method" +info_path: docs/api/iiq/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Returns all Account resources.

+ + + + + +This endpoint returns all Account resources. + +## Request + +

Query Parameters

+ +Returns all Account resources. + +
Schema
    Resources undefined[]
  • Array [
    • 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"} + +

    Example: urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:**My Application1**:account: { \"department\": \"IT\"}","type":"object","additionalProperties":true}} collapsible={false} discriminator={false}>
    meta
    + +Metadata of the SCIM resource. + +
  • ]
Schema
    Resources undefined[]
    + +The SCIM resources returned for this endpoint. + +
  • Array [
    • 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"} + +

    Example: urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:**My Application1**:account: { \"department\": \"IT\"}","type":"object","additionalProperties":true}} collapsible={false} discriminator={false}>
    meta
    + +Metadata of the SCIM resource. + +
  • ]
\ No newline at end of file diff --git a/docs/api/iiq/get-alert-by-id.api.mdx b/docs/api/iiq/get-alert-by-id.api.mdx new file mode 100644 index 000000000..f534aafcf --- /dev/null +++ b/docs/api/iiq/get-alert-by-id.api.mdx @@ -0,0 +1,62 @@ +--- +id: get-alert-by-id +sidebar_label: Returns an Alert resource based on id. +hide_title: true +hide_table_of_contents: true +api: eJztWW1v2koW/isj635oqwA2gUDQqlpuk16xmyZZQlStbvNhbI9hGttDZ8ZJEcp/33NmbGPAvCS3n642lYrxvJxnnvM6h6Uj5kxSzUU6Cp2BM2V6GDOpf1/A1xNH06lyBn865p1yHk6ckKlA8jkugOkfJzNGzCCRTIlMBow8cz0jCdXBjKdTwkPCFQzqTKYsbP7Dl6T10f7/Lf041FpyP9NMES0IT4M4Cxl8Eg37wo5zkSpGApoSnxE1ZwGPOAutCJxCV+t/ZEwuyJxKmjDNZJNURZEtWeynlRVJkRwrLV8TDo+U+i0FCssxJHLppPAFiKPImaGYI49zqmfwrIIZS6gzWDp6McdpCgSlUxhhP2kyj/FV4NK+650HfbcdeqxL+x48Mb/td3vMbbuR87KpJFCBiDa01IQ9JfuRcclA7Vpm7OVkabGYI8FwgbQ87JEAzbotEEMSiCShDcWQEA20xlxpBEbX9GItZdMEmmQy41tsE5WB8SoGkmp0c0KUIHMpnniIhojbKVi3kvdOvUeJvgD1PvM4RmlZrAvZa/N8hnuUZuzsYmsbxitYOyF0Po95YNzx7RTuNO0m+fDhTiRrbgPWngqNBl9Ab3744Lw8oHnYVQqBt10XP9YBjQ0dilCi4DjxViTwKeiGCEsnD9HmApFqlmrcq3LW1neFGy4rTIHiQLeaW/E83JZ+n3IgH/aF/dBRJTKhi3iEwg47US+KqNc/Y30Pnnx41XMpvO8i+Vajm1Kv0YSqgkBpmRaNKUuZVYq/MIN3n0ZfyB2TTxAV9mJxi7+2UTlX85gurmuFX9hBkm6C2C/hq5CPUSye7VyUYudubj+Bt6/Y9vcM1M6UIrdSBPhZbl+JGVtChnVWu0MolZKic3HNErVtFU80zuqOUXVeYiYd4IenoXhW5DMHG7YqI++GoFH9Hk/zyBaHhMCU/SIqxo4sOy/wd1J9Wy8hENK6oQlhw9V0IvzvLNC/nriqDKqUCLgx6jIHHmEXd8NbpO03yaJ6GffjUQHceEkZMCSbwzPwDvLzkG1DSoWo/bJnWs8HrVYsAhrPhNKDvtt3WzZG6AX/0VIBT1pP7VblnKrVi4wDYibte2HUMzm170cs9Fy33z476Jh4qi2nrHLZJDe3k9HN9fCK0DQk48vhRePm+uq/B5kEo0xpClqIcbvCbgKDu8a5LFt2+Hh72BEO4CA6Dwl2SwJrIiETMAiKYT9PmAdDRpolWEV+vRn/+/PVzVd49elyPBl9Hn0aIinw/fqm8vWhysEnhBlVkqIpnS5YxFOOr16jkNUqeEk1AYDTKYMSyCb84LB9BbDNFc1SyFMSwVgGRjXpCdwcQMfxolAHCSQDXyJQbmCuMv4LRQolQfWEI0iYkjznEXtUS3SuDE0f2QG49YYdeO45o16v014doZ7CCVWPZLxXywdMqz6LbqqnKgcMrOr5RyjFzizzqEfWbCbfF49a0HqczZRpM8MyJq8Kq6hAAwDb8rcfIYRCmDYDXAWqO7CgMItNpQwFWIm24o8ltRsVSHU21nsQMCFAzxgE7HV4UDGXZUnzr6gIqraITzN0lDWsRldrIi0Zai8b568qc+rMYQ3FfuY3TcHogVQ5NBL+BaJU8y6BNIcagSKUx8MwhMlqfxFjZhJaTC31AZfINyL+bqAohPLPkCUiH2lC8W/Cv/0r4iDodkcitxEPxiccrxYaL1CByOKQzOgTIyGPIgh9qSYJoymAUOv1ehn5d0V1TAQU4oYTgoyGBiFrx2i77XbDPW2cehOvM+i2Bx232T7rNtzuAO4SgD+mSueVI6uLn4ChQF94JC4hKKliEc8QIOfFNvkxQwGawGsNFHbIuZ2vFgocADQkHgutiHR/5nrTGd3VGVPQ9xOrSw/57WVUf3spoo1dnyPfbzadtuszP/IbQb9HGx33LGqcn7pBo33O4Jn5nZ4fmNKfyimrzVg7IdklRcn5POPBDO6NJiq++r7Ful6v6+J9i52dduiZ78Gly1sBmxwsRe7A4W4FT/WNxVNByPcHnu1awq672BeM7hUQEUkOTg25PKy5ga3Rsx/AF5pSKDjIFpCE6WqDwO6F3aO1SG0riBrVlY5i0sC6c+SL3mzeHTDniddF8z51m+55xbyxzK6/vNyPrzAUHmkex1ftpg/ZOub6jrHiiwhNC28PYWVnzMSWxCzYHaXfQJjnna8Ig5ulquXLYsiHD9xWvzneWefcg39dF3b/5uRVnLlD1fvPuLhhFU6EikGbg3NQorIjTDe/3K/yDyyfibxnbPqckDoHTqGiZd7hfMH+l7lS2/5nJuNXKHyr+BnlU0b/sVdHu7XJXAjAXK7MAxjf8HbUNJ0sxYJMwiIDAKbyYJgh2D8fqqNYkSXWzypzSpdEyEUvD7+bOQ4SwdNIbFNeQTq+vJuQyzScY9Qio1RDGUhBGRciyBJ7283LEDyT6RqXhuL0m6eoF66NFjbPb7aGg6IJzIHIhKarkm7VoEt3tuZsW24N+nLVpft/g/9wgz+3D81+6hbkBm7iuTHzZe4U5e8nJ86gaPyD4aHh4+Byidq4l/HLC762HWU0VUg21I8xfEU0VmyPmv5m3fUdpJpG3PoPEnknyzEN+V/P1y9ope89S+3PBaszPeAXyfFQrzSId+P8x533ZNfPP7WwiptnuqgCKanPjfflAabOGA2ZNLjs6DAI2FxX1m11+PFAZdr443IC4fN/1RDGCw== +sidebar_class_name: "get api-method" +info_path: docs/api/iiq/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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.

+ + +## Request + +

Path Parameters

Query Parameters

+ +Returns a single Alert resource based on the id. + +
Schema
    attributes undefined[]
    + +A list of attributes of the Alert. + +
  • Array [
  • ]
    • application undefined[]
    + +The corresponding Application object of the Alert. + +
  • Array [
  • ]
    • actions undefined[]
    + +Alert actions. + +
  • Array [
    • result undefined[]
    + +The Task Result of the Alert. + +
  • Array [
    • notifications undefined[]
    + +Notifications to send when a Alert action is generated. + +
  • Array [
  • ]
  • ]
  • ]
    • meta object
\ No newline at end of file diff --git a/docs/api/iiq/get-alerts.api.mdx b/docs/api/iiq/get-alerts.api.mdx new file mode 100644 index 000000000..162c0eb10 --- /dev/null +++ b/docs/api/iiq/get-alerts.api.mdx @@ -0,0 +1,97 @@ +--- +id: get-alerts +sidebar_label: Returns all Alert resources. +hide_title: true +hide_table_of_contents: true +api: eJztW21v27oV/iucMKBbFtuS48SOMQzzTdo7Y2nTOS76oQkGWqJi3siiKlJJjSD/feeQerMly3bSDdvgfGgt8eU85/3w2Hy2RMRiqrgIx541tO6ZGgUsVtI6thS9l9bwm5W+uDu2PCbdmEc4G+ZO51wSFnqR4KEiMVNJHEpCg4DoFfBGiiR2mWyTP8/izl/0P7fhSKmYzxLFJFGC8NANEo/B/0TNGa6JRCgZcWlIZozIiLnc58wjT1zN9ZR3NN/gHfmesHhJIhrTBVMsLlMi66TYD0PKj8ViZ2LpIm+0G9HbcAqrpDtnCyqBQEAVbAfEjRAJjdnwNmyRoyMQ1pAz5Q/1PnIoXb4YpguHroB5Ttse6mVHR3svGYdRoteBHnOgqM1ni6PuNAswFsIIPPo8gHF4NrtZw2dLLSMckcB2eA8j7AddRAG+wjWEfSe3lp39ObeW9bJuH6MgEE+S+CJOJWaogBBcAOvBtiiYyYeLVv+s1zsmN8zFleSk3Wt3213SIqFQ2p5yG9UCJDKJIhGDYNtAtJ6hQIiHJPpl+Qkfa9iaCREwitLxmE+TQFlDnwaSlfhUccIqPN0whaBxjHBfm4gxdi0U8IeISgka56FUjHpElOfwBsASGPpluYcGNsobd9KyNRYOvEkyWxKa++M7kGJuzc2IrmNvi1nk4rOodCEY4NuXMlbEmL5fB3yJRrngIbjn05wqIpAaihdJ59h52IBRUbR1j/2oAwlhid1r/AUcxy6DdipCLGFCAWoCKE2ORDJ1GmhEMrUZmiuSUL0SFXhU1fLS4GRwhcliBrICPJmYwEXA+O7ZZkSF0t9mZsQViwVtSYaBBcNbwKVCKHQl3JqEsB7Y20SnjbUQii4NkYEBJVKNuMdgECSKxSP3MsOW6G45vT/IPyLFmYCo/cQhYKQKSmmvzJsx3MOAa4ogVRh7SO2Y0CgKuKuD1utFuDFjtSEb3IiyCCQmMYyXkMcy6O2jI+sF0na2SiLwrm3jf6uAJqk4dLS9uRh/LJK3jt+qnOrbwK4rwIrBvmGnEqed3yRu91ySE6gNNKu4Ia6EosHEWGwVxaeyUafUM0XVw2hyqWOUeylAVMhNm/xbk0cP16ppk4vaEqHYvlIUNKLDuJMm7iouLf8bPUoSmbKea77Yl8YxRYPlii1k1SbLUfibVVs70IgPF0xKCBty2IXa4Qp4naSUrDvYYZIporR/he6qjrlXZelLyL9jxvTAZlB88UpiLPFU40+uTQe2c+72feY4Z/3BwMFPg/NB7+TU6fX7yKjx2Yo9YZAoEwK3TJRo3bOQGbeDvIiDRuIsflzRWw2WouDRTs1lFFBTY1SIX5pBUxjszu3fGGRx8lXEgfc7pGFmVkwX3u6x6WdMaVKmsaiUByobj+oi0QZCW+zgkQZJHfRyQCZ6UjP4X2PqPgTstD1l4Ig3lAfG/SGEIjcPbLmNCExpJjGjC63EF/g7Lge0+p2hejXuqNPRqJhOxOw3KGI3CcyMYkW+q6DKe0NhKVyuzTY/nuyg+xEU1Y/sn5c8BtoCMhxw+PuY+fUEv0zGGfqVNAAfIvgM7kvz4tIUtSVp1bFaAJkrFQ07nUC4NJgLqYYDe2B3TEhQS/69gyGp89jtlJiWnb5v/G1gdweO5/cH+tPMZx5USYPu2VY/RK4qPlgW7L7i0yaiTyp1KQwyMFtEaomnAzOLPMFJUNEHBuYRvsaRNoQA2EilYSAlBGsgVSwwjUtT72MRtDVMQC2JGeLr9eTvH66uv8Kri/eT6fjD+GI0HV9/gudP16XHu7J48kUoFKRwyXwecoSzjzqKVfASTgKA7R5SJh6d0ZPd7XqCo88Ng/gNpjRaxYHQjCjGNZkJIinYQRAsUypQR8UMnIxALYlpStsxVKCUuKgRPzWaMRztYvIk4gcfKI9rJZ5qRau+GXy9kbuOfc6o0+91CxbqBTql8oFMGtW9xcbqE+i6ssp0TD2WR4ENKgLgmZB2s4ev6WxT+fCwQgPkCSCMNJqlenXxkXzGUwMmvhQMVMi5DuvdtxjWJ1GoNuFwCr5LV1FAIZqXET9TzFBY+/w+QdNfwarlvYIgPfhtdYsrcItAryxzt1/9UqfsFXx7oMi8JFxDA+UuD0aeB8OyuTTRMwnNpuZ6ghL9lQDpgoYebcdCyr96bCHSEawxwPUhU7A2iMBbH9MFg/nLwh/Yw4ZUbgIdjE85HhD1WcYVSeCROX1kxOO+DxEvVGTBKJqrJDOKPpAmjTzWb4rjGPopNmI8oNFSXDe+Cha7drfbsk9aJ87U6Q1Pu8Oe3e6enbbs0yGcCAF/QKUCd3FRpnWBEjBk6DNnxSUEKZl4pznEbBdl26RsegK0hIdTOGWhPsx8uZTgJaA98ZBpbEOCfBuPdsFjSDGb1+WB9IQyrj+hZIHIrE+RN5tUr2vP2MyftdxBn7Z69pnfOj+x3Vb3nMFnNuv1Z64u8Gl8z2pT00ZIZklWbD7NuTuH078OmPufqU6d/qmtz1RnJz16NnNsp+8UwKZbiw+syD9jRX5t8JQQ8i3R6aKcUgual01x6YsEQfgxB4eHpO3VnLJWxNMM4CMN4ewbkwoQOMPTKu2P8BYsj67Gw93DvyktalSdO5ZONYXZoTOli36WO/TKLi82HXO+TK50n3s3c9q9tNffgnR2OdJjbPkoPN1saRAY6NyISseihV6wOeK/NUZCgSlr5WUwpMPNwvp6azlnp7Z9ap/bTtfpm69OsoNWvb9lbZjc6VAxi8waZbKDqWuE6Ql3Y+upyLGq9DVW3oQy6tu9BbW9A5V9eyWzY/3aV1iwxb7rrLtSTi71JnHdn35Wg3LtG85SP7m5KQl6P/Qlf3Zfsiq+tRb2Tk3kQ1vz0NY8tDUPbc1DW/PQ1jy0NQ9tzUNb89DWPLQ1D23NQ1vz0NY8tDUPbc1DW/PQ1vyvaGtqXkFKc5He2MCjN1VzeOjklzekbvuYX/wncbCHNVvrv1Ydp1PG/zCHZ7O1TuNIFuoTj+gPeM3h87itf3MqmZvgqUUDgKncHSUI8dtdeVR3E00QKc3J5Y2QrVSvpqEBcyxkn4e+qOq5hHTy/mZK3meXU8ahgkMkBUu7FG6yMOd9yMqofeRJ35PIvcAatE/QGLjSJrbOv94aGEX7jkCQUGQVRXD6U9r6ezDron0ufkd7uE3zP3KbJjVNxX6oDuRorvOq9rDn1AvLN6bQ0fDN8zO6y5c4eHnB1+a35ugakOnpLMBckN4/2Wgg/4nrNBvY083I4pJQ2tmz9G/nd2fgzXdnGtGt3fh5JcZX3qFpRJZf7Xklpt2vyWyFkd3neTuS3S7HNAMqX955rU3tfCumEUp2Wee1VvP/dSWmUVQrt4j+zfL6CfdfGnmpveNT8HSHDzFHpnThAuEc4hI4EAZus8PIdVlUtpzKbRjcJS/Wfn0/hfLlX70Abm8= +sidebar_class_name: "get api-method" +info_path: docs/api/iiq/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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** + + +## Request + +

Query Parameters

+ +Returned all SCIM resources for this endpoint. + +
Schema
    Resources undefined[]
  • Array [
    • attributes undefined[]
    + +A list of attributes of the Alert. + +
  • Array [
  • ]
    • application object
    + +The corresponding Application object of the Alert. + +
    actions undefined[]
    + +Not empty if action was taken on the Alert. + +
  • Array [
    • result undefined[]
    + +The Task Result of the Alert. + +
  • Array [
    • notifications undefined[]
    + +Notifications to send when a Alert action is generated. + +
  • Array [
  • ]
  • ]
  • ]
    • meta undefined[]
    + +Metadata for the Alert. + +
  • Array [
  • ]
  • ]
Schema
    Resources undefined[]
    + +The SCIM resources returned for this endpoint. + +
  • Array [
    • attributes undefined[]
    + +A list of attributes of the Alert. + +
  • Array [
  • ]
    • application object
    + +The corresponding Application object of the Alert. + +
    actions undefined[]
    + +Not empty if action was taken on the Alert. + +
  • Array [
    • result undefined[]
    + +The Task Result of the Alert. + +
  • Array [
    • notifications undefined[]
    + +Notifications to send when a Alert action is generated. + +
  • Array [
  • ]
  • ]
  • ]
    • meta undefined[]
    + +Metadata for the Alert. + +
  • Array [
  • ]
  • ]
\ No newline at end of file diff --git a/docs/api/iiq/get-application.api.mdx b/docs/api/iiq/get-application.api.mdx new file mode 100644 index 000000000..602f5ce3a --- /dev/null +++ b/docs/api/iiq/get-application.api.mdx @@ -0,0 +1,55 @@ +--- +id: get-application +sidebar_label: Returns an Application resource based on id or name. +hide_title: true +hide_table_of_contents: true +api: eJztWN9z2jgQ/lc0nrtpm3HAEJIwfmMS5o6bI+lBcvfQZDLCloNa23IlmZRj+N9vVzbGGENImutT89Aa/dhdfd/uSrsLSyRMUs1FPPAt13pkupckIffMkGVbmj4qy/1klUaVdW9bPlOe5IlZ5Vo3U0ZKK4hkSqTSY+SJ6ymJqPamPH4k3CdCkphGjHAFi3QqY+Y3SE9rySepZopoQXjshakPS2KiQS7ISkApIx6NyYQRlTCPB5z5mXBc8o4WAt6RrymTc5JQCWo0kw1yF2/KZ98y+YEU0cEa8k1+b78mBEJ5UxZRkBpSDTJAYxkarlxYd0yOjuDwLmc6cI0E5SqPR262GX5QHiaCx9ptNRy3JKBxdHSHxBRqkZ6FhaACEXS9EPi0LY7sJFRP4TsTbbkLS88TXKzgKPEjzLBvNEpCHDoPHPxrdZ12t+UH513zNQkoZV3n5HRiLavUlzgVQa0TNECDZF9TLhm4mJYpW9qLzDKDIEyvrC/APdBc3GfjtB0wCt4EG7cMrPomPcTZGgS3VQgmMxqmxnUp8UQU0WPFcBJZDrnSCAC4TegbyRNWePiWKwcAGaPetGxYprJkHYo0PhiGKAwFiDicwz9M7RRtr30WXJYZENAu7tu5Yyqb0NgncCIKi6ccrKASFIdPdF6SiyZCOJQNtHbxth0cB/L3WtbKIcz+B+JWB6rJEd9P3YZw9gPZu8c4zBQp5KXtOPjfJvAjIwKRUsBWuCOvT6gCLSLzPe5jiHsi1izWKLGUhZqfFYpdlNwhkXjnaJ4Zwf1tGwY+COJ6PvjLXBmB0bJxFnuPU3nOpHN61qWdgJ13Trte56TD2Pm53womunV6ZnJY5rhVvbcxB8/JkhkiWFULNIMPmenh7fgGqU2zLdSTQqmMODAdGFFMVxKi2m92z9N8xsglbPa0gPDajAm1bW6vcN5QeDTk/wIl5R37kaNS0nnZArhFjBwT0fHD7RgmTeDk4RhRyDWZlQ+FlcQXZtynmhaYeUImAsOLxEw/CfkFnW+50lw9BsrGmRcTXUWMHOffCF2RWvbAtlrzUqA+WZeDUf/i5uFjfzQcjMeD6ysE6+r6YdS7urwePvQuLvpjHLocjC+u/+6PHsYXv/eHPeseYRBPMZP1OJip/eaIyWc8ol2JI5+rJKTzq1rHvswmi2sapZeCNFO7H+w/BCPjCLITgpu7RVXNOlhfKPyQkP1FsqAmZEcDyEoBkyz2dh9t4y2y24yp1onbbJoomAql3a7TdZo8z0b8axOfaM1Zu3mr4N3VfN7qJdhdMmacpfDtU/yZO2SFdZJveJ79HYSgS0E23y16Px6ve6G6mWi3Gp4u9TyRxiY6n88E27aS97kAmzxKkSY2YdprfNh/hJLOegdCnehEOUTji8Fwfc1JlsA30g/VC0730RNCFsHQG7lSTnHzLbD+te3UoI1OiO+F7bMPYdQk7rrDN7aczJMMn0w16QWGNTdvGbgfy8w9UUXybXV4wYUBxSGMgBXsGEVsgNh22u1jp33cat04Lfek4zqdhnPeOXZOXXi6wLEQ3syGOlpXszuP9wb0le/3AxICmEyVHgrf1Jd7kWRbQOJWEuV7vxtOp+t2Thvds7M1nDPIajvRzCdfAeY/d1brrAPItNqdDvB3Z6Gy1d6bnalgMxZR/jPvgVLnYrkqQGqy7bpIV1A+zUQ4W9dRu461egRwzSK1XdQsy8+DV+ZN6365+jMBOxV5R8ZU+3Dxutamuy02qv0l1lxMzlYdgVSGL3Bkq1qAld7gBpNMtHn4ozGmCjEf2N/4OMjKC8W8VMImYwAs5V4vRcM/3ZdnTc7KUkppTQEpmryqH/G3WWMhKDwOxN5qYdSHV3k/9g2+ZAAFiQwo+M6l8FLM2Vks4TMVz2T6KIXPW93GCfKN+b3m/EY0HBSpTgDIiJo4ySvgomqKn6mX1u2SRhXyxbqE+tlQ+/ENtdz7NPumm/BY5iaHmCBa5OFX6YLalrvZbgMXxxDDhYsFMn4rw+USh7N+CQYFPNPpJMTUH9AQCv7DXeBn3+rVnY8d5H5h82rTcVXvmlbXW3H1s1v11pzVNhzX3N3jD8mRvBcG3ftR3qj+QA5rbNcauXozxPOyWYXDbSQN0xiZMupjSwBszdb0PMSztHurpYaHLB4Jv/Vv4IL8D80MAE4= +sidebar_class_name: "get api-method" +info_path: docs/api/iiq/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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.** + + +## Request + +

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/docs/api/iiq/get-applications.api.mdx b/docs/api/iiq/get-applications.api.mdx new file mode 100644 index 000000000..13ebb101a --- /dev/null +++ b/docs/api/iiq/get-applications.api.mdx @@ -0,0 +1,72 @@ +--- +id: get-applications +sidebar_label: Returns all Application resources. +hide_title: true +hide_table_of_contents: true +api: eJztWutv4zYS/1cIocW2W8eWvc4DwuEAN3FbHzZJz07uPmyCgJbomF1J1JJUsjkj//vNUA/LetnJpkU/OB+SmBTnPT/OWLOyRMQk1VyEE89yrHumR1Hkc9csKatjaXqvLOeTtbF827E8plzJI/wM566WXBEWepHgoSaS6ViGilDfJ4VzsK5ELF2muuQfc0l6/0x+34QjrSWfx5opogXhoevHHoO/RC8ZnoqAKSMuDcmcERUxly8488gj10vzyDuaE3hHvsRMPpGIShowzeQmL1Jmxr4mzBZSBDuzSw95o13Z3oRXcE65SxZQ4OBTDfSAe9GqhCsHxDsg79+D9RzO9MIx5JSjXB44yWnluEIyp9+1ncLh9+9vQnBWzh1dtrI4usbIBXsh7MDHBfdhHz4n5CxnZemnCHcU6BLeww77SoPIxyXcIewLubFGruYPjJxxyVwtQNGD9P8by3ouR8PI98WjIgshU6skTCEgXBDeAy6o+/SX04Pjo+GwQ2ZAB+PjQ3fYHXQHQDsU2kRPHp1wVoIB4ygSEmzXBab1+vlCfI6jn58u8GONlnMhfEbRWB5b0NjXlrOgvmIFtbWM2XMTfQX8f37a0X7mTJN5kJIxRRJ0IIoi8ydC8zR5B0rnAdasMdK5lN4Wp+baWlS5kKllUVHEdLki8BmGVMBDyJjHJdVEIDd0IbLOZedhi4yaSj0JPfa1TkjADHZv5M/l6dsFkfttEqH5DHm0JUcWRCwKRiWK6WbBXBGH+m1kmqVAkYgUxsEcjASiZPaBUAZ4uGfNwqy9/YL46uB2Z8EoYC4crIiFwFMEYboL1nYJHitBGnmgfgyPQlgSVwQBPVAMNxHLfK40Kgv6+56hPGfpPQC7ZSRHZGDUXRYFS1gWpEOSBnUBB4AYEhCh/wS/YLOJdGeN0gDSzBgB5eJeJ4Vf1SE09AhoROHhJQcpEFqo/0ifCnRRRLgAigI2+q16Hezov9d6rXhpsT/BcZlCNbfit7tugzj7C70HVUvGSKFfBraNfzYNPy3ULrPTyXlDAQNudAVABIAHkKDrZ3p/KKSzKvg/kniNaZ5w1UJTf5pgQpX9RQ4btXxzDVGAZqSy+icdjKkC7FY4XbXhpuGGyGlc2SWntbXQmnyl+mkVD7EzdWdVLmP0WVIpxSr1ZR7ea7pUSoo5yDULVDXNngv8Plm1BRWNuBMwpQCTlTOAguoj6DpNOVm3QGGa2b1Av8J3073cq6o08SBOuH6a/BsiObPyRmx2WkDCtefDw6MTOlyw4+HhiTv8MGTs+NjrL+a6f3g0R1UTICrzvQ45+IXgprFimS0xZbvZPr+eXaGH4+QIdaVQyUWGosskFjajUrWLXa4YSxhX4/lRDka+cKnP/wfOL55ot1zml7XXV5ahYxA6vLuewaYBwjT4Awp3RyLl3bqu9YRZ96imuc2gaIWyE+CShEw/CvkZweQ541yXWKZwfqmjG2tsNF1+VbSYLXvmpYb6ZJ1NpuPTq7vfx9PzyWw2ubxAY11c3k1HF2eX53ej09PxDJfOJrPTy/+Mp3ez09/G5yPrFs0gHkPI71o7mK12ccT8D1SxU8ojj6vIp0kZXyF9lmwmoZtSL2Bwwrbd2P8SjMwCQDE0bhoWZTbrZH0h8V1S9jvJFjUpO50A2C2YZKHbrFoO0e1iLLWOnF7PZMFSKO2c2Cd2j6doxL/0EAZ7D4PetYLurLddauiKinfdrAnDP6YBWfJ6Cutqu/cbHIIhBVDeTLrdHq1ttaLcN19flHtrJyHtlNPTwW4Wu4edkKAqK/khJdAh91LEUYcw7XZ/bFehwLM+gJAnBlFqInOb5he6ZBH8j+5P+84xRoLPAlh6o1BKXdx7C1t/P7BrrI1BiPVfVfdzWDXAXad8txJkrmRYAtfACyxrbmpTuB+LnnukiqTH6uwFF0ZAsccGKdgBktgw4sAeDA7swUG/f2X3nQ9Dxx527ePhgX3oQCkKaqF5Exnq3JrtNqr3Bu4r3u87AAKITJU+F56pClstySqGxKMkSM9+szntE2d42D05Olqb8wFQrdGa6eYrjPnfG6t/NATL9AfDIfgv+QosO3vVCAWbuYj0t9QDa3tZbRXz+qtF/BLmQfgP6764Sa1vr5635jJU0NnPxq1hYu2nv0ebdGjb+0bprRulLZFfatN18dVBm9j7PmvfZ+37rH2fte+z9n3Wvs/a91n7PmvfZ+37rI0+K8vZpUiHeTAXKdy9jrURcfh6ksmHbE4klv4LYtcqv6sslN3GDAlpMqf4lhG6H3xhZ/7BgZffJ8mbOMXcWMIhIwA8yt1RjIJ+ui3uGphKUKTwTG5FFDl71YqfzTMWGoGHC9HaIEzHUIiPs4mlCfReckEhXM6EGyNMJ+mDlSnqZKZr8jC3Trof0MUI6TX6G9KgKHo3AkMG1KRG+rJ4unU4qmzg1fpV437Q6u8xaJXGn2ZfdQ8qZG6Aw6TRKk246sQc5hSur1aYGdfSf37G5WSWALMASnE69xHe04mkxij4KwasGpT8zEDY9RRZ1uiZ2YiKAsnDpZGs9iPbdH7p1FSrGvkw1ytl2n0waqsY2QTXt0uy20BUu0DFca1XSrT7OFSrKNmA1iul2E8/vdn8TKubNkbX/hRf7Wee3tpntWNra9/d4gfJ0XmmLIMbjFEEKbyrEgojFwUunKoMQiGVvCD9dXwFxdn/AWGYFwA= +sidebar_class_name: "get api-method" +info_path: docs/api/iiq/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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** + + +## Request + +

Query Parameters

+ +Returns all SCIM Application resources. + +
Schema
    Resources undefined[]
  • Array [
    • 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. + +
  • Array [
    • 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/docs/api/iiq/get-entitlement-by-id.api.mdx b/docs/api/iiq/get-entitlement-by-id.api.mdx new file mode 100644 index 000000000..a8410948d --- /dev/null +++ b/docs/api/iiq/get-entitlement-by-id.api.mdx @@ -0,0 +1,66 @@ +--- +id: get-entitlement-by-id +sidebar_label: Returns an Entitlement resource based on id. +hide_title: true +hide_table_of_contents: true +api: eJztWW1v4kgS/ist6z7sRgkYAoGgzOi4SXY3p7zMJUSn00x0auwy9K5xM91NMiziv19VtwEbjANM7svpZkYD2N31+tRLd808OQbFjZDJdeh1vAGYq8QIE8MIEvO3KT489gwfaK/zxcu80d7zsReCDpQY02bc2hsCy6xgCrScqADYqzBDNuImGIpkwETIhMaXZqISCCsXfcWqH93/X5OuMUr0JwY0M5KJJIgnIeAnM0gcCY5looEFPGF9YHoMgYgEhI4DLeGr/d8moKZszBUfgQFVYWWc4LvjFCk52pVXuifs7swTTbl8RwadeQn+QNPBymzW4ILsOeZmiN91MIQR9zozz0zHtFgju2SAb+A7H41jehT4vO3XzoO2Xw9r0OTtGn6Dfr3fbIFf9yNvvu4s9IKMCt1VQcoKvk2EAgSEUROYH8+cRFY9fJ1KvTL2jmLy8TgWgQXbpkRdFsjRiJ9oIBsZtHQstCEpec5VDjnrmKiw3lBsOIDpCaJbA3IqcNcx05KNlXwRIQGTyGnct+L3k/6ZOPYlevxVxDFxm8RmwTu3rg9EYwlrb5vRNsXY0Xi0/5i9iwm3or3Cjo4e5SgXRxgAiTQUAwvRK0dH3vyZUOJ2aRK87vv0kRfowZpDM840qhNvyQ99jh5i0hlVhATAQCYG1xDFjMbV3zWRnWXshe5DDxvhhBDhpgxPiUAXIF0KMoxgRfYw+VxFLLdbvhX59Idiql0Lo5aNrnY/6rfCut8IamuO0JsydJeOiGXAY/En6pvdUS6S7P8OgaHkkVPWkoJNZpSH3TvGtZaBsEhI0xbGSNYHmZ3lNoDk30+PpOgLjydbmGaeUIisVI2kGpWTv8BnMhl8PDq6widyCsAuueGEjKOji2r6ll3A6KPhCosUYldAEsbTLNeLKr735nPyh9DjmE95P4Y7G3jrAl+uFjAKrb1Rweuc7OEWbJgDn+5NcaDkZEw0s0FeaOlAKhd8NnF1V8uZw0o5a64Up4wkDIz0ZhCVeDjLaRNb7xBSENZ8v10/Iyv8RUFULMbTw/VCw8dP17erTKJgjN+RO4qYZvQs2jN2LRdvaMy4U61aBA+lNp223/arLoWYqfhW1YEYVV/q1YxBdHUXpVJcFmOSdNuCxazpK+z+c+/6/q57w3gSsoer7uXJ/d3Nv8p1eux+ptBAGeRrAqqYu33130KP6zlKvFbks3uS6DAw8f75qX96VvtRMB0o1s4getLYo2xFT1aLN9GTWVAEIif1QfC55dhY/V0OEyrBDkfUJYI2lEI3pfkl5gPXw4cEW3C1J9PoulPAkkKGe1/KGHiSZe/aUI8PBgoGlHMOYTjkGtsYwNS1JLMb10UzVFDYF6/2TvYjGPVB3UclNXVF3C7Ym8Wnuw9YpI7vnz78hm0PV3j+Qij+SlVG09NLGEmqsseXnz5gp2foU3MRj6VI7A/sJkm8mGvzABEGw7AYdUgEegIh9zqEZAN0r5wcbbc7g1M7wLG380Lcd2JwY6kadb9eP/EbJ7VGr+Z3Gu2OX6uc+60Tv9nBnjOVr2e7gm7q2K2Fkzgu3U9VjISj/cy1FRDuaOVCHfaQOUCmGtvRtHZsSvspv8CJle/eilrE1cntyxoPOrDnU7XLc8WGSnNgaox7Sz4vUjn2nq5JS4gi3CdetuWHNFZdgkXl8B8et5e72FaOBcEa8VjDhmXfMuzSrs6Cb3fdyU6Vex9T5dd2D83ze7O0nKQSA7ElWNy7Q+j/0r1l2Vjc3icjYZPplfdhkmPgKhIe+rOn6C0uDBQUl5C381i69Qcygt/s1ZqdZr1z6lf8cz+TxeQ2xD493FBh2yv379x8ZO/0qot7pFYU8Vr7DNo1/NbHRy2f4/PmItveytBehpWYcO12yebYkd223bcHmLBWO1+Z8AX7qEILZiVJF5Wb76v3z69e7axxXsO/TR+5fPU82/K4xNgrRPPDonXMQpowifpwpifrKaaAcUZSd5B1Vx06g+pFA77c9MWbqKQjwEQde/OlO+TcTrqzsyzpnVrF72QZPFOKdr+7E1NY3JdJ+eq7wfM21sdVV2Kvj255wge5xxO6zUG8OlJ9cHdlSB/zyZ8u6cbwArG9l0p2h/SdTMBzEhPK3kdaujfMh/kCwT9e9RudZqPSOm2vAMq3FMPDJL9MDYxb1y1piVlmuxVNxZM/3kmsFT+EHAzwpJnhd0q8JsW3VoeY4CnFmruenzLOHpD64hYE3bVf1ux+vpFY8k4+ycQotJ9U+oQIutB/EfBafHA+FHfXaT5GKTldiFoO4f5XgaX9QnrTtfVmYaHYGy0DVzIWCbAbgJIziyhqoHdkEfj9RvOszRsRtBrNdtA4bQC0WlE94mH9rBVsP8fTGR5fgIIkKNUxN+V4t6P724JTJsdkLOKCTv99kL+usbvJsTzfsHoM8NcQj4Lpo4o99c1XHdVQpoNBO76iMuHlu4ZZbnw1p3kGqJfFiGui4j0s6q3PNBYhcv0Pdz3jSNuZAQljrzDsF7RF9/N1xU4mNAQThZusALhUBK6+fXnOvn2kAukCKLNmWWdJ5MVsxqZPWuORUUQSyU0/ZiR9uHrsoTdCW3bZNeZBFXFE5qUMJiN3PYlVkNIT6WQHg8vexWtXTslhZNEC/S1pVJSCYYyGHPFkdSxZDVySN0YtbsySU2C2mrr8f5a7yyw3xYmB76aKGVbYc46F+ywNlLWR+bHXyU96EYwUDLRwNiPfPKl4PqfHbmpI8MXcTvdjYVqsS5z2PzZB3WLgP2Dqrc2e01rk2aHr+9vrHcalpboUjoRXOj3TDyXcNetegPjpIb0N+pmVz/sLhVscN5JpVpyl0Dkgz+koMQQeUn+EMro13SCAscns3pjlknLLEvPrVQ/T638Ah3jyLQ== +sidebar_class_name: "get api-method" +info_path: docs/api/iiq/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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.

+ + +## Request + +

Path Parameters

Query Parameters

+ +Returns a single Entitlement resource based on the id. + +
Schema
    descriptions object
    + +A list of localized descriptions of the Entitlement. + +
    **Employee Database** target friendly description"}}>
    application undefined[]
    + +The corresponding Application object of the Entitlement. + +
  • Array [
  • ]
    • owner undefined[]
    + +The owner of the Entitlement. + +
  • Array [
  • ]
    • classifications object
    + +Classifications of this Entitlement. + +
    classification objectrequired
    + +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/docs/api/iiq/get-entitlements.api.mdx b/docs/api/iiq/get-entitlements.api.mdx new file mode 100644 index 000000000..e6402d594 --- /dev/null +++ b/docs/api/iiq/get-entitlements.api.mdx @@ -0,0 +1,96 @@ +--- +id: get-entitlements +sidebar_label: Returns all Entitlement resources. +hide_title: true +hide_table_of_contents: true +api: eJztWwtv2zgS/iuEcEDvcrEtO07iCu3i3KRdBEiTXOJgcWiKgpZom7uy6Ip00myQ/34zpCTT1sOPpIvDQYvFJpHEmW/eQ87yyREzFlPFRXQWOJ4zZupjpLgK2ZRFSjr7jqJj6XhfnKXHX/edgEk/5jNcCesGEy4Ji4KZ4JEiMVPzOJKEhiGx1sFzKeaxz2STvBvGpPWL+e9d1Fcq5sO5YpIoQXjkh/OAwU+iJgxXzUQkGfFpRIaMyBnz+YizgDxwNdGfvKEZgTfk+5zFj2RGYzplisXVvNgPw2sUi+nG3JJFQX9zrgNYJ/0Jm1IJLEKqgCCwt7VKaMy8u6hB9vZAex5nauRpetKTPp96yXJPUh5qPXvtputZFPb27iKwWIYB7fbkcLSPRgfvIngDf454CO/hb0PT8Z4c9TjDNxIkisbwhv2g01mIjwIuZyF9pMOQXcBywr6TO4f6YEZ5LsZ3jvO86g39MBQPkoxEnKjF8AMJfV/EATBA2a8/nTSOj7rdfXLDfFxJDprdZqfZIQ0SCaW9J/NOrR0i57OZiEF3TWBaLJqE9x8eNxSNzmYh9zWDUimQoEZsnGMegqWGj4Rm3vwGsGWOUA3sMg7WqD1gIwosEJv0IaByxmDZ4xzgUzT6lEfg2Q8TqohAbqhpZJ1h51EFRkVjdRYF7EcRSHA5Ntb4Mzxt14LcrkKE6tPkUZccWRAxspRKJFPlwHwxj9ROmFzXzcG6SWLaoIrm0yHoCdCkKgKng0ges3I8C4O/iqcRX0yntCEZxi6mhpBLhYjoUrIyeXU1LzaJzr4rCQhjBUKOASeSz1f74BNkFot7HqS+LTG2M35/l/9AjkMBOe+BQyQmVkp4L303ZEjDgKsKzTyMv1J5pZm+CQn3RtjCS0z+mIIg/6egm3t7zjPUvXSVRMgd18Ufy4CuE0XoBHZzcvZ5Ufd0SlR2rWyCoL4AJwb3BkqWpK3fJZJ7sjQEBgObKm6YK6FoeG1cNo/iwvbqhHtqomIY5RHltPdR71Z2yLEbVIW3Zo8Brk3TJCeFpXVBPldMK9Fh2klqYx6X1v+NfkvmMhE9s/yCLo1jiq7KFZvKvDc+W/y+OIXlmc64N4WaCHlDeh2ozOcg63XCyfkKFK5TQ1j0c3yXbcyDvEi3EQf9EB6Az6D64lTTVitgSVYQT8cjF/9p99xOrx2Mjnv6t+Fo2DvouN3AXwmyArX2syALhU9D/ido1l5RDUkMf4eKj63KkrCaFCv2LfOOUCmFz3WUJ+0YOLHdYlorq3XAom+/fkBB72k4L2FqPcHEtxAVnGhaTf4dPBPR+Je9vf7VN2iTeCT39t61kqdkQGNotcmnmEMEho/k1OL9/IzqN03Xhc6cq9hOFx0Zwdy6tQNkmFAB5rOc/PB0a7pXWO2lTPK0nbYL9QvNoAlFXYT6i8+J8ZBq/mtCp8KuNqe8R71CIFH/kLoHR8eohb/FbFQM4/b6LJVwqUzALzP4HbjTrPO0fdzSazW8iVIzr9XSfjsRUnk9t+e2TOJQj/x7CxNX677TshQiW2VCsQCaqV7nyFnnnihbiVvaqm+Sy6vB2eVF/5zQKCDXH/unjcuL8/9Uy3QZUz9k304/fBNUconRAnjEQwRFoRCJfvWzPIkHayxYZL9LRLRjhnbBCAf+ix1rR1gbO9SthN6z1JNsKdZ6kvVBkUMZ1Du50ikbxpT8JkSQeFHMoLBCGzIsqkKfQjo2pxMBOjBLG6gFFI4dVkbB4j0UImQ0spmreM4wRY7HMRtj9tmF4YTCVpQxSGIZmc24po1uQWFPX72sppSEzIK6/mBrHicX7zM2+5e372+YP4/B8/D3Re2R+6cn76GLV/gzOy3BP2CngOhCip3ZCEJhUuxzp6DKAQeHe5iwKOdyD/oMRy9fUngGGNsDinv4AOg0FBBakqLjdjoNt9todwdt1+v2PLfdfOseN9xDD/YTCT7TIfQTw5aWUOSQmR/rGYLD9URpAizYUMkvxewDUwntaFJF8mhPlj8wsJa7t6IWESOKxxgfX1Z44CnkcqI2Wa5kc2IyYKKMS01+GVK1692e6U3AaIRnVfdl+SGJVZNeQTj4F/Y62SpSyrEgWEc0lCyn2XWKzfRqNLi+6442quH+FqpaBvRhmyz/Mp6alYj5mJdEi3mX0t/G/Ff9zzfGu8o7ZiCprK55G/J2nD+bYgQ7X/tYpMR6fsyKq8f6FJYsfXky6HqH3WbvoGslMFHmrLfX51jTtsr6G3cd9ml6efNhbXIxUX4WgT6EqFAhGNRWnk6vU72s3LYbqtA9HLQPvcOOd+A22+23CxXeQwNVqEEbSfJRtfrunN/unPZR9+3bw7b7tguGMmf2aVc4KPTm9LBiyaXRJ0EeSuR8NbsUMLaQmk2tdUqz0nmvO1xZO/vQByxJb9Sfq8K6nuXjjz8UbLuhNC76EX0q+JlGdLz0WB8Zgb8aUkNmDj+BPmSSP02+Ddk9C/VxY7S5S5+LB8cARid7HbB4Drwc5akDv1KIHx/0Fv5JS8rgbshPE/3C0lVFamKa2WblMqbRH68Eq/LY8QB5zYvPq3ZRwW3iauZUFAdM10A9PQkxJ7ZbteO6TW6ciEjBllmJWDaQoIn8e84eijfMu/rdWZKOASXFYZPmEGx/CLjJwVfp6UIq2Jp9H0h3ReG5/0fFXoUXdc4bcvDdYffwqEe7I3bcPez53YMuY8fHo86IBp2jY798+45bd3jBYhb5lSJmm/pX3bGvB455HFIxD3+W368KbM5vNMtqUYOZsem/AjYVyeOm3vE9Jy2VPV1Buf/5WiOWwv/JwZqIVQ9XDl23nq+89nwlr76VUdxGw7B6PFOPZ+rxTD2eqccz9XimHs/U45l6PFOPZ+rxTD2eqccz9XimHs/U45l6PFOPZ+rxTD2eqccz9XimHs+8aDyTdlUTkVxERd+jWCqcpc4BHoMu7tPrjfM43EKPzurtoTQuzv5tzmIMaTKkeJ1ITfR5hf4FVNC/OmvqO0Ay2ddqAPAp901N+/LVfqunIiZqrG+y2oqQnaTo6pyJ3zioBB6NRN58FtLrjzcDMEJy2/YMkl88ouCPp8KfT825JFQ+zEkok74UmvUrTq95gHZCfRbIr0mDoBgCM1DklEaLXUhytanqYu+qgp8Wt5vqS8L/Q5eEEydU7IdqQc7meiKgY+kpibr8lW8MLHz+9IThcRuHz8/42Nzyw1CA4oBHa0FS7Stc4a+4IVwi5B8MwC5uQCflxdG3FrcWYNvLwZWYsqvLO2La/P7vWhjpReWXI9ns3m81IPtW8o6INr/yWwklvYe8q9f8f130rVTV0hXpn6yvV7jbWylL4c3lhUxf8Y+Ym8HEF9zqThjFAMKkaCj0fZ/NbM/J3fRFKln78+vHAbQC/wUYnVbz +sidebar_class_name: "get api-method" +info_path: docs/api/iiq/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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** + + +## Request + +

Query Parameters

+ +Returned all SCIM resources for this endpoint. + +
Schema
    Resources undefined[]
  • Array [
    • descriptions object
    + +A list of localized descriptions of the Entitlement. + +
    **AP_Logins** Target Friendly Description"}}>
    application undefined[]
    + +The corresponding Application object of the Entitlement. + +
  • Array [
  • ]
    • owner undefined[]
    + +The owner of the Entitlement. + +
  • Array [
  • ]
    • classifications object
    + +Classifications of this Entitlement. + +
    classification objectrequired
    + +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. + +
  • Array [
    • descriptions object
    + +A list of localized descriptions of the Entitlement. + +
    **AP_Logins** Target Friendly Description"}}>
    application undefined[]
    + +The corresponding Application object of the Entitlement. + +
  • Array [
  • ]
    • owner undefined[]
    + +The owner of the Entitlement. + +
  • Array [
  • ]
    • classifications object
    + +Classifications of this Entitlement. + +
    classification objectrequired
    + +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/docs/api/iiq/get-launched-workflow-by-id.api.mdx b/docs/api/iiq/get-launched-workflow-by-id.api.mdx new file mode 100644 index 000000000..ff132a08d --- /dev/null +++ b/docs/api/iiq/get-launched-workflow-by-id.api.mdx @@ -0,0 +1,57 @@ +--- +id: get-launched-workflow-by-id +sidebar_label: Returns a LaunchedWorkflow resource based on id. +hide_title: true +hide_table_of_contents: true +api: eJztWm1v2zgS/iuEPrVBYkuKX2QjLZBN2j0v2t1u4l4PqIMDJVE2tzKlilReYPi/3wwpybKtOG7XKRaH9kNjiTPDmeEzLyS1sJKUZVTxRIxCa2hNmXpHcxHMWPgpyb5EcXL3ywOMHFuKTqU1/GxtDkvr5tgKmQwynqIYEDKeMbJJRjImkzwLGLnjakbmVAUzLqaEh4RLGFR5JljYOvMz0n5t/p+Ic6Uy7ueKSaISwkUQ5yGDv0TBDCAwTYRkJKCC+IzIlAU84iw0MyAJXfF/zVn2QFKa0TlTLGuR+kxkcyp2b6aKsmS+72QFT3i+56QTMRHoKQlumlOYIaYK5MHsW77jcggqnpCjI/DSkDMVDbVQOZQBnw+NBHigPE4TLtTQadnDTSlHRxMB61hpg6u5sAQ8wJLFG8R6yTkuZkrVDH6bOazhwlIPKXJIsFJMYYTd03ka46vApp7tDALPdkOHdannwC/mu363z2zXjqzlJlJg9ZPocay0QHzGvuY8YwBOleVsebwwamnXwnCh/2ql99SV3afc4H5bq3MSJPM5PZEMnYWLEnOpUFO6hhKD2k08tsh4xrfWnsgcAk0ymKkBKcdEJiTNklseYlCgOAl8q/leyJc4o58A2O54HONseazKudfofIYyqpCyHvPZthp7+g755fe77dHgagHAr5P5WtxCvIlEYciV6raOjqzlDQLDcElU1rVt/LOu0JV2gSSUSDAh3pWUfApLQxLjTR6WkQoKNfGYeauEVFO3smlM5Zcrs0a1yMaRShC7Z0GOqqJFx1aQCMWEQjNomsY80Ohs/yXRlkVtYQAnACXFjeXga8WREkNk0wNvYzo1qTNEeQwUAGjWdIOnmoAWefG2wYBcGu1Nklgz4iWGaIEUP0liRkUdKiZkwTR8VEbDTVxFSQbVAN6EoOCJ4oDNpoJSySCXQDcGMkTWuqbfqf8K2a7tuid258TpjB172OkO3V7LHngndncIAFuWpm66eQxvD6bN43FXkqEiZcL+Gx4tRfxohzpOZ+XQlAlMedd8Kv6IItngWxAu8rkPKRTUK8ghoKciAXqj8hqm/57boXqyKcvqRrig5l1B+rtOnZs64tvSeVV4V3PtXtSPKa4SOQ+CJBeK/JoleUqoS9E5PISEwNXDFdRAJtWoIcJHIeSXFHISUhalo2QjmeHbrYBd/nOtmqEXkBD3na/kgWQNHdIL6GVyIXRzJ6SiItC+oRXZEyjvR1ob6B16fWfgeZ7+1Q28yKO206N1LT9kScCkHDWGwTcoPk8EVwnyYRVGkSROpq399bKdvo+KQdXNisS8C8YFGcA5w2AFZIZ5VmpV1QUNeGwKJDzgKA0Uv+WY+Xcj1gFNoIYAK42vmdrW5j/v3628Qcu5Sha5e4GKX0Nydr6a43X1MFJsTmoV7NXEOke9GbmEPi4ANz9MrGIulsHob9hOtK7n0EjjgMTYnoNeoxAG3W7fdkLX7bFB2IkGHvVYx40C5vs9xzntDvrAEnKZxvQBoxA4rqAKrV7+m8Y5vv2FCRZxJWGEo9w+O3U6kT/wT+1+x3N6nuuDXI/1nY7f7XkoVhh5RiEWolxkrzZMaFgYwhsAuULKDyY5wZvbrVnBP1WX8Jqcvafp6zOwEVrEL+wBKLF1gmegbK8PQGJAOBYpgKB3t2gQw7VZDUvBsUXMwxrpCtSu54RRX7fsnh/5p9QHaPe3uQFtWUQDVhMyGv25RVd5qUaHHtQeA9q29kC75hR4qCGo9ojoqgf9dQ5dJjSye6J6LdCl4d0T4BPr7NP6pLDWLAVTYKVxTUfoDYxKaAhXEVDSli1LBXJSghzYLw1mnF7XAf93vX6v10F03YmGoCgSOa6tiRvIWCHsP4PKSp3xY4YYIueXJtIuGVBRRckUi8qQXPz+CgrL8R8fX/2Lg9oZ7MADGuuKI/Et0oNa9Pjy4hWsiMK/1Z4SH8AgA/dMbagPwdh1a6HwlgsuobeAV+h7XFEdzo8l0YFt9yC5+zV6bKoqg2lsULPu8PbG6ryeWLpsijRvSHrn1X5EE9Tb9gImZa9fFfEaThL/L3ApbqDX2m9Ae3Oyr6RjQOzG23+xburOApTXwfKUSE20X7OIhfyKTcFyCJnHO9g18UizW3rxarkEiUmunvC3ofjnOHwzkxzQ7bsTxmQiCFnPGvoVIT+Tx3MnD+P79qbzG5LIRBwuUOpb+ft5bCIGfDBl6iKG1qJhBj1I9OgP2FR+YNmcS1kchIkn9zfPqMqurRAAWtJpU2f9rkgyJcWhFaVZRvHUjAOs9PSVwp8tlFb06yBL5rrxivI4hgR0gytdO5fckR+3E+OzKX/4ZFpteH9m05/Z9JFsqrMebzhO+Cg4uLM4sYi42R0/c5pp3vME9qnbdW2vG1irE0tQ8hrcmMunzxcuKg5iWA53mibyOSaba5Ne4M0nmgmjw5ssS3DrP8YsLvCYWT/MUzNwU7e75NcFSH65hJ2p4Eb7p4zbLAAr3mc4M6wSStEdZlrjlYHfdcq94n+uQ+641Ha7QhUjPwDbMqUh2Gkqpqrf4zzSTgcZa3ZqdSh8N2NiU8E7KknBeSATGs+sHz1H7gy7nZZ3WjtHjhOTgBtSzNW78urlGR0/UyodttuoRjxLpBp6tme3y5NY/rWNN7XtW7e9mk2298lE0Aaq97rC7FwlgFbNDmRaq0s/dpXs7tjpDrvu8NRuOc5gtUq3LJONi1TTqaA5+ApNrE9YJDuDAdTJQQfQY04LyjvAcWO/f1XeEKraHQ+Glq7mMtdRdXBdV0J07VyaAgrTzpLiKw19k69m8NDevKFsL7Zv85d4tcuy2/LaP8/ibwBtw2G6IRn9Sa4vRu+JEa1vUVErQkVI9A+w/vzDqKUvbCW0yRkwaQWAlAfnOVrw+aY+eo33nCY31WiqNIYql9fUOh8jjaXbCxElTfcVlaZXb67H5I0IdQ9FRuVBJrlMgnxenRgCxLVN+mOJCq+W1zrFFcPGrsF+LRoM1Tda4Mg51RgvLtpX99B7XEDzsLXp7sXqbvjntzX/5G9rCowqdq/aaUxNHdahtiiidfv7KWAbNnx9AxGBEYkciwWC42MWL5f42nzFgTEUckn9GMtCRGPJdqDm/+yLlkc8rXez658CFRtRS38Ec3h/HeBTlp22NH6is7LpBh8yjkZ9IyBeXBWfVb0ke3yD1ahhecIgHuo6lZo3QHp5A1wzRkPskT8Xhw/6sipVNRFbH7+gmVXp+/XNGLL9/wAjURPY +sidebar_class_name: "get api-method" +info_path: docs/api/iiq/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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** + + +## Request + +

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. + +
    \\n \\n \\n \\n\\n"}}>
    attributes undefined[]
    + +A list of attributes of the TaskResult. (From the TaskResult used to launch the Workflow). + +
  • Array [
    • \\n \\n \\n \\n\\n"}}>
  • ]
    • 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/docs/api/iiq/get-object-config-by-id.api.mdx b/docs/api/iiq/get-object-config-by-id.api.mdx new file mode 100644 index 000000000..1ed9825b7 --- /dev/null +++ b/docs/api/iiq/get-object-config-by-id.api.mdx @@ -0,0 +1,63 @@ +--- +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: eJztWW1v2zgS/iuEvmwbxC9xmjYVDge4ibcXIHG7jrOLxSYIaImOuCeRKkk59Rr+7ztDSpZky2qS3TvcLdZAUUciZ56ZeWY4HK88mTJFDZfiIvR874GZT7NfWWDOpJjzhw9LeHroGfqgPf8Xr/rKuzv0QqYDxVPcDXunESPVFUQxLTMVMPLITUQSaoKIiwciaMKIVISHhGtYZDIlWNgl/5ip3j9vxa0YGqP4LDNMEyMJF0GchQz+JwY0gNBUCs1IQAWZMaJTFvA5Z6HTgku+oxsB35EvGVNLklIFWg1Te9Wwr07NXMnkyYryTeGwRSGqQtfoIGIJBbExNSAEVNacxbV/Kzrk4AC84XNm5r4VoX0d8MR3m+EPyuNUcmH8o27frwo4OLgVEKqNXgzYykNfQ2hkZaGNKMeApdRE8N3J9vyVZ5YprtZgjHiAN+wrTdIYH72b9/FzdNofnB6F83en9tuMvR2wk36fnXrrbTZAdOW8mQ9dEK3Yl4wrBpwzKmPrw5WDZJ0Hr3PcZSCfiNMZWoZjF9eQBDJJaEczdBVGIubaIFZa44Pj5TbrumQaAWm3Ykx0BlmkGWgiu5Q4JFqSVMkFD5H+KE5jCmz0vdKvUeNMAq0eeRyjtiw2he7auhlDGZuk8fZ5bhfGEz1o97/Ya3uzqAvMvpZVqzUmlpAGc6tA2z048NZ3yA63SyPWQb+P/9UBTawHNKFEgwXxvsozoxAVIiGORlcKDzIwkMIwYVA0TdOYB7YK9n7VKH9V8RWEDqJruEPDw10wN4KD+0EuyMMSodAxZqscos4XJNgxpZBgcwyJC+228rG16rn6PmQijG2gd1JmR8OwKdjtGqlSFNnIDUv0rhObLcEq6dCUimzQ2k25to/QAMtbrtOYLsd7NeQLcjY4K7a1tivEZfchS6TTjFrd4iZ1+OZlavRGegLVgDfF5YOUMYPjaUFj5J8ILYttkYEqxTE97N6OXRA2ap45GVXVcxprZmvAnML2H3HzHme6FTmAF5k5lsLyUC81kOWFVrrNFdqYiBoSSiAqlpiILhiuckWBCtt54IvAEjdTdBY/0SfawHaqGqrA04Dm2ytQX/EulMeECvrA1CGBqsPjQzLnShvk6CGJqfv2+mkI2Veoa1BMx1kyY2oX5wXUPdBUj1mxqYIrkHGWCCKsmOIwCqmhWFTzdqaCiDuxVUSDvGiFZ1bU811Wgokoes8KK4B9E1GLj1QWs+YSMYE3JNOuQwuZ4gtm1ViAXXKjMxrHy2o3GDELRAGx4J+QJepryzeNWcLtad2WBxjlS/nAxVSewwmLKfGgZJZ+TwMj4Wj/A87LO1hrFXiNEiuYzJ3kLrmwB5dZ1uq7iJftvnSNm8dCbq5k2ODKEVAnv1xUwYHD0F3bIMGt8lGTRIbgV3cYNzoMhOJdZDIann8aX/4Mjz6PJlfD8Wg8he834+nF5fej0fmPw8ub0dm/huOPo2u8q5SO3uwE8Nuh2jWiiCHkiXWzJnO5wZ7Xt6c48MUnYvWcKr0l896w7Fy+za5x3tr9mzWw6dxSPaw2MRtDy7Z9vwIw2VwILG/grWGloeLwcOBX9fN82S6IT/YLjUmxxFlvgTBQRE3NZN0OyWr2/kC2t0rfxHzTOhErrUOmuGcNnwq/plTB3bqBX/kLF+FaQtgjTEcyi0NoaANWw0YyaJAri/VSBJGSgv/myPB/QElYOLiHEgR2vYiVxnquXceZTFKpwcD70eTz/cdYzmh8/xl4BFIS3yLgosTw32Im3j24yGSmO/bYdEWyw8SCQwwTsPXoP8bbLUp26KPuXB93UBfqtBdVDVqGcTwMApm5K1LT7aus5Pn9FrdhHSfUbYSeB+4MIo8ecBFPcduQApRyUU4cF88af154MrlT3n2ge2aG7ppwBU+xdcj5VL/JPDlHAsXwNtxAXHhsODCkaA/qF9RHcESxty1Yg/5g0Okfd46Ppkdv/JOB/6bfHbw56fRPfLgVg3GxdK5quJROLjEw+01rUBcZk/q9HgqNI6mNf9o/7feK8PEvPRxG9RaDXlVir2U4BG/Ye4sT6v+VPdpbvbU9MsJttZbg+d56W/HWgind6Kya0mJVm6pb76db7+jtm/fvT4767wcnJ4Nbz6ZsPnmYNl4IJ8VconorTAom6syiaNVbC+V687Esj2Q+wrVzQBPBH/VArepzwDWOhJhaFMPCTMXP4IC3PSMqcvXiB3J9dnFFnGg7gkE09tplvwArh58vunbSo1mQKdhkAcBSHgwzRP7LXfXtNbb2LuMqazZjLIRcjLdsScA13toW9LlsuAGVSCej6ykZidAOVQlejRS0xYycyyDDOuy6V6wRaJMdsW5I5J12jzFY3NQagsJ+KxoMtVUVHAk3vPJYLQdY4vmjq5o1q3KS9fcI/n9hBJ+T0sCVugeNARdIAJtbqzwtt35JOfT8rQE9UB9TD1euVkiEGxWv1/jYjXkxWUKucWoR5sddCyv+YiPvPR62/WP9F4OFG1x5dkr+5/vrTxh2t9rSOMMvbbrDPxRHo55JiFeT/NeX1+QbP9M0oitaI7Gs4ilQb1F5fQc7IkZDHEUBSrcIOkuWmsr2nRE8mrc50z6OplDOfwcBvw9j +sidebar_class_name: "get api-method" +info_path: docs/api/iiq/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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** + + +## Request + +

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. + +
  • Array [
    • attributeSources undefined[]
    + +Sources of values for this atribute. Identity attributes only. + +
  • Array [
  • ]
    • attributeTargets undefined[]
    + +Targets of this attribute that should receive the value upon attribute synchronization. Identity attributes only. + +
  • Array [
  • ]
  • ]
    • meta undefined[]
    + +Metadata for the ObjectConfig + +
  • Array [
  • ]
\ No newline at end of file diff --git a/docs/api/iiq/get-object-configs.api.mdx b/docs/api/iiq/get-object-configs.api.mdx new file mode 100644 index 000000000..cc8ed17b7 --- /dev/null +++ b/docs/api/iiq/get-object-configs.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-object-configs +sidebar_label: Returns all object of type ObjectConfig. +hide_title: true +hide_table_of_contents: true +api: eJztW3tv2koW/yoj/7NtFoghL4JWK9GE9iLldQm5V6umigZ7CHNre1zPOCkb5bvvOTM2trFxCGm32hWoUgDPnPM77zOnw5MlQhZRxUUwdK2edc/U5eQv5qgTEUz5vbQalqLwp/fZyn9vfWlYLpNOxEPcChvHMy4JC9xQ8ECRiKk4CiShnkfy++CBFHHkMNki/5hEu/+8DW6DvlIRn8SKSaIE4YHjxS6Dv0TNGG4IRSAZcWhAJozIkDl8yplLHrma6SU02/8tZtGchDSiPlMsSpiQMhf23XCZRsJfl0+yx+2/xA/ZjWGDdGbMp0DaowoIAduCLrjsAbIm2dkBXfU4U9OepiR70uF+z+yGD5R7Wqu9dsvu5Sns7LRuA7DQgj/a6cniaA+NDJ4F8AQ+TrkHz+GzoWr1niw1D/GJBGGCe3jCvlM/9PAr3EPYN3JrcZcFiqv5rWU9L1u873niUZKpiBI1GB5gdMcRkQtEUeLRx5Pm0eH+foNcA27YSfZa+61Oq0OaJBBKe8jCBWFvBGqLw1BEoLEWMK0WxxPiaxx+mF/gxwqhJkJ4jKJuXDalsaes3pR6kuWkVFHMSjK9u7waDy8v+mfvAa5C/LiM8Kl2gIL1tJLA50MqJRiXB1Ix6hJRsZTXSCJB0g/zVxhmpSGQkla68WYQWpLJnNBFzP1N5kKlHtFl5L7gLQu9WlQ6EPf47XMeK2JMvl8GfIq+6vMAAuhxRhURyA2VjawX2HlQg1HRSA0Dl32vAgmxwu41/gWctp2D3C6pMIcI1afJoy45skhtaoARydRqYI6IA7URJtu2S7CukyRkUAWxPwE9AZpURRA34H/3bDWezOBvczHiCN+nTckw12Ay87hUCIUW0qrJ+8u5u0V0dVhKlhjnkC4YcKpIrQ1wBhJG4oG7qVNLjLgFv3fyPXKcCMjOjxyySGKehHdh3YQhDQOuLq2UYbxCaw0idNDnNm+sx5XlqQXV4lr4haIHFQsz6SSrUK2dHesZSnS6SyL6jm3jnyKgUaITnYevT4bnWYXWmV3ly3oLZHYEODK4OFCiYehxRyfu3b8kknvKKQtsB+ZV3DBXQlFvZNy2jOIi79kJ99RaZRjYk6wMKqvdQLXnEkSJ27guwjV3jHFtmRY5qWwHMvKlFqAWHWaepK6XcWn1X5ueIZaJ5AvDZ3RpFFF0Wq6YL8t+mc/Cn63K1oKGvOczKSF1yF4HuoozkHWUcLK+AIVRaocc/RLfoom5WxbpJuDfsH7qNgLUF1XVx5xoFaHl2LRrt4+doylrtw+Put02vused/f3Dtr7R0corwnfkldhvng1vzMefEWapWAu0e9XBW89vxdUWC0H+qtBkzHS7Ue9IDyg0HA9mGzOZehR0y5V0k8WmK4mkWGZZz07XHbnMl8Mc3zN8iqG+GQzRmlvB+R9SCe8yjAfzBryQD10P2hDME/pOgKJBP5Rovc29QK3knXWQy546x7yeVG1/8DNK/RpViQANpJTM9O5bA6tpb+hmGZzznEUdlyuAFfFojGjDwxXmbRHAxd34QNHu24c0Yn3glKSRhpSYuDSqCIJrIcz2Z5D+o63oN75NIA0FTUIpEXuNeCUEUll6q1Hzbv361mNfYfKBdXRVJsyzqHJ10WbpZtyuBzhxX6QtmNJv+FSRSdUpoe+l8sAAndPNKnXqywDM6OoPU0sBfYiohodRbHHqrPECJ6YsgT9CfTrEOGajQbYIjcyhhZini+UM6aBwIkOT3WByFBfJzUeooTrhqwuDtDKZ+KeB2NxCi0T4sCouI9EHH6EVCOgg3uDApPzfmwOcaBLTZhMDeUWGSZH4EKSD7z5WkHBXK7OhVuhzgG4T3LqzYMDpaHKlkFSc8TzhQu6NS1XpdKAKBb90aB/enlx9i/46mowOu9fDC7G8P7mYjw8+zgYnP7RP7sZnPzWv/g0uMZRTqbsxU4Av2yuio4lsSPEilZzrmekaY5bR4Ebl8V8ucq0JZIjQNafvlC6wrB9ly+XX1mFS51qn3fzzcxCWpM/67n0Nfm7Ux4x7Vq9ElucIdDAqZD1Ur+hHkmXGMk1fwb0qSqIK+uRgAVUkwUPPBKBj838GwL/xZ4g50FN+iib13vNSIcwvHI+NqbRPas6GyQPjJULQaErmZyJ2HOhTXZYARiJoZnNLZbzwJmBvPzfxiH+N9yyc/cGp1Rac/U8ToQfCgkC3g1GV3efPDGh3t0V+BNQwXMCIPgVHoqnTB7EIpZNXT5Nosz7bPvnO63xvKLTNiw9k5DApe95fcfMe1Ycq7NsnowycJs+aVOzUeJkEepPOmbV1Vw3pgAlW5Q4jrFnwX82rE6m2psXdNFM0bII5/AtthCJPxWPNGvHiBMxHHNUOC58rTh4SNomFEemj6CIdG+dsTp2p9O095p77XF7v3fQ6e3brc7+QdM+6Nk2mssTRlUVZ9PRmR7wrhStgt1MqbC3u4tEvZmQqte1u/Zuaj7+bReP17sPnd08xd2jqY2vdtfudNvu9Kir303YYYfBE3ascUKXc67Le622IKkU9ITbCm3B67V1mNPWA4tkpbIKTNNVdaxurT9vrfbh/vHxQds+7hwcdMz/IaQjlnHlyTAdOxSOh37qiTLWKGr5Fkz5vHg1CtMqtNLff9TIqvr/t3LTxvpx1YFtbydWP3piVVbf0mxz9XRx/fq/HXhtB17bgdd24LUdeG0HXtuB13bgtR14bQde24HXduC1HXhtB17bgdd24PVLB16po89Ecq3bwnvCagYfCrbSN9xY9JBeHo4j7xVmt5YvuKXhOfzdTFwMaYJtOXLXBy79BhyxfzVs6WtqkjlxBJs0AFjKnX6MSD9/yT/VcyYTZLk1i1kSQraSWZXOArjGetY5fCoqDj8Z0tHgekwG6d11PBVF0A0zciqcGFOvaVoxLaBM+sr1wm+sbmsP7cOVtsay/Jo0CKoTKSgSDndZJU2yprkmn5yV0QXQFZbnKQXwT9k1vO3F+1948T5xPQVn5l2o+FzPaHQEPSXBVvzZhMSzB8YTPnh6wqi4ibznZ/zaXEXFCHC5xCGEu7izvtL2/40r+Cuk1M1Z9rOCBzMZsvTV2vUF+Hn37WthL/18YEPwG967r0W2+DnAhpjWv1r/Ioz0NwBvR7Lelfp6QPkL/xsiWv82fS2U9Ir/pl7z/3WVvlZVhV8f/GR9/YAr87WyVP42IJPpC36IOAqlGxfI85CecOoKGd1QgMMTC/OeU7pAj1QWPdunwRjal/8AHk150w== +sidebar_class_name: "get api-method" +info_path: docs/api/iiq/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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**. + + +## Request + +

Query Parameters

+ +Returned all SCIM resources for this endpoint. + +
Schema
    Resources undefined[]
  • Array [
    • objectAttributes undefined[]
    + +A list of attributes of the ObjectConfig. + +
  • Array [
    • attributeSources undefined[]
    + +Sources of values for this atribute. Identity attributes only. + +
  • Array [
  • ]
    • attributeTargets undefined[]
    + +Targets of this attribute that should receive the value upon attribute synchronization. Identity attributes only. + +
  • Array [
  • ]
  • ]
    • meta undefined[]
    + +Metadata for the ObjectConfig + +
  • Array [
  • ]
  • ]
Schema
    Resources undefined[]
    + +The SCIM resources returned for this endpoint. + +
  • Array [
    • objectAttributes undefined[]
    + +A list of attributes of the ObjectConfig. + +
  • Array [
    • attributeSources undefined[]
    + +Sources of values for this atribute. Identity attributes only. + +
  • Array [
  • ]
    • attributeTargets undefined[]
    + +Targets of this attribute that should receive the value upon attribute synchronization. Identity attributes only. + +
  • Array [
  • ]
  • ]
    • meta undefined[]
    + +Metadata for the ObjectConfig + +
  • Array [
  • ]
  • ]
\ No newline at end of file diff --git a/docs/api/iiq/get-policy-violation-by-id.api.mdx b/docs/api/iiq/get-policy-violation-by-id.api.mdx new file mode 100644 index 000000000..ee58b9999 --- /dev/null +++ b/docs/api/iiq/get-policy-violation-by-id.api.mdx @@ -0,0 +1,63 @@ +--- +id: get-policy-violation-by-id +sidebar_label: Returns a PolicyViolation resource based on id. +hide_title: true +hide_table_of_contents: true +api: eJztWU1z2zYQ/SsYTg9JKkuUQlsqb07i6ejg1rWd9mD7AJFLEylJMAAoW6PRf+8uSEmUSMl24n5MRyeRALH79u1iscLOHZmD4kbIbBw6vnMP5kImIpj9LmRihz/McKLjGH6vHf/G2ZrVzl3HCUEHSuT0jiKuY2BbXzEFWhYqAPYgTMxSboJYZPdMhExonDSFyiDsopqcK56CAUXK5k6GLygy3xRnAQnSlXMT47MOYki5488dM8tpgTYK5TuLNmyoVEbMNFGSfgVfC6EAqTCqgEVnXur5WoCa4XSFhxuUPykM6D3KOw488jRP1gb8gqs7AZJmFBeZodcmxFMWyDTlRxqICwMhS4Q2BHmtlRlZscZEZk1BgnMUDF12HSOlFi9bkcl0gV7WgJoYPAZJEUJ4upLWYVqyXMmpCMkpJE7jurW+N/otaZxI9N2DSBLSViRmqXvjuwmQjLVLd1HYhPHvUVlhYZGS6Rab765knQnNAp5l0qCZKyK775zFHUVOuUYT/IHr0s8mnEtLimZ89/aYcHQSkyWvwu4INNJAZkgcz3NcZ5f0vmiSOa9Rhh5EJxtRIhBhE8A4REHCzMa/7d8Eu8kP3Il3fDLiXgRD73gUeO89gOEw7EcT0z8+mZAP1g5qIqDRTcX4iPG6TQgOca1lIKzXKGnsx3VGdiWQon1LuTbTfALDRaIJ1law7IX2cfXtPwZPVL5pAqOctfQce/NZg8LdGHODoVhQtOx3opx8gcBQZt0Ij1DoPOE7vPSpnGRZjZIVguerbiHig5ywqxRNJ5OnPClatG/m6JXeh1gE8TcrDlw+HA5HkyFEwz4Mfxr1hxi4HpzwfuR6nkd4flAQNeF8vhzj/oxAQYYbFLOFafpjv+7YmNzv9RIZ8CSW2vgjd+T2hPja04FIe9NBj4To3tMYF4hSPmSg2lkjMaV/8CNdI+lviIcqjC2a1/b582W/slufr/h1fboBrcH++u2bcvaFkmER2OU8C1kIU0hkbnORnmkDqWY6lkUSsupg41NMSnySWFpkBoxqB9KCSLXhptBNkFd2fBe+sijBo5PE/5pD1mHnwoh7Sp8ddomJMRTls1SYFBOwM/vNIjGECAsc3sRzjqMhN3yJaHnCdhuRHyggZS2847ARGPH2CLhcVbAcLSnXtAGMpMLyFkdQOxzR+g3UA3cwOHIHR/3+tdv333u+63XdoXfkHvtYMqA5FFHtcUB7ZDnbZtZrBOvTp3vCtTmXoYjEE5xBrehHymgdS6uF302cO/K94+7o5GRN3BQt2MlbNfky2v7o3Tr9Ew8p6Q88D71065Ci5eJru7BN29XH8fnaelLwxA7d3C5lTigLu5atRhqqSazApzKZ4oFYleIbmmtKuVKcim9B2731f9IKzY2DRaovwES+/f+gfQoSv9Loa8wNucTKyO93XX8b+d3CYq8XqrT6x0O1eqhWD9XqoVo9VKuHavVQrR6q1UO1eqhW/yPVqoWP2zKWVf/DdiEw//tOb7vZ0Zs3OhELurYGNV12LAqV7I7h6hxeh7KzfWVdK3otO6Voey9MoGxOtA+Y7E4vxl179awhKJStxhAAfiqC04IMuLmrz14RJ2UWqX2zIpcgL6/g6d1+4xA5Iovk3vL88uzqmp1loWWajTMDKuIYS59kUFDmLpMAbhlr023m1OLfGXXfk+ep4myx34pGQ8tSXZuU2z1TNRFecqNe3qZvnV2ry/Xv61pVFBp4ND2sPYRN9TYS5lUstTTOOo7f7GuhvyheaMF8Ttg/q2SxoOGyf0IexuqHzjsM14gnGvYY9T/rJe0g+k+YOVs9uapwc2z76fX5+u6G0V5LWltja4vu6EUJMumF4fDmsupuvmVPNkJb8S3zczarI1ribkbz4g4XxcBD+g+AUMvvToMAclOT0OhrkY2rlPzz2TWmob8AKBmK5Q== +sidebar_class_name: "get api-method" +info_path: docs/api/iiq/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Returns a PolicyViolation resource based on id.

+ + + + + +The PolicyViolation resource with matching id is returned. + +## Request + +

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/docs/api/iiq/get-policy-violations.api.mdx b/docs/api/iiq/get-policy-violations.api.mdx new file mode 100644 index 000000000..6eeba281c --- /dev/null +++ b/docs/api/iiq/get-policy-violations.api.mdx @@ -0,0 +1,67 @@ +--- +id: get-policy-violations +sidebar_label: Returns all PolicyViolation resources. +hide_title: true +hide_table_of_contents: true +api: eJztWltv2zYU/iuEMGDd5siSo8Se3tIkGwwsbeek20OTB1qiYraSqJKUEyPIf9851MWyLStumrbA4L40EkWe73znSpMPlsiYpJqLdBxavnXL9DsR82DxDxexea2snqXprbL8D9bG0E3PCpkKJM/wGeZfzbgiLA0zwVNNJNO5TBWhcUzW5sKYErkMmLJBQEYlTZhmEsU8WByX+pwzuYCxFEbgMeIxjMOzCmYsoZb/YOlFhiNKS57ewgi7p0kW46sAwGlJAcMbmE3YZ3JtXYjgEzmtB64t63Ed/UkciztFIiGJkU4KoaBAEAgZghSiBZn8cXowPPa8HrlkgdHl0PbsgT0gByQV2mhbswpzJSMqzzIhNQttENqun4Lx14tn6bdVEVzTgJ4x5DuPtSLTBaE1+T8DPA3LT3ONhujC9laGO9OPYMAJitchiyhIhte0frsB+AyNn/CUKXI3o5oIlIZko+gaO087MGoq9TgN2X0bSGCK3Rr8NcrBoXvYQOd2YUICjQBkk6MQIqIGrUQxvR1aIPJU74jKdZqYHMfZgHWZsYBHvESV5skUmAI0FUngeSSjt2w7nqXJd7RnZmIXXa33pOeRQCQJPVAMYxo8nsRcacS3lIp2LVIDcFmxmMHCzCYmgRTBVycFDB+IQgaSCLsP4jxk4Um9Wg98hGRSzHlY+brCoK/lvVK/oMSp0DNyxyE4S5uVsle+mzJcowDXFa2bMH4clSUWEkmRrLH566VoMqFIQFNMUVNWE2n/aj1CGq/mKIQ/cBz8bxXOZNdkDnppBg4PK9Asgw/NN/2PCpd5aLAERgO7al4I1ULTeFI48ab0N7Wfb5Vdmw0r1tYAs9xRD7lu5IsNYVdd4W6EYcAbc9jklKbIpyrDMgQfA0dbLr/uzXYnPExDBUMtJFyeji/IpRklOcSDqVS1tZfrUikpOivXLFGb/vjYkPfBAsp8znTkG4TKVwFPfJpxP2FKQR5R/sB2/L9A10kpybqBFSYV7Y31N+SuWpiHmyqNQ3AVrhfjvwkPK5bXTNzQrK0WOlPv6HhEvYgNvaNR4B16jA2HoRtNtXt0PEV1l1HX4lmYLFYEw5+QhNb9DF5RpUTATSiikbtxnaNeMUtAv2pd4xlQViiPFcJaywCd0Jady3eDx0vbtAdIZTny6r1iElIs1u2AGr/sNqKYfoTGCdu+FfcIucpiusVKZ8UgSRuU1Ah2F91CxGsxJZcJqI4qz2mct0hHfZfuWcu9m/Fg9mzBgUOHw+FoOmTR0GXD30fuEBzXY8fUjRzP8xDPT5JFm3DeT8YQ9hGTLIVUBCVAb9qjW/ZM68zv92MR0HgmlPZHzsjpc/65j+Hfnw/6uIjqP43xEVCKuxSyWCtruExhH/hINUj6Bv5QurFB89I2333tFzbr7oJf1qYr0DbYXz49K2e/kyLMi70TTUMSsjmLRWZykVoorB5EzUQeh6TsVugckhKdxoYWkTLscpUw2wGs5Dpvq5bm/TZ8RacZFMX7bcbSHrngmt9i+uyRCSTGkBd/Q409YzEzI91q4TKICOo83cRzAW9Dqul6L2FveH4gGQpr4R1eaw4eb0pAVYLJHQVNijltAKFLSChuwEA6O8D5K6gHzmBw4AwOXPfKcf1Dz3c82xl6B86RD30gqIMe1e4HGCPVaJtaL+GsT1f3mCp9IULTfXVy1ujfkDKcR5Jy4lcT54x878geHR8viZuDBlt5Kwe/jLZ/+9eWe+wBJe7A88BKxc8Y1eQrM7FNmmkda+1RwBMRuhouRU7Y2piahrkYhH55LuI5FMRyf7Ui+UWb1FKiryA3mB+cfBc61XXkN4/Fv97KbgQX+O37bUm6m37LPXKc/a7kpXclT0TB0joGsW7+dNkFe7+p2W9q9pua/aZmv6nZb2r2m5r9pma/qdlvan7UpsZoAJE5E+XpvTlMhxLgW/2Wg3zwvnl1yJ7LeLvLlmV36bnW+ulUo8c1ZBRLkynF4ypouTAFmj8gt528G9vmlEmxIJem+QIA8CkPTnIE++GmOWr2EkXSaHxTc4mQq9M2fDbfWEgETyPR2Y1Pzi+vyHl1PWEMGx0ZUXCdMxHkmKiLmMfdAOp0nVoNd7dG9iEaGhvMFv3N0qBo0ZkrnVATIuV54c6HZ2sVqj5Le+7NipIzze51H3oLblK5Mf1D6Sjt1zrQF3Ds4QEt+l7Gj4/4ujgGRetBI4OlC9wuorFiHci/x62KLYp+YgB2eXWkbIosc6z7xQp86W2KTkz1dY9nYtr9wsSTMKqbHV+PZLdrEt2Amtc4nolo9xsSnVCqaxvP9Zr/102ITqpWbpR8Y76++rpDpyatFzuWGt3gg+SokqlakCgZxfDBlFiscBIELGv6zcYlCFylrtl/nl9B7foP3Mig4w== +sidebar_class_name: "get api-method" +info_path: docs/api/iiq/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Returns all PolicyViolation resources.

+ + + + + +This endpoint returns all PolicyViolation resources. + +## Request + +

Query Parameters

+ +Returns all PolicyViolation resources. + +
Schema
    Resources undefined[]
  • Array [
    • 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. + +
  • Array [
    • 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/docs/api/iiq/get-resource-type-by-id.api.mdx b/docs/api/iiq/get-resource-type-by-id.api.mdx new file mode 100644 index 000000000..58d0eb444 --- /dev/null +++ b/docs/api/iiq/get-resource-type-by-id.api.mdx @@ -0,0 +1,43 @@ +--- +id: get-resource-type-by-id +sidebar_label: Returns a ResourceType resource based on ID. +hide_title: true +hide_table_of_contents: true +api: eJzdVk1v2zgQ/SsEL+4ChuWml0A3dxO0BrZF6zinNAdGGkdsJVEhR94ahv/7zpCWra8k2x6bQyxRw+GbN29muJemAqtQm3KZylg+Aq7AmdomsN5V8H5Hq1OJ6tHJ+E62Pzl5P5UpuMTqirfT5nUGom0i/tWYCaTVQmGS6fJRLK+EdsIC1raEdCZ4S1hjs9vVZ2E2/vHm7+UnsgvOgl1iisKUYqMhT53YGCtAJVn3RCjR7oSyICZQppXRJU6mYqJT/l+qAvi3hZpfXZJBoSZClWnzcv0ToXT03U1mFH+lLG1FsMzCXrIfCte2DvY0aSahUpjRc/Aj471E+kzrDi0RIA990ih6CrkTxCls8mPhqdYWKDdoazjc84qrCBglgJxfzOf803W58vQ6oYSjI3MY9y4elINUEKPok8CnJaakwJFdqqrKdeKVEX137Hc/DMo8fIcEmSHLOkIdUOl0CCrEiT2J8KFdgqYSfqqiynnp1oFlxgLhfY+fafX3fTbyGPrty3jixMf1+otQaUrcOfWQs87CbmIzJ462INB4IO+JVNLxPy+DiBZndt1AE31AV+e334tXLJLE1CXO+KhzEodhV1YXyu4iloYIhhTM8tdPJf3FGnAT+9JxsUt0EQeH9KJ07tmL387mcZOQfuUNES5Erh0yGMLkxkBRqo6o4eSnBVRZq3ZcqAiF938CfHcW98vYT35jqhOwRJiD+KIJY1Cv0//rd4STYfEfiCbqQyPJ+0SrqUL1SqaeqdfcBCmOi6L5+usqyBCrOIrYQZ4Zh/Hl/HIeaf0UcezR9iLqTJSokUK7s45j6owHga8iaZ8jD4eT3EZUxu6PIuIZ04+4052f09Wg55+F9rIMEmODnDqAKfH+z2c/M8dB7QcTDRtqJ10a993JdOBxBHbbjK/a5s/nJiVZa9ydUyQHA+tosvwashBc+2nCcPwY9Q/UERdfltRz7vn8pLa0yQMgU50saoZ+d9/+esMsBEm2bE50MuRmtPK7t5FMiy43ZmTknJGurm/W4rpp2ksu3Y0i5VyZpC7IKgic880xfSvpGOYr+LmcveNca/RS6sfvXVOgnOaKiCyUr6PjJeE8i18ZwmEA9+bAaR7/uXerY26RGmtU5YruUMSjl+j+KO/+vXMq497ViyTEEmbT/Z4ZvbX54cDLTzVYFh09bpXVPLu9BFPt5zhV0kblDl4g/s3q2IT/Eq9c1UYjaTpEyf1hq/Ka3+jxB+yGV0jq8BQJqJTaIKMMRjS8ocLW9sHVjGvo1Bk+XK+pJv4DZHoeeA== +sidebar_class_name: "get api-method" +info_path: docs/api/iiq/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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'. + +## Request + +

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/docs/api/iiq/get-resource-types.api.mdx b/docs/api/iiq/get-resource-types.api.mdx new file mode 100644 index 000000000..7777805d1 --- /dev/null +++ b/docs/api/iiq/get-resource-types.api.mdx @@ -0,0 +1,47 @@ +--- +id: get-resource-types +sidebar_label: Returns all ResourceType resources. +hide_title: true +hide_table_of_contents: true +api: eJztWM9v2zoM/lcEXXJYEGd9l8K3bC32AmzDXpqeuhwUm0m0J1uuJAcLAv/vIyU7sVOnXYdeBiSH2PpFfiQ/kpD3XBdghJM6n6Y85mtwM7C6NAnMdwVYPuROrC2PH3h3fjHkKdjEyILO4smJUqy9hZl6YJkwwJS0DlImc+Y2fq3QuYURm+Mo0Vmmc7aSoFLLVtowEMmmKw1yZ3Ze0gDytNAyd4MhG8iU/nORAT1biGhokw1kYsBEnjaD258OcovrdjBC2xocaOCeX43H9OiaNQNXmhxtOGseyUl0jnIdHRdFoWTiPRr9sCRjz4NueisM+dvJoNFpJxRKLZWzT1V/LbMlGKZX5/xqPDZICYHDJTyDboE1GJyAnyIrFM69v66GNYIeJeT/TmSZC0oK1IMmYcyWO3Y/+8pKi+8UHLeR9hjBo25hjNjhUDrIgnlh3joj8zWvWpgeOAKPJbhVXAgjMhvbRGaxKGScgbViDTa+Go3jz8iaWa2JL1BCA7Ut/5xevfwBicOFrtNl+tQL0xtyszvxRcu22oaWCfzeop8REpGvJ3g4++cyG4q/HK+BZf/O59+YSFNDnlsqypVwGoOkkIhbYE57IB+EBYzl5+dBRJMjhS2h6SA4BXRzHP2ZvWySJLrM3YgfeNpvdmFkJswuWpIVYSMaM3291l7u1RkSWyGV9178HgnYBOS0ejxFOPEljsAgJtsHCkNVo4aDnOfS55gtxwryPPaD3Jgy16DDLPg88mZQuXsspQFMAGdKqIa/K7fHJ0+ELSp0UwauJ3hfcDYVTrwQqTP5qnSgYj8pmtXXs2DjXBFHEQlQG21dfD2+HkdSPkZke7S9ijp1MWqoYFqz/ZjuPk6/HMq0r6fPI2nr4VX1UrmuSRRKMfQ3hzctyw0NEm0CnTqAMfD+N+y0Pjr47q36312w+O07Xy340vIuLe/S8i4t79LyLi3vNS2vqgmw0fXdmSIp3IYqyuk1Gl25BWM9tUujzkcjRSJLtzsGhZ9etaf1lul/we9BNKMiQdr9fde/YA2cfJtilVmQ/qQ0eMgDwK0ymZSE9GHRXvUNMZCwtefgQILM61jR2O/h5AWZr3RPkzkind3ezdltU6anlKwrgVy50UmZ4a5AaYow2fQ9RzXkryDnevQPRVc6T55T+71oNJQCW6AjM+EzJ3Sp37zBnxT8w4X+7/yuUYfLYXWMCiVkTq7xrNvXBO35nkMcpIX9nph0b1RV0fRjCYZYg69bYSS1W88aPAAixQJBhPofduSrJIGCkmArVOkT8fRjCHHtkDCfbufInV8qpH8L +sidebar_class_name: "get api-method" +info_path: docs/api/iiq/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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'. + +## Request + +
+ +Returns all ResourceType resources. + +
Schema
    Resources object[]
  • Array [
    • meta object
    + +Metadata of the ResourceType. + +
  • ]
Schema
    Resources object[]
  • Array [
    • meta object
    + +Metadata of the ResourceType. + +
  • ]
\ No newline at end of file diff --git a/docs/api/iiq/get-role.api.mdx b/docs/api/iiq/get-role.api.mdx new file mode 100644 index 000000000..66c70fef3 --- /dev/null +++ b/docs/api/iiq/get-role.api.mdx @@ -0,0 +1,67 @@ +--- +id: get-role +sidebar_label: Returns a Role resource based on ID or name. +hide_title: true +hide_table_of_contents: true +api: eJztWm1zGjkS/iuqqavLLoXNYGNDqMtdscHZ4uq857Wdug8b15WYEaDdQTORNHY4iv9+3ZLmhWEGzMbxp3yIAyNNvz7danWz9uKESap5LCahN/TmTN/GEfPanqZz5Q1/8/Cr8h7aXshUIHmCW2Hj/YIRXCKSqTiVASNPXC/IkupgwcWcTMYklkTQJSNcwSadSsHCUzLSWvJpqpkiOiZcBFEawhZB9MLQSmKhGAmoIFNGVMICPuMstMRxyxuaE3hDPqdMrkhCJbDRTFapsy+W+kzGy2fTdy+Fo318UPsglkAhWLAlRRVBvyFnejY029RQBXw5tMvwhfIoibnQw+6pP0S7nYKJc4Jo6LWHxgLLSlgFX7Q9jnZOqF7AZ0vIG649vUpwlwLpxNzbVP1Ssns82/YQspTsc8olA1drmbJNe225GAVh2YkQxfEfafLT6hf8WsN8GgNdKna5j4hbIo80ShlYlGoSoopLLsApfGaMXAVOFKE3kCu4Ik3IdOWQI5RmNERNJiH5wdIErKBRCneQN9Zkb348JXdMa4SfXoBLKm5DSKDWlmFAU8WMNJZskkYRcM+xkhGtMgMiIKuWjGrYThWhVtanBRNEMSot/mfgBQc5a/y/TWXn7+ZPq3X1hS6TiLVaQ4Iw6TyedUyYdVqtMdWUjASNVkq3Wv9otcq+eIfit1pek9+K2DgGMnko0+fEpgV/1bTONWiNIF4u6YliuIgmirjS6EGIsyhUzn5ZQtiJfLQbo8HCSNRktELQd6h5GxUsthoBS7qgACbELcyQXSyiFfxhqlGQdpESICMwYyvUgodtF/SqTagICehPYfOCg8wUMgKNnuiqRBcVolabRr/t5pwX8F85+7Fv4MJM6Jr0+iwn7ir9LsE8oVXbZaklE1r9Sb9uScdewbUPmFwtA4VOO/N9/G/bVbfmVTSxAldG1Uw4pQrIxhaJkzEm7CAWGsyApGiSRDwwZ3Xnd4X01iWQJBJPcs0tdx7uMp9MfjXHcpGDkcE2uNqAReMheBT4097F5YD2ZqzfuxgEvfMeY/1+2J1NdfficopItACucvooOKDL5sUsERp+4EIAmHl+/fHuHt2W2r00kLFS1ilCczxamc6OMLVf0NF4DC8E+uRGxmEaGH9eU0HnTFaiRe3KOsrRHcUBjfj/wAPlNxrsRaWkq7IUcIAbAiaexX8/3sGiCSn4bsVTJCnky8suZaAGKwFTAB0HqiSiQrdJyB+5gk1tPNQhKhMqVqfkBhbta0sKNQX82yKNmAhTtJqzAhClAY84gsO8huGVYHRZAkxQERgMbzL9qlbC0MOVBmvE099BwbI5AIL8szec0QgCzisHdP7QRXv+PeQK1LZFB6D1HsgtqUhpNFKKz8XShIHb6xInR5401XHNFpo/umMRSBdLt7TZ5LzoNGK/1EJ4XGzIq6nnhc0dVM5YAdwzgNWVgM8MsusJAYWAMQUfPdbw+xDRuT11Q4xxZisYkx7gf/DQFKsTxIYhUBIhK8ZKMtjazvIyIIOqosGpoeXlMpHJpZiibFLnwnLrgLmsACChe+REqrMFQBjuAfAEiZ9oborIwkBn/tnZiX920u3e+92hPxj2Lk4Hl5cn/sUQcqYJ2K+WfFtIa9iKLt9C8vhJQM6pFdcsHQqf7SS+FRANAN0Bp2W0H6L/iiUnH5icp3iMbPJEtXNijI+lTIPuud/tn/dnb/3u27fdQRc/hW/Z1L/wz/tnyOwvks1qzozbCRyEMyYZ5KJdtlu3mGb+C62TYadjMvEiVno48Ad+h4d4pugV/9zJ6u2PCq5dncPiYrLgYsEk15gkd+W+gcoAEqk5pmzQShO09h1l4Fhzbnylp5OC636DfOAmuZO/klEQxKnQroQ86PFnc2iy4cy/6Pm9bnCky0t8X9rn9o51WF70+faJtVPHVbztditX4GCNg5kkgmo0VVl7YZoqvATbV0wVXSg/uXdPzYUSykxTkNqzAA8TW4QWu2TO0yQ3lSZJLDW8usXk5XGXMz2MiwJv5GcGEUwjhCCKlp2FBzF4BLfGSA67Xf980D8ShVucXxeHhcSIw7xIOgRBt/E1EQjU46dXBqBVUx+DQEVuXCF3LP6OYbbHnX1w5+DYNLjF+tUR6ERGBAYRVtIzd/OsQeL77Q1WA1e8HrgxsdmMuYLYVe1WTbTKxKvy3gGMd4cNXBqdwVYoaeamt/LP8U/v7YVrzJYx9tOKRku+f4OtmBfi3j+SO0b2QzUQMs51paPrDjhk/NsUi9tG34UFOK6kXu1toxTc2uUMKkj+FmlkUWr/1phoDzZyaFgdDlfA9e0FtEk5JzzDFnvzjLlNFBuOIJu5vbbgN2tHEHvezbtCyKZ7N88wmR6y8VzGaUKqcclFx3VZQj4z6UY7IWv6K5uNCX5sge3KdA1PQ2xUO5nu3k+ut1LUthcD2yyvSfDwGC9ZpcvuExw/bv9XX9DOe0O/d+r3e8UFDVNjPVLRztlqo15Hp96dnPucphr4TV/HoZlM7TUaK2yG75Cle+lbXG0f4b7UaDi3+Cfs9p/Op0+fvO5lD6zSPev1wFv4wDMluCVw3xgXW3xMlOxnZkabBteuz9uQb+0iBMxjHD0Ws4EmtbKTjWu2VLUN++LM846cE3oPm00Ri4vYDWnN9FAv4IvD1dqOqzY4OGDyMZsppjI6oi7wdqaJbsvkV6u8JW361GYsZlqX+AGSzuhmYtvgigUpXH1XRgDYyoNRiqL+9lBevUOVbX4o7clthyJnQxBz5uAez97GZ3FN0VZIent1d0+uRGgMSSZCMzmjgI9xHKR4n7Mhjn1W1OkTds5ycHuD03N0LNcGMFX9DWlQFH2agCGXVBTHVKm739DWL4azp1VTr4tO//fZ+gvM1h2MNPuiO3Cwc1OtmGhYu8jJftrQ9oZu5A7oxOjApfUanfZRRpsNPrbzOsRz1j0sutZNXvw+C3+VWXiDq/9g4K/qDxmyeYwZxD7fk98H5K81IN/rzK1fN7ysK7/Pyl9zVr7Xy7W/hSi8/YBfJEd3H5mPf7h1Pb0fyYEfSdVKl9V6YlWWJ5PanSBmgrqANI1TIJDOLmLbKdGl13Ym+ahWXt79fHUPhc7/AZTdpPI= +sidebar_class_name: "get api-method" +info_path: docs/api/iiq/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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/docs/api/iiq/get-roles.api.mdx b/docs/api/iiq/get-roles.api.mdx new file mode 100644 index 000000000..fdd76e465 --- /dev/null +++ b/docs/api/iiq/get-roles.api.mdx @@ -0,0 +1,99 @@ +--- +id: get-roles +sidebar_label: Returns all Role resources. +hide_title: true +hide_table_of_contents: true +api: eJztW21v2zgS/iuEcLgCPceWHCd2jesB2aZdeLHtdhMX96EJDrREx9yTJUWkkvoC//ebIak368VxmnTvAH3YthbJmWde+HBILh+sMGIxlTwMZp41tW6YvAh9JqyeJemNsKZfLf37umd5TLgxj7Av9JyvuCAs8KKQB5LETCZxIAj1fYID4IMIk9hlok/OpIz5IpFMEBkSHrh+4jH4m8iV6heFgWDEpQFZMCIi5vIlZx6553KluryimYBX5DZh8YZENKZrJlm8K51909KXcbh+tHwzyDtr0zOHnm4YgwR3xdaUgPVg8ZQzuZyqbmIqXL6e6mb4QbmvfDN1+vYUfdIHp2YC0bUPFkdPKlXQFkAL/FxyH9rht5ZkTR8suYmwRQC84Mba7obizPfDe0GWYWxgaxEQDRcQezAGXXPx4d3R+HQ06pFL5uJIctwf9Yf9ITkiQShV6LJkgLFoahJFYSyZ1//7Ih78Q/3x+vX7b3Qd+ez166lR9BaRE3ZLrqxzKik5C6i/EfLKAqj1NgqQ+tPmCTbiQGWPDm3iS0EWG0KzfHsFyLMwNsHW6t9eKTh7YP4We4dF4xzDu+YBJOT9ikoSogAMAErLQPOgDZxSCvhQMswx0NOGUtJYzgKPfauDCRnIbsCCNpzoTSUFXctREgmXBR8TwWQj3Ez7W8ex7UaUbpgE8iCAl2aqanxBsl6AHwFX6kLIVZigN6wJmdL41mmGlCfKIfFFIlAURx/Da5o4dtiE3FE/YUghFFCu1/RIMGyEmUZ8LiRaCYb7npK8YIZeoXWXNXHOM+quFKImR+RA1UztoYE916dCgHtdPd/zoQpwwTYEpOgS+AGgoPow8DfwBzQ2Aevl9ArsypTv0Cru9QyBih6hgUfAHxQ6rzjYgJRD/Xu6KchFA6m2rjGOVf5+hngWVxL2AiFNQdcsVY8KatXotxHOZyl6MbtNeMzWLIAfPFixmEsauOyJMS4hZT8gzFBrpAoEBnAItAJ/lcN2Uag4Lt/NPu6WHZACbgjUAqQDY2kU+SbVB38IFPBQyJAoxoVPcq1OhpL6F5pkqno/ZTxUVpjZgqVTmdl6kKEqbvDNmfQwBQucXdEwb2NjpQz5WMWsT97VljW5+Eoh0wrP2aYTp8Zy5eVLXf0kwgQtmxS5XBrHFGcnl2wtaidgpu+rVVtD0YhP10wIIHcxHUL59CvYemE0Wdcg4SJ1e0F+RW85rNyrmjSb/U5m56l70yKtjLcYPddejE5OJ3S0ZOPRycQdHY8YG489Z7mQzsnpAo3TpLSr6UvAIRJEVUrot0wfUYW0+v7xy+Ucg5novtSNQ6EXP8hiHuuwm8QT7UDPzs9hgCuPPsehl+hy7yMNaHWhrQn0WcZYfuhSn/8HYl0c0eCv1P95dB8sJUBxdPCvL5fQqGgSqw8FDxbxHF+x+ATKgBaIL1CAIYfIp4HsEY/fcQGdelBYIdNGNNj0yWdo1MPWFPIa/iuJxpz2EvSa8QIIpS73OSaHGoaUGSFjagEsQMJELtqm9tVNU2xp8Ea4+AMMLLoDUpDfWtMl9YE4rSJJZx8Ng2e/PS7A7M0nvc7N5iBuTYOE+mewdt8Ea8Vupq9ZDDnqpIkMa7rQ7NMl8wFdGJum7TbTRRc++1Sbwud5B52vj542l7CXRDKbM0ir9wH8mwGFHhEwCBRTiNFdjb4PPr3RlZWH1I0rD8wUxbpq64lAPMwCLaAAYRFCJxoUMcg4YakulWSwU2kIqqd1mapArYnI7Hqh5oHWNgB3aQCA0HwykOp8ASm8phAIC4UfSQ7+LTpoaA+HR/bwyHHmtjO1J9PRSX9yenpkn0xVSQ0ovxt5GaR27I4tL4E8vA+Ac2rhqqZ906dM4qUJ0ZCgleTUitpT9Ncw5uQDi28SrA62GVFVVozzQyVT1zm2nfHxePnGdt68cSYO/st7wxb2iX08HqKyv8RsWbNmXMxgfV2ymAEXVdVm5UC7/pWU0XQwUEy8CoWcTuyJPeAerilyw28HuOQO7oaDL4LFYrAfLpJFoaqs4v4MFR4QqVqm9KSN1aTVY4RKx5p14zsjHeVa2x3ygStyJ38lZ67aI5qqZG/EH62hyYdL+2Rkjxz3wJAX9D53zFWMGmOe48WYl1esSj2+E23TW5gCB2scZBIfdhWqeFR16iIReAChh6idUW78bG6+UtxTwXZBbSz0WoCLid5M5L3iTKciN3N2BUNLSp4/7zKl+/MizzfyM4MZTH1MQYSWroV7c/AAbY0z2XMc+3gyPjALS5p/bB7miDEPsyJpXwqajj8yAykeU/7gBNRmykMyUJDPppA7NP8OUdYSzjGEc3IoDZZU//AMNJAxA3fOzqr435U7aAtM8bpnx8SWS2YKYlO1azPRKzNrV3clYfSpKfWH0BVKmht1XvbL+U/v9IbrnK1DPKPPD8+y/ls8Xnsm7eMDtePMvt6dCKnm2vMRfQ5iMuM3VSyWnV5NCzx4yM2r3W0UJrc0nEEDko0ijSrSHUclOfblRpYa2ob9FXD98QL6pMgJj/BFK8+o3UTe4QCxadhrC37VdoCwx+28dwRpujf3fYrpgY1v4jCJyO685MHAnLJ4fKnoRhqQNecr262a/HiUWcX0Eb56ePllMKnDsiJFlaPoxgyPhmsIHj7jJquw2b2H5cf0/+4N2vFoao/69niUb9CQGuszFf2ctjbadTD1Vjj3MYdqEDf5MfTUEWer01juMxxD1mbQS2xt72C/1Og40/gEv/1zcHV1ZTmnI/CKMxyNIFr4wVIluBYwb5wXJT1qlrQrQ2/pRa3x3FfxrW6ECXMX+nf5fU+TWd9/Btx8j25db7dmLhaP9XHU3174bL/99NxyTmy7O95/7uP9PUm+c4ski/9fShvs7nagux3obge624HudqC7HehuB7rbge52oLsd6G4HutuB7nagux3obge624HudqC7HehuB7rbge524P/zdiCdjqvQPGzEaUblCn4M0jeOsKe9S9/iJbF/QEVg7T4jmZkus9+12Vo0WVB8BwKlpDq0xH8A3Zx9nulnDoK5CWx6NwoAdOXuWYIIv14XW9WhvGaGQp/MawjZMhFSqw32sfQ+fBnWlGs50ov3l3PyPn3EOQski5cUMuM8dBPcyenJjSesaNMVnpllaW1N+scYUi5Vquzar0SDoRjNCBy5pkG+QJVeb1QfbpTwPuTvOLpHp096dGryRLJvcgBrNleFiEr3BzMjCq98Menxw8MDpu6X2N9u8bN+coVpmh4H5sfQTdH6332X2uCTfzMwMX+Am95GqIdnB5v9Mk9VW5Fnz2qfiPzFnq7uRZ2+sv1+4M/5lrUddvHZ7RNxP9sT11ak6dPbJ4LsHrz+WQ9eW6Naer38vKHt3r7+WW9fWyNe+845j/w1/og5hl5VkLCWM4q0iqu2loDneVGRCirvYlFKVjT//H4OdeR/Ae7HXV8= +sidebar_class_name: "get api-method" +info_path: docs/api/iiq/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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[]
  • Array [
    • 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. + +
  • Array [
    • 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/docs/api/iiq/get-schema-by-id.api.mdx b/docs/api/iiq/get-schema-by-id.api.mdx new file mode 100644 index 000000000..17bfdbe49 --- /dev/null +++ b/docs/api/iiq/get-schema-by-id.api.mdx @@ -0,0 +1,47 @@ +--- +id: get-schema-by-id +sidebar_label: Returns a Schema based on id. +hide_title: true +hide_table_of_contents: true +api: eJzVWElz2zYU/isYXtjOKJK8jB2zJzf2dDTTbI7THBIfQPJRREoBDABa1mj03/sewE0Spdi51ReDWN76vU3rQJWguRVKztIgCuZgPyU5LPifK/weBZbPTRB9DfymCR5GQQom0aKkJ/jgPgfmD9lS2JxZ/F5wm+RCzplImTBMg620hHTM6LLfo2uf794xlbnlpzezt3jPqEon4O+F3Fot4sqCCVkmoEhZrorUPzWO4ytTQiIykbDuLlvmIslZKrIMNEuhBJmSKEo2YtpVCWNUreSaL8CCJgXXgcQP1MdTdroL0q/kNse13w6idUDP6R4ylPNgM2QPVLHRyz0jbhp+VEID2tjqCjYPtGNKJQ0Yono6ndK/bVp3znCGcWaQV9EaOuYGUtLIOmZEPlHSgrREg5dlIRLn0sl3Q4TW++Kr+DsklqygCQBWeDFEui/FoEY7rnT+6/uz1XvbXKMAnviiLGgLVYsE2CxyjjCRScQi8oLiBxdFqYS00cl4Gn02oMnU3ke7Ar7D3ZcwbqhtUdkletN9vYR27aFMafSatwpyGxO7DqP73K47/FbkW6uYvxADskYj7/HmWvMVgdTCwhHcdmQlxY8KJJgBZjcE+oWQLlgANdOkngaWcMmQoXJbtSZNUJouvA3Z+5EXFTg9nXytcmMWSiUhZAvg0tSE8YJUDDGagJbuUSffiIVooUfQvSe9Y2/8PgdmclVhNkBJ5xVCB4GPFmslIfvQo0bwEeMyZeG8UDEvDvAYpMgTrfCMF0VnhOPOJ8WfB9POXEcJpsKUBV/Ry18B7DO53HguTPYEbFG7qCyPRSHsap/lDFMrJhrw9qyvEXaTnMs57CHjA9pTxEUNHjxCaIQaePpeFqtw5NdfNEI6rL22pA93elyFhghJ7G/tmydDxKNXDeJN0LOQIWTCRNH6CRkuHVT9GROtah3uaqmNVdoT8oIggjFPwRwLyYiBTcZe9ppwj5LPua989vbEjmvV1ZhFVVjxDz0ZSNA3daboh/NWwAiHYrVEto5Q2bqgxz9WqsDY6AuQ8cIAck9Q4tsnntiB4oDFjIls10rEkl69MiCNsOIR/mCOmk8uS2Hgeayb3mFAa5FYbrdz2GCSaEigJ5qc3JReFqt0NWZvfN4LebHkK0NATCHjaCmPScwShpYEFwmUqX4Stf5xsOlX/UOG23dV86ZLaT4V/6IFMakriQgsHHwGysHfwlgK+/ZiA3Sbc4swrs3Y1CVTYX8BC2w2BvPLXl3a65daCb8GubUlhoNI8AGtUzFHU+OH4hW2XQ9421Tx9ZHCSUHfWQzt2QY0mbLuD2tbhiRKOGazIaur/lO6SFHMnDZ05mPXNCWyzgGIqHBLwNBXyV47qqGAR6woZDpCKEEPKWFEPKOm8zQVpCgvPmxVdy5X7zPXtW63c5uHjfvDhAGW71vrLe6m3PKDHc2BtrBQvp8cbg6b05f0SeTtaDKhp0WujI1eT19PJ0L8mFAbOHk8ndQTx+Qym56cnp2fXMLV+Uk8xb/L7CqNzy6np1fTiyQmSGFMmoPi1Ycvke7Lt+Dk4vzy4uTy/Pzs4uzqW+CD2XcB94MF5n53jGkHjZ91i4HzWN35DhM2XVvZ6dANTL8Yfkc78AQRHp1i810LWUPLYytX9bDo5igM1ShoHbZuRqgNzU2utfMTVqWLw55PMaFg99ABINidrGb1ldlHb2dP2g1DJIIrum6BkXb9YYbdywPxTyrtmhcUwKWaa8os0deH/qkT3UO9d6c1HonczIAu27qURaYQMlMDfVEn6d3tp3t2K1M3y7AZ9gk644iNG5VUlEN94JBfSadvlMFbMAevx2fkWWEdWHb1d6RRUXJqiYZccBcA9RzbzY67Q6MfGHd6yXZ+/B8P9LW3LDzZCTa0OL6jZRzo1jVIu98xRkHUTvoIBAIiHa/XZKbPuthsaBsrvybo4PKRa8FjFzdr6stpndZV9og1f7ura9Pvja0OpaFtsZtwlhTMrh7jFy7/hVX/R4oNlcgcm1+caEkwf3ydJFDa3sO9nwQI/G0Y/3V7j2D+D2aaQ58= +sidebar_class_name: "get api-method" +info_path: docs/api/iiq/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

+ +Returns a single Schema based on the id. + +
Schema
    attributes undefined[]
    + +Attributes used to describe this Schema. + +
  • Array [
  • ]
    • meta object
    + +Metadata of the Schema. + +
\ No newline at end of file diff --git a/docs/api/iiq/get-schemas.api.mdx b/docs/api/iiq/get-schemas.api.mdx new file mode 100644 index 000000000..fd502c685 --- /dev/null +++ b/docs/api/iiq/get-schemas.api.mdx @@ -0,0 +1,55 @@ +--- +id: get-schemas +sidebar_label: Returns all Schema resources. +hide_title: true +hide_table_of_contents: true +api: eJztWUlv2zgU/iuELjpM6iUJsmhOQRMMDEyXSdPpoc2Bkp4sdmRSJakkRpD/3vdIypJtOW2KAWYOziU0l7d+b4MeI1WD5lYoOcujJJqD/ZCVsOAmOogsn5so+Ry1O7cHUQ4m06Km+3j7oqqYP2QajGp0BoZxDawSxkLOhGS2BDqrlTQwYjf4K+bWapE2FkzMCgFVzkpV5cZdNY7aK1NDJgqRse4uuy9FVrJcFAVolkMNMhdyzpRsRbDLGkYodssOZX+MDicT+rcu9zXYRksUdUB+opApaUFaesjruhKZM9D4q6HXj5EXkla1JvNZ4XlZZXl1DaaprNlm+rZZpCi5KgJLgzxJDMiJJQmPlwQynoPGDXjgi7rCvenZ00FgOUCVLNrTnzUG7V4ojdYUprN8x4FrzZf4U1hYeKn9vkFDy3n01OP8OULxEgG2SGqu+cIkJhOLhNciWYAxfA4mORxNkj/R29eBU3SLFK5bY/bo7+Kr0q+QWTxYt6XIh3UVOVnQrrT2mMJd4QH04fXsDft4/XbjVqd/0LOn5rCWweKJ4aKqFfolmaKqHw06BzWUfAEDLsbdlzBuqa1R2SR62f16Ce0ACoICD1ZBbiNi1wXVNreLLuAclKxi/kIKHlJbvLccu+7IRopvDUjEy5BqFvRCSBfdgJoRbAHzR8YlQ4bKbW1lmHthS58tyN53vGqgg/xKuRGLpZIQswVwaQJhvCAVw/jOQEv3qJPvgMVooTvQvSe9Y2/8PgdmStVg+kJJ5w1CB2O3H3wuHvFRK/gB4zJn8bxSKa928BikyDOtjM9Wa2lqt/NJ8Z+DaWeuZwnmwtQVX9LLXwHsT3K59FyY7Am4Qu2isTwVlbDLbZYzrAWYpMHbM1wj7GYll3PYQsZ7tKdIqwAeX7NiDTx/J6tlfODXnzRCOg5eu6cf7vR5FVoiJLG/tW2eAhGPXjWIN0HPYoaQiTNF6wdkeO+g6s+whraqdbgLUhurtCfkBUEEh/qBK7DZyMseCPco+Zz7KuUU4Z7Y81p1xWGBxU38TU8GEvRlyBT9cF4LGOFQrO6RrSNUr1zQ458qVWFs9AUoeGUAuWco8dUDz+xAcdCYBUSxaSViSa9eGZBGWHEHvzNHzSeXe7FWHJ9h3RbrAa1FZrldz2GDSaIlQX1RyMltgWapypcj9trnvZhX93xpCIg5FBwt5TGJWcLQkuAigTLVD6LWP46c+N8aoYfEbw237ar2TZfSfCr+RQtiUlcSEVg5+AyUA+ojKOxXF1ug25JbhHEwY1uXTIO9GSywURvMLy9qdEprawwHkeEDWucCmxvqShRvbOmaGtOkF88UTgr6zmJoz1VAkylDQxtsGZMo8YjNhqyu+k/pIkUxc9rQmY9d05bIkAMQUfGagLGvkr3+WUMFd1hRyHRtV46UMCJ+oqbzPBekKK/er1V3LpfvCjTgZjv3dPvk/jBhgOXb1nqDuzm3fGdHs6MtrJTvxYebw/b0JX0SeTsZj+lpVSpjk7PJ2WQsxLcxtYHju8NxaNfHp8Vkenh0PD2F8+NpOsG/0+I8T49OJ4fnk5MsJUhhTJqd4oXDl0j36Us0PTk+PZmeHh8fnRydf4l8MPsu4GawwNy0bXB7bTUZ/ahbjJzHnp01TNdWdjqsOP2rc0bbgWeIcDdnBCEDtKiR7Q1n9OS3/YS2n9D2E9p+QttPaPsJbT+h7Se0/YS2n9D2E9p+QttPaP/JhNbCq1Th2yKhhWO0JlHrM9zxLZ1xGG10tdvjOSYS7Bo6x0ebHyRn4crsL29fT5pRGSW+rti6BUbYxfsZdi23xD9rtGtaUACXYi4ooySfb/unTl4P8d6dldFI5Ch4xmVZl6pIfyELNdAPdZJeX324YVcydzMMm2F/oAuOmLhUWUO50wcM+ZN0+kKZewXi6Gx0RB4V1oFkU39HGhUlZ9ZoyAV3wPdN5w8/g270kKuvov/T777BExYe7BibVCFJaweox4C6tU/ZBCzaenwkeHzU1dMTbWMF1wQFXN5xLXjq8E/lpcTGEadBQsk/sCQzZBnUhGlXBCmiNj8WE4BW+P/j6gYB8R368f1+ +sidebar_class_name: "get api-method" +info_path: docs/api/iiq/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +
+ +Returns all Schema resources. + +
Schema
    Resources object[]
  • Array [
    • attributes undefined[]
    + +Attributes used to describe this Schema. + +
  • Array [
  • ]
    • meta object
    + +Metadata of the Schema. + +
  • ]
Schema
    Resources object[]
  • Array [
    • attributes undefined[]
    + +Attributes used to describe this Schema. + +
  • Array [
  • ]
    • meta object
    + +Metadata of the Schema. + +
  • ]
\ No newline at end of file diff --git a/docs/api/iiq/get-task-result-by-id.api.mdx b/docs/api/iiq/get-task-result-by-id.api.mdx new file mode 100644 index 000000000..f7c9cd3e7 --- /dev/null +++ b/docs/api/iiq/get-task-result-by-id.api.mdx @@ -0,0 +1,48 @@ +--- +id: get-task-result-by-id +sidebar_label: Returns a TaskResult resource based on id. +hide_title: true +hide_table_of_contents: true +api: eJztWN9z2jgQ/lc0fmozxBgIKfXc3AyXpneZa3u5hE4fEh6ELUCNLbmSnIRh+N9vV7axDQ6FJA83N5eHALa032r32x/apSMTpqjhUlyEju/MmBlRfXfFdBqZ3xbwrOUYOtOOf+OUL7Qzbjkh04HiCW6FjaM5I+UCopiWqQoYeeBmTmJqgjkXM8JDwjW8NKkSLHR/mSjS/jX7fyuGxig+SQ3TxEjCRRClIYNPYkA2CEyk0IwEVJAJIzphAZ9yFmYIuISW+3+kTC1IQhWNmWHKJbuQ2GOGNFUy3hcr3xMO98ZEA+lgzmIK8iNqQBpgV0zGtX8rjsnREdjG58xMfStL+zrgsZ9thR+UR4nkwvgd1/PL7UdHtwJ8tYZHjy0dAT/AOWa9zDqUo8MSaubwPZPr+EvHLBJcq+FAYgZv2CONkwgfBR4deJ33wcDrhh3Wp4MOfGOT7qT/jnldb+qsNtkAfpbTJj64IFixHylXDOhmVMpWrWWmkLUfvM51Lr25p5Zzqc22JkMSyDimx5qhadDqEdcGtaM1EmSc3GSbS0ZzvuVaolMIGs0AqYEILaIlSZS85yFSHsVp2FfivdFvEXEigUsPPIoQzRJA1GmM6yYMZawDxnnKWttq7Gk13N8iMdOazmDTs+33ZBC5wOhrGdfCE+JKSIOhVejtHh05qzFyI9ulUeuu5+FHXaErawtNKNFwlqg560woeIfIzKA8RNYFUhgmDAqkSRLxwCa99neNUpcVW4HrwLuGZzrwcFuFr4KD+UEuyMO8oNAcppYAEXGfgHp32gl67zGgBv3Tk8Eg7Hr9TohuyBy7Cf0FmXQg2nA2U2wGviNnMk6k5vBtWJoAwbLNm2AjeHowWBDIVJgCM5cPHILX+OvaUJPqJk7Wsc/WO0i2pVkRJtIYa9N1GgTAYXjyjSqRCTxXSir4HDEVc4HctT/iJHsxrqpd7AddI5oKIIPatsen/M2hNvkOTtOujqF4IIBNVFvC/5BZWB0iOKYiVPSOuRBUJpQx5cIFUyMIsBg8oPU20GX+5lCwXrtPsJBoknszy0dQXBR0DWcRbQIb2ZfEvj0U8BL9pnVBUSvpS2NU5CibwUH2ImxIY/dPJiC9LixOyZYtnI8RnWW9SYjBwwAJqkOthpNyfwV3ImXEqKgCT2mk2cpWbMNR/nMBKwJ2I2bVtuB32BSDU6mgV4MnIYAdGw7Gbmr0ChHkAywb8adSUmnkrtftHnv9Y6876nh+z/M9z/U6J/AIvlUSxIu0Wst4mVq9fqkWe0x41h2/QK9SyOGK9UadU/8EdDtxu+86pWL3TNmO9AVqZSKCV1YMSmcAZRGaiTyDs4qK0LayGVON6pQbK4602tQYX1On51lEgY3WNZ+Jv6bTphwE0qFMTLLEnS+H7mEmJKx/AmNL4zWoZ5ORvvvAplzwp7ixu2yXe39m8G9S3U0j+UCK4uPk8NcYgGm0R49QrHxG/kUqkQvb55gFpFNoe6BKfaZoFkFFwFCbSqe+pcuwqV3cpQdVimJfC01KrLfbsTu2aHbwWjyBJbvPBdk5MPyeoWkvEOajVA9UQRdqI4tGaVOJqWHYRbtRIBrgr+WsW+vtdiK3TLHiMLuskW6cy6ICkK4tCBnDXWec4ZvqFUBOvrPAOK0NuwaKNZe8dWJ4mDOxoR55oNAMZDubjNGYiH5WFAZlLolksM69Gx341Scsi4eweW5M4rfbKDPCDsyHlttr85zb/Ecbr9nt+267MuZo79OoQ2tjPstwnY6fsF/9PoybSGx3ZWd8Lfv1TmtFQjear6JIvma37b7dOp3Tfqfv9U88DyBuHRRf3LZGjZeHq+IuZiq3CCQjHAbubqnl4W7YUk3HhlI+A6mwuYiKSjA8a3qCobIq4tXMZT4KswMVaNp9p8aKZXWessKLNlP3xcglVdEBbNuqFEWyvfibXJ9dfCaZaHuhRVUIdPzEfgH6Dy8vXHtr1ixIFWyyCsBSHgxTVPtmXH2LdSDOwr2yZm1LVLkYGtgOEtc4aBIupnLbwRVNr86vR+RchNa05AKKg5pScP0HGaQxFnWbnIDO9kx2ULXmpjNwe8gCbqzPN89vRcNBbW8BhoQrD6qSjz3KYcDOKUA2AaipvywHAv/PLv8ds8uch4Y9mnYSQY+BPrfhtMzDsD6DbsGVpjrYHBdX6xtnuUTff1XRaoWPs2EZBkfINZ1EmKjt/WsHKf5jg8MnzGv7qfqsNW+AHDtrfH17vcKgcOdZGieh5ZnG+ENxPNSBhHhzlc+t35Kd4+1G3Yp6JRZVbQqdazRejXFGxGiII6ibvOXFuRpLTGXz1hATj7YuXr+fjyB1/wORZuu0 +sidebar_class_name: "get api-method" +info_path: docs/api/iiq/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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** + + +## Request + +

Path Parameters

Query Parameters

+ +Returns a single TaskResult resource based on the id. + +
Schema
    attributes undefined[]
    + +A list of attributes of the TaskResult. + +
  • Array [
  • ]
    • meta object
\ No newline at end of file diff --git a/docs/api/iiq/get-user-by-id.api.mdx b/docs/api/iiq/get-user-by-id.api.mdx new file mode 100644 index 000000000..2f666357d --- /dev/null +++ b/docs/api/iiq/get-user-by-id.api.mdx @@ -0,0 +1,135 @@ +--- +id: get-user-by-id +sidebar_label: Returns a User resource based on id. +hide_title: true +hide_table_of_contents: true +api: eJztXAtv27oV/iuEMCCp5zh26sS5xrrNTbJdF81tlsfuhjYYaIm22UiiKlJxfYMA+xv7e/slO4ekXrb8SBoUu5sKtLUtkuf9nUPqgA+OiFhMFRfh0HP6zoSpG8nit3P41nQUnUin/9HBn6Rz23Q8Jt2YRzgcBl9PGcFHJGZSJLHLyIyrKQmocqc8nBDuES7hoUrikHktAuNjRij+VSrmo0QxCaPjO+YRKslOOpKI0J+T0RymfkmYVDtNIhN3imMajVj4TDYaTTKbcvgtSKQiI0aiWNxzzywU0VgRMSYK+Gs0clqNBoH14jkOoAFTwDkPiYg9+KAErsJD109wFfgdZ4NgkQgla4EyskmokgcnhC+ggwTk17riqJGIqil8lu6UBdTpPzhqHuEoCSyEE3jCvtIg8vEnt+f24I/bY+Nej+HHHmP4iXbG7W636zxWqRtUCoKVlN4iwzGI6Qtxl0Rv5z8BXyAoKF4yhWI1GipOGGpMTTkqB0yUK0BOReJ7KLsdbpSGYtmVrCKRJqoBbcJjBs6Cyz42H4zkWrHw2KolV/qW6kgJNkNwxns29FiouJova2FAXBEEdE8yFEKBrXwutbkLTgVyGGdaMiQ4IShh0Q1kAlEgGVAi7KtxgUG2GnifsP6FXo3LSZiX09uVr7T/CNDsjPs+Ukt8ldIujRsxXCOLCWeVApfZeKoiAxom1PfnJyKOmY+aer4yLTdkHItgQZ+NKxGUAtqlYSh0TKYytBorxSx6bZWAIwHhTsOihGPqS4aCjCko2X6vkMxOJffUTxgwTRXx0NgBD4FLnnt1Eb7AeMA4cgW6SCIEoVShYE6pGNUBaKKe7Jq1wc4LUbVjBuy8apErppRxmwq/w3iDKDKEXQqzNFdm2SjxfeAi03m66CIxA10qZtqAgH8053k2ZSFENo0NIo9FnJrPYMfvRvH+7/U/jcaZ0XCj0SfS5cH+/cG+Bv79RuNcuHct/NJo/KEMNW8MuDiPtwgNxikkGvCg3cb/yla51H6PHEpgx1/U/4hKjf6aR+4h3LgiVAAFuBSNIp+7Olftf5a43kPBYSBAIYYVN9S5t0w8xZThXyyMFmFtDVC3R93Do2PaHbNe9/DY7b7uIlB7nfFIdQ6PRhhVqb6Xid6E/Au6iKY95iBtagNNmVzPI5AJwhRt5qEtPUBXV8EPNIFhMAtEZikyw5x77mbpDhY4o5AFtRrPb66u0wwGGg5FuMeCSBU8WPuVhcACR3oiuFBieKVuLKTU5HBIbFKDTTuyRU6yAHenNJwwb73+Mt9BRYWVSsLMBkAEzgMEZdE0//7nv7CCoD7BmS1yYeXGumGeYvxnrAFwxhgiRg80UWB9zPCUojGoHwoUjBSZjPYy3GoSY5Y5OR/8fWlhHnoc6AKe5nwWMS+RaWaAHKDzSWFpWbk2ZgudunXauKcxpyg7VkdpdmiaSVc/frh5f4r6NloblbIQits0hVdZvNBglqdDBmZMxUyPqBQgLwPgMRAwRi3HVLZ0tQEz5TetEyJR8GwScM/zDaOgCohAH/+nIVpgPOZfgTyaK0JqoAW0RS4FRovHZeTT+QY3A898S+MRwCJ5R94xwKGwSYbDIbrdmAbcn1dHqOZdPzcqK3ifNtx7Ck5gEwAJBHz5GWpSBib0wfsTOtGpeTVjhhXkYgKFTbiaCf24moc/8fjbmLCacR4fMVMafa7mZJkHmXBFRz4r2kMXBqG3lxhYyCbmvlSOycKCtgyy/rwJQTKzZppEktd6fBX7uFKZfQt28zRydEEEE+SUQ45nasaYQQcRT2jIf9EPtYtulyMAZ30xZwx5oy4WsMucDcjbUkVSCM0S2lEPKhSowmJdCAN6UZXIAvmKkshU4sAF5b5cpnyGv8O6HiRayM5ZBkpMBsoKjhxooIYTIeYl/gvEIBRBOPzK5p4Ug5uEtSatJhl91nb5o2WnBQhSrJXSx2d/G5xfvD9rnXw41znEEMAEaOlr4J+J+K4JWIUwgvrXeFqQnsYxxfqRKxbI5byvqp3COgQrKoLsFmlpOq/WWxnHo4U1t8tUTkpKK9GqWtdgnHYeGFnl8K13S4pF8gCSsGmeP9nD7DzC9kqsaQdIn2UpwS6xg661YyoEQGgoJKGuAACKdUUNm+fQZet908EVEHcwbOOwz5ka93XxKvtYZvZNCQdfgKlI8FD1O612XxcMyxJ6HseP4DeF5FVdyglwPFctZTHquiKBTLu8+BVHjgEbItAL4IUBAbv4wEwju5gReHj3ilzaqhWda3sH3Yi9KbgWIdMS34CSYtS6CqAOWOOi+RGCDuiT4XlefGdyp/6yFVW3TXu93vEIjzE6rPfDcQePMbrsqHCM8ZuYjat5ubkcviQzU6Wi/v6+LyAIp5Ak+8ft4/Y+51/20w2NXUbub+Zbe6zeMfgsYJUec1Z4WvJCcpkeZUG6TrdF5lgLNp72WAt3mFnduJP7887iNnF771pjdhPPlskC4+s1OolFEgUjXbtbz9zebbem8iPzo1MmNbiuQPBCWi8sS3YLX5rkAnf3UsIUyE3KbW3A83y4ztv59nJzVTTIB5udfZEpvZI+OFlPf3CKeyNYypQN2jNXA4MdsExuBtWzCRtzWLCe6MlPb8r1VPPDzZtryiPG8dNAcrp3QV3YGbrN05M3diJ+tOnnJaJ5a8/YHNHFGLRR3aO9ca/b63Y9jOped+x2Dl4fHbhHPRvV+gy54nQCf14Rx0ux+18f4yjNeuXicZgLLGq5nxXhm2noan+PDK+3i21ckOwOr5vkLeoN6pOtIpkrE0Lp0fTS0Y+phMC6ZhcMEaQpYeiks1pkAFgw0caOyanVzYYItjO+CT9m+rVIzpSL4zYH8kDvM/5xqo+LRDzfCkQqqooFdfzKkGSzB26GEO3/22KHSyM64j7PCrqFPUD+lNDUn/ThHSh5oUJdCvSyEI9FKT5+cq7mgCfBIN8eiviTc4vDYi7vrlwoyisYwtMeCRTIJQwiepRR7TI/UHuzCZTdBbqdg0NYn8tzGtJJZUW+sOeoPGe3pPClFCWBWWr9riE91KdFaat9paSQDJguBhjF6ZY1rR7N0We+yYEvGrBt7OIBR/HFgEYlDI6Lwf5bgTVetuTy8djzKvtF5pFx3JcXuadblv/kZcv/F2NtU2R9eLFNwjYsv9BOwrwa2QY0mo4UYzWjMfsrTFmZHtJB5N6MKriydr71DPdarzVgBNGwIv+d2fMptD6gknC5fldkT42XkaCCQGd0QF+7ukqoEOAUtA4zEi6n6dGzOWXaam03fJO5b1Mkb+xbDl2TxGyyUmXm2QLA5KC7IX8GLIaYLxD5MAurIC5rc5hNBRGzUNojREub2gyaueUuDsY3vb4IJ+ku4AlYcVqBE5aaQA7Xi/VOsCfiwPZrb/MqrDqOMYbhARQ6oVspVP5K8oXichOnGJe4zOp6LX36TP+6gh9ohEm5QOlJLlZgYDsnW3/y9WSny+hv4RpPTz9PWf35p0xlx7NvUcukX9z1Np8sNZ1T7LhQgX21vWCL7NkzXe9SBxb1yYe0uUujnAtcu7BqlQee4Dsl81AuUS3mi+fVrx+dk5N2B8aenrYPnFt49FmM9MZ9mZV34Er6kX0jtqJ6rpB7iOyj3IPE44qkRSvGH5Xqko3B0tMKfYNwigerjn5xLvoQTt6c1bJjfQ9W3cNlnc1n3+yrgh0U0OxrC0RQ0LP+wcpj8LNskLHSlV6mRU4EsM4tetg6e/F0vIwJwaq6/nyb2U9GFFxmR1ZsAb5HQZu9YduKvAtF3esuVnYMwvjoh7buzzscH0IOgequ91I169O42hqENnJvdrMBU7TC+PAruC/NE3UOkGUPcE3X0ZqYKqctPGGwc7YMnqL0B+2Dg732wV6nc93u9F93++1uq93r7rUP++22s31CrxDre5QcBobOhYdtN+t1xsoq0xAU2InfrLj2cb972Do+OsoVd79uZ7KwIdlObT9/cjpHXdBI56DbBSN9ckyhnb80qyZWDhdVfrm24oDR7rIMmK7YXZmHhIf3wr/PO3xL5J6b2576XnNDNsAzmhz9vyl13JowL7bO4ezf1v1zdf9c3T9X98/V/XN1/1zdP1f3z9X9c5s9rO6fq/vn6v65un+u7p+r++fq/rm6f67un6v75+r+ubp/ru6fq/vn6v65un+u7p+r++fq/rm6f67un6v75+r+ubp/ru6fq/vn6v65un+u7p/7lffPpZE+FfaKVAxjvOmz71jffTBX8z3CA9x7pXeEJrG/OgBsN10eB87iHYaFhjutZrO0viVPXwGI7/f1B8jwg4thS1/CJ5mbxHhzJjIAQ7k7SJDVj7fFpzrjGQgqjMmshCw71iP0CROOcVANPByLta2Bl2dX1+Qs9LTJiK4oxhQ88VS4SZCVBlgGoEyf8NQqCx7nGHbh4EKmrlmSXy8NguqX+KBIQHxkxV4lmd8tuOJSQXOhYInxh/x+wf+z22ytoRW4/z6UGdy0BaG/PljfTq/9bTp94914ATD6Lz56eEC13sT+4yP+bG71RI+DkgaPAb3CPZ0r9P0/dpHrCpXesbmzcB2urcUcfSnqy+vrm+9qXStJ5b20z5aovqP1e97RutawCzfx5ia9xS8xR5s+McJ3L+1d0a9IvtEoWfM7311dKX5asITzotipWiz0PeKWewqehXs9UIJ5OHBdFqnCtKUralF7WeXw57NryKH/AfSAQ3o= +sidebar_class_name: "get api-method" +info_path: docs/api/iiq/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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. + +
  • Array [
  • ]
    • 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. + +
  • Array [
  • ]
    • entitlements undefined[]
    + +Entitlements of the User. Returned in response only if requested using the 'attributes' query parameter. + +
  • Array [
  • ]
    • roles undefined[]
    + +Roles of the User. Returned only if requested. Returned in response only if requested using the 'attributes' query parameter. + +
  • Array [
  • ]
    • 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. + +
  • Array [
  • ]
    • 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. + +
  • Array [
  • ]
    • entitlements undefined[]
    + +Entitlements of the User. Returned in response only if requested using the 'attributes' query parameter. + +
  • Array [
  • ]
    • roles undefined[]
    + +Roles of the User. Returned only if requested. Returned in response only if requested using the 'attributes' query parameter. + +
  • Array [
  • ]
    • 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/docs/api/iiq/get-users.api.mdx b/docs/api/iiq/get-users.api.mdx new file mode 100644 index 000000000..2db063662 --- /dev/null +++ b/docs/api/iiq/get-users.api.mdx @@ -0,0 +1,139 @@ +--- +id: get-users +sidebar_label: Returns all User resources. +hide_title: true +hide_table_of_contents: true +api: eJztXP1u2zgSfxVCOCDdnOPYjhNnDRQ4N8neumiaXJzc3qEpDrRE22wlURWluN4gwL3Gvd49yc2Q1IdtWZbTbO9LfywaSyRnOPzNb4bULB8tEbCQRlz4Q8fqW1MW3UkWSqthRXQqrf4HS//+2LAcJu2QB9gWWt7OuCTMdwLB/YiELIpDXxLqugQ7wAMp4tBmskluZyxkhOJ/URTycRwxSTwafmYOoZLs6b7wQ/jugowX0PdLzGS01yAytmfYZn8/FC6T+/sNMp9xeObFMiJjRoJQPHBHDxTQMCJiQqIZgw6ZrP19AuOFC2xAPRaBdtwnInTgj0jgKNy33RhHgefYG5QPhC9ZE8yQdkJjPFoc566Gg3c+vIGfE+7Ce/gt7RnzqNV/tKJFgG8k6OBP4Q37Sr3AxUeusJW5CftC7q0b6jI+nd1bhPoOwfGaU/7A/PfwF5FzaPEp/25CPe4uspfy3rKeVldm4LpiLslEhGbeWj9YHNuGWYNCOO2bn84OeifdboOMmK0UOmp2m51mhxwQX0RqJVNsSLV8Mg4CEUbMaYLQYlNIeP9mUdEUMQAF57JxCjiaUlevSexGEvFBU3TtyRymyrW6wvWuqBgqA9DWjx02oSAZHtP06ZrC54gQj/uA7PmMRhm6UHSqO/dLdIwAvkPfYV+LlAQfY1Olf6pl56h9lNOuXaYTGlAJQGtyFJI4ilaNSBZtVs0WsR9V1KrdyuvUarXW1BoFzOYTbrTyY28MlgJtEiMB5sBTp2yzPtmS7wi0hg9ofmBDh/kRjxYFuCO28Dx6IBm6PSCduFwqUslRF6yqpqw1uiCKFFfJBtwGvI+BJMK+aqIZpKMBxwnDYgnSJbp3Ku+V/EGxlIhmZM7BKc2KGdlL7cYMx0j4dLMB19XY1ZAe9WNgiMWZCEPmoqWeb0yjDZmEwlux5/5IeEthw6Y+khNwdjKH5r71BMEp6SNxAp1WC/9ZVucmF6JGZ8PL1TgFE7UFABqgDn1pELhcM/XhJ4kDPOYsBAsGaxpxLS4SEXVvNHzX5b5PEb4sMF0njLUb/clqnzbQtDl6WJNwW+bdShj6t7J+k5xRH80njRc6ACpAVjb8Knybpeoh62izFMxcWXmk3hJAjqNCUj62mnFpGFJEJ4+YJ9cB+JST98ECk/U5iyZ9paHsS5t7fRrwvsekBNqQ/U6z1X8Hc70xkqyPMMJNYvbc+Gtyl5eVO+tTSqhj+CfCncTKuK656RT4jd0ad49PTml3wnrd41O7e9RlrNdz2pNx1D4+GeMc02i4JvTO57AoIBBlw5qFypCpZHK7CACq4I3ayuBSDg8hqMMDGkMz6AVIZvhC8QsLH7id5k4wwAWFlEqh8/JudJukQxBnfeEfMC+I1MhKO/JA3ThhupxGqiPgKta6UjsUUjM8Ngk1Ao0PSIVC48f2jPpTJKsy+10K+3MTu6Kh/EIjoRMA38CKg0CZX5p//v0f6GzU1TkUuTbzxiR0kVD5J0woscckdnVDTCkpkaCKi+4VaufSbUToASmBrWU8PkjpqUH0sizI5eCvawODY3KQC7SZ6ZmntlgmAQCoXoWN3NCycGwMCk0ynOjo8EBDTnHumKsl5NLQnUY/X929O0d7a6uNl4INTrehiWB5esoOqDgyIfSYiblqUTgBOROx66g1FR4I0Iu67FPp0MULmBq/YUCIQpGwPe44rlYUTAEe6OK/mBfLeDLhX0E8LleA0sAKuBbZLNBbHC4Dly62wAyQ+YaGY2AW8pa8ZUAefoMMh0OEXZZ7b9Bdvdcmy6FPLdw7CiB4r41JPAE/foENDoMldAH9MdJWqWJaFdQi3R0UK6FeF+vwEw+/TQljGevpCUO9tudmTdZ1kDGP6Nhl+fVQ8d93DmJNC2nHDEvLPpkb0GQ7Bs/bGCRd1tSSKPJWtS9SH0daVt+Q3SLbkLh6bzTjAegSzRnT7CDCKfX5r3qXhxCtFiOAZ12xYGo3RG3MU9c1G5A3AjbCEMIVDeddc4ntqAN5P4TAUOW7GN2jWObEj/UoeflRGDOMtB7lbkEsv8DnMK4D8RuyrDQCxToCzUxgyBENpGrCx7jEfwUfhG0bNh+Z2JNwcIPAhrfZIONPal3+YNRpAoPA5ACdVEXZ5PXFXwaX1+8ummdXlyqGaAEYAI18RfxzEX5uAFchjaD9FZ+W5Rsr6VwxKAwgWN4Q5FVelpLzQ/kqY3tcYaXtupSzJaMtySoaV3OcAg+0LAJ88+2aYVE8kKRHYUuwK8JMP8IOllRTAEjepSHBDLGH0NrTGQIwNKMh5BVAQCE6NwgSvs3KsWnhCMg76LZF+Z9JQfsSlFIHUv02JIEqYVifoeNw/BNwkwtexamcAODZ0VoUw4MU2BIXpbwcNQZuCMAuwBeaBMzgA92NvMKIwP3PP5AkK0VwVQfoVu5NyDVPmUb4FpYU4+bIgzygBKIoIMt9VY6fbjPSeSd4qSTVbtFer3c67rFJr816P562e5Add9kJbU9a3W4XlfldyCbFutzdDF9SmVkUBf3DQzymc2cQJPunrdPWIedfDhFphw+dQzOMPNyut0Ks2jG4zGOFiLnIvV1CIblJzkUhXCe7Jn1GyifJGSm8zfLGvQzPeyXbuC3oKll27c9GyZzi5RadhiIOvLHK3Q0yq8O2spSfmRucM6nIdQOD58J6bljyKvejQa7xzExK6AKxKbKbW/g8a67idnZqsD0rGmSN4Tdsp/JKqZHU+Ui5/ME57o1gKJ02KGRuJgbTYF3cnOJpK7qNo85hyoWevX+9nE81ru5e31IeMI5/DSSnB9cUzxfsxvnZa9MR/zTh5yW8uTIytnt03geNV/dob9Lr9rpdB726153Y7c7RScc+6RmvVh8kCk6Z8PEGP17z3f94H8fZlBvXAcE2qKjm/SwP3y5DZfsHZHhbzbdxQPJqeNsgb9BukJ9U8mQeaRf6EvOwaH861JkQrK7eBYMHKUnoOkmvJhkAF0zVYofk3NhmiwebHt/EH3P1jS1TysZ22x15oPYZfztXx0UiXFQikYKsYsUc/2VMsh2B2ylE4b8qd9g0oGPu8jShW9kDZG8JTfCkDu/AyCsZ6g5np9aHe2u0AD7xBtn2UIT31kdsFnL5eWRDUl6gEJ72SJBAbqARUa20adf1KToj7hzD+FxeUp9OCzPylT1HhF/QnOzrFc+JIhxP5Tw9VPmuYUJdiVtamp9tMVaWDJIS0/UAvTjZsibZoz76zDY58EMRtvFdPODguVMKxUroHNeDwzcCc7x0yPXjsedl9qvKo+K4L89rTyum/+Rl0/8XU22bZ1292CahisovtJNQh+GVSKNhSTGJ5jRkf4YuG8ND0og86FY5KCvwlSvcax4pwvCCYUH8uzDnU7j6wErC5uqbnjk1XmeCAgHtcYce2SpLKJjAOVgdesRczpKjZ33KVGls23+dwrch4tfmK4fKSUI23Wgy/W6FYDLS3RI/PRaCz+eEXM39Ioq7TehgPhNEzH1pjhCNbGoiaArLV9gYP+i6wp8mu4AduOK8gCeMNIEalk/rrWA78kD1sat8Civ2Y/RheAGJjm8XTio130v55TZN0S+Tep5iC6XVPs/D1wge0ACDck7SThDLKVANZOUnXzuDLpVfARq7h59dRn/+KdMy8MxX1GXRLw697SdLDescCysiz1QsrBb/JO+eCb0b5VjUJVdpERhayAatbRi1CIFn+E1Jv5RrUvPx4rnf/s/OWm1oe37e6qiP+p/EWG3c11V5C1BSr8wXsQ3Zc8G8h6g+znsQOzwiSdKK/kexpmACKz0rsDdMLuLepqNf7IsYws7bo1p6rO/AqAc4rLX97Jt9jWAHBTL7agUCSOiZqoUoPga/SBvpVdJ1Gk1yJkB1btjD5Nmrp+PLnOBtyusvq/TemVFwmD1ZsAX4Hglt+oWtkngbkrqjLmZ2DNz45MdWD934eHIMMQSyu95L5ay7aVWZhLZqr3ezHotoweLDU4AvXS1FWkeAHTJaWBGQ+tRy2MITBtOnovPkZ99pdToHrc5Bu33bavePuv1Wt9nqdQ9ax/1Wy6oe0Aum9T1SDk1Dl8JRxVulNmPLJlMU5JmO32y41mm/e9w8PTnJDPdQtjNZ2ZBUM9sv91b7pAsWaXe6XVgkXe0c5j6aFQtbdpdo+ePahgNGs8vaVMumdlf6JeH+g3AfsnLxJXEvWtdW8l1zSzTAM5qM/b8pdHx8ejKeni+KxAF+/xtXRpafK1nt41arLo586eLILe6UrU6WxyT/G0j1DxB1bWVdW1nXVta1lXVtZV1bWddW1rWVdW1lXVtZ11bWtZV1bWVdW1nXVv7bK6Lq2sq6trKuraxrK+vayrq2sq6trGsr69rKurayrq2sayvr2sq6trKuraxrK+vayrq2sq6trGsr69rKurayrq18gdrKxNlnwtzCjJ5MgVv7loYv/MZdV3INcRy6m6Fv6ugyD7BWr+bMldopA+uhyZjiXZ2w58Qv++oPiO2D62FTXbEpmR2HeG0qKgBNuT2IUcMPH/NvVazT5JNrk64PqmwZLKizJWxj4ey5PxGlRYE3F6NbcpHcOK1yiQkFDJ4LO/bSpAATAJzTPZ5XpW5jncL+G8CjM5q1+auhYaLq8z0YErgeVTHXpd5svtx61bKP2R2i/zc3ZJuVjQDph5BRcF0BhAB9NBjOXSKOMMUHj48ItrvQfXrCx/qCWgQW5Cx4zueYM8YS+36Pe643zO4zA2Wze79N9mOpC3d3nsCut1yX6pRewP1MnapfZL1VjeTG7W/XJCqr4U6vry5XKH+99jM1qn5zdakqyXXaz0XN/9Yd1aWmWrrp+ze21zdfQ106k8Irt7MZfcQfIccpqYAKRMkoug9Soh5hYNssyONm7YpqHCXNIf54cQth9V/Z/NCA +sidebar_class_name: "get api-method" +info_path: docs/api/iiq/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Query Parameters

+ +Returns all SCIM User resources. + +
Schema
    Resources undefined[]
  • Array [
    • 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. + +
  • Array [
  • ]
    • 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. + +
  • Array [
  • ]
    • entitlements undefined[]
    + +Entitlements of the User. Returned in response only if requested using the 'attributes' query parameter. + +
  • Array [
  • ]
    • roles undefined[]
    + +Roles of the User. Returned only if requested. Returned in response only if requested using the 'attributes' query parameter. + +
  • Array [
  • ]
    • 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. + +
  • Array [
    • 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. + +
  • Array [
  • ]
    • 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. + +
  • Array [
  • ]
    • entitlements undefined[]
    + +Entitlements of the User. Returned in response only if requested using the 'attributes' query parameter. + +
  • Array [
  • ]
    • roles undefined[]
    + +Roles of the User. Returned only if requested. Returned in response only if requested using the 'attributes' query parameter. + +
  • Array [
  • ]
    • 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/docs/api/iiq/get-workflow-by-id.api.mdx b/docs/api/iiq/get-workflow-by-id.api.mdx new file mode 100644 index 000000000..ed7c9d0b5 --- /dev/null +++ b/docs/api/iiq/get-workflow-by-id.api.mdx @@ -0,0 +1,45 @@ +--- +id: get-workflow-by-id +sidebar_label: Returns a Workflow resource based on id. +hide_title: true +hide_table_of_contents: true +api: eJztV9tu2zgQ/RVCT22QyJJjt7awWMBNg22AZJG13e1DnAdKomy2kqiSlFPD8L/vDCnJ8iVGUvRhsVgjiC2KnDkzc+bCtSMKJqnmIr+JncCZM/1FyG9JKp4+rGDl3NF0rpzgwamXlfN47sRMRZIXeAwOTReM1K+JZEqUMmLkiesFyaiOFjyfEx4TruClLmXOYve3UJLO7/b/LB9pLXlYaqaIFoTnUVrGDL6JBskgsBC5YiSiOQkZUQWLeMJZbDXgFro9/71kckUKKmnGNJMuaWsi+6rYD6sqkSJ7qbLqTDx6odJZPsvRQypasIyChpRqkAfaG59xFZAG4QU5OwMnBZzpJDAyVaAingVWADxQnhaC5zrwXS+ohZydzXIIVwMCg7Z2cniACD1Vm0xEOcasoHoBv61MJ1g7elXgTgVG5XN4w37QrEhxKfLowPOH0cDrxj7r04EPv1jYDfvvmdf1EmezTwgItkgOKeGCWMm+l1wy4JqWJducry0c40F4XeHdBvSFGPHcOTHvD9CMSCSyjF4ohs5B36dcaURId8hgyblPO5dMF/wgxESVkDeKgaYjhDgnSpBCiiWPkfsoTsG5rb436i1qDAVw6omnKWorU13r3tkXMpTRZI7znM8OYbzKdwuaxymTP+++Z3PJBUJPRLaTppBeudCYYTVs9+zM2TwiQewphaC7nodfu4DGxhWKUKLAlPRY7QkphIYI600eI/EikWuWaxRHiyLlkSl6na8KZa5bjtoy9MG6FkBBLCHcmltUPD4E9TnnEA/QBTqwYEh0kG4VRsTwfAzeJx5+MLMGfpy8Nzk2CNk7Oow8n15iWGyc9xX/icR6la7RfC7ZHCJJroSsy9Fo6xN1wIF9nR+3T69TfctDSSGPEiHJRLNCIZ2r/YcU3esy8PaYNpaXGcbqA7Yaco9Zp+CEFTGBsMZligYqxed5hhRoL48FEGgUab40tsO7O5rTOR6o2QprNyasetV4zG5tlq+XVm6zcMsTFq2idOfw5yKmu+LGLAHOYiG+vboj9XL1uGcKLo3ZHHJP1vrvBcRsRf7mooFk7LkTMcNcBkPLELgbMYXF4J4qBZ0gJjeQCpAmBUIewUbzXZtLJqs8QtJvw4ahIlXsMGB1rTggxif74nWkaPqZSwvuTjTIoDKuz37a1iWovO1SJsKvLELou9kZSYaMPsJaWJ5yyJanBct38JEnCiXJnjuGFegKgwysYPwuNMjYMaDrdbsXXu/C7019L+hdBt2h27t8d+H1A6hfADwVNrOOlI3xLdbOlztroXURdDooMV0IpYOBN/A6vGIO/97BUaGz7Haaea3zktqSUqWBNWbUOeG5dlfHIyQzZ6x1P+25PvxN/X7Q7waXnuv7w63nltBkjzqugVHtOO21mfNl5vjvesNh3/eGvcFlb+ag+LphTKsKtN9oqnaiW6UHSQjGQPMpDf9OK65hOpv6Y2i8ENWwbSY2mMQCpxWw9XZc22APZ3JZz3OlTF9BgoMaWleYm7/I5OrmjljRpl0iDAK5RswP4OTo/sY1HVmxqJRYlhAAbOXRqETID4/tt1hSM5uBrT1NsiLkeh7BZ7PHQXfwPBGHvm8hHV9PpuQ6j02NsLUroRCVjyIqsZ4b8tmWAjaZKbihjTNwLzFAXJtw7NtvRIOhyIUCHJlRQ7VqotoOGicmDDtd7LXLZtj4/270L7obVVTU7IfuFCmFIRrCbjJqXWVh+5p77gStaxMwHTMNt6zXGPzPMt1scNmO4ZgbMVc0TLGAJjRV7AQr/mNXkmdc+42t9u9yS5qWuNHcYn69v37BHeSkLUfvWFubHvFBcjTqlYR4M65uHW/JicvzUWTVIs1XbSw14haFN484ujEa4+QG6OyGUVQNgvXRg9sRmtX0rD+up1C1/wFn5E54 +sidebar_class_name: "get api-method" +info_path: docs/api/iiq/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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** + + +## Request + +

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/docs/api/iiq/identityiq-scim-rest-api.info.mdx b/docs/api/iiq/identityiq-scim-rest-api.info.mdx new file mode 100644 index 000000000..e07898db4 --- /dev/null +++ b/docs/api/iiq/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 SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; +import Export from "@theme/ApiExplorer/Export"; + +Version: 8.3 + + + +

IdentityIQ SCIM REST API

+ + + +IdentityIQ REST Endpoint Interface Documentation for SCIM + + +

Authentication

Security Scheme Type:http
HTTP Authorization Scheme:basic
\ No newline at end of file diff --git a/docs/api/iiq/launch-workflow.api.mdx b/docs/api/iiq/launch-workflow.api.mdx new file mode 100644 index 000000000..1da1f789a --- /dev/null +++ b/docs/api/iiq/launch-workflow.api.mdx @@ -0,0 +1,59 @@ +--- +id: launch-workflow +sidebar_label: Endpoint used to launch a Workflow. +hide_title: true +hide_table_of_contents: true +api: eJztHGtv4zbyrxD61OYS2/IrtrE9IM3mCqNJmybpbYFNsKAlOmFXr5LUZo0g//1mKFFvP5LsIbme8mHXEjnvITkzGunBCiMmqOJhMHetmeXROHDuPoTi89IL7619S9Fbac0+Wqd6gLlmSFo3+5bLpCN4hNAAexK4UcgDRVRIEjwkFIR9ZU6sGKHEgHbIEYnoygupS5YwQ90xIthfMZOKcKl/csFcQgMXxuCOQwPCA8eLXQb/R7GSREbM4UvuIC2EN7jJgvHgNiXP3A5IEFFBfaaYQDkeLI6sAjGxgrEARuCSKiX4AriUcE8CoE+t2YOlVhGOShgMbmGEfaV+5OEtzYX1WNXAEXFC36cHkiFRBTJ4HIQKlySngBwLpmKBMqWyyygMJOuQK5RW80YyromMwUKSASXQpVaCe5Rh2ycyJJEIv3AX5UZ0EuByet/J75HiIlR35J57HlKLPWVol+YlukuYQ9097jerq87Gjmq7T630C+J5tvZS8mQpQr+iwL3LsCi8dp0gVCBZprvOnvUIrps63I+hu0KejdNZMyVitm85YaBYoHCIRpHHHb1EutLh/j/+lMjuQ0FiMADYSHFQRHZfFlRBhaCov7K8l8k8YN/T0oJoZpVl/izRg7livkaXafKjBSaacaaWM+0ocoaczVLKM0m5p5fizO70ZtWlCxifAH1F5ecL7TPWzSPYrGTDBmuXZcRZaMHSGs32h07JO06Pz8gZDegtI+dUSiDkSvSSZLFt0+ZR5i16ftEJUvo15ZZ0W7bhZ7baLtxVcQERACnLE3k0QP6/UC/eQVVlbBqojO/dOa5zCbMB/ByQ//M6IOTdkeOEcaAu0h204K4/XFvz+W/XFgkj+HkWuny5urY0FMJlCkrvwL0zGmUXcAkrALYiEAzAgTXq3Plw6zgMlvz2FLR9bXW3T5cbZqEVgD8tLFyCKEzKVJINYNwtADk9OunZU2di93r2cNKb2PhrOhoOR7Q3HBxuwgOLXCypwwrowAs3QGSnZQHiIvTYkesWod51c02+69Y0nes+s5qU/DZAdc1dQLmY9t3RYMGmYzYdLoaHC9i4BtPpYDjqD8ZsMQXquBejnjUgc5EJaUytucn4+5EFbMnh0Dz2mPhs2AS2So7TOtNmZxqPwJkm/4vOxIbMnRw6feray+Gy7yzswWIwmg4O6cJmhxP6PGdKdmqxxZ1qzBadomIGuOJqlcLPi0R75s8u6aUInp7nyFAGJiPq+jxYCyPDWKw3V672mtJLO/EVFbdMZQLWh56xuAUYoGHl5mKkyr5kHnPQg4orVRNZ58gDZ+z0BuM+ECmA/JLY/whwfWGf3kMk5KhQrFJO0tEyN+SAzK9ggjQswIw+7rZFb0/ZnAfLkLhcwom4MqRc6v/MAnC2lfY/JDxPXcBgKi6BqsCZker63t0SO6yMqiUyt29tUbXFa6siNc3bUMbLHNNh4/FyYY+G4IfD/oQtDvuOa9t0PKb2yB4PUQNMUY6yYcKSO+o5XcEvjxwF1Fvhufe6xjHs/ARGEhTY0ofy2zDRi1TCBqw3OBw0quQ49KNQQmbx6eTi/NNPXrig3icI2NUyFP6ri73WM5sG0vPuwpyu2TF3wZZMsMBhxPHAefE0NWljJ1z8CRQ7hjdglm/Q5ZANhm6vxwpxSOXgftct0S/zmSZCmGgl+dXT8iycW06zivn+V9+zHpO/fWuvu9em/W3a36b9bzxTa9P+Nu1v0/427W/T/r9tqtmm/W/HFq+tijbtb9P+Nu1v0/7/TtqPua/pL9ApYr9n43+V1pekyUUSSkyirNtXkl4KaboUIJvGDotqZt4he3vVe1lTg8xaXwqpbdb6kKfpxXpCKe1OGnCAz87enrW2s6He1JCqM7FqTZ0XKXsk1aDu5KHk/NfLq6yZR/dq1Lp/sCWnlHQr7XK7FRbSfTMo1BdyFZQNeiICYKLzgUJoK3RCzgRfcuzxqFPBJUpBKZYLOjxQHHhpciCDguC0bQz0e/3+QW900B9f2fbMPpzZg85wYsOtWa+HDEUUdIDYSzwtQthHaVCj/y+P3qJKeeCi0RjhVfLYPVXAWeJmST3JHtH8eK1epIUMx7PVMD6c5GrYcf3C6DZSEMgjQtP9tdumYGavFQYtxQLsr7qEw/rX5bJY48P0D6KPegUs9hcQlAC6FJbgSR8CcEICTLVGit7jkwp1tTLf1qVb22ry5VhfnGGsmstwaypou2/GCead92SQ94lVtRqBhuKadsCdq341jLXin9n9L2Pfp2JlmQMEANguboNUgsx1UjhwIYFLE300FqbPL9vXtZMVjkZCMTbjxp4lx1pXVH1pPbRSfK0rJoTZPpeKO8VT/IkWrVJpMCiGxU8LCqpI625oduTEmFUTbyXyx9kpWDKCAx3OXWoshibMYgWZ4KoUfj+UKRGIhLAyA/tJEiJZL6rL3z+jLq83w1rJZjvduZtrwPivQWPChcrCNH/DopTHVLLn0svkdQAJ+Y4SEQd6ufBAKoohLXaaZtO+L/NTimLt4aGOYu3+ZNxfTOzReGJp30hCmWMMjXeOZXQgXTx3SNPRZqJq1IYPOWA9Bj2Du3CE0aynurbPlw+c3XYARzCaRgtlcu/hNkYI5P6OBdVAZC0L91SSFGWBh80BSDWUGBwM7Ct7OBv1Z8Nepz8c5aGEFyanRZ3d3y9OTWTcqIaGbuU7paJZt4s4vbtQqhnkLr2ucVv+l+4G7n7pd3OEsrvBT0bgJ4dJfCKVrqTzjYoFl9hgQoJYiK/RpEJ/G32OC/qEeFc2qvPfyUD1GdtmV2vQ8bX14dqyx8PpdGT3pv3RqH9tWUnKpau0V+k2Xks+9Kjeqw0PvvF/GZu4Zz3dWtSU7O3f4Blu41PGt/AEN3jyCdGwoDMD73pikAPST/YsKWFgu2pP08e5BqA55m/S7HEYBGk9hwkRikTswksKWyPjo6Y3Dhrpf/vHxiZG/IZPjnvJocR3OzBTORWeQOIJVt9lx0szRqB1CRFQvMPheJxBkARkTe4HwTLa/jLWFUa484GKIEF4op1g37piwueBPsXwwo+SgZuiEAZen+Hy83u25AE3J8nTVkwOuy1dzdSaLnRdpVA5t8+oCVQSS6wI5AgbCwKeob1VUMPlNrHSMl7eOAM7812Ib5dFcIrqN7LUHVx16++UwQ7MxBfzqlYsvCccww0+nUyZ/0Yuj+dnJEFNFhRfMFJ3ukCnf4ACj87nHf1ekISkSmCchQzAVO4cxcjtx5viqN7/k7VfmJMpEFk2r0Rp8+EcC1WBZbaL/NWjE6O0QvvQx1c6I26qyURzZ06WQ35M972k4SXbtdp+lbZfpe1XaftV2n6Vtl+l7ZFo+1XenC1eWxVtv0rbr9L2q/y/9qvkdfdqv8mNfjy3DOvlzkIie3FyeUWyD63MTSxH3odO7GePl7BugymvppfVcK1JZ4D0uSo9UTDpsUYNebB+3g15tk918SP95kdGM5ZJvTP9wku5saPE90Pea/JWvw2T2kKxr6oLLsz1IzVddnhIqxRrvnyDhQgcfHjAcsLvwnt8xNvJh1IwNYY1QRceFnF0oWWDav5mH41Zo9SkVFD60I4pGOjvzHx7fb34MzEbJWn8Bk4u0Q1eCI4i6doReAyjLlbZsrLJcSLRgX7EkcM2f24GVZSA4dEUqTUAydybQskNG7Jg8iL9zo0furrYTLFQhP/iI5hrCy5CrWpd0tL3HyzYsW5jCFVgToIX//4DVTXTEw== +sidebar_class_name: "post api-method" +info_path: docs/api/iiq/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Query Parameters

Body

required
    input undefined[]
    + +A list of input attributes of the Launched Workflow. + +
  • Array [
    • \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"}}>
  • ]

Body

required
    input undefined[]
    + +A list of input attributes of the Launched Workflow. + +
  • Array [
    • \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"}}>
  • ]
+ +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[]
  • Array [
  • ]
    • input undefined[]
  • Array [
  • ]
    • \n"}}>
    meta undefined[]
    + +Metadata for the LaunchedWorkflow TaskResult. + +
  • Array [
  • ]
    • 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/docs/api/iiq/launched-workflows-get.api.mdx b/docs/api/iiq/launched-workflows-get.api.mdx new file mode 100644 index 000000000..1b15e7018 --- /dev/null +++ b/docs/api/iiq/launched-workflows-get.api.mdx @@ -0,0 +1,72 @@ +--- +id: launched-workflows-get +sidebar_label: Returns all LaunchedWorkflow resources. +hide_title: true +hide_table_of_contents: true +api: eJztXFtz27oR/isYviTHtSWSlmRak2TGtZMctbnVUprORJ4ORIIWTiiSIUBfxuP/3l2AN4mUrDhy5rRlHmKRAHY/LPYGrIQ7I4pZQiWPwpFnDI13NA3dOfO+RMk3P4iuxVsmjX1D0kthDL/Wm42LfcNjwk14jDSAwmTOBWGhF0c8lCRhMk1CQWgQkNXB0CiiNHGZ6JAXs4R0X+n/p+GJlAmfpZIJIiPCQzdIPQZ/iZwzHBVHoWDEpSGZMSJi5nKfM49cczlXXZ7RgsAz8j1lyS2JaUIXTLJkmRdZZcZuNDM/iRZbs8sGeSfbsp2GExgnQBoLChwCKoEecK+JiIshQDwge3sgxiFn0h8qkmIoXL4YagrwQHmgBD60OuZwlcre3jSERSyw4FLeGRxXS6GEthBa4NHnAbTDsyZsDO8MeRtji4CZhZfQwm7oIg7wlRvhB0TOvpOpYZu2fWD2D8zDiTUY9szhYa9jH1nwamiaU8O4X9WUkwA1iPhRkglLcwdlcd0o8YAdiuT8zenB0aDX2ydj5uJIctgBwh2bHJAwkkqzCh2GsQnINY3jKAFgHWDaPFEB7X+93XKiNI4D7ioGa2eBBBVirTJpIAWZ3RJaKPkzwFaox2ZgHxPvgUXwmE+BBWITLhgbvr2vQkaM2ftVwGeoAgsegr5fz6kkEXJDSSPrAjsPN2CUNJGj0GM3TSBBC9mlwl/AscwKZKsmwgoiFJ8ij7LkyIJEfkWoRDC5HpgbpaF8FCbTNGuwxpmla1RhupiBnABNLiJQOrDvS7YeT7ngW2oajtsHHxTzZJ26ETC7BT0QDM0ZjS/gQiIsuuTHtONd9Zkdotzzim9CgwG7Y8CJ1F3ZPigGiZPoinu5ggsYV/J7Ln5DjrMI3OE1B3PMlirjvdRvxpCGBrfJPuswtpQg91goubw9Z0BRSAhqjxbh2lDQAXc8jqoiEBgd0BtBgMihd/b2jHsIj/kogcBt08Q/y4DOM3EoXzY+Hb0vI6PyjrIaUlUggcC1t9cUTzWnImRWABazmFDx7VyvUCXyYEtBiN0wN0VwOId9MCswHzAsAF5xhd0/BKK/qywLaAkokuR6rjKSNNCcRH3SH6r2lE0214v6rDEHWWvKhrWPq1xxSzVuk01+RXFHz6IUoUNOGyN9Sb4W2zeiQ3+Xxek6LrXaY50HpCKbeaFnJV2aJBTNg0u2EHULqPr+r0ZjqkBjPlwwIcBhiaGNWQLM9TzjZFwAhfN8HSr0a3yXlzhGieJUmFef25uAXur8zUOVYXpFK+oHTxUCHfL8TYOOKqkAlUBp+5Ke/lYR0CyKAkbDquBlkrL7/TJNaXIcIO4FxTjqAcADycH51BNaRspU5wz6TaBbrj4l0kfiL7VYJ1C9A6s3scxhrz+0Bx3z2NEJFC6xBl9TbXi7MzTrHWveDYEEmef5CYnmJH61QC2rVwo01inSmF+GH32/wTwnS4E/604E9I+gv4a8pNM/J/YG72EDzOus6wcVG2uOlJbCKzx4wWvzon6OcZXIKAua5MSji87fWQjmCA8u+AKRBVIUVz221sCMPPBeMTgw7JllC/kwaFHjNkMy83+WUZn6KRVsW375GIjJsG17Dil4Goba74MPD10lLVp0e0DvXZM6pnXsOqYzs2aUOhZ+8pjt2rZpzQ6rKD8lEYps1GgYPwB8EYVcRjgOEy8kSYLoclm5j3wtJcccHFnHjuOoT33X8R1q230VEyCeJpmn3qTXWTdMaNF6QVW9NMlBFbmAsgBMAwU8YCuF7dgVx1DwcACEvAGG0mDMZB3Nv96/K4VBc175ELF5fbJPQ/LipOTxqngYQeAilazl5dQYn3yaGhl5lsCLv0XzsHMK8WNBQ2wRaOALwDLyoNXuH5mWZ9sDduz1/GOHOqxn+y6bzQYgd9OHER4XcUBv0RJhwGhCzoFY+f6fNEiZZgwWBhsdaOJI+ogdWj1/djw7NI96jjVw7BmQdtiR1ZsdOrYH/UJNU2NiHhIW8LrY8ULbiYcdQbUl9nzDQy7AscKrqzpfEEyREr4iL97T+NULmChkM9/YLfKRkrpznPtpFPr8EpOEqdFd10nU2lB/K6yXfEitM6+iLBXadizPP3LUp5k/O+wPLLvfq48GVUt86rIKkXen72v9CllV+qEcldygb1dJoVsRDDxU1KfyiKpVNfhxChsJ2LdsqdJLRi702C21e2q8+LLMFFacxTAVCEq4riOUBlUnJKJU/7xvnsAodQeVEmS8gKQWJALDz7TmWIM+7IOtvnM0GPRQx67Dsn8n7585cVxbbUHgrTxIk91ilsrbgzHBX3JydsYT5sozBr2opOQyidJ4SE4/vKQ23f/4+eXvHGAn7hwIBG+xUeBb7A+w6P7Z6UtYEYl/i0MufIAJaaVP5Ar8gWX17WaDQNnjiiq7XudAj01zYFqDWaU/pljFhGmgtWZZ4N2V1XmlT7x4GKcNHu+k2HKqDtV9WqYm+eauCOkVPYlmf4BI8URvKRkHbW/29AV1NIjN+vbvXD3PmY/4lb08RFV12ibRyPOMai65JqldYoB9NtPP90H3QDFK5QNC1z3+PFJfdSc7FPxmrzGdhoQsuw71ipDWgzy1B9Gy764Kv8GTTMPdGUr1AOdmEWiLARlcMnkaQJbRwEE1EtX6C/aZn/AoWIjs8DN8cMvzhFCy3RHkMHiuTJRuEVA6BJYfpdTBvcucTN5j10BrRzKVkx+klmXsQEukKvvy0yAAB3SBK105kd7gH+uO8cnA796ZFnvg1pu23nSNN1VejzecJ3wOOYgzO7Lwud4fP7Gbad74uOah3bdNp+8a5SEmgByDGNOGI+DVA4bTYgTRQ3Z3wBamC3Q2Y+1e4M0XmoQaw+skiXDzP1EFPSwuqIdFrBsuqvPOx6sAJL6dMR80Q6N/aHKrAaAc+wTHiIVDybLDRCEuJ/iog+9y/FOdewc52nqEylp+gW6LmOLBg46Yslq7W5NOuwlrFmpxTnw9Z+EqwGsqSDZyR1NoPMZee7TcG/Z7HeewcrQcRNkXBuou5vxdXnB7QsHPpYyH3S7CCOaRkEPHdMxufhTLv3exKNS9srslN9HdxhNBGijfqwizcZVAtSrzwEFLcenXrpLZn1j9Yd8eHpodyzouV+mKJaJxkSqYsj47X6Gp8QWDZO/4GOLkcQ+0Rx8Z5AXJSWO+nxfpVKqfGzCalormIlVWtXOsJREVO+91AK3uJVCd/rKrivD6b4pVvjqwuSLcN822KLzronBdfCvfVlhfwN9+D9DWlNuacltTbmvKbU25rSm3NeW2ptzWlNua8v/HGWZbU25rym1NufUgbU25rSm3NeW2ptx60/8mb9rWlNuacltTbmvKbU25rSm3NeXH1ZRVDAXO8wgvI7lUd4/EVM7hoVu/e2TfECy5yu+zSJPgB3S04fBcdxn9Qxc1NWkyo/gzcTknNPSI+gCTPfk06qjfdgvIihMYpABAV+6epIj260W1VZVytSuq9Cm8FkI2snKwcr/Yx1DZROhHTfWJAun56/GEvM4vWxnlh5fkLHLTRXFKiMVYnJO6BaRQT8PpHOICYR7XMH9FGiaqalogyAVVKp39Pv98u3tdVqV8V/6WvL0o5k97UUyml5LdyG4cUB1qlXndZda45iYgNDhsvLtDs/mcBPf3+Frf7YAm4nFBZwE6eZ8Ggm3Qjl9xOcyamaoNY3kVTrbPM9RdFT88gR+9F2YjpuLWmkdi2v7qlwdh5HfU/DwSuelbOMWVL5sBVS+keSSi7W972Qglv4LmsVrzv3W9y0ZRLd2O88Ty2sFdLhvn0nhfTTmnC3xIOE5KJQfgKhlFA0KnqClgVTOuak7tqhWkUuRGb19PIEX4D3LyyeA= +sidebar_class_name: "get api-method" +info_path: docs/api/iiq/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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** + + +## Request + +

Query Parameters

+ +Returned all SCIM resources for this endpoint.
**LaunchedWorkflow responses include attributes from the TaskResult related to the Workflow execution.** + +
Schema
    Resources undefined[]
  • Array [
    • "}}>\""}}>
    input object
    + +A list of input attributes of the Launched Workflow. + +
    output object
    + +A list of output attributes of the Launched Workflow. + +
    \\n \\n \\n \\n\\n"}}>
    attributes undefined[]
    + +A list of attributes of the TaskResult. (From the TaskResult used to launch the Workflow). + +
  • Array [
    • \\n \\n \\n \\n\\n"}}>
  • ]
    • 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. + +
  • Array [
    • "}}>\""}}>
    input object
    + +A list of input attributes of the Launched Workflow. + +
    output object
    + +A list of output attributes of the Launched Workflow. + +
    \\n \\n \\n \\n\\n"}}>
    attributes undefined[]
    + +A list of attributes of the TaskResult. (From the TaskResult used to launch the Workflow). + +
  • Array [
    • \\n \\n \\n \\n\\n"}}>
  • ]
    • 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/docs/api/iiq/launched-workflows.tag.mdx b/docs/api/iiq/launched-workflows.tag.mdx new file mode 100644 index 000000000..f1b4497ee --- /dev/null +++ b/docs/api/iiq/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/docs/api/iiq/object-config.tag.mdx b/docs/api/iiq/object-config.tag.mdx new file mode 100644 index 000000000..db2bc7293 --- /dev/null +++ b/docs/api/iiq/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/docs/api/iiq/policy-violations.tag.mdx b/docs/api/iiq/policy-violations.tag.mdx new file mode 100644 index 000000000..d04c9b5c5 --- /dev/null +++ b/docs/api/iiq/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/docs/api/iiq/resource-types.tag.mdx b/docs/api/iiq/resource-types.tag.mdx new file mode 100644 index 000000000..386beec18 --- /dev/null +++ b/docs/api/iiq/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/docs/api/iiq/roles.tag.mdx b/docs/api/iiq/roles.tag.mdx new file mode 100644 index 000000000..05e3337cf --- /dev/null +++ b/docs/api/iiq/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/docs/api/iiq/schemas.tag.mdx b/docs/api/iiq/schemas.tag.mdx new file mode 100644 index 000000000..261d61cc6 --- /dev/null +++ b/docs/api/iiq/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/docs/api/iiq/service-provider-config-get.api.mdx b/docs/api/iiq/service-provider-config-get.api.mdx new file mode 100644 index 000000000..066ee4105 --- /dev/null +++ b/docs/api/iiq/service-provider-config-get.api.mdx @@ -0,0 +1,104 @@ +--- +id: service-provider-config-get +sidebar_label: Returns all ServiceProviderConfig resources. +hide_title: true +hide_table_of_contents: true +api: eJztWm1v2zYQ/iuEvhTIPNlNsS3whgFulrUGui1z3E9tPtDS2WYrkSpJxfYM//fdkZItW4oTdy26ACqQSqLJe3nuhccD14HKQHMrlBzGQT+4AX0nIrjW6k7EoC+VnIrZK7BBJ7B8ZoL+u+YpwW0niMFEWmRECymN58IwkHGmhLRMg821NIwnCWskgDOMynUEJmS/TDTr/ur/fy8H1moxyS0YZhUTMkryGPDJ7BxoVaakARZxySbATAaRmAqI2ULYuZvyjG8JPGOfctArlnHNU7Cgj/OCpec11Sp9NLdiUTx4PNcxrjPRHFKOHBJukR5yb4ZJmD4r133Pzs4Q1b4AO+076qZvIpH2PTH84CJx+PfPw16/keDZ2XuJxi01Qwuvg/Nejx779hw5C6JozoSXwz92FmNTpVH5ir1DJBkpaUFaosSzLBGR87LuB0Pk1oGXkd4yTT5ohWduleXJCEyeWFOX4s88nYBmalrhrkvJGsWwqwxwIX7BDDQOwJKnWUJjzzvBphMYy7UdyhiWdXbOMvS7kAg9zSHWhSs49syAZYkwNmSXjU6xI19zg6PSPSfRvB3rcjn8b7zL5KZQvbRhhS7Xmq/wU1hIPbp+3KBvyhlpv+X3Lmh0JZ6JfgrG8BkY50VvUNdRwSm4RQqj0hAV+jW+Gj7lQkNMfDJuozmpihkFH5M8+YiPqUisQyCaczmDa27MQukYB4zSlH94jrhLW/iRUx55Yt7Z959YRXmK89yst1rUwRtI9no8vmY8jjVpNkmAvR29Yc5lyNAYfGRi4+OFZUXAPDNsnqdoZPRsgy+0bg5JxvZYVtAvUK663NzazPS73UilaS6FXYXbGA1xbDfeRY4ojV2JT10UIM4j+32sFjJRPDZkOI9iXTmUjngtGQmBenC79UjDrgfjy9ckP0Z+7tM+U26pqcitJh8gsi4r7Kxm8ixDQ+BHDfLdTzsPmCiVAKfUsi/fSz/O7niSl7GyItAXc0DQtUN+uydhumNb6mEVySlPDGw2m8KNTsThajx49XVh+KJaH2Dq1HZh8w3U7gQpX/5Vimr89zVfkWPeiH/gG+JSc49DWZtSQZF66yIQa1wu0jxlcrvtbIUxx9P3i00NmM/mnnkizCAVKnwmK6wqHtg9zi+clxRZ9UQ/+X34Znw1+kzfKPfu/4UfWJ0XbnBvSTE8zQEa6g40CW/afZvs0nNmOdjjTjSPX41u4Zc/pdTVmMHdBn8iBrSGMEebPnn9myubUwEpubLBHjlfJroqplD4IZwklqcH+3axoIabm9pYNVMhg8z3VfOnHGC07GcG4Szs+FLsJTciOl457eZR9bPHsA5U5bss2BslOc6yGcjclMnhNRZzXiR2Y7mMuUaTkz+jUf5T5dnIGMvPwtrRIwtNrDMXi0VINX2o9KyrpxH9nf/4/KfQLq3D8YtVy/fJnNPR4duUyJ7H4aGn3qg44hyAiZ9iQtEM/HbP8/JlAlxjMKiPQCFCgk+cg/r3WOCZyVLQ7JSrLXMJAI+DvCLoNir3gy1RXryHVSL73NtBKDewsMlfiEcyV8b2L3oXvSrCdBrs3p13m9s/G9dCcHTHj0K9PDX6XFbEKOEQc8sxmTkI9kW8h3P5r7PXZiBxv3uo13CsLNh1Gh7oV23rgIe6DT/0er7hcPS4dFi6PL0eQD28DtpFj2rYtC2EtoXQthDaFkLbQmhbCG0LoW0htC2EtoXQthDaFkLbQmhbCF+rhVAiOVd0F2bmrr3gIQnPSME9QmOk4jhouhmzxtNzcgIONYWGxZTh3/7E7EkzdAggKRjmB+Ze0DCD6yEmilviH+UaFzkBnO9QGOHXbfXXyo5QmbNFmEQOil6D22t8kkQ0hJyqhoJnJ+no6mbMrsp7PlQJ6SlHo/xWDVd30ied3GUTwsvTuQhfUCAL66xzqL8jjYq6syoCiQfn3Y5RXEh53JWiQ6jXu9sp7UWlJ3VRqXBYC0vbzRIuJDmHi7t1EapHbqhRNNKE9Zpi6q1ONhsadlpTxKBrci1of3LxgwuAx3T2wdD6CCvayqIIMkoLrpajNtXh1SaKum0KeXU1xij6Fx8jEwQ= +sidebar_class_name: "get api-method" +info_path: docs/api/iiq/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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** + + +## Request + +
+ +Returned all SCIM resources for this endpoint. + +
Schema
    Resources undefined[]
  • Array [
    • patch objectrequired
    + +A complex type that specifies PATCH configuration options. + +
    etag objectrequired
    + +A complex type that specifies ETAG configuration options. + +
    bulk objectrequired
    + +A complex type that specifies ETAG configuration options. + +
    filter objectrequired
    + +A complex type that specifies FILTER options. + +
    changePassword objectrequired
    + +A complex type that specifies change password options. + +
    sort objectrequired
    + +A complex type that specifies sort result options. + +
    authenticationSchemes objectrequired
    + +A complex type that specifies supported Authentication Scheme properties. + +
    meta object
  • ]
Schema
    Resources undefined[]
    + +The SCIM resources returned for this endpoint. + +
  • Array [
    • patch objectrequired
    + +A complex type that specifies PATCH configuration options. + +
    etag objectrequired
    + +A complex type that specifies ETAG configuration options. + +
    bulk objectrequired
    + +A complex type that specifies ETAG configuration options. + +
    filter objectrequired
    + +A complex type that specifies FILTER options. + +
    changePassword objectrequired
    + +A complex type that specifies change password options. + +
    sort objectrequired
    + +A complex type that specifies sort result options. + +
    authenticationSchemes objectrequired
    + +A complex type that specifies supported Authentication Scheme properties. + +
    meta object
  • ]
\ No newline at end of file diff --git a/docs/api/iiq/service-provider-config.tag.mdx b/docs/api/iiq/service-provider-config.tag.mdx new file mode 100644 index 000000000..b195c7498 --- /dev/null +++ b/docs/api/iiq/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/docs/api/iiq/sidebar.js b/docs/api/iiq/sidebar.js new file mode 100644 index 000000000..0fb58ff05 --- /dev/null +++ b/docs/api/iiq/sidebar.js @@ -0,0 +1 @@ +module.exports = [{"type":"doc","id":"api/iiq/identityiq-scim-rest-api"},{"type":"category","label":"Accounts","link":{"type":"doc","id":"api/iiq/accounts"},"items":[{"type":"doc","id":"api/iiq/get-accounts","label":"Returns all Account resources.","className":"api-method get"},{"type":"doc","id":"api/iiq/create-account","label":"Creates an Account.","className":"api-method post"},{"type":"doc","id":"api/iiq/get-account-by-id","label":"Returns an Account resource based on id.","className":"api-method get"},{"type":"doc","id":"api/iiq/update-account","label":"Updates an existing Account.","className":"api-method put"},{"type":"doc","id":"api/iiq/delete-account","label":"Deletes an existing Account.","className":"api-method delete"}]},{"type":"category","label":"Alerts","link":{"type":"doc","id":"api/iiq/alerts"},"items":[{"type":"doc","id":"api/iiq/get-alerts","label":"Returns all Alert resources.","className":"api-method get"},{"type":"doc","id":"api/iiq/create-alert","label":"Creates a new Alert.","className":"api-method post"},{"type":"doc","id":"api/iiq/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/iiq/applications"},"items":[{"type":"doc","id":"api/iiq/get-applications","label":"Returns all Application resources.","className":"api-method get"},{"type":"doc","id":"api/iiq/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/iiq/checked-policy-violations"},"items":[{"type":"doc","id":"api/iiq/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/iiq/entitlements"},"items":[{"type":"doc","id":"api/iiq/get-entitlements","label":"Returns all Entitlement resources.","className":"api-method get"},{"type":"doc","id":"api/iiq/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/iiq/launched-workflows"},"items":[{"type":"doc","id":"api/iiq/launched-workflows-get","label":"Returns all LaunchedWorkflow resources.","className":"api-method get"},{"type":"doc","id":"api/iiq/launch-workflow","label":"Endpoint used to launch a Workflow.","className":"api-method post"},{"type":"doc","id":"api/iiq/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/iiq/object-config"},"items":[{"type":"doc","id":"api/iiq/get-object-configs","label":"Returns all object of type ObjectConfig.","className":"api-method get"},{"type":"doc","id":"api/iiq/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/iiq/policy-violations"},"items":[{"type":"doc","id":"api/iiq/get-policy-violations","label":"Returns all PolicyViolation resources.","className":"api-method get"},{"type":"doc","id":"api/iiq/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/iiq/resource-types"},"items":[{"type":"doc","id":"api/iiq/get-resource-types","label":"Returns all ResourceType resources.","className":"api-method get"},{"type":"doc","id":"api/iiq/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/iiq/roles"},"items":[{"type":"doc","id":"api/iiq/get-roles","label":"Returns all Role resources.","className":"api-method get"},{"type":"doc","id":"api/iiq/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/iiq/schemas"},"items":[{"type":"doc","id":"api/iiq/get-schemas","label":"Returns all Schema resources.","className":"api-method get"},{"type":"doc","id":"api/iiq/get-schema-by-id","label":"Returns a Schema based on id.","className":"api-method get"}]},{"type":"category","label":"ServiceProviderConfig","link":{"type":"doc","id":"api/iiq/service-provider-config"},"items":[{"type":"doc","id":"api/iiq/service-provider-config-get","label":"Returns all ServiceProviderConfig resources.","className":"api-method get"}]},{"type":"category","label":"TaskResults","link":{"type":"doc","id":"api/iiq/task-results"},"items":[{"type":"doc","id":"api/iiq/task-results-get","label":"Returns all TaskResult resources.","className":"api-method get"},{"type":"doc","id":"api/iiq/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/iiq/users"},"items":[{"type":"doc","id":"api/iiq/get-users","label":"Returns all User resources.","className":"api-method get"},{"type":"doc","id":"api/iiq/create-user","label":"Creates a User.","className":"api-method post"},{"type":"doc","id":"api/iiq/get-user-by-id","label":"Returns a User resource based on id.","className":"api-method get"},{"type":"doc","id":"api/iiq/update-user","label":"Updates an existing User.","className":"api-method put"},{"type":"doc","id":"api/iiq/delete-user","label":"Deletes an existing User.","className":"api-method delete"}]},{"type":"category","label":"Workflows","link":{"type":"doc","id":"api/iiq/workflows"},"items":[{"type":"doc","id":"api/iiq/workflows-get","label":"Returns all Workflow resources.","className":"api-method get"},{"type":"doc","id":"api/iiq/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/docs/api/iiq/task-results-get.api.mdx b/docs/api/iiq/task-results-get.api.mdx new file mode 100644 index 000000000..d4bf89197 --- /dev/null +++ b/docs/api/iiq/task-results-get.api.mdx @@ -0,0 +1,56 @@ +--- +id: task-results-get +sidebar_label: Returns all TaskResult resources. +hide_title: true +hide_table_of_contents: true +api: eJztWltz27YS/isYvqRVdaFkKZE5Z86M6qStZ3I7kjJ9iP0AkZCMhiIZAIztevzfuwvwAokUJdnpmU5HfohNEtj9sHds9sGJEyao4nF0GTieM6fyy5TJNFTyV6actqPoSjreZ/uDc912AiZ9wRPch7tuuCQsCpKYR4oIplIRSULDkJTb4LWMU+Ez2SX/WQjS+6/59yqaKCX4IlVMEhUTHvlhGjD4TdQNw11JHElGfBqRBSMyYT5fchaQW65u9JIXtCDwgnxNmbgnCRV0zRQTzbzYneG1FPH6YG7ZpmByONc57JP+DVtT4BBSBfSAuyUbLr2rqENaLRCcx5laepqW9KTP157ZCg+Uh1rEXr/reuX2VusqAlUV7FFhDw5HzWhg8C2CL/C45CF8h2dD0vEeHHWf4BcJh4lW8IXd0XUS4ivcQ9hXcuVMgjWP5GS1Qp5XjvO4bQCTMIxvJVnGIhOFYQQ24PuxCIAyHnj6y0Xn1cvhsE1mzMed5Kw77A66A9IhUay0wRTmCHsFSC1NkliAwLrAtP5MYRx/SZOf79/jY83JFnEcMooCCtiSgrgcb0lDyayjKpGyyplarR8+fJxffng/eftjqwWQFZ4BlxK+1KZgKVDLCpwgoVKCdkFaitGAxJWFvOEkEk768/2B2glpGsGyYKcykJoWvLFr9FyyuCe0cMQXIOLChptRfRDBHrMpZOtQ6UMowLePNl7EmL3fBvwajRYsDJzy9oYqEiM3FDayLrDzqAGjokJdRgG7qwMJHsNWGn8Bp+9akPsVEVqIUHyaPMqSI4tcqwYYkUztBubHaaQOxDSyIbmuW0E1y6KRARWl6wWICcDkEgLXAQNcsd1wSn0faGV+jH8g/5miKpVty2RqLI/A+jXtSIaxCMNcyKVCiHQj7poMsR3iu0Tnka1YiiEAIgkDTqQaettgIyQR8Tce5LYu0RULfj/IH5HjIobwfcshwGRay3hvrFswpGHANUWcKowDpakgDrxmSx5xFFib3MRSPV2KO7NXFxLJLLalIDGhYYiFnJaj77ZaziOk8nyXROwD18Vfm4CmmUR0gJ5dXL4rc7kO+cpO/104sR+DdYPdAyWaJCH3dUTv/SGR3IMlKtAcKFdxw1zFioZ5kVFB8d6294x7rqsqDCxddnqa02+j2K2oUeE2b3J7zR0dX2umSy5qq4WSfKU+aESH4ShL+VVcWvwzU0ukMjt5ofiSLhWCoslyxdayapV2aP7s1FYdNOHemkkJAUV6Ayg43sJZpxkn5xooTHM9WPQrfDdVzIPqkT5F/Csm1QBMBsUnqmnTOliNW71auvjTH7uDcT9Yvhrrv3z3bDAauOORj6c1rluxKYwVR3KDMkiwFfgl+W1KJqm6iQWH2Mi/MeRj9lWsCd4ezcfXySNnh4Qe25WAXJ+Lbd4XxQ5ittQDYZBP0BZmqQ8axYj2OxWRIfhGiBhNdK6TIoYk/bBOzIdrG3a+H7BmJYqoyuNt9uVYmciEYimKxHXsrBD+LTaR8hiiUJaoWEK4Fd/ANcPYpyEyAMMFycsaH/yYfTmWUXbqgAwwFCidBHThBYlBrJi6CGkdu7n+SPTXY1l+RI1JmRmPYfO+1hUyLtseQQ7iMnlHLgTTDkxDcgHhn0LxJDTP0mYqPH8J6crc+QLMEcyE8I17ESn3WxjKmn67hi8E+1R+FoGDGBZ1eI0jQmxeU6yJA2DWUVxfUKp5JidBXsOyOd8Vkkp5D9zBoOMOO/3hvO96w5E3eNnt94cdd+RB/i6jxLNQFTSeBcs9H5ew2F3Cze3uGbhKIkcCG3Xcs3n/pTd0vTO4dr7ql8DA8XXifgYsQ8L/zsAgdWJ4ghychXFWe4eowik3WorUaDYsfgPOaKQ56kvajK+iD8tlXTjauHtky4mE9TGs38Fjd7Uz0HHJrov3p7TtIFXu3SfwPckbdmFtFaThAcVCvvIJMRltiqwpiiOika+ZWxerCutJ3RWgie2eMuwLu69XbEGewJLmY+hqXTsPDdO6hLJBTi9qJnjmPMJP28mLzpqyIRNCvuI4EVgF7ydIKKj6P/FSo+sVTAvg4HRBpe49mmrAI/3zQRcu491+dzCColfDU/Y1L178wXy8bmxK2BesPucVoeH2hkXb3aFbCjc1s7NOVrWhaGf8HXqjYXd8ZqUFrG1yD9uqwadvdXfrCDO+USrxej1dL2Ex5o3dsdszVby65197eIvofRv0rNZx75BSHeoc9S4OioC8Q36ge0tyuIms9S5zxmfIzx3N+yNvNPDOQO/98400IWvFZwHJ1jTL7sr5/crpvxyen4/67vkQlGS6qvndcl57i8jvW0RZ1wk0RzRcIlNtic2MS6CO9jXrnrnlNvuuh/ua0ugsj8ah7R4A7v3pezUC6v53werfNLcARq576gJ87y5AVXxb/aLdHZvDs9epiXBqIpyaCKcmwqmJcGoinJoIpybCqYlwaiKcmginJsKpifCvbSJkPg3+hlOKKz2amID7wYNtGvDW+JwZgUtFeISNVTLEZbbk8n/mFmtIE/Ru5E1oFBD9Bxj95ONlV49TSOankA7uNQBYyn3MEPB0bX/Vd3fj5NaaQn4I2ckEqytHXOOgDHi0jKtKtZBO38zm5E0+i3kJyUEsKaj7deyna0zmOsPh7RvPpAcHC4t0xt0z1DxXWs/b59ek4aC6pgBBrqm24mwqZrpv7HNbvg/lnMhpgvQfMUGaWZ9id6qXhNTckbUTPWTeVhkENjfoz87DA7rFJxE+PuJrMzGFLhBwSRchBuFs6nKnDfw/hkh3nFGXMuV0bFaMOHoC7PAD/H0To42wtwZgnwj+iVOjjciKgdYnYjp8MHQvjHyC9flIDhsIbQZkj6s+EdHhw6CNUPIB1adazb9r4rNRVBvDs3+zvL7DbGfjWWpHWMszXeOD4HgoXblAnIfghE3Yz9m9DzvLLLEtpzLpiVSKku3XN3OoX/4C5U5P1w== +sidebar_class_name: "get api-method" +info_path: docs/api/iiq/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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** + + +## Request + +

Query Parameters

+ +Returned all SCIM resources for this endpoint. + +
Schema
    Resources undefined[]
  • Array [
    • attributes undefined[]
    + +A list of attributes of the TaskResult. + +
  • Array [
  • ]
    • meta object
  • ]
Schema
    Resources undefined[]
    + +The SCIM resources returned for this endpoint. + +
  • Array [
    • attributes undefined[]
    + +A list of attributes of the TaskResult. + +
  • Array [
  • ]
    • meta object
  • ]
\ No newline at end of file diff --git a/docs/api/iiq/task-results.tag.mdx b/docs/api/iiq/task-results.tag.mdx new file mode 100644 index 000000000..8e6e9005b --- /dev/null +++ b/docs/api/iiq/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/docs/api/iiq/update-account.api.mdx b/docs/api/iiq/update-account.api.mdx new file mode 100644 index 000000000..4fff58720 --- /dev/null +++ b/docs/api/iiq/update-account.api.mdx @@ -0,0 +1,79 @@ +--- +id: update-account +sidebar_label: Updates an existing Account. +hide_title: true +hide_table_of_contents: true +api: eJztW1tv4zYW/itcPbVZ3+MkrrAo4M5kARfNbJoL+jDJAyXRNju6DUklYxj+73sOSV1syY4z6bRoIQcIdCEPz/18R6LWTpIyQRVP4lnguE6WBlSxqe8nWaycjqPoQjruR8dekc5jxwmY9AVPcQ7MuFsywuIgTXisSCZZQFRCDBlCY2InEsFkkgmf9QhOEOxzxgWMTekqTGhA5pyFgSQBS4EWSWKiYJSfCJiWJnHA4wWZpmnIfc1qDzhLqaARU0wgf2snhhPghprlQJaOw5G9lKolHEt/ySLquGtHrVIcKJUAonCHfaFRGuIl/8K/gJ9/weYXFwwPLxjDIzqcD8bjsbNpkp0Du3PNrhUVmcvlc1wlMrbprA0znzMmVnA7Z1YBE16mmDySw4DLNKSrDzC9Q33Fn1idpymoLYpoVzLUkAIdh1wq5LFcDk0kmMpETLhRtdGz1ObhkmhGSaFiIjPwErAtTGVf/DALWDAtqHWITEgqkieu7YTkJMwr1/tOfo8reolakmcehrhaFqp87a1xHkMahjkW9Jx9uquz8Rfo0DJB5iKJdtR4cptUVSCJT+M4USBfocHeibN5NL7CpPopCVbI+bbrdBw/iRWDWIRbtIyAvvR59O/fJbK7rsgNZgBLKQ7qgDMewEyuduh+dJ5omLHmUN6OuXsJxk+835mvGrx8ezGIffFBG2fdGCaGFYL226Gll0GC+632ExUemKL3MwPtxtpipR2bV7QDqBeyty1KykWN4mrLzaxws1+tnJDOBJkn4pUL+gMKSWfiYQYasosfJkPMQGN2XslAgs2b5b2/meUi3r6bXRUZFw5SOEa2bHQez9BSqdTt98PEp+EykcqdDCaDPueftf/1n0Z9pCH7LzO+AdYr/vvVHlmpAsc65ps9Zafy7FfXVeJ/qo4evtlnjl76T3ado/l62YMqpI51pJhi3p5VsltdppzTLOaQX6s6plImPtdp/ZlDSUK5DEVS8VBbCTUwIXDAoyhT6CKH5aVDb+SfHpWgGlwNSmnG9SraEywJXWrioIsZVr42ZfFYKhr7+9KyvVvVz048fZ0eIgiFWb70BuGalM+JCJrZyO/W1KEBJeAEXzBtMFCKv6TxYtcfcwKW26LuIsfPgivWTeJwBYA0MAgkZk8gqccKpIGL0LJ+H5QNmLpVIokX18/BcHT6L5TPzyBLxer6oJh20D9AXCDicqbmrsaI0sVgdg0MgRPKQ90PuMPewK3Et3urR7jT6+tfZu+md7P/fSAfpleXroXtda1da1jJbIyaeKmWALWkqlIhNCpTqJJcUyDn7mpbHo3wikIUYK9i6wmoIPNBTcy2I2gx25HUlq4aRScPDQx7//FE/0f979Ko0SXkbSo7OblabZWWk5Ncay5ZkwfQG9BVETD74LhwPrt7cDalXY1scE6DgCMBGl5XqqRpUxwLiGtm+G9IF6haDkXYx85O65jmOoauIMaUoB0WkpY+rjiVlyQho3HVq+yCUBc+sYZoeXFBM7FHpnFxNYJMCS6exeYe8VZEMmVL11aUAOE5DSXrEDhFZE4sNK/PpGYk0VVcexcwfoRom84WvimQ+DYKqpWybxZZj8jRSf+kbRfadqFtF9p2oW0X2nahbRfadqFtF9p2oW0X2nah3i4YnkzEa2A0Ggzqmr/Xb/p0PLAvXGolFB4O+cRkEGncv4K59rzWePmNxgvQqAHeHUJB3vjsfELHcwANZxN/fDrGN37BcO6p4dm5pwviQdjQ9j9t//Mn9T9tq9O2Om2r87dvdeIsDBERZ02lTLvc/ez9q6rYev4D/ubz7nwwGHTBF7yud04ZHp0GwbkfnLNg08LwFoa3MPxF0SIaZzQMV+/QO0NMha8Vc0klMMVikpMynq5p5Vue7mdHMQOkLjGRhww9RH4NJ0nM0LxRInCbXkGrsjPpOItTqW7YHAJ2WefiPayseFQpihaFmCSGc+GWnmzLeBnqTakNxkQU0oqDrUUXKTuWhTsqFkxNFwvBFnuA0QFmNCNKkwBT0JLKLrg4nqmIKVrn4QquwjDaCB3qMMw+vjkgi9ZYgT2ewa52zpGcVsvFaDAadQej7nB4Nxi6p2N3MO4NLsbdwZkLDZ6J7gOgM7+by1YV601gx+4w7R/TlKElr5IAq/JhtbFtrWkPiOzEN+tuMHHHZ73J+XmpuyfAIXtVZ2/u9Yr96vvtwRmej0Etw9F4DMZ6cAxqNXPv9LymFQvhkfThJfI9vxpG2gLXTNTehKTzlIRPZVLbJw8VguKjCq5YJOubMzcVLj6+CqIUu5TfVqR3e5PthyBaHxDmywT3R6cZrqc3FbtO6bPrYt8xFm8Ao0/5vuRMhPvd38L0Mgqc3TdalV5Iq9eQJh7FramA0PERiz6AIjC9hqqCO0ol8zOh4T8wAEO5P82Q4Y+P1btaepOAKmMK6yDLjvUEXRtwjIPKwGc0N+Wm1cvceNsvkMvnG7tPI3YagF1kXvSFL3dutnH7A/vuete9xWq9jf0m3L6y8au3fXmz9aKqyx5o+xVM9Q1M/Yl+w/uLpkHfrN2oYF6zSToHpBat8HieHHyucHN5e0cu868WZrFiYk4hTb5P/CwqIAOiAoy6B+2UeWZ3Jj1UrIZSDRGqSUMo6rdYYF1AgciK3bZ+4HFpbzf41+VD0r/sKwubDBT7ovrgRzw2bWSon8zqLFj5NqTjuEUexJfz6Nw4YL3GfHUvws0GL5ud/Jib8qbDcQ2w3y//P+yrhj2K/cR07FY/acizi/4Q4o/X15u/YDgoSeNHGqVEj3giOIr0Snf47sa69vdk7zc4jXzlkCReVTkpNF947+YR2y9GAyY0a+b+O8NAVwOucn7zdxloMDMNmGKp2jPBjH2sYIzr+zsY69nvQQCt4hRBn7GAwH/XeYA/OEm0YnQB19fXAIvjRUYXON6Qxd//AZCNrxU= +sidebar_class_name: "put api-method" +info_path: docs/api/iiq/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Query Parameters

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 objectrequired
    + +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"} + +

    Example: urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:**My Application1**:account: { \"department\": \"IT\"}","type":"object","additionalProperties":true}} collapsible={false} discriminator={false}>

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 objectrequired
    + +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"} + +

    Example: urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:**My Application1**:account: { \"department\": \"IT\"}","type":"object","additionalProperties":true}} collapsible={false} discriminator={false}>
+ +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"} + +

    Example: urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:**My Application1**:account: { \"department\": \"IT\"}","type":"object","additionalProperties":true}} collapsible={false} discriminator={false}>
    meta
    + +Metadata of the SCIM resource. + +
\ No newline at end of file diff --git a/docs/api/iiq/update-user.api.mdx b/docs/api/iiq/update-user.api.mdx new file mode 100644 index 000000000..d9ad9a23a --- /dev/null +++ b/docs/api/iiq/update-user.api.mdx @@ -0,0 +1,143 @@ +--- +id: update-user +sidebar_label: Updates an existing User. +hide_title: true +hide_table_of_contents: true +api: eJztXY1y27gRfhUMp3N2VFmWHdny6Zq28k/nlIkvqe302ok9HYiEJCQkwSNIOzqPZ/oafb0+SXcBkAQlUpId3801ZTLJSCSwWCx2v/0BRN47ImIxTbgIR54zcNLIowl7L1nstJ2ETqUz+ODgV+nctB2PSTfmEbaGtlczRljoRYKHCUkl80giiCZAKMFOJGZSpLHLOgQax3AZ/yVJzMdpwiQJaPwJulFJtmKWpHEIX0Toz8l4Dl1/SplMttpEpu4M27RasfCZbLXa5G7G4VqQyoSMGYliccs9TSiicULEhCTAXKtVjNVqEaAXz7EBDVgCzPGQiNiDD8A2UOGh66dIBa5jb+A9EqFknT+M490/qv/IKOsyETF5wyfMnbs+I2e3LEwk0pnRW5ih6zKpvkYxu+UilWTkQQuezMkt9WFabRBQyO7yy8PYnXHoKcYfmZsQLokbM5AjTCn0iASiSrjIFoiXjqlUIoV2E2iWglThYy5AFJ/HJjT1E9W/5YrU91qGuZDwIKIwitDzFLegAL5PQA9gVgENXZYJ8PJkdG5WtENGiq9QJIR9joBLGAqlgO0ygtgLeZ/RcMqMWKEDdxkd+6xNYCVQui6wL2ENUSM4Um0rNuEC3BPhhE9hRt6yfFF7cHyPRaB3cCmbwrKYi4VvqxZKnKC22cxqBO+lMQ+nsDjWzNVqGK5wGh1ynIu3XUksH6yOHAuRkAdLKIjHJX55ApcWUTPLifB9caeGzOYPwg5xGSTLpXU5lwkLTrIp6QEV5UGh6q3WN37yHQwPJvOJzV9dO9LlwVXMp1MWX4Y0kjORyGtHKzTcnlBfsmvnm2nyXasF4JHbGULIvRPCF8QXQAUAmrbDEUEimszgs3RnLKDO4N5J5hG2kglOEO6wzzSIfLzk9t0+/HH7bNLvM/zYZww/0b1Jt9frOQ9V8MQ9FOUCFI0mgAy+EJ/S6Hj+A/AF2ACLghIClW21kjhlCDJKl5FFCzNg1mBKmUCNSbZaOC1DySwdjtmBGSCMcdBmZ4BkH9r3euYKi+C2EUuhrivEsTTDIehlENAdyZBBNEifS2WGFsYCjxpbl3BNA8giKsoUgADAHLqyzxoRh5YxSWHgFrUMyUnoV4y3LV8ouxcgtTsOqAKjIQyZsUvtxgxpZMDfceqEs8zGLyEkMwqZxCJYkFPrUgQlvwU2hTgEWpDx1mnVsm9rWhXjYwFejYa2titbwokokDHfK2ZmumobBKYpYiMsYsBD4JIXmphrv14UYBy5AlmkETqLTH1hmQAaqDIabalkW9OG9VuwhC3dYOtFh1yyJNHqUKFPaCOg+Xpgl0IvxZUmG6W+j34kk3lGdHEw7UqSzCeCKyh4Vm5DMooYCUxkPim3dxvTzrSEW60BQTjbvd3fVcHNbqt1LtxPHfzSav2pDA+vNCA4DzfanCEqORbeHJewbN1tB/xEApiJt2gU+dxV6LqLY/3+o8RVu7cUAAwJbC3hoNDwLZsQfi4v9PuQ/4RroLzBhJvwI0cZcjWPYCTfn+dRmAdMuQlcoCk0g14ueh4DV9DnFlxyFjYBgTMK0ZTSk/P3l1dZJIQxigh3WBAlloqohTPYYXGkOsIapZpX6sYCQyAVIibAjXZAGoul6V5yUsagdOzgIXTWO4N8rdDcw0qZIfqD4YMFq9DBQuX//OvfErSD+gR7dsg7IwYMR+cZVn7E0FK5VNBQ1VBrnQRWwFlrnjJUU2FTgpop0/FOPqs20as0J+fDfywR5qHHYdwU+Mj5tDEmlRnCApYqXLZIy0raiLrKvSn4vaUxp1nYlKFsW3e6/P7t+zenKG8ttXEJzXG6EGNzIFKeXqgxwlN6DT1m4k7HLVUTKFwl3IYB9KKWdT4nXb2AufDbRidVaAPXAu55vmYUQx+e+MwEkTKdTPhnGB6XK8LRQAq4FsUs0Hgg6op8Ol+jZqCoxzQeAwyR1+Q1A2cQtsloNEK1m9CA+/Nqg1W8q/taZJb2qYV7Q0EJDOCSQMCXHwFUGCyhD9qf0qlycfWMaVaQiymEhWE9E+p2NQ9/4fGXMWEk4zw8oGfS8qznZJkHmfJERb7WeihHHHo7aYYSpmOhS2WbtAiacMLo8zoEyZc1lyQOeaXaV7GPlMrsG+ybZ5YTM1+BvZxx8KksuWPM5FfxlIb8Zx1no4ra4WE9hwC7vpgzhrxBcgULuczZkByXIgDLNEtoRz2ICCDqwWD/FtELckZpDV8RguhoFSJ0Ke8g5a2WCg6wJVU+B/FVKLkiDxkbJOHsc0Ky3kt4j74DPaWn3RX6DZk59gA4URGZhCwTBKwy1hBIA1JmBE2uqNIllWBhMq20QMQ64kV3Ax3ZZ5g2NjGs1nKkwpOQ3SpFyuESTYMWkeDSgoGEwJdzXy7L5wyvg+Q96I3pbuayU+2y8xCogGJwgiJER85/hpEhLFPJmnHWmZdqE9aZdiCV/qg0989mwTqAsXb0lt0++/vw/N2bs87J2/MOOckGwIjBjK9cI0jkUxvQHIEWNVR5HGu2NI4pRrQc8ka5HLkk1WZjTIbZgiDb9lhqnBer7QDbo5wVt8ujnJSEVhqriq72Asq8oGUVJHReLwkWhwc3EtB4/mgbNP0I2ymxphQgu1dooSaxhca3pUMq8GFgTRCIAUTHKsaHZD102WrrdZACIjMCWxwOOEsmAxVOywEGowMdhMIXYEoV8AZ7ne5AhVRLy+vSiI65z7PviwtQ3AUDlnwaZsUqMLAFnFtSpGVzyqfw4drRlYphgV4ivnZuFCLa16rBqdQtw+6Ld0OEiMyqhq4r0jCpwidVhzRBPHopO5tS3gDaALXdY4HhZU5yOcZZ6xoz32d7tCXmkfHUAFzGPTXcr/Z0YkwuA4jlVhhRUSrJq355whizCNE0zDX6+VhzuxTrOLQ/6ff6vZ53tNdn/d7E3dt/ebjvHvbfIsu/i9mkxvtcjJ6T5eEmLM+SJBrs7voCEGcGMdPgqHvU3eX8p91yPrluajpqkmKS3EF4/jfownV2uDzNrBG51a0sVVbKt5rhfuel9lLRqMKJn5kgA1cfbFe4XCXYJvRftt+KAfbG+/Slq+ouFRM41e435XKW5Q/aEW5E2w1f5erbFukrk7lKHC1m01qR6XvFKGirFjStHnQYsBhs3hrk7V3IakBGUb+bCSLuQmniQDM2TTQDuVpuY2Mse/kinErDxyOw4rQCJ8xoAjlcPa3Xgj0SBzan7XbHvYPDI9qbgJIfHLm9lz0sznp7k3Gyd3A4rrdjtGG4wWJmbTvYAxd1nGeyy3Wcol0imaRWu7K7T9SvS7hAI3DmjjXSo1TMYmAzJTPM6CL/lytdPv4GqvF49/MY6hpmj8a4K7DH+t8izMLCskNrV2ATxTOVsfLQz65663hF1TvFMnUSmCLiwlrk956oehfKsCD+f5tt+iqUc4FrF6hWaeAJFgb0Tbk0qu0vnhblfXBOTrp70Pb0tLvv3MCtj2Ks6jnLrLwGVVK3TFmjJsasmPcI2cd5D1OPJ+SchnSKxcO14TEksZjWinCgJAABu2SDfStSXnCneSMtpUtFBhIvESaUG+sN9OiLG0VlmzSNloc4L/dOK3s/2qLNcM9tyhuRdSFKetnDUImBXRx+21U7eweTAwBlCJf69TZ8sWi/mWif2XDXMvigM61iN+BDUc2/wTut3VZT+m9K/03pvyn9N6X/pvTflP6b0n9T+m9K/03pvyn9N6X/pvTflP6b0n9T+m9K/03pvyn9N6X/pvTflP6/ltK/vqdrCGp99rvdCkTSP+JaqlqojFwXJKRG/Exlan5osO43BrwiEMx+ZDb6q7V8GwRoGzj+/6t9jZNmI6PZyGg2MpqNjGYj47e1kdGU6Zsy/ddWpl+YoQe5jU7vLOdVHcrVVAJM1bbCTC45clxUVktPKDCVU7KtnocRfnpBLkwAjsq1uYI+rVK+YRG887xF8M3r20+pTjyyvP08lWtDZrNKBUJqqOIVrEdUAat1t6SFoBzF5mqWFuntFj7JnviCv0rP48atQp+3Fn9avrl2rVh2bc+GSYvx1RKdxiKNgrGK3Y1mbq62G4/yPfOjUyYVuNYguOXWLbJk2/rSJu/wiQASaxngmxK3swbPi+bKbxfp5fqoaFg01gUamylFicn1VfhTzI2AlA4blGbWA4NpsDzcHUTP2mz0AwZWD3ryw6tyPNV++/7VFeUR4/hpKDndeUddyAzd9unJK9MRPxr38xzWvLFmrLdo2wY32pLCQgU+Xqmi1oKXa+x4yXZ/8zaOs1ktXHyEBj7eSM37SRa+fgwV7e+Q0dVmto0Eyfboqk2OUW4Qn2xkyTzRJpTVppZKPzoSgtXVWTDua+NIaDpZrw4ZZjVm8PGnRjZrLNj0+CL80M+HKphy1Q7iWkMeqjzjn6eqXCQgHtwERCqiigVx/I8hyXoNXA8hSv83xY7f4kmRmMtPly5ut1XsbQSRkDACuYBGRLXKn1+2wA8eV5uqB+Ll4+7tHwB9Ls/ravWLOUfls3nsHZWKgnndg4GaMzDNGZjmDExzBqY5A9OcgWnOwDRnYJozMM0ZmCedgQH7ozK5YBNY6VmFvGFyCQ/qSr/YF3UIO6/3anlZH0867CDZr+EMTnXvRyOK+YXKL3QUZ010mO+w/cJHdh4Xsz6Oq+c9z9N2ApbQisWHq/j47cJRFwC58LsJ/aTSFTZVdltYYTB9NjQee/b73f39ne7+zt7eVXdv8LI36PY63X5vp3sw6HadzR16xbR+jZBDw9C58PDYzWqZsbLIFAQFpuMXC657NOgddI4ODwvB3a7KTBYSks3E9uO1s3fYA4ns7fd6sEjXjg60i02z6sHK5pKUN9dqCowmy9JgWpNd6ZuEh7fCvy0efl8a7qm+7bH7mmu8AdZoCvT/Itdx8/BQWPpM4JsPolSFhvhE8oFjdPcek+SR9wA3MPfKnmWexn69AZjTdIUdOIvPbbYO3Ckxa9IEH+qvHnuM+/vqA3j44btRRz14WDI3jaGTYgCacneYIqsfbuy7yuNpCLLa5KuELDtGI1SFCds4KAY8OHhRPNv4LFtE+9kE1pG14sSadfppxVmj8lGj7OxP6ehPcRZn4STO4jkX+5hLccKkOGCin8Rc/HrVsg5zEORDLhB1dCF3o6sOGFjnC8zW/c2TNu7LddIV9cuqIl9ZLHkgUExgfUkp887PWMqpKOSouktedsmKJLpGUl/WKKoaRRViuQhREkKR1ttCWONxniCDDXxY7mOtFLcqw91wEVdkSk9cw9V5op15VWZK5URpIXOxE5cV+caXRft2VL5eiutCvcdLcYPgEV9sMRErD1lfnF1ekbPsvTlKVhMKPv1UuGmQJ1mYUKF3uEbAy8MQ50jZVS7oBU+iSIPLUMehYCYgMGTFvIig7pR5Z9FD3RfHy5uX/DQv+Wle8lNFrHnJT5EV4BM/dgGPuT6FjOHxvQmls7eHtZ2BDqbRVyDK4q37e1Ty97H/8ICX9YtTMDwz8vKsV6HU4NNX9g6cGpHC4jgLbwnK/Jx678zzy+uLX4ezciaVr/R58oya1+D8mq/BWbmwCy87Kpb0Br/EHNf0kRa+fWF+W/eCFHXNhcDjV32lV+X0s/pIOLennYnFQN8DVvhnoFkqgr43N0/0VHdUSlt0rn6BENqG7jaEACRKajrotjdWfePd+ytoOzYvLgqEh11ieocZFvw/cK7hL3wRkQ73oZG6fu9kP6WBNpos/vkv1riI5Q== +sidebar_class_name: "put api-method" +info_path: docs/api/iiq/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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">** + +## Request + +

Path Parameters

Query Parameters


    **Example**: scim/v2/Users/**Mock.User**?**lookupByName=true**"}}>

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. + +
  • Array [
  • ]
    • 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. + +

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. + +
  • Array [
  • ]
    • 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. + +
  • Array [
  • ]
    • 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. + +
  • Array [
  • ]
    • entitlements undefined[]
    + +Entitlements of the User. Returned in response only if requested using the 'attributes' query parameter. + +
  • Array [
  • ]
    • roles undefined[]
    + +Roles of the User. Returned only if requested. Returned in response only if requested using the 'attributes' query parameter. + +
  • Array [
  • ]
    • 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/docs/api/iiq/users.tag.mdx b/docs/api/iiq/users.tag.mdx new file mode 100644 index 000000000..a6d0e6713 --- /dev/null +++ b/docs/api/iiq/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/docs/api/iiq/workflows-get.api.mdx b/docs/api/iiq/workflows-get.api.mdx new file mode 100644 index 000000000..f2c50398b --- /dev/null +++ b/docs/api/iiq/workflows-get.api.mdx @@ -0,0 +1,48 @@ +--- +id: workflows-get +sidebar_label: Returns all Workflow resources. +hide_title: true +hide_table_of_contents: true +api: eJztWW1v2zYQ/iuEvrTzEll27CYVhgFu0m0B0pfZ7vah6QdaomKukqiQVFIjyH/fHSVRsuWoTtYNw+agaGKKvHvu7eHJd+eIjEmquUjPQ8d3fhfycxSLW/Uz086Bo+mVcvyP9bLz6cAJmQokz/AMnJgvuSIsDTPBU00k07lMFaFxTKpDsKhELgOmXPLDQpL+j8X/l+lEa8kXuWaKaEF4GsR5yOA30UuGpzKRKkYCmpIFIypjAY84C8kt10uz5Rm1Ap6R65zJFcmopAnTTK7rIpvK2JdCWSRFsrO68lA42VXtZTqHcypYsoSChphqkAfarWu48olFeEh6PfCez5mOfCNR+SrgiV8IgA+Ux8bP/sD1/EpIr3eZQqwsBIzYncMxOAYcPEvhCXyMeAzP4XMh0PHvHL3K8IkCg9IreMK+0CSLcQnPEHZNLp0zQd5LccMVRBx2kZ+ETNSl49xv5sIkxhwhkZClWwqFkA5BIGSIZ8H46U+nh8cvRqMDMmMBniRH7sgdukNySFKhTe7YrISzEjyYZ5mQ4DwXlG63LRbic569Wr3Fj1ssXAgRM4qOCllE81g7fkRjxRoma5mzlk293vN37+fn795OLr7r9QCyRhtwK+GRSQtbHMS4DMoho0pBoHmqNKMhEev7CO8wQ4GZr1aPCNGDUUBJxuNFcoPFiixWhNpyfAa+tYncjeidDL+SN9apDlUB0MEmVIRYLrcAn2HWJjyFyrxdUk0EakMvo2qLnacdGDWV+jwN2ZdtIKFg2JXBb/EMxg3Igy5E6D4jHn3JUUUVzwIYUUw/DCwQeaqfhMnzvBasWclJBao0TxbgJ0BTuQiKBnLvij2Mpw74X0sxEogkoYeKIesgqcVcaYRC11i2uA42Gd0l5tLYYE4scuAKBppIm2gPIBlIhiwUVkmtsNqsvufqO9S4EEDWtxwopAxPqXtt34KhjAJcF6e0YTzCawfEPH+y7x68oVy4JmaiabvCSwupE+6tCrPb6zn3cFtXpxQiHnoe/loHNC39YIh3dnr+pr6wDZXr5g3vgp2BgOSFtAZJNMtiHhim7v+hUNxdw0EQLwip5oVyLTSNp0WqtlG8bWZzqb2K0HYYD1eSMzhAvzdYoaVu3lXWRj0WtgmNS063tgS1+FYT0IkO6aa80du4jP9nRcOQq9J0G/laLpWSYqZyzRLVTsb7hr6PztamgmbcT5hSwBfKH0I/cQG2TktNzieQMK0C0ZDf0ivZdc4lC1GPKRvIufW487Bt5oeUX+MNGkIeoUvl5iXZMHVLfR1HHv4MTrzhySCMjk/MX4vo5fHx2BtGR2h/UcOtNEPSeJSuc4NRr8gULGVQqZMMeYgR++B0SVNwYqvUN3Wf1Z8eB+EyJfhjcjZfgHaICd4BcFeGkt+U98GpZEAnhKYh+ZCF+KdFeFu1KK4VBcUE/0IeRUzCLpRQMOWD9jZUL1hAITtNTZYSqdlFY1Ltgd9hjlVMMYeTuo22O4HR0YY1AdgtYgeeFxbAtty0BTyuDoJzwIqmHU1gOY/Dwh1GacpwmWIraigE+DHkmi7iGoY1APxmnADNG0849uqVj6mmwDxQ2FCPCxp8Nh0gyMpimh4guGBZCilfHmriqsi7xgjgMVOKaLdoCVZ3yg24/LHiXlEdLNe6c3iI9BHmMaifgClXacJMD1IvT6EVJhPovW8Mc8OzNzQFHoAD1ZUCa3V+C2neXYqtdvn1TSHXLlzwiAWrIF47XKRic2XKIiC0JSxdnL6x6VZ+3DAFl6bsCphJVvrfC7hxVuQ3LiwkY88bEbLYMO3M+hq3Qzgh/UNyjgEMWIaQJ7DR/K7MJbNVGiB11UXXkALhghIPUXorYr8UDx5X0PZFzgUWdmcaZFAZVmdLkagWrpNmqyEWf8Ark7PJsIGp/C00ewbLcw6Md1tVt30JuaVQaMW5bqxDbzg89EaHg9F84PmjkT964Y7GR4fe2IduAjDGomgAtrD89KIqld38stQ68/t9lBgvhdL+iXfi9XmZIvy6jzdX/2bYt+9c/V2ugpgqDelh7u4OJ0EIrXvwCEnMmcK6XZw0hn/zwdgfD/0jzx0MXtZOQmLb6iOrsdzRref3S2fwYvTy5XjgnbyAKBRv4VXLMt/KKdU1bvrRKk8xsQyvATFhTn1FbQnSua9+DtZaPwzL99+q/2t/b9Ro1bvbvrHn7Tu/b935td238ZKwU5u+bxz3jeO+cdw3jvvGcd847hvH/2/jaHpHELIUOG+8MmPGjOolfKiDg1+zMnlTzbJyGT8ixs7mN64VU5z/WnQuhWggZPwKFu4WJHDzB6Tc5P25a743VSzIJdILAoCtPJjkiPLjp+ZT068VtdTYY8sOIVdfGZshFO5x0AM8jUTb4w2k09ezOXldzVUNB0UUYnEmghx52eSWuZzQJjMBtKninLhHGBau1xqRyn4jGgzFDMjAkQk16VV+6T3tHuFueveu/jp4Pwv+t8yCy/TT7IvuQ6/BTeNgquiuLLaNmT7WEy7e3WFVfJDx/T0uF/MQrICQK2x+Qjs1fTAJ/okh8AMWfmYAtp5ymx4QFsx8Z3cD/qaJbyfmjen1E5E/cfLbicwOpJ+Iaffh7ldhVFPov45kt6FuN6DmyPmJiHaf53ZCqYbMT82a/9Ywt9NVa/Pvv9lf32CA22nL1ul0bdMn/CA5GmW6FiB5oCZ8EwE6LyRMgvK1pjrVGueiFNus/fx6Dr3Lnx9vNzQ= +sidebar_class_name: "get api-method" +info_path: docs/api/iiq/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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** + + +## Request + +

Query Parameters

+ +Returned all SCIM resources for this endpoint. + +
Schema
    Resources undefined[]
  • Array [
    • meta object
  • ]
Schema
    Resources undefined[]
    + +The SCIM resources returned for this endpoint. + +
  • Array [
    • meta object
  • ]
\ No newline at end of file diff --git a/docs/api/iiq/workflows.tag.mdx b/docs/api/iiq/workflows.tag.mdx new file mode 100644 index 000000000..f1c44e4b7 --- /dev/null +++ b/docs/api/iiq/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 diff --git a/docs/api/nerm/v1/create-approval-action.api.mdx b/docs/api/nerm/v1/create-approval-action.api.mdx new file mode 100644 index 000000000..3817e942a --- /dev/null +++ b/docs/api/nerm/v1/create-approval-action.api.mdx @@ -0,0 +1,47 @@ +--- +id: create-approval-action +sidebar_label: Create an approval action +hide_title: true +hide_table_of_contents: true +api: eJztWG1v2zYQ/iuEPrWAYztvaxdgwNwiAzysTZC424fMMGjpZDGRSI2k7BiG/3vvSEmRLTtzhnwohiRAIpHH43Nvz5FaBSoHza1QchgFF0GogVsY5LlWc54OQpoIOkEEJtQid28XwWcnxLhkvBRk3El22SgBFqs0VQshZ8wUea60pUc1vYfQGrYQacokQMSsYlNgfsOI8diCZjYRptTF8KmafLdIRJgwroFZ4ZbOwCYoPxecLZR+iHHDiV83EdF7dtQaRStjpTPQptOa0yqFHcP1kolUVsQidG6aQMZF2pauXLFvXgM5oFbgXGVgl4uywtimaxDEhmNKx6ksTwHD8G5wPTSl0B6NiJ8twTJBSzKQqLXDCpT9NnzfxfBaPjPBxV1QYS53MsG4E2j4pwBjP6loGVys3KvQgLlidQGdIFSoTVqaQg+kpZN694YyZRWYMEFz6ckuc8Dc8ZBwT/QWOhjDaWh2y1svWCCihrCxGu1GYQocR1RBUaBApwV7M6Epa2vbbfOldPkUUiVnBl1P7oJHTo7Ehaencf/DSRQdHZ9Oz47OjuH46CPw/tHxT/EJP/95ev4h/Bist7Zro31CF/PU7ITXGGEq3gVyE9mNV/lUobFWGZascnWDsdcMM4azmVZFThppiMrTYp0xk0NIGc+oNLpkQc5n8Gq+JmU7/WwSVaQR0yAj0P/N1VyHiZhDE+lUoRXc81jMi9Tu8fNwp1+JiCql5DN04QYypwo3Ng8iz/mUhl5x51rrc1uXHjcTJIWsrMbXQVBpxpwode/HgUCssC5YWw1k7X4Ip8mRVnwFn/T79G8TxuUjZh6RXiVKbMcZqhIRK6koeGOdN9b50VgniiZleuJ5gZuJWkjQz9fhLpxlGdaqKmzY8HELOicZJ+DUVyFBX8cihc0T1YYdtBWidCePCbfow2lhX+7ZvXlSq2TGKlLjcLntCDcWc31CeT6BDvV3aYlX7WuzNINrzZe7UAsLmXnWXguPtlU3zr4NS+AwW+6Ce5XISMGvM3fgQ/7E6XsuYXNsjDtKWEyM5bY4AOBBAUGFzCussd76188Jl7N/iQLR9hw6bCh5+XQl2R/A6WkEOhOSMuyt2/4g3favUs1Wtz3b1WA/8YjdeHbBW1IhnbFIHNV1ovuS7qokXMWY6e22WUEbSte6f6el685+uT9Jym1zqbXSJliPvRHnu4wYIj4tsb3cgp4jD7o1aI4GW2hJiSPRNEz0KMUXeAzBrTQvMu75kwDQlm1kA5YhQ1Cj8ePTmgudfLPIbpXWS2ZUhldZklpQuBcaO34ZQbSe5hTdy3Plzj05twm+9bYOLqZX3z6rmxtWiPONceEpdIrLEmtzc9HrrdABXNqvPIN1V2IQEZFaAhAdoSaBi+dcC0oNz0e1uDe4zOyAhxmEqvV5YOTEmUR5bFdGzKS/7Yd4r0VrNZk3JnxhoYVdOoBTwMu9HhRk3t24OX1LAfE4mkJ1fMgostaJUQk6IRzxD79V3DlSD0B3Z/z7y1IV2j8G5GWK/c3TNfeyCtHOA+LGEfCwfrXtoFc9JTUOSYeieSLtkpwaZFqOtDmuZh0hY0WOoOTy9hx3+91+o5i/Xt58YYPrYTszsBCqSRZyOuGSbS47eBjSKQFrlmUqEvGSUQ4q7FgIA+OFs0xI5kIHci6wUAgYOQCLGPCqQKCkS9Lgy3DkIktlk3HZmNn77Wob7OqJKd4+eP3vPnh57qDzVC9PuaDm5ElyVXLs3XbtE6W2WBZ5KiFmRvHVasoNfNPpek3DyCaaqG38xKWO2XAB8IiuBsh6D7Ck7PJ5djQiUCSeFu4gu92dqH/6FYOQOtqzsuNG87i+uh0RIZaf8LC8aI3mCzpL4t+L4G/8xRfl26T7zkfjqyDFw2KB/IIyXi/9fAcSB9L/ +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 approval action' (create-approval-action)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create an approval action

+ + + + + +Create an approval action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_performers, workflow_action_roles, workflow_action_performer_notification_email, workflow_action_approval_email, workflow_action_rejection_email. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). + +## Request + +

Body

required
    workflow_action object
+ +Expected response to a valid request + +
Schema
    workflow_action object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/create-ask-security-question-action.api.mdx b/docs/api/nerm/v1/create-ask-security-question-action.api.mdx new file mode 100644 index 000000000..d09f1dda8 --- /dev/null +++ b/docs/api/nerm/v1/create-ask-security-question-action.api.mdx @@ -0,0 +1,47 @@ +--- +id: create-ask-security-question-action +sidebar_label: Create ask security question action +hide_title: true +hide_table_of_contents: true +api: eJztWNtu4zYQ/RVCz04cJ7vdNkCBZhcp4KJ7aeK2D6lh0NLIZiKRKknFMQz/e8+QkuNbEu82QF+aAIlEDodnbodDLRJTkZVeGd3PkvMktSQ9Xbi7a0prq/z8t5ocz16k/DfpJBm51KoqvJ0nH4K8kFpIdydcs0j83awSsl3m5cQl5zfJzNi7vDCzZsYlw05iKci/N9k8OV+EV2UJcLytqZOkRnvSnqdkVRUqDXC7t44RLBKXTqmU/OTnFQGTGd9S6rFnZdk4r8jxbLvzqMF0+AKVrQk7b5WeQDg3tpRAldQ1BDo7sDcdNZiSWNnu118iHDGmwuiJE94cQxk9yLIqeL+zs/zk3WmWHfXOxm+O3vSod/Q9yZOj3nf5qXz7w/jtu/T7ZLm13S7al9GtjQiT78O4CeyLNWXlg1ztyAI40sDN8ORMSQKORIBksZsU7pjx6rockx2ZfLQaX8OtEPIJ2XU3Y+js9CBLomo2YqX6EaabmrrIWqh1BWsLM1GbxvUA0Js70iN6qFSsj9dCF/SKR73Cq5I6IjXGZkqjmpyYKT8V2/uPePMXUY4ixJcTgOAlLki4wzquaznnf8EXQnpPCC4PyGLGM8PDTMGmB5iymUhhZ5gibTpV97RebGNjCpKRdnJZF/B0Lgu349f+3nwVyolWqTBWaOM3dg6qluxE5QOSp3lvGX7Yiw4Z4yJBnJ6c8L9NKJcPFcgEG7aioTDEvSwUj4WMTP4ntVcmtb1Z8S2sdhVVCgTFGgRN5KA5sIXBShsZBJkkxcSaumKNPNSkuRQOsVe5SoVF3gaaq+SEXs3XrGyvnxtSs6Qzst/maplloyY9QcvSjcxMg+KercV9OJtSXKlqsY3h0yxDXchIxkF9GxL4OldFKBXIxSYk27CDtwJKFIUqRqAnq8a1/3rPPpknK5XCecNqAq6wHeNGMTsBtS8n0KH+biyJqmn97JPWyvk+1Aqk7J6119OD36mbYN+GJXSYLTfJrZnqzNBPE159nJoS07dS0+bYkI9zmo2cl74+AOBBAYFCERWusF7H1w9TqScvRIFp+x5HUV/L5umzFr+S5KcB2TKcTtl/eOp0EnenqkqOC3rVnVdan9u6cb8bIXplcwq9DoJWM7iw0X3Qwftno2brtH2z74B9LzNxFdlFHIlaB2NBHNgPyn1okQ4+XY2mzzkyfffYbKH1dTi6f+Gly87Tcn+wVNjm0lqDlmo5jEa83WdEH/gsd8fXZO/Bg2ENzLHka6s5cTRMQ6JnBV7oIaWqaZ1frXUg3nIX2YUowRB80MTx8YoLg/x6kV0ba+eh2/dTlppxuGcWJ34TQVjPc4ZvlpUJfU8l/RRv3a3GxXVxfxy1V4XVlaCdxUIXHOVCrGpbQMfU+8qdd7sLeENq/0mWtDzWiCjgmTkRc1NXVgqL76VVnCeRnFbi0fomzROZlpSanSvuIIgLDXmcXU5NODycbzVOihJHJOwcMr6IPQAck7RkL2q29Wa4Pn3N0Yk41oVWwWKj2NogxvUYhDASH35uiXQQWu/QWP84RwsfHxN2OSfC1eOV+rKN195ucaMfPOzw2nbQv7kIPnEP7O27fu0ZbG477eXlkctXDKN0bthOzp0It3d8cnyyVrifLq8+iosv/d3Aw6B2UqSSu1k2MARfpil3BKhPUZpM5XPBKWZwOoH8EA7MCtyjQmRI3ysUBZMhG4yCJVwLGJQOOZh87A9C4LhESqnXZtrPK89/W9nqklf88BVfZ6Ib+XTuVoVUTHWxyhZNxd5sJ0/w97M1i6yfctFj7WIxlo5+t8VyycMQtVwow8fKDHWCBSQz7jpRQ3c0ZxOiMUcDRsjiRR16pG3iY2qOKy5SJstnZYdrvPTl8/WAy6v5+IRo8horZ9ym4O958hd+8WKq1UeKML5ICvQhNZgSMlEv//wD0LjJow== +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 ask security question action' (create-ask-security-question-action)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create ask security question action

+ + + + + +Create an ask security question action + +## Request + +

Body

required
    workflow_action object
+ +Expected response to a valid request + +
Schema
    workflow_action object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/create-auto-assign-action.api.mdx b/docs/api/nerm/v1/create-auto-assign-action.api.mdx new file mode 100644 index 000000000..907aa21b4 --- /dev/null +++ b/docs/api/nerm/v1/create-auto-assign-action.api.mdx @@ -0,0 +1,47 @@ +--- +id: create-auto-assign-action +sidebar_label: Create an auto assign action +hide_title: true +hide_table_of_contents: true +api: eJztWFtv2zYU/iuEnlbAsZNe1i7AgKVFBnhYL0jc7SEzDFo6splIpEZSdgzD/33fISXHt6RJEWAvTYtEIg/J79y+c6hlYiqy0iuj+1lymqSWpKez2psz59REn6U8lXSSjFxqVRXeTpMPQUxILSREhQyyQgbhrhhMSeSmKMxc6YlwdVUZ6/nRjK8p9U7MVVEITZQJLB6TiKdmQuaerPBT5Zq9BJ7ayZ/mU5VOhbQkvApLJ+SnkJ8pKebG3uQ4cBTXjVT2QhztjVpTkAv4HB3CVdbOb+LJzTaaBq0pq4Kg/k9nX/quEbpnR228WJAXipeUpLFrR9SQ/dp/0YVZvZy45PQqaZE2J7lk2Eks/VuT8+9NtkhOl+FVWYKXvK2pk6QGu2nPU7KqCpUGL/auHXtombh0SqXkJ7+oCD6LkHBmZdnnsKHj2R0bPWGByjaEnbfQG8IwRymBKqlrCHT2YG8HEofKWne/+dKYfEyF0RMH07O56FayIbHw1av8+O3LLDs6eTV+ffT6hE6O3pE8Pjr5OX8p3/wyfvM2fZesdo7bR/ttdBsjwuSHMG4D49yBAeCOolg0mYEghrOsGmPOsi4xqmDXXBXUZZzSplM1o02Tjg3CVcbky2VdwKi5LNweyv5BVJw67aYCIYpI3AIatlrFMGqQjaT39mk+PQiIzaay1lobBwg+gB8pZM2WUXJrShCKCSndWkZAt4NJHGiAkwsGNqkK2dqaNcZtJ77gf4v2ewIIBvLKrx27RYqr8MPWcBVSNmbHy+Nj/rNtkPPbCogAsRVlrFLMZKEy0aR58iOjnzmj743Np6b0RdxSwCnWwGnbsQo2t5xgUkysqSvekYe4ynmUK+Hge5WrVHDghlyv5ISezda82UE7u6mpCw4vnZH9PlPLLBs14UlgBzcyc032YYo6hLNhqPVWLTYUUxzBhd8FgbB965KGA7ZbhC09+CigRFKoYrSmlidb9t44uWMrB4riss64wnGMG8m8rv4PB9Bj7d1oEreOudmoIa2Vi0OolafSPaivp1u/lzdBvy1N6HG6XCXXZqozQ79NeHUXzRCmr6Wm7bEhTtQ0Hzkvff0IgI9yCDYUccM11sv4+mEq9eRblRljM+qIvpbN02ct/iTJTwOypdIcYf9rMXY3qqrkmIee8eT1rg8d3ZjfjeC9sqlCz4Og3Rlc2Ox9P46Nevt3s81OtX19qMC+l5m4iOyCtr/WQVkQR9uqd59SXY2mzzkifb9sttD6OpTuP3jpqnO/3F8sFY45txZNTrIaRiXeHFKiD3xWo7xckp2BB8MaqGPJ11Zz4GiohkDPCrzQbUphpXuScg93AsRH7iM7EyUYggtNHB+vuTDIbybZpbF2IZwpcTdjqTm7e25R8RsPQnueM3zbrEzoeyrpp3jr7TQurseXy1FsodsxiLtgHhc8VNsCK6feV+6011vCBlL7T7KkVVfDjwBlFkTMSD1ZKSyeSas4OiIlrcWjzk1wJzItKTV7t95BEBca8k1jH7vOFNdGKGxZwyHjS2ur/CIAHBM6VYveERpeDTenL9knEcem0NpFrBRrG8Q4C4MQRuLD7y19DswN8dUUv39dmNrGx9C6svsv7m6R562XDvaIW13g40rWroG+5+6zybYNq+xfSR7frSudG9aGIySCOuked483kvLT+cVHgZv7vnsR0O2kSCV3qtzJBRfLNOVqj9wTpclUvhAcSKbm24WD0TErlBbB/qRnCgHPRMfqIRkJLT+D0iHSko/9QcDK4V9KvTHz0HeVXbzLu6T/8T3m2b7HxNzjlqRXFVIxv0eSWTY0dbWbO0xJh4gKqT5lfsOK5XIsHX21xWrFw0hIy+wwvKOjQA5YQDLjBhvEcUMLdmx08dGAcbF4UYd2cJfjuQrFFWcp14UHZYcbFPzl8+WAOaX5yITg5jVWzrkjw+/T5B/8w4uJxSZ8ieLxZVKg5apRFCAT9+Wf/wCoeB8B +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 auto assign action' (create-auto-assign-action)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create an auto assign action

+ + + + + +Create an auto assign action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_roles. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). + +## Request + +

Body

required
    workflow_action object
+ +Expected response to a valid request + +
Schema
    workflow_action object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/create-automated-workflow.api.mdx b/docs/api/nerm/v1/create-automated-workflow.api.mdx new file mode 100644 index 000000000..79b610996 --- /dev/null +++ b/docs/api/nerm/v1/create-automated-workflow.api.mdx @@ -0,0 +1,51 @@ +--- +id: create-automated-workflow +sidebar_label: Create an automated workflow +hide_title: true +hide_table_of_contents: true +api: eJzFWW1PIzkS/itWf07ICzADaGdXzMHpcrplRiTcfpiLWk63O/FMd7vPdgMRyn/fqnK/OS8EdldaEMEul11PlavKZeclUIXQ3EqVT+LgKoi04FZcl1Zl8D/+TekfSaqegl4QCxNpWSAn8P2D+BjPGa952VPLbPnSBFffgppkgnkv0OL/pTD2s4rXwdULdaUWINXqUvSCSOVW5BaHeFGkMiJUg+8GBb4EJlqJjGPLrgsBENTiu4gsCCs06mClMDjaoDjKCb1EpiJErlDGnQnGapkvYUKiNOgGlLIEht4OZt8os5Vg1aIMV2IWCDUeJpIEUJgTWEY886xIUdLpaTL8OI7j/uh0cdY/G4lR/0LwYX/0IRnz88vF+cfoItj0ABG3pdkHUeRlhqa+zfkiFQjyRhrXnB8D/NtKAETNlGa5sj5caZhwS+JwXK3po69lAsByvwGPGwwmMpV4sn0h2TrExUFGzjPxfiF3MGtbwraAhr4hP4wlzg11mQoTcgtyFqUVXfNzrfkaVpFWZOa4q6VqCf6chi7YlH5tI6/vbqD35f749qH5yM9AuwY1Q9S+Be+l+XEPVKddVnAtIajeBOYnaP8Mf58+wcdCQDwI1DqP0jIWv0CTLwwELbUSK/TbQNeSWWnAvRZr2pvXNPjZ3xhn5QMx24pPeGp25D88TG4Y6MHcIsxyvRR2DwwfQRRdnJ2Jy8v+5cXlef/sNB72L+PRx/5F8mH4YTEenV8s+F6QDt67Yc6qfX0fyhtM3rW/Ut4QyMn1OnzkaflHgDzgFqG9rMxEmGiMptaJfPGVg4Bci77/Z8Tei0ILdC1D+sZ8bdAcnEHAFUrz9A0g/qhsdFGayxYCJlSSwAx8yWVu7CF5SseiG00SDrQlUDrnCJBOx8cRTChdaThg4S8rUytBFsWFqUEwlbf5rAfskLClMxbhgBanlL6mRTQc1dK31Aj36YB31vHfpI5e8NWdbJPY76Oj+pTbZ2ms8WlTOr8q2lQYA3o2juqzHiDfKGHulKXFq5FJDP4h7Ro4gCVfEvkvy5q+vpvNZt9CW0Zw29CcoU8yTcGHiICO9CTtyhPyrbH8rjXbTFKxdIqxvVncJendo6Y6UapoCNAmwWaO+oDxSNXdem9DP2hKU6jcuFNsPBziP98Kt88FJCgIjpqVWQVhCtIk0qjkC/6G6u6tBR2Pv+Tp2rnK4Tomk/l/RL60q+DqdAxd/tzt7qxSw3xTWblpSmOh3z/hWARD/sYMdCeqyrTp8yiCOKTufNNrquG32e2VwteLAONCfX8kMLQZu3buAIUkHTMPRYw3i/bm4GF7Sw122GoHUZs/Dfszt9HKR328ZueFDKudDPGswyqqAEiPVMdzwLDMXdPisWdhdmhVCAtrG3Zq2euH2b/609n17GE68rtjv3vqd8/87rnf/eB3P/rdC797iSghjYQd1Au0SYi5KsXaBbPASkRoyBBMFsalywMQrzCSKuNYuuyq1JgAedztiWfIJF0ChAHEJyzUoZXkRuipjRQwtVGps23CpbssJWUKDuDaMn+UlvJSvRtpzIsQN0TGxJELNHeOIAClWgsRuhtzvE128h3ZykRSswDcqL3bZJ52SWS2zImtib7+29TGDtsDXXtsjzV2aQYQPwZES6pssgUGbdHpOrWi7bl1qBqRVlm5GmiPgpbyKMmeNcEFTBiteL4UHh0KrBiXjkRc6u4QRNTSlVg1pVUQ2cGqFHE1LHLAxiXbAVMBFu5Q+N42XZ51bcRLTaPAL7Yil6ISYHbi0lOI5u1qUubdkHnikqIcdqqzTnOc1CvNvatJEzEbyhS7t9XmiARHopKCp1+9w9JPUJvO6jAGftZegukufkWayYjhGMYYWHyHZTgajM4H4+F42LG/s/IOb1X9MLyr42lbVbzhO6b1pnTVYR5ttpLaJ1WlCC0DOejAwngq7oB5z7waTUtwUNqFN90CrK67qsq4Kb/O9lVcn3nM7p3vsT4r6Q0Gi67aD07eU27BLeJL0i1EG1+psU1yquX+jVM3vcN8/0UuEnOrtdKGakxU4nyfEhPAp8EP2VToR7AJzQF1tLClzvHRKQfVwN1jfIESz5GgmeZdyr1eIQoUuYvsmmWwC3wJl06iL/Dgx2uV4+9G3lRpvWZGZQLKBywPABV70gpjqN5CHFPoG4Vy2Y9j1RgMmlJh0Lyghm35gDd3tIuhrSl1ClNW1hbmajB4AeV5btGLNidw6NRnzgk4wABKCqr1tUS3cMHdsDtlEw4ejfVTlIGT7hZzxM7wsY3VmYncq4TslUGuBbXm9LIAJ4pdE8CFgDumhmsEqPZt3h2e4mY4HF2mZm9QKdSW2Og2jUz02ISNf9Yl3Ez9EDnAgM9PazjLXDNAC+O+37dvy7dt6ureFnZee9/29tqWcZ0XVhfs1cNk/S7pvSO+/oz4N1/7ZJ4oNAn6l9vz0cnwZNiJ5bvb+1/Z9dfJ3kq/HmQRz7E4pkc8vPTRhYJByLJMxTJZM3RDVRq8GsKWwSiTOaPdE1BqQZxgiYERDTEs4OqIoCpj/jqZ0eZi1GQ874wc+erBw/vS5oqjX1k4a+OJNihSLnN61cbAe6litvt1hit2t6MW/H6FUQ6sLy8LbsSDTjcbJIN3agyVeRubFCkwAe6O+GoEPvFDrBGnQ9xHn+js306mw1zsZlxHmB1f5Z13EtHXL9MZBlj1PQzsFc7RHK2An1fB/+AXOsqlXPqyhlMQpVB+lJAagcetiz+/A7mmOmo= +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 automated workflow' (create-automated-workflow)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create an automated workflow

+ + + + + +Create an automated workflow + +## Request + +

Body

required
    workflow object
    condition_rules_attributes object[]
    + +The ProfileTypeRule this workflow will be working with. + +
  • Array [
    • `, `==`, `before`, `include?`, `absent?`, `after`]"} schema={{"type":"string","enum":["<",">","==","before","include?","absent?","after"],"required":true,"description":"The operator used by the condition rule.","example":">"}}>
  • ]
+ +Expected response to a valid request + +
Schema
    workflow object
    = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
    attributes object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/create-batch-update-action.api.mdx b/docs/api/nerm/v1/create-batch-update-action.api.mdx new file mode 100644 index 000000000..74b3075cf --- /dev/null +++ b/docs/api/nerm/v1/create-batch-update-action.api.mdx @@ -0,0 +1,47 @@ +--- +id: create-batch-update-action +sidebar_label: Create a batch update action +hide_title: true +hide_table_of_contents: true +api: eJztWG1v4zYM/iuCP+etb7tbgAFrDx2QYfeCNrd96IKAselYrS15ktw0CPLfR0q2L2/XpocC+7Ie0LMlinxIPiTlriJdogEntRol0TCKDYLDK3Bx9rVM6PEy5r2oEyVoYyNL/zaMPng5AWLGoqLysgIaYQdzGw3vooU2D2muF/WOjSadyOA/FVp3pZNlNFz5V2mQjDtTYSeKtXKoHG9BWeYy9uD695btriIbZ1gAP7lliYREz+4xdmSzNOyKk2h5t7E8rTEdf0AmG8LWGanmJJxqUwChiqqKBDp7sLfDM85QtL67zZcAR8ww12puhdM9UoZPUJQ52zs7SwfvTpOke3I2O++en+BJ9z3CoHvyU3oKFz/PLt7F76P1jrl9tC+j21gROj2EcRtYYINtM05nKH6pzGltIV0mIM8FOAIwq1gu1nlOYcZEJBWD2rLQYxfAxJl8xM1oz7TOEQLbUqhyincKud1zYHQQsJAEr1YqtBFKuy0fvKo1WXbSeZ/2ab72Pxw/WxJdAzNOBwP+bxvC9VMZ3GtEKZUUnEfIJa95ikf/s/mN2XyQDT9C55ugUlBSjKakidToQgBRJkMjKku/iEEg5kZXJWvkpYbpwlLuZSpjYYivnswlzPHNYs3KDsbZZrrKmV4qQfNjoYYkmdb0RDMFO9ULheb5GjyEsy7BVlWDbUYxTRKqC7BewKtvUlJ3DC4VkguzJtnyg00RSioKmU/bdvLqyH6XJ61KYZ1u+5I3x7ipmK0gtS8T6Nh4154E1aE2azfAGFgeQi0dFvZZfx0+ub268f5teYLH+XIX3etMJRp/nfPpXqwL2r4HhdtrE7KocDG1Dlx1BMCjEkIKRVDYYr0Nrx8yUPMXssBt+xE7YqSgfvqsxB8I/DRGU0jFDPsPp00nsg+yLGHGS29oudX6nOk6/HZK2SvqKfQ2CBrN1Atr3UcN3L9qNTvT9vzQgL2CRNyE7iK6olLeWWocZI+UO+y9ZrpqhZ9TYvr+2GygjZQf3b/z0XXn+3J/spQ3c22MNjZaT4ITF4ecGBE+o2i83KJ5pD7oz5A7Bl1lFBNHkWtE9CSnF3yK0Z+0r3Lu+ZsAssl9ZJeioA7Bgyasz9pe6OU3i+xWG7MUVhfoMpZacLoXhiZ+nUHynvc0f0CU2t97SnAZvfV3Li6272+P0/C90CySvPXxsT5FlcnpaOZcaYf9/oqCAMp9ggLXPUWJJFR6icgtqQ+lpMOPYCTTI/SkVjw4XbM7grjAWO99yIy9uFAkTyPLyjlnhWlW0YAoaDKSexPGF9M11i09wBmCQXNZsYt3k83tW05KwLEp1OaInWJvvRiXoReilfDwW9M/x/oBFcGg378sdWXCY8SR5vzffPuEum7SdPCSuHUNPG5m7QbojS/+m5247Q9SpZrhMgWC1ZPeoDfYKLtP1zcfxeWX0X7+SHuzKWLguyjf1XwOIY55nlN1iUInMl0KZoqm2UKti6JKu0Iq4QOM6lESpbmVMUgqN6RLPYNSnkrRx9HYx58JXoDa2HnhW3jnctuW9Yvf0IEyPEr7ZQ6S+1KojVVdXne7KedKOlhgRNGMC5OOrFYzsPjV5Os1LxORDLN68q2MPKnpAELCN0Mi/AMuGW9A3h0zMBbPK3+P2W1O3D7DicuYG9qzspON3vHl8+2YPaj/MkA54zMGFnyVoN/D6G/6Ry86dEn/5wNeX0U53RUq6mYkE/Tyz7/uKeJG +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 batch update action' (create-batch-update-action)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create a batch update action

+ + + + + +Create a batch update action + +## Request + +

Body

required
    workflow_action object
+ +Expected response to a valid request + +
Schema
    workflow_action object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/create-batch-workflow.api.mdx b/docs/api/nerm/v1/create-batch-workflow.api.mdx new file mode 100644 index 000000000..d755b2ee9 --- /dev/null +++ b/docs/api/nerm/v1/create-batch-workflow.api.mdx @@ -0,0 +1,47 @@ +--- +id: create-batch-workflow +sidebar_label: Create a batch workflow +hide_title: true +hide_table_of_contents: true +api: eJzFWFlv4zYQ/iuEnu34SLKHgT44bYqm6O4GsdN92BoCLVE2dyVSJSknhuH/3hlSB2k7F4qiCZCQwyHn49zULpIlU9RwKW7SaBIlilHDrqhJ1l+l+pHl8iHqRSnTieIlcgHPz5aHULJENvLQ8Rm60tHkW9SQdLToRYr9XTFtrmS6jSY7O+WKgTCjKtaLEikMEwaXaFnmPLFgBt81ytpFOlmzguLIbEsG0uXyO0sMCCsVQjecaVxtUbzICbOM5yxGrpin3gZtFBcr2JBJVVCAFFUVMPSOMIf6mK8ZqQ8leBIxQGjwEJZlgEKfwTHskRZljpLOz7Ph+3Ga9kfny4v+xYiN+h8YHfZH77Ixvfy4vHyffIj2PUBETaVPQWSiKlDV14Iuc4Ygf+HaDRcvAf66ZgBREamIkCaEyzVh7khcTuszQ/SNTABYnVbgywqDjURmgexQSLGN8XCQIWjB3i7kM+w6lHAooKWDFGk36pf9h+Z5XJv7WcsgKPQlmmuGNgnh3WvQMPjZQRCFfoJHALSiyg0HQlyH0n8g1tJ4RhpRpBF1jAd+INK5sUoMM8V+71YV0yXo0ulnPBzivxDH9WMJugUsDSsxEjLKhuY8bWRH/0NyeG0+oOkXkW9bCz0RBgUXfzCxMutocj6GKX30p0enNDBflZX2bWZl6u0bHOvTXgR+omD6mdWe3s5pkjCt7XSx77XJ9HV6eyZvriHxtEkIPEcDD3ngeU6WLn7hRJib9RlBnZGpcwfIQ9Z178sUa1JXeAJsfsBQpegWsHDDipOBdKS1J1Hrfw37KozC16V8WvImE8Qao6OHwaHkxpYBChhWwg0N3BFwi1VsZAwHKxN7qXB6P/+tP5tP5/ezUTgdh9PzcHoRTi/D6btw+j6cfginHxFlBeA81DYzxYnElGMsBaI8QUXGoLI4rVwegHiFlVxqx+Kzy0qBGWKa+jP2CJnEJ0AYQHzCQR6tsm6EntpKAVVrmTvdZpS7WptVOTiAG3Ox4cbmpcYaeUpLLBEbnloOwVDdAkEASrllLHZ9VnpIdvId2fCM22EJuPH2zsg090lWbYUT2xDD+x9SWz0cLvj6OFxr9dIuIH4MiI5U6+QADOrCm7prJYd7m1DVLK+zcr3QlYKOsuFWnw3BBUycrKlYsYAuoTnAoxOWVspfgoharWxCayjdBZEdtGojroFlHbB1yW5B14CZKwrfu6HLs26MeO1QS/CLg8i1UQkwvbgMLmT3Hd+kEn7IPFBuoxws5Z3TlpPmpIXf/nQRs7eZQvFlZdjJ/gcciaPBaH4bFMswQe2902EN/Cxuj7Wt3MTejCcE1zDGQONHLMPRYHQ5GA/HQ0//TstHvLd18cBWL/LapDds680Y9BgpCWjzNVchqW5F7DGQg544GKviEZi37GvQdAQHpTs4aL6avmvm6k7bfl2c6riuaErunO+RPqlsC49NV+MHZ29pt6RgXzKoRce+0mC7EbaX+x237ntP8/2JXFbMtVJSQQlcuEtcnrrEDeBT4IdkxtQGdGL3wHUUM5US+GYRcDVw9xQfMOwxYa6rf9Plnu8QGYo8RjYlBViBrhhx9CUWfnx7OH4/8mZSqS3RsoBXmG0PABV5UBJjqDEhrkn0jVK67Eexa4wGbaswcGWyax0gTVidaGuWSuXAvjam1JPBYAcXp8KgB+3PoOA09eYMjD+AdgI2b6ji6BIusFt2d9GMgjdj75QU4KDHjZxlJ/hOI01Wsq5VQeYqIM/ClRaIL4FqYrYW4JJRxdS0wmt9W/jLMzSEw+EztXbBS+FtLRvMHRM2Dnbwa9O+zeUPJgAG/P1pC3XMDSPULtr8rvsscd2lLf+lcPSh4HXP9q6F8x7nLtDrN23zpA2eoMELNHxjuuftiVdg/R7DHiSTuA/t72wyOhueDb04+3x994lMb29OduHNIkmowMa10s6ArtknEE6kkCnPtgTdRFYan22gUlglXBCrXQZtEPgwln+MNogvBs86BFVf9tPN3CofPbqgwlt5+oNSAHXXhfBz36Ccl2CNGZQ55cJ+psBw2NVR5H+fatrN4IvVGmMO2Ha7JdXsXuX7PZJB6wqdd9FFi/Vd2AAvOXBB9OsfbIvwHND+HMEge17Zt8dh3sHM6HZME8xVz/IuvLRw+2U2R/D1RzWwDu5RFDWAfyfRX/AbOpWl76IcmoEKEhXwuHPx5x91fgwt +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 batch workflow' (create-batch-workflow)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create a batch workflow

+ + + + + +Create a batch workflow + +## Request + +

Body

required
    workflow object
    options object
+ +Expected response to a valid request + +
Schema
    workflow object
    = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
    attributes object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/create-close-session-action.api.mdx b/docs/api/nerm/v1/create-close-session-action.api.mdx new file mode 100644 index 000000000..8651ca64a --- /dev/null +++ b/docs/api/nerm/v1/create-close-session-action.api.mdx @@ -0,0 +1,47 @@ +--- +id: create-close-session-action +sidebar_label: Create a close session action +hide_title: true +hide_table_of_contents: true +api: eJztV9tu4zYQ/RWCz77m0t01UKDZIAVcdDeL2G0fUsOgpJHFRCJVkrJjGP73zpCS49smziJAX5oFvBI5HJ6ZOXPRiusSjHBSq2HCBzw2IBxc59rCCKzF5auYNnmLJ2BjI0v/NuDXXpAJFpMss0GYiUbaiZnlg3u+0OYxzfWi3rF80uIG/qnAus86WfLByr9KA3i9MxW0eKyVA+VoS5RlLmMPr/tg6eIVt3EGhaAntywBoejoAWKHd5aGjHESLO02N09rTKcfkMmWsHVGqhkKp9oUAlHxqkKB1gHsXf+MM2Ab2932S4DDIsi1mlnmdAeVwZMoypzuOz9Pex/OkqTdP48u2hd96Lc/gui1+z+lZ+LyU3T5If7I13vXHaJ9Hd3WCtPpMYy7wDwprJeLK2MwQs/ydfg7BEyYOJNz2PZhpHUOIpAoFVWOXkxFbg9gDY/CYNKyRinThintdpB5VWu82Un3jHSXvmv/R26xJbIwBPys16P/djHcPJVIDrypEcUIIc3nIpe05pnL/yfpO5P0KB1+hKV3QSXDoBiNQWOp0QUTyJkMDKss/iCFBJsZXZWkkZYsW0iX4arF2MtUxswgYT2bSzGDd/M1KTvqZ5vpKid6qQTMj7laJMm0pieYqbBTvVBgXk7CYzjrHNyoarBF6NMkwbwQoQZ49U1I0NepzH2qoFxoIsmOHXQVosSkkPlUOPRhVLm3e/a7PNmoZNZpUuNx+esINyazZaj2dQKd6u/akqA65GZthjBGLI+hlg4K+6K9Dp7cQd54+3YsgdNsuecPOlOJhl9mdLoT6wK3H4SC3bUJ3qhgMbVOuOoEgCcFBBWyoHCDdRRerzOhZq9Egcr2HFpsqET9dKvY7yDoaQymkIoY9h+2mxa3j7IsRURL73jzRutLV9fut1OMXlF3ofdB0GimwS7oPqnj/lWr2eu2F8ca7GeRsLtQXVibVcobi4UD70PlDjpv6a5awW2KTD9smw20ofKt+zc6um59X+5PkvLX3BijjeXrSTDi8pgRQ8RnFLaXEZg51kF/Bs0x4CqjiDgKTUOiJzm+wFMM/qR9k3EvTwJAVx4iu2IFVghqNGE92tRCL7+dZCNtzJJZXYDLSGrhZzqDHb+OIFpPe5q+DErt555SuAzfunuDi+3674BpPQg2q3jAegdZH6PK5Hg2c660g253hV4Qyn0VBaw7CiOJsPQSgGpSV5QSD8+FkcSPUJQ24sHqmt5cxAXE+uALZezFmUJ57FlWzigsxLMKO0SBrRHtmxA+nGalW3qAEQgD5qoiG+8n29sjikrAsS20CRIZRdZ6McpDL4Qr4eHXpoCO9SMohIG/Py91ZcIjJ1cTAe6eP41umjgdnRJ35sDTmtbBJ9wpA/12gd2kvVSpJhAU2KCr3+l1elvZ9PXm7gu7+jY8jAre1myyWNCISSOYj4yIY2rTmDSs0IlMl4zir7FlYEVCX+Euk4p5t4GaS2QqVSgCiVkEOKsTKOUJwr8Mx96rxNtCqK2d1z5d94bWTbq+/s0bqEA9slvmQlLBCZxf1Xlzvx9KypDjmYPcyyjl8MxqFQkLf5h8vaZlZIghuk6e88OzFQ+ASGjmQyY/wpIQB+ztMSEj8bzyE8p+2aHCGE5cxVSqXpSdbFWFb7ejMZG8/pTHsNEZIxY0JODvgP+N//BFh/rnv/dpfcVznAIqrFMoE/TS378tbcet +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 close session action' (create-close-session-action)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create a close session action

+ + + + + +Create a close session action + +## Request + +

Body

required
    workflow_action object
+ +Expected response to a valid request + +
Schema
    workflow_action object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/create-contributors-action.api.mdx b/docs/api/nerm/v1/create-contributors-action.api.mdx new file mode 100644 index 000000000..44fd26496 --- /dev/null +++ b/docs/api/nerm/v1/create-contributors-action.api.mdx @@ -0,0 +1,47 @@ +--- +id: create-contributors-action +sidebar_label: Create a contributors action +hide_title: true +hide_table_of_contents: true +api: eJztWG1v2zYQ/iuEPrWAY+d17QIMWBpkmIe1CRJ3+5AZBi2dLCYSqZGUHcPwf+8dKSmyrKRJYXT70ARIJPJIPvf23FGrQOWguRVKDqPgNAg1cAvnSlotpoVV2pyFNBn0gghMqEXu3k6DcyfIOAsbsow74T4bJcBilaZqIeSMmSLPlbb0qKZ3EFrDFiJNmQSImFVsCsyfGzEeW9DMJqLai+FTNflmkYgwYVwDs8ItnYFNUH4uOFsofR/jgRO/biKit2xvaxSVjZXOQJve1pxWKXQM10smUlkRi9BZawIZF6nT1ECXhllhbFMz3GNDr1JvleUpoCHfnF0NTSn0xI54PFuCZYKWZCBx1x4rUPbz8G0fHWT5zASnt0GlQHmSCca9QMO/BRj7QUXL4HTlXoUG9LjVBfQCciJuSFM8z9NSx8GdIV+vAhMmqC492WUO6H0PCc/MNcUPesPQbMt0r1ggooawwYCSMxQmu3NEFRQFCvS2YG+GJAVdrbttvpQmn0Kq5Myg6clc8MDJkLjw6Cjef3cYRXsHR9PjveMDONh7D3x/7+Cn+JCf/Dw9eRe+D9at47bRfh1dY4SpuAvjJrDf+RycVOk+DPUIg0VnQvrxjeTD2FELiTLl1mjqWKTQJ+hu4nnQMU8NogZZZBhFTgU3NG5rMvTbc2PETFIcMuVVMokq0ojCmksPpc/YJf3vsSal9AjqNWXbY5YkykBLe4JA2JtKfj8Vmqf2d6CFY5fvB98dtwvcXIeJmEMzP6cKV3NfE2JepLaG3gmznYbEgeWmBAVpbeNkt9UaT7bCOiQd1Wjtfsh2JkeG84Y93N+nf5sYLh5yJB48qRIl4uVszlMRVWkV/CDAHRNgZzh8CwNe+y0ZOkUrdBqLtcqQXpSr+1j8NIUQZzOtipx2pCFqLyz2Ccyg76liu2xwPJjzGezM1rRZp53LNNQgI+TAbzI1j6JJzfoTbiZtBu9Iwi6cZQ4+FpAGSUcRdVzGCXRVjs3ebEMPOgpRuiZowq3Pz9db9sk4qbdkBtOeuiDC5Y4j3JjMdbP0fAC91N6lJn7rDaLmWvNlF2phIetk9FpfCw92K2+cfhuawMt0uQ3uVCIjBb/OXO+JvSNO33EJm2NjPFHCYmIst8ULAL7IIbgh8xvWWG/863nC5ewrXiDankOPDSUvny4l+xM4PY1cP0MR9h+Wm15g7kWe8ykN7fDketfnji7NbybovaysQrtBUO3s7mmZ7xReUHH/LrdpVdvjrgL7gUfs2rML3rcK6ZRF4qhuNv3XVFcl4TLGSN8umxW0oXSl+w9auu49LfcXSbljLrSmxnE99kqcdCkxRHxaYnm5AT1HHnRrUB0NttCSAkeiahjoUYov8BCCW2lepdzznQDQkdvIzliGDEGFxo9Pay508s0ku1FaL5lRGV6KSWpB7l5orPilB1F7mlN00c+V63tybhN8G7QaFzNotr/VIMobZx/jXFToFJcm1ubmdDBYoRG4tJ94Buu+REciKrUEIEoa8Fzg4jnXgsLDc1It7pUuozvgYQah2vreMHLiTKJ82ff6bwchtrCosSYVx4QvLLSwSwdwClyDPitIxdtxc/qGnOJxNIVqH5FSpK0TozR0QjjiH36r+HOk7oGu8vj3l6UqtH8MyNLk/+vHW/dF5abOJnGjDXxZzWobaEd3xfqq6C8A7dtXNVreZqrXR9auuUTIWJFqFC4e4UF/v7/fSNFPF9cf2dnVcNvXCKiaZCGnvpX6OudvHoZU+zETWaYiES8ZRZXCOoQ0hx7AWSYkc84AORcY/kR7pBimJuAFgEBJF3bBx+HI+YqSIeOyMfPc56023tUjBfz4LPY//CzmU5panUGeckF1w3PXqqS/23ZKmlbcTxpf0hIiTlyyWk25gc86Xa9pGHNOE+uMH2nOkQ4uAB5RQiEh3cOyvM8izL0RASPxtHB9Zrt4UHnzK85CKjjPyo4b3H51eTMirio/9mGe0BrNF5S4+Pc0+Ad/KdV9FXNfBGl8FaTYyxVYbVDG70s/XwBKctHe +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 contributors action' (create-contributors-action)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create a contributors action

+ + + + + +Create a contributors action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_performers, workflow_action_roles, workflow_action_performer_notification_email. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). + +## Request + +

Body

required
    workflow_action object
+ +Expected response to a valid request + +
Schema
    workflow_action object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/create-create-profile-action.api.mdx b/docs/api/nerm/v1/create-create-profile-action.api.mdx new file mode 100644 index 000000000..6e4416872 --- /dev/null +++ b/docs/api/nerm/v1/create-create-profile-action.api.mdx @@ -0,0 +1,47 @@ +--- +id: create-create-profile-action +sidebar_label: Create a create profile action +hide_title: true +hide_table_of_contents: true +api: eJztWFlv4zYQ/isEn33l6u4aKNDsIgVcdDdB7LYPqWHQ0shiIpEqSdkxDP/3zpCS4iuJsw1QFKgDOBI5nPnmHnrFdQFGOKnVIOZ9HhkQDr747xujE5nBZUS7vMVjsJGRhX/r80DDBAtHWBGomajJnZhZ3r/jC20ekkwvqh3Lxy1u4K8SrPus4yXvr/yrNIAAnCmhxSOtHChHW6IoMhl5gN17S5JX3EYp5IKe3LIAxKKn9xA5lIkgUB0nwdJuLXlSYTr+gIw3iK0zUs2QONEmF4iKlyUStPZgbxtolAJrdHebLwEOm0Km1cwypzvIDB5FXmQk7+ws6X04jeP2ydn0vH1+AiftjyB67ZMfklNx8Wl68SH6yNc74vbRvo5uY4Xp5BDGbWDB5RZ9Xjt7IV3KRJYx4VDstKTdSGcZGhdiFpcEZYtvh4CLOJ5UEQBmIuxELxSYDR2mWmcgQswloszcYR0GAXPDitlUl1mMhmUoAgEI6wk8+1rDGrrTRBeCN97Sk0QRShOlcg7xy7gSkdnngO06XKLpKqZMG6a025LrWa1RspNuw97babj2H/KuLTCZQtye9nr0bxvE1WMR3FCTksqCzUUm49pm/P9ce+dcOxgP35Nst4ElQ6cYjU5jidE5Exg0KQZzaSmiDfpzZnRZEEdaslVGMou+l4mMmMGI9UlXiBm8m62J2UE7VxloQMVgvs/U/43qgEkhs0lT9t5s2WfjpGHJrNNN/fTiCDcms2XI9vUAOtbelSaBdcjNSg1hjFgeQi0d5PZFfR08ur288fptaQLH6XLH73WqYg0/zeh0J9I5bt8LBdtrY5SoYDGxTrjyCIBHOQQZssCwwToMr19SoWaveIHK9hxabKBE9XSt2K8g6GkEJpeKIoz/e/2mxe2DLAoxpaV3lNxwfUl0ZX47Qe/lVRd6HwQ1ZxpQA++jWu4fFZudbnt+qMF+FjG7DdWFtVmpvLJYOFAeMnfQeUt31QquE4z0/bZZQxso37p/oaPr1vN0vxOVF3NljDaWr8dBiYtDSgwQn1HYXoZg5lgH/RlUx4ArjaLAUagaBnqc4Qs8RuBP2jcp9/IkACRyH9kly7FCUKMJ69OmFnr6zSQbamOWzOocXEpUC3L3wmDHrzyI2tOepitOof3cUwiX4lt3Z3Cx3VD0J1UnqJfxhPUWst5JpcnwcOpcYfvd7grNIJT7JnJYdxS6EnHpJQAVpa4oJB6eCyMpQEJVasiD2lV8cxHlEOm9q9bIkzOF9Ni0rJyRXyjQSmwROfZGVHBM+CIcuN3SA5yCMGAuS1Lybry5PSS3BBybRI2XSCnS1pNRInoiXAkPP9cVdKQfQCEM/P5xqUsTHjnZmiLg9umKd1U76uCYuDUIHte1Dt9F/+HF5PnJI0wXT/W5qRpSJZpUoLAISE46vU5vIxm/Xd1+ZZc3g32foux6k0WCJlSa4LxfRRRRl8ecY7mOZbJkFD0aOw4WNLQ07jKpmDc6qLnEQKcCRypgEgKO+gRK+fDiXwcj7xMK+1yojZ1Xb/A7Q2+T7kfc/UMoUZPtFpmQVLFCzqyqxLvbDQXKsGdSD4M3paTFQ6vVVFj4zWTrNS2jrwzF+/gpwXy44wEQMfkOU+EBloQ5oG+PCBqRZ6WfcXYLF5XWcOIyomL3Iu14o67cXA9HlCXVbxroOTpjxILGDPzu8z/xD190qKD+hw9aX/EM54gSKx3SBL70+RuWnygD +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 create profile action' (create-create-profile-action)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create a create profile action

+ + + + + +Create a create profile action + +## Request + +

Body

required
    workflow_action object
+ +Expected response to a valid request + +
Schema
    workflow_action object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/create-create-workflow.api.mdx b/docs/api/nerm/v1/create-create-workflow.api.mdx new file mode 100644 index 000000000..dd3582867 --- /dev/null +++ b/docs/api/nerm/v1/create-create-workflow.api.mdx @@ -0,0 +1,47 @@ +--- +id: create-create-workflow +sidebar_label: Create a create workflow +hide_title: true +hide_table_of_contents: true +api: eJzFWFtv2zYU/iuEnu34kqQXA3twtwzLsLZB7awPnSHQ0pHNViI1kkpiGP7vPYe0JMp2btjDUsAlDw95Pp47tY1UCZpboeR1Gk2iRAO38Kv7/ar0jyxX91EvSsEkWpTEhkx+mXHmudl9y2j5ykSTb1FNMtGiF2n4twJjP6h0E022bio0oDirK+hFiZIWpKUlXpa5SBycwXdDwraRSdZQcBrZTQkoXi2/Q2JRWKkJvBVgaLVB8SwnzjKRQ0xcsUiDDcZqIVe4IVO64Agpqipk6B1h7ipkvga2P5TRScyuW60wyDJEYc7wGHjgRZmTpPPzbPh2nKb90fnyon8xglH/HfBhf/QmG/PL98vLt8m7aNdDRNxW5hREkFVBqr6SfJkDgfxNGD9cPAf46xoQomZKM6lsF64wDPyRtJzuz+yir2UiwOq0Ap9XGG5kKuvI7gopNjEdjjIkL+D1Qj7hrkMJhwIa+g7FWGEd/cD9d+6PpJlSSeN9aDwc0n9diVcPJVoaFVezMqswTO54LojmoiD6Hxz+pT7O088y33htPm7aQsi/QK7sOpqcj3HKH8Lp0Sk1zBdF2q7JFqBfv8GzPh4qtwY0Tj/BPlibOU8SMMZNF7tekyBeprcncsEag6kJLPQcgzzsXuQ5W3qfxBNxbtdnjHTGpt4dMLYYSmG3ZRrmVxN1sIVZgWvNN4hFWChOZosjrT2K2vxn2B+4TdZd1M+nMV6KeG/J2FB09Cg4tLpzqY0jhpX0Q4t3RNxyFVsV48HaxkF4T2/nf/Rn8+n8djbqTsfd6Xl3etGdXnanb7rTt93pu+70PaGsEFyAekk6iRNFqcc6CkZ5QoqMUWVxWvk8gPGKK7kyniVkV5VGM8Q8DWfwgJkkJGAYYHziQQGtcm5EntpIQVUblXvdZlz4+pFVOTqAHwt5J6zLS7U18pSXMRlEpI5DAqlbEghEqTYAse8H0kOyl+/JVmTCDUvETbf3RuZ5SHJqK7zYmti9/yG10cPhQqiPw7VGL80C4aeAaEl7nRyAIV0EU3+t5HBvHaoG8n1W3i+0paCl3Amnz5rgAyZO1lyuoENXWPDo6ATSSodLGFGrlUtoNaW9ILGjVl3E1bCcAzYu2S6YPWDwReF7O/R51o8JrxsahX5xELkuKhFmEJedC7l9xzepZBgy91y4KEdLBec05aQ+aRGW9DZidi5TaLGsLJhTJRIdSZDBeH7TKZbdBLULTsc19LO4Oda1JxN3M5EwWqMYQ40fsQxHg9HlYDwcDwP9ey0f8d7siwe1L1Rtq9wKFB+/YltvBthjpKxDm6+F7pL2rYg7BnPQIwdTVTwC85p9NZqW4KG0B+/C7qvuu2a+7jTt18WpjusDT9kX73uszyrXllLTVfvB2WvaLSXhc4a16NhXamzX0vVyf9LWXe9xvr+Jy4m50lppLIELf4nLU5e4Rnwa/ZDNQN+hTtwevI4GW2lJfbjEq6G7p9SUw0MCbqd51eWe7hCBRB4jm7ICrcBXwDx9SYWf+mnPH0beTGm9YUYV+LJw7QGiYvdaUQzVJqQ1Rb5RKp/9OHWN0aBpFQa+gsRt74B5winFOLtUOkf+tbWlmQwGW7w5l5ZcaHeGFacuOGdo/QH2E7j5jmtBPuEju2H3N804ujM1T0mBHnrcyTl2Ro8PVqcl51sVpq4CEy3eaUH4EiwnduMALoFr0NOK7vVtES7PyBIeR8jUGIYuRbd1bDj3TNQ5uMHvdf82Vz9AIgz8/WWDhcwP3fuFjP6lfWtftXkrfCocvX5f9hZte7jgxekjff9Qq99pR+8qITNFksmMXrWjs+HZMIiXT1dfPrLpzfXJbrpeZAmX1IBWxtvBN+0Mw4IVKhXZhpG1VWXo+YWawVUmJHNKAmxn0BepjFPUYJwAPs8I1B7zx+u5w0qeWXAZrDzxtaODddvG4pNfSLy5qVoMypwL6R7R5NfbfTyEX0960VFEoE+tKXyQb7tdcgO3Ot/tiIyW1+SGi9bvnRfiBnyUoTORh/6ADQH0UPtzQkPseeWeEYcphJKc3zFNKO08ybsIIvzm82xOzrv/5oMGoj2akwrodxL9g/9wonwucx+GuHPQHOt6hTkHefy59PcTco+PVA== +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 create workflow' (create-create-workflow)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create a create workflow

+ + + + + +Create a create workflow + +## Request + +

Body

required
    workflow object
+ +Expected response to a valid request + +
Schema
    workflow object
    = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
    attributes object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/create-duplicate-prevention-action.api.mdx b/docs/api/nerm/v1/create-duplicate-prevention-action.api.mdx new file mode 100644 index 000000000..56e4faa50 --- /dev/null +++ b/docs/api/nerm/v1/create-duplicate-prevention-action.api.mdx @@ -0,0 +1,47 @@ +--- +id: create-duplicate-prevention-action +sidebar_label: Create a duplicate prevention action +hide_title: true +hide_table_of_contents: true +api: eJztWGtv2zYU/SuEPrWA8+pj7QIMmNtlgIe1DZJ0+5AZBi1d2WwkUiMpO4bh/75zKcmx/IpTdBgGNAVciby8PPfy8D40j0xBVnpldC+JzqPYkvT0S1lkKsbDpaUJaZ7txvwbdaKEXGxVEd7Oo/dBXkiRNEtEsVwjZFh0LG7GJFKTZWaq9Ei4siiM9fxohl8o9k5MVZYJTZQIb8SQRAUjETL1ZIUfK1frEnhqJp9NxyoeC2lJeBWWjsiPIT9RUkyNvUux4aBaN1DJc3G0RBkMHjwgHUjvrRqWnlxnYykclBqbk90yZ022d8lAG69S3pKHKZcqC+5wtM0Neen8qvnQ0TK+do7Ji4zg6Wfdy56rhXZoxPZiRl4oXpLDWEo6ooTs597zY5ymlyMXnd9GjQH1Ti7qdyJLf5fk/DuTzKLzeXhVlsASb0vqRLGBNu15ShaVW7Hy5ItjYswjF49hLj/5WUGgSgUJexaWOYcjczy75ronLFDJirDD+ekRhNnvEqiisoRAZwN2m7/MzKXtfvWldvmQMqNHDq5nd9G9ZEdi4cuX6embF0lydPZy+Oro1RmdHb0leXp09kP6Qr7+cfj6Tfw2Wqxtt4n2cXQrI8Kk2zC2gXX5moExfMqWGeMogxuFxHXMwKtkJuheucASODZVGXUEKBQ3N1nTVBhNDa9ETYNjtsaRtPF44GLDZjxuDukyZ3rJLMNsXFrLjOlvs7NSLYLqxtAaH3tfgE7xnZAjqTSDWTW50QuAmh6uMgjiVkBKa+WshTGVmdvweRd+YknGsK6tte3tYRzoA9VY6iSjHYR9BA/7plovVPJ1HGTHqgmt7j40CFyyiuepLDO/Y/feVsZxFG6UMncQZVrIgqoFdvbKB6S7E8oi/LEXXIG4U13xF6en/F8bysV9AR5jw0aUWSHFRGYqaUgafQ9L3zgs7eTkU+PSVaVS4FCswaGJ1JocUcmElB2CFZgkxciasmCNPMSVgUeKFw5nz3lUcMINoaiQo1036um+ZmVb/ezGpsyYXjoh+5W3L0kGNT1RD0g3MFNNdv9d3IazvopLVQ02VATYgoslFwSC+rUI2i6rWnbwVkAZSpNWtHuaZ3fyZKlSOG9YTcAVtmPcuMzLEmY/gQ71d21JpZoOygDKU+722uvp3m/cm2BfyxI6zJbb6IsZ68TQz6NQEaKiw/QXqak91g8ZbTpwKFjLAwAedCCc3yuFS6zX1et75JnRY+UFxiaoGHpa1k+ftPidJD/dkM2VZob9h1kHRcqdKgo5zOib7rzUum/r2v1ugNPL6yz0bRA0mhELa90HJd4/azVr2fbVtgT7TibiqoouaJVKHYzlyqvuN46fkl1RQX5KwfTNtNlA6+mQun/jpYvObrk/WCpsc2GtsS5a9CsjXm8zogd8ViO9XJOdIA6GNTDHki+tZuJomFYVVAkq4ZjCSvck4/ZXAsRbbiLrihwRghNNNT5cxsIgv3rJro21M+FMjn6WpaZ83FOLjF+fIKznOcMte2FC3VNIP8bbyVrh4k6WnXmr363bPC7p2U8uHFVpM6gYe1+485OTOZwhtf8oc1ocaxwo0JkZEYemE1koLJ5Iq5gmVWxailfG1yyPZJxTbDY+HdwEcaEhj9Tl1EhX7X+MJhiWWza1z/hQ3is/CwCHaBLIdks29ba/On3Nh1PhWBVanhUbxdYGMb6OQQgj1cOvTRy9MXfEjTZ+f5qZ0laPEXuceXD10BNfNMe1tVhslYOH5a6NTuRf6+TWG7llB7WtgTq0z2m1OYda/JAklqFL6dSwB5mVlSPOjk+PT1ciwseLqw+ie9nbpBSMbCZFLLlMZucFWsk45lIDEEVuEpXOBJPXIO0hquKgMSuUFuHMSU8UbhtHWXYWrg+h32BQOrA7+tC7CZTgu5dLvTJzyAexddzzh8jz/YPa//2DWhVuuBw7KTKpOLdVcXVeh+jb9XDBUXhvkOarxUEeS+fzoXT02WaLBQ/jPluOjP2HUBwCIxYgPnCXgaB5RzMmVkWxoxsGyOJZGWri9UTHqbha0Y05Oe6V7a/koctP1zccT+vPhbhkvMbKKZel+D2P/sI/vJgq44Zvijw+jzLUnSUyI2Qqvfz3DyXw7og= +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 duplicate prevention action' (create-duplicate-prevention-action)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create a duplicate prevention action

+ + + + + +Create a duplicate prevention action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - duplicatation_prevention_attributes, workflow_action_performers, workflow_action_roles, workflow_action_performer_notification_email. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). + +## Request + +

Body

required
    workflow_action object
+ +Expected response to a valid request + +
Schema
    workflow_action object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/create-email-verification-action.api.mdx b/docs/api/nerm/v1/create-email-verification-action.api.mdx new file mode 100644 index 000000000..e17969ac5 --- /dev/null +++ b/docs/api/nerm/v1/create-email-verification-action.api.mdx @@ -0,0 +1,47 @@ +--- +id: create-email-verification-action +sidebar_label: Create an email verification action +hide_title: true +hide_table_of_contents: true +api: eJztWG1v4kYQ/isrfyYB8tK7RqrU3ClVqXqXU0KvH1KEBnuATexdd3cNQYj/3pld4xhwEt8pVb+USMHenZ155n2WdaRzNOCkVoMkuohig+DwKgOZfkUjpzL2e5cx/486UYI2NjL3bxfRR08tQAnkE2JROyJge8bBzEYXd9FSm4dpqpfljo1Gncjg3wVa90Enq+hi7V+lQULiTIGdKNbKoXK8BXmelqy795bFryMbz0kwP7lVjgRIT+4xdiQzN6yXk2h5dyt5XGJqf0AmNWLrjFQzIp5qkwGhioqCCDoHsHetNJyjqHR39ZcAR0ww1WpmhdPHxAwfIctTlnd6Ou29O0mSo/7p5OzorI/9o/cIvaP+D9MTOP9xcv4ufh9t9sQdon0dXW1F6GkTxl1gv8ICPVVh0QSvr/hdmjIQIEkMWnvM6PzKGB9zGeKsBlGSd2do6halpdOTVqCDpCe+wskMO0IqkUlVOLQ7mE96BMXpB1T/AhTP9xBKrLVJpKIUsWIp3Vzsyx+z8B2Y/QaU4wDxdceiKjJOtLkujOVkhRV/pXpGRgHnMMsdL0C65J1RO1VIaAtVdgPESyZVwMRzucB6Ek20ThFCLZlCkZKlp5DaA7sOGuNQSCu2TIU2Qmm3I9mz2rARpfNInitlG/9hG9qcalFI+5Nej792gVw95lQiSNyWlHQXIBaQSl7z9Sv6v1S9calqjInvqVU3gaUgpxhNThNTozNqWZpOmlDAKI5AzIwucubIS2WQg7Dkew4dYShqfTnLYYZvZmtm1mhnSzmccnipBM33mZpq8LgMTzRjsGO9VFTgXszEJpxlIlasttgmyGWe8gKsJ/Dsty4hW09l6lOF6MJUkezowaKq7kDFycgJFe1vtuyzcVKxFNZpZuNx7bQnQWxfD6C29i41CaxDbpZqgDGwakItqSTbF/V1+OgO8qbW/ipxrXS5i+71XCUaf57x6eNYZ7R9Dwp310YkUeFybB24ogXAVg4hhiIwrLDehtePc1CzV7zAZXtBjWigoHy6VuJ3BH4aosl8b0r+w57TieyDzHOYpPimkiuuL4kuzW/H5L2s7EJvg2DLmWphybtV2/2zZLPXbc+aGuwHSMRNqC7iSBTKK0uFg+QRc+cHpNbdVSu8nlKkH7bNLbSB8q37Nz666TxP95WpvJgrYzQNVJtRUOK8SYkB4TOK2sstGhqIhT9D6hh0hVEcOIpUo0BPUnrBxxj9SftNyr08CSCLPER2KTKqENxowvqkqoWevp5kt9qYlbA6QzdnqiW7e2mo45ceJO15T/NVMdd+7snBzemtuze42G6oh/Ur4XaLTllvJesdVZiUGMydy+1Ft7smU4BynyHDzbEidxI2vULkwtSFXNLhBRjJQRIqU0UeVC9jPII4w1gfXFmHnlwooqfGZeWMfcPBVlCbyKg/kpIjxhcXRrqVBzhBMGguC1b0blTfvmXXBBx1ospTrBRr68k4GT0RrYSHX7ZVdOinbj9T/7Si6T08RmxvjoKbp1vy1dZZjaPizjDYrnPtG6j93a7panfSa7pl9Z+91GzvKE9FuyolUk0168RxEqD1j3vHvVqGfr66+SQuvwwOnUzwt5siBh5bWR3vaIhjbv2UiCLTCSvH4aSpDZFWZHra5Tuk9wKqhaTo56rH6lJmIs3/DEr5eIs+DYbeSZwLGajaTrufRvbG4aoQtP1lJdiQe3A3T0FyQQvptC7z8m4/SmzltsbMpNiec17TwfV6Ahb/MOlmw8sUgYbTYfSUfz4b6ABCwoMlZcoDrhh8UONoyPCYPC38GLRf27j6hhOXMdfDF2lHtdLz5fp2yElU/mpEfuQzBpY8idD/i+gv+qMXHYqs/2mJ19dRSqNGQcWQaAJf/vwDl5iohQ== +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 email verification action' (create-email-verification-action)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create an email verification action

+ + + + + +Create an email verification action + +## Request + +

Body

required
    workflow_action object
+ +Expected response to a valid request + +
Schema
    workflow_action object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/create-form-attribute.api.mdx b/docs/api/nerm/v1/create-form-attribute.api.mdx new file mode 100644 index 000000000..51bb4389d --- /dev/null +++ b/docs/api/nerm/v1/create-form-attribute.api.mdx @@ -0,0 +1,47 @@ +--- +id: create-form-attribute +sidebar_label: Create a form attribute +hide_title: true +hide_table_of_contents: true +api: eJztVttu4zYQ/RWCz77X3W4N9MFbZAEX2AsSty+psRhRY5sbiVRJKokh+N87Q8a2fEmQAEWf1gZskTPDuZ0zYiNz9MrpKmhr5ETO19oLNHlltQlCgRHKIQQUIJbWlQJCcDqrA8qOtBU6YLtZTpZJ7yMpTVs6AVZeTm7lsbGXi450+E+NPnyw+UZOmrjUDumo4GrsSGVNQBNYBFVVaBVd9b97jrORXq2xBH4KmwrJv82+owrksnIcWNDkhaTs+Nsh6tfp67yl6MnWrEjxtFIodC7sUgR6YjNSwUcoq4KtQI0BcJB1x8PxoDv+FcZdeD9W3eHo3S/vRst8oN4v5bYjDR6ie8bvGw99OdBDKcg5L74ldy+5bcd48fi9VMRDyNbUJbf9xDIjjNzJBXm2LkfX8kpowxXtdGIDIKStn0btOIaXXFfWa16e5Sdob9+ZLbkMOsRsjiDqScQfhqOvrPEJBaPBgP+O3V09VoQYzMVOVQRLvLiHQvNeRLP8AdwfwP0vgduR/0NtT0b782zpjvZ8GV+iyAfIxXViguiK2kBWRJYoy8EG7L2FH9bglyU14xz5u+BmJpLvDzbddp7X+4u1opsr56wj0i9SEj9fSmJG8TkDhbhBd49ORBtKx2GonSH+U4NqswaTF7TAR4XR0r8puZfJjOzyPLKpKNF7WKFI+xlhITYw6bdRcWOd2whvSwxr1nqgqMSDswSe7a6FLLP87iYsxhggrGnVPx49niQ+VsLHZtSuIKV1CJWf9PsNpQsmfIYStz1DLSP/doPYo5b3odJkfA9OMxBiZgf1lN4S6iJEFJeo7DlOo7owpC/Ae73i+jOgah8oN8fJLDg+VTsdNjHADMGhm9aczO2iLb7h8qc42kr7bnBSnG1Uo3VSYv7Hh487hs/tHRJJ+fe3ja1deoy84U5fH242V7uGXBro+5H9Wg6fzdzXGrbm5eloexpoQw5em6XlwLjXqf7D3qA3aDHp89X1JzH9Ors4UHbCeG/MUNQ+NQuUItgKIowoba6XG8GQsLXnNymVj6RCGxErieZeE0pLgivziRiE9KbloEzEjPw0m8dCM2ZLMC3J78/eVI9CbQ4kfdN196l8AR9DvypA88hJZGiemHMrT5lD2Fszt0jUNBl4/NMV2y1vE0Icw3Vx4EdEKxkgxI4Qku9ww3mlcLvz9IqikVfHuX86X3gCJoup4pn0ou6iRf+vX27mDPKnmzj1iG0cPNAm/07k3/SNN/446OJ1nfcbWYBZ1TSQSCedy59/ASU7N2o= +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 form attribute' (create-form-attribute)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create a form attribute

+ + + + + +This endpoint can create a form attribute + +## Request + +

Body

required
    form_attribute object
+ +Expected response to a valid request + +
Schema
    form_attribute object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/create-form.api.mdx b/docs/api/nerm/v1/create-form.api.mdx new file mode 100644 index 000000000..bd6f74898 --- /dev/null +++ b/docs/api/nerm/v1/create-form.api.mdx @@ -0,0 +1,47 @@ +--- +id: create-form +sidebar_label: Create a form +hide_title: true +hide_table_of_contents: true +api: eJztVm1v0zAQ/iuWP/eNsRVUiQ8DhlQkGNoKX6BCl+TSGhI72E67qOp/585e2qwtAz5DK7WJ77k333Nnb2SGLrWq8spoOZGzpXICdVYZpb1IQYvUIngUIHJjS9mTpkILjJ5mhI/SN1HkYeHk5LNkpJPznrT4o0bnX5qskZNNeFUWSc/bGnsyNdqj9iyCqipUGuwOvzkOZSNdusQS+Mk3FZIzk3zD1JOjynIUXqFjaQjst6haZR2Q81bpBYEO00dBQGFy4enxPmW8g7IqWI0XvrKl7YHmzrDHO/9AhfeGDcWNJKdC41pQbLki+akAOisPAiGfGko8lcXe3btGBI/vGXnKOps4NAs2XaoVdjcoMaZA0F3bORQOD02+Ro+2VBqdWC+RjNqdZUFU2lnekhuv/G5LHK3wh0niKqNdrNLZaMR/D31c3VVUUcxECxXeECFXUCheCxyT/+n0T9GpJ08XgJFAHJA17yuzC7JrXTTtzDnO4JH6nOFonDx/Nu7n5xfj/vmzp1k/ycYX/WR8/vQCR8k4OTvB7P7Zjtvnp+j8EjJxE1kr+qLWkBSB0alhtx4Hf8Nlo/E6p6F7zNc2pqkOjfKWVbe9X+M+MSq4ubLWWGrQeUzi4lQSU4rPaijELdoVVSnoUDoWfW019SqxrdZL0FlBL3iXYtB0f5Xc4y2I7PI4sktRonOwaJmfcJNweSO+W99bY20jnCmJaYxaU1RibQ0xaduWkGWGj7rKhClTgV/S2zAecj3pQv4ulKC2BYmW3lduMhxuKEnQnltnO9BUKPJqGsQBFXoIlSLlFVjF5Q/57OExqRzqgpkMaYmpOe6+AI8NCM6pBe8606h2njKynMKc40trq3wTAkwQLNrLmlP4PO+Kb3nTYxxd0K4GnBRnG2Dc0AFEK/HhTdt2M/MdNYVBvy8aU9v4GJqE63uzvxFctWXYj9wwVPdT8TDj382+OM4OZ9Z+GoWJw5EonRv2x4WLpp8MRoNRpxneX928E5cfpidnXisM96OERryLOw9pSswTxHlRmkzljeD6mtrxwUV7QVKhtAjbgnqliGglMY5bgpoA6WDjoNosprOwa0y7EnRH8urgRnZwcuy66w8uc51TZlgVoHhCRBZv7oneuc0tuQFoYbNJwOFHW2y3vEwFtcyu+Z7OgVykQLOXOMLE+44NRx5D68/YLcOLmt0fDQEeU1HjMuXB8Sh23unRD9e3M+bk/YWTqsA6FtZ8EtDvRH6hb7jFhmkUbqW8vpEF6EVNU4Mw0S5/fgJbWdc0 +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 form' (create-form)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create a form

+ + + + + +This endpoint can create a form + +## Request + +

Body

required
    form object
+ +Expected response to a valid request + +
Schema
    form object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/create-fulfillment-action.api.mdx b/docs/api/nerm/v1/create-fulfillment-action.api.mdx new file mode 100644 index 000000000..7417670de --- /dev/null +++ b/docs/api/nerm/v1/create-fulfillment-action.api.mdx @@ -0,0 +1,47 @@ +--- +id: create-fulfillment-action +sidebar_label: Create a fulfillment action +hide_title: true +hide_table_of_contents: true +api: eJztWGtv2zYU/SuEPrWAYyd9rF2AAUuLFPOwPpC424fMMGjpymYikRpJ2TEM//eeS8qOX0mTLsM2oAmQSOTl5bmvc0nNE1ORlV4Z3c2S4yS1JD29q4tcFUVJ2p+kPJe0koxcalUV3o6Tt0FOSJHfiAoZZNuiNyaRm6IwU6VHwtVVZaznRzO8pNQ7McUKoYky4Y0Ykoi7ZkLmnqzwY+UaXQJPy8kn07FKx0JaEl6FpSPyY8hPlBRTY69ybDiI6wYqeyoOdkZham5sSda1duasKWjP8GrJQBuvcpUGXw2olKoIljraZ2FZO79uGXRs2NXYbcqqIPjxycmnrmuEbtGI7cWMvFC8hN1NWUvUkP3cfdpGfLwcueT4Ilka0Ozkkn4rsfRXTc6/MdksOZ6HV2UJ8fa2plaSGmjTnqdkVRWNjZ1Lx6GeJy4dw1x+8rOKEPwICXtWlrMH0XA8u+W6ByxQ2Zqw8xZ2Q5j9LoEqqWsItHZgb2YkJ93Kdr/+0rh8SIXRIwfXs7voWrIjsfD58/zw1bMsOzh6Pnxx8OKIjg5ekzw8OPohfyZf/jh8+Sp9nSy2tttF+3V0ayPC5PswbgL7RU5QYYg7JzkibQXyY2RNXQn4caIyEkpHJ7HKJnt4DhVJbcZcyRE92Lu5LNxeA1jbXte6samLTFjSGdlv86606VhNaB3q0KAkZeSeXNaFvwVad68vmTqWStlx8OMGsqBqsbLbDVCMZVMFjwNgqRks2ei+HQeAeOWDx3bJdxF+GKqrUNGxeJ4dHvK/TSSn1xUKjTgUUZSJRoqJLFQmGhZIvhf8Ixf8rQXz0Io/iyoFgoICl4XIrSl3KEA2JACNPMTt1KMvCofYc4cS3Mq+vfxv8/U/Wv1ZNmjSE51WuoGZarJ3l+I+nE0lrlQtsaHXYgs+YbggENQvQ9IQ5uZZZMMO3gooQ9MfSA8fDmv/iMS6UimcN6wm4ArbMW4U8+pwcHcC3dffjSVRdazNxgxprZztQ608le5Oez1d+526CfZtWEL3s+UiuTRjnRn6eRTOWqBQTF9KTZtjfeyoaTpwXvr6HgDvFRAoFFHhCut5fH07lnr0lSgwbU+oJbpaNk8ftfiNJD/1yJZKc4b9q13PXamqkkMeesSdV1r/Vw33j0bNVrd9sa/BvpGZOIvsgvtFrYOxII7lSb79kO5qNH3Mkem7bXMJratD6/6Vly5at8v9zlJhm1NrjXXJoh+NeLnPiC7wWY32ck52Ah4Ma2COJV9bzYmjYRoSPSvwQtcphZXuQcbdfRIg3nIX2YkowRDcaOL4cMWFQX69yM6NtTPhTIlLIEtNOdxTi47fRBDW85zha21lwrmnkn6Mt87WwcV11m6xyzGIu+AeFyJU2wIrx95X7rjTmcMHUvsPsqRFWyOOAGVmRMxIHVkpLJ5Iqzg7IiWtxKPNTXInMi0pNTu3614QFxry6FhOjXS8Kqe4VcJgyxb2GV9aW+VnAeCQcDO2JzVbeNFfnz7nmEQc60KrELFRbG0Q4yoMQhiJD++W9NkzV8Q3V/z9aWZqGx8TdjSH/+zmknm6jNLeM+LGKfB+LWvbQX/3arR2NLovgBuqbihpl8dWzMJ7s6WcPRHwUfuwfbhWsB9Oz94LXPp3Qw+Yy0mRSj7FsoEh/DJN+SSAuhSlyVQ+E5xkBl0JMBAQzMJsEWJDeqJQDAyMzUWhEq4DDEqHLEzed3shdFwapdRrM3d829mGO7/hg++fhP57n4RiffOxp1MVUnEPiUQ2b6jwYrs+mfb2kSHoZMwcihXz+VA6+myLxYKHUfSWGah/Q3mBgLCAZMaHeJDTFc04Q2KuHPQYF4sXdThybvcR7nRxxUnKvedO2f4azX/6eN5j3mq+c6FIeI2VUz714e9x8id+8WJiQwsfw3h8nhQ41tXgBMhEvfzzBYJYa/w= +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 fulfillment action' (create-fulfillment-action)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create a fulfillment action

+ + + + + +Create a fulfillment action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_performers, workflow_action_roles, workflow_action_performer_notification_email. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). + +## Request + +

Body

required
    workflow_action object
+ +Expected response to a valid request + +
Schema
    workflow_action object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/create-identity-proofing-action.api.mdx b/docs/api/nerm/v1/create-identity-proofing-action.api.mdx new file mode 100644 index 000000000..c145b4e68 --- /dev/null +++ b/docs/api/nerm/v1/create-identity-proofing-action.api.mdx @@ -0,0 +1,47 @@ +--- +id: create-identity-proofing-action +sidebar_label: Create an identity proofing action +hide_title: true +hide_table_of_contents: true +api: eJztWFtv2zYU/iuEnlrAsZNe1i7AgKVFhnnY2iJxt4csMGjpyGIikRpJ2TEM//d9h5RdX9OkCLA9NAESiTzn8Fy+c6HmianJSq+M7mfJaZJakp76GWmv/OyTNSZXenyWMkHSSTJyqVV1eDtN3gdiIbVQLYOoWw4hA0tXDAoSuSlLM+VV19S1sZ4fzeiGUu/EVJWl0ESZ8EaMSEQNMiFzT1b4QrlWlsDTcvPZtFBpIaQl4VVgHZMvQD9RUkyNvc1x4DDyDVX2XBytVBwuVVxup0bnatxEJ3QO01WyrvHqgk2O9tlSNc6v25CbTQtaC01VlwTHPTv71Hct0QGJ2ngxIy8Us1TQjLKOaED7uf+8i4B4OXbJ6VWytLk9ySXXncTSPw05/85ks+R0Hl6VJUTZ24Y6Cez2EMhbsKxUaXBA78ZxbOeJSwuqJD/5WU2IdlQJZ8IxwAz87nh3y9uPYFDZGrHzFnaDGO6oJLRKmgYEnR21NyHI8FrZ7tdfWpePqDQIGlzP7qI7yY4E48uX+fGbF1l2dPJy9Oro1QmdHL0leXx08kP+Qr7+cfT6Tfo2WWwdt6vt17VbWxEm36fjpmK/ygkFKkTZgiI1jfZCOmdSFUA1Vb6IqIJfc1WSmMhSZZyJzLZKRazILpsgbVqoCa17e2RMSTJmdC6bEv7OZel2DOjvVZgzcSlUAL0A6YYNQdQCJ0OPYNOBerIIP+xEVwOzER4vjo/536Ye53c1oITTlqScSjIaLlqcJ98h/cSQ3guJb8H0RRQpEBRrEDSRW1Ohb5hQswPQASMpxtY0NUvkJReRLoVD7FWuUmEB2oDoWo7pyXzNwvb62RWmKRleOiP7ba6WWTZs4Ul2KN3QTDXZ+xNxn55tHq5ELXVDN8ER3C1dIAjilyFZloeNvrphBx8FLZEUqhxKDx+OGv94zx7EyUqkcN6wmKBXOI71RjKv2t/9AHqov1tLouiYm60Z0lo526e18lS5e+31dOd38ibYt2EJPcyWq+TGFDoz9POYubuYBrB9IzVtrl3jRE3TofPSNw9Q8EEBgUARBa50vYyv7wupx1+JApftCXVEX8v26aMWv5PkpwHZSmlG2H/YcjqJu1V1LUe89IQnr6Ted3TrfoeBsqraLvQ0Giwloxa2sh/Udf9qxWx121f7Guw7mYmLWF0wKzc6GIvCsZxVu4/prkbTxxxI322bq4FAh9b9G7MuOofp/oyTDY45t9ZYlyyuoxGv9xnRh35Wo71ckp2gDgYemGPJN1YzcDRMA9CzEi90l1LgdI8y7v5JgPjIXc3ORIUKwY0mro9WtTDQryfZpbF2JpypcKFhqimHe2rR8dsIwnreM3xdq02Ye2rpC7z1tgYX1zt0mXFgcsFJLsSpsSX4C+9rd9rrzeEJqf0HWdGiqxFNqGZmRFyXerJWYJ5IqxgjsTCtyKPlLcQTmVaUmp1r4yCQCw16nmvVWMfLX4rbE8y2bOc165c2FroHBUeEu549a9jOq+v17UuOTNRjnWgVKDaKrQ1knIuBCCvx4ZdlER2YW+IbGv7+NDONjY8Ju5tBcPHlMnW+jNXeSXFjFnxY49p20BNfAdbL8apIKJ0bVpchEE896R53j9dy78P5xR8CN9Td+OGI5aZIJQ+krGmIIZTlpo4UE5XJVD4TjBSDBoP6Ba9iVygtgoNJTxRwzfWMlUTOESZ7VkoHKCV/9AfB/4zySuq1na9/edjWev4lw79/t/gffLeIycmTS68upeI2EKvQvK1mV9vJxTXrcD1DRSi4GIJvPh9JR59tuVjwMvLWchG5/lK1Qg0BA8mMp3HUl1uaMTAiRI4GrB2Tl02YHbcbAresyHGWchO5l/Z6rV5/+ng54NLTfpJBijCPlVMe3/D3NPkbv3gxsTOF7za8Pk9KzGcNOghoolz++RcER/gM +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 proofing action' (create-identity-proofing-action)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create an identity proofing action

+ + + + + +Create an identity proofing action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - identity_proofing_action_configuration, identity_proofing_action_mappings. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). + +## Request + +

Body

required
    workflow_action object
+ +Expected response to a valid request + +
Schema
    workflow_action object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/create-invitation-action.api.mdx b/docs/api/nerm/v1/create-invitation-action.api.mdx new file mode 100644 index 000000000..2add7e890 --- /dev/null +++ b/docs/api/nerm/v1/create-invitation-action.api.mdx @@ -0,0 +1,47 @@ +--- +id: create-invitation-action +sidebar_label: Create an invitation action +hide_title: true +hide_table_of_contents: true +api: eJztWW1v2zYQ/iuEPrVA4iR9WbsAA+YWGeBhbYIk3T5khkFLJ4uJRGokFccw/N93R0q2ZCmO7RnbPnQDUkk83j33fqTngcpBcyuUHETBeRBq4BYG8lFY97Ef0t/gKIjAhFrk7u08+OzIGJdMLEkZd7Q9dpsAi1WaqqmQE2aKPFfa0qMa30NoDZuKNGUSIGJWsTEwLzRiPLagmU2EKXkxfKoWX00TESaMa2BWuK0TsAnSPwrOpko/xChw5PeNRPSaHbe+5rwwMKrBNNAFLyuMrcOKVRNUCVpleQpohFf9q4EpiZ7hKJVlM7BM0JYMJHI9YoiFfRu87qFxLZ+Y4PwuqACXkkwwPAo0/FWAsZ9UNAvO5+5VaEBfWV3AURAq5CYtLfE8T0XofHFyb8hP88CECWScnuwsB/Sch4Qyc02eR1MaWl0z1Q4bRFQjNlaj3kiM5sg4ogqKAgmOWrCb4UQRs9Td1l9Kk48hVXJi0PRkLnjiZEjc+PZtfPrhTRQdn70dvzt+dwZnxx+Bnx6f/RC/4e9/HL//EH4MFmvi2mhfRlf7wlTchbEJzCcIhgzTMBEoyKeIAWNcqhijQuGiaypsQomEbhIp41GkkYYwcx0m4hHq5h0rlQL36RjzIkUDxzw1LcSDToSUTRVThuGKUdkA7VgtXEjFYlJ4yCNu0Urjwnq3bw6K7WKhiZWAimg/t065sCNkPyqTsenelbWaKj5jrVYlYyZRRRoxVzYcSY7VR9paqCpGEFzyryD0CJoGW2gsOVrFgiQfHJUXgAFWinBSqfDwdMuc7PJDFdye0X5eqUf8aMc6sQlTI5MqvvtBdMm2Cu0DgCvTt+K4H6xHnooIq0IVzxCN6krvH0XN0KnEMD7hQmKzW4pr2Niw8axZlnoNkJj58t/BR5JehragirDW8tcc/X+sYa3R5Z+G4sbGtFuGHCgv9oPgxbbFt8URBQlcCZNFRgPVjeUy4jq6oAX8fgWawIP+qqyIy2GpWuznGAkYe9X7NVCALAmGdR2ajBcu9qywbq01PS8WngDjNMfY9XH25vSU/mkqc/GUo0iXh56UWgz3CcHKSTD4PvQdeOjrrEz7TH3XniXjZSSxWKsMhzvlDio4RWiauzibaFXkxJE+mXIEZAZ9T0HJtKraOZ9s25tetjUx67TzcqCQEej9TI1FeFSGJ+gRNyM1laA3T65dOAdVpy9ZVdjwvIUi6IhoHIFjv5xV/ADUPEw29CBRe3f9LeJkyZIZq4hNfSTw/ak6IB6yOpesG12Na81nXaiFhcxs1NfCk23ljdOvoQlsp8tdcK8SGSn4eeKqMs4YuHzPJTS/DVGihOnIYMkstgC4lUOQIfMMl1hv/OvnhMvJC16gsv0IR2wgefl0KdlvwOnpFnQmJEXYf3pGMw8iz/n4mZPFvpKXXDeJLs1vaEjNyi50GAQVZ6yFJe/ncdT67R8lm7Vu+66rwX7iEbv21YUds0I6ZbFwVBNwb5fuqiRcxhjp7bZZGwWodf9KWxdHz9P97idemjW0VhrP/0OvxPsuJQaIT0tsLzegH7EOuj2ojj8SUuBIVA0DPUrxBZ5CcDvNTsptngSARLaR9VmGFYIajf8+XtZCR9+YoJTWM2ZUBjYhqqk7WWvs+KUHUXtaU3QtmSs39+TcJvh2sja4mJPVKbn6hNTGWcc4BxU6xY2Jtbk5PzmZowm4tF95BoueRDciJjUDoIJ0wnMR0ClHCwoOX5GW5F7lMrYDHmYQqtZIeuvImUR6uukRE+mvOsMC2wMOn6TgkPCFhRZ25gCOgWvQ/YIUvBvWl2/IJR5HnWjpIVKKtHVklISOCL/4h1+q6nmrHoAuL/HvTzNVaP8YkJ3J+9ere8aLykmdI2JjCNyuY3VfH+9/O1YvvGWB2XRptQvQziulUsb6nU75uXbpsq2U569ItuXQNctsu/fFa4ZSsU0n/aobbHPg3sn+Hcfh3Wyyy44yhVqnORyXZKwIO1UQH7RnvdPeaa1mf724/sL6V4N2+mO9qxZZyOkgQ4O+KwE8DGkYRHEsU5GIZ4wKjcLBBAMbkxJXmZDM5SdgUcN6SH2QKjfWasATIYGSrhIFXwa3Ln2pOmZc1lY2/D6zDne+agnff9Y58M86PrpobD3JUy5oBvCdaF62srv1eKfa1tHMsB0k1AJxw3w+5ga+6XSxoM9YtDV1kOGqZbkGghuAR3QGw+byADPyrvfz8S3BctlduBPD+hhAg4rf0Q9pdNhIO6x16avLm1vqO+VPVRjgtEfzKVU8/Hse/In/44vy84j7PYu+z4MUp/IC5wak8Xzpv78BBxTlDA== +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 invitation action' (create-invitation-action)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create an invitation action

+ + + + + +Create an invitation action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_pause_action. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). + +## Request + +

Body

required
    workflow_action object
    configuration_attributes object
    workflow_action_email_attributes object
+ +Expected response to a valid request + +
Schema
    workflow_action object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/create-ldap-action.api.mdx b/docs/api/nerm/v1/create-ldap-action.api.mdx new file mode 100644 index 000000000..0211d40e4 --- /dev/null +++ b/docs/api/nerm/v1/create-ldap-action.api.mdx @@ -0,0 +1,47 @@ +--- +id: create-ldap-action +sidebar_label: Create a ldap action +hide_title: true +hide_table_of_contents: true +api: eJztWW1v2zYQ/iuEPrWAY8dJu3YBBsztMsBD35C424fMMGjpZDORSI2k4hiG//vuSMmWbMWx3QzrhyZAIpHH48N7P2oRqAw0t0LJfhRcBKEGbuFDxLNeSINBK4jAhFpk7u0ieO8IGGcJ0jDuiNpsMAUWqyRRMyEnzORZprSlRzW+hdAaNhNJwiRAxKxiY2B+n4jx2IJmdipMwYvhUzn5YjYV4ZRxDcwKt3QCdor094KzmdJ3MW448utGInrJTrZG8XCx0ilo09qa0yoB47AbaMKc5sZWsSKjGtLiJCrNEkCRvOh96ZuC6BGOUlk2B8sELUlBItcWy5H2a/9lG0Vt+cQEFzdBibTYyQTDVqDhnxyMfaeieXCxcK9CA+rM6hxaQaiQm7Q0xbMsEaHTaefWkNYWgQmnkHJ6svMMUI8eEu6ZabIAlK+h2Q0ZHbBARBViYzWeG4lJ+BxRBXmOBK0t2HXjIjNand1WXwqRjyFRcmJQ9CQueOAkSFx4fh6fvjmLopPu+fjVyasudE/eAj896f4Un/HXP49fvwnfBsuN7bbRPo2uMsJU3ISxDmzlLu/RO/hYeVcjnWukD1Uu7dquULKxSKBNSLkOp+IeqkIdKzRY7l0y5nmCYo15YrZw9htxkWOVTBnuiLZYg+pY4cbGKg0jv+XTEgKZp2SxH1TIE5z/DSdD5DAnk63DIkzEjuTmNqlLynNAABRYShclOXk/HXGLGMa59Wa32yj3s8VteCI6zqwI4Z4O0LRpaUnE5hgAS4SwGdzueZLDaJyLJMLg911LbzuSf6sgd7rkvrBqEnwGUI4fK/gdBylTRmzELoFhfwK6igWHzs8awZTrGyGxlY3UwHUbzSsq/Xw00SrPvm8DW4P9di2ueB0HxUlrhJkAkp1ILDzYRiSOAXMM6gh6USrkeouoMcHtyz/a8Bk3SoEG+VthfcBeF4nLpZ/SYDIsV7yWz05P6V99i8uHDMWHGagkpSqKkyEKGnMlTvCjmnnmaqaxTDimnLnyLBkqRStUGou1ShnHWoLKclfVYGnBCytCjjRE1b/FMp4Z1L2IRVgkOgpofLJv4nxa1sSsUc5mqvKEzEseHXl5FI0K88RkwM1IzSRG3Z3FWRPOojZbsSqxYSOBW1BDZByBY1+qpKgL661T7Ry0FaJEpxDJOhQfLNlH7WTF0lVu1NIQLrcd4UZnXnU+z5N8i5N41rWcwrXm8ybUwkJqng56m37jzlc7Cex3lpvgVk1lpODXCa1uYyOI07dcQn1siDtKmI2M5TbfA+BeCkGGzDNcYb32r++nXE6e0AKF7Xtosb7kxdNnyT4Ap6cBaEwkZGH/bxtyJ7KMjxN41p1XXHdtXYjfjFB7aZGFngdByRljYcH7cRyVTPtXwWYj275qSrDveMSufHRhJyyX7rAYOMprivYh2VVJ+ByjpW+nzRJaX7rU/QctXbYep/uTqNw2l1orbYLl0B/iddMh+ohPS0wv16DvMQ66NXgcDTbXkgwHW2iJhh4l+AIPIbiV5qDD7a4EgLbcRtZjKUYISjR+fLyKhY6+6mTXSus5MyoFbO6RakbqnmnM+IUG8fQ0p+jeDStzh4HbKb51NgoX06k0xQbpjJOLcarJNZaSwdTazFx0Ogs8PJf2E09h2ZaoQESj5gAUijo8EwE1NlqQWfhYtCL3hy2sOuBhCqHaKhEHjpxJpMdUZcRE+iu9MMfEkGJGxGMNCV+Ya2HnDuAYuAbdy+loN8Pq9DUpw+OoEq10Q4ei0zoycj9HhCP+4fcybg7UHdB9HP79Za5y7R8DkjDp/Wp9dXZZqqexOKyVf/vlqkfvRw+68KkG2iKgVO9hVtcre92NHAJ+dXNxdLe+86LhEChN1wD7rt3u1fdduW6pu4e3uQeZSa0J3XdVrV8serxqi7fuzLAAkrEiVBQZvDF226ft00oU/nR59ZH1vvS33RojWDnJQk6tCZmsc220WirvMNiyVEUinjMKIApLDcxk6Gw4y4Rkzu9A3guMcJTZyKgx+gL2eARKuggTfOwPnFtSvEu5rMw0fVjYxLlYR/cfHyL+0w8RPuxQPdrJEu4vFlyiWRQ56mbTV0w9PLlvFlPKaki6WIy5ga86WS5pGKOxptQwXOcilxlwAfCI2irMGncwJy17fZ8MCFDh55SdNjM71R5+RS+kamAn7bCSeL98vh5QQik+q6CF0xrNZxQc8e9F8Df+4ovyJYb79kLjiyDBQjvHUgBpPF/6+RcjnmCQ +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 ldap action' (create-ldap-action)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create a ldap action

+ + + + + +Create a ldap action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_performers, workflow_action_roles. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). + +## Request + +

Body

required
    workflow_action object
    ldap_action_user_roles_attributes object
    workflow_action_value_builders_attributes object
    workflow_action_directory_groups_attributes object
+ +Expected response to a valid request + +
Schema
    workflow_action object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/create-login-workflow.api.mdx b/docs/api/nerm/v1/create-login-workflow.api.mdx new file mode 100644 index 000000000..97329bd46 --- /dev/null +++ b/docs/api/nerm/v1/create-login-workflow.api.mdx @@ -0,0 +1,47 @@ +--- +id: create-login-workflow +sidebar_label: Create a login workflow +hide_title: true +hide_table_of_contents: true +api: eJzFWFlvGzcQ/ivEPkvWYTuHgD44rYu6yGFYcvOQCgtqd1ZisktuSa5tQdB/7wy5FyU7ttGHJkCyHA7Jb4bfHNQuUiVoboWSV2k0ixIN3MJHtRbyq9I/slzdR4MoBZNoUZIW6vzqdBhnOamx+07P8rWJZt+iRmSi5SDS8E8Fxn5Q6Taa7dxQaMDDrK5gECVKWpCWpnhZ5iJxYEbfDZ21i0yygYLTl92WgKer1XdILB5WaoJuBRiabVE8q4mjTOQQk1Ys0t4CY7WQa1yQKV1whBRVFSoMjjCH/lhsgNWbMtqJWRQ0eBhkGaIwJ7gNPPCizOmk09Ns/HaapsPJ6epseDaByfAd8PFw8iab8vP3q/O3ybtoP0BE3FbmMYggq4JcfSn5KgcC+Zsw/nP5HOCvG0CIminNpLIhXGEY+C1pOq33DNE3ZyLA6nEHPu8wXMhUFpwdHlJsY9ocz5C8gNcf8hlXHZ5weEArx1OUW2ie5w88lMJHTGxFgEwgk9eg+wRC0ekUBYWQoqAbmxzivDXoatT30TQquTEIK2UaDFg3cb8B6cxo5+5FnjOHAwKnTfb4B8NQWGdhGMb7vZ/FjUs01BszHY/pvxDS5UOJhoPD4FSZVRjudzwXJHPhHP0PkfvSYOXpF5lvPS2e5iheyUeQa7uJZqdTHPKH/vBolwbmi1LGvk17oF+/wKs+HfNIGSLZZ6izTjvmSQLGuOFyP2gz3cv89pOktsGs0GYIZI5BHU/ClQ8u3BHHdnPCyGfswtMBk4Qj8G2ZUsHoqkKArR9yXGu+RSzCQvFo2jvy2pOozX+G/YHbZBOifj4f81LE9U3GhqJjQMGh1Z3L0RjAYi39p0UbEbdcx1bFuLG2cS9PXdwu/hjOFxeL2/kkHE7D4Wk4PAuH5+HwTTh8Gw7fhcP3hLJCcD3UK/JJnCjKN9ZJMMoTcmSMLovTyucBjFecyZXxKn11VWlKnTztj+ABM0lfgGGA8Ykb9WSVoxExtT0FXW1U7n2bceELYVblSAD/LeSdsD5Z17eRp7yM6UJE6jQkkLslgUCUagsQ+yYoPRT7873Yiky4zxJxk/X+knneFzm3Ff7YRhjafyht/XA40ffH4Vzrl3aC8FNAdKLaJwdgyBe9oTcrOVzbhKqBvM7K9URXCjrJnXD+bAQ+YOJkw+UaArnCyk1bJ5BWuj+FEbX2VbSRdAaSOnrVRVwDyxGwpWQ3YWrA4IvC9+7T51n/TXjdp1HIi4PIdVGJMHtxGRjk1h1bUsl+yNxz4aIcb6q3T1tOmp2W/d6ki5i9yxRarCoLjzYnSCRBF8bz66BYhglq39sd55Bncbut67NmzjKRMJqjGEOPH6mMJ6PJ+Wg6no57/vdePtK9rosH9WFUbavcCjw+fsWywRywx0hZIFtshA5FdSvitsEc9MTGVBWPwLxmXYOmE3go3cZB89X0XXNfd9r26+yxjusDT9mN5x4bssr119R0NTw4eU27pSR8ybAWHXOlwXYlXS/3Jy3dD57W+4u03DGXWiuNJXDpjTh/zIgrxKeRh2wO+g594tagORpspSU9KCSahnRP6XUBDwn4lvtVxj3Tm9ORx8guWIG3wNfAvHxFhZ86aq/fj7y50nrLjCrwieTaA0TF7rWiGGqukOYUcaNUPvtx6hqjUdsqjFwvH3etA6YJ5xPjrqXSOapvrC3NbDTaoeFcWmLQ/gQLTlNvTvDyR9hO4OI7rgVRwgd2q+4NzTiymXqnpECCHjdyTp3RI4o1WclRq8LMVWCeRZOWhC/BamK3DuAKuAZ9UZFZ35b96TldhMfRV2rvhYwia50ajr0SNQ7u4/emfVuoH/SooX9/2WId858ReZfu/Kb7zeCyS1v9l8LRK/5lb+quheu9nH2g1w/O5r0ZvA+D5+HRA3DiWCFkpmiartm7fnIyPhn3wunz5c0ndnF99Wiz3UyyhEvqTyvj78n39AyjhhUqFdmWERtUZeh1hp7DWSYkc04E7HaQqlTlKagwjABfbwSqtunT1cL5mIhbcNmbefpHnQDqrovUn/0O5MlApWRU5lxI91MBsX5XB0v/NyIEehAuSLgNhRaq7XYrbuBW5/s9iZEWmji67ILCURQX4IMNmUb0/QFbgueBDhcEhtTzyj0xDtMLJUC/4iKhlPRT3WUv+q+/zBfE7PqHLbwdWqM5eYD+nUV/49+QO06+i3Ks+RXmI9Tx+9KffwGAz9+j +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 login workflow' (create-login-workflow)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create a login workflow

+ + + + + +Create a login workflow + +## Request + +

Body

required
    workflow object
    options object
    = 1`"} schema={{"type":"integer","format":"int32","minimum":1,"description":"Used for login/password reset for when the password will expire.","example":1}}>
+ +Expected response to a valid request + +
Schema
    workflow object
    = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
    attributes object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/create-notification-action.api.mdx b/docs/api/nerm/v1/create-notification-action.api.mdx new file mode 100644 index 000000000..61c8ae186 --- /dev/null +++ b/docs/api/nerm/v1/create-notification-action.api.mdx @@ -0,0 +1,47 @@ +--- +id: create-notification-action +sidebar_label: Create a notification action +hide_title: true +hide_table_of_contents: true +api: eJztWG1v4zYM/iuCP+etb7tbgAHrHTogw649NNn2oQsCxaZjtbbkSXLSIMh/Hyk5OSdxG6crsH24HpCzJYp8KFIPKa8ClYPmVig5iIJ+EGrgFm6VFbEI3fB1SL9BK4jAhFrk7q0ffHaCjDNZkWV8I2z5zAT9h2Ch9FOcqkU5Y4JxK9DwdwHGflLRMuiv3KvQgNatLqAVhEpakJameJ6nperuoyG7q8CECWScnuwyB0Sipo8QWrSZa/LFCjA0u7E8KTE1XyCiirCxWsgZCsdKZxxRBUWBAq0D2LvbM0qAbX231RcPh00hVXJmmFUdVAbPPMtTsndxEfc+nEdR++xietm+PIOz9kfgvfbZD/E5v/pxevUh/Bis98wdoj2OrjLCVFyHcRfYEGS0H26rcGSmVZGTisKANh0ChwES6YRbRDMtLJy8ozFPTS3orUpmrCI1Drczx3gUaTCGodrj3jTd5tITr9rnSekG15ov61ALC5l51V8Lz/Yghs6/HU+gmS8PwaNKZKTg5xmt7oQqw+lHLmF3bIwWuQ4TMYdqOKZKpcD9AY95kdoXtn9QmyNMGLZRyhAspscOOKcKDe+dxslehpjjx7NZDu1iJsAielvk9xG/3X6j43VaQv57ME7P2yB4s4fmQRYZpePQchlxHd2QCSL8Qxy0lJDUoNhdvcY/tCism6upS+u1F8EDk2N98bly3uvRf7t2b55zzCtM042op685TwWNuZoUfC8/71x+XqTyU+vPvVfJMChaYdBYrFXGOBJOAtrVHuKf/XLEFsImOGow9pQ6TCPbuRqV89nphemlvSZltftsElWklF4yAv22rcZqMCnTE/SEm4laSNCvM3gdzpLAt6o22KZABQfPBTdOwKnfhAT3OhapOyoo57vDXUIlU99L/v+35EtYTIzltmgAsFFAUCHzCrdYh/71c8Ll7EgUiLbn0GIDycunO8l+A05PI9CZkJRhwX/Zq5gnked8msK7Wt5qfc10uf1mgtHLyir0Pgg2mpELS90v46hU3D9LNXvV9rKuwH7iEbv37MLarJDOWSQOtIfKLXROqa5Kwl2MmX5YNjfQBtKV7l9p6br1stwfJOXM3GittAnWY+/EVZ0TA8SnJZaXIeg58qBbg+5osIWWlDgSXcNEj1J8gecQ3EpzknOvdwJAJg+RXbMMGYIKjR+fbrnQye/0UErrJTMqA5uQ1ILCvdBY8csIovc0p+jKnyvX9+TcJvjW3WtcTLd649sMorxx+2NciAqd4tLE2tz0u90VbgKX9pZnsO5IDCSiUksAoqQuzwUunnMtKD08J23FvdNldgc8zCBUB33syIkzifJYsoyYUVQozQosEBlWRnRvTPjCQgu7dACnwDXo64JcfBhXp4cUFI+jKrSNETlF3joxOoZOCEf8wy8b/hypJ6ALMf7+tFSF9o8B7TTF//7bN4+bTZhqm8SdNrBZzdrfoMY39fqq3dToQZ1sXJWq3F5yWJP74Sng6m5vpzl2yooyVw6uLtgZyFgRdjoqPjpnnV6nV6Gn25v7L+z66+Awz/FobyZZyKlnp8C5XOdhSH0PmmOZikS8ZHSiFNZgDAZmH84yIZlLRJBzgUefKJ9CjrQEePkhUNIdueDLYOTylIgg47Iyc+Qj394lYEt/Rz8O+u2ilqObp1wQf3sOWZU09LAfQGKcWiLCZEqIwHDJajXlBn7X6XpNw3jgNJ3+8Te6cYcfFwCPqINGYniCJeH1yNsjAkbiaeH6vX0SpzLjV1yHRPyvyo4rHPv1bjgizig/eWLMaI3mC2q58Lcf/IX/8EX5auK+i9L4KkixpyqQ9VHG66W/fwB5uHb9 +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 notification action' (create-notification-action)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create a notification action

+ + + + + +Create a notification action + +## Request + +

Body

required
    workflow_action object
    workflow_action_email_attributes object
+ +Expected response to a valid request + +
Schema
    workflow_action object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/create-password-reset-action.api.mdx b/docs/api/nerm/v1/create-password-reset-action.api.mdx new file mode 100644 index 000000000..af9164beb --- /dev/null +++ b/docs/api/nerm/v1/create-password-reset-action.api.mdx @@ -0,0 +1,47 @@ +--- +id: create-password-reset-action +sidebar_label: Create a password reset action +hide_title: true +hide_table_of_contents: true +api: eJztV9tu4zYQ/RWCz77l1t01UKDZRQq46O4Gids+pIYxlkY2E4lUSSqOYfjfO0NKXt82cRYB+tIESCRyODwzc+aipTQlWvDK6EEq+zKxCB6vwbm5sekNOvSXCe/KlkzRJVaV4a0vPwVJAaKshYVlaQGNuIepk/07SXsPWW7m9Y6To5a0+E+Fzn806UL2l+FVWSQA3lbYkonRHrXnLSjLXCUBYPfe8c1L6ZIZFsBPflEiYTGTe0w83VlaNscrdLzb3DyuMR1/QKUbws5bpacknBlbAKGSVUUCrT3Y2w4azlCsbfebLxGOmGBu9NQJbzqkDJ+gKHO+7+ws6707TdP2ydnkvH1+gift9wi99slP2SlcfJhcvEvey9XOdftoX0a3sSJMdgjjNrBra4rSB7nKoSXgdcxpRdk1EToMDmwyU4+46ceJMTlCZFIGVU6ezCB3e9AGB6EI5USjVBgrtPFb6IKqFd3slY9oD5B4FX7YN64kKsaon/Z6/G8bxNVTSQzBwOogytaCeIRc8Vqgr/yfqW/M1IN8+BGq3kSVgoJiDQVNZMRdAUSaGRE3sJc4BGJqTVWyRl5yYq78jFYdxV5lKhGWGBvoXMIU38zXrOygn93MVDnTS6dof8zVkKbjmp5ox+DGZq7RPp+Fh3DWSbhW1WCbkE/TlPICXBAI6puQkK8zlYdUIbnYS9ItO/gqQklJofIxePLhpPKv9+x3ebJWKZw3rCbgCtcxbkpmJ0jtywQ61t+1JVF1zM3aDLAWFodQK4+Fe9Zej09+L2+CfVuW4HG23Ml7M9OpwV+mfLqTmIK270Hj9tqIbtQ4HzsPvjoC4FEBIYUiKlxjvY2vn2agpy9Egcv2I7bEQEP99FWL3xH4aYi2UJoZ9h/2m5Z0D6osYcJLb3jzWutzV9fud2OKXlF3obdB0GimWljrPqrl/lWr2em254ca7EdIxU2sLqItKh2MpcJB95Fyj53XdFej8WtGTN9vmw20gQ6t+zc+ump9X+5PlgrXXFlrrJOrUTTi4pARA8JnNbWXW7SPVAfDGTLHoq+sZuJoMo2Inub0gk8JhpPuVcY9PwkgX7mP7FIUVCG40cT1yboWBvnNJLs11i6EMwX6GUvNOdxzSx2/jiBZz3uGPxBKE+aeEvyM3ro7g4vrNkPgOEyGzTKdcMFDLgSpsjkdnnlfun63uyQ3gPZfoMBVR1MoCZdZIHJR6kKp6PAjWMUEiVVpLR7NrvktISkwMXsfKsMgLjTJU9NyaspxYaJV1CIK6o1k4IjxJZVVfhEAThAs2suKjbwbbW7fclgijk2hdZTYKLY2iHEiBiFaiQ+/NhV0aB5QEwz6+/PCVDY+SvY1M+Dm2wfSVROog2Pi1iB4XNfaddDRY/1mlV3nvtKZYSAc3KjvpNPr9DZS6svVzWdxeT3Yjwzd2GyKBHjOZAQhOpAk3Kspc0RhUpUtBHPAUN8gbOQv2hVKi+A61I+K6MplikFSKiEN7AxKB5LIz4Nh8CyTtwC9sfPiV+zO6LpO2iO+fyMhuFV2yxwU153I/GWdPne7AXUhsw4mEFFwxqlHh5bLCTj8w+arFS8TUSyzdvQtTQJp6QBCyrMfEfoBF4w5om8PGRqL51WYVHbLDxfIeOIy4ZL1rOxoozpcf70dMtfr73qKHJ+xMOdhgf725d/0Sy8m1sHw8c/rS5nTNFBRvSKZqJd//gXL5s1n +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 password reset action' (create-password-reset-action)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create a password reset action

+ + + + + +Create a password reset action + +## Request + +

Body

required
    workflow_action object
+ +Expected response to a valid request + +
Schema
    workflow_action object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/create-password-update-workflow.api.mdx b/docs/api/nerm/v1/create-password-update-workflow.api.mdx new file mode 100644 index 000000000..51dd4c72f --- /dev/null +++ b/docs/api/nerm/v1/create-password-update-workflow.api.mdx @@ -0,0 +1,47 @@ +--- +id: create-password-update-workflow +sidebar_label: Create a password reset workflow +hide_title: true +hide_table_of_contents: true +api: eJzFWNtu4zYQ/RVCz45vSfYSoA/ZNkVT7CWIne7D1hBoaWRzVyJVkkpiGP73zpC60XY2CfrQBEjI4ZA8M5wzHGobqRI0t0LJ6zS6iBIN3MINN+ZB6fSuTLH3VekfWa4eokGUgkm0KEkdlX91yoyzstZnGgxY9tBNsHxlootvUSMy0WIQafinAmM/qHQTXWxdV2jA7a2uYBAlSlqQloZ4WeYicfBG3w1tuo1MsoaCU8tuSkAYavkdEoublZqMsQIMjbYontXEXiZyiEkrFmlvgrFayBVOyJQuOEKKqgoVBgeYQ8fM18DqRRmtxCwKGjwMsgxRmCEuA4+8KHPa6fQ0G7+dpunJ5HR5dnI2gcnJO+Djk8mbbMrP3y/P3ybvot0AEXFbmWMQQVYFufpK8mUOBPI3YXxz8Rzgr2tAiJopzaSyIVxhGPglaTit1wzRN3siwOq4A593GE5kKgv2DjcpNjEtjntIXsDrN/mMs/Z32N+gleMuyk00z8cPPJbCcyi2IkAmMJJXoPsBhKLTKQoKIUVBJzbZx3ln0NWoz3K1EnK0Ry4aeFiDdGa0Yw8iz5nDAYHTJjv8QRoK6yz8SCu2fN7t/CguXKKh3pjpeEz/QkhXjyUaDg6DU2VWIe/veS5I5ugc/Q/MfSlZefpF5hsfFk/HKB7JR5Aru44uTqfY5Y/97sEqDcwXpYxdm/ZAv36CV32a8xgyFGSfoc46bZ8nCRjjuovdoM10L/PbT5LaGrNCmyEwcgzq+CBcenLhiti36yEjn7FLHw6YJFwA+4uFdbdCgK1POa413yAWYaE4mvYOvPYkavOfYX/gNlmHqJ/Px7wUcX2SsSF2DIgcWt27HI0EFivpmxZtRNxyFVsV48Laxr08dXk3/+NkNr+c380mYXcadk/D7lnYPQ+7b8Lu27D7Luy+J5QVguuhXpJP4kRRvrFOgixPyJExuixOK58HkK84kivjVfrqqtKUOnna78EjZpK+AGmA/MSFerLKhRFFarsLutqo3Ps248JfhFmVYwD4tpD3wvpkXZ9GnvIypgMRqdOQQO6WBAJRqg1A7MuidF/s9/diKzLhmiXiJuv9IfO8L3JuK/y2jTC0f1/a+mF/oO+P/bHWL+0A4SdCdKLaJ3tgyBe9rjcr2Z/bUNVAXmfleqC7CjrJvXD+bASeMHGy5nIFgVzhzU1LJ5BWuj+EjFr5W7SRdAaSOnrVMa6B5QKwDcluwNSAwV8K37umz7O+TXhd0yiMiz3mOlYizB4vA4PcvENLKtmnzAMXjuV4Ur112uukWWnRr006xuxcptBiWVk4WpxgIAk6MJ7fBJdlmKB2vdVxDOMsbpd1ddaFs0wkjMaIY+jxA5XxZDQ5H03H03HP/97LB7o39eVBdRjdtlVuBW4fv2LaYAZYY6QskM3XQoeiuhRxy2AOemJhuhUPwLxmXoOmE3go3cJB8dXUXTN/77Tl19mxiusDT9mtjz12wipXX1PR1cTB8DXllpLwJcO76DBWGmzX0tVyf9LU3eBpvb9Iy21zpbXSeAUuvBHnx4y4Rnwa45DNQN+jT9wcNEeDrbSkB4VE0zDcU3pdwGMCvuR+lXHP1Oa05SGyS1bgKfAVMC9f0sVPFbXX7zNvprTeMKMKfCK58gBRsQetiEPNEdKYotgolc9+nKrGaNSWCm0VH7sqPu5qCMwXzjnGnU+lc5y3trY0F6PRFj3ApaVQ2g3x5mkuniFGwQjrCpx8z7Wg2PAMb9W9xRnHsKYiKikwUg8rOqfO6DXFmvTkYqzCFFZgwkXbFoQvwWvFbhzAJXAN+rIi+74t+sMzOhGPo6/UHhAZRdY6Nex7JaogXOP3po6bqx/0uqG/v2zwQvPNiNxMh3/bfTy46vJX/8lw8Jx/2eO6q+V6T2jP+Prl2Tw8g4di8E48eAlOXHgImSkapmP2rp8Mx8Nxj1efr24/scub66NVdzPIEi6pUK2MPydf3DOkDytUKrINo2hQlaFnGnoOR5mQzDkRsOzBmKXrntiFfAJ8xhGo2qZP13PnY4rggsveyAs+8wSYtx13X/SJyIcH3TKjMudCuq8IxINtzaP+5yPi1hNMwlhcE/1Qf7tdcgN3Ot/tSIwRoyl8Fx1fXPTiBHzUYRBSZP+ADQH20E/mhIrU88o9Q/ZTECVJP+MyobT1U91FL0PcfJnNKejrj194cDRHc3IF/b2I/sbfMKycfBvlWBdUmLNQx69LP/8Ce5X17w== +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 password reset workflow' (create-password-update-workflow)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create a password reset workflow

+ + + + + +Create a password reset workflow + +## Request + +

Body

required
    workflow object
    options object
    = 1`"} schema={{"type":"integer","format":"int32","minimum":1,"description":"Used for login/password reset for when the password will expire.","example":1}}>
+ +Expected response to a valid request + +
Schema
    workflow object
    = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
    attributes object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/create-permission.api.mdx b/docs/api/nerm/v1/create-permission.api.mdx new file mode 100644 index 000000000..31db9d2ea --- /dev/null +++ b/docs/api/nerm/v1/create-permission.api.mdx @@ -0,0 +1,47 @@ +--- +id: create-permission +sidebar_label: Create a permission +hide_title: true +hide_table_of_contents: true +api: eJzVV1Fv2zYQ/iuEnqnYkiXFDtCHtMsAD2sTJNleWmOgpJPNViI1kkpiGP7vvaPiWJm9LHnYijmAIx2P5Hd333ekN0EJtjCydVKr4Cy4XUnLQJWtlsqxQihWGBAOWAumkdail2WVNuxXWUGxLmrg7APadC1LQWtwJlSJproWuTbeFPBA43T/PC9xk37Jq6cV0cGJpQ3OPgeDbYIFDwz82YF173W5Ds42/lUawDWc6YAHhVYOlKMh0ba1LPweo6+WYtkEtlhBI+jJrVvAjXX+FQqH27WGEDkJlkb3m/6zr9E1/CHLgaN1RqolOmJaGoFggq5DB36QWWCyZLpiDp9oGXSBB9G0Na0CVVom0aQKcxFNw2QGWTgTp3GY51GUChFNJlUVbHlgO4/rlRD265f5pJymUIXFJE7CJJ3mYR6PszCdlpALMcuSaHYU8/ynHeY+I/gonH/fp40haZbyDjEwURRgLXOawN6JuoMBTuQULMEMgaJpEhNS1TVIgIjHfMITnvKMny4GAUTHsA1JWcMd1AS1RzDI1ZsAjPkzCHzKZzxCY8SjmEcTHiU8SnmU8eiUR1MezXg85jHOiXk8GQIeHwNMMAjjgHFbBOqk80W6GprpQwqwLYbXky8ej+nf83UvHloMEkq2c8XkM8Ew95JsXkDBD9HK6ziKzaC8VPV6J+qXZNMOe8ae3DGMs3x6moVVkmZhcjopw7zM0jDPkkkK4zzL45II8aPF+xY9/HfEf3GnY4z9X3Who/IK4yeBJcc09V6U7LqXDgtZp0Ree1kVmgJxcPIWQWkFlxW2lkO57IDNlVfrL9Zn9+/9fhe7Y/bCGG2w1os+iPRYEHPEZ5So2Q2YOzDMz8FwDLjOKGwYmLJOrfC8rvEFHgrwM+2bgnu5AwBteYjsnDVYHrEE1ttzqhkVs/cfMuZGG7NmVjfgVuR1j6jYvdFItO2uhDSm6WLRat/qWuFW+DYaXiaQsz4L1heiMzU6rJxr7dlotMFQhXKfRAPbE4Xlwr31GuAEyz0SrQxIuUYSCXxUe/c+tEp0NdFdFA0U+pC/3p0p9GcC4Swp90SmzjqMy1AgC8JXdEa6tQeYgzBgzjsK5PNiOHxDqe9xDJ2eKkFBUbTeDd97J7T0Dz/vtHmrv4FCGPj9bq070z96vVCVr/c3r4tdMf7a/Z/a6esa4PO28dpe8Ngzo0FXGxNIqSpNIKimfZ6jk/HJeKCWTxfXH9n51fxoQ9kN+jtuDqyzfVEeOwddYhtdymrNqPS6s3S8YppwlEnFfMZA3UlkYoOUJM2gSgCPXwKlPDeCj/Nbn1DiZSPUYORDf6sWz0+0ZzA3exH+W9fyR8o4eHCjthbS93avjc2jiA5u5CuSGJo3m1xY+M3U2y2ZkSyGmLvYS8UTFyfg8Y78I1J/gzWF3kcV3tLmT/U9bDPUCPsZ5wW1phd9F4MucHV5c0t8f/zRgGWkOUbc02UDv8+CL/jnf5X4fuepTPZNUAu17LAvoU+/Ln2+A1mJbvw= +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 permission' (create-permission)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create a permission

+ + + + + +This endpoint can create permissions for Lifecycle, Consolidation, and Collaboration + +## Request + +

Body

required
    permission object
+ +Expected response to a valid request + +
Schema
    permission object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/create-profile-check-action.api.mdx b/docs/api/nerm/v1/create-profile-check-action.api.mdx new file mode 100644 index 000000000..f6b14af59 --- /dev/null +++ b/docs/api/nerm/v1/create-profile-check-action.api.mdx @@ -0,0 +1,47 @@ +--- +id: create-profile-check-action +sidebar_label: Create a profile check action +hide_title: true +hide_table_of_contents: true +api: eJztWFtP4zgU/itWnqGFuezMIK20zIiRutq5CLo7D2xVuclJa0jsrO1Qqor/vt+xk5JegDJC2pcFVBL7+Jzv3I+7TExFVnpl9CBLTpLUkvT03ZpcFfRpRun1acqbyUGSkUutqsLbSfIpEAopqkgrUiYWsqX2cuqSk8tkbux1Xph5s+OS0UFi6Z+anP9oskVysgyvyhLEe1vTQZIa7Ul73pJVVag0wOtfORa8TBwklZKf/KIiQDGTK0o9ZAIKlPGKHO+2kscNpv0PqKxD7LxVegri3NhSAlVS1yA42IK9bp/hjMRKd999iXDEhAqjp0540wMzupVlVbC816/zo3evsuzw+PXkzeGbYzo+fE/y6PD4l/yVfPth8vZd+j652xC3jfZpdJ0VYfJdGNeBfVY6cx2HT6SjTOCwowLmxLP0kD6pPYFMZ+JGFnCzyE2NF6WDBEfOBc7QQNp0pm6oa+yJMQXJGG25rAuYO5eF28I/2IlXKAhumApjhTZ+TYXACoI1jVdQ4WzXASCtlYs18+2Uf6pFoGTDbXJbE3m5nz9HQDWDzQoaRyCPObRBRLouWUBjUpCsYHCSbTs8ChDMGE6xYj6TXriZqYsMe1VFMGAOzwm6Vc5D6srVqvHiekC0gu+x706cJ2zZgaaynhA/ZgDSxQrpjagDeB1v+OvEEp/6iQwCaq98OLCj3N2FH8buKlStWCBeHR3xv3X4Z7dVjP6WFBmNLEHwK14LlS75v6i9cFF7MJKeW9XOI0sBp1gDp4ncmhJJYHDSitrhA6kixdSaumKOvOTEXPkZVh18r3KVCou6FYpaJacP5cHzbc3Mdtq5yVpLOiP7c6aWWTZuwpPsWLqxmWuyj9fiXTibUrxi1WKbwKZZxl0hZmtg37qkLSxIFdDFoWM9i1kUUCIpVLFWX59n2QfjZMVSOG+YTcAVxDFuJLMLRfLJANrX3o0mkTXt1XOUp9I9qq+nW7+VN0G/NU1oP10ukysz05mh36Z8upeaEttXUtP62ij00PnYeenrPQDu5RAwFJHhCutFfP2EZjB9wgtctm/oQAy0bJ6+afEHSX4aki2V5gj7T6cOd62qSk4KelHJK66PiW7M78bwXtl0oZdB0HJGLWx4P4yj03F/NGw2uu2bXQ32o8zEeawu4lDUOiiLwgF5YO6p95zuajR9yxHp222zhTbQoXX/7sJk8zDdX0wVxJxZa6xL7kZRibe7lBgAn9VoLxdkb1AHwxmoY8nXVsc5utZx6skwgKUUTrpnKff4JEAschvZqShRIbjRxPXJqhYG+m6SXRhrF8KZkjCGgWrO7p5bdPzGg9Ce9wzfJCsT5p5K+hne+huDi+s3LWAc7o3tKg64YCAXfFTbAmdn3lfupN9fwgpS+6+ypLuehicByyyIuCb1ZaVw+EZaxfERi9KKPGrdhHci05JSs3WjHQZyoUGPnuXUlN3CcVajQ5RojdBvxPjS2iq/CAAnJC3Z05p1vBx1ty/YKxFHl2jlJFaKtQ1knIeBCCvx4XNbQIfmGuOw589fF6a28TGMrxwA5/dX6bPWTzunxLU5cL+mtWmgl70AditxU3G272X7Xp82bk+dO1HnZrL/xUDp3LDROBCj7se9o95RJ/u/np1/EaffB9tRBB3bTZFKHol5ZAyRJNOUxwo2TWkylS8Ex6tBi0MFhW+xy2YKbiZ9o5BZXFHZVsh6wt2CQekQ0MmXwTBg5Twrpe7sPPXVzMaQvSovT3+nE43LPb1fFVKFq1/I0WWT55eboediGdqR6ewzLhE4s1xyKP1pi7s7XkZEW06v0X0+h+zCAZIZz6jIvGtaMOKI/XDIyJgcAccZvlkmuZDHE6cpl9ZHaUedKvb928WQk7L5qgpu4zNWznmowedJ8jd+8WJivQ7fZ/H6MikwtdSoq6CJfPnnXzqJuc4= +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 profile check action' (create-profile-check-action)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create a profile check action

+ + + + + +Create a profile check action + +## Request + +

Body

required
    workflow_action object
+ +Expected response to a valid request + +
Schema
    workflow_action object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/create-profile-page.api.mdx b/docs/api/nerm/v1/create-profile-page.api.mdx new file mode 100644 index 000000000..f44e1d754 --- /dev/null +++ b/docs/api/nerm/v1/create-profile-page.api.mdx @@ -0,0 +1,47 @@ +--- +id: create-profile-page +sidebar_label: Create a profile page +hide_title: true +hide_table_of_contents: true +api: eJztVttu2zgQ/RWCz75tmrgLA/uQtlnAC7QJErcvrVFQ0shiQ5FakrIjGP73zpCRpdhOirwWtQFbIs/czwy55aYCK7w0ep7xGU8tCA831uRSwY1YAR/wDFxqZUUYRLwPCCZYFUGsiigvVo7PvnJ6dXw54Bb+r8H5dyZr+GwbXqUFNOJtDQOeGu1Be9oSVaVkGpwY/3BkZctdWkAp6Mk3FaBdk/yA1KMhtIsue4lWcDdY/yWqllkP5LyVenUU2aIAhkBmcuaLfVzwIMpKkRgtfCdNuwPJvWIPD/6JCGWQ5cayjbH3uTKbk0Z7K0+Mox0tSjjleWfiY8OClU+EPKWdVByqFTYt5Br6SUmMUSB0X3culINDlR/Agy2lBsc2BaBSu9fMpGN7zTs046WPaejxaRc+RA9XGe1ifc4mE/p7aunqocJaQsZaKPMGebcWStJaYBf/Q6TfnkgDfjrpmI5SYN15TbkkRonsWqumnTDHEXQ1Idkn0Z/BZJr8/XY6zM8vpsPzt2+yYZJNL4bJ9PzNBUySaXJ2wOkw51o2n58i8DuRsdvIUzZktRaJChxODRn1MHoNe42G6xwH7DFDW4/mOrTGfyS6GzyP+0KoYObKWmMxiGUM4uJUEHP0z2qh2B3YNdYoyGA4FnxtNXYncq3WhdCZwhd4SCFIulcF93LTAZk89uySleAc0SWuJ0iLUNyI71f3zljbMGdK5BmhNugV21iDPNq1JaQ9Q2dgZcJcqYQv8G0cDrTx42n3PR5vA+5CNlwoSG0VAgvvKzcbj7cYstCe2mg30lg29ME0ACMs+1hUEoXXwkoiQ4iug8cQc1ErYrVIS0jNcScGeGxG4ZxcUQ2IVLXzGJ+lgJbkX1pb6ZvgYALCgr2sKaCvy/72HZUg+tEH7StCQVG0AUbNHUC4Eh/+bVtwYe5Boxv4+09jahsfQ8NQtW+7u8BVW5Ru5Iah2k3Fw4hPzb44zg5nVjeNwsQh61LnhmxQsaK6v0aT0aTXDp+ubj+yy5v5yZnXbrJUaJbgWHcx2yJNkXsMWc9Kk8m8YVRTUzs6rDB+3GVSs5AK0GuJVCuRc9QU2AaAhxk51UYxX4RMEfFKoXs7z122Dk6NfZ89fzvrzpVxpYSkCRF5u30kentzC83XozqSpaCGQMB2mwgHn63a7WgZS2qJX8uO0IFeKICTGFlC1LuHhtyKDg4X5AbBVU3uHA0FGltR4jKlQfIidtnr2ZvruwWx8vGyiTUhGSuIK/Q749/wiy8mTqdwI6X1LVdCr+rARB710ucnzNHTvg== +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 profile page' (create-profile-page)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create a profile page

+ + + + + +Create a profile page + +## Request + +

Body

required
    page object
+ +Expected response to a valid request + +
Schema
    page object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/create-profile-select-action.api.mdx b/docs/api/nerm/v1/create-profile-select-action.api.mdx new file mode 100644 index 000000000..e754c1b0b --- /dev/null +++ b/docs/api/nerm/v1/create-profile-select-action.api.mdx @@ -0,0 +1,47 @@ +--- +id: create-profile-select-action +sidebar_label: Create a profile select action +hide_title: true +hide_table_of_contents: true +api: eJztWNtu4zYQ/RVCz77l1t0aKNDsIgVcdDdB4rYPqWGMpZHFRCJVkrJjGP73zpCS49smzjZAX5oAjkUOh2dmzlyUZaRLNOCkVoMk6kexQXB4Y3Qqc7zDHGN3GfNu1IoStLGRpX/qR5+9pABRBmFhvbSARtzB1Eb9+2iuzWOa63m9Y6NRKzL4d4XWfdLJIuov/aM0SACcqbAVxVo5VI63oCxzGXuA3QfLNy8jG2dYAH9zixIJi5480NV0J2Ehc5xEy7vNzeMa0/EHZLIhbJ2RakrCqTYFEKqoqkigtQd720HDDMXadrf5EOCICeZaTa1wukPK8AmKMuf7zs7S3ofTJGmfnE3O2+cneNL+iNBrn/yQnsLFj5OLD/HHaLVz3T7a19FtrAidHsK4DSzwwcvVQSfwGTix0JWYg6ItLUylaFHaZ1Xktg7jBRNncoabrp1onSMEcqVQ5eTcFHK7h3ZwEJ2gWxqlQhuhtNsC7FWt6GYnnTfgEK9X/ofdZUtiZyDCaa/Hf7ZBXD2VdIyuakTZXBAzyCWveUZH/5P3ncl7kA/fw97boFJQUIymoInU6EIAkSZDIypLH8QhEFOjq5I18hLRWLqMVi3FXqYyFoYY6+lcwhTfzdes7KCfbaarnOmlEjTf52pIknFNTzRjsGM9V2hezsJDOOskXKtqsE3Ip0lCeQHWC3j1TUia7kCpQnKhvSRbdvBVhJKSQuZjcOTDSeXe7tlv8mStUlinWY3H5a9j3JTMlkvU6wQ61t+1JUF1yM3aDDAGFodQS4eFfdFeh09uL2+8fVuW4HG23EcPOlOJxp+nfLoT64K2H0Dh9tqIblQ4H1sHrjoC4FEBIYUiKFxjvQuPnzNQ01eiwGV7hi0xUFB/u1biNwT+NkRTSMUM+w/7TSuyj7IsYcJL73jzWutLV9fut2OKXlF3ofdB0GimWljrPqrl/lmr2em254ca7CdIxG2oLqItKuWNpcJB95Fyh523dFet8Dolpu+3zQbaQPnW/SsfXbW+LfcHS/lrrozRxkarUTDi4pARA8JnFLWXOzQzqoP+DJlj0FVGMXEUmUZET3J6wKcY/Un7JuNengSQr9xHdikKqhDcaML6ZF0LvfzWpKeNWQirC6RRjqTmHO65oY5fR5Cs5z3N7wyl9nNPCS6jp+7O4GK7dQsYhxeEZplOWO8h64NUmZwOZ86Vtt/tLskNNE9+hQJXHUWhJFx6gchFqQulpMMzMJIJEqrSWjyYXfM7grjAWO+9uwy9uFAkT03LyinHhYlWUYsoqDeSgSPGF1dGuoUHOEEwaC4rNvJ+tLl9x2EJODaF1lFio9haL8aJ6IVoJXz5pamgQ/2INDvz5080UZvwNWJfMwNun9+ZrppAHRwTtwbB47rWroP+zaS/WXjX5UCqVDM2jne44qTT6/Q2suzr1e0XcXkz2A8WgWg2RQw8evJo5gMGccztm5JJFDqR6UIwLTS1EqpU5ELaFVIJ701UM0kM5srFICm7kGZ4BqU8b6Ivg6F3NvO5ALWx8+q77s40u87jI96SA0e4e3bLHCSXopAMyzqj7ndjbEPCH8opYmXG2UiHlssJWPzd5KsVLxN3DBN59Jw5nsd0ACHhcZA4/ogLxhzQt4cMjcXzyg8vuxWJa2Y4cRlzFXtRdrRRMG6u74ZM//rtnyLHZwzMeX6gz370F/3Sgw6l0f+LgNeXUU4DQkUljGSCXv75B3Oa2jQ= +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 profile select action' (create-profile-select-action)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create a profile select action

+ + + + + +Create a profile select action + +## Request + +

Body

required
    workflow_action object
+ +Expected response to a valid request + +
Schema
    workflow_action object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/create-profile-type-role.api.mdx b/docs/api/nerm/v1/create-profile-type-role.api.mdx new file mode 100644 index 000000000..932f11853 --- /dev/null +++ b/docs/api/nerm/v1/create-profile-type-role.api.mdx @@ -0,0 +1,47 @@ +--- +id: create-profile-type-role +sidebar_label: Create a profile type role +hide_title: true +hide_table_of_contents: true +api: eJztVt9v2zYQ/lcIPlu265+ZgT04gwt4QJMg8faSGQUlnSw2EqmRVBJD8P++O9Ku1djNmhXFXuoEtiR+x/vu7rsTG56CTYysnNSKz/gql5aBSistlWOJUCwxIBwwwSqjM1kAc9sKmNEFdNnV9WoRsVWOy7EspNsyp/F/s0HYvCj0U++y0MkDwz1TrdA0N7re5PgL7Ga/3Qq34x2uKzCCSCxTpBGc7iGEuEV/iHJiY/nsnh+4HMlYvu5wA3/XYN2lTrd81vhbaQA3dKaGDk+0cqAcLYmqKmTiHfY+WQq94TbJoRR0RbsiCx1/gsShW3SH9JxEL7iaaVP+O2pP8SOhPsq0ZWCdkWqDBi9TD0ymTGc+Pe1sIxSeRVkVZD2AeDydDrNoMLqYRKPxIIviNB5G018m74bDeNi/mAz4DnOBSfkPfk1I9Fv9oUMnnTd4UTWLi/Sh6thKKxvSM+j36edLKovnClMJKTtASU+CPYpC0jNfXP6zjj+wjh3+fSGe89ufxBfTSZSNxuh3OkzR72QcxZPRcAz9eBIP0lf1Ew0+K2h0TjSXImW3QRssYrUSceF1k2hi4KD7FsXglLrOcMKcquJAb6m8HH8n013n67g/CeXdLIzRBttgHYIYnwtiifyMEgW7A/MIhnkbDMeAq43CjtAKQ8uFSgu8gecEvKV9U3CvCx3I5SmzOSvBWrEBFp7HKAhf9oBvl/pOG7NlVpfgckI9ISv2ZDQqaHcoIa1pGvGV9r1cCZfjXe+LNgsDvcOtT4b19ahNgbjcucrOer0GIxbKXYkSdl2FVUMKegvQxar3RCXR+FEYSVrwwR3hIcJM1AVmjIukhESfCtzDmUI8E9bKDZWANFVbh+EZimdN/JLa4GvPE4xBGDDzmuK5X7eX76gCgUcb9LkgFBRF62F4H0D4JFy8xzkliOxKP4BCGvj961bXJlz65qFi3x7ffotDTY5T7mSOfdtEaA2gb38VSJVp8knFCwl91+13+63uuFrcfmDzm+XZ0XJY9OePGFhtQ/ZFkqAUGTYBK3Uqsy2jGuva0vsC84GrTCrmUwPqUaLySpQg9Qh2BeD7hEgpLwL+YbnyXEmHpVCtld++euJ5ybY59t7/d3Lai8jBs+tVhZA0lkK3NPvuuudnugv1mVML4mrTxMLCH6bY7egxqsiQpNfHHvKKRgMQKQqT1P4AW0pVCD/aU8HJWBOXkzFEgzJYzBMaXa9i160pcXN9t6JG2J/osOxkY8QTCRO/Z/wv/PPnRz8P/bGPnje8EGpT49xCTNiXPv8AlVK0rw== +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 profile type role' (create-profile-type-role)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create a profile type role

+ + + + + +This endpoint can create a profile type role. NOTE- The ability to toggle Allow/Block is done through the Profile Type + +## Request + +

Body

required
    form object
+ +Expected response to a valid request + +
Schema
    form object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/create-registration-workflow.api.mdx b/docs/api/nerm/v1/create-registration-workflow.api.mdx new file mode 100644 index 000000000..e4306564d --- /dev/null +++ b/docs/api/nerm/v1/create-registration-workflow.api.mdx @@ -0,0 +1,47 @@ +--- +id: create-registration-workflow +sidebar_label: Create a registration workflow +hide_title: true +hide_table_of_contents: true +api: eJzFWN1v2zYQ/1cIPdvxR5J+GNiDu2VYhrUNYmd96AyBlk42W4nUSCqJYfh/7x1pSZTtNAn2sARIyOOR97vjfVHbSJWguRVKXqfRJEo0cAu3sBLGevIXpb9nuXqIelEKJtGiJCqy/upYGWc64GYPLbvlKxNNvkY1yUSLXqTh3wqM/aDSTTTZuqnQgKKtrqAXJUpakJaWeFnmInGnDr4ZErmNTLKGgtPIbkpAEGr5DRKLwkpNilgBhlYbFM9y4iwTOcTEFYs02IAqCbnCDZnSBUdIUVUhQ+8Ic9cs8zWw/aGMTmIWCTUeBlmGKMwZHgOPvChzknR+ng3fjtO0PzpfXvQvRjDqvwM+7I/eZGN++X55+TZ5F+16iIjbypyCCLIqyNRXki9zIJC/CeOHi+cAf1kDQtRMaSaV7cIVhoE/kpbT/Zld9LVMBFidNuDzBsONTGUd2V0hxSamw1GG5AW8Xsgn3HUo4VBAQ9+hGCuso3sv/9Iu0Q9JM6WSxvvQeDikf12JV48l3jQarmZlVmGw3PNcEM1FQfQ/OPxLfZynn2W+8dZ8+moLIf8CubLraHI+xil/DKdHp9QwXxRpuyZbgH79Bs/6dKjcGdA4/QT7YG3mPEnAGDdd7HpNgniZ3X6SC9YYTE1goecYly5FnrOl90k8Eed2fcbIZmzq3QFji6EUdlemlG7bZNrBFmYFrjXfIBZhoTiZLY6s9iRq859hf+A2WXdRP5/GeCni/U3GhqKjR8Gh1b1LbRwxrKQfWtQRcctVbFWMB2sbB+E9vZv/0Z/Np/O72ag7HXen593pRXd62Z2+6U7fdqfvutP3hLJCcAHqJdkkThSlHusoGOUJGTJGk8Vp5fMAxiuu5Mp4lpBdVRqvIeZpOINHzCQhAcMA4xMPCmiVcyPy1EYKmtqo3Ns248LXj6zK0QH8WMh7YV1eqm8jT3kZ04WI1HFIIHNLAoEo1QYg9p1Eekj28j3Ziky4YYm4SXt/yTwPSc5shRdbE7v6H1IbOxwuhPY4XGvs0iwQfgqIlrS3yQEYskUw9Wolh3vrUDWQ77PyfqEtBS3lXjh71gQfMHGy5nIFHbrCgkdHJ5BWOlzCiFqtXEKrKa2CxI5WdRFXw3IO2Lhku2D2gMEXhW/t0OdZPya8bmgU+sVB5LqoRJhBXHYUcvuONalkGDIPXLgox5sKzmnKSX3SIizpbcTsXKbQYllZMKdKJDqSoAvj+U2nWHYT1C44HdfQz+LmWNeeTJxmImG0RjGGFj9iGY4Go8vBeDgeBvb3Vj7ivdkXD2pfqNpWuRUoPn7Ftt4MsMdIWYc2XwvdJe1bEXcM5qAnDqaqeATmNftqNC3BQ2kP3oXdV913zXzdadqvi1Md1weeslvve6zPKteWUtNV+8HZa9otJeFzhrXo2FdqbNfS9XJ/0tZd72m+v4nLibnSWmksgQuvxOUpJa4Rn0Y/ZDPQ92gTtwfV0WArLakPl6gauntKTTk8JuB2mlcp9/MOEUjkMbIpK/AW+AqYpy+p8FM/7fnDyJsprTfMqAJfFq49QFTsQSuKofoKaU2Rb5TKZz9OXWM0aFqFQfiujNsOArOFM41xt1PpHHetrS3NZDDYov5cWnKk3RnWnbrsnKEPDLCrwM33XAvyDB/fDbvXN+Po1NRCJQX66XE/59gZPUFYnZych1WYwApMt6jZgvAlWFTsxgFcAtegpxVp93URLs/oPjyOkKm5HlKKtHVsOPdM1D+4we91FzdX30EiDPz7ywbLmR+6Vwxd/W374r5qs1f4YDh6A7/sRdp2csG708f7/rlWv9aOXldCZook0zV6047OhmfDIGo+Xd1+ZNOb65M9db3IEi6pDa2MvwffujMMDlaoVGQbRretKkOPMLQMrjIhmTMSYFODHknFnGIHowXwkUag9pg/Xs8dVvLPgstg5dkvHx3E2zYuX/DNxF891Y9BmXMh3bOafHy7j5DwewrV3pMxgl62prBC7u12yQ3c6Xy3IzL6gibHXLSR4PwSN+BjDd2LfPY7bAish92fEyZizyv3vDhMLZT8/I5pQunop7yLIPJvPs/m5M77b0F4ZbRHczIE/Z1E/+AvTpTPce6DEXcum2O9rzAXIY8/l35+AJjlnz4= +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 registration workflow' (create-registration-workflow)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create a registration workflow

+ + + + + +Create a registration workflow + +## Request + +

Body

required
    workflow object
+ +Expected response to a valid request + +
Schema
    workflow object
    = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
    attributes object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/create-request-action.api.mdx b/docs/api/nerm/v1/create-request-action.api.mdx new file mode 100644 index 000000000..16af1644a --- /dev/null +++ b/docs/api/nerm/v1/create-request-action.api.mdx @@ -0,0 +1,47 @@ +--- +id: create-request-action +sidebar_label: Create a request action +hide_title: true +hide_table_of_contents: true +api: eJztWG1v4zYM/iuCPuetb7u7AAPWO3RAht21aLPtQxcEik3Ham3Jk+SkQZD/PlJyXOetTQ8dhgFLgdSSKPKhyIdUvOS6ACOc1GoQ8z6PDAgHt/BXCdZdRjTPWzwGGxlZ+FGff/EyTDATxJhYyzkxtbx/z+faPCaZnlcrlo9avBL+rOMF7y/9UBpAm86U0OKRVg6UoyVRFJmMPKbugyWTS26jFHJBT25RAILQkweIHNosDHngJFhaXVseV5iO3yDjhrB1RqopCifa5AJR8bJEgdYO7M2TGabAat9dcxDgsAlkWk0tc7qDyuBJ5EVG9s7Okt6H0zhun5xNztvnJ3DS/gii1z75ITkVF58mFx+ij3y1ZW4X7evoGjNMJ/swbgK7MXomcZOXrEIIBmNfiClulS5ldES2Q+ho7s3nmIjM7oXqLew7RJvqMosRjYrBfN85ChOlcgZNqBOtMxAh2xNRZu4AtMHeU2PSsrVSpg1T2m0g86pWtd92HOk8r/L9fQCsNWNsKt2HcSAQJ50/sU2qr/yHYNoCeRsoctrr0b9NFFdPBdIJKAxBFHMaTc9EJuN1ovD/af3OtD5Ilrfy+jaoZBgUZLjIWGJ0zgSmS4r0Li1+aaL51OiyII00ZQPhBbMYe5nIiBlM2e+n/qGz/keZH8fjuo6NhR3ruQLzMg334axY+FwSK2wTPNM4Rl6IUDO9+nVI8KwTmXmqoFzotfGGH2QKUSIpZDYWDs9wUrp3LKq1SmadJjUelzdHuJHMlgr66wl07HlXngTVgZuVG8IYsdiHWjrI7Yv+OnhyO7zx/m14Asf5cs8fdKpiDT9NaXcHyycuPwgFm3MjtKhgPrZOuPIIgEcFBBWyoLDGeheGX1Khpq9Egcr2DFpsoET1dK3YryDoaQgml4oy7F/tePZRFoWY0NQ7Wq61/qea7R+Vmq1ue76vwX4WMauaM2uzUnlnsXCgPVTuoPOW7qoVXCeY6bttcw1toHzr/oW2rlqH5X4nKW/myhhtLF+NghMX+5wYID6jsL3cgZlhHfR70B0DrjSKEkeha5jocYYDeIrA77Rvcu7lmwCQyV1klyzHCkGNJsxP6lro5Zsku9PGLJjVObiUpOYU7rnBjl9FEL2nNU0/oArt7z2FcCmOulsXF9utGsZ6jKLWH4310SlNhrtS5wrb73aX6L9Q7pvIYdVRGEMEpBcAVI26opC4eSaMpMwI5agWD/5Wic1FlEOkd37HDb04UyiP3crKKQWEMqzE3pBjU0TPRoQvKo10Cw9wAsKAuSzJu/tRc/mO4hFwNIXq8JBT5K0XIwZ6IZwJDz+vS+dQP4JCGPj940KXJjxyOmQK/e3zz8irdYT23g83boDHtavtAzr+x0/jAnSsqeeCXBWe3WpV1w+pEk0+UZ4EaCedXqfXoOW3q9uv7PJmsBtkhL5eZJGguyrd5XygRRRRv0f2sVzHMlkwSieNvQdh4NHjKpOK+SiAmklMeQJG7iIdAS/9BEr5fONfB0MfJCJALlRj5fD7gq17b834l14xhGyiBtstMiGpWgXaLCvS3W9ng+X124dx44VESkxF6eVyIiz8ZrLViqZRzlCuj57J5VMdN4CI6aqINHiEBaEMeNtDwkTiWekvNtvViupp2HEZUYV7UXbUKCY313dDYkj1zgSDRHuMmJNH+N3nf+IfDnQom/7FCs0veYaXhxJzEmWCXvr8DW9SOZw= +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 request action' (create-request-action)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create a request action

+ + + + + +Create a request action + +## Request + +

Body

required
    workflow_action object
+ +Expected response to a valid request + +
Schema
    workflow_action object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/create-rest-api-action.api.mdx b/docs/api/nerm/v1/create-rest-api-action.api.mdx new file mode 100644 index 000000000..1823853cb --- /dev/null +++ b/docs/api/nerm/v1/create-rest-api-action.api.mdx @@ -0,0 +1,47 @@ +--- +id: create-rest-api-action +sidebar_label: Create a REST API action +hide_title: true +hide_table_of_contents: true +api: eJztWG1v2zYQ/iuEPrWAX5K+rF2AAUuLDPCwNkXibh8yw6Clk8VEIjWSsmMY/u97jpIcvyVNimD7UgdwJPJ4fO7uuTvSy8iUZKVXRg+S6CSKLUlPF+T8aalOYx6POlFCLraqDG8n0ccgI6S4OLscitMvAyGDYE8MMxKpyXMzV3oqXFWWxnp+NJNrir0Tc5XnQhMlwhsxIVFvlwiZerLCZ8o1ugSe2skX80zFmZCWhFdh6ZR8BvmZkmJu7E2KDcf1urFKXoqusDBgLEvVjsZGp2pa1YZ2BM9sDY2l91ZNKk8uWOHoEPqicn4TdWq2MTc2maLMCQ56Ade4Rugejdp4sSAvFC8pSENrR1SQ/Tp42YPjvZy66OQqaq1sdnLRqBNZ+qeCmR9MsohOluFVWUIQva2oE8E+D4U8JcsyV3EwtH/tOIbLyMUZFZKf/KIkRLWGhD1Ly5SApx3P7vj3CQtUsiHs4F49hTDcUUigiqoKAp092NtUY0KtbfebL43LJ5QbPXVwPbuLbiU7Egtfv06P3r1Kku7x68mb7ptjOu6+J3nUPf4pfSXf/jx5+y5+H612tttH+210GyPCpIcwbgP7JG8IhBFN9JgzSCQ8pVXOudRjVNLGmZrRpgMnxuQk62RMZZXDhanM3R6mwUEMnE6tUgFCgndbsIKqFXb2ygeY2xVgFT7sDleCfXWgXx0d8b/t7c9uS5ACm7SitYEzmauktTn6Qc5nJudBJnwPOy9qlSiQ8BuCJlJrCiFBF663KEyW2SPF1JqqZI08xGXdoz4Lh9irVMXCgquByKWc0rP5mpUd9LPLTJUzvXRC9vtcLZNk3NCT7Fi6sZlrsg/n3yGcTfqtVbXY0BewBXc6FwSC+jYk8HWqctruiVt28FZAiaRQ+V2verJn7+XJWqVw3rCagCtsx7iRzOtG9jCBHuvvxpJadZ2bjRnSWrk4hFp5KtyD9nq69Xt5E+zbsoQeZ8tVdG0ynRj6dcqre+jrmL6WmrbHRthR03zsvPTVIwA+KiBQKGqFa6yX9evHTOrpN6LAZXtGHTHQsnk61+IPkvw0JFsozQz7HztNJ3I3qizlhIeecee11oe2btzvcAQsiqYLPQ+CVjNqYaP7Uc32r0bNTrd9c6jBfpCJuGjODl1R6WAsCkd76uw9pbsaTecpmL7fNltoAx1a9++8dNW5X+5PlgrbnFlrrItWo9qIt4eMGACf1Wgvl2RnqINhTTi2+8pqJo6GaSB6kuOFbmMKK92TjHv4JEC85T6yU1GgQnCjqccn61oY5DeT7NJYuxDOFLiMsNScwz236PhNBGE9zxm+V5UmnHtK6TO89XcOLq6/c2FxkHXBNy6Ep7I5lmXel+6k31/CAVL7z7KgVU8jiEBkFkRcjvpQgsUzaRVTo65Ha/Ha4IbZkYwLis3e/W4YxIWGPNqVU1Nd39diXH9grWXzRowvrqzyiwBwQrie2dOKzbsabU5fckBqHJtC6/iwUWxtEOMUDEIYqR9+a2vn0NwQX7Hw/cvCVLZ+jNjLHPuLu9vQWRuigwfErSPg4/rVroO+fYbfLKzrdFc6NYyAo1orOu4d9Y42sujz2cUnVrAfEjCwnRSx5KMlH71CWGQcc3tGsojCJCpdCA6+QasAqeAozAqlRfAZ6ZkCQ7kyMUhkD+GMzqB0YEf0aTAMLmW+FlJvzNx369/FurzL0B+/FPyHvxTU2cQnjH6ZS8Xlui4by6bqXO1mgwtHkZ26g8zNuFZBfLmcSEdfbb5a8TC4bjnZR3fVJeQ6FpBM+LCMOnBDC457zYDukEGxeF6Fo91uveaOUq84jbnGPyg72iinX84vh1wimt8+wHteY+WcTcL3SfQ3/vBi6sYRfiDh8WWU4/hUocBDptbLn38B63Wp7A== +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 REST API action' (create-rest-api-action)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create a REST API action

+ + + + + +Create a REST API action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - rest_api_action_configuration, api_configuration_attributes. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). + +## Request + +

Body

required
    workflow_action object
+ +Expected response to a valid request + +
Schema
    workflow_action object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/create-review-action.api.mdx b/docs/api/nerm/v1/create-review-action.api.mdx new file mode 100644 index 000000000..574672963 --- /dev/null +++ b/docs/api/nerm/v1/create-review-action.api.mdx @@ -0,0 +1,47 @@ +--- +id: create-review-action +sidebar_label: Create a review action +hide_title: true +hide_table_of_contents: true +api: eJztWFlvGzcQ/ivEPiWALNlx0qQGCtQJXEBFc8BW2gdXEKjdWYn2LrkluZIFQf+935ArWZevwEFRIDZg8xgOv7mHO09MRVZ6ZXQ3S06S1JL0dE4TRdPTlJeTVpKRS62qwuwk+RBIhBQ2UAkZyNqiNyaRm6IwU6VHwtVVZaznoRleUeqdmKqiEJooE96IIYl4VyZk7skKP1au4SUwWm6+mI5VOhbSkvAqHB2RH4N+oqSYGnud48JBPDdQ2UtxsLMKAXNjS7IDbbzKVRrEHVApVRFgO9oHt6ydX4cJHhsgGyFMWRUEfbw4/dJ1DdEdHHG9mJEXio+UpMG1JWrQfu2+bEPPXo5ccnKZLAVobnJJv5VY+qcm59+bbJaczMNUWYLJvK2plaQG3LTnLVlVRSNj58qxyeaJS8cQl0d+VhGMGCHhzsqyA0C1jne3VPeEAypbI3beQm4Qs94lUCV1DYLWDuxNz2IPWsnu1yeNyodUGD1yUD2ri24kKxIHj4/zw7evsuzg6Hj4+uD1ER0dvCN5eHD0U/5Kvvl5+OZt+i5ZbF23i/ZhdGsrwuT7MG4CO+VwcIGuMSB7umlCp82YKjmiJ2svl4XbC5C57VWdG5u6yHCxzsh+m/akTcdqQutQh8YUJGOOyGVd+DugdffqiuN8yVQgcBAfG8gCq8VKbjdAsJWNlz8PgCVnZLOG9904AMQrHzS2kR8X4YdRugrBGuPi1eEh/9sEcXZTIYaIrRBJ2RWkmMhCZUv/SH7E8jPH8p2x8tRgPo8sBYxiDYwmcmtKIeEtXI+Qxy07jxQja+qKOfISlz2P+iUcbM/FR1h47LdH/l26/q6Bn2WDVfoaSDcwU032/ijch7MJwttM2GBDGcUV3AnEVBnYL00CXeeqoM2eYUMOvgooQz0fSA8dDmv/jDl1xVI4b5hNwBWuY9wI5lXdv9+BHqvvRpLIOsZmI4a0Vs72oVaeSnevvJ5u/E7cBPk2JKHHyXKZXJmxzgz9OgptFLIntq+kps21Pm7UNB04L339CICPMggYishwhfUiTj+MpR49VJOxNqGW6GrZjD5r8QdJHvXIlkqzh/2nBc9dq6qSQ156xptXXP9Xtfavhs1WtX29r8C+l5k4j9kF74BaB2GROJZNevsp1dVo+pzD03fL5hJaV4fS/TsfXbTupvuTqcI1Z9Ya65JFPwrxZp8QXeCzGuXlguwEeTCcgTiWfG01O46GaHD0rMCEblIKJ92ThLu/EyC+chfZqSiRIbjQxPXhKhcG+vUguzDWzoQzJR5rTDVlc08tKn5jQUjPe4YfnZUJfU8l/Rizzlbj4jqxW15OQemCZlwwTm0LHBp7X7mTTmcO8aX2n2RJi7aGCYHHzIg4GXVkpXB4Iq1ix4jZaEUexW38OpFpSanZefv2ArnQoEexcmqk42s2xVsRsloWrs/40toqPwsAh4THqz2tWbjL/vr2BZsj4lgnWlmHhWJpAxkHYCDCShz8tsycPXNN/B7F319mprZxmLCO2fLnt0/Hs6WB9raHGw3g46rVtoIeevCsdT2PveA2CzfZZjdFrZKG0rlhSdg7IqCj9mH7cC0WP52dfxR4qu+aFpCXmyKV3KByAxfMK9OUizxCTpQmU/lMsBMZFBzAgMKxK5QWQfekJwp+zsBYXMQgodNnUDp4WfKx2wumYa8vpV7b2f9lZRvp/DbKf3yL+X7fYmIIclPSqQqpOMPHXDNvEtXldgi50L1spCoE+5iTG4jn86F09NUWiwUvIzYs54f+bUIK6QEHSGbcXSN1XNOMjRzNfdBjSExe1KEX3E7wXILiidOUi8K9tP21/Pvl80WPs0rzbQkuzmesnLJA+HuS/I1fTEysNOEDFK/PkwL9Vo2IBk3kyz//AiTgHMg= +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 review action' (create-review-action)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create a review action

+ + + + + +Create a review action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_performer_notification_email. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). + +## Request + +

Body

required
    workflow_action object
+ +Expected response to a valid request + +
Schema
    workflow_action object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/create-run-workflow-action.api.mdx b/docs/api/nerm/v1/create-run-workflow-action.api.mdx new file mode 100644 index 000000000..9c19f634a --- /dev/null +++ b/docs/api/nerm/v1/create-run-workflow-action.api.mdx @@ -0,0 +1,47 @@ +--- +id: create-run-workflow-action +sidebar_label: Create a run workflow action +hide_title: true +hide_table_of_contents: true +api: eJztWG1v2zYQ/iuEPrWAE+elXbsAA5YWGeBhbYrE3T5khkFLJ4uJRGokZccw/N93R0qKLMuO43bYlyZAIonH43MvfO7IZaBy0NwKJQdRcBGEGriFm0L+pfRDnKr5ZUhjQS+IwIRa5O7tIvjo5BhnupBsXsoy7oSP2TABFqsUPwk5ZabIc6UtParJPYTWsLlIUyYBImYVmwDzy0aMxxY0s4kwpS6GT9Xgq3kiwoRxDcwKN3UKNkH5meA1hrGfNxbRa3bEQiVjMS28geNcq1ikMObWajEpLDikBroQZoWxTWSxWsdV4lZZngI64tXll4EphbZolMqyBVgmaEoGErX2WIGyXwevj9HBlk9NcHEXtLxpglEv0PBPAcZ+UNEiuFi6V6EBA2Z1Ab0AzbSokIZ4nqcidPb27w3FahmYMIGM05Nd5IDR85BwTfQIhh+9aWi05cMXTBBRQ9igd+UUhdEdGUdUQVGgQG8D9npKUdLUttvmS+nyCaRKTg26ntwFj5wciRPPz+OTd2dRdHR6Pnlz9OYUTo/eAz85Ov0pPuNvf568fRe+D1at5TbRPo+u8YWpuAvjOjDcRpgvGHdK0lpyLmzi5vKJSIVdUCrl3BgWccuZIDvtHAB1IWauw0TMoOneiVIpcL8lY16k6OCYp2YD8aATIW2oSinDdEV0a6CdqpVLqcbOqXeMeT4p9suFdawEVESHhfWFSdi1cDuaBwLhwo5xuXHJCut51gxbR5hypDVpn6JlElWkESOdFa0wjFrqGLOinc7IVSxn1diA7PQJyCIjqpFKAr6GhabF8amOc9DQQ5NHXY4rJZr4S9i0MAF9Qt3t2mrlFW0/W+iao/dwnIg71FcAvDasT6W+Tk9h7Rpv1o1vTaIWIPQCrnNYRjVD8B2Q1fFCHYcAwh8sU8JW5NbqEVYrL6HB5Fi3PBucnZzQv3VYV485MgdQmLwoeYmzGU8FfXO1LvhR1r5zWeusEgfVNa+SYVC0wqCxWKusLnTY0miqLJxNtSpy0kifjC98nBmMvYhFyLSifUlpzqf7pvfzviZlnX6umUFGoA9zNY+icZmeoMfcjNVcgt5dm7twlpxfq6qwYUeJS1AfbJyAU7+xe5sd85odtBSixE0h0qeS/WLPbs2TWiUzVpEah8stR7hxM9ct8O4E2tffpSVe9VrvwbXmiy7UwkJmdtpr4dFu7Btn35olsJ8td8G9SmSk4NcpzT7G0ozD91zC+rcRrihhPjaW22IPgHsFBBUyr7DGeutfPyZcTp+JAtH2DHpsIHn5dC3ZH8DpaQg6E5Iy7H/tQs2DyHM+2doPHLZyrXXX0qX7DXVzWVmFvg+CSjNyYal7O45Gwd1Sbd90FdgPPGI3nl3wFFxIZ2yrcdy7umKTeB1jpm+WzQraQLrS/TtNXfW2y/1JUm6ZK62VNsFq5I1422XEAPFpieXlFvQMedDNQXN8b0eJI9E0TPQoxRd4DMHNNC8ybncnALTkJrJLliFDUKHx3yc1Fzr55ia7VVovmFEZ2ISk5q7L11jxywii9TSm6PYlV67vyblN8K3falxMv6NhNShvnH+MC1GhU5yaWJubi35/iU7g0n7mGayOqdtHVGoBQJTU57nAyTOuBaWH56Ra3BtdZnfAwwxCtdFeDp04kyiPJcuIqfQ3OmGBBSLDyojmjQgf9vl40nUAJ4AnBX1ZkIl3o+bwLQXF42gK1TEio8haJ0bb0AnhF//wW8WfQ/UAdEGDf39ZqEL7x4A8TfG/ebpLuarC1NkkrrWB+9WstoO+9QagSb0lxew6mL8E6EHWdR5xS2Ab587GubJ9uCunbDuA7Qtn43y090EGGwUZK/IZ7RwfrNPjk+OTBlt9vrr5xC6/DDbTHkNXDbKQU7yoxXWpz8OQ2iAkJZapSMQLRhtMYUlGxsdkxFGKsMtLkDOBTEAVgEKNLAV4FiJQ0u3A4NNg6NKWeCHjsjGy6/61jXf5xIY/7m3/g3tbz07UtfXzlAsqgZ6GlyWT37XZhUi7k8uRDROqAThluZxwA191ulrRZ+QsTQQ6emJsx584AXhEhxDk1gdYUIx9tI+GBIzE08K1zO06SJXaz7gMqXbulB01ytSX69sh0W55G415TnM0n5NZ+Pci+Bt/8UX5guyurOn7MkixLS2wcKKM10s//wIlEIPS +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 run workflow action' (create-run-workflow-action)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create a run workflow action

+ + + + + +Create a run workflow action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - configuration_profile_attribute. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). + +## Request + +

Body

required
    workflow_action object
    configuration_attributes object
+ +Expected response to a valid request + +
Schema
    workflow_action object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/create-set-attributes-action.api.mdx b/docs/api/nerm/v1/create-set-attributes-action.api.mdx new file mode 100644 index 000000000..bde99a101 --- /dev/null +++ b/docs/api/nerm/v1/create-set-attributes-action.api.mdx @@ -0,0 +1,47 @@ +--- +id: create-set-attributes-action +sidebar_label: Create a set attributes action +hide_title: true +hide_table_of_contents: true +api: eJztWG1v4jgQ/itWPrUSBfp2u4d00rGrnsTpdrsq7N2HHkImmRC3iZ2zHShC/PebsROaAGXpqqf7slSiiT0ePzPzzIzNKlA5aG6FkoMo6AWhBm5hCLZvrRbTwoLphzQbtIIITKhF7t56wUcnyTgzYBnfSDPuxNtslACLVZqqhZAzZoo8V9rSo5o+QGgNW4g0ZRIgYlaxKTC/dcR4bEEzm4hKF8OnavJkkYgwYVwDs8ItnYFNUH4uOFso/RjjhhO/biKiU3a2M4p4J894HVAD+wBmhbF1YLFqwiphqyxPAT1x0v8yMKXQCxqlsmyJ7hK0JAOJWlusQNmvg9M2etjymQl690EFudzJBONWoOGfAoz9oKJl0Fu5V6EBY2Z1Aa0gVKhNWprieZ6K0MW082AoWKvAhAlknJ7sMgcMn4eEe+aaGIDONDS75axXLBBRTdige+UMhdEdGUdUQVGgQGsHdpNTxJmN7bb+Urp8CqmSM4OuJ3fBEydH4sLLy7j77iKKzs4vp1dnV+dwfvYeePfs/Kf4gl//PL1+F74P1lvb7aL9NrraCFPxPoxNYMN6cpyYUyINpkwOoYhFyOY8LaBNyLgOEzGHuhOnSqXAfebFvEjRjTFPzQ6uwV4clDWVUoakRO41oDlVa9zZCltB3Un6tfuQY0yOPPQhv+h26V8TxM0T2kRZUol6S9FAQWOOu8EPmr4xTffy4Xt4eudVMgyKVhg0FmuVMY6koeKKJUoThzibaVXkpJGGqIbbpM5njYx1dM75DN7M16Rsr59NooqU6CUj0N/nah5Fk5KeoCfcTNRCgj6chftwlkm4UVVhww6BW1BbM07Aqa9Cgr6ORQrNBtiwg7ZClJgUIn3uWq/27Is82ahkxipS43C57Qg3JvOmpR0m0LH+Li3xqn1ulmZwrflyH2phITMH7bXwZHfyxtnXsASOs+U+eFCJjBT8OqPVbezwOP3AJTTHxrijhMXEWG6LIwAeFRBUyLzCDdahf/2YcDn7RhSobM+hxQaSl0+3kv0BnJ5GoDMhiWH/Y79pBeZR5Dmf0tAb7rzRemjr0v1mgtHLyi70NggqzVgLS91Htdy/SjVb3fZqX4P9wCN256sLHmoL6YzFwlGdP9uv6a5Kwm2MTN9tmxW0gXSt+3daum69LPcnSbltbrRW2gTrsTfiep8RA8SnJbaXIeg51kG3Bs3RYAstiTgSTUOiRym+wFMIbqV5lXGHTwJAW+4i67MMKwQ1Gj8+3dRCJ9840ymtl8yoDG8eJLWgcC80dvwygmg9zSm6UOXKnXtybhN862wdXEyneRuphnGFcR4yLkiFTnFxYm1uep3OCt3Apf3MM1i3JYYScaklABWlDs8FLp5zLYggviptxL3ZJb8DHmYQqp2L3ciJM4ny2LSMmEl/RQvxOoQ2azJyTPjCQgu7dACngDcy3S/IyPtxfXpIYfE46kKbKJFRZK0To0R0QjjiH36rKuhIPQJdufD7l6UqtH8MyNfEgLvn29FNFai9x8TGQfC4rrXtoOPO9PUSu0l8IWNFKCiyXtl5u9vu1vLp883dJ4Y3yd2wIBerSRZyOmTSIcyFhochNWpMG5apSMRLRgRQ2DSwJqGzcJYJyZzfQM4FcpVqFIHEPAI8rRMo6RgSfBqMnFuJuRmXtZnDV/5txKvnjP3xY8F/8WOBTyA6WnTylAuq075SrMpyc7+dAL6u7C04mLIJlSpctFpNuYGvOl2vaRgTS1OWj5/LiktyXAA8orMyFoBHWFKYfcDPRgSNxDETqNBsl2tqKH5FP6QSf1B2XKumX26HI6oN5Y8gSHZao/mCDlf43Qv+xj98Ub5vuF9KaHwVpHh6KrC+o4zXS59/AUgfq9k= +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 set attributes action' (create-set-attributes-action)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create a set attributes action

+ + + + + +Create a set attributes action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_set_attributes. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). + +## Request + +

Body

required
    workflow_action object
+ +Expected response to a valid request + +
Schema
    workflow_action object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/create-set-security-question-action.api.mdx b/docs/api/nerm/v1/create-set-security-question-action.api.mdx new file mode 100644 index 000000000..8b3635cfc --- /dev/null +++ b/docs/api/nerm/v1/create-set-security-question-action.api.mdx @@ -0,0 +1,47 @@ +--- +id: create-set-security-question-action +sidebar_label: Create set security question action +hide_title: true +hide_table_of_contents: true +api: eJztWNtu4zYQ/RVCz4mda3droECzixRw0d1sY7d9SA1jLI1sJhKpkpQdw/C/d4aUFPmSxFkE6EsdxJHImeGZ+zCrSBdowEmt+knUi2KD4HCAboBxaaRb/l6i5d2rmL+joyhBGxtZ+Lde9NnTCxAWHf0GHvFPxSSg5nIwtVHvLlpo85BmelHt2Gh0FBn09J90sox6K/8qDRIaZ0o8imKtHCrHW1AUmYw92u69ZQCryMYzzIGf3LJAgqQn9xg7OrMwrJuTaHm3PnlcYTqcQSYtYuuMVFMiTrXJgVBFZUkERzuwN+00nKFodHftlwBHTDDTamqF0x0Sho+QFxmfd36ennw4S5Lj0/PJxfHFKZ4ef0Q4OT79IT2Dyx8nlx/ij9F667hdtK+ja60Ine7DuAnsm9F54TxdadEQcEH2m8sEhdU5CrIkeQiy3aiwAlRCv3ZBJB0GDyaeyTm27TzROkMIAZdCmZGlU8jsDvT+XqhC0iGVUKGNUNptoPei6GBV5hM0Y52OG3AtDJICb4qm7WxaOj87yJ5BNJvySe/GWHamy6y2gSgLQpzpqdw08emaEDrpvLmfT8m1/zAkS3JsCN6zkxP+swnr+rGgQCeL1KTsNBBzyCSveZzR/wn3zgm3N2y/J+Nug0hBTqFEo8xKKQUphjRxmhBXFOogpkaXBUvkJSsW0s24QJPvZSpjYSixfNYVMMV3szUL22vnKtQNqgTN95kakmRchSclK9ixXihKyxeLxT6cVa1oRNXYJmTTJKG8gJCiXnztErJ1KjOfKkQX+mOyoQcfRSgpKWQ2Bkc2nJTu7ZZ9Nk4akcI6zWI8Ln8c46ZktoLEvh5Ah9q70iSIxnZFBGNguQ+1dJjbF/V1+Oh28sbrt6EJHqbLXXSvZyrR+POUuTuxzmn7HhRuro24yONibB248gCABzmEBIogsME6CK+fZ6Cmr3iBy/Ycj0RfQfV0o8RvCPw0RJNLxRH2n7ZF+yCLAia89I4nN1JfOroyvx2T9/KqC70Pgloy1cJK9vM4Wo33r0rMVre92NdgP0EibkN1EceiVF5ZKhx0Hgl32HlLd9UKb1KK9N22WUPrK9+6f2XW9dHzdH8ylT/m2hhtbLQeBSUu9ynRJ3yGB7cBmjnVQc9D6hh0pVEcOIpUo0BPMnrBxxg9p32Tci9PAshH7iK7EjlVCG40YX3S1EJP306ygTZm6QdRN2OqBbt7YajjVx4k7XlP86Wn0H7uKcDN6K27NbjYLt1txvUU2wyK9S4xWm8o631VmoxkzJwrbK/bXZE1QLmvkOO6o8ijBE8vEbk2daGQxDwHIzlOQnFqyIP2VZhHEOcY653b19CTC0X01LusnLJ7ON5K6hQ5tUjSc8T4AnYPcIJg0FyVrOvdqL09YO8EHG2ixlmsFGvryTgfPRGthIdf6kI61A+oCAZ9/7TUpQmPEZucA+H26bp3Xftr77S4MQ8e1ry2DfRul5R2Ma6Kzt67g5/ZpUo1K8BBEXCcdk46J62M/Hp9+0VcfevvepSQ1psiBh5TGbn3KsQxt3rGletEpkvBsaOp7VBVIzvTrpBKeJOjmkuKdq5yDJ4yEWneZ1DKB1f0pT/0HuHYz0G1dqor/SsX+q3xt0n8w/8jEIKKu263yEByCQvZs6oy8W47KEKuvZSLFM0zTmbiXa0mYPEPk63XvEykhhNg9JRxPv6JASHhaZJy4wGXrEHQ5XjICJk8K/3ss13QuOQGjquYi+CLtKNWvfl2Mxhy2lT/8CBnMo+BBY8f9N2L/qYfetFFcyX166soo/mipApINEEuf/4FZ9Q7Rw== +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 set security question action' (create-set-security-question-action)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create set security question action

+ + + + + +Create a set security question action + +## Request + +

Body

required
    workflow_action object
+ +Expected response to a valid request + +
Schema
    workflow_action object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/create-soap-api-action.api.mdx b/docs/api/nerm/v1/create-soap-api-action.api.mdx new file mode 100644 index 000000000..5d74ffea2 --- /dev/null +++ b/docs/api/nerm/v1/create-soap-api-action.api.mdx @@ -0,0 +1,47 @@ +--- +id: create-soap-api-action +sidebar_label: Create a SOAP API action +hide_title: true +hide_table_of_contents: true +api: eJztWOtv2zYQ/1cIfWoBP/JcuwAD5hYZ4GFtitjdPmSGcZZOFhOJ1EjKjmH4f98dKTl+JU2KYPtSB3Ak8nj3u/fRy0iXaMBJrfpJdBHFBsHhQEPZK2Uv5vWoFSVoYyNL/3YRffQ0AsTgqvdF9L70BXjCjhhmKFKd53ou1VTYqiy1cfyoJ7cYOyvmMs+FQkyE02KCIohLBKQOjXCZtDUvQU/N5pt5JuNMgEHhpD86RZcR/UyCmGtzl5LAcTg3lslb0RaWFBhDKZvVWKtUTqugaEvwztbSGJwzclI5tF4Li4fQF5V1m6hTvY251kkXZY5koDdkGlsTPcJRaScW6ITkIwUq4toSFdF+7b/tkOEdTG10cRM1WtaSbDRqRQb/qdC6DzpZRBdL/yoNkhOdqbAVkX6OGPIWlGUuY69o99ayD5eRjTMsgJ/cokTyaoBEMkvDIUGWtry7Y98XHJDJBrEl86opEZM5CiBUUVURQWsP9naocUCtdXebL7XJJ5hrNbVkejYX3gMbkg6enqZH706SpH18Ojlrnx3jcfs9wlH7+Kf0BM5/npy/i99Hqx1x+2i/jW5jRej0EMZtYJ/gDilgRO09jpmHROowJDBxJme4ab2J1jlCyMQUqpzsl0Ju9wD1DwLgXGqYCopGCrotTJ7ViiQ76TzG7fRf+Q/bwpYUesHLJ0dH/G9b/OV9SRFBQhrSoN0Mcpk0Ckc/IvOVI/NgJHxPaF4HllQdyW7kNJEaXQigcOFiS1XJcPSAmBpdlcyRl7imOyrOwpLvZSpjYShWfSCXMMVXszUzO2hnm+kq5/BSCZrvMzUkybgOTzRjsGM9V2iezr9DOOv0W7NqsFFTIBHc5qwn8Owbl5CtU5njdkPc0oNFEUpKCpk/NKoXW/bROFmzFNZpZuNxeXGMm5J53cWeDqDn2rvWJLAOuVmrAcbA4hBq6bCwT+rr8N7t5Y3Xb0sTfJ4uN9GtzlSi8dcpn+5QU6ftW1C4vTYiiQrnY+vAVc8A+CyHEEMRGK6xDsLrxwzU9Bte4LI9w5boK6ifrpT4A4GfhmgKqTjC/sdO04rsnSxLmPDSK0pec31KdG1+S/NfUdRd6HUQNJypFta8n9Vs/6rZ7HTbs0MN9gMk4roeHNqiUl5ZKhzNyNl5SXfVCq9SivT9ttlA6yvfun/no6vW43R/MpUXc2mMNjZajYIS54eU6BM+o6i9DNDMqA76M6SOQVcZxYGjSDUK9CSnF7yP0Z+0L1Lu6UkAWeQ+sp4oqEJwownrk3Ut9PSbSTbQxizomlHQTYSp5uzuuaGOX3uQtOc9zZeqUvu5pwSX0Vt3Z3Cx3Z3biiVa621jvXsqk9OxzLnSXnS7SzIAKPcZClx1FDmREOkFIpejLjGhwzMwkkMj1KM1eVC4juwI4gJjvXe5G3pyoYie2pWVUxUuazHdfUhbw+qNGF9cGekWHuAE6W5mehWrdzPa3B6wQwKOTaK1f1gp1taTcQp6IloJD781tXOo75DvV/T9y0JXJjxGbGX2/fXDVeiycdHBAXFrBHxev9o10DcG+M2qus51qVLN4tmlgctx56hztJFCny+vPzGDfX9Q+DWbIgaeK3nu8j6BOObeTJkiCp3IdCHY85r6BJUhshLtCqmENxiqmaTw5LLEICl1kAZ0BqV8aESf+kNvTw7WAtTGzmP3/V2sy4f0/PEbwX/4G0FIJR4vumUOkmt1qBnLuuTc7KaCrzC7RYfSNuNCReTL5QQsfjX5asXLFOiGM330UFp8otMBhIQnZSoCd7hgv4cIaA8ZFJPnlZ/rdos1t5NwohdzgX+SdrRRS79cDYZcH+pfPSju+YyBOY9W9H0R/U1/9KJD1/A/jfD6MsppdqqouhNN4MuffwHZg6Yl +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 SOAP API action' (create-soap-api-action)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create a SOAP API action

+ + + + + +Create a SOAP API action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - soap_api_action_configuration, api_configuration_attributes. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). + +## Request + +

Body

required
    workflow_action object
+ +Expected response to a valid request + +
Schema
    workflow_action object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/create-status-change-action.api.mdx b/docs/api/nerm/v1/create-status-change-action.api.mdx new file mode 100644 index 000000000..055773608 --- /dev/null +++ b/docs/api/nerm/v1/create-status-change-action.api.mdx @@ -0,0 +1,47 @@ +--- +id: create-status-change-action +sidebar_label: Create a status change action +hide_title: true +hide_table_of_contents: true +api: eJztWG1v4zYM/iuCPuetb7u7AAPWO3RAht310Gbbhy4IFJuO1dqSJ8lNgyD/faRku87Lpemtw74sBVJbosSH5ENSyorrAoxwUqtRzIc8MiAc3DrhSvspFWoOlxFN8g6PwUZGFv5tyD95QSaY9bIs8sJM1NJOzC0f3vGFNg9JphfVjOWTDjfwVwnWfdTxkg9X/lUaQPXOlNDhkVYOlKMpURSZjDy8/r0lxStuoxRyQU9uWQBC0bN7iBzqLAwZ4yRYmq01TytMxy+QcUvYOiPVHIUTbXKBqHhZokBnB/amf8YpsMZ2134JcNgMMq3mljndw83gSeRFRvrOzpLBu9M47p6czc675ydw0n0PYtA9+SE5FRcfZhfvovd8vaVuF+3L6FojTCf7MG4CC3SwXrAKOi4TTGnVBZTRS4AeIVOwmAaBg2508OQ2gCYis4gUVJkTc4h4j4ASIyXqx2vFfgXhH8dgcqmQgzFRatc8RFHDRJUedaA1C4YcNrZSjtYIE6X42KbETOsMRMiJRJSZa7Bvwhjt9SqTltWbMkSmtNvQ7bdao2YnnceyJxvX/kPOswUmVeDv6WBA/zYxXD0VyHXUVIsi4TBojyKTNOYTkf+fc2+cc3vp8D1JdxO2ZBgUozFoLDE6ZwI5k4JhpcUvpJBgc6PLgnakIcsW0qVUmzH2MpERM0hYn5uFmMOb+Zo22+tnm+oyI3qpGMz3uVrE8bSiJ5ipsFO9UGAOJ+E+nFUONlvV2Gbo0zjGvBChovnt65CgrxOZ+VRBudAT4w07SBWixKSQ2VQ49OGsdK/37Dd50myJNUzTNh6XV0e4MZmfy9pBAh3r78qSsDW0K7cwRiz3oZYO8iNK/HbeePs2LIHjbLnj9zpVsYaf5rS6F+kcp++Fgs2xyT/vQf9OO+mwupV1WN3JOqzVyP67dtPh9kEWhZjR0BtqbnY9pLpyv51i9PKqC70NgnpnrIXV3kd13D+qbba67fm+BvtRxOwmVBfWZaXyxmLhQH24uYPea7qrVnCdINN322YNbaR86/6Flq4735b7naS8mitjtLF8PQlGXOwzYoT4jML2cgvmEeugX4PmGHClUUQchaYh0eMMX+ApAr/Svsq4wycBIJW7yC5ZjhWCGk0YnzW10Mu3k+xWG7NkVufgUpJaULgXBjt+FUG0nuY0XXQK7c89hXApvvW3Di62H3J9Gq419SgusN5B1seoNBmuTZ0r7LDfX6EXhHJfRA7rHh6KmzMxMqEvComLH4WRxI9QlBrxYHVFby6iHCK9c+Eae3GmUB57lpVzCgvxrMQOkWNrRPsmhC8qjXRLD3AGwoC5LMnGu0l7+paiEnC0hZogkVFkrRejPPRCOBIefq4L6Fg/gEIY+P3jUpcmPHJyNRHg5vmmd1XHae8pceMceFzT2rmRHnU/2WwNz5eM57rbVAOpEk3YKN5BxUlv0Bu0kuzL1c1ndvl1tBssxFBPskjQyZNOZj5gIoqoe2MusVzHMlkyooVGuFio0IU4y6Ri3pugHiUSmAoXQcfkAjzCEyjlecM/j8be2UTnXKjWzEsX9K2zbJPFL9/sA0OodfaLTEiqQyEVVlU63W1H2CfO3oRCSqaUibhmtZoJC7+ZbL2mYSSOIRZPntPGkxgXgIjpKIgEf4AlIQ7Yu2NCRuJZ6Q8u29WI6mVYcRlRBTsoO2kVi6/Xt2PifvWDBYaN1hixoLMDfg/5n/iHLzqURf+rBo2veIbmlli+UCbsS5+/AR2MFOA= +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 status change action' (create-status-change-action)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create a status change action

+ + + + + +Create a status change action + +## Request + +

Body

required
    workflow_action object
+ +Expected response to a valid request + +
Schema
    workflow_action object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/create-synced-attribute.api.mdx b/docs/api/nerm/v1/create-synced-attribute.api.mdx new file mode 100644 index 000000000..fac47d64b --- /dev/null +++ b/docs/api/nerm/v1/create-synced-attribute.api.mdx @@ -0,0 +1,47 @@ +--- +id: create-synced-attribute +sidebar_label: Create a synced attribute +hide_title: true +hide_table_of_contents: true +api: eJy1Vk1v4zYQ/SsEL734M3HarYEevG0KuMAmQez2khrBWBrb3JVIlaSSCIL++86Q8VqxkjRbpDZgS+Qb8s3MmyFraQq04JXR81ROZWIRPC4qnWA6896qdelR9mSKLrGqYByhfg0o4QJMQAvnYevk9EYeTzm56kmL/5To/EeTVnJah1dlkbb1tsSeTIz2qD1PQVFkKgm0hp8d71lLl+wwB37yVYHEwqw/Y+Jp08KyE17RLjSr8fbbtrcqbRk4GtVbMtgYmwNtJMuSAD2JD5AXGUPGJ5Mf0w/r0z4kJz/3J6PxWf/D+GzSTxEmk9MJ/HS6gU44jp39wYn5b7JpKBzKh2WPA9o0PGvRFUa7SPtkNOa/pyufPxTkIq29hwpvBIg7yBSPhXDKd4tc9OMQvX+3eFt4SS3ppc6qfaL/n3AHbhuV4S3zeWPm35naVWQgeFsiJcymWyRE9D9I9J2JXuCB0YtEXxZw/yRImBGT0air24+QiusoT9EXpYZ1FqSbGCbtcfA9ojUaLzfUVLpi3LOb61ARf7Bp03sZ9xejwjbn1hrrZLOKTpw958Sc+FkNmVigvUMrgg25Y9GXVlOojCbXdqDTjF7wIcFg6b7LudfrC3nLLrOZyNE52KKI42vSjPA7FBHfVsfCWFsJZ3L0O0bdEytxbw2JrNmnkOcMd//ChHZSgN/R27BdT25YH5VXMzzuF45sXYiVC+kqbUbL7Lwv3HQ4rCkgoP0F5NgMNCWVGJoKcUCiGEKhyPgOrGKpBN8P8BiADZQZFwQkOSamo+hlgAtNeAHOqS1niCVXOk/eW3Z3xfyS0ipfBYJrBIt2VrK7N6v29IITFHm0Qd/yxU6xtwFG7xFEI/Hh9331Ls0X1ESDfn+pTGnjYygt1sL14UQ836fsmRPsbTVOayq9MbwCpyCGZTwYDUatErg4v/4kZlfzbvxIPvtJkYAWaxSlizGEJCG9CVK6yE2qNpXgTJnS8blEXtGsUFoEB1HfKZJXTjrjQiDpI51bwa2QSvlpvgz+s9hy0K2Zx2sFPHexeEK2PtTXa3eRmCqPD35YZKC4N0RN1o8Sv3lyZLB8p8dnSK9zKoarzI4rhezreg0O/7RZ0/AwZdOytFYHLQdlkQH1bxIIq+4LVsw7etBfMkuGZyWz7XQL7mfRYpZwh3kVu2oV89XlYsmCfLxtUeLYxsI9nyb0O5V/05deTGxb4UrG47XMQG9Lai+Eievy5yuLj37L +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 synced attribute' (create-synced-attribute)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create a synced attribute

+ + + + + +Create synced attribute + +## Request + +

Body

required
+ +Expected response to a valid request + +
Schema
    synced_attribute object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/create-unassign-action.api.mdx b/docs/api/nerm/v1/create-unassign-action.api.mdx new file mode 100644 index 000000000..7c84d454c --- /dev/null +++ b/docs/api/nerm/v1/create-unassign-action.api.mdx @@ -0,0 +1,47 @@ +--- +id: create-unassign-action +sidebar_label: Create an unassign action +hide_title: true +hide_table_of_contents: true +api: eJztWOtv2zYQ/1cIfWoBP/JcuwADlhYZ4GFtisTZPmSGcZZOFhOJ1EjKjmH4f+8dKTl+JXGKAPtSB3Ak8nj3u/fR80iXaMBJrXpJdBbFBsHhjQJr5Vidx7wRtaIEbWxk6d/Oos+eSIASVU0owFN2RD9Dkeo811OpxsJWZamN40c9usPYWTGVeS4UYiKcFiMUQWAiIHVohMukrXkJemo2300zGWcCDAon/dExuozoJxLEVJv7lAQOw7mhTN6L9taq0Tlaj8/iLlxFZd0qnlSvo6nR6qLMkXR/d/6tZ2uiJzgq7cQMnZB8pEBFXFuiItqb3vsO2dTB2EZnt1GDtJZko0ErMvhfhdZ90sksOpv7V2mQHORMha0o1sRNOd6Cssxl7B3YvbPsnnlk4wwL4Cc3K5EcFiCRzNKwu8mGlnc3bPSKAzJZIbbOkN5ETOYogFBFVUUErS3Y61HEobLU3a2+1CYfYa7V2JLp2Vz4AGxIOnh8nB58OEqS9uHx6KR9coiH7Y8IB+3DX9IjOP11dPoh/hgtNsRto30Z3cqK0OkujOvAblQ7pIMVPtxEanQhQJARU5ljh0GBiTM5wVX7jTQRQ0izFKqcLJhCbrcg9XZC4DxpmAqKRwq7NVSe1YIkO+lqlGvJvfAfNoctKfqCo48ODvjfuvyLh5KCgqQ0pJwUICaQS17zERv9DM43Ds6dofAj0XkVWApyitHktDo6KV64klJhMhw+IMZGVyVz5CUu2I4qr7Dke5nK2Ee2j+QSxvhmtmZmO+1sM13lHF4qQfNjpoYkGdbhiWYIdqinCs3zCbgLZ51/S1YNNuoLJIJ7mPUEnn3jkjr317vdmh4silBSUsh8CI5sOKrc6y37ZJwsWQrrNLPxuLw4xk3JvGxkzwfQvvauNQmsQ27WaoAxMNuFWjos7LP6OnxwW3nj9VvTBPfT5Ta605lKNP4+5tMd6uu0fQcK19cGJFHhdGgduGoPgHs5hBiKwHCJ9Tq8fs5AjV/wApftCbZET0H9dKnEXwj81EdTSMUR9j+2mlZk72VZwoiX3lDykutzomvz2yF5r6i70NsgaDhTLax579Vt/6nZbHTbk10N9hMk4ipUF5pgabYehcLRTJ2d13RXrfAypUjfbpsNtJ7yrftPPrpoPU33N1N5MRfGaGOjxSAocbpLiR7hM4rayzWaCdVBf4bUMegqozhw+NpAgZ7k9IIPMfqT9lXKPT8JIIvcRnYuCqoQ3GjC+mhZCz39apJda2NmwuqCrhlMNWV3Tw11/NqDpD3vab4zldrPPSW4jN66G4OL7TaXpGaBaK23jfXuqUxOxzLnSnvW7c7JAKDcVyhw0VHkREKkZ4hcjrpQSjo8ASM5NEI9WpIHhevIjiAuMNZbV7e+JxeK6EVAFW5iMV1/SFvD6g0YX1wZ6WYe4Ajp4mXOK1bvdrC6fc0OCThWiZb+YaVYW0/GKeiJaCU8/NHUzr6+R75i0fdvM12Z8Bixldn3V4+3oYvGRTsHxLURcL9+tWmgF2f41bq6zHapUs0A2KmBz2HnoHOwkkRfL66+CLo0bnuEArDZFDHwZMmTl/cKxDF3Z8oVUehEpjPBvtfUKagQkZ1oV0glvMlQTSQFKBcmBknJgzSiMyjlgyP60ut7i3K4FqBWdp68z2+CnT9m6M8fAd7mR4CQKDw8dMscJFfiUBHmdUG53Qx0rh9bJYWSMuMyROTz+Qgs3ph8seBlSh3DeTx4LBw+jekAQsJzMKX4Pc7YpcG57T6DYvK88lPbZinmZhFOnMdcvp+lHaxUym+X133O/vpnDYppPmNgyoMTfZ9F/9IfvejQE/xvH7w+j3KajCqq3UQT+PLnOwbBko4= +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 unassign action' (create-unassign-action)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create an unassign action

+ + + + + +Create an unassign action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_roles. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). + +## Request + +

Body

required
    workflow_action object
+ +Expected response to a valid request + +
Schema
    workflow_action object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/create-update-profile-action.api.mdx b/docs/api/nerm/v1/create-update-profile-action.api.mdx new file mode 100644 index 000000000..43a57ab8c --- /dev/null +++ b/docs/api/nerm/v1/create-update-profile-action.api.mdx @@ -0,0 +1,47 @@ +--- +id: create-update-profile-action +sidebar_label: Create an update profile action +hide_title: true +hide_table_of_contents: true +api: eJztWG1v4zYM/iuCPuetb7tbgAHrHTogw+5atLntQxcEsk0nam3Jk+SkQZD/PlKyfc5L2/RQYF+WAqklUdRD8iEpZ811AUY4qdUo4UMeGxAOvhUJft8YncoMLmNa5R2egI2NLPxoyD97SSYUK700K4I4E7W8EzPLh/d8qc1jmulltWL5pMMN/FOCdZ90suLDtR9KA4jAmRI6PNbKgXK0JIoik7FH2H+wdPSa23gOuaAntyoAwejoAWKHZyIItMdJsLRanzytMB2/QSYtYeuMVDMUTrXJBaLiZYkCnT3Y2x4az4E1trv2IMBhEWRazSxzuofK4EnkRUbnnZ2lgw+nSdI9OYvOu+cncNL9CGLQPfkpPRUXP0cXH+KPfLNz3D7a19G1ZphOD2HcBhZ4YZlogr2Ubs5EljHh8NiopNVYZxk6FxKWlARlS2+PgAsTz+UC2j6OtM5ABJqloszQy6nI7B7s0UGYTCKoSinThinttpB7VRs82UnXsmSb4Rv/Ib/ZAmkaGHE6GNC/bRBXT0UwsBbFEKJTFiKTNOepzf9n8Tuz+CAffoTGt0Elw6AYjUFjqdE5VjKNOw0rLX4hhwSbGV0WpJGmbMV1ZjH2MpUxM8hYT+dCzODdfE3KDvrZznWZEb1UAubHXC2SZFrRE8xU2KleKjAvZ+EhnFUSNqpqbBH6NEkwL4T1Al59HZK6ZGCqoFxoNMmWHXQUosSkkNm0KShv9uyzPGlUMut0U5n8cYQbk9kyVPs6gY71d2VJUB1yszJDGCNWh1BLB7l90V4HT24vb7x9W5bAcbbc8wc9V4mGX2e0uxfrHJcfhILtuQmeqGA5tU648giARwUEFbKgsMF6F4af50LNXokCle0FdNhIierpWrE/QNDTGEwuFTHsP+w3HW4fZVGIiKbe8eRG60tHV+63U4xeXnWh90FQa8ZaWOk+quX+VanZ6bbnhxrsJ5Gw21BdWJeVyhuLhQPPQ+UOem/prlrBdYpM32+bNbSR8q37d9q66Twv9ydJ+WOujNHG8s0kGHFxyIgR4jMK28sdmAXWQb8HzTHgSqOIOHh3Vkj0JMMBPMXgd9o3GffyTQDoyH1klyzHCkGNJsxHTS308u0ku9PGrJjVObg5SS0p3EuDHb+KIFpPa5reHgrt7z2FcHMc9XcuLrYf3hSmVSeop3GH9R6yPkilyXDz3LnCDvv9NbpBKPdV5LDpKQwl4tIrACpKfVFI3LwQRhJBQlVqxIPZFb+5iHOI9d5bzNiLM4Xy2LSsnFFciGgltogceyMaOCF8MV5l3coDjEAYMJclGXk/aS/fUVgCjrZQEyUyiqz1YpSIXghnwsNvdQUd60dQCAO/f1np0oRHTr4mBtx+f3m6qgN18Jq4dRE8rmvtOuhdrvztCtzUBalSTSAp8OGsk96gN2il29er2y/s8ma0HzXUXi+yWNAdlO5oPnIijqmPY1axXCcyXTHih8aegiULfYmrTCrm3QpqIZHKVMIIJKYZ4GWeQClPIP5lNPZeJ2LnQrVWXn/93bnXNhl9zJtzoAs10n6RCUlVKeTFukqu+91wUxY9k15I0DklJm5aryNh4ZvJNhuaRhoZ4vTkexJ5SuMGEAndDJHuj7Ai0AF+d0zQSDwr/T1mtzhR+Qw7LmMqaC/KTlq14+b6bkyZUP0igLGjPUYs6SqB30P+N/7hQIcq6X82oPk1z/CuUGI1Q5mglz7/Ag5f4wU= +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 update profile action' (create-update-profile-action)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create an update profile action

+ + + + + +Create an update profile action + +## Request + +

Body

required
    workflow_action object
+ +Expected response to a valid request + +
Schema
    workflow_action object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/create-update-workflow.api.mdx b/docs/api/nerm/v1/create-update-workflow.api.mdx new file mode 100644 index 000000000..a72cfa8bd --- /dev/null +++ b/docs/api/nerm/v1/create-update-workflow.api.mdx @@ -0,0 +1,47 @@ +--- +id: create-update-workflow +sidebar_label: Create an update workflow +hide_title: true +hide_table_of_contents: true +api: eJzFWFmP2zYQ/iuEnn3vbg4DfXDaLbpFkyxib/OQGgItUTYTiVRJyruG4f+eGVIHaXsv9KEbwCGHQ/Kb4ZzaR7JkihouxU0aTaNEMWrYXZnC71epfmS5vI96Ucp0oniJbMD0q2UiVJDKMpL7jtPQtY6m36KGpKNlL1Ls34pp80Gmu2i6t1OuGNxnVMV6USKFYcLgEi3LnCcWz/C7xtv2kU42rKA4MruSwf1y9Z0lBi4rFaI3nGlcbVE8ywmzjOcsRq6Yp94GbRQXa9iQSVVQgBRVFTD0TjCHGllsGKkPJXgSMZtOK4RlGaDQAziGPdCizPGmi4ts9HaSpv3xxeqyfzlm4/47Rkf98ZtsQq/er67eJu+iQw8QUVPpcxCZqApU9bWgq5whyN+4dsPlc4C/bhhAVEQqIqQJ4XJNmDsSl9P6zBB9cycArM4r8HmFwUYis+Du8JJiF+PhcIegBXv9JZ9g1/ENxxe09EOvNYvHVf68UG5vc2t9og4VfM/zvDaKUGCaGL5l0QGwGG4s6cgVD/YPgehSCu3MeTIa4X8hmOuHEs6HN2xYiZGEki3NOdKsQ0b/g++91N1o+lnkO6fox62s4OIvJtZmE00vJjClD/705JQG5ouc/tAGLqZev8GxPu61d5opmH5itY20c5okTGs7XXpG+TK9PRGWNuDXrQmC5Wjgcaa4crYJJ8LcbAYEdUZmzhzAzQncQu7CUK+jAJvvLVQpugMs3LDirBedaO1R1Po/w/5ATbIJUT8fUWnJ4/olY43e0UPnUHJroywFDGvhhgZkBNxiHRuJcUOZ2Is0s7vFH/35Yra4m4/D6SScXoTTy3B6FU7fhNO34fRdOH2PKCsA56FeoU7iRGLUMZYCXp6gImNQWZxWLg6Av8JKLrVj8dllpeAZYpr6M/YAkcQngBuAf8JBHs1VDGip7S2gai1zp9uMcpfKsioHA3BjLrbc2LjUvEae0jLGB+Gp5RAM1S0QBKCUO8ZiV8mkx2R3vyMbnnE7LAE3Su8emeY+yaqtcNc2xFD+Y2qrh+MFXx/Ha61e2gXEjw7RkWqdHIFBXXhTJ1ZyvLfNbSyvo3K90KWCjrLlVp8NwTlMnGyoWLOALiEX4tEJSyvlL4FHrdc2oDWUTkBkB61aj2tgWQNsTbJb0DVg5pLC927o4qwbI1471BLs4shzrVcCTM8vA4HsvlNJKuG7zD3l1svhpbxz2nTSnLT0s3nnMQcbKRRfVYbpcykSDInjg9H8NkiWYYA6eKfDGthZ3B5rK6WplYwnBNfQx0DjJyyj8XB8NZyMJiNP/07LJ7y3dfLASgqzbZUbDtfHr9jWmzOoMVIS0BYbrkJSXYrYYyAGPXIwZsUTMK/Z16DpCA5Kd/DBr76aumvu8k5bfl2eq7g+0JR8cbZH+qSyFTIWXY0dDF5TbknBPmeQi05tpcF2I2wt9yduPfQe5/sbuew110pJBSlw6YS4OifEDeBTYIdkztQWdGL3gDiKmUoJbAmg6xNg7in2B+whYXanfpVwT1eIDK88RTYjBbwCXTPi6CtM/FhXO37f8+ZSqR3RsoAmx5YHgIrcK4k+1Dwhrkm0jVK66EexaoyGbakwdBEr7moHiBNWKdq+S6Vy4N8YU+rpcLgHyakwaEKHAWScJuEM4PWHUE/A5i1VHG3CeXbL7iTNKJizbQEKsNDTSs6yE+yDSBOWrG1VELoKCLQg0xLxJZBOzM4CXDGqmJpVKNe3pb88x5dwOHym9mFQKJTWssHcMWHlYAe/N/XbQv5gAmDA7y87SGRuaPsXfPQvXdt/3cUtv1U4acRf1hZ3NZzX/DpPr3vGpmUMWrzTDs/vuLjIJGLCB3ZKHw9Gg5HnSZ+uv3wks9ubs3V2s0gSKrA0rbR7IVfOE3AYUsiUZzuCdiChR8Syp1KwSrggVn0MCh2wUkzw6E/gQQwaNwRVS/PxZmGxos0WVHgrT32TCcDuOzd9+kOOMwXMJMMyp1zYXh9tfl/7iv+RB5aOvQXsbYOuBXz7/YpqdqfywwHJYBUKTXTZ+YS1UNgADRsYGlrvD7ZDhA5rf4FokD2vbItxHF4wALodswRD0pO8S8/7bz/PF2jY9acpeCLcoyiqAH+n0T/wDybSxTn7/Ypa480h51cQj4DHnYt/PwExucwX +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 update workflow' (create-update-workflow)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create an update workflow

+ + + + + +Create an update workflow + +## Request + +

Body

required
    workflow object
+ +Expected response to a valid request + +
Schema
    workflow object
    = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
    attributes object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/create-user-profiles.api.mdx b/docs/api/nerm/v1/create-user-profiles.api.mdx new file mode 100644 index 000000000..848f0845b --- /dev/null +++ b/docs/api/nerm/v1/create-user-profiles.api.mdx @@ -0,0 +1,47 @@ +--- +id: create-user-profiles +sidebar_label: Create multiple user-profile contributor relationships +hide_title: true +hide_table_of_contents: true +api: eJytVttuEzEQ/RXLz01SegkQiYeCihQkoGpTXkpUze7OJoZde/Gl7WqVf2fGbtItKVW4pFK6ts94bmfOppOmQQteGT0t5ETmFsHjpUN7Zk2pKnRyTxbocqsaBhHkXYSIOlReNRWKQOBBk9AiN9pblQVvrLBYxYvdUjV8jYeFk5MryQaiWV8/35MWfwR0/q0pWjnp4lJZpHC8Dbgn+U7Uno+gaSqVx1tH3xyH00mXL7EGfvJtgxSgyb5h7skh+aDkvCIvdMpurzduH+BgLbSEVh5rt+M1qugBHWWsFwQsja2B4pQhEGAVLdnbrnCN1+BT+Xa26Rf5OqG3rVCHmitvbjVamSp63yU5X9EtXvmKLXqNl6v0YReuIQcp/YP9ff73mBKndw2VCguxhgpvBIgbqBTvxe7KP2ik0fi5pIC3e/FEoI7K8HvgB5PJ1TwlcvRU7G+hEOcpRDEQQUNWxfBzUxO7PQ7/b+BTHavygU2fi/sLo6KbU2uNdZskjp9KYkrxWQ2VuEB7Q9MVbSgdiz5YTY0xmlJbgi4qWuBdjtHS/VFyz88FssvtyE5Ejc7BAkXaz4iRwi9RJDxx8w640AS9MNa2wpka/ZJRtxSVuLWGKLzhIp8ZFqrGREo14Je0Gj0e7j3pYh1cbEWwFUGW3jduMhp1lCxo/wlqXA01NYy8mxZxSA0fQaPI+AasYhokNdjAU3IlkPCxbOQ15mZLHWcRLjThBTinFlx9plNwnjKznMqc48uDVb6NAWYIFu1J4FSu5v3jCy5+iqMP2vSCk+JsI4zWCUQ76eH9Wi1m5jtqCoO+37Qm2PQouaLc5/MHAT5dt2NLMK962icPS3h1XI6PBscvX7wcHB2PDwbZYZkPDvLX48NyPIYSxvKxAO5qs6WCuxo+IYX3ikezQ/quS8NpMS9Sr14M94f7vZn7dHr+UZycTbebSnxdH4octMjiay82FvKcCC5otERtClW2guljgmMxpFLTqVBaxKqjvlHE55qIzZNHs4YklhyUjvySH6ez2BRmdw26d/LXb91HmXQP0/4P7/FUWo93ftRUoFjI0pB19/N49Qt3iNFLnlc66LoMHF7aarXibeKd5SGYP0xdnAEyQCiodUy779hyvCnywYzdM7wK8fX9q2axqiaLk5x17lnsvCcpZ58vZjw69z9DqJtsY+GWuUXfE/mV/mhhknjG3yq838kK9CKQyBEm3cufn8tSQEM= +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 multiple user-profile contributor relationships' (create-user-profiles)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create multiple user-profile contributor relationships

+ + + + + +Create multiple user-profile contributor relationships + +## Request + +

Body

required
    user_profiles object[]
  • Array [
  • ]
+ +Expected response to a valid request + +
Schema
    oneOf
    user_profiles object[]
  • Array [
    • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
  • ]
    • job_status object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/create-username-password-action.api.mdx b/docs/api/nerm/v1/create-username-password-action.api.mdx new file mode 100644 index 000000000..537275127 --- /dev/null +++ b/docs/api/nerm/v1/create-username-password-action.api.mdx @@ -0,0 +1,47 @@ +--- +id: create-username-password-action +sidebar_label: Create a username password action +hide_title: true +hide_table_of_contents: true +api: eJztWG1v2zYQ/isEPzu287Z2AQYsLTLAw9oEibt9yAzjLJ1sJhKpkVQcw/B/3x0pOX6L6xQB9mUpkEjk8fjc3XMv6lyaEi14ZXQvlRcysQgevzm0Ggq8AeemxqaXCQvIlkzRJVaV4e1Cfg7CAkRVy4uyPiCgOeFh7OTFvaTVxyw303rHyUFLWvynQuc/mXQmL+bhVVkkGN5W2JKJ0R615y0oy1wlAWbnwfHlc+mSCRbAT35WIsExowdMPN1ZWjbKK3S829w8rDEdfkClK8LOW6XHJJwZWwChklVFAq0t2Os+6k9QLG33qy8RjhhhbvTYCW/apAyfoShzvu/0NOt+OEnTo+PT0dnR2TEeH31E6B4d/5SdwPnPo/MPyUe52LhuG+330a2sCJPtwrgO7MaaovRBjuMuyB/8ouwLDUCnSyq0GSTYZKKecNWfI2NyhEiqDKqcPJpB7rYg9nZCEsqJRqkgANr4NZRB1YJu9soH1K9QehF+2E2uJFZGApx0u/xnHcfVc0lkodsaUYoYUf8JcsVrgcnyf9K+M2l3UuJHWHsbVQoKijUUNJERjYmohk5G5jKNQIytqUrWyEtOTJWf0Kqj2KtMJcISaQOjSxjju/male30s5uYKmd66RTtj7ka0nRY0xPtENzQTDXa/Ym4C2edh0tVDbYR+TRNKS/ABYGgvgkJ+TpTeUgVkovNJV2zg68ilJQUKh+CJx+OKv92z77Kk6VK4bxhNQFXuI5xUzK7poLtJ9Ch/q4tiapjbtZmgLUw24VaeSzcXns9PvutvAn2rVmCh9lyLx/MRKcGfx3z6XZiCtp+AI3rawO6UeN06Dz46gCABwWEFIqocIn1Lr5+noAefycKXLafsCV6Guqnay3+QOCnPtpCaWbYf9hyWtI9qrKEES+9481Lrfuurt3vhhS9ou5C74Og0Uy1sNZ9UNf9q1az0W3PdjXYT5CK21hdxJGodDCWCgfdR8o9tt/SXY3G64yYvt02G2g9HVr373x00Xpd7k+WCtdcWWusk4tBNOJ8lxE9wkdzRi7u0D5RHQxnyByLvrKaiaPJNCJ6mtMLPicYTro3Gbd/EkC+chvZpSioQnCjieujZS0M8qtJdmesnQlnCvQTlppyuKeWOn4dQbKe9wx/MZQmzD0l+Am9dTYGF9dphsJhMxA2O3TIBSe5EKfK5nR+4n3pLjqdOXkCtP9KBxdtTdEkaGaGyHWpA6Wiw09gFXMkFqaleLS8priEpMDEbH259IO4iMOqc2rMoWGuVdQlCmqPZOOA8SWVVX4WAI4QLNrLiu28H6xu33FkIo5VoWWg2Ci2NohxLgYhWokPvzVFtG8eURMM+v3LzFQ2Pkp2N5Pg9uVz6aqJ1c5JcW0WPKxxbTrozUP+asFdlgGlM8OAOMhR73G72+6uZNfXq9sv4vKmtx0hurnZFAnwyMlXhyhBknDbZgCFSVU2E8wFQy2EKhT5jXaF0iK4EPWTIuZyxWKQlFVIszuD0oEs8kuvHzzMPC5Ar+wc8nm7McguU/iwb+NID+6dnTIHxYUo5sG8zqf7zfBy1ryeUcTJCacjnZvPR+Dwm80XC14m5lim8eAlbwKL6QBCyvMgMfwRZ4w82nDUZ3QsnldhetksSVw044nLhMvYXtnBSsW4ub7rM/nrz34KIZ+xMOUBgn5fyL/pH72YWBvD/w3w+lzmNCFUVMNIJurln38BGNvb+g== +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 username password action' (create-username-password-action)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create a username password action

+ + + + + +Create a username password action + +## Request + +

Body

required
    workflow_action object
+ +Expected response to a valid request + +
Schema
    workflow_action object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/create-workflow-page.api.mdx b/docs/api/nerm/v1/create-workflow-page.api.mdx new file mode 100644 index 000000000..75275a50a --- /dev/null +++ b/docs/api/nerm/v1/create-workflow-page.api.mdx @@ -0,0 +1,47 @@ +--- +id: create-workflow-page +sidebar_label: Create a workflow page +hide_title: true +hide_table_of_contents: true +api: eJztVktv2zgQ/isEz341TdyFgT2k2xRwgTZB4t09tEYxksY2G4nUkpQdwfB/7wwZWfKjWfTUS23Alshv3t8MuZWmRAteGT3N5ESmFsHjv8Y+LnKzuYMlyp7M0KVWlQwiyF8BIkBsnlGijDAPSycnnyW/OjnvSYv/Vej8W5PVcrINr8oimfG2wp5MjfaoPW9BWeYqDW4Mvzk2s5UuXWEB/OTrEsmwSb5h6slQadlpr8gK7Qbr/4uqVNYBOW+VXp6ENluhIKAwC+Hp8TkufIKizFmMF76ypt2R5F6xxyd/IMIpFAtj99k6a7SzcmCc7Ggo8JznrYmPtQhWPjHynHZWcawWbLpSa+wmJTEmR9Bd3QvIHR6rfIcebaE0OrFZISm1e81CObHXTFbOJ53SUQDVXVacS+YJZLc6rxtinEbQ1oRlD6K/wNE4+ePNuL+4vBr3L9+8zvpJNr7qJ+PL11c4SsbJBblCvnjlg8ABuXfhwy640mgXuXIxGvHfoRs3TyXxCjPRQIU31ARryBWvBabL36T+TepfQuq7MHMbNl+eI/BbyMR95Knoi0pDkgcOp4aNehz8DHuNxtsFDftThjYeTXVojQ8suuv9GPcPo4KZG2uNpSDmMYirc0FMyT+rIRcPaNdUoyBD4Vj0ldXUncS1Sq9AZzm94FOKQdL9VHAvNx2yyVPPrkWBzjFd4npCtAjFjfhudR+MtbVwpiCeMWpDXomNNcSjXVNC3jN8IpcmzJUS/IrehuFwHTZ99zWetT3pQjpcqEhlc0KuvC/dZDjcUsygPffRbqCpbuSEqREHVPchlIqE12AVsyGE18JjjAuocqY1pAWm5rQVAzx2IzinllwEZlXlPAVoOaI5+5dWVvk6OJggWLTXFUf0ed7dfuAaRD+6oH1JOCiONsC4uwOIVuLD+6YHZ+YRNblBv3/WprLxMXQMl/u+vZjcNFVpZ26Yqu1YPI743PCL8+x4aLXjKIwctq70wrANLlZU92owGow6/fDp5v6juL6bnh16zaZIQYuE5rqL2YY0JfIJor0oTKYWteCamsrxaUXx065QWoRUoF4r4lpBpOOuoD5AOs3YqSaK6SxkiplXgO7s/PDqd3Ru7Dvthctie7QMyxwUD4nI3O0z15uLZE8esZ34suKmIMR2m4DDv22+2/EyVdUyxeYtpwPDSICmMRGF2feINTsWXezP2A+G5xX7czIYeHRFieuUh8mL2Hmnb+9uH2ZMzOfLL5WFZSwwXfh3Ir/Ql15MnFDhhszrW5mDXlaBjDLq5c939xIC4A== +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 workflow page' (create-workflow-page)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create a workflow page

+ + + + + +Create a workflow page + +## Request + +

Body

required
    page object
+ +Expected response to a valid request + +
Schema
    page object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/delete-attribute-option.api.mdx b/docs/api/nerm/v1/delete-attribute-option.api.mdx new file mode 100644 index 000000000..4215bc8de --- /dev/null +++ b/docs/api/nerm/v1/delete-attribute-option.api.mdx @@ -0,0 +1,47 @@ +--- +id: delete-attribute-option +sidebar_label: Delete a option based attribute value by id +hide_title: true +hide_table_of_contents: true +api: eJyVVd+P2zYM/lcIvXQD8uvucm0XYA/ZLgMyrO1wl/blEBS0TZ/VOpInyekZhv/3kVZySZesQPIQWxIp8uP3kW6Vrchh0NYsMzVTGZUUaB6C00kd6EMlJ2rA+z51Oq5m6q63AgTb70CCnjLAvRdssawJkgZ0xr4Bn7yaParDeXTzaj1QFTrc8GVOTFpleMEBej8toSoMxUn85R3YHELBNyVfKA0QLDji22lLA6irDAM/rYMIh/0d/VNrRwwxuJoGyqcFbVDNWhWaSiJ69jZPbJlbt8HAO3XdZ0HPuKlKMbm6nr7O3iY3Q0yvfxlOJ1e3w7dXt9NhRjid3kzxzU2OquvWEs1XjI+8BLieTOTxPYLfrcm1BJLyMRbcpZrtEHHg1JpAJogvVlWp0954/MXLBe0pghfHygmnQcfw2uT2HM6McqxLAboq9ozAqzYyDp+Ewe4VFOghITL79Bif/AZqeg7Vb5jBPVeafIAh1AaTkoSb1EoJA40ugWUNfch7UfwXYNChJ2RpWGg6+1Ncu8H/230Sqz7MwjnLSuvWEcTtORBLzs8ZLOGB3JYc9D4MhwVWOyMMGYZWoMlKXtBzSlHNF4H7MWckIU8zm8OGvMcngrifMJN9F0T7Y60+WOca8JZbqxCrb5wVfHOWqe/2FMqZPTS9ZCHNNlNjQ59fmvXzrlnHrc46tvF9VWK31q5k8yKEys/G45ahownvuYW7kWH6OBfbEI2Y/jFWmp236LSIokd5MI9Q93rEdEOpPWn6VW8OMiEAvddPwoWIq/aBcToBtpb80trp0PQJJoSO3LwWWI/r4+MHoSLmcWz0woyAUrs5IetoxDvx5Y/9lFjZr9wdQf5/bWzt4quS+u47T8oVIVyNJqPJkTDfL+7fwfzv5SlWJnV/CCnyhCWofcSLacoqANYfbGym8wakqrb2rFDPGfApaAN9MmS2mknfMPsiTxYk8ViSpHaD9t1y1edaWR82aI5OLpvx36XfHvrg0k9FLH6g5zCuStTS11Fl7U6cj+qcONl1xhcwvwUDEau2lUgfXdl1ss0zyYkk1gcN9gLJtJd37oIcS08/APLT/e4T8jNc/vk5i2u3iabpO4PrwCt+/UpN/ATymGJAhBkLT5KNB/NUJs6Ry8mkEZ2/NPfd4q/FasEk/wtIor0Y +sidebar_class_name: "delete api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 option based attribute value by id' (delete-attribute-option)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Delete a option based attribute value by id

+ + + + + +Delete a option based attribute value by id + +## Request + +

Path Parameters

+ +Confirmation of a deleted object + +
Schema
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/delete-profile-type.api.mdx b/docs/api/nerm/v1/delete-profile-type.api.mdx new file mode 100644 index 000000000..517b8af6b --- /dev/null +++ b/docs/api/nerm/v1/delete-profile-type.api.mdx @@ -0,0 +1,47 @@ +--- +id: delete-profile-type +sidebar_label: Delete profile type +hide_title: true +hide_table_of_contents: true +api: eJzFVU1vGzcQ/SvEnlpAX7blNhXQgwIrgIomDWwll0AoRruzFpNdcktyFQsL/fe+ISVLsVwDPlWH1S5nhnxv5s2wy2zDjoK2Zl5kk6zgigN/dLbUFS+2DWc9rPnc6UZ84HETPRSpJjmpAK+BmlbVYcUrW6qwphBNqm59UKV2eK5YYbPg7JYLfJTWIXzNP2ylcjI/OA4AIdC9zyZfslNHny17WUOOauBxYu4ygw9g1AVitKBtKKzPKMxvEkJWdvWVc+C0ynFwmjfcU21TUMC/dSplA/GO/2m1Y2QouJZ7mc/XXFM26TJBgi2BVZt7eIJTTQErbRtR8APVTSUuF5fjX4o3q6s+5Ze/9ceji+v+m4vrcb9gGo+vxvTrVUnZbreU03xjjQdDHHA5GsnfEwamtIpWtg2JxqGGODC3JrAJEkNNU+k8GoZfvQR258hTChCI3GKboNOxGiecnztVNXtP96iSNahpDdJnCI6U9+lNaSxATn69bPwcpbdUqFukGWVXfdUaWkmdLQ6SzQIPXsPNGv6rjIp4yjLoEKHNzYYqXfwhobvef/t9Fq94zMw5C5ntlonE9fN1gRQNVeqO3YadijGgA3W1zkD01oDamkxR4YMfco6R/lXkXi4cy5EvVS6trw6VS/6nVbuzzm2Vt+irtXh9Byr13Vnoe3coodjscWAICum0STbct+jfsUWHnS52MPqYjtSjravgtw6h8ZPhsANnMuEDGnc3MKgbQKDreYC6D6nRCN6Q06KGSO/onjiW1FbSbpTXnNuzVl9EdyVzQZH3+l6KIKrCUAJBJ4yWgi9vnQ7bCHDF5NhNW+HzZXlqvpMaJBynTo8lEVLZfjrId3LCSnp5d5gNC/uNDWDg+fvWti69ZpLYQ99JuhKFi8FoMDpR5IfZ7Xs1/Tg/54pqHoyHKdr6xJfyHOVXEJ6qbaHLrZKs2tZDmh4IYFXaqAiGzUaj2jXKLrqEEhnDSEDtx+v7+SJibawPNZkTy/5yOB3TT2F2R6H/T3dJqlXghzBsKtLS/0mU3V7Ej/dMEjFiJpjl0MEahMXcdSvy/MlVu50sY2g5kc7yqNUopEJ7eUeblFR5fiERP93uL5if1esvp2cJ7RfJbGMHVa184fUbb9MFiTkGQkwFBCpgk2Gay0g6CTkbRdIPj91/M/tztphBDP8Cq2be/A== +sidebar_class_name: "delete api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 profile type' (delete-profile-type)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Delete profile type

+ + + + + +Delete a profile type. All profiles of that type must first be destroyed before the profile type can be destroyed. + +## Request + +

Path Parameters

+ +Info about the operation + +
Schema
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/delete-profile.api.mdx b/docs/api/nerm/v1/delete-profile.api.mdx new file mode 100644 index 000000000..6793db228 --- /dev/null +++ b/docs/api/nerm/v1/delete-profile.api.mdx @@ -0,0 +1,47 @@ +--- +id: delete-profile +sidebar_label: Delete a single profile +hide_title: true +hide_table_of_contents: true +api: eJzFVU1vGzkM/SuETlvAX0mcbdfAHgLECxjYFkXjngIfaA3HVjsjTfWRZDCY/77kyImddVugp/pgSyIpvUc+0p1yDXmMxtlVoRaqoIoiffSuNBWpEe+D9qYRO1tvBysgBGN3FUHz4hdxF9TiXh1OgtqMVIMea/b3YumU5Q3fYQp2N3Jbg3F/9sTqFlwJcU/gtl9IR4gOPEVv6IFGkJoCI/86Dxkpx3v6lownRh99opEKek81qkWnYtvIi4Gj7Y49S+drjHyS0oCCnrBuKnG5uJz/WbzbXo1RX/41ns8ursfvLq7n44JwPr+a49urElXfb+S10DgbmCE/cDmby89rBmvGfkggPGKAkLSmEMpUVe0BdTFR/UjNZ7Pz6KX3z+QYNBwroZ2NZKNEYNNURg9Fm34JEtads87p40AuCZc4mgyZ5P7zZ2+gZoy4I8jnW3lcqjD48wojOK2Tl0SP/pfZfviM1PX3CK0YtrdYwR35B/KQCY6lqMlbKsBZSHaPtqh4Q0+ahsgw+c2cX+njznnfQnAs5714PTIqePTuhTyzF5s79pCgEIEv1PS5KaadKXo+D0MmclckX7HLPsYmLKbTjumijR+4VfqJdZb4fdcSTbSrp9gYDn5Ab3BbZWZH90yvxFSJwFHXpN1Zc60Hd5BOBAzB7CT/3GA6hcjcvJDZCD4utIntAHBL6MnfJKFyvzk130n6M45Tp5dqCCl16EfZZyc+yYt/nrtx7b6SZRj8/Xfrks9LJTk1tnRyo6QrU7iYzCYzUaCJQ2U+LD+9h5uPq3OuXMhnI2i0sCVIIfPFoSOBNQe1K0zZgmTVpcCqDIyArWAsDGDIPhgudM0VF0myCInbX0AdBtr71XrA2rgQa7Qnlh+Py1dQu6POfzZhc1IjPcVpUyFPUH5zUE93ENrJ9B2pBU84rtWeQYml67YY6LOv+l6OvyXyUt7NUU9DsQsTZM0qLrEK9BOgf3w6jN038Osj+7tcDodo20HlVZIdL79Sm/82+g177QkLFpGAzYYbLRPjJORsUohmX5rzdvnvcr3kgv0HYX1nIQ== +sidebar_class_name: "delete api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 single profile' (delete-profile)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Delete a single profile

+ + + + + +Delete a single profile + +## Request + +

Path Parameters

+ +The Profile was successfully deleted. + +
+ +Error deleting Profile + +
Schema
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/delete-profiles.api.mdx b/docs/api/nerm/v1/delete-profiles.api.mdx new file mode 100644 index 000000000..cd3e1b84a --- /dev/null +++ b/docs/api/nerm/v1/delete-profiles.api.mdx @@ -0,0 +1,51 @@ +--- +id: delete-profiles +sidebar_label: Delete multiple profiles +hide_title: true +hide_table_of_contents: true +api: eJytVdtuGjEQ/RXLz9xygbRIfSANlYiaNEpoX1Ieht1ZcLJrb20vCVrx752xwyUlpYpUkGA9c7xzZuZ4XEtTogWvjB6lsi9TzNHjjTWZytHJBhlcYlXJAHJfBLcoqtyrMkdRboEeZk727+XGNGlIi78qdP7cpEvZr8NSWaQ43lbYkInRHrVnF5RlrpLAo/3gOFYtXTLHAvjJL0uk6Gb6gImnWBSDWHtFUci7ibhFgrWwJKDyWLh/v0GlOxjnrdIzwmTGFkDsZFURYLX+cFquNNrFvcedDv+9rtPwuaQ4mIo1VHgjQCwgV2wLVZHvKIDR+C2j6u4n4pXP2bBp2arxd9ClmcrVJCZx+hbvc0jFbaQnmqLSMM0D9cQUJXe+9X9Jj3SoyCVvPcT7B6NCmKG1xrpNEt23khgRP6shF3doF2hF2EPpWPSV1dQUoym1Oeg0pwU+Jxh2uncld1hQyCH3mQ1Egc7BDEW0T0lows9RRHxD4jNwoQl6Z6xdCmcK9HNGPREr8WQNKXOjQ/aZ7allFuDntG7vnEsXiuBCHyqbk3fufen67XZNmYL211DgqqWpWxTaLBFb1O02lIo2L8Aq1kA8Qxt4zCwDGgN82JICE7M3K8YBLjThBTinZlx61lLlPKVlOY8J80sqq/wyEJwiWLSDirO4n+y677jykccuaNMIToqzDTBaRxBZ4sOX9Vkem0fURIN+Py1NZeOj5HJyk2+3E2u47sXuhLmPw0KeZPChm/VOm92zo7Pmabd33JyeZEnzOPnYO8l6PcigxyqlEaQzw+/gJsTCHLU6rc6Ouq+Ht1dicDParyApY+0UCWgxRVG5WEVIEpKSIBGLwqQqWwrulakcjxzKi7xCaRFSRL1QpJyCJMQaJ1UjjSQmpUMz5dVoHCpQGucL0DueAwP/Fdd6e3IOXhKxWR6ffbvMQfGxj6qsX7T7+gKZEyG21fUUHH63+WrFZuqRZcFMtgoNeqENCCm1nfv0iASRnyOt5pgjMzyvwgXx5+Hm8RN3DBIeCAexk52zdzH8OhwPWWgvtxy1g3dZeCIj//blT/rSwsQ5E65CttcyBz2raB4QJr6ZP78BkJOgJw== +sidebar_class_name: "delete api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 profiles' (delete-profiles)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Delete multiple profiles

+ + + + + +Delete multiple profiles + +## Request + +

Body

required
    profiles object[]
  • Array [
  • ]
+ +Expected response to a valid request + +
Schema
    oneOf
    profiles object[]
  • Array [
    • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true,"description":"The objects UID","example":"profileUid"}}>
    attributes object
    + +Attributes that belong to this profile. + +
  • ]
    • job_status object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/delete-role-profile.api.mdx b/docs/api/nerm/v1/delete-role-profile.api.mdx new file mode 100644 index 000000000..82ce5d1e5 --- /dev/null +++ b/docs/api/nerm/v1/delete-role-profile.api.mdx @@ -0,0 +1,51 @@ +--- +id: delete-role-profile +sidebar_label: Delete a role profile assignment +hide_title: true +hide_table_of_contents: true +api: eJyVVdtu2zgQ/RWCTy3gWxKnFwP7kEW8gIttt3CyfSmMYiyNYrYSqZKUE0PQv+8Z0WmcOl00frApzozmnJkz41a7mj1F4+wi1zOdc8mRl67kj94VpmQ9wF3IvKnFBx6XvYci5eGk6uSlKARzYyu2EQGRboKefdaHHkGvBromTxWivZhbbfGAN5ocMUbeXVPcHCVcXCpXqLhh5dZfOYsqOuU5esNbHqimzini13mVsCPe8/fGeAaf6Bse6JBtuCI9a3Xc1ZIxINrewLNwvqKIm6bpUfAdVXUpLien01f5m/XZkLLTt8Pp5OR8+ObkfDrMmabTsym9PitId91KsoXa2QCGSHA6mcjPYwbLw0rdUgBSIHA7lpSZs1HKhiiq69JkfTPGX4OEtsfYUxGQuusGevpUuj8pV0uUAEnUUDWW1kiLomVOuEUePSers/xP0XfrcX502cS+Ugu7pdLk7yS0G/za75N49Wnm3jtIoFslEudPkVgAn7dUqiv2W/aqjwEddL7xlnPlLKhtyOYlHvgu4z4yPIvcz1DRI0xDNKmXLCmPkV2oikOgG1bpfg0p9fJM/ociunLe71Rw0PxGvG6BSt16B+116TPQYnMPoycoZApmeizj82Uvm3Fr8g620FcjjU/jS7htYqzDbDxuQZls/ICZ6kYWbQMGSIxHaPuYaoPgLXkjYujZPbgnigU1pUwCZRVn7mgKr3t3JSO7H3aUXUTVhAh+XgitBF/WeBN3PcA1k2d/0Qidz6tD85W0IOE4dPrRESGl94Mrz8kJN+nw1/3YXrtvbAED33/sXOPTUUtdjS2cvFHKlSicjCajyYEgP8yX79XFx8UxVzTz3qgysmrNqgmJL2UZuq+gO1W53BQ7JVV1TYAyAxDAqoxVPRi2W4Nmy1YUWUKIjD0hoPab7/3iusdauxArsgeW39iyjzC3D6L/rQ2dyhz5Lo7rkoxMbtJTu5df2t738kPIDAsSHdwAqljbdk2B//Vl18k1to2Xpq8eVNZLIDdBztB3QWXg/0H9Yrnf2i/V8zf+k3z2l2R3vfbLRp5w/Ma79K+DBQRCTDmkJWCT4SKTXXIQcrRDRMk/xvZy/vf8eo42/gf7/YO5 +sidebar_class_name: "delete api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 profile assignment' (delete-role-profile)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Delete a role profile assignment

+ + + + + +Delete a role profile assignment + +## Request + +

Path Parameters

+ +Role profile was destroyed + +
Schema
    + +object + +
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/delete-synced-attribute.api.mdx b/docs/api/nerm/v1/delete-synced-attribute.api.mdx new file mode 100644 index 000000000..3b8413bc6 --- /dev/null +++ b/docs/api/nerm/v1/delete-synced-attribute.api.mdx @@ -0,0 +1,47 @@ +--- +id: delete-synced-attribute +sidebar_label: Delete synced attribute +hide_title: true +hide_table_of_contents: true +api: eJzFVdtu3DYQ/RVCTymwN9vrJF2gD1t4C2yQOIbt9sVYGCNp5GUikQovjgVB/94Zcm9ZuXabl/phTZFnOHNmzgzbRNdowEmtlnkyS3Is0eFNozLM584ZmXqHyYD2bWZkzThCXQSUAGEDUMAWOSKogwebzO6S4zObrAZJDQYqsjUMaRNFH3RfbXQhS7x3TY33MqdLJLupwa17vq8iVjBWLC+ELoRbo9DpF8wcoQ1+89IgkXHG4yCx2RorSGZtwhZ0gaV41AMhC20qcLTjffCJT1DVJUNOTqdv8/fp2RCy01+H08nJ+fD9yfl0mCNMp2dTeHdWQNJ1gx0Bhfc7nq8RuMR9Tv5nAiv2ZmutLFWHHJxOJvzvx3iXqtACUu1djHOrF3KYaeVQObaBui5lFg7GXywbtv3Idxyp4HSNk9GtJA99v3NRobXwgILcFNJURLoXwZ5yvFtEAedEjv8GyfQ5Sr9DLq4pzWidGAqvIGVBaXLEl0UZ/2tuWuHnIqj5mKWTLoS2VI9QyvwDm7Jo/gn3F6OCm4UxmlqkW0US58/XhdpIQSlu0DyiEcGG6Bh03ijqPK2I2hpUXtIHPmUYLO1/Ivdy4ZBdvlS5uJ9uKxfxh1W70cY0wmqaCWtGfaeoxHejSd/dtoR8pvfDiaPgvpol48O5Ycft0RjpxnEE7VuTMEed2tFtNuQvDiRvSrp47VxtZ+NxS0kC5S6pybuRokJT1LpBHJFQxlBLMn4EI1k+IR97eExKAb7k/oSswkz3JsFtgAueIQKslQ9cNZaht44yYjgFK44v80a6JgSYIhg0c88JuFsdHt9w0WIch6BdDZlUshkn/B1BtBMXf2yHya3+iorCoN/fGu1NXPK42zUqpytSOBlNRpMDCV8urj+J+dWyz5XKvz0UGSiRovA28oUsI70IUqqodC6LRnBWtbekZUsR0KmQSoRgUD1KkkdFOmEhk3SRphcHtRnFn5a3IdZaW1eBOjjZvFrH79JxqO2+O1556GJeHT65cV2C5OaOAmo3Cr374WWzZDPrP3U9kTLs+EGhOq+JEF/ZtilY/NOUXcfbNMUMS2O112IQSi4tr6lvCigtvkDyzfXmxflFvPa4Pkt5swmqCf1Qev6i5VdsnnnbeQD+VGyvvZs/EdtxlmneUp4RcuoLzmFEzTMenQf2vZHJbbibUheLj4vbBWnwbxOePVg= +sidebar_class_name: "delete api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 synced attribute' (delete-synced-attribute)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Delete synced attribute

+ + + + + +Delete a synced attribute. + +## Request + +

Path Parameters

+ +Info about the operation + +
Schema
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/delete-user-profile.api.mdx b/docs/api/nerm/v1/delete-user-profile.api.mdx new file mode 100644 index 000000000..65aa93db6 --- /dev/null +++ b/docs/api/nerm/v1/delete-user-profile.api.mdx @@ -0,0 +1,51 @@ +--- +id: delete-user-profile +sidebar_label: Delete a user profile assignment +hide_title: true +hide_table_of_contents: true +api: eJyVVdtuGzcQ/RWCTy2gm225TQT0wYEVQEWTBr7kJRCK0e6sxWRFbkmubGGx/94zpBzLlVvEepC4nJmdc2bOjDrtGvYUjbOLUs90yTVHvg3sP3lXmZr1AHeh8KYRH3hcJg9FqoWTarKXohDMnd2wjQiIdBf07Is+9Ah6OdANedog2ou50xYPeKMpEWPk3Q3F9VHCxaVylYprVm71lYuoolOeoze85YFqm5Iifp1XGTviPf/dGs/gE33LAx2KNW9Izzodd41kDIi2d/CsnN9QxE3bJhT8QJumFpeT0+kv5ZvV2ZCK07fD6eTkfPjm5Hw6LJmm07Mp/XpWke77pWQLjbMBDJHgdDKRn+cMbg8rdU8BSIHA7VhSFs5GKRuiqGlqU6RmjL8GCe2OseciIHXfD/T0pXTvqFRXKAGSqKFqLa2QFkUrnHCLPHpNVmf5zyp163l+dNnEVKmF3VJtyt8ltB/8t99n8Upp5t47SKBfZhLnL5FYAJ+3VKtr9luUL8WADjrfesulchbU1mTLGg/8UHCKDK8i92+o6BGmIZrcS5aUx8gu1IZDoDtW+X4FKSV5Zv9DEV0773cqOGh+LV73QKXuvYP2+vwZaLG5p9ETFDIFMz2W8flrL5txZ8oetpCqkcen9TXc1jE2YTYed6BMNn7ETPUji7YBAyTGI7R9TI1B8Ja8ETEkdk/umWJFbS2TQMWGC3c0hTfJXcnI7ocdZRdRtSGCnxdCS8FXtN7EXQK4YvLsL1qh82V5aL6WFmQch07fOyKk9H5w5Tk74SYf3j+O7Y37xhYw8P3bzrU+H7XU1djKyRulXJnCyWgymhwI8uP86oO6+LQ45opmPhpVQVatWLZd4ktFge4r6E5tXGmqnZKqujZAmQEIYFXGqgSG7dag2bIVRZYQImNPCKj95vuwuElYGxfihuyB5Qe27DPM3ZPof2hD5zJHfojjpiYjk5v11O3ll7f3o/wQMsOCRAfXgCrWrltR4Ftf971cY9t4afrySWVJAqUJcoa+K6oD/w/qn672W/tn9fqN/yKf/SXZXdJ+3coTjt94l/91sIBAiKmEtARsNlwUsksOQo52iCj5+9hezv+Y38zRxn8AwwOEIQ== +sidebar_class_name: "delete api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 user profile assignment' (delete-user-profile)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Delete a user profile assignment

+ + + + + +Delete a user profile assignment + +## Request + +

Path Parameters

+ +User profile was destroyed + +
Schema
    + +object + +
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/delete-user-profiles.api.mdx b/docs/api/nerm/v1/delete-user-profiles.api.mdx new file mode 100644 index 000000000..e9af3de65 --- /dev/null +++ b/docs/api/nerm/v1/delete-user-profiles.api.mdx @@ -0,0 +1,47 @@ +--- +id: delete-user-profiles +sidebar_label: Delete multiple user-profile contributor relationships +hide_title: true +hide_table_of_contents: true +api: eJytVdtuGzcQ/RWCz7o4viiNgD44jQooaNLAVvriCsXs7qzEZJfcDknbwkL/3hkyujhKXaStBEi75CHnnJnDYa9dhwTBODuv9FRX2GDAjx7pA7naNOj1gAd9SaYTEEPeJIhqYxNM16CKDB52Ga1KZwOZIgZHirBJG/u16WSbACuvp3daFqhut/1yoAn/jOjDa1dt9LRPr4aQ6QSKONCyJ9ogU9B1jSnTruNPXuj02pdrbEGewqZDJuiKT1gGDsgxWFwwHIVnJewf+7AHOBDBhtEmYOv/eRtTHWE8i7UrxtSOWmCKOkYGbHcf0eY7TkFee352Jn9P8zl77DgOVmoHVcEpUPfQGBlLqdHfkQVn8dea83wqJJjQyMCT8m4Hfw986wq9XWYhl9/i/hoqdZMpqqGKFoom0S9d24lLRv8v8blNWXkrS5/j/ZugUpgZkSO/F3H1LRFz5kcWGnWLdM/WTGtYDmGIZLkwzrK0Ndiq4Rd8LDGt9N8l7nlToYQ8ZXatWvQeVqjyeMFmU2GNKuMHGh9BEs3QW0e0Ud61GNaCemBW6oEcu3PvRZlzh1MuLCCs+X389GwMtE+Z8KkYkRqGrEPo/HQ87lku2PAeWtyOLJeM47sN4ohLPobO8OJ7ICNGyIdpD8/yauC+IaeubLF0J81lkeDKMl6B92Yl+RdDRR9YG4mYpfArI5mwSQQLBEK6jiLlbnk8fSvpzzyOQftqiChRm2D8nkE8kh9+3h3qhfuMlmnw748bFyk/asmpVPrm0L9mu4Kc9Ju73Dr0RQ0/XNWTy+HVyxcvh5dXk/NhcVGXw/Py1eSinkyghon4lRuSrZ1sJJXI2XkxOhudHfn8/ezmnbr+MD9NI3tkN6lKsKpIfTqlEsqSTaXYzqp1lak3SgrmopcGxOJ4Vhmrkk6094Y91LKZxO3sb+QGJaRsqqh+N1+kNHTOhxbs0cy/viaeKOkPJ+w/XDy52gEfw7hrwEjzyLbuv5yAu6+qxR5asyKZ6PsCPH6kZruVYa40ie2WB58n1/EChIrNI4X+jAzRP2Xmw4WEF3gT033zdZ+QTpZXXJfSW57FLo+O8ZvZL7PFTOz65ebkesoqggcelN+p/p2//OJyy0rXq4z3ugG7itxaGJN3ls9f3HvRpw== +sidebar_class_name: "delete api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 user-profile contributor relationships' (delete-user-profiles)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Delete multiple user-profile contributor relationships

+ + + + + +Delete multiple user-profile contributor relationships + +## Request + +

Body

required
    user_profiles object[]
  • Array [
  • ]
+ +Expected response to a valid request + +
Schema
    oneOf
    user_profiles object[]
  • Array [
    • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
  • ]
    • job_status object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/delete-user-role.api.mdx b/docs/api/nerm/v1/delete-user-role.api.mdx new file mode 100644 index 000000000..f7a182da8 --- /dev/null +++ b/docs/api/nerm/v1/delete-user-role.api.mdx @@ -0,0 +1,51 @@ +--- +id: delete-user-role +sidebar_label: Delete a user role assignment +hide_title: true +hide_table_of_contents: true +api: eJyVVdtuGzcQ/RWCTy2gm225SQXkwYVVQEWTBr70JRCK0e7IYrJLbkmubGGx/54zpGLLlZvAepC4nJmdc2bOjDrtGvYUjbOLUs90yRVHvg3sr1zFeoCLUHjTiAPMl8msSLXwUB4uikIwd7ZmG+Ed6S7o2Sf9aA56OdANeaoR58XWaYsHvMuUCDDy1obi5ijV4lK5tYobVm71mYuoolOeoze85YFqm5Iifp1XGTLiPf/bGs+gEX3LAx2KDdekZ52Ou0YyBkTbO3iuna8p4qZtEwp+oLqpxOXkdPpL+XZ1NqTi9NfhdHJyPnx7cj4dlkzT6dmU3pytSff9UrKFxtkAhkhwOpnIz3MGt481uqcAmEjvdiz5CmejFAwh1DSVKVIDxp+DxHXHwHMFkLfvB3r6Uq7fqFRX4I8kaqhaSyukRcUKJ8Qij16T1Vn+a51a9Tw/+mtiKtPCbqky5R8S2g/+3+9v8Upp5t479L9fZhLnL5FYAJ+3VKlr9lvULsWADtreesulchbUNmTLCg/8UHCKDK8i91+ojZcJiCY3kiXlMbILVXMIdMcq36+go6TN7H+ooGvn/U4FB8FvxOseqNS9dxBenz8DLTb3NG6CQkZgpscyOP+IZsadKXsYQipFHpzWV/DZxNiE2XjcgS/Z+AHT1I8segYA0BeP0PMxNQbBW/JGlJCoPblnfmtqK5kBKmou3NH83SR3JcO6n3HUXBTVhghyXtgsBV/RehN3CeCKybO/aIXLp+Wh+Vrqn3EcOj22Q0jp/cjKc3bCTT78/m1gb9wXtoCB73c71/p81FJUY9dO3ijlyhRORpPR5ECNH+ZX79XFx8UxV3Tym1EVZNWKZcMlvlQUaL2C6FTtSrPeKamqawNkGYAAVmWsSmDYbg06LctQNAkVMjaEgNrvvPeLm4S1cSHWZA8sP9qszwB3T3L/8UrOBY78EMdNRUYGNiup26sur+ukOvjPsBHRuA0QiqnrVhT41ld9L9fYMF56vXwSV+p8aYKcoek1VYG/g/enq/2a/lm9fsW/SGZ/SXaXJF+18oTjF97lvxksHRBiKqEoAZsNF4Xsj4OQo70hAn4c1cv5n/ObObr3FV9Weik= +sidebar_class_name: "delete api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 user role assignment' (delete-user-role)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Delete a user role assignment

+ + + + + +Delete a user role assignment + +## Request + +

Path Parameters

+ +User role was destroyed + +
Schema
    + +object + +
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/delete-user.api.mdx b/docs/api/nerm/v1/delete-user.api.mdx new file mode 100644 index 000000000..b18964ed4 --- /dev/null +++ b/docs/api/nerm/v1/delete-user.api.mdx @@ -0,0 +1,47 @@ +--- +id: delete-user +sidebar_label: Delete a user +hide_title: true +hide_table_of_contents: true +api: eJyVVdtuGkEM/ZXRPLUStySkTZH6QBUqUTVplUtfIh7Mrhcm2Z3ZzoUGrfbfa89AoCGNFB5gZ2yvz7GPTSNNjRa8Mnqay5HMsUSPtw6t7NDBZVbVbCTTeTQJECFZPSycHN1JPjo568gaLFTkYvm6kZoOFKZy8lX8ghr88uCt03NhCuGXKMz8HjMvvBEWvVW4wo4IdQ6efo0VCRnFW/wdlEVC623AjnTZEiuQo0b6dc0ZHUXrBXkWxlbg6SaEiAIfoapLdjk6Hn7Iz+YnXciOP3WHg6PT7tnR6bCbIwyHJ0P4eFKAbNsZZ3O10Q4dJzgeDPjnGQNdGAFzE3yisa0nJcyM9qg9x0BdlyqLhv6948DmEHkqAQXWll/jVUqrKMNh3rGo0DlYoKA0hbIVkT5AsKO8KW8qY07k+NORw5cofYFcXFGZ0XnRFUHDvERuTGb4ZR57b+FmNP4ooiKes/TKR2hTvYJS5d84tO383+8Xe8U0E2sNyaydJRKnL/eFpKihFNdoV2hFjCE6pK5gNebCaKK2BJ2XdMDHDGOkexO51xuHnPK1zqX7+bZzyX+/a9fG2rVwhuZqyV5/CJX4Yw3pu922kG1mN7yMgidtJPtxNPuNylu6dLEMaTaDLcm+9L52o36/Ia6g/SUNbNvT1C9KbtaIPep3H2pFwSuwilUQae3cE7cCQsljBlmFmTkY8ZvoLngfCHBOLbj4rKbgPBGzzGTG+LJglV9HgHMEi3YcmMfdbN98zbVPOPadnlrBpORmK/A5OdFNevi63Qk35gE1waDvz2sTbHqUXNDtvHG5EoWj3qA32FPi5eTqQox/Tg+5Uhe3RpGBFnPkfRn5QpZR2wUJTlQmV8VacFVNcCRJRwjIKpQWEQzqlaIuV9Ru1iMpEGkJMajNWr2Y3kSstXG+Ar1neb6n/wHY7KR9uNBTAT0++n5dguJhTEppNoraLvuOHNFCpaYsKTtfN80cHN7asm35mjaH5T7OdsKJXc2V42fSagGlw1ewvbvabPn34u3/EC8S2VyCXkc5l4FP9PiA6/QvRcuECCHkVAwGmwzjjPfCXsjBPmBxPo3g+eT75GZCnfkLIZOF9Q== +sidebar_class_name: "delete api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 user' (delete-user)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Delete a user

+ + + + + +Delete a user + +## Request + +

Path Parameters

+ +Info about the operation + +
Schema
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/get-advanced-search.api.mdx b/docs/api/nerm/v1/get-advanced-search.api.mdx new file mode 100644 index 000000000..c1ef06ff1 --- /dev/null +++ b/docs/api/nerm/v1/get-advanced-search.api.mdx @@ -0,0 +1,39 @@ +--- +id: get-advanced-search +sidebar_label: Get saved advanced search queries +hide_title: true +hide_table_of_contents: true +api: eJyVVNtu4jAQ/RXLzwjY7hvSPiBtt0LaXlTYpwpVE2cAt4mdtceoUZR/35kECoVVLzyExHNmfM7cGu0rDEDWu1muJ3qNNM234Azmc4RgNnqgc4wm2EowjLhCUhG2mCvYAVXskOpvwmAxsgfBOurJgz5B6OVAB4yVd5Fhk0ZfjMfy9/aCy5cKDbHTHqrIK1BbKKyc8S2R+A7jHaEj8YeqKqzpRIyeogRpdDQbLEHeqK6Qw/rsicOyYxVEMtmewp7i447iwQFCgJrxlrCMHwey+REmUrBuzZiVDyUwSZ0SA0Q+5LeuqPWEQsJ2oNP//UrrfqNbExP6fsGf8HL8eRalgAyL8zhtl6bcSmYeQyowPgKxKUuE8T2p4OrbFVfwXDRZKuTgLviVLXDB5nsOzFd9iJ0TUIqfRU/3RMVhvtfzNbefQF+/i+fgPZd7G597Dcu2bQ/nJ2PT7n5cO6SN382WdA1IFfXotPEGOmLYYohd2lPgcuoNURUno1HDnQ6ObqDEdui8w7IqfI04NL4cQWXZeQvBQlbsyvoK78drBamQJgRTovFnI73o4MoxXkGMdu14+njoTIrkSwwiZin8TAqW6o5gxqwxTJOIeVgem+cyeT2PY9BrRkWUqO1g/N2D+KR/+bWfmIV/Rsc0+Pmj9in0r1pSat3KS0RJVy/h23A8HB9V6eby/lpN72bnWjeo9kZlwKkMVYq9XjAGY1TgclX63K5qJVn1KcoqYgZsVdapjgy6rQ3elbyChnwJ7x/kVSWkXJd2fT1bdFwrH6kEd2T5zAZ9Q7o5LLvPrd8+0YQvNKoKsE4WQddRza79Hs72Hhdww0zF1DQZRPwTiraVY4krNV8emqwrOTvwGuLKSTs8Yy0zwAmsqOvGInWL5XQzS6O8DsTVpaToH+u8REQ= +sidebar_class_name: "get api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 saved advanced search queries' (get-advanced-search)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get saved advanced search queries

+ + + + + +Get saved advanced search queries + +## Request + +
+ +Expected response to a valid request + +
Schema
    advanced_search object[]
  • Array [
    • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
    condition_rules_attributes object[]
  • Array [
    • anyOf= 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>= 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>= 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>`, `<`, `start_with?`, `end_with?`, `include?`]"} schema={{"type":"string","required":true,"enum":["==","!=",">","<","start_with?","end_with?","include?"]}}>= 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>`, `<`, `after`, `before`]"} schema={{"type":"string","enum":[">","<","after","before"]}}>`]"} schema={{"type":"string","required":true,"enum":["Today",""]}}>= 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>= 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>`, `<`]"} schema={{"type":"string","enum":["==",">","<"]}}>
  • ]
  • ]
\ No newline at end of file diff --git a/docs/api/nerm/v1/get-attribute-option.api.mdx b/docs/api/nerm/v1/get-attribute-option.api.mdx new file mode 100644 index 000000000..4a798afdb --- /dev/null +++ b/docs/api/nerm/v1/get-attribute-option.api.mdx @@ -0,0 +1,47 @@ +--- +id: get-attribute-option +sidebar_label: Find option based attribute value by id +hide_title: true +hide_table_of_contents: true +api: eJydVdtuGzcQ/RWCTy2gm2W5TRfog4o6hYomLmy3L4YQjHZnJSa75IYXRYvF/ntnSMmWI9WN6wdrSc5wzpk5M+ykadCCV0YvCpnJNfq591atgsebhrflQBbocqvSKpMLXRpRGitAuAZzVapcmHgoVuCwEHC4QGyhCkgXeFg7mT3Ip5Pk4ORyIBuwUKNHyyad1LSgKKogP8XxGvCbUxC/ClMKv6GbVh8x98IbYZFuxy0ORGgK8PRLIAus6G7yt/g5KItE0tuAA+nyDdYgs076tuGIjrz1miyJWw2edkKIKHAHdVOxycV09kPxZnU5hHz603A2ubgavrm4mg0LhNnscgY/XpYg+37J0VxD/NBxgOlkwj/PGVzvKHme0nUwZQrAKVO89zmg8xQ8N9qj9uwPTVOpPNZq/NHxJd0pi5QOcmwsV9arBEHjh8fkfzB7DP/lROy/IT0WobjRVZsS2w9kOO9XK/0H6jUVM7uc0hJ2x8uTW54h/hYk5HNCbG/a05lXPtbwK3kPp3TKfwM5O1emX6AQt6kaYiiChlUVK5Ub1oTH0WtqZDTelFHlXyf+gG6howB+Z9d+8O92f7NVDHNtraHW6ZeJxNU5EgvCZzVU4g7tFq2IPkSHOiZYTRqk3g16A7qoaIG7HFN7vorcy1pCDnmKbC5qdA7WKNL+isoV2zrZHzffnbG2Fc7QrNiw1RdCJb5YE+u7LyGfmf0cYwg8OjI5PqN+N+5U0ZONiylJsyfYisw33jcuG4874g3av6eB1I801Y6AmBZxRLUfQ6PIeQtWsSIixSfzxLOEULE6Ia8xNycj7D6aC553ApxTay4EKys4TyQts1oyvjxY5dsIcIVg0c4D03pYHh/fcR0SjmOjx7IwKbmferxORrSTPt4eWunefEJNMOj/z60JNn3GDlI0+PlGTleicDGajCZHqnx/fftOzP9cnHKlih4ORQ70UqAILvGFPCcJCBKfqE2hylZwVk1wPBkJAZ0KpUUEg3qrqOI1lZ61SWpEmpxxwKVn493iPmJtjPM16KOTt4oCvPROiVUr4kB7Br17aoD/9fKl7Hvc+XFTgeKuTjLr9up8ODebHblmBIYKvCEmbNV1HOMvW/U9b9NEsqyJ5ZMIo0IK5fibeqCEyuELbL673b+I34vXv6Znee03QbexNTgDmaTPT9imF52GFBGiSU/KY7DpYJ7zvDlyOZkzLPTH1v7tmkv8D4nXBUk= +sidebar_class_name: "get api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Find option based attribute value by id' (get-attribute-option)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Find option based attribute value by id

+ + + + + +Info for a specific option based attribute value + +## Request + +

Path Parameters

+ +Expected response to a valid request + +
Schema
    ne_attribute_option object
    = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/get-attribute-options.api.mdx b/docs/api/nerm/v1/get-attribute-options.api.mdx new file mode 100644 index 000000000..75a1acb14 --- /dev/null +++ b/docs/api/nerm/v1/get-attribute-options.api.mdx @@ -0,0 +1,47 @@ +--- +id: get-attribute-options +sidebar_label: Get option based attribute values +hide_title: true +hide_table_of_contents: true +api: eJydVm1v4zYM/iuCPuxTXpy+3N0CFEOGdYcM63Vou30pgoKx6UR3tuST5DRB4P8+Uk4cN82l6eVDEkkk9ZB8SGotTYEWvDJ6nMihnKEfeW/VtPR4W/C2kx2ZoIutCkuS+YxemLAQU3CYCNhqiAVkJbKGh5mTw0e5OzIba5OOLMBCjh4ti6ylpgWZ/V6iXZGq0q3Fy5tHWWaenUiNFQXMlA64BehEOGO90rMeqVj8XiqL5E0KmcOOdPEcc5DDtfSrgm8y068YexItLHvvFUGm00zlyrfElPY4Q0tyuIS8yGhvEEVVR5o0dfiG5GUQtAnt7uQcBUPP2mIytggekyfwsqpaBw0cunJ342XUGN3XdH4VDCaIxe3WQVwWmUlo29sSq04Ta41PTWaeVHI86uM/hEkpyq08cwZSlVEKa3/ejnnjOqnmBHkoyzJcvAvF+XkafTxLku7gfHrRvRjgoPsJIeoOPqRncPnr9PJj/IldbbwgDkECHo7Dv0NfWu2Iqz6eEwaxVRNKCz9HYdEVxEw8yY+pMRmCDrekUGa+EW0cCbGuJmytNhzYdRZF/PMS2/WyoERRCW1FhTcCuIwU75FDjtMYGyKYDoyDoshUHIjf/+rYyPpkgr/I+rYed1pgLYQC9Ji7t61R9k5IL5E0udXZaktBWR7Wy5X+G/XMz+Xw/IyWsGwvX1nZJ/CbSLgaN1HfF+Xq8coHDu41v+5ZOH1qmPbTTeRY2+D7jYfs8JHGpT/eQ/qok8KQym/h9qtB9Et919WHiC0UFhfKlO5nrVxEL2J0sw1GFT4deXGI2r9DIu5qBouuKDVMs8Du2PB9Hnvv4bXReJuGYbEf/S2osQ5F8xercov4kdx/LBWuubbW0ASqJrUTl4ecGBM+qyET92gXaEXQIXds6ClUtzR+Sj2nCZTRApcx1lX1LueOEwr5ytfIRtTGnIMZinp/yp2Nu1kt307svbF2RROSSBz63zOhEs/WBOpvUshnZvMAYAjAlSf7BzsGdcUQjXp6l5Z4K+feF27Y76/JZdD+CzXoqqcpbYTBrBB7lPY+FIqUF2AVk6GmYyNeu7hpqRLiHGPzqpc/BHHB/V+Ac2rGOWBSlc6Tf5YdmjC+uLTKrwLAKYJFOyrZo8dJ+/ieU1DjaAs1GWGn5GYGhN4fhGin/vPntsE8mG9Io4S/r1amtPXfUDNKp4YtcrhqFwa9qBe1CPnl+u5GjP4Zv/aVkrk9FDGN3ymK0tX+QhxT9sPLJzeJSleCo0olzoOEENApT7cABvVCUbJzyjrTkoiIPOyGzRi9GT8ErIVxPgfdOjnlpfcC9HrH+tOeiXWgPbW4fpGB4tqtGbXecPDx8NSiLM4JLp+v12z+X5tVFW/XjwBOfKIc82w3zH8I9YQXzkGk33B18DEV/KOT0IlOh/Gel8oRPK1n0Q7IZFd4oQwofjRT+SFJkar1RjG3r5bWq7bFVppO8fmaafM/bgk/PA== +sidebar_class_name: "get api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 option based attribute values' (get-attribute-options)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get option based attribute values

+ + + + + +Get option based attribute values + +## Request + +

Query Parameters

+ +Expected response to a valid request + +
Schema
    ne_attribute_options object[]
  • Array [
    • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
  • ]
    • _metadata object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/get-attribute.api.mdx b/docs/api/nerm/v1/get-attribute.api.mdx new file mode 100644 index 000000000..466a258a4 --- /dev/null +++ b/docs/api/nerm/v1/get-attribute.api.mdx @@ -0,0 +1,47 @@ +--- +id: get-attribute +sidebar_label: Find attribute data by id +hide_title: true +hide_table_of_contents: true +api: eJytVttu4zYQ/RVCTy1gx7k47dZAH1I0W7joXpCkfQkMgaLGNjcSqSWpJIKhf+8ZynaU2Mkm3eYhFjn3OTPDWSW2IieDtmaaJ5NkQeEsBKezOlAySHLyyumKySBOzdyKuXVCCl+R0nOthOxxB7nwyeQ62d75ZDZIKulkSYEc01aJwQG6dA4BzVorGZa7pn4Xdi7CkoTNvpAKIljhCGrplgairnIZ8AtXciooGnf0tdaOEERwNQ0Sr5ZUymSySkJTsUUPabMAJyIoZcBNXUcv6F6WVcEsR8fjn/J32clQquNfhuPDo9Phu6PT8TAnOR6fjOXPJ3OZtO2MrfnKGo8IYeD48JB/Hkdwfo8UBcrFhpVDkOJWFprvvtbkA4wrawKZwPKyqgqtIhajL56VrHaj6NIBwcoxckF3LhhKH5D4JjfCfkVeHMn8kymaLqPtIKn3y5Xa/EVmARQnJ8c4yvv+cUdLITMqdvW0T0pgDz1YW6RBV3uJyjVV6FEyMJM0TJJOLfUt5S9T031We1nhkhsGXdK+1CjcAOxUhv+uo6vq79PBxHTDuquETF1yh5blKM9HDf4Yv3KY58P1Adcgbg9DENcH/hlFwfVhGAWTGcx6dKEKMiso9UGG2u+FyGl/k3plHbgoBL59lq273UO1dwajZKmrNHeAzT0DalHYu7SsC5QLOxX9Q135/exzXWBAIfdZkz7TSjvc8OcRb/qaroL0I5lO1WtFHaaf85D33iodJ8Xb7WMUwCrFDL9WpqCFVM1jbo3BtUD+uTHLKv0/OoD1fH8XsCId4kB/eMva+DdIxvtm9W8yFxfdSBZDURsuZB7XyvLDEOjgLYPaGvo0j0/d0yG88Wpq4ivwJ4u2g+f5/mGuaObcOYv3s511QZzuC2IK/5yRhbgkhzIRUQbh4NmsncFDZA1CW0qTFzjQvaIo6d8U3MvvCrHJXc/OREneywWJ7j4DlvFt7/j7L/Clda4R3mJhWDLXHbwSd85y728gZJpdLyvsAu8Pk2TU7ys/Wum8TXgwcS66zaN2eHaSZQiVn4xGKwQsTfiIdaQ9MAANHtiG6ACgj2SlIXwrneZS6IbGlr0LcC4xXKBPqpKU3VlgriK74G1HoF31ghHgkqp9QHSOw5mxf6p2OjTRwYykI3dWczzXsz75kgHo/OgzbfHgoJL1zhOHVWTCTffxftM1V/aGDNzA/18bW7vuM+Gsaix3rJHT1YVwdHB4cNgrx4/nFx/E2efpbqyAckMUShqRkah9F69UCtgLVJ0oba7njeCs2trzXgQPQBXaiOgMmVsNqEtgzkWJMiTsTXG96ZbGD9Or6GtlfSil6VHeaxjYwi/QNVJkjYh7zJO1Ylvr395nu+QGug+jqpA6Dv9YRat11V0/muYeMhOYBHBLeMjk1SqTnv52RdvyNUaMY6xnD8UVkc+1528U9VwWnl7w+YeL9Z77o3j7jrw3oPWlNE0s+aLmEz5vqOn29JZf+CVmLD+2cLYjnCkeID2RncHBBbzt1T/OGbp/AdDLUJY= +sidebar_class_name: "get api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Find attribute data by id' (get-attribute)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Find attribute data by id

+ + + + + +Info for a specific attribute + +## Request + +

Path Parameters

+ +Expected response to a valid request + +
Schema
    ne_attribute object
    = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/get-attributes.api.mdx b/docs/api/nerm/v1/get-attributes.api.mdx new file mode 100644 index 000000000..02303d186 --- /dev/null +++ b/docs/api/nerm/v1/get-attributes.api.mdx @@ -0,0 +1,47 @@ +--- +id: get-attributes +sidebar_label: Get attribute data in bulk +hide_title: true +hide_table_of_contents: true +api: eJzFF8tuGzfwVwgeepIsJU16EGAUKuAGLpK4cNxeDGHBXY4kxlxyQ3JtLQT9e2a4D63stSI7BaqDJHLeT85suS3AiaCsuZR8xlcQ5iE4lZYBPB9xCT5zqiA4Qm/WyjMwsrDKBJYJwxwgMtwDEy0VkyIIpgxLS33Hls7m7KNaQlZlGph1rLJlpPQgXLZmS7zqaD0rvTIrVggncgjgSIUgVp7Pbvkeiy9GvIcyu91ygwdU8FsJrkIaZXqHQxvmWtsHH+UWYqVMtJ0JI5m3LqD0MyRx8K1UDtAjS6E9jLjP1pALPtvyUBUkyaZfIQuIWjjyYFCoFkK1ylXooaGfYAUO8WAj8kLj3ZvpdDfidrn08APM9xHRSbzd43n0gln10XjmQASQiQh8t+sBOnVQ5F7i+2nH9DGlD1VkKAGKq9ZA2BTaSrwOroTdqPO1Fino476+WfcTIxKwYNlSaQwcS6uTPN0YvOuJphRLIvgF4mNeEtGrVUBfmDKnXAywCcgDtKQEpYNAT5ICmA1jaR8M8RVSWSyDEKyhREau2R1L7aauLHR8m90jSm6RrXMwTUqhfoAlorscay6oZvACBaD2Hbw9NtDMmtpo28M5vIyYi75PsZgEuei4S68hlM54loqQralUWzKq+ID+duALNBdO8mtqrQZhopSlKHXoULscjkm3WxC3mnEss7fTKf0c6naxKdBUkJ0OFGjB7oVWdIcG+dYR5GekF0WhVRY7wOSrJybbkyvdQNLrSHt04ZyILShA7n/MRsmhPMPulGNNznhZKhldKeSV0VVbhLwcpsuV+QhmFdZ89utbPIpN//iES13CT0vtUdQH4AEjlwRVDAIzVxVhIMwIorxT9yCPQ5MhqT2vUO2Mg8phyDW9nvZqHmUhf5oHAZMW9flWkucTKScVfih++VjKcXPAawR2hzECmwP9TCJhcxhHQixoLLJY8CLVkPggQukHQ+SUv0t8Zh1iQaBn73m0+nYAGtuOX6sikQ7D5p4JKj24SY7VrQpSKuqnqCUOotedGX2fVkm/xo5hoz4HuMkpVYXUBzQ1q1NJHQ49ziO99zZTsYW8XH7T16OHT6XRsBJZdYjdzg5UmHmR/BcVQHx+vgqIkQpxpujGyjhpJN1z8+qR6tgQFTtUEHoYZPDBPj5RTdoh9/co/fzN9Jda1vlv0zpwcK/sUG2dxuXdlPd986l1xi5+Rvzd0Pv2h5Dsun7G2JiVhmqcnrjMkrwAZy953KyBq2UcnR97v1Xq0sSX8y8ipTnhObx/CSuKuXDO4jy+W9RGvB8y4hL1c0Zo9gUcVhCLNGiOi4MFPt44jJdmjfO4xgNsMoiU/kXGHU8oIJFPNZvjLOO9WOGkGO9TGm9opKnx+4H9Yp2rcF/AJI5D0ANqxR6cjWNqE0KC2WalIhUEvcJ8cjg2ULsmN9RLTOkwYfk6hMLPJpMt2ipM+Izj2e7MYLxQuK0AzjDeE1EoJL4XTlEW1HnYode2NQMVF1kOmX06HEd0RtMfwyamVuR8yqbSBzTMkSUL0i8rnQpVVDDFuRHcvCRTbhd98Bfyfa1HH6kLBRnFmwkwtvCIhDf1nz/bXnJj7wAHSfo+x03R1X9jsSiztMSR3FWb8OZsejbtZeLni+tPbP735eAi0ALj8pkCbpq1vSLLMOxxAcytVMuKkVextmmMRA0QSrNtVAbMvcIo05hO+YgZCDTqzroh+tPlTdS1sD7kwvQgHyA8syM/1na7z/P/aeGuQ0ZrzaTQQsWHNubmtknj20fTLybCGi0mwHabCg//OL3b0XW9RVDuSOUpVffbwBGjf7g1Dqp4B1VvLcXmVRJO7F2vFf7sznhEgf5y+kolXrJlHdGkt9LtFVns20YsYgwdvtk0vGGQarp5Rl23R/Wk2xKXrsF9uKCk/w4mZ2Cc +sidebar_class_name: "get api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 attribute data in bulk' (get-attributes)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get attribute data in bulk

+ + + + + +This endpoint can retrieve attribute data in bulk from Lifecycle or you can search for attributes using parameters + +## Request + +

Query Parameters

+ +Expected response to a valid request + +
Schema
    ne_attributes object[]
  • Array [
    • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
  • ]
    • _metadata object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/get-identity-proofing-results.api.mdx b/docs/api/nerm/v1/get-identity-proofing-results.api.mdx new file mode 100644 index 000000000..27c5de06c --- /dev/null +++ b/docs/api/nerm/v1/get-identity-proofing-results.api.mdx @@ -0,0 +1,39 @@ +--- +id: get-identity-proofing-results +sidebar_label: Get identity proofing result data in bulk +hide_title: true +hide_table_of_contents: true +api: eJy1V99v2zYQ/lcIPuzJjuXOWVsDwRBgWWFgaYM0wx4Cw6Ckk81GIlmSciMY/t97R1mynDqOmm15SGzyfnx3vPvusuHagBVeajVL+ZQvwc9SUF766sZqnUm1vAVX5t7xAU/BJVYaEkbRu5V0DFRqtFSeJUIxC95KWAOTOxPM7GzgFRlhqfCCScXiMn9gmdUF+0tmkFRJDmjfi6Xj03v+nLrj8wE3wooCPFgS3XCFXxDM1xJshSak6nw5xHuZ5/qbY5m2zIilVCFoJlTKnLYevZyhioWvpbSAqchE7mDAXbKCQvDphvvKkCcdf4HEoyiCw9R5CY5uc1lI3xHDnMASLMrBoygMxjcdR9F2wHWWOXhB8jwI2hRP93IOk6uWXTGeWBAe0oXwfLvtXLRw0OXe43nUGn2q6XwVDKYA5lMTIDyaXKd47G0J20Gbaww8kzksZHo64Te1HJv9wbxm+BEfjcVVryy3weJzFQhyyssy+NsHP4HJu2gyGQ8n5+N0OHmbvh++e5u8Gb4XURZlMP71HGIKrsX9TduHDGtg4cA5hPhiAP/sFNjnWuG/jKQLrK7u01jQddOQrO7IfwEFVFlQoxnhqK8zIXM+7yLCBhPUq6cx3YIvrXIsFj5ZEbBGjVrcr4Da1mjloBe6WOschApeMkEJaUTbNw+FuJ2TtdpwaL03UUR/DrFdPRqsYkhbDJQuwdYil3SGATnKeKKx+1RoR2FMLpPACqMvjoxsend/w1iLhrEWDWPtVYW1IlCUh8L1MdmnHbCN008qr5omPYJEJH5X7C8X5eBok/TR65BCT/EaXeOvl9auUU5VNA6k+uSwtjsehUeluPRw9BFEmkrKl8hvDp7j0OEh2TawqISsXkOg1A7DngoN2wWGXmLXoU5p0p/UQSV87cCHx+d2EFm0/fzqOXZqchEI7UV+/ErB4/Ena5l81GwRvwfvF+Pol9rXxW9RXSywlro88g79rEyig0RdN8nY1j8DoruV3q0/oXT8igw+39VIX2DXzQ5SWgydr7w3bjoabZBQhPIfkUm3Z0orQHy6AjhLdDESRqLyWlgp4nxXWa14zWI77uMiKSDRP65dQZwRUTMscblUSHLIbUnpvC4o5YEhHSSlRewBYAzCgr0sKaz7eff6MxFcjaMr1OaZguI7sg4kHYTwpP7wZ1OSd/oBkPPp90WlS1t/DGmXKtNkkdJVhzA+i84ivn+Qj1e31+zyZnZkxQTWXIYNMwZWujpekSTIUGF/K3Qqs4pRVrFKiPERAd7SGApgQK2l1arA56QlD2keaCpN23l3PbsLWI12vhCqc/MBfL919in4zX62/B+rcv08HntrZHKBQ5row4YWrMv3/sRQwgJYYaQktNnEwsHfNt9u6bge9FQzqXRUovuB/Wx0z+95R1E+QPV0icSpXJIgpxWkv+Me+9kJBMfXwVdCeXk9O4Gk3f9e6fxn9rATMDpL3x7IfM9WgTuwcnDloP8hsEZqvUvsRNOF/8MmRVZajv1wRb32HVvPBxg= +sidebar_class_name: "get api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 proofing result data in bulk' (get-identity-proofing-results)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get identity proofing result data in bulk

+ + + + + +This endpoint can retrieve identity proofing result data in bulk from Lifecycle + +## Request + +

Query Parameters

+ +Expected response to a valid request + +
Schema
    identity_proofing_results object[]
  • Array [
    • proofing_attributes object
  • ]
    • _metadata object
\ No newline at end of file diff --git a/docs/api/nerm/v1/get-job-status.api.mdx b/docs/api/nerm/v1/get-job-status.api.mdx new file mode 100644 index 000000000..b1bd1f965 --- /dev/null +++ b/docs/api/nerm/v1/get-job-status.api.mdx @@ -0,0 +1,47 @@ +--- +id: get-job-status +sidebar_label: Get the status of a bulk job +hide_title: true +hide_table_of_contents: true +api: eJy1VcFuIzcM/RVBpxZw7bRoLwZ6cIt06wV2N4jdXhZGwJmhbSUz0izFycYYzL+XlGzHW7vZ7KE5OCPxUXokn8jehhYJ2AU/r+zUbpDfhmLBwF20I1thLMm1ahbjG2TDWzQxmU1YGzBFVz+Y+1AImGET7fSjldUeYlcj2wJBg4yktt56WchRgrlzlTg5PfhTh7Q7u24pV7lKr9FL9VRC7shjZdYUGrn85sNiaQKZm9ny9z8N+qoNzitHYMHGrmbBOi9I9S7Q+Y0pCUG25TbCT50j+ZwydTiysdxiA3baW961SjIyiYcdhpWCYxt8xKj2n66u9N+XdK+fWiz1wgPUcJCbH6F2uicxRpZby+AZPas/tG3typT8yX3UQ/pzEqG4l2PFsSUtFbtMoZPsnTEd2XWgBuRw2ylgkKByIS5A8QmattatMugHo+K1MBn5kodr2kB8wFfAp4yBCLSajrGJr4gkIt29MpoGPGxeD0eiQPEV1C6E+LfWLdXGpGOMnC5lLAMlSankh+PfyP58SRK/QWVuc+XND6bzUNRJFYeEj79FD8Hjh3V6Q//OJztOlOc+ie2tug6j/8Y9h3adEzSschC/XApiLvzIQ20WSI9IJvlIOMfHKBnq/BZ8VcsCn0pMnvGbgntZIqkA58xmpsEYRRAm7xf6vrVXZPxpNReBaGdikE60VdRnYWU+U0jPe19CtYV9E1QKwFtZTFTh8dAQY8pBbmUd1WLfMrdxOpn0Eih4fi/9bRh7KZbcHHaIYyn2BFonzo9ATiWQlXeE58DWIO1KJVo2IrLzZpjgRtungRjdRjOvUuoiS1SkYayUX9mR410iWCAQ0qzTOD6uTs0LTXzmcQo61kGDsvuOqOsMkp388cfhoS3DA3qhIb+/7kJH+dNqNp1fBz1R05VD+HF8Nb46keH769t3ZnYzv9j4D0ZTgpfObaRLpHihLKXmRtRmmlC59c5oVoOMI2m7wkCs+jwTGfSPTkrcSK1VjCI/lLaspPZT6N18mbi2IbK0lhPLV0bdF3z7Z5l/dUTm9DI+8aStwek7zTrq93pL4/PueXxuhZru9n0BEf+iehh0O09MLXLlompKdLuGOuIL3L673Q+8783/PVovxvmAu9PJL72qU5BVYR6eRhKqRI1Qid40vuw1K7WtnHidtRM95fiC31xrYf8BWyoRJA== +sidebar_class_name: "get api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 status of a bulk job' (get-job-status)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get the status of a bulk job

+ + + + + +Get the status of a bulk job + +## Request + +

Query Parameters

+ +Expected response to a valid request + +
Schema
    job_data object[]
  • Array [
  • ]
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/get-profile-avatar.api.mdx b/docs/api/nerm/v1/get-profile-avatar.api.mdx new file mode 100644 index 000000000..618d20f28 --- /dev/null +++ b/docs/api/nerm/v1/get-profile-avatar.api.mdx @@ -0,0 +1,47 @@ +--- +id: get-profile-avatar +sidebar_label: Retrieves the URL of the profile avatar +hide_title: true +hide_table_of_contents: true +api: eJyVVU1vEzEQ/SuWTyDlq20KJRKHIAoKorRKCxeUw2R3NjHs2os/0q5W+9+ZsZM2kFLRHhqvZ8Z+b+bNuJWmRgteGT3L5USu0F9ZU6gSpxvwYGVP5ugyq2p2IYc5eqtwg074NYqv88/CFHFZpzABuzgPKycn3+XW4OSiJ2uwUKFHy5ZWavqgM1VO7opPr8GvD66cvd/dYZY/MPPCG2G3MHoi1Dl4+jVW5FjS2RRv8VdQFomQtwF70mVrrEBOWumbmm90FK1X5FkYW4GnnRAiCryDqi7Z5eh4/Co/W570ITt+0x+Pjk77Z0en436OMB6fjOH1SQGy6xZ8m6uNdsSQLjgejfjnTwbndzXhxlzsXJkCiA2Uivd+BXSeLs+M9qg9x0NdlyqLdRn+cHxIe8gipYMCKcVURa8ShGDLp6mSnVFDfqnLJuWo66hgykfmX8nedbwzfozMO8jFPGEWfRE0LMvIJzOcOY+D5zAxGi+LqIW/Oe3QzHRM0ycO7Xr/9vvGXvGac2sNCaxbJBKnj5GYET6roRTXaDdoRYwhOqSrYDVVymiitgadl/SBdxnGSPcsck+XCfnKQ2RTUaFzsEKR9pdUvSj+5L8v0WtjbSOcoY5as9ctoRK31lC5u/TXk2wz285mCNxgEzncNeWwVXk3vO9ZF7ORmjPKSK69r91kOGyJMmj/hTq2G2gqG2EwDeKAyj6EWlHwBqxiMUR2D+6JYgGhZPFBVmFmDnr8JroLHggCnFMrrgGLKjhP/CwTWjC+LFjlmwhwiWDRTgMz+r7YN19zCRKOfaf7ijApuR0L/J2caCctPuw65cb8RE0w6P/bxgSblpLzqnRh+EROV6JwNBgNRnuC/HI+vxDTq9khVyrmzigy0GKJIrjEF7KMqi9Id6IyuSoawVk1wfHoIARkFUqLCAb1RlGxK6o6y5KEiDRaGNR2rl7MbiLW2jhfgd6z/P8U/wN6+6D95zwEKeke7/ywLkFxH++GVNLj3iPRk5M4iLfRVNQ1oWeXtl2CQxpOXcfbNIAs62DxILyoilw5XpPkCygdPsHgxXz7TLwUz39iHiW13QTdxHYoA3/R8ic26ZmjmUSEaPKS2hhsMkwzHi97IQdjhcV938kfz7msvwE19ahq +sidebar_class_name: "get api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 URL of the profile avatar' (get-profile-avatar)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Retrieves the URL of the profile avatar

+ + + + + +Retrieves the URL of the profile avatar + +## Request + +

Path Parameters

+ +Expected response to a valid request + +
Schema
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/get-profile-type-attributes.api.mdx b/docs/api/nerm/v1/get-profile-type-attributes.api.mdx new file mode 100644 index 000000000..d2d2f2a2a --- /dev/null +++ b/docs/api/nerm/v1/get-profile-type-attributes.api.mdx @@ -0,0 +1,47 @@ +--- +id: get-profile-type-attributes +sidebar_label: profile_types/ne_attributes synced status +hide_title: true +hide_table_of_contents: true +api: eJy1V21v2zYQ/iuEvmwDkjgvztYZ2IcMSzsPaxok2b4EhkFJZ5utRKp8cSwY+u+7I21Zshy7btd+SC3yyHvu7rkXLiNVgOZWKDlMo0E0BXuv1URk8FQWcGOtFrGzYKKTKAWTaFGQKAq+A8skMF5LMC5TZkqZQLpZZRoyf7mZiYJZxYpwObN4+xleavnURIPnaPugiUYnUcE1z8GCJpFlJPEDNa+uGNMVY5HiJYIAFdzOOijvG+rY8A+mJszOgKn4IyQWpTV8dkIDWm61g5PIJDPIeTRYRnQCLzCIR05RcqJ0zi2uOOd1woLnRUYiF5f9n9M38dUpTy5/Pe2fX1yfvrm47p+mwPv9qz7/5WrCo6o6qQ3giRVzGCMwNG0N/7MDXXbwv/UyDJW3PNfxs2nZMuGZ2WsMSJdvvI4LTtY/eZaR7zf20UITvgGuk9kX4Y5LVus8Bl6te6Wrqb7gU9iv/J5PhfSsYyTM0NjYO/owBCEtTL1sHW9currEhVxIkZPbLhoAr78ambCQG4a5x1bHvjM4o7TdD+5P9YLpmiidGmZmymUpi5FpeM7z4jC+OqtqBMuIGErakV24gXcDfXKTRNUJZTI6wAqkby26lw10S1Vf8zqv6f5g3haVSS/+G5E5psCyFFRfnp/Tf21/3C4KNAezbC1K9YuzOc8EraETDRmbKAyLtN6CoshE4uPb+2jokuUeL7Wtp5AelkqUC6oOU6Ib3JzLslWz63DDQphW4K4r8pDfbGjjWnPijefuYbBYJztODTW4CYKawIFaq4GnH2RWrqv0sbUX69suLHcNFD8YFnRtY8HM+hvkFHvL4OoSP/mi+fntyDIeQ3YQW5DqotvuX6/jWcUINa4qfUdlWB9v2IGxEr5famDCMCUbsaojs1UUjm+LkRXWH9g1d1C27pcwPqFJqr8riX/nKXsIucpOmZM8znweJ4pgWj+DfHEGowc+TPwosk38NcKh9OXhLzpKxfc1uX9Jyqu51VrhfFONghHXu4wYIj4tecYeQc+xY/gzaI4G67TECoX9xMkZDmAZfsAiAX/SHGXc/lwGUtlFdsNyMIaabFiPkZZ+wgryTT48Kq1xHFA40M1I6gVRsRetkMfVOoS0p1ZjKEGgkW4Q9ZoTn+kttwbAqidh3JqEjHdTGBqdxuyKZtYWZtDrLdEXXNo77InVmcR4IjhVApwhH3q8EHh4zrUgloQCV4sH2yfcZdaPcDlWx06VffLijFou48aIKQWH2OaMRcN1FHqPgcRpYUsPMMYRB/SNI1OfR83tR4pNwNEUqkNFRkWrPkzfQQhXwo+36yr6pD6BRBj497dSOR1++twTcqLoRnJXMOHi7PzsvMHUu9uH9+zmfti1FaO83mQJlzQsOBPs5UmCtPAvglylYlIy8qpyhnopIsBdJiTzYEDOBbIgRzoQX5GhgL2WQK0ml/fDJ4+1UMZiC2vstHnRYsF6QjaWW9d5vSw3afG/PWRCTCwsbK/IuJC+7Whf2gOPn9t48cyg+5RpUxnJMEOr6exyGXMD/+isqmg5jHDEn1QYouumBL9q6TGPiZ3mfIJyx/MFK54jWV/wjkbTfCLsUVo/Or5S26tvgj06V4P5t2vszPrfTemBGX6fg8P7YKN3tCmFR/Lsx4fVVPATO/T+3gloPW3KsgmodtBWzmDnxCzBuYeeBIgzSN0k1AQb5zvNjwys+827W6ox/wExiNqk +sidebar_class_name: "get api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'profile_types/ne_attributes synced status' (get-profile-type-attributes)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

profile_types/ne_attributes synced status

+ + + + + +Get ne attributes and synced attribute relationship to profile type. + +## Request + +

Path Parameters

Query Parameters

+ +Expected response to a valid request + +
Schema
    form object
    records object[]
  • Array [
    • = 32 characters` and `<= 32 characters`"} schema={{"description":"Ne attribute's uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"1246d8b3-ac29-4015-8154-dea4434a73fa"}}>
  • ]
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/get-profile-type.api.mdx b/docs/api/nerm/v1/get-profile-type.api.mdx new file mode 100644 index 000000000..45636f5b8 --- /dev/null +++ b/docs/api/nerm/v1/get-profile-type.api.mdx @@ -0,0 +1,47 @@ +--- +id: get-profile-type +sidebar_label: Find profile type by id +hide_title: true +hide_table_of_contents: true +api: eJzNWG1v2zYQ/iuEPm1AFL+mSQ3sQ4amg4f1BXlZPwSGQUlnm61EqiTlRDX033dHSrYcO6mzBuuCILHEO95zd88dj14FKgfNrVBynASjYA72o1YzkcJ1mUNwFCRgYi1yEsDlt0ImLPcCzKIEi0omEpSzfG6C0W3QXjTB5CjIueYZWNC0vAokPuBGTkfQljm3ix074zdMzZhdAFPRZ4gts4ppsFrAEo5YkSfc4n+lWQIp7o36Gr4WQgP6YHUBR4GJF5DxYLQKCAluaVBbzlFypnTGLb4pCocC7nmWpyTS6w9fJWfRIORx/3U47PZOwrPeyTBMgA+HgyE/Hcx4UFUTsmZyJQ16iAb63S792/bg4j5H3JCwRpRc4GzJU0HvvhZgLBqPlbQgLenzPE9F7FLR+Wxok9WuFz4cqIhxxsRZ4SHUUZ96qe9Jo9sHxEUDTz7ItGwiuu3f9To3ho3fHG/FcTCYdU/7SRL2BtEwHPagF54B74a9V7M+P3kdnZzGZ0F1FBT7gWRC/gVyjrQYDfr4yO/bj4fDunmIK7c3aBENexLuWn64lzAMf4mGpNFQsk3xbQOflP4CmixgHmGudLnPCsgio1IB1FIlEHulkmHrUek5l+Kb4wI+cmPEXGbEE1xDCJoK63GwjfEdtGzG0xTFpFXbwNe2EXpU5mhwmhT5FHUthlJ4MtZ+REqlwOVOuD4tgKBRVUplGeo3dGabfQiiNwDJFgREZgCtcx0vxBKS5xvccRZNNbvtNYUVkQmLNTrVaGAqEtMyyrXmJfUoC5n5frlU+4hI22J3pKRwi1gQX2OSoTq+RoiPsun2sDqaoGlh4qkpZXxQ2MZm1zDz2uxO2AUTsdkbrlaPcezgFmMRFRYOidsPtaLd0G4OiM1+mzAXpo7wfhL+h91qFzlu82LQ1xkIaw5u5ehFYvtIpzs0aBI2NHkBQBLYert/Awh/HgQJGzvC+NkM3hSix/NTGXrzDGi1QEgCoTtWX56FeFioWHDqmv87Qraw/Sg36dhP8GjfIMJzGub4xqVQZDQ1dPcOPKTnW0g9qxClN+1EbLeNbuXrwArr4LUG/rDvaoRWh/um2t95wi798MpCVkgepW6wjRVt7f0+eKRVEj7M3KXgYYU1yMbSzct/kmp19Ljc3yTlzFxorfCmUU28Eyf7nBgjPi15yq5ALzFwTgfdwQtGoSXGCztuIRdcJik+wH0MTtM8y7mnmwaQyV1k5ywDY/gcmH8fYR5dSr18m1NXSuOAZxRerRYkdYeo2J1WyOCqSSGtqfpWRxDopjUKOu3yNJ2VSCpcNC4W/o5W6BTlFtbmZtTprNBhLu17LO7qGAfVZlY8xqR3eC5Qecm1ICr4drkW9w7OeJFSNfE4g1jt1pMT9wO2H3Qx6ESpwlj0TpM7E8IXF1rY0gGMALmtzwvy53bSXr6iBHgcbaF1PsipoL4duiHJCeEb/+FtU/rX6gtIhIF/fytVof3HgKIq5EzRjhQu70LvuHvcbdHx/cXlO3b+cby3dzSLOKVLFtUVSnfDOMbcM2Qdy1QiZiWjqKrC0A0SEeAqFjJzYEAuBaaabgRESqQh4A2TQNXX63fja4c1V8ZmXLZWHr/Bb0FdbZj+1KXfB9XCve3kKRfSnULEnlXNttutw4DmyhFqYsIWiIyWV6uIG7jRaVXRa2wtdGm6nWxI5TKeCEOfk3ocfQLtL5f1NwG/sud/i7DXoWYukKWjelrQE378AqX/JqOiGXyB91Lq3gjWL5zH1DhaKjsNg4i7rtE/Lihl/wA74/Tr +sidebar_class_name: "get api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Find profile type by id' (get-profile-type)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Find profile type by id

+ + + + + +Find profile type by id + +## Request + +

Path Parameters

+ +Expected response to a valid request + +
Schema
    profile_type object
    = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true,"description":"The objects UID.","example":"ptUid"}}>
    profile_type_dup_attributes object[]
  • Array [
    • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"description":"The uid of the properties that are used for duplication protection.","example":"attribute-uid"}}>
  • ]
    • profile_type_namings object[]
  • Array [
    • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"description":"The UID of the profile type naming.","example":"profile-type-name"}}>
  • ]
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/get-profile-types.api.mdx b/docs/api/nerm/v1/get-profile-types.api.mdx new file mode 100644 index 000000000..26ddd8f76 --- /dev/null +++ b/docs/api/nerm/v1/get-profile-types.api.mdx @@ -0,0 +1,47 @@ +--- +id: get-profile-types +sidebar_label: Get profile types +hide_title: true +hide_table_of_contents: true +api: eJzNWG1v2zYQ/iuEPuyTHct5aTsDwZChaeFhbYq8rB8Cw6Cls81GIlWSSuIZ+u+7I2VLtmXHSbN1QNFY4r08vHvuxOM8UBloboWS/TjoBROwX7QaiwSuZxmYoBXEYCItMpLA9Y9gmXIPbMQNxIxbq8Uot8DueZI7DcsnJujdBpk3xKyzNGgFGdc8BQualueBxAc0+T0HPUM1IWsPq17PkkQ9GDZWmmV8IqTDy7iMmVHaCjk5QBUN33OhAXcx5omBVmCiKaQ86M0DQoBm1OgbRBZFERnu2gqEhauJSIWtiQlpYQIa5eCRp1mC77phWLQCNR4beELyxAnqGN9WcgZjJCd1sSDSwC3EQ26DoqgtLOGgy8rjSbg0uq5p7MwZjAGyi8UG4TFLVIyvrc6haC1j7f7sDLWPESNBF2/MICbMo386wuVGi5pLrqOpuEelnW4/ODdsNGOlPDOW29zs5XWkVAJcOqNjnie2FK3DQN7xmFu+G8Yl2FxLg9y2iEJO2EKNCcnsFJgGkylp4Idw1dLt8lMMyJo37Bh5GIb0ZxXb+WOGmcGSW4gyqxinshP0DjdkKPWRQlJKx1KeZYmIXLF0vhkyMt+7KMriHfrircS51txVq4XUPG1GxE1lgMRKkb69IM9F7ELJ4wuZzHw81pNyjXH35g3rvz9YKaOjo3H49jCO292j0XH7uAvd9jvgYbv7ZnzIT34dnbyN3gVYJXkzkFTIP0FO7DToHR3iI3+sP+4P62YdV2Zv0CM69vTb9LxuSxiG/4hirvTU2P2ut9BVB1+VvsN2gB4wwTBRSOamfiPzlFoxoJaaAdFWKtmuPSo94VL87UiCj9wYMZEpEQjXEIKmxr0d7ML5BlqGTE9QTFq1CnzpG6GPZhk6HMZ5NkRdi6EUnqUNBVRH8HUKBI1hf5LKMtRf8JxVdgiidwDxCgTfG1pVZ3q2w43NoquFtUZXWBHY1Klra3QwFPE+JbWlXIomIpJZhmYRGreIBfEtXLo2bilnW9l0u18dDdC1MNHQzGS0V9j6ZtMx89rsQdgpE5FpDFet+Th2LE8Z/3or2gxt/32tGkt7VZhzU0a4mYT/YbfaRI5mXg36MgPtkoMrOXqV2G7pdPsGTUJFk1cAJKE6274EUFGsBwkbO8L42QyuCtHj+akMvXkGtFKgTQJt91l9fRbix0JFgo7X/z9C1rD9KDc3J5RqksHAi5RODWHjgYf0fAspzypE6aqdiNW2ERa+DqywDl5ttmwfuvFluDyYv3hO2zWZkW9ledK8JOHRNh6blvHsgIwzhSq/Oe+n3fAX7+v0Tej5B/dC5Y2f7X2sHIdBPT6fFsEoysAdN00Cv/OYXfoDP2uzXPJR4oaBSJE/T4m9xwAl4WLs5vH16C9A9aWbMf4gVZqotsn9RVLOzbnWCof8YuA3cdK0iT7i05In7Ar0PXLK6eB2tBvBkEr4McrlFIf8BB/gMQKnaZ61ud2EAnK5iewMpz5j+ASYfz+iQZDY7uXrib1SGs++RiGJ3bj4gKjYg1ZuBi5TSGuqvFshCJzaYdBZHbBwenRh8DcjuUbCBlNrM9PrdOa4Vy7tZ2x5xQEe3xcn6APMd4dnApXvuRbEAs/DpbjfWzl6BjxKIVKbXcaJ+7HDH/8x3sSm3FjcmKadDAhflGthZw7gCLDi9VlOW7kd1JevKPYeR11omQraVFDOyu7o6ITwjf/xYdEQr9Ud4MhN/5/OVK79T1csQo4VWaRw+S10D8KDsMbEz+eXn9jZl35jR10s4uwi2ajsWzRKRxGm3d0qpSoW4xmjqGJt08CNCHCVbgEcGJD3ArNMcxLxERkIdCnQW143fOpfO6yZMjblsrZCN2irN2NrIOcVvfe7bvOBtdjLOlnChXTfZ+1anifb7do0j+maIi5amM/J7o1OioJe+1sRynAsDBGqut3YinHXjVEjtjuYVVdRbhv46DrL/k533Bft8Fm7i3qh3+dcEO0AUruNqoAMqjp2VYVZAu4+05gPr3cWURusaW20P7Ky7Dgfz4mF/wA903oz +sidebar_class_name: "get api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 profile types' (get-profile-types)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get profile types

+ + + + + +Get option based attribute values + +## Request + +

Query Parameters

+ +Expected response to a valid request + +
Schema
    profile_types object[]
  • Array [
    • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true,"description":"The objects UID.","example":"ptUid"}}>
    profile_type_dup_attributes object[]
  • Array [
    • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"description":"The uid of the properties that are used for duplication protection.","example":"attribute-uid"}}>
  • ]
    • profile_type_namings object[]
  • Array [
    • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"description":"The UID of the profile type naming.","example":"profile-type-name"}}>
  • ]
  • ]
    • _metadata object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/get-profile-upload.api.mdx b/docs/api/nerm/v1/get-profile-upload.api.mdx new file mode 100644 index 000000000..759010756 --- /dev/null +++ b/docs/api/nerm/v1/get-profile-upload.api.mdx @@ -0,0 +1,47 @@ +--- +id: get-profile-upload +sidebar_label: Retrieves the URL of an attachment attribute value from a profile +hide_title: true +hide_table_of_contents: true +api: eJy9Vdtu20YQ/ZXFPjWAJMq23KYC+uCiTqAgN8h2XwIhGJFDaRNyl9mLYoLgv3dmV7LlSHHrIKgfLHJ3lnvOzJkznTQNWvDK6Fkhp3KF/r01parwpqkMFHIgC3S5VQ2HUMAcvVW4QSf8GsXN/LUwpQAtwHvI1zVqz49WLYNHsYEqoCitqQWIJn2Xvuhh5eT0g9yuOLkYyAYs1OjR8k4nNb3QbYoBKL63Ab8+ADP7i29nIGb5CXMvvBF2C3AgQlOAp19jRYEVfZvOW/wSlEWi6m3AgXT5GmuQ0076tuEbHZ3WK4osja3B00oIEQXeQt1UHHJyOvm1eL48G0J++vtwMj45Hz4/OZ8MC4TJ5GwCv52VIPt+cMfiLiEf/4XPNTFRxY7TsZT+vxQWfJtrjHZUJLrgdDzmn4egL28bSj0WYhfKVQCuveK1LwGdp8tzoz1R4fPQNJXKo+iyT44/0h2ySBWlg6QSkqhXCUKw1eNUaZ9RQ/FOV23KEdVCeuUj8xva73temRwj8ycUYp4wi6EIGpZV5JMbzpzH0VOYGI3vyijnbznt0Mx0TNMrPsqC+V7c3xwVr7m01lCP9ItE4vwYiRnhsxoqcYV2g1bEM0SHWiNYTZUymqitQRcVveBtjvGkexK5x8uEfOUhsgtRo3OwQpHWl1S9qPUUvy/RK2NtK5whU1hz1Ffug6/WULn79DeQvGe2tsUQuKemMtv5Stapos9CNLKs2+/CnqJdTE6ym6gqufa+cdMs6ygDoP1b6t5+pKmKBMm0iCNSQQaNosMbsIq1EcnehyfGJYSKtQh5jbk57PIYLtgcBDinVlwS1lhwnuha5rdgfHmwyrcR4BLBor0ITPDDYn/7iiuScOwH3RWIScmtS/B7CqKV9PBi1zjX5jNqgkH//2hNsOmRfYwMqzT8RU5XonAyGo/Ge/p8ezl/Iy7ez4462m5T5DQnliiCS3whz0kMNDwKUZtCla3grJrg2EkIAe0KpUUEg3qjqPZshqxS0iWS0zCorce+mV1HrI1xvga9t/MzJtYDUt19k/yccZgK5fHWZ00Fiq1g53NJ0nujciCn0cvDbjxPH0wXEsaaMsBHum4JDsnv+p6XydMsa2lxL96orEI5fqYuKqFy+AjXX+bbyfNMPH3wHiW5XQTdxpai7NAbPX7GNg1/9sQfAvifJukPYHqQbDJhSjeNGuonTmUKucjZT/cOH/got++ddb28ZOH+A5V0Rvg= +sidebar_class_name: "get api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 URL of an attachment attribute value from a profile' (get-profile-upload)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Retrieves the URL of an attachment attribute value from a profile

+ + + + + +Retrieves the URL of an attachment attribute value from a profile + +## Request + +

Path Parameters

+ +Expected response to a valid request + +
Schema
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/get-profile.api.mdx b/docs/api/nerm/v1/get-profile.api.mdx new file mode 100644 index 000000000..0f368407e --- /dev/null +++ b/docs/api/nerm/v1/get-profile.api.mdx @@ -0,0 +1,51 @@ +--- +id: get-profile +sidebar_label: Find profile by id +hide_title: true +hide_table_of_contents: true +api: eJy1V21v2kgQ/isrf7qTMGBekhTpPuTU9MSpbaK83JcKocEeYFuz6+6ukyDk/34zaxswkDQ56aQo2LOzM8+8jzeBztCAk1qNk2AULNDdGD2XKQatIEEbG5nxIR19kioRWXkoZmshE2JxsLDB6FtQ0W0waQUZGFihQ8Mnm0DRC1337JIFZeCWR9LHH4WeC7dEoWffMXbCaWHQGYmP2BJ5loCjX21EginJpvsGf+bSIKF2JsdWYOMlriAYbQK3zlijpdtqQZxzbVbgiJLnHgU+wypLmSXqDc6Si1k/hLj3IRx0o2F4EQ0HYYIwGPQHcN6fQ1AUE9ZmM60sWUgKet0u/zQtuHrOCDcmomZlE0A8QiqZ9jNH60h5rJVD5fg+ZFkqY+/8znfLQjbHVpTuoIvkYgqVkyWEyuG/ZiSL3+ASg5Bcq3RdO7Np2v02LFaMPzY82O/Pu+e9JAmj/mwQDiKMwguEbhidzXsw/DAbnscXQdEK8tM4VlJ9RrWghBj1e/QKz/uvb0f1cACrcs8DaSXlZQoeaz+UJ62gP05CvlEnZCWr3VBQVYn4yqKLVq1wyiqmb/P5y9p3xVDXG8tqEGaYarUgdv2fwmEduNyeQokqX3FFX8ZOPnKdjRXUj9dKfEbwj/doKHZUlAmX/MumlIoOzGlArhQRKJlMiYE41GL6a4AZqqSkZGAt+xdk+joY8mutgIG9jquWT8BiSkSydAru1bhyjwqdXB33Tk5VPhVAPZQ5GrF8AisqFQ0EvW6vH0ZR2Ivuo8Go1x8NB+3e8CzsDkfUgLiofFv8X3FVKt6HCxxhmOUO7an+BEkiWT+kN41O1cRfHGK93AolkOCqCuAm6zjEp6qUZOKzm27hTH0X8skvY8Fn7BGy74ilG3WiYYcM7Qa72rY0euJjcY1WQD0sT50k9dN3XGvdIc2FRDRolLmmSarGhxejzUuCHyyaIzDvuVej2RFKKDvBRUHhcdLtt8Kwx2R/Mjg1H/+ERNyWY1CEIlcwS/2IjDUHy/nIvXk4aoXXc79eHGZXjWqs/OT9m68WrZf5/mEur+bKGE07SzEpjRieMmJM+AxlrrhD80je8HfIHFpVcqNo+GtFpi2pnFJ6wecY/U37LuNeH+jIKo+RXYoVWgsLKmhPn3GT42ou+ffr904bsxZW05K2ZK4nQiWejOaqq0PIZ7raCH2L5ZkcdOo9r7ORSUF0691QLnq5SYll6VxmR53OhmwF5ThdiraieJFyvUZsU7w7kEm6/AhGchaU1b9lL22bA6UuyYN4Rdl43Lk8ezmnqf3LBTufsym3jgwzbMmE8cW5kW7tAc4QDJrLnE35Ntk/vmPflzj2mbahYKOCasXk95KJKOXDp7rT3usfqAgG/f9jrXNTPgbsUKnmmiWyu0oTona33d3LxK9Xt1/E5c34ZJeuD0UMilqfyG1pL8Qxhd3375VO5Hwt2KuaRhutoYSAToVUwoNB9SgpyisKN+cjZSDSmsqgqh39y/jeY820dStQeycnl/8Gys0uv1/4VChdyV23k6UglZ9gnDObKr32PiNawUj6zWJJUPhks5mBxQeTFgWTqY0YDupkl0U+xIm0/EyJO4fUHq6M+xh/u62+H34X7//2OGlLRQS19rmd5vxGjz9wXX7/UGchg2inpdRhsOXBZcxNYu/KUXPgTN3W419XHKN/ASH1rXY= +sidebar_class_name: "get api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Find profile by id' (get-profile)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Find profile by id

+ + + + + +Find profile by id + +## Request + +

Path Parameters

+ +Expected response to a valid request + +
Schema
    profile object
    = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true,"description":"The objects UID","example":"profileUid"}}>
    attributes object
    + +Attributes that belong to this profile. + +
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/get-profiles.api.mdx b/docs/api/nerm/v1/get-profiles.api.mdx new file mode 100644 index 000000000..f5d44a7ad --- /dev/null +++ b/docs/api/nerm/v1/get-profiles.api.mdx @@ -0,0 +1,51 @@ +--- +id: get-profiles +sidebar_label: Get profiles +hide_title: true +hide_table_of_contents: true +api: eJy9WG1v2zYQ/iuEPuyTX2QnTjsDwZBhWeGhbYom2ZfCMGjpbLOVSZWkkriG//vuSEmWbEd20m1BkEjk8e65V95pHagUNLdCyVEcDIM52E9azUQCJmgFMZhIi5R2ce8dWJZuNy2fm2D4JSiXxq0g5ZovwYKmnXUg8QUPfs9Ar/CEkJWXOu+rJFGPhs2UZimfC+kQMS5jZpS2Qs47eETD90xoQJwznhhoBSZawJIHw3VgVylJUtOvEFkkRVColxUIC3cTsRS2QiakhTlopIMnvkwTXOuF4aYVqNnMwBHKgSPUMa5u6YzVCLJKFkQauIV4wm2w2VQ2SjgocitxEJZMd08au3IMY4D0plAQntJExbhsdQabVmlreIqSLAY8i4immXWuOs3wCteW4oc3/XTFpLJMg820RNWYXQDjxqhIEDZW8mcxt9ydJwpPj/uVQDnutqlSCXDpwM14lticdFNRzP1rVMU7nxGhw4PyMRK9W45jyD1YFZnrMCGKiYibpedpw+6QmI3+eD2CVoBHl+j7YZBlKLWKyFhusyMe9TTsgSfZT9gBI0xmS8rvq8iKBzL9SPLi8Uay98Dd4x3oJeUr8hxXoWIZ4BQazWA/u3gxbMpttKAwK44xIfOAMqmSBn4qjirZ59JlMyZunrErEP0wpH91bNdPKcYTxnJByqxinAwraA0VMpSJkcIaIV3R4GmaiMglUPerISbrk2tUmTBbSq41d3XTwtIc54CxcjSYSG8e38hk5U2x6487NLlnbzCIa/Xs7GwWvunHcbt3Nj1vn/eg134LPGz3LmZ9Pvh1OngTvQ2wXGWHcWCQvAc5t4tgeNbHV/5UfT0d1f0OrNxu95QprTz49qXv8hOG4S8FmCsXauaec16dmoAisT8S601rryqcYPPnpWOhqMtmxKu2MIVEyTmSq1e5Iy8Z/06CN6mS1526OjXIuSAEJeIJEiCFnE+OA0xBxn4lxRuI7MtF0gwG7VoIIGDNuAr+CKxy9Tb5FSsUtPG2hAPOdTciuN6FKGq+fOSG5SJqCPph/6zd67X7vbve+bB/Nhycd/qDi3Y4GGJloqRK4/8aVy7iZbgqbcaB+sTjWJB8nnyqVaqdK3evJymZIkhu8wyg6mvJxYeyFHnCk912PRNXhVzwi4jRHlkE9dsjCXvd3qCLiobBNrcNJKjBHm2tFGANwxtGoPjJC461bgEvjJjV1jBydX0pv1ccG6WfY3xvQO+Becm5As12wUPZMt5QB2qFrZbCdt/1pZPyin91A97UcpNcZXlyeEuSSxv77y5mdarwyG9O+mUv/MXLurwIfR2HB6GeqTwncDkPg6ptPhTG2LifVnB+qKf4ncfss28dWJtlkk8T11ZEiuRZF9QnNxRKws3MDVq71i9AjaTrVv6io9SbPUf3N1E5MddaK5zeNmOvxOCQEiPEpzGp2S3oBwwUdwbVKZt/nB8yucBKk+ALTiTgTpoXKdccUEAi95FdYf9oDJ9jrXPr02Jy8fRVx94qrVc4XWIQu8bzEVGxR63cDJC7kPZUPha724falaBbmW2Ms4CfdjONsRosrE3NsNtdo5pcWkqiTUeiq1CuWgF00NVdngo8/MC1oADwIViSe7Xy/jXg0RJzdL+eO3LfveClKOZkdwqkzFjUSZMSY8IXZVrYlQM4Ba5BX2WkxZdxdfuWzO5xVIlKL5BSQd5wu0bbEeGKf/izuH/u1DfAvp3+Xq5Upv2jyxMhZ4o4krm8Cr1O2AkrQfjx+vMHdvVpdPDuKjZZxHE4BZYZry+PIvS4u9WWKhazFSOrYlpT144IcJdGCQcG5INABy/R0xSKGHxAk8WwnFk+jO4c1lQZu+SysrPz7aOGb70N6r1vJN58dP9004QL6e5y7Wqaj6b695MFCqa19XrKDdzrZLOhZT87kQtjYShitjPQs0j+h8H+oHbfYPXcZwg3kuKmK0Wna9I01zdAyD8YvFLosXG+QfD+Z4NXYmic5BsAlF8JXin3JUN5A4zKF4AtkPG27LkihDGPox999sLo9ueuIrowKqf2LgriUtbmd9eUtP8AHlEqKA== +sidebar_class_name: "get api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 profiles' (get-profiles)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get profiles

+ + + + + +Get profiles + +## Request + +

Query Parameters

+ +Expected response to a valid request + +
Schema
    profiles object[]
  • Array [
    • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true,"description":"The objects UID","example":"profileUid"}}>
    attributes object
    + +Attributes that belong to this profile. + +
  • ]
    • _metadata object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/get-risk-level.api.mdx b/docs/api/nerm/v1/get-risk-level.api.mdx new file mode 100644 index 000000000..1ea09738d --- /dev/null +++ b/docs/api/nerm/v1/get-risk-level.api.mdx @@ -0,0 +1,47 @@ +--- +id: get-risk-level +sidebar_label: Find risk level data by id +hide_title: true +hide_table_of_contents: true +api: eJyVVdtu2zgQ/RWCT1vA18TZtgb6kMWmCy96Q5L2JTCKkTS22UikyotrQdC/d4Z0YgVO0yYPsciZ4ZyZczhspanRgldGLwo5l2v0l8rdvsMtlnIgC3S5VTWbyfhW6UJYMouS7aIADyJrhCrI1cPayfmNPNidXA5kDRYq9GjZ2EpNCzopRig+swa/OUq0+FeYlfAbFCb7hrkX3giL3io6diBCTYnp11hRYElnU7zF70FZpBK8DTiQLt9gBXLeSt/UnNFRtF6T58rYCjzthBBR4A6qumSX6cns7+JVdjqE/OT1cDaZng1fTc9mwwJhNjudwcvTFciuW3I2Vxvt0HGCk8mEfx5WcLGrCTdSu/auXAKILZSK974HdJ6S50Z71J7joa5LlUcmxt8cH9IeV5HaQYG1Zd68ShC4519jz3/vS0X/QVcsQvFRl03qZzeQ4fG4Sul3qNfE4fz0hJaw6y+PTikhe4Bxfw5ZaqO0dz2TDlWGllOE0iti6ONKziejyZScjS3IdPClUFwnZ6VVFSry7MjPKx+ZPUi6i38DOXuMtH+gEJeJGzEUQUNWRt5ywwrxOHoOY0ZHxDfHfNyhWugoh/85tBv82u8Le8U0F9YaukjdMhVx9lgRC8JnNZTiCu0WrYgxVA7dn2A1KdJoKm0DuihpgbscY6R7VnFPSww55TGyc1Ghc7BGkfYzoj5e8uTfv4pXxtpGOEOTY8NePwiV+GENa+WOQraZ/cxiCDxI5nJ8uAtu3KqiI5OLnUgDKFjSn9x4X7v5eNxSuaD9B5pK3UgTZZTfNIgjonwMtaLgLVjFQkjavHdP5a2AxEnnQV5hbo7m2HV0Fzz0BDin1tx/FlRwnmqzXMyS8eXBKt9EgBmCRXseuJqbZd98xe1POPpO92xwUXI/+nidnGgnfby9u+LX5hY1waD/bxoTbPqU3FOlV4ZP5HalEqYjunM9MX64uHwvzj8tjmslIu+MIgctMhTBpXohz4l5QZoTlSnUqhHcVRMcj0dCQFahtIhgUG8VEV0R4yxJEiHS+GRQ+7fj/eI6Yq2N8xXonuXJ9+kB2vYg9d+8aqm1Hnd+XJeg+KYmDbV7xd30pq+jiDnFEWkbQsfGts3A4Wdbdh1v03CxzPPyIKzIeqEcf5OcV1A6fALuX5f7p+6FeP4z+Wg5+03QTZR7GXhFn7fYpKea5g0VRLOchy6BTYbznEdHL+RoZLB472/pfxdM20+Cz+Qn +sidebar_class_name: "get api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Find risk level data by id' (get-risk-level)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Find risk level data by id

+ + + + + +Find risk level data by id + +## Request + +

Path Parameters

+ +Expected response to a valid request + +
Schema
    risk_level object
    = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/get-risk-levels.api.mdx b/docs/api/nerm/v1/get-risk-levels.api.mdx new file mode 100644 index 000000000..bd68778bb --- /dev/null +++ b/docs/api/nerm/v1/get-risk-levels.api.mdx @@ -0,0 +1,47 @@ +--- +id: get-risk-levels +sidebar_label: Get risk level data in bulk +hide_title: true +hide_table_of_contents: true +api: eJytVktPI0cQ/iutPuTk2Gaz5GAJRUQiKyJYIiC5IAvVzJTtXnq6Z/thPLLmv29Vjz0e1l4Dq3AAprseX1V9VdVraSt0EJQ1l4WcyDmGW+WfrnCJ2suBLNDnTlV8T7f3C+UFmqKyygSRgxEOg1MkLBxpCc1qooAAQhmRRf0kZs6W4krNMK9zjWQxwNzLyYPcKXg5HcgKHJQY0PHlWhr6IIdfI7qalJTpfbzEdK61ffZiZp2oYK5MikWAKYS3LigzH5KKw69ROaQIZ6A9DqTPF1iCnKxlqCv2ZLMvmAcSrRxnJCj0fKtVqUJPjOLGOTqSwxWUFUU0ORmPm4G0s5nHVyRPk6Ar6HQn5ymBZt4Xk7lDCFg8QpBN07vo4JDLncfTcWf0e00f6mSwQKxutgHiqtK2oOPgIjaDLtcaMtTHc32/QAGBAGcxoEgKIlgxU5oKJ7L6TZneBNz0XFPhgVlz3PsthuiMFxmEfEEmxFaNyRYImkNfWePxTTAyazWCSV5mEHXoRLt8pwQ1U7bWGk6U+DAe85+X2C5WFWUXiw4D5wXEErTiMwrIc+5zS6wwiSZQVVrlia2jL56NrN/MSu6dx03v7ITBOUjNErD0rxtRxSEWUh+VxJ6JjJEEOHQoboyut3SR8bBeqcwVmnlYyMlvH+gTVv3PPSst2fZJQSB5tvThm1hmqY9KKpKiwtzM5GQ8HJ8caKZd0xEeVcaSJLkRggqpEbrZltrjsePdT8+BY53Pfm0AffjK4CocHwOj7aT9I3k/Oxn/0vo6+32cMuVwqWz0P2vl41j2c3O9TUaTfgby4yGi/wmFuG35LH4V0UCmE9dzy/4CDt/DcmtSMR/2s78FdWlSC/3NqjwwfiT3H0slNxfOWVoizbQN4vRQEJeEzxnQ4g7dkiZX0qFwXJow1MW0QaJZ0BLR9IGrHJOmf1dwxwmF7HIf2TkNNe9hjqI9z3jO8Wxr5fuFvbPO1bTkiMRpGj4TKvHsbJqtmxLynd3sdYYA3JBy1J8fNBpTEtq9Gx3RVS5CqPxkNFpTpGDCZ5rSzdBQtci1rRGHVO0RVIqUl+AUc6BlYSfeRraZqxLyEnO7v06SuOAlIMB7NefUM5eiDxSW4zimjC+PToU6AcwQHLrzyIE8TPvXd5z5FkdfqCsEByU3iyAtgCREJ+0/f20H3719Qton/PusttG1/6ZWUWZm2SKnqw3hZEiTqMfDzxe31+L8n8uDq3N7mV5OGYro23ghz6no6c1S2kLNasFZpc7mbUII6JZXXAKDZqmoxiUVm9lI/EPeeJNul15f3ieslfWhBNO7+YThR8+07+GudzT/fx59bQkCzbxRpUFxM7dcW29I+fBiqVFZF4Sfj9frDDz+63TT8HH7NGAmFMoz8XYr/kgErz5bDgJ8wrr3LqJBFFkmzaG3O3/Pq+UIit4TaQdkuuu/1A2UNVq0vBEpP63eec7Dq6e1N7TYSjcnPl0we74BeOkuVg== +sidebar_class_name: "get api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 risk level data in bulk' (get-risk-levels)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get risk level data in bulk

+ + + + + +This endpoint can retrieve risk level data in bulk from Lifecycle + +## Request + +

Query Parameters

+ +Expected response to a valid request + +
Schema
    risk_levels object[]
  • Array [
    • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
  • ]
    • _metadata object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/get-risk-score.api.mdx b/docs/api/nerm/v1/get-risk-score.api.mdx new file mode 100644 index 000000000..56b48c00e --- /dev/null +++ b/docs/api/nerm/v1/get-risk-score.api.mdx @@ -0,0 +1,47 @@ +--- +id: get-risk-score +sidebar_label: Find risk score data by id +hide_title: true +hide_table_of_contents: true +api: eJyVVm1v4zYM/iuCP21AXtt0uwXYhw7rDRl2L2i67UMRHGibTnSVJZ8kpzEM//eRUnrxwV2v6YfGMknxIfmQdJuYCi14afQqT5bJFv2tdA/rzFhMRkmOLrOyYjEJ30qdC0ti4VgucvAg0kbInFQ9bF2yvE9OcpdsRkkFFkr0aFnYJpoOdFOwkHxnBX43cLT6XZhC+B0Kk37GzAtvhEVvJe5xJOqKHNOvsSJHRXeTvcUvtbRIIXhb4yhx2Q5LSJZt4puKPTqy1lvSLIwtwdObug4o8ABlpVhlfrH4KX+TXo4hu/hlvJjNr8Zv5leLcY6wWFwu4OfLApKu27A3VxntKEJycDGb8c+3EdwcKsKNlK6jKocAYg9K8rsvNTpPzjOjPWrP9lBVSmahEtPPji9ph1HEdJBhZbluXkYInPNPIeff16WgX5EVi5B/0KqJ+exGSf28XSn1X6i3VMPl5QUd4dA/Dm6JmD69BsNJO+oN9VHXJTPuozWFVMyCf419KJR5XKNzXIcNX7Infis1SA8Zp2g5hFp5SQz4UCTL2WQ279mEvCoinXotZFlWQJDPcXY0Od8X1TWFVCrpm7Mc9u3O9UrmXvrQLqc50YW/UbJ4rhN+g1zcRsKLsag1pCo0Q2a47TxOzmkDo0Mg90OSP6Fa6dBjf7JpN/p/vX9YK7i5sdbQdOo2MYir54JYET6rQYk1WuKGCDYUDg2l2mpqc6MptB3oXNEBDxkGS3dWcC/3LbLLIbJrURLZYUvTOLxPqWxhckb9/nxbG2sb4QyN4x1rPRIq8WgN1bl7KiHLzHERMASezstkehowbtrKvCORC5mIU722irR23lduOZ22FC5o/55GfTfRVDLybxrECZV8CpUk4z1YyUQIkZ3UY3gFEGfpPshKzMxgOdwFdcGbRAD1+Zbzz4SqnafYLAezYXxZbYniAWCKYNFe1xzN/aYvXnP6I46+0tdqcFDJcZ/wOSrRm/jw9qk97swDaoJB/39tTG3jY2gYqQvDN3K6YgjzCbVij4zvb27fieuPq2GsVMgnochAixRF7WK8kGVUeUGcE6XJZdEIzqqpHe8cQkBSIbUIYFDvJRW6pIozJYmESDuJQR0X8rvVXcBaGedL0D3Ji0v/G7Ttierf+VSIqfV48NNKgeROjRxqj4y77600RxZLsqOi7QgdC9s2BYd/W9V1/JqGi+U6b07EClXPpeNnonMByuELcH+4PX4//CjO//Z4NpzjS9BNoLuq+USPD9jE75+Ol9OOFiSxicFGwXXGo6NnMhgZTN6vXfrHDZftPz6sXLU= +sidebar_class_name: "get api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Find risk score data by id' (get-risk-score)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Find risk score data by id

+ + + + + +Find risk score data by id + +## Request + +

Path Parameters

+ +Expected response to a valid request + +
Schema
    risk_score object
    = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/get-risk-scores.api.mdx b/docs/api/nerm/v1/get-risk-scores.api.mdx new file mode 100644 index 000000000..85a34c332 --- /dev/null +++ b/docs/api/nerm/v1/get-risk-scores.api.mdx @@ -0,0 +1,47 @@ +--- +id: get-risk-scores +sidebar_label: Get risk score data in bulk +hide_title: true +hide_table_of_contents: true +api: eJy1WN1v2zYQ/1cIPuzJs52u2YOBYMiwrPDQNEWSbg+BEVDSyWZDkSpJORYM/++9o2RZjr+9Ng9NRN6Rv/v63bFzbnKwwkujhwkf8DH4e+leHmJjwfEOT8DFVua0j7uPE+kY6CQ3UnsWC80seCthCsyiFnOkxhLhBZOaRYV6Yak1GfsoU4jLWAGe6MXY8cETXyk4PurwXFiRgQdLm3Ou8QMv/FaALVFJ6tbHOqZrpcyrY6mxLBdjqYMtTOiEOWO91OMuqlj4VkgLaGEqlIMOd/EEMsEHc+7LnG4y0VeIPYrmljziJcLCXSUz6VtiaDeMwaIczESWo0WDi35/0eEmTR0ckLwMgjbB1ZWcQwfqcVuMxxaEh+RZeL5YtDYaOHjl6sbLfnPoW03ny3BgApDfLQ2EWa5MgsveFrDoNL6uPPAsk/3+Hv7FTIr+ZZV8cHwqFUaOfM2+OEiYUEaP2av0k1rqORh7TBwad+C5GZox4EWBkBabQOsj90B9RAkCWyP1E+FZYyWmbo65B9q704CBLjJK4M/WoN0E4T9jX1LMwgdwjm4eraGdYn0p9Uz5/qywVNRBF99VKlVNBRXmTe1kFpU/yo8yywW64gRgw6Dxs3FhBUYikkr68hRwn1dqPxshEpUgltsP6B58YbVjkfDxBI9kSzUiRz9BzgSXG+2OK4zIGAVCh1tSUSjfiDb8EAp6MaLTqoMDhb3r9+nXOrabWY5lAEmDgfwk2FSoUBlokCOuiA2ymA60JvJcyTiwa++ro0PmR7NoiGLN9SthYa0I5O4hc4cPwRgcDBKZLpI7rcolvfFiu14m9UfQYz/hg9/e4aeYtT83TlmR4+FE6awx1JkM0mmII/itdQwqR6GvZJgEEgN/l/JBv9u/aOmsl80xkGsyOOWyrfxxzF3tAj/lwt3EcEz1ci996IbNgBNWn5tiPnsY2Nf+6V7jhdq+pWHm988CveW49Ue4/eqi/0t119Xv/cqXMJWmcOee8r6/5pvbpTMW4afD329jjz9Fwu4rkmC/skKLSAUCiQ3d56F7CnUYHWL8tOn9JaihDrz0D6kSC++S+5ekwjU31hqcJBejyojLbUYMEZ/VQrEHsFg2LOigOTbQNlIjjpGFnuAkqfADZjEETXeScfsTCujKTWTX2CmcE2McpcN6RM2DGkYl3w7sg7G2xEkXkzi0mFdExV4tjl91BNF62jP1cE8QBLEc77VJGftNcEI1fBcW05VPvM/doNebo6VC+0/Y+hZdjdHCq00J0MVo90QuUXkqrKQcqLKwEa8sq5sVF3EGsdkc0oI4o87KBLLfmFxPuVQ4j2ZZsmNE+OLCYuEHgBEIC/a6IEOeRu3tB/J8haMt1ASCjOJ1dw1dNQjhSvXH30vSeDQvgE2a/r0qTWGrP0OpSJ0aOpHcVZlw0UWCauXhp5v7W3b9ebjl/QRsuRmeTxGwwlX2ijjGoIeHS2YSmZaMvIqVTS0aEeAuzQ0BDOipxBhnGGzKRsw/oDFi0Awot8PHgDU3zmdCt3Y+gN/1VnsLd75K8x/z8qtC4JHzerkSkoq5yrV5nZRPa5MChnWC+Gl5Po+Egy9WLRa0XM1blAmJdJR4q7lppwX/692yFfoLlG+eTUhTBckFljoe2gnvlMNAasRnQjn89NiHYMdT50wsB18be6DseNucieS4p8UeOPueNGdiOuV1sQdZ6ymzAjJaUXogWCxEHIjpfxiw5Cq965j6YUtrow/SKU3r+XBDhPQdkcBoqg== +sidebar_class_name: "get api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 risk score data in bulk' (get-risk-scores)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get risk score data in bulk

+ + + + + +This endpoint can retrieve risk score data in bulk from Lifecycle + +## Request + +

Query Parameters

+ +Expected response to a valid request + +
Schema
    risk_scores object[]
  • Array [
    • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
  • ]
    • _metadata object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/get-role-profile.api.mdx b/docs/api/nerm/v1/get-role-profile.api.mdx new file mode 100644 index 000000000..548685bf3 --- /dev/null +++ b/docs/api/nerm/v1/get-role-profile.api.mdx @@ -0,0 +1,47 @@ +--- +id: get-role-profile +sidebar_label: Find role-profile contributor relationship by id +hide_title: true +hide_table_of_contents: true +api: eJydVdtu4zYQ/RWCTy3gWxyn3RroQ4pmCxfdC5K0L4FRjKSRzV2J1PLitSDo3ztDKhulTrfJ5iEWyRnynDmHw06aBi14ZfSmkGu5Q39tKnxvTakqlBNZoMutajiAll8rXQhLAdMmRYjcaG9VFryxwmIVd3J71YisFaqgDTzsnFzfSc4SQ5aT24lswEKNHi0vd1LTgE6IOYrPasDvTwBsfhWmFH6PwmQfMPfCGzqWEOABJyI0BXj6JSwFVrQ35Vv8FJRFIudtwIl0+R5rkOtO+rbhEx1l6x1FlsbW4GkmhIgCj1A3FYecLVc/FK+y8ynky5+mq8XZxfTV2cVqWiCsVucr+PG8BNn3Wz7NNVQAYkgHLBcL/nnM4OrYEG6kMg6hTAHEASrFc58COk+Hc11Re86HpqlUHis7/+B4k+6URSoHJVKJSVGvEgSu+t9D1f8/mmg/oy4WoXinqzZVtJ/I8HRerfQfqHek4vp8SUM4jocnu0Soz0HQR9jM6HnhFO+Vj0KOvD1d0gr/TeTqKZ1+gUJcJznEVAQNWRWlyg2bwuPsJSIZje/KaPN/C3CPbKOjA37n1H7y33F/cVQ85spaQ3en3yYSF0+R2BA+q6ESN2gPaEXMITp0ZYLVZEKjidoedFHRAI85xkz3InJf9xTykafILkWNzsEORZrPSLp4r1P8+PbdGGtb4Qw1iz1HfSZU4rM1pHV/LyGvmaGBMQTuHWs5H9vfzTtV9LToYi1S1wm2ori9941bz+cdEQbt31Ir6meaRCMEpkWckehzaBQlH8AqtkLk9hCeCJYQKvYd5DXm5qR53cZwwZ1OgHNqxwqwpYLzxM4ynS3jy4NVvo0AMwSL9jIwn7vtePmGBUg4xkFf9GBScuh3PE5BNJM+Xt9fklvzETXBoP8/tybY9BmvjdKl4R25XInC2WwxW4zs+Pbq+o24fL855UpS3i+KHLTIUASX+EKek/aCXCdqU6iyFVxVExz3REJAq0JpEcGgPiiSuibN2ZRkQ6SeyaCGB+PN5jZibYzzNejRyjc8Vo84dA9X4JseviSDx6OfNxUovtfJb93gz7tH7dlRzpoySeI9ceHlrsvA4Z+26nuepmZk2RXbBxtGjxTK8TfZv4TK4VdofHc9vIbfi5e/pE8SGiZBt/FyVIFH9PkR2/SaU38iQtTsyXsMNi1c5txqRiknLYat/uVW/3bFIv8DYij/QA== +sidebar_class_name: "get api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Find role-profile contributor relationship by id' (get-role-profile)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Find role-profile contributor relationship by id

+ + + + + +Find role-profile contributor relationship by id + +## Request + +

Path Parameters

+ +Expected response to a valid request + +
Schema
    role_profile object
    = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/get-role-profiles.api.mdx b/docs/api/nerm/v1/get-role-profiles.api.mdx new file mode 100644 index 000000000..fa9a9501c --- /dev/null +++ b/docs/api/nerm/v1/get-role-profiles.api.mdx @@ -0,0 +1,47 @@ +--- +id: get-role-profiles +sidebar_label: Get role-profile contributor relationships +hide_title: true +hide_table_of_contents: true +api: eJylVm1P4zgQ/iuWP9ynvqRsud2thE6cjlv1dCwr4O4LqpCTTFrvJnbWdqBRlf9+M3abplBa4PgAxJ6XZ2aemfGK6xKMcFKraconfA7uWufwzehM5mB5j6dgEyNLksD7L+CYQYF+GSRYopUzMq6cNsxA7i3ZhSxJ1Ym55ZM7Tgqs3Jic9XgpjCjAgaHrFVf4gbZ/VmBqVJOq87Hr/jzP9aNlGTorxVwq744JlTKrjZNqPkAVAz8raQDDyURuocdtsoBC8MmKu7okTzr+DolDUQSF4TuJsPA2l4V0HTGpHMzBoBwsRVHmeDaKoqbHdZZZOCJ56gVNiqdbOYu5UvOuGE8MCAfpvXC8aToXLRx0ufV4GrVGn2paV3uDKUB5tQkQlmWuUzx2poKm1+aaSnIv08PZvl0Am/7BdMaEL7rPOxYRCxeiOJ7pNmBULRDohFcVum06UNbEOIpmzUlC5PQaBovr/wOjW4cxjD9F4/GoPz4dpf3xx/Rz/9PH5KT/WURZlMHowynEO7iRwCIVThxGfQ2uMsqyWLhkgRjYRo1JxRwm2IAtsWXgVXHEGssglPeSiSp3rWgbiC90MyNrwbCn9kkU0Z9dbBfLElkCaYuBEivYg8glnWFAljhELQ7K012UZS4T33XD75aMrF7dXZ5y7RTYigtjhG97B4U9bgbL9oq6YmukVyqvN8Tn1X69Qqq/Qc3dgk8+nOCnWHY/n1nZtM1xgve6vH5NP3AnnSdiZ/72T/zNfUu1d4+wQ0OLfGsn8v1XCpbu8AQbgkpLjSq/ee9no+iX4Ovs1ygkAh6krux7rYyjnfxcbpLR+J8eH+/j9u8iZdeBwqzPKiXi3NM70eTPweAtxNYKrjK/qp5mfwNqqnzX/EWqNCNekvuXpLybC2M07r9mFoI43RfEFPEZJXJ2A+YBp53XwXCMHyrYuLj8KrXA/ZfjBywT8Jr2TcEdJhSQy+fIznGOWSvmwMJ5TKONxlmQ7xb2RhtT435GEvsB+Iio2KPRWP9mU0K60+v3B0EQ1IF8uDsycB76NIRHQ2WQsHzhXGknw+EKYxXKfcXR3AwU1gud6xpggPUeilKi8oMwklgQeNiKh9jWw5SLpIBEP9+EXpzR5GfCWjmn5BObKuswMEORzAhfUhnpag8wBmHAnFcUyt2se31DuQ84ukJtKSgovp7+fup7ITwJ//y5GR23+gfgEqHfZ7WuTPjXN4tUmSaLlK4QwmgQDaIOE79eXF+y82/TvVt/c8kSoVgMrLIhXpEkWHb/4Cp0KrOaUVaxt2mFIAK8pb3mwYB6kFjlAstNfEQGAq25SbtAL6e3HmuprSuE6ty86ZW5g3615f0b36oh9Q6n3bDMhaQ2Dhxbrel492SDYUEXiJwuVqtYWPjH5E1Dx+ElQBxIpSXKbTf6i2CPvrX2AvwB9c5jDodQRVJ+Br3e+ctPqwNed95t73T8ltfRASidp9gWyGzb8r4BsVy4zunljIUJeucJTcyO1rNJSVba4fTlggj7H+yVjaA= +sidebar_class_name: "get api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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-profile contributor relationships' (get-role-profiles)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get role-profile contributor relationships

+ + + + + +Get role-profile contributor relationships + +## Request + +

Query Parameters

+ +Expected response to a valid request + +
Schema
    role_profiles object[]
  • Array [
    • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
  • ]
    • _metadata object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/get-role.api.mdx b/docs/api/nerm/v1/get-role.api.mdx new file mode 100644 index 000000000..829a41a81 --- /dev/null +++ b/docs/api/nerm/v1/get-role.api.mdx @@ -0,0 +1,47 @@ +--- +id: get-role +sidebar_label: Find role by id +hide_title: true +hide_table_of_contents: true +api: eJyVVdtuGzcQ/RWCTy2gm225TQX0wUWdQkWTFLbbl0AwRrsjickuuRmSihaL/ffOkJItV65T+8FaknM5M+dw2GnXIEEwzs5LPdNrDDeuQj3QJfqCTCMnvD+3K6dWjhQo32BhVqZQ0SMpytYB1l7PPmpZer0Y6AYIagxIst1pywsOY0q2NRKwgbA5zfKrcisVNqjc8hMWQQWnCAMZ3OJAxaaEwL+MosSKY7M/4ZdoCBl6oIgD7YsN1qBnnQ5tIxk9e9s1WzL4GgLvxJhQ4A7qphKTs/PpD+Wb5cUQivOfhtPJ2eXwzdnldFgiTKcXU/jxYgW67xeSzTfOeq6QE5xPJvLztILrHXcnYKkOplICqC1URva+RPSBkxfOBrRB/KFpKlMkBsafvATpTqvI7WDHhoSvYDKE1PxvWnG5/6MfhFB+sFWbO9kPdHzerzb2D7RrZm92cc5L2B0vn0Y57nJqhyN/n0Bz/CyJ0wSPLrd7F7Fek4uNP7IHImhFTQFr/3IcKO+T+31K2fccLpiQjpLY+/Q30NPnGP0FSnWTiVNDFS0sq0Rq4SR6wNFr6HQWP6zShfg3ZQdAc5u08ru49oP/tvtbrFKaa6LUo0Uu4vK5IuaMjyxU6hZpy7c2+XA5fLkiWZars1zaBmxZ8QJ3BSZP/6riXlYhSspTZFeqRu9hjSrvL5m8NAGy/RM5OKJWecdjZSNWXxmV+kqO2e4PFMqZ2w8ygSBTZqbHaSyNO1P2vOlTD/JcilTx+SaExs/G444LBRves0z6kWWyOLNrEUdM9hgaw85bICMSyJJ7MM+FrSBWcqWgqLFwJ+PtLpkrUaEC781aOi9Sij5wVSRlLARfEcmENgFcIhDSVZQ6Pi6Oj2+l8RnHsdEDD1KU3k9EWWcj3skfbw/3/859Rssw+P/PrYuUP7V00/DUl4jSrlzC2WgymhzJ8P31zTt19ef8tFam8HCoCrBqifJgpHqhKJhzxWpTtSvNqlXSVRe9TE1GwKfKWJXAoN0aprhmrkWMLD/kqSqg9k/Ku/ldwto4H2qwRydvDScQ5tWyVWnGPYHYPSr7289bbmnAXRg3FRi5m1k73V5jh6dvoGecimnaMB7Z7rolePyLqr6XbR4kJMwuHqWUeC6Nl2+W7goqjy9g/e5m/+Z9r17/Xj5byGGi2jYJvIqy4s/P2OY3m2cLF8SjnfUjYPPBVSFj4sjlZDyIXB9u5G/XQtQ/uiPkjA== +sidebar_class_name: "get api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Find role by id' (get-role)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Find role by id

+ + + + + +Info for a specific user role + +## Request + +

Path Parameters

+ +Expected response to a valid request + +
Schema
    role object
    = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"sponsors_role"}}>
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/get-roles.api.mdx b/docs/api/nerm/v1/get-roles.api.mdx new file mode 100644 index 000000000..2fa923cde --- /dev/null +++ b/docs/api/nerm/v1/get-roles.api.mdx @@ -0,0 +1,47 @@ +--- +id: get-roles +sidebar_label: Get roles +hide_title: true +hide_table_of_contents: true +api: eJy9Vktv20YQ/iuLPfSkSnIa9yDAKFTADVTUcWG7vQSCMCJH0ibkLjO7lEUI/O+ZWUoUFcuynUN8kLm7855vHlvtCiQIxtlJqkd6ieHOZeh1T6foEzKFPPHDw8p4hTYtnLFBJWAVYSCDa1QkDGpBLlcfr+9u+uo2MkGWVapyZSQuyK1NiqoAghwDklfBqYXJ+JMl+TILvs9KAyy9Hn3SUaae9vSBga+32vKBrflaIlVMbmzncGzwOMvcI5vliJUujY0+KrCp8o6CsUtRR/i1NITs+QIyjz3tkxXmoEdbHapCNLn5Z0wCk7IHHKlg2Cx+zUxuQoeMg4JLJKbDDeRFxncXw2Hd026x8PgC5WUkpJRvD3Seo2uXXTKdEELAdAZB13XnoTWHVR40Xg5bod9z+lBFgSlicbt3EDdF5lK+DlRi3WtjzdGHFAKcD/cdhpKsV3MIyYoNV3s2ZawKK5QkF856fFXU547zDzZqWQCDoyVtnY5W1lOR1giOeXk3HMq/Y9uuNwW7iGlrg2AP1BoyI3fskJcAJI5TY2OuoCgyk0TIDD57EbJ9NTQa6B7IgAgiVgPm/mV2k54CAcM45+SNdFkygTgN6a3Nqn22dHmaLzf2H7TLsNKj397xETbd47GULtRinBz5mXijWX4DhnPovN+xCPWSXFm8Jggn5EA6i+yzqLIWvAYT4tNdNIYvZi0of7hSz9WmqHQBstNPFjfhvAuDfaP8I2q/uhj+0ui6+n0oEgrCtXHlC4F4Xsr7oe6G5WYfjDr+9fT7U1XwJ6TqrgG7+lWVFuZZLITEib6A/beUgLN4u4gd+fvo742a2FhffwurdJPn6P4XqqjmmijCZ9o4cXnKiQnbRzxa1D3SmkdH5GF3KLYfLnHu8aVdcZvP+ICbBCOnf5Nz5wGFovKpZWPueN7DElVzP5cmKI2voT+qFEdU8RhiEMdW+chWqUdynP96n0J5c7uJLCaA1Kwe0G44++h+MxNLYqDqVQiFHw0GW/YRbPjIxVP3LeeJlboKsc95HkBhmHkNZCT7Df5a8sanXbvVkOSYuKd7QCRXUpsKvDdLCbqgqPSBHSLxYCr2JSWZUEUD5wiENC7FhU/T7vO9xLyxo0vUpkCc0rv5EOdCJOKb5uOvfVd8cF+Qx4z8XvHKQc1nLBJjF04kSrgaFy76w/6wg0BZWtT438mJnQfV/jFuMXNUpW/8hSThdMd9InepWVRKoso1LUOGLeBXmXzRGLRrw9nNOc2CQ0YeyiActSP2ZvIQbS2cDznYzssHDIpOLWTbA5x/2m7W5CRw+xsUGRip6wZ82x0+O3vbil2Ri+12Dh7/o6yu5bpZHgQUqfGCwcMS8Kx7b1ktTtr4BavjPYY7UylkWrC4r4aITTacZ6LsTGxiwzdOpIl0uJ40D5HS1uuHa8nlN67+7uo= +sidebar_class_name: "get api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 roles' (get-roles)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get roles

+ + + + + +This endpoint can retrieve roles from NERM. Optionally you can provide parameters to filter results. + +## Request + +

Query Parameters

+ +Expected response to a valid request + +
Schema
    roles object[]
  • Array [
    • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"sponsors_role"}}>
  • ]
    • _metadata object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/get-user-avatar.api.mdx b/docs/api/nerm/v1/get-user-avatar.api.mdx new file mode 100644 index 000000000..3786a4199 --- /dev/null +++ b/docs/api/nerm/v1/get-user-avatar.api.mdx @@ -0,0 +1,47 @@ +--- +id: get-user-avatar +sidebar_label: Retrieves the URL of the user avatar +hide_title: true +hide_table_of_contents: true +api: eJyVVU1PGzEQ/SuWT62ULyC0NFIPVKVVqlKqAL2gHCa7k8Sway/+CKxW+987YycQGoqAA7E9M/Z7M29mG2kqtOCV0eNcjuQC/aVDe7wCD1Z2ZI4us6piO1kn6K3CFTrhlyguJz+FmcdloBgBmyAPCydHV5JPnZx2ZAUWSvS8G101UtOGblM5+Sq+twK/3Hls/HVzu5ldY+aFN8KuAXREqHLw9GusyLGguyne4m1QFomHtwE70mVLLEGOGunril90FK0X5Dk3tgRPJyFEFHgPZVWwy97+8EN+NDvoQrb/qTsc7B12j/YOh90cYTg8GMLHgznItp3ya64y2qHjB/YHA/55yuDkviLcmIuNK1MAsYJC8dltQOfp8cxoj9pzPFRVobJYjv6140uaXRYpHRRYWS6eVwlCsMXLVMnOqCE/00WdctS2VC3lI/NLsrctnwyfI/MFcjFJmEVXBA2zIvLJDGfOY+8tTIzGs3nUwr+cNmjGOqbpB4e2nf/7/WGv+MyJtYYE1k4TicPnSIwJn9VQiHO0K5JsjCE6pKtgNVXKaKK2BJ0XtMH7DGOkexO5l8uE/OQusmNRonOwQJHOZ1S9KP7kvy3Rc2NtLZyhjlqy1x2hEnfWULnb9NeRbDPrhmYI3GAj2Y8d2W9U3vYfutXFVKTOjBqSS+8rN+r3G+IL2v+idm17mmpGAEyN2KOa96FSFLwCq1gJkdqje+I3h1Cw8iArMTM7DX4R3QVPAwHOqQUXgBUVnCdyltlMGV8WrPJ1BDhDsDSeAtO5mm6bzzn/Cce200M5mJRczwTeJyc6SYtvmza5MDeoCQb9/1ybYNNSclKVnhu+kdOVKOz1Br3Blhp/nUxOxfHv8S5XquTGKDLQYhaHZuQLWUalFyQ6UZpczWvBWTXB8dwgBGQVSosIBvVKUaVLKjlrklSINFcY1Hqono4vItbKOF+C3rK8cng/wd08qv7Vwz+l2+O971cFKG7fzWxKMtx8GDpyFIfvOpRquSTQbG+aGTikgdS2fExDx3L5p496i2LIleM1yXwOhcMXsL+brD8N78XbPyvPMlofgq5jFxSBd7S8wTp92mgOESGatiQyBpsMxxmPlK2QnVHCmn7o3u8nXM2/oNegDA== +sidebar_class_name: "get api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 URL of the user avatar' (get-user-avatar)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Retrieves the URL of the user avatar

+ + + + + +Retrieves the URL of the user avatar + +## Request + +

Path Parameters

+ +Expected response to a valid request + +
Schema
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/get-user-manager.api.mdx b/docs/api/nerm/v1/get-user-manager.api.mdx new file mode 100644 index 000000000..6b8c440f7 --- /dev/null +++ b/docs/api/nerm/v1/get-user-manager.api.mdx @@ -0,0 +1,47 @@ +--- +id: get-user-manager +sidebar_label: Find user-manager relationship by id +hide_title: true +hide_table_of_contents: true +api: eJyVVV1v2zYU/SuEnlbAX3GcrTOwhwxLBw9LWyTpXgJjuJaubLYSqZKUa0HQf9+5lN04ddoleYhF8l7ynHsOL9vEVuwoaGsWWTJP1hw+eHbXZGjNLhkkGfvU6UoCsLwwuVW5dYqUrzjVuU5Vjfhh2Scox0XczG90hexAa5/M7xOJUfsYnywHSUWOSg4ymt+3icEA2+sMOVoOqihsTk//Q9lchQ0ru/rIaVDB4sDgNG95oOoqo4BfoMu4wN7Id/y51o7BLLiaB4lPN1xSMm+T0FRyoke2WSMSpEoKmKnriIJ3VFaFhJxNZz9nr1fnQ0qnvw5nk7OL4euzi9kwY5rNzmf0y3lOSdct5TRfgTp7OWA6mcjPYwZXO1QtcKYOoUKB1JYKLXOfa/YBh6fWBDZB8qmqCp3Gmo4/etmkPWXRlwOJlRM5g+4hSNX/3Vf9/6NB+xl1cUzZO1M0fUW7QVI/nVdq8zebNVScn08xpN3x8HQXgfocBJ3sFRk9LxzxQYco5JGxh1OsyN8gmT2l0++UqZteDjVUtaFVEaVKrZgi8OglIlnD7/Jo828FOCBbmOiAvyS1G3w/7h+JisdcOWdxd7plT+LiKRIL4HOGCnXLbov7F3NAB1emdgYmtAbUNmSyAgPepRwz/YvI/dhTLEeeIrtUJXsPIVQ/v4J08V738ce379Y61yhv0Sw2EvUFqNQXZ6F1d5BQ1uy+ewkE6R3zZHxsfz9uddZh0cda9F2ndgXiNiFUfj4etyBMJrxFK+pGBqIBgW2YRxB9TJVG8pacFitEbg/hPcGc6kJ8R2nJqT1pXncxXEmnU+S9XosCYqnaB7BzQmcp+NLa6dBEgCsmx+6yFj73y+PlWxGgx3Ec9FUPIZXs+52M+yDM9B9vDpfkzn5iAxj4/1tja9d/xmuj0etlRylXT+FsNBlNjuz49urmWl2+X5xyhZSHRZWSUSuWZyLypTSF9gquU6XNdN4oqaqtvfREIMCq0kZFMGy2GlKX0FxMCRsyeqaA2j8Y14u7iLWyPkDpo5U3Ggd892lSq0bFdvYId/tg+5e/dH3dA+/CuCpIy0XuDdbuDXn/qB975MwBAZpuAF6W23ZFnj+4outkGt3HiQ2WD76Lpsi0l2/4PafC8w84/HSzf/5eqZc/nU8S2k+SaeJtKGoZ4fMTN/3zjYYEQuju8uIAbL9wmUpvOUo56Sni7a/X+M8rUfU/x1P3Nw== +sidebar_class_name: "get api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Find user-manager relationship by id' (get-user-manager)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Find user-manager relationship by id

+ + + + + +Info for a specific user-manager relationship + +## Request + +

Path Parameters

+ +Expected response to a valid request + +
Schema
    user_manager object
    = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/get-user-managers.api.mdx b/docs/api/nerm/v1/get-user-managers.api.mdx new file mode 100644 index 000000000..dc70b4aae --- /dev/null +++ b/docs/api/nerm/v1/get-user-managers.api.mdx @@ -0,0 +1,47 @@ +--- +id: get-user-managers +sidebar_label: Get user-manager relationships +hide_title: true +hide_table_of_contents: true +api: eJzNVktv2zgQ/isED3vyu3kgBoIii80WXjRNkaR7CYyAokY2W4lUScqxYOi/7wxly3LiOo/D7uaQROQM55uZbx4rbnKwwiujJzEf8xn4bw7sldBiBtbxDo/BSatyksD7u7lyDHScG6U9k0IzC94qWAArUK+b1Yp4moZH3VzljiXWZOyzSkCWMgVmLCtNEbQdCCvnLMGjA/qFU3rGcmFFBr6G5cXM8fE9Jy2WbeBOO7wlNb5fcY0fiPtnAbZENaVbH7uuXaSpeXQBSi5mSgf7TOiYOWM9AuihioWfhbKAoUpE6qDDnZxDJvh4xX2ZkyUTfQfpUTS3FFqvwNFtqjLlW2IYPkDIKAdLkeUpng0Hg6rDTZI4eEHyOAjaGE+3cg7zoGdtMS4tCA/xg/C8qloXDRw0ubV4PGgefarpfBkejAHy642DsMxTE+OxtwVUnSbWlJIHFR+O9t0c2OQPZhImQuZD3BOVYuJqL16OdOMwqmYIFC0Xwew2AFEkzmQSjbpnJ3LYPRIy6gp5etYVo+Hph9Hx6HR0ckwONtjXTPoP4e+gAS9i4cVhLDfgC6sdi4SXcyqUjRpTmnkEasHlWErwKliRMSkIHawkokh9I9qENeS7mtJr9cOB4aPBgP7sYrtc5kgWiBsMzBsM2UKkis7QIUdUkgZJrgPrRZ6nSobi63939Mjq1UUWmNc0g624sFaE6veQuZefwSy8gmVYIfG1TssN/3mxXy9T+jPomZ/z8YcRfopl+/P5K+vqeZkonTZbX8Mr7pUPZdFq8d1RuHloqPbuTnaod5Ft40W6/0rD0h9uZP3NyPkYrJ8PB7/Vts5PBvRCbmGhTOHe+8rRYCc+V5tgVOGnw4/2cft3EbObmsKsywotojTQWxqy56H3FmIbDddJmFhPo78BNdGhav4iVeoRv5L7m6SCmUtrDdZBNa2dON7nxATxWS1Sdgt2gX0s6KA7NjQVLFycgYWe4xhM8QOWEoKme5NzhwkFZPI5sgvsY84hR1l9HlFro3ZWy7cTe2usLXFMI4lDA3xEVOzRGsx/tUkh3Zn1ikMQBFUg7++2DOyHIQz17lBYJCyfe5+7cb+/Ql+F9l+wNVc9jflC46YE6GG++yJXqLwQVhELah424rVv62bKhcxAmucTJYgz6vxMOKdmFHxiU+E8OmbJkynhk4VVvgwAI9yewF4U5Mr9tH19S7GvcbSFmlSQU3zd/UPXD0J4Uv/z56Z13JkfgEOEfp/jzmbrf0OxKJ0YepHCVbsw7A16gxYTv1zeXLGLr5O903NzGdbAKKyPwV8hJaY97F2ZiVVSMooq1jaNEESAtzTXAhjQC4VZzjDdxEdkINCYGzcD9GpyF7DmxnlMcuvmE/gDG+dTxKst1/9HK3CdSo/ds5+nQlFbqDm7WtP7/slERILMMRJ0sVpFwsE3m1YVHdebBXEqVo4ovN0QDgTihR1oL8AfUO7siNjUCpIKPe3fMb6z5L3T/luWrkNQthveFsh020lCXWPWcEugvRzzU+tdSGrELa1nDZheaXrep0uqg38A+xfSaQ== +sidebar_class_name: "get api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 user-manager relationships' (get-user-managers)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get user-manager relationships

+ + + + + +This endpoint can retrieve user-manager relationships from Lifecycle or you can search for user-manager relationships using parameters + +## Request + +

Query Parameters

+ +Expected response to a valid request + +
Schema
    user_managers object[]
  • Array [
    • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
  • ]
    • _metadata object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/get-user-profile.api.mdx b/docs/api/nerm/v1/get-user-profile.api.mdx new file mode 100644 index 000000000..945906ca3 --- /dev/null +++ b/docs/api/nerm/v1/get-user-profile.api.mdx @@ -0,0 +1,47 @@ +--- +id: get-user-profile +sidebar_label: Find user-profile contributor relationship by id +hide_title: true +hide_table_of_contents: true +api: eJydVttu2zgQ/RWCT1vAtzjObtfAPqRoWnixvSBJ9yUwgrE0ttlKpMqLY0HQv+8MKTdKnW2T5iEROTPkOTNnhmmkqdCCV0YvcjmXG/SfHNqP1qxVgXIgc3SZVRU7kPmN0rkI5DCskofIjPZWrYI3Vlgs4kluqyqxqoXK6QAPGyfnN5KjRBfl5HIgK7BQokfL5kZqWtANMUbxXRX47RGAxWth1sJvUZjVZ8y88IauJQS4w4EIVQ6e/hKWHAs6m+Itfg3KIpHzNuBAumyLJch5I31d8Y2OovWGPNfGluBpJ4SIAvdQVgW7nExnv+cvV6dDyKZ/DmeTk7Phy5Oz2TBHmM1OZ/DH6Rpk2y75NldRAoghXTCdTPjPQwYX+4pwYy4OrkwBxA4KxXtfAzpPl3NeUXuOh6oqVBYzO/7s+JDmmEVKBwVSiqmiXiUInPXbLus/9ybaT8iLRcg/6KJOGW0HMjweVyr9D+oNVXF+OqUl7PvL41MY6lMQtBE2M3qqu8Zb8EmmT47pi/k2eR9HoQ4li9vcabRd1bpukMuWTvHKRwX1mmo4Janwz0DOHhPIK8jFZdKBGIqgYVVEjWSG1ehx9Bx1GI0f1rG/vq/8AdlCR+n9zaHt4P/9/mWveM2FtYaatl0mEmePkVgQPquhEFdod9T4MYboUK8Gq0n9RhO1Lei8oAXuM4yR7lnkfixm5CuPkZ2LEp2DDYq0v6JKxoGS/Pttf2WsrYUzNKW27HVHqMSdNVT69lBCtplucjIEHlpzOe73nRs3Km/J6GIu0rgLtiC/rfeVm4/HDREG7d/TDGxHmopGCEyNOKKij6FSFLwDq1gKkdu9eyK4hlCweCErMTNHU/M6ugsesQKcUxuuAEsqOE/sLNNZMr4sWOXrCHCFYNGeB+Zzs+ybr7gACUff6Vs9mJTsBi2vkxPtpI83h067Nl9QEwz6/Vdtgk2fkrOq9NrwiZyuROFkNBlNenJ8f3H5Tpx/XBxzpVIejCIDLVbIL1bkC1lGtRekOlGaXK1rwVk1wfEwJgRkFUqLCAb1TlGpS6o5i5JkiDSsGVT3Ur1bXEeslXG+BN2z/MIr+YBDc98Cv/TipjJ43PtxVYDivk56azp93jx4FxzFzCmSSrwlLmxumhU4/GSLtuVtGkaWVbG8l2HUSK4cf5P811A4/AGN3y67Z/iFeP4T/iihbhN0HZujCLyizy9Yp38jaD4RIXplSHsMNhnOMx41vZCjEcNS/9bVby+4yP8BqaMqjw== +sidebar_class_name: "get api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Find user-profile contributor relationship by id' (get-user-profile)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Find user-profile contributor relationship by id

+ + + + + +Find user-profile contributor relationship by id + +## Request + +

Path Parameters

+ +Expected response to a valid request + +
Schema
    user_profile object
    = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/get-user-profiles.api.mdx b/docs/api/nerm/v1/get-user-profiles.api.mdx new file mode 100644 index 000000000..c4dec9a70 --- /dev/null +++ b/docs/api/nerm/v1/get-user-profiles.api.mdx @@ -0,0 +1,47 @@ +--- +id: get-user-profiles +sidebar_label: Get user-profile contributor relationships +hide_title: true +hide_table_of_contents: true +api: eJy1V9tu4zYQ/RVCD32ybPkWJwaCIkXThYvuZpFk+xIEASWNbO7KpJakEhuG/r0zlC3LseNb2zwkkTjDOXM7M1p4KgPNrVByFHtDbwz2mwH9VatEpGC8hheDibTISALPP4FlOQr4WSnBIiWtFmFulWYaUneTmYiMVC0fG2/45JECy1ZXPje8jGs+BQuajheexAe8+2cOeo5qQtYeNs3fpKl6MyxBYxkfC+nMMS5jZpS2Qo6bqKLhZy40oDsJTw00PBNNYMq94cKz84wsqfA7RBZFERS6bwXCwtNUTIWtiQlpYQwa5WDGp1mK79pBUDQ8lSQGDkj2naCO8e1azmCs5Lgu5kUauIX4hVuvKGoHFRw0ubbYD6pL32saO3cXxgDZ3cpBmGWpivG11TkUjSrWlJIXEe+P9uME2Oh3phLGXdJd3DGJmLjSi8ORrhxG1SkCRcu5M7sOQBjyqygJO/7VRdT2ezwKfR4NrnzeaQ+6nX5n0Lnok4MVdgnocll0cNCHJX4skpXK/+NFt5sEg04c++1u2PN7bWj7l8ADv32RdHj/KuwPossNL5b9cNCBZStSIqxa4mbh/L/C3YPeZdDrYeD77djvDeIr/3IQYTJ4kAQJtLt9CDdw15v8xdnZX0MoQRlw9fMRWfwLz0DmU+IY9SZd/9VMENPU+qx2UPcHeYjH3PL9btyDzbU0LOQ2mqBltlJjQjKLfaLBZOgMHIU+VCoFLp2VhOeprUQrvK5fi2e6rbzYMVQnCOjPJrbbWYbNDnGFgcLJ2StPBb1Dh4xdRgakYy2eZamIXPhb3w1dsjiaJB1zVGS+Fudac8feFqbm8DVYhkfUKTJcfCfT+Yq/vHy33lTIv0CO7cQbdjv4yGf1x+1blux3EEHRqPfpMeLvyekYne2WOrXQif+tsK7Qa/Pb77jJ8FLV+NkjcN/QI9vK8nT3kYSZ3T8BWyDjTKHKr876dTv4pbR1fRGUGYBXoXJz7i29wKvH5/MqGIX7aXi9XU31G4/Zfdk7zGe55GHq+ipSZM9C85SOUhLuErfqvI/+CtRIunb9k1SJnD6S+5uknJlbrRXuT8Vz6UR/lxMjxKclT9kD6FckV6eD7mjHZsgYuDzlcoL7U4oPMIvAaZqTnNtfUEAmt5HdIIEaw8fAyvchcSrxaClfT+yD0nqO+x0WsWPeN0TF3rTC/BerFNKZWu6vBIFT63utTa5CInZhKJfOXGPBehNrMzNstRboK5f2C86EoikxX2hczQGamO8WzwQqv3ItqArKOqzES9+WLO7xaAqR2p6CTpzRyGHcGDGm4FM15caiYzSRiOsNRLkWdu4AhsA16JucXHl6rh8/UOxLHHWhKhXklLccO27cOCF8U/7zx4p/HtUPwOlFv6/nKtflv65ZhEwU3UjhKl1oN4NmUKvEL7f3n9nN19HOrXF1yCLcvEKg6e/85VGEaXcL+1TFIpkziir2Ns0uRICnNFAdGJCvArM8xXRTPWIFAs3XYTW5P48eHdZMGTvlsnZy0lfKBvrFuu5P/NYpQ2+R7VpZygW1cVlji2U5Pr0bnZjQCSKng8Ui5Aa+6bQo6HW5glANxMJQya1XiQ/BHtzVdwL8AfONjwEkoZykHAcdb/yIJXuP+e19/kwYH6/Ke6xv7OFnGj5ryd2DadeOfSa0UxbXPYhqW/IayPOaFB1FYUHjpkXfpli6pd5NRDOlprU1S+iWir4/3VJL/wMoXrcN +sidebar_class_name: "get api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 user-profile contributor relationships' (get-user-profiles)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get user-profile contributor relationships

+ + + + + +Get user-profile contributor relationships + +## Request + +

Query Parameters

+ +Expected response to a valid request + +
Schema
    user_profiles object[]
  • Array [
    • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
  • ]
    • _metadata object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/get-user-role.api.mdx b/docs/api/nerm/v1/get-user-role.api.mdx new file mode 100644 index 000000000..e7060cd42 --- /dev/null +++ b/docs/api/nerm/v1/get-user-role.api.mdx @@ -0,0 +1,47 @@ +--- +id: get-user-role +sidebar_label: Find user role pairing by id +hide_title: true +hide_table_of_contents: true +api: eJyVVdtuGzcQ/RWCTw2gm2W5TQX0wUGcQEWTFLaTF0MoRtxZickuueFF0WKx/94ZUrKVyk1sP1hLzgznnJnDYSdtgw6CtmZRyLlcY/jo0V3bCuVAFuiV0w1bybYwpRWldQKEb1DpUisRyVk48hYNaKfNmqICrL2c38l7m5fLgWzAQY0BHds6aWhBZ+qCAjSf3kDYnKZ8LWwpwgaFXX1GFUSwwmFwGrc4ELEpINAvQSqworMp3uHXqB0Sl+AiDqRXG6xBzjsZ2oYz+rCHSUxqCLQTY0KBO6ibil3OprNfi5er8yGo6e/D2eTsYvjy7GI2LBBms/MZ/HZeguz7JWfzjTWeGFKC6WTCP98zuNpRqQIW4uDKFEBsodK89zWiD5RcWRPQBI6Hpqm0Si0Zf/Z8SHfKIpeDAhvHDQw6Q+CS/8Ml/7krcX5CURxC8cFUbS5nP5Dx8bham7/QrKmF8/MpLWF3vDw9hXE+BQH5Mp2n+ZJz0CG18CDi4ZS2+W8gZ4+15xUU4jp3QQxFNLCqUoeUZS0EHD2nN9bghzKp+7+lP8BamNT4Pzm0H/y/3yf2SmmunLN0ZfplJnHxGIkF4XMGKnGDbkt3LsUQHbop0RnSnjVEbQOmqGiBO4Up0j+L3I/VhJzyFNmlqNF7WKPI+yvqW7rO2f/40t1Y51rhLc2IDXt9I1Tim7PU6P7QQrbZ/ZhiCDwy5nJ8r3o/7nTRk8WnQuRJE11FTpsQGj8fjztiCya8p/HTjwx1jNLbFnFEHR9Doyl4C06zDhKxB/fMroRYseJA1ajsycC6Te6Cp5sA7/Way896ij4QNcdcloxPRadDmwCuEBy6y8hk7pbH5huufsZx7HTfDCYl9zOO19mJdvLHm8P1uLVf0BAM+v9Ha6PLn+nCaBrqfCKXK1M4G01GkyMtvr+6ficu/16ccqU+HoxCgREr5Pcg8QWlqPGCJCdqW+iyFVxVGz3PQUJAVqGNSGDQbDX1uaaGsyJJg0hzkkHtH4l3i9uEtbE+1GCOLG80JTh5g8SqFWl6fYe3e9D605+yXOeAuzBuKtB8a7Ogur367h5mrqeAOeWlBm4IKdu6bgUeP7qq73mb5ozjni8fRJYUUGjP36TsEiqPPwD+y/X+fXshnv82PspmvwmmTdKvIq/o8wu2+X2m0UOEaIKTshhsNlwqniJHISfTg4V8f2HfXnEL/wXSv+T+ +sidebar_class_name: "get api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Find user role pairing by id' (get-user-role)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Find user role pairing by id

+ + + + + +Info for a specific user role pairing + +## Request + +

Path Parameters

+ +Expected response to a valid request + +
Schema
    user_role object
    = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/get-user-roles.api.mdx b/docs/api/nerm/v1/get-user-roles.api.mdx new file mode 100644 index 000000000..fc7726c69 --- /dev/null +++ b/docs/api/nerm/v1/get-user-roles.api.mdx @@ -0,0 +1,47 @@ +--- +id: get-user-roles +sidebar_label: Get user role pairings +hide_title: true +hide_table_of_contents: true +api: eJzFVttu4zYQ/RWCD33yLd5cEANBkaLpwsVmUyTZvgRGMKJGNnclUktSjg3D/94ZKpaVxHUuKNA8JBE5wzkzc+aykrZEB0FbM07lSE4xfPPorm2OXnZkil45XfI1Xd7OtBdo0tJqE4QCIxwGp3GOoiIl4UhLlKCdNlMvMmcL8UVnqJaKzq0TS1tFLY/g1ExkdLRDr/L0hz4dFBjQMYwAUy9Hd7KR9nLSkS2R0d1KGvogkD8rdEvS0ab18dSP8zy3Dz7aL2GqTXRfgEmFty6Q9R6pOPxZaYcUlAxyjx3p1QwLkKOVDMuSLdnkO6pAoqXjIAZNsOg214UOLTGKFU7RkRwuoChzOjsYDNYdabPM4yuSR1HQpXS6lfOBI9UWk8ohBEzvIcj1unXRwCGTW4tHg+bR55o+LOODKWJ5tXEQF2VuUzoOrsJ1p4k15+Nep/ujfTtDMf5d2ExAnW6Oe6ZzSlztxeuRbhwm1YKAkuUqmt0GIEngVGXJsHt6rA66h6CSLqiT0y4MD04+DY+GJ8PjI3awwc40ehf2yNL/DHsbCpEYUgiwH8s1hsoZLxIIasYlslET2ohAQB360hqPb4KVWHIHTLSSQZWHRrSJaUz2esKv1Q9Heg8HA/7zFNvFoiSmYNpgEMFSyOaQaz4jhzzzSFliuImUh7LMtYqV1//u+ZHVmyss0q5uA1tZcA5i3Qcs/OtvUArewC+qjfTK5MsN82W1W6/Q5guaaZjJ0achfcKi/fnylce6eZ0lnYanb2GUDDrEatj08O4wHt83DPtw99rXr9iwDZDvvjK4CPubV38zU36N1s8OBr/Uts6OB/xC6XCubeU/+srh4ElwLjfBWMefjjzcRenfIBXXNXNFV1QGkjyyWlm2F7D3Hj5bg1dZnFLPo78BNTaxWP5kVW4N/yb3N0tFMxfOWRp960ntxNEuJ8aEzxnIxQ26ObXeqEPuuNhLqF5p7lVmRqMvpw9cKIya/l3O7ScUssmXyM6pfXkPUxT1ecIdjbtYLd9O7I11bkmjmUgc+94DoRIPzlL+15sU8p19XGAYAnDtyX6rU1APjDGol4XKEVvlLITSj/r9FTkKJnyldrzuGUoWWbZLxB4luw+lJuU5OM0UqEnYiNeOPTZQCapAZV9OkSguuNsL8F5POfJMpcoH8sqxGxPGpyqnwzICTGhHQndesR93k/b1DQe+xtEWavLATsnHjh87fRSik/qfPzZN49b+QBoc/PuMNjNX/xsrRZvM8oscrtqFg96gN2jR8OvF9aU4/2u8c2JuLuOyl8TlMPoLSlHO46JV2FRnS8FRpcLmsUEI6JZnWQSDZq4pxQXlmslI9EMebaNmaF6ObyPW0vpQgGndfMawY698jnS1Jfj/uNjWKQvUIvtlDpprv+bm6pHDd+1pRyyYkbt8ulol4PGby9drPq5XBiZOqj3zdDv693j9ymK2E90PXD7Z/KhtVSwVu9bHjO/crPYY365uHzT+nlVqD47W3rYFMtn2ili5lDIa/7xqU3JqvXPFfbal9aK/8itNS/t8wUz/B27Utwg= +sidebar_class_name: "get api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 user role pairings' (get-user-roles)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get user role pairings

+ + + + + +This endpoint can retrieve user role pairings from Lifecycle or you can search for user role pairings using parameters + +## Request + +

Query Parameters

+ +Expected response to a valid request + +
Schema
    user_roles object[]
  • Array [
    • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
  • ]
    • _metadata object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/get-user.api.mdx b/docs/api/nerm/v1/get-user.api.mdx new file mode 100644 index 000000000..80c4ddf59 --- /dev/null +++ b/docs/api/nerm/v1/get-user.api.mdx @@ -0,0 +1,47 @@ +--- +id: get-user +sidebar_label: Find user by id +hide_title: true +hide_table_of_contents: true +api: eJydVttuGzcQ/RWCTw2giy3LbSqgDyriFCoap7CdvBiCMdqdlRjvkhteFC0W+++dISVbjhS1rh+sJTkcnjNzZshWmhoteGX0LJcTuUT/yaGVPZmjy6yqeYXmZ7owojBWgHA1ZqpQmQjJ0MPSycm95KGT856swUKFnkeT+1ZqGpAHlZOtYl81+NXhAe+EKYRfoTCLL5h54Y2w6K3CNfZEqHPw9EsAcizJN+23+DUoi4Ta24A96bIVViAnrfRNzSc62q2XZEm4K/A0E0JEgRuo6pJNzkfjn/O3i4s+ZKNf++Oz88v+2/PLcT9HGI8vxvDLRQGy6+Z8mquNduj4gNHZGf+8ZHC1ocB4zMXOlCmAWEOpeO5rQOfp8Mxoj9rzfqjrUmUx+MMvjp20hyxSOGhjbTlVXiUIMfj/akV0/0M8LEJudNmkSHY9GY7vq5T+C/WSsje5GNEQNvvDAy8p8d+7oQUiqMqTwJIFmSaLQ0vUoWLRXSMRLlSJW9VeI2QZOheHcxZZAaFkly8t2bXy5XF8zoMP7tSx08yrNYvwnXKwKEmEc9pXmqXSRz2W4PzDD5b3aLPI+15VuE3Kx/1wZsY8UlofmGBNOnsA//+d1RYLtFQ9DyXoZYDlsUg8B0ly0PojmuK/nhwfK4DfIRc3SeeiL4LmwHANZIarzePgNeo3Gj8WsX98r/AdpJmOpfUnb+16P7b7zFbxmCtrDTWlbp5IXB4jMSN8VkMpbtGu0Yq4h+hQLwpWU3UbTdRWoHPKusAN54J2uleRO120yEceIpuKioRNmRJpfkE5ig0z2e+3tVtjbSOcoS68YqtvhEp8syYmdZtCXjPbls8QuClP5DB28WGr8o4mXYxBauPBUsnKlfe1mwyHLREF7a+pxLuBpmTRyaZBHFCyh1Ar2rwGq1gCqZCezBOxXVVCVmFmDm6Du2guuIMIcE4tOfIspeA8sbJMY874smCVbyLABYJFOw3M436+v3zLgU849o2e8sCk5PYC4XEyopn08X5XUXfmETXBoP+/NSbY9BnrRNH9yB45XInC+eBscLYnw+urmw9i+vfskCulcLcoMtBigXy1Rr6pmQlSm6hMropGcFRNcHzJEAJaFUqLCAb1WlGKK8o1i5Hkh3QJMajtDfxhdhex1sb5CvTeyntFB3DmxaIR8Up4AbF9VvbJh0CKpseNH9YlKC7LJJt2K6/dI6EnJ3QKZWhFUHi6bRfg8JMtu46nqYdYTur8WUUxxfmu204KKB2egPnTzfZ18Ea8/mVxlMh2EnQTtV0GHtHnIzbpddPxFbCiRssXM4FNC9PYrfe2HHQGVupTMf5xxTn6B1NjSP8= +sidebar_class_name: "get api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Find user by id' (get-user)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Find user by id

+ + + + + +Info for a specific user + +## Request + +

Path Parameters

+ +Expected response to a valid request + +
Schema
    user object
    = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readonly":true}}>
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/get-users.api.mdx b/docs/api/nerm/v1/get-users.api.mdx new file mode 100644 index 000000000..c95d63684 --- /dev/null +++ b/docs/api/nerm/v1/get-users.api.mdx @@ -0,0 +1,47 @@ +--- +id: get-users +sidebar_label: Get users +hide_title: true +hide_table_of_contents: true +api: eJy1V91P4zgQ/1csP9xTaQu33EMldOrpuFVPfJyAvRdUITeZtF4SO2s7pVXV/31n7CQNEEIpdzzQ2B57vn8zs+E6ByOc1GoS8xGfg/tmwVje4zHYyMicjvDgbiEtAxXnWirHIqGYAWckLIEVdIElRmfsQiYQraMUmDZsrQtPaEGYaMES3AqkhZVqznJhRAYuMHNibvnonnsCPu3xxunofsMVLlCKHwWYNZJL1Vg8F3ScpvrJem65mEvldWNCxcxq45BxH68Y+FFIA6hxIlILPW6jBWSCjzbcrXPipGffIXJImhuykJNg6TSVmXQNMjQGzMEgHaxElqe4dzwcbntcJ4mFdyhPPaGJcXdHZ9Gqat4k45EB4SB+EI5vt42DWhxkueN4OqwffXnTurV/MAbIrysFYZWnOsZtZwrY9mpb+59OUwcbMSL09k5kig4L0r9v4VLRbYNlqtFh3TzvFiHgmKdlTlfhNVsfytVJl76jac3V0/4nXK0TrrDdbAMNW4q0+ISF0cWqyCi7xpGTS1J1okT1ea3YBQj/eQcmo4TBN6dNUfFVme5pIE97sIF6HLXMMForpk0xEA5ELJzoluQGXGGUZTPhogXhTHWNUbigmAZsrpWFveSaaZ2CUJ5LIorU1aR1Fvq02U7ptfCwB4qT4ZB+nst2vsoxYSCuZSBDCfKvpD1UyFJGRhqxQnnwEHmeyshj2OC7pUc2e2NVwNIdmTBGePB0kNn3r8u40z9FgQSktIi1StcVfPCi/R4G1gWouVvw0a8nuBSr5vLVK8Hlr/KnV4bFHoHTKynezoYrQIUxo4AqHu5fgYgisNYvpw2Pv6Ckpz1ktMlXpvU+SfintGKW+mTrldDX9mIqrHt447ihNoY4HDmZQemU66Y5I60f0a0PpGBeFoSDH8sNJGAwbR5SoeaFmLdZYmckTkY7OvFbD3UOH1xpu2orMdVOpO1HClatWu8K7aBqcH733M+Oh78EXme/DXnQfCn1G+7d45Uvw2eGuayMsfV/Pf6lDTT+EDG7CdjAjlihKGYINyJN/Bz0P4IYWsF14juql9avhJooD0d/01UC37fo/iUqz+bcGI1As50GJU7blJigfEaJlN2CWWKZ8HdQHePRGhERe7RCLbBNw4RgsKIwxZv2Q8p1BxQQy9eSjbFAWItBzML+jGoG1YlA33TsrTZmjW0kBrGvLE8oFXsy2sd76UI602UnTSIIgjg+KMqm2nr1Q09bGAxUvnAut6PBYIM6CuWuEPi2fYV+QqZ6DdBHPw9ELvHyUhhJ3g/xV5MHnSqsElEGkX5doD156NWEtXJORqcoKqxDhQxpMCX5osJIt/YCzrCEgxkXpML9tHl8SzYPcjSJaheQUrwsp76MeiLcCR9/VThzpx+Bmjj8f4bjggmfPkmkSjS9SOYKKhz3h/1hIwKvzm8u2fifSWszUh36CWTmmxOvb4B4Pw9kOpbJmpFVMaepJqMEeEqNghcG1FKidzN0M8UhRh5Q3zCqO5LLyZ2XNdfWZUI1Tr6CY0XbILXZhfP/PlMFXziEvUGeCkn5HIJuU8ZlY95aoAq0sdnMhIVvJt1uaTv0WBQMcVWtqgboTbW6xoJWmR5hvZs3fLOLSw8++zPtngs62FYzx2f5tk4GHXyrqeNAvp2jQQfbeuz4rL6tjX4H42qIOJDvR9r6DikaM8ROkOkOWj3QYTZgz0MDNMZ9uDf2jVPj1qtKRK/U4P/1nIDhJ51W/bo= +sidebar_class_name: "get api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 users' (get-users)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get users

+ + + + + +This endpoint can retrieve users from Lifecycle or you can search for users using parameters + +## Request + +

Query Parameters

+ +Expected response to a valid request + +
Schema
    users object[]
  • Array [
    • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readonly":true}}>
  • ]
    • _metadata object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/get-workflow-actions.api.mdx b/docs/api/nerm/v1/get-workflow-actions.api.mdx new file mode 100644 index 000000000..2cf891a07 --- /dev/null +++ b/docs/api/nerm/v1/get-workflow-actions.api.mdx @@ -0,0 +1,47 @@ +--- +id: get-workflow-actions +sidebar_label: Get Workflow Actions +hide_title: true +hide_table_of_contents: true +api: eJytV1lv4zYQ/iuEnuMz1yZAgaZtunDR3S2StH0IAmNEjSwmEqklKTuG4f/eGUry2isn6xTJgyORc3xzj1aRKdGCV0ZPkugymqH/19inNDeLK8mnLjqKEnTSqpJfieQuU06gTkqjtBcStLDorcI5ikXDKmDD62Hmosv7qHP1cBSVYKFAj5YpVpGmF5LfUk5VQvyKVX6t0C47QFqgYvKbSI0VqcpJltIzorT4tVIWyaQUcodHkZMZFhBdriK/LFmN8w0psRbg6aSqgkZ8hqLMmSSO4UKm8bh3cSZHvROQcQ/k+UUPxqPz4/Hp+Hx8dhqt1w+szpVkFDpWMB4O+d8u2OvnEqXHRLSkwhsBYg654jOy0HlSLo32qD3zQ1nmSobQDB4dC1l1rTDxI4klxtJyIL2qIWx82Hr7cA7ywQFO+uZfbyvspshWLviskxgixtzomSMf9Hc8fnycDs/HSdIbHccnvZMRjnofEIa90Vk6htOL+PRcfojW36nrou1Evwtv60SYdB/IXWQ3tUhBUbGGoiZSawoB2hCnFZWjH0pBEDNrqpIl8pETC+UzOnUUfJUqKazJsc8WlDDDd/M1C9vrZ5eZKuf80gna/+dqSJJpk59op+CmZqHRbuGODdkEOpRnClXu9+Oc1E7eiGqxxeTTJKHCABcIgvg2JORrqupQK0QnLQKV0I4drIpQUlWofAqefBhX/u2efTFPNiKF84bFBFxBHeOmanah+fwwgQ71d2NJLRq3KxesheU+1Mpj4V611+Oz79RNsG/HEjzMlvvo0WQ6MfjzjLn70hR0/Qgad88eSKPGxdR58NUBAA8KCAkUtcAN1tv69dcM9OwHUeChNscjMdHQPH3R4k8EfrpDWyjNGRby3sqMCJLXM30vzMnefiJobLZCuVdQ69jBFkSRYvekyhJiPnpHzRupr6lu3O+mFL2iGUPvg6CVTL2wkf0yDgLilQ/h2t1FaNby31F0sm/C/gKJuKm7i+iJSgdjqXGQPhLusf+W8Wo0fknDVvL92GyhTXSY3X8w6/roZbp/mCqoubbW0KqzfqiNON1nxITwWU3j5RbtnPpg4CFzaMWqrObE0WQaJXqS0ws+Swyc7k3Gvb4JIKvsIrsSBXUIHjT1ebzphYF+u8hujbVL4QztdhlTLTjcC0sTv4kgWc93ptk4GQL4jF4GncWF6iF4ol4RK5sTVeZ96S4HgxWZC9p/pr1x3dcUMtJvlojcfAZQKmKeg1WcCHX32ZDX5jV5HIEsUJruohvIBa+lNJycmrH/OaEqGgUFzcB12P0cysoqvwwAYwSL9qpia+4ftq9v2f01jm2iTTTYqKjZU0PBBSI6qR9+bzvlnXlCTTDo96elqWz9GLFPlU4NS2R31SaM+sP+cCsZP1/ffBJXf032LPUo2suw09O4pQ0m2AtS8pSjnBOFSVS6FOxVQx2XCpoQ0K1QWgQwqOeKAs0FzilJSYi06zKoZrv/NLkLWEvjfAF66+YjerFZ6V/4+Fh9S/K3fofUXuY5MyhzUFy0dTqtmuS7727NFL6McPLdahWDw79tvl7zcf1FwhFPlOMEe2FkbQN+7XtlL7wnXHa+h6jpVEwZcW612R1yjbAiJLyaEaqa9Upyf9ji6vQFlrIpxY/XHJv/AHLW5cw= +sidebar_class_name: "get api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 Actions' (get-workflow-actions)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get Workflow Actions

+ + + + + +This endpoint can retrieve workflow actions + +## Request + +

Query Parameters

+ +Expected response to a valid request + +
Schema
    workflow_actions object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/get-workflow-session-upload.api.mdx b/docs/api/nerm/v1/get-workflow-session-upload.api.mdx new file mode 100644 index 000000000..17b9f950b --- /dev/null +++ b/docs/api/nerm/v1/get-workflow-session-upload.api.mdx @@ -0,0 +1,47 @@ +--- +id: get-workflow-session-upload +sidebar_label: Retrieves the URL of an attachment attribute value from a workflow session +hide_title: true +hide_table_of_contents: true +api: eJy9VttuGzcQ/RWCTw2gm225TQXkwUHcQkWTFLKdPARCMNqdlRjvkhteZC8W+++dISVZjlS3DoL6wd4lZ5bnzJw5dCtNjRa8Mnqay4lcov9o7G1RmrsrdI6Wb+rSQC57MkeXWVVzKAXO0FuFa3TCr1DczP4UphCgBXgP2apC7fnRqkXwKNZQBhSFNZUAcbf5vnDpAPq0h6WTk0/y2y0n5z1Zg4UKPVoOaaWmFzpfMSTFSGrwqwN40zeMh6GZxRfMvPBG2A3kngh1Dp7+GityLOnblG/xa1AWqQjeBuxJl62wAjlppW9qPtFRtl5SZGFsBZ5WQogo8B6quuSQk9Pxz/nLxVkfstNf++PRyXn/5cn5uJ8jjMdnY/jlrADZdb0di12JPv8Ln2tiovItp2NF/n8pzPk0V1OL0PEBp6MR/3kM+vK+ptJjLrah3AVgNShe+xrQeTo8M9oTFc6Hui5VFuU4/OL4I+0hi9RRSqwti9erBCHY8mmqtM+oIX+vyybViHohvfKR+Q3tdx2vjI+ReQ25mCXMoi+ChkUZ+WSGK+dx8BwmRuP7Isr5W05bNFMdy/QHp7Jg/inuA0fFYy6tNTQj3TyROD9GYkr4rIZSXKFdoxUxh+jQaASrqVNGE7UV6LykF7zPMGa6Z5F7uk3IRx4iuxAVzTwsUaT1BXUvaj3F70v0yljbCGfIFFYcdcdzcGcNtbtLPz3Je2ZjaAyBZ2oih1uD+bw1mGGr8m4YoscN2/1x7CjNxSol34nykivvazcZDlsqBWj/jsa4G2hqJ2EzDeKA5DCEWlHyGqxikUTWD+GJegGhZFFCVmFmDsc9hgt2CQGEdMm9YbEF54m3ZaJzxpcFq3wTAS4QLNqLwEw/zfe3r7g1Ccd+0K5TTEpu7ILfUxCtpIffthN0bW5REwz6/aoxwaZHNjRyrsLwF7lcicLJYDQY7Qn13eXsrbj4a3rU2rabIqMrZIEiuMQXsowaRfdKLiqTq6IRXFUTHFsKIaBdobSIYFCvFYmAXZHlSgJFshwGtTHbt9PriLU2zleg93Z+6GX2iF37MDY/+MpMrfN474d1CYpdYmuBSe0P1+lO7ZQ3iX4ftpf65NENRJpZUXE4t20X4JA8set4mXzPsszmD7qOosuV42eatAJKh0+w/2m2uZ1eiOdfzkfZbhZBN3HaqF70Ro+32KR/ENg3vwvgf7ptvwPTo2KTUVO56TqiUeNSppCLjD13L/nAa3myd/b2+yVr+m9e6WD4 +sidebar_class_name: "get api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 URL of an attachment attribute value from a workflow session' (get-workflow-session-upload)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Retrieves the URL of an attachment attribute value from a workflow session

+ + + + + +Retrieves the URL of an attachment attribute value from a workflow session + +## Request + +

Path Parameters

+ +Expected response to a valid request + +
Schema
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/get-workflow-session.api.mdx b/docs/api/nerm/v1/get-workflow-session.api.mdx new file mode 100644 index 000000000..61d9f3fb3 --- /dev/null +++ b/docs/api/nerm/v1/get-workflow-session.api.mdx @@ -0,0 +1,47 @@ +--- +id: get-workflow-session +sidebar_label: Find workflow session by id +hide_title: true +hide_table_of_contents: true +api: eJylV1tv2zYU/iuEnjbAie3E6cXAHlws3TKsFzTJ9lAEAi0d22xlUiUpJ4ah/77vkJYt2WmbYHmIxcNzyO/cDzeJKclKr4y+ypNxMif/r7FfZ4W5vybnQE56SU4us6pkJrC8VToX91sm4SKXmK6FysHr5dwl48/JIYNL7npJKa1ckifLLJtEY4EDg5zio0vpF0f3Xf0uzEz4BQkz/UKZF94IS94qWlFPVGUuPX6NFTkVOBvylr5VyhL08baiXuKyBS1lMt4kfl3yjQ7Seg7OmbFL6UGpqoCCHuSyLJhleDZ6kb+anp/I7Oz1yWgwvDh5NbwYneQkR6PzkXx5PpNJXd/xba6EfuT4grPBgH+6Glw+lMBNuWhYWQUpVrJQTPtWkfO4PDPak/YsL8uyUFlwS/+L40M2x1pEc0CwtOxEryKExvLp1vI/l4DqT7CNJZl/0MU6WrXuJdXjckul/yY9hyfH52dYyof28uiUHdynoKijc2Evss8XiKzHIqSrJcfsrSOL5XuCeWaqoN1aZhlsGZZ3dbAebz8JwGE03yCOt/KIaeWOM+leFYWYUtjAiVj7xalgm4lJDIspZHGLuA2xvzvBJR1srgVOWivXnGWelu5JVvsuave/Yb+RPlt0UTsvffUosMY3slTp1pMIbM1BjCSxZkVsYwkMcx0/PXQEbj1PvUlxsPVpcxe2J7c3f55c30xubq+H3eVZd3neXY66y4vu8kV3+bK7fNVdvmaUFcC1UE/ZJmlmuPr4QEG2Z2zIFCZL8yrWA+QrdgrjIkub3VQWbkhl3l7RAypKm4A0QH7KUCYbWiyhHKm7W2BqZ4po25mE18NHVSAA4rfSK+VDfWq8UeSyTNkhKg8cmtjcmkEApVkTpRmSP6LtkOP9kezVTIXPErhZ++hkWbRJwWzLeG1D7Op/SN3Z4XCjbY/DvZ1ddhuMP7bEhrS1yQEYtkVrGdXKDmWbVHXoW1lbfN8S9pSVCvZsCDFh0mwh9Zw6dIPGx0dnlFe2vYWMms9DQWsoewWZHVYNGdfACgG4C8n9htsCptgUvuw/Y52N34w3fDqDuDjI3JCVgNnKy45CQe5Yk0q3U+ZeqpDl8FTrnF07aU66a3f1fcbUoVJYNa08ucdaJAJJscNk8bHTLLsFqm6djj3EWbo7Ng0NMmimMsF7nGOw+BHLYNgfXvTPBmeDlv2jlY94P26bx3sentBeq8IrXJ8+Q6x3TZg1ctGh3SyU7ZK2I0k4BjXoOwdzVzwC8xy5Bs2eEKHsD65rmNkrH1x4OJ7W4a+XjB6bvN7IXHyKsSdORKVDD8Lw1cTB6XPGLqPpwywMroex0mC70mGm+4tF6973+f5hrnDNpbUG03B9F5W4eEyJK+CziENxTXYFmwQZqIMhuLLIBYHuW2mEe47aLOghoyDpnqXcjydE4iuPkU3EEl6QcxKRPuXGz5N65G9n3rWxdi2cwfi/COMBUIl7aziHGhfyntm+QhgCvwbGSf9woHX9jcprLhHBHvEtUdkCvAvvSzfu9zdQWmrP0VOfotk0veYUju9jlIDwSlrF4RCTescelZxJRDLPTdkSwXk8xAV2we8X0VSkEFYVqtYSNbYOLwNHGTqJXweAU5KW7KRinT7ftbev2QkRR5tp5xNWKtm+YngdmXhoCB9vm9HtxnwlDRj4/9saPSx+JmxZpWeGT2RzRRWGp4PTQSsk319+eicmH68eHVibTZFJzTNe5aK+cS4WiDyxNLmarQVb1VSOXzpAgF2htAhgCBMD3M2dkgMToUh4CTGo7TPw3dVNwFoa55dSt3Z+/OLswN3sI/5nD9VoXC7L/bKQijM2RtFmG3mfj55SPH2NVegpC6Bkls1mKh3d2qKumYxSY9nfd/sAC97PleNvBPdMFo5+gPqXT9vX66/i+S/fR5Vq3gB6HcK+qHiFz6+0jq/vmh81CzzMEFUMNm5MMi4kLZGjAsJBvMvZPy7Zff8BJ4G82A== +sidebar_class_name: "get api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Find workflow session by id' (get-workflow-session)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Find workflow session by id

+ + + + + +Find workflow session by id + +## Request + +

Path Parameters

+ +Expected response to a valid request + +
Schema
    workflow_session object
    = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
    attributes object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/get-workflow-sessions.api.mdx b/docs/api/nerm/v1/get-workflow-sessions.api.mdx new file mode 100644 index 000000000..478ce92dd --- /dev/null +++ b/docs/api/nerm/v1/get-workflow-sessions.api.mdx @@ -0,0 +1,47 @@ +--- +id: get-workflow-sessions +sidebar_label: Get workflow sessions +hide_title: true +hide_table_of_contents: true +api: eJytWVtv47YS/iuEHs6TE1/W3mwCLA5SdNuTg7MXNMnpwyIQaIm22ciUSlJJDMP/vTNDiSJ9i7PtPmTF4XA4M5zLR3qdlJXQ3MpS3eTJVTIX9vdSP86K8vlWGANkk/SSXJhMywq5gOdXYdlzw8RMx2X53CRX35PduYdeUnHNl8IKjSzrRMEARP1ZC72CpVIFg3i36wJEGTYrNav4XCrSlXGVM1NqK9X8HJZo8WcttQALZrwwopeYbCGWPLlaJ3ZV4U7l9A+RWWCtNFpspTA4W8iltAGbVFbMhQY+8cKXVQG04WCw6SXlbGbEK5wTYtQ5UDs+YzUoGbIlmRbcijzlNtlsggmvDmzZ7TgZeKHbK41dkcBciOpra6B4qYoyB7LVtdj0vK/B8JksRCrz4w7/5vjYzc/Mlgw+4dDYdHWSl72xcFxLUPIqqWvarzN+LMYfBuPx8Gw8GeZn44v88uzDRTY6u+SD2WAmhu8mYorGeb3r1xT+fSveGKygeHG6O4XeoPtSqv8JNbeL5OrdCIb8pRuGirVx/qpHvYLg0r+h12GfTqf8MptNwYnvM3Asz6ZnPLu4POOj4cW70WR0MXo/iXyKuwoDSryq+28t5z+qfKiLsdzW5rgWPgp3Cg/zy9+gjFD1kioVl1hBGIhp5aIeuVBW2hWDjIFUgPmsREdD4sGsEsiTFaVxsiqhcuRpXNoogi7Lg1legbAnXgDJfUazqrRyJjMqbbgFDSMOLZ4kbew+ojmwau4qkbElOAD1zkReaxEwOTexbMHVXBBrMA6l1VUOJYa0UEyA3eVKiIaab5ObehQsJ4ozQwusSLEb4Mzmagn+RUfQgOZzMeN1gcQZh9qDpFqxgIHXUIuCcZHzCu18gsMKN0B6MJzVBYRO0WzY+eKgm7Ky1tRfcpTaLI8NbDi8n+IlW2ypeLFACdj8um2BEOBLbG+hTL+6ZW6KOER/4ar9vtVTbrNFFLTNMtOscy5V5lmgHyhamx7e7hPSuLVw4JQocAgQONqG6UIEEBOQWi0hAbNHrwhpG+mUYQ5HWQQdj8F+Wk5rWiDVk7Su5ZsmajI3epRV5eyoZJt8nqeVgPIwvKThU3eMeV0VmGngCy1MWbhENCWE05YQUp6CCKpetyxQdqdQNIWBRPpC1abYQ1j0AApxiAP+WvG1tVaG0YHiju0yJuHEFwJNqOCQxEnlb1qWheAqSLeW1XcSggybB5TmBBNIGg0G+F+s26eXiiLJ64DBwRnUOJkHxTArAScpAk5Q+IqmyPX/MChkfTJO873WY8puCdeaE4iEMDWvi4L2c0JzhTKWf1XFqoVRBEPeCBb2SAkxw+tdshc36rctcKyHm9+9oZ7xRTTZ6sc8w7yk4cOmF+LGE/wWB8kdxGhbDOxCmt32/Qz1lU0FTWCEP0u7OGfoM3bt4gUSl1Lwngqnl2CSSLdTAuKw1w5qbf622j9RMY60biDLkbOBmpY2J5m2Na2DDWFf9LU5tWVKpTgNCvH1/d1/zm7vru/ub4fxcBQP38XDcTycxMP38fAiHn6Ih5dN904DramepWEzaIttCi5Lo2LrC2rE3nRX13MP9dp0T0tNff/tdkmDTuDxR9j7uy7UngbijDTAHw4VKlSiwUZph40icoiktmFeGsBETwohU0uM7d+mbqOGdJ8/tue2cUkaILmWtBdOpTHmSrfAbEtuU9Ujl3ai6xUdpQG7LcElTOrBa0dHIJfuAXJpB4pbSmdgBDwatSgA0wCqtAUgDSBTgGhDkB9gcgQS25nbAKQ0xkydQblH7pEltQpTprmqpHBSgRzfTjzIiN4ZfMZsAky0t0VCIEk8MF58i5plXKDixwoLcZZ6sSk1SLJMZgznMMfA4zssg2F/OOmPBqNB4H/n5R3e9jHiC8ImaK+AWiRsn75hWe9WAAjJWUS7W0gdkxqsQmKgBh0QjF1xR5m3rGu16QhOlU7wBl92AFbSEW49xtGrT+rB4w8/bx170MLdSws1aO+UwoM9+rrVh3yrSljyb9r943DwL7fXx/cD17MhXcoD/e8EKeNBEnroc+uMDf3rJeN9aPUnnrPmKYOdsVpRewbA2qbI+VugaqnE1xk9Y257v1XqRhEO/i8uRdR/iO//yEXbfNK61IAOHpwRk31G3IB+GlKU3Qr9BOFCa8AcTdcEgOJ4vVRQCXJoW3B3zAStNG8y7nhACdxyV7NruJkYw+eCOfqULosAoxx/eLC3pdYrZkoIYrrSPINW7FmXWF7aI8S5snmORhU44umkv3sJgMJJrnCPyrWGoE0W1lbmqt9fg71cWcypzTm04LYDn8OZ9wFgweInriVGgotFz+7sa65IcOFcQsruQltiZ3if8w8TFFE11PIlJgtdpIzIoL/aFSk4FVwLfV2jOd8fwulb9L/TI2Tyx4FGJc2dju5yxIRQij5+aQHtXfko4GqIfz+uoLO7T0oYqWYlSkR3OROG54PzQRCNXz799pldf7vZC+PbSZZxhci3Ns5ed1ugB/llmcvZiqFXIb/pfl1rmMXbKikjAEfBSSN+wJiEKBR4eb3y1+LPN3eka1Uau+QqmDn0o0Ok6LoL88O/UjiHYoPqVwWXmKAuctZNoH3fc9uEo1qATji5Xk+5Efe62GyQ7G7ueLr+laG9Vh/U7fAT+17tHsVq+/0eykuNjFRdTt/4pKfyIzrU/8jme16Sj+wZP7P/4N5Hn7GPbL71UP6Du5/yfH1ECc/zw8af/ox0RI3gzapT5KGrolTTIE8Epx+rICPcuusMG1GwaqcBoRRf83/9hDXgL8SoB6c= +sidebar_class_name: "get api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 sessions' (get-workflow-sessions)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get workflow sessions

+ + + + + +Get workflow sessions + +## Request + +

Query Parameters

+ +Expected response to a valid request + +
Schema
    workflow_sessions object[]
  • Array [
    • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
    attributes object
  • ]
    • _metadata object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/nerm-api.info.mdx b/docs/api/nerm/v1/nerm-api.info.mdx new file mode 100644 index 000000000..d1e29efb8 --- /dev/null +++ b/docs/api/nerm/v1/nerm-api.info.mdx @@ -0,0 +1,24 @@ +--- +id: nerm-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 'NERM API' (nerm-api)" +--- + +import ApiLogo from "@theme/ApiLogo"; +import SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; +import Export from "@theme/ApiExplorer/Export"; + +Version: 1.0.0 + + + +

NERM API

+ + + +The NERM API can be used to access and modify various resources in your environment. + +

Authentication

Security Scheme Type:http
HTTP Authorization Scheme:bearer
Bearer format:Token token=your token

License

\ No newline at end of file diff --git a/docs/api/nerm/v1/patch-advanced-search.api.mdx b/docs/api/nerm/v1/patch-advanced-search.api.mdx new file mode 100644 index 000000000..3933b1289 --- /dev/null +++ b/docs/api/nerm/v1/patch-advanced-search.api.mdx @@ -0,0 +1,39 @@ +--- +id: patch-advanced-search +sidebar_label: Update a saved advanced search query +hide_title: true +hide_table_of_contents: true +api: eJzNV21v4kYQ/isrf2olCAQIySGlFb0XNVLvEiXcpxShwR7DXuxd3+6ai4X4753xGnACTUiaqiUSwZ6Z3ZnZ55mZXQY6QwNOanURBYMgAxfOh9ECVIjRDYIJ50EjiNCGRmasRTpfswgcChAWFhgJqLSFLdXF9xxNQUYOZjYY3AaP5MG4QbsYSNGhYYVloOiB1pURWUnlvdjd9uKD0LFwcxR6+g1DJ5wWBp2RuMCGyEunGkIbEWFCa5O9we+5NEhxOZNjI7DhHFMIBsvAFRnvaMlazUgz1iYFR2/yvPQC7yHNElY57vT60dm024Sw867Zax+fNM+OT3rNCKHX6/bgtBtDsFqN/W5o3W86KniLx5uHWjlUjkWQZYkMy6S3vlkObrnrmw+SfMkMH5GTaEvbKpuTKpvPGlA8zwa8agQJTDHZ1VyVjkeSfZ2YPEE7AUeiae788pU6GAN86NJh6v1UxWVcnu5j95x0ZWavjI5lgiMSX9PCzS5t9qz2jQOX28P1h2tn2eSmjOkVhh8IWq8wu4ieMbqW9m4dy3i1Wm0lDynI8vLDKLOZVtYnv9Nu87+HPPl4n9EuxLe1KhMFxAISye9KkAb/bzxymBBdqqTw7KG48/12qVR/oJpRuRh0O/QI9/XHnVX+c5S/DOOvRPir8P0KdB+E7aeRXeGa5NQP5nrTghg23AQGQesRwlpLGa1IbNEs1g0kN3Sowdy5zA5arSXhGpT7Ql1ldaS0QirlukA8CnXagkyS8QKMhGlSHe5G3ZMphjxhKEKYYqh3+tCoVBfctARYK2eKuEYUC3PrdIqGQxqzf2FupCtKB6fkOpphzhHdjuviG+aZ96OutMkrBxVUrYufvRK98T8+rXkz0neoyA36Pi90bvzPgDPLlL7eNqeP6962l7xMs4B62tlJ3O81T06PT5u9k36nOe3GYbMTvut3434fYugHGzZt2fgUibYceUwJtktpJJDk58SPI9qQ3vl5eVJJjoe7NKGzckZT1mNILNYAukuug/Ydhk4u8JCVH5DjQTI8NyaV+gjv3SeJSbQx2Kf8knM4IIwbQqbwD28YCteNN4uCGEHmYIotbP5un32q/zxhv9TyNdJRWem3O60lELuSf45bWk3Qbb9hYtdgpUk2dP8yTqQKkzzCX9+SbJvi/5bc3j2LS+oAkCS82x53xlz8pIo11zXuFb5+Hx+1j9q1RvXl4/VnMby62C30dNVYC0UISkxR5NYXewhDtFaAikSqIxkXgluKzi1PXVR+SSqkEmUlRrWQRquUpq0jrpoyRJrK2Knq4vP5YlQW6kxbl4KqSQ68aj3we7kd7Q6+qvlTc1SZWlkCdAfjicuUk5Jvw7c7vaIRDAh71Mnm5DUrLJdTsPjVJKsVv/ZrU7fbdtuyCUTS8u+oOqUnnP/purpC/SxefvfbG9J6jFNFDX308w4Lf/8kzFBANDUSxdlZL3jvXWpyx6oZ7ozNTABvMSR4ZO5J3XFt5Lkajt7/zj29ujsSpNjIwA8ehel7EPxJf/SgyzyV40L5fklNWM1ymLG+X5g/fwEZmGkS +sidebar_class_name: "patch api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 saved advanced search query' (patch-advanced-search)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Update a saved advanced search query

+ + + + + +Update a saved advanced search query + +## Request + +

Path Parameters

Body

required
    advanced_search object
    condition_rules_attributes object[]
  • Array [
    • anyOf`, `<`, `start_with?`, `end_with?`, `include?`]"} schema={{"type":"string","required":true,"enum":["==","!=",">","<","start_with?","end_with?","include?"]}}>`, `<`, `after`, `before`]"} schema={{"type":"string","enum":[">","<","after","before"]}}>`]"} schema={{"type":"string","required":true,"enum":["Today",""]}}>`, `<`]"} schema={{"type":"string","enum":["==",">","<"]}}>
  • ]
+ +Expected response to a valid request + +
Schema
    advanced_search object
    = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
    condition_rules_attributes object[]
  • Array [
    • anyOf= 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>= 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>= 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>`, `<`, `start_with?`, `end_with?`, `include?`]"} schema={{"type":"string","required":true,"enum":["==","!=",">","<","start_with?","end_with?","include?"]}}>= 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>`, `<`, `after`, `before`]"} schema={{"type":"string","enum":[">","<","after","before"]}}>`]"} schema={{"type":"string","required":true,"enum":["Today",""]}}>= 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>= 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>`, `<`]"} schema={{"type":"string","enum":["==",">","<"]}}>
  • ]
\ No newline at end of file diff --git a/docs/api/nerm/v1/patch-attribute-option.api.mdx b/docs/api/nerm/v1/patch-attribute-option.api.mdx new file mode 100644 index 000000000..fb3b55c58 --- /dev/null +++ b/docs/api/nerm/v1/patch-attribute-option.api.mdx @@ -0,0 +1,47 @@ +--- +id: patch-attribute-option +sidebar_label: Update a option based attribute value by id +hide_title: true +hide_table_of_contents: true +api: eJzFVt9v2zYQ/lcIPm2AFSf+ldTAHtwuwzysTZGke8mM4iydbLYyqZGUE0HQ/7470o7d2M3ml80GbJG8I+/u++4TG2lKtOCV0dNMjmUJPl1OvLdqXnm8KXlBdmSGLrUqjsbyU5mBRwHChBkxB4eZgK2XWENRoZjXQmXk62Hh5PhB7tajm5OzDp1nYYUeLZs0UtOADgh+Ssd4lgfnT38WJhd+STvNv2DqhTfCIu2Oa+yIKkTXEcaKDAvam/wt/lUpi5ShtxV2pEuXuAI5bqSvSz7RkbdekGVu7Ao8zVRViAKfYFUWbHLRG4yyq3k/gbT3JhmcXwyTq4vhIMkQBoP+AC77Oci2ncXT0Pm3Jqv5iJeHp0Z71J6XoCwLlYbyd784Tq45jC0mSbGUlsHyCh2vavz8XNLPZlObk5wowX+sQNuRB3tvTFta88qH4rykTBs+XApXEtTx8N75Of99C+b1U0mBEn+2powmMIcUz4VKyv+3aP+mTpwqZDe6qCPMlHt13G+l9O+oF8Trcb9HQ3jaHx7s8h8hlvSeMRscg+ktZOI2oiESUWmYFwGp1HB7eDw7BSOj8SYPDf+y8NvopjoQ4Dd2bTvft/uDrcIx19YaUpF2FpMYHktiSvFZDYW4Q7tGK4IPpUPiUVlNHCQxq/QSdFbQAJ9SjEp1UnKvcwn5yMPIJmKFzsECRZyfE1xB4aL9vg7dGWtr4QzJ5pKtHikq8WhNwHcDIa+ZZz3nIFhHx7J7hP+u26isJRsXihKFuLIFmS+9L924220oc9D+A6lze6YJPQrF1IhnhH4XSkXOa7CKORGS3JnHTHOoCuYnpCtMzYGe3wdzweIvwDm1YCiYW5XzlKblvGYcX1pZ5esQ4BzBop1UnNbDbH/5jpGIcewbPQPDScnNK4DH0Yhm4sMv22a6N19RUxj0+1NtKhsfQw8x6Lc7kb/eYvNdfTloYkkvi6thPhokw8uLy2QwHPWSeT9Pk176ZtTPRyPIYSR3nbzfwUrnhjdlsOLixdn52fleV3y4vn0vJh+nh5UmRm0XRQr06kZRuVhtSFOioCDyi5XJVF4LxtRUjpWZ8qdVobQIpUC9VsS4FVGPe4O6AUm5Q6bxDf5+eh9iLY3zK9B7K6ddHr4Jv9k14al3kAi9xyffLQtQLCqR482mNR6OQefIdUwbELuWlAhbNQ2f9MkWbcvTxAHLhJztOiDQM1OOnwnpHAqHryTyw+3mevCjOP1eczSvzSToOvQl1YFG9PgV63i3Io2khOhFQ7TnYOPCuxhScs/uO8cDsWM5jh6TlAXyVdvZnhZ9nNy/+5X7bHMvIpaxk4VHfnvS71j+Sd9n1ocWDvONLEAvKpJHsokb8+dvLue4GQ== +sidebar_class_name: "patch api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 option based attribute value by id' (patch-attribute-option)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Update a option based attribute value by id

+ + + + + +Update a option based attribute value by id + +## Request + +

Path Parameters

Body

required
    ne_attribute_option object
+ +Expected response to a valid request + +
Schema
    ne_attribute_option object
    = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/patch-attribute-options.api.mdx b/docs/api/nerm/v1/patch-attribute-options.api.mdx new file mode 100644 index 000000000..a315e23c4 --- /dev/null +++ b/docs/api/nerm/v1/patch-attribute-options.api.mdx @@ -0,0 +1,47 @@ +--- +id: patch-attribute-options +sidebar_label: Update multiple option based attribute values +hide_title: true +hide_table_of_contents: true +api: eJytVdtuGzkM/RVBz76kubi7BvrgFFmsC/SCxN2X1ChoDcdWOyPN6pLEGPjfS0q+JXHSBKgN2CPxUDokDzmttA06CNqacSGHsoGgFqMQnJ7FgJ8bNnjZkQV65XRaEuprU0BAUccq6KZCYZNBzMBjIWDjLW6gisjeAeZeDq/lzmTXJ0870uH/hArntljKYZuW2iGRCS5iRyprAprAJmiaSqtEtv/DM5NWerXAGvgpLBskbnb2A1WgSxvHoQVNDMhq8Pv29u+b23de4BwsyUkHrP3vT9PFHsbTsWZOmNK6GoipjJEAq879S1/oY9dJfghdkS3oUPHWwwJ1j8mcPpxO39BW5nl8dMR/96t3cddQTFSpDVQEK4CrpXkvVUO+IvHW4OeSyvs4aU/xpTifBn+wM7ma5mBOD/E/h0JcZpqiK6KBWZVCULYmMQbs/VnyY5My84Fdn+P9H6PSNRfOWee3QZwdCmJM/JyBSlyhu0Enkg+F4zBEZ6g41E/RLMAUFS3wTmFO3auCe17EyFc+ZjYSNXoPcxR5f0bqE2GBIuM7Eu+AE03QK+vcUnhbY1gw6pZYiVtnk1zXemSb3Y4WJgFhQcv+wY7sSJ/y4VNJoqsIuQih8cN+v6WgwYRPUOOqZ6hwxMIuEXtU+D40mpxvwGmWQ27hLTwHWQLNK+51VaOyj4baJMGFIbwA7/Wcq8Cyij5QhI5DmjI/FZ0Oy0RwhuDQjSJHdD3dN19xETKPfdC2JhwUR5tgtM4g2skP/2zGwsT+REM06Pfd0kaXH9M04Hpf7obnxaYsTw276zy35EkJf52Vg9Pu2ds3b7unZ4Pj7uykVN1j9ffgpBwMoISBPDC8Xuq4mWDbyTUlstqUlqlxbbP1Te+od7TXP58uLj+K0Zfx48KQ9jZGoYDeMyiiz8UBpUisgtpE1LbQ5VKwBGz0PNwoXWQV2oiUOTQ3mrRZk0i5i6hvkIZfylfSiPw4nqTENtaHGsye5bUvvHsBtLuGff2bM6sl4F3oNxVoHkG5Ldp1I10frjZJcUFhsL1t+fivrlqteJsE41i90127JPGSA0JBGmSh/ESCyPeZd3fCLBhOrLiBHg4dHovZY6R4UD2Lne7NhC+jyft/WfTrlz/VkJ0c3NIm/w7lN/puRZX6Ke23sgIzjzSmCJMP5s8vNf4R4g== +sidebar_class_name: "patch api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 multiple option based attribute values' (patch-attribute-options)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Update multiple option based attribute values

+ + + + + +Update multiple option based attribute values + +## Request + +

Body

required
    ne_attribute_options object[]
  • Array [
  • ]
+ +Expected response to a valid request + +
Schema
    oneOf
    ne_attribute_options object[]
  • Array [
    • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
  • ]
    • job_status object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/patch-profile-type.api.mdx b/docs/api/nerm/v1/patch-profile-type.api.mdx new file mode 100644 index 000000000..70b28e660 --- /dev/null +++ b/docs/api/nerm/v1/patch-profile-type.api.mdx @@ -0,0 +1,47 @@ +--- +id: patch-profile-type +sidebar_label: Update a profile type by id +hide_title: true +hide_table_of_contents: true +api: eJztWVtv2zYU/iuEnjYgiq9pUgN7SLsMy7BekCbrQ2YElHRss5VIjaSSeIb/+84hJVuO5NTpgnbAnASOJR6S37l/ohaBykFzK5Q8T4JRkHMbz95rNREpXM5zCA6CBEysRU4iKHCVJ9wC4yz3QsyiFIvmTCQoa/nUBKProD5ogvEBrqt5BhY0DS8CiRe4mJsjpN931tjr/GemJszOgKnoE8SWWcU0WC3gFg5Y4ZAcMKVZAimujfM1/FUIDaiJ1QUcBCaeQcaD0SIgJLikwdlyipITpTNu8U5ROBRwz7M8JZFef/giOYkGIY/7L8Nht3cUnvSOhmECfDgcDPnxYMKD5XLsdwNjX6lkTls83DxW0oK0NMTzPBWxM3PnkyHlFk1sXknEgtZDp1iBpsPR0pY3XupL0t6yTX03LXs5E4bhH9mWZlR2rvvtcMMqH5X+DDpYolpo9anS87ZdQBYZ+R9wlpoDuUQqGdYulZ5yKf52psBLboyYyozMhGMIQVO0bAdbbd5AyyY8TVFMWrUJfLU3Qo/mOW54kxT5Dc61aD/hfVHqESmVApcNc32cAUGjUJPKMpxfeZOt1yGIfgNINiAgMgO4O9fxTNxSfDx1w4ayuFW1WutWGBCZsBaSG40b3IjE1DblWvM5JZ6FzHw5N5ZNfwCjZTHlySncIhbEV23JcDreRohbo+k6GAwm3eN+koS9QTQMhz3ohSfAu2HvxaTPj15GR8fxSTDGrYWJb8xcxlvNNuFFakvNGwXENIEwvxq7E3bGRGxazVdLORct3KJtosLCLnbckpki2aUONU29roLr9dZmL0xp8fag3MyFnayO+hftWDMhfwc5xUo9GvTxkt/XL5vIcZlng77yQFjG5IaPnsW2WyrfrkaTsA6TZwAksclWy30NIPx5YCQs9Ajje0fwOhE9nu8aoVdPgFYKhCQQujb7/FGIzUPFglMV/c8FZA3bv41NogEJtvo1IuzbMMU7zoUiIxbRbYPj5vkSUnIXCul1ORGbZaO79HlghXXwasw2HLgcoVENJlfS+CDvd7v0b3Prs/scEwLXr0SJinJ2y1NB9xwNDL4T49vNsxp48k6m84qctpjWLW/Q498wJXeHdfUQV26vfCfYU9495f1fUd49xd1T3D3F3VPcPcXdU9xHKW5/RXGHbaz2FU/YhSevLGSF5FHqiG2saGmv986UVkl4N3GHuw8zrEJ2Lh1f/o2mLg+2y/1BUm6bM62VNsFy7JU4alPiHPFpyVP2AfQtGs7NQXU02EJLtBdW3ELOuExSvID7GNxM8yTlHi8aQFs2kZ2yDIzhU2D+foR+dC718vWY+qA0EjyjMuRAJHWHqNidVhjBy8qFNKZWZ/QEgs7MR0GnnqCmsxDJEgeNs4Y/bS90inIza3Mz6nQWqDKX9i2m9/IQqWrFFg/R7R2eC5x8y7WgYPAFcyXuVSwP3AIeZxCrZkY5cU+xPdVFs1NQFcaifpoUGhO+uNDCzh3ACDC69WlB+lyP68MfyAUeR11o5RFSKijP+R1NckJ4x3/5pUr+S/UZJMLAz5/mqtD+a0B2JW9frE/yzyqnNJ/DyrcW5XNB/bGgzv63MO7ygHLNiMsbbbx1V7K4yRWrBR9jdte+xe22ftmDHhCTlo6w63KNcr1jMR1va/NfpU6zy317lVbtoUvFjV6CTRSFGOWsz6PeYfewW6uKb88u3rDT9+etLawaxIdFyaKyUdARRRxjCWJY/FimEjGZM0ptVRg6yMA0wFHsJ8xlBMhbgRWHHkypNmI1BGnqcf/m/NIlTK6MzbisjTz+UnAD7mJddL/0LtFnuIV728lTLqQjRVTKFmXpu95wGz3mjHAmBssMEdLwYhFxA1c6XS7pNuY4Jev1eF3hXAglwtD3pP0tQh3xDxflO74f2dNfTrYqVNFUOXd1Ny3oCr9+Bior9BxAj4Qz4C5aEKwfeO0hheU72mpio4tRn/UzTmPqfI/KjmtN5v3p5etfqZqVLzcxfGiS5nd0mISfo+BP/KVA9v3UvQGl+4sg5XJaYN9DGb8w/fwDzeQ/Kw== +sidebar_class_name: "patch api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 profile type by id' (patch-profile-type)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Update a profile type by id

+ + + + + +Update a profile type by id + +## Request + +

Path Parameters

Body

required
    profile_type object
    profile_type_dup_attributes object[]
  • Array [
    • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"description":"The uid of the properties that are used for duplication protection.","example":"attribute-uid"}}>
  • ]
    • profile_type_namings object[]
  • Array [
    • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"description":"The UID of the profile type naming.","example":"profile-type-name"}}>
  • ]
+ +Expected response to a valid request + +
Schema
    profile_type object
    = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true,"description":"The objects UID.","example":"ptUid"}}>
    profile_type_dup_attributes object[]
  • Array [
    • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"description":"The uid of the properties that are used for duplication protection.","example":"attribute-uid"}}>
  • ]
    • profile_type_namings object[]
  • Array [
    • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"description":"The UID of the profile type naming.","example":"profile-type-name"}}>
  • ]
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/patch-profile.api.mdx b/docs/api/nerm/v1/patch-profile.api.mdx new file mode 100644 index 000000000..2dcf335d1 --- /dev/null +++ b/docs/api/nerm/v1/patch-profile.api.mdx @@ -0,0 +1,51 @@ +--- +id: patch-profile +sidebar_label: Update a profile by id +hide_title: true +hide_table_of_contents: true +api: eJztWNtu2zgQ/RWCT7uAFVvyJamBfXDbLNaLXoLE2ZeuYdASZbOVSS1JJTEM//vOkJJlxY7TFG2fmgapRA5nzgxnzpDaUJVzzaxQcpzQIc2ZjZdXWqUi47RFE25iLXKchsnbPGGWE0ZyL0DmayISELNsYejwEy3HDZ22QJNmK265xpkNlfACKpy4kN7S8sDC+C1RKbFLTtT8M48tsYpobrXgd7xFCme/RZQmCc9AN6zX/L9CaA7YrS54i5p4yVeMDjfUrnO0aGC1XIBkqvSKWRgpCoeCP7BVnqFIGPUGycW8G7A4ehX0OmE/uAj7vSDhrNfr9th5N2V0u516a9zY1ypZo4nHxmMlLZcWp1ieZyJ2gW1/Nujc5hCbdxKwQOBgG6yA0MFsGcbnBX1QH7u6bVUaZjgxA2+fDQesMZbZwhwT5bJY4faOYivuMOhjyarHj5K848w9TrheCQk7lNAp6BPJDGAADrmYPa875zLxIzkzBvExkTk9TMdLsLXvxFypjDPp0idlRQZupCwzHKUtaJ4Xlptj4WNJInBLWHbVCORBAHfJAXP8wc52amcYraELlogJziEKcPpApBO2w3476kQdWm+IgbyND9WVFUc+4Ia26ApcEmB+9oJlrRsO6ZeQxthkKXRziPosdWqUfkrxreH6AMxL1lVo6gEPpVa83UKYrbCuAkuEQReH3YzmJlfS+O2JOh38r8kVlw85QOAJqUSRLBi5Y5nAMVeo9OfX5NdUG7rHko8yW1fM0XRtsiNAQ8ZvG1zV7aad8yhJgrA77wW9kIfBBWedIBykEeu/mvfP4wtM4OI4DijQd1wugHqH3Qhe2cP+69ejun0EqwzPraeS47x0qE8YAr9I97iiov5S11nDQCOHv4XhTlmv207V2VBXY2DOMyUXIK6+aTu+K7mecsUbeuROA3Jp6Hsx9DNxrQwgsNO4Kv0ALIZEBE9nzJ7cV6TdwIrV4UkFU9WfVYCDUKKxl/fMkNJEAwFwdTcIwyAKJ2FvGHWH/d5Z1B8Enf4QCAiLyh1Afiiu0sTLcH2nptfEOtopBZDMlhWAJGtxi49V6a9m+TObZbRrlr1j/fE1S8i1b4MkIIVk88y1yFjhZlm3c1/dHJXkH1N3kH+cXRWqsXSd929cum09LfcPSjkzl1oruB1sp96J/jEnxoBPQ+aSG67vIBpuDbgDl4JCS2j+SoJrSyinDF74Q8zdSvMi5043dI4mD5GNyIobwxZQ0G58jiSH1ezl9+v3Rmm9JkbBdWiJUveAitxrhVVXbSHOqd0NzJEsdmXaru5U7Y1ItjBuXCD8parQGYgsrc3NsN3egLdMWkyY7ZmEHQPzas35Gex4m+UCFt8xLTAPfP3vxL135UmasngF+XjIXU7cd2poAGKB4cd8KowF1zT6MkV8caGFXTuAc84016MCXfk03Z++weh7HPtCu81Ap2h5nXNHficEI/7hz4prJ+oLlwAD/v6xVoX2jxRDiht9XV/YLmuW2jvMlffSHYkfnCsoXP4u+umgF/TPw/Og1x9EwbybxkEUvxp008GApWxA6w5fN/Jj7XWvi9b3Gnd3OWDxX0z6w5hUyFRhjLGQfHKHZ52zzh5Lfbi8fk9GV+OjHbyaJDGT0BZJYXwlsDgGSnC9faUSka4J1puCYw9cUSA3YZYISVyacnkngAFWQAXIVcBOHK4wexn5fjxxWZwrY1dM7s08+RmmgXRT89+JDze+2DCf2nnGhHSnHGSVTUlAex91WnQo3OlzCZBwZrOZM8Nvdbbd4jBUmsayn9Y840ggEQaf60R/Eudv1+UHld/Jy78EHfWlHGRy7dgvK/ANHr/wtf8atcVPDEu49wC5IFg/8cZDCia4vF540Eaw0fkVoxhbz0nZ6R7LX40mb/5CNiu/JEG+4CLN7vFyCH+H9F/4By/KNzT3uQnHNzRjclFA4wEZrxh//ge75dFy +sidebar_class_name: "patch api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 profile by id' (patch-profile)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Update a profile by id

+ + + + + +Update a profile by id + +## Request + +

Path Parameters

Body

required
    profile object
    attributes object
+ +Expected response to a valid request + +
Schema
    profile object
    = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true,"description":"The objects UID","example":"profileUid"}}>
    attributes object
    + +Attributes that belong to this profile. + +
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/patch-profiles.api.mdx b/docs/api/nerm/v1/patch-profiles.api.mdx new file mode 100644 index 000000000..ae048df22 --- /dev/null +++ b/docs/api/nerm/v1/patch-profiles.api.mdx @@ -0,0 +1,51 @@ +--- +id: patch-profiles +sidebar_label: Update multiple profiles +hide_title: true +hide_table_of_contents: true +api: eJztVm1v2zYQ/isEP/stTuyuBvbBLTLMxdoGibMvmWGcpZPNViI1kkpiGP7vuyMjy67StAG2b7MBW7o7ks+9PcedNCVa8MroWSonsgSfbK6syVSOTnZkii6xqmQ9aW/LFDyKosq9KnMUZWPoYe3k5E4eRIuOtPh3hc6/M+lWTnbhVVmkY7ytsCMToz1qzyooy1wlAUb/i+OzdtIlGyyAn/y2RDrdrL5g4uksOoNAe0WnkPZwYmMJ1sKWDJXHwv14B5Ue2ThvlV6TTWZsAYROVhUZ7DtSQ4Ftw32nRrBkxfInN3MefOWeM0VdFRzJaeLVPZJgpqF+/KzFHwjhcY62UJrSkcoF7afSJcEgHHq9/PHeJeo0SkpwnL4MVB72AZts6KxjJ1bG5Ag6VEMGlHs5ySB3yNaedl5VHp+NMqSp4pRCfnUS71YA8REKqqegw0e/PGy75GhNQrBUIljHKMjplsngrH826g8Hw4FsEuIwJyQt26f6Fp84oR1Zl/PyFcs6N0jlm4oT2Xyj7KlIxioP2xj7vY1vHdoWmNesq9E0ggil2Xi/pzB75TnItSOuO2T5PugsutJoFxM0HAz477T5Lx9LAoGpqE2FNwLEPeSKZaHV5Su62mj8nFExtuvmW5xUIt83+mBWcr+ITlw8h/sdpOI6whNdUWlY5QF6YrjmPPb+XdAzHSLygZe+hPtPtgrHXFprrDs4MXrOiRnhs9RI4gbtPSU1rCF3LPrKakqK0eTaBnSa0ws+JhhWulc59zJLIh/ZRjYVBToHaxRRvqKeFn6DItofNbe8MdZuhTMF+g1bPRAq8WANk0Bdh6wzh0kUCMpv6LV/NGtciIELaahsTtqN96Wb9Ps7chS055Lf9zQli042W8QeJbsPpaLF92AVl0BkooN5dOyJ3iQkBXVUa/7Ng7ngQSCIN9WaI8+lVDlPXll2Y8H4ksoqvw0AVwgW7bRiL+4Wx+obDnzEcWx0yAM7xd4GM+bhYESS+PBbPVLm5itqgkG/v25NZeOj5Ghyjq+bKXzZ8GwzNe/iAJTnGfwyysYX3dGbszfdi9F42F2dZ0l3mLwdn2fjMWQwlvUUbEZKa/j97Eb1lGoG3XMz7GhUNaMpjJ/W9Pl/cvw3kyNcL3RmOMjcd7EXznqD3uCIzz5dXn8U06tZu2mIC2qlSECLFYrKxcaBJCHyEERbojCpyraC29NUjocMlTJphdIiVDXqe0VcURBpMKsRjyENIQb1VJIfZ/NQ9KVxvgB9pHnh3nqCdddw5Yt33difXFT9MgfFRB+JaPdEV6f34A0BYtlutwKHtzbf71lMbWmZIxYNKQWKoAUIKXU6t+ZXJBP5PsLqzvlkNs+rcM/9ls554MQV04RHwIu2iyO2vZrO3//O1PJ0V6ds8CILDyTk34n8i770YuJgCRd6lu9kDnpd0QAgm7gxf/4BjtlPZw== +sidebar_class_name: "patch api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 multiple profiles' (patch-profiles)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Update multiple profiles

+ + + + + +Update multiple profiles + +## Request + +

Body

required
    profiles object[]
  • Array [
    • attributes object
  • ]
+ +Expected response to a valid request + +
Schema
    oneOf
    profiles object[]
  • Array [
    • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true,"description":"The objects UID","example":"profileUid"}}>
    attributes object
    + +Attributes that belong to this profile. + +
  • ]
    • job_status object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/patch-role-profile.api.mdx b/docs/api/nerm/v1/patch-role-profile.api.mdx new file mode 100644 index 000000000..4767dbec7 --- /dev/null +++ b/docs/api/nerm/v1/patch-role-profile.api.mdx @@ -0,0 +1,47 @@ +--- +id: patch-role-profile +sidebar_label: Update a role-profile contributor relationship by id +hide_title: true +hide_table_of_contents: true +api: eJzFVt9v2zYQ/lcIPW2AFf92UgN7cLsM87C2gePuJTOGs3Sy2cqkRlKOBUH/e+9IO3bqLEv6sNmALZJ35Pfdd3diHekCDTip1TSNxlEBLlnPdI43Rmcyx6gVpWgTIws2IYNPRQoOBQhDRnERrESilTNyWTpthMHc72fXshDLSsiUNnGwstH4LmIvsfey0aJFBxrYoEPDy3WkaECneB+pAqD1GYjpz0Jnwq1R6OVnTJxwmo4lBLjFlig9xJYgLCnmtDf5G/y7lAaJojMltiKbrHED0biOXFXwiZa81YosM2024GimLD0K3MGmyNmk2xuM0qtlP4ak9yYedLrD+Ko7HMQpwmDQH8BlP4OoaRbhNLTurU4rPuLbwzlaqBwvQVHkMvHxan+2TK4+xxZIEhYKHKnlJIWOt6VY/rWP5QutidG/Um68J2/6MnOyd9L5CJ0mTuM/HAtbUDIEEL1Oh/8eq3m9KwgwpuJgynKC2EIuec6HMvqfovaSCDBHSD+qvAoCE+nyab+NVL+jWlFGj/s9GsLudHi2y38sWdx7EG3wlE5vIRWzIIeIRalgmXupEs0F4vDiNSJphR8zX/LfCnBANlU+A35j16b1z3Z/sJU/5toYTX2kWQQSw6dITAmfUZCLWzRbNML7EB1qH6VRlIRaEbU1qDSnAe4S9J72VeSezynkI8+RTcQGrYUVijC/JOl8jwv2p53oVhtTCaupca7Z6p5QiXujSevmICGv6YeWziC4k46j9mkB2HYt04YWrY9G6MGlyclu7Vxhx+12TZRBuQ/UmJsLRbIRBl0hXpDsbSgkOW/BSE4Gz+5oHihmUOaceZBsMNFnrXzuzQX3fQHWyhVrwElVWkf8DBNaML6kNNJVHuASwaCZlMznbnG6fMsSBBynRg+KMKlo3/15HIxoJjz8ciiTuf6CimDQ70+VLk149IXDas+O/f36IMp5Z3ko34heDFfDbDSIh5fdy3gwHPXiZT9L4l7yZtTPRiPIYBQ9ruGX+TAgqTLNx7F+Iabdi85F56RCPlzP3ovJzfQ8+JRdh0WRgBJLFKUNAkCSUDoKKgSx0anMKsEy69Jym6aQ0KqQSvjooNpKyr4NpSHXCVUGUhtnUPv3+fvp3GMttHUbUCcr33mfeMSjPlbmd99PQn443Ll2kYPklhMKod4Xzt0jfS35jMmTcm9NnHi5rpdg8ZPJm4anKUMMp+viWB8+eVNp+ZkkziC3+AyVH2b7e8OP4vUXnicJ7SdBVb5q85JH9PgFq3DpotZJhOg9REXBYMPCuwApnrP70fGsB3KXDh6ThPvms7aLkxZ1M5m/+5WrcH9hooRjJwP3/HKl33H0J31poEM39uXF83WUg1qV1DXJJmzMn6947rmL +sidebar_class_name: "patch api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 role-profile contributor relationship by id' (patch-role-profile)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Update a role-profile contributor relationship by id

+ + + + + +Update a role-profile contributor relationship by id + +## Request + +

Path Parameters

Body

required
    role_profile object
+ +Expected response to a valid request + +
Schema
    role_profile object
    = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/patch-role-profiles.api.mdx b/docs/api/nerm/v1/patch-role-profiles.api.mdx new file mode 100644 index 000000000..3fe8075a3 --- /dev/null +++ b/docs/api/nerm/v1/patch-role-profiles.api.mdx @@ -0,0 +1,47 @@ +--- +id: patch-role-profiles +sidebar_label: Update multiple role-profile contributor relationships +hide_title: true +hide_table_of_contents: true +api: eJytVm1v2zgM/iuCPuel60t2F2AfsqLDZcB2RZvtSxcMtEzH2mzJJ8ltAyP//UipSd2l69q7pUBiSQ/Fh+RDup20DToI2pp5LqeygaDKC1vhubOFrtDLgczRK6cbxhDiU5NDQFG3VdBNhcIReNgktFDWBKezNlgnHFbxXl/qhq8JsPJyeiXZQDTb65cD6fCfFn14a/O1nHZxqR0Sm+BaHEi+E03gI2iaSqt46/ibZzqd9KrEGvgprBskgjb7hiqQQ/JBsQVNXvhacvt15/YeDs7BmtA6YO1/fY3OexhPwZoVYQrraiCKsm0JsBkkb8/E3pF6HpzwQYeKIf0yDQ/pKH44n76htCe+hwcH/POwhme3DcWGudhCRbACxDVUmvdiOeQLMm8N/l1QbfeT9xhXivnnwPc2k5tlCuT4Me5vIRcXiaIYitZAVkX6ytYkx4Cj30t8bmJW3rPpU7w/Myq6OXPOOr8L4uSxIObEzxmoxCW6a3Qi2lA4DkPrDBXGGgqtBJNXtMBbhdHSvyi4p4WM7HKf2UzU6D2sUKT9jFQoQoki4QcSb4ETTdBL69xaeFtjKBl1Q6zEjbMk250W+czuBguTgFDScvywHQfSx0T4WIvWVQQpQ2j8dDzuKFow4SPUuBkZqhi5t2vEEVV8DI0m42twmnWQ+ncHT9EVQKOKG13VqOzePFtEuDCEF+C9XnH6WU+tDxSa41iWzE+1Tod1JJghOHSzlkO5WvaPLzn7iUcftCsGB8XRRhitE4h20sO7bbMv7Hc0RIO+36xt69JjbH8u9MX9yDzb1mNvxF2laSWPCvjjpJgcD09ev3o9PD6ZHA6zo0IND9Wfk6NiMoECJrI3sp5r0J9bz7OhnqBBawrLbLncqQSvRgejg14vfTy7+CBm5/P9WpEOt4dCgREZitaneoFSJFxBLSNqm+tiLVgVtvU85CiDdCq0ETGZaK416bQmwXJHUQ8hDUEmZaJs5If5Iua6sT7UYHon//n19yCS7r6L/8cLNUkq4G0YNxVoHlCpd7q7Nrv6QRIk1JIi4oOuy8DjJ1dtNrxNcnKs7eV9M0VpkwFCTgplNX1HgsjTxHy4YPcMr9r4Hv1xFvG0TBYzxfPrSeyyNyrOZ4vTv7gl7v4hoHKykYMbVil9T+UX+qOFTVMxap/3O1mBWbU0vQiTLubPvzFnEvI= +sidebar_class_name: "patch api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 multiple role-profile contributor relationships' (patch-role-profiles)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Update multiple role-profile contributor relationships

+ + + + + +Update multiple role-profile contributor relationships + +## Request + +

Body

required
    role_profiles object[]
  • Array [
  • ]
+ +Expected response to a valid request + +
Schema
    oneOf
    role_profiles object[]
  • Array [
    • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
  • ]
    • job_status object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/patch-role.api.mdx b/docs/api/nerm/v1/patch-role.api.mdx new file mode 100644 index 000000000..9bbb1d752 --- /dev/null +++ b/docs/api/nerm/v1/patch-role.api.mdx @@ -0,0 +1,47 @@ +--- +id: patch-role +sidebar_label: Update an existing role +hide_title: true +hide_table_of_contents: true +api: eJy9Vl+P4jYQ/yqWn1opLOzC9q5IfeCuW5Wqt3diub5s0cokA/gusVPbYYkivntn7ASyhKNdVSpIYHvG8/c3M664zsEIJ7WaJnzMc+HizUynwCOegI2NzImGlM95IhwwoRjspHVSrZkJfE6sLR8/ctpavoi4gb8KsO6dTko+rvxWGkDxzhQQ8VgrB8oRSeR5KmOvvv/Fkp6K23gDmaCVK3NAzXr5BWKHinJDxjqJWkgsaf9HrkA9cFln0HLkAlVkZPQ9IP9KplA7fQ8ijsFav12cBmG+AUaSmF413sNOZDlZciJqH3ElsvO6D1cecq2sNrYTbVJE10mRw3VhwQSNKFeYeCO3FNCD7KVGmlAdOQ/gmNOMAk//9c2IrURq/Umh6rO2XcSOetZGF3kriqjYiLKjg9xlNW/EpYPMXvZaJE+e/ckHaL9HVU46TyJZvSGd+eNcGGRxYAhgVR1QLhPSowJcNx17pj83UQuYIDcNoBlAnhcexxHThiWQomwedRDageDBiZU2mUDo8qLwVhydur4Z/ZC8XQ57Ir75sTcaXN/23l7fjnoJiNFoOBJvhiuBfvnysJT2gM+bwYD+Xnpwt8vRbkhYw+pzx7YilXTmq4v/z4Ukk38TDwMi+ajS8oCh4vy9TKrfQa0xe+PhDW7Frr19KaUdZVsXzJN5fY1dQvR/R+0Bs6NzGX0nEjYLiWM9Krpl6pMaa5Lu4Oo16dQKPq58QZymrDFoqjxWfqOr++jbfH8Ql1dzZ4yP0SI4cXvOiSnaZ5RI2QOYLfYjfwfdweIqjEK4aoWubYRKUtzALgZ/077KucsoBFLZtWzCMuzZYg0snC9pPFEHCPwv4KCNKZnV2FY2xPWMVrFnozHb+yaFRNOHcUhGUJ8Z874fcf1KJns8tD4KoTMVJkX6xrncjvv9Cl0Vyt0jUPZXCtOFunUJcIXp7otc4uWtMJJAEEB3YA+urUSRUlGJOINYd4eDZw/zQVgr1xR7AlNhHfplyJEF2RcXRrrSG7gEYcBMCvLjcdEmP1Dogx1tpkMmyCle90Q/ajwTnoTFL00HmOuvoNAM/P2p1IUJS07xpCzPjo+CuyYZnd5zOo3rht8ak8fZF1pDU9GPJ/W5IL1SrTRJpzSF0F1fDa4GrQK4v5t9YJNP07MDuCGyGF89Sz+EfZzDCwGfQgnLdCJXJaNs6sJSv0bPkcqkYj4IoLYSwZUhyqgMEPiA/ZyMqn37MJ37GOXaukyoFuXbL64XplbH2rr0SAsBdrBz/TwVkvpCQG1Vo7t5wEV8jD0bAbJBi+i4qpbCwmeT7vd0jGk0hKnFEcQeYYm0tMbM+MfFBSu/m9Xz9nv2+ll91pGmm6vSl1Za0A6XX6EM7wXsa+gQjhVELhkbCO+DSb05XT9e7DQoaqHhxiSmpnaRd9HqH58m8/e/UqnUT2GEC10y4plmJf6O+Z/4xY0OrdLXBJ1XPBVqXWBLQ54gmD5/A5xSBlA= +sidebar_class_name: "patch api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 role' (patch-role)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Update an existing role

+ + + + + +Update an existing role + +## Request + +

Path Parameters

Body

required
    role object
+ +Expected response to a valid request + +
Schema
    role object
    = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"sponsors_role"}}>
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/patch-roles.api.mdx b/docs/api/nerm/v1/patch-roles.api.mdx new file mode 100644 index 000000000..83e417b95 --- /dev/null +++ b/docs/api/nerm/v1/patch-roles.api.mdx @@ -0,0 +1,47 @@ +--- +id: patch-roles +sidebar_label: Update multiple roles +hide_title: true +hide_table_of_contents: true +api: eJytVttu2zAM/RVBz2nS3V4C7CEbOiwF2hVttpcuGBibibXakkfJaQMj/z5SysVNsg4D1gKJTR6Kt0MqrXY1EgTj7DjXQ11DyIpbV6LXPZ2jz8jUomTV1zqHgKpqymDqElXjkQQVYOH18F5TtJr2NOGvBn344PKVHrbx1RDy6YEa7OnM2YA2iArqujRZ9D746cVLq31WYAXyFFY1sl83+4lZYEc1SazBsBc5Nrrbw4AIVowyASv/d/Ok3aF8IGMXjELbVJLNNTJ+bkqUYrD8GiHL0Pv4Oj2szaRAJScpN1eUDPAJKi4TK58fte5pC9Vp3zuTu9pZ7+i4CeJIzMVRKFITkkc+FygrzFIqvTt75lgH9uicOwwqOCUdke+NZU/NofRR0tiNrBuXwNnPglxTn6r9cx+Srtpgj/tyImvIf0T4j1ig9ZpdBROiSs46eyOydZQTeilR6uXr83P5eu794qnmvmOuttCYp1pCaUQWKar/gY3O4pc5M+OYWN0YPffhz4hLN9Pracrg7amgP0CublNs6kx6MCtj3JmTEgXs/9+IxzaW41JMX4r7m6CimwsioeU2iXenkhhzfGShVHdIS6ZntOF0CENDljviLKdWgM1LfsGnDKOl/6fkXp5uFJfHkY1UxSMMC1RJPmMGxjFK+GcT6IhWyrsKQyGoR45KPZJjyu5IKDq325oSBISCXwe0WaA+FsDHHjRUsqoIofbDwaDlLMGGayb6um+5U+zWrRD73OkB1IaNl0BG+p+GZgdPWc2B17CMTFZh5o7XRISnTQHem4WUXXjU+MApkeQwlfiyhkxYxQBnCIQ0aiSF+2lXfSdVT3F0QbsmSFKSbYTJ0okglqSHT44qkGAn7gEth8Gf71euofSopZTS4Nv9vXGx7cNuz+9ZfLiZ0zbtrsz9Hkw3znZf3R9sGE6SXRs7d+JIOpWq96p/3j/v0P/64vZKjW7GJ7fxVqkysGoWN3IsdbouFLNcVS4385WShrrGy0Li5FmrjFWxDmiXhqlVMcdkCJj2yAtLgtokdzWexDLVzocKbEdzeCvTqbu73c/Vn6/xVN2AT2FQl2BkIyTSthted674guMQQdvOwONXKtdrEXP/SMg03bM3cokNEHKmhLTxARmiP6aAzibiVuBlE6+Aw6GXtZQsRpksihex085M3owmHz8LBzc/Q7gJYkTwyEL5HOrv/M8vLq2fSDaRt7oEu2h4TTAmHSx/vwHccC91 +sidebar_class_name: "patch api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 multiple roles' (patch-roles)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Update multiple roles

+ + + + + +Update multiple users + +## Request + +

Body

required
    roles object[]
  • Array [
  • ]
+ +Expected response to a valid request + +
Schema
    oneOf
    roles object[]
  • Array [
    • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"sponsors_role"}}>
  • ]
    • job_status object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/patch-user-manager.api.mdx b/docs/api/nerm/v1/patch-user-manager.api.mdx new file mode 100644 index 000000000..99570fae0 --- /dev/null +++ b/docs/api/nerm/v1/patch-user-manager.api.mdx @@ -0,0 +1,47 @@ +--- +id: patch-user-manager +sidebar_label: Update a user-manager relationship by id +hide_title: true +hide_table_of_contents: true +api: eJzFVttu4zYQ/RWCTy1gxfE1WQP7kN2mqItmd5FLX7JGMZZGNnclUiUpx4Lgf+8MacdOnQ2Sl9YGbFE8I57hOTNUK02FFrwyeprJiazAp8s7h/YKNCzQyo7M0KVWVQwhwF2VgUcBoiZQUkaUsFiEZ7ilqsS8ESqjQA8LJyf3kpFii3Ry1pEW/67R+Q8ma+SkDUNlkZb3tsaOTI32qD1PQVUVKg2P7n5zTKCVLl1iCXzlmwqJkpl/w9TTgpXlZLxCx7O87F/bZV+JJtp7oPNW6QUBc2NLIDqyrgmw6cjtQ18HJ7xXvmDI4b5uwodYgIUSPe/M5L6VmgaEDPundBRkeSTC9BdhcuGXKGI2whuSgAjgCjuiDhJ1hLEiw4KeLTtHe3y0iT+g35G4hrIK9Hv94Tg7nw8SSPvvkuFpb5Sc90bDJEMYDgdDOBvkQHkFgV1FZog72z895b+nGVyuK+KNmdhBOQUQKygU3wv+kP+TFV4jK+cI2WddNHFHScn6+bhS6T9QL0jFyaDP3lkfDo+f8t/6MOk/OnH4nE4fIBPXUQ6RiFrDvAhSpYZN4fHkLSIZjZ/zYPN/C7BjNtXBAb9z6KbzY9yfjArLXFprqHY2s5jE6LkkpsTPaijEDdoV9aIQQ+lQydRWkwmNptSWoLOCBrhOMUS6NyX3sqeQlzxmdiFKdI6EEPH+nKQLdR3xh9V3Y6xthDPULJaMeiBW4sEa0nqzk5DnzGMbZxLcPSaye1gArtuqbEOTLuxG7Du1LQi39L5yk263pZRB+0/UjDYnmmQjDqZBPCHZu1ApCl6BVWyGkN0eHlPMoS7YeZCWmJqj9nUb4IJ7nQDn1II1YFPVzlN+oTnOmF9aW+WbQHCOYNFe1JzP/exw+oYliDwOQY+KcFJy2/F4HEF0J178uiuTW/MdNdGg3/eNqW28DIXDal/vD63LnSjHneWxfCU1w/NRPh4mo7PeWTIcjfvJfJCnST99Nx7k4zHkMJZPa/h1MUxI6dzwcqxf3NPeyenJ6UGFfLq8vhIXX6bHm0/u2k2KFLSYI5/lQQBIU7KjoEIQpclU3giW2dSO2zRtCc0KpUXYHdQrRe4ryYZcJ1QZSG2cSW3PsKvpbeBaGecpy4OZN7xDPOHe7qvxTe8h0Qce175bFaC4tUTDt9sCuX+io6OYCUWSx5bEnafbdg4O72yx2fBtcoJlW872dRBMminH1yRlDoXDF+j/dL09kH8Wbz/Mn01oexN0E6qzqHlEl9+xiS8U1CIpITpv2KlENk58jJSSWw7fBx71Ou7GMeIi5f74InZ20Iq+XNx+/I2rbfu2R8biIAsPfIjS70R+pS8NTOy64ZWQ77eyAL2oSRLCxAfz5x8aR6pz +sidebar_class_name: "patch api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 user-manager relationship by id' (patch-user-manager)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Update a user-manager relationship by id

+ + + + + +Update a user-manager relationship by id + +## Request + +

Path Parameters

Body

required
    user_manager object
+ +Expected response to a valid request + +
Schema
    user_manager object
    = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/patch-user-managers.api.mdx b/docs/api/nerm/v1/patch-user-managers.api.mdx new file mode 100644 index 000000000..dc05bdc49 --- /dev/null +++ b/docs/api/nerm/v1/patch-user-managers.api.mdx @@ -0,0 +1,47 @@ +--- +id: patch-user-managers +sidebar_label: Update multiple user-manager relationships +hide_title: true +hide_table_of_contents: true +api: eJytVm1v0zAQ/iuWP/dlrwUq8aGbhijSAG0dX0aFrs6lMSR2sJ1tVdT/zp29dhmFsUl0Upv4nrOfu3vuvFbaGh0Ebc00k2NZQ1DFlUd3DgaW6LzsyQy9crpmDCGu6gwCiqopg65LFA2B+1VCC4dl3MsXumbXAEsvx9eSQaLabDnvSYc/G/ThxGYrOW7jq3ZIDIJrsCeVNQFNYBPUdalV3HX43TOFVnpVYAX8FFY1Eim7+I4q0IG143iCRs9WPvbb9tgHODgHK0LrgJX/9zY662B8cNosCZNbVwFRlE1DgHUvnfZM7D2p58EJH3QoGdItTf+ATPHD+fQ1pT3xPdjb45/HdTu7qyk2zMQGKoIVIG6g1LwWyyFfkHlr8FNOtd1N3obrB7ugUP9ufySz9TwFcvQn7ieQiYtEUfRFY2BRRvrKViTBgIP/S3xqYlY+sOtTAXxhVDzmzDnbCeL4T0FMiZ8zUIpLdDfUDtGHwnEYGmeoMNZQaAWYrKQXvFMYPf2LgntayMhH7jKbiAq9pzqItL4gFYpQoEj4nsQ74EQT9NI6txLeVhgKRt0SK3HrLMl2q0W22e0wYRIQCnodPm7HnvQxET7WonElQYoQaj8eDluKFkz4CBWuB4YqRsfbFeKAKj6EWpPzDTjNOkj9u4Wn6HKg8cSNripUdmeGzSJcGMIL8F4vOf2sp8YHCs1xLHPmpxqnwyoSXCA4dJOGQ7med82XnP3EowvaFoOD4mgjjN4TiFbSw7tNs8/sDzREg77frmzj0mNsfy70xcPIPNvUY2fEXadpJQ9zeH2cj476x6/2X/WPjkcH/cVhrvoH6s3oMB+NIIeR7Iys5zp059bzfKgnaNCa3DJbLncqwf5gb7DX6aWPZxfnYvJ5ulsr0uHGKBQYsYh3TqwXKEXCFdQyorKZzleCVWEbz0OOMkhWoY2IyURzo0mnFQmWO4p6CGkIMikTZSPPp7OY69r6QGF2LC+68h6xbx8694UXZ5JOwLswrEvQJl4w3CPtfTtd/1Z6EmRBzNnQtgvweOXK9ZqXSTaONTx/aJooYXJAyEiJrJofSBB5mtj2Z3w8w8sm3pe/zxyeisljonhOPYmdd0bC58ns9D1L//7ip7Kxk4NbWuTvsfxKf/Ri0/SL/x3weitLMMuGgiVM2pg/vwDXUgPs +sidebar_class_name: "patch api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 multiple user-manager relationships' (patch-user-managers)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Update multiple user-manager relationships

+ + + + + +Update multiple user-manager relationships + +## Request + +

Body

required
    user_managers object[]
  • Array [
  • ]
+ +Expected response to a valid request + +
Schema
    oneOf
    job_status object
    user_managers object[]
  • Array [
    • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
  • ]
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/patch-user-profile.api.mdx b/docs/api/nerm/v1/patch-user-profile.api.mdx new file mode 100644 index 000000000..e81bf34fb --- /dev/null +++ b/docs/api/nerm/v1/patch-user-profile.api.mdx @@ -0,0 +1,47 @@ +--- +id: patch-user-profile +sidebar_label: Update a user-profile contributor relationship by id +hide_title: true +hide_table_of_contents: true +api: eJzlVktvIzcM/iuCTi3giRO/kjXQQ3aboi66u0EevaRGQM9wbO3OSFNJk2QwmP9eUrITZ52mzl56qAM4lkhK/MiPpFppKrTgldGzTE5lBT5dXTu059bkqkDZkxm61KqKVUjhusrAowBRk1JSRS2RGu2tWtTeWGGxCOe5larEohEqo0M8LJ2c3ki2EmsrJ+c9utBCiR4ti1upaUG3BBulo0OrHSdmPwuTC79CYRZfMPXCG7qWPMA77Ik6uNgT5EuGBZ1N9hb/qpVFguhtjT3p0hWWIKet9E3FNzqy1kvSzI0twdNOXQcv8AHKqmCVo8Fokp0shgmkg3fJ6PBonJwcjUdJhjAaDUdwPMxBdt083obOvzdZw1d8ezlHC7VnEVRVodIQr/4Xx+DaXd8iSPKFAkfZ8opCR1KO5e06lntqE6J/hdwFSz50X3WNt+Bj/ve22WbJbdTetUJdl8wac6/Ryhi4Nc3kvKNTvPIhNduM7cKHb3AVnR/RDw4P+d9zGp09VBQpzMRGlXkE4g4KxXshh/I/Stc+YWSMkH3WRROZRaDrl+1KpX9HvaRSmg4HtISH7eXuKf8TriSDR7aMXiLIe8jEReSBSEStYVEEjqSGW4LHg7eww2j8nIcm923mN57NdKDeb2za9f5Z7w/WCtecWWuoc3bzCGL8EogZ+Wc1FOIS7R1132BDcKhh1lYT+40maCvQWUELfEgxWLo3gXudzMhX7np2Kkp0DpYo4v6CMhm6etTf7r2XxtpGOEOjYsVa9+SVuLeGUt9tUsgy8zjE2AmeHVPZ3648129V1pHQhWjEqVPbgvRW3ldu2u+3BBm0/0SjqDvQlDbywTSIB5T2PlSKjO/AKiZDQPekHiHmUBdMX0hLTM3O8LoK6oInnQDn1JJzwKSqnSd8lgHN2b+0tso3wcEFgkV7WjOem/m2+JJTEP3YVnrMCIOS63nH66hEO/HHL5tauzJfUZMb9P1TY2obf0qOK2f74mminW2SstvSHvuGpFF4Ms4no2R8fHScjMaTQbIY5mkySN9NhvlkAjlM5PPmsa/NTgfZ1/CFNrLuFoxS6dwwBiZFTNTRweHB4VbZfTq7+ChOz2e7GSXKboQiBS0WyM+jkFVIU+K4oOoSpclU3gjmjqkdDx2KM0mF0iKEHPWdIkqXxG0uPio3pKHETq2fRR9nV8HXyjhfgt6SfOez7BmO9qncv/uZF6Pq8cH3qwIU97FYXe26Gm+ekcaRzZQsidArwsTitl2Aw2tbdB1vE+0s18D8qehCRWTK8W9Kfw6Fw1eg/HCxfn79KN7+bnwR0HoTdBNaQVHzin5+xSa+XakfEyCaqsQtdjYKPkSXkis2fzLcaazc+qPFacrN+FXd+VbfOz+9+vArl/b63UmEYyML98x++p7KP+mPFia2+PA45f1WFqCXNbVi0okH8+dvvXAqmg== +sidebar_class_name: "patch api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 user-profile contributor relationship by id' (patch-user-profile)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Update a user-profile contributor relationship by id

+ + + + + +Update a user-profile contributor relationship by id + +## Request + +

Path Parameters

Body

required
    user_profile object
+ +Expected response to a valid request + +
Schema
    user_profile object
    = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/patch-user-profiles.api.mdx b/docs/api/nerm/v1/patch-user-profiles.api.mdx new file mode 100644 index 000000000..29090a4b1 --- /dev/null +++ b/docs/api/nerm/v1/patch-user-profiles.api.mdx @@ -0,0 +1,47 @@ +--- +id: patch-user-profiles +sidebar_label: Update multiple user-profile contributor relationships +hide_title: true +hide_table_of_contents: true +api: eJytVttu2zgQ/RWCz76kubhbA/vgFlnUBdoNEqcvWSMYSyOLrUSqvCQxBP97Z0jbUeo0dXfXBmxRPMM5cztSK02DFrwyeprLsWzAZ+W1Q3thTaEqdLInc3SZVQ1jCHHd5OBR1KHyqqlQBAL3m4QWmdHeqkXwxgqLVTzXlarhYzwsnRzfSDYQzfb4eU9a/BbQ+bcmX8lxG5fKIrHxNmBP8pmoPW9B01Qqi6cOvzim00qXlVgDX/lVg0TQLL5g5skh+aDYvCIvtMtub3duH+FgLawIrTzW7tfHqLyDcRSsXhKmMLYGoihDIMC6l7wdiN2QOhSu8RZ8yvLBNt1a3Cb0vhXqUHOBzL1GK1PiN8WU8zWd4pWv2KLbH/1juU4f9uIa8pESdXx0xH9Pm+f8oaGkYi62UOGNAHEHleJ7sQ/kb5TcaPy7IM77VXuOK2Xi58APZiHX8xTI6XPc30IuLhNF0RdBw6KK9DNT0xx4HPy/xKc6ZuUDm77E+zOjoptza411uyDOngtiSvyshkpcob2jOYw2FI5FH6ymwhhNoZWg84oW+JBhtHS/FdzLE4Tscp/ZRNToHCxRpPsLakrhSxQJT+35AJxogl4Za1fCmRp9yah7YiXuraEu3vUi75mdojEJ8CUth091oCddTISLtQi2IkjpfePGw2FL0YL2n6DG9UBTxci9WSEOqOJDaBQZ34FV3AdJOHbwFF0BpJGsMFmNmdkT0lmEC014Ac6pJaef+yk4T6FZjmXO/LJglV9FggsEi3YSOJSbeXf7irOfeHRBu2JwUBxthNE6gehOuvhrqxgz8xU10aDfP1cm2HQpOaVc6MtHrT7f1mNPW2+STMqTAv44K0an/bPXr173T89Gx/3FSZH1j7M3o5NiNIICRrKjlYcadAXzUJs91TzU8Bnp3CgkDRo9NnRhOAXcQ6murwZHg6POgH46v/woJhfT/Qag5t5uigy0WMSnaWwCyDKaBkFzKGqTq2IluNVMcKycVBbaFUqLWCHUd4qav6Yp4DGlwURSVialYy/Kj9NZLGBjnK9Bd3b+9cP8SSTtozT8h9eDlFqPD37YVKB0fIzyQLab2b35oc+o+0uKiDfadgEOr221XvNt6lHLAzN/nNA4L2SAkFPpuEW/IkHku8S8P2P3DK9CfCv4UeBYgpPFJGNRfBE77+jPxWT27j3P2eb1hsrJRhbuubnodyz/oS8tTJLa+A7E91tZgV4GkkTCpIP58x0gGFka +sidebar_class_name: "patch api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 multiple user-profile contributor relationships' (patch-user-profiles)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Update multiple user-profile contributor relationships

+ + + + + +Update multiple user-profile contributor relationships + +## Request + +

Body

required
    user_profiles object[]
  • Array [
  • ]
+ +Expected response to a valid request + +
Schema
    oneOf
    user_profiles object[]
  • Array [
    • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
  • ]
    • job_status object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/patch-user-role.api.mdx b/docs/api/nerm/v1/patch-user-role.api.mdx new file mode 100644 index 000000000..e5f12d8b9 --- /dev/null +++ b/docs/api/nerm/v1/patch-user-role.api.mdx @@ -0,0 +1,47 @@ +--- +id: patch-user-role +sidebar_label: Update a user role pairing by id +hide_title: true +hide_table_of_contents: true +api: eJzFVtuO4zYM/RVBTy0Q557MbIA+ZLdTNEX3grn0ZRoUjE0n2nUkV5JnxjDy70tKue1mdpB5aRMgsUzSOuQ5pNxIU6IFr4yeZXIiS/Dp6s6hvTYFypbM0KVWlWwn612ZgUcBoiIPYclFlKCs0kuxqIXKKMDD0snJvdx7ODlvSYv/Vuj8W5PVctKEpbJIG3pbYUumRnvUnk1QloVKA6DOZ8e7NtKlK1wDX/m6RMJhFp8x9bRbaRm+V7QLWXnPf3jPM10J8MHRec6DHHNj10BYZFWRw4bA0xPP8yVnrzzvL/c13IQP7Q8W1ujRcnkaqWlBbqFmSsfKr04KPvtVmFz4FYqYh/BGWKTd8QFbogp0tISxIsOCni1bJ6U9qd0PsLckPsG6DNh7/eE4u1wMEkj7b5JhtzdKLnujYZIhDIeDIVwMcqC8Aq+uNNrFmva7Xf77NoOrp5JwYyZ2rpwCiAcoFN8LspD/hwLOIZQThOyjLupYTqKxej5urfSfqJdE4WTQpyU8HS9Pn/JfyS/p7wU4fI6et5CJ68iCSESlYVEEhlLDWvDYfg03RuPHPKj7+9LvYM10IP4PDt20fuz3F3uFba6sNdQym3lMYvRcEjPCZzUU4gbtA42dEEPpUKdUVpP2jKbUVqCzghb4lGKIdK9K7mU1IW95imwq1ugcLFHE+wseldzO0f+46W6MtbVwhmbEir0eCZV4tIaI3uwoZJvZj2kGwUNjIjt73btOo7INWVwoRZw1lS3IaeV96SadTkP5gvYfaABt2po4IwCmRmwT5x0oFQU/gFWshJDawT3ml0NVsOYgXWNqTkbWbXAXPN8EOKeWTAArqnKekrOczZzxpZVVvg4AFwgW7bTiZO7nx+Ybrn/Ecey0p4OTktspx+voRHfixW+7Brk1X1ATDPr9pTaVjZehZZjq68P5dLVj5Ltpsm9ZSdPvcpSPh8nooneRDEfjfrIY5GnST9+MB/l4DDmM5VHfnhfAUJTODe/FzMVq9trddveoMT5cXb8X00+z07KTqHZGkYIWC+RTOpQe0pRUKEj/Ym0yldeCCTaV46FMxSCrUFqEuqB+UCS6NamP24MaAmloM6jtifV+dhuwlsb5NegjyxlvB99gbg7Nd9abRWTc45PvlAUoniBR2s22D+4PjDkKmFAYSWlFQNnWNAtweGeLzYZvE+GW1Tc/yD1oMVOOr4m3HAqHL2D+6Xp71v4sXn9OP5vN9iboOjRhUfGKLr9gHd8VaAxSQnSakMYZbDS8i5CSWw4/BJ7MM564MWKa8gx80Xd+NG4+TW/f/c5NtX1/IxVxkIVH1jn9TuTf9KWFiZM1vOTx/UYWoJcVTUDyiQ/mz1cIAJJt +sidebar_class_name: "patch api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 user role pairing by id' (patch-user-role)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Update a user role pairing by id

+ + + + + +Update a user role pairing by id + +## Request + +

Path Parameters

Body

required
    user_role object
+ +Expected response to a valid request + +
Schema
    user_role object
    = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/patch-user-roles.api.mdx b/docs/api/nerm/v1/patch-user-roles.api.mdx new file mode 100644 index 000000000..7e036d732 --- /dev/null +++ b/docs/api/nerm/v1/patch-user-roles.api.mdx @@ -0,0 +1,47 @@ +--- +id: patch-user-roles +sidebar_label: Update multiple user role pairings +hide_title: true +hide_table_of_contents: true +api: eJytVW1PGzEM/itRPveF17JV2oeCmFYk2ARlX1g1uTkfDdwltyQHVKf+99kJlGNlrEhrpd4lflI/th87jbQVOgjamnEmh7KCoOaXHt25LdDLjszQK6crBpD5ssogoCjrIuiqQFETUjiCigq00+aajwSgx/BKroxeTjvS4a8afTi02UIOm7jUDslncDV2pLImoAlsgqoqtIqc+jee/TbSqzmWwG9hUSExsbMbVIG8VY4jCJq8kJV9/kw+n7HgHCwIqgOW/t//obMWxgcOizC5dSUQP1nXBFh2kqsNscxoMyyBgw4FQ1Zl6O7QfvxwGn1ljU9Md7a2+PGyRscPFUWFmXiCimAFiDsoNO/FKsh3JNwa/JpTPdfTtkaUQv076sTO5HKaoth7jfghZOI88RNdURuYFZG7siVpLWDv/7Iem5iSEz76Fu/vjIpujp2zzq+C2H8tiDHxcwYKcYHujvQfz1A4DkPtDFXFGgptDiYraIEPCuNJ/67g3tYvsst1ZiNRovdwjSLtz0h/IsxRJHxH4gNwogl6YZ1bCG9LDHNG3RMrce8sCXYlRLbZ1chgEhDmtOy3WrAjfcyCj4WoXUH2eQiVH/b7DYUKJpxBicueoXKRb7tA7FG5+1BpOnwHTrMIUs+u4Cm0HGgIcXOrEpVdm1STCBeG8AK819ecexZT7QPF5TiQKfNTtdNhEQnOEBy6Uc1xXE3b5gtOfeLRBq0qwUFxtBFG6wSinfTy+anHJ/YWDdGg308LW7v0Grueq3z+PCOPn4rxcqZdpfEkd3P4sJ8P9rr7B9sH3b39wU53tpur7o76ONjNBwPIYSBbM2rTA6tBtdkBagUaqya3zJMLnZK/3dvqbbVa6Oz4/FSMvo3Xq0TyezIKBUbM4p0SKwVKkV4FdYoobabzhWA92NrzYKPckVVoI2Ia0dxpkmdJOuVGotZBGnxMykTByNPxJGa5sj6UYFqWja60F6yb50bd8EJMIgn4EPpVAdrE64O7oXnsmqt2kUl3c6LJu00zA4+XrlgueZvU4Viq0+feiEqlAwgZCY71cYsEkUeJYnfCvhle1PEq/HOu8ORLJ0aKZ9Gb2Gmr7b+NJkdfWOGPFzrViA85uGcZ0e9Q/qAvLWyacPHW5/1GFmCua5pEhEl/zJ/fuJHuKQ== +sidebar_class_name: "patch api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 multiple user role pairings' (patch-user-roles)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Update multiple user role pairings

+ + + + + +Update multiple user role pairings + +## Request + +

Body

required
    user_roles object[]
  • Array [
  • ]
+ +Expected response to a valid request + +
Schema
    oneOf
    user_roles object[]
  • Array [
    • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
  • ]
    • job_status object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/patch-user.api.mdx b/docs/api/nerm/v1/patch-user.api.mdx new file mode 100644 index 000000000..d0857596c --- /dev/null +++ b/docs/api/nerm/v1/patch-user.api.mdx @@ -0,0 +1,47 @@ +--- +id: patch-user +sidebar_label: Update a user by id +hide_title: true +hide_table_of_contents: true +api: eJzNV21vIjcQ/ivWfmolCISQuwSpUrlLqqa6S0556ZcUIbM7C77s2lvbS7JC/PfO2LuwsJDCSZVKJILt8bw/M+NFoDLQ3Aolb6JgEGTchrMnAzpoBRGYUIuMzvDkKYu4BcZZjqdsUjARIY3lUxMMngPaNMGohQw0T8HSavC8CCQu8LKjFdILmDV431wxFTM7A6Ym3yG0zCqmwWoBc2ix3EluMaVZBAnyxvsa/s6FBlTZ6hxagQlnkPJgsAhskZFEg7flFCljpVNucSfPnRbwxtMsIZLTXv9DdDE5a/Owd9nud0/P2xen5/12BLzfP+vzj2cxD5bLkZcGxn5SUUEitoWHSlqQlo54liUidP7sfDdk3KKpmzcSdck0ed8KMHRKPvx3KjTiACu3VXzVwsKdTIpqY+2GaPIhvoCLSfvDedhr9z9G523ejSbty+4kDPtwGcWXcFTEKFA+ZsGyVWZAU+NNfo/IyVHWNUsLconbRkboQ5G8a7un2MW6OlnzthjPXw3uZkpIexKqlGR41k0RIPOU0vwWMBixSKCEyC3wMARj3HJEkmOeJ6TLNuWWTsifHJj7w7Vam9eWLvi0HB8W9n1BKrkER8edfCJscmAEPWldyBUmYWiVM8VYbnPznnuHoRVzYnAlDJ8kmL6jbTEPjkllV8N/JQeUlqipkIep7Uk3M++L20M+U63ybOxv71S+yc9dYdWVDfWiVEiBJxx9MnZ0rSuETEII92usOCufB5QF7TPcog+h2mRKGl8Iet0u/dsUf/2Wob8hYhUpAZOzOU8E7bkyFvxPKxaP1KpAobH57nvowC8gp9hFBmc9XPK3+rLBZXf5OaKc/IdVYT+4fhQt+/OeTrix472wWJlNhbttRQplUO7q7gyVesGwjsnADPNszO2PM8s0xKCxS40TLqc5n+7yxDYaeis09HcB4BOP2L3Pc9ZmuSTHEAawwGc0O5wck/1Kwl3s5pjtDK9UupEOWn/Q1WVrP92fROXEXGutcDhajrwR57uMuEH9sO8l7AH0HKctdwfNwQ6ba4noVhJNm3EZYdQZvFEs8KY5yrj3QQsksqnZkKWY2Bgp5vcnGCNXiT19vdY9KK0LZhROgzOiekWt2KtWLqhlCOlMreZOUoLGw0HQcfNkZyGiJW4a5wU/UOYaQRvMrM3MoNNZoKlc2lsE+fJEYrhQtioAqJ93eCbw8pxrQUngobQi96ZVuORhCqFqFnNH7gYTxo0RU/I9JVNuLNqlyZAR6RfmOF8VTsEJcA16mJMdz6P68QO53utRJ1pFgowKylGW1p4Id/yP3ypMPaoXkKgGfv9SqFz7nw4pFOX79bB6XQVjXaqpqB468pXDe20MW5XNXfNTVSgb9bA+wxwquwLOaoBYV8R14SuL2apdN7r1wQ1XyFiReyjPfOxPT7on3Zoit9f3X9nw283Ojl8dspBLNnFziUsU3wcYApWlKhJxwSgdFQ4w2J8xdHjKhGQuiiDnAtGRIkwIx4hcwP5NSpVx+Hrz6HTNlLEpl7WT3W+zDTUX68Kw7ynng2fhzXayhPvpx8FtUcKyeua1goFwo9kMNaHtxWLCDTzpZLmkbcw/TWAYrdHnoBFVfWoQ88TAOxr+dF++X35mx78NdxpSbnJZuJqQ5LTCny9Q+PfpkprnDFsU4QSV9QefvUptGthrFxuVlWq/vzF0nfFd2lGt8H0bPn7+nTBevi0xTeiS5q/UMfF7EPyFf7hQvsa7ByjtL4J11ww8Y/r8A2UIZ84= +sidebar_class_name: "patch api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 user by id' (patch-user)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Update a user by id

+ + + + + +Update a user by id + +## Request + +

Path Parameters

Body

required
    user object
+ +Expected response to a valid request + +
Schema
    user object
    = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readonly":true}}>
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/patch-users.api.mdx b/docs/api/nerm/v1/patch-users.api.mdx new file mode 100644 index 000000000..a1449f60b --- /dev/null +++ b/docs/api/nerm/v1/patch-users.api.mdx @@ -0,0 +1,47 @@ +--- +id: patch-users +sidebar_label: Update multiple users +hide_title: true +hide_table_of_contents: true +api: eJytVm1vIjcQ/iuWP/PWa3K9IFUqd0lVTr3cKS/9kqLI6x3Ad7v21i8kK8R/74zNwhIIJVKJRLA9nnnm7RkvuanACq+MHud8yCvh5fzegXW8w3Nw0qqKDvHovsqFB1aGwquqABbWUl7MHB8+8LSedLiFfwI4/9HkNR8u41JZQO3eBuhwabQH7elIVFWhZLTe/+7IypI7OYdS0C9fV4B2TfYdpEdDlSWsXoGj02RuKyasFTVKKQ+l++/rKm/JOG+VnqHM1NhSIDQeAgp09rA/WVT/VRd1swHPosRg4I08ez/9AB+y7vtz+a579kt+3hWDPOteDDIpz+Ain17AXkzHl8xMmZ8DSzCZN8wCooEFblkWYsz5qsO1KOEQ4l19d6gpSraRlTXFKm6jIgyuKo76niQOqW5Otro9Jvo3h7uVUdr3pCnJRlK9bwJ0KKlUrgGTMVUFUKXh/jUIKcG5uJyQ5anAMsOrLyVfYEL9FMCQDrewdq+tYvJp+Xha2l9L0loLf3PeKSbKFydmMIm2jVxiEUpvoivOCx/csfCOpFcLUnCpnMgKLN/JSzO3UUnj11781hrQWmFmSp8GO4nuVt6fcQ/1zKwJ1WO6fRD8vr54hTVXduDlpdIKTwTG5DHKdS6xZQrq8LTmq23MOVVB92fcih9qa1cZ7RITvBsM6N+u/avnCgMOOWtEqTMFW4hC0V4kOP4GLjMavk4xN/u01MboMFKvS3w2GV9Nkgdnh0B/FDm7SdhYlwVNuSfc2JUYNw+9/xfxWMdwfKarx3D/RVLRzJW1hpxcO3F+yIkx4kOyKtgt2AVYFu+gO0iLwWrMiNHo2lzoHAubwbOEeNO9ybnjswHI5D6yESuRo8QMWNrPsC5j+yT5doHeGmtr5kwJfk5ST4iKPVmDlb4pQjozm5lLIISf47LfDFYXA+BiDoJFzuZz7ys37PeX6KXQ/hopfdXTmCk0a2oA4t++qBReXgirKP+p1zbiyauGXYUsQZr95ovicZAw4ZyaUdipjoLz6JIlHyaETwach3UEmIGwYEeBXHiYtI9vKeoJR1tokwRyiryNYrhOQriTfvzecPOd+QEaYeD3r7UJNv2MfU4Jvtm+Oq6aPGxeCQ9p4J86pNOwbQ/Ozdw8NPGagbc3rdpT51TbTddsKH/L+FtiX7PyhmD3+PU0ipxg7JSeGooUlVpK/0+9QW/QQnJ9dfOFjb6ND5J0c8ik0CyLoyTWShroDNuUlSZX05pRRRqcOciomD08ZUqzmEjQC4W9UWKTUBdj3wIyLoFaJ+LL+C7muTLOl0K3Tl57lO4AXW6J4fVXbMqgh2ffrwqRhlbsuuW6MVsv3DnioI3lMhMO7m2xWtE2FqClbphs2y82A14AkWNFUB3+ABThnxKgLr1gYrcWIT5iX7IW8Wq6MZLEdEdlJy1S+Ta6+/QHNdH6FY5JoEtWPNGzFr+H/G/8w4VJ/Bmf6rS/5IXQs4A8hzJJMX3+BYwWL1I= +sidebar_class_name: "patch api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 multiple users' (patch-users)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Update multiple users

+ + + + + +Update multiple users + +## Request + +

Body

required
    users object[]
  • Array [
  • ]
+ +Expected response to a valid request + +
Schema
    oneOf
    users object[]
  • Array [
    • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readonly":true}}>
  • ]
    • job_status object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/patch-workflow-session.api.mdx b/docs/api/nerm/v1/patch-workflow-session.api.mdx new file mode 100644 index 000000000..e8c6f7663 --- /dev/null +++ b/docs/api/nerm/v1/patch-workflow-session.api.mdx @@ -0,0 +1,47 @@ +--- +id: patch-workflow-session +sidebar_label: Update a workflow session by id +hide_title: true +hide_table_of_contents: true +api: eJztWVtv2zYU/iuEnjbAju9OamAPbpehGdY2iJ31ITMEWqJstpKo8pLEMPzfdw4pyZLstDGKYS9OgEQkz6G+cz8it57ImKSai/Qm9CZeRnWw/izk1ygWTzOmFCx4LS9kKpA8QzIgus9Cqhmh5CknJMpRkuWG8BDoNV0pb/LgNQmUt2jBOyRNmGYSSbZeCgPY1PLx1GFYH7zz5nciIqLXjIjlFxZoogWRTEvOHlmLGIuoRYQkIYthb+CX7JvhkoFUWhrW8lSwZgn1JltPbzJ8owLudAWUkZAJ1TBjjEXBnmmSxUjS6w/H4dVy0KZB/0172O2N2le90bAdMjocDob0chBRb7drlVJIkxZifDNMbg7k+MzjmACVFSWQDGCHHQc/PNQnj4gyQQCjyMQ1mSIaq2NCLYWIGXU2i6iJdU662y0cO1P6rQg3yNLUUCBSzVKNSzTLYh5Yv+h8UYh8e/guZwl4VSbRizRnClcLKfxcihM4QP0/tM+ulIPJ0xkc6SELS02CHnuvmIThRwYIIx6zckytGexwsbMC4PKrADR9YA6mz/nBDbg6tPsTesmS2QXYEcZ6fUE+pfGGTJ1llsALbyF5LBY7KK+GTVXAUSkp+iPXLFGv0tqLqNVPw36LeaaOWmmqzVFghW1oxv3ckuBbKfoR+KkUjwx1TAHDKnWPGmQE3OnK18KHjaX2i3fB8vR+/r49m0/n97NefdivDwf14bA+HNWH4/rwsj68qg/fIEoD4Cqol6gTPxCYe7SdgYALUJE+qMwPjQtJCBlYiYVyJFVyYSSYwadhdcSeIairExAGCU+pTZLFnMtA6KnlW0DVSsROtxEFq9sHE4MDuGeePnJtU0RhjTikmY8G4aGlSBmqO0UQgFJsGPPzlNeczjOgndY84vYxA9wovTMyjatTVm2Je20xWZe/OVvqoblQ1UdzrdRLuYD4XVEspnKdNMCgLipDJ1bQ5C1CVUHVCqrsuZ/XZh651Wcx4QLGD9Y0XbHavICkjlsHLDSyugQRtVrZhFbM7AVEctCqjbgClnXA0iX3CyoHbM0k2Zf9o8uz7hnx2kclwC8akWujEmBW4rImkOU7lMSk1ZB5otxGOViqsk9ZToqdFtWavo+Ync0Uki+NZupYlQJH4mgwGt/W6lU9Qe0qu8Ma+JlfbutjKp1YyXhAcA1jDDR+QNLtdXqjTr/b71b077R8QHubF4+P2HS0vATKPIfX+yewtWYMyn1IanPzNZf1Kc91BXYbyEEvbIxV8QDMKXwFmv2Eg7LfeAddlqe5tiZsNKjtAS5bCshZGbSZzkz9bhf/1cvY9XNmvZUUpNhJUgLpheNcEXX/Wy/0uoYCslCIddW1biC4Oc4Hie0vlq6goZ4M+jCkz9XhwS7nRuzciJ0bsXMjdm7Ezo3YuRE7N2InNmJlGzY81nm9pSG5c75H2sSktgZB81X4wcUpbZdI2afInh82faXAdpPanu5PZMUTupfo/kYq+5prKYWEErhwQoyOCXED+CT4IZkx+Qg6sTwgjmTaSIgFAtXXpODuIeRmwp4DZjnVScJ9v0Nk+MpDZFOSgBXoihE3v8TCj6eMjr4aeTMh5YYokTBoH7A9AFTkSQqMocKEuCbKI2EEgceyE6/TbGlVZ8vDHSYJqxF3qGtkDLRrrTM16XS2IDZNNfrP7gLKTVFtLsD0HWgmgPmRSo4O4cK6JHdi5geZHg0ScM/DNs6SEzyCJUVOso5lIG8lkGV39vRTsQBqid5YgEtGJZNTgzI9LKrLMzSDw1ElKq2CQnn5yas9cbVE2DbYhz+K5m0uvrIUYMDf3zZQxdwjnhZ7aPG7/Vns9T5pHfteqDXl3iCiV6NoPGyPLnuX7eFo3G8vB1HQ7gdvxoNoPKYRHXvNzvx0rlzYvOuuNtmv3avW/D68jmux7z5rDVWjOpwz+3+W2XkaCdQxRrKLrt5F96JbyZcfr+8+kOntzdGvqWKRBDTFDxCjXCi6jzYCaZEkIuTRhmDAC6PwMxyCA1YJT4mNEwbtLOQibOMwa0KeZPCZjqDyS5YPN3MbRplQOqFpZeXHN1M1yNt9Sn7NpZYLCfSwThZTjmXFJbptnhwfDuIXPxEm3DY+a0CLJNvtkip2L+PdDqfdNRGmpJArzID7y50Xsf7cJdJROb6yTXl9BXXTIIWHabFIzCdC/OUuv1z6lZx+dXcUYfH1nG6qEAvk+KGMxwFrRkNIWQjWLbxzkNpzZN8zHhRgbBEcxzTAov1d2kWlPt5O5+/eY/rPb9XAv+1NIMUOGP9OvH/gFwbCtQL26g3nt14MbbGBkg00bmP8+RcRr2rw +sidebar_class_name: "patch api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 workflow session by id' (patch-workflow-session)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Update a workflow session by id

+ + + + + +Update a workflow session by id + +## Request + +

Path Parameters

Query Parameters

Body

required
    workflow_session object
    attributes object
+ +Expected response to a valid request + +
Schema
    workflow_session object
    = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
    attributes object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/post-advanced-search.api.mdx b/docs/api/nerm/v1/post-advanced-search.api.mdx new file mode 100644 index 000000000..238158092 --- /dev/null +++ b/docs/api/nerm/v1/post-advanced-search.api.mdx @@ -0,0 +1,39 @@ +--- +id: post-advanced-search +sidebar_label: Save an advanced search query for later use +hide_title: true +hide_table_of_contents: true +api: eJzFV21vIjcQ/iuWP/N2cOFapLSibU6K1LtEgX5KERp2Z8GXXXtre2lWiP/eGS+EJXAJ4a46IpG155md8fiZF1bS5GjBK6OvYzmQuXF+GC9BRxiPEGy0kA0Zo4usyhlEkBEsUYAWsIEJF3DinwJtKRJjRQoerSgckq6HuZODe/kMLScNaZFUnP/NxKUcrMJSWSQvvC2wISOjPWrPIsjzVEXBy/YXx16spIsWmAE/+TJH8svMvmDkyWRu+UxeoQu6G8PTjeFXFVKYYVqDOW+Vnst18ChW7MTUFim6KXgSzQpf6W3gYC2U9FLlMasc0OVNQiE4tOuVT3nj1ppEpTgm8R29uNklY6+iRx584U7HD7fOssoonOkMxT/oas9Qu45fUbpT7mF7lsl6vd5J9tnI8vBh+rjcaFcFv9vp8L99pl495mSFOLeFCm8EiCWkivcC++SPI5qKD1nWkJRAGZAzsigIwMeE+EanZZUWdO7iuF6m9J+o554M97q0hMf68uAtP5zlb+P4mQw/i99nsPskbr/M7A2vSZ6hX5htMWbWAN+ibD8nWEM6tEu0LoS9sHSdcuF97gbt9ooYDdp/hgzXLW00ZnlqSsRWZLI25IqUl2AVzNLNtT7BqzRKoEiZhBBlGJmDHjAOcKEJL8A5NdeUZZRcUeG8ydDyYSbsX1RY5cvg4Iy8Rjss+DD3k7p4xBlW+VEHPUWUD8WnDTBaVyDaqR4+bjNmbB5Qkxv0fVmawlaPkmPKyXy36zdXj0ABwa+k7SY3drn1UkrsGP+c4KyX5RRlsj2t2qyxhLu8DNFPC1bqJfDTRdJ/37z48O5D8/1Fv9uc9ZKo2Y1+7veSfh8S6NfZdZgZJ5kZRl4t8ciL9oi8d9SKx9MNfIyP/qPCNH5SOAbm0nTakU7yekRcEtXifM85pb+b00RZUgdb7jjwNTvHoN8en19q4RmbOBThnaWtBBIfEsRzt6kJep3z47hlHqa0+T+zQOkoLWL89RsS5anqfr80PBbpGyrAkKZsLdR3aok6MVxFuDJX1fJdq9Pq1BrC56u7T2J4e31YVhcotkIR0Yw9Qx6jQ2mFKELnaPCORWZilZSCC7gpHE83VOxIKpQWoe6hXiprdEZTTYuM0EiDNP2wUzpUePnpehzKIneYDHRN8rbpfs/91W6SeuuPhOrKPNWYdp6C0jyHhIa22nS/+4M6Tf1jwf2RRKvVDBz+ZdP1mreDDe4xux4XOg4p0BREecE1+wEJIn+vHG5yza6x4WAMZF5VGkO6hty/iJ3UWvjtzWjMjWrzG4dujnUs/MuTHX0P5N/0RwsTghh6YNjnLqTnBcwZX72XP/8Bb4S1lA== +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Save an advanced search query for later use' (post-advanced-search)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Save an advanced search query for later use

+ + + + + +Save an advanced search query for later use + +## Request + +

Body

required
    advanced_search object
    condition_rules_attributes object[]
  • Array [
    • anyOf`, `<`, `start_with?`, `end_with?`, `include?`]"} schema={{"type":"string","required":true,"enum":["==","!=",">","<","start_with?","end_with?","include?"]}}>`, `<`, `after`, `before`]"} schema={{"type":"string","enum":[">","<","after","before"]}}>`]"} schema={{"type":"string","required":true,"enum":["Today",""]}}>`, `<`]"} schema={{"type":"string","enum":["==",">","<"]}}>
  • ]
+ +Expected response to a valid request + +
Schema
    advanced_search object
    = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
    condition_rules_attributes object[]
  • Array [
    • anyOf= 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>= 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>= 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>`, `<`, `start_with?`, `end_with?`, `include?`]"} schema={{"type":"string","required":true,"enum":["==","!=",">","<","start_with?","end_with?","include?"]}}>= 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>`, `<`, `after`, `before`]"} schema={{"type":"string","enum":[">","<","after","before"]}}>`]"} schema={{"type":"string","required":true,"enum":["Today",""]}}>= 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>= 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>`, `<`]"} schema={{"type":"string","enum":["==",">","<"]}}>
  • ]
\ No newline at end of file diff --git a/docs/api/nerm/v1/post-attribute-option.api.mdx b/docs/api/nerm/v1/post-attribute-option.api.mdx new file mode 100644 index 000000000..1a9936dc5 --- /dev/null +++ b/docs/api/nerm/v1/post-attribute-option.api.mdx @@ -0,0 +1,43 @@ +--- +id: post-attribute-option +sidebar_label: Add a value to an option based attribute +hide_title: true +hide_table_of_contents: true +api: eJzFVdtu2zAM/RVDz7k1adItwB6yoQMCrBd02VMXFIxNJ2ptSdMlS2Dk30fKubUpivVlcwDHEkmZPOeQroQ2aMFLrcaZGAqjnR95b+UseLwxvC8aIkOXWlmvhmKUZQkkSygCJl4noBIdTckMHJJpF06BHuZODO/Ffm/r6sS0ISz+Cuj8Z52txbCKS2mRsvA2YEOkWnlUnk1gTCHTmGX70XESlXDpAkvgJ782SGnp2SOmnl5qLNfkJTq2KnzYv/1Bb2t4V5DMjgIc7ao5BeTalkDZiRDIYdMQJ2dvXTdk89IXvPUS2k28GApnCJX65d1Oh/+eg365MpQowbtzjdAzC5L3IpLi/4L2NzhxqZDdqGJd00y1h9fjSqm+oZr7hRj2urSE1fHy5JR/xFizu+fsvNM/pWmsakakMsHHg0r0C71rLcYMuAbRfg3ihnBol2i5ZyoRbEGOC++NG7bbFfEKyl9DiZuW0gpLU+g1YivVZRuMpOAlWAmzombj4F5nmUMouHhIS0z1SVNPonuiyD8B5+RckdZIYmlwXpdouewp55cGK/06JjhDsGhHgQu6nx6bv7PO6jyOnfZAc1FcbXSjde1EO/XD1x1TE/2EitKg+6e1DrZ+jLiypO8OE+RyBQQIviHeE4WIXg4f+vngvNm/OLtonvcH3easl6fNbvpx0MsHA8hhIA4yOZaHVLnmQ5ms2njW6rQ64iCc68u7q2R0Oz5FeoHJzpikND1nmARXow1pis7RSM2SUmcyXyfMqQ6O257qJytJK4lQoFpKq1VJ7d6il1CvI42FWGkkXVyNJzFXFl4J6sjyjgn+LPfqMF/e9RWoSfe48m1TgFTcfFHd1bYd7l8ljQS14KYhc1XxsT9ssdnwNtFuWYPTg+ijBCmABgMpieX5hOQivtQZNyecBLtTwtwGL6fjprGLGBEJxr/pOz3q69ub7xNW7vYzRrxxjIXfPOzoPhQ/6bfXUWyKuF+JAtQ8wJz963P5+gP6FqM5 +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 a value to an option based attribute' (post-attribute-option)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Add a value to an option based attribute

+ + + + + +Add a value to an option based attribute + +## Request + +

Body

required
    ne_attribute_option object
+ +Expected response to a valid request + +
Schema
    ne_attribute_option object
    = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
+ +Invalid input + +
\ No newline at end of file diff --git a/docs/api/nerm/v1/post-attribute-options.api.mdx b/docs/api/nerm/v1/post-attribute-options.api.mdx new file mode 100644 index 000000000..32fc167c5 --- /dev/null +++ b/docs/api/nerm/v1/post-attribute-options.api.mdx @@ -0,0 +1,47 @@ +--- +id: post-attribute-options +sidebar_label: Create multiple new option based attribute values +hide_title: true +hide_table_of_contents: true +api: eJytVdtu2zAM/RVBz7n0mm0B9pANHZABa4s220sXFIxNJ9psydOlrWHk30dKubVNC3RYAiSWeCgdkod0K02NFrwyepzLoayN8yPvrZoFjxc17zvZkTm6zKq4JNBni+BRVKH0qi5RaLwXJhrFDBzmAtYniDsoA/IJHuZODm/k1mRWp0870uIfQvlPJm/ksI1LZZH4eBuwIzOjPWrPJqjrUmWRb/+XYzatdNkCK+An39RI/MzsF2aeLq0tR+cVMSCrxtvN7bfr27deYC005KQ8Vu6Np6l8x8HRrp6TQ2FsBURbhkCAZUeaVQafQpdk88qXvPUk+2SLH06Sq4lxuv3o4ID/Htfl7KEmppT/NVR4I4BroHgv5li+IZ1G40VBRXueihfIOgryZfBXM5PLaQrmZB//T5CLq0RTdEXQMCtjCJmpSGYee/+X/FjHzHxl19d4/2BUvObMWmPdJojTfUGMiZ/VUIprtHdoRfShcCz6YDUVh7ok6AXovKQFPmSYUvem4F6XJvKVz5mNRIXOwRxF2p+R9IRfoEj4jsQH4EQT9NpY2whnKvQLRt0TK3FvTdTqSo9sM+uZwRzAL2jV39tmHeliOlysSLAlIRfe127Y77cUM2h/DhUue5rqRiRMg9ijuvehVuR8B1axGlJfbuApxgJoEHEDZxVm5tm0mkS40IQX4JyacxFYVcF5CtByRFPmlwWrfBMJzhAs2lHgiG6mu+ZrrkHisQvalISD4mgjjNYJRDvp4ct6JEzMb9REg34/NibY9BgnAZf7ajsRz9ZVeWmC3ewZRvK4gPenxeCke/ru8F335HRw1J0dF1n3KPswOC4GAyhgILcTaTOJpkRA6cLwdVyvZD3sHfQOdlri/Ozqmxhdjp8nm+S0NooM6IWAIriUcMgy0p8g5YvK5KpoBJfVBMfzilJAVqG0iNlAfadIbhXpjhuDWgFpnsUcxLrLb+NJTBaLrwK9Y/mXt9OjINptH/7bqy4pweOD79clKJ4uSfLtqklu9leSZLbgXiJ72/Lx3225XPI2icGyMqfbVojCJAeEnPTFIviNDTNO3LsTZsFwYsXN8XSe8MRLHqOMZ9Cr2OlOu19eXE9Yz6uXNZWSfSzc0yb/DuVP+m60FVsl7reyBD0PNIAIk87lz1+TU/yM +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 multiple new option based attribute values' (post-attribute-options)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create multiple new option based attribute values

+ + + + + +Create multiple new option based attribute values + +## Request + +

Body

required
    ne_attribute_options object[]
  • Array [
  • ]
+ +Expected response to a valid request + +
Schema
    oneOf
    ne_attribute_options object[]
  • Array [
    • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
  • ]
    • job_status object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/post-profile-avatar.api.mdx b/docs/api/nerm/v1/post-profile-avatar.api.mdx new file mode 100644 index 000000000..f16d74659 --- /dev/null +++ b/docs/api/nerm/v1/post-profile-avatar.api.mdx @@ -0,0 +1,47 @@ +--- +id: post-profile-avatar +sidebar_label: Uploads a new profile avatar +hide_title: true +hide_table_of_contents: true +api: eJyVVVFv2zgM/iuCnu6AJE7b9LYLcA/ZrQNywNaizfYy5IGx6USbLekkOa0R+L+PlOImXXrdtQ+NLJLS95EfqZ00Fh0EZfS8kFNpjQ83zpSqwtkWAjg5kAX63CnLPuTx2VYGCi9AaLwXNvkK6J0DrL2cfpV7g5fLgbTgoMaAji07qemDDlIFuSs+0kLYnNwzfy9MKcIGhVl9wzyIYITD4BRucSAaW0CgX+NEgRWdTfEO/22UQ6IRXIMD6fMN1iCnOxlayzd6itZr8iyNqyHQTtNEFPgAta3Y5ex88kfxdnUxhPz8z+FkfHY5fHt2ORkWCJPJxQTeXJQgu26ZbkMf3pmi5St+vjw3OqAObKqbKijKQcj43iEBj6BO4CWeBIdyR0UJirJHVk7jiyRWSoNrCRX/MTBvjfYp+Hw85p+nqb16sHQRFqJ35dyC2EKleC/ykk8ogLWVyqNMsm+eD/n/+BtXvVwDsjNqKK511ab8MY+gQizJZ7InZpPnyLyDQtwmzGIoGg2rKvLJDZc04Og1TIzG6zKK9GdOPZq5jmn6h0O7wX/7fWGveM2Vc4aU3y0TicvnSMwJn9NQiTt0W3QixhAdEnzjNFXKaKK2AV1U9IEPOcZI/ypyL5cJ+cpTZDNRo/ewRpH2SWzr2JXJ/7h37oxzrfCGWn3DXveEStw7Q+XuenGyzfSDhjFw609l1o+LbKeKLnucJj6mI42NqCO5CcH6aZbtiDPo8IlmSTfSVDcCYVrEEdU9A6soeAtOsRoivYN74lgCdSWdB3mNuTmZPovoLnhUCfBerbkIrKrGByLomNGS8eWNU6GNAFcIDt2sYUZfl8fmO65BwnHs9FgSJiX3A4u/kxPtpMWHvlUW5jtqgkH//2pN49JScmKVLg2fyOlKFM5G49H4SJGfrm4/itnN/JQrVbM3ihy0WKFofOILeU7lFyQ8UZtCla3grJrG8+wgBGQVSosIBvVWUbVrKjvrkpSINFsY1H7if5wvIlaufQ36yPKLR+UJ3t1B8b98jFJ6Az6EzFaguGX7eZSUd/RQDeQ0Pgb7aCrfhjVKLrvdCjzSHOo63qZZ47jiy4PEYv0L5XlN6i6h8vgC7N9u96/F7+L1z9yzpPaboNso/KrhL1p+xzY9tTR+iBANWdIVg02GvxOk4YLDD4HPvVg87FLQLOfxc+R+MnZY+4+dfnN9t2Ap7x9KkhHH8MHx3MFhyV3TdT8A+vH1Ng== +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 a new profile avatar' (post-profile-avatar)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Uploads a new profile avatar

+ + + + + +Uploads a new profile avatar + +## Request + +

Path Parameters

Body

required
+ +Expected response to a valid request + +
Schema
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/post-profile-type.api.mdx b/docs/api/nerm/v1/post-profile-type.api.mdx new file mode 100644 index 000000000..c9392e6bd --- /dev/null +++ b/docs/api/nerm/v1/post-profile-type.api.mdx @@ -0,0 +1,47 @@ +--- +id: post-profile-type +sidebar_label: Create a profile type +hide_title: true +hide_table_of_contents: true +api: eJztWV1T2zgU/SsaPRMI0G67mdkH2mVnsrMtDB/bBzbDKLaSqLUlryQDaSb/fc+VbOIQh6aUofsQYEIsXeke3c9je8ZNIa3wyuh+ynu8MM6fWjNSmbyYFpLv8FS6xKqCJDD/3krhJROsiELMRykvxo73rnhz2PHBDrfy31I6/86kU96bhUtlJVR5W8odnhjtpfY0JYoiU0mAsvfZkbYZd8lE5oK+BT09boafZeKhEIoA3CtowWyl9jpKfUtai7wp5bxVerxy1IuJcgx/fiIZrWBmFL43j7iLVfJO5EVGG30y9ou0fI5jwUhjY6dtWqQuczKVxCozlWQ9bXSncWnsWGj1NZgCl8I5NdY5mQlzgGDJsOvB1spX0LKRyDKIaW+Wgd/rBvThtIDC67QsrrHWw34q+qI6x9CYTAodzDUSZQbfYVsnHyL6NJEElRnLtPEM+9XeZYt9CXJUKNMlSGFLoBE2magbipcfBbBiDKiud29VjYDJlfcyvbZQeK1S1wAhrBVTrFJe5q7NyyNjcwFovCxVSnZ96C/JaFuGbQFNeGABvlolw3IMA+LaaLvih4ej7puDNO3sHw5fdV7ty/3OWym6nf1fRgfi9a/D12+St3wA1col126qkyeZse9WgbC4G7tVfsJU4lrN10jJEE3CwzbD0stN7Lgmc1X6bVu3mbr/eyN7q/0WZi9dZfH2IF3OlY2sjvOX7Vhzpf+SeuwnvHd4gEtx17xcRY5tng36vQc6VUwu+ehZbLumMm5qNC0XYfIMgDQ6Vb3dUwDh54GR0AgA42dH8CIRI56fGqGX3wGtEuiQQCe04eePQjQTkyhBVfR/F5ANbD8am0QTUlCBBSL0dTnGSHChyolldNvghHWxhFTchkJ6UU7UctnozmMeeOUDvCY9nFdzVrrCaBdD/KDbpX/Lio/vCqQDdq9FmTegkTciUzQWSCL/SXxwM7+C+aYnOpvW1LXFsGF7B3+/YEJuDuvyIa7CX8Y+sCXEz0SIX5wAbwnvkwjvluBuCe6W4G4J7pbgbgnuYwS3c3BPcV+1sdp3ImVnkbyyDiu1GGaB2CaGto7n3pjSGi1PRuhzqxlWI+vrwJf/pKXznfVyf5NUUHNsrbGOzwfxEK/bDtEHPqtFxs6lvYHhwhocx0pfWg17oeKWeiJ0muFC3iUyrHTfdbjHi4YklavIjlgunRNjyeL4EH4MLo3yzZg6NxYEz5kcHIikboGK3VqDCJ7XLqQ5Uz/lJgyCkp7vLd0t7HAXzOCCJ0qbQWLifeF6e3sznFVo/xF5Pd8FR61p4i78vScKhcU3wiqKglgp78Xj2arnbFwkuUzMaioF8citI8eFvSmaSudxMEsnGRC+pLTKTwPAoURY26OSTnI1aE6fk+0jjqbQvSvoUHTaIEb8KAhhJH75o876C/NFasDA529TU9r4lZNByc1niwf8x7U3Vm/A4h1GfUPQvB9o0v41VLt6LrmgwtVAG2HdlCUuk8R6w8co3VXsbZvtXzWfB4ykpRVsut1Knd6wig7W9fcnHWe1vb38ke77QpeqGvyoR4ZCjHI25tH+bne32yiHH4/PPrCj035r76oncZeo2bDqEPRsIklQexiqHstNqkZTRqltSkdPMJAGmEUjYSEjpL5RKDV0R0pFEWVQateM+w/9i5AwVHhyoRsz616oLQGdLers+jdwMau9vPN7RSaUDgyIytesKnRXy1mJyJhQHcT4bDYUTl7abD6nYSQ0ZebVYFHOQnHBAimC6RE8XyQl7/uIq1O9LER7KgNnfNgLqFvFFUcJ9Y9HZQeNUn16cn5BlaF6fwhX0BorbumJDD57/B/8UlDEphReMtL4jGdCj0s0D8jEfennP56mxOA= +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 profile type' (post-profile-type)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create a profile type

+ + + + + +Create a profile type + +## Request + +

Body

required
    profile_type object
    profile_type_dup_attributes object[]
  • Array [
    • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"description":"The uid of the properties that are used for duplication protection.","example":"attribute-uid"}}>
  • ]
    • profile_type_namings object[]
  • Array [
    • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"description":"The UID of the profile type naming.","example":"profile-type-name"}}>
  • ]
+ +Expected response to a valid request + +
Schema
    profile_type object
    = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true,"description":"The objects UID.","example":"ptUid"}}>
    profile_type_dup_attributes object[]
  • Array [
    • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"description":"The uid of the properties that are used for duplication protection.","example":"attribute-uid"}}>
  • ]
    • profile_type_namings object[]
  • Array [
    • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"description":"The UID of the profile type naming.","example":"profile-type-name"}}>
  • ]
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/post-profile-upload.api.mdx b/docs/api/nerm/v1/post-profile-upload.api.mdx new file mode 100644 index 000000000..a82ef2b4b --- /dev/null +++ b/docs/api/nerm/v1/post-profile-upload.api.mdx @@ -0,0 +1,47 @@ +--- +id: post-profile-upload +sidebar_label: Uploads a new attachment attribute value to a profile +hide_title: true +hide_table_of_contents: true +api: eJy9Vk1vGzcQ/SsETw0gaWVbbhIBPTitC6hAYsNWegmEYrQ7kpjsklt+yF4I+987Q2otKVLd2If6YO2SQ/K9mTePu5GmRgteGT0p5FjWxvlbaxaqxM91aaCQPVmgy62qOYYi0rATIDQ+CPAe8lWF2vOjVfPgUayhDCi8oZg67UW7eFg6Of4ityNOznqyBgsVerQ8s5GaXugExYcqPqsGvzoCMPlNmIXwKxRm/hVzzwdZpLNxjT0R6gI8/RorCixpb1pv8e+gLBI/bwP2pMtXWIEcb6Rvaj7R0Wq9pMiFsRV4GgkhosBHqOqSQ87ORz8X7+YXfcjP3/dHw7PL/ruzy1G/QBiNLkbw9mIBsm17Tyye0vHXf/CZEhNVdJxOJfT/pTBLp6HzH0zR8BHfH54b7QkgT1Wh9IrK6DM+t0+5j6CO4KVSERwqPwnOKxIAzUZtPEdirjTYhlDxHwNztdEuLT4fDvnnMJvXjzUdhIXoQpMOSZKKxyIveUAB6rpUeWyB7KvjTX4cf7Dl8zWgeUYNxY0um5Q/5uGVjyX5TPOJ2egUmQ9QiLuEWfRF0DAvI5/ccEk9Dl7CxGi8WcQ++55Th2aiY5r+4KWs5H+L+5Oj4jHX1hpq3naWSFyeIjEhfFZDKe7RrtGKuIboUM8Gq6lSRhO1FeiipBd8zDGudC8i93yZkI88RnYlKnQOlijSOIltGZswxe/3zr2xthHOkFutOOqBG/TBGip324mT50xnooyBu30ss87xso0q2ixE/8w2+/7QUrSL2UlGGGUlV97XbpxlG0oBaP+JfKUdaCojYTIN4oBkkEGtaPEarGJxRLa78ER5AdSk7Eh5hbk59p8YLti2BDinllwTFllwnvhaJjhjfHmwyjcR4BzBor0KTPDLbH/6nkuScOwHPVWIScmtf/F7CqKR9PB71zlT8w01waD/vzQm2PTIDktWujC8I6crUTgbDAfDPYF+ur77KK5uJye9tpsUOWgxRxFc4gt5TmoQpENRmUItGsFZNcGxlRACmhVKiwgG9VpR8dmmWaYkTCSrYVBb9/84mUasLIUK9N7Ma+/PAyKbXWe8/kJOBfH46LO6BMU93xlaku7eZd2T43ibhO6jYHxwv5EAVix6WrLZzMEhGVvb8jCZl2XNzHYijQoqlONnapcFlA6f4ffT3fb6eSNefvWfJLkdBN3E1qHc0Bs9fsMmfX6w+b0K4A/d5a/AdJBscltKN90p1DecyhTya8LTn/JGuy1OXdBMLy26ytlt98KPXJZ7+8nYbm/up9yq2+8CahNewxvHfXu7R3aFtv0Hb1GSpw== +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 a new attachment attribute value to a profile' (post-profile-upload)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Uploads a new attachment attribute value to a profile

+ + + + + +Uploads a new attachment attribute value to a profile + +## Request + +

Path Parameters

Body

required
+ +Expected response to a valid request + +
Schema
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/post-profile.api.mdx b/docs/api/nerm/v1/post-profile.api.mdx new file mode 100644 index 000000000..ed36d39b0 --- /dev/null +++ b/docs/api/nerm/v1/post-profile.api.mdx @@ -0,0 +1,51 @@ +--- +id: post-profile +sidebar_label: Create a profile +hide_title: true +hide_table_of_contents: true +api: eJztWNtu2zgQ/RWCz5Zt+ZbWwD642yzgRdsEibMvXcOgJcpmK5FakkpiGP73naEkS4qcW5H2qWmQSuRw5sztjKQ9VSnXzAol5yGd0lQZe6lVJGJOOzTkJtAixV3Y+1NzZjlhJD0KWLYxdPqVFiuGLjtU8/8ybuwHFe7odO9uheag3OqMd2igpOXS4hZL01gEznjvm0Ebe2qCLU8YXtldysGqWn/jgQVbYAOgWgFWYLfE8KygZEldylgt5IYeOqWGFW6sRNiW6dBI6YQBVJplINB54AvoMJbZzJw6ymWWYGRmgRW3GKq5ZOXlhSSfOHOXC64TISGsYRm6hn4RrgAm4JSb1fO2Ui7DfCVlxiB+JmK6BD1MB1uwXXdyrVTMmXRZjlgWg5sRiw1aZRY0rzPLzanwsjAUmDIWXzYC3Qowv2dJWqSI39vVUe0Kozl1wRMBwT1EAUFoifT9nj/uDfqDPq0SZngMSFqyRdmSL5jwDk3AJQHmV6841rnmUJ4haawttkI3l2hexU6N0o8pvjFct8C85lyJplrIoVSKDwcIsxUWg1w6gotuXXOTKmny5Az6ffyv2dDn9ykA4CEpRYlV0N63LBa45tqY/vqOfWkvsvBCxruSV5quLbac5OoNmX+ktWKkw2HUPxuEoecP1yNv5HPfe8dZ3/Mn0YCN36/HZ8E7LN/sNA5o109cbuyWTocDuGX39duXo7p5AKsIzw1YBeOnWautTxgCvxb04gmiIndd6Oo2DDQq+Mf473Hr848PbBPU1VhY81jJDYirH0rHG1Pt467khh6404BcGHorfn4mrqUBBPY0rlI/AAvcrA5XzD6ZVyRdz4qkPeyxVEM37oGBUKKRyztmSGGigQCYeuj5vjfwF/5oOhhOx6PuYDzx+uMpEBA2VRr+bFyFidfheqOR18Q6OyoFkMwWHYAkazHFp7r096j8haPSGxyH5ejUfPzAQnKVj0HikUyydexGZKAwWdZl7sXDUUl+EQELtKurRDWXbvL+jUcPncfl/kEpZ+Zca6UNPSxzJ8annJgDPg2VS665voVouDPgjuY20xKGv5Lg2hbaKYYbfh9wd9K8yrmnBzpHk21kM5JwY9gGGtqtr5HksJtz+Xr/Xiutd8SohEPngNQdoCJ3WmHXlSnEPVW+wziOxaFMexVTGhcB45KQ6Rg2t9amZtrr7cFNJi1WyqErIVVgV+0470KqeywVcPiWaYEFkDf+UTx3q3iApixIoBDbpOXE8xENzC82GHcspMxY8EmjE0vEF2Ra2J0DuOZMcz3L0Imvy/r2NYY9x1EXOmYBnUJvnRg+6TshWMkv/ipJdqG+cwkw4O8fO5Xp/JJiLDHDV9V73HlFT7WnuPwZpWLv1gMFHUbs3TiajLzxmX/mjcaTgbceRoE3CN5PhtFkwiI2odVoryb4qblaG5/V64x7ZWnR928K/WkUKmSkMMbYSHlx+91+t1+jpy/nV5/J7HJ+cnSXmyRgEuYhyUzeCSwIgAvcUE9UKKIdwX5T8LwD7yZQm7BLhCSuTLm8FdD6CXAAkhTQEod3l1pFfp4vXBUjESRM1nZOfMJoYNxXlHfyc0feYFhDvTRmQrpHGmSSfUE3x08h+Fi3RSKCpf1+zQy/0fHhgMvQVhp7fFmRimtxOABvD9Cp2P7f+Q4x5Gi8BRpG8ThDAC0yxnGRn5gFSOBPyi5rXHl5cb1AZig+1kDs8Yxmd/iGBX+n9F/4Bzcqnwruiw6u72nM5CYD9gaZXC/+/A/OhleY +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 profile' (post-profile)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create a profile

+ + + + + +Create a profile + +## Request + +

Body

required
    profile object
    attributes object
+ +Expected response to a valid request + +
Schema
    profile object
    = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true,"description":"The objects UID","example":"profileUid"}}>
    attributes object
    + +Attributes that belong to this profile. + +
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/post-profiles.api.mdx b/docs/api/nerm/v1/post-profiles.api.mdx new file mode 100644 index 000000000..758a21cf6 --- /dev/null +++ b/docs/api/nerm/v1/post-profiles.api.mdx @@ -0,0 +1,51 @@ +--- +id: post-profiles +sidebar_label: Create multiple profiles +hide_title: true +hide_table_of_contents: true +api: eJztVt9vGjkQ/lcsP0MgJNA7pHtITzmJ6tpEgd5LDqFhdxbc7tp7tpcEIf73zthZFrJpqkjt24EEu56x55tf33gnTYkWvDJ6ksqxLI3zt9ZkKkcnOzJFl1hVspiEf1oEj6Kocq/KHEXZKHpYOTm+l4eleUda/K9C59+bdCvHu/CqLJIVbyvsyMRoj9qzCMoyV0lA0fvi2NZOumSNBfCT35ZI1s3yCyaebJENwuwVWSHpwWKjCdbClhSVx8L9+AQNBR5pOW+VXsl9pz56wYKFSts6HZkZWwD5IKuKFDrPnKQznAdfuZe2oq4KDtlV4tUGaWGioX680eJvhPA4Q1soTXFP65ienK/SBcEknHq1+LGtEnUaV0pwnLcMVC7ndA7YZE22j51cGpMj6FAGGVDS5TiD3LFV8HTysvL4YnghTRXnEvLbk0C3AoyPUFAhBRk++sXh2AVHcxyCpxLBMkZBQWip9M9758PeoD/oyyZhDnNC0tJ9KmzxiRPekXUdL96wrTNFqttUnKzN1sqeLslY3uEYY7938GeHtgXmLftqNM1ChNIcvN9TmL3yHOTaEV7cB4FFVxrtYnYG/T7/nbb89WNJCDAVtarwRoDYQK54LTS4fEMvG403GVViu2iegXRUH99X+mCWcj+PTly+hPs9pOIuwhNdUWlY5gF6YrjgPJ79XNATHSLygbe+hvsf1gpmrq011h2cGL7kxITwWeoiMUW7oYyGPeSORV9ZTUkxmlxbg05zesHHBMNO9ybnXudGZJNtZFeiQOdghSKuL6mhhV+jiPpHnS2nxtqtcKZAv2atB0IlHqxhBqjrkGWmHj+BnPya3npHA8aFELiQhcrmJF17X7pxr7cjP0F7Lvf9maZckWGzRTyjXPegVLR5A1ZxBUQWOqhHv56oTUJSUDe1ht4sqAseEoI4U6048FxJlfPklGUv5owvqazy2wBwiWDRXlXsxf38WDzluEccx0qHNLBT7G1QYw4OSrQSH/6qx83MfEVNMOj3j62pbHyUHExO8V0zeq8bjm1G5X099ZoR0Rp28iKD34bZ6LI7fHf+rns5HA26y4ss6Q6S30cX2WgEGYxkM+GaQfbSTDoaPc2oCeOkNU3+nwS/ZhLwmFc6Mxxk7qVY3+dn/bP+EUV9ur77KK5uJ+1GoPauhSIBLZYoKhebAZKE+EAQE4nCpCrbCm45UzmeG1SeJBVKi1CpqDeK2r8gHmCiImpCmivNRUx+nMxCITMZFKCPJK9cQE+w7hr6e/XSGnuOi6pX5qCYuyO57J4o6PRCu2Z2orXdbgkOP9t8v+dlajXLfT9viCa0PW1ASKl7ud2+4pbBRFjdGVtm9bwKF9bnDM0zJO64SpjVX9WdHxHo7c10xmzxdOemZPAeCw98N6XfsfyXvvRi4qgIF3Ne38kc9KoiSiedeC5/vgH7KEF4 +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 multiple profiles' (post-profiles)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create multiple profiles

+ + + + + +Create multiple profiles + +## Request + +

Body

required
    profiles object[]
  • Array [
    • attributes object
  • ]
+ +Expected response to a valid request + +
Schema
    oneOf
    profiles object[]
  • Array [
    • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true,"description":"The objects UID","example":"profileUid"}}>
    attributes object
    + +Attributes that belong to this profile. + +
  • ]
    • job_status object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/post-role-profile.api.mdx b/docs/api/nerm/v1/post-role-profile.api.mdx new file mode 100644 index 000000000..c9978177f --- /dev/null +++ b/docs/api/nerm/v1/post-role-profile.api.mdx @@ -0,0 +1,43 @@ +--- +id: post-role-profile +sidebar_label: Create a role-profile contributor relationship +hide_title: true +hide_table_of_contents: true +api: eJzFVdtuGjEQ/RXLz9wCgbRIfUirVEJqLkroU4qqYXcWnOzaW19oViv+vTNeCCCiivahXSRY28f2mTNnhlqaEi14ZfQklWNZGufvTY531mQqR9mSKbrEqpIRtP7JIngUICyB2mWDEonR3qp58MYKi3k8zi1VSds9LJwcP0rGiw3eyVlLWvwR0PmPJq3kuI5DZZE4eBuwJflI1J6XoCxzlcRDu0+OadTSJUssgN98VSIRM/MnTDxdSHdQRF7RLXwsXft9c+2JaJXuAR3FpRcEzIwtgOjIEAiwjjv50NPghPfKMwW5r+46PqyFK0mxhkS/1+OfQ92vXkoijKnYQoU3lIUV5IrnopTyP6l2igIcI6S3Oq+aBFPQ4e19hdJfUC/8Uo4HfRrCy/7w6JR/nLJ2/zVp573hcZ4mukmJ0mXw8ZAC/dJsS4u1A45Fdg80bkmHdoWWS6WWweaEWHpfunG3W1NGQfsbKHDd0UZjUeamQuwkpuhCqWjzCqyCed6kYwdv6GUQcg4LkgITc1TR0wgXmvACnFMLTS4jcyXBeVOg5XhnzC8JVvkqEpwjWLSXgSN5nO0vP7DDGh77oFe1OSiONsJo3IBopnn5vM3B1DyjJhr0/aEywTavUVA28/2ueVy9AAmCb9n21RtykMG7YTY6bw8vzi7a58NRvz0fZEm7n7wfDbLRCDIYyUODnLaHCSmdGb6O89doetbpdXpyZ6Cbq/trcXk3ORZ/iWK7KBLQYo4iuCYBkCTonACdisKkKqsEp9kExz2AJKFVspmI6qBeKWt0QbXfoUuo8JF6BJPS0QfyejKNXNmEBei9lT/u6AcR1LuW8xf/DY0nPL74bpmD0lyk0fz1pkweD3NKRltyFdF8Xc/B4Vebr9c8TXaw7M3ZrhiiNWkDdQxyGNv2GSum2RBuT/l2hueBWRz1y3Vru+OSMlH632Jne4V+d/swZUdv/tkoebzHwk/ugvQ9lt/oQwMTRWw6Ls/XMge9CLBgfHMuP78A7Huitg== +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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-profile contributor relationship' (post-role-profile)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create a role-profile contributor relationship

+ + + + + +Create a role-profile contributor relationship + +## Request + +

Body

required
    role_profile object
+ +Expected response to a valid request + +
Schema
    role_profile object
    = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
+ +Invalid input + +
\ No newline at end of file diff --git a/docs/api/nerm/v1/post-role-profiles.api.mdx b/docs/api/nerm/v1/post-role-profiles.api.mdx new file mode 100644 index 000000000..36290c799 --- /dev/null +++ b/docs/api/nerm/v1/post-role-profiles.api.mdx @@ -0,0 +1,47 @@ +--- +id: post-role-profiles +sidebar_label: Create multiple role-profile contributor relationships +hide_title: true +hide_table_of_contents: true +api: eJytVV1v2zoM/SuCnvPR9SPbDbCH9qIXyIBtRZu7ly4YaJtOtNmSR8ltDSP/faS0pOnSW7R3S4DEkg7FQ/KQ7rVrkCAYZ2eFnurG+XDpKrwgV5oKvR7oAn1OphEIA/4mhICqbqtgmgoVMXjYJLTKnQ1ksjY4UoRVvNavTCPXBFh6Pb3WYqCazfWLgSb83qIPZ67o9LSPS0PIZAK1ONByJ9ogR9A0lcnjreOvXuj02ucrrEGeQtcgE3TZV8wDO2QfHFow7EWuZbdftm7v4UAEHaNNwNo/8xpT7AA9R2yXDCwd1cA8ddsyYB0txdvz4IwPJlQC2ck/78ePZMk3nMzE4vDgQP4eVub8rmHGWKgNVAWnQN1AZWQvJlm/IJ/O4seSK7afkkeIeg74v4HvXKbXixTI8WPcz6BQl4miGqrWQlZF+rmrWWQBR3+W+MzGrLwT06d4fxJUdHNO5Mhvgzh5LIgZ8yMLlbpCukFS0YbDIQwtWS6MsxzaCmxR8QLvcoyW/kXBPS1PFJf7zE5Vjd7DElXaz1iCKqxQJfxA4x1Iohl65Yg65V2NYSWoW2albsmxZrdalDO3mRbCAcKKV+OHPTbQPubBx1K0VDFkFULjp+Nxz8GCDR+gxvXIcsHYu+sQR1zwMTSGjW+AjMggNeUWnoIrgeePdG9eY+72htQ8wpVlvALvzVKyL3JqfeDISEJZCL+8JRO6SDBDIKTTVkK5XuweX0nyE49d0LYWEpREG2G8TiDeSQ//bBp97r6hZRr8+7ZzLaXH2PpS58v7OXi+Kcfe3LreGUH6qIQ3J+XkeHjy+tXr4fHJ5HCYHZX58DD/a3JUTiZQwkQ/nEPPs2GZ80S0pRMGUsKU1lejg9HBTnt8OL98r04vZvv5Z2ltDlUOVmWoWp9qAHnOWlTcBap2hSk7JZV2rZe5xVnhU2WsiglCe2NYejVrUJqE2wJ5rgkpG6Wg38/mMX8ixBrszsn/fk89iKS/b8zfePMlmQS8C+OmAiMzJ/VD/7N1rn8pM4tvJa3FB32fgcd/qVqvZZslQqLXxX2DRLmyAULBqhOFfMNO+Cbmw7m4F3jVxhfer+NFBmCyOM1lJD2JXex0/8XHq7mo/OeLm6spNgS3vCm/U/2Zv7xwac5FOct+ryuwy5bnEWPSvfL5AXYO+V4= +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 multiple role-profile contributor relationships' (post-role-profiles)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create multiple role-profile contributor relationships

+ + + + + +Create multiple role-profile contributor relationships + +## Request + +

Body

required
    role_profiles object[]
  • Array [
  • ]
+ +Expected response to a valid request + +
Schema
    oneOf
    role_profiles object[]
  • Array [
    • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
  • ]
    • job_status object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/post-role.api.mdx b/docs/api/nerm/v1/post-role.api.mdx new file mode 100644 index 000000000..7dc1c8944 --- /dev/null +++ b/docs/api/nerm/v1/post-role.api.mdx @@ -0,0 +1,47 @@ +--- +id: post-role +sidebar_label: Create a new role +hide_title: true +hide_table_of_contents: true +api: eJzNVk1vEzEQ/SuWz2lSClwicWhRkYKgRW3gUqJqsjtJDLv2MrbbrFb578zYSZM2oQgOiERK1p7xfL034+20a5AgGGdHpR7qxvlw5SrUPV2iL8g0ImLBW0IIqEBZvFeUNQLMvR7eaFl6Pelpwh8RfThzZauHXVoaQrYbKGJPF84GtEFE0DSVKZLfwTcvHjrtiwXWIE+hbZB9uuk3LAI7akiiDIa9iFnx/lutaModJR/I2Dkr1cZ+QDsPCz18ecJLWO4ucQl1U6UDjbPekb9N3la9taF9g2hjLUW4QPY/MxWuy3eBUBTofVpO2ICF+rCBB5/Xa5/ibk4uNn5HH4igZXUTsPbP24HyNh2/TS5XK4nehCSSaI5OZC9tE6Y8c8VOjo/l7zHu58uGq4ul2qiq4JgFd1AZ2Ut4638M7WFkZ45q4Ah0FOglNygvbdVm9nGyf8WIx1aeZch/A/ADvK8OIXoGpbrKwKkjFS1MqwRq4cR6wP6fwOksXs6Y/vuQbQIa2cSV93J01fu13hfRSm7OiVKNJjmJ14eSGHF8ZKFS10h3SCqd4XQIQyTLdHWWU1uALSte4LLAdNL/UXLPsxDF5X5kp6rmroc5qrw/ZfBUWKDK+o/o4Iha5V2NYSFa9xyVuifHaK82EIrMbSazxADCTD1Yj2Cf0vcJgUgVSxYhNH44GHScI9hwwQxZ9S3jxE5di9hnnAfQGD58B2QE/cy2B/Wc0wxiJd0ERY2F27sPxkldCQEVeG/mUnRhUfSBEyLJYCLxFZFMaFOAUwRCOo2Swc1kV3wtNc9x7Co9QCBJSbZJjddZiXfyw7tN64/dd7QcBv++aV2k/KilkALv1fZ+Ot+gsB06aT48aevN3N8b77nZtx29beibJ+05Ee/Gzpz4ELByAV/0j/vHO/y/OL/6qE4/jfYrzdzZCFUBVk1RRZ+rna8YxTRXtSvNrFWCqYtexjXnz1JlrEqlQHtnmFs1k0y6gHmPPM4lqHUuH0fjVClhWg12R3Lo8n8UZLdtqsNvCrmIAZdh0FRgZBRkvnZrRue3CHmJWAjRed11U/D4marVSrYZORIaTba8TSziAzyimQzCsO/YSgQ5lqOxeBX1Kqap+bTZZRzlE6eFDIhndSc7vfjp8nos5Fu/53Dp5QzBvVw7/DvUX/nLC5enTmKZ7He6AjuPPB1YJ9uVz09QNUre +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 role' (post-role)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create a new role

+ + + + + +Create a new role + +## Request + +

Body

required
    role object
    = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"example":"sponsors_role"}}>
+ +Expected response to a valid request + +
Schema
    role object
    = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"sponsors_role"}}>
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/post-roles.api.mdx b/docs/api/nerm/v1/post-roles.api.mdx new file mode 100644 index 000000000..c2c794562 --- /dev/null +++ b/docs/api/nerm/v1/post-roles.api.mdx @@ -0,0 +1,47 @@ +--- +id: post-roles +sidebar_label: Create multiple new roles +hide_title: true +hide_table_of_contents: true +api: eJytVd9vEzEM/leiPG/tGPBSiYeBhlQEA22Fl1FN7p3bBu6Sw0m2nk7937GT/jjWMkBik9omtuPP9pcvnXYNEgTj7LjUI904H65dhV6f6BJ9QaYRG1veEEJAVccqmKZCZfFBRY8kngEWXo9uNaXI6Ykm/BHRh9eubPWoS0tDyAkCRTzRhbMBbRATNE1ligRg+M1Lpk77Yok1yK/QNsi53ewbFoETNSRwg+EscmxKt3cDImjZywSs/Z/Doyl7Tj6QsQt2qo19j3YRlnr0/JyXsOovcQU1ly8BjbPekb8TGHp9sjno8EC0sZbuXCHnn5sKpcG8f4VQFOh9Wk75AAv18QN2OW82OSXdglxs/qb8I+dAeZfC71LK9VrQm5BMgub0XPbWaZ8wFZpbdn52Jl+/MuNy1XB7sVRbVxWcAnUPlZG9xAT9D0N3Fj/OuWGH8+tjlB783uOdm+n1NFfw4hjo11Cq64xNnapoYVYl3IWTFgUc/F/EY5va8U5Cn8L9RbxSmkuiNOhNES+PFTFmfGShUjdI90gqxXA5hCGS5Yk4y6UtwZYVL3BVYIr0/1Tc05cIJeUhsgtVM7NhgSrvz5iBKixRZf9fOO2IWuVdjWEpXg+MSj2QY8ruSCg2t9UnwQByH/WQNlLlU/0+jSBSxaZlCI0fDYcdFwk2XDHP1wPLg+KsrkUc8KCH0BgOvgcyMv58Z3buuag5sODJjSlqLNyBKk6Su5JrpMB7s5CuC42iD1wRSQlTwVdEMqFNAGcIhHQRpYTbad98I03POPpOuxlIUVJtcuN1duKd/OOtoxoE7MR9R8sw+PNV6yLln1o6KfO93qvz5XYMOzW93QjjI33bytuBimXR2ivTXphuH8kMl8oAjJ07SSfzyj18NjgbnPXuwNXl9Qd18Wl82Gzmz9aoCrBqhvIEpYZnKVVMdVW70sxbJWN10YsqcQvYqoxVqRto7w3zq2aiyU1g7iOrloDaFPNhPEnNErbVYHuWY68gHXsvu/0Fe/rpzF0NuArDpgIj8pAp3G1Y3ntWl8J+3ui6GXj8TNV6Lds8TRJqTfdcTsziAISSCSJD/Y6tQMmgTieSVtyrmN6DxwogGpUjLgpRjSd9p70L+unjzUQIuXn5eRYSQ/DAm/I50l/5nxcuS1Finux3ugK7iCwZ7JPPlb+fEHL+Ww== +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 multiple new roles' (post-roles)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create multiple new roles

+ + + + + +Create multiple new users + +## Request + +

Body

required
    roles object[]
  • Array [
    • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"example":"sponsors_role"}}>
  • ]
+ +Expected response to a valid request + +
Schema
    oneOf
    roles object[]
  • Array [
    • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"sponsors_role"}}>
  • ]
    • job_status object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/post-user-avatar.api.mdx b/docs/api/nerm/v1/post-user-avatar.api.mdx new file mode 100644 index 000000000..4f25f91e3 --- /dev/null +++ b/docs/api/nerm/v1/post-user-avatar.api.mdx @@ -0,0 +1,47 @@ +--- +id: post-user-avatar +sidebar_label: Uploads a new user avatar +hide_title: true +hide_table_of_contents: true +api: eJyVVcFu2zgQ/RWCp13AtpzE2e0a6CFtU8ALtCkSZy+BD2NpZLOVSC5JOREM/XtnSCt26qyxySGmODPke5zHx600Fh0EZfSskFNpjQ/3Ht3VBgI4OZAF+twpywkUvreVgcILEBofRUOJAvrMACsvpw+SZ71cDKQFBzUG/po+bKWmD1pCFZSreDELYX20w+yTMKUIaxRm+R3zIIIRDoNTuMGBaGwBgX6NEwVWtDbVO/y3UQ4JfXANDqTP11iDnG5laC3v6KlaryizNK6GQDNNE1HgE9S24pSz88kfxbvlxRDy87+Gk/HZ5fDd2eVkWCBMJhcT+POiBNl1i7Qb+vDBFC1v8evmudEBdeBQ3VRB0RmEjPcdEvAI6ghe4klwrONeBIWeo6ViZCdILJUG1xIq/mNg3hrtU/H5eMw/L4/2+snSRliIPpXPFsQGKsVzkZd8QQGsrVQe1ZF997zI/8ffuOp0DyjOqKG40VWbzo95BBViS+4pnphNXiPzAQpxmzCLoWg0LKvIJzfc0oCjtzAxGm/KKNJfOfVoZjoe099c2g3+O+8fzorbXDtnSPndIpG4fI3EjPA5DZW4Q7ehuxRriA4JvnGaOmU0UVuDLir6wKccY6V/E7nTbULe8hjZlajRe1ihSPMktlW8lSn/8O7cGeda4Q1d9TVnPRIq8egMtbvrxckx0/sLY+CrP5VZ9Ipsq4oue/YRH88ieUYUkVyHYP00y7ZEGHT4SkbSjTQ1jRCYFnFETc/AKiregFMshchtn54IlkBXktaDvMbcHFnPPKYL9ikB3qsVd4Al1fhA7BzTWTC+vHEqtBHgEsGRWzZM52FxGL7jBiQch0nP/WBScudW/J2SaCYNPvf3ZG5+oCYY9P99axqXhpJPVenS8Ip8XInC2Wg8Gh/I8ev17Rdx9W12zJVa2QdFDloske088oU8p94LUp2oTaHKVvCpmsazcRACigqlRQSDeqOo1TX1nEVJMkQyFga1s/svs3nEyo2vQR9ETr0lL8Bu91o//QClgw34FDJbgeKb2ttQElz/OA3kND4Au1Lq2pp1SfHtdgkeyXu6jqfJXxw3erFXVmx7oTyPSdElVB5PAP7tdvdC/C7e/rS9ymg3CbqNeq8a/qLhD2zT80qWQ4TIWElODDYFPiZIwzmX7wtfe6XY4FLRVc6Wc5B+ZDUs+efb/e3mbs4K3j2OpB6u4YXjuoP9kC9L1/0EgtXs2A== +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 a new user avatar' (post-user-avatar)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Uploads a new user avatar

+ + + + + +Uploads a new user avatar + +## Request + +

Path Parameters

Body

required
+ +Expected response to a valid request + +
Schema
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/post-user-manager.api.mdx b/docs/api/nerm/v1/post-user-manager.api.mdx new file mode 100644 index 000000000..29b732e07 --- /dev/null +++ b/docs/api/nerm/v1/post-user-manager.api.mdx @@ -0,0 +1,47 @@ +--- +id: post-user-manager +sidebar_label: Create a new user-manager relationship +hide_title: true +hide_table_of_contents: true +api: eJzFVttuEzEQ/RXLz7mUtA0QiYcWFSmIUtQGXkqEJruziWHXXnxps1rl35mxkzZRSpW+QCqla/uM53LOzKaVpkYLXhk9zuVI1sb5rw7tJWiYo5UdmaPLrKoZQefvLYJHAULjvQgE7FYJKSyW8Rq3UDWZeZg7ObqVjBFrjJPTjrT4O6Dz5yZv5KiNS2WRfHsbsCMzoz1qz0dQ16XK4qX9n47dt9JlC6yAn3xTIwVkZj8x8+SwtpyJV+j4lN3+WLs9EK3yLaDzVuk5AQtjK6BwZAgEWHXk+tLD4IT3ypcM2a7qKn64Fq6miqUgBkdH/G+33hfLmgLGXGygwhuq/h2UivdiKeV/qtohFeAcIb/SZZMIpqTD03aV0p9Qz/1Cjo4HXObl9nL/ln9LWXfwQNrJUzydQy6uEx2iK4KGWRmpykxVl+ix9xKSjMargppnn4BNZGMdFfCRTVedv+O+MSq6ubDWUAOupimJ06eSGFN8VkMpbtDeUdtGG0rHog9WkwiNptQWoPOSFrjMMFq6FyX3vKaQXe5HdiYqdI6IEGl/RtQJv0CR8B2JS+BCE/TGWNsIZyr0C0bdU1Ti3hrierWhkM/MZtxxDMA6k/0d/Xeki2VwkYlgS0IsvK/dqN9vKVfQ/jNUuOpp4oucmwaxR3z3oVZkfAdWsQpiWo/wlFsBoWTJQVZhZvam7CTChSa8AOfUnIvPagrOU2JxgEw5vixY5ZsY4AzBoj0LnMntdPv4hmuf4tgGPVDBSXG2EUbrBKKd9PBh0x8T8ws1hUHf7xoTbHqMHcM0Xz8O9osNG/sj5aFv5XEBb06L4Un39PWr192T0+GgOzsusu4gezs8LoZDKGAod5v3MBsOSOnCsDvmL9X0Ve+od7TVGp8vri/F2ZfxfvFJVptDkYEWM+Q3XSQAsox0KKgDRGVyVTSCaTbB8XymktCpUFrE6qC+UyS7ivTHDUItgTS/OSgddSAvx5MYK4uQstw6OfgtuxN5+9iEL3hPJw14XPp+XYLieZLE3q7b4naXQxLWgruG9tt2Bg6/2nK14m2i37IWp4/ij1IkA5reTD/J9Bc2HF4KtDth7wwvA0exNzl4tiWLs4ynzbPY6VZjf7m6mbCC178yiCy2sXDPbyT6Hsnv9EcLk0ZY/CnC+60sQc8DpUqYdC9//gBu5ymh +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 user-manager relationship' (post-user-manager)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create a new user-manager relationship

+ + + + + +Create a new user-manager relationship + +## Request + +

Body

required
    user_manager object
+ +Expected response to a valid request + +
Schema
    user_manager object
    = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/post-user-managers.api.mdx b/docs/api/nerm/v1/post-user-managers.api.mdx new file mode 100644 index 000000000..6b1356b47 --- /dev/null +++ b/docs/api/nerm/v1/post-user-managers.api.mdx @@ -0,0 +1,47 @@ +--- +id: post-user-managers +sidebar_label: Create multiple new user-manager relationships +hide_title: true +hide_table_of_contents: true +api: eJytVW1P2zAQ/iuWP/eFt3ZbpX0oE5OKxIug7AurpmtyaQ2JndkOEEX977uzKaSUIZiWSmlsP2c/d/fcuZGmRAteGT1J5UiWxvkrh/YENCzQOtmRKbrEqpIhBPhmETyKosq9KnMUGu9FRQbdIloIi3nYzi1VyeYeFk6OriWDRLHedtaRFn9X6PyhSWs5asJQWSQS3lbYkYnRHrXnJSjLXCVh1/6NYxqNdMkSC+AvX5dIxMz8BhNPB5aWXfIKHa/ysb+ejn2Gg7VQE1p5LNw7t1FpC+i8VXpBwMzYAoinrCoCrDry8bT3wQnvlc8Z0oo7zYeHo+RKCmZksbezw3+bGTl6KIkxpmINFd4IEHeQK54LQZYfiKfReJZRxrZDsiZ6bObk59/XNwS0mkVHDl7jfgipuIgURVdUGuZ5oJ+YgsTlsfd/iU90iMoxm77lwA9GhWOOrDUtJwavOTEhflZDLi7R3pHIgw25Y9FXVlNijCbXlqDTnAb4kGCwdB9y7m15Ih+5zWwsCnSO8iDi/JwkKPwSRcR3JD4AB5qgl8baWjhToF8y6p5YiXtrSLNPWuQ1s+4SzAH8kkb9zRrrSBfi4EIqKpsTZOl96Ub9fkPOgvanUOCqpylhdLqpEXuU8D6UiozvwCqWQSzKJ3h0LgPqO1y9SYGJ2WpO0wAXmvACnFMLjj7LqXKePAtlNWN+SWWVrwPBOYJFO67YletZe/mSgx95tEFPuWCn2NsAo3EE0Uz8+L4u9Km5RU006P21NpWNn6H0Oc8Xz33waJ2Orb513WpBcj+Dz4NseNAdfNr91D0YDPe68/0s6e4lX4b72XAIGQzlZh96nw3JnDqizgwz4BTGsO72dno7rfI4Pbo4EePzyXb8SVrrRZGAFnPkyyHkAJKEtCioCkRhUpXVgjNtKsd9i6JCq0JpEQKE+k6R9ArSIBcJlQVSX2NSOkhBnkymIX4sRHKztfLh+2nDg+a5IP/hpouy8Pjg+2UOintM1H/zWCrXL9JKYltyKdFC08zB4ZXNVyueJklY1ufsuSCCPMkAISWVsSJusWaekXF3ysczPK/CBfeynXDDixbjhFvQm9hZq9rPzy6nrOrHi5qyxzYW7mmS3yP5k340MLGvhduc5xuZg15U5Cth4r78/AG8/u6W +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 multiple new user-manager relationships' (post-user-managers)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create multiple new user-manager relationships

+ + + + + +Create multiple new user-manager relationships + +## Request + +

Body

required
    user_managers object[]
  • Array [
  • ]
+ +Expected response to a valid request + +
Schema
    oneOf
    job_status object
    user_managers object[]
  • Array [
    • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
  • ]
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/post-user-profile.api.mdx b/docs/api/nerm/v1/post-user-profile.api.mdx new file mode 100644 index 000000000..8043b805e --- /dev/null +++ b/docs/api/nerm/v1/post-user-profile.api.mdx @@ -0,0 +1,43 @@ +--- +id: post-user-profile +sidebar_label: Create a user-profile contributor relationship +hide_title: true +hide_table_of_contents: true +api: eJzlVttuGjEQ/RXLz9wCgbRIfUirVEJqLkrJU4qiYZkFJ7v21pckaMW/d8aGACKqaF/6UCLB2j4znjlzZja1NBVa8Mro0UwOZWWcv3Nob6zJVYGyIWfoMqsqRtD5F4vgUYAIBGpWCSUyo71V0+CNFRaL6M4tVEXmHuZODu8l48Ua7+SkIS3+DOj8ZzNbymEdl8oixeBtwIZkl6g9H0FVFSqLTtuPjsOopcsWWAI/+WWFFJiZPmLm6UK6gzLyim6hU772YX3tkWg12wE6ykvPCZgbWwKFI0MgwCpastNj4RofwCeSjrbZpfIhoQ+tUIeSCTYvGq1MxK1rIScr8uKV59zlbllX8cM3uIr8p+y7nQ7/7Bf84rUipnAmNlDhDZX/GQrFe7GG8h+V6xgaOUeYXetimZRFSYf37Uqlv6Ge+4Uc9rq0hNfd5aGX/0Qrze6bWk47/UOBjHTSgtJV8JJhJfqF2QwTLhowibK9V9yGpNUzWh4OVHdbEGLhfeWG7XZNUgLtr6DEVUsbjWVVmCViKzNlGypFxs9gFUyLpIMtPIWXQyiYG8hKzMzBDBtHuNCEF+CcmmuSN6k6C86bkoihZCccXxas8ssY4BTBoj0PnMn9ZPf4O0s7xbELeiOfk+JsI4zWCUQ76eHrppBj84SawqDvT0sTbHqMhHIX3W7H5cUrECH4Xr+8iVL2cvjQzwenzf7ZyVnztD/oNqe9PGt2s4+DXj4YQA4Dua/MY20O5Hms4TsaXUuRs1Q6N5wDiyIV6qTVaXXkVpVXF7eX4vxmdFjRBYrNochAiynyCypWFbIMnROgZ6I0M5UvBWvHBMcTjXimU9KuiJSjflbW6JImWYsuoTGGNPE4KB3FJS9H4xgrK7sEvXPyxy/GvQzq7QD9i1dsYtLjq29XBSjN8yB2VL3uvft9oZB6F9yatF/XU3B4Z4vVirdJY5YFP9l2WNQ7GdD8o0JxLzzhksNMATfHfDvDi8BRHEz/VWNjcU6VqPxvsZOd6XFz/X3MbbL+B4GKxzYWXlhJ9D2UP+iPFiaSGDsw7teyAD0PMGd88sufX2QJE8U= +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 user-profile contributor relationship' (post-user-profile)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create a user-profile contributor relationship

+ + + + + +Create a user-profile contributor relationship + +## Request + +

Body

required
    user_profile object
+ +Expected response to a valid request + +
Schema
    user_profile object
    = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
+ +Invalid input + +
\ No newline at end of file diff --git a/docs/api/nerm/v1/post-user-role.api.mdx b/docs/api/nerm/v1/post-user-role.api.mdx new file mode 100644 index 000000000..0267ffb0e --- /dev/null +++ b/docs/api/nerm/v1/post-user-role.api.mdx @@ -0,0 +1,47 @@ +--- +id: post-user-role +sidebar_label: Assign a new role to a user +hide_title: true +hide_table_of_contents: true +api: eJzFVttu00AQ/ZXVPufSpm0KkXgIqEhB0KI25aVEaGKPkwV71+ylTWTl35nZbRpDSikv4EiJd+es53LOjNNIU6MFr4ye5HIka+P8tUN7aUqUHZmjy6yq2UzGsXNqoQUIjXfCEkJ4Q6tAeMJ6WDg5upG8jFYnZx1p8XtA51+bfC1HTVwqi+TK24AdmRntUXs2QV2XKouh9L86dthIly2xAr7z6xopBDP/ipknb7XlwL0iL2Rln1/Y5zOhKm8BnbdKLwhYGFsBxSJDIMCGgqcnPg9LYK88+5cP5dvEi0vgaqNdcj84OOCfnwt7tqopVMzFFpoKewul4r1YQfk/ivWc3DlByC90uU6kUsbh8XOV0u9RL/xSjo4GtIRVe7n/lH/FVHfwwNXxY/S8hlxcJhZEVwQN8yT9zFR1iR57f8ON0XhRUJ/sl34b1kRH4t/x0U3n97hPjIpuzqw11snNLCVx8lgSE4rPaijFFdpb6tB4htKx6IPVpD2jKbUl6LykBa4yjCfdXyX3tJqQXe5HNhYVOgcLFGl/TrwJv0SR8B2JK+BCE/TKWLsWzlTol4y6o6jEnTVE9GZLIdvMdpZxDMAKk/2d7DvSxRq4SEOwJZmX3tdu1O83lChofw4VbnqayCLPZo3YI7L7UCs6fAtWsQRiTjt4SqyAULLYIKswM3sjdBrhQhNeQBynVGyWUnCesrKcxozjy4JVfh0DnCNYtOPAadzM2uYrLnyKow164IGT4mwjjNYJRDvp5u22M6bmG2oKg75frU2w6Tb2CnN8uZvhZ1sqfhkjD70qjwp4cVIMj7snp4en3eOT4aA7Pyqy7iB7OTwqhkMoYChbDfu8AxyK0oVhX8xcquZh76B30OqI87PLD2L8cbJfdlLT1igy0GKO/NqKpYcsI/kJEr6oTK6KtWCCTXA8jakYZBVKi1gX1LeK1FaR7LgvqBOQpjUHpaMC5IfJNMbK2qtAtyxPvzx/CrfZNdyf3rmJZ48r369LUDwwkqCbe93ftHgi5Sy5J2izaebg8NqWmw1vE7+WxTbbqTtqjQ7QVCZXrMNvSBD5JoXWnbJrhpeBQ9ibCzy50olxxrPkSeys1bYfL66mLNH7fwzECZ+xcMeqoe+R/EwfWpg0oOLfCt5vZAl6EWiQECY9l68ff98NPA== +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Assign a new role to a user' (post-user-role)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Assign a new role to a user

+ + + + + +Assign a new role to a user + +## Request + +

Body

required
    user_role object
+ +Expected response to a valid request + +
Schema
    user_role object
    = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/post-user-roles.api.mdx b/docs/api/nerm/v1/post-user-roles.api.mdx new file mode 100644 index 000000000..00b0199b1 --- /dev/null +++ b/docs/api/nerm/v1/post-user-roles.api.mdx @@ -0,0 +1,47 @@ +--- +id: post-user-roles +sidebar_label: Create multiple new user role pairings +hide_title: true +hide_table_of_contents: true +api: eJytVdtuGzcQ/RWCz7o4viitgD44hQsoQC6wlb64QjHanbWY7JJbkmt7Iejfe4aM5HWcGjZQCdAuOYeaMzNnhlvtWvYUjbOLUs9160L8EthfupqDHumSQ+FNK3ZYf/dMkVXT1dG0NSvLd6oDWnnAVUvGG3sjxyLhMb/WB2PQq5H2/E/HIb5zZa/n27Q0nuE2+o5HunA2so1ioratTZFoTb8G8b3VodhwQ/IW+5bBxq2/chHhrfUSRDTwAqv4/Dv7fMCS99QDaiI34YX/YcoBMESJDcDK+YZAUncdADtEBVcvwwIcTawFss8xNtNHkhNaZ0P2f3x0JI/H2b+4b8GVS7WHqugUqVuqjeyl3OpXpNFZ/lShSk+T8SPLgDj/G/XerfVulaM4/Rnxd1Sqy8xPjVVnaV0n7oVroKLIk/+X9cKmlLyXo8/x/lNQyc2F986HQxBnPwtiAX7eUq2u2N9C1ekMwvEcO29RFWcR2oZsWWPB9wWnk+FVwT2vShaXT5mdq4ZDoBtWeX8N8am4YZXxI833JIkG9Mp536vgGo4bQd2BlbrzDmo9CFFsbj8LhAPFDVbTQV+NdEhJCKkOna9h38TYhvl0ukWkZONHang3sagWXLueeYJqT6k1OHxL3ogGciMe4DmyijBdpGOLhgv3ZAQtE1xZ4BWFYG4k9aKlLkSE5SWOlfArOm9inwiumTz7807iuF4NzVeS+cxjCDoUQoKSaBMM6wzCTn75Y9/fS/eNLWjg97fedT6/po6XIl8+DL6LfS0eD6rrwczRJxX9clbNTsdnb9+8HZ+ezY7H65OqGB8Xv85OqtmMKprpweB52QGoG/PPVk58S/FyQt9MjiZHg674eHH5QZ1/XjzNPBS1N6qCrFqzDP+UfSoKSFBB/Kpxpal6JTV2XZBZhXzAqoxVKTVsbw0U10B60hvoBsYsE1I2iUB/WCxT5kR/DdmB5cX3zyPm24f+e8UNlgUQ+T5O25qMjJKs9O33jrgeFhCa2ki7YHe7XVPgL77e7WQblfciw9WD7pMKcYCphJik9t+4F3KZ5ngpvgVed+nu+nFkyFDLJ84LGTPPYleDjv786Wop4v1+AaNUcsbTnagJv3P9F75YuDy70i0t+1tdk73pMGOAyf8rn38BHnLY4g== +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 multiple new user role pairings' (post-user-roles)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create multiple new user role pairings

+ + + + + +Create multiple new user role pairings + +## Request + +

Body

required
    user_roles object[]
  • Array [
  • ]
+ +Expected response to a valid request + +
Schema
    oneOf
    user_roles object[]
  • Array [
    • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
  • ]
    • job_status object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/post-user.api.mdx b/docs/api/nerm/v1/post-user.api.mdx new file mode 100644 index 000000000..9a77fa620 --- /dev/null +++ b/docs/api/nerm/v1/post-user.api.mdx @@ -0,0 +1,47 @@ +--- +id: post-user +sidebar_label: Create a new user +hide_title: true +hide_table_of_contents: true +api: eJy9V21v2zYQ/isEP/ttWdI1BgrMWTPAw5oUibsvrWFQ0tlmI5EaSTk2DP/33pGSJddy5nTYHMAxxeO9P89RW65zMMJJrcYJH/JcW/fJguEdnoCNjcxpCzd+MyAcMMEUPLMiSDixsHz4mdPS8mmHG/i7AOtudLLhw61fSgOo15kCOjzWyoFytCXyPJWxt9v/asnCltt4CZmgX26TA9rU0VeIHRrKDXnpJFja9db/UUqJDBpS1hmpFrxz5NRhmJMl+OiYP97hsBZZnpKCGx3xHT7IhEzb9M61yQTGVkqcbagSry05TOGvFp/mWirXi3VGhoO9Y7ugioyKcAcY/1ymUJbvDkQcg7V+OSXzc1Gk5OD3kicc84aafh2e2/mE03ImkxcTUhQocNJMqYR5mdpYEr2Zv4W3UffNVXzRvfwlueqKQRJ1rwdRHF/CdTK/Bp8W6dLWvJww13zctJdtZrQ/C/pQsXXCFfaljI9iJ1eUovfSiijFSk/PrnqpvelBqQ5Np3oh1b/o3XC+JTpSvjC6yGdBZWt4J5T6c6w6d+B4kkklcUc4bWZervMeVpASHMOa7+pS8dA+/kMh2VwrGzB7MRjQv0MPbtc54hsSVokyp5GHViKV9MwzDv+fyeW8jkfKTLRKN6FcGGzRfg7T9yeohVvy4c8XuBTr5vJISzuzvYKb/kM2OY3IH4XUaTzQjrBudhIu+7ATHF1dJz2jUzrvm+mMtX7Css4owBz7bCbcjyvLDczBIERnqVCLQizaMvEdFroXezRctgHgRiTsIfQ567JCUWIIAzgYEIAOeq/pfq3gfo6pPu7wyqWx8tD6g47uOqfl/iIpb+bWGI0XgN00BHHVFsQY/TNKpOwRzArpxJ/BcAy4wihEt1YY2lKoBKvOYE21wJP2VcG9DFogk8eejViGjY2VKmdDhDViDmkvyDeZ7lEbs2FWZ+CWJPWMXrFno31RyxLSnq6uUuSDICDzfnlnsj586ytQGEQrXzqX22G/v8UYhXJ3iO5dT2Gd0KjeANAFoC9yiYdXwkiqfsDQXjzEVAFSxBnE+pjIvbi/1zBhrVxQ0qmLCuswIM/IU/IvLox0G+9gBMKAGRUUwedpc/uRch78aArtS0BBUbReDNdBCJ+EH79XYJroJ1DoBn6/2+jChJ8eIlTeh/pCeVtVoeboQIT+ZrYnv7bbU0V3R6zWvMCcd+Oo2//wwlCTW81hJS/th+/R7D17cko11xQwdU6o5k+9QW/Q8Obu9uEDG30ct87vapPFQrHIz3Nf+kDpDDHHMp3I+YZRg+nC0qjFYuAuk4r5uoBaSWz0DDueIIkgBBzFjSp8GE+8r9T2mVCNnbZXhwMntzXC298zQvUcrF0/T4UkXgrg2ZbwCu8gNJiWhDpcb7eRsPDJpLsdPcY2MtTT0xpEvqXxAFI4tRO2+xNsyIPgS3cS7r9IhgVZP2Ie4sZwYuQnx4uy0wYxfLx/nBASyrckTD2dMeKZBgp+D/kX/MOFDhToX6Xo+ZbXQ4UHvfT5Bhgywh8= +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 user' (post-user)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create a new user

+ + + + + +Create a new user + +## Request + +

Body

required
    user object
+ +Expected response to a valid request + +
Schema
    user object
    = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readonly":true}}>
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/post-users.api.mdx b/docs/api/nerm/v1/post-users.api.mdx new file mode 100644 index 000000000..b6628c098 --- /dev/null +++ b/docs/api/nerm/v1/post-users.api.mdx @@ -0,0 +1,47 @@ +--- +id: post-users +sidebar_label: Create multiple new users +hide_title: true +hide_table_of_contents: true +api: eJytVm1v2zYQ/isEP/ttRdI1BgbMWTPABZoWibsvmWFQ0tlmK5EaX5wIhv9770jJkuuXpdgcwDHJO95zb89xy3UJRjip1TTjY15q675YMJb3eAY2NbKkMzz5w4BwwAqfO1nmwBQ8M19LOrGyfPzE43re4wb+8WDdrc4qPt6GpTSABpzx0OOpVg6UoyNRlrlMA4DhV0uWttymaygE/XJVCWhbJ18hdWioNATXSbB0Gs21YsIYUaGUdFDYf1dXooCOlHVGqhXvHaE9jMNsDcFvFtR7HF5EgfHAk1ud8B1uFELmp+5dalMIdLqWeLWhRry15DC2v1vcLbVUbpDqggxHe8d2QfmCsnMP6P9S5kAJxv17EGkK1oblnMwvBWYXVX+UPAMsGOriOtTbhYDTciGziwHxHgXOmqkvYUGmNZYlb5fv4F3Sf3udvulf/Zpd98UoS/o3oyRNr+AmW95ACIt0+cm4nDHX3e7aK6oFnS/ifXixdcJ5eynik9TJDYXovbQiyTHT81dnvb69i6C+Dk3neiXVf6jdqH/CO7p8ZbQvF/HKk+6duTTosUbvAHhWSCXxRDhtFkGu9x42kFM7xjXftanisXzih3yypVY2Nu2b0Yj+HUK4eymxwSFjjShzmgm2EbmkvcBF/CdoRyv4tMQEHjNIF6HFYJ2X+EBsMI8eXJ0CfSsy9hCxsT7zigqEcGM3Y9QcDP5fxFMVwvGBVC/h/oukgpk7YzQ5WTtxfcqJKeIzSuTsEcwGayDooDsGnDcKM6IVurYWKsPqZ/CSQtC0P+XcZRoHMnmMbMIK5DaxgrqhE6xK5rBWo3y3PB+1MRWzugC3JqlnRMWejcZi3xchnelmQhIG4da4GjYj0Ab/bUiBN8j/fO1cacfD4RadFMrd47jYDRQmCq3qCoBoeyhKicobYSSlP3bbXjw61ZCySAtI9XH7BfEwjZiwVq4o6lRG3jr0KPTRnPCl3khXBYAJCANm4smFp3n3+JGCHnF0hfY5IKfI2yCG6yiEO/HHnw2jz/Q3UAgDv3+rtDfxZ2hyyu9D+z64a9Kwn+dPzWgOE3U/UE9NvWboHU2s7uB53aRoO+CQ6Fueb+m8pt89aR5x5usYb47RkGqpyXcqnpjQXwajwagD5/7u4SObfJ6eJN7mkKVCsSQQcch+nOwM+44VOpPLilGNaW+JIjEfeMqkYiE1oDYSi73Aqqe2xEYEpND2hcQ/Tmchc1T6hVCdk0uPwgOw27bbL78kYzodvLhhmQtJXBX7aVu3XOeVuaZWxI3tNhEWvph8t6NtLC1DdT5vGyuUOSqAyDBdVGHfoCIoEVR/Fl8yyJA+PCR/pCMizKgxSYnCLsrOO2zx+dPjjLqjfghjLkjHiGea1fg95n/jHy505MXwWqb9Lc+FWnnkL5SJ99LnO8LYDdc= +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 multiple new users' (post-users)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create multiple new users

+ + + + + +Create multiple new users + +## Request + +

Body

required
    users object[]
  • Array [
  • ]
+ +Expected response to a valid request + +
Schema
    oneOf
    users object[]
  • Array [
    • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readonly":true}}>
  • ]
    • job_status object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/post-workflow-session-upload.api.mdx b/docs/api/nerm/v1/post-workflow-session-upload.api.mdx new file mode 100644 index 000000000..9ae2b972a --- /dev/null +++ b/docs/api/nerm/v1/post-workflow-session-upload.api.mdx @@ -0,0 +1,47 @@ +--- +id: post-workflow-session-upload +sidebar_label: Uploads a new attachment attribute value to a workflow session +hide_title: true +hide_table_of_contents: true +api: eJy9Vm1v2zYQ/iuEPm2AbTmJs7YG9iHdMsAD2hSxu34ojOIsnWw2EqmRlB1B0H/fHWn5JfayphuWD7FE3vGe514eqol0iQac1GqSRuOo1NZ90uYhy/VmitbS+scy15BGvShFmxhZsi1ZhmUrQCjcCHAOklWByvGjkYvKoVhDXqFwmmw22zOFDYfScQ6WNhp/jp5u2Wjei0owUKBDwyZNpOiFYkqGITl6CW51Amnyq9CZcCsUevEVE8ehDRIaXGNPVGUKjn61ESnmdDb5G/yzkgaJuTMV9iKbrLCAaNxEri45oiVvtSTLTJsCHK1UlUeBj1CUOZtcXI5+Sl8vrvqQXL7pj4YX1/3XF9ejfoowGl2N4NVVBlHb9nYsdgn68g98ZsREph2ncyn+fynMQzS07q1Oaw7xNHiilSOAvFVUuZNURhdz3D7l3oM6gRdKRXBKw63oJFrezSQje4bEQiowNaHiPwZmS+qd4Hw5HPLPcTZvH0sKhKnoTENnUpNKXvO8oiMKUJa5TPxwxF8tH/Lt+CuTP18D2mfUkN6pvA75Yx5OOl+Sj7QfmI3OkXkLqbgPmEVfVAoWueeTaC6pw8FLmGiFd5mfs6ecOjQT5dP0O7tyJ/+d3R9s5cPcGqNpeNt5IHF9jsSE8BkFuZiiWaMR3ofo0MxWRlGltCJqK1BpTi/4mKD3tC8i93yZkEOeIrsRBYkRLFGEdWq2pR/CYH84O1NtTC2sJrVasdWGB3RjNJW77ZqT93Qnr4yBp30cxZ30femkL25k2saVl9a4ORSKltysT1NQRN9f0cq50o7juKFcgHLvSWDagaJ6EjhdIw6oH2IoJTmvwUjuEk97bx64Z0DTytKUFJjoUyHy5oL1SwAhXXJxuNsq64i4YaZzxpdURrraA1wgGDQ3FTP9PD/cnnJtAo5Do12pmFS0FTJ+D0a0Eh5+60Zoph9QEQz6/3OtKxMeWWpJUzPNJ3K6AoWLwXAwPOjU97f378TNh8lZ0e02RQJKLFBUNvCFJKFCCWpIUehUZrXgrOrKsqYQAtoVUgkPBtVaUhewXnO/UociaQ6D2l4D7yYzj5V7ogB1sPOvr9YjRs1+Vv6DSzuUyOGji8scJMtBp3Whq/cX+q6ryW/sb5yq+5QYH92B1BsrHgzybZoFWCTxa1teJoEz3E7zff/65kql5WcaqQxyi88w/uF+e0X9KF7+eXCW7XYRVO2nirJFb/T4gHX4RGGB/C6A33Tffwemo2STIlO66d6hkeJUBpNfAp7+jA/aH3HuEmd6wekmYUU+MD9RYh77nfh9uJvOeIq33w40QezDB/tze/tHFoy2/Qvqwayn +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 a new attachment attribute value to a workflow session' (post-workflow-session-upload)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Uploads a new attachment attribute value to a workflow session

+ + + + + +Uploads a new attachment attribute value to a workflow session + +## Request + +

Path Parameters

Body

required
+ +Expected response to a valid request + +
Schema
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/post-workflow-session.api.mdx b/docs/api/nerm/v1/post-workflow-session.api.mdx new file mode 100644 index 000000000..2814c9ddf --- /dev/null +++ b/docs/api/nerm/v1/post-workflow-session.api.mdx @@ -0,0 +1,47 @@ +--- +id: post-workflow-session +sidebar_label: Create a workflow session +hide_title: true +hide_table_of_contents: true +api: eJztWG1v2zYQ/isEP9ux4yRuG2Af3CLDMqxtEDvrh8wwaImy2UqkypckhuH/vjtSr5abxeiKAUMTIBHJ4+m5491zJ26pyrlmVih5HdNLmitjPyn9JUnV45QbA/O0R2NuIi1ylAKZd5ozywkjj4UgMZWkZStDL+/p/pKh8x7NmWYZt1yjyJZKGIA67XCjQM1fHdebzvs+iTQlIEXsmpPIvzweuDzG/x0MRCTEuCiCUeJS0KX5Vyc0B+MSlhreoyZa84zRyy21mxwBLJVKOQt2JsylthDd7eZhOzf2rYo3uKXWZrUDZZGSlkuLSyzPUxF5Vw4+G0S+7b5LLT/zyMKrco2Ot4IbXC2tWJSefPkOETeEjdVCrkA4UTpjAIs6BwK9Pdy7yi6uv19B2NpVwaXLMBbuDNcw/MDBgkSkvBozf0x+OD/whkL8hQDbMTODUCn2Q9gI042TR4yqJfcLoBHGdn1CPsp0QybhJJewF95C7nyoVRoMbWEzDXBMa4bxKyzPzD+D3j2D2nw37LfMRus2amYByNJZbg4FGItjgUBYetMKtbYRoIY/sSxPw5nzJ7uo1C7QKpSELIgIruHBgPM6IsPTwenFYDQcDWntTMNTQNKRvSnO8QPyRY9mkKECXr84YltvyiFTY9Kam62Fbk/RkNBejdLfUowB2wFzzL4STT0RoNSKdztwsxUWnUz3+Lg/wmUvobnJgVvDMY2GQ/zXjqirpxygAE+WosQqYO4Hlgqc8ylM/0Maeyn5sBhDvKIGd3hfJuQfXK7sml6ejWDInprDjpajOPRozvz3OfInJ/4ATkSycgeBlWfDcrEoThICW3qqzAHSA0cfM8CwkuHRgo2AW64WVi1AsbaL8l2wPLmb/dafziazu+lpezhqD8/aw/P28KI9HLeHr9rD1+3hG0QJHLVooF6iT4C/kNKtn4Fsj9CRC3DZInaBDyBfYSVVJog0xZXTcAwLqB+NEZA/l80JSAPIT1DUmAtdHEZq9RZwtVFp8G3C4NT9g0shAMKzkA/Cen4qTyONWY7V4EHEXkJydLdEEIBSbTjQc2gb96eLLtJPW5EI/5gDbrQ+HDJLm1PebVl4bTnZtn9/tvLD/kLTH/trlV+qBcQfWuxyqvDJHhj0RWMYzIr297ZLZ2OhLgn1zIPw/iwnQsIsojWTK96aV9C9oeqIx043lyCjVitPaOVMbSCKg1d9xpWwfABWIVkvmAIwD0Xhc/0YeDY8I17/aBTExV7m+qwEmI28bBnk93UtcbKZMo9M+CyHk2roqcpJqWneaJUaGfOzEft/NGJVG3Z+qPN6y2JyG2KP9ImTvgZB81XGwckxbZeS/GPiP5r3Y6XEdi19T/c7bt31vi33J0r511xpreBLfDcPRlwcMuIa8GmIQzLl+gF84veAOZpbpyEXCFRfJyHcY+Bmwp8i7neao4x7vkPk+MousgnJ4BTYipMwv8TCjxcEQb6ZeVOl9YYYlXFoH7A9AFTkUSvMofIIcU2VFyCIgWHXSAf7HS0WQeN9Ee4wnE5BbG1tbi4Hgy0YzKTFyNmdQKEp68wJHPoA2gjY/MC0wFAICV2JBwOL2wfKogwCs9vAeXGC9yakZCMfUg4YKwN+3fkrC8MjqCJ24wEuOdNcTxyacz9vLk/xAAKOplB1HmgULa5L/DWJF8KGwT/8WrZtM/WFS4ABf3/ZQP0KjxS9imd9W1+gXNV0dehLodWO07OEvb5Ixuf9i1enr/rnF+NRf3mWRP1R9GZ8lozHLGFjut+TH7+rMLbot5vt9Ut1tdre+5ftmndKwE/6/mH0LWSi0MeYtCGRTk+GJ8MGKX64un1PJjfXBz+ZykUSMYlfGc6ErAtfZgS4j2QqFsmGYG4rZ/BbG/IAVomQxKcEh54VCAd7NaRGIEMO3+IIqrgEfX898xmD9JMx2Vh57ra1BXZbM+7zV7Qh4jGqBnnKBNaLwGPbgvbuO+npr2/XSI2wuN0umeF3Ot3tcDpc2iLXxMIgtdVXrd/E931Xugct+MI31WUylEKHEhT5rmRcz39gBWcx5DriDVveBVT9GWqt93ZqFlbVsGMSYZ17VnbeKCk3H6czpM3iChmCxV97M+wZ8e8l/Qt+YaBC8fT3zDi/pSk0kg6KHMgEvfjzN14lXrA= +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 workflow session' (post-workflow-session)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create a workflow session

+ + + + + +Create a workflow session + +## Request + +

Query Parameters

Body

required
    workflow_session object
    attributes object
+ +Expected response to a valid request + +
Schema
    workflow_session object
    = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}>
    attributes object
+ +Bad Request - unable to complete. + +
Schema
    oneOf failed to create/update"}}>
+ +Internal Server Error - returned on unhandled exceptions. + +
Schema
\ No newline at end of file diff --git a/docs/api/nerm/v1/run-advanced-search.api.mdx b/docs/api/nerm/v1/run-advanced-search.api.mdx new file mode 100644 index 000000000..a9f848a3f --- /dev/null +++ b/docs/api/nerm/v1/run-advanced-search.api.mdx @@ -0,0 +1,43 @@ +--- +id: run-advanced-search +sidebar_label: Run an advanced search for profiles, without saving the query +hide_title: true +hide_table_of_contents: true +api: eJy1WP9v2joQ/1es/MyXAIVuSHtPvLdNQtrWqtCf9hAyiQPeEjuzHVqE+N/fnZ2QBCil7UYRTezzffPd587eejJlihouxTj0hp7KxChcUxGwcMKoClZewwuZDhRPkQYo7jJBKHxzKqItGYmkIqmSEY+ZbpAHblYyM0TTNRdLYlaM/MqY2gA3Q5faG373Dhh4s4aXUkUTZphCgq0n4AUEFgu5qLzUdRrFsXzQTge65MLaA1oCc6kMaNCCJYr9yrhiYGVEY80ang5WLKHecOuZTYqS5OIHCwyQgiHgFcOZxtmYJ9xUyLgwbMkU0LFHmqQxjHV8f9fwZBRp9gxl3xKqEEZLOm0UKFkl8wLFqGHhnBpvt6tM7NUBkaXEvr9nerhSm41lGDKW3hQGssc0liEMG5Wx3cw5h2nzjww3KKP0FRI0vECCJcKaRtM05oH1cPuHRvdvL/ZksefzfM+fdz1dsPjYUTurUchRibnKIOTAWphaZMaty8mpUtSGjmGJU0BsbiIbXIdyDTfWTbcuhqcwfQeMm10Q9iz1xFCT6cvpR4WyuGRibXrFwo+wza9YNg6fWXTH9c/CltkOY6iYqUMDztsPho9OpdDO+V3fx3/1FP30mIIUSPeClBhJKFnTmOOYjT7vtwVagUTnYuE8Bx6eyk9AmATyauhlGRCg3TS8EfGmyJO6zVOAPcdek/HHWnr3epF/3Q3DZqe3uGpedVin+Y5Rv9kZRF3af7/oXwfvMMyz03okXHxhYmkghXpdeKWP1dfLtbo/UCv32z1IBeEOgI+lH/LjmsAXQR5XEBnZ55xXqyYgD0jyDVnvGoXAOYqYX+bzp6WPPx7IJsirNgBwIsUSyOWrtkPbRD+J3CJLsKyNAsPXDAbGghaPN4J8YdQ+TplKsD4BtM7OmeIEHZhTUzkXBErxcA4EQCGW8+cVTBkApx1JqdboX8rj88qAXwsBqNh5vQr+iNFlJTq3ryHimOEJO7G5jOCsLeVIUdvLB6pJLqKmQdfv9pqdTrPbmXauht3esH/V6vYHTb8/BGTCpErDP61XLuJlep2sYXt8oqEreDS+rSHVUWk86I32TEFJavIMQPQ1uMWnshR4skdTltS5RSEb/DwgOIceAfuOSPxOu9Nvg6G+V+a2ZjFYcERbgwLAsCw2HMTPX7CsMWHYB5DaGESuqg/ldcWykeopxveaqSNlXrKu0KYccKqUjGvFNNdwX0VxDrrflUSmqbTlMKWI6V77oHFqQ5sOs8B3XTTLmYI+yVsZk+phu72FIkqFQaG7lpCCwcbKDWOtQCZtmnJYvKaK00VRI/fkrnJHFByARTNIwKbj+LfkDu0BRPhSQGGHiAoybWQCXSgYM0P9gkxxs7EKLkBzpkYZGvR9Vp2eYFF3elSJ9pGNRnl5u47vjghG3MPnIl+n8icToAb8ftjITLlH2wRj/3BXtrifykg/0ZLmTWeJCOd6zbKVPOgc7boEjjQcZM/dKUtif/7hg/V+nNnCE9F3/Whw1exfd66bV/1Bt7noRUGzG7wf9KLBgEZ0UG3WjhrOy8Tsi8Uho1pnWDPV4c48J59C0n/mLA73C04R23y4yKSLtJ5ALBH38nrNsUv+bUprm+FUbSoo8IScU6Rv989fFfdMZWg72lJSMUMjYxPEYJWoTPT81/uxiDwLgn84CrgI4ixkf78hUYpDzG9Mw1OevgEApnGM0uxhCa8pIokogsjs0LLT8lt+5Xz17dPdVzK6HZ9sK4pJElABtZpk2kErDQKmtW04EhnyaEMQwCX0YnCgArCDWcIFsbjHxJorKRI4SGFdh1MUgwMXKpVfqXwdTy0sYpVJqKjMvPV2p2bQtjzOvf3ayG0rNh/tNKZc2EZO2csBVyW/H2F5A6+zsLVdYTUFgu12QTW7V/Fuh8OON1Sjshra2gQL4ASFlymA7j8ZkHj/OkOaiO6VuDk6o2IEuhUj2LDUnKWdVQr+7c1kiiUtv4BJ7O2Mp+gDWgG/Q+8/+IMXaZ1rq6Udx3ollhldIr3ji5//AYQOyJk= +sidebar_class_name: "post api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 an advanced search for profiles, without saving the query' (run-advanced-search)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Run an advanced search for profiles, without saving the query

+ + + + + +Run an advanced search for profiles, without saving the query + +## Request + +

Query Parameters

Body

required
    advanced_search object
    condition_rules_attributes object[]
  • Array [
    • anyOf`, `<`, `start_with?`, `end_with?`, `include?`]"} schema={{"type":"string","required":true,"enum":["==","!=",">","<","start_with?","end_with?","include?"]}}>`, `<`, `after`, `before`]"} schema={{"type":"string","enum":[">","<","after","before"]}}>`]"} schema={{"type":"string","required":true,"enum":["Today",""]}}>`, `<`]"} schema={{"type":"string","enum":["==",">","<"]}}>
  • ]
+ +Expected response to a valid request + +
Schema
    profiles object[]
  • Array [
    • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true,"description":"The objects UID","example":"profileUid"}}>
    attributes object
    + +Attributes that belong to this profile. + +
  • ]
\ No newline at end of file diff --git a/docs/api/nerm/v1/run-advanced-searchby-id.api.mdx b/docs/api/nerm/v1/run-advanced-searchby-id.api.mdx new file mode 100644 index 000000000..7cdc1dcc5 --- /dev/null +++ b/docs/api/nerm/v1/run-advanced-searchby-id.api.mdx @@ -0,0 +1,43 @@ +--- +id: run-advanced-searchby-id +sidebar_label: Run a saved advanced search query +hide_title: true +hide_table_of_contents: true +api: eJy1V1lv2zgQ/iuEnnYBy5Z8tKmBfQjQ7iJAL6TJUxEYY3Fss5VIlaTcGIb/+85Qkm3FzrXABkHCYzjzzT3aRqZEC14ZfSWjaWQrfSnXoDOU3xBstppvrt5HvUiiy6wqmY6oristQDhYoxTQkAsX6MWvCu2GXnhYumj6PXpwH931ohIsFOjRMsE20rQhpkrSK8XsS/CrE5lX74VZCL9CYeY/MPPCG2HRW4Vr7ImqlODpv7FCYk686b3FX5WySGp5W2EvctkKC4im28hvSpbo6LVeEuXC2AI8nVRVQIH3UJQ5k6TD8Rt5MR/FkA3fxeMkncQX6WQcS4TxeDSGt6MFRLtdb69Fq35QpN10NbnMc/PbCRIqSlgqHawvQJOJjPWEqN8Bv4DcnUNfm4FIS8s+9Aod3+aqUP6ITGmPS7THWqVJsutFZrFw+AzlJBBaSadnzHYwU2aRzC9nZEQyxuFiD4dEHiROkj3Thy+d3wSGErH80iqI92VuJNZ+3N2xcVxptKsVHiYJ/+va+MN9SW8p6lpSDhcQa8gVn5FjHHPODOmsgxGgLHOVBV8Mfjhmsn2xzWm3UHm9bijBWghx4LFwz3OgsHtBXJKt5Bedb9qI7up8s88NJ0LSHvwzGi2St0Mp43Q0H8fjFNP4AiGJ0zeLIUzezSdvs4uIzF+dx1Eo/RH1krJyOhrSFu6Pty9HdfsAVmO3W5JKwusMOpX+kJ9ygn65EvCLtio0vPodAV/rQ/GZWe96rcAZi5i9zOaPSz9UpIatYF6dgznmRi+J3PwndzgPvnJnU09XBVfXy8yrNRe7Kw3t8osWHxHC8gZtwQWG6sjdU6rUgh6o04HcCCJQSs6IgCj0cvY8wBK1rE9KcI7tCyp/GgzZtRXAwJ7G1fInYEel5Cm/cqOIvSrwjHNR8G2oxUzR8eVvcKIR0UEwTIajOE3jYXqTjqfD0XQy7g8nb+JkMqXKxEkVetP/iqsR8Tpc4AnDvPJ4tj6BlIrlQ/61U6m6+HcnzW3PlECCbzKAq69nF5/LUuKJ9362hzMLVSgEv8oE37FFSL8TkiQdpJMBKZpEh9x21P+zU3adUkA1rMq9IvGzVzzrfUNqGFJ0zihybfeo6SuBjbGPMb51aE/AvOZdi+ZwUEM5MN5xR/XKH5fCeMjH4Yfkol8ZZrrE0JJ47ppGg3Zkm9Uj22Cr5G5AkyGREO91O7dVNifqlfelmw4GW2qkoD0L3vW10UjONRvEfmaKAZSKHq/BKpi3fXJPXnfvBZARuHFmBel1mgOBvK74VEjUUlNzp6jKKudNQaMEKXTH+LLKKr8JAOcEH+1lxVp9vzu+/saNvcZxTLSPblYqamYu3tdEdFIv/m5z9sb8RE0w6O9fG1PZehkmGaUXhjmyuWoV0n7S50BtPfL5w/Uncfn16my+t5ciA01JJCpX6wtZhs6FSlAYqRYbwVY1VCRp0iEEdCuUFgEM6rWyRhc04XDC0XiDNAkxqGZY/XR1E7CWxvkC9NHNSyb8DujtYZZ62edBbWjO7kGZA43LXCk5orZNHB4+HZo4pFfTegyiUCRnrgg1k223c3B4a/Pdjo9rCeTwQ8CFaJDK8fowUT+K/4/rZvj+U7z+q+OsYu1QqDchDfKKd7T8iZv6y2d3R1QrGqR4KCaw9cUlObv0R09OhlQO6n0W//OB3fkvJAazjQ== +sidebar_class_name: "get api-method" +info_path: docs/api/nerm/v1/nerm-api +custom_edit_url: "https://github.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 a saved advanced search query' (run-advanced-searchby-id)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Run a saved advanced search query

+ + + + + +Run a saved advanced search query + +## Request + +

Path Parameters

Query Parameters

+ +Expected response to a valid request + +
Schema
    profiles object[]
  • Array [
    • = 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true,"description":"The objects UID","example":"profileUid"}}>
    attributes object
    + +Attributes that belong to this profile. + +
  • ]
\ No newline at end of file diff --git a/docs/api/nerm/v1/sidebar.js b/docs/api/nerm/v1/sidebar.js new file mode 100644 index 000000000..33a14dcc0 --- /dev/null +++ b/docs/api/nerm/v1/sidebar.js @@ -0,0 +1 @@ +module.exports = [{"type":"doc","id":"api/nerm/v1/nerm-api"},{"type":"category","label":"users","items":[{"type":"doc","id":"api/nerm/v1/post-user","label":"Create a new user","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/get-users","label":"Get users","className":"api-method get"},{"type":"doc","id":"api/nerm/v1/post-users","label":"Create multiple new users","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/patch-users","label":"Update multiple users","className":"api-method patch"},{"type":"doc","id":"api/nerm/v1/get-user","label":"Find user by id","className":"api-method get"},{"type":"doc","id":"api/nerm/v1/patch-user","label":"Update a user by id","className":"api-method patch"},{"type":"doc","id":"api/nerm/v1/delete-user","label":"Delete a user","className":"api-method delete"},{"type":"doc","id":"api/nerm/v1/get-user-avatar","label":"Retrieves the URL of the user avatar","className":"api-method get"},{"type":"doc","id":"api/nerm/v1/post-user-avatar","label":"Uploads a new user avatar","className":"api-method post"}]},{"type":"category","label":"user managers","items":[{"type":"doc","id":"api/nerm/v1/post-user-manager","label":"Create a new user-manager relationship","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/get-user-managers","label":"Get user-manager relationships","className":"api-method get"},{"type":"doc","id":"api/nerm/v1/post-user-managers","label":"Create multiple new user-manager relationships","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/patch-user-managers","label":"Update multiple user-manager relationships","className":"api-method patch"},{"type":"doc","id":"api/nerm/v1/get-user-manager","label":"Find user-manager relationship by id","className":"api-method get"},{"type":"doc","id":"api/nerm/v1/patch-user-manager","label":"Update a user-manager relationship by id","className":"api-method patch"}]},{"type":"category","label":"roles","items":[{"type":"doc","id":"api/nerm/v1/get-roles","label":"Get roles","className":"api-method get"},{"type":"doc","id":"api/nerm/v1/post-roles","label":"Create multiple new roles","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/patch-roles","label":"Update multiple roles","className":"api-method patch"},{"type":"doc","id":"api/nerm/v1/post-role","label":"Create a new role","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/get-role","label":"Find role by id","className":"api-method get"},{"type":"doc","id":"api/nerm/v1/patch-role","label":"Update an existing role","className":"api-method patch"}]},{"type":"category","label":"permissions","items":[{"type":"doc","id":"api/nerm/v1/create-permission","label":"Create a permission","className":"api-method post"}]},{"type":"category","label":"user roles","items":[{"type":"doc","id":"api/nerm/v1/post-user-role","label":"Assign a new role to a user","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/get-user-roles","label":"Get user role pairings","className":"api-method get"},{"type":"doc","id":"api/nerm/v1/post-user-roles","label":"Create multiple new user role pairings","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/patch-user-roles","label":"Update multiple user role pairings","className":"api-method patch"},{"type":"doc","id":"api/nerm/v1/get-user-role","label":"Find user role pairing by id","className":"api-method get"},{"type":"doc","id":"api/nerm/v1/patch-user-role","label":"Update a user role pairing by id","className":"api-method patch"},{"type":"doc","id":"api/nerm/v1/delete-user-role","label":"Delete a user role assignment","className":"api-method delete"}]},{"type":"category","label":"attributes","items":[{"type":"doc","id":"api/nerm/v1/get-attributes","label":"Get attribute data in bulk","className":"api-method get"},{"type":"doc","id":"api/nerm/v1/get-attribute","label":"Find attribute data by id","className":"api-method get"}]},{"type":"category","label":"attribute options","items":[{"type":"doc","id":"api/nerm/v1/post-attribute-option","label":"Add a value to an option based attribute","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/get-attribute-options","label":"Get option based attribute values","className":"api-method get"},{"type":"doc","id":"api/nerm/v1/post-attribute-options","label":"Create multiple new option based attribute values","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/patch-attribute-options","label":"Update multiple option based attribute values","className":"api-method patch"},{"type":"doc","id":"api/nerm/v1/get-attribute-option","label":"Find option based attribute value by id","className":"api-method get"},{"type":"doc","id":"api/nerm/v1/patch-attribute-option","label":"Update a option based attribute value by id","className":"api-method patch"},{"type":"doc","id":"api/nerm/v1/delete-attribute-option","label":"Delete a option based attribute value by id","className":"api-method delete"}]},{"type":"category","label":"pages","items":[{"type":"doc","id":"api/nerm/v1/create-profile-page","label":"Create a profile page","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/create-workflow-page","label":"Create a workflow page","className":"api-method post"}]},{"type":"category","label":"profile types","items":[{"type":"doc","id":"api/nerm/v1/post-profile-type","label":"Create a profile type","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/get-profile-types","label":"Get profile types","className":"api-method get"},{"type":"doc","id":"api/nerm/v1/get-profile-type","label":"Find profile type by id","className":"api-method get"},{"type":"doc","id":"api/nerm/v1/patch-profile-type","label":"Update a profile type by id","className":"api-method patch"},{"type":"doc","id":"api/nerm/v1/delete-profile-type","label":"Delete profile type","className":"api-method delete"}]},{"type":"category","label":"synced attributes","items":[{"type":"doc","id":"api/nerm/v1/get-profile-type-attributes","label":"profile_types/ne_attributes synced status","className":"api-method get"},{"type":"doc","id":"api/nerm/v1/create-synced-attribute","label":"Create a synced attribute","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/delete-synced-attribute","label":"Delete synced attribute","className":"api-method delete"}]},{"type":"category","label":"profile type roles","items":[{"type":"doc","id":"api/nerm/v1/create-profile-type-role","label":"Create a profile type role","className":"api-method post"}]},{"type":"category","label":"profiles","items":[{"type":"doc","id":"api/nerm/v1/post-profile","label":"Create a profile","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/get-profiles","label":"Get profiles","className":"api-method get"},{"type":"doc","id":"api/nerm/v1/post-profiles","label":"Create multiple profiles","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/patch-profiles","label":"Update multiple profiles","className":"api-method patch"},{"type":"doc","id":"api/nerm/v1/delete-profiles","label":"Delete multiple profiles","className":"api-method delete"},{"type":"doc","id":"api/nerm/v1/get-profile","label":"Find profile by id","className":"api-method get"},{"type":"doc","id":"api/nerm/v1/patch-profile","label":"Update a profile by id","className":"api-method patch"},{"type":"doc","id":"api/nerm/v1/delete-profile","label":"Delete a single profile","className":"api-method delete"},{"type":"doc","id":"api/nerm/v1/get-profile-upload","label":"Retrieves the URL of an attachment attribute value from a profile","className":"api-method get"},{"type":"doc","id":"api/nerm/v1/post-profile-upload","label":"Uploads a new attachment attribute value to a profile","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/get-profile-avatar","label":"Retrieves the URL of the profile avatar","className":"api-method get"},{"type":"doc","id":"api/nerm/v1/post-profile-avatar","label":"Uploads a new profile avatar","className":"api-method post"}]},{"type":"category","label":"risk scores","items":[{"type":"doc","id":"api/nerm/v1/get-risk-scores","label":"Get risk score data in bulk","className":"api-method get"},{"type":"doc","id":"api/nerm/v1/get-risk-score","label":"Find risk score data by id","className":"api-method get"}]},{"type":"category","label":"risk levels","items":[{"type":"doc","id":"api/nerm/v1/get-risk-levels","label":"Get risk level data in bulk","className":"api-method get"},{"type":"doc","id":"api/nerm/v1/get-risk-level","label":"Find risk level data by id","className":"api-method get"}]},{"type":"category","label":"user profiles","items":[{"type":"doc","id":"api/nerm/v1/post-user-profile","label":"Create a user-profile contributor relationship","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/get-user-profiles","label":"Get user-profile contributor relationships","className":"api-method get"},{"type":"doc","id":"api/nerm/v1/create-user-profiles","label":"Create multiple user-profile contributor relationships","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/patch-user-profiles","label":"Update multiple user-profile contributor relationships","className":"api-method patch"},{"type":"doc","id":"api/nerm/v1/delete-user-profiles","label":"Delete multiple user-profile contributor relationships","className":"api-method delete"},{"type":"doc","id":"api/nerm/v1/get-user-profile","label":"Find user-profile contributor relationship by id","className":"api-method get"},{"type":"doc","id":"api/nerm/v1/patch-user-profile","label":"Update a user-profile contributor relationship by id","className":"api-method patch"},{"type":"doc","id":"api/nerm/v1/delete-user-profile","label":"Delete a user profile assignment","className":"api-method delete"}]},{"type":"category","label":"role profiles","items":[{"type":"doc","id":"api/nerm/v1/post-role-profile","label":"Create a role-profile contributor relationship","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/get-role-profiles","label":"Get role-profile contributor relationships","className":"api-method get"},{"type":"doc","id":"api/nerm/v1/post-role-profiles","label":"Create multiple role-profile contributor relationships","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/patch-role-profiles","label":"Update multiple role-profile contributor relationships","className":"api-method patch"},{"type":"doc","id":"api/nerm/v1/get-role-profile","label":"Find role-profile contributor relationship by id","className":"api-method get"},{"type":"doc","id":"api/nerm/v1/patch-role-profile","label":"Update a role-profile contributor relationship by id","className":"api-method patch"},{"type":"doc","id":"api/nerm/v1/delete-role-profile","label":"Delete a role profile assignment","className":"api-method delete"}]},{"type":"category","label":"workflows","items":[{"type":"doc","id":"api/nerm/v1/create-create-workflow","label":"Create a create workflow","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/create-update-workflow","label":"Create an update workflow","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/create-batch-workflow","label":"Create a batch workflow","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/create-automated-workflow","label":"Create an automated workflow","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/create-registration-workflow","label":"Create a registration workflow","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/create-login-workflow","label":"Create a login workflow","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/create-password-update-workflow","label":"Create a password reset workflow","className":"api-method post"}]},{"type":"category","label":"workflow actions","items":[{"type":"doc","id":"api/nerm/v1/create-approval-action","label":"Create an approval action","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/create-ask-security-question-action","label":"Create ask security question action","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/create-auto-assign-action","label":"Create an auto assign action","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/create-batch-update-action","label":"Create a batch update action","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/create-close-session-action","label":"Create a close session action","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/create-contributors-action","label":"Create a contributors action","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/create-create-profile-action","label":"Create a create profile action","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/create-duplicate-prevention-action","label":"Create a duplicate prevention action","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/create-email-verification-action","label":"Create an email verification action","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/create-fulfillment-action","label":"Create a fulfillment action","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/create-identity-proofing-action","label":"Create an identity proofing action","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/create-invitation-action","label":"Create an invitation action","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/create-ldap-action","label":"Create a ldap action","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/create-notification-action","label":"Create a notification action","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/create-password-reset-action","label":"Create a password reset action","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/create-profile-check-action","label":"Create a profile check action","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/create-profile-select-action","label":"Create a profile select action","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/create-request-action","label":"Create a request action","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/create-rest-api-action","label":"Create a REST API action","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/create-review-action","label":"Create a review action","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/create-run-workflow-action","label":"Create a run workflow action","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/create-set-attributes-action","label":"Create a set attributes action","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/create-set-security-question-action","label":"Create set security question action","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/create-soap-api-action","label":"Create a SOAP API action","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/create-status-change-action","label":"Create a status change action","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/create-unassign-action","label":"Create an unassign action","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/create-update-profile-action","label":"Create an update profile action","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/create-username-password-action","label":"Create a username password action","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/get-workflow-actions","label":"Get Workflow Actions","className":"api-method get"}]},{"type":"category","label":"workflow sessions","items":[{"type":"doc","id":"api/nerm/v1/get-workflow-sessions","label":"Get workflow sessions","className":"api-method get"},{"type":"doc","id":"api/nerm/v1/post-workflow-session","label":"Create a workflow session","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/get-workflow-session","label":"Find workflow session by id","className":"api-method get"},{"type":"doc","id":"api/nerm/v1/patch-workflow-session","label":"Update a workflow session by id","className":"api-method patch"},{"type":"doc","id":"api/nerm/v1/get-workflow-session-upload","label":"Retrieves the URL of an attachment attribute value from a workflow session","className":"api-method get"},{"type":"doc","id":"api/nerm/v1/post-workflow-session-upload","label":"Uploads a new attachment attribute value to a workflow session","className":"api-method post"}]},{"type":"category","label":"identity proofing results","items":[{"type":"doc","id":"api/nerm/v1/get-identity-proofing-results","label":"Get identity proofing result data in bulk","className":"api-method get"}]},{"type":"category","label":"advanced search","items":[{"type":"doc","id":"api/nerm/v1/get-advanced-search","label":"Get saved advanced search queries","className":"api-method get"},{"type":"doc","id":"api/nerm/v1/post-advanced-search","label":"Save an advanced search query for later use","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/run-advanced-search","label":"Run an advanced search for profiles, without saving the query","className":"api-method post"},{"type":"doc","id":"api/nerm/v1/patch-advanced-search","label":"Update a saved advanced search query","className":"api-method patch"},{"type":"doc","id":"api/nerm/v1/run-advanced-searchby-id","label":"Run a saved advanced search query","className":"api-method get"}]},{"type":"category","label":"job status","items":[{"type":"doc","id":"api/nerm/v1/get-job-status","label":"Get the status of a bulk job","className":"api-method get"}]},{"type":"category","label":"forms","items":[{"type":"doc","id":"api/nerm/v1/create-form","label":"Create a form","className":"api-method post"}]},{"type":"category","label":"form attributes","items":[{"type":"doc","id":"api/nerm/v1/create-form-attribute","label":"Create a form attribute","className":"api-method post"}]}]; \ No newline at end of file diff --git a/docs/api/v3/access-profiles.tag.mdx b/docs/api/v3/access-profiles.tag.mdx new file mode 100644 index 000000000..fd98d925c --- /dev/null +++ b/docs/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/docs/api/v3/access-request-approvals.tag.mdx b/docs/api/v3/access-request-approvals.tag.mdx new file mode 100644 index 000000000..45cc17c2f --- /dev/null +++ b/docs/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/docs/api/v3/access-requests.tag.mdx b/docs/api/v3/access-requests.tag.mdx new file mode 100644 index 000000000..b4a0b996a --- /dev/null +++ b/docs/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/docs/api/v3/account-activities.tag.mdx b/docs/api/v3/account-activities.tag.mdx new file mode 100644 index 000000000..8d356bab2 --- /dev/null +++ b/docs/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/docs/api/v3/account-usages.tag.mdx b/docs/api/v3/account-usages.tag.mdx new file mode 100644 index 000000000..b4ff6e232 --- /dev/null +++ b/docs/api/v3/account-usages.tag.mdx @@ -0,0 +1,23 @@ +--- +id: account-usages +title: "Account Usages" +description: "Account Usages" +custom_edit_url: null +--- + + + +Use this API to implement account usage insight functionality. +With this functionality in place, administrators can gather information and insights about how their tenants' source accounts are being used. +This allows organizations to get the information they need to start optimizing and securing source account usage. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/docs/api/v3/accounts.tag.mdx b/docs/api/v3/accounts.tag.mdx new file mode 100644 index 000000000..3f54a4d82 --- /dev/null +++ b/docs/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/docs/api/v3/approve-access-request.api.mdx b/docs/api/v3/approve-access-request.api.mdx new file mode 100644 index 000000000..ee7150713 --- /dev/null +++ b/docs/api/v3/approve-access-request.api.mdx @@ -0,0 +1,107 @@ +--- +id: approve-access-request +sidebar_label: Approves an access request approval. +hide_title: true +hide_table_of_contents: true +api: eJztW2lz2zgS/Sso7occZcqyLEe2v2wptjPlqVzr2JvadVw7EAlJyFAAh0ccrcv/fV83QOqgfExmamcmRSflkslGo2+8hoCbwKYqk4W25jQODgOZppn9ooZRpPL8TP1SqrwItoJCTvLg8DJwz4V/IYZMLZM8uNoKYpVHmU6JFRidT3UulIlTq00hPNtcSCOk45F5HtLz6Ih3JpmLYqqEvTYqE3bMf1TvMTQW785++M/w+M3pW1HmKgO7DARJYq9VLAoroMrYZjOMw+QyIlE6kD6VmZypAgOgw02gSb5UFlO8MnhRqy0T2GAryKOpmsng8CYo5im9zYtMm0lwuxWQ0DpTsFSRlaqpsxI6XhecJFBf5SxNiFcvOtjZ7+6PBr2D/kjJ3e4OPu292I/wv9vtqeD2yk0D27y08ZzEWJ3lTH3R6lplT3IR2dlMmYJmWEg2hj8gWmRNgXc0HpIkOmInb3/OiclNU0k7+qwi8jWkhh0LrXJ666doWgO2K5NEjkirTcY4cgOFl2PVChwd5KOFCrBulClZkArNucitElIEMSjCQsNr6xMe4w0HCb2t+IprCTM5vmuOgOXD7iDc2Tnf2T/s7x3uDjrdg/1/kyCyLKY222QccIopTjfrPORxVQBUpls3qePZ1FGZckZJdnp88vb89PxflFQLeeunm6KOWNG0Xk6ooDeasTmyNBqxJk6PK6lrVRsx2x+o3t54dzCA5VRPqv1Iqv6Lve6I5nOJ9JgZY52niZwLGnHPpJ/t1HRii4TADyqQLvixD6vjwvoXmcpTa3Jn2l6310wYKlop/C9CFK6izAw+ajdvVYQoSvKSC9MYUT3nIsVjUL0sk+bzvFAziqFvzCwnbr/bbUp4lGiK1ZMsQ/TcLeUI9YCyRhuUFR3/BlnWQzJWhdTJkY0f4cNX2qhwkklNEioWOcJAQdVOxxghZhZl2bGsHMx0qwkIS3R2xEsZ18vJkVeG3J3J6GfwOn1EGF+4EK6GUAlGubhrWjVQcvSie9Drj1/0pezt93cGe6ODsdzd7R7sHRzQ7DPEgZwsZ2sgs0zOG1P/oLBS6UgkNoJH/guDoEDA9iwAT44hGnGTP+wD5vHIHHK0tZpeXlGor8UWiurLo/eiPxCJNJOSn8vJmhFMePGhUcKhuWP8LtMTbe6rUccnr4YXr8/x5OzkHxcnH/CJeDVgwNAgWmMKS1cXp/aaJfYKcN6pBOZAeRbPPdfnUEiafJlQ50tJiNgayzIpMMLPvmHEMmsxzuxsJZU4b74W4qnuqM6WGNEzLDDRVIxkjgFwIZE/d7UjfO0t+VxMsQCo7FlHDONYk5JAJshGMMX4ORgJGcdcN5jBuEQqQxiNhaEshLGFjtSqLxamXF9Qq5r3etkplByQ/OE4GUZFCeFYzeUsrKPFi+j9A5md5dZX6rUqOTcFIStQokxGNstgYTGCbrrIq8We3JWj8JiKrq5Yy6Wcy90bJ4yr56hnsswfkXfvE5SfkFWrX3xRPvlyhoJcjdgblZt8RfL1nAd7qtpdVeKLsVZJ3OZum7tt7j4yd9dfnnlctkBq/e5OE/pcGAe2efFsQJ+Mo8dYURExvPGO3BIwiIdIP348R2L/rAzRq68ptUK/Iz5yS3kTWdb+cM9HBD9qZ634ggRkOzoNxqhEKj5kuRcSs6GcqXabs72y2UgjQM0GiEjtsJjbkjvirDSGJJH5lgCCzs2TQkwl6qNvvbkCuvY85P68RZItkmxXo3Y1+n5WoxZJtrnb5u5fM3fvRZK1VJwtHifl5Wwms7mLNP+etJUCBKLaIVzsMrKr1tEKMRM1xgpWkUMw6u2MdsaDSPVj2Y9f7B6Me9GLntwb7Ax2Rv3eIFhe6y8XeVwn2WpOLfnb+ZFNDBD3BTiuNAiuvLA2Xt3+g3kzNaayRqWnxs2wOUx6tcCO/SZ2fGsL6AbGwI7ZHduLF2eviT99r0LsyW62zCJFMNuZDuSyYEhJMQxLa/52qIWOLXRsl592+fk+lp8WOra52+buXzN3fxV07D8EHfu/Ajr2BUGsMUGsPxI6xsAdBM3GcAqdrihhXkOwMYUq+OR3H33aFzKbqKIGeisosnfQRJHn1oo30swrsJSv7ESahbmovIF2RrRZRQsCKSYokYYO6mjrTsrQYQ1gUjq8keiZ5jwmhcA3m4fDcQGtXM5U8VbPok2UlJCQi0Jiae/VIsY0wkmNCf6BA++DTlCof8c9Tu+t37QfLM5I49eksTj5GilFOV/v/+5tOiVwCuEzKhcfnK/vOC7g9sylQRuhvqaufNUQtIXqLVRvl/t2uf8+lvsWqre52+buXzN3fwVU92jobqgOgkdDddB2uqLGUq8ouP7viJ1TxUvA4S1sxFg9XmBwxhUIJRIotbzRyofWD4Nt9z1+6H0VVifN8+2bxUH2221/6B7jXHPgZC2zBCymRZHmh9vbN3AhXHfbkanuoLLBi8Xc2OtOZGfbX3Y3FCR3cJuCCdzjkg/Zi+H7U9+BdNjwmabYdoWQJ3BuYFUpiuEOPnhwL//qgPAczYlwbLbopLOPM34MMVM0GU9ypu5wXDV0hG4XWXL7kD7/3L1PD8fkDj02me/euUAvIOWaeiT+FbkLsQBG7K8LyHPkKhgdL8ezq2WaD4TYnYQNysUqRN8V9BoCvSOynnipZIZ2wh2fefrjx/NnYkI4letEmRNEVpoaC2Tae4QR18FhdZSEBvHSlNlyMmXlhiuHdSjvxDiBUcQn80EpcXnqDfUWC8QZKjqbnQYpLiI06upp5b1YfVEJrZ2dhbUpOHVsEOF6W66Me8brJDcU2rhLA3QJ5JMJxbGm8qVpvScaryL3h+IyrfSSS3p9qxB/q7iFPlGZW/5sTQpn2svIHf6OkPzEAmnM1vrmyR2/cIkfdV94QlzXZSBLeDlWj1hFlde+WY4VfiHxW5Xjk/k41ViEV4cJV/NEjjU0icWpiKbW5urvQlDoUKpcTkpk2jeLdU2ThpwRYa+7JFLopgx1CEjJ8r1GYhgXTHJESzojGus2Vzhtf2LPoi78xDdPflrRmR9fYuUlythG+TfLTBOGNGHo6kTu5XcLGwUWcpt0cFd2OACOFv7nSuAFXaqLjtfGys/st3kMLR8RRGUueXro/jhcFEH/SfALoq5pUKYJkdeHzvC38Lxu61s23ljVXsK6BZvyJhaL6prdnLz1N6K00P7Z9CWNh4stF7pE9HtX6TsqyZ+n7v5BFa+tNN9jpfEYmbYuzxb3JU+qbmbp6uKm64ZLtw3vvQpI0cxa+V5lOYccYGzuL9IG+FThN95yIWCsj06Ke0OGSMts0kQW7toqSkY01Yp3JlJIR+Bzi8LWzjjNgbiptqD/ZEYT1iCDPSR6SZ2AX0d8ROtnIniQ2j46EQyun63v/z7Aie/5Ru5xFReCbtSVBmMphcuZkIi+B4In1nlUuhqHLtCoSjPLKLEeVSU8RSWZosMNUDbL341pCxvd8VKMPDAXQiT3+9cwJHnEX91dKHKmEg5iolvtAB7ijcAMpypJyeEo0MBqammGN6fnDY5gZvyXJjabbPtB+TbRggl1Wy4YdjtoN+kRtXDokpf4Dh9xKXo9uG4WO/h/qivWfgmj3mM7pc02Url0/ZLrWi+Du7pWDD9cuYBdNa5oc6bU+GLszQ3t1VAXd0uPwYE2Ai6vFk0aN0twKH1e3IK+03hPz/yF6Wf8bdPma9sbtao2Gs18sccQ4OPPirYmlhRBIw8FeA+JhXME/kuL8HzO6KFi0Pg2hvpYN8LtS91Le7W0V/D+He3QBSN/eXzmtj0yeY2H9Psw+IR/+MOmLltAxM9vgmoTETSOL/38D1oGX30= +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Body

+ +Reviewer's comment. + +
    author object
    + +Author of the 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/approve-approval-item.api.mdx b/docs/api/v3/approve-approval-item.api.mdx new file mode 100644 index 000000000..ae648d247 --- /dev/null +++ b/docs/api/v3/approve-approval-item.api.mdx @@ -0,0 +1,107 @@ +--- +id: approve-approval-item +sidebar_label: Approve an Approval Item +hide_title: true +hide_table_of_contents: true +api: eJztXOtT2zoW/1c02Q99DHknkPBlNxfo3XQoZSG0O8tl5iq2kqh1pKxlQ7MM//uecyTHdmxKQpn7mnxpgy3pPHQev3Ms+76iFyLkkdRq6FcOK3yxCPWtGNB/PBhGYl7Zq0R8aiqH15XPOvzK8Jqp3OxVfGG8UC5wLswczaRhg/Mhc0sYxhVL1qFJNXYio5kI8Qb351LtMR0yuML0nZJqWvfiMBQqYrGBQfPYRGzOvwoYASuH4r+xMFENuFnwkM9FJELk6b4ikfqCRzO4peAG/CV9+G28mZjzyuF9JVou8KqJQqBSedir4GIyFCBwFMaiKIlgw2OmJ8TbHcosrR7ENz5fBLiWmLR7k36n3TkQ/U53vzXujse9TqvDu/vt/oHfAyqlnPGMYocvyGWyLnFay7HabDWbY4/zNvzfGntist9stbg/bjXhd5N7lYcbpGUWWhlhkJNWo4H/5ekNUk0Y5ouIy8AwPf4iPNoUT6sI9g7nAS+B9Mim6l8MTr4vimln4m6GaIGRtKRh5wqqWJf8qb1pef1mr9Frd/2W6Db3e41m12+3Jr1+w+PNbq+Z6BbMSYTDrQiupm1HELY/DgI+xtG4l1kGjqVZBHx5RvbxFCe46b6dgAb1fbbe65lil3Np7W+dAfC5zaTPGxpN+2HpaZXNRc7KWmTgPQcjc4LC2l4oeCRKBZvocM7BRis+jKhGEujnJGk0D6qNg2qzOWr2Djvdw/ZBrdHv/afIE8xkdzOh8lbI7rhhCXngZK59OZHPZaVXbexXW91Rq3HYah22erVmo7MdKwGHEBovfOKnZBdyK21keumV77vgESmBcc/TMQR0GG50HHqCvRocv0LVmAjulxEVKp5jqnknlTQz4vtCYKhwP6M4VPTz5NuCguNe5Vwo304+4soTAVy8yTKTWaooEjGCwvCcKJGMaC5mPIzVlzjsA1cxD5JLBuWw7D8uxs8CrFV6yBsGuYmLiyTKXPgy+esY2J4mfyRZE35+kjqgyxfiVoo7uPIODAeF1hBjl3hbJ9OOZjwIhJqiJQ3nC+5FA8WDpZEGLlzKqdKTCSruFuP0XsVKM/Dc7BEEkLzeUt6LakN5y0xgXW8jGFeitjAV3l5LVcjDkC8L1rpXkWvjfiCB5COat7Yx2yWSiIdTEW0fR3NUmV3lmcSfF0efZOALpI+aSaKqHfDcZLUdZUAKMhj4PoASspYMoHierFlEYgNRjh76wK1gxxBPvEiHS6IZwdLjOBLPpJhMZ2MB4xOZKQilhBczrcRZPB9DRsvS/Jhg8s0IryB8uYa1yrOUY8Gmhxz1TzyINxT5FoduJ3O32ap2u90qwNIWklUclT/0ISjJaLmppmnDpJuUMFBmxIgNrBUDtYc0QF3kI9CxBbSV9awIsDeQkEWBQiZmWRTsTHOF53+HKJaD/a8MxJetY4jL0RvScwk9FBMBpZonfDZeFguQx+JICQbJuOZv4tdqY3demTPolWY9GqLKAO52HpyllU4t99Pbzd0zu6ydll2S/2Nc8/S8jP0VPANE8XFCZfajQG14Nrz85wka3sXJ+5Ojkfs5uro4o58n/z4fXtCv85Oz4+HZzwhVBmdHJ6d4EUnn0Vq63o+hNSrB1yS7yYaAbJNjA/+3lW804xFTAgw/0hDnkm6Hv51tpTi9YFkD52IWQpdtDuwZDH12idOrNhvVZn/UbB92+ljitHvdkroC4ynWFiDu3Ux6s7X6ImWihEMwjfWAKFUkplS4rTiES+1WuY9TSkyVLtXjtUazX8IA0ig13xdpO0wsBP+xEngzYznLRLsCWWcql1A7EIpnrjYo0HIWv4llIhFmx5dZZUoLBjLsMNSONYUlE4+3JZNMyferzgPBDbg6UWKTUM+d9EGg71xrzGb6KwMGtXXSoO4iubGZ6Tjw0Yvh152yjcaClt9zJVZCWuHLMv2jmX1TG9zeIHC7h+vp9p0Ugd/MYZ1kXBrknuIFzEcETzNzisMSbpxucsxcOmMhpDFxbGyhvUI4PnXBOBHJ1NKfzOMKN9MRddIyrvw62CrpJdFAhsdryAnYAU2UlZ9d5MDdNzmvXNd2VtOFFATEw1CHm6ghbQan/K4lEAhLZMzY8DEL4RHipr+UBvcBr/VrxW79QDGiiVJYbuwqmnrwPvNjJLwWdbNSZsr5B7zeKesZHwUS+/knSIBVWdK9YTLXtmRj7S+ZxDAP2Vj6L9hOtn3qI+1v4FnvpBLVacglckg6gSTnC4b5XWKDic11KFzrO9l9GpePX6CJWpP9xH2Q18p35IRB9YXc+wprbdIwuFIS5rNkCpQ7FHQfISsOBB/vN/qtzmS/w3mr12kedMf9CW+3G/1uv08NSUCrfCrKLC9P2rV+WKA92JH/gUIAjRgX9Yn49yLeWizBNTZMC3bsSkzHL4vEt2gPMN9PR+esc8ACrqYxXefTNSWo6tVlWQa0C38M5VSWQvIEzR6fvBtcnY4Iwf7r6uRytEKoBf+Rykez1IRTIH8Qx04AckZKYMKvsbdu1bcgEFcmO1Dav8zSoC/7YsLjIIIZjnrJjOzSaXZMXIn85lvEXsuaqO1BNKSHaBHAtzEkVT/pBbyFfC4WUfXUafItmwnui/BNjUFRI1FIKOWoZDAwf0lI1/fRde0CkxhcGZiBqk7HEYYa6a3l8VSV60VwEkNOs5uCzgGcP20nUNXFwByJmfXClbU4Ft3+AM9Wc3nuRhmlkUqXKuIQ2WFksAQ1hlgzMqidIPQZ5sIRbpeBwKOScauIlQ2NFO4+WGaOI033PB6bDfzuPIDwUyXRVjduhXM+gyWHjUa0G8k2uYgEN6kJgpPdqNV2JY7PJpgFd767892d727ou+s3L9yTcneXoE+zCH2uFI9BvyElzwL0Ccl6lGbJINtWtBtJxyIcRHr/eQSO/VUoHC/sI68XxEc2lZc860/2w14fJ1gwSf2Z6ggYJD1aCSYQiYR/SHynHJOirKraRWoAmMcSDFSVQEQq1pY6BrQKex4rPCfCuNljvhZGvYrYjN9SWxL4tREQqSq/utBSveTBhB2S3CHJXTbaZaMdktwhyZ3v7nz3pZHkiivyFoeTTDyf83BpLc3dt0+/YABLzmyylcutHg1m0QouxlYYq5JHDpVxqzluTg480fF5x99v9yctb7/FuwfNg+a40zqoZHP9derHKyfL+1Rmv+0+2sd2IrwFHBcrMC4Tae3n238xPVDGsIahZ4WbQeeg0psUO3aK2PFMRyAbLAzYMXykvXh1cWofWNvlUW/2MBo6LanO9j4RUlLTVHyTJtpBxx103KWfXfr5y6SfHXTc+e7Od/+cvrsVdOw8BR07W0DHDjtLHiP/ntDRB9xBz7NhU0CG5E2xUCxAFPjFV2dS0oOgK6CXQ5GtfhFFjrRmH7haJmDJ5DqRKlUXhjcYO8exYTIWBnA2hRCpGEQtCegWrQrPTgEmxfNqgZxL8mMUCNYNl9XBJAKprM8k9raiIpUXxMAhBYVAY+9Vg41JMCcxQfgHK1AfdAqB+gV7nG63fqgfzC5Q4lOUmJ1884RAn1/1f7tlpwSGwHyI4eLS7vUjxwVsz5wrKCPEt4UNXysIuoPqO6i+S/e7dP/XSPc7qL7z3Z3v/jl9dwuo7tDQ41AdBmwM1WFsrcFWWOodGtdvjtjJVRwHZN5Me/ZEaYrBCVeAKSFDC02NVvpGwmGljkdNqxRq6vfSf6i7lyvq9/nPJjxU8CQ2YkXLZhwGMHsWRQtzWK/fw+7Brj3U+ELWklfElL7Dd13qt+2SWIRHT63fARU/tkeW8VMWlkiNdB5KNGsbA4mA3QGSEg0YdoLOHHx3/eQc+hLqEmaX2cN3aZ2J0WV8swLqC/fWUY1MqiAjyHYVBg9PyfOp/T057CKPyFGmvu/SgvEMuFwTr2JPVxsBZkDv98F+4bn9Ixu8BjHu/PVNdswlgnXLYWFkmoDwMUHx7ZGPOKzFfhI8xFP+dHLm9fvPozdsihCVQkRsEB0L9y0Sdg5mRCFwkJwiwUmUlUIdT+2LL4PcOR10OTYJQCnsF3UpBLtO3l88g9xwAcGc1I6TBMUPnHXzOtk9X9yKANNmLdU2Gqf0FZi8rPPcvDeUIqmWkMq+PANXa7+oqnuzjU6j4xgnIpWG7HqRyMUzcj2Xib8lq1XtalVazbxZ48Kq9tqz57498HtcggeGtPVs4na9amY9LLzgCq66zgNqwvGRP13lJbv2bD5y61VxvTwfv6jP9KpUfhqz4S553WTIvJnWRvydMTQddJXraQye9my26P2sKnlEtdXIsFS1JKuyCmiS+DsFx1DWmPgYszmBGW37KuS2v9LOQlz4Fd+cYL/mZKbL15B0caSvPfNsnpFgFQlWbZwwjn/3ZRlgFnwbZaA4YA3gKN1/igSO0UxctGuVRn5avk5zMH14wCqtYhaH9o/DNAi6X4xu4OjVGAjTCMZX583gb+bWwsSWU1bSRljXYJHfQEM+XdOb5Xf1MBRz7B9NXpR4kHZbPqpg+dJR+pFI8seJu79TxNtFmr9ipHHwGM2NyLo6ImvkFtEVe3/YnJ4J+BfukqcSDocqh+o2wjDZZRYBj+yrnuDT3kwK6hosBI8QHe6hXek5+SFAYnR+qA1poSm9lhwCwxzqPBnAejX2Gcoy5YGKsSTD07qw6hftarNL0PI5bhI7TjYOANR8Hiv8dAMwEc/xJeOndteXxottEIIKTYlEMk0wbjUr8Ug0G1RFjYqTcG4+TrC9DJVrZhOfoAV7aFxvGRSZvqNZSQW5EPbzPDguD9GfWhsspzoTwQKLQoigAKZEhsKH4aiwIiym3AMNHU7rbpKp41j8LgAIb42hXYNSEC9heQUVbGZd+867KHybb92g7tOO+m/4ZT+XNRDu1xfY2kIhYlui2BrxupLWiDDhkL705/jCv9e+rwdVxQxLTJh3f49dESyaHvAy0MSS+/omrYmoNoHtwd9QnE7A+de/updVy+sL932+N/Rcp/yrdKUSJS09tUyr+Qr8/CqwCSB9em30BRgpfBTwGdysKZReX7X9I1KXHWQ7TJnphWcwWN+tqv7zj5dgsQ//B1s/lAk= +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

+ +A work items details object. + +
Schema
    remediationItems object[]nullable
    + +A list of remediation items + +
  • Array [
  • ]
    • approvalItems object[]nullable
    + +A list of items that need to be approved + +
  • Array [
  • ]
    • form object
    sections object[]
    + +Sections of the form + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/approve-approval-items-in-bulk.api.mdx b/docs/api/v3/approve-approval-items-in-bulk.api.mdx new file mode 100644 index 000000000..943039c0c --- /dev/null +++ b/docs/api/v3/approve-approval-items-in-bulk.api.mdx @@ -0,0 +1,107 @@ +--- +id: approve-approval-items-in-bulk +sidebar_label: Bulk approve Approval Items +hide_title: true +hide_table_of_contents: true +api: eJztXOtT2zoW/1c02Q99DM47kPBlNwV6Nx1KWQjtznKZuYqtJGodKWvZ0CzD/77nHMmxnZiS0E7vY/KlDbZ0XjqP35Fl31f0XEQ8lloNgsphhc/nkb4VffqPh4NYzMxAvUnCL5W9SswnpnJ4Xfmkoy+MblVu9iqBMH4k50gCCAyn0rD++YCNYA5z5OCKI2inVdmJjKciYlwxHsyk2mM6YnCF6Tsl1aTmJ1EkVMwSA4NmiYnZjH8RMAKIR+K/iTBxFQSa84jPRCwiFOu+IlGAOY+ncEvBDfhLBvDb+FMx45XD+0q8mONVE0fApfKwV0FiMhKgehwlYl0ZwQbHTI9JtjtUW4L8QFJ85bN5iLTEuNUd99qt9oHotTv7zVFnNOq2m23e2W/1DoJu5eEG2Zi5VkYYFKJZr+N/RVb9jLxhgYi5DA3To8/CJ019rWIwCM4Dm4bSpyWrfTY4+X5dQzsTTRThAsfSsgZzrFlhVemnFG76vUa33m11gqboNPa79UYnaDXH3V7d541Ot5GaFdZIRIOtGC6nbccQVjsJQz7C0biMeQGOpZmHfHFG7vCUJLjegZ2A/vNtsd7pqWKXM2ndbVUAcOTNtC/6GE37bu2JyuYq53VdF+AdBydzigJtPxI8FqWKjXU04+CjlQBGeLEE/gVN6o0Dr37gNRrDRvew3TlsHVTrve5/1mWCmexuKlTRC9kdNyxlD5LMdCDH8rmidL36vtfsDJv1w2bzsNmtNurt7UQJOeSlZB6QPCWrUKC0ketlV74dgkdkBMZ9XyeQJWG40UnkC/aif/wCTWNiuF/GVKhkhin8rVTSTEnuC4Gpwv2Mk0jRz5Ovc8qLe5VzoQI7+YgrX4Rw8SYvTI7UukokCCrDC6rEMqa5WEmwIlzisPdcJTxMLxnUw4r/uBq/CPBW6aNsmOTGLi+SKjMRyPSvYxB7kv6R1iL4+VHqkC5fiFsp7uDKW3AcVFpDjl3gbZ1OO5ryMBRqgp40mM25H/cVDxdGGrhwKSdKj8douFvM03sVq03fd7OHkECKdstkXzcb6lvmAqt2G8K4ErNFmfL2WmZCHkV8seatexW5Mu47Ckgxo/krC7NdIYl5NBHx9nm0wJVZKs9k/rw8+qQAn6F8VE2aVe2A5xar7TgDUpBhPwgAlJC35ADF83TNIxKbiAr8MAZuBTuGfOLHOloQzxhIj5JYPJNjOp2NBIxPdaYklDGeT7USZ8lsBBUtz/NDCnk3Y7xEyOUW1qooUkEEWx4K3D/yMNlQ5Vscup3OnUbT63Q6XqPZaCJbxdH4gwCSkowXm1qaFky6SakAZU6M2MB6MXB7yBLURTEDHVtAW1mtigB7QwlVFDjkcpZFwc41sz7k52exlD0J9MJAftk6h7gavSE/V9AjMRbQ//giYKNFGmKZJI/lkRIMkgvNnxLXauNwXroz2JVmPZqiygDudhGc55VNLY/T283DM0/WTsuT5P8YVX09KxN/Cc8AUXwYU+/6KFAbnA0u/3mCjndx8u7kaOh+Dq8uzujnyb/PBxf06/zk7Hhw9gtClf7Z0ckpXkTWRbSW0fs+tAa2ul/V7CafAvJ7CBvEv+184ymPmRLg+LGGPJduIATb+VaG09c8q+9CzELossWBNYOhz25xul6j7jV6w0brsN3DFqfV7ZT0FZhPsbcAde+m0p+u9BeZECUSgmusJkSpYjGhxm0pIVxqNctjnEpiZnSpHu81Gr0SAZBHqfv+kG2HsYXg39cCb+YsZ7lst8bWucol9A6E4pnrDdZ4OY/fxDORCbPjy7wy4wUDGe4wVI81pSWTjLZlk06pFlidh4IbCHXixMaRnjntw1DfuV0xW+mvDDjU1kWDtuwojM1UJ2GAUQy/7pTdvVuz8juuxFJJq3xZpX+0sm/qg9s7BC73YLXcvpUiDBoFrJOOy5LcU7KA+4jwaWFOcVgqjbNNQZhL5yyENMZOjC2st5aOT10yTlUy1ewn87nCxXRMnbaMq6AGvkp2SS2Qk/EaagLugKbGKs5el8DdN4WoXLV23tJrJQiYR5GONjFDtg+cybtSQCAtkTPjho+ZC58QN/2lNIQPRG1QXd8F7ytGPFELK42lomljO2BBgoxXsm5ey1w7/4DX22V7xkehxE3yE2TAPJbu3jBZ2LZkIx0smMQ0D9VYBj9wO9nuUx/pYIPIeiuV8CYRlygh2QSKXCAY1neJG0xspiPhtr7T1adxxfwFlqg22BsegL5WvyOnDJov4v4XoLXJhsGVkjCfpVOg3aGk+whbcSD4aL/ea7bH+23Om91246Az6o15q1XvdXo92pAEtMonoszziqzd1g8LtQ8r8j8wCKAR47I+Mf9WxlvJJUhjw7Jgxy7VdPKyWHyN9wDzvTk6Z+0DFnI1Seg6n6wYQXlXl2UV0BL+EMmJLIXkKZo9PnnbvzodEoL919XJ5XCJUNfiR6oA3VITToH6QRI7BSgYqYCJoMpeO6qvQSGuTH6gtH+ZhcFYDsSYJ2EMMxz3khl50ll1TEOJ4uZrzF7KqqjuQTakJ1MxwLcRFNUg3Qt4DfVczGPv1FnyNZsKHojoVZVBUyNRSWjlqGUwMH9BSDcIMHQtgXECoQzCQFenkxhTjfRX6nhmytUmOM0hp/lFweAAyZ/2E+jqEhCO1MxH4dJbnIhufUBma7midMOc0cikCxVzyOwwMlyAGSPsGRn0TpD6DHPpCJfLQOJR6bhlxsqnRkp3760wx7Gmez5PzAZxdx5C+vFIteWNW+GCz2DLYbMRrUa6TC4jwU3aBMHJbtRyudLAZ2OsgrvY3cXuLnY3jN3VmxfuSbm7S9CnsQ59rhRPwL4RFc816BOR9yjN0kF2W9EuJJ01cBDp3achBPYXoXC8sI+8fiA+sqW85Fl/uh72+ijFgmnpz3VHICDZ0WowhkwkgkOSO5OYDGVN1VrnBoB5JMFBVQlEpGZtoRNAq7DmicLDF4ybPRZoYdSLmE35LW1Lgrw2AyJXFXhzLdWPPJiwQ5I7JLmrRrtqtEOSOyS5i91d7P5oJLmUiqLF4SSTzGY8WlhPc/ft0y8YwNIzm2wZcstHg3m0gsTYEmNVisihMmo2Ro3xgS/aAW8H+63euOnvN3nnoHHQGLWbB5V8rb/O4ngZZMWYyq23XUf72E5Et4DjEgXOZWKtg+L2X0IPlDGtYepZ4mawOZj0JsOO7XXseKZj0A0IA3aMHtlevLo4tQ+sLXm0mz2MhkFLprN7nwgpadNUfJUm3kHHHXTclZ9d+fnLlJ8ddNzF7i52/5yxuxV0bD8FHdtbQMc2O0sfI/+e0DEA3EHPs2FRQIf09atIzEEV+MWXZ1Kyg6BLoFdAkc3eOoocas3ec7VIwZIp7ESqzFyY3mDsDMdG6VgYwNkEUqRikLUkoFv0Kjw7BZgUz6uFciYpjlEhoBstvP44Bq1szKT+tuQilR8mICElhVDj3qsGH5PgTmKM8A8o0D7oBBL1D9zjdKv1XfvB7AI1PkWN2clXXwiM+eX+b6fslMAAhI8wXVzatX7kuIDdM+cK2gjxdW7T1xKC7qD6Dqrvyv2u3P81yv0Oqu9idxe7f87Y3QKqOzT0OFSHARtDdRhbrbMllnqLzvXTETuFipOA3Jtp354ozTA44QpwJRRormmjlT6JcFip4VFTj1JNDb/O4LmXK2r3Mnio4OlrxIdWtCQKYcY0jufmsFa7hxWDlXqo8rmspq+FKX2H77fUblsl+QePm9pYAxZBYo8p42chLJMq2TmS6Mo27xEDa3XSDJ0WrE/nDL5JPz17voBehFkye/j+rHMruoxvU0BP4d40qpIbrekIul1F4cNT+nxsfUsPS+QRPcrM901eMJ6BlCvqVeyJaiNg6emdPlgvPKt/ZBNWP8HVvr7Jj7lEgG4lXBuZFR18NLD+xsgHHNZkbwSP8GQ/nZZ5+e7T8BWbICyltJAYRMTCfdSDnYMbUdrrpydHcBJVokgnE/uyS79wNgfDjI1DMAr7VV0Kwa7TdxbPoB5cQAIns+MkQTkDZ928TFcvELcixFJZzayNzikDVQMr1nhh3isqi9Q/SGVfmIGr1V+V595moxPoOMapSO0gu56nevGcXs8V4m8pNc9S84iaebUihTXttW/PevsQ60iCh4as9Wzmlp6Xo4fNFlxBqqsyoCWcHMUTVX66as+Wo0DPQ3pFOX5Vn+j1qOI0ZlNc+orJgPlTrY34O2PoOhgq15MEIu3ZYtE7WR5FhNes50TyLEtPeoAgSb5TCAxlnYmPsIITgNF2L4XC9jdaWcgLv+HbEuy3gs50+RoKLY4MtG+eLTMy9JChZ/OEcfK7r8mAsBDbqAPlAesAR9n6UyZwgubyoqVVmvmJfI3mYPnwQVSiYuaH9o/DLAm6X4xu4OjlGEjTCMCXZ8zgb+ZoYTErGCvdOli14Lq8oYYaumI3K+/yASjW1T+avqhxP9th+aDCxY/O0o9kkj9O3v2dMt4u0/wVM42DxOhuxNb1Dnknt4hufb8PN6SnAv6FuxSphL2hs6FejTBMnsw85LF9vRNi2p9KQTsFc8FjRId76Fd6RnEIkBiDH/pBIjShV5EjEJhDbydDoFdln6AVUz6YGNswPKELVD9r149dgpXPcZHYcbpwAKBms0Th5xpAiGSGLxY/tbqBNH5ikxB0ZUqkmmmCcctZaUSi26ApqtSQRDPzYYxbytCt5hbxCV6whsbtJ4Mhs/cyK5kiF8J+kgfHFSH6U7TBc7ypCOfYCEIGBTAlchzeD4ZrFIGYcg8xdDSpuUmmhmPxWwCgvHWGVhXaP7yELRV0rTm6b3Ifulv5zt2qT91nG+k/90N5rnYg6K/NcVMLVUlso2K7w+tK1h3ChHx/CH8eSvro0xT7SRh6f49bINgtPeBlYIP99fVN1gxRUwLrgr+hEx1D1K9+XS9vjJcX7jt8r+ghTvkn6EqVSPfv1CJr3Svw84vAjh/EpjdC7ZYMCWVv2E2b3JS1xxrYPi0b6fMPl+AQD/8Hsd4llQ== +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

+ +A work items details object. + +
Schema
    remediationItems object[]nullable
    + +A list of remediation items + +
  • Array [
  • ]
    • approvalItems object[]nullable
    + +A list of items that need to be approved + +
  • Array [
  • ]
    • form object
    sections object[]
    + +Sections of the form + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/approve-non-employee-request.api.mdx b/docs/api/v3/approve-non-employee-request.api.mdx new file mode 100644 index 000000000..1d27ccc94 --- /dev/null +++ b/docs/api/v3/approve-non-employee-request.api.mdx @@ -0,0 +1,87 @@ +--- +id: approve-non-employee-request +sidebar_label: Approve a Non-Employee Request +hide_title: true +hide_table_of_contents: true +api: eJztW2tv2zgW/SuE9sO0ReRYfjtfFm7iFikySdZJJthNgxlaom3OyJRXj7bewP99zyUpWbKdx3SKecEYoKNQ5OV9nnsvTT040ULEPJWROg2cI4cvFnH0SZxHajhfhNFSiJH4byaS1DlwEuFnsUyXztHdg3OTiPg4Uqn4kg6ydIax+9X9gZPyaYJnBwTcnAI7kxPhL/1QsO+54lMxFyp1MDkQiR/LBW2OrQdm64RxprBa5KsNSzxkseGEcRVgRionEpPTmWAKTNhpIq6xawyB0xi7sAxssnmGVWOh51oiIlgvgGgLHvO5SEWcaOEk8bPgEOvAUXiBv2TgbDJckbHgUqZizmTAXt3cnJ68xiLaUcYC2k3jTECN/kzMuXP04KTLBZFO0liqqbM6cMQXDno0Jrxmp93pBqLXFa2g3uiLTn3c9Jt+ux2M253AIWVbWd5GwZLIbW7kk3mgabwCd6H0tZkPf06I+4dtPqLxz8InQ0MSOEUK9dJbP5rPLZkqw5v6ODYTWaS0pisaISXP+ZczoabkLK16vV4W19o+YOMlm2sfiZ0VFJLKVL8v+ePAkj0Rvkxo49WKZsYiWUQqMSw36nX634vNZSQnHl+sMx6GFxPtLE9rD36zQ3GTKJ5z7OKQk/w6x3LKemv4nmj2emPXE+222xrXucvHbd/t9bsTr1Fvee2+T46V+/q2VkZiIhApPqIjMmZLksiXnCLkNIAqKOAPnhHSvN0WU6hsTmjw/uKH4eh8cH48/PH96OLmEq9OT4bn16fX/yYcWMtTjG6qxLCiI15ONJ/SMsekQQwoNFwPRjEGpySy4iTcNI6yhbPToXIpT9LomviHunYbbRdHtH/VJG2v06t77aDZmPT6dZ977Z7X8Pter95rtoOGeMyvc3qFQW5lOgMmk/V8P8pUeq6R6Dm+RgXAFcqw65mGsjKvKSbW7Nu1m/DwKuVpljxl0cHl5QhGJd8dDT8Mj6/14+Xw/OT0/D2ezi+ufxwNBydkyWMy/NkZZmxh/hDkAMkLRC/xqqYGz8vwX6B+HgeJYa4CH2tucs0OqqKUhLuIAxMIVjawMMbA7nSE/SI9v7SdV4rfSRhxrboXo6Sfo+SkyEAVWU7zYaI6jwJy+qcxJECwuqnUtq3udTsTqpz12GeesJDjISdcq8JJ3eu79Z7baF57vaN246jdr3mdxn+0gLEgUPiWnFiST/HQqh8127Vul3h4Oh+cAh7f8oTU9hwmq+3q5tks+JtxPBdcbsjLfc9DNmy7Xa/dcT2vXXd7Xtdz2+NGvyGaol7vtZxVkewrrruH498djku0C5ZKaiJWHUu/0/E6nXF7XK97eOr6zYaYND3e6ayrylsZhpLP2dUc1J3VI7xYJz1DBUBz7p+NA1sTtXaVQcehJPgZxjGM4rKRSLNYUbaYVOJzjKKSbCkVaBqf/Ub1ZCBSLsPjKHhBMnsnlXCnMZfEodAs+1jISFQZUL6YR7FghiRBKomg51WDDJqoeewtD5jVJTu2wpDGY+7/AlqnL3CzGyWxnuVLqNAHBjy2regKPu7U+43WpNPivNFred32uD/hzWa93+73NcSLJEG9W862PI75cmvr90KJWPosjHxY5H9QCOATutcM6M3J/2D95HkbaBov0D+1UmZuIabll1Hnd4Cofnt8yVpdZBU1zfQ4n24oQbk3V+TyWRjyMQ1RewLJDeGLWE6legquTobvBjdn17rU+NfN8ApPRGu7gVTw1oDcEqzCF2bRZ82xFYAyTiJCqAMph72xVN9AIK6S8kRp/kqWCVXcgZjwLEyxwu6+Y0WZNJvE0bwSSr5pk9krWRO1AzSilH956s/YGPkqyPulNwPfF4vUPbOafMNmgqP0eF1jgyCQJCQgFdEIoli/pI6WBwGFriEwyRDKYAZQEmWpbpF9UbXFWpVVa6wR5axsFAoOcP68nwz8NANzWsxyFBbeYlm09gHPRnNV7q436oNkqVLuQwo0W0uoES29D2SCbDJNmIUjMlcC4FH5vAKxymiq4e57wwwyi37n8yx5QdxdhoAfV4tWvPgkbPAl1DYZNNLWyM1kEcn2VHqxnVWYKw98hjQaBvvY3cfuPnZfGLubL0f28Me+1aWPt1363CieQb+xTp5bpU+svUdFLJ+kyxtryAMqYW2J9OH2GoH9CxoazBdfFnTm9g3rI5PKt5gfFPYw4+O8W85T/9oWxKDWo5FgAiQSwZHme82xVpRRVXN7t3dRPJZwULWjRNRnqssoYxwqizOliBOeHLAgEon6LmUzDnzkiIgkMQhIu6rAXURS/bpTtn0lua8k99lon43+1NloX0nuY3cfu3/N2H2ykiy40tFi66Qkm895vDSeZt/rw3yGCSz/GZIVIadNtVmtEDFW1FhOtXJwxg1v7E26vmgFvBV0mv1Jw+80eLvrdb1xq9F1yrn+bh3HRZBVY6pkb2NHrWIUcZ9Qx2UKzpWkURRUj/+g3lhMCNYIeoq6GTqHSu+L2rHR364dr6OIfuhf5hVSUqkh1VpHhGmYO6e5cT4XEzibAhcVA1RJ8EWuJOcCVGI4DQvlXOrgJSlAN166g0kKUUyg5E5W7CKVH2bgUCNBGFHVHMGxJF0JmFDNBwq6gp0Cnb9hdWpN9JsqeTYiic9IYjb84gtBgV5U7u1d57unYD4mjLgyBn7koNd0O1zBAdAQGMwq6s59fb6vz/c5fp/j/x45fl+f72N3H7t/zdj9FfW5rYYer88x4cX1OebW6qyopd6Rc/3uZboOFcuBdm8W+fpia7CuwXVdAVcihhaRvqerL64eOYfla1RufvspOXyQweowv2NEt3qpTDQcZnGIhbM0XSRHh4cPMBwMtqrxhazlVzlU9LnmR/PDT80dMET3BUzIgXqQ+fr4eXB5apuNmlZ3LMmjDfzpDYzytYDkuzCCPih+kj7dnyCrLqMMgKfJHDB4v/UuPQw2F2gtvkv07Jr2pi0ZIdtNHK6ek+eH5lNyGCKPyLFLfU/uhfkMXG6IZ29+5Jewr6gGN7tvXcVe5xXq2xpbm13QtAZ7K3iMBsH8lPHqw+31azalylNHfpZQ0SsktQqInUu4iEa2QX6sT4t0somjbDrTjA8qP5xQJLFJCIHZR3UlBLvL79ScA/JHwGitUlokNCzQqvtXuWUC8UmElA1ra02S48lAwXvlIa+se60zn24RpDK3sjBa+6hcdiIJkCRlcJpjRdQdH7tb5HLxklxfy8Q/cmquoeZqasnrDS6Mau98cxHHRzgTCYSm1tZXb27ouSV61E9hhKhu8kCasHxUf+7yc6t9NR8Vei7Rq/LxUd3OJNJqdRkzKMYSZMUwYKfMn0VRIv7JGLkOhcHdNEMUfTVbn2lTV0eE26iXWHLNlq50USRq/s4QGMo4Ex9TktY1SoTyTQUmJH/SlkXM/6S/RvipIrMevkMupZlB5CdfzTNt6NKGrsGAxPJvUhU5Ft1BhAzmor52gOO1/TUSWEZLmGdo7UR1Tf5Qr6HU4INVTSVZHJk/jtYAZ5+YfkGzizmAYKqxix8A8TeztChfVZSVnw5sanCb3zBCmtzQm+G3OJ2i1Plnk5ckHqwPUS5UuPzWKP0Ikvx5cPcPQrw90vwdkcZWvXQYOVp/ADVc38otruLv/qwI7Tc8VXNsO4tyfJhCb/s0MNGfj+FfvNVBritz9D26k9PlT5nMIuQphYOGA38mhT5HWAieUtF4QC4ZzXUIg0PCDXSLmtBU34mPIStH5ydD0KuxWzRqyod1qEmjmxeg+nNku7UrGOiS7MtOcpsz+hQrU3QdGkxkc8bhWc84RiATPzP4hZ5NiVyySFeAxao8mMnjSBU13a7E8+RiQgfO6GVL9n9mL5g/safNUKS+mW+uRa8FGYlQOyjNq1buz9GG07kzES7I4ABf1GGitMP3p9dbFEFMJZAL7XgUTw/touSQ5oIIdUnGGZo1NIc0RA0X/KpE13ocSsvK5f/1R5QVt3pYn7T/oZ8/2kREHcThgg7BSLjMdDSmm7xzdneTWHykb9znDSValBm1oVjx8EAnJ9RdrWgYG1Nbfne/bp500wmD0TMa2AkIiidU9Gpkv3B8zV747eVOwfIzQLVct/8OHn8RdGog6dtKzDLHOppD88L+juDqrxLWC7d+IKEm06wwR0VPzr0vte+XF3Ro5ozt55xzcxIR888YpH+PnI/4D39ECxMSmKTHH5z8XA9zDN28ztpVZtgH+mJ3tfo/Leflhg== +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/auth-user.tag.mdx b/docs/api/v3/auth-user.tag.mdx new file mode 100644 index 000000000..d906a4500 --- /dev/null +++ b/docs/api/v3/auth-user.tag.mdx @@ -0,0 +1,20 @@ +--- +id: auth-user +title: "Auth User" +description: "Auth User" +custom_edit_url: null +--- + + + +Authentication service user retrieval and user capabilities update + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/docs/api/v3/branding.tag.mdx b/docs/api/v3/branding.tag.mdx new file mode 100644 index 000000000..b6ed71391 --- /dev/null +++ b/docs/api/v3/branding.tag.mdx @@ -0,0 +1,23 @@ +--- +id: branding +title: "Branding" +description: "Branding" +custom_edit_url: null +--- + + + +Use this API to implement and customize branding functionality. +With this functionality in place, administrators can get list of existing branding items, create new branding and configure them for use throughout IdentityNow. +It allows to customise color of navigation bar, action buttons, logo and emailFromAddress. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/docs/api/v3/cancel-access-request.api.mdx b/docs/api/v3/cancel-access-request.api.mdx new file mode 100644 index 000000000..949f66a05 --- /dev/null +++ b/docs/api/v3/cancel-access-request.api.mdx @@ -0,0 +1,100 @@ +--- +id: cancel-access-request +sidebar_label: Cancel Access Request +hide_title: true +hide_table_of_contents: true +api: eJztW1tz00oS/itT2ocDVOzEzj0vWyHAqZwKkM1leQipZSyN7QFpRquREkwq/32/7hnZlp2QwKH2HCgVVcGWenr63l+PpZvI5qqQpbbmMIn2oliaWKX7caycO1H/rZQro5XIqbgqdDmJ9i5uonOnigNrSvW53K/KMa5FOjF7ktd0Cr9ozzOKLm8vV6JSjhyRebYi8HURbiXKxYXOaX/sfjbWTuwfHwplktxqUwrPxgkpclzTZiT8PiLs0xX7ZuESrREDFZamKhHWpBOhh0KXYiydMLYUuXQOd8qxEjLPC3slU+FKlXffm30zEaX9pIy41uVYvD35/T/7L14fvhES2loyg7BFoLBDZlHBJOJ6bHFDj7SRKfYL0tSbNEXU/qMu6LYNokK+LowdaJ7bBPa+iWq6aK8sKrUSxWR6U9ItSJ7qmJ23+tGRBW8iF49VJulTOckVbGoHH1VMTmyaOjhBDLANrDFJrUzEEIoFWRYErh1SC+gluohAZitT7selvoJlEEMkYZaRhHAvLIvwKrVyLO8S8UxMVxbw7pKYHBGFGqrCkaHIlDoBcywPGhwmXXFmhatY4GFFtq91WAyNFTGxlcgqKEQ+B6d7OEIO9VlmeUqi9ePd3s7azvpm0lebva2dtd5mst4f7uyuxbK3udOLbmc6P6jQiZLw1JylUwpqkuKeAG+IctgIKzKNTZUYTESmXSk/qW50C2GgC1Mf3JHMt3Ps7vRIre7m1k682d+Nt9agchzLrSH07a331uc8/DiBSKRCudwa5+Ogv9an/5qGITFzYtNBgSirwuCj9ulVB+E1krfhZ1mvQWT64HATiJJ1o+/OEy/uxtrasoQHqQZD8bIo4Lz7peSMgiW0QVHRyZ+QZTF/ElVKnR7YRD0cZ6+0UZ1RITVJqFjkGAtD3FOcZbZQwrOs6xjTNSMOluj2xHMUh7piHARlKNAKGX8Cr8dk8rnRWC/qJUg6ToJ7tlXbSg621nb7G8OtDSn7Oxu97c3B7lCur6/tbu7u0u4Z4kCOvGnC3rIo5GRp69+VUYWORWpjeOQLDFLMspA3xxKNuHEP+4B5PML+Z9DL007VDPIK6pwr6GjPD47FxrZIpRlVfF2OFoxgOuenuGIQ7HJAl6gFQHPP+C03m7tEUabKqDq/ePlq//zoDFdOXv7r/OUpPhGvpb6LHqpRfBCWEBWxMLbXLHFQgPNOpTCHQrF9Frg+g0LSuHlC7eaSELE1lFWKFv0s7H7HinnWYljYrJFKsYcZ4onuqu4KmjquZbKMx2IgHTd2Jn/ma0fnKFjymRgrmajiKdBBkmhSEu0d2QimWD8hdCCThOsGMxhWSGXF/d5WJQEEHaumL2ambHpjVm2P5p1CyQHJH44TlN4KwrGa81k4jZYgYvAPZPaWa0p3tlglJ6aUKOoxQ5HYFgUsLAbQTZdOhHJE7nIoPKamm1as+SbC5e61F+ZFafleLCv3iLw7TlF+Oqza9MaVCsnH/bzuwnLmplCRQj3nxYFq6q468cVQqzRpc7fN3TZ3H5m7izdPAi4Ldxn69Jahz7kJw8+XuwBawdFjbD0hfWF4Exy5QtNSgEh/vDsLgxPo1eecpogfiI98K19GllN/+OuDGnHXrX/mCxKQ7eg1GKISqWSP5Z5JzIbyplpf3u2VLQYaAWrugIg8J9IIImGyojKG8b5bEYlVzvxG4+nVdFbkCki7mqQznb1aJNkiybYbtd3o1+hGLZJsc7fN3Z8zd7+KJKdScbYEnOSqLJPFxEdauE/aSgECUZ8QimnKsasW0QoxE1OMFTWRQzTo9wa94XasNhK5kWyt7w778VZfbm73tnuDjf52NN/rL2Z5PE2yZk7N+dv7kU0MEHcFHFcZBJcrrU2ax38wb6GGVNao9ExxM5/u317OsOPGMnZ8Y0voBsbAjsU9x4vnJ0dzB+KS7GarIlYEs73pQC5LhpT8U4f6rPlHnBY6ttCxbT9t+/k12k8LHdvcbXP358zdb4KOGw9Bx41vgI4bgiDWkCDWXwkdE+AOgmZDOAU6xBXMawg25lAFn8LpY0j7UhYjVU6BXgNF9neXUeSZteK1NJPpgzaNk0gzMxeVN9BmRFvUtCCQYoQSaQSqlga6pajSmSJMivgRqc405zEpBL7FpLM/LKGVz5k63qa7aBOnFSTkopBaOnu1iDGNcFJDgn/gwOegIxTqH3jGGbz1p86DxQlpfEQai5efY6Uo56fnv5t3PSVwCOELKhen3tf3PC7gz8ylwRihPue+fE0haAvVW6jetvu23f8a7b6F6m3utrn7c+buN0D1gIbuh+ogeDRUB213TUyx1CsKrv87YudUCRJweAsbM1ZPZhiccQVCiQTKLR+05pKeio9Wm0/Eu9XwSDw9Tk/I0AtVFSlox2WZu73V1Rv4Cj667cpcd+vHko297sY2W71av6Py0IOmPstQu5Iq5smBHqH3m3TZwoWmIPYVjzfw9madKFxhd37C4Kv8jczYkRNMIcKzWREI+BBQfBli5pgmfnNMzQ//rizpCN3Oi/T2IX3+vf41PTyTe/S4y3xf3Qv0AlIuqEfiX87efjgl2O13X3oHYtZK6MC/v7TZWyLri+dKFqp+eeDJH+/OnooRgU1O9soRzlWapgOkyzFChIvZfv08CL9xQP2lsNVozILvN564oeQRwxQKi/fmVClxcRiM8AZV/gRlmU1KixRXAlp1+aT2TKKuVEoNsDuzJAWeTswqLLQqG+uecrPjqUAbfMz4ave96YgXmmqQpqZNNEFFHvLERV7rJef0+l4h/lFz64RsY27u6YIU3rQXsX+CO0YGEwuZOrbWd2/u+XXm+NEIhSvEdVEGskSQo/mcVFx77bvlaPDrEL+mHO/Nu7FGJ20uE75wCYdGmCbiUMRja536pxAUOpQGF6MKWfTdYl3Tph3OiE5/bU6kjt+yozvAhSzfERLD+GCSA+rLDEusPyHhlPzAnkXOf8DUnIgPDZ358gXaJ1EmNnbfLTNt2KENO74GuCC/704UWMht0oHrgA+Ag5n/uRIEQedqnud1Z1Vn9qu8hlpDDFGZi8v3/Je9WYELnwTfIOopDUowwerpk2P4LgIvalENY9UHAosWXJY3teiMC3bz8k5/1qRu+XfTlzTen52bvDXp5EdX6Xsqyd+n7v5FFa+tNL9ipQlAl84fT2ZvJ7581Htk9782943vkWFsR7iz2mEimU8yjxaXTxEdv+KHv7jLlYIRPeYl/3YnYah5NnkqS8oprinxWCs+f8iVLAl5rlBc24zrAOA2FR9MmcxoVIAGRcMBDcuBTsGvK95hwDOwTEHDHT33C64fbZjyTuHlY37J9UUdOABwWVYZesUUQlSZkAjPB6Ir0S6ufBHErGdUrZllGDldVVcEClsyRZfHnCJzb4d0UI0ZeC6IHtgLMeTCKTUMSR4htE8T1FSRE5VylBNdE/4/xBuR2xmrNCeHo4IDzKm5HV4fni1xBDMTfhqxxWg1LHKrRAsmNGr5YFjvYqikSzSoYRae4+tflayh9uzN50Y03cwO5ttXlTmAfDelMWg1p8M7Mm7lxzI/BV9EC1MwxU14NXwlGtPADJqbGzrjoaHwli6Dkg4QLi5nMx99A29/1sOD8ydFZwzhx4XO2YQBQjhMWP7VhMZQv8KfH32V9nJupj9+Sydp0SC8jZ3544lCXuMi/d2L3uMfvtjcxzuI+PpNVB/2gcbzrZHYXUAkfCA1b2//BxrUP2w= +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/cancel-report.api.mdx b/docs/api/v3/cancel-report.api.mdx new file mode 100644 index 000000000..ae8955cae --- /dev/null +++ b/docs/api/v3/cancel-report.api.mdx @@ -0,0 +1,83 @@ +--- +id: cancel-report +sidebar_label: Cancel Report +hide_title: true +hide_table_of_contents: true +api: eJztWl1z27oR/SsY9uEmGUuyZcWu9dJRbKfjO86N64/mwfFMIBKSkJAAL0A6UT3+7z27IClRsuM0zbT3ZvRiS+RicXaxuzgL4S4q5NRHw+voXOXWFV4cyUKK4y+Fk3GhrYlutqJE+djpnL8Oo0NpYpV6IYUrjdFmKhwP7UZbkc2VkyR3kkAyZsmgGC+9ikunizlmu4uuvHKH1hTqSzEqixkh8PkwaBomKlWFim7uMXkunczwzXkeZ/AFqnUChZrg5BKjVzGeHAk7EcVMNRgDClFYEVBhiFO/l9opIC1cqYCvmKek2+ssx4etSH3JU5vg0USmngTimcpkNLyLinnOkoWDbpaUPGYYyR2V9Pu7/cH+zmAQx/2DpL8b7+329/qD8WB/bz+6J6Oc8rk1XnlS1t8e0L+2Bb8BKLnHFKIjtEl0LAvlg0nArXwhPksvfBnHyvtJmYpxWdBrp4T2wiyGw+QxDSpKZ1QCXZWSgKAb3W9Fg+3tdQSHqabhx85ZBwznjYJJC8XYJnOaUZtbmeqEoqCamVTKPE8JOlT2PnrSe7fuRjv+qGKKkNxRABU6+CVRhdTpIa/AusvbYF9rozpTJzUhVAw5xkABjbc6oQDILDwTVNaxwXLd1vLBE90d8UomsDfYd1gZAzdRTnyCLgrupwBdGY3xoh4idCImAPXItGpfyfHe9kF/MNkbSNn/62Bn/+X4YCJ3d7cPXh4c0OwZ1llOg2uquaVzcr429d+VUU7HIrUxVuRfcIhTEr5nADw55U6hMv/0GrCOb/D/JewKso2ZFV5BKb6FavHq8EwM9kUqzbTk53K64gTTubrAE1OmqRzTI8pLWB4Uv3V6qs2D2WfKjArI0fHr0dXpJZ6cH//j6vgCn0jXWgUbmTqjABWxMLOfGXFlAOcVKlBcqKQrXlRaX8AgafyyoA7f/NzDmYitiSzTAiOq2R8YsaxaTJzNWqkUh3oonumu6m4ha/Esk0U8E2PpMcCG1H0xQs7nRee08uQLMVMyUe55V4ySRJORMhXIRijF+Dmlv0ySRe5PSqQywOhiZlE0jC10rNprsXBlezWQBLpgidPlRaHkAPKn42QUFyXAsZnLWdhESwWxrnhJ5bk2usvVKjg3BW1XkEzncKNz8DAXRI0drS6EmnyfSVPLNRXr/n5hFpe7NwHMUWH5XSxL/w15d5ai/HTYtObFraqSz1MdDtWIV6Nepqoi4SWZzYMrqWa56sQXE63SZJO7m9zd5O435u7qy/OK9VRvmfrsrFOfKyPBSa3jzXON+jQMqxZielMt5JaAQyqK9Ou7SyT2J2VIHmSSyOYP5EdhK18DP2rWIzwfE/1oFqu1FgSQ/RgsmKASqWTIuBeI2VHBVbvrs722bqwRoOYBioiq6cTclkK6BRGXfkskVnnzSyFmEvVRMoMNFZBmNUknt9oUGya5YZKb3WizG/08u9GGSW5yd5O7f87c/SqTbFBxtlQ8yZdZJt08RFr1nqyVAgLN+ZtoUo6XapWtkDLRcKyozRyicX9nvDPZj9UgkYNkb/dg0o/3+vLl/s7+znjQ34+W9/rrRR43SdbOqaX1DuvILgaJuwWPKw2CyxfWJu3jP7jXqQmVNSo9DW+Gz+HSm4Y79g/WueOlteKNNPOaIfkWhzQLH1FNg2xGsq6WhYAUU9RFI1CqNHBRKOlMQYtD0IhUZ5qTl6yAXjfvjCYFTAmJsnoSiu9xWgIhV4LUEmu2CCwNI9WEOB80MIOdojr/QHZaLdF/xeTFOVl8ShaL4y+xUpToDXN/+dD57gnAO6oRF2GBHznoDd2ONAgANAShZjW8c8PPN/x8s8dv9vifY4/f8PNN7m5y98+Zu/8BP6/Y0OP8HALfzM8h290WDZd6TcH1P6fpnCoVAg5vYeO4dHzcXHNw5hUIJQKUW89FhK5ODKNeuHXhe3c6ue811yMC7w+ISpdCcFYUuR/2endYKCzQfVfmuov6hbUq5sZ+7sY2693uPlB26H5ASDEUrqTkmyVidHZSNRdddq/TFMGh3PEEwdlsEMUqnM4Hw1/VT/dDaBXntkSBYzVbAtFeRRM/BswcrcQvnqW7HD1rNsK2K5feP2XPP3e/ZkdQ8ogdD7nvq3NBXgDlinkE/2Zxu+aCOHeYfe2OzWIfoT6tvzbZWxLri1dKOjQE4aeLZ7++u3wupsQ0OdNLTyRXaWoNkCtnCBGuZKP6GJ8G8ebibDmdMfBR64cSyhwxSWGweG8ulBLXJ5UTfkOJP0dNZpfSIMVlgEbdPKtXJlG3KqXdr7vwJAWeTkwPHurJ1rjnvNNxS6ANPmb8tPvedMSRpgKkaccmmcpE7vDEdV7bJZfs+l4Qf6m1dYK2Dmvzz1dQBNdex+HiTYz0JRUy9eyt75486Oss6aP+CU9I6yoG8kSFo/3zVlyv2nfjaOnrkL42jvfm3UxjG20PE6FqCY9dME3EiYhn1nr1NyEodCgNrqclsui7YX2mSTucEZ3+9hKkTpiyozsghYzvFIlhQjDJMW3KzEks6JpJQkp+4JVFzn9Ay5yIDy2b+fE19k6STGzsvxszTdihCTuhBvgKf9iaKLCQ22QD14EQAIeL9edKUAFdqnlB14NVndX3eAxtDTGgshafD8OX4aLAVZ8EvyDpRgYlmDh184MfvotKF+1PLWfVpwGrHlzHm1psiyt+C3ib0yjaKv9o9pLFo8WhyVuTzn90lX6kkvxx6u7/qeJtKs3PWGkqlkvhxtNW7cBykAe2tn6ER2fMM4W/eMuZynQazQq3X8xhltXkqSwopjmn45lW3PznShbE/LYormzGeQi6S8mPFo8VTR1kkLQebFSOdQp9XfEO3ZWJ4WLqrOi6BLR+tFWLdQEvn9EiiaN64UCgsqw0GEs5VmZCIjyeWN1E+7gMRQiNllG1ZZZpXDOqzkgKG3JFl3sMl/m3EzolRgO6tIhPzIU19NURMRxJK1Ld3V4Ycq5SjjKSa9Pvp3QjcjozlebU26GCgkyppRnenFyuaYQy42EXemjrpr1qkO+RLJRQqxOCYbeLjo4eUZeERnRJb7j6Lpob7a0ouluchn/1jnxV3ImV93I6SKK5ytAlhI7sOqo6MkgP+aZ71ZSB5s+odYPE3R2dNlCHck+P0WVTK3t9s2hAuHGDv+hz0txhfxTys/PqOvxz8U235x80oz41M/NFwxzh4ydFfTZMQTcKG/gghPGFF+GoZGnI2o8J1OE07evZWzo0Ymbw0G5ZfYAzUA/+DToYH5g= +sidebar_class_name: "post api-method" +info_path: docs/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 Report' (cancel-report)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Cancel Report

+ + + + + +Cancels a running report. + +## 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/certification-campaign-filters.tag.mdx b/docs/api/v3/certification-campaign-filters.tag.mdx new file mode 100644 index 000000000..30f6ca525 --- /dev/null +++ b/docs/api/v3/certification-campaign-filters.tag.mdx @@ -0,0 +1,47 @@ +--- +id: certification-campaign-filters +title: "Certification Campaign Filters" +description: "Certification Campaign Filters" +custom_edit_url: null +--- + + + +Use this API to implement the certification campaign filter functionality. These filters can be used to create a certification campaign that includes a subset of your entitlements or users to certify. + +For example, if for a certification campaign an organization wants to certify only specific users or entitlements, then those can be included/excluded on the basis of campaign filters. + +For more information about creating a campaign filter, refer to [Creating a Campaign Filter](https://documentation.sailpoint.com/saas/help/certs/campaign_filters.html#creating-a-campaign-filter) + +You can create campaign filters using any of the following criteria types: + +- Access Profile : This criteria type includes or excludes access profiles from a campaign. + +- Account Attribute : This criteria type includes or excludes certification items that match a specified value in an account attribute. + +- Entitlement : This criteria type includes or excludes entitlements from a campaign. + +- Identity : This criteria type includes or excludes specific identities from your campaign. + +- Identity Attribute : This criteria type includes or excludes identities based on whether they have an identity attribute that matches criteria you've chosen. + +- Role : This criteria type includes or excludes roles, as opposed to identities. + +- Source : This criteria type includes or excludes entitlements from a source you select. + +For more information about these criteria types, refer to [Types of Campaign Filters](https://documentation.sailpoint.com/saas/help/certs/campaign_filters.html#types-of-campaign-filters) + +Once the campaign filter is created, it can be linked while creating the campaign. The generated campaign will have the items to review as per the campaign filter. + +For example, An inclusion campaign filter is created with a source of Source 1, an operation of Equals, and an entitlement of Entitlement 1. When this filter is selected, only users who have Entitlement 1 are included in the campaign, and only Entitlement 1 is shown in the certification. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/docs/api/v3/certification-campaigns.tag.mdx b/docs/api/v3/certification-campaigns.tag.mdx new file mode 100644 index 000000000..a2e74d454 --- /dev/null +++ b/docs/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 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 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 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, IdentityNow would provision all the access the user needs, nothing more. + +IdentityNow 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 IdentityNow: + +- ManagerCampaign: IdentityNow 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: IdentityNow 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 IdentityNow 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 IdentityNow 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 IdentityNow. +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 IdentityNow 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/docs/api/v3/certification-summaries.tag.mdx b/docs/api/v3/certification-summaries.tag.mdx new file mode 100644 index 000000000..5a7eb138c --- /dev/null +++ b/docs/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/docs/api/v3/certifications.tag.mdx b/docs/api/v3/certifications.tag.mdx new file mode 100644 index 000000000..95a5a85f2 --- /dev/null +++ b/docs/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/docs/api/v3/complete-campaign.api.mdx b/docs/api/v3/complete-campaign.api.mdx new file mode 100644 index 000000000..550acacf9 --- /dev/null +++ b/docs/api/v3/complete-campaign.api.mdx @@ -0,0 +1,115 @@ +--- +id: complete-campaign +sidebar_label: Complete a Campaign +hide_title: true +hide_table_of_contents: true +api: eJztW/9T2zgW/1c0vh+2MCSBEErJzM1NCnSHvXbhUtj+AMytYiuJWsf2STY0x/C/3+c9yU6cQGm7ndttx9MdNrGlp/f9fZ4i3QVppozMdZqcREE/CNNZFqtcHcpZJvUkCbaCXE5s0L8MDpXJ9ViHPFiUA2xwvRVEyoZGZ/QCNPr9figL+nKFf+dTbYVKoizVSS5udRwLUyTCFmGorB0XcTwX49QImcxFWBIV+VTmQholNjczaXMRFWpzs/0YPZUXJhFShGmSKzxVxoCiHoOMqogKzNvcTNJcrFAEv/S/Qy+6JUI1WUsKbcGL47/MpDc6UpHIUyGjmQbHNnVMY8n5VRJKTPME1+ipG5UQdxK861zNrJjKGyWItZFSi4kRszdU/ym0AVsmjfE3HYvD4+H5vwdHb05+hdYicTr82X27InNZFRZG53OY7C64sMocklI+5oMin5IZdZT0S4H6RRbJXAXX9zCiwTrK5i/TCHPvVmx6yh9k3BZHaiyLmDgF05rUbNl+NVWTWoo8bcmMNKVEkaWVWKCzJYoEslgeVOp9ENKrvw+Pfzv953Hg+IHc8MqxjK3aCrx1iTnQjb02O+8tcXgX2HCqZpI+5fNMged09F6FOSiBh4wMoCzPXVtzXdwjvDMwK/R9O1UQzayK9GxwdjY8/e14Q5Dv0gujbtIP6pnjf8OLXCpkIXubQsoxaHOjkwm+q6SYkW08TTzxWuDYYn1j+OKt+iiJHJ75cff3IKpzflRGZimjM53FGBqVSSNnJJ1lB9EkbSbhGltBghf4piPyolVlel7vl+2Sm0KtBv95LeKiGrNqvPtifNDb7e2rg97e8+5obzR60ev25N7z3YP96EXg3NBCc9bZqrvdXTfOAJkjQ3SIlhhy5OOjj3Xvw+JW2nqGkeUcJI2Uh9q5ReiRNb7Sr5w+e9vb6xwexprS0DGnoce5HCHUKHx0ciNjHf0BXlZ9PFK51PFhGql1E65a7BXcvDUxUhOHLnOGmOhzHGaIWYpE7EhS+iEReFy7Zl1oor0jXspIDL18h14Yck4jww+gRUXmKYYuEo35opwCL6oSzAPLqn0lR8+3D7q98fOelN0XvZ39vdHBWO7ubh/sHRzQ6jP4gZw41fi1pTFyvrb0zypRRociTkNY5L9QiFESumcGeHFM4ZT9tA2YxmfonyLGja3E9PwKyttbKB8vD89Eb1/EMpkU/FxOVpSQtC7eUgjD2eWIHlFsQnJH+NToiU4eYqXMPEfHrwYXr8858/zr4vgtPhGttdo+QFAnEbklWIUvTNNb5tgLwHGnYqgDxUtseqqbEEhyUa8GarsUhMLnOMzwqz8wY5m0GJt0Vgul0BU58Uy3VXsLxQnPZjIPp2IkLSbAhDR80+WO1muvyU0xVTJSZqMtBlGkXY0TiEYQxfw5CKG+R5w3mMC4QCiDGZ1P0yKnkq1DVbfFQpV1aywy9Otlo1BwgPOn/QS1qgBzLOZyFFbe4ln09gHPTnN17s5Xs+Q8ySWqIEYiTYapMdCwGEE2ndsKUGnS/Uwm5bgqYy0XHk53bxwzR3nK7wAE7WfE3VmM9NNi0aoXN8oHn6Xa6xEXWaM0k89IPp/z5AqXeV2UgS/GWsVRE7tN7Dax+5mxu/py6HGZf8vQZ2cd+lwkAMPT1HDxXIM+hr0nYSjNg1xD5Ay5JRZN2y/vzhHYHxR3bepjRoDzG+IjV8rXkWVlD/d8RPCjMlbNFsQg69FJMEYmUlGf+V5wzIpyqtpdX+1VakYaDpo8ABGRNY2YpwX3wOiXE+JE2i0RpcomP+WuY5SMcF0GdF1xi9viBkk2SLKpRk01+nGqUYMkm9htYvf7jN1PIsmKK44Wj5NsMZtJM3ee5t+TtFJggCh3CEUVcmyqVbRCxESFsYI6cghG3Z3Rzng/VL1I9qLnuwfjbvi8K/f2d/Z3Rr3ufrBc6y8XcVwFWT2mluzt7MgqBoi7AY4rEjiXzdM0qm//Qb1GjSmt+d1lh5uhc6j0eoEde+vY8dc0h2wgDOxoHtlevBi+JvpYmsmT3tLChIpgtlOd+8WCICX/+KA+aps30LGBjk35acrPD1N+GujYxG4Tu99n7H4RdOw9BR17XwAde4Ig1pgg1p8JHSPgDoJmYxiFzpEUUG9CsDGDKPjkdx992OfSTFReAb0aiuwerKPI8zQVb+jgjQdLtrYTmSzURekNY2c01pRjNR25mWg6zIKspYFuyav0TBEmhf+IWM80xzEJBLpm3hqMc0jlYqb0t2oVnYRxAQ45KcQp7b2m8DFNh03GBP9AgfdBJ0jU33CP01vrD+0HiyFJ/JokFscfQ6Uo5qv9372HTgmcgHlD6eKts/UjxwXcnrlM0Eaoj5lLXxUEbaB6A9Wbct+U+x+j3DdQvYndJna/z9j9Aqju0dDjUB0DPhuqY2x7W1RY6hUflv1/I3YOFc+BOx6dhozVowUGZ1wBVyKGspQ3WvngbT/oVOfeO3c6uu+U578DOs1N0NBxVZgYg6d5ntl+p3MHY8FI922Z6TZyGOyVz5P0to3ZnZvdB1KPO7pOboPkFRV89FkMzk58r9FmFRtNXuxSHi/gFF6eQbZQPB8x+CR9OklMlpyjDRGOzJaAx3uP4sckJNqJnyyPbrMHrckI2S5MfP+UPL/tfkoOR+QROR5S3yfXwngBLlfEI/avF4fv3xLudquvHcFf1BLa8e+uLXZKw7ripZKGj53TIZhnv7w73xATQpsc7YUloKs0tQeIlzO4CGezQXkghCZxgTFpMZky44PakRuKHjGOIbC4St4qJS5PvBJ+RZofIi+zSmmS4lRAs66flZaJ1I2KqQK2F5okx9NR0oGGOrI2b4OrHbcFOsHHGT9tXyUtcaQpCdEBdR7jReQuT1xmpVxySa6vZeJvJbWWo9ZianZjhQun2svQHeEOEcJEQsaWtfXVizt6rSV61EPhCVFd5YE04fmoH5QKS6t9NR81ei2iV+fjKnk31Sil9WnCZS5hUQnjSJyIcJqmVv1DCHIdCoPLSYEo+mq2bmnRFkdEq7u9xFLLLdnSLQBD5u81AiNxziRHVJgZl6Rui4RD8ne2LGL+d74f83tNZn58ifpJI6M0tF/NMy3YogVbLgdYz78rT+RYiG2SgfOAc4DDhf05E3hGl3Keo/VgVmfyHZ5DpSEEq0zFZn33pb9IcP6T4Bc0uhqDFEy4ujo6RreQPC2qUTVllTsCqxpc5zdOURpX9Ob4rX7XpHL5V5OXJB4sNk5Ok3j+rbP0I5nkr5N3/6SM12SaHzHTeKRLG5DDxYXC47Inefj6XXWNDQ03/JT59b3EcnQ4mLe+/0cb1FOFv3jLIc5YHJ0O924MfpbJZLHMKRg4GYRTrXjnIFMyJ8i4xbf5ZhzAwMmUNegWIBGaGIxBtFvAWDnSMei1xTu0ZkkI21BbRid2QfV96vuztzDPGV9UPSotDuQ1mxUJ5lJwFjMh4VdPuEWkbVi47IUuLVGlZCnjv2pWGcrkb6QKvmqozMyejmmLGd3rkvWfWAvGt35/GYoki/jrgQtBhiqW7mrh1gpuf4o2XK41VXFGBkfqBQpTSyu8OTlfowhiif9RIzWTjp9kOzQWRKhHcs6w20Y7SI+oxUIXu0T3cHEfd+l6c82X7hYb6s015j/1GrOvvtQ2dTLa7SObFq6Nc23zZVDpGeP7fNe06pzRi02px8aouzvaFqI28p4eIyfRnsPl9aJL5O4avkmfF9eNH3WMZ16UaIN/2Krfdn2Q73IvM5kvtjECfPygaPcD8+6vMcptTzEz7oX/PaR1PmdIU05c+6GHGmc3w215fXLs9dI2xNkpbf4FI3/le+Z2VIy8xUP62w+u8A9fUn+HGIP4+V1Q7k9ijKNbYseHoJP/AKVj2P8A3qGLIw== +sidebar_class_name: "post api-method" +info_path: docs/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 Campaign' (complete-campaign)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + + +## Request + +

Path Parameters

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/complete-work-item.api.mdx b/docs/api/v3/complete-work-item.api.mdx new file mode 100644 index 000000000..2dc602a2b --- /dev/null +++ b/docs/api/v3/complete-work-item.api.mdx @@ -0,0 +1,107 @@ +--- +id: complete-work-item +sidebar_label: Complete a Work Item +hide_title: true +hide_table_of_contents: true +api: eJztXFtT4zgW/iuq7ENfioRcgfCymwF6Jl00zUKY3lqGqlFsJVG3I3ktG8hS/Pc950i+JaZJ6N65VV66jS2dm87lO7Kch5oORcRjqdXQrx3WPD0PAxGLTzr6MozFvLZTi/nU1A6va3iL4T1Tu9mp+cJ4kQxxIkwbzaRhg/MhS+cbxtkdTpAwocFOZDwTEeOKcX8u1Q7TEYM7TN8pqaa7XhJFQsUsMTBonpiYzfkXASOAaiT+kwgTN0CSkEd8DsQjlOehJpFzyOMZPFLwAP6SPlwbbybmvHb4UIsXId41cQRcao87NSQmIwGaxlEiVrUQbHjM9IRky8QHkuKeo14wRkw6B5N+t9PdF/1ub6897o3HB912l/f2Ov19/6D2eINsTKiVEQaFaDeb+F+Z1YClFjZMjz8LLwYunlYxmAFH8zAMpEfrsvvZ4JSHVb2yiWGEqxhLyxCMsKL7sqrPqdn2+q2D5kGn57dFr7V30Gz1/E57ctBverzVO2ilxoSVEdFwI4bZtM0YwhonQcDHOBoXryjAsTRhwBdn5ATPSYKr7NsJ6DVfF+u9nil2OZfWyZYFAPddT/uyZ9G0b9aeqKyvclHXVQHec3AypyjQ9iLBY1Gp2ERHcw4+WvNhRD2WwL+kSbO1X2/u11utUevgsNs77Ow3mv2Df6/KBDPZ3UyosheyO25Yyh4kmWtfTuRLRTmoN/fq7d6o3Txstw/bB41Ws7uZKAGHbJSEPslTsQolSmu5Xn7n6yF4REZg3PN0ArkRhhudRJ5grwbHr9A0JobnVUyFSuaYsd9JJc2M5L4QmCrcZZxEii5P7kPKhju1c6F8O/mIK08EcPOmKEyB1KpKJAgqw0uqxDKmuWmmu8RhH7hKeJAlP9TDiv+0Gj8K8FbpoWyY5CYuL5Iqc+HL9K9jEHua/jEIISne8gAuf5Y6oNsX4laKO7jzDhwHldaQYxf4WKfTjmY8CISaoicN5yH34oHiwcJIAzcu5VTpyQQNd4t5eqdmtRl4bvYIEkjZbrnsq2ZDfatcYNluIxhXYbYoV97ey03Io4gvVrx1pyaXxn1DASlnNG9pYTYrJDGPpiLePI+WuDJL5YXMX5ZHnxXgM5SPhkmzqh3w0mK1GWdACjIY+D5AEfKWAqB4ma5FRGITUYkfxsCtYMeQT7xYRwviGQPpcRKLF3JMp7OxgPGpzpSEcsbhTCtxlszHUNGKPD+muHY9xhkMrrawVmWRSiLY8lDi/jMPkjVVvsWhm+nca7XrvV6v3mq32shWcTT+0IekJOPFupamBZNuUipAlRMjNrBeDNwe8wR1Uc5AxyIGnyNvWwa7gYQqChwKOYvJNJFxl6p/pyyWsieBXhnILxvnEFej1+TnCnokJgK6Hk/4bLxIQyyX5Kk8UoFBCqH5m8S1WjucM3cGu9KsJ1NUFcDdLIKLvPKp1XF6u354FsnaaUWS/B/jBvS8VeJn8AwQxccJdaxPArXh2fDypxN0vIuT9ydHI3c5uro4o8uTf50PL+jq/OTseHj2I0KVwdnRySneRNZltJbT+za0BrZ6WNbsppgCBoXYXSP+KXTB7XjMlADHjzXkOef3Fu+v71s5Tl/xrIELMQuhqxYn3ad4cV/RatZb/VGrc9jtY4vTOehV9BWYT7G3AHXvZtKbLfUXuRAVEoJrLCdEqWIxpcYtkxBuddrVMU4lMTe6VE/3Gq1+hQDIo9J9v8u2w8RC8G9rgddzlrNCtlth61zlEnoHQvHM9QYrvJzHr+OZyITZ8VVemfOCgQx3GBrHmtKSScabskmnNEqszgPBDYQ6cWKTSM+d9kGg79xemK30VwYcauOiQRt1FMZmppPAxyiGqztl9+xWrPyeK5EpaZWvqvRPVvZ1fXBzh8DlHi6X23dSBH6rhHXScXmSe04WcB8RPC/MKQ5LpXG2KQlz6ZyFkMbEibGB9VbS8alLxqlKppFfMo8rXEzH1GnLuPJ3wVfJLqkFCjJeQ03Afc/UWOXZqxK456YUlcvWLlp6pQQB8yjS0TpmyHd/c3mXCgikJXJm3PAxofAIcdNfSkP4QNT6jdVN74FixBO1sNJYKpq2s33mJ8h4KesWtSy08494v1u1U3wUSNwaP0EGrM7S3RsmS9uWbKz9BZOY5qEaS7/x/baTfVqHI+2vEVnvpBL1acQlSkg2gSLnC4b1XeIGE5vrCPfAkGS6+jSunL/AEo0W+4H7oK/V78gpg+aLuPcFaK2zYXClJMxn6RRodyjpPsFW7As+3mv2293JXpfz9kG3td8b9ye802n2e/0+bUgCWuVTUeV5ZdZu64cF2oMV+S8YBNCIcVmfmH8t4y3lEqSxZlmwYzM1nbwsFvfxDmC+H47OWXefBVxNE7rPp0tGUPWry6oKaAl/jORUVkLyFM0en7wbXJ2OCMH+8+rkcpQh1JX4kcpHt9SEU6B+kMROAQpGKmDCb7C3jupbUIgrUxwo7V9mYTCWfTHhSRDDDMe9YkaRdF4d01CiuLmP2WvZEI0dyIb0PioG+DaGouqnewFvoZ6LMK6fOku+ZTPBfRG9aTBoaiQqCa0ctQwG5i8I6fo+hq4lMEkglEEY6Op0EmOqkd5SHc9NudwEpznktLgoGBwg+fN+Al1dAsKRmsUozLzFiejWB2S2litLNyoYjUy6UDGHzA4jgwWYMcKekUHvBKnPMJeOcLkMJB6VjssyVjE1Urr7YIU5jjU983hi1oi78wDST51Uyx7cChd8BlsOm41oNdJlchkJHtImCE52o7LlSgOfTbAKbmN3G7vb2F0zdpcfXrj34+4pQZ/WKvS5UjwB+0ZUPFegT0TeozRLB9ltRbuQdMLAQaT3n0YQ2F+EwvHCvvL6jvjIlvKKN/zpetj74xQLpqW/0B2BgGRHq8EEMpHwD0nuXGIylDVVZ5UbAOaxBAdVFRCRmrWFTgCtwponCo9cMG52mK+FUa9iNuO3tC0J8toMiFyVXw+1VPEWSW6R5LYabavRX6cabZHkNna3sfvnjN2vIslMKooWh5NMMp/zaGE9zT23b79gAEtPauaHMLNXg0W0gsRYhrFqZeRQG7db49Zk3xNdn3f9vU5/0vb22ry339pvjbvt/Vqx1l/ncZwFWTmmCutt19G+thPRLeC4RIFzmVhrv7z9l9ALZUxrmHoy3Aw2B5Pe5Nixu4odz3QMugFhwI7RE9uLVxen9oW1JY92s4fRMGjJdHbvEyElbZqKe2m+45nWLXTcQsdt+dmWny103ELHbexuY/f/DR27z0HH7gbQscvO0tfIvyd09AF30PtsWBTQIf3oKhIhqAJXPDuTkh8EzYBeCUW2+6socqQ1+8DVIgVLprQTqXJzYXqDsXMcG6VjYQBnU0iRikHWkoBu0avw7BRgUjyvFsi5pDhGhYButKgPJjFoZWMm9beMi1RekICElBQCjXuvGnxMgjuJCcI/oED7oFNI1N9xj9Ot1jftB7ML1PgUNWYn954QGPPZ/m+v6pTAEISPMF1c2rV+4riA3TPnCtoIcR/a9JVB0C1U30L1bbnflvu/RrnfQvVt7G5j988ZuxtAdYeGnobqMGBtqA5jG02WYal36Fy/OWKnUHESkHsz7dkTpTkGJ1wBroQChZo2WumHEA5ru3jUtE6pZvdB+o81PHCNkNBKk0QBDJrFcWgOd3cfYJFgcR4bPJSN9Eswpe/wk5bd205FysETpja8IGn5iT2ZjD/8YJk0yLSRRO+1qY4YWEOTMuinYHA6WvBV+ulx8wW0H8yS2cFPZp0n0W38gALaCPdxUYM8Z0VH0O0qCh6f0+fnztf0sESe0KPKfF/lBeMZSLmkXs0eojYCVps+44P1wuP5RzZHDRJc4Oub4phLxORWwpWReZ3BtwGrH4l8xGFt9oPgER7mpwMyr99/Gr1hU0SilAkSgyBYuF/vYOfgRpTpBulhEZxExSfSydR+3zIoHcfByGKTAIzCflGXQrDr9DPFMygBF5Czyew4SVCawFk3r9PV88WtCLA6NnJro3NKX+2CFXd5ad4bqoTUMkhlv5GBu41fVN19wEaHznGMU5E6QHYdpnrxgl4vFeJvKbW6pVYnaubNkhTWtNeePd7tQXgjCR4YstaLmVt69QI97K/gDlJdlgEt4eQoH6Ly0lV7sRwlenWkV5bjF/WJvogqT2M2q6VflQyZN9PaiL8zhq6DoXI9TSDSXiwWfYZVp4iot5sFkeqWZV3WATSSfKcQGMo6Ex9j0SbMou32CYXtr7SykBd+xQ8k2K8lnen2NdRWHOlrz7xYZmRYR4Z1myeMk9+WLnQsiG3UgfKAdYCjfP0pEzhBC3nR0qrM/ER+l+Zg+fBAVKJiwkP7x2GeBN0Vowc4OhsDaRoxd3asDP5mjhbWr5Kx0t2CZQuuyhtoKJtLdrPyZu88sZT+0fRFjQf5pspHFSy+d5Z+IpP8cfLu75Txtpnmr5hpHApGdyO2rl0oOrlFdKtbfLgHPRPwLzylSCW4Dc0MtWeEYYpkwoDH9otOiGlvJgVtDoSCx4gOd9Cv9JziECAxBj+0gERoSl8fRyAwh3ZOBkCvwT5B96U8MDF2XngoF6h+1q4FuwQrn+MiseN04QBAzeeJwl9oACGSOX5L/Nzq+tJ4iU1C0IgpkWqmCcZls9KIRLdBUzSoB4nm5uMEd5GhQS0s4jO8YA2N20IGQ+afYtZyRS6E/RUeHFeG6M/RBs+pz0QQYu8HGRTAlChw+DAcrVAEYsq9t9DRdNdNMrs4Fj//B+WtM3Qa0PHhLeyioFEt0D1yX2cDQMx++m7ZmR7yTfPf6DfwXLVAmL8b4s4VCp/Y1sS2gNe1vAWECYeSfspphl0iPHt4wI0NbIge8TbQxa75+ibvd6jvANPjNfSXEwjs5V/KK6r9+sL9pt4bejVT/cNylVKnu3JqkTfkNbj8IrCPB7HpO0+70UJC2Qd2K6YwZeVlBXZIWXt8/vES1vzxf7I7CyI= +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

+ +A WorkItems object + +
Schema
    remediationItems object[]nullable
    + +A list of remediation items + +
  • Array [
  • ]
    • approvalItems object[]nullable
    + +A list of items that need to be approved + +
  • Array [
  • ]
    • form object
    sections object[]
    + +Sections of the form + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/connectors.tag.mdx b/docs/api/v3/connectors.tag.mdx new file mode 100644 index 000000000..11f6a76b8 --- /dev/null +++ b/docs/api/v3/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/docs/api/v3/create-access-profile.api.mdx b/docs/api/v3/create-access-profile.api.mdx new file mode 100644 index 000000000..a2e75ca5b --- /dev/null +++ b/docs/api/v3/create-access-profile.api.mdx @@ -0,0 +1,157 @@ +--- +id: create-access-profile +sidebar_label: Create an Access Profile +hide_title: true +hide_table_of_contents: true +api: eJztPf1z4jiy/4qK98PspjDha0hI1dZ7DGSzXGVCjpCdusukdoUtQLvG5iw7GW4q//t1t+RPTMh8vLnbPddUDWBLrVarv9RqdT7W/I0IeCh9b+zUzmp2IHgoBrYtlLoO/IV0Ra1eC/lS1c7uavo5My9U7b5ec4SyA7lBANB9tpKKDa7HTMNRjHss36nx3huw0P9deOxRhitsXGeT6cUvg9Hb8VWdTSeX57nvN7dvzM+bye10mLz0g/hB3ILxKFz5gQy3DLAIxD8iGQgHBmM2d10WGtwabOwx7jgSca4znsXG99xtftjnx1lHKmRzwbhSvi1hxo6GE65EYd6vFLvxo8BGAszg7Zp/kOtozVS02fgBdnSFt4SuCxgQu2cIyxZSuA5Oqt1sNpm94gG3QxGoBrv0vaUIso0VYACzBaQ2gVAieADQCFN8kCqU3pJxjdfGLGKdrfxH8SACIIW3ZZ54LLaA2bFHATC5oibRxqG1BcImQEsRcOVahnoFiogDU+ECCRW+8Z1t7exjLV6v2lkYRKJes30vFF6Ir/hm40qbmPT4N4WM9rGm7JVYc/wWbjcCWM+f/ybssFbkyPwqwGuYFXB8KIF9obN0MiBUGMBcdkDgco1HzF+ULCs0Fh/4euNi/7bdb502T/lJq990mj3RbMG3fud0YTvt5km/TZPmzgSYTM/yqV7z+FocRuEKWr0AgXP49LdCWLBAfM6VsHA86xF4VdSeCkB3x/Qi1+VzhKSXII/D2AM2WtMqMD73o/AQNkPfdWFJsD2gDmspQ1es4ZNYBzE7JswIjjCosxh1xFdrkRcs0YgbMHl02COwbAykXtP4Q3PkXyuU68LyNdstq9mxmq1Zu33WaZ+9Pm20mt2/ly3b2nckSOUXouZyUB8xqMYnYNietZtngGR7P4bCw6XMIjj3fVdwjzBc8MgNy9f53UoAukEZzqCBDFhQomXcmGmBbz229SOtJKVnu5EDmjIERYfT9j3BzlOeaGQnaqbgP3oiwAnkEZzg473SUFQHKVMvuKtEUQHo5ruLKLxojSZvPDq/mo1nf9u1dRoN7NdgZPe0lo5NgpBERVcsQoY4oCFRIkTWfxUDfQVUAMpsohDsGTZ/lApIxLqgLN9wh021imQiCKA3qVXQ6bByOWqlOALNXqLQxg4JI5hJp0R/8W5vwbkjRLfZ6i3mXVBjp3a72ev0ay/WVz9Fa+6R8kHSM0eqjcvBuGTUGC0usBEIALxBa5GllA+WA02HBF3Dric3M3x4PZgNfyLOA0LWmQw1sUFibG1y7SgIYGrsgbtRfiAwv1kkvojcxmTXnoAcxL8xM0zFQsD4NukuRda+zEB9qQXSfoR2NPR/K2mX+RwojalnUrLU/ZOTDix0p9cCU9VZOPPmvNfstcSiizM4JBraLSpzAgWJRR7fuiYodx/5VuF6m+5ZrMyjF7MZjlTGWxl3TA+eG2UyurEGIyseLLOKOb9X94Q1rZE2Ta1XBi8eBHx70HIOwBNCjVcwgoedRuL1WJ+ihkENph1ZXFrXBc+N3Ks5GVCQ6JStQTo8IRyytehLcRSlZ5QvGOK1OuxPZXoZnU4+JVMbYYMZs0nHwUy1D9nYYfd9TLV3FJDc0Wyi9WyG+UjjXZ6/hU/kwIwPlHnxQn2YH208ajwjKu1mqytaHdFqt5t9+vEcuz7PF/lxs4ycx2B49UOGcRrdflMsHPG6Prn9YRIshz5+uQFPX9piJDZhfTT84ae/Dkb46fqw98nxeGZQ4u2nxBPXiH5ddyEDmj1IHm8tzOMGG2qN7W7roMZ/J1Yq7hiZ56MpSeEAWNqnpVsn2uDYYAv8NWwuEolJpAo3NbFyH8JwaHgmsaTAvgdMDUgPjo7CQv5iCR4Ejhvjwo6OSBqPjtBGhan91xZDacuFloWsSZl7o2lh8Br63kIukfwHdEmOgCjZ0C3SO3izd0T6xML7vO2x/TWpommy9ypd/X3LbZBInTGjZ5CQekRtoGHQB+ngaz0c+w2eysWWCJ7CKZKoTHwMIxLpaUPjSe4OP38asMqwuwT84Hs5ro/oxsI4XwFbPRJ3b3DvKj7djlyiFdGP5jE2QP6NZjYCvovkXr2eZ4WYCrMDRn9wff3L5N3V+RSexZ8mPhL/fDu4GlzQt4vJz+fTq8EVvLyYTm6vd32FkZ4NRhMAa+k5EqgfcfIBl4EfbeA5WC3SJGrje0qiBkA+T1YOGiMRGuxnFEwwiwE6ANAGzaNqvPeOjhKkj47O2Cz2CZMtRBpeeO9h86RpbqeRMdcFxQDYTIHNdOcsMXZgGNetaPl3dI0GZQiJUN5yjy9TOIkHb5RmZsl11yLlEcaAXeAKexw8VHaBxK1rYORZaicSCG0sOeA239L7o6OYOcYOqDtSczn7tLPMCa9jl8+INDjxPBOvIgZXZ5ECzEj/k2Rm+Rax38Eli2i3Z5/0T1t9i/f6C6vb521rLuy51QIbf9Lioteze/sdwkFOfKFdpuE0tk/ShWWpkVF98DVTfaKGnyYdX6blGwfV/DfVO0XkKxVUqaBKBX0TFYSilyogJZYv3a4WBdQQqRgx1ooA6DIeKfyIR6gzucCTgTq6z3EwAg9byqIRcunpWGdCk7va4mTemp/yjvV6IRyru3C6FnfafevU7LZORKsPPdp9e96zmz2r5fBTq9sR3Dqdi64177Tarxft7umizWv3T6RXHqQCnGEWQwwxB5LvxhHf0eJ5KSevQGbX4LFJQAuR9yN0AH1vN+pCc9zdIeTiLXVNBPEBz2EQGQqO4u6BpI4vwVNWGET3VWY03ICsfHyEe3T4lcxlb5CgZEET2n5Mz/cw8oEa0V5J14FNFxA+/3ZwNSq+hp0RqMYoRKZw0IvOth9OrmaD8dUNPKY9ETwCyeCg8p/q+a5rrToO97+x/TBsDF0e/F57ukcwX4Lg+V9vB5dZ8BdyjsdHRfRC4YrNCuh9Fa3nL0HzdauN6N0/HbK8GTj77VmC5tVk9kvyIzPsTwP8X88elnDHgt0kG+FkPGLb6zIxyMVK4sFiHVLWY5LMAXVqSrZPPLNC9mZJdxO0CnH7qA8Tjo4S5HFPrYj/obvGsc5S4tRZTBs6BQbq1LMb8MzZb26XrxU5beMkmXOQ3929eU2suXR3ROopWfxPtSQ31MxEDWDWOOU9NHk8Do7DrNHJrmhy4pI8OUAkIE1Kpy+iT3LWk2AKbz0/ZHpuFhLEoXh8fPILDisYRHP2S54LGq5NIOkwLA7lJTS3eeAK0bChS8vuL/rz3sL5P1wH6fEQEIDNOB0HJpK/Y9FeGL0ciYX0wEGjIwOcqW2YPPbn4kXR7Jno3sRLSt2BAwfLleRXkl9JfiX5leT/KSW/kvRvJ+l7iD5ABYCEoS6JPDdYfAyAu9IdYoJEIdUm03r+rDRO20iyEBpskCTpEUcHAt8+CJf2von6wFhPchJVz5yJuoIvgIKAdI4QCHuH056eF8dLHLZDB43PHw79cUnyIhK0KxK0khNbfdJ1Z7KkzBl0kndyvyeChDEjAkChTG2x2s3WbnSkENpIs+iqxMwqMbNKzKwSM6vEzCoxs0rMrBIzq8TMKjEzG9moEjOrxMwqMbNKzKwSM6vEzCorqsqK+ndnRVWJmVViZqWCKhVUJWZWiZlVYmaVmFklafy3JGlU6VlVelYl+ZXkV5JfSX4l+f8dkl9JepWYWSVmVomZf9TEzG6zuRsQGboSj/XPKf3FAoqFUeClFIuj0XPfodKn0gOFJymW89nJmnnT6YgQFMIQqHNY/H8Ec24tAy4RQ52xY0NHc4CHpF77AdY3RZCxTSrR/UCJRiuX/jM0k8HlCLiN0c3yEGIeoVtP/gPVv+nCpJMUWS0zOSeCz3vNfru76HU5b592Wyev5/0F73Sa/dd9yrVaw7LxZWnAPj/0hQAWAM+ETvvlPwWeQnNljgpo8JdH4QnGC3NvdNtkmgZfMH8fQqx4+2Z4zbonzOXeMqLnfFkggmfd3pTZXQ14EsilfNaNGp3/OLi9nMGTKZjE8xv4hrB2vKWBR4F9Gy0N8sLKfySMzQQwF1MJTFZFe3lkoB7BhLinsg2l/qW24MKsmTnghR5m9JIeWdBsEfjrnCiR3HwI2XeyIRp10DRJOhumwDpx7PEIRXgTWpeGkkdsJbgjgu9BHZkKw9zV7oeK0+m44+j8OQSwiECUdfASE3fBrku7YJ9TUhYVbKxHLrOLgsIBmL/ATNshHqbQNLNSmHCLQdGsD1YopnHy2M0yRCOSbr2Q2zAL7rpbIGMQYLYB+C2gtRUz6oiOEkDxeHG7RGPlEmIQm7camVHo0zubR+oFcnftgvqxaGrJiwdhhE8l0VtHJIWggRJGIxmniTqbVslyxYKfHHRUslvJbiW7L5Hd4supuYFi3pLrU3IN5dYz1dbReO64PoHZDcUl2f+pHUe9kLQLMy7SX97NTJ13ffJDG7Cv5x9pU757hyZZj8IhfWz607VABImOJpUANJFwzgjvFGMilCZVZ3e0H/1gLoFBvRIXEbRmQDn/6P8GkUepYFzVmeML5b0K2YqDfjRJgKQB6cKAY218qdNQK0+y8iQra1RZoz+HNao8yUp2K9n9Y8rus55kghVJi/GTVLRe82CrOc28p7swDBrE2YMiTc5PThey3goCY4mPVct7DrV5uzVvLU5s0XV41+l1+ou23Wvz1yetk9a82z6pZW39XSrHiZDlZSqz3nodicT053wCFnnAXCr0fScf/gPyBmKBag1VT+I3A80bmBUT+47t/q7vOPN9zCPcxh6SyvmQXkoj1GnQdo1tg7gtXalYgl70GKgq6escPbkWACXAUwfzl4AalGAJcIOtNVjg/QQtKDGTJaOYS6mKNIHr6/sfj1xizHeBPh9AIA8Wc7W+ondqluiLPHk2xRlf4ozZ+QdbCBT0xHN/XRbfHePNF9QRN3qB9wR69W6He8AAsCHQOivxOyv/vPLPKxtf2fg/h42v/PNKdivZ/WPK7if458Yb2u+fQ4MX++fQttFkiS/1I93x/NZuOomKwYDYm/k2Vb9wUh+c7oDAQ7wPgoPcgl8/1Kw8AKcdJVM63pmOxlobnR9wpnP1a/dP94gjcCLOZ+PTRa4Nx26143wXhVkH5FHqyUSBC41WYbhRZ8fHH2GNYW2fGnwjG9JctfD8R0z4OX7olGgsXd0AuQ0GcCJdQQj/2qsepEErE0hkfq0paQC9TubGbU3BelFM+Vn4cc2IrR+BbiQwdUxdMoxIjwHNDexCXilzMR/pujNHmNtt4D4dms/PnefmoYHsmUcZ+Z4dC9ozwLIwPUT/PuWLzI3AHe5ITRBu8do7g02wWZu9ETzA++B06vHdX97NvmdLdFJJSUQK/WNTCoeza2ARUoKD+AQAO5FdCvxoaW635M5YUOjYwoUJs/fejRDsLr6ucwXWYQrqnEiKnQRpEOx1/128Mg7mzKDhbKSURMYDxj8GCh3zXL/vyUjSbkKm1a4a7z2LjWSga1kpamOmqGtf3G3iefHMvD4Xif+JoVlGzAia+r6AhSbtna1zdmyQfATBXUXU+uzBNTwrAw+3XvAEoRZxQEoYPPInY3a8ap+NRw6ehfDyeLz33ulLWLluTGsspsCAug4bm7tU/8sYsg6Kwd0yAin6bLTo5pdFEmG1mxmULD2kJS3wJwm/SxAMTzOTLpdG7owPnp7naJH8lVYWZP5X2G077NfcnOnxHZhdbOn4tvpsnHFACwe0tA5QBn9t1ZCxQLZxDromBDHAMF1/0gQG0YzO07BKtTqBP6Y+aBpsQJWgqM2Z/nGWKjjzjdELbJ20ARWM7nhyVoh/XNvAQtOWI1YcSChScBdf1weLWqCbxjcJZKGV/U+bL844c0kYK719bS29R5P85+jdf5PGqzTNn1HTGAcZ45bT9C/En6f3ZnVJp+dLahaF7QsrXmaKNuo9XVIA0ch4UuhP17U6XLAvrkyV1qzLFqbLwHimElxyxzUp2GZgFuqoFYuk3SVoZ0ty1ctGLSmqlYzy5cWv7gsVrjRt91Rf2i2JFGeZl1caMsCKFTbuiuUsdisU5AsUvLAwwP3zlUW+KR5pgYGvfIN//wX+6jL7/+NldqyWB9aX9I0JrGRtvt687h6GUEVCgTUMrsek5ygwwe0wLViQBbNxeYgmnlwcmL6gMOpGcJLOOppZf01uCTABiqhQGtCS6rIFoL+5a8pcNNg70KOeDRoNY1SYeAZQf/NNsOoGjM412iw2iu0YQwmOPKz2AEhEayyJeMjYOVLZkYoLKXoinhndFGFJr9hBQSuKpKC6PCJYq8nC6KeMTTswFpg0ZQ7bgJAZc5ROZCpcfesP2uWjEYdggyG1VsLdoMoGhxL2llmD93Y824EIwDxtNhp+sDw2ndQxtsVbcjB5zQydRrPRxEcYMAJBycAd7imrV2Soj+kRo45noJupa/Kp3d7gIw6MV0trAo3rbDK9+GUweju+qrPp5PI89/3m9o35aarkmF/gf5oHcYv4ZDvcZq/TERegax4a3Bps7CVBf4ynZ7ChGjG5YZ8fJ75udLgy6CtlCpIAATDqGt9JSmsiusJbQtc46p+hcXpHsN1sNsFx5SitsIYNdul7S+LppLFK7vthGRMMXOnDTvFBKh3+0HjFscA6Op+CyuTg2T1WXiy0wMpIjwJLwSpqEm0cWlsgbAK0FAFzuo8Ni4inTgrGr443eFqDbBjpeJqOW97VinFLsDQrjGzCq48f0QXDIN4TPga7ioHiu/s0Roe/AKSO6ZO+/l1syekjdrXIvqZqded0HBW17qHPCZ5tmw2+YvljaIzXrih5QIehA/4ID/H/s9p7+EeKXisEaETPP9biQx1oo+HGO+eyjaP5gtN8evoXelxAnQ== +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 objectrequired
    + +Owner of the Access Profile + +
    source objectrequired
    entitlements object[]nullable
    + +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. + +
  • Array [
  • ]
    • accessRequestConfig objectnullable
    + +Access request configuration for this object + +
    approvalSchemes object[]nullable
    + +List describing the steps in approving the request + +
  • Array [
  • ]
    • revocationRequestConfig objectnullable
    + +Revocation request configuration for this object. + +
    approvalSchemes object[]nullable
    + +List describing the steps in approving the revocation request + +
  • Array [
  • ]
    • provisioningCriteria objectnullable
    + +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[]nullable
    + +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. + +
  • Array [
    • children object[]nullable
    + +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. + +
  • Array [
  • ]
  • ]
+ +Access Profile created + +
Schema
    owner objectrequired
    + +Owner of the Access Profile + +
    source objectrequired
    entitlements object[]nullable
    + +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. + +
  • Array [
  • ]
    • accessRequestConfig objectnullable
    + +Access request configuration for this object + +
    approvalSchemes object[]nullable
    + +List describing the steps in approving the request + +
  • Array [
  • ]
    • revocationRequestConfig objectnullable
    + +Revocation request configuration for this object. + +
    approvalSchemes object[]nullable
    + +List describing the steps in approving the revocation request + +
  • Array [
  • ]
    • provisioningCriteria objectnullable
    + +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[]nullable
    + +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. + +
  • Array [
    • children object[]nullable
    + +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. + +
  • Array [
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/create-access-request.api.mdx b/docs/api/v3/create-access-request.api.mdx new file mode 100644 index 000000000..2762203bd --- /dev/null +++ b/docs/api/v3/create-access-request.api.mdx @@ -0,0 +1,131 @@ +--- +id: create-access-request +sidebar_label: Submit an Access Request +hide_title: true +hide_table_of_contents: true +api: eJztHGlTGzn2r6i8H2ZCYWObmw+75QCZYpYElmNSu0Alcrdsa9IteVvdgIfiv+871KcNJJns7kzKNVUT3C09vfuS1A8tO1WJTLU1R2FrrxUkSqZqEATKuTP170y5tLXacirIEp3OWntXD61Lp5J9a1J1nw6ydALPWjo0e5LmtBOetMeAWjePN6utVI4dDmOwwsN1LXgVKhckeorrw+oXE+2Ey4axTp1IJ0owUOGBCm1SK45CZVJA5p29WxV3E5UooVNxp6NIjGwU2Tshzaw6SsjpNLG3MhLwD8JTrnNtrs2gBtwJCZDyEaGQbmaCSWKNzVw0E8MayI4QA0A0B+Cm1jglRomNAW2gQZlwagFbEStpmBS/zLWZSCeGShlPaAprIVUH7wDvUMBkGJfBw5FNcnS0GcOKr1UgM1imvgL8XUV1tWCGsSksmmaJAcBCJYlNro0eiZnN/NIizKaRDkBODUY74DSgoYNPOZEgn1UBCFUmA9CGeBBj/yidSEYtAj0IZwgPaBkDqwBDlocKCWKiflUBMAFEckRThghqmsgg1YFC1gQTBYgQcBCsutcuBYbMoUxLJmoECmFwIvDcybggTacqRuAAR+WsJzDCqLsGMGA2qWIgQU2GBMLGwCo3AbmAJmQoEVrhqsECl8o0czc/TtJ06vbW1kJ1qyI0sY6TOiKJdQDWGljMmpzqtdv1NQCbtuvW02Ywr5A/tMoUxD1Pc6HYX7Ggh9guQLwqVMoB+f8EOQco4cjZa8NaB3g4JZNgIganR1+0Ik97VQoTgTUFyQIiKcLC2hubYHNpSO3azGsfAFfGZTAOlRSNmS2A3lbWaarmOJGG9e/aXJA7wbnpnRXpbKqcsKPGSns48sOHn84G7y4+DPb3D8/PP3y4NitiH5AaFpbuTTjOolRPI5VTpBVZlxSoQ1ExuoMAzrPp1Cagy05Fo1LK4Bbyvy2uMJHwFtCywMYElFElILIz1HxkAgnqJ5WKursV4LNHepyxs/8i8Y3VnIIGBKzUGSI1RzKoriQseXdUKiRxgB7akSVLiB7IEnRA6AM/gU/8Ud0HapqihrG6SPBkdYcHTysiJ+kVoiXqY+DeLfh4caByuwE0kC01xMAPEe9IzwteMyCkhrjrSC5nNlLot/glGMxIwwMSDMk0UjH8S/6ipgA0+f1El2JGZKpTVkUs73WcxSjP/mYdHMLvdWFqoKean6B2IgeBYaREpfYI1Mmzw19O/n44p5TWYARramahgoWtoemJVMeKEPc+AK0IHcBCi0vULcitYBsGwKrxQrhhg+b3RejzNoe+NAHeQpiMh8DsiZ6iy4OnQ52kk0SPJxgK7K3GAERREBE7sMB8RMuxvdTMpSNOkNpYGjluCHceX/avOhGhBi6nxTyQK/h7O1OKFeAIfID4mKgYwtYBqOtHdCBuCoIZaYxjqMjVhIUCMDEcZ4Ssf8CHkGItiBWZzGIhw7G5OjVUrCMOawoB4odMDAIcopoZT7+XZxW/Z9R29WW99dZ8awOyFAbGnCvCLQ5RTeQiDQ6aE5pe9a0A/9LUnoIQAn/lkfVO69Qje1NEIub2bE4OoyrfQ9AM80Na+PaJvFWo58AqxdzvQGRXdRBxBthglBejLMX4geNW0b4Q8uXFPknrN2tUp+bCCh2re6R5FWPlqqgUJI/s7u50OhEnZz99GBy8PXpHHtFiol3E3hdtbYZoYUD668rKO5uqvZUVwVFMo40AFaFmKeaxwWdfSU5gNVO+PGI9LcdB1lxk3867jQIRUg5xIT/5pJTyc3CyDhyA9/53aBnoxTljgkHg2jn9rvIAHtapR/MGmWSOtWk+DqAsoDTxyL22IVQnD/QTuA2lTJpkarUVYKFiUnwF9ESeFWu/Oqw3HloO0pFY4l8Y66ECsUPMRgEu0A46i9E6B0uW8cYm+LtetgwEplTowXNeQjrPzLqbUEmgcr3WrhId0K3o9AdUpbp1kUNBW6/4bpBzFXwHcPQ4yySRM/hJCVSFFpcmwHR4oe4lqB4+6ge7vZ3uzsbWVne0sRludXtbW73tUMrdfq+7ubPRenwsWHpBUBZAM1mM1Vw1/4HHtdDTWjVZFM3Vd4NG/ADIGKVHEnIkit5VmJDSVEHS6JIjuWVzBKswJlfrqsgEeOko7NRY0UAf8ZVDfMOKQ66rQPmswpKSQyo8arD8KVE8oVbpCyz2cfz07OTN0fEhMvmE/jl8d3F0cXz4Fv5dVEQr5pVl14i4gAKh/ZWqV2NFYxkgUIeL0KqvA6yGFdBtN702xvBK3Hp+ca+S65thX232tna6vc1wvT/a2e0Gsre500N0IB+NvRU/j9M+D+ScIfQJhl83oTiTj/CGiL6CfVRFZ/AlMg+Z6A2TCeyQyylxP5srLnyQJdv/2U4M5ipEQYQJ3FuVSgguCx2ODEONVMjodIGOLDDmilcaTKfUvfG8HG3v7Pbhr1G3t70z3N4J5YZc727KXmu1NucdlMcwK8WEHrwjGf8T4JtDV79i8cc5d5AMdZrIZCY+qVkbQk2mxFRqrGZAiWe+jaEwVg2rrRkQajNwuZkjNc/SSu6FvQ9OvqRzNtBUZ0CkwR4TVLGQjK5hZZ8ZLG9SfcvFGWZHawvr8Q7bfp45vKyOaIqU8pFyWbaMhqZwmI6swUwC8NRjwyGPGhh5ilmk1JA7YFrwydg7JMtX0lPtwy2lOFRKFukSIeCdIic4NABx8ymYOD8e5LmwCFU14Ub0+htiYjNfClFfhED6pDG2IWOI9bemilTdQ8wNkdZQYR/Qdw/CoiIcVWt+TzQnkTkWiwjPM8FgIoFZiyivVqEMa4aIY3VQpmGJohp7lZRlVtY4LFjqlTWgWuqg5Tll3r0i5CmGL+hUYqXDKQy4lrLfNctJkCZQkdBc3OcNNepEYZzHlMhmaYNEny8Q7ByZBnyqQ3ARCo9lzljBkKoPHJaoXL2fWo/8ZVFu6JR1tSi7fJ1QLQLYQcLTWIK3biH32pg81z1+t99td7fbvd5Fv7fXX9/rbXa63e6/iuSDEzhsK+dJzs0TARnjLxplrI0PxT34Ie/9j/7md+B6vwn4P4Xr7cxpQC3vnsu7ntIKAMOAuC9PsgSlW5C4B9hsAszaEOc9yr6gLExDurwHPoIUcUZmRHOo2CFfRQzArOYrqw1Gd6Pbncdwn5RXHGL3/hkshxZ77FiAgSh1+DtwaaaoIdiNjvZt+Bnh7o02qj1OpEYMacMBisFQ+WwMo0mMbVwGmaenNK6eEgInOj3xWobV3iURA2wCrQ0+Aayjz0hRL42G+SKfArGkCDALllXbSg63urv9jdHWhpT9nY3e9uZwdyTX17u7m7u75GhAD6DmX5Tz15f+SRmV6AACO5Su+jeFLVwJvGeXiYt/fplAMD4z3eCxBZkeX4G7ddjwfL1/Kja2RQQRNKPnctxggmlfztdDQDkDPkn0WJvnapaDwzeDy+MLqgj/cXl4fvFULWjy3gT2WkeQYtwRxp4AsjsV8daQWPFQVyoban6gdhUjBN2iYhJm+NUXzKiCzvfsSlMKeGtT/Kg7qrPKu1EQzcBpDaXLW3lKrLDvaB97Tq6ICQRklbyCBK0IJ4Icq4P5VMJDnOG+bZmKFaEX4qoOVF0WJSufqk6Pq0JB4wDMX9aTQZBmgByRWbXCQls8il4+gDNzro7dRdNLzkxKm3YS3WRgE8q2MCzgbq53R9Q3Bcdj8nGFx0IXmJNF7u4tI3OQWnpHe58v291pBO6nTaQVL26VNz7qMfjaUJRRP/dI3p/T5KKC9LzIDZ9bCUvbXdru0nY/03abL898XubfUurTm099Lo1vCP+2KEErGtz5IK7XWJB0sMCnSD+/v/CNZmweY3GjvmV+xKF8QUs4lwc/H+YHBvLQX8oCESQ+MgUj8EQq3CO8S4yJUcyq9fnVIDsealBQsyBFpC3OfEc8yQxV9RLK33yvhDuplQ1UbrK3ucu+zCSXmeQyGi2j0XcTjZaZ5NJ2l7b757TdZzPJAiuyFp8nuSyOZTJjTfPvaf9BwIDy5G5hciSqZraCwESRY7XqmUNr2O8Ne6PtQG2EciPcWt8d9YOtvtzc7m33hhv97VY11l+VdlwYWd2mKvJmORKLIYnDXmxmQLlcam1Yb/9ldPIV3Rq6niJvBp4DS2+K3LG/O587Xlgr3uJxvPxYdi2HNCWP0KfB2BjHVs8JSzEGv2jwiI8GvFCV8HBTWyS4d+JPBPGxG4CbzNqDUQqksKGUu/V+FW2CKAMMyRPgrhiueyd1mh8CBQiUwY7BO3/D7NSL6Hdl8uIMKT5GisXhfaAUGnqRuW8u6u8eAfIJ+ohzFvATjV6udqQBBYCCgH1WkXcu8/Nlfr6M8csY/33E+GV+vrTdpe3+OW33C/Jznw09nZ/DgM/Oz2FspyuKXOoNKtf/PE0nU/EYkHoLG9ABq7DMwSmvAFVChKaW7lZOJd6hbDVOnLkW3rrElJCxyZIIBuV3dh5ASCCcx46c6k5+QMrYO7q4c7u+wOVol5sgOK0wo5PbdOiaF+kQaxON2suujhZgRhMxqKf5/aBn4Ru8c2fpmiE4NwKzikcpvSbRY7xNB2XED45Gd0hz5mgE2i6T6PElen5Zf44OBvIEHYvY9+xaMF4Alg3yEP2b8pLsOebbvPrcVdkyhmCN1p9b7ASH9cVrJRO6V0BXon5+f/FKjDHLJCvny4f+qJ0Up6Ai5MUGeQsfJ1FgSWw2nvDp89omCVqNGEV4jfXanCslrqrnec7AHxNLB+X9rC+6MSZr817xLTgsB7Thk2F8tqwtDuhAHl4OozGeRL6UeTXN6ZIVur4Wib/k0PJ7bATNvWpgway94hNjIgDTRRAycsStr16c4bUr8Np0AaqNUJs4ICc8HvWtrSCX2lfjUYPXRnh1PK7N+4nG01m1aYI9lnAQAaNQHIlgYq1TfxMCVQfN4GqcgRV9NVp3uGibLKLd71ZQavOSbd2GhJDwOwbDMKxMcogBmfIRC6maCdkkP5JkweY/0knHjzWa6fEVxE0cGdrgC+7NNnDGBdu4YJt9gPP4c1hCxcJzkHhPCI2eFWC/lD95Ao9oxecxrIVencCv0RwMDQGgSlDcdI9/7JUOzv8l6AWOLsaAC8Z8utjsw1s1HhbGphqz8k5Ak4Pz+EYWQmKDb4xv0YnCMPlHoxcpHpQNE7w2+K299BOe5I/jd/9PHm/pab5HT+MzXGw8npXX8g4XHGuma3RXL19Hu2ncRmve2mpexLoqTHfu6pSuHKN++rJR5a7R597uWXTC/L9wdaZ67+SZI/Q3L6HzrU6ro1Mh5fIFX9WVcU4+36TliyDwfzoJnloumKAc5UugzZPl00im6LnIcwcTrai9M1VA1RBvnYGi2pi8bfFhFwY0po/PJKCWEgpyHdH1kfdQP5sADAlrZzwQA1B/tb6IPgdbOqXPCxzk5klXxTKDtwoBiSzG2/Ev2XCoXZBxqIFS2qicMv5SQzEr97voHJAVdJlTJbE7GeE+gA5UxVRfWAss1flNAGAkSsSwtEpCzlREvgTH1Yusl2CDf2hPVEQXCCBOQsqsKiu8PbqYgwjAjAO6AtWxyXjNT3JrOBaAYEHLyrDegZodH2EdHEtTgXtefGCm/gmLpkI9lFsfy08HLT8dtPx00PLTQctPBy0/HbT8dNDy00HLTwctPx20/HTQ8tNBz306yHcKcHdmbYqHCbAayXi3iHflrlrNXTkorye4bwevHh5wqxm3qB7xMQzAfcyrm3IHCn8BSN5ypubEJ4Vbnf6MU5t6GsWe5vzhLdwU4xm8jf3s2JvK1uLpCW7ot4b+o0gx75Im8g7revj/Xusa/oMfPsBSjwCfP7TyMwcwhuHmfeFFbVH/B5L5+PgfH7h5JA== +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-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. +* You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. +* Does not support self request. Only manager can request to revoke access for their directly managed employees. +* If a `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] You can specify a `removeDate` if the access doesn't already have a sunset date. The `removeDate` must be a future date, in the UTC timezone. +* 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
    + +**Possible values:** `>= 1`, `<= 25` + +
  • Array [
    • 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. + +
  • ]
    • 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. + +
+ +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/create-account.api.mdx b/docs/api/v3/create-account.api.mdx new file mode 100644 index 000000000..e0a42557d --- /dev/null +++ b/docs/api/v3/create-account.api.mdx @@ -0,0 +1,90 @@ +--- +id: create-account +sidebar_label: Create Account +hide_title: true +hide_table_of_contents: true +api: eJztW1tTGzsS/iuq2YeTUHgMxoHAw+46QE6RSgLLZfMA1CLPyLaSGWlW0kB8KP77drc0N0wgyaZ2c1IuqiiPRmr1vb+W5dtIF8JwJ7U6SKOdKDGCOzFKEl0qF61Gjk9ttHMehREbXa5GqbCJkQWugRWnM2nZ6OiA2XKcS2cZV4z72YyowTTmuP0EL1JmhCuNsszNhB882IsZu1Cn8HxldWkScZBesZuZMDABSVe0bmSWsbHwNEXK8tI6fJYqycoUBqQiqlfcOSPHpRP2iunxR5G4+EL9dWXlvXZih9XsapXNgeei0MbZRY4n2rCJzAQbcwvEPWs2Xlm5UCPm9CehgCM3Y4fHv/9rtPfu4D3jpZtpI92cwQ5G/LuUBhY6zRIOnLuwbwxKtSIpcSIo9jY6s8LsauXEZzcCCqhsmaqdwJDdybniUxFd3oHmkaqw7pVOYe1tVG0S7ThTitUoQTJgNnjFiyKTCYnS/2jRULeRTWYi5/jJzQsBpvPaiVZbhM6jRn1o68KgfzgJT0i1eQdP9/1AML8Dq6exa54Bw6RMtA1v/OoRDio3WNy/ftPIYGErNY0WvJKbqXDBbGQEcpuWc8IS8ZnnRYZUNobjSTIW6+ubyfZwbWu4OeSTjS2ejPlkiw/TJLq7W414mkokz7OjDlddTu5adNscP70HGJCcIhqBa0uFMklbZHz+nue4wRs9U2xPC3hRgtOE0Y8pjdjRuxCj1bifmXOZ4ROsjWHm3y08F1oqFyc6B7GAXScdKSGsH9VG3iWd4aQ7tJAttLJe5MHaYNEDRnauEh/VqXCwj42+wSfv0QruzzgRrTZnSI5LBYqu9oBAZtZxgznBTwafgVC197xKkj/d97uuf8l0kROZMj2p81XjurXjNV40SLbXX669HIJtX26kfHNtHT9tbm8kA/i8/SJ6QNuWtHYsbJm5oOnh2toiG7uZBDWyfWMglnrsmPIoZj3PW8gMbAypAfOPVBB6Mo2/xQKP68are1en4unoey2V6E0NGAo4FMRyAgvRMtcyRePlGvK7J1mpl+bFHYWCJuJ19oqnIK+XbzcIg4o0PPkEtL4mHZwpCetZtYSBUauc9MC2Ykvw8eba9mA4gSDlg5fD9a0X4+0J39hY236xvY275+BhkJfbCYAbw+cLW/8ulDAyYZmGOiD/EFgDuQ0VhjaHJdKJ3D5tA6LxFfrHXOzn1mIGfhnWmVXG2avdIzbcYhlX05LG+fSeElTv7ARGVJllfIxDWGRAck/40MipVA+xIlSZY8Dt7b8enb09hZHj/X+c7Z/AJ6S1ACBGCrw1RbcEVsEXZvqGOA4C3HDLrMhAHSKN2UqgugIC8YAjwkTpn+zcgjLBtyYcQgpWhN0fWNEmzSZG551QSnxRZs9kLOJVgBowlnOXzAIk0B5vrEAgi8L13gZNrrCZ4Kkwz2M2qgtGVQhzPkfMApWkASyTEkJZEJrQpWNKO5mIri0aVXat0WSTt22jYHAA50/7yShxJTBHYrajsPaWwGKwD/DsNdfl7rSlNFLpHHJ0AlIA7pmDGo0BDTOoKAzhYUhHaC4LiUdV8+qM1U6SlO7eeWb2nKZ3CS/tV8TdUQbpp0ei1S+uRQg+i5DAZyOyRmWmkJHgJSV8XBxm1eaqAh/QocjSZewuY3cZu18Zu/dfHgdUF94S9FlfhD5nKrRWWDwXoI8h71G66r/+8P2bN+QqA4UEiPTmw2lo3GC++FwgMPyB+MiX8kUgW9vDj48RftTG6tgCGSQ9hg4UMpFId4jvhmNSlFfVxuJur7UZS3BQ9QBExJ6BzXXJOKjMlIpANLerDNoCq35zbMavqUUDfn0GxF1V2vPtwhJJLpHkshotq9EvU42WSHIZu8vY/XPG7qNIsuaKoiXgJFvmOTdz72nhPUrLGUxozhfrkCNT3UcrSIzVGCvqIodoPFgfr0+2EjFM+TDd3NieDJLNAX+xtb61Ph4OtqJ2rT9v4rgOsm5Mtezt7eiP2IW5BhxXKnAu67ROu8d/oF4jJpjWMPXUuBl0Diq9rLHjYPuBA3yt2Tuu5hVCsh0MqRodYU6DuTnONdVcmMDZFPKiYpCqpPanpjIXQMXgyXsmc0nBi1IAXTPvjSYORPGBUjlZvUv4XsdSJsg0omYNjiXxS58JYj6gQAh2Ctn5B6LTYKL/CsmzY5T4LUrM9j8nQmCg18j9xUPnuwfAvMEcceIN/IWDXt/tcAUOAA2Bz1k17lzi8yU+X9b4ZY3/NWr8Ep8vY3cZu3/O2P0GfB7Q0JfxOUz4anwOc+M1VmOp1+hc/3OYTqESOCD3ZjpJSkPHzRUGJ1wBroQMFdpSEuF4+yfqVzd/6KIQYkHPRmnwHsfMucLu9Pu3YB2wyl3MCxlD0gIDubnSN3iro3+98UCuwUsBPq4gW6VlQmfMdG+LNolJp0ai2/ocRxt4DZMU6KDV5ZFH6Suek+nmuoSsRmRWGbh4cCEaBjYL6B9+szQ7JpdZkBFkOzPZ3VPy/HPjMTk8kS/I8ZD6Ht0L5jPg8p54yP5lc6/rBIG2333hdldTPLA5GyxsdojTBuyV4Aa6AP99xbM3H06fsynCSwrv0iKyFRL7AQiQI3ARSl+j6uweF1FFMbqczojxUefbEQwXNslAYHahToRg5wdBCe8hrx9DIiaV4iJBsY+rLp9VlknFtciw5MWd60R9mao+aKjPO+ueU3mjPkAq+JjTaHyhemxPYtaRWKZxThCR2jp2XlRy8ZZc38vEXypqPU+tR9Ts83tceNWeJ/62TQIxiyR4Zklb3725p9dr0cOmCUaQ6n0eUBOBj+53Wkllte/mo0Ovh/S6fFyoDzMJtbO7jPlUxSyUvixlByyZaW3F3xhD18EwOJ+WEEXfzdYNbtqjiOgN1los9fyWPdkDJEj8vYXAUN6Z+BgrMQERDRhNpT4kr8iyEPNXdOP0qiMzDZ9DwcSZqU7sd/OMG/Zww57PATbwH66lAbMQ2ygD5QHvALuN/SkTBEZbOc/TejCrE/k+rcHSkACr/lJkseMfdpoEFz4xeoGz6zmQghFI19/y4d3UQIvuOLaVVR0B3NfgIr+Zhlp4T2+e3/oICuvjzyYvSjxqTkoOVTb/0Vn6C5nk58m7/6eMt8w0v2KmCdAWTxyPm7vq+8196O4N8p/+djT0/BA5pMHQzrTj1QPPxSNIPCOfCfgPbynpUDsAzZb/yQDCsTYZEMJheFJ6SmZS0OFFIbhDELuKIaJzSinhZjO0qERoSvezDeieQ7spM6AXsw/QHSoQ1WBniNc9gOpHHVrEE5DvCOVje5UPAhbM81Lh7xaAiTJnHDz9CUcFzSelz6fQKCpRSaYJkdarquSCEYCqiKlHMrk9nOApNzTQLX98Yi9wx+o6OSgSLaK8JRtBjkVGAYPzup3EU7QhCHozkRXYm0IxAFwoWju8OzhdoAjElPfeWJtpPyyyfZwLRLBr886wEUNHikPY5UEj3aLrr9ez5sc2HTe6bY7zl7+x+fbf2IT6jY1Xv8ADQrRB6RtB32mfR7z1o6YZNuEwdnuLzGDbeYfDkMPwUOL8sukq8Qlo+fMjas0/CcxL4QuL3umcIEg4oFj8JgYbXb/Cn0k9OveydU5wdIinc9E4/Pon90ceht/AIP7fiS7gDx504cMAfyKE47dRdYCIuY7oVljvIagTPqCYd3f/Aa/j9J4= +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. +>**Note: This API only supports account creation for file based sources.** +A token with ORG_ADMIN authority is required to call this API. + +## Request + +

Body

required
    attributes objectrequired
    + +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/create-auth-org-network-config.api.mdx b/docs/api/v3/create-auth-org-network-config.api.mdx new file mode 100644 index 000000000..29c99b32e --- /dev/null +++ b/docs/api/v3/create-auth-org-network-config.api.mdx @@ -0,0 +1,103 @@ +--- +id: create-auth-org-network-config +sidebar_label: Create security network configuration. +hide_title: true +hide_table_of_contents: true +api: eJztW1tzEzkW/isq7wMDFXcSJ5BNXrZCCLOZgoHNZXlIUjVyt2xraEu9kprgTeW/73eO1G07NgQYaudSXVMT3G3p6NzPd2Tptmcr5WTQ1pwUvYNe7pQM6rAOkzdu/LMKN9a9P7JmpMe9jV6QY987uOz9WNqhLMW5MtIEcaby2ukww4cQtMGQ641eoXzudEV0QfV8or04fHsinAq1M16EiRKFClKXXtiRkEZYN37khYkrCgkGRM7r1pG7TJyq/9TaKS98s6DPwTzmH4hHvjqgOX2QOYgyPALDzUgwfdu78MpBlKA+BpKPBFmd1bu+A/cOSykfntsCU2/5EStDP8HV6r5wSUvL7AomRx8SLTEEsUwIcQ7RR7Ys7Q10RZN8cFKb4IUyvnaKdbM4iQlbN4XWrMiVg9aMKO1Y57DBuNaFKrVRfkPcTHQ+EdKpgysjxHYmjiWeQZ4WUqWaKlgLc3kBacYKY52ciWlNK+FJfJClLoSuhCwKaBq2cVcGj74ewjJiKv37jGgPPkt7rGxp8yj98goDkU+kk3lQzm9cwXsKmgAJyQFMOaMxdQWHzKVXooQ/YWAGQ+ZkNxPIGLKqSh2pb/7qyQK3PZ9P1FTSpzCrFGxih7+qPGBi5ci/g1aeDUlSLwxj7nqr3qqg87IEBRIB/gkV8FTmRQc19QtEohJ6dxs99VFOq1KRZ21nO9leNsDwwdOn2fz/webOFsWHqctSDmksuRTmLijtGxjMbW2CI1cpvoLJo0OMfHmKP/88X8sUPCrAu3wg329pDa0tlTQrbL1QxgbE581EwaqOfQH6/wAPLQRR8eScYoEo/EsMS5m/T49wc/Ie0Wgi4zVGsi5h+pEsvVrgn3kEk0EHeuwtZasUhr27OxoCX64QaNEJBltb9M+XBDHxQ1IEznSdI3aO+BsdcXed7x2VmrLnsXNYtY86RzUSTOjRai1AHdWG0/R39MZYiY9gslVD3dftS9Sa/pgqFjhUzDLZOumXqsHUuqa4k0eQCDyOGG51RprItsVzWXBdJ/mOkjCkSdSI96B1UjzM0IXRmC+aKUIXbdiuWVbtKTl8trU/2B0925Vy8Pfd7b2nw/2R3NnZ2n+6v0+rT1H55Fj5B93/R2WU0zl7San/C4Wg6PuUN3jxNQHwCRswjS/QP4VcHNuKmfgVhGw2UMWfH70Vu3uiRKKo+b0c31OC6V+c9daEWST8xumxNutYUaaeUry+OH55ePHqHG9Oj/91cXyGT0RrBfcdGnhrQW4JVuELE3vDHCcBbiSBOcoeqsjEk0T1CQSSCSOmgTo++RmCcypSIGJGWn3NjEXSYuTsdCmU8ggDxQ86U9kGUIcncBOAaIYAHsgGEcg8OcxzVYX+q6TJJ2KiZKHc40wcFoUmIQHBEI0givkMX4CcKHQjgVEdCNHd6DCxdRDISjpXy7aYq3LZGvN08mrRKBQc4PxhPznMQw3mWMzFKGy9JbGY7EOJkddZ5u58QWms0pkJgG8EPUtK8s5Bw2II2TSSakpHZC6PxGOacW3GWsySnO5eR2ZeBMvf5bL2XxB3b0uknz6L1n7xQaXgY5icsj1ZozFTykj4MlZ0TG5rQtJFE/hipFVZdLHbxW4Xu18Yu/e/PE2IO33L0Gd7FfpcGOq/rePiuQJ9HHuPsaIZFFF5NOQGYbYEkX56d47Afq8MjVcfK2rWvyM+iqV8hfnD1h7x/ZDgR2usJVsQg6zH1FcgE6nigPmec8yKiqraWV3tpXVDDQc1ayAisqYTM1szrHW1McSJ9BuisMqbR0FMJPKjRER4HzMgrWqKfmX1d+1rOiTZIcmuGnXVqEOSHZLsYreL3e+NJFuuOFoSTvL1dCrdLHpa+p5/VRIYIJq9X9GGHJvqPlohYqLFWL1l5NAbDraH26O9XO0Wcrd4trM/GuTPBvLp3vbe9nB3sNdbrPWX8zhug2w5phbsHe3IKgaI+wAcVxs4lw/WFsvbf1CvUyNKa5R6WtwMnUOl13PsuLtmd9sGyAbCwI7uE9uLF6eviD6WZvKkN1u7XBHMjqrDcBkYUpIPQ9Pahw46dtCxKz9d+fnLlJ8OOnax28XunzN2vwo67j4EHXe/AjruCoJYI4JYvyd0LIA7CJqNYBTIkNdQryHYWEEUfLp3qkG6sQot0FtCkYP9VRR5bq14Lc2sAUt+aSfSzNVF6Q1jpzTWNWMxQIoxUqQRyFoa6Ja8Sk8VYVL4jyj1VHMck0Cg62b9w1GAVDFm2pNLzSra5GUNDjkplJb2Xi18TNNJoxHBP1DgfdAxEvV33ONM1vpN+8HilCR+RRKL44+5UhTz7f7v03WnBE7AvKN0cRZt/YnjAnHPXBq0EepjFdNXC0E7qN5B9a7cd+X+r1HuO6jexW4Xu3/O2P0KqJ7Q0KehOgZ8MVTH2GxLtFjqJZ/o/H8jdg6VxAG7t7A5Y/VijsEZV8CViKHK8kZrJenWQm+zubKwmW5L9PPmgkZsAyJXtSsxeBJC5Q82N2/jEea7TFY6Qw6DvcLM2Jsst9PNDztrUg+dNPXN0dmijid86Q5HXCRjFTtNXhxTHi8QFZ4OyvY8FM9HDD5L38gpW3KGNiQdtd4Q8PjkUfwabFZoJ+iKCEZn7EErMkK2C1fePSTPv3c+J0ck8gk51qnvs2thvACX98Qj9q/n11POCHfH1VcuqcxrCZl9sLLYGxo2EM+VdHTSmQ/B/PDTu/PHYkxok6O99nxLQ1N7gHh5CxfhbHbYHAihSVxgnK3HE2b8cOnIDUWPGJUQWFyZM6XE5UlSws9I86fIy6xSmqQ4FdCs6x8ayxTqgyqpAmZzTZLj6cJsQkPs0fN5j7nacVug+eZLPIJ9ZfrihXbxrLlPR7RZRO7yxGXVyCUX5PpWJv7WUOtHan2m5h/f4yKq9jKPR7hzhDCRkKVnbX3z4pFef4Ee9VB4Q1Tv80CaSHwsH5TKG6t9Mx9L9PpEb5mPK/MuXjpamiZi5hIelbAsxInIJ9Z69Q8hyHUoDC753tI3s8U3nfocEf3B1gJL/bhkX/cBDJm/VwgME51JDqkwMy6xcYuEQ/IXtixi/hdBF5J+WZKZX1+iftLIwub+m3mmBfu0YD/mAJ/4T9fgwCxim2TgPBAd4Ghuf84EidGFnJdupqzL6kx+k+dQaaC7ckzFVwfx4WCe4NKneKOORrdjkIIJV7dHx/AsEi2qUUvKanYE7mtwlV+6vmbu6S3y2/6uSeXyjyYvSXw43zh5Y8rZ987Sn8gkf5y8+ztlvC7T/BUzTUK6tAF5Or9ze9z0JO1FuYfvsS1dW1u9UbZ0gSx1wOTkLGxqRBZDK2LE1c1Dz/dz8Rffcn5gII82iRs/Rk6LZKpSBookziT5RCvedqiUDIQ3N8ib7ZSjHyCbUg7dWiNCY76N7KAmiUZRl6CXiXfo60wOw1JPR8d9QfVXm5q7M9j2LbmGeNG4C2DbdFobuioNJuqpkHDKB3yq0D6vY+pDW2FUI5ll8NjOavIAOSupIuPuxk39mxHtT6P1XXCdB9aC5/i0OQ1FkkUI41Pj1Apyqko2LY1bBv0P0Ya/9ieqrKirRN4GhFMLK7w+OV+hCGIm/SJCTVaa5DdpLIhQgxWdYSdDL0mvqD9DC7xA94jNN7+pbtZdL83uu9ftfIP+d7syn+oYNSCbFe2bkYB1bIhiA3rZa6bRRsZyC4pIm1CzikG3t7S/Qv3YHb1GcFPzfnk9b7foCcTjPgv3rO8V9fdpY79/PuPanBr51V8sqAOMM+LezWfHXi/002/f0C5Wb5iu90/j1oCTN3hJfw96V/gPD7aKTseJ6Ia37tL2EMZEug0IWocB0gcS8+7uf+v/2tg= +sidebar_class_name: "post api-method" +info_path: docs/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 security network configuration.' (create-auth-org-network-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create security network configuration.

+ + + + + +This API returns the details of an org's network auth configuration. Requires security scope of: 'sp:auth-org:create' + +## Request + +

Body

required
+ +Network configuration creation request body. The following constraints ensure the request body conforms to certain logical guidelines, which are: + 1. Each string element in the range array must be a valid ip address or +ip subnet mask. + 2. Each string element in the geolocation array must be 2 characters, +and they can only be uppercase letters. + +
+ +Network configuration for the tenant. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/create-branding-item.api.mdx b/docs/api/v3/create-branding-item.api.mdx new file mode 100644 index 000000000..9b55c0d71 --- /dev/null +++ b/docs/api/v3/create-branding-item.api.mdx @@ -0,0 +1,84 @@ +--- +id: create-branding-item +sidebar_label: Create a branding item +hide_title: true +hide_table_of_contents: true +api: eJztW91TGzkS/1dUcw+bpDy2MSQcvOyZj2yxRQLHx+YBqIs8I9tKZqQ5SQN4Kf73625p7BnbBI5NsrspvyR4ptVf6v51tyzfRboQhjup1UEabUeJEdyJHcNVKtXowIk8akWOj2y0fRFVj6OrVpQKmxhZ4EJYdjaWlvWPD5hQaaGlcswzsoyzQVjFJHBrX6o+c/qzUOxGujGuabGjk1/+0997d/Ce8dKNtZFuwoCfEf8tpREp0LOEZxlzQUobdMKXwrodnU6i7buooo22nSlFK0q0ckI5fJWXmZMFN64z1CaPU+44PrbJWOT0l5sUAmzQg08icYG153URKZ4LeFQYnZaJe4+frugjeM1JYXE90cz4WGfQR/MuQiqmh013AJW45XmR4cKktE7ncUUQE8F9U/ijYgIxC4rPuM+9UGWW8QG+QYeBFJ4gh53SOa12dabN47LG4pZd86wkuxJcw8DFzHNiA2LV0KHb3dzY24qCtGtxKNXnPyYrAw5NEWtr+29IhOLXckSR/cdEzPiwATcPCINQktlbo/N+mhph7ePSaAUbwhLGw5o6a6VjI4ps8i8LZJRS7URTOGR6JNWBwmAmrXj2Dhbz0ROCg5YyOVvL8rC0LhqFDGUmTh0EIjfpMr6eAzwZSMXNZDEMIcCRh89ykKsbIi4vb7vd5j+96B7kOumIoI5AuwQl8BoJrEhKBAhIzrvo3Aqzi5l+6/qAHJiwMlXbVQZt3wAlJOz9FSa1LbSyPmN73TX8r6nyTj0xA36lUQNKeFFkMiHPdT5ZXPUlHPk2KJGKIQdE+yGB4QHp3xIoloj8fsCxRPj3ApIlom3I90PI1vOTw8cllybD2lytW0zzZVK+PXwtCH0AVwKibHS7i2Cwm0nIebZvDGxkzE6EK42CVkQOoQsRLHQfbADtB7YqUsH+y7T99eAiFQ72a1enT/DLW6lEPDJcooaCVE5gIQOO15JQJNdGMM8SYxRNILp2w3PgifYa2+Ep2Ovt2w3GoAcNTz6j55bWg6ZC50rCelYtYTKlhHhArNgUfPCmu9XbGL7Z4Lz3z421zdeDrSFfX+9uvd6i+ho2up4O3Bi+WHh+EUoYmUAsQssofweHAJCD70kBEg5LEFTt43tAPJ7g/zOwy9NOzQz6MixNLWiCd3aP2cYmy7galfScj+acoOLz0+X5goyPjITYX6aKUGWOhW9v/23//PAMnpzs//t8/xT+Ql4LrXofMyjFsARVIRbG+oY0DgbccMusyMAdIm2zV4HrKzCIK1snlP6TnVgsl6EqwYogfcmKOmuPV/VUSnwdZy9kW7RbbIDPIMuTMYCnhQWwhUj+qp8konDxYfDkKzYWPBXmZZsBYkqPKB6NLayfACOERUxdz2BYQir7vkSXUPW0k4lo7sXMlc3dmMHIYX1TMDlA88fjpJ+4EpQjM+tZOI2WoGLYH5EGzzW1O6s5jVw6UQ6rJI5IE3CjMeBhLLLQO1gW4Ai3ywLwqIpuilh1dCS4C3C85zS9S3hpn5B3xxnAT0ymTV9ci5B8FsuERyPajWqbAiLBSzSbFgeq6XZViQ/dpMjSVe6ucneVu0/M3fmXJ2EECm+p9VkyB52rcAqDxXOh9TEUPUpXRzW/+0bMb2SLgUNCi/Trh7Nw0AP04rbAE5Wv2B/5Ur6gfH+6H/75ANuP6WY19gIVJD96C4aARCLdJr1nGpOjvKvWF6W91WYgIUDVkhYRUNOwiS4ZB5eZUinUhNsWS7Ww6ifHxhzwkUNGWOsREKWqNPY9+qqTXHWSq2q0qkY/TDVadZKr3F3l7t8zd7/YSU61omwJfZIt8xy/F6BIC+/RWs6AgFWH8WyacrRV890KMmPTHitqdg7RoLc2WBtuJmIj5Rvpm/WtYS950+OvN9c21wYbvc2oXusvZnk8TbJmTtX22+8juRiauGvo40oFwWWd1mnz+A/ca8QQYQ2hZ9o3g8/BpVfT3rG3tdg7nmnN3nE1qTok2+gh1cxHiGlAmyOtqWiBgLMR4KJiAFUS9MJQkrkALgaChmUyl5S8aAXwNZO4P3Rgik+UKsimUqRKshI0JCTINHbNGgJLgpFiiD0fcKAOdgTo/BW703x2+PvsTp6doMWHaDHbv02EwESfdu6vl53vHoDyBjHi1G/wAwe9ftrhCgIABgKPWdO+c9Wfr/rzVY1f1fgfo8av+vNV7q5y9++Zu/9Hfx66oYf7cyB4cn8OtO0um/ZSb+liyvdu0ylVggYU3kwnSWnouLnqwamvgFBChQptCUQ4XhiKOtVNG7w14bt9r0dpMng9dq6w253OHWwPbMt9mxeyDagFO+QmSt/gXYrO9foSsMFbAT6xwgUbPGTGK5JeSJucaiTGrQc5EuBd7G/4QIRWVza+yL+6MzTRJcAasWkxiPEQQ/QY1CxggPjJEnWbYmbBRrDt3GT3j9nz2/qX7PBMHrBjmfu+KAvoGV4zaZqH6l/N7oKdYqftpS/cCJtVD5zOegvCjpCsx3YENzAG+C8sXvz64ewlG2F/SfldWmxthcSBADLkGEKE8KtfHd7jIiopRpejMSneb3w9gvnChhkYzC7VqRDs4iA44T0A+wkgMbkUFwlKflx19aLamVRciwxrXrtxiacjU9UBD3V4Y91Lqm80CNTuyrQvVcz2JMKOxDqNNMFEmuvYRVHZxWt2PVeJf1TcYs8tJm725ZwW3rUXib9uk0DSIgueWfLWs4V7fnGNH05N8AS5zuuAngh6NL/USqpde7YeDX4x8mvqcak+jCUUz+Yy5rGKWah9WcoOWDLW2oqfGcPQwTS4GJWQRc9W6waFxpQRca9bUyn2ImMZQytI+h1CYigfTHyApZg6EQ1Nmkp9Sn6knYWc/wiDcso+NmymxxdQMZEy1Yl9ts4oMEaBsccAG/T3BQkDC3IbbSAc8AGwO9t/QoKgaA3zPK+lqE7sO7QGS0MCqhIXW2z7D9szgAt/MXqB1FMagGDspKdf8+E99sALq1LDWdUZwLwHF/Wlm3BzfvP6Ts+gsED+1exFi/uzo5IjlU2+Nko/gCR/Hdz9kxBvhTQ/ItKE3hbDjcSGIaAe5L5bWzy4w5PlsYB/4S1lKjXRMKL4K/vYw9TZFBl3GNOU08lYChr5C8Eddn4tjCudUx5Cu4vJD4MdMRrRRXoDCnMY0mQG/NrsA8xUKgEX4zyFlySA6ycdBqtT8PIx/Yhor9o4aKDyvFT4wyBQoswZh/B4ZHdTaZPSgxCMV0pUlmlq46arqozEsEFXtGmyMLk9GuLZMIydtU18RBbsoQ0Hw+DI2a3/aGbIicgoypCu2X4/xhsiJx6LrKDfgIBaMJ/VJLw7OFvgCMyUBbtgctZm1AmLbAdpgQmOOj4Y1tswx9EvCmA2gvGzxtf/+GL+Z1zz4XQ3Owz/E34LFmoHNv2dAk+n0JTSDyF+zLuIZmMeDA5jHAHh4d0dnlrgzHOPj2Fax5H44mo20uAnYOZPL2gu/Cxwag7H5fHZhOpfGI+X/tYMBy2/yB+K1MgXvjbAqWY6qB4f4fFQNAg/ccv9zI2MiW9r9qdXkj9QSsMfSHR//z8tfJp+ +sidebar_class_name: "post api-method" +info_path: docs/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 branding item' (create-branding-item)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create a branding item

+ + + + + +This API endpoint creates a branding item. +A token with API, ORG_ADMIN authority is required to call this API. + +## Request + +

Body

required
+ +Branding item created + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/create-campaign-filter.api.mdx b/docs/api/v3/create-campaign-filter.api.mdx new file mode 100644 index 000000000..937bb038c --- /dev/null +++ b/docs/api/v3/create-campaign-filter.api.mdx @@ -0,0 +1,91 @@ +--- +id: create-campaign-filter +sidebar_label: Create a Campaign Filter +hide_title: true +hide_table_of_contents: true +api: eJztXGtz27gV/SsY9sNuMnr4lTj2l44iy6l2HMuV5E07jseBSEjChgJVgoyjevzfey4AviT50Wym3c1wdicRyYuL+zz3AiRy50VLEfNERqofeMeeHwueiC5fLLmcqVMZJiL2Gl7CZ9o7vvK6Ik7kVPpmAMvImKXT3nXDC4T2Y7mk52DXNewYZ36VlE24FgEDj6m9DkTCZagZVwHDeNySvIWJtfBTXK4w+Z13qUXcjVQiviadNJmTQDJQxxnvpuV1bHXwru8hTiz+lQqdvI0CsLgzlzIW0DSJU9HwfOKmEnrEl8vQKdb+TZP0d57252LB6VeyWgroE01+E37ibai5pt2J1QZ0y5jsm0ihiYsMSrx0Eks12+DVh1mmLJmLwmbTzA3iK26FNFgcTY/47v7R4eTNwd40eMVfv8KPnTeHOwc7wT73vfuGp/hCPD3feC41w/9rs/2kGY1vVWbtBzAWvME6CZhNUrh2TXWat8L/26cv0VWl6FZJWRIx38TligU84UVs6aXwEa24cG5YkWk3lWiR1NGtgvjPkFcwQ2q9BMmtFC02thciDEgfnibRAtHk8zBcsWW0TEMEZcB4wkx8Uv4kciHYrUzm1t1pHEMyliLKqwqPEEwXkcSzUbpcRjEFoErDkE/oMUUy5F9EgfH2prj0pE1akcjWTQ12OxexYDIhWcko592zy1F/cM6imPX+kV3QqFbpoeFyK8OQSeWHaSCM5MbqUrGZUIQl0DL3JuOawfIlV4AuS3AnBUiqM9oZxNdihidmeWwSY0qVLggtckVwL5+SUKsU4jkJbJrxOJM6KYUGj2O+2ogMIiJTlifGr4Xehh9VXLBPN0Mvk7s7eH8xGPXHPdwbDs7or/5J73zcH/+z9POmMx4P+28vDZm5ddZ7j79x1el2e6PRzcVwcNo3w0eDy2G3Z58MLi3Nu3fD3rvOuHdyUx3cP/+1c9Y/uen2huP+ab/z9qx34ybfAPyxCzMT0M4Q5A26LhJFsE+5Sp+yNPY5nAY85iBfpGEi4RD3TBMLPO6cn7QHQxaL0CSQnsvlGkBtMwWS3eKGk4dkNBmfVT4D/2E4mJoq85ATen+/7JyNcON8ML7JL7qD83Gnf04/R+POcDy6+dAf/8044CT/Dbnx52DoNShtN4w2yAQh0OJZGPu5ASsq5jNnauWjodPdOi5c3+extnoeuBVJ9Fms2DSOFsZ5mWMraZULFUi9DPnqnCrOFmz6wsP0WaVIMEPKpkCh5GlhutsM1AlDuUWK+0ap+l9ZSUq2yYQshwUZL+dbRMbWICuMvGYMp7unc+guxV05fJSYAdWGQiP2veMpDzUaFD3HmK6M/VQWN2PhR3HQncsweM8T9Cg6f0QdBineMPPFQmtLEfQtEjkyn8ai2lhiRMmadZSVveyerEK6SnNdyqtKt5j1Pvf3lqleIlEtzO3t7GxWKNsiBkynvg9xp5BnRcFVt2Z1a1a3ZnVrVrdmdWtWt2Z1a1a3Zt+5NTvY2o3BQShmvTiGm5tsKJI0VoTaFjfcdhqbRMGKypNUsKEMfle/VsVbuxHYdRXz8aA8lUo0ZzFQCRIKI7KPgdRSfJEBRqC+opJalhn0GbpqisASrV32lgfQ1+rXdcrATEnM/c/g1X9Gg3ipJMazbAiTQZ4uW6YVh4JPXu8c7R1MXx9wvvfmYPfw1eRoyvf3d45eHR3R7AuECZ+VS9EDJe4dlV4AUxihrZH/hkGoetMGKwQwkz+/5hkezwQFS5ur6eRltEfbAGC+7V6wg0MWcjVLzX0+WzOCal6OtgGTZTyI5Uxu7VUz7D/pnXYuz6gYDoG/vdH4ASTvKERrQGEZmQZxHt0aiZ0Ct2hUtAhhDhG02EvH9SUU4kqXCaW90isNYyK2phyggBFu9i0jyqwLoMxSybcb2uxn2RKtBpvQvQUBQ9EsE/nLDpZHy6R55iz5ks0FD0T8osU6QSBJSR5aiNYYvwIjxoPANlymxKdIZdvTRmnCVIQGeG0NUZiy6o0CT87KTqHkgORPx0nHT1IIZ9QsZ2EeLU5E5x/IbC1XlW5cMpox6QoNiZ+18YBdYC+QCbrJRDMHR+QuDeBRGV2OWASBmVoG7t5bYU6SyDzzeaqfkXcXIeCnaVTLH3wRLvk0LYAsGhlvZG5yiISHpoOmwY4qd1eW+HbZUudunbt17j4zd9cfDt0elHtqWp/dzdbnUvEU9o1N8dxofWITPSpiGZFdFVhHNmhp7lqkXz6MkdifhSJ68XVJfdt37I9sKd8QvpP7w96fUPuRO6viCxLQ2NFqMAUSieDYyF1IbAxlTbW/OdtpFE8kAlRtaRFpj4StopRxmCxOlSJJuG6wIBJa/ZSwOQc+crPZZxGQZlVBc0nbKHUnWXeSdTWqq9GPU43qTrLO3Tp3/5y5+2gnmUtlssX1STpdLHi8spHmnpO2nIGAZW9DWZ5y+fZruVshZizvsbxq5+BN9nYnu9NDXxwE/CB4vX803fNf7/FXh7uHu5ODvUOvXOuvijzOk6yaUyV/Wz/arWYRf0EflyoEl06iKKhu/8G8sZgSrBH05H0zbA6TXue9497RltdeUcTec7XKOiRd6SFVYSPCNNAuiDbOaOllA5sBFxW9VpKRfSNLL+uajN48sVAupEle0gJ841WzM6V3GDZRsiDLZ3Evy7RBgjCirjlCYEkoKabU84GD6WBnQOfv2J06F/2uTp4NSeMz0pj1vvpCUKLnnfurbfu7fQgfE0aMrIMf2Oi1qx2uEABYEFjMyvvOuj+v+/O6xtc1/seo8XV/Xudunbt/ztz9L/pz1w093J+D4Nn9OWhbOyzvpU4puP7nbbpJFSeBCW8W+eZDtaDowU1fgVAigZaRNiDC6eSM1147NUNfRNqm34qTxiGo5kmy1Mft9h28BO/ct/hStqT7Sk9Fty0/WrS/7G/BHPvpIMULUCtIfbPX3Lnou5VFy9g2lhS+FuvMBNbSRhsKVFjc7Ao/yp8+iCAXrqIU6GbYNOhbNRdK5jbEXGIdkX85SZbZ0BG6Xcbh/VP6/Lr/mB6WyQN6bDPfo3OBnkHKNfVI/OvibNSIGm47+8YJqaKI0CJtb2OyAZHtsbeCx+ZzTXpv8fMvH8YvSt/ypZo6XCFpXYBEuUCIGBjrZHv4NMhUljhKZ/aLyU7lLQmlDZuGUJh9VCMh2FX2pec58H0IQDYmpUHCYACNuv4580wgvoiQSl+rsCQFngxUGxZq88q4F6bMmfWAVPi5MHdbH1WTnUhCH/o8zdA4Fc3yjl0tM714Sa9vFeIvGbem5dY03PSLNSmsaa98+9WNj9wlFjzUxlrfPLnl1yzxo8UT7hDXdRnIEk6O6rstP/PaN8tR4dckflU5PqoPc4kaWh3GLGQxjRIYBqzP/HkUafFXxih0KA2uZimy6JvFuqVJmyYjmns7JZGadsqmbKIjNPKdITGUDSY+oYpsGpIIvZoKbEp+Mp5Fzn8yhxc/VXQ2t69QOIkyiHz9zTLThE2asGkxQDv53cFJCIvcJh0MDtgA6Bb+N0jgBC1hnuW1FdUN+7YZQ6XBh6iGi14e24vjAuDcL2YeEHVOAwimhjp/24dr5nhRcaoYK9sKWLfgprxhhJq4Zjcrb74VRXXyj6YvadwpdkwGKlx9b5R+AEn+OLj7f0K8Gml+RKRxLS7tPA6Lg969bDFiT/U8fSAnO4/znEM0D54v+n4nXvIDL1tPl9jDJJXzEtWzED/219AYCXAxQeZWfmVIs7355m6tNudU8CeeGlw2KyesS4szPmU2sEpCCGYQHCIIs8+zFHAo+vxGdoLI+pKgHqt5w2hmDrPFCE+OlbkMwa/FPmAhrXwkFC2i6csYcP0tcqvpwsUnWZqiXV4sUkVRASHSBR1MeiqX4Uo/tSUHa2olMs0i07TnozL8JZAgU7TMcjJe6MGUXghIX5RS9om5kLHavQ2AIckjLosKRYbZaRDQVRdbT/EGTjTnIlzSMh71Eq2zKM3wvj/e4AhmSkMvX7SieNZ2g3SbaOmcA5S3wbDfwuKdbtGCeMFViW/+z1U8kfV3xTuQ3/9PXLhkpTVbe0l7jCRbateQdrF+5W0s1rH8m0cm2727O5qJVq73dBswSPsbV9fFwpSuwNNuRRmA+Cwo/927j+bYHrjIAGDjpQ6tle0Iu731KO11acvhYkAbfd7E/esbDrpifoub9Oex9xH/GaSxYQIic//Oy/YiQWP5Zu3itm7J/SA17+//A6Ey518= +sidebar_class_name: "post api-method" +info_path: docs/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 Filter' (create-campaign-filter)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create a Campaign Filter

+ + + + + +Create a campaign Filter based on filter details and criteria. + +## Request + +

Body

required
    criteriaList object[]
    + +List of criteria. + +
  • Array [
  • ]
+ +Created successfully. + +
Schema
    criteriaList object[]
    + +List of criteria. + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/create-campaign-template.api.mdx b/docs/api/v3/create-campaign-template.api.mdx new file mode 100644 index 000000000..f896ceaa9 --- /dev/null +++ b/docs/api/v3/create-campaign-template.api.mdx @@ -0,0 +1,179 @@ +--- +id: create-campaign-template +sidebar_label: Create a Campaign Template +hide_title: true +hide_table_of_contents: true +api: eJztXet327aS/1dwtB+S9Fiy3g/fD1vVVnp117Fy/WhO6+QkEAnZbChSy0dcr4//950ZACT40MtOtmmX5/a2FonHAJj5zWAwGD7U/JUIeOT43tSuHdWsQPBIHPPlijs33qVYrlz4XTuoRfwmrB1d145FEDkLx6IqTBcMax8OarYIrcBZ4Qto6ZhaYpxZqgzTrbE5D4XNoLp+1YAOQmHFgRPdQycPtatQBMe+F4k/onEc3WLHju0d6fL1SDV1JOmtfXiE/gPx37EIo598Gxp5oJ9OIGBUURCLg5qF7XkRvuKrlauGcPh7iOQ+1ELrViw5/hXdrwQMwJ//LqyoVhhXfjhQYhXgLEaOCLG+YxuthFHgeDeFVqYw/gWLbkU6PVHanvgDHrpYvW2NmoPRvD1o8na/z/vNFv41GMzno36z2RzWHg9qHl+K7T1e3jph0seLkGGtBvsnh798NhccK+Ga3AgPGQIWSFMWvqDCYSND2Rvu8RsRsOJ8POa63pcy4+3OBBp1cnQmXLfwA5pw7nkxd9lS0Z/yINAt2WmH9SPuRgmwsWlYyjK2gDL2zHPvNQcCBUsODFjDSvXIWebWutlu1puderN32W4fdbtHzWaj0+/+hoQtfRukbhfK3lBJ6xtT12sfNUeNUX9E1KHs2LGbIW/u+67gXklHOUnwbKRWhMxBgQBWKEgEuwUmmAvhsaSjzBovuBtSuwseu5H6DWT5d8Ap52KxXagvgS+otJRKgx8PgF9s4pvkfcJ2BisuAn+Zrci+OBzQT1PcYMTmsIauzeAPHkc+TDcM3XXv2cpfxS41xCNmad7CNWB3TnQrgSIOAsAvFgM2Np4JOjSWPNC0hs1hvz/o2x3RBKDpDwb9Vsue26Ldbi5wmWXrxV6EFy8Roqcnk7PL6eWvRWVwCTXW953U2xnMzqDU+vbeOGEES6UQClsFZHfc7c1OsNj6dpdBQ6HGj+phw/KXtcdHQjxuu44nTmKpTXeBPSFXGFbR8W1mx4Rwd7eOdZvVDOGtHwPXzOGRj70CnxwwKa7EMsBNHptezOpDWDamKWiwd7cgMlmm1BwbGor5INMbAbAcC/Ce62K3JvsRpKzcOJQt20lvrwFf1bQcoCyrrpCRfYtqk86XONKCf5RkJVJxBwN5X3vbfve+xl5Gdz67E+Jz+EqSF4gQZBsnqJRQPUG69VYPmiilutWFH/fhq6yWgF4J/1XbZYgROREV1VgKj0B2ZwsyWNYVvnCdJTNqpEbJtWT1LFcoGfuwm3RvAdaCibGTZTFaWHOwLAamMBYZN+FNaUZMFWrK8SO+rXgQYf/cQNJwJSwHVK9iXVxMssRE+A8WCslmnw4LRl54+ODYj4eadT8x4dkr38FV9a14CcsruQwVvC0iEGEyAQootdZ0eYLFYsxAxlz5HiciHfjkiwjufZAXTwgbBBjtKpCsL464A+Gc32PHTqBNo5oBa2VzUmowrJ8okFcFX2SZqIYbTCpGEtBlHEZIkuPRFCziKA7olx/YsF5AL7ci5wsWNfka2oB5v/djFgX3mVLG7oP0KE8hA2XDBySAtnV/Kx5GB9QOAV8gLOF8wUa6zSYTQQAlAYZWYGKKRqlt1Opdtppgth01W41ur//bJqVZogyUkkyHdaxhDfZBsNawRpmZaRi69834bPzz5ByeXMyuzo8nH2fvzuTPyfj8+J/wx/nsdPLxePbm7exiejmdnSHKGDKh6mtleean27yJx+frjLucAqWSIaMmwG43torS/DbMu1reYstbdEAKWknn4ov/WYxd17/biQYqKQ0s5G2o+7S+Yfn9JQiVTfSH+0/CdDwt9txgY8sSqwikDzCbiS+goh0J01geYN+OATgWYAIS7wOULBaEK/gaVXkceKhJF1TJ29UaJY52lK3NaIxokqL4AxB94W6sylCjBAuqJyfpGogFFS/nIdlO+cFNkSvXTi4OGjcMgFRxuB/QIn4obS6rN0pUoBaHt5Ozk+nZz8j/l8DXJ/DH8fjseHIqH46PL6e/jC+NHxMsAcJxOlFP1Q+qOjk/n6EsoSRB0ZOs6Kj6aD74QB/Z8Rf7DDBXK6+2GwxHyEy5Nlbd4rRcV17aDPCYl3nArIzXJsFEH9t1PMuNgapsDceGiXbQ/mAvoTX18x7ZIM6UWzAnog2ah7hr+bEHvA2dAFkggrd+4KBWAhgN/TiwxCsTtI5n5+eT07Gc5Ksz42dmgo3nm/foO21py9xUtrTEN9pLev/bwf1vq3fU6jRgfyQx3o+4m/GMmUsPClrc0FYioQceddrlSgCbYjA/c7XZzLQqJc2EkzIZ0DS3mk1iSrVn+DoEGqTphp9JJOK8Cy2YJPEg4PdFaGcubO2wb9LGIe0g7njgwfLjfoQjJ6LGhv3GUm6oy/p2ABXDMhM/a3S7gHelm0bNvhoW3o3Pz+A/07PXs+LW90SAGhQhMRa1qLlsKcIQzKysgUYtwoS4vsVd538KS6XnZdchYDM7mh+ybILrijyGPtgDsIF+On7LugPmcu8mpuf8JmsECa9+dQFPvNh1UUUkYC8bngXOjVNqW+vpPJm8Hl+dXqKpMvn31eQC/sK2CjOKcCQVmU98eOvfydmVA8BtZChcmA5Ewh9Uqz/AgLgXmgUd+Su8D2EymVJZUEP1XlLDbForWdSU5HdmlnRYs5dOQzQOAJThGUgT7OYThzcW/0EaAPVTNZM/sFvgTxG8Ati2bQcHqTVyCPXvEd25XTD+yKD144isLCtnkKZTmV2NdGN6ai4KQhhQvp1PxlaEvlMapmJjaRdrblEkakPDVjOXc8kak0ZTeg87F0v7wki5gAk0h7E5UciU3x6XKwS70tPlHA/myAEBR/eLHtYEqXkjiTmJfOmbye/cx4g2+OrxYJsAbfK7PkHbvFHN7atu2s2jVrvRH0hncJmZUZkVzzQrFo4bgQ7c6io+AY0XLGEHGSpXHUFx4ipTw7aLSpCsbYUy6VzJbmn8oRx3lPETu2IBogCo+/lpPl/sdHqCa38H6pEseL3PTLueC3RBIAFZQW0u5mLY71hN+H/XGg55p7ewB4vWQMCf9qK3x/7WcACrmTbWa/zm7Xj689nH19PTS9q0nl+dTnKLlSvzJFdx2rNxPAQg9Fo+J7AIY9jeR8e09YvC88Rft3XbZzCGQ8YRNYA8K5uULg7rFmAf3a+BxEBsPLNjyplHesNEXD5Dl7RGsam38Lez6xvlUkECpFzmjx1xZYAHTBwosprsf2pvt9HIlFBWmqylHU1Z0RAZ8zBvz6jFfDRm4no7O36QKyh4YN1+q2kid0pxgvZ380gy0x4CsQpECDyjpDB/qIIb1ePJxUV+80nP9vVgntCvuVBe/BwtDTb1lMMJzcEQDC0ECJwQ0NrBPUGFPBlb+WHozF1yHRp7AwPntcF0yL9wh2yRLMhcyL6TI0qTUHLDkHtyB2SeLqRjFRXsgRxXol9gFDc+gJ/HPUuwm8CPV5nTDd0LjRfMi61bGkJzLp1S7ORyRssqxVqvGM3Pz7NfJudn6Hr4+PP57OrtczhHE/kiTHo0OSXfFW5JjBO58vO2XXWI0ff0JOf9lEeHvf7Q6rVHFh4dDi2L9xejptXqtDr7xChkOqKzhUxX72DJHL5k8F8M2yBxJ47cre3QgolPdjjZtTQcxbj8yCwmFyfuMOklV3KAK2wUyuxAwQhVtkFpXTS/CAc+0c9PyKKfNL8C0H5KvOGASZslRtKSkxujqR321bZDNrcGbnNMvgbuEiHQQ8jQjQNRY8oNYT3KL/kfU/my1Ww290X9g5qc72MQ1SjgjreDL+F1HMBaoEffji21P5f8kQ/MgVUTf+AMIAaaBiztANct3yvJDbaPGzTJFDR5ktKy2VizBdl26k6yfDp5A/9NdMTHt+czMJQmyu2//kB+TNRkfRBGe8RHJfuLMnUpA8n8QGrJ08kxGNbGOdw6z0WppsfDSW63+aDJLTGwe3Q4aS3abYuPms1Wk9Zcd7hpcsanp3QGIskpzsMVGt3A4rY23sBMFsQX6/khPY6XvKOUpPYLwIQxqURyUquJeHzMngMT7cZwPqQ71nGOrYuiUtoYzk4AVipYsaCfyaWwnzk0Wyk3BGy+F85NrM/xZYAVjRfbJxeg6iDdOxZVXKXDKx2+UYcjM+2iqBK+1IoKK27VUYBPvlJUqqNPtK6JlpJONgCzfyCQecIhBEA+gGcHxEuyIx6k25idty07gVkglsJ2UP53DFjDM3PTFYGHnbIJCh3j4efUKcHBRr/xCOka7LxQDEelTlVIdgQH60IdndogjCHJvqesmfzujaSIlIArbrjL0pEkm6YXmltfpOF01q0fCsMDpE0Fzs4RWcb2ks792Sy4kT92l7rt8WinROl5SumlxODnyZf0s0go0i0XxGwzK+wlZp7h2sj2uPa0pZZO7jo9BKP9sLtZnUik2kJKWxQEUurOXECnjxGRIpXcbyudBYv53zSmZ+6V1yq+5++a5TC2bZhpCQ3Vzk5Myz+3qFlc+ZC4ksJ3MI2zYHXLvYlH5ga5q/Y4gtPOnRweSLMXnfZgsLD379/XfOqFCaMbfMxemk+S4wwuHdcYZkMGtwzWstk4gtWZx5F4RX5osVwBaBAtThJBnKFDOY9Lem+ws9iIhqB6wDqK0WLvs+ffeWUVC2N9mfmFZxkaR+cCeEDxvw7mwPcOLuKSvDyvnnE2uV+4r1yqvZFoG75Kl2H55iIrfrLgk3y2JbRf0CMZ0VWySvJkB+xkDN3xg3vly1Wu3KW6A7JN5g3VKjcEiUfXdN2qWDupI0Mdw5s9F5HWEHDdr35M5yqqctqiNliThg6U+q2TXjUeQ0HPTx802E/3+kzhIEsh7jrLqTTtTdgffTyZHE8vprOzCzp5/WX2X5OPs7PTXzPPz2bGz4whmnkDE1/kBhQBskRufdc2/Z3qqMeTB2c4Va7zWaq1A9OdwURkNQrIVho+q4NDjBsTRlTvh+JZoHlrRQ2KBEwHj5ccrTlaykMjqFPBnjw1i9WuUkdkFS6bhFmfk54f8hwBEwl5VkBN4im1joVmfBHJrakTpNcE7OSagrb3cGps9r72YIY/P+qAeLB7kCEJgRs3DSiXxC/2C2UIpOgwGqdCim8tW6hER0iWp0ANFXL6Qns+CmGm8vQjHz1PEdnZgOzdOpePi/0arog0VrJw6Fc8ikKkrQnASs5FfzTstcVwIYZz9D11h6IH4NkbWJvDJiWyl8Qyqui4dZGG6vVGICvI34Eydr4S5yqzTq3dZv6VTlME7fcwppUfwNwClxm+UIl0VgDmDwFe6k0rY7NzagMBVfpBnsZvMBppIOvGZMDHvmynTMg9uW5T74rlkgDdr8mMG8/A1JlRYuPXfpTEvsShHrGX5uq9elViVyQuUFLB6dj43HHpxfclD9JcoMPTryUVskl5JexpoI57niVYybc7gbpmcE/3XSYv4xOmxrqDoEBBBhXS1sqEofVmjTBs7GYHCM4FqX9V1l9/VG6cYl9rl1d30BzYYs7JAh7ZXWipK3q9/og2S9+MiYsxPNmwlX2Z/Dzr7v1KfL7ByftnGDCFne8mS2Zt4VKTZk3p7bqG5ijFe9q/HeiTvsSXnbhE91U7u9KlZA6VKkq29K6k8la4/LH1gGCdQ9KIRyCRVGI06PN522r2Os0W/NVf9Hv2wu5xzslu/050gdwY6js8ZOe3m82irOig8DCmRV3ErnuPk1mlEKhSCFQpBKoUAlUKgSqFQJVCoEohkFnaKoVAlUKgSiFQpRCoUghUKQSqFAJVCoEqhcB3e9evSiFQpRCoUghUKQSqFAJVCoEqhUCVQqBKIVClENjRVVylEKhSCFQpBKoUAtX1w7/R9cMqhUCVQqBKIVClECidnCqFQJVCoNLh370Or1IIVCkEqhQCVQqBKoVAlUKgSiFQpRCoUghUKQS+mxQCyW0zeYtxYM+FNRrZ3VGnO7KGo15rbg+7i96QN3utdrN2sPauexK5gqd77XpzWG+2L1ujo1b/qNtu9Dvt30y6j/Do9tvczm918WTMvB6hAuRrYbzC+8A/AipG+Kih7bPQ9z2Kdk829Pm7ZANhtXttbs3tbrvb63WHc/htA6J0ukNrPuilE3MBDb+luNUL2V3uDom+ZWkEYydTJyclP0lf7QpqQiOdC+kV1OdD60+HJHivPaWRVJYdTMg3GzfrsogOkZG/SiOO5Ku18T6KiM3qXxZykpl9ft6GNIRYkZ7P46CDAeXrv8yl3TRTQxYg5gPR7/ZGQti9dnfAreF8NOS9hbCHrYVoDxYpj61PkZBHikG9PSSkGB11m41mp/dcpNgzr0IFGLsBhtpnfEO8KOaB2D+/Q3qoNk0mJHXRyd+7ZpfIHDMopCr64q+3eiS/B5DLn6t8xXQha0AwCc7/q2JgLjtHDglHi25rbvVHYsC77VFrPrJFs99pdkZ9u9lp2qnwlCS/KDeWOoB/R51+Y9gb7AeBu2fMqFBuK8oZq/58rHtKZo+/sCW1Nc/LE2yp3JWfvyiYlGRBeSqeJBCOi6N8ydj818GVDa0XUUU28DcEFSUEf8KGaPf8Js+cp+1mUnJwdV2bt3p2vzlaWD1r2O1058M+GP29XrvT6i1sPlyg90FZVSVMhY8e/2xs2sjYe0pADqJKctjsClOKRb8TnJLOxW5p5hnXwUB1ikFndcD39AadeU9g7tsU8JwEsD8jN03WKywv/R779g4+1tewRvUbNNCBQhnEb0FFvIH4xSHP+xId2LLJTLB/9jQCZqLRYj9xm52r8R2rwaAHOeDWZ2hruoO7+spzoD7TVZiT3jEs6VYMBJ+DuLW7i36X8/aw2xr0QEHwTqc56o1GFCkh7wFsP9T4GW9OOhZTt24o4xMP1aVV6nz3cJ3qyk115eb/+ZUbNCficAe5e+sC/NRpaMmLL0IJH+2nJRrRauhlUoikNttUWZVKlksLvrxGUcluJbuV7O5/XY5enquEF+otmT6toulz5albWag8C6aPTGSAN7lUIXnaJxeSDjWVifSvd5cg2J8xLihk4o+Vvh3zlewjqcoLxI+T9ZDP5zpsQ6v+dC2QQJpHldQCkEjYR0R3SnEttRI7xd5e+8HcAQb1SkxEzO1FCUjojDn2PHLchgfM9kXovcgGlxMCYq+eXac0MJUlWVmSlTaqtNHfRxtVlmQlu5Xs/jVld6MlmQ22UnZSGC+XnE6dMcBTvpep86BAknqNJSKXnA6Y1go2xhIbq5a1HGrzdmveWgws0bV51+53Rou21W/z3qA1aM277UHN1PXXqRwnQpaVKWO95TrKa4YiwNuDsQfMFUa+b2fdfzEG5i0Q1iggWtvNMOcwpR8S27E9Ksnr4PsYlHSvLaQwY0N66RwhpkHZJZYNdFkowNmNgynHVM5RZCXMRFFnlDHedZYOCS+OAtoN7utjyvkuBUUzWdJLkuMBkcD10Wr2gbGcKAl/De7Jgr3hMn7/K1mnOnXOcyx5do4jPsURs8kflhAo6Inl3ivz72J4d4AYcSEXeI2jV+52uAcMABsCiVmJ3VnZ55V9Xun4Ssf/PXR8ZZ9XslvJ7l9Tdvewz5U1tN4+hwI72+dQttFkiS31mtIe/V+b6SQqigKZkUvnqE9tcLIrgJWQoJUfEojw6BZ+laTmxngGsgolQXGAET63UbQKjw4PH2CdYH0eG3zlJFE+nn+HQT6HXzolqIPhAVLCVEZg9DaP307V3kJ+BClwKNEwcSd1IOdaJZKqhTDn5Bfe2L6+RHqPEZKymQO8uKuYiR5jsAnsJJLr3DJzXm6MMLarwH3cNp5fOpvGIRtZM46y6dvYF5RnQGVueOqWUihgwaGhCzS5Ze9XQNWxBKtxHN2aagS3acWEqDMs1mY/CR5QfnI8uXj5r3eXr4xkzHGINq6+tcreAosQkI21Fx8rkW4J/PhGfvphnDknQcFhCxcGzN57F0KwaxXlfX8GCH8OkExTipUEoQDW+vBSr4yNWUdR+TXSmUTGc2zvEGbokGfqvSJFRzsC42ZW471XZyeUJMbRGSD0Bx5wg8euV3pc3BjXU4n4D91aXbZWp9bCVzkq5NReWzLuxgLpxSa4G9JsPblz2V7daA+3T/AEW83TgDOh6Miebll61Z5MR6a9OraXpeO9944yEGarMQlaOk3JFG/a+6H4T8aQdVAMrm9ikKInk0VpD+skEfV20yCpLrusO3WwCYm+UxAMTzITn6NOJpPEB2vNs6VIfqKVBZlXl74zY6bH15gHAEravhU+mWbssI4d1iUGhIp+9ZkEIBZkG8dAOCAZ4Dhdf0ICRaiBebKtUlSn5g+pDqoGvAwvE+mtjuSPoxTgdFJIeoGlkzIAwWhSJ+d9eElUtYXqKTNZ2hmQn8Eiva4PWjE3b5LexBmFmvJ7Gy+OeJz6TPDW9NdG6TVI8v3g7p+EeBXS/B2RRhm56HtUHr2ffPt+orcjD8k3Ijd/grBwSbTsa3M5I23nj/JlQ+fNj1au/1RZWdi8JjH7abDky2Brv+1VflFo2+fNjS8+5b4Nst8XeMxw6vVfmSm5U/sNoqnlNnlbMHV65YjWamvyvoT24tUk88rR175ltFNSwafcv9yUzbQ0memaT7Kuz8SVTEw+kVZ6aXN7gsjcxc1dJqT8YmcyjmwaQie5zLUl9ZWZxs9IkbdDBrtvPJfGzY5dRrHHF3e35l3JLaPMWlS4JrYxC9CetxqAOM3dyiVkWjpyy148xgkp7x78G96qJGwgpNyK0o9Wms0g4qNhI7/QdesIcgCvBI8QYQ70JzEBB1eBj5ym7zDf0IWkALQWd+Ut5vsGeyeY8CyQafSu0be/fPa7r9xs6W2eE629ca6WsYepxoCIeIlf2tym4m0ntGJpiVq+5wk9Mp/28kktbZbRHVOYCsp6KYJlOFvgSaFjCUOTb+kLFHmojglhIg3Vkg7kHPGXLvsc5Hww29oG86F+K9wVfWEEyAIkNZXX9LLQIjTmqTuzfnBzqCqFh1gWGkF/l2SGTqPZIOZFTxnwntGu/MQO49vtgof0eDStZeVrpV5j00xQ8oa+m8MVnjYgMbH0JUm33XWtxG0HonuLvj14+/CADaMP69G4q3X9IXVRqYvs0i1N4PdZoKCqc9C6Snyk/J7FA170mska0tW9sewHw/34doZO/xreHKLzb+lJDTjeHsV/H9Xew//QWFqpa2AP8vlDTZ9LQJnfk3yLfM2+Sf2Bw3x8/F+C3tXr +sidebar_class_name: "post api-method" +info_path: docs/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 Template' (create-campaign-template)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create a Campaign Template

+ + + + + +Create a campaign Template based on campaign. + +## 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
    alerts object[]
    + +A list of errors and warnings that have accumulated. + +
  • Array [
    • localizations object[]
  • Array [
  • ]
  • ]
    • 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. + +
  • Array [
  • ]
    • 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 objectrequired
    + +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. + +
    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). + +
  • Array [
  • ]
+ +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
    alerts object[]
    + +A list of errors and warnings that have accumulated. + +
  • Array [
    • localizations object[]
  • Array [
  • ]
  • ]
    • 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. + +
  • Array [
  • ]
    • 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 objectrequired
    + +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. + +
    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). + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/create-campaign.api.mdx b/docs/api/v3/create-campaign.api.mdx new file mode 100644 index 000000000..fe32dda13 --- /dev/null +++ b/docs/api/v3/create-campaign.api.mdx @@ -0,0 +1,171 @@ +--- +id: create-campaign +sidebar_label: Create a campaign +hide_title: true +hide_table_of_contents: true +api: eJztPdty27iSv4LSPiSZkmTqLvk8bCmyktVZx8qR7UnNcVIJSEI2JxSp5cWON+V/3+4GSIIiZUnxTCaZZU0mkUig0Wj0DY1u6GvNX4uAR47vzezacc0KBI/EhK/W3Ln2avVaxK/D2vFVbSKCyFk6FjVlSYOw9qFes0VoBc4aXwCECUEIGWeeuGPl3didE92w6EYwx1v6wUq+XQf+rWMLGx7Su0D8TyzCiJm+fd8EVEJhxYET3QM6X2uXoQgmvheJL9E4jm4QRcf2ji01wrGcSO3DAyCoAL0EOLXjr/TVCQRMNwpiUa9ZCMaL8BVfr12F7NHvIc7nay20bsSK46fofi1ghr75u7AipI0TufhAIxd33fmSENzW+Nx1VkzrkWFzVfP4StTyBK1LQDALIM8aqSlCxMWxNYzCKHC8awLG7bnn3idTyy/NzGb+kkhrZeOLL/CZMGtbI2MwMtsDg7f7fd43WvhpMBgtLdMwjEHtoS4xhIHzgC80kAybNNkMB3JCJufP4NOaBxGOz1kkYERYnToL18JyuMskE0QwCUZLIMJ/sFAIwvXTUQK6kXQMj7469sPRtfCQd8UnJjx77TtexGzfilewmJKjACyzRcQdN2wmlNSolU39Dff4tQiydXnYoF2R1I9QQHv1YxIim/j0VgT3vidAWIUdsshnJgrerSPuQBDNexzYCdhK0keShduu44kymkjs4YkNyDQip8DNeUI9C5nlIyKEYwK4ydgFEgxhsFWMCkAkKmEZR3FA3/zAhvUCfLkVObfYVOdrgAF0v/djFgX3uVY8WyZSQjwdl2TDt/k9wE7GW/MwqhOcO8d1gTCWcG4RSNcwmAgCaBmIcO17ocjTtW20jYbRabR6Fy3j2IA/rWa31/83UlBSbR+OwhaIVjatiR+7NhIE9B6sdaYsJWUICS9eoTJ5Mz4bv54u4Mn5/HIxmX6cvzuTX6fjxeS/4MNifjr9OJm/eTs/n13M5meoZTSZUP0BY9B/jnvmZ5p86nHTFboKMn3fFdwrTEO2DBmBYJ4Gg5iSREPTRrZY8tgFFlpyNxQaOvQdUOFx5C/Erf9ZjF3Xv9sLB2oJFgm6Im9D328bG5bfX4FQ2YR/eDgRZuNZceQmG1uWWEcgfaCzmbgVHnOkmsb2oPbtGBTHEuwZ8T6okuWS9Aq+hq/w2BOo2qmTlwIOWaIXbLYM/JUcNlEdkqMdz8blAILgHJvsguwuKKJb7saqDQEltaBGctKhAdkAdA7RQc0MGDa4LnLlVuLipIG2IWiqODxM0aL+iIMAtByT3ZslJjARh7fTs5PZ2Wvk/wvg6xP4MBmfTaan8uF4cjH7dXyhfZliCxCO06l6qr5Q1+liMUdZQkmCpid50VH9H9C3APyQ3Pb5IRPc6LVptpsMZ8h0udZW3eK0XJdeBgZ4zMs9YFbOMUt1oo9wHc9yY8Aq3wNcMw+cGDBJ7DlAU1/vkQ3iXLslcyJ2w0OQdtC7lh97wNswCKAFInjjgw8Ho4IaDf04sMQLXWlN5ovF9HQsiXx5pn3NEVh7jkQmX28vh2gPCyUdWJvhy8f9JaXjjc5Fu33c6h23Os1+qyV1vB9xN+f86ksPBlqgOdXwgUeddrkRQFAM6GOCrKExyEGVkqarkzIZSHBuGQYxJRldYf8xCGqoJYCfiCTqeRcg6CjxIOD3RdXOXCckb4qsMSh5z2Z3PPBg+UHX3XDkRLTYFrhDsZSFkrEd0IphmYufd7pd0HduGZsl7JuohXfjxRn8Mzt7NS/ukE4EmEEREmMRxITLViIMwc3KO2gEEQji+hZ3nf8tLFVCl32ngGD2dD9k21SvK/QY7rnq4AO9nLxl3QFzuXcd03N+nXeChNe4PIcnXuy6aCJSZS8BzwPn2in1rRNynkxfjS9PL9BVmf7rcnoOnxBWgaKojqQh84kPb/w7SV05gTvQRaFwgRyoCX9RUH+BCXEv1Bs68lt4HwIxmTJZ0EONXtJDB50Y2WznaskNKnvuNEWzDkoZnoE0WTfM5CGabGklf5EOQONUUfIXdgP8KYIXoLZt28FJJhY5hP73qN25XXD+yKH144i8LGvDIc1ImV+NbGN6qi8KqjDAfDefjK0oBuRomoqNpV+ccItCMXE0bEW5PHYXGtGIpPewcwGXHVqCPSLjAi6QCXNzopCpDTsuVwh+pZe0czygkQMC/vCQTWuK2LyRyJxEPrx7KO7cx6ht8NVDfZcArXwbFNsfZm3eKHCHmpu2cdxqN/uD7r+3uRmVW/FEt2LpuBHYwBKVuqnPodkKdpAhu7txQLhJFUvfmbauNG27aATJ21ZaJqOVHJbmH8p5Uy9gEtj5wQdXLEEUQOt+bhaYszwqVOSE2Qmu/R2YR/Lgk31mNrQpMASBCOQF1ViaYtjvWAb837WGQ97pLe3BsjUQ8NFe9g7Y36oxSX9JSmvrNX7zdjx7ffbx1ez0gjati8vT6cZibbTRolOPj3zGVyUjZ7oIldAr+ZyURRjD9j6a0NYvChdpvG7ntk9jDIecIwKAPCtByhCHdQNqHwOmgdSBCDy3Y9pwj5INE3H5/A52eIkWm3lLfze7vlEhFURAymVeC0huAB7Q9UCR1eT4M3u3j0auhPLSZK8k0JQXDZFzDzf9GbWYDxolrnaz4we5goIH1s2fRSYKpxQJdHiYR6KZjRCIdSBC4BklhUo4ZifTs4vZxW+0UZ1Mz883N5/07NAI5gl9M8kvJcOaw6XJZp4KOKE7GIKjhQoCCQJWO7gnVVEn73vth6FjuhQ61PYGmp5PHKYjfssd8kXySuZcjp2eFuiIUhiGwpN7aObZUgZW0cDW5bxS+wKzuPZB+XncswS7Dvx4naps6cPJUWi+4F7s3NKQNucyKMVOLua0rFKskxUj+rye/zpdnGHo4ePrxfzy7VM4J0HyWZiOqHPK5lC4JUmYJ8cz6VMg7742RBt7drIR/bRGraEx7PWHVq89svpGCz5ZvL8cGVar0+rsr6s3BqKzhdxQ72DJHL5i8C+e15C4E0fuBzu0gPDpDie/llqgGJcfmUXn4jQcJqPkSg5whbVGuR0oOKHKNyjti+4X6YFP9PUTsuinhF9B0X5Ko+Ggkx6XGInLhtxooPbYV9sO+dyJ4tbn5CeKu0QIkink8MaJqDltTGG7ll/xLzP5smUYxqFav16T9J6AqEYBd7w9Ygmv4gDWAiP6dmyp/bnkjw0/GVdNfEEKoA7UHVjaAW5bvheSG2wfN2iSKYh4EtMyamzZgmzTD2kUAmX5dPoG/k1txMe3izk4SlMV9i9GJRJ/bEzY5GMQGjzio5L9RZm5lEfLfiCt5Ol0Ao61dg63LXJRaunxcJLbbT4wuCUGdo8OJ61lu23xkWG0DFrzZMDHiDM+PaUzEIlOkQ6X6HQDi9uJ8wZusiC+2M4P4U1yLCN5RxnJJC4ABGPSiGxIbYLEw0P+HJhw16bzIduxjjfYuigqpcCQOgF4qeDFgn2mkMJh7tB8rcIQsPleOtexzBmAJZbWEOeL8CkEqAbI9o5FE1fZ8MqGP2rDkZn2MVQpXyaGCjvutFGgn3xlqNRAn2hdUyslg2ygzP6BiswTDmkA5AN4VidekgPxINvG7L1t2UuZBWIlbAflfyGWu+VEnpnroQg87JQgUBgjHn7OghIcfPRrjzRdky0KzXBW6lSFZEdw8C7U0akNwhiS7HvKm9ncvZEUkRFwxTV3WTaTdNP0LOHWZ3LTQP1v/FBoEaDEVeBsgZplbK/o3J/Ng2v5ZX+pK2ydCmr/lDBdZJheSB38NPmScRapihLIBTF7nBUOEjNPC23kR9x62lLLiLvNDsFsP+zvVqcSqbaQ0hcFgZS2MyeLlJohfQYluX+udBY85n/RnJ64V95q+J6+a5bT2LVhpiXUTDs70T3/jUXN65UPaSgpfAdknAfrG+5NPXI3KFx1wBFcEtzZ0AfS7cWgPTgs7P379zWfRmFCGwYfs+f6k/Q4g8vANabZkMMtk7VsNo5gdcw4Ei8oDi1Wa1AahEty2BDm8VDB45LRm+ws1rIhqB+wjmK02Pvs+XdeWcfCXJ/nvuFZRqJHTQE8oPg/SebA9w4u4oqiPC+ecDa5j0rKEgDlUh2siXbpVxkyLN9c5MVPNvymmG0J7uf0SGZ0laySPNkBPxlTd/zgXsVyVSh3pZI/d8m8ZlrlhiCN6OqhW5VrJ20kWOSYRD5/LiK9IeC63/yYzlVU5wxi4rCmgOrK/DbIrmqPoaHnZw+a7OV9cqZQz2OIu85yLHV/E/ZHH0+mk9n5bH52Tievv87/e/pxfnb6W+752Vz7mnNEc2+A8B8y54c4VSVb4kc608QPkgvSPMwFEahE1UjK0Xm/ylx8lmygC9mKMoieZCvK87NWu9HuXRh9Sskzmt3+8N/ZhjTLmNue8KbSl0rS0NSbbUli6nXhUKl41IGSXDOsbn9ptvtW32wbo/6A93q91kCIkWG3euaoU9vFz5vLUFcmr4zsG+GjAt3L3h9A1zTh8Ocg66OnBSq6nnpDNTDhwbcshtRYdH5TuiT6+8J6aC8ZIXjoiuQzQn+Sddl+4qUdRl3V+q222WmZLW4sjS7ny2Gn1e6Ytjk0xMCwzT75PMUT8/wh8YHLuemBlS1pwUvbKm+pnrPRDwa9xqWP6ePcD1ZrhTTfn2XBdwSstm2QtfMxGmogrHavzS3T7ra7vV53aMJ3GxybTndomYNerZ4KHVDlLaXPn8frtR9ENT0ScVUzWz27b4yWVs8adjtdc9jvLUWv1+60ekubD6U3fRDnSMckySEn89g2jGJ4daZ5puBM55xMlTgjbJk6E5M1XMaUOaN8T9xhyDOHkDJo0pNFWkTkqKoIpiqCqYpgqiKYqgimKoKpimCqIpiqCOYny1atimCqIpiqCKYqgqmKYKoimKoIpiqCqYpgqiKYPQ9UqyKYqgimKoKpimCqBNq/UQJtVQRTFcFURTBVEUwpcaoimKoIprLhP7wNr4pgqiKYqgimKoKpimCqIpiqCKYqgqmKYP7WRTCUrdzrjbrLbscc9IdGl/dHQ0NYArb2lrUcdE0xqNV/tGKZJGtJyy768/LL0zQXRLHdMIYNo33RNo7brePWsNlttxDF7HgSz3kPSErfFVNJaU/nI8kCJOck209JpBLbelohsSwL0Ms3j25aZZMkVUR+K828MR5JejF2GkAJ+OklR0RoYRnd1rDTssx2qzsYDIYmcr0wR/bQNrtdnhH6e5Um/dVM3LlodY573eNOt9npdr8jEysC/ok8XKydyi8hVVCVnmh8cyUHIvOwUaO1EftVYlMMkF7tDBP90BK3ra6MCAiMAIbF5F3BjW7bBo4YdVtdzlvtpTUaDHS5+571Zz+E8HW6x61Rs9f9nhYkR8g/SgQPq4X7OezO9yzXo4XsmG3RFr1huyWG3VZ7YPbt/qhjd1tW1+gDCbOF/IHK+v5qOSJPrGMcd/tNY9j5jnJUWIO/1iX7frWJymbOUgJnVjTDc+/qxdRiyr457lUm9Ue0enJj2y2rm5y4DiZJUv4ja8BWKave0HNU8SfGMCKbJk8+oSAyH5GQBWcT395jf/8KRL9xjX4IYCgTSC3oqH4YDXfQKwyeSJC5RNN8JAwo0Wyxl9xmCzW/iZoMRi8Cbn0GWLM9QiWXngP9WdKFOVl9S8mwYiC4CQzW7i77YGvaoDcHPXO05J2OMeqNRnRKJ3NQdwfUXmPVjmMxlfEtsH6Vh6pgigbf/6i4Sveu0r3/n6d7gz7jcbiH3L11Qf00aGrpi1uhhI+OFNXPNOJqJMukNBK8xGlT580fc0wEX6bwVrJbyW4lu4eXatDLhSq2Vm/J9WkVXZ9LT1UEoPEsuD6yiBarCFQjGZSXC0kBdeUi/fPdBQj2ZzyTDpn4sk4ys/8g/0ia8gLy43Q95HMzOTJMTH+2Fogg0VEVVIMmEvYx4Z1hrHmJneJor/zAdIBBvRIXEWNHVPxO5xux59G1BGEdNnEi9J7lExtJA+Kont2gKwgqT7LyJCtrVFmjv481qjzJSnYr2f05ZfdRTzKfn6D8pDBerTidoWFykXwvr22CBum1PywVuTSIrnsrCIylPlYt7znUzHbLbC0HlujavGv3O6Nl2+q3eW/QGrTMbhsTHjJbf5XJcSpkeZnS1luuoyxxEQFWrsQeMFcY+b6dD//FmBSyRLVGyXiJ3ww0B5J+SH3H9qikptj3MRHgPvGQwpwP6WU0Qp0GbVfYNkjaQgPOrh287gZUlePL3CSsgm4wvLSGuc7KIeHFWQDc4L4xXmJ9qhSUhMnSUdL6YtQEro9esw+M5URp6lVwTx7sNXeedvHbRkW4urbhKZ48W+CMT3HGbPrFEgIFPfXce+X34kWY+e6yc7nAWwK9crfDPWAA2BBInZX6nZV/XvnnlY2vbPzfw8ZX/nklu5Xs/pyye4B/rryh7f45NNjbP4e2TYOlvtQrunLje7vpJCoKA3kbjG/RzYZ25oOTXwGshAit/ZCUCI9u4Ft6LSxW7UpvX+IRBy68vomidXh8dPQVlgeW5aHJ104zyQf0/Lum5a+ObjslygazAqRgqUsoMcg8fjtTW4omETVw6G5LYkoaQJJY3V1SC4HUFA5+FH5St3Tvx6DWCEwda8UUD9FjTKyADURaQSgva9qYI8ztMnAfds3n185j85BAtsyjjHyPjgXtGWC5MT1KjMflgnUGQOfoacvRLwGridRR4zi60a0H7s6Kd/DNsVmbvRQ8oCtx8cDi+T/fXbzQ7v+MQ3Rtk0Ip9hZYhPTXOAneYycyKYEfX98Q4uPc8QjKC1u6MGH23jsXgl3NFBHOQLEvQBMTSbGTIOHHXh+eJytj40V3aPOaGSWR8RzbOwIKHfFcvxdk32gj4HjyFi142nzvNdgJ3UuQFh2rKdK+jl2tk3lxbV7fisR/JNAaElqDoIUvNrCQpL2yZLqNBUKLILgbErW+eXAJr6HBw10TPEGomzggJRQe+UMtK1m1b8YjB6+B8PJ4vPfe0aVX+W5M6qqkMn6GxZ1+KP6TMWQdFIOr6xik6JvRopu2GiQRjbahodSQQzacBriChN8pCIYnmYmbaIrJE/HBSfNsKZKfaGVB5lWdYW7O9PgKS0+hpe1b4TfjjAM2cMCG1AGhwl/dzA3IgmzjHEgPSAaYZOtPmkAhquk8CatUqxP4I+qDpgHrL+XdTetj+eU4U3DJPWT0AlunbUAFoyedHvNhXZKC9SBvZM6IlcQANilYxNf1wRhu0E3im8ag0ED+aPPFGY+zUAkW6v3RWnqLJvlx9O5fpPEqTfN31DTKt8WQowrkvfTt+2myCyn8PtbWFPMDf8qgmHJedl3/9/mBLLnn25XonyWQ75snvjXRXE8gf3K++MZvEO11O9O3FEs9di3cXjVUO680SQmzeSNJVk+1+6atjWKrfQhSXoyVziN/n5Mjoe6+Q0S/D0m7a2iPq4D+ZFpqifn7zGLfgoJ9Ctg3llFe/7DJaI9fp3BYhj7gljC3Cm/o5lvuQ4tHEiHdXwR/w1t1mQ3IKLciWeKOuzMdDP6gA1pr+UsnN46gYOZa8AgVTJ1++WJFHgZs5JHRhLxdgV1TIUsAqpi73HRcgNdk7wQTngUijZEi+g0Vn/3uq5BRVotxkpgkJNUq9vDKFkAiXjG88m6H3bKd0Iqle2X5nieSmfm0QU17Jb4GGkQkBd0eJoJVOF/iqZdjCc087RgLrFOojryAkJplySayQPVL1Rr1jcDCLthgExs3wl3TTe2AFihS3XbNLgoQAZgn9WbTD66PVKfwCNsCEAziSGboNI0m8S5GfYD1NLjypwq037TZ5KSv2QmfahxCa0/csVx1SqbOUvbS3L9CmFsvHdHuc8OIxdEaQ+uIbSwjKDJGdVXLYlQg0TcYv4KHX79iyBUDNg9aBc7Vhyweo2pSZeiVdOJngfKrzvoa6mIJFdsrHmJiiEj2kOHcR9t+0EJsb+cY2K7hFOmMV0YLA46XDeDfx7X38F8Ndayq7/kqn3+tJbF3aPN7ep8V37JJUB9wmg8P/wf+OCAe +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create a campaign

+ + + + + +Creates a new Certification Campaign with the information provided in the request body. + +## Request + +

Body

required
    alerts object[]
    + +A list of errors and warnings that have accumulated. + +
  • Array [
    • localizations object[]
  • Array [
  • ]
  • ]
    • 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. + +
  • Array [
  • ]
    • 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 objectrequired
    + +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. + +
    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). + +
  • Array [
  • ]
+ +Indicates that the campaign requested was successfully created and returns its representation. + +
Schema
    alerts object[]
    + +A list of errors and warnings that have accumulated. + +
  • Array [
    • localizations object[]
  • Array [
  • ]
  • ]
    • 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. + +
  • Array [
  • ]
    • 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 objectrequired
    + +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. + +
    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). + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/create-custom-connector.api.mdx b/docs/api/v3/create-custom-connector.api.mdx new file mode 100644 index 000000000..3ec130201 --- /dev/null +++ b/docs/api/v3/create-custom-connector.api.mdx @@ -0,0 +1,100 @@ +--- +id: create-custom-connector +sidebar_label: Create custom connector +hide_title: true +hide_table_of_contents: true +api: eJztXFlz2zgS/iso7kOOteT4SLz2y5YiKxlN+VodSW05rgxEQhJmSIBLgLY1Lv/37W6AFCnJZzJnKalKZLLR6BtfQ4BvAssnJjg4D9paKRFanZngYiPQqci4lVp1o+AgCDPBrWjnxuqkpAs2gkiYMJMp0gFVm6hYSGQsLOiaX1SLWf2LUOxK2ik77X382jo87p4wntupzqSdMWlYJv6Xy0xEQMpCHsfMTuFp66zbhInwpTD2vY5mwcFNUNAGBzbLxUYAc1mhLL7iaRrLkETf/NmgXDeBCaci4fjJShsLVGhBRuY0ZH4emNHOUiTUo5+BwEvgpjwPFE8EPApjbswJfgaDpRmazEphcB6iwPkcF2MzqSZLBhtMRUUEHNNkJ8KZYCRYriRIw4AtA+24sk2GI5AOLAkW4qNYEKFxYyKRyUvBOMuzmI0zKVQUzwo2bmIabKfcOg4wWCrQ2qRaGZi9T0RuipAroASvFTOMQUh0TJ5GaCvgnmqprAG9xDVP0pWWDW4LWz7NGkjbZN0xU9oyk4pQjiXIUEgdiTHPY+v0fuEnffFP75m7xSG+KNPceU8UjAZ6Z4F4M50znoEZccIEghA4MAgFNR9hLFcRzyL28goNT7Ee6gSIIxG92nBGpmhXc+cbYfGT4TImKzfn+XQK3MssbEU8tSKrKf3oQWCHCII6tP5NxRYjrWPB1ZIxMOGYHKPQzOg8CwUqxJnjU9jJv6LR5KgiU0sh8UeYHmxjc7PKB0LlCSbbYedT5+j07LhzMoCnh53jU/iv1znqtPqdQ8y8+5zl2VeNUw69pT+Y2S76SYrtN2/wvzrPFistxw7BKWVR+Pa6U0w+57lYeL5PYamZgB58Q17WmPVFdilDcaKvkKUb+Jy8MvPSUw9mx185/t8jbZ+dK2NYI/JMVMOVZxmfrZw6lsYyPWbFIGbyNNUZlqzRjNInrKykKo9jLOdFnkgrkhVpcVsR/Tw4651+6va7pyfdk4/Ao//fk/bXxWedVq/9A3wYnvQHvWF7MOx1Dr8OWr2PnUE/uPgdCkAt4yv1YMxjgxWgtMKxsBwWFl6RoUwCHkUS5+fxWSUdCo71XE14ilJYLhXW4sSzZTRMQbpiXV20fyklZG3hp2EX+Z18HB61epiIMbewBCaYxiGGmwHwYg9hdnxSBlpVnNtHVrizXqfdGkBN2vjty93uqgrXjiUappNlwKXBegJCVkGkej97WMRGgL/Q21Jd8lhGzSeVwHvrWgReknFbR49I7A/gxcYkA/+ChIJEDmEgA46XMiKf6wwhArLEFEQViK6e+mCJ5hZ7zyPQ1+nX9spgbcx4+AvwQvz7kEBDh7CKIUw6rHTHtGJP8NG7N/vbu+N3u5xv/2t3a+/taH/Md3be7L/d38fZE2EMnzyi0nwUCkBfyGINmFn+CgYBIAu2JwFo8mC5mNzhA+LxyMLqaEs1vbyAU6/tBhSD9+0ztrvHYq4mOT3nkwUjqMawv1T3QHPH+DSTE6nuT5oPreHRgJLjP8NOHz4hr6UEaSmI1gjDEkSFWJjqK5LYK3DFoTCLGMwhoiZ77bm+BoW4MlVC6X4yMwPGLOAnjPCzrxhRZQ1oHJb9aipR3lxb9lI2RXMDEB88S7gNp2zEEWxrAt/sdSsMRWobR96Sr9lUcMD5r5qsVdZEBtkITGH8DKEjFEtMXcdgnOPqQ52Xzi2iaVhM676Ym3JxFSpgy1HVKZgcIPnDcdIKbQ7CkZrVLCyjxYvo/QMyO8vVpRtUjEYmnUFpD0ELaEVmYMaMlp0R6CatYb4cobsMFB5V0JUVC0tgoRaVu2MnDOA6ehfy3Dwi785iKD8NUq18cSl88hlcYVw1Im8UbvIVyS8/NNhTle4qEp9BtxNH69xd5+46dx+Zu4sve7618m8J+mwtQ5+h8ttQuHguQZ+MokfpYq/qV4I33pEbDAziIdKPnwd+kwvoxXWKe0XfER+5pXxFZ1r4wz0fIfwonVXzBQpIdnQajKESieiA5J5LXEGJO8uzfdDZSEKAqhUQEapmVm6GZLki7M3NBou0MOqFZVOOW1OQEca4Coizqqjhmq81klwjyfVqtF6N/jar0RpJrnN3nbt/zdy9F0mWUlG2eJxk8iTh2cxFmn+P2nIGBCs2+clVi2gFmbESYwV15BCMtrdGW+O9UOxGfDd6t7M/3g7fbfO3e1t7W6Pd7b2gutafz/O4TLJ6TlX87fxIJsbNdsBxuYLgMlbrqL79B+bNxBjLGpaeEjeDzcGkF3PsuLuMHU+0Bd2AMWDH7I7txWHvCPnD1MQe7eY2mDFpyXTuq0uElPS9oLiW5mnfw6yh4xo6rpef9fLzZ15+1tBxnbvr3P1r5u6ToOPuQ9Bx9wnQcZchxBojxPojoWMEuAOh2RicAjqEOZhXIWxMQRX45Hcffdpbnk2ELYFeDUVu7y+jyIHW7JirWQGWTG0ncn6Sjcob0CZImxW0QMDZBEqkwsMAEtAtRpVMBGJSPNIWy0RSHqNCwDebNVpjC1q5nCnirZxFqjDOQUIqCrHGvVcNMSYhnMQY4R9woH3QCRTq77jH6b31TfvBrIcaH6HGrHMdCoE5X+7/vl11SqALwmdYLvrO13ccF3B75lxBGyGuU1e+Sgi6huprqL5e7tfL/d9juV9D9XXurnP3r5m7T4DqHg3dDdWB4NFQHWibb1iJpT7QcdjfG7FTqngJKLyZDgmrR3MMjodXBTyUdkaTDAHit10ot3I7xcyUkTooj5824NNYTg7cXZrg4vYCpYRYRI1STTu1KceBwWY5CE+rutbBaZJnMbyfWpuag83NG3fx5bbJU9mEugc+tjOlr5qhTjYvd1aUKzyd6lITCl6Uh9RutM66vj9pklsyiZHvyiRN4JzkTybPz4Tfy58uyWi6AVJc0NnA4/E+CukxiJlCC/KiOHmORl3SEXQbZvHtQ/p82rlPD8fkDj1Wme/euYCeLhHV1UPxL+ZB0Ues7mZfCo35+oPfEmwvTXaKZNvsveAZXm+igzMvf/w8eMUmiFCpQuQGwbGQ2FJAjp1BiFAFbBWHSHAQLUqZzidTErxVO6aDGcfGMSjMvqi+EOy8641wAktDD2o5mRQHCSofOOriZeGZSFyKGFfNZvWWQLIJUb8JFtrktXGvaIWkVkIqPChOT5tfVIMd0tl4iSs90ngVqTNk52mhF6/o9Vwh/lFwazhuDeJmXi1I4Ux7Hrpj35CwZBYeG7LWsyd3/BoVfth3wRPkuigDWsLLUT9cFRZee7YcNX4N5FeX44v6PJWw/NaHMVesmIHVM45Yl4VTrY34N2MYOpgG55McsujZYl3hpA3KiMb2m4pIDTdlQzYATJJ8R5AYygUTH+FiTlhGu20VSsmfyLOQ8z9Bqx2xn2o60+NzWHORMtKhebbMOGEDJ2y4GmC8/G5Jw8CC3EYdqA64AGjP/U+VwAtaqXn+PuOqqk7sN2kMLg0hiEpcTHrgfjiYFzj/idELpC5poAQjFi+Pm+G9Rc8L17WasYpdhEULLssba1hOF+zm5C2/C8Ul9s+mL2rcmm+2nKp49r2r9B2V5M9Td/+gireuNH/HSuPRMW5a9uY30zvzO2TumubyZejyeufqe8m1+42Pv5q4dInPdXTFzbPKHbCNAFOkeiO1mpgOYS5vV+J++lTAv/CWqgu1DtCYuQv9iLuqbIqLclSHwqkUtNGRQlOAaHUDc0EnVDsAomPBgnaWGE2occCroBxaUxkDvyb7jDfNQwgL7CLxgDFw/Vn7drIPJjpDE7HDItgA9CVJrvC3CoAQecI4hPQDERlJAw4h1Yr7iySQJuhZjiqqCIY6mqJJ/VSWmNOxvwVbCbwH5oK4M347nLt7lz5m5or0REyZgXT1luEh3hDtjamIU3R4jJdnTTUqj7uDJY54Y91/B6OzyaYfZDaRFphge+aCYacJ3Ss+woYOmu4K3zt+/8NiPN3MvwP4LX9lhE80bEk2U9x9Q6Fz1yK5LvQ8qHSh0NdMsUWFpzc3uC2DLdktPob8xp7//GLeceFPwM1tz1Db+ovAbQH/fUBj4JLZ9//LX3RgE+hGuC2fe2mrXfTZKW5+BSP/ezASt6OQ8St4iP8eBF/gb4C/v8NFDhDR85ug2J8DGse3wEGrYID/gGre3v4flbDVBQ== +sidebar_class_name: "post api-method" +info_path: docs/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 custom connector' (create-custom-connector)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create custom connector

+ + + + + +Create custom connector. +A token with ORG_ADMIN authority is required to call this API. + +## Request + +

Body

required
+ +A Connector Dto object + +
Schema
    connectorMetadata object
    + +A map containing metadata pertinent to the connector + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/create-lifecycle-state.api.mdx b/docs/api/v3/create-lifecycle-state.api.mdx new file mode 100644 index 000000000..3c1ca561b --- /dev/null +++ b/docs/api/v3/create-lifecycle-state.api.mdx @@ -0,0 +1,96 @@ +--- +id: create-lifecycle-state +sidebar_label: Create Lifecycle State +hide_title: true +hide_table_of_contents: true +api: eJztXG1v2zgS/iuE7sO2RWTHjvPmL3duki6ySJNcXq7AJcUtLVE2dyXSJ0pJvUH++80MKVmSlaTtFnvbhdCgsCVqOO/zDEX6wdMLkfJManUcemMvSAXPxImMRLAMYnGZwTdvw8v4zHjjG6+8weiO8T5ueKEwQSoXSAIIXM2lYZPzY2YpGcaZEves8WDvVk1Ypn8Vit3LbM7OLn78z+Tw/fEp0yk9zfNsrlOZLRmQS8V/c5mKEJ5gAY9jlrlJesCaEUGOA4G9B+/aiPRAq0x8yiZAAVmWoRrLUKgMxviLVEcyFn5csOMbZGeccMVnwvv4CPIseMoTkYnUEEmJUi04ENvwFNyAb2vkZOg19XDsxrBzO4YdH8KYQhJvnKW5AOaDuUi4N37wsuUCSZsslWrmPW544hNPFjFeE9HWXrQ/2hrtiv3R9s5wuj2d7o2GI769s7W/G+55yDVSFiZ7q8Mlkqsz09B+CyMBKk1l+ChfLGIZkEv0fzH4/EOFT1D/WUSKcRzr6S8iyGokb6yiUJcpulcmwVPgWVDTGmuXS5OJxJ8JhW4INs6VBElAXUxHYGjBzooJ6iqqakiGg+HWaJuY4OGZipdWrsfCZM1ZT+HqF9DnOB6NYp26RYwDvAEfWQj3v4DycHOw7W9u+8O9q8FovLk7Huz+GwZEOk04WMNDcn4mE9EmW6JDGck2dk64yZi9HfzRfAFj4PhE5S034kAniVaHmQb9Pe80mQjmCviNT1u9Ryg+ja2wjspU61hwVWXcenNdGR/mAqROSfQy8BkFPmYXRxczTygNfe6hrevsrIVoVVtXxVBGY9dzomAlNYYeyUCRTV56jHIn/OFNCfGYKhieG0Hs1Eg+x8wq2KuPNHk6aSiicpemK3Lcgc5tWnATIl8zkVZ9AS5tDassjIZNp2jOfponU7AI+KObB2wM9uEZm/M70WYpYgpykIxPdVa69VlTH6VjtVQl+ANlhqTeVCxSYXBqNWNElkEKjOQst8WQBvEmE17TJxXysnxP1SM1X+6axxCQeBklViS2rUQpMkvEJXpm1Oq7wZyrmVWM5WMSx5Mwkep3M2JrrGCcqDGeii9n5nIhArQTluRvopkcCTFjyQIjUrFb6xGTMARjmhNpsluPTUWs79d4fobfJo0KszxN+bLKKmYpk/0D/+sFOsEcCh+HqwuQtiQUNNNa05shCEkaWEPBnA9yy4UwPQYKuG1TJUioiQK6SF1FplDSZwtfydVHT8QWDOFBgFlgEuAF06KepsRPRKGtOxRa1oxLjD5HFsHdVDAILkwsyDf4YcXcsdOW0XkaCPMDc1z11oKSB0VSWCXFo9PJ25OjlpJX5/CQvk0hGcmIWToAUCEagLOWOoGeofIE3aKc4PD4kj59BMVZXo/Dz9HZykssAjq2921sVPxvGOwP9jb3Rjs7m9FoO9zZHOzsDHZDzveHg83tvRGQfn7I5uY6ai9d0YIvyzdgMINFqfhuWJKbSoa2IrMIkE8ODgd6iWLI4IR27RM9dikEuHHfEQDfFSpcaKgY1gvsPI6CqTvkpOp1dAcsDsHhAPX3p1XLftE0oHZtycNo5cboQBIApoaovQI+ItIv9NNo0uDmI5Zds4BgsoEAIO4JpArT1B9nNmQxmLpWoGsFulagawW6VqBrBbpWoGsFulagawW6VuD7awVGwMc6OI0lVDp2lKagc59dCNC2wgxqU7l7i8CmOqQ3L1Ld8ViGX9QWNAO/HpGhyCC5HOiwFUfVmX0nlfBnKZfIoSCWA3iQAcU7GWLCSHSKeAVJFtWIxvVqMAg00RuwtzwEea18B04Y9LGUB78CrePwZYaurfWKRwCxkO8+Ma3YFXy6s7k/HEU7I86He6PB7vZ0P+JbW5v72/v7OHsCbgBFvs1/61P/iF2RDFisATjK30AhAKuMQyc0+XPJt24DovEZ+sd4t2NLMR2/DN+wbUBSfntwzka7LIYiktN1PmsoQfnXl/jqLI9jTJRlx2IJn6VyJttRrMumh0fvJtcnV3Dl4uif10eX8AlprUXYBKqgCtEtNaHJOVT+bCXAPQfAIGJQB2B69sZRfQMCcSw4q4HSfjPUjIJvRTyPM3jCzd7yRJU0i1Kd1EIpsK8j2SvZE70NqB7YjvEsmLMpN7a24fA3kOPEIvNPnCbfsDnAZpG+7jHAIxKFhA4AojHH5MuXWIYAIljwgwSinFIvpgydZ1TzIevWbLFSZd0alURSNQo1Pp+yl/0E8nIOzJGY1SgsvcWx6OyDFZzmqXN3VVEaqXSpMqy7+MZ3CWpMU0QMU5BNZoa5dITmMpB4VDGuzFg1QIPcvLfMUPuJ/TvPzWfE3XkM6ccn0cobd8IFHyEVm43IGoWZXEaCm9ncxkoxqjRXEfhQI0UcdrHbxW4Xu58Zu82bF27N090l6NOy8Hmt3KYSLJ5r0CcVts8udp78Znt/a8gNRLQOIv304crtXMEFo08LXLL6hvjIlvI15ielPez1KcKP0lg1WyCDpEe3egGZSIRj4nvFMSnKqmprfbZ3Op1KcFDVAhGpRV3qnLBqmiuFnHCzwUItjPrBNQUW4NoMSAtroU9Yv0OSHZLsqlFXjf461ahDkl3sdrH7fcbus0iy5IqixeEkkycJT5fW09x9lJYzGMCKt++sDDkyVROtIDFWYiyvjhy86XAwHUS7gRiFfBTubO1Hw2BnyLd3B7uD6Wi461Vr/c0qjssgq8dUxd7WjqRiAHF3gONyBc5lMq3D+vIfqDcVEaY1TD0lbgadg0o/lthxuL+OHa+0Zu+5WhYIydQwpFrpCHMajE1wbFqMlbjSP4O8qHD5X2r7kkkmAqjgpgAWy0RS8KIUQDdd+pMoA1FsoBROVs4iVRDnwCFlglgjatbgWBKEFBFiPqBACHYG2fkbolNnot+F5NkFSnyCErOjT4EQGOglct9uW989Lt4VX1oDP7HQa7sdrsABoCGwOavEnR0+7/B5V+O7Gv/XqPEdPu9it4vd7zN2vwCfOzT0ND6HAZ+Nz2Fsb5OVWOodOtcfDtMpVBwH5N5MB0Ge0nJzgcEJV4ArIUMLbSiJ4FHFsddvHlI0/YeWc4uP/cZRSOPhkUrEjpbtPI2B2jzLFmbc7z+ANcGKjz2+kL2CnNL3uN+pf7f15GY79CuYNMztPho84Wkn6ZENUolubnMiTWAtQlKjQ4NlaPX4WfrKbeRd6hyyIJHZYBASzuXoMrC5gH7jB0OjaRvFxpqMINt1Gj++JM+/tp6TwxJ5Qo429T07F4xnwGVDPLcLpDgBe4nA3M6+dg52VWywmRuu78fCYUP2VvAUt8fS+41XP324es0q27EN7ZCUtIOWs3NwEUp3k2KtHx+iCpTqfGY3rkxqb1MwvFgUg8DsVuF+oJvimOwp1IELSNykUnxIUK7Apz6+KiwTijsRY4nsrTSJjidD1QcN9XntuddUDqlvkMruUMUdrbfKZ4cSsxRtNcMxTkRqA9nNopCLV+T6Wib+VlDz3ZYfomZeN7iwqr0J7O6cAGIcSfDYkLa+enJLz6/QwyYLriDVJg+oCcdH/R1YUFjtq/mo0fORXp2PW/VhLqHW1h9jNrUxA6UyDtkxC+ZaG/F3RlvJMAxuZjlE0VezdY+T+hQR/nCzwpJvp/SlD8iR+DuBwFDWmfgUKzcBFw2YToU2JH8my0LM/wx9dch+rslMl2+gwOLIUAfmq3nGCX2c0Lc5wDj+bf1Cx4LYRhkoD1gHOFjZnzKBY7SS8yyt1qxO5Pv0DJaGAFglKmYxtl/GqwTnPjG6gaPLMZCCEXiXbwVxW7GjRdv5qsoqlgyaGlznN9ZQOxt6s/yWS1ZYT/9s8qLEk9XKCu6N/9ZZ+olM8ufJu/+njNdlmr9ipnFQGFcoL1a/g3FUNC0PxQ93cHcmpzw/5Pqq+vGel87wPHWq5pkjKc3DIXbetaMa1cuNQxNum/La+YSXTyG07Nq/We2MX+1Wr+xQ/0aboBGcrm/U/lbENzxML+RmrkesJjWLztfXdY1wxyPgLmVm6rFAG6vN1lUyi5hnmMMohwdzKWhFaCF4hh60gXlEJ5R3ob0J6LyGJTSj44EpOCiHHl7GQK/HPuDRATBFiu027qEBqr9o13dfgmnPaT/8YRGoDE/M5Qp/RgaYyBOGp6JeiOZQmiC3RQe6byUKyTTB9vKpIgNjmkBV9Mhz0sScRfjqQAaiErQvzAUxa9x7A1BkJd5WglyImFvn22i0Wy/Rhkzhz0W8wIYfKiaA52pEvz++WqMIxJQ7dKDTWd89ZPo4Fohga2udYasHbT5ewtY54apC156Sbf5sUdOdHlbvSv74Hz5yUAF7vP4C1y7paIPtOe0iwM3aLxWh+td/DYl+vmhtHQCCd65tinl4wFUwbIof8TJkWFxiufm46nkpp5RnYcYRFIDmOa6qsl5dOMles/YfSmoVrli+VcvVyo0HH38VuODTJtYjpgm7REcc2pHunZB/tSTUVlBae9mFawP2Cbvs9+zYj5WlmPMzXAD1pu7HmBK7qpTye7iI/4+9W/gHX+zxLapydP3BK9ZoYYylW8DjNnToPoAlYNj/AD/4VVY= +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Body

required
+ +Lifecycle State + +
    emailNotificationOption object
    + +This is used for representing email configuration for a lifecycle state + +
    accountActions object[]
  • Array [
  • ]
+ +Created LifecycleState object. + +
Schema
    emailNotificationOption object
    + +This is used for representing email configuration for a lifecycle state + +
    accountActions object[]
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/create-non-employee-record.api.mdx b/docs/api/v3/create-non-employee-record.api.mdx new file mode 100644 index 000000000..569c0add1 --- /dev/null +++ b/docs/api/v3/create-non-employee-record.api.mdx @@ -0,0 +1,96 @@ +--- +id: create-non-employee-record +sidebar_label: Create Non-Employee Record +hide_title: true +hide_table_of_contents: true +api: eJztW2tz27oR/SsY9UMeY8p62pa+tErsdHzHSVw/mpk6nglEQhISEmAB0omux/+9uwuQIiVZdtKkNzdV7h2PLQKLg32c3YXA24ZOheGZ1Oo4agwboRE8E2+0OkrSWM+FOBOhNlFjp5HxqW0MrxrwLCgeshM5EeE8jAV7zRWfikSorHG904iEDY1MUSwIvZhJy4z4dy5sxj7LOGZuGcaZAmmikGZoreZ7dQZjpREwSYPoUKtMfMmYnrAPMlJDJawZOgkfAJgX/EJH88bwdmnpGlon3y0Oj0tIY5ja9JJgWdBDZnKx06CFYUMgladpLEOatvvRoujbhg1nIuH4WzZPBSymxx9FmIGg1KBWMykszQ1DnavsDU9EZbDNjFTTxrKuzhwmETEZwdoymzM/nykQgDDFFw47QhmoS8mTpk1kNmvc7TQm0thHLlTVzBPLaOaaJd65JVB4zL9RNk5cI/q8QA1alPFXS6VZG/TxN/95M9QEP51p9fXYaVZ9lX75D8Um5PjmYcEXM1Ga8vgQvZmzGx7LiqUzzawwNzDOsgyDphoeAMavVYfzkQPASAsEY3VuQoGR/JXbdBMBSV12Jxy0D1oH/b2DsN8ZhHutNvwW8r3JoBW2u+0urhnxbG0Q8CiSuBiPT2vhUMd1twxslMGDcQ7sMI71eHfMp2yizRJV7LB2i/FipGUS9SVAP19kkifMyt8Fs3maagORVNvSMkGMckSJQFB9GTfZIfDKOv0BioQDGeCGRZBJCIRNSmUOKzIiI7kM5y2pt9VpBa1u0OldtFpD+j9o9eEnRYWKfgAUkLoeSJuA9FeA3FV58apGZlW+qdBDEdBFyC1ipOKgVWUv9gqpAwKBINVy0ILh7+4cIptqZZ1DdQDmil1fUn6I1iaYxnejdrk20krzXF4eH262jE9Jy3EnJt2DyaDX7e2LQa+/1xn3x+ODXqfH+3vdwX50gP7x49LKaDyeN8+3OWWbU/6fcsrPnCbag6B1EHS6F+2DYb8z7A+a7b3Ov/6ALNG6D0eiIzmRYjMf3g/k3UwoSuFlm8B9jBeCH68S1xp8VyRe5CYMvdaw22/u7yOGu3vSGLVSLoP11iatWKL2j4wB7wzYmchyo5CzJzVE2K9gySMVxfp3zGeRyIAAX+roEaT2SioRTA2XiFAQ5BAmMpB4IyOYAaYzgjmRSE24BRpXVyNootlmL3jEfJJiL/1mUI2Gh59A1mPo51JJmM+KKUA8FOX3LCv2BR/vtQad3mSvx3nnoNfe748HE97ttgb9wYCcWlgL5FilGG4Mn68s/XehhJEhi3UIFvkdFAIOA7onALQ4TJGZSOzDNiAZj9A/cr8bW27T42XYLu8Avb14ecp6+xBHaprT53y6pAQVXJ7DJyqPYz7Gj7DzxbxMgt8aOZVqHRSh8gTLwcOjV6PLkwv45OzoH5dH5/Abylo5Ahgp8NYI3RKggi/M9GdC7DeAMWZFDOqAIGPPvdTnsCGubHWgL/TtHGqZBHxrwvM4gxl+9TUzqqLZxOikFkrF2cJT2RTNHTbGz4AhwhkbcwsTtOOC56MwFGkWnHhNPmczwSNhnjXZqExJmHlBKMyfgyAGuQpD1wmY5BDKAAZqCJ1D4aIzGS6x60KVdWssuOSkahQMDkD+sJ+MwiwHcMURShkOpbd4iN4+gNlpro7uYokR7VxlPIRd8DiegxoNVLLATLA3mVnm6QjNZYF4VDGuZKwqRRLdvXZgDjNNz0Ke20fE3WkM9BPQ1soHN8IHn8Xax7ERWaMwk2ckeIjbpsl+VGmuIvChhBVxtI3dbexuY/eRsbv88My36v4plT7t1dLnUvEc9Gsoea6UPoa8R2lWDHIHuM6QOwwU4kuk395dQGB/ghIOxosvKR5bfMf6yKXy1e6gtIf7fIzlR2msmi0QIOnR7WACTCSiIeFeICZFOVV1V1d7pc1YgoOqNSUisKZhc50zDiozuVKIhNsdBs2cVU8yNuM31DICXseAuKqKglRLlW0ryW0luc1G22z062SjbSW5jd1t7P45Y3djJVmiomjxdZLNk4SbufM0/9wdisMAVnxpxMqQI1MtVysojJU1VqNeOTTGnfa4PdkPRS/ivWivO5h0wr0O7++399vjXme/Uc31V4s4LoOsHlMVezs7korpwN6wXIFz2UzrqH78B+o1YoK0htRT1s2gc1DpdVk7dgarteOF1nhVY15USLZWQ6qFjpDTYGyCY00xFgZwNgVeVAyoSgIudCWZCJBi8EJHLBNJwYu7ALlmHowmGWzFBUrhZOUqUoVxDgiJCWKNVbMGx5KwSTHBmg8kUAU7BXb+jtWpN9F/VcmzM9zxCe6YHX0JhcBALyv3/rrz3WMAb5Ajzp2B7znodd0OV+AA0BA4zirrzm19vq3Ptzl+m+N/jRy/rc+3sbuN3T9n7H5Ffe6rofvrcxjw6PocxjZbrKylXqFz/c/LdAoVj4Dcm+kwzA0dNxc1ONUV4EoIKNWWSIRnM/hrt3rxJHCXwCw8doW/g5SbGEbOsiy1w93dW7AUWOiuyVPZLC73KP0ZbyLt3nTX8I4sr0UCc0V5SOfNo9Nj3100Sb9Gogs7vqMFnLZpR+isoHU6Gd4oH69hoRnnOgeGIzE7DNzduxN9DDBT6CWeWH9pC7WzskfY26WJ7x7azz+7m/bhhNyzj3Xq27gWjGeAcml7CP8azQUmB0Fkr0vA89IR1ShHK19dV8ecY2HuEK6MXCQbbOY6K4De4rAOeyG4ga7Bfb/x9Ld3F8/YFMtRooPcYiUsJPYPEFCn4EZEd6PirB8nUQYyOp/OaHOj2rcpGF5sEoNS2Ht1LgS7OvaKegN54AyIm9SOkwRxBc66flpYLxI3IsYU2VxoG51TRmoXtLjLa/OeUTqkvkEqdy0HPm2+VwE7lMhSEtM6jvFbpDaQXaXFvnhlX98K4i+FtMBJC0iafbaEwqn2KnS3c0KIcRTBY0va+ubFnbygIg+bLPgEpS5jQE14HPXvwMLCat+MoyYvQHl1HO/Vu5mEXFufxhy1MQupMo7YMQtnWlvxV8bQdTBUrqY5RNo3w/qMiwYUEUGnVYEUuCUDGUDlSPhOIDCUcyY+xsxNhYuGmk5FLmw/kGWBFz5AXx2xD7U908dXkGBxZKRD+82YccEAFwwcT1iP3+UvdCy8hAZ7IB5wDvByYX9iAg+0wotO1lrmJ/G7NAfTRwhQSYpNh+6P4YIE/W+MHuDocgzQNBbe5beC8DfzsjCJ1ZRVHBksa3AVb6whdy7pzeEtj6wwn/5s+8UdjxYnK29VPP/eLH0Pk/w8vPsHMd6WaX5FpvGlMJ5QVt7kOFpcta69ybD0Ulvt/YPyzYHqiwP+zn955X/Djf3ywn71vn3luv3i3nv12vvDN9YXF9bvuzVeuzS+4b2fyoXuTS/l7DQweMmIvgOrUoarj1dPTfFYfybgJzwl3qMOBvpD6nipIqyKSWOeIUMQQ4YzKei8JRWwVai1dzBKdUKsBg0GUil01SRoSrelDZifQ4csY5DXZO+goVVgZ4PNLN5QAakfte9qz8Fyp+jy7LAIAyhHkyRX+AoDgMgTxiHYHoiVSNowd5QOva0Sxc40FcXlrILfMAhRFU1q60xi307wYB56/kpIPLAWRIT1p/KgSLSIcl652MiZiClmcVy94XlINsRhMBNxSm/KACxojisrvD6+WJEIwpTz3KY2010/ye7iWBCCzaVzhm4Tmmh6hQUaUwiAilz36hSrvRtQvgZcc6nbxbcRP/glX595cchuikeBCD13bZ7rqa8aa3tq6MBm2HrD89tbPC3CBvMOPwakeBRxdb3oH6lngwl0akRN3SeBpxX+a4rgYk6FhD+WWP3+BVtaN8OdRG0ce105HTh9i2dyjbF/hzlxBx2Gf4YP8eew8R7+gz906jwJBtHnt43i2BDZi+Tiv/8A04p4NQ== +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +
+ +Created non-employee record. + +
Schema
    data object
    + +Attribute blob/bag for a non-employee. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/create-non-employee-request.api.mdx b/docs/api/v3/create-non-employee-request.api.mdx new file mode 100644 index 000000000..2c926d167 --- /dev/null +++ b/docs/api/v3/create-non-employee-request.api.mdx @@ -0,0 +1,103 @@ +--- +id: create-non-employee-request +sidebar_label: Create Non-Employee Request +hide_title: true +hide_table_of_contents: true +api: eJztXOtTIzcS/1dUvg/JbjHG4wdg7sOdF9gtUgQ4MKHu2K2sPCPb2owlRzMD61D+36+7pXnZxjyySTZbTrYoM5Za/fypu0fivqanwvBEanUc1vZrgRE8EadaHU2mkZ4JcSF+TUWc1LZqsQhSI5NZbf/mvnYVC3OgVSI+J700GcOzD/MPW7WEj2L4XAMCXkaBncihCGZBJNiPXPGRmAiV1GBwKOLAyCmuDSv3xzJmxq7G7mQUMcsL40wBNZFRy4ZwFcIXiRzOWDKGUdOp0bfC1BlyLI0AYhqWDCyTTA/ZRxmqfSVis28pf2Ta0NwUhGGTFIjqO0VPYp2aQNRBarfcGx2C4PcLPFfEJKLwPOdwgHMsBeAHtJuYVGzViCPQAFADpiMZ0KztTzGSvK/FwVhMOH5KZlMBi+jBJxGgAUBAsFUiRUxzg0CnKjnlE1EaHCdGqlFtUbnOiiJkMoS1wYrMzWcKCKCg4jMHSZAGKl/yST2eSLDsfKs2lCZ+4kJljXwXM5q5YolruwQSj/gLaePEFaQvM65BizJ6NlWatUYf/3bP64Em9qdjrZ7PO82qrtLJ/0OyE4oU8zjhPvq+M+XxIbo5Z7c8kiVLJ5qBg9/CuBicG6KsHE/AjFurys4nDgyGWiAzNhoQH54ppp0InFRpN4Ouv9fY6+zsBZ1mN9hp+PAp4DvDbiPwW34L1wx5sjIIeBhKXIxH55VwqPI1X2Ssl8AXgxTgZBDpwfaAj9gQor+KLVvMbzCejYyZjAkMJvyznKQTFsvfABnS6VQbiKSKSIvA0EuRS2QE1ZdwkxwC4KzSH3Ax4QAGKLDwEgmBsE6pzPKKEMqILsN5C+ptNBteo+U12/1GY5/+eY0O/KSoUOEfwApQXc2IT4x0lhiZl3HxpgJmZbwpwUMW0FnIFTFSctCysgtZcWOSCbG0vLMRss/nlqN4qlVsHaoJbK4H/Aznc+DPnfTJEM+j6GxIG+p6sJcrYy832NXV8eF6Wz0QibzRarR29ppeR7S5124Pd71BGDS9nUDs+H6z0+4G/vMQ4NIudBwC2sQ6kBw3nTsAzmXoKe2yz8MG9aTtwnGCg1/Iy4VI0OMWweSJC5cevnD9ZUIUOCt82Y48kQni9SZz2GQOX0nmoBZd9PG8dgN1G6h7MtT9JWni0zM/W5Ty6DgRk3h57ImMqTDNhjEQakILYtpp8srbMc2N4VhQyozaHxxIVbZkuOC8vmjt7Q08X3Q6XnvQ4B4fdAJvr7s79JuNtt/pBrVcBRaPFneWoTBCgdUBZqiELzzn2CFQIfwDQtpvl8UUKp1gYvnu7Keji9Pe6cHRz+8uzq7O4avjw6PT/nH/v5gWFvLkTxdVYlkZSqwHhsRnDo/g2OgZoNCoeEjuMkKRFUfhRkan09pKV86kPEx0H/kHda022iqOcP2qSTqAHw2/E7aawz2AEO539nyHMa1O2BQPRVRGLzfINcQtACBa7wumChVeobxK6u7bWilSLhOepCsitbBo7/z8AoyKvntx9MPRQZ8+nh+dHh6fvoNPp2f9ny+OeodoyQM0/MkJjFhqNx0BOQixKeT8yKsakWlXd5qyOIgtc2U5Stxkmu1VRSkJd2bCysYMLAyoflmAkGw9TeNLy/ml+B1GmpPqIJ2YuGJjvX3cwAJxqsRrx9ljSiN0iE6/HkMeLhSvx0KVUYzdcZd3ZYQXS0W/6zX2vGar7+/td5r7nW7d32n+jwSkbt0X5cSRXMdDu7Hf6tR3d5GH1XHTK6H7Gx6LCuR/k478Eldziy/4mvO00FGFhzjzd3QmVpvZUhbRLHPtJZPnrRLf34d/bb/ut7pFu2TTu1nu3fwF4PCIlf48hFjLyHy+ttPkukztVY2lg0iiLY6MgfzBY5COp0bhTjqscIavFDDtkIoqtfpzek3rE6mQCoADHT5ho38rlfBGhkvkUBDLAUxkGGEyRAiaaIPJPJJEDEARaFxVnaCJus/e8JA5DbEDJwwCruHBL0DrKZXYlZIwn2VTIP/Is+gVy4pdwQc7jW6zPdxpc97ca/u7nUF3yFutRrfT7ZKHiziG0rYM4Fn6XV36nVDCyIBFOgCL/AYKAccB3RMDtPjTM3ai8QT9Y+Vux+ZiOn4ZvuvaggT0zcE5a+9CUKlRSs/5aEEJyru6hCcqjSI+wEf4dgq7KkT4zMiRXFkAZtvX4dHb3tVJn3av/1wdXcInpLW0P/UUeGuIbgmsgi+M9R1x7ATAWItFBOqAYGOvHdXXIBBXcXmga8bHsxirkVAMeRolMMOtvmJGmTQbGj2phFL2YvB7WRf1LTbAZ4AUwZgNYC8PmbaY8LoXBGKaeCdOk6/ZWHBIy17VWS+vMbFvAkRh/gwIMSg+MXQtgWEKoSyoFtZpQq8sF4vfQpVVaxRgclI2CgYHcP64n/SCJAXmsvefeTjk3uJYdPYBnq3mqtz1F5AxnqmEByAFj2BfDbQxoGEGRTPUiTFzcITmigF4VDYuR6xyMkVw96NlBoog+i7gafyEuDuPAH48Ei3/4la44IuxpLRoRNbIzOQQydWbNNmNys2VBT6DbSgKN7G7id1N7D4xdhe/vHCv0+jbnCuKlod3/hVtIkuFwmXAw6oTKIxEsuBiErNmjWpy8Xg+UE4HbopQh3CqLcZcEVDOzsUrEObOt+A7z3+yUmel8kVt/sEliXW/3m50WdEmA4GHkN89piOzPGGtih5a5U/V0pXC0EFkdqd+KtXKQNCuYLuEJcW9B6eS2HF6X6NmXARzQwxjTAJhArrsh/k8y7v9Zc3BuikEt6HMbSnvNmQbpVk2yL7ntSiyha0+l5//cN0H3n+BOgLGi89TNOUXTM5tHrnca87BwD4fZNV/lncWQIAMUhBbCYbgAyLcJ74LjmuFqlrLq73VZiABHdWK+oROUM10yjiozKRKISc83mKhFrH6LmFjfkumA37t9ourqtCbaqmSTRmzKWM2qdAmFfp2UqFNGbOJ3U3s/j1j91llDOVJcTqZcDOznua+t+dpYADLThUWxwMfSsZbLM+xFrPvQdMf+MPdQLRD3g53Wt1hM9hp8s6uv+sP2s3dNdm3DbKFBLywt0vAUcV01sewVIFzxYnWYbX3DOqF2gJhDaEnz5tB55U0u9ldzh37WuPh/1mWIcWVHFIVOkJMg7ETHGuysTCAsxHgomIAVRL4QleSUAB4zGCxEMmJpOBFKYCumXm9YQKi2EDJnCxfRaogSoFDQoJIY9aswbEkCCmGmPMBBcpgR4DOXzA7dSb6XZk8u0CJT1BidvQ5EAIDPc/cO6teLhwD8wYx4tIa+IG3DLba4QocAAoCi1l53rnJzzf5+WaP3+zx38Yev8nPN7G7id2/Z+w+Iz932dDD+TkMeHJ+DmPrDZbnUm/Ruf70NJ1CxXFA7s10EKTGlFvdlFeAKyFDU00niKcc7+jWtsvHwrwsv67h3V5MDC1PqYlg6DhJpvH+9vY9mApMNK/zqaxn5zqVvsNbDNu3rRXAI/OLcwBdYRpQw7l3fuzKizop2Ej0YQt4tIBVN4mE3gpqp9bwWvp03h3sONMpQByR2WLg786f6DEeAYNi4rvYXfhA9SzJCLJdmWj+mDw/tdbJYYk8IMcq9a1dC8Yz4HJBPHfGKLuKfYlZt1196UJ2sZNgpdZcWuwMhzXZG8ENlAT25cX3P1z3X7ER5poU62mMaa6QWBxAtJyDixCW9bJGPk6i7cXodDQmxnuVVyUYO2wYgcDsvboUgt1kp41PAeQvAJVJpThJEBDgrA/fZ5YJxa2IcP+rF5pEx5Oh2gYNbfPKvFe011FRIJU9+AVP6++Vxw4lQpDEPRvHOBGpxmM300wuXpLrpUz8I6PmWWoeUYtfLXBhVXsT2HNfAQQwkuBRTNp68eKWnleihxUUPEGqizygJhwf1RdcQWa1F/NRoechvSof79X1WMJGWp3GLG6xGPbBKGTHLBhrHYt/MYaug2FwM0ohil7M1h0u6lFEeM1GiSXPLulJD9JC4u8EAkNZZ+ID3JYpK9GQsKnQhuRHsizE/Ef6YwQfKzLT4xvYPXFkqIP4xTzjgh4u6FkMiB3/dnNCx8JjjiAD4YB1gIPC/oQEjtES5llaK1GdyG/THNwaAmCVqMTTffvLfgFw7hOjL3B0PgYgGLPq/JUf/M4cLTonXVZW1g9Y1OAyv5GGjXFBb5bfvB+Fm+XXJi9K3CvaJmcqmn1plH4ASb4e3P2LEG+DNN8i0rg8F9uPpXv8R8WtvMrNpYWLyZV7yfmN4vKFYncXOL8KvOYmb36Rt3wPt3QNt7gPW75b+vjlz+Ju40MXDCu3E9bcHChdHFh/rB+Dl4zoyqsyZNjcd7klak/lwE/4lnCPyhMo/rLbn4KVyUwjniBCEEIGYymomTIVICrk0VsYpXpCqAbFA0IplMxEaETHggyYn0P5KyOgV2fXUK0qsLPBShWPnwDVT9qVrJdguXN0eXaYhQGko5NJqvBmGjCRThiHYHskVkIZB6mFdChclcgk05QU57MyfMMgRFXUqWYzk/hsiF13iVefa09cCyIidi13bo972WvAtUKQCxFRzOK4ajHzGG2IQ28soindoAe2oPItrfDjcX+JIhBT7s6uNqNtNynexrFABAtH6wytOlTIdLUdqk4IgBLdgxWnuoo/LbVw5zh/1/C1/lEot2cjje0pdghR6NQWf7bUvqmtLrWheBtjSQ4D7u+xi4R15xwfwwBsUdx8KMpK+qtaMIG6SVSb/yKwi+FeX3h0aTRvVyy/l8FK186wHaq1Yz+UugbnZ3Q2b+D+6NXENkAMv4OH+HO/9h7+h1/01DohDKLn97WsnYjAR3SzZG9VruM+oJjz+f8BMxlwRg== +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +
+ +Non-Employee request creation object + +
Schema
    nonEmployeeSource object
    data object
    + +Attribute blob/bag for a non-employee. + +
    approvalItems object[]
    + +List of approval item for the request + +
  • Array [
    • approver object
    + +Reference to the associated Identity + +
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/create-non-employee-source-schema-attributes.api.mdx b/docs/api/v3/create-non-employee-source-schema-attributes.api.mdx new file mode 100644 index 000000000..b7a405287 --- /dev/null +++ b/docs/api/v3/create-non-employee-source-schema-attributes.api.mdx @@ -0,0 +1,84 @@ +--- +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: eJztG2lz27j1r2DYDznG1C3b0peOYjutd3LVlpu2tmcCkZCEXQrQAqQd1eP/3vceQIoU5WPT9NiMkhnbEoF33wTuAr0UhqdSq9M4GAaRETwVH7Q6WSwTvRLiXGcmEufRXCz4KE2NnGSpsMFekPKZDYaXAawN88XsnZyKaBUlgr3nis/EQqg0uN4LYmEjI5eIBpCM59Ky0adT5rBZxpkSt8wSEsZzLGyqDauAd8Q02Hgu8tWpiOZKRjxhii8EW2Q2ZRPBMiV/zQSTiqW41u8DBsRimVqWao8bUNfQ3sp0zrhi4qu0qVQzB/lWJgkzwmZJimA5uwp6rVaj3ei1BuxMTIURKhIs0mqayCi9CnDxUitLeNlC23SPtVssAgr1Yo3OsghwAcmOoJiBPjxNWwleaCOAKdgDwB4mClSxkCm7kToh7ZbpuVJn4tdMwmdmdEI0p+JryvSUfZGxGiphzdCh+wKaXnIDAkiFQX3fBRJVuOTpHB6hZOCTky8Y0F7gKA+Gd0G6WtIz4FPNgvu9wDikYGapyUTdKHL9MomAxFcOakcIYto9nA563d6BGPT6+51JfzI57HV6vL/fHRzEh8H9tQMubPpGxytEvomLWARbhEd8uQQFkVCaP1vEfVenWk9+FlGKzBt0kFSCzRdPN3mrsQJPUZhoeoWeG+yjSlYMd7IX45O/jV8w8AKbLZfaoNrR2Gu20agIAnehIBM+EcnTZLzDZSyWdpnwFWDQzhkuTglXik64aftVfKMo0plK2QfUMuAtfI2+eFoMgGzDPetCeV91WDJ+560VUrgjpaE8KXORLMdgs09TgSsZmfdaEpMVSGFDtvN10IjBUuRUAilOUECwQ4+YAUQk5jqJhXka+Z8liI+Qg8embArualEBE/21iv4EzNOA/3oSMgufSGKFqnIJVD2pIGCiwZO5qlFwChJHD3BxcDPUAdwcFmHiEE4URFzhI66tRtAyyQj1vkLLpaNl005yewUnTWVK3JbzSzWzkP/e3zvALlyR43VaLfxV5c3tZcXmPISiaL+Tw8t4m5JBVAsOsIOLi9PjDTttt1utVj88aPf3w3a73woP2wftsD/pDDqiK1qtw15NRzU+IJKCAOzKQvR/ho7HBq12ut2lUccLrmKearPCGFDXsVNuNdiQeveChY7REx6XAsAWYSpJ11XKPs+F2m55t9yyhFtMjA5D1R86rfYgbB2Gne64fTjsd4b9QaO93/kHysVr+T9CUsmCHiKm1xp2+42DA0fMQxlBqGyBLkExey84Ho1P4Nfp8cmH8en47/Wa6ATWgy8uweox+kDVgTSmPpMAO3xbqQJBQUB5sCVNPMfZME/t8skun/zA+cTnkt629HGUSFAMOzEGKA2hhk8zo4Bw6YzKV5Qg23iFjEl1wxP5PZNLLFIukyMdP8P430olwpnhEikURHIEGxlAvJExxgtqDBzI3C9oXdUwqD1gb3jMzjx/R54ZdEjDo18A1unW4Fol6MJZVr4FrLyw7i1oxYHgk/3WoNOb7vc47xz22gf9yWDKu93WoD8YIPaFsBZ6xlKhHXBj+KqG+k9CCSMjlmiwCflPEAhEbZA9EUDIYYuE3Gmf1gHBeGbwcWsLNj295I974Gtvjj6x3gFkNTXL6Hs+2xCCCi/OsWvKEjDhUpZ1gD8aOZPqsWRyfPJ2dPEOg/vZyV8uTs7hL4RVSyYjBdYao1kCqWALc31LFHsGMNFZkYA4INOx1x7qa2CIK1teKN0nV4iAbU05NJqww2PfsqMMmk0NNDNlV8obzZeyIRp7EKYx//M0mrMJt+uM8npEaS185yX5ms0Fh/j4ChriOJbIJCQA8EYACvtXGO95HKPrOgDTDFzZNfI6SyECpXIzAaxFWdXGOqi8KyuFstVz0sMoSjMgLu+nC3corMWT6PUDNDvJ1bNHLjQS6UqlPEoxBkIPGWljQMIMAhyTqWU+HFE/CYFH5euKiIUhMGeLwt17R8xxqulZxDP7DL/7lED4CV3uyx/cCO98NKNw0Yi0kavJRyR4SAUNbvarCnXljg/5TCTxznd3vrvz3Wf67ubDM980+6dU+rTrpc+F4hnI11DyrJU+hqxHaZYvovLGK3KPgUB8ifTT5zE49i/QUMF68XWJddt3rI9cKq8RPyr04b6f5N1SnvrXukACSY6OgylEIhEPie41xSQoJ6puHdtbbSYSDFRtKRGprF7pjHEQmcmUQkq43WOxFla9SNmc37gmzVoXARGrisOlllh67yrJXSW5y0a7bPSjZKNdJbnz3Z3v/j5999FKsqCKvMXXSTZbLLhZOUvzz5FbzmBB8baZFS5HqtqsVhAYK2qsoFo5BJNOe9KeHkSiF/NevN8dTDvRfof3D9oH7UmvcxCUc/3l2o8LJ6v6VEnfTo8kYijibqCOyxQYl021jqvjPxCvEVMMaxh6iroZZA4ivS5qx86gXjuOtcaDEKu8QrKVGlKtZYQxDdYucK3J19IL/RnERYVjbAl0oSnJhQAoBo8CJPiKH50XuQC4ZhWOpjj3dY6SG1mBRaooyYBCigSJxqpZg2FJHJhP6ViBWVEFO4Po/B2rU6+if6uSZ2fIsTvUcPI1EgIdvajc+9vmu6c4A8cYce4U/MCg13U7XIEBQEPgYlZRd+7q8119vsvxuxz/Y+T4XX2+892d7/4+ffc31Oe+Gnq4PocFz67PYW2jxYpa6i0a13+9TCdX8RSQeTMdRZmhcXNeg1NdAaaEBC21pSCCp1SHQbN8BCH0p52ad/mp1fumK+NCXj7f7LoCR29mEgAzT9OlHTabd6BGUN99gy9lwx3uSFdK3zYivWjedLcEJTw94BwQwlqcRTSMxgPQDkmDhG8k2rcLhoTAqYLYRUsGldDY+FH4+amYFfDGHJg9PEXkbY2+BjKX0Gi8sLS6QbZV4xF4uzDJ/VP8/LX7GB8OyAN8bBPfo7hgPQMqN9hD8q9RXWAPAIj0dQH0HLkoNsrQBC6vy2vojIijsLZynYmw0+vUCPqIyzrsjeAGWgr38uPlT5/Hr9gMa1WKFZnFMllIbC7A2z6BGVEsHOUvAnATpSejs9mcmBtVXrWg77FpAkJhV+pcCHZ56gX1AZLEGUR1EjtuEhRIcNf1y1x7sbgRCebPxlraaJwyVk2QYpNX9r2iXElNhVTuBB1827hSITuWGMIk5nxc41mkHpFdLnO+eImvbyXiDzm00EELCZp9tUGFE+1l5I7uRBAAEARPLEnrm5E7eGEJHnZg8A1C3aQBJeHpqL4gi3KtfTMdFXghwqvScaU+zyUk4uo25uIes5BHk5idsmiutRV/ZAxNB13lcpaBp30zWbeINCSPCDutEkmhQxnKEMpKou8dOIZyxsQnmNapqtFQ8KnYue0X0izEhS/QdMfsS4Vn+voSsi+ujHVkv5lmRBgiwtDFCevpd8kNDQt8G3mgOOAM4Gitf4oEntBSXHSwtkZ+At+kPZg+IiCVoNjl0H0YroOg/4vRA1xdrIEwHdDxRP/KEE/QeViY4SrCyucJmxKs05toSKwbcnP0FvMsTLb/b/wix6P12AUvUHzvKP1AJPn/ibv/o4i3izQ/YqTxdTKOL8/WF6ZO8o6mcCt/hNwfDK8e3K6d264epi6fpX7mKeiNQ9C/5fDy5q0yYA59iVjx3VLZg125Wp9w4gh+LuAnPKUwRN0G9HLuMiASWwYD5KbosBSworkUNBtZCp5i6buHTqMX7jKf0RjZoAMmQDO6XoD3+zjIViYAr8E+Q/OpgB+DjSeeJgGoP2vfgZ6DCX1CC2THuVVCdbhYgGzSFQokw/ti7CnTjaWNMhdhoQ9VIudMU41a7MrDDfoEiqJB2jYL+3GKQ3Toz0sW+gQuMFDrJ+ggSNSIvy24ZuRMuMuJuK7afzwFG9wiRDuj6wtAFjSyJQzvT8c1iABM+ZsA2syafpNt4loAgr2eM4ZuAxpeOpkPTST06SW4R/mdUbyuWru188B11U1ru1u/VNjdhP193YT10RGXNJc4IkUzyVyH62YNl8G2WQNsHdbuyJbHDdCcznFkAfvv7nDKhr33PX4NusMRzuX1urWmFhccAf+GsDeFHLJ5m7ZsYy89i/ErspbyHdut/OSDYbVaz4QC+PMXgaOkgo37a7o2wylkA0HusX/FFI7dzY18e+3dGU4c3A43RXx07XVpsvPpI85Tg4m/57twQyrDbzEVwM9hcAX/4YNeusiCl4Hx+7sgH/nCGgcX//0LylYIJQ== +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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` + +## Request + +

Path Parameters

Body

required
+ +Schema Attribute created. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/create-non-employee-source.api.mdx b/docs/api/v3/create-non-employee-source.api.mdx new file mode 100644 index 000000000..ba0731f8d --- /dev/null +++ b/docs/api/v3/create-non-employee-source.api.mdx @@ -0,0 +1,115 @@ +--- +id: create-non-employee-source +sidebar_label: Create Non-Employee Source +hide_title: true +hide_table_of_contents: true +api: eJztW2tz27gV/SsY9cNuMqasp23pS8exnR3teG3Xj/W0TqaBSEjChgRUgoyjevzfey4AUtTDttZN292tnJmMRAIX93nuvRDwUNNTkfJMajWIav1amAqeiTOtTpJprGdCXOk8DUVtp5bxsan172p4FxQv2akciXAWxoL9xBUfi0SorPZxpxYJE6ZySmRB9HoiDUvFP3JhMnYv45i5ZRhnCtREQc3YtersEkNlKjBHg3KoVSa+ZkyP2CcZqb4SJu07Ap/Al6f7TkezWv9haeUFZh15tzZelxwNMbXuKWFZqCFLc7FTswtDHlDl02ksQztt9xdDpB9qJpyIhNOnbDYVWEwPfxFhBkLTlJSaSWHoreKJqIwyWSrVuLasozOMIhHXKQSDxVeOhzT/UmRcxrXHJQIv0T+ef9toGWd3ViWCJfW9Eumqms/p8TNkn1eQjNaxP9JpwqH82s3N4HhFnEEEy8hsxmS0yHcr7DUPGgfd/Ua72W42G43mfqPTGDb2Ru1OR4S92uNj1dJ3tDocFrTs9IrnDyJ1Y0R66byEpE9KH7/V6edxqvPpy4q/ngg2OGYQh2X4OKfB7gsieMEz6+dcKlP4qcmHAY8SPFkQsNlqt3o9YgdOmeovIjWrBjmVxgZMOaRiBZ6mfIavMhOJedl9f0fW+TpwIrVJOWGoc5U5WHpWRW6gN8z/maaajWUyLsJ3HGotcruevAOKywoKPz46omaqlXGqaTUaqxY4shgePQUaG8Mvj+PzEXivfvr2llqXSpaNxhvtRnvvoBV0RYcHnc5oPxhGYSvYC8Ves9nqdnphkwzgpg/WcrG4qofhQcS4MTqUVmH3MpsAM5BUX4Txwo32DsJuqxfuNZr4FPK9Ua8Rwq/axM1mCcpzQoNfycsrM9dqJnrl+utS2uMzPn2KuAe3LznTr4HhV2OLe7uqKqHyhML2h/OfTy7PDs+OTv7+w+X5zQVeDY5Pzq4H13+luJ0roXy6HolGWI/JkU1VssQmYys1REc8f4h8xtmYpFJcQa0uHT6BQG7OcaaviX8ofX0EPomNC3bswocbzW7Ubo0O4Ma82T1oej9vd6OWeMqqBb1LMRKpAM+38B0E4eO/ky62Fv2NWjTREcn+PNJHwJAgkyuprl+7nQhldVb2LdywmONDQXgJaBvNXtA4CFrt6+ZBv9vqd3v15l7rb6Qa16x8U048yed46DT67W59f594eHx8LnlvAHJhrPPo5GtGvhFvkrhOxZiHM6p8cwOYpvLXYbJho1QnVqCfm+zwYlBntj/kGQgNc3SFtkMckrwJnDFy4zkb5VmeCkYw6psYogECjKvITVI6o4moHAy8GhUNpg2hqc/gkIUTrsboLs80C2MJx0GlPdF5HGGhGN6vXBoBxzy+5zMDSjRtikIGgxc13aO/l9RKzni0pDdXG3XWlkOWKXaSptBVgCYY4iqI4GO32q1S/Er1hceuAPlGjWpk8/ORjjaoBt5LJYJxin4FHArLcoiJjPKcjEhviU4p1xLJwlZ23KIioYl6k73jEfMVJDvywlDEpzwk023ibzdKYj4rpgBhypZrzbJiX/DhXqPX6oz2Opy3DjrN/e6wN+LtdqPXde1VIowBxFehvID4xaV/ECiZZchiHcIi/xTkUBy6twzYxTfPCpbGBvqnrtKNnXeWjl9GmyU7cPx3Rxessw/MUuPcPufjJSWo4OaKSv08jvmQHtG+ByR3hM9TOZZr67MiRR2fvD+8Ob3Gk8uTv9ycXOET0VrZ/zlU8NaI3FLbXYKJvrccewEIz4yIoQ4AGnvrqb6FQBzdcGWgdN/MzECZ8K0Rz+MMM/zqa2ZUSc9xpwilYmfpe1kX9R3EO6E7z8IJG3ICLe1w9+1hGIppFpx6Tb5lE8EBL2/q7DCKJAmJNIpoBFHMnxEE8Sii0HUEPHJRqarzjFBKLtemc1UuWmMOL6dVo1BwgPOX/eQwzHIwV2ygleFQeotn0dsHPDvNLXJ3vZR9zExlPIQUaLhmUGOaQsMM4M0kUNXDEZnLAHhUMa5ErGo2t3D3k2MG1YR9F/LcbBB3FzHgJ7CilS++CB98cAPt0chaozCTRyS8JLHtZD+qNFcR+AxZPo62sbuN3W3sbhi7yy8v/SaQf2tLn+Zq6XOjeA79pjZ5rpQ+qfUepVkxyG3fO0PuUNviS6Qfb68R2J9RLmO8+DqlPa1vWB+5VL7C/GFpD/d8SOVHaawFWxCDVo9OghGQSER9y/ecY6sop6r26mrvdTqUcFC1pkQEaqZspnPGobI0V4o44WaHRVoY9V3GJhz4iA4W/DoEpFVVFEy1dBXutpLcVpLbbLTNRn+MbLStJLexu43d32fsPltJllzZaPF1ksmThKcz52n+vd2xZxjAip8jWRly1lTL1QoRY2WNVVusHGrDVnPYHO2HohPxTrTX7o1a4V6Ld/eb+81hp7Vfq+b6u3kcl0G2GFMVezs7WhWjiPuCOi5XcC6TaR0tbv9BvakYEawR9JR1M3QOlX4sa8dWb7V2vNaazunMigrJLNSQaq4jwjSMTWhsWozFAM7GwEXFAFUSfJEryUSASkqneWKZSBu8JAXoprPgcJRBFBcohZOVq0gVxjk4tEgQa6qaNRxL0h7uiGo+ULAV7Bjo/A2rU2+if6uSZ5ck8SlJzE6+hkJQoJeVe3fd/u5AuV1gduUM/MRGr+t2uIIDoCFwmFXWndv6fFufb3P8Nsf/MXL8tj7fxu42dn+fsfsr6nNfDT1dn2PAxvU5xtYbrKyl3pNz/dfLdBsqngPr3kyHYZ7a7eaiBrd1BVyJGJpqY0GEZxN8262eVAv8qQi8doW/YylPY4ycZNnU9Hd3H2ApWOixzqeyXpzXUfq+Hupk90t7De7QAQEXY0CuKA/tfjOdlXCL1K1+U0ku7PDOLuC0bSUiZ4XW7c7ws/SVP7g+gxzMkdlhcHfvTvYx2Jyil/jO2NF16z4rMkK2mzR+fEmen9vPyeGIPCHHOvU9uxbGM3C5JJ4/92EETA5C1l50wvbIAdVhTla++1gdc0WFueNwZeQ82VAz11ph6JyGtdg7wVN0De73je9/vL1+w8ZUjlo4yA1VwkJS/4CAuoAbWbg7LPb6aZLNQKnOxxN3cmbh1xQKLzaKoRT2QV0Jwe6Kw1VnyAOXAG6rdpokLFbQrI/fF9aLxBcRU4qsz7VNzikjtQst7vKFeW9sOrR9g1TuCBSe1j+ogB1LQilJaZ3GeBFtG8jupoVcvCLXa5n4U0EtcNQCS828WeLCqfbOHRmic1dWLTw2VluvXtzRCyr0qMnCE6K6zANpwvOx+BtYWFjt1Xws0AuI3iIfH9TtRCLXLk5jDtqKA1QDFk60NuLPjJHrUKjcjXNE2qvZuqdFAxsRQatRYSlwSwYyQOVo+TtFYCjnTHxImdsWLho1nYpc2H6ylgUufLJHxT4tyGwf3yHB0shIh+bVPNOCAS0YOJwwnn+Xv8ix6MAfZPAn6sgBjub2t0jgGa3goqO1Fvkt+V07h9JHCFYtFTPtuy/9OQj6T8y+oNHlGMA0Fd7lr4L4zjwtezK2qqxiy2BZg6v8xhq5c0lvjt9yy4ry6W9NXpL4cL6zcq7i2bdG6SeQ5LeDu/8jxNsizR8RaXwpTDuUlTtCJ0XTUlyPLC6HvHz5o1a5hUhnzje4KfXEzb3iKt3CTbq7jal+XHNr4FfMpiPziEFrC99IVSPflbmrm5+0Oz8Rxh58tvBlGxG0ecVNGLosNCczjXlGgW6BLpxIYbdNpoJnVDLvULDpxIITNECIiObYEhrbA+YprMjR6MoY9OrsFn2pgsgp9aR00ARUf9G+Ob2C/S7Ic9lx4c2oKpMkV3TiH0zkCeOImRdcPpImzB0yo0VVopBM29q2nFXAFMUSqcJe2xNpYs5HtL+O1r3i2S+sBcc2fnMdiqw45VyQSxHb0KNxi33LS7QRTsFExFNyQ6QVVJhVt/9pcL1CEcSUv7+k0/Gun2R2aSyI+APwmNCuoxemR9RfwsUrdN3dOrZwaa28yr10/ar8UeE/e1Hb508asjulDT3iPHfNmuuM72prO2ME2oQaaLx/eKA9H2oTH+kxGKUNhbuP8y7Qdl6YYPd+bEB+FrTn4H9sCOx1lXJzYfVXFGpM3Qy3n/Ts2I+VHv/inHbWakN/Dz1x2xUpv8dD+r9f+4B/hF5T50gYZJ8/1IrNP4xxdOnvXxEqHMY= +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 objectrequired
    + +Owner of non-employee source. + +
    approvers object[]
    + +**Possible values:** `<= 3` + +
    + +List of approvers. + +
  • Array [
  • ]
    • accountManagers object[]
    + +**Possible values:** `<= 10` + +
    + +List of account managers. + +
  • Array [
  • ]
+ +Created non-employee source. + +
Schema
    approvers object[]
    + +List of approvers + +
  • Array [
  • ]
    • accountManagers object[]
    + +List of account managers + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/create-oauth-client.api.mdx b/docs/api/v3/create-oauth-client.api.mdx new file mode 100644 index 000000000..2835b9a48 --- /dev/null +++ b/docs/api/v3/create-oauth-client.api.mdx @@ -0,0 +1,83 @@ +--- +id: create-oauth-client +sidebar_label: Create OAuth Client +hide_title: true +hide_table_of_contents: true +api: eJztXOtz2zYS/1cwug9NMpKsly1bX24UP1r1HNvnRzNTx5NCJCShpQCWIO2oHv3vt7sAKVKiZcdxL2lG00ktkeBid7GP34IL3Vd0KCIeS60GfqVX8SLBY3HKk3iyH0ih4kq1YoSXRDKeVXrX95UrI6J9rWLxKe7DILhWMWFP4wM1j57oTbniY1G5md9UKzEfGxxzioOZJWkqcMMXxotkiBPDtJcTaZid2zCumB1u6dWBhUj8mQgTv9U+cHFPX2UkgOE4SkS14iFDwCvc4mEYSI8E2vrdIPH7ivEmYsrxUzwLBUynh78LD0ULIxQ/lsLg3WFipBLGnPCpyI02cSTVGEarJAj4MBDptMsyCKbgSaZHLIbPKTX60j8bOOmZmegk8NlQBFqNWayBsPjEpyHSrfS9qahd6IBHlXm1MtFTEYIur6LgefykBNjV+THjxmhPgop9didBvciXvlMiSjleMFngaRLHYW9rK9AeDybaxL1mq93ZRv7UsxTVZ5MEbKQGy+3jKKu1kY7WMXEgpjp/b75E9fOZyH1/RAF9RXesObLEgAJTbtHudST/IoP76GlfVFkkRpEwk4+x/kOoKpiz7x79CBbuw1/JA8NGgb4zKAb3PLCSSxz8Cw+kD552IcCifbLJEhtLpkO7ZsYOQ4exRBhNycZCoU9nbIJv5ewPvt3iPHgTxHRqk+BBY4EX4PKUx/ZSu5VXRHe7MUdfJPG+iOFUR89hOGNnd6fTaDwuALHsQ7jw4qtImpyp8CjisxJLkbGYmlWTWjY5sKFAmjg1Hog8kb4FGdLZwOkGps7O4Kr0wdUU/IvYVEeC7rC7CYgOTinHSmIkQAO8uvzp9Hzwa/9ycHrycf/04JCNIw46QE5AWaA5Je5YPprW8yq5fshZb4B5onQJhD5LB0WRaeYW+5GYQloLC8ocb+E4+8eDw5PLj/vnhwfwd9A/vsDbYA/IaenNVQXAxfPDo/PDi58+Xp7+5/AEk0csY6L/YyrRurWxymrVGzlVmhUj88CJhsI6N0bHolZL2SoVYInXhX+TksrcI3VdXOFXWgXS2okejfDja2teBWYLOj49OjoenByWrYNT9OmJG5AOzWmwv2BunlIoY5K4W4mS7FWYDCHdIr/g2SPpotvrohWcnhwNnIrWsLk07Ozq7fFgP8+rnTPlFf09UjyfGIdaB4KryootKCaVj6iA9IqOB3Isp5uCCWAccqDDsHQqMgyp6DnwdT/xit43grgu5igRepL/cpzB6juaxBhwmJ8WHRZmBYUCoEBjv0jCUEfxS3JgLEnD7CyU93CtLdIqU4IXcDk1fycreB3QKNiby7/40EX/3TGzc9sAm3n0A/maEnGZAMbToXh+tkDpRjwJMBEBQiZqpseDYDVWXdC9Vfeqs8GIKc3oWTQCEwpPjqTwqzTSAZI7GQRouBY/54R1DLjnPxTZ+FCpM4LdU1iLFZBKNCf8FjQGH/BmJMeTOGPS4sa7ic5mlcuZyAfE1uOhdGVBjabujWRkYlJO2V0LECBszqs5kH9tgWZRbWuBUyHZFULwwjvzkcVWPf2s6jm3rl+Zzy0nJtTK2LzZajRWQ6QbD7YJMwHG81EXL1SVSL/cuPLzDw7ShclXToUo3PL2mruN3fa23xLbzZ3dRnPbb7dGu3sNjze3d5tolqD+SMSPT3dB48qmZK/IpsBGocSBD5DPZhBI4yRSYCPaxk5JScJZDoTdIKgXM8a21275/t6w1eT+cLvpdbvdvY7f2RHdpi+azS5v+g3fH7Z3eHc02us0R7wF8nT4sOuLljdqoyyPFXNfu3j7Zoq1r1KcbYqx9bUNlFpPrGy+t2LsJYuvz0/+zy+gNgXTpmDaFExLBVOs2eDgZFMjfa81kgP/ZRk+C/w+jKjFcgXAWz/Bu5SVcUSV+YBx0GqQjynUINJmqarlc7lI4elLA78IdRvNbq3RrTWbl83dXme71+7WG3u7v6IXTLVPFdRXZDngEGeT0C/je7fW2Km1ti9bjV6r1Wvt1puNDvH9DVSjf195J/1KVnwsIfcijq4+oxJcB5GW0Mi6sjG2f7Ioughh5WFl1bsX7pIzw3Rl11ejtv505WinrAJ19nUYRRAYauw8LbmkXUYXmtlQ+zMMlVIRinvBMtUXMZfBPkSLx/H+EaxvDVQtkUNBLFOYCWmrHDfDaZfckkwtkcYVjBA1UW+yt9xnaQG+74TB3Bxx7w+gNXhC/XylJDzP0keYXBQVJdOKruDDncZeqzPa6XCoPTvN7vZwb8Tb7cbe9t4exRmwHDDaMqRYnPpHhNuACAhwyr8IwnLQPTFAk5eA4gfWgGg8sdq1YzMxHb8MX+xCmcTe7p+xThdilRondJ2Pl5SgalcXKwEIJLeETyM5lqWlXwpfDg6P+lfHlwQB/3t1eAGfkNbKu+HllDfRd8SxEwAjqhEBqEP4dfbGUX2T29ZyA6XLhjMDykz3xuAJN3vJE3nSbBTpacGVPPsWnL2SdVGvAhCCa5A+vAkbcrPY7HiDiDGMa8dOk2/YBEprEb2us74PsQiEBKAE3ghE4fkZIiru++i6lsAoAVcWlJ51EjOlAVGI4losVLmcDtKYcpxfFHQO4PwJdbkXJ4jiUMy8F2bWItMNHVof4NlqrsjdZU5ppNKZirmHuCgIZqDGiOq1IcgmAbG4cETbnRB4VDoui1gYAlOxKNy9s8wcxJrueTwxT/C7M4jOqkaiZTduhXM+LN5dNKLVSJfJRSSX7elhNypbrtTx7R7Yxnc3vrvx3Sf67vLNFPe4uwR9mqvQ50qlFQsIsQJ9IrIepYtljVvIKhbiDiL9/P7S7YBhKfkpRHD6gvjIpvIV5vvZetjrw7QVIE39i7VABkmPVoIRRCLh94jvBcekKKuq9upsRzoaSjBQVQIRIWpGbKYTxkFlUaKoKYEbLHCEUT/E7nVQurdp91iE8muhlrY62CDJDZLcZKNNNvo+stEGSW58d+O7/0zfXYskM67IWxxOMsl0yqOZtTR3H6XlDAawtAOEZS5HS7WMVpAYyzBWpYgcKsNWc9gcdT3R8XnH32nvjVreTotvd5vd5rDT6lbyuf564ceZkxV9Krfedh1JxQDibgHHJQqMy8Ra+8XtP1BvJEYY1qibNMXN1L0zv8mwY2uv5K2W1uwdV7MUIZkChlQLHWFMg7FTHJt7JQSqHENcVAxClQS+0JTkVAAVfNvMAjmV5LwoBdCNZrX+KAZRrKOkRpbNIpUXJMAhRQLXjQGGJUFIMULMBxQIwY4hOr8gOnVL9EVInp2jxMcoMTv8ZDuGWIbct8v2dwfpK7ULu8APbPTaaocrMAAoCGzMynDnBp9v8Pkmx29y/PeR4zf4fOO7G9/9Z/ruZ+Bzh4Yexucw4Mn4HMbWGyzDUkfUEfH/hunkKo4D26CvPS+JaLs5xeCEK8CUkKFQU0tFyPG4bWUrf9bWUN8EAkLLS4K9xtTCaHpbW/ewRLA08zoPZd22msUzpe/qnp5u3bZLAg52Bpj8+RbcaMYWEDtJnRQbSbRdG+hoAqvmrL0E1E1bwmvpp83WM51AaCMyVWyac3ZEl4HNEIqIHwyNrpPdrMgIsl1FwfwxeX5pr5PDEnlAjjL1rZ0LxjPgckk8ZP9mcZr6AtG2nX3lTPUig+Bat1Ymc02lbwWPsPeLXlq8+vn95etc8y420YyZkNQextkZmAjFsH6+OZnSSqSTse386hdekeynnV919kFdCMGuB04JJxDczyEak0r7hTa3m1fpyvjiVgSY9+oLTaLhSV9tgYa2iu1xrynHUTEglW3Egqv1D6rGDqhBR2KuxjFORKrt2HWYypVvun4uE/9KqdUstRpRM6+XuLCqvXYt6Mt95M+e3LVK5ejVqB2phlSXebA9jsRH8cVW1q/3bD4K9GpIr8jHB/V+IiGBFh9jNl6lJyQGzJtobcS/GUPTQTe4HifgRc9m6w4nrdno12rkWKrZKWuyBnCQ+DsGx1DWmPgQ0zGhEQ1ATfnWJX+jlQWf/406+X4ryEyXryFr4khfe+bZPOOENZywZmOAcfzbpISGBb5tDx+A01sD2F+sP0UCx2gu5llapVGdyG/RM2lrGVFZ9PwtAlzheBiOLvQF9iqLV314BszRwsxUUFa6D7CswVV+Aw0JcUlvlt9sHwqT5LcmL0rcX2yXnKpg9tJR+oFI8u3E3a8U8TaR5nuMNA7f4rbj+eJ3XQ7TSmT5d1jyx+qWTtU9dFgnPey2cjCtpGr9uw6TrT9LRue71h7ecgeqiqelHj6eVDyd9AUHcIrnb1ZPyyydOlmcKqEzAbmDHba0LT1x4YauHH9w112v+xf2mCNvI02G7UrNfBi19cDq9jC+v5gIQ43vlAtIQCiEF+cj8mTCgMcYNSlreBMpaGMpFDxGLVTRivSUIj0UVKhWYSyhMTV5R+ASPOBDGQC9OnsPlbvywImxasdWHKD6u3bl+wX48RmGAXaQhgaA6NNpouBZNNtkyjgEoEfihy+Nl9g0B4pSIpVMU6GQPZXGfAxMqIo61a/R1JyO8A2E9EQuTDwyF0QJ414/gCJxRTL3TAU5FwE5Go4rFniP0UYDmIggxH0DyNEC++QXM7wbXK5QBGLKgFyeqOtovOUeMls4FohgMW2NoV1v1Bt4CSvwKVc5urZHv/BDLMu2dL943/Lo71s538IKcCvE7UqcNbEVqa37ryvFuv8GQyG4Ady4v8etLCyC53gZIiruk1zfLGpc/IYnkmlLizYK/hC4leLeodTcEQe3Z7L6cgjLbvuE3SZbO/Ymt3VxdoobhpWh+92uqd2FiTgeJsL/9yof4D/4okO7+jCIrt9X0j1NGGPppsizDHi5DyjmfP4/kPGq/w== +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/create-password-org-config.api.mdx b/docs/api/v3/create-password-org-config.api.mdx new file mode 100644 index 000000000..be98d2c2c --- /dev/null +++ b/docs/api/v3/create-password-org-config.api.mdx @@ -0,0 +1,85 @@ +--- +id: create-password-org-config +sidebar_label: Create Password Org Config +hide_title: true +hide_table_of_contents: true +api: eJztW1lzGzcS/iuo2QcfRVISdUV82aIlOaWUHGl1rB8k1RqcAUk4Q4ABZiQzKv33/boxMxweOtZxsomL5SqZHDQafeNrEHMf2bFyMtPWHCVRJ4qdkpk6ld7fWZecuMG+NX09iBpRJgc+6lxF5ZgII3mYHN00okT52Okxf+1EF0PtRff0SASWXmRDJcblZOsGImYGLXFp/FjFuq9VIvAnTby402kqcq9EovoyTzNxK9Ncta7NhRU9JWQvVSKzTEFs49xndjTlro3PXB6TJL4hJjYXI1AIrzIm/xToj2pUh4Z4Jp+CAMT7OsKguo6w6Jn6NdcOKpyc/fif7sGHo58brJmzEMM6IfNsaJ3+jS0hfAyTCtsXr3RiOqVMTWjcDBp37pzO1CvY1Ks4x+cJ7HofXXrlYNNMfcm6YEi2fpJBdPMAozvIpnz2zibgcs9fISpcSdI3opgYmoyG5Hic6phlXPvsyUf3kY+HaiTpUzYZK3jN9j6rOINoY0eBkWnlafRRg9Wm9izMIU00HwhHJqFlYae7oYL53ZPuEn1ES+6UQPSosEZLXAznIoFG+zL1qsXL8UjU4SeNSH2Ro3GqggkeMK4HOruwvyjze4S+DnwQGmB0Hf2hch4UWfVBmzwLHijk1XDnQDlw61s3kll4tNleUIBFKdhQMM6Lr40YBe6PiL1NIoNEj/JR1NnAZ/klfN5Zr+myXdNjY31Gi2NlBhTHXyd8yrOXiP6IvDsz8u7U5N34oSbvTk3evQfIm+mMPkeLNe+hRvpkCoRUWxJm8wMLft1oLzMY5CLJUHHGWCb4v72+Tv/N2ulM9ZVTJuZi+Fh9jVZVYFUFVlXgT68CC+7be1GNKO210Q5VYGtZ4u+nGvksDp1DbDbFmUIQGsAn3ecyUIAC0QMqIKtoAwPp5BuWgkRlUqf7NlE1WhhFm8GCH99ro5oDJzVJqFjkGBMFON7qBDPEyDryJbEkV5MKTEcCV8YnS7Q2xDuZiLNCv/1CGXKgk/Ev4HWUPC/QpdGYL8opQgN3QqhHllW7SvZ21vfaW/2dLSnbP2xt7G739vpyc3N9b3tvj1YfKe/lYCZHpXNysrD0j8oop2OR2hge+Q0GATqG7VkAXhxTAO5G/nkfMI8X2J/ziGkrNQt5BYHNhpDi3f6p2NoVqTSDnJ/LwZwRTPPyHE9MnqYUuFW5CoxPHOLXLBNFGUq+q+jg8H338vgCT84O/3V5eI5PxGuhbegaRGtZdRELQ3vHEhcK3EkPGJ/CHFRp3xZc30IhaXydUIdvfuJhzLJOYEax+pIZddai77A11VMpDshcvNYt1WqgCcEzFK94KHrSYwJcSORvu3GsxlnzuLDkWzFUMlHuTUt0k0STkjIN5cpj/oS7mSSh1A0M+jnvJ3caLUWeCWMzHatZX0xNOeuNaRU7rjuFkgOSPx8n3TjLIRyrWc/CKloKEQv/QOZguVnpLmpGY5NOTCZRKkGZTmBG52Bh0YNuOvOiKEfkLo/CY0q6qmLVizOXuw9BmIPM8lgsc/+CvDtNUX6arFo1cKuK5PMEn0I1Ym+UbioqUoGteHJBVbmrTPzQN65yd5W7q9x9Ye7OD54V7U4xytBnYxH6XJryuAVKLECfAMWNnTuTCY5s0GFNAZF++ngRoCRD9y9jOjT5hvgobOULwncrf4TnPYIflbNmfEECsh2DBn1UIpV0WO6pxGyoYKrNxdXeW9fTCFCzBCKiajo+GZMwmcuNIUmkb4jEKm9eZWIoUR8lMsL7UAG5xUmaYwu0vkKSKyS52o1Wu9H3sxutkOQqd1e5+/fM3SeRZCUVZ0uBk3w+Gkk3CZFWjJO2UoBAlAfvoko5dtU8WiFmosJY0SxyiHrtjd5GfzdWW4ncSnY29/rteKctt3c3djd6W+3dqL7XX03zuEqy2Zyq+Tv4kU0MEHcLHJcbBJfPrE1mj/9gXqf6VNao9FS4GTaHSW8q7NjeW8SOF9aKD9JMSoTkZzCkmdqIahpoR0TrSloQSDFAXTQCpUpDLgolPVLg4hA0ItUjnZWH5eDrJs1uP4MqIVHKIKtW0SZOc0jIlSC1hJotAktDSdUnzAcOjGAHqM7fEJ0WLvpdSF6ckcbHpLE4/BIrRYleIfftZee7RxDeUY04Dw5+5KA3dDvSIADQEISaVeHOFT5f4fPVHr/a47+PPX6Fz1e5u8rdv2fu/g/4vEBDj+NzELwYn4O2tS4qLPWef/v/s2E6p0ohQbisYOM4d3zcXGJwxhUIJRJobD0XEUmXAKK1Jdf/Iro4SLAwSJS7FITDLBv7ztraPRwFBz205Fi3UL/gq2xi7F0rtqO1280lZYfuBxS3M51Nwq0Gvt4YFmmxeZ2mCA7ljhcIxi6uU0QeRueD4Sf5GzliL05sjgLHbBoC0V5EEz+GmGO0Eq88U7c4ehZ0hG6XLn14Tp9/bz6lR2DyiB7LzPfkWqAXkHJOPRL/ZnrP85wwd1h94bbndB+hPm3xNswJkbXFOyUdGoLw08Xrnz5evBEDQpqc6bknkKs0X1WS4hQhwpWsWx7j0yTeXJzNB0MWvDvzQwlljuinUFhcm3OlxNVRYYSfUeLPUJPZpDRJcRmgWTevS88k6laltPu1ppakwNOJWYOF1uTMvDe803FLoE24DISnrWvTFAeaClC4CgaaQkXu8MTVuNRL1vT6WiH+UXJrBm5N5ubfzEkRTHsVh4s3MdKXWMjUs7W+evHAr1njR/0TnhDXeRnIEoUcsz9vxaXXvlqOGX5N4jcrx7X5ONTYRmeniVC1hMcumCbiSMRDa736pxAUOpQGV4McWfTVYt3Rok3OiGZ7vSZSMyzZ1E2AQpbvGIlhQjDJHm3KjEks4JpJQkp+Ys8i5z+hZU7Epxmd+fEV9k6iTGzsv1pmWrBJCzZDDfCF/GFrosCiq2/QIdyp5ADYn/qfK0EhaK3mBV5LqzqzX+M5tDXQ9XPm4sed8KUzLXDlhTkeIOqKBiWYMHX1gx++i4IX7U8zxipPA+YtuChvarEtztktyFudRtFW+VfTlzTuTg9NTkw6+dZV+pFK8tepu/+nireqNN9jpSlQLh0+nk3fWDn8o6/Xry+/Xo/mHXHP+hd9ST3bAmxcPEsMLxvhL0a5ZDCuR9fEfSCDqTqbcSozSi4uLvFQKz6FGCuZkfgNCnA74oIA3E1VSPnAaMAvTDlYTqJv1Cn4tcRHtHkmhq+pxaN7G+D62Ra93jncfUrRIg7KCAKSG41yg7mU7PlISMTpM2GWaA83sGroNIwqNbOMJ6tZZWmg+CVTtLjZcSN/0qfjanTCtWh6Zi0Eky/OqmFI8gjBfuqjKkXOVMpeJbrZPuA53gjh5lClY2oyUcqB6lRthQ9HFwscwcx46IVmHv3WWjHJrxEtmFDPFYJhs4XWkh5Ru4aOuMZ3n90nqvfkTtxAVG/RzYTU/fSMfvW63Atelyu2XuqZ1sZ0zEcOyEMPF/rlq2hZv4wObEhdNYbv7+kgiJrHB3qMSkSnDFc3096QvoFtOBDiBvsXRQcRxS8QzYsJA4nixGHxpxVqV8OMcMj0JO1NrfE/PaHjtqhXvMk3CmcYTt7hIf3tRNf4hy92HNKBXvej5/dReSIImsC3RGzLAEvxgdR8ePgvfRlmSQ== +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create Password Org Config

+ + + + + +This API creates the password org config. Unspecified fields will use default value. +To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to "true". +Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' + +## Request + +

Body

required
    = 1` and `<= 60`"} schema={{"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}}>= 6` and `<= 18`"} schema={{"type":"integer","format":"int32","description":"The length of \"digit token\". The default value is 6.","minimum":6,"maximum":18,"default":6,"example":9}}>
+ +Reference to the password org config. + +
Schema
    = 1` and `<= 60`"} schema={{"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}}>= 6` and `<= 18`"} schema={{"type":"integer","format":"int32","description":"The length of \"digit token\". The default value is 6.","minimum":6,"maximum":18,"default":6,"example":9}}>
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/create-password-sync-group.api.mdx b/docs/api/v3/create-password-sync-group.api.mdx new file mode 100644 index 000000000..cfc7aa3c1 --- /dev/null +++ b/docs/api/v3/create-password-sync-group.api.mdx @@ -0,0 +1,83 @@ +--- +id: create-password-sync-group +sidebar_label: Create Password Sync Group +hide_title: true +hide_table_of_contents: true +api: eJztW21v2zgS/iuE7sNuC8vxW5yXLwc3aRdZtNtcXq7ApcEtLdE2d2VSR0pNvUH++z1DUrYUO02uF9y1C6NFkEjD4cxw5uEzNH0b6VwYXkitTtLoMEqM4IU45dbeaJOeL1Tyk9FlHrWigk9tdHgVVe8YvWTurY2uW1EqbGJkTpqg52ImLRudnjCv0DLO8mqgpYFTGsjG3IqUacWKmWA2F4mcyMRZY1lu9CeZirTNRqzQvwvFbmQxY+/Pfvrn6PjdyS+Ml8VMG1ksGOYy4l+lNFBWaJbwLINGb0EbtluRlCQI+2+jSyvMkVaF+FyMoIF8kqk6rMyLybzYmRfPueJTMReqOLzBeBFd38FTmkrY4pVOofA2qmaODgtTilaUkG5V0Cue51nwZ+c3S4G5jWwyE3NOvxWLXCBUevybSApYCYexFoUUlt7KtCZjCyPVNLof5ZNjpic+dsuYQkh85vM8o3HD/f3uZNjvxv1xuhsPet1+fJDs7cb7orObJH3R303T6K4VKT4XNF1T/S94unGC+1atJtyQHaxLM1ThPdWIyOLkP3JumTm5G9yYsJccdPc7++neYDDmnUR0unuD4eSgPx72OoPdjpvb6tIk4iS1tUm5MXyxNudbaQuadTmjzwDkrFNh2cmxxSCkwtyue3BXM+yqsmwwHHYmg9102OkOh929lPODXrezuz+Ani+LdDrIt1YoyScE7AKhSiHKuEIZSKydq4Faud1wyyp1rWiizZwjTyMaFNOAZmQ7vX7c6cfd4UVncNjp4P8/IKDKLONjkqB0h31znaJqn8/AjGMNlkqfyUzYWciikaIrcKuv222ohY2Z3Is2JfLjOdhIwefKjDtyygibAyw9ZPTwfK2Iz8REGKESQcjYqKZV3Akjt7C1ha0tbH2/sEWF97TCaX1fEDfYhGpHmQRYsdfGaMNidiaK0igkvPSlFygaG4OjETuU6hPPZPqMOJeKgsvsSKfi8QR6I5UAo+SSLBTO5AQDA8PFCOSNQY45lRV6OLl2I2cQiXaXveIp/PX+HQVnKE8MT36Hrqdg1KWSGM+qIUymDOn60LRiT/DxsHPQG0yGA857+4Pu3u74YML7/c7B7sEBzT4X1gJxHoeqn4QSRiYs02Dp8g8EBIWN2DsD3OQbgOqBNXA6nhB/KmAvu3Qz2MuoC2ihOXl1dMoGeyhiNS3dcz69FwQVX55vwhGv+L2RU6k2mSJUOaeKOH79ZnT59gJPzl7/7fL1OX4jXWud00ghW1NKS5iKXJjpG2dxcICgxooM4aDO6GXQ+hIOcfRMNUFpwwZoEUzk1oSXWYERYfYNI+qq2cToeaOUEt8ysR9lW7RbbEzPAHDJrNnEvRwliciL+G2I5Es2EzwV5gXauDSV5CTPGKoRSjF+AUWMpymVrlcwKVHKwvV6uiyY0oVMRHMtVqFsrsYKLN/WF4WKA5Y/niejpChhnHOzXoXLbAkmhvWBzT5yTesuakFzIV2ogifwAl3pAmE0BhFmY/gmC8sCHNFyWQCPquSWiFXfAxzcvfPGHBfavUt4aZ9Qd6cZ4Cd2ri1ffBKh+Cxxw9Bv02pUyxQQKRBHN7jqyqtYVIXPsO1l6bZ2t7W7rd0n1u79l2ehlwtvHfXprlOfSxUOvmjzXKM+xmWP0tXp2B+O3oSFbDEEJFCknz9chGM1yIvPOR1hPSM/8lv5mvGj5Xr452OiH8vFaqwFGeji6D2YAIlEeujsXlnsAuVD1V+f7Y02Y4kEVRsoIlDTsIUuGUfITKkUWcJti6VaWPVDwWYc+MhREdZ6BKRZVRrnWqpiyyS3THK7G213oz/PbrRlktva3dbu91m7X2SSS6tctQSeZMv5nJuFz7TwnrzlDAKs+lSBLUvOLdV9tkLK2JJjRU3mEI173XF3speIQcoH6bB/MOklwx7f3evudceD3l5U3+uvVnW8LLJmTdXW26+jCzFI3CfwuFIhuWyhddo8/kN4jZgQrBH0LHkzYo6QXi+5Y+9gnTteaM3ecbWoGJJtcEi1ihFhGmTnJGsqWQhwNgUuKgaokrCLUonOjmNm6Cw5k3Ppipe8gF6ziEeTAq74QqmSbDmLVElWwkKHBJkm1qyRWBJOiglxPmhwDHYKdH5GdhqW6L9i8uyMPH5LHrPXnxMhqNCXzH130/nuCYw3hBHnfoEfOOj13Q5XSAA0BB6zlrxzy8+3/Hy7x2/3+D/HHr/l59va3dbu91m7/wE/D2zoYX4OgSfzc8i2O2zJpd5Qcv3PaborlWCBS2+mk6Q07ri54uCOVyCVyKBcWwcinO5mRjsb7mXSXRZP/L1JpckgOSuK3B7u7NxipbBCd22eyzYADItVLJS+aSd6vvOpvwF36IKArzEgV1om7ryZLq/6SdouvkZSCnu8cxP4aDuPKFkRdXcy/EX9KlxNWugSCOfUtBjSPaSTewwzc/QSP1gn3Xbps+YjfLs02d1j/vy9/yU/vJIH/NgUvi/OBXkGK++5R+Zfr27gnhPp9rOv3cNdbSTUqPXWJntPYj32SnCDjsB/dvHjzx8uXrApUU1X6qUllisk9QYollOkiIOyUXWOT4Pc7oJEms6c4aPGJyVUOmySwWH2UZ0Lwa5OQhB+AcafAZRdSGmQcDhAo65/rFYmFZ9ERttfexVJSjyZqh1EaIc3xr1wW53rCaTyN4bwtP1RxexYEgK5m9AkE1x0LR67yiu/eM2vrzXiL5W22GuLnTb74p4VPrRXib95k6B+SQXPrIvWV0/u9cU1fdRA4QlpvW8DRSLY0fx8K6lW7avtaOiLSV/Tjo/qw0xiH20OYx62mMU2mKXshCUzra34K2OUOlQGV9MSVfTVZt3QpLGriLjXqZkU+yljGYMVOvveojCUTyY+pl3ZkRINvqZSX5K/upVFzf/q7rL92vDZPb7C5kmSqU7sV9tME8Y0YewxwAb7/d5EiUX34+CDwwGfAEer9XdIEAytYZ7XtRHVnfodN4a2hgSmOi02P/R/HK4ALvzG3AuSXsoAgolULz/xo28RBF20QTWCVR0H3I/gur2Zxr54L27e3uVxFO2V35q/5PFodWryXmWL50bpB5Dk28Hd/xPibZHmz4g0gebS6ePZ6gtEr5/9Am/3G7rAW7sF/tCF59U17M0SCBlVqFup0ELVccET3PVjTzqXnwn8xFsHbq4FQYPnv0RGtK+uJs94QTDgYDCZSeEOTHLYTmS5RaWo5w660CEQXqItdoqmzj+DNeZocWUGfW32AR2pShBN6kbpigm0/qZDW3qOxDylvGbHVa6Dc87npaJvssGIcs44KuqRgkilTUqP22hOlag80475LkdVIEaVRqFou77MzO37CZ2so2mv5f0jcyHtbThWRyBrX5VZOXImMv/tPcg1O5bHdKPY4pnI3K12JC34p6jN8O7kYk0jlCmfsm1tpjthkN0hWSih7tAnQ7+NLth9mQOdJZr3mt4jt3xsQx3dT6nb1ccJ39iXG8N2TH3UTk5nf+Rq6fs630RfRRubaJTnjHptvL+9JWOpo7yjx4AnOnu4ul41jPQX9PpjItd1/y7oeCJ8LhFfLBy7COcQ6x+4UA/rR/ijpy/KXteOA07f0yFcNA7ftpz7kw3Db/CQfh5GH/EPf+jcZx59JZOe30bVOSFkvN6Kxm1iMeEXcvPu7t9sX1cf +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/create-personal-access-token.api.mdx b/docs/api/v3/create-personal-access-token.api.mdx new file mode 100644 index 000000000..f435e84c1 --- /dev/null +++ b/docs/api/v3/create-personal-access-token.api.mdx @@ -0,0 +1,91 @@ +--- +id: create-personal-access-token +sidebar_label: Create Personal Access Token +hide_title: true +hide_table_of_contents: true +api: eJztW21v2zgS/iuE7kNfYDl+ix37yyFN0kMW3SaXOFfcpQFKS5TNViK1opTUF+S/38yQki3bSby97l23MAqkiUwO532eocb3nk5FxnOp1WnojbwgEzwX5yIzWvH4MAiEMWP9RSiv4RkRFJnM597o+t67MiI70ioXX/PDIp/BM8+ko2Tup26vz2mzn+NuM0q44lOBVNIRj+Nnlt083DS8nE8N0i25YZYdRvwYD1aEwgSZTJF74H08k4ZZAQzjrDyB2RMYndAEDjLxWyFM/kaHIMr9CpH3PBGMq5CZADTDdPQ0HZkJUFueFaLhBagOlSNNnqaxDEite58NEr73TDATCcff8nkq4Cg9+SyC3FsV44wes0hnzKQikNFcqinLZ4Ip5A04ekQ2+OnEB5pphobNpTB4Iu5cOtnkGdBcO3m8dAaet/mUl+eH41d41kS448ImO+JK6Rwf4UZDSgQjwLOZyBjsYPpOiZBN5rSgAO8hCe9mOoEnYDhcA/9NBEpb0gUWxVeepDFy/V6H4pdLdgpanlqX9R7An9BOS7LxLONz2KeKOOYT3GitI3ORmM06iHgR5/goHRE1gx6KtOvquaTP1pRT9wt2GjGlnfeAPNaEUoQN2mVVeCfjeEl98Hc+o48dL277xzpHH70mIx9PBFfmCQsR+Rm/BRvAL7guk9NZXrGOpiDVVwzIvKbqa5A80aONMeoTQ6NIZsb67jMLIWtoFUJEPyxHzLV1SYxymZN1jx7LPBc2XL2HB0vCpFoZ69adVms9go9Kn3yvc8F8613S6kurGBxQgnduTiovGLCbiZzxHNxjUgCB0lahNGnM59YpvznU62Epw+2C8vT4mZC00QhRFWLYlRFGsYxR9oYbGTDM06/qIXXQj9ph0I/EQbTf67V7w/1Wb78XTCbtdmdwEHEKMNLIdow67f1eZlNuzJ3OwqeZbYftiYg6k2HU6/S7B91ebxD1e1F/2O0No2AQ8KA96Ld6nf3BQdhp7Qed/f6Ed6PuINgf8nAy/AGzxR8edI3vmfofS/M2yW/cYhZ5n5NPbpPSKT89XyjPN7oXbX4BER9CgAJaaa5FnaX6nEaepn48PmO4n8RRRYLmOz0+eT8+Hf8Ts9pCxOopCLZNvG8nFaSEuiY7wbB90OK9fsR5KESv1e5Hk55otQ+CTqvfJeffzhWeZmBWAETzIcWGGC5lViTfqTN0WaSpzjBtL3L8Oc/PyLbwzJWeTfxAFkg4hlgIK3xM1xv9FT8lqIYrGiwEFhGWoGcmkLSlDYIGFDrERlgFHimX3GwGHJ1We+C3Bn67PW4fjHr7o+6g2Roe/MtbrWVg1ypPljnGqbv05oXA29U8W+Vc0ettrHOxBF9gJ1kGSdNnFyIvMgw1aSPYoVw2AZiL5U+qWx7L71m9QpFzGR9BCD/vVG+lEj6EuEQOBbEcwEYGFG9liJAv0RniHyRZJiFaVzcJaKLZhhIRMgcL2JETBt0s48EXoHW6RZhdKQn7WbkFAouKzyPHioHgk35r2IFy0+O8c9BrD/ahEPFutzXcH1J0JWA86F3MhupSP/pvAhwCSlysA7DIv0Eh4Aage2KADvfWC9AjNiAaW+Z3u7YS0/HLsIVrQHZ+c3TOegMWczUt6DmfrihB+VeXa7USJLeEzwBkSrWJlTJBHp+8Pbx6N4YnFyd/vzq5hN+Q1lojd6jAW0N0S2AVfGGm74hjJwDGqxExqANR3mtH9fUSLHYLHegzcwPKLLE17HCnb9ixTJpFGfUmi1AKbL/LXsqmaDagCsIzSFTBjE04ohmtaPlrDOQ09985Tb5mM0iXInvVZIdhKFFISEEQjUAU9s+xnPIwxNC1BKICQllQV6CLHNqJXAYr2XWhylXkUuaWd8tGweAAzp/3k8MgL4A5EnM5CitvcSw6+wDPVnN17sZLSiOVzlXOA5ACkNIc1Jhl2OECvIbGwzCXjqhbgsSjynVVxlouIZTufrXMHOeaPgt4YbaIu/MY0o9PolUf3AoXfFgMXDYia5RmchnJ1RXa7FZV5ioDn0GbF4e72N3F7i52t4zd1Q9L3OM+JejTXoc+V4pDe6gzKp5r0Ccj71GalYsI3jhDNhgoxEGkXz6MHQSE9eJrinDuO+IjW8rXmD+s7GGfT8rrvbL0L2yBDJIerQQRZCIRjojvBcekKKuq7vppb3U2keCgagNEpFu4uS4YB5VlhVLICTcIpYVRL3J3h1RiZYuhhQr9VEuV75DkDknuqtGuGv081WiHJHexu4vdP2fsPokkK64oWhxOMkWS8GxuPc19bt+uwgJWvmdiVciRqVbRChJjFcby6sjBm3Tak3Y0CEQv5L2w3x1GnaDf4fuD9qA96XUG3nKtv17EcRVk9Zhasre1o3vnkt0CjisUOJfJtQ7r13+g3kxEmNYw9VS4mV75PdxU2LEzXMeOY63Zr1zNS4RkahhSLXSEOQ3WJrg2K9fCAs6mkBcV3rtK4AtdCd+9+SzDq9tYJpKCF6UAutncP4xyEMUGSulk1SlSBXEBHFImiDWiZg2OJfF9RISYDygQgp1Cdv6O6NSZ6L9C8uwCJX6HErOTr4EQGOgVct/fdL+LL0UyzBGX1sCPXPTabocrcABoCGzOqnDnDp/v8Pmuxu9q/M9R43f4fBe7u9j9c8bu78DnDg09js9hwdb4HNY2W6zCUm9peOd/DdMpVBwHdsBPB0GR0XVzicEJV4ArIUOppjGflONgrbe3eVaWRg4QGVqmiiyGtbM8T81ob+8ebAU2emjyVDbLoRGl75qBTvZuuxsyz2JIDnJXWAR043x4fur6iyZpOJPoxDbj0QFW39VIFOid7oafpF/OGc11ATmOyDRwmMY5FD0GNlPoJl4YN1mC+lmTEWS7yuKH5+T5R/cpOSyRR+TYpL4nz4L1DLhcEQ/Zv1kMUF8i7Lanr41RL0oJtmqdtcPOcFmHvRE8g57ATdT98mH8ik0RbFKwFwZxrpA0lsXXRh3dQA/Wl0wXUzt5elh7V4LBw6IYBGYf1aUQ7PrUKeE9ZPkLSMukUtwkKBPgrpuXpWVCcStiLIDNhSbR8WSo9kBDe7y27xUVO+oKpLKzP/C0+VH57FhiDpJYtHGNE5GaPHa9cZrnW5n4y+Yge7XChVXtdWBnbwKIYCTBY0Pa+ubDLT1/iR62UPAEqa7ygJpwfNTfcAWl1b6Zjxo9H+nV+fioPswkVNL6NmYTFzNQCOOQnbJgprURf2UMXQfD4HpaQBR9M1t3eKhPEeF3Wkss+fZIX/qAC4m/dxAYyjoTn2BdJliiAbGp0IbkJ7IsxPwnGh77VJOZHl9D+cSVoQ7MN/OMB/p4oG9zgHH82+qEjoWTbiAD5QHrAEcL+1MmcIwu5TxLa2NWJ/J7efllDRo/pTpazakuElxtztxrrMyyAqyu3vnhBLmjhSWqpqzyQmBVg+v8xhoq44reLL/VhRRWyx9NXpT4cHFvcqbi+ffO0o9kkh8n7/6fMt4u0/yMmcYBXbx/vFh8C+ukbEnKLyptmguvZvf/oDl5DAFShetSlgPPIsj1m0VDc/DwEz6l7EEoH3qoxTd6lsmkMc8xzijPBDMp6E4iFTxHNNpAX9cJ5QaA4MgrdJ5EaEpzwhkokUMXKWMca2cfoOlTAZgdGz6c4gCqn7Xr/C7B8ufoOOy4dCYAdUlSKBweByaKhHFw2Wc8LpQmKGxiBEUpUUpmJ/6rXWWWQFdGVTSp9ckScxbh5TX0xUuO9cxZ4FfG3VyDIpd8YiHIhYjJJ3BdvSV4jjZ4sz8TcYotJ2R1gSPWixN+PR2vUQRiyoBc0NrrbLrnNpk9XAtEsP2yztBtQqOJj7B5g/54ia4d8978laNVp7pf3Nlv/YVGV4uwidhL8eoL2ShsU2N7yGvvkR4SupIZNpuw4v4e70ewoXrAxxCd2Hxf3yz6JfwLKNt7Emo6vwjsz93FvD+eU3F1jfj6Gwds4ewOe/fy5NqbpX74/AxvobyJ+8ZmYlv7jN/BQ/w58j7CP/hDp9YvYBE9h17dXe/AGku3RDGbirj7BcV8ePgPn7yv1Q== +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 objectrequired
    + +Personal access token owner's identity. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/create-provisioning-policy.api.mdx b/docs/api/v3/create-provisioning-policy.api.mdx new file mode 100644 index 000000000..e326581e8 --- /dev/null +++ b/docs/api/v3/create-provisioning-policy.api.mdx @@ -0,0 +1,98 @@ +--- +id: create-provisioning-policy +sidebar_label: Create Provisioning Policy +hide_title: true +hide_table_of_contents: true +api: eJztXAtv2zgS/iuErkAf8CNxnLYJsDi4sdvzXprknGSLRRLs0hJtcyuTOlFq6gb57zczpF5+JNm0uHYXQoFGlsjhvPlxRPHG05GIeSK1GgbevufHgifiJNafpIF7Uk1PdCj9hdfwEj413v6Fd6rT2BfGu2p4gTB+LCPsDX3PZtKw3smQTYVCmsIwzixBFhGVdiLmUYi/x9yIgGnFJlKEAfvEw1SwJObKTHQ8Ny2WE4M/UiVCBdAenrHUCHY9E4oZkSTAH0sj9nP/zQErM82SRSSYsZw22DhNmEzYtQxDxkOj2bWOP+LoOpmJ2LWjPqZ1qc5yNpjPFRsLHDMALhi0ZlF5GCsWS3QmJ2dKXDOeJLGEQYHmjCdsoVMYLFzAM6ATpDF1LdGBQUdiApwAoYvS8DBkRSqyhRTm6tksSSKz324H4pMI0YQtw2UYaVBVy9fztgxUO9C+aRc6bU9TCQYr3WlK1Syz0Ywc/eek6bmOBbCATclBgMsecPgRdH8tkxk7Hr37rdd/PzxiPE1mOpbJAq0Vi/+mMgZBUSscNJ44U7bAiYzwU2wIjnTjnRsRH2gw7uekBxTQuYDv/VWWFvtzrvhUeFe34HURj/lcJCI2REWi70Uc+jc8BQ/glzUoOHTDy7jx9pM4FcCAPxNz7u3feGhubJugObzbVW8WzLo6k0hIfObgu9ij4+9tv956vbMbbO9t89cvt7Z3g87r7u7uuMs7O509D5nEcYVJ3uhggYMts+Gj2CrBRzyKQETScPsPg2PfrHKpx38IP6nIc2GlRYXE6AEJGA57WB0sy7cs3iZXpt5lad3V2sboJVJxP5GfUEsgkCQulpX5EGZKd5iebAq1CmvkWOv4ssEI6ceH8DdFsoFodlwu2FRjh4x7ZDk14GJnxOgqwyoNQz7GYSeQQcCCQqVzNMLBaNA7G0CL85O+vRgc9d4c4kV/eJpdDQ4H9Kx3ejp8d4Stj/JLS+G3d6Pj85OcTv7Tds1/jgbvhqdng1HRb9gfHJ0Nz34tupbuDPrDs4Ly0eHxwb+x5796R+8Gv50ACx+OR330oUKruUCr8UBZFYyzTuekvRa7VEPFhk7JR/q6ASnR5VdMpiaNIh0nkPBjqdMl6+VTEeT/t+BajqeGzfec/QEmgyQJRudBYBNMRrxhs8ycQzKO5XQKzcaQ3JkVBgwfMKuczSOyAfdnVgwrKNCDMDXgMZjN+DqpoVevLN6MQyBwBWGUzsfAg3Vks86VIU7A5ycgUYBaO6NmPBbk+ZDC5+CvBTNmH9o4YZp2cixxGouQ/B0U8vTATkQ939epSnD+mMhQPG2sRlQ+GWMY41Pu+gAZmPRsEAVLpiA1X+sUJu1sYsTuuXEwypxGQDmXymn9bp7Po+CxPLu+T9FUClIk3N7oRpt4V6UJ2yyUXxHiUtl4vkeEgcLs8A3ULojQWrX7D1I7XPvWi+yzpyYfAWlkVr1ULj3dI1hfmm8kWWApPUA0F++hgHCKLaaY608Y8TCCjiF3AJiaxHpe8rVL9SvALAxCRIg26ibwrBxEVmcASRb4YO30BwgN3AbhrkwoHZ7nswJMEYRWTWl+4HHMcVKSwJlZN18/Zm7GVIsts3kw985WZfoDOeMjJAiM5aBuHQ9rEnnWnHIoABDCsDgWSVgeJicXpyEig5yZkkCeSzrnSgLqYYf93gnrZe28W4IDE56GiHfwV5XG3ezmdErIMvOvQuoqw84PofeTm4mMTYJs3rae3ITcXT+5SYnXA/RPEd8CAT/UafCef7ZCHMyE/xHY83a3Ss9O5RdCgPm9UQ7HPAR2JKs0xd1curHW4M6KEBwPjmE1kEHBqrhvQ46oJCBECH4JoUBrFJBY6aTqDmW03fJKSs4gSqYS+o1esgHcbJ7p73C/AjhL8x6Glb/gIm69zF8n4xypN2mN+BA5b4vgfYve3BcJrI1MP9FgntLD1VUuNcnpkXOuTqdLyzGC98RbKR5c81VnvoNMBYAWKCxLORc5ccij4N6LI4vU10V+BnKLGNwQt2VSK4G55MpO2cu+s2R852rlEdDGqTQzEdzBMiYz7PLO1g50vMKyTfQUl1nowKoPgldRWeLg6KcnE8mehKpxfP7Tly+4uDR42Ye5o9E/+Al+S/qbLZQD9wDAFmJi7J98LQH1tf2h+3Juegw5QPQT9RiPyNMl+UP4KBpZliUSE1nOOOk4d5xqV6miNPl6hsdiivWALVyfgTduEwfJ92Shc3u7OuVtmmtWp5rtrc1zzV3x+YDILGWm9TFpEsjP/orULtl53zRjXN3eWkXFwkQA3e1Qna1t/FNNojYlB2xt/mY5jKhLLHWJpS6x1CWWusRSl1jqEktdYqlLLHWJpS6x/BAlFmrThZXNKrYPJeAaNohj4LTJRiJJY4Uv362e3FtVAB7Bwu4MAJYlcfxouF9NHwFJcqCDB1jxLeT+5jTmCDCYIJZ96GizXoBqp1folmRmampXNTNoorXN3vCAjZx8B04Ym3b8j0BrGNzPkEsOWRdA4nkcrxlWvBJ8/HJrr9OdvOxy3nnd3X61O96b8J2drb3dvT0cfQ7gHpLzunxcHZrqNtJnofbBIl9AIRCEBjd44ESEgz88hRONB0aRbZuL6fhluKcAcfGbgxPWfcVCrqYp3efTJSWo5vlpZfGBKQNLH0T4GJCuXLu8yhYn/cHb3vnhGa0b/nM+OIUrpLWyO6ansnjUBFpn+po4dgJcc8OMCEEdOHu/cFRfgECQf8sNpf1lFgaUyVycQg83+poeZdJ2Si+Hkm83YLBnsiVaDcAHcG/OE8Dp+ZoOm78AcCKipHnoNPmCzSDJivh5i/WCQKKQPLT7eOwaAYCGXUK4fTOTFEJZ0M4RnSaYhaS/lO4KVVatUeSTw7JRMDiA8/v9pOcnKTBHYpajMPcWx6KzD/BsNVfl7qykNFLpQiW4ssU9LrAe1nEMGnZbjQxz6QjNZSDxqKxdnrHKaZLS3XvLjE2QkM94ah4QdychpJ8miZY/+CRc8BG8tNmIrJGZyWUkh0eos2uVmysL/Byt1LFbx24duw+J3eWHI1fRLEOfNWXNc+W20eHkuQJ9YvIepbO9dl8I3jhDNhDXOYj084czt0kP2ovPUYZcvxE+slP5CvO93B72/pgWq5mxKrZABkmPVoIJZCIR7BPfBcdeVg7ubu2sjgaL27EEB1VrICIu2WjHJRZ64lTR0pObBgu0MOpp4gpItmxJGRBHVUHTbp6skWSNJOvZqJ6N/jazUY0k69itY/evGbt3IsnqPiWHk0w6n/N4YT0te68M0nIGDVj2br14SZ5vXCqjFSTGcozlVZGDN+5sj7cnr3zRDXg3eLmzN+n4Lzt899X2q+1xt/PKK8/1F0Uc50FWjamSva0dScUA4vC9RKrAuUyidVAt/4F6YzHBtEbV9Qw3g85BpVcFduyuYscjnYBsQBiwY7yhvHg+OkT6MLR9AQp6c+99Yqc6+2EPQkqqp4rP0nzVnoMaOtbQsZ5+6unnh5p+auhYx24du3/N2P1T0LF7H3Ts/gno2GUIsSYIsb4ndAwAdyA0m4BR8Dv0FNSrEDZGIApcuepjts2Bx1OR5ECvgiI7e6so8kxr9h53oTmwZCqVSFWoC9MbtJ1j2zhrK3HrzRRSpGKQtSSgW/QqOReISXGXRyjnkuIYBQK68aLZmyQglY2ZzN/yUaTywxQ4pKQQaqy9avAxCe4kJgj/gALVQaeQqL9hjdNZ66vqwWyEEh+ixGzw2RcCYz6v/+6u2yUwxA0lmC5Ora03bBewNXPcrqTE58imrxyC1lC9hur1dF9P93+P6b6G6nXs1rH714zdPwHVHRraDNWhwYOhOrRtbbEcS72lDZ//b8ROoeI4IPdm2iesHhQYnHAFuBIyFGkqtNJ5P/te2x3x1L7Jjvy5ba890cjDo4cQK1o20ziE3tkhSjdgPbDabYtHspV9vaT0NZ2k9GlnTS7Cracm250fpD6tJfC0KjtIi3QeS3RrmwNpAGsBt7HWy7/bvJN+tkmdttNbMg3cOuxcjG4DmxGsL54aat0il1qREWQ7j8Pb++T5ZecuOSyRDXKsU9+dY0F7BlwuiYfsXxUnRZ0iELejr5wXVUwu+AqgszLYMTbrsDeCx3S4Fu6Kefbzh7Pn+RFlAUsNIl8hcb0AAXQCLkLprZftEMFONOPEOp3OiPFeZQ8OhhObhCAwu1SnQrCL0sdZbASJmlSKnQTlBuz1sCO8QENtXum38WiuJutLzEr4UQ61cSLSso9dRJlcvCTXY5n4R0ataak1iZp5vsSFVe2Fb/d0+xDTSIKHhrT16MEtvWaJHi6q4A5SXebBHhlHfFR3TvmZ1R7NR4VeE+lV+bhUH2YS5tZqN2ZTGTMz+h5nyPyZ1kb8kzF0HQyDCzqo7dFsXeOgTYqIZmerxFLTDtmUTUCKxN8hBIayzsTHOFMTUNG2ZkIh+TtZFmL+d/rA7/eKzHT7AiZUbImnzT2aZxywiQM2bQ4wjn87X6FjQWyjDO7raXSAg8L+lAkco6WcZ2mtzepEvk19cGrwgVV7yEC0b3/sFwnOXTF6gK3zNpCCEWjne8nwuydHi77BKSsrKxEsa3CV31DDXLmkN8tv/qIT588fTV6UuFdUUvD7m2+dpTdkkh8n736njFdnmr9jpnHQFyuSo+I0yUHxEZ77MvAxxwesHg/w7b7zf/BBNvnXles/rvyqryGXvn/8jp8rPvgADHgAmYXYdcvBcj6zwHy1hJt/iQtPKSnTcgpMYQ9pRbhaJoNqyL9K9WdSUPEnAm0iyG9gCtFzSrngDWhysD0RmpLGY/BNDst1GQK9FvuAH1P7EE24ssZN10AVP4mmYU8hoE4wHlk/i1HAyvM56Dkhz0znjEMmuCeQA2n81M437gN0y5A9uzfvlSVfzBCoihatMeO5OZ7gWwLpi1K83jMWhKtxrwhAkSW3KwQZ4ffbmPPR3Su54D7akCSaMxFG6BkQYoCby8H8fni2QhGIKfdeSsfTtutk2tgWiOCq1jrDTgtW9HgLV8lzrlYDZv3BU0snieSvRuojnesjne890tllN1yVtyOsLtNBL7ZKYMs0F+7sLoyV/dLZzOsrNbD2n2GRB7rd3KBTYdniFm9DEsai18VVUZWg6SQ79SD/WnmjPz/LsvNzerNaPt95rRhZKV0tiioaHq30UWDxLReFkretkRJD9rF7KdekibDovvK2EYs1toetu97Z9qpUCzs5xgq0N3ZnTM9tWS/m13AT/9/3LuEf/NCRTVXQiO7feFmRHNpYutl6ZR1cdxegeGj2P3WSAQo= +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Body

required
    fields object[]
  • Array [
  • ]
+ +Created ProvisioningPolicyDto object + +
Schema
    fields object[]
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/create-role.api.mdx b/docs/api/v3/create-role.api.mdx new file mode 100644 index 000000000..eb5365d34 --- /dev/null +++ b/docs/api/v3/create-role.api.mdx @@ -0,0 +1,198 @@ +--- +id: create-role +sidebar_label: Create a Role +hide_title: true +hide_table_of_contents: true +api: eJztPWtz2siyf2WK+yG7LsCA8QNXbZ1LgDicdYwP4KRyHZd3kAasjZA4GskOm/J/P909M3piG3tzd7N7VKmKQZpHd0+/pqd7+FrxVyLgoeN7Q7tyXLECwUMx9l1RqVZCvpCV48sKfpWVq2rFFtIKnBW2hrbTG0ey7vmQqU6ScRZAy/on76MfsWUkQ3bDbwU8Dv3PwmN3TniD7atsND657vbfDc+qbDw6HZjPfqC+Ti5e0xPGo/DGD5xwDSMwi7suC/WcdfbJG3qM27aD0FRhkmzXJV8zzw81bBo05niWG9mOt2AcOluWkJKtAn/u4Ls5jM7DwmPAS0rfcmAYW+HAmfSjwBLQXuSmhdY4a74HNFxK4d4KiYBPoduSf3GW0ZLJaLXyA2zoCm8BTedABRw3RWs2d4Rr49itRqPBrBsecCsUAQx26nsLEaQbS5gRCDUTgIGQIriFoXFM8cWRIWKOhICeb/07cSsCoJwHlBJ36jlAzu4E9Ie/+CJa2bS0QP94gI2Tuc7SQSygYR5I4KRA/DsSMnzt2+vK8Vf66gQCGC4MIlGtWL4XCi/EV3y1ch2LGHL3V4l89rUiLSAfx0/heiWA8/zZr8IKK3mG7DLNuLB2wNWhA1wLnRw71VWGAeBQ6IpL4tjMn6s1RTZmxN+K9MTMiKWYh8yLAOW7G+BoYi7NTdgHWBi6B3eORI5rAxlec5uNFfJMBAGsAxEMViZyQ6SM+MKXKxcha1md5lHj6OCw3bEPj472Gs3DNm/ydkM0W8395lHlvlrx+FJsh8xNtOReDeCz+Qy42HbkykWRgAHSWEJf4MRTYr3KcbN1lIYIG7DW/sEhTq0EaQtS9lHezPjsDhjJdK1WgBGXHNa5glxVC52lyJKg0WrWGnu1RnPaah3vtY73j+rNRvv/iIO4PfLctWIZgGfp2w4szosAcjkshxmg/gy4WtNW4xhAaz0MV2buImjIPLgihvXzHJxft5QWyC5bAt1F4HEG6wrKLgpkBKoLBBjESUjgO+Y50gXNajla5QD2fiCW6rmIHAl0YPNIgjpb+sHMYcAnFpoEUK7OypEW8veSC0t4QDno5TDABTQBDg5zwrwwJnyAbvBBgg5Q43iRZ6lZzMRLvkBIAytitzxwsLXvgrQ7IepkJlyxBLBBKQrPWebmBOF0VhLehWK5gp4KYtvhS/MctKgf1JFV/TtPBJvURUL8OXdlgfooN9RXkRqkX/WsF1SKGri4usKLlmgxh/3B2XQ4/Vg0miMaH/ttVDDCQQWS0jOgMSQQF9TqKzPoKwbM4HirKPxd+iaGESi2jYoc2rA4aIsde4Pe4u2DOee2EO1G82A+a4tG88hqNQ72OtvrrbdP6yxanjobhmTgMxoZcPXBBqERAmbi7Hw0meLD8+609xa6zJGQVeaEitgg7xYZZpSaAFADnnSj7ESvZAaI30Vubegr90AOICM9I2YYi7mA+S2BhFLOx7nyPVKsVuFBwNcwIBjZpdzE28+3ecO+QbarXB49bQbs+RxsUuOoebjfFAdgiTpztEXNg2an2RGWxRHoh6QhJ13wFifUvgAsk5au58pBt9cbTCbX5+PRm+Hp4FXRFGfRecmqaTHOzoTCnBAm9+5bMnkW/gx94IOz8ECB27ESyLJZtq+23imW66YZDFiPAM/YpHvEn5qjNn4WD2YxHSSjpB1vJlfCAstr0YICyornt1eyD84C4tqfjpRyTa0iqbnTwTv4m13C9IstlWB2tmF/kwvXOTzcA0W412o026K5B0LTanToy2Nc8rhjkJ03zTRZCHpnP6UWr97uNMTcFvvV0cVPo2DR8/HDBDYFjiX6YhVW+72f3v6r28e/rg87rAyvpCYlTkGvSyxn4NPfOCvEIQ/z4/zwAeWUNiUe6GHNBbi3wF1X7J85tNkAFbAIuKd3FNr0YOO7GwfUtlYPEkReztcJR8FssOVwOKoL1ZIH4NcooInX2MK5BTBc8GDwezLy8438ZNo963fHfXhkbOn16XAyfWCnjN2SbZHzG2EuiFsVZIg+LG5CYhAQFwgJXg1DF5Oaz8Fj8u9QkMI7n7CbwyKsk33k8Sfvk2dAO2ZDz8btlCEzkTg1A8Bli7njKaMJcC01mWJKii+4ZBIQwYEziG4zOmztwLxpfYUIxGvlJIuKqyHsjd6JomjCkzjFu3iGiSYQ2ha1SVFQP585+0QFyQzl1LrkECqwSBw8eYxPBv+66J5O4MHZaHodf+mNzqbd4Rl+hDnH08n1h+H0LXwbnPXjzwAL/D8aF1mqC/uBePKMUjMTpCnW03QZxV2AWJ/F+nEneZMiIm+FRDSlyGPXkIeA/CwKweiCofEj0PzwSD8BmUybhEgqpsszTbyGL3a6q2icRxdnU6JmRvnnPKCYfcGHII2CHJoK3sRSEAituDAskpIJssIF7GUVjZpBP36GUZiUZa2ixwEkDEEjueucGY8R2LSMP4u14XhNovV2UYG0lxFDloML11bpzoeIQTEapTETiOPh6mLJHRdhU1Gy4Uaz+jiXJa7pREXa5oG/NBrdKxI3jwKqtYDfeXXy8zDUROE9FGmMHyriEkOm2GNzMKZ1ON/jFIzZhw1p86jVBAe4Q8YwCWNdKvxSy3H14MoRZYgM73HD8XziTKiZ3q7AYoXoxyKtnhDDYLMcGkOsLAAMA3qB3e0Gu2FaX6MCN8qDNlO0P45ZAqOk4K3zOfN8G+Ygc+AAizt6O2X6YkvfIyZUmqrKErVYZUYrVllKKSqQjVqsqqljf9isAhhJ4+cb72KNdHKIHVBq0dXPMq3FA1eIugVL1rQ6887sYG7/L7Kv43G0u5a/JLNy47g27NGe4ws/voaluSnNTWluSnNTmpvS3HwTc1Oal9K8lOalNC/foXkpzcmfaU7uNy/dqQAx3StG/wuaGQ0P4ktGKSZZjhXzNAJNj1iPxunDF3Pylj61q7NunApDMhIIfAuwURwyEdJAJCHOauo4IV41CUPpbCDuuusqwUAvmMVRs7l0XmhsqwJPN+CezTAkXrsFrc3rjxOtVRLt+URrqgMWE/F9uWfTBYnR56Vktr1Eb+CpL3xNB45V1tcGc/z8aL9Ws9e90Xg8OO1Oh6Mz+Hz2ZniiLHT6MDB+MAbNMJhMr7vn8Op99zRjzOHh6bBHI6EH1X133h2epD9ew2DTwRifDMbT4ZtU49OLiX4zOjsb9Kaj8fWk93bwrptzEqqVk9H7wfise9YbXJ+MRxfnqdOK9MFFAnr8SAMPj06Hbwa9jz1MdJt2p9jovDuZfBiN+9fnI8ABR8I8OPxzQX8mo9Sryehi3MOn0+6J+v8aMBmcjMYf6evkZ5hrcnGKU40H56PxNPmOA70fjk4N5mYZur3p8L3CAeD4WaG2ya/E9TNCpq0wLjFJSn86kqkMPEzV01bEMNWZfwd8NQ848ENkhVEgHkiiSHi/H/pTZT4L56p/VprF49pqixNpA1QW+emNv+SSDaCH8sG563B59iIgLiT4q5umzMwY1oWe7P6hI6G435Na2myS8joCUJoJVJPiCyhMCf4s+SkZbyI5N6yq/APjjWXUT1EpFo+uEE5XLLi1TuHgzf3nb2ayaQKYhmqDrbFC0OEq142WF9U2vF4ID6QCTw7B/YdG6qAVdP0OTrIDTpLHQLGvWYBWxPFkyEHlArbSX6qdpKQUHMrwnQmTgQHDAMUwYyx/ionyF1smlWgLA3s+c1UKa+4Ys84+3GACA5BdmvkoS0OG+P+dH3xGVwqcPXnjR4AygL50FgHXmMQ7XzBZWZNQBCeTYUFprpJSZkHwKS+QrCNbRcHKlypFFr12h+aRETjxamL0LdPcGq9f9iwT5SS2uecpGxQnX+A6pTXFzAf0ubfpQD3e5pmzc90b0QYOyMBjeGbOIzfUKXD3cW6u4qvnz4l+wkzlV4Y8WKRTOkyqj9wGDNVFp+X0fG/uLDad4ub0e2YeOmx2FpHW9iqTOs7iqxSPgLMeALjLtJMdxxuhZ1HD5DUFRoNhVjN3PJQGNaPy5GDSW/CEmJmO/QpPtbefGqdIsiIpciQEneRwt/dyNJCtVwgffN4MK+k6mOcbQKtm4u4Es7s3uoRZIE8xZUM9mpnZgdwrSY4fDVYEast0OYP19AkncPThjLyud92z7gl9KrhXBR+kr0DW6R6OZztA0ohTStsi8KOV2W5SAMX3pINqGpk3Xg7uEqZ1RntsSZqTS50LIuuYmLGzQ7Dt7ByzUZLCmol4oLiqphp8bPyOe3yRNI+9jyX/nKOm6prHF8foshMknocWgp0gSlU1GMU9VJwD0Eus50zlsuzsGLoP7Z0dpX8z5r5A3JhtsMsLAjFxhn8c7DPDVVUEj3Y8xORplkDoN/jRCaDtA+uwc9Ts1PhBZ15rd3irNhPWrNYEr+2wycXBgXWQTcPLMP8bP6Cs7vuMu2D0Muznw3XcBBX2ra8qJLbQllro8EUx+GnG2U6B1v/CGlTne/9VVOi24P6/6tA8d5TqtFSnf2V1ivxcUKZSLLZNc9ZUeXJfeWpyS/sUZDAzUDSZe+tq+kgCKGE8d2AtZ+GpeqSYFJeV+eGsOTvie7X9ubBr7bndrnG71akd6fTiQ9HsQI9Wx5odWI2DWtPmR7X2nuC1o5lo12Z7zdb+vNU+mrd45Sof56eAgSmYyQX5kXzUnKRICTbMiX9ydoS2AXGNV1nMVymL+SplMV9ZzFcW85XFfGUxX1nMVxbzlcV8ZTFfWcxXFvOVxXxlMV+Z/lqmv5bpr/896a9ldcX3lA5bFvOV5qY0N6W5Kc1NaW6+W3NTmpfSvJTmpTQv36F5Kc1JWcz3N6pLK4v5ymK+spivLOYri/nKYr6ymK8s5iuL+cpivrKYryzmK6tPyuqTspjvO9WgZTFfWcxXqtP/bnVaFvO9pJiv3WgU6/d6roPB9wElz9fYWIRR4CVhTWNOZr69ppR1D9bGIcxeXOqX1TC2AMMAetre4sThDezya7BBoyxXle9vQUetmWmz6gdYaoVDGo7eEG4HStSbmeKBnkYG2SzgFor4ZjnKxTo8Kp4yXbC2yfyE44ZpxaHgs4NGp9WeH7Q5bx21m4f7s86c7+01OvsdCvyA7pegd542ACe47Qc5pWRv5zcgCOzapbb1NPn2Wp7G2IL+eFSn2sZoanhZKL6E+EOcr3vnrH3IXO4tInrOFzkieLWLyaaQmhp4FDgL59Fj6/7gTddEGHVYE8faFDF01DmqT1r8xr8jiDUCWD2oAggYotjRo+4AQtyT6YaO+ibXYGmWTBtu6KFn39AjPbQ6IUyLEsnNl5D94NRFvQo77riEacZlkl29gzviVVg71ZTcYTeC2yL4MR3oV4dv0pRQcdtOjs/mEQY5KRTqRyHGEBwrF/NMSFlIsdbq4zS9KCgcAPnTfNK1QrTjhGZaCmNu0SDq9cHfP6V58kHJhGhE0jX4kBZgQcEuyw8wJMZmgJsTSqbVEdlTUDyeaRdrrEw9BELzTgHTD316Z/FIbiF35y6onxqhFr+4FVr4KAHB+IlJbMhoJB18pM66VbxcRvBja1/Kbim7pexuI7v5l2N9a4F+S67PhqsLLjz9E9NoPAuuTyBU7N38DvVvagelFpIyAbSL9M8PU/0b1xi0/bKiHIBv5x8pU14AvhuvR24TaEx/shYIINFRxwJAEwn7mOBOICZCKVLtFWd7g3XgwKDeBhcxwvOetR/R5iuIPNrkc3CSbV9I75X5HXAV3yUNSMFtu7byHS8sPcnSkyytUWmN/j7WqPQkS9ktZfevKbuPepIxVCQt2k+S0XLJg7XiNP1e1V1DAxO4FsnB9a3JrU17KzgYi32sStZzqMxazVlzfmiJts3b9sFeZ96yDlp8/7B52Jy1W4eVtK2/TOQ4FrKsTKXWW60jkRicODzoiDxgLhn6vp0N/wF5AzFHtUa5esZvBpoDSa9i37HVKfqOU9/HYPraeEgy40N6CY1Qp0HbJbY1+QbqAhhV6Q+qyvFVoNpZChgFU0SY6ywdEl7EAsYN1rXuHE+elKAYJotnUbmTgAdqAsxYoSAudzAxc44+H4xAHuwCtPM39E71Ev0uT56NEeNTxJgNvlhCoKDHnvv+pvjuEIAPUEdM1AI/EOhVux3uAQPEWUSx31n656V/Xtr40sb/PWx86Z+XslvK7l9Tdp/hn2tv6GH/HBps7Z9D23qDxb7UG8rd+aPddBIVDQGxN/MtuvHQTnxwyoOAh5g2j5NgMn5PsXI3wothLyuO7R1jonwt8sBxsz4L+3hJuS6oicy73Jur+yuEHngUMV35lEK04jhgZRc7yApOjB6mQi4KXHh1E4Yreby7+xXWHNb6vs5XTt2UpXr+Hda17d7ubdBgmGqgpBV0oB2pLO/u+VDvU+q0UgHlwSvNSROoddOZVRUJ60cx5kfHN5UKaz8CXUnDVLEGQDMmPQYwV7AreSX1PW1I5wKOgNtF4N4/hc/7vcfwUIM8gMcm8j06F7RnAGUOPQT/KuGTVMZZgVsSk4RbvlZhshE2a7HXggeY+UenID/888P0R12VkFQR6HveODsHFiGl2DUnAp9VOVp4E/jRQlX3djNnLiiEbO4CwuyTNxGCXaaLesag3omk2EmQRsFeVz+YlbGxbA0NaT2hJDIeMPsuUGiXZ/r9SEaTdhepqoH6J6/G+lSE4aDxxzYaRXUV4uXK4MVTeL0UiP8xo9XUaDUaTf6Yg0KR9tJSOTwWaAIcgruSqPXiydV4tdR4NbrCr4aj5mFASmg4sidlllm1F8ORGa+G42Xh+OR9UJXXmW5M6SlTTTJk1o3vS/EPxpB1UAwuFxFI0YvBooyvGklErdVIgVRTU9acGviXBN8pCIanmInP0L6Te+OD5+fZSiR/oZUFmf+F6nl+yeBMjy/BDGNL27fki2HGCWs4YU3pAKnhV1YOGQtkG3FQ2b/EAL1k/UkTaEBTOk+NtVGr0/C71AdNgwWg0ihyday+HCcKTn9i9AJbx21ABaN7Hp8dciwbUmOhqcsQywQW8hQswuv6YGFzdFPwxoEttLrfG76IcTeJv+BFkt9aSz+gSb4fvfsnabxS0/wdNY12mDGOqaODr317PUiq/rDK9+lfczDVuqlfWShED8uL/VMX+xfv9U8VX6do/kiJdEzz+DL24o3rl3oBn7z4PC6GKRT/60k2XsV9lb9d+zJGJ1u3n8LokQul48l+/8XPV/nbnTdWr2bv2E3dGJVc1ZS9iSm57yC53KdwvU76dp0tbqvJXTmz1UUo6Wu1LkvI/xDI76/gX/bej8tvIL3Zewcy1w6kbgi4erqwvlCYHddeq0hZpjRaPXqgTLlY+WYqQzbXk+nB8uVbl/naqU3Xd6RLdrYslbl6vGywCH38+yibwdev/1D4k0qdb10UAwxo+EKHCdMeqwq9FI2zNJcTwFtyuynMxq2QwrKZ8i8cBqxviA4qOegg0IIOBVaCE3tV0UkErkanGqiDPEYXHsBAC7pXIQDvg7u6fqnOPoCJ9iyQX4y4YholjPqrr0OvE5DCc/S4WN94YQzXMPKwFA2AAKsKbsBTrhrIERh+Qs3yPU8YzOhyIhb3Mu41+oBICioTxYvkR3NtcFIe2RNzgUMm9dExEJIqWpVYJ4iMhUtMjO2ysbSnxgY3sHYj3BXduAFgeVKkZng3nBZGhME8pSTrfrDY1Z3kLraFQTBuqZhhr96oN+gCO1+GS+6lxu3R8unr/fNc9DU5JVchONwZqYs08EoyjJHCXuYjrC/VkqqcWL0Xo7WA9lU2Gp9cd/vvhmdVhrfwmM+wMaKvk4vX9MQkYAAP4JLiLjHUc+JWbejFJ1J42JPtiocQeKOIZbChS1NSv+rhmQjWSrs7lCGAzmbusUzXUBIOnCkaqzslMtPqe0zyPaDhUgr3Fu+v+uThWYK5Diu5zMel3zSLz7LSP6QV35HSajQayU8ywGCn6i6SVGN968hMqF+uCG6FOsKna0IQc4pj19lb/05Q3SPmoXjiTj3HstI7cNrVnSFrFq1s9WsJfjLAxsl0fgo2zAOZOJ4Ycd1d4Xkjsl6kIsAqvn5ZUfF1cOpuMO4OD75+xTMoDDbf42MwAXjAcXmVxJLxGwykzqJImZNbUdHJDzV9rZE+7ChmdWB4W/VQ51uPtk0fDeBPNUFjLBekpBd1fBLwO3iI/x9XPsE/3AEoMmEjev61Yg4joY0a10R4NgU49AdE8/7+P8DByfE= +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create a Role

+ + + + + +This API creates a role. +You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority 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 the ROLE_SUBADMIN is not associated with themselves. +The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. + +## Request + +

Body

required
    owner objectrequired
    + +The owner of this object. + +
    accessProfiles object[]nullable
  • Array [
  • ]
    • entitlements object[]
  • Array [
  • ]
    • membership objectnullable
    + +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 objectnullable
    + +Defines STANDARD type Role membership + +
    key objectnullable
    + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
    children object[]nullable
    + +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. + +
  • Array [
    • key objectnullable
    + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
    children object[]nullable
    + +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. + +
  • Array [
    • key objectnullable
    + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
  • ]
  • ]
    • identities object[]nullable
    + +Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST. + +
  • Array [
  • ]
    • legacyMembershipInfo objectnullable
    + +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 objectnullable
    + +Access request configuration for this object + +
    approvalSchemes object[]
    + +List describing the steps in approving the request + +
  • Array [
  • ]
    • revocationRequestConfig objectnullable
    + +Revocation request configuration for this object. + +
    approvalSchemes object[]
    + +List describing the steps in approving the revocation request + +
  • Array [
  • ]
+ +Role created + +
Schema
    owner objectrequired
    + +The owner of this object. + +
    accessProfiles object[]nullable
  • Array [
  • ]
    • entitlements object[]
  • Array [
  • ]
    • membership objectnullable
    + +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 objectnullable
    + +Defines STANDARD type Role membership + +
    key objectnullable
    + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
    children object[]nullable
    + +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. + +
  • Array [
    • key objectnullable
    + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
    children object[]nullable
    + +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. + +
  • Array [
    • key objectnullable
    + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
  • ]
  • ]
    • identities object[]nullable
    + +Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST. + +
  • Array [
  • ]
    • legacyMembershipInfo objectnullable
    + +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 objectnullable
    + +Access request configuration for this object + +
    approvalSchemes object[]
    + +List describing the steps in approving the request + +
  • Array [
  • ]
    • revocationRequestConfig objectnullable
    + +Revocation request configuration for this object. + +
    approvalSchemes object[]
    + +List describing the steps in approving the revocation request + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/create-saved-search.api.mdx b/docs/api/v3/create-saved-search.api.mdx new file mode 100644 index 000000000..2c1dce0f9 --- /dev/null +++ b/docs/api/v3/create-saved-search.api.mdx @@ -0,0 +1,157 @@ +--- +id: create-saved-search +sidebar_label: Create a saved search +hide_title: true +hide_table_of_contents: true +api: eJztHGtz2zbyr2DYD00ypiTLj8T+cqfIcqrWsVRJTq7neByIhCQ0FKEjSNs6j//77S5AitTDcp1cX8PJjCMCi8XuYl9YArx3tPCSSMZz5/jy3rnQImqqMBZ3cSOJJ9Dm6Nmx5jfCd7XgkTc59iLBY+FcPVztODEfa4TpIwDrE4AD7b7QXiRnsVShc+w0aYRmnIXilhEyZpBVPoXOjqNmIuII2/YB2uAnjBbhjhOJ/yRCx2+VD2TeL6EfTEQBKYsVA4xa6rgCYz1kJ4xxHJ/NAunRVNVfNQ6+d7Q3EVNOvUHQGZEU4vlMAGI1/FV4MaCYRUhiLIVGuJBPxXoqsIepEYuXKDJsWqw6jmQ4hmdxx6ezAJtOpObDAMC556kkjLXzsCTDdbPlWp4+aZgEAc7lHMdRIrYQAVTEMqbe3HqcI/8PO9vEZNbR30A7dK1QzG65ZjKUsYSlmDOL4Gl8jFQ05bDIDmJ2Ywkk5pmr13bfuLVDt34wqNeO6/Xj+pvKbm3/386CwxMYOJDEmjNVvhzJTcQHXMePcJAO/iMIl6EvPSP/9eqpU1VpIRfSs3TbcfA/u51IY0Nr1IhHEZ/Do4zFdM0krTCZskjMIqHB4oBfmgncSwSPsKI6mc1UBGuazgfIG74vcTgP2A0PwMrZlM/ZUDDu+wRIOEZJnESC3cp4opKYhQpIF5V1RgUkoEcCJRZag0aOZADy2HGsVnMvljeSdBSBSYZTgdoOjzf2h/SpxwBFyiB4hY5tsTAFmHQp2qEv7nAdMrjLPODVA7qjIJmGG1bIdqL0QQKRAKZDEMILPRMe6pQmYajIF1FuqSZiDpIJAhxjZS/8lww0iwkOAL7yEuSRobBA5J/CwYZlKUCCw47EMbsuiPJ6hxpyopznmujneByJMTlZfMzJmB5v7A8rFhzNQ59do5ivC8qW+RWeqUi34GE2KeXjfgnEGGww7Lz/JrBtjhsihwxwvSeCw5qsx0pqnaI1gNvwflTRF9YyyB9M+JMRuqNLS/7VQueapDMElyG4T7XORHXLsuNLPQv4nBz4gmb0/NjMMseewguXSMiB5gm7wikhLkebYrJxLQTBEo3uoOh0Ln+mrj7xz+jh6sUkjmf6uFq9vb2tCANe8VR1nABHVRFWRR5FNRIjAVrsiepBpV6lqVxfB675ZSRrHiqTeBp8l29/yfQctPiOjSI1pcUx9Jz0z7atzz/TGPnCt1GTvPlLVAUS3gb7Nn3WvA0LGHDHXIYQUsCiOZsmQSxdAjSiW+uAl6PIsu5bmoueKKWV/BA5kbdrlq4ProAN5+iixV2FDSYSCOZfwB2Ab/GEj9Jm6gY8EIrsswbwz8ya2PybGnDKxMMjaUtB0x3UDavdIxnZ31fGh2M/pW6kt0j2E9Yo0bA+GAtRKPFCqcHLwjrpx4PjlrXITPFqmT/SoiCGHJbyzSXeN+ep65ghNJYbyn+BoSwymG5sIX1D8VScgnR5DNQPE0jfK16gEh93BQq2C+Dfb0RfJZEncqy2/tXuD/qEwQsSf8GOiSFNtJkceK9x/q6FIZaHY0ITqFvjRclnAsQerD4GzUUu+eShkDkdubt1t7aLaxICPRpIziiCmLcMX68BMMI/GA1B5ipptm/nHbR675FBENuUtj4/9MAfzgI1F5QJNFUEsRRzwwaGR8FOwHF7sQInebUqFjCbGHoLnK3MgLCotNtTbtP7/KzMqIMJ/v+/1CxTknQNDceF7CrtSoPcKVE2QIwPuUXfbgAEisHXcmAMIdX7yooIMzVak/ZjFxuCDvtpNCfslTUeLx+xjYJdLc9k9W5rxkBzfK+ZCP2ZkmG8VrSZ4HbNLiDT9mX0bUy8aTcuDfoULZOY/ZN6Zku7zN5QgR/lIQl6xMEBOscjHui8P6bn/MbxLcrLyRvcKr/UVUr2eZLNtfTILh4y37FOAtS1xgyeFsTyAklzfvpr80/r3rbKxnoaO0Bn8fTrJGK8hM1M84qSbovTfDWXPucKGyciThPbwnjrrIHGmQq10TGILuvlaytPWBLIF2N+SyFqJX16YmFKbtjWFCoU7ZNtyW3NF/uHtYN9dySOau7+3j53h2/2hesdDvf2Do78mne4j0qmbsNNBk1dW4tSW6LYpvjRaDY7F+eD62an12udNQbtzjn8Pj9tvwMg6Gz1+9fdXue0fdZaNPRaP1+0+oPrRhe6PjTOTA/iwV/d7lm7SZgwhDfedxvtd/mf14AMohS2tHqD9mkO+Oyib3s65+et5qDTu+43f2i9b0BT63zQHpy13rdolnedD63eeeO82bp+1+tcdKGpfUIgv+R+5kjPmizx0HTWPm01f2meta77g8YAgbqNfv9jp3dy3e0AD4ip16HRvQv6r9/JdfU7F70mhdzGO/P3Gjhpvev0fqHH/k8wV//iDKfqtbqd3mDxjIg+tDtnKefpMjSag/YHwwPQ8ZNhbaUG3AgZrp8t9KaqYcoM8HAy6OhcIoLJhPWUbZven6tbcJ6jCDL8KPEw5ShkqnlRZoWxWKUZwybTkFnAMcq4zTbq3tHum9qbg8M33kH9yDus7cIvjx+Ojmre7t7u3sp2nVDR/Dmfg1T5vXTrmtlS21+n9qtEt09SotO9DzzwGK0OC0QQbpZdz29hAMwxGYJ3ytGS98V5Yj5OBFARrc6JIe9Gagm7Fgw1PJyrUDDYRhhRI7N2Z2k2HlS94sEtn2uKS+jYGadqF6SWABYqBp2mKhnDLrkwGQAakhmPDS1YRq08IXRsT6nLYn9Z7C+L/WWxvyz2l8X+sthfFvvLYn9Z7C+L/WWxvyz2l8X+siRdFvvLYv9fvdi/thejAqDdr9VW+WtCWIWFbkURRFaX9dKNm+XWnlUFDffnRhtAD6X/VW8AiirvE+lN5a8tkxeJPZWhcMcR5JxAoSCSPRiIOdyN9DE+TFWE5SVEmdoKwRXrhiCJyi57y33g1/DXtMzgkkTc+wK4nlLAvAgljGfpEKzAYoayYVrxWvDhYe2ovj863Oe8/mZ/9/XB8GjE9/ZqRwdHR1S/gWSDj9cmmcWp34lQRNID3+7BivwXBAKZBsjepEg4+dM3loTjCfI3sQRhMzYtvQwPWcN+mL1tdtn+axaAPSfUzsdLQgjdi/7KPgA4N4g7kRzL8LE3Jiet00Za1LdvEhDXuiK9NMar6O3NRN0SxZYBrHdpEVAOU2GvLNZXwBAPdR5Qmic91yBMZk0aRtjZ14zIo15s0VJT8syJdPZCVkRlB5wZtE15DDntkGPOroyffdWAxHMWu2dWkq/sBvxlhX1ldpMrnGaiXM7UUy9yll8Ucs938XY9gQQyAeKIzbwVZtpiSbTrAzQbyRWpG+SERiKdm8qNZ2qsKsL0lOrwMtbMuiNcLg2OJ0zhMo+Vd7fk7t4bYk5iRX0eT/QT7K4bgPtxibWs40ZY46PwZLwRrUa6TNYjQSe9KMLBFipbrtTwzYamtN3SdkvbfaLtLnf27NkG20upz5oDDhchNyUBDJ4rqU/2qi4FMu96zULuMBCITZF+/DgAw/4iQoQXdzNp09JvlB+ZUL5CfCNbD9M+THfHaehfrAUSSHI0HIzAEwn/mOheUEyCMqLaW53tVEVDCQoarkkRwWtGbK4SrLmzKAlDpITrHeYrocPvYzaBTJSZMorxgJI2Lm62cykzyTKTLKNRGY3+HtGozCRL2y1t969pu49mkhlVZC02T9LJdMrxPTIdCjT9yC1nAMDSU7YsM7lchXeRrSAyluVYTjFzcIb13eHu6LUn9n2+7x/uHY3q3mGdH7zefb073K+/dvKx/nJhx5mRFW0qt95mHe0r7whfjCYhKJeOlfKL5T8QbyRG6NboCFyaN4PMK+aIsckd60drSrdKsfc8nKcZki7kkOFCRujTAHaKsFEKS2+Wx+AXQzyMLJUps8upACz0siqQU0nGi1wA3mjuNkZYoTWGkpWt01lsPVuTJwgUZs14HE8Ck2KEOR9goAwWX21/w+zULtFXZfKshxyfIcesdecJgYaeZe4H6+q7bSA+Qh/RNwu8odBrdjs8BAWADYHxWVneWebnZX5exvgyxv89YnyZn5e2W9ruX9N2f0N+brOhzfk5ADw5PwfYSo1ludQpvdX/vdN0MhVLAak3Ux6dhfIXOTjlFaBKSNBMaXIiHD995VTz372iAwUm5TfEJFEAMOkJ1ntYI1ibhwqfyUp6SjFUtxVPTas3e2s8Dh4NMNYFPstPPKo0N7ptu6+okGQjicprPB1NYORsz0g4GuRNNeFH8acnnecqAd9GaHbw3JdVJGoGMmewi/he23OB5gTaEo/A20UUPGzj58PeY3wYJBv4WCe+R+cCeAZULrGH5F/tZJ8262O6bWZf+cDZIoTgFq2+MlkHwersLSgBnpajtxYvfvw4eMnGmGSSkZvzzkLirgDMpAsqQk6skVbwcRDFlUglYzrEzxqFdyRoNGwUAMPsU9gXgl3m7731wB2TSHGQIA+Aoxbnp31xIwIMfJWFJFHxpB9WQUJVXhhnbgvQbkCG5koKtFY+ha49wCgxWCOMZZE2d+xylvLFc3w9l4jvUmyuweYSNv1yiQoj2kvPnLnxIkFi4YEmaT17coPPzeHDrRO0INZlGlASlo7imy0vXbVn01HA5yK+Ih2fwo907aM4jBmHxTQEwMBnbeZNlNLiH4yh6qAZXNIR+meTRXdNXLIIt17LkeSaKV3pQj5I9J2BYYRGmfgQ4zGlIwoytdA3JvmZVhZs/jNd/vhc4JmaLyFsIqSvPP1smnFCFyd0jQ/Qln4TlVCxwLaRB3NhjRSguVh/8gSW0JzPM7jWenVCX6UxGBo8IJWw4AcT6eF44eDsL0YdCJ3BgAt2jp3Fuz54ZhYXhqaCsNJCwLIEV+kNFETEJbkZerNCFEbJPxu/yHFjUS/phMH8W3vpDZ7kz+N3/yCPV3qav6OnsQku1h17i2+othZXPsyNhzX3gZctbB1EdlPjsZuri+u1j0Fld1mLdygLVyh/l2tu2S23zfe+Fte+8tesCresnnFPKb2mtHJdKHc7qLyg8ye6oOOgEyfQ9EJwLnSYPdBqTVzTPXL4C70U/2h/Crt/qmesfPEC9CDGSEGR0ptIQdW0GcgftW4HvbWaUnQD4nFRhTaIxrRGEbgBHvChDABfhX3Eewqg0xGWKvD8EWD9VdmaRR8MoEtXGE5Sdwjbkuk0CfEDE0BEMsXvK2zzmaC8XmJCu6fCUKScKdocZaPSOIfOGEVRSWXcGeFrF4mK7DxxLvCM2r5zAUHmvVrGSE8E5LsRrrip3YYb/LE7EcEMiyWQl8AWJe8337cHKxgBWWjVVUXjqh2kqwgLSLCAYJRhr1Kr1OiDG0rHUx7m8JpPZi996GJZm+4Xr5m2fmPbqjPue6szrNLSLR2zDzfljktnqdwBFjLBegj03N9jCQ/3/g/YbD3k5dVia49PuavR4KC/CHSi9t2ROzDfQUnNe+WlGLpoM8KUBx+FvcqVbLod+jDO0H4afGqqTxG/JXd0C78/wT8HvzJuFACAqB2clK1AAozBmybc6/JN+wPZfHj4HzyHRU0= +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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_. + + +
    property name* object[]
  • Array [
  • ]
    • orderBy objectnullable
    + +Sort by index. This takes precedence over the `sort` property. + + +
    property name* string[]nullable
  • Array [
    • + +string + +
  • ]
    • filters objectnullable
    + +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_. + + +
    property name* object[]
  • Array [
  • ]
    • orderBy objectnullable
    + +Sort by index. This takes precedence over the `sort` property. + + +
    property name* string[]nullable
  • Array [
    • + +string + +
  • ]
    • filters objectnullable
    + +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/create-scheduled-search.api.mdx b/docs/api/v3/create-scheduled-search.api.mdx new file mode 100644 index 000000000..c5f7c32e9 --- /dev/null +++ b/docs/api/v3/create-scheduled-search.api.mdx @@ -0,0 +1,156 @@ +--- +id: create-scheduled-search +sidebar_label: Create a new scheduled search +hide_title: true +hide_table_of_contents: true +api: eJztXetz2zYS/1cwvA9NMqaslx/ylxvFdlr1HNu15cu0tucEkZCEhgJVPuyoHv/vt7sAXxJlKU7SJC3bSWKSwGKx2P3tAyD9YEV8HFoH19alMxFu7AmXXQoeOBPrdstyRegEchZJX1kH1mEgeCRCxpkS9yxM24fUvnajrC3Ln4mAY/ueCz0c6pFSNoS3rED8EYsweu27c+vgYWGY/kQsEWeRz4ByKMOoBv0dX0VCRdiXz2aedGjI7d9DJPBgYe8pp6eedzaC2T1Y0XwmgLg//F04EZCYBchqJEWI7RSfinJO8AnzRywq4UpP2VAOo0CqMVyLD3w68/DWEZfenLky5EPsxB3Hj1UUQhsVex7etA6iIBaPC5Iu4yN35+PYKQ61CXuPwE8kI2qzsHanKKfHrXXiDPld0gP1oGw+vaN0Gtg4XecJj9i99Dw2FEx8EE4cCbf2pJR3dtqjxk6jYY/qvGG399ptmw8bbXun09lptN2W2NlzgGejjG6pWqyU1sgPphwUzXKhrx1JmH5+7Ga9sW/Xd+3mTr9ZP2g2D5r7tUa9/Zu1aDtdlhJgUrHe5Zm9v1tvMEM/E/gRNOvjMI9L9kdqAI9LF5/d8xAoy0jC5ObMTLZGxsbdM+XNU12b+q4cye9dEh4PozXiSCZaKoWkB0phUZtXAxKwrBmFR7Ulvdd0FtX9WMVTFohZIEIALZAucezEQQCXsFZhPJv5QYS8J6MgoRDs+UZ1XVciHe6xO+4BarIpn6NxcNeFHiBBJDaKozgQYDjRxI8jpvxIOmIFPAE3iPdH3d7Jr3D97vj4P/TD27PT/k/002H35Pj0qHsBP3ZPT6+6J3D3Nr/YaZ9FmOjjYKRiKpqEH4PAnyw64QFZP8iJ7qR32Wc29XilZfeK8SAA8aH/4FKFzFcA7gEoCggPgBBGcCIjZyJx0T398XgNjejeN10OtCpGPIgYVy4T8MeAXMDVWGzBcjleHMo78WXXFmcOl8R9ceXMk3TdjNSSddNsrPDJ1Bb4SuWTcUAigUsZiWluORPOHnMsXKOikd4dWbfwQIIrD4AkueEFzHmCiaQb4gbTy5SoQJE1bDgWgZVDMLjVaubRq4UuD4MSGSAsXuu+qThulwVGTnCZPa33GK0Y36U1Qrtn1p9IVDnQW4paBDVMbD6kFYbgCsdGtRkktjfQ80m5TaVrFjNZtGurBVe78KcDfxpNEu9CpIG3XD6vTLMyzX+YaaLWrzBMXPAeGBySHjCw0YF2cIMtamUUIIlKByAkeDLoXx3jPyAsuvrpCv95c9HDfy67ffgHFW1weXU6KBnBeNsB6nhm6aUDQr4VT4ciQK1z/RgWgf0R+5CJbTFPvgeGbqzGjYXDwg91+gmJ3ljNfbioMXY206rszXP0scEJPGcOVzhKHMLSgXwCMYKh4IcoC7Lmia0Qvm0MR5k2bVkgmFV4BLYTVIBUAdI/DJBI7VMma6UmpVclb1Pk2vdxmEwYwNItiW0mdfFlWarfVD6H96biNzCoVdUBwCRfSQeWrP8bky7aMyRyQSHV0/gYxAqHfSE+1Fh3KgLotH0q7v/3qx+8fwnYB6irAMtgvD/RgAF6w5lwKC3UYOgH4x9C5ooRj72o0BARsVYiudWliISBwwn8PfatFaqiAe92OX2yqL0jZ1JgIWZJNF0AfABkwAktk4hiSCyZhEDTcwH+HAGIUZ4SAzYC/rE7yZmYcunV1tvkGgBelMTyQibBrCYEeIW4TC5GKAeEkuFQ7+j4tN/rL2Sa6V20fnezMbPSUjYQS2eSU3Gn09iv7+/u7TbbztDdqzf2dttNd9+B/xuj3b1Vywd83OIjoahwtrxMPeViSRLWRpZX6lC7TO8C/gx93xNc0axIH62DEffCfNWOrnFwXMHj6SyaX4gQWpZoS4ENas/GQpn6bKIxvgMekt1PhMrUBHwI+CqFsQCRfi6P4CVnHp//EotgfiTAA3rruERhGR5BWJpnwyi5Q1er9h9IkdxmyjMxysD530lxz17cgwVOwO/me573ei+fN5UFPSiWN3OlpIL1FjwBts2s/DZzciQRXYk15fESq88XR038CgrE4RbGZnCTsw7rvk0cRUkJ1uo4u826aLRsx2217PZ+vW3zRsu12/UWqP7QcYe8MJXM0pJCURqmrQr3Otos8gCWhXKpIWs73sD4iNg7Id4/UzT30JWhopOH1fE/qgxCfPhlRJXWxZIU++nIGDKIND6G/MFEyVsWZA/499WpVQiP/0q5v8VA/5mCpyThL5Z8VrxcJ/oGXO1hENWGv06+noS7SsUQ3zxHwHN4gvKNaF9oJBVgpa48bZGwtzJp176MuNOycL7Uu1riC9Hq97NIh9yDxAyk/ZHLhMqvw0wHYllDgyb9RZYjV7BfJ9lmvdmy6w27iUmNvmjixVcS8WPRt5q9GXDnM1+F2jlCJlKeJJgN4dy+SboTan3EHvFiqLtpFUKuyF2Wgr3e0dMbmHVXtHfrO217JDp1u91qc3u43xa2sztstXY6bt3ZbVslO1j+PQRK5TzQo1X7xEu0tqpwf124b6S9wW724upTPyrhnEOwGVKhjVoOpDtI6jYDajVI5CYVqDV3VxRuNp/R8kK7WB9z9D44qdHj+t386nBEdTjiWyshVYcjqsMR1eGIasOj2vD4fjY8qsMRlWlWpvlNmmZ1OKI6HFEBUgVI3wwgVYcjqsMR1eGI77VaWh2OqA5HPP9wRJGeRCJ6qyMrwpfAQ/J2od5Satfry9I89HBwdhwE4OpsdkFriS4wMQh6K5ENfXeOSigVOBDpftJmUhEaXFrnQ9/dACDeSCXsccBpd1cQyw50hFX076SLSKGDLSKZ2DS1K3hLlEStwV5zF+ar53doJoOuJuDOe6DV2wA9rpSE/izpAihLIcOKYcWe4MPdeqfZHu22OW/utxt7O8POiLda9c5Op0OFMBGGfJxHzRRri0P/iFovHeb54PXknwKxnIPsiQEafHN4JhobArRum07T8Msi8SGCBIa9Pjxn7T3IA9Q4pvt8vCAEZV9dlu1oaMJngRzL0ngkrUMev+lenVAIevzL1TGGnEhrqebbRT9PUOHTtt/Ev9cpip4A1nvTWIq9MlRfwYQ4xt1ZQ6mvwnkIwkz8PvQwo5f0yJNmo8CfFkyJ7OZDxF7ImqhtgYeDexD4APoMOaZU5hDDq67jiFlknxhJvmITwV0RQIzyKaF9cb8pFeVSyGKQ5CS/KGgcwPl6Pek6EZ7joGnmrTDVFsOiWR/gWUuuyF0/JzQS6RySIifCKA83LHzI0zBCgLlJQHIDRxSwAfCopF2KWPldKoK7t5qZo0jHXQ6Pww3s7twD+LFpaumDO2GMjwoGGo1oNZJlMohkkmTqbFqly5UYPoNI03Mr261st7LdDW138eGFOSpjnlLoU3Je5krxGOQbkPNcCn0C0h6IaZNGOgrWC0kFMxMi/fyuD4b9HuJhDNIxpRafMz7Srrwks0vWQ98fJvWrxPVna4EMkhz1DEaARMI9IL4zjklQWlSt5dHe+MFQgoKqkhARUDNgcz9mHEQG2bVCTjgeu/NFqH6I2ASiXzwsAPxqBKRkxrVnvlQf9+mKKpKsIsnKG1Xe6Jv2RlUkWdluZbvfp+0+GUkW308ycVIYT6c8mGtNM89xtpxBA5Yc2s6qyelJ93y0gsRYGmNZxcjBGjYbw8ZozxFtl7fd3VZn1HR2m3xnr7HXGLabeKQ18/XXmR2nRla0qdx663U0e1/BHcRxsQLlCiPfd4vlPxBvIEYIawg9adwMMq8lZ9Ypdmwvx46nfgRzA8IQOwYryotXFye69q7Jo9z8OHBo/9TsBNCuBYaUqMMgaRlGVehYhY6V+6ncz9/G/VShY2W7le1+n7b7UaFje13o2P6I0LHNMMQaYYj1NUNHF+IODM1GsCgwB3OOLjtgZ6qPxuwjHoxFlAZ6hSiy2Sk55OP77C1X8yRYCguVSJWJC+EN2k6xbZC0hQacjQEiFb4hKX19dA5PIEFMiq+EeHIqyY5xQkA3mNvdUQSz0jaT6Fs6ijkiEBIoeD7WXn3QMYknVkYY/gEFqoOOAag/Y43TrNYn1YPZBc74BGfMjj84QqDNp/XfnbJTAj08Oqbo1Wxa6xXHBXTNnCtII8SHmYavNAStQvUqVK/cfeXu/x7uvgrVK9utbPf7tN2PCNVNNLQ6VIcGG4fq0LZWZ2ks9YZOkP7VETuZiuFAH2GnE710aCGJwSmuAFVChmY+FVpnPJrA1XZ6MtnWJ2np40U6A9AMxYEH7SZRNAsPtrcfYJ1gfR5rfCZr5gz6XPn3Ncefbt+1SlAHD5lqCwPccmOHsobuec+kGfrjPYFEBdZoRwNoWZszuVYIMqfTBU/ST77UMIcMhGkyW3j+3CgT3QY2Z5BJ/BBS65qlvw2xMEeY21XgPa6bz39bT81DE1kxjzLxPTkWtGfA5cL0kP1bXC5YcCBE63UF/BxqmOrGuMbXt/k2eJR4qjlcapm5GtwQaC4xdIbNmuw1KAq9IYZnZF78/K7/MndkOw4xDhYSswcwp3NQIwK7bnJeBDuR/wn8eDyhyXULJ3LQuNjIA6GwG3UpBLvuGUGdghe4ANgmsWMnQUiBvW5fJKvnijvhoYOsZdJG5ZSu2gYpbvNCv5fkDClryL/Yf6NsdiQRoyQ6dWyTnJzHJJBdz5J58dy8nsvEvxJqtqZmE7Xw5QIXWrTXjj7h7YCFIwnuhSStZw+u6dk5ephiwR2kusgDSsLwUTxH5SSr9mw+CvRspFfk40a9ozP9xW5MA1vykkCPORPfD8W/GUPVQVO5Hsdgac9mi14ksMki7GY9x5Kth7SlDXEj8XcChqG0MvEh+m0KW3xdQSGzHdDKAi4M9LuhhTnT7Wtwr9jS9Z3w2TzjgDYOaGucCA3/2nuhYoFt4xwIB7QCHGbrT0hgGM3hoqZVivxEfpv6oPtwgFX9HZjZgb44yEAwedOKHmDrtA3ANIbd6ckyuGaGFrqwgrCSgsGiBJf59XzwnAty0/ym257oTb+1+dL387K6Cn665HOj9Aok+XZw9yshXoU0f0ekMYEw1icvst/Ndpy9cqu/AfbER7uKdra63eJHDzf6QNXTH1td/wXKkk9/bPaF1uLr+YvfR9z0BeTi28dPvT2cf/V3+YXZz/jlxdwLmslbfcvvTJonpW8qJq8xIkKRSEySmcdFnQQsF4b1B/Dgb3hK4E7CghRYf+UFw948GRg8QhgkN+BMpKCS0kzwCGewhVDkTwm6IYtCf5F8LmZM3/kKQMe5x4fSA3o19g5ydgXqGGC+jke5gervvkncL2Fy52jX7CixdYi5p9NYQV+E5XiKn1teBwggMSfWfgvSdyWSmfkU+ae9EhBHpEFR0DvHIpiGZyPce5COyNn9mrHA7EOz8QCCzJtsOpEL4ZEKYrtiVreONoCNPRHeDFUQnC7E33lQeNvrL1EEYsrsdvnBeNt0CrexLX4eAT/dScrQqtVrdbyFufeUqxxd/fsmV/y6yUWtesj2XDb6RZXGdDDB255h2RJ5iHVSqvP/a6sk/79FFAgjfPrwgHUtTIYf8Ta9dosZZZbrUn4JHai+RQb7XmBdxWyo2P3cxxEw2FncKcL0W/fQNbMn297m6hjnZ4RmQ/P7Nae6JBPwe7iJfx9YN/C/hb+uUysENKL7D1ZS4IQ2mi7+939QocXY +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create a new scheduled search

+ + + + + +Creates a new scheduled search. + + +## Request + +

Body

required
+ +The scheduled search to persist. + +
    schedule objectrequired
    + +The schedule information. + +
    months objectnullable
    + +The months to execute the search. This only applies to schedules with a type of `ANNUALLY`. + + +
    days objectnullable
    + +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` or `ANNUALLY`, 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 objectrequired
    + +The hours selected. + +
    recipients object[]required
    + +A list of identities that should receive the scheduled search report via email. + +
  • Array [
  • ]
+ +The persisted scheduled search. + +
Schema
    owner object
    + +The owner of the scheduled search + +
    schedule objectrequired
    + +The schedule information. + +
    months objectnullable
    + +The months to execute the search. This only applies to schedules with a type of `ANNUALLY`. + + +
    days objectnullable
    + +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` or `ANNUALLY`, 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 objectrequired
    + +The hours selected. + +
    recipients object[]required
    + +A list of identities that should receive the scheduled search report via email. + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/create-segment.api.mdx b/docs/api/v3/create-segment.api.mdx new file mode 100644 index 000000000..901a12ad9 --- /dev/null +++ b/docs/api/v3/create-segment.api.mdx @@ -0,0 +1,101 @@ +--- +id: create-segment +sidebar_label: Create Segment +hide_title: true +hide_table_of_contents: true +api: eJztXG1z2zYS/isY3oc0HlOWZcWO9eFuFNtp1XFsny03c+d4rhAJSmhIgEeQdlSP//vtLkCKlOSXpLm7JsM2k0ggsFgsdp99AAK683QqMp5LrUahN/CCTPBcXIhpIlTubXpGBEUm87k3uLrzLo3IDrTKxad8WOQzKPNkqAbG1h4kXPGp8K7vrze9nE8NPneSjAdloTBBJlPsC3oaz6Rhw7MRs10axpkT1GEf1F83Nk50LgYbG8yJYKGIpJLY2rCEz1nOPwqWywT+0izNdMqnIAe/8DhmMoQ2UFuYzgc1hNKPQrFbmc/Y6fmP/xoevhudMJ2RAhzGonGQDDTKxL8LmYkQ5QQoKHd6dsAa+FCY/I0OwSB3XlnXG+RZITa9AG0DZoNHPE1jGZBdt34zOOA7zwQzkXD8lM9TASbQk99EgFZG7UWGyuJTGdbqmDyTauqtWk+U5nph2OgQtROfeJLG2KgbbW9HPd7394L9vt+fRDs+701Cf6/fe/W6G4mdSSi8+01P8UR8bl+TwkgljGHYuNmtq+R/mv+O0u3Erh1MpLOEg6G8EGr4OIlre6XZvZ3BzOULHXCWnOhm971ur+t3t+HPuNsd0J9Ol/77J6qT6FBG8r+jTyn7sxRqyP+8SdBUzGNWq9Tsm8Kr1DATaSYMxiFzc6NvlcjWuaIq4phPUIT16VUtqCnTkY0M27Cz4sRW7uqohCoSBIbR4dHJeDT+xyownJJ8bNdhNAowbByypDA5mwgmIIbheSyinKGyGMVG5BivL0qhL5hWTKq0yDeZxuq30ggAmH63y97wkJ3bOGYiy6D1rQQpYJ8izps2rHQEgz0nKEcWcwBHwqYfBPvbr7u8vxtxHgrR727vRpO+6G6/Dnrd3Z3954fiTwWArA/OH+IcsVCaNAYoxMZ2Rtz0dNgoJ5AEgzUspROZQ+CAccAcZ6cXYyw8G44PfoImERpyk8ncGhsiIpiRTMgBGfrRDY+LZkfgi3Ul/pC5TZGmOsu9ezAHmJHKyBnORSSg/0BU2QRq3EgjJzIGcx8AdotMErICYp9GlKwex1jxCSPCNEPvgbo2Q+rs6ek5dTUZ4AnZqNbNwvWHJ4fw7ejvl8PjC3T/hQVcGYyO59DDpMif4RMnOPllh4t2dbmxtqloJb7Rjjinz0GC58X3GtCEGugzlWrWjRoKXozPRyc/emvUeUTwYwKH4MBSNVzpF6qEeWkm4xD8qdYLzzI+fxL9jiU4MYxkMasG2oDzJab1otaLFr08mUQzwFSulKaMxtU80VACrAqhuRTssh/BJY9v+dxgZRTdgE0suEcNq5Kr67rCRwvnaYxjFT7vN++WJ/YanSjI5U3dmBOtY8HVGmuCuu4hJJgQ+S/weuBLlLGXKZzNKfGc2Q4g/yj7qaxl2IzDN6WZiCJHMmARwCFxeIOIx0bUBk3q1sZXLmHuyTZggRSi1Tpdr7uN/zSVL1cZJWlt2XzL5ls237L5ls23bL7lYd8WD2vZfOtFLZv/ftk8ZKJVAn8QS9TliLKSD1kqLzKFudHmN7d1DyMKaZ9fKnAQSRTvKxH9UORcxgc6fIarvgXS7U8zLlFDm0gDaIivMW5kCC0Y+ZAVWaZoqtdMsmCJznYjKx+4waDxMh58BFmjZ5CdSyWhPSubAOdZ4NVqt2JP8Mlud7/Xj3b7nPde97f3Xk32I76z091/tU8UKAE35dM6MFS43Oz6RwGkQAYMASmWv4NBgBGB7UkB6vz5sEwyngkVtm41TKcvw7dbm0B33hycsf4ei7maFlTOp0tGUP7lxTr0tIJPMzmVa/GkxPzDo7fDy+MxlJwDyB9dwCeUtUKhh1X8aWLqM31LGrsB3HJcGsRgDlixsA0ndQMGxJWpV5T2m5kDMCXMxR60cL2vaVEXzaJMJ41QCuyrQPaD7IjOJsBZxTIn3EADbRdWG8MgEGnuHztLbrAZMF6RveywYRhKt/QhuDYly+VhaGktCogKCGVBL+90AeRX5zJYWqsuTLkM1iWCHNcnBYMDNH/aT4ZBXoByNMx6FFbe4lQs8TF0lltevS2MRiadqxzBEd8vzsGMAJ0BIBOMTQJMOjhitOKDBUJZr0KsRj5Abd5ZZQ5zTc8CXphnxN1ZDPDj09CqBzfCBZ9xL1UBjWg2ZLVCJUSChzhsauxqVdNVBr5d6bWx28ZuG7vPjN3lh+du29I9JeqzZu/yUrkjDJg8V6hPRt4DvKusRPTGTeQm7hg4ivTz+7E7JwH1YZWCRxu+Ij+yqXxF+WE1H7Z8gvSjmqzGXKCCZEc7ggiQSIQD0nuhMRnKmmpntbe3OptIcFC1hiICamZsrgvGwWRZoRRqws0mC7Uw6kVuCSyHiDDGIiD2qkI/1VLlLZNsmWSbjdps9P1ko5ZJtrHbxu63GbuPMslKK4oWx5NMkSQ8m1tPc89pi5ZBBVa+QGdVyFWbsnW2gsJYxbG8JnPwJr3tyXa0F4h+yPvh7s5+1At2e/zV3vbe9qTf2/Pquf5qEcdVkDVjqjbfdh7da9XsBnhcocC5TK512Nz+K/D9aYSwRieFS94MNgeTXlfcsbe/yh3HWrN3XM1LhmQaHFItbISYBnUTrJuVdekd3RRwUTGAKgl6oSvhK2ifZXhwOZaJpODFUYDcbO4PoxyGYgOldLKqF6mCuAANCQlijaxZg2NJ3IWOkPOBBGKwU0Dnr8hO3RT9ISbPznHExzhidvQpEAIDvWLur9bt745A+Qwx4sJO8AMbvXa1wxU4ACwILGZVvLPl5y0/b3N8m+O/jxzf8vM2dtvY/TZj9zP4uWNDD/NzqPBsfv4KDy2yiku9pdfv/2uaTqHiNCD3ZjqgAwThgoMTrwBXQoVSbQhEON459LbKAwUeXk9ELmjVKLIYns7yPDWDra07mB2YlfsOT2XHXQacK33bCXSydbOz/riDiz1Aq7AIaI8Z7wfaTjpk00yi21qMow6shd0xBs+ApWk3+FH55QG/uS4A1UjMJh6JcS5ExaBmCuuHF+XJXLTIyhhhbJdZfP/UeH7ZeWwcVsgD41hnvkf7gvoMtFwaHqp/vbhNeoFE2/a+cqd0kTxwcdZb6ewUq/XYG8EzPIZC7yt++Pn9+CWbIr2k8MZDzdPybClnZ+AiBF/Dcu8eG1FGyXQxtacih423IxguLIphwOyDuhCCXZXHQU8A188BiMmk2EhQ7GOr6x/KmQnFjYgx5XUWlkTHk6HaAgtt8Ua7l5TeaB0glT28jCeAPyifHUpEHbrzinXcEGlZx67Scly8Nq4vVeIvpTTfSvNJmnm5pIU17VVgT9sEELMogseGrPXFnVt5fk0eLpqgBKUu64CWcHo032kF5ax9sR4NeT7Ka+rxQb2fScidzWbMQhUzkPrikI1YMNPaiL8xhq6DYXA1LSCKvlitW+zUp4jwe92aSr7t0pc+MEHS7xgCQ1ln4hPMxERENHA0FdqQ/JVmFmL+V1gnh+zXxpip+AoSJtYMdWC+WGfs0McOfYsBxulv8xE6FsQ2joFwwDrAwWL+CQmcojXMs7LWojqJ36I2mBoCUJWkmHRgvwwWAOc+MXqAtas6AMFIpKu3fHgH3MnCpNQwVrkFsGzBVX1jDblwyW5W32oLCvPjn228OOLhYqfkVMXzr43SDyDJnwd3/0+I1yLN94g0jtrijuP54sckjspFiL0u9rwbX+Utk8ZFrdo9rUcvLNUvUD1RcQ3Xe+Am0upFpOrOjb1y8/TdmcWgyusjD90Nad75WJzHLw/MN87L10+7L58md+fMqwfVOfH6qXB7Crs8PO22EBA0SJBbydWhynLu1d1XfD0wA5vhU8JbWgmBYPvjJMhE62LSmOeITITMoI6gfZsUphj5+yaig04ITWHRghCOR7RR0JTcIAO347DSJut12HtYGKsAAgUXxXjSBaT+pt3q+AJi5QxDjR2W4Qc0OEkKhZegQIkiYRyC/IkYDaUJCptKYI2sRDkyukrEqlYlrmLwoyk6tDzMEnMa4Qa/DEQtFJ/oCyLRuN19MCTOiHOixUDORUzzj/Wai6inZEP8+zMRp+gPkAeBEotaD+9G4xWJIEwZGFcgOjqbbrlGZgvrojvD4K0z7HQgzrAIF7gJVzW5BzR9bPFDPEvXC6s3Gd/k7+i4yMNF31aKm5NohMIuQu0q/8oztV8OmuEGAJTd3eGeFS5577EY8BM3RK6uFytailRoQHtXtC3wUeCeiXtZ4o/nRH/KUF95C4SLbNvC7oc9Wve6tkeBt++g8sT9NFBit1syfguF+PfA+wD/I0Sm1g+hEpXfeeXmJdSxckueuY5muQ8ESPf/ARqjlP0= +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create Segment

+ + + + + +This API creates a segment. +>**Note:** Segment definitions may take time to propagate to all identities. +A token with ORG_ADMIN or API authority is required to call this API. + +## Request + +

Body

required
    owner objectnullable
    + +The owner of this object. + +
    visibilityCriteria object
    expression object
    value objectnullable
    children object[]nullable
    + +List of expressions + +
  • Array [
    • value objectnullable
  • ]
+ +Segment created + +
Schema
    owner objectnullable
    + +The owner of this object. + +
    visibilityCriteria object
    expression object
    value objectnullable
    children object[]nullable
    + +List of expressions + +
  • Array [
    • value objectnullable
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/create-service-desk-integration.api.mdx b/docs/api/v3/create-service-desk-integration.api.mdx new file mode 100644 index 000000000..932ac4a71 --- /dev/null +++ b/docs/api/v3/create-service-desk-integration.api.mdx @@ -0,0 +1,155 @@ +--- +id: create-service-desk-integration +sidebar_label: Create new Service Desk integration +hide_title: true +hide_table_of_contents: true +api: eJztXf9T47YS/1fUvB8ObkhIQkIIvV4nB9wrHe7g8aU3fXAzVWw5Uc+R8ywbLmX439/uSnbs2AmB3rR3HbcdShxptd+0+9HKEve1iI90bf+6diHCW+kIdij0J3asIjEKeSQDVfu4VXOFdkI5pY/7tYNQ8EgwzpS4Y8u66QZjAxYFn4RidzIas9NwxAbuRCoWhPle5imPo3EQymjGpGah+F8sQ+ECAcYdR2jNojE8F8qdBlJFjdpWLZgKM9SxC0w5xJSli2SzImzVkKDQ0ZvAndX27xcEuhwLpqfCkZ50NAs8K5qcU0A+zAhAywngCxUhHT6d+tKhJtu/ayR2X9POWEw4fev7px7o9r4WzaYCBgqGvwsnqi0qNKeNzKgvdMoWfW5YQVAzaDLFJ2KB2JYZaqvGoyiUwzgSGg04DVFbkYRPwJd08aflSUM7NSrwdKUkaIxJFyQFBkTIPLBbBJpaxi2QEJ/5ZOoj1d12v9Plnf6u8DqdZmuvP2x5zR2xs9ve6bRazl7tYcuwXzDGCmVghwZDa+FvbBLriA0Fi4nVRiJ7RqQ5P8vclL1HJoAZY91SxYDgEw7mrrnQoh7JgtKNB7k0KRT4LLRYqSl2xzVLBsxy2W62O/Vmq97qXbb29jvd/Xa30e93/osMTgIX7fAXcuhz0G86bJHPdr21V+QzN+wTjJtpuNqUA3YrwhlTSGepLz4kFNblgGFzvX+jblQ9Ifs+uLs4PH6Xf3KjSrhzhcdjP5rTt13LfDD5ClgM7pQIz4X3lGBxin1AX2ZmRjNUVn56J4KvnuAJncPLU5Id6QgVTzCwHB8evb88vvwVQ8ec//QpcL5OCFnklB0fNvJu5PRbe03e2fU4d4WAOLHrDTsCwoXTbu7u9LNBYr2hXKmnPp+ZSJFXfjydBmFUe0DPkBE9o16HUVB7+IgRwId48mRzXARxCO5kOz/XGHkqpTY5OLm6uDw6z5skebimRRaGKbfHXqfHe57juG6z1eO8u9ff9fpex9v11rfHwkDLzXIZcqmAAvtlkDONIXBg+i+aqDirD1KJHk1TbCMUwIwD4GI4Y3OjbwHoiIAZeI4khtz5dMdDlznBZAodh9IHF95cHZo+z/74Y9bv90kf01A4JqVEYSxAc7Hv8yG2w88Y0bniI+EaUXVJqDJKPD7UTxQKPPBWangM/B0EypOjRjLWudBEFQTWWwzwwVzqsQjFmqLzMOQz+CgjMdFFb3goEz/V0nXiZztdt9Vv8b3dZqvrtvc63e6ww9s7bVRf2+nuZpp0e7vzJv299k4N3aEoZzm2e1Fs+ILZaTpLIJbQpGGHvo6tWmNtMGhKIKt0ndFIGh3ysx+gCSQrzf13pP8Sz71IR78bC2AgNEA3zwY8SDgxhsyZmFlwa9wEAhczNobPYTAhqYJwBHj82GNkC6YSOm7WHxgHB4DuwZ1wM6INg8AX3IBo7p4qf5aYNM16Hvd11sR5B8+OUVQAPAXHU8guiJdy/pjDg+eBw0eAB9k7iCwBsIVYMDGmy6THFrWPeiRWV7nyEwO/t7iaKWXymWkhyQO4JtHz8bQdz101XpI3Lk6vzg+O8mnDPlsza0BQfc74i2mlbLoPYbrz9dPKTzG4VB3dEAOpWQX8KdZ+OmcDJwIvYYewqHKiIJzl09B8PWnsbfLQPJalHFuVGo0mIndJZKfbJ5HhNzFsdlvwTy2RuPZuxqwntUAPzyDXhn/KyLUNqyC0OlYyktyXf4jwgrRZFiZhbsB/HIKJnY+09mbYHxSZEmCmV1noyye4RY83Rlo18nns46qERyYI6XyQkwqcInbImM6Yq5HQq5Pxqx8/T3xcKyCFH160Gs0XDOSC9Ywa/fDi6vJtfe/Fj69vbsKbG/Xqu8PTg8tfz44ME2dXb06OD9jNzU1Nc+mbkoMbufig/GlCh7qjLX7Ap0eGGSJKfZFb+uaNAG8VZxkBM1QYe3U419Fr05ZlGxs278bSGSfKQJCF2te0whPK/E42pDXcrPFqO0s1Hcr4y+tX310fHA4uB9fmCzlBuMzmghozN15+v/r7LJdn4DuNgeMEsYrOTY76c70bp0nN58l0knLI8/h46nCLfJqfGKA2WF4kLG9lP+7TjGuMRJRvpzc22Sa7T6wG2W1joSv2OZ1ubDbgIyS5DVbkirhNeWscGo9hOcpskawmso9Te0dexja/Tyg9fFFmj9RfwOtD1lyMffz4+tW2nR+w7n/A1KCCLPXEOsW49t4mJwifaS3ORDcAeoqA2HzKItTR/BZnNnQpGYAZTyOUqAQENXITA9k0LK+BQhjEo7FBj5nEVwrkHgNu0yIDR5+n0tZWCqJ+QIEs+1Oh3BwmpaotSuluGeZgcFhvGJkBowxBFpB5DFo2z2xPygkGjGIU8zFJD00klPQlQGQtXYFVYoHMwf8x8gG29QOFaI97HqmMUhiuZaS/qBJSFMDyTAkNHu20s4mklwUEZ8Ulx0Ou2PqUkte8W4P9AunVNVAFBYtwXRyh6oAxu6xD5UjkaQIGX5QkzcLcdSV+x/2zTP5dWIPdJ8kZsHztlvsxFgw/ifknlHlYyFGYdZ6CkZdlrufi4aWZsKxgcn51sgB76cmaoHfpUItFk2ZnTwx33G7X6fJOr7s3dJs913GGe71ep+X09tZHt0R+eamkjKOBDCMKi2SZrKMWAQY2sZWUh4ePpRg3UxinlkhwvuFgg0Mo9BQ81Nit3WwWXd7FkoJPOym0pDaV7oW9gmoXpdpFqXZRql2Uahel2kWpdlGqXZRqF6XaRal2UapdlGoXpdpFqXZRql2Uahel2kWpdlGqXZRqF6XaRal2UapdlG95FwUodso2Sg58iVHnKAwhp9XZuYjiUJlVV3YODwOXTsVIdYv+3XjK7snqlbXZqTkI3DUU+xbiTX0UmjKHIJYBBtpFNEWrCWrWkEz2fqhd3gKgiUaLveEuS6LygRUGFR9y5xPQOl5/cyXpwqSbLnhLhhU9wYe7zX674+12OIelU6vXHfY9vrPT7Hf7VCadCK1hiZstxiQr2/zQ/4b0EUoHYqRDgN4FW3HQPTFAg5fUdZbYgGisoX+swZi2qZiWX1iWfY62AKK+OThjnR6DSD2K6TkfLShB1a8uCosMkNwQPg3lSKoyVpJwcHj0dnB1cglPzo/+c3V0Ab8hrcIZsQEud1x0y8Ampjvi2AqAGyNa+KAO4TbYS0v1JQiE6TjTUNqsPtOgTGYzLvSwo5f0yJKel26SqUTz5nPENmRDNLYgFeLmDI9gATDkWBvCNS40fwmwUUyj+onV5Es2huWyCDcbbJBmBkZBXkN/KppAyqBNTiLgxTCVBZ18C+II0mkEwSFvi7kqF5d8SUw5yRoFJwdw/rifwFIcwCD5RG4Wpt5iWbT2AZ6N5hZKyhmlkUpnkC1h3Qgt/RmoMcSFPpU+ZaSZDUdoLg2BRyXt0oiVDaoU7t4ZZkyAhHjGY73GvAMYKlWdREu/uBV28um0xuiSNRIz2YgEX6LY1Nm2Ss2VTHzmSeG71dyt5m41d9ecu4tfntvXQ7LQp1WEPlfKHvjF5FmAPiF5DyxCkkYG0xtDbuEJYguRfv5waQ8Z4wrJLGC+ID4yqbzA/CC1h3k+RPiRGitnC2Twdr4q8SASCXef+J5zTIoyqtopjvY2CIcSHFSVQESImiGbBTEtYcNYEZ7leou5gdDqRcTGHOJjcoQ6SE9R19Nj1BWSrJBklY2qbPTPyEYVkqzmbjV3v825uxJJplzRbLE4SceTCQ9nxtPs9+b+FmjAkheVWTrlTFV2Aa0gMZZirFoeOdSG7daw5fUc0XF5x93d6XttZ7fNu71WrzXstHu1bK6/ns/jdJLl51TG3saO5vIZEeJmRKzAuXQUBG6+/EfvF3kY1mgnMsHNoPOGqUNa7Ngp2T8JIpANCAN2DJeUF6/OT8x+td3oDO2bJgizjerMjgtCSvRh0LTUUQUdK+hYpZ8q/fxj0k8FHau5W83db3PuPgk6dh6Djp0nQMcOQ4jlIcT6O6GjK12CZh4YBWRwYlCvQtg4BVGSFx3SaR/xcCSiFOjlUGS7X/J2YRCwd1zNErCkc5VINVcXhreAXoueZd5dUcDRCEKkYhC1JKBb9Co8PAWYFA9T+XIiaR6jQEA3nNUHHh5EMHMm8bd0FKkcPwYOKSjgayo47h2XUfJqC1CgOugIAvUXrHFaa/2pejA7R4lPUGJ29NkRAud8Wv/tlr0lgO8ThBguLoytl7wuYGrmXMEyQnyemvCVQtAKqldQvUr3Vbr/Z6T7CqpXc7eau9/m3H0CVLdoaDlUhwZrQ3Vo22iyFEu9pVe3/2rEPjBHH4kDcm8WOITV3TkGByVoAQ8lvlYMg1wBxD8wrjyIozHOTOmqfXtGq45ntOocr1DfNycFMRotfp95Yzpp9RHfXp0I8FmUfBpQRXfKcYDa9rLOuobMIQo1CohDH5qPo2iq97e378EvwB8eGnwqG8l5dRXcNZxgsn27UxLlzKEl9FCIk649lzQ4O7bLmgZZM5T0ej/NBhrA2Da5KyA9R7KSfnLKbQYrHmbIbOHLztZ56TGd1FWz5I4MctaCjCDbVeg/PCbPLzur5DBElshRpr6VY0F7BlwuiFczLygnvnSBEN+MXvCoedrCzYV2YbBTbNZmbwQP8WgtvW+z8fOHy002QmBLgSXWiKmFxJUITM0zcBEKnIPk3RPsRLksOWIh2CD3dg9OVOb5IDC7URdCsOtjq4T3kFHOIQWQSrGToKiDvT5uJJZxxa3wMdk25ppEx4PJsA0a2ua5fpuUWGkFIpU5toBHAfCWCnOIEb2d2lgRaUHJrqeJXDwj13OZ+FdCrW6o1Yma3lzgwqj22jFvizsQLZAE9zVp69mDG3r1DD1crsETpLrIA2rC8pF/J8tJrPZsPnL06kgvz8eN+kBH9PLdmIldTEPS9V12zJxxEGjxI2PoOjgNrkcxzKJns0XnAus0I+rtZoaluhmyLuuAQYm/E5gYyjgTHyIGIAgUmGoMTcnfyLIw53+j4zW/5WSmx9f4lzGgpRs4+tk844B1HLBuYoC2/NsbmTbp2hWUgeKAcYCDuf0pElhGMzHP0CqN6kR+m/pganCAVXNOdbpvPuzPA5z9jdEX2DptAyEYIXz6lhqdvje0MB3mlJUUHxY1WOTXDyALL+jN8JtuoWJm/trkRYkH8xoNXhXwpaP0kkjy9cTdvyniVZHmnxhpLKjGWuf5/M8AHc1P8dHtAI/etZbeDrD6FrTMJWjLbyLLXkS2/B6wwmpvnTu70rOMhTu0svdk2TbpZVS5KxJW3CU1V0JyE9TilU+WcnKnUv7uheWXIqWEc3cZLbudpvROlK/8GokVt0gktzpUty1Uty1Uty1Uty18ydsWlt+1kN4vs+qWgl7hYP5jZ95XHXm3AZWOkNtw+ujJ7zScrnd0G1ElDWWLjFksa4oyxY1BTfd4wk/4luIPFem4E5k/XYiliiwZvAIJoav564RjKWhLYQpZH1nZQvgYTAhug64Q4+O9ZEhoRMgAb//hPjcXwjXYB0EhPg6xXotHeYDq74Et3F7AtD3DaQuJ3uIzdhBMJrHCqyCBiXjCOKDAR0AcxFknNmsNJ1BKJJIFVK1JeyXAG9EhqoJuRhDhRJ96Fk1ksNojYwFU03bjGRSJFrFmnAtyLvy0qpivsj1GGwBifSz8KXobLJSE0iIzwrvjywJFIKbs2w5BONq2nfQ2tgUiNuVCh51Gs9Ek5BHoCHBGhq79w5eFP3uZh18LV7emO+9fy9/NtHMQq3/bU9wfQ2FjU4009d/r2vL6L8CYMdaKodH9Pe6jYDH0AR9D6MAi/fXHea0TPwFxs59CAM1ECruBX780tyzbgn3xzQTEYKaH2aNZ2TZbzj47xd2q2tD+uc+J2QII+R08xJ/7tRv4FzHx1IgFjej5fS3ZUIM2hm5SgShbgNtfUMyHh/8DCiToZQ== +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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
    + +Owner's identity. + +
    clusterRef object
    + +Source cluster. + +
    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. + +
  • Array [
  • ]
    • planInitializerScript objectnullable
    + +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"}}>
    attributes objectrequired
    + +Service Desk integration's attributes. Validation constraints enforced by the implementation. + +
    beforeProvisioningRule object
    + +Before Provisioning Rule. + +
+ +details of the created integration + +
Schema
    ownerRef object
    + +Owner's identity. + +
    clusterRef object
    + +Source cluster. + +
    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. + +
  • Array [
  • ]
    • planInitializerScript objectnullable
    + +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"}}>
    attributes objectrequired
    + +Service Desk integration's attributes. Validation constraints enforced by the implementation. + +
    beforeProvisioningRule object
    + +Before Provisioning Rule. + +
\\\\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\": \"RULE\",\n \"id\": \"048eb3d55c5a4758bd07dccb87741c78\",\n \"name\": \"Before Provisioning Airtable Rule\"\n }\n}"} language={"json"}>
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/create-sod-policy.api.mdx b/docs/api/v3/create-sod-policy.api.mdx new file mode 100644 index 000000000..9bfb8f405 --- /dev/null +++ b/docs/api/v3/create-sod-policy.api.mdx @@ -0,0 +1,132 @@ +--- +id: create-sod-policy +sidebar_label: Create SOD policy +hide_title: true +hide_table_of_contents: true +api: eJztHWtz2zbyr2B4M5c4I8p62/KXO0V2UnUcO5WV5np2poVIUEJKASofdtSM//vtAuBLb8dJLsmwTWKJBBa7i30vQX+0QubEAY8W1sn1R+tNyIK+FBH7EPXiaArXLO6Kk1C69lz63Fmc3MFYZr27f1ex5JwFNOJSDFzrxHICRiN2Jd3XaqBVsSI6CRHC1eUpMRdhlstCJ+BznAezRlMeEj01JGMZTclLJgCsT6hwCaDiwbyIiwnpOQ4LQ/KchswlGpkKueMwgxKfz3hEpEfaNcJExCOfzeBnSDwZEEadKXnqMy8i/yQBn0yjA1gRqAg4VQM2roKI65WqN2LI/op5AFgG0me41uXw5e+901eDiyrQGsBdFkbPpQuM/Ki+wmDgSxTErGI5yFMR4S06nwNExbfD9yEy4aMVOlM2o/gpWswZsEWO3zMnArjzALkccRbiXe7mxoRRABhbyxzVnCYwtGKxD3Q293FwzavXvQZt2UdOt2W3xl7Tpo2xax+1Gu3jmseaY5cpMqh7KfyFxvu+Ygk6Y3uv+TwOuUD2XeCs/PKai/aHxd8WANX7vZYW2I8ZBT5ZLoywI67gLIsMI3iD3E2ZIBEKULZRJBUnt1rAoFFr1OxaHf6MarUT9adaU//9dx3dM+lyj385HBP4j0KysOauPbpUH0CxcpdRjCNANcOtgI5SToMzE2GM0u9IuMmpcJQO4IaCkMS+T8c4xSAm70CHh8xbJ9FLWOHIJyGIq9LbRXVF5vX8ndQZOKejS4IjFV9FPEP7Mzg9uxgNRr+h9cmIS68Cvvvo1TKmZHC6tHlOt35co62OR6nLWKtW73jjFqvVj51GrdPsWnurU7KUy8O5TxcEZxXXuorncxlE1j3AVOYumXUaSVwH7DcLYLO1YsJOsIDBlj1ASs4MBGO5SQYjj8d/fvtvJjgrYqDv/BKzYLF75StGAzDUf+HoHXL5b6qs9FPunuxh1yYHpHdxSh42yTtQhgqEHQSfomtAtwimP3wAD/PTiWPmP33FIz7R1xKYBwXyfqK3DJzajAo6YQEJ2C1nd4ofUUABnKNU12UOD+GDdnJwlwfkxpKx8oOZlt5YhMFnuWBs3RY5MgiYAthzb/mDJCSbSqiemydCe1ApFN6Jy8TPCTaVhMCQhFMZ+y4QOpNIuXbB0ZRGaCmFjEjiTnOkvpdj4sVCrV9dR1kYgXXeTQ4YaACooObMMxOwkoMEBIhAzpicXby4HPbPTuHSxeXo9/RrwbakV++TKChFgwYBXaxggYMMcZnJTU1mCvjaGvVe1uEK/GjgkhDFzNZI5H3iZGUw2DtkeGI8J2AxOP0swYNxcg/DIZn0iUgU5WANUrdc+ir6UvayF4Z8IjBYxCiQTxDRZRDbYzKaQhjG/lqBS0TnVe+i9/JsCFeuRr3RoG9VcKWVkPiURZT7IaFjVGaUyxTlkCjPCtGogUXs1B8h67RC3QgNH26+BIUCK47e+mUg4znK88BMKHA3w22rM6e+f+mpTKF061/frS+L5v27/MBftws2mkRIM1wQ0jxbxhJsMxUryLrMw1ieJPaRJlZpSiFRYxDVptByRjKhRCsOwKCxD5GyR/0QRWm/TV9ZEkyiDgvG2qkE6EzTlM34C3XPyi1qvTy7OBv2znMik13pX168OB/0R4MLSOL6/bOrq9+f966W7XgyXjnKdEWdI/ZNCrldLYpCj0loft720ftJVZp04fDEQSZMAaxhWuxEkCKHhR0C4yzYwuZCJ2Qap3MctMtX4SAVY5hJVQLZTsBwlyBo4SqpqKv0fUY/mKRc+SnCdTSAqKDcw9iB9l91+EI/mC/t2qpf28ChTfKUOWswBednr+DnmtIDTEqCEg12QSIJAs8hDFV+OEhiXqKSdtAGUMOin8/g72lvBqfJmpqmhy6pzdFxu3PstBtdpwPm6NhxaMfr1px6s97c3xz9FIO/sNE/okUpWKXHodhzYWdhjwOMJcCW3ecjmBSrPO806xLaOp16pzNuj2tAW71z5DQbzGvWaadjJaQtL1F5BNSjjVAL1nVJ6eGOKiWV2lxqc6nN37025271Nzr6XQFYVvvOeKQEe2OB2QyHIbfUj1lmJvJTbD3KNkXVNfXzPUp0aypyaaRc5OxmWUw5qwJMXeTdVmsqVofW11K+ZLFjtbbx1asSpgiRrxokXRGjx+8Kmfq+WW4+s953zu7EdzmVzWWFn1V+0kyF5CWpmKAUUu+N0fqOuHw53jbrp85y2Vc+zp490nCBMVkTVBRQBoH/rDgfPw7nrrKquHFJ026NQVsubmTfHiJVR53jhtelx0qqml2n1mbHXp163sOt0gXYl9QqFUrU5ptJNjnab1QGarDdYMH666q8681Pf03J1NiDd2uNRU4hVA5dNBZ78CZvKNB37TYDepThqdnXggu6v9d7Dq5mDhZZu7hGrb662bmWV9LyK1uhZSu0bIWWNdOyFbpl5bIVWrZCy1Zo2QotW6FlK7R062UrtGyFls2TsnlSNk++0eZJ2QottbnU5h9Fm7+dVih/QHNrZ9s0LbTuqCxm1c4dA7/XPmyx45ErBe0SUnI5JLuHHa2UmHb1oPaD2z3Y3IEpe8hlD7nsIZc95LKH/E31kM1uZJWGLXqmZ6jdajecet0dgylqNpndcpp1u9vqUvuo03G6bQZ/vbq1tUO96u3bdr0xqndPWkcnzeO1bn5pRNLkbtVqqwLYh+BQROQsCMBo22TIojgQYMO59gPmLDAZS1cVbLgAQeaqv/mZmt+uqov2pbtHNPwCkih7ElCOGDKFsgMTMTO45S7K20xCkqNBpq4MxxULcsCJah2CNZcMDX19QwzGfQF1/gRY+5S33wgO80kyBXx/mtytWZYdMTru1LqNltdpUdo4btWP2uOuR5vNWrfdVTXHGYgS+NvdvQUlLNwhvnRgR/5m6Jkp8F6fE8fFrb1TNAVjD/5j/1uPTck0+BI8Zl+BwOV5/zVpHRGfikmsrtPJEhOE/eZqXUFaA74Ei8/X9r2TfPH07EXvzTna5OHZL2/OrkYbCu49AdLqolgCqiALU6njKEPAHYWQhvnADuZWyTMD9RkQBGFWfiDX38JFCMwkpg4JM8zqa2bkQRMvkLOCKjn6nQTkKa+yaoWM8dqMRpC5jfPR2DM0K/PIPjecfEamkAWy4KBKeq7LTbdOuRVsESwAEBhRF1VXA/BiUGWmXiuAgSFEaGBgi3uRsXKlOWKSn/P8pqByAOa75aTnRDEgp8jMa2EqLQZFsz+As+ZcEbtRjmmKpQvwPWBxYaS/SPqUZAy08SgkxhzhdoVgeEQyLrVY+ZxOmbtXGhlVhMf6Co3DPfTutQ/mx1akpTdumVE+TLONNVK7kWyTsUhwU0XyONmMSrcrUXwCptx3S90tdbfU3T11d/nm0DzNZ+6q0GfNI31vBI2Bv4Fyniuhjy6WCkmSQTpD0xtZwW6VCZF+fjsCxf6TCfWEwYc5psCfMT7SrnwF+V66H/r6GMOPdLMKe4EIKj5qCjywRMw9UXhnGOeixObqai9kMOYgoGJNiAhWMyALGRMKLAtiIVT3LqwQV7JQPInIlObqBVLXJ5nAt/BwEZWRZBlJlt6o9EY/jjcqI8lSd0vd/T51d2skWez+mTgpjGczqoqlIGnmPlJLCQwgybmS7KHPXB04i1YQGEljLKsYOVjjRn1c944c1nJpy+00u17D6TRo+6h+VB+3GtgbzXz9dabHqZIVdSq333ofFYshiLuFOC4WIFxhJKVbLP/F2N7x0Kyh6UnjZuB51RS9VezY6K7GjiMpySsqFkmEFBZiSJHxCG0ajJ3h2CAZCwMomYBdFARMFQe8UJTwDIZNAhAa/b5EVF6kAuAGC7vnRUCKVpREyNJVuHD8GDBUlsCXGDVLECwORDIPYz6AoCLYCVjnzxidmi16VCRPhkjxuXpD5NkHhzFU9DRyb6+r7w6EeeD/Sm/whkKveTREgABAQqBtVhp3lvF5GZ+XPr708T+Gjy/j81J3S939PnX3AfG5iYY2x+cwYO/4vI2Py5E0lnqhjiJ87TBdqYrBQIk3kY4TB6rcnMTgKq4AUUKE5lI9TTyn+PJz6zB98Tmak4qlA36NShz4MGIaRfPw5PDwI+wQ7Mx9lc55NTlAI+Rd1ZGzw9vmGnuDDwaEyTO6bqyf6Oi9Hpisoqr4GnAUXW3n1AKay8mxjhC4rSrCW+EnD74uZAyWTYGp4BEiI0bqMj6XAjnEk9AcxUGurNAItL0J/Ptd9Pza3EaHBrKBjnXs27oWjCeA5RJ5iD4+DGNebX+FwbZefeUF95kDwQStsbLYJQ5rkOeMBng0UvUsnv78dnRAJurJE1RxfFB9Qhg3R3Veg4goE9ZL6vc4SXmVQMaTqUK8V+iQoMoQzweCyY24YoxcJ0fTLsC2D8EYK5biJKb0H2e9e5rsjMtumY9ur5pxEgWPu+IQOHRIC/MOlItTuQAX+gQ/Pmp4I2xyys2zRfohSUOiSu3I9Tyhi+bo+lQk/pFAszU0W0ELD5aw0Ky9dvQTNw7oLYKgfqi49cmLa3h2Dh4mTnAFoS7jgJwweBT7Wk6ya5+MRwGejfCKeNyIt+r59OI0os1V8nTpgDhTKUP2L0JQdFANricxaNEno6UeireVRtiNWg4lWy9pcxuiQYXfOSiG0MKkT2mqYERCnCZcrZJ/qJ0Fnf9DnZ34o0CzunyNZytgpCud8JNxxgVtXNDWNiA0+GufhIIFuo00KDugBaCf7b+yBAbRnM3TsNZadQX+UM1RT9kBqgpKOD/RX04yA2c+EXUDR6djwARjMJ12+uA7MbDQMRWYlZQBljm4iq8vwR8u8U3jm5ah0Ed+a/Qixb2sWoKHlT+3ld5gSb4du/t/snilpfkRLY0Jb7HqOMx+Q81Zkoikj4bnXkr0xU+2bDk/nj7Vm57+fvyxli/4WpTyQMrygZSld3J8neMiDxKoLSdE9npQ/WsfCPnaJwN3HR/57glECUD3q8TK1EXyTl9nr6u9DGy2TRn8C3dV5KLqCqDK+peQob7lwcxB8NHHqxjHmXKmqqBzRiPMhCvoZ+VMxSWQ/qOI4QsmENBEHV0IwIBTn465j68MIW9BmYUDLgdLTPjcGEB9L02t6Qq8zmt0WuQ0cWSQUM5mscCXeAAS8YyAgu/ydi4PnVgHZSD/giWUSZXWprOSCAXdKLKiqootwSy89LBdpk3SnmuBTwtNrwwYmZO1jJAhM+97gXHFcsQu2OBJ7Snz5+hEQJnBTOc93qvBaAWiRFsOdDmsKoPJoZkUHuJYfF0OEK+FoVmtVWuWeq1XGIFtzcHtq+0rvq5r6eV0aWvwh/ntd0ZRsapyOMcOAPIm1lUeXUq7tgqlNPANU6lsh/XxIxaHsa50j5f/0h4czzIlZSP8BvB0kViZmz8ZOnnTlbTxvHtWhVxtt6Ip0TN04Xnr2He5YuDrSyzBW2PzS/1muq4Z0Du4iP+eWDfwP7qquRZRGKSug5MwtW0Yo+Emydy6XMZ8QDLv7/8H2dV7FA== +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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
    + +Owner's identity. + +
    violationOwnerAssignmentConfig objectnullable
    ownerRef object
    + +Owner's identity. + +
    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. + +
  • Array [
  • ]
    • 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. + +
  • Array [
  • ]
+ +SOD policy created + +
Schema
    ownerRef object
    + +Owner's identity. + +
    violationOwnerAssignmentConfig objectnullable
    ownerRef object
    + +Owner's identity. + +
    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. + +
  • Array [
  • ]
    • 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. + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/create-source-schema.api.mdx b/docs/api/v3/create-source-schema.api.mdx new file mode 100644 index 000000000..6f1cebb75 --- /dev/null +++ b/docs/api/v3/create-source-schema.api.mdx @@ -0,0 +1,100 @@ +--- +id: create-source-schema +sidebar_label: Create Schema on a Source +hide_title: true +hide_table_of_contents: true +api: eJztXW1z2ziS/iso3YdNUpZsye/+csXIiqNd2/JKcnJzHpcDkZDECUXoCNKOzuX/vt0NgC8i/RKPd292jrtVGZsEGo1G99ONboC+b8iliHjsy7DvNY4abiR4LEYyiVwxcudiwRsbjZjPVOPoqqEfq8b1RsMTyo38JfaDXl3qpRhnobhjuh+TIYvngqmlcP2pLzymuzM/ZH1PhLEfr87lXevXEEZY8ogvRCwiHOe+4SPRJY/n8CqEF/Cbos7A40YjEv+T+JEAduMoERsNpfk8um/EqyW1jSM/nDUe1tkcAzuWCa8FlMQPvlgG2KXjHrYPtg62d732YZsf7G21d73Owc7u7mSHd7Y7h42Haz2wUPFH6a1wtHU+XBnGMC98xZfLwHdJrJu/KRz8vsymnPwm3BhnH+EixD6IFt76XnkqVTPxPSanJGIt8J+dkBXtS8bClk+Nxl1XJjB1Ihr7t2JAcxsT4Z8dQMuFYSerRJooUysViwU84bHWLa1pkVhGQoHoVZGrSyUiZMk36ubEwMAkiV/BE7ddWaJAlWPJXB64SQBqT++T0AfdYHok0PaITWXEeGgn44c5hotcKufM0eI7x/VArfXVMuD/THbNCOyWB8D1i1mFbjEMn/hqLjzL7RxmyyN3/jb83s2lEpovlS0sk9AqMhwqZJGzdNwWG4TBChoH4pZDW5jtLJLJ0kxhTSkWYjER0WBKihG6QeKJCxEtfKWANZVjfSJlIHhY4v1TwGfAgUf2Hc6AY6GZi1gotV4aumyZEWZ3fjzPq7fHY459YSqzWSRmmtgjkp/yQAlgeAo4m0QizyaPIr6Ctj5YhqqSvAiTBaK3czn+3Dsf97vOuAePu4Ozi8GoTz8f94e97vjmojc8649G/cH5iB6OuoMvveHNqPu5d+bAk9658/EU2585584JvDkdDP52eQEPzgc3Q+f8eHB243S7vRF2vxgO/usX+O+o5wy7n+GHce/s4lSPfXl+Ouj+jX4YjYeX3fHlsHd8M3aGJ70x9h19doa9i0H/fGweanpf+shb//wEfj0ZDi4vbtYejn45764/u3BGo6+D4TFO+XI4BAnc5B4Bu4NLeDQ4P/3lZtj7+2VvhIM5x8f9MZBwTm9si+wlTNY5ORn2ThxsYnkZ3Xx2vvRuznpnH3vDkW6WE+g6W/DWTOHJNlUCqmhWXsCSGIa9T7Bil5f947L/HtAPPGBWvzTEugAKE9DHZLmUUQw4MlkhTmhXDI77A8vr1BFDq9YvbR/FllypZjwHe5zNGU9AvwEgtWckCqkaVnd35WIpFei2fUMBiu1cnnY1lUjArEK0r2Nw2G6cM3hDp6Dq1UQA/Fx5K9CqLLIQcgLCRhD6hJ5GHU1Rm8ojzHAPafhTFKbxnMxXTIR8EoCUgSaMRT8TraK1VTMXSPkdiQLqLXjIZ8QSLqOAJYsE0KZhBIQrGj2nAqgDKRjXVxqXlkbSgMnr9kx8rD8scOJJ0BrEP8MSi0AicoHzE0qLBweZiViHBu/eMwj45tJTTM1lEnjUGbQNHBUKATuIHxA7xtp/AZSCsBfECEFLYXTUVFgGCBE4RqEQUP1YGbemPYfRWfaVANfqMJtnzTcYDAz6FoYwJvREPhQIE2DcQDdYhOmGEgVJki4he0a9cYIZARwen2hmckajERF/spCIP2tMfEx/H1GZQLrftcYkof65pWmVUeM5y0hC8BiJi+bvsTGPYKW0KpfA+BWUtLdDiYzmILwL6Ydxi/VjEC0IHVYdnJaPEl/pgAWAxjneYKfHzoUZSNmVT0GtpAATWGoSFSnPXYS6bGSlWuwzv9UOFsRmYI754F19i3ZmrW59xIVUPVHK2EwsALjQZIBpcMYSXvPQ9NSKoHVcTzfv+JE16jHJ0UcznGrzNCir5WdA1kYEBufKzu5Fkzd49FZTJ2VY97AlRlI6qewhbA9dMJFQJipY6XU0HviJ3ug47mTkMXfOwxmsPxtBWGUba7GGAvBYz9o2Vxt6nn6KKxKDw4mJhAH7wEJ/S0IXhZsFZfkpWRlp/7QWMxzBDnKRsoyxlkohD53D1Dg3G9m6SRRhAGv5I69ZEXQ8ZlS048TVS6WJPMskZrSn0YujjePxoOV54p7nmxAgtRgD+blQ54g56cRJ79cxv1Jvi4FRgZWF9ASArI7WdWCu5v7SBMvcPMrtDsx2UHcwgXTECeGBI/RrWufLXSxo6k7G84nplPYTFLNbTU+XD3gD0LId1+f2RHh3xPp6e5C3r7xnCVFomaob/EB/UYYP8mIpipH/Koc9ZPRVOqzIV5ld1AbzyWuAKiYL8ltVvGmwKnGX48lIz0KJCVbMXIk4xZPElMvB7lSut1U7dOoTGhrMxjh5MJDvjDYyxWkbeT8dML+51C18/r+SeS6Gfcn240izpTebqTeHfXvAXe3Lnl03YvkJa7K8PLPH+VdwUkgkrO2nCYzhsU4wftLrVJ2DLO6ycoksC82Fga7Wt75PbyyrNqPXD5SdnPqzROd6q7KQRT4/y8DDsH0FUXgccVborsO5de4XfMVMTrQwgfsGKdUZgXkuSWRSMY0H4C7F66rURlmCGbx7YuqH5LvAa8x9d45avFjLo6znRh7JvL4uH5ry8lxaLzbZ0DI5nep8khzYoV7fx9I7aYPTAf0H4nX49+NgcNpzznHLbxU0XYHjVHSUp33IZ9KLPDqwrlPYO2L8BZCRW3Ob5DdRgVzL5pk83oIv4V0r4/6RBXheQsbnTwQaecqU94RcuoPzc8CNQZrHus6LtfSW0sUvUwLDS/9YR5yZiCj7j+YtK3Pyu3sH7m7n0N3basNPLt+bHm657e329s/l5OcJ7PSbGPyiJ0hTuuVMepEJskWwuXVkem5IpzRg9vo53XXOmLEFZo3BV2dJEPtvk2/NFA7WYYF0m6R5XjmJitSnHJpkSVVf9bJQ+p/AELj3XKz+QpZOaJnemJmsUGIjZXCu5DYxBrEbpW9YzvqG+9NvBdF8o8lgoGJafPgADvPDBxwk0jO1sECoDF7X5kAyxdD1vmcE8PAkWqH6ZN7xPq0QFgE3RYQUGI3KfSHNSIdeW/30qVkAsyLpKGn5oEy/VOArgYvGFosDB/t7++3p9MDdasNPkx38zd339rayqqcx1vVFP1nbMJUnpyuSa3OzD83U8NcHCg2ofPtC1PNsDcmUee+4YoYAqjZ6Xx5jrQieNGOfViIHgVvtw2a70+zsjDudo+3O0e5Bq7218984R9gNUqH49XwEHGJcS+YnuNlujztbR8BQx3KT00BTBn8gyATzWUKood0VdK/2VjmWVEIJ0GmCuS0jp8dK48hxXUSui8h1EbkuItdF5LqIXBeR6yJyXUSui8h1EbkuItdF5LqIXBeR6yJyXUSui8h/eJnXReS6iFwXkesicl1ErovIdRG5LiLXReS6iFwXkdMi8s7WVtlBdQHtAdp6UQTq3mRDm8nRGZ40+J5Ib0U5lRDASd9ifqOSsSdi7gdd2E0/L7tPYJjNWcTJPgWx7ErP5H8oy7iQuMEgkhbYqV0R1EESrTb7yD2Yr55f10wGZRdxF/PR/Rcs5qUundouWNe2sFExrNgXfLK3ddjZme7tcN452Gnv704Op3x7e+tw95Dq2guhFJ+9IJQ8EaGIfBfTqLAi/wsCAUUG2RMDNPjLg0ei8ULXrdum0zT8shhC7Q0A0Y/dC7azD9oczhJ6zmdrQgibl1hiCpMgQF9sbHnDMDGI/Jlf6dJtUHTc++RcnmKAmJa1kFapMOSE1rcAq6ALc3lHHJsJ0CkJEVAWvMU+GKof0txo2tCUGEz93qA99DCjV/TIk2bTSC4KpkR28yNm7/yWaG2A00K75zFE/xOuslMaH8AhiGXcPDWS/MDmEL2I6H2LOVnGKw1Syftxz9N5QiQwTWi3bVNu4FF9dy24yURZXI0MQE7zi4LGAZy/IN5y4wSYo2nmrTDVFsOiWR/gWUuuyN04JzQS6SqMuRubXLsrI8ozgH9lPlXbyIIpeQrAE9p2KWLlcZHg7kwzcxxLeqczD8/a3UUA8NOkqaUvboUxPkXlHkIjkU9MGkQyewzqbFqly2UNnwH+B15tu7Xt1rb7Qttdfzk0p+XMWwp9Ko7MXYZY05cROc9S6KN3BaFktpHOHumF3MA9igmR/vp1DIb9XYRUB/+xxG+zvGF8pF15RVrDrod+PrEncKzrz9YCGSQ56hlMAYmEd0R8ZxyToLSotsujfZLRxAcFDStCRDxDwFYy0ZXlJKQ6KlcbVGIJ/xKzOb8VtpZOCEjnBbzmkiqpdSRZR5K1N6q90Z/GG9WRZG27te3+e9ruk5FkyhVZi4mTVLJY8GilNc28x9lyBg2YvbfBUpOjpVqPVpAYS2OsRjFyaEw67Ul7uu+KHY/veHvbh9OOu9fhu/vt/fZkp7PfyPv6q8yOUyMr2lRuvfU6kojpBCIexQPlUrGUXjH9B+KNxJRK83EWEsPaQQD3cJ3Gjp3DihKYlOwMi7EmQlKFGDLMZISYBm0X2DaybenA5wxwMcQzAb7UF0f8hQAqEaZRA3/hx/o8qEC60arpTGOYijYUq2TpKOZ8uyIkCCRGzRIUy8fC3BRjPqBAEewM0PkNo1OzRL8rkmdDnPEpzpj1frhCoKGnkftuVX63jwdnESNGeoEfSfRGttqThOnJ1TTurOPzOj6vfXzt4/8cPr6Oz2vbrW3339N2fyI+N9HQ4/E5NHhxfA5tW1ssjaU+0YGPf3WYTqZiOCD1ZtKlI/peFoNTXIEXIKD9UioCEfyg+VFj01w+2Ly33zR/2DRXwfD8B0WHmrEkCqD9PI6X6mhz8x7WC9bpocWXfsveRg7lXcuVi83b7Qr0ya5lAX55ib6t4Fz0zR6jRVKOfDoDTFpKA2iZm6M0DQWyp/zwk/TtebEVzIhpMhu56zj0GG/hwY7iL4pat0iJSnOEuV1GwcNz8/my/dQ8NJFH5lElvifHgvYMuFybHrJ/jcsFCw+EaL3wqnhXw5WT4FpfXefb0BkQzWGpZeZycEvXKTE0wGYd9lHwCK8pUJXj3V+/jt+zGQalBAqJwnhY+HR0i7MLUCMCPcdm/LET+aHspplTqKmgkbFpAEJhv4YjIdhV7kv9bAjwTWJ3Cjcwr9/Z1fPErQjQUbYyaaNy+l64CVLcLN7cfE9OkXYPfqjP2OhrEU1zwTI7Q6+nSJtBdrW08+K5eb2Wif+w1JqaWpOoqfdrXGjRXrn6jI4Llo4keKBIWq8eXNNr5ujhVgueINV1HvQ1UeKjWAlz7aq9mo8CvSbSK/Lxa/iVTkUXu9kbXuaKVJ+5cymV+E/GUHXQVK5mCVjaq9mio9hNsohmZyvHUlMP2fSbED8Sf6dgGKFWJj5B/03hi4TILvS02X6jlQVc+EYn9L8V5kyPr8DNYktPuurVPOOATRywqXFCGf61F0PFwhNlMAfCAa0A3Wz9CQkMozlc1LQqkZ/Ib1IfOj4IrBIVtTzSvxxlIGh+YvQCW6dtAKYb9AUOUxvEa6yGFp2szwvLJg7WJVjmN5DgQdfkpvlNE1foVf9o88UZO1l+BT8M8dYo/QiS/HFw9/8I8Wqk+TMijQmIMU85zP6GTi+725M/0fz414bSE832S0FVHwrSH+yp/F5P+XR3+SM5FZ+nqf46Tf4Qd9UnYMwZ8OxjK29xBaviBtYz16KKt6Lqg+6/86B77pz748fQ86fQnzgejnozlSQBs5XOo77e4pTT34oOrMO/8JZcF21FYaOf3UPPkwH1jvVlNnByLigyJc6WMAfcLm0g0MoFOSbYI6I3FObi9IzmGYEF84BP/ADotdhX8xGQCLMSeNQIqP4mTXpiBLBDH2VgxxbJYEexWCQh9EWnkywYB7x8Bu7wEymJ9srmeqtmSH+DI+1lXRTiKIqCLoaBAarBFCssvityqPbMWABqypRXQJDZLb5GNpGhCMjksF1xz/ocbYDS5lwEpJgQUsDuQuRGOOuPSxSBWGg+9SGj2abppDaxLRDB/IBWhu3WVmsLH2GGYcHDHF39J9lyf4uNm4/MrWvUfVZV+v1/x82YMu5rN5eYtUXmEr0X1+mPK/OX3FCOR7k/6mYzIGBhc0yXQMP7e8zwYTrgAR+D38D00dV1ttsnQLOfucndA3pkeu+G5i+2vacaZeFPwVVybrPS4SpLSDXgx+8C81gp93T/RacbiSP92tS3muSWsu6lwh3Cpe6hU5hPtr3OpZUuBvQlqYn5c3QLnSGL+B08xH+PGr/C/+EXudSaC43o+X3D5puhjaaL//sHAOe+FA== +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Create Schema on a Source

+ + + + + +Creates a new Schema on the specified Source in IdentityNow. + + +## Request + +

Path Parameters

Body

required
    attributes object[]
    + +The attribute definitions which form the schema. + +
  • Array [
    • 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. + +
  • Array [
    • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/create-source.api.mdx b/docs/api/v3/create-source.api.mdx new file mode 100644 index 000000000..b672ba124 --- /dev/null +++ b/docs/api/v3/create-source.api.mdx @@ -0,0 +1,168 @@ +--- +id: create-source +sidebar_label: Creates a source in IdentityNow. +hide_title: true +hide_table_of_contents: true +api: eJztPWl3GkmSfyUf+6HtfoAA3doP+zDCMj0SaDjs6bX95KQqgWpDFVOHZNpP/30jIo86Qdit9Uz3VE+/nlJVHhGRcWdG8rXirYXPQ8dze3blomL5godi5EW+JSrVSiCsyHfCTeXi/dfKJBB+x3ND8SVsR+EC3lUc270IqHFwseIun4vKx8eP1UrI5wF+lwMFFXhli8DynTXOBPOMF07A5GQB4yxYC8uZORaTg7EHJ1zA61m0XOpXv4wGfeaLtS8C4YYEcZ213Q1b8yB48HwbxvEFC6LpyglDYTMesPWSO24NAWbctZlwLX+zxm/R2nNhMEsAQMxxWc+GMQHPvvdQ/+C2Weh9Fq6EYjC8umtf3vT6VTYaTIadrv7L8/WL0eQVvWMcyOIhvRhg54t/Ro4Pk4UeszggEiLO7dteHQi75j5fiVD4AZHWQZr8MxL+Br658AX+XPvevRMAmu2gE9xXshTszeSAZiSc81PoR+JTlTkhszx35swjIBe0E5qKHKl9KZYOEAlAe+0sBXvRGb19qRrU2UiEoePO5eAAuhwSaAEYAH7eCkiP6GxYIEIa+lO4WUMLb5acCHuaeXCaT3XGfvUitoqCkEWBkBMQzgkckFbEFXkwYww2MMyDFy1tXDqcc9KDwYEg+MH23J9CBVvBBMgH2IwDj6xg8WHCDB7wxXemEYBgw/JZ4XJTpc+4ngJgf6AJLM+XH9lcuChBIoE9QIPCYy3EilcuvlZwYFiyqectBXcrj9WKZo7KxYwvA1GtiC98tV4K9TfKkJrvlWdvcIy4By5ItWKhJLohfuLr9RLWBBnj4LcAueNrfnJv+hvAi6zno8iHDoglfHXsRJsAMHfnFZyb2wN3udGTpVkPEXVsveBGWRgUKi3rvHnWODs+ObOOW+fWSaMJTxY/mZ03rOZh6wgpILk8P3V6qjcRqJUagsOnwAPYKc1oqXlvNhqax8xA3zhP4uOO6UiJOVK+gB/WHrGB5BrP39QRCu8BuAPnT883FDPhgz4iQeEwyYOLQqf1EBvo1dq9evJrdvAxwINfEHTZkU0FDu/rWe14ZEMQ4UYr1Nm9y25/3Bv/iko7xtW8BZyKeSajni414RyF0zdwSPPwuznEdgLQ+psUpxRCcLPp4/iPjzCTtQSl9OQy4VBgazzL4aiUOqpTfo1cMFsIjJaeWHTfS6SIhKrfxx+xpp3ryWjcHaaXVL/85hW1DOa5BT05aZ6cTI+nDVjQ5smpddgSs8MmPzl51gUtAqBjBFAvDC0ttywvcsMOquslqcgOGcanRbIte7JEVyb7Mm+bdGZX/v9/ZdudzmDSH991BsNh97o97g368Nx/3btKL/aOdt+8/oqm0gYqykh3o1DGj+3medM6Pm80j+3W2fHZ4WnrtHV0zJ+VJfaE6VIrZ/ZeKvTaSevs5PRj0WpvY6BhtCxYxjT7MGwEgHGACHjJ9lhncHN73f1HEsAqCxbkxnhgamHR0S2y2cMCXM9tbIuj/RTqtvV/CxYcTq67aWajN9/MVj7StYiBThtnVuv06KjRpCd+xk9PGqBhnpWBcrN35ROtpGQFGeH4iUW5AdcL50MnbLkczMiZ322y1cq2tZfZ3wuBfpLVjYMKnIae9AxCEQVbkr3qDNf1ni8jbBK5yGcpWYkHIu9eMyCMuvS8z9GaGquBfwqMGa2nyKS+y+WWDf4AbnqINJKB4L61kJIR+hsKTzw2cwAlbjCPAhm2GJR9b5VE10C1BX5AAGaWvsHWhX6sfs1JWBobiFUwzpAOnCSoHSHeRUuEaEBABbg5ruWtkq0IiUDZIvHFCcLE158CiFIlWgfaZ/wACutjIZfuobCQTnmssWNVaqeEamKBQ4Ixk5g6AQVc0QzidwdAKZXSD1VKUwHiL251sgAm2rLcxiD5kRtoVdDpXFFIDNrLewhIk1jgPQEr/s519LNOjI0pFegtJ1WBj+uSScVICBMDpVn6wRwgQ/0EHSvc9zlGO04oVsn3PzCKBN+y3+2MB8O7UedN96adCT2yX795VVR+Y++Y8vT09FnXpWD+m81IvqRVSY94DfobuxrakWaX7RV1g+RgsRuRI5WklMb2kLxrfnYiveuj4+Pp0bR12OJxIlHZP7Jdf2zQaTzo3PeitTQ4OgF76y3RAhQxYlb6/4WMedsejd4Nhpd3t4PrXieT5ch+/Ga2XCMNviHV8dxsWTD/zYbdqhVit/Lz3gyaSXncJld6o/m2Xsy4WVqmWSwdFcKTmDaOD8/PGjGLxRF9Dv7qH5nlFIluZnkrXBuMV24K5OyZ4CFm0As4Ok29AT3wJdM94tBvinsSa0AECTjdoPskc8QF+jkf3U/GbzDv1mmPu/AaY8jBqEfPl70hSPDdbXd40xuNIJwf0ctRZ/C2mxDrbr/96hrb37T77Sv4cj0Y/G1yCy/6g7thu385uLlrdzrdEXa/HQ7+gSQcddvDzht4GHchaJVzT/rXg87f6GE0Hk4648mwe3k3bg+vumPsO3rTHnZvB73+WL2U473tIWy9/hX8eTUcTG7vMi9Hv/Y72Xd6URHlyXAIFLhLvNKpjEH/+te7Yffvk+4IJ2tfXvYwrdG+vtMt4o+AbPvqati9osyHhmV096b9tnt307151R2OZLMEQbNgwVeFws42RQQqaJZfwBwZht3XsGKTSe8yv4P2LSznap774P7Mkjx1QSGi2llRfQLaUauFC9Dw8wXtaWGAIfcXaATDhsXdIZBZewHwtv5COzq6cx7t4lF8AViRyylzNrfCXzkBuqGBGifF6sWDgIq0vHtB4Zdyk8jHhWjGD8jxJTsmR5SisgUYbuMYzgyJqeNncHiFi6rYxs1AmIueaay0tBUDh0E2DgqBtorZAtzdAnJvaCsTtDBOI3AP0cG4ayZgdJbcdfDWitKgubPyTHBkX6YgsT3gGtcLNUjMB4pA0Az4iUCSByeZi1BGsy9espUIF54d6MQVdgZuk26/3GP9soaWMosAlhyIvSJASLWkZkdOhWW4V5uSYPm/bGhxOIy6gMBS76W9o6hT8zBbxM2rGLckIhCEIwBi2moHmSRC7xv6uIUnN2cQPMXe6RAGpyczSsAkhEZqRHzSKhGfpU7cxr9bWGbpWZ8lx0SufK7LsfJa4ynJgEAO/CkLxd9mY+7DSklWzinj7xiJ2TzkRJHRAoh36zkQ27NeaJJFYLTUTjAlB0DRtC+r7PqyfasmCvTKG6WWY4ApLDWRipjnwUdeVrQK6uwNvzdb0UrNMcw9OFrbqbWS4alhT6QypShWoLhQZABovgw8+IzBK/WUjCB5XKK7jhUMgUY9ponxUQxnUjyVlpX0U0p2PvfFPNZzeWO3F/JKHz0X6sQMWQubA8SMY2jPgo1rgYi4XhQsN3IdlQXe0VtHAsxacHcO689GDiaYFDtQa1eAPpZYm5MbVYmnExQmxB3K5P8WuRZlJJRkixRjaRpJ+5TxGS7YyFvFJxPA1wqMykPjMFPGzWwvRT64wKGBj6xmgdOxTaho3x5Xz1ATYfaikFGmTi6OFI7tTsvTg9u2o1wAIzFK5SdcnQvWNogT32d1fiHfph2jFCgrzxagZIlPgelWUzBbC2cd6DM78lUif6syTbKDitfAq0cNDxChXZM8n++ilabspCyfmM0w6JDZYs3pZvkANlBaJsGdwW2He3fBeq6NfJCUr6RlcZFoMasr/YH2Iq8+yIoZLUb2K+/2kNAX8bA8yKQOOtFZHgcdgyBakd0qgk0qqxx0CZgU9bQqUc6KwpUGl6cdECiLg9wFid7m7EtIGhGmBrFRRh4E5DOjQCaNtqL3bof52amu1ed/FM0TPuw+4ceFBEsGm8aa+2K95Ja0ZU+uG4G8Q5o0LE/EOD8CklQuJBNP6/0eeWjotVwnzMfE6YzC+DQXS5uAOdMwM19hAGwiW8w46IzX7kTQSB6XVEf7dC4s2ATAEioXJiMK8Mfr8zprg+UEP9tsflfZO+Agm8ODCK16XZ+dQxmQwRral+IDeFVqSaf4zME5IwQcjyp+KjrVJ48R1llqOQZr4ZK/WFOwIe2NkD1Nh46RR/mWUmHpFeeEes0cykrN0FmCFD49DVo/PIq6AcT4Eglvp5Juv/B7ziwcS4q2MUtBRms4GM3NuJWBMeDOck3utWlaR7IY9FJAm33MwgTqVgLpE7b6XChZxf+WQmc7YFR9tWOK3ISpP/j/FJhfKwvBl+GisxDW57GzEuDQVC4OG9UKpghGtEWbhO19xXKhf0RHnVaAIjA4pR2XwBPjBajahbdMJleROnM61YNRIw/lq8NWfsM4IheDwG0grM1GQ8V6RjDkXrHHgs+O3MeW87I1hI9pvJqNR4kCntzlyC0FRzazILyTW9ER+CAJA2acJDr+q5PRKgWj92lvfW8G4lSnMWc8WobbDoHqvVxkJRRYmXPfvZF7Y3ow00WFtQCUOav5r9+eu8LkTb/d73Slhk8n4nNfvzkTH5OOzKWk3b55+Rb886x5+SehudkULp1M1UvB23wnX3Km+sdnWLcyHnbFLUUQhGgPzQixBbVU5zZA8vwqmzsUuhqN47hSnslFh/htESfBUVA0cMCj4OyliKLP14/BfN696bavx29oTybAqHIPvQ1KCuBbrTGsfCAXQx1gUJkkmhmCVVBo7IEHDFR4qLNWxLwJbmm0mrXGea11Nm4eXxydXbTO64dnwDMnJ4eNxv+mNHRvD0YdmzPUsb3b227td64Gp0idmjTGgHQlImwtPHB4cVUyqdq015RxHxKwQNPxXi5LUlnEfdmL2KNHpfgyNS++SRM2Fe/tS+aE/U3Hi056iW3t7tTMxFSKsOc0NjSthcByyvbE1oAorYZKGDfTIctorVoD/gVGO7o4blw0DutnrVPiMIi9yft4DoCI182A+4B1VGs0a63DcfPsonEGkNXPzhGsx8IDzvLce9Kb+5j1t1G3UedgDcGStDStRjNvaDqSdsp6mXRAuviHHBnKG6GwS8d4IRI1P5azXgifqoGqqTw7hpi2oGY1UuDpgiDw7LzIrk055qIwYe1YIqiimki10qVSWDvgzN16pSzRKEs0yhKNskSjLNEoSzTKEo2yRKM8C1uWaJQlGmWJRlmi8Z+mlMoSjf90DihLNMoSjbJEoyzRKEs0yhKNskSjLNEoSzTKEo2yRKMs0ShLNMoSjbJEoyzRKEs0yhKNskTjL0zzskSjLNEoSzTKEo2yRKMs0ShLNMoSjbJEoyzRqJQlGmWJxp+iROOo0SioyljiUSLW9X1Ythob6kSbo05FqNho6tn0cyiOew+Omf2MdRG2CMFl6Xj2Hrz92nFFbe5zByEUBLIFHWVsSEngFZ6WkUNqaaR2aT8QKFFvslfcBnwlfh2FDEYGPrdwu2Afrp+4DvRnugsqGp3ZLphWnAo+PWmct45mJ0ect86OmqfH0/MZPzxsnB+fnxPniSAA4/T0TugV/mAJKP2lZ8GK/A4EAcYH2hMANPn+51JojD11i2xr0FTwMlWQw151btnRKTC9O4/oPZ9niODWJqOcIwSYy4EHvjN3CutItD9z2X3dnlzjXqPZdcSxcvt2bVebZgAVeEHXEykEUDQDcFUtSlz/rEb92aSuTUO1A6SCPmXQoYeavaBHcuj4dKQWJUv++BJ74dRFvQqeHKoHOpooi5NUTu7ntmWJdVi7VpT8Ga2oLfyXEGXGCUl1eHHFKYvLbVuYn9OZRZQM0RlRMPlONh6KSZl1S7UCuU4uCgoHQL6Ht2KFEL8RT6Sk0HCLAlG7TraiXBq6cYJoRNIN2BNL/26R+ukeBkEQc2gzlCSYctugeFzdzmis5LlTUnc3EpjL0KNvMjH0pNzdxr9GZT7cCyV8dJZDaiORzBsrjaQOelBn1coslxZ8MM9iaZeyW8puKbt7ym7241DVoqqv5PoUFKROXJWMQOOZc3184h7X0z8Hp47pyoWk341TLtIv78bql+Zw0+TLGv2zZ/SPpCnPAd826yHfT/WZfG3647VAAImOEoMZaCJhXxDcMcREKEmqw/xsrz1/6gCDugUuIh7xMElNP3Jpm5sHVdoBwxPrC34v9FEH0oB0nMOuyUxc6UmWnmRpjUpr9JexRqUnWcpuKbt/Ttnd6UkaqEhalJ8URKsV9zeS09R3xJYzaMD0rShxITstVdZbwcGY8bEqac+hMm01p83ZqSWObH5knxyez1rWSYsfnzZPm9OjFh6xj239+1iOjZClZSqx3nIdicR0QBRPSgJzBaHn2en0H5DXFzM6ORHGLjGsHThwjx+N79g6L9i98mizbKM9pCDlQ7oxjVCneVimCW193ZbO485BL7q4X+B48jYUzLXWGJUsqFSyrMGFcf1NrT3DvXApKJrJzCyOay0jgJA0wdKTFa4P3AlNrZ2se+Vz0M7P6J2qJfpDnjwbIsbXiDHrfrGEQEE3nvtxUX63hzvhqCNGcoG3JHpltMNdYABzsNj4naV/XvrnpY0vbfxfw8aX/nkpu6Xs/jll9xv8c+UNbffPocHe/jm0rTeY8aVe05meH+2mk6goCIi9mWdRBYUd++DkV2B9CrRfewEpER4u4K8DVRsCb6SvL6GI/CV8XIThOrg4OPgKiwOL8ljna6eur4hxvYe65a0O7g8LVE1cIgfKyo7kYZP2bU8FFHUiqe/QeWxiSZpAElgdjYqPZe4cX5+w2QAeTA5TTZRG0WusiITw4adAHVBFguRwBNwm/vLxKXzeHu7CQw6yBY8i8u2cC9ozgDKDHoL/EZdL3klJlxjI2ScBXh9DGqod4fLGtgNjs/xJzgE2a7FXgvt0TBi3K1788m78ks3RuyTplvf6CIcqRji7BRYh7dXWqXvsRAYlruhrpzZHUFrYbAkIsw/uSAj2Pnm35hD0MJG0nap0/fhCr4wt7sUSLV49eVB3deDY7gFQ6CBdIftSXseEYUDi4Fv9g6vPOMe1ChJFedb6/VrjxRN4fS8Q/6VHq8nRajRa8DIDhSTte0setrFAZHEIvgyIWt89uRyvlhgPYyZ4g6NmYZDluARHekvL0qv23XCkxqvheGk4PrjvFo6VLXHWlXSqFK2Hh+S8QPwPY8g6KAbv5xFI0XeD9YCT1kgiaq1GAqSanLLm1MARJPiuQTBcyUx8ioaY/BB19RWJ5CdaWZD5T1QJ8SmFM71+D/YSW9qeFXw3zDhhDSesSR0QKPilOULGwiNkeIcQCr1kgE68/qQJFKAJnSfHKtTqNPwB9UHTYAGoNEqwvpB/XMQKTj0x+oCtTRtQwRW6AEVt8mG5sBrrMT71/bu6YE9mALIUzMO79MAUZugm4TUZKDSP/274IsbtOFGC9/s+t5beokn+ffTuv0jjlZrmr6hplGeLCUeVxnvl2ZtuXDCjrpiJr6Xe5WwV3iCduEBayai5iDlz083Wm5SrMRjyxuPUfcf6Qih1F3B60O23+RZc0mOu3d196a6acMd9tLuu8EleH2tg+LZLXXdd6aqAo4viMmBsve3NgJG+me2p60ILrwE1t1FuvUwzed/m9psenxWP7TcMPus05hq7P83dZ0VXn/117r9KXn/1Q8tgTc1Yvjw0VR2ar5HJl3buUVu5tbTyj5c7FlQ7Nhu5YkNVg7Wl1k/RIlcQt4f6pyq2hPrfUmGWqC+T+Ttd/VVcf2XKr56sicqURO1cL6XdcqVG+UojWRa0syooW8qTqOTZXl+TLK/ZUe4CdAf3klZGpfySTq3MzuS36QK6LBX+C1/JM6eUGRAkvs4kOcwa1Dn6sOTDWwtHUIJ/DThgpqeKfqS3Ir977Xvo7At1/8ac8MR6aL7kU2eJ1zWzd+ouKR+zp3gkEkb9zVNp1BGwKt3twy61owb2crWKXLyGGYCIVoyDO/iEN4c3bUUy6FALIwGSVzmZXtoDRzcRSUFXxQp/FQxmI/nrJwmn7Ym5wGcL1DYwEDLhb8WIDJVdxHbpdNtTY4OnWFuIJYkHKEThBimPrjfOjQiDuerGKM+fH6hOwQG2hUEwtSmZ4bDeqDfwFWZCQeoT48ofowkS9ZGpX4upZxnra7wJLn1JKx5Al1/qmi95PQvWsetXv4wGfWQreeuFujM8/cM3eHg2iKYgS8hsPEDO1LtPdN2X+QWcaE13VlgC6/AzYH9w2ypsJCgGw6u79uVNr19lSsOov/CuKaVyJq/onT7TEW5kTbWsMyMuw9iWDu0CHyVuHEbQDghKJHEkk6Ey2fy+opPNYGMWmIaGV1+/4s4JZl4f8TVdXUBmXN/nZhT0Vsr3ZhKQ+MID+ENeeEBXieiS+3SNOF1jlrli4UVn9PalufhsJMLQXAJl7lCQJftKA6gss7mJAYnwKf2TNdTTzIPTfKoz9qu+xCEi1QQTFFzaILlp200QiAFqkweKXpU6mfRgcHWdhO3RzeAEW8EEXEaWeO+PWK1DedF7Co/4RiBpM5abamo37IEmUJs5QAadjkhgD9Bs443PAvdfzN0Vbby7It5qqZALpJPrwBEfpaG0MW4C9pC91bGNGpmmuG/uPAp6bLKH3Jnb2fZjYrfkdkD3V2KhIx3XkRs/Pn+Al/jfi8oH+B/GiWup6KARvf9a0duo0EaOq1NeRRkf9YBoPj7+H3NvwvI= +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Query Parameters

Body

required
    owner objectrequired
    + +Reference to an owning Identity Object + +
    cluster objectnullable
    + +Reference to the associated Cluster + +
    accountCorrelationConfig objectnullable
    + +Reference to an Account Correlation Config object + +
    accountCorrelationRule objectnullable
    + +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 objectnullable
    + +Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient. + +
    beforeProvisioningRule objectnullable
    + +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 + +
  • Array [
  • ]
    • passwordPolicies object[]nullable
    + +List of references to the associated PasswordPolicy objects. + +
  • Array [
  • ]
    • managementWorkgroup objectnullable
    + +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 objectrequired
    + +Reference to an owning Identity Object + +
    cluster objectnullable
    + +Reference to the associated Cluster + +
    accountCorrelationConfig objectnullable
    + +Reference to an Account Correlation Config object + +
    accountCorrelationRule objectnullable
    + +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 objectnullable
    + +Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient. + +
    beforeProvisioningRule objectnullable
    + +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 + +
  • Array [
  • ]
    • passwordPolicies object[]nullable
    + +List of references to the associated PasswordPolicy objects. + +
  • Array [
  • ]
    • managementWorkgroup objectnullable
    + +Reference to Management Workgroup for this Source + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/create-transform.api.mdx b/docs/api/v3/create-transform.api.mdx new file mode 100644 index 000000000..ab579f5ad --- /dev/null +++ b/docs/api/v3/create-transform.api.mdx @@ -0,0 +1,563 @@ +--- +id: create-transform +sidebar_label: Create transform +hide_title: true +hide_table_of_contents: true +api: eJztfYt2GzeS6K9gOXuOJF+SIiX5pdnMPbQkJ8paslaPeHYs3xDsBsm2mt2cfohmbH3U/Yb9sa0H0I0mKYpyMkkkQ3PGYXfjUShUFaoKhcLnWiYHaW33fe08kVHaj5NRWvtQr/kq9ZJgnAVxVNut7SVKZioVUkRqIjJTUsS9j8rLRDAaKT+AEuG0KV5Nha/6Mg+zusiGSgRRppJIhqIfyoEIUpGqTGSx6MswVfgjiPzAg8pQWsKXIRQJsCsvT7N4VPbWFG+jcCrOZBCexNCqUKNxGE8VwDWU14o6k70gDLIpNusRzNBOCe4kyIYlPBqOLMlVUxyrCbTNdXxR4kJ4MhI9JfIUXgcRdXLoqyjDXk6SuB+ESozkeBxEg5Q60IUuDpuiA+1fqYj7tcBIAgQsz4Zxgs3AaBP1zzxIoAsEXIYho6Fzctis1WvxWCUSZ+LQh7lgGAsI4TtWVmn2Kvantd3PNdNWbReHNjuV5wBbCQp0B4PTw8a+vBjQE2XYDgwqxImBepsfU6z8uZZ6QzWS+CubjhU0xxRQW9RLosaJSqExakLEfQGoNNgPpw0RJ3qOVdIAkgkiHH8x23pgPJL3tUiOFLyibus1mWVJ0MuBJpFYxwmiKAvgCSCjkiWEKZSMBnMQXkQBYE1gYQSN8J1ZSFWfJJAXNnAejAC78CTOY7EPiIKvoyB6o6JBNqzttuFJfjJPT1s3Gsg7IaCZgBLUfclSZrIRhigf4dil58V5lHXMoOFTT6bq2c6+8mK/fDyI9CPMIkwc//ADbE2G2D8AvxePxjJR+uk1dEkF8eFIwggQSg/KxKnaDySAmwENhEcyuUoRovaznfEwjrB+P0jS7CcZBj5OVR7iu0Czhg0q8Lf69LaPv9J4u/3sGfwKZZodFu9D1c9OJDYTxvFVPqYfE5XAfyMEMAx+UccwUQgBIMqPR51wPJTHOVBO4BUvrWfVV4mKPEW/x6H0VCcMywf8FQyGutMU6BxxkCKlYvU07xVzBv9FcsjHY4IH5ECCNPO9inCeYnqXAwo+2CRTQa36xCS/H3tEnzNUUMz8WzPzOMw8CeHjMMvG6e7mpq+uVYiU0UxB+o1R+jVhkjYDP9r0odnNgn7Szbhs5uamwinIG3kYyh7CuEg2HKlMNgB2CXI0zjOSY5b4hbkGOcNSELglDNJMACmJdKy8oB94JE0XEjWLGfVJebmWM0BCMPW774FJgoxwtoDIZ2WMLQ/SOE88ogpbHNDzh5t62ewMo1SbnC9YsNDtBQvmWgbeNeGqCkqVGZfVVp9QdKYsBYAVodY1cK6ujmyhBrL6rtJTldGX9URMrIVaqhBC/cBkRPT9lQAUDHA7Ki2psyI6qr0skVS3d2rLsNtLVaTbfWdaS0OLyJc0QOvVV65i51pbQrYrlzIlSDwBRyIgrFdFSvmpZsQguga9xBe9aZXFK8ueaWJPhl4e8hp+iuO6KcBPT6BEDNrbqerD09CCtxfHoZLRHMAdQfhimIzmB4rTUAEkSRUcEcYDACAdxnnoI9yJaiisTjoaiMRkiv9GgBghUwHUnpnxm3UIqhBkApDrAQnZIyQFFEWkmTU9Yj3IFSbNUs1onfPC3FewCvVUkpYvzlA8ynBvKOltyJrCr5nwUY6SN5zIaYpo0YrsZW0vjHNfnKnkOoDBin2F+vEIMCEuMtKLL2uVKb6zPM51OcSVNJqiOIIEv2kiuwNeLtUpLdRnVL1bgWVRCex+Bqt3U1iJIVxyAiKryxoud5c1VDkvazTx8GDbHjYBDszaXiVADYmIigkuoMfWbxZP+J8A4JThER4AJL1sMeyaLFcjQL3io+UVT6BTYECEg9UwsKPMZPqCW7Glz2WE//vb8dvzA7GfswVouLVYxwVpIbAcQX0J2k7KtiQo2sEoHwHtg36IeoyWJgDSztOWNcDLqEJc7dYjl1rzjHNv8aWV2G9KKGWnxlA4nDVcZqXTkqIIEGLvXqt16ca4AJNCoOIq1qGVDU1qsyQxGYKeYzEINAON43wiO3XIYRJHSFcIo+iDRZ8nqi6mcU4+jDxlD0l3JCM5UElXXKnpJE7I5eBPYaJRewLeRRNM5GMqjNbOGkwtVwH73cfXEfB3xrygv0CZeR5uzjDhlvey/aL14unz1nZ7u91utdrPWzutXutZf3tnR3kvHzOLLqWeiuq4yIK+W3ustFDY1Uvtp8LGrVYuTPTbVePSXF/WgdFzKjWNeb+sYkYG6kw99gbcDhOi4dj4CpYXXehBuKv4SiUtr8OyAaKgrdazPBT3xEzp0FhWMVED9al0f6A0nWmm9Ibcd06N92RZPV+FwSjIaGKIPGeaMI6X+9pZFUfNkro9NQhmbEft17l9No3HZ0mJfIFxCNxscX7ppr2xBIRZVxe6FnVzFQu66sQJonGe6W+7taOjI+H7Ygp/dfHDD7uj0W6aNs/OznB9zzO7KJbZ9P3No6PaDf4hktIxKFnc7larPe+fOixEaVWETkAwprmHsq+fh5bvHBeJRMHiE8GikKUzbuB7+ZhhPbrFfnbeZudtdt5m523+M3ibZyWCVfZOruyIgnjMeLg6PqVKJt5QwJh4b5NBrkiLd3Fy5UsyiapQrSQPbI9haVnEkd0dAsLivCnY9metGagNYJv1O5pKZWv09TpIA7TW9d4okjXL5j6wRx1Fs+5UD56XgGZlqPsHJ53T86OD43MaLXd0FifWHK40aMu8gtGAyOoHg1xbh7TvbFwWC5ED2EBLaoJWkK9gBCCbA+3+AGNKUVWoxSjD5ZABTbkK2iKKyHiUh1kAIxMgwpJAVQwIvcfrE/y0lW69qw5+H8anQOrCYFfxNK0wfF1ZrCPPbpIts9EUe7BmJ3GYlgM1uEkBilsHZ0bfFId9EcWZ0CtvfVabCMLQhA2UwQHr0gyOu9yYs7IsBLHVVSDnlCbgNa4ab4Lo6nfCzmQYAFdYrKMJWuqW+0k8IoaGJkpDWSB2qMeZGAkSmzOoMrpVVoBLjeIjrZFF75rZUHDWyZwVQR80MmweBTNNCT/aERnLuuP2ozhqYAPc+1fN7D3m8XUQot2wmm+l3CgSoG4hWxE0uMigzoL9RzJJ4omRrVAaOk1RtK0iGYrlkBeJJgNnd4vaL8WKEEdwL+RGGMggSrMKODDv2K1BTp8bI4RpP5rx4FqiETswek+dnmQ0FahDYBQIRsUUwKTcFgZ4xKMeKbwBQig6x/tVlxi2rz4BoSCoGjWojAEKZfMyorgbD1Y4GIP+TM7XcrUnrpfXgB/8sCtEQ3Qj2iA0/o4uvMJuOpo6D/epkB+APiSnuGbNliCXGJahBkKyWlMsVHKhdvnEhShWSOP2QjQEM8WuXxGz/7ZehbEJOlmSpe+CbLh+WXuyf/Dm4Pxg/8llbWPDErsnvNpPv5Yy4YkopFzhcRb17BfLBWB6pEZxMv19abNYtzRnqKxJ/kWkydm1fWbWSa7xMLTjjGAtCQ0etO+VKVGPrzIl64MkzsdpE21EhAo6Xv+81vFhbtduNsSXLyKM2V4U330n1jo50uzaxuPyHc5Kw9KfcHrLGGnzCUz9VSKzdHwd2MhjttVs9QYxgO5iIBswzKHXqRbsOpYP+uC9GV7pjIDp04wajbyKK15oqCYuPbBUwLivARmL14pMXilyHHCVYnGz5F8JLws2pgfDFADKdSBNEB7q676xSk8sRZ1NEssno/G2wDKoWjUzijZbpj9rj4Gt/NfO6KFmO4R4ltD3smKIyqx14ajcUfkDpvJb4qsclTsqfxRUfq/gwFmq1+8t+JNETtGVmalROk8PN3PED0oeVkEqpTqoZH6M0RKMB8QANn2+r/0YD5GDBPz/bBTwzo7jPcd7D5b3/oXxtbPMarWxgpvXo42QIAX8ouOfjFGmkn6MwUzsqIDquYdxG0jqXfKAd4T6J/vCX3WRk+Cb/tClOeyab+Qbpz0F7cFMya9KO4ApthczExa++6ZAyw6Ny676Z1eYgF8ToBKj0X+NGy4W8BVbbRY+5J55ZK4WoENgGgYvKVlb85YRSzKCtiPZPVaBiF7cLJq+fyEUcx4tjtdzJqkTpQ9WlP4hBwhmJWzZ9Pw+phVJx15pX/LuDMaMBrg9sX7OrlZNQRPDHHqnCXeBxRCnDosbfrDEdOG32nA7iG4H0e0guh1Et4PodhDdDqLbQXQ7iG4H0Zlrzlz7c5lrtxy3nrUtKsHjs2ZVx6iu+lgdEzK+0OcStRuEJlacBTjw/aJvoc2MXg4s3AD2xBH5yNQjqZ1dZvESJIJG2DIuKCmJiCekBwgLQmL4W6Zapmk+ouUZy1FRaOrw7O2LZ6227vTJQsvtmMDao8OFuWeh7Bbx+6UsK/jvC0VmC4zVFicwmyqJ8F1ZS3y5jL6IhvkrqjVm/6rvuJoZgyiqdTFyv3F01PD9tfM1O8j/7134jOLdVIIFKPJl4jfhffGHrb7Z75wI60+3enTk+z/8MBpBc//oVj5jq1SpbBLfY1snB29P3hz8fPb29blp6+gITxZgi3Yrdltki2tiOFExKvdnMRjhsKCA+kTtHpy83fvh5/PDo4Off+z81IGKfxGjlDl4FPgRRlHXxY8yyiUIyTaqpe2Xz1u6A9B1mKSoJyZhXLxDOabVEmcLFw2QEQG7Ku5ueh6wd4fH21sIGJmf0As5V9utVnRHazg79wIU2mxEMooZVqu/u7ohoGtlRL+mDXiD8wn/seYPnmawXn1Dw63Gm9u1bSn0IyzkWigwf8yKpNttam31oZEDOndGG1jsu0FcjJnF0uIwo1ZJgHQQi7NyiPUd9quTZU26BVoxqEXRKGjO/KBPnpNsUVe6izLr05y0w3UEjz/DR1jiWAttCjroZzTiuTrpFJSST9DLgJUdUF9wqpkr8HhMcTZ6d2YQBeAp9on/J6DpSGYFcJnonFsAf1aCf9E8a5LmEyrGzyBAg67aCNbdarXajdbzRmtHtLd2Wy92nz7jegVdFs2dSI7EJzlIX38BaQtjEOh9Q/ccYT5IyzV4DiOIiuYGDnuxUD0lLXJGns5JT/5OAq15dNT0ffG9WJPZWnEgSvyCgrKLg2u2njdhcJ190ALKIZ7sn3d1KwcHB3VBx6rqYm0NBdoX8Q4XoB/zUOzAO2RkKjmExoWsik1qUZwcmSJDsRavrXmAwqs1IeviF/jrUjkR82soXC9wuS+nIbI144Hb+E/qpo5jqIrVFndVR+gtFCAOjjQavv9eDBlMKbHbFqEARjLVSJiBlwbv0/CxpRKBuDpoPOwQJrChEn9AMq1WAUO5qvyjCjNB3YayO+2t1ounz6rVblnkuOuSMM9Nr82t7acrtfD3v9NCeXsTu0Ub/w1/jbV3a5NJI1+0lFEb77aeN7aNlC0E42hk1kA61Dtz/O6PU7ZKU4M/Z1rXdlqX07qc1uW0Lqd1Oa3LaV1O63ocWpfz4jov7sPx4iLFWnEzSyNdtEpy31AXSj7gYl1crIuLdXGxLi7WxcW6uFgXF+viYl1crIuzkpyV9DCsJBfr4nZd3K6L23Vxuy5u18XturhdF7fr8mfbdXGxLk7rclqX07qc1uW0Lqd1Oa3LaV0u1sV5cZ0XdzbWpUgLc6/b0qxYlfIGtyZyU3GPxXL1uPjNH96cl+yGV+Z5OOkhLvhADdGuKFLPiP8QZXSOqXtQ1H1jqqCJAnSKa1hcqf7dXP3vF/U9oHiFZK77vy2oXnb/vVXrNgj+NguBpba9QeUMxgP/fn9O/xxUFbE35y6pl32pm5O4TuI+JInr9s2cB8d5cJwHx3lwnAfHeXCcB8d5cP5sHhy3b+a0Lqd1Oa3LaV1O63Jal9O6nNbl9s2cF9d5cZd4cY9kNrzjBLZ1Oc2vvLimYn9o4qwuTbg3B4sLHsOCSS0PMMVRXcgwhsoTsFWoIiwrw7IEldfXtDc1wy67vJ4WIRy8OChP7dV+m9vrN3FMDYTvL8X3RnEdD/JMKUyiePJ/2hM6RAWz71+MVxIbc6fwjPC4RXZoqUFdiHyMtpwfTyI+jib5Pc5Md7NbPTWmj5YafaCcbr7w5zLSR1CXcpZ1BrVLcqXLdbvICl1L8C0Hej1oqmYd9/Qij/MT4AFc6WlhgkjfrBJR0bTPFEajheUSPoo8CrSARMljamxoyBjM1UAjTP4a4DaqC8xtx3LdOuPWmYe5zigi+lTtBxLPNgP5hUcyuUrv3Dx0JO9I/kGSvGo/2xkPQc7fSeKaLE7VYMUolJXmuqeKk+7WXCfUiaFdgk9E+ajHrgzttCsctbS4V8Cbn2xYQ8sZvjjjo+dlYgVCezLVzbGrg53JJm0QfRd4j6/Ff6BtvD88eyu228+eNdqg+I2HsrGl635YN9qZipqT4CoYKz+QzTgZbOLTJlT8mSv+rCvOrK+1izN3aN3JlgcrW6iBn/AyzTsMt9/lamArJwVaYJq0ye1JeU0wwVYl0cT7zzMIquCg42FYntiHMXhZnExrc+m1amnnSCcqoRc39VunArG2pK+3V5lc0D5SYfQrmv3hVOiZnG9bAQ7iqVKH+0s7QLdSMIjiRB0kSZykKwglScGOaNlxBicWUYlCgw3lCHrIYzGKrznNGLNeBEay5muMYURGxv7EehhcIe+IY8w2dBKTpxksZU9R2Q0xQV8+WuielyfNOyXSty5uK/yb5KGq7lgu4eFoYaK7aMVEc2XQs51T7XsVAYCeQEAYq5FSPvEvLb7X8RUgqzetorayhJom9mTo5SEL1FMc16OaaVsS6xHrQa4waSY8PaArSnU+qWPSttLyxdlYeYEM94aS3oYqGuDV6b9iwkc5ZiLjLFY9ZTKMXdb2wjj3xZlKrgMYrNhXKIno6uiLLAgBHZe1yhTfWb52Yw9xtfhpO/WVjrwX3QGiFqbtFBbreHRG1bsVWBaVYCWmgtVVMs0ZDAFqdNjDJUWFX9ZQdl7yfcvwcJtTTYMCZSsEaPKFRcUEF9Bj6zeLJ/xPAHDK8AgPAJJethh2TZarESC12McMcLh/SU5bMj5o7vB4gp5Mv8j3WEofNhRoa1Tsa9em4dZSjSON0qNoDQlLU1rXDuFPwSgfAe2H8YS2JHWgSyp2nrasAc6YA+3WI5da84xzb/GVg7L5rQml7NQkiDVZ6goNbVY6LSmKACH27rVan8kgJK1LXGDCVsrHtw6tbFT3TgqSmAzj1M6VSp77FOeTUshhljpgF6QrynfbVxJ3IupFpAUmVsUGuyMZyYFKuuJKTSdxwg6EKUw0+uzwWFMcX6EvHgtjLtk1mFquUnrYB0rHg+kvUGaeh5szTLjlvWy/aL14+ry13d5ut1ut9vPWTqvXetbf3tlR3svHzKJLqeeDrToGc9+XW4C/TnsEPp2CATcS6x7UCBueTBWQoK1KLhDOKMcTPmhRmWE1AqJ+XNPoHC/flOMFKE59ApvtjoTleU9z1Hx+8uLTKpvlpnA1IXld/9Z7kkipYIqjdKYMslSDs9Pa+YMJdEPfnEyYTHfOf27ySWvFzS/7rqYIlZgM9GfHw46HHy4PpzFuDty5LdMvgujv4FNraq2cyIB5pafNbGQUofJlVn9y4nI1iujc1dEHtG+xhQmXzydxozBcqtsl66o5aNZBh744u6xt/FVklv5o9l+0AUQB92Z7Bwy0fAwEx7qh6W2behsmSq3QXwc61JXB3kW3CNcm85f8QotrvthpUc2qUKHBOqHihMqDFSqh6mcn8q7tmNt8e6s6V0DUoB8ebS19+4A+kqNNPcENlas8UobOWFA0WfLdDmVjQNSuqI/YwXvVfQXcyS2ERnEUyD7/YJ8Jwj4xFToF8sVsLsYLBvJVAWbQEXQZojIjgdjWL2sgdzYs8BBpetQzguiRuYGcDPq2ZFAcX+XjO0QQndSYl0D8esGsLxv0LRQhfjx7eyy4BaTZKzVtMGOMJYyRT6XAy+IeKm3j0GVTdAFHlqnRONO7UXTZEQeyFLRTN76m0sGLDxVRxw3aDKZvV9CpWjQEunntdn7y5Bj0tidPjHvL8FxB40bQYG3uGw81/ZU1rKgon6EepXUg9IPr6FnZw91XTSzWNU5Mo8Z0W0DNDDyqXtFVhNGmHI4Dss0sATPMRyMbjw3eEEGmxRnH22dU51B6kd4mUYy8PsUXB0cHeEasc3GGX086ezX7SqQqIEScTnI6yflAJedEJS4U1ZH34yRvrHqMtn8Y/OLo3NH5Y6Vzji/ooDfpmL1Qd9L6vcIaeLarFjh7zKfGCE6BwzZ1QDVQaxlxYAVAGP2UdsT1XVusfj7hWz65ZRPyIYVJmGgitXHqgLaQAuB7L5TRlanPmTW0G2BJUo15o7nYVu5ub3VNc79hAEZ352mr++2EYDjR8w2KHid1nNRxUsdJnd9N6piooTucfotC91YOSDvct+I5s5lA8jESsbm81poPmmOMLZtIvouZLu4OsmEQ4etEcORBdktw+YFp8rz47PjU8enD5dNxKD3VCcM/zDvfse48X+iUP5Aw2/hbU3HB7jrhVDUGCSkfpxCaKX3xepgUjKu1DV2Mbyuvep0bAJWAV5c1+LEGP/7n/6OvwnmSHac/eE6/g80TUOU/0buCYeaZnguttkbrA9/SsB0yqKAGCvYNogWrsgagGuP3/v/Jxi+dxj8+1O5KoXNKPbzKg9Anv2I1dQ713261KV+OZutyvPeKhl8gWWZ29yheMchyn69YT5B77d1F2vPXmEhBguWRXx21cBqGkzsPV+5gKkEXgOQCkJwQckLojxJCKaB60XUwtgTyVRiMgozUBTqSMC+MyiL3Un700diC+0p+s7ShMn0dmy1ByllyZo+6l/7HPn/pJUpeCcr/B51lE6XAIprE5TmJIsanInMq3F1n8vZXUevulLScfkOFrBTJfqYZvCryhhJPWwKsNDdM2pJSJP+Vo4aoFYraajV6eLpLB27VgU61DMejItXeJmWaHjxU0mL61+mrbynUrguVeVWd6ymlwBgm8WSVg9Bl0sN1pPlNEinmPCSz8bzMIxGgk1ZYwo46jaxDMohRFia8WnFexEgDDwiK+davHmqOaZmDMqG0xahOM4pMFkDyjbF00G0UPulQJgNzy5rx3hvRSo2YyHpOjshh9fOZB01E2CGdScqzt/1XBFuRo+OyVk1luLyhKA/Dr1ruONlIiUkgJW7LnmrjknApQdxS9yiWugwGsGij76uyL915br5IqkTim+JrTbBocXNHEueDIXztB5+UbzbWyg+euecQiIf5gZPqI847oKjCf35SYewhsZ9jkiLs7o2MBjkmbq+Ibe763zGFPzkm73ITnBGySl++gGI5rhFFboHfIuWunpJv3n1YpdPivOlyUu0pzHg1R6n8ukSbVkkWUOrCA6aWRRYX6Ua0mlQsu+VJ02L56VK/XTqpxqZZo71Q8FA5TO9f9tQqcFwIvupS1K4XR/twPNt08IwaetvvQ3crDZcuobHVM5NkaeEmfEw5h7WoNTAbeUiaBmODKMVCiOCciSj67cQOcQQintTWoK+b01K60Z4J7t5eNFgV+b/RnIJqRXNaSPxbZhXmVLG23WijULJXFJw+GYZahyyPPC8MgCeuwl3EAeWgYIxi05VJL3q2UfHsFlT8PrOuKmvgr5xzjcsSg/y8kAIWkvs3LSCd3vVw9S5obuQCmB11P07qzsdjF5/vyPvRkne+MGGxo27LdvtgI9GOfluesI8QSzl6Yfa/LtjvIgr+Cdg73OeB2idGK9b/luc/fyH9wfDj1Ue5vfNxuNVrD68+DmWaK89nDtVw3D1nhwumqRLzjO2UyfAaXqJohsqJJOe+l6dZPFLJ/Pc7ZwVxvgDjp0r6OB8wnJ1Wa96nsRcG6OSm5MyiIU5nDhfj3CiMpI79Kd9Yeo2ZXpBLMfZaB0BIzMLiEVdvfkw5W2HqDdVILpJvs7skGWBlL/bV3VP7GuRaY4Ah00jcBDKlZWH5RFHheD8hN2nonMpVHT+AiWZbvJK+ONXj29ODQaIFw+cK2jpcndZMFeCpYn9jQbfquZK9Z62XWzv9ZztSbr3YaT9/2nvZl9vbrZdPX1JmwBFwoBwszGle7drkLaarDoNfFLqtJeCe85Vj57Vb06DPbZvTNYurJdLjssUwNbwiU5/wNLt4tXcidp6LUDvcYHWYybylosbFGbxB3zqHA5rMrNTw2ySoumrK7XZ9Oej+wevOxRu8B/T04L8uDs7gF7b1YeHOE3FlTCatvvrSDGAi0SkTAjqU3xRPdKtPYEBSZxrTBc3pfk4gqJkOaujeF9Swm7ZdCkxqxDefMrPD0sN3fIJe71uxX+lJx8P9j4ZxXT4RQ2BllWw0RadYH03GpZGcUtyU75c3XPVzzIxJOzy45wPreDAbIVWisjobpRx5Y08KMgdAvsKmn5fleP8m5WS3uLCglmKL0VxqpS/6rEB3biGNUIp3kXqZzt/pxQkm1hc9VFNA+9DiiH1tIxmZcoXEshckEndHDMx+FtM3T+LFvnfy3UkI4qdBQys+XCvNfOQt0dqSKNUYI5GMvoWVrV01m5FS0Q9U6DvedbzreHdF3p39eKrSMfCi+UqqT3te9bmIZA74TWjxnFN9EsXWjzCF2GjhiayjuqZVpB/fnQNjXylyXoMZhqrsb6gf8VI+B3ynmA9+3zN7YGbpL+cCASQ88gj6IImUv0twlxATohhV2/O9vY6TXgAEGi1QETF5MgXj4mXMSR5pW6Mu/Fil0VomhhLkI1hpeAG2SeKiIr/BO2JOk3SapFuN3Gr0aFYjp0k63nW8+zB5d6kmWUBF3KL1pDQfjWQyZUozCfHwMjkBBTCqkuqLguVoqma1FWxMFDpWrao51Hpb7V67/9xTO77c8Z9tv+xvec+25NPn7eft3s7W85q91r8v+bhgsipPWfPN88j3I6gETxrlERBXmsWxX6FWRG+i+ijWKB7A6M2A8yZe7FDojjvzuuNxnMHY8HrpxlzuQtP+xekbQYfAuXnEG+8eINNyAkbyhqNKSTsSdFbbqY5OdXTLj1t+Hs3y41RHx7uOdx8m795Lddy5S3XcuYfquCNQxaKj4H+k6uiD3oGqWT/AiI8iMU5xvFV7HzXbZ3h4KCsUvYoWufVyXos8j2NxJKOpUZbSiicyKtGF4g3KjrBsYspioLIYgIiM8Fq8IOY422CkUCfFAwJ8Us/nnN7QbjJtdOgoGvNMGeyte9FB4PbFkDHQWICH6vqo/kEL5AcdgKD+DX2cerZ+lT9YnNKRCBwxXYSskOcL/+/TRVECh0UEA8/1LeEC7DPHW/gi9WnM4qtQQZ2q7lR1t9y75f5xLPdOVXe863j3YfLuPVR1rQ3drqpDgZVVdSjbbIlCl3pN0Zu/t8beseJR+ey7vj7TL3VwQEKq4CXeQo2d4NXNe0zKnRzz62CgbrRbBKfu8v3ItQ8YgjpSQIQ4lHFMLtqxxBo167RrDZtHPZKHUD01+xlmFmb0pinHQdPEKEfxhI7OXm8vkFNlei2QdH7ukZ3ROTnUhkmT5oOP+LJ8pA54dswtMMUJ3aXtm4yhlPmTm6kLYA9NfpwQNB6NwfZYS6l0U4eOz4wRxnaRhDd3jeen7WXj4EZuGcci9C3tC8oLgHJmeDUOKzbUcIZKOvc+RxPlwoPbA1tznb3FYlvilZIJHbrEiJn1H9+db4iBvtrd10e5iwwoJ0AiJPo6JnoEK1mHwRHwTiU+B1lN9EMYsLiMzpQS781N1MewJpyCECeUYiVFcgNrfVhf5cw2YGhTVupt0NJINkQQ8elEeNu8jBpiP0CJhQe6qYweIh+SfD8245LWuL4WiL+Y1hrcWoNaSzdmoGDUvvc43tsDfscmZJgStr66c26vYbWHBhe8wVZnYUBMaDiqUVWembWvhqPSXgPbq8JxGb2jAzDVaoKFlTk/cSi8YRyn6v8KgaSDbPB+kAMXfTVYdOqmQRzR2GpZIDW4y0bQAC2S4HsDjBExMckeruKkxMTsTyGW7NLMAs936VRNtzJmev0+iAhqTC/w1TBjhw3ssMEyINXw81qW8q2nOAaSA0wAe+X8kyTQgFoyj9taKNWp+U2qg0uDB6DyJdPjXX7YLQWcSdhCH7B0UQZEcI1OA+k4M3gWui1c0CrIMu6DWQzOw4vna6IZvDG8xSYorq1/tvHiiDull+VtFE5/ayl9iyT588jdP0jiOUnzGCWNVovRW6l9gK9if3pQnkaM+AjheQD6UQZvxXks9mVmpdD14ek1pzCYPaJYOYX4Lk6ufPIkzJ5c3D846ZyeHx0coz6vzz2exYl19nG3pk+OVQvsA4+riNNT6tNj+it7cF/jkcg3QXQ1+/l1EFICu9q/reOpzWtluLoJg0yy9B2oauuXNTCp3xycH+w/uaxtbJRd6+Ob06KV9QHobeO0qe/tSDthuP55reOPgmjtZkN8+ULGIfHLd9+JtU6O2fPXsMVbj1NqeGdP0/4rToXe0JnAfkzdaAPSlnKsrs87fVM6jAv/wteUU8gAOsC8LdOv2c1gyiKTu096w0CRu2gM04qqfx0FSzwiQaxPbCqdx21AU58AxUow8IMQp0m8w5wdgIsEbXEM04ZWP8baKC8OJIp9w7mgQY9GeYQHQwEIvI0E5MMd7O0HqZfzKgQzGykzspj0+KKWEckoNxAVTbJKwSB828d9hcBTtbuzJ+m+gIlTvakAiLQYsBzIqQo5pVJt1cxMpm0QHY2hCsfoDYAlFLRpm8WPDs/nWoTGIr2TFSeDTV0p3cSy0AjaukwM281Wk7KjonUMZrPV7h5NX+XIZ4WQPpdbKLospjuM1MQ+RcrBUsFopPwASoRAAa+mxpNV154YY/6HcmDlJuIEeESe7KoROv+suQ+XT6daF7AK1CssIsJ0W/FU4bYYxvyTWcl0SKTB45OVA+R40Y6BR8OBXqmmOFYT9Pzoc7DFedYiTSbnkIkq3CNA4PQDupF2PKZclvqqDix0cdgUHa3RMN+VYIBtq0xUW0YHXc2hZAIcVStCA1BtsxToaPtujtG/ixOasy3O7o73NcvdAQb0EH0h8PbzZ3T8oe1/g69hIUGv0vsPpWmPT9AaOwDJP3Kl0PGkd5wa51PSA7WHaX4rDb0NXIOdikvL2u6ak7foXq3hSV/aaWSfVSInKH3h393aJd5xUK9xGgI+5I7vP9eMBxjKcLtG4V6kb+ofOMybm/8FyyhGsg== +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 nullable 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 + +
    + +string + +
    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 + +
    + +string + +
    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 + +
    + +string + +
    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 + +
    + +string + +
    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","enum":["LT","LTE","GT","GTE"],"example":"LT"}}>
    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 + +
    + +string + +
    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 + +
    + +string + +
    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 objectrequired
    + +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. + + +
    **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"}}} collapsible={false} discriminator={false}>
    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 objectrequired
    + +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 nullable 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 + +
    + +string + +
    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 + +
    + +string + +
    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 + +
    + +string + +
    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 + +
    + +string + +
    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","enum":["LT","LTE","GT","GTE"],"example":"LT"}}>
    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 + +
    + +string + +
    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 + +
    + +string + +
    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 objectrequired
    + +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. + + +
    **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"},"additionalProperties":true}} collapsible={false} discriminator={false}>
    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 objectrequired
    + +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/delete-access-profile.api.mdx b/docs/api/v3/delete-access-profile.api.mdx new file mode 100644 index 000000000..203b3d329 --- /dev/null +++ b/docs/api/v3/delete-access-profile.api.mdx @@ -0,0 +1,87 @@ +--- +id: delete-access-profile +sidebar_label: Delete the specified Access Profile +hide_title: true +hide_table_of_contents: true +api: eJztW1tTGzkW/iuq3odcyja+QMC8bDlAppgigeWyeQBqI3fLtjLd6h5JDfFQ/Pf9jqS23TYEJpvdnaQ8DxlbLR1956rvyM1dlBdCcytzdZhEu1EiUmHFII6FMSc6H8lURI3I8rGJdi8jP87CAxNdN7DAxFoWJADLzyfSsMHJIfNyDOOKiS/SWKnGrL66daWu1PlELA2zrDSWqdyyoWBSsdKIBhvlGmJ4VqT4sjQ/xhZhut80YXLE7ERMMZTm2NfmBGNQFKmMnaYNdiRHgu1NY6w/s9wKhg04O80Bix2OmLRMmgZGNtttJrTGU+ilhS21EolDPoDY34Rit9JOSOMGOz795V+D/feHHxrs7PjidO+g+obVYeDs4q0bY7y0k1xLO/Vyfy+lBm4AleoGYgHf2xFoFONJIj1sviLIg3A2gwH4EAqRukkmFawuNBmCneWljvHUmDyWnCzkUNsV47fg64JrnsGMmjx+Fyl8gWNlgkeSXFxwO4mW/X64z/LRAwIJjPcKllR6RrtWl6IRmXgiMh7t3kV2WtAmxmrECWYGX2OoG/c7O+0dvr3T6bX7bd7u4NNmp9vpd/oijnl0f39Nkk2RK4OIhLBue5P+Vwf4IWdxrqxQljVh5IQiAeFJiAmWgP1uuWGmdPBHZcqGpaXHWpCL1Hw5NBqKWSxQiHohHkErum9EiJpVBKfVitsJPIaA5N5SxTyOl8IYeKR9YTBE2YNESMg/AQdtwOchvfHZ0C53q0bNh59FbMmxmlLdSm+lRFgu0708EQ85oA79nVSiOdZcEnyfDjEWEvQbmRC4LNeEm0RWgeDmtWrOhF1aHfaWJ+w02HwvKAOjWc3j3yCLytBTgC6UxHpWLWEycSXikW3FtuDDN+1+d3P0ZpPz7s5mZ3tr2B/xHkJqq9+n3TO4go+9acLeXGs+Xdn6F6GEljFL85in8g8YRAsO2/saRZtToliRmad94GQ8w/5UJf3cmZoBL7Pii6W68HbvhG1us5SrcenG+XjJCKp5cYYRVaYplQmfhNDcCz7WcizVg7moyoxq//7Bu8HF0TlGTg/+cXFwhk8ka+UIGKgqvwAVsTDJbx3ioIDLMgR4jAhvsddB6msoxJVZnCj9NzNFGcsQWyNephYrwu4PrFgUzUY6z2rp7fLmi2UvZUu0GkgqjGXcxhM25EgtlvtEfk0FrLDNo2DJ12wieCL0qxYbhDrMU3bDUwjF+qkru0kyrwSjEnkuXIXNS3eSyVjUfTE3Zd0bSAJp3YyjRadQcgD503EyiG0JcE7NxSycRUuAWNW/JFiuju58uSZOleUxtOBpOoUZtYaFXXmU1szKoiTbZ1xV83CQIT9Qse7v52odEJr3Hsy+zd2zmJfmGXl3kqL8NJ1qswc3IiSfoarsq5GYHZewRKhIeEhqu8Vh1sxdVeKzkRRpss7dde6uc/eZubv88DRwIPd0hsplC5383Van1WbHLp0Cs2fDKZhQTjTrv0OYYBzn7mXG8xxAdUoSxf240+714q2t4c6mGMZ90e+JfvdNEo92hjvDXrRIIi7nBWKWvfVkXQgkHyDOd1f4Ymyt/bqKHlD8RU3voXBF1CvvFYHvru/df0RHO6vWvVChByEK02QzY/veacZ6q0mOZIZ0ch2Nn8d+/XgeehDMF18K4vffkaV6QrUCfjDLCj8+JH/PUqaWEQTQRbPXYIQQEMmuwz1HHM1N1Vvd7V2uhxJlQq3aiUyt2TQvGYfJdKkUIeHoHZNcGHLThOOUCg505xDtqpJmkUtl13x+zefXnGDNCX4eTrDm8+vcXefuj5m7f4rPO55kyizjeuojLTwnbenivDe7E2WzlHuMi/fYjGMt0+5htzPsjLZjsZnwzeRNrz/qxm+6fGu7s90Zbna3vwvtBom7AY8rFYLL2DxPatFK5tViRGXNXa5XvBk2r9Hsbn+VO57nOXvP1bRiSKbGIdXcRlTTMDejubqaiwmcjVEXFUOpksBFoSQzASmafrZIZSZd8pIWkKunzcGIrv19oizfTuN7nJZA6CpB9ePILZfUToyI80GCY7BjVOfvyE6Di/4jJs9OSeMj0pgdfImFoESfMfeth+7cDwFeU4048w52Yf1Yt4MOs1RoCHzNmvHONT9f8/P1Gb8+43+OM37Nz9e5u87dHzN3/wQ/D2zocX6OCc/m55jbarMZl3pHwfU/p+kuVQICF94sj+NSu+vmioPDCEZgUNqp2+QCvH7Ph/IApJ0yUyZq19/GNsN1+i4cQdT0ml4kyQQicf4elHsdhhZGG/VFZuNOJvcR7UfE0utU6hQzJ9YWZndj4w6uhovvW7yQLVRAeNtOVX7bivNs46b3QOFCWIRExi5JGbsLa3qZym/Scg7SknLAF0y3gXeXMwlFO9zmrpa/Kp9e6qE4mOYlSqQT02DIlxCPbhgwCzQjL4yb3XLxt6IjdLvQ6f1T+vyz9zU9vJBH9HjIfF/dC/MZUC6pR/Cv5+FxRqzd774SJPOTiDq97spmxzSty94Krun9Kvfjx8tfP56/YmPiqq5WlIZospDUXCDbThAirhYOqh8CaJE7nnRejsOrWLWfWij32CiFwuxKnQnBLg+DET7gkDhFVXcmpUXCFRJadf2y8kwibkRK52drbkkKPMT/Biy0wWvrXrmz0jUVUuFj5kZbV6rJ9iWVMElnPs0JKroekV0WlV58Qa9vBfG3Sloz5JqTZl4tofCmvYxTSaU0RgEgETw1zlrfvLmX11yQRx0YRkjqMgayRMBR/4Esrrz2zThq8pokr47jSn2cSBzE9WXMFy5mcI6mCTtk8STPjfg7YxQ6lAaX4xJZ9M2wbmnTpsuIZre9AKnpt2zKJmilw3eExFA+mPiQjnXHanIQPpX4lPzkPIuc/4SmO2Gfajq74UucvjQzyWPzzZhpwyZt2PQ1wAT8/nCjwEJukw6uDvgA2Jv731WCAHSh5nlZD1Z1J37DraGjIQZUJ8UUu/7L7rzAhU/MPaDZszkowcTKZz8Z4jsLsuiEqxmruk9YtuAq3jTHwbpkN493dp9Fh+1fTV/SeOHN3WOVTr93lX6kkvx16u7/qeKtK83PWGkCT6Zwc9uGhmIxyD1bW70EpFvqicC/eGr8y+og5Gh35q+TL4opUm4ppl1OxxMp3PVBIbgl5teguMozl4egu5T8aBKdoLHGHCStARvlQ5lCXot9RH+mYpiYejN64QJSP+ehSTuDlU/ISWy/chwIVJaVil6xB4gyYxzh8YR3E2ni0hchtGpKVJq594HYbFWVkRQ2ZIqW61J0Zo5HdM+MFnbBiU/sBR+acMkMQ5JHwgv3c0VOReqijObV6fdTshE5zYlIC+oOUUFBpsTCDu8Pz1ckQpgy7q8FWrkeb4RFZoPmQgi1Oj4Yei30hDRU5Maig6ohp9bJX0gUIpYjCRfX/yxgObbu5rfs6z8h+fH/hCSczNRSbRR0j0iBUvoWz/fTl9FSP41VuzKhPyiaIKBowt0d3TVRd3lPw7+Xgi4yLq/nzaNruhHr9Bk9+wiVVHwlsF6eBiO9Ys/6c5UHtajuTNV0fl0S4eNvgm5ZoMH9NWb5azCHzz/wF2ULS1Z+SqrdPuwfHB2cH0Se7D3EdcIHmAPV/N8PwMXS +sidebar_class_name: "delete api-method" +info_path: docs/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 the specified Access Profile' (delete-access-profile)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. 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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/delete-access-profiles-in-bulk.api.mdx b/docs/api/v3/delete-access-profiles-in-bulk.api.mdx new file mode 100644 index 000000000..ea835b85a --- /dev/null +++ b/docs/api/v3/delete-access-profiles-in-bulk.api.mdx @@ -0,0 +1,107 @@ +--- +id: delete-access-profiles-in-bulk +sidebar_label: Delete Access Profile(s) +hide_title: true +hide_table_of_contents: true +api: eJztXOtv2zgS/1cI3YdtA9uxHefhfDkkTbrIIt3k8rh+SIMrLVE2tzKpI6m03iD/+80MKUuynUe7xW13YRRtbYkczvM3wxHl+0jnwnAntTpJov0oEZlw4iCOhbXnRqcyE/ZEHRbZp6gVOT620f5N5G+z8n5024J5NjYyRzpA5WoiLTs4P2FSSSe5E5ZxNgIijOjDIKZTppVg2rCpNoItkOx8UB/U4QyGp7zIXIvJlHE1w1luIoBsImMgmyzOY9zgXVZY0WJKz5ez7LPMMjYSDKRNtZnCVK4SIraxIdW1FRsbLJUiS8o1jLA5TKwWs3S5sHxMH7lj08I6pGnEVN8BxVQa6zrspCTw30LAAE91Y2MEX45TWNydqWwGy4GONjacKWDpFpvoz+JOmFa5AApiRA6jgTBI1OR0zpwnPioc4yCfhlHmCe2USvBWTkjLB8zpT0LBPTdBm7XY2cXP/zk4enfya4tdnl1fvDkuv4GxwoXL60O6xnjhJtpIN0NpUGJpYF2nWYz8uOAHoBPFeJJItEULfGGRzJSDbUEraLj5LCTjOV0WZCLjCemIW6tjSdKSBJe6MLG31cwPGGUCKfFkCt5onTAdcOVgnEOdzKL9+6jkPNpHe7SiWCsnlMNbPM8zVCdwvvmbRfe+j2w8EVOOn9wsF+DwevSbiB3QzQ3Gk5MQFTi3HkcnCV1rRsopcIQed3Jk8b9FOYHvmrkwBP163Bg+g6/Siamt8WGdkWocPbQi8YVP80xguPbjYW+vuzfY3ev1RXfU6/bg0253uzfsDUUcc6AThuyFIX0aInr9Ydrb7u31dqJbINl04GVZwO8rf7bAv3JgUftJ5gzCw9QD2OYiluC7yy4qU2+6mCulXU16+Bhz7x7Bsj7OKd42NlKeWVp4ZdRzB4rKKZQaQPI4fNSUPdI6E1xFNaWilA+gEicdfo0agIloeURMX3gva9jjfkmP3uWWfeWmMsvOYGtvRGbZ2dkbDVdZjobwPRrStNwDcloiBnlLv9tdNt+FcIVRoCIKRJk+CllzVSOCPgHiC9r8TjHluP2EqWrR5xdz0MlRaWScERAD+BdfRFw4mEH3GkmpwyhxgetRpgBo8VjmsXcT6bSt466woIoAUM7w+BPzVzt1Fykts4PBxuNB4sMuHgx7vd6Q97voFbkArAbmK2nKyP4qmKjgMBCsRPpKkChdbeRdLe4/6mrBGxdBgjLUi+UJyW4V8nEzprAH73tSmpdB79f4S5MVn+rBLbwnrzLx40oDhcCc5HD2Yo0YkQojVOzB3wtXN3BhS9d9LM0/paOFiAdcqxH0KmO5J9NZjjwi9pwej67OGI4gYZ5bQKhiit53cXZ6jGVkpVq6gv70YtM9v1jNbntot+1dPhxtJbwLduO8uzXo7Q32uukwwYUVn75EWmnzDIoXHP2VTLzjCpzfMLRC9OBRemU+ucYgiR6/X883HuQXEs4cZW5u5wF6syJEnk8m6M4YsTQ/aIb494ZqEIC/ASKGKRJBEtHD7UNISP1u/4kchGnaMUi7GBVKVPuGpTp+nVrWqWWdWtapZZ1a/ozUUkJm6a8cgGirO+xygqRBr89LSKoh0s3q0VupmHv3D5SoBqs2S28yCQmHHRsDGNJm9bxV7/2MdDLzAX7HM/k9c1UiHJfZG528wJPeSiXaY8MlciiI5Rgmou/cScJ02r55kiVU0bimW4EmOj12yBMWNrbsTRAG/QezFdB6CSBeKwnzWTmFSY/FjywrdgUf7XSH/UG6M+C8vzfo7W6PhinfAt/ZHg5x9Sk4iLf3M2D4s1DCyJhlOgaL/A4KMVBkQGGBDNDiL08EROMF+r8CufzYuZiBX+bEF4cNscM352ywyzKuxgVd5+MFJaj29SVcUUWWYUsr9CBagYkzI8dSrWKlxMGj47cH16dXcOXi+F/Xx5fwCWkt9W4PVAn/wCr4wkR/Jo6DAJ+5ZRYQIcaGFNsIVDdAIK5sfaD03+zMgjLLRi7MCKuvmFEnzVKjp41Qorj54tgr2RGdFsPWBJtyB7lrxC11LXwxhfiVu/Zp0OQGmwieCPO6ww5CA5JnDKIRiFLbEbtDSVI1WdMCQllQM1EXjintZLwAr5Uqm9aoQPS0bhQMDuD8eT85iF0BzJGY9Sice0tgsUrPXnNN7q5qSiOVzpTjMUjBs2wGajQGNEwtYwnpP8ARmssC8Khy3Byx6rmB4O6dZ+bIabpHTbnn4+48A/hpk2jzG3ciBB8VJB6NxLxPDJoIiBTqZJocRs3NVQa+74SvY3cdu+vYfWHsLt4sS7xwl0qf3nLpc63CQx9MnkuljyHvUbp8MvQ7lTfBkPQIKZRIv7y/Ck+eaOec4+OX71gf+VS+xPzB3B7++qgsp8vUX9kCGSQ9eglSQCKR7BPfFce+uiZVbS2v9labkQQHVStKREBNw2a68E/6CqWQE25bLNHCqp8cm/C7eZVPCIirqqSda6ncupJcV5LrbLTORn+fbLSuJNexu47dv2bsPllJzrmiaAl1ki2mU25m3tPCfZSWMxhQHW+ahxyZarFaQWJsXmNFzcohGvV7o166G4tBwgfJztYw7cc7fb6929vtjQb93aie62+qOJ4HWTOmavb2diQVQxGHR1sKBc5lndZJs/0H6jUiRVijI0hl3Qw670S+v0i1Y3+4XDteac3e4VGVUCHZRg2pKh0hpsHYKY415VgYwNkYcFHhkzKp/bE2ORVAxYDTsExOJQUvSgF0zax9kDoQxQdK6WS1U3BxVgCHhASZxqpZg2NJPKKTYs0HFKiCHQM6f8fqNJjoD1Xy7AIlPkWJ2fGXWAgM9Hnlvr2qv3sCzBvEiEtv4EcavX63wxU4AGwIPGbN6851fb6uz9c5fp3j/x45fl2fr2N3Hbt/zdj9ivo8VEOP1+cw4MX1OYztdNm8lnqLzvV/L9MpVAIH5N5Mx3FhqN1c1uCgBCvgonQzWuQa6vo33pUPoGjHyJSJ2vfd2HY4c7E/pWMW0e3DLfIInojy5NoSBnGcFm02p9hNPBXW9kfaI1wUq0svWGEymDBxLrf7m5v3YG+w80OH57IDMAgmdzOlP3diPd2821qBXnjMwEcqLJYUMXWt8SiZX6RDVjISA8GjJi3gbUZ6QZcH21F/+Un65YmUmS4AJ4lMCw/mBKeky8BmDjuSnyyN7pATLskIsl2b7OE5ef699ZQcnsgjcqxS35NrwXgGXC6Ih+zfVj5yiaW7X33JU6p0hNu9/tJiZziszw4FN7Cv8E9AXv3y/uo1G2PBSoDhT/kISa/zcHYOLkKAeFA+DcBJlKOMLsYTf7Ss8bwFA5ClGQjMPqhLIdjNSVDCr5ApLgDaSaU4SRCa4KzbV6VlEnEnMkyinUqT6HgQBJugoU3emPeaEibtLKTCU5l0tfNBtdmRRByjdzFwTBCRNorsJi/l4jW5vpWJf5TU2iHkiJp9vcCFV+1N7M/vxIACSIJnlrT1zYt7eu0aPdyGwRWkusgDaiLw0XxKFpdW+2Y+GvTaSK/Jxwf13p/3a0xjHr2YhWSaJeyExROtrfgnY+g6GAY34wKi6JvZokOGbYqIdr9bY6ntl2zLNtSWxN8pBIbyzsRHmNuptNFQ9anEh+RHsizE/Ed6A+VjQ2a6fAMpGEcmOrbfzDMu2MYF2x4DbODfZzh0LIhtlIFwwDvAm8r+hASB0RrmeVorUZ3Ib9IcTA0xsEpUbL7vv+xXABc+MbqBo+djAIKxNJ8/N8T38AItTHMNZZVNhUUNLvObaciuC3rz/M6bWphxfzR5UeKDqveCbzF9b5R+BEl+HNz9kxBvjTR/R6QJxTL2MC+qV2iPqwPBT7zG+MdeQF1+/zRsrdH1SQVhh1MPOF85Lncl/Wuk8C/cJdSgHQLsv/xLxFhP1cnkGXcYX4Qv8UQK6mfkgjusQlvo43pKmAClN8pP71oDobGBMQAgFipjPpIZ0Ouw97BhVDGYGzeLeAIEqP6mw67xEix+jg7DjkongmJuOi0UvmQNTBRTfDPmOU9LpI0LD4iwd1SilMy/IT6fVaIDujCqgt56FWZqz1JsfMOeuuZQz6wF/mRD1xsUiRbx59yjSpALkZHH47jmVuA52uDF7YnIctyuApoL5d8ECSu8O7laogjElKWXwTvajDfDJLuJY4EIbru8M2x1YJNKb8zAzg22dA3OV7x9/sq+XnSo+6rXv/7tg3o7aP3bBz/gbx+Eyge3rJs5NmvpXSK/hfZti5tooW0Bs+qNCwDjCbY5YOD9PTb2cBf/gJfB7Ng1whcNy006foMFfIOPOh2fBDaWwhOl9tWMKrrQQVp+VIZ9Az/DNw2fHFvvxJyfYfs0GoXfeJj6npThn+Ei/rsffYA/8EXnHpRgEF2/j8oOL4zxdMvSeVXlGD6gmA8P/wPpQ+kf +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +
  • Array [
    • usedBy object[]
    + +List of references to objects which are using the indicated Access Profile + +
  • Array [
  • ]
  • ]
+ +Returned if at least one deletion will be performed. + +
Schema
    inUse object[]
    + +List of usages of Access Profiles targeted for deletion. + +
  • Array [
    • usedBy object[]
    + +List of references to objects which are using the indicated Access Profile + +
  • Array [
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/delete-account.api.mdx b/docs/api/v3/delete-account.api.mdx new file mode 100644 index 000000000..26e38c78a --- /dev/null +++ b/docs/api/v3/delete-account.api.mdx @@ -0,0 +1,99 @@ +--- +id: delete-account +sidebar_label: Delete Account +hide_title: true +hide_table_of_contents: true +api: eJztW21z0zoW/isa7wegk5c2SV+SD7sTaLnTO+VlS7vMTttZFFtJBI7kK9ktuZ3+932OJCdOUiiwzF5g/AVc++jovJ9HinQb6UwYnkutjpNoECUiFbkYxrEuVB41opxPbDS4iMIbG101QGNjIzMagxHnVrB8Ki0bvj5muWaeA+OKcT+mxS7VGREIlWRaqpzZYjSTua3QlKNybj/gdcKMyAujLDiHl8eHm3y0SudhpKcsuY2NnrHjRKhc5vOX+qbBlM4dhdWFiQXD7CIdN9jNVMZTFkMQI2yR5kyqKqNHNggi1YTdyHzqPirxMWd8MjFi4gzHRiK/EUJVJyAdKgK0GDvTjF9rmXhj2VgobqRuQBQmaZpYz2bQTBABz9lcF+wikZaP0oU49urxNM8zO2i3E3EtUnJdy3KZOnO0wKEtE9XmmWxfd9thcDMMfsLg5qkwxF4t7D0VsxZzVr2Racp4aiFmmuobJwDcaaCYk6FiFluaaVzAOIIcMwTtB5jAGenV6W//GR6+OH7JeJFPtYENvI5/FNKQghomx2xl2LQu1d+3tl6+OjsasH9jWvJHxbfLaZ1fvYUt02Mnw2V0KFKJeBLJc5mKy4jl80y0trYQvVbEBc2OCL6lQDXPtMrhvSHEoqiGtQYl88GMKz4R0dUdQjzjhs8wtbFuqKRAz2A+8FT4gL9kQvxj2I9Hg9uI5sRbmxuESnTXiEplo0FuCrGeNCGdKKrBRnzksyyl8WLcPRj3e93evuj3dvc6o93R6KDX6fHdvW5/PzmISDiEaqaVFZYm7mx36L819nauYp83icgRIJamiUl5ZDXIeZalMnbR235vacxtRZl7ZUW6Oq7l7IzYcelSI0wCpzGbcwNXBOLMaLjKRlV7kNmpjAST6dF7EVOpAS3iOZdeL9BsSILkCU4n1aLGmtWrhuzE/Z2D7YPefm/voJvwve0detrrd+MOnvu70R18hOR0xKWGzmynrhDgO1H0trc3xXiWSpiRHRmjDWuyU1choLL0spGmwuZspBMX9lJd81QmX+WBz9vGm/uZTsRm6K1H2nOpRHNi4ChIKJzIMQaSZ65lQs6baSOCB0vzOrrVyIQlWjvsKU+gr9fvWVCGDGl4/AG8jpOHBTpXEuNZOYTBqWNtPjWt2Bd8tLfd7/TGez3OOwe9nf3dUX/Mu93t/m6/T7PPEGHIXFuZmxvD5xtT/yaUMDJmqUb5kX8KajMctncCuMkxBIVkZh/2gePxBfY/g16edqFmkJdRJWowzp4+e816+yzlalK493yyZgTVPH9DpadIU6rFvqZAc8/4lZETqe4TRahiRgl3ePR8eH5yhjenR/88P3qDJ+K10cuHCtGaUFhCVMTCFH0gXypww9G4UJJjJHiLbQWuW1CIh1YdCKX/y84tjInYGnOkFEaE2e8ZUWXty3w1lWJfttlj2RKtBvot3s14jtY94hYDtG9HW0hkkeXNk2DJLTYVPBHmSYsNk0SSkjxlyEYwxfg5GDGeUMtd6WeuiekiJ9AgY7Hqi6UpV72xrCYnVadQckDyh+NkGOcFhHNqVrNwES1BxOAfyOwttyrdWcVozqRz1OgYWqDdzmFGA5yBygTdCH+FckTusig8qqRbVKxqkXTl7oUX5jDX7lvMC/sFefc6RflpOtUWH65FSD5LcMBXI+eN0k2hIuGjK/g0OFAt3FUmPhtLkSZ17ta5W+fuF+bu+sfTgOrCVwd9djahz7kKiJ6a5wb0MS56lC5h/59+eeQd2WAwSIBIv789C+sFWs59zAgYfkd85Fv5JpBd+MO/HxH8WDhrxRckoLOj12CMSiSSgZN7KbEzlDdVd3O259qMJAJU3QMRUTWNW2BxmMwUyoFobhss0cKqRzmb8mu37IG8vgL6ZW/TL/RqJFkjybob1d3ol+lGNZKsc7fO3Z8zdz+LJBdSuWwJOMkWsxk3cx9p4TtpyxkIlvuLi5RzrlpHK8SMLTBWtIocolFnZ7Qz3o9FL+G9ZK/bH3fivQ7f3d/Z3xn1OvtRtddfLPN4kWSrOVXxt/ejMzFA3DVwXKEQXDbXOlnd/oN5jRhTWaPSs8DNsDlMerXEjr1N7PhS59ANjIEdzSe2F89PT4g/pnbsyW7+pwdKWmc6/0MCQUr384f4KG1eQ8caOtbtp24/v0z7qaFjnbt17v6cuftV0LH3EHTsfQV07DGCWGOCWH8ldEyAOwiajeEU6BAXMK8i2JhBFTyF3ceQ9jk3E5EvgN4Kiuz0N1HkmdbsBVfzEizZlZ1ItTQXlTfQzojWlLQg4GyCEqkYqpbU/rd3OROESRE/LBy6oOMjgviaeXM4zqGVz5ky3hazSBWnBSR0RSHVtPeqEWMS4STGBP/Awe2DTlCov+MeZ/DW/7QfzE5J4xPSmB19jIWgnF/s/+7ed0rgGMIbKhdvvK8/cVzA75lzhWWE+Jj58rWAoDVUr6F63e7rdv9rtPsaqte5W+fuz5m7XwHVAxr6NFQHwRdDddC2ttkCSz2n4Pq/I3aXKkECF95Mxw6rJ0sM7nAFQml5iJ7KCB0ZHkTt8oxx+1YmdxGdSyZI6KUpTAqS8lz3LZwE59y1eCZbMhwgV/rGHe6+7t5TcuiEqU8vFK2kiN2Sgc7i+0lazrRGUvT6Uucm8IZ2ylCclmfIP8ufTj6TB+dYfjDPpkGHrUMkudcQM8My4pF11C0XORs6Qrdzk949pM+/up/TwzP5hB73me+zc4GeQco19Uj8q+Ux8jeEt/3sG4fJlz2Edvo7G5O9IrIOeyq4oTP47vDL49/fnj1hE0KZLssLSwBXSFoWIE9eI0RcFRuWB0FokGssRhcTfxlhuHLUhrKGjVO6cHCp3gjBLiqXENgp6rEzKQ0SrgTQqC+/VcBXxj1xXc4tB6TC48y9bV2qJjuUVHwkdWuiCSq61R27yEq9eEWvbxXibyW3pufWdNzskzUpvGkvYn90O0bqEgueWmetb57c82tW+NHaCW+I67oMZIkgx+oBqbj02jfLscKvSfxW5bhUb91Nl9VhzFcsZtEB04Qds3iqtRX/YIxCh9LgYlIgi75ZLHe9pukyotnZrojU9FM2ZROA0Ml3gsRQPpj4iBqywyPab424lHznPIucf+du17xb0dm9vkDfJMpEx19xVWZNZpqwSRM2fQ2wQf5wxwHCIrdJB1cHfAA8W/rfVYIgaKXmeV73VnXHvu3GUGuIIarjYrOB/2OwLHDhibkPRL2gQQkmPL04Mkb3awIv6k0rxip3AtYtuClvqtES1+zm5V38nklt8kfTlzQeLjdMXql0/r2r9CcqyY9Td/+iildXml+x0gSES+Hmpg1LgWqQe7S2uX3nrocK/IuvLlMdlMZCZXmhssomS3lOMe1yOp5K4Rb+meA5Ib8GxZWeuTwMd8uE9YwmBjRIWgs0ykcyBb8We4uVlQL2NrSqCjca3+uwvHoDK792F0kPS8cBQM1mhaILixCimDGO8HjAu4m0ceGLEBZZSpSaaQfjFqPKjKSwIVO03PrCzOyrMe0QY/FZceIDc8GHNmwPw5DkkXArcanIqUhdlBHdKvx+iDcipzkVaUbrOlRQgClRmeHF8dkGRzBT4TcJbSbtMMi2iRZMaKnjg6HbwmqOXmXa5liErkjurnoubx6vhNHtciu8vnBcXzj+YS8cB3RBy8J2RruYFOyFX6b6zYCLqGQO8oG/CTtFNtCX21va4qKl8R29/qMQtH9ycbVc+bodg2DnJBqMYb71u8XVVHl8GizwpEyscOP4XjnLPVk1X27HRHj8IGgXB6LeXYHKb7M5QfwHvxFXGbLxUxWtoRebI4dHJ0dnR5GHpPchsvAAvdFz/guVz5ui +sidebar_class_name: "delete api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Delete Account

+ + + + + +Use this API to delete an account. +This endpoint submits an account delete task and returns the task ID. +This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account's returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future. +A token with ORG_ADMIN authority is required to call this API. +>**NOTE: You can only delete accounts from sources of the "DelimitedFile" type.** + +## Request + +

Path Parameters

+ +Async task details. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/delete-branding.api.mdx b/docs/api/v3/delete-branding.api.mdx new file mode 100644 index 000000000..246ddfcca --- /dev/null +++ b/docs/api/v3/delete-branding.api.mdx @@ -0,0 +1,96 @@ +--- +id: delete-branding +sidebar_label: Delete a branding item +hide_title: true +hide_table_of_contents: true +api: eJztW9ty2zgS/RUU92GSlCX5osRrvWwpjjPlKeeyvmweHNcGIiEJCQVyANK21uV/39MNkBIlO06yqZ0kxZdEJoFG307jNATdRFmurCx0Zg6TaBAlKlWFem6lSbSZRBtRIScuGpxH9aOLDQxysdU5TcKU06l2Yvj2UCiT5Jk2hfBChDbjzM5YtsAnIY1Q19oVkCJGQZzQhZqJ0VwYOVPd92YoiuyTMuJKF1MSuiHeHP/+7+GLV4evhSyLaWZ1MRdY0Ko/S21VgvEilmkqiqBGF0o7FZc0EIrfRGdO2f3MFOq6GEICGaMTM6g0GFxhpIoubmFYLi3UKJR1PFOTebnEnI2I9MNf/B8WiKdqJqPBTVTMc3ruCkvOud2IKsWiQWFLte4sxaaKbAyN1YofYMtIBfclWEZdy1meKo7LWJZpEZGWVrk8M045Wn97s0//NVd5DZ+QxYhFB2FIdCwL5XhBUk+5QlxJJ1wZx8q5cZmKUVnQa6vIt2Yx3WtkVVFaA2drE4R4DbpkcH9zc12D/VTT9ANrEfiOOK4FjBtajLKEo6nNpUx1QrELK5NImecpqQ6RvY+O5N6sez4bfVRxgYm5pVQutPdLogqp0/0sUetRWg3KS21UZ2KlJg0VqxxjooDES83RmWWW4kIiq8jxuG4jSPBEd0s8lwns9fbtB2PgpsLK+BNkEcweUujMaMwX1RShEwbQPcuqXSVHzzb3tvvjZ30pt//e39p9Otoby52dzb2ne3u0+gxxlhPvmrC2tFbO15b+XRlldSzSDKjS/4FDrJIuIJgXxxRKVvdwDFjGF/ifQOHH1mYGfQWhdkNI8Xz/rejvilSaScnP5WTFCaZzdkI4LdNUjugRwQ+We8FvrJ5oc5cqypQzqgkvDl4Oz45O8eT44J9nByf4RLLWyt3QVIiCqsiFaXbFGgcDGFcAcAwEd8WTIPUJDJLGLQ/U/i83d4T8gG/MCKvfMWNZtBjbbNaAUuxLnHiku6q7AdTiGYpvPBUj6TAh89B9MgTm86JzFDz5REyVTJR93BXDJNFkpEwF0AihmD8n+MskWWB/XALKigt0hqJhskLHqhmLhSub0QAIdMEjjpaDQuCA5g/nyTAuSijHZi6jsM6WoGJV8ZLguaZ2p6tVcG4KGcMK7CJzuNFaeJgLoi5cXQg1+X4mTTWurli3twuzuNy98sq8KDJ+F8vSfQHu3qYoPx02rX5xqQL4HNVhX404GlWYQkXCSzKbJ4dRdbgq4IuxVmnSYrfFbovdL8Tu6svjwHrCW6Y+W+vU58wEokqb5xr1qRlWNcjzYx/IDQGHBIr0x7vTwIUxXl3nxCm/Iz/yW/ma8sM6Hv75iOhHHaxGLEhB9mNg+KhEKhmw3guN2VHeVTvrq73M7EgjQc0dFBFV04p5VgoJl9nSGNJEug2RZMqZ3woxlaiPkhmsr4C0qkk63IO0TLJlku1u1O5Gv85u1DLJFrstdn9O7H6WSdZaMVoCT3LlbCbt3GdaeE/WSoEB9fmbqCHHoVplKyRM1BwrajKHaLS9Ndoa78aqn8h+8mxnb7wdP9uWT3e3drdG/e3daHmvP1/guAZZE1NL8fZxZBeDxF2Cx5UGyeWKLEuax39wr1VjKmtUemreDJ/DpRcL7njnGWcB2yAY3NHec7x4dnxE8rE0iye/ZaWNFdFs7zoMlwVTSsphfz7dUseWOrbbT7v9/DLbT0sdW+y22P05sftV1LH/EHXsfwV17AuiWGOiWH8ldUzAO4iajREU2BCXcK8h2pjDFHxa3C/g8iPtRBU10WuwyO29dRZ5mmXilTTziiy5xkmkWbiLyhvGzmisrcZigBQTlEgjULU02C1llZ4p4qTIH5HqmWYck0GQa+ed4biAVR4zq9+n4+84LaEhF4U0o7PXDDmmkU5qTPQPEvgcdIJC/R3POEO0/qfzYHFMFh+RxeLgOlaKMF+f/z6965bAIZS3VC5OfKzvuS7gz8ylQRuhrnNfvmoK2lL1lqq323273f8a231L1Vvsttj9ObH7FVQ9sKH7qToGfDFVx9jupqi51Eu+KPr/ZuwMlaABp7fIYubqyYKDM69AKi0uGlMZofu1g6hX3YR1vRu6IHsb0TVeYoVeodKmGDUtitwNer0bxAnxue3KXHdRvhCqYm6yq26czXqXO3dUHbpk6hGGupWUMXcNdGvZL9Jl71pNCeyrHS/gfe2v3iJV4XO+XfBZ+dX13jk6EOHFbAgke0gmfgw1c3QSvzl/75mTZ81G2HZm09uH7PnXzufs8ELuseMu9312LYwX0HLFPFL/YnHr+oQot1997e71Yhuhw/7ttcXe0LBt8VxJi37A33959Me708diQkSTgV464rhKU2cAqLxFinAhG1Z3QWgS7y02KydTVnzYuG1DwBHjFAaL9+ZEKXF+GJzwGhX+GCWZXUqTFFcBmnXxqIpMoi5VSptfd+FJSjydmB481JONeY95o+OOYOlGfPe96YgXmuqPpg2bxgQTucET53lll1yy61uV+FslreOldViae7yihXfteexvb8dAL4mQqWNvffPiXl5nSR61T3hCUld1IE8EPZp3pOIqat+sR0Neh+Q19Xhv3k01dtHmNOGLlnDYBNNEHIp4mmVO/UMISh2CwfmkBIq+Wa0rWrTDiOhsby6p1PFLdnQHnJD1OwIwjE8mOaI9mSlJ5k9HGJIfOLLA/Ad0zIn40LCZH59j66SRSRa7b9aZFuzQgh1fA1zQ3+9MlFjANtnAdcAnwP4i/lwJgqJLNc/LurOqs/gez6GtIYaqLMXlA//HYFHgwifBL2h0PQYlmCh1fWuMfjkSZNH21HBWdRiw6sF1fdMMu+KK37y+9VeatFP+aPaSxcPFmckbk86/d5W+p5L8OHX3L6p4baX5FStNILmUbrxs6AaWk9yztfUTPDpinir8i7eMVGbT6FX8T+GIwyyLyVNZUE4zpuOpVtz750oWxPw2KK+yGeMQdJfAjw6PBU0sxgC0DmxUjnQKeV3xDs2VieFiaqzozi2kfsxCh3UCL7/l3/W9qAIHAjWblYZ+igclypmQSI8HoptoF5e+CKHPMqqyLGMaV8+qEElpQ67ocothZ+7NmA6J0X8uBfGBtRBDF06I4UiKSPgV38KQY5VyltG4Jv1+SDYypzNVaU6tHSooyJRaWuHV4emaRAgz4WuJzE56YZLr0VgIoVbHJ8NOFw0dPcozV6APbWjOP62UzR8OrqbTzeJU/Ef8eWbYXKgr6OV0jkW2lr5L8e3geVS3gxg/YOPRYUzhD3p5c0PnHNQc3dJj9PfURJ9fLHof7hkRKvqMdnOMQrD6W8xlJz06Dvo+5m9qvvwXmneaUh3cmfmiZ4/w8ZOiVp+NQUsMc/g0hlX1r/x5zdKktW80qM+qe+gXB0cHpweRpy137drhAzyDuvRfubHxnw== +sidebar_class_name: "delete api-method" +info_path: docs/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 branding item' (delete-branding)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Delete a branding item

+ + + + + +This API endpoint delete information for an existing branding item by name. +A token with API, ORG_ADMIN authority is required to call this API. + +## 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/delete-bulk-roles.api.mdx b/docs/api/v3/delete-bulk-roles.api.mdx new file mode 100644 index 000000000..2048b9712 --- /dev/null +++ b/docs/api/v3/delete-bulk-roles.api.mdx @@ -0,0 +1,85 @@ +--- +id: delete-bulk-roles +sidebar_label: Delete Role(s) +hide_title: true +hide_table_of_contents: true +api: eJztW+tv2zgS/1cI34dti9ixHcePfDm4TbrIXrrpOcn1QxJsKYm22UikjpSSeoP87zczpGTJzqsP9HYLo0AqS+S8Z/gbirpt6FQYnkmtDqPGXiMSscjE6zy+muhY2MZWI+Mz29g7b7jfl1swxIZGpjgFJpzOpWXj94dMKplJngnLOAtgPiNSMIjpKdNKMG1Yoo1gRKh1oS7UmGX6Sih2I7M50thix5Nf/xjvvzv8fYtNjo8OimuYSj9Pzl7THcbzbK6NzBYMuBvx31waEQE1FvI4ZpmXqcUOFeNRJFGMLZCrwu4heglfgLTxok6JySnD3yQ7qBrGeQQMpYIRggQQNmMctOPW6hDtQOKc6NyEMINYJlzxmUiEytiNNlczo/PUonVu5jKcE6W6VBJtmYgkEKYFnvBsXuto0di7bRRqN/Yyk4utRqhVBrTxEU/TWIbk1e1PFv1027DhXCQcr7JFKsBzOvgkwgzopgZjIJPgXiQLKh5GdFn39JEEFUHaw30S2pkCdAyEc7WIUEhPnBvDF/BTZiKxFaY2M1LNGndbDfGZJ2ksMLS64agzbA97g2GnK9pBp92Bq0F7tzPqjEQYcqDjhwz9kC4NEZ3uaNrZ7Qw7/cbl3d1WxSTnpR4QsZnMkBGFMIb2Pok7ceasyVJR/3zJs9/bGQbEs98fBqP7xKIhfEhDVsRygtlUK+ss3G131607EVluFDgc8oUc42IGg0JGaG+8yri9YuCrqTYJmJHuOduzMo3RCV8dCiu5jexA9DzOWmtx4qauOvYREmz/9JjhaKQlVJ6gjU/HJ//6Y3JwcnZ0ip4qHVF7AAaU0ZfxOtwnLiW5Xr/HxSCYDkYd0RtNo2DQ67f7vCt6fDjq7+wiD8WTL9QokjaNoWDgTOSn8jjmATJ0KVnyxwcYB0UkIpEJ0djP9EoEevZVAzj9n1ai0MGxQ4a9dns91t7EEovQgTFQWJvMhR6Ws2mtnAVQaLAGSXXNYxl9U2DVYycSGZfxGx09w95vpRLNmeESJRQkcggTGVC8lhFmAa0qjmSRKDRuJQLa7VaHveYR84nP3nhl0C+Gh1dA6/AZYXamJMxnxRRMT8jHh9iKgeBBvz3q9qbgPd4d9jqD3WA05Ts77dHuaITcE2EtrAzVOlnUzzrrX4USRoYs1rA6yT/BIEZwsD0JQMzvKbkP+IBoPCfeQS83tlTTy8sy8TnDZfX1m/esN2AxV7Oc7vPZihFU8+xkLT9Ac0f42MiZVPeJUpSJ/YO3Y5cIk4N/nx2cwBXSWkMjYwXRGmFYgqgQC3N9QxJ7BW64ZRbqZYiLFXvlqb4ChTiU3spA6X7ZhQVjQmxNOdZA9spzv2dGlTSbGp3UUony5nPGXsiWaG3Bkgn3Ep7Bqh9wCxO0AxKvxmEo0qx55C35is0Fj4R52WJjD2N4zCAbgSghFVh7Ad8skcg0h1QWtHToPGNKZzIUdV8sTblarYridFR1CiYHSP50nIzDLAfhSM1qFpbR4kX0/gGZneXq0p1WjEYmXaiMh6AFoC/AZNoYXBoD0E1mlvlyhO6yUHhUMa6sWNWaS+XunROGqi48C3lun5F372MoP01SrXxwLXzyEQhy1UiUaBMs4SsSPKSlGyf7UaW7isRnUyniaJO7m9zd5O4zc3f14cQj7Dqeomx5eOW/B4U7KpQuAY/qQaAwE8mDqyDmER51cNHoCN7hURgMexHv4f+jdqe3K9q7g97uYNATjSocOF+mepmH9bSrhIRz9Xf3wqWHkaAe9k8AdyyLZSIzdi11zJ3h1uz4wEhWNELfbsjBgAPq5WF/2ha9bjcKwt3hcNjv8yDsdgMx+mZD+k4QTJSDgcTnUAjM1oR/9lpBpuy2XaRAU9l0jVjNYq1euwd6TIURKsRS4To7SG2YlqvovgB8cPAzbfckzx9tx4oshUnPL55sri8alxS+pdzOsEVX01k33ZnyuziIi9e6GkMLg9LFVs+fLh5djaYdJt/9/Pbh1O8TwXjxOcX9hO/Y+jiUvib8uCy17n5QtPcFql+WWRSQktNpMAX/i2iP5F5K3Fiaamed21ttAglrj7qn+wNAZNhC57SbZXKlUBJut1ikhVW/ZGzOAfpwWOysdeAGuaqomWqpsk2TuGkSN0BzAzR/HqC5aRI3ubvJ3b9n7n5Rk0g4yeZJws3CRZp/jtpyBgNKBM7KlHsIiO+wEmOtAu6g2wk600EoqAPs74ym3bDf5buDzqAT9LqD79IBAoi7BhwHuFkYm2kd1Xf2wbxGTLGsYekpcTPYvAazu6N17HiqNXvH1aJASLaGIZcdHtU0GJvgWFOMhQGczaAuKnyPJbV7tSUTAVQMBI1rrTB5UQugaxbN8TQDVVyiLF+5ei7+XaylShBrRM0aAgvas0BMEfMBBUKwM6jO3xGdehd9E5JnE9T4iJrJg6K/LJH77n2vbg5BeIM14sQ5+IF3OK7b4QoCABoCV7NK3LnB5xt8vlnjN2v8z7HGb/D5Jnc3ufv3zN0vwOceDT2Mz2HAs/E5jG21WYml3mJw/XCYTqniJaDwZjoMc0PbzQUGByNYATdltiAmZ4Dr37hQHgNox8yUkdrDffVmrgC4hVci2nMHDenUkH+28uTy7hKlhxhFTVNtqTpxJNjYxgl2u/JKo4FCINp0iuYmhmHzLEvt3vb2Lfgf/H7X4qlsQVmEEMgWSt+0Qp1sX+/cU83wRJHLXKiHUR7SLjaesXRMWuQ1IzExXBUlBs6HZCdMAfAl7Tc/Sh8PQ2FwLHQOdZPIbOEJNB+kdBvETKFD+cX6Q1xo8zUdQbczE989pc9/dh7TwxF5QI/7zPcoLxjPQMoV9VD8y2XMnCCUd9zXIme5PGH7111jdozDuuy14Ab6DPdG5MVvH05fshkCWCoguUXsLCR2HJCC7yFEqECOi7cDOInWLKPzmTvNOK69f8GEZNMYFGYX6kQIdn7ojfA7rBwTKPVkUpwkqLrgrMsXhWcicS1iXFRbS0ti4EHgb4OFtnlt3ktaQKnTkArPULoDkxeqyfYl1jWJQADHeBWpcWTnaaEXr+j1tUL8o6DWdNSaRM2+XJHCmfY8dEf1QqgKSILHlqz11cwdvWaFHrZlcAeprsqAlvBy1N+ahYXXvlqOGr0m0qvLcaE+0KHo+jTmahazsLjGETtk4VxrK/7JGIYOpsH5LIcs+mqx6CR2kzKi2W1XRGo6lk3ZBKxJ8h1BYigXTDzAtZ6gjgYUqCKXkh/Js5DzH6ETj9jHms50+xyWZBwZ6dB+tczIsIkMm64GWC+/W/EwsCC3UQeqAy4A3iz9T5XAC1qpeY7WvVWdyG/THFwaQhCVqNh0z/3YWxY4f8XoAY4ux0AJRqhevkfE4/WeFi57NWMVmwyrFlyXN9aw2q7YzclbbnLhCvxX0xc1Hi/3Yo5VvPjeVfqBSvLXqbv/p4q3qTQ/Y6Xx4Bn3NCfLz2YOHvvO4xs/PwG0DbFNOvqWpppRDhqub0PiPvlcwF94SmWBWgJe/fyjSiaNeYYJRAUknEtBGxip4BnCzC0MYp1Q0gO2xkpTfHs0MzAGKoQF6MsDGQO9FvsAHaIKwZ/YHeKRD6D6Sfs28QRc+h4jgu0XUQJoLUlyhZ9JgRB5wjjE4hOhFEkb5q7iQbOoyg9bNGHGclaR/hijaAr6lEiYxB5PcacbmuhKxDzBCwLG+m1uMCR6xH0V0VgqMhHuPBqOq2P9p2hDmDbnIk6xP4VyLfA81pLDu8PTNYpATFn6DqylzWzbT7LbOBaIYF/lgmGnBV0p3sKGDDq1muT0kQ8eq3thX66G0e1yS3/zPd6P+x7Pr8zYUm2nuLmIvstdi+eaafcVGgZZtZ2GBm2OLTc8vr3F7SfsLe/wNoiNexvnl8vWEX8BWbcNRf33lcDtD//eo3m6SCsHAtdf6GA362a4ra1Hx1Z3Bd4f4yZfI/BfGyZu58TwG7iJf/caF/APfujUZRIWVbx/2yj2IWGMo1sAuvvwjL9ANe/u/gf1l0qi +sidebar_class_name: "post api-method" +info_path: docs/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 Role(s)' (delete-bulk-roles)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/delete-campaign-filters.api.mdx b/docs/api/v3/delete-campaign-filters.api.mdx new file mode 100644 index 000000000..905d8c8e8 --- /dev/null +++ b/docs/api/v3/delete-campaign-filters.api.mdx @@ -0,0 +1,103 @@ +--- +id: delete-campaign-filters +sidebar_label: Deletes Campaign Filters +hide_title: true +hide_table_of_contents: true +api: eJztW21T2zoW/iua7IfbdkgCIUDhy04K9A53aGF52X6gzFax5UStLflKNpDL8N/3OZLsvFLabmdv23E77cTy0dF513MU5b6lc2F4IbU6ilt7rVikohD7PMu5HKnXMi2Esa21VsFHtrV31doXppCJjNwMVtGxivB6DRxsZGRO78HvwPGzLKooE0/JbsfaCnYUW8aNYDYXEdiKmEnFirFgudE3MsZzKm3BdLLIgGZ22KAsxtrIv0AX8TQlvlkJ+qFgXLGTs9//Mzh4c/SWacM42z88u/DPHShkRVQaWUyg1H3r0gqzr1Uh7gpiSYrKWO1Va7b9mnveOK3rB6hpxJ+lsMUrHYPF/YLWA/bRwjyV7EcHdoUKlhWaeZYkEDGURsAJhSnFWisieVRBzHmep8HkXWJMYzYai4zTp2KSC6zJjeET8JGFyOzMuC2MVKPWw1pL3EGAVJB268lQvNzejNbxrx+9fMk3t5J4J9nYEfgYJ1vg0xPJcHOnH2/u9qJ+TCR9e7Mz3NgASV/8uQ0z4A/JbXOtrHBr9tb7y9Z4q1lQhrXh35hUQUiQm4MV2S23zJZRJKxNypQNy4JeIzCkZWo6HQYb0qSiNGoaK5UEHVKyv76+LMF+Kmn6oTGIhDY7qxkkc1IM4UxaUaobnsqYvPK1XtDDjyIqMBEBnFOueLvEouAy3dexWPbMYsq8lkq0R4ZLklA4kSNMDCmBGSzTsIxnSXFFKjg6Erh2Mlmis8Fe8Rj6ev32gzIwU2F49Am8KOmfEuhSScxn1RQmY5ZAqEeWFTuCD7fXd3v9ZLvPee9lf2Nna7ib8M3N9d2t3V1aPYOf+UjYFeE7v/TvQgkjI5Zq5LfLcyM4pRYJ4BZfEfGP+MDx+AL7X0AvT1urGeRlVCDWUEpe7Z+y/g5LuRqVbpyPFoyg2pfnGFFlmvIhDVFSQ3PP+MTIkVSrRBGqzChBDw5fDy6PLzBydvivy8NzfCJeS/V1oKqMgqiIhbG+dRIHBVxeocREhYg77EXg+gIKcWVnCaV/shMLYyK2El6mBWaE1VfMmGXNEqOzuVSKfDVlz2RHdNaQtRjLeBGN2ZBbTNA+dV8MkPN50T4OlnzBxoLHwjxHbY9jSUrylCEbwRTzJ66yx/E095MSqQxhJDYCFA2lCxmJeV9MTTnvDSSBLBzF8axTKDkg+dNxMoiKEsI5NWezsI6WIGJV8eJguXnpLhar4EQVPIIW2M8mMKMxsLAriLKwdSGUZPuMq4qurlhUkSu1XLl744U5KLR7F/HSfkHenaYoP22nWv3iRoTkcxtX2KDJG5WbQkXCS1LbTa638WCLKvGxBYo0bnK3yd0md78wdxdfngXUE9466LOxDH0uFZ+C5CXoUyOsisjjeu/INcLNASL98e4Cif1JKKIXdzkh1e+Ij/xWvgJHV/7w40OCH7Wz5nxBAjo7eg0SVCIR7zm5pxI7Q3lTbS6v9lqboUSAqhUQEVXTsIkuXbdiSqVIEm7XWKyFVb8VbMxRH7lDsL4C0qoqbudaqqJBkg2SbHajZjf6dXajBkk2udvk7s+Zu59FkrVULlsCTrJllnEz8ZEW3pO2nIGgPn9jdco5Vy2iFWLGaozVmkcOrWFvY7iR7ESiH/N+vL25m/Si7R7f2tnY2Rj2ezut2b3+aprHdZLN59SMv70fnYkB4m6A40qF4LKF1vH88R/Ma0RCZY1KT42bYXOY9HqKHVeecRbQDYyBHc0jx4uXZ8fEP5z8crKbLk0kCGZ704GcFw5SUgzD0tIWDXRsoGOz/TTbzy+z/TTQscndJnd/ztz9KujYfwo69r8COvYZQayEINbfCR1j4A6CZgmcAh2iEuZVBBtzqIJP4fQxpH3BzUgUNdCbQ5G93WUUeaE1e8PVpAJLdu4kUk3NReUNtBnRmooWBJyNUCIVQ9WSQLcUVTIThEkRPyyVmXR5TAqBr5m0BwldpvA5s/h9Op6jtISEriikms5eNWJM0gWLhOAfOLhz0BEK9Xc84wze+p/Og9kZaXxMGrPDu0gIyvn6/Hdr1S2BIwhvqFyce18/cl3An5lzhTZC3OW+fNUQtIHqDVRvtvtmu/81tvsGqje52+Tuz5m7XwHVAxp6HKqD4IuhOmg766zGUq8puP7viN2lSpDAhTfTkcPq8RSDO1yBUCKBcu0OWnNOl39b3YWLv7Ybbv7StWGChl6q0qQgHhdFbve63Xs4C0566PBcdlDD4K9iovRtJ9JZ92ZzRemhm6a2uu0cl5FrHQanR6HX6DgTG0lR7EueW8Ab3ClF8QrDuysGn+WveOY8OUEbwjybNYaIDxHlhiFmjnbiN+uoOy6ClnSEbpcmfXhKn39vfk4Pz+QRPVaZ77NrgZ5BygX1SPzr6S3vc8LdfvWlu97TvYRO/HtLi50QWY+9EtygKfCXYJ798e7iORsR2nTZXloCukJSe4B8OUWIuGo2qC6E0CS3wRhdjsZO8MHclRvKHpakUJi9V+dCsKujYIS3KPNnqMvOpDRJuFJAs66fVZ6JxY1IaQfsTC1JgSdj1YWFunxu3nO327m2QCp8zNxo571qswNJRUjSrk00QUXX5bGrvNKLz+j1rUL8o+LW9tzajpt9viCFN+1V5K9wR0hhYsFT66z1zYt7fu0ZftRDYYS4LspAlghyzF+UiiqvfbMcc/zaxG9ejvfq3VhiK52fxnzlYhY7YRqzIxaNtbbin4xR6FAaXI1KZNE3i3VLi7ZdRrR76zMitf2SbdkGMHTyHSMxlA8mPqSN2eES7Y9IXEp+cJ5Fzn9A2xyzD3M6u+Er7J9EGevIfrPMtGCbFmz7GmCD/H57osBCbpMOrg74ANif+t9VgiDoTM3zvFZWdce+6+bQ1hBBVMfF5nv+YW9a4MIn5l4QdU2DEky4ur46hmcWeNEeNWes6kRg0YLL8qYaW+OC3by89featF3+aPqSxoPpwcmJSiffu0o/Ukl+nLr7N1W8ptL8ipUmIF06gDyb/mTt8Dv/FAyNOeLZ6RV6jtks8nBw+ZyQDrLHAv/jrSsFDrOjI3I9ngNJs2zylBeUNK5oRGMp3AlDLnhB0HKNAldnLtGBp6m6oI90jEYGNKgKFnCXD2UKfh32Di2ciuBDat/oZi+4ftShjzuHG08pCthBFRlAaFlWKsylJC4zxhF/T4RPLG1U+iqHbk6JSjPtcGI9q0p5iksyRcc1MiazJwkdRaPLnYmSJ9ZCkNhwDg1DkkcIzlOPVCtyJlIXxkQ3j++f4o3QbI9FmlMDiRINtCZmVnhzdLHEEcxU+PJDm1E3TLJdogUT6qV8MGx20DbSELVi6HbnJPe/IV36telCQN1PT99/3N+dhl2M2o9uTqdmpHPp2yHffl61FttPp6j/6elaa0ytKoju7+l0hbqxBxpGalPrfnU9bbboCcz9KYvrWD8J6u7DsX77YuJ25tDGL39fQf2fn+FPbj5Lez3TTZ+e0BlWaxh+G5v5gwHDbzFI/++13uMvHnTu4xBEbhydfjgcAo3nW0GgVQggfCA1Hx7+C6a9Oao= +sidebar_class_name: "post api-method" +info_path: docs/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 'Deletes Campaign Filters' (delete-campaign-filters)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Deletes Campaign Filters

+ + + + + +Deletes campaign filters whose Ids are specified in the provided list of campaign filter Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN. + +## Request + +

Body

arrayrequired
+ +A json list of IDs of campaign filters to delete. + +
  • Array [
    • + +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/delete-campaign-template-schedule.api.mdx b/docs/api/v3/delete-campaign-template-schedule.api.mdx new file mode 100644 index 000000000..751b6fa10 --- /dev/null +++ b/docs/api/v3/delete-campaign-template-schedule.api.mdx @@ -0,0 +1,95 @@ +--- +id: delete-campaign-template-schedule +sidebar_label: Deletes a Campaign Template's Schedule +hide_title: true +hide_table_of_contents: true +api: eJztW11zEzkW/Suq3ocBKrYTxyQkL1MmCVuZCgObj+EhpAq5W7YFbalXUge8qfz3PVdSt912QoBhdwaqX8Dplq7u17k6V5ZvEl0Iw53U6jhL9pNM5MKJAz4ruJyoczErcu7EWToVWZmLZCNxfGKT/cvkQBgnxzL1U1k1wSZXG5BhUyMLegGJh16iZW4qmI1y2FgbxlkaZzEX1+myU+FKoyxeDjYHTI5pmhFMWqb0YroVrgtdrEhLI90c+twkF1aYA62c+OSGpZuSjjJT+9UanWqNfVOq5OoWehbc8Bl0M9YLkKRtwTF1I1F4gb9kRqtg1RlP9m8SNy/oqXVGqklyu5EY8e9SGgHHOVOKVcvPYfHxIdPeiHVj2ceptks+gY0jAcEsxCAjC8UnzMpp0c3BSGSp2H62O8oGu6M+F1vjZztitDkabe9kQiRkkRG20MoKS9r2Nwf0X1On3zVLyUnKsQ6TKqMAxuCQMcI69pFbZss0FdaOy5yNStcIQjXdaaiLSRQvkUFWFBI06JJ7Bpub6xoc5JKmHxmDHOjEgJOAcUOLkc7mtKJU1zyX3hlxZRLJiyKPudd7b0nuzXqc9Oi9SB0mFoaS3Mngl0w4LvMDnYn1mK6G8IVUojMxXJKGwqucYiKDxGuZUbBmGp4JIqtI+3HN6MET3S32nGewN9h3EI2Bm5zh6QfIIgA+pNCFkpjPqilMZh5L9ywrdgUf7Wzu9QfjnQHn/WeDrd2no70x397e3Hu6t0erzxBnPgmuiWtzY/h8bel/CiWMTFmuU0TkP3CIERy+9wr4xTFFIrvtwzHwMr7A/wShMLY2M+rLCOgbqBPPD16zwS7LuZqU/jmfrDhBdS7OCNNlnvMRPSKwwvIg+JWRE6nuUkWockZl5PDoxfDi5BxPTo/+dXF0hk8ka63SDVWFKKiKXJjqj17jaIDHFaCdErbZkyj1CQziyi4PlLFYzi2cidwa8zJ3mBFXv2PGsmg2NnrWgFIaqiJ7JLuiuwHU4tmMu3TKRtxigg7QfTIE5gvXOYmefMKmgmfCPO6yYZZJMpLnDGiEUMyfE/x5li2wPy4BZSgj3VSjaCjtZCqasVi4shkNgEA6P+JkOSgEDmj+cJ4MU1dCOW/mMgrrbIkqVhUvi55rane+WgXnyvEUVvA8n8ONxsDDviBKZ+tCKMn3M66qcXXFur1dmOXL3cugzKHT/l3KS/sFuHudo/x0vGn1i2sRwWepDodq5KNRhSlWJLwks/3kOKoOVwV8NpYiz1rstthtsfuF2F19eRpZT3zrqc/WOvW5UBzMVBu/ea5Rn5phVYMCtQ6B3GBwSKRIv705B7A/CEXjxaeCGOh35EdhK19TfljHIzwfEf2og9WIBSno/RgsGKMSiWzf673Q2DsquGp7fbUX2owkElTdQRFRNQ2b65JxuAxsXpEm3G6wTAurfnFsylEfuWewoQLSqirrFFoq1zLJlkm2u1G7G/08u1HLJFvsttj9MbH7WSZZa+XREnmSLWczbuYh0+J7spZOTLfr8zdWQ86HapWtkDBWc6ykyRySUX9rtDXeTcUg44NsZ3tv3E93+vzp7tbu1mjQ302W9/rLBY5rkDUxtRTvEEfvYpC4a/C4UiG5rNM6ax7/wb1GjKmsUempeTN8DpdeLbjjnWecDrZBMLijued48eL0hORjaS+e/KZLkwqi2cF1GM6dp5SUw/C0tK6lji11bLefdvv5abafljq22G2x+2Ni96uo4+Ah6jj4Cuo4YESxxkSx/krqmIF3EDUbIyh0m6CEexXRxgKm4FM8fYywd9xMhKuJXoNF9vfWWeS51uwlV/OKLNnGSaRauIvKG8bOaKypxmIAZxOUSMVQtSTYLWWVnAnipPTlfy5n0uOYDIJcM+8Mxw5WBcysfp+Ov9O8hIa+KOSazl41ckwincSY6B8k+HPQCQr1dzzjjNH6U+fB7JQsPiGL2dGnVAjCfH3++/SuWwLHUN5QuTgLsb7nukA4M+cKbYT4VITyVVPQlqq3VL3d7tvt/ufY7luq3mK3xe6Pid2voOqRDd1P1THgi6k6xnY3Wc2lXlBy/d8Zu4dK1MCnN9Op5+rZgoN7XoFUWlxBpjJCd3H3k97aFV7bu5HZbc8ubiWHjiAoWJocs6bOFXa/17tB3BCv2y4vZBflDKFzc6U/dlM9611v31GF6NJpQBzqWFamvosYvj6ObUfXe9tISuhQ/fwCwffePkpdxMDfNvisfLplTEGdoyNhQcwGQ/LH5PKPoWaBzuIX60d3fTKt2QjbLkx++5A9f2x/zo4g5B477nLfZ9fCeAYtV8wj9a8WF7fpXvksrL52fXuxrdDhf39tsVc0rM+eC27QH4T7MI9+e3P+mE2IeHrgl5Y4r5DUKQA6r5EivrANq7shNMnvNUaXk6lXfNi4fUNAYuMcBrO36kwIdnkcnfA7Kv4pSrR3KU0SvirQrKtHVWQycS1y2gy7C09S4slM9eChHm/Me+w3Pt8hSIWPM/+0+1Z12KGkeiRpA6cx0UTf8LHLorKLL9n1rUr8o5LWCdI6Xpp9vKJFcO1lGm5zp0AzieC59d765sWDvM6SPGqn8ISkrupAnoh6NO9MpVXUvlmPhrwOyWvq8Va9mUrsqs1pLBQxZrEp5hk7ZulUayt+ZYxSh2BwOSmBom9W6yMt2vGI6PQ3l1TqhCU7sgOO6PU7ATBUSCY+oj3aUxQdTks8JN/5yALz79BBZ+xdw2b/+BJbKY3MdGq/WWdasEMLdkINsFH/sFNRYgHbZIOvAyEBDhbx95UgKrpU84KsO6u6F9/zc2hrSKGql2KL/fDH/qLAxU/Mv6DR9RiUYKLY9S0y/M2iLNquGs6qDgdWPbiub66xS674Lehbf8VJO+ffzV6yeLg4Q3ml8vn3rtL3VJK/T939iypeW2l+xkoTSS+lm182dgfLSR7Y2vqJHh05TwX+xVuPVM+u0bv4bsxzmGUxxJgppz2m06kU/iygENwR89ugvNIzj0PQXQI/Oj4vaGIwBqC1YKN8JHPI67I3aLZUChdTo0V3cCH1vY4d1xm8/JqCxA6rwIFAzWalwlzCWDljHOnxQHQzadMyFCH0XUpUlmlP4+pZFSIpbcgVXd9ymJl9NaZDY/SjS0F8YC3E0MYTYziSIhJ/Abgw5FTkPstoXJN+PyQbmdOZirygVg8VFGRKLK3w8vh8TSKEqfg1hTaTXpxkezQWQqjVCcmw3UWDR48KbR360obm4XeXvP5xJqt+zolmYukXnY30ulmcmv8vf7kZNw1i+72CzqvIhjJ0H6Htu0zW2z5M3K9/kum1Ry8xheU0/OaGTjioDbqlx+jsqX2+vFp0Ob47RFDoMxrNMSC/+pvNZfMfncZfdz7239H8yV9y3mlxdY6n5osWPsHHD4I6f5iK/hgW+qMZr314EQ5vlqasfb1BTVbdUB8enRydHyWBs9y1ZccPcBaK0n8BMQj/2g== +sidebar_class_name: "delete api-method" +info_path: docs/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 'Deletes a Campaign Template's Schedule' (delete-campaign-template-schedule)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/delete-campaign-template.api.mdx b/docs/api/v3/delete-campaign-template.api.mdx new file mode 100644 index 000000000..5359829e0 --- /dev/null +++ b/docs/api/v3/delete-campaign-template.api.mdx @@ -0,0 +1,95 @@ +--- +id: delete-campaign-template +sidebar_label: Delete a Campaign Template +hide_title: true +hide_table_of_contents: true +api: eJztW11zEzkW/Suq3ocBKrYTxyEkL1smCVuZCgObj+UhpAq5W7YFbalXUod4U/nve66kbrvthABL7QxUv4DdLV3dr3N1riLfJroQhjup1XGW7CeZyIUTB3xWcDlR52JW5NyJZCNxfGKT/cvkQBgnxzL1U1g10CZXG5hrUyMLegFJh16SZZylcRBzURwbzdnxYRdSrUhLI90ckm+TCyvMgVZO3Lhh6aa0mszUfjW9U03fD0omV3dYtOCGz/DNWC9D0tIFx+yNROEFvsmMFkqnYsaT/dvEzQt6ap2RapLcbSRG/LuURsB6Z0qxasb5VEBXpsfM4dM9pgiIYUGjjEwSNxiT0xL9dG/rxeaL7Z1sa2+Lv3i+ubWT9V8MdnZGA97f7u8lpL8RttDKCku69TcH9F9Tgz80S8kryrEOkyoj38OvpA6pLqxjn7lltkxTYe24zNmodPTaCCYtU4vpTkNdTHKlUSKDrCgkaNAlZww2N9c1OMglTT8yRhvocFoLGDe0GOlsTitKdc1z6Z0RVyaRvCjymDa9j5bk3q5HRY8+itRhYmEoL50MfsmE4zI/0JlYj+BqwF5JJToTwyVpKLzKKSYySLyWGQVrpuGZILKKqx/XjB480d1iL3kGe4N9B9EYuMkZnn6CLMLMYwpdKIn5rJrCZMbGUOqBZcWu4KPnm3v9wfj5gHPky9buzmhvzLe3N/d29vZo9RnizCfBNXFtbgyfry39D6GEkSnLdYqI/AcOMYLD914BvzimSOSyfTwGXsZX+J8AE8bWZkZ9GSF7AwXh5cFbNthlOVeT0j/nkxUnqM7FGSG4zHM+okcETVgeBL8xciLVfaoIVc6obhwevRpenJzjyenRPy+OzvCJZK0VqaGqEAVVkQtT/dlrHA3wuAK0U8I2exalPoNBXNnlgTJ8s3MLZyK3xrzMHWbE1e+ZsSyajY2eNaCUhjLInsiu6G4AtXg24y6dshG3mKADdJ8NgfnCdU6iJ5+xqeCZME+7bJhlkozkOQMaIRTz5wR/nmUL7I9LQBnKSDfVKBpKO5mKZiwWrmxGAyCQzo84WQ4KgQOaP54nw9SVUM6buYzCOluiilXFy6Lnmtqdr1bBuXI8hRU8z+dwozHwsC+I0tm6EEry/Yyralxdse7uFmb5cvc6KHPotH+X8tJ+Be7e5ig/HW9a/eJaRPBZqsOhGvloVGGKFQkvyWw/OY6qw1UBn42lyLMWuy12W+x+JXZXX55G1hPfeuqztU59LhQHFdXGb55r1KdmWNWgwIpDIDcYHBIp0u/vzgHsT0LReHFTEN/8gfwobOVryg/reITnI6IfdbAasSAFvR+DBWNUIpHte70XGntHBVdtr6/2SpuRRIKqeygiqqZhc10yDpeZUinShNsNlmlh1W+OTTnqI/cMNlRAWlVlnUJL5Vom2TLJdjdqd6NfZzdqmWSL3Ra7Pyd2v8gka608WiJPsuVsxs08ZFp8T9ZyhgH1+RurIedDtcpWSBirOVbSZA7JqL812hrvpmKQ8UH2fHtv3E+f9/nO7tbu1mjQ302W9/rLBY5rkDUxtRTvEEfvYpC4a/C4UiG5rNM6ax7/wb1GjKmsUempeTN8DpdeLbjjvWecDrZBMLijeeB48eL0hORjaS+e/KZLkwqi2cF1GM6dp5SUw/C0tK6lji11bLefdvv5Zbafljq22G2x+3Ni95uo4+Ax6jj4Buo4YESxxkSx/kzqmIF3EDUbIyh0M6CEexXRxgKm4FM8fYywd9xMhKuJXoNF9vfWWeS51uw1V/OKLNnGSaRauIvKG8bOaKypxmIAZxOUSMVQtSTYLWWVnAnipPSn/lzOpMcxGQS5Zt4Zjh2sCphZ/Xs6vqd5CQ19Ucg1nb1q5JhEOokx0T9I8OegExTqH3jGGaP1P50Hs1Oy+IQsZkc3qRCE+fr8d+e+WwLHUN5QuTgLsX7gukA4M+cKbYS4KUL5qiloS9Vbqt5u9+12/2ts9y1Vb7HbYvfnxO43UPXIhh6m6hjw1VQdY7ubrOZSryi5/u+M3UMlauDTm+nUc/VswcE9r0AqLW4NUxmhm7f7SW/tzq7t3crsLqEbv0QOg16lyTF46lxh93u9W4QLYbrr8kJ2UcUQMTdX+nM31bPe9fY9xYfumgagoXxlZeqbh+Hb49htdL2TjaQ8DkXPLxBc7s2ijIXr/SWDL8qnq8QUyzkaERbEbDDkfMwp/xhqFmgofrN+dNfn0JqNsO3C5HeP2fOv7S/ZEYQ8YMd97vviWhjPoOWKeaT+1eKC9hkx77D62jXtxW5CZ/79tcXe0LA+eym4QVsQrsE8+f3d+VM2Ib7p8V5aorpCUoMAxLxFivh6NqyuhNAkv8UYXU6mXvFh49IN4YeNcxjM3qszIdjlcXTCHyj0p6jM3qU0SfhiQLOunlSRycS1yGkP7C48SYknM9WDh3q8Me+p3+98YyAVPs780+571WGHksqQpH2bxkQTfZ/HLovKLr5k1/cq8bdKWidI63hp9umKFsG1l2m4xJ0CxCSC59Z767sXD/I6S/Koi8ITkrqqA3ki6tG8KpVWUftuPRryOiSvqcd79W4qsZk2p7FQu5jFXphn7JilU62t+DtjlDoEg8tJCRR9t1qfadGOR0Snv7mkUics2ZEdUEOv3wmAoUIy8RFtzZ6Z6HBI4iH5wUcWmP+AxjljHxo2+8eX2EFpZKZT+90604IdWrATaoCN+ocNihIL2CYbfB0ICXCwiL+vBFHRpZoXZN1b1b34np9DW0MKVb0UW+yHL/uLAhc/Mf+CRtdjUIKJWdeXx/CdRVm0SzWcVZ0JrHpwXd9cY3Nc8VvQt/7LJm2YfzV7yeLh4ujkjcrnP7pKP1BJ/jp190+qeG2l+RUrTeS6lG5+2dgULCd5YGvrB3l00jwV+BdvPVI9qUbL4pswz2GWxRBRppz2mE6nUvgjgEJwR8xvg/JKzzwOQXcJ/Gj0vKCJwRiA1oKN8pHMIa/L3qHHUilcTP0VXb2F1I86Nlpn8PJbChI7rAIHAjWblQpzCWPljHGkxyPRzaRNy1CE0G4pUVmmPY2rZ1WIpLQhV3R9p2Fm9s2YzorRhi4F8ZG1EEMbD4rhSIpI/JnfwpBTkfsso3FN+v2YbGROZyrygjo8VFCQKbG0wuvj8zWJEKbiXye0mfTiJNujsRBCrU5Ihu0u+jp6VGjr0I42NKfuCfSw+jUlW/rdZSOlbhcH5F/3+8pY8omr9wo6ZCINytA7hF7tMlnv1TBxX2b0k84plKUxt7d0FkGdyx09Rg9Oje7l1aIx8Q0d/Eif0RKOgdLV31Iua//kNP7q8qn/a8o3/cLyXqOq8zU1X7TWCT5+EtSRwxr0rbDHH5l4XcOLcKiyNGXtzw7UBdWN7uHRydH5URJIxX17avwA16Bq/BeWCbyd +sidebar_class_name: "delete api-method" +info_path: docs/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 Campaign Template' (delete-campaign-template)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Delete a Campaign Template

+ + + + + +Deletes a campaign template by ID. + +## 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/delete-campaigns.api.mdx b/docs/api/v3/delete-campaigns.api.mdx new file mode 100644 index 000000000..eea72ab3e --- /dev/null +++ b/docs/api/v3/delete-campaigns.api.mdx @@ -0,0 +1,103 @@ +--- +id: delete-campaigns +sidebar_label: Deletes Campaigns +hide_title: true +hide_table_of_contents: true +api: eJztW21PGzsW/itW9sNtK/IeSOHLigK94ooWlpftB4q2zoyTuJ3Yc+0ZaBbx3/c5tmeSSaC03GpvW40qVcnM8fF5P88xzm1Dp8LwTGp1GDd2GrFIRCb2+CzlcqJsY6OR8Ylt7Fw29oTJ5FhGjpYtKK42sMhGRqb0Aiz2HQvLooKE3Uy1FewwtowbwWwqIjASMZOKZVPBUqOvZYzvibQZ0+NyJS1psd08m2oj/wuCiCeJMJbNchCOBOOKHZ/+/p/d/TeHb5k2jLO9g9Nz/70F2a2IciOzOeS/bVxYYfa0ysTnjFiSTjJWO8VmO171xtUdNDLiz1zY7JWOsfZ2RcFzyCyhDCQl8Rd6Zpp5JrQ3sZBGwKiZycVGI6KtVUbseJomwZDtj5Z43jZsNBUzTp+yeSqwix59FFEGRjBPSrYXlt5i46dIRI70fLkxfI6vMhMzu7SfzYxUk8bdRkN8xvpEkIF60Xb3Zefly2G/vxkJ0e10h/3BdicedYfDrai3BT6BpL/Fh93eoL/V6bpPm3y7E3U6vS4MCp6ZzIhjo4wbHyWn3s6NuzsiMsKmWlmvaK/TW1d0N4pEmiESmuxUZLlRFEVe6eAydsMtsznorB3nSTJnvFgjFcxBpHZuoTw56YlO8eIOOp11CfcSCYbswBjE48NSjhBZTFrIdM0TGf8FWVYDJBYZl8mejsW6c1dT9bVUojkxXJKEwokcYWHISKxgM42M9SyL6HJ0JHAZJ2SJVpe94jELDmV7QRlyveHRJ/Ci+vKYQBdKYj0rliCo2RhCPbCtGAo+2ups9wbjrQHnvZeD7nBztD3m/X5ne3N7m3afIQ74RCxHepEB1a1/F0oYGbFEo8q4amMEh+2dAG7ze5LmAR84Hl9hf8pbT1uqGeRlVKY2UNBe7Z2wwZAlXE1y95xPVoygmhdneKIQ7HxEj6jeQHPP+NjIiVT3iSJUPqMc3z94vXtxdI4npwf/ujg4wyfitVbXdxWiNaawhKiIham+cRIHBVzeIakjpFqLvQhcX0AhToVoQSjtUhIitsY8TzKsCLvfs2KZNRsbPaukUuRrOnsmW6K1gbaAZzOeRVM24hYLtO8yL3ztaB4FS75gU8FjYZ6jw8SxJCV5wpCNYIr1c9df4njRpsY5UhnCSLSjPGNKZzISVV8sTFn1xqL+HS07hZIDkj8eJ7tRlkM4p+ZyFpbREkQM/qFW6vapSne+WiXnKuMRtOBUJiNtDCzMRtBNZpaFckTusig8qqArK9ZyWXfl7o0XZj/T7l3Ec/sVeXeSoPw0nWrli2sRks91sIAPyBuFm0JFCvXcLS5RRLBFkfgMUCOJ69ytc7fO3a/M3dWXpwGXhbcO+nTXoc+F4guovgZ9jIsepVlB5AcJ78gNQu8BIv3x7hyJ/UkoohefUwLR3xEf+Va+jixLf/jnI4IfpbMqviABnR29BmNUIhHvOLkXEjtDeVP113d7rc1IIkDVPRARVdOwuc7dsGRypUgSbjdYrIVVv2VsylEfuUO4vgLSripuphoIt0aSNZKsu1HdjX6dblQjyTp369z9OXP3i0iylMplS8BJNp/NuJn7SAvvSVvOQMCKE0JWppxz1SpaIWasxFiNKnJojHrdUXc8jMQg5oN4q7897kVbPb457A67o0Fv2Fju9ZeLPC6TrJpTS/72fnQmBoi7Bo7LFYLLZlrH1eM/mNeIMZU1Kj0lbobNYdKrBXYcrGPHtzqDbmAM7GgeOF68OD0i/nRWTuzJbjo3kSCY7U0Hcp45SEkxDEtLm9XQsYaOdfup288v035q6Fjnbp27P2fufhN0HDwGHQffAB0HjCDWmCDW3wkdY+AOgmZjOAU6RDnMqwg2plAFn8LpY0j7jJuJyEqgV0GRve17rgxozd5wNS/Akq2cRKqFuai8gXZGtKagBQFnE5RIxVC1JNAtRZWcCcKkiB+WyJl0eUwKga+ZN3fHGbTyOVPEW7mLVFGSQ0JXFBJNZ68aMSbpmseY4B84uHPQCQr1dzzjDN76S+fB7JQ0PiKN2cHnSAjK+fL8d/O+WwKHEN5QuTjzvn7guoA/M+cKY4T4nPryVULQGqrXUL1u93W7/zXafQ3V69ytc/fnzN1vgOoBDT0M1UHw1VAdtK0OK7HUawqu/ztid6kSJHDhzXTksHq8wOAOVyCUSKBUu4PWlNMV5Ea7vKvbLi/qevzvxclNAqpplqV2p92+hZfgnbsWT2ULxQuOyuZK37QiPWtf9++pOXTF1Ba3rOM8cjPD7slhGDJazrZGUvj6Wuc28JZ22lCgwuLubsEX+Ss+cy6cY/5gns0GQ6iHUHKPIWaKOeI366hbLnTWdIRuFya5e0yff/e/pIdn8oAe95nvi3uBnkHKFfVI/KvFJfMzAtx+97Wr5osmQkf9vbXNjomsx14JbjAN+Nsvz/54d/6cTQhmujTPLSFcIWkuQKKcIERcGdstboLQItdZjM4nUyf4buWuDaUNGydQmL1XZ0Kwy8NghLeo76coyM6ktEi4GkCrrp4VnonFtUio9bUWlqTAk7Fqw0JtXln33LU5Nw9IhY8z97T1XjXZvqTqI6ldE01Q0Y137DIt9OJLej1ViH8U3JqeW9Nxs89XpPCmvYz83e0IuUsseGKdtZ68uefXXOJHwxOeENdVGcgSQY7qDamo8NqT5ajwaxK/qhzv1bupRA+tLmO+ZDGLFpjE7JBFU62t+CdjFDqUBpeTHFn0ZLFuaNOmy4hmr7MkUtNv2ZRNIEIn3xESQ/lg4iPqyA6QaH824lLyg/Mscv4D5uWYfajo7B5fonESZawj+2SZacMmbdj0NcAG+X1fosBCbpMOrg74ANhb+N9VgiDoUs3zvO6t6o59262h1hBBVMfFpjv+y86iwIVPzL0g6pIGJZgAdXlnDN9Z4EXNqWKs4ihg1YLr8iYaPXHFbl7e8g+a1Cd/NH1J493FicmxSubfu0o/UEl+nLr7N1W8utL8ipUmQFw6eTxd/HDuoBhGwo/WvtevyTCZI66dfmHoWM4mDwvXDwrpJHsq8D/eupLgQDtGIjfkObC0zCZNeEbJ44pHNJXCHTGkgmcEMTcogPXMJTxwNVUZDJKO0cSABtXBAvbykUzAr8XeYYZTEXxJ8xtd7QXXjzoMcmdw5wlFA9svIgRIbTbLFdZSMuczxhGHj4RRLG2U+2qHcU6JQjPt8GK5qkh9ik8yRctNMmZmj8d0Fo0xdylaHtkLwWLDQTQMSR4hWE9DUqnIqUhcOBNdFec/xhsh2pyKJKUJEqUaqE0s7fDm8HyNI5ip8NcPbSbtsMi2iRZMaKbywdBvYW6kRzSLYdytSO5/vLr8C9hKJN0uzt1/pF+6hsZFE0c7pRMyUi/3E5AfNS8bUUUn/2PXjcaU5lG8vb2lIxSavO7oMdKY5vPLq8VgRd/A1R+luOn0k6ARPpzdN8/nrguHWX39jxI06/kV/njmi7RXSyPzyTEdVDVG4de4Mz/9G36Dh/T/TuM9/uGLTn2sgcg9xzgfToBA4/kWcOe+bh8+kJp3d/8DmFdNeA== +sidebar_class_name: "post api-method" +info_path: docs/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 'Deletes Campaigns' (delete-campaigns)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/delete-custom-connector.api.mdx b/docs/api/v3/delete-custom-connector.api.mdx new file mode 100644 index 000000000..e651c3f54 --- /dev/null +++ b/docs/api/v3/delete-custom-connector.api.mdx @@ -0,0 +1,96 @@ +--- +id: delete-custom-connector +sidebar_label: deleteCustomConnector +hide_title: true +hide_table_of_contents: true +api: eJztW21z0zoW/isa74cLTJP0JdBtvuyEttzpnQLdviwfSmdRbCUROLKx5JbcTv/7PudIseOmpcCyy4XxF3Dlo6Pzruco8nXk5MRGg/NoNzNGxS4rbHSxFmW5KqTTmTlIokGUqFQ5tVtal80qumgN4zYudE50oNpjKiFFzIQiXlAKN5VOlFabidDOCj9JGDlT3bdmKFz2QRlxpd1UvD7+/d/DvZcHr4Qs3TQrtJsLbUWhPpa6UAlIRSzTFBwxOjw66EKKXBbg5FRBelxHxBbS+EVe0R9rkSb5cummK0KfTpWoScWlTEslsjEWULUCXXHCJMSaxKGXpdEfQaoTMVGGjAXpoGWtdFwotiCJuJA/GriiVGuRdfOUhdSzPCUB1ac8zRIMjWVqiSCeqpmMBteRm+dM6QqYjyklzxlE8qRW8ebmglaxeWassjRvc71P/zW1fZWRgE4ZJzpCm0THkNvrQyIq68SVhIPKOFbWjstUjEpHrwvW29TT4YgRTXJlYaC5NoGJl6Ab3axF/fX1VQl2U03T94sCJuqI44rBuCHFKEvY8drAIzohG4aViaXM85REB8vee0t8r1ctlo3ewxEUHwVFs9PeLolyUqe7bOxV6zaFfaGN6kwKqUlCxSLHmCjA8VInFM6zDJbxLBdRw3Tdhqdgie6GeC4T6Ov12w3KwEyukPEH8KJMe0igMx90iykUfWPOrzuXVdtKjp6t72z2x8/6Um7+vb+x/XS0M5ZbW+s7T3d2aPUZ/Cwn3jRhbVkUcr6y9O8U5ToWaYYE1H/CIIhv2J4F4MUpz5ya2Yd9wDy+wP6UnJ62UjPIK5z65NZQa57vHon+tkilmZQ8Lie3jGA6ZycYMWWayhENUQpCc8/4daEn2tyZaKacUWHc238xPDs8xcjx/j/P9k/wRLwubgs7NIuMgqiIhWl2xRIHBTivUCFjFIqueBK4PoFC0thlwlBf7NzCmIitsSxThxlh9TtmLLMW4wKldzmVOG8+OfFId1V3DVmLsZl08VSMpMWEzKfukyFyPnedw2DJJ2KqZKKKx10xTBJNSsrU10eL+XNKf5kkde6PS6Sy4jKeoWiYzOlYNX1Rm7LpDSSBdkxxuOwUSg5I/nCcDGNXQjhWczkLq2gJIi4qXhIs15Tu9HYVnBsnY2iBDWcOMxYFLMwFkTaxRSHUZPuZNAu6qmLd3NRqcbl76YXZcxm/i2VpvyDvjlKUnw6rVr24VCH5LNVhX43YGws3hYqEl6Q2Tw5UlbsWiS/GWqVJm7tt7ra5+4W5e/vlcUA94S1Dn41V6HNmAqalzXMF+lQIa0HE8CY4ck3AIAEi/fHmNCBm0AM3Eq78jvjIb+Urwg8rf/jxEcGPylkNX5CAbEevwRiVSCUDlruWmA3lTbW1utqLrBhpBKi5AyKiahZinpVCwmRFaQxJIu2aSDJlzW9OTCXqo2QE6ysgrWqSTp5p41ok2SLJdjdqd6NfZzdqkWSbu23u/py5+1kkWUnF2RJwki1nM1nMfaSF96StFCCozt9ElXLsqttohZiJCmNFTeQQjTY3Rhvj7Vj1E9lPnm3tjDfjZ5vy6fbG9saov7kdLe/153UeV0nWzKklf3s/+jNXVVwCx5UGwWVdliXN4z+Yt1BjKmtUeircDJvDpBc1drzzjNNBNzAGdizuOV48Oz4k/lia2ZPdsrKIFcFsbzp/Zk2QkmIYltbWtdCxhY7t9tNuP7/M9tNCxzZ329z9OXP3q6Bj/yHo2P8K6NgXBLHGBLF+JHRMgDsImo3hFL50APMago05VMFTOH0Mae9kMVGuAnoNFLm5s4oiT7NMvJRmvgBLtnESaWpzUXkD7YxoiwUtCKSYoEQagaqlgW4pqvRMESZF/IhUzzTnMSkEvsW8Mxw7aOVz5vbv6fg7TktIyEUhzejsNUOMaYSTGhP8Awc+B52gUH/HM87grf/qPFgck8aHpLHY/xQrRTlfnf8+veuWwAGEL6hcnHhf33NdwJ+ZS4M2Qn3KffmqIGgL1Vuo3m737Xb/a2z3LVRvc7fN3Z8zd78Cqgc0dD9UB8EXQ3XQdtdFhaVeUHD93xE7p0qQgMNbZDFj9aTG4DCCVRjUbs6LnAHi7/pQHpZuSpmpEzOo7tZ28DTWk4G/lxxd0OXXmUIs1peVqQ7Rfd9B1Kum2d51fdX3JqJFCV16xcoiBfHUudwOer1r+Bt+vunKXHdRBuFyNzfZVTfOZr3LrTuqF11W9ZmK+peUMXcfw6OD0K502UuFpkTwVZMX8D5ju1DIw3d8S+Gz/PkWMoJhjk5GeDZrAkkTgpKHIWaOjuQ3629ZcxCu6Ajdzor05iF9/rX1OT08k3v0uMt8n10L9AJS3lKPxL+oY+SEoLtffSVS6u2IfjTYXFnsNZFtiudKFugr/D2aR3+8OX28dI3b31RXmjoMpNwRQoQL4nBxp4Qm8R5VZOVkyoIPG7d2KAHFOIXC4q05UUqcHwQjvMJOcYzSzialSYqrCc26eLTwTKIuVUqbaLe2JAUekqAHC/VkY95j3jC5s9AGjzN/7fyt6Yg9TXVM08ZPNEFFbhTFeb7QSy7p9a1C/G3BreO5dZibfXxLCm/a89jfAo9RBYiFTC1b65sX9/w6S/yoDcMIcb0tA1kiyNG8axUvvPbNcjT4dYhfU4635s1UYzduThO+dgmLzTRNxIGIp1lm1T+EoNChNDiflMiibxbrihbtcEZ0NteXROr4JTu6A2zJ8h0iMYwPJjmivZ2hTeZPWTgl37FnkfPv0Hkn4l1DZx4+xxZMlEkW22+WmRbs0IIdXwNskN/vcBRYyG3SgeuAD4Dd2v9cCYKgSzXP87qzqjP7Hs+hrSGGqMzF5gP/x6AucOFJ8AuirmhQggmaV7fP6GOVwIu2uYaxFocKty24Km+aYXe9ZTcvb/XTKO24fzV9SeNhffby2qTz712l76kkf526+4MqXltpfsVKE8AyhRsvG7qK5SD3aG31JJCOqqcK/+ItZyqjcvQ8/sM7wjDLbPJUOoppzul4qhWfIeRKOkJ+axRX2YzzEHCXkh+dIjOa0GdvSFoLNCpHOgW/rniDJs3EMDE1aHR3F1zfZ6FTO4GVj8hJYm/hOACo2aw09PUfhChn9GXdQ95NtI1LX4QC4vcCZQzjqlmLjKSwIVN0uVUpZvb1mA6b0ccuOfGBteBDG06aYUjySPj4sFbkWKUcZUTXhN8P8UbkdKYqzalFRAUFmFJLK7w8OF3hCGYm/LyRFZNemGR7RAsm1Or4YNjqojGkoTyzDv3sEl/fPQn/rae492PP6/p4/Yd99xm2EML+vZxOvUij0vcivvc7j+reDxMGS9+Eop2YQnmiub6mwxHqhG5o+GOpqPM+v6gbHW4Q4Rd6TqpvNO81yKPjIPZj/nnnf/956Z2WWJwSmnl9QBDh8YOic4UlU6ALhzH4AIgV9QT+iGhp6sqPKI2ue2//cP90P/II564NPjzArihh/wFtCiox +sidebar_class_name: "delete api-method" +info_path: docs/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 'deleteCustomConnector' (delete-custom-connector)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

deleteCustomConnector

+ + + + + +Delete a custom connector that using its script name. +A token with ORG_ADMIN authority is required to call this API. + +## 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/delete-identity-profile.api.mdx b/docs/api/v3/delete-identity-profile.api.mdx new file mode 100644 index 000000000..55cd35370 --- /dev/null +++ b/docs/api/v3/delete-identity-profile.api.mdx @@ -0,0 +1,101 @@ +--- +id: delete-identity-profile +sidebar_label: Delete an Identity Profile +hide_title: true +hide_table_of_contents: true +api: eJztW1tTGzkW/isq78MkKdr4BsZ+2XKATDFFBgbM5oFQG7lbbStpSz2SGuKh+O97jqS+2Q6QTGpnJtUviemWzv0cfUct3bdkyhQ1XIqTqDVuRSxhhp1ETBhuVudKxjxhrZ2WoXPdGl+38jfEv9Ktmx2YpEPFUyQCJKYLromjowkVZH0KmVHNIiLhzVH7vXgvzgTRWRgyrXeIwclMRKnkwpA7niREMZMpQSj8iJliImTESBgIhLLkk+dEDNWfYITOEmOJTmDQJyaAhFmQs4uf/zs5envyK6GZWUiF0gAfxX7PuAJZgF5IgZXlPjk/sRSmwCGWSSLvuJgTxecLA/ooVptGrdx1sceER2LMvdpB6tQeO0HBlilVdAk/FVr0vsXRaCk1C3gl4AX8tT434BG81OGCLWlrfN8yqxSHaaNANHgTS7WkBp5kGYx82GnlIrbGRmVs00Ns0yvgDKDEPtNlmiBxFvcP4tGgPxiy0WBvvzfbm80OBr0B3dvvj4bRQevhBvnoVAoNYQBS9To9/K/OawIGSg0YKyAX1pFgQzIFZ11YXxE5+8hCU/gWTb3u2o9yRkLFKFBBEUMpDMiOrGiaJjy00bv7USO/+4qV1gQROS8bEjUhysiSsWVfckaO3txuOjpQYdIY7tQGi29xyZrFMTqdV2POVM3QcXzQOegedAfRaDgMe90O/KKdvf2DzoB2aNxHf7q4eBYXO7RK/zUNP82VzEREzpwBpkwtuaBGKhIexJ1+J+4Fsy7dDwas3w9GI3YQ7I/6e7OwezDs79mAqjF6lhzVR1VxfmaCKR66hIXAJcZLg66PqKGEC+sDectUQlc7JMNyMVvZh7noQPWSqVsesjaKl9BMgN/V07JdaaYIcAUf2sy9W0jiZ0eWA8pVE1hnaSqVQTahxGeGbfV4kYSgBAsMt26oMz+iWKngDcaZJ7Zun7dQGCfZnPS6pDsY7w3H/RE5PJoSyK5+RdU/L8LdgolCY3JHdWGHx+TZW5enVOPSUJPpbXIxkS1x9bh0ZR6evKNKuHfHSklMiNyzlv2ULVP3YnN5KQs90Y5jVdycxQOIBvXNPisz/ZLDMExBCOoHHDLodDZLxWHCIVOJFaCoWxAe3BUHLK5MGzKTkV1GuLilCf+62vR4SYmYoTw5lNEzkv4NFyyYK8pRQmZFDmEiBvgtjzCpllJhRUOSeX2z4+r1HizR7pLXNAJ9nX6HXhm0pIIiArROnlHrrgSH+SSfAmXPpfl2tmzI6Gy/M+oN4v0Bpb2DQXe4NxvFtN/vjPZGI+S+BIfSOauGFlWKrjZY57UlkbCc8z/AILBsgO2tAMwHGjdsqZ/2gaXxnKILermxhZpeXqhsn80OrDSvD8/JYAjpJeaZfU7na0YQwdUlLv9ZktAZPsJlG5PdEj4D8MG31t08sY6O30yuTqfw5OL4t6vjS/iFtDaSBxZBLiIMSxAVYmEh76zEXgEsAhqWvhCXWvLKU30FClGhqwO5+0uvNBgTYiumiLvIK899y4wqaRIruaylks2bz4a84G3W3iEzfAaVLFyUYBGHv3JoIjj1lnxFFoxGTL1sk0kUcVSSJgSyEYjC/BUQIjSKMHUdgTiDVGYWAcjMECGNXUGqvihNWfdGWU5Oq07B5ADJn46TSWgyEM6qWc3CIlq8iN4/ILOzXF26acVo1qQrYWgIWgB8XYEZlcIFfga6cUCrvhyhuzQUHpGPKypWtUracvfWCXNkpH0X0kw/I+/OEyg/gVWteHHLfPJpxMmuGllv5G7yFcljeTvZjyrclSc+gYqdRE3uNrnb5O4zc3f95YXv1PxbC326m9DnSvgO+Y9Ky1ZAH2WjR8i8jf7DwhvvyB2E1R4i/fJu6vtv7Is/p9iLfkd85JbyzRav8Id7Psu7yXzpL32BAlo7Og1iqEQsGlu5S4mtoZyp+pvc3kg14xCgYgtEzLDLWMnM7RdkArEuoXqHRJJp8ZMhCwr1Md88kMX+QWA3EBok2SDJZjVqVqMfZzVqkGSTu03u/jNz91EkWUhls8XjJJ0tl1StXKT596gtJTCA5N8MSJFy1lXraAWJkQJjterIoTXrdWfdeBiyQUQH0X5/FPfC/R7dG3aH3dmgN2xV1/rrMo+LJKvnVMXfzo/WxADibgHHZQKCSxspo/r2X2Y/HGBZs1+CctwMNgeT3pTYcbCJHX+VBnTDLfnAf9/a3F68ujh1HyYcebSbzBR+o1D5lwyzoMZCSoxhsDTXpoGODXRslp9m+flhlp8GOja52+TuPzN3vwo6Dp6CjoOvgI4DghArRoj1V0LHCHAHQrMYnAI6hBmYVyBsTEEV+OV3H33aG6rmzBRAr4Yie6NNFDmVkrylYpWDJV3biRSlubC8wdgljlX5WI5nquZQIgWBqsUB3WJU4ckAwKR4SiDhS27zGBUCumoVTGIDWrmcyeOt4MJFmGQgoS0KicS9VwkxxiGcWIzwDyjYfdA5FOrvuMfpvfWn9oPJBWp8ihqT488hY5jzxf7v3rZTAicgvMJycel8/YXjAm7PnApoI9jn1JWvAoI2UL2B6s1y3yz3P8Zy30D1Jneb3P1n5u5XQHWPhr4M1WHAs6E6jG13SIGl3mBw/d8Ru00VL4ENbyJDi9WjEoODETSDh9ysLBM8SHzoQnmSmQVm5mPH/m/wuPySQSyW1yywDuG5/3Frd32a3r3fcgngoYVCINp0imYqgckLY1I93t29B/+D3x/aNOXtfLaQd+1QLndv+1uqGR5edZkLPKIstN3I5PzEty9t6zXFMTFcFbUMnA+tnTAFwJf21MKj9PFUOgbHCjob4sjsEEgiH6T2MZ4khg7lJ21Ht21QbugIul2p5OEpff7Tf0wPR+QLemwz36O8YDwBKdfUQ/Fvypi5RCjvuG9ETrk84UeE3gazMxzWI68ZVdBnuHM1L355N31J5ghgbQHJNGJnxrHjgBQ8hxCxBXKSnzHBSXbNUjKbL6zgk9opHkxIEiegMHkvLhkj1/kdkV9h5biAUm9NipOYrS446+ZF7pmI3bIEF9V2aUkMPEiKXbDQLq3Ne2kXUNtpcOGOrcPT9nsRkCOOdY0jEMAxXkXbOJLrNNeLVvT6ViH+lVMLHLXAUtMv16Rwpr0O3anwEKoCkqCJttb6ZuaOXlChh20ZPEGq6zKgJbwc9bNXYe61b5ajRi9AenU53ot3Cw6rc30acbWMaFhck4ickHAhpWb/JgRDB9Pgep5BFn2zWHfINLAZEfQ6FZECxzLgAWBNK98pJIZwwURnuNZbqCPdrotNyQ/Ws5DzH6ATj8iHms728TUsyTgykqH+ZpmRYYAMA1cDtJffrXgYWJDbqIOtAy4ADkv/20rgBa3UPEdra1W35HftHFwaQhDVUtHp2P0xLguc/0XsCxxdjIESjFC9OI2GV+E8LVz2asbKNxnWLbgpbyJhtV2zm5O3+FSKK/DfTV/UeFLuxZyJZPW9q/QXKsnfp+7+RRWvqTQ/YqXx4BnDzbL1XUY1yB1a29wZxK3rBYN/4a3NVIvSaX6HEzFMlUyaUIMx7S7mLjizewopowaR3w7GlVzaPPS3/6BztITm9napAoEpdIE8AXpt8g6aNhGCibFhw7O8QPWj9J3bJVj53N5RPsodBwBqucwE3qkFIbIloRAeT3g34jrMXBGC/k0Ut1OlhXHFrDwjMWzQFPZSKlNLfRb7W5AVJz7BC3yo/c4zGBI94i8dl4pcsMRGGY6rw++naEPkBAuWpPaiIogFDWCFw9uT6QZFICb85w6p5rt+kt7FsUAEWx0XDP02NIr4KJXaQH9bk9ze1t1y13w9pO7LHffmnvpT99T9cod9ym6KO3Zo/cz1Ta5vvd64qY4hs0ESr69DK7QAx+Gc+3u0LHZxD/j494zhLsL1Tdmk2eYWYgp/Q7scQ8Vav8Re9eSLC6/pS/up6gtX27eqk29TilW5Q9GCn58YbmxsU+ThBqa5rSgrphvpNqsqNDY+59T6/6Pj0+Ppccthq23Qwv8Aq0Dx/B8LS+xg +sidebar_class_name: "delete api-method" +info_path: docs/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 an Identity Profile' (delete-identity-profile)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Delete an Identity Profile

+ + + + + +This deletes an Identity Profile based on ID. + +On success, this endpoint will return a reference to the bulk delete task result. + +A token with ORG_ADMIN authority is required to call this API. + +The following rights are required to access this endpoint: idn:identity-profile:delete + +## Request + +

Path Parameters

+ +Accepted - Returns a TaskResult object referencing the bulk delete job created. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/delete-identity-profiles.api.mdx b/docs/api/v3/delete-identity-profiles.api.mdx new file mode 100644 index 000000000..a56fa871b --- /dev/null +++ b/docs/api/v3/delete-identity-profiles.api.mdx @@ -0,0 +1,97 @@ +--- +id: delete-identity-profiles +sidebar_label: Delete Identity Profiles +hide_title: true +hide_table_of_contents: true +api: eJztW21z2zYS/isY3YcmGVPWmy1LX27kl3TccWqfLV8+2J4LREISEgpQAdCO4vF/v90FSJGSY7tu5q7tqJ3JWCSw7/vsLkje1/RcGO6kVsdJrV9LRCqcOE6EctItzowey1TY2lbN8Ymt9a9q+S1W3LvZgl02NnKOVIDGcCot84Qsm2Wpk/NUsLWN7FZyxlkqrWN6zGw2n6dSJOz40Nav1bU6VXAtjoW1W8whSaGSuZbKsTuZpswIlxkFBIwYCyNULJjTsFCwUZZ+CfyZ4/YLrLAgBREdwKIvQgEJN2Wn5z//Z3D44fhXxjM31QalAz5G/JZJA5IAvZgDK+I+ODsmCkPgMNZpqu+kmjAjJ1NnGTeiso2T3FWx+0wmqi+DGaK5N0PfCwoWxv3Cun2dLGr9+xWbrlqvomTYyUawtR4ooSS1vjOZ2KrFWjnYjlQ5Gjkmf29/tkj6vmbjqZjxdZ4nwTNrvMFDqKTnjgzdYi5gAzeGL+CndGJmkV64bp0BW9UetmriK59BMGAgteJec6+xt9sdtXi7IxqNZnfUbnT3kt3GqLHb6wGdZ5bsYeiBYEivthKy+2CeQ2/ZB/gPbWLnWllBcrUarXV1B+CzuQP/ReycYgvcyoYQP+cUPkyPPovYFeGG3l+Nts96xGIjOFBBs7zS7gOV86IorQixDHZwzCPsl87wJOA3BBqkuJNedZmsO2YtgTFpfKCOpTC1kt9q4zF4pLnX7CS9bjduNRvwF2/s7O41OrzBx230suIz8UIutLRMf5/HXyZGZyphp94IQ2FmUnGnDYv3xo12Y9yKRk2+G3VEux31emIv2u21d0Zxc6/b3klQgAqjF8lRvlQW52ehhJGxx5ExiOCCNOj+hDvOpCI/6FthUr7YYpmFEBot6GIuOlC9EOZWxpAtIF7KMwW+N8/LdmmFYcAVfEiAcjfVLOxOiAPKVREYYVQbh2xijdeceNTjoMuMO0R8iNbISXJDlfkhRwCFOxhrgdiqfT5oxQbZhLWarNnp73T77R47OBwyyLB2SdU/LsLdVKhCY3bHbWGHp+TZWZVnqcaF4y57BKWAmspmiFAXvvrAlY/cKH/vyBiNCZF7ltgPxWzub6zXwmX9YdZzLIubs0CEypFsme0XEpZhCiYBxDqNxjpcHEDVhKJIAhTYBeEhPUCUiwNWN6lueSp/Hz49DSmJcFymBzp5QdK/l0pEE8MlSihI5Bg2YoDfygSTaqahlnqSOcbRunrFcGCJepPt8wT09fodBGXQkgZABGgdvwDrLpWE/SzfArDn0/xxtqIr+Gi30Wt1xrsdzlt7nWZ3Z9Qb83a70duBogXcZ+BQPhHl0MoLY5V1ji2phi5DfgODQOkA25MAIgTaai39jg+IxktAF/Tyaws1g7yAbF/dFlSb/YMz1ulCeqlJRtf5ZMUIKrq8gCsqS1M+wkvYZmCyE+FT6Inko7ibJ9bh0fvB5ckQrpwf/evy6AL+QlpryQOFUKoEwxJEhViY6juSOCiAIGCh8sVYbtm7QPUdKMSVLS+U/pddWDAmxNaYYzvI3gXuj+wok2Zjo2eVVKK8+erYG1kX9S02wmuAZPGUjTiiv/ZI9c53FNFJsOQ7NhU8EeZtnQ2SRKKSPGWQjRn2yXwBhBhPEkxdT2CcQSoL6gJ05pjSjipI2RdLU1a9sYSTk7JTMDlA8ufjZBC7DIQjNctZWERLEDH4B2T2lqtKNywZjUy6UI7HoAV01QswozFY4Eegm4QmOsARussC8Kh8XYFYZZQkuPvghTl0mu7FPLMvyLuzFOAnItWKG7ciJB91th6NyBu5mwIihRGDNodVhbvyxGeA2Gmyyd1N7m5y94W5u3rzPExr4S61Ps311udShcH9W2lsK1ofQ9GjdD7df6P2JjhyC9vq0CL98nEYjgVwXP86x9n5B/ZHvpSvj3mFP/z1UT5R5qV/6QsUkOzoNRgDEomkT3IvJSZDeVO117m912YkIUDVIy1ihlPGQmf+GCNT2OsybrdYooVVPzk25YCP+ZmGLo41IjrX2HSSm05yU4021ejvU402neQmdze5+9fM3Sc7yUIqypbQJ9lsNuNm4SMt3EdtOYMFLH9uwIqUI1etditIjBU9Vq3aOdRGreaoOe7GopPwTrLb7o1b8W6L73Sb3eao0+rWyrX+apnHRZJVc6rkb+9HMjE0cbfQx2UKgss6rZPq8V9GDw8Q1ugBVd43g83BpDdF79jqrfeOQ63ZB64WeYdkKz2kWtoIMQ3WznCtyddKfEg3AVxUDKBKglwYSnimGzGD57upnElKXtQC6JpFNBg7UMUnSh5kBRep4jQDCQkJUo1ds4bAkqCkGGPPBxSog50AOv/A7jS46A918uwcNT5BjdnR11gITPSic9957Hz3GIQ3iBEX3sHfOej10w5XEAAwEHjMKvrOTX++6c83NX5T4/8eNX7Tn29yd5O7f83c/R39eeiGvt+fw4IX9+ewtt5gRS/1HoPrf96mU6oECSi8mY7jzNBxc96DgxGsgIvSLYgJvgJy4EN5AE07ZuZT75HdPNyglBCLqNFcW0Ihjhtr26ub7Da+PhQVr6D5EcIrl5kUtkydm9v+9vY9+Bx8/VDnc1nPySh9V4/1bPu2/QiC4asGPluBWZLFdHI9ODsOc0qdPGUkJoNHTmLg/Ua2wbAH/9EZ85P08R0iDIiFzvD9HCSzxSBxQmDSZXzvA6aSnyytrlMgrukIul2a9OE5ff7dfkoPT+Q7ejxmvid5wXoGUq6oh+LfLOPkAtt3z30tWpYlCUe+1hqzU1zWYvuCG5gt/FOQN798HL5lE2xaCTQyi/2ykDhlQNqdQYgQKA7yJwK4ieqU0dlkSoIPKs9cMAnZOAWF2bW6EIJd5e/r/QrV4hzgnUyKmwQhCu66eZN7JhG3IsVCWl9aEgMPEmEbLLTNK/veUtGk6UIq/5IRXK1fq4gdSsQyicUf1wQVaVhkV/NcL17S67VC/COnFnlqEVGzb1ek8Ka9iv07PDEgAZLgqSVrvZq5pxeV6OEoBleQ6qoMaIkgR/VJWZx77dVyVOhFSK8qx7X6OJVQkavbmMcvZqGgpgk7ZvFUayv+yRiGDqbB1SSDLHq1WHfINKKMiFqNkkiRZxnJCPpLku8EEkP5YOIjrO/U3mjo/FTiU/ITeRZy/hNM3wn7VNGZLl9BGcaViY7tq2VGhhEyjDwG2CC/r3IYWPhKHehAOOAD4GDpf0KCIGgJ8zytR1GdyG/THiwNMYhKVOy873/0lwAX/mJ0A1cXawCCsT0vnh3i+9SBFpa6irHyg4VVC67Lm2qosCt28/IWB1tYdf9s+qLGg+X5y6lKFz8apb+DJH8e3P0/Id4Gaf6OSBMaZjzHPF9+PnH0w78ywHgmvVa+NsAs8u3g+nEjnodPBfwLdwkKqPXn+Wv92CSVycxT7jBp/OcjUynooGIuuMPWcgsDV88o0cPL4DCOEqEJfXBgwCIcRkuZAr06+wiToIrBhzgF4qsdQPWzDuPgBbjxjL6kOcwjAzq02SxT+JUHCJHNGIf4eyZ8EmnjzKMcDIWq+GBBU59Y7MpTHuMSTUEfjAgzs6fj8FJ8KUqe4QVBYsNxNhgSPeK/NagtFTkXKYUxrqv298/RhtCMpiKd03vrIBZMlSUOH46HaxSBmLKgF8z72ky2wya7jWuBCM5SPhjadZg+8RIOZDA0VySnbzfWv6ta+4yhOMTffGH1ui+sQo3F4Wh7jkeD6JHMD2t+RMbZemVEhn3lIRnAYIpDNSy9v8eDJJwYH/AywA+eUlzdLAdC/AUs/IESTdVfBB5khCcY0XBB3UM4sVh/NIMzqt/hD6meXFue+89O8biuNgrfks38GYjhd3AR/+3XruF/+KHnPldgEV2/r+UnirDG083btMe6lPAHqvnw8F/8nK38 +sidebar_class_name: "post api-method" +info_path: docs/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 Identity Profiles' (delete-identity-profiles)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +The following rights are required to access this endpoint: idn:identity-profile:delete + +## Request + +

Body

arrayrequired
+ +Identity Profile bulk delete request body. + +
  • Array [
    • + +string + +
  • ]
+ +Accepted - Returns a TaskResult object referencing the bulk delete job created. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/delete-lifecycle-state.api.mdx b/docs/api/v3/delete-lifecycle-state.api.mdx new file mode 100644 index 000000000..7224ca9dd --- /dev/null +++ b/docs/api/v3/delete-lifecycle-state.api.mdx @@ -0,0 +1,96 @@ +--- +id: delete-lifecycle-state +sidebar_label: Delete Lifecycle State by ID +hide_title: true +hide_table_of_contents: true +api: eJztW1lz2zgS/iso7kOOMiVbks+XLcV2pjzlxB4fm9pyXBOIBCVkKJBDkE40Lv/3/bpBUqdjx5PaSVJ8SWgSaPTdX0PArZekKpO5TsxR6O15oYpVro51pIJJEKvzXObKW/NyObTe3pVXfxD8xXrXa5hig0ynRAIELkbaCmXCNNEmF46cFflIiYW5orDaDIXOrTg6aL03fZEnfygjPul8JPqnR2siycTJ2S+/9w/eHL0VsshHSabziQD9TP1Z6EyFmCICGcegj7eY1AKvVgUFDQS/t96lVdl+YnL1Oe+DAsmgQ7OnQ2VyjPHTLIl0rPy4Ys63xNzeWBo5VN71HQRMZSbHECOzTFKTmKkEsTXP4AP+WiKnQ29RMUflGHHqxkBqjKkk8fbyrFBgPhipsfT2br18khJpm2dQk3e35qnPcpzG9K4z2OnuhGrXDwe7A18OgshXW70tP+xFne2eDHud7g5mrGR1QdBVnC4a6umMqqi7E+32ur1ttdvb3OoMNgeDnV6nJze3urvbIZi8Jso2TYyFM4FYZ71D/y36lGKTK5uLT9IKWwSBsjYq4ngiJJ7THL4Af0vY0ezE5mpMrhCQ5U1OFGWaxjpgR29/tET2dlmGZPBRBfmSQg7Yi0NR606w7mgFGBzxk2vHvSOzqJJHkntmxcHFiaC5RFmZYswhd/T6cP+/+8eHv59f9C8OKeKmCl78CO3DoE/lgALRmyG/0en2Nu8q13m6WKG2aSwngujMLeBRaGYyyBHqtdd5d1gSkeIErN4yrXIJjKAxvfX1ZV/ZjzUsLg6zDDR9cabyIjPkHRH7RuVGgyTkTKLNjYx1+LecZd4HQpVLHe8n4SNU9lob5Q8zqYlDxSwHmChA8UaHlB7HSaaEIykSJwKPm1cjNNHaEK9kCHmdfPulMKRKKPgP0Dp6hGNcGo35opoidCgiMHXPsmpbycHW+m6nF231pOzs9Da2Nwe7kex213c3d3dp9TECFZl0Jjw8mWVysrT0L8qoTAciTpDR9V9QSKYkdM8M8OKYohHY9mEbMI1H6J8Sixtbi1nyK6hirAkpXu2fit62iKUZFvxeDheUYPzLc8qvyEZyQK8oQUJyR/gk00NtVrFSBfjB4ev+5fEF3pwd/nZ5eI4norVUWfsG3hqSW4JV+MIo+cQclwJwYkR8BAiQlnhZUn0JgaSxswO1ncmS8K1IFnGOGeXqK2bMkhZRloznQilw5VU81y3VWhMDejeWeTASA2kxASak4S/7nKj941KTL8VIyVBlL1qiH4aahJSxQDSCKOZPQEjIMOTEzgSiAqGsGB8kRS5MkutgIZ1MVTlvjZl8MmsUCg5w/rCf9IO8AHMs5mwU1t5Ssljah5IgrzPP3VIZm5gcuU8TgplAjVkGDYsBZCNQVKYjMpdF4jHVuDpjzaZJTndvHDMHecLfAlnYR8TdaYz047No9YcbVQafJYTlshFbozJTmZHKgsuTy1G1uarAF5FWcdjEbhO7Tew+MnYXP56VCLn8ytBnYxn6XJqySaLiuQR9MvYek1Sd1F8Mb0pDcrNVQqRf312UrRh1cp9TQv3fEB+5Ur7EfL+2h3s/IPhRG2vOFsQg69FJECETqXCP+Z5yzIpyquour/Y6yQYaDmpWQERkzUxMkkJIqCwrjCFOpF0TYaKseZaLkUR+lNyCuAzoOl6fW94GSTZIsqlGTTX6eapRgySb2G1i98eM3S8iyZorjpYSJ9liPJbZxHla+Z2klQIDRLVXK+qQY1MtohUiJmqM5c0jB2/Q2RhsRNuB6oWyF251d6NOsNWRm9sb2xuDXmfbm631V9M4roNsPqZm7O3syCoGiLsBjisMnMvmSRLOb/9BvZmKKK1R6qlxM3QOlV5PsWNvGTu+TXLIBsLAjtk924uXZ8dEH0szedJbUmSBIpjtVIfhMmdIST4MTWubN9CxgY5N+WnKz09Tfhro2MRuE7s/Zux+FXTsPQQde18BHXuCIFZEEOufhI4hcAdBswhGgQxBAfUago0pRMFTuftYhn0us6HKa6A3hyI7uyvONCSJeCPNpAJLdm4n0kzVRekNY8c0NqvGYoAUQ6RII5C1NNAteZUeK8Kk9Et+rMea45gEAt1s4vejHFK5mKn8rV5FmyAuwCEnhTihvdcEPqbhTioi+AcKvA86RKL+hnucpbX+1n6wOCOJj0licfg5UIpivt7/3Vx1SuAIzGeULs6dre85LuD2zKVBG6E+py591RC0geoNVG/KfVPuf45y30D1Jnab2P0xY/croHqJhu6H6hjwaKiOsa11UWOp1+Rc/3fEzqFScsDuLZKAsXo4xeCMK+BK0xPulEboXPSe1148vG3btyvOc9+1F05OY9jyWeo7j86fE6R00hRZjCVGeZ7avXb7FkaGce9aMtWtag2TfGoFybh9012RsuiEqgtPcBIWAbcc/dOjskdpsWkyTd7vUiUv4AzFyiA/h8H4aMIX6dPZXPKACdoX4cis0Vnk0hP5NdhM0YY8s+VJXlLskoyQ7TKL7x6S5z/dL8nhiNwjxyr1fXEtjBfgckE8Yv96el3gnPC6W33p0sC0BtEvBZ2lxU5oWEe8UjJDM+EOzzz/9d3FCzEklMpZwl13UJraCsTZKVyEs2C/OkhCk7gwZUkxHDHj/bmjOhR1IoohsHhvzpUSV9WdgrcoD2fI56xSmqQ4hdCs6+eVZUJ1o2KqnK2pJsnxdGja0FBbzs17wVWS2wlt8Djmt633xhcHmpKXpmpPY0oRuTsUV2kll5yR66lM/Kui5jtqPlOzLxa4cKq9CtzR7wChTyRkbFlbT17c0fNn6FHvhTdEdZEH0kTJx/wBq6Cy2pP5mKPnE715Pt6bdyONEjw/TbiMJywqaByKIxGMksSqfwtBrkNhcDUsEEVPZusTLepzRPid9RmWfLekr30ASubvGIFhnDPJARV0xjOJ21rhkPzAlkXMf0C7HYoPczLz6yvUXRoZJoF9Ms+0oE8L+i4H2JJ/V9bIsRDbJAPnAecA+1P7cyYoGZ3JeY7WyqzO5Ns8h0pDAFaZik333B970wRXPgn+QKPrMUjBhMfrI2d05amkRbVtTlnVTsKiBpf5jROU1AW9OX7r30OpzH5v8pLE/emGy4mJJ986S9+TSb6fvPsPZbwm0/yMmaZEyORuvGzZSsw6uUNry9t/tD89UvgXXzlSGYqj0XHXOAnDzJJJY5mTT3NMByOteOMgVTIn5LdGfpWMOQ4Bdyn40R4yoWGGMQhaCzQqBzoGvZZ4h87MBFAxdWV0YBdUPyZle3YOLZ/yHdSDynAAUONxYegOJpgoxkLCPR6wbqhtULgkhCbNqEqyhGFcPauKSHIbUkWL+5NsbE8i2mFG8zpjxAfWgg1tub0MRZJFyqubU0HOVMxeRuPm4fdDtOE5/kjFKfWFyKAAU2pmhTdHF0sUQcyUv2kk2bBdTrJtGgsi1Oo4Z+i20A3SqzSxOZrYOc6p51q6ATyYuLulc051O91Y/w4uE5cVhVqBdko7XyRg4VoT10BeLd3+Jass3zDmi7aLPSSNXHEjF23JCEok4re3tLNCHdUdvf6zUNS2X11PGyZuNGFfekaDGyF7qC/o9PlZKe8LsfpK8kqRqy1BM5nuBnh4/EPRJsIqYak1fBJXK68fP4GpFXq9u8YstxXFWnMD3WbVDImln3OoT6w3EA4Ojw8vDj0Hu1ahjvIBRkJe/R97kh8z +sidebar_class_name: "delete api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Delete Lifecycle State by ID

+ + + + + +This endpoint deletes the Lifecycle State using its ID. +A token with API, or ORG_ADMIN authority is required to call this API. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/delete-non-employee-record.api.mdx b/docs/api/v3/delete-non-employee-record.api.mdx new file mode 100644 index 000000000..5b73f88e5 --- /dev/null +++ b/docs/api/v3/delete-non-employee-record.api.mdx @@ -0,0 +1,84 @@ +--- +id: delete-non-employee-record +sidebar_label: Delete Non-Employee Record +hide_title: true +hide_table_of_contents: true +api: eJztWm1T2zoW/iua7IcLHZxACFD4spMC3eEOvWV52X6gzKDYcqLWlnwlmTbL8N/3OZLtxAkv3W53995OvrRJfHT0nFc9R/i+owthuJNanSSdg04iMuHEb1od50Wmp0Kci1ibpLPRcXxsOwfXHTyL6ofsVKYinsaZYO+44mORC+U6NxtQY2MjC1ILpZcTaZkRv5fCOvZFZhkL2zDOFLSJWpvxe3U/qnPISiOwSEN1rJUTXx3TKbuViTpQwpqDoOEWwApueI7PhuDddyTtWHA3wSOFB/gmCX8bUsuKsC+TCVu7ujo5Woe0+MrxlBaLdPt1uj/YHuyJ/cHObn+0Mxq9HvQHfGd3e38veQ1hE+DCf86UYqNj44nIeefgvuOmBemwzkg17jw83JCwLbSywtLz/uaA/lvEFkxWjkVMqkTG3MEXbiJmTuSW2TKOhbVpmbFR6eixEQyOVrPlTrMRLXKlUQIGqkpJQNDtPGx0BpubywgOM0nLj43RBhjOGwVpC8VIJ1PaUao7nsmkC1dUO5NKXhQZQYfK3idLeu+XPaNHn0TsKIqGEtHJ4JdEOC6zQ52IZS8uhvKtVCIaGy4JofCQYyxk0HgnE6xguYZngkpKIjLBy3VbgYYnulvsDU/YeWXfYWUM3OQMjz9DFxXJS4CulMR6Vi+hvEoB6oltxZ7go93N/f4g3R1w3n892NrbGe2nfHt7c39nf592zxFnVJed25sbw6dLW/9NKGFkzDIdIyL/hEOM4PC9B+A3xxLpRG5fjoHX8Q3+v4RdQbYxs8LLqGw3UOVvDs/YYI9lXI1L/zsfLzhBRVcXVLBllvER/USVBMuD4vdGjqV6DIpQZU5d6ej47fDq9BK/nB///er4Ap9I11IrGqq6ogAVuTDRXzziygBfV+gssRNJl72qtL6CQVzZeUEZvtmphTORWykvM4cV1e6PrJhXzVKj81Yp1T1uTXZFdwNVi99y7uIJG3GLBTqU7qshar5w0WnlyVdsIngizHqXDZNEkpE8Y6hGKMX6KZU/T5JZ7aclShlgpJtoNA2lnYxFOxYzV7ajgSKQzkuczgeFigPIX86TYexKgKtbeVMOTbZUEOuOl1Sea6O7XOyCU+V4DCt4lk3hRoNm7nxDlM42jVCS73OuarmmYz08zMzy7e5dAHPktH8W89J+Q92dZWg/kTeteXAnquKz1IdDN/LRqMNUdSQ8JLP94kqqCVdd+CyVIktWtbuq3VXtfmPtLj48r1hP9dRTn61l6nOleAn/Gn94LlGfhmHVQp7eVIHcYHBIRZF+/XCJwv4sFMmLrwXRwx/Ij8JRvgR+2MQj/D4i+tEEqxULAuj9GCxI0YlEcuBxzxB7RwVXbS/v9labkUSCqkcoIrqmYVNdMg6XmVIpQsLtBku0sOoXxyYc/ZF7Bhs6IO2qkqjQUrkVk1wxydVptDqNfp7TaMUkV7W7qt0/Z+0+yyQbVL5aKp5kyzznZhoyrXpO1nIGgeb+jTUl50O1yFZIGWs4VqfNHDqj/tZoK92LxSDhg2R3ez/tx7t9vrO3tbc1GvT3OvNn/fWsjpsia9fUXLxDHL2LQeLuwONKheSyTuukff0H9xqRUluj1tPwZvgcLr1puGN/f5k7XmpNV8bTmiHZFodUMx9RT4NsTrKmloUAZ2P0RcXQqiRwUSrJXECLQdKwTObSFy9ZAb1mGg1TB1NCoSzehOJ7nJVA6DtBpok1aySWhJEiJc4HDZ7BjtGdfyA7rUL0HzF5dk4Wn5LF7PhrLAQVesPcdx673z0BeEM94iIE+ImL3jDtcIUEwEAQelbDO1f8fMXPV2f86oz/Oc74FT9f1e6qdv+ctftv8POKDT3NzyHwzfwcst1N1nCpt5Rc/3Oa7kulQuDTm+k4Lo2/bq45uOcVSKXZCx7+tQk3wffe/BsYUXgTwvbuZfIAmcD/A7LSZBCfOFfYg17vHgFDoB66vJBd9DHEzE2V/tKNdd67236k/dB7AqHU0MCSMvbXzsOzk2rI6Ho3G0mZHNqe3yA43RtGOQvn+wviZ/XTWx8Uzaku0ei8mg2GrK+yyv8MmAVGil+sl+76LFqyEbZdmezhJXv+sf2cHUHJE3Y85r5n94I8A8oF8wj+DYULkYciH68r4DkM/WpYUqivb+ZlLoifB4RLkrMzh2a6/hKg9yTWZ28ENxgewp851n79cLnOxsRKfVcoLRFiIWmMQF2dIY181xvWV/60yB9ERpfjiTdu2PqjClUZSzM4hX1UF0Kw65PKUb/hODhH//Zup0XCtwxadbNWRy8RdyKjk7I78zYlp0xUD17s8da6dX8q+vFBKnzM/a/djypiR5KalaTTnWQqE/00yK6L2i4+Z9f3gvhLrS0K2iKvza4voAiuvY7DSzoxSp1U8Mx6b3335kFfNKePZi38QloXMZAnKhztP4XFddS+G0dLX0T62jg+qg8TiSO3vYyFDscsTswsYScsnmhtxV8Zo9ShUrkel6i074b1hTaNfEVE/c05SFHYMpIRCKTHd4rCUCGZ+IgOcM9fNKidSkLZ3vrIoi/cYrxO2G3LZv/zNc5Zkkx0bL8bM20Y0YZR6BO2wh+OMUos1DbZ4PtASIDDWfx9J6iAzvXFoOvRzu/V9/waOj5iQPVabHEQvhzMmmD1ifkHJN3IoE0T/27+OIjvrNJFZ1nLWfXNwaIHl/FmGkfogt8C3ubmio7VP5q9ZPFwdsHyXmXTH92ln+gkf5y++3/qeKtO8zN2mooRU7r5bavRYT7JA6Nbvu6j++iJwL946ivVU28MNn5U8xxmXk2RcUc57Ws6nkjhLwoKwR2xww3KK537OgQlpuLHOOgVjQ1kULQWjJWPZAZ9XfYBk5iK4WKawujVCmj9pKtx7AJePqMgsaM6cCBQeV4qrKUaK3PGkR4vRDeRNi5DE8JQpkRtmfY0rllVVySlDbmi6+cRk9v3Kd0oY1idC+ILeyGGtrpOhiMpItVb2zNDzkXms4zk2hT9Jd3InGgisoLmQHRQkCkxt8O7k8sljVCmLOzCvK3NuFctsj2ShRIah0IybHcx/dFPhbYOQ2sLuX+7vfWOefMefSul7mfX6P/lt+Srs4JEegXdYRH0MgwmYRS87jw2CmLpgUzonf4J7CSp+3u67KDB6IF+Bl6apK9vZnOPnz8QAvqMmTNFgYtnDF+rDEnW2Uuv5T9qRX1fp6azUb2Dj58FTfgAjzkY8P0VjIcWHoRLmrklS3/GoHmpGZyPjk+PL4/RPf4Fx0dBVA== +sidebar_class_name: "delete api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Delete Non-Employee Record

+ + + + + +This request will delete a non-employee record. +Requires role context of `idn:nesr:delete` + +## 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/delete-non-employee-records-in-bulk.api.mdx b/docs/api/v3/delete-non-employee-records-in-bulk.api.mdx new file mode 100644 index 000000000..e817c93b8 --- /dev/null +++ b/docs/api/v3/delete-non-employee-records-in-bulk.api.mdx @@ -0,0 +1,87 @@ +--- +id: delete-non-employee-records-in-bulk +sidebar_label: Delete Multiple Non-Employee Records +hide_title: true +hide_table_of_contents: true +api: eJztW1tv2zoS/iuE9uG0RWQnjps0eVm4abrIQXqazWX74AYILdE2W4nUklJab5D/vt+QlGzZTpPtFrs9hVsgiKnhcK7fzNDKXaQLYXgptTpJo8MoFZkoxR9aHedFpmdCnItEm9SeqNdV9jnaiko+sdHhMAJJXNOwUzkWySzJBHvHFZ+IXKgyut4CN5sYWRB38L6cSsuM+GclbMm+yCxj/jSWV1kpC+xWYCpqpsafzEbcipRpxcrpEoXE08LoW5mKtMPOwVkagSM0WCValeJryfSY3chUHSphzaE/7wZqBDFe63QWHd4tCdrSbQS9a0Fr4UfY1glccCQMV5pKbEXuUKgOjrwoMpk4w3Y/WWJ7F9lkKnJOv5WzQuAgPfokkhKMoAXcUEph6Sn0WhXqVFqnzbIFSI7AjhvDZ/goS5HbhWNsaaSa4MFYm5xDvKiqZBrdb0XiKwcrQQ7tjV7tvkrFQZyODkYxHyXjWOz19+K0P+7t93na7+2+Aote+gSy6/v7ReMMnUZY9Mu20Mp6TXvb/XXmZ8GQLGZSpWRGuJXc30QPt8xWSSKsHVcZfFTSYwODWBio2V5qNqJNZWUUYkiqwMRL0CEL9Le3VyU4yiRtPzZGG8hw3jAYt6SgMKATpbrlmUzJEz8oAlJRcpkd6VSsc2Nb2LdSiXhiuCQJhRM5wcaQGdjBcg3LeJYUQaSCoyOBmwggS3R22Gueukwi/Y6CMjBTaXjyGbwIJB4T6EpJ7Gf1FgQpQ+A9dKzYF3y0t33Q64/3+pz3XvV39l+ODsZ8d3f74OXBAZ2ew8+AlcWYrmO9ffTfhBJGJizTCTzyLxjECA7bOwHc4WvS4wEfOB5PsP8l9PK0jZpBXkYItMU4e310xvr7LONqUrl1PlkygoqvLrCiqizjI1oiQIHmnvF7IydSrRNFqCqnBHtz/HZwdXqJlfPjv18dX+A34rWCwQNVZxRERSxM9RcncVDA5RWwLikJUV8Eri+gEFd2kVD6T3ZmYUzE1pgDw7EjnL5mxyJrNjY6b6VSDdfPZEd0tpC1WANUJdM2/L8YIOeLMj4NlnzBpoKnwjzvsEGaSlKSZwzZCKbYP6P052k6z/1xhVSGMLKcaoCG0qVMRNsXc1O2vYEkkKWjOF10CiUHJH88TgZJWUG4uio16dBESxCxRrw0WK4t3eUyCs5UyRNowbNsBjMalM3SAaIsbQOEkmyfc1XTNYhFiFyr5eDunRfmTands4RX9gl5d5YBfmKnWvPgVoTks4TDoU6TN2o3BUTCQ1Lbba6reW2LOvHZWIos3eTuJnc3ufvE3F1+eB66nvDUtT47q63PleIV7Gtc8VxpfZoOqyZy7U1w5BaDQUKL9PuHSyT2Z6GIXnwtqBH8gf2RL+Urwg8af/j1EbUfjbNaviABnR29BmMgkUgPndxziZ2hvKl2V097q81IIkDVmhYRqGnYTFeMw2SmUook4XaLpVpY9VvJphz4yF0H6xGQTlVpXGipyk0nuekkN9VoU41+nWq06SQ3ubvJ3T9n7n6zk2ykctkS+iRb5Tk3Mx9p4TlpyxkImvs31qScc9Vyt0LMWNNjRe3OIRr1dkY74/1E9FPeT/d2D8a9ZK/HX+7v7O+M+r39aLHWD+d53CRZO6cW/O396EyMJu4WfVylEFy21DptX//BvEaMCdYIepq+GTaHSa+b3rF3sNo7XmpNd+WzukOyrR5SzW1EmAbanGhNTQsCzibARcUAVRJyUSjJXICLQdCwTObSJS9pAb5mFg/GJVTxibJ8E4rPSVZBQocEmaauWSOwJJQUY+r5wMF1sBOg8w/sToOL/qtOnp2TxqekMTv+mghBid507i/X3e+eQHhDGHHhHfzARa+fdrhCAGAg8JjV9J2b/nzTn29q/KbG/xo1ftOfb3J3k7t/ztz9D/rz0A093J+D4Mn9OWg726zppd5ScP3P23SXKkECF95MJ0ll3HVz3YO7vgKhRAIV2joQ4eUUn7qLb1PE4Y2TLr3yEftXPkDqhwAvXmUy7JqWZWEPu907eA3euu/wQnYAZnBcOVP6SyfRefd2dw0G0csCPt+AYmmVuLvnwdlJmDQ6ztZGUjh77HMHeMs77Shw4QF3S/xN/ornzqUzXQHtHJsthtAPoeWWIWaBueI366g7LpRWdIRuVya7f0yff+x+Sw/P5AE91pnvm2eBnkHKJfVI/GtyF9wPRs5fV5DnyIPWoCKPD68XaS6oSfcSrlDOCw8Ndr0Vgd4TWY+9FtxggvDfdTz7/cPlczah1tRBQ2WpKxaSZgkk1xnCyEHfoL73p02uGhldTaZOuUHrmxVKNTbOYBT2UV0IwYYnwVB/oCacA8Sd2WmTcLhBu66f1d5Lxa3IqFx25tam4JSp6sKKXd7a99yVRjdDSOXfFcJq56OK2RtJiCWpxBNNUNGNhGxY1HrxBb2+V4i/1Nxizy123OzzJSm8aYeJf1MnQb4TC55ZZ63vPtzzixf40cCFFeK6LANZIsjR/j4sqb323XK0+MXEry3HR/VhKlF329uYhzlmUTazlJ2wZKq1FX9ljEKHUmU4qZBp3y3WFzo0dhkR97YXRIr9kbGM0UU6+U6RGMoHEx9RFXdNjEZ/p1KftjfOs8CFG8zYKbtp6eyWhyi2RJnqxH63zHRgTAfGHidskN/XMgosejMOOjgc8AFwNPe/Q4Ig6AIuel5rkd+x77o9VD4SiOq42OLQfzicg2D4jbkHRN3QAKapCW++IcRnFnhRQWsZq74+WLbgqryZRh1dspuXt7m+otr6s+lLGg/mtyzvVTb70Sj9AJL8PLj7f0K8DdL8ikgT2mK6rTyfvwp9XA8w4R3kH/1WMKZ6xLfTMwwsi1nlW8jVS0a6BZ8K/MRTBw2u4cc45QZE1zQtsikyXlISORBJplK464lC8JLa0S0KZJ27xEcPTmiDIdQxmhjQACUsWmQ+khn4ddgHzH8qgU9p9qMXOsD1kw5D4AXcekZRwd7UkYKOLc8rhb2U1FXOOOLxkXBKpU0qj3oYBZWoNdOub2x21RBAcUqmcG9+C5Pb92O6x8aIvBA1j5yFoLHhEhuGJI/QCEADVqPIuchcWBNdeyZ4jDdCNZ6KrKDpE5CN7k0snPDu5HKFI5gpC70w5Wsz6YZNtku0YELzlw+G3Q5mTlqiOQ6jckty947+u/qPCVpv8Yc/Y1gOrrv5Nf5P9ecJoagRSbegGzdSufITlB9dh9G60RVbF4dXjDpTmndBfXdHgtIkd0/L0JLm/+H1fFBzwxE2uKsaNz19FnRFEL4biC9nrmKHu4DVLz1odvQ7/PXPN2mvF0bys/d0ERaNwt9i5P52wfAvWKSfh9FH/McHXfh4BJFbv4vquzrQeL7079/7kNFX +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/delete-non-employee-request.api.mdx b/docs/api/v3/delete-non-employee-request.api.mdx new file mode 100644 index 000000000..a54da01c1 --- /dev/null +++ b/docs/api/v3/delete-non-employee-request.api.mdx @@ -0,0 +1,96 @@ +--- +id: delete-non-employee-request +sidebar_label: Delete Non-Employee Request +hide_title: true +hide_table_of_contents: true +api: eJztW9ty2zgS/RUU92GSlKmb5TjWy5ZiO1ueciZZXzYPjqsCkaCEhAI4AOlE4/K/z2mApERJjpNsdmeS4ostEY1G33EaAm8DnQnDc6nVSRyMglikIhe/aXU8z1K9EOJM/F4Imwc7Qc6nNhhdBRgMq1F2KhMRLaJUsJdc8amYC5UH1zvgYyMjM+ILrhczaZnxnNhHmabMr8M4U+AmKm4lSYe9VbSuNALTNJhHWuXiU850wt7JWI2UsGbkebyDaBk3fI7PhgS8DSStmfF8hiGFAXyTcbAuVEOPSjgZM6lYPhPs8vLkiCXazDkpb7w4MFFuCrET2Ggm5jwY3Qb5IqMFbG6kmoKynDIKigKL3u0E4hPHKkTDo36/1+vthfv9vadhv7/XC5/19/vh3mRwMBC7otd7Ngzurmk1m2llhaUFBr0h/VsX3ttE5SyExLGMeA5jkeC1nblltogiYW1SpGxS5DRsBIMv1HJ6rtmEJuWFUaLWvpKgQxoMe71NCQ5TSdOPjdEGMpzVDJKGFBMdL2hFqW54KuMOLFSuTCx5lqUkOlh231vie7tpWj15LyJyQmYoWHPp7RKLnMv0UMdimxuawr6QSoRTwyVJKJzIESYycLyRMWawuYZlPEuKMlLB0ZHASw/CEp0+e85jVuYFOyyVgZlyw6MP4EWJ9JBAl0piPqumUNwhcO5bVuwLPnnaOxgMk6dDzgfPhv39vclBwnd3ewd7Bwe0+hx+RgLalbW5MXyxsfS/hBJGRizVETzyBwxiBIftnQBucUyRuZjbh33geHyB/S+gl6et1SzlZZTXOygEzw9fs+E+S7maFu45n64ZQYWX55TRRZryCT2iVITmnvErI6dSbRNFqGJOhevo+MX48vQCT86O/315fI5PxGujWo1VlVEQFbEw0x+dxKUCLq9QeqJcxB32pOT6BApxZVcJpf9mFxbGRGwlvEhR256Uq2+ZscqaJUbPG6lUFcFHsiM6O8haPEOpiWZswi0maJ+6T8bI+SwPT0tLPmEzwWNhHnfYOI4lKclThmwEU8xfUPrzOF7mflIglSGMzGcaRUPpXEai6YulKZveQBLI3FGcrjqFkgOSPxwn4ygvIFxV6+t0qKOlFLGqeHFpuaZ0F+tVcKFyHkELnqYLmNEYWNgVRJnbuhBKsv2cq4qurlh3d0u1XLl76YU5yrUbi3hhvyDvXqcoP6FTrR64EWXyWarDvho5b1RuKisSBkltN7mkqt1VJT5LpEjjNnfb3G1z9wtzd33wrEQ95aiDPv1N6HOpeAH7Grd5bkCfGmFVRA7elI7cYTBICZF+fXOBxP4gFNGLTxnhy++Ij/xWviH8uPaHfz4h+FE7q+ELEtDZ0WuQoBKJeOTkXkrsDOVNtbu52gttJhIBqrZARFRNwxa6YBwmM4VSJAm3OyzWwqpfcjbjqI/cIVhfAWlVFYeZlipvkWSLJNvdqN2Nfp7dqEWSbe62uftj5u5nkWQtlcuWEifZYj7nZuEjrRwnbTkDQX3+xuqUc65aRyvEjNUYK2gih2Ay6E/6yX4khjEfxk93D5JB9HTA9/b7+/3JcLAfrO71V8s8rpOsmVMr/vZ+dCYGiLsBjisUgsvmWsfN4z+Y14iEyhqVnho3w+Yw6fUSO24948yhGxgDO5p7jhcvz06JP5Z27MluujCRIJjtTQdynjtISTEMS0t3mt1CxxY6tttPu/38HNtPCx3b3G1z98fM3a+CjsOHoOPwK6DjkBHESghi/ZXQMQbuIGiWwCnQISpgXkWwMYMq+FSePpZpn3MzFXkN9BoocnCwiSIvtKa7CYsKLNnGSaRamovKG2jnRGsqWhBwNkWJVAxVSwLdUlTJuSBMivhhqZxLl8ekEPiaRThOcmjlc2b993R8j9ICErqikGo6e9WIMYlwEgnBP3Bw56BTFOrveMZZeuu/Og9mZ6TxKWnMjj9FQlDO1+e/e9tuCZxAeEPl4tz7+p7rAv7MnCu0EeJT5stXDUFbqN5C9Xa7b7f7n2O7b6F6m7tt7v6YufsVUL1EQ/dDdRB8MVQHbafHaiz1goLr/47YXaqUErjwZjpyWD1eYnCHKxBKy6vEVEboJu4o6K5e9Q0rhN29lfEdiHwv4EUrTAr6WZ5ndtTt3sJj8NRdh2eyg0IGp+ULpT92Ij3v3uxuqT903dTnGipYXESufxi/Pikbjo6zs5EUyr7uuQW81Z1mFLSwvrtn8Fn+dLuY3LlAL8I8mx2GsC/Dyj2GmBl6il+so+64MNrQEbpdmvTuIX3+s/s5PTyTe/TYZr7PrgV6BinX1CPxr8ldcD0YOX9dQp5DX7DGBfn66nqV5pwAupdwg3K56dBPA4MNgV4R2YA9F9yge/C3ZR79+ubiMZsSLHVlobCEiIWkPgKJ9Rph5MreuLo5QpPcTmR0MZ055caNuzmUZixJYRT2Vp0Lwa5OSkP9hv3gDAXcmZ0mCVczaNb1o8p7sbgRKW2VnaW1KThlrLqwYpc35j1226LrH6Tyt8XxtPNWhexIUrWStL0TTamiawfZVVbpxVf0+lYh/lFxCz230HGzj9ek8Ka9ivxd7wi5Tix4ap21vnlxzy9c4UfNFp4Q13UZyBKlHM0bVVHltW+Wo8EvJH5NOd6qNzOJPbc5jfkSxyy2zDRmJyyaaW3FPxmj0KFUuZoWyLRvFusjLRq6jAgHvRWRQr9kKEMgSCffKRJD+WDiE9rBHYDR/izFpe0751nUhXfor2P2rqGze3yFjZYoYx3Zb5aZFgxpwdDXCVvK7/cxCizkNung6oAPgMOl/10lKAVdqYue19bK79h33RzaPiKI6rjYbOS/jJZFsPzE3ABR1zQo0wTA6ztm+M5KXrSZNYxVHR2sW3BT3lRjD12zm5e3/gGU9tW/m76k8Xh5wvJKpYvvXaXvqSR/n7r7F1W8ttL8jJWmhMQUbm7ZsndYDXKP6DbP++hAeibwF6MuUx32RmfjejWHYVbZZCnPKaZdTkczKdxJQSZ4Tuhwh+JKz10eAhJT8qMfdIymBjRIWgvEyicyBb8Oe4NWTEUwMbVhdEMXXN/rsh87h5Vfk5PYUeU4AKj5vFCYSzlWzBlHeDzg3VjaqPBFCF2ZEpVm2sG4elaVkRQ2ZIqOa0jM3L5K6EgZ3eqKEx9YCz605XkyDEkeKd8OXCpyJlIXZUTXhOgP8UbkhDORZtQIooICTImVFV6eXGxwBDNV/oihzbRbTrJdogUTaod8MOx20P7Ro0zbHF1rQ3L3HmXjXcblK5uNmLpdHqT/z1/ILLcLIulmdI5F0he+N/Ht4FWwtR3E3JGM6Q3SGXQlsttbOvGg5uiOHoOM2umr62Xv43oQuIE+o/FMkOTiM7o/KjWJH7OvegV0q07VCZ5aLJv3AB8/COr56QXQa1D5Qxknpx/wxzYrUzZ+2KAGqm6lj45Pjy+OUU7+BPcS3fc= +sidebar_class_name: "delete api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Delete Non-Employee Request

+ + + + + +This request will delete a non-employee request. +Requires role context of `idn:nesr:delete` + +## 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/delete-non-employee-schema-attribute.api.mdx b/docs/api/v3/delete-non-employee-schema-attribute.api.mdx new file mode 100644 index 000000000..a2bad1795 --- /dev/null +++ b/docs/api/v3/delete-non-employee-schema-attribute.api.mdx @@ -0,0 +1,85 @@ +--- +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: eJztW1tv2zgW/iuE92GaIrITx0mavCzcNF1kkF42l+1DGqC0RNlsJVJDUmk9Qf77foeUZMlOm0622Jkp/JJYInnu5/A7NH3b04Uw3EmtTpLeYS8RmXDitVbHeZHpuRDn8UzkfOyckZPSid5mz/Gp7R1e9TApqmexU5mKeB5ngr3iik9FLpTrXW+Cno2NLIg+qF/MpGVCJVGhpXIsMLOMM1uIWKYyZtazY7zmx1JtMK7AS9S8rC5NLPrv1Zn4rZQGBIwG41grJ744plP2QSbqUAlrDgOLD+8VBC+44TmeDIl/25MkUcHdDEMKA3hq2MIWm70gS+/wtufmBQ1bjKpp726zZwJnWMyZUqyqKViwG2sMx04S9uTy8uTFBiiLLxzKEEmR7jxLD0Y7o31xMNrdG052J5Nno+GI7+7tHOwnz8DsXkmDDX6AmJ4Ok8kflOqaiNtCKysssR5ujehfl8FrHZwCV0dMqkTGnNztwJckE9axz9wyW8axsDYtMwZL0bCBRBZOb5Y7zSa0yJVGiQS0KiJBgj7pOtraWpXgKJO0/NgYhFHEzhoCaUeKiU7mxFGqG57JpA9jVJyJJC+KjEQHycFHS3RvV42uJx9F7CjKDGWUk8EuiXBcZkc6EasOWvbHS6lENDVckoTCixxjIQPFG5lgBcs1LBNIUpiTCn5ev+M9WKK/zZ7zhJ1V+h1VysBMzvD4E2hRtj8k0KWSWM/qJYgSn45fYSv2BZ/sbR0MR+neiPPhs9H2/u7kIOU7O1sHuwcHxD2Hn1EdbIs3N4bPV1j/SyhhUA8yHcMjv8MgRnDY3gvgmWOJdCK3D/vA0/gO+1M+hLmNmpW8jArLJurQ86O3bLTPMq6mpX/Pp0tGUNHlOaVpmWV8Qq8o86B5IPzGyKlU94kiVJlTVX1x/HJ8eXqBN2fH/748PscnorVSSseqziiIiliY6c9e4koBn1eofbETSZ89rag+hUJc2fZEGZ7s3MKYiK2Ul5nDior7PSvapFlqdN5JpboKP5F90d9E1uJdzl08YxNusUCH1H06Rs4XLjqtLPmUzQRPhNnos3GSSFKSZwzZCKJYP6f050myyP20RCpDGOlmGkVDaSexJ3R8sTBl1xtIAun8jNO2Uyg5IPnDcTKOXQnh6s2mSYcmWioR64qXVJbrSnexXAXnyvEYWvAsm8OMxsDCviBKZ5tCKMn2OVf1vKZi3d0t1PLl7lUQ5oXTfizmpf2OvHubofxEXrVm4EZUyWepDodq5L1Ru6mqSBgktf3ialbjrjrxWSpFlqxzd52769z9ztxdHjyrUE816qHP9ir0uVS8hH2N3zxXoE+DsOpJHt5UjtxkMEgFkX59d4HE/iQUzRdfCoKTPxAfha18Rfhx44/wfkLwo3FWxxckoLdj0CBFJRLJoZd7IbE3VDDVziq3l9pMJAJU3QMRUTUNm+uScZjMlEqRJNxuskQLq35xbMZRH7lHsKECtlucNZJcI8n1brTejX6e3WiNJNe5u87dv2fufhNJNlL5bKlwki3znJt5iLRqnLTlDBOa8zfWpJx31TJaIWKswVi9LnLoTYbbk+10PxajhI+SvZ2DdBjvDfnu/vb+9mQ03O+19/qrRR43SdbNqZa/gx+9iQHiboDjSoXgsk7rpHv8B/MakVJZo9LT4GbYHCa9brDj8GAVO15oTUfe8xoh2Q6GVAsbUU3D3JzmmnouJnA2RV1UDKVKQi4KJZkLUDEIGpbJXPrkJS1A18yjceqgSkiU5ZNQPMdZCQl9Jcg0oWaNwJJQUqSE+UDBI9gpqvMPRKeVi/4nJM/OSONT0pgdf4mFoERvkPvufee7JxDeUI04Dw7+ykFv6Ha4QgCgIQg1q8Gda3y+xufrPX69x/8ce/wan69zd527f8/c/QP4vEJDX8fnmPDd+Bxz+1uswVIvKbj+7zDdp0olgQ9vpuO4NP64ucbgHlcglBY3Vfy1DjfD86B9RyQK9yPs4La+KHE3CEAuau54YLB13+OOblJ4EBnkL00GojPnCns4GNzCrXDnXZ8Xso9qB8+6udKf+7HOBzc79xQpuk0QEhJlLiljfzg9fntStSJ97wwjKd5DcfQMgmu8+hTZcJE/Rv4mfboRQj6fQ1MWyGwy5EYVe/41xCzQePxi/ey+j7UVHaHbpcnuHtLnPzvf0iMQ+Yoe95nvm7wwn0HKJfVI/GtyF+IDhLy/LiHPUahq45IC4uq6PcdfxwkSrsxc7EzU+Q1XBHpD04bsueAGLUb4MuTJr+8uNtiUsKuvHaUl2CwkNRvIvrcII18bx/UXA7TIb1dGl9OZV27c+eqFcpGlGYzC3qtzIdjVSWWo19g0zlDlvdlpkfCFhVZdP6m9l4gbkdF+2l9Ym4JTJmoAKw54Z92G3zt9kyEVPub+bf+9itgLSSVNEgagOZWKvmdkV0WtF2/p9Vgh/lFTiwK1yFOzG0tSBNNexeEqT4yCQCR4Zr21Hs080Ita9KgjwxuiuiwDWaKSo/uFWVx77dFydOhFRK8rx3v1biaxMXeXsVAHmcW+miXshMUzra34J2MUOpQqV9MSmfZosT4T08hnRDTcaokUBZaRjAAzvXynSAwVgolPaJv3KEcDAKokpO0H71nUhQ9owhP2oaOzf32F3ZhmJjq2j5aZGEbEMAp1wlbyh82OAgu5TTr4OhAC4Gjhf18JKkFbdTHQurfye/IDv8ZfxIOonootDsPD4aIIVp+YH6DZzRyUaULpzVeIeGYVLdrxOsaqzxeWLbgqb6ax0S7ZLcjbnG/R5vtX05c0Hi+OYd6obP6jq/RXKslfp+7+SRVvXWl+xkpT4WYKN8+2ajDaQR4Q3eqhIJ1azwT+YtRnqgfoaH98Q+cxTJtMkXFHMe1zOp5J4Y8TCsEdocNNiiud+zwEJKbkR9PoCU0N5iBpLRArn8gM9PrsHfo1FcPE1KvRBQxQ/airpu0cVn7r75C/qB0HAJXnpcJayrEyZxzh8YB3E2njMhQhtG5K1JppD+OaVXVGUtiQKfq+azG5fZPSuTNa2pYTH+AFH9rq0BmGJI9UN7oXipyJzEcZzetC9IdoI3KimcgK6hZRQQGmRIvDq5OLFYogpqr79NpMB9UiO6C5IELtUAiGnT56RHpVaOvQ2nYkp04M8HDlzjsVu87PBMJ18+VIu12cwf/JPxGothiaNCjogIw0LkM/E/rMq959fSaWHq5cyW+1mjTe/nEBOpMZ7Ejkbm/pyIUarzt6/VspqJ+/ul70Vb6/gYvpMzrfFAVk+S5/24JPKp2TDfbgDxHu1bc+NlTzxYlBDx8/CTpoaKtBTeTjBWv99OARcjTmvrvG3HAu5S0VhsPJVWvhync71B42pwkvjk+PL45RLP8LudTmkQ== +sidebar_class_name: "delete api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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` + + +## 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/delete-non-employee-source-schema-attributes.api.mdx b/docs/api/v3/delete-non-employee-source-schema-attributes.api.mdx new file mode 100644 index 000000000..181c2551d --- /dev/null +++ b/docs/api/v3/delete-non-employee-source-schema-attributes.api.mdx @@ -0,0 +1,83 @@ +--- +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: eJztWtty2zgS/RWU9mGSlCnZsmzHftlSHGcrU85lfdk8OK4KREISMiTAAUgnWpf/fU83SIqUnDibTe3MpPRiS2Sj7904DeG2Z3PlZKGteZn0jnqJSlWhXltzkuWpXSh1bksXq/N4rjI5LgqnJ2WhfG+rV8iZ7x1d9UAb1cTiVE9VvIhTJV5JI2cqU6boXW+BrY+dzkkMhFzMtRfKJFFutSlEkOmFTFMRl76wmfAsT8hGoJhaJ6QwEKZqYZ5V64sz9XupHWicheDYmkJ9LoSdig86MUdGeXcURHyA2rl0MsNnR8rf9jTpk8tijlcGL/AtsIU3tnpBjd7Rba9Y5PwO+phZ726r54JQ+KxwpVq3UIngOaGJkfosoTVxUNPdp9PD0e7oQB2O9vaHk73J5OloOJJ7+7uHB8nT3t01Mfe5NR5+hujh9oj+dQW8tsFQuC8S2iQ6luSlAnJJM+UL8Ul64cs4Vt5Py1TAjfTaQSMPPzbLCysmtKgonVEJeFVMggZ9snW0vb2uwXGqafmJc4hMhCDUDKYdLSY2WZBEbW5kqpM+nFFJJpYyz1NSHSwHHz3xvV13up18VHFBsXOUrIUOfklUIXV6bBO1HqDVeLzQRkUzJzVpqFjlGAsFON7oBCtEZuGZwJJSh0xgun4nevBEf0c8kwknHdl3XBkDNxVOxr+BFxXSQwpdGo31ol6CLOEM/4JYdaDkZH/7cDia7o+kHD4d7RzsTQ6ncnd3+3Dv8JCkZ4gzKs63ZEvn5GJN9D+UUU7HIrUxIvJvOMQpCd+zAiwcS3ShMv9wDJjHN/if6iHQNmZW+goq1i2U9rPjt2J0IFJpZiU/l7MVJ5jo8pzKtExTOaFHVHmwPDB+4/RMm/tUUabMqFM9P3kxvjy9wJOzk39enpzjE/Faa09jU1cUVEUuzO0n1rgygOsK/SQuVNIXTyquT2CQNL5NqMM3v/BwJnJrKsu0wIpK+j0r2qzF1KERtkup7myPdF/1t1C1eJbJIp6LifRYYEPpPhmj5vMiOq08+UTMlUyUe9wX4yTRZKRMBaoRTLF+QeUvk2RZ+9MSpQxldDG3aBrGFhptthOLpSu70UAR6IIpTttBoeKA5g/nyTguSihXN/CmHJpsqVSsO15Sea6r3cVqF1yYQsawAjvMAm50Dh7mhqgL3zRCTb7PpKnpmo51d7c0i9vdq6DM88Lyu1iW/hvq7m2K9hOxac2LG1UVn6c+HLoRR6MOU9WR8JLM5sUVVROuuvDFVKs02dTupnY3tfuNtbv68qxCPdVbhj4769Dn0sgS/nW8ea5BnwZh1UQMb6pAbgk4pIJIv767QGH/pgzRq885wckfiI/CVr6m/LiJR3g+IfjRBKsTC1KQ/RgsmKITqeSI9V5qzI4Krtpdl/bCuolGgpp7ICK6phMLWwoJl7nSGNJE+i2RWOXNL4WYS/RHyQg2dMD22LBBkhskudmNNrvRz7MbbZDkpnY3tfvXrN2vIslGK66WCif5MsukW4RMq96TtVKAoDl/E03JcahW0QoxEw3G6nWRQ28y3JnsTA9iNUrkKNnfPZwO4/2h3DvYOdiZjIYHvfZef7Ws46bIujXVineII7sYIO4GOK40SC5fWJt0j//gXqem1Nao9TS4GT6HS68b7Dg8XMeOF9bSMfKiRki+gyHN0kfU00CbEa2raUEgxQx90Qi0Kg29KJV0psDFIWlEqjPNxUtWgK9bRONpAVNCoayehOJ7nJbQkDtBagk1WySWhpFqSpgPHBjBztCdfyA6rUL0PyF5cUYWn5LF4uRzrBQVeoPc9+47330J5R31iPMQ4C8c9IZpRxokAAaC0LMa3LnB5xt8vtnjN3v8z7HHb/D5pnY3tfvXrN3/Ap9XaOjL+BwE34zPQdvfFg2WekHJ9X+H6VwqlQac3sLGcen4uLnG4IwrkErLSyB8WaKY4/ugfe0iCvcj/OC2vihxNwhALpLt+yFhLggaly4Fm3lR5P5oMLhFIBHAu77MdR/9DbEsFsZ+6sc2G9zs3tOW6P5AKEE0tqSM+Th6/PZlNXz02f1OU4aHdsgCQjDYYMplBIUPjr/Kn+6AUJQXsE0ENlsC1VBlGz+GmjlGjV88U/c5u9ZshG2XLr17yJ5/7X7NjsDkC3bc576vygK9gJYr5pH61xQuZAQYcbwuoc9x6GPjklLg6rpNw7eBgoZrlMu9iGa94ZpCb4hsKJ4p6TBUhJ8/Hv367uKxmBFa5W5RegLKStN4gXp7izTibjiufwqgRbxBOVvO5mzcuPNjC1WfmKZwinhvzpUSVy8rR73GNnGGvs5up0WKWwmtun5URy9RNyqlHbS/9DYlp07MAF4cyM66x7xb8lihDT5m/LT/3kTiuaYmpmnXJ5rKRJ4SxVVe2yVbdn2vEn+ruUWBW8Tc/OMVLYJrr+JweSdGCyAWMvXsre8WHvhFLX40g+EJcV3VgTxR6dH9iSyuo/bdenT4RcSvq8d7826usRV3l4nQ+YTHTpom4qWI59Z69XchKHWoVK5mJSrtu9X6REIjrohouN1SKQoiIx0BWLJ+pygME5JJTmhjZ1xjAflMEsr2A0cWfeEDxu5EfOjYzI+vsP8SZWJj/906k8CIBEahT/hK/7C9UWKhtskG7gMhAY6X8edOUCna6ouB172dn9kPeA1fvYOqzMXnR+HL0bIJVp8EvyDqhgZtmnB586MhXSqseNEe13FWfaKw6sF1fVOLrXXFb0Hf5kSLtts/m71k8Xh58PLGpIsf3aW/0En+PH33D+p4m07zM3aaCilTurHYaqRoJ3lAdOvHgHROPVf4i7dcqQzJMfDwCMcYps0mT2VBOc01Hc+14gOEXMmC0OEW5ZXNuA4Bian4MSYyo5kDDYrWA7HKiU7Bry/eYUIzMVxM0xlduQDXj7Ya087h5bd8E/t5HTgAqCwrDdZSjZWZkEiPB6KbaB+XoQlhWDOqtswyjGtW1RVJaUOu6POc4jL/ZkonzRhiW0F8QBZi6KtjZjiSIlLd4V4acqZSzjKi60L0h3gjc6K5SnOaD9FBAaZUS8KrlxdrHMHMVJfSrZsNqkV+QLRgQuNQSIbdPqZCepRbX2CY7WhOs9fDd+E71+7DVfPVnLtdnr//oVfuq62GSAY5HY2R5WWYa8KEedW7b8LE0qO1y/jtIRMjyRwOpPW3t3S6QhPXHT3+vVQ0ul9dLwcqHmwQW/qMIXeKzrF6bb/tsEeVicljsXqZ/1576gNBs1ieBfTw8TdFRwiNGRi3oTSf9LBC4XU4C2otXPu1hMavZj5/fnJ6cnGCZvQfhAh4UA== +sidebar_class_name: "delete api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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` + +## 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/delete-non-employee-source.api.mdx b/docs/api/v3/delete-non-employee-source.api.mdx new file mode 100644 index 000000000..af957419f --- /dev/null +++ b/docs/api/v3/delete-non-employee-source.api.mdx @@ -0,0 +1,83 @@ +--- +id: delete-non-employee-source +sidebar_label: Delete Non-Employee Source +hide_title: true +hide_table_of_contents: true +api: eJztWltz27gV/isY9WGTjCnZ8m3tl47iOB3vOInrS/PgeCYQCUlISEALgE5Uj/97v3NAUqLkxGmatrsZvdgSCRx854rvQLjr2KlyMmhrTrLOYSdTuQrqtTXHxTS3M6UubOlS1dnoBDn2ncPrDt4l9UtxqkcqnaW5Eq+kkWNVKBM6NxsQ41OnpyQWQi8n2gunfi+VD+KTznMRlxFSGEhTtTTPa3XFOYZqpzDHQnJqTVCfg7Aj8V5n5tAo7w6jgPddAJtKJwt8cQTvrqNpxakME7wyeIFvUS70WwYWlRP8xsVFYYTgSrXR8elEFbJzeNcJsylLCU6bced+o6M+S0CmZ2pre293bz9Tv+6rnWyzf6D2Nofb6Xa6u5sNd/eyzv0NSfZTa7zyJKy/uUP/2jhe26ilCSIR2mQ6lQHqh4mam0164cs0Vd6PylwMy0CvnRIwrZlPD1YMaVIonVEZZFVCIoIuod/Z3FxFcJRrmn7snHXAcN4IGLVQDG02oxW1uZW5zsj81cokUk6nOUGHyN4HT3LvVs1ohx9UGshvjkIv6GiXTAWp8yObqVWTL7vtpTYqGTupCaFiyCkmCki81RlmiMLCMlEkxQ2pwOMI8Nx7sER3SzyXGUcc6XdUKQMzBSfTj5BFafEYoCujMV/UU4TOxAigvrCs2ldyuLd50N8Z7e1I2f91Z2t/d3gwktvbmwe7Bwe0egE/I5/8wtrSOTlbWfpvyiinU5HbFB75JwzilITtGQAvjik6qMI/7gOW8Q32v4RecWyjZoVXUKZuIK+fH52JnX2RSzMu+bkcLxnBJFcXlKJlnsshPaK0g+ZR8Bunx9o8BEWZsqA69OL45eDq9BJPzo//fnV8gU8ka6X4DEydUYCKWJjYT4y4UoDzCsUkDSrrimeV1GdQSBq/OFDHb37mYUzE1kiWecCMavUHZiyKFiNni1Yq1WXtie6q7gayFs8KGdKJGEqPCTam7rMBcn4aktPKks/ERMlMuaddMcgyTUrKXCAbIRTzZ5T+MsvmuT8qkcoAo8PEomgYGzRqbMsXc1O2vYEk0IFHnC46hZIDyB+Pk0EaSoCrq3eTDk20VBDripdVlmuju1yugjMTZAotZJ7PYEbnYGEuiDr4phBqsn0hTT2uqVj393O1uNy9imBeBMvvUln6b8i7sxzlJ2HVmhe3qko+T3U4ViP2Ru2mqiLhJanNk6tRjbvqxBcjrfJsnbvr3F3n7jfm7vLL84r1VG+Z+mytUp8rI0vY1/HmuUJ9GoZVD2J6UzlyQ8AgFUX67e0lEvujMjRefZ4Sl/yB/Chu5SvgB40/4vMh0Y/GWS1fEEC2Y9RghEqkskPGPUfMhoqm2l5d7aV1Q40ANQ9QRFRNJ2a2FBImc6UxhET6DZFZ5c0vQUwk6qNkBhsrIK1qsmRqtQlrJrlmkuvdaL0b/Ty70ZpJrnN3nbt/ztz9KpNsUHG2VDzJl0Uh3SxGWvWetJUCA5rzN9GkHLtqma2QMNFwrE6bOXSG/a3h1mg/VTuZ3Mn2tg9G/XSvL3f3t/a3hjv9/c7iXn89z+Mmydo5teDv6Ec2MUjcLXhcaRBcPlibtY//YF6nRlTWqPQ0vBk2h0lvGu7YP1jljpfW0iHxrGZIvsUhzdxGVNMwtqCxrh6LAVKMUReNQKnSwEWhpAsFKQ5BI3JdaE5e0gJy3SwZjAJUiYmyfBKK72leAiFXgtwSa7YILA0l1Yg4HyQwgx2jOv9Adlq56D9i8uKcND4ljcXx51QpSvSGue8+dL57AvCOasRFdPAXDnpjtyMNAgANQaxZDe9c8/M1P1/v8es9/ufY49f8fJ2769z9c+buv8HPKzb0ZX6OAd/MzzG2uykaLvWSgut/TtM5VSoEHN7Cpmnp+Li55uDMKxBK8ysdfFEiTPC9t3jnIol3I3zvrr4kcY+RsQuI+EqXY9IkhKk/7PXu4Da4674rp7qLagbPhZmxn7qpLXq32w8UIbotEBMOZSwrUz58HpydVK1Gl43tNMVzLH68QDQ9q0eRCxfwMfFX5dNtD/LpDJqIKGZDIPar2OLHgDlFY/GL59FdjqUVHaHblcvvH9PnH9tf0yMK+YIeD5nvq2thvADKJfUI/g25C/6HIPbXFfAcxao1KMnh1zeLYy6IpUeEKyPnOw91dv0VQG9oWF88V9KhhYg/djz57e3lUzEmbsq1ofREi5WmZgLZdYYw4to3qA/+aRJvR86W4wkrN2j9tEK5JkY5jCLemQulxPVJZajX2BTOUcXZ7DRJceGgWTdPau9l6lbltF9259am4NSZ6cGKPdma95T3Rm4itMHHgp9235lEvNBUsjTt8TSmUpF7QnE9rfWSC3p9L4i/1NKSKC1haf7pEopo2us0XtVJkfAkQuaerfXdi0d5yYI86rjwhKQuYyBLVDjaP4iltde+G0dLXkLy2jjembcTjY23PU3EOic89s08EycinVjr1V+FoNChVLkel8i074b1iRZNOCOS/uYCpCQumegENJLxnSIxTAwmOaRtnFmMBcEzWUzb9+xZ1IX3aLIz8b6lMz++xm5LIzOb+u/GTAsmtGAS64Sv8MfNjAILuU06cB2IAXA09z9XggroQl2Msh6s/Cy+x3No+0gBlaX46WH8cjgvgtUnwS9odDMGZZpYePMTIb6LShbtaC1j1ecHyxZcxZtbbKRLdot4m/Mr2lz/aPqSxoP5Mcsbk89+dJX+QiX549Td/1PFW1ean7HSVLyYwo2XrRqIxSCPjG710I9OpScKf/GWM5UJONobbtiYwyyKmeYyUExzTqcTrfi4YKpkIHa4QXFlC85DUGJKfjSFLGjsMAZJ68FY5VDnkNcVb9GPmRQmpl6MLlhA6gdbNWUXsPIZOUm8qB0HAlUUpcFcyrGyEBLh8Yh3M+3TMhYhtGZG1ZpZpnHNrDojKWzIFF3uSlzh34zoXBkt64ITH1kLPvTVoTIMSR6pbmvPFTlXOUcZjWtT9MdkI3KSicqn1A2igoJMqYUVXp1crkiEMFPdP7du3Ksm+R6NhRBqh2IwbHfRA9KjqfUBrWsLOd9qb92Qb+7Pt0Lqbn6Y/l++HV/tFTSmN6WTLIJexsYkNoTXnYcaQkw9bO7No3+YQFsae3dHBx/UHt3TY6Cmrvr6Zt79cBcCR9Bn9J8jpLn6ivpPKn2yp2LxOv6DuOtzOjObt+gdfPyoqLNv4KILBmA+gGEw8XU8olmYuPIjBvVJTdv84vj0+PIYVeNfRx096w== +sidebar_class_name: "delete api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Delete Non-Employee Source

+ + + + + +This request will delete a non-employee source. Requires role context of `idn:nesr:delete`. + +## 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/delete-oauth-client.api.mdx b/docs/api/v3/delete-oauth-client.api.mdx new file mode 100644 index 000000000..f17ae8256 --- /dev/null +++ b/docs/api/v3/delete-oauth-client.api.mdx @@ -0,0 +1,95 @@ +--- +id: delete-oauth-client +sidebar_label: Delete OAuth Client +hide_title: true +hide_table_of_contents: true +api: eJztW1tzEzsS/iuq2YcDVGwnjpMQv2yZELZyKhzYXJaHkCrkGdkWzEizkibEm8p/368leeyJEwIstedAzQvYM62+d+trRb5JdCkMd1KroywZJpnIhRNveOVmB7kUyiUbiRVpZaSbJ8OLm+TcCnOglRPXbgQiPEtsOdS0oJP6FcOCKz4VyeXt5Ubi+NQSzRsiZoGlTfAiEzY1siTBEHs2k5YF2ZZxxQJ54NeFCiU3vMBLY70SktaUHOI3EoUX+CYz0jSdiYInw5vEzUt6ap2RaprcbiRG/LuSRsBGZyqxLl80ZDLPTlzzosyJj5hsP5/sD7YHe2J/sLPbH++Mx88H/QHf2d3e38ueJ2SrEbbUygpLCvQ3B/RfU8wfmqXkOzIKOg02N9dpgo/YoTHasA47Ea4ySmRMTpiDlmSHsI6NdTZncJpUVzyXGTkpsiaWvCxzmfqw9j5a4nuz7hw9/ihSCnBpKAmcDJpnwnGZH+hMrDvyrt9eSSU6U8MlaSi8yikWMnC8khlWsEIbwQJLpoMJnq7b8C880d1iL3gGe4N9B9EYuMkZnn4CL0rQxxQ6VxLr2WIJ4sgmUOoBsWJP8PHu5n5/MNkdcN5/Ptja2xnvT/j29ub+zv4+SS+EtUhnuyKbG8Pna6L/IZQwMmW5ThGR/8AhRnD43ivghWOJdKKwj8fA8/gK/1PeBtrazKgvowrdYJy9OHjLBnss52pa+ed8escJqnN+SoVU5Tkf0yOqEFgeGL8xcirVfaoIVRVU2y8PX43Oj8/w5OTwn+eHp/hEvNaKfKSQrRmlJVRFLsz0Z69xNOAzt8yiBaROZF32LHJ9BoO4squEMnyzcwtnIrcmvModVkTp96xYZc0mRheNUkpDO2NPZFd0N9iYnhXcpTM25hYLEEIifzZKU1G6znH05DM2EzwT5mmXjbJMkpE8Z6hGMMX6ORgxnmVUuoHBpEIpQxnpZrpyTGknU9GMxdKVzWigCKTzFMerQaHigOaP58kodRWU82auVmGdLVHFGB/oHDzX1O5sxWnepXPleAoreJ7P4UZj4GE2hm3S2UWno3BZNB61oKs71u3t0izf7l4HZV467d+lvLJfUXdvc7SfjjetfnElYvEhDXTsRj4aizDFjoSXZLZfHKnqcC0Kn02kyLO2dtvabWv3K2v37suTiIziWw99ttahz7kiGKmN3zzXoI/x2aM0WxB5eBMDucHgkAiRfn93hsL+JBTRi+uSYN8PxEdhK19TflTHIzwfE/yog9WIBSno/RgsmKATiWzo9V5q7B0VXLW9Lu2VNmOJBFX3QER0TcPmumIcLjOVUqQJtxss08Kq3xybcfRHjoqwNnRAkqqyTqllgNstkmyRZLsbtbvRr7EbtUiyrd22dn/O2v0ikqy18tUScZKtioKbeci0+J6s5QwEbHFGx+qS86G6i1aIGasxVtJEDsm4vzXemuylYpDxQba7vT/pp7t9vrO3tbc1HvT3ktW9/mJZx3WRNWtqJd4hjt7FAHFXwHGVQnJZp3XWPP6De42YUFuj1lPjZvgcLr1cYsd7TyEdbANjYEfzwPHi+ckx8Ydoz578piuTCoLZwXUg585DSspheFpa10LHFjq220+7/fwy208LHdvabWv356zdb4KOg8eg4+AboOOAEcSaEMT6M6FjBtxB0GyCoMCGtIJ7FcHGEqbgUzx9jGXvuJkKVwO9Bors76+jyDOt2Wuu5guwZBsnkWrpLmpvoC2I1ixoQcDZFC1SMXQtCXRLWSULQZgU+cNyWUhfx2QQ+Jp5ZzRxsCrUzCLfailSpXkFDX1TyDWdvWrkmEQ6iQnBP3Dw56BTNOofeMYZo/U/nQezE7L4mCxmh9epEFTz9fnvzn23BI6gvKF2cRpi/cB1gXBmzhXGCHFdhvZVQ9AWqrdQvd3u2+3+19juW6je1m5buz9n7X4DVI9o6GGoDoKvhuqg7W6yGku9ouT6vyN2XypRA5/eTKceq2dLDO5xBVJpeUWX2ghdgB0mvdXLt7Z3I7PbhC7tEi4MKlUmB93MudIOe70bRAoRuu3yUnbRwBAsN1f6czfVRe9q+56+Q9dMQ42hc2VV6ueG0dujOGh0vX+NpBQO/c4LCN72FlGywuv+fsEX+dNlXgrjHDMIC2w2GNI9ppN/DDVLzBK/WU/d9emzZiNsOzf57WP2/Gv7S3YEJg/YcZ/7vigL9Axa3jGP1L9c3rE+JdAdpK/dtF5uJBTw/powf4G5z14IbjARhBswT35/d/aUTQlq+lKvLKFcIWk2QLG8RYr4VjZa3AahRX53Mbqazrzio8Z9GyodNslhMHuvToVgF0fRCX+gx5+gKXuX0iLh+wCtunyyiEwmrkRO21936UlKPJmpHjzU4411T/1W52cCqfCx8E+771WHvZTUgSRt2UQTTfQjHrsoF3bxFbu+V4m/Lbh1AreO52af3tEiuPYiXiBPUb/EgufWe+u7hQd+nRV+NEDhCXG9qwN5IurRvCWVLqL23Xo0+HWIX1OP9+rdTGIfbS5joW0xi20wz9gRS2daW/F3xih1qAwuphWq6LvV+kxCO6EF9jdXVOoEkR3ZASr0+h2jMFRIJj6mXdmDEh3OR3xJfvCRRc1/wMycsQ8Nm/3jC2yeRJnp1H63ziSwQwI7oQfYqH/YmyixUNtkg+8DIQEOlvH3nSAqutLzAq97u7pn3/NraGtIoarnYsth+DJcNrj4ifkXRF3ToAUTqK7vjeE7i7xog2o4a3EccNeD6/rmGvviHb8Ffes/atJe+VezlyweLU9N3qh8/qO79AOd5K/Td/+kjtd2ml+x00SYS+nmxcZ5YDXJA1pbP8OjQ+aZwL946yvV42lMK37+8hhmlU2Zc0c57Ws6nUnhp/9ScEfIb4PyShe+DgF3qfgx43lGUwMaFK0FGuVjmYNfl73DeKVSuJhGK7p1C64fdZyxTuHltxQk9nIROACooqgU1lKNVQXjSI9HoptJm1ahCWHSUmJhmfYwrl61qEhKG3JF1w8ZprBvJnRMjAl0JYiPyEIMbTwjhiMpIvGHdktDTkTus4zomvD7Md7InM5M5CUNd+igAFNiRcLro7M1jmCm4h8mtJn24iLbI1owoVEnJMN2FyMdPSq1dZhEG5rT4MRWf4p4N5dulofij/4mMbZ5wue9ks6USGoV5oUwml0kjdEMa4Yyox8/zqAbvb65oVMHGlRu6TGmbRppLy6Xc4if3+A2+ozhb4KivPvjxVWdn5zEnzk+9X83Wf9J471KL47L1Hw5KSf4+EnQgI11GEOhtD8B8QqFF+GMZGXJ2l8RaLKp59aXh8eHZ4dJAAr37ZPxA+xHJ/gv1/N1Pw== +sidebar_class_name: "delete api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Delete OAuth Client

+ + + + + +This deletes an OAuth client. + +## Request + +

Path Parameters

+ +No content. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/delete-password-sync-group.api.mdx b/docs/api/v3/delete-password-sync-group.api.mdx new file mode 100644 index 000000000..b88774560 --- /dev/null +++ b/docs/api/v3/delete-password-sync-group.api.mdx @@ -0,0 +1,83 @@ +--- +id: delete-password-sync-group +sidebar_label: Delete Password Sync Group by ID +hide_title: true +hide_table_of_contents: true +api: eJztW9ty2zgS/RUU92GSlCnZki+xXqYU20l5ykm8vkweHNcGIiEJCQlwAdCO1uV/39MASV0dZ7ypnZmUXmKJBBp9O43TEHIX6UIY7qRWx2nUi1KRCSdOubW32qTnE5W8Mbosoo3I8ZGNeldR/Y7RS+bf2uh6AzNtYmRBkiDnYiwt658esyDQMjcWzBYikUMpUlbUQiwJGZGQFuszp78IxW6lG7P3Z2/+1T98e/yO8dKNtZFuwiDSiH+X0kCC0yzhWQa5YaEWVLQiKWkg1LyLLq0wB1o58dX1IYFUl6nq1SvHtHLsV45zrvhI5EK53i3mi+j6HgYV3PAcuhvr5Ukyq+CQtBEpvMA3mdKiyVjkPOrdRW5S0FPrjFSj6H4jqpWNes6UYtlFgh0fMj1c5Q2yL7iODBNfeV5kJHz35cut4W53K+4O0p14u7PVjfeTvZ34pdjcSZKu6O6kaUTaG2ELraywpFlnc5v+zK//Dh4k/yjHYiZVKhNeB4oUF9axW26ZLZNEWDssMzYoHb02giKhptOh64AmudIohEaqSkjQoEWu2N7cXNbgIJM0/cgYbaDDWSNgOKfFQKc+9lLd8Eym5JBqZRLJiyIj1SGy/dmS3LvlmOjBZ5E4TCwM5buTwS+pcFxmBzoVy/FbDNdrqQTyhUvSUHiVE0xkkHgjU8xguYZngkiKKpngx81HEJ5obbFXPIW9wb6Dyhi4yRmefIEswuJjCl0qifmsnsJkyoZQ6oFlxZ7gg93N/c72cHeb887L7a29ncH+kHe7m/s7+/u0eo44Awh2Zm1uDJ8sLf1GKGFkwjINDMr/wCFGcPjeK+AXxxQAKbePx8DL+A7/E1zC2MbMSl9GGN9gnL06OGXbeyzjalT653y04AQVX54Tfsss4wN6RMCE5UHweyNHUq1SRagypwpyePS6f3lygSdnR/+8PDrHJ5K1VP76qkYUVEUujPWt17gywOMK6E6cSFvsRSX1BQziys4OlFXhnFg4E7k15GXmMKNafcWMWdFsaHQ+B6UkFET2TLZEawOoxbOcu2TMBtxigg7QfdEH5gsXn1SefMHGgqfCPEeRTlNJRvKMAY0QivkTgj9P0yn2hyWgLHwl1ygaSjuZLFSyqSvnowEQSOdHnMwGhcABzR/Pk37iSijnzZxFYZMtlYp1xUsrz81rd7FYBSfK8QRWYM+ZwI3GwMO+IEpnm0IoyffYTepxTcW6v5+a5cvd26DModP+XcJL+x24O81QfmJvWvPiRlTgs1SHQzXy0ajDVFUkvCSz/eRqVBOuGvgMm3OWrrG7xu4au9+J3cWXZxXrqd566rO1TH0uVUVrafNcoj4Nw6oHeXpTBXKDwSEVRfrtw0VFmjFefC2Ibf5AfhS28iXl+008wvMB0Y8mWHOxIAW9H4MFQ1Qikfa83lONvaOCq7rLq73WZiCRoGoFRUTVNGyiS8bhMlMqRZpwu8FSLaz6xbExR33knsGGCkirqjQutFRuzSTXTHK9G613o59nN1ozyTV219j9e2L3m0yy0cqjpeJJtsxzbiYh06r3ZC1nGNCcv7EGcj5Ui2yFhLGGY0XzzCEadLYGW8O9RGynfDvd7e4PO8luh+/sbe1tDbY7e9HsXn81xXEDsnlMzcQ7xNG7GCTuBjyuVEgu67RO54//4F4jhlTWqPQ0vBk+h0uvG+7Y2V/mjhdas7dcTWqGZOc4pJr6iGoaxuY01tRjMYCzEeqiYihVEnpRKslcQIpB0rBM5tKDl6yAXDOJ+0MHUwJQFk9C8T3JSmjoK0GmiTVrJJaEkWJInA8SPIMdoTr/QHZaheh/YvLsjCw+IYvZ0ddECAJ6w9x3Vp3vHkN5QzXiPAT4gYPe0O1whQRAQxBqVsM71/x8zc/Xe/x6j/859vg1P19jd43dvyd2/wA/r9jQw/wcA76bn2Nsa5M1XOo1Jdf/naZ7qFQa+PRmOklK44+baw7ueQVSaXqPhMoI3ZjoRe0V9y5s+06m9/7eBtHDoFlpMgwfO1fYXrt9h4AhUPctXsgW6hhi5iZK37YSnbdvuivKD90TCFBDAUvLxB8700WUsEjLu9lIyuRQ9vwCweneMMpZON8fEH9TPl0CoWhOdIlC58VsMGR9lVX+MdQs0FL8Yv3ols+iJRth26XJ7h+z5/fut+wIQh6wY5X7vrkWxjNouWAeqX89vWZzTtw7rL502Wa6n1C/1lla7D0N67BXghs0BuEnjGe/fbh4zkbEOD3iS0tkV0hqEYCZU6SIr2j9+jifJvlNBtk0GnvF+3M/mBCC2DCDweyjOheCXR1XTniHUn+G2uxdSpOELwc06/pZHZlU3IiMdsHW1JOUeDJVbXiozefmPfc7nm8NpMLH3D9tfVQxO5RUiCTt3DSmMtF3euyqqO3iM3Y9VYl/1NLiIC320uzzBS2Ca6+ScAEnAYxJBM+s99aTFw/y4hl51EfhCUld1IE8Uekx/zNXUkftyXrMyYtJ3rweH9WHscR2Oj+NherFLHbDLGXHLBlrbcWvjFHqEAyuRiVQ9GS1bmnR2CMi7mzOqBSHJWMZgxx6/U4ADBWSiQ9oc/bcRIO2qTRA8pOPLDD/Ca1zyj7N2ewfX2EPpZGpTuyTdaYFY1owDjXAVvqHLYoSC9gmG3wdCAlwMI2/rwSVojM1L8haWdW9+Laf42/XQVUvxRa98KU3LXDVJ+Zf0OhmDEowcevmhz+6KljJon1qzln1qcCiB5f1zTS2xwW/BX2bUynaMv9q9pLF/enhyXuVTX50lX6gkvx16u6fVPHWleZnrDQV26V088tWbcFskge2tnyUR2fNY4F/8dYj1dNqNC3h2jNxmFkxRcYd5bTHdDKWwh8CFII7Yn4blFc69zgE3SXwo9XzgkYGYwBaCzbKBzKDvBb7gC5LJXAxdVh0bQJSP+uq1TqHl08pSOywDhwIVJ6Xiu5eQ4kyZxzp8Uh0U2mTMhQhNFxK1JZpT+OaWTUiKW3IFS3fa5jcvh/SaTEa0ZkgPrIWYmiro2I4kiJSXdCeGnImMp9lNG6efj8mG5kTj0VWUI+HCgoyJWZWeHt8sSQRwpSFXeiltRm1q0m2TWMhhFqdkAzdFjo7elRo69CQzmlO/RNbcdmeDSbs+HAxse6mB+V/zt37aiOhDqBd0OEV2VWGjiT0gFfRqh4QU3sypf9AMIYTaNTdHZ1yUEd0T4/R3VMLfXU9bXh8o4j40Gc0m0Ogf/F2/aw/np1Vij9nf+DO/UqD6jM7NZm26xE+fhHU5Uu6eo9R4RjGaxlehIOamSlLP2VQX9U0z4dHJ0cXR1GgKat26eoDnII69F9Kd3Dk +sidebar_class_name: "delete api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/delete-personal-access-token.api.mdx b/docs/api/v3/delete-personal-access-token.api.mdx new file mode 100644 index 000000000..be3a011b9 --- /dev/null +++ b/docs/api/v3/delete-personal-access-token.api.mdx @@ -0,0 +1,95 @@ +--- +id: delete-personal-access-token +sidebar_label: Delete Personal Access Token +hide_title: true +hide_table_of_contents: true +api: eJztW11z0zoa/isa78UBJh9tmrY0NzuhlJ2eKQe2H8tF6QyKrSQCW/JKcmm20/++zyvZTtykFFhmz4HxDaS29Op5P/W8inIb6VwY7qRWx0k0ihKRCifeCmO14uk4joW15/qTUFEnsiIujHSLaHR5G11YYQ61cuLGjQs3x7PI5qNs0c3LuV3uJ3cdzbajjCs+EyQlH/E0fWTY1d1VJ3J8ZkluhYYFOMzjsRFGJMLGRuaEHtjP59KyoIBlnFUrsLAC8yv0gCDnhmcYZKzXRNLcnEOHTqTwAn/JhIDGc5HxaHQbuUVOT60zUs2iu05kxL8LaQQM5kwh1nGIzYszL1fc8CxPSaCY7jyfHgx3hvviYLi7N5jsTibPh4Mh393bOdhPnkdkBSNsrpUVlpAMtob0X3O9PzSLyRPK9QjccGtrfcxhKvGeHRmjDeuyU+EKo0TC5JQ5wCWFhHVsopMFgxWluuapTMhapWgSyfM8lbEPlv5HS3Jv162kJx9F7MjMhkLLyYA8EY7L9FAnYt2i9w34SirRnRkuCaHwkGNMZJB4LRPMYJk2ggWRTAcV/Lhew76wRG+bveAJ9A36HZbKwEzO8PgTZFHYPwboQknMZ9UU+JFNAeqBZcW+4JO9rYPBcLo35HzwfLi9vzs5mPKdna2D3YMDWj1DUCDQ7cra3Bi+WFv6H0IJI2OW6hge+Q8MYgSH7T0AvzimSCcy+7gPvIyvsD8FcBhbq1niZZTvHSTXi8O3bLjPUq5mhX/OZ/eMoLoXZ5RRRZryCT2iVIHmQfAbI2dSbYIiVJFR1r88ejW+ODnHk9Ojf14cneETyVrL+jHSSiUUloCKWJjrzx5xqcBnbplFTYidSHrsWSn1GRTiyq4OlOEvu7AwJmJryovUYUa5+oYZq6LZ1OiskUpxKI7sieyJXodN6FnGXTxnE24xAS6k4c+oqOWue1Ja8hmbC54I87THxkkiSUlUEWQjhGL+AoIYTxJK3SBgWiCVAUa6uS4cU9rJWDR9sTRl0xtIAun8iJNVp1ByAPnjcTKOXQFwXs3VLKyjpYRY+geYg+Wa6M5XjOZNulCOx9AC28QCZjQGFmYT6CadrSoducui8KhqXF2x7u6Wavly9zqAeem0fxfzwn5F3r1NUX66XrX6xbUok4/qeVmNvDcqN5UVCS9JbT+5HFW7q0p8NpUiTdrcbXO3zd2vzN37L09LZlS+9dRne536XCgOgqqN3zzXqI/x0aM0qwZ5elM6ssNgkJIi/f7uvGJxlombnPjfD+RHYStfAz+u/RGeT4h+1M5q+IIAejsGDaaoRCIZedxLxN5QwVQ766u90mYiEaBqA0VE1TRsoQvGYTJTKEVIuO2wRAurfnNszlEfa7qLObSqSrq5lsRMWybZMsl2N2p3o19lN2qZZJu7be7+nLn7RSZZo/LZUvIkW2QZN4sQaeV70pYzDGDVGR2rU8676j5bIWGs5lhRkzlEk8H2ZHu6H4thwofJ3s7BdBDvDfju/vb+9mQ42I9W9/rLZR7XSdbMqRV/Bz96E4PEXYPHFQrBZZ3WSfP4D+Y1YkpljUpPzZthc5j0askdN55COugGweCO5oHjxYvTE5KPpb14spsuTCyIZgfTYTh3nlJSDMPS0rqWOrbUsd1+2u3nl9l+WurY5m6buz9n7n4TdRw+Rh2H30Adh4wo1pQo1p9JHRPwDqJmUzgFOsQFzKuINuZQBZ/K08cy7R03M+FqotdgkYODdRZ5rjV7zdWiIku2cRKpluai8oaxGY011VgM4GyGEqnoC3gJdktRJTNBnBTxw1KZSZ/HpBDkmkV3PHXQKuRMFW/1KlLFaQGEviikms5eNWJMIpzElOgfJPhz0BkK9Q884yy99T+dB7NT0viENGZHN7EQlPP1+e/uplsCxwBvqFycBV8/cF0gnJlzhTZC3OShfNUUtKXqLVVvt/t2u/81tvuWqre52+buz5m730DVSzb0MFXHgK+m6hjb22I1l3pFwfV/Z+w+VUoEPryZjj1XT5Yc3PMKhNLy4i+VEboJO4r6my/o9m9lchfRXWAiiAFbYVJMmDuX21G/fwuXwVV3PZ7LHioZvOYWSn/uxTrrX+9sKEB03zQkG0pYUsS+gRi/PS47jp43tJEUy6Hw+QWC2b1qFLUwv79o8EX5dL2X/LlAM8KCmA5D3Jdx5R8DZo6m4jfrR/d8HK3pCN0uTHr3mD7/2vmSHkHIA3psMt8X18J4BpT31CP4V8ur22fEvsPqaxe4lzsKnfsP1hZ7Q8MG7IXgBq1BuArz5Pd350/ZjDinz/nCEt0VkpoEZM39m9thkt9mjC5mcw983Lh4QznEpikUZu/VmRDs8rg0wh8o9qeozt6kNEn4gkCzrp5UnknEtUhpH+wtLUmBJxPVh4X6vDHvqd/zfHMgFT5m/mnvveqyl5JKkaS9m8aUKvpej11uvN39vSD+tjnTnt5DEUx7GYeL3DESmUTw1HprfffiQV53RR51UnhCUu9jIEuUOJrXpeLKa9+NoyGvS/KaON6rd3OJDbU5jYX6xSz2wzRhxyyea23F3xmj0KE0uJwVyKLvhvWZFu36jOgOtlYgdcOSXdkFPfT4TpAYKgQTn9D27NmJDgclPiU/eM8i5z+geU7Yh4bO/vEldlEamejYfjdmWrBLC3ZDDbAl/rBJUWAht0kHXwdCABwu/e8rQQl0peYFWRuruhffd9XPRGJA9VJsPgp/jJYFrvzE/IuoszIGJZjYdX2BDH+zUhbtVA1jVecC9y24jjfV2CDv2S3grb/dpE3zr6YvaTxeHp+8UeniR1fpByrJX6fu/kkVr600v2KlKfkuhZtftmwMVoM8sLX1wzw6bZ4L/Iu3PlM9sUbb4hsxz2FWxeQpdxTTPqfjuRT+GCAX3BHz61Bc6cznIeguJT+aPS9oZjAGSWvBRvlEppDXY+/QZ6kYJqYei67fQupHXTZbZ7DyW3ISe1k5DgQqywqFuZRjRcY4wuMR7ybSxkUoQmi5lKg0057G1bOqjKSwIVP0fLdhMvtmSufFaEVXnPjIWvChLQ+LYUjySPnTu6UipyL1UUbjmvT7MdmInO5cpDl1eaigIFNiZYXXx+drEiFMld9QaDPrl5Nsn8ZCCLU6IRh2eujt6FGurUNL2kBOHdQa561+PdkIqtvlMflX/2yxrPtE2Ps5nTYRjCI0EKFpu4w2U0lMHsmEfjA5B2oad3tLBxPUwtzRYzTk1PVeXi07FN/ZwaD0Gf3hFOl6/4eOq0o8OS1/EvnUf7XyhZ8/blSjOlpTi2VXHeHjJ0HNOOahZQV6f1rikYUX4TxlZcraNw7U/NQ97sujk6PzoyhwiU1bafkBhkCx+C+kdqfQ +sidebar_class_name: "delete api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Delete Personal Access Token

+ + + + + +This deletes a personal access token. + +## Request + +

Path Parameters

+ +No content. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/delete-provisioning-policy.api.mdx b/docs/api/v3/delete-provisioning-policy.api.mdx new file mode 100644 index 000000000..0a5c5a8e4 --- /dev/null +++ b/docs/api/v3/delete-provisioning-policy.api.mdx @@ -0,0 +1,96 @@ +--- +id: delete-provisioning-policy +sidebar_label: Delete Provisioning Policy by UsageType +hide_title: true +hide_table_of_contents: true +api: eJztXGtTGzkW/Ssq74c8yjZgTAj+suWAk/UsARbMpqaAmpG7ZVszbamn1Q3xUvz3PVeS+4FNIGxqZybTValK0y1d3fc9V271bUPHIuGp1GoYNnqNUEQiFSeJvpYG96SanuhIBotGs5HyqWn0LhpnOksCYRpXTYw2QSJjmo25B3auYelMsLhEgcWWBLuR6cw+NLEI5ESKkGWGTwXTinH8i2MMs6y0L1WfpfpXodyk/smwyXTCjk8//NQ/+Dg8YjxLZzqR6YJJwxLxWyYTkEs1C3gUYRHcxaQ22DYiyGggWL9tnBuR7GuVis9pHxRIHBmqXpnbluO2N+cKvDWu7iBnzBM+h2yJsVQkSRtzzG82FB7gL2OVAhU2G0tuGr00yQQYCGZizhu920a6iO3YNME6jbv7+htBNU65bHhArIvPfB5HNKUT7G293Xy7vRNu7W3xt282t3bCztvuzs64yzvbnT0QW8uW1e+Ill3la3Vx4o/pyVrjWUptdqmGig1DoVKo9EjfNBlnTnZoXjGTxbFOUnbNE6kzU6WUe5pps/ewphevyW5mMDRnv2ipREIG5WHorLkk3nQmnfMFg/KmUwwbazjG/umgPxrAe0J2fnJAlw+uyAY8mHmHs4KCXoAnMhTkOnyd1JjVL4s349cCiy2YyuZj8ABdwZ/NOneXCIRQTCBRSFob2WE8ETYAAj2fw+kLZkwPY7wwLTYiWUucJiLiNrA0e7GfCFyzfhDoTKUMkTqRkXjRXI26VEC7NHYCXdNT7ueAzBg8WELhPVNYNd/oLAppTGagGZqeG4dC1WsEyrlUXutf5vk8Dp/Ls5/7gkylRJDi9oNu9BDvYDmF14wz0DULFVSEuFSDo/67w8dEGCg+jr6F2oUltFbtwZPUjuvAeZF79sLkKxCNpVUv1cHw7AmCHUjzjSQLHaUniObjPRIIp8Ql8Lm+pojHCjpB7ogWbJLoecnXLtWPOrNBCBI+6iZ4Vg4ipzPk/wU9WJfFlBAh3KaSW13YNR5O1MimWRSRbI3ehEcGuVMgAVDxyOe6OMCF8yZcePXT1eBwYJ/1z86GH45o9FF+6Sj89OH0+Pwkp5P/6abmf54OPgzPRoPTYt7wYHA0Go5+LKaW7gwOhqOC8tHh8f4/aeY/+kcfBj+dgIVPx6cHVMfXKKOuDnV1qKtDXR3+mtUB+cumw/McP99RH5AIE8Oz0PygSHQ2u/RfNVEeafLFFBkQmpUqpIbGt0SEv4VJ2Q03yIQBWigzySIGx6PHiU05qpju1JaINEuQJUDLE3EctKl96G5urnKwH0maPkgSiNtipzmBSYWLsQ5t7yTVNY9kSO2GX5lIlnqxjV8M0b1dLY96/AtiDhOhS0RdKp1eQpFyGe3rUKwrpVVm38NHW9OEUyJkwrIcYKKzTkimmWtoxpH0CdWNq/ZH0ER7i73jIeR18u17YaCmNOHBr6BFDe5jDJ0riflsOYXJMPfnNcuKXcHHbzb3Ot3Jmy7n6Mi2dnfGexO+vb25t7NHbVljDjvDiUxpbZ4kfLGy9AeBeJUBizR6WPkfKATRCt1bBuzimCIRBOZxG1gaT9A/1XU3NhfT88uoR6b6/W7/hHV3WcTVNLP3+fSeElTr/KwCkqi/hOSO8DEqslTrWFmCqIPB+/754cjim3+dD85wRbRW9hf6ahlR2hbXmb6xHHsBbFyJCOqgLPPaU30Ngbgy5YHS/WUWBsqkMsyzKMUMv/qaGWXSLvWUQylwGwrspWyLdhNRi3tzngJPjDklNO1C9zWSqIjT1qHX5Gs2Exzw4lWb9cNQkpA8AjaKQNRiGYS/gzo+9icZQlnYHRGNpKF0KpH7KrYoVFm1RpHRDstGoeAA54/7ST9IMzBnxSxHYe4tnsVlxgu95qrcje5nwYVKeQApkJUXUGOSQMM2IcrU5IlQku7nXC3H5Rnr7q4Qy6a7j46Zg1TbZwHPzBPi7iRC+mlZ0fIH18IHny2DLhtZayzN5DMSHpLYdrIflZtrGfhsIkUU1rFbx24du0+M3fsPTz3q8U8t9NlahT7nym8LU/FcgT45wloOsvDGG9JuL3uI9MOnkd98xnjxOaZN02+Ij1wpX2G+n9vD3R9bUL00VsUWxKDVo5Nggkwkwp7lu+DYKsqpant1NYDwsYSDqjUQEVkzIZBsG9IkUxYic9NkoRZGvUh9o2sRrMuAtKoKWzFajrRGkjWSrKtRXY2+n2pUI8k6duvY/XPG7heRZM6VjRaPk0w2n/Nk4TzNPydpOcOAfP+N5SFnTXUfrRAxlmOsRhU5NMadrfHWZDcQ3ZB3wzfbe5NO8KbDd3a3drfG3c5uo1zrL4o4zoOsGlMlezs7WhUDxNH+aabgXCbVOqxu/0G9iZhQWrO/pCxxM3QOlV4V2HHtHmcK2UAY2DF5YHvx/PSQ6GNp90MN9Ob3pxOvOgznqYWU5MPQtDRpDR1r6FiXn7r8fDflp4aOdezWsfvnjN2vgo7dx6Bj9yugY5cRxJoQxPo9oWMI3EHQbAKjQIYgg3oVwcYYouDK7z76sE95MhVpDvQqKLKzt4oiR1qzj/S2jAdLprITqQp1UXrD2DmNTZZjJb0iMEWKVAxZSwLdklfJuSBMSm8hRHIubRyTQKCbLFr9SQqpXMzc/z0dfwdRBg5tUog07b1q+JiEO4kJwT9QsPugUyTqb7jH6a31P+0Hs1OS+JAkZoPPgRAU8/n+7866twSGYD6hdHHmbP3A6wJuz5xeq1Dic+zSVw5Ba6heQ/W63Nfl/vso9zVUr2O3jt0/Z+x+BVT3aOhhqI4BT4bqGNveZDmWek/O9X9H7DZUPAfWvZkOLFYPCwxucQVcqTjiR2mEjor1GhsOsJuN2+UhtruN1QNxkgbkx8nuGnSwjpCjYzpLIlCapWlsehsbt7AlbHjX5rFsS38cQOmbdqDnG9fbazITvYiaHxwMs8B2Fv2ToW9F2tYCiSQndxnRLuDsYWUmd4Zd7BsIX6RPB+PI0PYlYEemSe8He4ezt8FmjG7jhbGj29bBVmSEbOdJdPeYPP/e/pIcjsgDcqxT3xfXwngGLu+JR+xfFecgzwiWu9VXTkMWpYZ+EOisLHZMwzrsneAJegb3jszLHz6NXrEpgVGbDDJDOFhI6h4QTidwEZvs+sv3RWiSrT+JzqbuQGi/8kYOBRebRBCYXaozIdhF6UgJO0XatiqlScJmCpp19XJpmVBci4gKZLvQJDmeDNUGNLTBK/Ne2WJouwapcDlfHkBtsQNJOYqOEtgxXkTbBLKLeCkXL8n1XCb+tqTWctRalpp5dY8Lp9qLwL3hHSDCiQSPjNXWsxd39FoletRi4Q5Rvc8DacLzUX2PKlha7dl8VOi1iF6Vj0v1aSZRaavTmEtszMzsKYIhC2ZaG/F3xsh1KAwuphmi6Nls3dCiLRsRrc5miaWWW7IlW8CNlr9DBIZyzsTHVLctbNFuB8WG5M/Wsoj5n+2xpJ8rMtvbFyivNDLUgXk2z7RgixZsuRxgPP+uepFjIbZJBpsHnAPsF/a3mcAzWsp5jtbarG7Jb9g5VBoCsGqpmLjn/ugVCc5fMfuARudjkIIJdudvltFpDU+LSlhFWcsNg/saXOU30qic9/Tm+M1/9qRq+keTlyTuF/sqxypafOss/UAm+ePk3d8p49WZ5nvMNB4Ik7vZZX3HUHZyh9ZWd/nyQ2V4aiPVIm70M8VHLcpk6CAc+bSN6WAmhd0fiAVPCfk1ya/03MYh4C4FP7pAS2hqD+glYJijo5MR6LXZJzoXGEDF1HzRe7mgSqf77LJn0PIJGYkdLA0HADWfZ4o+jgEmsjnjcI9HrBtKE2QuCfmzlI4hbWFcPmsZkeQ2pIq2bUOSuTme0EYyetSSER9ZCzY0fhcZiiSL+I9WFIKc0lFESgQYV4Xfj9GG57RmIoqp/UMGBZgSpRU+DkcrFEFM+Z8udDLd8JPMBo0FEWp1nDNst9H00a1YmxS9aoVzaq1Y+fMpzH0/hY0XrDhMeM+/bout9D/oR1R8waFOYSOm/S+SP3Odi2sjL/wnUMhUvdLXUNZ2kjSm+DQJmpMZVEk0bm9pG4X6qju6/VsmqEe/uCraJttuLg+T5ufxH1Tny1Mv1iv7Q1Dl8yprhVpu/alF0fU3cPmroM2CXDBqCJ/NRX2Svj5JX5+kr0/S/yVO0n99ki0qw90VBrudc5v33XO3t16aufLrM+135fud+edX+APdk79AmQE+/C//cvi3 +sidebar_class_name: "delete api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/delete-role.api.mdx b/docs/api/v3/delete-role.api.mdx new file mode 100644 index 000000000..83c476040 --- /dev/null +++ b/docs/api/v3/delete-role.api.mdx @@ -0,0 +1,84 @@ +--- +id: delete-role +sidebar_label: Delete a Role +hide_title: true +hide_table_of_contents: true +api: eJztW1tz27gV/isY9mGTjElZshPHfukotrPjHSd2fWkeHE8DkZCEhAS4AOhE9fi/9zsASYmSHadp2u5m9OCEIg4Ozh3fgaDbSJfCcCe1OsqivSgTuXDiTOci2ogcn9ho7yqijza63sCoTY0siRq0F1Np2fD0iIVJlnFGlGw0Y9JZdnSQvFdD5vQnodhn6aZEu8FOzn79x/DgzdHbDXZ2cnzYPGsTPp5fvvJvGK/cVBvpwMwyI36vpBEZuLGU5zlz9doJO1KMZ5kkmTYgwcJyD/Er+Ixplc+6nJgcM/o8TFNhLTs1eiyhNpMqzasMS0sFWhFU5AZ/1upUchekOteVwcSwcsEVn4hCKMc+a/NpYnRVWqbH7PNUptPApiOcJOMVohgJk8DwJTe8gEkNmf82kmTtkrsphhQG8ElmeG6sEu05U4mNyKZTUfBo7zZys5KorDNSTaK7Zc8dHZAwjTbgJL7wosxpyiDd7b/cfMl3Xva3Nnc3+WYfT9v9QV/g73n/ZXR3TQvbUiuLoMBag81t+q+7wlv4SStHFohhuUymnCKEliSphYVluGW28tYeVzkbVY6GYVgYQ82nw7YjmuQqo+ZeaCRISLntzc1VCfZzSdMPjUFoxeysZTDuSDHSmY8wqW54LjOyfr0yseRlmZPoYNn7aInv7aqV9eijSB25zVAyORnskgnHZb6vM7HqkWWHvJZKxBPDJUkovMgpJjJwvJEZZrBCwzKBZeM7T5d0vAdLJH32imfQN+i3XysDMznD00/gRYn+mECXSmI+a6YwmbExhHpgWbEj+OjF5u5ge/xim/PBy+3+zvPR7phvIYae7+7S6gX8jKSwC2tzY/hsZelfhRJGpizXyE/5TxjECA7bewH84pginSjs4z7wPL7B/hfQK9C2atbyMie+OCosr/ZP2fYOy7maVP49nywZQcWX55ShVZ7zEb2irITmgfGJkROp7hNFqKqgMntw+Hp4eXyBN2eHf7s8PMcT8Vqpu0PVZBRERSxM9Wcvca2AzytU5BSVKWHPaq7PoBBXdpFQhk92ZmFMxNaYV7nDjHr1e2YssmZjo4tOKvm8+eLYE5mIZANZi3cFdyh4I24xQYfUfUYVtnTxcW3JZ2wqeCbM04QN60LOc4ZsBFNfq5H+qPDz3B9XSGXhK61G0VDayVR0fTE3ZdcbSALpPMXxolMoOSD543EyTF0F4byai1nYRkstYlPxstpyXekulqvgTDmeQgvsP9iVtDGwsC+ItI82hVCS7bGzNHRtxbq7m6vly92bIMyB034s5ZX9hrw7zVF+Yq9aO3Aj6uSzVIdDNRLtfgtL1BUJg6S2n1xTte5qEp+Npcizde6uc3edu9+Yu8uDZzXqqUc99OmvQp9LVYNd2jxXoE+LsBoiD29qR3ogXkOk395d1HAa9OJLSVDzB+KjsJWvCD9s/RHejwh+tM7q+IIE9HYMGoxRiUS25+WeS+wNFUy1tbraa21GEgGq7oGIqJqGzXTl0b6plCJJuN1gmRZW/eLYlKM+8tAv+ApIq6osLrVUbo0k10hyvRutd6OfZzdaI8l17q5z98+Zu19Fkq1UPltqnGSrouBmFiKtHidtOQNBe/7G2pTzrlpGK8SMtRgr6iKHaDToj/rjnVRsZ3w7e7G1Ox6kLwb8+U5/pz/aHuxEi3v91TyP2yTr5tSCv4MfvYkB4m6A4yqF4LJO66x7/AfzGjGmskalp8XNsDlMet1ix8HuKna80Jq94WrWICTbwZBqbiOqaaAtiNY0tCDgbIK6qBhKlYRcFEqyEOBiEDQsl4X0yUtagK+ZxcOxgyohUZZPQpuDausrQa4JNWsEloSSYkyYDxw8gp2gOv9AdFq76D9C8uyMND4mjdnhl1QISvQWuT+/73z3CMIbqhHnwcEPHPSGbocrBAAaglCzWty5xudrfL7e49d7/M+xx6/x+Tp317n758zdfwOf12joYXwOgm/G56BNNlmLpV5TcP3PYbpPlVoCH95Mp2ll/HFzg8FhBCvwUrqZX+QSuH4/hPIQoJ0yU2Zqz+hcxJUCcEs/iWwvXMSgStSMLY1c03WGQiBG57df/AUMYhn1aIrt3crsLqL1CWgGHSuTY3zqXGn3er1buB4uv0t4KRNURHjfzZT+nKS66N1s3VPI6MZBSFqUwqxK/QE23UIJiyTeYUZSToQC6hcI7vMmouiHG/1R81f504URiouZrlAyPZsNhvyp49O/hpglmpNfrKdOfDyu6AjdLk1+95g+f9/6mh6ByQN63Ge+r64FegYpl9Qj8a/n4XJOKD6svhI0852JOr/BymInRDZgrwQ3aDHClyFPfnt38ZRNCLv62lFZgs1CUrOB7DtFiPjaOGy+GKBJfrsyupqE2z/DzlcvlItsnENh9l6dC8GujmojvMWmcYYq701Kk4QvLDTr+knjmUzciJz202RuSQo8xHwPFurxzrynfu/0TYZUeCz82+S9itmBpJImCQMQTa2i7xnZVdnoxRf0+l4h/tJwiwO32HOzT5ekCKa9SsNVnhQFgVjw3HprfffigV+8wI86MrwhrssykCVqObpfmKWN175bjg6/mPh15Xiv3vn7Yt1pLJQrZrGv5hk7YulUayv+yhiFDqXB1aRCFn23WP6SWuwzIh5sLogUhyVjGQNmevmOkRgqBBMf0TbvUY4GAFRZSMkP3rPI+Q9owjP2oaOzf32F3ZgoM53a75aZFoxpwTjUAFvLHzY7CizkNung60AIgP25/30lqAVdqHmB171V3bPv+Tm0NaQQ1XOx5V74sDcvcPUT8wNE3dKgBBNKb79CpAuINS/a8TrGas4Xli24Km+usdEu2S3I255v0eb7R9OXNB7Oj2FOVD770VX6gUryx6m7/6eKt640P2OlqXEzhZtftm4wFoM8oLXVQ0E6tZ4K/ItRn6keoKP9CRecCcMssilz7iimfU6nUyn8cUIpuCPkt0FxpQufh4C7lPzNTemJAQ2S1gKN8pHMwS9h79CvqRQmpl6NLmCA60ddN23nsPIpOYkdNI4DgCqKStHdbghRFYwjPB7xbiZtWoUihNZNiUYz7WFcO6vJSAobMkXiuxZT2JMxnTujpV1w4iNrwYe2PnSGIckj9WXuuSJnIvdRRnRd+P0Yb0ROPBV5Sd0iKijAlFhY4c3RxQpHMFPW31pPtJn06km2R7RgQq1OCIatBD0ivSq1deibOpJTw1Rf/F+Ootv5+fr6twL/td8K1Fsj9TS9kg72yFNV6LFCG3sV+TYWtHsyo59xTOFHen17S0c+1NTd0evfK0HnCVfX857N97oIMXpGgzxGARNf8fKTs9r2T9nKTwzulbM5plSz+QlFhMdPgg42IC3af8jrT568LGEgnE0tTFn59qbT1h8cHh9eHEYBT90HJ+oHqI6C+S85eNkC +sidebar_class_name: "delete api-method" +info_path: docs/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 Role' (delete-role)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/delete-saved-search.api.mdx b/docs/api/v3/delete-saved-search.api.mdx new file mode 100644 index 000000000..e027fe15c --- /dev/null +++ b/docs/api/v3/delete-saved-search.api.mdx @@ -0,0 +1,96 @@ +--- +id: delete-saved-search +sidebar_label: Delete document by ID +hide_title: true +hide_table_of_contents: true +api: eJztW1tT20oS/itT2oeTpLANxkDgZcsJZItT5CTLZfNAqMpYGtuTSCOtZkTwUvz3/bpnLFs2hCSb2nOS0hNG6u7p+3w9Ht9GTk5sdHAZnclrlYgzJct4Gl1tRImycakLp3MTHUSHKlVOWeGmSthCxXqsQW2ZxzJP972JNqK8UKUknuMEXAlzseQgeCMqZCkzPC1p1dtIk/RCOnpl8AL/6SRaXf74UORjXrxU/66UdVg2yeMqU8Z1QW3jqcpkdHAbuVlBMqwrtZlEdxsRMehSQR1XVmojUjcyK1Ki6cf7W883n+/sPo93+vvx7uYWPsVyd7y/GW9tb21Hd1fEbovcWGVJeH9zQH+auv2Ri5e5cdBEdMSxSXQs554KyorP0gpbxbGydlylYlQ5el0qoa0wuYgDu8vFiJhcVRoYqE0Q4jXokjWDzc11DV6mmtiPyjIvocNpLaDhMjHKkxmtqM21THVCfgsrk0hZFCmpDpG9j5bk3q67NR99VLGjKJYUaae9XxLlpE5f5olaD8FqKF9pozqTUmrSULHKMRgFJF7rBBwiy+EZL3IedaYjhRfRgye6W+KFTGCvty9EgdzkShl/gizKwscUujAa/GLOInQixlDqgWXVnpKj3c39/mC8O5Cy/3ywtbcz2h/L7e3N/Z39fVo9Q5zlxLsmrC3LUs7Wlv6HMqrUsUjzGBH5DxxSKgnfswK8OFi0U5l9PAYs4yv8fw67PG1tZtBXOHXjNoQUL16+FYM9kUozqfi5nKw4wXQuzqhgqzSVI3pEtQXLveA3pZ5oc58qylQZNZvDo1fDi5NzPDk9+ufF0Rk+kay1tjM0yFauKKiKXJjmn1njYADXFXpMjH7QFc+C1GcwSBq7TKhD55qhc2TIrbGsUgeOsPo9HMuixbjMs0Ypcd3cOPFEd1V3A1WLZ5l08VSMpAVD7kv32RA1X7jOSfDkMzFVMlHl064YJokmI2UqUI0QCv4Zlb9MkkXtjyuUMpTRbpqjaZjc6Vg1Y7FwZTMaKALtmOJkOShUHND88TwZxq6CcmzmchXW2RJUDPGBzt5zTe3OV7vgzDgZwwqZpjO4sSzhYW6I2tm6EWryfSbNnK7uWHd3C7O43b32yhy6nN/FsrJfUXdvU7SfDptWv7hWofgs9WHfjTga8zCFjoSXZDYzB6o6XPPCF9gd06St3bZ229r9ytpdfXkaUE94y9Bnax36XBhZwb8lb55r0KdGWHMihjchkBsCDgkQ6fd35yjsT8oQvbopCDD+QHzkt/I15Yd1PPzzEcGPOliNWJCC7EdvwRidSCUHrPdCY3aUd9X2+mqv8nKkkaDmHoiIrlmKWV4JCZeVlTGkibQbANnKmt+cmALDC8kI1ndAWtUknSLXHoG3SLJFku1u1O5Gv8Zu1CLJtnbb2v05a/eLSLLWiqsl4CRbZZksZz7TwnuyVgoQ1Odvoi45DtUqWiFhosZYURM5RKP+1mhrvBerQSIHye72/rgf7/blzt7W3tZo0N+Llvf6y0Ud10XWrKmlePs4sosB4q6B4yqD5LIuz5Pm8R/cW6oxtTVqPTVuhs/h0qsFdrz3jNPBNggGdiwfOF68OD0h+ViaxZPf8qqMFcFs7zqQS8eQknIYntbWtdCxhY7t9tNuP7/M9tNCx7Z229r9OWv3m6Dj4DHoOPgG6DgQBLHGBLH+TOiYAHcQNBsjKLAhruBeQ7CxgCn4FE4fQ9k7WU6Uq4FeA0X299dR5Hmei9fSzOZgyTZOIs3CXdTeQJsRbTmnBYEUE7RII9C1NNAtZZXOFGFS5I9Idaa5jskgyC1nneHYwSpfM6vfp+P/OK2gITeFNKez1xw5ppFOakzwDxL4HHSCRv0DzzhDtP6n82BxShafkMXi6CZWimq+Pv/due+WwDGUL6ldnPlYP3BdwJ+ZS4MxQt0Uvn3VELSF6i1Ub7f7drv/Nbb7Fqq3tdvW7s9Zu98A1QMaehiqg+CroTpou5uixlKvKLn+74idSyVowOkt8pixerLA4IwrkEqLe7jURuii7UHU44u7HX9xV9nerU7u8NYPAV6nqkxBOHWusAe93i1ChRDddWWhu+hgiJabmfxzN86z3vX2PY2H7pn6IkPrSqqYB4fh2+MwaXTZwaWmHPYNjxfw7maTKFvhdr5g8EX5dGuY4jjDECK8mA2BfA/5xI+hZoFh4jfL1F3OnzUbYdtFmd49Zs+/tr9khxfygB33ue+La4FeQMsV80j9KwoXYg5BHK8L6PPSd6phRUG+vFqmOSNk7jVco1zsNvSdQH9NoTdE1hcvkC0YG/w1mSe/vzt/KiaER7kfVJagsNI0QKCi3iKNuN8N51dGiIm3oDKvJlM2bti4lEP1JcYpnCLemzOlxOVxcNQf2AhO0bnZ7cSkuFkQ19WTefQSda1S2iO7C29TcurE9ODFnmzwPeX9kAcHbfAx46fd96YjDjW1KU37OtEEE3kOFJfF3C65ZNf3KvG3ubSOl9ZhafbpihbetZexv+Qdo8hJhEwte+u7F/fyOkvyaMrCE5K6qgN5IujRvEoVz6P23Xo05HVIXlOP9+bdVGOzbbIJ39uExV6ZJuJYxNM8t+rvQlDqUKlcTipU2ner9ZkW7XBFdPqbSyp1/JId3QF0ZP1OUBjGJ5Mc0dbNyCX3hyhcth84sugLHzBYJ+JDw2Z+fIkdliiTPLbfrTMt2KEFO75P2KC/38AosVDbZAP3AZ8ALxfx504QFF3qi17WvZ2fxfeYh7aPGKqyFFsc+H8OFk0wfBL8gqhrGrRpQt715TL8L4Is2sUazpqfGax6cF3fNMfmueI3r2/9zSdtqH81e8ni4eJo5Y1JZz+6Sz/QSf46ffdP6nhtp/kVO03AwpRuvGwYGpaT3CO69YM+OokGPFb0liuVQTdGGh7SGMMsiylS6SinuabjqVZ8RFAo6QgdblBe5RnXISAxFT8GQRY0KUGDorVArHKkU8jrineYwUwMF9P8RVdzIfVjHgaxM3j5LQVJHM4DBwCVZZUBL9VYlQmJ9Hgkuom2ceWbEMYxo+aW5Qzjaq55RVLakCu6PImUmX0zprNkjKlLQXxkLcTQhoNkOJIiEn71tzDkVKWcZUTXhOiPyUbmdKYqLWgCRAcFmFJLK7w+Pl+TCGEmfHuRl5NeYLI9ooUQGod8Mmx3MffRoyK3DuNqQ3OarurfI4rRTBwfrmbT7eLs/Kt/TBkaPiH1XkFHULR+5acLP8ldRs1JDkwHOqGfb06hJr2/vaVTCppr7ugxpnMagS+vFmMLjw/wIH3GsDhGfaovKP/kNPyg8ql47FeZ9+o/P2gzs8WMHeHjJ0WjOZTHAAv1+eyEVfMv/OnKEsva9w807tQT7+HRydH5EYr/v6xGkac= +sidebar_class_name: "delete api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Delete document by ID

+ + + + + +Deletes the specified saved search. + + +## 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/delete-scheduled-search.api.mdx b/docs/api/v3/delete-scheduled-search.api.mdx new file mode 100644 index 000000000..dab9f98fb --- /dev/null +++ b/docs/api/v3/delete-scheduled-search.api.mdx @@ -0,0 +1,96 @@ +--- +id: delete-scheduled-search +sidebar_label: Delete a Scheduled Search +hide_title: true +hide_table_of_contents: true +api: eJztW9tSGzsW/RVVz8NJUr6AMRB4mXKATHGKnDBcJg+Eqsjdsq2kW+qR1AQPxb/P2pLcvkFIMqk5J6l+wnRLW2tftbYs3yWOj22yf5WcpxORVbnI2LngJp0k160kEzY1snRSq2Q/ORS5cMIyNxHMliKVI4nRtp5n/bzOe5W0El0Kw2necYaZmZ9ZrxAXaCUlN7zAG0MI7hJJq5Tc0SuFF/hPZskqjONDpkcehBH/roR1WDrTaVUI5ToYTYAKnuzfJW5akgzrjFTj5L6V0ARpBCA5U4lWIm55UeY0ppfubb7ceLm98zLd7u2lOxub+JTyndHeRrq5tbmV3F/TdFtqZYUl4b2NPv1ZxvaHZgdaOSBhbXasMpnymcUiWPaZW2arNBXWjqqcDStHr41g0jKlWRqnO82GNMlVRkFBqaKQgKBD2vQ3NtYRHOSSph8Zow0wnNUClkzGhjqb0opS3fBcZmS3uDKJ5GWZE3SI7H60JPdu3ax6+FGkjrxoyNtOBrtkwnGZH+hMrLtg1ZWvpRLtseGSEAoPOcVEBok3MsMMVmhYJoiced2PI8Bz78ESnU32imfQN+gXvUBmcoannyCLIvEpQJdKYj6bTWEyYyOAemRZsSv4cGdjr9cf7fQ5773sb+5uD/dGfGtrY297b49WL+BnPg6miWtzY/h0bel/CCWMTFmuU3jkPzCIERy29wD84pginSjs0z7wMr7C/hfQK4yt1Yx4mRO3rsU4e3Vwyvq7LOdqXPnnfLxiBNW+PKeErfKcD+kR5RY0D4LfGjmW6iEoQlUFFZ7Do9eDy5MLPDk7+ufl0Tk+kay18jNQiFafUYCKWJjozx5xVMDnFepMinrQYS+i1BdQiCu7OFDGCjZF5SgQWyNe5Q4z4uoPzFgUzUZGF0up5PPm1rFnsiM6LWQtnhXcpRM25BYTdEjdFwPkfOnaJ9GSL9hE8EyY5x02yDJJSvKcIRshFPOnlP48y+a5P6qQygAj3USjaCjtZCqWfTE35bI3kATS+REni06h5ADyp+NkkLoK4Lyai1lYR0uEGP0DzMFyy+guVqvgVDmeQgue51OY0RhY2BdE6WxdCCXZvuBqNq6uWPf3c7V8uXsTwBw67d+lvLJfkXenOcpP26tWv7gRMfks1eFQjbw3Zm6KFQkvSW0/OY6q3TVLfIZdMs+a3G1yt8ndr8zd1ZdnkfXEt576bK5Tn0vFK9jX+M1zjfrUDGs2yNOb6MgWg0EiRfr93QUS+5NQNF7clkQYfyA/Clv5GvhB7Y/wfEj0o3bWki8IoLdj0GCESiSyfY97jtgbKphqa32119oMJQJUPUARUTUNm+qKcZjMVEoREm5bINnCqt8cm3DUR+4ZbKiAtKrK2qWWgYE3TLJhks1u1OxGv8Zu1DDJJneb3P05c/eLTLJG5bMl8iRbFQU30xBp8T1pyxkG1OdvrE4576pVtkLCWM2xkmXmkAx7m8PN0W4q+hnvZztbe6NeutPj27ubu5vDfm83Wdzrr+Z5XCfZck4t+Dv40ZsYJO4GPK5SCC7rtM6Wj/9gXiNGVNao9NS8GTaHSa/n3PHBM04H3SAY3NE8crx4eXZC8rG0F09205VJBdHsYDoM585TSophWFpa11DHhjo220+z/fwy209DHZvcbXL358zdb6KO/aeoY/8bqGOfEcUaEcX6M6ljBt5B1GwEp0CHtIJ5FdHGEqrgUzx9jGnvuBkLVxO9JRbZ21tnkRdaszdcTWdkyS6dRKq5uai8YWxBY81sLAZwNkaJVAxVS4LdUlTJQhAnRfywXBbS5zEpBLlm2h6MHLQKObP6fTr+T/MKCH1RyDWdvWrEmEQ4iRHRP0jw56BjFOofeMYZvfU/nQezM9L4hDRmR7epEJTz9fnv9kO3BI4B3lC5OA++fuS6QDgz5wpthLgtQ/mqKWhD1Ruq3mz3zXb/a2z3DVVvcrfJ3Z8zd7+Bqkc29DhVx4CvpuoY29lgNZd6TcH1f2fsPlUiAh/eTKeeq2dzDu55BUJpfheXyghdtN1PuvUF3na4wCts905m9xgRGoGAqzI5Bk+cK+1+t3sHd8FN9x1eyg6qGDzmpkp/7qS66N5sPVB86K5pSDSUr6xKffMwOD2O3UbHG9lIiuNQ9PwCweReLYpYmN5fMviifLo5TL6cohFhQUyLIeZjTPnHgFmiofjN+tEdH0NrOkK3S5PfP6XPv7a+pEcQ8ogeD5nvi2thPAPKFfUI/jW5C36HIO+vS+A5CNVqUJGjr64Xx9Bd7CIgXBs533Hoe4HeGqC3NKzHXiFa0DqEqzLPfn938ZyNiZP6mlBZosNCUhOBrDpFGPmaN5hdG6FJfhsyuhpPvHKDpYs5lGNslMMo7L06F4JdHUdD/YHN4AzV25udJglfMGjW9bOZ9zJxI3LaJztza1Nwykx1YcUuX5r33O+JvnmQCh8L/7TzXrXZoaRSJWlvpzFRRd8Lsqtyphdf0Ot7QfxtJq0dpLW9NPt8BUUw7VUaLnqnSHQSwXPrrfXdiwd57QV51GnhCUldxUCWiDiWr1OlM699N44leW2St4zjvXo3kdhwl6exUN+YxX6ZZ+yYpROtrfg7YxQ6lCpX4wqZ9t2wPtOibZ8R7d7GAqR2WLIt26CPHt8JEkOFYOJD2r49e9HhIMWn7QfvWdSFD2iuM/ZhSWf/+Aq7LI3MdGq/GzMt2KYF26FO2Ig/bGIUWMht0sHXgRAAB3P/+0oQgS7UxSDrwcrvxXf9HNo+UkD1Umy5H/7ZnxfB+In5FzS6HoMyTey7vmCG/1mURTvZkrFm5warFlzHm2tsoCt2C3jrbz9pU/2r6UsaD+bHK29VPv3RVfqRSvLXqbt/UsVrKs2vWGkiH6Zw88vGxmExyAOjWz/so9No0GNBb32meuKNtsY3ap7DLIopc+4opn1OpxMp/DFBKbgjdtiiuNKFz0NQYkp+NINe0NhgDJLWgrHyocwhr8PeoQ9TKUxMPRhdz4XUjzo2Y+ew8ik5iR3OHAcCVRSVwlzKsapgHOHxhHczadMqFCG0ZErMNNOextWzZhlJYUOm6PhuxBT27YjOk9GqLjjxibXgQxsPk2FI8kj85d9ckTOR+yijccsU/SnZiJz2ROQldYGooCBTYmGFN8cXaxIhTMVvMLQZd+Mk26WxEELtUAiGrQ56P3pUauvQsi4hpw4L9HDtJ5UrEXU3P0P/ph9XxsJPjL1b0nEU4ahClxG6uqtkvavDxH2Z0c86J4BMY+7u6NSCepx7eoxunVriq+t5C+NbCViTPqN5HCFXxReUeHYWf2D5nD31K80HdZgdvKnpvOdO8PGToFYd4NHQAr4/S/HQwotw2rIwZe37CGp96g748Ojk6OIIheC/Xm+c3A== +sidebar_class_name: "delete api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Delete a Scheduled Search

+ + + + + +Deletes the specified scheduled search. + + +## 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/delete-segment.api.mdx b/docs/api/v3/delete-segment.api.mdx new file mode 100644 index 000000000..2a2934fe5 --- /dev/null +++ b/docs/api/v3/delete-segment.api.mdx @@ -0,0 +1,97 @@ +--- +id: delete-segment +sidebar_label: Delete Segment by ID +hide_title: true +hide_table_of_contents: true +api: eJztW1tzEzkW/iuq3oeBVGwnjpMQP+yWIWEqU+GyuSwPIbXI3bIt6JZ6JHXAk8p/n+9IcvuWEGCpnYHqFzDd0tE537noO0J9k+hSGO6kVsdZ0k8ykQsnzsS4EMolm4kVaWWkmyb9y5vkwgrzTCsnPrlB5SZ4lshM9W0Y3S+44mORXN1ebSaOjy29j5JsgmeZsKmRJa2Flc4n0rLB62MWlrTMTQSLopgtRSpHUmRsOPUvxvJaKHZ82H6r/rmx8VI70d/YwBvu6jleDmSzgmMO/wBpuhDMSfpDs6FI6Z9iNBKpgzRIGuD5B4j9KN2EvTr99b+DwxfHL5k2Xi8OEzXZzqCoEb9X0kAfSEp5nmPpoH4bIJXc8AI2GOthkmReyQHQZqLwAv+SGWGZTkTBk/5N4qYlPbXOSDVObjeTmfik70wl1qGaI3N8SCoEzGht8YkXZU7SxGjnyeigt9PbFwe93b3ucHc4fNLr9vju3s7BfvYkIb8YYUutrLCkRnerR38tL/YSBpKPlWuTZr2trfUxz3JJuhwZA6xa7FS4yiiAI0feWWSNsI4NdebBk+qa5zIjdaNoEsnLMpepD73Oe0tyb9Yh0sP3cBdhbChQnQyaZ8JxmT/TmViHcxW951KJ1thwSRoKr3KKiQwSr2WGGazQRrAgkulggh+3jC+QaG+zpzyDvcG+Z9EYwOQMTz9AFiXRQwpdKIn5bDaFyYyNoNQ9y4p9wYd7Wwfd3mivx3n3SW97f3d4MOI7O1sHuwcHtHohrEXq2YW1uTF8urb0r0IJI1OWawSx/AOAGMGBvVfAL44p0onCPuwDL+ML8KfoDWNrM6O+jCrJJuPs6bPXrLfPcq7GlX/OxysgqNbFGaVTled8SI8oT2B5EPzKyLFUd6kiVFVQHTo8ej64ODnHk9Ojf18cneEXyVqrSgOFaM0oLKEqYmGiP3qNowEfuUUm5oBDZG22EaVuwCCu7OJAGevZ1AJMxNaIV7nDjLj6HTMWRbOR0cVSKqWh7LJHsi3amyhmeFZwl07YkFtMgAtp+MYgTUXpWicRyQ02ETwT5nGbDbJMkpE8Z8hGCPV1cigYzzJK3SBgVCGVha+IunJMaSfTlTozh3LZG0gC6fyIk0WnUHJA84fjZJC6Csp5MxezsI6WqGL0D3QOyC1rd74Amod0qhxHwaeiPQWMxgBhNoRt0tlZpSN3WRQeNRtXV6zb27lZvty9CMocOu3fpbyyX5B3r3OUn5Y3rX5xLWLyWarooRp5b8zcFCsSXpLZfnIcVbtrlvgMe2WeNbnb5G6Tu1+Yu6svTyMzim899dlepz4XKvJC2jzXqI/x0aP0jDz+4elNdOQmMctIkX57cx7JJ8aLTyWRv+/Ij8JWvqb8oPZHeD4k+lE7a8kXpKDHMVgwQiUSWd/rPdfYAxWg2llf7bk2Q4kAVXdQRFRNw6a6YhyQmUop0oTbTZZpYdUvjk046iNHRlgbKiCtqrJWqSUx04ZJNkyy2Y2a3ehn2Y0aJtnkbpO7P2bufpZJ1lr5bIk8yVZFwc00RFp8T9ZyhgFsdkbH6pTzrlplKySM1RwrWWYOybC7Pdwe7aeil/FetrdzMOqme12+u7+9vz3sdfeTxb3+cp7HdZIt59SCv4Mf46GkuQaPqxSCyzqts+XjP8BrxIjKGpWemjcDc0B6NeeOd55COtgGweCO5p7jxYvTE5KPpb14wk1XJhVEswN04YCYKCXFMJCW1jXUsaGOzfbTbD8/zfbTUMcmd5vc/TFz96uoY+8h6tj7CurYY0SxRkSx/krqmIF3EDUbwSmwIa0AryLaWMIU/IqnjzHtHTdj4Wqit8QiuwfrLPJca/aCq+mMLNmlk0g1h4vKG8YWNNbMxmIAjxcPULUk2C1FFV0nACdF/LBcFtLnMRkEuWbaGowcrAo5M4u3ehWp0ryChr4o5JrOXjViTCKcxIjoHyT4c9AxCvV3POOM3vqfzoPZKVl8Qhazo0+pEJTz9fnv7l23BI6hvKFycRZ8fc91gXBmzhXaCPGpDOWrpqANVW+oerPdN9v9z7HdN1S9yd0md3/M3P0Kqh7Z0P1UHQO+mKpjbHuL1VzqOQXX/52x+1SJGvjwZjr1XD2bc3DPKxBK82vEVEboGmw/6cTrq7ZzI7PbhO4VEyUM2lQmx5CJc6Xtdzo3cBKcc9vmpWyjdsFPbqr0x3aqi871zh0lh26YhvRC0cqq1LcMdIM3LNL20BpJ0RtKnV8gAO2NoTgF4P5qwWfl021e8uAU7QcLYjYZIj1Gkn8MNUu0Eb9YP7rtI2fNRth2YfLbh+z5z87n7AhC7rHjLvg+uxbGM2i5Yh6pfzW/Bn5GfDusvnYZfL6H0El/d22xVzSsy54KbtAMhMsvj357c/6YjYll+iyvLBFcIaktQJ68Roj4KjaYXQShSX5jMboaT7zig6WrNpQ1bJTDYPZWnQnBLo8jCC9R3k9Rjz2kNEn4EkCzrh7NPJOJa5HTzteeI0mBJzPVAUIdvjTvsd/lfDsgFX4W/mn7rWqxQ0nFR9JuTWOiib67Y5flzC6+YNe3KvGPmbRWkNby0uzjFS0CtJdpuLqdInVJBM+tR+ubFw/yWgvyqHfCE5K6qgMhEfVYviCVzrz2zXosyWuRvGU93qo3E4ktdHkaCxWLWeyAecaOWTrR2op/MUahQ2lwOa6QRd+s1kdatOUzotXdWlCpFZZsyRYIodfvBImhQjDxIW3Ino/ocDTiU/Kd9yxy/h3a5Yy9W7LZP77EvkkjM53ab9aZFmzRgq1QA2zUP2xLFFjIbbLB14EQAM/m/veVICq6UPOCrDuruhff8XNoa0ihqpdiy374R39e4OIv5l/Q6HoMSjDx6frKGH2lEWXR3rQE1uwkYBXBdX1zjS1xBbegb/3/mbRN/t3sJYsH8wOTVyqffu8qfU8l+fvU3b+o4jWV5mesNJHhUrj5ZWMrsBjkga2tH9/R+fJE4E+89ZnqqTQalfDhGXGYRTFlzh3FtM/pdCKFb/xLwR0xv02KK134PATdpeRHe+cFjQ3GIGkt2Cgfyhzy2uwNOiuVAmLqqujCLaS+17G9OgPKr8lJ7HDmOBCooqgUffYGJaqCcYTHA97NpE2rUITQZCkxs0x7GlfPmmUkhQ1B0fb9hSnsqxGdEKP5XHDiA2vBhzYeDwNI8kj80m5uyKnIfZTRuGX6/ZBsRE5rIvKS+jpUUJApsbDCi+PzNYkQpuL/SWgz7sRJtkNjIYRanRAMO210c/So1NahCV3SnHomFr+YpA8fjw9Xg+lmfiD+M31AGbck6iU6JR19EUJV6G1CB3mZzDpIDO/LjL4nnQBCenNzQ+ci1E/d0uPfK0FN9+XVvF3ybSa8S7/Rno5QO1Y/slxE9tFpVPYxO5/c/+nlnVrPjvXUdN7RJ/j5QdBBABRHuwzV/UmNVyu8CGc5C1PW/reD2rC6vz48Ojk6P0oCq7lrU48/gALK1p9DQ+eq +sidebar_class_name: "delete api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

+ +No content. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/delete-service-desk-integration.api.mdx b/docs/api/v3/delete-service-desk-integration.api.mdx new file mode 100644 index 000000000..6f02cc7be --- /dev/null +++ b/docs/api/v3/delete-service-desk-integration.api.mdx @@ -0,0 +1,95 @@ +--- +id: delete-service-desk-integration +sidebar_label: Delete a Service Desk integration +hide_title: true +hide_table_of_contents: true +api: eJztW1tzEzkW/iuq3ocBypdcDNn4ZcuQsJWpMLC5LA8hVcjdsq2hLfVI6hBPKv99viOp2+44JsBSO0D1S2Krj47OXd+R1TeJ41ObDC+SU2GuZCrYgbAf2JFyYmq4k1oll50kEzY1svBfh8mByIUTjCsmrqV1Uk1ZY7JcTmbjBTs66DE2Yk5/EIp9lG7GXpspG2VzqZg2zalhlJdupo10CyYtM+KPUhqRgQHjaSqsZW6GcaGyQmOpXtJJdCHCekcZ5Mu8fJEvsV3VppMU3PA5CAypfZMofMEkmeGRJPUK7mbJXZ2PDpiebFYTsoVVMbESOBk6U4pOYt0ipxWsnBc5EYjrItcZhiY8t0SQzsScJ8ObxC0KT+kMjOopuZ8zTDipdnt7SextoZUVlibsbA3oX1PWjVJ647uZYFN5BV9AJ1t6i07KPF9EDbBMJxlsba3zfZFLoRw7NAZu67IT4Uqj4Bg58UxJb2EdG+vMO06qK57LjPyTakihHLHkRZHL1MvT/90S35t1A+jx7yJ15CtDrnUyaJsJx2X+wttu3VhNYV9KJbpQXJKEwoucYiIDxyuZUczOtREssCTfkgqertcwPCzR22bPeQZ9g34vojIwkzM8/QBeFHYPCXSuJOazagqTGZtAqA3Lij3Bx8+29ncGk2cDznf+Odjeezren/Dd3a39p/v7tPocnuPTYJq4NjeGL9aW/rdQwsiU5TqFR/6EQYzgsL0XwC9Ose/E3D7sA8/jM+x/Br0Cba1mlJc5ce06jLPnL96wwR7LuZqWfpxP7xhBdc9PMaIQnnxMQ5RR0Dwwfm3kVKp780aVc6ppB4cvR+fHZxg5OfzP+eEpPhGvtYo2UojWjMISoiIWZvqjlzgq8JFbZpEcKbKjx55Erk+gEFd2lVCGb3ZhYUzE1oSXucOMuPo9M1ZZs4nR80Yq+by5duyR7Ileh41pbM5dOmNjbjGBKg/In4yQxYXrHkdLPmEzwTNhHvdQUDNJSvKcIRvBFPMXYMR4llHqBgaTEqksfH3QpWNKO9SPpi+Wpmx6A0kgnac4XnUKJQckfzhORqkrIZxXczUL62iJIkb/QOZguaZ0ZytG8yZdKMdTaMGpsKXaGFiYjaGbdJbFckTusig8qqKrK9bt7VItX+5eBWEOnPbPUl7az8i7NznKT9erVj+4EjH5LG0aoRp5b1RuihUJD0ltPzlS1e6qEp9NpMizNnfb3G1z9zNz9+7Dk4im4lMPfbbXoc+5ipiUNs816GN89ChdAdc/A9wKjuwQyI0Q6de3ZxEHE4C9LggmfkN8FLbyNeFHtT/C+JjgR+2shi9IQG/HoMEElUhkQy/3UmJvqGCq3fXVXmozlghQdQ9ERNU0bKFLxmEyUypFknDbYZkWVv3i2IyjPlYoX9dAv1sj/RZJtkiy3Y3a3ejn2I1aJNnmbpu7P2bufhJJ1lL5bIk4yZbzOTeLEGnxOWnLGQhYda7H6pTzrrqLVogZqzFW0kQOyXhne7w92UvFIOOD7Nnu/mQnfbbDn+5t722PBzt7yepef7HM4zrJmjm14u/gR29igLgr4LhSIbis0zprHv/BvEZMqKz5I9sKN8PmMOnlEjvec3L5m3bQDYyBHc2G48Xzk2Pij6U9e7KbLk0qCGYH04GcOw8pKYbDIXULHVvo2G4/7fbz02w/LXRsc7fN3R8zd78IOg4ego6DL4COA0YQa0IQ6++EjhlwB0GzCZwCHdIS5lUEGwuogk/x9DGmveNmKlwN9Boocmd/HUWeac1ecbWowJJtnESqpbmovIF2TrSmoqX7B/EHclQtCXRLUSXngjAp4oflci59HpNC4GsW3dHEQauQM1W81atIleYlJPRFIdd09qoRYxLhJCYE/8DBn4NOUai/4Rln9Nb/dB7MTkjjY9KYHV6nQlDO1+e/T++7JUCXLQyVi9Pg6w3XBcKZOVdoI8R1EcpXDUFbqN5C9Xa7b7f7n2O7b6F6m7tt7v6YufsFUD2ioc1QHQSfDdVB29tiNZZ6ScH1f0fsPlWiBD68mU49Vs+WGBxGsAKD0i38IueA+C9CKI9KN6PMlJka2nAntYuA+NDldMt3CGcQPO2sP1+5s1pRXdLV17lAzC5v+FK9oru6w6S/abrt38jsNiEZCYwGO5Qmx5yZc4Ud9vs3CA+ExW2PF7KHqokIcQulP/ZSPe9f7d5T7Ohua0hslMusTH2zMnpzFLubnneqkZQ3ocj6BYKLvRkpQ+Bqf6nhk/zpbjLFzgKNDwtsOgw5FmPYD0PMAg3ML9ZT93zMrukI3c5NfvuQPv/d/ZQegckGPe4z3yfXAj2DlHfUI/EvlyF1Skg/rL4WWMvdi35j2Flb7DWR7bDnghu0IeHazaNf3549ZlPCt76+lJagtZDUkCBD3yBEfP0cVVdQaJLf0owup+Hy9KhxyYfylU1yKMzeqVMh2MVRNMJv2FhOsBN4k9Ik4YsPzbp8VHkmE1cipz23t7QkBR5yog8L9Xlj3mO/v/pGRCp8nPvR3jvVZQeSyh6FvKeJKvq+kl0UlV58Ra+vFeIfFbdu4Nb13OzjO1IE016k4dJ4iqJBLHhuvbW+evHAr7vCj7o2jBDXuzKQJaIczatZaeW1r5ajwa9L/JpyvFNvZxKbd3MaCyWMWey9ecaOWDrT2op/MUahQ2lwMS2RRV8t1kdatOszoruztSJSNyzZlV1AUS/fMRJDhWDiY4ICHgnpcCjjU/K99yxy/j0a9Yy9b+jshy/oHQ5QZjq1Xy0zLdilBbuhBtgof9gQKbCQ26SDrwMhAF4s/e8rQRR0peYFXvdWdc++7+fQ1pBCVM/FFsPwZbgscPET8w+IuqZBCSYkX19Ww3cWedGu2DBWdQZx14Lr8uYam/EduwV5619SaYP+3vQljUfLo5rXKl986yq9oZJ8P3X3b6p4baX5GStNxNYUbn7Z2ISsBnlAa+sHh3SyPRP4i6c+Uz2IR4u0fAFslU2Rc0cxHV6wm0nhjxwKwR0hvw7FlZ77PATcpeRHY+kZTQ1okLQWaJSPZQ5+PfYWPZ1KYWLq5+iqL7j+rmNjdworvyEnsYPKcQBQ83mp6GU/CFHOGUd4PODdTNq0DEUI7Z0SlWbaw7h6VpWRFDZkip7vbMzcvp7EV+RWnPjAWvChjQfTMCR5JL43uFTkROSh5wBdE34/xBuR052JvKCOEhUUYEqsrPDq6GyNI5ip+GuINtN+nGT7RAsm1OqEYNjtoY+koUJbh16qIXl4jXPjW413I+tmeS7/Hb4DGrcZ6g/6BR2kkdZl6FdCm3iRbGwTMX8oM3rVdQY7EenNDR27UNN0S8N/lIJ6+ovLZU/ke0m4kD5n9cucGy326CQq8Zh9wcuk92pVHSKqxfL8IMHHD4KOHaAHmnNo4s+FvJThQTg5Wpmy9ttKo8k+ODw+PDtMApK5byOPH2AUlKq/AGKRFvI= +sidebar_class_name: "delete api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/delete-sod-policy-schedule.api.mdx b/docs/api/v3/delete-sod-policy-schedule.api.mdx new file mode 100644 index 000000000..3289abfcb --- /dev/null +++ b/docs/api/v3/delete-sod-policy-schedule.api.mdx @@ -0,0 +1,95 @@ +--- +id: delete-sod-policy-schedule +sidebar_label: Delete SOD policy schedule +hide_title: true +hide_table_of_contents: true +api: eJztW21T27gW/isa3w/bduIEQoCSL3dSoHfYoVsuL7cfKDNVbCVR15a8kk2by/Df73MkxYkJlJbt3N12/AUc++jovOs5snwTWZFURpbzaHh5E11YYfa1KsXnclSVM9yLZKqGVqdxoTOZzIefQCuiq9urTqQLYXgptTpKo2GUikyU4kynJ47wLJmJtMpE1IlKPrXE6eztAfMPI4xOhU2MLGg8Rp/PpGWehWU2jGUTbRhnthCJnEiRMuLg5WDjOTs66IJ7wQ3PMcxYp4EkbgWH7J1I4QF+yRTXxDPn0fAmKucF3bWlkWoa3XYiI/6opBFQojSVWJdMYCamJ6zE1YoE9LOWNK9sycYiqJCS5CSc+MzzIqPpxGTr5WRvsBUPdsVePNje6cfj7fE4fjnoD/j2ztbebvoyIqsaYQutrLAka39jQP+aEv2mWUI+UiVbEHdJj8HGxjrxfiaJ8NAY2DJmp6KsjIKA0utDugsSXadzBhdIdc0zmZLsYQ5iyYsCKjtf9z5a4nuzblA9/iiSkjxiKDJK6VVIRclltq9TsW78u7Z+LZWIp4ZLklA4kRMMZOB4LVOMYLk2ZGRiuXCJo2saG5bobrJXPIW+Xr/9oAzMVBqe/A5eFLWPCXShJMazxRAmnWcfmlbsCj7e2djrDyY7A877Lwebu9vjvQnf2trY297bo9lzYS2fetOEubkxfL429b+EEkYmLNMJPPJfGMQIDts7AdzkGIJczO3jPnA8vsL+FOuetlYzyMuoJHSQjK/2T9hgl2VcTSt3n0/vGEHFF2eUfFWW8THdoqyC5p7xWyOnUt0nilBVTmXi4PD16OL4HHdOD/99cXiGK+K1VjJGCtGaUlhCVMTCTH9yEgcFPnEUEmRjgnTssheB6wsoxJVdJZT+l51bGBOxNeFVVmJEmP2eEaus2cTovJFKia+f7Jnsim4HRQH3cl4mMzbmFgPgQiJ/MUoSUZTxcbDkCzYTPBXmeZeN0lSSkjxjyEYwxfg5VReeppS6nsGkQipDGFnOdFUypUuZiKYvlqZsegNJIEtHcbzqFEoOSP54nIySsoJwTs3VLKyjJYgY/AOZveWa0p2vGM2ZdK5KnkALnmVzmNEYWJiNoZssbV3yJNk+52pBV1es29ulWq7cvfHCHJTaPUt4Zb8i704ylJ/YqVY/uBYh+RAGOlQj542Fm0JFwkNS2w0OVLW7FonPsJJlaZu7be62ufuVuXv34WlAPeGpgz6b69DnQnFgWG3c4rkGfYyLHqXZgsjBm+DIDoNBAkT69d05Evt3oYhefC4IKn5HfOSX8jXhR7U//P0xwY/aWQ1fkIDOjl6DCSqRSIdO7qXEzlDeVFvrs73WZiwRoOoeiIiqadhcV4zDZKZSiiThtsNSLaz6pWQzjvrIkRHW+gpIsyrqGKQqWyTZIsl2NWpXo59nNWqRZJu7be7+mLn7RSRZS+WyJeAkW+U5N3MfaeE5acsZCOr9N1annHPVXbRCzFiNsaImcojG/c3x5mQ3EYOUD9Kdrb1JP9np8+3dzd3N8aC/G62u9ZfLPK6TrJlTK/72fnQmBoi7Bo6rFILLllqnze2/ivYSJ1TWqPTUuBk2h0mvltjx3u3IErqBMbCjeWB78eL0mPhjasee7KYrkwiC2d50IOelg5QUw7C0tGULHVvo2C4/7fLz0yw/LXRsc7fN3R8zd78JOg4eg46Db4COA0YQa0IQ66+EjilwB0GzCZwCHZIK5nWvoAuogquw+xjSvuRmKsoa6DVQZH9vHUWea83ecDVfgCXb2IlUS3NReQNtTrRmQQsCzqYokYqhakmgW4oqmQvCpIgflslcujwmhcDXzOPRpIRWPmcW8VbPIlWSVZDQFYVM096rRoxJesk/IfgHDm4fdIpC/R33OIO3/tR+MDsljY9JY3b4ORGCcr7e/92+75TAEYQ3VC7OvK8fOC7g98y5QhshPhe+fNUQtIXqLVRvl/t2uf85lvsWqre52+buj5m73wDVAxp6GKqD4KuhOmi7G6zGUq8puP7viN2lSpDAhTfTicPq6RKDO1yBUFqe26UyQodmh1GvPuyLgtK7keltzy7P8vpewItWmQz0s7Is7LDXu4HH4KnbLi9kF4UMTivnSn/qJjrvXW/dU3/ouKnPNVSwtEpc/zA6OQoNR9fZ2UgKZV/33ATe6k4zClpY350z+CJ/OghM7pyjF2GeTYch7ENYudsQs0BP8Yt11F0XRms6QrcLk90+ps9/tr6kh2fygB73me+Lc4GeQco76pH4V536cDedxs797GtHvJcLCm3799cme0tkffZKcIPOwJ+Eefbru/PnbEqQ06V8ZQntCkk9ApLmBCHiStpocSqEBrlVxuhqOnOCjxrnbiiF2CSDwuy9OhOCXR4FI/yGWn+K4uxMSoOEqwc06urZwjOpuBYZLYPdpSUp8GSqerBQjzfGPXdLnusNpMJl7u5236uYHUiqRJKWbqIJKrpWj10WC734il5PFeIfC26x5xY7bvb5HSm8aS8Tf447QR4TC55ZZ60nT+75xSv8qJHCHeJ6VwayRJCjeVoqWXjtyXI0+MXErynHe/VuJrGeNocxX76YxXKYpeyIJTOtrfgnYxQ6lAaX0wpZ9GSxPtGkscuIuL+xIlLsp4xlDHTo5DtGYigfTHxMq7MDJ9rvk7iU/OA8i5z/gN45ZR8aOrvbl1hEiTLViX2yzDRhTBPGvgbYIL9foyiwkNukg6sDPgD2l/53lSAIulLzPK97q7pj33NjaGlIIKrjYouh/zFcFrhwxdwDoq5pUIIJXNfnx/CbBV60UDWMtdgWuGvBdXkzjfXxjt28vPXLTVoz/276ksaj5e7JW5XNv3eVfqCS/H3q7l9U8dpK8zNWmgB3KdzctKEvWA1yj9bW9/Jos3km8BdPXaY6XI2uxfVhDsOssikyXlJMu5xOZlK4XYBC8JKQX4fiSucuDwF3KfnR6zlGUwMaJK0FGuVjmYFfl71Dm6USmJhaLDp9C64fdei1zmDlE3ISO1g4DgAqzyuFsZRjVc44wuMR76bSJpUvQui4lFhoph2Mq0ctMpLChkzRdc2Gye3bCW0XoxNdceIjc8GHNuwVw5DkkfCR3lKRU5G5KCO6Jvx+jDciJ56JrKAmDxUUYEqszPDm6HyNI5ip8IJCm2kvDLI9ogUTanV8MGx10drRrULbEh1pQ3JqoFa/DFzplxohdbPcI/8THzyGdYAAfK+gzScSq/INhe/hLqPVHg5DhvUnkE4sNAYzqEGENze0UUE9zS3dRoNOXfDl1bJlca0eLEzX6BcnyN+730iu6vXsNHxN+dy9annyl5P3arnYiFPzZQ8e4fJ3Qa07lESDC93c3oqT2z/wuy8rQ9beT1CvVHfEB4fHh+eHkYce96284QJmQm35HzCmr1Y= +sidebar_class_name: "delete api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Delete SOD policy schedule

+ + + + + +This deletes schedule for a specified SOD policy by ID. + +## Request + +

Path Parameters

+ +No content response. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/delete-sod-policy.api.mdx b/docs/api/v3/delete-sod-policy.api.mdx new file mode 100644 index 000000000..6e312fd91 --- /dev/null +++ b/docs/api/v3/delete-sod-policy.api.mdx @@ -0,0 +1,96 @@ +--- +id: delete-sod-policy +sidebar_label: Delete SOD policy by ID +hide_title: true +hide_table_of_contents: true +api: eJztW1tTGzka/Suq3odJUtiAMRD8suUAmWWKBJbL5oFQG7lbtpW0pR5JDfFS/Pc9n6Ru3yAk2dTOTKpfwO6WPp3vqiNZukusSEsj3TTpXd0ll1aYfa2c+Oz6pRvjWSIz1bM6axU6l+m0d4u2Irm+v15LdCEMd1KroyzpJZnIhRPnOjv1DZO1xPGRJQnnJwcsPkSvTNjUyIL6odfFWFoWulrGmS1EKodSZIw6hSHb79WZ+L2UBi2MzgXTQ3Zy9uu/+wdvjt62MU7BDZ9AgLFeB0lyCw70a4nCC3yTGT7bdCwmPOndJW5a0FPrjFSj5H4tMUE+1HCmFKsYBTs6oGEdPs20YU5H6IRCfOaTIie5Yrj1crjX3Wp1d8Veq7u902kNtgeD1stup8u3d7b2drOXGDUi/b0UZjqDmuuRTHn+EN6BhvZcJYRvyMvcBbj3y3iPVAYRZNDbsQBkA9ywsvQG1kMXQbNncSxGUp4zbfB+zE1WKcXY+VzrCTefrLdAcAvjleMyxlXGPpbWMctvBJOO3Uo3DqNax11p2+zIsVSXecYGgg3LPJ/WnTGuEam+EXAAXhlCjLH/MUPCbqTFHziYM8TchCuhXC3Be4Q8KAAgK8mnYWioli94Jjh35uwhz62gSEZoFVpZYcnanY0u/Vu06VsN+MgL5doUMN2NjdU2+7nEe3ZoDFRqsTPhSqOgkwyBU0Ec6GxKzpDqhucyI4RRNInkRZGT9yBy/aMluXerkaAHH0XqKPQNJaGTAXkmHJf5vs7EapQvB8lrqURrZLgkhMJDTtGRQeKNzMiGE20ECyKr2PftFoMdlmhvslc8Y2dRv/2oDMzkDE8/QRYViKcAXSqJ/qzqwiSCQZvHhhW7gg92NvY63eFOl/POy+7m7vZgb8i3tjb2tvf2aPSJsJaPgmni2NwYPl0Z+lehhJEpyzVCRv4HBjGCw/YegB8cXVD2JvZpH3gZX2F/Kiqhba1mxMuo+q4hF1/tn7LuLsu5GpX+OR8tGUG1Ls+pdCCf+KCKcGgeBJ8YOZLqIShClROqzAeHr/uXxxd4cnb4z8vDc3wiWStVuq8Qrb6oACpiYaxvPeKowC1KgUUupkjnNnsRpb6AQlzZ+YYyfLNTC2OyWMXQI47+QI950Wxo9GQhldIwVbFnsi3aaygteDbhLh2zAbdUWpRv/qKfpqJwreNoyRdsLHgmzPM262eZJCVRBZGNEIr+U6pRPMsodYOAYYlUFr6q6dIxpZ1Ml4r+zJSL3kASSOdbHM87hZIDyJ+Ok37qSirRpOZ8FtbREiFG/wBzsNwiuos5o3mTTpXjqaPqjzqaaoMKjMoE3aSzVaUjd1kUHlW1qyvW/f1MLV/u3gQwB077dykv7Vfk3WmO8tPyqtUvbkRMPkvTa6hG3huVm2JFwktS23eOrWp3VYnPwCTyrMndJneb3P3K3F1+eRaZUXzrqc/mKvW5VBzLBW385LlCfYyPHqVZ1cjTm+jINSKAkSL99u4Cif1JKGovPhdE034gPwpT+Qr4fu2P8HwQGKSop/6ZLwigt2PQYIhKJLKexz1D7A0VTLW1OtprbQYSAaoeoIiomoZNdck4TGZKpQgJt2ss08KqXxzoOeojR0ZYGyogjapocSaJmTZMsmGSzWzUzEY/y2zUMMkmd5vc/Wvm7heZZI3KZ0vkSbacTLiZhkiL70lbztCAVXt0rE4576pltkLCWM2xkkXmkAw6m4PN4W4quhnvZjtbe8NOutPh27ubu5uDbmc3mZ/rr2Z5XCfZYk7N+Tv40ZsYJO4GPK5UCC7rtM4Wt/9gXiOGVNao9NS8GTaHSa9n3PHBXUgH3SAY3NE8sr14eXZM8jG0F09206VJBdHsYDo0585TSophWFpa11DHhjo2008z/fw0009DHZvcbXL3r5m730Qdu09Rx+43UMcuI4o1JIr1R1LHDLyDqNkQToEOaQnzKqKNBVTBp7j7GNPecTMSriZ6Cyyys7fKIi+0Zm+4mlZkyS7sRKqZuai8oe2E2pqqLRpwNkKJVPRbvAS7paiSE0GcFPHDcjmRPo9JIcg101Z/6KBVyJkq3upRpErzEgh9Ucg17b1qxJhEOIkh0T9I8PugIxTqH7jHGb31P+0HszPS+Jg0ZoefUyEo5+v93+2HTgkcAbyhcnEefP3IcYGwZ84VlhHicxHKV01BG6reUPVmum+m+59jum+oepO7Te7+NXP3G6h6ZEOPU3U0+GqqjrbtDVZzqdf+OOz/m7H7VIkIfHgznXquns04uOcVCKXZEWkqI3Q6uZes1+eqUVDW72R2j3dhCRAQlSZHs7Fzhe2tr9/BUXDQfZsXso36BV+5qdK37VRP1m+2Hig74dSvP7NrdFamftnQPz2K64y2N6+RFMGh3PkBgrHjCePEwuj+eMEX5dPpZfLiFEsQFsSsMUR7jCb/GDALLCV+sb5120fPio7Q7dLk90/p86+tL+kRhDyix0Pm++JYaM+Ackk9gn+9Vh+fPyfOHUZfOUQ/m0dot7+zMtgJNeuwV4IbOqztD8A8++3dxXM2IqbpM720RHKFpKUBcuUUIeIrWb86DEKd/ORidDkae+D9heM2lDlsmENh9l6dC8GujqIR3qLEn6Eme5NSJ+HLAPW6flZ5JhM3IqfZrz2zJAWezNQ6LLTOF/o99zOdXxJIhY8T/7T9XrXYgaQCJGnGpjZRRb/CY1dFpRef0+t7QfytktYK0lpemn2+hCKY9ioNx7dTpC+J4Ln11vruwYO81pw8Wj/hCUldxkCWiDgWD0mllde+G8eCvBbJW8TxXr0bS0yji91YqFrMjv2p/SOWjrW24u+MUehQGlyNSmTRd8O6pUFbPiNanY05SK0wZEu2QAo9vmMkhgrBxAc0KXtOosP2iE/JD96zyPkP/i7ChwWd/eMrzJ3UMtOp/W7MNGCLBmyFGmAj/jA1UWAht0kHXwdCAOzP/O8rQQQ6V/OCrAeruhe/7vvQ1JACqpdii1740psVuPiJ+RfUum6DEkycuj42hu8syqL5acFY1W7AsgVX8dLtEbVkt4C3/k2Tpso/m76kcX+2aXKi8umPrtKPVJI/T939gypeU2l+xkoTWS6Fmx82LgfmgzywtdUtPNpjHgv8xVufqZ5OY7FSXSATbF5MkXNHMe1zOh1L4Rf/heCOmN8axZWe+DwE3aXkpytwJGhk0AZJa8FG+UDmkNdm77C6UilMTCsrOnQLqR91XGKdw8qn5CR2UDkOBGoyKRX6Uo6VE8YRHk94N5M2LUMRwkJLiUoz7Wlc3avKSAobMkXbrzHMxJ4MaZcYC9A5Jz4xFnxo4xYxDEkeiTcLZ4qcidxHGbVbpN9PyUbktMYiL2hthwoKMiXmRnhzdLEiEcJU/F1Cm9F67GTXqS2E0FInBMNWGys6elRo67AQXUBe3/OLdw8HU3Z0sBxPd7N98R9yrzROB8Tj1wvaeiJ0ZVhXhBXcVTK/gkOXnszojusYKtDbuzvam6D1zD09Dlc9aWEHe1LIVncQv6BIc5lz8TLng075JGg/YXZ1Nu4ZJAmt0KqV4Tca/lkMjuy5/yHr6QvADyKr9jPVdB5WhRjRcn+NVmGLygMML8Im1lyXlZ95SLN6Y+Hg8Pjw4jAJVO4hJhM/9K5oV+K/gUegnQ== +sidebar_class_name: "delete api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Delete SOD policy by ID

+ + + + + +This deletes a specified SOD policy. +Requires role of ORG_ADMIN. + +## Request + +

Path Parameters

Query Parameters

+ +No content. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/delete-source-schema.api.mdx b/docs/api/v3/delete-source-schema.api.mdx new file mode 100644 index 000000000..ceb9ce910 --- /dev/null +++ b/docs/api/v3/delete-source-schema.api.mdx @@ -0,0 +1,95 @@ +--- +id: delete-source-schema +sidebar_label: Delete Source Schema by ID +hide_title: true +hide_table_of_contents: true +api: eJztW9ty2zgS/RWU9mGSlC62LMexX7YU29nylDPJ+rJ5cFwViIQkJBTIJUDHWpf/fU83QEqUfEm8qZ1Jii+JTAKNvp3GaQi6aaWZyqXTqTmKW3utWCXKqdO0yCN1Gk3VTLbaLScntrV30fKPbeuy3cpkLmcYmdOLm5Y2mJtJN8Vogxf4y/JgCG23cvXvQucK8l1eqHbLesF7Ny03z3isy7WZtG7bWN9Guc5IHzw/myrhFxU67kKSupazLKEp/Wh389XGq63teHN3U756ubG5HfdfDba3RwPZ3+rvQtjdavHarNYDaqxqfIdaPPkJal2SdJulxsKTWLu/MaD/6iv8kYooNU4ZJzpCm1hH0ikrHBYm1ZR14qu0whYR4mHHRSJGhaPXOTxlhVlMd6kY0SRX5EbFkBWEeA26ZOxgY2Ndg/1E0/TDPE9z6HBSCRjXtBil8ZxW1OZKJt4ZYWUSKbMsIdUhsvfZktybda+no88qcpiY5ZSLTnu/xMpJneynsVqP0GpA3mijOpNcatJQscoRJgpIvNIxZohZCs94kSL1JvC4evTgie6meC1j2Ovt2w/GwE0ul9EXyCKcPKbQudGYL8opSBMxhlL3LKt2lBy93NjtD8YvB1IiXzZ3tke7Y7m1tbG7vUu53JohznLiXRPWlnku52tL/0MZletIJGmEiPwHDsmVhO9ZAV4cU7RTM/t4DFjGN/ifAOHHVmYGfYVT164tpHi9/14MdkQizaTg53Ky4gTTOT8lnBZJIkf0iKAHy73gd7meaHOXKsoUM6pOB4dvhufHZ3hycvjP88NTfCJZl6vKDk2JKKiKXJimX1njYADjClUwciruihdB6gsYJI1dHqj9X3Zu4Uzk1lgWicOMsPodM5ZFi3GezmpQYtxcO/FMd1W3DdTi2Uy6aCpG0mJC6qH7YgjMZ65zHDz5QkyVjFX+vCuGcazJSJkIoBFCMX9O8JdxvMD+uACUoYx20xRFw6ROR6oei4Ur69EACLTjEcfLQSFwQPPH82QYuQLKsZnLKKyyJahYVrw4eK6u3dlqFZwbJyNYIZNkDjfmOTzMBVE7WxVCTb6fSVOOqyrW7e3CLC53b70yBy7ld5Es7Dfg7n2C8tNh06oXVyqAz1Id9tWIo1GGKVQkvCSzeXIYVYWrBL4Ya5XEDXYb7DbY/Ubsrr48CawnvGXqs7lOfc6NLODfnDfPNepTMaxyENObEMi2gEMCRfr9wxmA/UUZGq+uM+KTP5Af+a18TflhFQ//fET0owpWLRakIPvRWzBGJVLxHuu90Jgd5V21tb7amzQfaSSouYMiomrmYp4WQsJleWEMaSJtW8SpsuY3J6YS9VEyg/UVkFY1cSdLtXENk2yYZLMbNbvRr7MbNUyywW6D3Z8Tuw8yyUorRkvgSbaYzWQ+95kW3pO1UmBAdf4mKshxqFbZCgkTFcdq1ZlDa9TfHG2OdyI1iOUgfrm1O+5HL/tye2dzZ3M06O+0lvf6iwWOK5DVMbUUbx9HdjFI3BV4XGGQXNalaVw//oN7czWmskalp+LN8DlcerngjneecTrYBsHgjvk9x4vnJ8ckH0uzePKbPw4m0LLrMFw6ppSUw/C0tq6hjg11bLafZvv5Zbafhjo22G2w+3Ni97uo4+Ax6jj4Duo4EESxxkSx/kzqGIN3EDUbIyiwISrgXkO0MYMp+BROHwPsncwnylVEr8Yi+7vrLPIsTcVbaeYlWbK1k0izcBeVN4yd0di8HIsBUkxQIo1A1dJgt5RVeqaIkyJ/RKJnmnFMBkFuPu8Mxw5Wecysfp+Ov6OkgIZcFJKUzl5T5JhGOqkx0T9I4HPQCQr1DzzjDNH6n86DxQlZfEwWi8PrSCnCfHX+u33XLYEjKJ9TuTj1sb7nuoA/M5cGbYS6znz5qihoQ9Ubqt5s9812/2ts9w1Vb7DbYPfnxO53UPXAhu6n6hjwzVQdY7sbouJSbyi5/u+MnaESNOD0FmnEXD1ecPC1C7oHfF24vKMb7sSO5uLogPVB1i0uFVPFoau4e62e5/a2d1NeEr7teZpHj8IF3VuM9x2EN6jIE0ydOpfZvV7vBnFGfG+7MtNdlD+E2s1N+rUbpbPe1dYdVYsuqXqEou7FRcRdx/D9UWhTuhydXBMAfLXkBXys2B+U6ogZ3054UD7dNKYkmMM44cW0BcASkpEfQ80Mnchvlkd3OfnWbIRt53ly+5g9/9p6yA4v5B477nLfg2thvICWK+aR+pcULiQMBHG8zqHPvi9zw4LCfnG5PIZzxWu4NnKxVdEXCv01hd7RsL54rWSOnsPfsXn2+4ez52JCZJaLSWGJRytN3Qfg+B5pxMVyWN43oUm8f+VpMZmyccPajR4CpxgncIr4aE6VEhdHwVF/YBc5Qdlnt9MkxZWGZl0+K6MXqyuV0AbbXXibklPHpgcv9mRt3nPeTLnr0AYfZ/y0+9F0xIGmGqeJFNCYYCI3keIiK+2SS3Y9VYm/ldI6XlqHpdnnK1p4115E/oZ4hApBImRi2VtPXtzL6yzJoxYNT0jqqg7kiaBH/R5WVEbtyXrU5HVIXl2Pj+bDVGOnrk8TvtoJi402icWRiKZpatXfhaDUIahcTAog7clqfaVFO4yITn9jSaWOX7KjO+CdrN8xgGF8MskR7ftMe1J/AsOw/cSRRV34hK48Fp9qNvPjC2zPNDJOI/tknWnBDi3Y8XXCBv397keJBWyTDVwHfALsL+LPlSAoulQXvaw7Kz+L7/Ec2j4iqMpSbLbn/9hbFMHwSfALGl2NQZkm2l7dTMPfIsiiLbDmrPLAYdWD6/omKXbeFb95fauvTWk3/qvZSxYPF+cy70wy/9FV+p5K8tepu39SxWsqza9YaQKRpnTjZUPHsZzkntGtnxLSMfZU4V+8ZaQyY0c/xB0ec5hlMVkiHeU0YzqaasXnC5mSjthhm/IqnTEOQYkJ/OgiWdAkxxiA1oKxypFOIK8rPqCBMxFcTM0b3euF1M9p6OJO4eX3FCRxUAYOBGo2KwzmEsaKmZBIj0eiG2sbFb4IoZczqrQsZRpXzSoRSWlDruhyG5PP7LsxHUSjx10K4iNrIYY2nELDkRSR8EvBhSEnKuEso3F1iv6YbGROZ6qSjNpHVFCQKbW0wtujszWJEGbCVx9pPumFSbZHYyGE2iGfDFtdNI30KEutQ69b0/yBrqyWUlUNJ/Ldy+hIikQWvmHw7dpF+CknWb+39KvO0LHx0/JHlSD4U6hDk25u6CiD+pdbeowWnvrki8tFe8JtAjxFn9EmjoHD1Z9a3iy+HWg9Owk/ynzOX8bUfhd6pxXl8ZuZLzrvFj5+UdSwV5ZQ4/V0LZZ/BvoULUrPocWG7/h0h/3iX/vzn6WJa9+QUE9VNdoHh8eHZ4eoMP8FtKzefA== +sidebar_class_name: "delete api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Delete Source Schema by ID

+ + + + + +Delete Source Schema by ID + +## 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/delete-source.api.mdx b/docs/api/v3/delete-source.api.mdx new file mode 100644 index 000000000..ac3bfbcbc --- /dev/null +++ b/docs/api/v3/delete-source.api.mdx @@ -0,0 +1,97 @@ +--- +id: delete-source +sidebar_label: Delete Source by ID +hide_title: true +hide_table_of_contents: true +api: eJztW9ty2zgS/RUU92GSlCVZshxHftlSbGfWM85lfdk8OKkJRIISEgrgEKBtxeV/39MAKFGWHDvZ1M4kxZeEIoFG3/s0DFxHOhcFt1KrwyTajRKRCStOdFnEItqIjIjLQtpZtHt+HZ0ZUexpZcWVHZZ2gneRTNSucYPN7pQrPhbR+5v3G5HlY0PfPSET4VUiTFzInFbCOqcTaZhQSSvXUlnmlzWMM5OLWKYyZp4sk4odJkJZMPFKX7bfqSGz+pNQ7FLaCXt9/Osfw/2Xh6822Mnrs+O9g+qXLqoXJ2fP3TvGwbMmYRiWLsSfpSxEAmIs5lnGLDE0fHNIK+CnThmPY10qa5hW+Coqhi4lPo8EKEz1BQiksjB2g0asHeYlS9psGNuSZ8xYbktD9C03n5i4goZJJ+BCebK2kIIIX0jOpgI8J+zXg1P2oUMTWn5+51omNx9goJwXHINEYZyJJOk25zDORqTwAb9kQnaMJ2LKo93ryM5yemuwihpHNxtRpYlo1xalWLWTYCfBEkRIXPFpnhGFXjzoPtt8trWddAdd/uzpZnc76T3rb2+P+ry31RtE5AeFMLlWBh6ApXubPfpveYFhHIscCmItdixsWSg8ytRpkjgTxrJLbpgpMc6YtMyyGVnGz4HraK/0mbFi2gaDMTmosrQQz/NMxs63Ox8NrXa9qgg9+ihiS5osKBKs9Lz6r7eZJW3QFzKfnwiTQY9gNRWFULEgHS2rGDpT5ZSC4XR48vsfxwcnZ0enFBALVdY/wCJQ9IqhbtvlcN+5EPFDbgQ9l5ldZ5+dnYGIU1hls7szSHd6m4N+L+0+63JaybvIfWv9q0RotwrBEz7K4NHS5BmfMZq8hgn2yEx0mSXkzArm6ohpbmeP67zR65ubm/kb4zVdyzxkqXI65QUyT3QcnIhiwzvIJQWbm0DK5yHmsMQFz8q6RHXNesXer5dKLYFLx2h/c3PVG/YyCU9jB0WBbHO3+4504lKOVOBOJt/RSRNhucz2dPIAI76QSrTGBZfEoXAsx5jIQPFCJqTGqS4oXRHJyqxuXHvJraCJdpc95wnk9fLtBWGgJlvw+BNoHT7Ag8+UxHxWTUF6YSmYumNZsSP46OnmoNdPn/Y5R6Lp7myPBinf2tocbA8GtPoUCQIVqBa/ES8KPltZ+lehRIESk2mkfvkZCoFzQ/eOAbc4OQsSirnfBo7GA/RPqcOPnYsZ+GVUUDfgxc/33rD+Dsu4GpfuPR/fUoJqnZ2Qf8IzKRR9yobknvDrQo6lWsdKlYH2D14MfSgcH/z77OAET0RrpToPFbw1IbcEq/CFib50HAcBXEJG9MWusD0JVJ9AIK5MfaA0tewM30o5EgRmhNXXzKiTZmmhp0uhFHv0wR7JtmhvIMPg3ZTbeMJG3GBCqNRPfFFpHQVNPmETJC9RPEYVThJJQqISu1xhMH9GqYoniSsojkBaIpSFgxi6tExpK2OxbIuFKpetgSCQ1o04qhuFggOc3+8nASY4MetROPeWwGKwD3j2mlvm7vR2+Zwpy2NIwal+xrooXO2CbBIAJ6QjMpdB4lHVuHnGohRYieXS3UvPzL7V7lvMS/OAuHuTIf20nGjzDxciBJ8hKOazkbNGZaaQkUKhd5PDqLm5qsAHFhNZ0sRuE7tN7D4wdm9/rLBW+OqgT3cV+pyp0E19XofcC+c9Slct12cHb4IhXW8WINJvb09DN0fd4FVOfch3xEe+lK+2HHN7+Pcjgh9zYy3Zghh0evQSpMhEItl1fC84jhYocWt1tRe6GEk4qFoDEZE1CzbTJeNQWVEq5eCs2WCJFkb9YtmEIz9y1/r4DFjvmhsk2SDJpho11ejnqUYNkmxit4ndHzN2v4gkl7f6Ak5a7PDB08J3t/HOMIBVW8dsHnLzzb06WiFibI6xomXkEI163VE33YlFP+H95OnWIO3FT3t8e6e70x31eztRvdafL+J4HmTLMVWzt7ejUzFA3AVwXKngXMZqnSxv/0G9hUgprVHqmeNm6Bwqfb/Ajv1V7PhKW8gGwsCOxR3bi2fHR3772ZMnvfn9egpav0dtJ9w6SEk+DE1LYxvo2EDHpvw05eenKT8NdGxit4ndHzN2vwo69u+Djv2vgI59RhArJYj1V0LHBLiDoFkKo0CGuIR6FcHGHKLgKew+hrC3vBgLOwd6SyiyN1hzakFr9pKrWQWWzNJOpFqoi9Ibxk5pbFGNxQDOxkiRiiFrSaBb8io5FYRJ4T8sk1Pp4pgEAt1i1hqmFlL5mKn8bb6KVHFWgkOXFDJNe68aPibpLEVK8A8U3D7oGIn6O+5xBmv9T/vB7JgkPiKJ2cFVLATF/Hz/d3vdKYFDMF9Qujjxtr7juIDfM+cKbYS4yn36mkPQBqo3UL0p9025/znKfQPVm9htYvfHjN2vgOoBDd0N1THgwVAdY9ubbI6lXnB/3PX/i9hdqAQOnHszHTusniwwuMMVdGg7qg7TUxqhE9m7UScclXentyM6XU+I0DNTFhlGTKzNzW6ncw0bwTY3bZ7Ltgzn35W+bMd62rnYWpNx6ICpjy7krKSMXccwfHMYWoy202whyXl9pnMLeD07WchNoW93suCL9KtzvzMIwzyZDToVHRzJvQabObqIX4wb3XaOsyIjZDsrspv75PnP1pfk8ETukGOd+r64FsYzcHlLPGL//eIyxAnBbb/6ypWIRQmhjf7eymKvaViPPRe8QC/gz748+u3t6WM2JpDpgrw0hG+FpK4AYfIGLuKS2LA6B0KTXF0pdDmeOMaHSydtKGhYmkFg9k6dCMHOa3co2DHSsVMpTRIuA9Cs948qyyTiQmRU+NoLTZLjyUR1oKEOX5r32BU51w1Ihcepe9t+p1psX1LukVSsaUwQ0Z/ZPs8ruXhNrm9l4h8VtZan1nLUzONbXHjVnsf+5HaMyCUSPDNOW9+8uKfXqtGj1glviOptHkgTgY/l81FxZbVv5mOJXovoLfPxTr2dSFTQ5WnVLZNwbv+QxROtjfgnY+Q6FAbn4xJR9M1sXdKiLRcRrd5mjaWWX7IlW8CDjr8jBIbyzsRHVI8dHNF+Z8SF5AdnWcT8B3TLCfuwJLN7fY6ySSMTHZtv5pkWbNGCLZ8DTODfVyVyLMQ2yeDygHeAvYX9XSYIjNZynqe1Nqs78h03h0pDDFYdFZPv+h+7iwQXnpj7QKPnY5CCCU7PT4zR1aZAi0rTkrKqjYDbGlzlN9OoiLf05vmd/zmTquTfTV6SeLjYL3mtstn3ztJ3ZJK/T979izJek2l+xkwTAC65m1s2dAJ1J/dobXX3jraXJwL/4quLVIek0af4i5yEYepk8oxb8mkX0/GEbkTSdrjglpDfBvmVnro4BNyl4Ed35wiNC4xB0BqgUT6SGei12Vs0ViqGiqmpovO2oPpRh+7qBFp+426h7leGA4CaTktFd0XBRDllHO5xj3UTaeLSJyH0WEpUkmkH4+azqogktyFVtF17UUzN65Q2iCVdfoseuBZsaMLuMBRJFgl3PheCHIvMeRmNW4bf99GG57QmIsuprUMGBZgStRVeHp6uUAQxFf4koYtxJ0wyHRoLItTqeGfYaqOZo1e5NhY96BLn1DJVV05HM3a4f9uXrhfb4c014u90jTiUQ+pjOjntupF1St9X+eb1PArNK0bvyoQusE5gPfpwfU07MtTK3dDrP0tB7f75+0Wn5jpcOBY9ozFOkbZu3zSuW/XRcVDrY/c3pfr947WMVpuIarbYP4jw+EnQtgPmoTkHu25fyLHiP/ido9qUlb+tUNc37+b3D44OTg8iD6LWYYjwAMmRJf8La5cWzQ== +sidebar_class_name: "delete api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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}` + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/delete-tagged-object.api.mdx b/docs/api/v3/delete-tagged-object.api.mdx new file mode 100644 index 000000000..39b45a716 --- /dev/null +++ b/docs/api/v3/delete-tagged-object.api.mdx @@ -0,0 +1,83 @@ +--- +id: delete-tagged-object +sidebar_label: Delete Tagged Object +hide_title: true +hide_table_of_contents: true +api: eJztW1tv2zgW/iuE92HaIrYTx0kavyzcxB14kDbZXKYYpMGUlmibrUxqSCmtN8h/n+8cyrJl57bZYnem8EsriYeH587v0MxNzabKyUxb049rnVqsEpWpczkaqfh48FlFWW2j5lWUO51Na53Lm9qFV+7Amkx9y7p5Nsa3mo5NJ5OjzkQaOVK1q9urjRrePY0FViLw8jWMxMpHTqe0JBY8H2svwqpeSJEFcsvkYmidyMZK+FRFeqgxkE1T1YBIqXRygjnOs1CaWKUS4mzUDAbwRpQkezRWE1nr3IQPnZrPnDYjjCiTT0jC7sFB7+zs95PT47f9ox4GuicnR/2D7nn/+D3eDrrvTrr9n+mx9/68f37Ue4f/8dY/5Pff8Hh6zBPPjg9/PznG3N/45eL0oAdjbNSc+iPXTsG+mcvVqgUUqyXscEn9zBaWIY3VNzlJE9KAV7vduFNrHT+g85NE6R+yIHgqpHBqqJwykbpPHjXcfj3cb2+399R+e2e3NdgZDF63W225s7u9vxe/rlE8OOVTa7zyJFZrs03/VRd/b0VEcWWyBkna3txcpTlINMZFzzlERl2cqix3BgbTQWLSTvlMDGw8FYgrba5lomMSt2BNLGWaJjrimG9+9sT3ZtVkdhb8qaMMyXSQPFaZ1MmBjdVdIVUV9q02qj5yUpOEikWOMFGA47WOMUNMrFMisJwZnemq9oUlGlvijYyhb9DvoFAGZsqcjL6AF2XvYwJdGI35YjZF6LjMsDuWVXtKDnY391vt4W5bytbr9tbezmB/KLe3N/d39vdp9YnyHinvF9aWzsnpytI/K6OcjkRiI3jk3zCIUxK2ZwF4cUzRmZr4x33APJ5gf4rmQFuqWcgrqHptoNy8OTgR7T2RSDPK+bscLRnB1C/OKL3yJJED+kR5A80D42OnR9o8VF0Oe2+7F0dUL057/7roneGJeK3Uwa5BtMYUlhAVsTC2X1niQoGv0guP3IsyFTfEq4LrKygkjV8k1OHNTz2MidgayjzJMKNY/Y4Zi6zF0NlJJZWiUOrFC91QjQ0xoG8TmUVjMZCeSpVh8lfdKFJpVj8qLPlKjJWMlXvZEN041qSkTASyEUwxfwpGQsYxpW5gMMyRyhBGZ2ObZ8LYTEdLdWZuyqo3kAQ6Y4qjRadQckDyx+OkG2U5hGM1F7OwjJZCxMI/kDlYrird+YLR2KRTk8kIWsgkmcKMzlExHUA3nflZpSN3eRQeM6MrK9bt7VwtLnfvgjCHmeWxSOb+CXl3kqD81Fm1cuBaFcnnqaKHasTemLmpqEgYJLV5ckFVumuW+AK7chKvc3edu+vcfWLuLg+eFsioGGXos7UKfS6MBNy2jjfPFejjOHqMFTMihjeFIzcEDFJApF8+nCOxvyhD9OpbSmDwO+KjsJWvCN8t/RG+Dwh+lM6q+IIEZDsGDYaoRCrusNxzidlQwVTbq6u9tW6gEaDmDoiIqunE1OZCwmQuN4YkkX5DxFZ581MmxhL1USIjvA8VkFY1cT21mpDpGkmukeR6N1rvRj/KbrRGkuvcXefu3zN3H0SSpVScLQVO8vlkIt00RFoxTtpKAQIxO6MTZcqxq5bRCjETJcaqVZFDbdDaGmwN9yLVjmU73t3eH7ai3Zbc2dva2xq0W3u1xb3+cp7HZZJVc2rB38GPbGKAuGvguNwguHxmbVw9/sv51JLKGpWeEjfD5jDpVYkdW/ur2PHcWvFOmukMIfkKhjRzG1FNA+2EaN2MFgRSjFAXjUCp0pCLQklPFLg4BI1I9ERz8pIW4Oum9e4wgyohUWZBVq6iTZTkkJArQWIJNVsEloaSakiYDxwYwY5Qnb8jOi1c9F8heXFKGh+RxqL3LVKKEr1E7jt3ne/2IbyjGnEWHHzPQW/odqRBAKAhCDWrxJ1rfL7G5+s9fr3H/xh7/Bqfr3N3nbt/z9z9D/B5gYbux+cgeDI+B21jU5RY6i0F1/8cpnOqFBJweAsbRbnj4+YZBmdcgVCa3zzhqx10q6TWDHch6kFX37yh8Lht3uj4lq+kED4MouUuAf04y1LfaYJOGXjqtiFT3UAhg9OyqbFfG5GdNK+376g/dFEg5BoqWJxHfO7cPekXXUaD7ew0hXKoe7xAsDprRkEL6/MJ8YP86ZIGuXNqc1Q6ZrNBdz+KsOLPEDNFT/GTZ+oGh9GKjtDtwiW3j+nz6/ZDegQm9+hxl/keXAv0AlIuqUfiX81vEJ0R+A6rr9wjmm8o1LC1VhY7JrKWeKOkQ2cQfsN48cuH85diRJCTUz73hHaVph4BSXOCEOGS1p2d59Mk3mWczUdjFrxb+cWEUkgMEygsPpozpcRlvzDCe9T6UxRnNilNUlwPaNbVi5lnYnWtEtoGG3NLUuDp2DRhoaaszHvJWx73BtrgccJfGx9NXRxqqkSatm6iKVTkVk9cpjO95IJezxXiHzNu9cCtztz8yyUpgmkvo3ADJ0IeEwuZeLbWsxcP/OoL/KiRwhfiuiwDWaKQo/o7VzTz2rPlqPCrE7+qHB/Nh7HGflqdJkL5Eh7bYRKLvojG1nr1TyEodCgNLkc5sujZYn2lReucEfXW5oJI9bBkXdeBDlm+IySGCcEkB7Q7MzixwG0mDin5iT2LnP+E3jkWnyo68+dLbKJEGdvIP1tmWrBOC9ZDDfCF/GGPosBCbpMOXAdCABzM/c+VoBB0oeYFXndWdWbf5Dl8+w2iMhefdsJLZ17giifBA0Rd0qAEE7guf/nDuyh40UZVMdbsWGDZgqvyJhb745LdgrzlsRTtmX81fUnj7vz05Ngk0+9dpe+pJH+duvt/qnjrSvMjVpoC7lK48bJFX7AY5AGtrZ7l0WHzWOFfjHKmMq5G18J9GGOYRTZpIjOKac7paKwVnwKkSmaE/DYoruyE8xBwl5IfvR4zGjnQIGk90Kgc6AT8GuID2iwTwcTUYtG9CXD9bIte6wxWPiEnicOZ4wCgJpPcYC7lWD4REuHxiHdj7aM8FCF0XEbNNLMM48pZs4yksCFTNLjZcBN/PKTjYnSiC058ZC340BdnxTAkeaS4QD1X5FQlHGVEV4Xfj/FG5NTHKkmpyUMFBZhSCyu865+vcAQz46EXmmnrRs1ikm8SLZhQqxOCYbuB1o4+pdZn6EgrklMDJSoX7peD6WZ+Ov7cm/dF+Sfc3kzpzImkyUMfEVq3y1q1dcOkTnEbv6Nj+hOAMYQnupsbOp6gTuaWPqMtp9738mreqHCDB7vSM7rEIbJ2+db6ok4vTov77S/FE6/V36nO7KDNTOc9dg2PXxS15jxKTdmz5XrqHftnCAcD39LfHISDHTZfGAhHPwtTVn4coUatbMcPe0e9c/qjBnnPtl88wFsobH8CUjqNng== +sidebar_class_name: "delete api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Delete Tagged Object

+ + + + + +This deletes a tagged object for the specified type. + +## Request + +

Path Parameters

+ +No content. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/delete-tags-to-many-object.api.mdx b/docs/api/v3/delete-tags-to-many-object.api.mdx new file mode 100644 index 000000000..478b8b98c --- /dev/null +++ b/docs/api/v3/delete-tags-to-many-object.api.mdx @@ -0,0 +1,89 @@ +--- +id: delete-tags-to-many-object +sidebar_label: Remove Tags from Multiple Objects +hide_title: true +hide_table_of_contents: true +api: eJztW21v2zgS/iuE7sO2he28Nmny5eA4bs+LJPY5zhWLNGhpiba5lSifKCX1Bfnv98xQkiU7TXq94m63MAo0sjgczuvDGZq+9+K5SmSqY9MLvGMvUKFK1UhO7Sg+l2bRH/+u/NRreFb5WaLThXd8fe9dWZV0YpOqL2k7S2d45+nAHKdyehxJI6fKu3m4aXj4bGkM7KYqEI6X9TASKOsnek7LYtHRTFvRHvREoqL4VllBE8UkiSMRZWGq56ESsZvc+mA+mLZI48/KiDudzmheQ3S6w9HH9ul576Ih+sN3xeOwO+gvB4b9s27t+fLqJP942b8adsrBOCleFBRCQs2Y9BcQNVH/zHQCjdJY+DIMRZor0IKhaFDZ9CQOYKv7FU0vs/k8TlJMdfqIdDGHvjJRot3pdC8vPw6G/be9s24D7AZnvU571OtDok77fNDuvcNT92LUG511z/G3IXqn/PE3pw+pcfpx0Me03wqVColIXO84TTLV8HzynElJOjmfh9pn92/9bknEe8/6MxVJeiLhIHRcxMA8oWBJtbI06l4P1cRWaGWSyAVIdaoi+zwPN1pS2TTRZgoqZbKIIqduFAxUrIJPhVnwWLELPhWGwSNZBn+WpuEPZBsKRPVFRggvrF2ZUvfZ6ajPbvIeoFbwmLR1+t6piCcICVX6eMYxM1GJMr4SbHMK8tirrr/rH+282X7z+uCN/3r3yD/Y3sGTLw8mR9v+zt7OHi1vZPSouUwWhnJMbJyH6wL9LUNSNhMlA6IRgbbzUC4EMfsuSd/rMNQyEvhLIfMAwVKd8pDLdJfop5jGY4wCz0ZIrszDqvRncqxCyrRxIRDnnTSixKZStGvv5Orj295F+6JDPh90egCixhLingy1waB7cYoX593hu64DqYkE/IC4HFvx9ES4kYZDLEpjiKhM4GQky4bapmxlhjQgy9LcLdEW+9vbQiUJ3rPl0ywxmKsnzhV3cRYGQgaBCDKXqMoxypnnfAgTIQsLXhElUgnBLqMkUasvkAVKM0VLnNZZ0gyrQwBDCJCbmhiI0ar53Rmm6u6TLPxcdTkGaThRdh4b61J8d3t/HQcvAJwOhURTaBOwHJalzPFT3EkrbOb7ytpJFopxRuGJwCRDmeV0FxhLy5mciZOgRfEEG69L0EEgYXqXbd8Uw5rpl1KMAeO0oja3MtRskB8En4FKpQ47cfBoRteFfauNak4TqUlCFy4+JgpwvNUBuTSCu4RjWeQ009U9CEu0dsSJDKCv06+TK0NOTaT/Gbx634BxV0ZjviimCB2Usf3IsupQyfHB9tHu/uRgX8rdN/s7h6/HRxO5t7d99ProiFaP4GcUDo8hRX3pd8qoRPsijLH16n/BIEA22J4F4MW/ffthHt9g/xElMtOWaubyCqqBGkKKk85A7B+KUJppxu/ldMUIpnl1uYbV0Nwx7id6qp8EqNPu2/bVGe1uw+7fr7qXeCJea9VU2xQZBVERC7P4ziGRU4DzClWejyqkJV7lXF9BIWlslVC7T3ZhYUyRgyFm5Ks/MqPK2pVv1VTyXcEoXuiWajWQtXgXydSfibG0VBG51H3VRs7P0+ZZbslXYoadSyUvAZdBoElJGQpkI5hi/oL3hSBY5v4kQyorhr0YoGHiVPuq7oulKVd3zgLZzqpOoeSA5M/HSdtPMwjHalazsIyWXMQC8YLccnXpRqsouDCp9KEFSs0FzJgktFcTIOrUlkCoyfbY6Au6ErGqgM1wd+6EKfZnX2b2G/JuEAJ+mqxaOXCr8uTjHcmhEXujcFOOSPl2xZNzqtJdReKLiVZhsMndTe5ucvcbc3d1cJhXPfkolz4766XPlcm7Wdo810qfssIqiLi8yR3JvXFeIv36fpT34aBXX+Y6Lxh/UH3ktvI14dulP9z7MRe0hbNqviAB2Y5OgwmQSAXHLPdSYjaUM9Xe+mpv42SsEaDmkRIRqJmIRZxx5ZxkxpAk0jZEECtrfknFTAIfJVewDgFpVRM057E26aaS3FSSm91osxv9PLvRppLc5O4md/+cuftkJVlKxdmS10k2iyKZLFyk5eOkrRQgKM/fRJly7KrVaoWYibLG8uqVgzfe3RnvTA59tR/I/eBg72iy6x/syteHO4c74/3dQ6+6118v87hMsnpOVfzt/MgmRhF3izouMwgum8ZxUD/+g3kTNSFY40Pnom6GzWHSm7J23D1arx1HcSzoK7SiQrK1GtIsbUSYBtqIaJOCFgRSTIGLRgCqNOSiUNKRApeEDm1DHWlOXtICfJNFsz1JoYpLlNWTUHz2wwwSMhKEMVXNMQJLQ0k1oZoPHLiCnQKdf2B1mrvov6rkxZA0PiONRfeLrxQlelm5v37sfLcH4RPCiEvn4K8c9LpuRxoEABoCh1ll3bmpzzf1+WaP3+zxP8cev6nPN7m7yd0/Z+7+B/V5Xg19vT4HwTfX56BtbYuylnrL9yH+12U6p0ouAYe3iH0/S/i4uajBua5AKJFA89gyiEi6meZtpXxBoZlfINsaZ+Hnprto5tG1NqoOnWBZEoJ+lqZze7y1dQ9/wU8PLTnXLcAYXJYuTHzX8uNo63bvEfShawIu04BfQebzqTNda3OLtNjKiaZAdqjHCzibFzdNLGzP58NP8i+u7iziDDjHbBp0RykPKn4NMefoKH6xTN3iIFrTEbpdJeHDc/r8Y+8pPRyTr+jxmPmeXAv0AlKuqEfi3yxvIV5S6e1WX7uLuNxOqF3bXVusT2S74kTJBH2B+wbjxa/vRy/FlApOTvjMUq2rNHUISJkBQoQBrV2c5tMk3mOSOJu66zXt2vcllEBiEkJh8cFcKiWue7kRLoD0Q0Azm5QmKUYDmnXzovBMoG5VSJtga2lJCjwdmC1YaEvW5r3kDY87A23wGPHb1gfTFKeacEjTxk00uYrc6InreaGXrOj1vUL8peDWdNyazM2+XJHCmfbad/dvfGQxsZChZWt99+KOX7PCj9oovCGuqzKQJXI56t9y+YXXvluOGr8m8avL8cG8n2nspvVpwoGXsDO+8dUT/iyOrfqrEBQ6lAbX0wxZ9N1i3dGiTc6I5u52RaSmW7Kpm6gNWb4zJIZxwSTHtDdzaRKjajOBS8lP7Fnk/Cd0zoH4VNOZX19jCyXKIPbtd8tMCzZpwabDAJvL73YoCizkNunAOOACoLP0PyNBLmgF8xyvR1Gd2W/xHNoafIjKXOz82H04XgJc/iR4gKhLGkAwldbl9350QTjnRdtUzVjFocCqBdflDWPsjit2c/KWh1K0Y/7R9CWN28uzk74JFz8apb+CJH8c3P0/Id4GaX5GpMmLXTqDHC5/adAt2pL6tfzrMssqt9vpDvvzt82Ly+Zrt70rv+tYv2xdu2tdXBjGkkgONlLew1RT0tWW6+eOdDA+U/gfo4wr3AOgw1peaK6ymYcypQxkBPJnWvGJxVzJlOrUBmVBHDFqoDgnqEJfyoymCWgAMRa1sxzrEPxa4j1aQuMjIKgdpDse4Pp7nPeFl4iJAYWUOC3CDOVeFGWGfh8CIbJISATzM7EYaOtnDjLRHRpVaBZz0VnOKvCDgpxM0eLGKIlsf0JH2+iaKyH3zFqIOJufa8OQ5JHcyUtFhipk9xFdvVl4jjfivDlT4ZwcDrxH6acqK5z3RmscwcxY6IXGP06mW/kku0W0YEKNmQuGvRbaUHpFrR265wrfIXdyYlT+Yui8+MVQ8XOjlci6Xx7r/1w/PMoznRqhrTkd4ZHBMteYuV742qv3wphU7YaRvTNqnUF3f0+nPdQaPtBr4AwdJVzfLDs/+gT+7tSHkeazotOG/GuG5mjBZUJ+rLD+/Qk1o26GO0l6kvam0t0P+nSm5o3z31dF7qAikXd4Sf8fex/wzyMkcnEMIn5/7xXHfqBxfIt67LFyJH8gNR8e/g2nPyeg +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + +
    objectRefs object[]
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/delete-transform.api.mdx b/docs/api/v3/delete-transform.api.mdx new file mode 100644 index 000000000..f98ee2ada --- /dev/null +++ b/docs/api/v3/delete-transform.api.mdx @@ -0,0 +1,96 @@ +--- +id: delete-transform +sidebar_label: Delete a transform +hide_title: true +hide_table_of_contents: true +api: eJztW1tTGzkW/iuq3odJUtgG44TBL1sOkC2myITlsnkgVEXuVtsi3VKPpAY8FP99vyN1t28QkmxqZ5LqF7DVR0fnru/I6rvI8YmNhhfRmeHKptrkNrrciBJhYyMLJ7WKhtG+yIQTlrmpYK6mY7YQsUylSNh45h9N5LVQ7HC/y0bOiRyz1YQ5zRI/nfGFuW7KHZOWlRbTpWJaCaYNy7UR7DARykk3Y8dGpzITLOdFAVaW3cgsY0bYMnM0iSsmjNGmyw5TcAQ7HcelsRtspkuWl9axVBr8NSLX12JF/NTonHEwbNiPRUrre3G96Iv03Q9qBGU+QcMb6aYLjGr1SjfVhuSGIEb8UUoD3aB+TIt48UbHh91oI9KFMJxMe5jAuGF6Y348L7jhOcYMOeYuUvgCOpngkSR3FNxNo1UfHe4zna6o2Nge1LVE0dCZUmxE1s0yYmtlXmREIG6LTCcYSnlmiSCeipxHw7vIzQpP6QysEt0TKfeThlE/TnZ+5clkevXpim8Prqb98db009WU21LESXR/SQvbQisrLLHqbw7o37Lov8NGWjl4nXXg10TGvI42klrAgzfcMlvGsbA2LTM2Lh09hrNgVTWfDoXHNMmVRoXACkyCBF2SfbC5uS7BXiZp+gFFE2Q4aRikS1KMdeK9K9U1z2RCvqxWJpYIo4xEB8velSW+d+tG1OMrETtysqEwcDLYJRGOy2zP23/V4KuefiOV6EwMlyShTwDonwgGjtcyocDNQxgTyzooQqJEi76DJbpb7DVPoG/Qb69SBmZCEMWfwItC9CmBzpXEfFZPYTJhCL/HlhU7go9fbe72B+mrAef9XwdbOy/Huynf3t7cfbm7S6vn8DOfBNNUa3Nj+Gxt6X8JJYyMWaaRZfJPGMQIDtt7AfzilDQoRvZpH3geX2D/M+gVaBs1K3mZE7duA4Xu9d4xG+ywjKtJ6cf5ZMUIqnN+ihFVZhkf0xBlJTQPjN8ZOZHqIVGEKnMq1/sHb0bnR2cYOTn49/nBKT4Rr7XSPVJ1RkFUxMJU33iJKwV8XqFExE4kXfai4voCCqGGLBLK8M3OLIyJ2Eo5ijBmVKs/MGORdSi2i6nk8+bWsWeyK7obyFqM5dzFUzbmtCfokLovRsj5wnWOKku+YFPBE2GeY49JEklK8owhG8EU82eU/jxJ5rmflkhl4Uu2RtFQ2slYLPtibsplbyAJpPMUR4tOoeSA5E/HySh2JYTzai5mYRMtlYh1xUsqyy1Ld7ZaBWfK8RhaYFeZwYzGwMK+IEpnm0IoyfY5VzVdU7Hu7+dq+XL3Ngiz77R/FvPSfkHeHWcoPx2vWvPgWlTJZ6kOh2rkvVG7qapIeOi3KZpcUTXuqhMfG7fIkjZ329xtc/cLc3f14UmFeqqnHvpsrUOfc1UBV9o816BPg7BqIg9vKkduEGSvINJv788qdAx6QEmCmt8RH4WtfE34UeOPMD6uYXu99c99QQJ6OwYNUlQikQy93HOJvaGCqbbXV3ujzVgiQNUDEBFV0/i2g8NkplSKJOFoRRItrPrFsSlHfeQewYYKSKuqpFNoqVyLJFsk2e5G7W708+xGLZJsc7fN3R8zdz+LJBupfLZUOMmWec7NLERa9Zy05QwEzfkba1LOu2oVrRAz1mCsaBk5ROP+1ngr3YnFIOGD5NX2btqPX/X5y52tna3xoL8TLe71F/M8bpJsOacW/B386E0MEHcNHFcqBJd1WifLx38lHSWnVNao9DS4GTaHSS/n2PHBM04H3cAY2NE8crx4fnJE/LG0Z09206WJ/cl4MF04NydISTEMS0vrWujYQsd2+2m3n59m+2mhY5u7be7+mLn7VdBx8BR0HHwFdBwwglgpQay/EjomwB0EzVI4BTrEJcyrCDYWUAWfqtPHKu0dNxPhGqC3hCL7u+so8kxr9parWQ2W7NJJpJqbi8obaHOiNTUtXZmoLmmgakmgW4oqmQvCpIgflslc+jwmhcDXzDqj1EGrkDOrv6fje5yVkNAXhUyH2x43XLr6KgU4+HPQCQr1dzzjrLz1P50HsxPS+Ig0Zge3sRCU883578uHbgkcQnhD5eI0+PqR6wLhzJwrtBHitgjlq4GgLVRvoXq73bfb/c+x3bdQvc3dNnd/zNz9CqheoaHHoToIvhiqg7a7yRos9YaC6/+O2H2qVBL48A5Xh/2lhRqDwwhWYFC6mV/kHBB/L4TyqHRTykyZqGFz3XYIHxAqvaRbr7lAEM6v91IBolu7w6jX0NvenUzuI1qF4GTQpDQZiKbOFXbY693BwXDsfZcXsiure9FK33Rjnfeutx8oV3Q7NaQmCl5Sxr7dGB0fVv1J17vFSIr8UCb9AsFJ3hAU43CWv5bwWf50LZm8P0PrwgKbDYYsqaLQD0PMAi3IL9ZTd33UrekI3c5Ndv+UPv/Z/pwegckjejxkvs+uBXoGKVfUI/Ev50FxSlg9rL4WGvP9h34l6K8t9o7I+uy14AaNRLg48+y392fP2YQQqq8QpSVwLCS1FMixY4SIr4Cj+hIJTfKbktHlZOoFHy1d06GMY2kGhdkHdSoEu6jv1v+OreEEtdyblCYJXz5o1uWz2jOJuBYZ7ZrduSUp8BD1PViox5fmPfc7pG8lpKL49qPdD6rD9iUVLkk7PdFUKvrOkF0UtV58Qa9vFeIfNbdO4Nbx3OzzFSmCaS/icO07RtoTC55Zb61vXjzw6yzwo74LI8R1VQayRCXH8uWquPbaN8uxxK9D/Jbl+KDeTyW23+VpLNQsZrF7Zgk7ZPFUayv+yRiFDqXBxaREFn2zWDe0aMdnRKe/uSBSJyzZkR2ASS/fERJDhWDiY9rMPZbR4VjFp+RH71nk/Ee02gn7uKSzH76g90pAmejYfrPMtGCHFuyEGmAr+cOWRoGF3CYdfB0IAbA397+vBJWgCzUv8Hqwqnv2PT+HtoYYonouthiGL8N5gas+Mf+AqBsalGDC4s11M3oFpeJF+9qSsepThFULrsubaWynK3YL8ja/hdIW+3fTlzQezQ9b3qls9r2r9COV5O9Td/+iitdWmp+x0lTomMLNL1u1EYtBHtDa+tGf9a/h4S+e+kz1MBxNTvVW3XT+/h+xKTLu6lfZeDyVwh8aFII7Qn4bFFc693kIuEvJL2xgNDGgQdJaoFE+lhn4ddl7dGUqhompI6PLuuB6pavW7BRWPiYnsf3acQBQeV4qeqcPQpQ54wiPJ7ybSBuXoQihQVOi1kx7GNfMqjOSwoZM0fW9CZqCdymdLqNxXXDiE2vBh7Y6WoYhySPVK4NzRU5E5qOM6Jbh91O8ETmdqcgK6glRQQGmxMIKbw/P1jiCmap+z9Bm0qsm2R7Rggm1OiEYtrvoBGmo0NaheVqSfPWV0dVQupsfpbfvp37f91OrTZG6mV5BB3fkozJ0V6GLvYjmXSwmDGVCLw1P4UZ6dndH5zrU093T8B+loEODi8t5y+ZbXUQYfU6aN04f9e+zk0rc5+yp11wflL0+mlSz+alEhI+fBB1mSHpPFVThtMmLFh6E86iFKWu/2Cx1+vsHRwdnB1FAVw+Bi+oDLIHy+V+lfIgI +sidebar_class_name: "delete api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/disable-account.api.mdx b/docs/api/v3/disable-account.api.mdx new file mode 100644 index 000000000..8962d57ee --- /dev/null +++ b/docs/api/v3/disable-account.api.mdx @@ -0,0 +1,96 @@ +--- +id: disable-account +sidebar_label: Disable Account +hide_title: true +hide_table_of_contents: true +api: eJztW1tv2zgW/iuE9qEXxHZ8ycV+Wbi3QQZpm02T6UMabGmJtjmVSa0oJfUE+e/7nUPKluNc2m6x0xZGgUKRyMNzP9+hyavIZiqXhbbmIIkGUaKdHKVqGMe2NEW0FRVy4qLBWRTeuOh8K0qUi3Od0SRMOZlqJ4ZHB8KVo5kunJCikO6TKKwI1EQxVUJ6AkKaROSqKHPj+D2PPXjRFOKDGWLSJ2XEpS6m4u3xb/8evnh98EbIspjaXBdzgZVy9Z9S5yoh+rFMUxDx6zfBrVNxSQPB8VV06lT+3JpCfS6GoEBS6MQMAiOu4QpZqMFMGjlR0fk1BMtkLmeqULljAprEyySmbkUGH/CXTmiVeKpmMhpcRcU8o7euyLWZRNdbUcVdNCjyUq2raqkHpqQ+y1mWEgk17u6P+71ub0/1ezu7ndHOaLTf6/Tkzm63v5fsR8QfUVeueGaTOa1+c7GYhIXV8ElmWapjtmvrT0eLX9XYXuXq2FMVpYNWxzZfsKgMWa8VrEjO4MW1oz9VTM6R5eQ9hVaOqELPKjcy/UPlehwWJ6e6ud7BWDhVbMETRDVFgFKsnBMXMtUJzEK+IQt2ELCVi0sJi5HJeSD4ZBdh0welNJf8BXPU1dsd99v72/vdnaSjdtq7+9vtnaTbGe/3t2PZ3tlvk+0geqyOcnuhHRglCneyntVGiTKrOK55eQEeRmWBN14KZ0tQh5cLjhfLFMmfWeuXU3h9fT4+GFsINzexd3VlXJmHSFrQpum8eNIUzHhC/Dwib3jkLWlEaVIbfwKRivSlRtDIJOFIrPT+6JSHPRKLdCBGc17t0uafxqm9rOl3ZG2qpKkreCxTp66hxEIXrPCQL07sZJKq4GHR9fU1x4jLrHHeaTrbnXU1D0lunxkSVUiduuibvbtKXEIy0WpxQeSkZgOGNQSERk7IC1IWDw7aiepxTUmEkuD9saBv8XudCDte5Lx73bUTs7v29nq7+91E7m636Wm33407eO7vRLeo2rHWjpUr00rTve3tdTaepxpqFC/zHA7SEMeciyGy9ryFcBIjJBlyMG04JptfY4H7dePV/dwmaj2F3syYr7RRjUkOQ4FDxSzHmOgDkL19ZhEWnmSlXh7XXFEoNNFsi2cyEVW2ex6EIUXmMv4EWj5Z3c/QqdGYL6opSOMcaHcsq/aUHO1u9zu98W5Pys5+r723M+qPZbe73d/p92n1GTwMFcjV1pZ5LudrS/+mDDJrLBCosMhfiuqohO6ZAV4cU3ShZu5hGzCNL9A/VSw/diFm4FdQXUUSF8+eH4nenkilmZT8Xk5uKME0Tt9RCS3TlAsJlytI7gm/zfVEm9tYUaacUcC9ePlqeHp4gjfHL/91+vIdnojWGhIZIqGahNwSrMIXpvaSOQ4CXEqH7J1CHZQvnwaqTyGQDFgkDNT+Lzd3UCZ8aywRUpgRVr9lRp20GOd2thJKsQch4rFuquaWGNG7mSziqRhJyv7W5/6nCGSVFY3DoMmnYqpkovInTTFMEk1ColIiGkEU8+cgRHmcQtcTGJcF1QgqjbYsqIBolJwVWyxVuWqNZTY5rBuFggOcP+wnw7gowRyLWY/ChbcEFoN9wLPX3Cp3JzWlsUrnyNExpADOm0ONeQ4NC5Q+QTgzpCMyl0PiMdW4RcaqJ0lOd689My8Ky99iWboviLujFOmnwaItPlyoEHwVKEE2YmtUZgoZCR854dPkMGphrirwxVirNNnE7iZ2N7H7hbF78+NxQHXhK0Of9jr0OTWhlaTiuQZ9cuVhd9Vv/uVxsDfkloBCAkT6/f1JaFQxXn3OCBh+R3zkS/k6kF3Yw78fEfxYGGvFFsRg6KRIgjEykUoGzPeSY1aUV1V3fbVXNh9pOKi5BSJyRza3pZBQWV4aBtHSbYnEKmceFWIqL7iVoc6CMyCtapJGZrUpNkhygyQ31WhTjX6darRBkpvY3cTuzxm79yLJBVccLQEnuXI2k/nce1r4TtJKgQHL/cVFyLGpbqIVIiYWGCtaRQ7RqNMetcd7seolspfsdvvjTrzbkTt77b32qNfZi+q1/mwZx4sgW42pmr29HVnFAHEXwHGlgXO5wtpkdfsP6s3VmNIapZ4FbobOodLzJXbsrWPHN7aAbCAM7Jjfsb14enxI9LE0kye98Q45wWyvOv8LAEFK3gpXn7UrNtBxAx035WdTfn6Z8rOBjpvY3cTuzxm7XwUdew9Bx95XQMeeIIg1Joj1d0LHBLiDoNkYRoEMcQn1GoKNGUTBU9h9DGFfyHyiigXQW0GRnf46ijyxVryWZl6BJbeyE2mW6qL0hrEzGptXYzFAiglSpBHIWtr63971TBEmhf+IVM80xzEJBLr5vDEcF5DKx0zlb4tVtInTEhxyUkgt7b1a+JiGO6kxwT9Q4H3QCRL1d9zjDNb6n/aDxTFJfEgSi5ef6fwMVLjY/9257ZTAgQknc955W99xXMDvmfMxE/U58+lrAUE3UH0D1TflflPuf41yv4Hqm9jdxO7PGbtfAdUDGrobqmPAF0N1jG1uiwWWekXO9X9H7BwqgQN2b2FjxurJEoMzroArEUOZ5Y1WPvg+iFrVefnWlU6ua4fBfRPgeSrzFEOnRZG5Qat1BVPBRNdNmekmMhisVcyNvWzGdta66N6SeOicqQ8ypK6kjLlx4DsFvEiTFZxrWtknPF7Aq5tFIm+F2vmAwb306Rw/2XGOJkR4MlsC/h78iV+DzQzNxCPHo5vsP2syQrbTPL1+SJ4/uvfJ4YncIcdt6rt3LYwX4PKGeMT++fJqxDtC3X71tQsSy0pC+/2dtcXe0rCOeKZkjpbAH4F5/Pv7kydiQliTY710BHOVpuYA0XIEF+FcNqyOg9AkLi+5LSdTZny4cuCGYkfwkXPxwbxTSpwdBCW8QZI/RlZmldIkxYmAZp0/riyTqAuVUv1rLjVJjqcT04KGWnJl3hOuddwUaIPHGb9tfjAN8UJTCtJUs2lMEJF7PHGWVXLJmlzfysQ/KmoNT63B1NyTG1x41Z7F/gB3jAAmEjJ1rK1vXtzTa9ToUQeFN0T1Jg+kicDH6jGpuLLaN/OxQq9B9Fb5+GDeTzUK6eo04fOWcKiDaSIORDy11ql/CkGuQ2FwNikRRd/M1iUt2uCIaHS2ayw1/JIN3QAsZP4OERjGO5McUVlmVGL9BgmH5Ee2LGL+I1+/+LgiM78+Q/WkkYmN3TfzTAs2aMGGzwEu8B9uOoBZxDbJwHnAO8Dzpf05EwRGaznP07o1qzP5Fs+h0hCDVabisoH/Y7BMcOFJ8AcavRiDFEyoenFwjK53BVpUoVaUVe0H3NTgOr+pRWG8oTfP7+JXTSqWP5q8JPFwuW3y1qTz752l78gkP07e/Zsy3ibT/IqZJuBc2n48Xl6kfFl1JHdfYHz49uCtlwf9nTi06fBvljN0IPWo8vBwfdfQ8VU//I+vnBoYwaM/qi4+KlEnk6WyoCDiJBJPteL9hkzJgqDmFjmynXHghytt6CqZ0CTHGGQJB/grRzoFvaZ4j4bOAPTn1MzROV9Q/dOGru4dzHpEXiFeVJ4CxDablYYu6IKJckZ3Hh9yJ/QRcemzHno7oyrJLOPGxawqBZCfkir4FqLKZ+7tmDam0fPWvOaBteA01T1CKJIsEi71LgU5Vilbncat4v2HaMNVG1OVZtROImUDvanaCq8PTtYogpgJP4XYfNIKk1yLxoII9VbeGbpNNJH0ihoz9L51zsMF6+V97RU/ulpuwf9Q17RD/aLGo5XRbhlJV/pGyLedZ1HVdmL4gO9KV50nepkpdagYc3VFmyrUhl3Ta8Q0dexn58sui7vTMDMJIXmPkh4fB7af8M9CK3e1b2W62gg08+UeQITHT4q2DjAPDTb45b0d5sV/CD8mNE7mjAiqiWu/klDf6Wf4/aJ7x57Xevijt7RzFo3CTfGZ347I5SVe0v+D6AP+4Q9/EZkzKL+/iqrNPYzxdCvodRvyCA/QOYb9F5eMcbE= +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Body

required
+ +Async task details + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/enable-account.api.mdx b/docs/api/v3/enable-account.api.mdx new file mode 100644 index 000000000..35d4116e0 --- /dev/null +++ b/docs/api/v3/enable-account.api.mdx @@ -0,0 +1,96 @@ +--- +id: enable-account +sidebar_label: Enable Account +hide_title: true +hide_table_of_contents: true +api: eJztW1lz2zgS/iso7kOOsiTr8CG9bCmJM+WpHF7Hnjw4rg1EQhImFMAlSDsal//7ft0AJcrykWRTO0lKlSpHIoFG3/01BFxFNlO5LLQ1h0k0iJSRo1QN49iWpoi2okJOXDQ4i8ITF51vRYlyca4zmoMZJ1PtxPDoULhyNNOFE1IU0n0ShRWemJB+rpAmEbkqytw4UUyVH3b4oinEBzPE+E/KiEtdTMXb49/+PXzx+vCNkGUxtbku5gKL5Oo/pc5VQqRjmaYg4pduglGn4pIGgtmr6NSp/Lk1hfpcDEGBBNCJGQRGXMMVslCDmTRyoqLza8iUyVzOVKFyxwQ0SZZJTN2KDF7gm05olXiqZjIaXEXFPKOnrsi1mUTXW1HFXTQo8lKta2mpB6akPstZlhIJNe7uj/u9bm9P9Xs7u53Rzmi03+v05M5ut7+X7EfEH1FXrnhmkzmtfnOxmISFwfBKZlmqY7Zo609Hi1/V2F7l6thTFaWDVsc2X7DoLddKtKP/yQ+8uHb0p4rJL7Kc/KbQyhFV6FnlRqZ/qFyPw+LkTjfXOxwLp4oteIKopghQipVz4kKmOoFZyDdkwQ4CtnJxKWExMjkPBJ/sImz6oJTmkr9gjrp6u+N+e397v7uTdNROe3d/u72TdDvj/f52LNs7+22yHUSP1VFuL7QDo0ThTtaz2ihRZhXHNS8vwMOoLPDES+FsCerwcsGhYpki+TNr/XIKr6/PxwtjC+HmJvaurowrc+XHLGjTdF48aQpmPCF+HpE3PPKWNKI0qY0/gUhF+lIjaGSScCRWen90ysMeiUUiEKM5r3Zp80/j1F7W9DuyNlXS1BU8lqlT11BioQtWeEgVJ3YySVXwsOj6+ppjxGXWOO80ne3OupqHJLfPDIkqpE5d9M3eXeUsIZlotbggclKzAcMaAkIjJ+QFKYsHB+1E9bimJEL57/5Y0Lf4vU6EHS9y3r3u2onZXXt7vd39biJ3t9v0abffjTv43N+JblG1Y60dK1emlaZ729vrbDxPNdQoDvIcDtIQx5yLIbL2vIVwEiMkGXIwbTgmm19jgft149X93CZqPYXezJgvtVGNSQ5DgUPFLMeY6AOQvX1mERaeZKVeHtdcUSg00WyLZzIRVbZ7HoQhReYy/gRaPlndz9Cp0ZgvqilI4xxodyyr9pQc7W73O73xbk/Kzn6vvbcz6o9lt7vd3+n3afUZPAwVyNXWlnku52tL/6YMMmssEKiwyF+K6qiE7pkBXhxTdKFm7mEbMI0v0D9VLD92IWbgV1BdRRIXz54fid6eSKWZlPxcTm4owTRO31EJLdOUCwmXK0juCb/N9USb21hRppxRwL04eDk8fXWCJ8cH/zo9eIdPRGsNhAyRUE1CbglW4QtTe8kcBwEupUP2TqEOypdPA9WnEEgGLBIGav/NzR2UCd8aS4QUZoTVb5lRJy3GuZ2thFLsQYh4rJuquSVG9Gwmi3gqRpKyv/W5/ykCWWVF41XQ5FMxVTJR+ZOmGCaJJiFRKRGNIIr5cxCiPE6h6wmMy4JqBJVGWxZUQDRKzootlqpctcYym7yqG4WCA5w/7CfDuCjBHItZj8KFtwQWg33As9fcKncnNaWxSufI0TGkAM6bQ415Dg0LlD5BEDOkIzKXQ+Ix1bhFxqonSU53rz0zLwrL72JZui+Iu6MU6afBoi1eXKgQfBUoQTZia1RmChkJLznh0+QwamGuKvDFWKs02cTuJnY3sfuFsXvz5XFAdeEtQ5/2OvQ5NaGVpOK5Bn1y5WF31W/+5XGwN+SWgEICRPr9/UloVDFefc4IGH5HfORL+TqQXdjDPx8R/FgYa8UWxGDopEiCMTKRSgbM95JjVpRXVXd9tZc2H2k4qLkFInJHNrelkFBZXhoG0dJticQqZx4VYiovuJWhzoIzIK1qkkZmtSk2SHKDJDfVaFONfp1qtEGSm9jdxO7PGbv3IskFVxwtASe5cjaT+dx7WnhP0kqBAcv9xUXIsaluohUiJhYYK1pFDtGo0x61x3ux6iWyl+x2++NOvNuRO3vtvfao19mL6rX+bBnHiyBbjamavb0dWcUAcRfAcaWBc7nC2mR1+w/qzdWY0hqlngVuhs6h0vMlduytY8c3toBsIAzsmN+xvXh6/IroY2kmT3rjHXKC2V51/hcAgpS8Fa4+a1dsoOMGOm7Kz6b8/DLlZwMdN7G7id2fM3a/Cjr2HoKOva+Ajj1BEGtMEOvvhI4JcAdBszGMAhniEuo1BBsziIJPYfcxhH0h84kqFkBvBUV2+uso8sRa8VqaeQWW3MpOpFmqi9Ibxs5obF6NxQApJkiRRiBraet/e9czRZgU/iNSPdMcxyQQ6ObzxnBcQCofM5W/LVbRJk5LcMhJIbW092rhYxrupMYE/0CB90EnSNTfcY8zWOt/2g8WxyTxK5JYHHym8zNQ4WL/d+e2UwKHJpzMeedtfcdxAb9nzsdM1OfMp68FBN1A9Q1U35T7Tbn/Ncr9BqpvYncTuz9n7H4FVA9o6G6ojgFfDNUxtrktFljqJTnX/x2xc6gEDti9hY0ZqydLDM64Aq5EDGWWN1r54PsgalXn5VtXOrlu+TPhER21J1zoWSrzFCOnRZG5Qat1BUvBQtdNmekmEhiMVcyNvWzGdta66N6Sd+iYqY8xZK6kjLlv4NsEvEiT9ZtrWtnnO17Aa5slImeF1vl8wb306Rg/mXGOHkR4MlsC7h7ciR+DzQy9xCPHo5vsPmsyQrbTPL1+SJ4/uvfJ4YncIcdt6rt3LYwX4PKGeMT++fJmxDsC3X71tfsRy0JC2/2dtcXe0rCOeKZkjo7An4B5/Pv7kydiQlCTQ710hHKVpt4AwXIEF+FUNqxOg9Akri65LSdTZny4ct6GQkfwiXPxwbxTSpwdBiW8QY4/RlJmldIkxXmAZp0/riyTqAuVUvlrLjVJjqcT04KGWnJl3hMuddwTaIOPM37a/GAa4oWmDKSpZNOYICK3eOIsq+SSNbm+lYl/VNQanlqDqbknN7jwqj2L/fntGPFLJGTqWFvfvLin16jRowYKT4jqTR5IE4GP1VNScWW1b+ZjhV6D6K3y8cG8n2rU0dVpwqct4VAG00QcinhqrVP/FIJch8LgbFIiir6ZrUtatMER0ehs11hq+CUbugFUyPy9QmAY70xyRFWZQYn1+yMckh/Zsoj5j3z74uOKzPz4DMWTRiY2dt/MMy3YoAUbPge4wH+46ABmEdskA+cB7wDPl/bnTBAYreU8T+vWrM7kWzyHSkMMVpmKywb+y2CZ4MInwS9o9GIMUjCB6sW5MbrdFWhRgVpRVrUdcFOD6/ymFnXxht48v4sfNalW/mjyksTD5a7JW5POv3eWviOT/Dh592/KeJtM8ytmmgBzaffxeHmP8qBqSO6+v/jw5cFb7w76K3Ho0uHfLGdoQOpR5eHh+qah45t++Iu3nBoYwKM9qu49KlEnk6WyoCDiJBJPteLthkzJgqDmFjmynXHghxttaCqZ0CTHGGQJB/grRzoFvaZ4j37OAPPn1MvRMV9Q/dOGpu4dzHpEXiFeVJ4CxDablYbu54KJckZXHh9yp0S7uPRZD62dUZVklnHjYlaVAshPSRV8CVHlM/d2TPvSaHlrXvPAWnCa6hohFEkWCXd6l4Icq5StTuNW8f5DtOGqjalKM+omkbKB3lRthdeHJ2sUQcyEX0JsPmmFSa5FY0GEeivvDN0mekh6RH0ZWt8a3QN/tXp5UXvFja6WG/A/yv3sULmo5WhltE1GcpW+BfL95llU9ZsYPvCXpH3LiSZmSp0phlxd0WYK9V/X9BjBTJ362fmyveK2NFxcTkIs3qOex8eB6yf8c9DKHe1bea42AM182ftH+PhJ0ZYB5qGxBr+8p8O8+BfhR4TGyZyhQDVx7dcRajj9DL9PdO/Y81rvfvSWdsyiUbghPvPbELm8xEP6O4g+4B+++AvInDr5+VVUbephjKdbYa7bIEf4AJ1j2H8BAH9sYQ== +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Body

required
+ +Async task details + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/execute-saved-search.api.mdx b/docs/api/v3/execute-saved-search.api.mdx new file mode 100644 index 000000000..8d400ab44 --- /dev/null +++ b/docs/api/v3/execute-saved-search.api.mdx @@ -0,0 +1,113 @@ +--- +id: execute-saved-search +sidebar_label: Execute a saved search by ID +hide_title: true +hide_table_of_contents: true +api: eJztXOtz2kgS/1emuA+buBC2MX7gL1cEYx+7xHA8kko5LmeQBphdaaTTwzbn8v9+3T0jIQF+JJu6zaaUVCVi1NPT3dOPXw8SD5WYz6PK6VVlxG+Fw0aCh/aicl2tOCKyQxnE0leV00rnXthJLCIWLwSLAmHLmQTyiCZFNKn2WVWqFT8QIcdJXQemCT2NeBvW1UrAQ+6JWIS47kNFIv+Ax3hLwQ34JJ3KugDdM+bPaPVQ/CcRUQzrOr6deELFNaCO7IXweOX0oRIvA+QRxaFU88pjtYITZChAnjhMRBWE4l7gIk3dbu6f7J0cHp3Yh/WmfbS3D1c2P5o19+z9g/2DyuO1ng7rvfOdJbIvivVxIVTBCkyrDHeZBGuFcj4XsDabLhlnKKSTuBlxle2kQ11nh91J1zXGXZKqK6UNI9BogwnY/bPqzoqsYG3lx7mdenOHkj4n3KTLYIPjt1VacMe/UyLcYVw5bCcELoEES0cwEM7J6BHzkihmU8GC0L+VjnC0A9i+iuE2mooHgStt8obd3yO018PmPvnT34Udo1uE6DuxFFFKp5XZNPq4YJp1e8Agj3PKEc3WHdICF/0l7x7H/LjeOGrsWeANx1bDFk2Ln9gHVoOfNI8PThqHTfsEHYxMtV1MuvWkpFOBGxqTN2thuOv2ZxQW6+Yp8m4xvO9AMMxASWWDh/i0hqbXzIoW1QzX4wP0VYmHCaDVbvcnl+Obdn847PRa427/Eq4vz7sXQAQ3O6PRzWDYP+/2OquBYeffk85ofNMawK0PrZ6+g3zwajDoddvECT61W+8Hre5F/vIGmI07QxzpDMfd8xxxbzIyd/qXl532uD+8GbX/1XnfgqHO5bg77nXed2iVi/6HzvCyddnu3FwM+5MBDHXPiORT7jInejZkhIehXve80/7U7nVuRuPWGIkGrdHoY394djPogw7Iadin2cMJ/Tfq526N+pNhG0fHrQv97w1o0rnoDz/Rx9FvsNZo0sOlhp1BfzhefUZGH7r9Xqp5ug2t9rj7QesAcvymVdvIyy2Iadg/k3OzbAFbHOGHs3E/YlESBH6ICfNOxgupdGpxIEhlvLz075hUs5CDPyR2nISiVoiBnCmBnIbOYn+MPgSeL5+ITumkouT98elIezkRF/L4lWZF61+vBEOpnGEaEZC8aVKaurZLCslIumxF9RWxatThYciXKEssvGhbYisjt4zcMnK/KnJxUnpP48ZWCjtQeLN8ASiQPlHieTxcIsc8uBllwZyB0FvuJmIdaLyy4qNwkAeeWRCw1BgpcutkIMHYMrc9uBevMGQxmV39CU7Xj4+PjxvImAaiwFeRtmx9r77pIy3bFgF6pMWGApxOwaUsAHN2x9FzgS6KZonrArZM50hlcl20hDTq1VCnxt7e5iptF7VknTD0w2dWmgImRyQrFZhZOrXvBz8dEUNdaPvO1sRbFPZcKmHNQy5RQkEi2zDR4GKsGp4fCqZZptFFdMWABUvU9tk77oC+Wr+2UQYdLuT2H8BL4+HnBZooCfNZOgVjegZCPbGsOBZ8erTXrDdmRw3O6yeN/ePDaXPGDw72mofNJq7uwV7yeb4aZWWvuPSFAC+XNnN9G3bkv1TnONieBKDFn6uUxT0gHq+wP6YtTZupaeSFcn0fV6G3edcesMYxc7maJzTO52tGUNZkhA0oOCyf4pCJCM24D8Et1XM1+Kxz3krLhKlNyGtb2pfKQbf0qS9YQBaPVwpQ7AgXzAEog+0YrjugEFdRnlBGuUAC35rxxI1hhll9y4w8azYLfa8QShQ39zF7I2uiVgW0A2MejxH48Agm+Lr47Oj4t3rGkjtsIbgjwrc11nIciUpyl1HSgwaRL7E/5I5DsU8MZglWKqpnfhJjkyrttcK1MmVxN1YloZffFMrG9/HLftKCIgnCkZr5KMy8xYho9gdk1pYrSjdez3RLFXMbtOCY6mw/hCQNmQl0k4AmTTrC7Yog8aiULstY+UpH6e69FgZKNd2zeRK9Iu4GLqQfi1TLbtwKE3wRQkzTpeNupNtkMpLJyTQ57eVTW6SBz2ZSuE4Zu2XslrH7ythdvzk02MrcJeizvwl9JoonYN+QiucG9AmFPtpjKZHuHvRGVhkYxECkXz+OIbD/EHTSJ+4DhHnfER/pUr6JDrP90ONT6pnTzSrsBQpIdtQazCATCeeU5F5JTIbSpjrYXO3cD6cSHFRtgYiQNUO29BPGwWRhohRKwqMqc3wRqV9ituCQHzmhVJ0BcVXlWIEv9YlyiSRLJFlWo7Ia/RzVqESSZeyWsfv3jN1nkWTxNNTgpNWxJB4z6/uoLWdAwNJTPpaFXHZKmUcryIxlGKtSRA6VaX1/uj87tkXD4Q3n6KA5q9tHdX54vH+8P23Ujyv5Wn+1iuMsyIoxldtvvY9kYgBxt4DjEgXOFcW+7xSP/8C8oZhhWsPUk+FmsHktPeQk7NjYxI6Xfgy6AWPAjuETx4uTYU9/TaPZo938JLQFwmxtOv1dM0JK+rpd3Es69C2hYwkdy/JTlp+fo/yU0LGM3TJ2/56x+1XQsfESdGx8BXRsMIRYM4RYfyV0dAB3IDSbwaaADnYC5lUIGwNQBa7M6aMJ+5iHcxFnQK+AIuvNLU9M+D57z9UyBUtR4SRSrcyF6Q1oPaQNU1og4GwOKVIxyFrS149eSE8gJgX/Ya70JMUxKgR8w6XVmsWglY6Z1N+yVaSy3QQkpKTg+nj26oOPSXxMc4bwDzjQOegcEvV3POM0u/WnzoPZEDXuocasc28LgTGfnf8ebntKoAvCh5guRnqvn3hcQJ+ZcwVthLgPdPrKIGgJ1UuoXpb7stz/HOW+hOpl7Jax+/eM3a+A6gYNPQ3VgeDVUB1oa3ssw1Ln6Fz/d8ROoWIkIPdmvk1Y3VlhcMIV4EooUODTQSu9NnZa2aX3eyz9pL6Idh+k87hr3j0DKt0KaMmS0IUJizgOotPd3QfYMNioxxoPZE2aB6uVf1ezfW/39mBL+sGnTXWoQQJzEpvah9aga/qNGpk5lOjJOu3RAtropBj6LBifHjN4lj++C4e7uYRWhGk2VXw+3HgVDYOYAbQUv0REXSMv2tARdJuE7uNL+nw4eE4PzeQJPbaZ79m1gJ6BlGvqofjXuF2w88CI9msC8rR1vmoluNlX13kafLLb0xJuUK5qDn4zUN8QqI9kdfYOvAaaB/2wzJtfP47fsjmiUsoKSYSAWEhsIyCuBuBGlPVa6YMjOIkKUegn8wUp1yo8moNRxmYuGIV9ViMh2FX+Af4h5G8yO04SlDJw1vWbdPcccStcrJS1lbXROaWjdsGKu7ww7y1VRWofpIJLj5v33Cx2JjFZSazuSGNUpG6QXQWpXjyn17cK8Y+Um6W5WcQtersmhTbtla0f9bYh1JEFdyOy1jcvrvlZOX7Ya8EIcl2XAS1h5Cg+UGWnu/bNchT4WcivKMdn9XEhoeQWpzGd4VgEFdN1WJfZC9+PxD8ZQ9fBULmaJxBp3yzWHS5qUURY9b2cSJZe0pIWAEiSrweBobQz8SkWcMIvvj5KobD9QjsLeeELvSf6paAzDV9BnUVKx7ejb5YZF7RwQUvnicjIr8sYOhbENupAeUA7QHu1/5QJjKC5vKh5bc38xH6X5mD5sEFU/a5JcKo/nK6SoLlidAOpMxpI04i/s0fMOL7dq3lhLSsYKz05WLfgpryuDyV0zW5a3uz7TyyrP5q+qHFrdcDSV+7ye2fpJzLJj5N3/6KMV2aanzHTGESMB5XD1S8UdNLe5VtebKv+YC+pASkEE4ljGqN8CGu8unmYiaft0AQIvEt5iBoLaNuoEd14hTJweYwRSxnLXkhBxyCB4DFi3ypGje9RlgHAj6kNml1iNA+BBlJSBHicT6UL/GrsI/SZygYHwh4THz8Grr/7ptkcgQ8N0AXZWeqWAA89L1EwFzNI4jEOzv+C7zoyshOdYqHlVCLVzCeQms1K8w0GBZqiRt1W6EX9GZ6XQyuec9EX1gIPjcxhORgSd8T8UsdKkaFwKYaQrtiAvMQb4sJaCDdA54H6AFBR5FZ43x1vcARmynxD44fzXTMp2kVaYILNnnaGgxr0tjiE/SK05Dm+5hdN8Fc58j8OMV2y7tm6Uz2sviZ4/S+hGMfHfmQ3wOM2lCPRPZTuW68qxb4VJp3ST5+krSs0OgtsdIHy4QHPZrCPe8RhCHhs/K+uV20aRRvYFK8hwmaQj8QzerwZmpc/37KXfltlqybp8aJark4WKnD5h8ADCVCDAlifGJFo+ob5isIa69eA04kb371gH6tn6FOoZ2mvcycDgz69Fz41P9fi6UOOkN/BIP57WvkMfzHXBdpdgYjGHyrpkSHQaL74538AZ2+7 +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Execute a saved search by ID

+ + + + + +Executes the specified saved search. + + +## Request + +

Path Parameters

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. + + +
  • Array [
  • ]
+ +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/export-identity-profiles.api.mdx b/docs/api/v3/export-identity-profiles.api.mdx new file mode 100644 index 000000000..ff34a8623 --- /dev/null +++ b/docs/api/v3/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: eJztHGlz47b1r2DYD0k0pmwdPmc6Ha0sO0pty5XkbFPvjgORkIQsRTIEaa/q8X/vew/gIZE+s02zqb7syiTw8O4LAO+tIBQRj2Xg913ryBKfwyCK+67wYxkvL6NgKj2hrC0r5jNlHV1b6SuWvfu4ZblCOZEMEQrAGM+lYhoQ/i9VLP0Zk+nE0Exk0mfxXLBpEC14zFQoHDmVwmWTJT1Xoe0E/lTOmBLRrXREHdAIecQXIhYRInNvSVzv10RES3jnwxv405MLGVvrSJ3zz8xPFhMRsWDKIqESD7CLA/gZJ5Ff/+CPhGDXP7ZY57LPRjH3XR65rBt4nnAQBrvMlv747TyOQ3W0ve2KW+EhB+uKSy8MpB/XnWCxLV1/m4dyWxk4QEkKx85J+A5pZ4sgEsALzQYYgGRG4tdERgIkMuWeElsgF74IPSCvubuzZSlnLhbcOrq34mWINMO6YiYimKnB6EetJjxYSF8ukoV1BPMW/LP+TVBcMeXABfrr4WGrmpvBdKpEmZ0DegxoAwdJiInnGa6CuOI6u1IJ97xlQax3Mp6zGkmnhowP+Uz6PBYwPwqS2ZzgGMF8NeL4DcLI2P84850g8cu8709ZLY4SUWMyBq4C48MgTDzNSsFq/7THQcw9u4uza8jSMPCVYHPBXVB/kgMOrDCHORjiXZB4YITCWAZITk4zuQH/WE3rRI3dCWTVzAeOuSAxkJn0HZwHZGij5yBoQIURIczhPpvzWwGPQUbEHBwvFyF34i2kBhxHJEBiC+G7sLAfxKgpSuCqNQLyV6K8hjgRtrfcS4TmAo4GtBOVYvNVaBDSU6FEkyDwBPetgp7QzEd1BXwqucWKtUrAVRyBdKyHAhqWdJn4lX2wxLR1MD1st9r74rC9u9ec7E4mB+1mm+/utQ733YMPVkkhT2jpTIsShaInF55yXS39GBywnjZBlfJ/Z9H8RfMHMLMNnt+hjpykT1H1VBJi0AL0UIw6NnlecIevwYV5riL91xEziNQRQqjVpFurHbGa+HWL+aKmn6FQyk/DSAYRxMDiG+sxgSpE5XUCLXgcNCJuK4EcAIrWZb1Fi6wLcgRL/sHFiFxZF+JIP3uZCIHzIDFgPUDcYrlErIePyGntKxXytrmzg/+tsugM0hl0mTq/YcHkF8BRaadaSnHQ8iGHieExQuJh6EmHfML2LwrB3ZdFyaOIoxbIWCxU4bleqRwM1tY0iAED9ARKmiLkdyw1WbfARqkXLwWsTEUa6+v8qGcx4KoGzKZRsCAOxzyaibiYpa3FPdA9Jbzp88SMYBSbeIHzicT3LCkaWtkKVqH2VsF8o9jxeMBwDkIUPsbja6vT7fZGo5vL4eCkf9aDF+bBsPePq95ofNMdXJz0T/H5eDy8Gf100b0ZDa6G3V7hzdX4+5vBEH92O+eXnf7pxQ0AG/eG8ORkMDy/Oe6d9C/64/7gAp6cDn7sDS86FwDidDi4uoRH/ePexbg//ulm8O6HXrewaPYix++sf9Lr/tQ9692Mxp0xPrkYjPsn/W4H4d+Me+eXZ/r5ZWc0ej8YHt9cDs763Z+KT4iOdPXLq3fw/sas1e+N8vWHA1pzeEX/jXqn5zCGfg1/7AMBx73R32/6F+Pe6bBjyBsNCgtqVsGPcQfBjYedixFyhH73T097wNKrd6PusH9ppgN6fz85G7zH+iL3XAYOaJR03yL5/nG9qOZW0zlsHOwctHbdxmGDH+ztNHbd5kF7d3fSnjRbTY4raX/8+rVcqUKPL8nTrK76/ZB1wLNBJnQMft2BWLK0HiCyp3aBvsLzBlOqcdZNJo8G1xq1j+tmoVmzZlpLBQ7FnglfUEBgiS8h4ABD0JuhGQ/SBdbpLMaNRrPV3iUkuDvwvaXOXwpMWl31Ap6+Aj7H8chyB+Bj1CoB7OIL9EMuprsvh9wEwdo7u3bzYNxoH+3sHzX2/1V0VAjOjiXFxBJti8ClEqYiGnCIBvq183vjBYiB4yco77gSXQj4gX8cB5RQPKU0PInnGPQ4auAoSCKnQodW6HxO98dAbOFJSv96r2DVCM6XzElUDEFkCrULo+BlghgmQVBQ8kmaIKNp3IHmPh9CEBUa+hQSq8BfGlXSSJH64orOB8xI1zVREsqXu7l0sOKi4mYKNRMWPZQLUGcl50gG+IXuLbfdNyz25Tzf9wnUcTZqJ/J0xe39BvzeQ0kn+YLB/5gqkXtMs7Vni+29dqVipPMpu4Bi9EkFbezAilW2UqGDr1MgE8S+tPq8Ljb+qZXn0QCbpuhDMYVcfz7M3OKzhXdJWOA5sAvB87Q/0kCxDvGFcIVbZyBSiAzYCAPyZ6Co2AibCx+mOXPuz4A63QVVpFtszhWbCHi/4O6qOho3mC5GzZ1KOyirfd7oMbOBXbp7MoFSDIu84FFXWWphZQgdFLDpxEDeJIkhCmHH9nk3fSym0gcsgDW0dMZDnkICDoQhlm26CZzoJrUClqL4XTN/Htwh9mlag+WJqRsxEnNdRnBnXrEANaBLsgNLdoRS5VpD+KigFTkAcnjCnU/YpKI+VAAxGuEsAkCI+lNKt6uy+Lad0oaNcg23nqcJj2vgujJktIwj7isUVbFifGUlmYkEVNVAMykNvpD00/jNMjPL/CqpxsWL/EExY6xeJrdyKJylh64mQ/g4Q7VaTkpwFQJXHiexIIdXevfyanHBn2cLrq1VSH4danBm/LKKAq6UH3ddgsO9yxUMub9crR2yft86jIePD+uId6KJBGSjJfsklrZur4ZcRrRZAulaBB7XX7KFiHlmYbmXLlJ0n6OvZW8JmyS2ZWlvZ56eL01gTZ/TTpQJMfv7/KC5J/YOdhrwy9mZ7LRc3uC7Le3P0wx4XKEBxff9dW3MJqzCKY0zDq3g63qfHUHMGgqs+IZpIKqS0DOJJlefhtTH6lcG7Mz3JglE9CoNk26mXwDLtO7WKtzJQevAFYe2Ozmc2HziTG2x196z3fa0ud/mbrvZOkDyIqLmMSNdSdu57ycct3twRnXEKVixHlavFMejvISxEArHUPhgbeOiOMoW3fddLLsomBlPq3czKKirSwHpHowwsb4QWlKdrQp4r3TCD9g2XCfLgKsk2bxL2wWmRnx4IDVsV7Ucu5De+DHrRRGgbbNhYVtG85e2W9gkcJcYUKQPnJDuW3qPj3g8F2xdet3AfYHfO4EYYs8iLhFDQSg7MBEj3610MebR9ogGmaoIjVtVW+BEvcHecZcNDX1dQ4z2984ngFVtNqsIXek+RzoFTSYVf8WyYl/wyd7OYbM93WtzDjltY393cjjlrdbO4e7hIa6+gPyAz0RVqF1d+hSzEukwL4AUUP4bGAJ5rjJhlBZ/KjqvyoBgvDDu6LEZmQZfFovP8RaE93fdS9beZx6knwk957M1Jvj21aiqBteAB5DJysquQFrgHPdOOldn2B803VNrC2GVCp4OpBLahgNKTymbywm4g2RYCUzmMJWuGag1IAh8d3Gg1H8p6nExY7Aww6xeMaMIOu9kp6ZEdvM5Zt/KuqhvQZaMXR4eQxo5QW+U5uy1joPuyz4znKyZLdbv6qyTheY0A1xA1jGB2Om6et9E75qDKQvaPAiSGDcwTQM9l0XOyvVYkjqWs6JQ0DgA8+f1BMoj9OFEZtEKM20xKBr5AM6ac6vYjQtMI5biBhEUXrrkcYIIiy8GPpfJWDHjjmifBhyPn47LPFbRX5K7O9fIUFcL24I8US+wu0sP3I9NpGUvboUxPspjtDciaaRiMh7JlEI02YzKxJUavt5J2tjuxnY3tvtC211/OTQbreYtpT6Ncupz5ZsGHAbPUuoTkfb4AUsH6WJOC3ILewEmRfrh/RgMGyp0pk+mYcvnC+ZHOpSXkO9k8jAb5ul+ehr6c1kggsRHTcEUPJFwjwjvHGOdJBKrWuXVTgIo3EBB/YoUEbxmxJZBwjiwLEp8n87mqC3mBkL538TmVI6DnQ/tAakx4dp6e36TSW4yyU002kSjP0002mSSG9vd2O7XabtPZpIZVmQtJk9SyWLBo6XWNPMeqeUMBuTHozOTI1GtZysIjGU5lrWaOViTZmPSmO47ou3ytrvXOpw2nb0m391v7Dcm7ea+VYz117kdZ0a2alMFeWs5ms2L6BbyuMQH5VJxELir7b8Ej25O0a2h68nyZuB5Hfv8ae7YPKzYGgkCdo5dfZMhqZUc0s95hD4Nxi5wbJSOlbibOQO/6OOxbhnonrRcCIBCm3J0dpx2QwFfgBst7c4UTwybE+lGybJVpO94iWt299INyjsucb9yijkfQKAMdgbe+Qtmp0ZEvymTZ0Ok+AwpZtjdxm1glmXuu1X93T4gH6GPGGkBP9Lo1dUO90EBoCDQPivLOzf5+SY/38T4TYz/c8T4TX6+sd2N7X6dtvuK/NxkQ4/n5zDgxfk5jK3vsCyXOqE9+987TSdTMRiQerPAcZKI2s1pDk63YeAhnWOFRa4gr+9qVe5A0o6WKV3/KD1uYpszY0d4RtL6iMcNFgI0EemZ0c3ckOMsa3t9htrWF2jwXA1llpqoJPJgdHod6x5kDTJ+qPNQ1lMIfnBHd7JuWxWeC48YqPQ0m5vom154A0wvUicJRRKNQHtMWkDLy5yksLKrX0/CT0+RLIMEfCSB2cJDVUYh6TGgGUI18o0y1ywe6ILkGo1A21XkPTxHj7nJ9ggdGsgjdFSx78m1YDwDLNfIs/R5klQ/Rpi269VLWpKHIiz1mqXFBjisyd4JHkFNoXc/vv3h/fg7VrgDQlf8hMTqAsztElSEnGEn3QnASRSf8hvanZW9FjQ+NvWAYGYu3KbnXC4gSgzBrRNLcZIgT4KzXn4ZkK/Me+R67QffNsd88YAojTEk6ivI12FKFy/Q9VYk/pJCszU0m6DhRcQVLDRrrx19dscBD4AguKeIW29eXMOzC/CwBIMnCHUdB+SEwWN1h8xJpfZmPFbg2QhvFY8P/ns6q706jWnPxdSc7pj3mTMPAiX+xhiqDprB9SwBK3ozWnRA3CaLsJs7BZRsvaQtbcgrCb8zMAxfKxOfYFw3R4mnEEu1Sf5MkgWb/5mu/f68QjM9vobwiyPdwHnFDdc1nHFBGxe0tQ9QBn8d3VCx8Cgg0EB+QCtAN5c/eQKDaMHnaViVXp3Ab9McDA0OoEpQVHik/zjKHZz5xegFjs7GgAu26NCq2TPEk9wG1kN+cUIzK20orHOwjK8XQGRd45vGN2toYbT9o9GLFHfyvgve0vrSXvoRT/LH8bv/I4+38TR/Rk9jEmVUN1p27RAtKrnO1spdQEWfQYF/4S1ZKmXkUO/kXz4pggk9HtO5fLRpZy4F9Q9CwWPM/LZQr4IF2aG5GiLMbf8Z3VGNAGEOFZ/0AF6dvYcCzXeAxVic4YkLgPpLYKq0EXD5EoXEjlPBMby2mfjmTlqyYBzU4xnpulI5iXZCUKv5IqUsoDQum5VaJKoNsoION4tooQbTkb6qXxDiM2uBDJXpMnN9P9l8pCInZCg8fUMHxq2m38/BBs2x58ILsTwEDwrJlCiscN4flyACMF9fFagH0WzbTFLbOBaAZF84sFp1KArxURioGGrZAlx9ALt0BFytK9R93lv/r37ZysQJTPC3Q2xrIdqJLjh0hXdtlSo8KvOpxoOqYQ404qj7e+x/YMHzgI/1Z0Ww8gOGmztMVTfaioR+XV/LqmTdJ4EdhfRjYKZnYNEdmJfz4f/rM1dP8DH7DNgbGbn5ZtXX982qJ9Qh/TDZG7Vh88Go3/LBqCclk38G7I2y+b/+BtSTrM0/yJWz9mPeJIQQi7cptceieKun6e2HwqzSBv1KT/e0h/kOf6R6ND9wqYeH/wDp2kj5 +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Export Identity Profiles

+ + + + + +This exports existing identity profiles in the format specified by the sp-config service. + +## Request + +

Query Parameters

+ +List of export objects with identity profiles. + +
Schema
  • Array [
    • self object
    + +Self block for exported object. + +
    object object
    owner objectnullable
    + +The owner of the Identity Profile. + +
    authoritativeSource objectrequired
    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[]
  • Array [
    • transformDefinition object
    + +The seaspray transformation definition. + +
    attributes object
    + +Arbitrary key-value pairs to store any metadata for the object + +
  • ]
    • identityExceptionReportReference objectnullable
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/export-non-employee-records.api.mdx b/docs/api/v3/export-non-employee-records.api.mdx new file mode 100644 index 000000000..c37840b82 --- /dev/null +++ b/docs/api/v3/export-non-employee-records.api.mdx @@ -0,0 +1,95 @@ +--- +id: export-non-employee-records +sidebar_label: Exports Non-Employee Records to CSV +hide_title: true +hide_table_of_contents: true +api: eJztW1tv2zgW/iuE92GawrIdx06avOykaTpIkV42l+lDGqC0RNvsSKSWlNJ6g/z3/Q5JyVacNm222E4LAb0oInl47uc7DHXd0bkwvJBaHSWdvY74lGtTvNLqMMtTvRDiRMTaJLbT7RR8Zjt7Fx0MRtUoO5ZTES/iVLCXXPGZyIQqOpfdTiJsbGROdEH1bC4tM+LfpbCFZZwdnP7JEv1RpZonbKoN42nKFOiKQNeyqdEZZuZGX8lEJMzq0sSix05ARRpMMBqbxloV4lPB9JS9l4naU8KaPSN48h4M59zwTBTCENvXHUmc5LyYY0hhAD/JpHOb1VO3DztK2KPz86NnG5hg/JZQT2FK0e3YeC4y3tm77hSLnMjYwkg169x0oT4OCeid2NzaHm/vJOLJjhglg+Gu2B5MtuKteDxOJuPtpHNzSZRtrpUVlogNBwP6r8nOobMH5IfKwIqTFxqmvSF3P7ZX9LzclsexLlXxCvJ1p9JY/5Ty8JDPtRJdcC/TbuYMZrq24KZ4xgu8Vwn9/0690Kp3msli3mV47LLwPB6Po/B33GUftPodf3uJFj0FL+rFOsN8mVXTh4PhIBqMosH4bPBkbzDAn2iT/u36kSfRYOdsc3d15J16K9NU8qx3MOfTqcTe4UWX1W+abHz047/Hftiu8PJUmAIusFz5II46Nzew7Ogu6xykEtZgh8bAhyP4ZlEaBWPJKSvmovJ4NtHJgiECpLriqUx6TUPyPE9l7EKw/8ES3et1F9OTDyIuyKkNBWwhvc8kooApD3Qi1t3xtmc/l0pEM8MlcSgcyzEWhhDDCpZpI5gnSRFFIrh5xPDSxaCJ3iZ7isg9CfIdBGGgJug7/gu0KJncx9C5kljPqiVM+lzwmW3FjuCT7cHucDTdHnE+fDLa3BlPdqd8a2uwO97dpd0zYS182q7szY3hi7Wt/xBKGBmzVMewyH+gECQN6N4x4DbHElmIzN5vA0fjK/R/Brn83FrMwC+jWO4i2z09eMNGOyzlala693x2SwkqOj+l/FWmKZ/QK0pJkNwTfm3kTKq7WBGqzCh5Pzt8vn9+fIY3J4f/Oj88xRPRWsvY+wrempBbglX4wlx/dBwHAT5yy6xIoQ6R9NjjQPUxBOLKrk6U/ie7sFAmfGvKy7TAirD7HStWSfsqsBpKVcJ/JHui12UTepfxIp6zCbdYABPS9Mf7cSzyIjoOmnzM5igKwmz02H6SSBKSpwzRCKJYvwAhxhOqM9ITmJYIZTCDRKbLArWpkKg+DVssVdm0BoJAFm7G8apRKDjA+f1+sh8XJZir6lodDrW3BBaDfcCz11yTu7MVpTmVLlTBY0iBUruAGo2BhtkEskmU5JCOyFwWiUdV8+qMRSmwEsulu5eemWeFdmMxL+1XxN2bFOkncqLVA1ciBB/cQFcFn6xRmSlkJAyS2G5xDQuCLqrAZ1Mp0qSN3TZ229j9yti9PXgSMGkYddBncx36nCteQr/GFc816GOc9yjNqkkO3gRDdhkUEiDSi7dnCOy/hKL5aD4IZ39HfORL+Rrz+7U9/PsJwY/aWA1bEINOj16CKTKRSPYc30uOnaK8qrbWd3uuzUTCQdUdEBFZ07CFLhmHykypFHHCbRftkbDqt4LNOfIjUD349RmQdlVJlGupihZJtkiyrUZtNfp1qlGLJNvYbWP354zdLyLJmisXLQEn2TLLuFl4TwvjJC1nmMCq01FWh5wz1W20QsRYjbE6TeTQmQw3J5vTnViMEj5Ktrd2p8N4e8jHO5s7m5PRcKezWusvlnFcB1kzplbs7e3oVAwQdwUcVyo4ly20TprHf1CvEVNKa5R6atwMnUOll0vsOFrHjq90AdlAGNjRfOZ48fzkmOhja0ee9OYPsSloneownRcOUpIPQ9PSFi10bKFjW37a8vPLlJ8WOrax28buzxm73wQdR/dBx9E3QMcRI4g1JYj1I6FjAtxB0GwKo0CGuIR6FcHGHKLgKZw+hrAvuJmJogZ6DRQ53F1HkWda0/2MRQWWbOMkUi3VRekNczOaW9/XwATOZkiRiiFrSaBb8iqZCcKk8B+Wyky6OCaBQNcsov1pAal8zFT+Vu8iVZyW4NAlhVTT2auGj0m4k5gS/AMFdw46Q6L+jmecwVr/03kwOyGJj0lidvgpFoJivj7/Hd91S+AIzBtKF6fe1p+5LuDPzLlCGyE+5T591RC0heotVG/LfVvuf41y30L1Nnbb2P05Y/cboHpAQ5+H6pjw1VAdc3sDVmOp5+Rc/3fE7kIlcODcm+nYYfVkicEdroArEUNA6ZRD6NLxXqe/esM58tDd9q9lctMYsf3qajSW+vbAc1uaFFTmRZHbvX7/GkaE8W56PJc95DbYsVgo/ZGuvvavtu5ISXQD1YcfklpSxq6l2H9zFHqQnlO9keTdPhW6DbwhnLDkxzCIu3rwRfp0vZosvICMzJPpMkRC8DT3GmzmaDN+s252z3nWmoyQ7dykN/fJ8+fWl+TwRD4jx13q++JemM/A5S3xiP1LMhe8AYScvc7Bz4HPYfslecDF5eqcU8LsnsO1mcs6RL8tGK4x9JqmDdlTwQ0aCn+B5tGLt2cbbEZI1WWK0hJIFpJaC8TaG7iRy4T71WUSWuSKk9HlbO6E229c16HIY9MUSmHv1KkQ7OIoKOoVSsQJcrpTOy0SLo3QqstHlfUScSVSqp69pbbJOWWi+tBinzfWbbhK6VoKqfCYube9dypizyQlMEkVn+YEEV2HyC7ySi6+ItdDmfhHRS3y1CJHzW7c4sKr9iL2179jhD+R4Kl12nrw5p5etEKP+i+8Iaq3eSBNBD6al6ziymoP5qNBLyJ6TT7eqbdziTLcXMZ81mMWVTRN2BGL51pb8U/GyHUoVC5mJSLtwWx9pE0jFxHRcLDCUuS3jGQEUOn4O0ZgKO9MfEJF3WEa7Y9XXNi+d5ZFXniPljth7xsyu9cXqL00M9GxfTDPtGFEG0Y+T9jAvy9t5FiIbZLB5QHvAAdL+7tMEBhdyYue1p2Z35HvuzVUPmKw6qjYfM//sLdMguGJuQGaXc9Bmu64j0nCtTP6PifQovrWUFZ1mnBbg+v8phpl9ZbePL/170Sp1P7d5CWJ95eHLq9VuvjeWfozmeTvk3d/UMZrM82vmGkCSiZ3c9uGdmLVyT2iWz8CpDPqucC/GHWR6uA4mh3XvjkMs0omT3lBPu1iOp5L4Q4PcsELQodd8iuduTgEJKbgR4voCM0M5iBoLRArn8gU9HrsLbozFUPF1JnRpV1Q/aBDi3YKLb8hI7FnleEAoLKsVFhLMVZmjMM97rFuIm1c+iSERk2JSjLtYFy9qopIchtSRc/1KCazr6d0yowGdsWI9+wFG9pwxAxFkkXC55FLQU5E6ryM5jUh+n204TnRXKQ59YbIoABTYmWHl0dnaxRBTIXfa2gz64dFtk9zQYTaIe8MWz10hPQq17ZAI7tC1382aVnjW9XwKSup1n9N2fCt6+UZ+w/6XjUUE/dhZ04HXyRb6TsX30JedO5qIbF0z33J2uCI5Kv6SHQdc+iICFxf0+EJNVU39BoiUmd+cbnsmVzvAvPRM3rYKZKD+IKuHgUJkw12x7ezd8pUHfmpxbLb7+DxL0GHBJK+jcUsf4rjuPED/pxnZUn9CSy1VXXP/cch/OTmvxEBMuw= +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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` + +## Request + +

Path Parameters

+ +Exported CSV + +
Schema
    any
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/export-non-employee-source-schema-template.api.mdx b/docs/api/v3/export-non-employee-source-schema-template.api.mdx new file mode 100644 index 000000000..3c1cff490 --- /dev/null +++ b/docs/api/v3/export-non-employee-source-schema-template.api.mdx @@ -0,0 +1,95 @@ +--- +id: export-non-employee-source-schema-template +sidebar_label: Exports Source Schema Template +hide_title: true +hide_table_of_contents: true +api: eJztW1tTGzkW/isq78OElNsGYyDwsuUAmWKKXJbL5oFQFblbtpVpSz2SmsRL8d/3O5K6bWMTkmxqM0n1S2J3S0ffueo7Qr5t6UIY7qRWJ1nroCU+Fdq4V1odT4tcz4Q416VJxXk6EVN+IfCQO9Fqtxwf29bBVQsjk2ooO5Ujkc7SXLCXXPGxmArlWtftViZsamRBi2CJi4m0zIi/SmGdZZxl+qPKNc/YSBvmJoKFJVlYk1WL+tecFUbfyExkzPpRHXYGSdIIiNRYONXKiU+O6RF7LzN1oIQ1B0bw7D1AF9zwqXDCEPTbliQ0BXcTvFJ4gW8ya92HG9GcZOzJ5eXJ0QYGmLAk7OVMKdowGgdGmi9G289G+/3t/p7Y7+/s9oY7w+Gzfq/Pd3a39/eyZ5hsvVqtg9uWmxU0xzoj1bh1d3dNkm2hlRWW3vc2N+m/ZTjH3kHQf72VsIA3AQxPK8AU3dTe0Oc5SJ6mulTuFVRuj6Sx4VPO44diopVoQ6jM21PvR9O2jht3BPltoTL6/50C4Lt2q78O42EuAYAdGwOXJfCQK40CZDny/o2+Z0OdzRhiQaobnsuss4ydF0UuUx+Z3Q+W5N6u2k4PP4jUkWsNxbGTwXKZcEB/qDOxauf7/n0hlUjGhktCKDzkFBNjoGEGm2ojWBBJcUUq+HEEeG5VWKKzxZ4jjs+ifodRGZjJGZ7+CVmUY48BulQS81k1hcl5ZqxZVuwJPtzd3O/1R7t9znvP+lt7O8P9Ed/e3tzf2d+n1afCWrjRLqzNjeGzlaV/F0oYmbJcp/DIf2AQpA5s7wH4xTFFOjG1j/vAy/gC+19ArzC2VjPiZRS+beT888M3rL/Hcq7GpX/Ox/eMoJLLc8riMs/5kB5RYkLzIPi1kWOp1kERqpxSGTs6fjG4PL3Ak7Pjf10en+MTyVqpXQOFaM0oLAEVsTDRHz3iqMBHbpkVOcwhsg57GqU+hUJc2cWBMnyzMwtjIrZGvMwdZsTV18xYFM1GRk+XUqkqe09kR3TabEjPptylEzbkFhPgQhr+dJCmonDJabTkUzZBaRRmo8MGWSZJSZ4zZCOEYv4MghjPqNrKIGBUIpUBRrqJLh1T2knU4CVfzE257A0kgXR+xOmiUyg5gPzxOBmkrgS4qrrX6VBHS4QY/QPMwXLL6C4WjOZNOlOOp9CC5/kMZjQGFmZD6CaxOcVyRO6yKDyqGldXLCqBlVq+3L0MYI6c9u9SXtovyLs3OcpP4lWrX9yImHwIA11te+SNyk2xIuElqe0n15tjtEWV+GwkRZ41udvkbpO7X5i791+eRWYW33rqs7VKfS4VL2Ff4zfPFepjfPQozapBnt5ER7YZDBIp0h9vL5DYfwpF48HJiW1+R34UtvIV8IPaH+H5kOhH7awlXxBAb8egwQiVSGQHHvccsTdUMNX26movtBlKBKhaQxFRNQ2b6ZJxmMyUShESbttoFoRVvzk24aiPILLAGyograqypNBSuYZJNkyy2Y2a3ejX2Y0aJtnkbpO7P2fufpZJ1qh8tkSeZMvplJtZiLT4nrTlDANYdUbI6pTzrrrPVkgYqzlWa5k5tIa9reHWaC8V/Yz3s93t/VEv3e3xnb2tva1hv7fXWtzrr+Z5XCfZck4t+Dv40ZsYJO4GPK5UCC7rtM6Wj/9gXiNGVNao9NS8GTaHSa/n3LG/yh1faQfdIBjc0TxwvHh5dkrysbQXT3YLR6aUtN50GM6dp5QUw7C0tK6hjg11bLafZvv5Zbafhjo2udvk7s+Zu19FHfuPUcf+V1DHPiOKNSKK9SOpYwbeQdRsBKdAh7SEeRXRxgKq4FM8fYxp77gZC1cTvSUW2dtfZZEXWtNNhVlFluzSSaSam4vKG8ZOaWx9cwEDOBujRCqGqiXBbimq5FQQJ6ULC7mcSp/HpBDkmlkyGDloFXKmird6FanSvARCXxRyTWevGjEmEU5iRPQPEvw56BiF+juecUZv/U/nweyMND4ljdnxp1QIyvn6/Hdn3S2BE4A3VC7Og68fuC4Qzsy5QhshPhWhfNUUtKHqDVVvtvtmu/81tvuGqje52+Tuz5m7X0HVIxt6mKpjwBdTdYztbLKaS72g4Pq/M3afKhGBD2+mU8/VszkH97wCoUSAwNKphtDV24NWV2mViHiHOAnU3XZvZXbXDfwt4Q5hAj8Ji5oX7rl2q1vDkBN6hQC9NDlETpwr7EG3ewuPwpN3HV7IDgodnOpmSn/spHravdleU5/oOmrIRVS4rEx9fzF4cxIbko73g5EU6qEu+gWCV7zmFNTwjr+H8Fn5dOOY3D2DwiyIaTOkRQw7/xgwC/Qcv1k/uuPDbEVH6HZp8rvH9Pn39uf0CEIe0GOd+T67FsYzoLynHsG/JnchNCDI++sSeA5DQRuUFA5X14tj/O3mgHBl5HxToj8d9FYAvaZhPfZccIPuItymefLH24sNNiba6stGaYkxC0l9BhLvDcLIl8VBdbOEJvmdyuhyPPHKDZbu7lAaslEOo7B36lwIdnUSDfUK+8UZCrw3O00SvqbQrOsnlfcycSNy2ko7c2tTcMpMdWHFLl+at+G3Td9fSIWPU/+0804l7EhSNZO0/dOYqKJvF9lVUenFF/T6VhD/qKQlQVripdmNeyiCaa/ScBc8RS0gETy33lrfvHiQlyzIo2YMT0jqfQxkiYhj+cZVWnntm3EsyUtI3jKOd+rtRGJPXp7GQglkFltqnrETlk60tuKfjFHoUKpcjUtk2jfD+kiLJj4jkt7mAqQkLJnIBAzT4ztFYqgQTHxIO7wnODqctfi0fe89i7rwHv13xt4v6ewfX2EjppGZTu03Y6YFE1owCXXCRvxhn6PAQm6TDr4OhAA4nPvfV4IIdKEuBllrK78X3/VzaPtIAdVLscVB+HIwL4LxE/MvaHQ9BmW65X9MEe+g4TuLsmizWzJWdbRw34KreHONPfae3QLe+g+ktO/+3fQljQfzE5jXKp997yr9QCX5+9TdH1TxmkrzK1aaSJkp3PyysbdYDPLA6FbPA+nAeiLwL976TPXcHJ2P7+U8h1kUQ3yaYtrndDqRwp8kFII7Yodtiis99XkISkzJj37RCxobjEHSWjBWPpQ55HXYW7RqKoWJqU2jG7yQ+kHHfu0cVn5DTmJHleNAoKbTUmEu5Vg5ZRzh8Yh3M2nTMhQhdG1KVJppT+PqWVVGUtiQKTq+YTFT+3pER87oZhec+Mha8KGN580wJHkk/mJwrsiZyH2U0bhliv6YbEROMhF5QY0iKijIlFhY4eXJxYpECFPxjxzajLtxku3SWAihdigEw3YH7SE9KrR16GoX5IZfEtqHf0i4FFa387P2H/gLzriX+N81FnQIRqqVoXEJ7eRVa107iakH/redD3eUpHDVU6IDmcBeJO32lk5VqMG6o8fQmVr2q+t5/+T7GLiSPqO5HaFQiM8Y70lUN9tga35aulbB6ixQzebHAC18/FPQ6QH0Qo8NxP54x6MJL8IB0MKU+ueg1GLVzfjvx4iZu/8CN2UArg== +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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` + +## Request + +

Path Parameters

+ +Exported Source Schema Template + +
Schema
    any
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/forward-access-request.api.mdx b/docs/api/v3/forward-access-request.api.mdx new file mode 100644 index 000000000..5181c455e --- /dev/null +++ b/docs/api/v3/forward-access-request.api.mdx @@ -0,0 +1,103 @@ +--- +id: forward-access-request +sidebar_label: Forwards an access request approval. +hide_title: true +hide_table_of_contents: true +api: eJztW1tzEzkW/iuq3ocBKr7GSUhetkyAqUwFwoZkeQipRe6WbUFb6ukLiTeV/77fOVK33XZuZKgdoBooym4fHZ27vqOWrgKbqFTm2pqDKNgLxja9kGk0DEOVZcfqz0JlebAR5HKSBXtngXsu/A9imCSp/SrjLDjfCCKVhalOiBUYnUx1JpSJEqtNLjzbTEgjpOOReh7S8xC5FVIYdSHshVFpWxyZeC7yqXLfhR3zl4pcmkgcHf/+n+HLNwdvRZGpFNxTEMSxvVARsYNmmHiGcZBFhiRZG8okMpUzlWMAVLoKNImbyHyKnwx+wLdyEphkI8jCqZrJYO8qyOcJ/ZrlqTaT4HojIB10qmC4PC3UugmU0NGq4CSBupSzJCZe/XC397z7fLTT3x2MlNzs9vBpa/t5iH/dbl8F1+duGpjqhY3mJEZ9lgNDOrIHhRzZIufZvMFhh+V5V+UNrcmVyYkpyGIdMpvO54w4X61rbkefVZjXGJ0FcNkReYiNFdrZjDhCakwLB+RaZcRhiWrNkjcZ7qAyXBUSNxmOTLXV3w23uz18CuX2eLcb9jZ7AxDPtDlUZgLH7vXwTV6W3/pbW9cLUR8kjicWZEtNZh3Na3b+JuE27xMO0uU6Z1avfUJ6L77MbXB9fc2xlyXWZM66/W5/PTIoWZMcsraQsHmRGnzUzqZl8l3ITGQFJ+S4iJFvshyDrLVMms2zXM3awaOjxYk76HbXJdyPNRn1VZra9A4pRwh8gRTWBhbQ0V+QZTUqI5VLHe/bSN0fBq+1Ua1JKjVJqFjkEAN9SGCEmFnUH8eyDF6mq6c8LNHuiRcyqsrovleG3J7K8At4PSRNTo3GeFEOoVqDcLxtWrWj5Gi7u9sfjLcHUvafD3o7W6Pdsdzc7O5u7e7S7DPEgZw40/i5ZZrK+drUvyvkow5FbEN45L8wSKokbM8C8OQYohE32f0+YB4PsD+loaOt1PTyilxd5htYPV7svxODHRFLMyn4uZysGMG0Tt9TnUewyxE9okIIzR3jo1RPtLlJFGWKGRW7l69eD08PT/Dk+NW/Tl+9xyfitbb8DQ2iNaKwtLx0Te0FS+wV4LxTMcyhorZ45rk+g0LSZMuEOltKQsTWWBZxjhF+9htGLLMW49TOaqnEeXOZiye6rdobYkTPsHiEUzGSGQbAhUT+zNWO1qG35DMxVRJV7mlbDKNIk5JYgpGNYIrxczASMoq4bri6WCCVIYzOp7QkGZvrUNV9sTBl3RuL2ne47BRKDkh+f5wMw7wgOEFqLmdhFS1eRO8fyOwsV5fuZLVKzk1OEAKUKJOhTVNYWIygm84z4csRuStD4TElXVWxlks6l7s3ThhXz1HPZJE9IO/exSg/LVat+uGr8smXMeZxCxR5o3STr0i+nvPgahnztigTX4y1iqMmd5vcbXL3gbm7+uOxx2ULpDbo9tahz6mRBeyb8uK5Bn1Sjh6DjsgTOXzvHLkhYBAPkf74cILE/qIM0avLhED5d8RHbilfR5aVP9zzEcGPylk1X5CAbEenwRiVSEV7LPdCYjaUM9Xm+myAwCONADU3QETq+8TcFtz6pYUxJInMNkRkVWZ+y8VUoj76lpMroGtLW9yXNkiyQZLNatSsRr/OatQgySZ3m9z9OXP3TiRZScXZ4nFSVsxmMp27SPO/k7ZSgECUO4SiSjl21SpaIWaiwlhBHTkEo35v1BvvhGoQyUG0vbk77ofbfbm109vpjQb9nWB5rT9b5HGVZPWcWvK38yObGCDuK3BcYRBcWW5tVN/+g3lTNaayxi8JStwMm8Ok5wvsOFjHjm9tDt3AGNgxvWV78fT4kPjTCwR+BwG72SINFcFsZzqQy5whJcUwLK35rUgDHRvo2Cw/zfLzayw/DXRscrfJ3Z8zd78JOg7ug46Db4COA0EQa0wQ6++EjhFwB0GzMZwCHcIC5jUEGxOogk9+99GnfS7TicoroFdDkf3ddRR5Yq14I828BEtZbSfSLMxF5Q20M6JNS1oQSDFBiTR0IkVbd7JBzxRhUsSPiPVMcx6TQuCbzlvDcQ6tXM6U8VbNok0YF5CQi0Jsae/VIsY0wkmNCf6BA++DTlCov+Mep/fWX9oPFsek8SFpLF5dhkpRzlf7v1s3nRI4gPAplYv3zte3HBdwe+bSoI1Ql4krXxUEbaB6A9Wb5b5Z7n+N5b6B6k3uNrn7c+buN0B1j4Zuh+ogeDBUB227Kyos9ZqC6/+O2DlVvAQc3sKGjNWjBQZnXIFQIoESyxutfDp7L+i49/gt76tWebQ561wtTmxfd/yZXIxzzYGTtUhjsJjmeZLtdTpXcCFcd92WiW6jssGL+dzYi3ZoZ52vmzcUJDp/6pIPM0UFnyYXw3cHvgNps+FTTbHtCiFP4NzAqlIUwx188OBO/nQInfw7R3MiHJsNgTzwccaPIWaCJuO3jKnbHFdrOkK30zS+vk+ff2/epYdjcoseN5nvzrlALyDlinok/jm5C7EARuyvU8iz7yrYsCD3n50v07wnxO4kXKNcrEL0rqC/JtARkfXFCyVTtBPu+MyTPz6cPBUTwqlcJ4qMILLS1Fgg094hjLgODsujJDSIl6bUFpMpKzesHdahvBPjGEYRH817pcTZgTfUWywQx6jobHYapLiI0KjzJ6X3IvVVxbR2thfWpuDUkenAih1ZG/eU10luKPTiQkD7o2mJl5rKl6b1nmi8itwfirOk1Esu6fVYIf5Rcmv5RGVu2dMVKZxpz0J3+DtE8hMLpDFb69GTO36tJX7UfeEJcV2VgSzh5agfsQpLrz1ajhq/FvGry/HRfJhqLML1YcLVPJFhDY0jcSDCqbWZ+qcQFDqUKmeTApn2aLEuaNIWZ0Sr310SqeWmbOkWICXLd4jEMC6Y3I0SRjTWba5w2n5iz6IufOJ7OJ9qOvPjM6y8RBnZMHu0zDRhiyZsuTqRefndwkaBhdwmHbgOuADYX/ifK4EXdKkuOl43Vn5m3+ExtHyEEJW5ZMme+7K3KIL+k+AfiLqiQZkmRF4dOsN34XnR6lYzVrmXsGrBdXlji0V1xW5O3uqNKC20P5q+pPFwseVCt7q+d5W+pZL8OHX3b6p4TaX5FSuNx8i0dXm8uBj4quxm6lftHnJPrroId/+9NcxLYc7q+iZmObkcklzfeKSd8anC//iVKwQ3AWixuGlk7LTMJoll7i5uopaEU614yyJRMidUukHxbGec/4DiVHTQmDKjSQoaFIsMSFmOdAx+bfEBPaEJ4VrqB+moMLh+tr4xfA/vvuMrqi/LgAFwm80Kg7GU28VMSITlPVEV6SwsXPFDe2hUqZll+FiNKisBhSuZos2dUTrLjsa0t422eSl47pkLsZP5jW0Ykv3uLq8uFDlWMUc30dVbg/t4I2JbUxUn5HBUboA4tTTDm4OTNY5gZvzbFJtOOn5Q1iFaMKE2zAXDZht9KD2i3g7t8xLf1/ffEm6vBtfVYmv/R75z7Jc66lE6CW3KkQUK11e57vYsuK27xfC92o3kssFFOzSlBhljr65oT4e6vWt6DA60YXB2vmjmuKmCf+kzCsMYjFdvLC/b8smxv+L7lN9K3XyP+Uatyg1JM1/sRQT4+EXRFsaSImj4oQDvNbFwjsC/3GidzBlllAzW3tpQv+tGuP2rO2nPl/YU3h3RTl4w8repZ257JJUXeEj/7wUf8RdfbOKSB0T8/CooNxtB4/jSn/8BJxsRwA== +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-access-profile-entitlements.api.mdx b/docs/api/v3/get-access-profile-entitlements.api.mdx new file mode 100644 index 000000000..75d4da64f --- /dev/null +++ b/docs/api/v3/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: eJztXHtz2zYS/yoY9maSaERZkuXY0kznRrWdjDtO7POjuTs700IkKKGhCIYgbasef/fbXYAvPRw5ybRNTn+0kUFgsdgXfrsEeO+oWCQ8lSo68p2BMxbp0POE1qeJCmQoDqNUpqGYiijVTtNJ+Vg7gyvH9GG2k3beNx1faC+RMVICOhcTqdnw9IiFUqeapRPBqqQY11p5kqfCZ7cynTDOxvJGRKxO+Dq6joYsVR/gCXUDik12cvb61+HBm6O3TXZ+cnm2f5j/pZK84fzyJ2pjPEsnKpHpjAE/ifiYyQSmTBWT0Q2QBcYMny12FDHu+xL5bwI7lUlX05xmOmUTfiMYN3wDYVzqucoSTywsEh8tWyYINuYJn4pUJCjeeyeCP0CK0odHEuUZ83TizAv56ICpgKh6Kkq5jGQ0XiSdr9oZpEkmmo72JmLKncG9k85inEWnCQyEnuKOT+MQm7pev7PX3uO7e53tdr/N2x341et0O/1OX3gedx4emveGs4+ZSGYw2LIcyqlMFzh9w+9YlE1HIkGOE6GzMCVpJSLNkqh1HZ0Lwa5+2SabOU955PPEZ/sqDIWHNNhpIaD3zydpGuvB1pYvbkSI9tvSXIaxklHa8tR0S/rRFo/llrZ0XK+g45aCfsECMJipSgQYA/yckhe0ahILeKhFRTDdnfYSAcK8YiwSGGnImKbtLjRMQSnTbOoMYNyU35nfRMUXAQcp0F8rpamCQItFcZ5QM7Bt7S3IwtBKlcGDFrvUGQ/DGdOx8GQgcwNskHYaKPiYj2UEpgnjE5WNjXFaxXwz6vgCZRTiXy18T2XRouyPAtZAR2owmYJUQfCxirPQiFKwxr/dC5Xy0N3H0Q0UaawiLdhEcB/MvwgES9xhwoGiykKfjYT1DNCcDAq9gfxYw9hEg90KFNU4Aon5LYyU5zLyBAU5oVMMBRjFgBVGC2Eej2ysYqAjEg72l9OYe2kTV0MhEjQGIdqHiSOVoqVogbM2iMiPtPIG8kTc3vAwE0YK2BvYznTOzTdhQStC4kipUPDIqdgJjVxpKxBrKXivDq8P84b0ioYU2s80qgwtI18l0zOI6nfMDBuhKUR/skh/MOsCzlzL5wvU7au8FU1GZ3GsEtzkUPwUjoCUusXHEHpCX5PdGpyhEj1ACo2G9BuNAWuIj2B6UcO0oTCLVn1rW3kKEhxl6ZJHZH+LzV4icNelB2Ow7RD+Gwv4V9gOU+VTWFzdQ91GILNlTGra3Oce1XbPgmEmPrJrZyrQ00+Ca2fRFFfZk0aJPmpPlfiGLstdLVBvsOxFUzsHan9zQ8MFz5vZuWlbz8hAF2Q/AN5y8TdNfGoyaw9NVuq9pjAa5+YPl2jpPTaZQK5RFd12G/+pS/kYoC7G8znMjNgMfmJ/Hseh9Cgsbf2ucdD9on55knC0BJmKqa60q9HvIDbEigmKOZWGFcCIS2xjHo2DKZZcMcKVC2hvb7cXBP3Ozg6gvZ12f9fnXHidlx0PDcrY5VMnolHVqY55FsGCkwvYorpIt1DW04mXbrYwTe5yOAPZwHrUzXZmMXVlqhrt/bc/1lbRPLmsNZwkY2zSYZy6kCoosw01D/Z/xKfDomV4gG2h8niIbJqwck7WcEKqviB+1+HbmAbDjku4Z0GipsbhTV5iTa66qDGAwHghcKwzd6XlL5JcnMgbSHXGwl+xg9dYhg3fwJc5l9CsQmcOIcAkXqgy/7W6EYjJvmweIsXGOa0lc5lwtYb85RTQ1wQSyvlpbrnOo151p/ChwU3lnLd0292222m77b2Lzt5ge3uw0221u/3/onCLoPiFzIQcgmMlwn4BS8aKv15ktF5xdLAsKHZ3Pb63t+PvQlCEX57o7vF2uy1GyEm6tofaObBj0+BlHt7ymUbIfO2YCgPhg5IB0/i02GunWYiHJwfn7vDANXUJSN6rgXfpHlMnPWRTHqN3B4kQLqqOfRAz14TLmMtEL8aYmYb9q8rEvUMb9dscMMPvXyg0IzO28sLD04oKrTtoMTZ76af3yBJrR5AS81EJ8Zdv1UcHGv/JZ2iix/Jo1sS853YivYkpEB3WHZhrDXkX5DnV5V05we6oM9rj2+5OIHy3F/g9l/vdvrvXbXd6orO9Kzp9GNHte6OXXvul2/H5ntvbFtzdG4meO9rudHeCbm8v6HLnPYZiQCBeeiqSqYQJAXs8BSTMAUDI8kJTCDi4OCkwVEnbbiEAtFLMJxEAngOMO0UY90wzcFI+4lq0GIV8+IvkMB4nYkz1LVK/l8HoKeQ0RvkG90tdWg1AdAWJJjyIYwHYD/NPTEtveDKDCJGMRTgDj0hvBUQRCBUBpLiYuYYStbOV09etBV9P5Hiy1ELmDBkcjwod1J09F61xi3ECo5A+UkpLCo9LwXCEmWAlJqylyGRKCJH7J1E4y+1rhSXWHPrw+HD/AktnjiWzlk+bvjR7hS1TJxiDDGEddjl5slvnrMLAf85br3/59R8XZ8O358P9i6OTt4YbNG54XprDQapMlMgfVTwAH+Cj3jIMvE+qYodJAibmsrNKEcMUmKg4wUbKp4qsjCCGSHKkp8LkFUHfFynY7b7y14iYr2QkXBChRA4FsezBQAAC6kb6mFpQMcGQLMAN9qt5Pkqi1WE/cR/Wa9a3bxeDEky49wFoHa2xG11GEsazfAjg9MJVl0wrdgUfvWz3u73gZY/z7l4PcPuoH/Dt7XZ/p9+n7Vtozcfi057xWkC+Kz1GqEr+AQIBOwLZEwM0+fopCdFYc8cyfYtlWn5ZKu5SLMP/tH/KersQG6JxRu18PCeEyL08d+bjPazcED4B15BLkayIsBJ45RwcvhpeHl9Ay9nhvy4Pz+EX0lp4ozGMwFp9NEtFVbuJuiWO7QIQ42iBiS3sC6xhqTZgQTzS1Y7S/GVCJLPlJRhhZ18yokq63GdzVyK/uUvZc9kSrSZET8RZPIWtCwO2nweuBr4XAFx9bCXZsAXJFy02LDZfkwBpGI9hGN+HmK3A1JjBlQXVL1WWYrlPeqKui1KU87tvHkaOq0pB5wDOP20nQy/NgDlaZtULC2uxLFr9AM9GcnXuLipCI5Fi0QNCv0eVck8luNsyQES0Q9lwRLUHCDxR3q+IWLXoiNy8McyY0AnxjGd6Db87DSH8uLS04sGNsM5Hr0hMNBKsxEh5RLLVfxpsexXqyh3fVEc2vrvx3Y3vrum78w/PbOXPPiXo01mEPpeRfTGMm+cC9EnIeiKVvz3+g+CNVSS9urYQ6ed3F/blM/QXdzGWIb8iPjJb+QLzw0Iftgic14jzrb/UBTJIcjQrCCASCX9AfJccG5BIotpenO2VSkYSDDRaAhEhaiZspjLGQWRJFtFLbQ6pma+Ejp4ted+Os0a+a0rOGyS5QZKb3WizG303u9EGSW58d+O736bvPookC67IWyxO0tl0ypOZsTT7HFfLGXQoDxMVLle83KyiFSTGCozl1JGDM+p2Rp1g1xM9n/f8l9v9oOu97PKd3c5uZ9Tr7jrVvf6q9OPCyeo+VdG30aN5ESGSG8BxWQTGpVOl/Hr5L8PjCAGGNQw9BW4GmYNI3xfYsdtfxI4XSrE3PJrlCEnXMGRUyghjGvSdYt8k7wsd8qOmEKok8IWmhG+uXIaHJxidtELnxVUA3WTmDgM8p2PPb1kjK2aRkRdmwCFFglAhalZgWBIPQwWI+YACIdgxROeviE6tir4IybMzXPExrpgd3nlCoKMXyH1nWX33CJhPMEacGwWvKPSabIdHYACQEJiYVeDODT7f4PPNHr/Z47+PPX6Dzze+u/Hdb9N3n4DPLRpajc+hw9r4HPq22qzAUq/ohPmfDdPJVSwHZN5MeV6WULk5x+B0+gYaZTqjSS4B1+8bUx4CaEfPlH40MNVYNzZ3jgZ4AsF5j4dmpwLs0N4rwwCEt5gGzla9v966l/7DlqgfmzUZhFlbloQwLD9pfA8qB1U/tHgsWxAJcdwsUrd03Phme0kAw5MGxllhSj8zh5jxcLOZpEWKSiT6ggmcNIFRmz3+7xSnmh+ljyev0B5mKoNQSWSaeOrL2iU1A5sxJCXPNPVukR0urBHWdpmED59ajz2kvWIdhsiKdSwT36NzQX8GXM4tD9l/X5oJHWA1sy8YS7kjYcbXXZjsBLt12U+CJ5BamJcgz39+d/GCjRGzUswwp9eFxCQDvO4UTIRi4jB/IYCDaJsqrzUNa69c0AdZEMKCmb2lcmSF8BY2izOI7iRSHCQooOCo9c+589q4FXdSriOXHdDxLjx5RH3sEs29nas4XxevrOtzmfghp+ZaxyNqeMa+xoUR7ZU5bYWnR0ksPNQkrc+e3NBzK/RcOrbkItV5HlASlo/6izIv19pn81Gj5yK9Oh/X0Ts68VcfxkwIY3pCB66OmDdRSot/Moamg25wNc7Aiz6bLTpm6JJHuN12hSXXTOlKF+Al8XcMjhEZY+Ij3N4J3SgAfpFvXPI30iz4/G909u632pqp+Qp2YezpK+8JlzfmeMYJXZzQNTFAW/7NJoeGBb6Na6A4YAxgv9Q/RQLLaCXmGVpLozqR36IxuDV4wCpR0fHA/DEoA5z9xegB9i76QAhGdF68OoS/maVFJ2KrwsrrCvMSXOQ3VLDBzsnN8FvUtXDT/butF1c8LMsveGLwa0fpFZHk7xN3/6KIt4k032OksXgZzY2mtYlF1cgNWlssBmq6Owz/h6fafJ0AgDmkPeV14SqZOOQpHcJHn/YmUlAZIRZ4SDvEC3Dmpgz4IcBddH5IFonQmG6EJMAwh8RPhkCvxd7hZQ0PRIw5Gh68AKq/K5usFYfA2UGuOABQ02kW4fcPgIlsyjiYxye060vtZSYIQcoWiXxlimBcMSr3SDQbFEWLspVkqk8CrDdLvPXhrDkX6DC/fQeCRI3Yq5XlQs5ESFaG/erw+1O0wXLciQjpxhREUABTojLDm6OLBYpALLI3R1Uy3rKD9Bb2xUtqsHhjDNstyA3pWpPSKaS0Fbp0a6H+fYdnev664dwFrqLYvvkkxxM/yWF3QUxftmKs3aFSMpNOmUT2yplLZGHUwNytrOoEsqMJ6BL7399juQcTuwdsNpd+McMFw0LfLW+or1Tjt/UpjaVC/CCwgJJ/KcSWSBwHs+D15fD/9Q2MR+RYfCPkMwW5+aDFt/dBi0fMIf9qyWdaw+arFN/XVykesZTymyWfaSubz0os+6zEIxIvv+pRSvx9WbN9IhJ4fmbB0wu23pfAlnKWv7OMZlW2co4BzTzgXVQT7IlB88C8qKoMWTjKUav/vz5ESMxXFBjsj8EVvnb4HzGhfi8= +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +## Request + +

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[]
  • Array [
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-access-profile.api.mdx b/docs/api/v3/get-access-profile.api.mdx new file mode 100644 index 000000000..6164355ac --- /dev/null +++ b/docs/api/v3/get-access-profile.api.mdx @@ -0,0 +1,121 @@ +--- +id: get-access-profile +sidebar_label: Get an Access Profile +hide_title: true +hide_table_of_contents: true +api: eJztHGtz4kbyr0xxHzZLIczLYFyVuiPgOE55jQ/jbN15XckgjWASIRGNZC/n8n+/7p7RC4HxPip3SfHFFtJMT0+/u+fxVAlWIuSRDPwLp3JamYtoYNtCqeswcKUnKrVKxOeqcnpX0e+Z+aAq97WKI5QdyhX2hr7ThVRscH3BQhHFoa8Y91mxE5utmYwUuxjVP/gf/AGLgt+Ezx5ltMCONTaenP88GL27uKqxyfjyrPB8c/ud+Xkzvp0M049BmLxIWjAeR4sglBGMpgCb32MZCgcGYzb3PBYZPOswuRUP+VJEIsQpPlUkzmPFowV88uED/JIOPCcwKqdRGItaRdkLseSV06dKtF5hKxWF0p9XnjdpcjFigQsjig1KAEzxkS9XHnZu2f3mSeOk3bN5t9tvO40mPJ04jX7vuNFodvqV53tEQa0CXwHhYdRWo4H/imMNEnJnY9iBHwk/wrZ8tfKkTZw++lVhh6fyNILZr8KOKpuzKOG+ClFsIqmxARKVKFEWDsE+hRi81+w3nEZXADGa/X77xLWdVqPXbxE3uDP2vbXmxnPCqn0oXEGrVyBwBv+DtRCWwyM+40pYOJ71CPIkSgwuj+nHnsdnCEmLyoY8+G4QLokLjM+CONqHzTDwPGAJtgfUgZcy8sQS/iuUZ8TsiDAjOMKgzhLUEV8bGkXiFSwacQNmQ2kfuWIJkFpF4w/NYQxhRXK5wb5Gq2k12lajOW21Ttut0+OTerPR+fc2ti0DR7ryS1HzuIpYAqr+CRi2pq3GKSDZ2o2h8JGVeQRnQeAJ7hOGLo+9aDuf3y8EoBtuwxmMjwFbZxfbpDHXAr/6bB3EbBnDLKVve7EjGI8YIAEvAl+ws0wm6vmJmikEj74Iy8ZijK93asOmOciE2uWeEpsGQDcvM1H48RJdx8Xo7Gp6Mf1X2WdoNLBfnZH/ACZ6jp7tDARaEhU94UYMcUBjr0SEov8mAfoGqACUWcUR+AJs/igVkIh1Gg32HXfYBGy3AHAiDKH3owQoYEuBcwVqZTgCzV5j0C4cUkZwMc4W+8U7XZdzR4hOo9l1Zx0wYyd2q9Ft9yuvtlc/xEvuk/FB0jNHqpXH18zPmTFiLogRKAB8AYIVKBUsZQRKC8QBclyPb6b48nowHf5AkgeErIE71sQGjbEXBNOOwxCmxh64FxcHeqMKSHwRuVW8WgVhVHkGcpD8JsIwEa6A8W2yXSqIQ1tsc1Bf6oFuCLIOPfSfhTQEKGsjVyqwpTGAm6zu93ptYHS72wRX1XadWWPWbXSbwu3gDPaphg5dtgVTgtSiiG9NE5R7j3ytkN+mex4r8+rVYoYjbZOtbNJm8MIo49GNNRhZyWA5LhZiEN0TeFoha5p5rxxePAz5eq/nHDBPosXbcII5LImNZQaSrCf2FC0MWjAdBCJrPS941MHhjBwoaHQm1qAdvhAO+VqMpTiq0gvGFxzxUu2Pp3K9jE0HxoAOqZWwwY3ZZONgppwmUi+J+y6h2jkKaO5oOtZ2Nid8ZPEuz97Bf5TAXAyU+/BKe1gcDSL8F1SlBVGtaLZFs9Vq9OnHS+L6slwUx80LchGD4dW3OcGpd/oN4TriuDa+/XYczocBPtyI8EHaYiRWUW00/PaHfw5G+N8LIG8oyHhuUJLtZ50igN3TiH7dcCEHmj1IbsQieV1nQ22xvXUNzPhvJEqlzMsP0JVkcABsAJEOM3YYNIBB3ATGX0XBEtKhVGNSrfLFY2rchzAcOp5xoik1UIsItQdHR2WheHELHgSOG+fCqlXSxmoVfVSU+X/tMZT2XOhZyJtsC280LQxew8B35RzJv8eWFAiImg3dYp0GExkIlVR5X/Y9drAkUzRJc8St3N/FboNEFowZO4OE1CNqBw2DPkgHP+vh2K/wVrprIngGZ5NE29THCCKRnhIaX3Jv+PnTAC5Ddgn4wfN2XB8xjIVxvgK2eiTu3WDuKj7dj1yiF9GvZgk2QP6VFjYCXkZyp10vikJChekepz+4vv55/P7qbALvkv+mhpH8fDe4GpzT0/n4p7PJ1eAKPp5PxrfX5VhhpGcjFGEtfUcC9WNOMeA8DOIVvAevRZaEiggSLQDKeco5aIxEqLOfUDHBLYYYAEAbdI+q/sGvVlOkq9VTNk1iwjSFyMoLWNqpVtOmhUwj5643DANgMwEx053zxCjBMKHbpucv2RoNyhASobzjPp9ncNII3hjNHMt1103KI4wBO0cO+xwiVHaOxK1pYBRZ6iASCG08OeA2W9P3ajURjgsHzB2ZuYJ/KrE5lXXs8hmVBieZZxpVJOBqLFaAGdl/0sy83CL2JVzyiHa6dq9/0uxbvNt3rU6ft6yZsGdWE3x8r8lFt2t3dweEg4L6Qrtcw0nin6QHbKmQU30ItFB9ooWfpB1fZ+Xre838H2p3NpE/mKCDCTqYoD/EBKHqZQZIiflr09VNBd21JHBp0tiLkcJ/yQg1JiHh8yGGh/A5KUbgQsW2aoSc+7rWmdLkruL2Zs3ZCW9bx65wrI7rdCzutPrWicm2eqLZhx6tvj3r2o2u1XT4idVpC26dzETHmrWbrWO31TlxW7xy/0x25UEqwBlmMcQScyh5uY74npjnZ5K8AJ1dQsQmAS1EPogxAAz8ctWF5ljOEAr1lpomgvi4AruByFBxFLMH0jo+h0hZYRE9ULnRMAFZBPgKc3T4lc5lZ5FgC0NT2j5li2RY+UCLaC+k50DSRatG+a+Dq9HmZ8iMwDTGEQqFg1F0vv1wfDUdXFzdwGvKieAVaAYHk/9cK3ZdatOxv/+NHURRfejx8LfK8z2C+RIEz/55O7jMgz+XM1w+2kQvEp5YLYDeV/Fy9ho0j5stRO/+eZ/nzcHZ7c9SNK/G05/TH7lhfxjgXz17YGHJg92kiXA6Hont9TY1KNRKksESG7KtxzidA9rUjGyfuGaF4s3S7qZoFWH6qBcTqtUUecypFck/dNc41lhGnBpLaEMrqECdWj4Bz62bFrJ8bcgpjZPkzkF/y7l5RSy59Eoq9Zwy/1M9yQ01M1UDmDVOeQdNHo/CoyjvdPIcTVdc0jd7iASkyej0RfRJ13pSTOGrH0RMz81CgjhUj6cS74wKAeAQI12cpMgFHdcqlLQYlpTyUprbPPSEqNvQpWn33f6s6zr/QD5In0eAACTjtByYan7Jo72yejkSrvQhQKMlA5ypbYQ8iecSpmjxTG1vGiVl4cCeheWD5h80/6D5B80/aP5fUvMPmv7HafoOog/QACBhqEuqz3WWLANgVloiJmgUUm08qRXXSpNtG+kuhDobgLH4KJfxUkt0KPDrg/Ao903NB9Z60pWoWm5N1BPcBQoC0gVCIOySpD2/rI6XOGybFhpfXhz685LkVSRoHUjQTFds9UrXndklZdag030n9zsqSFgzAgCdbbswh57EZf0z2v5iAcVwL2xGsaQaPQsc2p0qfTB4kmo5n71Zs+g6HRGBQRgCdfar//fgzq15yCViqHfs2NDRLOAhqZcBMEGDTHzSFtsPlKg3C9t/hmYyyI6Q21jd3F5CLCJ068vf0fybLkw6plK/dVjRE3zWbfRbHbfb4bx10mn2jmd9l7fbjf5xn/ZaLYFtfL61YF8c+lyACEBkQqv98j8CV6G5MksFNPjrq/AE45V7b3TbdJoGX3B/H6MaREzfDa9Zp8c87s9jes/nG0TwrdubbX5XAx6Hci5fDKNGZ98Pbi+n8GYCLvHsBp4QVilaGvhU2LfR06AsLIJHwthMAPdiKoGbVdFfVg3UKkyI+yrfUOpfag0hzJKZBV7oYUbf0iMPmrlhsCyoEunNx4h9I+uiXgNLk25nwy2wTlJ7rKIKryLr0lCyyhaCOyJ8C+bIcSROkns6/FDJdjruOHr/HAJwY1BlXbzEjbvg16W94Z8zUm4a2MSOXOaZgsoBmL/CTdsRLqbQNPNamEqLQdHwB3DWlCtiN80RjUi69iNuwyy4562BjGGIuw0gbqFN+sYc0VICGB4/aZdarMKGGMTmnUZmFAX0zeaxeoXeXXtgfiyaWvrhQRjlU2n11iFuJGwyFskETdTZtErZlSh+utBx0N2D7h509zW6u/lxYs6emK8U+jTLoc+tbw7eoPMshT6hyYaS0zn/0YGjZiRlYSZE+vH91BwM0is/lIB9vfhIu/Ly6ZmUHxuL9Inrz3iBCBIdzVYCsETCOSW8M4yJUJpU7fJo3wfhTIKA+ltCRLCaIe35x/g3jH3aCsZVjTmBUP6biC042EezCZAsIB0YcKxVIPU21EMkeYgkD97o4I3+Gt7oEEkedPegu39O3X0xkkyxIm0xcZKKl0serrWkme90FoZBg2T3oMg256erC/loBYGxNMaqFCOHyqzVnDXdni06Du843XbfbdndFj/uNXvNWafVq+R9/V2mx6mSFXUqx2/NRyIxBHG4Hz72QbhUFAROsfwH5A2Fi2YNTU8aNwPN67grJokdW/1y7DgNAtxHuE4iJFWIIf2MRmjToO0S24ZJWzpSMQe76DMwVTLQe/TkUgCUEFcdPLmUpLw4C4Abrq2Bi+cTtKIkQpaOYg6lKrIEXqDPfzxyiTVfF2M+gEARLO7V+orRqWHRF0XybIIzvsQZs7OPthCo6GnkfrytvnuBJ1/QRtxoBu8o9Opsh/sgAJAQaJuVxp2H+PwQnx98/MHH/zV8/CE+P+juQXf/nLr7CfG5iYZ2x+fQ4NXxObStN1gaS31PZzz/6DCdVMVgQOLNAptuv3CyGJzOgMBLPA+Cg9xCXD/UojyAoB01Uzr+qa7GWiu9P+AUL+2o3OO1TUsBcmhu1kIDhHdLnVaOiu3V0ZN0nnHfAcWUejpx6EHLRRSt1OnR0RNwGbj7XOcrWZfmsIUfPOKWn6OH9habpe83QHmDUZxY3yGE13PpQerEm1Ci+GtbSQNoTpkztxUFHKOq8ovwk1sj1kEM1pHA1HDzkhFFeg1oriAPeaPM0XykbGmOMLfb0HveN5+f2i/NQwPZMY9t5HtxLGjPAMuN6SH695lk5M4EluQjc0KY5LVKg42xWYt9J3iIJ8Jp3eObH99P37I5hqlkJmKFEbK5DIezaxARMoODZA0AO5FnCoN4bs63FFZZUO2Y68GE2Qf/Rgh2lxzYuQL/MAGDTiTFToJsCPa6/ybhjIO7ZtB11jNKouCB6B8BhY54od9bcpOUT8jsvqv6B99iIxnq26wUtTFT1Ldf3K2SefHcvD4Xib8l0CyjawRNvd3AQpP2zta7dmzQfQTBPUXU+uzBNTwrBw+TL3iDUDdxQEoYPIprY3bCtc/GowDPQnhFPD747/UxrEI3pq0WU+BCPYddmNNUf2cMRQfV4G4egxZ9Nlp09ssijbBajRxKlh7SkhZElITfJSiGr4VJX5hGAU0AsZ7vaJX8hTgLOv8L5NsO+6UwZ3p9B44XWzqBrT4bZxzQwgEtbQOUwV/7NRQs0G2cg74VggRgmPGfLIFBNGfzNKytVp3AH1EfdA02oEpQ1OpU/zjNDJx5YvQBW6dtwARjQJ6uFuINiAYWOrcCsZJSwiYFy/h6AfjUDbppfNNSFvrZ/7f54oxzx4TxrrevbaV3WJL/H7v7P7J4B0vzV7Q0JkRGcaNhTS6RF3IdrZXrf3QJl8Bju9cXpKkUi0Omk53RzYNZeTxCmSadthdSUOVgJTjdZ1RDuQqWpIcQ7qLyQ35IgOZ0FVEICHPPnOyus/eQmvk2kBjTMtxrAVB/DUx+dgNUvkYmsVHCOIbX48Q+HnAGJOIl3gK2j7uOVHaskrvDfJHMjDZHs7RXopEoNkgKuopChEs1ds19VDkm7hkLeKhMfRkISddk6Ftss4lMhKcPukC7Yvi9DzZIjrUQ3goTQ7CgEEyJ3AjvLqYliADM11up60E4PzKd1BG2xYMhMHktDO06pIP4ahWoCLLYHNxzEZUPiW9K01NWUv9TXkNsnA9mDUcrrJIhLWKdxeiU8a6ykTJCr1Pp4Bb1BdAMGzw9YSUFE6hnfP17LDBNv7vP8iPKK4Gd5lJTc5fnTkp+k2z3f/vS1b1bcU/qgP46KwFU4PE3gZUDwJvOfevSDmGlP+jiT65LaXmkkFOfn6HM8R0e3DwABcBG/ReA6YPy +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

+ +An AccessProfile + +
Schema
    owner objectrequired
    + +Owner of the Access Profile + +
    source objectrequired
    entitlements object[]nullable
    + +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. + +
  • Array [
  • ]
    • accessRequestConfig objectnullable
    + +Access request configuration for this object + +
    approvalSchemes object[]nullable
    + +List describing the steps in approving the request + +
  • Array [
  • ]
    • revocationRequestConfig objectnullable
    + +Revocation request configuration for this object. + +
    approvalSchemes object[]nullable
    + +List describing the steps in approving the revocation request + +
  • Array [
  • ]
    • provisioningCriteria objectnullable
    + +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[]nullable
    + +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. + +
  • Array [
    • children object[]nullable
    + +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. + +
  • Array [
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-access-request-approval-summary.api.mdx b/docs/api/v3/get-access-request-approval-summary.api.mdx new file mode 100644 index 000000000..8b5c20618 --- /dev/null +++ b/docs/api/v3/get-access-request-approval-summary.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-access-request-approval-summary +sidebar_label: Get the number of access-requests-approvals +hide_title: true +hide_table_of_contents: true +api: eJztW2tv2zgW/SuE9sO0QeTYzqsOsFi4T2TQ1+axBTYJtrRE2+zIlJeU2nqC/Pc995KS5UeStlvMdAp/mI4jkpf3fc+lqOsonyorC52b4zQ6ikaq6CeJcu5E/bdUruhPpzb/KLPTcjKRdhZtR04lpdXFLDq6uI7OnbJPclOoz0W/LMZ4FunUHEkmEVtPI5aBiIudJ3NklUyjq5ur7aiQI0fL/K4ibCuqfV2EOalyidVTYhIsno21E8qk01ybQlhVlNY4UYyVMOVkoKzIh2KKcW1G28JvrVIhTYq5H1RS0B9+s8CfEzWDLXGqlLiM8k9G2Vinl5HAFDsTU2nlRBWgPlBZ/kkMcyskJM6t/p21J7QZ5i3op57pWEOaWGYaGDMYwZ8VddJmMlYTGR1dR8VsSmOusGA8ulmVWgmdkmwkKVMQxIOXz2JMmQJmqWY0RDqGPqxyGN/mITwtVa24aqIItmHRaJqbqkQPNdRV0W5dGiHElnhz8uI//aevjl+LEvZ3IpEG/2UZlsE0n3Qxhrpnc5aOn/o916/n5WA0F0NVJFjKhBoSQLVeaAuDfhorc2kqDQrsZ/KC6KQV9dcwxjoOc5PNglAzsTVRW6S/qXTsO9qSTi/NKs8wkvosJ9OMrNNNep1H7Uf7B4+S/W4vOWh38CuRB8NeO+nsdnYxmZxKW4VgGoJ3dbO93geGNp/EqSzU1zjBcywStIjkJpXwb3LtQk+UIJpQkIYSaRA2L7OCDAKNDmDQMUSEOxT0q8xSegbVShIUqjw+fRM/gkTkABNZLMhdc/v3brvbjtu7cad31ukd7feOOp1/r5H6ih65aW6cciRYt92m/y2K8/r2eN2+LVgbjo1tE8o9piDSeJ7phGNx54Mj+teris0HRJSi1FLeK7TnLmzfmIjUokbKRuvCcCXN3JFPQCCok2nudptqbcPAlcBfvfc8s3375pWOv3rzL8ik92yO3RFn7FzLNebmhkb31nnMk0zD3OKZtYjdGNWCchhlKJ/0lnO1ptzB3v0dnSVVhdTZkzxVqxG7ErDaqHhkpSYmFXOdYKEggTW7ziS3CGMmWaVunreYd6CMVkc8lmldIJ8EYUiPVia/gdZxej9D50ZjvaiWUEmp8v2abdWhkoODdq+7NzzYk7L7aK9zuD/oDeXubru33+vR7hPYX468asLe0lo5W9n6hULO1onIctQK/buieiyhe2aAN8cSXaiJu98GTOML9E9e6+fWYgZ+BWEW5Bvx+MlbsXcoMmlGJT+XoyUlmPj8lBJ3mWVyQI8KWyKvBybeWD3SZh0rCvFC0Obps+f985dneHLy7J/nz07xi2itAJs+gYiU3DLnIEO6Zo6DAJ+kE05lHHctsRWobkEgGfBPmBhqg5s5KBO+NZQoA1gRdl+zoknaVxFfP7yrJR7giQe6pVrbqBp4hrhGlRlI1F0UVp6+RRBuWsQvgya3xBgoT9mHLdFPU01CAmVwUXVYP6PyI9OUotcTGJaIZsX4IS8Lqus6Waq/c1UuWmOeTF42jULBAc7v95N+UpRgjsVsRmHtLYHFYB/w7DW3yN1ZQ2ms0pkpZAIpAGlmUKO10LAYQDaNVBnSEZnLIfGYal6dsZo5kjPeK8/M0yLnsUSW7gvi7m2G9BOzaPXARxWCD26Qh2zE1qjMFDISBklsXhxm1eaqAl8AI2bpJnY3sbuJ3S+M3eXBkwCVwyijn84q+jk3VcsJIVbQj1W+G1rqS70ht6nZCSjp13dnCOzflKH56vOUcPt3xEe+lK8w36/t4Z8PCH7UxlqwBTHIevQSDJGJVHrEfM85ZkV5Ve2u7vY8twMNBzVrUCI3nbO8FBIqs6UxDOHdtkhz5cwvhRhL5MeAbDkD+gOHmE8cNkhygyQ31WhTjX6earRBkpvY3cTuXzN270SSNVccLQEnhWN+72lhnM8TBSaI6tBW1CHHplpGK0RM1BgrWkQO0aDbGXSGh4naS+VeerDbG3aTg67cP+wcdgZ73cOoWesv5nFcB9liTDXs7e3IKgaIo/cepYFzuSLP0wVvJfVaNaS0Rqmnxs3QOVR6VWPHbm8VO57luXhFLzBOqlPNJoY0cx1RTsPcCc2tT0D5RH2EvGgEUpXO/TsbOp6PhaXj+kxPNAcvSQG6dhb3h3Ra6QOlcrJ6F22SrASHnAmynFBzDsfSEFINCfOBAiPYEbLzd0SnwUT/F5IXJyTxS5JYPPucKEWBXiP3/XVHvMdg3lKOOPUGvuWs13c70sAB0BD4nFXjzg0+3+DzTY3f1Pifo8Zv8Pkmdjex+9eM3a/A5wEN3Y7PMeGL8TnmttqixlLPybn+cJjOoRI4YPcWeZKUlo+bKwzOuAKuFC6f8QUqukgW7dx2iWyn+lXdJuNLaYQVPZulzbB8XBRTd7Szcw3rwWo3LTnVrep2j8k/tZJ8svNxd00uoksDPu6wTVomfAbdf3scOo4W69xqcmufA3kDbwGWkhwYluDT4jvp01UgMu0sL5H1mMy2QAgEF+PHYHOK/uIXx7Nb7FIrMkK2c5vd3CfPv3bvksMTuUWOdeq7cy/MF+BySTxi/2p+h/CUgLjffeUm4by4UPPWXdnsDU3risdKWnQJ/n3Gg1/fnT0UI4KfHP6lI+SrNPULCKC3cBFOb/3qbJ8WccWxeTnyt6b6C29PKJzEMIPA4tLQ3cCL46CE18j7J0jUrFJapDg30KqrB5VlUvVRZVQSW3NNkuPp1MCN9Y5cWPeQyx/3CXSbkC7P4Gnr0sTiqaaspKmM05wgIrd94mJaySUbcn0rE3+rqMUhAJmae7jEhVftReIv5CSIaSJBt/VIW9+8uacXN+hRU4UnRHWZB9JE4GPxnVdSWe2b+VigFxO9RT4uzTu+Z7e4TPhUVt2vOxbJOM+d+ofga6UUBhejElH0zWzx5b6YIyLuthssxX7LWMdAiszfSwSG8c4kB1SpGajkwHAm9SH5ni2LmH/PVwjfL8jMjy9QUGlmmifum3mmDWPaMPY5wAX+fb0ix6KrYpCB84B3gCdz+3MmCIw2cp6ntTarM/kdXkOlIQGrTMVNj/wfR/MEF34JHqDZ9RykYALa9VtAupYaaFHRWlBWdUSwrMFVfrMctXJJb57f+oiK6uePJi9J3J+fpLwx2ex7Z+lbMsmPk3f/pIy3yTQ/Y6YJ0JfcjbcNPULTyT1aWz3Xo4PnscK/GOVIZYyNDsbfvCcM0yQzzWRBPs0xnYy14hOBqZIFIb9t8qt8wnEIuEvBr8IV/pHFHAStAxqVA53RBwDiHVouk0DF1G7RHQpQ/ZCHvusUWn7LX2U8rQwHADWZlIZu1IOJciIk3OMe66baJaVPQui+jKokyxnG1auqiCS3IVW0uPGwE/dmSEfH6EobRrxnL9jQhXNjKJIsEq7pzwU5URl7Gc1bhN/30YbnxGOVTanhQwYFmFKNHV4dn61QBDHjIBca69yOdsIit0NzQYRaHe8Muy20efRomrsC3WmD7gtVLH0Us9hQuXlHtexj1/MD9B/9a5tQfaht2JnS8Rcpo/RtjG8kL6LbGsmoun3faCXRnIyhSlp2fU0HJ9RX3dBj//0GNZiwK4VO9a3DncrbfLTzZ320s9YzflN0sNL4/iqcnkQRddVfbtg/+EOcO2Rpfkc0F+Zq3tvDZa8w25/ysf/6hf4csLFq5U0ZUanPZl48ozQlbwF94QdtdXPzPzWmwEQ= +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-access-request-config.api.mdx b/docs/api/v3/get-access-request-config.api.mdx new file mode 100644 index 000000000..8ca11443c --- /dev/null +++ b/docs/api/v3/get-access-request-config.api.mdx @@ -0,0 +1,95 @@ +--- +id: get-access-request-config +sidebar_label: Get Access Request Configuration +hide_title: true +hide_table_of_contents: true +api: eJztW21z27gR/isY9sMlGVG25Hd/aWVHufNNHKeO3UzHzsxBJCghIQEWIG2rHv/37i5AipRkW8ml7V1GX+KIXCz29dldCLoPdC4ML6RWJ3FwGIxFMYgiYe25+FcpbHGsVSLHQSewIiqNLKbB4dV9cGmFgTeFuCsGZTGBZ4GM1SGnlaFxS8OI1h4awePg08OnTlDwsUVatwPzW9gAXsXCRkbmKAdIcTGRlgkV51qqghlRlEZZVkwEAyGMgGftrZjbqnSKdEFcI2yulRWw333Q39zEP+092kKw4yYH9loUXKYWOUWopyqQAc/zVEZEsfHZIpf7wEYTkXH8XzHNBfDVo88iKmBhbtC0hXQywFqjb3hqT0tbHInhXSGM4mlj4UjrVHAVzBvjJGGFKUUH9Ves5sMyYMRGgsFn1ETEbDRlwvNldmoLkaEC4o5neQo7IJeHTsDLQg88l6Hio1TEq0vBuIqZt7ow/tONFLf4wQjykeVZLS3slYHBIp6mUy+7I6r0WCah53+mjsSEp8lZ4qNwwYeV884Uc6TsLGl7Etk/45g01bfn8zsO1FQrcTR1f1ezDydaFnFVWciHKUu08W+XOmSpBEOg0VMBMpxyxcfCrCgEyxz5Y3JAam1M4HUsDZgDKHJtCrsoFwhWyAI/BguyeX+g7N6N5yKTKhZmoOKhBW+T8R9zWxV9rFpFcTRb97UujPnUXqpCpjMWDWMBhAg037yx3pXZCLbWCcP1rNDslkvMKLCSi9FEGosWckJ2GZhX6fqzpYCvkEfEPuQLxC7p0Eo9uYWopUUV4RFkipN3q990x2YnUGWaYqbWMYP8jkRxK4SqjGh/j87EqVYN1Cxk4qHOfr10Gb/7GqlO+Z3MyqxhrqWCoLgWqgL+RevWwOPtWcXic4YF1rhdcNhrqNFbokYCmTni0RcXr8Kci2QZ0LfXzQeno65X2cJINV4wwQXogxSUtVoBWAKyn7wevrs4ufhnl134oMJaGuLrpgeCig4TUsbPb3YSQ0GDWs5k3Mr7YKe3u7/Z24m3+sn+wWbEezv7vX500Nvf3N/aifsCN1CA7s9v8UsJMBSiuGgZABubp3zKcDH6V3oJntNskEqos+yNMOPSatweiq1Mn99/iGSMx7FB3PuKHTnt2E3cjn+rllkNDyOdBU1crOwIcSGgK4nER1lM3oGKiIIkZ5N6sAJUooKKFmTwt92DLcDocEa5vI1ZsfgNF3ZcodS8SfnY1TVkAS5gDcGruvNEcT/WGVJSnwmVaJUWpN7S0BrcM/Jc2O1EQpjZcpTJosA3kEaPCBSLhJcp6AjpbUVDQPqM2CqUFPF/RUAj0A2/U76x4bWnqqD6gG1oE3AeS4y69lq3guQljo/50CUM4hJAkshyxA0qhDXewmslRCzi7rU6BdFljr7w/Ks2FS3BQytyDsEJpAwhD1bLuCbFenrdTICzWyXMddCBp1aXJhKNB77NuQ6oebgObrX5Mja6zA/vZfxwHTRlqd9Z9mKMSK44ZCtzj15WupWWNGi6oLntEqSfwca80B3WWNmperLOTJJDj6vbu7ubyfZOvLvZ293t7cWcH/R7mzv72y3sWEzRCjCaALNkcHt4QIrtZQPQcSrRzUNjIAJCQBCcsmCKAOe66uoQZaTjKXpYKnLWdxyJYhqyjnW8Qj15I5UIIUwlSihI5AgW4vBzI2MM3QxbAMcS8R5VILp2hQNLdHvsiMdNxCRl0JAGij3wOlmhhl4qCetZtQTqC2XSI9uKPcFHu5sH/e1kd5vz/v52b29ndJDwra3Ng52DA9wdMsBCkDRzmBvDpwtb/ywgpmTEUg3VQ/5b4AjGsUyiALQ5LJEw/dnnfUA8VuxPHG2tppeX4SlAB+aOo+P3bHuPpVyNS3rOx3NGUOHlh4UsAs0d4zMjx1ItE0Uo7NaugtfDN4PLtxfw5Hz498vhB/gf8lo4PhgoiNYYw1JTNznRtySxV+CWW+gjUzAHwtArz/UVKMT9KYMn9F28G6WZBwVY4XdfsqLJmiVGZ61UityRCXshu6LbAciBZ9CaRhM24ji/Y4sL5K8wkfMifOst+YpNoFUR5mWXDeJYopIAupCNJcIrp1YROh1MXccgKSGVQRjoRnRZUA8dtSfPhinnMa1Ck7dNp2BygOQrlJeoKEE4UrOZhXW0eBG9f0BmZ7m2dBcNo5FJp6rgUXWMEGlDo+sIdJNQWj0cobssAI+q6GrEaiEpSnPqhHldaHoX8dKukHfvU4CfkFSrX9wIn3w0TDk0Im9UbvKI5EcWWuypandViQ/zpkjjde6uc3eduyvm7vzLc3/s699S69NbbH0uFS/BvoaK50LrYyh6sMH1RO70wTmyw8AgvkX69eMFJPYXoZBe3OU4JnzH/siV8sXTs9of7vkI24/aWS1foIBkR6dBAkgk4kOSeyYxGcqZamtxtzfajCQEqFrSIgJqGjbVJTXuplSKBhvbYbEWVv1UsAkHfPRnj4SA7lg/pHP9dSe57iTX1WhdjX6carTuJNe5u87dP2fuPtlJ1lJRtvg+yZZZxs3URZp/j9pyBgSsuoDA6pQjV813K8iM1T1W0O4cglG/N+ole5HYjvl2vLt1kPSj3T7f2evt9Ubb/b2gWeuvZnlcJ1k7pxr+dn4kE0MTdwN9XEnf1hVax+3jvxJPghOENYSeum8Gm4NJP9W9Y/9gsXe80JqdcjWtb3q0ekg1sxFiGtBmSGsqWiDgbAy4qBhAlQS5MJRkJoALHiGzVGayPkkGvmYaDhK8leASpQqyeheporQECQkJUo1d89x3vmZKHewY0Pk7dqfeRb+rk2fnqPFb1JgN7yI6bWd1576z7Hz3RPmrIB+cgx856HXTDlcQADAQOMyq+851f77uz9c1fl3jf4wav+7P17m7zt0/Z+5+RX/uu6HH+3MgWLk/B9ruJqt7qTd0L+B/3aZTqngJKLyZjugmdDzrwamvgFDyt7gRQzhezQ42ll7LDvBKN/aFTqTSpEA6KYrcHm5s3IOnwEMPXZ7LbnUFSulbvAG1cbO1BHdmdx4BueIyovPmwfsTP110yb5GYgg7vKMNnLXruxZgdToZfpJ/dYVsqktAOGLTwatzPpzoMYiZwyzxkyXqLoXPgo6g26VJH57T5x9bT+nhmDyixzLzPbkX0DOQck49FP/T7AZ+46rPwj38WSHBQa2/sNkZkvXZkeAGJgL33cWLXz9evGRjbDUp1UtLN4EkzgaQLO8hRAjKBtU5Pi6i6mJ0OZ6Q4IPWNyWYOixJQWF2rT4Iwa6qm3LvAOPPAZTJpLhIEA7gqk8vKs/E4kakWP66M0ti4MlYbYCFNnhr3UsqdTQTSOXueuLVt2sVstd0xRmvsLpbTk5FGvHYVV7pxRt6fasQf6m4hT7ZiJt9OSeFM+1V5G7eRJC/yAIv86O1vnlzxy9s8AvpRleIXOdlQEt4Odrfb0WV175Zjha/EPm15bhWHycS6mh7GXOwxSyUwTRmJyyaaG3FXxnD0ME0uBqXkEXfLNYtbhpSRoT9zYZIodsylCF0hSTfW0gM5YKJj7AqU1OioV9TsUvJ38izkPO/0b2z31o60+MrKJ5IGevIfrPMuGGIG4YOA6yX39UmDCzIbdSBcMAFwPHM/4QEXtAG5jleS1Gd2G/QGiwNEYhKXGx+6D4czgDO/4/RC6SuaQCCsamuv/GDz8zzenA/PZkZqzoOmLfgoryphro4Zzcnb30chbXyj6YvajyYnZqcqXT6vVH6EST54+Du/wnx1kjzIyKNb3Mx3GjbuWv4GOSuW1s8w7P0ix74F95SplI/DdMKzV/UwzTZ5CkvMKYpp6OJFDT954IX2Pl1qt+1QR5Wv76zjtHYAA0kLV3sH8mUfnHwEcYrFYGJcbTC+xLA9bP2M9YHsPJ7+p3j68pxDO+elwp/oQFClBnjEB7PeDeWNiodCEGDr0SlmaY2rl5VZSSGDZqCfiIgTGbPEjwmhgm04cRn9gIfWn9GDIZEj7jfhgQzRc6F+3kD0rXb7+d4Q+SEE5HmONwBgkIzJRo7nJ5cLHAEZspduu5qM97wi+wG0gITHHVcMGx1YaTDR7m2BUyiDb4/i4I99cPQ+cC6n52Qf4cfrfqqgO38Ro5HUChk6cYLN8xdBcuHORgPJhp/t3EV3N/jMQVONg/4GMhwBr76NBtc8BMwdscVNP19ETQm04HGbBJePPLHMaQeMn8eog/4IxXN/we3enj4D7GwSb8= +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get Access Request Configuration

+ + + + + +This endpoint returns the current access-request configuration. + +## Request + +
+ +Access Request Configuration Details. + +
Schema
    requestOnBehalfOfConfig object
    + +Request On Behalf Of Configuration. + +
    approvalReminderAndEscalationConfig object
    + +Approval Reminder and Escalation Configuration. + +
    = 1`"} schema={{"type":"integer","description":"Maximum number of reminder notification to send to the reviewer before approval escalation.","format":"int32","minimum":1,"example":1,"nullable":true}}>
    fallbackApproverRef objectnullable
    entitlementRequestConfig object
    + +Entitlement Request Configuration. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-account-activity.api.mdx b/docs/api/v3/get-account-activity.api.mdx new file mode 100644 index 000000000..b889f3ccc --- /dev/null +++ b/docs/api/v3/get-account-activity.api.mdx @@ -0,0 +1,111 @@ +--- +id: get-account-activity +sidebar_label: Get an Account Activity +hide_title: true +hide_table_of_contents: true +api: eJztXOtz6zau/1c43g/b04kcyW/nyx3Xcbpu87q207PdNHNLS5TNHlny6pEcbyb/+wVA6mU5iZPNPtrxtHMiSyQIgATwA0jpsRasRchjGfhjp3ZSW4h4YNtB4sOfWN7LeFM7qsV8EdVObmv6CdOPpIhqd0c1R0R2KNdIAgjMljJiQCVinEXSX3iCcd2Na4psvmESGkinDsTXPOQrEYsQh3isSSSy5vESHvnwAH5JB64jeylWvHbyWIs3a7wbxSGQrz0d1ULx90SGAtiPw0RUGdrBAZEUX/lq7SEt4TZ7br/VbHVFv9XuNObt+bzXarR4u9Psd51e7ekOh4nWgR+B0MBEwzTxT3mogV8dKZj/JuwYRrMDPxZ+jL34eu1Jm5R+/FuEXR+r8mUd1yFOEWkbngLnFR1sizx2WOCyeIfgJakbdt/qmb1m22mIttXpmVbbaTbcXt+0udXuWahbNQWvDYg6xpb5sO8czg4Fj4VTVe3npfBLpNkDj5grwyhmaaejCpduEK44qLzmQAMjliBLiSPT6hpm17CsmdU7abVPmt262e/9DTlZBY505f6seBw4yTq9h5WeYXaMRnvWME8ajZNGr26Zrb+hFSSex+fYCpc3KinATm9QU95hT77KQ1b4tEzD6s+s5kmrjypr9tqkMj0McDKNeZzQcuWed+WSYW/TfH1FRUSFcRecA8uJo9MQfrJCjzS9GQ5H0yncORuMz28mI7gaXw6vLq7PRzP8cT26PB1ffl87wuHvipLkXWMZ053hNv9PR9tsP909pZy/LlE+Fhj8BJyUiOKdgmJHNB2ctGBr/sD0cYqEU2fs2hM8Ar0IQW3cwPOCBxiLeRIWH9oeEIqgITlhurniG7YIgwcW3IMScXrrv/i/+AYbekHiDJI4WKHt4J2xA+4JhhzEIMA8icXNGtcEPsr5x1/n0hX2xvYEqkkMl9xfUCsdHuhu3jcNJ1WqxMI1j6KHIHQK9LOmbLrx7WUY+PIf5CzZRLjghZfUGV2iq71okf1io4xTprjMn+F/t+eChz4YbSjYUoTi7ptlHK+jk+NjJ7CTFZAj4vWIS28dSD+uwyI8jjiPjpfCWx9H0N1e6j+4EAywfc+J6st45f1J3YbZMbQTNtI5NUAB/BPMQxq8QG4RpvxPk9WKh5tdkWB7wb0jMpwqFy0x+mp9RXrA4oJ1XfDUVs9qt13Rs0301Xjl9Bvtudm0OvuHhr8kK+4b4KEd5Jw5Mlp7sCbTaJFyURp9Cgq/RoWzqQjvpS3QFGtp0/Eb5BS5mPGSx0pyLTALxRoWAzyOSqPbVnved9u2zdu8Jfrtfl9wbopOy+X9hjV3atsuWLMyDwKwT7/Ki+/gMhWgcjBxz8OgLCL4FYsVhLAgLHO15PeCzQX4cUfYwD3Ecr/IH7mhp9xrba8bfMRDQGCHBXVYUB+0oEQYBmG0K+ZtAeAsElEPtgK2+EJER8SpvzlSSnsAZ8uET14RLikN0DLzMOQ4dyTLTrSf8X1bKzpm34clHYT1YXo1+moL4uuE/cbved2DAFAf44BhsgZFF57PICwGCfDFIamBcIoqTNE+i4NUDGYyNwxWzPYkaIi1u7zF5/2uwedN12hx4Rp9VzQMU3DXatvdptPoaPDSMSFoA48QG2qIIB4g7sBAb9Ko7vOv1uk0ADvSYx0B/QDWfJjeIOYzMs/gn3S46qK9l07CPQ1zohzaMMCokAbGmSvZkbZsM//PpEdAajsDbPXsdqvda1rzRqfVMvu8Z82Fa/P53BRNu80/zj/B4G8eOQUJO4XbieDLPJ3CE5hLhwAgsUB5QU5236wIgGAY3HNvF8CvwF+N0c/Gl+PpX0ancGsy+mE0nOnL2c3kki5Hf70eT+gqQ+u14eByODrHmxXgXqC3O2dQWJoBqvySqjv1bZ/hHk4/YdTn8D2KKCOgCXLkgj4nXs5zgbGby59Gk/HZePDdOWYhkJBcjJXcmKekCpj8XK2fXBcGL0izo7JQWUk5J6m411uSiBLihHxnpSsSbwMGtuqImPUtxYgscq74F5QO72lSuwoFrU7HdFttp2NanY7VdThGS7Pda+l4qVi4/AijfAt3A4ev2I8CooxDsXEeOJvXGRiq6k862C7Co5j9PQHaK8iIOPz7Va4g+72X9xz/+jCPDGJUEvoczNiHSI6rYSUwRRaeQHLJimEtr45soTP4EG+hWSWHseLOvhWUp1JeTcLS2ruX4uGQ7Byw6Ydh03RJHbzZwZv9m71ZtnWyHxAanGLcH05GAypNXlydjs9+hovTkS5Wno6nGjCMLvXFzeX51fBHuNB/JqOLq5/wwXQ0y7BRWeBJZukIGzIemfT3gxGKzVTcrd0gBE9XmdjPACieFvBeX0l5rQ/yrIeltJdVDmm7REQv1qUd8E82uKgJuCVyoABSkz3G/wmbEcLKeH5pmBkYXZSA4xr43NtAYnY7IP8GQMuVnjCsdqNvWqbVtxpW404FDpBCpH5rn7JxmcFL6p/bs1T1YVXiYRHwAGA+092uPZ+C/opRBxy1qA/BZYQB8hkFSWiL/V3glNrvNWvVLaBOU7g9UlWnZZrgBbtW07RNm1IMRUjXg8e+G7zdpWeJzRW131+qrGO+b1fhvq2472juLbtpWa2U+62R3+XPUz/+IjPbK3HH4DO9T/GsP6INkP+7nlydjcnZTK6085mNZ+ejC/i7a38XnGgShrAcPYRT63UQIot6bBJAsZvuRpSdy/aYqZ+Z5P0L3KPj3Zqn55MhhpWDKApsiVsa7EHGS90WEYhm8IjZfB0n4CEBcsSAvSIVxQAv6Rb1qvcrLkYM11QAuoDuWMl/waazeeOOI1EA7l2XFmqlErPlHcO5jEMESl/ExiCXxtZchlnxR5V9IH56CYIn7RzsIFTlKwdDf1n+ir8HAJREcbD6UWwsBIT0g6mxLGiYPW1sP23Q9IRiFdyLUx2g377Lh5GbuA4DXDphyu9auVScVD9gXuAvRIjTKxeAVdDvYJ9oDbARd1wzB1nfZ6+1Yeowb5on9H85xO+IefRcfBV2Ut7ffF0+bSx5Lp9RKW5kjv46Gt7MVPZOpYOf1fVsNLkYXw5U7SDd1zytlQoi+e1chNEWq7/zVftxC/b5acaH8LS162THUJV8R1TVNtgEcGqIy1AqAJzaFqJnXLDShwHV8ZYPOvahfNUwcPYIJ2fSF8Yi5BI5VIV4GzoyqmuRcmnLU5FMMTy1q5crk6ZZt9h33GHa/zGN+2mPKeQ2Zhb7xNYbX0J/lnYBW9WZ4M5hRVfwecfsN1pup8V5o9eyupik8mbTxASVTmfoInhh7N1l5++FL0Jpg/+wYUb+QYGKg+6JARp8/9oy0dhD/2j1qm0mZrqDEIuvEIE4+254zVpdhnsSCd3niy0l+MbNtIJzQHJF+CqUC+m/FNxPR2eDm/MZpQz/ezOaPpctDDAxoJwdWIW1sAweiGMtAOZJESRkiK3r7FtN9VsQiPtRsaFUvzQgdYTLEy+GHnr0HT2KpNXGStGUyG6+xuwbWRf1IzYXdJghBqQ55xHVCaj5t4i/17FxrjX5LVsCjBLhpzobZN5LmX9EhyHmAJCdgtdxEwQDBBZwC8gPYmmL8lzkqqw4TO1JzouTgsYBnO+R+9gxboeQmEUrzFaLZlHPD/CsNFfmblZQGql048cIi6AlADRyqoDFILOhM3faHeF0ReB4/LRd5rGKDpLc3YVi5jQO6JnNk2gPu7v2wP0YJFr24F5o44swfCtvRLORTpP2SDq2U2fdKpuu1PAZHbU42O7Bdg+2u6ftbj+c6B1u/ZSgj1WFPjc+T0C/IQXPCvQJU4CeNlK1JjWRRwjnNUT64fMMDPuL8LG9+LqWeo/6g/CRCuXVE7nZfKj787QWmob+fC6QQdKjksAFTyScE+I755gUpVTVrI52FgDyhQXq74CI4DVDtgkSxkFlYeLT/h4HSOwEIvL/HKtSuEa95AFxVN8x1AGHA5I8IMlDNDpEoz9MNDogyYPtHmz392m7LyLJjCuyFo2T0mMXtNL0c3VKCxrkZy0zk8t274poBYmxDGPVysihNm9Yc8vt2qLl8JbTafbdht1p8HbX6lrzVqNbK8b629yOMyMr21RhvtU8quNlIsT3KBIfFlcUB4FTLv8luIngoltD15PhZtA5qPQux46tKna8DGKQDQgDdgyfKS/eTM6RPgxN5FFvahcOjVbvueBGBkJKXMOgaRl94LtnB+h4gI6H8HMIPwfoeICOB9s92O6/Gjq2XoOOrTdAxxZDiOUixPpPQkcHcAdCMxcmBWRITwdkx3N19VGbvT7mlQK9Eops9KsochYE7AJ32DVYikqVSL/0VhPAV1jQ/iad/IhOCLIFuEgf382RgTrriscmAZPi6QVPriTZMQoEdMONMaAXnJTNpOstG0Vv8UfkFPAIB50X4xKWk3AR/gEFqoMuwFF/YI1Tz9Y/VQ9mE5T4HCVm+K6YQJvP6r/tXacE6O0ydBdTNdfPHBdQNXPuQxohvq6V+8og6AGqH6D6Idwfwv0fI9wfoPrBdg+2+/u03TdAdY2Gnofq0GBvqA5t6ybLsNQZLq5/O2InU9Ec0PJmgU1Y3ckxOOEKWEr6u2noQ/C7ZSe1460vvoBPOX6UzhO0UFmAYioJPWicfnPmEeYK5uipzteynp5m9oMH+ujMfXOH58GDpsrKwHc5ifp40OB6rFONOmk4lLiIlcejAZS+SSZcruknFF6kn76RsIEshCkyR3i8Xy8ouo1vCUI28eeIWtdpAVVkBNluQu/pNXl+ar4khyLyjBy71PfiWNCeAZdb4iH7dzhdMOn03g7M102EbxmSqxokONG3d8U2U4TmisNKyzzc4KZAo8LQFTZrsO8ED/EzTXRO5psfPs8+sQUCUnIICX5OjwmJGQSY1DUsI3J4g/TMCHaiGBQGyUK9CzQoncpBA2OuB0phv/hTIdht+l7SJUSCCbhuUjt2EuQtsFfhq0jiXngYJLe+iCQd/xi0eMxL/T5RQKTMQfrqRD6eecfPMp1K9FP0DQhso0WkRJDdrlO5eEGu9zLxp5SaoagZRC36tMWFUu2t/rCHDVaOJLgXkbbePbiiZxToYZoFd5DqNg+oCc1H+SyVnc7au/ko0TOQXpmPX/zP6h2uUjemnBuLIFh6DhszexkEkfgfxnDpoKncLhKwtHezRS+OGWQRRsMssGSoIQ1pAHYk/gpf6uJzjN0EXQJVRSGz/ZVmFvzCr/Sy568lmen2LYRYbOkEdvRunnFAAwc0lJ+INP/6XSJgFmwbZVCvFtMCGObzT55AM1rwi4rWTs9P5I+pD4YPG1glKtH6RP04yZ2gvmL0AFtnbcBNI/TOTpfhm9maFoaxkrLSosG2Bqv8egFEzy29KX6zrU+MqP9t8qLEg7y2cuV7m4/20s94kv8ev/sf8ngHT/NH9DQaDMv0Xd2tjzXgIleIrlrpi+jdP/gXnpKlEuoG3Kxe30QMUySz9niMa5ps2l5KQTWCteD04ugRriv1QUuExGj8kAkSoQV9IzYEhjlkddLDNwXZZ/3FrBATMDybC1R/C3Qmln+X4zSdOIbv/ic+vm8KTCQrxmF5vDK7jozsRDkh/ZEyxZD6rlbWK7VIXDaoCnoJVYSr6MrVnwUpTOIrY8EcRrqSDIqkF/3Uh5RzQSbCo1WG7coQ/TXasHIM/PolpoDgQQFMicIIF+NZhSIQ8/X2RRAujnWn6Bjb4ov6ILxaDM06JH54ax1EMeSrBbrfixgL5lsfoK6UkR7z8vnbP0StfT+C9uM1lqOQlUQlGiqxu61VEzvoeCIdfCFzCVxjm8dHrFpgmvOEtyFbx5T49i7PYiibAIXiNSSPLpjr9offipJ8M9EfuP5E+y67P2a9k/u05OZv8my7BpdfBCbp0I8+16CqKMSUeqDqLIUulZ0IzHuy3Pf7EUzk0/8DLaD6AQ== +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get an Account Activity

+ + + + + +This gets a single account activity by its id. + +## Request + +

Path Parameters

+ +An account activity object + +
Schema
    requesterIdentitySummary objectnullable
    targetIdentitySummary objectnullable
    items object[]nullable
    + +Individual actions performed as part of this account activity + +
  • Array [
    • requesterComment objectnullable
    reviewerIdentitySummary objectnullable
    reviewerComment objectnullable
    accountRequestInfo objectnullable
    + +If an account activity item is associated with an access request, captures details of that request. + +
    clientMetadata objectnullable
    + +Arbitrary key-value pairs, if any were included in the corresponding access request item + +
  • ]
    • clientMetadata objectnullable
    + +Arbitrary key-value pairs, if any were included in the corresponding access request + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-account-entitlements.api.mdx b/docs/api/v3/get-account-entitlements.api.mdx new file mode 100644 index 000000000..f849e3e38 --- /dev/null +++ b/docs/api/v3/get-account-entitlements.api.mdx @@ -0,0 +1,104 @@ +--- +id: get-account-entitlements +sidebar_label: Account Entitlements +hide_title: true +hide_table_of_contents: true +api: eJztXOlz2zYW/1cw3A9NNKZsXT4009lRbCd1x4m9PjY762S2EAlKaCmAJUjbqsf/+773AF6S7Nhpp11n1Q+pRQLvPn4ACd55OhEpz6RWR6E39CYiGwWBzlV2qDKZxWImVGa8DS/jE+MNrzx313ifN7xQmCCVCU6GqRdTadjo9IilIstTZZioUWA6YtlUMG6ntxn7pEYs078IxW5kNmUnZ+/+Mzp4f/SB8Tyb6lRmcwb0UvFrLlMRwlAW8DgGIpZLG2QyIshxIMh1510ake5rlYnbbAQUUFYZqqFjaIap4KH3+R7ETnjKZyITqaGJEoX/NRfpHEgquAM/YzmTmbeo4Xt+y1Q+G4sU1UmFyWPQDCSzGrc/qXMh2NU/e2SG84yrkKch29dxLAKkwU5L1p9fTbMsMcPNzVBcixi90DZcxomWYJ5AzzZB+k2eyE3j6PhBScevVHjNIp2ymU4Fkwr+nJEv0TqF6bxhxGMjNjxxy2dJDOp1B1tgvGAqZtwb3nnZPEGdga+YiBRmWjL2Uq8LF2ZSyVk+84Ywb8Zv7d9EJRQRByvQr/v7jdXW1FFkxLI5T+gyiA0WxNiIcvCvtSqDG212aXJw+ZyZRAQykhAFFCot8k4LDZ/wiVQ8EzA/1flkSnScY16MO36HM0rzP2x8Cv8l2x9FrJWluWgxmYFVwfCJTvLYmlKw1r/8C53x2N/H2S00aaKVEWwKWQThT37AgSvSYcqBos7jkI2FywzwnIxKv4H9WMvGRIvdCDTVRIHFQvAY+EyqQFDeC5NJNWEcHA2iMFIEioBiU34NlYSBj8g4OF7OEh5kG6gNVQ3wGNSdEBgrnWGkGIFcW0Tke9K8hTKRtNc8zoW1Ao4GsXNTSPMiIgj1WRFEY61jwZVXixOaWcVKwqFSlqEiQ28FFZOl4Abvvi6AZbhY/8vyzohSKZ4not5utNfv9XfEXn+w3R0PxuPdfrfPB9u9vZ1w18OyXMSYQd7drS38X5PDSDGepnyO4VZwEs02FWAHgHiHuTxJYhmQ9TZ/Nkjgblk5ogfzZCZmxBgKzklEfcGN0OOfwUcN819Zg2ErSdHPmbRCg9ZLMp/PDZD2J0Jhm4V4zJWE0GZHB0VLPCkYNO1dt58MO91ef0BC8PBExXPrgvvCdYtcP8DVZ9DnOB49HAD9TKxQYx9vYMCHWCKeTrm71Rn4WwO/u3vR6Q+3doadnX/XixqS8zMJ3FfoNtMhlf1lcY65yZi9HfzZcoFgFHIw6g03Yh8qjVYHmfYwqxaDpil2DVMxO8QWoFQkEP2Ek2rx7C3GF89AkXGefcHhNRKsmvKo/y3k+o1MeYHDQEmqisuczviNK5jL7B5lsv/he8RoZiMMvi8LI/6A2oj8GmwWuVrLkUr1G4/xG0FlhT5xADkbZDqds4N9ZFNaxDzEZcFypuJSupWHocQ5PD6techWxVKCO+8dgJLkws49L8AqlNjRewejP9jC+yafQ6/HyDI6TwNxTmXKhrGdvlRWaIQLIhzCIAfQGxPQGcpkVftshM14QkgVuqdjzUi4Ry04oRH3GIbyWsYASFak4gF2LcAkwth+Cu23bkb4Wc1uV+yq3lTys70JilCs8/CdvhYIHL6G4QTnCkId1ihE8WnMrQNqHeKBVD6ncUv5NobOryZo6vZS+mbOk4sGX1Dv4oRl5NCImacwEQrB4JV3fnJ5tn+IXanyoLsGetne9Dhr25OexrSqpMFeZ3drtzcIO3sdvrsNhTXs7vYHg3F/3O11uVdrUo+z/yEHLOdjteXjGKClK2nPlOeHM7aY+V69ZtdixfoQ7iL8WHGfijr+t+H1V+GR/ViiJIdpCojNZ2c1rGvXIYRh2ViHtJaVCuqmpDh8Lkwpg7AZUaHIoJDu6/AJ1n0LGeNPUi5RQkEiBzARslNfyxCBNmFOS7Ks7TiuaV+wRLvD3vAQ9LX67Ttl0MgpD34BWkdPiLZLC4SKKYAZCfk+wFbsCD7e3trr9qPtPucQYZ2dwXgv4r3e1t5gbw+5z4QxfFJPthLfNVm/QzQmAxbrADzyGxgEog5sTwIQ8zokfNwHROMJ9kd4bMeWajp5Ge5ZbMCC5s3+KevvsJirSU7X+WTBCMq/PEe8DitlzJESKVnCJ6mcSLVKlKJGHBy+HV0eX8CVs8N/XB6ew19Ia2kvB5C2VCGGpabF3VTfkMROgRtuYEGFaxeo6azlqLZAIa5MfaC0vwyBYOZWITDDcV8xo06aRameNVIpsBs87JVsi/YG1ACEgTwLpmwMUCwsmmALepxIMv/YWbLl1q2v22xUdm6LYgzMn+OSD1p61TCiHFJZ0DJX5xmuCmUgmr6oTNn0RlVJjutOweQAyb8cJ1C8chCO1KxnYRktTkTnH5DZWq4p3UXNaGTSucpggSwD2lAJdIqlkQG8gRWzYa4cobsMFB5VjCsrVqOAojTvrTC2QkI947l5Qt6dxlB+fFKtvHEtXPIRPrHViLxRuMlVJLdJRJPdqNJdReIzWC3E4Tp317m7zt0n5u7izTO3C1NgH4Q+nWXoc6mKNSMosQR9UooepVljYekcucHAIA4i/fjxwj0EgPHiNsH9lT8QH9lWvryPVPrDXh8j/Cid1fAFCkh2tBpEUIlEOCS5K4ktSCRT9Za5vdXpWEKAqhUQEapmyuY6ZxxMluZK0Yan2WChFkZ9l7mtTsgIY2wFRK4q9O2u4hpJrpHkuhutu9E3043WSHKdu+vcfZm5+yiSLKWibHE4yeSzGU/nNtLcfXq2x2BA9cy5TLnaE4kKrSAxVmIsr4kcvHG3M+5EO4Hoh7wfbvf2om6w3eWDnc5OZ9zv7nj1Xn9V5XGZZM2cqvnb+pFMDCDuGnBcriC4TKZ12Nz+y/EBT4RljXbgC9wMNgeTfq6wY3/FYx2dgW5AGLBj+sD24uXZMdIH1kQe7WZ3TDFpaw+ZEFLS821xK022ho5r6LhuP+v28820nzV0XOfuOndfZu4+Czr2vwQd+8+Ajn2GECtCiPVXQsdQ2hcVI3AK6BDkYF5Vey/I7T66tM94OhFZCfQaKLK7t4wiL7Rm77maF2DJNHYiVWUuLG8wdoZj02IsDODutRKoWhLQLUaVnAnEpPjWFb3WiXmMCgHddO6Pogy0ci+LungruUgVxDlISEUBH+Ij3xsu8Zl+hPAPKNA+6AQK9R+4x+m89bv2g9kZanyMGrPD20AIzPly/3ew6i2BIxA+xXJxbn39wOsCds+cK1hGiNvElq8Sgq6h+hqqr9v9ut1/G+1+DdXXubvO3ZeZu8+A6g4NPQzVYcCToTqMbW+xEku9peMsfzZip1RxElB4Mx0QVg8rDE64AkLJnabEGoKHbIbeZnEUcfNOhvebCwdX7ELAypWnMYwvjhPdgbvATfdtnsg2VDGcN1f6hs4UXfdWFB9819QmGpSvMLcnlfAEk2XSJiOnEuPYFj1iYE3uzgl55Rv6j9Iv3tGdw0KEWTIb+Payiym6DGImsKD4ztDoNsXQko6g22Ua339JH3cS6wE9LJEH9Fhlvkd5wXgGUi6o594WLo6e0nv4lvvSAdSqm+Cef3eJ2QkO67I3gqewLLCvwbz68ePFa1Y7LWQQ6gqJCwTImFMIEapno+KVEJxELaY6/zhqvHSD+cOiGBRm7jjbkTPCByj0Z1CZyaQ4SVAxwFlPP8zGG/MeOLz2SfnubWyJfRvHOBXtAb+rpNCL1/T6WiH+VlDzLTWfqJnXC1JY014F9iXuAJIYSfDYkLW+mrml59fo4SoKriDVRRnQEk6O5qtSQeG1r5ajQc9Hek05PqmPUwnNtDmN2drFzJROcB6xYKq1EX9nDEMH0+BqkkMWfbVYN8jUp4zwu1s1kXzL0pc+QEOS7xgSQ9lg4mNszYRMtN0koZT8iTwLOf8THSr9qaEzXb6CDoojQx0844TmgszI0EeGvq0BxslvGxQGFuQ26kB1wAbAfuV/qgRO0FrNs7RWVnUiv0lzsDUEICpRMcnQ/hhWBc79xegGji7HQAlGZF2+PIbH5x0t7FINYxV7AosWXJY31tAcF+xm5S2fbGLD/F/TFzUeVVsneJ7vj67SD1SS/526+xdVvHWl+RYrjcO6GG7E1i0K6kFu0dryRp6h01zwL9ylTCVQDUuW6rsCdTJJzDOMacrpYCoFbQEkgmeI/DYwrvSM8hDgLiY/LPSI0IROM6cgMIdFm4yBXpt9xGNkAMRTXF/hq7dA9WftFlrnYOVTdBI7KBzH8IBvrvB7JCBEPmMcwuML3g2lCXJbhGC5pUShmSYYV84qMhLDBk1BJxRFOjMnEe4VSzyH6D2RF/iwOP8OhkSPuEP9lSJnIqYow3FN+P0l2hA5/lTEdBYUKiiAKVHj8P7oYokiEFPu6YROJ5tuktnEsXi2GJS3wdBrw7qOzphqk8FytEa3OKi68CWahXPC5db4X/ABGtc5EPJvJrhXhYrkdgliV31XXrHqg+FD+1mEujqwlJiC4jjw7g73NXAVdI+X7Wc8cDkIXsBAr7778KAFXtYHalZa7xeBOwXF93fcXoBHZ+ufbof/ry/LPGLH8ss7X2nI9WdiXt5nYh4Jh+JbQFU0fK62UJ5Za16ducr4mp77Nr78slKEYqdfzesSFKLBvPvPMMpGDslib9jt3dqUpQegqES55fbuEJsRfwDauz+GV7hZ91+qF+zn +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Query Parameters

+ +An array of account entitlements + +
Schema
  • Array [
    • attributes object
    + +Entitlement attributes + +
    source object
    + +Source the entitlement belongs to. + +
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-account.api.mdx b/docs/api/v3/get-account.api.mdx new file mode 100644 index 000000000..7d2f40c5d --- /dev/null +++ b/docs/api/v3/get-account.api.mdx @@ -0,0 +1,108 @@ +--- +id: get-account +sidebar_label: Account Details +hide_title: true +hide_table_of_contents: true +api: eJztXFlz27YW/isY3ocmGUvWvr3cUWTZVStbqiQn0+tkXIgEJTQUyHKxo3r83+85ALhJ9JZkumT0YlMkcHB2fOdwuTNcj/k05K4YWUbPWLGwb5puJELjyAjpKjB6V4Y+ExgfjwyLBabPPZwAwy8DRsI1D0h/OiKhS3wWRr6AU4xYLKTcCYjt+oSSgIuVwwhVlMhyS3gYkNFJmZAPog9TPzFBbnm4JpPZ2XX/5Hx0QWgUrl2fhzA2AMp/RNxnFq5iUsdJli0DowEzIxwIzN4hT/7AFSH7HPaBAgrALdHTSwc9n1HL+HgPsnjUpxsWMj+QEzlK5FGYcmQIuAC/uIXUzTXbUKN3Z4RbD88GoQ/iGPdHRsyV0Qv9iO1qR+sNxQQy7DPdeA7OZ3a9Y3cb9UabdRvNVm3ZXC47jVqDNlv1btvqGMiczwLPFQELcOFapYL/ism7y9+ZGeISJooNpoOh1PMcbkrDHv8e4Pi7jCCgwIkthdYiKRpGVqIrpQTUk49OEnLFC+hkj5X5NgjZprRiAp0JrBQJ/kfEQHLi2tIdJvECeR1m1cKtaq3eaEomqDURzlap9T42x+6qF3D2BfQpjkermUA/ZAViDPACHBILrr+Acq1SbZYqzVKts6g2epV2r9r+HwwA199QsIaB5Eohh9ULZNu4Frd5ETtjGoREXTb/ar6AsZCHkspbGrCBu9m44iR0QX+PO03gRr7JRjJw5KHU+pFBQ+BvGYXgRPBDhzZIdYMXLR7QpcNwkuOan+SBkBdHFjg0hjaQk06WpqdImK7vM0faEvRIRQR+vR1kT65pMBRSkA3TGSzvzQm7e+GdU6TZrXYqnXrTqrFmtdUBvVr1mt3pVkxabXaqxm7oL8BAezGg1lKZK8mEzHHFKiBSs1mNPcrPEP67WyZ1ub8waNNz6JaITHw8vTbXmv5rdBGvlucIDlObar4yjtPbdz1qWRzXoc40Y9eibIxsxOukNGF9Cr99uLZa+Wyl/SYR986wuR+EyiTGHLa0qcul+zk0PR15nuuHypFR9bvDSTwC4yrv/KlMS9d1GBV7+hsJC+MfeOX2nrps390QKkiOqLZ2Vg6bOgFmmxzpfTPv7DAk8zu2HE0CUESOg2Eb6ztZDC/cZ6L6xTKynEdE4BEidLYkkyb2BNN541stlaShvYV28tKTSix0/3jNdMdcbrNxqnJdLu6azVq73ZRZIpcIiyTOM72nAeABDaacCf2JRACaEqYQh3FBYhEv3FuAaTBJEUtniWSG8sI882VkNZejv9LVhRvmswNywNP9Yc9SUcQLc9kL7EMDBLLM33CR2ii+qPFU1kiB44XlIEkH+Qi5L9ykvsJjYXeDJA7IOSb7Mv3sbo5fyQnL0sosp0XnmYjZt8Az94NcZkbrxttRo9Wq2I2m1apUW61q26K0W6tWmp1GCpBGJ8OLxWjxawrv+xbdkJ+ZANtu0Vt3N5c8VFBXd5k/WUyIvFIAxES0kfXTYDC5vFhcDyaz2XDcX4wmF3B8cTo6g0FwcTifX09nk9PReJiemA1/uRzOF9f9KVx61x+rK0gHj6bT8WggKcGvQf982h+dZQ+vgdhiOMMzw9lidJoZPL6c6yuTi4vhYDGZXc8HPw7P+3BKKmg8PB/KVc4m74azi/7FYHh9NptcTuFURofxYYb15JRmHk6NR6fDwa+D8fB6vugvcNC0P5+/n8xOrqcTkAEpzSZy9uxS/ptPMpfmk8vZAM8u+mfq7zVIMjybzH6VP+c/w1rzyzEuNRtOJ7NF+hsJvRtNxrHksRn6g8XonZIB+PhZifYxG8UZKWMQDNB3geaVjvx0UkkziXImjMbbNTfXyr99ZjPYaCBXyjqN5eIldulmq2M2a10TXbpjmrRlA8Sq1qt1I1MRPc7GjxFkhhJCe8xChcDwC/h7zx2HQ+TAf6wsd2uFWTz5JAtqJ7ew0xXHvouXnglU9xNAw2yanWa9wbrdBiQA1u0wZrfMdpPVmmxZqT6WAAoA2iELHLLAIQt8+yxgMxpGfq6Ie7DqUBeIwwNEfCKkXODvUOUKPFRZ4geof2KyufL4ov9WetEO/rrHxlrMZIyf4Syw1yjqsA1AaMgNQ993fVIiM9ndBCCiwQ+2PRiwuHQt2aPk4oY63HpRJ+7xZKOaqAPXeoaVTwGillY+lUiVSZZNmEiA4g23UGkb14/7srHd5bh8dxI0Ua6St9QCeZV8Ay0MWtin5iegVdwk2GkOK1AdTwGIJ5vBDyzL2owuW5VurWG3GpTWOo1qu7ns2rRer3Sb3S6uvmFBQFc5H6K+T7d7S59hWcVNrOLAIn+CQsD7QfeSAbk4TOFQpBT2FPI2kDSeoX/cydTYREzNL8Fe9BHUR28HU9JoE4eKVSTP09WOEkTpcl5UNyjCE5+veGHdHm8yJ8PTfpwHdfJFWnuN+z5UBgrLu3LnXbu3kmMtwC3A+YA5oA5mlckbTfUNCERFkB3I1S9V8YFv2TRyQpihVy+YkSWt6sZsKJmqcU9e8TIrH8HGjx1QGkJGWkJOsYirbi68geBlXlgaa02+IWvIbsx/XSb9pCFEIBqBKMzfAiFCLQtDVxGwI8wastJ1oxBLS26yvC1SVe72OeIMMs4aBYMDOH9GejNDqNWkT+SiMPEWzaK2D/CsNJfnbpFRmlTpFtKkCVKkZSDk8yXIhjdadDpCcwWQeEQ8LslY2ewt0925YkYmb2yZ0yh4RtxNHUg/JSlacuGG6eBD/KazkbRGbCadkeAiii0n61GJueLAJzZnjnWI3UPsHmL3mbG7e3Gm7yvqqxL6VPehz6XQHWXcPPegj89UQy5uO/+pbk8pQx4RUIiGSD+9X+ibuzCeffbwLtE3xEdqK9+/M5rYQ51fxugx3vpTWyCDUo9KAhsyEbN6ku+UY6kopar6/mqnrr/k4KCiACLKvurWjeQdBj8SErzS4IhYLgvED9g4u5FdNOBXZUBcVVglD6vSA5I8IMnDbnTYjb6f3eiAJA+xe4jdf2fsPookE65ktGicFESbDfW3ytP0dZSWEhhA4ifcSBJy0lS7aAWJkQRjGXnkYCxr1WXVbpusYdGG1ap37ZrZqtFmu9quLhu1tpHd66/SOE6CLB9TGXsrO0oVA4i7ARwXCXCuIHRdK9/+A/X6zMa0Jm+6xrgZdA4q/Zhix0bBI2xuCLIBYcCO/gPtxcvZWLViFXnUm7pHgkGr+7b4EAtCSnmTnH3mQXiAjgfoeNh+DtvPd7P9HKDjIXYPsfvvjN0XQcfGU9Cx8QLo2CAIsWyEWH8ndLQAdyA0s8EoIIN+zhTk8EAUONLdRx32IfVXLEyAXg5F1roFD9G4LjmnYhuDpSDXiRSpujC9wdgNjvXjsTCAkhWkSEEga3FAt+hVfMMQk+ILBw7fcBnHKBDQ9belvh2CVCpmYn9LVuHCdCLgUCYFfHJHPldAOT7IYyP8AwqyD7qCRP0Ne5zaWl/VDyYzlHiMEpPhZ5MxjPmk/9ssekpgBMz7mC7mytYPPC6geuZUQBnBPnsqfSUQ9ADVD1D9sN0ftvvvY7s/QPVD7B5i998Zuy+A6hoNPQzVYcCzoTqMLVdIgqVO0bn+csQuQ0VzIN2buKbE6laKwSWuAFfSr8tjDsF3xnvGcfyK+fEdt+4NfC0d8aBiJfIdGLIOQy/oHR/fgYXAMvdl6vFy/OqLcG/Lprs5vqkX5Bv1yhX6CmQsKzJlvYBv3atFylKvPkfXVXlOLqC0LCVBJwVte/rtxYfpx48Fb6H2IIrMET7brt1IngY2Paghfgjk6LJ0mz0ZQbZL37l/Sp539cfkUEQekKNIfY+uBeMJcLkjnqEeDI6/IjBHsK1W3/uWQLqBYJu/trfYBIfVyFtGfagE1JMvr356v3idedMvwo8hEMaxJoAgmYKLyBTWj58CwUlyV/HdaLWWjPdzz9lgyBDbwffyPog5Y+Qq864emUEylirFSUzGP876+Cq2jMVumIPbXjnVJDoet8QxaOiY5ua9llucrAW4UK+Ow9nyB1EiJxwzD8etGsdoEWVpR668WC6aketLmfhPTK2kqJUkteD1DhdKtVemem7bhLhFEhQ/QwHa+uLFFb1Shh4WTnAGqe7ygJrQfOSfjjJjq30xHzl6JaSX5+ODeC+f3s9PIypdkQC2P8ciI2KuXTdg/yUEXQfD4GoVQRR9MVvylYGSjIhSrZJhqaSWLPESoEHJ3xgCQyhnokvcjSUYcVVfRIbkb9KyEPO/Qa1skd9yMsvTV7Bp4kjLNYMv5hkXLOGCJZUDAs2//mwJMAuxjTLIPKAcYJDaX2YCzWgm5ylahVldkj+Wc3BrMIFV9QECr6d+9NIEp4+IvICjkzGQghFMJ8+L4ZdQNK3Mq+VKWXEbYFeD+/w6LuyHO3pT/CY3M3GP/KfJixL3024Jfr3iW2fpBzLJPyfv/k0Z75BpvsdMo+EtuptcVtcBWSdXaG2/dyc/BMXgL1yVkSpxNFQp6qtOiGGyZDyHhujTMqbNNWey6vcYDRH5HaFfuRsZhwB3MfihtpOEVvLbPT4wTKFO4w7QK5P3UFYJwN4+llT4tC1Q/d3VtVX6judJbDiCn7OJBL5uDkxEG0LBPZ6wrsUDM1JJCCoswWLJXAnjkllxRKLboCrKsrjwN8HExvYwVJ4ZIz6xFtgw0L1hUCRaRL+2mgoyw1fjMRHAuDz8foo2eE5pzRwPizrIoACmWGaF89FijyIQE/qGhOuvjvWk4BjHAhEsdZQz1MtQyuEpzw1CqEAzdONvVp0o59/1o7u0Ef5P+baY3kmwBDj2sF0lP2uhShJV+F0ZceEHw3vcwrdI1yA5Xrm7w14GlkH3eBpqeCyUrz6mVY6sDtMvpRR9sCOrlVczzexrkv+8WCGfcfNNbNO624DDTwzLdWAVilpgVvZTJCPqguq4ZKbs3ZPAeimpgs+G6Cz0ga1XH4DQkFz+DxyABLA= +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Account Details

+ + + + + +Use this API to return the details for a single account by its ID. +A token with ORG_ADMIN authority is required to call this API. + +## Request + +

Path Parameters

+ +Account object. + +
Schema
    attributes objectrequired
    + +The account attributes that are aggregated + +
    identity object
    + +The identity this account is correlated to + +
    sourceOwner object
    + +The owner of the source this account belongs to + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-accounts-schema.api.mdx b/docs/api/v3/get-accounts-schema.api.mdx new file mode 100644 index 000000000..c8f186872 --- /dev/null +++ b/docs/api/v3/get-accounts-schema.api.mdx @@ -0,0 +1,96 @@ +--- +id: get-accounts-schema +sidebar_label: Downloads source accounts schema template +hide_title: true +hide_table_of_contents: true +api: eJztW1tzEzkW/isq78NAypdcDJnkYbdCCFNMMcDmMjyEVCF3y7agW+qR1AFvKv99v3Mkt+04IcBO7QxUvyR9kc79HH1HVl91gpz4zv5558TWLlO+c9Ht5MpnTldBW9PZ75xOtRcHr5+L3H40hZW5F2GqxOHJ78JnU1VK3MogcjXWRsV3MstsbYKQITg9qgMeWyOk8Myj/9b8c2Pj5avTo33REMc/sNUTI4PKMbqYibF14qkqdKnp0TNdqETA9zc2Ot2OrZSTJOTzHGJOVDiIbP0Ji4URlXSyVEE50vCqo0mdSoYpXhm8wJ3Oce3UH7V2ClSCq1W3E9Xq7F91wqyiUR5qmEnnet00SkS7CSakPsmyKmjGz9nW3qZ6vPvzrpRDle/Jvc1Rvpc/2hkOH23vjEed6wvi6ytrPIwOVtubm/RvlcFJnUFdP64L2GNufxiDjDyGQcAzsyYoE1ha9SkMMn9J1wtRdN4lZbsTfanMS7oay1IXM75UvVLqolvYjC3ZLaWRE+W6E2frynd9kC48hUu6yuT0v3N9DSsMb5P1sNCQQxw5B7/1xLEKtTOQVY9ZXDKy8kGMbD4jb2tzKQud91dVkFVV6CjL4L0nulfr7rCj9yoL5F9HMRB0tGCuAnQ5tLlad91Nzz1DrPYmTmqSULHIGSYKULzUOWaI0jolIklhowo8rr/iZ1iivyWeyBz6Rv0OkzIwU3Ay+wBaFJ/3CXRmNOaL+RTEE8f/HWzVrpKjx5t728Px46GU2z8Pt3YfjfbGcmdnc+/R3h5xLxE48KVf4i2dk7M11r8oo5zOBAVBof8DgzglYXsWgJljCnKw9Pf7gGl8gf0pc+LYRs0kr6Ao7qJYPDl8LYa7opBmUvNzOblhBNM7O6FURnbIET2i9IXmkfArpyfa3CaKMnVJJe/p0bODsxeneHJ89O+zoxNcEa21CnhgEK05hSVERSxM7UeWOCnwUXrhVQFzqLwvNhLVDSgkjV8eqOOdn3kYkwqmrIuAGYn7LTOWSYuxs+VKKnHefArige6rfleM6FkpQzYVI+m5ivLwDdRFVYXei2TJDTFVqCLuYV8c5LkmJWUhkI0givkzEBIypzKjI4FxjVSGMDpMbR2EsUGjiq/4YmHKVW8gCXTgES+WnULJAcnvj5ODLNQQjtVczsImWpKIyT+QOVpuVbrTJaOxSWcmyAxaSKqrmXUOFhZYqIQOXqRyRO7yKDxmPq6pWFQC52pxufstCvM0WH6Xydp/Qd69LlB+eqxa8+JSpeRDGNhUjdgbczelioSXpDZPTqMad80THyuEKvI2d9vcbXP3C3P35svjhNDSW4Y+W+vQ58zIGvZ1vHiuQR/H0WOsmA9ieJMc2RUwSIJIv745RWJ/UIbGq08VYdI/ER/FpXxN+IPGH/H5iOBH46wVX5CAbMeowRiVSOX7LPdCYjZUNNXOOrdn1o00AtTcAhFRNZ2Y2VpImMzVxpAk0neBfJU3PwUxlZfcXEDeWAGJq8l7ldUmtEiyRZLtatSuRj/OatQiyTZ329z9PnP3s0iykYqzJeEkX5eldLMYaek9aSsFBoj5XqFoUo5ddROtEDHRYKzOKnLojLa3Rlvj3UwNcznMH+/sjbezx9vy0e7W7tZouL3bWV7rzxd53CTZak4t+Tv6kU0MEHcJHFcbBJcP1uar238wr1NjKmtUehrcDJvDpBcL7Dhcx44vbYBuIAzs6O7YXjw7fkH0wZrJk93iBi0lLZsubVcDUlIMw9LahxY6ttCxXX7a5eeHWX5a6Njmbpu732fufhV0HN4HHYdfAR2HgiDWmCDWXwkdc+AOgmZjOAU6ZDXMawg2VlAFV2n3MaV9kG6iQgP0VlDk9t46ijy1VvwmzWwOlvzKTqRZmIvKG8aWNNbNx2o6x8A/pQtULQ10S1GlS0WYFPEj0nmFviCFQNfNegfjAK1izszjreGiTVbUkJCLQmFp79UixjTCSY0J/oEC74NOUKj/xD3O5K3/aT9YHJPGL0hjcfQpU4pyvtn/fXTbKYHnEN5RuTiJvr7juEDcM5cGbYT6VMXy1UDQFqq3UL1d7tvl/sdY7luo3uZum7vfZ+5+BVRPaOhuqI4BXwzVMba/KRos9YyC6/+O2DlVkgQc3sJmjNXzBQaHEbzCQx1mzOQMEP8whvJBHaaUmTo3+xG69yJy20dFyzsXdEK2VAjDdLqX6g+d3d3vDNIx4MGVzq8HcZIfpEPHvkMsCVtGtWpXYMo0hMrvDwZX8Da8fN2Xle6jCMLhYWbsx35my8Hlzi21i46qxjxF9cvrjHsPOrEcmfTZR05TGsSayQyix9gqFPDwHJ9R+Cx9OqVLoTCDdiKS6QqkTApJfgwxK/QjP3ke3ecQXNMRup254vo+fX7f+Zwekcgdetxmvs/ywngBKW+oR+JfLCKEz21H7mtxsliM6CeD7TVmr2jYtniipENXEU/RPPj1zelDMSG4yuWi9oSUlab+Agn3GiHC5fBgfqKEJvEK5Ww9mbLgBytndij9xLiAwuKtOVFKnD9PRniJdeIYhZ1NSpMU1xKadfFg7plcXaqCltD+wpIUeEiBASw0kCvzHvJyyX2FNrgs+Wn/remJp5qqmKZln8YkFblNFOfVXC+5pNe3CvGPObVepNZjav7hDSmiac+zeAY8Qw0gErLwbK1vZh7p9ZboUROGJ0T1pgxkiSTH6kmrbO61b5ZjhV6P6K3K8da8mWqsxavTRCxfwmMpLXLxXGRTa736lxAUOpQG55MaWfTNYn0kpj3OiN725pJIvciyp3tAlizfCySGicEkR7SyM7CxcY+FU/IdexY5/w59dy7erejMj8+xANPI3Gb+m2Umhj1i2Is1wCf54/pGgYXcJh24DsQAOFz4nytBEnSp5kVat1Z1Jj/gObQ0ZBCVqfhqP97sLwpcuhL8gkY3Y1CCCZg3Z89wLxItWuRWjDXfUrhpwXV5C4u19YbdorzND6O03v7d9CWNDxY7L69MMfuzq/QdleTvU3f/oorXVpofsdIkqEzhxmxTT7Ec5BGtre8D0kb1VOEv3nKmMiZHx8M9HGOYZTJVIQPFNOd0NtWKdxAqJQMhvy7FlS05DwF3KfnRJzKhCVA5bWN7oFE50gXo9cUbtGgGsNtRe0Ynd0H1vU192gms/JqcJJ7OHQcAVZa1wVzKsboUEuFxj3dz7bM6FiF0a0bNNbMM45pZ84yksCFT9LlRcaV/NaatZnSxS068hxd86NM+MwxJHkmfCy4UOVYFRxmNW4Xf99FG5PSmqqioQUQFBZhSSxx+e366RhHETPpxw7rJIE3yAxoLItTqxGDY6aMtpEeV9QHd7LLkzceb6TzMvF1qPuJUJcWGuhlhV4vt9r/vp6Bp1eEPICvaJiMj1LF9iU3jeSdNwOh9/lgz9Y24ajpH9CJTWI5GX13Rvgq1Udf0+I9aUdN+frHokri7hFPpGi3qGCVDfcZ2D47TV6YP+Zeh5c9Gb5V+vhVoZotdgA4uPyjaPMA8tNgQl3d3WJT4Iu7/LE1pPgpd6ad/OaIwk3cs2ukC6qIs/Rf43wNR +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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.** + +## Request + +

Path Parameters

+ +Successfully downloaded the file + +
Schema
    any
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-active-campaigns.api.mdx b/docs/api/v3/get-active-campaigns.api.mdx new file mode 100644 index 000000000..98a8c6fbf --- /dev/null +++ b/docs/api/v3/get-active-campaigns.api.mdx @@ -0,0 +1,131 @@ +--- +id: get-active-campaigns +sidebar_label: List Campaigns +hide_title: true +hide_table_of_contents: true +api: eJztXHtz4ka2/ypd7B9JKIOReAiourVFsCfLlsfMAt65dz2upCW1QImQiFqyh3X5u99zTrcevGyPJ96ZyZLaZLHUffq8+3f6oftKtBIxT/woHLmVfmUukoGT+LdiyJcr7s9DWTmpJHwuK/3rylDEie/5DjVnRYubk4orpBP7K3wBVH4SiWRO9p7x0GWxSNIYficLsWR+yDgLfJnUgUrIVnF067sCHjux4FK4LBC3ImCRx1yRcD9gXhQzwZ1FTpT5XtbNRZrMieJYOAn7PRXxug5MS+GksZ+sgfH7ypUU8TAKE/ExGaTJAoXx3bCfUashL30Y263cPIA0Kx7zpUhELKm3jzIRYaAbwhv4UzGG4zggEa/07yvJeoVvZBL74RzeiDBd4kjTi9Fb+PPN1cUFkD+pxOL31I8FqNvjgRTbyjvDgZd+KCS7WwiQLWYy8JcnDHRwWEO+LPSxR1shKUkZAXuT7qdAFjviK1d4PA0SZosFv/WjGFUoPkL/AGUi3h9O9qsCqPhJZVuMt/wjAwXYwD5wGQsJ1GGoSDNR/xBOhWDX/2yywbsRmybgJDx22TAKArAjOti73Ao33y+SZCX7p6cuio0uW5cg9Sryw6TuRMtTsOYpX/mnUtOpOTmdWmHNH0g1yyhGX4OfS/JkFHXHJrnsZruxx8gwrpiLGHoqMupR04QHYDp/iZaHfkv+Uf0mKlrH9NfDIW1GnifFrjrH9BjYBg2ivbw0CLRWGbyosyuZ8iBYM7kSDgQpGPnOTxasStapouJXfO6HPBHQP47S+UK7BBnmmzHHZxgjV/9h5TtRGu7qfuSxahKnosr8BLQKil9FqzRQqhSs+r+1WZTwoDbE3lVU6SoKpWALSCjg/mQHbLgnHBYcKEZp4ELgFeEJyS2zG+bOqvKJKrsTqKp5CBpzwWJgM0gI2A/EkAlkHUirCbLCSBCI/5BBOAt4DDYi5WB7H7KCk5ygNBD9kDaj5VKEmDnCKEFPkQJHrRKR/yHJq8gTcXvLg1QoLWBrYDuVGTffhAehPHucyI6iQPCwUvIT6nnQVzw/oBni8BTwdK5/QzRyd0gl2hBdJRObyXWYQCZV3Wz0jfA/rOO/KEGBs5rm8wc09pvsKfqQTFerKE703EP5CUhFd/gaclHgKhCgsEYUyz5SqFZ9t1rts6r4HXwxrKpnqN38qbzTT4HFJJXl1hvzE3Zi4nf2AaadkEMuyNHJh8rBeUsix48asJRQMEZ4TQrUC8j5DNtOgfxXblnUwLZdp+rZ86wK5iCDnTDEJdCyumuXCiKqLCdKVLLZaOD/baprQKAEk2OOWiL7V+BZ1tmP6xyfZI0QVJUgJuUxlT0x+h3EepDJYRS+WgUasp7+KnGo+1178zjm6Bl+IpbEYhSKsUfgT7dQvCAY9hMSjcBT5mUbCedaib3pDyeK0A064yGSObWHG8g6mRqJn83RdpR3kWml3GxjetFQwYujJeVtBRPWaMqqgpBVBJilxxq2Ur5XMBgLBNPpGd1Gt2MZPSGchtUwLINbotlst3mz0+BFeGWROBG3vrjbmVQHwBK+QLbBi+M1qPw7SBOOI6Rk9hr9zYfcrqjUqT93A8DFyEXDbNQMs2a2Z41Ov9GA/9UNs/mvTM0w+uBy8NP5BIObUgeOOJyN/nmO/rkEcS+jopY5D7kdlAKZp0kEbEe/iQH6e+lNPllSP7ndUUeB4tCsNbq1hjkzesihadWtpkEc4gy9UUsBd0YDvRbtDf23XzaBpQCeqXKEoD8McT6ZjFHAIHJ44P87a4wt8AlqQYTZezGO/TllwbPzN4OrixkyAuUQuh0MG0lwfQhiH3M6JJtlCg5F0MFZ+IEbixC8Jqw5h5qCS9XRbcm/yVEsAX7RNETTs7uttuPZot01DNPmrY7VFKJVOMpU8BiKlVIsbSXSzfdsBDP9jjuAsq2a2ZkZ7X7L7LdaJVeYng8mw799YU+w0FcVc0a3blqdg57Qfp4jhFAA5Mp+LCpboPRC2YMzNo3SGFDgM+ISGjLoIKnDJ4fgdHw1GZ7/PH5/uRmH0xlE5tmj2lcY7eXKx8UAxOfuNBt0OJ5Mzi8GMxp4j3GsmWH1G62+0as3TOugcaxPjtL3g8nlKwUpTHqAGe7iCOdjAipbMdi0TWFC3JmG6IIbWHbH7fSabstwWo2O2Sy5xQTAL8vGKK/uHPYPFxI25mnOYuwc3YXPStOtTrfkI5PxxfnPw/Hbd+PpaDYaX34N+dqEZN3rt416o9M+nK8fcQRjK0px0ecN1utPT+BPzt375m0uGS3Q7EzWDavb6XV422qLBuTgTtftWKbpOK7d84yG4X7d9s/mt9cz/zJyaankgP2bar5W9U8JLQ4Hb98NRj9d/vxmdDGj3Ka0DXNct9N0GvBvy+l2ebPtuZZnWAJ+ul670PYMqnW2o3JVUWFlIVOAysmQWE/kJEeWunSldDxGfWdWoimRnA0XPnG63PcG7VQacLPJPShrKVwf67OJ8Erijs7OL2ej2f9lclrCMdsmd2y3Zbba7VbXhr9dzzSbra5jWyU5p2C4d1iUsKkqJVTZhO4jYlxv1nzpJ2U+Ry4tOdtG2+00ep7TdrqtZsvudtqeaLfNpgG65V0P155VWaf7bjirmiO1wuR7P1mM49WCgwMR5CbtZh2XWCmB7Gutdq31JZURlcvxz2fnw9EUXHRayfOrAQb3HMNoNHtGy/YavCWMlmgaHbvDLdtyvhwY3oyyPWD4GZPw60SXQsPNVh109orRlSn8ywaV7vy4/13fvMz7Xg9hY7k/cgVy6Qv51WPtHUcrge12s24Z3Vd0NK27V/SzfYl4037naqWAVgB2TF1k18/P6Dqh6oxbSSWtuvvKVdaUs5UcKnMNwVhJzH3t5g9fMlq423S8puu2IVm3bMPmbqfVcUXLdtqG3ev1StGi6iOy0eGYyXSOsXK4x1bYdGtGgwoNSILmM0qlZwTPZ5ZK+2LH0iwazXrPbL9m7JT19tkRdK9faeiga2Kra3humwveMKAOMhsNF/hqGl1ai3v1vP5UJfopnnzzgP+cVFr7lk+HgQ992Hkcgz/WAGcUW0lqm4+2iJgduWtVN0Kp4L9orTRftlzFuPJMMwSxg8XIMHLFvnX07W2PUNTmmBiAQ0EsO9BR72BjbUNbOnprO1IiULvNbekWrjmwH7nLJlq+oRYG1ASJx/kNaCHOfIqhq9CH/izrwvxiyXvPsMIS3AZUara8TotzE2prqw0lFW82G702pBIYfQnpDwCI3LPIvH1WAhzZd5heIBBY7nHQvdrFx8HL69KP2yBbUnhK3BnIpdrmYmp+GS43nEBN9+PwHWtZLODhPKXnfL6lhLB2NcV4hlDAlKLC82F7JePwsYhiiWNy/o+r8yn8Qlo7h0kGeHzBRbeMaO90Ed0Rx1qAO6h+pcDNDeHWWVVTrYJAXB03yRrqgw5yLUGZ2X4C9NCj7+lRJq2q73IoOeo8Cfver4v6CbPx2ZInMPnadEIjUmcuqgOYCldJ7UJrsqq3hX+os4HrUm7hgdpVldB/jTuq3HXVfpDa6YdQFrSLHKW00uqrxbjCFoUqN61RbC1clI3ykK0qPeUnAydJgTkSsxyFubdoFrV98GAJjbPJ3aykNFIpbnw5IAWdV8gO7tggm4/HhlQE0/4TJJ4wa5dnLEyBmViU7t4qZs6SiN45PJXPiLt3AaSfGomWv7gVOvjooEp2LIkXZtIZSZ/BoM75qRutiyzw1Q7ZMXaPsXuM3WfG7vbLid401m8J+hi70OcqBPS7iGKaPHegT0zeE0Ysa6ROLypDqkN1Sjt/fz+DwP5N0Lq6+LhCzPkH4iM1le/Z9s7soQ8CZOcEsqm/sAUySHpUEniQiYTbJ74LjklRSlXN3dHeRLHtg4OGeyAiFnNsHaWMg8riNAzpPJE8YW4kZPid3g7US1KUAXHU0K2pYwdHJHlEksfZ6Dgb/WlmoyOSPMbuMXa/zdh9FElunqzTOEmmyyWnRW3wNFGsp3MGDYoj3XnI6Z32TbSCxFiOsSqbyKFim4ZteJYjWi5vuZ1mzzOdjsnblmEZdsu0KuW5fvOAiAqyp86IoIoBxN0CjktDcC6ZRJG7ufyX4pFUD9Mapp4cN4PO69kCI2JHs7eLHWdRhLtq6wwhyQ0MGRY6wpwGbZfYNs7a0pWfOeTFEI+i+8AXupK/FEAFT9QyOu+OwYtSAN14XRt4eDhan6LPr7DoUfzQCVLgkDJBgEdgYNw77uORdA8xH1AgBDuH7PwHolNtos9C8myCEl+gxOz8oyMEBnqO3Nv71ndHwHyMOWKqDHxgoVdVOzwEB4CCQOWsHHce8fkRnx/n+OMc/+eY44/4/Bi7x9j9NmP3E/C5RkOH8Tk0eDY+h7b1Bsux1Bu65/efhukUKpoDdakpcpw0puXmDIMTrgBX0nfyMYdwvLdeOc3vPOE5EcKCio00xtPm2cWwe7AOWOWhzld+PTufE0Z3dDvstrkn1/gyiz3IVm6q7pzhXTQ1SJ10GvvotirH0QBKw/q+ZCW/hPYofbqsB6Zb4/UCReaEgYtrF6LHeLYa6ofvJLWuk8vsyAiyXcXBw1Py6Dt1B+RQRA7IsU99j44F7RlwuSUesn9TfJJgikBbjb7zYYJi8sDizNwZbIzNTPaj4DFUAWq/4vu/v5/9wOYILym81WVD4dO3Azh7By5C6WuQrd1jJ5pRinvgg43dEQwX5gUgMNPXevVxwPUl5PUJJGJSKXYSFPvY6/nXEvlGvwOXeD+ENXbmx+rWoqQ2WkR10fl6lcnFS3K9lIm/ZNRqilqNqOGVyA0ulGqvHXXaxoGYRRI8kKStFw+u6NVK9LBogidIdZsH1ITmY3NPy8ms9mI+NujVkN4mHx/C9wsf5s7NbkylKiYXdF1hxJxFFEnxV8bQdTAMrucpRNGL2brDQWsUETWzUWKppoas+TVAgsTfBQRGqJyJ2zgTExCJAKOFrgrJX8iyEPO/0J3kXzZkpsfXMGFiSzdyPuGu7RbPOGANB6ypHCA1/2o+QsfCc3UgA+UB5QDDwv6UCTSjpZynaO3N6kT+lPrg1OAAq0RFrvrqj36R4LLbtPQCW+dtIAUjkM53+eBvpmnhpLShrGwJYFuDu/wGEcyFW3pT/OZLUDg/fm3yosSDYqVkHAbrPzpLH8gkX0/e/UIZ75hp/oyZRkNbPzvXrmuAspMrtLa7bifpYyvwX3hLkUoYGiqU4vsqZTKrgCfo0xTTzsIXVPGvBE8Q+Z2gX0VLikOAuxj8+LklJDSnK4ExMMyhRvMDoFdn76GkCh1QMZZTeEYCqP4a6bqquOV0lhkO73Ut0xD6YoylS8bBPZ6wrutLJ1VJCKqrUGSSRQTj8l5ZRNLdXFBFnQqLeCnHHi4NQ9VZMuITY4ENpV4XBkWiRfTp7EKQCZ5epmuNJ1vw+yna4Dm1hQhWWNBBBgUwJUojvB3NdigCsVDfNY7i+anuJE+xLRDBUkc5Q7MOZRw+WkUygeqzRJcuUpY/XrbhRvfFGvhX8ZEyPYsg/D9d4TIVCpWqckQVfNeVouCDEmIBAuPD+3tcvsDq56F0BQ7KQND+5gH/g/J/Pd8Z26uF38S6UvrMmq7n1ddcni/kt/UVskcUkX1k7YV6+O/6fNgjesw/r/ZCRR6/BfbtfQvsEXfIPvj2Qm84fr/rc77f9Yhdio+rvdAy/71f33pEq8UXzwqt3hTrofqOpkpVhCZUN7U3Uuq1c3oAqeTr1T+dI7TjBwpl/QOHenj4f0/S9wY= +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Query Parameters

+ +A list of campaign objects. By default list of SLIM campaigns is returned. + +
Schema
  • Array [
    • oneOf
    alerts object[]
    + +A list of errors and warnings that have accumulated. + +
  • Array [
    • localizations object[]
  • Array [
  • ]
  • ]
    • alerts object[]
    + +A list of errors and warnings that have accumulated. + +
  • Array [
    • localizations object[]
  • Array [
  • ]
  • ]
    • 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. + +
  • Array [
  • ]
    • 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 objectrequired
    + +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. + +
    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). + +
  • Array [
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-auth-org-network-config.api.mdx b/docs/api/v3/get-auth-org-network-config.api.mdx new file mode 100644 index 000000000..588b1ba5b --- /dev/null +++ b/docs/api/v3/get-auth-org-network-config.api.mdx @@ -0,0 +1,95 @@ +--- +id: get-auth-org-network-config +sidebar_label: Get security network configuration. +hide_title: true +hide_table_of_contents: true +api: eJztW1tTGzsS/iuq2YdcCg9gTFh42XLIZTlFTrJcNg+Eqsgzsq2TsTRH0kC8FP99v5Y04yshYVObk9Q8APa41ep7fy3km0SXwnAntTrKk4NkJFy/cuO3ZvS7cNfafDrUaihHyUbi+MgmBxfJ60IPeMHOhOLKsVORVUa6KV44JxVILjeSXNjMyJKYguXZWFrWf3fEjHCVUZa5sWC5cFwWlukh44ppM3pkmQo7Mg4BWOb3rYJoKTsRf1bSCMtsvaHNIDnWH7BHtjygNR2wOTCC548gbk0HkW+ScysMFHHis9eO1Fhek1zeQnLsUGplBTS9SbpbW/RnUZtolkX52FAbr5bzVoEuXgfwTiFKRjsrR7x4WRYy82s2/7DE8Cax2VhMOL1y01JgCz34Q2QOC0tDznEyiGO4Gok5Mm4Mnyar1haQrSjAgQSDfWXJ/FJLskgnJnaOiXUGXktuNxLxmU/KQpBtttOddC/tgry7u5vOfrqbO1vkX1UVBR8QrTOVwNqR0IUOaj1AwExXypkp/ubfIORhH5SvTvDrn2drhboeg08hrRP5HK+B1oXgakWsF0Jph/i6Hgs4MngT9r+SucgZcYFPjWBzTOFeNih49im+pRiAIVhtidTvMeRVAdcPeWHFnPxeRgjppKO3yUK2xahKbm+JpLcuDA8LiZBiL43Brh2kB6UWhJBDL7lBugjr2EDnU4b0k+qKFzL/jtEYEvgQLlt11LJtX0klOiPDJUkovMjk62hfrGATbeqaQBFBKng6ErixGVki3WbPee7LAel3GJUhSxq4AryO8vsFOlcS61m9hMm8yeA124o9wQfPtva7veGzHufdv/e293YH+0O+s7O1v7u/T7tPhLV8JOy94f9aKGFk5qOkkP+BQVB9bCwhfvM1CXCHDzyPr7A/pVygbdSM8jIqiRuMs+eH71hvjxUoFJV/zkdLRlCd89NkTZoFxm+NHEm1ThShqgnl64uXr/rnx2d4cvLyX+cvT/GKeK20i75CtOYUlhAVsTDW117iqMA1px5A1UPkKXsauT6FQjy2lkgowzs7RXJOWExErIi7r1kxz5oNjZ4spFIW+gd7LFORbrABPZtwl43ZgFuqBsqTP+1nmShd5zha8ikbo7sI8yRl/TyXpCS6J7IRTLF+CkaM51RkZGAwrJDKEEa6sa4cQ1WSmVj0xcyUi96YlZPjeadQckDy++Okn7kKwnk157OwiZYoYvQPFUa/z6J0Z3NG8yadKsdR7EFZUJE3BhZmA+gmUVRjOSJ3WRQeVdM1FWu+Svpy9yYI88Jp/1nGK/sVefeuQPnpeNWaD65ETD6Ega6rPXmjdlOsSPgwNHcsbnpCtEWd+GwoRZG3udvmbpu7X5m7yx+eRPAdP/XQZ3sV+pwrAtfa+Oa5An2Mjx6lWU0UAHpw5AZhtgiRfnt/hsT+JBTRi88lpovviY9CK18Rvt/4IzwfEPxonLXgCxLQ2zGOGKhEIj/wcs8k9oYKptpZ3e2VNgOJAFVrICKqpmFTXXlYayqlSBJuN1iuhVWPHBtz1EeOjLA2VEDaVeWdUkvlWiTZIsm2G7Xd6NfpRi2SbHO3zd2fM3e/iCQbqXy2RJxkq8mEm2mItPi5P4xmIGD1MTBrUs67ahmtEDPWYKxkETkkg+72YHu4l4leznv5s539YTd71uW7e9t724Nedy+Z7/UXszxukmwxp+b8HfzoTQwQdwUcVykEl3Va54vHfzCvEUMqa1R6GtwMm8OklzPs2Ftz0K0ddANjYEdzx/Hi+ckx8cfWnj3ZTVcmEwSzg+lAzp2HlBTDsLS0roWOLXRs20/bfn6Z9tNCxzZ329z9OXP3m6Bj7z7o2PsG6NhjBLGGBLF+JHTMgTsImg3hFOiQVTCvIthYQhW8WrrgwM1IuAboLaDI7v4qijzTmr3halqDJbtwEqlm5qLyBtoJ0ZqaFgScjVAiFUPVkkC3FFVyIgiTIn5YISfS5zEpBL5m2ukPHbQKOVPHW7OLVFlRQUJfFApNZ68aMSYRTmJI8A8c/DnoCIX6O55xRm/9T+fB7IQ0PiaN2cvPmRCU88357+66WwJHEN5QuTgNvr7jukA4M+cKY4T4XIby1UDQFqq3UL1t9227/zXafQvV29xtc/fnzN1vgOoRDd0N1UHw1VAdtOkWa7DUK3+j8/+N2H2qRAl8eDOdeayezzC4xxUIpXiRm2oIp9vOyWZ91Xkz3rHuZPW17jAFBKEqU4B47FxpDzY3b8Jl5tuUlzJFCYO73FTp6zTTk82rnTWVhy6a2vrmbF6FC7508ztsknoLG0lBHCqe3yDYO96TTSzs7m8YfJG/4hPvyCmmkHjpeoMh4GNA+ccQs8Q0QRfLQZ36AFrREbqdm+L2Pn3+vfMlPQKTO/RYZ74v7gV6BimX1CPxL2fX2k8JdofdVy63z1oJub27stlbIuuy54Ibuujs78A8/u392RM2IrDpk72yhHOFpOkA6fIOIeKLWb++D0KLfH8xuhqNveD9hRs3lDxsWEBh9kGdCsEujqIRfkeVP0FZ9ialRcJXAlp1+bj2TC6uREENMJ1ZkgJP5moTFvIRPVv3xDc7PxVIhZeTcAP7g+qwF9KEq+Y23tD2Kvohj12UtV58Tq+HCvG3mlsncOt4bvbJkhTBtBdZuMGdIYOJBS+st9aDNw/8OnP8aITCE+K6LANZIsqxeE8qq732YDkW+HWI36IcH9T7sUQnXVzGQuFiFo2wyNkRy8ZaW/EPxih0KA0uRhWy6MFiXdOmHZ8Rne7WnEidsGVHdoALvXzHSAwVgokPqC97WKLDCYlPyY/es8j5j5iac/ZxQWf/+ALtkyhzndkHy0wbdmjDTqgBNsofvzwDYZHbpIOvAyEADmf+95UgCjpX8wKvtVXds9/0a6g10DdsPBdbHoQ3B7MCF1+F7+EQdUODEkywurk5hvcs8qIWtWCs+kBg2YKr8hYanXHJbkHe5t+a1C3/avqSxv3ZuclbVUy/d5W+o5L8deruD6p4baX5FStNBLoUbn7bOBHMB3lAa6uneHTMPBb4jU99pnpEjXnFT2Aew8yzKQvuKKZ9TmdjKfz8XwruCPltUFzpic9DwF1Kfvr6GDEaGdAgaS3QKB/IAvxS9h4DlspgYhqu6N4tuP6h45R1Ciu/IyexF7XjAKAmk0rRVx0hRDVhHOFxj3dzabMqFCEAfCVqzbSHcc2qOiMpbMgUqR8zzMS+HdJBMWbQOSfesxd8aOMpMQxJHiG0TRNMo8iJKHyUEd0i/L6PNyKnMxZFSeMdKijAlJjb4c3R2QpHMFPxXxM07sRFdpNowYRGnRAMOymGOnpUauswi87xfS3c7Gumat33PdPl2LqZHZP/oO+7xmZCU8BmSWdXpFsVppIwBV4k9SI6TFicAzFZjGEHIrq5oTMOGopu6TFmexqgLy5nMw+9A/Nw1uEHx0/Cz9j+NGQ2Rq/+v4AmmGZCff2S3MfvaIbxBW11e/tfxxU2XQ== +sidebar_class_name: "get api-method" +info_path: docs/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 security network configuration.' (get-auth-org-network-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get security network configuration.

+ + + + + +This API returns the details of an org's network auth configuration. Requires security scope of: 'sp:auth-org:read' + +## Request + +
+ +Network configuration for the tenant's auth org. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-auth-user.api.mdx b/docs/api/v3/get-auth-user.api.mdx new file mode 100644 index 000000000..f9f514763 --- /dev/null +++ b/docs/api/v3/get-auth-user.api.mdx @@ -0,0 +1,95 @@ +--- +id: get-auth-user +sidebar_label: Auth User Details +hide_title: true +hide_table_of_contents: true +api: eJztXFtz2zYW/isY7UOTjCVbN1vWy65iK6m7ju2V7WZmnUwKkZCEhgJVgIyj9fi/73cAkCIl+drsts2oD6kEAud+Dr4DEb6pxDOheSJjdRRWupWxSHppMrk0Qle2Kgkfm0r3qkJDzI593KqEwgRazmgJFgxEkmrFkolgZiYCOZIiZCmm/mAYxzKhEhlY+szMTSKmLBQJl5Gpgf6Maz4VidDE5aYiieCMJxM8UniAbzKsLHM8ColmMmdHh3imxW+p1AKyJzoVWxUTTMSUV7o3lWQ+Iwom0VKNK7dbFfGVT2cRjYlRszPabzVbe2K/1d5tDNvDYafVaPH2bnN/L+xUbqGnEUGqwceKRsofxCoRX619yChm1iUFq6RsVwseVj7SMi3MLFZGGJKhsbND/ysrcPEsWwXEXSVEjs9mkZ+4/ashmjeresfDX0WQkJE1uTiRTiLQ4I5K2T7LVr6w8xi5gbgvbJcIk1Q9FRgVDnqQVsFjZVqNYL/e2em02h0u9nhrtFNvd4b14XDU4aOd3UaHGKRP4QBDpkr+lgom3QjZWJeZXssoqpmphBdvrXVGksYfZHHI4pGNc3IV8+sYNyYOJE/gyWuQXEwgvz5B2732rjMniT3y3j1Jp0Mk3YOy9TKG0F+AWzwXgim7uCxCfb/abncgQsMmxBTB9VTqWLJqT8mnzqT/8OO1IJ5a805i9QjjFlnYJWulb+f/EenrWH8+ezp5WvZoHkgc5BeP+k+3VLb0ySYbSW0SV/6ews8uW5Ov78GLyEb8OVRp1Rqi51n6hNLMIj4/eTJhosmkYp4A0mcU6ylPVoVnOTMOo5mnsbFL7st/UvAMSYywCA8mXI3FIZL5YSY0iwqCNdDME2CBpbCU9juNenWnWd3pXDQa3eZet9ms7e/U/51xP47HUl3IKeoqlqzZLrJHWf2xLCNaxV5EsRozkpR94VEqXhJrL7jEfjG227izrBvabRWFq+9ix2vs1TvtTrMBebDjaRSgJ4vk1/2vpOIzPpSRzPawJXdrzeel2ux9X1xWkIDTfHyV2GDXRpNAXaAN/qA/uPjUO3x3dILBg+PTy8NPb09/XjNyed4fYODH/vHZYf/8n/h4Onibzxv0z04LhAanx/3yl/PL19n3817v/NO73knvbf9d/2SxaHl80O8dWp7np5eDgwU9/7VAMeSmm8oqD6dSSajIk1gvhlFyACW4CsSnKVfcOSZbkoayNDnkCa+aAGgCY4R+ZIAxMxnGXIdVi4DWjF8DQwnCjYuMWFjn9hbuxTZth3PgeWuHW+uw00EkKc76WseaVZlDnyge0rmf0CAikw3jcM6kQYFBAMrwG+Inh8gO4vARNeKNVKI61lyShMKKHGAhYYcvMsQKNo218CAvi2A7r1xBYIlanb3mIfR1+h14Zch6mgefQevoETDp0mGjbAlAElXdu9iKPcGHuzv7jdZot8V5o9Oq77WH+yPebO7st/f3iTvqgEHYFPMoy68y67dCCS0DVIgAHvkPDIKAge2tAJb5mpS8wweWxiPsT0Dbzc3V9PIyAvJbjLPXB2estYeSqsapHefjJSOo6uU59SNpFPEhDVGfQaXbEj7VcizVfVXksP+md3l8YQvBvy775/hEtFYaqZ5CtIYUlhAVsTCJr121dwpcc8OMiGAOEdbYK0/1FRTiyhQnSvctbyBGPI0SrPDc16wokmYjHU9LqRS4roe9kDVR22JDGkPdDiZsyA0WxK75e9ULAjFLqsfekq/YBAVB6Jc11gtRSKTFQnY7MFg/ByHGw5BS1xEYpUhlYUF0nAJzxOiFlnbShSnL3liUkOOiUyg5IPkjAEOQpBDOqlnMwjxavIjeP5DZWa4s3UXBaNakc5XwgDq6KJrDjNghA1Qm6CYTw3w5IncZFB6VzcsrVrEy2nL3zglzmMT2WcBT84i8O4tQfqpWtfzBF+GTD2EQ+2pkvZG5yVckPCS17WI/K3dXlvjAnSIKN7m7yd1N7j4yd5cfDvyJkX9qoU99FfpcKgK3sbab5wr00TZ6VMyySe4cyTlyi8EgHiL99P4Cif1ZKJovvs7o8Owb4iO3la+C9NwfbnxI8CN3VskXJKC1o9NghEokwq6VeyGxNZQzVXOV25tYDyUCVK2BiNQcsHmcMg6T6VQpkoSbLRbGwqgfEjbhqI8cGWGMq4DEVYXVWYxGZYMkN0hysxttdqPvZzfaIMlN7m5y96+Zu/ciyVwqmy0eJ5l0OuV67iLNPydtOcMElv12yfKUs65aRitEjOUYq1JGDpVhoz6sj/YC0Qp5K9xt7o8awW6Dt/fqe/Vhq7FXKe71V4s8zpOsnFMFfzs/ut9Phf4CHJcqBJdJ4jgsH//BvFqMqKxR6clxM2wOk35cYMfWKnY8iRPoBsLAjvqO48XLwTHRB2tLnuwWpzoQBLOd6TCdJxZSUgzD0tIkG+i4gY6b7Wez/Xw3288GOm5yd5O7f83cfRJ0bD0EHVtPgI4tRhBrRBDrj4SOIXAHQbMRnAIdsjcYtJhBFXzyp48+7ROuxyLJgV4JRTb217whEcfsHVfzDCyZ0kmkWpiLyhvmTmmuzuZiAmdjlEhFrxFJoFuKKjkVhEnpxZNITqXNY1IIdPW82hsl0MrlTBZvORepgiiFhLYouLczYsSYRDiJEcE/ULDnoGMU6m94xum99bvOg9mAND4mjVn/ayAE5Xx+/tte95bAEYTXVC7Ona/veF3AnZlzhTZCfJ258pVD0A1U30D1zXa/2e6/j+1+A9U3ubvJ3b9m7j4Bqns0dDdUx4RHQ3XMre2wHEu9oeD6vyN2mypeAhveLA4sVg8XGNziCoSSv8BENYQuEXUr2/kFHbN9I8PbCt3qIUTohEl1hEmTJJmZ7vb2jbvUclvjM1nz10fmKr6m9/K3vzTXVBx6wdRlF2pWmAa2Y+idHfkWo2YtqyUF79LdG5+qFKawt32z4F769m15OHCO7oM5Mlv0grUPJDtM7/Kii/Dv1tds4KzoCN0udXT7kD4/N+/TwxG5Q4915ruXF+YzSLmkHolfuIR1TnDbcV+5irXYQsjdjRVmpzStwV4LrtELuHdfXvz0/uIlGxPItEmeGsK3QlJXgDQ5yy5v9LL3QGiR3Vd0nI7dNZ9e6U0bSho2iqAw+6DOhWBX2aWkE1T3AcqxNWmvdM/r44vMM6H4IiLa+GoLS1LgyVBtw0Lb5fthL+0mZ7sBqdyL9BitfVBVdiip9kjarGmOV9E2d+wqv5TCC3o9V4i/ZdSqjlrVUjMvl6Rwpr0K3JvbATKXSPDIWGs9m7mjVy3Qo9YJI0R1WQayhJej/H5UkHnt2XKU6FWJXlmOD+r9RGIHXbrg5woWM9gAo5AdsWASx0b8nTEKHUqDq3GKLHq2WNfEtGozotrYKYhUdSyrkuqile8YiaFcMPEh7ccWjsTuZMSm5C/Ws8j5X9Ath+yXks52+ArbJs0M48A8W2ZiWCWG/n6h8fL7W5AQFrlNOtg64ALgYOF/Wwm8oIWa52itreqW/LZdQ1sDXW2wVMys6750FwXOf2KFCxB+Dkowwen8jTF8Z54WbU0lY2UHAcsWXJXXXqVZspuTN/85k3bJP5u+pHFvcV5yqqL5t67Sd1SSP0/d/YMq3qbSfI+VxgNcCjfL1ncCxSB3aG319I6OlycC/+KpzVSLpNGnLK4qF8nMIp5QTNucDiZS2L5/JnhCyG+L4iqe2jwE3KXkR3dnCY015iBpDdCou3E3r7H3aKxUABNTU0Xv24Lqr7Hvrs5h5TNyEjvMHAcANZ2miq6JQ4h0yjjC4wHvhtIEqStC6LGUyDSLLYzLV2UZSWFDprCXAYWemtMRHRCj9yw48QFe8KHxp8MwJHnE/6WChSIDEdkoo3ll+P0QbUROdSKimb0aCrHQpBU4vDu6WKEIYsr/JBHr8bZfZLZpLohQq+OCoVlDM2evNMcmQQ9aoJv/dQc4w4b/ciTdLA7Df9/fe/A7AEH37RkdNNkL/q6VcC3bVWXRsmFBV4Z0dXACmenZzQ2dQ1ADc0vD6L+pyb36uOhPbF8Hc9JntIMjJKu4R5sXA//nI16y8p+VWCtpdnCm5oueuYKPnwW12hAVDSmEtWchVhD3wJ2WFJas/J5AnU7ewb7tk5v5HZum/wClURb+CwgchT0= +sidebar_class_name: "get api-method" +info_path: docs/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 'Auth User Details' (get-auth-user)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Auth User Details

+ + + + + +Return the specified user's authentication system details. + +## Request + +

Path Parameters

+ +The specified user's authentication system details. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-branding-list.api.mdx b/docs/api/v3/get-branding-list.api.mdx new file mode 100644 index 000000000..5f1fb292a --- /dev/null +++ b/docs/api/v3/get-branding-list.api.mdx @@ -0,0 +1,85 @@ +--- +id: get-branding-list +sidebar_label: List of branding items +hide_title: true +hide_table_of_contents: true +api: eJztW21TGzkS/isq34dNUtgGQ8LClzsHSIot8nK8bD4Q6iLPyLaSseSVZiBeiv9+T7c04xlsAsembndTTlUSmJH6vZ/uluXrlp0qJ3NtzWHa2m2NVP7SSZNqMzrSPm+ttXI58q3d81b5uHWx1kqVT5ye0i7sOR1rL/rvD4Uy6dRqkwun8sIZL6TIQETYoRjE3ULnauI7H81H0xe5/aKMuNL5mLaviXfHr//T339z+FbIIh9bp/OZAGmnfiu0UynWi0Rmmcgjww7E8yopaCFEvG6deeX2rMnV17wPCiS2Ts1uyXzXKZm2Lm6ggVN+ao1XUO261Vtfp/+aWvXvkh1ME+Jhctokp9NMJ2zA7mdPO69bPhmriaSf8tlUgZZ0Ts6wjwnUntvBZ5WQkaeO3JDrII+RE1Vb5XNHdr9tdlq1IB5Wqa9yMs1oY6qGssjy1g0zSIskf/sgynGxYDnqBG+9MEWWyQG9yV2hwEUmROFlkefW7NnMuvt5jdVXcSmzglVJaI8Y4m+gJAZMqiHD+vr21v7OXdwv1ZE2X/4Y7wwUmiw3Ng5eLGVp5KUesfP/GMs5HTGQ7oHMEWM6e+XspJ+miGd/P3feIYbYImTcU2dlbNupaTb7l8cyzuROYifLWPscMSddemRH9uz46H7Ohcsofct9IsPGBu9lXLBIm0MDA03YNjJ7A5Hl6AEhzFuFnu8Vk7j120zBNdc5vywB75DS6ob+rLW2liHFXqYBBuLAOXiyLY4Z/ABXegikUgxfCkgysCnDmTYIAJ0+BkfuwItU5XDYnk0fYJhX2qj2yElNEioWOcFGAYqXmmFkYp0SgSQFKanA6zoN08ESnQ3xUqbQN+i3F5UhEzqZfCHTpfcLdGY09otyi9ApZ8QdbNW2koMX6zu9reGLLSl7P29tbD8f7Azl5ub6zvOdHeIePe2XAHCT9WtllNMJghFlRf8Og6BAwPYsADN/OGYzjQfY/xR6hbWVmlFeQWVrDTXz5d57sbUtMmlGBT+Xo1tGMO2zk+UJQ4TfOY3gXyaKMsWEiuL+wav+2dEpnhwf/Pvs4AQ/Ea2Fyt6nFEopLCEqYmFsr1jiqMCV9MKrDOZQaUc8i1SfQSGJ4l9bqMNvfuZhTBHLEnZE7kt21EkHwKqnUhJqvHiiO6qzJgb0DGmejIGeHhvgQlr+rJ8kapq3j6Iln4kxGgDlnnYEIFMHSAlw7LF/BkKEi5S6gcCwQCor7lBsgbJnc52opi/mpmx6Y44jR3WnUHJA8vvjpJ/kBYRjNetZWEVLFDH6R6XRck3pTmtGY5POTE5lktqoGczoHCxMVRbNgxcRjshdHsBjynUVYtXhkeEu4vF+bvldIgv/gLx7nwF+2qxa9eJSxeTzVCcCGrE3SjdFRMJLUps3x1WVu8rEF0OtsnSVu6vcXeXuA3P39svjOB/Ft9z6bCy2PmcmTmpUPBdaH8fRY2w5zv0eOrHgyDUBg8QW6ZcPp3EYxHr1dUrT3nfsj0IpXzLhlf4IzwfUflTOaviCBGQ7Bg2GQCKV7rLcc4lDk8im2lzk9sq6gUaAmiUtIlDTiZkthITJXGEMSSL9mkit8uanXIwl8FEiI7wPCEhcTdoOTfqqk1x1kqtqtKpGP0w1WnWSq9xd5e7fM3e/2UlWUnG2xD7JF5OJdLMQafE9aSsFFojypF5UKceuut2tEDFR9VitZufQGvQ2BhvD7URtpXIrfbG5M+wlL3ry+fbG9sZgq7fdqtf683keV0nWzKmav4Mf2cRo4i7RxxUGweVza9Pm8V9Bn4sMCdYIeqq+GTaHSS+q3rG3s9g7nlor3kgzKzsk3+ghzdxGhGlYO6G1rlyLBVKMgItGAKo05KJQ0hMFKg5BIzI90Zy8pAXoulm7P8yhSkiUMsgqLtokWQEJGQkyS12zRWBpKKmG1POBAnewI6Dzd+xOJ/PT30d38uKYND4ijcXB10QpSvSqc3++7Hz3EMI7woiT4OA7DnrDtCMNAgADQcCsqu9c9eer/nxV41c1/seo8av+fJW7q9z9e+bu/9Cfx27o7v4cCx7cn2NtZ11UvdQrvpny/27TOVWiBBzewiZJ4fi4uezBua9AKMXrUIQhku4StbrlTRu6NRGa/SBG4TK8Huf51O92u9fwDrxy05FT3QFowUH5zNgrukvRvdxcgjV0KSDkVbxgQ2fMdKEqMOmwTZ2msA0YxwyChcMNHwRoeWXjm/TLO0MzWwDVmMyaQIjHEOLHEHOK+eEnz6s7HDILOkK3M5fd3KfPr5vf0iMQuUOPZeb7Ji+sF3TNpKkeiX8xvyZ2Qo124L5wWWxePGg46y0we0fLeuKlkg5TQPi84skvH06fihG1l5zehafOVmmaB5Ag7xEiDF/98uyeNnFFcbYYjVnwfuPTEUoXMcygsPhoTpQS54fRCG+B68cAYjYpbVKc+7Tr4knpmVRdqoxKXqdxiaerU9OFhbqyse8plzeeA2p3ZTofTVvsa0IdTWWa1kQVeawT59NSL1nT67FC/KOk1g7U2kzNP70lRTDteRJu2yTIWSIhM8/WejTzQK9do0dDE54Q1dsykCWiHM3PtJLSa4+Wo0GvTfSacnw0H8YatbO5TQSoEh6lL0vFoUjG1nr1TyEodCgNzkcFsujRYl0R0zZnRLu3XhOpHVi2dRudIMt3hMQwIZjkgCoxNyIWPZpJQ0p+Ys8i5z9hTk7Fp4bO/PgcBZNWpjbxj5aZGLaJYTtggI/yh3pEgYXcJh0YB0IA7M39z0gQBa1hXqC1FNWZfJf3UGlIICpT8dPd8MvuHODiT4Jf0OpqDSCYGunqUz666hppUVFqGKs8ArhtwUV5+SbcLbsFeasjKKqPfzV9SeP+/KTknclm3xul70CSvw7u/kmIt0KaHxFpYmtL4cZs4wxQD/LQrS2e29HB8ljhX7zlTOUeGhNKuLtPPUydzDSTOcU053Qy1oon/qmSOXV+axRXdsJ5iHaXkh9zHRMaOaxB0np0o3KgM9DriA8YqUwCE9M4RXckQPWzjXPVCaz8nr9ysF86Dg3UZFIY+u4AhCgmQiI87vFuqn1SBBDCdGVUqZnlNq7aVWYkhQ2ZosODhZv4d0M6GsbUWXPiPbzgQx/PhWHI+a3/1lyRY5VxlNG6Zvt9H21ETnussikNdEBQNFOqxuHN4ekCRRAzHnphcLZu1I2bfJfWggiNOiEYNjsY4/gbBdbnmD5rdI+Wfl/idjhdz8/C/9xvjsQyQv1/d0rnVKRVEeaRMPGdt+YTH2aIMTSmh9fXdH5B488NPcbcTsPx+cV8uqHfQCycY/CI+EXx/MwnHfMRefGzAJpVqunz9QE5St5R9uIPxOrm5r8oIieK +sidebar_class_name: "get api-method" +info_path: docs/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 branding items' (get-branding-list)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

List of branding items

+ + + + + +This API endpoint returns a list of branding items. + +A token with API, ORG_ADMIN authority is required to call this API. + +## Request + +
+ +A list of branding items. + +
Schema
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-branding.api.mdx b/docs/api/v3/get-branding.api.mdx new file mode 100644 index 000000000..5e5af016c --- /dev/null +++ b/docs/api/v3/get-branding.api.mdx @@ -0,0 +1,96 @@ +--- +id: get-branding +sidebar_label: Get a branding item +hide_title: true +hide_table_of_contents: true +api: eJztW1lzEzsW/iuqnocLlJcshkz8MmOSQOVWWCbL8BBSg9wt24K21COpk/im8t/nnCP1Zjsk5FJzgeoXcNzS2ZfvyOqbSGfCcCe1OkyiYTQV7qXhKpFqGnUix6c2Gp5H5VcXnSgRNjYywx2w/nQmLRu9P2RCJZmWyjEjnJHiUlgm1USbOdFm8IlxxcS1tA4IsXGgyKQTczZeMMXnovdRjZjTX4RiV9LNkG6HvTt+/Z/R/pvDt4znbqaNdAsGPI34by6NSGA9i3maMhck6YHcVsQ5LgTZb6IzK8yeVk5cuxFQQH1kooaFBEMjeBJd3IJqGTcghRPG0kaJCmYctnQiFA/+ov+AfjwTcx4NbyK3yPB7CzqDeW47USFXNHQmF6vmEqQp0xMQWCyZAVQZi9KACTAS13yepcghEROepy5COY2wmVZWWJRga2MD/2vyGS1R1uPPInZAMEZDKIc7eJalMib39D9b3Hazqli5MTMYKE56pt4cy+ova1to2pBlvVbEIMlj9/ZBlMNiFvxREVx6oPI05WN8gt4ALjxGCi9z57Ta06k29/OaiWt2ydOcVIlxj49mosTGRKohw8bGzmB/9y7ul+JIqi9/jncKFJosNzcPXqxlqfilnJKT/xzLig4bc/NA5hBLMn1l9HyUJBC09n7utINNYAvjYU+dldJdI7J08U8Ly6je9GI9X8faOog5bpIjPdVnx0f3c85NiglY7GMpbGzwXscFFkl1WNU5nr4Bkfn0ASFMWxs1ch62fp0pcHXS0cOiLB9iWt3e4qPBumqwl0rIeXZgDDiyy46Fy42C0il9EcKSJaxjY51QaZUK/C+T3vcrF4lw4K89nTzALq+kEt2p4RIlFCRyDBsZULyUVEXm2gjmSRZ1lNb1GpYDS/Q22UuegL5ev72gDFrQ8PgLWi65X6AzJWE/K7YwmVBC3MFW7Ag+frGxuzWYvBhwvvX3webO8/HuhG9vb+w+391F7sHR9XTgxvDFCuvXQgkjY4hFaHHyDzAINCsb2ikxhy1YVO39PiAaD7A/tii/tlQzyMuwhXYYZy/33rPBDku5mub0PZ8uGUF1z07W5wsSfmfkVKp1ogiVz7FB7x+8Gp0dncI3xwf/Ojs4gU9IawV+jDCDEgxLEBViYaavSOKgwBW3zIoUzCGSHnsWqD4Dhbiy9YXS/2UXFrtl6EqwI3Bfs6NO2tereirFHm+wJ7Ineh3o6vAdZHk8g+JpYQO4EJc/G8WxyFz3KFjyGZsBGBHmaY9BxZS+ovhqbGH/AuEBlEVMXU9gkkMqC0JLOoeup52MRdMXlSmb3qjKyFHdKZgcIPn9cTKKXQ7CkZr1LCyjJYgY/COSYLmmdKc1o5FJF8phl0RItwAzGgMWxiYL2MGyUI7QXRYKjyrWlRWrXh2p3IVyvO80PYt5bh+Qd+9TKD9dUq18cClC8llsE74akTcKN4WKBA9RbdocVpXuKhKfTaRIkzZ329xtc/eBubv88DjMQOEpQZ/NVehzpsLUiM1zBfoYih6li9HyDw/EvCM7DAwSINLvH07DYArrxXWGE953xEe+la+Z4gp/+O/HCD9KZzV8gQKSHcO4DZVIJEOSu5KYDOVNtb3K7ZU2YwkBqtZARKiahi10zjiYzORKoSTcdliihVW/OTbjUB85ZIS1vgIiV5V0PUZvkWSLJNtu1HajX6YbtUiyzd02d3/O3P0qkiylomwJOMnm8zk3Cx9p4TlqyxksYMVpfHXITq5aRitIjJUYK2oih2i8tTnenOzEYpDwQfJie3eyFb/Y4s93Nnc2x4Otnaje68+rPC6TrJlTNX97P5KJAcRdAo7LFQSXdVonzeO/HH+8mWBZw9JT4mawOZj0osKOg1Xs+FY70A0IA3Y0dxwvnh0fIX1gTeTRbjo3sUCY7U0Hy7kjSIkx7H8saqFjCx3b9tO2n1+m/bTQsc3dNnd/ztz9Jug4uA86Dr4BOg4YQqwJQqy/EjomgDsQmk3AKaBDnIN56c5PBqrAp+qyD5UfbqbClUCvgSK3dldR5KnW7A1XiwIs2cZJpKrMheUN1s5xrSnWwgLOplAiFYOqJQHdYlTJuUBMCvHDUjmXlMeoENA1i+5o4kArnzNFvJVcpIrTHCSkopBqPHvVEGMSwklMEP4BBToHnUKh/o5nnPPqCsGjz4PZMWp8hBqzg+tYCMz58vz3+bpbAocgvMFyceJ9fcd1AX9mzhWMEeI68+WrhKAtVG+hetvu23b/a7T7Fqq3udvm7s+Zu98A1QMauhuqw4IHQ3VY29tgJZZ6Rdeb/9+InVIlSEDhzXRMWD2pMDjhCgilcOsfawhedR9G/eK6tu3f4DXq2wgv1CMk9NLkJoVVM+cyO+z3b8BJ4JzbHs9kD2oX+MktlL7Ce7n9y+01JQdvmPr0Cpe1cWTAVwg8kx6Z1kiMXl/qiIE3tL8tDnFaXP/9Kv3i/vkCxg/myXQYRHqIJPoaxMxgjPjN+jcQKHJWdATdzkx6e58+/97+mh6eyB16rDPfV3nBeoZXlpvqofgX1fsPJ4i3PfeVtyCqHoIn/VsrzN7hsi32UnADw4C//PLk9w+nT9kUUSZleW4R4AqJYwHkyXsIEapio+IiCG6ixmJ0Pp2R4KPGVRvMGjZJQWH2UZ0Iwc4PgxHeQnk/hnpMJsVNgkoA7rp4UngmEZcixc7Xa1wI78tE9cFCfd7Y95S6HI0DtXvXvY+qy/YlFh+J3RrXBBVpumPnWaEXr+n1WCH+VlDrempdomafLknhTXse+6vbMaQukuCpJWs9mrmn163Rw9kJvkGqyzKgJYIczQtSceG1R8vRoNdFek05PqoPMwkttLmN+YrFLHTANGGHLJ5pbcU/GMPQwTQ4n+aQRY8W6wqZdikjulsbNZG6nmVXdgEQknxHkBjKBxMfY0MmPKL90Qil5CfyLOT8JxiXE/apoTN9fQ59E1cmOraPlhkZdpFh19cAG+T3bQkDC3IbdaA64ANgr/I/VYIgaK3meVprqzqR79MebA0xiEpUbDb0fwyrAhc+MXqAq8s1UIIRT5dXxvAdrkALe1PDWMVJwLIFV+WltyqW7OblLX/PxDb5o+mLGo+qA5N3Kl187yp9RyX5ceruX1Tx2krzK1aagHAx3IhtGAXqQe7R2urxHZ4vzwT8C08pUwlKw6DiX0pFDFMnk6XcYUxTTsczfHMTz8MFd4j8OhhXek55CHAXkx/GOyI0NbAGktYCGuVjmQK9HvsAk5WKwcQ4VeGFW6D6WYfx6gSs/J5est0vHAcAaj7PFb4UC0Lkc8YhPO7xbiJtnPsiBEOWEoVmmmBcuavISAwbNEWP5gszt+8meEIMw2fNiffwAh/acDwMhqzeII0qRY5FSlGG65rw+z7aEDndmUgznOugggKYEjUObw5PVygCMRV+k9Bm2g+bbB/XAhEcdXwwbPdgmqO3U7V1MITW6L4WDrDh8qutjVi6qc7Df9AXpUNzwamgn+EhFuqa+ynFj4PnUTkOwvohKQ8TxgzsgQ9vbvCQA4ejW/wahnucoM8vqtmHZkZwFX6GWXMChWD5tei6nZ4cB3mf0s803/Ky9FplinM7tahGdnyr8ovASZ/UgYkYFKLDGBLWP/LHNbVNKz9o4KRVjtCvDzDM+B1NO3wAw0BZ+h+eky06 +sidebar_class_name: "get api-method" +info_path: docs/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 branding item' (get-branding)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get a branding item

+ + + + + +This API endpoint retrieves information for an existing branding item by name. +A token with API, ORG_ADMIN authority is required to call this API. + +## Request + +

Path Parameters

+ +A branding item object + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-campaign-filter-by-id.api.mdx b/docs/api/v3/get-campaign-filter-by-id.api.mdx new file mode 100644 index 000000000..1df10e960 --- /dev/null +++ b/docs/api/v3/get-campaign-filter-by-id.api.mdx @@ -0,0 +1,99 @@ +--- +id: get-campaign-filter-by-id +sidebar_label: Get Campaign Filter by ID +hide_title: true +hide_table_of_contents: true +api: eJztXFlzG7kR/iuoycPaLh46aGvFlxRNUg63aFEhqXVSWpUMzoAk1kNgAsxIYlT67+kGMBcPS1Zc2axr9mFNzgCNvvtrENCDJyOmaMylGARe21uwuEtXEeULccbDmKn3a3he82K60F77yusyFfM5980Mkg4ldqz2rmtewLSveITvgd6YxYqzW6YJF3OpVnYefCJUEHbPdczFgvgpnbmhQxKNT+Mlcw9+0mTQawAbmvmJ4vEaWHnwLjVTXSlidh93kniJ7PFAtFNidTu3rRgNvOtHYC2iiq6YYRTnc2QwojCz5gl4Ad/sFCOx9pdsRb32gxevI3ynQRKxgDfsHlYI8RE7nZ/Sw+PTk9nPraN58Ja+ewsfDn4+OWgdBMfU9x5rnmL/SrhioNxYJWxTP1OQcdAjcm6k3dRDLMmMEeV0GDQ8lEIxHUmhmUbejg4O8J8y0c4WITn7nfkxatBHhYkYJ9EoCp0lm79rnPmwLTVViq5hHo/ZSheeW4repjwbHkF6LKY81DAuUuhpMbd882CXZsu0BsEevXyzDax1n1pvuuTgpnpzNXA+nN8orToIQIngiKQTA7FZErPNYMB1S/RfvnxhXJmL7ra/+CZA1ySgMSUzqhkoURAdMR/CFr44M6xRtdtCNJBreSeA/Wfwy4gZaq0EnFsuGmRqv7AwQHloEkuMe5+G4ZpEMkpCGgMnNCY+xKZJCDFfMXLH46U1d6IUcAZpAKiVBJ6AM11IDu8mSRRJhQ4okjCkM3yNAQb8r2TAtoMC2cU3TZQKWbZmqpG7JVOM8Bh5RaWcd4eXk8HonECS6v8j/YKzGoWXhsodD0NIbH6YBMxwbrTOBVkwgVkVpMysSagmoPmCKWAc8Ac8cOq4gCHlFe0K7D5f4YlVvraIUaVIVpgoM0HgWbYkpu+Ci2dDQKcpjSFk7B3ZoaxqHISqLC68N3+U84J9uyPnOr67o48Xo8lg2odn49EQ/xn0+ufTwfSfhY83nel0PHh/aYaZR8P+R/gXvnW63f5kcnMxHp0NzPTJ6HLc7ds3o0s75sOHcf9DZ9rv3ZQnD85/7QwHvZtufzwdnA0674f9G7f4VuWbOjczDu0UgdbIqxoGCiOfM5E+p2HsQ23EPE1h+CoJYw4Gce+wjmLp7Jz3mqMxlIbQBJBe8mgjQe1SBQS7zRuOH+TRRHyKAUxZCMPR3BTIfUbo//2yM5zAg/PR9Cb70h2dTzuDc/w4mXbG08nNp8H0b8YAvewz8A3/H429GobtltJGKSOYtGjqxn6mwJKI2cqpWNlskOlhMy9cP2a+tn5ecsuD6Atbk7mSK2O81LClsMqYCriOQro+x4qzIzfd0jB5VilixAw1UCl+mpnuLgV1wpDv4KIESq4sJwXdpEwW3QKVl9HNPWOnk+VK3lCGk93TWeou+F3RfQRbQFYbMw2+77XnNNSAm/QS5nS58hOeP1TMlyroLnkYfKQxYBedvUKEgYLXzHoAmrQdEQxsJnLDfJwL1cYOBi/Z0I6wvBfNk1ZIV2muC3FVgs4p9nnE/2peaxdU64KFoJr1lQI71wnA5UQJTNs2cSAnDJLpTAZrrE9cgBJ58BIgtyfhBobJriuZX/fKMy5YfaEgLQGHzLDsw0TEFLc8QMi+klBKLck095lx5RgBTTQOyXsagLxWvq4TBtQUK+p/AVqDZyDES8FhPkmnEB5k8bJjWXbC6OzdwelRa/6uRenRz63Dk7ez0zk9Pj44fXt6iquvwE/ooliL9tS4D1h7ITOFEnAN/zcoBMu3623M4s8veobGM7OCHZuJ6fgl2ATVIGO+716Q1gkJqVgk5jldbChB1C8nuzKTJTxSfMF3gtU0+ff6Z53LIVbDMSTg/mS6J5V3BHhrgG4pDUJcyjvDsRPgDpCKZiGoA/oa8sZRfQMCUaGLA7n9ptcalAm+NaeQFWCGW33HjCLpPFOmoeTbjpG84g3WqEF/Bc9WmBlytIzD33R8n0Vxfeg0+YYsoY9k6nWDdIKAo5A0tDlaw/w1Nmo0CCziMjU+gVC2oFYmMRESEPBGE5GrsmyNPKEMi0bB4ADOn/aTjh8nwJwRsxiFmbc4Fp19gGeruTJ304LSjErXgEj8FMdD3oXkC5kJZOOxJi4dobk0JB6RjssyFqbAVCyT7j5aZnqxNO98muhnxN1FCOmnbkTLXtwyF3waOyCbjYw1UjO5jAQvDYTGyW5UZq408G3fUsVuFbtV7D4zdjdfjt0GlXtroM/hNvS5FDQB/SpTPLegjzLeIyRJB9m2wBqyhr25g0i/fJpCYH9hAsez+wiB23fER7aU79hiS+1hn8/SDcu09Oe2QAaNHt3eJ2QiFrQN3znHFiQaVR1vr3Ym1YyDg4odEBE3SchaJoSCylQiBHJCdY0EkmnxU0yWFPIjhYjQ2mZAXFUE9Qj3USokWSHJqhpV1ejHqUYVkqxit4rdP2fsfhVJZlyZaHE4SSerFVVr62nuPUpLCQwg6U+lJAu5bP+1iFaQGMkwlldGDt7s6HB2OD/xWSugreDd8en8yH93RN+eHJ4czlpHJ16x1l/lcZwFWTmmCva2drR7zUzd4g/fApxLx1IG5e0/UK9ic0xrmHoy3Aw6x9+Ec+zY2saO5zIG2YAwYEe1Z3vxcjxE+vjzApJHvclE+QxhtlUdDKexgZTow/aX+wo6VtCxKj9V+flhyk8FHavYrWL3zxm73wQdW09Bx9Y3QMcWQYg1R4j1R0LHAHAHQrM5GAVkSM9QKYa/fcOn/OSlST9ULVicAb0Sijw63XF6SkrykYp1CpZ0aSdS5OrC9AZjVzhWpWPxzApZQIoUeDqJS3uwD898ASYF/yEhX3ETxygQnhld1ztzPApjYyb1t2wVd+ZKm6QQStx7leBjHNyJzRH+AQWzD7qARP0d9zidtf6r/WAyRomHKDHp3/uMYcxn+79vd50SGADzCtPFxNp6z3EBu2dOBbQR7D6y6SuDoBVUr6B6Ve6rcv9jlPsKqlexW8XunzN2vwGqOzS0H6rDgGdDdRjbOCAZljpD5/qfI3YTKo4D495E+garBzkGN7gCXMldyMIcgreU2l5z426Tbj7w4NHDe1GICy1LiQph6DKOI91uNh/AUmChxwaNeIO7Cx9C3jV8uWreHu/IO/YWCvoMZK4g8U3f0LkYuEajYfSrOLqwzXdmAattIxE6K2jdnC/4Kn08W4tmXEMPQiyZGl57cO5kHgObEfQS2SUc1M6WjCDbpQofn5Ln1+OvyWGJ7JFjl/q+uhaMJ8DlhnjI/nV+jW2CoNuuvnWZLS8kuN1/tLXYCIcdkfeMKnPzB0/AvPrl0/R14VqIvUfHOPYGECwX4CImlXXS0yA4yVQXJZOFvXzTKZ23wdAh8xAEJr+JCWPkKr00dA45fgxJ2agUJzGTB3DW9avUMgG7ZSGWv0auSXQ8HogmaKhJS/Nem1JneoLCbcHGb6JOehwzEN50MGOciKbFI1dRKhctyPVSJv6SUqtbanVDTb/e4MKq9sq357d9iF8kQUNttPXixS29eoEeNlDwBKlu8oCacHyUT0n5qdVezEeJXh3plfn4TXxacqij5WnEpi2ioQyGARkQfymlZn8lBF0Hw+BqkUAUvZitO1y0biKifnRQYKlul6zzOqBCw98QAkNYZ6IzrMoGlEi7P2JC8rOxLMT8Z+iZA/K5JLN5fAXFE0cG0tcv5hkXrOOCdZsDtOPf1iZ0LIhtlMHkAesA3dz+JhM4Rgs5z9LamdUN+aaZg6XBB1YNFR217Zd2nuDcJ2Je4OhsDKRgBNXZuTH4ThwtLFAlZaXbAZsa3OY3lFAXN/Rm+c1+1MRa+f8mL0rcyXdNRiJcf+8svSeT/P/k3T8o41WZ5kfMNA7moruZZV0/UHRyi9a29/C0uQQL/4e3JlINnoZuJb9AXCQThTRGnzYx7S/xIj1uijMaI/KrpdeT7dVoDH7o8QyhBV5Oxru0gEbpjIdAr0E+QXslfFAxtlZ46hao/i5dj5XfTu6lhgMAtVolAi9ZAxPJCm89P2XdgGs/sUkIOi3BUsmkgXHZrDQi0W1QFQ3TZKiVHs1xmxg60IIRn1gLbKjdHjEoEi3i/iBCLsg4vWoK48rw+yna4Dn1JQsjbO4ggwKYYoUVPg6mWxSBmHA/TEi1aLpJuolj8RIlCG+d4bgBLR0+iqSOoRMt0P3A4s0r+WS2JoPepkc95Fvj3/vPVbjagKC+GeFGFLKa2CbDtnRX3mZLB9PaPMBbhUuJd62vvIcH3K3ABucRH0OXjq3w1XXev5i+D9SNn4PsauNeKV+N3QXH1+b3lm/4+xN7REp34ER+e7TtwccvDHv27I9qmDu4dmvFcGxf282XwsStnyewZcoa4g999Be6p/q6D6AdyC//AYrj9Ts= +sidebar_class_name: "get api-method" +info_path: docs/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 Campaign Filter by ID' (get-campaign-filter-by-id)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get Campaign Filter by ID

+ + + + + +Retrieves information for an existing campaign filter using the filter's ID. + +## Request + +

Path Parameters

+ +A campaign filter object. + +
Schema
  • Array [
    • criteriaList object[]
    + +List of criteria. + +
  • Array [
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-campaign-reports-config.api.mdx b/docs/api/v3/get-campaign-reports-config.api.mdx new file mode 100644 index 000000000..e660ff15d --- /dev/null +++ b/docs/api/v3/get-campaign-reports-config.api.mdx @@ -0,0 +1,84 @@ +--- +id: get-campaign-reports-config +sidebar_label: Get Campaign Reports Configuration +hide_title: true +hide_table_of_contents: true +api: eJztWltzEzkW/iuq3ocBKm0nTiCbvGwZE6hMwcDmsjyE1CJ3y7aYbqmR1AFPKv99vyOp2+7YISxD7Q6UeSB299G5n6PvyLpOdCUMd1Kr4zw5TKbCjXhZcTlVJ6LSxtmRVhM5TbYSx6c2ObxIRsI4OZGZX8QaaptcbiW5sJmRFb0Ar+fCZTNhWeY51EEKm2jDsriImSCjx0a1MUK5Ys6kY1JlRQ1eTCs80EowUYgSr1nKZI6/0s0Zd87Ice1AlouJVCJnHLJq63QZ+UJyUZfK9t7BmI+1NKA1uiDGEzY6Ojn79/DZq+PfGFc5e33yInzrwVQrstpACMy9Ts6tMHCCE5/dsHYzcoHM1WFjQxptSIOZh0bwPLm8gTcgrtLKCnjtOhlsb9Ofroca57HgazZa9hT0yEiscrSQV1URfd7/YGn1dWLh3pLTJzevBPjp8QeROYqVdIVYFWBXJFSG4u9kULJx7rDx7Sg4cEkEN4bPsVDVRcHHJMSZWtwOfSGtIyevRquJCVhIJ8pl1hYkaprcbCXiM/Qm3hfJRBrrFC8FFhQ8fry88f+2kr21Xi0k5cqRMUi1FKa72lB6yAlzM4Hc+FgLqDfWObLNItuueCHz3p/xd9eNuXBcFiOdi1XrVooEmZtODfcJLLzKGRYycLySOVawUhvBAktyKZng6Ujh1lHkid4Oe8pzdhLtG0Vj4CZnePY7eFGJ36fQuZJYz5olCKEv2TvEin3Bx0+2DwZ7kyd7nA/+vrez/3h8MOG7u9sHjw8OSHoprOVTsS6LuqJfCCWMzFihM0TkDzgExWRjz/DC12TNHTHwPL7C/2ewK9C2ZkZ9GVX8FuPs6egN29tnBVfT2j/n01tOUOn56UpNwPLA+LWRU6nWqSJUXVKSPzt6Pjx/eYYnJ0f/PD86xSfitdJRhwrZmlNaQlXkwkx/8hpHAz6hAVq0ysyJvMceRa6PYBBXdplQhm92buFMap+8LhxWROlrViyzZhODFrtcSlloj+yB7IneFhvTs5Kj+7Mxt1iAEBL5o2GWicqlL6MnH7EZmqUwD3tsmOeSjOQFQzWCKdbPwYjxPKfSDQwmNUoZykg307VjSjuZiW4sFq683aGanvhyOShUHND8/jwZZq6Gct7M5SpssyWqGOMDnYPnutqdLTnNu3SuHM9gBS+w02Uam2CGzgTbpLMstiMKl0XjUQ1d27GoBTZm+Xb3KijzzGn/LuO1/Yq6e1Og/aTetPbFlYjFhzTQsRv5aDRhih0JL8lsvzhSteFqCp9NpCjyTe1uandTu19Zu7dfnkQsGd966LOzCn3OFQdE1cZvnivQx/jsUZo1RAGRh0BuMTgkQqRf356hsH8XiujF5wrI+Xvio7CVryg/bOMRno8JfrTB6sSCFPR+jDMFOpHID73eC42TBUrcXZX2XJuxRIKqNRARXdOwua4Zh8tMrRRpwu0Wy7Ww6hfHZhz9kaMirA0dkKSqPK20VG6DJDdIcrMbbXajn2c32iDJTe1uavfHrN0vIslWK18tESfZuiy5mYdMi+/JWs5AwJpTTdaWnA/VbbRCzFiLsZIuckjGg53xzmQ/E3s538uf7B5MBtmTAX+8v7O/M94b7CfLe/3Foo7bIuvW1FK8Qxy9iwHiroDjaoXksk7rvHv8B/caMaG2Rq2nxc3wOVy6OGEcHKxixzOt2Suu5g1Csh0MqRY+op4G2pJoTUMLAs6m6IuKoVVJ6EWpJEsBLgZJwwpZSl+8ZAX4mnk6nDiYEgqlSbJWSnteTp2g0ISaNRJLwkgxIcwHDh7BTtGdvyM6jSH6U0ienZDFL8lidvQ5E4IKvUXuj9ed7x5DeUM94jQE+I6D3jDtcIUEwEAQelaLOzf4fIPPN3v8Zo//Ofb4DT7f1O6mdn/M2v0v8HlEQ3fjcxB8NT4HbW+btVjqOSXX/xym+1KJGvj0ZjrL6CpIvsDgHlcgleL1FOohnK5hJP3mCobtd+9gLK43hBEgKFebAotmzlX2sN+/RswQq5ser2Svuaag9Kdepsv+1e6aDkRXBUK1oYfldeZPnodvjuOc0fOeNpKSOXQ+LyD43dtGaQv/+zPiL/KnOw4U0Lmu0es8my2GxI+J5R9DzQpTxS/WU/d8Iq3YCNvOTXFznz3/2v2SHYHJHXasc98XZYGeQctb5pH6l4t7N6cEv4P0lds3iy2FRrbBirDXRDZgTwU3mA3CrxgPfn179pBNCXT6oq8t4V0haUpA2bxBivimNmxO9GmR32eMrqczr/iw85sJFRGbFDCYvVOnQrCL4+iE39DtT9CevUtpkfAdgVZdPmgik4srUdBG2Ft4khJP5qoPD/V5Z91Dv+n56UAqfCz90947lbJnknqRpM2baKKJfthjF1VjF1+y61uV+FvDLQ3cUs/NPrylRXDtRRbu4GSoZGLBC+u99c3CA790iR+NUnhCXG/rQJ6IenR/6cqaqH2zHh1+KfHr6vFOvZ1J7KjdZSw0MGaxIRY5O2bZTGsr/sEYpQ6VwcW0RhV9s1qfSGjqKyIdbC+plAaRqUyBD71+L1EYKiQTH9P+7OGJBnJTeSjJ9z6yqPn3/mbc+47N/vEFtlGizHVmv1lnEpiSwDT0ABv1D7sUJRZqm2zwfSAkwGgRf98JoqJLPS/wWtvVPfu+X0NbQwZVPRdbHYYvh4sGFz8x/4KoWxq0YILX7W9/+M4iL9qqOs5qDgZue3BV30Jjh7zlt6BvezBFu+ZfzV6yeLg4P3mtivn37tJ3dJK/Tt/9P3W8Taf5GTtNBLyUbl5snAyWkzygtdXTPDpungn8j7e+Uj2yxtziJzGPYZbZVAV3lNO+prOZFP4coBLcEfLborzSpa9DwF0qfkx7ntHUgAZFa4FG+VgW4NdjbzFoqQwupiGLbk6A6wcdp61TePkNBYk9awIHAFWWtaKrwVCiLhlHetwT3VzarA5NCDhficYy7WFcu6qpSEobckXPjxumtK8ndGCMWXQpiPfIQgxtPC2GIyki/v4xJpnWkBNR+Cwjui78vo83MiediaKiMQ8dFGBKLEl4dXy2whHMlIVdGKe1mfbjItsnWjChUSckw24Pwx09qrR1mEmX+L4Qjt17LbyTWteL0/If+E5/3I9okOhXdAxG7qnDYBMGyoukHSgTur2/bqTEkDKDS4n4+pqOTWi+uqHHH2tBM/nF5WJ8om8QEo5P/Az6u/Bjuz9gWUzmqz9B0DDUDr0vjigT+B37avxAom5u/gPnDYU8 +sidebar_class_name: "get api-method" +info_path: docs/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 Campaign Reports Configuration' (get-campaign-reports-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +
+ +Campaign Report Configuration + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-campaign-reports.api.mdx b/docs/api/v3/get-campaign-reports.api.mdx new file mode 100644 index 000000000..684253ed1 --- /dev/null +++ b/docs/api/v3/get-campaign-reports.api.mdx @@ -0,0 +1,96 @@ +--- +id: get-campaign-reports +sidebar_label: Get Campaign Reports +hide_title: true +hide_table_of_contents: true +api: eJztW1tz2kgW/itd2odJUgabiy/wskUwzjIVGy/gSdU6qUwjtaBnREurlpywLv/3/U63JCTwLd7UzkyKl0SWTp8+9/OdRrp1wkjEPJGhGnpO15mLpM+XEZdzNRZRGCfa2XMSPtdO99rpiziRvnQNOcvptPNpz/GEdmMZ0QNwOROJuxCa8SBgsWXD/DBmnLkVFm7Ggs1W6+vhaf0jNv93KmOwiMMA/4Y+6w/G08+90/PhxR477U3+8XbUG5/usdH4nb3LuPLYeHA5yskguBZuGstkBeFvnSst4n6oEvE16aXJghSSnurm+9asoN1YcM/5dAedIh7zpUhErM16SZpFHCv3HIUH+Et6tAlUXXKne+skq4ju6iSWao4n4it4B3Sr6XYaJwcnh8eNmeu7/slB47jhNluiPWs3mw3fde72nNiqDC8kcSo2TTpdCFiGDJHgqjAWWfXLQrqLws48FmwmIADzjRe8ukPKwJZRqLTQJGjz4ID+q+7Qi2O+og0K5pYlC2e/CTfRdWjkkv1UQot5FAWZH/d/08ThdtsUnHhinUzEUpfuW5YUWjIxBsqDidmoc8rmuHasIFNaC1UQVSPfuGR9tcm3qtpkdMqiEOKu2I0MAxt8mXYwTBokpFwUUy4kUpQk3Xbqt3Jmp9MRIya0hVDpkhTK4nQ8mFy9n5JO61CpPkJcIMi+hxhIq/tCsnXoNToNfnJ00Dj0miftw8NZe9ZsNTltbcP8qc3/kS45pQ/3+CwQjBblcfo8w6+FIvpLS99gv+QrnLu7daRMQs/GyNisP01CSLodAFVn6oQnqX6GHQ0dSc8fk73syslVvz+YTHDnQ298Mbx4h6vBeDwa4//pYIxC1JsOTs0f55ef8yeXg4tToq24Pr95d0cZmytc1nYsfBEL5Ypn6FxKmif1pqdW6yL/cv36vfPL3vDdxef+6PxyNBlOh6OLzzZIQVU8HQ/OB6fDnnk6mfamV5N7iLYeoKYPz4b9bBlIRmdn+eOKaR6XomoqozIiJuA6Gaeql9ynP4XrSAWrvNqikC45KB2PJ6KWSAT+fSV4GWqKXBdFkBGl6TpEjXCXOg/tLxyXqcocWWhRSFHNcZviRY84OnEPmx0XCYkrlx/5nQO30Wq01m2nKJb9cBmFWprILByXx3opMsuh8IQpS0ZDm2h0ao1mrdGZNlrddqfbOq63Tg7/RXrdUU627+sj/UCSdQZxjN5Ug1xJGivhMWlLAtV1ASPOQm/FYDKpbnggvZd0lwcC3xMJl0E/9J4R+GdSido85pIkFEZkFwsZON5Ij7roMkRDtSzzqmboqoULlqg32FsOCJLp18+UodIVc/d38Bo+o5JfKYn1LF/CpGd6/APbimPBZ0cHnWbbP2pzjvrdOD6cdXzeah10Djsd2n0ptObzclMr2nJ163dCiVi6LAhdeOQ/MAiSBLY3ApjNH+vkVR8YHs+wP+WUpS3UzORlBNT2UJHe9i9Z+5gFXM1Tc5/PN4ygalcU5SoNAupANqWpABjGo1jOpboXn2Ul7nRw1rOJOB7882owwRXx2oK1PYVo9SgsISpiYRF+MRJnClDWaxHAHABd7E3G9Q0U4kqXCaX9S680jInY8jk1QvYm2/2eFWXWzI/DZSWVXItq2StZF/U9oD/cQzEDKJxxjQVwIZG/6bmuiJLa+8ySb9gCRVDEr+us53mmivCAIRvBFOtXYMS451HqWgZ+ilSGMDJZhGnCVJhIV1R9sTZl1RvrGv2+7BRKDkj+dJz03CSFcEbNchYW0ZKJmPkHMlvLVaWbloxmTLpSCXehBYAkJpAwRmVHZYJuEkg6K0fkLo3Co3K6omKVYYkpd+dWGINJ8MzlqX5G3l0GKD81o1rx4EZkyYcwCLNqZLyRuymrSHhIapvFGVXhrjzxmS9F4O1yd5e7u9x9Zu5uPhxn03P21ECfxjb0uVI8hX1j0zy3oE9sokeFLCeyI4V15B6DQTKI9POHKRL7d6GIXnyNaAz+jvjItvLt+b/wh70/I/hROKviCxLQ2NFq4KMSCa9r5F5LXEKJre3dzsJ4JhGg6h6IiKoZs1WYmrMM4GhFknC9x7xQaPVTwhYc9ZEjI7S2FZB2VV4tCqVKdkhyhyR33WjXjX6cbrRDkrvc3eXuXzN3H0WShVQmWzKcpNPlkscrG2nZc3s2CwKW/47DipQzrtpEK8SMFRjLqSIHZ9ZszBr+sSvaHm97R62O33SPmvzwuHHcmLWbx06511+v87hIsmpOlfxt/WhMDBB3AxyXKgSXTsLQqx7/pXSO6lNZo9JT4GbYnH6wWmPH9jZ2vAgT6AbGwI7xA8eLV+P3xB9bG/ZktzCNXUEw25oO5DwxkJJiGJaWOtlBxx103LWfXfv5YdrPDjrucneXu3/N3P0m6Nh+Cjq2vwE6thlBLJ8g1h8JHT3gDoJmPpxC746lMK8i2BhBFVxlp49Z2ic8noukAHoVFNnsbKPIaRiyc65WOVjSlZNItTYXlTfQLok2zmlBwNkcJVIxVC0JdEtRRS8CAJPSiwGBXEqTx6QQ+MarWs9PoJXNmTzeil2kcoMUEpqiEIR09hoixiTCSfgE/8DBnIPOUai/4xln5q3/6TyYjUnj96QxG3x1haCcL85/D+97S2AI4WMqFxPr6wdeF7Bn5lxhjBBfI1u+Cgi6g+o7qL5r97t2/2O0+x1U3+XuLnf/mrn7DVA9Q0MPQ3UQPBuqg7Z+wAosdUbB9X9H7CZVMglMeLPQNVjdW2NwgysQStk3JlRD6EuKrrOff22g92+ld7cfF1+d2CHAypTGAWgXSRLp7v7+LVwFF93VeSTrqGDwVrJS4Ze6Gy73b1r3FB56z9QmGUqXl7pmcOhdDrNJo24MHEuKYVvwzAbW3EYlilaY3bxg8Cj//O33FYYQZtns0ev/WTyZ2xAzwjDxkzbUdRM/WzpCt6s4uHtKn19aj+lhmTygx33me3Qv0DNIuaFe9pZz/q3NhFC33X3ri5t1J6Hz/ubWZiMia7K3gscYCewrMK9+/jB9zeaENU2up5pgrpA0HCBbLhEippb18tdBaJFpL3GYzhdG8F7lhRvKHeYHUJh9VBMh2PUwM8IFivwYVdmYlBYJUwho1adXuWc8cSMC6n/1tSUp8KSn9mGhfV5Z99r0OjMUSGVfMsfd+kdVY6eSSpCknk00mYpmxmPXUa4XL+n1UiH+lnOrWW41w02/3pDCmvbatS9wu0hgYsEDbaz14s0tv1qJH01QuENcN2UgS2RyVF+TcnOvvViOCr8a8avK8VF9MF9SVZcxW7eYRh8MPDZk7iIMtfg7YxQ6lAbX8xRZ9GKxzOdbNZMRteZBSaSa3bIma4CFRr73SAxlg4nPqC0bVBLaAxKTkr8azyLnfzVfJvxa0dncvkb3JEovdPWLZaYNa7RhzdYAnclvmxMFFnKbdDB1wAZAf+1/UwkyQUs1z/K6t6ob9vtmDbUGF6LaD3uirv2juy5w2RUzD4i6oEEJJlRdvDhG3ydmvKhDVYyVnwdsWnBb3iBEY9ywm5W3+FWTmuWfTV/SuLc+NqGPYb53lX6gkvx56u4fVPF2leZHrDQZzqVwM9tmA0E5yC1a2z7Eo1PmhcC/eGoy1QBqjCtmADMYpswmCnhCMW1y2l1IYcb/SPCEkN8exVW4NHkIuEvJjyHPMJrHoEHSaqBRPpMB+NXZB8xXyoWJabai127B9bcwG7ImsPIlOYmd5o6jz86WqcJayrF0yTjC4wnvelK7qS1CGLWUyDULDYwrVuUZSWFDpqibKSNe6pFP58QYQUtOfGIv+FBnh8QwJHkk+3xurchY2M86ia4Kv5/ijcipLUQQme8MIRZmtdIO58PpFkcwU9kvE2E8388W6X2iBRMadWwwtOqY6ehWFOoEo2iJ7zuRsI0vpfVmMN2uj8X/NN/hZ/2EBoH9iE6vSL3UDiZ2Drx2ijkQ9F3zYX0+CmK4WMAURHR7S6ccNBfd0W1M9zRCX39ajz1mXISX6BrDpo8asPktfdlCrzIFvdfmd5qXfmH/gIr5MZ5arSd4B5e/Cxr8oSTGYyhnTmaM4PaBPbspLdn6dYMGrmKefjegaOMP9O7sAkZCdfovPs/iCQ== +sidebar_class_name: "get api-method" +info_path: docs/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 Campaign Reports' (get-campaign-reports)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +## Request + +

Path Parameters

+ +Array of campaign report objects. + +
Schema
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-campaign-template-schedule.api.mdx b/docs/api/v3/get-campaign-template-schedule.api.mdx new file mode 100644 index 000000000..839f01e5e --- /dev/null +++ b/docs/api/v3/get-campaign-template-schedule.api.mdx @@ -0,0 +1,167 @@ +--- +id: get-campaign-template-schedule +sidebar_label: Gets a Campaign Template's Schedule +hide_title: true +hide_table_of_contents: true +api: eJztXG1z2zYS/isY3ofYGVGWZNmO1Q83qu30nHOcnF+aubM8U4iEJDYUqBKkHdXj/37PLkCKevFL0rS95jTTaWQSu9jXB7sQoDsvmahUZlGij0Ov4w1VdiDHExkN9YUaT2KZqfNgpMI8Vl7Ny+TQeJ0r70ClWTSIAqYTBYHxrmteqEyQRhN6AXY/qMyIbKSEcUzEIEmFFIEjEZmbpC7OVJan2uBlu9EW0YDIUiUiI3QyIzcqq0MQo4I8jbIphLnzLo1KDxKdqU9ZN89GJGAU6k4xh1/M0UmVDL3re0g5kakcq0ylhjlEJOtEgrbmabzAX1FI02DasfQ6d142ndBTk6WRHnr3NS9Vv+RRqmCzLM3Vot4XUPn4UCSsxbK24naUmIpRoGRfgbEYqIyekYrqE6himrTR7qswUNuv9vphe6/fkqo5eLWr+o1+f3s3VMojjVJlJok2ypC0rUaD/lmWCVZLlc7m3bFSxLo4V4pfvb+8EEqHkyQCYZgE+RgcrOeJepzAS05YQ4IH5AqdkQByMoldlGz9bEiKu2WbJv2fVZCBcJJSLGaR1cG+XbT8oqEPyYnjSCsbZskNgjmOZ/oFMlQ6gDbHWgyVprc1QSOyaKwEpouSUAwiFYdGmDFeKLKH1NYo5CV8hARgpOEjAeUG0TCH4+viNbR3ioOnOOwen/y7OrMWI3mjxItRkqfmBYVuTfTzDPGciRehnJoX34Hsw9HRP1fS9ZNsVBJLHTqaIgWUzscU6pYeD96+O734B3/qnp5edk/440H35Oj0sHtGqTmLKEeDMB7DWSOzyhvzdj6fqAAZDzPfjqJgJCwdBbiciS4RCTLIohvY+52Op+JGxlHIUVKINBtM85m6OHKR0+npnn6nxWvVT3OZTlnjtzINRnjz0vrg5Pj8gv4A2xyS9LxWz6vhn+2eR9RHcP5UbDvZasJkEtGErIq0eCM1c934Bf8gZOLp5iN8m8TwJegwEg/F9ox9dpsUyvdVdqsQH2/y2Ip7qAI17qt0xvmse/rD0RzrPStys7UwRaunvzAFjhAIdrYMQMl+mhYi8rSVYCFN8SeLNR8S/AYBYQWtzCrTVE6XJv3R6uMArjCINCoUiU0eVYpFeAEqvJJ9JCh4RUAZsxJWS4GuvCagGkOdgSqj6dFQpVWMbNU8RNlYZvb1bntJ4OPC0IXXOMFhawcLNMx493PIfmVnLI1C8lAOfn66gGrDbFZzBZBvU4XSoy4uRniA/4rJ7TpZRTKbLz1NMN5zEvU8i11ilBCAhdFgoBjfQ5lJEaoJcJsSwLmEvQGXFTw5Ti0WdEjE0p8w0Eex0fT3NmmEA5b5IexyGrPdrIkT/Oc36/U6jy9yveNWcYhrA6QUl5SPTUJQ9iyu34mEqoHbyKiOOD5/57/abTRJSTJwlAEjMzFVMhUbPc/3my2Q9zyWpcC/JTKMbDVajcrgnj5NMlryZFaSwXLIbZNPJknqKhlKFLZkjXO+BLYwUYah3Y3mwZxo1u63IwQd8vsmClXY0yT2Y6rUGXIWwPE812Stp5DLBglqpAQCAhRiaSgkpnNWfoQJrG7ZvE6TMVO0GpAWnOjzE9yWIa/VsJh3UoVphnbR0uEjcvh+Y9tvtCwZ1C9pahCo1SwpOytWBryfUX9NZOVw/YNwlef6f0BVrnI+H1aJ7HFcncsgt4KPUlS2POOsRBhQpL/qvq1hRQ7i3IDBI4H5alV9cJiTuVHhGSpHjZ3hsbzYt2mxY+O7m4kdml8nibbQsvP+7SMy7MwKCf5372sHurXQNx3pS9FdDf3fJ9LVp0lkR69ySykQLQg+9SiP5AAv6dTGyAFkcymRUSFRZsNthBIC/XOcaGgskgAN4HxzCaBs+Y19v7kvmtudnZ1Oa5fsSHz/A5vTpsBT0XNRyPErCCiCcuOWuzTXmnKiugNg+6ZII/XQmNWKGqGawMVnXrzAQ2BFblJuUFawgmUZgQqCBvW8A6QHEmGOFWs/oxcYM6/8AUXsapdZRLomS2Q8ttgG8VsgIaL2qib7II6o/jpKUyjpu00NKOK0pIkUls9+Ek5J/Ehzi/QV2+ZQZTKKD5LwGWn/GkDlD1MZkYSKRQ5A6KoUchw395Zlkak8bt6MsES9Kb6XIfS1+h04ZSiSUhl8BK/nRNKljkAvChLhmscHplV7SvZ3G/ut9mC3LWXrVbu5t9PfH8jt7cb+zv4+97dAYjl8Bhz9QFkcBciUAB75FQZJlTRuj4MnX4E7D/iAeTzD/pQ4dmypppNX0GYWbSp8f/BetPdQc+lhzs/lcMEI2r88p22rPI5lnx7RfhQ0t4zfpdEwWgk1BaAfHr3uXp4wph/96/KI0J14LW3ldTWiNaSwhKiIhVFya8tBq8CtpGSMYQ7aGnnpuL6EQlKb6sDIbQhODYyJ2BrIPM5A4WZfQVFlbRfqaioFdudPbER1Va8BnvEMGAoonFtOXnaDQE0y/8RZ8qUYKRmqdLMuumEYkZIAd7e6jlHd9oGrYUipaxkMcqSyKmt0VPpRoOZ9MTPlvDdmIHJSdQolByR/Ok66QZZDOFazmoVltDgRnX8gs7XcvHQXFaOxSac6o1IJI9HjBEmawsK8QRWh1XFwZDF2LHUxrkSs+/uZWgx3b60wh1nC7wKZm2fk3fsY8OOzauWLG+WSzxC2u56JvFG4ySGSa0iYuOisClsUiW+XinXurnN3nbvPzN3Fl2fuqwX3lkuf5nLpc6llDvumvHgulT7lVznFIPsNgnVkTVBJaK3z5sMFEvsjqkeM52pZfc36yC7lS8J3S3/Y5/2ibC2W/pkvSEC2o/sOBEikwg7LPZOYDWVNtb08GyrgfoQA1StKRKBmKqZJzrvpRQEtTY03mPSLzH45IJERxlgEpFl16PMXNOtKcl1Jrlej9Wr07axG60pynbvr3P1r5u6jlWQpFWeLq5NMPh7LdGojzb23pwwwQBSHXESZcnZ7eqFaIWairLG8+crB67ea/eZgL1DtULbD3e39QSvYbcmdveZes99u7XnVtf5qlsdlks3nVMXf1o+e/fItvUEdl2sEl8mSJJzf/oN5UzUgWCPoKetm2BwmvZ7Vju3l2vE0yaAbGKN2TB/YXrw8OyH+mJrZk92SPA0UldnWdPZrzvI7S/UpMtm6dFyXjuvlZ738fDPLz7p0XOfuOnf/mrn7WaVj+6nSsf0ZpWNbUIk1oBLrzywdQ9QdVJoN4BQ6Me9ObqdqAlXmTmAz/Mh0qLKy0JurIlv7Kw6DJ4l4K/W0KJbM3E6knpmL4A1jxzQ2LcZigBRDQKQujlBTVNERANSkdL49jsYR5zEpBL7p1O/yIQWbM0W8lbPwoRtIyKBAhxVo3lsZIZzUgMo/cOB90CGA+ivucTpv/ab9YHFGGp+QxuLoU6AU5Xy5/7uz6pQAHyYhuDi3vn7guIDdM5cabYT6NLHwVZag61J9Xaqvl/v1cv9tLPfrUn2du+vc/Wvm7meU6q4aerhUx4Bnl+oYW2+IspZ6TcH1h1fsnCpOAg5ve8iWDy0UNTjXFQgld8GWMITumna8raU7qmbrLgrvt8zszq1tB6x0eRqDapRlE9PZ2rqD0+Cs+7qcRHVgGfyWTXVyWw+S8dbN9goIsneMKHwAYmEecAvRfX/seo46mzqNKJot9PEE1vCsHMUtHMBHDR7lT7doyaNTtCPCsqnRaW4XWfwYYk7QVrwwPLrOkbSkI3S7TOP7p/T5cfsxPSyTB/RYZb5H58J4ASkX1CPxr2c3k+m48NjOvnQ/ebam0M5/a2mydzSsJb5XMqXrqHwYZuPNh4vN4qw5sp5uGQyFiqhNQN68R4gwqnWLgyFExAtNmuTDEQvenTt6Q1kkBjEUFj1Nl32vjp0RTgH3Z8BnNikRKYYEorreKDwTqhsV00pYn1mSAi8K9RYstCXn6DZnd4UjbU+542m9p31xGBEY0fF5HlMcp6duT1xNCr1kRa8vFeJvBTffcvOZm9lckMKa9iqwR7kDpDKxkLFha33x5JafX+FHvRSeENdFGcgSTo75A1NB4bUvlmOOn0/85uXo6Q98k2CeTFgEEwYrYhyKY7ocnRj1d8H3xCkNroY5suiLxeLrCz5nhN9qVETy7ZR+5KNAZPlOkBjaBpPs0wLN9Ulit0o4JX9izyLnf+I7Az/N6cyPr7CO0sgwCcwXy0wT+jShbzHAOPntMkWBhdwmHRgHbAAczPzPSOAErWCe5bUS1Zn9FtPQ0hBAVOZiJh37R2cGcO6T4Bc0uhwDCKb6ujxCZu+ZMi9aq+aMVewMLFpwWd44wRK5YDcrb/n9Ji2b/2v6ksbd2QYK3Vv/2ij9AJL87+Dun4R4a6T5FpHGVbwUbjytaw2qQW6rteXtPMO/OIL/4y1nKpfWaFy4FeMapsqGKmaKac7pYBQp3giYKJlR5VejuErGnIcodyn53R1rMUwxBklrUI3KfhSDX118oDuHAUxMXRYdwAXXnxPXbp3Dyu/5F1AOC8ehgBqPcw1ayrF8TLfMnvJuGJkgtyCEpkurQjO+3i5KqiIjKWzIFHXuN9KxeTegHWM0oxUnPjEXfGjcdjEMSR5xv3AzU+RMxe7+Ym2h/H6KNyLHH6l4Qn0eEBTFlKrM8Pb4YokjmGn3HUWSDrcckdmisXR5FMrbYNiuo7ujR5PEZGhKK3z5V4Vk+btDovilInQSlR8rmoutu9l++e/2o0RuuaA6f2tC21QkfW77DtvwXXnLDR8IO+WPDbHo13T70GQ0/O6ONjaoAbqnx2joqWu+up71N9wXwh30Gf3lAMm++GtEVd03ztxVx03+auY3/kbRSo2L7Ts9nXXuHj5+VNTwQ9V7vvHNOzIsvX1h92wqJEvfalB7VfbRPxxRbMkHVmr3AZYCFv0XfLn1jw== +sidebar_class_name: "get api-method" +info_path: docs/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 'Gets a Campaign Template's Schedule' (get-campaign-template-schedule)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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. +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 objectrequired
    + +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" + + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-campaign-template.api.mdx b/docs/api/v3/get-campaign-template.api.mdx new file mode 100644 index 000000000..cf9f99249 --- /dev/null +++ b/docs/api/v3/get-campaign-template.api.mdx @@ -0,0 +1,143 @@ +--- +id: get-campaign-template +sidebar_label: Get a Campaign Template +hide_title: true +hide_table_of_contents: true +api: eJztXVlz20iS/isV3AdbHSIF3qTmYYct0R7OyKKHktoxIzvsIlCk0AYBDg7LXIf++2ZmVQGFgyJldW8fy4jpsQjUkZWVx5dZB77VgrUIeewG/sSpndaWIj7jqzV3l/61WK09HovacS3my6h2els7E2HsLlybyjNdMKp9OK45IrJDd40voJlXIrbvRMQ4s1UhFqvm2HzDJucNaDUSdhK68QZa/la7iUR4Fvix+BqPkvgOe3Md/1RXr+vqp6HgTu3DA3S55iFfiViEEbXgYsdrDnWPaz68gF+ug90AJSteO/1WizdrfBrFoesvaw/HtVD8J3FDAQOPw0QUB3F9Jxg8wQLlYbyI1CjEV3jlYbste9gcWIN212kOm3zQs5pdpzXodLvzDm+1W8MaEh2KaB34kYiQoJZl4T8V3fKYs0UQshh+pH2vOHAVSKenS/eL8BUNNjLOj7Etvl57aoJOfo6wwW9lDgTzn4Ud14oD1hPKjKlfhyggsSsJBoaW+FhsZeKwYJEnPM7ay7HL6g/nrb7FW70eB3bhX/3+fD7sWZY1wAmS87irx+s7NzInBms12N84/BWwueBYiYHALoWPsm5MZ/SCCkf5iXzDfb4UISvz46HQ9VMpM97uTaBRp0CnJiuVFO77CfdATiT9upEG0m2D4sRij/k7w4Ko3w42DVNZJRaohVPf22jNAQpAOqE2VqrH7qow11bLqlvtutW9brVOO51Ty2q0e51/I2GrwAGbsg9lb6ik/StT122dWsPGsDck6lB3nMTLkTcPAk9wv6Kjgib4DlILdtBFhQBRKFvDOxCCuQBNTjvKzfGCexG1u+CJF6vfQFZwD5IyE4vdSo3mhEpLrTTk8RjkxSG5Sd+nYmeI4iIMVvmK7IvLwbRrihuMxBzm0HMY/MGTOAB2w9A9b8PWwTrxqCEeM1vLFs4Bu3fjO2kokjAE+8UScAKNZxodGkuVXe71+j2nLSwwNL1+v9dsOnNHtFrWAqdZtl7uRfjJCn3R5Hx8eT25/lfZ1V1Dje19p/X2NmaXUGp7e2/cCBweUxYKWwXL7nq7mx1jse3trsKGshp/VQ8bdrCqPTyQxeOO5/riPJFAYR+zJ+QMwyy6gcOchCzc/Z1r3+U9Q3QXJCA1c3gUYK8gJ8dMqiuJDEgTOLmraR3dKdMUNNi7O1CZvFBqiTVRx3GuNzLAciwge56H3ZriRyZl7SWRbNlJe3sF9lWx5Rh1WXWFghzYVNtB8y3tSBP+pzQr1Yp7GMj72tvWu/c19jK+D9i9EJ+jI0keQALQbWRQJaGaQbr1ZheaqKS62YEfm+go7yWgV7L/qu0qixG7MRXVthQege5OF4SrthW+8twVM2pkYOpWinpeKpSOfdhPu3cY1hLE2AtZDBf2HJBF31TGsuCmsilhxERZTTl+tG+AO2PsnxuWNFoL2wXXq0QXJ5OQmIj+wiIhxezTSQnNRiffXOfhRIvuJyZ8Zx24OKuBnaxgeqWUoYN3RAwqTBCgZKW2QpfvQCwGB3Jw5ffIiGzg4y8i3ASgL74QDigw4irQrC+uuAflhJgDOnZDDY1qhlmr4kklYNjOKNBXZb4ImaiGG0w6RlLQVRLFSJLrEwsWSZyE9CsIHZgvoJfbsfsFi5pyDW0A3zdBwuJwkytlhFbkR3lmMlA3ArAE0Lbub82j+JjaIcMXCltA/ACVOpbFRBhCSR2ZNCqxUbN73bQAtp1azUan2/v3Y06zwhkoJ5kN60ybNQj4YK5hjnKcaRi+983ocvR6PIMnV9Ob2dn44/Tdpfw5Hs3O/gZ/zKYX449n0zdvp1eT68n0Eq2MoROqvnaWl0EWxI59Pt8G7goOlEpGjJoA3G4EwhJ+G/CuVkRsRUQHpCBKmokvwWcx8rzgfi8aqKQEWCjbUPf7+obpD1agVA7RHz2dCZPRpNxzg41sW6xj0D6w2UxgfOpKM43lwew7CRiOBUBAkn0wJYsF2RV8ja48CX30pAuq5O+LRkmiXYW1GY0RISmqPxiiL9xLVBlqlMyC6slNuwZiwcVLPqThVBAuy1K5lbk4aAwYwFIl0dMMLdoP5c1l9UaFC9Tq8HZ8eT65fI3yfw1yfQ5/nI0uz8YX8uHo7Hry0+ja+DHGEqAcF2P1VP2gquPZbIq6hJoERc/zqqPqI3wIgD7C8VdPGWChVtFtNxiOkJl6bcy6zWm6bvysGZAxP/eA2bmcVGoTA2zX9W0vAaryNVwHGO0i/mAvoTX1c4NikOTKLZgbU4Dmo921g8QH2YZOgCxQwbsgdNErgRmNgiS0xZFptM6ms9n4YiSZfHNp/Mwx2Hj+eIy+V0hbEcjDOAiJP4qXdPzbxvi32T1tthsQH0kbH8Tcy+X9zKkHBy2WFEqk9MCjdqvaCWBTDPgzV8FmrlWpaaY5qdIBTXPTskgoVczwyxBokKYbfiaRaOc9aMEkiYch35RNO/MgtMO+yRtHFEHc89CH6cd4hKMkoseGeGMlA+qqvl2wilEVxM+Dbg/sXWXQqMVXm4V3o9kl/DO5fDUth77nAtygiEiwqEUtZSsRRQCz8gCNWgSGeIHNPfd/SlOl+bLvELCZPeGHLJvadUUew2TzMWCgH8/esk6fedxfJvScL/MgSPj1mytMKyeehy4iNfay4WnoLt1KbK3ZeT5+Nbq5uEaoMv7nzfgK/sK2ShxFcyQdWUByeBfcS+7KAWAYGQkP2IGW8AfV6g8wIO5HZkFX/oo2ETCTKZcFNVTvFTXMprWTRU/5n0SAWNoyM89eug3ROAajDM8oG83mPJLBLxb/QQKA+oXi5A/sDuRThEdgth3HxUFqjxxB/Q1ad+6UwB8B2iCJCWXZBUCasTI/G1lgemFOCpowoHy3nIzsGHOnNEwlxhIXa2lRJGqg4SjOFVKyBtOIpRuIXGydCyPnAhBoDmNz44ipvD1OVwS40tflXB945IKCY/pFD2uM1LyRxJzHgczNFCP3EVobfPVwvEuBHsu7foe3eaOae6q7aVmnzVaj15fJ4CqYcYAVz4QVC9eLwQfuTBWf42LaCiLISKXqyBSnqTI1bKfsBJlcKiMrk/FKdkvjj+S441ye2BMLUAWwup+/L+eLnU7Oce7vwT0SgtdxZtb1XGAKAgnIK6q1mItBr21b8F/HHgx4u7tw+otmX8CfzqL7hPjWSAArThvzNXrzdjR5ffnx1eTimoLW2c3FuDBZhTLflSrOejaWh8AIvZLPyVhECYT38RmFfnE0S/N1O8M+QzBcAkfUAMqsbFKmOOw7MPuYfg2lDcTGcxFTAR7pgImkfIopaW3FJv4i2C2ub1RKBQmQellcdsSZARkw7UBZ1GT/E2c3RiMooVCarKUTTXnVEDl4WMQz2fJzyonb3eL4Qc6g4KF992uxidIpZQY9Pc0jycx6CMU6FBHIjNLC4qIKBqpn46urYvBJz56awTynX3OhsvgFWhps4quEE8LBCICWXlEHrx1uyFTIlbF1EEXu3KPUoREbGHZeA6YT/oW7hEXyRuZK9p0uUZqEUhqG0pN7WObJQiZW0cEey3Gl/gVGsQzA+PnctwVbhkGyzq1u6F5ovAAvdoY0ZM25TEqx8+spTatUaz1jxJ/X05/Gs0tMPXx8PZvevH2O5GgiX0Rpj6akFLvCkMRYkateb9vXhxh9b9nS0e0N7G5raOPS4cC2eW8xtOxmu9l+yh6FXEe0tpDr6h1MmctXDP7FbRuk7iSR+7Ud2cD40pYROZdGohinH4XFlOI0HSaz5EoPcIaNQrkIFECowgaVdRF+kR34RD8/oYh+0vIKhvZTmg0Hm/S4xkhaCnpjNLVHXO24hLm14TbHFGjDXaEEegg5unEgakyFIWy38iv+dSJfNi3LeqrVP65Jfp+BqsYhd/09cgmvkhDmAjP6TmKr+FzKR3FjDsya+IocQBtoAliKALdN35GUBifAAE0KBTFPUlrFjS0hyK5Vd9Lli/Eb+Df1ER/fzqYAlMYq7b99QX5E1ORzEEZ7JEcV8UWVu5R75IJQesmL8RkAa2MdblvmotLT4+Ikd1q8b3Fb9J0uLU7ai1bL5kPLalo057rDx5gzurigNRBJTpkPNwi6QcQdDd4AJguSi+3ykC3HS9lRTlLnBYBhTDqRgtZqIh4e8uvARLsxnA9ZxDoqiHVZVSobQ+6EgFIBxYJ/ppTC0+DQdK3SEBB8L9xlotfx5QYrGi+2TylA1UEWO5Zd3MGHH3z4oz4chWkfR5XKpXZUWHGnjwL7FChHpTr6RPOaeimZZANj9hc0ZL5wyQKgHMCzY5Il2REPszBm77BlL2MWipVwXNT/PTes4Zq5mYrAxU7ZBG0d49HnLCnBAaMvfbJ0DTYrFcNRqVUV0h3BAV2opVMHlDEi3fcVmilGb6RF5AQ8seQey0aSBk0vtLS+yLbT2XdBJIwMkIYKnM3QsoycFa37s2m4lD/217rd+9EuiNJZRum1tMHP0y+ZZ5GmSLdcUrPHReFJauYbqY18j1tXW2oZc7f5IdchgdwTVqcaqUJIiUVBIaXvLGzoDHBHpMg099fVzhJi/ieN6Zmx8lbH9/yoWQ5jV8BMU2i4dnZuIv/CpObtyoc0lRS9AzZOw/Ud98c+wQ1KVz1hCU4ndwr2QMJeTNoDYGHv37+vBdQLE0Y3+Ji9NJ+kyxlcJq5xmw0BbrlZy2GjGGZnnsTiiPLQYrUGo0G0uOkO4hwdKnlc0XuDXSbGbgiqB6KjBC3xP/vBvV9VsTTWl7lfuJah7ehcgAwo+debOfC9i5O4oizP0TPWJp+23VdO1ZMt0S77KlOG1cFFXv1kwe/K2VbQfkWP5I6uilmSKzuAk3HrThBuVC5XpXJX6gzILp03XKsMCNKMrpm6VXvtpI+M9B7e/LqIREMgdf8KElpXUZWzFjVgTRs6Vu63Tn7VeAwF/SB70GA/bvSawnGeQow6q6k08SbERx/Px2eTq8n08opWXn+a/mP8cXp58a/c88up8TMHRHNvgPFlaUAVICRyF3iOme9USz2+XDhDVnnuZ+nWjs10BhOx3ShZtsrts3pziHFiwtjV+6G8FmieWlGDIgXTm8fhT1qK1UpXA2WZC3s4dDrDdmdoD4bd5twZdBbdAbe6zZZVSw9W6W2mM5p/gzha3WvVrUHdal03h6fN3mmn1ei1W/826T7Fpduy+ZXSRHsg1G7OFzqpUNrBKRcWihvTa2+bHVwZM49HqA3ytShZr4Mw/itYxRgfNTQ+i4LAp93uaUBvJKaJMX1ht7otbs+dTqvT7XYGc/jtgEVpdwb2vN/NGHMFDb+lfatXsrvCGRK1aczcjJ2yTjKlyKTS4l15SUlOHtg8zkVvOOi2xGAhBnPMIXUGogtGsNu3MxppXUjPoF4f2r46JI331lUaSWXVwoR882iwLovoLTLyV+WOI/lq634fRcTj7l8WclPObpPlvFjKx2WJNAUwJV3OULZhVW8GlK+37z6VPK7YEqrkZduGTS1OpVXz/ELxo/6iZOaOFaYsG4h5X/Q63aEQTrfV6XN7MB8OeHchnEFzIVr9RSZjM4HCjw5D5nm2W4p+vTUgSzE87VgNq919rqUAJC6jBk2B3AVzMBjPMxgqzvgV7UVKsFr4K4O+ND9N+CibYT53PXpRyxbVJilDshSd/K3Cv9pfpcC8xFGespfva7JBEb6vHR3VCssMylKVc/G3OzOSvwcjV1xXeaKx20epCkYw3Zz/R7WBEomTBFdYwuGi05zbvaHo805r2JwPHWH12lZ72HOstuVkyjM6Z6qpHWCpDfbvtN1rDLr9p5lAaJ1BL1Iwtpq5Nwcrt4+VM2b9+bYut7nkVmeiO32r74g5p8AUwDZQ0hHdbm8ocxh/XCRVIerPxlKFIz9/UGMyy0/dc+xJasJxclQuGZv/ZezKI62XrYps4E9oVJQS/AYB0betqyW/MJ92w6R04eq2Nm92nZ41XNhde9Bpd+aDHoD+brfVbnYXDh8sMPugUFWFUOGjh9/aNj0q2E/UgIKJKp0+3N9MKRH9ndgpmVzsVF1Kc+a5uFGd9qCzOtj37ASdeU5gHji04TndwP6Mu2nyWWF56PcscPbIsb6COaovEaADhXITvw0V8QTiF5cy7ytMYMsmc5v986sRwIlGk/3IHTZT4ztTg8EMcsjtz9DWZI909Y3vQn2mqzA3O2NY0a3oCz4HdWt1Fr0O561Bp9nvgoPg7bY17A6HtFNCngPYvajxGk9OujZTp26AIWACI3VolTrff7vO4cjN4cjN//MjNwgnkmgPvXvrgfmp09DSF1+EUj6Kp6U1otnQ06Qskgq2qbIqlU6XVnx5jOKguwfdPeju04/L0cuZuvBCvSXo0yxDnxtfncpC51mCPvIiAzzJpQrJ1T45kbSoqSDS399dg2J/xn1BERNf1/p0zC+Ej6QrLxE/SudDPp/rbRva9WdzgQQSH9WlFmCJhHNKdGcU1zKU2C739ioI5y4IqF8BEfFuL7qAhNaYE9+nxG10zJxARP6L/OZysoDYq+/U6RqYA5I8IMmDNzp4oz+PNzogyYPuHnT3j6m7jyLJ/GYrhZOiZLXitOqMGzzle3l1HhRIr15jqcqlqwMmWsHGWIqxannkUJu3mvPmom+LjsM7Tq89XLTsXot3+81+c95p9Wumr7/N9DhVsrxOGfMt51EeMxQhnh5MfBCuKA4CJ5/+S3Bj3gLNGm2I1rgZeA4s/ZBhx04ZO14GMYwNGgbsGG5JL97MLrB96Frutwa+yfUmVFp5LaE6mSYi2iUovrpRfICOB+h4cD8H9/OncT8H6HjQ3YPu/jF190nQsbMLOnaeAB07DCHWAiHWbwkdHcAdCM0WMCl4Ikrde5peEWNeqYtqHS5FnAK9HIpsDcso8joIcGv7RoOlKJeJ9DN2oXmDsissG+qyUICrD6uom+tRqvA+M8CkeMWR565c0mMcELQbbuqjBd40JXVGy1vaS3pTGBoFL8DcawAy5sbpIapwQ3nQJZenQH8hoKovYHxOPpjNcMQXOGI2/moLgTqf5n+7VbsE8JBgiObiSs71lu0CMmfOfQgjxNe1NF8pBD1A9QNUP7j7g7v/c7j7A1Q/6O5Bd/+YuvsEqK7Q0HaoDgX2hupQtmGxFEu9ossz/68RO6mKokDe66q/dJRhcMIVIErqw5FoQ/Dzi6e1bd93qeG+aESGkqgkxL3id3G8jk5PTr7BXMEcPTT42k33i/vBPW4XP/nSrrA8uNFUapn6tgRGDqO3ExVqNIjDoUufrCAJpQ4kv9WVpLUI+E47DB5tX19HssGzNrKZY7wCRgkUPcZtyxBNpBcDyTuYC2OEsd2E3sOu8fzUfmwcspEt46hi36N9QXkGVBaGp8676290XiHslr2XvtSZuRJM+Jev1p9isRb7UfCQvnSDe2Be/v3d9ZHxWY8kQpyr7z9hb0FEyJiN9H4QrET+JQySpfyI2Ci34waVhy08GDB7718JwW7VecHNJVj5GZhlYilWEmQJsNaHl3pmHLy/Hh1gI+MkCp7r+CfAoROeq3dEzo6iAuOMf+O9X2fndN2gq+8S058KwyCP3a71uLgxru8l4r90a3XZWp1ai44KVEjW3tpyB7cNGoxNcC8ibn1357K9utEehlDwBFst0oCcUHTk90nZeta+m45ce3VsL0/He/8d3WWdr8ak4dIX3k3wzqYgEv/NGIoOqsHtMgEt+m6y6ALtOmlEvWUZJNVll3W3DriQ6LsAxfClMPE5+mWCJYHMkJBKfqKZBZ1X1wflxkyPb/FGKSjpBHb03TRjh3XssC5tQKToVx/cAmJBt3EMZAekAJxl80+WQBFq2DzZVqVVp+ZPqA66BrxWSV7JvD6VP04zA6evF6cXWDotAyYYYXW6cwyvG1FtoYvKMUsnBIocLNPrBeAZC3yT9KbLmugtf2/jxRGPsrwJ3r/zS1vpLZbk92N3fyOLd7A0f0ZLo4Cuq68oUBGBKeQSrZWzeBFd3gn/D2/VTY6AqCFeyb58azaDQBllWn7m784VFP+vBY8R+R3r7+qCHgLcReXXFyEs6VRjCARzT16FsGmwdxBg+TawGIMr+oBgwH4OVJSVHQk81xOH166tEh/vKwQikhV+rnfX7DpuZCfSCEGs5Qs9soBgXFpLayQdVAdW0NW5IlxF0wUmiiEGNSZxR18wh5HKEgMjcUbUAb9sIDM8EUcnBo8L8HtX2yA59TvhrekzRUAWBGtGD28m16UWoTFfLU0E4fJEVYpOsCw0gqGOFIZ2A4I6fLQO8Eisb7T7WuDVcFXfsS7c5ZemxmuvRAyA3PzSbfY5vPlGXYGq7D0C9ZM1ppew+0QGDjJQu62VAzWoeIr3JB7X7oBSLPPtG2YhMGx5MA563n7IohKK5oCJ+cOJW6l/qc/SHqkPh0R0k1dpKOllrpUj0ek0f5NF0jX487PAAByG8IDH6WWGhAiUL2QOxahSWmXAuCeNa1+PcdL5Fheq/sBLQB4e/hfV/6oJ +sidebar_class_name: "get api-method" +info_path: docs/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 Template' (get-campaign-template)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get a Campaign Template

+ + + + + +Fetches a campaign template by ID. + +## Request + +

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
    alerts object[]
    + +A list of errors and warnings that have accumulated. + +
  • Array [
    • localizations object[]
  • Array [
  • ]
  • ]
    • 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. + +
  • Array [
  • ]
    • 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 objectrequired
    + +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. + +
    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). + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-campaign.api.mdx b/docs/api/v3/get-campaign.api.mdx new file mode 100644 index 000000000..cf477a3a5 --- /dev/null +++ b/docs/api/v3/get-campaign.api.mdx @@ -0,0 +1,99 @@ +--- +id: get-campaign +sidebar_label: Get a campaign +hide_title: true +hide_table_of_contents: true +api: eJztXG1z2zYS/isY3Ye8jCVLlCzFvg83qqzk1HGsnCw3M3UzDUSCEhoKUAnSjurxf7/dBfgmyYmdZtomo5lMLJLAYnexL8+CAG9reiVinkitRkHtpDYXyYAvV1zOVe2glvC5qZ1c1QYiTmQofWrHsgam9u6gFgjjx3KFD6D7RCSxFNfCMKlCHS9tB/jFuGLiozSJVHPmOwIsNXiZLER+64lho9MG66fJQsfyDxHAkygSsWHL1CRsJhhnsbiW4kbERDdZSJP3PsBhxpNXv/ZPX4/ODxiOywbDydTeaIBIRvhpLJM1iHVbuzQiHmiViI8Jjgj33t2BTCse86VIYFRqJVGyFYfnBzUFD+BKBkjKX4glr53c1pL1Cu8aEF7Na3cHtVj8nspYgEaTOBWbWpqCwKNTpsOK6CzRKF/sVIgjiI/wLELSnn/cetF8cdRrzfzQD180W72W77VFZ9bxvFbo15DvWJiVVkYY5MlrNvFPdeR+MZqe/Sb8BAbxUQEqwcZ8tYrcLB/+ZrDH7baUecdEJsTbRSSXrGQ1hfBXVl9V+Q8sIdRzjMaXSMsw6HRLlUiMB2MVrXdrchRsanFTa83e8czrNbnX7fIuaA1+9XrHoT9rNps9nCo7o5uKmpYnBps02Ci0xmblZ/AL7CTB8TlLBIzIE3HAzEr4kkfMWj+ZO2lVmH8zIwTx+v4wI13POprDWxncHc6FQm8U75lQwUpLlbBA++kS5qdwpUAkXEamkWmypK1C9Ndc8Tn4SD4vdxu621b1JzRQevTPVEQh+PBaxGutBFNCBCZ3KgoZAZutcWAZs6XVj1ULDyKpxC6dWO7hTgDM1BO5Zc1VRUH48jUyQjxmhBuMTVFhSCOPY1KRCsI0SWO60nEA8wX8cj+R19i0bNdAA/S+1ilL4nWlFS+m6UYmC7jOxiXf0AFfYyB04624SQ6Izo2MIlCML+Q1Euk0m0zEMbTMwkhVr17Ta9ab7XrraNpqnjThX6vROer+jBq0WnuIRWELZKsQa6DTKECFQBCGuYY5qmiGmFDpEoPJ6/55/9VwAncuxpeTwfDX8dtzeznsTwb/hR+T8dnw18H49ZvxxWg6Gp9jlCn5hOsPHENIk9G5LrLaUPFZJMohaKZ1JLjaEsO2NIxIMFWisZ2QqHPI0whMKOSRESV26BpY4WmiJ+JafxD9KNI3D+KBWhqGXdG2oe+XjQ3Tr5fgVAHxbx6vhFF/tD0y5G/fF6sEvA9iNoNkppi0YRrbQ9gPUggcoeDW9iGUhCHFFXwMl3BbCQzt1EnlhA3L4kLAwlgv7bBZ6LAWLVWA0wEKQRkbDK0OkkjErnmUujZE1OZaO5LMhwZmY4g5pAcnGRhsPN+2ynuVi0KDbg1EqtQ8LtBi/EjjGKIcs90bO1Jg5g5vhueno/NXaP9TsOtT+DHonw+GZ/ZmfzAd/dSfli6G2AKc42zo7roL6jqcTMboS+hJ0PS06jqu/x3CBeAP1R1cPEbAjV6babvBUEJW9uvSrPucputSFWTAxlTlBvMrILXAOUhXKj9KgatqDxmAoiXiD/YUqLnLNZpBWmkXMpmwBTfg7RB3fZ0qsG0YBNjiFqliVoIwanQa++JZOWgNxpPJ8KxvlXx5XrqsKLh0H5UMc56IBwGiB2SogaXG8OGn8ZKL8c321PNOWkcnrXaj22rZGK8THlUKgfLUQ4IWmE5L/MCttrc7CSApBvqZga9hMqhQtZ5WDie7fCDjudVsklFS0hXB12GwxFpG+E8yiXEeypikzBKPY77eDu0sgjIJx6ZsDEFeBeyGxwqmH2LdgqMlYsb2AQ6l1hd2jC0hKppdqL0KuiOId9EuM8vMNwsLb/uTc/gzOn853i77TgWkQWHIsIhiZmVLYQzArCpAI4qgkEhDbSf/2JqqTC8PFQHJPBB+2LZ5XHfsMSwAoXZkPwzesE6PRVzNU7rP51UQJFT98gLLwDSKMEXkwd4SHsdyLndi60ydp8OX/cuzKUKV4f8uhxfwC2ltaRTDkU1kmuxwoW+sdq0ANxCLjIhAHRgJnzuqz0Egrky5obRXZm1AmcylLOjhRt/Ro0w6S7KYKX9PBZilb6tl9lQ2ROMAgjLcA2/yF2zGDaZsmyWfWwBQP3OafM4WYJ8ifgZhOwgkCpllZKjsAaBiYR9sgT8CtDpNCGX5G4C0UGV1NorC9Kw8KRjCgPPP20nfT1JgjsR0ZmxxcWYtjsUMaAROc1XupiWlkUrXULkAZMfljLVNhwCBZiCbTAxzNThOlwFcqbJ2UoGOJDj43V0h1hC5eW2ZOU00PCs9zOq9PkYbfHSXc0Xe4upC/EnqzyrvbIWh22sdC+E3e7jCwHui3T464u1ukxeLH1lpOaGiakcAs9UWhTBXjAGugXgFLG8VYBZJZQWYzUAtr+4dTZtdqjKajZbX/rmodYsiIANYBbi5H9U7jLYDa7sn9yFhi5RBiReCx/5iW289AWpqt0Q7nL3oHPnhTBy9aLW8Ge90e20hOoXeLIXySklVcRvP2UiFeks7Xr3Zq3vdKSTnjnfS6ZQ0k1dBf7FiCPOw8Y16rFl1QE2FevqnzJF6gGFBQwYdLN56tA1tlI+5vnIcfb++bIT5QnXtQs8V5AfqnEDBNQDUoY3MFmqqGm3PPOGBkXkt8QI02Jt1g+5xO+i0/E6z67VLGkVSrETrftPLVRvgygn4KGcxdtY4qQ9Qb6f7oqTerSr8rzVJG/Q6u9Y/B5HEMEsRlNXB0Ir6r5zlZjqgKiAPv39ilbQKVuyS1UAHDwAsL0Hf9XnMJXJoU5APHbF+vpYBLqgtNeRIS7KSqqqpqIP2z37gAchr5Rs4YTBvxNz/ALRGO4uNKkOXSkJ/lnWBgilHUjuGFT3BZ93msdcJux3OPTDW3tHsOOTtdvP46PgYR3cp9fOo+BXW/dJnDjOCQgDwGrfkQoPvAeMeMO4B4wMBI8QznpoH+N2bCMJPnUTLH1wL53y0um6jEc1GNk0uIsFDFJs6u1b5dGWOz0IpomDvu3vf3fvu44s9ejhxr2vcU4I+rW3oc6l48VJ9C/rYZXhc3nSN7CqqnUh6ke4g0o9vp+DYH3BF3zDxcYUver8iPrKpfMd762w+7P1Ztm8gS/3FXCCDpEf3SgYikQhOiO+C41qBEtvbo73U8UyCgaodEBGiZkyvzzioLE6Voheb5gCQszDqSbE4h8UuRUAcVQV1eom5R5J7JLnPRvts9P1koz2S3Pvu3ne/Td/9JJKsvjZwOMmkyyWP19bS3HO78Qsa5BuHir2F+cplGa0gMZZjrFoVOdRmXmvWCnu+6AS8E3Tbx6Hndz1+1Gv1WrOO16uVc/1V4ce5k1V9qjTfdh5JxQDicJ9HqsC4TKJ1UF3+A/XGIsSwRjutMtwMOgeVviuwY2cbO57rBGQDwoAd43uWFy8nZ0gfd7UiedSbXfhGp7Wb6ug9L0JKtGG7c3YPHffQcZ9+9unnu0k/e+i49929736bvvso6Nj5HHTsPAI6dhhCrBAh1t8JHQPAHQjNQpgU3ILvdu3GYgWiVE4pUPjh8VwkOdCroEjveMfxE63Za67WGVgylZVIVagLwxu0XWLbOGsLDTibS9x2DVFLantIBjd/AibFrdGRXEryYxQIz2yt6/0wAamsz2T2lo+Sb5/FoBBpXHvVYGMSDzKECP+AAq2DziFQf8U1zmz74J9ZD2YTlPgMJWbDj74Q6PP5+u/Rrl0CI2A+xnBxYef6nu0Cds2cKygjxMeVDV85BN1D9T1U36f7fbr/PtL9HqrvfXfvu9+m7z4Cqjs0dD9UhwYPhurQttFkOZZ6SYfl/mrETq7iOCDzZtonrB4UGJxwBZiS+/4BxhA87H9Sy08n20PJNfx6AAJCy0saR9BmkSQrc3J4eAtTBFNz1+Ar2chOkil90/D18vC6vSPg4P5S61zuQCQWDP03I1dhNEixsaRzlmSYNIBVszt5WDOgbtpY8En6uB0Y52+Nu6YtmQM8ievsiG7jQScoIp4Ye9qd7GZLRpDtMo7uPifPT+1PyWGJ3CPHLvV9cixoz4DLDfGQ/XfFxx4uEG3b0bc++VBkEFzn3z4PNsZmHvtB8JiOZ+PWl6c/vp0+K51Ftd+xEBKLAvCSN2AiFMP62TYQ7ERpJdbpfEGM9ysbbdBnWBiBwOwXdSEEuxo5JZxDcJ9ANCaVYidBAQB7vXuazUyAh64w7zUKTaLhyUAdgoYOeaXfM8pxVAyUPtPR+EXV2anE0EMn3LCNE5FqO3a1yuTiJbm+lIl/ZdTqllqdqJlnG1xY1V75duO2D46LJHhkSFtfPLilVy/Rw8oJ7iDVTR5QE46P6vYoP5u1L+ajQq+O9Kp8/KLeLiQk0Go3ZuMVMws6PD9i/kJrI/7DGJoOusHVPAUv+mK2bnDQOnlE3WuWWKrbIeuyDnCQ+DsDx1DWmPgM0zGhEW0XRsgl39PMgs+/p7OM7ysy0+0r/PwBtAy0b76YZxywjgPWbQwwjn/3lQhgFnwbZaA4YA1gUMw/RQLHaCnmWVo7ozqRP6Q+mBp8YJWomNWJvTgpApz7xegBts7bQAhGNJ1vGINr5mjd2a8DFMrK1gE2NbjNb6QhIW7ozfKbv83EJPlPkxcl7hfLJXig9WtH6XsiyT8n7v5NEW8fab7HSOPwLZobDesKgbKRW7S2vXhn6AM08D88JU8lIA1liv3MDGKYMhn8BAfatP02zQI/YYWr4YIniPwO6FslS/JDgLvo/FDcEaE5fZ0gBoY5FGoyAnoN9hbqKuWDirGmoq/eaPabdsXVBWj5DX0T6DSbODzmtkwVfr0BmEiXDI/Jf2Z2A2n81AYhKLGUyCTTBOPyXplH0pFDUAV9d0nESzMOcX0YSs/SJH5mLJhD4xaHQZE4I+6oXiHIBI8H0on4gw34/TnaYDn1hYhWdLYe2IIarTTC69F0iyIQU+6NhI7nh66TOcS2QARLHWsM7QbUcnhrpU0CJWiJ7iuRlD5BtGlGt8VC+DfwcTiXY7A4OFzhShaKnNpixdaEV7W8JoT2JzLAjyEsQCn46PYW1zmwQrrD21DfYxF99a4ogKhwhPmqnnS8V2NPJ+5Tas/oTc2Dvhm3U4ZszU6ti3K9Bj8/CKzyQQqohUEOWoYhHu0Du1BT6rL1KgOrrLx4fjVEE+P3JGz3A7+xd3f3f/en3XQ= +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

+ +A campaign object + +
Schema
    alerts object[]
    + +A list of errors and warnings that have accumulated. + +
  • Array [
    • localizations object[]
  • Array [
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-certification-task.api.mdx b/docs/api/v3/get-certification-task.api.mdx new file mode 100644 index 000000000..fec48bbec --- /dev/null +++ b/docs/api/v3/get-certification-task.api.mdx @@ -0,0 +1,103 @@ +--- +id: get-certification-task +sidebar_label: Certification Task by ID +hide_title: true +hide_table_of_contents: true +api: eJztXG1z2rgW/isa3w/bdmLCW0Lgyx2W0F52kiZLyHbmpp2usAWoNZJXspOymfz3e44kGxvIW7dzd9vxl5bI0tF5P88RMreejJmiCZdiFHo9b86SAVMJn/HADE6o/uzteQmda6935ZWeae/DnhcyHSge49+wfLLgmvTPR0SxJFVCk2TBSFBcRBKgSGZSmUc6ZgE8YiEZHddInyTyMxPkhicLcjZ+87F/fDp6S2DuYDieuL9omiyk4smKwFaK/ZFyBcsTSQIaRUDUMlAjY3bN2Q1TesdmZY4CKgiN9CYFEFuzIMWtQPRb71IzNZAiYV+SPvCA6uCh6JVo9RSjoffhDhQTU0WXLAEGzGqO6okprNvzBDyAv3iIWwQLtqRe79ZLVjGO6kRxMffu9rxMOK+XqJRtq5pZXY6OgQz7QpdxhOsPW9NWs3HQ8JuHQd1vN2dtv9vsdv2jo+5RGDSCbkiphwwqpmMwItO4ebNex//KW/R3mA72ClAJIsH5NI4j93T/k8ZFt9sSyeknFiSwMFbobAm3W4L4W1LvEnJ0TOTsHkeqlURvBt3GUf3osNPoMhbUO/VGp0E7rNU6OKCtwzpFpdr9nrIvznhgZ3IqFSPXNEqZJku6IlNGaBiCd3Fh1sxSCAFmOBTpEt1lPOxfXIzevIUh48sfCwODs9Pzk+Fk+BFdffR6NOhPRmf44PXo7ejiP1vD6/n90/O+IzqYjH7rl8eyjx8HsNlkWBw5HiIBDOK1Cjf4QoVRBUlh8my18YQtQQ80wTidMphObKoBDYEOpysbacaFbxZSG0PDgE6kWivR7j4KCcRtFBaVuaWQTOaSPPloLsno2W5nJHlYgqf74VGrHSAzOqFJqp/Gip2bsZPv5xTx6+Xwcog5AAx3Pj57Mx5eXMBfF5eDgf00HI/PxmW1uDXAB1NKqiIfVCm6glUotX48iiMJWfOJrmHn5vl4ybSmcxAIMuoeoeTnwTlpd0hExTw143Re1isT/iUKJNIoolMcwsQIQljCZ4rPudjFSqaq4+Hr/uXJBEbGQ1DBBXxCWltlrC/A/0IMd2AV1L6QN4ZjJ8ANBTdlEaiDhTXyylF9BQJRV/LcRG7/0iuNLhSyGU2jBFa43XesKJImMyWX5iFWAqYTEtjyQ17wGqvtgU/C2JImwYJMqbZeidNf9YOAxYl/4jT5iiygLDH1EkpsGHIUkkaPpy5Th2WaECETHrCyLdaqLFsDwownZsZJ0SgYfsD5437SD5IUmDNiOoc3Lpp7i2PR2Qd4tporczcpKM2odCUSGoAUUOFXoEalQMNkCrLxRBNX0Ez2gdIlsnlcgI44ZJ27u7VYQ+Tm1DJznEjv/kcnXCfb8pEIhlE0G3k2RS7oNQMrAPZhIpApsIM50GSYLOANIKBa87lYArMTRXl0PDnT22V7XJhGEpzndonACxApgYPNNkoaD2EyIp29r8wDsQK8JVN9diOYek6GzRYSiStzRjYif9Y6mnXbrXaHddsHh83pwXR61G626cFhq9sJj1A7gt08e3NY8xf2pa0tqzy7TBZXl/fuX07OTqG6DfJyfDp8Oyn54niHQ5iknhHZssvjmiwq8nH5d4l/L+cPM27CBeYEQDFhT6zSIUwlVIBb8yXD/Hez4JAOC9ACot9RRPVC7YGECYtxoY+LypW73qz79a7fbE8aR71Gvdfu1A67rf+WtL7dIN3d4fP2Lgw9iDiGoUkNxIeuBPsizLSzUmafytA0NHnK+WYwO2QJ6Hcgwyc45msumD8HeyCHNu0GsBBiVF7zEAHQEkGvJVlKz2XXBU3UGuRnyDZjJ9/ACYNqVDT4DLSeAsQuBYf1JFsCUZqjhx3bsg6j08N6t9meHbYpbR61G52DaXdGW61696Dbxd1dGdmFeMpbv2EQAjyw5YX/CQpBTwcPQwbM5hVIqkBSBZKeBpIwr9NUPyHuziNIP74RLX9wzVzwaYQvNhsZa2RmchkJHhrAhIvdrNxcWeDbTrKK3Sp2q9h9YuxuPhy7k0P31ECfxjb0uRTurBaL5xb0UcZ7hMwOdP+0jYg15B4e+jqI9Mu7iTsXhvnsS4xHot8QH9lSvuPsM7OHHZ8i/MiNVbIFMmj0aCWYQSZiYc/wvebYKMqqqrW922upphwcVOyAiJA1FVnJlFBQmUqFQE6o3iOhZFr85JpHChGhtc2AuKsI/Vhy21NUSLJCklU1qqrRj1GNKiRZxW4Vu99n7D6IJHOuTLQ4nKTT5ZKqlfU09xylpQQmkOw7bJKHnDHVJlpBYiTHWF4ZOXjTZmPamHUC1g5pOzxsdWfN4LBJDzqNTmPabna8Yq2/WsdxHmTlmCrY29rRfofH1DXguFSAc+lEyrB8/AfqVWyGaQ1TT46bQeeg0g9r7Njexo5vZQKyAWHAjuqe48XL8QnSx9sQSB71JlMVMITZVnX2GwKElOjDoGn75UUFHSvoWJWfqvz8GOWngo5V7Fax+33G7rOgY/sx6Nh+BnRsE4RYM4RYfyd0DAF3IDSbgVFAhiAF9QqEjTGIAp/c6aMLe3vZLQd6JRTZ7G6jyImU5JSKVQaWdOkkUqzVhekN5i5xrsrmwgRK5pAiBYGsxQHdolfhV/KASfEr+ogvuYljFAjoqpXfnyUglY2ZzN/yXbgIohQ4NEkhknj2KsHHOLgTmyH8AwrmHHQOifobnnE6a/2l82AyRolPUGIy/BIwhjGfn/8e7LolMMIbP5guLqyt77kuYM/MqYA2gn2JbfrKIWgF1SuoXpX7qtz/GOW+gupV7Fax+33G7jOgukND90N1mPBkqA5za3WSY6nX6Fz/d8RuQsVxYNybyMBg9XCNwQ2uAFdyb9xhDsE3w3refulWto83WPX+LQ/vPHwZDaGh5SpVEcxeJEmse/v7t2AsMNJdjca8ll1kFvKmFsjl/nVrR+rBm6Y2zCB5hWlgWgd8b89uUjMqVhy92KY8s4FVuBEK/RUUb64YPEgf33VDS66gDSGWzB5efnYeZYaBzRjaiZ+0mV0zHrQlI8h2qaK7x+T5rfWQHJbIPXLsUt+De8F8AlxuiIfsf1i/O3iBuNvuvvUG4bqW4Il/c2uzM5zWJD8zqqApsJdgXvzybvKSzBFtmmhPNQJdxrE9gHg5Bxcx2ayfXQjBRabAKJnOF4bxfunKDUYPmUUgMHkvLhgjVyOnhLeQ5seQl41KcREzqQBXfXiRWSZk1yzCClhbaxIdj4diHzS0T0vrXppqZ9oCLuxtbBitvRc+OeaYhPDFUjPHiWi6PHIVZ3LRglxfy8S/Mmq+peYbavrlBhdWtVeBvcIdQAgjCRppo62v3tzS8wv0sIeCEaS6yQNqwvFRvigVZFb7aj5K9HykV+bjvXhnLtOXlxGbuYiGShiFZESChZSa/ZsQdB0Mg6t5ClH01WyZG/y+iQi/WS+w5Nstfe4DMDT8nUBgCOtMdIqF2eASaY9ITEj+biwLMf+7eUvg95LMZvgK6ifODGWgv5pn3NDHDX2bA7Tj35YndCyIbZTB5AHrAIO1/U0mcIwWcp6ltTOrG/L7Zg2WhgBYNVR03LN/9NYJzn0i5gHOzudACkZcnV8dw/efHS2sUSVlZScCmxrc5jeSUBo39Gb5zb/XxHL5T5MXJe6vD07ORLT61ln6nkzyz8m7f1PGqzLNj5hpHNJFdzPbupag6OQWrW0f4+E584LBv/DURKqB1NCw2N+GQAxTJBNHNEGfNjEdLDgzBwAxowkivz30K7k0cQhwF4Mf2jxDaG7eDFPAMIWWjUf4AiB5x+xbmAq7K7x4C1Q/SddmXYCWz9FI5DgzHACo5TIV+JMUwES6JPhC5yPWDbkOUpuEoNkSLJNMGhiXr8oiEt0GVVEzfYZa6rMZnhRDE1ow4iN7gQ21OyYGRaJF3O9QrAUZs8j9ssfeBvx+jDZ4jr9gUYz9HWRQAFOssMPpaLJFEYgJ992EVPN9t0jv41wggq2OdYZWDbo6HIqlTqAZLdAtvYlH8FU8fGfW/CBGyaFu14fjP9pPlLjShD3FfoxHYaip1PY4tqm88nY0lbCyx0P8UYAFaBUn3d7ikQm2WHc4/EfKsB+/+rDuoEznCQbHz9C5zoChzV8lKSr6xdhJ/tJ86bP+rZKdLGdnfGK1bu89+PiZ4akAsAq9MzBrjm0MI/aBPdgpLNn66gN7sbzZfjNER6T3lHX3AYSGxPU/LLig7Q== +sidebar_class_name: "get api-method" +info_path: docs/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 'Certification Task by ID' (get-certification-task)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Certification Task by ID

+ + + + + +This API returns the certification task for the specified ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for the specified certification can also call this API. + +## Request + +

Path Parameters

+ +A certification task + +
Schema
    errors object[]
    + +A list of errors that have been encountered by the task. + +
  • Array [
  • ]
    • reassignmentTrailDTOs object[]
    + +Reassignment trails that lead to self certification identity + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-completed-work-items.api.mdx b/docs/api/v3/get-completed-work-items.api.mdx new file mode 100644 index 000000000..240479d52 --- /dev/null +++ b/docs/api/v3/get-completed-work-items.api.mdx @@ -0,0 +1,95 @@ +--- +id: get-completed-work-items +sidebar_label: Completed Work Items +hide_title: true +hide_table_of_contents: true +api: eJztHGlTGzn2r6i8H5JQtLGNHY6qrV0PkFlShLBgJlPLpGrkbrWtSVvq6QPwpvjv+96T+nK3wSapyWTW+UDstvT07ktSf27pUEQ8kVqdeq3D1kQkR3oWBiIR3gcdfTpNxCxubbcSPolbhzctfMbMw4/bLU/EbiRDnA1zR1MZMwAQM85cHQTCxR+Y9uGbBcnucL7E+WwsAq0mUk1YopmQyVREDP6wOBSu9CUMTmMRveTeTCoWid9TGQnv1TbTZpibRpFQCQ1qA4Yhj/gM1ogQz88tiRj9nopoDr8p+AW+6jslIiBzuxW7UzHjrcPPrWQe4k9xEgEmrYc6TYJJD2nANQlA9iUnhQUyToAcJAXxFDFQ2mbsxNDEFSMacswBCgzdKRPAZimAmPFPAkYAFy0YpCujvHXo8yAW2y1xz5GbgFy31+2OXc534f/e2BX+626vx71xrwufu9wFcpoZEciZTFqLtL7j90yls7EhMRJxGoAsQTiRSNJItX9RV0Kwm5922fDilF0lXHk88thRIeqLXAYfX06TJIwPd3Y8cQuCBiVrx1wGoZYqaYM+7EhP7fBQ7sQWjlOojFPI8hXzgWszHYEYFHyckao+zpfeoNMgYVhXTEQEMw0Y82i3Bw9AOHKWzlqHMG/G781nguIJnwMX6NvDMm5q349FnZ3v6TGgDRxEsftpEFiuMvihza7jlAfBvKTwd6AxbIuks4WMDznYB09QKSKdTqYExwrmuxHHFwgjZ/9y5rs6VXXen/psK4lSsQUGClwFxoc6TAPDSsG2fnZGOuGBc4Szt5CloVaxYFPBPVB/kgMObDCHKQeIOg08sHhrGSA56edyA/6xLaMTW+xOIKsmCjjmgcRAZlK5IrNv9BgcBA2oMCKEueAtpvxWwGOQETEHx8tZyN1kG6kh7wASmwnlwcJKJ6gpscBVtwjI34nyLcSJsL3lQSoMF3A0oA0ux2LzXWgQ0tOgRGOtA8FVq6QnNPPh4SNCMyKNcUKv08H/qjpyhl57SXBCfFwNSgq6BRN5GAbSJUx3fotx9uc6OjyKOComASg91+PfgAsYoSLkWiINTtKrh5+aGh/Xgk2rHAB67kF3v7O/O/B6YtB9vd/pDrzdnr9/0HF5d7DfxXiWRSQMfGssmE9bb0GwS3BzfJyJrYzAsYzDgM/PyXCfwgQDr2cmoKU/jtZbPVXsCqxv2oRAFvZXWrPgAE37YuoJyuokl2mtI/CWg/JZQgG2GwnwaI2E5W7VgxFOImH9CiWd7p7T2XO63VF3/7A/ONzda3cO9v9TxwlmsrupUAspzx2PWbY8YDLTHkWw56Gy73ReO73BqNc57PUOe/vtbqe/HioBB1tOQ4/waZBCBdJKqlc8edwEj4gJjLvGf8PwWKcRuOwXw+MXyBpwh0mj8IXCKHfTegMBL54S3pcCXYX9aCILfDy5D8kvbrcuwMubyUcYFgJ4+LGMTAlUnSRCBInhFVISmdDcLNu/wmHvuILcpCgAgA6D/nIyfhSgrdJF3NDJ+dZfEikz4cns2zGgPcm+DENwihCf4ONPUgf0+FLcSnEHT96A4iDRGnzvHH/W2bSjKSROQk1Qk04pNA4VD+axxFLlCsOt7yPjbgXlBoaaoWtnj8CBVPlW4F5nG9LbpAKLfBvBuAa2RQXxpwuBIQsYVW39qgGk6tHcBcGsF0gSHkFxt74frazKDJRnLv48P/okAr9B+GjHmVc1A54brNZbGTIIGQw9D7IV0pZSovE8WsuZinFElfXQBiC5PAZ/4iYa8mhcMwHQ4zQRz1wxm24rYEszOaFi4XCqlTinbLqy5vus+7DawnmzopnDWlVRqqBgwkNl9Z8wM15tZZNEr0XzoNtzBoOBA2V6D5eFSg6Yf+qBU5LJfFVOk8CknZQh0KTEmBsYLYbVHgoHdVn1QMciAZ2L662OoeljUK2TzzDpsFVNctXfyItlyxNCL2LwL2v7EBujV1zPBvRI+FDCQbCFem+emViByTI/0pCDlEzzD7FrtbI55+oMfKVZS11UU4K7ngWX1yqmNtvp7ermWQZrppVB8n+OsURtQj9PzyCjeO9T63BponZ6fnr1rxNUvMuTtydHI/txdH15Th9Pfr44vaRPFyfnx6fnP2KqMjw/OjnDh7h0NVsr4H1ZtkZ9vgXKPpZdwLBkuyvYv+nPUu9ACVD8RGPTwOi9yfdX160iT69p1tCamEmhm4STl+bPrSu6Had7MOruHvYPsMTZ3R801BXoT7G2wMbOVLrThfqiQKIBQ1CNRYf4SG+rwcbzBpNhulTLa43uQQMCuEaj+n6VtoNvUvAvK4FXU5bzkrerLWtV5UpkjSlbG9TWshq/imbiIsyMb9LKYi1sWGGHoX2syS3F6XjdZbIp7cpSF4HgMZg6rcT8SM8s9UGg7+x2hIn01zEo1NpBg3YWyIzjadaxhE93ymwy1Lj8liuRE2mIb4r0SyP7qjq4vkKguE8Xw+0bKQKvW8l1snGFk3sKF1AfETyNzBkOy7CxvKkgc2WVhTIN36KxBvdq7jhrT2Ykxe3iI7WJQZh2UUstdp53QFeJLxkHSjjeQEzA1mjGrOrsOgb297hilYvcLnO6FoJg8SjS0SpsKDbgCnwXAgi4JdN953F5zwS+YVvbB6v12vVdyaFitCZSYbAxUDTtv3nMSyPag6x43TKVpXIe/223+p1uvZt8rXiaTHUk/wswHXZZ2hjAXUCBfXulWTbIJNdmu4E2Bs049vbDCMLtJ6FwvDCNn+c0o5doOzGgjvyQzSC745Os7zXOOGLGV3wEIAiZhPQMBT4IX3iHhHeBseEUsWq3vhqozVh6UNHU+WRc1lynIDPBolQp2iKJt5mnRaxeJHZzxHUBX0Yba7iq8hyzD/H1OOWRXh9pbwVP9UYq4UwiLpEQYhkkDZ5gmC9JbNiZ/Q4DMrMmGleNB/1Op91lP3AP2EJtbnZkiUF1jLj7CWCt0oC5VhLms2wK7mD7dvO5YVmxJ/j4deeg1/df9znv7fe7e4Pxgc93dzsHg4MDavAa/Wiy5OrStpXGAu2ClqAxQHYX2yiaqdOKtSHBWDHMmrE5mZk+J+I+2YYc+oejC9bfYwFXk5Se88kCE5RzfdWUURjA7yM5kY0lTlYdHJ+8GV6fjagi+Pf1ydUoz/hr/kgqD9VSU94H8ZgwtgSQc6OEAM8QbFmoW0AQV3F5oDTf4nmMvtHugMEMu3rDjDLoItuwOyqM7OY+YS9lW7S3IbrQgYQE0uExJCle1lvZgvxIhIlzZjm5ZZ3YqzaDIlEikVAaUwkWw/w5VQ4e7lTa1NZPweIFbbHqNEHXLd2FvKhg5WJTIfPJZ2WhoHEA5k/rCVTJKSBHZJatMNcWi6KVD+BsOFfFblRiGrF0rhIOkdKlzXxXR1iDM6hFIZTEzLojFFcMjkdl46QiL9quhJoTxOadQeY40fSby9N4Bbu7CMD9OERa/sOtsMZHrtJ4I5JGJibrkewBBZpsR+Xiygyf+ZhVbGx3Y7sb213Rdhd/vLRHEujXHCuyFpsnxelsxqO50TT7u+kBwYDilEpucnmDrJytIDCW51itaubQGve6466/54q+x/ve690Dv+e+7vHBXnevO+739lrlWH9T2HFuZFWbKsnbyNE0r0R0C3kcJOQiihOtvYq2Insj4aNbQ9eT583Ac2DpxyJ37Ndzx3PI9N9gpg+5Y7SQO2bwry/PTNvWgEe+mS1ZNFpinakAMKWk0kHcQ621SR03qeMm/GzCz18m/GxSx43tbmz3+7TdtVLH/lOpY3+N1LHPzrNm6rdMHT1pjjb7IBS8TmLvSkQiBFLgE893ZorjEHmiV8kiewf1LHKkNXvH1TxLluJKJ1IV7EL3BmNnODbKxsIAzibgIhWe0ZbaXA/BHUTISXHXlg6Cox0jQQA3mjtDPwGq7PFyq2/5KlK5QQoYklPASzG47h2XeFbbx/QPIFAfdAKO+iv2OK20vqgfzC6R4jOkmJ3cu0Kgzef930HTwetTQD5Cd3FlZE0avqxnzhWUEeI+NO4rT0E3qfomVd+E+024/2uE+02qvrHdje1+n7a7Rqpus6HlqToMWDlVh7HtDstzqTd0Ae6PztjJVCwGpN5Mu+ZcRZGDU14BqmSvl6MP4ckUvuzgeQuHPM1O+ZCdKQEMRmkUwMjs6uFnEBQI6KHNQ9nOzkQrfUf3D293G9wOCNWaITguLzVndPC2o1mkTeyNJGqwcXe0gGG2vVPYyq85Pgo/O3g1hxKEGTDbeHnEahM9RiqhlLDHbNukPTUagbbrKHh4ih57a3MJHQbIEjqa2PfoWjCeAZYL5LXMcaJYgMTpQDvICw+qHRk/NUxRyjcfy2OuMC83GNZGFrEGdwTqxyXf47Ae+0HwCI+10SGZl28/jF6xCWaj5A3SGBNh+zIBzi5AjcjbDbMDIziJAlBxn3pYOZKD1sX8AJjC7PXY7MD+OYSBS/DbxHacJMhV4KzVL8fyyrwll2F/UY49yk3Hr3CMJdFcGL4JM7p4ia7nIvG3DJpjoDkELX61gIVh7Y0bSHSWLpg4guBBTNx69uIGnlOChzUWPEGoizggJywe1YNUbia1Z+NRgecgvCoev6gPdDa4Oo0Zz5adrzxl7lTrWPyDMVQdNJWbSQqW9my06ECyQxbh9DollByzpCMdSBwJvzMwDGWUiY8xcFPeok0Lhcz2V5Is+IVf6ZL6rxWa6fENxFcc6Wl3jRvfCzjjgg4u6Bg/EVv8TfhCxQLbRhrIDxgFOCrkT57AIlryiwZWo+cn8Ds0B8OHC6gSlDg8NF8OCydoPzH6AUfnY8BNY96dHy2D78zCwhhWYVbWMVjkYB3fQEPoXOCbwTff98Rw+mejFykeFo2V9yqYf20vvcST/Hn87jfyeBtP81f0NDYTRnWjZW3JUFZyk9HV23wxvbQE/sKvZKmUckNBU7ynpAwmDHhi7jaATbtTKahBEAqeYHa4jXqlZ2SHkBKj8UMZSIAmdA8nAoQ5lHQyAHht9gEqMOUCi7H6woO5APU3bcuwK+DyBQqJHWeCgwRqNksV3lUEJNIZ3qp5SrqejN3UOCEoxpTIKNOUxuWzMotEtUFWtKkOiWbxex87yVCkloT4xFogw9i2kYGRxaWEVkHIpTD30XFcNUV/CjZojjMVQYj1H3hQSKZEaYV3p6MaRACm7N6FjiY7dlK8g2PxIhwQb5Rhtw1VHz4KdZxAsVqCm7+3i5Ve0lV79UHeOP/Gr+uyUQTT/50Qu1pIVGpKFlMf3rSK+rBVvgsG9cQUqMcRnz9j6wPLpQd8bN4NhHUIiAK1vXiZzCNs+NZv+GpkxSeBDYLijWW2CdCiixarU/d9vdPrEU5kryx7Jh/+v17G9ZhGZS8reyYjN2/W+v7erPWIOmSvTyu04WPRSaLuDThbEh25VTPJNJhLs2pbsAglb/r9eAJB7OF/7GOwsA== +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Query Parameters

+ +List of completed work items. + +
Schema
  • Array [
    • remediationItems object[]nullable
    + +A list of remediation items + +
  • Array [
  • ]
    • approvalItems object[]nullable
    + +A list of items that need to be approved + +
  • Array [
  • ]
    • form object
    sections object[]
    + +Sections of the form + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-connector-correlation-config.api.mdx b/docs/api/v3/get-connector-correlation-config.api.mdx new file mode 100644 index 000000000..a515b790a --- /dev/null +++ b/docs/api/v3/get-connector-correlation-config.api.mdx @@ -0,0 +1,100 @@ +--- +id: get-connector-correlation-config +sidebar_label: getConnectorCorrelationConfig +hide_title: true +hide_table_of_contents: true +api: eJztW1lzEzsW/iuqngeW8pLFkIlfpkwIVG4FyGQZHkJqkLtlW9AtNZI6xDeV/z7fkeS2HTsEGGYuUM0DNOqjo7PrO7L6OnF8bJP+ebKnlRKp08YmF61El8JwJ7U6yJJ+Mhaufr2njRG5f4exkRwnrSQTNjWypDFQvxAunQjLOEtnkx5YPNfzaBwTWWWlGjPpLAvTmeKF6LxTA+b0R6HYZ+km7M3xy38Pnr86eM145SbaSDdl0jIjPlXSiAykLOV5ztwEo4Ojgw7kKbkBJycMaXadEFvIFRZ5Tf9pJZIkLbmbrIh/OhFsTsoueV4JpkdYQMwV6rATT0KsSRx6WSn5CaQyY2OhyHyQjrv5HJYa4fUnEWfyJ31nKtFKrJvmXkhZlDkJKK7KXGcYGvHcEgFsWvCkf524aekpnYH5PCX3c/oJP5mreHNzQavYUisrLM3b2tigf1a1/bKbsAIenFCOZvOyzGXq33evipyG7pLsBn9aSW/dqnu5BD+2bwzM0mbHwlVGwVwymJmMI6xjQ515Z0sFL8isc7coHyzxXSOLHn6AahQThmLayWCLTDgu8z1v4FWL3opnqUR7bLgkCYUXOcVEBo6XMqMQLrQRLLCcRYqn6yx5B5bobLJnPIO+Qb+9qAzM5AxPP4IX5dt9Ap2FQJtNoYgbQag7lhU7gg+fbuxu9UZPe5xv/b23ufNkuDvi29sbu092d2n1QljLx8E0cW1uDJ+uLP2SIlumLNdIOvknDIKYhu29AH5xyi0nCnu/DzyPr7A/hWigrdWM8jInrlwLhebZ3hHr7bCcq3Hlx/n4lhFU++wEI6rKcz6kIUo7aB4YvzFyLNXa5FJVQeXx+f6LwdnhKUaO9/95tn+CJ+J1cVvYgUK0ZhSWEBWxMNGfvcRRgc8cxU7kMIfIOuxx5PoYCnFlFwljTbFTC2Mitka8yh1mxNXXzFhkzUZGF0up5PPmyrGHsiM6LTaksYKjULMht5gAFxL540GaitK1D6MlH7OJ4JkwjzpskGWSlOR5qIkW86dgxHiWUeoGBqMKqSx86dYVKrp2MhXLvpibctkbSALpPMXholMoOSD5/XEySF0F4byai1lYR0sUMfoHMgfLLUt3umA0b9KpcjyFFthkpqE8pqhM0I02rliOyF0WhUfN6OqKRSVwppYvd6+CMM+d9u9SXtmvyLujHOWn7VWrX1yKmHyWNsFQjbw3Zm6KFQkvSW0/OVLV7polPhtJkWdN7ja52+TuV+bu7ZfHEWvFtx76bK5CnzMVcSxtnivQx/joUXoGdv8MSCw4ssVgkAiR/nh7GlEy6IEVCUv+QHwUtvIV4Qe1P8L4kOBH7awlX5CA3o5BgxEqkcj6Xu65xN5QwVTbq6u90GYoEaBqDURE1TRsqivGYTJTKUWScNtimRZWPXBswlEfOTLC2lABaVWVtUstlWuQZIMkm92o2Y1+n92oQZJN7ja5+2vm7heRZC2Vz5aIk2xVFNxMQ6TF96QtZyBgs1M/Vqecd9VttELMWI2xkmXkkAy3Noebo51U9DLey55u74620qdb/MnO5s7msLe1kyzu9efzPK6TbDmnFvwd/BjOWYW5BI6rFILLOq2z5eM/mNeIEZU1Kj01bobNYdKLOXbsrWLH19pBNzAGdjR3HC+eHR8Sfyzt2ZPddGVSQTA7mA7k3HlISTEMS0vrGujYQMdm+2m2n99m+2mgY5O7Te7+mrn7TdCxdx907H0DdOwxglgjglh/JXTMgDsImo3gFLpxUMG8imBjCVXwFE8fY9o7bsbC1UBvCUVu7a75dVxr9oqr6Qws2aWTSDU3F5U30BZEa2a0IOBsjBKpGKqWBLqlqJKFIEyK+GG5LKTPY1IIfM20PRg5aBVyZhZv9SpSpXkFCX1RyDWdvWrEmEQ4iRHBP3Dw56BjFOofeMYZvfVfnQezY9L4kDRm+1epEJTz9fnvk3W3BA4gvKFycRJ8fcd1gXBmzhXaCHFVhvJVQ9AGqjdQvdnum+3+99juG6je5G6Tu79m7n4DVI9o6G6oDoKvhuqg7WywGku9oOD6vyN2nypRAh/eTKceq2dzDA4jWIFB6aZ+kTNA/L0QyoPKTSgzZab69W3Vdrif2kdRy5ILuu5aCERivLBMJYiu9/aTbj3Ddq/nN3tvugt3Xdv1XdfQVwQ1K5Nj/sS50va73Wt4H16/6fBSdlAUEQBuqvTnTqqL7uX2mlpGV1dD3qIaZlXqe5HB0UFsXjreZ0ZSWoQa6hcIHvRWogSAJ/2dhS/y9/eQERpT9DUssGkxpFAMUT8MMUv0Jw9suGftQ3JFR+h2ZvKb+/T51/aX9AhM7tBjnfm+uBboGaS8pR6JfzGPmBMC8mH1lbiZb070E8LWymJviGyLPRPcoMsIt2oe/vH29NHCRe5wV11I6jeQgEcIEV8eB7MbJjTJ71hGV+OJF3ywdIeH0pGNcijM3qkTIdj5QTTCa+wbxyj03qQ0SfjaQrMuHs48k4lLkdOW2plbkgIPKdGFhbp8ad4jv336PkMqPBbh4vk71WbPJVU1STCAaKKKvm1k5+VML76g1/cK8bcZt3bg1vbc7KNbUgTTnqfhTniKmkAseG69tb578cCvvcCPmjKMENfbMpAlohzLN6/Smde+W44lfm3ityzHO/V2IrE3L09joZYxi601z9gBSydaW/EPxih0KA3OxxWy6LvF+kyLtn1GtLc2FkRqhyXbsg2k6eU7RGKoEEx8SDu9Bzo6nLn4lHzvPYucf48+PGPvl3T2w+fYkIky06n9bplpwTYt2A41wEb5w35HgYXcJh18HQgBsDf3v68EUdCFmhd4ra3qnn3Xz6GtIYWonost++E//XmBi0/MvyDqmgYlmIB6fReNPleJvGjTWzLW7IjhtgVX5c019tpbdgvy1j+U0v77s+lLGg/mJzFvVD790VX6jkry89Tdv6jiNZXmd6w0ETpTuPllY4+xGOQBra2eC9LB9UTgb7z1meoxOjqg8OkdYZhFNiWwMsW0z+l0IoU/USgFd4T8WhRXuvB5CLhLyY++0TMa04dvSFoLNMqHMge/DnuLlk2lMDG1a3STF1w/6Ni3ncDKR+Qk9nzmOACooqgUff8HIaqCvq27z7uZtGkVilBsAoJA2sO4etYsIylsyBQd37iYwr4Z0dEzutoFJ96zFnxo47kzDEkeiZ8fzhU5jk0H0S3D7/t4I3LaE5GX1DCiggJMiYUVXh2crnAEMxV/7NBm3I2TbJdowYRanRAM2x20iTRUauvQ3S7wpZ9M6u8/2cIHoGz9F6DX81P3n+Bj0LirUDvQLelYjJSsQnsSOsTzZN4hYkJ/6UPRNU0i2o4JjEQTr6/pSIU6phsa/lQJ6tfPL+YNkW8k4T96zuqvOe+018PjqMsj/6PQ//5D1LXmmZ0tqun8WCHB40dBpxEL9kHvDmP4YyOvaCAIB0sLU29/NbrUrL/cp7Dld4CA+ACbosz9B8fJP8g= +sidebar_class_name: "get api-method" +info_path: docs/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 'getConnectorCorrelationConfig' (get-connector-correlation-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

getConnectorCorrelationConfig

+ + + + + +Fetches a connector's correlation config using its script name. +A token with ORG_ADMIN authority is required to call this API. + +## Request + +

Path Parameters

+ +The connector's correlation config + +
Schema
    + +string + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-connector-source-config.api.mdx b/docs/api/v3/get-connector-source-config.api.mdx new file mode 100644 index 000000000..7ac4130f7 --- /dev/null +++ b/docs/api/v3/get-connector-source-config.api.mdx @@ -0,0 +1,100 @@ +--- +id: get-connector-source-config +sidebar_label: getConnectorSourceConfig +hide_title: true +hide_table_of_contents: true +api: eJztW1tzEzkW/iuq3gcu5Usuhmz8smVCoDIVIJvL8hBSi9wt24K21EjqEE8q/32/I8ltd+wQYNlloHoemI766Ojc9R1ZfZ04PrZJ/zzZ00qJ1Gljk4tWogthuJNaHWRJPxkLV70+0aVJBf4cyXHSSjJhUyMLIgXhC+HSibCMs3RO/8Ay66fQEOaw0ko1ZtJh3M9kik9F550aMKc/CsU+Szdhb45f/nvw/NXBa8ZLN9FGuhmTlhnxqZRGZCBlKc9z5iYYHRwddCBKwQ04OWFIn+uE2EKksMhr+qOVSBKy4G6yIvnpRLAFKbvkeSmYHmEBsdClw048CbEmcehlqeQnkMqMjYUio0E67hZzWGqEtySJOJc/6TtTilZi3Sz3QsppkZOA4qrIdYahEc8tEcCcU570rxM3KzylMzCfp+R+Tj/hJwsVb24uaBVbaGWFpXlbGxv0v1Vt13jICbCEBmCPt04oR1N5UeQy9Tp0r6Y5Dd0l1g3+ayW9dUvu5RL82L4xsEmbHQtXGgVbyWBjsoywjg115j0tFVwgs87donywxHeNLHr4AXpRQBgKYyeDITLhuMz3vHVXzXkrjqUS7bHhkiQUXuQUExk4XsqM4neqjWCB5TxMPF2n5hpYorPJnvEM+gb99qIyMJMzPP0IXpRi9wl0FqJsPoXCbQSh7lhW7Ag+fLqxu9UbPe1xvvX33ubOk+HuiG9vb+w+2d2l1afCWj4Opolrc2P4bGXplxTWMmW5RsbJP2EQBDRs7wXwi1NiIXTs/T7wPL7C/hSfgbZSM8qLGL1yLRSYZ3tHrLfDcq7GpR/n41tGUO2zE4yoMs/5kIYo56B5YPzGyLFUazNLlVOqiM/3XwzODk8xcrz/z7P9EzwRr4vbwg4UojWjsISoiIWJ/uwljgp85sgvkcMcIuuwx5HrYyjElV0mjAXFziyMidga8TJ3mBFXXzNjmTUbGT2tpZLPmyvHHsqO6LTYkMamHAWaDbnFBLiQyB8P0lQUrn0YLfmYTQTPhHnUYYMsk6Qkz0NBtJg/AyPGs4xSNzAYlUhl4eu2LlHOtZOpqPtiYcq6N5AE0nmKw2WnUHJA8vvjZJC6EsJ5NZezsIqWKGL0D2QOlqtLd7pkNG/SmXI8hRbYYWYwozGwMBtCN9q1Yjkid1kUHjWnqyoWlcC5Wr7cvQrCPHfav0t5ab8i745ylJ+2V616cSli8lnaAUM18t6YuylWJLwktf3kSFW5a574bCRFnjW52+Ruk7tfmbu3Xx5HoBXfeuizuQp9zlQEsbR5rkAf46NH6TnS/dPDm+jIFoNBIkT64+1phMigB1AkIPkD8VHYyleEH1T+CONDgh+Vs2q+IAG9HYMGI1QikfW93AuJvaGCqbZXV3uhzVAiQNUaiIiqadhMl4zDZKZUiiThtsUyLax64NiEoz5yZIS1oQLSqiprF1oq1yDJBkk2u1GzG/0+u1GDJJvcbXL318zdLyLJSiqfLREn2XI65WYWIi2+J205AwGbH/mxKuW8q26jFWLGKoyV1JFDMtzaHG6OdlLRy3gve7q9O9pKn27xJzubO5vD3tZOsrzXny/yuEqyek4t+Tv4MRyyCnMJHFcqBJd1Wmf14z+Y14gRlTUqPRVuhs1h0osFduytYsfX2kE3MAZ2NHccL54dHxJ/LO3Zk93C0SclrTcdyLnzkJJiGJaW1jXQsYGOzfbTbD+/zfbTQMcmd5vc/TVz95ugY+8+6Nj7BujYYwSxRgSxfiZ0zIA7CJqN4BS6aVDCvIpgYwFV8BRPH2PaO27GwlVAr4Yit3bX/DSuNXvF1WwOlmztJFItzEXlDbRTojVzWhBwNkaJVAxVSwLdUlTJqSBMivhhuZxKn8ekEPiaWXswctAq5Mw83qpVpErzEhL6opBrOnvViDGJcBIjgn/g4M9BxyjUP/CMM3rrvzoPZsek8SFpzPavUiEo56vz3yfrbgkcQHhD5eIk+PqO6wLhzJwrtBHiqgjlq4KgDVRvoHqz3Tfb/e+x3TdQvcndJnd/zdz9Bqge0dDdUB0EXw3VQdvZYBWWekHB9X9H7D5VogQ+vJlOPVbPFhgcRrACg9LN/CJngPh7IZQHpZtQZspM9aurqu1wh7iPopYlF3TXdSoQifGOMpUgutvbT7rVDNu9XlzrvemGJiCySWh1gplBw9LkmDpxrrD9bvcajofDbzq8kB3UQ/jezZT+3En1tHu5vaaM0a3VkLIohFmZ+jZkcHQQ+5aOd5eRlBGhfPoFgvO8gSj24UR/XeGL/P39Y0TFDNqwwKbFkD0xOv0wxCzQmjyw4X61j8YVHaHbmclv7tPnX9tf0iMwuUOPdeb74lqgZ5Dylnok/sUiWE4Iw4fVV0JmsS/RrwdbK4u9IbIt9kxwgwYjXKh5+Mfb00dLF7jDHXUhqdVA7h0hRHxlHMwvl9Akv1kZXY4nXvBB7foOZSIb5VCYvVMnQrDzg2iE19gyjlHjvUlpkvBlhWZdPJx7JhOXIqfdtLOwJAUesqELC3V5bd4jv3P6FkMqPE7DhfN3qs2eSypokhAA0UQVfcfIzou5XnxJr+8V4m9zbu3Are252Ue3pAimPU/DdfAU5YBY8Nx6a3334oFfe4kf9WMYIa63ZSBLRDnql67Sude+W44avzbxq8vxTr2dSGzL9WkslDFmsavmGTtg6URrK/7BGIUOpcH5uEQWfbdYn2nRts+I9tbGkkjtsGRbtgEyvXyHSAwVgokPaZP3GEeH4xafku+9Z5Hz79GCZ+x9TWc/fI69mCgzndrvlpkWbNOC7VADbJQ/bHUUWMht0sHXgRAAewv/+0oQBV2qeYHX2qru2Xf9HNoaUojqudiiH/7oLwpcfGL+BVFXNCjBhNGra2j0mUrkRftdzVjz04XbFlyVN9fYZm/ZLchb/UZKW+9fTV/SeLA4hHmj8tmPrtJ3VJK/Tt39SRWvqTS/Y6WJqJnCzS8b24vlIA9obfVIkM6sJwL/4q3PVA/P0fyET+4IwyyzoS/BKKZ9TqcTKfxhQiG4I+TXorjSU5+HgLuU/GgZPaMxffCGpLVAo3woc/DrsLfo1lQKE1OnRpd4wfWDji3bCax8RE5iz+eOA4CaTktF3/1BiHJK39Td591M2rQMRSji/yCQ9jCumjXPSAobMkXH9yxmat+M6NQZDe2SE+9ZCz608cgZhiSPxM8OF4oci9xHGdHV4fd9vBE57YnIC+oVUUEBpsTSCq8OTlc4gpmKv3NoM+7GSbZLtGBCrU4Ihu0OOkQaKrR1aGyX+NKvJdXXnix87snWf+95vThr/7mffsa9hJqAbkHnYKRaGZqS0BKeJ4uWEBP6tc9C610h+owJrEJzrq/p+IRapBsa/lQK6s3PLxYdkO8c4TB6zqrPNu+00sPjqMYj/wPQ//6L07WWmZ8jqtniCCHB40dBJw9LpkGfDmP4IyKvaCAIh0hLU29/IVprzF/uU5zyO3b9+ACboq79BzbRMjc= +sidebar_class_name: "get api-method" +info_path: docs/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 'getConnectorSourceConfig' (get-connector-source-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

getConnectorSourceConfig

+ + + + + +Fetches a connector's source config using its script name. +A token with ORG_ADMIN authority is required to call this API. + +## Request + +

Path Parameters

+ +The connector's source template + +
Schema
    + +string + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-connector-source-template.api.mdx b/docs/api/v3/get-connector-source-template.api.mdx new file mode 100644 index 000000000..85f626513 --- /dev/null +++ b/docs/api/v3/get-connector-source-template.api.mdx @@ -0,0 +1,100 @@ +--- +id: get-connector-source-template +sidebar_label: getConnectorSourceTemplate +hide_title: true +hide_table_of_contents: true +api: eJztW1lzEzsW/iuqngeW8pI4hkz8MmVCoHIrQCbL8BBSg9wt24K21EjqEN9U/vt8R5LbW0yAYYYL1TxAoz46Oru+I6tvEsdHNuldJPtaKZE6bWxy2Uh0IQx3UqvDLOklI+Gq16e6NKk4E5Mi504kjSQTNjWyIGKQvhAuHQvLOEtnMx5YZv0k5uIsVlqpRkw6vPFzmeIT0Xqn+szpj0Kxz9KN2ZuTl//uP391+Jrx0o21kW7KpGVGfCqlERlIWcrznLkxRvvHhy0IU3ADTk4Y0ukmIbYQKizymv7TSCSJWXA3XpP9bCzYnJRd8bwUTA+xgJhr02KnnoRYkzj0slTyE0hlxkZCkeEgHXfzOSw1wluTRJzJn/ScKUUjsW6aeyEljEMCiusi1xmGhjy3RACDTnjSu0nctPCUzsB8npL7Ob2En85VvL29pFVsoZUVluZ1trbon3Vtv+AjsMdbJ5Sjqbwocpl6HdrXk5yGNol1iz+NpHvXkvu5BD92YAxs0mQnwpVGwVYy2JgsI6xjA515T0sFF8istVmUD5b43iGLHnyAXhQQhkLZyWCITDgu831v3XVzrkSyVKI5MlyShMKLnGIiA8crmVH8TrQRLLCchYmnay25BpZobbNnPIO+Qb/9qAzM5AxPP4IXpdl9Ap2HKJtNoXAbQqgNy4pdwQdPt/Y63eHTLuedv3e3d58M9oZ8Z2dr78neHq0+EdbyUTBNXJsbw6drS7+ksJYpyzUyTv4JgyCgYXsvgF+cEguhY+/3gefxFfan+Ay0lZpRXsTotWugxDzbP2bdXZZzNSr9OB+tGEE1z08xoso85wMaopyD5oHxGyNHUt2ZWaqcUFV8fvCif350hpGTg3+eH5ziiXhdrgrbV4jWjMISoiIWxvqzlzgq8Jkjv0QOc4isxR5Hro+hEFd2kTAWFDu1MCZia8jL3GFGXP2OGYus2dDoyVIq+by5duyhbIlWgw1obMJRotmAW0yAC4n8cT9NReGaR9GSj9lY8EyYRy3WzzJJSvI8FESL+VMwYjzLKHUDg2GJVBa+busS5Vw7mYplX8xNuewNJIF0nuJo0SmUHJD8/jjpp66EcF7NxSysoiWKGP0DmYPllqU7WzCaN+lUOZ5CC+wwU5jRGFiYDaAb7VqxHJG7LAqPmtFVFYtK4EwtX+5eBWGeO+3fpby0X5F3xznKT9OrVr24EjH5LO2AoRp5b8zcFCsSXpLafnKkqtw1S3w2lCLP6tytc7fO3a/M3dWXJxFoxbce+myvQ59zFUEsbZ5r0Mf46FF6hnT/9PAmOrLBYJAIkf54exYhMugBFAlI/kB8FLbyNeH7lT/C+IDgR+WsJV+QgN6OQYMhKpHIel7uucTeUMFUO+urvdBmIBGg6g6IiKpp2FSXjMNkplSKJOG2wTItrHrg2JijPnJkhLWhAtKqKmsWWipXI8kaSda7Ub0b/T67UY0k69ytc/fXzN0vIslKKp8tESfZcjLhZhoiLb4nbTkDAZsd+bEq5byrVtEKMWMVxkqWkUMy6GwPtoe7qehmvJs93dkbdtKnHf5kd3t3e9Dt7CaLe/3FPI+rJFvOqQV/Bz+GQ1ZhroDjSoXgsk7rbPn4D+Y1YkhljUpPhZthc5j0co4du+vY8bV20A2MgR3NhuPF85Mj4o+lPXuyWzj6pKT1pgM5dx5SUgzD0tK6GjrW0LHefurt57fZfmroWOdunbu/Zu5+E3Ts3gcdu98AHbuMINaQINbPhI4ZcAdBsyGcQncNSphXEWwsoAqe4uljTHvHzUi4CugtocjO3h0/jWvNXnE1nYElu3QSqebmovIG2gnRmhktCDgboUQqhqolgW4pquREECal2w+5nEifx6QQ+Jppsz900CrkzCzeqlWkSvMSEvqikGs6e9WIMYlwEkOCf+Dgz0FHKNQ/8Iwzeuu/Og9mJ6TxEWnMDq5TISjnq/PfJ3fdEjiE8IbKxWnw9YbrAuHMnCu0EeK6COWrgqA1VK+her3d19v977Hd11C9zt06d3/N3P0GqB7R0GaoDoKvhuqgbW2xCku9oOD6vyN2nypRAh/eTKceq2dzDA4jWIFB6aZ+kXNA/P0Qyv3SjSkzZaZ61VXVJp6GctRDUcuSS7rrOhGIxHhPmUoQ3e3tJe1qhm3fzK/13rZDE9BcuOgamoqgY2lyTB47V9heu30D18Plty1eyBYqIrzvpkp/bqV60r7auaOQ0b3VkLQohVmZ+kakf3wYO5eWd5iRlBOhgPoFgvu8iSj64UZ/YeGL/P0NZMTFFPqwwKbBkD8xPv0wxCzQnDyw4Ya1j8c1HaHbuclv79PnXztf0iMw2aDHXeb74lqgZ5ByRT0S/3IeLqeE4sPqa0Ez35no94PO2mJviKzDnglu0GKEKzUP/3h79mjhCne4pS4kNRvIvmOEiK+N/dn1Eprktyujy9HYC95fusBDuciGORRm79SpEOziMBrhNTaNE1R5b1KaJHxhoVmXD2eeycSVyGk/bc0tSYGHfGjDQm2+NO+R3zt9kyEVHifhyvk71WTPJZU0SRiAaKKKvmdkF8VML76g1/cK8bcZt2bg1vTc7KMVKYJpL9JwITxFQSAWPLfeWt+9eODXXOBHHRlGiOuqDGSJKMfytat05rXvlmOJX5P4LcvxTr0dS2zMy9NYKGTMYl/NM3bI0rHWVvyDMQodSoOLUYks+m6xPtOiTZ8Rzc7WgkjNsGRTNgEzvXxHSAwVgokPaJv3KEeHAxefku+9Z5Hz79GEZ+z9ks5++AK7MVFmOrXfLTMt2KQFm6EG2Ch/2OwosJDbpIOvAyEA9uf+95UgCrpQ8wKvO6u6Z9/2c2hrSCGq52KLXvhPb17g4hPzL4i6okEJJpReXUSjD1UiL9rxlow1O19YteC6vLnGRrtityBv9Sspbb5/NX1J4/78GOaNyqc/ukpvqCR/nbr7kypeXWl+x0oTcTOFm182NhiLQR7Q2vqhIJ1ajwX+xlufqR6go/0JH90RhllkQxCZYtrndDqWwh8nFII7Qn4Niis98XkIuEvJj6bRMxrRJ29IWgs0ygcyB78We4t+TaUwMfVqdI0XXD/o2LSdwsrH5CT2fOY4AKjJpFT05R+EKCf0Vd193s2kTctQhGIHEATSHsZVs2YZSWFDpmj5rsVM7JshnTujpV1w4j1rwYc2HjrDkOSR+OHhXJETkfsoI7pl+H0fb0ROcyzygrpFVFCAKbGwwqvDszWOYKbiLx3ajNpxkm0TLZhQqxOCYaeFHpGGCm0dWtsFvvR7SfXNJwsffbJNX33ezM/bf/YHoHE/oUagXdBpGKlXhsYkNIYXybwxxITe0sehq70huo0xbEOzbm7oGIUapVsa/lQK6tEvLud9kO8f4TZ6zqrPNzda6uFJVOSR/yHof//l6Z22mZ0nqun8KCHB40dBJxALxkG/DmP4oyKvaCAIh0kLU1e/FF1q0F8eULTyDXt/fIBNUd3+A53FN5s= +sidebar_class_name: "get api-method" +info_path: docs/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 'getConnectorSourceTemplate' (get-connector-source-template)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

getConnectorSourceTemplate

+ + + + + +Fetches a connector's source template using its script name. +A token with ORG_ADMIN authority is required to call this API. + +## Request + +

Path Parameters

+ +The connector's source template + +
Schema
    + +string + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-connector-translations.api.mdx b/docs/api/v3/get-connector-translations.api.mdx new file mode 100644 index 000000000..85d83489e --- /dev/null +++ b/docs/api/v3/get-connector-translations.api.mdx @@ -0,0 +1,100 @@ +--- +id: get-connector-translations +sidebar_label: getConnectorTranslations +hide_title: true +hide_table_of_contents: true +api: eJztW1tzEzkW/iuq3gcu5Usuhmz8smUCTGUqQCaX5SFJLXK32ha01U1LHfCk/N/3O5L6YjsmkGWWgWoejNMtHZ3bd/RJlm4Cwyc6GF4EB6lSIjRproOrTpBmIudGpuowCobBRJjq9VnOlU7sOx10gkjoMJcZ/YmGL4UJp0IzzsKy/QPNTKMLK7RUEyaNZq4jU3wmepdqxEz6QSj2SZope3Py239Gz18dvma8MNM0l2bOpGa5+FjIXERoykKeJMxM8XR0fNiDJhnPIcmInMy5CUgsNHKDvKY/OoEkHTNupmuKn00Fq5uya54UgqUxBhC1KT12apuQaFKHXhZKfkRTGbGJUOQzaMdN3YeFubCWk4ql/sHQ5IXoBNrME6uknGUJKSg+Z0ka4VHME00N4M0ZD4Y3gZlntqXJ4T7bkts+w4Cf1iYuFp3K8iSFi1atXtNg8wCqmFFeRCRCpfiIJT70NUkpyN8GHx/oxZ/T7tlb24VGo8dx7h4fvMb/U2otKFlC+njPqXNCIaBvKqF8q83BeIvbouPMocjzLEvm9MUHJ5aTHjuMmUrZteTjpGqLEE3ktVAdpBvyCvkSiZgXiaHOl1D3MggWV+QUnSE1oSL8sLO1Rf+tK7Apo8muVBmhjHWj+Gz6WcLJ6Tcb3bvAv04wuG2og0RCFHuR50ieLjsRpsgVkkq6ZKQACm3YOI0sJKRCrsqot6wFuUiGVr/+e53erks6fg97KBg5wd1I54BIGC6TA5uG62mxgnepRHeSw1poKKzKIToySLyWEQF9luaCOZElnmy73lIOwxO9bfaMR7DX2XfgjYGb4OzwA2RRKbpLoXMHx7IL4TKGUhuGFXuCj59u7e8M4qcDznf+OdjeezLej/nu7tb+k/19Gn0mtOYT5xo/Ns9zPl8b+jfCvwxd8sk/4RAgH763CtjBLTrETN8dA4/dO81tAKM00+vLKBE7KMTPDo7ZYI8lXE0K+5xPVpyguuenBMQiSQg9rjTAcif4TS4nLpk3VYjnL16Ozo/O8OTkxR/nL07xjWRdrSo7UsjWiNISqiIXpuknq7E34BPHlCASuENEPfbYS30Mg4C1ZkNfefVcw5klpNHDj35Lj6ZoFufpbAlKFjefDXsoe6LXYWN6NuOYyNiYa3RACKn541EYisx0j7wnH7Op4JHIH/XYKIokGckTN3No9J9DEONRRNB1AuICUBZ2gksLzHupkaFYjkXtyuVoAATS2BZHzaAQOKD53XkyCk0B5ayZTRRW2eJV9PGBzs5zy9qdNZxmXTpXhoewAlPxHG7Mc3iYjWEbTe++HFG4NAqPKttVFYtKYGmWLXevnDLPTWrfhbzQX4G7Yyq2XWta9eJaePBpKvWuGtlolGHyFclPIrazb1WFqwQ+i6VIoha7LXZb7H4ldldfnniC5d9a6rO9Tn3OlWf7NHmuUZ/cZg9IXtnI0hsfyA6DQzxF+v3tmV9LoD0YNfHd78iP3FS+pvyoiod7Pib6UQVrKRakoPWjsyBGJRLR0Opda2wd5Vy1uz7ayzQfSySouoUiomrmbJ4WjMNleaEUacJ1h0Wp0OqBYVOO+siBCK1dBaRRVdTNUqlMyyRbJtnORu1s9OvMRi2TbLHbYvfnxO4XmWSllUWL50m6mM14PneZ5t+TtZyhASu3+lgFORuqVbZCwljFsYJl5hCMd7bH2/FeKAYRH0RPd/fjnfDpDn+yt723PR7s7AXNuf6ixnEFsmVMNeLt4uh2o0V+DR5XKCSXNmkaLW//wb25iKms2S3RkjfD53DpVc0dB+vc8XVqYBsEgzvmG7YXz0+OSD6GtuLJb2mRh4JotnMdmnNjKSXlMDwttWmpY0sd2+mnnX5+memnpY4tdlvs/pzY/SbqOLiLOg6+gToOGFGsmCjWj6SOEXgHUbMYQaETGQXcq4g2ZjAF3/zuo4e94flEmIroLbHInf1bfhJPU/aKq3lJlvTSTqSq3UXlDW1n1DYv26IBdz/OM1QtCXZLWSVngjgp8oclciYtjskgyM3n3VFsYJXDTJlv1ShShUkBDW1RSFLae02RYxLpJGKif5Bg90EnKNTfcY/TR+t/2g9mJ2TxEVnMXnwOhSDMV/u/T247JXAI5XMqF6cu1huOC7g9c66wjBCfM1e+KgraUvWWqrfTfTvd/xrTfUvVW+y22P05sfsNVN2zoc1UHQ2+mqqjbW+LVVzqJSXX/52xW6h4Ddzp1DS0XD2qOTicoAUeSjO3g5yD4h+4VB4VZkrIlJEaVkdUu+5Y7BBFLQqu6IzrTCAT/VluKkF0HHgY9Kseun9Tn39e9JsHXPs3zoRFQFoQ3XSWFnkCEVNjMj3s92+QAAj8oscz2UNdRA6YuUo/9cJ01r/evaWc0elVB10UxKgI7XJkdHzo1y89G7bcnuh1ZdQO4IJoHUUYQDDtsYUvyrcHtpEdcyxtmBPTYUCRz1L7GGpmWKI80O5Aus3KNRth23meLO6y59+7X7LDCdlgx23u++JYaM+g5Yp5pP5VnTSnxOXd6GupU89P9CvCztpgb6jZDnsmeI6FhjtY8/D3t2ePGife3aF+IWnJAQweI0VshRyVh0yok5208rSYTK3io6VjPIRIFicwmF2qUyHYxaF3wmtMHSeo9dal1EnY8kK9rh6WkYnEtUhoVu3VnqTEAyr68FCfL/V7ZGdQu9SQCl9n7oT+peqy55IKm72pQG28iXblyC6y0i7esOu+SvyjlNZ10rpWmn60ooVz7UXojoWHKAskgifaeuvegzt53YY8WpfhCUld1YE84fVYPnwVllG7tx5L8rokb1mPS/V2KjE9L3djrpwxjdk1idghC6dpqsW/GKPUIRhcTAqg6N5qfaJBuxYR3Z2thkpdN2RXdkE2rX5HAIZyycTHNNlbrpO6bRcLyXc2ssD8OyzFI/ZuyWb7+AJzMrWM0lDfW2casEsDdl0N0F5/N+VRYgHbZIOtAy4BDur420rgFW3UPCfr1qpuxfdtH5oaQqhqpehs6P4Y1gWuvHlhX1Drqg1KMHH16jga3evxsmjeW3JWucuw6sF1fZMU0+2K35y+1W+lNAX/3ewli0f1Zswblcy/d5XeUEn+PnX3B1W8ttL8ipXGs2dKNzusX2Y0k9yxtfWtQdq7ngp84q1FqqXpWAS5O4rEYZpiMtBlymmL6XAqhd1UyAQ3xPw6lFfpzOIQdJfAj6WjFTShG4IArQYb5WOZQF6PvcWqTYVwMa3Y6DAvpL5P/dLtFF4+piCx52XgQKBms0LRRUkoUczoEuJd0Y2kDgtXhPw6wCmUWhpX9SoRSWlDrujZtUs+029i2n3GwrYRxDvGQgzLC3NwJEXE31asDTkR9cW6Zfp9l2xkTncqkozWjKigIFOiMcKrw7M1iRCm/O8daT7p+066T20hhJY6Lhl2e1gp0qMs1QYL3IZc+tWkuh3LvnQ99qbecv+hN2X9TNK4qrjwjrnxC8OLoF4YosNw6RbtyuXHoV/xYrkxhXOo880N7abQSmlBjz8WgpbqF1f1QsguIBE3+h5V1103euvhibfnkf096K+/qXuri8ptRTWvdxQCfP0gaCOi4SNaOd7buL/oouu9bPKhXVyhpdsBs4FzL90eWaNbU3Jzy+G3F4Q8voHH+C9ID1Tq/wL0S9kN +sidebar_class_name: "get api-method" +info_path: docs/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 'getConnectorTranslations' (get-connector-translations)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

getConnectorTranslations

+ + + + + +Fetches a connector's translations using its script name. +A token with ORG_ADMIN authority is required to call this API. + +## Request + +

Path Parameters

+ +The connector's translations + +
Schema
    + +string + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-connector.api.mdx b/docs/api/v3/get-connector.api.mdx new file mode 100644 index 000000000..d599e3dbe --- /dev/null +++ b/docs/api/v3/get-connector.api.mdx @@ -0,0 +1,104 @@ +--- +id: get-connector +sidebar_label: getConnector +hide_title: true +hide_table_of_contents: true +api: eJztXHtz2za2/yq46h9JOpbkV5ONx05HsZWsWr9qyc3ea2VciIQkJCTIkqBt2ePvvr8DgC9Ljh03vd3tKDOxJBA473NwDgDipqH5JG1snTV2I6WEp6MkbXxcaUSxSLiWker5ja3GROjicWOl4YvUS2RMj/HwndDeVKSMMy/vw/SUa5alUk2Y1Cmz3ZnioWgNVYfp6LNQ7FLqKTs6eX/e2TvoHTKe6WmUSD1jMmWJ+D2TifDRlXk8CAARrZ3jXgv4Y54AkhYJEX7TILCgwyI5pB8rDUmUxVxP58gdTAUru7ILHmSCRWMgECUDLdY3XQg0kUMPMyV/R1fps4lQJB1QBy5Lpr1EGJERiTn9jS2dZGKlkepZYIiUYRwQgeIqDiIfTWMepNQBMgx5Y+umoWex6akTiM/05GbMVoP3SxZvb1duLJcgKpmhnxNDEEFehOELEFUWksp96qYi/BlLGnBBhGckYI0/n+nB9bQ5+GCGkFCpeZzY5t1DfE6pt0jxx6M/nzgNDkjm9E0FZEol/cB3u0gdlmRSNY/jYEZfnDbGctJivTFTEbuQfBQUfaGTibwQagX2BUOCgfhizLNA0+AhyB02GrcfSQ9pHKkUJEIO66ur9FEnoMMK02Z7GByNPuEHcRQpLZSmEUSW9Ixy259SGnYzL95iYJyQ92hpkVq1zCthXgylJSlrxKXkTANkZ4F8HTDTtwqsL5IL6YnD6JJAegFP08MnEGkGzpNaab5dqTrlV4KvxIwa/NRSryz1Fc38Kwy+FkdlNLsKgxqe7R/Rwi4QZPB059laa/UZE8qLfIDdeXY6eNf8x7Mf3wzV9v/sHe0O/ve4yzoVaMenb/d7u7DElMsgjqTSLV/7w8Z8C4Gojiyo26l2LSPTUSxUYbEdn8eIg4BLcsIIL0t1FLKOJi1Irlg/k1qwJtsNoozwk3ge0a8Nsox1REkiAkPZrnHHJ0i5AsP59B8QdhMkRvEskZOpZs93X7D11fU11oegjklQbCC8qYqCaAL3W2E95bUY6yA8mAE0r5D9CL/Fmk3Aq6pv9y6rX6dEgJqH8CitsI7nRRlor4xnFoCFrLc7GoIeZVp0MH6iQsSl1DzBs3cygAmwYsYGvu4vINKFoRl+I1DJAE1mssNv+7P9VRDinl+BgN9BNBPiMAtHZH9fA8uXaRzwGQWFCkRP5VC22/ewu92ek7Az0zTKEk882ULt8McZ57AB6wTdhXkOG8Y+0ZRqrnweRIr4UdGw8eObxQa78USD3X4XJSHRp1JgmGodb7Xbl5eXrWqgCNtXqd8uWs7HGHO+fr7aQjOILLg+fGTE8JHHeHn+hwGU0KB5LANxCiPgftnmzH33IZAQlM6IBShT8FRUAlO/oklj/Qz/tt+iU6Fw5v7B1kTgs5BfwegEgVsjxeB3X14TrI3V1ZKokl4iIIvjKEEG173CHE96peGfeFISQv2zvD+MVPrI+H7qHx3SM8rZrLkaQtp36KNowMheSV9v7hroH7LOpWUuLfNPs8x3SRT+sdiJAm4iVT1hi5uut0G3sR/ZTOdhRNBVwieCUR3HPosZG5vSErm/V6lGK6mn0W6zeNhOiyKOUFuZCd/opIKdJwmfLeQykKmm2jAfaUwrLXXERrO7dWPPVJKJYJccJbGaMXElvEyb2sWOLoDZMqc2ejCLJZW7M8vmSDBMtKiIuS1BK7DwqACEKjTXQqUEVVkQUNe8BIWhh+m80G8rEjxrxJHfjpJJu6DJCKutRapLsdKvtRZssvHxdqVivhXgoyiC/6g5qRIpTNpq29EMPgmEY6eqUEu3K+xcpUwFZNXtn4yTu/CRi989egR+nXCV2iTkuFbq3S0E7xaaIY8Jm+ZS0cpIBQ5U6DKelGwKgjBVLmweYLjvS+rEgyo6S1xBK5W1QPLdfEjffEJIH6rv2N4ROzwasO5ebwDDnOZqosq7WP8ArZVceOAYEiaYhyHmHEBC9pbt85EIzp3KwEpfaA0RpDu/imQklZ/hu5Aq1SII8B3le2VYZzJJxITXxlXa7g5MLQo3NoPWlXbF1SPQ1kc/CXNPjaP7EP9swmSWSIQIzD4SPi2VMKb4GRNRSRe7vpS0xKCYj3T6lwxYBNsTAXpz1hdwdM2okMfDI9U8TkQoU1qj8lnPJ7x6hvq+tT1K3tD/92Lk0I2EZNtw/UhN3vyfkHo4zFZXxx6SeGBL0EC4qVNJynbb9QeZgiYxGfKAiSTg2Qg0ExSfZyDkuVTsQCpYsXrBxg5yYkZVGLuAuVdoZKHUVR4hjwVkE4yc7H9GqW6enuxX6MJwJ5tmf7d30LSS+f2LEPGZQ+wc95oDWpOsg3QUXWcJy9U5ltdQHbFBUO+ofIG11DnoVu2lIqEeJM8qwzFxLKAY0vUxEbyj1KIgvQ/pCzVJLKyX5sMfi7rOOuqaTwNAZbA/HYF0bQeITSIEv1dMP56NjT0m9PdaBIowEwLGDXFgXbNLkZDs0giywbhLoRSbJFGOme1xSlwceH0NzhFXpzCWMa35msGGuSHSkDp/YcGVIXNsSsk6J28FZbZ35Uf0VIaQ+NATZSbSsC2WIaiZtd70EtGqP2wsEG2J+n2C2V2oRchrj0YVSur4KvVtgRKmgjZP/DMKYFnn3PMq6t6Zo7Dee5LE1d6L4NcHTOEhO5SEp8jCb5xnnJNnnFvPMD1u2xfrQ+VH3r5Un78YLg/ENGFlpGD3h88aNLsWMD/cqKppglVNpENFrg3P3sldfKjKOWMgQxFleueRUWuo4NXng6Ofu4c7hX8PFeXJx8gnD3gcU41Ev5vU0MwXHZru0VBZ+kGBnX+RMruVGhPHc2tb1O99EmUxvL/O3TGS2XNTAdzjtUPVN6vKxfrHjv1d0Gbpp3zYET5GEaD6U2Sje0g2dvYQH3pKi4ldfEnDyM+CWrQtnebByWQkhcYDsvwDR+gkkN70M4h3YQKpCHn1+whDFVfIrEr4P5v186qWW6yL9FeRTeQa1NcaUSfnH7EhNDGuq/wmTIQ+9slJ0+vZ5yBLoRoFGdJ6UIt2QBpFTnogNEcZtHA9/oE0LHRDmUmtEPJ0vgFx2qNvlGmjEHx8IlaUB6c94Ov+a/BT32yLcE0FL9UpHtU6aa41ainKqSqxxKEtSL+0i7PXPT7p7nYG3T007nV/7e4fHR90Dwfm18ERPk66+91OH88/PlDKWVzVkqoYSrTAhkxjsfy8B9HJAM/o6eai3ZXdQJJAu0kC+E12InSWKCSOLh2nbTIUE2wU+WbbTypTz7a+3faLb0jcNVttD9Wb76D9JlxHEoXCkOxhIK1dXkjf2EqUUOZAIPM9Q9OvVRMaJNFaY2+5D34tf7uOGVs9eJ8Bq+c/TNCp3XLMh9Deoy2BF6IVrwQfvVx9vb45frnJ+fo/Ntde/TB6PeYbG6uvf3j9mrCHIk3hQQ+Xv+8px5ee3W9DyPKhKw7ZGwIM8sZ8SXmPDtyW5KMWFtz+Xs6mo5dpcaVXULO93T1mm69YwDH1mnY+uSME1Tztz1W/4NwCPrLrE190p3ed0/2BcZtfTrt9fCNYc67TUbBWn8wSpMIWpgiuumSAyv9UBBAHrZB976B+D4ZQI1U7ut3ldIZpNMx3MTHCYV8wogqajZMorLmS8ZsrVH+yJVoriF5oC7n2pmxE61kMKqTu32MqE7Fu7jtJfs+mgiN3eNFinSLM2cX5FONnFAYR/8h1LYBxBlcWZhMfszJTEbIGUddFKcq7axF5JNmvKoWcA5Q/bCcdT2cgzrBZ9cLCWhyJTj+g2UquTt2gIjQj0hmmBE+79RezaeUhMoE3OsLgwhGpK0XgUXm/ImJVA6QJdweWmD0d2amKZ+kj/O44QPhpGtaKBxfCOV9K85GNRkYbuZpcRHLTlhnsehXqyh0fRTzqh6XvLn136buP9N27D0/cmRL31KQ+a/Opz6lyJ5po8pxLfRJjPSrKjz1d28LfKnKFQSAuRfrpw8Cdl0J/cRXTqaJvmB/ZqXzBqZhcH7Z9ZBYsc2XVdEEEul0I4mCMSCT8LUN3SbERlBXVxjw2VEwj6VMVP58iUm3MZlHGOESWZMrk7DxdYX4kUvVMsylHfERBDXptBCSsKBzsrtMyk1xmksvZaDkb/W1mo2UmufTdpe/+d/ruFzPJgirjLS5PSrMw5MnMWpp7Ttxyhg4sP91cHlo2qrqbrRAwVuRYjXrm0Bitr43Wxq88senzTf/lxuvxuvdynf/wau3V2mhz/VWjOteflX5cOFndpyr6tnq0J+7t6nKmfFr8jSK/vvwH8SZiTGHNnALP82bIHCL9WOaOm/O542GkwRutMjcBY/Hy4unJPsEHagOe5GbPAZDTGtHZNxYopSQbhqRl+g3PgC9Tx2XquJx+ltPPMnVcpo5L31367p+dOm4+lDpufkXquMkoxRpTivVXpo4+8g5KzcZQCr1rmkG8itLGmE4tQvJ29dG5vebJROgi0atlkeuv57PIQRSxAzqu65KltLYSqUpxUXhD35D6JnlfdOD2fUQ6RCCR3ZJVyZBOltNBSRbIUBo/JoYAN5k1O2M6qWR9Jre3AotUXpCBQhMUgojWXiPYmIQ5iTGlf4Bg1kEnCNTfcI3TaesPrQezE+J4nzhm3StPCPL5Yv33h0WnBOjISkLhwh1Cuee4gF0z53SmRFzFNnwVKegyVV+m6svpfjnd/z2m+2WqvvTdpe/+d/ruV6TqLhu6P1VHh0en6ujbWmVFLvXOvLX0/52xG1dxFNgLOSLP5Op+mYPTsVaBRqlnBslpak5PEwQ6gE6eKX21VRxMbdqXC7cQ1PzGR7rWIxSwRHczDYUguuhlq1G+tZa2b8qbJ24bKw1bRFiesiRA5+J4PFQNFd+2eCxb0p2UVtGleV/1YmNB4KJzqtZJEfr8zBxOp6tpXKXSMgpKzHUlNmAaBFZd7lWy8p2pL8I318/ADmYoYpgFs0JvgTp7NM0gM0Yx8szeudEy9jfHI3g7TYLbh/j5deNLfFgg9/CxSHxfxIX+DFTeYY/I/1iahzn+brHPGUk5E9F+wfocsiPqts7eCp7QSXVzhOb5Tx8GLyrvr9krioSk4gLedgwTMbGwkx8noUFmekqibDI1hHdqB3bI99g4AMNsqPpCsLPqafsTRHUj0vqLFR+f55rxxYUIaP6886I07L8NCbV5bdwLM1eaokIqOkxuX/YcqibbMy8z0pl/08exaGpEdhbnfPEKX08l4rscWtNCaxpo6Ys7VFjRnnn2ALiHAEAgeJAaaT0ZuYXXrMCjCgwtBPUuDSQJR0f9mJWXa+3JdNTgNQlenY6h+jCVmIjrw5gNXCzFPBr4rMe8aRSl4kfGyHTIDc4mGbzoyWRdEtKm8Yjm+mqFpKZF2ZRNpJWGvn04hrLGxEc0rZusJrILLMYlfzOahc//hqLbZ7/VeDbNZ5h9qacfeemTaSaETULYtDEgdfTbyY0MC75NPJg4YA1gt9S/iQSO0ErMs7AWRnUDvm3G0NTggVQDJY237I+tMsDl10qZB9S76IMQTFl5cfCMbilzsGiGqwkrX0+4K8F5eundXHVHbpbeYleUJtv/NH6J48otRkcqmH3rKH1PJPnPibt/UcRbRpq/Y6RxeTKZm0HrCoqqkdtsbX4RkFappwJ/8dR4qknIUe7YGxcph6mCyV9MMz7tTaUwywex4OaiiRWyqyg0foh0l5wfRaIBNKHLJgTd1MZR8MkA8FrsgzD3z2Tm4g46tguonyJXpJUXEezlikMCFYaZomsfQUQW0mUWD2nXl6mX2SCUX95gCIpMGleMyj2SzIZE0TJVShKmR2N3BV5FiQ/ggg5Tt8jM7aUT7rrFkpETdzEV9aun3w/BhuU0pyKIqToM6G67VFQwHPQGcxABTLmdDbqtww1K29QXQNyNQBiw0UJNSE1xlGqUshW4tD9y762eN+V6+l9wwaebMijXb8e0wGWub7G1h631zspXJkneW5V7BlE+0NvN1OfmhtZBqPK5pWZ7UyaVgJA8GbdfXL95L/OVdapvfT/lPXzSpR+VazxdrW+vs8zrsa9k4vmJk/YLswH1519/upCxfB1Tzaps5QxXNHhL18rYJSrDqO1gF7EqQ+e2eWorA++75Db8niTEfdk6oyWJfwMrSolm +sidebar_class_name: "get api-method" +info_path: docs/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 'getConnector' (get-connector)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

getConnector

+ + + + + +Fetches a connector that using its script name. +A token with ORG_ADMIN authority is required to call this API. + +## Request + +

Path Parameters

Query Parameters

+ +A Connector Dto object + +
Schema
    \n\n\n"}}>\n\n\n\n\n\n\t\n\t\t\n\t\t\n\t\t\n\t\n\n"}}>
    \n \n \n \n \n\n \n
    "}}>
    \n \n \n \n \n\n \n
    "}}>
    translationProperties object
    + +A map containing translation attributes by loacale key + +

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

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

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

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

    Geben Sie im Gruppenfilter die Gruppenfilterbedingungen an. Beispiel: displayName sw \"S\".\nplaceHolder_accAggregation=userName sw \"S\"\nplaceHolder_grpAggregation=displayName sw \"S\"\nplaceHolder_host=https://{Delinea_SCIM_Server_host}/v2\ndocLinkLabel_AuthenticationSettings=Mehr \\u00fcber Verbindungseinstellungen\ndocLinkLabel_Filters=Mehr \\u00fcber Konto- und Gruppenfilter\nHostURL=Host-URL\nConnectionTimeout=Zeit\\u00fcberschreitung bei Verbindung\nAPI_TOKEN=API-Token\nJSONPathMapping=JSON-Path-Attribut-Mapping\nFilterConditionForAccounts=Kontofilter\nFilterConditionForGroups=Gruppenfilter\nPage_Size=Seitengr\\u00f6\\u00dfe\nSchemaAttribute=Schema-Attribut\nJSONpath=JSON-Pfad\nShortDesc=Das Integrationsmodul IdentityNow f\\u00fcr Delinea Secret Server On-Premise bietet die M\\u00f6glichkeit einer tiefen Governance f\\u00fcr Konten und Gruppen. Es unterst\\u00fctzt au\\u00dferdem das End-to-End-Lebenszyklus-Management."}}} collapsible={false} discriminator={false}>
    connectorMetadata object
    + +A map containing metadata pertinent to the UI to be used + +
\\n\\n\\n\",\n \"correlationConfigXml\": \"\\n\\n\\n\\n\\n\\n\\t\\n\\t\\t\\n\\t\\t\\n\\t\\t\\n\\t\\n\\n\",\n \"sourceConfigXml\": \"
\\n \\n \\n \\n \\n\\n \\n
\",\n \"sourceConfig\": \"
\\n \\n \\n \\n \\n\\n \\n
\",\n \"sourceConfigFrom\": \"sp-connect\",\n \"s3Location\": \"custom-connector/scriptname\",\n \"uploadedFiles\": [\n \"pod/org/connectorFiles/testconnector/test1.jar\"\n ],\n \"fileUpload\": true,\n \"directConnect\": true,\n \"translationProperties\": {\n \"de\": \"# Copyright (C) 2024 SailPoint Technologies, Inc. All rights reserved.\\n# DO NOT EDIT. This file is generated by \\\"sailpointTranslate\\\" command.\\nmenuLabel_ConnectionSettings=Verbindungseinstellungen\\nmenuLabel_AggregationSettings=Aggregationseinstellungen\\nsectionLabel_AuthenticationSettings=Verbindungseinstellungen\\nsectionLabel_AggregationSettings=Aggregationseinstellungen\\nsectionInfo_AuthenticationSettings=Konfigurieren Sie eine direkte Verbindung zwischen der Quelle Delinea Secret Server On-Premise und IdentityNow.

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

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

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

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

Geben Sie im Gruppenfilter die Gruppenfilterbedingungen an. Beispiel: displayName sw \\\"S\\\".\\nplaceHolder_accAggregation=userName sw \\\"S\\\"\\nplaceHolder_grpAggregation=displayName sw \\\"S\\\"\\nplaceHolder_host=https://{Delinea_SCIM_Server_host}/v2\\ndocLinkLabel_AuthenticationSettings=Mehr \\\\u00fcber Verbindungseinstellungen\\ndocLinkLabel_Filters=Mehr \\\\u00fcber Konto- und Gruppenfilter\\nHostURL=Host-URL\\nConnectionTimeout=Zeit\\\\u00fcberschreitung bei Verbindung\\nAPI_TOKEN=API-Token\\nJSONPathMapping=JSON-Path-Attribut-Mapping\\nFilterConditionForAccounts=Kontofilter\\nFilterConditionForGroups=Gruppenfilter\\nPage_Size=Seitengr\\\\u00f6\\\\u00dfe\\nSchemaAttribute=Schema-Attribut\\nJSONpath=JSON-Pfad\\nShortDesc=Das Integrationsmodul IdentityNow f\\\\u00fcr Delinea Secret Server On-Premise bietet die M\\\\u00f6glichkeit einer tiefen Governance f\\\\u00fcr Konten und Gruppen. Es unterst\\\\u00fctzt au\\\\u00dferdem das End-to-End-Lebenszyklus-Management.\"\n },\n \"connectorMetadata\": {\n \"supportedUI\": \"EXTJS\",\n \"platform\": \"ccg\",\n \"shortDesc\": \"connector description\"\n },\n \"status\": \"RELEASED\"\n}"} language={"json"}>
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-count-completed-work-items.api.mdx b/docs/api/v3/get-count-completed-work-items.api.mdx new file mode 100644 index 000000000..029126bb2 --- /dev/null +++ b/docs/api/v3/get-count-completed-work-items.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-count-completed-work-items +sidebar_label: Count Completed Work Items +hide_title: true +hide_table_of_contents: true +api: eJztW9ty2zgS/RUU92GSlCVZshKv/bKlOM6Up5xJ1pfNg+OqQCQkIaFADgDa1rj873u6AVI3J06yqc1MSi82RTYafcdpELxNilJZ6XVhjrJkPxkrf1BUBn+mZa68yt4W9uORV1OXbCVejl2yf5HQPRFuXm4lmXKp1SWxAIOziXYCXJyQIiVOohjhInIT1zRU01AxVHlhxtqMhS+E0n6irMAf4UqV6pEGceWUfSSzqTbCqj8qbVX2eEsUgSytrFVgT0RtCFdKK6eYw5KIt4kmYf6olJ3hmcET/CyujbJQcytx6URNZbJ/m/hZSY+ct5AkuVtV5+gFyU/zNZILZkNT1kIl+yOZO7WVqBtJimJct9ftDlMpd/C/N0zV6Fm315PZsNfFdVemyd0ljXdlYZxyJEhve5v+LU9/rB0bcG42TJsWxkNzopZlmeuU3df54GjI7bpuxfCDSj2ZyJKzvQ4TsncWyDS4jpVN1j2q5p5cEqRRt7d3B8t57Vn3JmQ4kpK7O3rY3+6uq3duZOUnhdV/wtstcaJ8ZQ0uNZvcKoFYMoWoiVhPMVEyU5bjINCJ396eIYY+KkP06qYkn7S/n6GUtYVdF34gpso5OVYi3B9yKEOcQL8YDSTglcx1FjQYSZ2rbJ/lnkvMhgqm2lmf7WVhhzrLoOOanTgFxKyohITJbGUMSSLdlsgK5cwvXkzklRIyTSEvJZunHFUma5UFnP4dLZUpD9UOikytp9ZqWL3URrXGVmpShE2GKMuUAMcrnZEG08KSbYllnYRM116ybX97u90Vz2UGsyDfkS8HURkKSSvTj+BFte0hgc6NxnhRDxE6E6NYa+6ZVu0qOXy2vdfrj571pez9s9/dfTrcG8mdne29p3t7NHuMD7cwt7RWztam/lWhouhU5EWKKKFksEo6ihQIUIdTyLoHfcA8vsD+lNaBtlGzjmevbvwW6vfzgzeivytyacYV35fjFSOY1vkp1dcqz+WQbnlbKWgeGL+2eqzNfaIoU01pJXlx+HJwfnyGOyeH/z4/PMUV8VpbVQZIbZNRWEJUxMKkuGaJowLX0gmncpgDiS+eRK5PoJA0bpFQh19u5qiQZ2okq9xjRJz9nhGLrMXIFlN+aGOocd7cePFIt1V7C0sa7k2lTydiKB0GwIVE/mSA3Ct96zha8kksYo/bYpBlmpSUOVUIMMX4GRgJiWRHhgcGowoZD2GwShaVR030OlXLvpibctkb87p8vOgUSg5I/nCcDFJfQThWczELm2iJIkb/QOZguWXpzhaMxiadGS9TaCHzfAYzYi1PvRhCNw3oEMsRucuh8JiaThuuou1kcbk5JGleBWFe+IKfpbJyX5B3b3KUnxar1jy4UjH5uFSGasTeqN0UKxLX0ZArNVXjrjrxBWBMnm1yd5O7m9z9wtxdfXgSMTI/baTibIk4yVXTqQTM50iLz0lbKUAgaowtmpRjV62iFWImGoyVLCOHBLB92B3tpqqfyX72bGdv1Euf9eTT3e5ud9jv7SaLa/3FPI+bJFvOqQV/Bz+yiQHiroDjKoPgcr4osqVoJfNaNaKyRqWnwc2wOUx6OceO/XXs+HvhoRsYAzvaFexY8z8/OSb+mJrZk92KyqaKYHYwHcilZ0hJMQxLozfZQMcNdNwsP5vl56dZfjbQcZO7m9z9e+buV0HH/kPQsf8V0LEvCGKNCGL9SOiYAXcQNBvBKbT9HnfIrSqhCq7i7mNMey/tWPkG6C2hyN7eOoo8KwrxSppZDZbc0k6kmZuLyhtop0Rra1oQSDFGiTQCVUsD3VJU6akiTIr4Ebmeas5jUgh87aw1GHloFXKmjrdmFm3SvIKEXBToTQLNey01wkmNCP6BA++DjlGov+MeZ/TW/7QfLE5I42PSWBzepEpRzjf7v0/vexNwBOEtlYvT4GuO8E/tmUuDNkLdlKF8NRB0A9U3UH2z3G+W+59jud9A9U3ubnL375m7XwHVIxr6NFQHwRdDddC2t0WDpV5ScP3fETunSpSAw1sUKWP1bI7BGVcglOKZHD7f4if40aETGC2uNJ3mWE0nnOXYSkIjEOSqbA76ifel2+90buEuuOmuLUvdRhWDx/zMFNdtMOlc7dxTfODamIwoX1mVcvMweHMUu402G9lqiuNQ9HiCYHJWiyIWpudDBp/lT8dzyJczNCIisNkSiPkYU3ybdEVD8Ytj6jbH0JqO0O3c5ncP6fOfnc/pEZh8Qo/7zPfZuUAvIOWKeiT+JbkLfgcj9tc55DkI1WpQka8vLhdpTgmdBwnXKOcrDr0X6K0J9JrIeuK5kpYOWfFRmUe/vT17LMaESbkmVI7gcDyHJcUbhBHXvEF9bIQG8TJki2o8YeUGSwdzKMfEKIdRxDtzqpS4OIqG+h2LwQmqN5udBikuGDTq8lHtvUxdqZzWyfbc2hScOjMdWLEjl8Y95jWRmwdtcDnlu+13piVeaCpVmtZ2ookqci8oLspaL7mg17cK8Y+aWytwazE393hFimDaizTXVDJTJDqxkLlja33z5IFfa4EfdVq4Q1xXZSBLRDmWj1Oltde+WY4lfi3ityzHO/N2orHgLg8Tob4Jh/Uyz8SRSCdF4dS/hKDQoVS5GFfItG8W65ombXFGtHrbCyK1wpQt3QJ8ZPmOkRgmBJMc0vLN6KUIGymctu/Zs6gL79FcZ+L9ks58+wKrLFFmReq+WWaasEUTtkKdcFH+sIhRYCG3SYdwgo8D4GDuf64EUdCFuhh43Vv5mX2Hx/CxSIjKXFy5H37sz4tgvBL8gKgbGpRpQt/NATP8FpEXrWRLxqr3DVYtuC5vXmABXbFbkLd5+0mL6l9NX9J4MN9eeW3y2feu0p+oJH+duvuDKt6m0vyMlSbiYQo3njY2DotBHhDd+mYf7UZPFP7iKWcqA2+0NdyoMYZZZFPm0lNMc06nE614m6BU0hM63KK4Kqach4DElPxoBpnR2IIGSeuAWOVQ5+DXFm/Rhxkgc0s9GB3PBdcPRWzGTmHlN+Qk8aJ2HADUdFoZjKUcq6ZCIjwe8G6mXVqFIoSWzKhas4JhXDOqzkgKGzJFm7sRO3WvR7SfjFZ1wYkPzAUf1qfQYUjySDxeP1fkROUcZUS3DNEf4o3IaU1UXlIXiAoKMKUWZnh1dLbGEcxMfINR2HEnDnIdogUTaodCMOy00fvRrbJwHi3rAl8+qC6abx7EwgcOKyF1O99E/3GfOsRlhPB/p6TNLdKqCj1LaBMvknmbyL6KQvE1tYpoLCYwA1He3tJOCPVNd3Q7fDNBDQl8QmE//7zhk5b47FcS90r7UVErP/8gI7brCX8XUbdj3AJBUN6JYZHCsLBXszBq7W0GcWn6518PEQl3/wW0ndZb +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-count-work-items.api.mdx b/docs/api/v3/get-count-work-items.api.mdx new file mode 100644 index 000000000..a7b3697c8 --- /dev/null +++ b/docs/api/v3/get-count-work-items.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-count-work-items +sidebar_label: Count Work Items +hide_title: true +hide_table_of_contents: true +api: eJztW1tTG7kS/iuqOQ+bpLANxoTAyymHkC22yCbL5eSBUBV5RraVjKVZSQN4Kf77ft2ascc2CUlOai8pv4CtabX6rq9lzW1iC+Vk0NYcZcl+MlLhwJYmvLXu41FQE59sJEGOfLJ/kdCYiIOXG0mmfOp0QTMx72ysvcBkL6RIiYGwQ3FNEzRNEAOVWzPSZiSCFUqHsXICf4QvVKqHWmWi9Mo9ktlEG+HU76V2Knu8IWwkS0vnFJgSURsiFdLJiQrKkWC3iSYRfi+Vm+KZwRN8tddGOei0kfh0rCYy2b9NwrSgRz44SJLcLStx9IKkpvVmkgtmQ0vWQiX7Q5l7tZGoGzkpcuKnhtvPhnu97d6u2uvtPO0OdgaDZ71uT+483d7bzZ4ld5c03xfWeOVJkO7mJv1bXP5Y+yWzYdnUmgDNiVoWRa5T9lXng6cpt6u62cEHlQYykSPPBh0XZJ80yDS4jpRLVv2o7vNf0lC3u3cHywUdWPdZoHDYJHd39LC3ubWq3rmRZRhbp/+At1viRIXSGXzUbHKnBCLIWFETsZ5irGSmHMdBpBO/vD1DDH1UhujVTUE+aX8/QynnrFsVvi8myns5UiKODziUIU6kb0YDCXglc51FDYZS5yrbZ7nnErOhoqm2V1d7ad1AZxl0XLETp4CY2lJImMyVxpAk0m+IzCpvfgpiLK+UkGkKeSnZAmWmMlmrsHD6d7RUpgJUO7CZWk2t5bB6qY1qjZzUpAibDFGWKQGOVzojDSbWkW2JZZ2ETNdesG1vc7O9JZ7LDGZBviNfDiplKCSdTD+CFxWyhwQ6NxrzRT1F6EwMq1pzz7JqV8nB0829bm/4tCdl91lva3dnsDeU29ubezt7e7R6FR++sbZ0Tk5Xlv5ZoaLoVOQ2RZRQMjglPUUKBKjDKWbdgz5gHl9gf0rrSDtTs47noG7CBqr284M3orcrcmlGJY/L0ZIRTOv8lOprmedyQEPBlQqaR8avnR5pc58oypQT2j9eHL7snx+fYeTk8Lfzw1N8Il4re0kfqW0yCkuIilgY22uWuFLgWnrhVQ5zIPHFk4rrEygkjW8S6vjNTz0V8kwNZZkHzKhWv2dGk7UYOjvhh64KNc6bmyAe6bZqb2BLw9hEhnQsBtJjAlxI5E/6yL0itI4rSz6pitjjtuhnmSYlZU4VAkwxfwpGQiLZkeGRwbBExkMY7JK2DKiJQadq0RdzUy56Y16Xj5tOoeSA5A/HST8NJYRjNZtZOIuWSsTKP5A5Wm5RurOG0dikUxNkCi1knk9hRuzlaRAD6KYBGKpyRO7yKDymptOGq2g7aW43hyTNqyjMi2D5WSpL/wV59yZH+WmxarMHV6pKPi6VsRqxN2o3VRWJ62jMlZpq5q468QVgTJ6tc3edu+vc/cLcXX54UmFkfjqTirOlwkm+nEwkYD5HWvWctJUCBKLG2GKWcuyqZbRCzMQMYyWLyCEZdLcGW8PdVPUy2cuA4Ifd9GlX7uxu7W4Net3dpLnXX8zzeJZkiznV8Hf0I5sYIO4KOK40CC4frM0WopXM69SQyhqVnhluhs1h0ss5duytYsdfbYBuYAzs6JawY83//OSY+GNpZk92s6VLFcHsaDqQy8CQkmIYlkZvsoaOa+i43n7W288Ps/2soeM6d9e5++/M3a+Cjr2HoGPvK6BjTxDEGhLE+juhYwbcQdBsCKfQoXt1Qu5UAVXwqTp9rNI+SDdSYQb0FlBkd28VRZ5ZK15JM63Bkl84iTRzc1F5A+2EaF1NCwIpRiiRRqBqaaBbiio9UYRJET8i1xPNeUwKga+btvrDAK1iztTxNltFmzQvISEXBfolgda9lhrhpIYE/8CBz0FHKNTf8Yyz8tb/dR4sTkjjY9JYHN6kSlHOz85/d+77JeAIwjsqF6fR1xzhnzozlwZthLopYvmaQdA1VF9D9fV2v97uf4ztfg3V17m7zt1/Z+5+BVSv0NCnoToIvhiqg7a9KWZY6iUF11+O2DlVKgk4vIVNGatncwzOuAKhVF3A4fstYYwvHbqB0eJK04k3ODaSCP+jNKXLQTUOofD7nc4tnATn3LVloduoXfBTmBp73U7tpHO1fU/JgUOrFETRysqUW4b+m6Oqx2izaZ2m6I2ljheIhmZlKE5hcL5a8Fn+dCmHPDhF+yEimw2BSK8iiYchZoE24ifP1G2OnBUdodu5y+8e0ud/25/TIzL5hB73me+za4FeQMol9Uj8S3IXvA1G7K9zyHMQa1S/JA9fXDZpTgmTRwlXKOf7DP0a0F0R6DWRdcVzJR1dreILMo9+eXv2WIwIiXIlKD2B4Or2lRRvEEZc6fr1ZRGaxJuPs+VozMr1F67jUGaJYQ6jiHfmVClxcVQZ6ldsASeo2Wx2mqS4TNCsy0e19zJ1pXLaHdtza1Nw6sx0YMWOXJj3mHdCbhm0wccJj7bfmZZ4oalAadrRiaZSkTtAcVHUesmGXt8qxH9qbq3IrcXc/OMlKaJpL9JcU6FMkd7EQuaerfXNi0d+rQY/6q8wQlyXZSBLVHIsXqJKa699sxwL/FrEb1GOd+btWGObXZwmYlUTHrtknokjkY6t9eq/QlDoUKpcjEpk2jeLdU2LtjgjWt3NhkituGRLtwAaWb5jJIaJwSQHtGkzZrHx+ITT9j17FnXhPVrqTLxf0JmHL7C3EmVmU//NMtOCLVqwFeuEr+SPWxcFFnKbdIj39jgADub+50pQCdqoi5HXvZWf2Xd4Dl+GhKjMxRf78cv+vAhWnwQ/IOoZDco0Ye7ZtTJ8FxUv2r8WjFWfFixbcFXe3GLbXLJblHf2mydtpf80fUnj/vxQ5bXJp9+7Sn+ikvxz6u7fVPHWleZHrDQVCqZw42WrdqEZ5BHRrR7x0Rn0WOEvnnKmMtxGM8PtGWOYJpsil4FimnM6HWvFhwOFkoHQ4QbFlZ1wHgISU/KjBWRGIwcaJK0HYpUDnYNfW7xF92WAzB11XnQpF1w/2KoFO4WV35CTxIvacQBQk0lpMJdyrJwIifB4wLuZ9mkZixAaMaNqzSzDuNmsOiMpbMgUbe5B3MS/HtIpMhrUhhMfWAs+rO+ew5DkkepS/VyRE5VzlBHdIkR/iDcipzVWeUG9HyoowJRqrPDq6GyFI5iZ6ncL60adapLvEC2YUDsUg2G7jY6PhgrrAxrVBl++ni4arzAsBdLt/MD8r36ZodoyCOt3Cjq+Ig3K2J/ERvAimTeC7BdqBdE4jKEmPb29pfMN6ovuaDi+CUENB2xOYT1/aeGTOn/23Yd7JfyoqEGfv2ZRNeEJv+1Qt1vc4kBQPl9hkeK0eALTmLXyGwVxmXXFPx/C03d/AtcRvi8= +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-custom-violation-report.api.mdx b/docs/api/v3/get-custom-violation-report.api.mdx new file mode 100644 index 000000000..8cc023fb2 --- /dev/null +++ b/docs/api/v3/get-custom-violation-report.api.mdx @@ -0,0 +1,99 @@ +--- +id: get-custom-violation-report +sidebar_label: Download custom violation report +hide_title: true +hide_table_of_contents: true +api: eJztW1tTGzkW/iuq3odJUr6AMRB42XKATDFFEtbA5IFQFblbtpVpSx2pG+Kh+O/7HUndvgIJk92ZpDoPxFYfHZ27viOrbyMr4sLIfBrtX95GF1aYA61y8SXvFfkYY5FM1L7VSfNa6pTnUqt9I3gSXd1dNSKdCePGjpNoPxqJ/KCwuZ78XpL2RaZNHjWinI8sMTt7d8hOdSrjaYTpibCxkRlRYvr5WFrG01TfWJZrlugblWqeMM5sJmI5lCJhik/wtxKFGbcAG2oDspG8FtWQEUNhhIpFC8tn3GBiLox1WkpaLuPQrxERR3zzs/rCFmkOZRqRjcdiwqP92yifZkRhcyPVKLprgPZzIY2AyrkpxKoagh0fMj1kOT4tSzOvGUkmvvBJlhJ/Mdx6OdzrbnV3xV53e6cz2B4MXnY7Xb69s7W3m7zEymslH8pUvKWPf0Fm7zZGbJwtSXJGjBdFjB1Z0y1M7jfCZlpZYWnJzsYG/bfIuC/ywijrGP4pM8eT3ch8HJzlOTq3gobnLEbwcRlmrPo5iERUQuW0Hs8yhJOjamMFGrrPDI0Iuk04pkUDqbiZRnf414i66yQ/SCVWYEfGwB5N5hVB7MnSr58LYXM20MmUIW6luuapTB4Q7pMlvmuk04NPIqYkyQzlUy69PRMBQ6QHOhHrNFkU9rVUojkyMBwkFE7kGBMZOF7LBDPYRBvBPMsyNB3dooNhidYme4Wk6wf9DoIyMFNuePwHeFGuPybQhZKYz8opTCZVXK1ZVuwKPtjZ2Ot0hztdzjsvu5u724O9Id/a2tjb3tuj1SfCWj7ypglrc2P4dGXpX4USRsYs1TE88icMgnoF2zsB3OKYInMxsY/7wPH4CvtTznvaSs0gL6NS2kBxenVwyrq7LOVqVLhxPloygmpenFFaF2nKBzREmQrNPeN3Ro6kWieKUMWEauvh0evexck5RvpH/7k4OsMn4rVSZ3sK0ZpQWEJUxMJY3ziJgwI33DIrUphDJC32InB9AYV4SMtAKP03O7UwJmJryFE7MSOsvmbGPGs2NEj8+VSK/b7DnsmWaDXYgMaQrfGYDbjFBLiQyF/04lhkefMkWPIFG2M/EuZ5i/WSRJKSPGXIRjDF/CkYMZ4klLqewbBAKvsqpIucKZ3LeKnQzUy56A0kgcwdxcm8Uyg5IPnjcdKL8wLCOTXns7CKliBi8A9k9pZblO58zmjOpFPUzBhaYPOcwozGwMJsAN1kblkoR+Qui8KjSrqqYlEJLNVy5e6NF+Yw1+5ZzAv7FXl3mqL8NJ1q1YNrEZLP7ei+GjlvlG4KFQkPSW03OVBV7ioTH8VfpEmdu3Xu1rn7lbm7/LAf8Fp46qDP5ir0uVAc2F8bt3muQB/jokdpVhJ5hOYd2WAwSIBIv70/R2L/AZQHevElI/j5HfGR38pXhO9V/vDjA4IflbMWfEECOjt6DYaoRCLZd3LPJHaG8qbaWl3ttTYDiQBVayAiqqZhU10wDpOZQimShNsG8L+w6pecjTnqI0dGWOsrIK2qkmampcprJFkjyXo3qnejn2c3qpFknbt17v6YufsgkqykctkScJItJhM6YnORFp6TtpyBgJUnh6xKOeeqZbRCzFiFsaJF5BANOpuDzeFuLLoJ7yY7W3vDTrzT4du7m7ubg25nN5rf6y9neVwl2WJOzfnb+9GZGCDuGjiuUAgum2udLB7/Fe5sl8oalZ4KN8PmMOnVDDt2V7HjW51DNzAGdjT3HC9e9E/82bFnT3bThYkFwWxvOn9sSpCSYhiWljavoWMNHevtp95+fprtp4aOde7Wuftj5u43QcfuY9Cx+w3QscsIYg0JYv2d0DEB7iBoNoRToENcwLyKYGMGVfApnD6GtM+5GYm8AnoLKLKzt4oiz7Vmb7ialmDJLpxEqpm5qLyBdkK0pqQFQXlvAlVLAt1SVMmJIEyK+GGpnEiXx6QQ+JppszfMoZXPmTLeqlWkitMCErqikGo6e9WIMYlwEkOCf+DgzkFHKNTf8YwzeOsvnQezPml8Qhqzoy+xEJTz1fnv9rpbAscQ3lC5OPO+vue6gD8z5wpthPiS+fJVQdAaqtdQvd7u6+3+59jua6he526duz9m7n4DVA9o6H6oDoKvhuqgbW2wCku9puD6vyN2lypBAhfeTMcOqyczDO5wBUIp3HamGkJ3cfej9sIN6aa/rtq+XbxVfNcub/62b8tbu3fg4fsEL3ZhUrAb53lm99vtW3gTXrxr8Uy2UOTg0Hyq9E0r1pP29daa2kRXUX0eorolRex6i97pcWhGWs4HRlKY+5roFvAecVpTQMMz7g7Cg/zdnV24eoo+hXk2DYaUCCHnhiFmhn7jF+uoWy7EVnSEbhcmvXtMn9+3HtLDM7lHj3Xme3At0DNIuaQeiX/VqC7MnxEw96uvXJufbTb0k0BnZbF3RNZhrwQ36Br8LZlnv70/f85GBEddOSgsIWEhqX9AQp0iRFy565U3RmiS24GMLkZjJ3hv4U4OpRcbplCYfVBnQrDL42CEt9gH+ijczqQ0SbhaQbOunpWeScS1SGmLbM0sSYEnE9WGhdp8Yd5ztx26vkEqf9Eao60PqskOJVUpSds60QQVXRvILrNSLz6n11OF+FfJrem5NR03+3xJCm/ay9jf8Y6R48SCp9ZZ68mLe37NOX7UZGGEuC7LQJYIcizepIpLrz1ZjgV+TeK3KMcH9X4ssdcuTmO+tDGLrTJN2DGLx1pb8W/GKHQoDS5HBbLoyWLd0KJNlxHNzsacSE2/ZFM2gRydfCdIDOWDiQ9o53bARfszFJeSH51nkfMf0Vcn7OOCzm74EhssUSY6tk+WmRZs0oJNXwNskN/vXxRYyG3SwdUBHwAHM/+7ShAEnat5ntfaqu7Yt90c2hpiiOq42Gzff9mfFbjwibkHRF3RoAQT8K7uluE7C7xoE1swVnlksGzBVXlTjb1zyW5e3uqHT9pP/2n6ksa92cnKO5VOv3eVvqeS/HPq7t9U8epK8zNWmgCFKdzcsqFnmA9yj9ZWz/noIHos8BdPXaY6zI2Oxr8VRhhmnk0GQE0x7XI6HkvhTggywXNCfg2KKz1xeQi4S8mPPtC/XmZAg6S1QKN8IFPwa7H3aMFUDBNT+0U3c8H1kw592BmsfEpOYoel4wCgJpNCYS7lWDFhHOHxiHcTaePCFyF0Y0qUmmkH46pZZUZS2JApWq4RMRP7bkhHyehS55z4yFrwoQ3nyDAkeSS8GjhTpC98Z0J0i/D7Md6InOZYpBk1gKigAFNiboU3x+crHMFMhR8vtBm1wyTbJlowoVbHB8NWC20fDWXa5uhW5yUvX/4MLwguvwm4HFi3s1P0/+V7pGG7IJzfzuj8iqQvfN/hO8HLaF0niKn7K2+YloLRw+olTvQXY1iDGN3e0lkItUZ3NPy5ENRoX17NOh/XMcJR9Bkt6RBlYPnVznnDPOuHl0Cfu19zvv4l1bVql4d7ajrr6yN8/EPQccCSttT2PUnQB99MfYJclaHR0sPU7jTJmdE/9udNcxOXXy+lBrA6Avj1iKKf34Mlwgd4DNXyv7iVeIQ= +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Download custom violation report

+ + + + + +This allows to download a specified named violation report for a given report reference. + +## Request + +

Path Parameters

+ +Returns the zip file with given custom name that contains the violation report file. + +
Schema
    + +string + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-default-identity-attribute-config.api.mdx b/docs/api/v3/get-default-identity-attribute-config.api.mdx new file mode 100644 index 000000000..b56e46f60 --- /dev/null +++ b/docs/api/v3/get-default-identity-attribute-config.api.mdx @@ -0,0 +1,104 @@ +--- +id: get-default-identity-attribute-config +sidebar_label: Get default Identity Attribute Config +hide_title: true +hide_table_of_contents: true +api: eJztW91z07gW/1c0vg8LTJ20aejXy53QAtOdQrv9uDyUzkWx5UTgSF5JLs12+r/fc45kJ05SWljmLjB+gdSWjs73+R1Zuo10IQx3UqvDNNqLRsIdiIyXuTtMhXLSTQfOGTksndjXKpOjaC1yfGSjvcuoGsFOjM5kLmx0tRalwiZGFkgQyJ2PpWVGuNIoy9xYsNQTZ7KayyvyLCH6nfdqwJz+JBT7LN2YHZ++/u/g4M3hW8ZLN9YG5xDNP0tpRApDWcLzHIjD08HJIT4AIR65GEhTcMMnwgmDMt1GEtkuuBvDKwUv4K9qelx4OWOZwkubjMWER3u3kZsWOMwCbYX6ybSZcAdPyhJG3q1FFbPRnjOlWNaRYIuqZIcHyJu44ZMiR+K94c7mTip243S4O4z5MMlisdXfitN+1tvu87Tf29yJ7q5wLVtoZcEYwFlvfR3/a643ULPlauMyb12mhx9F4nBt0JCDUTifF0UuE3KS7keLRG6Xxfczo0XpwJukEpZ5G4lVtpgAfdBcsEnpvdF2GDlPGuaP9WdvWoXuKpg2MD7PYUmWcscZKJ0JnoxXLGCZVLPHRmSgozEDYybCWnIBg0HgpFeaUHyYo7EWFYeGGvIEXDMF3wR5tMqnSGeigaFrnpe4VEZiBlfpVrKBJIEuLhhUNtQ6F1yRzshTo72M51bMGR4dBjyoluXccGXRweyc6rkxfApUpBON5w+ZhLmKGqnc61rST1QnVyuUuawvuZgo3lLYLMdFkwscxXR2j1M0vR88TeYYSTXDBzWrq+1kBbcFaOV+EefsUOupKZh/+5AcuBqOqGSpF1xYayYNTxJdKlfrK5o38Er78TQlOjw/aXDI1fQ4o7TV5PFubZHG3dXdIuMDM5TArJmyT2Iak/uygktjMc6s00aAB0wZ5EZeRxgKWHNVS3Q7Y9/bPhIxWQyypC5NUj19Mz2jP+vnVHJ6ye7GzvrO9jbf6W2JrZ31DfiVrA/XN1O+wZ9vRnd3aHnpSHnnKzxg/v1S2aonNOncV97uaFR/VeLczyXMYS+NAU3E7JTKGpSgEPKY5YV1bKhTKlFSgU5l+rdyadMhUzCFzPd1+gi3fAUhHo8Ml8ihIJYTmIiJ6VqmmJImaGFPsvJdGtd0VtBEZ4O94CnI6+XbD8L4cEw+Aa3D9GGGLpSE+ayaAjFfe9SKZcW24MOt9d1eP9vqc97b6W9sPx/uZnxzc333+e4urj6B9M1HYlUmbC79GouGTFiuASrIv0AhBtJDyHK0+JeSZ9MGROORacGPrcUM/DInbtwaZN8X+yesv81yrkYlPeejBSWo+OIMcUiZ51g76nLgCR8bOZJqFStClRNEaAcvXw0ujs7hyenLPy5ensEvpLUE0wASSJWiWwKr4AtUbGcCfOYWEirWWihf7Fmg+gwE4gHWhYHS/2WnFpRZwS+YEVZfMWOeNMuglDZCieLmxrEnsiM6a2yIzyCRQ5UfcgsTwIQ4/NkgSUTh4qOgyWdsLHgqzNMOG9SZsyrQEygKQ0htaYqh6wlkJYSyIMCpS8eUdjJZKEEzVTatMcsoR/NGweAAzh/2k0HiSmCOxJyPwtpbAovBPsCz11yTu/M5pZFKp8rxBKQA2DUFNRqDQAnSHJPOspCO0FwWEo+qxtUZaz5RUrp745k5cJreJby0j4i7kxzST0yi1S+uRQg+KjM+G5E1KjOFjAQvqZri5DCqNlcV+CyTIk/b2G1jt43dR8bu4svT0C6GtwR9Npahz4UK3TcWzyXoY8h7lK5a9L881vaGXMNWLUCk39+dh94e+6GbApvi74iPfClfbnhre/jnQ4QftbEatkAGSY9eggwykUj3iO8Zx6Qor6rN5dVeacDV4KBqBUSErGnYVJeMg8pMqRRywu0aS7Ww6jfHxhzyI/QHwK/PgNQ3pnGhpfp7XXmLJFsk2Vajthr9UNWoRZJt7Lax+3PG7heRZM0VRUvASbacTLiZek8L71FazmAAqz5czPYXyVSLaAWJsRpjRU3kEA17G8ONbDsR/ZT3063N3ayXbPX48+2N7Y1hv7cdzdf6y1kc10HWjKk5e3s7hr1lcw04rlTgXNZpnTa3/0C9RmSY1jD11LgZdN7BbdgaO/aXseNb7UA2IAzY0dyzvXhxeoT0hd+n5ag32ktFmO1VB8O5I0iJPgyalta10LGFjm35acvPL1N+WujYxm4buz9n7H4VdOw/BB37XwEd+wwhVoYQ65+EjingDoRmGRgFZEhKUK9C2FiAKPCL12cwKP1wgyeaKqDXQJG93RXnH7Rmb/DTfQBLtrETqWbqwvQGYyc41lRjYQBnI0iRikHWkoBu0avkRCAmxZM3uZxIimMUCOiaaTzIHEjlY6byt3oVqZK8TMMRnlzj3qsGH5PgTiJD+AcUaB90BIn6O+5xBmv9rf1gdooSH6HE7OVNIgTGfL3/+3zVKYFDYN5gujjztr7nuIDfM+cK2ghxU/j0VUPQFqq3UL0t9225/zXKfQvV29htY/fnjN2vgOoBDd0P1WHAo6E6jO2ssxpLvaLT0f9vxE6hEjjwNwl0Qlg9nWFwUIIV8FC6KS1yARB/37vyoHRjjEyZqr3FOwR7YAoEp1d4Zn8iwBfD7QtMQnj7YC/qLs6x3dsVVxHuuiH24vplfRo3Tqo7G77x8HooTQ7kx84Vdq/bvQX3ALe46/BCdioSSn/uJHrSvd5ckezwbKutTrmnZULNCl698It0yKhGYtz4JEsLeBOHY+6RBVPToYYv0lfhjPgUGh/myazhYevgw/QY2CyggfnN0ugO+eySjCDbhcnvHpLnP5tfksMTuUeOVer74lowngGXC+Ih+1czlzpDpO9XX3KsWfXCbwy9pcWOcViPvRDcQBvij908+f3d+dP6EkXKSovQWkhsSCBCT8BFKH8OqiMoOIlKmtHlaEyMDxqHfDBeWZaDwOy9OhOCXVYnq99CYTmFSkAqxUmCkg/OunpSWSYV1yLHmtuZaRIdD2KmCxrq8sa8p1RfqRGRqj7U33mvYnYgMe3hxREaE0SkvpJdFpVcfE6ub2XiXxW12FOLiZp9usCFV+1l4g+NJ5A0kATPLWnrmxf39OI5eti1wROkusgDaiLw0TyalVRW+2Y+GvRipNfk4716N5ZQvJvTmE91zELtzVN2yJKx1lb8mzF0HQyDy1EJUfTNbH3GRWOKiLi3PsdS7JeMZQxQlPg7gsBQ3pn4EKFAuGJEmzIUkh/IshDzH6BRT9mHhsz0+BIqNo5MdWK/mWdcMMYFY58DbODfF0R0LIhtlIHygHeA/Zn9KRMERudynqe1MqsT+S7NwdKQAKtExRZ7/o+9WYKr7tDRCxxdj4EUHNFllnBYDW94BVpYFRvKqvYgFjW4zG+uoRgv6M3zW39JxQL9o8mLEg9mWzXHKp9+7yx9Tyb5cfLuP5Tx2kzzK2aagK3R3WjZhWtb6OQerS1vHOLO9ljAv/CWIpVAPLRI/kYxYph5MkXOHd3Xw5hOxlLQlkMhuEPkt4Z+pScUh+HKKDSWRGhkYAwErQU0yocyB3od9g56OpWAirGfw6O+QPWjDo3dGWj5BI3EDirDAYCaTEqFlx+BiXLCOLjHA9ZNpU1Kn4QA4CtRSaYJxtWzqohEt0FV0I1HYSb2OMO9aWh754z4wFpgQxs2pkGRaJFwOXomyKnI/c1dGNeE3w/RBs+JxyIvsKOEDApgSsyt8ObwfIkiEFPha4g2o26YZLs4Fohgq+OdYbMDfSQ+KrR10HPN0X0tXH1D/N4L0YvedTvbm/8ZLreH2oNNQ7fA3TVURembGN9mXi5db0f7LfWr/s77w50m9C5j0DTSvb3FjRtsu+7w8Z+lwF2By6tZV0XdKDhBuG8d7j7fq+8np0EvT+nT0z135leKXG07qulsxyGCn58EblSsEpYuzPqtJWLTj/SbT3M0lj7PNPr51y/Rdfk9QCD8AJVAqvsfSIL6cg== +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

+ +An Identity Attribute Config object. + +
Schema
    attributeTransforms object[]
  • Array [
    • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-default-violation-report.api.mdx b/docs/api/v3/get-default-violation-report.api.mdx new file mode 100644 index 000000000..2e85263b3 --- /dev/null +++ b/docs/api/v3/get-default-violation-report.api.mdx @@ -0,0 +1,99 @@ +--- +id: get-default-violation-report +sidebar_label: Download violation report +hide_title: true +hide_table_of_contents: true +api: eJztW1tTGzkW/iuq3odJUr6AMRB42XKATDFFJiyXyQOhKnK3bCtpSz1SN+Ch+O/7HUnddtsmJNnUziTVeSC2+ujo3PUdWX0fWREXRuazaP/qPrq0whxolYu7fFDkE4xFMlH7ViftG6lTnkut9o3gSXT9cN2KdCaMGztOov1oLPJDMeJFmv9R0p6JTJs8akU5H1vidv72kJ3qVMazCPMTYWMjM6LE/IuJtIynqb61LNcs0bcq1TxhnFVrM+MYspE2GB7LG1ENGTESRqhYdLBcxg2filwY69SSxD7jUKgVKTzANz/rTFiIC+lbkY0nYsqj/fson2VEYXMj1Th6aIH2z0IaAR1zU4hVsQU7PmR6xHJ8WpZmUROSTNzxaZYSfzHaejna62/1d8Vef3unN9weDl/2e32+vbO1t5u8jMjCRthMKyssCdbb2KD/6sufibwwyrrFvWW90Tt/yQyDPGcxHMplIFk1pUydyYhKqJwW4FkGPo6qCy409Jh1WhFcMeWYFg2l4mYWPeBfK+qvE/UglViBHRkD97WZl1wkTJam+7MQNmdDncwYQkGqG57K5DPCfbTEd410evhRxBR3maEYzaU3YCJgiPRAJ2KdJnVhX0sl2mMDw0FC4USOMZGB441MMINNtRHMsyy97+jqboYlOpvsFeL4LOh3EJSBmXLD40/gRfnzlECXSmI+K6cwmbg0eGRZsSv4cGdjr9cf7fQ5773sb+5uD/dGfGtrY297b49Wnwpr+dibJqzNjeGzlaV/FUoYGbNUx/DIXzAIagBs7wRwi2OKzMXUPu0Dx+ML7E9p5WkrNYO8jMpTC/n/6uCU9XdZytW4cON8vGQE1b48p5wv0pQPaYgSGJp7xm+NHEu1ThShiimVq8Oj14PLkwuMnB395/LoHJ+I10rpGihEa0JhCVERCxN96yQOCtxyy6xIYQ6RdNiLwPUFFOIhLQOh9N/szMKYiC1XTTEjrL5mxiJrNjJ6Wkul2Ndy9kx2RKfFhjSGbI0nbMgtJsCFRP5iEMciy9snwZIv2AQ1XpjnHTZIEklK8pQhG8EU82dgxHiSUOp6BqMCqQxhZD7RRc6UzqUvxHNfzE1Z9waSQOaO4mTRKZQckPzpOBnEeQHhnJqLWVhFSxAx+Acye8vVpbtYMJoz6Qw1M4YW2I9mMKMxsDAbQjeZWxbKEbnLovCokq6qWFQCS7VcuXvjhTnMtXsW88J+Qd6dpig/bada9eBGhORzm6SvRs4bpZtCRcJDUttNDlSVu8rER/EXadLkbpO7Te5+Ye4uPzwLAC08ddBncxX6XCoOPK2N2zxXoI9x0aM0K4k8QvOObDEYJECk395dILE/AfWCXtxlhEq/Iz7yW/mK8IPKH358SPCjclbNFySgs6PXYIRKJJJ9J/dcYmcob6qt1dVeazOUCFC1BiKiaho20wXjMJkplCJJuG0BYgurfsnZhKM+cmSEtb4C0qoqaWdaqrxBkg2SbHajZjf6eXajBkk2udvk7o+Zu59FkpVULlsCTrLFdEpHbC7SwnPSljMQsPKokFUp51y1jFaIGaswVlRHDtGwtzncHO3Gop/wfrKztTfqxTs9vr27ubs57Pd2o8W9/mqex1WS1XNqwd/ej87EAHE3wHGFQnDZXOukfvxXuONTKmtUeircDJvDpNdz7NhfxY6/6xy6gTGwo3nkePHy7MQfz3r2ZDddmFgQzPam88emBCkphmFpafMGOjbQsdl+mu3np9l+GujY5G6Tuz9m7n4VdOw/BR37XwEd+4wg1ogg1t8JHRPgDoJmIzgFOsQFzKsINmZQBZ/C6WNI+5ybscgroFdDkb29VRR5oTV7w9WsBEu2dhKp5uai8gbaKdGakhYE5dUEVC0JdEtRJaeCMCnih6VyKl0ek0Lga2btwSiHVj5nynirVpEqTgtI6IpCqunsVSPGJMJJjAj+gYM7Bx2jUH/HM87grf/pPJidkcYnpDE7uouFoJyvzn+3190SOIbwhsrFuff1I9cF/Jk5V2gjxF3my1cFQRuo3kD1ZrtvtvufY7tvoHqTu03u/pi5+xVQPaChx6E6CL4YqoO2s8EqLPWaguv/jthdqgQJXHgzHTusnswxuMMVCKVwg5hqCF3U3Y+6tVvHbX9dtXtfv7j70C0v12Kibw68rIVJwWOS55nd73bv4UK47qHDM9lBZYMX85nSt51YT7s3W2sKEt0/9cmHkpYUsWsoBqfHoQPpOMMbSbHtC6FbwLvBqUpRDHe4iwef5U8Xksm/MzQnzLNpMeRBiDM3DDEzNBm/WEfdcXG1oiN0uzTpw1P6/LH1OT08k0f0WGe+z64FegYpl9Qj8a9b1c3zc0LjfvWV++fzHYZ+B+itLPaWyHrsleAGrYK/GvPst3cXz9mYMKirAYUl+CskNQ3IolOEiKtxg/KaCE1y247RxXjiBB/ULuJQTrFRCoXZe3UuBLs6Dkb4HcX/DNXamZQmCVcgaNb1s9IzibgRKe2LnbklKfBkorqwUJfX5j13e6BrFqTyt6sx2nmv2uxQUmmStJcTTVDR9X7sKiv14gt6fasQ/yq5tT23tuNmny9J4U17FfuL3TESm1jw1DprffPinl97gR91VhghrssykCWCHPXrU3HptW+Wo8avTfzqcrxX7yYSG2x9GvP1jFnsj2nCjlk80dqKfzNGoUNpcDUukEXfLNYtLdp2GdHubSyI1PZLtmUbcNHJd4LEUD6Y+JC2a4dWtD84cSn5wXkWOf8BzXTCPtR0dsNX2FWJMtGx/WaZacE2Ldj2NcAG+f2mRYGF3CYdXB3wAXAw97+rBEHQhZrnea2t6o59182hrSGGqI6Lzfb9l/15gQufmHtA1BUNSjCh7epCGb6zwIt2rpqxynOCZQuuyptqbJhLdvPyVr920ib6T9OXNB7Mj1PeqnT2vav0I5Xkn1N3/6aK11San7HSBPxL4eaWDY3CYpB7tLZ6uEenzxOBv3jqMtUBbbQxrjFzGGaRTQYUTTHtcjqeSOGOBTLBc0J+LYorPXV5CLhLyY/mzzEaG9AgaS3QKB/KFPw67B36LhXDxNRz0XVccP2oQ/N1DiufkpPYYek4AKjptFCYSzlWTBlHeDzh3UTauPBFCC2YEqVm2sG4alaZkRQ2ZIqO6z7M1L4d0fkxWtMFJz6xFnxow+ExDEkeCS8LzhU5E74dIbo6/H6KNyKnPRFpRl0fKijAlFhY4c3xxQpHMFPhFwttxt0wyXaJFkyo1fHBsNVBr0dDmbY5WtRFycuXKJff+1uOqPv5mfn3fBEz7AsE6LsZnU6RmIVvMHyfdxWt6/MwdX/lFc2q1UPzMIGqNPn+nk43qO95oGF09dQ6X13P2xrXDsIL9BlN5gg5vvwO56Lyz87C257P3e8zX/5m51pVy+M6NZt36hE+fhLU4C9piJYYirnTGCe0J/LnNQvTl1/PpF6qaqF/PaJA4o9sy+ED7IPC819yx/xf +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Download violation report

+ + + + + +This allows to download a violation report for a given report reference. + +## Request + +

Path Parameters

+ +Returns the PolicyReport.zip that contains the violation report file. + +
Schema
    + +string + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-entitlements-schema.api.mdx b/docs/api/v3/get-entitlements-schema.api.mdx new file mode 100644 index 000000000..713e2d322 --- /dev/null +++ b/docs/api/v3/get-entitlements-schema.api.mdx @@ -0,0 +1,97 @@ +--- +id: get-entitlements-schema +sidebar_label: Downloads source entitlements schema template +hide_title: true +hide_table_of_contents: true +api: eJztW1tv2zgW/iuE92HawJdc3KYxsDtI03SQQW+by/QhLVBaom12JFIjUmm9Qf77fueQlq04adpusdMWeklsiTz3c/gdmrzseDl1ndF558RWZaJc5223kyqXlLrw2prOqHM6007svzoSqf1gMitTJ/xMiYOTP4RLZiqX+Cq9SNVEGxXeKeO1z1SO/0J6X+px5fHKGiGFYz79N+aN+dfGxouXp4cjUbPAPzDXUyO9SjE+m4uJLcUTlelc06OnOlORhOtvbHS6HVuoUpKoRymEnSp/uGTuTlhAjCpkKXPlVUm6XnY0KVZIP8Mrgxf4plN8LtVflS4VKPmyUt1OULAzuuz4eUGjHJQx087VupGUCBYUTEh9lHmR0YxHydbepnq4+2hXyqFK9+Te5jjdSx/sDIcPtncmY9CK8vxVqXK+FCjwfkFfvkAQGi/spOECt7DCUqpfl9T/OS1tVXSu3pL6rrDGIQrAaHtzk/41yZ9UCSzvJlUG1ywCAn4hr0/gGzBJrPHgyrKqj36QuAv6vOSt0y6p2E21KzI5Jxm6SanI5d0Vbt3cpnqi8XBFF9dlaV0XXs+1cxjnOldXMMPwJnEPMk0GOCxLRFFPHCtflQbi6glLTO5WzouxTecUe9pcyEyn/aYWsigynXCMDd47onu57g87fq8ST5FWUkR6HYyYKi91dmBTte676657ivzpTUupSULFIieYKEDxQqeYIXJbKhFIko851Whcv+FbWKK/JR7LFPoG/Q6iMjCTL2XyJ2hRttwl0JnRmC8WUxDZnI23sFW7So4fbu5tDycPh1JuPxpu7T4Y703kzs7m3oO9PeKeI3bkNJgm8pZlKedrrH9TRpU6EZlN4JH/wCAIENieBWDmmIKKkLu7fcA0PsP+lMNhbK1mlFdQIHdRvB4fvBLDXZFJM634uZxeM4LpnZ1QDiNB5JgeUSGB5oHwy1JPtblJFGWqnMrwk8On+2fPTvHk+PDfZ4cn+ES01qryvkG0phSWEBWxMLMfWOKowAfphFMZzKHSvtiIVDegkDRudaAO39zcwZhUxGWVecyI3G+YsUpaTEqbN1KJ8+ajF/d0X/W7YkzPcumTmRhLxzWdh2/so44UvvcsWnJDzBQKSXm/L/bTVJOSMhPIRhDF/DkICZlSpdGBwKRCKkMY7We28sJYr7GqNHyxNGXTG0gCKicY8WzVKZQckPzuONlPfAXhWM3VLKyjJYoY/QOZg+Wa0p2uGI1NOjdeJtBCUmlNbFnCwgILp9DeiViOyF0OhccsxtUVi0rgQi0ud8+DME+85XeJrNxn5N2rDOWnx6rVLy5UTD6EgY3ViL2xcFOsSHhJavPkOKp21yLxsUioLG1zt83dNnc/M3evvzyOIC2+ZeiztQ59zoysYN+SF8816FNy9BgrFoMY3kRHdgUMEiHS769Pkdh/KkPj1ceC0PE3xEdhKV8Tfr/2R3g+JvhRO6vhCxKQ7Rg0mKASqXTEci8lZkMFU+2sc3tqy7FGgJobICKqZinmthISJisrY0gS6boAv8qZX7yYSdRHyag4VEDiatJeYbXxLZJskWS7GrWr0c+zGrVIss3dNnd/zNz9JJKspeJsiTjJVXkuy3mItPietJUCA8Riu1DUKceuuo5WiJioMVaniRw64+2t8dZkN1HDVA7Thzt7k+3k4bZ8sLu1uzUebu92Vtf682Ue10nWzKkVfwc/sokB4i6A4yqD4HLe2rS5/QfzlmpCZY1KT42bYXOY9O0SOw7XseML66EbCAM7lrdsL54dPyP6YM3kyW5hq5iSlk0Xt9ABKSmGYWntfAsdW+jYLj/t8vPTLD8tdGxzt83dHzN3vwg6Du+CjsMvgI5DQRBrQhDr74SOKXAHQbMJnAIdkgrmNQQbC6iCT3H3Maa9l+VU+RroNVDk9t46ijy1VjyXZr4AS66xE2mW5qLyhrE5jS0XYzWdq5iiRBqBqqWBbimqdK4IkyJ+RDw90RekEOiW897+xEOrkDOLeKu5aJNkFSTkopBZ2nu1iDGNcFITgn+gwPugUxTqb7jHGb31P+0Hi2PS+BlpLA4/JkpRztf7vw9uOiVwBOFLKhcnwde3HBcIe+bSoI1QH4tQvmoI2kL1Fqq3y3273P8cy30L1dvcbXP3x8zdL4DqEQ3dDtUx4LOhOsb2N0WNpZ5ScP3fETunSpSAw1vYhLF6usTgMIJTeKj9nJmcAeIfhFDer/yMMlOnZhSgey8gtxEqWtp5S4dkc4UwjGeNqf7QKeJRZxAPJQ8udXo1CJPcYPXkaofYEr4MqlVlhmkz7ws3Ggwu4XF4+qovC91HIaR5c2M/9BObDy52bqhfdFw15CoqYFol3H/QGerApM9+KjWlQqibzCB4jS1DQQ/v8TmFT9I38UjxHBqKQKYrkDYxLPkxxCzQk/zieHSfw3BNR+h2VmZXd+nzx86n9AhEbtHjJvN9khfGC0h5TT0S/+0ySvgUeeC+FivLBYl+NtheY/aShm2Lx0qW6CzCSZp7v78+vS+mBFm5ZFSO0LLS1GMg6V4hRLgk7i9OldAkXqVKW01nLPh+49wOpaCYZFBYvDEnSonzo2iEF1grjlHc2aQ0SXE9oVlv7y08k6oLldEy2l9akgIPaTCAhQayMe8+L5ncW2iDjzk/7b8xPfFEUyWjQ9k8JqrIraI4LxZ6yRW9vlaIfyyo9QK1HlNz969JEUx7noRz4AnqAJGQmWNrfTXzQK+3Qo8aMTwhqtdlIEtEOZqnrZKF175ajga9HtFryvHGvJ5prMfNaSKUMOGwnGapOBLJzFqnfhWCQofS4HxaIYu+WqwPxLTHGdHb3lwRqRdY9nQP6JLle4bEMCGY5JhWdwY3NuyzcEq+Y88i59+h907Fu4bO/PgcizCNTG3ivlpmYtgjhr1QA1yUP6xxFFjIbdKB60AIgIOl/7kSREFXal6gdWNVZ/IDnkNLQwJRmYorRuHLaFng4ifBL2h0PQYlmMB5ff4M30WkRQtdw1iLbYXrFlyXN7NYX6/ZLchb/zhKa+73pi9pvL/cfXlpsvm3rtK3VJLvp+7+TRWvrTQ/Y6WJcJnCjdnGvmI1yANaW98LpM3qmcJfvOVMZVyOrof7OMYwq2SKTHqKac7pZKYV7yIUSnpCfl2KK5tzHgLuUvKjV2RCU745VkJgib5PZ6DXF6/pDmICE1OLRqd3QfW9jb3aCaz8ipwkniwcBwCV55XBXMqxKhcS4XGHd1PtkioUIXRsRi00swzj6lmLjKSwIVP0uVkpc/dyQtvN6GRXnHgHL/jQxb1mGJI8Eu8KLhU5VhlHGY1rwu+7aCNyejOVFdQkooICTKkVDs+PTtcogpiJP3DYcjqIk9yAxoIItTohGHb6aA3pUWGdR0e7Knl9qTSeiVltmeoLpiqn+FDXo+xyue3+vV9TjesP34gsaNOMzFGFRia0kOedOAGjR3yJNHaRvGO00keiM5nBjjTj8pJ2WqipuqLH4QYpdZdwKuUN2tQJSob6hN0+eWH0Rqn/VLRV0LieGncEOnyLdNGufaEg947j5dv7/DPV6m3aG8VY7Eua+aoAC/EwD/0+LMVbTSxKeBE2o1am1JdUG839b4cU7/IW9BA/jM5pS+G/fgNqtw== +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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.** + +## Request + +

Path Parameters

Query Parameters

+ +Successfully downloaded the file + +
Schema
    any
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-identity-access-summaries.api.mdx b/docs/api/v3/get-identity-access-summaries.api.mdx new file mode 100644 index 000000000..e766d75bc --- /dev/null +++ b/docs/api/v3/get-identity-access-summaries.api.mdx @@ -0,0 +1,199 @@ +--- +id: get-identity-access-summaries +sidebar_label: Access Summaries +hide_title: true +hide_table_of_contents: true +api: eJztXX1z2kjS/ypT3B+7oQwGDMamaus5FmMft7bxAzi5vSSVG6QBtBES0Uh2fCl/96e7Z/SGwGAnz+5ma6q2NkYa9fT09Muve2akLyV/JQIeOr43sEud0lyEA1t4oRM+dC1LSDmOlkseOEKWDkohn8tS522pJ4LQmTkWPcbSFu8PSraQVuCs8AZQmywcybo3AxaIMAo8yThzHRkyf8Y4UWcyfpjN/ICFC8HkSlhAXNjM0Ywwiy9X3Jl7zMp1zD2bhQ8rUWVdFvofhcfunXDBhqOLD92zq8E1A4q9/miif/EoXPgB0gOmAvEpcgLoJPSBvOtC14rVKhuJO0fciyBmCa7n+7U49O3K9QdBQFJYEfYAQvpS8rHDBsrLsb1OjkQnENwuvX8Ega14wJcihO7oIQfFtuLhAqh5cAN+OTZSthZiyUudLyUcMVyVYeB489LjQSkeSqkTBpEoToHYKcjBGfQgPsNNF0mL2dHJ7LR51GyL02bruDFtTacnzUaTt46PTtv2CXS6kVHibDur0IUXLVEeo+FlH352e73+ePzhZjQ8H9CF/vVkMLnsX8G/IJx9RoY9ZLQpoKljTiiWOLGgdaBadyKvZbmxrvGQjOxTJIKHdGius3TC0joHV/wzgyFNRYA8BEJGbih1x6Du1XfeWAj29vUR2cA4BIXlgc16vusKiyR/k8z++x8XYbiSncNDGzh20Sqrkjvuyne8sGr5y0PQokO+cg6lplOxEjqVVItekdYu/QCm3YM/lzTFqJypNGegvSIjhUartmHaoF8xFyguRUZdOmrAhaXjOUucS3huyT+rv4mKLWYcpEC/HrdJ05/NpCiKc0iXgW2QIHqCWQTmpaTK4EaV3coILO4h4yLI4Ms0O2UU/IrPHY+HoBiLwI/mC6KjJ+a7mY6vmIxE/NuFb/mRV5T9YMbKaGRlMB6QKgh+5a8iV4lSsPK/KhM/5G6lh0+XUaQr35OCLcCRgfrTPGDDDeaw4EDRj1ybTYW2DHTus2Te0I+XlU6UGTheENXcA4nZMGMwZ45nCfLXQobgRyCGhMgKo4GQM15wsHHOYI5IONjeAUdnhQc4GvL2MGNL4dnQseeHqClSYK9lIvITjbyMPBG3d9yNhJICtga2Ixlz811okHKXBSWa+r4ruFfK6Ak9uVVXZo5LkWlDX08EpNS7KrdcdWwmPrF3OwPLu1JBL8+Jg0SZIokaQDAhFr588ELww+qxKWqW9zvP0N+UmICziubzFarKeXwVNVBGq5UfhMBejHNmQMq/x9vgyVxbkhkoMOYHsoMUUD1RkvBYudxhZfHpgHmirG4lsk1uOV7+Fk5iclPe65sEBVwB1hBWpR8Flrje2E4RuQl8GJ3Y0nJrvJQ41ucpTsazobHyihQoYhj7Rp2ijta1ZQzd/sl1BSWzriljdW0/PQHp5ye4hDAydsgSBduo1fCfvGwutwBvEKLlQ3SBoADP8NXK1bDw8DeJD34pzhgPAo6TjThLZq77099gwIVZ6XpM3WEL37XjSdF8kMOFgU8F3lAATiDiXQUo5NBRQ1KtN/WVb6furo89CxUJHKreNAqm7rZhVQCIw9vryYfecDTqX3Yng+E1/H19PrjYhGD1hVH/f2/7Y0g8buDW6+6luoN08K+bm8tBjyjBr1736qY7uMj++QGITfojvALZy+A80/jydqzvDK+v+73JcPRh3PtH/6q7hp4PShfD1/3Rdfe61/9wMRre3sClwRk1+TXzZ4b15JJmHi5dDs77vV97l/0P40l3go1uuuPxm+Ho7MPNEMaAlDSWH93SP+Nh5tZ4eDvq4dVJ90L9/wOMpH8xHP1KP8e/QF/j20vsatS/GUKmlvxGQq8Hw8t45PE0dHuTwWs1BuDjFzW091n/kBklOTq4dBb6E5xe8COQTG3wPEVtGZyhrqCebtGXtMOGdVo/qZ0ct+vHtZPm8Umt3q6fnh41rFa9dTSbtrFb5Rb36Rhb7t11P/Xl5C96EC6498DOeMinXMKIH9F3pq02GZAHMJtPU9iQN6h9BeakHivb3wZBtdr1k8ZR7bimBdVuNqzjo1br5OWC2tZj7/qnbLibTqdt67hVw45yBL8UhPB0/4MUiDE+9aPwSS4unDuBGJTbh/cBzGni+lSaY+lJs5NJwzlw7iDszoW9Eb4ltHVMzcO5Irc2unTgwSmIC10vIOeku9wggBH/3oOs49laE7vh3dNIbhlBvO9BZjdFy1P2W2VUPXKU5Cp4u7TRzve06risBZpazRFq1dFmW/ZRY3ZyWrN4vXVS16p61LIbYn+1/EcEyUcF2UXJMNuRK5c/JJoal2F2jazrOhB52bkI5pH0Cf0sAWrs7r+PzRi37QDV6xk9cuqxOlM9/j1+TPpwEdSzhF4kdqaxHEcCmgvItd5A7ofAsOvZxAAyzEPgcBqFhBifb8/J46AVCsER/MzxvBSYaQ5nue5eY+a2X38qyXtGh084E9V6TDhpSBYy2dsAFLqKEZJCKVkeKPdURaUVzCva7LoNY+bgAOJNRiFzjM8DP1rJlM+XzYnmBp38/cKxFqrwmWVjCrjYm+f7Hp6NK92zyliJM2Fhf/HEsG0LC2InB12A4HeCnUESYkFm9cAq+u+Um8GzQcGLOGmfWPx4Klr1ujVt1meQ+x7bU96YWRZvt09qFjK04PJGBEtHSuhWbnT+X+HsgTpWSRLy65EEXWmm/2/dPcWaRI1V+MSMxMOISNWclLlNvEF24Fsq6HwFY/cLAYwVoAoFIapQ3fkf8zgLIxx0b7l+ZF/4dwILWC9gYQJktoiFSLN5THvD2DFH444nEdp115OhLAf79Ih6cNYdE+TYwPb6wO1NfW5J9mKyW9Dg07Bh5UPymYMQSa65OZm1XA7akixkxM+rrBJz2QflOZW9yoIg3r1jyjuSSBJc9lRum+f4br+A8zobbIjLfAC+OLsZVRo1xOs416Cncz/4CkGkFP7cotB85oVBaKdCeRNgbGtBNeeNtfA85euk9kyP6RqK4OCeN/VTrylpq1Lx2PID8c0GOSCajIimy4ja3NKRXgnbiZZ61pNsNbU2hDbKM+4DwffJUSS43UhuzpvyI/U4xs0Y7e2LFyjWJuuNycjjUazhqSLSBcyMQ9rPvRbToF0eP2WFvG4UAIINwTKSboEF17c+/u4M6E4fD7amTqYg9V0VpAolUJw/vdMiNj+cYrLFs8kwW/rF1TRH5QCx/V3797j8E3DQh8gKo0Dkk9h9ql7Pq3Hoog6EFd9yeMxWXLotWHO+uNMScXHnqC2mjVNxnM2in89IbDO66v9UrmxBihuKvQacLDiAYxaV0NmwovBmIbzsmNk9BMe4i9z4a41apdaEID5p1Dr1eqfWqtaO2/+mKObbqnb3/8gTxP+QJR0VOWshZ/WTTqvdqR9XT08UZxyTI1CvgSed+SLcA9/FLdUyfcxBTKcQRXSDwdnuAHJ7m+ZXmzTMatq23Wo26vZJq3k6q/GpfVQ7rR83LD6zj6Z1HE8k+Vyc8Qe5ES7st4/htLYxtCXgwgbyaiElGXPCZLOVZWIMwfZJX94bXt1c9smR3V7/cj18c110HWMVsR0VTGiZKJaR6p8CiV4nxC1PkffR8+9zCVTaURZodNcnP49D1D4o1NV+viaYWxncDZmeUUHWs6/QD4t72OBmODiXml07jt3MycyyG7X2aWP/Yt11prbxRId9+Nd/EKISl2epvlehQu6GOvJL6sZP9J5ZiwRWM3BNbzNKSsqE5jSrz6kkf6NK8aaEdY9s+Ztlx8Kzz7StfQMHi9qIdxnuXKHyDscqXPBDkheJzysnWCuzgZ+tV+qNSqM1qdU69F+1Vqv925TRTRn9JWX0wvY41KEtHiu/yre7bNBN9uHmfEoR7OHe1nX3tLUeYFYSzUqiWUk0LtCsJJqVRLOSaFYSzUqiWUk0K4lmJdGsJJqVRLOS+DsxYFYSzUqiWUk0K4lmJdGsJP65VxLzJvb0lJ7FJ5Hz1eisEVW36fzaEk0N/5s0Gp2jRqd1Uq3XmgXTejkvOePZm6PGBo42yq+bW3rFRNbfvAT7zUvxI3+/ldjTWntm19qnzZfX4AtddZUN47HJeDlWfqO110JfeEGduKaqoFzzI2g1Nh5MDSnVSc+9C5wYHjysKYX8Q9dgTc3d1NxfUHPfVR3bXQ0jK8qXwTCg6Lc47FzD/5o1+3vENFvW66tF37tlwT63x2V38QR7j1dU1xzA5kVV7Xf2LIiYLTRmC43ZQmNimYllZguN2UJjttAYF2hcoNlCY7bQmC00ZguN2UJjttCYLTRmC43ZQmO20JgtNGYLjdlCY7bQmC00ZguN2UJjttCYLTQ7t9A8t+yfXendXfjftcxryv2m3G/K/abcb8r9ptxvyv2m3G/K/abcb8r9ptxvyv2m3G/K/abcb8r9ptxvyv2m3G/K/abcH5a2NKEic554+uX2B1Xijrl5u+FTivlYgf5qq0dpgjtpTDkquf7SJyCJvjd3PEGfOl3bRR8XsV9Or+DMc+VbkbZMS7j5Cq5GB0ktVZfzStOAe7bvVeeA7P/OraWoSN/lAZXcEs+Q8ezZYWz/1F8yjJ8VeXaBiUOxKJdW0IoFtKIIsqWjtapOsWqhXFsmXVcXNuWwGrrmMsw0DXybIG6VIqGRr11q0LdHsylT5qE4lchnEu1mlopqc7rW5qiGZNdyg/iRDG5/TwbR3PS1057rYGLVDwKwygobZT47jYqjDyKyqW+TDTsekFfF6ed+DHVLsmILELfb8+09MpZzmOsKKKKDHApi2YIHGVC8c+iDqfT5Z0UyyR+wXR6IgCSqdfYzt2G8anw9PRh0DgG3PgKtfQput54Dz7P4kdwCU7Fb0RZ8elw7bTRnx03OGyfNers1PZ3xI4gRrdNTCsN4Onq+R1J9IcBQHQtBOczIf0EgEPARZlA+iZ3vnxUTjT1rnaptMkzNLwvF5/CAcfZz74Y12xDpvXlE1/l8TQhe5XZcSAxVSgOEh4EzdzYeb4zj0Vn/vBvDX425kdYmOKvjkU8hcQHoNEwHgHhECjzxKOwqK2uqZRgQ92S2oaN+yQeJXxnV2RU8oXvf8ESWNJsF/jJnSmQ3n0P2o1MV1QM2xWtk1Ay9sh0X1svoalZh5VJLsqw/If+qyrq27eAguasWCCQ8T8tS3LbVt5qRwCxCBE6AGBNrzw8daw2Qp6IsID4dIS+zk4LGAZzv1hMI2hEwR8PMWmGiLZpFPT/As5JcnrtJRmgkUvwoNcABaAnJKLg7LJAzCAi0rqDdEX0bGhyPF7dLPFY28JO7u1LMQAqi9gfwSO5hdzcuuJ8KDS25cSe08VHAVd6IZiOeJu2RdDSmh3WrZLpiw1dfrza2a2zX2O6etrt+c6S/8a7vEvSpF6HPrccjkG9AwbMAfQLSHg/SR91IVUXURB5gDqMh0j/fTMCwP0K668SHtb8lPlKhvMB8N5kPdX3q6M/Fx6E/nQtkkOSoRjADTyTsDvGdckyCUqI6KvZ27gdTBxTU2wAR8bQ6e/AjxkFkQeR5yAmXB8z2hfR+wIWcu/x2ElqStSsrH1JcgyQNkjTRyESjv040MkjS2K6x3e/Tdp9EkglXZC0aJ0ldPFbLZ+o+Fd4ZNMCdDPQ8S0wuWZvPohUkxhKMVcojh9K0UZ/WZ21LNG3etI+PTmcN67jBW+16uz5tNqhwmMT6t6kdJ0aWt6nMfKt5VDv8RHAnsC4PyiVD37fz5T8QbyBm6NbQ9SS4GWQOIn2fYsdmETte+yGMDQgDdgy2lBdvR5dIH18jiOSTHSAIs+NNh7hFBCEl6jBI2pGhgY4GOprwY8LPXyb8GOhobNfY7vdpu8+Cjs1d0LH5DOjYZAixZgix/kjoaAPuQGg2g0mBMehtg+tb6WOzD3kwF2EC9HIosnFaRJET32dXeAJNgyWZq0R6qbjQvUHbJbYN4rYOvul2Di7Sw937jq9e/+osBWJSPGLpOkuH7BgHBHSDh0p3FsKolM3E+pb04niWGwGH5BTwFAX2e88dPFQxQ/gHFKgOOgdH/Q1rnHq2vqoezEY44kscMet/toRAm0/qv61NuwQGwHyA7mKs5nrLdgFVM+cepBHi80q5rwSCGqhuoLoJ9ybc/zXCvYHqxnaN7X6ftvsMqK7R0HaoDg32huotfEs7S7DUOR3T+b0RO5mK5oDUm/kWYXU7xeCEK0CVkCFA6ehDeLiAH4cWOpL4BJ88/OLYj4dqab+iZARe5vALaswjPKUyA8VoFOBu4kUYrmTnEJoID+btscpXTjU+iuX597it+PDuaIM3Uq8GQE0Cf2ZH6kMF3ZuBTj+qJPXAQcVWXpA6UHOgD0SVJMwF7Tp4kn58oPwBMhOmyBzgMRitZHRZvw/jB0mtq6RUhTHC2G4D93HXeF4fPTUORWTLODaJ78m+oD0DLteGh+y/x+kCRQBC9I4A1fstcNVTTqwboQqk4QUXARqFzobYrMF+FjzAs2S0L+bHf76ZvGJzBKDkACKJ2Fc4mDGACd2AipCDS/as40MUcwI/mqvjPN3cLhw0KDZzYcDsnTcWgr3NnkEagasmkeJDgrwDPvX+x3hmbHEnXAyK1VSSqHiO7R2ChA557rlX6jNHmCk46XnF6jsvPqSPpkBt9BAp8WNvV/G4eGZcL2XibzG1ijY3oiZfrXGhRPvWUru6LbBqJMFdSdJ6ceeKXiVDD9MquIJU13lASWg+8nunrHjWXsxHjl4F6eX5eOe9Ud/QyD3GlDNjEoKja7MBsxa+L8X/MIaqg2bwdh6BFb2YLXq9QoUsotKoZViqqC4rTgWwIvF3CYbhKWVSB14JqviqakIm+R+aWbD5/9A7M/6TGzNdfgshFVvaviVfzDN2WMEOK8oHSM2/ilioWGDbOAbyA0oBeun8kyfQjGZ8nqK10asT+UN6BkODBawSFbnqqB+d1MHpvxjdwNZJG3DBCLWT3WTwm2laGLZywoqLBOsSLPLr+hAt1+Sm+E2WOjGC/tnGiyPuprWUoec+fGsvvcWT/Hn87h/k8Yyn+St6Gg1+Ud2o27XXSaGSK7RWrOxJek8f/B/ukqUSysYXLCRHkrNkVi4PUafJpq2FI6gmsBJ4OM8VB6hX/pLsEOAuGj+e0EdCczrXGwDDHLI4x6U3Z73BI34WiBgTLtyLC1R/83XmNQYp3+AksbN44gBALZeRp19/EC3x61O7Ztd2pBUpJwT5lyfikfkE45KnYotEtUFRVCn1CJZyOMPiMeSlmUnc0RfModSVYxAknUxWZ/vSgYyEq3IRaJeH37tog+ZUFsJd0esUgC1I4DI9XA0mBYpAzNPLFX4wP9QPyUNsC0Qw1VHKcFSFRI9ekefLEPLTDF2NccdxsrSuSF/SOrkC7uhP1bYZfDFR/EZFHRCSnCup0ciVsOh4dfqCCwvSVe7MAX9lkzcyeYwSVdbVEYCmczi6+NA9uxpcIwLHVynoX9o5qKO8mKrjrnFSBgxJoWa1ytRxW9SD5MUa+X7xFUZg1usPlpLDpJhsHK6wbEanpVXyoxLQt6V8AgoPdRwsfq3noHiDyEFas4BJwEe/fMGiC2Zkj3j5UyQwo4fUNH2fx6ZXZGRn5Ip/zhyyhrwfXIf+PB7OUFUHRZ3RjUOQMQ9slvm03g0PQBHAIJ7hT6WmA4A3plNZJXS2hMlt8vwosIxB611poaJER1b3l8NwNpMiVMfrVf0JplKJA/LYsMpuZUTJcqqOpFxl6rdMVU8OkEu93TTN8rREvx85+iSIlwtyMGNlrMKVmYPuFKS48leRG7/1tfyvysQPIemjA7/ltNKklyXTz+oWlRL3y90TDKEXhqULdfEkoAMoqwGU2T0t3s09HwtBCB/GjmclNTmV0YbIClMvU0ArVgc7cEWVxIXt1VnkAxwNuQkQ/1J4WKnEpWGYdimw1zIR+YlGXlaLh8CtetshSQFbT9VrBRU334c6xC+EeKE2nDsuhvZ4ClUgJa8eD5nqop/jNV5VAP595QJwDpkEziqaT0Kb5/FVKsomb4mJw9IMSPn3eJuWKyQpH/KAFXvZQQqoFOoFEXa53GFl8emAeaKsbin/DkgvueV4+VsYX5Ob8l7fzL4MM307QLFd7jO2W1o+PfVKLPLlkz8Gif3Jp14Ci+sTP1bX9pt2EGZ+vp6WKfa3LtP3aX30mcH7x5FGLa9ol8cufDQ428ZcvN7nPWQ5i5l27GdO/Bpf8ctENcQLCE8xXN3TQCOgZCEH/V7GKd19fI9v9KRwQvJUt9SCVOahwpYNnIhkkeCiDwj48f8Aslkf+w== +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Query Parameters

+ +List of access summaries + +
Schema
  • Array [
    • access object
    entitlement objectnullable
    owner objectnullable
    dataAccess objectnullable
    + +DAS data for the entitlement + +
    policies object[]
    + +List of classification policies that apply to resources the entitlement \ groups has access to + +
  • Array [
  • ]
    • categories object[]
    + +List of classification categories that apply to resources the entitlement \ groups has access to + +
  • Array [
  • ]
    • impactScore object
    account objectnullable
    + +Information about the status of the entitlement + +
    activityInsights object
    + +Insights into account activity + +
    accessProfile object
    owner objectnullable
    + +Owner of the Access Profile + +
    entitlements object[]
    + +A list of entitlements associated with this Access Profile + +
  • Array [
    • owner objectnullable
    dataAccess objectnullable
    + +DAS data for the entitlement + +
    policies object[]
    + +List of classification policies that apply to resources the entitlement \ groups has access to + +
  • Array [
  • ]
    • categories object[]
    + +List of classification categories that apply to resources the entitlement \ groups has access to + +
  • Array [
  • ]
    • impactScore object
    account objectnullable
    + +Information about the status of the entitlement + +
    activityInsights object
    + +Insights into account activity + +
  • ]
    • role objectnullable
    owner objectnullable
    accessProfiles object[]
    + +The list of Access Profiles associated with this Role + +
  • Array [
    • owner objectnullable
    + +Owner of the Access Profile + +
    entitlements object[]
    + +A list of entitlements associated with this Access Profile + +
  • Array [
    • owner objectnullable
    dataAccess objectnullable
    + +DAS data for the entitlement + +
    policies object[]
    + +List of classification policies that apply to resources the entitlement \ groups has access to + +
  • Array [
  • ]
    • categories object[]
    + +List of classification categories that apply to resources the entitlement \ groups has access to + +
  • Array [
  • ]
    • impactScore object
    account objectnullable
    + +Information about the status of the entitlement + +
    activityInsights object
    + +Insights into account activity + +
  • ]
  • ]
    • entitlements object[]
    + +The list of entitlements associated with this Role + +
  • Array [
    • owner objectnullable
    dataAccess objectnullable
    + +DAS data for the entitlement + +
    policies object[]
    + +List of classification policies that apply to resources the entitlement \ groups has access to + +
  • Array [
  • ]
    • categories object[]
    + +List of classification categories that apply to resources the entitlement \ groups has access to + +
  • Array [
  • ]
    • impactScore object
    account objectnullable
    + +Information about the status of the entitlement + +
    activityInsights object
    + +Insights into account activity + +
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-identity-certification-item-permissions.api.mdx b/docs/api/v3/get-identity-certification-item-permissions.api.mdx new file mode 100644 index 000000000..a75b41035 --- /dev/null +++ b/docs/api/v3/get-identity-certification-item-permissions.api.mdx @@ -0,0 +1,95 @@ +--- +id: get-identity-certification-item-permissions +sidebar_label: Permissions for Entitlement Certification Item +hide_title: true +hide_table_of_contents: true +api: eJztXP9T2zgW/1c02bvZNiUBQoCSmZ2dFGiPnbb0IGzvhna2iq0k2nVs17KBLMP/fp/3JH9LArRsZ3fbyy8Q29LT+/4+kiVfN6JYJTLVUXjkN3qNsUqPfBWmOp3tqyTVI+3Zh6mavlHJVBuDK9NYa6RybBq980atmWm8X2v4yniJjukaFAcTbUT/zZFIVJoloRHpRIm4JCWkMZGnZap8canTiZChYAYCNcV/4VXpCw0+xFAaNMYVkVp8/r0RRwdt0Rdp9JsKLdHjkxe/9A9eHb0WUSL2D08G7kpm6SRKIK0Al4n6mOkEpNNIeDIIQN/y3hYn6kKrS5UYMQIBvl8f2APbMjDzHaEoo7yMRoCyrhtnRiX7UZiqq7SPoUmB2g97NVq9REm/8f4GqoxlIqcqxbjcW5NCP2YqmYFuiCe4HOmAn2Mgb6KmstG7bqSzmB6ZNNHhuHEzb5Ln3AXimixIjcgMWrEuTSpDXya+MLMwlVfCdhtCIzoU5z9vsR1P80b7URAoj6V/U/D5/tEkTWPTW1/31YUKyLvaRuogjnSYtr1oug5512Ws1/PBWl5Bp1XK+52VC5y1HJ+P34Xvwuf5XbKXyeI4SshxrFEU/gdBdEmPR1oFPpwrhKOwh0eJ6RGFZjOVCdy82eyJpvq4Jsxl095P9HiSGr7vSb53WgwAxuPIwLsq1EQT1NfgUNy2D7PzoOJCBpky4hEMH2F4K4jtF/rmsZAJvBYu3NKhUSGI6gtVuhV5DdE7DoOZkIJsEygeqkm+28RwFW6qxMGUmMqZGCqYVPltcZSKaWZS65fuLv6nlwphIYXVQ06CNCWF1YG7tybCKC06dNxdU2jbwFZWZub4OW6rKzmNA7U2Zw3IBa1ovyc+/Oio/GCHeuLJJ4/+2ensnxz2B4f48fgJOHlieXuiPj7BrdP/nraPn/3UPxv8q4PLDzTYYJ6+Dt0Im582QvXh6eHLw/0BPdpEHDkZEChOQ+qjeNeoMvGugaBy4RhLhHERjbVARka9MyrzfNPopUmmFhPnfHI7Oqhxp0ZbT0d73a3urtrrbu90htvD4dNupyu3d7b2dv2nt/FIOfJLs8Z5eY6/jre3+XTj6c7u5tAbymF3YxO/fLDq7+1sdjq7JX9zKS3QU5025gd9hYQUZtMhufuoSF5I1bawwAVPlfqTs9RjjoVphIjWIX5OWRuU9UsFjhB+qqKXzvbGEtVjXDVWCXpaMvbWVgc3pjrU02za6KHfVF7Z30zFVyMJLfDVzW3ajEYjoxbVecy3wTY0yMGaIYFZrQo8aIszk6GUzYSJlQdD5+W5ydZpkuJjOdYhCjf6J1E2njAdZ5ivxhx/wBiF+m9Xvhdl4aLuj0aiSXHVRNxAq1B8HMVZYFWJZP+f1iBKZdDap95NUmkMpKTEBMAA7s92oIZLwmEiQTHKAkr0LjKofI8Ku1Geb1qfaAogGqhqHEJjNoef6tBTDISUSSmzokwQK4IFYZQzkShXkiAcK4fa62ksvXSNpGEYBYsBu/kYmAoIPAV1DqM2mcgPLHmTeGJuuVxaLdhyY6sXc/NVeJDNkAtONIyiQMmwUfET7nlDwC43qaEOnY0N+lf3kb4INGo3bHsXWCYvGAM/2AzMWd0jeAmnA0UZx4HL0Ou/GiJ7vcinTBJJHksETOV+NPwV6lnw3VMYO7D54GBwXGCBcnIgbEfAs5TciqDjKSzxhiwBaO7LVBKAbwuqInRFPiPH40SNWa5REk2FB9wSTeHbZmaIL3ZbtBslSrXILsBtEWTGgzhWMB+5IXnnhUxmIqC6HcwK6OLr0QieTg4caPwz6zl9Q6aNE/KXVFtrWGCwREFz9mGYr3LE9Ei1x20h2Z/gRezZjOdK6wGHAa6YfOJiwQV7lvQJ7eWeNG8IV5WrpdUClgbSjsMoy5ov1myHZ+ozMJcuxtAh5HDi5D5f56zCANDQi59/+cfgpP/6tL8/ODp+bbmheRuel+5wkEZ4ckMPu8v8fJ8tIg6TBJ7UwkSrTFm2nHAqEsPIn1VgXvsBjl44dN3evkrhnvuRr+5X4nMdqhY0pYlDxSx76ChA8UL7lC85dViSFLskArdr1+wHTbQ3xTPpQ14r374ThnSYSO830KIJ+X0MnYUa/UXeRehyLrRkWLWr5HBnY6/THe10pew87W7ubg/3RnJra2Nve2+PRp8qY+RY3R8AL1SImZgngghTXv07FAJ3ge6ZAR78rqRStwHT+AT9kxPbtoWYjl9BU+o11KVn+29EdxcpIBxnfF+O55QQts5OqUID8MhhnsAhuSV8jAjQ4dLwC6nunzcODp/3z14OcOfk8N9nh6f4RbQWVj76SMqhT24ZcY2eRJfMsRPgUiJFKipBNFdrOqpNCCTdKolrqO2VzYTCFRP0cKMv6VElbfNpNZQ8u/4gHum2aq8hSeIe6pw3qS+sNPuep+K09dJpsungx+O26Pu+JiGBC9xk1807pe/bjG8RJUJZcZ2KspSKu/ZU3RalKuvWKBPJy6pRKDjA+f1+0vdSgFf2iVoUFt7iWHT2Ac9Wc3XuBhWlsUppVQQZ3mNc7EUJkA4yE2SjQuTSES9MIPGEebsiY1XzI6e7V5YZmyGRz2RmPiHu3gRIPy0WrXhwoVzw8YTIZiO2Rm4ml5Ec1ufOrlVhrjzw7Yx+Fbur2F3F7ifG7vzDE4fuc+xD0GdzEfqchW75mYrnAvRJ2HvCKF+j/t2utFhD0rJjDpF+ejtwS91or65imqV8QXxkS/mS+UluD7dKnC8i56W/tAUxyHq0EoyQiZTfY75Lji1IZFVtLY72PEqGGg4aLoGIyJqJmEUZL6wmWRjyvNWsCT9SJvw+dTNWRIQxNgPSqKHfspPDFZJcIclVNVpVo2+mGq2Q5Cp2V7H7dcbunUiy4IqjxeEkk02nMplZT3PPSVop0KB8dVCEHJtqHq0QMVFgrEYdOTSGnc3h5mjXU11fdv2drb1Rx9vpyO1deqHX7ew2qrX+vIzjIsjqMVWxt7Ujqxgg7gI4LgvhXCaNIr++/Af1JmpEaY1ST4GboXOo9H2JHbuL2PF1lEI2EAZ2TG5ZXjw7eUn06e02kSe9RVniKYLZVnV2SZcgJb+mUFfapCvouIKOq/KzKj/fTPlZQcdV7K5i9+uM3c+Cjt37oGP3M6BjVxDEGhHE+iuho6/tfpOR5q2MXpbwK/9ExRAFv9zqowt79y48B3o1FNnZW0SRgygSr2Q4y8GSqa1EhqW6KL2h7ZTaJnlbTRsu7UYNZC0NdEtepaeKMCnt++HdORTHJBDoJrNWf0T7Mt2eH+dvxSg69IIMHHJSCCJae43gY5o20IwI/oECr4OOkai/4Bqns9YfWg8WJyTxS5JYHF55SlHMF+u/28t2CRyB+YTSxam19S3bBeyauQwxjVBXsU1fBQRdQfUVVF+V+1W5/zbK/Qqqr2J3FbtfZ+x+BlR3aOh2qI4GnwzV0ba9IQos9Zx3Jf/ZiJ1DxXHA7i0ij7G6X2JwxhVwJXckkXIIHWHpNdZrx07M+vXcgZubdfuev5Xwgb0W56T1a7s5+mY9rh1htPMGK0aWBCCfbyK/hnVh1Zu2jHVbuwORYXTJO8kvtpbkKtqa6s42JpGf2f3ptG/dDtJmmySa3N7mSB7AWsjtDm8UG9bvpE8nC8j0M8xbhCWzJhAizgX5Nh0Qw/zje8Ot2+xyCzJCtrMkuLlPHrf//hY5LJFb5FimvjvHQnsBLufEI/bflwcpTwmo29EXjlOWxYdeEXQWBjumZh3xTMkEswi7a+bRT28Hj8WY4CmnB3seUmmaTyDA3sBFOP318x0k1IkrUnnqpV/bo0PhJkYBBBbuEEN+qPY16sIJEjmrlDopzh3U69OPMMhav1uOLLwLW+JAJ/aEgz2z50S0xzrO41wuWZHroUx8l1NrufhjanRms8aFVe253YUvPMQ8kZCBYW09eHBLr1Wh1+Lt7C2iOs8DacLxUd9Z5eVWezAfNXotolfn4134dqJRe+vdhE11wkx4I/6R8CZRZNSPQpDrUBicjzNE0YPZuqRBWxwRrc5GhaWWHbKlW0CSzN9LBEZonUkOqZIzkInsmgqH5Ae2LGL+A5/J+FCTmW+fo+BSSz/yPuNczhzPNGCLBmzZHGAc/7aekWMhtkkGzgPWAfZL+3MmcIxWcp6ltTSrM/l17kOlwQOrTMXEPXvRKxOc+yX4AbUu2iAFExAv9prRYXBHi4paTVn5EsK8Bhf5DSLU0jm9WX6LF6FUX/9u8pLE/XKlhU6SfOksfUsm+fvk3b8o460yzbeYaRw0JnfjYd0courkFq0trvsZPlqKv3jKkcoYHDOc8hxhlUwcyJR8mmPam2jFKwaxosN7dLwfIkRTjkPAXQp+zAuZ0DhBGzq3BzQqhzoAvbZ4iylZ6EHFNB2jnbqg+mvk5mXF4UBxkBsOAGo6zUL6LAeYyKZCwj3usa6vjZfZJITZWahyySKGcUWvPCLJbUgVbZ6YJFNzPKKlZcxaK0a8ZyzY0Lh1ZSiSLOJO/ZaCnKjAfRhlbQ5+30cbntOaqCCmCSEyKMCUqozw6miwQBHEQvcyI0rG666TWae2IEJTHesMW21MA+lWHJkUs9cK3co3Xji9HVa+xLJf/xgBplTzbnZdrrGvvvviShzNTdZjWoMjjWd2rmRns+f1z0WQj/QWPyCxZEJLDYvzvtU5LWZJE9iUSF9fk7pogndDt+25dJrpwsEohsuDzLeacPWdmNV3Ylbfibn1OzFLA/w3RYt05UeZ3EKc/WDMp4fe1/Wxkzs0kX/L5YF6+P/6Sskdeiy+4vJARa4+OfL1fXLkDnfIvytTesP7cmH2M8v8oxOHfx7z5pMl35xaykj+0jGcVfkoGJzDMZ/nrXeyVH5r6gF8Odh08x4trW+ztuxD+xas0m1hnwipuXgz8eKQQLi8ZUnD/eid0zuN/wF4JYaR +sidebar_class_name: "get api-method" +info_path: docs/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 'Permissions for Entitlement Certification Item' (get-identity-certification-item-permissions)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-identity-certification.api.mdx b/docs/api/v3/get-identity-certification.api.mdx new file mode 100644 index 000000000..fae4583b6 --- /dev/null +++ b/docs/api/v3/get-identity-certification.api.mdx @@ -0,0 +1,95 @@ +--- +id: get-identity-certification +sidebar_label: Identity Certification by ID +hide_title: true +hide_table_of_contents: true +api: eJztXFt32zYS/is42ocmOZasm2966Sqy4qrr2FlZbk7r+DQQCUloKUJLgHa0Pv7vOzMgKd5sKdn0evjQ1CKBwWAu31wI8qGmViLgRip/5NZ6tbkwI1f4Rpr1QARGzqRDN2t7NcPnuta7qWWu69rtXs0V2gnkisb1apOF1Kz/bsQCYcLA14wzLf25J5iMKDOHL1dczn3mpGmx6ZpJo9notMH6zKhfhc/upVmwy/HZz/3Tt6MLpgI2GI4n0S8emoUKkCCsGIj/hDIQLkwE+p7HTMRHg43FnRT3ItBsBgToenZhh/uMe7owMdmKq4RmvjJMh6uVCgytJrSxFDPEYL9aw94sJ2fqTgQ+9x3BzgIVrnQDJLniAV8KAwyBPB9qEqW24mYBt3y4Ab+kC39rZyGWvNZ7qJn1Cq9qE4Aga497tXiztZ4JQlHUgMhtkOiJTyB2DwmJWed4dtLtdI/ESffgsD09mE6Pu+0uPzjsnBy5x7XHW1xDr2A7QiMH7WYT/5ddp+9vVama/iIcA4s7yjcwFInw1cqL7u//opHSQ3GvycRVgBZqpOUDNgL/bnbSdk5ax83jzoHbFgetw+Nm68DttGfHJ02Htw6OW2i3GeHlZSVdpmag8pzEUMhWF+nVrlQYgCYv730RsL7jCK0j4yI7GMIwtRZgKjeaRt5uXR7XeJKBWKZlYtlYwI21FuI2Wm4zdWJ/phdFXQSB8LgR7pXhJtRwacl9lxsVrAdquQQ9jS15/BM9vEwJz28MbTD0JXgJ+HOyw4irxmda40YX2xfNSLR0vUFsqhdI9DFWUZG48MMlIV7/7bv+6OyiDOsEw1m4oFUNrMsN4tFUABHAiZkIBLi/m+MhJvmY09UzbLztX/TPhmO4cnV5PR4Mf758f2F/DvvjwXfPc/e0OGKyj7npuwg7dSW/CNPCIKLjNe4uJWD5AgA2EGh3gPPIhB96Hp8iFxbGNkz1nyNNQsvbcAGdCAVzowqSYJe+t2ZpeSb3NIWFqWDX/oYMRCY/c6EQSaLdK6QrfccLgavsjAgzwZnYizSEgtGEmXEzEBNbcIw8jDuOCn0IOLAIRqso9MGqd4JZtHnZSNvs5Xg8PO9Phqdw8foi9fM2Y4eb64/Po8BWezjFiAZ6hm3dLwRIGQKjJQMhMRCbAI1Q6QpHaoqWbojUcmIMCFR1g/2oQlJDNHlDEYlgsE4I7eEkyBnqJPnUZRgI8ksuNNhrvD3joWf2shxigC/nMi3Z/vn5z6fDwehqdHlxBdfHwx8u/wXGc3H+Y+b6xWXqZ0bomTuPCEDSZJBpHKOGtXScZkQadKdKeYL7BR18x8EaMmIBA4Y0asld8W3a69HfgPbGFAclq0gI2XMRlMNsuJyChsGfUuaMMgMvX+ZYWCBXCR9gvi6JO95YBo4O9mpAZcmNXb/TrmXYnCjDvR1ZNDi2nFFAI4SBTCq7x6YKks2YK2ITHLiMyVazjMsI23IJSrN1XG8e1tsHk3az12732seNVrP7Uy1FAXxO1I3cxO8nfSyGT5xBDqtc4P+3XTNeI1k0Uexb0OZnmwtkfwEkxfvWW/e586uv7j3hzkXKYiiIZs0mo4B2qQKS+f+PlezCX4aXbjkvYWksL5V/SVyFtAlHlKaG2fBNym41662TSavT6570OkeNzvHBT8iErUN25iMfjkv4Qp6QoSAqqVhU6qjZDCNTwal25zWmuGsNsD052aT2Me3fK+8sXy8uQ5O8Eyoe6e1GnYZmyWPUjHOH7ELx8v80UKI2AMF2SXJHp8OLyWjy4/Y0ctvyCaUsJj6d7H1dvKK8L4WTz7Gdg9Dfk8UMrD7LYypBiE3IOoxtNOSys8Rp8pvJOtEsALP4DVztGaT6Deu8pxfNoNHuFd9wPBm9GQ36E8jRchlz5lYFXBVwVcD1OcCVLnfSvpmveXYrOm2RT4MZ/CewcoPqsyQTYfccm8RxczZn4EnPlupKGoc9uMwOUnAL16EuHwaBCko6D7aDPqNCowSgqKSHmlbg9I3INzVdwtiMexrLNBr5VmjN56K43GlJpySzXrxQ3koKHpUIpNhBzvAMLK3gwo4A44RBgPqhKYUOzAf/Fft4NemfDU8/9tgk3UGSGpQGBRtYlVHYieGOkXfUhqFZ/cFk9MOwZBaNExHp0dlFQjpJW3E7xdQ1prFniz/q4zmQ74NNo2ElteAHP4U/lne4YNnBfhwtmQ0byc1S439H0kybW+lTmFOjYBAO65b14weeRDmTWbI6G9PzF9tIsj5KzyygzHWp2ST9O+5Jakx+pe68Kwyg/UC5O1jGG+mL+jzgEjkkswL5uoJh9SVd1PlSBVhzmVQAoXFZ0AZJNFrsNXfZONrfINoMSjOA+g1ojXaIvNe2Wx1PwShsHxeVLiuOBJ8eNk/a3dlhl/P2cbd1dDA9mfFOp3lycHJCCG09VqfW5kHA14Wlz4QvAukwTzmgkf+CQCwAEQOx90ojlnq7DojGjp5pxybbjPhlRnwy4ALs9eAd6x4xj/vzkK7zeU4Ifv36qgAssHNL+DKQc1naSY5953T4pn99PqEu2r+vh1fwF9IqRHJsk/oumqWiIn2h7onjaAMI7Vp4IA7s0L6KqL6CDXFqJiQDpf2l1xqEGXcBYUa0esmMNGmGSXPGlchvPhn2QjZEYw8gCq5BTHUWbAoO7ca48gqfFa1M/TyS5Cu2EBww5WWD9V1X4ia5x8AbgSjMXxPWuS66riUwC8GVBT0NVaHBRqV0sh2RlCgLMB9BynlaKegcwPl2O+k7JgTmaJtpL0ysJWIx0g/wbCXXKASUWGgk0rVvEKXxgevatukdQCbYGz4BjuAI1aUBePx4XIJYaaQcpoKjBUh8pBLqHfzunQfwU6etJTfuROR8GoOORSPSRqymCJHgJm6bJkejEnXFjs8gB/Dcyncr3618d0ffzd8cR6cQ0qlPq5j6XPvREzEMnoXUJyDrwado0aAopyVF0hOiKEX6/v0kOngC48WnFT4J+or5kQ3lxXMUiT7s9SllvLGyMrpABkmOdgczQCLh9ojvDcckKCuqTnG1NyqYSjBQvyRFBNQM2FqF9oFd6PvICdd7dADG/ybqyXN78oEQEFf13fpKSd9UmWSVSVbRqIpGf59oVGWSle9WvvvX9N1nM8mEK/KWKE/S4XLJg7W1tOg+HQlgMIDF52E3Z1pJVflsBYmxJMeqZTOH2rTdmrZmR47ourzrHnZOZm3nsM0PjlpHrWm3fVRLx/qbjR8nTpb1qZS+rR5JxJDE3UEeF/pgXNoo5WbbfyGecpohrCH0JHkzncl7vN3kjt1i7nihDOwNCEPuGDzRXrwen9tjj5Y8ys0em0WnTZ2RTM5Ui09Sf8UjwlXqWKWOVfipwk+VOlapY+W7le/+1qljd1vq2P2M1LHLMMWaYYr1R6aOLuQdmJrNJJ7VTp7gB2IFW4G/ou5j5PaGB3NhkkQvk0W2T0rezFCKveX+Ok6WdKYT6W/EhfAGY5c4NnnjDgZwNgeI9BmgllT2sJRcCsxJ8UiKJ5eS/Bg3BHSDdb0/M/jQn3wmtrdkleQtDQQFT9nTBnjwALxohukfUKA+6ByA+iv2OJdPHej4jH4wG+OOz3HHbPjJEQJ9Pun/HpSdEhjhMRmEiyur6yeOC9ieOfehjBCfVha+khS0StWrVL0K91W4/3uE+ypVr3y38t2/pu9+RqoeZUNPp+owYOdUHcY2mizJpd6gcf3uGTu5SsQBmTdTDuXq7iYHp7wCTCn6ugdiCH5qolfbz362Yv9Buo9w11YAlqEw8GDgwpiV7u3vP4CeQD+PDb6SjfiYt6/u8aD+/l2nBHXwkKn1MMAtN3SoasDvadhFGiTdQKIBW7SjBaysaT9oqiBzOl3wLP34JYY1VCDMktnDs/+RMdFlPL4LlcQ3mkY3yHgKe4S9XQfe47b9/NB5bh+WyBP7KBPfs2vBeAZc5raH7N+iukDhQIj0dQ38DCxM9UNU8s1teswVpuWWw8LITajBBwLtAkOXOKzNXgseQM1gz8i8+P795CWbYzJKYBDid16YkFg9gDu9AzMisOvH50VwEsWfQIXzBW2unzmRg87FZh4IhX3wr4RgN/E56AuIAmOAbRI7ThKEFDjr9kWsPVfcCQ8DZGMjbTRO6fr7IMV9npn3koIhVQ3Sty9D4OtDH/w6O5WIUfQqKo6JtkhFILtZxfviqX19KRP/iKnVLbU6UdMvc1xY0d449oS3Ax6OJLinSVpfvLilV0/RwxILriDVPA8oiYiP7DkqJ9baF/ORoVdHelk+PvjvFxIibXYas8DGNARKz2Uj5iyU0uJbxtB00FVu5iF42hezdY+L1skj6u1miqW6XbIu65A3En/n4Bi+NSY+xbhNaYuyHRRy24+kWcCFj/R2wcfMnunyDYRXHOkqR38xz7hgHResW5zQEf82eqFhgW/jHggHrAEMNvonJIgYTeGipVWK/ER+n+Zg+HCAVaKiVz37o7cBwegvRjdwdDIGYBrT7uRkGX5BIKKFISwjrLhhkJdgkV9PQeTMyc3ymzz2xGj6Z9sv7ri/6avgN0q+Nko/gSR/Htz9gxCvQpq/I9JEiTCaGy2be8kKjdxmdMUun6YPHsC/cJc8lTJuqGfst+kwh0mTWXncoE2TTzsLKag/sBLcYHa4h3alluSHkBKj8+PncpDQnN78DIBhDhWd9PAVSvYeCjDfARFj8YXncoHqLyqqwq5Ayu9QSew0VhzDD/eEPn5NCJgIlww/o7FFu67UTmhBCGoxX8Q7U5TGJbNij0SzQVE0qAwJlvpyho1kqFFTStyyFuhQR11kECS9wGq/e7fZyBg/goRAAOOyKfo22mA59YXwVlj+AYJCMiVSK7wdTQoUgZgfPbpQwXw/mqT3cSwQwXLIGkOnAUUfvf2otIFaNUU3toHcS6fTNRud5o3qYdM/r76WuPVriVHEw1Jlf4UNOFRAaMsrW8re1LI0YVJPuvj+5QL0hPcfHrBHg4XdI14GbrABcHO7qduofgITwr/d6M3bZ9T2Ivo0lvvSvnxa/NpiKdtxd9FfbxoLNfjzV4H9CJgHVTtwTQ0j4sjesC2l1JTCQxcs85Iy/2wIdvv4P/EMDFg= +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

+ +An identity campaign certification object + +
Schema
    campaign object
    reviewer object
    reassignment objectnullable
    from object
    reviewer object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-identity-decision-summary.api.mdx b/docs/api/v3/get-identity-decision-summary.api.mdx new file mode 100644 index 000000000..f916fe7b3 --- /dev/null +++ b/docs/api/v3/get-identity-decision-summary.api.mdx @@ -0,0 +1,95 @@ +--- +id: get-identity-decision-summary +sidebar_label: Summary of Certification Decisions +hide_title: true +hide_table_of_contents: true +api: eJztXFtTG7kS/isq78MmFLbBGAi8nHKApNjKheVy8gDUiTwj20rG0kTSAF6K/366W5rxjG1iLqndTWpeEpiRWp/6pq+bmblt6FQY7qRWh3FjtzEU7jAWykk32ReRtHD9JBuPuZk0VhuOD21j97yxJ4yTAxnRNObvS2Ebl6uNWNjIyBRvgLTTkbSsd3TIjHCZUZZxZr00pgfMjQSLwyKWjXksGIjjismAgEV8nHI5VCwqr9hip5WZ3IggVv4lYtafMDdJRYv1mNNfhWLX0o3Yx+O3/+vtvz/8wLRhewfHp+E3nrmRNrgYQDXiWyYNyHAa1k4SgOg30GLH4kqKa2EsG4AAul4BBeMBe2JnJ4LaUm74WDiYC8q7bUjUTMrdCG4puAG/yRh+ttFIjHlj97aB8OGqdUaqYeNutZHjauw6k4l5LYsZLIf7IE/cgPYSFCQGG68GO92N7rbY6W5udfqb/f6rbqfLN7c2drbjV7BEgPUtE2TpgGsgE4JdRjCATYrvop0unBsyuFBLxkx8YxdLAV00GrObfENQwEI2S5xlmYXFyIOs4yrmJmZ2ohy/YX5aH4woFTv/7wb530k+aE8niYhISUeFWS5fjJxL7W67HYsrkWBEtCyXSaqlcq1Ij9syVm2eyna+WDMq5DSn5v3N6wuQNQPOlxfqQr3Jr6KL2SxNtXEAz/uRgP+TRF/j7YEUSQz+rGLmo1Ibu4sSVlbmNbmysstWxLdV2OZK4+4STWRTCAeIQzBKZ20N/6vq8OR7sQcaj7RysAxO5GmaBG9qf7E4+3be5Lr/BXSAHm4Qr5N+bUKaiDH8n+cQ+x5XmM4EvYqhMHNW/pCN+2BlAFgSUgLqRtyxEb8SrC8gsgPuwuE2Vhug1TF3fomNDrojjyJh7ZHRYB3xdEBeDEu9nIdj2lyEyejnQMHZDwfQuUcpOnuOfYKAh8PoLoKxyFVOtePJA7Bg2nM4lqklXgPB7mZz5CrrazgWILgBnRMUdFLlv5aBbz3cqZ4D/V7/eh769bWl/vcc1DOu+DysC11k1lOfqeMZp30e4FdLfNr2UrDnFR6bD8K7zJEXhBi7HsloxICZANB8tWXRX4YIxAZY0t+E0ITFyg66NLyersXH5Oxlilx+tjxZlU+FuUCbC82NQfp0JS4/bZ7kgwTqqRp7HKYFelqYFUN6eJa/LT8Ul2nrvoAgaM9wscchW6CzBREAyCgLwJW8bMTicLZ0vLvDkd1FnHQvkZhBDowBOtyEMgsLRSTvnqNi3SGsg4wcU4Um1RVPZNz6cWw1Fg6o/p6u8J9QzMwXIUo0h4ZLRCgIcgQTMXKvZIwUfqwNOiaKzGk2jWtVCjLQRGudveYx7Nfvby9sBhVqePQVZB3GywGdKQnzWT4FKueirFiwrNgWvL+1ttPpDra6nHdedde3N/s7A76xsbazubODq48hE/GhV01YmxvDJ3NLvxUKipqIJRoKXiq8jeCgewJAi8MU6cTYLrcByXiA/tGn/dhimwEvc+LGrTLOXu8dse42S7gaZnSdD2eUoJpnJ1jiZknC+3gJa2rYuRf80cihVIugCIgm7H7sH7zpnb07hSvHB3+eHZzATyhrrvnRU+CtMbqlphAc6WtCHDZwzaEYFFhEirjFVoLUFdgQp+gsBkr/m51YUCb41oBDZQkzwuoLZpRFs4HR40ooUdzcOPZCtkQLuA5eg6CGwO9zCxMCJVrpwamUuua7oMkVNhKQI8zLFuvFscRNAreCaAShMH8CghiPY193U12bQSgL6r7ozDGlnYxE1RZTVVatMc0q78pGweAA5Mv9pBe5DMDRNstRWHhLgBjsA5i95qroTktKI5VigwFqfmzwTECNxoCGWR/2Jp1lIR1RjQ+JR+XjioxVTpaU7t57MPtO072IZ/YBcXeUQPpp0taKG1ciBJ/FzpXPRmSN3EwhI8FN3DZNDqMKc+WB77sQdezWsVvH7gNjd/bmcejEhbtEfdbnqc+ZCs1nPDznqI8h71E671D/5Vu73pCr2MUOFOmPT6eh0Q3jxU2KbdofyI/8UT4HvlfYIzRc835sfvRPbYEASY9+BwPIRCLeJdxTxKQor6qN+dXeaNOX4KBqAUWErGnYRGf0dwCTKYVIuF1lsRZW/R5IbqixKAPiqipu+vZuzSRrJlmfRvVp9MucRjWTrGO3jt2fM3a/yyQLVBQtgSeF5ym8p4X71PBjMIDlfxNmRciRqWbZCgpjBcdqVJlDo99Z768PtiPRjXk33trYGXSirQ7f3F7fXu93O9uN8ll/Po3jIsiqMVWyt7cjqRhI3BXwuEyBc1mndVxt/4F6jRhgWsPUU/Bm0Dmo9HLKHbvz3PGDdrA3EAzc0dzTXjw7fofy8fEOFI9605mJBNJsrzrfL0VKiT4MmpbW1dSxpo718VMfP7/M8VNTxzp269j9OWP3UdSxu4w6dh9BHbsMKdYAKdY/SR1j4B1IzQZgFNhDlIF6FdLGFLYCP4XuYwh7x81QuILoVVhkZ2eeRZ5qzd5zNcnJkq10ItVUXZjeYOwYx5p8LAzgbAgpUjHIWhLYLXqVHAvkpOA/LJFjSXGMGwK5ZtLsDfCBVx8zub8Vq0gVJRkgpKSQaOy9avAxCe4kBkj/QAL1QYeQqH9gjzNY61n9YHaMO36HO2YHN5EQGPNF/3dz0VMChwDeYLo48ba+53EB3zPnCsoIcZP69FVQ0Jqq11S9Pu7r4/7XOO5rql7Hbh27P2fsPoKqBzZ0P1WHAQ+m6jC2tcYKLvUGnetvZ+wUKgEBuTfTEXH1eMrBiVeAK4U3EjGH4Ptyu4125UF9276V8V07f6a1aYs3FX1J4BFmJoGZ+Rtet2A4MNhdi6eylb9VpfQ1veZ1tbEgDeFTpz7kIJHFmX95DF8q84u0SN1Gokf79EcLeOXTBtF387fJvisf37pDq06gJGFezCq+yxi8iy7jawhQWvxuaXSLvGluj7C3M5PcLdtPeDnunn14IffsY5H6vrsWjGeAcmZ7CP8SzQUeAILIXmeAZ8/nrV6GVj+/LI85QZ7uEc6NnJ49+BeCzhygjzisw14LbqCI8A/NvPjj0+lLNkR2StnBv1koJJYTEF9H4EaU/Xr5AyQ4iQ4ko7PhiDbXqzyig9HGBgkohV2oEyHYef5s9Ac4Fo4hj5PacZKg1IGzHv4OIq/Me0mnI5URUvnHs+Fq60I12b40/hVF/85q2CJVhew8zffFS/t6KojfcmlNL61J0vDtxwoKr9rzyD/yHUHIowieWNLWkxf38poleVhzwRWUOosBNRFwVB+sinKrPRlHRV4T5VVxXKhP9Hx9dRrzmY5ZODmTmB2yaKS1Ff9hDF0HQ+V8mEGkPRkWPdTfpIhodtZKkJp+yaZsApEkfO8gMJR3Jt7Hg5x4jPYtFQrbz2RZyAuf6bWoz5U90+VzOG9xZKyjR7xYO4MZF2zigk2fJ2zA748zdCyIbdwD5QHvAHtT+1MmCEBLedHLWpj5SXyb5uDxEQFUkmLTXf/L7jQJhp8Y3cDRxRhI08jDi0fN8E3wIAvPtIqy8g7CrAbn8SYajtIZvXm8xd9B8Xj9t+0Xd9ybNlo+qmTyo7P0PZnk35N3/6GMV2eaXzHTBGaM7kbLzrx4hU7uGd182w/70iMB/8JdilSi4FDg+I9jIIcpi0kT7tCnKaajkRTUMEgFd8gOV9Gv9JjiECgxBj+UhSRoaGAMBK0Fxsr7MgF5LfYJKjIVgYqxGsMHdUHqFx3KshPQ8hEaie3nhgMCNR5nCr/JASCyMcMX1ZZYN5Y2ynwSguJMiXxnmmhcMSuPSHQbVEWL6hIzth8H2FmGorVkxCVrgQ1taCuDItEi4asZ040ci8QXKjCuStGXyQbPaY5EkmI9CBkUyJQorfD+8HROIghT4W8Z2gzbYZJt41gQguWQd4aNFlSBeCnV1kHxWpJb+kBE9RsvxdvXs651O22r1197oa+9hLMNi5J2ir03VHXmCylfxZ43qlUsTNqlL8DMFbJQ9ozASDjl9hY7NljV3eFl/6EWLJfAYzAop19mudc+9SdUvvcJlXss91Vg12X6IZzQWWnQJ1fyevmRhnhxHDzvJfn2gm/3LISSt3nVpIwjhwgedHcJo3znjhD5G763V5oy99cv3ErRb3l7APni7v/9RPkO +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-identity-profile.api.mdx b/docs/api/v3/get-identity-profile.api.mdx new file mode 100644 index 000000000..4f57dd115 --- /dev/null +++ b/docs/api/v3/get-identity-profile.api.mdx @@ -0,0 +1,112 @@ +--- +id: get-identity-profile +sidebar_label: Get single Identity Profile +hide_title: true +hide_table_of_contents: true +api: eJztXFtz27gV/isY9mGTjClbsnx96Si2k3oniV3ZbqZ1Ml2IBCVsKJBLkHG0Hv/3fgcAKVKkndjN7G30suuQwMG5n++AgG69JBUZz2WiTkPv0JuK/DQUKpf54jxLIhkLb8PL+VR7h9de+Ya5V9r7uOGFQgeZTIkC5l/OpGaZyItMacaZlmoaC7Y6kU24FiFLFDs97n1QI5Ynn4RiNzKfsbPx6/+Ojt+evmNJxkbnp4wX+SzJaLYh/UshM8zNExbwOGY5LYhhPfCZ8ozPRS4y4vbWk8RQyvMZXim8wL+kY8RPLSO+DPFSBzMx597hrZcvUhqm8wyM402UZHOe40lRYOTdhleu7x3mWSHa0nfIChFBSXzh8zQm4oPJ/vZ+KA78cHIw8fkkiHyxO9z1w2E02BvycDjY3vfuPtJaOk2UhprB2WBri/7XXG+k2sslk59FkNOSQaJyvKRpPE1jGRgzb/6sae5tTWro8SwyKnPyWxpeXdxrq0KwBdXBZXJp+YJaWmxdLHQu5v5UKHItGKtQ8peCNMGSCBYT7KxcYFXhSzXJsD/YHu4YJnh4puKF1fldaczVVd/h6SPocxpPJg1APxcdYhzRC/zJQrx/BOXBVn/H39rxB/uX/eHh1t5hf+8/dV8icn4u56JLtnkSykh2sfOG65zZ18FvzRcYg5MZKi8RukfJfJ6o4zyB/h52mjJ4wfBncZEUWdDhQw0520HYjrHak1L+1ThoxtzbBQsKnSdzFsU8ZyZQ0iq/qSKO+YQGOiMkN/DcGiuVaG1WzNCHmGgSXxXdLtCWWahiblLu8cm7y9PLf3dkWswo17X8UU68mclgZpNiJiKRCRUIZqIf69U1UhGGuDaGH1b7MnafsNggOOjvb+1v74T9gz7f34UjhoP94c7OZDgZbA+4Vwvqh9n4RzHnyifvJJ2yUOo05gumarH/BP7eyziWfM7wf0qOd+TvaSZN1anxJJFPp3CMWszg0e6w0zHK+QxjGW8n6oaD9rewYlesdPjg4xzo4uxqfHTy3d3HkV07D6iO2Sggk7FjZL0gT7KF9aASbIxFhFI+G1dpseJzkiSx4MowGvEihkdFPNZtXIHMwWQEQFXSJJ6IKGEiJUQowh6DSSVhogWD+FM4KirvzQy4irNgxtVUEOAiIbXxLTbjmk0E3s952HRHlwbLxY6SwsKIVhy03R5uN7EJ0c2GurAoku5ExImakmrvS5X1qNoe1Bnar3EzyiHepMhRhVQkp19P08cikgpcWLgoljrkJSVoIE3hMSwwJAsLiDVUSuYP3fxZckPcl7CG8GmQxDH5C0onN4EuOJymvYBmUrVth0gOhNa9VlALRQ7agQFIwxMeACzDtEhasCjMjcnzBAx95nFBS1lXdvVts5QNkji6vSVMuN8DV52hkuUy40qTqWr5x+NZxhegIgH89CNMAld11BykoRfS/OnyZluZbX21XOPdN+WDOmLsXmYZ5YDKMqZUUzF8XLHabSctuE6hlftFrNnhkdm9vVpey+fVgitr1cBvEFBMV/ry6gbutB8PQ0OHx+cNDrlaNHsHx2MbGN59vFtlfJRNJJjNFuyTWPjGfVnKZaYpzgDXMmRctWDo6XgVYcssXZfodsm+tb0nfGMxdHcm27mnbxeusJbPTdfrSszeHt8f7Ird/a0+/gq2JlvbIe/znW2bz0sEfNnhAfX3p6veWE1o0mmNcwmtlutOvgTCKGss0iTLx2Uh6rLQV4Am15/GQiPCTzsLdrPT7fIwGVb+BVpIYkTsKa0tdQgkzX1B2oDtXKmCx8zO6K44tSi2w3qd5rhXlxiLUniJxod6m5DM0Y7oUxVS22WKmcu0tKjrdfS5ANzDCFfra6Wl9NmugvfIJHxHuwKrYpXbNHfGt4Zd2wRHwCwqZydZBl58NjbbMwAHslQamnP0lpMkNHssUkE8GT5qC+HhNBYigGV8lITfkMxeoTD404xL4lAYlgNMpHL2WYZUyOaUFyzJ0u5mXNMXoYlen73kIRs7+Y6cMDaJB59AqzsWmgxd2c2LcgrFQWnTjmXFnuCT3a2DwTDaHXIOoNrf25kcRHx7e+tg5+CAVp+j6POp6KqfzaVfE9SQAYsT4Dr5KxQC8KpdbTSLP1RymzYwNL6xmNixlZiOX5aLL/kGavbLo3M23GMxMGVhnvPpihKUf3XR1VhbwmeAp7Kz1S+7luOTV6OrN5d4Mj7559XJBf4iWq0uZgR8YAMzMZjTQLSlADdAuFoQQiN8/MJRfQGBkJDrA6X9lzYbV8xFIWa41Ttm1EmzCACsEUombr7k7Jnsid4GoC9t3fAc2LDa+aThL0YB5ST/jdPkCzZDcyKy5z02quptCevmgBITFMQwpNC1BKICoSzMxmlS5EwluQxWgMtSlasFoswkb+pGoeAA51/3E/Q8lJiNmPUorLzFsejsA56t5prcXdaUZlS6UDlHN2X7mCDJqKNiSKRM5pq5dETm0kg8qhxXZax63jfp7q1lxmxV0V4fL/Q3xN15jPTjG9GqF5+FCz4DTmw2MtYozeQykutvzGQ3qjJXGfgskiIO17G7jt117H5j7K6+HLuPI+6tgT79NvS5Um5XjYpnC/pkxntUUn5j+tV2aNaQG9TgO4j04/tL942KuugvKe3jfEd8ZEt5+/NOZQ/7fELwozJWwxbEoNGjlSBCJhLhoeF7ybFRlFXVdnu1Vwm6MTio6oCIyJoZWyQF41BZVihFnHC9wcJEaPVDzmYc+RFdJfi1GdDsNoR+mkj1uI9RayS5RpLrarSuRn/oarRGkuvYXcfunzN2H0SSFVcmWhxO0sV8zrOF9TT3nqTlDANYeUxnuSttTLWKVogYqzCW10QO3mTQn/SjvUAMQz4Md7cPokGwO+A7e/29/mQ42PPqtf56GcdVkDVjqmZva0f3RSL7DBxXKDiXzpMkbG7/Qb2ZiCitUeqpcDN03qPN+wo7DjvO3iQ5ZANhYMfsnu3Fq/Eb+yXVkie92e+QFLTusyt9JyRIST4MTUudr6HjGjquy8+6/Pxlys8aOq5jdx27f87YfRR0HH4NOg4fAR2HjCBWRBDr94SOIXAHQbMIRqFjZQXUqwg2phAFf/Hq5I49J5BNRV4BvQaKHBx0nJpJEvaWDnw4sKQbO5FqqS5Kbxg7p7FZOVbSQbcpUqRiqfkab7xKzgVhUjqvFcu5NHFMAoFutvBHUQ6pbMyU/latIlUQF6E7+FWeXbvhko6yRQT/QMHsg06RqL/jHqez1v+1H8zGJPEbkpjRwQc6Iciq/d+drlMCp2A+o3RxYW19z3EBu2fOFdoI8SW16auCoGuovobq63K/Lvd/jXK/hurr2F3H7p8zdh8B1R0auh+qY8A3Q3WM7W2xCku9Msc5f2vEbkLFcWDcmyWBwerhEoNDCVrgobnihEWuAPGPrCuPinxGkSlDdbh6Y/aQrs94H+kk6lzAE92lYUpBdNP20NtcnaE3bzuu3d55tD4BTStjkcWYPMvzVB9ubt7C9DD5XY+nslfOVslNL0jmm5+3OxIZnVvV5b2HsAhMI0LXh+0iPWOwTFJM2ARqFrDmc2duPQ0zmgMLD9Ivzxsv0NQwS2aDjt87/zSPwWaK5uQHbUb3jD+2ZIRsV1l89zV5/rX9kByWyD1ydKnvwbUwnoHLFfE8e/K4dJcLQvF29ZbTLCsTfT8YtBY7o2ED9lLwDC2GPVLz7Mf3l89Z7bYw3RpnQlKzgeg7h4uY3Dgqj5fQJFOusqSYzgzjo8YBHopFFsUQmH1QF0Kw6/K09DsUjTGyvFEpTRImsdCsj89Ky4Tis4ipnvaWmiTHQzxsQkObvDHvuamdpsmQqrrm0fugfHchjK4SmTFORNMzsuu0lIvX5HoqE38rqfmWmm+o6ecrXFjVXgf2QHiAhEAkeKyNtp68uKXn1+hRR4YnRHWVB9KE46N57CoorfZkPhr0fKLX5OODem9u9TWnMZvImEZdjUN2yoJZkmjxd8bIdSgMrqcFoujJbJmrhL6JCH+wVWPJt0v60gfMNPy9QWAo60x8QmXeXTozGy4mJH8ylkXM/4QmPGQ/NWQ2j69RjWlkmAT6yTzTgj4t6NscoB3/ttiRYyG2SQaTB6wDHC3tbzKBY7SW8yytzqxuyG+aOVQaArBqqOj00P7jcJng3F/MvKDR1RikYM9cb3IH0ejOn6N1t7xia5VV7i+sarDNb5yg0K7ozfJbfSWl4vtHk5ckHi23Yeg+//fO0vdkkj9O3v2dMt460/wVM43DzeRuZtmVq1jk5BattTcFadd6JvBfvDWRagA62h/7qzeEYepk0pjn5gYnxXQwk8JsJ6SC54T8NsivkrmJQ3eJGE2jITQ1v2aSgWGOBlDGoNdj79GvqQAqpl6NjvGC6s+Ja9ouoOVzMhI7Lg3H6Ac+CuV+vaCYMw73+Ip1Q6mDwiYhtG5KlJIlBsZVs8qIJLchVZhrcCKb67OI9p0l3W30vnEt2FC7TWcokizifuZnKchYxPYuN8Y14ffXaMNz/JmIU+oWkUEBpkRthbenly2KIKbcl44km266SXqTxoIItTrWGbZ76BHpUZroHK1tje5rkd/3o0mrPnW73G3/fX92ydUSagI2U9oJI9EK25TYpvC69cNLZI9Wb0m/xoQ+Ywat0JzbW+KXWqQ7evxLIag7v/647IBM5wiDudvyXb+dUNfSs/InGJ6bT0D3/FJTpzjl9p9aLDt/D39+ErRh0CWIue5st3gMm3ak3QSq0Wh9Jml01q9PyM34PUXb/QGVIC39Dz+5dgk= +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

+ +An Identity Profile object. + +
Schema
    owner objectnullable
    + +The owner of the Identity Profile. + +
    authoritativeSource objectrequired
    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[]
  • Array [
    • transformDefinition object
    + +The seaspray transformation definition. + +
    attributes object
    + +Arbitrary key-value pairs to store any metadata for the object + +
  • ]
    • identityExceptionReportReference objectnullable
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-identity-summaries.api.mdx b/docs/api/v3/get-identity-summaries.api.mdx new file mode 100644 index 000000000..c14a52bde --- /dev/null +++ b/docs/api/v3/get-identity-summaries.api.mdx @@ -0,0 +1,95 @@ +--- +id: get-identity-summaries +sidebar_label: Identity Summaries for Campaign Certification +hide_title: true +hide_table_of_contents: true +api: eJztXPtTIzcS/ldUcz9k14UN2AZjqq6uHGC3SLGP43F7VSx1kWdkW9mxNCvNAA7F/37dLc3LD2BJKgkb/5KwM1Kr9fVDX8vS3AU6EYanUqvjKNgPxiI9joRKZTo7y6ZTbqSwwUaQ8rEN9i+DA2FSOZIhdWBli6uNIBI2NDLBFyDnfCItG3w8ZkakmVGWcRZLmzI9YulEMOnHYDYXwUbaQCObiBAHKFuEfJpwOVYsrI7dYgOW6i9CsRuZTtiH07f/Gxy+O37PQMrB0em5/xfP0ok2KAbUMeJrJo2IoCNIjWPQxCnZYqfiWoobYZwa9Lw2HLRXjMd2viNAk3DDpyKFvgDQXSBx9glPJ/BKwQv4l4zgbxtOxJQH+3dBOkvwqU2NVOPgfiPI9Qr2U5OJRSTFY2Cw40MYQdzCyxhFi1Fnb9Tvdro90e/u7LaHO8PhXrfd5Tu7nX4v2oNBvaJfM2FmpaaxnMo0mNfgHb9lKpsOhUHzGWGzOLUIorNt67M6E4Jd/qdDBj9LuYq4idiBjmMRkn4fC4yuXk3SNLH7m5uRuBYxOl/LchknWqq0FerppozUJk/kpvVymmEhp1li/ZoMNdUGwFHw59R5RVBFcwQGExVc2jtbS+wA44qxMNDTiXGPOm14MJVKTrNpsA/9pvzW/U1SIjHigAL9634Vmno0smIRzg/0GNQGBDEWRhl4lEOVwYsWu7AZONksjwVwWPLxBlmngcAnfCwVTwX0NzobT0iON8yLMcdvMEYB/2rwQ52pReyPR6yBQdZgMgVUAfhEJ1nsoBSs8d/muU553DzA3g2ENNHKCjYRPAL3JztgwyXhMOEgUWdxxIbCRwZYTo4KuwF+rOF8osEg1wBUYwWIRWAxsJlUoaAUJWwKiQFyYYqqMJoI5Z8JvxbwGGxE4GB7CekgTDdwNpTgwGJToSIYWOkUPcUKHLVBQv5JM2+gTqTtNY8z4VDA1qB2ZnNtXoQHuXS54ERDrWPBVVDxE+q50ldGMqb8vWSsB9J2mW9lxMRX9vnRvPs5WHDINzR04UWZRdOjh+VoMTtTKSRg122ILqX+YNP8w+EDmjW9nq/RR97kT9H1bJYk2qSgnltAIa2BKH2DryGFxZEl/3dkQxu7jxIaDRk1GvusIb6CC6uGewaKAawgqnilhH+F9iqe2pvGyoXMoi7fZtFKysEo4k0rEALQo25sGmHejGcw3l/ciAjJvAnP3LOnGRBg9wYI7q8QWJcbLULZ3trC/9VBOfGEb5HsAX6hhlQPGRp68SSJPZPZ/MVi17tFK3FjOBpYpmJqK8/18BeYK/Iwg9ik0ikEnGuJhReZ1fHhCko6qzGqdtjf3tva6/XafGerO9rZ2oa/+jvdLQF/DnkPXcS53mODvodW+ZCxVF/QF/zItREHQJfBEd4IM86sRvl5s+PnT20o0JyeO4po2RR3ett77c7W7hZMcbvf7/Q6vR7vdCKBKhShuSLb1pZaFaFRgdnfTARoYTxJQaLNyIqFp83h8MM8+aaFbyiA7JcKzC0DkNsD6EszqRUp9WpmFtxXg/nSOcrj5i0Sy4AbUOitEeSLFYs8gF9/t9MR3aAGn1uQNp42/l5l/HHMBfskY4yTJ2vgLVjTgFC7ukc8usui9yCWIJsdGQNWakKFVDIaZ0hiKmyoIyqupAI6IaPWM0J7RQhHIoU8d6CjJ0TVG6lEc2y4RA0FqRxCRwYSr2WETk/MwonMw4LatWpBAEi0ttmPPIL5uvkd+MmgfxkefgFZTwnACyWhP8u7gG8X3r5kWNETfLi71W93R7tdztt73e3ezrA/ArNt9Xf6fRx9KqzlY2GX5MT60G+FgmU5ZLGGWlX+CoAYwTGXoAI0+NPTKMl4Av6Yb1zbYppeX5aKWyConP148JF1eyzmapzRcz6eA0E1L87Q06Ee4sMisDe8Eh+MHEu1TBWhsCy4DA6P3gwuTs7hyenRvy+OzuAvlLWwNzFQ4K2UnDRR+Im+cWnITeCGw2oocAUFMswaXmoDJsSVrTaU7l92ZgFM5rkm9PCjL+lRFc1GRk9roURxc5uyV7IlWhuQ8OAZEJJwwoYciDkDE1KRMghDkaTNE49kw1cnr1tsEEUSJwllA5F7C/0x6zMeRY50uIITQllQMaOzFLm/DEXdFiWUdWuUSfakahQMDtD8cT8ZhCnUtuQTtSgsvMWr6O0DOjvk6tqdV0AjSJFdAeEJqWwOtYFCCDITzE0CHfPpiEgOJB6VtysyVnXtoHT3zilzmGp6F/LMPiHuPsaQfpo0teLFtfDBR/slLhuRNXIz+YzktwKos29VmCsPfEfD1rG7jt117D4xdudfnvqaxb8l6rO9SH0ulN83xsVzgfoY8h6l883lXz1JJUNu4Aa0p0g/fTr3e9TQXtwmWIb+jvzILeULyg8Ke/hqMy9G86W/tAUqSDi6GYwgE4lon/QuNSagHFSdxdHeaDOU4KBqCUWErGnYTGeMA2QmU4q2tewGi7Sw6ofUb2hBRFjrMiCOqqKmq23XTHLNJNer0Xo1+m5WozWTXMfuOnZfZuw+yCQLrShaPE/Kt5HJ0/x7nC1n0KD8ZbEIOTLVPFtBYazgWEGdOQTD9vZwe9QLRTfi3Wi30x+1w9023+lt97aH3TZuW5Zr/WUZx0WQ1WOqYm9nR4IYSNw18LhMgXPZVOuovv2X4e8eI0xrmHoK3gyYA6RXJXfsLnLH9zqFuYFg4I5mxfbixekJyseTGSgecdOZCQXSbAed+y0TKSX9iilupU3X1HFNHdfLz3r5+W6WnzV1XMfuOnZfZux+E3XsPkYdu99AHbsMKdYIKdafSR0j6Y6jjcAoMIcwA3gV0sYEpgJ/+d1HH/YpN2ORFkSvxiLb/UUWea41e8fVLCdLtrYTqUq4ML1B2ym2NXlbaMDZGFKkwnN1EtgtepWcCuSkeCyQDu9hHOOEQK6ZNQcjPLLljwR6fytGkSqMM9CQkkKsce9Vg49JPF83QvoHEmgfdAyJ+nfc4/TW+k37wewUZ3yCM2ZHt6EQGPPF/u/OslMCx6C8wXRx5my94riA2zPnCsoIcZu49FVQ0DVVX1P19XK/Xu6/j+V+TdXXsbuO3ZcZu99A1T0bWk3VocGTqTq0bW2xgku9oUsLfzRjp1DxGpB7Mx0SV49KDk68AlzJXxXEHIJX3faDzdqJXbt5J6P7zfx0arN68NsVBU7HzMTQNz/gfgemA5Pdt3giW3lfpW/olPt1Z0kiwnOnLugglUWZOzuPZ+rdIC0C3Ej0aZcAaQAHv78ZEhSH6R+Ur/yx7RkUJcyJ2WDg/96/6DEeroXi4gdLrVvkTwtzhLldmPj+sfn4uwEr5uGErJjHMvgeHAvaM9Bybnqo/hWaC3wAD6ejvS5AnwOXuQYZ2v3yqtrmDJm603ChZbn64G8E7QWFPmCzNvtRcINHxenYzKufPp2/ZmPkp5Qf3MUKIbGggAj7CG5E+W+QHyHBTrQklbfiBrVDOhhvbBQDKMxfcsrPh7+HheEUMjnBjp0EJQ/s9fQrGLzWb8WVps+qyQ6lcTc03CF4P0V37esyyefFK/N6rhL/yKU1nbQmScPrHzUtHLSXoTv0HULQowgeW0Lr2YM7ec2KPKy64AlKndcBkfB61I9WhbnVnq1HTV4T5dX1+Kw+TSQsvvVuzOU6Zid0r++YhROtrfgXY+g6GCqX4wwi7dlq3eCgTYqIZnurolLTDdmUTaCSpN8JBIZyzsSHuJQTk9FuU4XC9meyLOSFn+mq1c+1OdPjS1hxsWWkw2+4VzSnMw7YxAGbLk9Yr79b0NCxILZxDpQHnAMclPanTOAVreRFJ2tp5ifxm9QHl48QVCUpNtl3/9gvk6D/i9ELbF20gTSNTLw4bIbXuL0sXNVqYOV7CPMILuoba1hM53Bz+ha/hOIC+1ebL854UG61fFDx7PfO0isyyV8n7/5JGW+dab7HTOO5MbobDeuLiKqTO0a3uPFn6eo5/BfeUqQSCYcSp7xtXhWTxDxFn6aYDidS0JZBIniK7HAD/UpPKQ6BEmPw4wU8FDQ20AaC1gJj5UMZg7wW+wQ1mQoBYqzH8KguSP1F+8LsDFD+iEZih7nhgEBNp5nCu4SgRDZlHNzjEetG0oaZS0JQnimRz0wTjSt65RGJboNQtKgyMVP7YYR7y1C2Voz4yFhgw/yOKQCJFvHX58qJnIrYlSrQrk7RH5MNntOciDjBihAyKJApURnh3fH5gkQQpvyvGdqMN30nu4ltQQiWQ84ZOi2oA/FRom0K5WtFbu4D5UdXKMsd5B8EqV16nPeyu3KP/W/0ZRa/lGENspngZhsim7m6yZWtl0G9bIVO+/S1liWVK9Q5E7AKdrq7w00aLOPu8bG7e471EbgIRmF52XylFV7WN1WWIvlF4LZH/skYv7ER0JX8p+Pw9/oYygM4Fh+LeSaQ6y+bvLwvmzzgDvnna57pDevPivymz4o8aJryazHPNM7f7GMhD4JZfqilBPOq3O38xlX11aknEq/puMaTPpu2VLn8hzs1q2qWKw0U4f4KWrncSTq6F+7XmkqXhfMMOLliB/3tEfC/+/8DinPMsQ== +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-identity-summary.api.mdx b/docs/api/v3/get-identity-summary.api.mdx new file mode 100644 index 000000000..053b9a615 --- /dev/null +++ b/docs/api/v3/get-identity-summary.api.mdx @@ -0,0 +1,95 @@ +--- +id: get-identity-summary +sidebar_label: Summary for Identity +hide_title: true +hide_table_of_contents: true +api: eJztW1tzGjkW/isq9iGXMmADNsYvW4ztTDGV2/qyeXBcO6JbgJJGIpLajsfl/77fkdRAA4kdT2pnku2XpK0+Ojp3fUeob2t6Jgx3UqtBWjuojYUbpEI56W5O8+mUm5vaVs3xsa0dXNQOhXFyJBNPzsJ7KWztcquWCpsYOaMX4HI2kZb13w6YES43yjI3EcwGfmykDeOKybgMAyvO7EwkYC3SxXjCpzMux4oly8s2WJ85/VEodi3dhL05+fU//aNXg9cMXA+PT87iXzx3E22IDSQx4lMuDXg7Da5ZBnGCfA12Iq6kuBbGerH8eGk50EO8zK5OhFVm3PCpcJgL29zWJCk+426CVwov8JdM8WyTiZjy2sFtzd3MaNQ6I9W4drdVK+SqHTiTi3UjivuMwQZHWEF8xsuMWItRe3/U67Q7XdHr7O61hrvD4X6n1eG7e+1eN93Hol8QtOTywfeTu3D6iqCtpLezv73f7bb47nZntLu9g6febmdb4HHIIeglLWNnWlkEGIRobW/Tf+Wl+mptJSyTaOUwSOR8NsuirZofLM25XVdMDz+IxJFHDSWDk2FFeG9N+U26Do6YHvkI3yDLg1XukmGDO+5b9DWoiiUzqT4uJU1pxX4moTJ7Icw4t5r4F2SDx6s2FCAuolCkm1Tc7e7st9rbe9tQcafXa3fb3S5vt1NBIiSaiJ1YlmCodSa4WhNhoFJynrDseiIghfGiGJ+yTDoxLbJ2zQ5PVtN4wq8EZEfZWAiwJDrF8R2kw1yvSanSrRbEuzsi7WwKyMNMgpYdGwO56qguVP5IrlEU/VMurGNDnfrCJNUVz2Ta+H5BmwrHZXao0wfE0QupRH1suCQJhRc5wUQGjlcyJTdPtREssCwCwdM1Sm6HJRo77BeeQt+g32FUhixqePIRvB4ScudKYj4rpsCbc/9uWFZ0BR/ubfdandFeh/PWfmenuzvsjRBq273dXo9Wnwpr+TiYJq7NjeE3a0v/KpQwMmGZRp2Xf8AgRnDKHhLAL44pPuTu94Hn8QD7U4YF2rmaUV7mxGe3hW3xl8O3rNNlGVfj3I/z8YoRVP38lAp5nmV8OA/lrSjEGyPHUm0SRah8Snv60fGL/vnLM4ycHP/r/PgUT8RrbUunUhvSEaIiFib6OiReUOCaW2ZFBnOItMGeR67PoRCP238klBEM3FgYE7E14nnmMCOuvmHGMms2MnpaSiWfN58deyoborGFFMfYlLtkwobcYgJcSOTP+0kiZq7+MlryOZsIngrzDHgiTSUpyTOGbARTzKc6x3iaUuoGBqMcqSw86NC5Y0o7mYiyLxamLHtjUVZeLjuFkgOS3x8n/cTlEM6ruZyF82iJIkb/QOZgubJ0Z0tG8ya9UY4n0AK4BvhCGwMLsyF0k86yWI7IXRaFRxV084q1XC19uXsVhDly2r9LeG4fkHdvM5Sfuldt/uJKxOSzBNhCNfLeKNwUKxJektp+cqSau6tIfIZNKkur3K1yt8rdB+bu6suTCMPjWw99dtahz7mKPRdtnmvQx/joUbpozP6IsMw7couatwiRfnt3Fvs70IvPM+ozviM+Clv5eiMx90cYHxL8mDur5AsS0NsxaDBCJRLpgZd7IbE3VDBVe321F9oMJQJUbYCIqJqG3eiccZjM5EqRJNxusVQLq564gGQ5MsLaUAFpVZXWZ1oqVyHJCklWu1G1G/08u1GFJKvcrXL3x8zdryLJuVQ+WyJOKg5OfaTF96QtZyBgxYEwm6ecd9UqWiFmbI6xamXkUBu2doY7o24iOinvpHvt3qiV7LX4bnenuzPstLq15b3+YpHH8yQr59SSv4MfvYkB4q6A43KF4LJO67R8/AfzGjGiskalZ46bYXOY9HKBHTvr2PG1dtANjIEdzReOF89PXhJ/+lWD2JPddG4SQTA7mA7k3HlISTEMS0vrKuhYQcdq+6m2n59m+6mgY5W7Ve7+mLn7TdCxcx907HwDdOwwglgjglh/JXRMgTsImo3gFOiQ5DCvItg4gyp4iqePMe0dN2Ph5kCvhCJbvXUUeaY1e8XVTQGWbOkkUi3MReUNtFOiNQWtpBs7Y5RIxVC1JNAtRZWcCsKkiB+Wyan0eUwKga+5qfdHDlqFnCnibb6KVEmWQ0JfFDJNZ68aMSYRTmJE8A8c/DnoGIX6O55xRm/9qfNgdkIavySN2fHnRAjK+fn57+6mWwIDCG+oXJwGX3/hukA4M+cKbYT4PAvlaw5BK6heQfVqu6+2+59ju6+gepW7Ve7+mLn7DVA9oqEvQ3UQPBiqg7axzeZY6gUF1/8csftUiRL48GY68Vg9XWBwjysQSvF+PdUQun19UGuW7qja5q1M75rFFda6Le7X0/jK/ew7MAmNQpA7Nxn4TZyb2YNm8xbuhBvvGnwmG8Vcpa8biZ42r9obihPdRQ2JiPKW5olvLugCf1ik4Z1gJMV5KIp+geASrzZFNFzjLyF8lb+Kl5dv0KiwwGaLISdizPlhuqKLhuOJ9dQNH2NrOkK3c5Pd3afPv9tf0yMw+YIem8z31bVAzyDlinok/iW5C3FBV7TJX+eQ5zBUs35OsXBxuUxzSug9SLhGudiR6HeD1ppAb4isxX4R3NCFaX+V5ulv786esTFhVl8zcktwWUhqMpB1bxFGvib2i2slNMlvU0bn44lXrl+6uEM5yEYZjMLeq1Mh2EVxS/o1NosTVHdvdpokfEGhWZdPC++l4kpktI82Ftam4JSpasKKTV6a98zvmb65kAqP0/AlyHtVZ0eSShllj6eJKvpekV3MCr34kl6PFeIfBbd64Fb33OyzFSmCaS+ScBE8QSEgFjyz3lqPXjzwqy/xo04MI8R1VQayRJSjfN0qKbz2aDlK/OrEryzHe/VuIrEhl6exUP+YxX6apWzAkonWVvyTMQodSpWLcY5Me7RY17Ro3WdEvbW9JFI9LFmXdcBLL99LJIYKwcSHtL17dKPDQYtP29+9Z1EXfkfznbLfSzr74QvswkSZ6sQ+WmZasE4L1kOdsFH+sMlRYCG3SQdfB0IAHC787ytBFHSpLgZeGyu/Z9/0c2j7SCCq52JnB+GPg0URjE/MvyDqOQ3KNKHz+QU0+iwq8qKdrmSs4lxh1YLr8mYaG+yK3YK8819HadP9u+lLGvcXxy9vVHbzvav0FyrJ36fu/kUVr6o0P2OliXiZws0vGxuL5SAPiG79MJBOqycC/+Ktz1QPzNH2hC9FCcMss5ll3FFM+5xOJlL4Y4SZ4I7Q4RbFlZ76PAQkpuSnz9CI0diABklrgVj5UGbg12Dv0KepBCamHo2u74LrBx2btVNY+S05iR0VjgOAmk5zRV/UQYh8yjjC4x7vptImeShCaNmUKDTTHsbNZxUZSWFDpmj4bsVM7ZsRnTejlV1y4j1rwYc2HjbDkOSR+MXoQpETkYX2BXRliH4fb0ROfSKyGXWJqKAAU2JphVeDszWOYKbiLxzajJtxkm0SLZhQOxSCod1Ab0hDM20dWtolvqdLnyEPFp9NloLpdnG8/v/xLXPcrKjLaM7oiI1sl4fOKDSrF7Vys4pJB/775vV+Nbxa/aIY7c0EziBOt7d0XkPd2x0Nf8oFHQZcXC6aM98kIU7oGW3zCFKvfme87KOnJ9Eqz/wvTg/6anqjysXZo7pZHDvU8PhR0GkF9KVG9M/LVfoq+lGCrFr37hKTwjGXt12gCwdhSxzWfiqirnN+OPHrMdLo7r+BW166 +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

+ +An identity summary + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-lifecycle-state.api.mdx b/docs/api/v3/get-lifecycle-state.api.mdx new file mode 100644 index 000000000..4af17db58 --- /dev/null +++ b/docs/api/v3/get-lifecycle-state.api.mdx @@ -0,0 +1,100 @@ +--- +id: get-lifecycle-state +sidebar_label: Retrieves Lifecycle State +hide_title: true +hide_table_of_contents: true +api: eJztXOtv2zgS/1cI3Ydti8iOH3nYX+7cJF1kkSa9PK7AJcEtLVE2W5n0ilJab5D//WaGlCzJynOL3W1hoNh1JGo47/kNRerW03OR8FRqdRh6Q28i0iMZiWARxOIs5anwNryUT4w3vPSKG4zuGO96wwuFCRI5x+fh6fOpNEyocK6lSlki0kSKG2EYZ7VnW1dqxFL9WSj2RaZTdnL68/9G++8Pj5lO2OjDIeNZOtWJTBcMKCbit0wmIoQnWMDjmKU4DwxrAXdGBBkOBA5vvQsjkj2tUvE1HQEF5FqGaihDoVIY488THclY+HHOjm+QnWEieOhd34FAc57wmUhFYoigRLHmHEhteApuwF8rxGTo1RVx6MawD3YMO9yHMbkc3jBNMgGsB1Mx497w1ksXcyRtQGFq4t1teOIrn81jvNYd7/Z2QzHww/Fg7PNxEPliu7/th/2ou9PnYb/b24UnGlmtidnEac0wf4BREfV2o0G/198Rg/7Wdne8NR7v9rt9vrXdG+yEwOQ1UjZzrQw4DxDrbm7i/+o+JMjgwqRg8aozsi/cMJMFgTAmyuJ4UfhYiK4QoOVVijT5fB7LgPy6/ckg4duSFOBDJxHZ18mjx59EkFYkv7RKRJdIMEZSaZkGHa7wfLYAZmf+RCiMJWA7UxIkAGUyHYG3CnaST1BVYFl/Mux0e/0tYoKHJypeWPXf5easz3oMV59Bn+N4NFkA9FPRIMYe3oCfLERdP51yd7Oz5W9u+d3d805/uLkz7Oz8FwZEOplxsIaH5PxUzkSTbDMdykg2sXPETcrs7eDP5gsYg/glKm+5EXt6NtNqP9UUaQ85TSqCqQJ+4+NG7xGKj2MrrKMy1joWXJUZt0FXVcbHqQCpExK9CGtGYc0o6RJdTJ+hNPS7hbausrMSwGVtnedDGY1dze2CFdQYeiQDRdZ5aTGqAfAPb0IVEImC4ZkRxE6F5EPMLNNS+ZH7k5dVROkuTZen6j2d2bTgJkS+JiIp+wJc6nXLLPS7daeoz36czcZgEfBHNw/YGOzDUzblN6LJUsQU5CAZH+u0cOuTuj4Kx2qorvAPlBmSehMxh3yKU6sJI7IMUmAkJ5mt6DSI15nw6j6pkJfFe674hMrec13zEAISL6PEisSeWVrILBGX6JlRo+8GU64mVjGWj1Ecj8KZVH+YEQsUBONEjfFEPJ+Zs7kI0E6IK76JZjIkxIwlC4xIxa6sR4zCEIxpjqRJrzw2FrH+ssLzA/zWaZSY5UnCF2VWMUuZ9F/4n1agZ5hD4Wd3eQHSloSCZhorfj0EIUkDayiY80FuuRCmxUABV02qBAk1UUAXqarI5Ep6svClXH1wT2zBEB4EmAVGAV4wDeqpS3xPFNq6Q6FlzbjA6HNkEaGOBYPgwsSCfIMflswdO20ZnSUAYn5ijqvWSlDyIE8Ky6R4cDx6e3TQUPKqHO7TX2NIRjJilg6gbIgG4KyhTqBnqGyGblFMsH94Rr+uQXGW18PwKTpbeolFQIf2vo2Nkv91g0Fnd3O3v729GfW3wu3NzvZ2ZyfkfNDtbG7t9oH0w0MAOa50H4UrWvBl+QYMZrAo5X8bNstMKUNbkVkEyCcDhwO9RDFkcALt9okWOxMC3LjtCIDvFi0OeYGdx1EwVYcclb2O7nBCr64v+P60atnPex/Uri15GK3cGB1IAsDU1TVXwDvsA3L91JpNuAlS9pv6gr1YQqVjB0kCOvfZqQBtK8ygNpW7loGNdUg9o1Q3PJbPawvqgV+NyFCkkFz2dNiIo6rMvpNK+JOES+RQEMsBPMiA4o0MMWHMdIJ4BUnm1YjGtSowCDTR6rC3PAR5rXx7Thj0sYQHn4HWYfg4QxfWevkjgFjId++ZVuwIPt7eHHT70Xaf8+5uv7OzNR5EvNfbHGwNBjj7DNwAinyT/1an/hm7IhmwWANwlL+DQgBWGYdOaPKHkm/VBkTjCfrHeLdjCzEdvwzXBjYgKb/d+8D6OyyGIpLRdT6pKUH5F2fYS0OjiYmy6Fgs4ZNETmQzinXZdP/g3eji6ByunB78++LgDH4hrZUIG0EVVCG6pSY0OYXKny4FoJ5XxKAOwPTsjaP6BgTiWHCWA6X9y1AzCr4V8SxO4Qk3e8MTZdIsSvSsEkqBXUhhr2RLtDagemA7xtNgysbc2NqGw99AjhPz1D9ymnzDpgCbRfK6xQCPSBQSOgCIxgyTL19gGQKIYMEPEogySr2YMnSWUs2HrFuxxVKVVWuUEknZKNT4fE0f9xPIyxkwR2KWo7DwFseisw9WcJqnyl1pycKqdKFSrLu4VrUANSYJIoYxyCZTw1w6QnMZSDwqH1dkrAqgQW7eW2ao/cT+nWfmCXH3IYb045NoxY0b4YKPkIrNRmSN3EwuI8HNdGpjJR9VmCsPfKiRIg7XsbuO3XXsPjF26zdP3Wqou0vQp7MKfS6UWw7H4rkCfRJh++x8zfx32/tbQ24gonUQ6ZeP527NHReMvs5xyeob4iNbyleYHxX2sNfHCD8KY1VsgQySHt3qBWQiEQ6J7yXHpCirqt7qbO90MpbgoKoBIlKLutAZYdUkUwo54WaDhVoY9ZNrCizAtRnQvs3wCeuvkeQaSa6r0boa/TjVaI0k17G7jt3vM3YfRJIFVxQtDieZbDbjycJ6mruP0nIGA1j+Xp4VIUemqqMVJMYKjOVVkYM37nbGnWgnEP2Q98Pt3iDqBttdvrXT2emM+90dr1zrL5dxXARZNaZK9rZ2JBUDiLsBHJcpcC6Tah1Wl/8y3HcSYVrD1FPgZtA5qPR6iR37De/TdQqyAWHAjsk9y4sXp0dIH99PIHnUm13+xaC1bwZoORQhJfowaBpfxqyh4xo6rsvPuvz8KOVnDR3XsbuO3e8zdp8FHfuPQcf+M6BjnyHEihBi/ZXQMQTcgdAsAqOADEEG6qXtym431XLvFKUfnkxEWgC9CorsDhr2r2rN3nO1yMGSqaxEqqW6ML3B2BmOTfKxEveLTCBFKtxEIrXdqiRnAjEp7nqJ5UxSHKNAQDdZ+KMoBalszOT+VswiVRBnwCElhVjj2qsGH5PgTiJC+AcUaB10Aon6G65xOmv9ofVgdooSH6HE7OBrIATGfLH+u9W0S+Aw33F4Zm19z3YBu2bOFbQR4uvcpq8Cgq6h+hqqr8v9utz/GOV+DdXXsbuO3e8zdp8B1R0auh+qw4AnQ3UY29pkBZZ6h871pyN2ChXHAbk30wFh9XCJwQlXgCu5o4uYQ/AA3NBr10/pmfZtw8G9u3btiBwMWz00d+fhMUPEk1aULIlhimmazs2w3b4FC4Nl71p8Llv5HEp/wZ307ZteQ76yxzjQ14CTMLM7tPHUo52kRXZJJLq+zZM0gbUSaQKdHKxF+xIepK/cEbEF9C7MktlgECbODekysDmHHuQnQ6Npg+7Giowg20US3z0mz396D8lhidwjR5P6HpwLxjPgsiae21+cnwo9Q7BuZ185G7osQPiaoLsy2QkO67K3gid48Ip2zrz65eP5a1Y66Gfo7I3EngKC7AO4CKXAUb6LBB+iqpTobGK3RI8q+3Qw5FgUg8DsSuFO88v88Ogx1IZTSOakUnxIUP7Ap65f5ZYJxY2IsWy2lppEx5OhaoOG2rzy3GsqkdRLSGXPPuFZqSvls32JmYsOMeAYJyK1huxynsvFS3K9lIl/5NR8t5mcqJnXNS6sai8Du+87gLhHEjw2pK0XT27p+SV62HjBFaRa5wE14fio7q4Kcqu9mI8KPR/pVfm4Uh+nEupv9TFm0x0zUD7jkB2yYKq1Ef9kdEgBw+BykkEUvZitLzipTxHhdzdLLPl2Sl/6gCaJvyMIDGWdiY+xmhOY0XZdhULyV7IsxPyv0GuH7NeKzHT5Eooujgx1YF7MM07o44S+zQHG8W9rGjoWxDbKQHnAOsDe0v6UCRyjpZxnaTVmdSLfpmewNATAKlEx86H9Y7hMcO4Xoxs4uhgDKRjBeLHfDA+sOVp0UKSsrHwZoa7BVX5jDfW0pjfLb/EyFGvs301elHi0XG3BU5ffOkvfk0n+Pnn3L8p460zzI2YaB4/R3Wha10eUndyitdW1PyPcQUy4S5FKOBy6nOWxrjKZecxT9GmK6WCKn2PAxXTBU0R+G+hXekZxCHA3oJOhltCEPkSQAMMc+jwZA70W+4iHFANQMbZkuFsXqH7Srjc7Ay1/oJN3+7nhGJ7NzxR+bAOYyGYMz18/Yt1QmiCzSQg6NCVyyTTBuOKpPCLRbVAVLWpOkpk5iXB5GTrXkhEfmQtsaNzaMiiSjl3bb3QsBTkVMbeHUzdq8Psx2uA5/lTEc2wKIYMCmBKlGd4fnq9QBGLKvdDQyaTtHjJtHAtEsNWxztBrQSuIl+bapNDBluieFt93qX1EpO5Rt8sl9b/kEzGugCDyb89xlYuOUtpOxPaLlytfdUEjrH43hj6gUm8ZcWTDl1agC5lqPIh96d3e4ioKNlB3ePm3TGCLfnm97I+oryxO5A4jSBb10+RlLb46dfK+Zs2fmmkUOV/+U4tl5+/Bz88CFwyahMVO8EVcNX5W5gVMNej1Dg8l22Un0podaBemSiRWXt1gW1gsFvx8gDHB70EY7gdYCHLo/wH/kHpU +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

+ +The requested LifecycleState was successfully retrieved. + +
Schema
    emailNotificationOption object
    + +This is used for representing email configuration for a lifecycle state + +
    accountActions object[]
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-non-employee-approval-summary.api.mdx b/docs/api/v3/get-non-employee-approval-summary.api.mdx new file mode 100644 index 000000000..8ff1a19b1 --- /dev/null +++ b/docs/api/v3/get-non-employee-approval-summary.api.mdx @@ -0,0 +1,87 @@ +--- +id: get-non-employee-approval-summary +sidebar_label: Get Summary of Non-Employee Approval Requests +hide_title: true +hide_table_of_contents: true +api: eJztW21z0zoW/isa7wco0yRtWijtl51Qyp3egQvbl+VD25kqtpIIbClXsinZTv/7PudIduKmtFxgdrlMPlAcWzo67+c5snyd2KlystTWHGbJXjJW5R/WHBTT3M6UGkynzn6S+XFVFNLNkvXEq7Ryupwle2fXyalXbt+aUn0uB1U5wb2Lm4v1pJRjj+sEhDo1JfFaj1Q6S3Ml3kgjx6pQpkwwOFM+dXpKDGD5k4n2wqk/K+VLcaXzHD9Kp9UnJaTwgQthR8KAtKpJy8hlPdF3xclEOTzAv/LKijTwWGFI5ZUXI+tEOVHiMk5QWQe3LsVUlhP8cbJQpXJ750aITaZF05yYSM/TnIUUkSYxc6kzs2eUd3tOyexyXWgjriY6nYhUeiUww7pz4/F/IWeNdC15JCS9XyYhvddjozJRWswFl6VOq1y6OBT8DWe4jVFmTByUE1k2zx55obMuCdQPAsGKDhYIgkHn0jRjb/N/nhTqPBF+Yqs8E0MlaJjOVHZuokJu6xF8V4rWAWE2YpzBgxt2rzS03dLC/DEE16Uq2lJPdAFNQp+uC09s7OTZFzW5DxkQjwwe4FeLK/LddKIKmexdJ+VsSgM8XMuMk5tlL1RQF9QDRxePT08PX6612QP35ENXE1vML+hxLQwEHyoyRO2+WVecznWpDdiSLJQ2mU5lGXSzaBWSkSTQTiEwS1ep9UR9lnAQYr2f7m4+33jef76xvbWRjYYbm3S1KZ/ubm9vbD/bSCgQnfJTa+DxJHN/Y4P+a0v61SEFZtjjEbQggsc5cQ0ivQ+eKF0va9cOP6i0JEs5yjGlDnxEDWYLIzUIjxWZaNkOpiqGUDfFSJz4UPCDDGxSyDJQ3uonC4rrw9hTBZ3D7n+VgTjvu9d3ihTzDRqoJ34nB2ABns1udE+uv7mhgdt3ec1+rslLD5yD73fEkSorRzGqQ4zUGW5oM44EbUAW6efH+VCmSqnzfZup5Wi+rcJX2qjO2ElNHCpmOcXEmJPInoVFnQgk6zDncd1FtZEmupviBaL2KMq3H4UhfTqZfgStw+xhhk6NxnxRT0GmaQrSHcuqHSWHzzZ2+9ujZ9tS9p9vb+48He6O5NbWxu7T3V1avVDeo6T6hbWlc3K2tPRvyiinU5HbFBb5DxSCigXdMwO8OKZw4n3YBkzjK/RPLhzGNmJGfgUV0HWUgBf778T2jsilGVd8X45vKcF0To8psVd5Lod0i/IhJA+E3zo91uYuVhSCh6DIy4NXg9PXJ7hzdPCv04NjXBGtJfwxMHVCthxxE3vFHEcBrlDwvMo5CLviSaT6BAJJ4xcH6vDLz5DnC/jWSFZ5iRlx9TtmLJIWIxfrSR1KNdp4rLuqu47agnuIb5ToIUp0Jqzh4U8GaaqmZed11OQTFEuZKbfWFYMs0yQk8gSXZ89gBNVcZhmFbiAwqhDKikuzrUrkGYAM1bbFXJVta8yTyutFo1BwgPOH/WSQMkCrQVUTDo23RBbrgplFzbW5O1lQGqt0ZkqZQgogrBnUiPqaIjNBNg1MFdMRmcsj8Zh6XJOxFnMlp7s3gZmXpeVnqaz8V8Tduxzpp8OiNQ8+qRh8nmBAjZDk3EwxI+Ehic2Ta+RV66IOfDHSKs9WsbuK3VXsfmXs3n54FLFyfMrQZ3MZ+pwaiU7XOi6eS9DHsfcYNGhxEMObaMh1al4iRPr9/QkC+6MyNF59nhLI/4H4KJTyJeYHjT3C/SHBj8ZYLVsQg6zHIMEImUhle8z3nGNWVFDV1vJqr6wbajiouQMicts5sxW36K4yhjiRfl1kVnnzqESvTS0/IsL7kAFpVZN1phaAdoUkV0hyVY1W1ejXqUYrJLmK3VXs/j1j914k2XDF0RJxUtx1DZ4Wn/MOp8AAUe/aiibk2FS30QoREw3GStrIIRn2N4ebo51UbWdyO3u2tTvqp8/68unO5s7mcLu/kyzW+rN5HDdB1o6pBXsHO7KKAeJoK7wycC5fWpu1t/+gXqdG/MalnENi2A4A7uaiwY793WXseGItvSea1QjJtzCkmeuIchrGFjS2eVWCAVKMkReNQKrS4ItcSRcKVBzttee60By8JAXoullnMCrpFQ8HSu1kzSrapHkFDjkT5JZQs4VjaQipRoT5QIER7BjZ+Qei02ii70Ly4ogkfk0Si4PPqVIU6A1yf3rX/u4hmHeUI46Dgb+w0Ru6HWngAGgIQs5qcOcKn6/w+arGr2r8r1HjV/h8Fbur2P17xu5fwOcRDX0Zn2PAV+NzjO1uiAZLvSLn+p/DdA6VyAG7t7ApnzLJ5hiccQVcKZ7/4rM1dJor6S2eM+jU5wx8L+qnd906YXPDx8MIMAZeK5eDxqQsp36v17uGCWG6m66c6m59uMbYq25qi96nrTsSEp0cCMGHdbMq5Y3owbvD2HZ0WfFOk2+HRMgLBDOwqOTFMAdvGd9Ln84LkX1ntkLqYzLrAnEQ/Yxvg80pmoxHnkd32a+WZIRspy6/eUief2/dJ0cg8gU57lLfvWthvACXt8Qj9i/mp/mOCY2H1ZfO9M0rDHVw/aXF3tKwvnihpEOrEF5qPP79/cmaGBMG5RxQ8aE0palpQBS9g4twjhvUG/w0icuOs9V4wowPWq9QKKbEKIfA4twcKyXODqMS/kDyP0K2ZpXSJMUJgmZdPK4tk6lPKqe62J1rkhxPZ6YHDfVka94a10BuFrQJJ2lwt3tuOuKlptSkqZbTmCgi937ibFrLJRfk+lYm/lFT6wRqHabm125xEVR7loYjOSkCm0ggSllb37x4oNdZoEedFe4Q1ds8kCYiH+0XX2lttW/mo0WvQ/TafJyb93xSsT1NhHxWn1k8FOnEWq/+KQS5DoXB2bhCFH0zW3w8ssMR0elvLLDUCUt2dAdwkfl7jcAwwZnkkMo1oxULIGeyEJKXbFnE/CWa6UxctmTm22eoqjQys6n/Zp5pwQ4t2Ak5wEf+Q9Eix6JzY5CB80BwgP25/TkTREYXcl6gdWdWZ/I9nkOlIQWrTMVP98KPvXmCi1eCH9DoZgxSMKHt5lUgHZWNtKhytZRV7xPc1uAyv7lFwbylt8Bvs09FRfRnk5ckHsy3U96afPajs/QXMsnPk3f/TxlvlWl+xUwT8S+5Gy8bG4VFJw9obXlzz/OZbfzFUx+OcgNoo40JJ9sJwyySmeayJJ/mmE4n/E2DU1MlS0J+6+RXtuA4BNyl4Fc+EBo7jEHQeqBROdQ56HXFe/RdJoWKqeeigxSg+sHG5usYWn5HRhIva8MBQBVFZehAO5ioCiHhHg9YN9M+rUISQgtmVC2ZZRjXzKojktyGVNHl7sMV/u2I9o/Rmi4Y8YG1YMP6qDkUSRaJZ/nnghypnL2MxrXh90O04Tmdicqn1PUhgwJMqYUV3hyeLFEEMeMhF7pr68a9OMn3aCyIUKsTnGGri16Pbk2tL9GiLtD9TZXieH7MvvVRTH3munnNcdvLruf76KtvY1bfxnzttzERC5ARelPakSTXrEJTGXr7s+Tu3p7SZ/Ox1177Cxo0jBO4N02+vqYdLep1b+g2RtF2ydnFvJXlLQBEHl1nyd4ItNU9zv34KH7qssYm+Cm+vrlTi/Xur5nNN34SXH5UtF/UVtjNBSaEvT1WRxgTdv8WZi+9H6PWvNmR+e2A8pL8AsqLF/Tl3c3NfwE9iqIx +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-non-employee-approval.api.mdx b/docs/api/v3/get-non-employee-approval.api.mdx new file mode 100644 index 000000000..a5f47b20c --- /dev/null +++ b/docs/api/v3/get-non-employee-approval.api.mdx @@ -0,0 +1,102 @@ +--- +id: get-non-employee-approval +sidebar_label: Get a non-employee approval item detail +hide_title: true +hide_table_of_contents: true +api: eJztXG1z27gR/isY9cMlGVMW9WZJX1rFVlLfOLZry5e2TuYCkZCEHAWoBBlH9fi/d3cBUqQk27KbyV1T3fSuMgks9n2fBUHeVvRcxDyRWh2HlV5lIpJTrQazeaQXQvTn81h/4VFlr2JEkMYyWVR617eVKyPiQ60S8TXpp8kUrn28+7hXSfjEwO8KUPAyEuxEjkWwCCLB3nHFJ2ImVFKBwaEwQSznuDKs+1YkhnGmYKbIZnK3OpOJmLFQJFxGVTacihjuwb/JjWaB5SKFUakRho11zJKpNEyocK6lSnofFGM+TcMRMZtyAyMEizWw5KYzPWafZKh6Spi4FwseftpjUrGbqQymLOBG4JTFBxVwxUBFjKtFzl4VV6gXVtA3yi0h/pUKk4hwORY0Oecxn4lExIZ0KVH8OQct7lUU3IC/ZFhZ1U9JpWXFyJC9uLo6PnoJk3BFGQuwZBKnAqwWTMWMV3q3lWQxR9ImiaWaVO72KuIrB3p4TfiNdqt9EIrOgWiGtXpXtGujRtAIWq1w1GqHMNqxCeLEiwKfKojSUHjWNGs8o0L06LMIErRrxv2FVQq7kVEE1xM2EswRCp2RQe9CMQN6TjQb88iIKnt1JMY8jRIGcqcwAzQMEr4qyUxDNwg90mBrrkpS42z02ViYuVbgOji+Xqvh/22teisdGpUcCRwbZsOQSAYUUvufDZK4LbDEo+hsTIZ3zFka6BcxhmIiLSvgA2tW26uAe884rFJBgz/NSSpFk9cDXzQ6nZHni1bLa45q3OOjVuB1ugdjv15r+q1ugOqyRES8rpULMYY4VIFAG6Gzc2N0IDl6+3EIqsBcsfeIkPbuuphCpTNMJG/PfhlcnPZPDwe/vr04uzqHW8dHg9Ph8fAfmEKW8uRXV1ViWRnDekyOiU/pmEMXwoQDCo2WFyF9cDZBkRVH4SaxTucoh0xooUJyzKQ8SvQQ+Qd1bTbaJo5w/bJJWn67U/NbYaM+7nRrAfdbHb8edP1OrdNohXWgf/cgG7lB3stkehyS9YJApyo5pWh9jK+LPFnlynDzGYV7kdcEBlbd3aWb8Ogy4UlqHrJo//z8AoyKvnsx+HlwOKSf54PTo+PTt/Dr9Gz468Wgf4SWPETDn5zAiLVyMQBykF7nEL3Iq5qQaUvVwyXfZRwYy1xRjgI3mWb7ZVEKwp3FoQ0EJxuwMIILq6xlBMCVQrqdL+cX4nccaU6qC/Rs5hLHw/ZxA7FU5VFZCoHsMlKd6RCd/uEcEkKweokk25bXeo/5t1DB2A0UzYjDj4xwtZxOan7Xq3W8emPod3qteq/Vrfrt+j9JQCinybflxJF8iIdmrddoVQ8OkIfNcZPZ6RjS42uo8FTlHk5X61XskWqR++AyN1K2xNSzhFbfrSRk7MgV1fHA92u1Wss78Fttz/dbNa/jH/hea1Tv1kVD1GqdJpoywzPFKNhl9u+e2Qu0c5YKakJWK45+u+2326PWqFbz4ddB0KiLccPn7fYSxL0HHCb5jF3OgDqwspkX5+8nACa2CJRvWXjKrnpjua0ayy24v4zNlgsVY+EnaBVw5oYlnEKQOKa8Z9GmXLlO+jLjGsAgAOanUqVZD+jjL+56FWoFrjKfavV03mlWeZVW/g8VF+rj4scJYwOQmfL4iCoXwndZsDSkQ2iZviB8tHmxWMOBGbdWmZ3PHBgMNQVmISdf6jQOxHcF2YaWXE+otUat0e7UvZZocq/ZHB94ozCoe+1AtH2/3mp2Ax+Zt9OPt8gtVjZA1sVacgM2X9eaY2qlOtp80Gp3gla9G7QhH3SCgLfHkJD8ht8gVW7l6Y4THPxMXi5su3i3QnnLhQsXn7n+OqH7MrAduWXSsz1ePwHuR2lir5UlOJGG8JsdyXg+9EmCOC54HHPssLC9M48X5O1c/YmYYM1EVrBcB8z2IWYB6X22oSFfSxgxtvZjK/6qlrCsQzoArKhjKOdgfdpAWOrIOCWZkrmp0f92iHiNq98fGm9k6YkYee9RxDYc/H0Ifx71h4MVsLZNa4ZU0fVBHOB0nWUoE2KelC2XLbkpMMuxlqG0iI/EFmX1BIexUJp5xBcQctrq8ep4uX24ymCZsb4raoQNUHcimCoZ8Gg7sIB1MZ9iM6m2EHa5HnuXGtobS5UEfMQglDcmM1dfq8qxMhXRfCi+btFQ4khGu59LTYwWoIUVI0xzHmQGuWOnqLy8E9qIeCCmOgq3gQZ/laA+WjyZ8gSwWBQZNMBIfy0vP1DQb4DHOBZog5U0lpsq00DWodi9wEdzzfGYdhD3NocQ0M1o0UrruUa64LOgYzXhlHi5trys+knmrx+3cXFE5nf3jMyrFDYIl6tlCOssRN2mEsHDUKI6eHS+oXsrbBavbHHkahpFerQ/4hOro5KGSmZcrYT9FBdG2j/67tFz9neWfXYp0u32TuiowkWceQRZ/pvurVjKIsoecKzXkHrNqzW8enPo+z34X9Ov+g0oK61erUbVPuFxshVbD2NrawvSCZHE2rGKanNeqKlS4bddFghuXtSnRVu/y07bI9r/ftttDzJyX65yzT4mKp0mxT24++cURx253oH2KZqbHtccRhJtN4hjSEkeg2YjjRVuLoxLgo10SBtFUlFH+qRnOA8jbfsM61CHWyCBN1IJbxJziRwKYjmAiQwFliFmppmORfZYzIEEGle2Bmii6rPXPGTZ47VDJwyik5gHvwGtbfrMK1tmsyn4cDEr9RuWFQeCj9q1br05bjc5r3ea/kFr1B3zRqPWbXW7FCDCGGjhi3k9a11WHwErEcuARRoKpPw3KAT8DnRPDNDi23c7RGNLJGbH5mI6fgmc7EFNe314zpoHEJNqktJ1PllRgvKuLnE/LY2gnhdaDkv4LJYTubG9zara0eBN/+pkSEXtb1eDS/iFtNbKVl+Bt4bolsAq+MJU3xDHTgAMVSMiUAfEKnvlqL4Cgbh7Hu0GSvuX7crAt+i5Ksxwq2+YUSTNxrGelUIpe4j+QlZFdQ8wK2YvngRTNuJmCa9f9QnjeydOk6/YVHAAiy+rrJ/jEPt4Fxu9BYJfACgYupbAOIVQFtQgQ+7AZ8dyFQ0vVVm2xjKvnBSNQtB9G6zcD+iIQXZWIA+H3Fsci84+wLPV3DqULiZWs1AJDxIEhFBuAx3H+KwcgBWTiWEuHaG5DCQelY3LM1Zx04LS3TvLzFGi6V7AU7NF3J1HkH482whkN74IF3wGd+hsNiJrZGZyGck9+6XJblRurizwAdyLKNzF7i52d7G7Zeyu3rxwh1TcXYI+/jr0uVI8Bf3GVDzXoE9M3qM0ywYRvHGG3MPnYw4i/fx+CIH9GyBBPEf1dY5N7DfER7aUr7eEuT3s9VHWl2Wlf2kLZJD0aCUYQyYSYY/4XnJMirKqaqyv9kbHIwkOqjZARNpjWOiUDpnFqVLICTd7LNTCqJ8SNuVf7I6VMfnzXOgVPDpwtkOSOyS5q0a7avTjVKMdktzF7i52/zdj90EkmXNF0eJwkklnMx4vrKe5+/boBgxg2XFploccmWoVrSAxlmOsShk5VEZ1f+SPDwLRDHkzbDe643rQrvPWgX/gj5r1g0qx1l8v4zgPsnJMFext7UgqpmMlMUsVOJdJtA7L23+g3liM6Z2BZAmJwXb4IOljjh3r3XXsONQa32VYZAjJlDCkWuoIcxqMneHYOBsLAzibQF5U+ExPAl/oSnImgEoMTsMiOZMUvCgF0I0XXn+MD8FsoGROlq/iDs8bygSRRtSswbEkPj0cI+YDCoRgJ5CdvyE6dSb6r5A8u0CJT1BiNvgaCIGBniP31qb93WN8IIg54tIa+J6NXtvtcAUOAA2BzVk57tzh8x0+39X4XY3/MWr8Dp/vYncXu/+bsfsEfO7Q0P34HAZsjc9hbLXGciz1Bp3ru8N0ChXHgX25UwdBGtN2c4bBCVeAK7mXkzGH4Luyvcp+8byOl53TMfu3Mryr4PvKiA4tY2kcwYRpksxNb3//FuwFdrqr8rmsZgfRlb7BU/P7Xxobsg8eE7CRBouEaUC7zv3zY9djVEnLsURHtlmPFrA6J7nQZUH3tD/8IP3sLOBCp5DniMwenp10TkWX8YQOdBQ/GfeCAepoTUaQ7SqO7h6T55fGQ3JYIvfIsUl9D64F4xlwuSKeO/aRvV5Op9fs6msvmS/LCbZr9bXFznBYnb0WPIa+wD7BePHz++FLNkHASQGfGsS6QmKHACFzDi5CCa2f7ebjJKoxsU4nU2K8X3peggHExhEIzD6oSyHYdfaezilk+gtIzaRSnCQoG+Csjy8yy4Tii4iwCFaXmkTHk6HaBw3t89K8l1TwqDOQyp7fgavVD8pjRxLzkMTCjWOciNToset5JhcvyPVcJv6UUfMsNY+omZcrXFjVXgf2/E0AUYwkICRJW89e3NLzCvSwjYIrSHWVB9SE46P8lCvIrPZsPkr0PKRX5uODek9fCyhPYzZ5MQPFMArZMQumWhvxZ8bQdTAMricpRNGz2aJPFHgUEV69VmDJs0t60gNsSPydQGAo60x8hLWZoIkG1KZCG5KfyLIQ85+gcw7Zp5LMdPkaSiiODHVgns0zLujhgp7NAcbxbysUOhaeVgMZKA9YBzhc2p8ygWO0kPMsrY1Zncjv0xwsDQGwal/ZmPfsH71lgnO/GN3A0fkYSMEVOnDtnvvhmWBHi46xFpWVbQqsanCd30hDdVzRm+U335TCivlHkxcl7i/3Ts5UtPjWWfqeTPLHybu/U8bbZZofMdM4sIvuRsu6rqDo5Batre/k2c/TwH/hLkUqoWroWbKXyQQrkplHPEGfppgOplLQHsBc8ASR3x76lZ5RHALcxeCHTo8ITeggcAwMc+jaZAT0quw9NFkqABVjg4WnJoDqZ+06rUvQ8jkaiR1lhgMANZulCl/+BCbSGePgHo9YN5QmSG0Sgn5LiUwyTTAun5VFJLoNqoLelhPxzJyNcbNY4suhlS3XAhsat1MMikSLuPell4JciIi8DMeV4fdjtMFzPHz9ht5ZAragYSus8O54uEYRiCn3+o+OJ/tuktnHsUAEWx3rDI0qNHb0Oo42CfSjBbpv8cNFj39iadW/bpfb5f9Pn2lyVQzX3Z/jxhkqNbXtkG1BryubW1CY3JMhvnYy1fiJiOvK7S3usWBDdoeX7WeUsDMFh8CYW3676F7ND7/Px5Q2Sv2bwO2Gta89uZ2FSgUbuKxxfKJYLy7cW1Iv2ZafuNrIYbbtqRZFvnLOQ9xOwHfjOL2cBhzaG3avqzBl7WkQipbvP7wdYGDye2CO+4HfQru7+w/Jksqx +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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. + +
  • Array [
  • ]
    • data object
    + +Attribute blob/bag for a non-employee. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-non-employee-bulk-upload-status.api.mdx b/docs/api/v3/get-non-employee-bulk-upload-status.api.mdx new file mode 100644 index 000000000..372123080 --- /dev/null +++ b/docs/api/v3/get-non-employee-bulk-upload-status.api.mdx @@ -0,0 +1,85 @@ +--- +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: eJztW1tTGzsS/iuq2YeTpBibOwdethxwUpwigTWweQBqI8/ItpIZyZFmID4U/32/ljTj8QXIZlO7OSm/JPZMq9XXr7tlcR/psTC8kFodp9FBNBTFe626+TjTEyFel9nnS3zk6XnBi9JGa1HBhzY6uIpAFVdk7EQORDJJMsHeccWHIheqiG7WolTYxMgxcQfvi5Fg6nHmrHN2zIwoSqMsK0Br/WM9cN+UuBO2YH2sYqVbxj7pPhto44nHIpEDKVJmdWkS0bpWPfGllEZYZjQkS7QqxNeC2H2UqTpQwpoDI3j68VpBrzE3PBeFMKTdfSRJ4DEvRnil8ALfZBrNa3TutmLHR+zF5eXx0UsQGL8pbFmYUqxFNhmJnEcH91ExGRMbWxiphtHDWiS+cpiCnomNrd2d3b1U/L4nttP1zX2xu97fSraSnZ20v7ObRg83xNmOtbLCErPN9XX6b06cxwwWTw22xuSAcTVpQVZnEngKjPh4nMnExUH7kyVu94ui6/4nkRRkLENRU0gvi/fToorQUJU5BctZ9/3R8fu3eHL8/l9nvdO3ve75Ob4dnr47O+ledI/wudvrnfYWg6bXCIiBzjJ9B9bslmclHCtV6oTGE3oPsYawEixgEEi2zIrKFnNRg+C4roS6jlgueNiBIkpa9qUUJSKJq5Tdcen5a9Z3OyTYQKSOQ0OZZVyS0hiYN5tgJbGYXVzrvrB0xC1WCIWQpfgoIMmdLEa6LMhxTBijjXU8nM0W1g+4zLAGEocd3fLpOlVmWVgys50t+7ksCr/U5VSVSVEzWCtnPiCEC1m4Z09hxsMDUW4vC9jDTMJArEuSsZh5X2N/6b1GueRCWKcTMqhU8LtMf2DopqKAsQ51KpaF76ywb6QS8dBwSRI6Y8JBqYuJW5mSg3NtBPMsq8BzdK0Z+8ESrQ32GpHYC/odBmXIoIYnn8GLwPg5gS6VxHpWLWEyrdFwybZiT/D+7vr+5vZgd5vzzd+3N/Z2+vsDvrW1vr+zv0+75wgWwHczl7kxfLKw9VuhhJEJy3QCj/wJgwBJYXsngNscS2Qhcvu8DxyPb7A/lQ9PW6sZ5GUE7GuMs9eHZ2x7j2VcDUv3nA/njKDiSwIeSgHep0eE0tDcMz41cijVU0h21H3TuTy5wJNe9x+X3XN8Il4LsNVRFThBVMTCSN85iYMCd8g5KzKYA2jAXgWurxqJHAhlKIUTC2MitgYcqIYVYfclK5qs2cDofCaVqir4QrZEaw15j2c5L5IR63MgE4MLifxVJ0nEuIhPgiVfsREqpTAvW6yTppKU5FmFwjknhGM8TSl1PYNBiVQWNW4pXUggyYwvpqac9cYUVU6aTqHkgOTPx0knKUoIVxX7Oh3qaAkiBv9AZm+5WekuGkZzJp2ogifQgmcA9EQD2hMqrgWThWUBjshdFsCjKroasZpg6eDunRfmqNDuXcJL+w15d5YBfmKnWv3iVoTkswHygUbOG5WbAiIFUHeLA1XtrirxGTqoLF3l7ip3V7n7jbk7/7IX2vTw1rU+G4utz6XiJexrXPFcaH2Mix6lWUXk2pvgyDXqb0OL9MeHCyT2Z3RvoBdfxzR6/MD+yJfyBeE7tT/8837VgVelf+oLEtDZ0Wvge9MDJ/dUYmcob6qtxd3eaNOXCFC1pEUEaho20SXjMJkplSJJuF1jqRZW/VaguwU+8sS1wQ4BaVeVxmMtVbHqJFed5KoararRr1ONVp3kKndXufvXzN0nO8laKpctoU+yZZ5zM/GRFt6TtpyBgFUHxqxOOeeq+W6FmLG6x4pmO4eov7nR3xjsJWI75dvp7tb+YDPZ3eQ7ext7G/3tzb2oWeuvpnlcJ9lsTjX87f3oTIwm7hZ9XKkQXLbQOp09/oN5jRgQrBH01H0zbA6T3tS94+b+Yu94oTX9JjGpOiQ700OqqY0I00CbE62paEHA2RC4qBigSkIuCiWZC3AxCBqWyVy65CUtwNdM4s6ggCo+Uaogq3eRKslKSOiQINP+XJmOmJE6A+r5wMF1sEOg8w/sToOL/qtOnvVI4xPSmHW/JkJQoted+86y891jCG8II869gx856PXTDlcIAAwEHrPqvnPVn6/681WNX9X4X6PGr/rzVe6ucvevmbv/QX8euqHH+3MQfHN/DtrWOqt7qTcUXP/zNt2lSpDAhTfTibvgkE57cNdXIJTCRSJ3q6YY4UtbaRWLcEEg9tcKbPtepg+zbxp3Vdq2unHkhwMvdmkysBsVxdgetNv38Ca8+NDiY9kCyMGhxUTpu1ai8/bt1hJsoksEtrorkpaJO5Ome0d+k5bzgZEU5h4T3QbeI05rCmh4xp0eP8mfLg2RqydQlnk2awwpEULOPab7HZg3frOOuuVCbEFH6HZpsofn9Pnn1lN6eCaP6LHMfE/uBXoGKefUI/FvyF0ICzBy/rqEPIcezDolhcLVTZPmnJp3L+EC5bQg0cC3uSDQKZFtsteCG0wW/jeQF398uHjJhtSyOsgoLXXLQtKMgaQ7Qxg5SOxUvwfQIleljC6HI6dcZ+YXF0pBNshgFHatzoVgV8fBUO9RK3oAd2d2WiQcntCqmxeV91JxKzIqo62ptSk4ZarasGKbz6x76Uqmmy2kwsfcPW1dq5gdSUIySaWfaIKKblRkV+NKL97Q63uF+FvFLfbcYsfNvpyTwpv2KvE3eBLgALHgmXXW+u7NPb+4wY8GMTwhrvMykCWCHLO/kyWV175bjhl+MfGbleNafRhJ1OPZZczDH7Mop1nKjlky0tqKvzNGoUOpcjUskWnfLdYdbRq7jIg31xsixX7LWMboLp18J0gM5YOJ96m6u+ZGo+9TqU/bj86zwIWP7qbbxxmd3eMrFGGiTHViv1tm2jCmDWOPEzbI72scBRZym3RwOOAD4HDqf4cEQdAGLnpeS5HfsW+7NVQ+Eojq7ymOD/yXgykIhk/MvSDqmgYwTc15/cshvrPAiwrdjLGqY4V5Cy7Km2nU1zm7eXnrYy2quT+bvqRxZ3r6cqqyyY9G6UeQ5OfB3f8T4q2Q5ldEmtAuU7i5bcNc0Qxy39EtngXSYfVI4F+8dZnq+nJMPf6aL/UwTTbjjBcU0y6nk5EU7hRhLHhB3eEaxZXOXR5W95PDfeGhAQ2S1qJj5X2ZgV+LfcCYphKYmEY0uncBrp90mNXOYeUzchI7qhyHBirPS4W1lGNlzjjC4xnvptImpQchTGxKVJpp18bVq6qMpLAhU7TcsGJyezqg42ZMsg0nPrMXfGjDWTMMSR4Jl/6nivRE5qKM6GZb9Od4I3LikcjGNCQCQdFMicYO744vFjiCmQqXr7UZtsMi2yZaMKFxyAfDVgujIT0aa1tgom3wPe0j6NXcH1I078GHQwS/z3yY3U/P3X/uv9sI5YdI2mM6MyNrlH7W8dPnVbRs+sTSA/cXHY8NoJTQfgTFwDKCeYnT/T0dwNA89kCPv5SCpvurm+m45cYeeJ4+Yw4eAFfEE7Z9EZRNX7Ilf0yyVLnq2FBNpicGET5+FnTQIOmPRUDlT4KcNP6FPytqLFn4NYUms3p+f9tFqD38G3sUSSA= +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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` + + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-non-employee-record.api.mdx b/docs/api/v3/get-non-employee-record.api.mdx new file mode 100644 index 000000000..8dc4f5783 --- /dev/null +++ b/docs/api/v3/get-non-employee-record.api.mdx @@ -0,0 +1,88 @@ +--- +id: get-non-employee-record +sidebar_label: Get a Non-Employee Record +hide_title: true +hide_table_of_contents: true +api: eJztW2tz27gV/SsY9UPijKm3bEtfWsV2Mt5xEtePeqaOZwKRkISEArQA6UT1+L/3XICkREl+xHXb3Yz2Q1YmgYtznzgXJG8reioMT6RWR1GlVxmJ5KNWh5NprGdCnIpQm6iyXUn4yFZ6VxXcC/Kb7FgORTgLY8E+cMVHYiJUUrnerkTChkZOSSYkno+lZRBrGWcK00U+3Tjh1c/qVPyeSiMsMxqyQq0S8SNhesi+yEj1lLCmZwSPvgDHlBs+EYkwhOa2ImmBKU/GuKVwA39JgltGUALtV2UyYq8vLo4OtjDa+PWhfmJSsV0RPzhGkzAxbO0Nu+1We1d0252d5qAzGOy1m23e2Wl1d6M9TLbhWEx4pXdbSWZTmmMTI9Wocnd3TZLtVCsrLN1v1uv0v8ex6cFXESaQ7UwBm2IWn05jGTo/1b5amnq7unQxcWrIq4n0C8MkK/C2K0NtJhyyK2SGJ9qsWvkp69xtV3gY6lQlH51zVkGUF6VAEDYRtBT0lsmMZfMZebe8en8wmFXPJhLOxzpDaewTV1lU7ZVlbuYa+ZcyjiWfkPCYP1M2TVwjukAN98n4p6W6WWWJ3z3YqiXJf8uuV0Pt4E/HWv08djervEqn+I/ETlzSm8cFn49F4cejA0pszm54LBfcnGhmhbnBOMsSKhiLlQJgsrXKcL5yAIy0IDBWpyYUR2sj/UE1/cSV2G6G3cZefa+zsxd2mt1wp97Ar5DvDLv1sNFqtGjNiCdrs49HkaTFeHxSysOlArEMrJ/gxiBNBBvEelAb8BFDji5VzRLK5WLST2lhV3xgkYSb5IAnaz1fJD90EEEiEdsPVgC/PBV45uQymrdksXqjG9T3gmbrvLHX6zR7nW61sdP8p4tzFf0XkEDqWhzN+n04JjqSQykerof3A7kcC4XwpILoChX7zrMczwU/3SQhtrTkZZFkIh/C0K73Wp3q7i5hAAjknhu0uuXf3dH99rotaz+WZP1DYxCdATsVSWoU1exhCdFARzOGTJbK5Xr15fazSCQogPs6ekJReyeVCEaGS0IoHOQQExkk3sgIM+A6I5gXSaWJVHDjymaEJaoN9pZHLNuk2H6mDJnR8PAbZD2l/Fwoifksn0JEhLL8nmXFruCDnXq32R7utDlv7rUbu51Bd8hbrXq30+26oBbWojgulhhuDJ+tLP1eKGFkyGIdwiP/gkEQMLC9A+AWxxSZiIl93AdOxhPsT7Xfjy3UzPAyYnnbKG9v909Yexd5pEapu85HS0ZQwcUZMbw0jvmALhFPo33ZCf5k5EiqdVCESifEWg8O3/Uvjs9x5fTw7xeHZ/hFslaoal8hWiMKS0BFLIz1d4c4U4ByzIoY5kCSsTeZ1DdQiCu7OFD6v+wMXGaC2BryNE4wI1t9zYxF0Wxo9KSUSjklfi2rorrNBnQNFSIcswG3mKB9LXjTD0MxTYLjzJJv2Bi0WZitKusXWxLtvBCK+TMIYtirKHW9gGGKVAYYcAidgrjoRIZL1XVuyrI35rXkeNEplBxA/nic9MMkBbic+RfpUERLBjHzDzB7y5XRnS9VRDtTCQ+hBY/jGcxowGRRmaCbRD+SlSNyl0XhUfm4omItlkhX7j54MAeJdvdCnton5N1JjPITONWKGzciSz5L3MdXI+eN3E1ZRcJNUttNzkYV7soTHxRWxNEmdze5u8ndJ+bu8s3TrFHP7jrq01ilPheKp7CvcZvnCvUxLnqUZvkgR28yR24zGCSjSL9dniOxv4HCYbz4MaXDhxfkR34rX+0OCn/46wOiH4WzSr4ggM6OXoMhKpGIeg73HLEzlDdVa3W1d9oMJAJUraGIqJqGzXTKOExmUqUICbfbDM2cVa8SNuY3rmUEXl8BaVUVBVMtVbJhkhsmudmNNrvRr7MbbZjkJnc3ufvnzN0HmWSBymVLxpNsOplwM/ORlt33h+IYwPJHRvOnQM5Vy2yFhLGCY1XKzKEyaDYGjeFuKNoRb0c7re6wGe40eWe3sdsYtJu7lcW9/mqex0WSlXNqwd/ej87E7sDesFQhuGyidVQ+/oN5jRhSWaPSU/Bm2BwmvS64Y7O7yh3PtaZHirOcIdkSh1RzG1FNw9gJjTX5WAzgbIS6qBhKlQQuCiU5EZBiEDQslhPpkpe0gFwzC/rDBKr4RMmDrFhFqjBOgdBVglgTa9YILAklxZA4HyQ4BjtCdX5Bdpq56D9i8uyUND4mjdnhj1AISvSCuXfWne8eAbyhGnHmHXzPQa/vdrhCAKAh8DWr4J0bfr7h55s9frPH/xp7/Iafb3J3k7t/ztz9CX6esaH7+TkGPJmfY2y1zgou9Y6C639O012qZAhceDMdhqlxx805B3e8AqGUvf1HNYReqOtVaovvnQT+HTBbu5XRHcZ48u9hpSbG8HGSTG2vVruFt+Cluyqfymr+go/S3+ltpNpNa03toZcEfJ6hekVp6M6c+ydHWYdRdTY2ksLY1zy3gLe404oCFpZ3p8MPyqdXsciVM52iyjkx2wwhn4WUuwyYU/QTr2z24hZZaEVH6HZh4rvH9PlH6yE9vJB79FhnvgfXwngGlEvqEfxrchfcDkHOXxfAs++LVT8lV19dL445I3LuEa6MnG841NA1VwB9omFN9lZwg87BP+N4/dvl+RYbESV1JSG1xIaFpB4CSXWCMHIlr5+f99MktwsZnY7GTrl+6YkKpRgbxjAK+6zOhGBXR5mhPmIvOEXxdmanScLVC5p1/Tr3XiRuREzbZHVubQpOGakarFjjpXlbbkt0vYNU/tUcXK1+VgE7kFSpJG3tNCZT0bWC7Gqa68UX9HouiL/k0gIvLXDS7NYSCm/aq9C/oRMiz0kEj62z1rMX9/KCBXnUaOEKSV3GQJbIcJSfg4W5156NoyQvIHllHJ/V5Vhivy1PY768MYvtMo7YEQvHWlvxV8YodChVrkYpMu3ZsL7TooHLiKBZX4AU+CUDGYA9OnzHSAzlg4kPaPd25EWD16nIp+0X51nUhS/orSP2paSzu3yFTZZGRjq0z8ZMCwa0YODrhM3w+z2MAoteRIMOrg74ANif+99VggzoQl30stZWfie+5ubQ9hECqpNipz3/R29eBLNfzN2g0cUYlGki38WTQfzNMlm0kZWMlR8bLFtwFW+ssX8u2c3jLY6taE/9o+lLGvfnpyufVDx76Sp9TyX549Td/1PF21SaX7HSZHSYws0tm/UNi0HuGd3qWR8dRo8F/sVdl6mOd6OrcX2a4zCLYqYxTyimXU6HYyncKcFU8ITY4TbFlZ64PAQlpuRHL+gEjdw7vgaAOfo6GUNelV2iDVMhTEwtGL1XAalfddaLncHKJ+QkdpA7DgRqMkkVvXgPEOmEcYTHI96NpA1TX4TQkSmRa6YdjStm5RlJYUOmqLpmxEzspyEdJ6NTXXDiI2vBhzY7S4YhySPZNz5zRU5F7KKMxpUp+mOyETnBWMRT930HYKGlW1jhw9H5ikQIU/5rgao2o1o2ydZoLIRQO+SDoVVF6+c+vNA2Qce6IPe9SMANSy+0F99YlSLqdn6E/rJfUGU7Aw2oTem4ioCmvg3xjd9VZV3jh6k9GdHnXWNoRaNub+lcg9qgO7qMfp6a5qvreZfjug0YnH6jvRwincUDer7O1Ii22GOfbK3VIj+aU7N5V17Bz2+CmnmAR8sL+O60xUHzN/x5zMKUlScW1B0VPfL7Q7j77t8vszy+ +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get a Non-Employee Record

+ + + + + +This gets a non-employee record. +Requires role context of `idn:nesr:read` + +## Request + +

Path Parameters

+ +Non-Employee record object + +
Schema
    data object
    + +Attribute blob/bag for a non-employee. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-non-employee-request-summary.api.mdx b/docs/api/v3/get-non-employee-request-summary.api.mdx new file mode 100644 index 000000000..1980101b0 --- /dev/null +++ b/docs/api/v3/get-non-employee-request-summary.api.mdx @@ -0,0 +1,87 @@ +--- +id: get-non-employee-request-summary +sidebar_label: Get Summary of Non-Employee Requests +hide_title: true +hide_table_of_contents: true +api: eJztW1tz2zYW/isY7kPtjCXZshPHftlxHafjTtpkfdk82J4xREISWhLQAqQdrcf/fb9zAFKiJMdpmum2HT3EoUjg4NzPd0DwIbET5WSprTnNksNkpMqfrTkpJrmdKnWm/lMpX55XRSHdNNlKvEorp8tpcnj1kFx65Y6tKdWn8qgqx7h383izlZRy5HGdgE6nJiTe6aFKp2muxE/SyJEqlCkTDM6UT52e0PpY/WKsvXBhUXGv8xw/SqfVnRJS+MCFsENhQFrVpON43xUXY+UwEv/KeyvSwFolc1F55cXQOlGOlbiNE1TWwa1bMZHlGH+cLFSp3OG1EWKHadE0J8bS8zRnwXykSTzc6swcGuXdoVMyu90S2oj7sU7HIpVeCcyw7tp4/F/IaSNUSwwJAVuiyMnE2TuZNzIJ6b0eGZWJ0mIuuCx1WuXSCZmmtjIliJM6nRhM8RSDzYgYKceyefSdFzrrklj9IBZM6KD+IB4ULs0itUVhrpNCXSfCj22VZ2Kgrg3xqTPwFbWzqFQIUSlaDvTZkHECD+aF7zXU3lIHPVpp2SCREt5WLlUbfjNoVwTlEse+C+dsbOjZPTV5FBkXjwwe4FeLyWTZ+xQ0Bc3AwcXG5eXpm82VbC2qnhzrfmyLwGOUB3IPFFmj9uCsKy5nqtQGbEg2qzaZTmUZVDNvG5KJONZOITRLVykEYDpWhUwOH5JyOiGRPKibEUaCi0KWuFNVOhMbetjY970biaOs0GYzedxK1CcJQWhqPz3Yeb39uv96e293OxsOtnfoake+PNjb2957tZ1QNDvlJ9YgfmjN/vY2/ddWWyvOaz9vzDr4RaUlScKhg6DHfLh5TiJjfu8XT0QelgULM8msjlJUqQMLIURIIc1IDcKww0p7mqoYQAsUbHHiEy5mDYdjcDEfAuhFy19eBIXOOVyjyv6c+sHNbp8U7RQJ8BWc1hP/ME4nCi4IJ/qtjMZ5fxifZlaZjikCfzPDC4ym1mXfnk8wigzCEfZ0KX18pHF7q+LpONeUAU6cQ17piDNVVo4qgA6pqI6wgc04y2iDXIsE/+1CLFOl1PmxzdSqPNNm9q02qjNyUhOHillOMTGme3KOwqIeB5J1NuVxLTWSJro74ntkxKgocRyFIXU6mf4KWqfZ8wxdGo35op6ChN4U/hXLqn0lB6+2D/p7w1d7UvZf7+3svxwcDOXu7vbBy4MDWr1Q3pPd59aWzsnp0tI/KKOcTkVuU1jkv1AIkAF0zwzw4piiS1X4523ANL5A/+TfYWwjZuRXEFDZQoX9/viD2NsXuTSjiu/L0YISTOfynIpkledyQLeo1kDyQPi90yNtVrGiEFmE9N6cvD26fHeBO2cn/7o8OccV0VqCd0emLnaWw3Fs75njKMA9sIRXOee+rngRqb6AQNL4+YE6/PJTBGgB3xrKKi8xI66+YsY8aTF0sVbXoVSjug3dVd0t1G1Pxb0E+hkA/WSUIWj4i6M0VZOy8y5q8gVgiMyU2+yivGaahAR0Y+TjGfQNgBUyAkkRvwwrhLJi5GOrEtkIYE61bTFTZdsas5zybt4oFBzg/Hk/OUoZCNfgtQmHxlsiizUYyaLm2txdzCmNVTo1pUwhBRLoFGoEdkmRmSCbRgGI6YjM5ZF4TD2uyVjzqZLT3U+BmTel5WeprPwXxN2HHOmnw6I1D+5UDD5PEKsGn3JmppiR8JDE5skNpo26qANfDLXKs3XsrmN3HbtfGLuLD89iFxGfMvTZWYY+l0ZW0K/j4rkEfRx7j0EjHAcxvImG3KKGMEKkHz9eILB/VYbGq08TaqC+IT4KpXyJ+aPGHuH+gOBHY6yWLYhB1mOQYIhMpLJD5nvGMSsqqGp3ebW31g00HNSsgIiMVqe24q0QVxlDnEi/JTKrvPmuFGN5x20s+A0ZkFY1WWdigWHXSHKNJNfVaF2N/j7VaI0k17G7jt2/Zux+Fkk2XHG0RJwUt56Dp8XnvAEsMEDU+9miCTk21SJaIWKiwVhJGzkkg/7OYGe4n6q9TO5lr3YPhv30VV++3N/Z3xns9feT+Vp/NYvjJsjaMTVn72BHVjFA3B1wXGXgXL60Nmtv/0G9Tg35zVY5g8SwHQDc402DHfsHy9jxwlp6DTetEZJvYUgz0xHlNIwtaOz8yxgpRsiLRiBVafBFrqQLBSqO3mPkutAcvCQF6Lpp52hY0qs0DpTayZpVtEnzChxyJsgtoWYLx9IQUg0J84ECI9gRsvM3RKfRRL8LyYszkvgdSSxOPqVKUaA3yP3lqv3dUzDvKEecBwM/sdEbuh1p4ABoCELOanDnGp+v8fm6xq9r/N+jxq/x+Tp217H714zd34DPIxp6Gp9jwBfjc4ztbosGS70l5/rDYTqHSuSA3VvYlE/wZDMMzrgCrhRP1/E5JTosl/TmTyN0anjdi+rpPbSOIDzy4TvCi4HVyuUgMS7LiT/s9R5gQVjusSsnulsfYTL2vpvaone3uyIf0cGBEHvIaFmV8j700YfT2HV0We9Ok2uHPMgLBCuwpOTEsAbvGH+WPh29IvNObYXMx2S2BMIguhnfBpsT9BjfeR7dZbdakhGyXbr88Tl5/r37OTkCkSfkWKW+z66F8QJcLohH7N/MzkqeExgPqy+dmJwVGGrg+kuLvadhffG9kg6dQninsfHjx4tNMSIIyimg4kN/SlPPgCD6ABfhFHdU7+/TJK46zlajMTN+1HqDQiElhjkEFtfmXClxdRqV8DNy/xmSNauUJinODzTrZqO2TKbuVE5lsTvTJDmezkwPGurJ1rxNLoHcK2gTzs7gbvfadMQbTZlJUymnMVFEbv3E1aSWS87J9bVM/KOm1gnUOkzNby5wEVR7lYYTOSnimkjI3LO2vnrxQK8zR48aK9whqos8kCYiH+33Xmltta/mo0WvQ/TafFybj3wGtD1NhHRWnwY9FenYWq/+KQS5DoXB1ahCFH01W3zwtMMR0elvz7HUCUt2dAdokfl7h8AwwZnkgKo1gxULHGeyEJK3bFnE/C166UzctmTm21coqjQys6n/ap5pwQ4t2Ak5wEf+Q80ix6IjmpCB80BwgOOZ/TkTREbncl6gtTKrM/kez6HSkIJVpuInh+HH4SzBxSvBD2h0MwYpmMB28yaQD8IFWlS4WsqqtwkWNbjMb25RLxf0Fvhttqmohv7Z5CWJj2a7Ke9NPv3WWfqJTPLnybv/p4y3zjR/x0wT4S+5Gy8b+4R5Jw9obXlvz/NxePzFUx9OyQNno4sJ3w0QhpknM8llST7NMZ2O+YsRpyZKloT8tsivbMFxCLhLwa98IDRyGIOg9UCjcqBz0OuKj2i7TAoVU8tF5yhA9Rcbe69zaPkDGUm8qQ0HAFUUlaHPBsBEVQgJ93jGupn2aRWSEDowo2rJLMO4ZlYdkeQ2pIouNx+u8O+HtH2MznTOiM+sBRv6uHcMRZJF4mcRM0HOVM5eRuPa8Ps52vCczljlE2r6kEEBptTcCj+dXixRBDETDl13rRv14iTfo7EgQq1OcIbdLlo9PqdufYkOdY7uD6oU57MvSFqfItQvNxad62G2e77+4Gj9wdHv+OAoogIyUG9CW5PkpFVoL0OTf5WsbPIpjzbf1B22v0pC5ziGn9Pchwfa2aKm95FuYxRtm1zdzHpa3gtACNJ1lhwOkeDVZ9x94yx+TrTJdvmzfey0Up/1hrCZzvaCElz+qmgLqa27xxtMCNt9rJkwJmwIzs1eemVG7XqzSfPDCeUq+QTyixf0rePj4/8A7V0hyA== +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-non-employee-request.api.mdx b/docs/api/v3/get-non-employee-request.api.mdx new file mode 100644 index 000000000..1bed62bc0 --- /dev/null +++ b/docs/api/v3/get-non-employee-request.api.mdx @@ -0,0 +1,111 @@ +--- +id: get-non-employee-request +sidebar_label: Get a Non-Employee Request +hide_title: true +hide_table_of_contents: true +api: eJztXG1z2zYS/isY3ocmGVMW9WJb+nKn2E5GHdf22XIzd06mgUhQQkoBOpCMo/P4v9/uAqRISX6Jm7bXjDrtnUwC+76LZ0GQt56eC8MzqdUw8vreRGSnWh3P5oleCHEh/pOLNPN2vFSEuZHZwutf33pXqTCHWmXiSzbIsylc+3D3YcfL+CSF3x4Q8AsK7ETGIlyEiWA/ccUnYiZU5sHgSKShkXNkDGxHU5ky4J0yzhRMF8V0YyVovFejqTCCcfgvu9EstOxznrA8FSmLtWEZEhEqmmupsv57xVjQYDANRxg25SmMAIoaZHHTmY7ZRxmpvhKp6RvBo487TCpLKeSpoBk4/b0KuUIJ6comEUkErhY0vIHcWxXusxxGjC09faPgCrC+j1QDDD7nhs9EJkxKJpdopTkHY+94Cm7AXzLyVs1Ys3whl4zYi6ur4dFLGC6+cLiNs3kYBM1ms+vvB909Pwi6Tf8g2A/87rjVa4m2aDYPOjABiUgjIDQykwuIg3AqZtzr33rZYo500sxINfHuMACMSOdagTvwfqvZxP97goB6/EmEpDS5BeID5vH5PJEhBebupxQn31aY8yQ5i8kwTgxLA+1mMKAzaYUAG62JuuOBp2YcuHholoeNmOrchAJs2Khbr9lutvcOWn5XdLjf6cT7/jgKW/5eKPaCoNXt9MLAuwNz0fThRinqXC8to2HEeJrqUPJMROxGZlMbjLUwsVTrErXCXnDQPOjuHYTdVi/cawbwK+R7ca8ZBu2gjdLYwHmiJDj4mbJciIzLBDnWKD+RceXiM/mvE4L4hPokM7pdKXB25InMBEj7WDDxMNS5yk6fZEVXOkFwGUFIQ+lkbj5Zti7wjUwSyWeNdAZKot1iadInMqqG6w9QCHHmBhbvLAsknvBn0saJG0hfFlJDcoLbv5YqzXrAHv9w1xuhJvHnU62+XnaaVefSLf9BsjNanszjhLGmF64cHmEd5+wzT2TF05lmUPQ/Y/6shywI43jVxfnEQcBIC8rU1RCtiLUtddtS91tLnRfxjG+KKR5FEqnw5LwWXSur/ao+gwxujPNMsHGix7tjPrFwqKZATfJVZDDIkTEhiR1c/I2GnBpmYpaujz2RKUG3YhgDpWYOApawApg5obkxfAF/yoLa75xIdbEIplWDNxDtg4OxH4hu1++Mm9zn427oH/T246DV7ATdXuiVJrD1aHVliQEJK/A6lBlUuBI5Q1eBlsrfo6S9u66mUPkMMfzbs5+PL04Hp4fHv7y9OLs6h1vDo+PT0XD0L0TvS33Kq6smsaLEwI9JC3XL8igtzAeDJsuLFC4TVFlxVG5idD73NoZyoeVRpkcoP5hrs9M2SYT86y7pQv1oBt2o3YoPoITwoHsQuBrT7kYtcV9GFfRKh7yDvIUCiN77hlChJmuG7YG761Uy5TLjWb4hU5ceHZyfX4BTMXYvjn88PhzRz/Pj06Ph6Vv4dXo2+uXieHCEnjxEx5+cwIi1Tu0YyEGKzQHro6xqcn9DVOZBaoWr6lGRprDsoK5KRbkzE9UWZhBhDBfWilDBT9P4Crugkr9xojmZDuDEzDUbD/vHDVxWnDpxb1hcJhihIwz6h2sIVF/hZ5J8W+f1bipUtYqxG+5wV0F4ZS1sBj2/eeC32qPgoN9t9bu9RrDX+jcpCA1t9m0lcSQfkqHT7Le7jf19lGFz3gwq1f01NNm1kv9dBvJzQs0xX4k1F2mRowoXceYROOWbutlSFsmiCO01l7eafrPttzqjIOjDv52gEbQhCrp9aPsRDWbcZL9BrNqCah1ChiG6DOfdK1Cz2ad/l8IIFf0OogDVzYIEJEh3gyB/eHF4xEt/XIV4UBDaPNpQKIrtRxgAwnY2bSgdJhJ9cWwM4AefARzPjcKVNK5JNtYRwQ6pqFP7qr2mh4FURA3AoY6esNC/kUr4E8MlSihI5BAmMswwGWEJmmmDYB5JFhuENK5uTrBEI2CvecSchdihUwYLruHhr0DrKZ3YlZIwnxVTcKuwQNEb2Ip9wcd7zV6rE+91OG8ddIL97rgX83a72ev2ehThIk2hta0W8AJ+11m/FUoYGbJEh+CR/4JBIHDA9iQAMX86YicaT7A/du52bKmmk5fhbvAOANDXh+essw9JpSY5XeeTFSMo/+oSN2HzJOFjvIQbo7irQoTPjJzIjQ1gsXwdHb8ZXJ2MaPX659XxJfxCWmvr00BBtEYYlpo2i6f6hiR2CmCupSIBc0CysVeO6itQiKu0OlDav9JFit1IJGKeJxnMcNw3zKiSZrHRs1oqFVvnL2RDNHbYGK9BpQinbAxrecS0rQmvBmEo5pl/4iz5ik0FB1j2ssEGZY+J+yZAFOYvcHMcmk9MXUsgziGVBfXCOgckrDO52vwuTVn3xrKYnFSdgskBkj8eJ4OQHiwUTwjKdCijxYno/AMyW8vVpRutVMZ0oTIeghY8gXU11MaAhRk0zdAnpsyVI3RXCoVHFePKilUFU1TufrLCQBNE90Kep0/Iu/MEyo9PqpU3PguXfCm2lLYakTcKN7mK5PpNmuxGle4qEp/BMpRE29zd5u42d5+Yu6s3L9xjNHeXoE+wDn2uFM/BvoYWzzXoYyh6lGbFIII3zpE7uNviINKP70aQ2L8ClMOnp1/m+LTvG+Iju5Svb/eV/rDXx0UDViz9S1+ggGRHq0EMlUhEfZJ7KTEZypqqvc7tjTZjCQGqNkBEejy70Dk9Wja5UigJT3dYpEWqfsjYlH+mDX+Q11ZA+5TZp8fMWyS5RZLb1Wi7Gn0/q9EWSW5zd5u7f83cfRBJllJRtjiclOazGTcLG2nuvj3SAANYcaCLlSlHrlpFK0iMlRjLqyMHb9wKxkG8H4pOxDvRXrsXt8K9Fu/uB/vBuNPa96pr/fUyj8skq+dUxd/Wj2RiOm5hWK4guNJM66i+/QfmNSKmk4LZEhKD7wDA3X1YYsfOpiNrGegGhAE7mnu2F68uTpA+sCbyaDf7XB6TlkwHw3lGkBJjGCwt6Qn1FjpuoeN2+dkuP9/H8rOFjtvc3ebuXzN3vwo6dh6Djp2vgI4dhhArRoj1Z0LHCHAHQrMYnAI6hDmYV2XLEyJu99GlfcYNvgxSAL0aimz11lHkSGt8AWZRgKW0thOplubC8gZjZzjWFGNhAGcTKJGKQdWSgG4xquRMICaF+GGJnEnKY1QI6JqFP4gzfOuFcqaIt5KLVGGSg4RUFBKNe68aYkziOyoxwj+gQPugEyjU33CP03nrN+0HswvU+AQ1ZsdfQiEw58v93+6mUwJDEN5gubi0vr7nuIDdM+cK2gjxZW7LVwlBt1B9C9W3y/12uf8+lvstVN/m7jZ3/5q5+xVQ3aGh+6E6DHgyVIexjSYrsdQbDK4/HLFTqjgJKLyZDgmrR0sMTrgCQsm90I41BN+c7nu71ePdfgGvd29ldOfhO+4IDq1cuUlg/DTL5ml/d/cW3AVuumvwuWwUL2kofYOvJO5+bm8oPnjW1CYalK8oD6l5GJwPXbfRICMbiXFsix4xsCYntTBiwfR0yOBB+vTyGvhyAY0Is2R2GMS8iym6jOe5oaH4IXVvb6KJ1nQE3a5McveYPj+3H9LDErlHj03me5AXjGcg5Yp67sBw8UmCS0TelvvahwmWqwnu+bfWmJ3hsBZ7LbiBtsAeg3nx47vRSzZBvEn5nqcIdYXEBgEy5hxChOrZoDgSgpNoiTE6n0xJ8EHt0A3mD4sTUJi9V5dCsOvi1aFTKPQXUJnJpDhJUDHAWR9eFJ6JxGeR4BrYWFoSA09GahcstMtr817SekeNgVT2FDdcbbxXPjuSWIYkrts4xqlIfR67nhd68YpezxXibwU131LziVr6ckUKa9rr0B7iDiGJkQRPUrLWs5lben6FHnZRcAWprsqAlnBy1I9KhYXXni1HjZ6P9OpyvFfvphIW0/o0ZmsXS2EtTCI2ZOFU61T8nTEMHUyD60kOWfRssW6QqU8Z4beaFZF8y9KXPkBDku8EEkPZYOJjXJoJmWi7SUIp+ZE8Czn/ERrniH2s6UyXr2EFxZGRDtNny4wMfWTo2xqQOvntAoWBBbmNOlAdsAFwuPQ/VQInaKXmWVobqzqR36U5uDSEICpRSed9+0d/WeDcL0Y3cHQ5BkowIuvy8Bj8zRwteumpaqxiT2DVguvyJhoWxxW7WXnLJ5u4YP6/6YsaD5ZbJ2cqWXzrKn1PJfn/qbt/UsXbVprvsdI4rIvhRmxdU1ANcovW1jfy7KeN4H/hLmUqgWpoWYqPDwhWJTNPeIYxTTkdTqWgLYC54Bkivx2MKz2jPAS4i8kPjR4RmtDrYAYE5tC0yQToNdg76LFUCCbG/gqP3gLVT9o1Wpdg5XN0EjsqHAcAajbLFb4YDULkM8YhPB7xbiTTMLdFCNotJQrNNMG4claRkRg2aIoGdRpmlp7FuFcs8csb3hN5gQ9Tt1EMhkSPuC81LRW5EAlFGY6rw+/HaEPk+FORzOkDLiAW9GsVDj8NR2sUgZhyTye0mey6SekujgUi2OrYYGg3oK+jL6voNIN2tEL3rcgAG9begFx+E2zlixflBvn2a15rX/Ny6xtKuTvHHTU0d24bJdubXnsbe1OY25cRvr08BefgsNtb3HvBTu0OL8MwbOyvPywbMWpgIW7wN7TAMVQl8YC3Xly4b3y9rDt60/fDNupR7B+qxXLrwIOfvwrccQDpoS8H+WlLiGSzN+ymUWXK2mMV7PLKRv7tMYY4vwcwuB/4Jbq7u/8B+ZhPMA== +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

+ +Non-Employee request object. + +
Schema
    nonEmployeeSource object
    data object
    + +Attribute blob/bag for a non-employee. + +
    approvalItems object[]
    + +List of approval item for the request + +
  • Array [
    • approver object
    + +Reference to the associated Identity + +
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-non-employee-schema-attribute.api.mdx b/docs/api/v3/get-non-employee-schema-attribute.api.mdx new file mode 100644 index 000000000..64d9c26af --- /dev/null +++ b/docs/api/v3/get-non-employee-schema-attribute.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-non-employee-schema-attribute +sidebar_label: Get Schema Attribute Non-Employee Source +hide_title: true +hide_table_of_contents: true +api: eJztW+tz27gR/1cw7IdLMqbesix96Sixc9WN82hsN20dzwQiIQl3JKAApBPV4/+9uwuQokT5UTe93t3oSyKLwO5v37sQeBPopTA8k1pN4mAUzEX2VquTdJnolRBn0UKkfJxlRk7zTAQHgRVRbmS2CkaXN8GFFeaVVpn4lo3zbAHfXd1eHQQZn1v4HAChsKDETuVMRKsoEewNV3wuUqGyABbHwkZGLhEAsD9fSMvG7ycMcFjGmSUAjBcI2HTFJjGbacOyhWB2KSI5kyJmG7zOdG4iMYkb7IP4kksjLDMaOEcOK9Mz9lnGaqSENSMjePyZeYI5SMTS3GZsKhhXjEeRzlXGUsJscCfxJQYN0MeSG56KTBhLGpEoxJKDLg4CBQ/grxI76Bf0RwIFo5sgWy3xsYWnah7cHgTGYQUrZCYXB4H4xkEgXCNm3aPZsNftDcSw1z/sTPvT6VGv0+P9w+5wEB8FdTWCEpzqSuOh3p5dXEyOnwOznUitV9uvC5OYMhkH6DpgqqVWVlhk3Wm18L+HRQPCZFrwKFjPl8tERuTSzZ8tbrqpy6OnP4soQwMaDIBMOpYAoybzQQDulnKgHaD6gqrIPGq3W61WPxy0+4dhu91vhUftQTvsTzvDjuiKVuuoVxN7h2VQsXZlM5FW+E81OC1XdbWB3plET4RgqUUIfAfeGvNMmxXT4MJJwhREh/DRYb332kZVErQlYEh1TPF0rxaAtggzmYoaso8LoVyAbKP6yi1LOMRVwWGDO5i6PQxbR2Gne94+GvU7o/6w0T7s/BP1EkGEZv8jSJ72fWB6rVG33xgMHBiHoI5EqDzFnHd+8vdz+PN4fH4C/02OT96eT87/UU90J7CeGbEEhwe3BRqEEalijgFx+K7sB+lILLNNyxUsM5nRn3en73PEDDIkfCqSXUJsQjzFZSyWdpnwFaRY7fR4MfHpd4fzbQIb++T5FtML6k5ECwWRmdAXD/LHSC+3MMxRRfpd82NvfK7OlfwCUQGhXEnO1TglKA3loSxEsjyHUvAwClzJqGqsNQFF6GKyZYRFiUHGaFHwcVPWKc8eOQOJSCx0EgvzMPO/SFAfMc8WPGMzmSQWDTDV3zbZn0D2M+AxHgKVMdJYaapCA5sp/MFcMwGNY5rfHUJAt6BFnOq5RqpKwawlnA0slw7Ltp8U/nr1GBcPbm+RaG9X5XiVSDAMOzEGkIbQGmS5UQBcOqdCIAKdSccrFEyqa55ISg3fqbjEIuMyeaXjRzj/a6lEODdcIkJBkCPYyIDitYwxX6TaCOZIFnFB6zYdAzTRaLOXPKZWCOV75YXBgDQ8+gVoTXYm101AF86zii3g5aV372ArBoJPD1vDTm922OO8c9RrD/rT4Yx3u61hfzhE7qmwFpoqW+HNjeGrGusfhRJGRizR4BPyX6AQyNqgewJAzGGLhNppH7YB0Xhk8nFrSzE9XorHA4i1l6/es94Aqpqa5/Q9n28pQYUXZ9he5Qm4cKXKOsLvjJxLdV8xOT55Pb44xeT+4eSvFydn8Alp1YrJWIG3xuiWmlrUhf5KiL0AWOisSEAdUOnYC0/1BQjEla0ulO4v14iAb814nmSww3PfsaNKms2MTjdCqei3n8mGaBxAmsb6z7NowabcrivKizGVtfDUa/IFW0BPLszzBhvHsUQhoQBANAJR2L+i3jyOMXQdgVkOoQxgZLbQeQYZKJPbBWCtyk1rrJPKadUoVK0eUx7GUZYDuGKsKMOh9BYP0dsHMDvN1atHoTRS6UplPMowByYrUKMxoGEGCY5JGIt8OkJzWUg8qlhXZixMgYVYlO7eODDHmaZnEc/tI+LufQLpJ3S1r3hwLXzwgRton43IGoWZfEaCh9TQ4Ga/qjRXEfhQz0QS72N3H7v72H1k7G4//ODnZf+UWp92vfW5UDwH/RoqnrXWx5D3KM2KRdTeeEMe4NGIb5F++ngOgf0LDFSwXnxbYt/2HfsjV8pr4MelPdz302JaKkr/2hYIkPToJJhBJhLxiHCvEZOinKq6dW6vtZlKcFC1o0Wktnqlc8ZBZSZXCpFwe8BiLaz6IWMLfu2GNGtdBkSuKg6XWmLrve8k953kvhrtq9EfpRrtO8l97O5j9/cZu/d2kiUqihbfJ9k8TblZOU/zz1FazmABK365YWXIkam2uxUkxsoeK9jsHIJppz1tzwaR6MW8Fx92h7NOdNjh/UF70J72OoOgWusv13FcBtlmTFXs7exIKoYm7hr6uFyBc9lM63jz+A/Ua8QM0xqmnrJvBp2DSq/K3rEz3PHblNb46+aq6JDsRg+p1jrCnAZrU1xrirWwgLM55EWFx9gScKEryVQAFQNOwxKZSgpelALomlU4nuG5rwuUwslKLlJFSQ4IKRMkGrtmDY4l8cB8hj0fUKAOdg7Z+Tt2p95E/1Unzz6gxKcoMTv5FgmBgV527v1d57sTPAPHHHHmDHzHQa+bdrgCB4CBwOWssu/c9+f7/nxf4/c1/o9R4/f9+T5297H7+4zd/6A/993Q3f05LHh0fw5rGy1W9lKv0bl+9TadQsUjIPdmOopyQ8fNRQ9OfQW4kr+1iDkEb7ONgmb1BkLoLzs1b4rbbbdN18WF5TUGeFi5pHcb4C1H7CAd+NwkQHSRZUs7ajZvwKZgy9sGX8qGu+mRrZT+2oh02rzu7shQeJXARSPkuDiP6GQarzg6Jg2yhJHo7C4zEgNnF5Id3RrsQ2fI99IvrsisQFLmyBzglSLvePQ1wFzC1PGDpdUNcrSajCDbhUluH5Lnb9375HBE7pBjl/ru5QXrGaDcEg/hX60vpdJlEMe9djV1XXJwpOvUmL3DZR32UnADs4P7lePZTx/Pn7M5NqWUFHKL/bCQOEVAWL0HF6GkNy5O/HET1SGj8/mCgI83flPBIGOzBARmn9SZEOxy4pXwFqrBB0jfpFLcJChj4K6rZ4VlYnEtEiyUjbUm0fFkrJqgoSbf2PeciiJND1K5q3LwbeOTCtmxxFwlsbjjGi8iDYPsclnIxStyPRXEnwpqoaMWEjX7fAuFU+1l5O7oRBDpSIInlrT1ZOaOXlihh6MWfINUtzGgJjyOzV/CosJqT8axQS9Eeps4PqmPCwkVd3MbcwmOWSiYScwmLFpobcWfGUPXwTC4nOcQRU+G9RWZhhQRYadVgRQ6lqEMoX8kfKcQGMo5E59i/ab2RUNnp2IXkp/JshDzn2G6jtnnDZnp60sos7gy1pF9MmZkGCLD0OUA6/G7KoaOBbGNMlAecA7wam1/ygQeaCXnOVo7szqRb9IeLA0RQCUqdjlyf4zWCc5/YvQAV5drIAUHdA/R/zaIV+U8LSxlG8oqDg62NVjHm2iooFt6c3jLgyusqr81eVHi8fp85Z1KVt87S9+RSX47eff/lPH2meaPmGl8Q4zuRmz95FB1ctet1U/78Dh6IeBfeEqRSp03zDU0qVEPUyWzTHiGPk0xHS2koHOCpeAZdn4H6Fc6pTiEdheDH6ZBIjSnq/YGAHOY7GQC9BrsIwxiKgIV4xCGNyuA6s/aT2NnoOX3aCR2XBgOGqg0zRXsxRjLU8bBPR6wbixtlLskBDOZEoVkmtq4clcRkeg2qIoGjSMmte9meKAMs2rFiA/wAhtaf5oMikSL+Fds1oJ8EAl5Ga7bbL8fog2eE+KtdLrKD7BgqKtweDM5r1EEYsrfitdm3vSbbBPXAhEcdZwzdBsw/NEtdW0zmFkrdH8UWf2Voh1vXW072M36TP3393aXL0ZItrnEMzLUTe6mGjdtXga7pk3YOqq9TVUZOPF59b0wmGEWoHEkd3ODpy44ft3i119ygSP95dV6uqKpFJwBP8PwO4NUI+5R+jOvpfg5/W50z2thd8hbnByq1frQIICPvwg8a6iKgaPk04GVL4I9CUep7tsrer+D0wsWoCn32B1eVTbWft7BQbI8UPjxBKOI39GT+A/4uuPt7b8B9/P9Ew== +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

+ +The Schema Attribute + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-non-employee-source-schema-attributes.api.mdx b/docs/api/v3/get-non-employee-source-schema-attributes.api.mdx new file mode 100644 index 000000000..1f9e2e030 --- /dev/null +++ b/docs/api/v3/get-non-employee-source-schema-attributes.api.mdx @@ -0,0 +1,96 @@ +--- +id: get-non-employee-source-schema-attributes +sidebar_label: List Schema Attributes Non-Employee Source +hide_title: true +hide_table_of_contents: true +api: eJztXFtz2zYW/isY7UOTjClLsnx92VFjp6uOc1lfNrvreCYQCUloKUAlSCeqx/99v3MASqQkX5LtbtuMHtrIJHBw7uc7EKDbhp2qTObamn7SOGqMVP7GmpPJNLUzpc5tkcXqPB6riezleaYHRa5cY6vhVFxkOp81jq5uG5dOZS+tydXnvFfkYzy7vrveauRy5PC5AXpRSVCc6qGKZ3GqxGtp5EhNlMkbGJwoF2d6SnyAi4uxdqL3ri/AjhP5WIlUu1zYoXDMi5BzZsTQZjzCTVWsh1oloragF6GfNMXFWGVKSPx3ICbSJDK32axKSSYJZudWKBmPhVGf1lESssjtBAqLZZrOmqKXJJq4lulsSxTQhIilIVKimBKtdkvEhcOUykrECwTUUFk2lKCZqbzIDDhIU5ZlLXtDm6b2Ezgc4LGZrSPby8XEunxLSCydy5Q01j6oEvmkscSgXFElzQ/mTP1S6AzvMguzxN6QNPOjTsyRUS47ypRMPoqgaBZygsWJDskax7YwOTENg2Y0k+3B6mrCWaYykxMFWR27iyYLTyUcZath8AJ/uWAk8iw2cOPotpHPpvwOvJtR426rkXlG4aZ5VqithvosYRsao4Y7B8PD7k53Xx12d/c6g93B4KDb6crdvZ3D/eSgsepgc3vqpEHeCgVMrXHwbizdabXon/qc3twJfUCIWkSw3uDLmCan0xTuQdO2f3I093ZVLJllcoZ5OlcTV3luBz+pOCetZRSZufYcgcsVlWw14PtwRTy5vOwfN6oakXG73Wq1dqP99u5e1G7vtqKD9n472h10DjtqR7VaB90VrSzLJWAR6N3NHJisrD+w8BRpVrUKswhN5od3L0eqwLOFX1vDzm4QYCoEmAsu45pVScjU4GFiEw7uB7UA2irKNVxqmbP3Y2W8Vy5z9Uk6kUpHgeNXqK0OT2gfRq2DqLNz0T442u0c7R4223udf5NeYoRF/j9iKdB+iJlu62hnt7m/75nxHKxyokwxoSx8cfLPC/x53Ls4wT/945M3F/2Lf62m3hOMR3aYIh7gzqDBPBJV8nyIA05XWUYOUNO8brlyyVzn/Ge1rtQrygXxDBlSOVDpOiHqLJ7SMJFoN03lDPnQej1e9kMtWON8dcZ6IWO9oexDulPx2FBC5wePrk/JYz5FUAorc95iPfE6JMjC6F8QFQjlSkasximz0jSBlbFKpxfIv49zQSMFp+qFJlAZLvtLRhjPedAJWRQ+ns2LZlieVgaJWI1tmqjs8cX/htrlF8/HMhdDVBVHBhjYz/XlT6jGwWMCC1w7WGNzU5UaqGf4R3NNHxqnKrA+hEC3pMUrreYabSpVaiXh1Hi58rws+0npr9dPcXGSbiI/9322bx/c3dEa3XV15mWqYSdxkmVgPBJnoVL7xKpYLkW+ZZOZYBRxI1PNmeJLa9A9tSZRudTpS5s8IRZeaaOiUSY1caiY5RgTBSje6ITSx8QCcXmSZZjwuLqfQBPNtvheJuIsyPcyCEPxmcn4Z9Dqr821dYYuvaOVU+D0c2dfs6zaV3Kw1zrsdId7XSk7B932/u7gcCh3dlqHu4eHbDblHICNW1O860v/oIzKdCxSCxfRv0IhSOLQPTPAiz+93jONJ+YiP3YuZuCXw5OQ4Pcv34nuPoqcGRX8XI6WlGCiy3MCY0UKj64UXU/4baZH2jxUW45PXvUuTynXn538/fLkHJ+I1kpt6Rl4a0JuaRkmju0nD+69AFT3nEqhDhQ+8SJQfQGBpHHVgdr/5XEJfGsoizTHjLD6mhlV0mKYATZXQ6nEvM90UzW3kLUJDsgcTcBAukWBedHjKhedBk2+EGPgYpU9r3YBAtEIopg/Y3zMPUVINsMCoQxmdD62RY6EhC5iqR4sVFm3xiLHnFaNwsXrKdWiF+cFmCuh/Twc5t4SWAz2Ac9ec6vFpFQaq3RmchmHXghqzDJoWCDfCY2+LaQjMpdD4jHluHnGohRYisXp7rVn5ji3/C6WhXtC3L1LkX4iXwrLFzcqBJ+jJsxnI7ZGaaaQkfCS8Q1NDqPm5ioDH+VNpckmdjexu4ndJ8bu8suz0F2Htwx92qvQ59LIAvrNuHiuQJ+MvcdYUQ5ieBMMuUXbEwEi/fj+AoH9M/orjFefpwTjfkN85Ev5mv2B0h7++aBsnsrSv7AFMch69BIMkYlUcsR8LzhmRXlV7ayu9spmAw0HNWsgIqPsmS14sysrjCFOpNsSiVXOfJeLsbzxPZtzPgPSqiaJplYTEt8gyQ2S3FSjTTX6VqrRBkluYncTu3/O2H0QSc654mgJOMkVk4nMZt7TwnuSVgoMEOX3PGIecmyqZbRCxMQcYzXqyKEx6LQH7eF+rLqJ7CZ7O4fDTrzXkbv77f32oNvZb1Rr/dUijudBVo+pir29HVnFAHE3wHGFgXO53Nqkvv0H9WZqSGmNUs8cN0PnUOn1Ajt2V7HjG5tDNhAGdszu2V68PDsl+liayZPe/PdlFLSsOr/1S5CSfBia1i7fQMcNdNyUn035+WbKzwY6bmJ3E7t/ztj9IujYfQw6dr8AOnYFQawhQazfEzomwB0EzYYwCmSIC6jX5IvTHWH3MYR9LrORyudAr4YiO4erKPLCWjrENyvBkqvtRJqFuii9YeyExmblWAyQYoQUaehshAa6Ja/SE0WYFP4jUj3RHMckEOhms6g3pMMEPmZKf5uvok2cFuCQk0Jqae/Vwsc0ncIYEvwDBd4HHSFR/4Z7nMFa/9V+sDgjiU9JYnHyOVaKYn6+/7u77pRAnw5WULo497a+57iA3zOXBm2E+jz16WsOQTdQfQPVN+V+U+6/jXK/geqb2N3E7p8zdr8Aqgc0dD9Ux4AnQ3WMbbbEHEu9Iuf6vyN2DpXAAbu3sDFj9WSBwRlXwJXCHR3KIXSD4qixXT3WGoUT9Nu35Y2Ku22P4iJZv75DmNGzW2QpyIzzfOqOtrdvYUVY764pp7rpDwznM2M/NWM72b7ZWZOT6Aiqjz9ktaSIuaeguzt+kSbrPtPk3j4X8gLeEiwtOTIswmcPHqRfnrSeQTbhyWzRyfTgavwYbE7RZ3zneHSTXWtFRsh2maV3j8nzj52H5PBE7pFjnfoeXAvjBbhcEo/Yv17ctuIzxX71lTtXiyJDXwV0VhZ7S8M64nslM3QL/nTMsx/fXzwXI4KhnAYKRwhYaeobEEjv4CKc5nrlSRGaxJUns8VozIz3amdxKKzEMIXA4oM5V0pc9YMS3iD/nyFhs0ppkuIcQbOun5WWSdSNSqk0NheaJMfTidmGhrZlbd5zLoPcL2jjb1zgafODicSxpuykqZzTmCAit3/ialrKJStyfS0TfympRZ5axNTc8yUuvGqvYn+2O0ZsEwmZOtbWVy/u6UUVetRc4QlRXeaBNBH4qJ+gikurfTUfNXoR0avz8cG8H2vU2Po04VOacCiRaSL6Ih5b69RfhSDXoTC4GhWIoq9m6xMtGnFERJ1WhaXILxnpCIiR+TtFYBjvTHJAFZsBi/V7JxySH9myiPmP6KcT8bEmMz++QmGlkYmN3VfzTAtGtGDkc4AL/Pu6RY6F2CYZOA94B3i5sD9ngsBoJed5WmuzOpPf5jlUGmKwylTc9Mj/cbRIcOGT4Bc0ej4GKbjB11nCmTK6cRFoUfGqKavcKljW4Cq/qUXNXNKb53f+hSfV0T+avCRxb7Gj8taks986S9+TSf44efd3ynibTPMtZpoAgcndeNnQK1Sd3KO11f092oAeK/wfbzlSGWujk+HejDFMlcw0lTn5NMd0PNaKdwamSuaE/LbK69+IQ8BdCn6+VA1CI76xmYFhiV5Op6DXFO/RepkYKqa2i07kgupPNvRf59DyOzKSOC4NBwA1mRQGcynGCrrdLR6zbqJdXPgkhC7MqFIyyzBuPquMSHIbUkWTG5Bs4t4OaQsZ3WnFiI+sBRuWd56hSLJIuMi9EORMpexlNK4Ovx+jDc+J6HIj3wgFW2jjKiu87l+sUAQxE760sNloO0xy2zQWRKjV8c6w00S7x5cdrcvRpVbontLd7pWL3et+AWDZxW4X++ibHy74pn64INRqIrs9pU1Dcp3CN32+/b5qrGu/MfVo5ScNqh04eroxxKX5t7e070Tt6B09/qVQtKlxdb3oNrlLR3DQZ7T/Q6Re9YALPgtqSZ7zN2eLXzm4R55yq9TMFrskDXz8WdHmylyMu2u+nSz5ejAY8q/9Llll4sr3SNS/zncufjih4JX3QKHwgX4+5O7uP2Zb9ww= +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-non-employee-source.api.mdx b/docs/api/v3/get-non-employee-source.api.mdx new file mode 100644 index 000000000..316b3f5ef --- /dev/null +++ b/docs/api/v3/get-non-employee-source.api.mdx @@ -0,0 +1,95 @@ +--- +id: get-non-employee-source +sidebar_label: Get a Non-Employee Source +hide_title: true +hide_table_of_contents: true +api: eJztW1tz27gV/isY9WGTjCnralt66XgdJ+Mdb5z6spnWyTQQCEnYpQAVJO2oHv/3fueApK52vN5Mm+3oIQ5FAud+Dr4Dgnc1N9VeZsbZk7jWr4109s7Z48k0cTOtL1zula7t1FKtcm+yWa1/fVe7SrU/cjbTX7LDPBvj3qf7Tzu1TI5SXNcwPyoJiFMz1GqmEi1+llaO9ETbrIbBsU6VN1PiC66XY5MKsE6FFBbTdTk9ZQHq4nKsvRYS/7JbJ1RgnstE5KlOxdB5kY218PpfuU4zHUd0ZyqzMf54OdGZ9n3x0QrRZFI0y4uxTMMsB+kKksINxWcT277Vqe97LePPO8JYcTs2aiyUTLXADOc/2hT/T+Ss5CmknZXSEqNWYASreWgcGEJHaYVUyuW4NWF7+FXyWSmewlhnk9lHW7II5ElomdG4mXC3tg7vVEqm7B9DJiXt8cjiAX6FqfDwquWDhwU/0V8k7E7DW6rXPGgcDPZV62DQ7jYaTVzJllbd/V5DyiYGk1DGa8RM5nONCFFjPZG1/l0tm02ZZeaNHdXuKTS8TqfOwlX0vNVo0H/LciwFTZBWuMGvWmWkIHsHgYNpcjpNjOKA3f01pbl3C7xlkpwN2QiFFIEG2chToGcmyGDidUl3aoiaiQSX2tXVyes1U20S0cT1JcPJRrvR3jtoRV3dkVGnM9yPBrFqRXtK7zWbrW6np5q1+525PzZI8YCDhExTp4xEeItbg9DOKGk2ZcsmV3b3DlS31VN7jSaulNwb9hqq2W62SZoQJE+UhAY/U5ZznUmTEMclyk9kvHDzmfzXCSE8UbhMxo/XCt+pyTSk/VowISS9u+HsWw3rU5NyTZkP2SmJSe/lDD/BY5IuGOEBJuHpuqm0zSdUdd+e/XJ8/u7w3dHxP9+en129x6OT18fvLk8u/071dm6E6u6qmU9ipJgZgp8wQ65Dhu9kM65cMC+yI5nfRImVYkRaWWlh1pF3+bS20ZwnxZzXmbsk+WH0zRm4SSLiv1yeuojhRrMbt1vDA4SxbHYPmkWct7txSz/k1ZLeuR5iOYHMHxA7SEIaXpTlsEo96srl+r316Pfq0YmLSffHK32MGhJlZqLXRP0w1nYRVYhb4IVE4qIkvFJoG81e1DiIWu3L5kG/2+p3e/XmXusfZBoFJJF9W0kKko/J0Gn02936/j7JwMvwg4WOnkPMzqaV+SgxhGCOvUd4RAI1PPcWdbeIqFKmgYs5qoy9kUlYFp+8aj+eJzGvGkcufsIa9cZYHY28NCShZpEVJgqqvibGDDjP0wpAJCmbSQUet2xIWKLeFD/KGPoG/Y4KZSgOvVS/gdZTlu8razBflFMQ9xVa3cBW72s52Gv0Wp3hXkfK1kGnud8d9Iay3W70ur0ecZ/oNEXhWSwwZeFZZv1WW+2NEolT8Mi/YRCEDGzPAjDzp9cqpvEE+xPmDWMrNQt5BcHrHdSXH4/ei84+MsmOcr4vRytGsNHVBUHXPEnkgG4RwoTmgfCZNyOzETWUhfP18ZvDq9NL3Dk//tvV8QWuiNZa13FoEa0xhSVERSyM3S1LXChAWZbqBOZAmolXBdVXUEjadHGgCb/SGVqPCWJrKPMkw4yC+4YZi6TF0LvJUiqVvcgLU9f1HTGge6gR6BAG6BBidAU8/NWhUnqaRaeFJV+hNZGx9i/r4jCODSmJ4o5sBFFuVQbAbXFMqRsIDHOksmYA5fIMq0FmVhHT3JTL3pjXktNFp1ByQPKvx8mh4u6tbLmqdKiipRCx8A9kDpZblu5ypSamM5tJBS3QBsxgRvReCpUJuhm0lkU5InelKDy2HFdVrMU1hsvdz0EYrHH8TMk8fULevU9QfiJWrXpwo4vkQxi4ohqxN0o3FRUJD0ltnlyMqtxVJr7A2pPE29zd5u42d5+Yu6sPz4v9iOIpQ5/mOvS5sjKHfT0vnmvQx3P0WCfKQQxvCkfuEJguINJPHy6R2L8BxGG8/jKlbZNviI/CUr4m/GHlj3B/QPCjctaSL0hAtmPQYIhKpOM+yz2XmA0VTNVe5/bG+YFBgNoNEJG3s2Yu5/07n1tLksh0R8ROp/aHTIwl6iP6KsgbKiBxtXE0dcb+vv2fLZLcIsntarRdjb7r1WiLJLe5u83dP2fuPookK6k4WwqclOaTifSzEGnFc95HFhggyjdjoko5dtUqWiFiosJYtWXkUBu0moPmcF/pTiw78V67N2ypvZbs7jf3m4NOa7+2uNZfz/O4SrLlnFrwd/Ajmxgg7gY4LrcIrjRzLl7e/oN5vR7y69hsDonhOwC4+08Vdmz11rHjpXP0dnhWIqR0CUPauY2opmHshMb6ciwGSDFCXbQCpcpALgolM9Gg4hE0IjETw8lLWoCun0WHw4xeAHOilEFWcTFWJTkk5EqQOELNDoFloKQeEuYDBUawI1Tnb4hOCxf9ISQvzknjU9JYHH9RWlOiV8i9u2l/9wTCe6oRF8HBD2z0hm5HWgQAGoJQsyrcucXnW3y+XeO3a/z/xxq/xefb3N3m7p8zd38HPi/Q0MP4HAOejM8xtt4QFZZ6Q8H1X4fpnCqFBBzewik+gRjPMTjjCoRScdiTagidFOzXdhePT0XFWcPdu/Kk2n2NToH6m/KQYe4TTBpn2TTt7+7ewWfw1X1dTk29PE9i3W1ducnuTXtDBaKjAiHbUMPiXPHO8+H7k6LPqLOlvaFgDpWPGQS7s24UtrA/7xE/Sp8PrMGhM2giApkdgcAvAotvQ8wpuoofUh5d50Ba0xG6Xfnk/mv6/NJ+TI9A5AE9NpnvUV4YLyDlinrFcY/y0O4Fwe/Afe3o7nxJoZattcbsjIa1xI9aevQG4S3Gi58+XL4UIwKdnPR5SnhXG+oSkDbvESJc1A7LHX2axOuMd/lozIIfLr0zoSQSwwQKi4/2QmtxXR7seYdqf47yzCalSZorAs369KL0TKxvdEILYX1uSQo8E9tdWGhXLs17yYsedwfGhuM3uFv/aCPx2lAtMrR405hCRW72xPW01Esu6PVcIf5SUosCtYippS9XpAimvVbhDI5CJhMJmaRsrWczD/SiBXrUSuEOUV2VgSxRyLH8pkuVXnu2HEv0IqK3LMdH+4FPRi9PE6GAiRQLYhKLE6HGzqX6r0JQ6FAaXI9yZNGzxeLj2BFnRNRqLIgUBZaRiYAPWb5TJIYNwSQHtD4zPHFAbjYOKfmZPYuc/4zuORafl3Tm29dYRmlk7FT6bJmJYUQMo1AD0kL+sEpRYNFhM+jAdSAEwNHc/1wJCkEXal6gtbGqM/ldnkNLg4KoTCWd9sOP/rzAFVeCH9DoagxKMMHr6t0ffouCFp/KXDRWuTGwasF1eROHFXLFbkHeamOKVs3vTV/S+HC+f3Jmk9m3rtIPVJLvp+7+jyrettL8P1aaAvBSuDHbojNYDPKA1tZ388KnOPiLp5ypjKzRt5QfHNA3GXMy00RmFNOc02psNO8DTLXMCPntUFy5Cech4C4lP7o9JjTic7weAkt0biYBvbr4gEbLKpiYmiw6OQGqv7qi27qAld+Tk8Tr0nEAUJNJbulgNYTIJ0IiPL7i3dikKg9FCD2X1aVmjmFcNavMSAobMkWd2w0/Sc+GtGGMXnTBiV/hBR+mxW4xDEkeKT5PmityrhOOMhq3DL+/RhuRE411MqU2DxUUYEovcPj55HKNIojZ4jMR50e7xaR0l8aCCLU6IRjadTR3dGvq0gw96QLdtzoDNlz6NKj6aG7lI5dqk3z7udsf+9ytWAtJgd0pbcGRa/LQVIVm9rq2qZnF1H714RX6ozG8SWPv7mjHhlq7e7oN7rQdcP1p3rlxx4tAo2s0zkOUMf2If1+cFx/HvRSL39dtlLvcYLSz+d5CDZe/adqSqMRF+w6BeeeIhQmPw97SwsS1ty/UB1b9/ttjSgL5AKQoLuhrzvv7/wCacEaT +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

+ +Non-Employee source object. + +
Schema
    approvers object[]
    + +List of approvers + +
  • Array [
  • ]
    • accountManagers object[]
    + +List of account managers + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-oauth-client.api.mdx b/docs/api/v3/get-oauth-client.api.mdx new file mode 100644 index 000000000..96417aeaa --- /dev/null +++ b/docs/api/v3/get-oauth-client.api.mdx @@ -0,0 +1,95 @@ +--- +id: get-oauth-client +sidebar_label: Get OAuth Client +hide_title: true +hide_table_of_contents: true +api: eJztXFlzGzcS/iso7kNsF+9DoviyRevwMitLXh1xVRSVA86AJJIhMAvMSGZU+u/b3cBwZkjqsOJsEhdfbIkDNL5u9PE1NOBdRcfC8ERqNQorg8pUJKc8TWb7kRQqqVQrVgSpkcmiMri6q1xaYfa1SsTnZAiD4LOKjQcaJ9QCmjGYc8WnAieuPDCCh5Xr++tqJeFTi1NPUQZzK9kKPAiFDYyMEQxAuZhJywCPZaFIuIws0xPGFXPTnNQ6LBRzw+ciEcYSRolzYw7oqhUFD+A3GSKeYCbmvDK4qySLGD+1iZFqWrmvVoz4byqNAP0Tk4p1HKK0JiNx4jOfxxHKEZNOf7LX7XR3xV63t9Me98bjfrfd5b2dzt5u2K+gzkbYWCsrLAJoN5v4X3mZMwAhbMJsGgRChCJE3QI0NuwDjOZxHMmAdqrxi8Upd+s66fEvIsBtiw3uayLdgoB4Te9VNUcHaN9kRdmSpu1gr9Vv9ju9sC16rZ1+s9ULO+1Jf68Z8Fav30JbjlMrlbD2hEy/vqhKo4iPUdxDtsZNy6Bk0uiX4YeR9xZmZzqNQjYWkVZTlugSzGEwF7VzHXGDgGZ6LmJwyUsTvQxPJoBdnh0zbq0OJE9EyG4lWAlx6VslTIY4B1nCNEuSeNBoRDrg0UzbZNBqd7o9xKceMFQZyJDNUgitGkYRwnVWmmjz2KIHYq6Lz+5XpH6pNYas8PsTCg8VPfEhk1owWIYWs4I28jfy5U+BDkWVGTGBEJl9SvSvQlUhzEM/9VMAgQn/Sw4JYBLpW4tqcIgRay9w8A88kiEkqHMBwRLaglYSYmcqDMCClec8cR912mvGJa9L52O3i9YJwlTjlmEEClKRwky5VASyU8Ej4bcbRIIPi4bY7TUpw5B6fzDgzIq/C3B/p9t0kEPIiUFyaWQRIzeGLzZ4ikzE3G7Mrqs+FEnIct55IKkZfQMIs9UgyEbWucsyvtb9hRyhCPrqoQC7BgBTw1VyAbA26bHEXYZJObDN3uFUhnNh6Gqw5M6+fzw6PLn4tH92eAD/j4bH5/gYdgiRbXw4vLz41+nZ6Mfhxej05NP+6cEhfHh2eHR2eP6vTxen/z48wYKYyITkv8s0eMyeLm23601GCjOEa9e2PQC3HovcwmUrboS1UYEVrHlMkpFWzYkOmwUTDGCvtIogsTONDjzBH187lyiBLdn49OjoeHRyuGkfvKFPT/yAbGjBgsMc3H0mYRNIQreW2dirOB1D9UW8EGsT6TPS67IXnJ4cjbyJHoG5MuzD5dvj0X4Rq1szw4pJwSheLF5jrSPB1XqRUEyqEEkC2ZXdzgTosVoiSi6AmcE45mFZthTkDzY6OCkqN4H0K+5RCQz68OuBgQ33MgkLgCoui7kFVgUbQp1H/z5P41ib5GsisE6kZW4VSje4vY5rbTJCEHE5t38kFPwcuDa4mE97OOl8+P6YubVRgPryNLlUAGhEGfjSS5eVJ4QRtUTOxcbqg0+pSuOIKguBA6HXII65jCAlUU2qOpwrWt5yyzIEJXrZbO3Wmru1Vuui1R90e4PObr251/8Ro2CuQzmRfyrkiEOeTeNwE+5+rblTa/cu2s1Buz1o9+utZpdw4yTomjbiXi2hf4we5fSfK4K+A9MykrBKd+qM+i9cwyagKawD1UTpBFuyzAwMHFPcCLMoLpFaIMtVoO5QlVS0gH8CkA6wF16m700WhUQ0SSMKf5dYJwswEOCXwawgGAiOAdqjGXJ+iB0eJPJGwAKkCjFGJ88A7b1x/dPznMsGOhYv5zi4SROeRrh10PWSNDvgUbRerc/p2XqBqZfLcAgaDHgsfe9cI5GDiTQ2odU2PXXbDpW41NBeuea31JWVeyLfgZSRPsqwH6ezK8yxRL9KJMFXyEKFy8vL5pS/nnnzVFZIEdmGFgmUSIgeOWuf+Wa8cn+P1upuase9Mx8aA25ZY2ciSY0CP5Nu63zNZGMdLrCGSUVk+iv27O7QYx/S+NPd4RFsbg3sLBGhIMiU/5Fcw+ZAMM01xI4TmXkfjSsHCVii3mJveciy04h9rwySJsODX0HW6BmHCZdKwnyWTWEy7/42LCt2BR/vNPfa3clOl/N2v9va7Y33JrzTae719vaoAIDbgMduovDlpd9hQgOqRp2A/I16Cw62JwC0eGU9kh/YA5LxDPtjWnZjl2p6vAzPyqCfZW/3P7DuLuReNU3pcz5dMYKqXZ6vJR0sIST41Mip3NizZ7zy4PBoeHl8Qdz8P5eH5/ATylo7V1vlIjN9S4i9AlghrIjAHJBC2Rsv9Q0oxJUtDpSepiwsGJP5FAgz/OobZhRFs4nR81IoBe5gkb2SdVGH+oGfQT2EGjDm1tUaHP4GqXyc1I69Jd+wmeChMK/rbBhCIgIlgcFCNIJQmL/AisDDEEPXCZikEMqCeJOGGgUlTQaivBe5KVdLQJZQjoubgsEByJ9xihMkKdJrVLMYhUtv8RD9/gBmZ7kyuouC0cikC5VgMYSRUA0DbaiRxvoroWj6dITbZSHxqGzcMmNhCszUonT33oE5SDQ9C3hqnxF3HyA1qxqptnxwI3zwIanw2Yh2I9smn5E8faHJftRyu7LAZ5Dbo3Abu9vY3cbuM2N39WHGe/xToj6tdepzqbJWEpRYoz6GvAdoeKnf9BtZxRMST5G+/3jhDyKxx/8cIyH9ivzIlfI18MPlfrjPx0g/lptV2gsESHZ0GkwgE4lwQLhzxGQoZ6rO+mpH2owlOKjaQBEhaxq20Cm1LSZVCpFwW6VOSn2XsBm/yU/FtGvVhAprsZauI9gyyS2T3FajbTX6NqrRlkluY3cbu3/P2H2USS5RUbR4nmTT+ZybhfM0/5xe4GEwgGWvw7BlyNFWrbIVFMaWHKtSZg6Vcbs1bk12A9ENeTfc6exN2sFOm/d2W7utcbe9WynW+qs8jpdBVo6pwn67fSQTA4m7AR6XKnAum2gdlo//wLxGTDCtYepZ8mawOZj0OueO3XXueKIT0A0EA3c0Dxwv4isnIB+WJvFoN52awP3hlEwHw3mSH86Lz5LOiLfUcUsdt+VnW36+jfKzpY7b2N3G7t8zdr+IOnafoo7dL6COXYYUa4IU68+kjiHwDqRmE9gU0CFIwbwKaWMMqsBP/vTRh33CDb5gkRG9Eots7214aU1r9p6rRUaWbOkkUuXmwvQGY+c4tvDGFyCaQopUDLKWBHaLXiXnAjkpvhUSybmkOEaFQK5Z1IaTBLRyMZP523IVqYIoBYSUFPzL2eBjEtxJTJD+gQQ6B51Cov6KZ5x+t37XeTA7Q42PUWN2+Nm9hM+W57+9TW8JjLI35s7dXj/wuoA7M+cK2gjxOXbpa0lBt1R9S9W35X5b7r+Ncr+l6tvY3cbu3zN2v4Cqezb0MFWHAc+m6jC23mRLLnVE79L+vxk7hYpHQO7NdEBcPcw5OPEKcCV/UxZzCF40HVQaxauutnEnw/sK3p1FUujwpHj9kG4p2UGjcQfbBNtzX+exrLuXnpOF0rf1QM8bN50NSQffMXUBBmkrTANqGvAFYrdInYxrJPqvS3a0gDP18uVkMDm9XPCo/Oz+5QIaEObEVPFejPcl+hhgxtBIfGdpdJ18Z01H0O3SRPdP6fND5zE9nJAH9NhkvkfXgvEMUK6oh/Cv86vO58i43eprF57zKoIbvn4zz98beyu4wesd9PrLq+8/Xrwu3MbDd7GnTEhsDCBSPoCLUB4bFm8bUmkxOp26yx3D0ss2+9nljjr7SZ0Lwa5G3ggnkODPICOTSYelmyzXr7KdCcWNiLD21XNLouPJUDXAQo3yDZjXVOeoIZDK3VGAT+s/qRo7oPe8JdZrHONVpP6OXcWZXsVrBS8F8Y9MWs1Jq5E0+3oFhTPtlb91unp19MWL+xftC/Jq9FZ7DaWuYnDXmAhH+RWp5ZWcF+MoyauhvDKOn9RHujRRnsZczsouTY9YMNPain8yhq6DYXA1TSGKXgyLbmrUXApsNwuQam7JmqwBJSR8xxAYyjkTH2NJJkai3eEIheTPtLMQ8z/TnY6fSzrTx1dQOXFkqAP7Ysy4YA0XrLkcYD1+/10DABZi2903hqB3DrCf7z9lAg+0kPOcrI1ZncQ3aE7F31AgKfmNkTzB+Z+Yu8dQXblVMqjkL43B78zLwupUMlZ2FrBqwXW8kYaiuGI3h3f5F00slH81fVHjYX5kcqqixdfO0g9kkr9O3v2TMt4203yLmcZzXHQ3WtY3A0Und2xt/QAPT5hnwtKlNopUItPQquQXVIti4ogn6NMU08FMCmr9Y8ETZH5V9Cs9pzgEuovBDw0eCZrSfS8DgDk0azICeXX2EXorFYCJsa/CV25B6i/aN1jnYOUPuEnsINs4IFDzeapgLsZYOmcc3OOJ3Q2lDVKXhKDNUiLTTBONW87KIhLdBk1Rpw7DzO3pBM+Iof0sbOITa8EeWn9ADIbEHfFfaJMrciYi8jIcV6bfT8nGC4QzEcV0SxVg4X24fIX3o4s1iSBM+b9KaDNt+Em2gWNBCLY6zhk6dejn8KNY2wTa0ILcdyJhxe/9WXWku/w4/NlfAORzPZL0RoynSrh06poG159dVUr9GcwZyBDvB+I3ReDjuzs8d8Bu5R4/hn4bm9qr67wZoSYObOevv9NN6kewvzrzVzBf019O1r8/aCPo7MBMLfJeuQI//iqwxYZ59/hFC+4MhAC5B+6UpDBl7e8I2N4sO9d3h7i3/IFK6X8A5SEX/A8Ftb89 +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get OAuth Client

+ + + + + +This gets details of an OAuth client. + +## Request + +

Path Parameters

+ +Request succeeded. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-password-change-status.api.mdx b/docs/api/v3/get-password-change-status.api.mdx new file mode 100644 index 000000000..ba947e540 --- /dev/null +++ b/docs/api/v3/get-password-change-status.api.mdx @@ -0,0 +1,95 @@ +--- +id: get-password-change-status +sidebar_label: Get Password Change Request Status +hide_title: true +hide_table_of_contents: true +api: eJztW1tTGzkW/iuq3odJUthg4wDmZcshkPUUSVgumwdCbeRu2Vam3eqV1ICH4r/vdyR1+wokmezOJNUvM0730dG5n+8I9V2kcqG5lSrrJ9F+NBL2hBtzo3RyMObZSJxZbgsTbUSWj0y0fxmVr9lbnvGRmIjMRlcbUSJMrGVOjMDmfCwN6530mRa20JlhdiyYcayYGjLO8pJL7HYB3X8KYWyT9ZhVv4mM3Ug7ZjIBd2mnTN1kQjOlmdWFsSJxvONU4jXjeZ7K2KnAeGHHStMK7E88pQaxVSzmaQohvFRNqJNzzSfCCk1K3UWSpM65HeNVhhf4l0zw28RjMeHR/l1kpzk9NVbLbBTdb0Ql+2gfQomNSNzySZ4SzdZed6/bHba2+d6wk/DdvXan291pdVsv93YHfNCNls11st4arP86ur+inUyuMiMMydHe2qL/LTI4q0xLhn7AuNg2Vpklh4HBnNk2PxvicreqrRp8FjEtzDXFiZVehsCQImbZMDBfkaZ8QIbwdlmOjAflI3W/yoxwAsWUWCeFyIoJhWv/3b9PTt+/OT08O8PTo/67/tk/Dmmfo17/GD9WQnfZF36HebnmWUIEobXSZk4GrjWfYoW0YmLWhs6qSTwTlhRE8oQTK0ku11oz59NU8YQyQGbXPEUcX5GlVKFj0U/+iKTHEl5CkHle8Bdt8eXStuNua29rb3u3szPc6bTjrRb96na39vY6W602h5zYEgnvzFw6IlSg+3t62VkX/Qe+EBySDVmDnbqag7yXPh3K8BqoZDpnleb3y4dEWC7TA5WsDcVFYY9kJhojzSVJ6NzOYixk4HgtE/L+RGnBPMsyox1dcyEKYYlmi72Co0+DfgdBGbKh5vFv4LU+QxcFusgk1rNyCYouG1KlXb+t2BV8sLPVbXfgQs7be53W7stBd8i3t7e6L7suKSfCGLSGdZG2uPUbgbIuY5Yq1Gf5OwyiBYftnQBu8zXB+YAPHI8vsD+ljKet1AzyMitu7Qaa06uDE9bZZSkiuXDP+WjJCFnj4myl1EFzz/i9liOZPVaVXh8e9S6Oz/Hk9PCfF4dn+EW8VopRL0O0JhSWEBWxMFY3TuKgwA03zIgU5hBJk70IXF9AIR56biCUoQNP0TwniK0hL1I02xdh9zUr5lmzoVaThVRyeXNr2TPZFM0NNqBnE27jMRtwgwXKV4UXvTgWuW0cB0u+YGPBE6Gfo88niSQlecqQjWCK9VMwYjxJKHU9g2GBVBYODKjCskxZGYtFX8xMudx4ykJyPO8USg5I/nSc9GJbQDin5nwWVtESRAz+gczecovSnc8ZzZl0mlkeQwvgkSnMqDUszAbQTVrDQjkidxkUnqykqyrWfH105e6tF+a1Ve5dzAvzBXl3kqL8NJxq1YtrEZLPEF7y1ch5o3RTqEh4SWq7xYGqcleZ+GwoRZrUuVvnbp27X5i7yy9PA+YPbx30aa1Cn4ssjDzUPFegj3bRk6lyLvrdT0nekRs0TwWI9OuH8zB3gV7c5jTXfEd85Fv5ivC9yh/++aDEvmXrn/mCBHR29BoMUYlEsu/knknsDOVNtb2625HSA4kAzdZARFRNzaaqYBwm00WWkSTcbLBECZP9YtmYoz5yZIQxvgLSrlnSyJXMbI0kayRZd6O6G/083ahGknXu1rn7Y+buo0iyksplS8BJpphMuJ76SAvv/TE9CFh5+syqlHOuWkYrxIxVGCtaRA7RoN0atIa7segkvJPsbHeH7XinzV/utnZbg057N5rv9ZezPK6SbDGn5vzt/ehMDBB3DRxXZAguY5VKFo//YF4thlTWqPRUuBk2h0mvZtixs4od3ykL3cAY2FE/cLx4cXpM/LG1Y09288eklLTOdCDn1kFKimFYWn7PQ/kaOtbQsW4/dfupoWMNHevcrXP3fw0dO09Bx85XQMcOI4g1JIj1Z0LHBLiDoNkQToEOcQHzZgQbc6iCX+H0MaS95XokbAX0FlBku7uKIs+Volsz0xIsmYWTyGxmLipvoJ0QrS5pQcDZCCUyY6haEuiWokpOBGFSxA9L5US6PCaFwFdPG72hhVY+Z8p4q3aRWZwWkNAVhVTR2atCjEmEkxgS/AMHdw46QqH+jmecwVt/6DyYnZLGx6QxO7yNhaCcr85/X667JdCH8JrKxZn39QPXBfyZOc8wRojb3JevCoLWUL2G6nW7r9v9z9Hua6he526duz9m7n4FVA9o6GGoDoIvhuqgbW6xCksdUXD93xG7S5UggQtvpmKH1ZMZBne4AqEUbrVTDaHr3fvRZnlXteHvqjb8vfTNO5ncg8pPAl6wQqdYMLY2N/ubm3fwF/x03+S5bJZX0zN104zVZPN6e031ocumPtNQv5IidtMDXV33mzSdlbWkQPZVz23gbe70opCF7d0tg0f50511cuYUkwjzbDYYgj4ElXsMMXNMFL8YR910QbSiI3S70On9U/r8a/sxPTyTB/RYZ75H9wI9g5RL6pH4V+QuOB6MnL8uIM+BL1e9gpx9eTVPc0bw3Eu4QjlrOfSHgfaKQO+JrM1eCa4xO/i7Ms9+/XD+nI0IlLqiUBjCw0LSFIG0OkEYuaLXK++N0CLXh7QqRmOnXG/hZg4lGRumMAr7mJ0JwS77wVDv0A1OUb6d2WmRcBWDVl09K72XiGuRUqNszqxNwSmTbBNW3OQL6567puimB5nh58Q9bX7MGuy1pFolqbkTTVDRDYPsMi/14nN6fasQfyu5NTy3huNmni9J4U17GT75iJHpxIKnxlnrmzf3/Bpz/GjUwhPiuiwDWSLIsXifKi699s1yLPBrEL9FOT5mH8YSHXdxGfMFjhk0zDRhfRaPlTLi74xR6FCqXI4KZNo3i3VDmzZcRjTaW3MiNfyWDdkAfnTyHSMxMh9MfED928EX5U9SXNp+cp5FXfiE6TphnxZ0do8v0WaJMlGx+WaZacMGbdjwdcIE+X0Xo8BCbpMOrg74ADiY+d9VgiDoXF30vNZWfsd+062h9hFDVMfF5Pv+H/uzIhh+MfeCqCsalGmC39UNM/peKfCiVrZgrPLgYNmCq/KmCh10yW5e3urPn9RV/2r6ksa92fnK+yydfu8q/UAl+evU3T+p4tWV5mesNAEQU7i5bcPkMB/kHtGtnvbRcfRY4L946zLVIW/MNf4TTcIw82zylFuKaZfT8VgKd06QC24JHW5QXKmJy0NAYkp+TIOO0UiDBklrgFj5QKbg12QfMIhlMUxMQxjdzwXXzypMY2ew8gk5ib0uHQcANZkUGX0ACiGKCeMIjye8m0gTF74IYSbLRKmZcjCuWlVmJIUNmaLpxhE9Me+HdKCMWXXOiU/sBR+acJoMQ5JHwjenM0VOReqijOgWIfpTvBE5jbFIcxoDUUEBpsTcDm/75yscwSwLf8JQerQZFplNogUTGod8MGw3MfzRo1wZi5l1ju8bYVn16aT/dLg6aK6+IV4IrbvZafoP8L1w6Ds0MGzmdBxGZij8kOMHy8to/WCJxfv0DeZGNIbViO7ujk5OaMy6p8fQhMbyy6vZFOWmGTiUfmOAHaJcLH9JO2++Z6dB9OfskU+JH1CiPPnLprOhP8LP3wSdFUDye/p81B/mOLn8C3/cM7dk5Q8iNHpVI/ibQ8TS/X8BC3/LzA== +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-password-dictionary.api.mdx b/docs/api/v3/get-password-dictionary.api.mdx new file mode 100644 index 000000000..aca025921 --- /dev/null +++ b/docs/api/v3/get-password-dictionary.api.mdx @@ -0,0 +1,128 @@ +--- +id: get-password-dictionary +sidebar_label: Get Password Dictionary +hide_title: true +hide_table_of_contents: true +api: eJztW+tT2zoW/1c06Yc+Jg4Q0lLY2dlJgXa4Q1uWx/YDYS6KrSRqbcmVZCBl+N/3nCPZcR6UttvZe9sxnaHBlo7O+/yOIt22dC4Md1Krg6S10xoLd8StvdYm2ZMxPuZm2mq3HB/b1s55q3zJam8v2q1E2NjIHJ8AkdOJtAwoWZaXw5NqOBtpw9xEMG3GXMkvtHZnoPrM6U9CsWvpJuz98Zs/+3tvD94xXriJNtJNGdA04nMhjUhgKIt5mgIdeNo/OoD5p0By5XIyFTBYsVgrx6ViqVTCwkzuGDdiZ6A2OvAuy4Ry4V1E/I2ksY7FE2547ITB9R8/etwmWkPBNrov2ZmSsU6APPzKtVQgMS4g1NhN2oyrBFdgcqw0Mp0URqoxy42OhbXwcaC6HSayHISjhQdqs8NSDZIJejDHCD0grq3jBlYiRQ1afvw/By1kEGS0MhFBRcBljVqbiBlhSW7mjOAOxnHLgL2Mp6SgSgkD1ev4NYPekHV3j47p74hJx7LCBgY9f0qr6HoinbA5j0VNm6gcrdLpvSMscQlG1tci+cdAsfCT8RuZFVnQMtMj4oo4BQWstspA4b+j+7wj48iGqzwk04ZUrVi3/Xx9PXjFEz+kUA5VUWOZXrcXfAjlqyn/aQclmOMgrI0KKxc+O30dvayrADXUQd4fsROe5WlN/U7ceBL4+vLy0o9aJaPNKFTQ8OX44DRC/Xl2cv9E8NSJHEr0EnxFavx8LYybDhQfxgn8xp+BKpmC1/zLjb22gSdIHFbEBYYvJI/b1pkVZhe97Mb1Ia4xochE7ZTTo9naUcYVHwtU6A44atK6uIM0A86bg4cLSEW3re76Ov43n3r6K/2znAf8BCfHmcjGWp6C4vEvG09Exun5NBdAyjoM19Yd/LRbvVWL7aYSDb5vDKS0iB0LVxgFypKjEGqfC1T6UCeUvaS64qlMOvNc8DxPZUxZcO2j1at50cOPInYwEUwC+dpJr4JEgNuku+Dny3wvJuXX4IXR2IC0wKEglilKgOKVTNClye09yTKsaBwyLG7I/YAOaKKzwV7xBOT18u0GYUBNDhz3E9DCWvIQQxCmMJ+VU5hMqtKwYlmxJfjwxfp2tzd60eO8+7K3sfV8uD3im5vr28+3t3H1DNIqOI2trc2N4dOlpd8IJYyMfYDKL6AQ8DHQPTFAi8MU8PvMPmwDH0oPi4v1KSSEUszAL4UylAv2aveI9bZYytW4oOd8vKAEFZ2dwBNVpCkf4iNnCgGSe8LvjRx7Z15kRagiw2jb23/dPzs8hSfH+/8+2z+BT0hrqYL3FXhrgm4JrIIvTPS1T7NegGsoGlakoA6RdNizQPUZCMSVrQ+U/i87taBM8K0RL1IHM8LqK2bUSbOR0dlcKMU+ebAnsiM6bShw8CzjLp6wIbcCKwoNf9aPY5G76DBo8hmbQA4R5mmH9ZNEUlpIGUQjEKXsD5WSJwmGricwKiCUBZUwXTgsDjIW87aYqXLeGhAE0tGIw7pRMDiA84f9pB+7gqc+vdejsPKWwGKwjyjLzDx3pzWlkUqnUGEgHyJqmoIajQENsyHIJp2tKr9E3UPmLcdVGQtTYCkWpbu3npk9p+ldzAv7DXF3hMk2ItGqF1ciBJ9FyOKzEVmjNFPISPASxabJYVRlrjLwob6JNGlit4ndJna/MXYXXx4HqBTeEvTZWIY+Zyo0Zlg8l6CPIe9RuuzefJMXDNmGzq+ESH98OA1tH4wXNzk2dz8RH/lSvgIklvbwz4dlb1OW/pktkEHSo5dgBJlIJDvE94xjUpRX1ebyaq+1GUpwULUCIkLWNGyqC+p1TKGoy+LQTCRaWPXYsQmH/MhjbBh9BsRVVRJRX9MgyQZJNtWoqUa/TzVqkGQTu03s/pqx+1UkWXFF0RJwki2yDL9AIE8L71FazmBAtWnHqpAjUy2iFSTGKozVmkcOrWF3Y7gx2opFL+G95MXm9qgbv+jy51sbWxvDXnerVa/157M4roJsPqZq9vZ2JBUDiLsCHFcocC7rtE7mt/9AvUaMMK1h6qlwM+gcVHoxw469Zez4TjuQDQgDdjT3bC+eHR8ifdwuRvKoN12YGL9gCarzXxsgpKRtbnEjrWugYwMdm/LTlJ/fpvw00LGJ3SZ2f83Y/S7o2HsIOva+Azr2GEKsEUKsvxI6JoA7EJqNJJ4ZYXEB6lUIG3MQBT6F3ccQ9o6bsXAV0JtDkd3tZRR5qjV7y9W0BEt2bidSzdSF6Q3GZjjWlGNhAGdjSJGKQdaSgG7Rq2SGx1MM+A9LZSYpjlEgoGumUX+EZzx8zJT+Vq0iVZwWwCElhVTj3qsGH5PgTmJERy/MlPZBx5Cof+IeZ7DW/7QfzI5R4kOUmO3fxEJgzFf7v89XnRI4AOYNposTb+t7jgv4PXOuoI0QN7lPXxUEbaB6A9Wbct+U+9+j3DdQvYndJnZ/zdj9Dqge0ND9UB3P1n4rVIexnXVWYanX6Fz/d8ROoRI4IPdmOiasnswwOOEKcKVwmh5zCMejrq21FcdcW3hAFlGhZ6gwKQycOJfbnbW1W7AT2Oeuw3PZgfQFpnJTpa87sc7WrjZXZB08ZOojDPJWUtAqeDw+tBkd0q6R6MA+29ECXtckD7oq6JxOF3yVvuIZGXEKHQjzZNoMnD04Ez0GNnPoJB5bGt0h51mSEWQ7M+ndQ/L8Z/Nrcngi98ixSn1fXQvGM+ByQTxk/2J2nvkEIbdffelU86yM4GZ/d2mx9zisy14JbqAf8Odfnvzx4fQpGyPQpEAv8IIAExI7AwiVI3ARSmT98iwITqLaYnQxnhDj/bnTNhg4bJSCwGygToRg5wdBCe8gwx9DSiaV4iRBWQBnXTwpLZOIK5Fi8evMNImOJxO1Bhpa43PznlKho45AqhHeJwjXOiK2JzH/SCzYOCaISA0eO89LuXhNrh9l4lFJLfLUIqJmny5w4VV7HvvT2zFEL5LgqSVt/fDinl5Uo4ftEzxBqos8oCYCH/NnpOLSaj/Mxxy9COnN8zFQHyYSquj8NOaTFrNQBNOEHbB4orUV/2IMXQfD4HxcQBT9MFvXuGhEERF112ssRX7JSEaACYm/QwiMcAuDD7EmEyTRfneEQvKSLAsxf0kXLS7nZKbH51A6cWSiY/vDPOOCES4Y+RxgA/++MqFjQWyjDJQHvAPszuxPmSAwWst5ntbKrE7k12gOloYYWCUqNt/xf+zMElz4xOgFjq7GQApGSF2dGsPrH4EWlqc5ZZWbAYsaXOY31VAVF/Tm+a2+0sRK+XeTFyXuz/ZM3qt0+rOz9D2Z5O+Td/+ijNdkmt8x0wSQi+5Gy4ZuoO7kHq0t7+DhFvNEwG94S5FKaBp6FX9ZEDFMnUyecoc+TTEdT6Sg3j8X3CHya6Nf6YziMNypFOFW5JjuNhpgmEO3JlOg12EfoLlSMagYGys8cwtUP+rQYZ2Alo/QSGyvNBwAqCwrFF49BSaKjHFwjwesm0gbFz4JQZ+lRCmZJhhXzSojEt0GVdGhFsNk9v0IN4mh/6wZ8YG1wIY27BCDItEiiLaxe6kEORYpeRmOm4ffD9EGz4kmIs2xtYMMKvAO3WyFtwenSxSBmApfS2gzXguT7BqOBSLY6nhn2OxAQ4ePcm0d9KE1um+EY6suGi/40+1sW7y5ctxcOW6uHDdXjunKcYB1teu9dyFL3Ya9mPPWqr0Y6O4nkIvw9e0t7jHixsQdPv5cCNzAOr+Y7TvgX0DW7zXS5s0nQXtctBs528aaY+Oitjf0Zh+TJ78HioYPuMjd3X8BgLAUBg== +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +``` + +## Request + +
+ +A password dictionary response + +
Schema
    + +string + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-password-org-config.api.mdx b/docs/api/v3/get-password-org-config.api.mdx new file mode 100644 index 000000000..71df21783 --- /dev/null +++ b/docs/api/v3/get-password-org-config.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-password-org-config +sidebar_label: Get Password Org Config +hide_title: true +hide_table_of_contents: true +api: eJztW9ly2zgW/RUU5yFLWZJ3t/UypdhOyl1O2+Nl8uC4JhAJSUgoQA2QdtQu/fuce0FS1GI7487MpFN6SSQSuDh3xbkQfB/ZkXIy09YcJ1E76qvsTHp/Z11y6voH1vR0P1qLMtn3Ufs6Kt+J8CYPM6ObtShRPnZ6xF/b0eVAe9E5OxZOZbkzXmQDJUblZOv6ImYBoinO1e+5dsqL0/N3/+ocvj/+bS3MtKnCSCHzbGCd/oNXEj4GXmF74oVOTLuU2IDERpDYdkomLwDZqzh3OhsD9n105ZUD5Ex9zTqQR6o8Nj+6mUAlgBpZ4xU0v48219fpv1k1z1VPOWViJTL7kIpNYIlpaZORADkapTpmZVqfPUm5j3w8UENJn7LxSEGu7X5WcYaJI0fuyXTAEOc+s8Nj4zOXxyTBHxnZTVVSm9q1sJs00bxHjk1Cy8KgdwMFqE4EaVPIuiZX9JSE45SAG1VYoykuoWCiejJPM3Er05zf9mTqVZOX4zdRm5+sReqrHI5SQIJQNcF73dfZpf2izJ8B/THIgb0h6GP0X8V5WIT3e23yLHigwKvhzr5ykNazbiiz8Ghrc0EBhlKIoaidh6+NGAbpD8DeIcgYoof5MGpv4LP8Gj7vrtd02anpsbE+o8WJMn2K+OeBT3n2EugP4N2dwbtbw7vxSw3vbg3v/gR4M53R52ix+ExqQx9NAfLfo+7bXxqERRgsGmx3MiFk28sS/yDVyGdx5Bxis4EaRlVOIYd6XAYcaprymejaZExW0QYG0sl3LAWJyqROD2yiamNhFG36C358q41q9J3UhFAx5BgTBSTe6gQzxNA68iWJJFeTCjyOAFfGJ0s0N8QbmXDNJv0OCmXIgU7GXyDrOHka0JXRmC/KKUInAqH40LJqT8nu7vr+5nZvd1vKzV+2N/Z2uvs9ubW1vr+zv0+rD5X3sj+To9I5OV5Y+p0yyulYpDaGR/6AQVDvYXsGwItjis7U0D/tA5bxDfbnPOKxlZoFXkEb0pqQ4s3BmdjeE6k0/Zyfy/6cEUzj6gJPTJ6mFLhVuQqCTx3C1yyDogwl33V0ePS2c3VyiSfnR/+4OrrAJ5K1sHN3DKK1rLqIhYG9Y8SFAnfSC69SmIMq7etC6msoJItdvhiowzc/9jBmWScwo1h9yYy6aNFz2JrqqRSH3Vu81E3VXBNdeobiFQ9EV3pMgAtp+OtOHKtR1jgpLPlaDLCfK/eqKTpJoklJmYZy5TF/DEFCJgmlbhDQy3k/udNgHXkmjM10rGZ9MTXlrDemVeyk7hRKDiB/Ok46cZYDHKtZz8IqWgqIhX+AOVhuFt1lzWhs0rHJJEolRqZjmNE5WFh0oZvOvCjKEbnLo/CYclxVserFmcvd+wDmMLP8Lpa5/4a8O0tRfhqsWvXiVhXJ54k+hWrE3ijdVFSkglvx5GJU5a4y8UVPqzRZ5e4qd1e5+425O//yvGh3irdMfTYWqc+VKTsyKLFAfQIVN3aubQuOXKN+rqBIv364DFSSqfvXEVrA78mPwla+AL5T+SM87xL9qJw14wsCyHYMGvRQiVTSZtxTxGyoYKqtxdXeWtfVCFCzhCKiajoxtrmQMJnLjSEk0q+JxCpvXmRiIFEfJTLC+1ABucVJGiMLtr5ikismudqNVrvRz7MbrZjkKndXufvXzN1HmWSFirOl4Ek+Hw6lG4dIK96TtlJggCgP3kWVcuyqebZCwkTFsaJZ5hB1Nze6G729WG0ncjvZ3drvbca7m3Jnb2Nvo7u9uRfV9/rraR5XSTabUzV/Bz+yiUHibsHjcoPg8pm1yezxH8zrVI/KGpWeijfD5jDpTcUdN/cXueOlteK9NOOSIfkZDmmmNqKahrFDGuvKsRggRR910QiUKg1cFEp6qCDFIWhEqoc6Kw/LIdeNG51eBlVCopRBVq2iTZzmQMiVILXEmi0CS0NJ1SPOBwnMYPuozt+RnRYu+lNMXpyTxieksTj6GitFiV4x951l57vHAO+oRlwEBz9w0Bu6HWkQAGgIQs2qeOeKn6/4+WqPX+3xP8cev+Lnq9xd5e5fM3f/A35esKGH+TkGfDM/x9jmuqi41Fv+7f9/TdM5VQoE4bKCjePc8XFzycGZVyCUihtQVEMkXQGIWktuCPHdImKFAVDuUgwcZNnIt1ute/gJ/pk05Ug3Ub7gqmxs7F0ztsPW7daSqkPXA4r7Uc4m4VIDX4AKizTZuk5TAIdqxwsEWxe3KSIPm/O58KPyjRyyE8c2R31jMWsCwV4EEz8GzBE6iReeRzc5eBZ0hG5XLp08pc8/tx7TIwh5QI9l5nt0LYwXQDmnHsG/mV4FuyDKHVZfuBA23UaoTVu8DHNKwzbFGyUd+oHwy8XLXz9cvhJ9Ipqc6Lknjqs031SS4gwhwoWsU57i0yTeW5zN+wMG3pn5nYQSR/RSKCw+mgulxPVxYYTfUOHPUZLZpDRJcRWgWTcvS88k6laltPk1p5akwNOJacFCLTkz7xVvdNwRaBPuAuFp86NpiENN9SfcBMOYQkVu8MT1qNRL1vR6Loi/ldIaQVqDpflXcyiCaa/jcO8mRvaSCJl6ttazFw/yGjV51D7hCUmdx0CWKHDM/roVl157No4ZeQ2SN4vjo/kw0NhFZ6eJULSExyaYJuJYxANrvfq7EBQ6lAbX/RxZ9GxYd7RogzOisbleg9QISzZ0A5yQ8Z0gMUwIJtmlPZkpiQVbM0lIyU/sWeT8J3TMifg0ozM/vsbWSSMTG/tnY6YFG7RgI9QAX+APOxMFFt18gw7hSiUHwMHU/1wJCqC1mhdkLa3qLL7Fc2hroAuqLMWP2uFLe1rgyvty/IJGV2NQgolSV7/34bsoZNH2NGOs8jBg3oKLeFOLXXHObgFvdRhFO+WPpi9p3JmemZyadPy9q/QDleTHqbv/p4q3qjQ/Y6UpSC6FGy9bdAP1IA9sbfEEj46YBwr/4i1nKrNp9CrcfTGHqYsZpTKjmOacjgdace8/UjIj5rdGcWWHnIegu5T86PBYUN9hDJLWg43Krk4hryk+oLkyMUxMjRXdloDUz7bosC5g5TNykjgsHQcCNRzmBnMpx/KhkAiPJ7ybaB/noQiB4BtVamaZxlWzyoyksCFTNLnFcEN/2qNDYvSfNSc+sRZ86IsTYhiSPEJsm7qXSpFzlXKU0bhZ+v2UbEROY6DSEbV2qKAgU6q2wvvjywWJEGY89EILjTanVUzyLRoLIdTqhGDYaqKho0cj6zP0oTW571Qmqr8OOXV9Uf3tyEw83U+PxX+EPxIpdhNqA1ojOrgi5fLQloQW8Dpa1gKiqRjABPT6/p6ONqgfmtBjtPTUN1/fTNsd+gax4YiDe8YviltrPgSZds+LPxNQ81I1pu+OyHPygX2w+EBLTSb/BhkpMr0= +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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' + +## Request + +
+ +Reference to the password org config. + +
Schema
    = 1` and `<= 60`"} schema={{"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}}>= 6` and `<= 18`"} schema={{"type":"integer","format":"int32","description":"The length of \"digit token\". The default value is 6.","minimum":6,"maximum":18,"default":6,"example":9}}>
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-password-sync-group.api.mdx b/docs/api/v3/get-password-sync-group.api.mdx new file mode 100644 index 000000000..7e9ef874b --- /dev/null +++ b/docs/api/v3/get-password-sync-group.api.mdx @@ -0,0 +1,95 @@ +--- +id: get-password-sync-group +sidebar_label: Get Password Sync Group by ID +hide_title: true +hide_table_of_contents: true +api: eJztW2tv2zgW/SuE9sO0ReT4FSfxl4WnaYsM0jabxxbYNNjSEm1zRqa0JJXWE+S/77mkJFu206TdYGemEFC0qkRe3vc9lyZvgzQTmluZquM4GAZTYU+5MZ9THZ8vVPRGp3kW7ASWT00wvArKb4w+MvfVBNc7QSxMpGVGZEDkYiYNG50eMy1srpVhdiaYoRlTmsEmqfavMhHJiRQxOz5qsRGz6W9Csc/Sztj7szf/Hh29PX7HeG5nqZZ2wUBUi//kUmOCTVnEkwRk/FItMGlElNNAMHobXBqhX6bKii92BArEvIzVMCsECImd0LETzrniUzEXyg614HFwfQeJMq75XFihjSMnSa6Mg9BOoPAB/5MxrRnNxJwHw9vALjJ6a6yWahrc7QQlr8HQ6lxs6khAapZOWMnSqoYgHnSnpbgRJJn4wudZQuQHBwedyaDXCXvjeC/sdzu98DDa3wsPRHsvinqitxfHAfGvhclSZYQh3rrtNv1T5+BMTIQWKhK0GpljCyO0eERaVJYI8CxLZOS8ZfdXQ1RuNzWQjn8VkcXETJNvWel5gLo2tLSuFK+Qurd8h/ilidYlfoe3WxdY52q54BaHZx1aoVTWaQqNLI6/SbhK0ZmbXFuwGx12DtoH8X6/P+btSLQ7+/3B5LA3HnTb/b22W9ukuY7EcWxWFuVa88XGmifS2JqPeV+HiR0JAxc0mCStmJutTlwxdlVy1h8M2pP+XjxodwaDzn7M+WG309476IPO14fACa9BMkKQWfEIhVGIxBjKuELAS9jORftKmHzmhpXkdgKklTmHnwY0KaQJdc22u72w3Qs7g4t2f9hu48+/KJrzJOFjGkFhCv7maeyS0lMxmHDYoCL6RGyCTyttzUWX+XrVbj7wHhc4VWrb7vXbnP5hf62561N50R0poL8tq71MJJIVe6U1ikzIzlwFgsNLH3qUlAXsMU5jV1CkuuGJjJ8wz8XCcpm8TGPxsAO9lkqgCHFJHArHcoSJDBRvZIwZ8BsNH3Mky+zhxtWrAjTR6rCfeQx5vXwvC2HITzSPfgOtx+SoSyUxn5VTmIyrYr1lWbEv+HjQPuz2J4M+592Dfmd/b3w44b1e+3Dv8JBWnwtjkHEeTlVvhBJaRixJUdjl71AIAhu6dwy4xbckqnts4Gg8Qv8UwH5sJWbBLyPgsMM4+/nlKevvI4jVNHfv+XRNCSq8PN+WRzzh91pOpdrGilD5nCLi6NXr0eXJBd6cvfrH5atzPBGtDVQ1UvDWmNwSrMIXZulnx3EhAKUaIxKoQ8Qt9qKg+gIC8QKBFQNliccMlAnfmvA8sZhRrL5lxippNtHpvBZKkUdZ7JlsidYOG9M7JLhoxsbcYAJMSMNfjKJIZDY8KTT5gs0AtoR+DuQXx5KE5AlDNIIo5i9AiPE4ptD1BCY5Qlk4eJjmlqnUymgNHS1VWbfGMlmerBqFggOcP+wno8jmYM6JuRqFlbcULBb2Ac9ec3XuLlaU5lS6UJZHkAJAdgE1ag0NszFkk9awIh2RuQwSjyrHVRlrtQa4dPfWM3NkU/ct4rl5RNydJkg/oROt+nAjiuAzhA19NnLWKM1UZKQCOLrJxajKXGXgM5S9JG5it4ndJnYfGbvrH8+KXq746qBPZxP6XKqiV6biuQF9tPMelZYN9e8O3hSG3GFQSAGRfvlwUXTiGC++ZNTDPiE+8qV8g/lRZQ//fkzwozJWzRbEoNOjl2CCTCTioeN7ybFTlFdVb3O116keSzio2gIRkTU1W6Q541CZzpUiTrjZYXEqjPrJshlHfuSICGN8BqRVVRxmqVS2QZINkmyqUVONfpxq1CDJJnab2P1rxu5XkWTFlYuWAieZfD7neuE9rfhO0nKGAaz8VYFVIedMtY5WiBirMFZQRw7BuNsZdyb7kejHvB8PeoeTbjTo8r39zn5n3O/uB6u1/moZx1WQ1WNqxd7ejk7FAHE3wHG5gnMZm6ZxffsP6tViQmmNUk+Fm6FzqPR6iR37W35FSC1kA2FgR33P9uLl2QnRx9KOPOnNbYISzPaqw3BuHaQkH4ampbENdGygY1N+mvLzw5SfBjo2sdvE7l8zdr8JOvYfgo79b4COfUYQa0IQ64+EjjFwB0GzCYwCGaIc6lUEGzOIgqdi97EIe8v1VNgK6NVQZPdwE0VepCl7y9WiBEumthOpluqi9Iaxcxqry7EYwNkUKVIxZC0JdEteRScQgEnpREIi59LFMQkEunoRjiYWUvmYKf2tWkWqKMnBoUsKSUp7ryl8TMKdxITgHyi4fdApEvUT7nEW1vqf9oPZGUl8QhKzV18iISjmq/3fvW2nBI7BvKZ0ce5tfc9xAb9nzhXaCPEl8+mrgqANVG+gelPum3L/Y5T7Bqo3sdvE7l8zdr8Bqhdo6H6ojgGPhuoY22qzCku9Juf6vyN2FyoFB869WRo5rB4vMbjDFXCl4oYD5RA6yj8MdrfcBzC7tzK+C+g+AWFDz1auEwyfWZuZ4e7uLawFK921eCZbSGIwmF2o9HMrSue7N70tuYeOmvo4Q/aK88j1DnRFwi/ScjrWktzY5zy3gNe4k4ocFpp3Zwy+Sl8Vh9wX6EOYJ7PD4PKFS7nXYDNDP/GTcaNbzoU2ZIRslzq5e0ief/a+Jocnco8c29T31bUwnoHLNfGI/evl9Y9zAt5+9Y1LIMtiQlv+3Y3F3tOwLvtZcI2uwJ+CefbLh4vnbEpw04V7bgjpCkn9AQLmFC7i0tmoPBFCk1yFgTdNZ47xUe3MDYUPmyQQmH1U50Kwq+NCCe+Q58+QmJ1KaZJwuYBmXT8rLROLG5FQCWwtNUmOJ2O1Cw3t8tq8567cub5AKn/2HG9bH1XIjiRlIUllm8YUIro2j11lpVx8Ra7vZeJvJbXQUwsdNfN8jQuv2qvIn+GOEMNEgifGaeu7F/f0whV61EThDVFd54E0UfBRPykVlVb7bj5q9EKiV+fjo/owk6il9WnMpy5mUAqTmB2zaJamRvydMXIdCoOraY4o+m62PtOioYuIsNteYSn0S4YyBDJ0/J0gMJR3Jj6myuyASer3SFxIfnKWRcx/crciPtVkdq+vUEBpZJxG5rt5pgVDWjD0OcAU/Pv6RI6F2CYZXB7wDvByaX+XCQpGV3Kep7U1qzvyu24OlYYIrDoqJhv6/wyXCa54Yu4Dja7GIAUTsK7OjtEVtoIWFamassotgXUNbvKbpKiNa3rz/FY/bFK9/LPJSxKPljsn71WyeOosfU8m+fPk3T8o4zWZ5kfMNAXUJXdzyxY9waqTe7S2uY9HG80zgb/x1UWqw9ToWPx1XMIwq2SyhFvyaRfT0YzuqdLGuOCWkN8O+VU6d3EIuEvBjz7PEZq623oaDHP0bDIBvRb7gBZLRVAxtVd08hZUf02LPuscWj4lI7Gj0nAAUPN5ruhOMJjI54zDPR6wbixNlPskhG5LiVKy1MG4alYZkeQ2pIqWazT03Lyf0FYxutAVIz6wFmxoin1iKJIsUlyvWwpyJhLnZTSuDr8fog3PCWcicZf9kEEBpsTKCm+PLzYogpgqfpxI9XS3mGR2aSyIUKvjnaHXQlvn7rimxqIbXaH7Rli27XLgeMGOj9a96na5Rf5HXQkv6gg1ALsZbVyRWLlvSHwLeBVsawExdShjutk+gw5o1O0t7XBQQ3RHr9HZU/t8db3sd1yfCPPQMxrNCYJ//db3qkaenRWMP3e/0Tz6LvhWkcodO7VYNusBHn8T1ONLuhKOUX4TxvHpP/htmpUpGz9kUGNVtc5vXpFX8XtqdPEAnSAL/ReqK1GQ +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-password-sync-groups.api.mdx b/docs/api/v3/get-password-sync-groups.api.mdx new file mode 100644 index 000000000..15f2793f6 --- /dev/null +++ b/docs/api/v3/get-password-sync-groups.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-password-sync-groups +sidebar_label: Get Password Sync Group List +hide_title: true +hide_table_of_contents: true +api: eJztW/tv3LgR/lcI9Ye7LKz1vrx+AEWxsZPAh+Ti86Mp6hgNV+LuMieROpKys2f4f+/MkNI+/Ugu6F3SLYrWkcjhzDcPfsOlbiNdCMOd1Oo4jQ6isXAn3NobbdKzqUpeGV0WNtqKHB/b6OAyql4yfMvC66utKBU2MbJAOSDlfCItG5wcMyNcaZRlnGXSOqZHrKgEWBQwJgFNNmBO/yoUu5Fuwt6evvrP4OjN8c+Ml26ijXRTBvKM+K2URqQwlCU8y5gLqzRBPyuSEgeCjrfRhRXmUCsnPrkBSEC9ZaoOqqVjXDqmpeOcKz4WuVDuwAieRld3YEzBDc+FE8aSOIkm/VYKM4WFFLyBf2Yyly5atvsN/8RUmQ+FQVONsGXmLOrrcWi+V2dCsMt/dgmcM8dVygGKQ51lIkEZ7KRe+urHiXOFPdjeTsW1yNBNTctlVmipXDPR+TbYtM0LuW2DnDip5cQzE56xkTYs10YwqeDPnJyNmFWARgcjnlmxFYlPPC8yMK+z0wJIk4nIeXRwG7lpgTbDumIsDMz0Yvyjbgce5FLJvMyjA5iX80/+b5KSihEHFOhfd3db69HUo5EVq3C+pcegNiDoJoKNSvC6R5XBiya7sCUEwpTZQiRyJCE2KIAa5J0GAl/wsVTcCZgP/h5PSE5wzDfjjj/gjBr++8FPdKlWsT8esYYzpWgw6QBVAL7QRZl5KAVr/Cs+145n8SHObiCkhVZWsAlkEYQ/+QEHrkmHCQeJusxSNhQhM8BzclT7DfBjDR8TDXYjEKqxAsRS8Bj4TKpEUDUQ1kk1huLiUBVGhkBpUGzCrwU8Bh8RODhe5gVP3BZaQ7UEPAZZn8LCSjuMFCtw1QYJ+TtZ3kCdSNtrnpXCo4CjQe3SVtp8ExGE9qwJoqHWmeAqmosTmnmHVbByqcUJnVYL/28xRgYPV3UQm2AVhuiCqbwoMpmQrtsfLc6/XVWIG8MxNKUTuZ17rocfAQd4URjEzUmvlUznxlhnIBpWA/kIFcRQnOkWzUET9ff22qN+tx13h+lO3Ou0u/F+srsT74nWTpJ0RXcnTaO7Kl2WMfgZnq5dYFmr2YJr9lDWxhUqFE80IDU9/izjag8UNHlhwU6y395r7aW7vd6QtxLRau/2+qP97rDfafV2WrS21aVJxHFq13hjcc3Xyz73eyj4nkRYdnxk17gwWHA3p9hlpVmv32+Nejtpv9Xu99u7Kef7nXZrZ68Hch4eAmF5BSIT2LydeAJg5wBVikUMa4yTufAsYuY5dsMtq8TNFVecFOOERWRbnW7c6sbt/nmrd9BqwX//jZUVNio+rBIP9Mt1SvvT11Iw4+CDWuhXUhP0dNIthGjNAaM7/M9W1FtXBw4zCUnOXhgDhSlmp3Ml3W+3VKrZUKdE5KSCeirTL6kP99SBVDgopIc6FY8D/FIqAeSPS9RQkMoJTGQg8VqmuJ9QafUiq+yicc0FTAGJZps95ynY6+07DMYgjoYnv4Ksp+TwhZIwn1VTmEypwN+zrNgVfNhv7Xd6o36P885er727M9wf8W63tb+zv4+r58JayMjHU/mVUMLIhGUaCLX8HQCBwAfsSQFa/Om1mGQ8AX8McD+2NjPoy5Cwb8G+/fzwhPV2IcjVuKTnfLwEgoovztblmRf81sixVOtUEQp50WV09OLl4OL1OTw5ffHLxYsz+AtlrTQyAwXRmmJYauIwE31DGgcDMBWtwC0a2ABrBKkNMIgrOz9Q2rBBWACThc0WZoTV18yYF81GRucLqZT47ob9KJuiuQWEBMsBd8mEDTkwEwYuJJY2SBJRuPh1QLIR6Nkz6LjSVKKRwJuI3ViYP0Vmw1MkRVIFxg2pLIjN6dIh+ZGJWPTFDMpFb8yKyet5p2BygOaPx8kgcUDuKSYWsrCOlqBi8A/o7JFb1O58DjSCdKoc8ECZUN+QaANMECoT2CaBmoZyhO6yUHhUNa6uWPM1ksrdG6/MkdP0LuGlfULenWRQfmIyrX5xLULyUcPoqxF5o3JTqEihF6LJYVTtrirxGWwLWbrJ3U3ubnL3ibm7/PI0dD/hLVGf9ir1uVDhjAo3zxXqYyh6lK4Osn4nehMcucUAkECRfnp3Hk7AYLz4VGAX9xX5kd/K1/RvlT/88yHSj9pZC75ABQlHb8EIKpFID0jvmcaeJBJU3dXVXmozlBCgag1FhKpp2FSXjANkplSK+nq7xVItrPrBhY4eMsJaXwFxVZXGvnneMMkNk9zsRpvd6LvZjTZMcpO7m9z9NnP3QSZZa0XZEniSLfOcm6mPtPAereUMBsx+WqlTjly1zFZQGKs5VrTIHKJhpz1sj3YT0Ut5L+1390edpN/hO7vt3faw19mN5vf6y1ke10m2mFNz/vZ+JIiBxF0DjysVBJd1WqeLx38ArxEjLGtYemreDJgDpFc1d+zsr3LHc63ZG66mFUOyCxxSzTDCmgZjcxxrqrEwgLMx1EWFPwlJ0AtDCc9WY2bwrJV+d8LkRStArpnGg5EDU8KvWSHI6lWkSrISNKRKkGlkzRoCS+JPQyPkfCCBGOwYqvNXZKfBRX+IybNTtPg1WsxefEqEwESvmfvOuvPdY1DeYI048w6+56DXdztcQQBAQ+BrVs07N/x8w883e/xmj/8+9vgNP9/k7iZ3v83c/Qx+HtjQ/fwcBjyZn8PYZovVXOol3bf5X9N0SpWgAYU300lSGjpurjg48QoIpXAfFGsIx1uU0faaG5R41cPzfq9RaTIYWd10ugVHgYPumryQTahf4Cs3VfqGrjtdd9eUHbwf4FMMClda+ktUeLnKL9IkeI3ECPbljhbwYIcrTFF9q+pB+Src3JnqEgocidliEO0hmugxqFlAK/GDpdFNip4VG8G2C5PdPWZPuCR2jx1eyD12rIPvwbVgPAMtl8xD9a9md2XPkHP71VduzM72EezTOiuLvcVhHfZccAMNgf/p4sef3p0/Y2NkmpTppUWSKyS2BpArJxAiVMkG1TE+TqLNZXY1c7DwQwlmDhtlYDALN+2OAwg/Q4k/hZpMkOIkQWUAZz39nh1fmHfPvbr3KmZH0vhreJbGBBP93cPLorKLz9n1pUr8rZIWe2kxSbPPlrTw0F4m/uJNAumLInhmCa0vXtzLi+fkYf8ET1Dqsg6IRNBj8eetpPLaF+uxIC9GeYt6vFfvJhK20cVpzFctZid0ufSYJROtrfgHYxg6mAaX4xKy6IvVusFFY8qIuNOaUyn2S8YyBlJI+r2GxFA+mPgQN2XiJBromkp9Sn4gz0LOf6CrXh8WbKbHl7B34shUJ59xeXRJZ1wwxgVjXwNs0N9vTRhYeH0MbKA64APgcOZ/qgRB0bma52Wtreokfpvm4NaQgKokxRYH/h8HswIX/mL0AkfXY6AEI6euf/DD+/5BFu5PC2BVpwHLCK7qm2nYFpdw8/rWp1G4Vf7V7EWLB7NDk7cqm37tKn1PJfnr1N0/qeJtKs33WGkCy8Vwo2VDOzAf5J6trR7hWfr+Af4X3lKmEp2GZmX2ycO8mCLjDmOacjqZSEHNfyG4Q+a3hXGlc8pDoLuY/NDikaAxXUE2oDCHdk1mIK/J3kF3pRKAGDsrvC4BUj/q0GKdAcon6CR2VDkOCFSelwo/oAIlypxxCI9HvJtKm5S+CEGjpURlmSYaV8+qMhLDBqFoUo9hcvt2hKfE0IDOOfGRtcCHNhwRA5DokfBpysyQU5FRlOG4Rfr9mGyInHgisgJ7O6igQKbE3Apvjs9XJIIw5e+yN7UZb4dJdhvHghBsdXwwdJvQ0dHFfW0dNKJzcl8Jx9bd88fL88tBdTs7HP8TvpwLOwhS/+0CT6vQoNK3Ir7vu4zW9n3QSUzAbnx/e4sHGtgE3eFj/4ERdoPgBIzz2Rcp9xr+bX06txa0XwUeEVRfBoZDgCjCjvHpOPx/ffP2AI71N4FfCOTmA7Zv7wO2B8Kh+kpxFg1XsxMUqDX4FZB3HRUeP8kfrM7NWvnpEaXUh12vXuBmwO+h1uEPXOru7r9GrG69 +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-pending-certification-tasks.api.mdx b/docs/api/v3/get-pending-certification-tasks.api.mdx new file mode 100644 index 000000000..0a1b4a6f6 --- /dev/null +++ b/docs/api/v3/get-pending-certification-tasks.api.mdx @@ -0,0 +1,103 @@ +--- +id: get-pending-certification-tasks +sidebar_label: List of Pending Certification Tasks +hide_title: true +hide_table_of_contents: true +api: eJztXP9T4zYW/1c06Q/dzeAQkkCAmZubNIRtOrBwIXRvjmWKYiuJuo7klWwgx/C/33uS7Ngk4dt22rLnH7oNtvT0vr/Pky3fVWTEFI25FP2gsl+ZsPiUiYCLSZepmI+5b+4Nqf6iKxuVmE50Zf+iUripK5cblYBpX/EI/wYywynXpHPaJ4rFiRKaUBJyHRM5JpElT95d/eu8d947uCJSkav+x99OBycfBr2zs6v3xM+TJzEuXiMdMSc0iadMxHiHBSSWX5ggPsX/wpDEbtENMkpgKRHOVxEic5kQqpihJRX/ryEEjF5zdkNuOBAaMcc3C2ogtGZ+ong8B8HvKueaqa4UMbuNO0AAlcEDsV9YaF8xGlQu70EtEVV0xmKmtJnNUTlfE6bmQFfAHfjTrsyUxwMULcZb2p+yGa3s31XieYSDdKxAaXCH3dJZFOKlTkBrWwHbbbDt7Xp7t9lqVe6X7cBI/wDVnq5C0lVqpDpjVcLBGqhNDepjBARVcJskICWKrtjXhCsGnjGmoWb3G6tFCPmMx5WHix/TWyKS2QgWNQzoJIy11TUqt/ZZnDFGLn5tGk85i6kIqApIV4Yh843BTjPtXb6bxnGk9zc3A3bNQnTamqY8jCQXcc2Xs02wwiaN+KZ2dDw/o+MtrPCejMHdZhLszwX8nBmDrRA1p+nGdn2FRWBdNmEKZloy9lKzARdmXPBZMqvsw7wZvbW/DZWAjSlowfx1v06bcjzWbFmdJ+YysA0aRFuNE3BVq1UCN2rkXCcQBnOiI+aDL4Jf3/B4SqrGOlVUfEQnXICxYb6SyWRq6DjDvBlzfIMxMvWvV74vE7Gs+/6YVGOVYLzENkdEMkpCq0pGqv/2hjKmodfF2VVUaQR5kZEpJAJwf2MHHLgiHKYUKMokDPJph/BxZjfQH6lan6gSiGBQ1USAxgKwGNiMCx/ngRg6xrxKwdDACjGCmOQ4pdeQ7SDxKqMcHM9nEfXjDZQGcqZiYLEZ5GVYWMgYPUUzXLVqiPzDSF5Fngy31zRMmNUCjga2IV04bt6EB6E8K5xoJGXIqKjk/MRmvXW+MuahyezPy9d4h7Cv5HOlc3AM9W7Q65yd9T98/FxZztuHhnLmJIlGy6IDpcogei5iyK922gg9RvzJmv/Big+ceY7P9+gCh+lV9CydRJFUWKvRSiZrASl5g7chQ4WBNu5tMYhUeh8pVKs8qFb3SZV9BQ8VVXstpgrASX/VHVBs/moFC28aghqN0qjX8X9FHXeWIMkKtAAW9LHaQ04AAjSKQnd783eNVO6WTU+VougkPGYznbsuR7+DDuFGpFDemFveeLDKbdaVcVOkl9isFRyt4e9t7dZ3d9pbe4z59XZ9q71F26zZ3N6mzZ06RXez6z1nXeO261cmxxh6JiVoMqNzTAc0CKxD2jIFKY0ZDgWm4YtK6vhwqRgJcKF7cnx61Bv2fuv2BsP+Yb/bGfZP8MZh/2P/7Oely4vxnePTjiPaHfZ/7RSvpT9/68Jiw17+ykEPCSCGzWGrIl+oMON+wxerDb3Apk0IhxFDN7PeDhoCHY7mFraiLsnNVGpjaIycGFN8qsTU+W3Q5JW5pJBU5oI82dVMkv6L3c5I8rgEz/dDgKs+MgMpJk7081ixY1N2svWcImw3ARdyrQT8dXbe7dpfvcHgZFBUi5sDfDClpNKvj+JQQgvyTNewY7OMOGNa0wkIBC3FBtTpn7qnpNUmIRWTxFynk6JemfDOUSABAJCO0oIGQljCJ4pPuFhZi5yqDnqHnfOjIVwZ9EAFZ/ALaS11cR2RtgfSYJapvDEcOwFuKLgpw8IA1Z9UHdUqCESFzg/k9i891+hCrrjCDLf6ihl50mSs5MwhVYNyiG/7L/KO11gNuj28BnXfn5IR1dYrDSrr+D6LYu/IabLq4Nh76CWDgKOQgJOeTF0GvUnoKAHscJ8VbbFQZdEaEGY8NiOO8kbB8APOn/aTjh8DmDc+kTq8cdHMWxyLafsWOM0VuRvmlGZUiqDBx/YZ+wRfQrPnx6Zb5oAyXKEz2QdKmkjHcQE64pB17u8XYvWQm2PLzEEsK+tvHUGVXZYvK7428myKNEh1xKCpZ8JAT4Y50GSYNODvsbRTrQEDA2KNhwqQy8HwRC/X90FuGIlxnFsFQF5gMW44flDSci346/JAhH22TPTJjYB25AUZNp1IJM5cdOnFyB83d8d7rWarzfZa2zuN0fZotNtqtOj2TnOvHeyidgS7efHiMOcb1qXNJau8uEzmZxfX7pwPT46hunWzcnzc+zgs+OJghUOYpJ4SWbLL05rMK/Jp+VeJv5bzxxk34QJjfKAYs2dW6QA7UUTSMZ8xzH83U+5P89ACot9RrOW7ZJzo4aRi5a436l59z2u0hlu7+1v1/Va7trPX/E9B60sbhHD3Hge0VqHtbsgxDk1uIB4Z5BrdfGofyWCOCSjLOS/H32siM2AxKLgrg2d45iEXzJuAQZBDm3d9mAhBKq+5aRVMw2lJFvJz0XdBE7Ut8hOkm4GTr+uEQT0q6n8BWs9BYueCw3ySToEwzeDDimVZm9HRTn2v0RrvtCht7La22tujvTFtNut723t7uLqrI6sgT3HpDwxigPu2vpjdUnR1cDFkwCxeoqQSJZUo6XkoCRM7TfQz4u40hPTjGdGyG9fMBZ/ZRrfZyFgjNZPLSG6H2Ex2ozJzpYFvW8kydsvYLWP3mbH78ObA7TG6uwb6bC1Dn3ORe9S4BH2U8R4hs+eRthOxhtzAh6MOIv3yaeieeMJ4dhvh3vYfiI9sKV+xS5raw201pzvRaelf2AIZNHq0EowhE7Fg3/C94NiCRKOq5vJqh1KNODioWAER8Zlk9vBWJUKYpx16gwSSafGj6x4pRITWNgPiqiLw7MZ2iSRLJFlWo7IafTfVqESSZeyWsfs2Y/dRJJlxZaLF4SSdzGZUza2nufsoLSUwYPHCSRZyxlQP0QoSIxnGqhSRQ2XU2Bptjds+awW0Few098YNf6dBt9tb7a1Rq9Gu5Gv9xSKOsyArxlTO3taO9iEeU9eA4xIBzqVjKYPi9h+oV7ExpjVMPRluBp2DSi8X2LG1jB0/yhhkA8KAHdWa7cXzwRHSZ8qSR73JRPkMYbZVnX1EgJDSvNzCbu3TixI6ltCxLD9l+fk+yk8JHcvYLWP3bcbui6Bj6yno2HoBdGwRhFhjhFh/JXQMuH1LeQxGARnSIwuKRSAK/HK7jy7s7dtuGdAroMjG3jKKHEpJjqmYp2BJF3YixUJdmN5g7AzHqnQsDKBkAilS4OvWHNAtehU+kwdMis/ozTvdGMcoENBVc68zxld93Zvizt+yVbjwwwQ4NEkhlLj3KsHHOL52PUb4BxTMPugEEvUfuMfprPVN+8FkgBIfocSkd+szhjGf7f9ur3pLoI+v/GC6OLO2XvO6gN0zpwLaCHYb2fSVQdASqpdQvSz3Zbn/Psp9CdXL2C1j923G7gugukND66E6DHg2VIextTrJsNShOcv2ZyN2EyqOA+PeRPoGqwcLDG5wBbiSO3mOOYTimerKZuG1bC89imU7AMtQokIYmB5luwM7gX3uazTitfQlZiFvzHm26+aKrIMvmdoIg7wVJPaUHJ6es4vUjHYVRwe22c4sYHXtTgdWsmNzj9LH04JoxDl0IMSS2cAXn50zmcvAZgSdxI/ajK4Z51mSEWQ7V+H9U/K4U4Br5LBE1sixSn2PrgXjCXD5QDxk/3JxcP4MIbddfen4/KKM4GZ/Y2mxExzWID8xqqAfsO+/vPvl0/A9mSDQNIFuj0cyjp0BhMopuIhJZJ30XRCcZGrL4tRzp/C2DQYOGYcgMHGHWPtOCR8hww8gJRuVdhafH4BZzz9ISQvz1hxZ/Sw8csCVPWepzRgnoj3WexGlctGcXK9l4oeUmmepeYYaHuEscGFVe+Hbt7d9iF4kQUNttPXqxS09L0cP2ye4glQf8oCacHwU35HyU6u9mo8CPQ/pFfn4LD6ZF+mL04hNWkRPzbntPvGnUmr2T0LQdTAMLiYJRNGr2TJv73smIrxGPceSZ5f0uAeY0PB3BIEhrDPREdZkA0mk3R0xIXllLAsxf2VOCFwVZDaXL6B04shA+i84HfyAZ1zQwwU9mwO0499WJnQsiG2UweQB6wDdhf1NJnCM5nKepbUyqxvym2YOlgYfWDVUdLRv/9hfJDj3i5gbODobAykYIXX21hh+SMTRwvJUUFa6GfBQg8v8hhKq4gO9WX6zR5pYKf9u8qLEncWeyYkI5390ll6TSf4+efcvynhlpvkeM40DuehuZlnXDeSd3KK15R08bT4tAv/CXROpBk1Dr7L4mkieTBTSGH3axLQ/5cz0/hGjMSK/DfQrOTNxCHAXgx86PENoYk6FKWCYQrfGQ/NpoE/MnsBU2FjhO7dA9XfpOqwz0PIpGokcpIYDADWbJQLmYowlM4KHOZ+wbsC1n9gkBH2WYKlk0sC4bFYakeg2qIqaaTHUTJ+McZMY+s+cEZ9YC2yYftEBFIkWcV/yWAgyYKH7qNXGA/j9FG3wHG/KwghbO8igAKZYboXj/nCJIhAT7rGEVJNNN0lv4lgggq2OdYZmDRo6vBRJHUMfmqN75I7Ruq92kcKpPJJ+t6vgW3eLLfLv60NdrkZhc7EZ4XYYqiyxzY5tLC8qqxpLaFWmoFi8fXeHGybYZd3jZfvBF2w3wcoYSIuvyTyi0m/75tZKKb4w3BRY9akwtwWAH5F5CZdv6+Ncj+gk/fbYK/Xw//VVrUf0mH117JWKLD+R9fY+kfWIO6TfQXulN5QfsPqWD1g9apnFV8cWtrlcbPJBtbqEsTasTOmy0+zWf27W0sNxpJJtx37oIV6ha7o/9wOXur//HzY0VRE= +sidebar_class_name: "get api-method" +info_path: docs/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 Pending Certification Tasks' (get-pending-certification-tasks)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

List of Pending Certification Tasks

+ + + + + +This API returns a list of pending (`QUEUED` or `IN_PROGRESS`) certification tasks. Any authenticated token can call this API, but only certification tasks you are authorized to review will be returned. + +## Request + +

Query Parameters

+ +A list of pending certification tasks + +
Schema
  • Array [
    • errors object[]
    + +A list of errors that have been encountered by the task. + +
  • Array [
  • ]
    • reassignmentTrailDTOs object[]
    + +Reassignment trails that lead to self certification identity + +
  • Array [
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-provisioning-policy.api.mdx b/docs/api/v3/get-provisioning-policy.api.mdx new file mode 100644 index 000000000..2b865ef38 --- /dev/null +++ b/docs/api/v3/get-provisioning-policy.api.mdx @@ -0,0 +1,96 @@ +--- +id: get-provisioning-policy +sidebar_label: Get Provisioning Policy by UsageType +hide_title: true +hide_table_of_contents: true +api: eJztXG1TIzcS/iuquVTtS2EDxiyLv1x5wUucY4EzkK0UbCXyjGwrO5YcaQZwKP77dbc0b9gGlmxdks18wsxIrX7vpzWauQ30TBieSK36UdAJxiI5MfpKWrgg1fhExzKcB2tBwsc26FwEpzo1obDBp7UgEjY0coZTYeLZRFomVNSYaakSZkRipLgSliUTwRZJsmuZTOienYlQjqSIWGr5WDCt7l12SzKpWD8SKpHJ/EhfNy9VlyX6s1COUvekv8aOBwc/d/c/9I/W2Onx+WCvl/2nTXbh9PwdXWM8TSbaADEGfBvxWyoNrJVoFvI4Bg7gKtBsguhWhCkOBPFvg3MrzJ5WibhJukABVSIj1ZmVBAQNoIQdI3gE01fcblgS65FRnSlXoJRHyTR4NJWqkdvSZhM/3YGlZtzwqUiEsSSDRHvNOHC/Fii4Af85Kn3kJNNF0ElMKkD8cCKmPOjcBsl8RmPBsmoc3C16gMhs1d9HxYkbPp3FOKUV7m6+3Xi7tR1t7m7yt282Nrej1tv29vawzVtbrV0gtpQt8ogzXHaRr8XFkT+mR6ysJubU5HyryS5Vv+JGa4wzJzvYXTGbzmbaJOyKG6lTW6VUKLfJ3oNHefHW2PUEvJCzX8HxhUF34lHkfCkjvuYcasrnDJQ3HsOwoQav3Rv0umc9xlXEzk/28efKFVmPhxMfIiQo0AvhjowEOi5fJjXM6pbFm/ArAYvNmUqnQ+ABdAWhZsWSuRIiNxIjkChCrZ3RMG4ExWaop1MI04IZ24ExXpgGo1RQ4tSImCeYCTR7sQf+ngjWDUOdQpqAxDCSsXixRnQrbCQCtItjR6BrvMv9HCAzBB6IUHTPFKTma53GEY5JLWgGp+fG0Sq3CSjnUnmtP8zz+Sx6Ls9+7gs0lRJhApdXutEq3oHlBLxmmAJdO1dhRYhL1Tvqvjt8TISe4sP4a6hdEKGlag+fpHb4HTovcvde2HwFpJFZ9VLt90+fINi+tF9JsshReoJoPt5jAeFkXPmY6iuMeFhBG8gd8ZyNjJ6WfO1S/aRTCkIg4aNuBPfKQeR0BtVnjjeWZTElRARuU8mtLuyC1Ykasmkaxyhb0Bnx2ELuFJAAsHTlc10cwA/nTfDDqx9/9Q57dK97eto/OMLRR/lPR+Hng8Hx+UlOJ//XTc3/HfQO+qdnvUExr7/fOzrrn/1UTC1d6e33zwrKR4fHe//Bmd93jw56P58ACx+PB/uIRJYoo64OdXWoq0NdHf6Z1QHyF6XD8xw/32EfYISdgWdB+wZForWxgX8WEyUCbWFBz0vatn3QxjW3kApD6ALtCArLPO/1IgT9ITZHKkHSfDaDOeTN679apH+7WKT08Ffw/Aq+v3DwHxsXg/GQSMexawoWy1tVhAXLZtrB2eVa4X8tHYy6loqHiYScKF1FQC7uNz1PYaZ0xefUZUtWWCO3WsaXiwAKClA/G3L0OIwflXE5Z2ONEzLukeWijarBQQ0OanBQg4MaHNTgoAQO1oKRFHFkS/WBG8OxKEngzC6r18+pzZhqcWRWB3PvrG4XgpzmCAkCY4nhyoJ002U8LEnk2XDKoQBA5vgD1yIJy8vk5EwaIzLImSkJFPikc64kgCJ2uN89Yd1sHIAqZGHE0xjxDv5XpfEwuzmd0v5z5l+F1FWGvR/C7O9uR9LYBNm8a353G3P/+7vblHjdQ/8U5g4hWazT6AO/cULsTUT4GdgLtjdK907l77RRm18b5HAswP1WklXa4mou3VBrcGdFCI5HxyqeL9+hfR9zRCURIULwSwgFkNTg3rzSSdUdynvyzaCk5AyiZCqh/9FLVoCb1ZX+AfcrNril/QDLyh95nK6Q+Y/JOEXqjSsi/wQ574rgfY/evC8SLmMLoBzMU7q5FLfjEBjTXgb792IJuIb1jAFOG2wgktRA+WbS6cl3BAA8InpcIhWwLP8Y3K+mj4gk2dPRE6z4HnJ/Y2w4AgwmiOUQJrqsF6Hap9og7EaSmalpXNXMoInmJnvHIzbw8u15YVzaCT8DrX70OEM+OWRTAInncbxkWbEj+PDNxm6rPXrT5rz1tr25sz3cHfGtrY3d7V18FhJMAdxDcl6Wj6tLHwiogzJksQ7BIr+DQiAIQffEAC3+9BRONJ4YRW5sLqbnl+FjMcTF7/ZOWHuHxVyNU7rOx/eUoBrnp5XmA1MGSO4IHwPSlUvbq6w52e+9754fnlHf8N/z3in8QloLjyW7KotHTaB1oq+JYy8A9bIiBnVg9X7tqb4GgSD/lgdK95+dQ2M8ZT5OYYZffcmMMmlX0suhFLpniOylbIrmGuADuDblCeD0vKfD4a8BnIhZ0jj0mnzNJpBkhXnVZN0okigkjxklENcjANBwLYR0BEYphLKgZ6Q6TTALyfBeuitUWbVGkU8Oy0bB4ADOH/eTbpikwByJWY7C3Fs8i94+wLPTXJW70o6EU+lcJdjZ4mNa6Ie1MaBhBgmVycQyn47QXBYSj8rG5RmrnCYp3X1wzLgECfmMp/YJcXcSQ/ppkGj5jSvhg4/gpctGZI3MTD4jeTxCk/2o3FxZ4OdopY7dOnbr2H1K7N6/OfCbnWXos7kIfc6VPwmCxXMB+hjyHqWz4yK/E7zxhqRzJR4i/fDxzB9HwWMwN7MMuX4lfORK+QLz3dwe7vqQmtXMWBVbIIOkRyfBCDKRiDrEd8ExKcqpamtxNWhuhxIcVC2BiNiyYfNJGz0mVdR6crvGIi2sepH4DSS3bUkZsHxcqEaSNZKsq1Fdjb6dalQjyTp269j9e8bug0gy54qixeMkm06n3Mydp2XPlUFazmAAyx67szzkyFT30QoSYznGCqrIIRi2Noebo51QtCPejt5s7Y5a4ZsW397Z3Nkctls7QbnWXxRxnAdZNaZK9nZ2JBUDiMPnEqkC57KJ1lF1+y/Fc90jTGu0u57hZtA5qPRTgR3bi9jxSCcgGxAG7GhWbC+eDw6RPiztHoCC3vxzH+NVB8N5QpCS9lPFjbRJDR1r6FiXn7r8fDPlp4aOdezWsfv3jN0vgo7tx6Bj+wugY5shxBohxPozoWMEuAOh2QiMAjKEKaiXXgecgSjwy+8+ZsccuBmLJAd6FRTZ2l1yPFVr9gFPoXmwZCs7kapQF6Y3GDvFsSYbK/HozRhSpGKQtSSgW/QqORWISfGURyynkuIYBQK6Zt7ojhKQysVM5m/5KlKFcQocUlKINe694vFYCe4kRgj/gALtg44hUX/FPU5vrT+0H8wGKPEhSsx6N6EQGPP5/u/2slMCfTxQguni1Nl6xXEBt2eOx5WUuJm59JVD0Bqq11C9Lvd1uf82yn0N1evYrWP37xm7XwDVPRpaDdVhwJOhOoxtbrAcS72nA5//b8ROoeI5IPdmOiSsHhUYnHAFuJL/LAjmEPw4QydYd2jdrt9mn424W1/8NIXEAfmbR3gO2bUIjuPUxEBpkiQz21lfvwVDggHvmnwmm9mLTEpfN0M9Xb/aWpKW8BSqzQ7qR2lIbUX3pO/7kCap30j0cJcOaQFnDH/GNrBgFDp+8CD97Lw6nax3ZNbwFLH3NroMbM6g1XhhaXSTvGtBRpDt3MR3j8nz49ZDcjgiK+RYpr4H14LxDLi8Jx6y/6n47skpYnK3+sLXT4o6g08DWguLHeOwFnsnuIGGwR2QefnDx7NXbIxIlDJBahEEC4mtA8TSCbgIZbpudlgEJ1HxMTodu4/GdCvHcTCy2CgGgdmlOhWCXZTe02IDyNmkUpwkKE3grE8vM8tE4krEWB2bhSbR8WSk1kFD67wy7xVVQmoZpMIj+nS1eakabF9igsL3c2iMF5E6QHYxy+TiJbmey8S/MmoNR61B1Oyre1w41V6E7nh3COGNJHhsSVvPXtzRa5ToYX8FV5DqfR5QE56P6iGqMLPas/mo0GsgvSofl+rjREKZrU5jLqsxO6FXc/osnGhtxb8ZQ9fBMLgYpxBFz2brGhdtUEQ0WhsllhpuyYZsAGgk/g4hMJRzJj7Eok2YRbvtEwrJX8iyEPO/0Lt+v1RkpssXUFtxZKRD+2yeccEGLthwOcB6/l3pQseC2EYZKA84B9gr7E+ZwDNaynmO1tKsTuTXaQ6WhhBYJSp21nH/dIoE538xuoGj8zGQghFz58fK8BUoT4texykrK9stuK/BRX5jDWXznt4cv/kzTyylfzV5UeJusamCr+J87Sy9IpP8dfLun5Tx6kzzLWYaj4LR3WhZ3y6UndyhtcUtvvxNTbhLkUpwG5qZ4sN3ZTL4Vl/+1mI4wa8p4J654AkivzX0Kz2lOAS4i8EPLSARGtP7iQYY5tDOyRjoNdlHfNk2BBVj54WHcoEqvjJLy56Clk/oG337meEAQE2nqcKPBwAT6ZRxcI9HrBtJG6YuCfkXlB1DmmBcPiuLSHQbVEWTehAztccj3EWGBrVkxEfWAhtav4UMiiy9pFkIMsD3ezERwLgq/H6MNnhOYyLiGfZ+kEEBTInSCh/6ZwsUgZjyzy20Ga/7SXYdxwIRbHWcM2w1oePDSzNtE2hUS3QPRFL5ygbzX0cczlnxeu7CNyfyTfRv+KuLvmJhq7E+w90z+pCFa31cH3rhv1qItu6UPmC4tBXFMcVnMKC7mYAtkMbtLW7CYGN2h5d/SwV2+Befir6L+tXsFe/81cyVJnmZvSP7ih4jVb6IuFSobONQzYs9gwB+fha41ZALhh3ls7mov29Rf9+i/r5F/X2Lf8T3Lb48yRaV4e4TDHb77pT33X23M1+aufDsGjfM8t3Sgx6iBb6i9/I/oMYAuvwfY+pSAg== +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

+ +The requested ProvisioningPolicyDto was successfully retrieved. + +
Schema
    fields object[]
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-public-identities.api.mdx b/docs/api/v3/get-public-identities.api.mdx new file mode 100644 index 000000000..1a7ae2f1f --- /dev/null +++ b/docs/api/v3/get-public-identities.api.mdx @@ -0,0 +1,91 @@ +--- +id: get-public-identities +sidebar_label: Get a list of public identities +hide_title: true +hide_table_of_contents: true +api: eJztXOtz2zYS/1cw7Ic2Gku25VfsmZs7VZFdtbKlk+TkOrbHhUhIYkMBDEHa1nn8v9/uAnxJ8iNOrtf0lA+OCAKLfe8PIMh7R4Ui4rGvZNtzjpyJiHvJKPDdtidk7Me+0M6GE/OJdo4uHHOLFe5dbTghj/hMxCLCLveOL4HMp0REcxgo4Q5cBv7Mj+HSE9qN/BBng9ZTfsdkMhuJiKkxi4ROglizWMHPOIlk7VIOhGAX73dYo9dmg5hLj0cea6ogEC7SYL1s6qsfpnEc6qPNTU/ciACFqmnuB6HyZVxz1WzT9+QmD/1NbelU3YxONRfhDRuriM1UJJgv4eeMVFMD3iPxKfEjAUoa80CLDUfc8VkYgHj1va0NR7tTMePO0b0Tz0OUGeYVExHBSEPGNO3UoWHmS3+WzJwjGDfjd+Y3UfHEmIMW6OrhYWO1NtV4rMWyOrvUDGyDBuOpYOMkCKxWGdyosXOd8CCYMx0K1x/7wmO3fjxlFbJOBRUf8okveSxgfKSSyZToWMN8M+b4AmNk6n9c+a5K5LLu22NWiaNEVJgfg1ZB8aEKk8CoUrDKv6pDFfOg2sTRFVRpqKQWbCq4B+5PdsCOK8JhyoGiSgKPjYSNDLCcP87sBvpjFeMTFXYrUFUTCRrzwGJgM1+6OA7E0LEvJ4yDoYEVRoIwl0s25TcCmsFGpBzs789C7sYbKI2vYTRYbCakBxNLFaOnaIGzVojI30jyCvJE3N7wIBFGC9gb2E50ys034UEozwonGikVCC6dgp/QyEd9ZewHlBZX0NJxBMZwHlawUfasY6KRuUOi0YboKqnYTM9lDJnUDBuhb8g/WMffGUGBs6rl8w0a+zhtRR/SSRiqKAb20B6Un4CUusXbkIsCT5Mjm2qkIn2EFCoV36tUjlhFfAJflBXTxgOf66xZ39pmULAfLDeP/UjHaJDlWwFfvuMU/MDJxjLxiV06P6upvHScx8zNPdRPJKq53R/JEhtMSUjEE0zXWS1lt1PfnTINDqrHc9bodBbUBJRQnxwNDHP5ZE2IRS7n+b08uY/mrGI5qYA2GauywTRNJAIyDrgVsBsJTFOg+YiFkYrBuBSrhe42iC8dHXIP0uWlg50vHTdQiWdb7IjEB38sjZJQhezNVN2P9yATrrr9ZLja6y+PV40O+mS8FuoHpkRe1QLDAFT2glAeAPk/eSCjBhbDeGDaXhbEEEgVE1KlQCIFP1yhikzl06jb+tYW/lfWUoMFvo6xBIYGbdoImTM1+h041ugMroKCDnUYRvMwhF6U1Td/10jiftl8PIo4GhqCZKYL7YYkIlw/JkbLCHe+FMLvRAx6hVw1UkmMRbPMI/SHIAL1EziGeXxvlRMtpIVUQOhcVFrdPdx+u/V272D7bX1na09sbR9sHx7uHOzs7dfrh7tv0eWM5z43w08JlHUwKvf4KBDM83UY8DmjYARFp9zXStM3wA7gZccimiRa4WSUeJ+frYE5h2BkIn0IMUsfHCTK/Gb1lJymrI3zKSkj4JSYBpD5tDo/zUKLEgkkSfA3/biI5fn+wd2ZqGoV8AhjBqeHcIkT/fnzD0HEwB8Ld+4GFOFAZUn2srYhFm8EzpnehpCPxUumFhLh64XTaA7b71vQ0D4zP68HP3X7w+thq39abO10z05sI5K+KrGR0liWx02gVgBkRGnIbYqybNjq5WEegYoA5WyqbrM4YgMBw/FHE4sGLlKgzkMw59A3s9ClbMg86AlRQuox+jGocoRYzg0SxKNZx9B3P2Lm0Jg2+wbvsqbAiTYKvSLlgkuA4jYIbyAwhBnzFa2ZkANcbEtenlPc2TnHkZohzwDgxwJMC04GNNB2EGYc1xnLWa0gUiTA4QTCbLtSs6OMTkHWgoMs5qlFXyhnG9N7OT5zD2l2z8+G181uv9/qNIbt7hn8Pjtun0AnuNkaDK57/e5xu9PKG/qtf563BsPrRg9uvW90zB2kg796vU67SZTgqtk47TXaJ8Wf10AMfA1bWv1h+7jQuXM+sHe6Z2et5rDbvx40f2qdNqCpdTZsDzut0xbNctJ93+qfNc6areuTfve8h978jrr8WvhZYD1rssxDU6d93Gr+2uxAVAwbQ+zUawwGH7r9d9e9LsiAlPpdGt0/p/8G3cKtQfe838TWYePE/L0GSVon3f6vdDn4BeYanHdwqn6rh3GXXSOh9+1uJ5U8NQMFm5EB+PjFiHa1lE4lQ/vZXZo08NDElNneDbvFwozxBAGAXdLgO4NAhLVPBPArSlx013IWLKgyLYPvYjVEH6J09KUVjO/ujzmsc8Xu1vb+eLQLheytW9/a3zn8L1ew4VTNuGYtD7O8A7Avky9luJ+GIpW3GOYeJXExljLksJwPF+FJPnwxOT4FPMoB/FHMn9cFTp5NxnBIUWhakgOq/VqqjYuzlWZq5jPRkv9zOTeDihTPByut1Mimf8B/hREXBmE9D5UyjL+AajJQs4g9MujxDEjIMUJawktVwOqjEGIFfp8IjIzfBR8ue+mF9RgnnCop8kE9e2nN4uxt1/f24M/OLi1ezZjUUbJRzawhHYf2uKLV0pcwnes4pvaaSNtTFZfav6aG3+7vH+x7O2JrH5g9ONjf3vZGnqjXt8Y5s6cAGqD4nlqSX6Ti3Z369mtUfEVuvbtqPdQMfERdrSgC+FgFZJPvAJrdWYN0RsqbI07yJVD2vdcskh7JSR4teZrKe0GAHwPyq04i7iOHglh2YSDCrhvfw2Ui7cQZkml2oX7lzA2aqG2zH7mXIzkrDKYHQI4fgVb7BZXp3KxA0iGQkjMYvmJacSD4aH/rsL473t/lvP52d/tgb3Q45js7W4d7h1SvZgAfwVGerxEnQooICkSgXLDIv0EhkGMx9yADNPnL6wLReGGCNX0zMS2/LBZ3MWBe9mOzx3YPWMDlJKF2PllQgqyCUy5CTZDcEO5G/sSXT6HMd63jRgqELPqy64xlTCw9dEtF2BcXDHEuwC1kEC0CsyHFKpZqBQTiUhc7+uZKzyGOZ8zu9cAIO/uKEUXSGZrPQoni5i5mP/g1UdsA5A9tMx7D6mbENe6UGXhVabiuCONqx2qyYnfz39RYw+7O8cAUOQ3j57iEgBWp2dcxD2gQixFiw80EqWLfXYBmuSqXFoG2RnaKRsHgAM5fsEQHGAjMkZjFKMy8xbJo7QM8G80t4qtcaaRS3MCCFO3SYybaW3QhM4FsPizLbDqifSRIPDLtl2WsYumndHdqmAEwSvdcnugXxF0vgPRTJdGyGzfCBh89XzTZSGSbqKAJm5HsgowG216ZudLANztd69hdx+46dl8Yu4s3+3YX2N4l6LO9DH3OJU9AvxEVzyXoE5H3SMXSTmZ9bAy5gY8oLET6+cMQAvujkNhf3IW4Rf8V8ZEp5Sv2sVN72A39dL8/Lf25LZBB0qORYAyZSHhHxHfOsVn7kKp2lmc7VtHIBweVKyAiZM2IzVVCu1pRIiU9BtYbzFNCy+9j+wDYxY0xkwFxVulVzeODNZJcI8l1NVpXo79MNVojyXXsrmP324zdJ5FkxhVFi8VJOpnNeDQ3nmbvo7ScQYf8JF4WctlWdhGtIDGWYSynjBycUX17tD0+cMWux3e9/Z3Dcd3dr/O9g+2D7dFu/cAp1vqLPI6zICvHVMHexo6kYgBxN4DjEgnOpWOlvPL2X4JHS8aY1uhIUIqbQec1h7YXDXasHy5jx6FSuPs5TxGSLmFImesIcxr0nWHfKO2Lh5HYBPKixBOEPvCFruTPBFDBkzGMjili8KIUQDeaVxtj3HG1hx+tk2Wz2Ee75gFyoBA1K3AsH08DjRHzAQVCsBPIzl8RnVoTfRGSZ32UuIMSs9adKwQGeobc91bt77YlnZYI2MAY+JGNXrPa4RIcABYEJmdluHONz9f4fF3j1zX+r1Hj1/h8Hbvr2P02Y/cz8LlFQ4/jc+jwYnwOfWtbLMNSx3Tc+4+G6RQqlgNyb6ZcOjXp5Rj8YRk84Dni1Weezdt3MwGuZ1/Ow5zD4ylcbJqu1VJXs0gw7CcRHq1ID4bfg1XBmg81Hvq19GCSVLd0OvxmZ0WOwsMEJh4hy3mJOXOOZ9HNJDWyReSju5vcSBMYy9jj9k52CP1J+ulRo7lKIBsSmQ084GZdj5qBzRDWHd9r6l0jV1uSEWQ7j4KH5+SxZ+ofkcMQeUSOVep7ci7oz4DLBfGQ/Ss0lzkVS/Y6B36aJqk1EjTxxVWxzwBBvOFwqWdemHDhV19iqIvd6uxHwSNYYZhnIT/8/GH4hk0QulLqMC8k2PdCOOuBG1FqbKTPBXAQVav81cBG6ckLhiIbB6AUZt/0Kp5A7EOSJ7XjIEF5BUe9/NUFXhr3yHtdl7LK3vmRebPBHLm2Ipp33y7CVC5ekOu1THyXUqsaalWihq9NlLgwqr1wzUkeF/IBkuCBJm29enJDr1qghwsyaEGqizygJiwf5edlbmq1V/NRoldFemU+LuUHOhteHsZMWkvf9mkzd6qUFn9nDF0HQ+VikkCkvZotOpBepYio1rcKLFXNlFW/CiiT+OtAYEjjTObFDgI5CvCf9EzY/kaWhbzwGx0b/60kMzVfQDHGnp5yP+N9nAWeccIqTlg1eUJb/k2tQ8eC2EYZKA8YB2jm9qdMYBkt5EVDa2XmJ/KbNAbLhwusEhUdHpmLozwJ2l+MbmDvrA+kaQTp2RNEuGaWFha8krLS7YVFDS7zGyioswt6M/xm21tYe/9s8qLEjXwXpiuD+dfO0o9kkj9P3v0fZbx1pvkrZhoLm9HdaNqF0+Ho5AbRLe8JamHf04G7FKnpi0f5e0dFMmHAY/Rpiml36gvaTQgFjxEdbqBfqRnFoX2PSNgXmCYR9IGg1YBY+cgP8FUE9gGWa9IFFeNSDc9fANXflV2zDUDLPTQSe5caDgDUbJZIfJcAmEhmjIN7PGNdz9duYpIQrNykSCVTBOOyUWlEotugKmq0aIlmujvGbWdY0RaM+MxcYENt95xBkfSCmjncnAvSx3eKMRFAvzJEf442eE51KoIQF4uQQQFMicIMp+3hEkUgJjXIBYtyFU027SC9iX3xzQQQ3jjDTg2WiNgUKh3DyrZA9/k1WMmvskSOCHwzxF0opJuYVYNZn104y+szQPNTmBtv3t/jLgUuVh6w2byIjKsAUAT62iPvEN/nW/3f2OdTVmrMnJJPvw6THomnA/Qv18P/13dPntBj9l2YVypy/RGTb+8jJk+4Q/qlmld6w/rDI3/4h0eeMGb+SZEvDe71t0c+/9sjTxhmxUdfXmmh/7vPgzyh1fxLLLkyr/J9WtobBTBFhafwjp551lMYtXQaAqlk++knLYCID/8BN0iCIw== +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get a list of public identities

+ + + + + +Get a list of public identities + +## Request + +

Query Parameters

+ +A list of public identity objects. + +
Schema
  • Array [
    • manager objectnullable
    + +An identity reference to the manager of this identity + +
    attributes object[]
    + +The public identity attributes of the identity + +
  • Array [
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-public-identity-config.api.mdx b/docs/api/v3/get-public-identity-config.api.mdx new file mode 100644 index 000000000..336f1d2b8 --- /dev/null +++ b/docs/api/v3/get-public-identity-config.api.mdx @@ -0,0 +1,91 @@ +--- +id: get-public-identity-config +sidebar_label: Get the Public Identities Configuration +hide_title: true +hide_table_of_contents: true +api: eJztW21z2zYS/isY3YcmGVOWZceO/eWGkWVXrWzp9JJMzsk4EAlJaCiAB5JOVE/+++0uQIqU/NY0c9dm9MWWwMVi3/cBCN3WdCwMT6VWnbB2UpuJtJ9NIhl0QqFSmS5bWk3lrLZTS/ksqZ1c1exj5p5LkTBH8mGnFookMDJGbsBrINLMqISlc8FimhUt2Y1M5CQSjKepkZMshfl6yrhi0i3I+A2XEUeaVDMj/pOJJGU8jo2+ESZhU22YHwQiSdjAPkxgeshawqRyKgPShbX4IuZyppI684HPJ6HYZ5nOWW9wzvzTi84l41k61wYXlAktI40IccmARxHIDKN+v1MHzY1IYq0SAerf1pqNBv5b19RKmWQgmAhFiNMCrVJQCalB+shJtvtbglNua0kwFwuOn9JlLICJnvwmgrS2bsVTkYI9yEpZjPK9zG2/LBsxnfMUVATRJyVrczIUGRzthpqVHAfMuFpqJZhU5CVtZig5mDpGa1qNV4uUhOXG8OWGrGMnoHxMwIqPBfh1TYpC2ixBn1fFk6lYJI8bbpxYfy54jPFViMI+iaXlr1aWBDoJgRTKJI74kim+EJuWgImlZRPgp2Yby47moroWUIgvEI4RTgp0plKzrH3dqeEaf5RdWb4K31bOFxiDQjRWTWQ/Z+LSFSkXOoSUESGKobKIPFI7SU0mdh4R6+1cKJskAbHLbA1hn3nCIg6pkLNGK4KxFxwSoRbyVHipXJO92dh75TUOvebLUbNx0myeNF/V9xoH/66VJHy93Mw6NE0RaZ/nurrwHdKhLOsxs6521eOWetNHQmULLIZ+q9UbX46uW73BoN31R53eJXy+POucAxE8bA+H1/1B76zTba8GBu1/jdvD0bXfh0dv/K59gnzwU7/f7bSIE3xr+Rd9v3Ne/ngNzEbtAY60B6POWYm4Ox66J73Ly3Zr1BtcD1s/ty98GGpfjjqjbvuiTauc9960B5f+Zat9fT7ojfsw1DklkneljyXRiyEnPAx1O2ft1rtWt309HPkjJOr7w+Hb3uD0ut8DHZDToEezB2P6N+yVHg1740ELR0f+uf17DZq0z3uDd/R1+CusNRx3calBu98bjFbfkdGbTq+ba567wW+NOm+sDiDHr1a1jb7kK4b+c20PCysWF3QxVdnTUS+BSh7H2qQQRtg2XP3JU+lSf4aSNDUQbiYLoMlRrVgFdMmUeS6epnqEMQQhLcPHs76oS0BcSZXgeO9Vgx8cTjkPhTho7B1OJwcCEihoNg73j59eV37OFlx5RvCQynC5sKAR8ryqKjaa6wUkeBuogUm51uQCD8RUGKEC8UAlKgoQkhzc1U9bkQRS1jYGyrTHLJAAX0jrqhwUTHRI3VuqGx7JP9d0q3kfUtNt6fAJljyTSngzwyVKKEjkACYyBCwyhBlQkgxYmFjm0UZ0VeOCJep77DUPc1yDwIqUQUsaHnwCXp0nBM9YSZjP8ingS2p39ywrjgSfHDaOmwfTwwPOm68O9o5eTo6nfH+/cfzymEJqASCCz54AAM6FEgbQYaQBRcnfwSAQYWB7EoAWf6h/V31APJ7YIS1toaaTl6XiS7rDOHvd6rODI+gPapbROJ+tGUF54+FGNwDNLeOekTOpHmoEp+0zP69VrkAir7tqj1QhhiWICrEwh1KSrhTA9pmICMwBnZO9cFxfgELcAWlHKO23ZJmAMSG2pjyLUpjhVr9jRpk1mxq9qKQS5c2XlD2TdVHfAYiGnZSnwZxNOOIobSvgC0Tecep1nSVfsDlUEGGeA8wOQ4lK8ohBNgJTmL8krBeGmLqWwTTDcklFVWcpUzqVwVr1XJlyA5K4ctItOwWTAyR/PE58qNQgHKlZzsIiWpyIzj8gs7XceglcGY1MulQpD0ALQKtLMKMxYGEGOIvwpCtH6K4ECo/K6YqKVa6SVO4urDDQL+hZwLPkCXnXj6D8eKRa8eBGuOQjoG+rEXkjd5OrSPCQ+h9OdlSFu/LEZ4CoonCbu9vc3ebuE3N3/eHAnSK4pwR99jahz1i5gwlsnhvQx1D0KJ2fXvxuIax15A5skHOI9MvbkTv2AHrxJcbDje+Ij2wr3xDeL/xhxycIPwpnVXyBApIdrQZTqEQiPCG5VxKToayp9jdXO9NmIiFA1R0QEc8N2FJnjIPJTKYUSsKTHRZqkaifUjbnUB/t8YitgLiqCr1YS5VukeQWSW670bYb/TjdaIskt7m7zd2/Z+4+iCQLqShbHE5KssWCm6U767TP6TUbAwKWv89iRcqRq9bRCjJjBcaqVZFDbdLcm+xNjwJxEPKD8HD/eNoMDpv85dHe0d7koHlUK/f6q1UeF0lWzamSv60fycQA4m4Ax2UKgitJtQ6rx39gXiOmWNboVVaOm8HmYNIPBXZsHt/x7kBrdsHVcvUOsYwh1cpGWNM0vkQCWpPTAgFnM6iLikGpkiAXhpJcCOBiIGhYJBeSkhe1AL5m6fnTFFSxiZIHWbGKVEGUgYRUCSKNqFlDYElQUkwR8wEHQrAzqM7fEZ06F/0pJM8GqHEXNWbtL/b9JyuQ+8u7znc7ILzBGjG0Dr7noNfudriCAIANga1ZBe7c4vMtPt/2+G2P/zF6/Bafb3N3m7t/z9z9A/jcoaH78TkQPBmfA229wQosdYbB9T+H6ZQqTgIKb6aDIDN03JxjcMIVEErugiHWEJ7O4cuuvajmyeJOmhfk9w0t9rdSZSYC6nmaxsnJ7u4tOAuc9LXOY1nPLyoo/bke6MXuzf4dpQfvCLh7iEaHWUBHzn6/4zYYdTKxkRjFtuTRAtbgpBTGKxieDocf5J/fn1jqDIocsdnBqyUuomgYxIxhO/FT4q6ZoYE2dATdxib6+pg+b/Yf0sMyuUePu8z34FpAz0DKNfVQ/A/oLvA6MCJ/jUGelq1VfoaevvpQphkiNrcSblCu+g3u55obAvWQrMleC25g42BfcTz75e3oOZshIqWKkCUIhoXELQTkVB/CiCqenx/34yRqQkZnszkp51deqGCGsWkERmHv1VAIdlW++zOA2k1mx0mCygXO+vAs914obkSEXbK+sjYGpwzVLlhxl1fmPaeOSFsHqexdObys9l557FRioZLY2ZHGqUg7QXYV53rxkl7fKsQ/cm6e5eYRt+T5mhTWtFeBvaATQJojCx4lZK1vXtzy80r8cJ8FI8h1XQa0hJOj+hosyL32zXJU+HnIryrHe/V2LqHdVqcxW91YAt0yClmHBXOtE/FPxjB0MFWuZhlk2jeL9RkX9SgjvGajJJJnl/SkB+CR5OtCYigbTHyCzZuwiwZYp0Kbth/Js1AXPtK96Y8VnWn4CnosUoY6SL5ZZlzQwwU9WycSJ79tYRhYkNuoA9UBGwCtlf+pEjhBS3XR8rqz8hP7XZqD7SMAUYlLEp/YLyerIug+MXqA1AUNlGnE3sWLQbyE7HhhH6sYKz81WLfgpryRhva5Zjcrb3FqhS31r6YvauyvDld6Klp+7yp9TyX569Td/1PF21aaH7HSODSM4UbLrt2exSC3iG7zqA/PoucC/sJTylSC3bCpsT9sWb+fHEc8xZimnA7mUtAhQSx4iuhwB+NKLygPARJj8sNWkBjNDNBA0iaAWPlERngJmL2FXZgKwMS4A8NrFcD1N+22YkOwch+dxE5zxwGAWiwyhTeYQYhswTiExyPeDWUSZLYIwSZAiVwzTTCumJVnJIYNmoIu9QuzSHpTPE2GjWrJiY+sBT5M3FEyGJJ+BUGXp2srRQYioihDuipEf4w3RI43F1GMe0CooACmRGmFi85ogyMwUwnoBXttbWa7blKyi7TABLdDNhj267Dzw6FYJylsWEt8z0VKTrnvZ1rupxDr8XW7Ok//YX635VoU7i12Yzw2Q4tldj9kN6BXtXs3oLBdmYNxkeb2Fk9XcDf2FYdBdty6X31YbbZogwMT6JSFdkD0U6GaPYdZbeA331TgtqjYG5+3wc9f/ws+LWHQ +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +
+ +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. + +
  • Array [
  • ]
    • modifiedBy objectnullable
    + +The identity who last modified this configuration. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-report-result.api.mdx b/docs/api/v3/get-report-result.api.mdx new file mode 100644 index 000000000..f39548b80 --- /dev/null +++ b/docs/api/v3/get-report-result.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-report-result +sidebar_label: Get Report Result +hide_title: true +hide_table_of_contents: true +api: eJztW+lz2zYW/1cw3A9OMpasy4f0ZUeR5FYdx/bKcrNbN5NCJCihoUCWIO2oHv/v+94DeEny0SSz23bkmTYiCbwL7/g9ELx3Ej7XTu/GmYgojBPNhjzhbPQ5ibmbyFA5H/YdT2g3lhFd9pzvRMKShWAxTYB/dBrAPD+MGc9uJguesDuuWZwqBg8k/VJSzetsIpI0VpqJZZSsqlSYVMzlWiD9WDAO/6mQoSC3cI/rT8wTvlQSJdHsTiYLlmrh4bSIr4KQe+ujmOJLUXf2nTASMcc7Yw90mIvE6DshvvBcCzeNZbICU9w711rEg1Al4nPST5MFmkdHPSNqzYgKV9xzPjyAeSIeA5NExJomSzRSxGHavoPc4QqFMpyAO/ByF2LJnd69k6wifK6TGEzjPOw7sfgtlbEAGZM4Feumv1byt1Qw6QmVSF+KmIU+rQVpbW14t5Dugi248gIwjREamIrPfBkFyE347RO/22l3jkW3c3jUmh3OZiedVocfHrW7x94JyGG1AGbxqlDDDZFCIrbqMAvDQHDloMw+R6P2fB5oUVGK7qxrpROeCNKkpEUC6x5FwQq8xxNoHdBLqNzb0DV8kbgLfOLH4ZLMMHxbVhQtiOsDcyLwF6FR2lajgf9UJRiKhMsAqM7CNHmBDwMXF91DJUgL5ZQuOdfBrxoJ3m+aJ5z9KtzEWdd9K2drAuAJPhkDF0YmQrZRjI6cSKOMGT8lDuvOBIZQ6RJdtz8YXFyfT6/g1ng4Op+Op+PR1cfhaNofn1VvFhf/+Xg5uTgdn40+5jdGk8nFBEZcTC6/759/rMy6GvUng+8/jv59eTGZwvX1+eBiMhmd9aej4cec/0YquaZQB8NatVa47BS8Apab5wbRizANPDYTONAV2sY8LvlkOGIQrbfSJfsUXr5FVXBFdLGh8M/JoTdNVhUPR1UirJRXTJSB6LA0MYQESm6FY+jvQifomkaBOrvWKQ/Am5GURrLoV0Y5Cq6K5BTeuMYscw+TrFAB6T0vt00T6yIXaaNqKd7qnLjNI1+08G/Wmnmd7lHzsHPSbDfxD9m6kO4w8J/lbSTNTIEmIAMxD6bDYKgSSw5R4+B1LZFrqrcarUat0a01jqedVq/Z6TUa9fZR5ycUAWMg1U85+tX1YDC6Qn88hfW+nozg1/v+5Hx8/h38mo4m78bn6JGbjmilroQbxp+NRMO6arWMGUjmpaa0lGSTkB3mIi5rDLeOOi+wFxoFvXtZZdjutDCVhnf6K9ho+TvRRjJV6sdAnN+Cs/FZIE6JWJkRj2OOlUAmYvnkGgyufoSry+Ep1MZ1IS7SJCqynC8DwYzYus6mmAYoq5s7hCdciBk0CZRrJpQXhaAcRg5nVJlYXnnZHlIzYu/VGRtbHGFZ3YVqL4GSeGvTDY/n6RIX2uCMOxkEmFxu9kD6vX22B+LvfUBGtpRVTGV0/PCA2UQm5AtlLKHRI+xgspQJu2RlY9mGMtaIdLnkUF+fiHjrgMj/lgepWE/62xN6Jck9kU5MNnGaotH0Wset2UnjpON2fN5s+a5/4vOT7kmz0cJqn4c/Rmi7GqGH9War9ZNTBGgpDovIaB+dNDP3bXbb25wtNyz+7TudbZV6EEhct1Ecg3vULJbEauBbTEqZl81Cb4XJWSowm/S+qmBXS65HJhyE3gvqxynUsdo85hIlFCSyCxMx2G+lh469DMH9DMms0NC4aqoBS9Sb7C2g24nVb2CVQR8EoP4JaI3/QGGwU6AiUJg9wlYcCz47anRbHf+ow3nrpNM8Ppx1fd5uN7qH3S5yX0LS4nOxLVWsdw0KYJzLghCCGrIQIlMOticBiPmW7PLIGhCNF9h/CnqZsbmaVl6G0H4f8sjbwSXrHLOAq3lK9/l8zQiqdo2erNKAvNXCyn0rxEUs51I9lRCHo9P+9RmCosnoX9ejK/iFtDZKUB8KtPLQLUOC9YvwjiS2CiAQ1SIAcwivzt5Yqm9AIQ6tUGmgNFd6pcGYeQJjbyz3LTPKpAssnYWSa/og9krWRX0f0iTcg3gF8DPjiMNCg8Pe9F1XREntzFryDVtAgyTi13XW9zwCIDxglMQ0zF9hvuWeVwA5P4VQFtTUIRRWYbIB6QpTVlejSMRn5UXB4ADJn/eTvpsAOiOfqERh7i1WRLs+ILOxXFW6acloZNKVSrB1dQn4uSFACxcyE+gmobzZdEQIEhKPysblGatcXyjdvTPCDJOQnrk81S+Iu8sA0k+NVMsf3AobfNqiVshGtBrZMtmMBA8J+uJkOypfrizwoYyLwNvF7i52d7H7wthdfzix+xP2KUGf5ib0uVY8BfvGVDw3oE9M3oO7ZXYQwRu7kPu0f2Gs88P7KQT2J6FwvPgc4cbMN8RHppRvCN/P18Pcn1Gnky1WZS1QQLKj0cCHTCS8HsldSOwUKLG9yQ0g5UyCg6otEBGyZsxWYUrNht3QAai/z7xQ6LxN4C518pQBkavyatR97JDkDknuqtGuGv19qtEOSe5idxe7f83YfRJJVnchLU4q9hzB0+xz1JYzGMCyN2UsD7l817GMVpAYyzGWU0UOzqzVnDX9Y1d0PN7xjtpdv+UetfjhcfO4Oeu0jp1yrb8p4jgPsmpMldbbrCOZGF/5AI5LFTiXTsLQq27/0S6zj2mNXiRmuBlsDiYtdhhb3U3sOA1D9o6rVYaQdAVDqsJGmNNg7BLHxtlYGMDZHPKiYpCqJMiFroQ7+jUW40uFQC4lBS9qAXTjVa3v4w62CZTMyXIuUrlBChJSJghCRM0hOJYEJYWPmA8oEIKdQ3b+hujULtFXIXk2QY3PUGM2+uwKgYGeI/fDbfu7YxA+xhxxZRb4kY1e0+1wBQ4ADYHJWTnu3OHzHT7f1fhdjf971PgdPt/F7i52/5qx+wfwuUVDj+NzGPBifA5j6w2WY6lTbs44/m9hOoWKlYDcm4UuHbDxCgxOuAJcyZ7JxByCByd7zoE55aAP7stnJx8O4uK8JuJDI1oaBzBlkSSR7h3ADKFgpR7qPJL17PCFCu/qbrg8uG1vyT94UMDEGmQwL6Vzr6x/ObZdhjl9EUt0ZZP3iIGxuj3q6GiwPu0QP0lf2RNlqzCFTEdk9hm4vXUruo2nLKGn2NP27CpaaUNH0O06Dh6e0+fH9lN6GCKP6LHNfE/ygvEMpFxTD8X/UByvvULwbbhvHLItCgo2bK0NZhc4rMXeCh5DZ2DeYbz64f30NZsj5KSQT+kIlZDYI0DQXIKLUErrZ/v5OImqTBym8wUJ3q+8McEQYn4ACrOf1ZUQ7MYeoFmdQ66fQHImk+IkQfkAZ314la2MJ25FgGWwXlgSHU966gAsdMAr815TyaPeQCpz8gnu1n9WNTaUmInooDOOsSpSq8duokwvXtLrS4X4R0atZqjViJp+vSaFMe2Na07guBDHSIIHmqz1xcwNvVqJHjZScAeprsuAlrByVN9zudmqfbEcFXo1pFeV42f1no58Vqcxk76yE6pj5i7CUIt/Moaug2FwM08hir5YLDpnWqOIqLUaJZFqhmVN1gAdknxnEBjKOJM5TkzgJATcpjwTkr/QykLM/wK9s8d+qehMt2+giOJIL3T1F8uMDGvIsGZygLbymxqFjoUHFgN7lNE4wKBYf8oEVtBSzjO0tmZ1In9Ac7A0uCAqUdFRz1z0igRnfzF6gKPzMZCCEVznb/7gmllaWKgqxsq2BdYtuClvEEJ9XLObkTfflsKa+WfTFzXuF7snFypYfess/Ugm+fPk3f9Txttlmr9jprFwF92N2Nq+oOzkBq1t7uWZD6Lg//CUIpVwNXQt5hMoxDBlMlHAE/Rpiml3IQXtAkSCJ4j89tGvwiXFYfY1hf2Wak6nfGMQmEPfJgOgV2fvoc1SLpgYWyw8NwFUfw1tr3UFVr6kU9nDbOEAQC2XqYK5GGPpknFwj2dW15PaTU0Sgo5LiUyzkGBcPiuLSHQbNEWdmo14qS/8K/MJSGkRn+EFa6jtXjEYElfEfuRUKDIRAXkZjqvC7+dog+fUFiKIsMmDDApgSpQ4vBtPNygCMaVBL2imw3h+YCfpAxwLRLDVMc7QrkNrh7eiUCfQkZbo4od59th4/llbxZPui63xv+hXfLb0YM9wEOF+F1oiNT2M6Rxv7Pl4XLTe2nd3tnmEdmQBxsOx9/e4PYKd1APeNt+7YUsJK4nB8sgna2VDfuOv17Zq+EngjkD58zvb9zsONldZU/cHJX81sd/lvWZf82HhVomznUq1KgubaVJZlwf8UMRsQ5ECZojZqCpN3niVg5rnmwffjTCm+CMIxf7o3eC2w38BQ3GOUQ== +sidebar_class_name: "get api-method" +info_path: docs/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 Report Result' (get-report-result)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get Report Result

+ + + + + +Get the report results for a report that was run or is running. Returns empty report result in case there are no active task definitions with used in payload task definition name. + +## Request + +

Path Parameters

Query Parameters

+ +Details about report that was run or is running. + +
Schema
 Identities Details Report result.
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-report.api.mdx b/docs/api/v3/get-report.api.mdx new file mode 100644 index 000000000..e22c72fb3 --- /dev/null +++ b/docs/api/v3/get-report.api.mdx @@ -0,0 +1,107 @@ +--- +id: get-report +sidebar_label: Get Report File +hide_title: true +hide_table_of_contents: true +api: eJztW21TGzkS/iuquQ95KWyDMRB8e3flEEixRQLHy+YDUBV5RmMrjKXZkYbgpfjv193SjGewDYRN7W1S8wXjmVar3/uRLN0Glo9M0D8PjkWqM2vYO245272xGQ+t1Cq4XAkiYcJMpvS1H7wXQMVZRvRMKhbLRLBYZxNu28FKoFORcaTdj4B6JKzjDG+MCPNM2ilMdxucGZHtaGXFjR3kdowimLTvuMIHj4LLO5g75RmfCCsyQ6MkSpByoF8JFLyAb5abq2Nh8sTChDBJOBYTHvRvAztN8b2xmVSj4G4lyMTvucwEiGWzXNzX60zJ33PBZCSUlbEUGdMxs2PBcAJQF2dgX8cyHLMxV1EiIm8DmFTc8Ema4GwiXn8Tb/fWe1tiu7ex2R1uDIdvet0e39hc396K3oAcXguYLJvO1EAr7pERH1ACZlL5BG0Vmmv4lkYxmOkxzQ5zm+bWu6jQCocIY0styI01VXCKZdLSR3XemCdGPGj9GeN9MrGVAqJNWC4Tw8oYqUueZiIWGUzgCVys4eQrbDhlkYg5eUUmCRsKlpuZOkjE4kxPqv5rL1WI55G0fJg8Tauh1ongiuQlETxpVc1FnthVOAWkD84GdkGfMEiKDAxSCB7pryrRPGqzT6hWCLlgBePKDWLiGmkhAJnBf+CJ1eTQ492jw+NTFiY6j1qO9orHVxzepzJsM7ZLIwtbOb4RkxQOGQQ+iKWmRaCD5Yn/cFqJlGqqgSkv0VQm1coIg8bprq7iR13lquOgWBiRiBB5+YLBdk5+q7gSC0iIVUFZZMXTNJEhVZMOhiM8Wp4ajiN6RyoOvr0Db1QZYLJ8IwPgMIZSRNXnNthxgrUiCUob6RS8r+/pgtx6YUh/nzRPyhFuLQ/HE5jun8XQf11cXFCZ+AhfLgInXm+RzXcSib7bzTIIrxbkjs0zVfq6EI8NdTRFt0t1zRMZPWD7L8apOie6Hn4Bd2IlyrDuY047cTCtd3QkFtm5LuyeVKI1yrhECQWJHMJAiEB9LSNMkomG8HQsi+pFdO1auQJLtNfYW461wunn/YWGxXZ2BbywJz0mkG8ExRDoCJSmS6YVW4IPN1e3u714s8d5901vbWtjuB3z9fXV7Y3tbZx9IozhI2caPzfPMj6dm/q9UCKTIUt0CB75gwKIg+1JAJochkgrJuZxHxCPJ9gfA9bRlmp6eRk25xXo9W93jlhviyVcjXJ6zkf3jKBaZydYTPMkoSJK1Q80d4wPMzmS6qF29m53b3B2cApPjnf/e7Z7Av8hrznwMVAQrRGGpab+PNZfSWKvwFduygrTZq8919egEFemSijdNzOFLJ2UxYe99rMvGFFl7ftKJZVCh2TYS9kWbehN+AxqCWCFIcemBC5E8teDMBSpbR14S75mrry8arNBFFFF4QmDbASmMH6KhZpHEaauYxDnkMogjLRjDS1daStDUffFzJR1b0ASSEsUB1WnYHKA5I/HySC0OQhHalazsIwWL6L3D8jsLFeXrlIenUmnyiLSBMpkCmaEVhhCZcqxsxnmyxG6y0DhUQVdWbGwBBZqUbn74IR5ZzW9C3lunpB3RwmUnxapVr64Fj75DHZYV43IG4WbfEXy7ZcGe6rSXUXiQ/kXSdTkbpO7Te4+MXfvvzz2SNO/JeizNg99zhSH1aTOqHnOQR8Hc5VmBRHBG+/IFQYG8RDp10+nkNhXQiG9uElxOfAd8ZFr5XPCD0p/uOdDhB+ls2q+QAHJjk6DGCqRiPok90xiMpQz1fr8bLDaHEoIULUAIkLVzNhU54yDybJcKZSEmxVYnQijXlhYAkN95JARxrgKiLOqqJVqqR5C8Q2SbJBk042abvSDdaMGSTa52+Tuj5m7DyLJUirKFo+TTD6Z4AYgRZp/j9pyBgSs2PNkZcqRq+6jFWTGSowV1JFDMOyuDdfirVD0It6LNte342642eUbW2tba8Nedyuo9vrzWR6XSVbPqYq/nR/JxADirgHH5Qp3MK3WUX37L8c95xjLGpaeEjeDzXFzd4Yde/PY8aO2oBswBuyYLdlePDs+YLR/79ij3XSehQJhtjMdkHNLkBJjGCwtjW2gYwMdm/bTtJ+fpv000LHJ3SZ3f8zc/Sbo2HsMOva+ATr2GEKsGCHWXw4dfxmv/XsPf6+vojwUiWzwSwdes/rP3PTrPnpDFULXEGR3e8Hv5FqzD3jgwAMlU9uFVDNTYWkD2ok7nOBpgYCzEZRHxaBiSUC2GFFyIhCP4nmJRE4k5TAKCnyzaWsQWwDDLl+KWCtnkSpMcpCQCkKicd9Vg0YSQknECP2AA+2BjqBIf8f9Te+pP7UXzI5R4wPUmO3ehEJgvpd7vxuLTgjsg/AZlooTt0RYclSgOBYCSwhxk7rSVcLPBqY3ML1p9U2r/zlafQPTm9xtcvfHzN1vgOkeDS2H6UDwZJgOtO1VVmKpPToJ/FejdUoVL4E7Dq1DOlJcweCEKyCU/Il8rCF4hr4fdNwBVdO5rZ7tvQvwsD4CQydTniVAO7Y2Nf0OkAoFLrpr81S23XF5O1X6azvUk871+oLCg2dMXZJB6YpyuljABkf7foO6TQbOJJ2NpgClCZy5/fHqwIDZ6XDBg/zp1Df4capzKHHEZoVBvPt4oscgZgqLiReGqNsUP3M6gm5nWXL3mD6/rT+kh2OyRI9F5ntwLqBnIOU99VD8y9ndihNE3W72uRsWs06Ce/3duckOkazL3gqewZLAHX95+eun01dshFiTcj03CHOFxMUBZMsRhAjVskFxFAQHUXvJdD4ak+CD2mEbzB0WJ6Awu1AnQrBzfx9g+hGK/DFUZTIpDhJUCHDU5cvCM5G4Fgn2v/bMkhh4MlIdsFCH18a9ol5HiwKp3PlueNq+UC32TmIJktizkcarSGs8dp4WevGKXs8V4h8Ft5bj1iJu5tU9KZxpz0N3eDuEBEYWPDFkrWdP7vi1KvxwBQVPkOt9GdASXo76Eamw8Nqz5ajxayG/uhwX6hNdrqkPY65uMQN9MInYPgvHWhvxH8YwdDANzkc5ZNGzxaIbPS3KiFZ3tSJSy03Zki2AhSTfASSGcsHEh9iWCZVoAGwqcin5mTwLOf+Zbmh8rulMj8+heyJlpEPzbJlxwhZO2HI1wHj5XXPCwILcRh2oDrgA2Jn5nyqBF7RS8xyvhVWd2HdoDLaGEEQlLibtuy/9WYErLuXQC6QuaaAEI6ouD43Bd+Z50V2NqrGK/YD7FpyXN9HQGO/Zzclb/qKJzfLvpi9qPJhtmxyqZPq9q/SSSvL3qbv/p4rXVJqfsdJ4nIvhRtP6BUE1yB1am9/Ew13msYC/8JYylQA1LFdoAUYYpsomTbjFmKacDsdS0PI/FZwuEK5gXOkJ5SHAXUx+WOQRoxHductAYA4LNpkAvzb7BOsrFYKJcW2FR26B6xftF1knYOUjdBJ7VzgOANRkkisYizmWTxiH8HjEu5E0Ye6KECy1lCg00wTjylFFRmLYoCnatMrIJuYwxn1iWIJWnPjIXOBD4zeJwZDoEX/TcqbIsUgoypCuDr8f4w2R0xqLJMXVHVRQAFOiMsOH/dM5jsBMueMnbZ2NOn6Q6SAtMMGljguG9Tas6fBRqo2FpWiF73thi3uoe+6ybC2Obmc74o9ekvYlHrF5J8UNJZwxd2sFtzQ7D/zSDKj7tTvOgPbHIBuS3N7itgMuVO7wsbvTiis2MBTG4uwK61JJXx77266v2DfdE16owZXAJXXtKrNfOQd08/bpYn3/m78PiuyvZj5T2J/qWu+Ddqpek54Z63K27n1+9P2Z+/cLJS52cdW0KmyhSS2l7i7Lm76kgCNxm3iVwfevI6Pi5b7K+12sOnwJhvP/9M9xR+Z/spjgEg== +sidebar_class_name: "get api-method" +info_path: docs/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 Report File' (get-report)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get Report File

+ + + + + +Gets a report in file format. + +## Request + +

Path Parameters

Query Parameters

+ +Report file in selected format. CSV by default. + +
Response Headers
  • Content-disposition string
    Example: attachment;filename=\"fileName" + +The requested report's filename + +
Schema
    + +string + +
Schema
    + +string + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response objectFile Not Found - 404 Error The requested file was not found.\"\n }\n ]\n}"} language={"json"}>
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-role-assigned-identities.api.mdx b/docs/api/v3/get-role-assigned-identities.api.mdx new file mode 100644 index 000000000..4c6afc834 --- /dev/null +++ b/docs/api/v3/get-role-assigned-identities.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-role-assigned-identities +sidebar_label: List Identities assigned a Role +hide_title: true +hide_table_of_contents: true +api: eJztXHtz27gR/yoY3h+XaES9/Io102kVx7k641xcy24643guEAlJuJAAQ5C2VY+/e3cXIClKsq340muSqjPXk/FY7Bu/BYG79XQiUp5JrY5Cr+9NRHaqIzEwRk6UCI9CoTKZSWG8ppfxifH6Fx4OMN5l00t4ymORiRSbbz2pgEDCsymMVdABf8kQfptgKmLu9W+9bJZgq8lSqSbeXdMLhQlSmeDy0H70iukxy6aC4RJsrFN2PZXBlJq4Y4lVPDGeCpZpNhIskiYTuJi44XES4Sq9YL/7ovOC773obnX2O7zThV/b3V5XwD873RcwOBWfc5nCvH6W5uKu6WT4nIt0VgkRyVhm3iKzb/kNU3k8EikynQqTR5lBblKR5alqfVBDIdjFP7fY4OSIDTOuQp6G7EBHkQiQBjsp1Xf5bJpliem326G4EhGapGW4jBItVdYKdNyWoWrzRLaNo+MHJR2/MsNz0lmsQS1Swc+YDNuqSTrmkRFzeurtdFaYCNYVE5HCTEvGNm31oCGWSsZ57PVhXsxv7G+iEooxBy3QX3f3aVOPx0Ysq/MdNQPboEE09ziPIqdVBh0tdm5yHkUzZhIRyLEER7iW2ZQ1yDoNVHzCJ1LxDFximup8Yt3GGea7MccfMEap/vuVH+hcLev+aMwaGAANJjPQKig+0UkeWVUK1viXf6YzHvkHOLuBKk20MoJNBQ/B/ckOOHBFOEw5UNR5FGKQ2sgAy8lxaTfQH2tYn2iwa4GqmijQWAgWA5tJFeA8EMNkkDMYB0MDK4wEYQFXbMqvIDkwsBEpB8fLOOFB1kRppIHZYLFYqBAWVjpDTzECV20Qkb+Q5A3kibi94lEurBZwNLCdm4Kb78KDUJ4VTjTSkFO58ub8hGbe6ytjGVFq/4IE/pqmlNbPDZoMPaOQkpmZyiBx2mkjdAX1J6v0JysXcOY7Pp+jbV8XregyJk8SncKGQuqndASk9DV2Q+qJQkN+a7dOnZo+Umg0ZNho9FlDfAbXUw3bxiPJza+wdtllrl0X6FRGy82qPrgJvt6obWw4ADrYGy28+4xnkP0HjTeXTDA+uG8EKgl30SW7DoHaN25VFHjRpkPbtp5FQeFgwCZDBTZZabYmc2aqmaDqJn3fXWJA2qxoUNW9Tgf/VdfiMWAUTI7zAKYANQXogVUCDekesjTM50kSyYBivv27QSK3y/bkacrR8jITsZlr16PfQU1LyX4AuhjhVuuglvNn+AuSqWNt5nAXKI6zWBRZnROLmH2SFC1FuBAWBJS3wr3qy57BUhW+K9ZZAdj49u6Yw74itjvd3fFoW3S6L4JeZ3drH/2yVPx6K9Jw1sYUnlLYPLR+1hKhRC3fFWG0zhLTHDYdcDse8hGAVqCQRHzGHl3tbKpj4O2wXJL87PE1D3EY42EIDmfWkudv0vUqfY0hhYulJciHnTEb6jwNVsorFIKLC29wcHA4HP52eviP88PhGXScvjs+/O3t4duXh6fDvx+dYDmwoBugVLiRCtGLwd+n+hr3ag6uEwDASCuH06OMS4yEWrcLiUqmJT5gMnWcrhAIWfBgf6sNKlV1h/9returQvUgkjCKHaYpZAufnc4BFwsqCZCwkQ5nGCRSAWqQYesJ0VtGaT2kQgHqiA50uIYXvga9+ZPUqk8QywFMZEDxSoaY4QhAWJKFx9C4Vk23oIlWl73kIchr5TtwwqAKUx58AlpHa8T6uZIwnxVTmKyy7oplxZ7go93Ofm97vLvNee/FdndvZ7Q/5ltQtu3sU9jH4Ot8IsyKtFdf+hehYBcPWKQDsMi/QSEQmaB7YoAWfyhT1m1ANNbMAnZsKabjl2XiBnAoZy8PTtj2Hou4muTUzicLSlD++RC3byh7MI8UFalj4l0qJ1I9FKCvDl8Pzo8pMovYQFpLYTlQRThqyukYkVklwDWkJCNwfwXMyxqOagME4srMD5T2LzODujtmDlLCDLf6ihnzpNk41XEtlChubjL2TLZEqwmwG9oAnUD2GHHA3wxMSLXIIAhEkvnHTpMNV4Q8b7FBGEoUEqoDwvAG5s8Qv0OutJDE1pUQyoJqFp1nCPFlIOq2qFRZt0aVR47njYLBAZw/7ieDIIMSlnyiFoWltzgWi3QZOs21FvaNSmmkUsReAIcCqo4DnUK9A5kJZJMA1lw6IggEiUcV48qMNZ8eKd29tcy8yjT1BTw3a8TdSQTpxyfRyo4r4YKPjkVsNiJrFGZyGclV/DTZjSrNVQS+hSmb2N3E7iZ214zdxc5TV6C4XoI+3WXoc654DvpNafNcgj4peY/SrBhE8MYZsslAIQ4ivXl/BoH9SSgcL24SPKv4ivjIbuVLzA9Ke7hatChVi62/sgUySHq0EowhE4mwT3xXHFuQSKraWl7ttU5HEhxUrYCIWHGwmc7pjDrNlaLTK9NkoRZG/Zy5cyuICGNsBsRVVejbyneDJDdIcrMbbXajH2Y32iDJTexuYvf7jN0HkWTJFUWLw0kmj2OezqynuX57ggwDqg+IZciRqRbRChJjJcby6sjBG/W6o+54LxDbId8Od7f2x71gt8d39rp73dF2b8+b3+svqjgug6weU3P2tnYkFQOIuwIclytwLpNpHdaP/3L8KjLGtIapp8TNoHNQ6WWJHXv7y9jxTGv2lqtZgZBMDUOqSkeY02BsjGPTYiwM4GwCeVHhh08JfKEryVgAFfyGw+jrKgYvSgF005k/GOO3OffN1jlZuYpUQZSH7oQ20oiaNTiWxA+gY8R8QIEQ7ASy81dEp85EfwjJs1OU+BglZoc3gRAY6CVy31l1vnsEzKeYI4bWwPcc9NpqhytwACgIbM4qcecGn2/w+WaP3+zxP8Yev8Hnm9jdxO73GbtfgM8dGrofn8OAtfE5jG11WImlXtOtsj8bplOoOA7IvZkOgjyl4+YCg4MSjIBG/OyPi5wDrj+wrjwA0I6RKUPVx0sRfq4AuAWfRNjHOx2Yh5Z7wEQIWuf6Hu8hapd3S6FOt4JWXQnixe2HWEAUuMvZmP7whnXfayN1076V4V27mOPL+fvatnixas3TCOYUd61uwdvAy+5aPJGthdsh7autFbkTLznYPAHZN8ztNS683mUXaZGPpBLD0OZsWsB6jLtt6JX3uh6kX1ycmekcsjSRaTIIWRcS1AxsJlAP/WxodItCYElGkO08je4ek8ddU7tHDkvkHjlWqe/BtWA8Ay4XxEP2LysPHWLhYFdf8tNqM8Ris7e02Dsc1mMvBU+hqrHfX569eX/2nE0QLlO6svf3hMT6BpzsBFyE0vGg+BaBk2iHrG5RD2pfezD82TgCgZm7FFtcqvkV9qlT2FhIpThJUC7DWevf9OO1efdcgf2gfPZKpvYioKExTkR7TfgiKeTic3I9lYmfCmq+peYTNbxlWOPCqvYisLeHAshBSIJHhrT15MUtPX+OHhaB0IJUF3lATTg+6t/ogsJqT+ajRs9HenU+Pqj3dN+rPo3Z/MXMlO6BH7FgqrURf2UMXQfD4GKSQxQ9mS26ZOZTRPi9zhxLvl3Slz4gW+LvGAJDWWfiI0QWBKw0YE4V2pD8SJaFmP9IV3w/1mSm5gsAADgy1MEXXF9d4BkX9HFB3+YA4/i3+ys6FsQ2ykB5wDrAQWV/ygSO0bmcZ2mtzOpEvk1zcGsIgFWiYpK+/aNfJTj3i1EHji7HQArGwqD8agl/M0cLN9masoojjUUNLvMbadjbF/Rm+S2P1HC//9bkRYkH1cnPOxXNvnaWvieTfDt593+U8TaZ5kfMNA6qo7vRsq6mmXdyi9aWzyENPVWC/4deilSqCaDiql4nzZNJIp6hT1NMB1Mp6AQjETxD5NdEv9IxxSHAXQx+AOZEaAIwHo/RDaBRPpIR0Gux91AiqgBUjOUh3vkAqr9rVycOQcsnaCT2qjAcAKg4zhVeewYm8phxcI9HrBtKE+Q2CUG1qEQhmSYYV84qIhLdBlXRokIpjc27MR51S7zl7a25FtjQuHNuUCRaxD0uqQQ5FRF5GY6rw+/HaIPn+FMRJVigQgYFMCXmVnh7dLZEEYgpQ/e6WzqdtN0k08axQARLHesMWy0oS7Ep0SaDgmyO7uPFVs2vykSOCLyd4MkX0s1tRWALsQu6S48K6NNr11W1GKD7KfCCg29v8aQEC5M7bLbPdrBCA8Wg71UPuhY4KT83fGcvT1dq8JPAs4fiYa07XfDoNdP6evj/ejL6gB7LJ7VPVOTm/ef39/7zAXcoHvk+0Rs2jzj/e484H7Ba9dz2iXbbPNJsPKLi6lFspeLL6sDvC7fhZ6fuCfZz9jX+wxUr+S6+xKnZPNOFPIA37i5hlM3DxL7tsJ9f5qYsXVBAuctz5V8OEW3xe2pX96N/gYfp/wGOC+/e +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

List Identities assigned a Role

+ + + + + +List Identities assigned a Role + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-role.api.mdx b/docs/api/v3/get-role.api.mdx new file mode 100644 index 000000000..f352f9c8b --- /dev/null +++ b/docs/api/v3/get-role.api.mdx @@ -0,0 +1,141 @@ +--- +id: get-role +sidebar_label: Get a Role +hide_title: true +hide_table_of_contents: true +api: eJztPWtz2ki2f6WL/ZCJCzBg/MBVU/cyQDzsOMYLOKm5TsrTSC3oiZBYtRSHSfm/33NOd+uB8HOyO4+iaiYGqdV93q8+Lb5WwpWIeCzDYOhWTitzEY9DX1SqlZjPVeX0uoJfVeVjteIK5URyhUNh4HQhFeteDlkk4iQKFOMMR7LZmslYsWG//iH4EHRZHH4SAbuV8QJHV9lofHbT7b8dXlTZeHQ+sJ/DSH+dXP1AVxhP4kUYyRimU7DGvxMZCRdmYw73fRab1etsGDDuuhKhqgIMueXum2/J1ywM/HVxJiY9ht+7jiOUYpdR6ElAnMnA8RMXlpYBjBUaSR7B/0qFjuSxhmoSJhE8qFde8oDPxVIEMbsNo0/zKExWioUeu11IZ6GnKQAnkXxLsZyJqA6kX/GIL0UsImTA14pEeq94vIBbAdyAb9KFz5YqldM4SkS1opyFWPLK6ddKvF7hKBVHMphX7jZ5N+wjMBYbmEl84cuVj4+0nE7zpHHCj0+aB41Ogzea8KndbDUF/H/YPKncfcSF1SoMFIgFrNVqNPBPcYVzqWJcAymqBahaccIgBpLgYL5a+dIhqdv/VeETX8vQh7NfhRNXNoHvWqBXEYpuLDUYQJES4mWZFUy6edzrjOTYk8J32TIBoGeC+cKLWZAA6LcLECYnEgBpMGc8oGdAWOHx6FYqEALWbjTYD9xlY2CGgOdFFIEs30p4GsiU+HF9G32Pjtsd9/jk5ADo2+ZN3m6k9LU8fgoyiwRErQbwuXwGYulKtfJBunGCDQ4v+ZdzEcxBhk6brZM8RCTQrcOjY1yacBVPIGUfhmX6cMsVs49WK14YLTnwueLChVoslxsi1mg1a42DWqM5bbVOD1qnhyf1ZqP9fyTR3B2BamqJBniWoSuBOS8CyOfADjtB/RlwtaatximA1rofrsLaZdBQeJAjVjM3JXiTb9ntexXzKgo4Q6vAnCRSiWIr4fugTkKB3LFAKh9sqCPB9nyRIMjMDyOx1NdFIhXQgXmJcgRQJJpJBnLioN0H4ylXUjko30suHBEA5eApyQAXFUucHNaEdWFO+ACPwQcFRk/PEySBo1exCy/5HCGNnIR95pHE0aEP2i7jxAUbKnwyjMmSiUAuN9YE5ZQrBfdisVzBkxpiV/KlvR5G8F8dRTW8DUS0zVxkxPe4r0rUR72hZzWpQfv1k/WSSdETl7krgmSJnnHYH1xMh9Ofy85xRPPjc1sNjJBoQHJ2BiyGAuKCH3llJ30FPgp8ziqJf5e9SWEEij3FRA5dYA55XXeL3eLtI49zV4h2o3nkzdqi0TxxWo2jg87T7daPj9ssYg+49ph8dcEiA67hUsaxdsicXY4mU7x42Z32foRHPCRkFUIQTWzQd+NwQWsidMifuZ8UF3qlCkD8LnKrZLUCEa3cATmAjHSNhGEsPAHrOwIJxSnGsCFGjmQ8ivgaJpQg/2qbbD/f52W+vhjZFMD2PPBJjZPm8WFTHIEn6njoi5pHzU6zIxyHI9D3acOGdsFdXDDS9AI2Ge16rh50e73BZHJzOR69GZ4PXpVdcRGdl3DNqHFxJVTmjDAb976lkBfhL9AHPsh5EGLAa41AUcyKzxrvnRO5bl7AQPQI8IJPukP8aTha42fJYBHTQTaLiZWJP0ythAOe1yGGYiRIID3dyN67CqhrfzrSxjXHRTJz54O38LfIwvyNJxrB4mqQymwxhZ3j4wMwhAetRrMtmgegNK1Gh748JCUPBwbFdfNCU4Sgd/F9jnn1dqchPFccVkdX34+ieS/EDxMRfZaO6ItVXO33vv/xX90+/vVDyHoKspJblCQFoy7KRNRCrhCHTZgflof3qKcr0DKYr2qlABKjeAHBRhqfgYSDkoMJmEc8MCmUcT04WOdJxjwoUHnlrTOJgtUgN5IczYUeifmYAZpkjc3lZwDDN1lINvPznfxk2r3od8d9uGR96c35cDK9JyPGx5izgATOQRh/I8wFSauGDNEH5mYkBgXxgZAQ1TAMMWm4BxFTeIuKFN+GhJ0HTAASaPci3FNMri1op5AEu5hOWTITiXMrAFyu8GRgslgRLQ2ZUkqKL8gyBYjgxAVEnzI7pHbg3oy9QgRSXsmMqcgN4W6NTjRFM5nEJd6mK0wMgdC36CRFQ/184ewTFRSzlNN82UCoJCJpheQhORn866p7PoELF6PpTfqlN7qYdocX+BHWHE8nN++H0x/h2+Cin34GWODf0bgsUl3IB9LFC0bNLpCnWM/QZZQ+AsT6JNYPB8nbDBFFK6SiOUOehoY8BuRnSQxOFxxNmIDlh0vmCuhk3iUkSgvdptCkPHxx0F1F5zy6upgSNQvGfyMCSsUXYgiyKCihufJNqgWRMIZLYYCR6QR54RL2qopOzaKfXgMC5D1rFSMOIGEMFslfb7jxFIFtbPxJrK3EGxKtn1YVyEcZKWQbcCFvs2rUNmJQjUZbzAzidLq6WHLpI2yKKl/DrW71YSnLQlNdPWNeFC6tRQ/KxN1EAc1axG+DOsV5VB+UnlZprOlp4pJA5sRjezGmdewdcCrGHEJC2jxpNSEA7pAzzKps1xq/HDs+3ss5ogyR4R0mHM8nzoSGmXQFmBVjHIu0ekQNo+16aB1xWscEu8Bu96P9OG+v0YBb40HJFOXHqUhQmdIX3GNB6MIa5A4kiLg06ZR9FkeGAQmhtlRVlpnFKrNWscpyRlGDbM1iVS+dxsOWC+AkbZxvo4s10kmSOKDWYqhfFFqHR74QdQdY1nQ6Xmd25Ln/i+IrA45+1wmX5FYW0nchR3tOLPwwD3fuZududu5m52527mbnbr6Ju9m5l5172bmXnXv5E7qXnTv5I93J3XbWnQtQ04Ny9b9kmdHxIL7klFKSbYjiJo3A0iPWo3F+88XuvOV37eqsa7aHl1pHIoF3ATaqQ2ZKGomsxFnNbSekXFMwlen24b6/rhIMdIM5PNBtPbCy9a0aPDOABy7DknjtM1htXn+YaK0d0Z5PtKbeYLEV35dHNl3QGLNfSm47yOwG7vrC13zhmEX3uOPnV/uNmb3pjcbjwXl3OhxdwOeLN8Mz7aHzm4HphTFYhsFketO9hFvvuucFZw4Xz4c9mgkjqO7by+7wLP/xBiabDsZ4ZTCeDt/kBp9fTcyd0cXFoDcdjW8mvR8Hb7sbQUK1cjZ6NxhfdC96g5uz8ejqMrdbkd+4yEBPLxng4dL58M2g93MP+9Km3SkOuuxOJu9H4/7N5QhwwJmwbQ3/XNGfySh3azK6Gvfw6rR7pv+9AUwGZ6Pxz/R18hOsNbk6x6XGg8vReJp9x4neDUfnFnPLhm5vOnyncQA4ftKobYsrkX9WyYwXRhaTpvSnI5VpCHXoGS9iheoivAW58iIO8pA4cRKJe5ooMtnvx+FUu8/Svuof1WbxsLV6wo60BaqI/HQRLrliA3hCx+Dcl1xdvAiIKwXx6rYlCyvGdWEWu7tvSyh97lErbZOkTRsBKM0EmknxBQymgniW4pRCNJHtG1Z1/4GNxgrmp2wUy1tXCKcv5txZ53AIvPD5yUyxTSAIY2BlBA+CDde9bsReNNtwey4C0ArcOYTwHwbpjVaw9Xu4yB51z4JhX7MIvYgMVMzB5AK2KlzqTFJRC86CA3lmwnZgwDRAMewY29zFRP1LPRMFWDhxEDI/DObA+41tzDp7v8AGBiC7sutRl4aK8V9snsVQCoI9tQgTQBlAX8p5lHbd2swXXFbRJZTBKXRYiC9SQV7kwXOg+NQXSN6RrZJoFSp0fBSPcUnrqASCeL0wxpZ5aU35V9zLRD1Jfe5lzgelzRfIp7ylmIWAPg+2bainaZ7dOzdPI9ogAQV4rMx4PPFj0wJn4n6IwbVcPX9NjBNmur8y5tE839JhW33UU8DQj5i2nF4YeHK+bRd3w74X1qHNZjlPjLVHFua6+CrlLeBiBADhMmWy4zQRehY1bF9TZC0YdjVzGaA26BV1JAeLfoZIiNnl2K9w1UT7uXnKJCuTYoOEYJMk93svRwPFeoXwweftsJKtg3W+AbR6Je5PsLt7a0i4pXFcX5rZ1YHcK0WBH01WBuqJ7XIW6+kjQeDo/QVFXW+7F90z+lQKr0oxSF+DbNo9ZOBKIGnCqaWN+v9tuslM87xEM43Cm7KD+4RpnVGOrcwhA9MLoug4xd4ewba3d8pGWQtroeKB6qqHGvBx8Fs6kBBtel2w7Z82qKkf3cQX5+iyMyRegB6CnSFKVT1ZPzvZAOhl3nOme1n29izdh+7enra/BXdfIm4qNvjICwoxaYd/Wuyz01V1BY8yHhLyvEgg9Fvi6AzQ9pFz3Dlpdmr8qOPV2h3eqs2EM6s1IWo7bnJxdOQcFdvwCsL/Joyoq/uuEC5Yuwz5fLxOh6DB/hzqExJPsJZG6fBGufhp53maAa3/hS2o6ff+q5jQp4L7H7Whm9KxM6c7c/pXNqcozyVjqsT8qW3O2Zm5h8liT7gN+1RksCtQNZkH62p+SwIoYSN3EC05D/R5pJQU1xXveNacnfCD2qEn3Frbc9s17rY6tRPTXnwsmh14otVxZkdO46jWdPlJrX0geO1kJtq12UGzdei12idei1c+btb5qWBgD8xsFPmRfDC8ve0QX8+XWHwfUPN8jY3poGdW1rTuZBa6dEhTBsAbSZi9+Khf0cK4AhwD2Gn3CTsObyDLr0GCRl2uut/fgQeNZaZkNYzwqBVOaSV6S7kdKFFvFg4P9AwyKGYRd1DFt+vRRq0joMNT9hE826Rd7dZlxbHgs6NGp9X2jtqct07azePDWcfjBweNzmGHCj9g+xXYnccdwBmm/aCn1OwtfwOCQNaujK+nxZ9u5WmOJ9Aft+r02BRNAy+LxZcYz+b+0Ltk7WPm82Ce0HU+3yBCULuabCup6YlHkZzLB7et+4M3XVthNGVNnGtbxVDqfdSQrPgivCWIDQJ4elAXELBEsWdm3QOEeKDyA6X+ptbgaZbMOG54wqy+5Yn81HqHMK9KpDdfYvadrIt6FTLu9AjTjKusu3oPM+JVXDs3lNxjC8FdEb3OF/r15puyR6i4mzvE7CVY5KRSaJjEWEOQzkbNMyNlqcXamI/zPFNQOQDyx+Wk68ToxwnNvBam0mJANPwBmDXlNouSGdGIpGuIIR3AgopdThhhSYzNADc8jG7MEflTMDyBHZdarMJ5CITmrQamH4d0z+GJeoLeXfpgfmqEWnrjszDKRw0INk7MakPWIpniIz1sRqXssoqfevud7u50d6e7T9HdzZtj8+oCc5dCn2Y59LkKzPsi0HmWQp9I6Nq7fanEbzqD0oykTgATIv3z/dS8kQKLtl9W1APw7eIj7cpLwHdTfmwkgdb1Z7xAAImOphYAlki4pwR3BjERSpPqoLzaGzwHDgIabAkRE9zvWYcJJV9RElCSzyFIdkOhglex3lgwdWSygFTcdmurUAbxLpLcRZI7b7TzRn8fb7SLJHe6u9Pdv6buPhhJplCRtpg4SSXLJY/WWtLMfX3uGgbYwrXINq4/297afLSCk7E0xqoUI4fKrNWcNb1jR7Rd3naPDjpeyzlq8cPj5nFz1m4dV/K+/jrT41TJijqV47fmI5EYgjjc6EgCEC4Vh6FbLP8BeSPhoVmjXj0bNwPNgaQf09ix1SnHjtMwxGL62kZIqhBDBhmN0KbB2CWOtf0G+gUw+qQ/mCoZ6kK1XAqYBVtEmC+XkpQXsYB5o3Wt6+HOk1YUK2TpKuZdb4osAXasUBGXS2zM9DDmgxkogp2Ddf6G0alh0e+K5NkYMT5HjNngiyMEKnoauR9uq+8OAfgIbcREM/ieQq/OdngAApB2EaVx5y4+38XnOx+/8/F/Dx+/i893urvT3b+m7j4jPjfR0P3xOQx4cnwOY+sNlsZSb6h3578dppOqGAhIvFno0BsP3SwGpz4IuIht87gINuP3tCh3E3wx7HVFusEpNsrXkgACN+eTcE/xxADaofId/Zbj/L3H79BsH/EdwksBUm3eOI3mDF9vfFrZx9Fq/6t07yoILsalmiRJ5MP9RRyv1On+/leQFJCQuzpfybo9zBqEt3gabv/zwRa7hw0KWsfBcrqJ7g3H9z7rRerE34i657W9pQU0t00/VkUB16ky/eD89nzDOkzAwtI0VTw5YMSZLgOYK8hlXinzdjfkTglHwO0q8u8ew+fdwUN46EnuwWMb+R5cC8YzgHIDPQT/YyZduT61koxljgwTxVZpsREOa7EfBI+wX5D2Tr775/vpa3OWITt7YN4Ox9kliAiZ0q7dR/ikD7HFiyhM5vpMcLewU4OqyzwfEGYfgokQ7Dp/FGgMToFIig8JskP41MfvLGdcPOyG7reeURIFD8R9Hyi0zwvPvSZXSzlJ7qxB/UNQY306uiExZMAxBkX9AsXrlcWL5/B6KRD/sLPV9Gw1mk293oBCk/ba0Z0/DtgPnIL7iqj14sX1fLXcfDV68V8NZ92EASlh4CjurzmWay+GozBfDecrwvEheK/PaxceY9pW2TMoQ+YswlCJ/2EMRQfV4HqegBa9GCzqE6uRRtRajRxINb1kTdYgKiX4zkExAi1MfIZRAQVFIcSLgatV8hfiLOj8L3QK6JcCznT5Gpw3jnRDR70YZlywhgvWtA1QBn7tG1GwQLcRB90zTALQy/hPlsAAmrN5eq6tVp2m36dn0DU4ACrNolan+stpZuDMJ0Y3cHQ6BkwwBvXpjiO+oN7MhQ6yQCxbjtikYBlePwS/vEE3DW9aDkNf/WfDFzHuZlUbfP3kt7bS91iSP4/d/YMs3s7S/B0tjQmzpT3ZafKRvJDraK1cQ1T2FCTcJU2leB6yJf2TIvk+c5xm5fMYZZp02llIQdWHleB0xK+KchUuSQ8h3EXlt79NMqcDnBEAzH3TKF1n7yG9CxwgMaZ22K8Bs/4amhxvAlS+RCaxvmUcw7MTSYA97wBEsmQcxOMR7rpSOYk2QpDpBcJiRm9BYOlTViNRbJAUdB4F31g78swrjXNMfGQt4KH94REgJB2d0T+fkiEyFj5JGY4rht+PzQ2SU1sIf0VHewEsSBVzK7wdTkszwmSBfr9MPYzm++YhtY9jYRJMdbQwHNQhpaQ35YQqhmQqN++ZiM1LhDdF6GtWi9/9OM9/8Md5jGfElGZ/hWVAZFSiUyydxV5XIvOTN6fSxYb7BbARL3/9igUizOnu8PK/E4HVh+uPWcpGqS5ImDkcvO0HLPJ8/s6eXXrNSr/psxVOW9QM1lk9o1Ix79XCNxfcfYRRuk5FsOgbupKVe6S011NI6c8GKPz8nlDCfAC8wVj+P7qr1Tg= +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

+ +List of all Roles + +
Schema
    owner objectrequired
    + +The owner of this object. + +
    accessProfiles object[]nullable
  • Array [
  • ]
    • entitlements object[]
  • Array [
  • ]
    • membership objectnullable
    + +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 objectnullable
    + +Defines STANDARD type Role membership + +
    key objectnullable
    + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
    children object[]nullable
    + +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. + +
  • Array [
    • key objectnullable
    + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
    children object[]nullable
    + +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. + +
  • Array [
    • key objectnullable
    + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
  • ]
  • ]
    • identities object[]nullable
    + +Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST. + +
  • Array [
  • ]
    • legacyMembershipInfo objectnullable
    + +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 objectnullable
    + +Access request configuration for this object + +
    approvalSchemes object[]
    + +List describing the steps in approving the request + +
  • Array [
  • ]
    • revocationRequestConfig objectnullable
    + +Revocation request configuration for this object. + +
    approvalSchemes object[]
    + +List describing the steps in approving the revocation request + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-saved-search.api.mdx b/docs/api/v3/get-saved-search.api.mdx new file mode 100644 index 000000000..125d1ebb2 --- /dev/null +++ b/docs/api/v3/get-saved-search.api.mdx @@ -0,0 +1,133 @@ +--- +id: get-saved-search +sidebar_label: Return saved search by ID +hide_title: true +hide_table_of_contents: true +api: eJztXOtX2zgW/1d0vB+m7cFJCIEWvuymITCZoYRJQruzlEMVW0k0daysZQNZDv/73nslv/Ig9LE7j5MvEFvS1X3fn2TLD07Mx9o5unL6/Fb4rC945E2c6x3HF9qL5CyWKnSOnJ6IkyjULJ4IpmfCkyMJvTWN0TSm8jF0dhw1ExHHMR0fRo1FTGQt1R1nxiM+FbGIcMoHRyLpGY+xKYQGuJK+szh355ipEc0ciX8nQscwp6+8ZCrCuAK9tTcRU+4cPTjxfIY0dBzJcOw87jg4QEYCeImjROw44p5PZwH2qXuHu29qb/YP3nj79UPvoLYLvzx+MDqsebt7u3vO4zUO1zMVaqGReL1Ww39l3gYlrkr6AM48FcbAJA7js1kgPVJN9TeNYx+WGVfD34QXw0AeBN0RqWixZRahimNpeAJtrWSpyAjrHBvblLVTVEbNF42D2n7DHYnDmtvYa3B3+KYhXO9guLe3f+jXvIMGqlPdhSJaPSM1pXZa9ounxTCti/YDDsNkir7ZbLW6l+eDm1a312ufNQed7jn8Pj/pnEInaGz3+zcXve5J56yd3+i1f7ls9wc3zQtoet88My1IB39dXJx1WkQJrlrNdxfNzmnx5w0QG7R7eKfdG3ROCp3PLvu2pXt+3m4Nur2bfuvH9rsm3GqfDzqDs/a7Ns1y2n3f7p03z1vtm9Ne9/ICbnWOqcuvhZ8F1rNblnm4ddY5abd+bZ21b/qD5gA7XTT7/Q/d3vHNRRdkQEq9Lo3uXdK/frfQ1O9e9lp4d9A8NX9vQJL2abf3K132f4a5+pdnOFWvfdHtDfJrJPS+0z1LJU/N0GwNOu+NDMDHz0a0pZTRDBnaz+aD1DXQxBovjgddzXQym6kIQ+dOxhMZUpeODzEj4/m5umMyHEUc/CHxIP+ISslrC6qE7nTrOFYD9CHw1XWhIf2UFeOMm2Jjc6Io5ZkrQ4rmv84ZQ678nhiJSISeyGKp469y+2Wm8xQorXLggscYdZiTpV5KPV8iAIRjMoTsVOBlqFQgeLjEzIeJAC6i5TkZXN9KLYcB2FgxHs5VKNgwiY2qUdgKG+AoqBwB2jsIGA/u+FyzoWAjHmjBOBWYSCCxUDFoRFpaxIyXJ4OOhmXGY8NLLKfkHr4Y8SSAlEsUC3qg60cw1qacagrRKtfBlo0pboULHUvNQS8+456nkjDWqPIS+VWzFe48f9IwCQKca7ngrWDiMffPQpk+R/k3q8mLBI/FmiDzoWmJY7CnhoCWsYTyNmeWwPPkGKloysGqDlJ20dhlH6/tvnFrB259f1CvHdXrR/U3ld1a41/F1AADB5JEc6bKJwCzmvkAEs4TEqSDfw/GZehLz+h/tXvq1FXaKIX00uA04+A/u5tIuEFhteRGPIr4HHNXLKYrJmlDOge0MwNYhEkoHNNMXhJBUovBonk2t/MB8abvSxzOA3bLA8BJbApRDRHPfZ86Eo1RgumdioCClBEqYJ3CeR0iACcWWoNHjmQA+thxrFdzL5a3knwUO5MOESfS5a39YXOo6RQpQ+AVpuvcMKU+qSk6oS/u0Q5Zv6tix+tHhHxBMg3XWMg2ovaHiBsRU4MSXqSI2uBrFfmQYXNTTcTcpEsYY3Uv/JcMPIsJDh1SLEy1FVT+MRysMUupp2Y8EkfspqTKmx26UVDlvHCLfo7HkRhTTcfLgo7p8tb+SOsU/Oahz25QzTersSDPXORiBSpcdsqn8xKVl835m7ptStyAzmWA9p4I7q9DvuTWKVnTcRPdDyr6zNqG+AJ6MOwXkEOLfIb6ZQQeUq+b0xrBiuz4Us8CPqcEnvOMmR9vsyyxp/2FSywUuhYZu8YpYWUTzdesMUxqoR4s0ZgOyknn6hdq6pP8jC6uX0zieKaPqtW7u7uKMN0rnqqOE5CoKsKqKJKoRiliqu5X6lWayvV14JpfRrPmojKJp8HfivdfMj0HL75no0hNyTiGn+P+2Sb7/COtkS98WzUpm79EVyDlrYlv02bD24iABXfMZQglBSKasymAE+kaDGQYX5WAF6vIou/nK9xCJkp5pTxESeTtCtP1IRWw4RxTtLi3kCzmnyEdQG7xhI/aZuqWMJ5gnzR0/8RsiM2/awCnQjw+AVtKnu6gb1jvHsnI/r42ORzbCbqR3yLbz7BRosE+WAtRKXHu1JBlwU766eK4wRZZKF4vykdeFJhdkIcl2dev/VcJQ2SsNLTHAAJllcE04x3yN1RPaW3w4PAYuAeUDrXaC1TiNxOowJGMIb/fir5KIq+4MG//s9Mf9ImCFyR+Lo6pIS2MmUL3XvP8FJeeEQ/HRCZQdyaLUs6EHrh6wqKZY8lnDwXkdOju1t3aLtokBH40sJxxBDVvsX+9Bp2x/6PxEBSukqJ9Oy8s7N+hgKC2KW2L/diDfDgL1FwQEmipCGopYsMmlkfBjiFxe7GCJHm9rBYImxhaS5ItzYB90Wk3Q+50m+RrUZlxB1P8/3fQLHOS1IZG4hK6SpvSIndCnKVL98zomwOAumLxtRKYQEj9vrKkwsyNVsB+bGJD8OFsh4CoV1ZkvGLFNg52vTiT9buNiIHm+EEzEfozJc2O5vrKtGtWAZm3L5LvIPAG9wSob8inZHFJTeMKpl0Ur7jof3oVnVvuLerLKQbcsrzUtNXs12m2cKdHcfGY5Y5VGqCmFWHwvCJWVEiK+emvxZ82vW3Ujc00doDO6um3acRkCYtMi46SLotTvFqAz4WNjWMRG2C7shWrApBtrNrlb0FZBUO3owgqq8t66cJNlh5LgIf7c+MN4IfS/6YnAGWX94n1lvJXbpOXmT2RoXDHEWBO4FAQyx4MRAx3K32sD1MV4fYSkkxjhfqV9w1BE5Vd9pb7IK+Rr2WFQZNE3PsMtJ6zgXkZShjP0iG4A4sIZc204rXgw4PaYb0xOmhwXn/T2H29Pzwc8b292uH+4SHt3wDY4OOVILM89akIRSQ9yO0eWOQ/oBBAGqB7A5Fw8ucvLInGM/Rvagn2zcS0/EJw3sewHmZvWxes8ZoFEM8J3efjBSWE7mV/aR0AkhvC3UiOZfjUE5Pj9kkz3dS3TxKQ1qpNemmCV9HTm4m6I46tALjfpUVAGKbCXlmqr0Agbh8G2o7SPhqca1AmsyENI+zsK0YUSedLtDSUKG7uY/ZCVkRlB5IZ3JvyGDDtkCNmVybPvmoC8JzF7pnV5Cu7AH9ZYd+Ibgobp5kqF5F6mkXOikah9Hwfb/YTAJAJMEdiFqMw8xbLorUP8Gw0V+au8ADSqHRudm48s8eqIoSntA8vY81sOkJzaUg8Ydovy1jFdEvp7p1h5jhW1ObxRD8j7i4CSD8uiZY13AobfFSeTDYia6RmshkJGulBEQ62vTJzpYFvFjTb2N3G7jZ2nxm7i409+26DbSXos7sMfS5DbrYEsHguQZ/sUV3ayTzrNYbcYaAQC5F++jCAwP4sQuwv7mfSwtLvhI9MKV9ivpnZw9wfpqvjtPTntkAGSY9GghFkIuEfEd85x6Qoo6q95dlOVDSU4KDhCogIWTNic5XgnjuLkjBETrjeYb4SOvwhZhNAosxso5gMKGnh4mYrly2S3CLJbTXaVqO/RjXaIslt7G5j988Zu08iyYwrihaLk3QynXJ8jkwvBZp2lJYz6MDSt2xZFnKFHd4crSAxlmEsp4wcnGF9d7g7eu2Jhs8b/sHe4ajuHdT5/uvd17vDRv21U6z1V3kcZ0FWjqmCvY0d7SPvCB+MJiE4l46V8svbf6DeSIwwrdErcCluBp1XaNMyxY6NZex4rmKQDTfI3fy9kIXtxcveGaMH4oY86o2eYSHMNqozLwUipEQfBk1LHW+h4xY6bsvPtvz8ZcrPFjpuY3cbu3/O2P0i6NjYBB0bXwAdGwwh1oieqf+O0NEH3IHQbARGARnsWzr56zt299GGfcyjsYgzoFdCkfXDFS8AKMXe8XCegiVd2okMc3VheoO+U+wbpX3p/cQxpMiQQdaSyrysIacCMSm+8hTIqaQ4RoGAbjR3myN8zm9iJnv5IZ3FvhWhKSkECvde8VCHBHcSI4R/QIH2QfEFye+4x2mt9U37wayHEp+hxKx97wmBMZ/t/+6vekugA8xHmC76xtZrXhcwe+Y8hGWEuJ+Z9JVB0C1U30L1bbnflvu/RrnfQvVt7G5j988Zu18A1S0aWg/VocOzoTr0rdRYhqVO6N3Q/zdip1CxHJB7M+URVvdzDE64AlzJfugCcwh+yeLIqdKRUdee/9HVB+k/QqtZARiGkiiAjulZqAewE9jnscJnspKedwnVXcVT0+rt3oqsgy+ZmgiDvOUnHq0amhcdu8yokHYjiQ5ssh1NYHRt37Z1NOic3i54kn56Zm4OKxBmyOzgCQLrTHQb2JzBSuIHbU+YmLMMCzKCbJdR8LhJnvd7T8lhiKyRY5X6npwL+jPgckE8ZP8azQUGT0/YXQI/LZOm8IQM3Lsu9ukjLDccLvXMSw0+EKgvMdTFbnX2FrwFz2bQOzIvfvoweMnGCEYpGZjTdULi6gHC6QLciJJdM31fBAdR/YlUMqYjo6xZeiMHg4uNAlAK+xj2hWBXxa8s9CBtk9pxkKBMgaPy03q+uBUBFshKrm10TumHVdBilZfGmbOptGqQoTkADXcrH0PXHpeRWNSxjxWRFoHsapbKxQtyfS0Tf0upuYaaS9T0ywUujGqvPPOGtxcJUgsPNGnrqyc39NwCPVxiwR2kusgDasLyUX6Pykut9tV8lOi5SK/Mx8fwAx0yLg9jJrExDYUy8FmHeROltPg7Y+g6GCpXdGDzq9mik80uRYRbrxVYcs2UrnQBNxJ/ZxAYoXEmPsS6TbBFmR0UCttPZFnIC5/oqPGnksx0+wrKK/b0lae/mmec0MUJXZMntOXfVC90LIhtlMF8HoEcoJXbnzKBZbSQFw2tlZmfyFdpDJYPD1glKnp2ZC6O8iRofzFqwN5ZH0jTzpGTv1kG18zSwhJWUla6YbCowWV+AwWVc0Fvht/ssSdW0z+avChxM99X6YbB/Htn6TWZ5I+Td3+njLfNNH/FTGOBMLobTZt+KKPg5AbRLe/yafq+CvyFVopUQtywnqEVGmGYIplZwGP0aYppbyIF7Q/MBI8RHe6gX6kpxSFAYgx+WAUSoTEdLo6AYQ4rOhkAvQr7gOf3PFAxLr7wvVyg+puyq7A+aPmCjvYdp4YDADWdJiF+eAmYSKb43aFN1vWl9hKThGAtFopUMkUwLhuVRiS6DaqCDsnhKb7uCDeSJZ7Adp45F9hQ211kUCRaxH5WLxekJwLyMuxXhuibaIPnuBMRzHD5BxkUwJQozPCuM1iiCMRC++hCReOqHaSr2BeI4HLIOMNeBRZ99CEqpWNYqxbomt3z8md4hnPWOV70qId88/zZnyu0SR/RenWGe1B0ktWsMMxq7sopr+Zg0JH5tNcEWMX2hwfcpsC1zSPetl/MuLrOly60hMi+zpCec1zL/IuePdr4km369OFK/tOdtnCeL7Id+PlZ4NocmH+8LnzSBFgzDWZ7pTBk6QEELnmyJe9pG2z4+F/hZn44 +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Return saved search by ID

+ + + + + +Returns the specified saved search. + + +## Request + +

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_. + + +
    property name* object[]
  • Array [
  • ]
    • orderBy objectnullable
    + +Sort by index. This takes precedence over the `sort` property. + + +
    property name* string[]nullable
  • Array [
    • + +string + +
  • ]
    • filters objectnullable
    + +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-scheduled-search.api.mdx b/docs/api/v3/get-scheduled-search.api.mdx new file mode 100644 index 000000000..f88ff36ec --- /dev/null +++ b/docs/api/v3/get-scheduled-search.api.mdx @@ -0,0 +1,125 @@ +--- +id: get-scheduled-search +sidebar_label: Get a Scheduled Search +hide_title: true +hide_table_of_contents: true +api: eJztXPtz2zYS/lcwvB+aZExZL8uPX25U22nVc+zUj8u0jucMkZCEhiJVPuyoHv/v9+0CpEg9IsftXZtUk3EkkcBisY9vdwGQD04qh4lzcO1ceCPlZ4HyxYWSsTdybrYcXyVerCepjkLnwDlXaRaHiUhHSiQT5emBRuuk6Jdwv5qz5UQTFUvq1fPRb6jSgrilveVMZCzHKlUxDf7gaBpgIlO6FeIGfmnfmeegdySiAY8fq18zlaQY1Y+8bKzClMYlXsbSOXhw0umEaCRprMOh87jlUAcdK/CTxpnactRHOZ4E1Kbp7Tf26ns7nT1vp7nvdeoNfPNkZ7Bf9xqtRst5vKHuySQKE5UQ8Wa9Th9V3i4rXC2TiheFKRilrnIyCbTHItr+JaH+D4vMR/1flJeiowyCswGLaf7OJCZRp9rwBYktZWueGdE7In6qMiqLpO6rdqe+03YHar/utltt6fb32sr1Ov1Wa2ffr3udtkNCkf5ZGEyNTCHk6D5U8XIe+FauvXmGFmhtrZmpuTuv5nlzoXGpBQ1rCIm+QkPoaaBiFXqKTEyF2ZgcoHd0fHrZu/yJDH8miuIqpmfku37MspnmA4liJguW19ntNNte39+tN3Y77aa/5+FfY9DZdR4rhntthmY+bnJp91bofMbDgva5X+19+D58GyiZKJHhj1reav9W6NB851a3udx0CLOWPnp90nDWzmhR0b6axAqukLvmIya9ztANQiybNt1ZNfF1zB9JHUyFrxPZp07S86IsTBNCpCwI6GJh6JWBl/FRuvJ57FSHegp7ZCSpTrnNHM6ekpzWizORd3mPJ5gTNc5NKR3JVNzrIIBjCfVReRn0+Gls2dlpDxo7jYY7qMuG295tt13Zb7Tdnf39nUbbb6mdXY+czYOhsFE8LOLfSmkNongsgbCOj75uqseqap71xp5b77jNnctm/aDZPGju1Rr19s8LXtwVBQFyiN7FmbuHwCAs/ZnAj9DskoZ5XAiXbAa4vdwJ72UCyjrVmNxU2MnWloHqOPI50n7Zkghkkq4RRz7RpVLIeyyLj6sjHlg2jOJWbWUUqfY/RjwAcAOVEkRrChfEsZfFAPIUukqyySSKy0Geg0zCiNr1fU10ZCDuZIBkQIzllJxD+j56WHAdZMikFBwnHUVZKsIo1Z5aAU82Oh11eyc/4fe74+N/8Zc3Z6eX3/O3w+7J8elR9xxfu6enV92Tk7kYVvSZh4lLGoxNLExHyVIDWxOAny06FYBsFJdEd9K7uBQu93hlZPdKyDiG+ChxkohAIgoB7jEMBcIDEGIEhCbTlkmcd0+/O15DI72PbJcDY4qpjFMhQ18o/OVxW4ZDtQV1eUGW6Dv1v9UtzRw/mfuq5uydQm9WarneDBsrkj5uC74K+cw4YJFQIpGqcbI0XS5YuCZDY7s74qRDI4eNQZLD8BzmfIKJvBvhhjBqyk2gyho1HCKJLCEYLrWaZfRqrciLrDhuFgXGQXCRPWP3Io3y2GUswoRncTnSZHKwW07XFTfMfT5hDQtZJJi3ue/dmvkU3BbStcrMlXbttPCrg799/DWaLN65TIMu+XK6cc2Na/7NXJOsfoVjksJ7cDgijXolEbcmwN1ucStrAHlWegsh4c7t5dUxfUBY/Ov7K/p4fd6jj4vuJT7I0G4vrk5vl4xgo+0t2fjM05cOKAVsp49iF1bnRxmUIH7NolQlWyLQH8DQe6fx3qFh8aXO34joe6e5hx81Ic4mxpSDaYk+NTjBfeHJkEZBzeaTfLjCpC/pLMma5r7C+PZkOJpZ05YDwazCI/hOvAGkDSD9zQCJzb5gsrbUpYxWyj7FoX2PhpkJAyzdsNgm2qySLltV+gvVc3RtrH6GQ61aHQAmRaH2oLLLn4X2yZ9RyMWVUs/gY5yFNOwL9bEmumMVo9P2qbr/z09R/OElsA+oGwLLMN5v5MCA3mKl2YBhFA+/SYSvBjIL0kpDQsTaEsmtXorIGTgc4f9htGq5zQDezWL5ZNaVPT3RihZiFkTTBeADkIETRiYp55C0ZJKAZuAD/jwFxFheEgMbgX/iTkuhxlIHtfU+uVktXbVaSv4W8sLZopp6oU9r8dCNXrFiCuuyvSv404+iQMmQZ8X26BwMZJCUV+34Nw1OGjweT9LpuUrQcom1VNjg9mKoQruRkltM5CFCivuRCmdmYnZlQsoFmPRzeUSUnARy+mOm4umRQgQM1nFJwrI8QliGZ8soh0PfmPavRJHDZsEzMyoQ/O+0uhcv7uGBI8Tdcs+3vd7L501lzg6qy5ulpaSK91YiAbWdeflNlR5vTJmtjtki/BJ4yDe7HmlJ22kv2zQ6DGhwcRzHCHWuMDtsFAIru1yiH/lTMkIdIoBo/3dtJlWhwWc9H0b+EwDitQ6VO4yRGZGymWUPHaHF6E77hBQm2WKSuU9zu0q0JEnUGuJb6WO+Zn6HdjIUamLpfQCt3hPQ4yrU6C/yLkBZThlWDKt2lex36vvN9qDTlrK5127s7vT3B7LVqu/v7O/zQphKEjkso2aBtdWhvyOr154IIkQ9/ZsiLJeQPTPAgz8dnpnGEwHatC2mafkVqfqYooAR3x6+Fe1d1AHhMOPrcjgnhNC9uli2o2EIn8V6qJfmI8U65PHr7tUJp6DHP14dU8pJtBbWfLsU5xkqIt72G0X3pkQxE6D13iKXEq8s1VeYkLQ7zLahtvvN0wTCzOM+etjRl/QokxaDOBpXXIn95mMqXuiaqm0hwuEaEh+gT19SSRWZzPxV1/PUJHVPrCRfiZGSvoqRo/ye1L6631SIciFlsUhyUlYKOQc4X28nXS/NwBxPs+yFhbVYFq1+wLORXJW70n62EekURZGXUpZHGxYR6jTKEDA3DSS3cMQJG4AnzNsViFXepWK4e2OYOUpN3uXJLHmC370NAD8uT624caes8/GCgUEj1kauJotItkjmzrZVoa7c8QUyzcDf+O7Gdze++0Tfnb95bo/K2Luc+jQWU5+rUGaQb8zBcyH1idl6kNPmjUwWbBTJC2Y2Rfrh3SUc+wPyYUrSqaRWf2R+ZEL5ksou14e53s/Xr/LQP9MFMchyNDMYAImUf8B8zzhmQRlRtRZHex3FfQ0DDZekiEDNWEyjTEiIDNV1SJzIZEv4kUrCb1IxQvZLhwXAr0FALmZ8dxJpc2hqk0luMslNNNpEo68jGm0yyY3vbnz3y/TdT2aSBVfsLTZPSrLxWMZTY2n2Ps1WCjQQ+aHt2Woyq2o+WyFiosixnGrm4PSbjX5jsOupti/bfqe1P2h6nabc2W3sNvrtJh1pncX665kfF05W9amSvo0e7d5XfIc8LgthXEkaRX51+Q/ijdWAYI2gp8ibIXOI9GaWO7YXc8fTKMXcQBi5Y7xiefHq/MSsvRvyJLcoiz3eP7U7AbxrQSkl2TAkrZN0kzpuUsdN+NmEn68m/GxSx43vbnz3y/Tdz0od2+tSx/ZnpI5tQSnWgFKsPzN19JF3UGo2gFIwB3uObnbAzq4+WrdPZTxUaZHoVbLI5v6SQz5RJN7IcJonS0llJTKciYvgDW3H1DbO26KBFENAZCiAWjoyR+foBBJyUnokJNBjzX5MEwLdeOp2BylmZXwmt7diFHtEIGFQCCJae41gY5pOrAwo/QMFXgcdAqj/wDVOq63ftR4szmnGJzRjcfzRU4p8vlj/3Vl2SqBHR8cILi6MrlccFzBr5jJEGaE+Tgx8FSnoJlXfpOqbcL8J919HuN+k6hvf3fjul+m7n5Gq22xodaqOBk9O1dG2VhdFLvWaT5D+vzN2dhXLgTnCzid6+dBCnoNzXgFTsu9OIQyhF6McONvFwWTXHKRVyfaD9h/RwlQBhqksDtB4lKaT5GB7+wG6go4ea3Kia/Yc+jSM7mteNN6+ay1BHjpoarwM2OVnHlcO3bc9W2rUWMKxJiM2iMcDGHnbc7lOArnzCYNP0s/f1jBFFSIMmS06g24Nii+DzQmqiW8Sbl1zzPsh5uaIuV3FweO6+fy79al5GCIr5rFMfJ8cC+0FuJybHrF/Q+qC0kGI9XUFfg4NVHUzUvT1TbkNHSceGw4XWs7CDW0KNBcYOqNmTfEtrIWfEqNzMi9+eHf5snRsO0soF1aaKgi41FuYEQNeNz8zQp04BsVRNhzx5LqVUznkYGIQQCjifXihlLjuWUGdIhKcA7pZ7NRJMVpQr5sXufZ8dacCCpK1mbTJOLUfbkOK27LS7yUHRK4cyg/3vw9dcaQJpzQFdmqTn56nQlBcT/J5ydK8nsvEP3JqrqHmMrXk5RwXRrTXnjnl7cHLiYQMEpbWswc39NwSPSqzcIWozvNAkrB8VM9SebnWns1HhZ5L9Kp8vA/f8bn+ajdhwC1/UKAnvFEUJeqfQpDpkKtcDzN42rPZ4ocJXPYIt1kvseSaIV3tIndk/k7gGKExJtmn2M2pS2RWUdhtb1mzwIVb83xoZc58+Rohllr6kZc8m2ca0KUBXYMTieXfRDAyLPg2zYFxwBjA4Uz/jASW0RIuGlpLkZ/Jb3MfCh8eWDXvgpkcmB8HMxDMn7biG9S6aAOYptS7OF2G38LSojBWEVa+aDAvwUV+gwjRc05uht9i65Mi6l9tvjTj7mxthV5f8kej9Aok+evg7p+EeBuk+RqRxibDZG48rK0aykZuMrrFlT7zRjP8j7vsqZx1o6Yxr+2gHKZMZhLIlGyafdobacVrBBMlU8oOt8iuojH7IVJicv78/R9DfnFTDIYlqjodgF5NvEMRFnoQMRVgdDYXVH+JbCV2ASm/JSWJo1xxSKDG4yxEX/KxbCwkzGONdn2deJkBIdRjocpnFnEaV/TKPZLMhkTBD5GqeJycDWgxGXVqSYlrxoIOE7uSDEHyQ93mTY2ziZyrgK2M2lVT9HW0YTnuSAUTKgGBoEimVGmEN73LBYogFtrtiygebttOyTa1pefdMXljDK0aCj+6NImSFPVqie53KkVuuPDqy4UXvBWr55/xEkyL+ZSsb09oGYpYyEyBYQq6a2exoEPHA82PE47ALbV5eKDVCipvHukyP0xJNcKseuEqIn8xXPFQ5MopvDi3DzO+FOteqLl0DvmCWzid1doOvn5QVKKDefOaCF5DYdbMDbPKUuqysA9BVU9R+X53DDU+/he3Q088 +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get a Scheduled Search

+ + + + + +Returns the specified scheduled search. + +## Request + +

Path Parameters

+ +The requested scheduled search. + +
Schema
    owner object
    + +The owner of the scheduled search + +
    schedule objectrequired
    + +The schedule information. + +
    months objectnullable
    + +The months to execute the search. This only applies to schedules with a type of `ANNUALLY`. + + +
    days objectnullable
    + +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` or `ANNUALLY`, 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 objectrequired
    + +The hours selected. + +
    recipients object[]required
    + +A list of identities that should receive the scheduled search report via email. + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-segment.api.mdx b/docs/api/v3/get-segment.api.mdx new file mode 100644 index 000000000..90d8a192f --- /dev/null +++ b/docs/api/v3/get-segment.api.mdx @@ -0,0 +1,104 @@ +--- +id: get-segment +sidebar_label: Get Segment by ID +hide_title: true +hide_table_of_contents: true +api: eJztXFlz4zYS/iso7sMcJcqSLF962VJsz6xSHttry5na9bg2EAlKSCiCC5D2KC7/9+1ugBQpycdMJpujmEolMgk0+u6vIUD3nkqF5plUySj0Bt5UZJdiOhdJ5rU8I4Jcy2zhDa7vvSsj9KFKMvE5G+bZDJ55MkwGxo4eaMFDmFJ9NOcJnwrv5uGm5WV8anCKI248eBYKE2iZ4tqw8ngmDRuej5gWWa4Tw7KZYI4UM6kIZCRFyCYLejGVtyJho6P2p2TIMvUz/HEnsxk7u3j/n+HRh9EpU5qoceBVoRAMyGvx31xqoJIpFvA4BlJ20TawnnLN5yIT2pC8EplKOUja8hJ4AX9JlNAEMzHn3uDeyxYpPjWZlsnUe2h5BXlvkOlcrAu4lGd0hCyApFqKW4Gri898nsZIT0Tb+9FBf7u/Jw76O7u9yc5kst/v9fnO7vbBXrjvoT61MKlKjDDISK/Twf/Vl1uaMUCrwScYwtM0lgGZe+sng+Pu1wVSk59EgBNTjc6RSbsKSL8m9BMyvjJonppknajbjXq87+8FB32/P4m2fd6bhP5ev7ez34nE9iQUqEer7i9ba5IbmQhjGE6uL+sG+Z8XvyD1AFw1ExuFiZSec1CUF8IIP5PAxqZV8QW7m4HPVX0UPMmRri/f6/Q6fqcL/447nQH92+7QP/9GduYqJM/+LfgpaH8RQzX6X2YERY95zCqD6mtTlBccapGCH2M6YM426i4RepMrJnkc8wmSeCy0aCpTkY1pO7G95sSW7rpUIsnnmJ9GR8en49H4X+v56Yzo47w2IylAsXHI5rnJ2EQwAdkH3sciyhgyi/nHiAzD/FVB9BVTCZNJmmctpnD4nTSCcdbvdNh3PGQXkD8EkBNaw+w7CVRAP3mc1XVY8vjQelFQjkJQMWXAsO4HwUF3v8P7uxHnoRD9Tnc3mvRFp7sf9DqQa14eiv/IIdf7WALQRiyUJo35gkLRWsSZp81GGZvDG1BYTVNqLjMIHFAOqOP87HKMD8+H48N/wJQIFdliMrPKhogIZkQTqpNGP7rlcV5fCHyxysSvUrfJ01TpzHsAdYAa6Rk5w4WIBKwfiLKowYhbaeRExqDuQ6g6QkvKrFBrziIqK0/nWPEZI8LUQ++RsbZwK/28ec7cSAb5hHRUWWbp+sPTI/jr+J9Xw5NLdP+lBtwzkI5nsMIkz17gE6do/GLB5bwq3VjZUrQW36hHtOlLMsHL4ntD0oQR6DMla9aNagxeji9Gp++9Dew8QfgpgkNwYAAWVVf6gQZhXZrJOAR/qqzCteaLZ7PfiQQnBkmWVjWIxDIxN40XNV60XOXZIqohp/IkUVTReLKYK3gCqApTc0HYVT9Klzy+4wuDg5F0LW3igwfksHxyfVNl+HjpPDU51tPnQ+t+1bA36ERBBj1ARcyJUrHgyQZtArvuJRSYEPGvMIiXqGKvQjhbU+IFswtA/Unsp2KUYTMOfyWKiShyICMUEYfC4Q0iHhtREZrYrchXoPIH0k1/E3A/jCXyckxVyYcqhe0Q1kZb37SrWhMVUk8jE3AQSRDvGwH9UGRcxocqfIGrvgPQ7U81l8ihLaQBTGRA8VaGMIORD1mSRYmmcfUiC5pod2tV+dAJg8rTPPgZaI1eAHauEgnzWTEFMM8yX60vK/YEn+x2Dnr9aLfPeW+/393bmRxEfHu7c7BzQBBoDm4KfazZkJfrS78XAApkwDAhxfIXUAggItA9MUCLvzwtE40Xpgo7thTT8cuwU28B3Pnu8Jz191jMk2lOz/l0RQmJf3W5KXtawmdaTuXGfFLk/KPjd8OrkzE8uYAkf3wJn5DWGoQelvGnCKnP1B1x7AS449gaxKAO6FjYW0f1LQjE3XaAGyjd5sACEtOcudiDGW71DTOqpFmk1bwWSoHd1mCvZVu0W5DOSpQ54QYmKNtYvR0GgUgz/8Rp8i2bAeIV+k2bDcNQutaH0rUpUC4PQwtrkUCUQygL2qhQOYBflclgpVddqnI1WRcZ5KRqFAwO4Px5PxkGWQ7MkZjVKCy9xbFY5MfQaW61e1sqjVS6SDJMjriXsgA1QuoMIDOBbBLSpEtHjDo+aBCKcWXGqtUD5OaDZeYoU/Qu4Ll5Qdydx5B+fBKtfHErXPAZ7MBsNiJryLJDpYwEL1FsmuxGleYqAt92ek3sNrHbxO4LY3f15YXbrnRvCfp016HPVeK2a7F4rkEfTd4DuKsYRPDGGbKFOwYOIn3/cez2hGE8dCm4J/sN8ZEt5WvMD0t72OcThB+lsWq2QAZJj1aCCDKRCAfE95JjUpRV1fb6au+Unkhw0GQDRISsqdlC5YyDynSeJMgJNy0WKmGSV5kFsBwiwhibAXHVJPRTJZOsQZINkmyqUVON/jrVqEGSTew2sfvnjN0nkWTJFUWLw0kmn8+5XlhPc+9pi5bBAFZ8cc7KkCs3ZatoBYmxEmN5deTgTXrdSTfaC0Q/5P1wd/sg6gW7Pb6z193rTvq9Pa9a66+XcVwGWT2mKva2dnRfq+pbwHF5As5lMqXC+vZfjt+fRpjWMPWUuBl0Diq9WWLH/jp2PFUZyAaEATvqR7YXry5OkD4sTeRRbyrXgaBv60h1MJxnBCnRh0HT0nzD0wYNdGygY1N+mvLTQMcGOjax28Tubw0d+89Bx/4XQMc+Q4gVIcT6PaFjCLgDoVkERgEZiuNS5bE7t/vowj7jeiqyEujVUGTvYB1FjpViH3iyKMCSqe1EJkt1YXqDsXMcq4uxdNLLnuKFrCUB3aJX4UFGwKTgPyyWc0lxjAIBXb3wh1EGUtmYKfytXEUmQZwDh5QUYoV7rwp8TOJZhgjhH1CgfdApJOpvuMfprPWr9oPZBUp8ghKz48+BEBjz5f7vzqZTAiNgXmO6uLS2fuS4gN0z5wm0EeJzatNXCUEbqN5A9abcN+X+r1HuG6jexG4Tu3/O2P0CqO7Q0ONQHQa8GKrv4NUXVmKpd3SI8/+N2ClUHAfk3kwFhNXDJQYnXAGu5O7oYQ7Bq2kDb6s4lbp1L8MHDy/tIR60rOQ6hiGzLEvNYGvrHiwElnlo81S2pbsUkqi7dqDmW7fbG/INHi+1sQUZK8wD6hfwVp1dpE161RJd1+Y5WsBq2R2I9Qxom84VPEm/uCqygN6DWTItPFzt3IgeA5sp9BCvijteqJU1GUG2Kx0/PCfPD9tPyWGJPCLHJvU9uRaMZ8DlinjI/s3yjuUlgm27+tpNy2UBwW3+3tpiZzisx74TXOOBZjr58vr7j+M3bIoQk0Icr8dNi1tKnJ2Di1AKGxanQHASVRWt8qm9XzOsnbPBkGFRDAKzT8mlEOy6uFh0Crn9ApIxqRQnCYp/nHXzurBMKG5FjGWvvdQkOp4Mky3Q0BavzXtDJY56AZnYa3B4l+xT4rMjiZkHbznQGCcitXbsOi3k4hW5vpaJvxXUfEvNJ2rmzQoXVrXXgT23HUDcIgkeG9LWVy9u6fkVetg4wROkusoDasLxUT8dFRRW+2o+avR8pFfn41PycSahftanMZuumIHyF4dsxIKZUkb8nTF0HQyD62kOUfTVbN3hoj5FhN/rVFjy7ZK+9AENEn8nEBiJdSY+wWpMYETZfREKyR/JshDzP0KvHLIfazLT42somjgyVIH5ap5xQR8X9G0OMI5/W5PQsSC2UQbKA9YBDpf2p0zgGK3kPEtrY1Yn8ls0B0tDAKwSFZMO7B+DZYJznxi9wNHlGEjBCKbL82J4c9rRwsJUU1axDbCqwXV+YwX1cEVvlt/yy0yskX80eVHi4XK35CyJF986Sz+SSf44efd3ynhNpvkrZhoHb9HdaFnXB1Sd3KK19b073FyeCfgvvKVIJRwNXYr9MQjEMFUyacwz9GmK6WCGP72Am+GCZ4j8WuhXak5xCHAXgx+viSGhKd3r18Awhz6Nrqe12Udoq5IAVIwtFZ62Bao/KddbXYKWz9FI7KgwHACo+TxP8CI2MJHPGQf3eMa6oTRBbpMQdFiJKCSj68ysnFVEJLoNqqJNzYWem7MIt4eh86wY8Zm1wIbG7Q2DItEi7tcvloJciJi8DMfV4fdztMFz/JmIU2zqIIMCmBKVFT6MxmsUgVjivpBQerrlJpktHIs3KkF46wzbbWjl8FGqTAYdaIXue5Exd/EOfz9kdLTqSffLrfDf/3dIXBVB+L+V4lYVCpXbdsQ2fdfFT1qgAQYyxHu2M5Aa39zf4z4GtkAP+Bj6d2ySr2+WHQ51hmAQ/ByWNxYf1cfrC8fsGzaePfULJhv5LjbiksWyB/fg488CW3dgne5y2r0VYsy+sLsvlSlr309g71R2xO+P0XH4I2XYfaALqA//AyHTrbw= +sidebar_class_name: "get api-method" +info_path: docs/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 Segment by ID' (get-segment)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get 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. + +## Request + +

Path Parameters

+ +Segment + +
Schema
    owner objectnullable
    + +The owner of this object. + +
    visibilityCriteria object
    expression object
    value objectnullable
    children object[]nullable
    + +List of expressions + +
  • Array [
    • value objectnullable
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-service-desk-integration-template.api.mdx b/docs/api/v3/get-service-desk-integration-template.api.mdx new file mode 100644 index 000000000..1e9acfeed --- /dev/null +++ b/docs/api/v3/get-service-desk-integration-template.api.mdx @@ -0,0 +1,111 @@ +--- +id: get-service-desk-integration-template +sidebar_label: Service Desk integration template by scriptName. +hide_title: true +hide_table_of_contents: true +api: eJztXG1T40YS/isT3QdgC9vYmGVxNpvyApuQgsDxclt3QFXG0tierDxSNCPAR/Hfr7tn9GYLA5ut5HbL+bAx0kxPv/fTI43uPcNH2utdemciuZG+YHtCf2IHyohRwo2MlHe97gVC+4mM6c+edz6WmvVPDphQQRxJZVgiTJoozbhi4k5qI9WIVejJgh4zYhKH3Ag2mDJL9lc+EU3G+sxEn4Rit9KM2XEyYv1gIhWLkiote5WnZhwl0kwZMJOIP1KZiAAIMO77QmtmkMmMwaa37kWxsAwcBCDDSBhHFGmWxD133MGMmCfAmBEJ6ufeU/AHzCxYhiES9RFzM/bmlSRK0rEbHqaCRUPgSzxDNSAHcAhEM8m8nklSse5pMw2JCwkjkQNxF4dRAJeGPNQ4wB+LCfd6956ZxjTSJGAOGslpTs/jZ4UMDw/XuIqOI6WFxnmdjQ38X1WcUxoRaGuckhCPqG8PJMiH6lj4cijBPiV7A0d+BBOVwdV4HIfSJxKt3zUueV8ShYfh8ZCM4ISKBr8Lv6qfS2sgkCZO0NZGWnFkMC/N2VSDqhsjodAngK9UyT/APgd7mYmOswUe16IM2p3N7hYxwYNjFU6tkR7WnavMrkqO8Hz63NoH1AT0jagRYxdvoN8E6DPPp9zZaG81NrYanTfn7W5vY7vX3v4PDBhGyYSDNTwk1zCSPHxOtkkUkC3n2Tnk2jB72/+r+QLGjDRE5T3XYjeaTCIFTgj6m3eamnQmNTEJ3IuQwYKMPx2l6yzVNudYC0H6C5gIpGGP5VLdnHFZ4mzd4waUMUgNeCy5743UMBrUsxupoRzNO7WVaNYAmHNW8NYKc8OneexZ+fDms7NQc6GxPopBTuJs7+CI9DrkaWjqbj5UhKznvBhQ4t8mTjAPZxMeI+/FMMZvuAz5IBRkspIMGkyDRYiqwEsEzX2EB2BIGMTDk5LmbRLOlXCfmQXc0CNOYeYnUfyFflljz3r55wc+akefbqdOjswNcwL1qhALBa46GCTEGyh8PDziio9EUpNDc4ZuxwKIJ1bZVc6kzpmbECFWFpLqttBG24gLQ6ajNIHyzYZJNCGOo2QEyOAAPBY1z1RGJ4CCRGNPxRD8IBE4PboVQUm0QRSFgqu5ZFFyVFc0c4NmOW5+jbqSOBSJUMguiJdzHiXPjC7GjviURcAWG5RrpByyWe2jHonVknQ8SfgUIQgQ1IuL5IzhiFNi9FmRUZ95ZhNDdY298+M81+hiPe3WCxatJ1Q6IUB6fHG6u4+5r0g67hqYyJb1xVzYcv7i9Yt65O+032y82dwK2jtt/uY1lKeg86a7tTXoDjqbHe6VSv1iTn5OwaUa6IaUrZRDAp/P2s+nrO8b8BK2B7XEN1Ey9cpFsITOrL29h+uHEoHCS5xKrUYzkbdIZH9rh0SGX2KwsdWG/7xMYu9oypwntctF9vnkOvBfHbmOZRWEVgcKcjAP5X9FYiFrXea01ZtDMnHxSF0Aw/mgyJyAw551qU+lIVWRLD1UPd4aadHKpynY1Iy5sUlIV5OcVOAUqU/G9MdcjYReXFnf/ng3CRkmAJjyw0q7ubECnYwPwEqNfli5OP/QeLPy47urq+TqSr39bu949/zfJ/uWiZOL94cHu+zq6srTUBpt8xOYAC/UX83o0HS0xQ94dd8yQ0RpLnJLd94L8FZxUhKwRIWxt3uFjt7Zsaw82LJ5O5b+OFMGC6RG7WuLn5T9TTYkMDltvm2VqeZLWX959/a7y929/nn/0t6AxihKDCsEtWZuvvp+8f0ylyfgO82+70epMqe2Rv252c3jrPt8MZ0M7XweHy9dbpZP+y8mqFVWFQkb7fKfPYq4JrSt1XF6dY2tsfvMalDdVmem4pzjeHWtCX9CkVtl81wRtzlvzT3rMaxCmc2S1UT2aWpH5GVs7fuM0sMXZXZf/QW8PpTNxdj19bu3LRcfVwoqA1aqqEw9s87jbSqkzxxq2+wGQE8RECtCltp7foORDVNqFmDW0wglKgFJjdzEQjYNzT9QSKJ0NLbosVT4aoHcU8Atnmdg/y6WbidrTtSPKJBjPxYqqGBS2j9CKYN1yxwsLpWTGTDKAGQBmcegZXvNzaSaYMEoZrEQi/TAZkJJNwEiaxkI3K8SyBz8HzMfYNswUoj2+HBIKqMS5keTGJqcGZWQogCWl7pjuLTZKReS7TIgOJnvQh5o76cGMdTv5+B4INit2x7aDSXacj9JIFM02CntB1osW9bMIApov04qaI9k8KI9oMX9SiAM5LZd2gl7Cox9ACs2QD6JHApiGYqra03IByZoLEsy65ZpXBWDgSaabfaeByzz9V0nDOo94f4noHXwDJx6YXefsilMBnkbUbOs2BZ88Hpjp9Mdvu5yDoC0vb012Bnyzc2Nna2dHVx9IrSGxqGE2PN+obr0T7gFJn3wPJ9gUgC24qB7YoAWL7cYi21ANJ6hf2x27dhcTMcvgN07sw6F//3uCetuM/D/UUrX+WhGCapxcTYH3UByS/g4kSOpandBXXext/+hf3F4DldO9/95sX8Gv5DW3GZ3H0FkgG4ZuXC/JY6dALdcQxoLQR3QerJXjuorEAiTXGmg22DStPPIXB6DGW71mhll0kVDnIUSxc2dYauyKZrrkGBw740bgFUDjh03dg4w/BUUYxGbxqHT5Cs2hiZEJGtN1s93OOwmi4b51IryIMDQtQSGKYSyoL3cKDWQpAwkiaotClXOAukstxyWjYLBAZw/7SfQ4ECJJZ+oRGHuLY5FZx/g2Wquyt15SWmk0qkyHNA4jITO248SbJ8YFDnIzpq5dITm0pB4VDYuz1jlnErp7sgyYxMk5DOe6mfEHRR3qRokWn7jRrjg0/lmTkDWyMzkMhLctJs5MNmNys2VBT4bShEGy9hdxu4ydp8Zu7M3T91DsTL0ac9DnwvlHkVi8ZyDPgl5D0C7bJDd1LGGXMdnmw4i/fLx3D3+RNxpYeEXxEe2lM8x38/tYa8Psp3irPQXtkAGSY9WgiFkIhH0iO+CY1KUVdXm/GofomQgwUFVDUSErJmwaZRSY5CkijYLuF5nQSS0WjFszCE/Zg93o/z5biN/wLtEkkskuaxGy2r0bVSjJZJcxu4ydr/O2F2IJHOuKFocTtLpZMKTqfU0d5/2YBkMYNnrWSwPOft2wQxaQWIsx1heFTl4g0570B5u+6Ib8G7wenNn2PFfd/jWdnu7Peh2tr1yrb8s4jgPsmpMlext7WjfeBMJbvGmCpxLmygKqtt/Kb4qOMS0Rs93MtwMOm/iQ78cO3ZrdqUjA7IBYcCOySPbixenh/YpoHt8lLjn9wizrersPjZCSvRh+7LiEjouoeOy/CzLzzdTfpbQcRm7y9j9OmP3RdCx+xR07L4AOnYZQqwhQqy/EzoGMiBoNgSjgAx+CuqlEyYxiAK/3O6jC3vDk5EwOdCroMjOTs07W1HEjriaZmBJV3YiVaEuTG8RvWw6Lb0RoICjEaRIxSBrSUC36FVyIhCT4gvgoZxIimMUCOgm00Z/aEAqGzOZv+WrSOWHKXBISQEf/uO6t1ya7IUBoED7oCNI1F9wj9NZ60/tB7NTlPgQJWb7d74QGPP5/u9W3VsC+F5BgunizNr6kdcF7J45V9BGiLvYpq8cgi6h+hKqL8v9stx/G+V+CdWXsbuM3a8zdl8A1R0aehyqw4BnQ3UY29xgOZb6QC/E/tWIvW/PmBEH5N4s8gmrBwUGByVoARclHo+DRS4A4u9aV+6nZoyRKQPVcydfGnjypcHxcHcPD8pgLpq9W3o92I65xjdYJwL81R3qxkSFx7F7XuuxmbqVHanRrfviQPKDh+wiLrUqSZMQqIyNiXWv1boHTwEPeWjyWDYhgYKzmKmKbpt+NGndbNbkveJQKWTOwJ3/wFPzdpEm2TeR9Bo1xQctYK2dHaPM39dfSD87TTSFHohZMut4YMO5M13Gt4ihl1nRNLpJ7jsnI8h2kYQPT8nzr81Fclgij8hRp76Fa8F4BlzOiOdeXc686wxBv119zseKQoaPGzpzix3jsA57L3iCRxjpDZzVXz6er7HS6XA6QCkk9iYQrCfgIpRK+9nbKDiJqlv2Krtg/cr7Phi6bBiCwOxKnQnBLg+cEn6FGnMKRYFUipME5SGcdb2aWSYQNyLE8tssNImOBwHSAg21eGXeGpVa6kmksq+H48vjV6rhDothENAYJyK1mOwyzuTiJbk+l4l/ZNQallqDqOm1GS6sai99+/64D/kDSfBQk7Y+e3FLr1Gihw0cXEGqszygJhwf1be0/Mxqn81HhV4D6VX5uFIf6ShUdRqzGY1pKMNhwA6YP44iLX5kDF0Hw+BylEIUfTZbdP6qQRHR6GyUWGrYJRuyAaiU+DuEwFDWmfgAUQGBosjuz1BI/kaWhZj/jY4x/FaRmS5f4lc8YGQQ+fqzecYFG7hgw+YA7fi3tREdC2IbZaA8YB1gt7A/ZQLHaCnnWVq1WZ3It2gOlgYfWLXnAeOe/aNXJDj3i9ENHJ2PgRSMoD5/b41OOVtaWCArysq2I2Y1OM9vGEFdntGb5Td/qIq1+v9NXpS4X+za4JHsL52lH8kk/z9592/KeMtM8y1mGgez0d1oWdePlJ3corX5PUTc5B4L+BfuUqQSnoduqfhuT5kMAmb0afuJpbEUtPsQC24Q+a2jX0UTikOAuxj8wn0raETfRsHj1xz6RRkCvSb7KOhEc5pga4dv/QLV3yPX452Blk/ou1J7meEYftAlVfi5J2AinTAO7vGEdQOp/dQmIej0lMgkiwjG5bOyiES3QVXQITuRTPTx0B2JKxnxibXAhtrtUYMi0SLudHshyKmwZ/lwXBV+P0UbPKcxFmGMzSVkUABTorTC0cH5HEUgptyDkSgZtdwk3cKxQMSdMIcJm01oKfFSHGkDnXCJ7ks/4zXraPfFjv1X+uEwV5mwpWjFuA2Hikpti2N7zUvv0V6TnMl1m/C7V/p6GDQwY1A3Tr+/x40c7L0e8PIfqcBdgsvrorWiltSdug3y46+Panr11Am2Ro+ivsCHyGq1kG1ZqmmxW+F52SdwSrLSFx3sbhRJYgfY/arS1LknOpX2/qd9dHH+CGBwP0BrkBL/BytVrGk= +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

+ +Responds with the ServiceDeskIntegrationTemplateDto with the specified scriptName. + +
Schema
    attributes objectrequired
    + +The 'attributes' property value is a map of attributes available for integrations using this Service Desk integration template. + +
    provisioningConfig objectrequired
    + +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. + +
  • Array [
  • ]
    • planInitializerScript objectnullable
    + +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"}}>
\\\\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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-service-desk-integration-types.api.mdx b/docs/api/v3/get-service-desk-integration-types.api.mdx new file mode 100644 index 000000000..c6fcd42ec --- /dev/null +++ b/docs/api/v3/get-service-desk-integration-types.api.mdx @@ -0,0 +1,95 @@ +--- +id: get-service-desk-integration-types +sidebar_label: Service Desk Integration Types List. +hide_title: true +hide_table_of_contents: true +api: eJztW1tTG7kS/isqn4dNUowNxgkLL6ccIFtskYTDZfNAqIo8I9tKxtKspCF4Kf776W5pbr4A4aTOblKTB2JrpL5362tZc9txfGI7e5edM2GuZSzYgbBf2JFyYmK4k1p1rjY6ibCxkRl93eucT6Vlw5MjJlSSaakcM8LlRlnmpoLFuTECxlJpHdNjZvMs08aJhDU4yIoDc/NM2C5jQ+b0F6HYV+mm7L2ZsGEyk4pp01zqR3nuptpIN2cgjRF/5tIAD6cZj2NhURYYLyTsdjY6OhOe31ECSkyEC0SRZk3fcxQGphthM60sfN677fQ3N/G/ph1OaUZivbwcRDKGz1Hnmh3S+eMtAFxjDaPKITOeZamM6Xnvs0WOtx0bT8WM4ydcATIQS1gnnZjZZRHJVUZkoAxQtYyzdW5mQCBLuRMkS5cM4G2KwUHcNjqe9Ds+ExgVQQQ9+ixiB08zgyZ20ptM4azVAkkfKTijsFbBVNxwEIM0IzYlF+uMVJPOXTFwH2Gcwa55mgs2huBZQ//c67REv6bkvVyqeYw7WD3K3SO4nlXUl3ijctLRvDWxGXxEot/hv43OYFVo7qcSc/DQGJAkYqeUnxCA0lsbXSsgPUc6ofSRCuSWyVMCcI33E+G4TPd1Impzg56L9eSNVCICDSVKKEjkGBYyoHgtE1jBZtoI5kkWAUPzmrYFS3S32GuegL5ev/2gDBrW8PgL0MLkf0igCyVhPSuWMJmUHl3BVuwIPnq1udsfjF8NOO//OtjaeTnaHfPt7c3dl7u7yH0GFYlPvGkWMrfJ+jehhJExS3UMHvkLDGIEB9uTAMS8nuz3+4BoPML+56CXn1uqGeSFonDjNqBqvN4/YYMdlnI1yWmcTxaMoKKLMxhReZryEQ45kwvQ3BN+b+REqlWiCJXPsMIcHL4ZXhyfw8jp4X8uDs/gE9Ja2nyGCqI1wbAEUSEWpvorSRwU+MotsyIFc4iky14Eqi9AIR72pzCxSOK5BWNCbI15njpYEbivWFEnzcZGzxqpRHlz49gz2RXdDTbCsRl38ZSNuIUFWGFh+osh7E6Zi46DJV+wqeCJMM+7sK0lEpXkqa8iFtbPgRDjSYKp6wmMc0hlQVuOzh1T2kGZaPqiMmXTG1V1Oa47BZMDJH84Toaxy0E4UrOehWW0BBGDf0Bmb7mmdOc1o5FJ58rxGLTgKeyVsYZdM4bKBLpJ2LBCOUJ3WSg8qphXVqx60aRy99YLc+A0PYt5bh+RdycplJ+IVCsfXIuQfBZhha9G5I3CTaEiwUMq9rg4zCrdVSQ+G0uRJm3utrnb5u4jc3fx4WkA5OEpQZ+tZehzoUJngJvnEvQxFD1KF+3DXx78ekduYKsRINLvH85DN4JtxE2GSPg74iO/lS8JPyz94cdHCD9KZzV8gQKSHb0GY6hEItkjuSuJPUgkU20vc3ujzUhCgKoVEBGqpmFznUNTAz7PlUJJuN1giRZW/eLYlEN9LHotXbZbUdlvtUiyRZLtbtTuRj/HbtQiyTZ329z9MXP3XiRZSkXZEnCSzWczbuY+0sJz1JYzmMCKo2FWphy5ahGtIDFWYqxOEzl0Rv2t0dZ4JxaDhA+SV9u74378qs9f7mztbI0G/Z1Ofa+/rPK4TLJmTtX87f1IJgYQdw04LlcQXNZpnTSP/3I8uh9jWaOD8wI3g83BpFcVdhwsY8d32oFuQBiwo1lzvHhxeoz0gTWRR7vp3MQCYbY3HUznjiAlxjBYWlrXQscWOrbbT7v9/DTbTwsd29xtc/fHzN1vgo6Dh6Dj4Bug44AhxBojxPo7oWMCuAOh2RicAjoUtzvKOwXh9LH4wZubiXAl0GugyP7uit/TtWZvuZoXYMk2TiJVZS4sbzB3hnNNMRdvgbAJlEjFoGpJQLcYVXImEJPiVYZUziTlMSoEdM08Go4daOVzpoi3kotUcZqDhFQUUo1nrxpiTEI4iTHCP6BA56ATKNTf8YwzeOt/Og9mp6jxMWrMDm9iITDny/Pfl6tuCeDNAoPl4sz7es11AX9mzhW0EeIm8+WrhKAtVG+hervdt9v9z7Hdt1C9zd02d3/M3P0GqB7Q0HqoDhMeDdVhbneTlVjqDQbX/x2xU6oECSi8mY4JqycVBse7rQIGpZsTkwuA+Ps+lIe5m2JmykTtWX/1NIKA+BJxvGu9B2WNatHi09oVZj/n6u4KNYF4DXessVBxpN3prVtpey5cufYth7dAblJYNHUus3u93i0EBgTEXZdnsgv1EmLDzZX+2o31rHe9vaLMVfd0oVAmeUxtCl5a90y65E4jMWN8eSUG3rlkQMwNcDJdZ7iXfnGNeQ4tD/NkNvDmb4heGgYxM2hdfrE0u0vRuqQj6HZh0ruH9Plj+z49PJE1eqwy3728YD4DKRfUQ/GvqmA6Q4zvuS+FVLVv4a8L/SVm73Fan70W3EAD4i/cPPv9w/lzNkFkS5UltwiqhcRWBHLzBEKEKuewuHyCi2gzMzqfTEnwYeN6D2YqG6egMPuozoRgl0fBCO9gSzmFPYBMiosElR1cdfWs8EwirkWKu223siQGHuRDDyzU4411z2lnpRZEKvg4o9HuRxWxA4kFD2Oe5gQVqaNkl1mhF6/p9VQh/lVQizy1iKjZ5wtSeNNexv66eAzlAknw1JK1nszc04tq9LBfgxGkuigDWiLI0byUFRdee7IcDXoR0mvK8VF9mErYtpvLmC9gzMKumybsiMVTra34N2MYOpgGl5McsujJYn1FphFlRNTfrIkUeZaRjACEknzHkBjKBxMfIQggDKT9cQyl5CfyLOT8J2jRE/apoTMNX+I7NDAz0bF9sszIMEKGka8BNsjvt0IMLMht1IHqgA+A/cr/VAmCoLWa52mtrOpEvkdrcGuIdeZLjM32/Je9qsCFT4we4OxyDpRgxPDlNTX4zgIt3A8bxipOHxYtuCxvqmEbXrCbl7f8DRW35n+avqjxsDqkea/S+feu0msqyT+n7v5NFa+tND9jpQmoGsON2Ib2ox7kHq0tHxnimfZUwF94SplK8B2aI/82IWKYOhl87Qtj2r/gOJWCDhsywR0ivw2MKz2jPAS4i8kvwmuJE8DleOJtAY3ykUyBXpd9gG5OxWBi7OTwki9Q/axDS3cGVj6h1zoPCscBgJrNcoUvW4IQ+YxxCI8HvJtIG+e+CEFjp0ShmSYYV64qMhLDBk3RpZ7GzOz7cXgHrubEB3iBD204kgZDVi8hdipFTkXqmw6Y14TfD9GGyImmIs2wl4QKCmBK1Di8PTpfogjEVPgdRJtJLyyyPZwLRLDV8cGw3YUOEocybR00vjW6a1/XpNdU2bG0dNe6EVy31aH8j/qubtiOsI/oZXjUhtbJfV/j+8nLztp+Mqy3+I7qFCyKk29v8WgG26s7HP4zF9j3X15V3RN+Ayb+iIZa0C+CjgboEKfq/pd/5mj0vL8dYiDwNdtq+ICs7u7+C/Jzi2U= +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +
+ +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-service-desk-integration.api.mdx b/docs/api/v3/get-service-desk-integration.api.mdx new file mode 100644 index 000000000..a9d10e02b --- /dev/null +++ b/docs/api/v3/get-service-desk-integration.api.mdx @@ -0,0 +1,123 @@ +--- +id: get-service-desk-integration +sidebar_label: Get a Service Desk integration +hide_title: true +hide_table_of_contents: true +api: eJztXHtz4rYW/yqq7x+b7AABAiHQ7XbYJNvSSTa5eXSnN9mZClsGdY1MLTsJzeS733OOZGODyas7fezQ6bTBlo7O+/yOLPvOiflIO71L50xE19IVbF/oz2ygYjGKeCxD5XyqOJ7QbiSn9LPn/CBixhUTt1LHUo1YYaacz2TDGRvs1xjrszj8LBS7kfGYHUcj1vcmUrEwKk41V3kSj8NIxjMmNYvE74mMhAcEGHddoTWLx3BdKG8awlI1p+KEU2HWG3jA3EjElijSzMtRcaY84hMRiwgFvnMU/IAZ0oNbEgWb8njsLEo72GehD6uK1XICc7AszEzZdXpxlIiKo+NZgEtoOZnCHxVH3E6D0INLPg80DnDHYsKd3p0Tz6Y0Mo5ApTSS05yew1Gw+/tPSF5PQ6WFxgnNeh3/V2S2XPR9YJB0j1KM5DWYYrAPa7ghjFExkuHTaSBdGr31m0ZadznmeBAc+6Qzy2Y4/E248ZKuVmnolWZ6Klzp2yVqBV1dGksUiVXMUhWHx6CSYRKD1KCCaYTmjqXRAZiuRHVFni6U/D0RTHogKTAgIuaD4z1kz4L2d5rdVpu3ujvCb7Xqjd3usOHXt8X2TnO71Wi4u859xTrSCluUKQMn1Ng58IB/sUmiYzYULCFWa6nspd6wKkzZB2QCmHEjwWNRqhgQfMLB3I4HI6qxXFJ6z0Ge8C4EOAQdjHjY82+4ZumCeS6b9WarWm9UG53zxm6v1e4127Vut/U/ZHASemiHv5DDgIN+s2WX+WxWG7vLfBaWfYZxcwMfNmWfXYtoxhTSWemL9ymFp3LAcLjuXakrVU3JfghvzvYHR8UrV6qEO0/4PAniOX07tcwH01vAYnijRHQq/Ocki2OcA/oykRnPUFnF8E4FfzjAUzr758ckO9IRKplgYhnsH3w4H5z/gqljzn92FTh/SgpZ5BSrWtGN3G5jt85bOz7nnhCQJ3b8YUtAunCb9Z3tbj5JPG0pT+ppwGcmUxSVn0ynYRRDRQDryZiu0SzI8s79J8wAAeSTZ5vjLEwicCc7+aXGKFIptcne4cXZ+cFp0STpxSdaZGGZcnvstjq847uu59UbHc7bu90dv+u3/B3/6fZYWGi1Wc4jLhWioZ/7BdMYAntm/qKJlqN6L5Po0TLFNiIBzLiAjgBozY1eAdQUAzNwHUkMufv5hkcec8MJABw5lAG48ObDqel29scfs263S/qYRsI1JcWgGpUEAR/iOPyNGZ0rPhKeEVWXpCqjxMG+fqZQ4IHXUsNl4G8vVL4c1dK1ToUmqiCwrjDAB3OpxyISTxSdRxGfIfyLxUQve8N9mfiZli5TP9tue41ug+/u1Bttr7nbareHLd7cbqL6mm57Jzek3dmZD+nuNrcddIdlOZeViHXv1fLAV8yG6SyFWEKThl26nVi1JtqA6IxAXuk6p5EsOxSjH6AJFCvNgyPSf4nnnmWr34wFMBAZpF5kAy6knBhDFkxMcF/o2LgJJC5mbAy/o3BCUoXRCBqKAQBytAVTKR0v7w+MgwPA9PBGeDnRhmEYCK4Ie3LvWAWz1KRZ1bOwPDNx0cHzaywrAK6C4ylkF8TLOH/M4cHzwOFjwIPsCDJLCGwhFkyN6THps0Xtox6J1Ydc+ZmJ319sx0qZfGFZSOsAtlJ6vp6263kPrZfWjbPji9O9g2LZsNeeWDVMK/fs9RfLSlm4DyHc+dPLyo8JuFQV3RATqekC/hRrP56yvhuDl7B9aKrcOIxmxTI0bwyNvU0dmueyjGOrUqPRVOQ2iey2uyQy/CWG9XYD/nFSiZ2jGbOe1AA9vIBcE/4pI9c0rILQaqBkLHkg/xDRGWmzLE1CbMC/HJKJjUfaPGA4HxSZEWBmVlnqKxa4RY83Rnpo5dMkwK6ExyYJ6WKSkwqcInHJmO6Yq5HQDxfjN9/fTgLsFZDCd68atforBnJBP6NG3726OH9f3X31/durq+jqSr35Zv947/yXkwPDxMnFu8PBHru6unI0l4HZM/FiDy+UX03p0HS0xXd49cAwQ0RpLnJLd94J8FZxkhMwR4WxN/tzHb01Y1l+sGHzZizdcaoMBFmofU0dnlDmb7Ih9XCz2putPNVsKeMvb998c7m33z/vX5obcoJwmc0FNWauvf724ft5Lk/Ad2p91w0TFZ+aGvXnZteO002rZ9NJt0Nexsdzl1vk0/wXE9QGK4qE+3P5nz2KuNpIxMVxemOTbbK71GpQ3TYWpuKc4+nGZg1+QpHbYMtcEbcZb7V94zGsQJktktVE9nFqR+RlbPPblNL9F2X2QP0FvN7nzcXYp09v32zZ+IC+/x5Lgwrz1FPrLOe1D7Y4QfrM9uJMdgOgpwiIzUMWoY7m1xjZMKVkAWY8jVCiEpDUyE0MZNPQXgOFKExGY4Mec4WvFMg9Btymywwc3E6l3VtZEvUjCmTZnwrlFTApbTujlF7FMAeLQ79hZAaMMgRZQOYxaNlcszOpJhgwilkswCI9NJlQ0k2AyFp6Are5BTIH/8fMB9g2CBWiPe77pDIqYdjLyGBRJaQogOW5LTS4tN3MF5JOHhCcLLcc94XN1udsec2n1djPUF49A1VQsBj74hhVB4zZtg6VQzviEzD4oiRZFeaeJ/EeD05y9XehB7tLizNgeeeaBwluGH4W818o83CpRmHVeQ5GXlW5XoqHV1bCsg2T04vDBdhLV54IelcutbhpUm/tiuG21267bd7qtHeHXr3jue5wt9NpNdzO7tPRLZFfvVVSxlFfRjGlRbJM3lGXAQYOsTsp9FikBOMWH35gvgOKrbInJnuBxKxzEEVQ06rsVMRJpEzXlY/hYejRAymprtG/a895evJwZ+3htkWwR0+FHlPse8g31VFktjkEsQww0DbRlK0mqFlDMn1sReOKFgBN1BrsHfdYmpX3rDCo+Ii7n4HW4OkPV9IpTHpZw1uyrOgIPtypd5stf6fFObROjU572PX59na92+7SNulEaA0tbn4zJu1sF59CKhFJF3KkS4DeA1tx0D0xQIuX7OussAHReIL+cQ/GjM3EtPxCW3YbVwCivts7Ya0Og0w9Sug6Hy0oQVUvzpaaDJDcED6O5Eiq0ieCNh3sH7zvXxyew5XTg/9eHJzBX0hr6TFtH9sdD90ytIXphji2AuCDES0CUIfwauy1pfoaBMJynBsobVWfaVAmsxUXZtjVS2bkSc+3btJQori5jdmGrIlaBUohPpzhMTQAQ457Q9jjwvDXABvFNK4eWk2+ZmNol0W0WWP9rDIwSvIa5tOmCZQMDF1DwE8glAU9+AyTGMppDMmhaIu5KhdbvjSnHOaNgsEBnD/uJ9CKAxgknyhEYeYtlkVrH+DZaG5hSzmnNFLpDKol9I0wMpiBGiNs9GnrU8aa2XSE5tKQeFQ6LstY+aRK6e7IMGMSJOQznugnxB3AUKmqJFp241rY4NPZHqNH1kjNZDMS3ESxabIdlZkrDXzmSxF469hdx+46dp8Yu4s3T+05kTz0aSxDnwtlz9pg8VyCPhF5DzQh6SCD6Y0hK3h4x0Kknz6e2/M92CGZBuYL4iNTypeY72f2MNeHCD8yYxVsgQxez7sSHzKR8HrE95xjUpRR1fbyau/DaCjBQVUJRISsGbFZmFALGyWK8CzXFeaFQqtXMRtzyI/p6aUwO8BUzU4wrZHkGkmuq9G6Gn0d1WiNJNexu47df2fsPogkM64oWixO0slkwqOZ8TR7n54WMBjA0hPLLAs5syu7gFaQGMswllNEDs6w2Rg2/I4rWh5veTvbXb/p7jR5u9PoNIatZsfJ1/rLeRxnQVaMqZy9jR1Jxfi8HXBcosC5dByGXnH7j84X+ZjW6ElkiptB5zWzD2mxY6vk+UkYg2xAGLBjtGJ78eL00Dyvtg86I3vSBGG2UZ154oKQEn3YHL5fQ8c1dFyXn3X5+WrKzxo6rmN3Hbv/zth9FnRsPQYdW8+Aji2GEMtHiPV3QkdPegTNfDAKyOAmoF6FsHEKoqQHHbKwj3k0EnEG9AoostktOV0YhuyIq1kKlnRhJ1LN1YXpLaRj0bPc2RUFHJk3/yBrSUC36FX48hRgUnyZKpATSXGMAgHdaFbt+/gigomZ1N+yVaRygwQ4pKSAx1Rw3Rsu4/RoC1CgfdARJOovuMdprfWn9oPZKUp8iBKzg1tXCIz5bP+3XXZKAM8TRJguzoytVxwXMHvmXEEbIW6nJn1lEHQN1ddQfV3u1+X+6yj3a6i+jt117P47Y/cZUN2iodVQHQY8GarD2FqdZVjqPR3d/qsRe9+8+kgckHuz0CWs7s0xOChBC7go8VgxLHIBEH/PuHI/iccYmdJTPfuOVhXf0apy/HpJD1/pwly0eDd3XtqM+YQnVycC/NV+tQQTFX5/pOdsrZqpt+6kd+8gc4hCjQKSKIA54zie6t7W1h34BfjDfY1PZS19X12FNzU3nGxdb5dkOfPSEnoo5EnPvpfUPxnYtqZG1owkHe+naKAFjG3TbwVk75E8SD99y20GHQ8zZCp42Nk6L12mN3XVLP1GBjnrkowg20UU3D8mz8/bD8lhiKyQo0x9D64F4xlwuSCeYw4op750hhDfrL7kUfOyhQ8XmkuLHeOwJnsneISv1tJ5m42fPp5vshECW0osiUZMLSR2IhCaJ+AilDj76dkTnES1LH3FQrB+4XQPBirzAxCYXakzIdjlwCrhA1SUUygBpFKcJCjr4KxPG6llPHEtAiy2tbkm0fEgHLZAQ1u8MG+TCit1IFKZ1xbwVQD8SoV5iRFdnsZYEamhZJfTVC6ek+ulTPwnpVY11KpETW8ucGFUe+ma0+IuZAskwQNN2nrx4oZeNUcP2zW4glQXeUBNWD6KZ7Lc1Gov5qNAr4r0inxcqY/0il5xGjP5i2kouoHHBswdh6EW3zOGroNhcDlKIIpezBa9F1iliKg26zmWqmbJqqwCBiX+DiEwlHEmPkQMQBAoNLsxFJK/kmUh5n+l12t+LchMly/xo1Qw0gtd/WKeccEqLlg1OUBb/k0lRMeC2EYZKA8YB9ib258ygWU0l/MMrdKsTuS3aA6WBhdYNe+pTnvmR2+e4OxfjG7g6GwMpGCE8NkpNXr73tDCclhQVrr5sKjBZX6DEKrwgt4Mv9kjVKzM/zR5UeL+fI8GPxXwpbP0ikzyz8m7f1PGW2earzHTWFCN7kbL2u4j7+QGrS3vGGr6wBf8F+5SpBJ6h95o/km7PBn8NgL6tPli4FgK2muYCk6vl1XQr8IJxSHAXQx+/GAJEhrRZ8zwswAcukP6UkyNfRT0pn0SYSOHZ3yB6m+h7ejOQMsnaCS2nxoOANRkkij8RhQwkUwYB/d4xLqe1G5ikhD0dUqkkoUE47JZaUSi26Aq6JVJEU30sW9ffMsZ8ZG1wIba7kiDItEi9qsLc0FOhXnHFMcV4fdjtMFzqmMRTLGVhAwKYErkVjganC9RBGLKPgYJo9GWnaS3cCwQsV8+gAnbNWgg8dI01DH0vTm69FHKhz7pt/A5t2w3/p/2OUtbYLAz2Jri3hnKm5hOxTSIl87KBhHm96SHL4uOQUM49O4Od1qwXbrHy78nAtv4y0/zboi6SPsCt5e9Sb1SXRunVohN9pxPY5aKlW4cqtl8z8Bx0hd4QRD68ofZCyI2zQ2zW5SbsvQ8pdBc/3CALsdXFHD7B6gEUtT/ATnZtpY= +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

+ +ServiceDeskIntegrationDto with the given ID + +
Schema
    ownerRef object
    + +Owner's identity. + +
    clusterRef object
    + +Source cluster. + +
    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. + +
  • Array [
  • ]
    • planInitializerScript objectnullable
    + +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"}}>
    attributes objectrequired
    + +Service Desk integration's attributes. Validation constraints enforced by the implementation. + +
    beforeProvisioningRule object
    + +Before Provisioning Rule. + +
\\\\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\": \"RULE\",\n \"id\": \"048eb3d55c5a4758bd07dccb87741c78\",\n \"name\": \"Before Provisioning Airtable Rule\"\n }\n}"} language={"json"}>
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-service-desk-integrations.api.mdx b/docs/api/v3/get-service-desk-integrations.api.mdx new file mode 100644 index 000000000..b93e663c3 --- /dev/null +++ b/docs/api/v3/get-service-desk-integrations.api.mdx @@ -0,0 +1,123 @@ +--- +id: get-service-desk-integrations +sidebar_label: List existing Service Desk Integrations +hide_title: true +hide_table_of_contents: true +api: eJztPPlz2zbW/wqW+0MSjSRLsmRb3rQd1XZ23XFir49m97MzU4gEJTQUyRKkbdWj/33fewBPUfLRfN2mq06nlUHg4d0Hrgcr5hNl7V9bFyK6lbZgh0J9Zsd+LCYRj2XgW5+aliOUHcmQ/ty3/i5ixpknVcwCl5lxOKww6jAOmBtETNxDN+lP2Crwqs3YiMXBZ+GzOxlP2Wk0YSNnJn0Gw0ujdCtP4mkQyXjOpGKR+CWRkXAAAOO2LZRi8RTahe+EgfTjttW0glDoqY4dQH4i4nqMFXQNecRnIhYRcuTBkkjtL4mI5vDNhy/wZ+C6SsRWlSen1MxgygAwEMxNPA+wU4kXM/jQZlcq4Z43ZyoUtnQloEzUNjw5k3ED8Q/5RPo8FjA+CpLJlOBoEKp9418Iwa5/3Gajs2N2EXPf4ZHDDgLPEzbiwM4y3D+9nsZxqPa3thxxKzykv6249DRH7GC2JR1/i4dySxk4LTuD08p58IYkOAsiAXTBzxnxCVmast3ad7mnRNMS93wWesCfTtNS9lTMuLX/YMXzEFkmkckignEaiG7a7kEDCFTOkhmNc4TLgVb4vVg065lPzFri/Xt+z/xkNhYR6qPhGHI0EnES+V8N73qD38C9Gb/XvwlKxkv4i7hpGKiCiLS7WWbvEk4qniNGNKWFKIZe4EBDHCWiBkcVR2Dj1qIqmQuYLhNIotAPoFKnrGNq7scgPD1oDDYB9v37yumvyBHAq2WwfHPjg7roNnQwKglD5JlD8iTLBjDBHX4GK/Yctc8aDeRuo2EVZKkZXuC8K73/R84XlANon/GWEkgj4L0slHeEyR9cLJpdVcG8S1ufJhoGUzDt/oNI7SOERkM6jQbITPzSBLIauk3Lj1pNC7J3uZ/tJQoQKH5YEjoTv7Ab64dg6rPDQNxY1ipnZgeJv+zMjl3WQFk3mIwhREAUCYMw8XRcEKzxr9ZlEHOvdYCjGyjFEGKXYFPBHZAqBRXsWOMQpxwgBonnsLEwvhFl62ZBCNnV0AGuwe4E+q6JDy7MaZNVSN8WFHGFDukcfCygwogQZnOfTfmtgGbgOKkj9pezkNtxE6mheI3qCdEZJvaDGJ20Ejhrg4B8Q5Q3ECfC9pZ7idBcwN6AdqJSbL4Kl77CasdB4AnuWwVHTSMXi08ITYtU4YBep4P/K+vIyWOpFwC2A2gB/YLBPAw9adO3rZ8VQnhYRolHEUfllLGY0cyQrZy6lAaZHsH4Z+DJksKWUjSZo/FKpbmOXcOoa20FZWBNPVXT4jG4tXESAw+AIWGEMoul5oh06txfGacrX4KWMukABzDZijIXsQrbkhnv9Ib9Ae8Pd4Tb73e6e8Nx1+1si+2d3na/27X30KdqI65KZg0zcECbXaJpopeYgSchhSZU2yntBZJyfFblzuyDDjKWHQny9eviggM9WrFcYvq+hTjhV7J/7LGWU+yOK5ZOWMSy1+n1W51uq7t72d3b7w8g92gPh/3/QwRngUNJ7++HoceBv9m0y3j2Wt29ZTxL0z5DuIWO60U5YrcQBJiPcFbq4iKF8FQMGHbXAa6Vgv0Q3F0cHr8vt9z4NdhlPsgqD63TwfQToBjc+SI6F+5znMUpjgF+acuM58issnmnhK838BTO4eUp0Y5whI/p77V1fHj04fL48t/oOnL8s1bA/CkupIopOz5sl9XIHnb3Ory/43KIvAL8xI477gtwF3avs7M9LDqJp03lSBV6fK49RZn5OtWxFqgZMqY2GoW+fvEJPYDOTJ4pjosgiUCdzOCXCqMMpVYmBydXF5dH52WRpI1PlEhlmnp57PV3+a5r247T6e5yPtgb7rhDt+/uuE+XR2Wi1WK5jDhUYJAJ/TgqiUYDONDjqyJatuqDjKJHwxR7HQlAxob0aTxnudCbmM8BMiYZHnP78x0mRJDdhDBwLD1Q4TfrXdP9/Ndf58PhkPgRQqamQ4pOYfzE8/g4TWnQo3OfT4SjSVU1rkoz8fhQPZMo0MBbqaAZ8DsIfFdO2ulc50IRVCBYNRnkBznVU8xWn0b6UqZTU8RWyc+4dJ3q2fbA6Q67fG+n0x04vb3+YDDu8952D9nXswc7hS6D3Z28y3Cvt22hOizTucxEjHuvlju+YsZM8+UkRRy26XNi2Iq5Mi0spQCKTFcFjmTeoWz9kJpAsFLce0/8r9Hci2z2u6kABCK9+lZGQ6oMEy3IkojTgkKrCTgupmUMf0fBjKgKokmbMSiMSBZQCRg4TlEfGAcF4Fj/QYGQk5Zn2pCxOKe+N09FWs68Kzl7ruDFOZYZAK2geD6ii6VMivljCg+aF2JJB2S9B88SAFqYC+Zrg1AAVbmPfCRU16nyMx2/W11irUXyhWEhjQNYqah8PmXmc9bNl8aNi9Or84OjctgwbU+MGuBUXzJ/NazUmfsYzJ0/Paz8IwGVaqEaoiPVVcBvQu0f52wERSqU3IdQVNlxEM3LYSgvD7W8dRzKfVmGsWGp5mhK8oBItgdDIhl+iXFn0IV/8iWM93NmNKlLyxzPBteDf+rA9TSqQLR/7MtYck/+KqIL4madmwTbgH85OBNjj7QhwHA8MDIDwPSoOtdXDnBVjddCWjfzeeIJvWhBTkiVnZz0QSkSvTJhT7k/EWp9MH773f3Mw1oBIXzzqtvuvGJAF9Qz/uSbV1eX71p7r7779uYmurnx3/7l8PTg8t9nRxqJs6vvT44P2M3NjZUvczixgw31rSkcGo6y+AZbjzQyBJTGIrb05XsB2irOCgQWoDD29jDn0be6Lyt21mjeTaU9TZmBSRZyXy/ZCV//JhlSDTdvv90qQs2m0vry7du/XB8cji5H1/qDnGG6zHJCtZjbjb+t/17E8gx0pz2yaV3qXMeo3za6fZpuRD0bTroc8jI8njtdFU/9X3RQr1mZJNxzK/65TxbXnoi43E+9fsPesIdUahDdXleG4pjT8PWbNvwJQe41W8aKsM1wax9qjWElyKwKVhHYx6G9Jy1jb/6WQlp8UWSP/N8B10VRXIx9+vTt2y1jH1D3LzA0+EEReiqdZb/2wQQncJ/ZWpxZQJ4KnxKx3GRp74DfomXDkJoJmNY0yhJ9AU6N1ESnbArK68KOJ7rTPPDVJnKPJW7hMgJH96E0aytLpH5Eggz6ofCdUk5KW8lIpdPUyMHkUG+oyhL7FLiszH6tphhjgk5G0Yt5GKTH2hPqhXBIkZV0BG5dC0QO/o+eD3JbL/Ax2+OuSyyjEIa1jPSqLFmzM5jxZLeYEJwtlxyL0mLrc5a88mFt9iOEV0enKkhYjHVxjKwDxExZh8yRiNMMBF6lJIvC3HEkfuPeWSH+VmqwhzQ4Qy5v0RYBjPws8r+Q5vFSjMKo85wceVXkemk+vDIS1i2YnF+dVNJeanli0rtyquqiSae/J8bbzmBgD3h/d7A3djq7jm2P93Z3+117d+/p2S2BX71UUofRSEYxuUWSTFFRlxMM7GJWUmiTpCbHrWyBLBbk8fp1GygHnkS3cxRFENRa7LywF1Y04nHg0CkT6d+igrdfsK2yorR2cN3CO6Cd3cc4+w4cTmsS6XUOQShDHmiqaHJXtCelQaI3QhKoX1kEwIl2l33PHZa65QNDDHI+4vZngHX89N2VdAiT+Q5szbRiV/DxTmfY67s7fc6hduruDsZDl29vd4aDIa2TzoRSUOMWV2PS0rZ69MgXkbTBSdqU0TsgKw6812eNcPKahZ0VMiAYT+A/LsLovhmZBl+oy+7jJuSo3x+csf4uA1c9SaidTypM8FtXF0tVBlCuAZ9GciL9OlRSf3B49G50dXIJLedH/7w6uoBfCGvpbNYI6x0H1TIwkemOMDYE4M6IEri3KZw2axioDSAI43GhozRhfa6AmcyEXBhhZq8ZUQSdr92kpkR2cx+z17It2k2Ihbg7w2OoAMYcF4ewyMXtbcgbRRi3TgwnG2Zf+02bjbLQoLeFFYynVROIGfqIgj53BaYsaBs8SGLcNQbvUJZFzspqzZc6lZOiUNA4APPH9QRqccgGSSdKVphpi0HRyAdw1pyrrCkXmEYsxbMYUDjadHrMDiKs9GntU8aKGXdExyHA8fhpv8xjFb0qubv3GhntIcGf8UQ9we4gD5V+i0jLPtwKY3wqW2R0SBqpmIxHMifiaLDplYkrNXx9YGNjuxvb3djuE223+vHcHBtJcx9MfbrLqc+Vbw7QYvBcSn0i0h6oQtJOOqnXgmziiVyTIv3w8dIc2sUSSVcwXzA/0qF8CflRJg9zNi09upaG/lwWiOBtXpa44ImEs0945xjrJJFYtb0827sgGktQUL8mRQSvGbF5kFANGyU+JbRcNZkTCOW/is1RKHMkOchOJbeyY8mbTHKTSW6i0SYa/Tmi0SaT3Njuxna/Tttdm0lmWJG1mDxJJbMZj+Za08x32i5g0CE/k56ZnF6WrWQrCIxlOZZVzhysca877rq7tug7vO/sbA/dnr3T44Pd7m533O/tWsVYf53bcWZkZZsqyFvLkViMG+6QxyU+KJeKg8ApL//RASMX3RptRaZ5M/C8rRciTe7Yr9lACWKgDQBD7hitWF68Oj/RG9ZmpzMyR00wzdas01sumFLS+Xe6TLdJHTep4yb8bMLPnyb8bFLHje1ubPfrtN1npY79x1LH/jNSxz7DFMvFFOu/mTo6Ul9kdEEoQIOdAHt9TBtDICU96ZCZfcyjiYizRK+URfaGNccLg4C95/48TZZUaSXSz9mF7i2gc9HzwuEVHzCagIv08UamhOwWtQpvT0FOirep6Non2jESBHCjeWvk4k0Ec5nU6Fs2i/RtLwEMySngORWc947LOD3bAhBoHXQCjvoLrnEaaf2m9WB2jhSfIMXs6N4WAm0+W/8d1J0SwAMFEbqLCy3rFccF9Jo596GMEPehdl9ZCrpJ1Tep+ibcb8L9nyPcb1L1je1ubPfrtN1npOomG1qdqkOHJ6fq0LfdYVku9Y7Obv/eGftI330kDEi9WWBTru7kOTgwQQlolHiuGCa5ghT/QKvyKImnaJnS8ffNJa0WXtJqcXySbB/vdKEvqn4tHJjWfT7h0dWZAH01T5Gho+II29paNRKfDNLFhqY9iTzonj5p8gAqAaqwaPNQttO76n5wR++a3G7XODh9YQmVE1ykY+4k4SsqepI2CTKSdLSfDIEm0GJN3wnI7pCshZ/ecJtDscM0mCYedDZ6S810S9efp+9jkJ4u0Qi0XUXe4jF6zGswK+jQQFbQUce+tXNBfwZYVsiz9OHkVI0uMLvXsy8pUx6xcF+htzTZKXbrse8Fj/BaLR21ef3Dx8s3bII5LfkU/XSTkFiEgFWegYqQzxylx05wEIWx/EG5UelgD9oocz0gmJkndY4NEz5AMDkH708sxUGCHA6OevqDOrw0bsUDOvhChb7AiNpOfQyJ+pGh6zClixfoeikSf02htTS0FkHD56VKWGjWXtv6oLgNjgJBcE8Rt148uYbXKsDDSg1aEGoVB+SEwaN8HMtOpfZiPErwWgivjMeN/5Gu55WHMe26mJrSK1LHzJ4GgRLfMYaqg2ZwPUnAil6MFt0JbJFFtHqdAkotPWVLtiD9JPxOwDB8rUx8jOGfsp9AL8SQSf5EkgWb/4mu1vxUopmar/GRSejpBPYzXomq4IwTtnDClvYByuCvgyAqFtg20kB+QCvAQS5/8gQG0YLP07BqvTqB36IxGBpsQFXfUQ339R/7uYMzvxh9wN5ZH3DBmL1nB9To5r2GhZGwxKx03aHKwWV8vQACcIVvGt9s9xSD8h+NXqR4lC/P4DMBX9pLr/Akfxy/+1/yeBtP82f0NCafRnWjaU3hUVRyna0tLxYqetwL/gtfyVIpcYeyKH/bsAgG30VAndYvAE+loGWGUHC6WtZEvQpmZIeQ7qLx42MlCGhCT5jhkwAcCkN6JabNPgq6ZZ9EWMPh8V6A+nNgirkL4PIZCokdpoKDBGo2S3x8HwqQSGaMg3o8Il1HKjvRTghKOl+klAWUxmWjUotEtUFW0HVJEc3UqWsuvRWE+MhcIENlFqOBkSgR8+JCTsi58LJyo5x+PwYbNKc1FV6IVSR4UEimRGGG98eXSxABmG92QIJosmUGqS3sC0DMqwcwYLsNtSM2hYGKoeQtwKU3EB9/XbqqXw/5ivzX9o61iURYQmyFuL6GjEl0SaOLyGtrdREJZckUmIidHh5wHQYrqgU262dJsbQ0N7rzdyxXsu5/67nrWs7rC8fZc+Bm8UM/9/p0Rn5db1evYUT6NPcL+fA/91L0Glbmj3S/kJmbF56/8AvPa4SVv+v9QmFtHnz++h58XqMP6aveuTZ8yhciIcris1ZadBRy9SC9E1IYtXRWoLRw/PcjzKn4igrV/MCpFov/APkYA/w= +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Query Parameters

+ +List of ServiceDeskIntegrationDto + +
Schema
  • Array [
    • ownerRef object
    + +Owner's identity. + +
    clusterRef object
    + +Source cluster. + +
    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. + +
  • Array [
  • ]
    • planInitializerScript objectnullable
    + +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"}}>
    attributes objectrequired
    + +Service Desk integration's attributes. Validation constraints enforced by the implementation. + +
    beforeProvisioningRule object
    + +Before Provisioning Rule. + +
  • ]
\\\\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\": \"RULE\",\n \"id\": \"048eb3d55c5a4758bd07dccb87741c78\",\n \"name\": \"Before Provisioning Airtable Rule\"\n }\n }\n]"} language={"json"}>
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-sod-all-report-run-status.api.mdx b/docs/api/v3/get-sod-all-report-run-status.api.mdx new file mode 100644 index 000000000..ef00135db --- /dev/null +++ b/docs/api/v3/get-sod-all-report-run-status.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-sod-all-report-run-status +sidebar_label: Get multi-report run task status +hide_title: true +hide_table_of_contents: true +api: eJztW1tz2zYW/isY7kOTjClbF1/klx3FVrLuxLEryc2Dk2kgEpLQUAALkE60Hv/3/Q5AUqLlW72Z3TajF1smgXO/fAeCrwMrotzIbBEcXl4HF1aYI60y8S3r5dkMzwIZq0Or4/BK6oRnUqtDI3gcfLr5tBXoVBj37CQODoOpyIY67iXJQKTaZINcDTOe5TbYCjI+tURseHbMznUio0WA7bGwkZEpEcD20UxaJlScaqkyBmKWZTPBrKPBJtowziohmHE8/OMkYakjykyuGmBnhE21sgI8r4PWzg79qjPzkjE9cTzWyIIOy7j9cg/9iEykMiLL0xRv3Obt3y3Rvg5sNBNz7t4mydnEWTZbpAJ89fh3EWXBbd3JLgWLdVmEzZOM2KaGDJ5Jr5enWFG2mZFq+gzK7Hh0xogIsRAqn5OjBv3zs8Hot0F/ePFuRL4S3/g8TYhR/dXNFiLku4hxcuwEqPi0om7zYOegvRs3u01+sLfT3I1bB53d3XFn3Gq3OLFWfP4EG/wrn3MVUtjycSIYbSo9/zTDL4VaBjBrsl/LHcENZMlk5pfouEgAt/8405B0PQDqzvRR/gQ7VnHLH5J91ZXDi6Oj/nCIJx96g/cn79/iU38wOBvg96g/OD153xv1j90fp+e/lW/O+++PaW3N9eXDmxvK/lLhVW0HYiKMUJEg71Qbl/qtSFMoWg8nH01Be3/cHsPH4aTd7YSdvclByCMeh+PdVqvd3etO+N5BULo/OAVjyX7JhVkwLwxJCAE6d6X+USKRu6xvDHI7xIYsN0rETPqIMOKPXNiMjXW8YKhIUl3xRMZ/Ku0f9nUsMi6TIx0/IXTfSCXCqeGSJBRO5AgbGSheyRg72FwbwTzJMqjdunrcwhKNJnvNY+jr9TsqlKHINTz6AlonT0jkCyWxn5VbmIxdjbyHrdgXfLy30211JnsdzpG+zf3dMdzXbu90d7td4j4X1vLpak0LuDF8scb6rVDCyIglOoJH/g2DIKVheyeAY07hk4m5fdwHjsYT7D+CXn5tpWYhL6MmuYU0fH10zjr7LOFqmrvnfHrLCCq8oIBXeZJQAQoOM5MLaO4Jnxk5leouUcoMPu6/6fnkGPR/uegP8YlorXXQnkK0xhSWEBWxMNNfncSFAl+5ZVYkMIeIG+xVQfUVFOLKri6UReddWBgTsTXhVAfZq4L7HTtWSbOJ0fNaKkUeUbAXsiEaW2xMz+Y8i2ZszC02wIW0/FUvikSahe8KS75iM5RsYV42WC+OJSnJE4ZsBFHsX4AQ43FMqesJTHKkMoSR2UznGVM6k5Go+2Jpyro3ltXs3apTKDkg+eNx0ouyHMI5NVezsIqWQsTCP5DZW64u3WjFaM6kC5XxCFoARyxgRmNgYTaGbhLoqChH5C6LwqPKdVXFWu1KrtydemFcS8K7iOf2CXl3nqD8hE616sWVKJIPYaCLauS8UbqpqEh4SWq7zcWqyl1l4rOJFEm8yd1N7m5y94m5e/vloBh4ircO+jTXoc+F4pjqtHHNcw36GBc9SrNykUeU3pFbDAYpINLPH0ZI7C9C0XrxLZVGfE985Fv5mvC9yh/++ZjgR+Wsmi9IQGdHr8EElUjEh07upcTOUN5U7XVub7QZSwSougMiomoattA54zAZRkJFknC7xWItrPopYzOO+siREdb6Cugn29CNthskuUGSm2606UY/TjfaIMlN7m5y9++Zuw8iyUoqly0FTrL5fM7Nwkda8d4fSGIBK4/eWZVyzlW30QoRYxXGCurIIRi3muPmZD8SnZh34r12d9KK9lp8d7+53xx3WvvBaq+/XOZxlWT1nFrxt/ejMzFA3BVwXK4QXDbTOq4f/+V0ADyhskalp8LNsDlM+qnCjq3uOnYcac1OuVqUCMnWMKRa2ohqGtbOaa0p12IBZ1PURcVQqiTkolCScwEqBkHDEjmXLnlJC9A1i7A3yaCKT5QyyCouUkVJDgldJUg0oWaNwJJQUkwI84GCQ7BTVOfviE4LF/1XSJ4NSON3pDHrf4uEoESvkPvuXee7JxDeUI0Yegffc9Drpx2uEAAYCHzNqnDnBp9v8Pmmx296/I/R4zf4fJO7m9z9e+bun8DnBRq6H59jwZPxOdY2dliFpd5QcP3PYbpLlUICF95MR1Fu3HFzicEdrkAoFTeQqIZwurkUbNduLYX+YgRee9zvJcpNgpWzLEvt4fb2NRwFB900eCobqF/wVbZQ+msj0vPtq/YdZYfuB/gUQ+GK88gdN/fOT4rhouHMayRFsC93joE3tlOIYhVGdwfDD9IvL60sdI4C58hs0a2dIprcY4iZYpT4ybrVDRc9azpCtwuT3Dymz6/th/TwRO7R4y7zPcgL6xmkvKVeccukvJ82JMztua/dUlv2EZrTWmvMzmhZi70W3GAg8F9dvPj5w+glmxLSdJmeWwK5QtJogFw5R4i4StYrj/Fpk2suRufTmRO8V/uihDKHTRIozD6qoRDs8qQwwnuU+AFqsjMpbRKuDNCuTy9Kz8TiSiTU/RpLS1LgyVhtw0LbvLbvpet0biSQCh/n7mnjowrZsaQCJKlj05pCRTfhscu01Iuv6PVcIf5RUgs9tdBRsy9vSeFNexn5izcR0pdI8MQ6az2buacXrtCj+QlPiOptGcgShRz1r7ei0mvPlqNGLyR6dTk+qg8ziTZa38Z81WIWXTCJ2QmLZlpb8U/GKHQoDS6nObLo2WJ9Jaahy4iwtbMiUuhZhjIEKHTyvUNiKB9MfExN2WESDbimYp+Sn51nkfOfMTLH7HNNZ/f4Er2TVsY6ss+WmRiGxDD0NcAW8vvWRIGF3CYdXB3wAXC09L+rBIWgKzXP07qzqjvy224PtYYIovr7eOmh/+NwWeCKT8y9oNXVGpRgwtTVF350Y7SgRf2pZqzyNOC2BdflTTTa4i27eXmr0yhqlX81fUnj3vLQ5Ewli+9dpe+pJH+duvt/qnibSvMjVpoC5VK4ObbFOLAa5B6trR/h0RnzTOAn3rpMdXAaw4obvxyGWSWTAitTTLucjmZSuOE/FTwj5LdFcaXnLg8Bdyn5MeI5QlODNUhaCzTKxzIBvQb7gOlKRTAxTVZ0XQJUf9fFiDWElc/dTf/j0nEAUPN5rrCXciyfM47weMS7sbRR7osQBi0lSs20g3HVrjIjKWzIFA03Y5i5PZvQKTEG0BUnPsILPrTFETEMSR4priEvFRkIP3TQujr8fow2IieciSSl2Q4VFGBKrHA4PRmtUQQxZaEXZmhtptvFJrtNa0GERh0fDO0GJjp6lGqbYRBdoftWYNSnS9Th7f9/sOV/cNQC63p5QP49/22jaA+E67dTOooiaXM/Z/ih7jK4c6jDmDCDUvT++ppOK2jCuaHHf9ClcDz/tBxg6C/Q9acWbgr8Ity07M41lgPx+sk/jSPVrPm2T77g93S24gOxurn5D+55+Uc= +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get multi-report run task status

+ + + + + +This endpoint gets the status for a violation report for all policy run. + +## Request + +
+ +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-sod-policy-schedule.api.mdx b/docs/api/v3/get-sod-policy-schedule.api.mdx new file mode 100644 index 000000000..1c3660ac0 --- /dev/null +++ b/docs/api/v3/get-sod-policy-schedule.api.mdx @@ -0,0 +1,105 @@ +--- +id: get-sod-policy-schedule +sidebar_label: Get SOD policy schedule +hide_title: true +hide_table_of_contents: true +api: eJztXNty20YS/ZUp7IMvJVC86fqyxUhywqwseSVqXbGkWg2BIYkYxCAYQDKj0r/v6R4ABEjKUmxnN8nSZZsEMNPT19PdA4D3jlFelgTpzNm/vHcujEoOdJSqT2kvSyc45wR+tG+078Y6DLzZfqKk71w/XG84OlaJTAMd9X1n3xmr9Fz773jQuTdRfhYqZ8NJ5dgQlfPTQ2EvOpjqK+MlQUyTMXUwCYxQkR/rIEoFCBkhhYmVF4wC5Quaahd/YYTJSTdAO5aJnKpUJYZ5D4hWLMH1hhPhAo4CH99pylQ6+/dOOovprEmTIBo7DxtOon7JgkSB/zTJ1DJfSvQPhR6JFN/mbJRMiFSLRIGaumWG1Cc5jUNaQo06u6O9bsft7qg9t7u13XaHW8Ohu9ttd+XWdmdvx991SImJMrGOjDLEX7vZpI86FyvWpbU8slKU0ngZx7jMptj82dCk+2Wh9fBn5aWktYQMlwZ2SauoRdUsamJuvbnsPLMq8/nBD25ra7fbabXbu51ma4s07MFfUlLw8hIjnUwlBHB8jHDTgMktW4AuiLuJimAF+MkqM+B0vk7dCu1mu+k2W/g7aDb3+W+jyX8+OKR66Z9G4cwaH7xOtc8e97szWyz0VdzWFv8SA1ZH1OxYDIDMBfefZr+SNYu5q/xqWRlzkSOrPlxqLHmgpbPo9UdRNkVsxYgPeDlE4hgEUiU4DCFFFsc6gcUrwQhCpnEVXUU93w+IjgzFrQwzBY3LmRgqIX0fM4KIiY2yNEtgrSCd6CwVkU4DT2E+odaCMhW4IRQ77PWPf8Lx+6Ojf/CXt6cngx/420Hv+OjksHeGr72Tk4veMc5eV9VazkmDtKbnAS3G7helE1aJDMPTEWPa54P3q1WnQpCFleeqO+6fD4TLM15b3b0WMkmgPgIcGURG6EgJzJlqKM8PDFbw0lzPTOKsd/L90RM00judT9nncSaVSSpk5FMeKBA3kdFYbcBcXpiZ4Fb9vrYlyXHI3Nctl18p7ZZrrbCbZWPZDhwCPBZ8lfqZc8AqwWGQqqlZmZ5KFi7J0djvDpF7MQXYn4AkI3gWhnJIox7LYSUTxTSObGumwgXqrNHAsUqquIdTnXYVJzoPtQR6aeeW6rheVhhEWqUj6/eUS9Un1CKpsh6hZOJNGoKLAw3gE5zmFA8sYt6whVEt0NrkNjdF7N1YeUpuS+3mxiyMdul0cLSNf3v412qzeusqfaBTvpytQ3Mdmv9noUle/0hgksH7CDgifUNFzY1NcDcbPCp3gLsgDMkDbqAkXLkZXBzRB5TFRz9c0Mebsz59nPcG+CBHuzm/OLlZsUKebW/Ix+eRvnJBKeA7Q5WQ1/k6gxHEL5lOldkQYfARDF05rSuHlsWXJn8joldOexcHDSFOY+vK4axCnwYc47rwZESrZAam4yZghKXwhUaG0qSkuSJWGN+eDUdzb9pwoJjH8Aixk6wBaQ1I/2eAxG5fMtlYGVLWKtWY4tS+S8vMlQGWrlltcWB3MVY1UYv6WtkFVju41q7b3HbbW4N2c7/d3m/vNlrN7oel7qgnSgLkhf3zU3d3u9kSOf25Og4xbEDLPNC5qfqAgOr7q/0HmKSjwIPJBh9E4FM8o8lMbMwUTRLjY5JFtOxL9akhelOVYNLmibr79086+fgK2AfUjTT3sr9SAAN6y90YC4Y6Gb8waCBHMgvT2kBCxMYKzS1FUqm0goGDCf4fa+cRV7GAd73cPtl9HC+IA0hcjY3HYuaRjrXSq5fkHu9Wn263F2mJw8Epg2ejAiT9w6OTQX+w0CqWZyl8V25HPL0c7GN9IJ2J/uHCToO309ptyu72SEpfqW6ztT0adhW812s3t7ttWvf5G0MrVgbUxyGglojUl34beBOpQpF/GjZ3aVLtnxVU+IKayiA8msbp7EwZuFrVjEOtQyWjJZb6kU+bYQD7YCQUzQVrPFlEyqZrZACmrPwqbyMZGsZE9ur8uNjC0kn/GYZ4V2xT5nOg+Zr0zVGrNWrL7o631+0ORx3ZHvo73fbWbnOkOkNffWZX6retX0z6egbq5lnY3314oOvdVduWByE7/VGSQA2uOFNIshHllTxfI8IV6qSh9meEG0EEVA78b7iz6SuUD+GB9p/hxm+CSLnjBOUGOFTMsoeJAhRvA5/KIlvBMMmi5OBxde+GJhot8Z30Ia+V7yAXhtSYSO8jaD3HkBdRgPmimIJQ5jz8yLJqR8nhdnOv3R1td6Vs73ZbO1vDvZHsdJp7W3t7vLukjJFjtQog60t/ryICZBFqpJLgVygEHgHdMwO8+OcwtW4DpvEM/VP6smNLMXN+Bd2KQFcgvjt4J7o7KK6jccbn5XhBCZF7cb6UeSC5JXyaBONgZZIvN/eO3vQujrmuO/rnxRHVcURr6XZFj5InYwxYhS9M9J2t+60Ad7JSoIjXOdXXEEhSMTsfGNgjMzNQZpFMMSNffcWMKmkxSvS0FkqevW8jXgYN1dgAyOEcqglvIoaS+hRty93XPc9Tceoe55p8LSaIeJUg8X9NvVyzxVyVS3VAjiXHVaNQcIDzp/2k56UZmGMxq1FYekvOYm4f8Gw1V+duUFEaq3SGTsNLqXQKqe9A84MuZQjZAiSNHI64CgLwRMW4ErGqEMlw99Yyc5jaYsaTmXlG3L0LAT8ui1ZeuFV58HEXbtGIrVGYKUekvPPkyfmo0lxF4Avkg9Bfx+46dtex+8zYXbx4lt+sza9y6dNaLn0uIplBvwknz6XSJ2HvQX9VDOLyJjck70LlJdKP7wcI7I8qovHcp6pvWR/ZVL7EfK+0hz0/LDaFitQ/twUxyHq0Eoy4ot5nvuccs6KsqjrLq73RyTCAg0YrSkSgZiJmOhMSKkPLGhEn0mwIXysTvUjFRAIfJSLCGIuA9jECl58jWFeS60pynY3W2eivk43WleQ6dtex++eM3c9WkiVXHC15nWSy6VQmM+tp+XWSVgoMEMVjg6IMOTbVYrVCxERZYzn1ysEZtlvD1mjHU11fdv3tzt6o7W235dZOa6c17LZ3nGquv5zHcRlk9Ziq2NvaMb+hlNyijssiOJdJtfbr239Qb6JGBGsEPWXdDJ1Dpddl7djeW3HPQ2vxVkazokIytRoymuuIMA1jpzQ2KcZigBRj4GIkAFWBtncS6YaMKxI4jQiDacDBS1KAbjJze6MUothAKZysXIVvPYJDRoJQU9Ws4VgBhFQjqvlAgSvYMdD5G1anuYm+qpIXZyTxMUksjj55SlGgl5X71qr93T7dSSOMOLcGfmSj13Y7MoIDoCGwmFXWnev6fF2fr3P8Osf/NXL8uj5fx+46dv+csfsb6vO8Gnq8PseAZ9fnW/SOhyhrqTf85MF/u0znUMk5sE/0aI8fAfTnNTjXFXCl/FUvwhB602rf2SzfDQOabN4H/sOmmb/+Zat/y1eWhBg/SdPY7G9u3sNcMNNDQ8ZBo3hSJdJ3DU9PN287K8CHnhKwgQb48jOPN5177/p5i9FgJScB+bEFPV7Aqjx/pMMxUD1vD3+WPj22Qrac6Qwwx2Q26NGd3Kf4NNiM0VC8MPlDLqSiJRkh20USPjwlz786n5PDEnlEjlXq++xaGC/A5YJ4xP71RvkuID3gMbWrL70ROM8m1K21lxY7pWFt8Z2SCT8TSzcwXv74fvBKjKne5HjPDJW6KqAGARHzDi7CeNYrNvNpEqeYRGfjCTPeq90uofgRoxACi6voXClx2c+VcAKgPwMys0ppkmIwoFnXLwvL+OpWhZQDG3NNkuMFfrQJDW3K2rxXnO+4Mai+ynQVueIwIBgKKG/TmFxE7vPEZVzIJStyfSkTfyuouZaay9TMqwUurGovPfv4jYcgJhIyNKytL17c0nMr9KiLwhmiusgDaSLno36Tyyus9sV81Oi5RK/Ox1X0fhIgmdanCYtdwiAXhr7oC2+itVF/F4Jch8Lgcpwhir6YrTta1OWIcNvNCkuuXdINXJSGzN8xAiOyziSHlJq5MtEo2iLfhuQNWxYxf2Ofhq/JzKcvkUFppK8988U804IuLehaDDA5/zZBkWMhtkkGxgHrAAdz+zMS5IxWMM/SWonqTH6T51Bq8MAqUzHxvj3YnwNc8WwpX6DR5RhAMFXW5W0/HIucFmWpmrKKPYFFDS7zG2okxwW9WX7LPSlKmH80eUni3nzrhJ7b+9Yo/QiS/HFw93+EeGuk+SsiTV7rkrvxsnlTUHVyW60tb+QZfj8K/+MqRyoX1WhZ7EuKVMNUycShTMmnOaa9Cf2GAL2Jo2RKld8G+ZWechyi3KXgL952HPOr7gkYlmjaghD0GuI9eqzIg4qpv6KHJkD1Z503WufQ8jv+cYXDwnAooKbTLKKnw8FENhUS7vGEdf3AeJkFIbRbkSok01zGlbOKiCS3IVU0uNNIpuZ0RHvFaEMrRnxiLdjQ5BvFUCS/wmJ/2WEuyJkK2ctoXL38foo2PMedqDCmDg8IimJKVVZ42x8sUQSxyEAudNI6GW/mk8wmjaW3eyC8dYZOA30dnYq1SdGOVuh+r9JVvwuw6E/3893xL/6BjDwFUO2+GdOmE3GU2V7Ctm+XTrV9w5T98iczmKlrevHCpDTw/p42KKideaDTaMyp+728nncr3OVBufTdrzxP/4hUL8/ytzxe8S2W3/RLGyslKzbdotm833bw9aOiNh2C2TfneB+FebUX7E5LZcrSvQhqjcru9/sj8gv5SJbNv0AvwJH/AIWnC5M= +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get SOD policy schedule

+ + + + + +This endpoint gets a specified SOD policy's schedule. + +## Request + +

Path Parameters

+ +SOD policy schedule. + +
Schema
    schedule object
    + +The schedule information. + +
    months object
    + +The months to execute the search. This only applies to schedules with a type of `ANNUALLY`. + + +
    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` or `ANNUALLY`, 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[]
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-sod-policy.api.mdx b/docs/api/v3/get-sod-policy.api.mdx new file mode 100644 index 000000000..5a37b85b9 --- /dev/null +++ b/docs/api/v3/get-sod-policy.api.mdx @@ -0,0 +1,120 @@ +--- +id: get-sod-policy +sidebar_label: Get SOD policy by ID +hide_title: true +hide_table_of_contents: true +api: eJztXOtz2zYS/1cwvA+JO6as9+vLnSI7rjqOncpyc62TaSESlJBSgMqHY9Wj//12AfClhyXHaXvJ6KbXyiSw2F3s47dLgg9WyJw44NHC6t4+WDchC/pSROw+6sXRFK5Z3BXdULr2XPrcWXQDRl3rw/LDsSXnLKARl2LgWl1rwqJr6b5Vg6xjK6KTEGdfX50ScxGmuCx0Aj7HSTBlNOUhgXkhCefM4R5nLsHxeqXSezFkf8Q8YCEJpM+I9MjV8PzX3umbwWUJlpjTgM5YxIJQsc6R5JwC08eWgBvwF3fhd+hM2Yxa3QcrWszxahgFXEys5bEVaPrAfhTEbJ09RganuGwEvzJBSCRJwIAIu2PIB7uns7mPlJlXa3udes2ut1jHrjeaVXvcGI/tdr1ap41mrdNy2xaqDmSaSxGyENmqlsv4n+LimR6AB1zFwV0REY6k8zncUKo/+Rji8Id1KeX4I3MiVFOAGxVxvRioZE0Tq4IbMZX2MuHKXqXiVWndbjmdul0fezWbVseu3apXG+2yx2pjl1koGnWvhL/QOl0me7Hnmq/ikAsWhuQSZ+WX18qw7xd/4s45sEzENsriyWBGQU+WCyPsiCs66zuLN8inKROwu2CGOX3DX4Z8cXer5WrZLlfgn1G53FX/lMrqf79sknsmXWXSfxWPCf1nMVlYc9ceXakf1Ce5y3n3mCfOn7GjXNzwzEQYozM7Em5yKhzl0rihYCSx79MxTjGMyU+CBUPmbbLoFa5w5IsQzBXcA+JYac3m9fyd0hk6p6MrgiOVXkU8wyg2OD27HA1GP2MMy4RLrwK/+/jVKqfGs3Ob53Qq7TKtNz1KXcbq5UrTG9dZudJ2qmUIH9be7pQs5fJw7tMFwVnFta7j+VwGkbUEmsCMuqZmnUYS14EMwALYbO2YsBMsYLBlT7CSM0MhCZsZjTwf//35l8xw1sxA3/kxZsFi98rXjAbOlPyBo3fY5X+o40CYecnd7h5xbXJEepen5GmTvCMVqMDYwfAhWIsJJlbIZOETdJifThwz/+UbHvGJvpbQPCqI9z29Y4SSGRV0wgLIVnecfVL6iAIK5Bzlui4k3RB+hATiEd7lAXlvyThC5WVe+t4iDH7LBWObtsiRQcAUwZ57x59kIdlUQvXcvBCvaAiAQArFd4IA8HfCzXEiIACIqYx9FwSdSZRc7ROMpRFGSiEjkqT6nKgf5Zh4sVDrlzZJFkYQnXeLAwEaCCqqufDMBKzkoAABMpALJmeXr6+G/bNTuHR5Nfo1/bMQW9KrywRLpWzQIKCLNS5wkBEuC7lpyEwJ31qj3nkFrsB/qrgkj9hsg0UukyQrg8HekOGFyZzAxeD0i4AHk+SexkMy6TOZKNrBBqbuuPQV+lLxsheGfCJmENLBFz0+QUZXSTyOyWhKYRj7Gw0uMZ03vcve+dkQrlyPeqNB3zrGldaA9SmLKPdDQsfozGiXKcshUZkVwLWhRew0H6HqtEO9F5o+3DwHh4Iojtn6PJDxHO15YCYUtJvx9mgyp75/5SnAfkjrf39aXzXN5Yf8wJ8eN+ylLqZcMNK8WsYSYjMVa8y6zEMsT5L4SJOoNKUhGTNAtSm1XJBMJEkqMo/GPiBlj/ohmtJ+m762JIREDQvGOqkEmEw9uKWSqMkX6p6VW9Q6P7s8G/YuciaTXelfXb6+GPRHg0uoSfv9s+vrX1/1rlfjeDJeJcp0xZ5asA9lNws4fdwtikbvMy/Kz3t89H5WlRZdODxJkIlSgGuYFjsR8XlY2CEIzoItbKi7Va7QPF3goF25CgcpjGEmlQhUOwHDXQLQwlVRUSFUuBCP7vGPRpmoPEW4RgPICto9jB3o/FWBP+i9+aNRXs9rWzS0zZ6yZA2h4OLsDfx3QwMDJiWgRJNVzYFPUw4wVOXhIMG8RBXt4A3ghsU8n9HfM95kPQkt01OX1OGo3Wi2nUa14zQhHLUdhza9Ttmp1Cq1/cPR9zHkCxvzI0aUQlR6Hos9F3YW9jhALAGxbJlHMClXed1p1SWyNZuVZnPcGJdBtkqz5dSqzKtVaLOZ9YZWljh+BtXWVqqF6Lri9Nh/4pPpwZsP3nzw5q/fm3O3+lsT/S4AlnXQMx0pw86RJJom0eWxGQ5D7qgfs6TFu3etowXNkbc1Rds0YNNG647OYtbt3DFwwyOAPfqDG9qBKUwvbut2R0ilVehWd5gfa3QVW1OFTlS+f7TLSMnVkOwe1lprMe2Y0N6PbufI2taE+iu7ROtNob+9nWO6N/l2S/JQygTAD4UWx74uk29J7Dtnd8dgtQeQK6e/qO2nJR7Je0Gxsiv0LLaWOTsKmtVCxayfooxVkPG8RPDMiA9ReAMaK7AMBv9FeW4/j+eOSke4cecM9jHtshcywWpXKPvrKVbVararXoe2lVXVOk65wdpehXre0yPqJcSXLRHVJAFdpXNMfOgM1HC7JYL1N7XHN4ef/oZes4kHHzYGi5xDqOZDMVjsoZt8oMCkvzsM6FFmN7JOwyN+pmeo3WpUnUrFHUMoqtWYXXdqFbtT71C71Ww6nQaD/3uVbMeM1ezI9g27Uh1VOt16q1trb0zzKyOWS22U9U3PtPsADkVEzoIAgrZNhiyKAwExnOs8gDGdQSkxlq5q2HABhszdL/jw21V90b5090DDr6GIsicB5cghUyw7MBErgzvuor3NJBQ5mmSaynBcsSEHmihVAKy5ZGjk6xthEPcF1PkdaO3T3r4RHOaTZArk/rS427AsazE6bpY71brXrFNabdcrrca449FardxpdFTPcQamBPl297MFZSzcIb50YEf+ZJiZKeheMaAWt/Yu0RSNPfSPz7/12FRMwy/Bt1OOAbi86r8l9RbxqZjE6jqdrChB2DfXmxrSmvAVRHy+8bl3Ui+enr3u3VxgTB6e/Xhzdj3a0nDvCbBWF80SWAVbmEqNo4wAnyhAGuaDOphbIt8Zqt+BQACz8gO5/itchKBMYvqQMMOsvmFGnjTxAjkruJKjX+UhL3mJlY7JGK/NaASV2ziPxr7DsDKP7Aujye/IFKpAFhyVSM91uXlap9IKPiJYACEIoi66ribgxeDKwAyPpggMAaFBgC3uRabKtYcjpvi5yG8KOgdwvttOek4UA3NKzLwXptZiWDT7AzxrzRW5G+WUplS6gNwDERdG+ovkOSUZg2w8CokJR7hdIQQekYxLI1a+plPh7o1mRjXhsb9C43APv3vrQ/ixlWjpjTtmnA/LbBON1G4k22QiEtxUSB4nm1HpdiWOTyCU++7Bdw++e/DdPX139ebQvMln7iroU1mHPjeCxqDfQCXPNeijm6VCkmSQrtD0Rh7j0yoDkX54NwLH/p0J9YbB/RxL4C+Ij3QqX2O+l+6Hvj5G+JFuVmEvkEGlRy2BB5GIuV3Fd8ZxDiXW1ld7LYMxBwMVGyAiRM2ALGRMKKgsiIVQT+/CY+JKFooXEZnSXL9A6v4kE/jyKhfRAUkekOQhGx2y0beTjQ5I8uC7B9/9On33USRZfPpncFIYz2ZUNUvB0sx9lJYSGECSMyXZS5+5PnCGVpAYSTGWVUQO1rhaGVe8lsPqLq27zVrHqzrNKm20Kq3KuF7FZ6NZrr/N/Dh1sqJP5fZb76NSMYC4O8BxsQDjCiMp3WL7L8bHOx6GNQw9KW4GnZdM01tjx/o6dryUEcgGhAE7BlvaizfDC/3IWpNHvck4wIeNQfp8G580IaRUz5rYvX5V4gAdD9DxkH4O6efbSD8H6Hjw3YPvfp2++yToWN8FHetPgI51ghDLQ4j1T0JHF3AHQjMPNgVkcGJQr0DYOAdRktcGUrePaDBhUQr0Ciiy2llHkSMpyRsqFglYCgudSJGpC8MbjJ3h2CAZCwMomUCIFASiFgd0i1aFJ3kBk4L9EJ/PuPJjFAjoBgu750UglfaZxN7SVbhw/Bg4VEHBl9h7lWBjHMyJeQj/gILqg04gUH/BHqfZrWf1g8kQJb5AicnZvcMY+nza/21sektgIMyx0Wu911teFzAvGAsoI9j9XIevFIIeoPoBqh/S/SHdfxvp/gDVD7578N2v03efANUNGtoO1WHA3lC9gYcuSIqlXqsDrX83YleuYjhQ5k2ko7C6m2FwhSvAlMw3pDCG4DecutZJ+tEpiCYnD9xdwj2N/zU7ceDDsGkUzcPuyckD7BLszrJE57yUHMUW8lPJkbOTu9qGmIOvmIbJaS831u8G994OTJFRUroNOJqvjnVqAa3p5IBwCBpX7xY8Sj85QrWA+oNoMsd4GN2YkrqMbzhDHfEiNIe6UTNrMoJsN4G/3CXPT7XH5NBEtsixSX2PrgXjCXC5Ih6yj69Vm2+LXSPg1quvfWEsSyLY6q+uLXaFw6rkFaMBfmRDvf3y8od3oyMyUe8wo5vjkccJYTzSh77fgomoMNZL3gTBSSqzBDKeTBXjvcK7Nug2xPNBYPJeXDNGbpOPHFxCfB9CQFYqxUlMxQCc9eFlsjMuu2M+pr5Spkk0PO6KE9DQCS3MO1JpTtUDXOhvQeGhlffCJqfcvKWuj9sYEVV5R27niVw0J9fnMvGvhJqtqdmKWni0woVW7a2j3912wHeRBPVDpa3PXlzTs3P0sHiCK0h1lQfUhOGj+IaUk+zaZ/NRoGcjvSIf78U7ddKxOI3okJWcUxoQZyplyP5NCJoOusHtJAYv+my21PFKW3mEXS3nWLL1kja3AREq/i7AMYQ2Jv29DwVIpO6NKJf8Te0s+Pxv6hTubwWZ1eVbPKULI13phJ/NMy5o44K2jgGh4V/nJTQs8G2UQcUBbQD9bP9VJDCM5mKeprUxqivyJ2oOpgYHWFVUwnlX/9HNApz5RdQNHJ2OgRCMgDp9Zwz+JoYWJqeCspJWwKoG1/n1JeTEFb1pftMHmpgn/9/kRYl7WccEP3vzpaP0lkjy/xN3/6GId4g032KkMRAXzU0ta2qBvJFrtLbev8MG85TBv+Gu8lSFpaFSUbWXwjB5MnOfRmjTyqedKX6dFBvijEaI/I7RruRM+SHAXXR+/DQPEpqoQ18BMEyhVuM+fmyJvIPSSjigYiyr8I1boPpRmvrqGrT8FjeJnCYbBwBqNosFfv4ImIhnhIJ57Nhdl4dOrIMQVFmCJZJJBePSWYlHotmgKkqqwAhm4ZWHLWJ9vG/PtWAPQ9MfBkXmDnlmggyZ+VIWjCvC7120wXLsKfPnWNhBBAUwxXIrvBmM1ihKPL2oH0rIYHJiJoUnOBY/NAbCa2OolaCcs9QHEcMIqtAc3XMW5b8MOl7oz56tfNkz7Yg/96u7Jg0gfj+ZY78JuYp1PaErt1srX7nBlC538az1VKozs9bDAzYksI5Z4uU/9AFQPIWZlCmqvAOt4u/s+OVWiV4ajt0j9Uhln2/2bpQi6a2JRVZWW/Dzd4bVOAihjgnrdoliUd/QDZXclLVHDlgKpUXu+RnaAd2SVc0PUAfEjf8BSlOjew== +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get SOD policy by ID

+ + + + + +This gets specified SOD policy. +Requires role of ORG_ADMIN. + +## Request + +

Path Parameters

+ +SOD policy ID. + +
Schema
    ownerRef object
    + +Owner's identity. + +
    violationOwnerAssignmentConfig objectnullable
    ownerRef object
    + +Owner's identity. + +
    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. + +
  • Array [
  • ]
    • 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. + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-sod-violation-report-run-status.api.mdx b/docs/api/v3/get-sod-violation-report-run-status.api.mdx new file mode 100644 index 000000000..503f9003c --- /dev/null +++ b/docs/api/v3/get-sod-violation-report-run-status.api.mdx @@ -0,0 +1,95 @@ +--- +id: get-sod-violation-report-run-status +sidebar_label: Get violation report run status +hide_title: true +hide_table_of_contents: true +api: eJztW99X2zgW/ld0vA/T9uCEhFAKL3tSSLvMaQsbYPpAe6aKrSSaOpJHsmkzHP73/a5kO3YChXa7OzM9fgHHlq7u7/tdWb4OrIhyI7NlcHB5HVxYYQ61ysTnbJhnc9wLZKwOrI7DK6kTnkmtDozgcfD+5v1WoFNh3L3jODgIZiI70/Ev5bixSLXJxrk6y3iW22AryPjMEsmzkyN2qhMZLQMQiYWNjExpCoicz6VloGRZNhfMuqlsqg3jrOKAGUeamVyxjNuPGMozNueW8YSYW7KJEIpJdaU/iriDlVNu+EJkwlgnpqSVUg4BtwKFB/jlSY6FzZMM0mwFNpqLBQ8OroNsmdIImxmpZsHNFsb+nksjIHNmcrEpgWDHR0xPnQQlq2IqjFCRYJnGD5ASV4I4E5/5Ik2Ifl88i5/1nm2H/cEkCgdxvxfu96Kn4R6fTuPJYG9nsh0HpHUjbKqVFZaY629v078mC17jJQt36o3Wj8jaKiMaPE1hEzey+5slQtc1LfAkOZk67RX60JPfRJQF6+KTcVNn3FsWdup1BjHkO5n0QniK65r+esrs6PyEERGnWZUvyNvGo9OT8fmv49HZxatzcriVypuPYFkZfxc2jo/WTBvtw7DPdnbj3n6PP3u63duN+88Gu7uTwaS/0+e0tPfD+xb/V77gKiQn55NEMJpUmvlhil8xtYpC1mNV1AY34CWTmR+i43EtLo4yDU43HaBpTB+zD9Bj5aT8S7zXTXl2cXg4OjvDnbfD8ZvjNy9xNRqPT8b4fz4avz5+MzwfHbkfr09/LZ+cjt4c0diG6cubNzcUUqXAdWnHZciSdaqJK/lq3BSCNt3Je9PDwrpKQ14J4eflH8QZFh7cFt+HiUTMspExSIwhG4ssN0rETJY55/dc2IxNNFIh0ikSIU9k/FXh/mUbxyLjMjnU8QNc9oVUIpwZLolD4ViOMJGB4pWMMYMttBHMkyyd2Y1r+is00emx5zyGvF6+w0IY8ljDo4+gdfyAAL5QEvNZOYXJ2BWYO5YVe4JPnm7v9wfTpwPOEba9vd3J/pTv7Gzv7+7v0+oLYS2f1XNZwI3hy42lXwoljIxYoiNY5A8oBKEM3TsG3OLkNplY2Ptt4Gg8QP9Uj/zYSsyCX0Z1fgvh9/zwlA32WMLVLHf3+WxNCSq8IEdXeZJQ4vGVD5J7widGzqS6jZUyco9GL4Y+KMajf1+MznBFtDbK/5DKdkxuCVbhC3P9yXFcCPAJNd6KBOpAXWdPCqpPIBBXtj5QFvhhaaFM+NaUU/5jT4rVb5lRJ82mRi8aoRR5UMQeyY7obAFf4N6CZ9GcTbjFBJiQhj8ZRpFIs/BVocknbI5ULczjDhvGsSQhecIQjSCK+QRUGI9jCl1PYJojlMGMzOY6z5jSmYzWcMJKlU1rrLLYq7pRKDjA+f1+MoyyHMw5MetRWHlLwWJhH/DsNdfk7rymNKfSpcp4BCmAH5ZQozHQMJtANgmMV6QjMpdF4lHluCpj1auRS3evPTOuFOFZxHP7gLg7TZB+Qida9eBKFMFnCZP5bOSsUZqpyEh4SGK7ycWoylxl4LOpFEncxm4bu23sPjB21x+Oi66meOqgT28T+lwojsZUG1c8N6CPcd6jNCsHeSTpDbnFoJACIv389hyB/ZG6RMvE55Taue+Ij3wp32B+WNnD358Q/KiM1bAFMej06CWYIhOJ+MDxveLYKcqramdztRfaTCQcVN0CEZE1DVvqnHGoDP2gIk643WKxFlb9RN008iNHRFjrMyCtquIw1VJlLZJskWRbjdpq9ONUoxZJtrHbxu7fM3a/iCQrrly0FDjJ5osFN0vvacVzvxGJAazcX2dVyDlTraMVIsYqjBU0kUMw6fcmveleJAYxH8RPd/an/ehpn+/u9fZ6k0F/L6jX+stVHFdB1oypmr29HZ2KAeKugONyBeeymdZxc/svd+8dKK1R6qlwM3QOlb5fYcfBJnZ8ozPIBsLAjuaO7cWL8Sv/XsOTJ73p3ESCYLZXnX8xQ5CSfBialjZroWMLHdvy05afH6b8tNCxjd02dv+esftV0HFwH3QcfAV0HDCCWFOCWH8mdIyBOwiaTWEUyBDlUK8i2JhCFFwVu49F2GfczERWAb0Giuzvb6LIc63Za66WJViyjZ1ItVIXpTeMXdBYU47FAM5mSJGKIWtJoFvyKrkQhEnhPyyRC+nimAQCXbMMh9MMUvmYKf2tWkWqKMnBoUsKiaa9Vw0fk3AnMSX4BwpuH3SGRP0d9zgLa/1X+8FsTBK/IonZ6HMkBMV8tf+7e9spgWMwbyhdnHlb33FcwO+Zc4U2QnxOffqqIGgL1Vuo3pb7ttz/GOW+hept7Lax+/eM3a+A6gUauhuqY8CDoTrGdrZZhaVekHP93xG7C5WCA+feTEcOq8crDO5wBVypOIpPOYROuB8EXTq+7w6WIpt0G2f5Q3/GNvRnWrvXzVPwN6Dh+wTPdm4SkJtnWWoPut1rWBNWvOnwVHaQ5GDQbKn0p06kF92rnVtyEx1F9XGI7BbnkesthqfHRTPScTYwktzc50S3gLeIk5ocGpZxZxC+SL88F71En8I8mS06GF64nLsNNlP0Gz9ZN7rjXGxDRsh2YZKb++T5ZedLcngid8hxm/q+uBbGM3C5Jl5xkLn8muOMgLlffeObjlWxoVcC/Y3FTmhYnz0X3KBr8KdkHv389vwxmxEcdekgt4SEhaT+AQF1Chdx6W5YnhihSa4CGZ3P5o7xYeNMDoUXmyYQmL1TZ0Kwy+NCCW9QB8ZI3E6lNEm4XEGz3j8qLROLK5FQieysNEmOJ2PVhYa6vDHvsSuHrm+QCpcLd7fzToXsSFKWklTWaUwhomsD2WVaysVrcn0rE/8oqYWeWuio2cdrXHjVXkb+jHeEGCcSPLFOW9+8uKcX1uhRk4U7RHWdB9JEwUfzJFVUWu2b+WjQC4lek4936u1cotY2pzGf2phFqUxidsyiudZW/JMxch0Kg8tZjij6ZrY+0aKhi4iwv11jKfRLhjIEcnT8vUJgKO9MfEKV2wEX7fdQXEh+cJZFzH9AXx2zDw2Z3e1LFFgaGevIfjPPtGBIC4Y+B9iCf1+/yLEQ2ySDywPeAQ5X9neZoGC0lvM8rVuzuiPfdXOoNERg1X/ykR74HwerBFdcMfeARldjkIIJeFdny/CbFbSoiDWUVW4ZrGtwk99Eo3au6c3zW734pHr6V5OXJB6udlZOVLL83ln6jkzy18m7f1LGazPNj5hpCihM7uaWLXqGupN7tLa5z0cb0XOBv3jqItVhbnQ0rkdzGKZOJgWGJp92MR3N6YtO2jgXPCPkt0V+pRcuDgF3KfjRBzpCM4MxCFoLNMonMgG9DnuLFkxFUDG1X3QyF1R/00UfdgYtn5KR2FFpOACoxSJXmEsxli8YfQJ7j3VjaaPcJyF0Y0qUkmkH46pZZUSS25AqOq4RMQt7MqWtZHSpNSPesxZsaIt9ZCiSLFJ86bYSZCx8M0LjmvD7PtrwnHAukpQaQGRQgClRW+H18fkGRRBTxcsLbWbdYpLt0lgQoVbHO8NOB20f3Uq1zdCt1ui+FNnt39Ta8kPnhl9drzbR/0dfNxeFghB+N6WdK+I79x2H7wEvg3oPSBF1dxeIpwdrX0OjsZhDDUTn+po2QagnuqHbaP6pw758v2p5XKsIC9E1etEp4n/9G+m6Sh6Ni6+pH7vXOA//cvpWqctdPbVcNfQBLj8K2gdYEwudMwRzmzaOaT/Ib+vUpm+8+KBGq2q1X47Iy/gdNbu4gIKQlf4DUX4eMA== +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-sod-violation-report-status.api.mdx b/docs/api/v3/get-sod-violation-report-status.api.mdx new file mode 100644 index 000000000..30b6d94cb --- /dev/null +++ b/docs/api/v3/get-sod-violation-report-status.api.mdx @@ -0,0 +1,95 @@ +--- +id: get-sod-violation-report-status +sidebar_label: Get SOD violation report status +hide_title: true +hide_table_of_contents: true +api: eJztW1tz2zYW/isY7kOTjClZF1/klx3FVrLuJLFXtpsHJ9NAJCShoQAVIJ2oHv/3/Q5AUqRlx042u20zfEloEDg49/MdCLwOrIgyI9NVcHB5HVxYYQ61SsXndJilc4wFMlYHVsfhldQJT6VWB0bwOHh/834r0Eth3NhxHBwEM5Ge6fiXYt5YLLVJz1KeZjbYClI+s0Tv7OSInepERqsAFGJhIyOXNB8UzufSMpCxLJ0LZt1SNtWGcVZuz4yjy0ymWMrtR0zlKZtzy3hCnK3YRAjFpLrSH0Xcws5LbvhCpMJYJ6OknZYc0m0FCi/wl4zxbKO5WPDg4DpIV0satamRahbcbAVG/J5JIyBkajKxybVgx0dMTx3XG4ymGk8gJa6qIhFj4jNfLBPaSkx7+9NBvxf298Qg7O/sdsPJzmQS7ve7fb6z2xvsxfsBadwIu9TKCkt8dre36b86N17h93JTqI32j8jSKiUafLmESdzM9m+WCF1XFMKT5GTqlJerRk9+E1Ea3NYE2XbpbHvHxsJmSersYchvUumF8BRvK/3rKbOj8xNGRJxmVbYgZxuPTk/G57+OR2cXr87J39Yqr7+CkeEE34ON46O6abvRoLO/vd/biTuDDt/f3e7sxN39/s7OpD/p9rqctvZu+NDm/8oWXIXk43ySCEaLCjM/TvFrptZByDqsjNjgBrykMvVTdOwjeOzWH6UanG46QN2Y3r8focfSSfmXeK+a8uzi8HB0doaRt8Pxm+M3L/E0Go9Pxvj/fDR+ffxmeD46cn+8Pv21eHM6enNEc2umLwZvbiikCoGr0o7FVBihIkHWKReu5atwkwtadyfvTUFX7Mf7sH7Y7U+isB93O+GgE+2Ge3w6jSf9vd5kO15nIa+E8PPqD+IMG/fviu/DRCJm2cgY5MWQjUWaGSViJr0nUKoSNmUTjUyIbIo8yBMZf1W4f9nGsUi5TA51/AiXfSGVCGeGS+JQOJYjLGSgeCVjrGALbQTzJAtndvPq/gpNtDrsOY8hr5fvMBeGPNbw6CNoHT8igC+UxHpWLGEydvXlnm3FnuCT3e1Btz/d7XOOsO3s7UwGU97rbQ92BgPafSGs5bNqLgu4MXy1sfVLoYSREUt0BIv8AYUglKF7x4DbnNwmFQv7sA0cjUfon0qTn1uKmfPLqMZvIfyeH56y/h5LuJplbpzPbilBhRfk6CpLEko8vghCck/4xMiZVHexUkTu0ejF0AfFePTvi9EZnojWRvUfUtWOyS3BKnxhrj85jnMBPqHEW5FAHSjr7FlO9RkE4spWJ8ocPqwslAnfmnLKf+xZvvsdK6qk2dToRS2UIg+I2BPZEq0twAuMLXgazdmEWyyACWn6s2EUiWUavso1+YzNkaqFedpiwziWJCRPGKIRRLGecArjcUyh6wlMM4QymJHpXGcpUzqVkajbYq3KujXWWexV1SgUHOD8YT8ZRmkG5pyY1SgsvSVnMbcPePaaq3N3XlGaU+lKpTyCFMAPK6jRGGiYTSCbBMTL0xGZyyLxqGJembGq1cilu9eeGVeK8C7imX1E3J0mSD+hE618cSXy4LMEz3w2ctYozJRnJLwksd3ifFZpriLw2VSKJG5it4ndJnYfGbu3X47zriZ/66BPZxP6XCiOplQbVzw3oI9x3qM0KyZ5JOkNucWgkBwi/fz2HIH9kZpEy8TnJXV23xEf+VK+wfywtIcfnxD8KI1VswUx6PToJZgiE4n4wPG95tgpyquqt7nbC20mEg6q7oCIyJqGrXTGOFSGflARJ9xusVgLq36iZhr5kSMirPUZkHZVcbjUUqUNkmyQZFONmmr041SjBkk2sdvE7t8zdr+IJEuuXLTkOMlmiwU3K+9p+Xt/EIkJrDhfZ2XIOVPdRitEjJUYK6gjh2DS7Uw6071I9GPej3d7g2k32u3ynb3OXmfS7+4F1Vp/uY7jMsjqMVWxt7ejUzFA3BVwXKbgXDbVOq4f/2V08DultEapp8TN0DlU+n6NHfub2PGNTiEbCAM7mnuOFy/Gr4g+tnbkSW86M5EgmO1V53+XIUhJPgxNS5s20LGBjk35acrPD1N+GujYxG4Tu3/P2P0q6Nh/CDr2vwI69hlBrClBrD8TOsbAHQTNpjAKZIgyqFcRbFxCFDzlp4952KfczERaAr0aiuwONlHkudbsNVerAizZ2kmkWquL0hvmLmiuKeZiAmczpEjFkLUk0C15lVwIwqTwH5bIhXRxTAKBrlmFw2kKqXzMFP5W7iJVlGTg0CWFRNPZq4aPSbiTmBL8AwV3DjpDov6OZ5y5tf6r82A2JolfkcRs9DkSgmK+PP/dueuWwDGYN5Quzryt77ku4M/MuUIbIT4vffoqIWgD1Ruo3pT7ptz/GOW+gepN7Dax+/eM3a+A6jkauh+qY8KjoTrmtrZZiaVekHP93xG7C5WcA+feTEcOq8drDO5wBVwpv4ZPOYQuuB8Ebbq67y6WIpu0r2V80y4v2Yb+ki0m+4bA85eZBOvmabq0B+32NcwGc920+FK2kM1guXSl9KdWpBftq94dSYjunPqAQxqLs8g1EcPT47zraDllG0n+7JOf28Cr3olHngsTuMsGX6RfXIBeoSFhnswW3QDPfcsNg80lGoufrJvdcr60ISNkuzDJzUPy/NL7khyeyD1y3KW+L+6F+Qxc3hIvv7FcfLJxRgjc777x4ca6qtDZf3djsxOa1mXPBTdoD/x1mCc/vz1/ymaEO13cZ5Ygr5DUKCByTuEiLq8Ni6shtMiVGqOz2dwxPqxdvqE4YtMEArN36kwIdnmcK+ENEv4YGdqplBYJlxRo1fsnhWVicSUSqoWttSbJ8WSs2tBQm9fWPXV1zzUIUuFx4UZb71TIjiSlI0n1m+bkIrp+j10uC7l4Ra5vZeIfBbXQUwsdNfv0FhdetZeRv8wdIZiJBE+s09Y3b+7phRV61E1hhKje5oE0kfNRvzIVFVb7Zj5q9EKiV+fjnXo7lyiq9WXM5zBmUROTmB2zaK61Ff9kjFyHwuByliGKvpmtT7Rp6CIi7G5XWAr9lqEMAREdf68QGMo7E59QiXYIRfvDEheSH5xlEfMf0EDH7ENNZjd8iUpKM2Md2W/mmTYMacPQ5wCb8+8LFTkWYptkcHnAO8Dh2v4uE+SMVnKep3VnVnfk224NlYYIrPpvO5YH/o+DdYLLn5h7QbPLOUjBhLDLS2T4m+W0qFrVlFWcDdzW4Ca/iUaRvKU3z2/5CycVzr+avCTxcH2EcqKS1ffO0vdkkr9O3v2TMl6TaX7ETJNjXnI3t23eHFSd3KO1zQM9OnGeC/yLty5SHbhG6+KaMYdhqmSWwMrk0y6mo7n7ihO4WfCUkN8W+ZVeuDgE3KXgR8PnCM0M5iBoLdAon8gE9FrsLXotFUHF1GfRFVxQ/U3nDdcZtHxKRmJHheEAoBaLTGEtxVi2YPSp6wPWjaWNMp+E0HYpUUimHYwrVxURSW5Dqmi5jsMs7MmUzozRjlaM+MBesKHND4yhSLJI/knbWpCx8E0HzavD74dow3PCuUiW1OkhgwJMicoOr4/PNyiCmMp/pdBm1s4X2TbNBRFqdbwz9Fro72hoqW2KtrRC96VI3ZeJG59T2uKD5ppfXa9Py/9HXzHnhYIQfntJR1TEd+Y7Dt/sXQbVZg9LDtx3zRv9HjqIOeSlBdfXdKxBzc8NDaOdp5758v26t3E9IUxBz+gupwj02x9AV2V/Ms4/lX7qfpj5ps+i75S0OLJTq3W3HuDxo6AmH4KiFYZc7hTG8exf+HOaypKNXzKooSp755cj8iZ+T23OH6AfZJ//ANY+CB0= +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-source-health.api.mdx b/docs/api/v3/get-source-health.api.mdx new file mode 100644 index 000000000..3ff60afc8 --- /dev/null +++ b/docs/api/v3/get-source-health.api.mdx @@ -0,0 +1,95 @@ +--- +id: get-source-health +sidebar_label: Fetches source health by id +hide_title: true +hide_table_of_contents: true +api: eJztW2tT27ga/iuanA+9DElICFD4ciYbwpZdtvQEsp0zLFMUW0nUOrJrybRZhv9+nleSHTsJ0LI7Z3c7+dIaW3rvl0eKdFuLE5FyI2N1EtYOaxNhzuMsDcRrwSMzrW3VtAiyVJp57fDytjbUIu3Fyogvppvh8+FlTYbqUNsp+jAVPKxd3V1t1QyfaPrqiOkaXoVCB6lMiBUYXUylZkKFSSyVYWNhgqnQzBFiU8ucjeb+xTPNZAhZEp7ymTAi1VYaSYQSbsVU+IC/3PgTGpyKT5lMBbQyaSagCDjMeO3wtmbmiR1rUqkmtbtV0QRzcoNrA5TEFz5LIprSDg5ar7Zf7eyGrYMWf7W33doN2686u7ujDm/vtA9qpHsqdBIrDa3Bq729Tf9VORxbdcMldXUWwFR6nEXRHFwDsrMyNJsnSSQD66XmB00kblfViUcfRGBqy9ocmZiN43SJV8gNJ4Om5H4jnayw8Yp1SB0enimI5O1YJW+mZCUWj5kpzLbOZLt7r4Ld9kEAk+Ep4Hvjg+2gtdPukP0dy1XWVVbniQjkGLJaVjSW2Oq5NmLGRgJT2IwrPoFhRWPSYN3AyBvBjhAEgYnT+RZ7F6cfQ44H2L/RYCdjNo8zxlPBAmhpiAJnRyKSM2lA5VhGwttty46cZdowLYwV4BrGu5EasnHd0zfX7FMm0jkrYpTB8NdksusGq1jkLBHq9Kj7ltW9bGQCF7+PmYD40sjc3nrV3s4FrfaOtWycTh6nWiQZjS7TCoXikawHH6ZES2rK+RjFgJNhS3RHcRwJrspzxzzSK8FyoktSM16hZhn0IlhYpH+YtFRwZOCJgfI01uY+Cy/UnYkJT+KwnmnBtWnVUfpSYer55IbmMrL1qhHEs/utWDADY5D7BvvT6AcEsjb6dC7SGxmIX1EFpSsFD1OncnbjBudhUxCpcJOfPE0ED7HS8Eym15pMZTNb3c+Gg17//flF96L/vj8YnA3e906H5xf9AQat+eherf/2a3f5/XH35HQ46N9HMv+8nujrfvf04vV/l18P3/Re93s/94/uo7oy4P2bM8/i/P6x62VY/k6kur3e2fDNxflqR0S9VygG5CYjUGfQRrLIVHP7Qe53VEmlKVUB18TRAfCNvnbWNaNeJNFmWD9N0SXqbCBMlipUP+lihdooiTOKwzlDz5bqBjXB9sUnd6hq2wmFQWL14vArCuCxVKI+SbkkCYUVOcBEZmtxaFtAjHLuSObhbsdVGzks0WixH3gIfZ1+Pa8MGTHlwUfQOvmK3B0qifksn0K9kLrtPWzFvuCjve2Ddme81+Ec0KG1vzs6GPOdne2D3YMD4j4DBkATKyceT1M+X2H9o1AilQGL4gAe+R0GQROD7a0AljmmoJHN9OM+sDS+wv5UTNzYQk0vLyNQuIWy+0PvLevss4irSWbf88mSEVR9SLmkAHT4iF5Rl4TmjvBZKidybV3Ly85R/7g7PL3Am0H/P8P+OZ6I1kpGdRWiNaSwhKiIhWn82UrsFfjMAThFBHOIsMFeeqovoRBXujxQ+t7ikEYoxhyJiRme+5oZZdJsnMazSioFDkGz57IhGluALng344CEbMQ1JlAFwPCXXeDBxNRPvSVfEngLRfoC0CYMJSnJI4ZsBFHMn4MQ42FIqesIjDOkMoSR6LOZYSo2KPlVXyxMWfXGopKclp1CyQHJH48TYK8Mwlk1y1lYRIsX0fsHMjvLVaW7KBnNmnSuDEeJxMhoDjOmhJ7YCLpJo5kvR+QujcKj8nFFxSoXSFvufnHCuAKJesYz/RV59zZC+alb1YoPN8InnybY56qR9UbuJl+R8NGCV5rsRxXuyhOfAeNG4SZ3N7m7yd2vzN3ljwO/BC9Dn9Yq9Bkqvwah5rkCfVIbPSrOFyq/W3jjHbmFxVIOkX56d4HE/igUjRdfEtp1+BPxkWvlK8J3C3+49yOCH4WzKr4gAa0dnQZjVCIRHlq5FxJbQzlT7azZsojTkUSAqjUQEVUzLVbSaaaUXUjrLRbGQqtnhk056iO3uxuuArq9n7pbTG2Q5AZJbrrRpht9N91ogyQ3ubvJ3X9m7j6IJAupbLZ4nKSz2Yyncxdp/jtpyxkGsPzHIFaknHXVMlohYqzAWLUqcqiN2q1Ra7wfiE7IO+HezsG4Hey1+e5+a7816rT3a+Vef7nI4yLJqjlV8rfzozUxQNwNcFymEFzaxHFY3f7LaEdyTGWNSk+Bm2FzmPRqgR07q9jxTWygGwgDO6b3bC8OB6dEH6wtebKb28qnpLWmw3BuLKSkGIalpTYb6LiBjpv2s2k/30372UDHTe5ucvefmbvfBB07j0HHzjdAxw4jiDUmiPVXQscQuIOg2RhOofMXGcyrCDYmUAVPfvfRp73h6USYAuhVUGT7YBVFXsQx+4WreQ6WdGUnUi3MReUNY2c0Ns3H2hMhE5RIxVC1ZOyOLMmZIEyK+GH+0E+DkUKgm87r3TEd43E5k8dbwUWqIMogoS0KUUx7rzFiTCKcxJjgHyjYfdAJCvWfuMfpvfWH9oPZgDQ+JY1Z/0sgBOV8sf+7u+6UwAmET6lcnDtf33NcwO2Zc4VlhPiSuPJVQNANVN9A9U2737T776Pdb6D6Jnc3ufvPzN1vgOoeDd0P1THgq6E6xja2WYGljrk74fn/Rew2VbwENrxZHFisHi4wuMUVCCV/J4RqCN2zOKw1/V2P5m1+1eLOv6pPF1dGCCI66bI0wqypMYk+bDZv4TQ4667BE9lALYPfzFzFn+lAdfNmZ00JohOnLt1QxMLMnY/tvj3xa46GNXUqKZpd6bMMnOGtchS3+bntB+nn5+rn0IY5Mlt0y8BHln0NMRMsK55pO7phI2lFR+g2TKO7x/T5dechPRyRe/RYZ74HeWE8g5RL6pH4V4sbPueEvx33lXs+i55CO//tFWZnNKzNfhA8tTcf6DDM85/eXbxgE0KdNuszTYBXSFomIG/eIkRsVevmB0Nokm00aZxNplbwbuXoDWURG0dQmP2mzoVglyfeCG9Q7geoz9akNEnYkkCzrp7nngnFjYioE1ZP8jdlqJqwUJNX5r2wXc8uD6TC48y+bfym8msbkro3jfEquusjl0muFy/p9VQh/pVTqztqdUtNv1iSwpn2MnBHuQOkMpHgkbbWejJzR69eokdrKbwhqssykCW8HNUDU0HutSfLUaFXJ3pVOX5T76YSLbU6jbkKxjQ6YhSyExZM41iLfzNGoUNpcDnJkEVPFuszMa3bjKi3t0si1R3LuqSbG1a+UySGcsHER9SgLT6J3VaJTclr61nk/DWWzyG7ruhsX1+ij9LIMA70k2UmhnViWHc1QHv5XZuiwEJukw62DrgA6C38byuBF7RU8xyttVXdkm/aOdQaAohqqejk0P1xuChw/onZDzS6GIMSTPi6OEKGv5mnRb2qYqx8Z2DZgqvyRjFa5JLdnLzF75vUNv9u+pLG3cUGCl3O+7Or9D2V5O9Td/+iirepNN9jpfGIl8LNsvVLg3KQO7S2up1H+81TgX/x1WaqhdZYuNilmMUwZTJJxA3FtM3pYCqF3QhIBDeE/LYoruKZzUPAXUp+LPcsoQldUEXSaqBRPpIR6DXYO6y0VAAT0yqLDuCC6ofYL7fOYeW39nb1Ue44AKjZLFOYSzmWzRhHeDzi3VDqIHNFyN9QcwLFFsYVs/KMpLAhUzTseiOd6bNxftdw4cRHeMGH2m8Xw5DkEX+7e6HIQEQ2ymhcFX4/RhuRg5VKlNA6DxUUYEqUOPxycrFCEcSU/40iTidNP0k3aSyI3OQXMWs7Dazu3K1PbbAoLdE9vu+Cu73XXomp28U++dNuyfseQOC9mdDeE4mUucWEW8Vd+iunZL3D0pX56kLuyt2bpeG3t7RbQauaO3ptbzrj/dVi0WIXe7AxPYfr7+iWFXs+8LfzX9jfWyrX7dfKn++wqflicV3D40dBa/JCB6xfIbXdOrESuc9uc6U0ceXnB1oHFQveH/sUBPyeluofoD2Kxv8AZVC1AQ== +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Fetches source health by id

+ + + + + +This endpoint fetches source health by source's id + +## Request + +

Path Parameters

+ +Fetched source health successfully + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-source-schema.api.mdx b/docs/api/v3/get-source-schema.api.mdx new file mode 100644 index 000000000..ec1bd2e6a --- /dev/null +++ b/docs/api/v3/get-source-schema.api.mdx @@ -0,0 +1,104 @@ +--- +id: get-source-schema +sidebar_label: Get Source Schema by ID +hide_title: true +hide_table_of_contents: true +api: eJztHGl327jxr+CpH5r4WbIly+eXPkZWHG1tydWRdOv1cyASkrihCJUgnah+/u+dGQA8RPmse+xWXxIZBAZzz2Bw3FXkQkQ89mXY8SonlamIBzKJXDFwZ2LOK9uVmE9V5eSqoptV5Xq74gnlRv4CB8GQMxGzeCaY7sD0QDZess4p80PW8UQY+/GyK7/XfgkB4IJHfC5iESHYu4qPMBY8nsGnED7AX4ogAT7blUj8PfEjAajFUSK2K0qjdXJXiZcL6htHfjit3K9iNcww8r0aQBI/+HwR4JCGe1w/2j3a2/fqx3V+dLBb3/caR839/XGTN/YaxwBsPVo0N6H1CBqrGK9BS3Po5WhdI3S1kKECOcDcjd1d/K88A+IgVCw8O9d3rphKXJCfmiRBsIQegLC4FYSDK8MYhISw+GIR+C7pw86vCgHelYmV41+FG6MoI9Se2Nfo+F6ZIevo9z0mJ1plCPKLpWME8py5sOdjs3HXlQmQTkBj/1b0iLYhAX7pBJovDAcxGVKTBsrUEqQxhxaubUWzFKSwAIEC61URq5ESEaLkG9txYkBgnMSvwInboSxRoA+xZC4P3CTg0ILfk9AHXWF6pokvIjaREeOhJcYPcwgXsVTOhaPZ10V5oAn6ahHwfye6ZgZ2ywPA+tmowrAYpk98NROexXYG1PLInb0Nvt9nUgmNl8oEyyT0igyGClHkLJ23xnoh2WIgbjn0BWqnkUwWhoQVpZiL+VhEvQkpRugGiScuRTT3lQLUVA71sZSB4GEJ948BnwIGHtl3OAWMhUYuYqHUemngskUGmH3341levT0ecxwLpEynkZhqYA9wfsIDJQDhieBxEok8mjyK+BL6+mAZah3nRZjMMfI4o+GndnfYaTnDNjS3eheXvUGHfp92+u3W8Oay3b/oDAadXndAjYNW73O7fzNofWpfONDS7jofzrH/hdN1zuDLea/359ElNHR7N32ne9q7uHFarfYAh1/2e3/9Gf4ftJ1+6xP8GLYvLs/13KPuea/1Z/oxGPZHreGo3z69GTr9s/YQxw4+Of32Za/THZpGDe9zB3HrdM/gz7N+b3R5s9I4+LnbWm27dAaDL73+KZI86veBAze5JkC3N4KmXvf855t++y+j9gAnc05PO0MA4Zzf2B7ZRyDWOTvrt88c7GJxGdx8cj63by7aFx/a/YHulmPoKlrw1ZDwaJ91DFrTrSzAEhv67Y8gsdGoc1rOPXr0gwfM6pd2sS44hTHoY7JYyAjDIGQj0KTzCshCtlhep04YWrX+aMcotuBKVeMZ2ON0xngC+g0OUkdGgpCq4frhrpwvpALdtl/cSGSDy2SvhwJhOolCtK9TyCncOGfwBk5B1dcDAefnyluBVmU9C3lO8LCRAr542utoiNpUHkCGewjDnyAzTeRkvmIi5OMAuAwwYS76TbCK1rYeuUDKbwgUvN6ch3xKKKEYBYgsEgCbphGQUWnvOREAHUDBvL7SfmlhOA0+edWeCY/VxgImngStQf9nUGIRcETOkT7Ilog9OAkkxjo1ePeeQfY6kx5kVDOZBB4NBm2DQIVMwAHixwJ66vgFrhSYPSdEyLUUZkdNBTFAigBEcwYJ1Y+lCWs6chidZV/I4VodZrOs+zaDiUHfwhDmhJGIhwJmghs3rhsswgxDjgInSZcQPaPeSGAGAKfHFo1Mzmi0R8Rf1iXib+0TH9LfB1QmkO43rTFJqH/XNKyy13jKMpIQIkbiovl7bMgjkJRW5ZIzfgUkHe2QI4MZMO9S+mFcY50YWAtMB6lD0PKR40udsICjcU632fmpc2kmUlbyqVMrKcAYRE2sIuX5HqEuG16pGvvEb3WABbYZN8d8iK6+9XZGVrc++oVUPZHL2E3MwXGhyQDSEIwlfOahGakVQeu4Jjcf+BE1GjHOwUcznGjzNF5W8884WZsRGD9XDnbPIt74o7cinZRhNcKWEEnhpLyHtD10wURCmahgqeVoIvAjozFwfJeRx9wZD6cgfzaAtMp21mwNYekVaaptd7Wt6fRTvyIxORybTBh8H1jor0noInOzpCxPkuWRjk8rOcMJLIfnKcqYa6nU5WFwmJjgZjNbN4kiTGAtfhQ11yQdDxkVrUBReik3EWeZxIzWNFo42jgeTlqeBu55vkkBUosxLj+X6pwwJyWc9H7V56/V22JiVEBlLj0BTlZn6zoxVzN/YZJlbppyqwOzHNQDTCIdcfLwgBHGNa3z5SHWaepBJvKJyYTWE5SzW01PxQe4gdOyA1dpeyS9O2EdvTzI21c+soTItEzVjf/AeFF2HxTFUi9G8auc9pDRr9NhRbHKrKK2mU9RA1QxmVPcWoebdlYl7HI4Ge5ZV2KSFUMrAad8kpByOdidyo22aodBfUxTg9mYIA8G8o3RQqZItuH34wnzm3Pdus//K57nctjnLD9ONFp6sZlGc1i3B9zVsexJuRHKj1iTxeWJNc5/ApNCIWFlPU3OGJp1tfSjltP6gmpxlZUrZFnXXJjoanXp+/jCct1i9PqeqpMTf5roIvW6KmQRz08y8DBtX0IWHkecFYbrdG4V+zlfMlO2LRBwVyGluiBnnisSmVJM5R6wS/31utJGmYOZe/fExA8pdkHUmPnuDLV4vlJHWa2NPFB5fV09NMXlqbJebKqhZXC61PkoOLBDLd+Hyjtph/Me/Qf5Ovz7odc7bztdXPJbBU0lcJqyjuq09/l6fBFHB+Q6gbUj5l/gMnIyN9HVZgVypZpn6nhzvoBvtQz7BwTwNIdMzB8LNPIUKe8RvrR63S74jV5ax7rOs7X0lcrFz1MCg0vnVGecGYuo+o/mLdfW5PcPjtz9xrF7sFuHXy4/mBzvuvW9+t7LavKzBFb6VUx+MRKkJd1yJb2IBNki2NyqZ3pqSqc0Yfb5Kd11LpixBWaNwVcXSRD7b1NvzRQO5DBHuFXSPK9cREXoEw5dsqKqr9pZKv1vQAjCey5XfyZKZySmN0Ym2yixmTIEVwqbmIPYhdJX3HH7iuvTrwXWfCViMFExPba2IGBubeEkkabUugXyyhB1bQ0kUwy9efkEA+4f9VaoPll0vEv3FYsON/UIqWM0KveZNCOdekX6aasRgJFIOku6fVCGX9rgKzkX7VusHzg6PDisTyZH7m4dfo2b+Jd76B3sZnulxlhLe8UrC6YycXrTdIU222hIwz/vKTXAmqp4ptfz7B5Sbk/UAEDVxujLY9wrgpZq7JMkci5wt35crTeqjeaw0TjZa5zsH9Xqu82/IY2wGsSts38Bj4BDjmvBvACbvfqwsXsCCDUsNjkNNFv49+Qym+v2ilvg7cG1taMI1L3K+raSoys8afI9lt6SaiohOCf/LbeMPRFzP2jBavpp3n0Ew6xOI072KQhlV3qm/kNVxrnEBQaBtI6d+hWdOnCiVmcfuAf0avpahhjkXcRdrEd3niHMkd46tUNwX9u6jTXTikPBxwe7x43m5KDJeeOoWT/cHx9P+N7e7vH+Me1rz4VSfPqMVPJMhCLyXSyjgkT+AQwBRQbeEwI0+fOTR4LxzNCt+6ZkGnxZDKn2NjjRD61L1jwEbQ6nCbXz6QoTwuoIt5jCJAgwFhtb3jZI9CJ/6q8N6TYpOm1/dEbnmCCm21oIq7Qx5IQ2tgCqoAsz+Z0wNgTQeQgRUBW8xrYM1K20Npp2NFsMZv/eeHsYYWZfMyIPmk0iOS+YEtnNj5i982uitg1BC+2ex5D9jzmW+UxaugUBQSzi6rnh5BabQfYiovc15mQVrzRJpejHPU/XCRHAJKHVti25QUT13ZXkJmNlURqZAznPCwWNAzB/Rr7lxgkgR2TmrTDVFoOikQ/grDlXxC53jEWzdBnG3I1Nrd2VEdUZIL4yn3bbyIKpeAqOJ7T9Uo+V94vk7i40MqexpG+68vCk3V0G4H6qRFr64VYY41O03UPeSOQLk8YjmTUGDTa9UnFZw2fg/wNvY7sb293Y7jNtd/Vj35yQM18p9amXU59RiHv6MqLgWUp99KoglMx20tUjLchtXKOYFOmnL0Mw7G8ipH3wHws8+feG+ZEO5WvKGlYeun1sT+DY0J/JAhEkPmoKJuCJhHdCeGcYE6M0q/bKs32U0dgHBQ3XpIh4hoAtZaJ3lpOQ9lG52qYtlvCPMZvxW2H30skD0nkBr7qgndRNJrnJJDfRaBONfjfRaJNJbmx3Y7u/Tdt9NJNMsSJrMXmSSuZzHi21ppnvSC1n0IHZuxosNTkS1Wq2gsBYmmNViplDZdyoj+uTQ1c0Pd70DvaOJw33oMH3D+uH9XGzcVjJx/qrzI5TIyvaVE7eWo7EYjqBiEfxQLlULKVXLP8BeyMxoa35OEuJQXaQwN1fZ7ljs5w7dmUMtAFgyB2jB8qLo/653oPS4JFveldORumVisKpHfHDV/Emddykjpvwswk/v5vws0kdN7a7sd3fpu2+KHVsPpU6Nl+QOjYZplgTTLH+m6mj5+t7MBMQCtBgD4+n5zZM9dGYvTm3ahO9QhbZOF5zkEpKdoFH+kyypAqVyDBjF7o36DvHvpHtS9eGpuAiQzxZ6kt9/difC8xJcTM+8Od+rG8VCYQbLavOJAaqtM1YfUtnMbckFTmFQGLtVYKO+Xi8a4LpH0CgOugUHPUb1jiNtP6lejDrI8XnSDFr/3CFQJtP67/7604JdPD6FbqLgZb1A8cFIntmKAnT+09pCrpJ1Tep+ibcb8L97yPcb1L1je1ubPe3absvSNVNNvRwqg4dnp2qQ9/aLktzqY90bPg/nbGTqRgMSL2ZdClX97IcnPIKvEZboeeg0IfgM0gnlR1zg3Xnzj7QdL9j3hOAJvM40j3012sCjWISBTB0FscLdbKzcweSA4nd1/jCr9nXbUL5vebK+c7t3ho/lF3zB0/mJfr2q3PZMQuPGvE78ulOGekrTaC5b45mVxRIgc4bPArf3j9YAnFMg9nOXe+mZnzVAdYWf1TUu0bqVKIRaBtFwf1T9Hzee4wODeQBOtax79G5oD8DLFfIQ/SvUVygAgCI5IVPD7W043ISFPvVdb4PnSnWGJZ6ZsEHtwgaJYR62K3BPgge4bVXOjXz7qcvw/dsiukpuYdEYWYsfFxPgIFdghqR+3PsCRIcRBEpe7nAKZzRQXNjkwCYwn4JB0Kwq9wLZKwPjpzY7hRe9Lh+Z6XniVsRYMisZdxG5fS9cAe4uFN8CeQ9hUdaR/ihPrOtr9lWzYMd2Z1MTSItC9nVwtLFc3S9Fok/WGhVDa1K0NT7FSw0a69cfebbBZtHEDxQxK1XT67hVXPwcNEFLQh1FQf97AjhUTxZ5VqpvRqPArwqwivi8Uv4hW7ZFYfZFwPMlfsOc2dSKvEnxlB10FSupglY2qvRoqt9VbKIamM3h1JVT1n1q5BJEn7nYBihViY+xkhOiYzUNRUy268kWfALX+nG59cCzdR8BQEXe3rSVa/GGSes4oRV7SeUwV/HM1QssG2kgfyAVoBWJn/yBAbRnF/UsNZ6fgK/Q2MwfLiAKkFRixP9x0nmBM0vRh+wd9oH3HSFXnQzZ83wWRQDi25q5pllSwirHCzjG0iIpSt80/imG6EYX//X6EWKnazSgg+NvbWXfsCT/O/43f+Sx9t4mt+jpzGpMaobTWvWEHkl1xldue6n6L4X/AtfyVIpB4cVTvaMSx7MIuCxvgsONu3O8JlOLKQLHmN2uI16Jedkh5ASo/EL8+7IlG6zRYAwhzWeHwC8Gvti3tCKcDmGJ3UB6q/SrMsGwGV604idWsFBAjWfJyGMRRtL5oyDejwhXXxhLNFOyLwOoRHST1ilo6xFotogK+hetYjmqjfB0jKsWnNCfGIukKEydWVgZHYJvpIR0hcBaRn2K6boT8EGzanOREAXGMGDQjIlcjNcdIYliAAsNJsZMprumEFqB/sCEFwOaWXYq8EyEJsWUsWwes3BxYd01zyiu6pPd1kx/cVv7xrXjzn7zgJrU4hJotcZepV3ZV7fRaad5B7iNQs9arXv4MK6YAZU4KC7O6xp4LLnHpthLY8L5qvrbFVDqwv7PFzu/uwDlL3rm3d039OuTOEp37VU2DpcuMyW4BX4+U3gyj2lBNdrr8ci/3Lva7CwnKPbq7rMQ3zRn3UhKDewtFWCS7F0cY7PS97f/xM6JyHI +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get Source Schema by ID

+ + + + + +Get the Source Schema by ID in IdentityNow. + + +## Request + +

Path Parameters

+ +The requested Schema was successfully retrieved. + +
Schema
    attributes object[]
    + +The attribute definitions which form the schema. + +
  • Array [
    • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-source.api.mdx b/docs/api/v3/get-source.api.mdx new file mode 100644 index 000000000..4ef539129 --- /dev/null +++ b/docs/api/v3/get-source.api.mdx @@ -0,0 +1,138 @@ +--- +id: get-source +sidebar_label: Get Source by ID +hide_title: true +hide_table_of_contents: true +api: eJztPflzGkeX/0oX+0NsFyAuXewPWxhhmXwSsBz2l5VdcjPTwMTDDJlDMlHpf9/3XnfPLQk5WudYUqkEz3S/fvfVPe27krsRHg8s1+mbpXZpKYKJG3qGKJVLvjBCzwq2pfbVXWnmC6/rOoH4FnTCYAXPSpbptH0a7Lc9wc3S5/vP5VLAlz6+lWD8EjwyhW941gYXgSWmK8tnwjErG9dyAgYr+owzfyMMa2EZTEJklsP6pnACWH/g3lY/OR0WuF+Fw26tYMWG4/Prztllf1Bmk+Fs3O3pP7mefjCZvaVnjAO6LtLBYF1P/BZanjABGDO4bbMAsemM+lUgeMM9vhaB8Hwi2UJsNxyILZcceAF/skzki7ESa15q35WC7Qaf+oFnOcvSfbmkwZfagReKPOWCTRR5CEh84+uNjRAaxmn9pHbSPDTrp3V+clSrH5qNk9bh4bzFG83GaQk56wl/4zo+8BSWbtRq+L/0Ah0N3p3/KowAljBQZE6AQ/lmY1sGifrgVx/H3+VJiSZuPFSMwJKrAbo5chEhbg4de1tMbbBCMpm7YEFEdxHRh0cnxmHj1ACi4ZfBjxanNaPebLSQoZLv+aXTS70P19ypIDp8bguGk/S6fn7dy63G5j4D6JnrJF4+shzpO/yLrw3X27hgbjAX1MQIXG9bRSzcW0d4eXmOxUJ4wgGBgrpyWOTWAbQiw2BDLa3HpSffZoGjNuIbRF1OZHOB4D29qhlDjhginHCN5t0/6w2m/ekvaN8xrdFToKlYZ9I49M804yxF0zM0pN78bg0xLX9j821KUwoxuNwOEP79Paxk2KEfPCkmBMV93zUsELPJumpSXkZOaNuIjLae2HdcSaLK0t3QvM8/Qqbdi9lk2hunRaofPluiRkR5TqBHR/Wjo/nhvAYCrR8dG82GWDTr/OjoRQVahEA3MkAtGBItNww3dAJ46wmbXCTEuoW1fNokO3ImS0xlcm7shJ+S/P+9ZDvd7nA2mF53h+Nx76Iz7Q8H8Hvwrn+eFvYj454tf8VT9HkRZwzJ1SIbp9BnHJ7K0Hd40jxuHDdah/xFVWJHnM60c2ZX0qFXjhonR8efi6T9kAKNQ7tAjGn1YTgIEOOAEeiS6bLu8HJ00ft3EsEy81duaEMkhVALQmehD37ldgW50ENqi9B+CvTY6l9CBcezi15a2ejJs9XKQ74WKdBx7cRoHLdatTr94if8+KgGHuZFFSi3ek/+IklKVQAYfInJciSUS0i9cD1Mwmx7uKDs8vGQrSTbCQDTeRiIwU4EDJKqrqeipoEasAXkxgq3pHpVGcr1htshDgkd1LOUrcSAbi1ImLUCAlTbdb+GGxqsAP/kR2G0mmKTei/FLQf8Ado0iDSRvuCesZKWEXhb1Ex4urCAJB5RHvr0PCbZc9dJciOsHsAfCICVZW7woKDvy3c5C0tT886yIfioBE4y1AyR7iIRIRlrHgBtlmO46+QoIsJXsUh8s/wg8fYnH8omSdaBzhk/gcP6XKilOzgs5FOeapxYlt4p4ZqYb5FhLCSllo8eyQ8XUONZgMreKf1QpzQXYP5i5Lk3lg9wYaEHxB0FJC90fO0Kut1z0C8wI9t2b33yJAZkT6CKv3Nd/WwSsBmgCLPloqrwcRwKqVgJYeG9D0s/WANkqZ/gY4l7HsdqxwrEOvn8B1aRkFsOet3pcHw96b7vXXYypUf27bOlovobO9eUx8fHLyqXgvUvtxP5kKSShngB/hunRrwjzy7HK+76SWBxGpFjleTUY42leaPZ4HFrS8U/il1/DOg8Brr03HAjA84GiuJb1zNHro0RoEgRs9b/JyrmqDOZfByOz65Hw4t+N9PlyL58tlpukAfPaHW8tFoWrH+5ZSMlITaSr3dW0EzLY5SU9FbrbbVYcbO8TKtYuiqEX2JeO2yentRiFYsr+hz+5T+yyjEyPVrlg3BMCF65JVCzF4IHoVeo0WnuDekHt5meEZd+kFX74QYIQQbOt5g+UeFZLfDP+ep+Nn2PfbduZ9qDx1hDDid9+n3WH4MFX49648v+ZALl/IQeTrrDD72EWfcGnbcXOP6yM+icw5uL4fBfsxE8GAyvx53B2fDyutPt9iY4fTQe/htZOOl1xt338GPag6JVrj0bXAy7/6Ifk+l41p3Oxr2z62lnfN6b4tzJ+864Nxr2B1P1UML70Efc+oNz+OP5eDgbXWceTn4ZdLPPtFCR5Nl4DBy4TjzSrYzh4OKX63Hvv2e9CS7WOTvrY1ujc3GtR8QvgdjO+fm4d06dD43L5Pp950Pv+rJ3+bY3nshhCYZm0YK3ioRHxxQxqGBYXoA5Nox770Bis1n/LL/Z8hyVc7TOfXLesKROtalEVBszao7P0KFXghV4+OWKNlmwwJD7CwQhUsPi6VDIbFwfdFu/McBlRZPzZBdD8QRQRSmn7NmMhLe2fExDfQUnperFQMBFGu6NoPJLpUmU40I14/mU+FIckxClqTyADDcRhrVAZur6mXa70BWbuDsFa9FvgpW2tmLksMhGoFBoq5oNUKLdBBAZZNfghXEZgZtaFtZdCwHQWXLXwd0oToPnztoz4ZF9mMLEdEFrHDfQKDEPOAJFM9AnfMkeXGQpAlnNvnrN1iJYuaavG1c4GbRNpv00QXzbwEjZRYBIDsxeEyLkWlKro6aCGG4wwgBxEPm/bUk4HKCuoLBUOss+UtWpdZit4uFlrFsSFQji4QMzTSE3E8ki1DTkKHCSdAnRU+qdLmFweQqjhEzCaKRHxF/aJeJv6RMf0t8HVMZ2ja9SY0JH/q5KWHmv8ZRlQCEH+ZSB5m+yKfdwx1Wim3XG3wGJmTzgxJHJCpg3wj3dKusHUbMIgpaFHFfNAXA0nbMyuzjrjNRCvpZ85NRyCjAHUROrSHluPdRlxSu/yt7zG9nTAbYpN8ew92Bpb6dkJcvTSD2Ry9SiWIPjQpMBpLntu/Aai1eaKRVB6rgkdxM7GEKNZswT8NEMF9I8lZeV/FNOdrn0xDL2c/lgtxPxyh+9FOmkDNkIm0MkghPxnvlbxwATcdzQt7dSjioCPzJbVwLMWHFnCfJnEwsbTEodaLQjwB9LqvVwvyzptPzChrhFnfxfQ8egjoSybJFSLM0jGZ8yOUObTdx1hDLmWn7k8jA4LFRwi7aXQg9S4CDCj6JmQdLxkFH9FgrZrYu4iTi7YcCoUyeFI43j4aTlaeCmaakUILIY5fITqU6bdSLCSe+zPr9Qb9OJUQqVtWsKcLKkp6B06zmErZW1kTRiO5YeJfq3qtMkJ6h6DbJ69PCAEcY1qfP5Kdppykkq8onFAosO2S3Wmh6JD3ADpxU1uDO0PZLetVnfMVEPkvaVjCwOMi1WdeU/MF7k3QdFsciLUfzKpz1k9EU67FOs2sAPoKzMLIoaoIrhmuJWEW7SWeWwS+CkuKddiUpWFK0EXJ52QKQMDnbnJ2ZrtcOgPqelwWxUkAcD+cqokEmTrfj9eML84lzX7vP/Fc8TOewu5UdboiWLzSiae2Jjc0PGsiflRig/Yk0alydqnB+BSaoXkqmn9X6PPDT0TsoJ+zFxO6OwPs3V0lHBnBmYWa+wAI4qW+w46I7X442giTxSJ6QX1L0wf+uDSqhemKwoIB+vLqusA5ET8uxo87vMPoIGmRx+iMCoQoK0YFs3JBuQxRrGF3YmbGttoc69s2wdAMo0ch2CZvpCmsWXyAi43/VvvjBQXG/LokN3qLJfsPH3pcpS4hhuhEP5YkXhhryPjOxpPnQje5RPqRWWljgn0ivRoazUCl0brPDpZTD6LUJMdH8LuY2MN1NNt5/5DWcGwpKmHYUlP+M1LKzmFtzI4Ohzy6Yjk9VoaBXZEpGXQjraxyxsoD7IIH0KUx6KCOXJ0P+URmdaEFQ9tWOK2oStP/h/Cs270kpwO1h1V8L4OrXWAhKaUrtZK5ewRTChLdokblclw4H5IR11WgOJoODUdrRBJ6YrcLUr1042V5E7SzrVg1UjD+SjZiO/YRxSikHo1hDXeq2mar3IMORescv8r5bcx5brsg2Uj2m66rV7SQIeJeWoLQmc5q5rQ9GQQ+Gj3IoO8ThrHMCiJInOo+pmtGrB6H3akecuwJyqBHPBQxsIXUAsEQmc6M/RXi6qEhqs7Lk/vpF7Gc1g0RRV1gJS0VnNP3977hybN4POoNuTHj7diM+9fXYnPmYdhUvJu1378g3450X78k9ic7ktFJ1s1UvD236nXnKm5sdnWB9UPJyKW4pgCOEOnhFqCxqpzm2A5XlltrSodI08juVIe6YUHeq3VdwER0PRyIGOQrKXYoo+8D2F8Hn9vte5mL6nPRkfq8od/DY4KcBvvcGy8pZSDHWAQXWSaGUoVsGhsVvuM3Dhge5aicw57lqjXqmdVhon0/phu3XSbpxWmyegM0dHzVrtf1Ieur+Dok6jM9RxvNs5bu12rgaXSJ2ajIIB+Uok2Fi5kPCiVDKt2nTWlEkfErjA0OlOKUvSWcRz2as4o0en+Dq1Lj5JMzZV7+3K5kT8TdeLmaP6pk53KtHCyA2x4zImDK0EoHIq9sTRgDitQCWCWzQhq2iNSg3+BUVrtQ9r7VqzetI4Jg2D2puyj5dAiHQ9ArgLWq1KrV5pNKf1k3btBDCrnpwiWveFB5zlufdkNvc5m2+jb4PJraLvHbo2HiViPc8DsVXYWDfaLHUqQtVGc9ekjz8s5wYSMzp48kLfRZgigJSl65o76PY7yxGVpcctxFAQygZMlLUhNYHXeFpGgtTWSOPSeSBwolpnb7kJ9Er6uooYrAw8buB2wS5aP3MsmM/0FHQ0urNdsKw4Fnx+VDtttBZHLc4bJ6368eH8dMGbzdrp4ekpaZ7wfQhOT++EnguQOzh92zVAIr8DQ0DxgfeEAC2++7kUgrGjb5FjIzIVvgy/aiqDx3/bHbHWMSi9swzpOV9mmOBUZpNcIgSUS8BDz1pahd+R6HzmrPeuM7vAvcZo1xFh5fbtOo4OzYAq6AJEJsJYEYCm6UOqalDj+o2C+iZqXUcD1Q6QKvpUQIcZavWCGUnQ8elIbUqG/ASMvbKqolqGTA7dAx1NnHPswqqe3JuOYYhNULlQnHyDUdQU3muoMuOGpDq8uObUxeWmKdu4ARVS1AzRHVEI+Va2HopZmU1LtQO5SAoFjQMw3yFbMQKo30gnUlYYaYtCUadOpuJcGrtpgmnE0i3EEyNQWyF0uBMzYaDNos1QsmDqbYPjcfS4yGMlz52Su7uUyJwFLr2TjaEn7W5kg/upEGnRixuhjI/OckhvJJJ9Y+WR1EEPmqxGReLShg/hWdjm3nb3tru33R1tN/tyrL7yVG8p9annU5+Zo5oRGDxzqY9H2uO4+uNXdUxXCpK+klUp0s8fp+q7Wtw0+bbB/OwF8yMZygu+U9XykM/n+ky+Dv2xLBBB4qOkYAGeSJhtwjvGmBglWdXMr/bO9eYWKKhTkCLiEY+oqemFDm1zc79MO2B4Yn3Fb4Q+6kAeMPnx8j6T3GeS+2i0j0b/nGi0zyT3tru33b+n7T6aSUZYkbWoPMkP12vubaWmqfdILWcwgOn7RuIP2UlU2WwFgbEoxyqlM4fSvFGf1xfHhmiZvGUeNU8XDeOowQ+P68f1eauBR+zjWH8V23FkZGmbSshbypFYTAdE8aQkKJcfuK6Zbv8Bez2xoJMTQZwSg+wggbv/HOeOrXzuOHADoA2/iq3E5/gy7cXZ+EJuZknwyDd1C4und7zSh6roO8196rhPHffhZx9+/jHhZ5867m13b7t/T9t9VurYeip1bD0jdWwxTLHo4pE/M3U0LfmZkrotRJ/t94Q67Ku6j8rs1bFineilssjGacEZKJeOXG11suSnOpFOzC50by5e9gFjPT2Wvupagot08NSJ5co79XDHvsLow1d1IEHe5AJwvW2ls8ATldJmtL5Fq1iOYYeAITkF25X3pNxyK4hubJC3p/AlOOoX7HEqaf2hfjAbI8UXSDHrfTOEQJuP+r+HRacE+nieEt3FRMr6geMCsmfOHSgjos/TohR0n6rvU/V9uN+H+39GuN+n6nvb3dvu39N2n5Gqq2zo4VQdBuycqsPYao1FudQ7Ohn+ozN2MhWFAak3cw3K1c04B6e8Ar9yLtF15uhD8A7vdulAfWB8cGeZ9yW83xzTQYlJ6NkwYhUEG799cHAHAgLB3Ff5xqrqywYd97ZquOuDm2aBu4kvWwCHZYby2HJn1Ff1RZXY6ln0ZR+pJS0gmawO2ccf+DwKX5/V3gIxTIIpJz6yp8d4twaUED/56lMnZEqORqBt5tn3T9HzofkYHRLIA3QUse/RtWA8Aywz5CH6n+Pr6Ok6LLl67lL6OH5glz//TdAQhzXYW8E9+uAMD768+vnj9DVbYoZJFi5viBQWlgRgIyNQEfJgHX0IBCdRUInvhuikjtmgxbCFDQSzT85ECHaVuMqejcEXE0s7qTtTPr/SkjHFjbAx6lWTn3ytDyzTOQAOHaTvWnktL/bEUiDxCUX1k6O/lou/epUkyq/2rjaaLp6g63uR+A8NrSKhVQia/zqDhWTtlSGPbRtgtgiC2z5x67sXl/AqCXhYN8EThJrFQV7sQnikD0cZWmrfjUcKXgXhpfH45HxcWUb2shx9J4O61KCPn1u4vvgvxlB10AyuliFY0XejdYuLVsgiKo1aAqWKXLJiVSAZJPwuwDAcqUx8jsGYchF1iSqZ5BeSLNj8F/qm9kuKZnp8BTETR5qu4X83zrhgBResSB/gK/xlSELFAttGGsgPSAXoxvInT6AQTfg8CavQqxP4A5qDocEAVAmKv2nLP7RjB6d+MXqBo6Mx4IJLdJWeOi6GF88oWPfx94O/q6uaZRcgy8E8vrYL4TDDN4lvtJeJIfKvRi9S3ImbJfg3Rby0l37Ak/x1/O6f5PH2nuaf6GlUdovqRsuqMiCp5DJby7fufLqGF/4Lb8lSKY2GIiW+KCcJZmPzAHWabNpYWYKK/o3gAWZ+ZdQrd012COkuGr9QN7ss6QM2/NKeQ5lm2XgROPuobinzsKLCw7YA9VdXlVYT4DLdGsXOtOAggVqvQwcv+AYkwjXjoB5PSBfvcAulE1Ifk0mE5CVh0Sxtkag2yAq6hFh4a3+4wO6whR+MlnZcC2Toq9YwMBIloi6LjAkZqyuycVw6/X4KNmhOZSXsDdZ04EEhmRKJFS770xxEAOao/QjXWx6oSf4BjgUgWOpIZWhWoZLDRxvXD6AATcA9F4H+K4TmW9Y/yyrSXdwI/wv/PU4qumBZcLDBDhYSG8oyRdaCVyVVC8LotmXiV4crYAa+uLvD7gZWRvf4mC6pgOef48KHCkZ9j1/0cfSDfHo1Vri+pv2Z5F8AVYiobsg527gWL8HPrwJLeJhHl47KHguhIl/ILkxiSm6fAouoqDKWV2/yB+Kx+gFkg8f5XzzcVEk= +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

+ +A Source object + +
Schema
    owner objectrequired
    + +Reference to an owning Identity Object + +
    cluster objectnullable
    + +Reference to the associated Cluster + +
    accountCorrelationConfig objectnullable
    + +Reference to an Account Correlation Config object + +
    accountCorrelationRule objectnullable
    + +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 objectnullable
    + +Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient. + +
    beforeProvisioningRule objectnullable
    + +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 + +
  • Array [
  • ]
    • passwordPolicies object[]nullable
    + +List of references to the associated PasswordPolicy objects. + +
  • Array [
  • ]
    • managementWorkgroup objectnullable
    + +Reference to Management Workgroup for this Source + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-status-by-source-id.api.mdx b/docs/api/v3/get-status-by-source-id.api.mdx new file mode 100644 index 000000000..4ea3cf8f7 --- /dev/null +++ b/docs/api/v3/get-status-by-source-id.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-status-by-source-id +sidebar_label: Finds status of source usage +hide_title: true +hide_table_of_contents: true +api: eJztW9ty2zgS/RUU92GSlC62bMexX7Yc25nylBN7fdk8OKkKREISEhLkAKQTrcv/vqcbIEVdHGcz2d2ZlOYhI5FA4/TtoBuC76JSjl20fxNd5pWNlbh2cqxc9L4TJcrFVhelzk20H11NtBMH5yfCqrKyxolyooQrZVk5kY/8Ny+hIglCG6fHk9IJh/GFGE7FydGbesjJUS/qRHmhrCTxJwkWGKvyksW9nHooeNqJCmllpkplCeNdZPAFY91sgCZwhSwn0SLikyMCNlsVA6z6vdJWYbnSVqoTuXiiMhnt30XltGDBpdVmHN13IvVFZkVKzwbx3uaLjRdbO8nm3qZ88XxjcycZvNje2Rluy8HWYC+6h7GciiuryymjvHbKHuamVF/KgwrIYF2dmH0Zx3llSrdvlUyi9zTNKlfkxsHgwDDY2KD/zWtx+YdMHBMKU5JYWRSpjtne/Y+OZN8t658PP6q4JLtb8k6pPTLv52U7LZq8HUPCI++JgzhWRSmHqRK3Mq2UE9Kq/XdGiK44PHt9fnp8dUzf6L+u4DgLcZUpyYEmSyGNkHGpb2FikchS1mpOpBNDpUywgTTJonGwmJC3UqeMYJTbliF7HsXJmx+Cw+TlN2ChUQ/iidqBV4Oih6bKKIxaj2agEUoI2FKXPMv7gF3gPRDd39P77VXRdZhqhIc4thY4uuKCc1slQvtwo3xRDlrlyVTAHtrAgzr5gZGVqBKmOMwT9Xh0vdJGdcdWakKoGHKMiQISb3WCGSLLYWAvss4YHjdvV1iityleygT6ev0OgzJkRivjT5BFnPQYoGujMV/UU4ROGn+uWFbtKjl8vrE32B4935YSFLK5uzPcG8mtrY29nb09Wj1TzvPvbG1prZwuLf2rMsrqWKR5DI/8CwYBqcD2DIAXJ24sVeYe9wHL+Ab7X0EvP7ZRM+AVRHUdIcXLw3OxvStSacYVP5fjBSOY7vUlnpgq5QTwTAzNveAzq8farIJSZ8DR8auD69MrPLk4/sf18SU+kayl/erAIFoTCktARSxM8s+MOCjwWRJtpjCHSnriWZD6rEn1ZqAOO93UwZiIrZGs0hIzwuorZrRFi5HNs7lUiv2+IJ7onup1wBd4lskynoihdJgAF9LwZ541u6fBks/EBJuGsk/Bp0miSUmZ1nyaySkECZkklLpewKhCKgOMLid5VRLr6EV+mZly3hszLjltO4WSA8gfj5ODuKwAjtVsZ2ETLQFi8A8we8vNo7tqGY1NOjUlUS9GplOY0VpYWAyhmwazBjoidzkQj6nHNYzVpkimu9cezFGZ87tYVu4b8u48Bf10WbXmxa0KyYcwyAMbsTdqNwVGwktSmyeHUY276sQXI63SZJ2769xd5+435u7iy4tQU4e3XPpsLpc+10aiNs8tb55LpY/l6DG5qAdxeRMc2REwSCiRfnt7hcT+hKoP49WXgtqLH1gf+a18CfxB4w//fEjlR+OsOV8QQLaj12AEJlLJPuOeIWZDeVNtLa/2KrdDjQA1K0pEsKYV07zi2tZWxhAS6ToiyZUzv5SojMGPaH2A1zMgrWqSbpFrU64ryXUlud6N1rvRz7MbrSvJde6uc/evmbtfrSQbVJwtoU5yVZZJO/WRFt6TtlJggKhPd0WTcuyqxWqFhImmxormK4doONgcbo52Y7WdyO3k+dbeaBA/H8id3c3dzeH2YDdq7/U3szxukmw+p1r+9n5kE6OIu0UdVxkElyvzPJk//oN5rRoRrRH1NHUzbA6Tvm9qx8Hecu14lefitTTTukJyczWkmdmIOA1jMxpr67EYIMUYvGgEqEoDF4WSzhSkWASNSHWmOXlJC8i10+7BqIQqPlHqIGtW0SZOKyBkJkhzqppzBJamk9sR1XyQwBXsGOz8A6vT4KI/VMmLC9L4lDQWx19ipSjRm8p9Z9X57gnAW+KIS+/gBw56fbcjDQIADYHnrKbuXNfn6/p8vcev9/ifY49f1+fr3F3n7l8zd/+D+jxUQw/X5xjwzfU5xvY2RFNLvaLg+p+X6ZwqAQGHt8jjuLJ83FzX4FxXIJTCfRq+P0P3T6K+v1/Q5fsIrn9XX6C574erHXSDhSpED66yKSZNyrJw+/3+HXwGX933ZKF7oDK4rZya/HMvzrP+7dYKBqKrAj7bwGFJFfPJM10e8ov02NJWUzB75uMFvN1ZNwpb2J/PiL8qny4EkUOnUEh4MR2BwA+BxY8Bs0BX8Yvj0T0OpCUdodu1Te8f0+efW1/Twwt5QI9V5vvqWhgvgHJBPYLfunB0SeW3X33p2tFsS6GWbbC02BkNG4iXSlr0Bv5XjCe/vb16KsZUdHLSV47qXaWpS0DanCNEmNQO6hN9msT7jM2r8YSBH8z9ZkJJJEYpFBbvzKVS4uYkGOEN2P4C9MwmpUmKGYFmvX9SeyZRtyqljbA3syQFnk5MHxbqy7l5T3nT4+5AG3zM+GnvnemKI01cpGnzpjFBRW72xE1R6yVben0viL/V0rpeWpeluacLKLxpb2J/BydGJpMImTq21ncv7uV1W/KolcITkrqIgSwRcMz/0hXXXvtuHHPyuiRvHsc783aisaPOTxOewITDhpgm4kTEkzx36u9CUOhQGtyMK2TRd8P6TIt2OSO6g40WpK5fsqvBkorxnSIxjA8mOaT9mcuTHJWbSXxKfmDPIuc/8HWvD3M68+MbbKM0Mslj992YacEuLdj1HOACfr9LUWAht0kH5gEfAIcz/zMTBKAtzvOyVrI6i+/zHNoaYkD1FwGLff9lf0Zw4ZPgFzS6GQMKpvK6+e0P30WQRVvVnLHqg4FFCy7jTXPskAt283ibgynaNf9s+pLGB7PzkzOTTn80Sz/AJH8e3v0/Md6aaX5GpgkFL4UbLxs6g3aQ+2pt+TSPjpsnCv/iLWcqV9boW7gT4xqmLaZIZUkxzTkdT7Tic4BCSb7V3KG4yjPOQ5S7lPzo9ljQ2GIMktahGpVDnUJeT7xFo2VimJiaLLo5Aakf89BtXcLK5+QkcVQ7DgVUllWGbhwDRJUJifB4xLuJdnHlSQg9l1G1ZjmXcc2sOiMpbMgUPW43bObORnRgjF605cRH1oIPXTgthiHJI+Gy/kyRC5VylNG4+fL7MdmInO5EpQW1eWBQFFOqtcLrk6sliRBmwqXq3I77YZLr01gIoVbHB8NWD80dPSpyV6Inbcl9hWRwrT9yaN++Xwyqu9k5+X/jbyXCFkG1fb+gkylCXPlew/d4N9Fcj4c5+60/kwhtHhqHCdSk0Xd3dJRBPc89PUYLT33yzftZS8OtIDxAn9FRjpDf6itaP7kIf13xVKz404uVCtQHcGY6670jfPykqGVv4KO9BW4+WWFM/rU/e2lNXPp1gvqkph/+9ZiCRD6w5YYP0B+k8m9+NuAw +sidebar_class_name: "get api-method" +info_path: docs/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 'Finds status of source usage' (get-status-by-source-id)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Finds status of source usage

+ + + + + +This API returns the status of the source usage insights setup by IDN source ID. + +## Request + +

Path Parameters

+ +Status of the source usage insights setup by IDN source ID. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-status-check-details.api.mdx b/docs/api/v3/get-status-check-details.api.mdx new file mode 100644 index 000000000..0c435ba69 --- /dev/null +++ b/docs/api/v3/get-status-check-details.api.mdx @@ -0,0 +1,95 @@ +--- +id: get-status-check-details +sidebar_label: Get the time check configuration +hide_title: true +hide_table_of_contents: true +api: eJztW1tTGzkW/isq78MkKWyDccLCy5YDZIopmGS4bB4IVZG7ZVuhW/K01ICH4r/Pd466226bS5JN7SSpfknstnTul+8I9W3Ly7Fr7Zy3TlR2pSMl9pS7FAfGq3EmvbamdbHWipWLMj3lrzutX5UXfqKE16kS0URFlyKyZqTHedgh7Ej8matcxeJk7+AI66JL5V1HiIHw9lIZca39RLzNxmIQpxrrM1HjHp7K3E9spv1MaCcy9WeuM1D0VsgoUs5BBDxXJp5abXyntdayUxUEOIgh5Vj5Ey997nZJwj3lpU4cVmXKTa1xCkrftnrr6/RfXb8/WHbetst6FZtJS3ww2oxZ/1JpSHUlk1wRdVqijCeicjpNdMQCdT85onzbcjBXKldZ7i7bL5U3Os1TYfJ0qDIRy5kT0sQCqsJSMhEjGI1tT9LUrKfnvgtuEI7twLoHK5K/p5m90g6LQGDBUAcFgyNtcs8qLS48kjeLRoVUFB5+NlVQwg4/qciHHXCF18HGn8loxSaVqoiFNCwSQ+WvFQIoaBQMQDIWEjifgQm+qxuZThN6tLneuntShxXeS+aHQ9gDCD5m+SjHXusOHL32/O2hYMIiWta/LwB3E40YEvtZBie3xbHyeWYQZXrEcUdeVM6LoY05N7SBlXTc+ZLwe9xlMcu4a2O1sLZStS7sG21UG/GmSULFIkfYKNjkMUVnajMlAkmyJKnA6zo1s8ESnQ3xWsbQN+i3WyhD1swkRzpl9lMCnRmN/aLcInTMyfIAW7Wl5PDV+navP3rVl7L37/7G1svh9khubq5vv9zeJu4pyo0cB9MUvGWWydkK61+VUZmORGIjeOQvGCRTErZnAZg5tmivUve0D5jGZ9j/FHqFtZWahbzCqxu/JqR4vftO9LdEIs045+dyvGQE0z47wROTJ4kc0iOf5QqaB8JvMz3W5j5RFBKEisne/pvB2eEpnhzv/3G2f4JPRGuldQwMojWmsLScVRN7zRIXClxLJ5xKYA4Vd8SLguoLKCSNW1yowzc3czAmYmsk88RjR8H9nh2LpMUos2ktlThvbrx4pjuqs4Yyg2ep9NFEDKXDBriQlr8YoPVMffuwsOQLMVEyVtnzDnpWrElJ1KvQDLB/BkJCxjGlbiAwypHKivufzb0wFr1R1X0xN2XdG/OScrjoFEoOSP50nAwin0M4VnMxC6toKUQs/AOZg+Xq0p0uGI1NOkNLjKCFTJIZzJhlsLAYQjftQ8OkSqbJ9qk05bqqYi1WSi53R0GYPW/5t0jm7jPy7l2C8tNm1aofrlSRfFy2QzVib5RuKioSfmQwQ5uLVZW7ysQXI62SuMndJneb3P3M3F3+8biA3cWvDH02VqHPmSlgPzXPFeiTcfQYW84GfwWUGxy5RnNEAZF+e39ajBo0I9xMCfR+Q3wUWvmK8IPKH+H5sJwUytY/9wUJyHYMGoxQiVS8w3LPJWZDBVNtrnJ7Y7OhRoCaeyAiqmYmZjYXEibLcsMzi3RrIrbKmV+8mEjUx3KQstUs1a6GqQZJNkiy6UZNN/o5ulGDJJvcbXL3x8zdR5FkJRVnS4GTXJ6mMpuFSCt+J22lwAJRHgCLKuXYVctohYiJCmO16sihNextDDdGW5Hqx7Ifv9rcHvWiVz35cmtja2PY7221Fnv9+TyPqySr59SCv4Mf2cQAcVfAcblBcDlvbVw//oN5MzWissan4iVuhs1h0os5duyvYsffrYduIAzsmD1wvHh2fEj0wZrJk91snkWKYHYwHZZLz5CSYhiW1s430LGBjk37adrPT9N+GujY5G6Tuz9m7n4RdOw/BR37XwAd+4Ig1ogg1j8JHWPgDoJmIzgFOkQ5zGsINk6hCj4Vp49F2nuZjZWvgF4NRfa2V1HkqbXiSJpZCZZc7STSzM1F5Q1rU1qblWvpiocYo0QagaqlgW4pquhOCTAp4kckOtWcx6QQ6Gaz9mDkoVXImTLeKi7aREkOCbkoJJbOXi1iTCOc1IjgHyjwOegYhfobnnEW3vqfzoPFMWl8SBqL/ZtIKcr56vz35X23BPgCBZWLk+DrB64LhDNzaTBGqJtpKF8VBG2gegPVm3bftPufo903UL3J3SZ3f8zc/QKoXqChh6E6Fnw2VMfazrqosNQbCq7/O2LnVCkk4PAWNmKsHs8xOIzgFB5qP2MmZ4D4uyGUB7mfUGbq2Oy4cBW4jYC4bEu6SL2Dssa1aPnXhYvCYc3F3QVpgngtLlBToZJEu9V9aKfrhru4bb4Y265dBG+RyIRNg1nyLAGlifdTt9Pt3iJaECV3HTnVHRRRBIyfGXvdiWzavdq8p/bRVdeQ56iecR7x7DJ4d1AMOx32caYpjULNZQbB42xVShh4nu84PErfyJRDaYY5SAQyawIpV4Q0P4aYU8wzvzhe3eEQXtERup1lyd1T+vx38zE9ApEH9LjPfI/ywnoBKZfUI/Ev5hF2QsA/cF+Js3kzoz859FaYvaVlPfFayQxTSbiF8+y396fPxZjgLpeb3BHSVprmEyTsO4QIl9NBeSOFNnGHy2w+nrDgg9qdH0pfMUqgsPhgTpQS5weFEX5HnzlGY2CT0ibFtYh2XTwrPROrK5VQC+7MLUmBhyTpwkJdWdv3nNstzyXa4GPKTzsfTFvsaaqClAi8plCRx0xxPi31kgt6fa0Q/yqptQO1NlNzz5ekCKY9j8Id8gg1hEjIxLG1vpp5oNdeoEdDHJ4Q1WUZyBKFHPWbWlHpta+Wo0avTfTqcnww7ycavby+TYSqJhxacRKLAxFNrHXqP0JQ6FAanI9zZNFXi3VNTNucEe3e+oJI7cCyrdtApizfIRLDhGCSQ0IGDIxsOKPhlPzInkXOf+R3Pj7WdObH5/TWDFbGNnJfLTMxbBPDdqgBrpA/9EcKLOQ26cB1IATA7tz/XAkKQRdqXqB1b1Vn8l3eQ60hgqhMxU13wpedeYErPgn+gVZXa1CCCdhXd9fwXRS0qEnWjFUeSSxbcFXexKI3L9ktyFv9YZX69femL2k8mJ/cvDXJ7FtX6QcqyfdTd/+hitdUmp+x0hRQm8KN2RYzyWKQB7S2eo5IB90ThX/xK2cqY3pMTOF9R8Iwi2SmifQU0+GVxolWfAIxVdIT8lujuLIp5yHgLiU/5kwmNAZYp2NwBzQqhzoBvY54jxHPRDAxjXd08xdUP9lizjuBld+Rk8Re6TgAqDTNDb1eCSHyVEiExxPejbWL8lCEgPONKjWzDOOqXWVGUtiQKTo86GSpezsqXlRccOITvODD8rVKGJI8QmibZqhKkWOVhEkE6+rw+ynaiJz2RCVTGjBRQQGm1AKHo4PTFYogZoo/jths3C02uS6tBREadUIwbHYwVvKbh9Z5TMMLdJ96fXY5sG7np/Tf7au3Ra+hIaE7pcM1Uj0PQ0uYIM9bD06QlKEPz5CYSiawIVG4vaUTGhqo7ugxFKXx//xiPi/RN3AOJzU8dF4qPiHgs5z5IcDqXztqo++v++R6+UAjLT4Qq7u7vwHYLX2M +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +
+ +QueuedCheckConfigDetails containing the configured values + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-tagged-object.api.mdx b/docs/api/v3/get-tagged-object.api.mdx new file mode 100644 index 000000000..39161680f --- /dev/null +++ b/docs/api/v3/get-tagged-object.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-tagged-object +sidebar_label: Get Tagged Object +hide_title: true +hide_table_of_contents: true +api: eJztW21z2kgS/itT3IdNUgZswC/w5YpgO8eWE/v8cqktx5UM0gCTFSNuRnLCufzf7+keSSDAjs9J3e6m+GJLmp6ep1+ne5DuKvFUWZno2PTDSqcyUsmlHI1UeDr4rIKkslVxKkitTmaVzvVd5cop24tNor4m3TQZ41lFh6aTyFHHKhmCPL+dSCNHqnJzf7NVwb0jUs9ZeNaugpFQucDqKS2PxS/H2gkgcEKKxNPGTCuGsRXJWAk3VYEeagwks6mqYb2ptHKiEmUdA9TEZyoBbatiMIA7oiQ5grGayErnzj/oVFxitRlhRJl0QvC6vd7RxcXHs/PT4/7JEQa6Z2cn/V73sn/6Dne97tuzbv8NXR69u+xfnhy9xX/c9Q/5/jdcnp/yxIvTw49np5j7G99cnfeOoImtilX/TrVVUHRiU7UqvmKxRDxcEj+JhVWAq25ZZvVVTqYRycDr3W+tlVuHj0j9JDD9Q4aCqwyHVUNllQnUw4jUsHkwbLearX3Vbu3uNQa7g8FBq9GSu3vN9n54UCGHsMpNY+OUI2CN7W36t7R8Sf7BzCtGmhCgaMGAnNAkNFFOp5EO2IXrnx3NvlsVO87d+ZFl2J0sxUOiPTT//FwN13Eqk/rRP8y5Fk2wMKUs7eHlKeuRrA/vWIO2TL9i/4QCdO4ErHnl4AwlF2gE7Z2D7YPdvYNgt9EO9rZ3cBXIvWF7O9hp7jRpee+jqwBMGkVyQGzWOeU/UqSVKmUaohGhdtNIzgQxexbS9zqKtJwI/CfHuQewRCc8tJgFDzHtPk9jBWZprZxRxkvUxK2NsDL4EzlQEUEQgxxQSHfSiCLZFtCuK6+vPh7333Xf9cjmZ70+EsgD8ICbhlrr4qiHVUwijqxFBq2Kc5Wk1mBd7bVFOUA5BFgczgQ0ps2tjHT4XRFWjotQJVJHvThca+4y2GNtVHVkpSaEiiEHmCjA8VaHmCEmsYXZmWVucKYr5yBoorYjXssQ8nr5epkwpEErg9/Bq/+EALgyGvNFPkXosNiJ1iyr9pUc7G23G63hXkvKxkFrZ3930B7KZnO7vdtu0+oT5Rz2xXV+VF76jTLK6kBEcQCL/AcKgdtD9wyAF1/jeg/YgHk8Qf+U8z1tIWaGV9COv4Vt+XXvTLT2RSTNKOXncrSkBFO9ulgJZEjuGZ9aPdLmsUR5eHTcvTqh1Hd+9M+rowtcEa+VYqFr4K0huSWgwhfG8RdGnAnwRTrhVAR1qLAmXmVcX0EgadwiofZ3buagTPjWUKZRghnZ6mtmLLIWQxtPSqEU+PJIvNA1VdtCrOPZRCbBWAyko73GMPmrbhCoaVI9yTT5SoyR1pR9WRPdMNQkpIwEohFMMX/GSSMMKXQ9g2GKUAYYnYzjNBEmTnSwtBfPVbmcVvM0crJoFAoOIP+2n3SDJAU4FnMxCgtvySBm9gFmr7kyussFpbFKZyaRAaSQUTSDGq3lrR+yaVSEWToiczkkHpPTFRlrMTtyunvrwXDyxlggU/eEuDuLkH6qLFoxcKuy4OPs7bMRWyM3U5aRMEhi8+SMqjBXHvgC1WsUbmJ3E7ub2H1i7C4PnmfdQzbKpc/OaulzZSRa1Njy5rlS+lj2HoPyKyPi8iYz5JaAQrIS6df3lwjs35UhevV1Si3TD6yP/Fa+Ar5b2MM/H1D5URirZAsCyHr0EgyRiVTYYdxzxKwor6rm6mrHsR1oOKhZUyIia1oxi1MhoTKbGkNIpNsSYayc+SURY4n8KBERzvkMSKuasDqNtUk2leSmktzsRpvd6OfZjTaV5CZ2N7H714zdRyvJAhVHS1YnuXQykXbmPS0bJ2mlAIHIz7FFEXJsquVqhZiJosaqlCuHyqCxM9gZ7geqFcpWuNdsDxvBXkPu7u/s7wxajf3K4l5/PY/jIsjKMbVgb29HVjGKuFvUcamBc7kkjsPy8V/KZ/uU1vhEMq+boXOo9KaoHRvtNSf1cSzeSjPLKyRXqiHNXEeU00A7IVqb04JAihHyohFIVRq4yJX0RIGLhdOISE80By9JAb52Vu0OE4jiAyV3smIVbYIoBULOBFFMVXMMx9IQUg2p5gMHrmBHyM4/sDrNTPRdlbw4J4lPSGJx9DVQigK9qNx3153v9gHeUo648AZ+4KDXdzvSwAHQEPicVdSdm/p8U59v9vjNHv9z7PGb+nwTu5vY/WvG7v9Qn2fV0MP1OQieXJ+DtrYtilrqmJzr/16mc6hkCNi9RRwEqeXj5rwG57oCrpS9qkU5hN756VTq/oWhqhfU1e/IN+7rdzq8r9A7XFQcelypjUA/TpKp69RBpwzMdF+TU11DFoPFkpmJv9SCeFK/ba5JPvSWgA80pK8wDfjQuXvWz1qMGivZavJjn/R4Aa9yFos8Fqrn4+FH+eevdcziFGmO2WzR+yuZT/FjwJyiofjFMXWNfWhFRsh2ZaP7b8nzr+ZjcngmD8ixTn2PrgV6AZRL4hH8m/krdxdUefvVV168m+8m1K01VhY7JbKGeK2kRVvgf8B48ev7y5diRPUmx3vqqNRVmhoERMwZXITzWTc/zKdJvMXYOB2NGXi39HMJxY8YRhBYfDAXSonrfqaEd0j058jMrFKapDgZ0KybF7llQnWrItoDa3NNkuPp0NShoboszXvJ+x03BtrgcsJPax9MVRxqSkOa9m2iyUTkPk9cT3O55IJczwXxt5xb1XOrMjf3cgmFV+114F+/CRDExEJGjrX17MU9v+oCP+qi8IS4LmMgTWQ4yj9yBbnVno2jxK9K/Mo4Ppj3Y43NtDxN+NwlHPbCKBR9EYzj2Km/C0GuQ2FwPUoRRc+G9YUWrXJEVBvbC5CqfsmqrqI0ZHwnCAzjnUkOaGvmyiRG0WZCH5Kf2LKI+U/83uGnksz8+Bo7KFGGceCejZkWrNKCVZ8DXIbfb1DkWIhtkoHzgHeA3tz+nAkyoAs5z/Nam9WZfZ3n0NYQACpzcdOOv+nME1x2JXiAqAsapGCqrIuf/XAvMl60S5WUlZ8JLGtwFW8UY3Nc0pvHW5xJ0Yb5Z5OXJO7Oj05OTTT70Vn6gUzy58m7f1DG22SanzHTZLUuuRsvmzUFi07uq7XVgzw6aR4r/MUoRyoX1WhZuAnjGmaRzTSSCfk0x3Qwphfa0TZMlUyo8tsiv4onHIcodyn40egxo5EFDYLWoRqVAx2BX028R49lAqiY+it6aQJcP8dZo3UBLZ+RkcRhbjgUUJNJajCXYiydCAn3+IZ1Q+2C1CchtFtG5ZLFXMYVs/KIJLchVdS407ATdzqks2K0oQtG/MZasKHLDoqhSLJI9o3BXJBzFbGXEV25/P4Wb3hOdayiKXV4yKAoptTCCm/7lyscwcw4yIVOOrajejbJ1YkWTKjV8c7QrKGvo0fT2CVoRxf4vlGJKH2PsuxJd/Nz8Wd9mJIlfqrY61M6aiIcqe8gfNN2XSk3bZjUyT5W6eiQ3ukfAzbR3d3RqQT1MPf0GN04tbzXN/MWhVs7aJSu0RwOEa/Lb88vCvTiPPv446V48lcnawXKT9jMbN5cV3D5u6KePPvY4DuQPf0TlGfAg5Lv6bMcf6bDKvQD/tRnYcrK7yLUphWd+Jsj8lH5wI6fXcBcyGn/Bblil4M= +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get Tagged Object

+ + + + + +This gets a tagged object for the specified type. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-transform.api.mdx b/docs/api/v3/get-transform.api.mdx new file mode 100644 index 000000000..644657877 --- /dev/null +++ b/docs/api/v3/get-transform.api.mdx @@ -0,0 +1,328 @@ +--- +id: get-transform +sidebar_label: Transform by ID +hide_title: true +hide_table_of_contents: true +api: eJztfYlyGzmS6K9gORshyUtSpCRLtubNbLAt2S2vdayO9uxY3iZYBZJlFQvsOiSz3fqo/Yb9sc0DqIOkRPp43S0ZjphpsaoAJPJCZiKR+FRL5SCp7b6rnccySvo6HiW19/WarxIvDsZpoKPabu18GCSic3IgYpVmcZSIdKhEahuIZKy8oB8oX/Qm9GoQXKtIHOw1L6OOSPUV/LgJ0mGpSaykL2SWDnUcpBMB3cfqlyyIoY9UC0+GIXTEgzZr9Zoeq1giMAc+gDNQaQ4tvBzLWI5UqmKcx6daBD/go8CHVwFCP5bpsDY9pYM9oftT84CRYYJxoK4VfG8Bqu2mcabqtSSdhNhxEozGIX6gPo5D7cOjvgwThb8lvdmtbXj+zjPpD4Yfrj7Iza0Pw41ee3j1YSiTTHkIV+IN1UjWdj/V0smYOoVho0Ht9vY9DpyMdZSoBN9vtFr4nyl65CAzWksoh849HaUqSrGZHI/DwCPMrX9IsO2n0tiA5eM+4cxAoXsflJfO4Ooc+o/VGOCCbqkzxJ2MRAADxRF0M2kIHQsvS1I9UnHDV/0gQlJaOJsVfL5jGtV52HpNpjD7XpYqYr1xjNROA54/U3MaT9MQXkTBL5kS+DGTFVgnLbFIQZrzYKSSFH6Jcy32ZIrjj4LojYoGwCW7bfglP9pfT1u3BsiFECCO8AsaPidPzrcIQ5SNcO7S83QWpR07aXjVk4na3tpTHrKT/bkfmZ9ATyAh/+EH2JsMcXwA/oUeAfcr8+slDEkf4o9Dy/UefKMTtRdIADcFbggPZXyVIETt7a3xUEfYvh/ESfqTDEls4owYPPCB3iCeZVCDyFcfgWvgr0Rvtre34a9QJulB/jxU/fREYjeh1lfZmP64UTH8N0IAw+BXdQSEQggAUb4edcLxUB5lwDmBlz8s/VZ9FavIY6Ech9JTnTAsfuBfwWBoBk2A4xEHCXIqNk+yXk4z+C+yQzYeEzxZguw7Uq9UhHTS9CwDFLwvs0wFteojs/ye9pL7BPPYUh6nmcUhvBym6TjZXV/3Qb+EyBnNRAbhWIMUNYFI64EfrfvQ7XrOP8m6Lrq5va1ICspGFoayhzCyhqrCcqhS2QDYpZA9naVVXdcUQOtMJSDCLC1hkKQCWMkqcw+1YTqXqeFFTwn1UXkAiE/qOVJWkQQp4WwOk0/rmLI+SHQWe8QVZXVAv2c0QunbhVLZETnz2Plwc/yVKBl7QwFzohcG5Iq2eKvjK19OarfTUC2lDwp1BL3b5kJH5eHMogOralPQMpsMdRb6ArjNY81e6cU0Knqjt9dBEgAfMDGVQLZm3dwH8aijajaDmsnzEtCsTHVv/6Rzen64f3ROs+WBznRcouFSk75GvsqVMKisfjDImIdxmZeC296BHMAGQC9uhrCY+bimg27Gr/ErHfuKmkIrRhksMQbQhJvAZ8DCyMajLEwDmJkAFRYHpGyKuXpgfgDrEvx9CV+WnlUnvwfzU6B1YbLF7Htah0pGXzZ901isosyuk+mw1hQvYM2OdZgUE7W4SQCKOydnZ98UB30R6VSYlbc+ZdncBGBQmbkijmlYsSrt5HjItTKSjFGTI4h+F8g5JQK8xFXjTRBd/U7YuRkGIBUl0TEMLU3P/ViPSKChi5ypmgKxQyP2QznAgRJFrUltTqGqbOKWOsWftEbmoxthQ8VZFwqtr6AvghS7R8VMJOGfZjTG6D3Dcf+RjhrYAY/+RZT9DDq+DEKQsmVEGyYCFi8YgQlSC8wtFCuCBhcZtFlw/EjGsb6xuhW+hkETVG3LaIZ8OeRFosnAlYcF0wAVhM8SwaMg/8qBDKIkrYADdMdhLXL63BkhTIY3coKLnxdmviqrRhzA2j11+iWjiUAbApYreFwCJuG+YC2E1btHBm+AEIrO0V5h+dl1R30ERkFQDWrQGAMUSvCRjqNwIjxY4WAO5jUu6wUHJyT18hrwgy92hWiIbgTdX6sDA2sXHuEwHcOd4N/gR34A9pCc4Jo1/QU+o2+og1CN4L8JflRIIVMMJmBVsUIeLy9E4NKIcvuKmv2X1SqMTbDJ4jR5Cz7L6mXtyd7+m/3z/b0nl7W1tZLaPeHVfvKlnAm/iEOKFR6paKifLxeA6ZEa6Xjy+/Jmvm4ZyVAp0B+8ZOTJ6bV9iuqk13ga1GvCsBaMBj/gb9QKzIlmfhWSrA5inY2TJvqICBUMvPpppeMDbVdu18Rvv4lQs78o/vY3sdLJkGdXiDzGXktOYHztB96p6sOv4RKav2MZaShRbfrokSpasXFJm1JooR6A8WmsoB5irKGwOS7OqGbjCSlbgwLwflK7UlqxRZsPIRNgN3pAm4XasJ6brad3zPEWHZ9xlpYme6evDGRAjgEfecy+Wtm8QQx48A5jB4EHo06MYucZ4Bikv8xKZxVMnyhqLfIqrnihoZa49MBSAfO+BmTMXytSeQUDkQRgk3xxK+m/Al5WbMwPVigAlOtAUpsLCs5I33qlJyVDnV2SHPE53uZ4BlWvZsrQZs/0ZxMxKBv/tTP6QY6RJSBT6RYeFb7IlHc9Tb+qd+G43HH5A+byPGjkuNxx+SPk8jwWel80iTh0TizZPC/BH8dygqHMVI2SWX64nWF+MPKwCXIptUEj84NGT1APSADK/Pmu9loPUYIE/O9sBFZv7b2zo5zsPWDZK20/3CeAhVOEK49OAvQCX9jmuBGgBrL6bEZYS30sEeb1aCMkSAC/GPgnZ5S5pK/DUN9woAKaZx44YOTpdSkC3hHqF46F/9BFSYJ35kWXaNi17yg2TnsKJoKZUFw1SwFRCfanWQjz2H1ToGeHzmVX/dI1fho0CUyQD53+a9xwKQFf8dWm4UPpmUXmUkFZBnN2x9N48yUnlnQEahUTHqtARA9u55Hv/yMUMxGtGj9xqtSp0oeqSqt7t/epUhrK7FMnClWw+WH1yZdr2KLr2X1MwzJFVBohptQMHSUBbk+snnOo1XDQjRUOs9OEu8BiiKTDz608lNR0HrdaczuIbgfR7SC6HUS3g+h2EN0OottBdDuIbgfRuWvOXftzuWt5Buj9OyvU3Hw741Z1rOnK3GwYGR+oIGdkS1hxRonme/nYwrgZvQxEuAHiiTPyUajxJTGGXbwEqaAR9owLSkIq4gnZAaIEIQn8HaSWSZKNaHnG7+hT6Org7PjZdqttBn0y13M7IrDA4uJwW4GyO9Tvb8W3gv/9RpnZAnO1xQlQU8URPitaid8uo99Ew/7LmzWm/1WfcTM7B5E3607gX+PwsOH7K+crP/64OxrtJknz7OzsH114jerdNoIFKPJl7Dfhef4Pe32z1zkRpX+m18ND3//xx9EIuvtnt/Iae6VGRZf4HPs62T8+ebP/89nxy3Pb1+Hhuu+vY4/lXsp9kS9umOFEaTTuzzQ44bCggPlE/e6fHL/48efzg8P9n193fupAw7+IUcISPAr8CLOo6+K1jDIJSrKNZmn7+U7LDAC2DrMUjcQsjIt3KMe0WiK1cNEAHRFwqGJx17OAvT042txAwMj9hFEouNputaIFvSF1PgtQ6LMRyUgzrKXxFg1DQNeKjH7DG/AE6Qn/KdEPfk1hvfqEplvNNy+3Lmuh17CQG6XA8jGtku72qY3Xh04O2NwpbWBx7AZxMWYRS8REZ3ZtQZMEWAexOK2H2N7huDp51mRboBeDVhTNgmjmB32KnKTzhjJDsJ2BmmdG2+E6MgRHAF7CEsdWaFOcYjTGWsQzbZIJGCUfYZQBGztgviCpWSoAG6QH/350fL6/OzWJHPAEx8T/EdAIRBVwST3C3wB/WoB/0TxrkuUTKsYPH8ipdoJtN1qtdqO102htifbGbuvZ7tNtbpfzZd7dieRMfNKD9PZX0LYwB4HRNwzPEeaDpFiDZzCCqGiu4bTnK9VTsiKn9OmM9uT3pNCah4dN3xevxIpMV4TVleJXVJRdnFyztdOEyXX2wAoopniyd941vezv79fF4eGhgDVnZQUV2m/iLS5Ar7NQbMEzFGT6cgidC1lVm9SjODm0nwzFil5Z8QCFVytC1sWv8K9L3wnNj+Hjeo7LPTkJUawZD9zHf9AwdZxDVa22eKg6Ql9CAeLg0KDh1SsxZDClxGFbhAKYycQgYQpemrxP08eeCgTi6mDwsEWYwI4K/AHLtFo5DMWq8s8qzAR1G77dam+0nj3drja7Y5HjoQvGPLejNjc2ny7Vwz/+QQvl3V3s5n38F/xrrLxdublpZPOWMurj7cZOY9Nq2VwxjkZ2Dazd4k467yf98cZW4Wrw69TY2s7qclaXs7qc1eWsLmd1OavLWV2Pw+pyUVwXxX04UVzk2FLezL2ZLsYk+dxUFyo+4HJdXK6Ly3VxuS4u18XlurhcF5fr4nJdXK6L85Kcl/QwvCSX6+J2Xdyui9t1cbsubtfF7bq4XRe36/Jn23VxuS7O6nJWl7O6nNXlrC5ndTmry1ldLtfFRXFdFHc61yUvC7PcTpDJfCnlqgDCzb5IE6Upv8fifvM4/5tfvDkvxO0MhveQ6CEu+MAN0a7IS8+I/yeK7Bzbdj9v+8Y2QRcF+BTXMF1p/reZ9q/mjT2gfIV4Zvi/z2leDP+q1OouCP4+DUHJbHuDxhnMB/7/1Tn9337VEHtz7op6lZSU07hO4z4ojev2zVwEx0VwXATHRXBcBMdFcFwEx0Vw/mwRHLdv5qwuZ3U5q8tZXc7qclaXs7qc1eX2zVwU10Vx74niHsp0uOAEdulymq+8uKbifxjmrC5NuDcHiwsewwKiFgeYdFQXMtTQ+AZ8FWoIy8qw+IK+N9e0N43A3nd5PS1COHmxX5zaq32b2+vXcU4NhO8v+ftGfh0PykyhTCJ982/tGzpEBdT3L8ZLqY2ZU3hWedyhO4zWoCFENkZfztc3ER9Hk/wcKdNd71ZPjZmjpdYeKMjNF/5cRuYI6r2SVTqD2iW90uW2XRSFbknx3Q/0atBUzTru6UUe1yfAA7jSM8oEkb5eZaK8a585jGYLyyW8FFkUGAWJmse2WDOQMZjLgUaY/Brg1qoLzF3Hct0649aZh7nOKGL6RO0FEs82A/uFhzK+ShZuHjqWdyz/IFletbe3xkPQ8wtZ3LDFqRosmYWyFK17Kj/pXqJ1TINY3iX4RJSNehzKMEG7PFBLi3sFvFliwxpaUPjijI+eF4UVCO3xxHTHoQ4OJtuyQfRe4D2+JfkDa+Pdwdmx2GxvbzfaYPiNh7KxYdq+X7XWmYqaN8FVMFZ+IJs6Hqzjr3Vo+DM3/Nk0nFpfaxdn7tC60y0PVrdQBz/hZZoLHLff5WrgUk0K9MAMa1PYk+qaYIGtSqGJd5+mEFTBQcfDtDyxB3PwUh1PajPltWpJ59AUKqEHt/U7SYFYu2es46tUzukfuTD6im5/PBWGkrN9K8CBnih1sHfvABhWCgaRjtV+HOs4WUIpSUp2RM+OKzixiooVOmyoRzBCrsVIX3OZMRa9CJxkI9eYw4iCjOOJ1TC4QtkRR1ht6ERTpBk8ZU/Rt2viBmP56KF7XhY3F2qk713dVuQ3zkJV3bG8R4ajuYXuoiULzRVJz+Waaq9UBAB6AgFhrEZK+SS/tPhe6ytAVm9SRW1lCbVdvJChl4WsUE9xXo+K0mVNbGZsJrkE0Wx6ekBXlJp6UkdkbSXFg7Ox8gIZvhhKehqqaIBXp38FwUcZViLjKlY9ZSuMXdZehDrzxZmKrwOYrNhTqIno6uiLNAgBHZe1CokXfl+7LU9xufzpcukrk3kvugNELZDtFBZrPTqj5t0KLPO+YCOmgtVlKs1ZDAFqTNrDJWWFX9ZQd17yfcvw466gmgEFvq0woK0XFuUEzqHH3m/nE/xPAHDC8AgPAJJeOh92w5bLMSD12McKcLh/SUFbcj6Idng8wRDTz+s9FtqHHQXaGhV7JrRppbUw48ii9ChbQ8LSlNRNQPhjMMpGwPuhvqEtSZPokoitp63SBKfcgXbrkWutWcH5bPWVgbH5vSml9NQWiLVV6nILbVo73fMpAoTY+6zV+kwGIVld4gILtlI9vlXoZa26d5KzxM1QJ+VaqRS5T5CeVEIOq9SBuCBfUb3bvpK4E1HPMy2wsCp22B3JSA5U3BVXanKjYw4gTIDQGLPDY01aX2EsHj/GWrIrQFpuUkTYB8rkg5k38M2sDDenhHDDe95+1nr2dKe12d5st1ut9k5rq9Vrbfc3t7aU9/wxi+i93PO+bDoGM+/v9wC/znoEOZ2AAzcSqx60CBueTBSwYNmUnKOcUY/HfNCiQmE1AqZ+XGR0gZfvKvACHKc+gs+2oGB51jMSNVufPH+1zGa5/bhakLxu/jZ7ksip4IqjdqYKstSCq9OW6wcT6Ja/uZgwue5c/9zWkzaGm1+MXS0RKrEY6M9Ohp0MP1wZTjRuDizclunnSfQL5LRE2lJNZMC8MmSzGxl5qnxR1Z+CuNyMMjp3TfYB7VtsYMHl8xvdyB2X6nbJqmoOmnWwoS/OLmtrfxVpyX60+y/GAaKEe7u9Aw5aNgaGY9vQjrZJow1jpZYYrwMDmsbg72JYhFuT+0txofktn221qGVVqdBknVJxSuXBKpVQ9dMTuWg75q7Y3rLBFVA1GIdHX8vcPmCO5BhXT3BHxSqPnGEqFuRdFnK3RdUYELVL2iPl5L3qvgLu5OZKIz8KVD7/UD4ThGNiKXRK5NPsLuo5E/miBDMYCIYM0ZiRwGyrlzXQO2sl8BBpZtZTiuiRhYGcDvq+dJDWV9l4gQqikxqzGogfz6H6fZO+gyPE67PjI8E9IM9eqUmDBWMsYY58KgUe5vdQGR+HLpuiCzjSVI3GqdmNosuOOJEl5526jTUVAV78UVF13GFZwMztCqZUi4HAdG/Czk+eHIHd9uSJDW9Zmct53CoabM1j46Gmv7KFFeXfp2hHGRsI4+Ame1b2cPfVMEvpGifmUeu6zeFmBh5Nr+gqwmxTTscB3WaXgCnho5mNxxZviCDb41Tg7ROac6i9yG6TqEZenuKD/cN9PCPWuTjDtyedF7XylUhVQIg5neZ0mvOBas4bFbtUVMfej5O9sekR+v5h8Kvjc8fnj5XPOb+gg9GkI45CLeT1z0prYGpXPXCOmE+sE5yAhK2bhGrg1iLjoJQAYe1T2hE3d22x+fmEb/nknm3KhxS2YKLN1EbSAW8hB8D7XiijK9ueK2uYMMA9RTVmneZ8W7m7udG13X3DBIzu1tNW9/tJwXCq5ztUPU7rOK3jtI7TOr+b1rFZQwuCfvNS95ZOSDvYK+VzplOJ5GNkYnt5bYkeRGPMLbuRfBczXdwdpMMgwsex4MyD9I7k8n3b5Xn+2smpk9OHK6fjUHqqE4Z/WHS+U7rzfG5Qfl8CtfFvw8W5uJuCU9UcJOR8JCF0U8TizTQpGddYG+Yzvq28GnVuAFQCHl3W4I8V+ON//wdjFS6S7CT9wUv6AjGPwZT/SM9ygZkVev5ouTXaHPiWVuxQQAV1kItvEM1ZlQ0A1Ry/d/8tG792Gv98X1tUQueURvghC0Kf4orV0jk0frvVpno5RqyL+X5WNvwczTK1u0f5ikGa+XzFeozSW95dpD1/g4kENFgW+dVZC2dhOL3zcPUOlhJ0CUguAckpIaeE/igllACq510HU9ZAvgqDUZCSuUBHEmaVUfHJZxk/5mhsLn2FvJWsoaJ8HbstQcJVcqaPuhfxxz6/6cVKXgmq/weDpTdKgUd0o4tzEnmOT0XnVKS7zuztL2PWLdS0XH5DhWwUyX5qBLyq8oYST1sCrEQbZm1JJZL/yllD1AtlbbUaPTzdZRK36sCnRofjUZHqaDdFmR48VNJi/jflq+/4qF0XKvWqNtdTKoExjPXNMgehi6KHq8jz66RS7HlIFuNZnUcqwBStKCk7GjQqHZJBjLIy4dWK6yJGBnhAkOZbv3poOSZFDcqYyhajOc0oslUAKTbG2sH0kcekQxkP7C1rNnpvVSt1YjPruTgip9XPVh60GWEHdCYpS4/7PxBseY2Oy1q1lOH9HUVZGH7RcsfFRgpMAitxX2VS25CEKwnilrpHsdSlMIF5G31fVH1p4bn5vKgSqW/Kr7XJovnNHbHOBkN42w8+Kt9urBUvPHvPITAPywMX1Uecd8BQhf/8pELtIbOfY5EiHO6NjAYZFm6vqG0e+l+xhD8FJheFCc4IWUUsX8BnGa4ReW2Bb1Fy15Dkuw8fVvk0P296P6v2FFa8muFUflygzZgkczh17gHTkkem83IjxkzKl93ipGm+/HRp3C6dVGPXrNGeq3joOyzvX4zUynGcK77qUtSu50f7cD6bdPCMOjru92G4paZLl9CUzTNbZGnuJrymmsNG1VqYrT4kS4OxQZxSQojgmomo+suFHXQEKp7M1qBvujNautGeSu7enDdZFfnfiKZgWhFNc41/B1WBpoqt7UYblVJ5RUHyyTA0NmRx5HluAjxJFe4iDqgGBWMUu64QPR+5jIrtO1Dx+1BdVdbAr6S5wWWBQf49lwPmsvt3rSCd3fVw7S7obuQSmB13P07uzsZjl5/v2PvRsnc2t2Cx4+6S7/a+jMRy9tv9BfsIsVSjF6j/Zcl+F1HwC2DvYI8nWj4xWvH+Nzx/55n0B8MPVx/k5taH4UavPbz6MJRJpjyfJdTAsZhmB3PIVMl5xn6KYngNL1ZEoYKQFNz3siTVIxXPvl9IFcT5HIyfKukjPWA6W63WbEzjRRhgkJuKM4uGOJ06XIy0UZhJrf0J31h6jZVeUEox99okQEiswuKRVK9/SLhaYeIN1UjO02/TuyQpYOWF9tVi0r4EvdYYYMo0MjeBTGVZWD9RVjjeT8hdWj6n76qBH8BEsy1+kL44NfN7YSaDTAuOzxX0dbA8r9kmIFP5/sacYdWOkr3t1vONrf72lpQbz7baO097z/tyc7P1/Olzqgw4AgmUg7k1zatD27rFdNVh8KvCsLUE3HO9chy8dmcZ9Jltc7pmcblCevxtPk0Dr0jVRzzNLn54cSK2dkRoAm6wOkxV3lJR4+IMnmBsndMBbWVW6vg4DqqhmmK73VwOurf/snPxBu8BPd3/z4v9M/gL+3o/d+eJpFKTS2uuvrQTuJEYlAkBHcpviiem1ycwIWkqjZkP7el+LiBohA5amNHntCh3XQ4pMKuR3HxM7Q5LD5/xCXqzb8VxpScdD/c/GjZ0+UQMQZRVvNYUnXx9tBWXRnJCeVO+X9xw1c+wMibt8OCeD6zjwXSGVIHKKjUKPfKmTBQUDoB8iU0/L83w/k2qyV6Swpxb8i1Ge6mVueizAt15CWmEUryL1EtN/U5Px1hYX/TQTAHrw6gjjrWNZGS/yzVWeUEidXfIwOylmt55Ei/2XSh3JyGonwZNLX9xrYzwUbTEWEuiMGOsRrL2FjYu7aqVBSkR/UCFvpNdJ7tOdpeU3emXpyoZgyzat2T6tGdNn4tIZoDfmBbPGdMnVuz9CPsROy1MyDqaa8ZEev32HAT7SlHwGtwwNGW/oX3ES/kM8J2cHvy8Z/fA7NJf0AIBJDzyDPqgiZS/S3AXEBOiGFWbs6O91HEvAAaN5piIWDyZknHxMuY4i4yvURe+Vkm0koqhBP0IXhpegG2LuKjIb/COmLMknSXpViO3Gj2a1chZkk52new+TNm915LMoSJpMXZSko1GMp4wp9mCeHiZnIAPMKuS2otc5IhU09YKdiZyG6tWtRxqvY12r93f8dSWL7f87c3n/Q1ve0M+3WnvtHtbGzu18lr/rpDjXMiqMlWiN9OR70dQMZ40yiJgriTV2q9wK6I3Vn1Ua5QPYO1mwHkTL3bIbcetWdvxSKcwN7xeujFTu9D2f3H6RtAhcO4e8ca7Byi0XICRouFoUtKOBJ3VdqajMx3d8uOWn0ez/DjT0cmuk92HKbufZTpuLTIdtz7DdNwSaGLRUfA/0nT0we5A06wfYMZHXhgnP95qoo9G7FM8PJTmhl7Fitx4PmtFnmstDmU0scZSUolERgW6UL3BtyP8NrbfYqKyGICKjPBavEBznm0wUmiT4gEBPqnnc01v6DeeNDp0FI1lpkj2NqOYJPDyxZAaeCzAQ3V9NP+gB4qDDkBRf8MYp6HWV8WDxSkdicAZ00XICmU+j/8+nZclcJBnMDCt70gX4Jg53sIXqY9jVl+5CepMdWequ+XeLfePY7l3prqTXSe7D1N2P8NUN9bQ3aY6fLC0qQ7fNlsit6VeUvbm722xd0r5qHz23Vyf6Rc2OCAhUfAQb6HGQfDq5hfMyp0M6+tgom60myen7saKSvZUH/KlybX3mJc6UsCZOD8w+lElSeylVj4B+ynwb2s4LhqYPLfqcdpPQHIg9W1TjoOmTV6O9A2dqb3enKPAirpboAL9zCMHpHNyYDyWJhGKz/6y4qQBmGz2epj86O69/dtSolQSlLupC5Abw5dcKVSPxuCUrCT0ddPklE/NEeZ2EYe3i+bz0+Z98+BO7pjHPPTdOxZ8LwDKqenVON/YsskZWu88+gyzFCsS7htszAx2jJ9tiB+UjOk0JqbSrL5+e74mBubOd9+c8c5Lo5wAi5BO7Ni0EmxUOiWOgHcqiTsog6IfwoTFZXSmlHhnr6g+gsXiFLQ7oRQbKVIo2Or96jKHuQFD67LSbo3WTHIugoiPLcLT5mXUEHsBqjI86U3fmCny6cl3YzsvWZrXlwLxF9tbg3trUG/J2hQUjNp3HieCe6AIsAsZJoStLx6c+2uU+kNPDJ5gr9MwICYMHNV0K89S7YvhqPTXwP6qcFxGb+lkTLWZYIVlD1YcCG+odaL+XQhkHRSDd4MMpOiLwaLjOA2SiMZGqwRSg4dsBA0wLwm+NyAYETOT7OHyTtaN5kALiWSXKAsy36XjNt3KnOnxuyAiqLHuwBfDjAM2cMAG64DEwM+LXMLXoeIcSA8wA7wo6E+awABa0nnc11ytTt2vUxtcGjwAlW+fHu/yj91CwdlKLvQCv86/ARVco2NCJgENfgvTF650FWTZuMI0BmfhxYM30RTeGN58dxQX3T/bfHHGnSL8chyFk2+tpe/QJH8evfsHaTynaR6jpjH2MrIbDWscizKTs7U2GwxM6JAm/D+8Tbi0CBjm4PYUZbnK3WApG1vTTXrDQFEYYawkldWuI1/pEcmhOcmnTH2vAR0miwFgCY5fEEJ/TfEWazl4gGL00TB9F3r9oI2zlh9UE3uWcGBAjUZZhAcGAQi8pQLYYwF1/SDxMlZC4LJFys5MkxmXt7ISiWyDqGiStwJOwXEf483gytYWV9UxYwENExNsBkQiRSI+21lM5FSFXGqntmzFHts3cE5jqMIxeomgQcGYUqURDg/OZ3qEziKzw6HjwbpplKzjt9AJujrMDJtN8A2pjKhOUvCcSv0W9YZ6E3GwN81Hn4rIOtvtqE450SaZOixq7z/I6wTylsjBHmjIjtHpzHp5E/TsbL5PSkcA7XFNoiquLakZlMjGawga/+tjjHzhlDJ2Rtjpe1crnD5osMt3Ogxh1vju0ycMjKALdIuPf8kUet3v3hceDnmGQBD82y+dhbwDI6vmjKq/lp8InSqPCKiKUZbugt5G96JJ4djX4M8rhfEAAB+8ZpgABWwIOH7BIZ1Sk5lNj4pf/GofmUfesRSbPwARoGz+D6vJTEo= +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

+ +Transform with the given ID + +
Schema
    attributes object nullable 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 + +
    + +string + +
    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 + +
    + +string + +
    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 + +
    + +string + +
    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 + +
    + +string + +
    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","enum":["LT","LTE","GT","GTE"],"example":"LT"}}>
    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 + +
    + +string + +
    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 + +
    + +string + +
    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 objectrequired
    + +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. + + +
    **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"},"additionalProperties":true}} collapsible={false} discriminator={false}>
    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 objectrequired
    + +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-usages-by-account-id.api.mdx b/docs/api/v3/get-usages-by-account-id.api.mdx new file mode 100644 index 000000000..1216d6d0a --- /dev/null +++ b/docs/api/v3/get-usages-by-account-id.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-usages-by-account-id +sidebar_label: Returns account usage insights +hide_title: true +hide_table_of_contents: true +api: eJztW21z2zYS/isY9kMTjSjZsmzHmrm5cZyk407S5PxyuRk3M4VISEJLAiwA2tF5/N9vdwFSpF5s1830mlb9kFoksNh99hXg4jZyfGqj0VV0nCS6VI5dWj4VNvrUjVJhEyMLJ7WKRtHFTFp2/OGUGeFKoyzjzJZ5zs2c6QnjYXaJs5lUVk5nzrKJNqzg1rHdAcu1cjPbi7qRLoThSPY0BcJT4fyaL+eBB3jcjQpueC6cMMjdbaTgBwzmjRES2Sq4m0XLvJ6+Qp5OX/1Q8QUjjPi1lEbAis6UohvZZCZyHo1uIzcvkLR1RqppdNeNxGeeFxk+E5O9F5Oj4d7wUBwN9w8G4/3x+MVwMOT7B3tHh+kLGH3r+fi1FGYOywQ+M5lLt8LXO/6ZqTIfC4P8GWHLDEByOmDa+1GdC8Gu/r1HQJ87rlJuUnais0wkSIN9qFH59GzmXGFH/X4qrkWGmPYsl1mhpXK9ROd9mao+L2TfBjpxUtOJF+g+JyXl2qDa4M+cNNNrITbhmRUNXAb7O2sAhHXFVBiY6cn4R3sDeJBLJfMyj0YwL+ef/d9EJRUTDijQr7tNaOrJxIpVON/TY2AbEHQzwSZllgVUGbzogS2XPMvmzBYikRMpUnYj3Yx1SDsdBL7gU6m4EzDf6HI6IzpBMV+NOn6HMmr4N4NfOdCSi01YBx2pw6QDVAH4Qhdl5qEUrPOf+EI7nsUnOLuDkBZaWcFmgqdg/qQHHLjGHWYcKOoyS9lYBM8AzclJrTfAj3W8TXTYjUCopgoQS0FjoDOpEpwHYlgHHg2ByiErzEeohCs249cCHoOOCBwcL/OCJ66L0kCcMwI0lguVwsJKO7QUK3DVDhH5B0neQZ6I22uelcKjgKOB7dJW3HwVFrQhJI61zgRXUcNOaOZGW7HaUMTeHF4b9ogQ89gKZN0BV3fLNnYO1GqzKC3qEk2mEp/ZuXIQUf2kMdqI+oOx/gYFBr7iwOVzUrl/hnZky6JASFLSCcUoIKNv8DXEoyy1I7CpFMTvdKJm4onxWXQHWdiKpDTSzSkLXlphTiCPis/uuITEB3kbGB2FLGdHBrwr+oTTKoezqILBzg7+bwndJ2bvBNeHiAAEeVFkMiH76v9skertquK5MRxNRDqR28ZzPf4Z8MRMbxB/Jz2vJPh9ZkMDVqsTgFYa4DXlJBJiTTyTFDczmcxATCevAUrUDJ9OjZii3fVawA92BnvxzjAe7KI9+tj3UFQ9GK7lZxHagCdLIQ8MdMEYhQ78WcF/w63nEXWA9ZUuTSJa/O1inI6cdMRsqJeofIru8L9uNFyn65NMgsrYa2MAjJidNYKqT3gULNlYpwSOVBDRZPoUbW/SqnDgXic6XavbNrNvpBLx1HCJHApiOYGJDCheyxRdh4KbJ1npmsa1VQlI9HbZS56CvF6+kyAMQmh48gvQwhL0IYYulYT5rJrC5MKd1ywrDgUfH+wcDYaTgyHngxfD3cP98dGE7+3tHO0fHeHqubC+zF51k/bS3wkljExYphPQyH8BEHBxwJ4YoMUf71lE4xH4o+36sbWYgV+GgacLlvny5AMbHrKMq2lJz/l0CQQVX55jXoCSjI+rFAOSe8LvjZxKtY4VobAyuYpevX5zfPn2Ap6cvf7X5etz+AtprWxLjhVYa4pmqcnVZvqGOA4CoEtZgYEbHJ11AtUOCMSVbQ6U/pedWwCThXQHM8Lqa2Y0SbOJ0XnLlRIfpdkz2RO9LpQE8AwCBkShMYfagGkfCTrgwqJw8duAZCcUSM977DhNJQoJlQvVFxbmz7G24Gnqc52vecGVBQUXXTosP+RSyGhA2dbGIo68bSoFnQM4f9hOjhMH5TXZRMsLa2sJLAb9AM8euTZ3Fw3QCFJM6hAEE6rcE22gFoPIBLJJSEkhHFFuhcCjqnF1xGqGRwp37zwzr5ymdwkv7SP87kMG4Scm0eoX1yI4H23ZfDQibVRqChEp7EZochhVq6tyfJ/9t7679d2t7z7Sd5dfnoUKN7yl0md3tfS5VBwqZW0oea6UPoasR2lWDaLyJiiyywCQUCJ9//ECHPsXoXC8+FzgPuoL1kc+la8wf1zrI2xyqj1QlfoXukAGCUcvwQQikUhHxPeCY18kElR7q6u90WYswUDVmhIRoqZhc10yDpCZUinaWdsuS7Ww6lsX9tTgEdb6CIirqjT2W6ptJbmtJLfZaJuN/jLZaFtJbn1367tfp+/eW0nWXJG3hDopfOn0lhbe08EpgwGLjxu1y5GqlqsVJMbqGitqVw7ReLA73p0cJmKY8mF6sHc0GSQHA75/uHu4Ox4ODqNmrr9a+HHtZG2faujb65EghiLuGuq4UoFxWad12j7+K/G4fYJhDUNPXTcD5gDpp7p2HByt1o4XWrN3XM2rCsm2aki1wAhjGozNcaypxtJx5xTiosKPMhL4QlOSuQAq+HGA0ZcfdF6UAuiaeXw8cSBK+J4UjKxeRaokK4FDigSZxqpZg2FJ/DgzwZoPKFAFO4Xo/AWr06Ci31XJszOU+C1KzF5/ToRAR68r9/1157unwLzBGHHuFbzhoNfvdrgCA4ANgY9Zdd25rc+39fk2x29z/F8jx2/r863vbn336/Td31Cfh2poc30OAx5dn8PY3g6ra6k31PHyR5fp5CqBAzJvppOkNHTcXNXgVFeAKYX2SYwh2AY5ivqhlSCmTg7bv637Je/6HiOMMthUgmWi57A0Gcys+mFuQXGgsLseL2QP4hnozs2VvqGmmOu9NWEI+wW8y0EgS0vfaoMtOH6RHsFtJFq0D3+0gAc/NBVFde/NvfSxyQi1OtclBDwi02Vg/cG66DGwWcDW4ltLo3tkTSsygmyXJrt7SJ7QSrRBDk9kgxzr4Lt3LRjPgMsl8ZD9Rg/QOdbgfvWVTqBFXsF922Blsfc4bMBeCm5gg+A/ZTz7/uPFczbFypM83/dYCYlbBfCdD2AiFNmOq2N9nETJZtEsedz6cIKexCYZCMxC79tpAOEHCPlnEKMJUpwkKCzgrMd3Y/HWvA2dbj+qmL2Sxjdr+S6mIKLvBrwqKrl4Q66nMvFNRS321GKihp1gLS48tFeJb8RJwJ2RBM8sofXkxT29uEEP91PwBKku84BIBD7an7uSSmtP5qNFL0Z6bT5+VB99C1ZrGvNRjNkZtXuesmSmtRX/ZAxNB93galqCFz2ZLer7iskj4sFOg6XYLxlLiJSC+HsLjqG8MfExJmmqUTSUbyr1LvkTaRZ8/ifqQP2pJTM9voJciiNTnfyGFsMlnnHBGBeMfQywgX+fqtCwsP0MZKA44A3gZKF/igSB0UbM87TWRnUi36c51LgJrBIVW4z8j9EiwIW/GL3A0fUYCMER9eeHD4DwmwVamK9aYFWnA8sIrvKbaUiTS7h5fuvTKUydfzZ5UeLjxSHKe5XNv3SU3hBJ/jxx9/8U8baR5q8YaULVi+ZGy4btQdPIfbW2eqRn6UYC/AtvyVOpvIbNy+ISQpNMkXGHNk0+ncykoMOAQnCHlV8X7Urn5IdQ7qLzC9/ay6YGxoDTWqhG+VhmQK/HPsJuS0EJbnCnhe0TQPVnHbZc54DyB1QSe1UpDgqoPC8VNikDE2XOOJjHA9pNpU1KH4Rg46VEJZmmMq6eVXkkmg1C0aM9h8nt+wmeGsOGtKHEB9YCHdpwZAxAokbCBYCFIGciIyvDce3y+yHaYDnxTGQF7vUggkIxJRorvDu9WKEIxFRoltZm2g+TbB/HAhHc6nhj2OvBDg8fFdo62Jg26J5V19rW9sIvm9Xt4rj8S96MC8kBq/p+gQdTyGvpdxl+i3cVtbd4MGnUvBS32OXBvmEGUuKU21s8zsAtzx0+9pc2cO8HkKNVL26EbBTy67q6thbHXwQeEFQ388IRQERX+B6Pw9/rztk9ONZ38p4I5PYC2dd3gewec6huCT7RGv52V73ugXJxiW4B5qfF4dNvDNzPzsKtv+ds3bXotXxUH0zUvMlExd8i3dx9gsHeIYkr/94fljdmrnxORnHqA8zvXmNC5xu2R+GP0RUeff4Pb4MG3A== +sidebar_class_name: "get api-method" +info_path: docs/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 'Returns account usage insights' (get-usages-by-account-id)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Returns account usage insights

+ + + + + +This API returns a summary of account usage insights for past 12 months. + +## Request + +

Path Parameters

Query Parameters

+ +Summary of account usage insights for past 12 months. + +
Schema
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-usages-by-source-id.api.mdx b/docs/api/v3/get-usages-by-source-id.api.mdx new file mode 100644 index 000000000..0a1036c33 --- /dev/null +++ b/docs/api/v3/get-usages-by-source-id.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-usages-by-source-id +sidebar_label: Returns source usage insights +hide_title: true +hide_table_of_contents: true +api: eJztW21v2zgS/iuE9sO2hmXHTtI0Bg6HNEkXWbTbXl6uB6QFSku0zVYitaSUxBfkv9/MkHrzS5pmi71t1/uh60jkcOaZFz6kyNsg51MbjC6DM12YSLALy6fCBh+6QSxsZGSWS62CUXA+k5YdvD1hRuSFUZZxZos05WbO9IRZ17nAzkwqK6ez3LKJNizjNmeDIUu1yme2F3QDnQnDUepJDHKnIndDvpg7DeBpN8i44anIhUHVbgMFf0BbWzeQqFPG81mwqOjJESp0cvSbVwoaGPF7IY2A4XJTiG5go5lIeTC6DfJ5RoJzI9U0uOsG4oanWYLPhtH+4PnW8+3deLA/4M+fbQ124+Hznd3d8Q4fbg/3ofWtU+P3Qpg5DOO1TGQq8yW1XvMbpop0LAyqZ4QtEkAo1x7P3nt1JgS7/Pc2gXyWcxVzE7NDnSQiQhnsbYXJhyezPM/sqN+PxZVIENCe5TLJtFR5L9JpX8aqzzPZt15OGFVywhrbp+ShVBv0GfxMyS29FmITnljRwGW4u7UCQBhXTIWBnk6Me7Q9hAepVDIt0mAE/VJ+436TlFhMOKBAf92tQ1NPJlYsw/mGHoPagGA+E2xSJIlHlcGLHsRxwZNkzmwmIjmRImbXMp+xDnmng8BnfCoVzwX0N7qYzkiOd8x3444/4IwK/vXgR7pQy9ifTFgHE6nDZA6oAvCZzorEQSlY5z/huc55Eh5i7w5CmmllBZsJHkP4kx+w4Yp0mHGQqIskZmPhMwM8JyeV3wA/1nEx0WHXAqGaKkAsBo+Bz6SKsB+YYXPIaChSOarCyBAWccVm/ErAY/ARgYPtZZrxKO+iNVDjjACPpULFMLDSOUaKFThqh4T8gyzvoE6k7RVPCuFQwNZjLIKlNt9FBK0piWOtE8FV0IgT6rk2Vqw2VK/Xl9dGPCLEPLQCVc9Bq7vFGDsDaVVYFBZ9iSFTms/sXOVQUV2nMcaI+pOx/gkNBr1Cr+VTcrl7hnFkiyxDSGLyCdUoEKOv8TXUoyS2I4ipGMzvdILmxBPis+AOZmArosLIfE5z4IUV5hAmUXGTHxQw78GUDYqOeERhaUcGsiv4gN3KhLPoguHWFv5vAd3HzdwRDg8FAeTxLEtkROHV/2RR6O2y37kxHCNE5iK1jed6/AngxGneIPy5dKqS3fdFDTVYJiaArDSga8zJIoSadCYrrmcymjHIb3kFSKJj+HRqxBTDrtfCfbg13A63dsLhAMPRlb5aG1esmtpMEs2XiyOqAyXGIJx1gQPVfHUr/eWKF+klqCRCAOfIsZxDulXUkCktTQdbvZ1dyMMglzlp7ogT0ajgDv/rBjur3H6YSHAfOzYGZIfstFFf3dxHdZONdUxASQXFTcaP8fw6D4scMu1Qxyv93Fb2pVQinBouUUNBKkfQkYHEKxljFlGdcyJLv1O7tlsBid6AveAx2OvsO/TGIIKGR59BFlLRLyl0oST0Z2UXJuvMXjGs2BN8/Gxrf7gzebbDOTDHwd7ueH/Ct7e39nf3kT4GqbCObS+nTHvoX4QSRkYs0RF45L8ACGQ7YE8K0OAPzzKS8QD8MZBd2zoUnb4Ma1AXJtEXh2/Zzh5LuJoW9JxPF0BQ4cUZThHAzvi4nG3Acif4jZFTqVapIhSSlMvg6PjlwcWrc3hyevyvi+Mz+IWyllYnBwqiNcaw1JRvM31NGnsDrjnklcAaDknPOl5qBwziyjYbSveXnVsAk/mZD3r40Vf0aIpmE6PTVipFrmCzJ7Inel1gB/AMqgdUpDEHmsC0cpTpIIpEloevPJIdz5We9thBHEs0EkgMUQ0L/edIM3gcu2nP0V9IZVdHdJEjE5GRaPuihrLtjbqMvGo6BZMDNP9ynBxEOTBtiolWFlbR4lX0/gGdHXJt7c4boBGkOL9DcYyIxEfaAC2DygS2SaidvhzRNAuFR5XtqorVrI5U7l47ZY5yTe8iXtgH5N3bBMpPSKZVL66ETz5avblqRN4o3eQrkl+YUGffqnJXmfiOCGxyd5O7m9x9YO4uvjz1ZNe/JeozWKY+F4oDadaGJs8l6mMoepRmZSOiN96RXQaAeIr067tzSOzPQmF7cZPhkuob8iM3lS8pf1D5w693yuVQOfXXvkAFCUdnwQQqkYhHpHetsSOJBNX28mgvtRlLCFC1giJC1TRsrgvGATJTKEWLbNtlsRZW/Zz75TVkhLWuAuKoKg7d6mrDJDdMcjMbbWajH2Y22jDJTe5ucvf7zN17mWSlFWWL50n+g6eLNP8ereUMGtTfOaqUI1ctshUUxiqOFbSZQzAeDsaDyV4kdmK+Ez/b3p8Mo2dDvrs32BuMd4Z7QXOuv6zzuEqydk41/O38SBADibsCHlcoCC6bax23t/8K3HmfYFnD0lPxZsAcIP1Qccfh/jJ3PNeaveZqXjIk2+KQqsYIaxq0TbGtKdtCA86mUBcVfp+RoBeGkkwFSMHvBIw+AmHyohUg18zDg0kOpvhPSz7IqlGkipICNKRKkGhkzRoCS+J3mglyPpBADHYK1fkbslPvoj/E5NkpWvwKLWbHN5EQmOgVc99dtb97AsobrBFnzsFrNnrdaocrCABYELiaVfHODT/f8PPNHL+Z43+MOX7Dzze5u8nd7zN3v4Kfeza0np9Dgwfzc2jb22IVl3pJh1/+bJpOqeI1oPBmOooKQ9vNJQcnXgGh5I9RYg3BA5GjoO/OEIR0qMP2b8tzk3d9hxDWGDxdgiTR6VeYBPqVB2NuwW3grrsez2QPqhl4Lp8rfU2nY662VxQhPC3gEg7KWFy4Mzd4FscN0iOwjcR4dsWPBnDQ+9NFQXUI5175eNoIfToHm5gT02UQ+z626DGomcHC4mdLrXsUS0s2gm0XJrn7kj3+TNEaO5yQNXasgu/esaA9Ay0XzEP1G4eBzpCBu9GXjgTVswqu2oZLg73BZkP2QnADywP3IePJr+/On7Ip8k7Ke3fYSkhcKEDmvIUQobp2UG7qYyeaaupTkwetzyaYR2ySgMHMH4I78SD8BgX/FCo0QYqdBBUF7PXwY1m81W/Nkbf3KmRH0rhTW+48kzfRHQu8zEq7eMOuxyrxUyktdNJCkoZHwlpaOGgvI3cMJ4JkRhE8sYTWowd38sKGPFxNwROUuqgDIuH1aH/sikqvPVqPlrwQ5bX1eK/eucNYrW7M1TBmZ3Tu84RFM62t+CdjGDqYBpfTArLo0WrRCbCQMiIcbjVUCt2QoYRCKUi/V5AYygUTH+MUTQxFA3lTsUvJj+RZyPmPdBT1Y8tmenwJMym2jHX0FWcNF3TGAUMcMHQ1wHr93USFgYUn0cAGqgMuAA5r/1Ml8Io2ap6TtbKqk/g+9aETnKAqSbHZyP0xqguc/8XoBbau2kAJRoZdff6Dv5mXhbNVC6xyb2ARwWV9Ew2T5AJuTt9qbwonzr+avWjxQb2F8kYl829dpddUkr9O3f0/VbxNpfkRK43nvBhuNKxfHDSD3LG15Q09S1cT4F94S5lK5BqWLvVthKaYLOE5xjTldDSTgrYCMsFzZH5djCudUh4C3cXkhwUfCZoaaANJa4GN8rFMQF6PvYO1looAYlxn4eEJkPpJ+wXXGaD8Fp3EjkrHAYFK00LhcWVQokgZh/D4gndjaaPCFSFYdilRWqaJxlW9yozEsEEoerTiMKl9M8E9Y1iONpz4hbHAh9ZvGAOQ6BF/E6A25FQkFGXYrk2/vyQbIieciSTDlR5UUCBTojHC65PzJYkgTLmFTk+bad93sn1sC0JwqeOCYbsH6zt8lGmbw7K0IffU321beSh+Mapu673yb3g7zk8NyOn7GW5KoaaFW2O45d1l0FreQZ9R42JcvcKDNcMMLMQOt7e4kYHLnTt87G5u4LoP4MaIrq+FrLXw+7q/thLFzwK3BsrreX7xH9A9vofj8Pe6eHYPjtXFvEcCublF9v3dIrsnHMqrgo+Mhr/dfa97oKxv0tVgfqg3nr6ycD859Vf/nrIVV6NXqlF+KVHzpg61en6yufsAbV06kk7utdskb3Rc+oyMxlQbl78c41TO1yyM/I/RJW55/g+gXgXD +sidebar_class_name: "get api-method" +info_path: docs/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 'Returns source usage insights' (get-usages-by-source-id)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Returns source usage insights

+ + + + + +This API returns a summary of source usage insights for past 12 months. + +## Request + +

Path Parameters

Query Parameters

+ +Summary of source usage insights for past 12 months. + +
Schema
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-work-item.api.mdx b/docs/api/v3/get-work-item.api.mdx new file mode 100644 index 000000000..f2027b59f --- /dev/null +++ b/docs/api/v3/get-work-item.api.mdx @@ -0,0 +1,95 @@ +--- +id: get-work-item +sidebar_label: Get a Work Item +hide_title: true +hide_table_of_contents: true +api: eJztXG1z27gR/isY9kOSG1OWZCm29KXV2U6qjOO4frl06vPMQSQkIaEAlSDtqB7/9+4uAJGU5FhyMpe7G31JKBLAvmBfnl2Cvg/0VKQ8k1r146AbjET2Uaef+5mYBDtBxkcm6F4HeIvhPRPc7ASxMFEqpzgHZlyOpWEwzbBsLFgsMi4Tw/SQcTafxgYi0Wok1YhlmgkJI1MabqYikkMpYpYbkb7k8UQqlor/5jIV8asdpu2wKE9ToTIaVAO+pjzlE5GJFLm7DyTyMeXZGB4peAC/ZAzXJhqLCQ+690E2m+Jdk6XAQ/CwE3gaQTdLc7EoU/8IBUDKdyiCBBGQrPjCJ9MEF2pGncZB/WCvHTc6DX7wut5ox82DVrs9aPHmXrMTPNwgDTPVygiDHDTrdfxvUXclCuwO9EJER/JWKNY/QpqRVhmIjnP5dJrIiPZq95PBBe6XRdSDTyLKUEcp7mwmLXnQx5Ia1pD6EaGbot14fYBC7zWHB516xBvtg4bXqzCwM/2NCM6nbUYQtjtPEj7A0biPZQaOpJkmfHZK9vAUJ7gRsZ2ABvR1tt7psWIXE2ntbZEBfafWkx5pFhqgad8sPa2yvshlWZcZeMfByJygsHaUCp6JlYINdTrhYKNBDCPCTAL9iiT1xn5Y3w8bjcvGQbfV7u7t1+qdg/8s8wQz2d0YjD+regY3zJMHTiY6pqDxPFYOwvrrsNm+bNa7zWa3eVBr1FubsZJwA7FoGhM/K3ahstJaplfc+boLHpISGI8inUM8hOFG52kk2Ive0QtUjcng+SqiQuUTDOVvpJJmTHyfCwwV7jLLU0WXx1+mFBh3gjOhYjv5kKtIJHDzpsxMaallkYgRmwbKomQyo7k+yVzgsPdc5TzxtwzKYdl/XIy3AqxVRsgbBrmhi4skykTE0v86ArZH/kdvCkHxlidw+YvUCd0+F7dS3MGdN2A4KLSGGDvDx9pPOxzzJBFqhJbUn0x5lPUUT2ZGGrhxIUdKD4eouFuM0zuBlaYXudmXEECqeit4X1YbyrvKBBb1dgnjVqgtLYS39woV8jTlsyVr3QnkwrhvSCDViBYtbMxmiSTjKYCKzeNohSqzqzyT+PPi6JMMfIL0UTM+qtoBz01Wm1EGpCCTXhwDMCFrKQGK58laRiQ2EFXooQ/cCnYE8STKdDojmhksPcgz8UyKfjpASoSTTmYKQgXh6VgrcZpPBpDRyjQ/eKy7HuE5NF6tYa2qLFVYsOmhQv0XnuRrinyLQzeTud1ohu12O2w0G00kqzgqvx9DUJLZbF1N04ZJN8kzsMqIERtYKwZqD0WAOq9GoCNbDwSLWTHosURCFgUKpZjFpA9k3IXqHxTFPHli6IWB+LJxDHE5ek16LqGnYiig0omgIBrMvIsVnDwWR1ZgkJJr/i5+rdZ257k5g15p1qMhahXA3cyDy7SKqav99HZ99ywva6eVl+T/GNQiPVnF/hyeAaL4MKTi9VGg1j/tX/zzGA3v/Pjd8eGlu7y8Oj+ly+N/n/XP6ers+PSof/oWoUrv9PD4BG8i6SpaK9b7NrQGurpflOymHAJ6Jd9dw//JdcHseMaUAMPPNMQ5Z/cW769vWwVOX7KsnnMxC6FXbQ7sGQx9dolzEDbqYaNz2djrtjpY4uwdtFfUFRhPsbYAce/GMhov1BcFEys4BNNYDIhSZWJEhducQ7i111zt45QSC6VL9Xit0eisYABprDTf79J2GFoI/m0l8HrGclqKdktknalcQO1AKJ652mCJlrP4dSwTiTA7fpVVFrRgIMMOQ+1IU1gy+WBTMn5KtWd1lghuwNWJEhumeuKkTxJ959piNtNfGTCojZMGNuesG5uxzpMYvRiu7tDGpFnW8juuxFxIK/yqTP9oZl/XBjc3CNzu/mK6fSNFEjcqWMePK4LcU7yA+YjkaWZOcJjnxummwsyFMxZCGkPHxgbaWwrHJy4Ye5FMrbhkEVe4mY6ok5ZxFe+CrZJevAZKPF5DTsAuqFdWdfYyB+65qXjlorbLml5KQUA8TXW6jhqKRnDB70ICgbBExowNn6JNjb+UBvcBr41ry93wnmJEE6Ww3NhVNLWwYxbnKXXBK1G3LGWpnH/A+616Y7lvfKV4no11Kv8HS4bMd2+YJNWlgOCRS+YHWWw9FjwWKfXU7Tj27uMlZNvPQuF4Yfs+37HnTPIvM99jEwB3fOTbXgOvEDu+EiKAQQASMrYSDGHvRdwlvguOSVFWVXvL1MBqBjKGgmZZTzZizXQOWyZYmiuFnHCzw2ItjHqRsTG/JWwO/CIsoTgmVBxONeTY76gp+9bkUMdrBKo3UolwlHKJgpDKADPEgiFcktivYxOd+hcx3ploXDUdtOr1WoP9zGNQC3W52aETBq0x5dFnWGud/suVkjCf+SlQPVIOe4Ss2Bd88LreabaGr1ucNw9ajf32oDPke3v1TrvTof6utY9Vjlwl7TppLNERWAk6A4A745KoN6c1S0NaY80sa8fOxfT2nIkv2Q5A6J8Pz1hrnyVcjXK6z0cLSlDh1cUqQGEX/pDKkVxZ4fji4Oj4Te/q5JIKgn9dHV9czgH/UjiSKkaz1AT7IB0Tx04Aim2EB8Dx2U9u1Z9AIK5MeaC0v8zMYGiMxZDnSQYzHPUVM8pLF2DDvVBh5DdfMvZS1kRtB5IL3APwCmh4ABgl9q2VnwAeiWkWnjhN/uSC2KsagxpRopBQGVMFZmD+jAoHcPbYI9thDh4v6M2azjOM3DJagEWFKhd7Cj4kn5Q3BZ0DOH/aTqBIzoE5ErPshXNrcSy6/QGereaq3F2WlEYqnamMQ6KEkckM1JhiCc6gFIVMYpgLR7hdBgKP8uOkoihaq2SaY+TmvWXmKNP0LOK5WcPvzhIIPyGJNn9wK5zzUai00Yh2w2+Ti0gUR62v+FHz7fKOz4YIKra+u/Xdre+u6buLD8/d4QN6OueKvMXhJJNPJjydWUtzz20LCAYwf3iBzV1u3h8roxVcjM0xVlBFDsGg2Rg0hvuRaMW8Fb/e6wyb0esmb+839huDVnM/KOf668KP505W9anSftt9tL0rkd4CjgM8LlKTaR1XrBXVm4ohhjUMPXPcDDoHld4U2LG1jB1PAei/QaAP2DFdwI5+/avzE9u1tcuj3uwbWXRaUp0tABBSUuUgvkCptYWOW+i4TT/b9POXST9b6Lj13a3v/jl9dyPo2HoKOrY2gI4tdup7qT8SOsaAO6ipC5sCMvjTxqmYgihwxecvZorTEHOgV0GRzc6KQ75as/dczTxYMpVOpCrUheENxk5wbOrHwgDuDgRD1JKAbtGq8AUiYFJ8aZvIiSQ/RoFg3XQW9oYZSGV9xtvbnIpUUZIDhxQU8FQ20r3jEsxJDBH+wQrUBx1BoP6OPU63W9/UD2bnKPEJSsyOv0RCoM/P+7/tVUes+8B8iuHiwu41WfhjPXOuoIwQX6Y2fM0h6Baqb6H6Nt1v0/1fI91vofrWd7e+++f03Q2gukNDj0N1GLA2VIextTqbY6k3aFy/O2InV3EckHkzHdljFQUGJ1wBpuS+ZcQYgt8FdoNdPG4RUqTZvZfxQ4CHjhARWmbyNIFB4yybmu7u7j3sEezNQ41PZc2fhlb6Do917t7urYg4sJ/OAyFmxbk9ndM767sSo0aaTSUar410RMDqmWRBMwV908mCr67vj1zNoPpgdpkd/GzEGRLdxkOEUEW4A7Y1MpwlGUG2qzR5eEqeX/a+Jodd5BE5Vqnvq7RgPAMuF8QL7EEiI2Cz6Sg77BceUTu0IaqX4wZf35THXCAktxwujSzSDL4MWD4o+QGHNdnPgqd4oI3Ox7x89/HyFRshEKVAkBvEwO5DVs7OwIwo0PX8WRGcRLkn1fnInvHsVU7joGOxYQJKYb+qCyHYtT+qfwoZ4BxCNqkdJwmKEjjr5qXfvVjcigSTY63QNhqnjNUuaHGXV+a9okRIFYNU9pwo3K39qkJ3iJsOXuEYJyIVgOx66uXiJbmey8Tf/GqhXS2k1cyrBS6saq+jRGKcjMC7cQmeGNLWs4nb9cLSelhewR1cdZEH1ITjo3qGKvK79mw+KuuFuF6Vj1/VRzoVXJ3GbFDzJyv7LBprbcTfGUPTQVe5HuXgac9mi44ih+QRYbNeYim0JEMZAmYk/k7AMZQ1Jj7AnE2QRdvuCbntb7SzEBd+w0OC7LeKzHT7GlIrjox1ZJ7NMxIMkWBo44Rx/Ltv0IFZ8G2UgeKANYDDYv8pEjhGS3HRrrUy8tPyuzQH00cErNIqZtq1P7pFEHRXjB7g6PkYCNMIueenyuA3c2th+qooyzcLFjW4zG+iIWsu6M3yO3/liZn0jyYvStwreiofVDL73lH6kUjyx4m7PyjibSPNXzHSOBCM5kZkXbVQNnKL6JY7fNiCHgv4F56SpxLahlqm+MsU5WWmCc/sVw3g09FYCuoNTAXPEB3uoF3pCfkhQGJ0fqgAaaERfYGTAsMcqjmZwHo19hGKLxWBirHwwjO5sOon7SqwC9DyGW4SO/IbBwBqMskVfqUITOQT/J7mqd2NpYlyG4SgDlPCS6YJxs1neY9Es0FV1KgESSfmwxCbyFCfljbxCVqwh8Z1kEGRxecIQSHIubBfouO4KkR/am2wnHAskimWfhBBAUyJEoX3/culFWEx5V5b6HS06yaZXRyLn8CB8NYY9mpQ8OGtqTYZ1Kmldd+KrPy3XRbt6L5ol/+Qvw3j0gbi/d0pdrBQitzWKLYWvA6KWhAmdCX9XYMxCIrP7u+xwYGV0QPehsIeq+frm6LwoQIE9gCvoc4cgocv/gWZshJennue2SN/V2Yly741p2ZFVR7A5WeBxTzwTF882G4LcWQf2H5MacrSGwusk+Y18ttj2PiH/wP1ZfZW +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

+ +The work item with the given ID. + +
Schema
    remediationItems object[]nullable
    + +A list of remediation items + +
  • Array [
  • ]
    • approvalItems object[]nullable
    + +A list of items that need to be approved + +
  • Array [
  • ]
    • form object
    sections object[]
    + +Sections of the form + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/get-work-items-summary.api.mdx b/docs/api/v3/get-work-items-summary.api.mdx new file mode 100644 index 000000000..5519e3602 --- /dev/null +++ b/docs/api/v3/get-work-items-summary.api.mdx @@ -0,0 +1,83 @@ +--- +id: get-work-items-summary +sidebar_label: Work Items Summary +hide_title: true +hide_table_of_contents: true +api: eJztW1tzEzkW/iuq3ocBKrZjx5BNXqYMhKlMhYHNZXgIqULulm1BW+qR1Em8qfz3/c5Rd/uWEGCpuVB+SezW0dG56zuy+iaxhXIyaGsOs2Q/GavwzrpPh0FN/Uk5nUo3S7aSIMc+2T9PaEjwWHKxlWTKp04XNBczTyfaC0z3QgofZwo7Elc0RdMUMVS5NWNtxiJYoXSYKCfwR/hCpXqkVSZKr9wjmU21EU79UWqnssdbwkaytHROmcBEbQhVSCenKihHot0kmoT4o1QssMEIvtoroxz02kp8OlFTmezfJGFW0JAPDpIkt6tqHL4kqWm9RnLBbGjJWqhkfyRzr7YSdS2nRU78ur1ud5hKuYP/vWGqRs+6vZ7Mhr0uPndlmtxe0HxfWOOVJ0F629v0b3n5I+3DstmwbGpNgOZELYsi1yn7q/PR05Sbdd3s8KNKA5nIkXeDjgvis1mg0mA6Vi5ZdyRsbUvDctCcZWEalXt7tyQafQlkkq9j3Ey8h3sXzIMNMv9axjzpHqY727fEVgd22Vqg397ScH+7u+6XMyPLMLFO/xcSt8SxCqUz+Kg5VpwSCH5jRU3EDhITJTPlOIAjnfj13SkE/ASbgl5dFxRM7e/nYeWcdevCD8RUeS/HSsTnQ85BiBPpF8OYBLyUuc6iBiOpc5Xts9xzidlQ0VQ766u9sm6osww6rtmJc1fMbCkkTOZKY0gS6bdEZpU3PwUxkZdKyDSFvFQlAhUVZbJWYeH872ipTAWo9sJmar0mrIbXK21Ua+ykJkXYZIi2TAlwvNQZaTC1jmxLLOvqwXTtJdv2t7fbXfFcZjALChUS/UWlDAWlk+kn8DrMHhbozGjMF/UUoTMxqorkHcuqXSWHz7b3ev3Rs76UvX/3u7tPh3sjubOzvfd0b49Wr+LDL6wtnZOztaV/USiFOhW5TREllAxOSU+RAgHqcIp596APmMcX2J/SO9I2atbxHNR12MKG8/zFW9HfFbk045Kfy/GKEUzr7IQ2hjLP5ZAeBVcqaB4Zv3F6rM1doihTTmnre3nwanB2dIonxwf/OTs4wSfitbYNDpDaJqOwhKiIhYm9YokrBa6kF17lMAcSXzypuD6BQtL4RUIdv/mZpx0oUyNZ5gEzqtXvmLHIWoycnfKgq0KN8+Y6iEe6rdpb2IvxbCpDOhFD6TEBLiTyJwPkXhFaR5Uln1RF7HFbDLJMk5KorqgQYIr5MzASEsmODI8MRiUyHsJge7dlQE0MOlXLvpibctkb88p8tOgUSg5I/nCcDNJQQjhWczELm2ipRKz8A5mj5ZalO10wGpt0ZoJMoYXM8xnMCBCSBjGEbhpYpypH5C6PwmNqOm24iraTxQ3ngKR5HYV5GSyPpbL0X5B3b3OUnxar1gxcqir5uFTGasTeqN1UVSSuozFXaqrGXXXiC+CvPNvk7iZ3N7n7hbm7OnhcgXsebaTibKlwUtUWxUirxklbKUAg6uZANCnHrlpFK8RMNBgrWUYOCfqNYXe0m6p+JvvZs529US991pNPd7u73WG/t5ss7vXn8zxukmw5pxb8Hf3IJgaIuwSOKw2Cywdrs6VoJfM6NaKyRqWnwc2wOUx6MceO/XXs+JsN0A2MgR3dCnas+Z8dHxF/LM3syW62dKkimB1NB3IZGFJSDMPSaKo20HEDHTfbz2b7+WG2nw103OTuJnf/mbn7VdCx/xB07H8FdOwLglgjglh/JXTMgDsImo3gFOhQH+07VUAVfKpOH6u0D9KNVWiA3hKK7O2to8hTa8VraWY1WPJLJ5Fmbi4qb6CdEq2raUEgxRgl0ghULQ10S1Glp4owKeJH5HqqOY9JIfB1s9ZgFKBVzJk63ppVtEnzEhJyUaCfQGjdK6kRTmpE8A8c+Bx0jEL9Hc84K2/9X+fB4pg0PiKNxcF1qhTlfHP++/SunzAOIbyjcnESfc0Rft+ZuTRoI9R1EctXA0E3UH0D1Tfb/Wa7/zG2+w1U3+TuJnf/mbn7FVC9QkP3Q3UQfDFUB217WzRY6hUF15+O2DlVKgk4vIVNGatncwzOuAKhVN0e4os5YYIvHbqD0eJK0/HNVaLYAER5SpeDbhJC4fc7nRu4Ce65bctCt1G94KkwM/aqndpp53LnjqIDl1ZJiLKVlSk3DYO3h1WX0WbjOk3xG4sdLxBNzepQpMLkfLngs/zpPhH5cIYGREQ2WwKxXsUSP6YbLWgkfvJM3ebYWdMRup25/PYhfX7f+Zwekck9etxlvs+uBXoBKVfUI/EvyF3wNxixv84gz4tYpQYl+fj8YpHmhFB5lHCNcr7T0O8BvTWB3hBZTzxX0tGtML4i8+jXd6ePxZiwKNeC0hMMri6OSfEWYcS1blBfF6FJvP04W44nrNxg6UIO5ZYY5TCKeG9OlBLnh5WhfsMmcIyqzWanSYoLBc26eFR7L1OXKqf9sT23NgWnzkwHVuzIpXmPeS/kpkEbfJzy0/Z70xIvNZUoTXs60VQqcg8ozotaL7mg17cK8a+aWytyazE3/3hFimja8zTXVCpTJDixkLlna33z4pFfa4EfdVh4QlxXZSBLVHIsX6NKa699sxxL/FrEb1mO9+bdRGOjXZ4mYl0THvtknolDkU6s9epnISh0KFXOxyUy7ZvFuqJFW5wRrd72gkituGRLtwAbWb4jJIaJwSSHtG0zarHxAIXT9gN7FnXhA5rqTHxY0pkfn2N3JcrMpv6bZaYFW7RgK9YJX8kfNy8KLOQ26cB1IAbAi7n/uRJUgi7UxcjrzsrP7Ds8h7aPFKIyF1/sxy/78yJYfRI8QNQNDco0oe7mYhm+i4oX7WBLxqrPC1YtuC5vbrFxrtgtytv86kmb6d9NX9J4MD9WeWPy2feu0vdUkr9P3f2LKt6m0vyIlabCwRRuvGzVMCwGeUR064d8dAo9UfiLUc5UBtxoZ7hBYwyzyKbIZaCY5pxOJ1rx8UChZCB0uEVxZaech4DElPxoApnR2IEGSeuBWOVQ5+DXFu/Qf5kUJqbei67lgutHWzVhJ7DyW3KSeFk7DgBqOi0N5lKOlVMhER4PeDfTPi1jEUIrZlStmWUY18yqM5LChkzR5i7ETf2bEZ0jo0VdcOIDa8GH9bV5GJI8Ur0PMFfkWOUcZUS3DNEf4o3IaU1UXlD3hwoKMKUWVnh9eLrGke7QV79cWDfuVJN8h2jBhNqhGAw7bfR89KiwPqBVXeA7f/NCzF/LWAqlm/mh+Z//Lka1bRDe7xR0iEValLFHie3geTJvBym7KiXQPkygLI3f3NA5B3VHt/Q4vspBbQcsT8E9f+viXr0/+/LGnTJ+UtSoz98TqZrxhF/XqJsubnQgKJ+zsEhxWjyJWZi19lsFcWm6418O4O/b/wFHeATx +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/global-tenant-security-settings.tag.mdx b/docs/api/v3/global-tenant-security-settings.tag.mdx new file mode 100644 index 000000000..aae73e41c --- /dev/null +++ b/docs/api/v3/global-tenant-security-settings.tag.mdx @@ -0,0 +1,23 @@ +--- +id: global-tenant-security-settings +title: "Global Tenant Security Settings" +description: "Global Tenant Security Settings" +custom_edit_url: null +--- + + + +Use this API to implement and customize global tenant security settings. +With this functionality in place, administrators can manage the global security settings that a tenant/org has. +This API can be used to configure the networks and Geographies allowed to access IdentityNow URLs. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/docs/api/v3/identity-profiles.tag.mdx b/docs/api/v3/identity-profiles.tag.mdx new file mode 100644 index 000000000..df0eec8c8 --- /dev/null +++ b/docs/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/docs/api/v3/identitynow-v-3-api.info.mdx b/docs/api/v3/identitynow-v-3-api.info.mdx new file mode 100644 index 000000000..177328ed1 --- /dev/null +++ b/docs/api/v3/identitynow-v-3-api.info.mdx @@ -0,0 +1,48 @@ +--- +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 SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; +import Export from "@theme/ApiExplorer/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) generated using either a Personal Access token or through the Authorization Code flow. +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
OAuth Flow (clientCredentials):

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

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

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

Authorization URL: https://tenant.login.sailpoint.com/oauth/authorize

Scopes:
  • sp:scopes:default: default scope
  • sp:scopes:all: access to all scopes
 + +OAuth2 Bearer token (JWT) generated using client credentials flow. +See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information. +- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-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
OAuth Flow (clientCredentials):

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

Scopes:
  • sp:scopes:default: default scope

Contact

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

License

MIT
\ No newline at end of file diff --git a/docs/api/v3/import-accounts-schema.api.mdx b/docs/api/v3/import-accounts-schema.api.mdx new file mode 100644 index 000000000..8f0508bb4 --- /dev/null +++ b/docs/api/v3/import-accounts-schema.api.mdx @@ -0,0 +1,97 @@ +--- +id: import-accounts-schema +sidebar_label: Uploads source accounts schema template +hide_title: true +hide_table_of_contents: true +api: eJztHNl227j1V3DUh0l8LFmSdz20h5EUR60tuVqSTj0+NkRCEidcVIK0o/r433vvBcBFlJek7jbVPExkEri4+waAD5WYz2WldVUZhUlkC1m53q04QtqRu4zdMKi0KuOFK5l12WPJ0gu5IxlnksYyaS+Ez1ks/KXHY8FmridYHDI7DGbuPIlEOvQnmGXbYRLEjMdx5E6TWMjaL8EvwThkkYAn4g6mLjIYfui4sxXjgaPX3WVeOGduAO96jghiN16xfnhfYwil7bn2V7azYzm+G+zssOrv4Y92GATCRiqkeaSJNH/ePqgHfe6Lx1vztOcvwyhmHR5z88jSyI+IYvN0sCwA74T3AWKajkLMfr+z0x+Muy2WshH+AQa78wBY5rAw8FZsFkasIzzXd/HRR2SB4pus7exUdivhUkQc1+o5IBCX8NMoSbUYDFryCMiIRYTifKi4KLsljxfwKoAXONGB35H4W+JGAgDFUSJ2K0qIldZDJV4tcZQEaQTzymNZDwRT7GIESHzjIHeccWI3Tuvi6PjkmPMD4Zzy0/rUOXUO9w8ODpv7s2nl8VqtK2T8IXRWuNg6GqAzMUgVX/mJF7tATbwHfPGrDsgBH5cQDae/gniR8ggZFLugvfAWNahMzm4FgXFYoDJ1Ax6tKo/0HyImlyBFNblZr+M/RcpHiQ2ikLPEA1kpbQQxGW2tFJDnyyXoIglr71eJ01+PObB1A95lKbigNjNaXwm/VpBG0z5tnNRP9g+dxmmDnxzVG4dO8+Tg8HB6wJv7zVOUrFKI16yFI59bTZu1Ahq7d2JAtI0J8PcuoPjCcBIYBj1SQJlcSXAz8ITH9Fi7nkgsQXzAelnEaiJFhCi52lNYxul8P06pv2KJRKmDe+OenZDDw/dJ4IJiM7XSzBURWTMPDDFukEO4iKW0LrQVowMii3MluNJ/Jbp6BXbHPcD61ajCtBiWT1y5EI7BdgHU8shevA2+94tQCoWXzATLQhgVaQwloshZum6NDdB9RsITdxzGArXzKEyWmoQ1pfCFPxXRYEaKEdhe4ohLEfmulOjFc6hPw9ATPCjh/tHjGIEcsu9gDhgLhVzEglDppYbLlhlgdu/Gi7x6o0PDuUDKfB6JuQL2BOdn3JMCEJ4JHkNEzaPJo4ivYCwEDV9u4rwIEh9DuzUZf+r2x722Ne7C4/bg4nIw6tHvTm/YbY9vLrvDi95o1Bv0R/Rw1B587g5vRu1P3QsLnnT71odzHH9h9a0zeHM+GPxpcgkP+oObodXvDC5urHa7O8Lpl8PBX36Gf0dda9j+BD/G3YvLc7X2pH8+aP+JfozGw0l7PBl2Ozdja3jWHePc0Sdr2L0c9Ppj/VDB+9xD3Hr9M/jzbDiYXN6sPRz93G+vP7u0RqMvg2EHSZ4Mh8CBm9wjQHcwgUeD/vnPN8PunyfdES5mdTq9MYCwzm/MiOwlEGudnQ27ZxYOMbiMbj5Zn7s3F92LD93hSA3LMXQdLXirSXh2zCYGbRhWFmCJDcPuR5DYZNLrlJM7lcJwjxn9Ui7WBqcwBX1MlphqgB+ZYiqmkxLI23ZYXqcwuRFpUqjmSLbkUlbjBdjjfMF4AvoNDlJFRoKQquHm6XYIaY4E3TZv7Ehkk8tkb4YCuWUSBWhfHcg27Dhn8BpOQdU3AwHnZ4d3Aq3KeBbynOBhI0kpKnkdBVGZyhPIcAdhuDNkpkmIIR8UAZ96mAxGuBb9JlhFa9uMnBeGXxEoeD2fB3xOKKEYBYgMUnAR0DICci3lPWcCoKt01JXKLy01p8Enr9sz4bH+sICJE4LWoP/TKLEIOBL6SB8kTcQeXGQuYpUavHvPIE1dhFBJyEWYeA5NBm2DQIVMwAni2xJGqvgFrhRTN0KEXEthddRUEAOkCBwrE0iovq10WFORQ+ss+0IO1+gwW2TDdxksjEULVgswE/GQwExw49p1g0XoachR4CTpEuWASr2RwAwALo9PFDI5o1EeEX8Zl4i/lU98Sn+fUBkvtL8qjUkC9bumYJW9xkuWkQQQMRIbzd9hYx6BpJQql5zxD0BS0Q45MloA8y5DqOBqrBcDa4HpIHUIWi5yfKUSFnA0VmeXnXesy7QG0pJPnVpJAaYgamIVKc99hLqseSVr7BO/UwEW2KbdHIMaynONt9OyunPRL6TqiVzGYcIHx4UmA0hDMIbSFHIDPVMpgtJxRW4+8CNqNGOag49mOFPmqb2s4p92siYj0H6uHOxeRbz2R29FOinDeoQtIZLCSXkPaXtgg4kEYSK9lZKjjsDPzMbAcR9GDrMXPJiD/NkI0qq0JKbRgQB/rKg2w+WuotNN/QrV1lOdCYPvAwv9NQmoI5AlZXmSDI9UfFrLGVpQ/fopyphrydTlYXCY6eBmMls7iSJMYA1+FDU3JB1PGRWVyyi9lJuIc5jEjGoaJRxlHE8nLS8DdxxXpwCpxWiXn0t1WsxKCSe9X/f5G/W2mBgVUPFDR4CTVdm6Sszlwl3qZJnrR7nqQJeDaoJOpCNOHh4wwrimdL48xThNNUlHPjGbUT1BObvR9FR8gBs4rbRjtUbbM+ldi/VUeZC3r3xkCZBpmapr/4Hxouw+KIqlXoziVzntIaPfpMOSYpWuonaZS1EDVDHxKW5twk05qxJ2OZw094wr0cmKppWAUz5JSNkc7E7mZhu1w6A+paXBbHSQBwP5yqiQKZKt+f18wvzmXDfu8/+K57kc9jXlh+5oqmIzjeZQt3vcVrHsRbkRys9Yk8HlhRrn34FJoZGwVk+TM8Y2Ibm2j0pOm/unxSor18gyrrmw0NV66ft8YbmpGL1+pO4kteO5QqTchSzi+Sn0sMkfrCALjyPOCtNVOreOvc9XTDd0CwQ8VEipLsiZ55pEuhVTwfZrth+wobVR5mDm3h0xcwOKXRA1Fq69QC321/oo672RJzqvP9YPTXF5qa0X625oGZxqdT4LDuxQyfep9k464HxA/0C+Dv//MBicd60+lvxGQVMJdFLWUZ/2Mb8LUMTRArnOoHbE/AtcRk7mOrqarCBc6+bpPp7Pl/CulmH/hABe5pCO+VOBRp4i5TzDl/ag3we/MUj7WNd5tpbeUrv4dUqgcel1VMaZsYi6/2je4cae/OHRiX3YPLWP6g34ZfOj2Wndbuw39r+vJ79IoNKvYvKLkSBt6ZY76UUkyBYrtOdRgPnSklZpwez1S7prXTCzd2aMwZUXuMHzNv3WTOFADrRxVCXNc8pNVIQ+4zAka6q6spul0v8ChCC853L1V6J0RmJ6Y2SyjRKTKUNwpbCJOYgplG5xL+4W69PbAmtuiRhMVPSInR0ImDs7uEikKDVugbwyRF3TA8kUAxZ8mQGPz3orVJ8sOhq3ve5wU4+QOkatcp9JM9Kl16SfPtUC0BJJV0m3D8rwSxt8JeeifIvxAyfHR8eN2ezErjfg1/QA/7KPnaN6tlerjXVd6GdrBVOZOLWdukabeahJwz8fKTXAnqp4pddzzB6S2gdk91wyDaCW31/FcdXYJUnkXGC9cVptNKvNg3Gz2dpvtg5Pao36wV+RRtrsd/8ZPDwOOa4B8x3Y7DfGzXoLEGoabHIaqLfW1Tbxwaad4TZ4e3Bt3SgCda+yoenkqA5PmnxPQ2dFPZUAnJNL+L3RlrEjYu56baimX+bdRzDM6jziZJ+CULZDR/d/qMvoh1hgEEjj2Glc0akDJ2oN9oE7QK+ir62JQd5F3MZ+dO8VwpyorVMzBfe1jdvYsKw4Fnx6VD9tHsyODjhvnhw0jg+npzO+v18/PTylfW1fSMnnr0glz0QgItfGNipI5O/AEFBk4D0hQIu/PnkkGK8M3WpsSqbGl8WQau+CE/3QvmQHx6DNwTyh53y+xoSgOsEtpiDxPIzF2pZ3NRKDyJ27G0O6SYo63Y/W5BwTxHRbC2GVNoaswMQWQBV0YRHeE8aaALQ5KTzqgtfYjoa6k/ZG04F6i0Hv32tvDzP06htm5EGzWRT6BVMiu/kWs3duTdR2IWih3fMYsv8pl3SehobjiR2xjKvnmpM7bAHZi4je15iVdbzSJJWiH3cc1Sekkx0JVdum5QYR1bXXkpuMlUVpZA7kPC8UNA7A/BX5lh0ngByRmbfCVFs0ilo+gLPiXBG7cY5pxNJVEHM71r12O4yozwDxlbm020YWTM1TcDyBGZd6rLxfJHd3oZDpxCG9U52HF+3u0gP3UyXS0hd3QhufpO0e8kYi35jUHknXGDRZj0rFZQyfgf/3nK3tbm13a7uvtN31l0N9Hk6/pdSnUU59JgHu6YcRBc9S6qOqgiBkZpDqHilB7mKNolOkP34Zg2F/FQHtg39b4pnAN8yPVCjf0NYw8lDPp+YEjgn9mSwQQeKjomAGnkg4LcI7wzg9THhQ3y+v9jGMpi4oaLAhRcQzBGwVJmpnOQloH5XLXdpiCX6K2YLfCbOXTh6Qzgs41SXtpG4zyW0muY1G22j0m4lG20xya7tb2/3ftN1nM8kUK7IWnSfJxPfxLgZpmn6P1HIGA5i5mcFSkyNRrWcrCIylOValmDlUps3GtDE7tsWBww+co/3TWdM+avLD48ZxY3rQPK7kY/1VZsepkRVtKidvJUdiMZ1AxKN4oFwyDkOn2P4D9kZiRlvzcZYSg+wggXu8TnPH5umGLbAwZBe4GaszJFnIIYOMR+jTYKyPYyMzlg58zsEvBngmwA3VxRHXFwAlwjaqvnNUo7M5ADdaVa1ZDKQoQzFKlq6iz7dL8gReiFlzCIrl4sbcDHM+gEAZ7By88xtmp1pE/1Qmz4ZI8TlSzLrfbCHQ0NPM/XBTf7eHB2fRR4yUgJ9o9EZmtycJ0pOrad65zc+3+fk2xm9j/G8jxm/z863tbm33f9N2vyM/19nQ0/k5DHh1fg5ja3WW5lIf6cDHvztNJ1PRGJB6s9CmI/pOloPjQTgBD914RYvgNeK2UmULkna0TNcJWurMW1Vlbi1166pyjZfc1fUJWG0ZSnJBeP++VdnTVxf2HlzncU9fIdszh5zxAAmll4qyJPJgyiKOl7K1t/cAAgdBP9b40q2Z68xBeF+zQ3/vbn+D+8rudYEDdBJ13QE/PKAWqZGYIpcOEZOa0wJKaPosTkWC8KjB/Cx8c+BsBdQxBWY3d5+HHuM1PihJfpI0ukZaWKIRaJtE3uNL9Hzef44OBeQJOjax79m1YDwDLNfIQ/SvMyWhAyJq9ZKqZPEI671mabEBDmuyD4JHeIeBtkDe/fHL+D2bY8ZKHiORmCwLl851cXYJKkIe0TLbATiJglR2Dc0qbLigBbKZp76TMRKCXZmPZ/QhVAzBtxNLrcL1zOt3RjKOuBMeRtFaxklUPLCCPeDQXvFa53uKmFRauIE6gKPuTFT17cvsgL0ikSpFdrU0dPEcXT+KxO8MtKqCViVo8v0aFoq1V7Y6wGODG0AQ3JPErR9eXMGr5uBhHQZPEOo6DuoOKeFR3CazjdR+GI8CvCrCK+LxS/CFjkwXp5nrX/r+VI/ZizCU4g+MoeqgGVzNE7CiH0aLzmlXySKqzXoOpapasupWIbkk/M7BMAKlTHyKwZ1ymxDSvsBRJnlLkgWbv6Xj+7cFmunxFcRgHOmEtvxhnHHBKi5YVT5AavxViEPFwuNmQAP5AaUA7Uz+5Ak0ojmfp2Bt9OoEfo/m0NlCQJWgyGVL/dHKHJz+xegFjk7HgAuu0Oc59MYh3nHVsOjYfZ5ZpquwzsEyvl4I4XWNbwrftKuFIfe/jV6k2MqaL/jViLf20k94kv8ev/sf8nhbT/Nb9DQ6W0Z1o2V1WZFXcpWtlVuBkg7vwv/hLVkqpeVQ9GR3cvNg8NNi6mIP2LS9oA+FRWIpeIyZ3y7qVeiTHUK6i8Yv9CXSOR1NjgBhDmWf6wG8GvuiP4gQYYWGxy4A6q+hLtVGwGW6oM46RnCQQPl+EuDHxgCJxGcc1OMF6eLnIhLlhPRVP4WQ+h5BOstYJKoNsoIuyYjIl4MZdpuhkM0J8YW1QIZSt5qBkdmNpkpGyFB4pGU4rph+vwQbNKe6EB6dRgcPCsmUyK1w0RuXIAKwQH/2IIzme3qS3MOxAARLHaUM+zWoDPER1ktQSOXgTvTX5syHF9Ir5cWPzq3r10PWb99+ue4//+U6HV2xLNpbYkcQhZ2oMk0Vx1cVPQFGt+jDcro+hl9phQw11wIrahj98IAtJCwXH/Hx3xKB/Ymr66wapCrafEcld9HkCS15N9SfontPm2D5T9xtxN50PYNV1vCowM+vAvskMI9uVqhGFqGiXuidkyrduMsmbvrYHVbIapLqj+WGl3aQCl2HywF9pmiqv7Hnq/YLAia4u9lPYJhOAjflQPoHDnp8/AeZkIPq +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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.** + +## Request + +

Path Parameters

Body

required
+ +Successfully uploaded the file + +
Schema
    attributes object[]
    + +The attribute definitions which form the schema. + +
  • Array [
    • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/import-connector-file.api.mdx b/docs/api/v3/import-connector-file.api.mdx new file mode 100644 index 000000000..965ed8ece --- /dev/null +++ b/docs/api/v3/import-connector-file.api.mdx @@ -0,0 +1,126 @@ +--- +id: import-connector-file +sidebar_label: Upload connector file to source +hide_title: true +hide_table_of_contents: true +api: eJztPWtz27aWfwWj/dCkI8l6+Kn9sKPIiqNeW9JKcnO7TsaBSEhiQpG6BGlHzfi/7zkHAN+25dSb9nbd6bQKCRyc9wsA863ib0TAQ8f3BnalU3HWGz8Ie77nCSv0g7eOKyrVihRWFDjhttK5+la5lCKAAaH4GnajcAXPKo7tdaQfBZaQNW6vHa+z5h5fisrHu4/VSsiXEkdN1YgKPNrwgK9FKAJJIB0Plt5wAFatePAC/qTAAU7VSiD+FTmBAPTCIBKAjbUSa17pfKuE2w2NDQPHW1buqhVbSCtwNkgOPJ+tBFOLMseuAyTxla83Lk5pWSfN48Zx+8BunjT58WGjeWC3jvcPDub7vNVunVQQ8Tw0R7Jo4/rclowzGW0A1Fp4IXeZwpZZhm9sAYxjr1zni2Cf7bnF7MC5EQH7zAP5moU+zqcpP0k2bbN5ZH0RYZ3REtyVPpPCg1X6synjns26ke2ETNzAYrL+wesChC/CY7dOuGKjydl19/RiMGQcpOGjmBhAMUzDxSzuuixE2N3xoK45KmT4xre3yMY8gy2Urhfiq3Xkhg5IK9xb+MG6ZvOQGF8QgT//DIQD6E2AChU6IGd4i2woCqpaQWAcFqjMHY8H28od/YOIyY3vSTW51Wjg/7JSuCQBIF0gXOKyjCzQKrmIXHdL3ALehQxJ3vgyrCmJaeZVMsRxkKBjkfLvfZYIfnfKHLuMrkBwe+S5W8PJLO6IsmMzf0HIK80s08qDw2ProHVigVbCL4sfLk4aVrPd2kcVV/ZRXDq71LsILLCG6PA58AgnmXVlcd2LrcEmb0NPXCf18oHlSM3hX3xt+QF4HB7CXFBBtJ1tHbHwbz0RFMU/EQsRCA9sDY0IFrn1AC02sEGkqPkjI62Hpafe5oGjv8A3iLqayOYCwQdmVTuBHDNEeNEa3dvgtD+cDWa/oX9LaI2fAk3lOpPFYXBqGOdomp6gIc32d2uI7ciNy7cZTSnF4GI7RPhkrpYbyfBRMSEoLqVvOSBmm/X0pKKMPDBhRMZYT+KXrhRRxEI97+OPkGnv/HI660+yIjUPnyxRK6a8INDDw+bh4fxg3gCBNg+PrHZLLNpNfnj4rAItQ6AXG6ARDImWW5YfeZAJBIFwyUVCzF84y8dNsqtmstRUpuYy/z7rzEv+/16y3V5vdDmcXfdGk0n/vDsbjIbwe/h2cJYV9gPjnix/zVP0eTFnLMXVMhun3MQ6OFG5ycFx+6h11No/4M+qEjvidGqcM7tSDr122Do+PPpYJu37FGgSuSVizKoPw0GAGAeMQJdsn/VGF+Pz/j/TCFaZXPmRC5EUQi0InUUS/MrtClKi+9QWof0UmrH1v4QKTi7P+1lloydPVqsgcsvTiKPGsdU62t9vNOkXP+ZHhw3wMM+qQIXV++oXSVKpgioGgpRQLiD1wvUwCXPd0YKqgIdDtpZsNwRM51EohjsRMEyrupmKmgZqwCALZRq3tHphHi7YDXcjHBJ5qGcZW0kA3TqQZhoFBKiu73+JNjRYA4YE34TRbAWi3ytxqwF/gDYDIkukFDywVsoywmCLmglPFw6QxGPKI0nPE5IDf50mN8bqHvyBAFhZ5Qb3Cvqu+q1gYVlqoNSE4KMTOMVQO0K6y0SEZEABAbQ5nuWv06OICKljkfjqyDD19icJ1ZMia8/kjB/AYX0s1dIdHBbyqUg1Tqwq75RyTUw6ZBgLRakj0SPJaLFwLAdQeXFKP9QpzQWYvxgH/o0jAS4sdI+444AURJ40rqDXO6NaE7yXfyvJk1iQPYEq/s5N9bNJwWaAIsxWi+rCx/QKoBLCCv0lLP1gDVClfoqPFR4EHKsdJxTr9PMfWEVCbjns92ajyfW0965/0c2VHvm3T5aK7m/sXFMeHR09q1xK1r/YTtVDkkoW4jn4b5wa8448uxqvuSvTwJI0osAqxamHOn/zVrvFkxakjn8Uu/4Y0HkCdBn40UYFnA0Uxbd+YI99FyNAmSLmrf9PVMxxdzp9P5qcXo9H54NersuRf/lktdwgD57Q6nhutSxZ/2LLxlpCbKxe76yguZbHOC3prdHberni5nmZVbFsVQi/xLxx0D45biQqllT0Bfyrf2SVI2R6vMqvwrMheBWWQM1eCB5GQalGZ7k3oh/cZWZGUvrNBbXY/QAZON/GHfN6iX8uVveXs3fYd+t1Z314jDXkaDqg36eDCVjw9bg/uRhMp1DOT+nhtDf6tZ8y6/6w++Ycx190h90zeHM+Gv3jcgwPhqPrSXd4Orq47vZ6/SlOH09G/0QWTvvdSe8d/Jj1oWhVa18Oz0e9f9CP6Wxy2ZtdTvqn17Pu5Kw/w7nTd91JfzwaDGf6oYL36wBxGwzP4I9nk9Hl+Dr3cPrbsJd/ZoSKJF9OJsCB69Qj08oYDc9/u570//uyP8XFuqenA2xrdM+vzYjkJRDbPTub9M+o82FwmV6/6/7av77oX7zpT6ZqWIqhebTgrSbhwTFlDCoZVhRggQ2T/luQ2OXl4LRS2MZ5isp5Ruc+eD+ztE51qETUuz56jmTo0GvhCjz8ckW7MVhgqP0FghCrYfl0KGQ2vgTdjreTwGXFk4tkl0MJBFBFKafq2YxFsHYkpqFSw8moejkQcJGWfyOo/NJpEuW4UM0EkhJfimMKojKVe5DhNsJwFshMUz9Dwis8dMVQWQe4Fv0mWFlrK0cOi2wECoW2rtkAJdpNAJFBdg1eGJcRuPvlYN21EACdpXcd/I3mNHjuvD0THvmHGUxsH7TG80ODEguAI1A0c9qIIvbgIksRqmr21Wu2FuHKt6VpXOFk0DaV9tME8XUDI1UXASI5bpARIuRaMqujpoIYbjDCAHEQ+b9uSTgcoK6gsNQ6y95T1Wl0mK2S4VXaHksqEMRDAjNtofYUySL0NOQocJJ0ibbdlHpnSxhcnsIoIZMyGuUR8Zdxifhb+cT79PcelXF964vSmMhTv+sKVtFrPGYZUMhBPmWh+dtsxgOQlFLlgjP+DkgMN0mJI9MVMG/sO1Dbs0EYN4sgaDnIcd0cAEfTPa2y89PuWC8kjeRjp1ZQgDmImlhFynMboC5rXsk6e8dvVE8H2KbdHMPeg2O8nZaVKk9j9UQuU4sCd7XRZAah2o1eCyxeaaZSBKXjitxN4mAINZoxT8FHM1wo89ReVvFPO9nlMhDLxM8Vg91OxGt/9FykkzLkI2wBkRhOzHsmt54FJuL5kXS3So46Aj8w21QCzFpxbwnyZ1MHG0xaHWi0J/AAAVFthsuqotORpQ1xhzr5nyPPoo6EtmyRUSzDIxWfcjlDh039dYwy5loydnkYHBY6uMXbS1EQ4N67wY+iZknScZ9R0aEElF7MTcTZj0JGnTolHGUc9yctjwO3bUenALHFaJefSnU6rBsTTnqf9/mleptNjDKorH1bgJMlPQWlW88hbK2cjaIR27H0KNW/1Z0mNUHXa5DVo4cHjDCuKZ0vTjFOU03SkU8sFlh0qG6x0fRYfIAbOK24wZ2j7YH0rsMGno16kLavdGTxkGmJqmv/gfGi6D4oisVejOJXMe0hoy/TYUmxagM/gLIqcyhqgCpGa4pbZbgpZ1XALoWT5p5xJTpZ0bQScHXaAZGyONidTM02aodBfU5Lg9noIA8G8oVRIZMlW/P74YT52blu3Of/K56ncthdyo+OQksVm3E0D8TG5ZaKZY/KjVB+wJoMLo/UOD8Ck0wvJFdPm/0edWjorZIT9mOSdkZpfVqopeOCOTcwt15pARxXtthxMB2vhxtBU8ixIWoJ5QVNL0xuJaiE7oWpigLy8fqyzroQOSHPjje/q+w9aJDN4YcIrTokSAu29SOyAVWsYXxhp8J11g7q3Fs6oEZcqtLIdQSaKYUyi0+xEXDZkzefGChusGXx4UhU2U/Y+PtUZxlxjDbCo3yxpnFD3sdG9jgf4vOdTD2lVlhW4pxIr8WHsjIr9FywwseXweinjuX9K+IuMt7ONN1+4TecWQhLmXYclmTOazhYzS24lcNRcsfdUHodD60jW2LyMkjH+5ilDdR7GaRUxtKHIiJ1VvY/ldHZDgTVQO+YojZh6w/+n0HzW2UluBuueithfZk5awEJTaXTblQr2CKY0hZtGreriuXB/IiOOq2BRFBwaju6oBOzFbjale+mm6vInSWd6omPVcKjdqu4YRxRikHoNhDXZqOha73YMNResc/kF0ftY6t12QbKxyxdzcadIgHPnHLUlhROc993oWgooPBebUVHkIOkAlicJNHBVdOM1i0Ys087Dnw871knmAseuUDoAmKJSOFEf473clGV0GBVz/3hjdyLeAaLp+iyFpCKz2r++dtzZ9i8GXaHvb7y8NlGfOHtkzvxCesoXCre7dqXb8E/z9qXfxSbi22p6FSrXhne9jv1kjM9PznDeq/i4VTcUgRDiHbwjFBb0Eh9bgMsL6iypUOla+xxHE/ZM6XoUL+tkiY4GopBDnQUkr0MU6ajywlowHQG4fP6Xb97PntHezISq8od/DY4KcBvvcGy8pZSDH2AQXeSaGUoVsGhsVsuGbjw0HStSHlT2tJoNWuNk1rreNY86Owfd1on9fYx6MzhYbvR+J+Mhx7soKiz+Ax1Eu92jlu7navBJTKnJuNgQL4SCbZWPiS8KJVcqzabNeXShxQuMHS2U8qSdhbJXPYqyejRKb7OrEun7jOMzdR7u7I5FX+z9aKTFbFt0p1avDByQ+y4jA1DayGonI49STQgTmtQqeAWT8grWqvWgH9B0fY7B41Oo10/bh2RhkHtTdnHcyBEuh4D3AWt/VqjWWu1Z83jTuMYMKsfnyBad6UHnNW593Q29zGfb1fUXYn9susRPRePErF+EIDYamxiGm2OPhWha6O5b9MtEce7gcSMDp48070IW4SQsvR8ewfdfut4orYMuIMYCkLZgomqNqQm8BpPyyiQxhppXDYPBE7Um+wNt4FeRV9PE4OVQcAt3C7YResvPQfmMzMFHY3pbJcsK44Enx82Tlr7i8N9zlvH+82jg/nJgrfbjZODkxPSPCElBKfHd0LPBMgdnL7rWyCR34EhoPjAe0KAFt/9XArB2NG3qLExmRpfhre7quDx3/TGbP8IlN5bRvScL3NM8GqX00IiBJQrwKPAWTql90hMPnPaf9u9PMe9xnjXEWEV9u26ngnNgCroAkQmwlgTgKYpIVW1qHH9s4b6c9y6jgfqHSBd9OmADjP06iUz0qCT05HGlCx1FY69cuqiXoVMDt0DHU2cc+zC6p7cz13LEpuwdq45+TNGUVsEr6HKTBqS+vDimlMXl9u2auPSXaeImiGmIwoh38nXQwkr82mpcSDnaaGgcQDmO2QrVgj1G+lExgpjbdEomtTJ1pzLYjdLMY1YuoV4YoV6K4QOd2ImDLQ5tBlKFky9bXA8nhkXe6z0uVNydxcKmdPQp3eqMfSo3Y1dcD81Ii1+cSO08dFZDuWNRLpvrD2SPuhBk/WoWFzG8CE8C9d+sd0X232x3R1tN/9yoi+F6reU+jRLboZ6uhmBwbOQ+gSkPZ5vbsnqY7pKkFXMo3WK9Mv7mb5ei5smXzeYnz1jfqRCeQH5biwP9XxuzuSb0J/IAhEkPioKFuCJhN0hvBOM4xu1+412cbW3fjB3QEG9khQRj3jETc0g8mibm8sq7YDhifUVvxHmqAN5QDrOYddUJ+4lk3zJJF+i0Us0+ttEo5dM8sV2X2z339N2H8wkY6zIWnSeJKP1Gj9IQpqm3yO1nMEAZj5PklxkJ1HlsxUExuIcq5LNHCrzVnPeXBxZYt/m+/Zh+2TRsg5b/OCoedSc77fwiH0S668SO46NLGtTKXkrORKL6YAonpQE5ZKh79vZ9h+wNxALOjkRJikxyA4SuLuPce7YOinZvfJps2xrMiSZySG9hEfo03y8pgljAzOWzuMuwS96uF/g+OprKNhrrTG6sqBbyeoOLsANtrXuAvfClaEYJYtXcTzLjQBD8gSur2643nInjO/aqXuvfAne+RmzUy2iP5TJswlSfI4Us/5XSwg09DhzPyjr7w5wJxx9xFQJ+J5Gr6p2uAcKEB8sjvPOl/z8JT9/ifEvMf7vEeNf8vMX232x3X9P231Cfq6zofvzcxiwc34OY+sNFudSb+lMz49O08lUNAak3sy36AaFneTglFfg/RQYj18zRCeCn8nsVPb03ZC9b+ZLmXd76lOHtfjogDqPgZ/vxFxRoRkFLsxeheFGdvb2voH0QGp3db5x6uYbMp5/W7f89d5Nu8QXJXfowJvZkTqN0h0PdMVRJ54HDh3YJp2lBZQE9Nmp5Nzmg/DNEZwt0McUmGrq7hQ9xiuTUF/8JPUJVuRYgUag7TJw7x6j59f2Q3QoIPfQUca+B9eC8QywzJGH6H9MvrZKXzlQqxe+uZoEFyzeikc9Rzisxd4IHtA5YtzPePXL+9lrtsT0k8xfffhHOHSlhLMxqAi5t67p7eMkijjJlb9uZvcEzYktXCCYffCmQrArc1hzCH5/Ao6aWNrNXIX9+MpIxhY3wsWQWE+f5F3vOba3Bxzay16hfa2+14R1QupkXP2DZw5BJ5cZFInqMPbVxtDFU3R9LxL/YaDVFLQaQZOvc1go1l5Z6jSOBTaNILgriVvfvbiCV0vBw6IKniDUPA7qvi7hkd3zsozUvhuPDLwawsvi8cF7v3Ks/B1oc9VO31Ub4Ck6X4r/YgxVB83gahmBFX03Wre4aI0sotZqpFCqqSVrTg0yRcLvHAzDU8rE5xipKVHR38Yik/xEkgWb/0RXJT5laKbHVxBQcaTtW/K7ccYFa7hgTfkAqfFX8QoVC8+Y4UeG0OiVAvQS+ZMn0IimfJ6CVerVCfwezcHQYAGqBEVuOuoPncTB6V+MXuDoeAy44Ap9IUXvAuJ9Yg3rLjkW/rv+Ap9qEeQ5WMTX9SFW5vim8I1bVBg//2r0IsXdpJOCHwB+bi99jyf56/jdP8njvXiav6On0akvqhstq2uEtJKrbK3Y15P0dTX4L7wlS6UcGyqY5P5zGszG5SHqNNm0tXIEdQQ2goeY+VVRr/w12SGku2j8Ql/YXdK5ZLxAxaGGc1z8viN7rz8+EWC5hWcoAOpnX9ddU+AyfQyAnRrBQQK1XkcefrcRkIjWjIN6PCJd/DRHpJyQTvQVQurbD/EsY5GoNsgK+racCNZytMDWsYP3ACo7rgUyNF9OB0aiRPQ3gBJCJvrLhzgum34/Bhs0p7YS7gYLPvCgkEyJ1AoXg1kBIgDz9Ccm/GC5pyfJPRwLQLDUUcrQrkOZh4+wdILqNAVXfUY+/8F+vPeUXPXIfAY9bpr/nf4eAB2dsKzY22B7DJkVqTJH1ZlX+i9iQLl2Un8nQ3mpCcXLCqtUmPbtGzZWsO66w8d0sxGef0zKKipHzcdf4hs197L91URT8pq2hjJ/r0MpHaYZ6G2TPkAFfn4R2D6IaaEPVqkuD2GkXutthRpd0kiml/11CFhxqkmqeZQaXthewfIuLujHI/rE0lz/LQxr1ZtAwAS3mvwEvumkqiyn0D9w0N3d/wLNq4NZ +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Body

required
+ +Uploaded the file successfully and sent all post-upload events + +
Schema
    owner objectrequired
    + +Reference to an owning Identity Object + +
    cluster objectnullable
    + +Reference to the associated Cluster + +
    accountCorrelationConfig objectnullable
    + +Reference to an Account Correlation Config object + +
    accountCorrelationRule objectnullable
    + +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 objectnullable
    + +Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient. + +
    beforeProvisioningRule objectnullable
    + +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 + +
  • Array [
  • ]
    • passwordPolicies object[]nullable
    + +List of references to the associated PasswordPolicy objects. + +
  • Array [
  • ]
    • managementWorkgroup objectnullable
    + +Reference to Management Workgroup for this Source + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/import-entitlements-schema.api.mdx b/docs/api/v3/import-entitlements-schema.api.mdx new file mode 100644 index 000000000..7d7defb27 --- /dev/null +++ b/docs/api/v3/import-entitlements-schema.api.mdx @@ -0,0 +1,97 @@ +--- +id: import-entitlements-schema +sidebar_label: Uploads source entitlements schema template +hide_title: true +hide_table_of_contents: true +api: eJztPPlz27jV/wpG/WETjSVL8q2ZtsPIiqPWllwdSbdejw2RkMQND5Ug7ejz+H//3nsAeIjykdS9ttofNjIJPLz7AsCHSsznstK+qozCJLKFrFzvVBwh7chdxm4YVNqV8cKVzLrssWTphdyRjDNJY5m0F8LnLBb+0uOxYDPXEywOmR0GM3eeRCId+pNkIojd2BM+/Mt4HEfuNImFrP8S/BKMQxYJeCLuYPoig+OHjjtbMR44eu0d5oVz5gbwrucQwBXrh/d1hlA6nmt/ZdWq5fhuUK2y2h/gj04YBMJGSqR5pAk1f94+qAd97ovHW/O05y/DKGanPOZrj7oZHSmM0/A+QPyqVUTkD9VqfzDutlnKOfgHeOrOA+CSw8LAW7FZGLFT4bm+i48+IsWKVbJerVZ2KuFSRBzx7jkgA5fWzi89It7DwCWPAPNYRCjFh4qLIlvyeAGvAniBkx34HYm/J24kAFgcJWKnomRXaT9U4tUSR0kQQDCvPJbFL5jiECNA4hsHceOMY7t50hCHR8dHnO8L54SfNKbOiXOwt79/0NqbTQGWxufviYhWGUJqbWR45TsQwfEsnBUUSRouZFj9MYP++3kUJsvK47UiX8j4Q+iscKl1boDGxgAPX/mJF7vA1HgXROTXHNAAfFxCM5z+CoqFAohQVrELtgNvUXfLxOxUEBiHBSpTN+DAjEf6DxGTS1BONbnVaOA/RbpHiQ1aIWeJB2qj7AA0xthJpYA8Xy7BCkhvdn+VOP31mIN0N+BdVgbXQSng+koH6wX2t+yT5nHjeO/AaZ40+fFho3ngtI73Dw6m+7y11zpBuSo1eM1agZb5U6tx2w4TIJ2Axu6dGBBtYwL8vQsovjCcBDZKjxRQJlcSnBw84TE91o4vEksQH1pjEauJFBGi5GofZRl39/04pZ6SJRKlDs6Ve3ZC7hbfJ4ELis3USjNXRORYeGCIcYMcwkUspXVhKfaRJaK9uRIc+T8TXb0Cu+MeYP1qVGFaDMsnrlwIx2C7AGp5ZC/eBt/7RSiFwktmgmUhjIo0hhJR5Cxdt84G6Mkj4Yk7DmOBWnI4moQ1pfCFPxXRYEaKEdhe4ohLEfmulBiccqhPw9ATPCjh/tHjGPscsu9gDhgLhVzEglDppYbLlhlgdu/Gi7x6o0PDuUDKfB6JuQL2BOdn3JMCEJ4JHkM8z6PJo4ijT4f45ctNnBdB4mNiYU3Gn7r9ca9jjbvwuDO4uByMevT7tDfsdsY3l93hRW806g36I3o46gw+d4c3o86n7oUFT7p968M5jr+w+tYZvDkfDP48uYQH/cHN0OqfDi5urE6nO8Lpl8PBX3+Gf0dda9j5BD/G3YvLc7X2pH8+6PyZfozGw0lnPBl2T2/G1vCsO8a5o0/WsHs56PXH+qGC97mHuPX6Z/Dn2XAwubxZezj6ud9Zf3ZpjUZfBsNTJHkyHAIHbnKPAN3BBB4N+uc/3wy7f5l0R7iYdXraGwMI6/zGjMheArHW2dmwe2bhEIPL6OaT9bl7c9G9+NAdjtSwHEPX0YK3moRnx2xi0IZhZQGW2DDsfgSJTSa903JqOaAf3GNGv5SLtcEpTEEfkyVmPeBHppgE6vwIMsYqy+sU5lkiTUnVHMmWXMpavAB7nC8YT0C/wUGqyEgQUjXcPN0OIeOSoNvmjR2JbHKZ7M1QIKtNogDt6xSyDTvOGbyGU1D1zUDA+dnhnUCrMp6FPCd42EhSckxeR0FUpvIEMtxBGO4MmakjJ6amIuBTD/PSCNei3wSraG2bkfPC8CsCBa/n84DPCSUUowCRQQEgAlpGQK6lvOdMAHSVGbtS+aWl5jT45HV7JjzWHxYwcULQGvR/GiUWAUdCH+mDpInYg4vMRaxSg3fvGWTLixDqGLkIE8+hyaBtEKiQCThBfFvCSBW/wJVi6kaIkGsprI6aCmKAFIFjXQQJ1beVDmsqcmidZV/I4RodZots+A6DhbFkwjoFZiIeEpgJbly7brAIPQ05CpwkXaIcUKk3EpgBwOXxiUImZzTKI+Iv4xLxt/KJT+nvEyrjhfZXpTFJoH7XFayy13jJMpIAIkZio/k7bMwjkJRS5ZIz/gFIKtohR0YLYN5lCLVjnfViYC0wHaQOQctFjq9UwgKOxjrdYeen1mVajmnJp06tpABTEDWxipTnPkJd1rySdfaJ36kAC2zTbo5BOee5xttpWd256BdS9UQu4zCqc9BkAGkIxlAUQ26gZypFUDquyM0HfkSNZkxz8NEMZ8o8tZdV/NNO1mQE2s+Vg92riNf+6K1IJ2VYj7AlRFI4Ke8hbQ9sMJEgTKS3UnLUEfiZ2Rg47sPIYfaCB3OQPxtBWpVW5zQ6EOCPFdVmuNxRdLqpX6Eyf6ozYfB9YKG/JgH1IrKkLE+S4ZGKT2s5QxuKcD9FGXMtmbo8DA4zHdxMZmsnUYQJrMGPouaGpOMpo6JyGaWXchNxDpM4X38r43g6aXkZuOO4OgVILUa7/Fyq02ZWSjjp/brP36i3xcSogIofOgKcrMrWVWIuF+5SJ8tcP8pVB7ocVBN0Ih1x8vCAEcY1pfPlKcZpqkk68onZjOoJytmNpqfiA9zAaZmJ67Q9k961WU+VB3n7ykeWAJmWqbr2Hxgvyu6DoljqxSh+ldMeMvpNOiwpVukqaoe5FDVAFROf4tYm3JSzKmGXw0lzz7gSnaxoWgk45ZOElM3B7mRutlE7DOpTWhrMRgd5MJCvjAqZItma388nzG/OdeM+/6d4nsthX1N+6OaqKjbTaA51u8dtFctelBuh/Iw1GVxeqHH+FZgUGglr9TQ5Y2wTkmv7qOS0uY1brLJyjSzjmgsLXa2Xvs8XlpuK0etH6k7SZgBXiJS7kEU8P4UebjEEK8jC44izwnSVzq1j7/MV0w3dAgEPFVKqC3LmuSaRbsVUsP2a7URsaG2UOZi5d0fM3IBiF0SNhWsvUIv9tT7Kem/kic7rj/VDU1xeauvFuhtaBqdanc+CAztU8n2qvZMOOB/QP5Cvw/8/DAbnXauPJb9R0FQCpynrqE/7mN8DKOJogVxnUDti/gUuIydzHV1NVhCudfN0H8/nS3hXz7B/QgAvc0jH/KlAI0+Rcp7hS2fQ74PfGKR9rOs8W0tvqV38OiXQuPROVcaZsYi6/2je4cae/MHhsX3QOrEPG034ZfPD2UnDbu41976vJ79IoNKvYfKLkSBt6ZY76UUk9F7M47pnemlJq7Rg9vol3bUumLYFZozBlRe4wfM2/dZM4UAOtHFUI81zyk1UhD7jMCRrqroyt6H3T0AIwnsuV38lSmckpjdGJtsoMZkyBFcKm5iDmELpFvfibrE+vS2w5paIwURFj6hWIWBWq7hIpCg1boG8MkRd0wPJFAMWfJkBj896K1SfLDo+pLuZRYebeoTUMWqV+0yakS69Jv30qRaAlki6Srp9UIZf2uArORflW4wfOD46PGrOZsd2owm/pvv4l33kHDayHVptrOtCP1srmMrEqe3UNdrMQ00a/vlIqQH2VMUrvZ5j9pDUPiC755JpAPX8/iqOq8UuSSLnAhvNk1qzVWvtj1ut9l6rfXBcbzb2/4Y00jED9x/Bw+OQ4xow34HNXnPcarQBoZbBJqeBeodfbRPvb9oZ7oC3B9fWjSJQ9xobmk6O6vCkyfc0dFbUUwnAObmE3xttGTsi5q7XgWr6Zd59BMOszSNO9ikIZTt0dP+Huox+iAUGgTSOncYVnTpwot5kH7gD9Cr6OpoY5F3EbexH914hzInaOjVTcF/buI0Ny4ojwaeHjZPW/uxwn/PW8X7z6GB6MuN7e42TgxPa1/aFlHz+ilTyTAQicm1so4JE/g8YAooMvCcEaPHXJ48E45WhW41NydT4shhS7R1woh86l2z/CLQ5mCf0nM/XmBDUJrjFFCSeh7FY2/KORmIQuXN3Y0g3SdFp96M1OccEMd3WQliljSErMLEFUAVdWIT3hLEmAG1OCo+64HVW1VCraW80Hai3GPT+vfb2MEOvvmFGHjSbRaFfMCWym28xe+fWRX0HghbaPY8h+59ySUd7aHgVAoJYxrVzzckqW0D2IqL3dWZlHa80SaXoxx1H9QnpZEdC1bZpuUFEde215CZjZVEamQM5zwsFjQMwf0W+ZccJIEdk5q0w1RaNopYP4Kw4V8RunGMasXQVxNyOda/dDiPqM0B8ZS7ttpEFU/MUHE9gxqUeK+8Xyd1dKGRO45Deqc7Di3Z36YH7qRFp6Ys7oY1P0nYPeSORb0xqj6RrDJqsR6XiMobPwP97ztZ2t7a7td1X2u76y6E+D6ffUurTLKc+kwD39MOIgmcp9VFVQRAyM0h1j5Qgd7BG0SnSn76MwbC/ioD2wb8t8UzgG+ZHKpRvaGsYeajnU3MCx4T+TBaIIPFRUTADTyScNuGdYZweJtxv7JVX+xhGUxcUNNiQIuIZArYKE7WznAS0j8rlDm2xBD/FbMHvhNlLJw9I5wWc2pJ2UreZ5DaT3EajbTT6zUSjbSa5td2t7f532u6zmWSKFVmLzpNk4vt4F4M0Tb9HajmDAczczGCpyZGo1rMVBMbSHKtSzBwq01Zz2pwd2WLf4fvO4d7JrGUftvjBUfOoOd1vHVXysf4qs+PUyIo2lZO3kiOxmE4g4lE8UC4Zh6FTbP8BeyMxo635OEuJQXaQwD1ep7lj62TDFlgYsgvcjNUZkizkkEHGI/RpMNbHsZEZSwc+5+AXAzwT4Ibq4ojrC4ASYRtVX3+q09kcgButatYsBlKUoRglS1fR59sleQIvxKw5BMVycWNuhjkfQKAMdg7e+Q2zUy2ifyiTZ0Ok+BwpZt1vthBo6GnmfrCpv9vDg7PoI0ZKwE80eiOz25ME6cnVNO/c5ufb/Hwb47cx/rcR47f5+dZ2t7b732m735Gf62zo6fwcBrw6P4ex9QZLc6mPdODjX52mk6loDEi9WWjTEX0ny8HxIJyAh268okXwGnFHqbIFSTtapusEbXXmraYyt7a6dVW5xkvu6voErLYMJbkg/AxAu7Krry7sPrjO466+QrabP8aPh0goxVTUJZEH0xZxvJTt3d0HEDoI+7HOl27dXGkOwvu6Hfq7d3sbXFh2twucoJOoKw/4HQS1SJ1EFbl0kJhUnRZQgtPncSoSBEhN5mfhm0NnK6CQKTA7uTs99Biv8kFZ8pOk0XXSxBKNQNsk8h5foufz3nN0KCBP0LGJfc+uBeMZYLlGHqJ/nSkKHRJRq5fUJYtJWPO1SosNcFiLfRA8wnsMtA3y7k9fxu/ZHLNW8hqJxIRZuHS2i7NLUBHyipbZEsBJFKiyq2hWYdMFrZDNPPWVjpEQ7Mp8uqMP4WII/p1YahWuaF6/M5JxxJ3wMJLWM06i4oEl7AKHdotXO99T1KTywg3UIRx1b6Kmb2Bmh+wViVQtsquloYvn6PpRJH5noNUUtBpBk+/XsFCsvbLVIR4bXAGC4J4kbv3w4gpeLQcPazF4glDXcVD3SAmP4laZbaT2w3gU4NUQXhGPX4IvdGy6OM1cAdN3qHrMXoShFH9kDFUHzeBqnoAV/TBadFa7RhZRazVyKNXUkjW3Bgkm4XcOhhEoZeJTDPCU34SQ+gWOMslbkizY/C0d4b8t0EyPryAO40gntOUP44wL1nDBmvIBUuOvwhwqFh45AxrIDygF6GTyJ0+gEc35PAVro1cn8Ls0h84XAqoERS7b6o925uD0L0YvcHQ6BlxwhT7RoTcP8Z6rhkVH7/PMMp2FdQ6W8fVCCLFrfFP4pp0tDLv/afQixVbWgMEvR7y1l37Ck/zn+N1/k8fbeprfoqfRGTOqGy2rS4u8kqtsrdwOlHSAF/4Pb8lSKTWHwie7l5sHgx83U5d7wKbtBX2mLBJLwWPM/HZQr0Kf7BDSXTR+oS+Szul4cgQIcyj9XA/g1dkX/VGECKs0PHoBUH8Ndbk2Ai7TJXV2agQHCZTvJwF+6gyQSHzGQT1ekC5+MiJRTkhf91MIqW8SpLOMRaLaICvoooyIfDmYYccZitmcEF9YC2QodbsZGJndaqpkhAyFR1qG44rp90uwQXNqC+HRiXTwoJBMidwKF71xCSIAC/SnD8JovqsnyV0cC0Cw1FHKsFeH6hAfYc0ExVQO7kR/705fMsoXTOufvlvXsYes7779ft6/5ft5OqhiNbS7xGYgyjhR1Zmqi68qegKMbtOn7XRpTJ2wXHEM5dYCC2qY8fCAHSSsFB/xsfquHZbM5sMpuZslT6jDs5+x24j1V4EtkMJH83Sno0LftjM16Hci8m6oP4L3nrbf8t/424iG6bcGqzwCBj2YR3c6VAuNUFEv9J5Nje76ZRM3fWYP63I1SXXmcsNLe1eFfsflgD6QNNVf9/NV4wcBE9yd7Gf76lqnnpsyL/0DBz0+/j+Po96V +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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.** + +## Request + +

Path Parameters

Query Parameters

Body

required
+ +Successfully uploaded the file + +
Schema
    attributes object[]
    + +The attribute definitions which form the schema. + +
  • Array [
    • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/import-identity-profiles.api.mdx b/docs/api/v3/import-identity-profiles.api.mdx new file mode 100644 index 000000000..73b1dee25 --- /dev/null +++ b/docs/api/v3/import-identity-profiles.api.mdx @@ -0,0 +1,135 @@ +--- +id: import-identity-profiles +sidebar_label: Import Identity Profiles +hide_title: true +hide_table_of_contents: true +api: eJztHGlz2zb2r2C4H3qMKevy+WVHlmVXrS1pJTmerOtxQRKS0FCklocd1eP/vu/h4C1fTbvZjCYziUIC78K7AfDR8FcsoBH3vb5jHBt8ufKDqO8wL+LRehT4M+6y0NgxHBbaAV/hQBg2XfCQyLEhWQXsnvtx6K4J+4yPmEO4ggAvJYgawIjoPDSObwwNniTwb3eMgP0nZmF04jtr4/ixgG9UgaIEBVEgFB4wYCUKYrZj2L4XwTCESFcrl9uC1d3fQwT7aIT2gi0p/orWKwaIaBDQNcDhEVuGmee+9Tuzo5Ic+gU2U+rkBCQJXoGII84EvHsWhFwiV6A5UDhnAYxkn+ly5cKzRhHPBzmL+IECTGaBvyTRgpGIBnMWkZAF99xmiHDmB0saScitpvG0Y4TMnb3MzARGEcv17U8EQLzMioSWQA2jgHvzEtReHsx3ITmdDgnOQYjMi5eoEp1utzeZ3I3Gw7P+RQ9eqAfj3r+uepPpXXc4OOuf4/PpdHw3+Tjo3k2GV+NuL/PmavrT3XCMP7udy1Gnfz64A2DT3hienA3Hl3envbP+oD/tDwfw5Hz4oTcedAYA4nw8vBrBo/5pbzDtTz/eDU9+7nUzSJMXKX0X/bNe92P3onc3mXam+GQwnPbP+t0Owr+b9i5HF/L5qDOZXA/Hp3ej4UW/+zH7RPChsY+uTuD9ncLV701S/OOhwDm+Ev9MeueXMEb8Gn/oAwOnvckvd/3BtHc+7ij2JsMMQikq+DHtILjpuDOYoETE7/75eQ9EenUy6Y77IzUdyPvl7GJ4jZaZqKWGAxrFnfesfP+0llVzo2kfNQ7rh609p3HUoIf79cae0zxs7+1ZbavZalLE5NHlu7TM4eHKpWuC8/NYfxqTjh3xe0ZOwVXYkR+sjacnQKXsAn2F6w7BYm7KJpM6mBtJ2m3RLKRoCqa1DsGhmHPmobMFMmOPg7sDgRB/Jsx4qBEU+Uzp5k6j2WrvCSKoM/TctfRyGSHlsQ7g6RvgUxyPIrcBfsQq2OjiC/RDDrx/A+QmLKxZ3zObh9NG+7h+cNw4+HfWUSE4M+KAvYK3pe/wGa8i54KGEZGv7b+bLiAMHL+AckJD1vWXS987jXyQ3/NKQ+No4Qc8oqiBEz8O7AodyvH5ku5PgdnME81/MT7mjeByTew4jCCIzFwK4QSDlwpiMM6LXZdaOFAtgv8AmvtyCEFSxNDniMgDf21U0ZFC+2IUWgE5zNB4VZSMfPKw4PYCnkHCErAZC5hnMyJyAZHXpBJJAL/SvaW2+w5kX87z/RQvqWeidqJMc27vT9B3zV2X0yWBfzFVEu5xFXBU3HVl7pJNOvbblYqh54vsgnrPK2ijDhirbKVCB9+mQCqIfWn1eVts/KaVZ2OA1VXBmM0CFi7GiVtM6LR832XUE4TOaOyCRs2oG7LSYoHnIHxGaFppBBIoAfI8xhzm1AgsKUQGF6oGYH8OigqR92HBPJhmL6g3B+48wWQodIssaEgsBu+X1Mmro3KDGlnXj2VRUbKDstqD2lnSIarZIC5ACk7XYq7vzVG0m1xlIZXPEHSYoaYTAXtWHEEU8mZ8/rKbPmUz7gEVIBqBOpEh1ZBAAqsVaAyxBchYloghiBSX31HzF/4DUq/TGixPbN91UV8gdFJZRlBQmjICKB+98tqBJdssDMu1BvNQQStyAJSwRe1PzIOlBacFK+qKcmzpA0H31I0RlVRlFd92NW/AiYJbS9OEzRpYVIaEl2lAvRCXKlsxvrGSTJYEVFVBUykNvuDip/KbZWGW5VVSjcGr/EE2Y6xGk1o5FM7cRVeTEHyakFq9TiGj4QqkspnFzDq80buXsUUZf54gLODKJL+2jTadyMvILnDl+lHHEXCoO8pRSL11vnZQNJYTw6fbpyLhncDiQGywJp/Y2hTqS1aUByHaGaRrAXhcb02WLKKJhaVeOsvRY0q+XHuDmWLFdgzp7dTTy7UKrPq56AOpEHNwQA+b+2z/sN6AX3bdqrcc2qB7LenPdQY8rdCA7Pt+URuTCXk4pXHKoWV8Xe+zzYSwxgwrvrEORFUr9EKiScNPYxaChfcrA3bie+MYInqVhnEn0S+ABU4MgRUqXOuwdeiwI9OxjiyTWvbMZPvtfdNpz5oHbeq0m61DZC8Q3Gwy0lzaTj0vpi6RM6ojTsaK5bBa5XJslCWMhVA4hcIHaxsHl6Ns0X3PwbJLBDPlaRGpqnXCEYN0D0aoWJ8JLVpnqwLeG53w09NtmS0FrpJl9U63C1SN+PQk1BDoXEGQk+rRrNervZhcZhHPRQMUI0llL/KtvcdEbxOiBXxVyJKxoo6IFmlx3ZO3UA8zV8hYkoeEUhIClS7b2Mrj3swvF56wxImTBo1bQmSmc4bZXxQHHuRSG5qQmFVJ5JklfTEeaq6lzRPJ/K5cKXIpcZfYVs8zXFdNLzMM3vXlKKKBw+C8VV8NfhkMrwd3495Zb9zDFuK4NxlefOiNRTxkn6PXA8fRBegiJ0GHD6rmu/csk27P0g7wDcI/Jrps3QF3dEyU37YP2vvsyD6C0uCgfeDs79UPWq0ms//YEc7hmID/dWDttFe9NUQkiiA+vCJX0aSrCSIP99Y7mNGBqI4zUau2MU5Kj5yJVgl2Y5kHbyjbTFsouHhKzCnVtzjqgQYeCLtCla/lm60Sb5X4a1diFgR+UKHCPXy+VeCtAn/tCiy1TmdXFZqcZJqirJH8qZ7IA7wgagMC+wnxyhE/rbUsSt+s0HnMKpeqRpACf0/Nqbc1MeHyX4em2NN+zcaj3gRMtvRe2sz7Ezt4skv5Wmb+gv7kaaEh+WZSqluRxRQ7LQPyKi7T4kxakTjnspLfyhqiXVU2dF0OFk6kAzchk1eem+saTRx9IBYk9tiU4h4YL3f+VA1R3E9C8+yCe35Z5mfcY+Y8oBwpFOwSGyZi9+yeOyKHwjaEBKnLTDEuL3qQRK1BTqhDxoq/rmJG9ozsTwCruvTOE3Ql90r1FCy7dQlZgZYdMGrt14+a7dl+m1LQu8bBnnU0o61W/Wjv6Aix6xha0a7Loz7Hzia3ievbsCJ/gEBA80LVihPIn3M9+TUQMF7Zu5JjEzaXmSi1A9XcSXdE2gfEpd48Fs/pvCAEz7yaVO3jScDDgM955c6i9kinvbPO1QWeMVAnMIwdhFXaNOlAjiH7AL5ocYuOcMrAAw0hHcGGMLbjf1RQfwSGqBdmB3L5v1DskxNV9MMMhb1iRhZ0mgJpUxJ28zki3/Maq+0QC59BIWsviIUdDd33/7FjYwvEvFCS/JEsGHVY8EONdJKAqbvIS3BEFiMQSdF0JYBZDKYMxPBo4ccR8fxIHcJJ1yIVZbEfpZ3QRXZRXp26gF/DPpBgM2uFibYoEtX6AM1ScnnqphmhCZGuvYiCx5TbJrYfoNckFvDGIUQrd4TLFYLj8fS4xGNlfatwdypLETvjeLSAxuEr7G7kgvsxBWvJC5GBofGJpEF6I7EaepmUR1LbKWKyGpUsV5I8zzhzna3tbm13a7uvtN3iS91wVG9F6tMopz5QRslNfAyepdQnENrj+UQPkhtCciF3ML9TKdLP11Mw7E/ME5t2n1eYoX3B/EiG8hLxHZJWQfjcwvQjWazcWiCBQo6Sgxl4IgaVID5OKZaNZiGqVhnbmR9YHBTUq0gRwWsGZO3HhILIgtgTvSwa7hDHZ6H3XUQWFPwjtXH3VHpAsbnpmCufe9E2k9xmkttotI1G30402maSW9vd2u7/p+0+m0kmVAlrUXlSGC+XNFhLTVPv5b42DCB62z49BCOWqpitIDCS5FhGPnMwrGbDaswObNZ2aNvZbx3NmvZ+k+4dNA4aVrt5YGRj/U1qx4mR5W0qs95yHdUBqOAe8rjYA+UKI9938u0/EG/AZujW0PUkeTPIvIZnhXTu2DyqOJjg++QSTwapDCnM5ZBeKiP0aTB2iWMDPZbjicg5+EWPrMSxDaFKfMkAijjY5/IlF8aLXADcYG12ZhGwIg1FK1mChXu2GzvqhKA+5PhAOZ55nGHOBxBEBjsH7/wFs1O1RH8qkydj5PgCOSZ4QgaPkpIkc9+r6u/2gfgAfcRELvCGRq+sdqgHCgAFgfRZSd65zc+3+fk2xm9j/LcR47f5+dZ2t7b7/2m7b8jPVTa0OT+HAa/Oz2FsrU6SXOpMnPv9u9N0YSqKAqHexLftOBDtZp2Dixv18FDchQMkV5DXd6UqdyBpFycHHO9YH+sx1b2TY1gKTE5v8dDykoEuIkcrPxReiOJEY7c4KdyVBw0MxInJpeQrDlwYvYiiVXi8u/sIyw3L/FSjK17TEDz/oWb7y937VoXzwlMGob4U48S2aFp3Rn1VotTEIgUc7UA6TYFALpk6kG2EsHSivfwsfH10Y+3H4CYFmB08J6N0UjwGMldQkHwXqtvaKOISj8DbVeA+vcTPh9ZzfEggG/ioEt+zuGA8ASoL7BnyWLpWkQlm7hJ7SVHSaITVXrOEbIjDmuSE0QDKCrkB8v3P19MfSOYqOZ7tJoxjgQEWNwIVEf6wozcDcJIIUYEfzxeC8E5uuwXtj8xcYJj86k0YIzf6PPsAAsUYPLsQKU5iwpngrNvv9co47J65GENrqSRR8cAGdkFCuzQ37wcRL0VhwdPj5bVfPVMd0cF7ZmKMYlHUieRmpfmiGb7eS8Q/NDRTQjMFtPCHAhVStDe2PL5jgxNAENQNhbTejVzCMzPwsAqDJwi1SANKQtGR3ySz9aq9m44cPBPh5en41bsWVz7z04h0XSSEWOo6pE/she+H7J+EoOqgGdzMY7Cid5Ml7pmawiLMZj1DkilRmtyE1FLQdwGG4UllohaGdnUjcQbhVJrkb2JlweZ/g8LbIb/leBaPbyAC40jHt8N304wITURoSh8QKvrVuUggFmwbeRB+QCpAN11/4QkUoRmfJ2FVenUBflfMwdBgA6kCSrg6lv85Th2c+kXECxydjAEXbIi7b2rbEC+EKlhP6f1rKSzdUyhKsEyv60NwLchN0pv0tDDgfm38IsedtPWCH3v40l56gyf5evzu/8jjbT3Nt+hpVK6MLcxx+nWvnq5qbjJfw2qUPlKVHHDmmfuom48U6xPF1Sd+s9/2UePk125Kh+qf/SxK8SsoySdD3kxl8fsa2a9rNOovffniC8tm42cZZAFc+OjB4bMfHkgu6su5lXfkbzbeT1eXyjfeKdetpOJl7eJd7b/66vPta28k5+4Yv+42cP4ycPnGb+XlXHkbFqoO9O0Cc+HiK0YUWRqVu+64LbRg8De8FWFRVMDUjkTHJHdXF8GswDLEXXoMoPaCM9GvWzEa4dLvoBP3lyLoqc85sFACmotj+wF4B+pSi7sAr0auGQFpgfixGYInnADq777qikxg1UboEcmp9pIEP7UUe+o7MvGSgJm+5EodHoJVC9Zs3/OY5swXNVMyS4c/9NEoCnHNhIHKDmcTeacq4zFfwAUOM1S7OjTnd1JGxsyVX9WAcfla9yXY4KbNBXNXqAuQrkDlwjIYLvvTEkQA5kkdr/nBfFdNCndxLABJ/LDRqtVrdeGP/DBaUi8DV11HLn+9saBQj+le1ns/FCnNHOvk3RU2iJGgWNbtslFyY5QaJYa+k4E3XhbYVYFRj4/YScS+wRM+hiCEbaqb27QtgP9DkxIdReGbxK00Q21hmfhZoLRlVd6bw06FnCG7lM+OzTZ+RkPs1xqW+uDlUjbBAvqAHgD+PjZ+hT8YdVZSS2CQeP5o6JYyjPk9+TwT3ZCrqh/I5tPTfwFQoxkR +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Import Identity Profiles

+ + + + + +This imports previously exported identity profiles. + +## Request + +

Body

arrayrequired
+ +Previously exported Identity Profiles. + +
  • Array [
    • self object
    + +Self block for exported object. + +
    object object
    owner objectnullable
    + +The owner of the Identity Profile. + +
    authoritativeSource objectrequired
    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[]
  • Array [
    • transformDefinition object
    + +The seaspray transformation definition. + +
    attributes object
    + +Arbitrary key-value pairs to store any metadata for the object + +
  • ]
    • identityExceptionReportReference objectnullable
  • ]
+ +The result of importing Identity Profiles. + +
Schema
    infos object[]required
    + +Informational messages returned from the target service on import. + +
  • Array [
    • details objectrequired
    + +Message details if any, in key:value pairs. + +
  • ]
    • warnings object[]required
    + +Warning messages returned from the target service on import. + +
  • Array [
    • details objectrequired
    + +Message details if any, in key:value pairs. + +
  • ]
    • errors object[]required
    + +Error messages returned from the target service on import. + +
  • Array [
    • details objectrequired
    + +Message details if any, in key:value pairs. + +
  • ]
    • importedObjects object[]required
    + +References to objects that were created or updated by the import. + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/import-non-employee-records-in-bulk.api.mdx b/docs/api/v3/import-non-employee-records-in-bulk.api.mdx new file mode 100644 index 000000000..60335f881 --- /dev/null +++ b/docs/api/v3/import-non-employee-records-in-bulk.api.mdx @@ -0,0 +1,97 @@ +--- +id: import-non-employee-records-in-bulk +sidebar_label: Imports, or Updates, Non-Employee Records +hide_title: true +hide_table_of_contents: true +api: eJztW2tv2zgW/SuE9sO0ReTYzttfFmmSDjxIm6yTTIFNgy0t0TZbifSIUlNPkP++515SfsRuk3aLnQc8wMwoEnl5n4eHNHkX2bEqZKmt6aZRJ9L52BblG2tO8nFmJ0r1VGKL1HXNyyr7GG1ETiVVoctJ1Lm+i66cKo6sKdXn8rAqR3gX6dR0jMryTi6NHKro5v5mIyrl0NFHyI1rweJUD1QySTIlXnPTXJkyQuNUuaTQY1IJCl2OtBNj60pxq7NMeP02hC1ENU5lqTbEgtDCqysGtjKp0EaUIyWOLn5tiJ76rdKFcqKwGDLxWgs7EO+9yq7oJIWCxPewciwLmatSFY7t1KTJWMLCjcjgAzkqjR6qemGrIlGim4pnV1fd4+doUPhB4dmyqBS8l4xULqPOXVROxiTGlYU2w+h+I1KfJYygd6q1tbuzu5eq/T21nTbbB2q32d9KtpKdnbS/s5tG5FKSrFz50qYTEsf2wH94zKus1DCg3BzYIo/hJB5waWjb/6CSkowtKAdKrRx9rdsvKrgRkTCJAaK+NrKYRPf38+Zd+3439/f+vRtb47zAdrPNch+ElcMibqUTMknUuFSpKK3oK9FHoiFySC16Z+wtBVuWQooM0SlEqXPVgEJzJsvxONMJZ/HmB0cDPN1eBHKFtcvasloV0kym4oPt/+RE97gxi/QsfO3koLXf3N/Z3U922gfJbrOFp0TuDg6ayQD/ULAdp0r3iUN3jylPKZN9P3YU1ImDOgYVoEIFOHz8ZrVaW60tUssXwEqtpuGnoospBitVnX5ldeEnjrCr+rkuIbmxqFKzdRA39+P21mVrv7PT7uwcNFq77X+TKrlN9UD/MF2QP/MKZRKA4gHkG3RypSwrt0ojZaqciuD85M1x983PeNN985/z3tnPvZOLC/x1dPb6/PTk8uQYzye93llvGeh6qqwK41jNgc0yewvR4pPMUOYoh5TzG2/oOzJ4iBpzVBn4Pwq+TpAHWdp4Z97VSr2LRK5kGIEcAWAFhlQoMgmsvJXay+cixAgJBoB3SMKcMaukYEYoUInZBD1JxGLnqe1LXUeIRF8pAzQm71O53+pyZCsUu5kIVRS2cCyDfbbUfyB15mEjjMjdZ/0WAluHhvCp1CW/m5vnaHq7Yr/9YvuRh7HtZnMZuY4yDVvFCQ0iYuHDBi20D0DAZdEHMJNvtEEINXnikr96YPSfeUYjGJNhosq040i6sUqQ/UkwxZtljcK/QslkhIZGeQN/EAqmCkpkRzZVj0PSKwweDwsoDbNZQxiRcs580iklQG4LlB+LrBOT2y2WGtzbaImXyNRecNpRMIZCVMjkI2Q9BSOvjEZ/UXcROkUFFV8aVu0p2d9tHrS3B7vbUrb3t1t7O/2Dgdzaah7sHBww+iCZQEnma10WhZwsDf2zMqpAoDKbIMy/wyGAUPieFeDB0UWXKnePx4BlPMH/lEi+7dTMoK8gTrOBmfLl0bnY3gPMmWHF7+XwgRNMfEXAZKosk316RQQFlnvBZ4UeavM1pDs+eXV4dXqJN72Tf12dXOCJZC3B2qGpwQuqIhdGmM/LmQE8O6gM7gBaiBdB6ou5Qg8Ntf/LTRycidwaSKAeeoTRV/SYFy0Ghc0X6rMmgM90QzU2AEN4h0kFtdWXQC6qNGr+4pDJSXwaPPlCjJRMVfG8IQ7TVJORMqtROpeEgEKmqZpyz0EFfFBTXDO21IlajMXMlYvRmOHU6XxQqDig+eN5cpiUFZSree60HKbZElQM8YHO3nOL2l3OOY1dOgFeJbBCZgB8sG1QbsAdbNOlEwGOKFwOwGPqdjUMLsAvY+hrr8xxaflbIiv3hLo7zwA/MZs2/fBJheJzYUoAGnE06jAFRMJHMps7h1bTcNWFL8A9snRdu+vaXdfuE2v34cde4DrhK/Op1jKfujKygn8LnjyX+FTB2WOsqBsxvQmB5G2AwLt+eXuJwv4IMon26vOYlqU/cJXop/Il5Q+n8fDv+zVDr6f+WSxIQfajt8Bz1w7rPdOYHeVdtbU82itb9DUS1KzgnUDNQkxsJSRcVlTGkCbSbYjUKmd+KkG2gY+01HbOIyCNatJ4bLUpf6Cn1kxyzSTXs9F6NlozyTWTXNfuunZ/NJOcasXVEniSq/KcfpTgTAvfyVop0GC26zYtOQ7VQ7ZCwsSUY0WLzCHqt1v91mAvUdup3E53tw4G7WS3LXf2Wnut/nZ7L5qf669ndTwtssWamou3jyO7GCTuE3hcZZBcrrQ2XdxThHsLNSBYI+iZ8mb4HC69mXHH7WXu+MaWsI1+FIshY/We5VXvlORjaBZPfvO/N1DRsuv8TjpRSspheFq7ck0d19RxPf2sp5+/zfSzpo7r2l3X7l+zdr+JOm4/Rh23v4E6bguiWHzu6I+kjqlOmZoNEBTYEH6ahx1jmIKnsPsYyr6UxVCVU6K3wCLbByuO7VhLp7UmNVlyCzuRZuYugje0zaltUbdFAymGgEgjgFoa7Jayig5ogJMif0Smc811TAZBbjGJDwd05sfXTJ1v01G0SbIKGjIoZNafXqCDDKiiAdE/SOB90CGA+gfucYZo/U/7waJHFp+SxeLkc6IU1fx0/3dn1dGDLpQvCC4ufKy/cAbB75lLg2WE+jz28DWloGuqvqbq6+l+Pd3/Pab7NVVf1+66dv+atfsNVD2woS9TdTR4MlVH20ZTTLnUK0qu/ztj51IJGnB6C5swV09nHJx5BVKJFKIbEAQidAehE23On/iOPXd3m3c6vV/8MndIPKKrG8QavcJVkUHOqCzHrrO5eYc4In73DTnWDcAbQllOjL1tJDbf/LS1ApXoZKurzyKnVcKrisPzbliGNNj7haYE92jIA/hYsL2UyogJnz74qny6b0FBnsBK4cVsCBRDSDZ+TeeHsdL4yXHrBifXko2w7arI7h+z59etr9nhhXzBjlXu++pYaC+g5QPzSP2b2U2bC6LkfvSl+zazaYZ+DGgvDXZGzdripZIF3Zzg8zHPfnl7+VwMiYgyEFSOOLDStHJAKZ0jRRjoDuuzItSJ557CVsMRK364cBqHCksMMhgs3pkLpcR1NzjhDWaAHiCbXUqdFKME9bp5VkcmVZ9URpNjY+ZJSjydmk14aFMu9HvOEyGvGLTxNwHwtvHOxOJYEz5pmtCpTTCRF4DielzbJefs+l4l/lFLi720mKW55w+08K69TvyR8QTVTSJk5thb3z24lxfPyaPlFd6Q1Ic6kCeCHotnqJI6at+tx4K8mOQt6vHOvB1pzLKL3YQHNeEwSWap6IpkZK1T/xSCUofK4HpYoYq+W61bGjTmiojbzTmVYj9krGNwRtbvFIVhfDLJPs3ZTFms3z3hknzPkUXNv+dbEu8XbObX15haqWVqE/fdOtOAMQ0YewxwQX8/c1FiobbJBsYBnwBHs/gzEgRF5zDPy1qJ6ix+k/vQ1JBAVZbixh3/R2cGcOFJ8AdqPW0DCCbKPT1Vhr9FkEXT14Kz6s2Chx5c1jezmDUf+M3rO/3Jk2bSP5u9ZPHhbE/lzGSTH43SX0CSPw/u/kGIt0aavyPSBBJM6cbDhtXCfJJ7tra8w+f4AiL+i69cqcy2sZbxd6mIw8yLGWeypJzmmk5GWvHewFjJkpjfBuWVzbkO67tt4VLWkG9MFlBYYjWnM8hriLdYfJkELqaFF53JhdQPNqzALuDlcwqSOK4DBwKV55VBX6qxKqfbro9FN9UuqTwIYR1mVG2ZZRo37VVXJKUNuaLBS5Aid2cD2kTG+nQuiI+MhRi6sIMMR1JEwl3omSE9lXGWUbtF+v2YbGROPFLZmJZ+QFCQKTU3wuvu5ZJECDPhZwtbDDdDJ7dJbSGEljo+GbYaWPDRK1pEYZ06J7fL18kdHyS/4uug7sGF8nD//WGGzd24/oOuqIcphZpsjml3iyys/NrELxOvo1XLRHTt8OX1L64UsfYY0XITAu7uaIeElk339Pq3StHy+/pmtiri1SSCSM9YqA4AEeorvnoWbEyfixXX5VfaVO/rmclsSR/h8aOinQBN1+HRym/VsDb+Q/htIL6c8Bxed1x1O54Wi76T3wGaa770GwmtzKar8vMz2guL+uESfu43GEgwy92YPcJngQ+togPhgRrd3/8XYPXWdw== +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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` + +## Request + +

Path Parameters

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/lifecycle-states.tag.mdx b/docs/api/v3/lifecycle-states.tag.mdx new file mode 100644 index 000000000..64529156c --- /dev/null +++ b/docs/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 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/docs/api/v3/list-access-profiles.api.mdx b/docs/api/v3/list-access-profiles.api.mdx new file mode 100644 index 000000000..407ec4c44 --- /dev/null +++ b/docs/api/v3/list-access-profiles.api.mdx @@ -0,0 +1,121 @@ +--- +id: list-access-profiles +sidebar_label: List Access Profiles +hide_title: true +hide_table_of_contents: true +api: eJztPWtz2ki2f6WL/ZAZCmEQGIyrpu5lsJPxlmO8Bk92r+OaaaQW1oyQiB52vCn/9z3n9EMSAmM7qewklw+JQeo+ffq8z+kHn2rRUsQ89aPwxK0d1gI/SYeOI5LkPI48PxBJrVFL+TypHV7V5Atm3lw3aq5InNhfYn/oPb3xEzY8P2GxSLM4TBhnCJBFHlvp23wfvg+HLI3+FCG789Mb7NZg44s3vw2P3p6cNdjF+PS49Hly+bP6OhlfXozMyyjWD3QLxrP0Jor99J4BPrH4kPmxcGEw5vAgYKnCsglTW/KYL0QqYpzgp5qPs/iQifge3oXwBr56UWwl2Yy7C3jbqCXOjVjw2uGnWnq/xPdJGvvhvPawSowTjy3j6NZ3hdtgMGkcBMYWijiAENGGO04UuwAB8bu74SnifOsn/iwQ+Ah7+KHrOzyFLiVKrJv6iSvCFGbeZFPoeMuDTCD5EYqZK44ggObwiYemBzs5ImJi02QpHJ8Hqn+9vhD1egOw850b7JwAddMbHrrMUx2QsDgHDexVAuAUk7utFvuZA+7ACAEzFnEcxZIzihC+RLBeL9K6Xi9jTDh5vpCDFhFPFdXCCMjJdH9kr/jIF8sAuXTgtAct0esf9DnvCnfAB62ZO3D3O93uvt3xZtBYC0rt0ONBIh4a6+Uh8Bd+Wlvl9lmUComIJIlSBJzWgn/0F9lCERNfEwjEeL8FNJoIwa5+7VD7SQpU5bHLRlEQCAeBs3Mjo9c/3KTpMjnc23PFrQhQdZsJ94Nl5Idp04kWe74b7vGlv5coOJZj4Fi5rP9IWCyiGEULPi7IADSrNChQcL+1RvZhWDEXMXSUUOSjjg0PgAM469oh9FMUkEBc4fEsSPHLwyYaR56XiCqRx/QYcFZ64WWgzrFIAByDF012mWQgiPcFWSHbUieC11Gdlnzuh5x4FUfZ/EZpJIJIvhlefAYrDPU3E9+JsrBKezBn9TTORJ2B6N75QPhltMwCSUrQ3X9a0yjlgTXC3nUk6TIKE8FuBHdBgYkP2DDMFjP4DjZJUV1qzV2UBS6biZJR0HxDS1OXMlFndwJJNQ+BYi5ZmIkfOoLMPFgXNEIcGA2oMJoImKaQ3fBbAY+BR0QcbO8vltxJG0wqYiyAYwsRgrEmMwKSkggctU5AfqKZ16WhAmylKhMVsDWgnSUam29CgnA+a4RoFkWB4GGtICfSFm6SFeXXnuMXX1MXw/0sId+HTkdTK7kPU/6RyW4zFIXwK5P0b3JegJml8PwReftaPyV/lC2X4AZF7gQ9ABXd4WswPYGbkNzK+CqKk0OEUK/7br1+yOriA4heWJfPkJjmaXKnnjqxQJ9PL+YgqQH8mwv4K1SDReSSkdvcIroLgQLrhlTqwiHKUC/ViyTKYkes6TOKFsso8UHfzZRyGkBTmCzGD/WS28WZMfGBva9NgA3nyAY2kZ3e157ucxMc5FExK5g91GRuJQLZCahVJXAC0P7i8ocTXpW+iXz2NNkDhpBYNZgSowbLxaXCooalXz6dJxSriTkYzdTy3S/FG4qaBdjelLQHratYLNP7BuOu62MjcvA6nl5JK2TAHIHbkbEqB5vIkwS8hYz/kVITifMPYDeNU8rjhZMjmZsAHmpyZE2R6E4Wx/AdRs9CfgtcReVpqL73UoqgWR60ahED8QEfRGFvOShtzfadgWfvWwcdp2d1+z3bGrT6HUt0Drz+bGZzYfcatjhwD9oHLcvuzhyr69pta9CG5n3uee6s2+/MWs/gGvjKIHOFlYVqesTypzgCdBkVdr27EZRHgBSS25TBlPT8lN5AqoCO3YmAkECHwrCVlJBhiLEiVXUkPJ+RPMAYShQKJK+vmRAEDAkjKmxlgfKLq8S7xkdyGglSxW618E957qfrU1sAj7MFTLALXy4DzN2gy94fCfb7VKU2j2OOPALjukgKz6PZH2AaKqFYeUDMYmO0NKkvkfXddSq4mqkLEHWdGVYA5iJqOwOQvQPeh/TJbfVEqw2fBiCfjmu3+gObJI+74zC4NyIiRW0bCmfoGrYjcAx/o3shLJeDt+KJsHA86w7Se1ExH9UxQ0gRUE91yLNibfJ4CaQsytJt2BSsPqBO+WcgUOrI9CBme4QZwREKdaZRR3yVOd5OnyMdWpfRYXcg3BpIwbLCGMJK/cUK+1pgLlodq9We2vZhxz7cP2i2W93/W8c24wI+C7WAg1ZoUM1nYGhP7dYhIGlvxlCEyEp3u53aZKbW4Iy1EAmWDNCjLfBtyO6jjC2yBPNQMj0MEgJAAo1BKNhxLhMlS6OmQBFZ1ZaM8fFGbVg1B7lQK/tVNgCyeZWJIsQk8Kp2cnR8Nj2Z/qtawJNoYD+sH8HEKZiQs4UkRxWNAuGlDHFAk4wJOYj+Kw30FUNvGS4ziEUjbH7nJ5h7ra8CUQoljXTZNRocgWZPMWimGOS7a+wX7/Y8Dnmo6LbaPW/WBTN24NitXmdQe7K9+iWDxJGMD5KeuX6yDPg9CwtmTIbb7AQUAN4AwUqUiiCXTWU0ydn5eDLFh+fD6egXkjwgJGWjRGzQGEeGJirqKJfyaKBXSQmJzyK3CihrkOjVSH61MFwID/JtSJiRUDI3WOegPtcDTQiyDMjkfxS/rddGiOgix1cGcJXVg36/A4zu9NrgqjoQIbVmvVavLbwuzmCbashy6rrKtiC1KOPbkATlwR2/T5DfqnsRK/XoyWKGI62TrXzSavDSKOOjiTU8svRgBS6WqvmyJ/C0RtY0915rgpHHPefQVPZLTrCApQmuywwkWdf21NdxGkXOyFrMYmSsPhMy3CuINWhHKIRLvlZHlI8Z3yfGU4VeyqbLKpLKChyycTBTThNpVsR9k1BtHAU092g6lna2IHxk8U6P38JflMBCDFR48UR7WB7t5Kj5iKrYrXZXtDuibdutAX15TFwfl4vyuEVBLmMwOvupIDjN7qAlPFfsN8aXP43j+SjCDxMR3/qOOBLLtHE0+umXfwyP8G8QOTwoyXhhUJLtBxnRq/rGlw4XCqDZrc+VWOjHTTbSeSKk3PxPEqVwFUwYoSvJ4QDYKMTCtUnsKbN3wBdEC0x0tcbkdVRxZ4z7CNMecDxjrSmQLYOrAe1R60oyXlyDB4HjyrngAgxqIxY6Q6mS0v8XsyjyLNVESoU3khYKr1EUev4cyb/FlpQIiJoN3TK5Kpkvpxjlfdz3yDpuSjjIlG4t9zexWyGRB2PKziAh5YjSQaulPaaHY3/AU1MGMHBWSbROfUqFVnwQ+jwYvXwawGXIOgE/+Lwe1zsMY2GcL4CtHIkHE8xpxfP9CCXRqtKWF+LEUgobAa8iudGul0VBU2G6xekPz89/G787O76AZ/qvWlfVX98Oz4Zv6NOb8a/HF2fDM3j55mJ8eV6NFY5U3TAxa7dA/YxTDDiPo2xpFixVjYGWetWipqYnEaHJfkXFTFQdSxX5sEBVrxuksU471TGhSSHysoMs65qmpUyj4K5XDANgcwFiJjsXiVGBoUK3Vc9fsTUSlCIkQnnLQz7P4ZgIXhnNAstl11XKI4whe4McDmlJ5w0StyGBUWSZL1ib+t7sXi01a+E4ccHckZkr+acKm42sY5cXVBpcPU8TVWhwDVo8kvafNLMot4h9BZciot2e0x8ctAcW7w08qzvgtjUTzsxqg4/vt7no9Zze5oBwWFJfaFdoeKH9kx8AW2rkVG8jKVTPtPAXpuPTrHxzq5n/qnZnFfmdCdqZoJ0J+iomCFUvN0CqxP8UdV9V0E3L0bqKf3KU4B89QgPX+nkIMTxty5LFCH91wUlVI2h9qRQOX9W8/qw9O+Ada98TrtX13K7FXXtgHahsqy/aA+hhD5xZz2n1rLbLD6xuR3DrYCa61qzTtvc9u3vg2bx2/UB2BXeFRRiJjrDEHPu8Wkd8R8wr7I26AZ1dQMTmA1qIPO5mwFyjWnWRC2aVDKFUb2lIIoiPuEaXqHUxgdkDaR2fQ6ScpGoJzoyGCchNhI8wR8dNOHouG4sEaxhqaPsp37OIlQ+0iM6NH7iQdNEmvuLb4dnR6mvIjMA0ZikKhYtRdLH9aHw2HZ6cTeAx5UTwCDSDg8nHBbVi14U0Hdv7T5woTZujgMd/1h6uEcznIHj8j8vhaRH8G3+Gy0qr6KUiEMsboPcZ7bfZjuZ+20b0rh+2ed4CnM3+zKB5Np7+Zr4Uhv1liP/L2QMLKx5sYhJhMx6J7fk6NSjVSvRg2oas6zE2c0CbmpPtmWtWtL/IdFdFqxTTR7mYUK8b5Ot1meNTd4ljg+XEaTBNG9qDCdRpFBPwwjbWUpZfWAiV+5jWrzOLBfeDiko9GOY/15NMqJmqGuCyukjSDTS524v30pU1dkMUs+JinmwhEpAmp9Nn0ces9RhM1QZSOTcLCeI2zF63GRUCwCGm+UYC8pHL2KfFMF3KMzR3eBwI0XSgS9sZeINZz3P/F/mA2w8BAUjGaTnQaP5LV4OPhOeHEKDRkgHO1FFCruM5zRQpnsb2migpDwe2LCzvNH+n+TvN32n+TvO/S83fafrX0/QNRB+iAUDCUBejz02mlwH0UZkSMUGjkGrji0Z5rVRv2zC7EJpsaE6jkETHAt/eioByX2M+sNZjVqIahTXRQHAPKAhIlwiBsCuS9vC4Op7isB1aaHx8cejbJcmTSGDvSNA2K7ZypetK7ZJSa9Bm38n1hgoS1owQQnfdLs1R4OO6/jHtf7GAZOUzZ7ocPYtcOi3oh2DxfCrmPHcX54Z82RUpWIQRkGe7/r8Gf27NY+4jhnLLjgMd1Qoe0pqOeUiQ2imtMf5AiWa7tP9npCaD/Ii5g+XN9TXEMkKXof8B7b/qwvx8x/k6n9MXfNZrDeyu1+tybh902/392cDjnU5rsD+gzVYL4Bufr63Yl4d+I0AGIDSh5X7/3wKXoXmi1gpo8KeX4QnGEzffyLZmmgpf8H8f0waETD+Pzlm3zwIezjN6zucrRAity8k6xysBj2N/7j8aRx0dvx5enk7hyQX4xOMJfEJYlXBpGOqDoRFVsG+iO8JYTQA3YyYCd6uiw6wrqHWYEA+TYkNffkvuIYZZMLXCCz3U6Gt6FEEzL44WJVUivfmYsh/8pmg2wNSY/Wy4B9bVxcc66vAytU4VJevqqNiPYI/MVn8ZfyR6Px13XbmBTp7+A1WW1UvcuQuO3XdWHHROylULqw3JaZEpqByA+RP8tJPiagpNs6iFRloUivnBXUm5MnbTAtGIpHjuxIFZ0BEHJ4pj3G4AgQuY7YQpc0RrCWB4Qt3OWKzSjhjE5q1E5iiN6J3Ds+QJencegPmxaGrmxa1QypeY8q0rCicytEVSURN11oefNS204puVjp3u7nR3p7tP0d3VlxfqbIp6S6FPuxr6XIbqIgR0npXQJ1bpkL4t4d8ycpSMpDRMhUh/fzdVFzXIpR/KwL5cfCRdeQX5oeHHyiq9dv05LxBBoqPaSwCWCE8k4uMcYxkkEqk61dFeR/HMBwEN14SIYDVj2vSPAXCchbQXjCcN5kYiCV+l6nSxrKCQBaQTA64lT/3tIsldJLnzRjtv9N14o10kudPdne5+m7r7aCRpsCJtUXFSki0WPL6Xkqbe02EYBg3yw95G5czyQjFaQWDMxFi1cuRQm9ntWdvrO6Lr8q7b6ww82+nZfL/f7rdnXbtfK/r6q1yPjZKVdarAb8lHIjEEcbghPgtBuJI0itxy+S/DGyE8NGtoekzcDDRv4rYYHTvag2rsOI0i3Eh4ryOkpBRDhjmN0KZB2wW2jXVbOlMxB7sY4vU0fiQ36fkLAVDwjgR5WRQqL84C4Mb31tDDAwrqZh0lZGYUdSo1IUsQROpiMe5j0dfDmA8gUASLm7W+YHSqWPRZkTy7wBmf0vVYxx8dIVDRTeS+v66+e4JHX9BGTCSDNxR6ZbbD8QYCSAikzTJx5y4+38XnOx+/8/Hfh4/fxec73d3p7repu8+Iz1U0tDk+hwZPjs+hbbPFTCz1mg55fu0wnVRFYUDizSKHrr9w8xicDoHAQzwQgoNcQlw/kqI8hKAdNdN3w0NZjbWWcoPAId7aUbvGa50WAuQQZzOn+0WXHPvU9srt6TIzCiflTLI4gEb6ardPwGBg7EOTL/2mrw5ahNEd3e9221ljruTdBihqMICbyfuD8DY5OUiT2BL7KPnSTNIAkknqvG3NXCP3KHx9Y8R9lIFhJDAN3LikpJAeA5pLSEFeJepY/gPd7rgyR5jbZRw8bJuPuhVvwzwkkA3zWEe+R8eC9gywXJkeon+dC0XhPGBFNHL/g/mdXRlsjM1s9rPgMZ4GpyWPH/7+bvojm2OEShZCXheob09m5yAiZAGHuvyPncgp5dfLDksLLKhxzAtgwkzdFqoP65yBa7gAW04kxU6CzAf2evrFgrzUb8PdoO9Dix35sbzJKqE2aory5ourpZ4XL8zrpUj8TUOzlJoRNLzUsISFJO2VIzfsOKD2CIIHCVHrxYNLeFYBHuZd8AShruKAlFB4lJfFHM21F+NRgmchvDIe78N38ghWqRuTBkvfo3eiTlL9D2MoOqgGV/MMtOjFaNG5L4s0wrJbBZQsOaTlWxBMEn6noBihFCZ5WRrFMhGEeaErVfJ34izo/O90e+PvpTnT4yvwudjSjZxn3Ja5gjMOaOGAlrQBicJfujQULNBtnIO8EYIEYJTznyyBQrRg8ySstVadwO9RH3QNDqBKUJLlofxymBs49YnRC2xt2oAJxljcLBTiZfQKFvq1ErF0FWGVglV8gwjc6QrdJL6mioUu9q82X5xx4Ygw3vP2pa30Bkvy17G7/yWLt7M036OlUdExihsNq9KIopDLaK1a+qMLuAQe2T0/IU2lMBySnPx8bhHMMuApyjTptHPjCyoaLAVP5Y24MIVoQXoI4S4qP6SGBGhO1xDFgDAP1KnuJnsHWVnoAIkxI8NtFgD1j0ilZvmt0UeacQyvxslCPNwMSGQLvAFsG3ddP3GyRN8bFgo9M9oYzUwvrZEoNkgKuoZCxItk7Km7qApM3DIW8FBfBQuEpCsy5A28+UQuRCAPuUC7cvi9DTZIjnUjgiXmhGBBIZgShRHenkwrEAFYqK72juL5nuqU7GFbPBQCk5fC0GlCJoiPllGSQgJbgEtH5au33a7cwGqK6d/gz8Eoz4Mpw94Sq2NIiEymMDJVvKqtpoqQfNwAqfDVp09YO8G86QEfy6uXMYEEvqmbS9WFnRtptvvVmP/+r8aslYI/BdZYVn4MSB+ep+P3T2fyd/JjMY/QSf9IzgsJ9P/rh14eoaP5IZwXEnL3qy3f3q+2PCIO+qd5XigNu59e+e5/euUx32V+q+eF4rP73ZRH6Zv/SM3LjfX3/tsn20Kr0u/JvJCM3+hvkjxCmvU/2pKT5zpfd4F0A69wkv6bcg8JQi7jFnpVNjqVVsfeHGMKyTcU5NQHHOrh4T9/3XnB +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Query Parameters

+ +List of Access Profiles + +
Schema
  • Array [
    • owner objectrequired
    + +Owner of the Access Profile + +
    source objectrequired
    entitlements object[]nullable
    + +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. + +
  • Array [
  • ]
    • accessRequestConfig objectnullable
    + +Access request configuration for this object + +
    approvalSchemes object[]nullable
    + +List describing the steps in approving the request + +
  • Array [
  • ]
    • revocationRequestConfig objectnullable
    + +Revocation request configuration for this object. + +
    approvalSchemes object[]nullable
    + +List describing the steps in approving the revocation request + +
  • Array [
  • ]
    • provisioningCriteria objectnullable
    + +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[]nullable
    + +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. + +
  • Array [
    • children object[]nullable
    + +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. + +
  • Array [
  • ]
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/list-access-request-status.api.mdx b/docs/api/v3/list-access-request-status.api.mdx new file mode 100644 index 000000000..6676cb887 --- /dev/null +++ b/docs/api/v3/list-access-request-status.api.mdx @@ -0,0 +1,188 @@ +--- +id: list-access-request-status +sidebar_label: Access Request Status +hide_title: true +hide_table_of_contents: true +api: eJztfWtz4kbW8F/pIh+SoRAGjI3tL08RjCdkbeMX8Ex2Z1LeRmpAGSERXezxMzX//T3ndLfUEgJjj3PZfajKBCOk7nO/9enWl0qwEiGP3cAfOJWziudGcde2RRSNxO+JiOJxzOMkqtQqkbCT0I0fK2cfvlRuIxH2Aj8Wn+NuEi/gWsV1/DNOT1qhfNSK6NmzUHCn8uvXX2uVmM8jvFfOwNQUUQV+ckRkh+4KAQEwJgvB8jcxCQjr3gxYKOIk9CPGGYLLghmTEzM1MZMTi4hNeSQcFvgshgGjlbDdmQsX4K7wka14yJciFmFU/+h3/UcWB5+Ezx7ceME4fOWAWYAoM5v76dgwkhuy4MFXs9RZ13xwOHp71z2/Glwbj7sSMjeEqeMARvM8GMaVyMCFuYgNXFLgZwHMA9OFDL4CkMCEDGRig4u0ImTgNx9+ga8KTuFY8DzyzV6IJa+cfanEjyu8IYpD159XvtYq4jNfrjy81rJPmyeNk05n2poeC95uNOEv+6h9NDvtNNut00qRQReuB1AQWUMRJV4MtH6kr64j/BixRvAfFq69UHdJXrMHEQq25I6os+pSVJnrO67NY8AXbwMZC+F5wrjOrpI4AWI9MvHZ9pLIvReSyNVQzHnoABqWnq6K5NFUrpzNuBeJr7WnSDR9/CspFC94TKTIUeivpEvx6b+AOpmWpnSSUgT6IlxSB4Na8A3ELOYh6hAoz+sR0tCiKpgDx7w2fRZZeRS5cx8ei4O/GT3xd7BkSERJuoG+RVvd90H4iQ1isXyamLsTxA4SP15DYTBj1ThMcJIYuAA2chWsEg8mo7mqv1iTIOae1cOnq4jmKvAjwRbgXgAD4hve6CfLqcRIU4L07CFIPIdNhfIeSA+Y0HOXbqz4G8xmkYAvZKGAYwFgUoJVCQunQeAJ7hNKMw5zpgTIeLqVIgTGGkWu+OcybAKFwm6wueCl5wI9AUjyksfy0mELLixd310my8pZA/7mn+XfraOGgQZ8M5FoNhqbUJDUW8NhSJdBbgBs5M4sAcZKVBj8UGe3kdTATE6lBirOwGMrPnd9KQZhkMwXppTX2bkElejSQJ76QZwN9oo0ytNhExlmpIjRrooOgQuKc9eO3XvQO9S0gcPE7+yjtgHHnU7TPjl2ZmADOmAIxMx2Zkdtu/GxsskKaEkBg+bPpRGIQcLBtrPo0Y9BquRjU1QCn314d0iRyFjf1As8T9g4JrtJA45ff1jE8So6OzhwxL3wMGysR9z1VgGQqm4HywOIAA/4yj3Qk1l2Oo6VBS7fSQqhl1Fwvvnof/Qv9FW0S1GyWgUhWFoKIkhsYKjgAX8GrnpORBorQ9cgjM5whGq1lJjV6hmrit9rgGkNIi34F9eYB58efPrw6UY+yGSNRQ/V3U1YhOBtZbMhS0CcJbcigUQApFAC8nwbw2h/c64hwkWejeW13TgGXKjakArAPTW2DBxSzxor5RkwBuatIj8yVVEPl/DoV7wkvUGEjGg1GviRp/GlCq9TLw5uRix1EA+j2pjPgF+CJ/lq5aGbgycPfovw8S/rfOZhyFEicJjIuB5MfwPyYbAeIrljVwIlBWddSvJQ/pQsuW9hxsSnnmCOG608/kjk0D6awJ4KpGyKSz1HKZk53YQBqJpootCCgON4lTN0sCB+Eoh1YISPpg4StF6vPx7f3YyGF4PLPvwwGtJH/3oymFz2r+CzUsNR1zM3GDFPZkmPAoTF8dcghJTLFiCIjopEzkUMYkuUBHcxnFH+s53iqHaKoduJ3pM3ylBchU0yLHpYQF6nQNFaCeFcYLsoihrJPG6ThZtlossE/gdBR4pOHbWfBi8TmYLvxNu+j9LArb6G4iY+lo9zPhkyvLNucHpwTjz9J+bgGQ7pVQDWdXafIQ0xB+d5okhnxtvHMw5EFuDHjmfTtmg0T+xW4/jwFCfaTUP0VKZq5OcaS1tU+YqC7sZ0jZ46hwAcrmnjs9VmO8BgK3YBoiIA5xiKKNliDxxckeOALHyz3LQazVOr2bJajUnj9KzZOWu26s3T1r8IjzwIoNr3QGqa2sVr3APnQApC9pcb1QoIfRcA5FRkEEl7oUnT26Bp6PoKavkrxi5hGIRXYF/43JTB1BzmH1k3j880m15gc28HscCKkbw39UBLCSTDKhU4GvZj74a1O8zj/jyh63ye54DwrdtxmTGSAw9Dd+7628zmef+ie3s5QXvZ/3+3/fEmI9n1dSIVUGi/CB4IYoUAClUk0AkDp1hVjVoFhLgfmTeqFC56jNAnqKAdnlCzlzxhDs1mYbA0M2Zmy5Ie+8Gti3oNZAYtGI8hWcwV0qroYFaxdakoWVU52Js662YCec89GBSef0QDKJXE9VUSAPmLTLWDJMaI3bULSpyRsihQWm4vTaagqgPkT8sJBBqQb5BMaIdKEp1KiwJRJ7qOolzRxmdEI5JigAYhjE2pjB1AWmyD3QfcXIjoVGRBcRLEEL6+z/WBRi66BMNS9Q39UgZrw08Y0azHkjrO0eVEAt/9X0Akh2dUw1yJ+481JnwKwQSWJ50kTO3VCjQRADzADzeC0fEX+ILBBbkxjJ22hhH9X/q928ng+m2mEXe94dXNZX/SP4drve51r395SX9P+qOrwXVX/gCBwbvBeDC8hmfv3vVHg4tBrzuB73c3/etzPeDP/V7J7RfdgRzxeji5615e3g0m/SuKNeQ99Ft/NBqO1uvOg1x5g/Cj8rJfqDBDwlFlKXZnzJQHrFN9FnaCoXFN11ry40p9hRudAGkaBRDdKcLC9zoOvkauM5YHTk9nWPcApRNtBg6Q0jYPHUpr6gZkqu0HVMABIFdJTM9mvMg/nE4FwrKknBwrKmBvBdVs0Bdi1Io1bgULDfckN9dnmUHaHS1geCrEK0kEhoiVTP1yMgmEfOAupSIwNRibe8gkKfuXlJRysk6HUPwmbewakFKGSsACz6iK+CaCGyXtjA19gRXKJdIoX59UGUjZoDUyHVjrFLIaFRijQK5Fsigimpsk+YyBS5H6HdhUlUtVWYNvyFfOlJk6qg3NSEOI6ZhceDGWgwTqvuaJEZe/zMGD9DxA2pkLxzbV09acPjgENGOmPkjvDyJBeRKyOZ1BOjyiJUVpQHHu0wpLjiS6dBeQa+HecLdoPa2dApuDkJ7MJJcmfGn8ruN2ObJbNnQhS9AG+O0Q1O0aLcHd29Hw9gZ+ep2Af3D+DGCMLKCzJQtot3bPAs4LifEGSPLTX4Ep5sJj6hNCXHS8qoidcnlzermB3w8LrMjeu+IBtRg9p/QVJIBGqP+trHefO+Hr5niS5c8HwuD+YWcz94+ewf0nqiTfAGMX3KLPut4UGIWFHzMyk2UVNIkjNeaPj5uypG/MMSdwkeGihYwetCXTo5Ykjo0Tq3U4aZ6cHbXOjjr1w9OTf5VlMrLctS1mywKs7g16MgqXjFir/8vNYLQWvXVHvZ8GeO+uIZVpsjPXlLfeFGWVhgh5Iw+fXAcAhTBK47Dt8TSqkbZja9iw7l1yQYQizrZnxOcVNQLo0IvLkm3MPwl/W+C2PvOGME4OKLFXXNkN+9BeuPcYcs1wEUHFIjhUTtoy+dB6ccV9SKlwpVCHCxQhUMF0e5Xx5uZu+P66P4Jr4+HtCLyU/nrVve6+pb+w8pheztcN08tGWTK9tub61iTzXJXTozThu3cdTA6BPvMwSFayekLVPKouu1NVXeB+PiYtuJkU9tRyqJvHkiQ7VFH21ZF9dWRfHdmpOrLWRZDLBii3wsU/20uoYgr5ZL4QotoDMM2aC1/QEl29dEnimesJWYVlJeu1aZFYOZpCeDrQ16V1ViiUQRKKJdx2vqH6sq76jm6iCCGvQvOm4qCVXCJC0oP38AJ/jv5DtaswtWK/3kBS3xTEmDFJq2E1OlazOWk0zui/knjka4mJpACllLX6llypW3AVIFFFaplzRZtz06eK1P8xuaoSiCdT1SLC21JXlUk9YOsPAUYQ1DTw2fU0dEihftUMtwDAX5ziPgHNn5njFkB5SZK7eylD93iVTFoUqm/l/Iap/hrG7wjMH5DdFvm+hQPbEte/Sxa6zzr3Weefl3UqV/STG0H28Ph6rj/wnK6K2q5fpMU65pOO/WGhkos0j8x5/zzyFyH3P4FBD8mGiIdXAgRCimeB0fXYu8CLeWV7LLw91Mj12oBhkRnpg+w7L6CdXpc0k2QAqLveK7Rx5I3bLvhvs3D6kY082U6VIo/S4aiEmQWFJqvywL13Pc/lSwafZP4xSZCRPJJ7onzxemqQIm7eLruEGCrzVff6tnt5N+p3x+PB22sssdBiU0Yw2XdNCUthhEzLVQ4hEzt9XzEfwsSTR5/Aw6qAU2fgbog7dhJaWMS1UoyKIbIR30cSxu7tZHjVnQx63womT+IA5GYdToJExd+pAgGgBJZsYpSCSjkTSJVxT24+SHZn7jyRO67qbGIkg1tv1YUC7KXGwlSwAdY8KXU3EGQmLqLxA3xbBREWsh6xe9a3hA9i9YaBoXMDhzwkqEVdE/WuP+51L2mp9q+jZupC4A4QX+5JghQoeaGXR11fKj/ew6dYQNn0UA0Gnkk7+GEsYnLkb71gCviNxNIFyoRysbmfDXATeK4NLsHoqw3sBJGXcOR7ayPOo4OF8FYHek/KgYTgTiwxM60v4qX3hsg97l9egPi+G/Tf3533L/tvX53qej+ILIdhX30o7vH5SHgzSy6ToETC8AhylP3uxglhFzHP/SSy7jKgnexDRVnTAYGEVjWRqJ1yeqllG5fUbNQPkQGU51F6md2ouwP/uZygvXQHGEvfmVQkVnxnzGyt0inekBR8uMkgJFA0X75VFvjqDusyUhq+y+hgReYsbwrOuNTmVWobI+wSQ44R9KZhCuqPFfpSCcXQO2sbKHicsgLPRT5AW6vyoElcyB+zaAWEXzlBHWjmxr4qLfusDS1vy/IoCGZlTzmZyVxLiW60pqpSaY/6DnkkGVSj7VONQyjc08ZQmmG9T/a0dWxPZ1PHcSCLhL/sjn04bTYazYZ07CQ/kw35dZofj7rXkzu5YkLJ1LvhP/rp9/LKe34brYwCzA025ph1lhtSmiHcKRv4YHgW/B4tBaZEnrGvDHJrVUJOu2DQJtAWgTwlCuBvqnPnNitLofvm0PA9du/GhSK2x7Hcv2Pqe1pvHrdKF2D1LoZXhEwNuQ2mduPs8Kje6bT+ZQjQLpWg7vqC+au0pG8a949rUX8Kk5KW9a2FvJPdCzrm1LqItNjcwrA9sN/QkKA5arAXNaskAS4t9bm4NCLBlOUF3aIGQlnfth65oXBYbLZwS8Z8tX6YXSb7Q3thdgLAEKz2FsFqHb9+H8zz4BsFWERk8OH6T4scSdlX2ig5kELSpN2k+kvDNDi9rGzwCrt4dqs0qPXFkk06WMHTOznI0X+bcaaNIRgp4q+5HSKbLHRHLZGhhT46O+zUG6qcIM+OKNM3ZPYQHGw5zl16Tlc6Nel2VbUddaQsYksXbyScO6oRPpn4LggHkxpFO2g0qmvb4dsd0TqaHXY6QDnR4uLE5qJ9fNSY7q4xtBpasqmuZNLfgoVfdwKMYk0NUGIlVyiLvV9l05nOJhM2bBKLAuedG8jMUp2mkteMtb4ICabMiYRvY6TKs75vNh6es3s9IrMXwv6UZQQb9OvJJv7xrY7BZNP8hn1/qsyeREjSckCMLVq35XEdECVJpOSsD+86mlvv8kMzypjKcp90wlnn0Gkei1OLNw5PrPaxfWRNW6B/zVb7WDSPZg4E22XQpEj0cKIRbX7dAJ1P5yhoBkEaF6lkUamiwaN3z+SRalXY9wPt+4H2/UBb+4F2bAeSC1Ebe4JUSxCAmusISjH6kGlaqgZ5qTc4IildSTdoYKWuuEkDYSyzmeQmbM8FelyJGMK8mJcZgSLTs22hNyWO3ziIosDtcOrGIQ8f2SfxaJFEshV3w4gK1Y/yUBZf3FPdT695ZpVFHfxfg34qJUOe0lPmuSuBbyzzabEqYJ4j95cspemuVnKFBcgaxVgcq9Ryv9IpZipemHVOTlvwFx6dcTLtnDi8zQ8bR7xJInRfcL3P6hNaN6fKGqC6mMXNHHqAPDyF51zwJ23+CivNj0+nXCg28t6X5lTZCKXpN/x8dzO8HPQK8aBxfcdwz5iomGw3Zs3mrMXbVsc+bVvt6ezQ4q2pY3XaraOTxkwcTh2xe5RnTLQ5sf4RD9rAlAjvvpHUNk3LOHDkVdWMhtVa+IouXWZBPc3KJ3k0SSNMtdyIwsJd7WzELKa8AWzHAveZwZ8R5G6pxfUJJAwcVbPiPIgziVpbLtkkDTjPNpgLeZe6k3aZbmlQLvZUy9Y8BXo/A313yRefYUpk6y5NdrlOuA3W3yAg4x5mUOhkqd0x7XKkJgawzuBdKRXUqmNslDPPvth2csbw9hr3bY5GfVk7h7+vLwbU21I89kJd0Js9Zd9I91L+guPIhphLtV+S2l+ubrqDt+afdzDYhPrNe/3RJN1cid8vb8fql+H1db83GY7uxr2f+lfdSuEsj63dVNmfBujppTR4q1wOLvq9f/Yu+3fjSXeCN910x+P3w1FqKNKDREa39GHYEL0FAP6YdN/K/98BJv23w9E/6ev4HzDXWEeMN8PRJPuOA70bDNPFCs2Gbm8yeCdxADj+sWEnAPpm4J86CFMLL7KYJBmsonnCDQZiKu4xXR5Y/ZCDPCQ2hmvmCQtgQHRlehczaSrN4LwsET7qdJri1Dk8xDOhDqeH9vT4eHZ8ePqMmqQ5CT2R6yF8ZD+NTOUtGsb+Z7FcZcZEZshkvvYGZm9g9gZmb2Be38B8LdyyVjrLgnrh6D6NHWL6AqfSgzN0TrZSQxn7RPQsz1gZ2Yfpf0qYvlFGjPLdE3JEt/Z0vW7HIq+Td0u5XD5Ka2xmL0DaxUc5vtl88IKjzgLsFRTOOJneLHgkRqo+XJb1r52nJR9lvfE7On06mbIVjpEWmQWt/MuJlRKo9GVzK0+GjOz5UexUhRdsEtBDfCzfs/OxUjg5RU4sj8SAIWZJSN1j5uRkMuEmlWmlDceETl6oyvcJPe+grXVcsymNveVa0m5KOLxh8/gqFLpbZgJB1VyEf8bpd5SGakkFENLOI8DYJshzJNSL2hFT7ciOXHumnfHh09PKoqC8W6vN07P+HCx8dh4IWbxSN2zfYry2m6B07UIPVgpKLLmQx1+P/BKp2TTDExK0SSw2yBE3e2PIMHzDVuMo5uGGtdGS5UBcAVUaqzWQqRFeunsQu6zVqUDfAIQe4jlQtLbtYXzOymO24lhulnR4fnfzU3fc3+mIrWxjhHmQz6ZDtvCgInnfJj0wtsqUw5gNTequF8SeWD28uMWcQx/NtXUFcevsueHWOLHKOb8dljcyJ2dssNQORK3flByGlPOCkXSDJQpO4LPrQHsvbVxNVyDvUo5Rl8ox9n1U+y1haA7//IAti+2LedIUT2Qq2237fDvlRsWXa6RcKW3BU2ZmfW0hjavlHak/L77nA5dH5tjhr0/7BrdO4U0NWYQNtAgjnT8m0s1dSRp5GXZzTTxyED3ZaZR9M+O2fEv6huNtdXeJrFDMAVJ5tDVtvybEhboaEXPnIfc37Trfvte71IRtD1ezHkKEhqduHM/rcBJPdcPStMVNJvKI0gY2FWqLWG8o2yz3hclpX2VzNEaJ6cm5hQU4RZucg9ulJddkzHo3brFBZ3pyeOKIU8uZnk4tPrVnljhuH1tOe9bqtLnTbh1SPry+Pre2CFvwrK+9PqdPGlCvLpDrmun6MS2w4gEmtEiQ12YT4S8VGLYJ89DIeG40fG/p7618clViFSsqR2+XHb/dIyIxWq9lFmh79hIGk+nTwKH35aSLvc8/l3tD/CINWy9wdvALF6CbFiglbZqRq7Y2PKjOcUAqGiY/tzCelyCgRL3JfuROat16ChmkZMjtTzDWLnJ7K5uk9CPYCqOdScm0oiP49Lhx2mrPjtuct07azc7R9HTGDw8bp0endNiyPv3iyQbRt7gC7trGOaK4bSLw5ekLOPnuMeS+PWXfnvJ/uj2FjmLgSXkiVgjOPDA/FqGW/nAvlPJFcv8WhW/r0ZsOUujh9OwZRYv02Bvac7HX3b3u7nV3R90t/jhSLx1Rv1Lo01wPfW599SpAdJ5roU+oj1/SN8lipmRkDVcMVYj08/uJetEgnTBN5zm8YnwkXfka8N2UH/L6VLeraddv1OYAQKKjxED22p0R3BnEla9plHi4PttFACEuCKhfEiLSAupjkFDGFCY+Zc8cYl8nEJH/fay2nMnwliwgzuo7ltyDuY8k95Hk3hvtvdF/jTfaR5J73d3r7n+m7m6NJFOoSFtUnBQlyyXHA62ol0j+TscLMLghexlqqnLEqmK0goOxNMaq5COHyrTVnDZnHVu0Hd52jg9PZy37uMWPOs1Oc9pudSqmr3/JFgha4REh7h9I6HSVOAicfPkvoc1t9PrrOAuJ8SwGapTQsWPrtKQJPwjYFRZB9WvFczGkn9EIbVpAyymP6buC8QbO5mAX/cJhODAKbgBh9D5SVN4JrQnF4aPVpSPL1Ptn02MN1Czp7hK0BNgKSOdtcTfWb0yBESiCnYN1fsXo1Ngr9uJIno0Q40vEmPU/20KgoqeR+1FZfXeALxBCGzGWDN5Q6JXZDvdBACAhkDYrjTv38fk+Pt/7+L2P/+/w8fv4fK+7e939z9TdZ8TnKhraHJ/DDTvH50fYUMHSWOqCWib+7DCdVEVBQOKdblfOYnCKK0CUEKC5IBvC4wV8OZAFWEuxylJHP9cqMvCXICWhB7fqU/O+AKeAQ1/rfOXW9Zk1fvBAx+bdH25t4gDL5STyLGN8GbqcpE70DV0UYWnvaAJJbdWGUklP59s6vu7YewwSsHA0TA1b75U40WXczAy5xPeR6l5H6qzhCLjdht7Xp/BRL3XfgIccZAMeZeTb3gCzchlAWUAPwf8V2QUsh4HkK2to9tsID/Ahc4XnzJiOBBO11tpkQ7ytxX4UPKQjHHHt4oef30/eZNvq1dvuhUuNd5zdgIiQKevqOj4+RN5FdoNRx1hupQRVh808QJh99MdCsA/mppkRGGUiKT4kyA7gU8aZjeJeeOj+Cuc1uo5/ABQ64Lnn3pCrK/a91z/6Fjt30QKl/f4KRXlEy4eVxosbeL0UiO/0aJZSNhotelOAQpL2g2xPwjOIiCwcX5wB1Hrx5HI8yxjPov41C0ctwoCUUHDk17dszbUXw5Ebz8Lx8nB89N/Lo51zjzFptlgEbtBz2IDZiyCIxP8whqKDavBhnoAWvRgs2rZgkUZYrYYBkiWntFwLokKC7xIUQ22ikO2WFJQE2KPsSJX8N3EWdP7ftEH83zmc6fIHbI+EO53Ajl4MM05o4YSWtAGRgl81gwKw2GoIOMidBSQAvYz/ZAkUoIbNk2OVWnUa/oCeQddgA6iyyXx1Jr+cZQZO/cXoB7w7vQdMMAbV6YoffGdqrK/pIVqKWLocUKTgOrxeAH6xQDcJb1qOQl/5d8MXMe5mVRM8I+y1rfQGS/L3sbt/kcXbW5r/RkujwlwUN5pW5QOmkMtobb2GF1FnOvwffiVNpXia4/Ef8gjv/MbelcdjlGnSaXvhCsr+V4LHGPnV9JHewknP3InkQHM6VzBkdD751PXwQFb2Xsg3uoeYWmG/BIz6W6ByrDFQ+QaZxM414xhuAEt87IAGIJIlvhThKe46bmQn0ghBpuULjZncP5E+pTUSxQZJQbsGRLiMhjMsE7u4R6Oy41zAw0jViIGQ1GUtDwLKEBkJteES7suH30+NDZJj4dYCTO7AgkIwJYwZrgaTtRHx9PwI8IIkOgjnB+qh6ADvxX3IgLwUhsM6pHR4aRVEMWSixriFnQ9jnSoV9imkZXHKgUsfIksrD1jCMy31VovCzg2Zi4Hw5EoL2fvd4K7wka14COABm/D94l3/UbkEebg7vo1dWgYQF+zQT8+KTg97l7PUWdd8cDh6e9c9vxpcG4+rXW70XhoUJHRn1LSDyMAFyCsNXFLg0RFIOaOj3EmmpIPDzORghdU0pHciMyWZl36olOelkOksAjx/4kPlyxckCyZpX/EyEUOewuhGqIdO+d4Fkz8XrofqqNaB6NBsdTZWehQrQi93thpVoEg27uM7UeqsuhTVtBYiMzX9BihEuM6uEqynQPYpPtseKNi9LOuwaijm8n0plp6uupE6nwTWKtJtLNaMqvuqKlGhHYWvijfteqGXvph4/1XYTh//CGTX35SoNzFHOsM1kJfHgcQ8RDnP7176RroYPK2SN6+amD9NpSJd/2xa4e/yrYeKLOmx0trq4c5thjtPnibUdmT12zEsOjvwhVgOZqyKhVKAQx13twpWiadfuln9xZoEMWTrPdxvVM2KgWrlOI0J/GQ5lUhrYskjJyh+NE/Qc2FCWo9W7A1ms0jAF7n9Z+4HqjV0C+K09+nlKF/xz2XgBgrGJyYn2F8++ZDQxaAqULVtz1Mw4Aty6uw2kqqRCZlUDUUzXFHh+CrFWOTqSgqN/CsPGkhtP4izwZ5ATjLjm3VG01RGUKQyMTAbX4FBpe/Pehlf1vg/qMrhWN/UCzxP5kXsJvXou8ftejLLTsexssgA4ngEEo2EgpPSjAt9leru6Xk2enVoBkMFD3RQAq5IyZfrIAy4KBOd4QjVaunLNqrVM1YVv+N7fGsQF8C/uMYwNPbg04dPN8I1ixqLHqrbuSMBj17OnjHg9DdnTgQgFlkzltd2YwwQu6rOLK+l77yosVLW1KjqXX2C7AhSkey/ZtVtiLPwwAJpECnoko/JVS/jqbW+EBwlXYl428dAnW8oe6g/cKqvX/8/AoqhJw== +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Query Parameters

+ +List of requested item status. + +
Schema
  • Array [
    • cancelledRequestDetails object
    + +Provides additional details for a request that has been cancelled. + +
    owner object
    + +Owner's identity. + +
    approvalDetails object[]
    + +Approval details for each item. + +
  • Array [
    • originalOwner object
    + +Identity of orginal approval owner. + +
    currentOwner object
    + +Identity who reviewed the access item request. + +
    errorMessages object[]nullable
    + +If the request failed, includes any error messages that were generated. + +
  • Array [
  • ]
  • ]
    • manualWorkItemDetails object[]nullable
    + +Manual work items created for provisioning the item. + +
  • Array [
    • originalOwner objectnullable
    + +Identity of original work item owner, if the work item has been forwarded. + +
    currentOwner objectnullable
    + +Identity of current work item owner. + +
    forwardHistory object[]nullable
    + +The history of approval forward action. + +
  • Array [
  • ]
  • ]
    • requester object
    + +Access item requester's identity. + +
    requestedFor object[]
    + +**Possible values:** `>= 1`, `<= 10` + +
    + +Identities access was requested for. + +
  • Array [
  • ]
    • requesterComment object
    + +The requester's comment. + +
    author object
    + +Author of the comment + +
    sodViolationContext object
    + +An object referencing a completed SOD violation check + +
    violationCheckResult object
    + +The inner object representing the completed SOD Violation check + +
    message object
    + +If the request failed, this includes any error message that was generated. + +
    clientMetadata objectnullable
    + +Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. + +
    violationContexts object[]nullable
  • Array [
    • policy object
    + +SOD policy. + +
    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[]
  • Array [
  • ]
    • rightCriteria object
    criteriaList object[]
  • Array [
  • ]
  • ]
    • violatedPolicies object[]nullable
    + +A list of the SOD policies that were violated. + +
  • Array [
  • ]
    • 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[]nullable
    + +A list of Phases that the Access Request has gone through in order, to help determine the status of the request. + +
  • Array [
  • ]
    • clientMetadata objectnullable
    + +Arbitrary key-value pairs, if any were included in the corresponding access request + +
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/list-account-activities.api.mdx b/docs/api/v3/list-account-activities.api.mdx new file mode 100644 index 000000000..b5835a018 --- /dev/null +++ b/docs/api/v3/list-account-activities.api.mdx @@ -0,0 +1,99 @@ +--- +id: list-account-activities +sidebar_label: List Account Activities +hide_title: true +hide_table_of_contents: true +api: eJztXHlz47aS/yoo5Y+XqEyZ1GXLVVtbiiznKfG1kpxJnuPaQCQoMUORCkHaozfl777dDfDSYcseJy/OqnKYIq7uRqP7h0YTnyvhQkQ89sJg4FROKr4n465th0kAf2Lv3os9ISsHlZhPZeXktqLLWKHw7qDiCGlH3gJ7gT7GM0+yqYgl48wOfV/YWMBCl3HdmmetWTzjMZNAgHSX8EOwqXcvAvZ7IqIlW/CIz0UsIlkDGvJfQMnniodjUT0oC6AEfkYCXshYOIYbRvBa2jMx55WTz5V4ucAKMo68YFp5XKdZMM8RQezFS0UT0qLpXLIHLlnWN4O+a6w6F1XmBY5n85j4EMxOogi6YIkUUOEiiRPu+0smPtl+IoEt9uDFM1aNxJRHDpBhpCNWkT3s34sEzILLfSkOKuITny98pLpud6xj87jVPrZb9Y7dNi14snnb7Zi21bAawM9z8pgsv0wcOfdFwbwbMawO9VJhyIWwPdcD9jOxPHi+zyaCCeBGRMR5KqSIhfCCR7AIUO2VxEqq/4WSK2h5lfHAKb6b/HFy9L25F1dW5XPBP7EgmU+QbRdkIBMf1n4cwmOcREHtl2AkBLv9scG61wM2ioFemA3Wy03Ddbay776exfFCnhweOuJe+GicapJ7/iL0grhmh/NDzwkO+cI7lLofIzcxRm4hvsFFyuZhBHocwOOcTNzTcqm3zA1aAeOKqUBjorpRrxp1eDH3Am+ezCsn0G7OP6ln6sURLgcp0K/HbdIMXVeKdXFe0WsgGySISuEmoGdKqgwKauxGKrXIdVKpBc1OFQW/4FMvAK2C9lGYTGdaOWli3s10fMFkZOLfLnxajWuyH7isGkcJLsxYLfBFuEh8JUrBqj8Z4zDmvtHD1lUU6SIMpGAzwR1Qf5oHrLhhOaARfQgT30GboVYGWhM3mzdaxkonquxBoKimAUjMgRmDOfMCOzMwYKbAt8ZIClNmxeYBm3GwEJzBHJFwsL43X4DBOUBuPPRgMGNzETgwcBDGqClS4KhV6uS/iPMq0kTU3nM/EUoKWBvIBrukqXkXGoT8bFCiSRj6ggeVgp5Qy6264no+oY4X+IwzapLNPlhvmDLUjJRLJpdBDIZTNZugKgR/ski/UnyhW9R0foNze5a+RZWRyWIRRhr0KHMEXYUPWAymx3ck6a0CkWEkT7CHahWlU62esKr4HZQvOAA4CP+BIvrw14e/Afz1ZACm7YDJh6pqZUcCVppDDalyrBpio7SjjQ3noUOG8CUtK0WPiPRCRfZLZZC696FwQSqzXyrrKrZNTyRK6kk9KdgtXIrckALnA5heV6ER9PYXVyBkeFV9RurdbsoD00W6csD03B+wfC5LM6TLN0zGHb5SdliixOumiX/KwjyHfc3mHQj0aIfgVsAbQCu+WPgIyKDV4W8Sm35en0weRRyn3YvFXBbeh5PfQEa4U4lQptQ7lHrOJkVYcTzONqBY2YDcGi2nLlqA2kyr5TTq7jEAN261ji3UIqWMzw2IoBZr5sO+crh0YtZE/mEG+7i1XZTrRTAT+WxuXR8OVDBiD3gpUWRaR4Z5ZFjW2Do+abZOGkc1s3P8L6Qk1ZxdSfE5UJI1eg0px4bZNuqtcd08qddP6sc1y2z+C+0BGBk+SV0QCinERi8QU95gR7rKQ67RaZmG1RlbjZNmB0XWOG6RyPQwQAlYjDghdQVseeXSDnu1z+c1SlIvjLvo/PLO0U2LAMHZbWV00+v1RyN4c9YdnN8M+/A0uOxdXVyf98f447p/eTq4/K5ygMPfFTnJm4KFpje9VfrRNK9I/+4xpfx5jvKxwBAMFdjayCg5DLInZFtL86cBGEAlxq4BaQA+lEKs2D9fGyTsSEJFCprQyzlfsmkUPrDwHreVML0EuQzW88PE6SZxOMe1g29SZ9WNgYFJEoubBeoEFuX0469zzxX20vYFikn0ZjyYUi0dzqG3eds0ALTeK5FwzaV8CCOn0H9WlY2WgQ2bjsD7NxnRzI1iYzSJrrauRfKLlTJKmaIyL8N/bs8FjwIFA2HTLQqeLLQTgLaxgoVlbyY5l4cz4S8OJTS3Z/oPKoKh/FBtFs/9r9RrdGjaCBvpnBogAP4NzAMummyXn9I/SsCVAxDY4AlWFe4VnuFUmWhQjyz0IPWARYV1XbDU1rHVarni2DbRVuOT06m3JmbDau/uGv6ZwOYBfDp3kHLmeHLhg06m3qIQQiksTRD4NQqcjUR079kCl2IlrTp4AZ/rcThCEsQwwKEFKAMUyzI4sFqTjtuybd7iTdFpdTqCc1O0my7v1K2JU1k1wRt2AiVasqgM7IXAHqJTFhJ+ocPXYKZAFW28JgLsuAM7ctxdhUFlZR/y+JhbrVW9wSIKFu0Vaq9Qb6RQIorCSG7yeWXKupknohZsDmTxqZAHRGmwPNCRC4xHiICsosCYRI5LtqHhfGuc0X1bKRrmIACVDqNaL33qf7IF0XXCfuP3vOaDA6gNcMAoWYCgC+VjcIthAnRxj3YbKMIsGhOHKRvMZG4UzpntexhXbR3xJp90jgw+abhGkwvX6LiibpiCu1bLPmo49bYGL20TnDbQCL6hggjiAfwODPQiieo2f7RMRyGsIz3WAfQfUjxavyDis2624J90uHWlvfechPsa5sgc2jDAqLARjDNTsmHb8pbbI+gKlnFpjTaP7VazddywJvV2s2l2+LE1Ea7NJxNTNOwWfzv7BIO/eOQsHv9kEKCI4Ms0nWLMEUMrWEoklA+hdt4VARCMwnvubwL4a/BXY/SzweVg9M/+Kbwa9r/v98b6cXwzvKTH/k/XgyE9ZWi90ute9vrn+HINuBf627xnUFiaAar8mIo7tW0f4B1OP2HUbfgeWfQk9Al85IxuYy+nuUDYzeWP/eHgbND99hx3IbAhuRgovnGfkgpg+PP6eed1YfACN8HamljXpJySlN3rFU5ECXH2KH4bvxwYqMAvYdaXBCMyzznnH9MAlO5qU6Cg2W6bbrPl4IlS2zpyOHpLs3Xc1P5SkXD5FovyJdR1HT5nPwjwMg75xknoLJ8noKeiQulgmzrux+z3BPqew46IM3UEJNm9d8/xbwDzyMBHJVHAYRkH4MlRG+YCt8jCF9hdMmcYOa1R+A9n+y2shSaVDMacO7tGUB5L+2pilnTv3hMP+83OHpu+GTZNVWpvzfbW7E+2Zlm2025AqHuKfr837HcpNHlxdTo4+xkeTvs6WHk6GGnA0L/UDzeX51e9H+BB/xn2L65+xIJRf5xhozLDw2ylI2zIaMQTnZ1ghCIzZbecv7VE8HSVsb0FQPE0gPe8JuWxPthnPcw8e7ZOIR2j0NnK9ri0A/bJBhM1BLNEBpTOm58f/0c6lkaEldH81DBjWHQyAcPVDbi/hI3ZbZfsGwAt1/OFYbXqHdMyrY5Vt+p3ynEAFyK1W7uEjcsEXlL7fD17Kj6s84Ek0ABgPpPdpjOfgvyKXgcMtaj1wGREIdIpwySyxe4mcET1d5q19SOgdkO4xySqdtM0wQoeWQ3TNm3aYqiOdDx4ELjhy016trG5ovq7c5UnpmUjbch0IurbmnrLblhWM6V+ZeRX2fPUjj9JzKombhh8rM8pttojOgD53+vh1dmAjM3wShuf8WB83r+Av5vyMbPMMswayg5l9djEgCI3PY0oG5fVMVM7M8zbF6h/XDvIHmzfDOEpMXib0PbwSEPlz6i6iEA0gQfM5os4AQsJkCMG7CWVF8uzEmvr1q+ojOiuKQB0Ac0xkv/Ems7mjTuOhwxw/7qkqM8kfnSjiRdHCJQ+iqWhUmgW3Iuy4I9O7QlsP3HUob3yx5EKXzmU21Pif83eAwBKZBzOfxBLCwEh/dDpOhZUzErrq6V1mp5IzMN7caod9MtP+Zw0HyoKUXWilN6FMqk4qUHI/DCYigin15tiqpNOZ1vPpKztctZaN7WbN80T+rfs4jf4PCoXn4SdlM83n+cvTcPM9vJZL8WDzP5P/d7NWO3eKXTws3oe94cXg8uuih2k55qnlVJAJH+ds9BfIfWda+3bKez2acZCLG5uSvnoqZhvn8LaBhsWUu4KuboM4TNqrBfAiB4FYV+aD7IlsKmMVS90dvAnZ14gjGnEPaRQReJtaMgosEXSpTNP1WUK4qlerRyaNM2axb7lDtMGkGngT4dMEbdxa7GLc70JPGjP0iawWLMkng3DiiPBJ22zU2+67Sbn9eOmdYS7VN5omLhDpfQMHQXfkEhTHvo7EYjIs8GA2DAj/yZPxUH2RAANvntwmfrYQf647FXdjM30CCEWn8AFcfZt75o1jxgeSiT0nk9XhBAYN6M1oAOcq46vIm/qBU9599P+WffmfEx7hv+56Y+2bRe6QZo3HlKO6Sx8IIo1A7hRksIncF1jVd1rFRjigSxW9NQvjUh1MiS00KNvaFHsWp2sFJcSrZtPMfvaq4naAZsIymaIAWpOuKRAgcqiRQC+iI1zLcmqTp/9psa6mflS619SNsQEELJTMDtugmiA0AKeAQVh7NmiPBe5KNcspjYl58VJwcUBlO+w+bExJ590orQKM23RJKZ5/Y6WXJm6cUFoJFJM5QObZlNeN1lVAGOwtQHXL5k2R5RRB4YnSOtlFqtoIcncXShiTuOQymyeyB3W3bUP5scg1rKCe6EXHyX0K2tEs5FOk7ZI2rlTY10rm6504aucv/3a3a/d/drdce2uFg71EbcuJehjrUOfm4AnIN+InOca9IlShJ5WUsEmNZEHiOc1RPr+wxgW9kcRYH3xaeHpQ+o3wkfKla8R383mQ6c2p8HQ1PXnc4EEkhwVBy5YIuGcEN05xQokkqga66OdhQB9QUGDDRARP8NiyzBhHEQWJQEd8HHAxE4oZPCPWH9xoWAvWUAcNXAMleGwR5J7JLn3Rntv9LfxRnskuV+7+7X7Ptfuk0gyo4pWi8ZJad4FaZouV2laUCFPtsyWXHZ8V0Qr2BnLMFaljBwqk7o1sdwjWzQd3nTajY5bt9t13jqyjqxJs35UKfr623wdZ4usvKYK863mUeWXiQg/pEgCUC4Zh6FTDv8leIrgollD05PhZpA5iPQuw471zjp2HIchu8DgqEZIsoQhg1JCKgwMWhws04ElHe7q2y7AVHmhSlPAE2+D4SeBjL4LxsWLXEC/0dLoUm6q/tpYK1k2io7OSrIEGH2noz7u4ae7LmI+6IEQ7BSs8xuiUz1FX4Tk2RA5PkeOGab5ClzoGXJvbYrvUmIw2oiRmuAtgV612+EBKABsCJTNynDnHp/v8fnex+99/N/Dx+/x+X7t7tfu+1y7L8DnGg1tx+dQYWd8DnVrJsuw1Bndh/Jnw3RaKpoCUm8W2pSE4eQYnHAFqBISNKVrkxY8nsGPw5WPdVUGm0L9ip4k8qFe+qXwZ5gmmJ7HGl94tTQHJQgf6FPh+8YGo4PZAWqBgdlyEvXJN16zoQapkXAjD/VXGTsaQIlaXzCTf/j2ZP9pHtkyTMC8UTcHmJSldYleY243bCT+Ial2jXRnjUfg7SbyH5/jR18XsoUP1ckWPjaJ78mxoD4DKlfYQ/LvcLpgvinbEubrRmJuOFmpboJzfHtXrDNCVK4oXKuZexrcydXXCLrCanX2reARflxPhxtff/9h/A2bIhYlW6DuWtHXunF2DWpEtq6bBvqxEbmf/HKtbukoBdcWc30QCtN3JaXZpJfgBIZgtUns2EiQocBWu9/KwkvtttyMhB/Tn3qR0F/uYR3Noro96naR8sULfL2WiK/S3gzVm0G94Y0wJSqUaG/155g2LHDsgvuSpPXqwVV/RqE/3GHBG+x1lQaUhKajfABmp7P2ajpK/RnYX5mOX4IPKvO21Iwpu8bkjK4HGzB7FoZS/DdjqDq4VG6nCay0V5NF6b4GrQijbhZIMtSQhmcAbCT6Cvcr8Am6bUItIQC6wFHL9leaWbALv1KK/q8lnun1LXhXrOmE9guuGlqhGQc0cEBD2Qmp6dcZoEAsZg0CD+qDEFKAXj7/ZAk0oQW7qPraaPmp+0Nqg+7DBlKpF7k4UT9OciOonxgVYO2sDphpRN3ZkSB+T6P7Qg9WElYaL1iV4Dq9fgiOc0Vuit4sXoXO9K/GL3LczcMqV4G/fGsrvcWS/HXs7n/I4u0tzd/R0mgc7KVfWKx8YodKrhDdepBPUsY2/B9KaaUS4AbInF9aWexm4fMYdZrWtD3zBIUHFoJTuv8B6pW6hgghMS5+2ARSR1O62SsCgjls6Dyfrrr9oO85iHDvhQkV0Otvod6E5V9TnqYTx/CLrSTArwSAiGTOOKjHM7PreNJOlBHSV0sogtRtCFmrdEWi2qAo6NMBEc3llas/5ixM4jNjwRym18eBICk9W10EmDMyFD5pGdYrQ/Tn+gbNMfDOItz9gQUFMCUKI1wMxms9QmeB+iaoFkbTQ91IHmJd/LwKmFfK0KjBng9fLUIZw1a10C/dk7fhku8VffqcR87/sOu+tYtAbH+4wIAVUpyo/Yja+t1WNmz9YKMwA7aw9PNnjGjgPugRX6vbGnGDATJGNc6vDH2Cuf/4veAb5fBR4MZ/9bpzvcWv0Fd+X8Lkn3bb907M0d3lX8Db+7u8+0mxbLjL/JXCeV83dz8hlPRi8lfK4f/XldtPyDG7kvyVgtzfn/3+7s9+Qh3SS9JfqQ37S7DfwSXYT0x/fu/5KxVgf4X1k/LN7wvP5XuXx+Ap7g1olmwj4VbVTB3MFVqtpa5gL9lhyXd9gP+P/wcZ2zNM +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

List Account Activities

+ + + + + +This gets a collection of account activities that satisfy the given query parameters. + +## Request + +

Query Parameters

+ +List of account activities + +
Schema
  • Array [
    • requesterIdentitySummary objectnullable
    targetIdentitySummary objectnullable
    items object[]nullable
    + +Individual actions performed as part of this account activity + +
  • Array [
    • requesterComment objectnullable
    reviewerIdentitySummary objectnullable
    reviewerComment objectnullable
    accountRequestInfo objectnullable
    + +If an account activity item is associated with an access request, captures details of that request. + +
    clientMetadata objectnullable
    + +Arbitrary key-value pairs, if any were included in the corresponding access request item + +
  • ]
    • clientMetadata objectnullable
    + +Arbitrary key-value pairs, if any were included in the corresponding access request + +
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/list-accounts.api.mdx b/docs/api/v3/list-accounts.api.mdx new file mode 100644 index 000000000..1235d8232 --- /dev/null +++ b/docs/api/v3/list-accounts.api.mdx @@ -0,0 +1,96 @@ +--- +id: list-accounts +sidebar_label: Accounts List +hide_title: true +hide_table_of_contents: true +api: eJztXHtz2kgS/ypTuj92QwEGDH5QdXVFMPayaxsOcHJ7Tso7SANoI0ZEI9lhXf7u190zeiHsOI/LbfbYqo2FNNPTz990z2h0b/krEfDQ9WXfsdqW56qwY9t+JENlla2Qz5XVvraSW2/LliOUHbgr7AIdJgtXsUCEUSAV4wz7M3/GuOlQZeyN7LDQfycku3PDBRuMzm46Jxf9S8ajcOEHbrhmROJ95AbCgabM5p7HQiTcGfarwIYSdoQNgZV760qJoOvLUHwIO0AB2XMd2Y5HbAeCO9bbB+B0xQO+FKEIFHV0kd/3kQjWQFLCE5J36YbWplAX/AOT0XIqApQlECryQoWcaUGrb+RYCHb9ah8ZZOOQS4cHDuv6nidspMGGydBvf1yE4Uq19/YccSs8VHdVcddb+a4Mq7a/3APu9/jK3VOGTsVO6FRSEV6wmR+wpR8I5kq4XJLRUDux6qz2jHtKlC3xgS9XHojXaNVAefZCLLnVvrfC9QplhnHFXATQU5PRt/YbcGPpSncZLa029FvyD/qaqDhixkEL9Ovhobxdm/5spkRRnQO6DWyDBsOFYLMI7Ku1yuBBlV2pCEy+ZmolbHfmgheQq5TIOiVU/IrPXclDAf0DP5oviI4xzHdjji8wRqL+x5VP7l/QfX/GSmEQiRJzQ9AqKH7lryJPq1Kw0r8qEz/kXqWLvUuo0pUvlWALiCJwf7IDNtwSDgsOFP3Ic9hUmMgAy7mzxG6gP1bSPlFidwJVNZegMQcsBjZzpS0o7oUKXTkH9AiRFUaCAAhItuC3Am6DjUg52N5drrgdllEaQg2w2FJIBwaWfoieogSOWiIifyfJS8gTcXvLvUhoLWBrYDtSMTffhQehPFucaOr7nuDSyvgJ9XzUV2auR7C4hZYKAzCG9ZAZFfBVyBDwt+8w8Z69sRr2cf2odtSC/xv1Vm1Ww1/H+86Uz5rNRq3+xir44SmNmDhPpNDi6FixkphayxBwV3eboifJb2yRv2m1AGcVw+cLdI3T+C56nIpWKz8IgT20HqEZkPLv8DEgl+cocns9q/qBaiOFUsl1SqU2K4n34LmyzNRdKb4fa3b7c7TXY09C91b0Tf/tbZQfBbZ4jHYkbT8IBGJB3GKDq+q24YsO+piXKVQUeVnBox9zuwwMYmTzihJoH+Bw0yPLNMimm41hyD+5k6FWNl1srO89z8HAHGChMkMFlJkN+Q60LgOSODR3gpGM2cFkiXul11XdN+s9ZRZFeBcglibibuIXmW7aFyxMrOJZQqEBG7Ua/snb4TyfBzJ/+jtoAl3BxtQNJirowlcrz7UJ9vZ+V9jvvugYPAg4+pQbiiWNBwwOZpTQmRaads7LrrULYg4YoKVCV/PqOkVWx2sFpCtzIQU5GoukC47M+icoABpgEA+w6atZf6w39pstYoI7A+mtNVg/xMGwOeol3P0E+hzbYwgYcxcJdvEBuqyDc/vzKQNctyq1VqVxNKk327XDdv3w39kwRHKV0KVYK8gW+9wWB+DgAPqx/a35AsbAY4nKS65EF4DElyehbyFQPeU0ceDgvEiXlxpjeAj8TaNQoAPHZQtFEAKQq/jUE9jJ8+13dJEPLyRHTmbKKPidxV5M9QqBBzcXXPUkCQIZjq698t6csLsFRjOK1JP1fstpiFb94Aj06uw3ZkfHNZvXW0f1AoZOwECFGNBj6aosDuopwKCcY2GEnpnR2JP89OCvvxaky+LAoM2Vx9cEbs8fO8W5b6GLeLQ8R3CZ2tTwlXGcdtH1uOO4OA73hhm76hyvyEY8TkpTJ7UcEkg+nwdibvwmEfce8rxAhdok1hgmqyFOVuioPL2t5xvtyKj6zeYsboFxlXf+7RlorvyQDsY/8Eo5eF5ds8BfQrbEckSNtbNymCQjT7po5vzIHZb5HVuOJwEooQbFsI31nQyGDx4yUf3JMoqcR0TgETKE2jYDEwXBDG58raESGCoMtIFLH1XiVvePx0xnzOk6G6ca63Jx12o1Dg9bhBI5INwmcZ7pLfUsGUw7E/oT1nBBwhQWrJDTxSJe+ndVxqCTJpb2kkkP7YV55qvIag6jv9DVsdzMoQNy4KbzQ8FSmJB9oX24ghCAlHPpytRG8UOTZ2WNpLxVWFUJHOQj5GHrJPUFHguzG4C4kEnS+Wn62Zwcv5ATkaW1UXBn5pdinjN5/nyQQ2a0bjwdNQ8OarNmyzmo1Q8O6ocO58eNeq111EwTpP5J73LSn/yaFlcdhy/ZL0KCbdforZuTSz5V0E83mT+ZDBg92ZKISVx5urY63e7g6nJy0x2MRr3zzqQ/uITry9P+GTSCh73x+GY4Gpz2z3vpjVHvn1e98eSmM4RHrzrn+gnSwavh8LzfJUrwq9u5GHb6Z9nLGyA26Y3wTm806Z9mGp9fjc2TweVlrzsZjG7G3Z96Fx24RQo67130aJSzwave6LJz2e3dnI0GV0O4ldFhfJlhPbllmIdb5/3TXvfX7nnvZjzpTLDRsDMevx6MTm6GA5ABKY0G1Ht0RX/Gg8yj8eBq1MW7k86Z/vcGJOmdDUa/0s/xLzDW+Oochxr1hoPRJP2NhF71B+ex5LEZOt1J/5WWAfj4RYv2NhvFGSnjJBhS3wmalxz546CSIol2JozGu4VrL7R/B2ImYKIBrKT6TeTiJVkaOjiyW41jG136yLb5wQxSrPp+fd/KVERPs/FTBMhQwdQeUWhrYvgZ/L12Pc+FyIG/WHFu1gqjuPNJNqkd3MFMtz32fXz0zES1CABNu2Uftfab4vi4CQAgjo+EmB3Yhy3RaIlprf4UAGxJ0HYosEOBHQp8fRSYCR5GQa6Ie7Tq0A/0RiiudXFXxquQgBV4qVHiB6h/YrK58viy85K8aCP/esCFt5jJOH9+wP/KVnPbElwXpAZw6AWBH7AKG2U2aPTmGW28sKnv0AasK2+55zq4//CpS3SPoA0knwBRXd95hplPIUetzANOqaoglm3oyIDireug1mijRJOMDU/tqjntgSaqdfaSOyCvlq9rhEETB9x+B7S2rxLkGbrSWXXcBXK8ZD12y7DiUPDpQe240ZwdNDlvHDXrh63p8Yzv79eOW8fHOPpSKMXnOSeK1zbzQ59hXeXaWMaBRf4AhYD7g+6JARrcyiyHPm0DovEM/eNUptsmYhp+GW60l6FAetkdsuYh87icR3SfzzeUICtX422FgyY8CNy5u7Vwj2eZk95pJwZCg75Iq/DOQQdKA53M+zT1Lvw74tgIcAf5vBK48i6cKisZqiUQiEuVbejqX7rkY2brDHqY0bf0yJLWhWM2lGz9VgL70a2KahlmflwC5SFA0hRAxWFgQtpzhegVq7BybjRZMputL6qsk6wI6b1KBf3XuE/JHUdvVuj9c4QNKnX9KMTa0rVF3hapKjcXOmIIOc8aBYMDOH8GvtkhFGvkE7koTLzFsGjsAzxrzeW5m2SURirFXRkbpEjrQAD0KcjmhooZOKLNEQAeGbdLECsL3wR3F5oZQm9cM+eRekbcDT2AnwqJljy4FSb46PUPjUZkjdhMBpHMmw3U2bRKzBUHvt6+2cXuLnZ3sfvM2N18ODIbj+YppT71YupzJc2SMk6ehdQnEHpFLl53/kPvT2lDlhkoxKRIP7+emDfXoL34sMJtoq+YH+mpvMB8J7GH2aWO08d46k9tgQySHrUEM0Ai4bSJ75RjnSSSqvaLo536wdQFB5VbUkRaWF37EW0xBJGk7JWrMnN8oeQPoXk/ByJCKY2AOKp0KnpPfJdJ7jLJ3Wy0m43+MrPRLpPcxe4udr/P2H0yk0y4omgxeZKKlkserLWnmef0ShuDBumL0knIkak2sxUkxpIcy8pnDta0UZ/WZ4e2aDq86RzsH88a9kGDtw7rh/Vps3FoZef66zSOkyDLx1TG3tqOpGJI4m4hj4skOJcKfd/JL/9F+L7kDGGNdl3jvBl0Dip9m+SOjeMt+x++zy64XMcZksrlkDLVEWIatF1i2yBuCw04mwMuSnzB2wW+0JXcpQAq+FoBo7fIMXhRCqAbrCudGb5EbN5NN06WjOJK24uAQ0IC3HShJWHu4h7MDHM+oEAZ7BzQ+Stmp8ZEX5TJsxFKfI4Ss94HWwgM9CRzb21b3+0D8wFixFgb+JGFXl3tcAkOAAWBxqwk79zl57v8fDfH7+b4v8Ycv8vPd7G7i93vM3Y/IT832dDj+Tk0eHZ+Dm2rNZbkUqd0eu5bp+kUKoYDcm/m2/Q6r5Pm4JRXgCshQ3M6ZLviePrZ2uPpeW2d62suosCDp/GhpXswDhjlocpXbjV+YVH6d3Ry6XZ/C9ToF2XRTQCsnEifh8JzUnqQKqk0cNFrNcTRAFrB5hCilRyQepJ+/DLH2o8A1IhMGd9IMh5Et4HNFZQPPyhqXSWPKcgIsl0F3sPH5DHnvR6RQxN5RI5t6ntyLGjPgMsN8Sz9Okd8rn2MebYevXC6PZ07sDZrFAYbYLMGeyl4AEWA3q748efXkxeZ97P1QTjhYjkA8TEEFyH06sRL99iJJpT0cHUntzmC0cJmHr5Nbc7KZt6wZiPAYVIpdhIU+tjr+UfmeK7fIydj38gKO3EDfaJOURsjoj49fL2K5eIZuT6Xib/F1CqaWoWo4XG9HBdatde2ftnGhpBFEtxTpK3PHlzTq2ToYc0Ed5DqJg+oCcNHfkvLjq322Xzk6FWQXp6PN/I1vXOV78Y0UjG1oOPhfWYvfF+JfzCGroNhcD2PIIo+my160atCEVFp1DIsVfSQFbcCiSDxdw6BIbUz8SlOxJSH+JCiSUeH5G9kWYj53+jo7m85men2NcyX2NLx7U84B7rBMw5YwQErGgOU4V9PR+hYENsoA+GAdoBuan9CAsNoBvM0ra2oTuT3qA9ODTawqo+Nrdr6RzsFOHPF6AG2TtoABGMenWzy4bc5DK3MgSCtrHgFYFODRX49H6bCDb1pfpMVKJwe/2zyosSddKEEzxx+bZR+BEn+PLj7P0K8HdL8FZHGZLbobjSsKQGyTq6zteKynaIvmMC/8JQilVJoKFDSj5Zkyaw8HqJPU0zbC1dQwb8SPMTMr4x+5S8pDiHdxeCHso4IzenEdQAMcyjRXA/PwrPXUFFJSLsDrKbwFQmg+rtvyqr0zfyT2HAMDyFHEg8JARPRknFwj49Y13GVHWkQguJKilgyn9K4pFcckeg2qIoq1RXBUg1muDIMRWfGiB8ZC2wYn9EHRaJFzGGDVJARHmhCIIB2+fT7Y7TBcyoL4a2wngMEhWRKZEa46E8KFIGY1G9LV/1gvmc6qT1sC0Sw1NHOsF+FKg5vrXwVQvGZoRt/uorhJwk2veg+XQH/Nl+yMrMEpvd7K1yFooOGutzQ9dy1xTMf21qAPHjv/h4XJ7C4ecDb+kMbWOWl51S3HZfMyvd9fdRqq6LeCSz34292mYLeomP9z9fD/9fXqJ7QY/K1rs9U5O7TUt/fp6WecIf4ZPxnesPuA09/oQ88PeEm6afDPtNRdp9o+m9/oulJ+6Uf5Urt9zZdAoWk4i0eryeMpgxDd9O7IZlehfcFkEqyQn3Ww2yOP1Ibmwsc6uHhP1XhTf8= +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Query Parameters

+ +List of account objects + +
Schema
  • Array [
    • attributes objectrequired
    + +The account attributes that are aggregated + +
    identity object
    + +The identity this account is correlated to + +
    sourceOwner object
    + +The owner of the source this account belongs to + +
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/list-campaign-filters.api.mdx b/docs/api/v3/list-campaign-filters.api.mdx new file mode 100644 index 000000000..75c569a28 --- /dev/null +++ b/docs/api/v3/list-campaign-filters.api.mdx @@ -0,0 +1,93 @@ +--- +id: list-campaign-filters +sidebar_label: List Campaign Filters +hide_title: true +hide_table_of_contents: true +api: eJztXOtzGjkS/1dUsx92kwJs41fsL3cEkyxbtvEB3tyV43LEjABtBs3saMY25+J/v+6WNA/Aj82m7pI9qlIOzEitfvevNSMevCgWCU9lpLqBd+yFUqdtPou5nKh3MkxFor2al/KJ9o6vvLZIUjmWPo1nbhxzA69rXiC0n8gY7wO1U6CmGQ/DlbENNvBhZeZzxUaCJSLIfBGwW8mZTrkKeBKwX3fZ75lI5izmCZ/pxkf1UbXW0GIznvpTqSYsnYrKFGBdCz9LZDoH9h+8Sy2SdqRScZ+2snSKIslAHfuWYH1MBOuohONE8MC7XoBMREuQhEhEomS0CpBXcIfUNpOptyz+Gb9nKpuNRMKiMciosxDUkUbwMc0SBQINhGBXIGfrossGTu52FIbCJxVf5Etf/zRN01gfb20F4laEaLWG5jKMI6nShh/NtkCSLR7LLae/up/TqRcivGLjKGGzKBFMKvg4I1s2gPdE/J5JMIR3POahFjVP3INeQhCvub8NivSnYsa94wcvnccoM6wrJiKBmYaMubTbhAszqeQsm3nHMG/G781nohKIMQct0LfForZemyBBsqrNAV7d6o3HWqTAO6gRzT3OwCOMahncaLBLnYHDzZmOhQ++Ck51J9Mpe00meo3aj/lEKp4KmJ9E2WRKdKx1wC+/C5P8CYPkJnjcAFL5YRaIwVynYlakgao9umOWJpmoMTuaaRrOxjYqpSLF+lGmUgbyOxXXmLg3E+D2jEXwN7mTWjQYUFRRyuIkupUBGI6rObvlYSZIQTLFCZAu5syKgJekJi6e1hbxuaqwURSFgiuvpBMcucCgB2bjSGmhcXxzexv/W01uGNcue1jBWTT6DUyM+vIx1agUp/I4Dm3e3PpN4/yHVX7MTJgIGogx1ZrVJWhVl4bxJOHzFXMMQdfhepaQl2Ui+VpVKku5lZ2IFDxar/IUlGjpNIHsu+ogAfJCPlDlxyuZxhNH4yO+s3t0OHqz1xwH+/xgHz5svznc3tsOdrnvLZxbPrfecArOAP+WVvtRM5zfqKzaDcAwUBZYKwViowyywZLouG6F/pcvXxpX5aK95DqQnHwqseDiPOVsxDWEASSdIplZM8xRtatCNJDr6E4B+y/gVzAaaqwEnBsuGmxovogwQHl4lkaYknxKq3EUZyEkT4jOlPlQJCkppnImTJ4lc2dJApyxDMptVeABONMFpkc2yOI4oiyvIIPzkQtT4H8WBWI13JBdvLOFUiHLxkw1dgf5Q9hUgEo5b59eDrq9cwY5o/NP9wVnNUo3icqdhOLh0hdyTlqHxDURClERSJlbk3HNQPMlU8A44A94kNxyAUOqK5oVSvnuuVWeWoRUqTCLX3m5IHAtXxIBWMnF8yGgU0cDk9azqSTPbKWFH80f1bxg7q66nuO73Tu76A26ww5c6/dO8b/uSed82B3+q/TxpjUc9rtvL2kYXTrtnMH/8K3VbncGg5uLfu9dl6YPepf9dsfc6V2aMe/f9zvvW8POyU11cvf819Zp9+Sm3ekPu++6rbennRu7+Ap2HVo3I4e2inA1rQgUwT7lIn1yYYygFnM/h+EzKCsSDFIui3C7dX6y1etDSQwpgPRUxksJap0qINhN3rD8II8U8Q7DU6kJw96YkOpjRuj847J1OoAL573hTf6l3Tsftrrn+HEwbPWHg5sP3eHPZICT/DPwDX97fa+GYbuitJ5jBJMWd27s5wqsiJiv7MTKZ3sITJbywvUi97X5y5JbEUSfxZyNk2hGxnOGrYRVzlQgdRzy+TlWnDW5ieDIy5YvkEv6PDPtdQqCZkeu4WJRhjpXhpOSbhyTZbdA5eV0C89Y62SFkpeUYWX3dJ66S35Xdh8lJpDV+gT3cjCmpzCnLRM/k8XFRPhRErSnMgzOsInDJGJvIcJAwWu0HsAxbUYEXZOJ7DAf50K1MYPBS5a0owzvZfO4CmkrzXUpriqdr8M+SJJQ7FqsvWr4ouVzMW/6PWCo3FQtFmWj5DDvyoArb3/0hjdH/M3B7tFuEOwc7u0d7ft7e7sHQXB4MGruF2jdwYACynSxpOk1PfoajPZH5lpksbaMm6pdKUzVovNn3e6Hb9PhYKIuN0p2ILVWwUvwbW7Hzv1LrbaMGzHJFLOzGACGeJm5Cuzw1c319+/LXtd5kGNkQmjurWv62pCRQY+dJAGV11nfBjaTY7uLAJ00gKdRFMwRj0oF6pBB4+s1gwElpbaFyE9XoXdSifokARgCHApi2YeJtsHGDTPadDAkHdahcdWaCJpo7LC3PAB5jXxtKwyoKU24/xlodV/QEV4qCfOZm8JkkNfHNcuKQ8FHB9tHzb3xwR7nzTd7O4f7o6Mx393dPto/OsLVZ2B2PhHPt8fvEWsDEgkj6GPkvwVuR3DQPTFAi78c5BKNF6IAMzYX0/LLcAuyBgjpbfuC7R2ykKtJRtf5ZEkJqn45WIdEDOFeIidybXPqwN5J513r8hTRbx8AV2cwfAS6tRR4a4BuGVHtmkZ3xLEV4A46Ey1w80oEDfbaUn0NAnGlywOl+WY3g+zGCsywq6+ZUSZdICMXSr7Zr2U/yYZo1NgIr9GGb9Ed4/DXLd8XcVo/tZp8zaaCByJ51WCtIJAoJA8NJsMN4znuOvMgMB2W2UiEUDZNbJSluBEl/aVNg0KVVWsUAOK0bBQMDuD8eT9p+WkGzJGY5SjMvcWyaO0DPBvNVbkblpRGKp1DB+K7vh3SKORSyEwZbptpZtMRmktD4lFuXJ6xMAU6sSjdnRlmTtLIICKe6RfE3UUI6adOouU3boUNPtoMt9t9aA1nJpuR7BYvTc43Ba0uXOCbfYpN7G5idxO7L4zd5Zt9u9Vt7xL02VmFPpeKZ6DfhIrnCvRJyHtUxNwgsw1gDFnDvTgLkX75MITA/iwUjhf3MTZqXxEfmVK+wnwrt4e5PnKPC13pL2yBDJIejQRjyEQiOCa+C45JUUZVu6urvYuSkQQHVWsgIm6KsnmUMQ4qSzKlkBOuayyIhFY/pmzKIT9yiAitTQbEVVVQN4+VNkhygyQ31WhTjf4y1WiDJDexu4nd7zN2n0SSOVcULRYn6Ww248nceJq9j9JyBgOYe+mC5SGXP28poxUkxnKM5VWRgzdq7ox2xoe+2Av4XnCwezRu+gdNvn+4c7gz2mseeuVaf1XEcR5k1Zgq2dvY0TxbEskt4LhMgXPpNIqC6vYfqDcRY0xrmHpy3Aw6B5Ve59ixebTmOXcUsTN888UiJF3BkKrQEeY0GDvDsYkbi08X2QTyosLnyDIyr2Dg0/k6w0fNjF6DwuBFKYBuMq+3xriHbALFOVm+in06rikThBGi5ggcS4KQYoyYDygQgp1Adv6K6NSa6E8hedZHiU9RYtweFwIDPUfu++v2d7vAfII5YmAM/MhGr+l2uAIHgIbA5Kwcd27w+Qafb2r8psb/NWr8Bp9vYncTu99n7P4BfG7R0OP4HAa8GJ/D2MY2y7HUO3q3+r8N0ylULAfmdfHIpzdTgwKDE64AV0KGJoJyCMdzId7W0pkQc5QEIaHhJktCGOXe/38AI4FxFg0ey4a0r9So6I4OAdzurkk55lVhdBdIWkFmjhbgkQOzSINUm0j0XpPqaAGjaPuqupefNXiSPr5cghacRxkkNyJTw3dTrSfRZWAzhjYif1N6QScDlmQE2S6TcPGcPPboxCNyGCKPyLFOfU+uBeMZcLkkHrJ/XZz8GSDeNquvnP8pagj2aM2VxXo4rMneCp7Q69n42OKnXz4MX5Xe3c00AlwhsS2AOLkAF6Es1nJb+DiJCktx2qRVeUiCUcPGIQjM7JEg91rWOaT3PuRjUilOEpQCcNbLT5/wyrxHTpt8VHV2IhNzOEXTGCsidXfsKnZy8ZJcX8rED45a3VCrEzX9aokLo9or37x040PoIgkeatLWFy9u6NVL9LB3gitIdZkH1ITlo/poy3dW+2I+KvTqSK/Kx0f1YSqhhFanMZOxmIYKGAasy/xpFGnxN0ZHlzAMriYZRNEXs3WHi9YpIurN7RJLdbNkXdYBEBJ/pxAYyjgTH2FBJjwSAVRTgQnJT2RZiPlPdAboU0VmunwFdRNHBpH/B45ULfGMC9ZxwbrJAdryb8oSOhbENspAecA4QLuwP2UCy2gp5xlaa7M6kd+iOVga8DAjUdHxsflyXCQ4d1yJbuDofAykYMTT+cM+PCppaWFtqijL7QQsa3CV3zCCkrikN8NvvhOFZfJbkxclbhUbJj0Vzr92ln4kk3w7efd/lPE2meavmGkswkV3o2VtK1B2coPWVrfvNJ1Ugr9wlyKVoDQ0KsUprzKZOOQp+jTFtD+Vghr/WPAUkV/NnSEz59cw+KG9I0ITPEGGB54AjfKRDIFeg32Azkr5oGLsqvBVCaD6W2Tbq+Jl5hNnOABQs1mm8CQcMJHN8Gjac9YNpPYzk4SgyVLCSUbHUVk+y0Ukug2qokH9RTLTvTHuEEPzWTLiM2uBDd2pUFAkWsS++F0I0nfngWBcFX4/Rxs8pz4VYYx9HWRQAFOitMJZd7hCEYgpDXJB/xwlky07SW/hWDzpAsIbZ9htQDeHl+JIp9CElujSSbGV3wFYOTiZ74h/C78IYGsJNgFbMe5ZoWiZaUpM93flrXR/0E9MI3ot3nt4wC0NbIUWeNkcncaeEEyB3l6cP35UC9/XDwOsVdhngZsE7ncP3Ev/dHDr5Xr4PzzS/4Qy3c8efKEyv7nz+E+I+sgPDBSSXxf7BhBbeHzNbBRSoBkaZiuxNGvlYRtSybd33ncwBfJHAKX9gEstFv8BmwYe0Q== +sidebar_class_name: "get api-method" +info_path: docs/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 Campaign Filters' (list-campaign-filters)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

List Campaign Filters

+ + + + + +Lists all Campaign Filters. Scope can be reduced via standard V3 query params. + +All Campaign Filters matching the query params + +## Request + +

Query Parameters

+ +List of campaign filter objects + +
Schema
    items object[]
    + +The list of campaign filters + +
  • Array [
    • criteriaList object[]
    + +List of criteria. + +
  • Array [
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/list-campaign-templates.api.mdx b/docs/api/v3/list-campaign-templates.api.mdx new file mode 100644 index 000000000..c24be2a01 --- /dev/null +++ b/docs/api/v3/list-campaign-templates.api.mdx @@ -0,0 +1,133 @@ +--- +id: list-campaign-templates +sidebar_label: List Campaign Templates +hide_title: true +hide_table_of_contents: true +api: eJztPWtz20aSf2WK+8G2iqTA92Pr6sJItJd7kqilpPgSyWUPgSGJmAQYPCTrXPrv190zgzdFSkqydpZVm7UIYHp6+t09PcDXkrsWHg9s1xlZpX5pafvBEV+tuT13LsVqveSB8EvlUsDnfql/XToSXmDPbJNGMP2kX/pQLlnCNz17jTcA0AkA8hlfLlkOXJVdmDArM7nDpoJ5wgpNYbFbmzM/4I7FPYv91GC/hcK7Z2vu8ZVfvXFunEERMLbigbmwnTkLFiI1BrD2hRl6dnAPmH8tXfnCO3KdQHwJBmGwwNXYltM3FcRKoEBWkAZ9T3Cr9OEB1kXQRCA8n8DYuDqaByZw4A5RbWUHpSwJTvkX5oSrqfCYO4Nl+uESSBK48GcQeg6s6UIIdg1LHZyP2IVe+pG7XAqT6HseTf3h9SII1n7/8NASt2KJTKv63F6uXdsJqqa7OoS1HPK1fahJWDEjOJV4CW/YzPXYyvUEsx34c0WMrALunvgttIEXpf6ML31RLokvQJklLK/eMoCU5kKseKn/tRTcr3HNMK+YCw9GSjDyUqMOF1a2Y6/CVakP41b8i/yboFhixoEK9OvhoVxMTXc280WenGO6DGgDBZHXsxDkQVKVwY0qu/JDkLd75q+FCTIKInVnBwt2QNw5QMKv+dx2gMUw3nPD+YLgKMZ8N+x4ATMi8m8mvumGTp72oxk7CLxQHDA7AKoC4dfuOlxKUgp28L+VSzfgy8oRjj5Akq5dxxdsAVoE4k98wAcL1GHBAaIbLi1pC1AzgHP2LOIb0I8dSJk4YHcCSTV3gGIWGYUL2zFxHCzDD9AMcGA0oMJoIWRjFvxWwGXgEREHn7dB582gjKuxfRgNHFsJx4KJHTdASfEFznpAQP6LVn6AOBG2t3wZCkkFfBrQDn2NzXchQbieAiGauu5ScKeUkBMauVFWfNcjs1gAyw88YEZSHpHEvOILRD0ArB6yMnYB0CKxCH1t0iOX4N87AVhUOWiKMuL8ybT+Gy4Y8KooLN8Qy+U1lCM/XK+RJBbxhGwUgHHv8DbYo6Xl90GmkHhlZoKDgSfLwDqLjNXBQSnBIkniTYSf2cvfkfBvCdo3Tnq55Czx3+qru5GfbIkMeFzP7yMEyY+DA+CM+K3M5sCaORoGp8yW8PcS/nbgX//uQD5tW7s8m2MlE7+xG3CGDgczzXSocVMqYYShzaWPfKwbBv6Tj6bQaupgJYLA3OmvQCwUBRNjG7DdMJiv10sVox3+6iOEr3lJ4Z7HUaZsgOUnrkuIORegIy+mQy94Yu0hMQNbYm5bRXKYcSQWLgN5k1tKimZ1s2d0etN6x+D1dpu3jRr+1elMp722YRhdlGKpDNtmvFyAaOg5XvkMR1XZPzj85YLt5iQ9ILNz4QhSkAgz/xU97FdTmJ0qHubpkVWsp2KWuLszgokxGTw1WpEycMeB+IhpGdRAqoi3skbbcT7CB1HFLRK+WQEZUJ65NXaW99rTRKYIB1UCe5XhtVE3KkajYrQu6/V+s9k3jGqj3fwFEdPWcTtmp/Sk+Qdj16r3jV611+4RdqhTVrhMoRd70exEGU1wLMQWMhiKK0AU8sq9ACGYCuGwaKIUj5Vfz3jrcsm9A0mZiNl2pb4EuaCnpVYm5LFMtjJI3o/ELiGKM89dpQdSHscjjKuMxJzsLxppHgYuxigmheo6irQYxFWmli3kQRwzQgrngV3DIMurvtDo0FqyhqbWNbrtdqdtNYQBhqbd6bRrNWtqiXrdmCGbJfT8LMLBuPq6NDoenl2OLn/OZ8GXMGLz3NG4nY3ZGbqSjfBOwUsAq5SFQqhg8e3ldrBDfGwz3JVXVVbjB3URPXfp4YEsHreWtiOOQ1lF2MXsCclh4KLtWswKycLdLWxzkfYM/kLnBTAdzErxklRXEhn052x0Ma50gW1MY1Bl7xegMmmh1BILQyL45dRsZIDlWmRsPxUp8SOTsl6GvoRsRbO9BfuqyFJGXVZToSC7Jo220HxLO1KD/ynNirTiDhZyUzqvv78psdfBnQtJjvjsvyknslMkUCGimkAaeq0FIAqxrjXhx73/Ju0lYFay/wp2kcUI7IAe1bYULoHujmdUDdn08AUkbywxIk5GrqWop6VC6diH3bR7i2HNhRg7RRa9mTmFyKKTVMa84EayKcOIkbKacv1o3yBkpUiNJywpFSTA9SrRpSwVIzTh/x0STSlmnw5zhSj/8KttPRxq0f3EICeluJlZrhlCvhpIKUMHb4kAVJhCgJyV2hi6PCNiSVAgFa58i4SIFz68hfTJBX1xhLCoBEe1hltb3IFyTu9xYtvToVEpYdYezaySAcNmQoG+KvNFkYkCXGXSMZKCrkKf6gi2oypbQUj5PHM9LJ8AvhwSoltdbolCN4Z0v3dDFnj3qadiIyf9KI9NBuqGC5YAYOv51tyH1AXhkOHzhClsKpk0DYMJz3O9qKJTLYyNaq3LmgFhW9+oVZut9i+POc0CZ6CcZLysI23WxJdAlmVSlKkmfO/p4GzwbjiBKxfjq8nR8OP4/Zn8ORxMjv4Bf0zGJ8OPR+PT8/HF6HI0PkMrk9AJNV47yzM3rm8PHT7dFNxlHCg96TMCgVWhOBSV4XcivMvVV7IRHaCCUdJE3LqfxQAz2J1woCdlgIWyDWOfN3dUDSP8/acTYTQY5WeusoFpijVW/MBmM3ELLtqWZhqfB7NvhWA4ZhACkuyDKZnNyK7gbXTlsjAIV3GQs2s0ShJtq1ib0RoxJEX1B0OUKOUR0EwJUk0NyIKLl3SI0inXm+elciNxcdGYMIClCv2nGVq0H8qby+HVAheo1eF8eHY8OnuH8n8Jcn0MfxwNzo6GJ/Li4Ohy9NPgMvFjiE+AcpwM1VX1g4YOJ5Mx6hJqEjx6nFYdNR7DBxfwozj+4ikLzIzKuu0qwxWypF4nuK52j66cGAzImJO6wMzUdlVkE12EazvmMgSs0iNsCwhtY/zBXgM09fMexSBMPTfD4vFCZuncpEKxj3EeoAUquHA9G70SmFHfDT1TvEkaraPxZDI8GUgiX50lfqYInLj+eI6+U0pbkMjDOigSfzRe0vlvA/PfWqtfa1QhP5I2HivtqS3BJOsf2ZQocAJUtI/3B1Kc86WmJc1JkQ5onGuGQUKpcobfB8EEahrwC5FEO78ECH5BUS5j2tlSFQDJG8s65h33HGC/2kKRmxyQb6xkQl0098ZKXzroXmKl9rF8V5uF94PJGfwzOns7zqe+xwLcoPBJsAiilrKV8H0Is9IBGkEEgixdky/t/8uxamuxMrMEBLNj+CGfjey6Qo/hPnEZYqAfj85Zs8OW3JmHdJ3P00GQcCpXF1ibD5dLdBGRsZeAx549twtja03O4+HbwdXJJYYqw39dDS/gL4SVoyiaI+nIXJLDhXsnqSsXgGmkL7B0jpbwQEE9gAVxx08+aMtf/r0PxGTKZcEINXvBiCRo7WSjTTdmyk119tquimoZjDJco115NuW+TH5pk1AGAJUTRckDtTv4Bsy2Zdm4SO2RcVf/Hq07t3LBHwW0bhhQlGVmAtKYlGluxInpSZIpaMIA8+1yMjADrJ3SMpUYy7hYS4tCUQcalqJcpiSbIBqRFLdVTF0LI+cCIdAU1mYHPlP1fNrZgLjS0c/ZDtDIBgXH8ote1hCxOZXIHAeurM1kM/cBWhu8hftKjyvQY3XXZ3ibUwXuqe6mbvRr9Wq7I4vBRWHGPqx4YVghN9a2l4qPcR9uBRmkr0p1ZIqjUplatpV3ghRtKysT00pOS+v35bqDVJ14KWagCmB1Pz+v5ouTjo6R93fgHimC13lmPPVUYAmCdu9TQmjMpqLbbpgG/Nc0u13eaM2szqzWEfCnNWs9Ib9NFIAVpRP8GpyeD0bvzj6+HZ1cUtI6uToZZpiVeeZZpeJ45sT2EBghuX0qjYUfQnofHFHqF/iTqF63Ne1LCIZNwREBQJmVIGWJw1yA2cfyqydtIAJPZUyZ8EgnTCTlYyxJays2cmbudnE9VSUVREDqZXbbETkDMpC0A3lRk/OPrO0xGoUSKkqTo3ShKa0aIhUeZuMZxcyHBCWut4vjB8lBwT1z8UeRicopeQI9vcwj0Yxn8MTaEz7IjNLC7KYKJqpHw4uLbPJJ155awTxWLQyqip/BpcpGjio4YTjoQ6CV7ixEUyF3xtau79vT5X2mrSlh53XAdMhvuU2xSNrIXMi5oy3KJKJUhqHy5A6WeTSLW97Kcl2Rf4FVzF0wfg61Pc09N1yndjf0LLRe7NbcltKQNeeyKMWOL8fEVqnWmmNEn3fjn4aTMyw9fHw3GV+dv0RyNJKv/GjGpKRkp8KUJLEjV7zftqsPScw9Os5UP+XWYavdNVv1nolbh13T5O1ZzzBrjVrjKT0KqYlobyE11Xtgmc1XDP7Fdg5Sd9kTtBNsn/ptdYaT5mWiUIzsR2FJSnFUDpNVcqUHyOHEQ6kMFIJQFRsUjsXwi+zAJ/r5CUX0k5ZXMLSfomo4NnU+qjESl4zeJEDtkFdbNsXc2nAn1+Rqw12gBHoJKbxxIWpNmSVstvIr/mUkb9YMw3iq1S+XJL2PQFUDj9vODrWEt6EHvPBU27VKBUk+so05wDXxBSlA/VWJAJYywE3seyOlwXKpOZKEgognMS2ixoYUZNuuO+nyyfAU/o18xMfzyRgCpaEq+2/ekB8QNukaRAIeyVFBflHkLnU/mfSSJ8MjCKwT+3CbKheFnh43J7lV5x2Dm6JjtWhz0pzV6ybvGUbNIJ7rCR8jzuDkhPZAJDp5Olxh0A0ibungDcJkQXKxWR7i7Xjdsk9OUtcFgGBMOpGM1mokHh7S+8CEe2I5H+KMdZAR67yqFAJD6ngQpUIUC/6ZSgpPC4fGa1WGgOR7Zs9DvY8vG6xovQifSoBqgjh3zLu4vQ/f+/BHfTgK0y6OKpJL7ahw4FYfBfbJVY5KTfSJ+Bp5KVlkA2P2dzRkjrDJAqAcwLUyyZKciHtxGrNz2rKTMfPESlg26v+ODWu4Z54sReBmpwRBrWPc/xwXJTjE6HOHLF2VTXKP4arUrgrpjuAQXaitUwuU0Sfdd1Q0k83eSIvICSzFnC9ZvJIoaXqlpfVV3E5nLlxfJCpAOlTgbIKWZWCtaN+fjb25/LG71m3vRzshTCcxppfSBr9Mv2SdRZoiDTmnZo+LwpPUzEmUNtIzbtxtKcXE3eSHbIsEcsewOtJIlULKWBRPjpDvzDR0utgRKWLN/WO1Mxcx/4vW9MJceaPje3nWLJexLWEmFiZcOztORv4ZpqbtyoeolOS/BzKOvfWCO0OHwg0qVz1hC04XdzL2QIa9WLSHgIXd3NyUXJqFicQ0eJm9Tl6JtjO4LFxjmw0F3LJZy2KDALgzDQPxhurQYrUGo0G42FEHcQoPVTwumL3KzsJENwSNA9FRghY6nx33zikamFvr69Qv3MvQdnQqZngWSRZzVTMH3reRiSuq8rx5wd7k09p9JauebIm22VdZMixOLtLqJx98Vs22APcLuiQ7ugq4JHd28JCJhXJ/r2q5qpS7UmdDtul8wrXKhCCq6CZLt6rXTvpIX/fwpvdFZDQEUvezG9K+ihocQ9QBawSorNxvhfxq4jI86LjxhSr78V7vKZTTGGLWWYxlMt6E/Ojj8fBodDEan13QzutP4/8Zfhyfnfycun42TvxMBaKpO0D4vDSgClAksnCXVrLeqbZ64uN6oM+fpVsrJ8sZTARmNWfZCttndXNI4sREoqv3Q34vMD61kgrapIaVQDOmwuz1rGav0eyZ3V6rNrW6zVmry41WrW6UoqNouqd0QsxOYEJbefWK0a0Y9ctar19r95v1artR/yWJZB/3afO2VooONTyo1s1XuoKQa9eUuwjZLvTSea2J22DJsxCqG76kDor9ACYwwEtVHYz5rutQa3uUvSeq0ESYjjDrrTo3p1az3my1mt0p/LbAfDSaXXPaacWEuQDA59SkeiGnyxwYUR1iyc7riHSSKFki5Xbq8vtHknlg4DgX7V63VRfdmehOsWDU7IoWWLxWx4xxpE0gzUG9GbR5K0idG920JSOxLNqFkHcezczlI7ofRv4qbC+StzY29ygkHvf18iE7ouwmWU6Lpbycl8ikAEaoSw7F3am680/e3txqKmlc0P+p5GVTd6a6/ajxz9qsstL2aUe0m62eEFar3uxwszvtdXlrJqxubSbqnVksMBOxVsddZYVms9p3KvUuqX2v3zSqRqP1UrVXp/69CAPZv7LX/pdpv8oQ/kDljxBWW3b5cC2qLFNkE3OYT+0l3SjF22GjiCBxcU3+Volb6QcpMK9xlX32+qYkAQrvpvTmTSmzQaDMTr6Kfr21lvgtWKzMjsjOJmsXbcqYsqif/pu2ZL1ZszY12z3R4c16rzbtWcJoN4xGr20ZDcOKhT/aREKKq6oLJpgbI5gG2LF+o13ttjrbTdkj0PPGSgL4C5oqJdn/hmji68a64u9Mp+1mKSrxXpemtZbVNnozs2V2m43mtNsGJ9tq1Ru11szi3RnG6cqKFQgVXnr4dxucRwX7iRqQMTC5czq7mxolot+qrRkcM5W6b8mSnmRjkuESQGcwi+TpxpDodB8R7RIRSVaRSXp5XJRqIbvW+03NjtGxxJRT+QmybMCkCZag3ZOVyu83hSoQ9RcnUZmDfX9S/JFvNk731z7JZsgGvWbRq12OljZ2eVMDN6sA2eLjZ8km+6lrUbdw1P399Be+bCipyhOzR661Q4HyLXCnMscYGTCUHfAmDMTje7c2la3pTVQSZKpTPl3KB0pUa+xHbrGJWt+RWgyWXz1ufgZYox1qvVeODeOZHsLs+IBewbSiI/gUPHC9OWs3Oa93m7VOC+w4bzSMXqvXozYD2US/fUfgHR47tE2mjqwAQcBc+erEJ02+e6/L/rzK/rzKf/h5FXT9ob+D3p0vwfxUaGnRjVuhlI8yW2mNiBuaTcoiqbSXBqunInZpxZdnEPa6u9fdve4+/awZ3Zyot0WouxT61PKhz5WjjjSh88yFPvItAHgMSj0kt8okI2lHUIVI/3x/CYr9GZtqfCa+rPXRkt8pPpKuPIf8IOKHei2i7nnQrj/mBSJIdFRvhABLJKw+4R1jTISSpGrkZ3vrelMbBNQpCBHxxVj09g7aoA0dh2qnfplZrvCdV+nObLKAOKtjVeRLGPeR5D6S3HujvTf6y3ijfSS519297n6fuvtoJBlhRdqi4iQ/XK04bfxid6S8L987Bw/Eb6KPVI5YlY1WEBiLYqxSOnIoTeu1aW3WMUXT4k2r3ejN6ma7zludWqc2bdY7paSvv471OFKytE4l+C35KM/oCQ+P3oUOCJcfuK6VLv+F2NU2Q7NG3cQ6bgaaA0k/RLFjvVfwUgTXxSafex0h+akY0olphDYNnl3hs55+Fh7gbG7j+7rUCztRlPA1DhWGb91i9Jp+VF5cBcD17iuDGR6wVy//V0IWzRK9IAEtwdLFqNkFwbKDqHfUu6cIds5l8/vvFJ3q9868JJJnE1zxCa6YDb+YQqCiR5F7q6i+i73RHtqIC8ngDYVeme1wBwQAEgJps6K4cx+f7+PzvY/f+/i/ho/fx+d73d3r7vepu0+Iz1U0tDk+hwd2js/h2arBoljqLb0z6M8O00lVFAbydVb6Be9xDE5xBYgSIjSnr5itOX5srlTwWmtsZqCgUOITetiMo7+X8xXYBOx5qPK1HTXkOO4dfTTntlFgdLA7QCqYepsuFpvxEz1ykioR17PpJb0knDSBJLV6CVMp+jbPo/D1Acx77DuSYMp46FXJEl3G9hJIJKKj0PKtc5k1wtquvOXDtvWoTw1tWIcEsmEdReR7dC54ngGWmeWpEz76g4IXGHHL2XOfFYy9CGZp+ZeJjvGxOvtRcI/e7Y0bF6//+f7yTeJFxvIbTPrEJzsHESE7NtBFfBxEriX+jt0gtU2CesNmS1gwU58lU33W92dg4CdgkYmkOEiQEcBRu3+tiafGbfgI2Y1TYcf0ghVbvz1BfxyBPtR2vdbr4ol1PReJv2loFQmtQtDwO1EpLCRpr03ZdmOC8iIIvvSJWs+eXMKrJOBh9gRXEGoWB6SEwiO9uWVqrj0bjxS8CsJL43HjvKe396WHMWmz9Cs+RnhK3fXFfzOGooNqcD0PQYuejRa9MrBCGlGpGwmUKnLKil2BkJDwOwHFcKQw8Sm6ZIpIXAjWHEuq5CfiLOi8OjCdWjNdvsYz9PCk5ZpP+ARZBmecsIITVqQN8BX+6hMDgCzoNq6B7IAUgKOY/2QJFKIJmydhFVp1An9IY9A14EFy+RK6dV/+6McGTr9QkW7g09EzYIIxoo62+/CApYL1IF8tHxNL1wKyFMzju3TBKWboJvGNalHoKL+19eKKB3HJBE8c/95WeoMl+Xbs7r/J4u0tzV/R0qgY19ZHu1QykBRyGa3lC3g+va4I/h/uqnfXQDANqUr8ra8kGIyRUablh00WtqDUfy14gJFfWX9JDPQQwl1Ufn2AbE5t4x4gzJfyCNl9lb2H3MoxgcSYV9EnU1z2q6sSrLg3/VgzDl80sQodfEMLIBGu8ANl27hr2b4ZSiMEaZYj9MpcCuOiUVojqWkfSEEvCxPeyh/PsEYM6WeCiVvmAh7qbz8CIZEjqhE7XsgEu5ips7ucCb+3wQbJqSzEck0vZge0IE9LzHA6usxBBGCOOoTgevNDNcg/xGcBCKY6UhgaVcjn8NLaxTMHTgIufesy9+E+PytPX+Oq+LfxsXHlTzAROFxj5QqXF8rEROaA16WCHBCyigXQAO9+/YqlDUyIHhJHgSAzBIakm9M3UuL7+uZ4Ick+CywW6E+qq3JAib6Fuzsd/rM+Fv4IHaOPqT+TkPsvf39/X/5+RBz0592fKQ37b3Q/St34g+jPpO/+U9x/xKe4H+FY/CX1mGMf4vqieg+ANGbkiuUwuemQGJXblkcoUSH43RBDJb4h8VR/4FQPD/8PNkVbYQ== +sidebar_class_name: "get api-method" +info_path: docs/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 Campaign Templates' (list-campaign-templates)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

List Campaign Templates

+ + + + + +Lists all CampaignTemplates. Scope can be reduced via standard V3 query params. + +All CampaignTemplates matching the query params + +## Request + +

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
    alerts object[]
    + +A list of errors and warnings that have accumulated. + +
  • Array [
    • localizations object[]
  • Array [
  • ]
  • ]
    • 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. + +
  • Array [
  • ]
    • 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 objectrequired
    + +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. + +
    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). + +
  • Array [
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/list-certification-reviewers.api.mdx b/docs/api/v3/list-certification-reviewers.api.mdx new file mode 100644 index 000000000..4ae71bc3d --- /dev/null +++ b/docs/api/v3/list-certification-reviewers.api.mdx @@ -0,0 +1,95 @@ +--- +id: list-certification-reviewers +sidebar_label: List of Reviewers for certification +hide_title: true +hide_table_of_contents: true +api: eJztXGtz2zYW/SsY9kMTjSXbshzbmtnZVR2n605e68dmd5zMFiIhCS0FMATpRz3+73vuBUiJkl9JO22T6ostgcDFfd8DCOB1ZDOVy0Jbc5hE/SjVrthXeaFHOubWI3Wu1YXKXbQWFXLsov5Z1Ojgog9rUaJcnOuMvoPIyUQ7MXh7KHJVlLlxQgqiK+wILYGcGNlcFBMl4nliHTEQhf1ZGXGhi4l4c/T9/wbPXx2+Fui8f3B0Er7JspjYXBdXAhPl6mOpc5VgoIhlmoKqn74jjhZmQ3tjOvQ3QqZucSBkdSouaQbIex2dOpXvW1Ooy2KAqUkHOjH9Bq1+rmQSfbiBNjKZy6kqSGk0WpNOMolxa5HBA3zTCU0RT9RURv3rqLjKqNUVuTbj6GYtqmSK+kVeqmX9LqhNHD4HPXUpp1lKhNRoa3e019vq7ai93vaz7nB7ONztdXty+9nW3k6yiykCWx9LlV/N+Er1VBfR4nyv5KUw5XSocm9CV6aFI3V7+3bem2OlxNm/t9jox4U0icwTsW/TVMXM39taIx+eTIoic/319USdq5S8r+OkTjOrTdGJ7XQdml2XmV53gU47rum0Z5p9yiad2lwJbfBx6v0nmtfdCKZVc3rpbm/conXMq8Yqx0hPxjdtddEw1UZPy2nUx7ipvPSfmUqiRhJa4G83d2nTjkZOLavzDTeDbWiQImBUwve8VgUedMSpK+GOV8JlKoaN4docDS22TosUn8mxNrJQGJ/bcjxhOsEwX4w5foUxavXfrfzYlmZZ94cj0aKQagldQKtQfGazMvWqVKL1n/aJLWTa3qfRLVJphhSnxATBDfdnO1DHW8JhIkHRlmkihipEBiynR7XdoD/R8j7REshKUNXYQGMJLAabaRMrTmbKFUgDSJoFsSJYEM5UE3mu0AwbsXKov55mMi7WSBpOhbDYVJkEExtbkKc4RbO2mMjfWPIW8cTcnsu0VF4L1Btsl67i5ovwIJ8cl5xoaG2qpInm/IRH3ukrI50WvsTdk5ObjvSCh9TWLx2ZjDyjklK4K1MgcfphQ3IF8zur9BsvFzhrBz6fkm1fVK3kMq7MMpsXYK8qyCOQshf0GKknTRz7rUcJNnd9otBq6aTV6ouW+gjXMy3fRsqsW91FaIU6dTrf3KhUNEaoj+J99J0dvo/uLEyOeLzXQnMZg4JAtp0iTUCyZeMdg9qf3HQk8KLhjn3b48wGhbNF1kSwwJLeI8IqVYZzpNHuxgb9ayprsAzeQComOIQEi+4yy9IARNZ/cjTmetlKMs8l2VMXaurm2u3wJwhPhkYVlMNZVGc5Ka/Qaq73ss2XgRH14GxpDUooctrh84PXJ4cn/+0IxqWcJmXSpscNlVT9yF2Azx6c7DCB/IxBk06D0Pbms92Nze1kqzva3duI5eb27mY33tvc3djd2k66iibwbv3QFP8skeXbxC5pRiTaZam8Ehw0sIcOHDwk2QAGhJe+UPm4dJamZ5d4eP4D6iZkksBL3KfMKHnGzsjP+I9qmLNoRBBEyMQRGrzew8Mjhe4KRe0diuxriDgwCTOA3jc0oHebd+6nGsPFQZ4jDtpA/LO66zER11MxtAkvFrRB0fMG+1QPrj216ZmJKsDjvk0eYc8X2qj2OJeaOFTMcoyBAhTPdUKxy/XPkyR9kwjcr+lh0ERnU3wnE8jr5dsPwpBecxn/DFqHj/DhU6MxXlRDYN86n9wyrdpRcvhsY6/bGz3rSdnd7W3ubA/3RnJra2Nve2+PZp/CU+R4Pmjr0G9O/b0yKEKxSC3WXvoXKASuRG5KDPDk92WLpg2YxiPzg+9bixn4FbS2WwO4+m7/rejtiFSaccntcrygBNM+PV7KV5DcE36T67E2t7GiDIHXs+j5wYvB6csTtBwd/Ov04BifiNbSKnpg4K0JuaVloDmxF8xxEOBCogooqhyAbKIVqLYgkDRuvqP239yVgzJFQEQYEWa/ZcQ8aTHK7bQRSrFfCIsnuqM6a8iwaEPdjSdiKAEfkXc9lB7EscqK9sugyVbA0E+xxk8STUIC3DIEdRjPqRqZxhdbvyxCKCuG3LYsCKHqWDVtMVPlYvWoksvLeaNQcIDzh/1kEBdYgbFPNKKw9pbAYrAPePaaa3J3Mqc0VimhChT6mBd3sc0B15GZIJsGDAnpiIs7Eo+p+tUZaz5ncrp75Zl5Xlh+FsvSPSLu3qZIP20WrX5wrkLw8areZyO2RmWmkJHCgpUHh161uarA9/BjFbur2F3F7iNjd/HhUcDk4SlDn81l6HNqwj4oFc8l6JOz9xhbbZb+4ncKvSHXaEM1QKQf3p2EPVf0V5cZLbV/Q3zkS/ktq4rKHmGVVS3CqtI/swUxyHr0EoyQiVTSZ75nHHuQyKraWp7thc2HGg5qboGIyJq5uLKlkFBZXhrDmy9uTSRWOfNtEbZdEBHO+QxIs5qk7dd0KyS5QpKrarSqRl9NNVohyVXsrmL3y4zde5FkzRVHS8BJrpxOZX7lPS08J2mlQIfZ7191yLGpFtEKERM1xoqayCEadjeHm6OdWPUS2Uuebe2NuvGzrtze2dzZHPa6O9F8rT+bxXEdZM2YmrO3tyOrGCDuHDiuNHAuV1ibNLf/StrvH1Fao9RT42boHCr9MMOOvWXs+NoWkA2EgR3zO7YXT49eEn06aUDkSW+2zGNFMNurzv/iRpCSf2tTl9oVK+i4go6r8rMqP19N+VlBx1XsrmL3y4zdT4KOvYegY+8ToGNPEMQaEcT6I6Fjov2hqRGMAhniEuo1BBsziIJPYfcxhH0h87EqaqDXQJHdvWUUeWKteCXNVQWWXGMn0szURekNfafUN6/6ooMUY6RIQ6e/NNAteZWeKsKkdHiNj5hRHJNAoJtftQcjOqAUDq4Ff6tn0SZOS3DISSG1tPdq4WOaToGNCP6BAu+DjpGof8M9zmCtX7UfLI5I4pcksTi4jJWimK/3f7dvOyVwCOZzShfH3tZ3HBfwe+bSYBmhLjOfvmoIuoLqK6i+Kvercv91lPsVVF/F7ip2v8zY/QSoHtDQ3VAdHR4N1dG3syFqLPWCj9b/3oidQyVwwO4tbMxYPZlhcMYVcCViaMw3cPj6VT9ab1ybcuvXOrlZnz/W7NcCnrUyTzGkOs99DYvBUjcdmelOdaDV2As+1H2+dUv+8QdkyXeQwZLSHxWnI+R+kg7rOdfkyj7v8QRe6+HaQlSfHb+XfnUg+AprEeHJrNFB6OBW3Aw2M6wpvnXcu8NutCQjZDvN05uH5AlH4e+QwxO5Q47b1HfvXOgvwOWCeMT+h9ktvWMC3372pbt6s4JC2/7dpcneULeu+E7JHCsDfxLmyQ/vTp6KMUFODnl/R0BpWiMgaN7CRTilDapTITSIq8zsOtagce6GQkiMUggswu2a6tzza+T6IyRnVikNUpwPaNTjbxPIxrg77tK8N23xXOf+soG/ExlE9PeNzrJKLjkn1+cy8U1Fre2ptZka3WRocOFVexb7c9wx4phIyNSxtj57ck+vPUePFlJoIaqLPJAmAh/N01JxZbXP5qNBr030mny8N+8mGvW0OUz49CXchC+UHYp4Yq1TfxeCXIfC4GxcIoo+m60LmrTNEdHubsyx1PZTtnUb6JD5e4nAMN6Z5JCqM4MT6/dJOCR/ZMsi5n/ku0I/NmTm5jMUUeqZ2PgTrsgs8EwTtmnCts8BLvDvaxQ5FmKbZOA84B1gf2Z/zgSB0bmc52ndmtWZ/DqPodIQg1Wm4rK+/9KfJbjwSfAD6l33QQomcF2fH6ObxoEWFaqGsqptgUUNLvObWtTHBb15fusfN6lm/tnkJYkHs92TNya9+q2z9B2Z5M+Td/+gjLfKNF9jpglwl9yNp124VEVO7tHa8l6e4zvP+IunHKmMq7FqmV1znieTpbIgn+aYjida8S5ApmRByG+N/MpOOQ4Bdyn4sdZjQuMcfRC0DmhUDnXK98feYZllYqiYllh0+hZUf7JhrXUMLb8lI4nnleEAoKbT0tB9OzBRToWEezxg3US7uPRJCCsuoyrJLMO4elQVkeQ2pIoOLzbyqXszou1irETnjPjAXLBhdTsSiiSLhAusM0GOVBpenLG2AL8fog3PaU9UmtEiDxkUYErNzfDq8GSJIoiZ8AOFzcfrYZBbp74gQksd7wxbHSztqCmzrsCKdI7uy3D7s/kyjcZCatG3rmeb5V/Fy0BCaaI1xXpG+2GkqdKvcfzK8ixqriwxqM8v+ZgtLrFcmUC51Pf6mrZPaKV1Q83+rjMtOWFpCqbZVfc71fplvZPjVgX+rGhDonrlSNhy8FfAH6+Hv9bLNO7RY/2ykc9U5OrNGF/emzHucYfq9Sef6Q2r11v8itdb3GOW2ZtGPtMwf9VXV9yj09m7QWY6/TDbk/zEwvrkKECIp3yW4pb3bN3KSvUbmrma56NiEVDg5gN6+WTJHPkH/oeTuSFLRwtIlHoz+/sDwnjyjhVz+NA/o23w/wNPRkji +sidebar_class_name: "get api-method" +info_path: docs/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 Reviewers for certification' (list-certification-reviewers)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

List of Reviewers for 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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/list-completed-approvals.api.mdx b/docs/api/v3/list-completed-approvals.api.mdx new file mode 100644 index 000000000..1aa175cf2 --- /dev/null +++ b/docs/api/v3/list-completed-approvals.api.mdx @@ -0,0 +1,171 @@ +--- +id: list-completed-approvals +sidebar_label: Completed Access Request Approvals List +hide_title: true +hide_table_of_contents: true +api: eJztPWtTI7eyf0XlfEiWYoyfGKi6dcsxhjgBzLHN7k3YLY48o8GTHc8481jWZ4v/frtb0rw8NoYlz+OqbIzHUqvVL3W3WpovFX8hAh45vjewKicV1wmjnj9fuCISVnexCPxP3A0r+5WI34eVk9tK1zRFGLKR+C0WYcTSJh/2K5YIzcBZIDAANZk5IROetfAdL2KBiOLACxkOwHybmXoQxjWIKhsLwfb8B08EhmPtMRgiWLIFD/gcWgZsKlz/gdl+wHgczfzA+Q8hzhzP9quAY9ISMf1ScRALggG/efALfNXA4UkAU3ACAbO2YXCxXwnNmZjzysmXSrRcYOMwChzvvvJYnNnAZotAhMKL9lk0EwyQj0UyQ99zl2XTI8SxebgQpmM78JtjAQwnWlbfe4yxPTYcnd91Ty8HVywOYRbM5B78c13oBrR8cKIZ494y6cYGp3LsTf1hZJ/ZIjKhL0ESGZQcjx74wf0+e5gJ772nCcRgQM+PEJClwV/5nlE2BM1YzmrJ9uZiDwAC20BMALgTMID53ltFGnggPnOkE9C0YR7Xj2pH7cMjs904Ng9rdfjL5If2cc2sN+tN4EI5R11n7kSVIosu+WfmxfMpSA0IGzArdiNAx1dcghmhrN2+bbLu9YCNI+5ZPLBYz3ddYZJQXSfC9OG7WRQtwpODA0t8AhEEhamG3HFJsKvA6QPH8g74wjkIFRzDTOAYqVC+IQmY+4EgiQ3mJL3VMlFM6NJo10oEE8YV9yKAnhKMfNRswIO54znzeF45gX5z/ln+TVAsYXOgAn17XEdN37ZDsUrOIT0GtIGCKDB2DKIkqcrghyq7CWOQrmVGtkla94g7e0j4Bb93PB4J6B/48f2M4CjG/G3Y8RXMSMi/nvimH3urtAdrsxcFMWiVEwFVgfALfxG7kpRgL//PmPgRd40e9t5Dki58LxRsJrgF4k98wIYl6jDjANGPXQtMq9IMtEp2wjegHxhkYv4eexBIqnsPKIYmAXjmeCb2o6UALCXjwGhAhdFEyDTM+CewNwx4RMTB9s58wU2wnDAbsDGBAI7NYZmAgdHegKSAYYVR9wjI/9DM9xAnwlaaWqICtga0lYH6u0gQzqdEiKa+7wruVTJyQj3XyortuLTQfc06dkYwEnGIQ+QhrVCafOHSi8CSym5TlA3vD6bxN3KigJmh8HyDzD7TT1GGwnix8ANcbPUSawMo/wF/BlvkWiEJsvR0/CA8QQh7e+Bi7J2wPfEbyKK3z+4F/AO5dOHThU8PPp3QA0u3z8KHPdlHCbuwzvyg+hIAc98i+0g9qXUke2IvDQl7Qo/cAglLsviNvX9yoXxfWbtUhkik58lMxqihnnIjFMgbIMCqOI0B/F9cmJACRVEay2fbCdIJGqZAIAH2WcrLHKf048rjB6S0NMch0rZRq+FHnmwXyiNO3O7UqUZTYvqwvsCyAP3Ab3Mdk4zMwa8hdv6yyjgeBBx57kRiHmae+9NfgR7oJQdIv8iRKIErXML0oief+ozgfFYLcllvNFttFAcpZttAw5Y456w3mgfLrxAYAFXU3iiaFrQwIgc6FAd7B05tbhT2wMFplTALHmit3jFqHaNen9SPTlrtk2anWjs++gWRSFj6mlhooMzlIAHYcQWhI0So0Z40aieNxknjqFqvtQghZYd6r0QcCuoMBfQ5JGonJFKdJ4TGKjrCQz/otnI+6l5N7rq9Xn88hsej/tvhT/3kOxrLlUBShZwaO4RcZadymSSfPguzynIgqXUapCh3BG2TK9ggE5KoSChr36XK5ylQQB/x5dN0XQdo1EyiPMqQJKUQuIolWlk6ZdThBKXg2zANGFf0OFpD9+3gnk6Gkq4ZTg1O+1eTweRnjOxTAiRPYULb2I6nZgK0LwaCHVjfeOvQ5uC/ihasb/a0JUAXzEbtsHW0vaHJDk1hLQw7i8EJBUHnFrKNWU64cPmS7FEejXfgYjp8zuATLS34YQXmDgDsKOFohr0oOiX2uODUy+kD85TykdIlIHD9qW4y4qXQlhllltN2SmC+RG60fKDNdp4z2OsKE+jpsxHICFZrg2A1DrcXrB/WC9FX4DfyITyLGHw43tMiR1L2SCHmQApJnQJ+/aVGEvnJEQ/C+n75DBF6mGGSRHZcmYFC/1XFaNsBf1dR2hqJjDg1O+vFqd14fXF6Po5d8IE91nVRsDaJVCIm8DtZyqflZagM6teuSBrO77cCFTEtWXGONxiG5vH2nNRDrV9WxjLCyHGCep1Gfm4RGUqyr0QLk6yTkpUAHOfrXf2Bpd1yCaQ0SdtsWw3RhrizVm9bzYZ9BKEnr7eP6ttT6ioTAJSN1MVQByY4EqHggTljUlxXgs4nLU76beNwko6UH1YDZjI6EJzzqY5s9ymXIMOuyDEJpXWirgVZ+ot316Ph2eCij27vkD5IkC/6l/BZsn+iDOU6nAlGVo7U0oBGRErPSNgiEJ6Z9z57lG+TAaXrDm3aK9ksOWbapTjFogecn4Mai6kgNj8B2iCC/zhT8KtfH++dYloUGYS/argvi/nkHlOZJURTPYRwonzOXeqnOadJt6113NL2lQXVemVVeG5pHrFn7DkgHEyuiam8lel+qyMabbvZ6QDlRIOLI5OL1mG7Nn1eAqC4yK0Z9Fd/5lUtHwT4MSvpSqykzdxkIdEYp8L1IfWJdlqw04J/vBbobNO3ofYbc/pQFFvSjwW29ONQOYVBqEbJRqHPTDHu9GanN39ZvSmBDoIV+cFSA9YakehQokIhiRzI1QMPrB9kr5erie+qghsRXG1FidMCFbjqzezAn2O0OF/NOStki5J8FnDvI7t0KKXgiYdXQgT86Weh0XXZW9+NOGny11qNOQRzMLzjCj0c9C5MO3kuaSbJAFh33VfI+k/QiOAO+8zB4pst5g8G5dioHRmNJhqUduOk3ak2lUHRXdbyZDNVijxKwFFaIcFnw45MMSNKliwMnXsPya3z/ht2jrLNVRb/vbfHLrtXN92Lu1G/Ox4Pzq8wGDphXS9DMFnBQNmzAgQ2A2JOhfB04YlJVSi6HcxnusxLX8TDj7AIUpZjX3JdFimBCQMjhuUH/lz4nmDCDcW3ocSxezMZXnYng97XognLgk9xYxFPwoR7PiATJAoEiBJa+xjo+1JQqQIHpCrTJjceLJa2cx/Lmr4qSznwRFPQlyXWU2CdT7zAYcpxzZNSVrVxZgnbwWl8h5VfPjScQhewbp5BpR1vsALE8WVyATe6NFHv+uNe9wIoO7z686iZxAvQAsSXu5IgBUqeldR6MD7142htp30AbEs7eDsWEW0zn7v+FOY3EnMHKBPI0oR+CuDadx0TloTMnrdvxjh5iUd+3zvkPDyYCXdxoKYQHkgM7sQcGobVWTR33xC5x/2LMxDft4P+u7vT/kX//NWprnQtXIaYkcSaL1gysX8oXNuQyydKJIBHlMP0dyeKaXZYH/oRd+iSAA6GJD6BrOmiMomtKi+Q5YVJ+nMTl9Ro2DGDUJ5HyWN2rVr73nM5QYWRBw9+8PEuS0VixTeZkY1FMsQbkoLb6xRDQkXz5WtlgS/uAt8VUhq+SelghNlR3hQW41Kbl2YZV5zOEkMOv64FU1B/eFIuoejDpimuwoqTy2ireZzlHbKnfLxE+NUiCNZBlnGlTshIlcvghvlIoPeWcwrWFW+V77cHsVA2BwGBuKJikbKAUFuJzx9SQa5qpQidLSID7EIQgzWLLlhjmBE1KNZZbOBg9/p6NHzbP6WN+R/7vQn8mYsgMg0y3nS+WnxMWJF7MAeze6pw3MKr1yWNKKtYQqyy2wDWRi+OKpKZ63v3aNS10VEWvKSoep2XlvW3GjUVwNVqJ/TfL6thcXYmNwuElGzCvUAIBjaJAFWO52oOyDGE2ZgzDjNUv+C4kjBAjzD2cHXGr9UScTDjICBhfR7Z1w+iCkQBrYTa8B0Ro/hYyVVm5+mVyB361lvHl+thD2P/zyUbIbBsyUBK2m/hmbICNa28Hw9P2ScNB8gqzI9P7pEkKrVORcY3uvajPxoNR2tKViay7i2CqBGoVI5IZlPopryeBEgRxzIKXwXvJDs1b/OgGVn3Mi1PBrQ7Tat+KI4NXmseGa1Ds21MG3VgTKN1KOpt25paVhk2ySR6ONCINkTWYOd5WGusGaSOS+iSwDyP3j6TR3MwCvxePB1Ruz64KFtqgWyb1P2pMRjKHviL7PveNWt1mAuqGdNzXgglwdO9KeWgBDwMnHundL9KC9Zp/6x7czEh0/uvm/54sq4aCs+7WFgGKNNEM/+BMFYTQG2FVZ2WqCrbU1D3YELcC7MNnTDrrCmbBT3U6CU9sqCTyCmxXqZUVPadUxXVfXDbQgzB8djJlIfQwZfGbg+32haRcaEouafq1N9UWdeyHJwkLFxU5h3qkIRblqwWlUcPojgQ5AmiUwc+vmMWNllTUq6rz7rIMgVdCGViniooAjfVJZnQuieCAB1OJS0KRcUfrOyjcYqJy7zJp7JYU7vTEJgEqDNTmJsThTr3SdWp4NJ7up3jAY2wFjPrAfURm0uJDKa3ytaezOg2uI9Yx0oOv+OZbmxhPZK3LEwrWQbuhSeClTzobappiRrkpT7DEUlplGI5Bjo/vklLl8WsONAmosxmUoLadB2gx6WIOCwyvMwIFJnOE7m6Lkmirq2O7wZTJwo4OIkfxdKQBw8W3AlCCqqX6hCC+EQxCjop6KykUZAuqLkC/VRKhjylXtnTFhQzkjnM7FEXZp4j95e0SABcLpkNArKGETrylf3cr3SmT+Ve7c7RcQP+smv1ztG0c2TxFm/W2rxOIvSpsOCW5fuLhE0Sm6vmVFkDVJdsIJabHkweemEZP3/S5i8wKt6ijAnFRrZ9aUFKCqG0JgV+vrseXgx6hdx65vmWqfPMQMWKlJpdr9sN3jI65nHLaE3tpsEbU8votBrto5otmlNLbJ8xzwy0vjDleyzYR28bW19LamdNy9i35FOVNsfIEr7iki6LJ3qalU/yaJJk61VqFIWFO3qxEXZE0TDYjlkE9gGrLTAu0hbXI5RkiESW6d6PUolaSe2skwYcZxPOhT0s1RKL9Tel+IvVJxEmYTTq/RT17SVffHbocNVWoUbhmFGp9c8QkHEXd6OWdLIWgo4kmsIUBgYDsLpWswUuqbxkS1c2BJS93vDmanLXG45GfRnnw99XZ4NzTAAUq2LUA+WB3Mlgs3shf0E4+Nf1NSiZzhj0upfX3cF59s87ADbpj/BJfzQZnGUaX9yM1S/DqyuIboeju3Hvh/5lt7JfmM85BLmjq+5Vr393PhreXMOjzOaZ/jODevIocd4qF4Ozfu/n3kX/bjzpTrDRdXc8fjccJYYiqQMa3dBHxobgl5tRD59Ouufy/3cwk/75cPQzfR3/BGONtcd4PRxN0u8I6O1gmCRWNBu6vcngrZwD4PGTnFqZh4n8U8fCtfAii0mSwSpmT8qgI6b8nuySB1Y/4CAPsYnuWjWTMAADoivitzGTWaUZnJZtKrY7nbo4tppNWNg6zWnTnB4e2ofN42eUimcHoR7ZYS6X7IdRVnmLhrH/WcwXqTGRu41kvnYGZmdgdgZmZ2Be38A8FpqsJMxSp15Yek9pC5++wKnkvg4dky0UKBUU4pFwPcozDqzs3PQ/xE1fKyOZ9N0TckRNkxx/RVaI6VT/BBa5exGkicCVfMvmMyd29hiDzkqE8XTuRKj5cnMwkoNgBkRvrqKfj1VamLco9MY0Bd7IEGCWSUbjTpQk22XJWHrzRGJ75BhYui9MJ0SrBAuVcLL7x7hcgf1ZFpPeWxe7lUXJslQlSaYpPAr5Iic/Pdx/VTjR/Pw40Huy8KA/GSMJ5RnrQKY15JSeKM9IZp6nyabF95W3i2R51UtPEBfI1k0o0h0lJ6qJHGsy/E9vXjSM2qFR60zqxydY71erdlpHv5RiZ+UKCTPUJCpbaTpU8VWq6tOprddOZelNx1zqrewo0e+TdEp7mXTbR8lcVjLqjxtkqaLWxVbZOfseUZdRjpQZbJS57iSbFJ364K5SPlQlWJ9/BH+No22Rs97zrS0WgzOw8sZ9wKmoRmZKTeio+IWcoiIHCTKXjM6vF0CJap19z63kxq6emgzSMeDmR4A12GIZvJFFnroLbj/pvZKSYUVH8Olh7bjRsg9bnDeOWvVOe3psc/ChjtvHdKRKZZfLnJL80OeYdXZMmUx3/gMEwbIKUCBEgAbf5HjstoR2W0K7LaFkS4jWGR6HW+jdtQvmx6CpJT98Ekr5ciUr6bKkLZIK86lzssYoWmjFl/cr7HR3p7s73d1Sd4s/jtTtQupXcn3qq67PjacvzIRJrLg+gS6tyt+qKRm5j2GPcpF+fDcBxf4IkRTe7Pl5gSVxr+gfyaV8tdAn4Ye6OUr7qXrpT3mBCBId5Qzk/vYJ4Z1iXHlMvMTm6mhnPvjKIKBeiYtISculHzMOJAtiz6OKo3CfWb4IvW8jdb1McpY4UjegGrJGc+dJ7jzJ3Wq0W43+MavRzpPc6e5Od/+eurvRk0ywIm1RflIYz+ccD7jS/p38nc5PMGiQXjucqByxquitIDCW+FiVvOdQmTbq07rdMUXL4i3rsHlsN8zDBm936p36tNXoVLJr/UvKDqkuWwRYsxfT6avI9618+i+mgnI0a+oMnPSbgeZ0g4T2HRvHJel032eXWD6pPKQw50N6KY3QpkHbObbVZ3WwAWf3YBe9wmE5gIJFl4zuZEblxVkA3GBpdG08IqVuek6uMFSjJBWdaAlw+53O43IHr0220ecDCOTB3oN1fkXvNFOf/WJPno1wxhc4Y9b/bAqBip547u2y/O4Ad33QRowlg9ckemW0wz0QAAgIpM1K/M6df77zz3dr/G6N/2es8Tv/fKe7O939e+ruM/xz5Q2t98+hwdb+ObSt1ljiS51R9ecf7aaTqigMSLyTI0KpD05+BYgSInRPr6xZ8GgGXw7yt5knx9vxNLwuY9qvyChA4hcHLvTTR+y/ANuAXY9VvnCq+jCx5z/QGftPzRIjlFYVwUhWLN9egG81kINUidiBg/IsjR8NIEmvymsryVH+jfB11csSa34kmH2sfVOyRY9xlhBYfBuq8rFHeodIYY4wt5vAfXxqPurtDGvmIYGsmUcZ+TaOBe0ZYFmYHqL/AdkF/AdAxK+bEO/vI6uF12XBsw/ZNmP00iWGKy3TlQcju8YKQkNs1mDfCx7QnRC42fHdj+8mb9Kzb+rVFro4jF2DGJHtSy4RxU60HKUvOurmtlZQ15jtAlGYem9NtrJ1BFacyI6dBBmOwjUUT7wEg+f6rXlLzXvPYKdOIN+RIa9xUVOU56hvF3pePDOvlyLxjYZmKO0kaPgCjhwWkrS3shAKL10jstDL04BaLx5cwjMy8DDigicItYgDUkLhkd8QMzXXXoxHDp6B8PJ4vPfeybuict2YtHMsnNGrmgbMnPl+KP6X0fvyUFVu72PQtBejRaewDNIIo1HLoGTIIQ3HADeS8LsAxfCkMMlLVciL8fG+CUuq7b+Js2AX/k0FcP/OzZke38Jqiy0t33zGm10KOOOABg5oSDsRKvzlYoaChSV9MAdZlUkC0Ev5T5ZAIZqxixJWqeUn8AfUB5cPE1CVNwYsTuSXk9QIqr8Y/YCtkzZgptELT7YI8ZV8CtZjcmugIpbOHxQpuIqv68NCWqCbxDfJX+Hi+lebL864m6ZZ8FLE17bSayzJX8fu/kkWb2dp/omWRvnFKG40rAogskIuPbrVpF9IZcrwf/iVNJUccI5ndPULBLNgFi6PUKZJp82ZIyhdsBCcrh/fz9Sj64Px6v2l93SRasDowrOp4+JFPewdHhozgcQYi2GBBUD91VdB2RiofE3vkD3VjMN3Zc1jDy/zByTiOV5L8xR3LSc0Y2mEIDTzhJ6ZvCMu6aU1EsUGSUEHi0QwD4c25pUhZM0w8YmxgIehSipzeZe/ehFbOpGRkKctsF3eRX8KNkiOgZd9YTQIFhScKZEZ4XIwWYGI1/GFMC+Iuv3g/kB1Cg+wLR4WgslLYWhWIQakox5+GEHomoGbeUnZmhcBMzrBuHJNf5JZ/xPeC6wWE4wCDhaY6sK5xTJykUHjbWVd0Ej802EjBBkzH89n3la+fMHsCMZQj/hYvmkPgxPgD6qAVX79U5YQu9cIv9ZrhEsZ/FFgLiTzwmeV8JDvR9yeTX+vVwlvIIV+U/IL6fDf9Q7gTSKl35H8QkLuXuj793uh7wZx0G9tfqE07F7C+5d/Ce8G5qevYX4h+/+7X5q7gbLpy4pTyn5IE9CU9AV3jGwiOV6ym9ylyvRaqeNAKMnOwXkffN/H/wdU/k2p +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Query Parameters

+ +List of Completed Approvals. + +
Schema
  • Array [
    • requester object
    + +Access item requester's identity. + +
    requestedFor object[]
    + +**Possible values:** `>= 1`, `<= 10` + +
    + +Identities access was requested for. + +
  • Array [
  • ]
    • reviewedBy object
    + +Identity who reviewed the access item request. + +
    owner object
    + +Owner's identity. + +
    requestedObject object
    + +The requested access item. + +
    requesterComment object
    + +The requester's comment. + +
    author object
    + +Author of the comment + +
    reviewerComment object
    + +The approval's reviewer's comment. + +
    author object
    + +Author of the comment + +
    previousReviewersComments object[]
    + +The history of the previous reviewers comments. + +
  • Array [
    • author object
    + +Author of the comment + +
  • ]
    • forwardHistory object[]
    + +The history of approval forward action. + +
  • Array [
  • ]
    • sodViolationContext object
    + +An object referencing a completed SOD violation check + +
    violationCheckResult object
    + +The inner object representing the completed SOD Violation check + +
    message object
    + +If the request failed, this includes any error message that was generated. + +
    clientMetadata objectnullable
    + +Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. + +
    violationContexts object[]nullable
  • Array [
    • policy object
    + +SOD policy. + +
    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[]
  • Array [
  • ]
    • rightCriteria object
    criteriaList object[]
  • Array [
  • ]
  • ]
    • violatedPolicies object[]nullable
    + +A list of the SOD policies that were violated. + +
  • Array [
  • ]
    • preApprovalTriggerResult objectnullable
    + +If the access request submitted event trigger is configured and this access request was intercepted by it, then this is the result of the trigger's decision to either approve or deny the request. + +
    clientMetadata object
    + +Arbitrary key-value pairs provided during the request. + +
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/list-identity-access-review-items.api.mdx b/docs/api/v3/list-identity-access-review-items.api.mdx new file mode 100644 index 000000000..7c5a01735 --- /dev/null +++ b/docs/api/v3/list-identity-access-review-items.api.mdx @@ -0,0 +1,203 @@ +--- +id: list-identity-access-review-items +sidebar_label: List of Access Review Items +hide_title: true +hide_table_of_contents: true +api: eJztPf1z2kiy/8oU98NuKIMBg7FddfUeh7GPW8f4AU7uLknlBmkAbYTEaiQ7vlT+99fdM/pCwmAnm022pmprY6SZnp7+mv6YGX2q+GsR8NDxvaFdOau4jgyHtvBCJ3zoWZaQcizuHHE/DMVKVg4qIV/IytmbSl8EoTN3LOopK+8OKraQVuCs8TfAmS4dyXo3QxaIMAo8yThD0MyfM05g4QXCZQ4CZnM/YNxjjh6ZWXy15s7CY1Z2nDrrsdD/IDx274RLNhpfvu+dvxxeM+jdH4yn+hePwqUfIBgHh/ktcgJhQ0eA6ros1JjVmZqZCNTw9Dw3HLT3GHdloWMyOdsXknl+yGS0XvtBSKMJGSqIOWBAASlhRgqTS/9OBB73LMEuAz9ayzrQds0DvhIhIAQU/lRxkI5rHi7hlQcv4Jdjw9/SWooVr5x9qoQPa3wqw8DxFpXPB5V4spWzMIhEkSdiF4XZ8BxGEB/hpYugxfzoZH7aPmp3xWm7c9yadWazk3arzTvHR6dd+wQG1YjCvIOHFFPXWTlhZRODl/wj86LVTAQoCIGQkQu0AnooKam/9SZCsDevjoi6k5B7Ng9s1vddV1iE301Co3c/L8NwLc8OD21xJ1wU47rkjrv2HS+sW/7q0LG9Q752DqWGU7MSOLWU1i+IVys/AOJ48OdKiVolS805SIHI0KXVaZTwAcYVCxFATwVGPTpqwYOV4zmraFU5g34r/lH9TVBsMedABfr1eRs1/flciiI5R/QY0AYKhsDceQRiqqjK4EWd3coIJPeBybWwgMcge6Q4VeJOFQm/5gvH46GA/iCHiyXB0Yz5YdjxBcxIyL+d+JYfeUXaD+esikpWBQsGVAXCr/115CpSClb9Z23qh9yt9bF3FUm6BiMg2FJwG8Sf+IANS9RhyQGiH7k2mwmtGcA5Z57wDejHqkomqgwMGJBq4QHFbOAY8MxBs6ItERgGML0hosJoImTUlvxOwGPgEREH2ztgDqzwAGdDVhM4thKeDQOjfQNJkQJHrRKQv9LMq4gTYXvH3UgoKmBrQDuSMTY/hAQpc1kQopnvu4J7lYycUM+irBRAa+GZOy4Z9EfNdl6yLqhLIg6RRB6iqMTTZvLBC8GSqm4zlA3vG9P4L2pegFlN4/kCmX0RP0UZ0msioKeWV7BPAMq/x9dgi1xbkiAr/8MP5BlCqFYdu1o9Y1XxG8iiV1XPkGL6qX6inIh68QXMATgKoyZQPFGNIau1bxKtVjx4qJeNtNkG2Zi0kvf50csA6Ffl/Qi2K0Cxwrr0o8AS14/Avwl8ILPY0jK3Tjs2E7+xtzvX67eVrSu2RF6RpBZkeZvoZmwrmgtekwJFBIiPUp1il6HJQW3b3AoWdqIcqu9ZC5BmmzowUc/20wBgZ6nIHbAszVhG2g9YuRDFjcqEZivPM6CexPjPedlT+A9SYAVebtg0WE7I+S8LBWhBAY6EHPgJDbn3gKsjsT5xYzbELUsTcGElrTw9j4kg8AO1LvmWFQVqwQLOEA+RRbhOaadIa11trSgoYX2DztVq4KsfXDLfA2fK94RGCJZzIqgCJ2lp1Wsfg0nAuuusRH0r9TfGezYDcoxvfnPaZ6bhiudTPyuLvzvpCfCzCQ6jBGOA8M1JjWh/XQoXZf75tH6H9FRurkQKthoN/CdPot5jeQAgqOWD4w4WBDry9drVcenhrxJ7fyryhwcBR8aq/ulzf/Yr2GuMqgO076GjcFKDalNb1nwDW4+pN2zpu3a8BGnMiYVA45nAF2oewt4y5G7U1NtNemHQjm+QYjhHPZqO2mm4zUVZeBjcvKn0+v3R7fX0fX80Hg+uetPh6Br+vr4YXkIjeDmYTN7fjEcXw6tB+mA8+L/bwWT6vncDr171rtQbhIN/3dxcDfsECX71ey9vesPL7J/vAdh0MMYng/F0eJFpfHU70W9G19eD/nQ0fj/p/33wsgePBtfT4fRq8HJAo1yOXg3G173r/uD95Xh0ewOPhufU5F+ZPzOoJ4808vDoangx6P+rfzV4P5n2ptjopjeZvB6Nz9/fjGAOCGk8ot7jW/pnMsq8moxux318Ou1dqv+/h5kMLkfjf9HPyS8w1uT2CocaD25G42n6GwG9Go6u4pnHbOj1p8NXag6Axy9qau+ydiUzS9JUeHQe+lNkL9gfxy7zwIrSMjyPDckWeUkHbFmnzZPGyXG3edw4aR+fNJrd5unpUcvqNDtH81kXh1UWc5+BseXeQ2e8BfKO+uC3ow085yGfcQkz/ow2N+NTlCiQF7kun6UBXF6h9iWYk/pnIufDFAjV6TZPWkeN44YmVLfdso6POp2T5xNq24j9679mHb3ZbNa1jjuNQrj4qUCEx8cfpiEx4zM/Ch/F4tK5E2iiuX14HwBPE9OnEk6WZpqdMA154NzBUrIQdmkgncDWC24+sC5ia+MKADg4BXKh6eUsHS43CUDEv/dE8HSpic3wbjaSWcbFkNbLGWqe0l+dIXYU5Wr4ulKq53tqdZyQB0mt5wB1mqizHfuoNT85bVi82TlpalE96tgtsb9Y/j1aca+G6CJlmO3ItcsfEkmNffxdM+vB4g6CdSGCRSR98ppWEFjtHn+AzRi37QDF6wkjchqxPlcj/m/cTfrwEMSzglYkNqYxHccCmgvPEq/BMcIQqefZhAAizEPAcBaFKih9sj4n3UEqlDdHgVgO55XAnN9onhvuFebQ9htPpdueMOAjxkS1npBbNSINme6tAMoZiz0k5aVkcVAuIqX318BX1NlNHcYMkAOucjILmUN8QcWRFM/n8URjg0b+fulYS+UjZ9GYCdf3FvmxR+eTWu+8NlHkTFDYnzyx27YFBbETg54Vgv1l5xChWKEPDnhN/51iM3yyU/AsTLonFj+eiU6zac3azflsdnJsz3hrblm82z1pWIjQkssbEawcKakkuDuL+iRjD9AxXErAb64kaEoz43/t4WmtScRYLZ8Yw3i4IlJePUWuDDeIDnxLLTpfgNj9UgBiBVcljshwkA95PwtXOBjecv3IVkXHLevy4yhMAcwWshBotohhl8wdQzqIciW6dr3NYCiLwT4johyc9ybkcpSgvTlxu2zMLcFeDHaLN/i427D2IVbNuRBJaJof5UqHv5aLBeGk8Br3V1Elhr4PynIqfZUFQrx9y5R1JJIkftn+ofDdfgvOq+xiQ1jmF+DL85txrdVAfx15DXK68IMvIEQK4fsmhcYzTwzydmoUN4GPbS2p+ldalcxDvk6qgNRNZ4wFB/NcNk6zoaitinYTyw/EV5vkkGAyAppujNDqls70pbCdaKW5nkSrqbaha6Ms4z4u+D4xigSzG8nyuCk/U4/juhl7e/v6C7TWJvsjkpnHs9jwp4qeLvjMOKX9zGsxDNpl8VNUyOpGAXiwIWhGMiyg4PrWh2+OgB7088HW0MkkpH6ohFQhBYr805vEYvVDFpMunk9H2UIXppodFQPE+nft32MhPuAgD5EVRoHIB7H7ZL2eluPQSR1YVnzL4TFaceq2oM355E5HxMmdo66YtU7FcTaKfjoisc54qsb5WKxsQYgbir0mnBRewTCLGibgC4O/XgovO2d2D4tjPERu/o1Wo9ZowyI+bTXOms2zRqfeOO7+m1Yx31a5u98RJ1j/Q5YMVMSsg5g1T8463bPmcf30RGHGMTgC8Rp60lkswz38u7il2jAVYxDDKawiusHwfPcCcnubxldlEma1bdvutFtN+6TTPp03+Mw+apw2j1sWn9tHsybOJ5J8Ic75gyx1F/bbUXbaKF3aEufCBvCq9JLMOUGy3ckiMYHF9lFb3h+9vLkakCG7vf7levT6umg6JmrFdtRiQkXxmEZqfFpI9IYNrEdF3gfPv88FUOlAWUejt8n8vB+idnairA7yOcFcqXS3y/SEDLLmvvJ+WDxCiZnhYFwaduM4NjMnc8tuNbqnrf2TddeZ3MYjAw7gX/9BiFqcnqX8Xo0SuSV55OfkjR8ZPbPzAlDN1h6VM5+klMmb06g+JZP8lTLFZQHrHtHyV4uOhWefa137CgYWpRHfYmFWpXc4ZuGCn5K4SHxcO8FGmg3sbLPWbNVanWmjcUb/1RuNxr9NGt2k0Z+TRi9sVEYZ2mKx8lW+3WmDdANBzqYUnT3co79pnrbmA0wl0VQSTSXRmEBTSTSVRFNJNJVEU0k0lURTSTSVRFNJNJVEU0n8RgiYSqKpJJpKoqkkmkqiqSR+35XEvIo9ztLz+E6IfDY6q0T1bTK/UaJp4H/TVuvsqHXWOak3G+2Caj0fl5zy7I1RqwSjUvr1cqVXDGT98hLsV0/F66OaOyuxp43u3G50T9vPz8EXhuopHcZD4nE5Vn6l2mthLHyg7r6grKDcsCOoNTYeJQ0p1ElvIBHIGB48bAiF/ENrsCbnbnLuz8i578qO7c6GkRbl02C4oOj7dHbW8L+kZn+PPs2Wen29aHu3FOxze1x2J09w9LiiumEAyouq2u7smRAxW2jMFhqzhcasZWYtM1tozBYas4XGmEBjAs0WGrOFxmyhMVtozBYas4XGbKExW2jMFhqzhcZsoTFbaMwWGrOFxmyhMVtozBYas4XGbKHZuYXmqWn/bKV3d+J/V5nXpPtNut+k+02636T7TbrfpPtNut+k+02636T7TbrfpPtNut+k+02636T7TbrfpPtNut+k+026P6xsaUJJ5jzw7PcZyQYpS/bIJxufl3nOfCYv9jukHqPEQHW7Ld5ptOcdMFAtftppNwT8OeNP+ERe9siR63h4riweeYdtips9PeGQTG2PrwAWEuxH3S4/OrJpKUg+q/2kc0TZmDn39dM4ytugw08yRlEHJPSh+pkAw5UisBloZqSnn+083JCcPRO+0zyugJKTJ9eub2w/lVyvy4mU1c+yyN4T93sH9Ds5goMhT7z0a7VopkvymfHwtrCcjWTPIwSNWxPUNSjsnVCHKjFpsolM1mslx5Mcs8Gr0S+D/Pcy07elAnAeo6gYkhTJnuZH9HXPNCrZQDVBh5LleFIMwiX8JK8nhC1zVRv8JrhOaRZsnjKKQwT6WVnUdtn3c/uug2H3gL78W2NjAU6dhyo012SkY6ps5ttk4R0PQk9Vunjql3W32FdbhBBn9317D5N34Xiitgi4gxiqjxVb0JGhADj0Od0VRroKZBJdYru8mwqUqDfZ37gN81Xz6+vJIBkDbn0AWPtYx1vPgf4s7pIrPxaHFV3BZ8eN01Z7ftzmvHXSbnY7s9M5WMXGaef0lJw0PDu/2CPlcik8ETgWhmzAkf/i15wFR0NP2QYcfP+cCcHYMxOu2ibT1PiyUHwMD0DD/9a/Ye0u+IHeIqLnfLFBBK92OymkDVTAC4BHgbNwSq1ArMPng4teHBzpiAxhlQU72lvxyWFaQuwSphNAb1UKPA8r7DqraqhVmBD3ZLaho37JB4mGTcfe0EOPXtIjC5rNA3+VUyXSm48h+9mpi/oBrEboMWOmiGHZ1Y7LLlVU43VYu9KUrLKl4LYIXtRZz7YdnCR3VflIQn8qWnLbRtVVAOYRxmcULmHaxfNDx9oI11JSFmyYtiVXWaagcgDmu+UEXLoIkKNpZrUwkRaNouYP4KwoV9+wfynRiKQPXojeJrR0H4CMAZZP2AzmhlUnbY6QXRIMjxe3SyxW1kSSuXupkIEAVe0e4ZHcQ+9uXDA/NZpa8uJOaOUju6ysEXEjZpO2SLrUTp11q4RdseIz8Kdc2+iu0V2ju3vq7ubLsZBr0MX4Lbk+zaLrc+vxCOgb0OJZcH0Ckh4P/EvdSEcQxMgD9Da1i/SP11NQ7A8QUzjxUf6v6R+ppbyAfC/hh3o+Q/cjYVaOF4gg0VHNYA6WSNhnhHeKsXISiVRHxdEu/GDmgIB6JS4ieagPfsQ4kCyIPA8x4fKA2b6Q3k+hCro23Fbh2bW173ih8SSNJ2lWI7Ma/XlWI+NJGt01uvtj6u6jnmSCFWmL9pPiHL8qrqr3VJZh0AD3uVB/lqhcsnMj660gMJb4WJW851CZtZqz5rxribbN2/bx0em8ZR23eKfb7DZn7Va3kl3r36R6nChZXqcy/FZ8VPs/RXAnsGoDwiVD37fz6T8gbyDmaNYo5Rr7zUBzIOm71HdsF33Haz+EuQFg8B2DLenF2/EVwsdLJilPHO8PQjc73pKKG4jQpUQZBko7MjSuo3EdzfJjlp8/zfJjXEeju0Z3f0zdfZLr2N7lOraf4Dq2GbpYc3Sx/kjX0Qa/A12zOTAF5qA3lW4etIjVPuTBQoSJo5fzIlunRS9y6vvsJZ5P1M6SzGUivZRcaN6g7QrbBnFbB+9BXoCJ9PBsh+Ory4GdlUCfFA/gus7KIT3GCQHc4KHWm4cwK6Uzsbwlozie5UaAIRkFPGOD495zB4/czNH9AwiUB12Aof6KOU7NrS/KB7MxzvgKZ8wGHy0hUOeT/G+nbJfAEJAP0FxMFK+3bBdQOXPuQRghPq6V+UpcUOOqG1fdLPdmuf9zLPfGVTe6a3T3x9TdJ7jq2hva7qpDg71d9Q7e4c8SX+qCDnF9a4+dVEVjQOLNfIt8dTv1wcmvAFFChMBLRxvCwyX8OMxtp5aHnxz786Eq7dfUNtaaMkMHFRUVKCSjwIXOyzBcy7PDw0/AO+DZ5zpfO/V4q7bn3+MdD4d3RyWWSF0agVIEtsyO1CcsejdDHXrUieKBg0KtLCANoOivj8pVJPCBdhw8Cj++auABohKmwBzgASktYPRY35Tyk6TWdRKowhxhbreB+3nXfF4dPTYPBWTLPMrI9+hY0J4BlhvTQ/TfIbtACOiEJfDrFvDpK9PVi5Dxb95l29ANEwrDQst0+cEiQauA0AibtdjfBA9w2zjtm/n5H6+nL9gCHVQyEJFE31g4GFGAit2AGJEB7MV7SLATrUmBHy3UYbBebpcOKhybu0AU9tabCMHeZE+wjcGUE9mxkyDrgb3e/RxzzxZ3wsVFs55SG4XTsb1DoOIhz/V7oT6ShZGEk552rb/14iseUFWojZ4iBYbszTqeF8/M67lI/CWGVtPqSNDkiw0sFGnfWGrXtwVajyC4K4lazx5cwatl4GHYBU8Q6iYOSAmNR35vlRVz7dl45ODVEF4ej7fea/UFllw3powdk7B4ujYbMmvp+1L8D2MoOqgqbxYRaNqz0aLLOWqkEbVWI4NSTQ1Zc2rgSxJ+V6AYnhImdVyaXBlfZVVIbf9DnAW78B+6ceU/uTnT4zew5GJL27fks3HGAWs4YE3ZCanxVysaChboNs6B7IASgH7Kf7IEGtGMXVSwSi0/gT+kPrh8WIAqQZHrM/XjLDWC+i9GL7B10gbMNLri6ZkT12UaFi5rOWLFSYRNChbxdX1YTTfopvBNSqG4wn5v88UZ99Jcy8hzH762ld5iSb4fu/sHWTxjaf6MlkY7xyhuNOzGZWQo5MqjK2b+JJ1Lg//DW9JU8sLxeo7kQHsWzNrlIco06bS1dATlDNYCb+dzxQHKlb8iPQSXGJUfD+MhoAWdCg8AYQ5RnuPSvWuv8ZINC0iMARnu1QWov/o6MpsAlW+QSew8ZhzDU2qRpy/PiFb47bJd3LUdaUXKCEF85ol4Zj65cUmvWCNRbJAUdQpNgpUczTG5DHFrhok7xgIeSp1ZBkLSWTw6OltJJzIWropVoF3eRd8FGySnthTumi7jALQgwMuM8HI4LUAEYJ4uZ/jB4lB3kofYFoBgOKSE4agOgSBdsOjLEOLXDNyr/KcT1Sk+NtRB1cZ1kUlKXfn5aFrVDhu84Sq+mlOvDYXzstxLj/NaENFyZ+Hlj8vWWU/bfmLkaHz5vnf+cniNvjdewaF/abOgjoBjEI/7yUkMcDEKNWZ1PReUgOToY/50Ll59BQpd6JhMLtn+oy+pSAs8CDEfm+KVETAjhYm6Lot7lmCXdLsQSZ1aAjF2OVxjlo6O7qt4S8W7byp5mNDpjE7vloW8ECAtgZ3Y69MnTO9g/PcZHwOOgQqs0ntlyq5qyTL0Jf+YOewfCAlGSH+mERlc18urjh8nIRhoHtgs84nHGx6ASIFqPcEySw0HXOcYTm2dwNmy4G4j5QeBCROqrKUpkUoFg+X96TCaz6UI1TUPKtMFoqHIAVFzWGe3MqLQXK6FRWfRlbBWadwq5Vc5OG/qlt00XtQU/XHo6BMhnk/I4ZxVMd9XBRMAJAIqrv115Ma3D1f/WZv6IYSPdM1VNc1p6QJo+nnnolDizrx7cmjo4rq0JBgzAb2HqppAld1TmXDh+ZhyQkdk4qBealVWsXGIqDB1qQdaBXWEBGu3RC5sr+7LOsDZkNlRJ7IxJ4oGAtguBY5aJSB/pZlXVZkSsFW3bhIVsPVMXW+psPkxxCG+mOSZ0nDhuOgkxCxUSzKlvuMpUwb2Y1xNVqnmb0sXcAwRScCspvEkv/Uifkrp3+S2orhIMQdQ/j2+psKIJOFDHLA2IM8QQrXq2NXqGauK30B+vKp6hsTWT/UTZeXrxRfJdQwJFE9UY8i5WyLqZSNttsGlP2kl7/OjlwHQr8r7ZW+HTW9a3QZf3/69peXjMqj4I58vhRO1hn/PMigBxU0JnKhn+8kfELOU4Qcsw8XkB1L7gJWzMG5UxrLHGYWT+CJGbZgLsK7kTJa5lmRfsd7IHXU9h/eQXFebLNForHlNCiR0mL/umw3PJRlirLRQIYnMNBUplP0GshODmLoeI17wtUDX1vpr42DuoXO1GvjqB5fqcm/fi6/NgdWNXDMFTsZXrxJMvK2SdgjtsMMZzL9j+mZI44rnUzg72W9D3g2efr8URjJ8XcIWxfn3ITExMEfYd2kZ6olRy89jHf69oI10O+JLoNc21OItFd5DFrMYZYjBPr/Da6rJNyUc1QtVR890Kew0w8kltc3LAQTmn/8f/eREvA== +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 objectnullable
    owner objectnullable
    dataAccess objectnullable
    + +DAS data for the entitlement + +
    policies object[]
    + +List of classification policies that apply to resources the entitlement \ groups has access to + +
  • Array [
  • ]
    • categories object[]
    + +List of classification categories that apply to resources the entitlement \ groups has access to + +
  • Array [
  • ]
    • impactScore object
    account objectnullable
    + +Information about the status of the entitlement + +
    activityInsights object
    + +Insights into account activity + +
    accessProfile object
    owner objectnullable
    + +Owner of the Access Profile + +
    entitlements object[]
    + +A list of entitlements associated with this Access Profile + +
  • Array [
    • owner objectnullable
    dataAccess objectnullable
    + +DAS data for the entitlement + +
    policies object[]
    + +List of classification policies that apply to resources the entitlement \ groups has access to + +
  • Array [
  • ]
    • categories object[]
    + +List of classification categories that apply to resources the entitlement \ groups has access to + +
  • Array [
  • ]
    • impactScore object
    account objectnullable
    + +Information about the status of the entitlement + +
    activityInsights object
    + +Insights into account activity + +
  • ]
    • role objectnullable
    owner objectnullable
    accessProfiles object[]
    + +The list of Access Profiles associated with this Role + +
  • Array [
    • owner objectnullable
    + +Owner of the Access Profile + +
    entitlements object[]
    + +A list of entitlements associated with this Access Profile + +
  • Array [
    • owner objectnullable
    dataAccess objectnullable
    + +DAS data for the entitlement + +
    policies object[]
    + +List of classification policies that apply to resources the entitlement \ groups has access to + +
  • Array [
  • ]
    • categories object[]
    + +List of classification categories that apply to resources the entitlement \ groups has access to + +
  • Array [
  • ]
    • impactScore object
    account objectnullable
    + +Information about the status of the entitlement + +
    activityInsights object
    + +Insights into account activity + +
  • ]
  • ]
    • entitlements object[]
    + +The list of entitlements associated with this Role + +
  • Array [
    • owner objectnullable
    dataAccess objectnullable
    + +DAS data for the entitlement + +
    policies object[]
    + +List of classification policies that apply to resources the entitlement \ groups has access to + +
  • Array [
  • ]
    • categories object[]
    + +List of classification categories that apply to resources the entitlement \ groups has access to + +
  • Array [
  • ]
    • impactScore object
    account objectnullable
    + +Information about the status of the entitlement + +
    activityInsights object
    + +Insights into account activity + +
  • ]
    • identitySummary object
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/list-identity-certifications.api.mdx b/docs/api/v3/list-identity-certifications.api.mdx new file mode 100644 index 000000000..6817b24b9 --- /dev/null +++ b/docs/api/v3/list-identity-certifications.api.mdx @@ -0,0 +1,83 @@ +--- +id: list-identity-certifications +sidebar_label: Identity Campaign Certifications by IDs +hide_title: true +hide_table_of_contents: true +api: eJztXOt3GjcW/1d06IcmHIMNtuPHOXu6FJOUrmNnMW62dXwaMSNAzSDR0YwdNsf/+957pXkyYJKm3ablQ1Ojka6u7ku/q9eHmp6LkEdSq75fO60F0kR9X6hIRouuCCM5lh59NbWdWsQnpnZ6Uyt9uN2p+cJ4oZzjbyAynErDOq/6LBRRHCrDOEO6TI+ZdLSZx2dzLieKeQViLJryiBn4YcYL+CHYRN4JxX6NRbhgcx7ymYhEaJqsoxaMx1AD6EFj4bNIv4OaHsf/ggAaWy522CiGvlWwKPe10DHjoSAyOpT/JRrA9J0U9+xeAo2RcGMQfpOlw/K1MExp4DOez3UYQR3gz0SGjXVY7oQbA8O0pF/oOxEqrjzBXoQ6npsmSDUbFMj2Q02iBGm48E3BF/hpWRJhIxEffDLeVMx47fRDLVrMsZKJQqkmtYedmngPwg2wDFovK0ew/hnqIqGaKqXJ6jNRZ1L5JFFD8vfiMITPLDYiRHZxrDIUYCxjHhjxsFPNciBnMlrq/CV/z1Q8G0GnxICJA5AaCR2l3HyjroRgNz/sk5yvIq58Hvqsq4NAeEiDvUqldftkGkVzc7q764s7EaAdNw2XwVxLFTU9PduVvtrlc7lrHJ2Gl9JpZFJ/SlqbaTAEqeDPGSmuYqg5wbYP9yo0AP2KiQihpSVji/bbUDCTSs7iWe0U2s34e/s3UfHFmIMU6NfDKmnq8diIZXFeUjGwDRJEXY1jsFkrVQYfmuzaxOAKC2bmwgObBCu8l9GU1Uk7dRT8nE+kAmVDe7DIyZToOMV8Mer4DcpIxb9a+J6O1bLs+2NWj8IY/SWywWKu53FgRSlY/T+NoY540Ohi6zqKdA7hQLCp4D6YP+kBK1a4A4bAex0Hfj7+MDlO9QbyY3VrE3UGHgyimiiQmA8aA51JDDAuJkFIgPAbISuMBkIBcsrvIOwx0BEJB+tLiMdetIOjgTAXCtDYTCgfOsZIB5ZiBPZaJyL/oJHXkSfi9o4HsbBSwNrANoQLx80XYUE4ngojGmkdCK5qOTuxUW+VrYxlQJG8oq+NArb0mfiVvamJ8f7x+ORg/+BInBwcPmuPDkej44P2AT98tn9y5B+/qS0Z5HPqOrWi2KDq0cISaTGzUBEEYNtshCal/mDVfGXlA5w1HJ9P0UaeJ6Voem5SBfZQjRTWgJS+x88QwgLfkP1b3KJDc4oU6nXp1+unrC5+BRNWdVuWgIxm1cf5lBvhipP6GtUAXae1lajXVunaIJcfp+tcMEL/4g0jUDjQY9EMsIcdP16eva8s3PgzqxjFUlbwlS3bTL0g+joJgIEEdpiFT3XQwy1K2oZRg7Jt7+3h/4oSOt8QaYJoPQ1zBIR2oMHn88B92f3FIKEPy0rkYchR/zISM5Mr16NfQAwI5UIUWyQte9LHfzOltr2T1vHe8f6h3xaHrWfHe61Df789Pj7Z83jr8LiFCLtkLcWhQXDQYwvK8kNB07Emme/tSschhPXLewVBoeN5whg2sNAWBd+DanohAOTdGKp5+2j32MdKBhIpV4klc48bFIrj1nWXNR3an/lOUUcAP3FW9cF8oxjVNkPzA89fdGmKigaWPP6JuUiVEtYPDCFxrCS4t0PGNMIkdtTyjvlYXM7r4vFOCxKt7K+bGO8FEn1IVLRMXCgENJCbdV6+6vRfXFRlZYBMoBV2aFVj527wyZFA7wvFGKAEYAG/xENC8qGkqzVsvOxcdF70BlBydXk96PZ+vnx9YX/2OoPud+u5Wy2OhOxDqfkmws6VlDtBsMxGNt/kPsBDdj/VzAsF5ZUyQiYUYGs+yrBCxlRnHWkSWtmGl4IW8leutSQJdok5bF6e6TdDqA5g17XKyGCOXCgoem02esqNATQGMXBVbOGiKDgTewLU0qAKRhMX6o0ROMKMCviPcY9AIoxAwVSdpNcwKEjlmY02T5t5m70cDHrnnWHvDAqvL3I/bwt2mJU/rI8Cj9rDGU5VoGcY1v1UgJQhbbdkDK0IJBGLQqUPuZOhXN6PCaQUxWjTaNNkP+qY1OAaZxSRCK5IpIR2sJF+Jxok+VwxVAT5pQVN9i1+JuS5U+QQYXY1l3nJds7Pfz7rdftX/cuLKygf9H64/BcYz8X5j4Xyi8vcz4LQC18eMADJqBCZBknUsJbuANQKDJ3XwXeUg+TFAgYsFJtBfvRNrYTNgXZmit2KXrJ0ryLMpilWzpxRZuDlsxILlBmlfBDS5FaX1GUhHB0u5ZYFNin/25BFm6BVMgrRCMNAYdFth4005I8JV8QmOHAVk629Ki5dbCsBlL3WcWPvWaN9OGzvnbbbp+3jZmvv4Kc8bAWfE41IZvP3Sh9Lwie2IIfVPi1B/J59Jn2knaaKfQna/GhzAVQY6juxa711l3vvlL4PhD8ROYuhSbRoNgUFtCsVkLb/LVayCX8FXg6qeYkr5/JK+VfMqwCbsEYlNCxO36Ts1l6jdTJs7Z8enJzuHzX3jw9/QiYszN+Yj/J0XMFXshSTrnO6hVg9HuPMtORUm/OaUNw0B3gcnGTQPqH9R+HO6v4GicwS3AmZkAw2o05Vi+Qp90tWmQsdJd3/MxKG0sxNQG7/rHcx7A9/fBxGPtZ9SqkYE1eDvc8brwj35eLkOrZLIfSPZLEQVtfymAMIiQlZh7HbICV0ljpNeTBFJxqHYBa/g6utiVS/Y563utNCNNo84+sNhv3n/W5nCBithJgLn7aBaxu4toHrYwJXPt3J+2Y559ks6bRJPlVm8J/AzA2yzwokwu45bsEkW8clA093lCmvpHq4BlcYQS7cQjnk5b0w1GHFyoPd7B9TolERoCilh5xWYPNM5FlOlzLmdoNrVPOlMIZPxHJ3ZxUrJYX+ko7KVrLkUalAhut5BpZopX9D/bjdbmqytALzRtXZ26th50Xv7O0pG+ZXkKQBpUla5I40rsRwL5J3tAxDrTrdYf+HXkUrqicc6f6Li5R0CltxOMvQNaGxY5M/WsfzAO+DTaNhpbngG5WLP5Z3KLDs4HocdVmcNtKPlcb/iqSZN7fKAyNnkYZKD1jvoGqdvhtIFDTZJWuwQW6b0zopbV9CnuvTapNUdzyQtDL5scv2K2Y4X0QQ7rva38A0nkslGpOQS+SQ7AoE7AuG6Zf0Uem03WhJJmZD9YpRGyTRbLFvuc8GbnxdNxgUZwgJHNDqbzD1Xtvl6qQJTsPJdkpFt+JI8NGzvZP2wfjZAeft44PW0eHoZMz39/dODk9OKERbl83vayT7HcWuXwglQumxQHugETw0YyMQMZC474ZbJERjQ9e0ddNhOn5ZJN5H4APs2+4rdnDEAq4mMZXzSUkIqnF9tRRZYOSW8GUoJ7JyKTlxnrPe8871+ZCW0f593buCv5DW0lSO66T2CI2mLH2q74ljNwCM7Ubgxhku0dYd1ToMiCuTryjtL7MwIMxkGRBauN4rWuRJM0TNBVciv3kfsSeyKZo7EKOgDCZVb8pG4NF+EljquFk0jxrnTpJ1d2ThaZN1fF/iIHlgd/wNtF9QsPN9u9doT6GAKws64aDjCFcqpVdcEsmJcinOu5hynlcKOgdw/riddLwoBuZomHkvTK3FsZgccfKd5JpLM0oiNBIpbqp6eMwMz9LQqrcX0akyGRnmwhHtbULgUUm9NGLlQ2UvNzvaCIl7KrHZwO9eBRB+GjS09MOdcM5Hh6hsNCJtJGpyEcmdD6LGrlaqrsTx7e7r1ne3vrv13Q19t/xx4E4nJNgHoU9rGfpcq9yJ0yXoE5L14Daaq+RALSmStogcRPr+9dCdeYX64v0ct4I+Iz6yU/kS851UH+6QSXIGJZn6M10ggyRHO4IxRCLhnxLfGccWJJKo9pd7e67DkQQDVRUQEU+kpmd4w1gpOutmduh8rvraLcpze/SBIiD2qvyGPdKyRZJbJLmdjbaz0V9mNtoiya3vbn33y/TdtUgy5Yq8xeEkE89mPFxYS3Pf6UwAgwrZdYPU5UhVZbSCxFiKsWpF5FAbtVuj1vjIEwc+P/Cf7Z+M296zNj88ah21Rgfto1p+rr/J/Dh1sqJP5fRt9UgiBhB3BzguVmBcJtLaLy7/xXjMaYxhDUNPipvpUN7DbYod2ycVh+q0Zi+5WiQIyRQwpMpkhDEN6s6wbnqVCypwd/kMQpXUdp9LzgRQwRPbjO5i2HthAumGi0ZnjCfw3Q0PZ2RpL+kBO4wEgbYLxbhmDK4zRswHFAjBTiA6f0Z0Olu1Fv8RSJ4NcMTnOGLWe+8JgY6eIvfDqvXdPu5wYIy4sgpesdBrsx2uwAAgIbAxK8WdW3y+xefbOX47x/815vgtPt/67tZ3v0zf/Qh87tDQanwOFTbG51C3ucdSLPWc7qD+0TCdXMVxQObNtEcHJfwMgxOuAFNChiZ0VX3Ooyn82F26dmcRv+UlDgOok9w8/AAqAtU8NPlcNpPDOUrf0/XDu/2KgIMnA6xzQcjyY3upES872k6aJNhQou3aQEcdWDG7C7219JbjWvrJ0bOFjiG0EZkdPLHl7IiK8dAFJBFfG6rdJLtZGiOM7ToMHh4bj7u0uWIclsiKcVSJb21fUJ8Bl6XhIfu3qC7QNb45gfq6Bn66NkJ1YtTvzW2+zhUicsvhUs1slsEsrr3E0CVWa7NvBQ8hXbAbG0++fz18yiaIQykO2BuvQmLiAJ70CsyI4lwnWeTHRjT1ZI8ZdArbKOhXbByAUJi7m56cXrmACWAAEZvE3sleFoFWm9+N5YV2K26iv1ENdiZDe3XW3kRxQ7S39W/mybh4blyfysRXCbWGpdYgangvt8CFFe2NZ4/leODcSIIHhqT1yZ1beo0cPcyuoASplnlASTg+iptfXqK1T+ajQK+B9Ip8vFGvpxIm2WIzZmMaM1N6jqHPvKnWRnzDGJoOusrNJAZP+2S27rHTBnlEo72XY6lhu2zIBkBG4u8cHENZY+IjnLIJsWgAc8q3bvuWNAtx4S2dCXtbGDMV38DMijV97X3Ehe8Sz9hhAzts2DhhHP924kLDAt/GMVAcsAbQzfRPkcAxmouLllZl5Cfyu9QGpw8PWCUqZn5qf5xmQdD9xegD1k7rQJhGxJ1uB+K9L0cLZ6+CsJK1grIEl/kNNEyaJblZftO1KpxI/2zjxRF3siUVvFn6uaP0ikjy54m7/6eIt400f8VI4zAwmht1Wzoai0ZuEd3yAp+ha2rwL3wlTyWwDalM9khQnsw84BHaNPm0N5WClgbmgkeIDnfQrvSM/BAgMTo/XnJGQhM6rx8CwxySORnQi1+vIfdSHogY8y48TAFUf9EuAbsCKb9CJbGzRHEMr1vHCu+AAxPxjOHlx0e060vjxTYIQRqmRDIyTTAubZV4JJoNiqJJGUg4M5djXEOG9DSnxEf6Ah0mL3yAIOnagX20JRvIAK+uu5SkCNEfow2W05iKYI6ZH0RQAFMi18PL/nCJIhBT9uJ7U4eTXdfI7GJdIILpkDWG/Sbke3RmXZsI0tQc3cQGWPomRPEdPnzAoH9myvb1IVtF3z7M91EP87mJEDOY3TkuyaFeYpt12eT2plZKbiEVmoLi8MuHD7heg5neAxbbt4MwhQIrQkfNHgtao67f9lRf5QDeCVyTqHpR0K1A1OjBo825/LLe9Fsjk+TJwk+Uw9/rMb41ckwfK/xEQW5f1vvyXtZbYw7J84mfaA3bZ+1+p2ft1iote8fwE9X2d36obq1ks1cDM8neZqu7tKIKKIJiGeEF28xu9+RaLR2IQCrpEvyLHgDLh/8Bb7tW3A== +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Query Parameters

+ +List of identity campaign certifications + +
Schema
  • Array [
    • campaign object
    reviewer object
    reassignment objectnullable
    from object
    reviewer object
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/list-identity-profiles.api.mdx b/docs/api/v3/list-identity-profiles.api.mdx new file mode 100644 index 000000000..1db803ca4 --- /dev/null +++ b/docs/api/v3/list-identity-profiles.api.mdx @@ -0,0 +1,100 @@ +--- +id: list-identity-profiles +sidebar_label: Identity Profiles List +hide_title: true +hide_table_of_contents: true +api: eJztHGlz2zb2r2C4H9poRNk6fM7s7Di203Unib0+NrvrZLYQCUpoKIAhSDuqx/9933sAKVKkZcfNtE1XH9rIJPDw7gsA7zydiJRnUquT0Nv3Ymmyk1CoTGbzs1RHMhbG63oZnxhv/9orXrHy3YeuFwoTpDJBGADhcioNS0WWp8owzhAg0xFrzGRjbkTItGLZVDCTiEBGEh58ykU6ZwlP+UxkIjW99+qAZfqjUOxWZlN2ev7Dfw+O3py8ZTplB2cnjOfZVKcImhb+lMsUwGSaBTyOATg8xWHwYCKyVRj1gNDFukDunSeRIsII3il4QyyaycxbJvsN/8xUPhuLFGGnwuRxZnBRywqg4kIIdv3PISFzkXEV8jRkhzqORYAw2Fm59Ifvp1mWmP2NjVDciBgl1DNcxomWKusFerYhQ7XBE7lhHBw/KOH4CxJesAh4NNOpYFLBzxnJGcks2OTtRzw2ouuJz3yWxEDeYGuz65lgKmbc27/zsnmCNMO6YiJSmGnB2EfDATyYSSVn+czbh3kz/tn+JiihiDhwgf66v++2c1NHkRFNdp7SY0AbOIj6EeUgS8tVBi967MrkIN55RXFIOzoknQ4yPuETqXgmYH6q88mU4DjBfDPi+BXCKNn/MPMDnasm708i1snSXHSYzICrwPhEJ3lsWSlY51/+pc547B/i7A6yNNHKCDYVPAT1JzngwBZzmHKAqPM4ZGPhLAMkJ6NSbsA/1rE60WG3Alk1UcCxECQGMpMqEGTjwmRSTcCaM0SFESFg8IpN+Y2AxyAjYg6Ol7OEB1kXqSEPARKbCRXCwkpnqClG4KodAvJXoryDOBG2NzzOheUCjga0c1Ng801oENLTokRjrWPBlVfRE5r5oK6AiyS32LJWA7jJUpCOd19Bw5MhE5/Ye09Ew91obzQc7Yi90db2YLw1Hu+OBiO+tT3c2wl333sNhXxFS5dalBsUPUWNgutmrjJwwHbaGFVK/cai+YvlD2DmOzxfoI68Kp6i6pk8SXSaAXooRnJrAErf4mtwYXFoSP9tRNap2UcInY4MO5191hGfukyJLkQx+A/VWXVZDL9j/G0UOMguM7cdOweFVpu1cnSSSoqglRkd7yFFMEjClylCxVOh8XHfCOQccGJZR7q0yLICXMCSf3DxI1eWhX9hnz1N9MB5kDSwHiB2WSGRLgtSgYzqgtmHFOi6TN8qQFOWv6ywvfsPKBLrjA0KYbC5if/UefnapT9yKctDLxJoCC0QEWAST5JYBuRfNn42OPOuKV6ephw1Q2ZiRitCSD6NKHNyI/T4Z+BVTVeurSIBskmK/M6kxVaGTWQv5gZA+xOhBKkLy5UEdWQnR0gCsvG0WGBZ46pa1R8MR1uEBA9PVTy3XvG+UOnlVd/C0y+Az3E8KrITVRPgIb5AxQsxiD4d8mCzv+VvbvmD3cv+aH9zZ7+/85+qMSE4P5NkMQ3aCn1pUQEOKmBfB781XoAYaB1BeQkFwCG4A62OMk3uZpXSFGk+IHwjLnSeBi06VKOz6YWWKxXBKk8K+pfrgl6N9DdzFuQm0zMWQUbEcAAYKw1EFwl+lY+LsAu0koFWUClJa6JCQ1chUQe+TLpdoEmzUJgPQul2dPz28uTy3y0VG8wo1rX4YVJ0O5XB1JZPqYggE8NUirwCVYQLjpSAgVxrw6vZvrDdZyw2CPb6u5u7w62wv9fnu9ugiOFgd7S1NR6NB8MB9ypGvRqNv+eQHfqonchTFkqTxHxO7vdX4PcOEkXJZwz+Rad5j/pe+PJHU/jtUatiFPMpdECKu1JB+5uwYputtOjglynQxenV+eHxV1cfB3atPAD1nB0EKDJ2BF4vgBRwbjWoiNXnIoIAPz0v3eKj6XxDWOA5sLbhZfxHnBAoZilKCCiLegxEKgMqr4H8CSgqltdToWBaMOVqIsq2DekWFF0GKiN4P4MKsKaOzg0Wi1HJ2GoHTbVflI9uNrDL1mRjSNQwBdQPuspGYVwitFvB5iAD8sZ5BlFIRXLyuJs+EpFUgIVtLIkFD3kBCTiQJJjUBQQyt601AyxF8Ydu/lTf2n6UTWuwk+WySozEnAxdcFCa5gIGc9uG7MCSA2FsB6tm1EKhgrbkAMjhMQ8+YulL1a2GGI1wZhoQoqrX2CK4jG8bBW1AiYPbW6QJD2vgsjKUtFymXBkUlVmVUz5RJKCqDppLafCFpJ/ObzaZ2eRXQzXePskfVDPG9mUWVg4ptIzR1ZQIH5WotsvJCG4S4MrDJFbk8IXevblaVvHn5YJLa1WS34DaJiW/vKqAW+XHw5Dg8PishiFX83rtUHYRlmHcf7hfRvwgHUtANp2zj2Lu26ZNwmVKLVhI11LwuGrOoFjjpYUtvHSVorsF+lb2nvBJYlDekrdzT9/MXWAtnlP/3IWYnR2+O9gW27ubffgVbI43hyHv862h9edFBnzZogHV9yfL2lhOqMNpjHMOreLrjj8Hgph1LrAQPS8CUZuEHkk0ufl4TlXuSWvALn1vnkNEb9MwGZb6BbBcYV9Xq8F4d7gbij0/HO+NfT4OIl9sj7b9cBQNdkY8HA2Gu0heStQ8ZKS1tJ0rlXNsIuOM9ohTsWI7rNcqjgd5CWMhFF5C4YO1TYjiaFr0iQqx7KJg5jyt7ZFSUDdnAtI9GOFifSW0FDrbFvC+0AnfY69gmSwHDlULqR61dQ8OIWlRGTtOU0DGZ+eVFq7lGrVm2ViHtB0jFdAnw+f0Fh7wYyFYsIwPdfgEb/YKIoM/SblEDAWhHMBEjGc3MsRIRq1UC7IQPI2rKyNwotdnL3nIzh19h44Y68WDjwCr3RjqCF3Z7kUxBQ2hEGrLsmJH8PH25t5gFG2POIdMtb+zNd6L+HC4ube1t4erzyDq84loC6D1pX/AXEMGLNaQ2MlfgCGQvRoXHGnxVTG3LgOC8cRoYseWZDp8WSY+Z10I2i8Pz9hoh8WQVOb0nE+WmKD8q4u2ytoCPoX8VLbW+kXZcnT86uDq9SU8OT/+x9XxBfxCWI0y5gASBGuZmpJOytEWBNxCimsEpmiYIHcc1A4QBB65OlDavwx1rpgzQ5jhVm+ZUQXNIsjAaqZEdvM5Y9/Lnuh1IffF3g3PIDmsbaB2DgJ0Sv5rx8mO24550WMHZcAt8roZ5BJjiIhhaHuldocNTFnQ7o3OM9zskMFS5rJg5XKEKFzJ66pQ0DgA88f1BIoe9MxEZtUKS21xKDr5AM6Wc3XsLitMI5ZiUxjKKVvIBDrFkoqBJ2UyM8y5I+rNguNRxbjSY1UdP7m7NxYZ6lVhs4/n5gl2dxaD+/GJtPLFjXDGR9mJ9UYkjUJMziO5Aocmu1GluArDt93jte2ubXdtu0+03eWX527PxL2l1KffTH2ulGurYfBspD4paY/SxXGUX2yJZgXZxQrfpUg/vrt0x1mwjP6cYCPnK+ZHNpQ3kD8o5eE2yYo9tCL0L2SBCBIfLQUReCIR7hPeC4xtkkisGjZXe6WhHAMFVS0pInjNlM11zjiwLM2Von1802WhFkZ9l7kd/AD7GdYDUrsh9O2W3DqTXGeS62i0jkZ/mmi0ziTXtru23W/TdldmkiVWZC0uTzL5bMbTudU09x6p5QwGLI5SliZHolrOVhAYK3Msr545eONBf9yPdgIxCvko3B7uRYNge8C3dvo7/fFosONVY/31wo5LI6vbVEXeVo5uSyK9gTwuV6BcJtM6rLf/cjyuFaFbQ9dT5s3A8x5274vccbDXsuGhNXuDvXqXIZlaDqkWPEKfBmNnODYtxkrco5yAX1R4BFRq22mWMwFQaKuNzpnSHifgC3DTuX8Q4elCd3rVKVm5ilRBnIduz67YdrzlEnchI8z5AAJlsBPwzl8xO3Ui+lWZPDtHil8jxQx71ri5y8rMfautv3sCyKfoIy6sgB9o9NpqhytQACgIrM8q8851fr7Oz9cxfh3j/xwxfp2fr213bbvfpu1+QX7usqGH83MY8OT8HMb2NlmZS72infjfOk0nU3EYkHozHQR5Su3mIgcHJhgBD+l0KixyBXn9oVXlA0ja0TJlqPaLQyS+Owm2jycfvQ94iGAmQBORngnd4ks4zvI2lmfgQUdbM1hq8jSGYcXdizsQMgj3vscT2SumKn1LFzBuhi0uC88WmOJwWpjbax143cMu0iPRpBK137pKWsAKyh2M8Mp7HivhF4dC5joH50hgunhGymkiPQY0EyhDvjM0ukea16ARaLtK4/vH6HHXVh6gwwJ5gI429q1cC8YzwHKJPM8eDykU4wLzdbt6Qz0WMQhrvEFjsVMcNmAvBU+hmLDbHt//+O7yBatc6aD7PEJiWQF2dgYqQl7woNgCwEkUmBbXOA9qmyxodSyKgWDmbuUVR1reQng4B39OLMVJglwIznr6zR9em/fAHbz3ynendvG8J41xJNp7itdJQRev0PVcJP5SQPMtNJ+g4a2jGhaWtdeBPbQTgOkjCB4b4tazF7fw/Ao8rL3gCUJdxgE54fCob40FhdSejUcNno/w6ni8V+/o6HV9GrMui5kpXUQ9YcFUayP+xhiqDprB9SQHK3o2WnTe2yeL8AebFZR8u6QvfUgoCb/XYBjKKhMfY0B3J4MjCKLWJH8iyYLN/0R3A3+q0UyPryHu4shQB19wnW0JZ1zQxwV96wOMw9+GNVQsPNkHNJAfsApwuJA/eQKHaMXnWVitXp3Ab9AcDA0BoEpQTLJv/9hfODj3i9ELHF2OARfs0RlUt1mIB7MdrPvFPQjLrKKTsMzBJr6xhpC6xDeLb9nJwjD7R6MXKT5YNFzw0tXX9tIPeJI/jt/9nTze2tP8GT2Ny5BR3WjZpfOyqOQ2W2u2/wx9KwH+D2/JUikVh0Jn8XmEKpgk5hkds0ebDqZSUOMgETzDzK+LeqVnZIfupgeUhwRoQldOU0CYQ6knY4DXY++gMlMBsBirMjxqAVB/1q48uwAun6GQ2FEhOIa3MHPlrpjlM8ZBPR6RbihNkFsnBEWaEgVlmtK4clZhkag2yAo6qyzSmTmNsMMs8QC698S1QIbGtZeBkSgRdyN9Qci5iO2FGxhXT78fgw2a409FnGBdCB4UkilRWeHNyWUDIgBT9uR/T6eTDTfJbOBYAIKljlWGYQ+qQXyUaJNBEVuB2/wqDl7PXlanu0VL/Rv/vI6LQ1hAbCTYL0O25LagsaXjtdcsHaEYmQLr8OXdHdKFddQ9PrafJsCCEuTobjq13XurcvDb+lJPK8c+CuxQFB8icj0Ij27KPJ0P/1+f2FnBx/ITRM9k5Pp7Od/e93JWqEPxUaRnasP6YzW/x8dqVkp08emiZ8p0/f2Zp3x/ZqUMFl8NWsjgw6K5CTEcL3Val0gB3U6z+yWVWY0TBbUm9A/HmKfxB6pe9wOXur//Hynzbtc= +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Query Parameters

+ +List of identityProfiles. + +
Schema
  • Array [
    • owner objectnullable
    + +The owner of the Identity Profile. + +
    authoritativeSource objectrequired
    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[]
  • Array [
    • transformDefinition object
    + +The seaspray transformation definition. + +
    attributes object
    + +Arbitrary key-value pairs to store any metadata for the object + +
  • ]
    • identityExceptionReportReference objectnullable
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/list-lifecycle-states.api.mdx b/docs/api/v3/list-lifecycle-states.api.mdx new file mode 100644 index 000000000..4376c17ed --- /dev/null +++ b/docs/api/v3/list-lifecycle-states.api.mdx @@ -0,0 +1,88 @@ +--- +id: list-lifecycle-states +sidebar_label: Lists LifecycleStates +hide_title: true +hide_table_of_contents: true +api: eJztXHtz2zYS/yoY9o8mGlO2ZPmlmZs7xXY67jixz4/LzTmZK0SCEhoKYAnSierxd7/dBUiRIuU4bqZXt5rppDIJLva9vwUB3nk6ESnPpFYnoTf0YmmyUxmJYB7E4jLjmTDehpfxifGGN155h7lbHza8UJgglQlSgOevptIwoUI/0VJlDMkZxuOYZVPBlggzbowOJPwM2SeZTdlJKFQms/l5qiMZC9N9r0Ys0x+FsvdH5ycbTKfs7OKH/46O3py8ZTzPpjqFRxhMm4pfcpkCsUyzwM4JV+GhLohgRJDjQBDjzrs2Ij3UKhOfsxFQQNFkqIbSze8nlgE/Lhj2DXI8TAUPvQ/3IHXCUz4TmUgNEZQoe8KB1Ian4Ab81SAmQ6+pLbEsNKNhhSjeMEtzAdwHUzHj3vDOy+YJUjdZKtXEu9/wxGc+S2K8JqLt/ehgsD3YEweDnd3+eGc83h/0B3xnd/tgL9yH0Y7TX3KRzhesxnImswZzb/hnpvLZWKRMR6Bck8dgS9BtKrI8VWCcSyHYzb+2UcXoECrkacgOdRyLAGmw81JJH15Msywxw83NUNyKGH2ua7iMyUu6gZ5tgv43eSI3jaPjByUdf6HslywC+890CnpS8HNGntutaSzisREVvfR3tloUCPOKiUjhSUvGXtruw4WZVHKWz7whPDfjn+1vohKKiIMW6K/7VdrUUWREU51ndBnYBg1iMEQ5eKjVKoMbXXZtcnDaOTOJCGQki6DokHU6qPiET6QCP4TnU51PpkTHGebZmOM3GKNU/2rlBzpXTd2fRKyDgdRhMgOtguITneSxVaVgnX/7VzrjsX+IT3dQpYlWRrApxDu4P9kBB7aEw5QDRZ3HIRsLFxlgORmVdgP9sY71iQ77JFBVEwUaC8FiYDOpAkGZS5gMIppxMDSwwkgQSGOKTfmtgMtgI1IOjpezhAfZBkpDeQ8sNoOkCxMrnaGnGIGzdojI30jyDvJE3N7yOBdWCzga2M5Nwc2z8KAVKXGsdSy48ip+Qk+u9BWjU0rgLXOtyrcVB0Wdc98IlAUqWD0VB1Ap4OLGTIcUyg2PvIS5SyfKDVoeHaxQFjNzlUH+tQ+N0aPU72yZ71A9wJfvuHxJDmKvodeZPElQgSFZkDIakNGf8DaIHIdmiB7oFMEKTXQ6HtbPIsQM6ri/tYX/q2voFKADRlodNDA9/hlYRaMFWMAh2OFJniSxDMh1Nn82+Phd04Q8TTlaX2ZiRtNCtj2LqHy7EZZ2zR9urLNgxU9RlZm0LEOVbnB8OTdA2p8IJcglWK4kuBw7OUI5UENnxQTLXrXwHBn2+tuDHWKCh2cqnluHvy/cdnnWt3D1K+hzHI/O6izTJHiIN9CnQtL3oyn3t3o7/taO39+/6g2GW3vD3t5/qgGD5PxMwuwtspWB0vQDDn5gbwe/N1/AGEAzovKKG3EIIa/VUaYJST3kNJkIpgr4jd+2eo9QfBxbYRvJaynN1ZXxbipAahtuJThlBE4ZAW+iixg5lIZ+d9HWdXZastpCW1fFUEZj2xBrSY2hR1L4L/HSZdQHwH94E6t7qmA41Blip0byIWYW/Ub1kWWeTpcUUblL0xVInKr741BHycKgv+wUy7O/LTGBmwdsbAstFe4WSxFTkJtk/FZnpVufLeujdKyWDksaKtqk3lQkkE1xasi8RBbAg4rkJLd9HQ3iy0x4yz6pkJf5G674hLqar3VNwFh0GSVWJPbM0kJmiThCWhe2y74bTLmaWMVYPkZxPAoB+/1mRorekxM1xgFofDUzlxaRB9g2fhPN5EioAvShuL+3HjEKQzCmweL33gNsBgW1wfMD/C7TaCl/JauYpUz2D/wHYQHmUPjZX1z4UKmVjbazvVijYM4HueUCungGCnjfpkqQUBMFdJG6ikyhpEcLX8nVxytiC4bwgDDxiNCOeQgdPByFtu5QaFkzzjH6HFlE4ACrHWJHvsEPK+aOnbaMztNAmO+Z46rbCEoeFElhkRSP345enR63lLw6h0cOOhoE/paOBf3AWUudQM9Q2GfdLCY4OrmkXx9AcZbXk/AxOlt4iUVAJ/a+jY2K//WDg97+1v5gd3crGuyEu1u93d3eXsj5Qb+3tbM/ANIPDwHc2FiBKl3Rgi/LN2Awg0Wp+NuwWW4qGdqKzCJAPjk4HOglgu6Q0YKMfaLLsDl67206AuC70GPZVS7yAjuPo2DqDjmqeh3dAYtDcLg1n+enVct+sbSF2rUlD6N1eVWvvQLeYxdQ6KeO8fEm6mjQ1hYcxhJKHTtOU1C6zy4qHbddDaFOmo11SGuCUkG7K8PuE/qFMvLrIRmKDLLLoQ5bgVSd2ddSCX+ScokcCmI5gAcZULyVIWYM6nwtyaIc0bhuDQeBJro99oqHIK+V79AJg06W8uAj0DoJv8zQtTVf8QhAlrJ7a5lW7Ak+3t066A+i3QHn/f1Bb29nfBDx7e2tg52DA5x9Bn4AVb7NgetT/4BtkQxYrAE5yl9BIYCrjIMnNPlD2bduA6LxCP1jwNuxpZiOX4ZrvxuQlV8dnrPBHouhiuR0nU+WlKD860tcNMjjGDNl2bJYwmepnMh2GOvS6dHx69H16RVcuTj+5/XxJfxCWo0QG0EZVCG6pSY4OYXSny0E+MQBMQjs0wHUs46j2gGBOFacxUBp/zLUjTK3FgJPuNlbnqiSZlGqZ7VQCuxCOXshu6K7AeUD+zGeBVM25sYWN1pEgyQnksw/dZrsuNWzl10GgESikNAC0OITZF8+xzoEGMGiH7sgSrkXc4bOMyr6kHZrtliosm6NSiapGoU6n8/Zl/0EEnMOzJGY1SgsvcWx6OyDJZzmqXN3VVEaqRTXcCDlB7SsG+g0RcgwBtlkZphLR7SUAolHFePKjFVDNMjNG8sM9Z/YwPPcPCLuzmNIPz6JVt64FS74CKrYbETWKMzkMpJbqqaH3ajSXEXg28WedeyuY3cdu4+M3eWbF24x1N0l6NNrQp9r5V53YvFsQJ9U2Ea7eCf6q23+rSHptamDSD++u3IvVXHF6HOCa1bfEB/ZUt5gflTaw61pF0veRelf2AIZJD265QvIRCIcEt8Lji1IJFVtN2d7rdOxBAdVLRCRetS5zgmsprlS9NrFbLBQC6O+d12BRbg2A1Zfaa+R5BpJrqvRuhr9earRGkmuY3cdu88zdh9EkiVXFC0OJ5l8NuPp3Hqau4/ScgYDFjtfypAjUy2jFSTGSozl1ZGDN+73xr1oLxCDkA/C3e2DqB/s9vnOXm+vNx7097xqrb9ZxHEZZPWYqtjb2pFUDCDuFnBcrsC5TKZ1WF/+y3F3RYRpDVNPiZtB56DSDyV27B80seOV1uwNV/MCIZkahlQLHWFOg7EzHJsWYyUu9U8gLypc/5favmWSMwFUcFcAo21BGLwoBdBN5/4oykAUt9nIOVk5i1RBnAOHlAlijahZg2NJ3LkTIeYDCoRgJ5CdvyE6dSb6TUieXaDEpygxO/4cCIGBXiL3nbb13ZPiZfGlNfCKhV7b7XAFDgANgc1ZJe5c4/M1Pl/X+HWN/3PU+DU+X8fuOnafZ+x+BT53aGg1PocBj8bnMLa7xUos9Zq2Q//eMJ1CxXFA7s10EOQpLTcXGJxwBbgSMjShUxN0imbobS6fnzGbdy1Hau43l87o4M5g2xtYrvM0BmrFlug7MCYY8b7LE9ktyCn9ifZF326v3GyHbgWThrndR4O7sO0kXTJBKtHLbUqkCaxB3C50r9x+/SB95TbyznUOSZDIbDCICOdxdBnYTKDd+N7QaNpGsdGQEWS7TuP7L8njdpOvkMMSWSFHm/oenAvGM+BySTy3C6Q4mnWJuNzO3jigtag12Mv1m/uxcFifvRI8xe2x9HrjxY/vrl6yynZs2mYvJO2g5ewcXISy3ahY6seHqAAtTteMai9TMLpYFIPAzB2WKE5vvYUycAF5m1SKDwlKFfjU4zfk89pzK45GvFc+O5KpcFvNcIwT0R4fuUkKuXhFrqcy8V1BzXdbfogaHgaocWFVexPYzTkBhDiS4LEhbT15ckvPr9DDHguuINVlHlATjo/6K7CgsNqT+ajR85FenY/36t1UQqmtP8ZsZmNmSueDTlgw1dqIvzPaSoZhcDPJIYqezNYnnNSniPD7WxWWfDulL30AjsTfKQSGss7Ex1i4CbdogHQqtCH5E1kWYv4nOrL0U01munwD9RVHhjr4ilMmSzzjhD5O6NscYBz/tnyhY0FsowyUB6wDHC7sT5nAMVrJeZZWa1Yn8pv0DJaGAFglKiYZ2j+GiwTnfjG6gaPLMZCCEXeXLwVxW7GjRdv5qsoqVgyWNdjkN9ZQOpf0ZvktV6ywnP7R5EWJR4uFFdwb/62z9IpM8sfJu/+njLfONH/GTOOQMLobTetahqqTW7TWXOYzwm2Xh7sUqQS5oaFZbL6tkklinqFPU0wHUylogSARPEPkt4F+pWcUhwB3A9q/bwlN6LhYCgxzaOlkDPS67B1uJQ9Axdh94ZYKoPqzdm3YJWj5nPZHHxWGY3iCKld4Xh+YyGcMT8l8wbqhNEFukxA0Y0oUkmmCceVTRUSi26AqutSHpDNzFuFKMjSpFSN+YS6wYXHAEBRJh2PsidGFIBci5vYIwcYS/P4SbfAcfyriBPs/yKAApkRlhjcnVw2KQEy5Teg6nWy6h8wmjgUi2OpYZ9juQteHlxJtMmhWK3RP6UMMzS87LB3FKlfO/7gfcnAVBluDzQRXvGhHvG1VbO940/j2Akra/LoDfWmh0T5CQzLVeHLmxru7w7UT7KXu8bI9PoxNZXloojgvvFKNz+sjCq26/ShwNaL4RoRbb/DoCOTj9fDX+vrBA3osvw7xREWuP2Xw/D5l8IA7FN+reKI3/JU/I/CgXhffdlho9sNiiesrs/iLC1eRXtJb+9ZP9rQyU7yvUfMqJwWTbRXpHg/b2WAlJu1Iu2pfodF4r43SlSupPxwjiuArejL3Y3iDa7D/A+hl87A= +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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[]
  • Array [
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/list-non-employee-approvals.api.mdx b/docs/api/v3/list-non-employee-approvals.api.mdx new file mode 100644 index 000000000..f226724e9 --- /dev/null +++ b/docs/api/v3/list-non-employee-approvals.api.mdx @@ -0,0 +1,91 @@ +--- +id: list-non-employee-approvals +sidebar_label: Get List of Non-Employee Approval Requests +hide_title: true +hide_table_of_contents: true +api: eJztXOtz2zYS/1cw7Ie2GlMW9fBDMzc3iuNk3HFsnx/N3TmZBiJBCS0FsAQZR+fx/367C5AiLVl23LTX9PQhDkUCi33jtyDAW0+nIuO51Ooo8oZeIk1+otXhLE30XIhRmmb6I0+Mt+UZERaZzOfe8PrWuzIiO9AqF5/yUZFP4d77u/dbXs4nBq49IOGXNNixjEU4DxPB3nDFJ2ImVO5B40iYMJMpjg0jX06lYRORG8YZcsF0zBSQESUZ7nhhmfi1ECY37XfqcioyeAL/8hvNQstQAW0KIwyLdcZyJCtUlGqp8uE7xVjQZtANW2Rsyg20ECzTwJ3rjgN/kJEaKmGyYSZ49GGLScVupjKcspAbgV3m71TIleUUKZTc2VG5mrs7ImvjoN3aoPpGuVGtICKqerdBzynP+EzkIjOkaYnKgXbZHJ4peAI/q44+DIamCadixr3hrZfPU2xg8kyqiXe3rGTBZAT6BzsSozdTPavzwm5AIzMeiTZrzUQL5I5kyHNhGQYHyKAziYGsYieZCXCcGCQXW574xMFcyEE33A/2OnvdvU6/14nicSfAq4AP9vv9Tn+nA7ytli2RM5l79xl/wz8xVczGqL4YmDVFAp6Sa7jMi0yBji/ARa5/7LHR2RG7yLmKeBaxA50kIkQa7KxS6/vvpnmemuH2diQ+igQDoG24TMhF2qGebYP1t3kqt42j44cVHX9hnu9JgzMN3icVXM4ojNbrpTvorDAXjCsmAi1pydhbvS7cmEklZ8XMG0K/Gf9kr4lKJGIOWqBfdw9pU8exEcvqPKXbwDZoEA0bF0nitMrgQZtdGYiiZM5MKkIZS3DRG5lPWYus00LFp3wiFXgG9M90MZk6LyLDfDXm+A3GqNT/sPJDXahl3R/FrJVnBQYXhJsExac6LRKrSsFa//Qvdc4T/wB7t1ClqVaQdKaQicD9yQ7YcEU4TDlQ1EUSsbFwkQGWk3FlN9Afa1mfaLEbzJ1yokBjEVgMbCZVWGUCyB+QiXNkhZEgDPPdlH+EXMfARqQcbC9nKQ/zLZQGUm0mwGKQ4SMYWOkcPcUIHLVFRP5GkreQJ+IWcl4hrBaw9ZhSpOPmq/AglGeFE401zChceTU/oZ4P+kosE0r5n5HMX1GXyvqFQZOhZ5RSMjNXOSRO222MrqD+YJV+Y+UCznzH5/do21flXXQZU6SpznAatBM2pCMgpW/wMaSeJDLktxao6MwMkUKrVc6ZIEhemFZryFri15ZXn4SaTZj4lb3zzsAbgfI7b9msD9nGIHdrbVPLFej+3DcCdQAyLZvtAqj9yY2GAt832YW99zSDDTHeATpBmy0IqIimkFZrPWRwHTwEkmXWM6jrbqeD/zXVeOwwYgULZS5mBoOVcBwkXugCDxPEL9Bl+2eD/W6XbcizjKO1iQD1SpLTmMCXa6HHP4OSEJtlqNRcWr5ktNYTrq6OXi5l/wYybvAOwMxrIqhA9Pb2xn4gBgO/P+5wn48Hob+3vxsH3U4/GOyH6F0lzlxW0bmIIcVjjnbTPDdGhxKVzI4cCoQh1wtpny6LKRROhNfe69MfD89PRicHhz+9Pj+9OoNHRy8PTy6PLv+FIH8hT3V3aUIkVsBDjJ0WahBVYjWgUKHJ4ibiazZBkRVNQBPAHynKIXMaqFa/lFK+zPUl8g/qWm20VRzh+E2TDIKdvU4wiHrdeG+/E/JgsBc4oNsbRF2gf7eWjcogb2ESP6LcwEOaF08o0zzG13lVMFTKcP0Zpao6r4DZ87Z7unCTMheus+jo7OwcjIq+e374w+HBJV2eHZ68PDp5DVcnp5c/nR+OXqIlD9Dwx8fQYqmgOwRykOdSCGXk1aW5RklXFh1VHBjLXF2OGjelZkdNUWrCnWaRDQQnm8VIS3osCYArRfS4Gi6oxW+caE6qs4gmf9w+ruEiLTWJe0flbaRapsW1OSSCYPVzSbZtjvV2KtRS5ZZwuCgJt5vppBPs+509v9u7DPaGg+5wsN8Odrr/JgFd5v2CnDiS63jod4a9QXt3F3lYHTelnY4gPb6AwpuKxvXpSi16u2ipSfV75fFScHlPXh4GQafTGfi7wWDHD4JBx98LdgN/MO7ud0VPdDp7fdR/Wc9nj/O6Sce/Xzqu0a5YqqkJWS3XNXZ2gp2d8WDc6QRwtRv2uiLuBXxnZ4Ea30JRI/mMXUDlNQVWVvPinPQYEAC2ef9oHGArpNVfBYoOEon55zDLwCo+O6+VgPUAHeuIjCkVELVO+7mg6QH3jEQOgPNAR0+YzV5JJfxJxiVyKIjlEDoylFUiRrelmCWJORVFoHbNKANNtAP2gkfMKZMdOGFQ5RkPfwFaR0/wsysloT8ru4C7VQB3xbBiV/DxTme/2493+px39/rB7mC8H/Ner7M/2N+nHC+M4ZN65FZoszn0a6GgHgpZokOwyH9AIZA/QffEAA1eB6jrbUA0nqB/XAy0bSsxHb8M10G3IKxfHJyx/i5MK2pS0H0+uacE5V9doM8XScLHZUEMklvCp5mcSLUuX708fDW6Or4krPGPq8MLuEJaS2hipMq1SE1rHlN9Qxw7AXDKMQJLGZhzWMtRbYFA3C22uobS/jJzg5DbFefQw42+okedNIuze+ul5aLxd7It2ltsjPdg2ginbAwTFlStdmpsjcJQpLl/7DTZcss537fZKIokCgk5lVZDcP11jishPIps9WdX6CCUBa3+6CLHxRIZiqYtFqpsWmORUo7rRsHgAM4f95NRSEvq5dp4FQ6VtzgWy7XiyGmuyd3lPYBAZS5UniGtM4Y6y0DDbAyySaiLXTqiahMSjyrbVRmrnk4p3b2xzMDUQs9CXpgnxN1ZAunHJ9GqBx+FCz5aYLbZiKxRmsllJFdUUWfXqjJXGfi2Ht7E7iZ2N7H7xNi9//DcLQW5pwR9gmXoc6V4AfrNaPJcgj4ZeY/SrGxE8MYZcgsxrINIP7y9hMD+BSoafG/4KcW1qi+Ij+xUvsT8qLKHW/Yry+Vy6l/YAhkkPVoJYshEIhoS3wuOLUgkVfWWR3uls7EEB1UrICK9oZzrgl6qZoVS9B7AbLFIC6O+zd0bAIgIY2wGtO9XfbvIuEGSGyS5mY02s9FfZjbaIMlN7G5i9+uM3bVIsuKKosXhJFPMZjybW09zz2k1n0GDxVaMKuTIVPfRChJjFcbymsjBG3eDcRDvhqIf8X6009uPu+FOlw92g91g3O/uevW5/noRx1WQNWOqZm9rR1IxgLiPgOMKBc5lcq2j5vJfgS+gY9ojly8gMdgOANzd+wo7dveXseOl1riNb14iJNPAkGqhI8xp0HaGbcsde9iAswnkRYVbSCTwha4kZwKo4OtyRvtUMHhRCqCbzf1RjLsc3O4XWb5pcKNIFSYFcEiZINGImjU4lsStJDFiPqBACHYC2fkLolNnot+E5Nk5SnyMErPDT6EQGOgVch+sWt89AuYzzBEX1sAPLPTaaocrcAAoCGzOqnDnBp9v8Plmjt/M8X+NOX6Dzzexu4ndrzN2PwOfOzT0MD6HBk/G59C23WEVlnpF+3P/aJhOoeI4IPdmOqTzFdECgxOuAFdChia0jT/leNjG265vo/J545QOAkPLU5El0LbcE3oLpgIT3bV5Ktvl7g2lb2hj6MfeisSDOwRskAH9qLDbTXEbqh2kTQrOJPqwTXg0gFW32/TsVftP19LHLRNox7kuIMURmS0G/u78iW4DmykUE98aat0m/1mSEWS7ypK7x+Rx22kfkMMSeUCOVepbOxa0Z8DlPfHcZo/yUNUFom47+tLRqsVMgpVad2mwU2zWZS8Ez6AksC8vvvvh7eX3bIJYk2Ld7jMWEosDiJYzcBHKZaNyIR870fSyOMwxarwqwdhhcQICM7c3v9xGcwJJ/hyyMqkUOwlKBNjr6TuSeaPfAzvx3ymfvZSZ3bBsT1o5Ee1pheu0lIvX5HouE9+U1HxLzSdquBu6wYVV7XVot96EEMBIgk6CgbaePbil59foYQUFd5DqfR5QE46P5guusLTas/lo0PORXpOPd+otHYxrdmM2bzEzpeMoRyycam3E3xlD18EwuJ4UEEXPZotO4/kUEX63U2PJt0P60gdYSPwdQ2Ao60x8jNMyoRINgE1FNiQ/kGUh5j/QSYMPDZnp9jXMntgy0uFnbLO/xzMO6OOAvs0BxvFvJyd0LNx2CDJQHrAOcLCwP2UCx2gt51laK7M6kd+mPjg1hMAqUTHp0P4YLhKcu2L0AFtXbSAFI6quXvnBb+Zo4QzVUFa5HnBfg8v8Jhomxnt6s/xW61E4Wf7Z5EWJR4tlk1OVzL90ln4gk/x58u7/KONtMs1fMdM4nIvuRsO6gqDu5BatLS/i2ZPY8BeeUqQSoIZyZXFIsk4mTXiOPk0xHU6loPI/FTxH5LeFfqVnFIcAdzH4ocgjQhPay54BwxwKNpkAvTZ7C/WVCkHFWFvhhgmg+rN2RdYFaPkMjcReloYDADWbFcodvC5mjIN7PGLdSJqwsEkISi0lSsk0wbiqVxmR6DaoijZVGdnMnMa4TgwlaM2Ij4wFNjRukRgUSTvq7XbmhSDnIiEvw3ZN+P0YbfAcfyqSFKs7yKAApkRthDdHl0sUgZgyIBdU0TqbbLtOZhvbAhEsdawz9NpQ0+GtVJscStEa3dciZ+Vpsca2/eoYSPku476L3S4WyzffJyi/T+CmOWRlO8VFNdR6YeslW55eew+Up1DwTDWeyLj2bm9x5QVrtTu8bU9cYtEKvoLhuDgguMYiX/RjBivl+kXgYsP97y24ZQWPzqM8neGv6yMGa/RRfqPhmXr4//r6wBo9Vl9neKYiN58S+Po+JbDGHcrvRTzTGzbfA1j9PYA1Gl98deGZOv//Psy/RrOLbyYsNPt+sc5KH4wCNECJiOZ9282+gKn1WtqigFSqRfHXhwgZ+QMFuLvAoe7u/gsArD/W +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/list-non-employee-records.api.mdx b/docs/api/v3/list-non-employee-records.api.mdx new file mode 100644 index 000000000..95621937d --- /dev/null +++ b/docs/api/v3/list-non-employee-records.api.mdx @@ -0,0 +1,89 @@ +--- +id: list-non-employee-records +sidebar_label: List Non-Employee Records +hide_title: true +hide_table_of_contents: true +api: eJztXHtz2zYS/yoY9o82GlG2JL+kmZs713Y67jiNz4/LzTmeCURCElISYAAyjs7j7367C5AiJfnZXK/pqTNtFBLY/WHfCwK9DXQmDM+lVsdxMAwSafNftDpKs0TPhDgTkTaxDdqBFVFhZD4Lhle3waUV5kCrXHzJ94t8Cs+u767bQc4nFn4HQCAsKbATORbRLEoEe8MVn4hUqDyAwbGwkZEZcga+F1Np2UTklnGGGJgeMwVkREnGOCQddjEVRjAO/+Y3mkUORcETVlhh2VgbliMtoeJMS5UP3yvGujQNRxg25RZGAEENkPx05PZBxmqohDVDI3j8oc2kYjdTGU1ZxK3AKTP4pRBkDSNPEvwDCdbh2g6y7dXYAiSYzKNIFypnKYnCPJHJEnV4wnM32lHqgIYybngqcmEs6UiiWD8VwszgnYI3pN1U5sGi7N/wL0wV6QhQAjMjbJGAHnINP/PCKFjKOSjg6h99tn96zM5zrmJuYnagk0RESIOdVqyvf5jmeWaHGxux+CwSNK6O5TIhXXQinW6AmDd4JjespxNGFZ1wvoRXpMlUg5qlgp8pmSgu04hPhTQCjHXMEyvagfjCQS6wvN72JthpNBUpD4a3QT7LcM3AV4CoYaYj4x71e/AglUqmRRoMYV7Kv7jfRCUWYw5SoL/d3bVXS1OPx1Ysi/MtPQbYIEHU3LgAG3FSZfCiwy4tmGsyYzYTkRxLEbMbmU9Zi7TTQsFnfCIVz9EgjC4mU2ewTjHfjDp+gzIq8d8vfPKjJdkfj1krN4VoMZmDVEHwmc6KxIlSsNY/wwud8yQ8wNktFGmmFTjeFFwezJ/0QN627A7ocTe6SGI2Et4zQHNyXOkN5MdaziZa7AaDlJwokFgMGgOdSRXhPFiGzaWagHvnCIW5gIBOP+WfIbAx0BEJB8fLNONR3sbVQADBGJhC/IyBsdI5WooVyLVFRP5CK28hJkL7mSeFcFLA0SOKRB7NN2FBuJ4VRjTSELq5Cmp2QjPvtRWrDYXFFbyWiNvcgHbqBooy56EVuJYcpt7VEAY+oP8CjNpWFyYSkEYXrfIc+FeGVFjUPhpZKTBmZyqHGOwmjdCq1O+sne9QRIAr9ChfkZG4Z2h5tsgyFGLsEyxENSCjb/A1RLAktkOwQhm3WV0grJRIe57wxtJY/zbh5S9QgUzaLJtqhbNybvJDkHUbs7j7EUFSBvZASMcUM1ut4D51j2XyXHU3dFqiZuITex/0okF3b3Nve2cv2u4Nop3NLvyK+M54sBl1+93++2BJ368JwB9c405Kizp/XT59mtYp6LkKUhs7RAqtVim/VguMQnwCRV2jKlyotSj83uYm/tGUWqNqdOUe06OPgBxVSZUaRHyYxrMskRHFj42PFufeLiuWG8PRJmQuUlt77ihiuWQQdy4dIhk/GAMuL48Pl9S8CrCMMaTNbUmM+3vjwVZ/a1cMtrZ3eqPt0Whvq7fFt3f6g914Dy2v5jKrQDSZnrkMgiYTgzygIq+KSjT/Jvf90WjWOYfsNEU+les9zqW+tO+tc9oV9N9BbpE8ReKlMz+bNk5cQbpCTbHh2VRpVpPijQPbsUj5b/45egxyodDzbC40q8llu/oHyfqw9zhh7BNKPR4fUmeB+VvW1EzZ3mCJYF2LU28JAIzn1YTzkQPAWAsEU+Wn5y7TTVyy7cciI/KMec5XeR+PY4nMeHLa8MOlsNwEtp/Di1EB5dwo0aONEZ9QaOINWTRQLkaZ/QIZI22USJlpHnR+WIMIcwm2/WAEcOyxvXUZjOG8BYltdgfh5l7Y619094bbveH2oNPd6f2L7Nyluq+MBMvDVTh6m/fhKBPsC4G8mwrl2xUKVOyGex8vCT9dJD7pf00knuRDGLY2h/3tzu4uYgAQ4Hs0aGlXBN7e4YCtVcnsIJEo/iNjwDxDdlbrF+qQRjqeYaaVipy984JEd09Ci0UOEfBAx0+Iaq+lEuHEcIkIBUGOYCIDip9ljNme6nZHstyQoHFNOYIkOl32I4+Zz1LswC8G5Wh49CvQekr8uVQS5rNyCkSeqgJZwVbsCj7a2Rz0tsY7W5z39ra6u9ujwZj3+5uD7cGArFpYC9HRrqgQmqx/Egrqn4glOgKN/BsEAhYDsicAxPzpRQXReIL8Mfi7sdUyPV6Gu1NQVLMfD07Z1i44kpoU9JxPFoSgwstzrIGLJOGjsnvCxEyE3xo5kWoVFKGw6b4KDo9e71+eXMCTs6O/Xx6dwy+ktbRTt6/AWmM0S00N8lTfEGK/AHQyK7DeBC9jLU+1BQviytYHSvc3O4NiJmW+k4MZnvuKGXXSbGx02nClcivvB9kRnTZ0uxhyeB5N2YhD28u0Cwat/SgSWR6eeEm2fO//qsP2q5zkWmdMqTNsmyFZuRLdbeeAKwvaKtBFjp21jBbC61yUTW3Mg8lJXSnoHID8cTvZj2ijs9yxrNyhshYP0esHMDvJNdFdLIRE6kWgPYhoUwoiG5SyEJlgbRKaFx+OqB2AwKPKcVXEqsdICndvHJjDXNO7iBf2CX53mkD4CWlp1YvPwjsf7Ua6aETaKNXkI5LfaKPJflSlrtLxXcOy9t21765994m+u/jyzLfw/i2VPt3l0udS8QLkayh5LpU+hqxHaVYOovLGK7LNQCC+RPr53QU49q9Qw+HXnC8Z7uN8xfrIpfLl9qDSh9+bKbduytQ/1wUCJDm6FYwhEol4SLjniF2RSKLqL3N7rc1IgoGqFSUifTWa6YI+dZlCKdo0tm0G3ZxV3+d+uxg8wloXAd1Xr9DtBK0ryXUluc5G62z0p8lG60py7btr3/02fffBSrJCRd7i6yRbpCk3M2dp/r3bFYcB8+/2lcuRqharFSTGqhoraFYOwajXHXXHu5HYivlWvNMfjHvRTo9v73Z3u6Ot3m5Qz/VXcz+unKzpUzV9Oz2SiGnH3rBCgXHZXOu4uf1X4HfhMZ1cyuclMegOCri766p27A2Wa8cLrfFE1ayskGyjhlRzGWFMg7EpjjXlWBjA2QTiosLzBhJwoSnJVAAV/MzN6FADOi+uAuiaWbg/xq+a/qiELPdWPRepoqQAhBQJEo1VswbDknjuYIw1H1CgCnYC0fkrVqdeRb+pkmdnuOITXDE7+hIJgY5eVe7bq/Z3jwG8wRhx7hR8z0av63a4AgOAhsDFrKruXNfn6/p8nePXOf7PkePX9fnad9e++2367jPqc18N3V+fw4An1+cwtrPJqlrqNR3m/L3LdHIVj4DMm+koKgxtN5c1ONUVYEoIaEJnvjOO9x6CjfrBk9DUrktgWegQFSaBkeWxvVtQFCjorsMz2SkP9yh9Q2f3PvdXhB08H+BcDAJXXLgTgXhS0DHpkHiNRAt24Y4YOGH787FBdUTwQfp4DAu1ONMFBDgi02Zg7d6a6DHAzKCV+N76Q1t3dOx2YY2wtkuT3D22Hn/i8Z51OCL3rGOV+B7kBeMZoFxYHsK/nt9uOcea23FfuuMyzyPYp/WWmL3FYT32o+AGGgL36eKHn99dvGITrDTJ091RUCGxNQBfOQUToUi2X27j4yRKLvNz//uNDyXoOWycwIKZP8Z97IXwC4T4M4jJJFKcJCgM4KynHxrljXn3HNp+r0J2KI07U+ru3PgluoPtV1m5Ll5b10tBfFdSCx21kKjhcdUGCifaq8gdvInAfZEETyxJ68XMHb2wRg/7J3iCVBcxoCQ8jubnrajU2otxNOiFSK+J4716R/eImtOYi1rMTunmwjGLplpb8VfG0HTQDa4mBXjRi2HR5aWQPCLsbdYghY5lKEMoCgnfCTiGcsbER5iUqSbRUK6p2LnkB9Is+PwHOlf8obFmenwFuRNHxjp6xknoBczIMESGoYsB1uN3qQkNCw+YwRooDjgDOJjrnyKBB1qLeY7WyqhO5DdoDqaGCKASFZsN3V+G8wDnfzF6gaOrMRCCA7pw4D/44dUzTwvzU0NY5W7AogSX8SYa0uKC3BzeajcKU+Ufbb244v35pslblcy+dpS+J5L8ceLu/yjirSPNnzHS+CoXzY3Y+nagbuSuWlvewnMXV+G/8JY8lcppaFbm9+nqZLKE52jT5NPRVApq/jPBc6z82mhXOiU/hHIXnR9aPCI0obO7BgBzaNdkAvQ67B10VyoCEWNnhcclgOpH7Vusc5DyKSqJHZaKgwIqTQuFB+oBRJEyDubxiHZjaaPCBSFotJQoV6apjKtmlR6JZoOi6FCPYVL7doy7xNCA1pT4CC/QYXnrBQSJGvGXm+YLORMJWRmOa5bfj9EGywmnIsno3gbAgk6txuHN8cUSRSCm3C2AjjaTDT/JbuBYIIKtjjOGfgc6OrpQoW0OjWiN7gneZm6cU5/fLm9Y1O18Z3x9L/y33wv3+RDXs5Hh3huqp3CNletir4KVXSz0RVPQIr6/vcXtGWzp7vCxu3CHvS2YFHrt/IbdvZr8tm6ZrxTarwI3PMpL9H5LI6B7iE+Xw//X9fAH5Fhdn3+hINd3vb+9u94PmEN5of+F1rC+Y/1fuWP9oMrm9+pfqLT1RenmRekHpT2/1j6X9vV8y5T+JzyQsSm6UW5209yXlNqspbMGSKXa3f7pCKs/fk8v7X8gq7u7/wB2TlMs +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Query Parameters

+ +Non-Employee record objects + +
Schema
  • Array [
    • data object
    + +Attribute blob/bag for a non-employee. + +
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/list-non-employee-requests.api.mdx b/docs/api/v3/list-non-employee-requests.api.mdx new file mode 100644 index 000000000..a15d65f0f --- /dev/null +++ b/docs/api/v3/list-non-employee-requests.api.mdx @@ -0,0 +1,99 @@ +--- +id: list-non-employee-requests +sidebar_label: List Non-Employee Requests +hide_title: true +hide_table_of_contents: true +api: eJztXHtz2zYS/yoY9o8mGlPW0w/N3NyptpNRx419fjR352QaiIQktBSgAmQcXcbf/XYXIEXqYTuur9f0dNNrZRJY7Bu/BQF8DvRMGJ5KrQZx0AsSadM3Wp1MZ4meC3Ehfs2ETW2wE1gRZUam86B38zm4tsIcaZWKT2k/Syfw7P3d+50g5WMLvwOgEOYk2KkciWgeJYL9wBUfi6lQaQCNY2EjI2c4NAx8NZGWjUVqGWfIBNMjpoCMyMkYz0qdXU2EEYzD/9NbzSLHRsYTlllh2Ugblk4E++A7iDiERx/YjKcT+JfhU5EK03unGGsSLexm2IRb6mY0MOppIg8fZKx6SljTM4LHH3aYVOx2IqMJi7gVDHpo805Z+O+Uz3MmcxnWCsC4tXKsRMxSDQ2BpVRGWcIN41GkM5UCJdSTYcM5vIXGaoyjphNevPrWMhnXUYaWkwFsY0CvThbQJFfL1JY5fxdMxbuA2YnOkpgNxTs1M/qjjIEvr4plDX7kSSZwOKB/K5OE+Q7UmAa+laDjhf3w+XoVkDiCWZ2ZSLywL50emVMjsmvr4HKFtSw5nUQ/AQJmDu8UvCF/nco0WHamH/gnprLpEFgCNoywWQKDgrqNSDOjQHGXwM3Nj23WPx+wy5SrmJuYHekkERHSYOfF0O9fTNJ0Znu7u7H4KBIMl7rlMplpqdJ6pKe74CG7fCZ3racTRgWdcCHCS/LMqQa3lQp+TinoUEzUijQCwm/EEyt2AvGJg8ZAvFa3AYEXTcSUB73PQTqfocwwrgCDQk9Hxj1qt+DBVCo5zaZBD/pN+Sf3m6jEYsRBC/TX3d3Oem3q0ciKVXWe0WNgGzSIZhtlYHynVQYv6uzaQvglc2ZnIpIjCS5EnlAj69RQ8TM+loqn6CtGZ+OJizVnmK/GHL/BGIX6NyufonVF94MRq6UmEzUmUx91egbZInVhV/tHeKVTnoRH2LuGKp1pRYmJx3lEUhyuhgPmk1sf/T4ywHJyVNgN9Mdqzidq7BaTLuQt0BhmHrCZVFER0pijOBgaWGEu7USQgib8o8AUJwwpB9vL6YxH6Q5KA2nECLAYTAiYdZRO0VOswFFrROQvJHkNeSJuKQM5LWDrIaUdz81X4UEozxonGmqYdbgKSn5CPTf6SiUzV0bcMIJNDZgouCvxEohme6+7tx+Lg33RiRutQ7HXGLajdtTtxsPuXrziizjRQL5XKcAAEv52oqc+kt28dwtTxxQcr85qU3RZFcsIXNXNJ+U5qh5sEs1qQxl/jRo3SVWKPXQnHlqBZgL1VAWOYAqHhzt8hjMXT8BP0syuiHkJHBRRktH0S5NV7lV2rlKYYFynIYaM+p1d7xtUEvAVei5fUgS4ZxhWNpvNUI1xgYZGQEbf4mtIz0lsexhiXh2sqo8daGIABcJYOyzh+S/QvEx22GyiFfzlwYV7Bcya9BhoQSsV449abaN9RzL5UvtWjOgwwyBm4lfAMK3osHnQOOjuHUTd1mG012jCr4jvjQ4bUbPdbL8LVsz7ihj4gxvYaWnZxK/yp48zMiVwh++1sT2kUKvl+qvVwAfErzUWIHLP5w2L2m81GvifqtpO7wHlTA9/BhkItBF2hokMCIBfJRj/QGD3Z4tUPq/amBvD0T1kKqY0OiCJsxEBPt/CEUc8aFCYVDouZXxvJri+Hhyv2L5SmDhNIJAOyg7GG+1Ge++gFXZFh4edzmg/HMZRK9yLxF6z2ep2DqMmumSuyHVcLCcUGmiAyNrqSGLU5TMzGLKiUUe1ytFDTo7cuOh6JCfY+Im8XIgU/BlHrFB+5MClh08cf5VQALNkAFMSvS7Vrq7lKfgV5aL7namUzx4W5iKffRezYV5soWarDCNakXxatwCpJqi3Irs+PFDZXaHko55rhnjrhkDieb7+YtrYcQ3py5xrSv9fTJV63aOPv/nnmBpxFJpdvngU6lUdpVv8D8n6EvhhwohwclMOjjHdcQSdsmRpgqgGca1dddlvbV5uV9n5mQODsRYUqcsuWmJrm+q2qe63prog5ilf51M8jiVS4cl5xbtWwFZVnn4KL4YZFJzDRA93h3xMgINXBKhwvgwd+hkOjLSBeA42B/l8vx5m5M0Y4oIC4Xi8AYNtQg//5UCqsiXjJedtivbBwTBsim437AwbPOTDbhQeHO6Pmq1Gp9k9jIJCBS4fLc8sIyizsU72Sy0lzxn4DLQQfoOQ7u2qmELhYsRN8Prsx5OLN/03Ryc/vb44uz6HV4PjkzdXg6t/4rrsQp7i6cqiBLECINO60rxUFuLaI3gGKDRZPCR3GaPIihYBxkZns2CtK+dSHqf6CvkHda032jqOcPyqSbqQPxrNbtxujQ4ghfBm96Dpc0y7G7fEpojK6RUGeQtxO6B68jmhQoVXqJPTun8blCLFl6n3WLR/fn4BRkXfvTj5/uToin6en7w5Hrx5Db/enF39dHHSP0ZLHqHhT0+hxcoa/AmQgxCbQTGAvPqyaC3gL+LA5jX0Qo4SN7lm+1VRSsKdmbgyMbt1qhU95gTAlWJ6XQzXLMXvKNGcVOdWldKH7eMbLjJOlXgwyB8TjNAxrW7em0Mg+4owlWTb6lhvJ0KtrJYQ7soJL82FjeZh2DgIW+2r5kGv2+p1D+vNvda/SEBXuz8nJ57kfTx0Gr12t76/jzysj5t+Kbt/x62opPw/pSM/xdXy5buqr3lPiz1VeIg9cTnlWc3sKItknrv2islbjbDRDludq2azB/90mvVmG7yg22s0CA3myz1PZKsyoTqDkGKILsN+GxlqNHr0z4IZv+D0zKzgGvRaRprESHcNI797cnjASr9fhriXkTv6LryaKPzEiA0wRXTWLTkdJRKNcWIMAIiQXZQ+UZRZG+qYcIdUVKo9ZRFqA5KKqQI40vEjZvpXUolwbLhEDgWxHEFH/5EUcxB9KnAk86+j1K6qT9BEvcm+4zHzKmJHXhjMuIZHvwCtx5Ri10pCf5Z3AQBSwOg1w4p9wYd7jcNWZ7TX4bx10Gnud4eHI95uNw67h4fk4sJa/Da7ZvWuOvRroYSREUt0BBb5NygEPAd0TwzQ4I+H7ETjEfrH0t21LcT0/DL8lr8DCPS7o3PW2YeoUuOMnvPxkhJUeH2JS9VZkvBh/sEGl1WI8JmRY7m2Asznr+OTV/3r0yuavv5+fXIJv5DWygTVV/m3EU3f5Cb6ljj2AmCwWYHLwhBtrOap1kAgrmy5oXR/2bnFcsR/PIIefvQ1Pcqk2cgsfb/JNz68kHVR32FDfAapIpqwIUzmMdMuKdT6USRmaXjqNVnznxtf1lm/KDLd1zpL+yKGUMnEsVtJd1+QIZQFFcM6w30SqVyufheqrFpjkU1Oy0bB4ADOH/aTfkR7RfL9HUU4FN7iWcy/XcVec1XurpZSI30yiEAK+g4eaWNAwwyqZigULfPpiFbtIfGovF2RscpoitLdD44ZqILoXcQz+4i4O08g/YQkWvHio/DBRxsg8i0bi7WAPCP5gpM6FztBvC7ywHffFbaxu43dbew+MnaXX174D23+LUGf5ir0uVY8A/0amjxXoI8h71Ga5Y0I3nhD7uByi4dI37+9gsD+BbActBefZvi59RnxkZvKV9f7Cnv4T6h5BZZP/QtbIIOkRyfBCDKRiHvE94JjBxJJVe3V0V5pM5TgoGoNRKRdaXOd0W5BkylF+1TsDou1sOrb1O9QgYiw1mVAHFXFoftgu0WSWyS5nY22s9GfZjbaIslt7G5j9+uM3XuRZMEVRYvHSTabTrmZO0/z792eBmiw2CpchByZahmtIDFWYKygihyCYas5bI72I9GJeSfeax+OWtFei3f3m/vNYae1H5Tn+ptFHBdBVo2pkr2dHUnFtN/CsEyBc9lU67i6/Jfhbs0RHf5IF5AYbAcA7u59gR1bh6vY8UprPJUyzxGSrWBItdAR5jRoO8W25VMMnI0hLyrc4iyBL3QlORVABbefMtpHjcGLUgBdMw/7I9x86Hdny3yN1Y8iVZRkwCFlgkQjatbgWBK3Oo8Q8wEFQrBjyM7PiE69iX4TkmcXKPEpSsxOPkVCYKAXyL27bn13AMwbzBGXzsAbFnpdtcMVOAAUBC5nFbhzi8+3+Hw7x2/n+D/HHL/F59vY3cbu1xm7X4DPPRrajM+hwaPxObStN1iBpV7R+bHfG6ZTqHgOyL2Zjui8V7zA4IQrwJWQoTEdM8Uz2fDHbnlnTpjD6wDPnCMudCxlJoGm+fGaz2ApsNBdnc9kPd9ap/QtnbH52F6Td3CDgIsxyFxx5k7u4IkeN0id9GskurDLdzSA07Y/kxcUR3nupU9bjsGMc51BhiMyOwzc3bsTPcZdOFBLfGv9nvs7Ouq3JCPIdm2Su4fk8SeTNsjhiGyQY5367h0L2jPgckk8v80jvyLgEkG3G33looDFRIKFWmtlsDNs1mLfCW6gInDfLl58//bqJRsj1KRQd0e2hMTaAILlHFyEUlk/X8fHTjS7LM4a9ytfSjB02CgBgZk/Oppv+HwDOf4CkjKpFDsJygPY6/GHu3il34aDou9UyI6lcWe/3L0FXkR3mPZmlsvFS3I9lYlvcmqhoxYSNTxWVuHCqfYmcjtvIohfJMETS9p68uCOXliihwUUPEGqyzygJjwf1e9bUW61J/NRoRcivSof79RbuiGh2o25tJXflTBg0URrK/7KGLoOhsHNOIMoejJbdC1DSBERthollkI3ZChDQIXE3ykEhnLOxIc4KxMo0YDXVOxC8gNZFmL+A53/+1CRmR7fwOSJLWMdfcGJxSWeccAQBwxdDrCefzc3oWPhTjOQgfKAc4Cjhf0pE3hGSznP0Vqb1Yn8LvXBqSECVomKnfXcH71FgvO/GL3A1kUbSMEIqosvfvA387Roq2pZWflywLIGV/lNNMyLS3pz/BbLUThX/tHkRYn7i1WTM5XMnztLb8gkf5y8+z/KeNtM82fMNB7morvRsL4eKDu5Q2ura3iWLvSAf8NbilTC01CtLO7wKJOZJTxFn6aYjiZSUPU/EzxF5LeDfqWnFIcAdzH4hXWExrSJ1wDDHOo1mQC9OnsL5ZWKQMVYWuF+CaD6s/Y11iVo+RyNxI5zwwGAmk4z5e+ByKaMg3s8YN1Y2ihzSQgqLSVyyTTBuKJXHpHoNqiKOhUZZmrPRrhMLPG8ZPDIscCG1q8RgyLRIv4SgoUgFyIhL8N2Vfj9EG3wnHAikhkduwW2oFQrjfDD4GqFIhBT/qCfNuNd38nuYlsggqWOc4Z2HUo6Og+rbQqVaIkunY+rbFsv3dG1dE6xWBvf3q61vV1r5XYtP8OjKXZnuJyIDpe5UtEV5jfB+sIcSr0JOCY2+PwZl5ywSr3Dx+6uDyzXIUowES0u99jom1/XZV1rtfaLwEWc/C4yv0wT0LUDj9fD/9ctW/fosbiF7ImK3F6Z9fVdmXWPO+T3oj3RG15c+GuGXlIqf7b7q+7lefl+rifyvr2J6jluorrXUovrxp5oo+11UkvXSd2r7sXtXwt1v1+sWNNFsoAuKBMTjnDd3JesUq+VvR5Ipfi68PoEwTffsJThf+BQd3f/AaSdYyM= +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Query Parameters

+ +List of non-employee request objects. + +
Schema
  • Array [
    • nonEmployeeSource object
    data object
    + +Attribute blob/bag for a non-employee. + +
    approvalItems object[]
    + +List of approval item for the request + +
  • Array [
    • approver object
    + +Reference to the associated Identity + +
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/list-non-employee-sources.api.mdx b/docs/api/v3/list-non-employee-sources.api.mdx new file mode 100644 index 000000000..eebe11ecd --- /dev/null +++ b/docs/api/v3/list-non-employee-sources.api.mdx @@ -0,0 +1,95 @@ +--- +id: list-non-employee-sources +sidebar_label: List Non-Employee Sources +hide_title: true +hide_table_of_contents: true +api: eJztXHtz2zYS/yoY3h9NNKKsh+WHZm5uXMfJuOPEOT+au3MyF4iEJLQkwANIO7qMv/vtLkBS1MNx3UyvadWZtjIJLPa9v4UAfQ50JgzPpVancTAKEmnzN1qdpFmi50Jc6sJEwgbtwIqoMDKfB6Obz8G1FeZYq1x8yo+KfAbPPtx/aAc5n1r4HACBsKTAzuRERPMoEew1V3wqUqHyAAbHwkZGZrgyrHs1k5ZNRW4ZZ8gD0xOmgIwoyVjHSYddzYQRjMO/+Z1mkeOi4AkrrLBsog3LZ4IZ8Z9C2FzEIT7JeD6D/xieilyYEXuvGOsRKZxl2IxbN0sDm54kcvBRxmqkhDUjI3j8sc2kYnczGc1YxK1gMEOb98rC/1M+L9csJfAcM26tnCoRs1zDK+Ail1GRcMN4FOlC5TAX9WLYeA5vYbCa4jr5jFevvrNMxh3kuu+4BlsY0KPjHjTH1TK1ZV7fB6l4HzA700USs7F4rzKjb2UMfHnhPzZ09pHd8qQQuBzQv5NJwvwEGkwL30lQa20vfF4KTdyTfhiqR98p2wEvqmxgyY8kmh4WNXN4p+ANeWAq82DZP17zT0wV6RhWhZWMsEUCvgIaNSIvjALdXIKT3Pw4YEdvT9llzlXMTcyOdZKICGmwt9XSH57N8jyzo52dWNyKBAOgY7lMMi1V3ol0ugNm3+GZ3LGeThhVdMJahOfkbakGV5QKPqYURigmalIaAQE14YkV7UB84uDIIF5/2IVYimYi5cHoc5DPM5QZ1hVgM5jpyLhHgz48SKWSaZEGI5iX8k/uM1GJxYSDFuiv+/v2em3qycSKVXWe02NgGzSIZpsUYF+nVQYvOuzaQkglc2YzEcmJBC8hY7fIOi1UfManUvEc3cHoYjrzYUeG+WbM8SuMUal/s/IpIFd0fzphrdwUosVk7gNLZ5AQchdZrX+EVzrnSXiMs1uo0kwryjY8LoMOB64JBwy6Ox/gPjLAcnJS2Q30x1rOJ1rsDhMppCbQGCYXsJlUUZU6MQ1xMDSwwlxmiSDLzPitwCwmDCkHx8s041HeRmkgUxgBFoMcj4lF6Rw9xQpctUVE/kqSt5An4paSjNMCjh5TZvHcfBMehPKscaKxhlLCVbDgJzRzo680km9jxQ0r2NyAiYL7BV4gxa94G1YLSNoqh9pN4t3NdLpYItkd5P8UXKvDWik6pYplBM7oisJioekEm5hfrNRh6fVP1tn9OhkmCZ+iM8VoKYhDcJqZAA6N93NwygZecC4L5VRHEkOLwsZVp81yWG2oNq1hfpP+F7IEOj4PrUCHAkM2TYMrtCOAEfhmWcBLWLeK4oIQABXT0uvtXOVQAN2kMYa0+o1D4y+oGuAr9Fw+pwh1zzDsbZFlqLy4QmATIKPv8DWUjyS2I0gBpATmtdD25jiNW60A4WOZ6Sxqud/t4v+aejp7ABkyPf4J2CaYQRAOnBAI8CxL0J+BwM5PFql8XrUlN4ajG8hcpLQ61L7zCUGU+pMf65ZBLGNQm7l0/Mr4Qd+4vj59sWL2Bk52YiDOCxb9hncH3cHeQT8cil0e7u5O9sNxHPXDvUjs9Xr94e5h1ENPK3W5jotlZ6OFTuM6OuKyqoAl1+i2yVE/OuwddA+GewfRsH8Y7XV78Cnie5PDbtQb9AbIjYunR3KCg5/Iy4XIwZlXMsYjF154+MT1VwkFkOEDSLb0eqWTOgMPo+zzsDOB0wLWJpS8KQTqIe2NXvzwIu7tqqqEQoRzE7w6//Hk4s3Rm+OTf7+6OL9+C69OX5y8uTq9+if2b7USqqcrSIfqDoS/dfV+oRJhzwLqhehI6oeQOTibolSKkMUUgGUWrFXnqZ/zItdXyD8ofX0EruMI148bdhyCD3d7w3jQnxyAG/Pe8KDn/XwwjPtik1VLehdiAmAKeH4HvgNBiMN9Q+a63gdN2ezcthb9vVo01TH1Qg9m+hhySJjLNVDs3UyoFeSVcPhQEl5KtN3eYdg9CPuDq97BaNgfDQ87vb3+v1A1JZL4ipx4kg/xsNsdDYad/X3k4Z52fDYlukckOVXPoVZnbQu2VDCrlqeRmbHnMLFdn8PrtL3SzlVi9vrQ0Cnogfm4xKdfkA+94s2J4/se/2kHu+sQy3EiET6fGAOhELKLhZ5sUf9jHVMESQUNkYMAvxTDbNByTBXyWMePqMcvAVaHU8MlciiI5Qgm+o0fhHLUGzmS5Y4PjWs6DWii02Pf8xjkdfIde2Ew5gyPfgZaj4Eq10rCfFZOgRiv4OWaZcW+4OO97mF/d7K3y3n/YLe3PxwfTvhg0D0cHh7i6qmwFpKsXQP+mku/EkoYGbFER2CR/4JCIDxA98QALf74vEw0HqF/7HPc2EpMzy/DHck25NLvj9+y3X3IGmpa0HM+XVKCCq8vgxVvbnsmzo2cyrUIqSwSL05eHl2fXcGTi5O/X59cwiektbJje6TKVlFTRM70HXHsBcCMYgU2EpBSWMtTbYFAXNnFgdL9ZefQ/KbMd8sww6++ZsYiaTYxS+1suX37THZEp83G+AzCPpqxMbcwQbvM1zqKIpHl4ZnXZMvvrzzvsKM4ligkFDLanrC0uzsGjBrHrvdyW2YQyq6v1EWOuxdyGR3Wqmxao84rZ4tGweAAzr/sJ0cRbXiXu9RVOFTe4lksW/nYa67J3dVS/qcmE/q+iDb+IKNCWoXMBLJJ6Ep9OqJeDxKPKsdVGWuxnlK6e+2YgXpO7yJe2EfE3dsE0k9IolUvboUPPtrxLbeheW0mn5H8ZiZNrna3vS7KwHfd6DZ2t7G7jd1Hxu7yywu/T+PfEvTprUKfa8UL0K+h4rkCfQx5j9KsHETwxhuyjY2Dh0g/vLuCwP4ZACuMF58y3JX7ivjIlfIV5o8qe/hNt3JPriz9tS2QQdKjk2ACmUjEI+K75tiBRFLVYHW1l9qMJTioWgMR6Zu2uS7oK09TKEUb87bNYi2s+i73W/IQEda6DIirqjh0W3xbJLlFkttqtK1Gf5hqtEWS29jdxu63GbsPIsmKK4oWj5NskabczJ2n+fe0Z85gQH02ogo5MtUyWkFirMJYQRM5BON+b9yb7EdiN+a78d7gcNKP9vp8uN/b7413+/vBYq2/qeO4CrJmTC3Y29mRVAwg7hZwXKHAuWyuddzc/ivw698JnWDLa0gMtgMAd/+hwo79w1XseKU1nqyblwjJNjCkqnWEOQ3GpjjWlGMlfnE+hbyo8EyHBL7QlWQqgAp+i83o4AgGL0oBdM08PJrkeGbOHUeR5UayX0WqKCmAQ8oEiVb0pf0dl3i2Y4KYDygQgp1Cdv6K6NSb6FcheXaBEp+hxOzkUyQEBnqF3Ifr9ndPgXmDOeLSGXjDRq/rdrgCB4CGwOWsCndu8fkWn29r/LbG/zFq/Bafb2N3G7vfZuz+Anzu0dBmfA4DHo3PYWynyyos9ZIOzP7WMJ1CxXNA7s10RMdf4xqDE64AV0KGpnSuHq+WwB87jSOwduHajLktbzsUJoGR5XnMz2AoMNB9h2eyUx6YUfqODmXeDtakHTwf4EIMEldcuKOeeATULdIh9RqJHuzSHS3glO3PIAfV2c8H6dOJPLDiHORgjkybgbd7b6LHwGYGrcR3lkZ3yHtWZATZrk1y/yV5/FHWDXI4IhvkWKe+B9eC8Qy4XBLPn2cpbzldIuZ2q6/cdarrCPZp/ZXFznFYn30vuIGGwH118eyHd1fP2RSRJkW6O+MrJB1g5uwtuAhlsqNyGx8nUXGp71YcNb4owchhkwQEZv6ofHly6Q2k+AvIyaRSnCQoDeCsx58G5o15Gw7Gv1cheyGNOyzs7l55Ed3lgZuslIsvyPVUJv5SUgsdtZCo4UnkBhdOtTeRO3gTQfgiCZ5Y0taTF3f0wgV62D/BE6S6zANqwvPR/HorKq32ZD4a9EKk1+TjvXpHl76a05jLWuX1r1MWzbS24m+MoetgGNxMC4iiJ7NFN81Cioiw311gKXRLhjIEUEj8nUFgKOdMfIxFmTCJBrimYheSH8myEPMf6cLKx4bM9PgGaieOjHX0C464L/GMC4a4YOhygPX8u9KEjoWHxkAGygPOAY5r+1Mm8Iwu5DxHa21WJ/I7NAdLQwSsEhWbjdwfozrB+U+MXuDoagykYMTU1Rd+8DfztOjY6aKyyt2AZQ2u8ptoKItLenP8VrtRWCp/b/KixEf1psm5SuZfO0tvyCS/n7z7f8p420zzR8w0HuWiu9Gyvh1YdHKH1la38CxdYIT/wluKVILT0KzUdxYXyWQJz9GnKaajmRTU/GeC54j82uhXOqU4BLiLwS+sIzSlg8oGGObQrskE6HXYO+iuVAQqxs4Kj0sA1Z+0b7EuQctv0UjsRWk4AFBpWih/K65IGd5X/oJ1Y2mjwiUhaLSUKCXTBOOqWWVEotugKjrUY5jUnk9wlxga0AUjfmEtsKH1W8SgSDo27a6q1YJciIS8DMc14feXaIPnhDORZNjbQQYFMCUWVnh9erVCEYgpf6Bam+mOn2R3cCwQwVbHOcOgAx0dPsq0zaERXaBL1x4aV5/qXxlYusVT7Yxvfx/gz/H7AL5mo353MtwfRBcqXPPnOu2bYG2nDb3bDDwN33/+jFtI2Hbe42N3xRP7b3B7zCz1nc6N3vZt/drAWqX9LHBTpvwxBb/tEtC1jMfr4c/1MwEP6LH6GYUnKnJ75//bu/P/gDuUV9yf6A3PLvzt8ueUrL/a9fwHeV7+gYEn8n71te/iP8j02h8WeCLn20v2D6q6/u2DWr8f6p1Y+o0nKLKUkKicumnuC5qFWStHGJBKtWn+6gRBJd/QovsPuNT9/f8ABPMuqQ== +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Query Parameters

+ +List of non-employee sources objects. + +
Schema
  • Array [
    • approvers object[]
    + +List of approvers + +
  • Array [
  • ]
    • accountManagers object[]
    + +List of account managers + +
  • Array [
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/list-oauth-clients.api.mdx b/docs/api/v3/list-oauth-clients.api.mdx new file mode 100644 index 000000000..c02b43fcd --- /dev/null +++ b/docs/api/v3/list-oauth-clients.api.mdx @@ -0,0 +1,83 @@ +--- +id: list-oauth-clients +sidebar_label: List OAuth Clients +hide_title: true +hide_table_of_contents: true +api: eJztXFtz27YS/isY9aGJR5Ql2fJFL2cUX1K1ju1jyc1MHU8KkZCElgRYgrSjevzfz+4CpEhdHMdNTy+jPsS2CC6+XezlWwjoQ03HIuGp1Kof1Lq1UJr0gmfp9CiUQqWmVq8Z4WeJTGe17s1D7dqI5EirVHxKezAKPquZuKvxDc+nV7oRV3wiarePt/VayicGx1zgYJbLhAeBMH4iY5wXZh1OpWETkRrGGSJgeszsK1amaQCOmCc8EqlIDCGR+OJvmUhm8EzBE/hzLEN6Xq8l4rdMJgJUGvPQCNDCn4qI17oPtXQW41iTJlJNao+LWE5JBkuEyUIAlBkYxdKpYCblKuBJwMxMpfwTs6+NRMCkYjc/7rDeZZ8N8kFHOgyFjzLZZQH89tU0TWPT3d4OxJ0I0fQNw2UYa6nShq+jbRmobR7L7Xwyzy/keHMDfGMVBWSew/n6g/qgTvNPGZjTZHGskxTgjXVCCoxBlL7Hx2MpwgCMrQJml18nposStrZCblJY5GBrq8u2QlEHUSoLwy2wqfjEozhE2+WDWChYu9ne8Zptr9kZtprdzmG3vd9ot3Z/quH6A7pYKyMMGr7dbOKPqrnP1i23j16mUnyDx3EofXLS7V8MvvawvJ48STi6gkxFZEqf69EvYD/0nwR1TaUFI4NlX1h0hf4xIkPTldFVLNH2D1sHzYOdTtAWndbeQbPVCXba44PDps9bnYMW+tcIfUgYc05Oujwp2pePUFyaZGI5NgRD986h5NLoD3Q5G1XMTHUWBmwEboUOqyswe34kvIEOeYKApjoSMcTodRK+DE8ugF1fnTFujPYlR0+7l2AlxKXvFcSQQzwHWcGEoQCREGqfh1Nt0m6rvbPbQXxqjaGqQHpsmkGugQjgAcK1Vsqdfc2kxyLS5WeL4f+l1uix0t+fUbin6In1IkgspdDE/KkT+Tv5+EdfBxB4iRhD+Ew/pvpXoeoUrPbVjz4kNvgpIbOxMYS0QTW474NXDHHwjzyUAWTsgYAgCsrBAGlGTEQCsGDmiKf2o532knHJ67JoZFfRWEGAgdlpGIGClK0wexSKQNopeST8dYdI8GHZEPud5iOmBlLvTwacW/EPAT7Y221ayAHUFD+9TqRZkXkWPWUxE62rOL2i5pErxJCo7gBhPhsEWd9Ydynia9lfyBHKoG/WBdgtAJgkXKVDgLVKjwJ3FSblwDZ7i68yfBeGLgbL3NmPzvon58OPR1cnx/Cz3zsb4GNYIUS28mHvevjdxVX/p96wf3H+8eji+AQ+vDo5vToZfPdxePHDyTkSh1SmJP9trsFT9rRpu91oMlKYIVyztOw+uPVIzC1cteJKWCsVWMA6j0ky0qI50WHzYIIB7JVWISR2ptGBx/jra+sSFbAVG1+cnp71z09WrYMz9MW5G5APLVmwNwf3mEtYBZLQLWU29irORlCVES/E2li6jPS66gUX56d9Z6InYC4Mu7x+c9Y/KmO1c+ZYMSkkipeL10jrUHC1XCQUsLMAyQPZld1PBeixWCIqLoCZAemjMED/8qkgf7D+8XlZOSKWj6gEBn3w9cDAgjuZhAVAlafF3AKzgg2hzqN/D3Ki9/UQOO4IJJJmoXSDy2s52Coj+CGXkfkzoRAFB3YLCdqmPXxp0Ht3xuzcKEB9eZosFAAaUQVeeGlReQIY4aUyEiurDz6lKo0j6iwADoRegzgiGUJKoppUtzgXtLznhuUIKvSy2dr3mvteqzVsHXR3O92d/Ubz8OAnjIJIBxKI/F8JGfsAlsXBKtwHXnPPa3eG7Wa33e62Dxqt5i7hzpuH55CtP0ePavqfK4K+A6/lJGGR7jQY9ak4B7RnUQzzQDVROsXWNTcDA8eE3i6ZlafIDJDlOlB3qEoqnME/PkgH2DMn0/Ums1IiGmchhb9NrOMZ9m33U+lPS4KB4CRAezRDzg+xw6FRhL5yZlUhxmjlJUB7gVM0nu1cxtexeDnHwUUac2hM8aO4S9JMl4fhcrUe0LPlAtOoluEANOhCZ+x2GTwS2R3LxKQ026qndtmhEj+WNwRusPdb6MqqPZHrQKpIn2TYT9PZBeZYoV8VkuAqZKnCzcvL6pS/nHnnqayUIvIFLRMokRI9sta+co167RH/q9d2V/XqzptPkgT80mNXIs0Shfsfdu1c0WQjHcywiElFbPolzfyapj0QKZfhEeTxz7eHp7C6HhhaIkJBkKkAILuG1YFoijQEjxWZux+Nq0YJWKLRYm94APpa/Y6cMsiaEu7/CrL6z9hNuFYS3mf5K0zO278V04p9wUd7zcP27nhvl/P2wW5rvzM6HPOdneZh5/CQKgD4DbjsKg5fnfotZjTgatQKyN+pueBgewJAkz9/44RkPMP+mJft2EJNh5fh7iE0tOzN0SXb3YfkqyYZfc4nC0ZQ3vVgKetgDSHBF4mcyJVNe04sj09Oe9dnQyLn/70+GcBvKGtpA3KRjEz1PSF2CmCJMAL34SCHsi0ndQsU4sqUB0rHU2YGjMlcDoQ33Owr3iiLZuNER5VQ8u1WK3slG6IBBQQ/g4IIRWDEjS02OHwLuXycemfOkltsKnggktcN1gsgE4GSQGEhGkEovD/DksCDwG5d0tZgBqEsiDhpKFJQ06QvqmsxN+ViDcgzyll5UTA4APkztnH8NEN+jWqWo7DwFgfRrQ9uOtI8VXTDktHIpLhH6yNjDaEc+jqhThoLsISq6dIRbZNC4lH5uCJjYQrM1aJ0986COU41PfN5Zp4Rd5eQm5VHqhUP7oQLPmQVLhvRauTL5DKS4y/0shtVLFce+HYjdxO7m9jdxO4zY3fxYU583FOiPq1l6nOt8l4SlFiiPgl5D/DwSsPpFrKOWySOIn3/fuh2IrHJ/xQjI/2K/MiW8iXwvWI93HdW+VdaeemfrwUCJDtaDcaQiUTQJdxzxJYkkql2lmc71clIgoOqFRQRsmbCZjqjviXJlEIk3NSplVLfpmzK7+bbYtr2akIFnv2GbMMkN0xyU4021ehfU402THITu5vY/WfG7pNMskBF0eJ4ksmiiCcz62nuOWrLGQxg+VkZVoQcLdUiW0FhrOBYtSpzqI3arVFrvO+L3YDvBns7h+O2v9fmnf3Wfmu0296vlWv9zTyOiyCrxlRpve06komBxN0Bj8sUOJdJtQ6q239g3kSMMa1h6il4M9gcTHpbcMf24YrvG7Vm77ia5QzJVDikmtsIcxqMjXBs6cs6MOUE8qJikKok4EJXkpEAKbShH8pIUvCiFiA3mXm9MZ72soGSO1kxi1R+mAFCygTuXA04lgQlxRg5H0ggBjuB7PwV2alboj/E5NkVanyGGrOTT74QGOgFc++s2t/t5192DuwCr9notd0OV+AA0BDYnFXwzg0/3/DzTY3f1Ph/R43f8PNN7G5i958Zu1/Azx0bWs/PYcCz+TmMbTRZwaVO6RjE/5umU6g4BOTeTPt+ltB2c87BiVeAKyGgiaAcwvFKR227fJ/DXgFBPmihZHhovJbfY3iAFYKVeWzwWDbsUZV0pvQ9XWa421mRb/BggI0tyFhBZq9I4LEPO0mD7JpIdF2b52gCa+XiSEl+Z+JJ+fmp+ZnOILORmDqeZnRuRB8DzBh6iG8NjW6Q2yzpCLpdJ+Hj5/RxV0DW6GGFrNFjlfmenAvGM0C5oB7Cv53f2Bkg2bazL93bmRcQXOvl89TutO8bwRM8lEffWbz6/v3wdekMtb0bIySd2+PsElyEUlivfEacqkqis4k9kterfENylB/Ja7APaiAEu+k7I5xDbr+CZEwm7VXOHz7/Fk313OJrKnHUC0hlT5bBp40PymPHdDpHYqnGMU5Fau3YTZzrVT4M9lIQ3+TSPCvNI2l4f6eCwpr2xt0VWDzw/+LJ3fGokjyPziJ5KHURgz18Sjiq32sVBylfjKMiz0N5VRwf1Hs66lZ9jdl0lV916TN/qrUR/2EMXQfD4GaSQRS9GBadr/Ns9ms3S5A8O6UnPWCDhO8MAkNZZ+IjrMZERjTwNBXYkPyZVhZi/mc6ifdzRWf6+AaKJo4MtP8FV8MWMOOEHk7o2RxgHH5bk9CxILbtLREIeusAR/P1p0zggJZynpW1MquT+G16Jz9XRlLm5/zmCc79xuzps/rCWcBubf5NH/zNnCwsTBVj5dsAixZcxhtqqIcLdrN4i20orJF/N31R4958t+RChbOvnaXXZJK/T979izLeJtP8GzONo7fobjSt6wPKTm7Z2vLeHW4uT4Who8gUqcSjoUuZXysoi4lDnqJPU0z7Uymo648FT5H51dGvdERxCHQXgx96OxI0oVO6CQDm0KfJEOQ12Htoq5QPJsaWCs9JgNRftOutBmDlS1wkdpwvHBCoKMoUvIsxlkWMg3t8ZnUDafzMJiHosJTINdNE44q38ohEt0FTNKi5SCJzMcbtYeg8S4v4mblgDY3bGwZD4oq4C9tzRa5ESF6G46r0+3Oy8dj3VIQx3S0AWHiKeT7Du/5wSSIIUwb0guZZJ5Nt95LZxrEgBFsd6ww7DWjl8KNYmxQ60JJcurdcvda+dJW02At/3gV3l+qRo2/HuJ+EM2e2Z7Cd2U2t2pnd4rl1k+KDhwfca8A25RE/thfjsV8DM7n7Se4m/FqQm5vv626+r1yZXwXuFMz/lwNuN6BGF9/z1g+WAC8C2o0eWg/7mt0KKr219GUJSina87cn6MV8DSdwv+BUj4//A/Pa83I= +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

List OAuth Clients

+ + + + + +This gets a list of OAuth clients. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/list-pending-approvals.api.mdx b/docs/api/v3/list-pending-approvals.api.mdx new file mode 100644 index 000000000..8c0c235d1 --- /dev/null +++ b/docs/api/v3/list-pending-approvals.api.mdx @@ -0,0 +1,151 @@ +--- +id: list-pending-approvals +sidebar_label: Pending Access Request Approvals List +hide_title: true +hide_table_of_contents: true +api: eJztPWtzIreyf0VFPiRLGczT2K66dYtg7JDYhgt49+Z4txwxozGTHWbIPNbL2fJ/v90taV4MGHt9k2wOVdkYBqnV6pe6Wy3Nl5K3FD4Pbc8dmKXTkmMH4Ui4pu3ed5dL3/vEnaB0UAr5fVA6vS11DUMEARuLPyIRhCxp8uGgZIrA8O0lggJA07kdMAC09Gw3ZL4II98NGGc4APMstpSDMK5BVNlECPa+5D24wq/Y5vsSg0H8FVtyny9EKHw2E473wCzPZzwK555v/5sQZ7ZreVXAMm6JuH4p2YgHwYDfXPgFvmro8CQw5mLBS6dfSuFqib8FoQ8YlR7zUxkAtr4IhBsesHAuGGAbiXhKnuus1mdDWGLjYCkM27KFyWwTINjhqvreZYyV2XB8cdc9uxpcsygAlJnBXfjnONANSPdgh3PG3VXcjQ3O5Mjb+sPIHrNEaEBfgiRSKNkuPfD8+wP2MBcu08RgMJ7rhQjH1NCvPbdSNAJNV05qxcoLUQZ4wCIQCoBt+wizAGUgt/jMF0sH6dwwTurHteP20bHRbpwYR7U6fDL4kXVSM+rNehMa+yBgti9AIi3AXDweFHPTsRd2WMrz64p/Zm60mIHEgKAB5yInBPQ8xTKYIUra7dsm644GbBJy1+S+yXqe4wiDBGoUC9KHH+ZhuAxODw9N8QnED5SlGnDbIbGuGt7i0DbdQ760DwMFp2LEcCqJQL4hgVh4viBp9RckudX1qaYI1WjXCqQUxhX3woeeEox81GzAg4Xt2otoUTqFfgv+WX4mKKawOFCBvj1uoqZnWYFYJ+eQHgPaQEGUHysCyZJUZfBDld0EEQjbKiXqJLxl4k4ZCb/k97bLQwH9fS+6nxMcxZhvhh1fwYyY/JuJb3iRu057MD3l0I9Ay+wQqAqEX3rLyJGkFKz8v5WpF3Kn0sPeZSTp0nMDweaCmyD+xAdsWKAOcw4QvcgxwawqzUAjZcV8A/qxspSJMnsQSKp7FyiGJgJ4ZrsG9qOFgEwfMBpQYTQRMhVz/gnMD9hGn4iD7e3FkhtgRmE2YHN8ARxbgOmEgdH+gKSAlYVRywTkv2jmZcSJsJV2l6iArQFtZbC+FQnC+RQI0czzHMHdUkpOpNXbJCuW7dAiVzDWzovaOcGIxSEKkIe0YGnyBSs3BEsqu81QNtw/mcbfyYkCZhWF5xtk9rl+ijIURMul54eAnl5xLQDlPeDPYIscMyBBll6O5wenCKFcts1y+ZSVxR8gi25ZPlPCLMxzz68WNVh4Jtk3+uUexNiBf/cC/sI/1TKz0sHSKv4An+apFe99qbSJ1wFO7nm8Thkj1C9eCQTSFCa2LgYTAP83FwKkQF4EJvLZbgJwigbFF0iAA5bwMMMp/bj0+AEpLc1ogLRt1Gr4J0u2S+XFKlc5cYTRABgerApgzKEXOF+ObZBpOPw9wK5f1tnGfZ8jx+1QLILUc2/2O1AD/VofqRfaEiFwXgtYnve+E8cP3LFqTirrjWarjcIghWwXaNgSZ5x2KbNg+TUCA6CK1lsF04QWldCGDvnB3qFnmh6FPXBwPSXMnCNZq3cqtU6lXp/Wj09b7dNmp1o7Of4XIhEz9DWx0ECZw4H/2HENoWNEqNGeNmqnjcZp47har7UIIWVdeq9EHArEKgroc0jUjkmkOk8JjXV0hIvey23pYty9nt51e73+ZAKPx/23w1/68XcXvMG14E+FiRo7hFxlZ3JxI088DbPKMiCpdRJqKCcCLZMj2CAVWahwJm21pcJnKZBDH/Hls2Q1BmjUTKI8TpEkoRA4eAVaWThl1OEYJf/7IIn61vQ43ED33eCeTYeSrilODc7619PB9FeMxhMCxE9hQrvYjqdmArTPx3MdWN1468ji4HWKFqxu1qwlQBeMRu2odby7oUkPTcEpDDuPwHUEQecmso2ZdrB0+IrsURaNd+AY2nzB4C9aWvCecswdANhxzNEUe1F0CuxxzhWX0wfmKeUjpYtB4OpT3WbEC6GtUsosp20XwHyJ3Gj5QJttP2ew1xUm0NNnI5ASrNYWwWoc7S5YP20Woq/Ab+xBUBUy+GO7T4scSdkjBYYDKSR1CtP1lxr8RkL/PGOj9eQ1DY2G+ecYmfwMCgzMyRY5aJ78SQZmIj1NYHPadgwli9ZcxGl6bUoLFQL9eg9vYGpvTAIpTLE122ZDtCHYqNXbZrNhHUO8wevt4/ruFLtO+X1FI3XRw4UJjkUguG/MmSTxWqTxpL1Kvm0dTtKRknlqwFT4DZEYn+lw5oACP+lth7ZBKG1SBS3c0k24G42H54PLPno7Q/pDwn3Zv4K/BaluZWY34Uww0rZBWQQUNyk9Y2EJX7hG1unoUXIkfDoiMNYaxhPLuztZzNUITEUsWbQpg29jzl7Br369c3+GmStkC/6q4b7MwZdbAEXEQVUegu9YPOcu9dP80qTb1WbuaAWLIii9Gis8dzSU2DNybRAJJtfSRMqKNL7VEY221ex0gHKiwcWxwUXrqF2bPS/ayy+QGwb93Zu7VdMTaBJT8q3E6iz0CoGnncq0aC198cn2InDCP9niAUJ/BSco8M12jJX3mrHXjL+pZqyl4hA6CFbo+SsNWGsE87VKaLYEJHIgVw/cN3+SvV6uJp5jygyW8K93osRZjgpc9WaW7y3Ywxz+t5Y8UcjmJfnc5+5HdmWTb+yKh1dCBDyEZ6HRddhbzwk5afLXWo0FuKkwvO0IPRz0zk07fi5pJskAWHedV0hfTdGI4AbP3Mat4B3mDwblpFI7rjSaaFDajdN2p9pUBkV32ciT7VTJ8ygGhxxK8NmSWsyH9mTJgsC+d5HcOoG1JQWabq7SUe/dMrvqXt90L+/G/e5kMri4RvfulHXdFMHkBhqFgTkIbA7EnAnh6n1PgzZBdTuYz2yVlb6QBx9hyaO440ByXe6ZgwkDI4a7X95CeK5gwgnE94HEsXszHV51p4Pe16IJy4JHnnAeT8KEux4g48cKBIgSWgcYunhSUGkDGKQq1SYzHiyWln0fyXKSKks48ERT0JcVbufhNnO0xGGKcc2SUtZYcGYKy8Zp/ICFCB40nEEXsG5uhXYW3+AGpO3JcAkztpqod/1Jr3sJlB1e/3XUjL0haAHiyx1JkBwlzwu2GhmfeVG4sdMBALakHbydiJB2Sy4cbwbzG4uFDZTx5c5YPwEw8hzbgCUhtXXjGRFOXuKR3b4JOA8O58JZHqopBIcSgzsIuEBRq/Nw4bwhck/6l+cgvm8H/Xd3Z/3L/sWrU13pWrAKMLTHkgNYMrF/IByrIpdPlEgAjygHye92GNHsAubYHzHVHLunMCTxCWRN1zRIbNUumap2Ue23ckmNhh1TCGV5FD9mI9Xac5/LCarTOXzw/I93aSoSK75LjVxZxkO8ISm4HSUYEiqaL18rC3x553uOkNLwXUKHSpAe5U1uMS60eUneZM3pLDDk8OtGMDn1hyfFEoo+bBK051acTLZPzeM865A95ePFwq8WQbAOsoogcULGatcXd37GAr23jFOwqXageOPIj4SyOQgIxBUVi5QFhNqMff5AlofJVorQ6RoGjDEI0YE78j1K96wtv125H0zrBSidKgIBPaKHGDypuas0jVRcxAdrO8Ci28EcWqt+UuNw6ZFgVyKsbhGH7mg0Hr7tn9F21c/93pQ+ng/H77rjM/icCU1SjTU7cxWQci7S7ViAOcdYbcdoQVfqoA5gpZzKAwJcC71DKrxjjufe42KhjZlaGQpKBzd5f2k/rlFTgWGtdkr//SuL+c0Se8ZZ6RcI08AiUaJqyMwmHM4HkDfmHCakfsBhJR1g+kHk4iKPX6sFUmVEvk8y/zwqbx5ElTmBVMXEhe+IGIXZKszSFvzl1A08863tyWW0hymDzwUZYVjtZPwlzb5wDVk3BVoH0DFLPBmesU8aDpBRGB+fTBYH4QY6aWWY3Oi9z/54PBxv2LKdyqqPEIJNoEoxIqlU+E3xfiqQIopk8L4O3o5T1m+zoBktCkX6HA9odZpm/UicVHiteVxpHRntyqxRB0Y0Wkei3rbMmWkWYRNPoocDjSkzvAE718UKOc0gVfGrC2KyPHr7TB4tQOf5vXg6EHc88Gx2lHrZNq56UWMwlD2wqezH3oi1OswBVYzoOc9FoOAg3xRyUAIe+va9XZi414J11j/v3lxOycj+z01/Mt1UDYAV2iaWwcjs0tx7IIzVBFA7wRmgla3KygpqGSbE3SDd0A7SPp4yUdBDjV7QIw06DrhiY2VIRWU/2FVRPQBvL8DIHWunZzzQK5VgZdxzWIaVS0XJsqqufFNlXdO0cZKwglNxYqAjGW6aslZKFsyGkS/IgURfENY328htLSWk3FSfcJlmCnoeysQ8td8F3q1DMqF1T/g++qlKWhSKij9Y2ULj5POdCdGIpFgUZmgvHOIZH3VmBnOzw0CnTKk2CyIBV7ezXaAR1iKlHac+YnMlkSnKFw8yFppZ4HViFRd5ELZrOJGJ+/HuKjet2OzfC1f4a+nT20TTYjXISn2KI5LSKMVyDPRRPIOWKpOZka9NRJHNfPyAq5pjAz2uRMhhUeFFRiDPdB7L1agg97qxprPrz+zQ5+BbfhSriiyXXXLbDygWX6nSWfGJQhv0QdAXSYInXZNwDfqplAx5Sr3SNcIUapI5TG3W5WaeIfeXZLcUXCqZRAKyBiH6/6WDzK90CkWlbK3O8UkDPlm1eud41jk2eYs3a21eJxH6lFtwi7YJ8oSN86Hr5lRZA1SXdPyWmR5MHnph8Sl/0uYvMZheFXE7V4EJYiPbvnTnPoFQuGEPP9+NhpeDXi4ln3q+Y8Y9NVB+i75m1etWg7cqHeOkVWnNrGaFN2ZmpdNqtI9rlmjOTLF7oj010Obt+B+xXBWdaWw9ktROm5aJZ8qnKtuOASl8xSVd7iL3NCuf5NE0TvKrjCoKC7f1YiOskIIYsB3zEOwDxjMYTmmL6xJKMrIiy3QPIU4sUWsZoU3SgONswzm39aVaYqnqtp2B/DZ8iLkbjXo/QX13yRefbToSsFNkkSuOL7T+KQIy7uAm1orOgkGQEQdLmPlA5x9W12p6pz+Rl/Qe/pbQsdcb3lxP73rD8bgv0wPw+fp8cIF5g3x5gHqgPJA7GUp2L+UvCAc/jUagZDrR0OtejbqDi/THOwA27Y/xSX88HZynGl/eTNQvw+triGOH47tJ76f+VTdXk3BQuoAQdnzdve717y7Gw5sRPErtuemPKdTjR7HzVrocnPd7v/Yu+3eTaXeKjUbdyeTdcBwbirggYnxDf1I2BL/cjHv4dNq9kP+/g5n0L4bjX+nr5BcYa6I9xtFwPE2+I6C3g2Gcj9Fs6Pamg7dyDoDHL3JqRR4m8k8dZNTCiywmSQarmK4TR0dM+T3pJQ+svs9BHiID3bVqKh0ABkRXhO5iJtNKMzgr2otsdzp1cWI2m7CwdZqzpjE7OrKOmifPKJVMD0I90sNcrdhP47Ty5g1j/7NYLBNjIjcpyXztDczewOwNzN7AvL6Becw1WUuYJU69MPVW1A4+fY5T8QlzHZMtFSgVFOJBRj3KMwq29276n+Kmb5SRVPruCTmipj2dr8u0zuX1S0ooW0VHvHoUtTNKULAKG6dOyKYzEjMP1gpKRqjsxvPPf21Y5UxaKXueuQMnzoHElXuf00a4TFMY0FFt7GBsQRuTEmQmE5RlFlCiWmc/cjO+4qGnJoNU9LnxEWANdpDBG1mYpbtg7lcnKguGFR3BZ0e1k0bLOmpx3jhu1Tvt2YnFwYCdtE+owFuldoosQnboC0z52IbMZNn/BoLgVihYbUSABt+m9ft87D4fu8/HxvlY/M3gUbCD3o0cMD8Vmlr8wyehlC+zzZykN7VFUj42dVatYnZpxZeH+/a6u9fdve7uqLv5H8fqYLv6lVyf+rrrc+Pq+5VgEmuuj6/LFrKXMElGHmCIrFykn99NQbE/Chfbi89LLGN5Rf9ILuXru+wxP9SlBXp/Ri/9CS8QQaKjnIHcXDolvBOMS4+xl9hcH+3c82c2CKhb4CJSxmDlRYwDyfzIdWm7PzhgpicC9/tQnW2OTzSF6sqsiqyr2nuSe09yvxrtV6N/zGq09yT3urvX3W9Td7d6kjFWpC3KTwqixYLjoTRKnsvfqeaZQYPkprpY5YhVeW8FgbHYxyplPYfSrFGf1a2OIVomb5lHzROrYRw1eLtT79RnrUanlF7rX1LzQ0WRwseCmYhOTISeZ2bTfxFVc6JZU+dWpN8MNK9i9Y/2HRsnBVUnnseusHZJeUhBxod0ExqhTYO2C2yr6+uxAWf3YBfd3AEXgIIVT4yu8UPlxVkAXH9V6Vp4rEFdDhjfn6NGicup0BLg3hedoeM23rRnoc8HEMiDvQfr/Ireaao48sWePBvjjC9xxqz/2RACFT323NtF+d0BIO+jjZhIBm9I9Mpoh7sgABAQSJsV+517/3zvn+/X+P0a/89Y4/f++V5397r7beruM/xz5Q1t9s+hwc7+ObSt1ljsS51T6dWf7aaTqigMSLzj+vzEBye/AkQJEbqnW86XPJzDl8PsVZrxkdTgUF3qD01lDCCxi3wHeulDsV+AacCsxypf2lV9TM/1HuhU7KdmgQmSV8dQna/vmZE8z4jX6cpBqkRq30ZplqaPBpCEV5Vtpfjw7Vb4+r6FlReBsSMwB1h2oiSLHmMhP4QV3weqcuORLp3OzRHmduM7j0/NR10LvGEeEsiGeRSRb+tY0J4BlrnpIfofkF3AfQBE/LoJ8CYtsll4wQ08+5BuM0EfXWK41jJZdzCua6whNMRmDfaj4D6d4satjh9+fjd9kxw7UXcqCzuk6wDYCMSILF98kRl2osUouRm/m9lYQU1jlgNEYeqi83RR2RhsOJEdOwkyG7mD40/cvswz/TZca/7erbAz25eXM8uLF9QU5RHG26WeF0/N66VIfKehVZRuEjS8+TmDhSTtrTxeg9ckEVno5RtArRcPLuFVUvAw3oInCDWPA1JC4ZHdDjM0116MRwZeBeFl8XjvvpO3u2S6MWnlWDCnu/0HzJh7XiD+m9HrVVBVbu8j0LQXo0UHICqkEZVGLYVSRQ5ZsSvgRBJ+l6AYrhQmeQ0C+TAenu42pdr+RpwFu/AbHaD4LTNnenwLay22ND3jGVeK53DGASs4YEXaiUDhL5cyFCzQbZyDLGwmAegl/CdLoBBN2UUJq9DyE/hD6oPLhwGoysO6y1P55TQxguoTox+wddwGzDT64PEGIb7SRcF6jO/5UsTS2YM8BdfxdTxYRnN0k/jG2StcWv9u88UZd5MkC15j9tpWeoMl+fvY3b/I4u0tzT/R0iivGMWNhlXhQ1rIpUe3nvIL6HIH+D/8SppK7jfH43H6jTNpMEuHhyjTpNPG3BaULFgKTlegHuhbffC6D3UmVb3/6p6uPvQZXVE0sx28AoO9w/MaBpAYIzEsrwCov3sqJJsAlUf0yrEzzTiGt7JFLl4sDEhEC7wB4inumnZgRNIIQWDmCj0zeatT3EtrJIoNkoJq+oW/CIYWZpUhYE0x8YmxgIeBSilzeZ+wegNIMpGxkIXO2C7roj8FGySngtfzYCwIFhScKZEa4WowXYOIF2gFMC+IuT3//lB1Cg6xLdbpw+SlMDSrEAHS9Z1eEELgmoIbvx1jw1vjGB0dWrsoOM6q/yUvkVOLCUYBh0tMdOHcIhm5yJDxtrQpZMSoUgWNEGLMPTwYdVv68gUzIxhBPeJj+YIXDE2AO6gAZvE1K2lC7F9B9xqvoCtk7UeBOZDUewFVokO+kmd3Fn1bb53bQgr9Ur0X0uE/63Vx20RKv07vhYTcv/vt23v32xZx0C/4e6E07N/X9v/2vrYtTEvetPdCtv1nv19tC2WT99ollP2QpIwpTQsuFNkycpZkN7mrlOq1VneBUOJM/0UfvNXH/wO+hNgo +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Query Parameters

+ +List of Pending Approvals. + +
Schema
  • Array [
    • requester object
    + +Access item requester's identity. + +
    requestedFor object[]
    + +**Possible values:** `>= 1`, `<= 10` + +
    + +Identities access was requested for. + +
  • Array [
  • ]
    • owner object
    + +Access item owner's identity. + +
    requestedObject object
    + +The requested access item. + +
    requesterComment object
    + +The requester's comment. + +
    author object
    + +Author of the comment + +
    previousReviewersComments object[]
    + +The history of the previous reviewers comments. + +
  • Array [
    • author object
    + +Author of the comment + +
  • ]
    • forwardHistory object[]
    + +The history of approval forward action. + +
  • Array [
  • ]
    • sodViolationContext object
    + +An object referencing a completed SOD violation check + +
    violationCheckResult object
    + +The inner object representing the completed SOD Violation check + +
    message object
    + +If the request failed, this includes any error message that was generated. + +
    clientMetadata objectnullable
    + +Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. + +
    violationContexts object[]nullable
  • Array [
    • policy object
    + +SOD policy. + +
    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[]
  • Array [
  • ]
    • rightCriteria object
    criteriaList object[]
  • Array [
  • ]
  • ]
    • violatedPolicies object[]nullable
    + +A list of the SOD policies that were violated. + +
  • Array [
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/list-personal-access-tokens.api.mdx b/docs/api/v3/list-personal-access-tokens.api.mdx new file mode 100644 index 000000000..babf188d0 --- /dev/null +++ b/docs/api/v3/list-personal-access-tokens.api.mdx @@ -0,0 +1,87 @@ +--- +id: list-personal-access-tokens +sidebar_label: List Personal Access Tokens +hide_title: true +hide_table_of_contents: true +api: eJztW1lz2zgS/isozkMmLlGWZPnSy5bHdqacyky8sbypHdtVgUhQwoQEtABpR+vyf9/uBkiKEn0kO7VzrF4SmQIafffXUPM+0HNheC61OouDUZBKm58LY7Xi6VEUCWvH+rNQNugEVkSFkfkiGF3dB5dWmGOtcvElPyryGTwL7HyULcK53xxy2h3mtH1kBI+RxlNrMq74VLhVPE2fJ/XEIk/r5uGmE+R8apHBUi7mBGNeMlgRCxsZOUctgA7GM2nZVOSWcRbpNBURfsF0wsrDmDuMucMYt1ZHkuciZncyn7F8JpgmarD0k75TwoQy/tRl7F+FMAs254ZnIhemy84SWl0vWl3CgBedyRyIdxgI/BgPLNEG+M2F4ioHNmDlRDAjciPFLe6dFDkdFQERIJsVNmczfivo4SsZq+d0/ooZOZ3lXdB9xZ0lZ5CoNeIbvlPwDfxZChSsa1cwGQuVgyuxsxNUK+kL17O7mbbiMRHtTBdpjGKhl4oY9Anquw4ycR10lmXzCyvpEjCivpNq6iQYOXGfdtZX1wqIcwU85AWw4vhDfsEka0ZrMxeTipYZAaqxeYd9PYvPWaTLiMslujNu2+iRehRzURG/1I+XBFz3qFKLjuSTbIIPoBKkEZBiEp5aAeEbzUTGg9F9kC/m6DAW6KopuUvCizQPRqpI004gvvBsnuKKQXTYP+gd7O1Pdntx7+Cg14dPu8O9vUEyGRz0RfDw0Gl3xkSm5KxfwcfDqt++IRogvwXmLCssKhdVbXOuYm5iZhcq51+Y2zZxDnD1jx12dH7GLspFx3VCOa+i6Ob7WZ7P7Wh7OwbVppiSu5bLdK6lyruRzrZB1dt8LrfLw8I6MYV1NH7nBAXOQs/n62t1rd6UT9E7bTGfa4M2xozR9JVEijQGP1Axc2VBGztCCltbKbc5JP14a2vEtlLRAVJon61g2ULlIpYKNugNdsLeIOztjvu90e7haLDfHfSHvwSYkoG7uVZWWFT8oNfD/5rqfgch/njKxSQUYflROW7l83kqI6pi279a3H+/blhuDEefkLnI7NJzPfkVFIlZzaDQuXRcQepqdc7VXFansFZW2fe5xrgpUC0+OOGzQc8kC/zArYwYFtHX3YYyD/aSfhztJeIg2R0O+8PD3d5wdxhNJv3+YP8g4eiizr9fwiad9xSjXXbMldI5MktujRuAYQ1/mMcyBiYIyMgLqDwoVFOAn3Us3l6wMzDT1EEMZNlGei5azILexCe4MTeFWDfTen5ACEDULCbK9Yi9oO/WhG5KvczxFRDI9Kg1lYV00iiRxubExDMLAS1pFQMA6bhS2OZwTXbPW92HNr+yVcnsrjmqo/qcDzxN/WT8nuF+UocqMtTF2cnpz+Oz8T8RINVGrZ6CYC8JkZdJBVHU9B2X6/lwL+E8FmLY6+8lk6Ho9Q+iQW9v5/Dlzv80A7MCCliIVQp9j8XSzlO+oGhpMnTh0ibWmAA4pmfnPH9PtoVnEdDIRatCIMozjv4aw4owl5lojVD8llIvruiwGFgEZsl3Myi+0nlUBzCSQGABqbw94dxB0HpuVnQKBTPs7Yf9/rh/MBrujnb2u73Dg1+Q/TJzt/G/Gpm/gzzInkuhQGEqFNYm4dDZcgYj5I7HQZnM5nAkhD+mNADzrJjHhGyg8EKNBYh9fjQGkgBeHDbWKl3APxGQBdYXnpgPtQXgK+XTeFKklLid7yYLLJx3MxnNkCIUTwPJVrNUqynkTUCPEir6wud/0IYnZCCB3H6NhTzQWjLQROtUcLWcEj2oqSj6v5vGQcSIhnRKd0qGDyU4hGyONroA/HGO+INBRORo8w7xL51Kb6WVGDEe5GL2h88AMxIeiS57AwryXHTYR20+JwAxrEORzjmfA6OoYqRqsSko99yVlLoUiDWauwqo1aCUUNaYMvPWwXlTx+6Poq3P/eBxCVB/wAOGbdDkOJVgeXZqDLAYsg8iLwyWQd8WeLzPJjpeoLakuuWpjL8FsjwCTWKRg3GOobw+n/7eSCVCKL8SORTEcgQb0bFvZYy+m2nwWEeyrJW0rumaoIluH8BKDPI6+Y69MJgQDY8+A62zFxSESyVhPyu3QBhVQLTlWLEv+GSvdzgYJntDzgcHw/7+7uQw4Ts7vcPdQ6oDEO4YxrYFVDSP/hETB4CtVEO3JP8NCgG/AN0TA3T4y+Eh0Xgh9nJrKzE9vwwvTyCm2A/H52y4DzlOTQt6zqcrSlDh5cVaIsasTYTfQ4snVRsrZSk/OX1zdPluDE8+nP798vQCPiGttZuPI0gEKka3BFbBF2b6jjj2AmAmtgLbDmy+tzzVLRCIK7u8ULq/7ALa9Iz57AQ7/OktO5ZJs8TorBFKkbtpYt/LruhCusZnUIIg5U64dTkdl29hJM/z8J3X5BabQWEX5nWXHcWx9BcyEI1AFPYvMA/zOK5b9aSAUBbU/GooCZDnZLSCA2pVrpbFMrO8WzYKBgdw/ryfHLlrBhJzOQorb/Esevtgj0XnNLkbLymNVIotKZQgvB2AGqaNAQ1TuZPQw/p0RF0hJB5Vrqsy1jLYoXT3k2PmJNf0XcQL+4K4O08h/YQkWvXFrfDBhwnfZyOyRmkmn5E8YqDNflVlrjLwXd+6id1N7G5i94Wxu/plCXz8twR9+uvQ51LxAvRrqHiuQR8jHDpk5SKCN96QnaWb07cfxzXuFF/miOF+Q3zkSvka80eVPfwVXXmDV5b+2hbIIOnRSZBAJsIbT3xcc+xAIqlqZ/00QMATCQ6qWiAioeWFLqhZMIVSyAm3HepY1Ct/MV/hYQfUhYpDdyG4QZIbJLmpRptq9JepRhskuYndTez+OWP3SSRZcUXR4nGSLbKMm4XzNP89SssZLGDlT4OsCjky1SpaQWKswlhBEzkEk0F/0k/2IzGM+TDe2zlMBtHegO/u9/f7k+FgP1iu9Vd1HFdB1oypJXs7O5KKAcTdAo4rFDiXzbWOm9d/oF4jEkxrmHoq3Aw6B5XeVNhxcLiOHcdas5+4WpQIyTYwpKp1hDkN1ma41pRrYQFnU8iLCu9WJfCFriQzAVTo3jyVmaTgRSmArlmERwn+uO0CpR5c8KdIFaUFcEiZAC+28dw7LvG3wgQxH1AgBDuF7PwbolNvov8KybMPKPE7lJidfomEwECvkPtu2/0u/mBpMEdcOAM/ctHruh2uwAGgIXA5q8KdG3y+weebGr+p8X+NGr/B55vY3cTunzN2vwKfezT0OD6HBS/G57C222MVlnpDAwr/a5hOoeI5IPdmOooKQ9fNJQYnXAGuhAxNBeUQjhPtwXb7TCvOFxAwdDwVJoW15fzmvRvAfujyueyW001K39EQ5+1OS+LBCQEXZJC64sKNhuLIqDukSwo2En3YJTw6wKm7GoQrZ0WfpF+OAC50YfygeAenvrw/0WNgcw7NxCvrR6AeaKZ2RUaQ7dKkD8/J40dfH5HDEXlEjjb1PXkWrGfA5Yp4yP5N/ebCBaJud/ra+wt1JcFObbB22HtcNmA/CG6gJfCjnW8/jl9X40ixnwkWkiYmOVt938BPnmF5MbqYuvcEjho/lWDsMBxwwcnuCyHY1ZlXws+Q5D9AViaV4iZBiQB3vXx6mDf2vaZaR02BVG6oC552r1XITqRxw8VuDseLSD0eu2od2PlWJr5rD7LXK1w41V5FbvQmggBGEjy1pK1vPtzRC5foYQcFT5DqKg9uIon4aP7AFZVW+2Y+GvRCpNfk41p9pAmz5jbm8lb5MsEZi2ZaW/E3xtB1MAyupgVE0TezRWNtIUVEOOgtsRS6I0MZAiwk/t5BYCjnTHyCZZlQiQbApmIXkp/IshDzn2iO7FNDZnp8BdUTV8Y6+oqR+BWe8cAQDwxdDrCef1ec0LFwJBNnyDDonQMc1/anTOAZXcp5jlZrVify27SnHD0jKvV0cp3g/CdWDqg1J5gBVVc/+eGrPp4WVqiGssr7gFUNrvObaiiMK3pz/Fb3UVgs/2jyosRH9bXJe5Uufuss/Ugm+ePk3d8p420yzV8x03ici+5Gx/qGYNnJHVpbv8Sz9DoI/AvfUqQSoIZ2pX7XcZlMOSxMMR3N8FUxaBnmgueI/DroVzqjOAS4i8EvrCM0pRldAwxzaNhkiu86sI/QX6kIVIy9FQ5MANVftW+y6gnlk9JwAKCyrFD4RgEwUWSMg3s8Y91Y2qhwSQhaLSVKydyLL9WuMiLRbVAVXeoyTGbfJ3hPDC3okhGfOQtsaP0lMSgSLeJfVKsF+SBS8jJc14Tfz9EGzwlnIp3TWD+whePM9Qk/nY3XKAIxZUEu6KK1mW77TXYb1wIRbHWcM+x0oafDR3Ntc2hFl+jS+1qPvGG74lP39e345l3bZ9+19QUPO5XtOV6vof4L1zm5RvUqeKRRhdZnBobCFff3eAeDXdsDPnbvR2L7Cl6DgRm3vyvQNNXmxd3/vxd3W93vs8DboaVXvP0VUBDgbcHLXWrzTu1j79Q+ofb6ZeZa6zf15QpENb506O5UKcTdNnfrurRr7XdJpFLdhP14inWCP4K6/Qc86uHhPzmORnk= +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Query Parameters

+ +List of personal access tokens. + +
Schema
  • Array [
    • owner objectrequired
    + +Personal access token owner's identity. + +
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/list-provisioning-policies.api.mdx b/docs/api/v3/list-provisioning-policies.api.mdx new file mode 100644 index 000000000..61242e927 --- /dev/null +++ b/docs/api/v3/list-provisioning-policies.api.mdx @@ -0,0 +1,96 @@ +--- +id: list-provisioning-policies +sidebar_label: Lists ProvisioningPolicies +hide_title: true +hide_table_of_contents: true +api: eJztXGtz2zYW/SsYbWfyGEt+J7G/7Ci2klXXsb1+NNOxMy1EQhIaClAJ0o7q8X/fcy9AitQjdtLMbpvRJ1EkcHHfOBcEeNewY5XKTFvTjRv7jUS77DS1N9rhjjaDU5voSCvXWGtkcuAa+1eNc5unEe58WGvEykWpHlNv9L0YaieUiZtjq00miJQTMklENlRiEVGhjejGymQ6mxzb29a1aYvMflRG3OpsKNqn3TVhU3Fy9vaX9uG77rGQeTa0KVoLjJSq33OdqhhdROSHwV10aoFZp6KcGoLhu8alU+mBNZn6lLVBgYTQsdkfV1gCz+Bpsp8qGaP7sscjaeRANT7cQ/ixTOVIZSp1PIgmFYwlyK81DB7gn2NNdYlgwWxjP0tzBf6ioRrJxv5dI5uMuW2WYpzG/bxSlfAaF5oIqU9yNE6ox1a0t/lq49X2bry5tylfvdjY3I23Xu3s7vZ25Nb21l6DmEyVG1vjYC4MtbWxQT/1AY5gJmH78waaHEKxtvebijIyf0QKNBkRkOMxnrPTrP/miMrdvEAyTeWEVJmpkavc9xRrKrnyCiOdpuSOmfb8ejXOqmhWQ+RdVVsJbyvBvasKC1cLG/fhZ9rIKNM3pGj2SeJi1h6PYaZyhxS7hL8aa+y6i/iK4JAZIkVGCDknetLB4UFXmoLLiRhY6lBwTyznDl56wYzOM2zyJJE9GrYvEwdfVCYfkREOzjrtiw5aXJ4e+ovOcfv1EV0cds+Lq85Rh5+1z8+7b4+p9XF56Sn88vbs5PK0pFP+9V3Lv2edt93zi87ZtF/3sHN80b34edq1cqdz2L2YUj4+Ojn4N/X8V/v4beeXU7Dw/uTskHxoqtVSoPmQIqWQcRbpnLXXEtemW0tPa0IKH9FIN0a4fDy2aSZuZKptPmO9Mqm6lngD1wo8rYnbIbKbFL/BZCqlLCbj2Kewgviaz2MjORGw2GCAZj2LbOiFgeFj4ZWzfETRkdHQi+EFBT2Er4PHUL6Ui6RGr3ZVvKFEIEiDMMpHPfDgHdktcmXK5LHqQ6KYtHbBzWSq2PMjOxrBX6fMuH20CcI0Bc8ZFU5TlbC/QyFPDtj3RTuKbI75BAmqrxP1ZG0+opBixtSPw5ieytAHZHoqBFE8YwpW863Nk5ja5BRY1L00DkVZ0AiUc22C1j/P8+U4/lqeQ98nZCqDFInbS91oGe9gOYPX9HLQdRMT1YS4Nj6eHxChYyg7fAO1Kya0UO3Ro9SO68h7kX/2xJUjEI3CqtcmpKcHBDvU7htJFntKjxAtxHuiEE6pRy0je0MRjxFsityRYPJJ7ajia9fmZ5tzEIJEiLo+nlWDyOsMoGdCDxZOf0rFcBsCbjrjdHhZzgqYIvpaJbH7kvn6a+ZmSrXUspgHS+9s1aY/yJkeE0EwlqXSOEg3WsTDgkReNOccCmAyoQsaiyWsDlOSS/OEkEHJTEWgRkg6l0b/nitxdNg+Fe2iXeOe4UBf5gnhIPpXp/F5dks6Fexa+NdU6jrDwQ/R+4e7vk5dRmzet364S2S4/uEuZ14PyD9Vek9QLbF5/E5+8kIcDFX0Eew1djcqz871Hwwiy3tnJRxrEERlWbWb3i2l61kLdzaM4GR8YpJJAWrr4r5JJKGSmJEi/BKhAElTQvTGZnV3qOL5VqOi5AKiFCrh/+QlS8DN8pn+M+43xd7avcOw+ieZ5Etk/nMyjoh684bJP0LO+2nwviFvPlSZ1IkDMId5Kg8XYndqQo12FqH+g0QD2IhOmoLVpjhTWZ5i/hbaK4psoVAX9GzMtZY24Fkzy19aByzJHzGLcmDjR5jxDZJ/c5BKQhhCMcsROvq0F5PeRzYl3E0kC1tzu7qdoYnWpngtY3EW5DsIwvi8E30ErW78MEMhOxRdAMXLQF4wrHqpZO/Fxt7WTv/FjpSo0TZf7vb2+nJ7e2Nvd2+PRh8B3SM7L0rI9aHfKkyEOhKJRc2LGI5hKwndMwM8+ONzONN4ZBj5tqWYgV9BNTUB49cHp2LnpUikGeR8Xw5mlGCal+e16oNyBiT3hE8AdfXC+qqoTg47b9qXRxdcOPznsnOOK6I1twrRNkVAWkatQ3vLHAcBbqUTTiVQB03fzwPV5xAICbjaUPt/buKgTBECFT3C6At6VEn7Ob0aSpFfgBBPdUu11gAQcG8kMwD1sqij5s+BTtQ4ax4FTT4XQ2RZlT5riXYcaxJSJoIziC8SgDR8DaE9gX6OUFa8gmLzjNKQjmby3VSVdWtME8pR1SgUHOD8YT9pR1kO5ljMahSW3hJYDPYBz15zde4uKkpjlU5MRqUtrfGgILZpCg0LZFShMydCOiJzOSQeU7QrM1Y1T3K6e+eZ8RkS+Uzm7hFxd5og/TRZtPLBjQrBx/jSZyO2RmGmkJECIOHOoVVpriLwS7iyit1V7K5i9zGxO/vwLKx1FtiHoM/mPPS5NGEZmSbPOeiTsvcYW6w1/8HwJhiSl6MDRPrx/UVYrKZV70/jArp+I3zkp/I55tulPfz9HlerhbFqtiAGWY9egj4ykYr3me8pxx4ksqq250dDddvTcFCzACJSzUbVJ6/0pLnh2lO6NRFb5cyTLKwg+XVLzoDVtwMrJLlCkqvZaDUbfT+z0QpJrmJ3Fbt/z9j9LJIsueJoCTjJ5aORTCfe04oXy5BWCjQQxVt3UYYcm2oWrRAxUWKsRh05NHpbm73N/stI7cRyJ36xvdffil5syd2Xmy83eztbLxvVuf5qGsdlkNVjqmJvb0dWMUAcvZjIDZzLZdbG9eU/qDdVfUprvLxe4GboHCr9MMWOO/PY8dhmkA2EgR3TJcuLl2dHRB9D+zeg0Ft48ZMG1aG5zBhS8oKq+qRdtoKOK+i4mn5W0893M/2soOMqdlex+/eM3S+CjjsPQcedL4COO4IgVp8g1v8TOsbAHQTN+jAKZIhyqNcQbBxDFFyF1cdin4NMByorgV4NRW7tzaPIC2vFO9qGFsCSq61Emqm6KL2h7YjapkVbTXtvBkiRRiBraaBb8io9UoRJaZtHokea45gEAt100mz3M0jlY6bwt3IUbaIkB4ecFBJLa68WPqbhTqpP8A8UeB10gET9Ddc4g7X+1HqwOCOJj0hi0fkUKUUxX67/7i7aJdClHSWULs69rZdsF/Br5rRfyahPY5++Sgi6guorqL6a7lfT/fcx3a+g+ip2V7H794zdL4DqAQ0th+po8GiojratDVFiqTe84/N/jdg5VAIH7N7CRozV4ykGZ1wBVyKGgNIph9B5tv3Gukfrbv2uONJ2vz5/PM4fE/RlgecyTxP0HmbZ2O2vr9/BeDDafUuOdas4vWTsbSuyo/Wb7QWpiHaeumJ3fpxHXEq0T7uh9mixylNNXu1TIA/gDRA21jYcDMFbDj5Lv9ikztvpPZk12jocPIxvg80xyosnjlu32KPmZIRsl2ly/5A8P21/Tg5PZIkci9T32bHQXoDLGfGI/Q/Tg5LnhMP96HPHJadzC70B2Job7ISabYnXSqYoEvymmKc/vr94JgaEPjn6c0fAV2kqFxA/p3ARzm7tYoMIdeIJJ7X5YMiMt2tbcCiaRD+BwOLanCslriqHs8QZ8jSrlDopTg3U68PTwjKxulEJzYitqSbJ8XRs1qGhdVnr94xnPy4TtKF9+Xy3dW2a4lBTUqJDOdwmiMhVn7gaF3LJilxfy8Q/CmpNT63J1NyzGS68aq8iv6U7QkgTCZk41tZXD+7pNSv0qKbCHaI6ywNpIvBR3zgVFVb7aj5q9JpEr87HtXk/1Jha692Ez2TCDfk8TldEQ2ud+qcQ5DoUBleDHFH01Wzd0qBNjojm1kaFpaYfsqmbAIrM3xECw3hnkj2aqBmnWL9kwiH5K1sWMf8rH/D7tSYz377CfEotYxu5r+aZBmzSgE2fA1zg309X5FiIbZKB84B3gIOp/TkTBEYrOc/TWpjVmfw696GpIQKrTMWN9/2f/WmCC1eCH1Drsg1SMOHscisZnXsKtPgMTlVZxQrBrAbn+U0spsoZvXl+y/ecNH3+1eQlidvThRQ6f/Ots/SSTPLXybv/p4y3yjTfY6YJyJfcjYcNJULVyT1am1/WK49n4ilHKkNsFDD+AxaEYapk6ChfeVQxGmrFCwJjJTNCfmvkV3bEcQi4S8GPso8JDfhQYgqGJUo4nYBeS7ynE7YRVEzVFm3EBVU6J8vDnkPLp/wZjsPCcABQo1Fu6IsBYCIfCQn3eMC6sXZR7pNQOJXsGbIM48peRUSS25AqWlx3pCN30qeVYxSlFSM+MBZsWHxuAoqsnMycCnJGh3opEaBdHX4/RBue0xyqZEz1HjIowJSqjPCuezFHEcRMeFdh08F66OTWqS2IUKnjnWG7hSqPbo2ty1CcVuge8ZdQlnxWZebzEuVy+V/qcyphZqGSYH1MK1v8lQlfovga8Sp87YRE2q98+GRxmYjCYwg1Ube7O1oToZrpnm7/nisquK8+TEsiLiWLI9flUcmlentanFl9xm91qh9PWShGsYxnJtMKvoHLj4oK/1IUFMlgmtdnmCH/2K/gVDrOveOgIqusqt92yMPkkvk6XEB4ZKT/Alo2CCI= +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

+ +List of ProvisioningPolicyDto objects + +
Schema
  • Array [
    • fields object[]
  • Array [
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/list-requestable-objects.api.mdx b/docs/api/v3/list-requestable-objects.api.mdx new file mode 100644 index 000000000..03eb7f1e0 --- /dev/null +++ b/docs/api/v3/list-requestable-objects.api.mdx @@ -0,0 +1,84 @@ +--- +id: list-requestable-objects +sidebar_label: Requestable Objects List +hide_title: true +hide_table_of_contents: true +api: eJztXGlzG7m1/Sso5kPGLDYlUpK1VL1KOFocpmTLT5Ljl8iuDNgNkhg3G51eJCsu/fd37gV64yLJsiuxZvjFFrux3P2eC6DxpWVilchMm2gYtA5aoU6zc/WvXKWZHIXqbPSr8rO01WllcpK2Dq5atZeiePux0wpU6ic6pnEwyuVUp0JFQWx0lIlEZXkSpUIKGl2YsZC+76s0FTpTs1RkU5nZf3wZiZFCB55DBXiamHwyxf9KDGwfR0A5fNot3tjRZKLETCaf0PtGZ1Mx+NtgeDr4+fS4I94evzkavnklTCIGFxfDV2+Oj2ybRKUxOBGZ4Zl0oKJMZ7ciTsw1fgQiT3U0Ee3ihaeDtgAZCZrIRM66H6JBdCtkjt5o4Eum3XxSEbPkyzDEwHWZYKZUKZpNJwW/LFNZ4wWcuVGYyrPzV/8cHL0evuGJTEIUYkzqrROecMVMVgF1+aMV/iNeV80txpASNTDJhARGP2Vk8CQp5dOFXTD/KlMJWceXlib1s2TwLsIb/KxJDQ8LclsHYxmmqtNK/amaydbBl1Z2G1P7NEsg7dZdp6U+y1kc0jO1q+To5eZ+f3v8clvK/t52b3dntD+WW1ub+zv7+615ExyOoT2VYuYOs3Etw1yVpmii8LbBurGmXHJN9qDHGlItmf0QibYYBDMdwRzA75xqWUUSVlBaz/DIzmp7vjGRJ+d6Mxl2qlvRnqk2STqWaeoMw9xEq4YDf3Jk2VviXyDqPu4yFcko64ozmn+eqJn8BP5zH9wwe10xjCyLvoS+eAB5LXVIQ3dEDEuDujoCZOtJBIlZM1IkEtABmyGflhH+YL/QkTO8NA+zLtS83GrIGNIFtZ7okGytNkJaeG2lMuq6wf074gYGq4SSYIeekMOYSJGQzs9OjzkUHB4eX1z88+352cnw9Lhblywrl8bhqGLlrIKuuMjj2CSZdYog0EScLJrO5C0zHAQVs+McXRXbiMkzkon2VfdR3iCTRJJY2CsXvQROEuUzisxNPvCCGMR/x28uh5enx6/x/7JIrYSfJwnYJVO0fIHuReux3HVFq+6WC3PCUvnFQg65JKrvGj5N9HUWRlCf49AEyglkpXWoZPbkYHKiYf6+EucGPxcCR0ZqNzcpArRM/CkF/pVB0jo9JYFMwwBmMoOdGatzopTsqzY8GxeRTmZYJBf2KNulPWbzbuQWiq3Wk2BUcDADdld7DYjM4MqPcZxFv7GdN4oxGs5jH9bcp5ZXi2TaIXZdkgWrGbVGQFFJQnHHlJGOg0mdOesV0GDZhqSOrs2MW3ZBYqy8riD3v+d4hSTwzHGPvwqhtDpRHoYLjnfh5IngCbhA7HJcHemQYj3F8KgwNWd9VUZ2/miI25kMlBjdkuQNgaepDMdFbi9TR6VitGzItCvaJfntghqV1uchJRbh3qIJJgc9HbOr++VR1XOkfAk1NQmbSkpbLoWUjEJ341BPpjRHIcZvmESGiZKBnYxfuIEQ5UzILuoEDY+EAyr20qblYRrKY5Ucf+IYgT84hds8UKbRF86lnc8UzluXNPfgLM05rNuMqjWDWhlQ3QNrRy6y1iNnbcCrmjGWFvpxVQgJ9UxnC/HjtfwsYO8j+Cusq5Z6bVYEKLkAnr3625YYvB0KUBUFMgnEoQlDEIsxxNsSKX78aZplcXqwsRGoaxVSBdJNoUIGrF3fzDZ0EG3IWFMo4nE8vxzHqxDnCxbjDBEROsWfM65jlnp3KYv+zuYSX8e8aqIS9LTD2EdbfTyAVvWMHB39ZvKz/ZtHCdRYQgr8626VNM14nKpFcZ7xY5DtgvA4L40BeQeG/y7NYR911+Vc02bttEnwsZwgj2WqUSQV9vRc1PENyijFv1r4vsmjRdmTd2dJDrStM+ucsYnz0IoSbvp/3iWgaugdUu82F4cmQlCZIoq4dGUT/KI7UBF7Y/IwsGWsxYtCj0u9QX6ibW2iLW4ouxYp/UMEnWmCJS4McgqEokGKYEYYnU/lteKQmbBwqL2exdIHWtWZLQehsRkiKiammMWVJs3a5kH+hzlvE01Mra2L6kgdIcxR8ywsiPhZYkQjg9guo1bNTiygXGUrFnoRcHoUhmR0l96ID5hp9KG1Am+VlmEXEBhuFZJMb6MMQdV2G1nI8p8V9x8sz6DMc3S+IL2fFE/JnKqSoIAfY0Opj14jLIVByjZtV5FMkh7QCG1kz3b7QLTVv2CWUds+I5HVnnYgPrxZVO5KbEt03KuhWsQgJ5BeqohbUE/KW21DdoYFiEYl3o+tQBLJvPou7LPHKQ/acHqBJu4+kpBstGPE29/cpP+aYjl1iwxLFhggQt8geiPoopuM45DBrYk2fk2p75fHo2w7Ii0wJSSeTFuKdLBM63PxPVi2uFUAxixV4bgBt/r+fm9vc29rJ+irnd7Lvc3eTrDVH+/tb/qyt7PXI9uxJvjQzH/JEZE9Qps8ZaDTOERRYivBVSQ1oR/JDPo6V7b6dGubRIKPccmS77P6AC28TLMx1xjc7O16m7ter3fZ2zvY3jnY2u1u7u/9Y4F+Wg2g3lT4RaskeAMYXdACsmYmYHxCdFGlQ02LqPz1dO55my+9/s5lf/Og3z/o73V7m9vfQGcoYaslhXdz4zykzqPq12r1zUF3W0kwLnYarGWyDggaFSGlw4HTOgSqUq4BmgK8KyT4vBd9bOStahUKDWF4NuYF43VRvS6qf9iiujMf0u5QNZf7Ga7x8DEpCbw3nIC5L3XdmdODLjOYTFPja5Yr5MlVALC+vna7L/MBt2SXXoBUcxOp5FyNlyXW+b7NRLsq8CwJxLSsXu5mQCXDI44+f+8K3gfkmkQGHr1uaKRo12KZPiavO9vTQVO1y5J2Pal/twRe7gU9wNkg1MA74kQlkzw1XDjM4E0Pz39MzWgFMyHX+YoZJc/YHdsZ/1x0Sw0eAk/y+lBh9cPSftFcoYJ8j4r2DVgcRAETUAvZh1xLZul5iZ2XVlh1Ht5PFe8S1tIlfs1yxCC35C18N6rN37V6twpCDQ0XldtqxwWDd9RgexliPQSkguMc8zq0B2xV1eU1IsXIBLyhqiMUxdbGvhbNrkCtgcog1kNenHvIBE50pLxJIjVRaJfOfXR0siMhcX1shyzCBLdrOgUk0e2Jn2VQ7pgfOmZIjon0P2Gsx8Sud5FGf1F0oeBUJM0l0z64UUuQEcYtJ/U4U5YBzalfKYQv7YvQ+NDIvxmiSPIsIoAnf3zlwGM8MqTZtiWbjl6Rqc+0KSh+PnwrtneB5aJJzs/lZE4IkffuYhmcswOfJXqil+LPAv0cHZ8M3p1eEp47/t93xxeXKwDPICoyh+GFqKm5YYodAwSBUe5AHLRr2XajtsGQjNJ6Q21/pbfw1ZlwKybo4WZf0qM+tBgnZtZwJfabz5n4SXdVt4OkQDCcN8dGMuUEb5faCC7HmXfqJNl2a2wvGhs8vET1lds7lS4qUS5UJy6YnNaVQs4Byh+2k4Gf5bTnS2zWvbC0FkdiBYys5JrUXdaExiKlNQWfjpDQ4q9vANIByEY5F67ChSMu7RF4oqJdGbHqMZLD3WtLzFFm+B0DuYf97m2I8OMxa+WLa+Wcj6ubIpLXdr9dRHIL2ty5PD/jZFE4vl18WPvu2nfXvvtI351/ee7W6dxbhj69RejzLnJnxSh5LkCfRNkirDhQ9m+GN06RvJvvINJf31+6k2h0tOxzrPkQwnfDRzaVLxA/KPXh1lgLiFik/koXRCDL0XIwRiRSwQHTXVFsQSKLamtxthOTjDQMNFoCEakCFbcmt+eA8ijizZm0IwKj0uiPmduWKRd/iiN4nl3RXSPJNZJcZ6N1NvrNZKM1klz77tp3n6fv3oskS6rYWxxOSvPZTCa31tLce95NEWhQnY8pXY5VNY9WaDBRYqxWEzm0Rv3eqDfe9dV2ILeDl1v7477/si93dnu7vdF2f7dVz/VXlR+XTtb0qZq+rR5ZxABx18BxeQTjSjNjgubyX067/WM+SppVkBi6o1PqH0vs2N9fxI6XxojXdPjfIaS0gSGjSkYU09B2Rm2Toq2mbzMmiIsRnevRxq7+0/6mJ+j0guDDQ+S8xAXGTW69wZhWVd2RpOpIvZ1FR36Yg0KOBKEh1GxgWJrO94wJ82EERrATROfviE6dir4JyYtz4viUOBbHn32lyNFL5L6zbH13COITihEXVsErFnpttSMjGAAKAhuzSty5xudrfL7O8esc/9vI8Wt8vvbdte8+T9/9Cnzu0NBqfI4Gj8bnaNvdFCWWOuFD0/9pmM6u4ihg8xbG56NqQYXBGVfAlIigCX9bEctsih8btQNsXnUk1cJ+S1CehGhYnL79Yj+EvevKWHeLMxORueEjuNdbS6KOPYNBFoO4FeT2YC8d+LWTdFm6iSYKbLTjCays3TH0VnnS997xizMntyZP3Ae7HTpr44yJH4PMGJXEH1Nu3WXjWeARvL1LwruH+HEHl1fwYQdZwccy8d07F9oLUDnHHpH/kdQFhWMg1tc70HNow9QgJyVffay3uSBYbilcaFmlGirl+gsEnVGzvvhZyYROq/Duxk9/fX/5QkwIjHIwsKe+leYDLVK8hRlxsCuPeVInzj+1ewoaeynkXGIcQijCfVFRHL95gyxwjrDNYh9UVweg1+PPh8tGvxXfT3yIPHGkE3t83H4F7li035hcxQVfssbXU4n4QzGaZ0fzeDQ6m96gwor2yrdnc3x4OA0hw5Sl9eTJ7XhebTwqsfCERp2ngSTh6GjugPmF1p5MR2M8j8Zr0vEhej/V9I19o5uwgU2kU/6IaCj8qTGp+pMQZDrkKleTHJ72ZLJuaFKPPcLrb9ZI8uyUnvaAG5m+UzhGZI1JjihvM2wxQHRRYN32F9Ys4sIvfJT5lwbP/PgK6ZVaBsb/io8e5mimCT2a0LNxInX02+xFhgXfJh44DlgDOKz0z5HAEVqLi+4OhGWRn4ff4D6UPnwT2xCTxgf2x0EVBN1fgl9Q67INwjTB7nJPkE6murEohTWEVSwYzEtwkd7QIHPOyc3SWy5YUTb90fgljgfVugpdPPG9o/SKSPLjxN3/UsRbR5rfYqRxQJjMjaedO9tLRm4R3eIqnz3Kj3/xlj2VEbekT2aKT1vrw8ShzMim2af9qVa8PhArmdkLYMCCmbEfAhKXN79goAl/JJSAYBm6bzC64j0KsMiHiKn4ohMVGPVX46qwC0j5Ld9adFQoTtAJ5DyiY98gIp8JCfN4QLuBTv3cBiHUYpEqOLO3F5W9Co8ksyFRdLkMSWbp2ZgWklGj1pT4wFzQYfH1GwTJ30LZjxYrRs5VyFZG7ZoQ/aGxYTneVIUxlX+IoABTqjbD6+HlwogYLErBF8psk0w2XKd0g9piECqHrDFsdVH00aPYpBlq1dq4S276EvTt37xBfanWztcXf/1+Lv5yaZvqrY2YVhHJinJbI9p6/Kq1rB5H9TaFrdHrL19onYmK0zt6bD/3paoPhk99qi91Vxrc+pqvZ3LN1wqD+aRo2ap5Q5xbnmrx91ePN4Xf2tVg98iruBvtiZJ6Hldc3S8Be//XdzOV3/dlWPcIunah2BOF/bxuDrpHFMXFSE+Uw+/ryp975FheifTU8LW+v+fZ3d9zjzkUlzR9Uyz/we9p+UEu2rlHC9X1R0/Uw+/utpz702Z5V1Elzo/VnhrvY6EQ4ojEJY/tZnfaa70WzqLRKOXu56tjlPN3/w9cozT0 +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Query Parameters

+ +List of requestable objects + +
Schema
  • Array [
    • ownerRef objectnullable
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/list-roles.api.mdx b/docs/api/v3/list-roles.api.mdx new file mode 100644 index 000000000..6b637f502 --- /dev/null +++ b/docs/api/v3/list-roles.api.mdx @@ -0,0 +1,141 @@ +--- +id: list-roles +sidebar_label: List Roles +hide_title: true +hide_table_of_contents: true +api: eJztPWtz4sayf2WK82ETCmFeNuCq1L0EvA4nXuMDePfmOlt7BmkEygqJaCR7yZb/++numdEDsI2dvUk2lw/JYmke/e6enp7R51K4EhGPvTAYOqXTku/JeBz6QpYqpZjPZen0pqT+fl8pOULakbfCxtB0uvAk610NWSTiJAok4wx7s9Bl1KP6c/Bz0GNx+FEE7M6LF9i4wkbj8w+9wZvhZYWNRxdn5ncYqT8n19/TE8aTeBFGXrxmME0kfk28SDgwGrO577NYT14FOFc84ksRiwih/VzyELhfExGt4V0Ab+BPN4wsmcy4s4S3lZK0F2LJS6efS/F6he9lHHnBvHS/iePQZasovPUc4VSY6/k4CcwtNM4AEKHMbTuMHBgB4btb8BhhvvWkN/MFPsIeXuB4No+hSxHPoSOCGNCssim0uuV+IpCE2CVFDIcTQEH4xYO0BxsOiG7YVK6E7XFf9y+Xl6JcrgAonr3AzhJIGS944DBXd0AqIsBmsFcShquyHmvVaux7DlACyQXgJqIojBQPNMqegq5czlO1XC6CSwC5nlAz5qGONX2CEAjHTH9kpPjElysf+XFcP+nU6sdOs+F2ujWb14879YbdrXdqneax0xDQ2IhE6dTlvhT3ld2c972lF5c2+XoZxkIBouihJRnRWvJP3jJZakriaxoCIT6ugUxPhGA3b5vUfhIDSXnksH7o+8LGwdlVKo3vv1nE8UqeHh054lb4qGhVyT1/FXpBXLXD5ZHnBEd85R1JPY5lp+NYmVR/S1AswwiFCH4uSV2r2zTIUfC4tkPKYVoxFxF0VKOoR80GPAAOINalU+inKaAGcYTLEz/GP+4fonHoulJsE3lEjwFmrQFuAoobCQnDMXhRZdcyASlc52SFzESZCF5GxVnxuRdw4lUUJvOF1j0cQn41vPgdrEip/zDx7TAJtmkPhqscR4koMxDdOw8IvwpXia9ICbr7P9Y0jLlv9bF3GUm6CgMp2EJwBxSY+IANg2Q5g7/BIGmqK625CxPfYTNRMAqGb2hmykomyuxOIKnmAVDMIY8w8QJbkEEH64IWiAOjARRGiIBdCtiC3wp4DDwi4mB7b7nidlxhShEjARxbigDMMpkRkBQpcNYyDfIdYV5WhgqgVapMVMDWAHYiDTRfhQQhPjuEaBaCn+VBKScnyhY+JCvagz3HA76mLin3E0leDj2OoZZcBzH/xFS3GYpC8AeT9B8KL4DM0nB+i7x9bZ6SP0pWK/CBIvOALgwV3uFrMD2+I0luVTQURvIURyiXPadcPmVl8SuIXlBWz5CY6VN5p5/akUDvTi/mIKk+/DcX8K/QDZahQ0bu4RbhXQAU2DWlVhcO8YR+WS74y9x7Jn5lJAX7+0iJhHlULHJmCjWPW1Ig+QHfbYmZwGh/cXlBhDelZaKe7ScrwAISgwrTbK+wjL0FzlAry7zcnycUW4k5GLnY8pwvxRuKZwXYypikHa2hWK7idYVxx/GwETlkE+lSHK8C2BCcgwonOVguLiXYdBWPI30mCtJvwLqlriPz6sOBWgzA7BolsnlIajuJIvgb5kwCfgu8RBGu6L5rJTvQLAstjWCB0ICnoOC0GDrWZsd2120cW52mfWK12icNq1trNy3R7Ljt2azBReOk0hAdpwPRpNVozWyr5TTqVrcOzdvcdZ1Zq92c1Z7BK/BofuIIKwk0esTofcw1GvYtJr1bCAr1QfbIuamQR/lnWm5ANI/u1w6BkECH3LR65cXQ/W9IUBnJzWfEexhZsz1H6PIONMCZS2VNniS89lmbJHuPjxTwEmnRqNXwnyLGF/l1IwyKmMH82JCvVj6um6Dh0S8SW3/epiyPIo788GKxlLnn4ewXUP6t4KhHE+HKMUIbEnsKNM/ZpVybi15w245ZoOEwuG4DypJdYMtEUnzhCzeG2AkCjrsFrH7JSFCsE1AfWLYhh+88iXHO7hUXhSuK6EUB1+ugk3ar67Q7nWat3m7xOm/VRL1RP653UOuVYO6DzCKBAAsMIXfIeTieXPl8zXCAPJYlWhZciGAeL0qn9UYnDxE2YI3jkzZOrQ3i07MPTDBK3e9A0EzXnEVz4IEVe0tRJEENFLbWtGr1aaNx2mycHneq9Vrrf0lluTMK/HWqW6npfQFAPgd2mAGqz4CrMW3UTgG0xsNwFebeBg2FBzligr9NCd7kW/Z6g20ZdNdRwBmaUbS6MgGrKsA5gqZJkDsWeNIHw2B7egUM2EOMulTPReJJoAMs4SQE4xC8zjwGcmJjsASuw1t50kb5XnJhiwAoB708BrhAiI+Dw5wwL4wJP6Ab/IAAXI8TJIGtZjETL/kcIY3sBEL3yMPW4H8924sTB8yP8AVaJ1ijC1gpbcwJyumtJLwDU7CCngpix+NL8xw8O5ouYAHFW7vMRUZ8bdW29Yb6KlKD9que1S2Togbe5q4IcIF3UxoOzi6nw+lP29m1EY2P/XYaGJ0NyuwMWAxcbIM/fmUGfcXQxwarJP5d9iaFESi2j4lMEz2es8Nu8daJy2GNKVq1+ok7a4lavWM3aifN7v5264enbZYKpdkQ5A7eFCwy4BrCOjVWkSdnV6PJFB9e9ab9H8h1AiFppUnEBn23VUCjY5Vijo4meiULQPwucuvgswSLuBKQkZ6RMIyFC2tpWAwjobhtCymvohBCtbyoPe0Kn+/zhgODbI9mZXraAtiuCz6p1qm3j+viBDxR10VfVD+pd+tdYdscgX5IGza0C96qhAPRC9ikteu5etDr988mkw9X49Hr4cXZq21XXETnJVzTalycCZU5I8zGuy8p5EX4C/SBHzrpkhqBopgV+2rvnRO5Xl7AQPQI8IJPukf8qTla42fJYBHTs2wUpmJQlRbSCwibGAooK5nf38g+OAuo62A6UsY1x0Uycxdnb+DfIgvzL/Y0gsXZhoNdIVy33W6CIWw2avWWqDdBaRq1Lv3xmJQ8HhgU580LTRGC/uV3OeZVW92acB1xXBldfzeK5v0Qf0xEdOvZYiBWcWXQ/+6Hf/UG+K8f2twvyEpuUpIUjLoE5g3lwlshDpswPy4P71BP9TK1ki4jdeYxjc88WpiCCZhHnJY+8Jd2PdhYrVW1eZCg8tJdZxIFs2FqiKO5yFa1GmiSNTb3bgEMs6OVjfx8Jz+Z9i4HvfEAHhlf+uFiOJk+sKWG3Zi9gBWvjTD+JtSOU6zNIif0gbkZiUFBMMkBUQ3DEHMjYxHfhYQdpt/XWW6DElwGtFM21NtTmsxE4twMABcsWr1AOU2Aa6nJlFJSfEKWSUCElvp5RPcZHZZ84N60vcqlD2wII1KmIjeEszM6URTNZBKneJPOMNEEQt+iFikK6ucL54CoIJmhnOLLBkJbIpJusj4mJ2f/uu5dTODB5Wj6If2jP7qc9oaX+BPmHE8nH94Npz/AX2eXg/Q3wAL/H423RaoXsGzyglEzE+Qp1td0GaVdgFgfxfrxIHmXIaJohVQ0Z8jT0JDHgPwsicHpgqOhxD880k9AJ/MuAXP1KHSbQpPy8MVBdwWd8+j6ckrULBj/jQgoFd87nZtBCeVShrZHW7qpFkRCGy5JWZJUJ8gLb2EvK7R1rNFPn2F6JudZK5T+wSzmrfDXG248RWAXG38UayPxmkTr/bIC+SgjhWwDLrXX7engeBcxKHejLGYGcTpcVSy55yNsMkwiWwx3utXHpSwLTSc0BnOjcGkserBN3E0U0KxF/C6oUpxHFQa4aYQqjVvCirgkkDnx2J2MabTdJqdkzDEsSOudRh0C4C45wywndqPwy7Hj/YOcI8oQGd7iguP5xJlQM71cwUQtxrFIqyfUMNqth1k+11MWGuwCuzuKjuKNdG9qb2gxRevjVCQ8KhMR3GVB6MAcuhigYooK0r7YMgxICJWlqrDMLFaYsYoVljOKCmRjFitq6jQeNlwAJ2ni/EL+U20t7k4q2zzyhajawLK63XW7sxPX+W8UX9ydhsZ2uCS3svB8B9Zoz4mFH+fhwd0c3M3B3RzczcHdHNzNF3E3B/dycC8H93JwL39B93JwJ3+mO7nfzboLrLRqbmf/tywzOh7El5xSSrINUdykEVh6xHo0zm++mJ23/K4dVqabymzSkUjgW4CN8pCZkkYiS3FWctsJKdckDJWrdaoQDPSCak9DTKDCzMa3KvB0A6yZwpS4dQtWm1cfJ1rjQLTnE62uNlhMxvf31PhEZr+U3HbuAIKqYCokjln0gDt+frZfm9kP/dF4fHbRmw5Hl/D78vXwXHno/GZg+mAMluFsMv3Qu4JXb3sXBWcODy+GfRoJI6jem6ve8Dz/8wMMNj0b45Oz8XT4Otf44nqi34wuL8/609H4w6T/w9mb3kaQUCmdj96ejS97l/2zD+fj0fVVbrciv3GRgZ4+0sDDo4vh67P+T3083jLtTbHRVW8yeTcaDz5cjQAHHAlPv+A/1/TPZJR7NRldj/v4dNo7V///AJicnY/GP9Gfkx9hrsn1BU41PrsajafZ3zjQ2+HowmBu2NDrT4dvFQ4Ax48KtV1xJfLPKJn2wshi0pTBdJSvCsUSR+1FjFBdhndYzh1xkIfEjpNIPFBEkcn+IA6nyn1u7av+WWUWj1urPXak08NMBZCmi3DJJTuDHioG577H5eWLgLiWEK/umrIwY1wVerL7h7aE0n5PWmmzSNq0EYDSTKCZFJ/AYEqIZ005bK70NTVlFVV/YKKxgvnZNorbW1cIpy/m3F7ncAjc8PmLmWKZAJaYOuBrbCzCVbVuxF402/B6LgLQCtw5hPAfGqmNVrD1ZZykDEFSwMCwr1nE6UQDVl7biK0Ml0IXEGMJDp3pmAlTgQHDqNLwrV1M1L/UM1GAhQMHIfPDYA6839jGrLJ3CyxgALJLMx9VacgY/38XRh8xlIJgT1fNAuhLb0710YhJuvIFl1V0CdvgFCosxCdPwroIK8Rz5zi4z1ZJtAolOj6Kx7hH88gEgng1sT7ukUpryr/iXibqSepzr3I+KC2+QD7lLUW+wHhXQXF+71z31kXGBXiMzBSOlFTyZwxeMifGCTNVXxnzaJ4v6TClPnIfMFQXXZbTDwPXm+/axd2w74V5aLPZmyfa2qdHAFP9ebxmSp09iuU4XQg9ixqmrikyFkzXcaM2qBlVJKcPnjIzHfsFnqZF8ek42yTbJsUGCcEmedzvvxwNFOsVwge/d8NKtg7m+QLQqpm4P8Gq750h4Y5icn26JDt8IlaqdJ0G2wZqz3I5g/X0iSBw9O6Soq43vcveOf3aCq+2YpCBPhAj0+PCQNKEU0nbPAqTVXpyVhfU0+lifbrWEIkwrTJaY0t9VEPXgqgzGOUywYaniEZZCWsh44Hqqppq8LHxGx7wedY8jT6W/OMGNVXXTXxxjB47R+IFdKLvHFGqqMEo75EdVk6952ytTxobug+dclnZ34K73yJuKjbY5QWJmLTCP032meEqKoNHKx4S8rxIIPQ74ugM0NaJ3e526l2Ln3Rdq9XlDWsm7JmFh5vbdS5OTuyTYhleQfhfhxFVdd8XwgVjl2E9H6/TJmiwb0N1cmIPa6mVDl9sJz/NOPsZ0OpXbEF1vffXYkL3Bff/1IZuSsfBnB7M6ddsTlGet4ypPhK3T0YqO0r9OFnMqbfhgJIMZgbKJvNgXclvSXgyjdzN2ctCsHxTctuz+qzDm9axKxyr5TotizuNrtXR5cVtUe9Cj0bXnp3YtROr7vCO1WoKbnVmomXNmvXGsdtoddwGL73fzPNTwsAcmNlI8iP5sH1r18m+vu9h9v2MquctNt64Q8T4k1no0D0vXgDM8Qi1554BfMDEOAI8AxhqZ48th9ewzLdghUZlrqrg34aO2jTTahWP7ashjUjvyLcDJar1wumBvkYG5SziNur4bkXaSHYEdHrKdMHDTeZE8o5pRVvw2Umt22i5Jy3OG51WvX0867q82ax1j7uU+QHjL8HwPO0BznHdD4pK1d7eb0AQWLZL7exp8v3NPI2xB/1xr061TdHU8LJYfIorjLPv+1es1WY+D+YJPefzDSIE1vVkV05NDTyKvLn36L714Ox1z6QYdV4Tx9qVMtRX+oRkxhfhHUGsEcDjgyqDgDmKsh61DAjxQOYbeuovuQZXs2Tac0MPPfuOHvmh1RZhXpVIbz7F7BuvKqoVWHKnZ5hmXGbl1WVcEq9i60JTsqyv/vg2n+lXu2/SnKHijpPtn7kJZjkpFxomMSYRPHsj6ZmRcqvGWtuPizxTUDkA8qflpGfH6MgJzbwWptKiQcyuXFKU28xKZkQjkuK9BDZgQdkuO4wwJ8ZmgJsXS6bNETlUMDyBaZdarMKBCITmjQJmEIf0zuaJ3EPvrnwwPxahlr64FVr5qALBBIpZcshYJJ19pM7m2ipDC6P4qbs/6O5Bdw+6u4/ubr4c6/sM9FsKferboc91oK+wQ+e5FfpEQiXfzT13v6kllGIklQLoEOmf76b6Dj3M2n5aURHAl4uPlCvfAr6X8mNjFWhcf8YLBJDoqJMBYImEc0pwZxCrIJFI1dye7TUeBAcBDXaEiAlu+KzDhFZfURLQKp9DlOyEQgavYn1blErwkgWk7LZjqVthDpHkIZI8eKODN/rbeKNDJHnQ3YPufp26+2gkmUJF2qLjJJkslzxaK0nT79XBa2iQXQuWqtytKa7NRys4GEtjrFIxcijNGvVZ3W3bouXwlnPS7LoN+6TBj9v1dn3WarRLeV9/k+lxqmRFncrxW/GRSAxBHO50JAEIl4zD0Cmm/xK8MdBFs0bFeiZuBpoDSd+nsWOjux07TsMQs+lrEyHJQgwZZDRCmwZtl9jWFByoG2DUUX8wVV6oMtXeUsAoWCOiLv9F5UUsYNxobfVc3HrSN6VqIUtn0ZeoSbIEWLJCWVzuYWWmizEfjEAR7JyrS4+/UHSqWfS7Ink2Rowv6Lrjs0+2EKjoaeR+vCu/OwTgI7QRE8XgBxK9arXD8a66tIwojTsP8fkhPj/4+IOP/3v4+EN8ftDdg+5+nbr7jPhcR0MPx+fQYO/4HNpWayyNpV5T8c4fHaaTqmgISLxZaNOVh04Wg1MhBDzEunmcBKvx+0qUewneDHtT8pzgFCvlrSSAwM3+KJxTPDKAdmj7zZLKYPLvnn5Do73Hi4WXAqQaaTOnr0+sOEJQOor0LcJqzaGokUQ+vDLXh38GIQHhuK/ylVc1B1mD8I7uEL9t7jB5WJug1BuMppOounC8sVxNUiXWRlQ5r0wtTaAYrWuxSulV5Y+Ob842rMMEjCsNU8FTA1qS6TGAuYJlzCupb3a7pxv/N3AE3K4j//4pfPTN6w/goQZ5AI9d5Ht0LmjPAMoN9BD895lg5WrUtsQr82G4RmxsTTbCZg32veAR1grStsk3/3w3/VafY8jOHZjP6bArEBGyoj2zhfBRHWDLf3KkV9ikQa1lrg8IM/0FifwxoDH4AyIpdhJkgrDX/pfX80K/B74X8XNgsQEd2/AwWsA2GkV1eeLNyuDFc3i9FIh/mNEsNZpFo+HF+QUoFGlvbFX0Y4PpwCG4L4laL55cjWflxrPo0j8LR92EASmh4ShurdmGay+GozCeheMV4fg5eKfOahe6MWWmzPmTIbMXYSjFfzGGooNqcDNPQIteDBbViFmkEVajlgPJUlNangUBKcF3AYoRKGHiMwwIKB4KIVQMHKWS/ybOgs7/m04A/buAMz2+Ab+NLZ3QfsYXGTZgxgktnNBSNkBq+JVbRMEC3UYcVL0wCUA/4z9ZAg1ozuapsXZadRr+iPqga7ABVBpFrk7VH6eZgdO/GL3A1mkbMMEYz6ebjfgpMj0W+sYCsUwmYpOC2/D6IbjkDbopeNNMGLrpvxq+iHEvS9jg1ZNf2ko/YEn+Onb3T7J4B0vzd7Q0OsL2zKlOvRTJC7mK1rbTh9KcgIS3pKkUysNCKfseS36Ylc9jlGnSaXvhCUo8rASP1fdXAIVwSXoI4S4qP52qhIHmdHgzAoC5r4ukq+wdrOwCG0iMqzos1YBRfwn18m4CVL5CJrGBYRzDcxNJgPXuAESyZBzE4wnuOp60E2WEYJEXCIMZ3YDA0l5GI1FskBR0FgVvqx25+jrjHBOfmAt4aD5GAoSkYzPqey8ZImPhk5Rhu2L4/dTYIDnWQvgrOtYLYMEqMTfDm+F0a0QYLFB3y1TDaH6kO8kjbAuD4FJHCUOzCqtJuiUnlDGso3LjUsm5+crKxhco0jT8X+fLntqNYPx/tMJ0GWKVqPWIWu3dlCLzddIFYIsPPn/GFAoufe7xsfpWD64BgfT6xOyurzrkCXD47Ocf+dnPnVyma7o2v9uqsyelEi5392fn3+Rrn4/QyXzl9IUE+v/1pc5H6Jh+yfSFhDx8dvPr++zmI+Jgvq36Qmk4fDvzr/vtzMecTvqV1Bfy/fAFzEfpm31u9OVW9u/5FcunIqHC90BfSLyv6uuSjxBk90c3M6K8z3YyIPp/D/2Uk6WlgBpCba7mem2VHxV2mc7PcFHGH0hx6R841f39fwAtWus8 +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Query Parameters

+ +List of Roles + +
Schema
  • Array [
    • owner objectrequired
    + +The owner of this object. + +
    accessProfiles object[]nullable
  • Array [
  • ]
    • entitlements object[]
  • Array [
  • ]
    • membership objectnullable
    + +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 objectnullable
    + +Defines STANDARD type Role membership + +
    key objectnullable
    + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
    children object[]nullable
    + +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. + +
  • Array [
    • key objectnullable
    + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
    children object[]nullable
    + +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. + +
  • Array [
    • key objectnullable
    + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
  • ]
  • ]
    • identities object[]nullable
    + +Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST. + +
  • Array [
  • ]
    • legacyMembershipInfo objectnullable
    + +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 objectnullable
    + +Access request configuration for this object + +
    approvalSchemes object[]
    + +List describing the steps in approving the request + +
  • Array [
  • ]
    • revocationRequestConfig objectnullable
    + +Revocation request configuration for this object. + +
    approvalSchemes object[]
    + +List describing the steps in approving the revocation request + +
  • Array [
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/list-saved-searches.api.mdx b/docs/api/v3/list-saved-searches.api.mdx new file mode 100644 index 000000000..50f5b28ed --- /dev/null +++ b/docs/api/v3/list-saved-searches.api.mdx @@ -0,0 +1,125 @@ +--- +id: list-saved-searches +sidebar_label: A list of Saved Searches +hide_title: true +hide_table_of_contents: true +api: eJztXG134jiy/is6ng/TzYkJIeT1nHvu0oRk2U2HLJDunU3npIUtQNPGYiw7CZuT/75VJdnYYJJMZu7u9ly+dBNLKlWV6uUpyfKjo4WXRDKeO8fXj86VFlFLhbF4iJtJPIFnjp4da34nfFcLHnmT40hw37l5utlyYj7W2KOPzaxPzQ4894X2IjmLpQqdY6cn4iQKNeMskDpmasSIHDPkhK5+CZ0tR81ExHFEx4cx2JOo9m0n6DHjEZ+KWESaOJVI+5dERHNoC6EF/lSjkRaxs8xBlx4zGcaKxRPBRkkQsEjoJIiBi7jKrnTCg2DO9Ex4ciSBuXsZT1glkFMZVxgMm/GxDHksYHykkvGE6BgSKEBfCHb9aZc1LzusH/PQ55HPWioIhIc8sMuM95t3kzie6ePtbV/ciQDFrmoug5kC9qqemm5LP9zmM7mtLR3Xy+i4Cx28ZyMVsamKBMgFP6ekvCrIHolfEhkJUOOIB1psOeKBT2cB6Ke25WhQ5pQ7x49OPJ+hymBWMRYRjDNEzKPdOjyYylBOkymN88WIg6zw++lpq1z5pKwV3X/kDyxMpkMR4cpbjaFGIzKL70Z39b3foL0pfzC/iUqmS/hrrTY9lYSr2uyMWCWOElFhMgYbBTOeqVkSGMMUrPJ3d6BiHrgtHF1Bdc9UqAWbgM/CCpBVY8eSFZlwoKiSwGdDYRcH/ECOMi8AjbKK8bAKuxeovHEIOvRhDWEVZejhOBBDxzIcg7vHyAojQZjHQzYBh4bHsGqkLOwvpzPuxVsojdQwGtZwKkIfJg5VjFaiBc5aISL/Q5JXkCfi9o4HiTBawN7AdqJTbr4Lm0J5SoxqqFQgeOjkLIVGkq1Y8xjJgCLhVtF4VmjpOILFcJ6WDemUxmern2hcMrSMVEqm52EMvmuGDdEUwn+zSn8wQgJnruXzPa7tafoUTUYns5mKYmAP1U/BHUipe2yGQB74muzWZBcV6WOkUKmo+xCYkn6lcswq4peKk1sVJ21k4hf2xTngB/XGfqPm1rydA7fhiSOXH3q7boMfHh3sHjb2jrzDL46D+TB1N40LUK/V8L+i2gfAYJoFra9gJizmQ2DGwxQM/g8E+GwWSI+saftnjVQeV5eZRxHH9ZexmOrcczX8GdQKDZDeuiPKm8stswiVE0vDtfTLmc6zyDonJmcXbSyvwpovGvu1vYY7Ekc1t7Hb4O7wsCFcb3+4u7t35Ne8/QYaJam6fEZqQj3FS9MX5l4jhmld9gLgMMQofO00W63u1cXgttXt9drnzUGnewG/L047Z9AJGtv9/u1lr3vaOW8vHvTaf7tq9we3zUto+tQ8Ny1IB39dXp53WkQJ/mo1P142O2f5n7dAbNDu4ZN2b9A5zXU+v+rblu7FRbs16PZu+60/tz824VH7YtAZnLc/tmmWs+6ndu+iedFq3571uleX8KhzQl1+yv3MsZ49sszDo/POabv1U+u8fdsfNAfY6bLZ73/u9k5uL7sgA1LqdWl074r+63dzTf3uVa+FTwfNM/PvLUjSPuv2fqI/+3+FufpX5zhVr33Z7Q0WfyOhT53ueSp5ugzN1qDzycgAfPzViLYCJJshw/WzODE1DVxijX+cDLr5eIC5DkIWdun44EuAcC/UPQbniIM9JB5kOFEtWG1OldCdHp3EaoA2BLa6zjUgUFhWjDG+5Bt172jnsHa4t3/o7dWPvP3aDvzy+P7oCCLM7s6uA3E+lzSuDSma/2bBGHLl98QI8jAk0syXOn6Z2a8y3TlJmZZWOSanAhHEAhhZ8y73KwUAd0yGELXWJLU8M58nAriIVufE6H4ntRwGAoEAD+cqFGyYxEbVFKPZAEdRnDc4gAf3fK4RClDGZByFIaiiASMwaDSgIgYcUpgMOhqWGY8NL7GcknkUc3BODzYnY1J+PhiZlF1mOtjyYogrMaETqTnoxWfcI2SkVxJ82Wy5J6+fNIRaCedK0cqzTDwt7DNXvV2g/C+ryYPCMhZrnMxPIW5h1e5h2QBmx5KqN0vgdXJkeB0pu7jYRRuv7Ry6tX23vjeo147r9eP6YXWn1vhHPjTAwIEk0Zyp8qluXJPxIeA8I0E6+D/BuAx96Rn9l5unTk2ljVJIL3VOMw5B4f1EwgNyqxUzWsElxUnaEM4BB80AOGEQshDUSyIIajHW41k0t/MB8abvSxwOpQUVAKA/8GrweO77BqWaEh/DOyUBBSED6gMYXi1zKosIwIiF1mCRADppu8FaNZQn8k6SjWJn0iGUKDH9eWd/2BhqOkXKEKhguF4sTKFPuhQdqHUecB2yftf5jjdPCAWDZBquWSHbiNrPV23v0o0MbYJlhMXfYqkmYm7CJYyxuhe+KWAEhw6+8hKUkXIr1VODNctS6AlQOxLH7LagytstepBT5Tz3iH6Ox5EYU07HP3M6pj/v7I80T8FvRPS3qObbcizIMxO5LEGFL4PlYlyi9PJy/KZuLwVuQO0ywPU2BXk5VVPXWrKm40t0P6voG2sb4kvowbCfQw4tshnqlxF4TK3O7AJakR1f6lnA5xTAFzxj5MfHLAvsaX/hEgu5rnnGbnBKU6mW1xgmtFAPW5EWg87136ipT/Iz+mNRa97f31eF6Q415vY4AYm2Rbgt8iS2oxQxbe9V69s0levrwDW/jGbNH9VJPA1+yD9/n9bEo0hNaXEMPyf985fW509pjnzn26xJ0fw9moIpU8tVYktY4962QISEO+Yy1LihCTBmCuBEugYDGcbLAvByFlm2/cU+QS4SpbxSHKIg8qFk6foQCthwjiFaPFhIFvNvEA4gtnjCR20zdSdMef5VQ/evzLrY/Hd14FSIp2dgS8HSHbQNa90jGdnfNyaGYztBN7JbZPsVa4Q7UJQLUSnxwqgXW8XPJMcX1iJzxZtl+ciKzIYQ4s0l2dfX/mXCEBkrDe092L0VygymGZ+QvaF6CrXBo8Nj4B5QOuRqL1CJj6cIKpIxxPc70VdJ5OUL8/bfO/1Bnyh4QeIvxDE5hLYxc917zYszLD0jHo6JTKDuTRSlmAk9sHrCpLnAkq8eCsjpyN2pu7Ud2lUDfjSwnHEEOW+5f70GnbH/k7EQFK6aon07LxT2H1FAUNuUDkv+3IN4OAvUXBASaKkIciliwyamR8FOIHB7sYIgebOqFnCbGFoLkq3MgH3RaF+G3Ok2yVtRmTEHk/z/76BZZiTpGhqJC+gqbUqTnNkkTEv3bNFfdgDqisnXSmAcIbX76ooKMzMqgf3YxIZgw9kOAVGvlkS8fMY2BnazPJO1uxcRA83xo2Yi9M2O67OZacdUAZm1L5PvIPAG89Rm211kZLGkpnG5pV0Wb91O9moVvVi5D6gvJ+9wq/JS00azb9Ns7kmP/OIpix1lGqCmEjd4XRLLKyTF/OZoy+BPG95e1I2NNHaAzvLpb9OIiRIWmeYNJS2LU7yag8+5jY0TERtgW9qKWSFD+qSawuncGm3TmZk9mzZHZ++ysk6FEH2tQsyRWIVlxyV0GpKdX3NtDwrfV8uOhdJzyzzG2CN2G2XHFi1AAcBJO4oACLislzsdNOfgdJIBDunPjfGC20j/LQcZaxKVT5puKb90V3/5aCsU7jgCiAwcCmLZg4EIOe+kj+mMTukMydS1qV9xmxM0Ud1hH7gP8hr5WlYYtKCIe9+A1mv2W69CCeNZOgQ3jNPDqpJpxYHgw/3aUb0x2m9wXj9s7BzsDY9GfHe3drR3dETbTYCN+LgUExenPhOhiKQHqciDFfknKASAEejeIDqc/PV1MNF4hf5N6sO+mZiWX4avlUD5zj60LlnjgAUQfhJ6zsdLSgjdq/5K2QKSG8LdSI5l+NwBz0n7tJmeQdiDD6RVdqYgTaxRdNg0UffEsRUAt+e0CAhyVVnFUq2AQDzU+Y7S/KXnGpTJbASCEXb2khF50ouKMnUlz7yDw97JqqhuQeyFZ1MeAwQfck2hwESBJuDkWeyeW01W7H7B+yr7jWAst8+bqXK5sEiD3nl+USibPMQv2wng3QSYIzHzXphZi2XRrg/wbDRX5G6QUxqpdG42mjyzJawiRNN0bCBjzWw4olgJgSdM+2URK58dKNx9NMycxIraPJ7oV/jdZQDhxyXRsoY7YZ2PsqmJRrQa6TLZiGRfUqLBtle2XKnjm/pr47sb39347it9d7mxZ1/WsK0EfXZWoc9VyM0OBibPFeiTnSymnczRtFnILQYKsRDpL58H4NjfRIj9xcNMWhT9O+Ejk8pXmG9m62Ff40mL+TT1L9YCGSQ9GglGEImEf0x8LzgmRRlV7a7OdqqioQQDDUsgIkTNiM1VgkcELErCkF4R01vMV0KHP8b25TDa9TERUFKd5WaF1gZJbpDkJhttstEfIxttkOTGdze++3367rNIMuOKvMXiJJ1MpxyPvekdRtOO0nIGHRZv6Wcul9uQXqAVJMYyjOUUkYMzrO8Md0YHnmj4vOHv7x6N6t5+ne8d7BzsDBv1Ayef668Xfpw5WdGncutt1tGe0Ed4jpuEuKMZK+UXt/9AvZEYYVijN/ZS3Aw6r9Ieq8WO9aOSvU+l2EcezlOEpAsYMlzoCGMa9J1i3yjtSwfhY4iLId4ukMqcCsipACp0tkZXGNB5UQqgG83d5gg3Te3FiHSXPZ3Fbr9rigSBQtSMbw9KvGUwQswHFAjB4kn874hO7RL9JiTPeijxOUrM2g+eEOjoGXLfK9vf7QDzEcaIvlngNRu9ptrhIRgAFAQmZmW4c4PPN/h8k+M3Of6PkeM3+Hzjuxvf/T5991fgc4uG1uNz6PBqfA59qzWWYalTegnh3w3TyVUsB2TeTHn06pa/wOCEK8CUkKEx3Zefcbzr72znL/rT6w8G8RtekiiAPun7to+wRLA0T1U+k9X0ncpQ3dMFz7vdkoCDbwYY54KQ5Sfm2iheJzWTVEmxkUTbNYGOJjBqtm90ONk90mfpp+9lz1UCoY3IbOFbataO6DGwOYMi4kdt32I078styQiyXUXB00vy2Guxa+QwRNbIUaa+Z+eC/gy4XBIP2b/Zyr7l0Ee0bWZf+aLDIoNghVZfmayL3ersAxgBvttHhxbv/vJ58J6NEWOSj5u3s4XEogC85BJMhGJYM93Ax0GUVhZfS2gWjkjQZ9goAIGZva6dv6XXg2hMKsVBggIAjnr9zWJeGLfmcvaX0LWvW0rM1djHimgusF/PUrl4Tq63MvFDSs011FyihneaC1wY1V575pUbLxKkFh5o0tabJzf03Bw9rJzgCVJd5gE1YfkoHmx56aq9mY8CPRfpFfn4En6mSyrFYczEK6Yn9IWCDvMmSmnxv4yh6aAbXNML/29mi27GuOQRbr2WY8k1U7rSBThI/J2DY4TGmPgQ0zGhEQVALfSNS36llQWf/0pXVb4WZKbH15A1saevvF9xXX6JZ5zQxQldEwO05d8kJTQs8G2UwVyvIwNoLdafIoFlNBfzDK3SqE7kt2kMvVQGrBIV/EIM/XG8CHD2F6MG7J31gRDsHDuLoz74m1lamJkKykr3AZY1uMpvoCAhLunN8JvtQ2GS/G+TFyVuLrZLumEw/72j9JpI8t8Td/9DEW8Taf6IkcbiWzQ3mja9aJkzcoPWVjfvNN3PhX+hlTyVgDSUKYvv5uTJzAIeo02TT3sTKajsnwkeI/LbQrtSU/JDgLvo/FDcEaExXU6JgGEOhZoMgF6Vfcb3vz1QMdZU+KIEUP1Z2eKqD1q+pFfDT9KFAwA1nSYhXtwHJpIp3lt/aXV9qb3EBCEosUKRSqYIxmWjUo9Es0FV0EvW+BZ4d4T7wxJv8DivnAvWUNvNYVAk3U4yH7BZCNITAVkZ9ivC75dog+W4ExHMsKqDCApgSuRm+NgZrFAEYqG9p6Oi8bYdpLexLxDBUscYw24Vajn6kIHSMZSgObrN7Asu+e+eUbW0dAU/2xJ/5TfQbMRHqL49w30lugZhSgdToV07SxUaYP4JcIgtj4+46YDlyhM+thctoW7LrvGlL8SvZfP/14fSStX9TeA2QPYhufSyF11zfb0iv6+vnj2jiPSjbm/Uw+Z7Zd/f98qesYb0o3RvtIbNR8eWPzr2jK4XX3hbaPtmsbMEkf0m9x0BCPNmmNlqzo1aOYxFKtn231kbkyRfU3LYHzjV09O/ANpBT3E= +sidebar_class_name: "get api-method" +info_path: docs/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 'A list of Saved Searches' (list-saved-searches)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

A list of Saved Searches

+ + + + + +Returns a list of saved searches. + + +## Request + +

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_. + + +
    property name* object[]
  • Array [
  • ]
    • orderBy objectnullable
    + +Sort by index. This takes precedence over the `sort` property. + + +
    property name* string[]nullable
  • Array [
    • + +string + +
  • ]
    • filters objectnullable
    + +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/list-scheduled-search.api.mdx b/docs/api/v3/list-scheduled-search.api.mdx new file mode 100644 index 000000000..8f8f766fe --- /dev/null +++ b/docs/api/v3/list-scheduled-search.api.mdx @@ -0,0 +1,130 @@ +--- +id: list-scheduled-search +sidebar_label: List scheduled searches +hide_title: true +hide_table_of_contents: true +api: eJztHGlT40b2r3QpHzLjQsY3mKqtLQeYxFkGJmB2NmGopS217c7Iao0OwKH47/ve69Zly5gh2SSTuLayg6Xu1+++utUPVsynkXVwZV04M+EmnnDZheChM7OudyxXRE4og1gq3zqwzkWchH7EOPNkFDM1YVE2J6I5Iqp/8K0dSwUi5Dhr6MI8HJ1BN8B3rICHfC5iEeLqD5bEFT4lIlzAOx/ewE81mUQitpbxOKPHTPqxYvFMsEnieSwUUeLFgEdcZ5dRwj1vwaJAOHIiAb07Gc9YzZNzGdcYTAv4VPo8FjA/VMl0RnA0CCThQgh29e82G7wbsouY+y4PXXaoPE84iAN7l+F+/WoWx0F0sLvrilvhIeH1iEsvUIBe3VHzXen6uzyQu5GBYzsZHDvnwWs2USGbq1AAXfDnnNhXB9pD8SmRoQBGTrgXiR1L3PN54AF/GjsWCmDOrYMHK14EyDJYVUxFCPM0EP2o3YIHc+nLeTKnea6YcKAV/n583KlmPjFrhfdv+T3zk/lYhCh/wzHkaEjK8cXwrtX9Fdyb83v9N0HJeAm/1nLTUYm/ys3hhNXiMBE1JmPQUVDjQAWJpxVTsNp/7JGKuWcf4uwasjtQfiTYTHAXJEBajQMrJDLjAFElnsvGwggH7EBOMisAjrKatrAauxPIvKkPPHRBhiBF6Ts4D8iIYulPwehjRIURIczhPpvxWwGPQWrELBwv5wF34h2kRkYwG2Q4F74LC/sqRi2JBK5aIyD/IMpriBNhe8u9RGgu4GhAO4lSbL4InUJ6KpRqrJQnuG8VNIVmkq4Y9ZhIjzzhTll5VmBFcQjCsB6XFekNzc+kn0QoMtSMlEoWLfwYbFdPG6Mq+L8zS7/SRAJmtsHzNcr2TfoUVSZKgkCFMaCH7CfnDqDUHb4GR+65Eemtji8qjA4QQq2m7nxASrq12gGriU81/TQCBTXxZpi9sgoCs0ojmPjEPlg9x2n0O13X7gsxtjv9zr7db7Tb9l7LbfR6otnstsUHy3q8Rk3Q5hihgFqNBv5TFssICEhjpbEljJWrUROwchQ4H/ARAIQHgScd0rjdnyOE9LCqCjwMOeqIjMU8KjxX45+B9fACQuDZhGLr8psgRAbGUmMu3WrEl9FkwyPEs6yJRW42XNHpNbodeyL6DbvT7nB7vN8RttMbt9vdvttweh0yIO6e+d5CGwyoMkmvGgd6hdyLKxBagbWzgVL9dtmYlm0J18URuKwGBL4IFTAUE3CT4OdcJNvHAHBlDY+OT0fD0Y+YLuWsyJ4CeZq/m9ccHqWE5guxjJIcdsvpN/cb+729XqvjjN29RnOv12m5+w78rznp7VngWApe6kovTXhcp9werpF5jsOK9LWNoWW9A3cWkXemkTfSvUFvQn/TqJuUb9IHheeuTgrXK85GilYF7YoAwgsESteoEXnTp8WvfW0V2fhmHeGbkD8CV7hgroz4GCdxh4IbunIf8lJ8mCl6aeEqPApPPg+d8lLPQQ+VJJYxjVlKzk+RT5vZWXKeG9UJB6eqpJMTDPQQ5MW9cBKQ49O+pdvtTJrdZtOeNHjT7ux1OjYfNzt2t9/vNjtuW3T3HDQ2BxSFlOJh1f+t5VaW7Lkw147lXJTVs9Hctxs9u9UdtRoHrdZBa7/ebHR+WrHiAcsAoEEML87s/V6jyQz8nOFHMGyEyzyuFFmkBmkCuGKEdzwCyDKWVN8YYutVTnWuXCp9vmxOeByC59PsSAmt5EI6oyo+ro94yylfdRQpzz+GeACOG7wS5Lhxmn45SQiOPMZaNMtsslUQUEQedeC6EuFAfk1ZMFDFF2gc3HV1qqbrXMjiBWX9KokxSZaOWOOeTHQ6GgxPfoTf74+P/0V/vD07HX1Hfx0OTo5Pjwbn8Ofg9PRycHKyFMOyOctuYoSLkYr58SyqVLANAfjFrBOYVmJmmLHuZHgxYrYulzTvoLTB1IhhQsUhAjHlg3M3yTw4QljBMdWGBnE+OP32eAOM+E6ZKQdpXh3GlItiRZPGbe5PBVQ/vuNBBn4r/r+yRcrhJ2Fflpx5k8nNcC2Vm0ZjTdJHYwGvjD85BusyzrwoyVC4QkUjvTuipAML6xBAUhhe8jlPIJFOo2pAiylVgTJqTxTuGU7tNXmRYcf1KsMoCK6ip/Uey1kTu7RG6PDMRjOJKgd6S2m8oIGpzUe6ZudZgnmT2t6NpifDNuOuEWYqtCurDb968F8f/mu2iL1LmQY+cvlia5pb0/ybmSZq/RrDRIEPweAQ9A32Gm50gLvZoVFGAdKs9AaYBG9uRpfH+A8wi359d4n/vDkf4j8XgxH8g4p2c3F5elOxgom2N6jjuaVXLsjTJh5onasSEAL7lKhYRDvMkx8BoQ9W84OFy8IfDfoLgX6wWvvwo87YWaBV2VsU4OOAE3hPDTvTUdPdWqgwmemfmyRrkdoK+bdnu6Ncm3YsYMw6fwS2E24d0tYh/c0cEql9hmS90qS0VIo2RaF9H5fJmQEoXRPbAqn31qq6Sn+ieg6fzcVPYFDrugPgk5QvHRDZ6CcmXbRnKOTCUqmn/WOY+LjsK3FfZ4O5CGHS7qm4+++PKvz4GnwfeF0ffBms9wsaMDaS060/7QxVOP06Yqb/XhpIewwVnFvfikgROJzB/0/VunabdnjXq+WTReMdGUiBjZgV1gyylrHmSUw5JLZMohlt6MBkAR6juiQG3wj+j91KzsScS6++2Sa33dJ13VK0N58aZ6tiGvou9uhBNnJNxxS0y8wu+Z91+0EFrPX+EDxACR7Pg3hxrndMNqBB49lU+Gb7PdUY5UCEZHcz4edqovfyfVXY9n4RjhAlA48vfsAtqyMBEdDbhCUyy+AIzNI4G0QpHLpatWkTjMJmhrPe3YLgfyvFHXt1BxY4wx3Jwsx3w+Hrl5GypAfl9mahlVSy3lIkwLG5lV+X4UkEorc68iZ8hXtIT0g8Ykvb0ju9xNHSZnC1R9VbtOYohN6pfZXt/VJNativd2BrLNudK/lMxiOzL/26XrULmUbQYhTvErqdql2wQw95xY7DECKzzc4Lm9HafmljjI2Vu0A0pA/xTrov2RNb48lcUstD5T7Dn72RvrCnISRyqJuEsgMTQenUrXTRsenckECmLojGlYI7cqLeZN9wF+jV9B0aYjAyhtz5CLCGz3B2l76E+SydAkEh2xutWFbsCT7uNfqtzqTX4by132nudcf9CW+3G/1uv099OxFFfFp08lloKC/9LRqpdJinIEjLXwSGHg68JwRo8edHE4LxzHiix2ZkGnxZLO5jqLfYN4fvWGcPyhZ/mtBzPl1igm9fXlRtwGjAZ6Gcysr0KWubHr8ZXJ5Qxnz8w+UxZsgIa6VFPcC0hDybol3KmbrTFZUmANvTWerHagZqDQjiWCbkA6X+FS0iYGaapsAMs3rFjCJoNgnVvGRKZDf3YPyyLuo7EJDhGeRp4CzHPCJXoL3AwHFEENsnhpM1c7AEUqpfU4mUt8cyVq5kWMbxnRSFgsYBmG/Wk4ETJ4AckVm0wkxbDIpGPoCz5lwZu1GBacRSPCXhxJiU4v6KgrISExqgTULgMe6IfCU4Hj8dl3ms4qYaubu3GpmjWKeJDk+iZ9jdOw/cj02kZS9uhTE+6m9ob0TSSMVkPJKp6WmyGZWJKzV8fZRia7tb293a7jNtd/nluTn7Y95S6tNcTX0ufZ4Af0MKniupT0jaAyl4Okgn7VqQ1N8zKdL370dg2B8hfceaAjsA4rfMj3QoryhEU3mYU2Npuy0N/bksEEHio6ZgAp5IuAeEd44xMUqzqr262hsVjiUoqF+RIoLXDNlCJYwDy8LE9+lEYrTDXCUi/+vYnEUEi4gi7QGp9nJtfUZtm0luM8ltNNpGo79MNNpmklvb3drul2m7T2aSGVZkLSZPipL5nIcLrWnmPVLLGQzIPwrJTI5EtZytIDCW5VhWOXOwxq3muDnZc0TH5R231+5PWk6vxbt7zb3muNPCE7h5rL/K7TgzsrJNFeSt5Wi26sJbyOMSHzuasVJuuf0H7A3FBN0aup4sbwaeA0uv89yxs5o7nqoYaAPAkDuGa9qLl+cneqtAg0e+qSR0aLvXbFzQJgumlPQBiriXUbxNHbep4zb8bMPPXyb8bFPHre1ubffLtN3PSh07m1LHzmekjh2GKdYEU6w/MnV0pf6SeAJCARrMsb/8PKDpPhqzj3k4FXGW6JWyyFa/YgddKfaW+4s0WYpKnUg/Zxe6Nxg7x7FhOhYGcDYFF+njJ9FS6ZN+eGAKclL8goW+u0Y7RoIAbriwBxPcejdfcxt9y1YxJxoicgqewt6rAh2TeMBmgukfQKA+6BQc9W/Y4zTS+lX9YHaOFJ8gxez43hECbT7r/3arTgkM8aQbuosLLes1xwV0z5z7UEaI+0C7rywF3abq21R9G+634f6vEe63qfrWdre2+2Xa7mek6iYbWp+qw4Bnp+owtt5gWS71hg68/t4ZO5mKwUCfuKcDyHRoIc3BKa8AVUKEpnTJV8DjGfzYzc5R2+n1KPBSFwAanyT0YFx6Kc0DiAnE81jngaybE/MLX93RzTS37Qqng2dMtYGB23ITfd8N3oOjF6kTc0OJ+qudHS2gWW1OEFvZBThPwk/vlVhAAcI0mB08LW90iR4DmgEUEl9HNLpu6ZsslmgE2i5D73ETPeY+nzV0aCBr6Khi35NrwXgGWC6Rh+hfo7hA3gCI5HUJ+BxqLzVIUMZX18UxePB5rjFcGZlHGtwPaK0gdIbDWuwbUBT6ng2PyLz6/v3odeGAub4MSUgsHsCa3oEaka8bpMdFcBKFn/wquEHpQA7aFpt4wBRm7qIaGkadQhA4B69NbMdJghwFznr+tUm8NG/NzVMffJsdyVDfqhTRmPScP93OdRWkdPECXS9F4qsUmq2h2QQNL2wqYaFZe+XoA94OGDiC4F5E3Hrx4hqeXYCHFRY8QajLOCAnDB7lY1ROKrUX41GCZyO8Mh4f/Pf0BUJ5GtN+Lf2kYcicmVKR+CdjqDpoKlfTBCztxWjRZw82WYTdahRQsvWStrQhbST8TsAwfK1MfIxhm7IWpRsoZLY3JFnwCzf6S9YSzfT4CqIrjnSV8xl3gS3hjAvauKCt/URk8NfBCxULbBtpID+gFeAwlz95AoNowS9qWJWen8Dv0hwMHw6gqm+tCQ70j4PcCabfhdELHJ2NATeNWXd2sAx+MwMLI1iJWWm/YJmDq/h6CgLnEt80vtmuJwbTPxu9SPEgb6vgRSu/tZde40n+PH73D/J4W0/zV/Q0Jg9GdaNlTcFQVHKd0a02+fTda/D/8JYslRJuKGfyS0GLYAKPx6jTZNPOTApqDwSCx5gd7qBeqTnZIaTEaPzpTSVTumIqBIQ5FHTSA3h19h7qL98BFmPthcdyAerPyhRhF8DldygkdpQKDhKo+TzxYS7aWDJnHNRjg3RdGTmJdkJQivkipUxRGpfNSi0S1QZZQZ+7inAenU2wjwwlakGIG9YCGUamiQyMpM/P9e2cOSHnwiMtw3HlFH0TbNAceya8AKs/8KCQTInCCm+HoxWIAMw3OxcqnO6aSdEujsUv84F4rQztOtR8+ChQUQylagHuCX5JvHrf5LI+PeSd88+45dk4fczWdwNsQSEOia4wdDF3ZVUUc9f4bXQU49uHB+xRYGXziI/1tadYMqT31WXfaq5F9+91GXQlyz8K7Bpkl2WbxoClbyR4NiO/rJudn2BEenH1C/mwvZP5y7uT+QltSC/efqE2bC9W/oyLlZ8QQ37BdS6I67w/RT2h9Gt3igB6mm5aF2atbOsilKyR+O0xhMbH/wGoZKyG +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

List scheduled searches

+ + + + + +Returns a list of scheduled searches. + + +## Request + +

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 objectrequired
    + +The schedule information. + +
    months objectnullable
    + +The months to execute the search. This only applies to schedules with a type of `ANNUALLY`. + + +
    days objectnullable
    + +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` or `ANNUALLY`, 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 objectrequired
    + +The hours selected. + +
    recipients object[]required
    + +A list of identities that should receive the scheduled search report via email. + +
  • Array [
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/list-segments.api.mdx b/docs/api/v3/list-segments.api.mdx new file mode 100644 index 000000000..2b40fa6b1 --- /dev/null +++ b/docs/api/v3/list-segments.api.mdx @@ -0,0 +1,92 @@ +--- +id: list-segments +sidebar_label: List Segments +hide_title: true +hide_table_of_contents: true +api: eJztXP9TGzcW/1c0ez+kYVhjjIHAzM2NCyR1hwQOTHN3hLnKu1pb7a60Xe0CLsP/fu89ab/Zhjhp79rk3Mk0sCs9ve/v87RSHjydioznUqth6B16sTT5pZgkQuXG2/SMCIpM5jPv8PrBuzIiO9IqF/f5oMin8MyToTo0dvhhJngIU5qPEq74RHg3jzebXs4nBqdU1OFZKEyQyRRXh7VHU2nY4HzIMpEXmTKMM2SH6YjxOGaOqOmwD2rAcv2zUOxO5lN2dvHm34Pjt8N3TGc0nwN3GtlmQDATvxQyEyHMYAHSyd0yHWA25RlPRC4yQxJKZOOXQmQzeKfgDWkkkbk3z+tbfs9UkYxFhuxlwhRxbnAJy3vng7oUgl3/sEMMXeZchTwL2ZGOYxEgDXZeLX3zzTTPU3O4tRWKWxGjQTqGyzjVUuWdQCdboNMtnsot4+j4QUXHr0V4ySJQQKIzwaSCHxMyK4pZ6sA7jHhsxKYn7nmSxiBeb7cLVg6mIuHe4YOXz1KUGdYVE5HBTEvGPtrpwYNEKpkUiXcI8xJ+b38mKqGIOGiBfnt83FyuTR1FRiyq84weA9ugwXwqWFSAoaxWwe55h12ZAmw3YyYVgYwkmJNMv0HW2UDFp3wiFc8FzM90MZkSHWeYL8Ycv8EYlfqfVn6gC7Wo+2HENvKsEBtM5qBVUHyq0yK2qhRs4x/+SOc89o9w9gaqNNXKCDaFeAf3JzvgwCXhMOVAURdxyMbCRQZYTkaV3UB/bMP6xAa7E6iqiQKNhWAxsJlUgaAAFiaXagIJIUdWGAkC0azYlN8KeAw2IuXgeJmkPMg3URoKf7AY5I0QFlY6R08xAlfdICJ/Jck3kCfi9pbHhbBawNHAdmFKbr4ID0J5ljjRWOtYcOU1/IRmPmJqLk1qcEKv28W/2j5yuiQPA60AqwG4FIznaRrLgBjc+sngpIdFLniWcfRHmYvENJ7r8U8gPObjDJWVS8uKDBtjTJ6BCyx47wg8z3H0wrDhMWqnUobXjba3ox7v+/vBQd/vj6Mdn/fGob/f7+2+6kZiZxwK77EMkE9ba1wYqYQxDCe3l3WD/PvZr0g9gNKYi6XCVCEdwgg/l8DGslXxBbubQsXLax7QvR3p9vK9bq/rd7fhz6jbPaQ/nS799y9kJ9EhpdD/Bj8l7U9iqEX/04yg6TGkhMag9tqEKkoOM5GCs6P3Mmcbfacgty5xRQUliI/rkFrkgqZiVBCisBM7C05s6S5KJRQm7mtveHzybjQc/XMRD50RfZzXYSQFKBZSaVIYSkwCEi+8j0WUM2QW0Q8WUchwL0qiLxgkJqnSAvKhxuF30mC+7He77FsesgubW5nIMp3ZtGeTd1uHFY+PmysF5TAEFRP+Ctt+EBxsv+ry/l7EoXaIfnd7Lxr3RXf7VdDr7u0crB6K3xWQ7H2EnGgjFkqTxnxGoWgt4szTYcOcJfAGFNbSlIb6k2MxUqCO87PLET48H4yOvoMpESqSKggpGyIisDUO0HCGfmTLRHMh8MUmE79J3aZIU53lHhRyD9RIz8gZLkQENRKKXAWiYcStNHIsY1D3EWBekUnKuJCpzyICtc/nWHGPEWHaoffEWNsq6Ozj5jlzI6mAoY4ay9SuP3h3DL+d/P1qcHqJ7l9rwD0D6XgOK4yLfAWfeIfGLxes5zXpxtqWqIX4Rj2iTVfJBKvF95KkCSOoiJasWTdqMXg5uhi+e+MtYecZws8RHBQInVqu9AMNwro0lXEI/rSkQj+f/Uo4UFvVrF7V11701XtRtcpHiyhAW4DxDmpzNSOwC6gKU3NJ2FU/Spc8vuMzg4ORdCtt4oNH5LB6cn3TZPikdp6WHIvpE/unOcPeoBMBPr9tKrMJqhc2MtxLKDAh4mJhEC9RxZ6HcLamQHNrF4D6o+xPFdS2bY7STESRAxltGD/XADTlc6UCZCbl9JfB+6NYIjMnVJZ8KFN1p2a7aFu2xjqkLRWpwEMkYbxP7QCeyAmhyKE/OtLhCr76GlC3P8m4RA5tJQ1gIgOKtzLENpGcyJIsazSNa1dZ0ERnu1WWj5wwqL2MBz8DreEKaOdKSZjPyikAeuqEtbis2Bd8vNc96PWjvT7nvVf97f3d8UHEd3a6B7sHhIES8FM+aWaGKjG3l34jABXIgGFGiuWvoBCARKB7YoAWXz0vE40Vc4UdW4np+GW4NbgJeOfbo3PW32cxV5OCnvPJnBKUf3W5LH1awmeZnMilCaVM+scnrwdXpyN4cgFZ/uQSfkJaCxh6UAWgJqg+1XfEsRPgjmNvgJ03tCxsw1HdAIG4Ms2B0v5mZpCZEuaCD2a41ZfMaJJmUaaTVigFdh+VfSM7orMJ+ayCmWNuYIK2ndXGIAhEmvunTpMbbtflZYcNwlC63ofytSlhLg9Di2vtRhqEsqBNGl3kuKchg7lmtVblfLYuU8hp0ygYHMD5x/1kEOQFMEdiNqOw8hbHYpkgQ6e5+fatVhqpdKZyzI4BbQcGGnJnAJkJZJOQJ106YtTyQYdQjqsyVqsgIDdvLTPHuaZ3AS/MCnF3HkP68Um06sWtcMFH+8A2G5E1ZNWiUkZyW5w02Y2qzFUGvm311rG7jt117K4Yu/MvL9ympntL0Gd7EfpcKfe1CIvnAvTJyHsAeJWDCN44Q27iloGDSN+/H7lPUjAe2hTcnP0d8ZEt5QvMDyp72OdjhB+VsVq2QAZJj1aCCDKRCA+J75pjCxJJVTuLq73W2ViCg6olEBGyZsZmumAcVJYVStF2vdlkoRZGvcjdRj1EhDE2A+KqKvTtnvgaSa6R5LoaravRV1ON1khyHbvr2P0yY/dZJFlxRdHicJIpkoRnM+tp7j3t0TIYUJ+YqEKu2pVtohUkxiqM5bWRgzfubY+3o/1A9EPeD/d2DqJesNfju/vb+9vjfm/fa9b66zqOqyBrx1TD3taO7rtqdgs4rlDgXCbXOmxv/xX4ATXCtIapp8LNoHNQ6U2FHXsHi9hxpDV7y9WsREimhSFVrSPMaTA2wbFZOZY+0k0gLyo86SGBL3Ql/AbtswwPqtBxEgxelALoZjN/EOUgijuk4pysWkWqIC6AQ8oEsUbUrMGxJG5DR4j5gAIh2Alk598RnToT/SYkzy5Q4lOUmJ3cB0JgoFfIfXfZ/u4QmM8wR1xaAz+x0Wu7Ha7AAaAhsDmrwp1rfL7G5+sav67xX0eNX+PzdeyuY/fLjN1PwOcODT2Nz2HAyvh8F08tsgpLvabv7/9rmE6h4jgg92Y6oBMEYY3BCVeAKyFDEzptn3K8r+FtmebVDoSClosii+FteWj5AYwDRnns8FR2pDvKp/QdnVy+3Vl+3MGFHiSrsLDnofGctF2kQyrNJHqtTXG0gFWwO8bgVQekn6VfHvCb6QKSGpHZxCMxzoPoMbCZQvvwojyZ+0gH4udkBNmusvjxY/K4895PyGGJPCHHMvU9uxaMZ8DlnHjI/k19E+cScbZdfeE+Tl07sDfrLSx2hsN67FvBMzyGQp8rvvn+/eglmyC6pOjGQ82T8mwpZ+fgIpS9BuXWPU6iglLfshi0Po5gtLAoBoGZOzRfHgd9B2n9AvIwqRQnCQp9nLX6kXnemvfEEfkPymfHMrMn6g2NcSLaawTXaSkXb8j1uUz8paTmW2o+UTMv57iwqr0O7GGbAEIWSfDYkLY+e3FLz2/Qw54JniDVeR5QE46P9ietoLTaZ/PRoucjvTYfH9T7qYTS2Z7GbKZiZkr3RIYsmGptxN8YQ9fBMLieFBBFn83WHS7qU0T4vW6DJd8u6UsfgCDxdwqBoawz8TEWYsIhGiCaCm1I/kiWhZj/ka6u/NiSmR5fQ73EkaEOPuEeyBzPuKCPC/o2BxjHvy1H6FgQ2ygD5QHrAEe1/SkTOEYbOc/SWprVifwWzcHSEACrRMWkh/aXwzrBuZ8YvcDR1RhIwYijq498dFvE0sKa1FJWuQMwr8FFfmMNpXBOb5bfagcKy+OfTV6UeFBvlJypePZ7Z+knMsmfJ+/+QRlvnWm+xkzjkC26Gy3rWoCmk1u0trhtZ+gqI/wf3lKkEoSGBqW+vdgkk8Y8R5+mmA6mUlDDnwqeI/LbRL/SCcUhwF0Mfjzci4QmdBsrA4Y5tGh0qLjD3kNHpQJQMXZTeEQCqP6kXVt1CVo+RyOx49JwAKCSpFB4fQaYKBLGwT0+Yt1QmqCwSQiaKyVKyegSCqtmlRGJboOq6FBfkSXmLMKdYWg6G0b8yFpgw/IKICgSLeJumdaCXIiYvAzHteH3x2iD5/hTEafYz0EGBTAlGiu8HY4WKAIxZUAu6Jt1Ntlyk8wWjsVz8CC8dYadDnRx+CjVJofms0GXrjU0br/P3UurdsD/iJvqrmYg2N9KcU8KRShs82G7u2vPNK7WT0E6fPbwgFsV2Oo84mN7Ixh7PlA1enN9hfRJab+su+5LFfWzwOa/vMrv2nuPDvqvrof/r0vqz+ixusT/mYpc3zj/8m6cP+MO5T8rUHvDTb1PQrdwIB2R6Sjx2El2y7Qxa+GjIlKptrHenGDK508AaPcDXfh5/A/JThOy +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Query Parameters

+ +List of all segments + +
Schema
  • Array [
    • owner objectnullable
    + +The owner of this object. + +
    visibilityCriteria object
    expression object
    value objectnullable
    children object[]nullable
    + +List of expressions + +
  • Array [
    • value objectnullable
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/list-sod-policies.api.mdx b/docs/api/v3/list-sod-policies.api.mdx new file mode 100644 index 000000000..81fffde7f --- /dev/null +++ b/docs/api/v3/list-sod-policies.api.mdx @@ -0,0 +1,108 @@ +--- +id: list-sod-policies +sidebar_label: List SOD policies +hide_title: true +hide_table_of_contents: true +api: eJztPGtz27i1fwXDfthEY8p62/LMnXsV2XHVcezUVrptncwuRIISdilCS5BO1Iz/+z3nAHzpYclJurfZq852VyaBg/N+EcBnRwsvjWWydM7uPzvvtIiHKkrEp2SQJjN45kg/OtPKdxcqlN7yLBbcdz48fjhy1ELEPJEqGvnOmRNKndwp/y2OkkI7R07CpxoB3N2cM3q8dGCWL7QXywXOg1njmdRsKhLNcD5TAeNhyHDGwgKqv49uxW+pjIVmsQoFjrm5vfxpcP5mdA2rLHjM5yIRsSYCJEL9LRXxEt5F8IZQm8vEWV36Df/EonQ+ETGCBPBpCGgkCn4maRzBundCsPu/tdng7YjdJTzyeeyzoQpD4SEM9jZf+sOLWZIs9NnxsS8eRIicqWsuw4WSUVL31PwYuHjMF/JYWziul8NxCxJeskDFbK5iwWQEP+fE3zrgHhseAKcDHmpx5IhPfL4IgbxWt3HkaG8m5tw5++wkywXSDOuKqYhhpgFjHrVb8GAuIzlP584ZzJvzT+Y3QfFFwIEL9Nfj49Fmbqog0GKdnTf0GNAGDiYzwYIUBGm4yuBFnb3TKch2yfRCeDKQwmcfZTJjNZJODRm/4FMZ8UTA/Fil0xnBsYL5bsTxFcLI2b+d+Z5Ko3XejwJWS+JU1JhMgKvA+IVapKFhpWC1v7tjlfDQHeLsGrJ0oSIt2AxsGdSf5IADN5jDjANElYY+mwhrGSA5GeRyA/6xmtGJGvsokFXTCDjmg8RAZjLycB6QoRMZTRkHQQMqjAhhHo/YjD8IeAwyIubgeDlfcC85QmrAPcQCJDYXkQ8LRypBTdECV60RkP8iymuIE2H7wMNUGC7gaEA71Rk234UGIT0blGiiwPvxyCnpCc3cqiuBDMktboClkxiE4TyuKtJrmpJLP9UoMtSMjEqml1ECjtNMm6AqRL8zS/9k6ALMXIvnS5Tt6+wpqoxOFwsVJ4Aesp/cEYBSH/E1uJ7Q16S3JoKpWJ8hhFpN+rXaGauJ32rmb2Rk9QmgluSPnJLQIEwy8Rt770y8Xr8dNE7EyaTX6Xbb/V6r57W6/W7H6552u533zrrwMZpmRqlRTK1GA/9TFc7VtggJAD2M2eAZYBJfLOA56dnxLxpnfl5XAB7HHFVFJmKuS8/V5BdgOIbVGJmTSIOP9NeVZ1V3TIhnMLTMlkbQbAYt3nFPvH7H7UyCtstbE9896bS6p41AtCe+IIZw/yYKl0b7HzMd3nPNV6ioQmt2jbPKy5ukxf20/BcquwfLJGIjLblj9mGEm0iCs5qrgDuFF+zjTESgVKBnuRiWqHUWfL2CQavRariNJvwzbjTO6J96g/73z010z5VPwfHfhWMG/6uQrKy5S0Y39ANcfukxqjFaZYFbBR3KCi3OItIp5n7gIECvKTzAZBQoKAnkGHyS+UxATH2MRHwrgk0avYIVjvxBg7qC2UD2W1/TeTN/J3UWzvn4huFI4muEAf3eGZ1fXI9H439g2lsQlz8FfPexq1VM2eh8RXhev3na4J1ewCGci06j2QsmHdFonnqtRq/dd/Y2p2wpX+pFyJcMZ1XXujOO1YGg4wAy9IxmnScK14G6QcQgbGOYIAlICEBkz9CSCwvBlgysgFHG4+//+GehOGtqYN78lcLhzpXvBI+9GaPguUMv/4d7HriZF9I/28OvTV+ywfU5e96k4CU5KlB2UHyOKROWY1D46GfwsDydeXb+izcykVPzLIP5skLen00mBjkYn1IW8CDFR+JHEnMAZyK6D+m7hh86i60yhrCnUopNhZW+d5iA32opxCYReSqOTWgf+A/yWRpSTGXczC0T8YpDtsdUZIoHWzDi7wybo4xASBNmlNnGYq6QcpKTSSLB/2DymMXpEqm/qAnUNpGX5XFrlFGKsJsccNAA0CQnhXsWmCR6SECMCJScycX165vb4cU5PLq+Gf+U/1nxLfnTx6z8Xov4VSxwkCWucLm5y8wB3zvjwWUTnsB/Wrjkat6QJZRZkFXxaO+U4QcbOQGL0fk3SR5skHseDtmkL0SiqgcbkHqQKqSsjPzlQGuok6CqScAWAzlFRFdBPJ2T8RzCbRpuVLhMdd4MrgeXF7fw5G48GI+GzhGutNaLORcJpOOQGU/QmFEvc5Q1o8gKRZSFxdw8HiHrjEFBgUXw4eUlGBR4cYzWl1DLL1CfR3ZChbsFbk8Gc8h5bwJq8BzC+u8f1ldV8/FDeeDfnlbsR1N/+qCkZbaUy9kyslDcYi7PMv/IM6804xqKechqc2glJ1mtnVcK5KM9hb62JLhEkxZMTFCJMZgG8Mq0Mky8oHflqty5vLi+uB1clVSmeDK8uX59NRqOR9eXPw2Gw4u7u59eDe5W/Xg2ngJlvuKAFhzGEgtd/rRZVJU+FEFSnvf06P20Ki+6cHheZ1umANYwLfUS6utWdG2uIrF0ZWQKMoMTlrY7Y1VW/2aT6gyqHWysaExaJBUVTarr5/wT/tFtMIpT2KNA3BCVuum5jUz8alIH1P6BHdA96+Ft+lQEa3AFVxdv4L8bet4wKUtKDNgl9rQ+zqQ3M3E4znJeRsW8wLa0U43zBfw9/c3oPFvT0PTcJY07Ou32Tr1uq+/1wB2deh7vBf2G12w32/u7oz+nEC9cjI/oUSpe6etQHPjYTYVVMZcAX/ZYzmByrMq8M6zLaOv1mr3epDtpAG3N3onXbomg3eS9XtFTW1ni6CugnmyFWvGuK0YPb2I5nR2s+WDNB2v+/q259Gq4NdDvSsCyz65LZ5VJhPm+BYzBvoSGa6C6tquad093tAuLFuaOgRs+Be/R9NvQ48tz76qstmt3Ti2lrKZt/FT3qtpvqrSXyk2hXZrHbm7Z7mEna32jHRNO94Pbf+ls6yz9O1s/652e371HY1sy5R5KtjnBerUPlb7FviZT7jPsO2d3G2C1sC/VyN9U9/O6jZWtoFquVRoRW2uXHVXKavVh189Th9XM4eu8+1e6cXCtG1KsCsqg8N8U59Ovw7lPMQZBrPZzir+eozonvdNW0OenpDrtvtfoitOgyYPg+W7zGpzIFrdpPb2pryVGLNR4brHd4qaGmxrbm33McEOX2Br9h40eoaT19ot82SPswZuyN8BwvdvWzSgrjaJH8IQxmRkkrW7Lazb9Cfibdlu4Ha/ddPudPndPej2v3xXw/6BZSOxSAAY83BHSu26zNW72zzonZ+3TjbF8ZYTRPKez6Xv1ELK6KGEXcQyO2WW3pc0jZmMPbQphE+VTp0VGDzyU/pd8zd6S1/vU0Bwqf4809jVUP+405hIxFISyBxMxpX+QPqobbeIwIPNwheOqnTTgRL3JXnGf3Vr6hpYYTNhi7v0KsPbpS7+LJMxn2RSI73lVtmFZcSL4pNfotzpBr8N567TTPOlO+gFvtxv9bp+ahXPQJIipuz8KkK5Ij4XKA4n8S2D05cB7QoAWd/aurQjGHvzHD9dmbE6mxZfhZsQjSE5eDd+yzgkLeTRN6TmfrjAhct/dbeokG8A34NXlxg/WWaF3fvF68O4K/e7txV/fXdyNt3TKBxFoq49qqWi31EyZXMkS8JFD2iJw54rw66xmodaAIEilygOl+UsvNTCT2QYizLCrb5hRBs2CWM0rpuSZnZvshayL+hGb4LM5T6DkmpQzrhp6lUXiXllO1uxGsJd1NvB9aT+z0T4q7O0vcQ8V932z2cfs7QNTFrRvDJM/yMLAv1ZlUbBy7auGrVquykJB4wDMd+vJwEtSQI7ILFthri0WRSsfwNlwrorduMQ0YinuagKH69EORRtN2ARok4lm1h3RxiJwPFE2LvdY5WKM3N0bgwx1z7ExwlO9h929DcH9uERa/uJBWOOjranGG5E0MjFZj2R3XdJkOyoXV2b4ZuvTwXYPtnuw3T1td/Xlrd2lZ99S6tNcT33eRTwF/sYUPNdSH9PljBTLBpkqzAjyCD8z2RTpLz+OwbB/FRFtDfi0wDL3G+ZHJpSvIT/I5WF3eWabQLPQX8gCESQ+GgoC8ETCPyO8C4yJUYZV7fXVXqt4IkFBow0pInjNmC1VyjiwLE6jiD676SPmK6GjHxK7d9j2BJRpLIoIzyrgntJDJnnIJA/R6BCN/jDR6JBJHmz3YLvfp+0+mUnmWJG12DxJp/M5p14paJp9T+c/GAwoDnHlJkeiWs1WEBjLcyynmjk4k1Zz0gxOPNHxecfvtftBy+u1ePekedKcdFr4UbOI9feFHedGVrWpkryNHInFkMQ9QB6XRqBcOlHKr7b/UvyEE6BbQ9eT583A87ppL5rcsdVfzx3HSrE3PFpmGZKu5JBRwSP0aTB2jmPjbCwM4GwKfjHCw2cS8EJVwsMTLovx7BydcEPjRSoAbrx0BwGej7Ln5qyS5avIyAtTwJA8Qagwa1agWBIPoQWY8wEEymCn4J2/YXZqRfRVmTy7RYqvkGJ28ckTAg09z9y7m/q7o8ju1L8zAt7S6LV7OiJQACgIjM/K885Dfn7Izw8x/hDj/xgx/pCfH2z3YLvfp+0+Iz+32dD2/BwG7J2fd3FLHMtzqdd0huD3TtPJVCwGpN5MeV4aU7s5y8EprwBVQoSmdAHIguMNMc5xfjuMuffF5PsGkzQOYUR28P8zCAgE81jnC1nPDr5E6iOd/n9ob3A3uC9AZ3tr/dTs58C7BswidWJrLFFzjZujBQyTs+MY+SUDT8LPNqwuVQqOjcAc4dEfq0X0GHelQAnxg7ZHaMyumxUagbZ3cfi4ix57Z8IWOgyQLXRsYt+Ta8F4BliukIfo41YYe//PHebaZvW1W4CK+IH1WWttsRsc1mKvBI/xSCN9snjxlx/HL9mU9p2ghZvLJIS0R2zegoqQBxtk7XucREGluPxlUPlAghbDghAIZvYuj+xI2TW49lvwxcRSnCTI/HHW/tdO8Mq8LTd3vI9cdi7tziKzD9KSaG43uV9kdPESXV+KxJ8yaK6B5hI0vPCigoVh7b1nNtx4YLYIgoeauPXFixt4bgke1k3wBKGu4oCcsHhUP2t5mdS+GI8KPBfhVfF4H/1I+8qr05jxVtkG0hHzZkpp8d+MoeqgGdxPU7CiL0aLNrO7ZBFuq1FCyTVLutKFZJDwuwLDiIwymdOVlIsoSNMi35jkzyRZsPmf6czDzxWa6fE9nomAkb7ynnGXygrOuKCLC7rGB2iLvwlJqFhg20gD+QGjAMNC/uQJLKIln2dgbfTqBP6Y5tAeO0CVoOjFmfnjrHBw9hejFzg6HwMuGHPp/EMfXoFiYWFcqjAr6wKscnAd31BBOFzhm8E370JhiPxPoxcpHhTNEjxk/K299BZP8p/jd/+PPN7B0/wRPY3NblHdaFlbBpSV3GRr6607TTeswb/hLVkqpdFQpBSXqpXBLEKeoE6TTXszKajoXwieYOZ3hHql5mSHkO6i8eNBaAQ0pY26MSDMoUyTIR5tZz9CVRV5wGKsqHCbBED9RdnS6g64/BaFxM4zwUECNZ+nER42ByTSOeOgHjuk60vtpcYJQYEViYwyRWlcPiuzSFQbZEWdaot4rm8C7A6bLdl7rgUy1LY1DIws7b4vCLkV9l4CGFdNv3fBBs1xZyJcYE0HHhSSKVFa4c1ovAZR4Y5zoAtqZxVPj+0kfYxj8VoHIN4oQ7sOlZxD18/oBArQElw67Fi+s2tVkz4XnfBvcCemDQOYvx8vsNWEWKWmnjBF271TKdqgDJgpOsbgfP6MXQisYB7xsblTDks54CAqabE9fisB39fNmhuZ9avAuj67ONRW7g6d09ifD/+/rsR8go/5laFfyMjD/Zbf3/2WT6hDdonpF2rD4ZLKZ15S+YQoijtCC2F8KHpReFgKxho7oihgppnWdGnW2sdbhJK3Cy8vMKzyLUWK/YFLPT7+L65bHyc= +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

List SOD policies

+ + + + + +This gets list of all SOD policies. +Requires role of ORG_ADMIN + +## Request + +

Query Parameters

+ +List of all SOD policies. + +
Schema
  • Array [
    • ownerRef object
    + +Owner's identity. + +
    violationOwnerAssignmentConfig objectnullable
    ownerRef object
    + +Owner's identity. + +
    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. + +
  • Array [
  • ]
    • 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. + +
  • Array [
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/list-source-schemas.api.mdx b/docs/api/v3/list-source-schemas.api.mdx new file mode 100644 index 000000000..62acad1ea --- /dev/null +++ b/docs/api/v3/list-source-schemas.api.mdx @@ -0,0 +1,104 @@ +--- +id: list-source-schemas +sidebar_label: List Schemas on a Source +hide_title: true +hide_table_of_contents: true +api: eJztXGt327jR/is46odNfCzZku/+0sPIiqPWtvzqknTrzXEgEpS4oQiVIO2oPv7v78wA4EWUr3Xb3a2+JDIJDGYGc3kwIHBXk3MR8ySQUderHdfCQCUDmcauGLhTMeOqtllL+ETVjq9q+rmqfd2seUK5cTDHbtDpDDoplkwFM53gN0+Y+AHPmYzojZoLN/AD4TFNhgUR63oiSoJkcSFvG79EMNKcx3wmEhHjeHe1AInPeTKFVxG8gL8UdQZWN2ux+EcaxAK4TuJUbNYUjV07vqslizm1TeIgmtTul9kdIqOaie5JAyiJH3w2D7FLyz1qHm4f7ux5zaMmP9zfbu55rcPdvb3xLm/ttI6AmGHrH6mIFzlfQeSGqSfqOLQqMefzUL2Eu67PlEhYItlPk1im8582UX9aidx1ZRolTBNjgWJ+EIK6QKs88kDV4YJRJ9NCMR4LFoskjSPhNVgPG3B2w8NUMOnbEZBQLFw5iYJ/QrOSRqhF7f4riqTmMlIgHgjR2t7G/1Yo1gx8C1wxlbpgMMpPQxgX2IgDcaMHcGWUwOQjDT6fh4FLJrj1q0JCd1Vt8TjmqO4gETNVeC7Hvwo3QdOJ0ZCTQLMXeFVNrzKDwEM15Jb7Ymsw8/+csbDlY6OZydVEk+BG9Ei2IRF+6QBaLww7WQ/URJlaKNCh9lByTG1LsZjDBMOUqDJXIyViZCkwvuokwMA4TV7BE7ddWarAYsHCXR66acjhCb5PowC8iumRIFTEzJcxGLYVJogKDJe5VM65o9V3gfOBThWoecj/neyaEYw3PZtV6JbA8GmgpsKz3E5BWh6707fh93YqldB8qXximYRWseFQIYucZeOa2BCLUNzwiMJPKZCUZZiJ2VjEPZ8MQ0e+SxHPAqWAtaJ7jqUMBY8qvH8M+QQ48MjvowlwLDRzMYuktktDl81zwuw2SKZF8/Z4wrEviDKZxGKiiT2geQrEwLAvOMRDoZ4RXTLNiyidYQp0RsNPnYtht+0MO/C43Tu/7A269Puk2++0h9eXnf55dzDo9i4G9HDQ7n3u9K8H7U+dcweedC6cD2fY/ty5cE7hzVmv99fRJTy46F33nYuT3vm10253Btj9st/728/w/6Dj9Nuf4Mewc355psceXZz12n+lH4Nhf9Qejvqdk+uh0z/tDLHv4JPT71z2uhdD81DT+9xF3roXp/Dnab83urxeejj4+aK9/OzSGQy+9PonKPKo3wcNXBceAbu9ETzqXZz9fN3v/N+oM8DBnJOT7hBIOGfXtkX+EoR1Tk/7nVMHm1heBtefnM+d6/PO+YdOf6CbFRS6zBa8NSI82maVglY0q05gRQ39zkeYsdGoe1IFQT36wUNm7UuHWBeCwhgz4Xwu4wTiyHiBcULjGEA9G6xoU8cMvVq/tH0Um3Ol6skU/HEyZTxFOJCYjEkUMjNc3d2Vs7lUYNv2jRuLvHNV7NVUNIpA/zoBYOMmBYc3dEqmvpoIBD9X3gj0qgyiYOSECBsrwjAUdTRF7SoPMMM9pBH4qEwLiwDGiIiPQ9Ay0ISx6DfRKnvbauZCKb8jUYh6Mx7xCbFEuHZBOEpENAzBLYqevkBQNZzCuIHGv3JuNA0xedmfiY/lhyVOPAlWg/HPsMRi0IicoXyAokg9OMhEJBoavHvPAC1PpaeYmso09KgzWBskqtBgQvEDgHei8xeEUlD2jBih0FIaHS0VpgEgAuJGBoDqx8KkNZ05jM2yLxRwrQ2zad58k8HAYG9RBGNCT+RDgTIhjJvQDR5humlk6pEtIXvGvFHAnAAOj080MwWn0RERf9mQiL91THzIfh8wmVC637XFpJH+3dC0qlHjKc9II8gYqYvu77Ehj2GmtClXgvErKOlshxoZTEF5lzKIkgbrJqBaUDrMOiStADW+0IAFAo1zssnOTpxLM5CyM58FtYoBjGGqSVVkPLcx2rLRlWqwT/xGJ1hceegwxwLIroGNdmaubgKMC5l5opaxmZhB4EKXAaYhGUt4zSPTUxuCtnEtbjHxI2vUY1ygj27oa/c0UdaudCjIWkRg4lw12T1LeBOP3kp0MoblDFthJKOT6R5ge+SCi0QyVeFCz6PJwI/0xsRxK2OPuVMeTWD+2QBglW2s1RrBkizWUtvmalPLGWRxhVaWY4OEIfaBh/6aRi4qNwdlRZGsjnR+WsIMx7D8nmUs05I5C3mYHHyT3CyyddM4RgBr+aOsuQJ0PORUsKogzJ1rE3mWacJoTaMnRzvHw6DlaeKeFxgIkHmMCfkFqHPMnExwsvvlmL/SbsvAqMTKTHoCgqxG6xqYq2kwN2CZm0eF1YFZDuoOBkjHnCI8cIR5Tdt8tYsNmrqTyXzC92k9QZjdWno2fcAbBC3bcVm2R+DdMevq5UHRv4qZJUKl5aZu4gfmi2r4oCyWRTHKX1XYQ06/yoZ1FcWsojZZQFkDTDGdUd5axZsOVhXuCjwZ7dlQYsCKkZWIE54kplwOfqcKva3ZYVIf09DgNibJg4N8Z7SQKYtt9P04YH5zrdvw+T+l8wKGfc7y41izpRebWTaHdXvIXZ3Lnpw3YvkRb7K8PLHG+U9wUiokLK2nKRjDY12d/ajnaXUBt7zKKhSybGguDXS1vPR9fGG5ajH69Z6qln4wSXW9fFUVssznJxl6CNsXgMKTmLNSdw3nlrmf8QUzteOSAHe6EHtOwbxQJDKlmNo9cJfF61WljaoG8/DuCT+IKHdB1pgG7hSteLZUR3lm5fV19dCMl6fKeomphlbJ6VLno+TAD/X8PlTeyRqc9eg/wOvw74de76zjXOCS3xpoNgMnmeqoTntfLPSXeXRgXn1YOyL+gpBRmHO7Q2JQgVyq5pk63ozP4V0j5/6BCXhaQybnjwU6ecaU94he2r2LC4gbvayO9bWo1spbKhc/zwgML90TjThzFdGuALq3XFmT39s/dPdaR+7+dhN+uXzfP9p2mzvNnZfV5KcprPTrCH4xE2Ql3WolfeWmyP1yZHpqSKcyYP76Kdt1zpnxBWadIVDnaZgEb1NvzQ0O5mGGdOtkeV61iIrUfQ5N8qJqoDo5lP43MATpvYDVn8nSKU3TGzOTb5RYpAzJldImYhC7UPqGe5LfcH36raSabyQMAhXTYmMDEubGBg4Sa0ltWKCoDFnX1kByw9CbpU8o4P7RaIXmk2fHu2x7tRxws4iQBUZjcp/JMrKhl2Y/e2omwMxINkq2fVClX9n4qwQXHVtsHDg82D9o+v6hu92EX+Nd/Ms98Pa3861Z46zLk366tGCqCqe3lZdksw+NaPjnPUEDrKmKZ0Y9z+4h6X1AdssVMwTQtDH78gT3iuBJPQloJgohcLt5VG+26q3dYat1vNM63jtsNLd3/44ywmqQdtlfz0fIAeNaMi/gZqc5bG0fA0Mty03BAjV9jJj4dHfV5nEbwj3Etk4cg73XWd+WcnSJJ0PfY+ktqKgSQXQKXrWX/EDi9ETCg7ANy+mnlfcRPLM+iTk5qCCWXemZAhCVGWcSVxhE0kZ2aleO6qCJRpN94B7Iq+VrG2FQeTF3sSDdfcZsjvTeqe2CG9s2bqwYVhwIPt7fPmrt+vu7nLcOd5sHe+Mjn+/sbB/tHdHG9kwoxSfPwJKnIhJx4GIdFWbkn6AQsGTQPTFAgz8fPRKNZ+Zu3TYT0/DLEsDamxBFP7Qv2e4BmHM0Sek5nywpIaqPcI8pSsMQk7Fx5k3DRC8OJsHKnG5R0UnnozM6Q4SY7WshrcrOkBPZ5AKsgi1M5S1xbARAp1MipDJ4g20YqhtZcTRraPYYzAa+CffQw4y+okeRNPNjOSu5EvnNj4S9CxqisQlZCx2fJwD/xxzrfAaXbkBGEPOkfmY0ucGmAF9E/L7BnLzklaFUSn/c83ShEAn4KS23bc0NUmrgLqGbXJXl2cgjyFlxUtA5gPNnAC43SYE5ErPohZm1GBbN/ADPWnNl7oYFpZFKF1HC3cQU210ZU6EBEiwLaLuNPJiqpxB4Itsui1jFwEjh7lwzc5JIeqdLD0/63WUI4adOomUvboRxPkX7PRSNRLEyaSKSWWRQZ9Mqmy7r+AwSQOitfXftu2vffabvLr/sm0/mzFuCPs0q9BlFuKkvY0qeFeijlwWRZLaRLh/pidzERYqBSH/5MgTH/i4i2gj/McfvD98QH+lUvqKuYedDPx/bT3Bs6s/nAhkkPWoJfIhEwjsmvnOONUgkVe1UR/so43EABhqtgIj4EQFbyFRvLacRbaRytUl7LNFPCZvyG2E30ykC0gcDXn1OW6lrJLlGkutstM5Gf5hstEaSa99d++7v03cfRZIZV+QtBiepdDbj8UJbmnmP0nIGDZg9vMEyl6OpWkYrSIxlGKtWRg61cas5bvoHrtj1+K63v3Pkt9z9Ft87aB40x7utg1ox11/lfpw5WdmnCvOt55FUTJ8g4rd4YFwqkdIrl/9AvbHwaW8+ySExzB0AuPuvOXbcrWLHC5mAbEAYsGP8QHlx1D/Tm1CaPOpNb8vJODtTUfpshw45raHjGjqu0886/fxh0s8aOq59d+27v0/ffRF03H0KOu6+ADruMoRYPkKs/yZ09AJ9EMaHSQEZ7Nfj2Ycbpvpo3N58uGqBXglFto5WfEklJTvHb/oMWFKlSmSUqwvDG7SdYdvYtqVzQxMIkRF+WhpIff44mAnEpLgbHwazINHHigTSjRd1x09AKu0z1t6yUcwxSUVBIZRYe5VgYwF+3+Uj/AMKVAedQKB+wxqnma1/qR7M+ijxGUrMOj9cIdDns/rv3qqvBLp4/grDxUDP9QOfC8T2o6E0yg5AZRB0DdXXUH2d7tfp/o+R7tdQfe27a9/9ffruC6C6QUMPQ3Vo8GyoDm0b2yzDUh/pu+H/NGInVzEckHkz6RJW93IMTrgCz9FCe0DpGEPwOqjj2pY5wrp1Z2+Eut9S2Y1VeiGg+UrjENpPk2Sujre27mC6YJruG3weNOydNpG8bbhytnWzsyL45If7IXx5qT7z6lx2zWqjQUqOAzpJRkZKA2iVmw+yawpUTx8ZPErfnjpYgERMk9ksHOqmx3iXAywoflLUukE2VJERZBvF4f1T8nzeeUwOTeQBOVap79GxoD0DLpfEQ/a/4nTBvAMhmi+8cKito5WT4lxffS22oS+JNYeVlnnGwX2BVoWhHjZrsQ+Cx3jYlT6VefeXL8P3bIKYlGJCqhAOiwAXEeBVl2BGFPMc+9kIdqI0lN9X4JQ+zEEfY34ISmG/RAMh2FXhnjPWh+hNandK93h8fWdnzxM3IsQ82ci1jcYZeNEWaHGrfP/He8qJtHgIIv2ltj5cWzfXdOQnMbWItBZkV3MrFy/I9Vom/mSp1TW1OlFT75e40Kq9cvWH3i44OpLgoSJtvXpwTa9eoIcrLXiCVJd50JeNEB/lz6lcO2uv5qNEr470ynz8En2hs3XlbvaeAHPQvsvcqZRK/JkxNB10latJCp72arboQF+dPKLe2i6wVNdD1oM6wEfi7wwcI9LGxMeYvgm9SF1IIbf9RjMLceEbnfP8VpKZHl9BlsWWnnTVq3nGAes4YF3HCWX410kMDQt8G2WgOKANoJ3PP0UCw2ghLmpaKyM/kd+iPpg+XDnXIUbNj/Ufx3kQNL8YvcDWWRsI0zW6x818YIaXoRhadD6zqCxbN1jWYJXfUEICXdKb5jfb/cSk+luTFyV28vIKXi/21lH6gUjy24m7/6WIt440f8RIY/AwmhsNaxYORSPXiK5a7FN0ygv+hbfkqQS8YVmTX95SJDMPeaJPgINPu1O8tBOr54IniA430a7kjPwQIDE6vzC3jUzoDFsMDHNY2AUh0GuwL+bmrBjXYPh5LlD9VZrF2AC0TDcZsRM7cQCgZrM0gr7oY+mMcTCPJ2YX7xVLdRAyd0JohvTFVVkv65FoNqgKOk0t4pnq+VhPhqVqYRKfGAvmUJliMigyP/peywXpi5CsDNuVIfpTtMFy6lMR0rFFiKAApkRhhPPusEIRiEVmB0PGky3TSW1hWyCCyyFtDDsNWPvho7lUCSxZC3TxHt/sAle8B8Nck7tsUHd5Cf3t7v41SQHR/NYcS1XIY6pXIHrRd2Vu/0V1HhcuArbrPlglTEEmbHh3h2UNXATd42N9WS+uLuylcIVTsw8I9pu4h3elUr4LXP8v3zhsVvo1uqvXruReKPO7vrm2+D1tP5UuSV7Jii04RosiB5bFbI7ohKyuJBFH+rWuNRU6VnZjUJRs/Y9XWN7f/z9w+X80 +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

List Schemas on a Source

+ + + + + +Lists the Schemas that exist on the specified Source in IdentityNow. + + +## Request + +

Path Parameters

Query Parameters

+ +The Schemas were successfully retrieved. + +
Schema
  • Array [
    • attributes object[]
    + +The attribute definitions which form the schema. + +
  • Array [
    • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/list-sources.api.mdx b/docs/api/v3/list-sources.api.mdx new file mode 100644 index 000000000..e6646b221 --- /dev/null +++ b/docs/api/v3/list-sources.api.mdx @@ -0,0 +1,138 @@ +--- +id: list-sources +sidebar_label: Lists all sources in IdentityNow. +hide_title: true +hide_table_of_contents: true +api: eJztPWlzGzeyfwXF/bCJiqQp6tbWq1c0RdvMSqIeScXJk10yOAOSEw9nmDkkc13679sHMDclyvEmcZZbuyt6Bmg0+kJ3o4H5XPOXKpCR43t9u3Zac50wGvlxYKmwVq+FyooDJ1rVTm8+165DFXR9L1Kfok4czeFZzbG905BbnwZK2rX3D+/rtUjOQnxr4MAjW4VW4CxxGBhkPHdCoTy7sfQdLxI4Ziik64poroSGJxxP9G3lRTD8pX/ffOd1ROR/VJ64d6K5GAxf33bOLvqXdTEaXA+7vcK/Rtcv9QM/EMPBefpESEDex1kJwCJQv8ZOoGyALSxGAZ52rvpNmP5SBnKhIhWERAAHcf81VsEK3nnwhui1cKJacYIX8pPw4sVEBcKfwhhh7MIMYYhARXHgwWRGSombH/dwJDGKpGfLwBZd33WVhTDEVTL0++/mUbQMT1+8sNWdcpFdzVA6LtGuafmLF8CFF3LpvAg1nIaVwGmkU/heTIEUCz9QQFr4uSCm4zQNDWqnU+mGql5Tn+Ri6cL02gctEAJrrhaydvq5Fq2WOGcYV81UAD0ZDD/aa8ODheM5i3hRO4V+C/mJfxMUW00lUIH+9fBQr6amP52GqkzOAT0GtIGCKCLTGBjFVBXwoimuwxh4txLhUlnO1AF2kpDsEHd2kPBLOXM8GSnoH/jxbE5wNGO+GXb8BmYk5F9PfMuPvTLt+1OxEwWx2hFOBFQFwi/9ZewyKZXY+akx9iPpNrrYewdJuvS9UIk5mAMQf+IDNqxQh7kEiH7s2mKitGYA55xpwjegn9hhmdgR9wpJNfOAYjZwDHjmeJYiBVZh5HgzIYHRgIqgiYA2e2Iu7xQ8Bh4RcbC9s1hKK6rjbEj9gWMLMEUwsOdHKCmhwlF3CMj/0Mx3ECfC9k66sWIqYGtAOw4NNt+EBOF8KoRo4vuukl4tIyfUc62sTB2XzGIFrDAKgBm1h8yo1EuoX8W7Wg+e+Culwne1kqi9IqCJfMQhMpWWBEPPcOVFYFq52wSFxfudif43njlg1tB4fo/cf2WeolCF8XLpBxGghwwigwWg/Ht8DcbJtUOSbF54/SA8RQg7O469s3MqdtSvIJxeXcwU/A8E1YW/Lvz14K8TemD66iK83+E+SFjqZfl1YXqG92nvtJfugVyqHKcSvn/vAaG+BLOpkqDQKmTsZB20Ur+xwFMA4iQgDTgE/SjIhW+Tcf+CntKTMwV6Hr31g48zWAGW2UltDCcjr0nn5KXxK0AN71ISlxgAhtGN5itqkHsBghfF4fMpbfmex3I6zvJ240np/n5waYSp2L3QrbbOKoQo9Y9ahcwqhYZXNkKFugXiUDYYJfswAvB/cuuAFCjahhE/28wyAPVJRUFfWE3qwog98AGGAYeWdJJ/a2GqCxYeYBM0y1DNtMbH0qI1resHgXJprQBvfurMHn/J47ACBZnXw9hVTcZ0zUsEu+YVA80pjGlbVFI0HBn5TP6ZiPtaaQQSN8J4Im3wg56zUK1bl9hj1F4KxizozJhoxfDT0SFLxhWdrOhNIiV1cT93rDnKA/dAOOCsJF0TnymAVbkY0DTFyxXS4A4bI4OxIfslYOfIWfFsxwLRCfMI8Tj4CGK6AB6i7xKg76tpFAIHVsL3wI++c9S90OGbxhY6roQEX0NOACnwk6gPUEEF/6DYzYcWQdoJfSTwj3i5BCr4MTh7cwjfKMBKiEFagS58v4wbvpPF+YsJAJqCbobs1ofYBuYP02MqMCeyY4Ckif3WnnjlBxPHBnqw58ecbNYwZDVua4jy0W618E9eCM41w3mCwp/8AkKIps7CkBgcZ+ghl0sXSQ89XvwSYrfPZbGTQSBRSp1ILcLMc4aIUWeA9idyGBnHrrKiGGwPgFPGo8vjmooV/mKMa1kxb1snu8et44PDY+ugfWIdtnbhlyUPpycta3evvY9KwVpUHjo/1JsY1LaB6JBckKOnxw3L416sDDYPBUDPHCfz8pHhKM+g1czyAzC9GLbY4BqjOVk1EQuyj2V2D9UUxBYDBhR1D80oGmmTkRADw63Hucdvi8DHgA++QdS5I6gKgg/MqHYKOSGI8jCWu6n1z3qX4/74Z8yrpHNNnsKcqmWmENedGcIZC/EMCdnd+2IJsZ1w6YKdyUpKJQYXK7T3tQeIQWqWG6OheYJNCArsgW85uHCKru5U5hF6MoiM0Z40XroxK4CTcOD978HT7vn1aNwb5llqHj6bo1Yy8xJDDw93Dw8nB5MWMHT38Mjaa6vp3q48PPyqDK1CoJsooGEMsXad4/G0Sna4p8h0FdxX+Ou0s8j5/zxnO93u4PpyfNsdDIe98864P7iE35ev+q/zzH6k3bP5r2mKNi+hjMVUrdLxA3v3ZNc6OGntHtjt44PjvaP2UXv/QH5VkdgQpzNjnMUNG/TGYfv48Oh9FbfXCRC6mE+Jj8BGnNTBRJHti+7g4uq891MWQXCr55SfIqdIZ3vYi1kntgjt72lm6E8hgsPr815e2OjJs8UqQLpWCdBR69hqH+3vt3bplzyWR4ctsDBfVYBKo/f4F3GSRaEcbVyAS4bjoXPmuoMp5fEfX7I1ZzsRYAq+prrcaAKXWVE3XVHSQAw4T8e4ZcWrKcaJ7z6FMVHOcrqSAjLuNAkgQHV9/2O8pMYa8N/DZBlt5sik3zO7ucFvmFsSTuQmGSoZQIzA/n2wosjcB98fpiSTmacRu55y4C+y002wWoM/TABGZt9gLaMxGCxqWGU0xw4cE9SOKXVXwSKcxkJGGK15lr/ItqJJhHotUp8czkEn3HjnaYv1wviM78Bgva+U0g0MFtKpPGvsWGfrlDFNInRIMTj2wswNWKQwnk4dywFUtkbpdzVKEwXqr64C/84JAS4MtIbdyYIUxBCLa1PQ7b6mZLHENBGnGSzwnkAU/yVN9LPMwBaAIvTmQXXgo9MnGAnhFud2WfqdJYBTANlY/5k5gP9IxDG4vOx1x4Ph7aj7pnfRKYQexbfP5orOe2wcUx4dHX1VvlSMf7Ea8UPiSnV6J6EdWXZun0n2JMBSN6JEKqaUme0eedfy+JC96/2Dg8n+pL3XlmmiUq9/tHb9NqCTFCjlT3nBwSTZvR/YV76LK0CVIBa1/w8UzKvOaPR2MDy7vRqc97uFLEfx5bPFcok0eEaq42uLZcX4FytxpTkkrvj1xgJaSHlcZTm9MnLbrBbcIi3zIpaPCuGXmrQO9k6OW6mIpRF9Cf/6bxnlCImejPKj8mxYvEpDoGSbTcYKiS5UkNAP6QrTIw39wKtOt2UmK3SfKPBsVtjncnR/PX6DebduZ9yDxxhDDkZ9+n3WH4IG3171hhf90QjC+RE9HHUHP/Yyat277Lw8x/YXncvOa3hzPhj88/oKHlwOboedy7PBxW2n2+2NsPvVcPATknDU6wy7b+DHuAdBK499fXk+6P6TfozGw+vu+HrYO7sdd4ave2PsO3rTGfauBv3LsX7I8H7sI279y9fwz9fDwfXVbeHh6OfLbvGZYSpO+Xo4BArcZh6ZVMbg8vzn22Hv/657Ixysc3bWx7RG5/zWtEhfwmQ7r18Pe68p82FwGd2+6fzYu73oXbzsDUfcLEPQIlrwVk/h0TZVBKpoVmZgiQzD3ivg2PV1/6xc5PYckfOMzL3zdkRWpk4pROSXpk9Iux4NU8iEu2gYYPC+A0FIxLC6OwQySz8E2TZvaKvRdC5PuxoKb6CgWeeczZUKFk6Ibmio4eREvRoImEjLv+PKCe0mkY+L2z9cJUHrGENkVVmDjLRpj5V20kz8TFWGaIptrAKEseg3wcprWzVyGGQjUAi0dcwGKIXpThhYYRyGtrccjLumCqCL7K6Dv9SUBstd1GfCo/gwh4ntg9RgoZFGSQRAEQiaYX4qZPLgIDMVcTT73fdioaK5b4cmcaWrlNjtpw7q0xJachZB10URImRacqOjpAIbsIIK99hg5f+0IuZIj/f6tMyKtxR1GhkW87R5nXYG0wgE8cBtRluZTU7QCN0NKQqUJFlC9DJ1eikAs83KyGSUhi0i/jImEX+zTVwnv2tExvWtjywxsce/mwyrbDWe0gwI5MCfslD9bTGWAXCKRblkjL8AkrBlJIkiozkQ74pqFUQ/SpJFsGg5FtVFUnIADE3nrC7OzzpXZtvacD4xaiUBmACriVQkPPcByrKmVdgUb+Qd53SAbNrMYYGd6xhrp3nF4WkinkhlSlHgZj+qDCAt3dCH1xi8Uk8WBJZxnu4yNTCEGvWYZOBz8SCpp7ayyXY9GtnZLFCz1M6VF7uNJq/t0deaOglDcYUtIZLASWiPxS4WqIjnx6G7Yj7qFfiR3iYSENZcejPgv+AiSlPFgK09dUdFeDBr0zys8zydsDIh7lAm/5fY47KapHwhOyVDI16fCj7DqRj5iwRl9LWSUhmBi8NUL27FAgaDH62aFU7HOqVKK0YNNRFnrFCgTB0zh5VjvdPyNHDbdrQLkGiMNvkZV+dUdJKJk9wXbX6l3OYdoxwqC99WYGRJTkHosOo2nDtLniOmY+lRJn+rM03cQcdr4NXPqeQF9UzLfLmLMZrcSa98ajrFoIOzxUbSE/YBbmC0kgR3YW6PuHenop+pa9H6lV1ZPCRaKurafuB6UTYftIolVozWr7LbQ0pfJcMhrVVL+AEzM5XEIIrxgtatKtzYWJWwy+CkqWdMiXZW9FwJOFc7IFKWBL0LM72N2OGiPlFcHhToRR4U5KOgQCY/bU3vxx3mr051Yz7/q2ie8WE3CT9OGS0ONpPVPFBLV1q8lj3JN0L5EW0yuDwR4/wemORyIYV42uz3cNHQK+ZTrmLvpjI+LcXSScBcaFgYrzIATiJbzDiYjNfjiaCRLv5jK2hyYeEqBJHQuTCOKMAfb86aomNhCaRINr/rAksgbQk/VGQ1qTpu5cekAxys0XGHM0UHJQDKK8c1C0CdWi7ikM7GEAIfEiWQYTe8+yCoUjJThAci+wETfx+aIseOwVJ55C82NG5I+0TJnqZDN9FHfkqpsDzHJU29kRRl5UbouqCFTw8z1meCVjAx6XLVZTbp9oO8k8JCWKzaybIUFqwGHqYJptIq4JgtBdZNm0iWZHo5pJN9zMoE6loCschYuigi5jN5/2Clsx1YVAO9Y4rShKk/+JtD83ONq4G7c2V9HDsLBQ5N7XSvVa9himBEW7RZ3G5qFtbFxlTqtIApgoBT2tEFmRjPwdTOfTebXH3kqFFhw5jP+hC6LcR1t9XSsV6iGLxX7Ivwo8P72DyuWEL4mJ/XbuuBp5DUCq85uZJF4S1vRceqUA6rnSQqADXJaJ2CMfu0V4E/BXVq1oqnYTI48ekYs5ebq1l+YiP3Iukhki5pzWpSq/nHb8+9xuTNZeey22MLn0/El94+OxOfko6WS6bdpnn5Nvznq+bln8TmYlXJOk7V6zL8L5RLacr40xrWtYKHXXFLkcr9n555Rx8M0HUboHlBXcwcCl0Ti5M5PYae/f08TYKjohjkQEbB2csRxdRmj2H5vH3T65yP39CeTIhR5QZ2G4wU4LdYYlhJhyBMAYPOJNHIEKyCQRP3MhRgwiOTtSLhzUhLq73baJ002sfj3YPT/ePT9klz7xhk5vBwr9X6/5yF7m8gqOOkhjpd7zZetzarq8EhclWTyWLARyNhwtbcB4cXuVJI1ea9poL7kMFFH5PYDBljLNK+4rvUo0ej+H1uXHySJ2wu3tuUzJn1Nx8vOnkW28bdaSQD8xmZzYaxoWkjApEz5xCS1YAorUFlFrekQ1HQ2o0W/BcEbf/0oHXa2mset49IwsxRna+BEMl6AnATtPYbrd1Ge2+8e3zaOgbMmscniNZDZYEz171nvbn3RX8bbRv23q86D9F1sZZI9IIA+NYQw8zxXT4ow8HRxLfpnL3j0RmNZu35BybW7D3bKgKfpevbGwj3K8dTjVkgHcRQEcoWdOTgkLLAdIyWQRp1pHZ5RxAo0dwVL6UN8+X5dfVkMDQIpIX7BZuI/bXnQH9huqClMantimHVkZKTw9ZJe396uC9l+3h/9+hgcjKVe3utk4OTExI9FYawOj29FfpaAePB6ru+BRz5FxAEJB9oTwjQ4JsXphCMDY0Lt02mqfEVeJ0EHtB52b0S+0cg9d4spudyViCC17gelTwhmDkDHgTOzKk8SGIcmrPeq871OW42JtuOCKu0cdfxzNrs03l1WJoIYz0B1M1QubRL0RQ7GupOkrtOGuotIB316RUdeujRK3pkQaflkUaVLL57Q3znNFWzDq4c2geqTZxITMPqpNxOx7LUMmqca0ru6KP430OYmWYkdfUinviCiF7aNudx+XYFyoaYlCis+U4xIEpJWfRLjQU5zzIFlQMw38BdsSII4EgmclqYSItG0fhOtqZcHrtxhmhEUjwXakV6L4SqO9EVhrk5tBtKGswH0cANNO0Si5UtPCVzd8HInEU+vePM0JN6d+WC+WnQ1JIXd0orHx9mI2uksoljbZF0pQd11q0SdhnF5wOkW93d6u5WdzfU3eLLoT4Fqt+S67Nbdn2uPZ2NwMWz5PoEJD2eb4436zpdZiRdR6RdpB/ejvWNRrhr8mmJDtpX9I94KS8h30n4oc/Jm6J8s/SnvEAEiY48Azx0q+xTwjvFmJ1EItVeebT0yG3ZRaQjviarGcQe7XPLsE5bYFiyzre3cK0DWcDsrVFbT3LrSW5Xo+1q9NdZjbae5FZ3t7r7beruo55kghVpi/aTwnixkMGKJU2/p4tg6KqS5Bq9ROWIVUVvpZa71qSW9xxqk/buZHd6ZKl9W+7bh3sn07Z12JYHR7tHu5P9NtbYp2v9TarHiZLldSrDb+YjkZgqRLFUEoQrjHzfzqf/YryxaUqlE1HqEgPvIrx4JfUd98u+46UfwdzwWGwjdztgFv718Jx3sxg80k3fzxKYLa98VRUd1Ny6jlvXcbv8bJefv8zys3Udt7q71d1vU3ef5TruP+U67j/DddwX6GLRzSN/pOtoO3xOSV8XYor7A6WrfXX2Uau9ris2jl7Oi2yfVBRB+VRztTLOUpjLRHopudC8+XjbB7QNTFs61jUDE+lh2Ynj86V6uGXfEHTyVVck8FUuADdYNTpTLKnU919reUtGcTzLjQFDMgquzxel3EsnSq5s4OtT5AwM9VfMcWpu/aZ8sBjijM9xxqL3yVIKdT7J/x5UVQn0saASzcWIeb2mXIBz5tKDMCI5n5a4oFtXfeuqb5f77XL/11jut676Vne3uvtt6u4zXHXtDa131aHBxq46tG22ROJLvaLS8N/bYydV0RiQeAvfIl/dTn1w8ivwmDO0n9GHfJYSvxRVexFmvimFniAjEQcuvDR3738G3gBPHppy6TTNRYOef08X8N/tVVia9KIFsFV2zCXLeN0/D9IkigYOneojiaQBmL66wD493PMofFOnvYJ5CAZTzxywp8d4rwZED38P9TGnB/p8SmGOMLfrwH14aj76swVr5sFA1syjinyPjgXtBWBZmB6i/z79BBhdhcWjlz4Eli4dmOAvnwcaYLO2eKlkQIfNsOblux/ejr8XM3QuSbn5dkjlYDQA6nEFIkLGq2PqP7ATrSfpvRCdXIUNKouYujBhoT/Hk/l+mBiCGSaSdnL3pWz+5Yf8PStrPr7zzjMn5dITrzxFPrF3szTzkpl5fSkSfzPQGgytQdDwqxM5LJi0NxZXbFugsQhCuiFR64sHZ3iNDDwMmeAJQi3iwJe6EB75uijLcO2L8cjBayC8PB7vvLf0BYN8N3Mfg77QoI9HLfxQ/a8QKDqoBjezGLToi9GizyY0SCMa7VYGpQYP2XAa4AcSfuegGB4Lk5zgOkxuiL5AlVTyA3EWdP4Dnaf9kJszPb6B5RJb2r71jM+ZFHDGARs4YINtQKjx59UIBQt0G+dAdoAFoJvynyyBRjRj8xhWpVUn8C+oDy4NFqBKUMLlKf/jNDVw+pegF9g6aQMmuEbX6OlKMbx0RsN6SM8O/ktf08wJgCIFy/i6PqyEBboxvsk2Jq6Of7b54ow7aZ4EvxLxta30Gkvy57G7f5DF21qav6Kl0Y4tihsNqyOArJCzt1bO2oV0BS/8P7wlTSUPGuKT9JKcLJilKyOUadJpa+4oiveXSkbo+dEHk/wF6SG4u6j8St/qMqPDa3jKXkKE5rh4Cbh4q28oCzCYwjpbgPqLr6OqEVCZbowSZ4Zx4EAtFrGHl3sDEvFCSBCPJ7iL97fFbIT0QTJGiC8IS3oZjUSxQVLQBcQqWISDKSaGHTwsWttwLOCh+ewOEBI5oi+KTCcy1NdjY7u8+/0UbJCcxly5SwznwIKCM6UyI1z0xyWIAMzTWxF+MHuhO4UvsC0AwVCHhWGvCUEcPlr6YQSxZwbuefIB3DUfvy1K1uc0Kf7NfExXLz4YNbxYYm4LaRFzFMNR4k3NRIkQd8yBSvjo82fMeGDI9ICP+RtfGDua6/ySM9JrKfRtfY23kk4fFeYQzMeGdZagRvesbk6H/67P6D5Cx+Qzw19IyO03cb+9b+I+Ig7mw8dfKA3bz9ZuP1u7/WztN/DZ2keNQPpF6y80A9uv026/TlvxddpHhS79YPJvW3vYC9t+mvav9mnaxy1W/vvGqQS9T3eLIFJ6z/dT2fj5TAibuC/vG2d6lSqrEEqyl8dfC5Br0oj6Bw718PBvVUmEVg== +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Query Parameters

+ +List of Source objects + +
Schema
  • Array [
    • owner objectrequired
    + +Reference to an owning Identity Object + +
    cluster objectnullable
    + +Reference to the associated Cluster + +
    accountCorrelationConfig objectnullable
    + +Reference to an Account Correlation Config object + +
    accountCorrelationRule objectnullable
    + +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 objectnullable
    + +Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient. + +
    beforeProvisioningRule objectnullable
    + +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 + +
  • Array [
  • ]
    • passwordPolicies object[]nullable
    + +List of references to the associated PasswordPolicy objects. + +
  • Array [
  • ]
    • managementWorkgroup objectnullable
    + +Reference to Management Workgroup for this Source + +
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/list-tagged-objects-by-type.api.mdx b/docs/api/v3/list-tagged-objects-by-type.api.mdx new file mode 100644 index 000000000..2e1e05114 --- /dev/null +++ b/docs/api/v3/list-tagged-objects-by-type.api.mdx @@ -0,0 +1,85 @@ +--- +id: list-tagged-objects-by-type +sidebar_label: List Tagged Objects by Type +hide_title: true +hide_table_of_contents: true +api: eJztW21z2zYS/isY9kMTjSXb8lusmZsbRbZbdZzYZ8uX6ziZBiIhCS0JMABpR+fxf7/dBUiRerEdt9M2OX2xRQJY7DueBYG7QKfC8Exq1Y+CThBLmw34eCyis+GvIszs6+lgmopgI7AizI3MpkHn+i64ssL0tMrE56ybZxN4F8hIdTI+7hjBI+hePCZc8bEIPtx/2Ajg2WJXNwHzMwTQEgkbGpkiG8DEYCIt6573mRFZbpRlnCFfTI8Yj2OWueHaDWfDKcuAxdZ79V511ZRxYEioTIY8g16Z/k0olvApGwqWW3rDQiLjZ2kBtyk3PBGZMJbEk8hFykGwjUBBAzxlXgvhRCQ86Ny5F53AZkaqMbQIlScoXLfXO768/OX84uykf3oMDd3z89N+rzvon72Fp173zXm3/wP+PH476A9Oj9/Af3jqH9Hzz/Dz4owGXp4d/XJ+BmN/poeri94x6HEjMOJTLo0Ac2UmF4vKE6QP1FZNUyg4KNRIcSNQZvGZJ2mMMtB89xte7k+5MNOZ4LFMZBbMz/KGf2Yg8FAYnMcIm8dgCjcDmAyMcSkEu/73DtnxMuMq4iZiPR3HwArQYOelyj+8mGRZajubmxGwFqNDtiyXcaqlylqhTjbBmTZ5Kjetp9MMSzrNmelespE2LNFGMKngZ0JujaLONDbisRUV2dt7W0uMCvOKsTAw0pFxr3ba8CKRSiZoaRiX8M/uN1GJxIiDFujpfpU29WhkxaI6z+g1sA0aBO9loxwc1GmVQUOLXdkcfHbKbCpCOZJg1FuZTViDrNNAxad8LBW4PIw3Oh9PiI43zFdjjt9hjFL9q5Uf6lwt6r4/Yg0MpAaTGWgVFJ/qNI+dKgVr/Kc50BmPmz0c3UCVplpZwSaQ6MD9yQ7YcUk4TDhQ1HkcYfJxkQGWk6PSbqA/1nA+0WC3AlU1VqCxiLLZpVQhjgMxbAZZBvJghqwwEgSymGITfiPgNdiIlIP9ZZLyMNtAaSDBGQEWS4SKYGKlKQlYgbM2iMg/SPIG8kTc3vA4F04L2NvnTMfNV+FBLiUuONFQ61hwFVT8hEau9JWRjGk5WJ3y7+cd6YSGlNbPLZoMPaOQktmpyiBxumFDdAX1J6v0OycXcNb0fL5E254Ub9FlbJ6m2uDiieqndASk9C02Q+qJI0t+64CDNraDFBoNt8pciFFLRo1GhzXEp8Z8C2qwaKstQdXBTHxi74N2eLj9auvV3v6rcK99GO5vbcOvkO+PDrfC7Z3tnffBoh8gyCji06LF2ltb+K9up9PVWAIFnqVYghUwS4hIBzIHUOJpGiOyAEqbv1okd7foINwYjq4kM5HYyns3y0ICGlR5IDRiULeZdDKUqllGqd7Vtf5l2KRq0MqQurRHgzNSLMaPjJZxO5eejwjJgBcWMGZCaW0E2RLTHVlEIPaoOdRj7oPTu1BfZEDB6suHs2xSZ+jHHPJsE2Eu9mGRtGkM8BKJPYvTd5BsJU8Y/EeHgowUZDKjpioSP4Jh9wWGftTVVuWoUz4UMQG1YcEQIWJYSs4KnypZuw5eX/1y0n/bfdtDm5/3+oA/V7AHfN9j2+6yiOvBNLBgHRsD8dVkF5WV0KEUWuHYUEdTTEBSwTIko+eE3orAiEQGybKno6X2nk/jSjTHhkvkUBDLIQxkQPFGRpgEaUVyJAuLU786qgZNtLbZax6BvE6+nhcGVWh4+BvQ6j8hAq6UhPGsGMLkLDEvmVYcCD7c3zps7472dzlvv9rdPtgbHo74zs7W4d7hIc6eCGuhKlvmSPWpfxAKloWQxRpKJvlfUAj4PeieGKDJH0pzdRsQjSfoHwsY17cU0/PLsN7cALjzunfOdg9YzNU4p/d8PKcE1by6XIhkkNwRPjNyLNVDmfLo+KR7dYq57+L4X1fHl/ALaS2Uql0F3hqhW2qCfhN9Sxx7AW45LKcCl2EAUazhqTZAIK5staN0T3ZqQZnMYxQY4WdfMqJKmo2MTmqhFLrinL2QLdHagGCHdwCfwgkbciyCwYQEbrthKNKseeo12fCo9mWLdaNIopAANwkU2qKI5lHkkIsrVCCUBYFgnWeIGWU4V13OVDmfV4s8clo1CgYHcP64n3TDDGoi8olaFJbe4ln09gGenebq3A0qSiOVIkQLcfcAy61QG4OZfAiyScAHPh0RSoLEo4p+ZcaqpkdKd28cM5S9oS3kuX1C3J3HkH6aJFrZcCN88FH6dtmIrFGYyWckX0LSYN+rNFcR+A7HrWN3Hbvr2H1i7M43Xvg6w7cS9NlehD5XCvcjtaHFcwH6GPIepVnRieCNN+QGA4V4iPTTu4HfyoT+4nOKRc8fiI/cUr7AfLe0hy9Zi4q2WPpntkAGSY9OghFkIhF1iO8Zxw4kkqp2Fmc70WYowUHVEogIWdOwqc4ZB5WZXCnaDrEbLNLCqu8zvxECEWGty4A4q4qarkBeI8k1klyvRuvV6JtZjdZIch2769j9OmP3QSRZckXR4nGSzZOEm6nzNN9OO9gMOsy+SJUhR6aaRytIjJUYK6gjh2DY3h5ujw5CsRvx3Wh/53DUDvfbfO9g+2B7uNs+CKpr/fUsjssgq8dUxd7OjqRiAHE3gONyBc5lM62j+vYfqNeIEaY12pIscDPoHFT6ocSO7cNF7DjQmr3halogJFvDkGqmI8xp0DfBvqboCx04G0NeVPglTQJf6EoyEUDF4IdA+lyHwYtSAF0zbXZH+LHHfwT0TlbOIlUY58AhZYJYI2rW4FgSv6iNEPMBBUKwY8jOfyA69Sb6XUieXaDEpygxO/4cCoGBXiL3vWX7u31g3mCOuHQGXrHR66odrsABoCBwOavEnWt8vsbn6zV+vcZ/G2v8Gp+vY3cdu19n7H4BPvdoaDU+hw5PxufQt7XFSix1QseU/myYTqHiOSD3ZjoMc0PbzQUGJ1wBroQMjek0I52V7QSb7jhN0x+n2bxD37gP8PAw4kLHUm5i6FocZ7oDS4GF7ls8lS1IYGCsbKr0LZ1putlZknfwgICLMchcUe5OSuEJKjdJi/RrJLqwy3c0gdO2P/oVlEenHqRfHOmY6hwyHJHZwLMr3p3oNbCZQi3xvaXeLXKfBRlBtisT3z8mjz8JtkIOR2SFHMvU9+Bc0J8Bl3PiIfsfZme9LxF0u9kXTnzPFhIs1NoLk51htzZ7LbiBisB9u3jx07vBSzZGqEmh7o7ICYm1AQTLObgIpbJusY+Pg2h1mR1p7da+lGDosFEMAjN/QrHvlfAWcvwFJGVSaXd2JhxGPf0wHa+NW3Ee8b1qsiNp3Fk7d4bMi+jObF6nhVy8ItdzmfiuoNZ01JpEDY/x1bhwqr0O3cmbEOIXSfDYkraePbmj16zQwwIK3iDVeR5QE56P+vetsLDas/mo0WsivTof79W7iYR1tD6MubTF7IQO5fZZONHain8yhq6DYXA9ziGKns3WLU7apIhotrcqLDXdlE3ZBFRI/J1CYCjnTHyIqzKBEg14TUUuJD+SZSHmP9J5y481men1NSye2DPS4RecEJ3jGSds4oRNlwOs59+tTehYENsoA+UB5wC9mf0pE3hGKznP0Vqa1Yn8Jo3BpSEEVomKTTvuoTNLcP4XowbsXfaBFIyguvzih6c5PS1coGrKKrYD5jW4yG+sYV2c05vjt9yOwrXy7yYvStyd7ZqcqXj6R2fpFZnk75N3/6KMt84032Km8TAX3Y2m9fVA1ckdWlvcw7N0bwT+QitFKuFpqFZmV0WqZNKYZ+jTFNPhBG9nQcWQCp4h8ttAv9IJxSHAXQx+qPGI0NhAHwhaC2iUD2UM9FrsHZRXKgQVY2mF5yWA6q/a11iXoOVzNBI7KgwHACpJcgVjMcbyhHFwj0esG0kb5i4JQaWlRCGZJhhXjioiEt0GVdGiIsMk9myE28RQgVaM+MhcYEPr94hBkWgRf01jJsiFiMnLsF8dfj9GGzynORFxisUdZFAAU6Iyw5v+YIEiEFMW5IIiWpvxph9kN7EvEMFSxznDTgtKOnyVaptBJVqhS7cQ6jch8Sqjv21Z86m72eb4X3A30i8giPw3U9ytQnlyV4m4uu86qNd9MKhDo6CUmIDg2OPuDrc0sAq6x9futg2Wg2AFdPTZVZ6Von9ddw6Xqu03gZsExZVKvw0Q0N3Lp+vh/+uy4AN6LC9TPlOR65t/X9/Nvwfcobje+UxvWF/f+9Lrew/YYnZ9cmaND7MNrS/M/C8u/D2/l/QB/knX25cyV3yKUdMqZwXT7loaXrF3EU5cuia3A18ZtPCNGsUrd0V/OEbQwFeUYP5H5xr3U/8H81HrKw== +sidebar_class_name: "get api-method" +info_path: docs/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 by Type' (list-tagged-objects-by-type)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

List Tagged Objects by Type

+ + + + + +This API returns a list of all tagged objects by type. + +Any authenticated token may be used to call this API. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/list-tagged-objects.api.mdx b/docs/api/v3/list-tagged-objects.api.mdx new file mode 100644 index 000000000..42d938dee --- /dev/null +++ b/docs/api/v3/list-tagged-objects.api.mdx @@ -0,0 +1,85 @@ +--- +id: list-tagged-objects +sidebar_label: List Tagged Objects +hide_title: true +hide_table_of_contents: true +api: eJztW21z2zYS/isY9kMbjSnb8lvsmZsbRbZ76jixz5Yv13E8LURCEloSYADSjs7j/367C5Ai9eK4bqbX9PTFlghgse/7LAQ+BDoThudSq34cHAWJtPmAj8ciPh/+IqLcBhuBFVFhZD4Njm4egmsrTE+rXHzKu0U+gWeBjNVRzsdHRvAYppdfU674WAS3j7cbAXy3ONWRZiVtGImFjYzMkAHYfjCRlnUv+syIvDDKMs6QI6ZHjCcJy91y7Za3P6gPqqumjAMjQuUy4jmM5vpXoVjKp2woWGHpCYtouafeBi4zbngqcmEsiSVx94+FMFMYUzBCukhlHsyz+JZ/YqpIh8IgV0bYIsktbuFYBqauhGA3/9ohOa5yrmJuYtbTSQJMAw12UW19+90kzzN7tLkZizuRoCnalssk01Ll7Uinm6DMTZ7JTevphFFFJ5yJ8IqNtGGpNoJJBR9TMiiKacTHQhoBph3xxIqNQHziaZaAeJ29LTBtNBEpD44egnyaocywrxgLAysdGfdopwMPUqlkWqTBEaxL+Sf3majEYsRBC/Tt8XFjuTb1aGTFojrP6TGwDRoEK7JRAYZyWmUw0GbXtgDbTZnNRCRHEsx5L/MJa5F1Wqj4jI+lAtPDeqOL8YToeMN8Neb4Hcao1L9a+ZEu1KLu+yPWyk0hWkzmoFVQfKazInGqFKz173Cgc56EPVzdQpVmWlnBJhDo4P5kB5y4JBwmHCjqIokxCF1kgOXkqLIb6I+1nE+02L1AVY0VaCymqL6SKsJ1IIbNpRpDHsiRFUaCQDQrNuF3Ah6DjUg5OF+mGY/yDZQGAt0IsFgqVAwbK52jp1iBu7aIyN9I8hbyRNze8aQQTgs42+cOx81X4UEozxInGmqdCK6Cmp/QypW+MpIJpcUltGxuwBjB47wjndKSyvqFRZOhZ5RSMjtVOSROt2yIrqD+YJV+4+QCzkLP5yu07Wn5FF3GFlmmDRYRVD+lIyCl73EYUk8SW/JbVzK1sUdIodVy9ehSjNoybrWOWEt8BCdUrflR1OLiOBS1d8BjfSComTXw40x8ZB+CN9c/nfbfdd/1Tj4Ei96ApbaMUot262xt4b+mtc5WV1QgGWFxh2QBy3iWJVhUYdnmLxbXPiz6BDeGo/fIXKS29tyRXMg5g/qGVIgNqjOXjuFKWcsoNae60XnfBM0pzIs3QbfXO7m6+uni8vy0f3YCA92Li7N+rzvon7+Db73u24tu/3v8ePJu0B+cnbyF//Ctf0zff4SPl+e08Or8+KeLc1j7I325vuydIHSZmai2pCnt8eCcEX+PiIuWcTuXkY/RMOh4TmgHWYwYQYLEDEcWEQg3Gi7SiQ63X2+93tt/He11DqP9rW34FPH90eFWtL2zvYPbu+heZEBBweXDWQJpMvSPAlJriMgO57BY2iwBZIXEXsTpe8ivkqcM/qNDQRIKcpnTUB12HsOyxxI2ftbVVqWlMz4UCWGzYckQgUGoHuelT1Ws3dRiC55f9PoAXVewB3w/4tjusvDqwTZQo06MgRwSssta8XPAhIoaG+p4ijlHKqg8Mn5J6K0IjFjkkB97Ol5q7/nMrUQ4Nlwih4JYjmAhA4p3Msa8R0XIkSwtTvPaDbuCJtrb7A2PQV4nX88Lgyo0PPoVaPWfEQHXSsJ6Vi5hcpaLl2wrDgQf7m8ddnZH+7ucd17vbh/sDQ9HfGdn63Dv8BB3T4W10Igsc6Tm1t8LBZUgYomGbkH+BxQCfg+6JwZo86fSXNMGROMZ+h+AXG5uJabnl2GLtQEI503vgu0esISrcUHP+XhOCSq8vlqIZJDcET43cizVU5ny+OS0e32Gue/y5J/XJ1fwCWktdGddBd4ao1tqQnsTfU8cewHuOVRQgZUXcBNreaotEIgrW58o3Tc7taBM5mEJrPC7L1lRJ81GRqeNUIpcP8q+k23R3oBgh2eAmKIJG3Ls/8CEhGe7USSyPDzzmmx5IPuqzbpxLFFIQJiEA23ZP/I4dmDF9SYQyoJwry5yhIkyEk1bzFQ5n1fLPHJWNwoGB3D+eT/pRjm0QeQTjSisvMWz6O0DPDvNNbkb1JRGKkVUFmHjjB1WpI3BTD4E2STAOJ+OCBhB4lHlvCpj1dMjpbu3jhnK3jAW8cI+I+4uEkg/IYlWDdwJH3yUvl02ImuUZvIZyXeNtNjPqsxVBr6DbuvYXcfuOnafGbvzg5e+qfCjBH22F6HPtcKjOG2oeC5AH0PeozQrJxG88YbcYKAQD5F+eD/wp3gwX3zKsMP5gvjIlfIF5ruVPXyXWjaxZemf2QIZJD06CUaQiUR8RHzPOHYgkVS1s7jbqTZDCQ6qlkBEyJqGTXXBOKjMFErRCYjdYLEWVn2b+7MPiAhrXQbEXVUcup54jSTXSHJdjdbV6C9TjdZIch2769j9OmP3SSRZcUXR4nGSLdKUm6nzND9Ox9UMJsx+hKpCjkw1j1aQGKswVtBEDsGwsz3cHh1EYjfmu/H+zuGoE+13+N7B9sH2cLdzENRr/c0sjqsga8ZUzd7OjqRiAHF3gOMKBc5lc63j5vEfqNeIEaY1OpIscTPoHFR6W2HHzuEidhxozd5yNS0Rkm1gSDXTEeY0mJviXFPOhQmcjSEvKvzxTAJf6EoyFUDF4G9/9AsdBi9KAXTNNOyO8Pcd/7ufd7JqF6mipAAOKRMkGlGzBseS+CPaCDEfUCAEO4bs/AXRqTfR70Ly7BIlPkOJ2cmnSAgM9Aq57y073+0D8wZzxJUz8IqDXtftcAUOAA2By1kV7lzj8zU+X9f4dY3/a9T4NT5fx+46dr/O2P0N+NyjodX4HCY8G5/D3PYWq7DUKd1M+qNhOoWK54Dcm+koKgwdN5cYnHAFuBIyNKYLjBnHe6/Bprs7E+raRVkEhI6XwiQwp7y69AAmAtM8tnkm25C5wEr5VOl7ur90t7Mk4eDNABdckLLiwt2KwttSbpM2KdZI9F2X6GgDp2Z/zSuorkk9Sb+8yzHVBaQ2IrOBl1a8H9FjYDODJuJbS7Pb5DcLMoJs1yZ5/Jw8/tbXCjkckRVyLFPfk3vBfAZczomH7N/O7jVfIdp2uy/cbp5VEOzQOgubneO0DnsjuIFWwP1o8d0P7wev2BgxJsW4uw4nJDYFECUX4CKUw7rlAT4uorIyu77abfxEgjHDRgkIzPxtxL5XwjtI7peQjUml3dk9aFj1/ItzvLFuxd3DDypkx9K4e3WW5ngR3f3Mm6yUi9fkeikT35TUQkctJGp4Za/BhVPtTeSu3EQQuEiCJ5a09eLNHb2wRg87J3iCVOd5QE14Ppo/bEWl1V7MR4NeiPSafHxQ7ycSCmhzGXP5itkJXcDts2iitRV/ZwxdB8PgZlxAFL2YrXvcNKSICDtbNZZCt2UoQ4CDxN8ZBIZyzsSHWI4JjWgAaip2IfkzWRZi/me6W/lzQ2Z6fANVE2fGOvoNt0HneMYNQ9wwdDnAev5dUULHgthGGSgPOAfozexPmcAzWst5jtbSrE7kN2kNloYIWCUqNjtyX45mCc5/YjSAs6s5kIIRTVc/9eGdTU8LK1NDWeU5wLwGF/lNNBTEOb05fqtzKCySfzZ5UeLu7LjkXCXTL52lV2SSP0/e/R9lvHWm+StmGo9v0d1oW98I1J3cobXFwztL74jAXxilSCUgDW3K7LWQOpks4Tn6NMV0NJGC2v5M8ByR3wb6lU4pDgHuYvBDc0eExgbmQNBaQKN8KBOg12bvoa9SEagYeyq8KAFUf9G+uboCLV+gkdhxaTgAUGlaKFiLMVakjIN7fMa6sbRR4ZIQtFhKlJJpgnHVqjIi0W1QFW3qLkxqz0d4PgytZ82In9kLbGj94TAoEi3iX8mYCXIpEvIynNeE35+jDZ4TTkSSYVcHGRTAlKjt8LY/WKAIxJQFuaB71ma86RfZTZwLRLDVcc6w04ZeDh9l2ubQgtbo0rsGc2/9zfnSw+w0/A98/88XDET6mxkeSyH/hes8XIN3E8w1eNAyTEBAHHl4wDML7HYe8bF7gwbbPtA2OvTs9ZyVon5d7xEuVdevAk8BytckfZ8fBNgaPl8P/18vAD6hx+oFyRcqcv0239f3Nt8T7lC+svlCb1i/kvfFX8l7wlizdyZn5rqdnWxBabiFuS7SqE64Ze6ou7Zq4cdgpFIdP35/gkWar2h5/Afc6vHxv2RWYOk= +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/list-transforms.api.mdx b/docs/api/v3/list-transforms.api.mdx new file mode 100644 index 000000000..ad1f2c0e5 --- /dev/null +++ b/docs/api/v3/list-transforms.api.mdx @@ -0,0 +1,328 @@ +--- +id: list-transforms +sidebar_label: List transforms +hide_title: true +hide_table_of_contents: true +api: eJztfYt227a24K9geGYt2xpJlmzn5TM9s9TYSd0bxx4/ms6JMzVEQhJjilQJ0raa+qPmG+6P3f0A+JBkS0k7bZ0ia51TiySAjf3eG8DGJy+TQ+3tvvfOUhnrQZKOtfeh6QVK+2k4ycIk9na91yrTQooo1JlIBkJGkdDyWgUis41E0v+o/Ey3L+KeyJIrFYubMBuVH+gWtU6VDITMs1GShtlUhBqe/JyHKfaVCB97zkbwtHd80PaaXjJRqUQgDgIAA3uogNn0JjKVY5WpFGfwyQsR1p9zlU7hXQxv4GcyGGiVebMzOqLHIoxh1GykxCCHkVOl8ygT8KItznUOwEyFnig/HIQAH82nEYXjMGsgsBM5DGOZKWifJvlwRP1wF4iGU6XE+x+2cSbiNJNxINNAvEyiCNAEMIjjAvYP66Msm+jdzc1AXasI59zWMowmCYDX9pPxZhjEm3ISbmrTT8sv+mmVONgQgBcxTlIF80IUEeYQjRbH3u5ARlo1PXUrx5MI8NNpetofqbH0dj952XSCKINR1VCl0I474UfbW/BgHMbhOB9Tu0ANJMwV/r67ay5GPiFrDveH8lbE+bivUmQmgzHEaKqyPI0fDe62nvwG7I3lLf9NvRS4hF/3YtNP8ngemwcD0cjSXDVEmAGPAhtPkkkeMWMq0fixdZZkMmq9xNYNRPckibUSI5BEoABLKXy4gCIjCT0meRSIvjLEATkIB4UUAEZFgyWsIW4UIm8YAw4DoCFQMYx9RfKtdBbGQ9AgGYIiaCIg7LEYgRaBx0A1QhZ+H44n0s+aOBvSDkDDsYoDGDhOMuQSrXDUBnXyDc28gTARtNcyyhVjAb8GsHNtoXkUPIXzWcBU/SSJlIy9CqdQS+IVwx70n2adc+qs8ha+QAIjuUvNzYKXhjBXMUiTMb1GVbsQUp1NEU5ibm8BpBp6iodeZUrePv9VaG4Eo7u17VWBH4QRqfEH4X9FHxX8mWtkKoTW0kHoaZyBduFmfWTW+A8m+j94JgBZy8C5gdz3yj5Fptb5ZJKkGYCHDELmB7pKbvA1mJoo0CRZbPySVO9iD40GapY0llGjsSsa6ucGP0UEmidNoW8aKxBN3U6iJCi4raQU9iXUz+LCO5/A4L7U6sJ7gMp3dx9wNNYoGt9vdTr4nzrdeoXnULoDAqTBH1kCDsNr8BigCSJJIuP5CcwW1B10JieTKPRJeDY/auzx0zxEMk0lcgz0MCZIwHofDcgtMF+whzLHVGdktScwCxiOBiEXJxYW3dG0JYBMfq6zZKzSFkhgGFd9n7qcvLeCSMM2PZkBrvp5psivmqRI1SxkbDHzz8tOHcLzOAR5EHEhvcBCxeA1STsLx6Bq4Zc4S8QemAA2Om9UPMxG3m6XzI79BZbGALkUAsQRflEjoSicM4QhRlv23pM+6eWenTS86gMXPd3ZA0UelD/3Y/MT6Ayk5T+CEHuTEY4PwL9MwBSkyvx6xdaUfxxKmAFCCYI5SbTaCyUyD3BJdCjTK9Qjqvt0ZzJKYmw/CFOd/SCjMEBS5RHpyQDoDT5oFdQQ7MwtcA38pZPt7tOn8FckdXZQPI/UIDuW2E2UJFf5hP64IXMfI4BR+ItC/YYQAKKCZNyLJiP5NgfOCf3iYeW3GoDdBMNHf08i6ateFJU/8K9wODKDapAExIFGTsXmOu8XNIP/IjvkKLr4X43sO1avVcx6BJ/lgIIPVZapoVbdMsvvJb6eF+NCgYsjS3mcZp5G8HIV7RlAt5ulCthMym7AFlQlBWUDPHLZL23ijA+pMtkC2KWQ/STP6iatLX5AP0Cj9idpIfUDrGS9eV8Yt3+eqeEFeA3qVvkASEAxSKysIgkzwtkCJp/VMVV9oJM89YkrquqAfs9phMq3S6WyJwrmsfPh5uwlydQfFQbGgFzTFu+S9CoApXk3C9VK+iCuOBNFc5HE1eEqTr04Q0LoEbmTpPvZ66z2YhqVvdHb61CHwAdMTHLoUtbNAxCPJqpmM6iZPJuGdm2qe/vHvZOzw/23ZzRbHugUbHBJw5Umzf6lVcKgsgbhMGceRsMuBbe9BzmADYBe3IzA1gXoLWBAYCxgkgbsH5ADblxtA6jmJvAZsDCy8Rj8ihBmJkCFpSEpm3KuPsTYwLpVX7F4Vp/8HswPnGmc7GJX87OnbxqLdZTZTfI+NtrgcAGYSaTLiVrcaIDi3snZ2bcFxDjozhvL25xxYMndN3NFHNOwYl3ayfGQG1UkGb9oxpkukHNCBHiFVuNNGF/9Qdi5GYUgFRXRMQwtTc/knKNAQxcFU7UFYodGHESS3UtFrUltzqCKOYsJUemUXFCcbTG6ETZUnE2h0DmDEItDMlTMRBL+aUZjjD4wHPcfg7OMHfDoX0TZz6Aje92riDZMBLxicAI1UgvDDxArggaNDPosOH4MXmZyY3WrzfWI1TRDYQ7ZSLRNNFMZFp1+jFdZIngUipuHMox1VgMH6I7DWuRw1MEIk9GNnKLx86M8UFXViANYv6dJv2Q8FehDYJAOZC+B0dwX2EKw3n1yeEOEUPTe7pWen7U76jbkEN+gpvDkL+KjOJoKHywczMG8RrNecrAmqZfXgB98sStES1zG0P21OjCwXsIjHKZnuPNgjz4KQvCH5BRt1uwXFOriN9RBpMbwX40flVLIFIMJWFWsOI1QGqKR1KLavqZm/9t6HcY2+GRppt+F2Wj9wmvs7b/ZP9vfa1x4GxsVtXvM1n76pZwZauaQ0sIjFQ31C3MBmB6rcZJO/1jeLOyWkQyVUealhzw5a9tnqE56rQidhdQMa8lo8MNkiZgTzfxqJFkfpkk+0W2MHREqGHj901ovANqu3W2IX38VUcJxpPjmG7HWy5Fn14g8xl/TxzB+EoT+iRrAr9EKmr9nGQnzTxBAYKSqyGKjSZtRaFEyBOfTeEGUVGspbI7GGdVsOiVla1AA0U9mLaUVW/T5EDIBfqMPtFmqDZuF23pyzxzvMPCZ5FllsvfGykAG5BiIkSccq1XdG8QAZvUwvxD6MOrUKHaeAY5B+stYOqtgBkRR65HXccWGhlqi6QFTAfO+BmQsthWZvIKBSAKwSWHcKvqvhJcVG/ODFQoA5TqU1OacViBkYKPS44qjPpM4KbMQ85FBPaqZcbQ5Mv3JZAyqzr93Sj8oMLIEZCrdUd7MPpuJrmfpV48uHJc7Ln/EXF4kjRyXOy7/Crm8yIU+lE0iDl2QSzbPH8iI13u9m2N+cPKwCXIptUEn82OCkWAyJAGo8ud77/tkhBIk4H+nY/B6vQ/Oj3Ky94hlr7L88JAAlkERWp5EhxgFvrTNcSFADWX92ZywVvpYIc3r00JIqAG/mPinYJS5hNcNtVkETXMfAjCK9C4pA97DxTz669tLlCR4Z15cEg0v7TvKjdOagslgasqr5hkgSmN/CQthkbtvC4zsMLi8VD9fFkuVyFyU5MOg/xoXXCrA12K1WfhQeuaRuVJSlsGcX9g20XwliCUdgVrFpMdqENGDu0Xk+/8IxVxGy+MnTpU6VfpYVWl97fYhVUpDmXVqrVAFmx9Wn3y5hi27nl/HNCxTZqUDyaszAIEOcXli/YxTrWpmE5RZacJVYDFC0uHnVh4qarrIW224FUS3guhWEN0KoltBdCuIbgXRrSC6FUS3gujCNReu/bXCtWIH6MMrK9TcfLtgl7dxXZmbDSPjAxUWjGwJK05DnPheMbYwYUY/BxFugXjijGiDPL4kxrDGS5AKGtNmelArmlREg/wAUYGQBP4eUkut87EyR1zYC4GuDk6Pnj/tdM2gjYWR21sCCzwuTreVKLtH/f5afiv436+0M1vgXm1xDNRUaYzPylbi14v4V9Gy/4pmrdl/9WfczM5BFM0up/CvdXjYCoK1s7Xvvtsdj3e1bp+env54Ca9RvdtG9mhDG54X/7DXN3u9Y1H5Z3o9PAyC774bj6G7f1/WXmOv1KjsEp9jX8f7R8dv9n86PXp1Zvs6PNwMgk3ssdpLtS+KxQ0zHKsEnfvTBIJwMCjgPlG/+8dHL7/76ezgcP+n73s/9KDhP8RYswSPwyDGXdRN8b2McwlKsotuaffFs44ZAHwdZikaiVkYjXckJ2QtkVpoNEBHhJyqWN71PGDvDt5ubyFgFH7CKJRc7XY68ZLekDqfBSj02YplnDCslfGWDUNAe+WOfsMb8ATpCf+p0A9+zWC9/oSmW99vXm1d1ULfgyE3SoHlY1Yl3R9Tm6gPgxzwuTNawOLcDeJiwiKmxTTJrW1Bl8QcH5rVQ+zvlOdxMvItMIpBL4pmQTQLwgFlTrJFQ5kh2M9AzTOn7dCOjCAQgJdg4tgLbYsTzMZYj3iujTncNJFDtfhkGerBf709OtvfnZlEAbjGMfF/BDQCUQdcUo/wN8CfleCft0/b5PlEivHD53XqnWDbrU6n2+o8a3V2RHdrt/N898lTblfwZdHdseSd+KQH6e0voG1hDgKzb5ieI8yHurTBcxhBVLTpfNVipXrCB3rr+nROe/J7Umjtw8N2EIjXYk1ma8LqSvELKspLnFy786wNk+vtgRdQTvF47+zS9LK/v98Uh4eHAmzO2hoqtF/FOzRA3+eR2IFnKMj05Qg6F7KuNqlHcXxoPxmJtWRtzQcUXq0J2RS/wL9L+k4k/Bg+bha43JPTCMWa8cB9/AcN08Q51NVqh4dqIvQVFCAODg0aXr8WIwZTShy2QyiAmUwNEmbgpckHNH3sqUQgWgeDhx3CBHZU4g9YptMpYCityr/rMBPUXfh2p7vVef7kab3ZPUaOhy4Z88yO2t7afrJSDz/+SIby/i52iz7+D/xrrb1bu7lp5YtMGfXxbutZa9tq2UIxjsfWBnp3uJLO60l/vrNVhhr8OjO+tvO6nNflvC7ndTmvy3ldzutyXtfX4XW5LK7L4j6eLC5ybGXfzIM7XYxL8rlbXaj4gNvr4va6uL0ubq+L2+vi9rq4vS5ur4vb6+L2urgoyUVJjyNKcntd3KqLW3Vxqy5u1cWturhVF7fq4lZd/mqrLm6vi/O6nNflvC7ndTmvy3ldzutyXpfb6+KyuC6LO7vXpSgLs9pKkNn5Utmrgte28bpIG6WpuMfiYfe4+JtfvDkrxe0UhveR6BEafOCGeFcUpWfE/xTl7hzbdr9o+8Y2wRAF+BRtWFJr/s1c+9eLxh7SfoV0bvh/LWheDv+60uo+CP41C0HFbXuDzhnMB/7/9Rn9337dEXtz5op6VZSU07hO4z4qjevWzVwGx2VwXAbHZXBcBsdlcFwGx2Vw/moZHLdu5rwu53U5r8t5Xc7rcl6X87qc1+XWzVwW12VxH8jiHspstOQEduVymt94cU0t/jDMWTdNuDYHxgWPYQFRywNMSdwUMkqg8Q3EKtQQzMqo/IK+N9e0t43APnR5PRkhnLzYL0/teb/P7fWbOKcWwveP4n2ruI4HZaZUJnFy8z+6N3SICqgfnE9WUhtzp/Cs8rhHdxitQUOIfIKxXJDcxHwcTfJzpMzl5mX91Jg5Wmr9gZLcfOHPRWyOoD4oWZUzqJekVy657SWKwmVF8T0M9HrYVu0mrunFPtcnwAO40jfKBJG+WWeiouuAOYxmC+YSXoo8Do2CRM1jW2wYyBjM1UAjTP4W4DbqBua+Y7nOzjg78zjtjCKm12ovlHi2GdgvOpTplV66eOhY3rH8o2R51X26MxmBnl/K4oYtTtRwxV0oK9G6r4qT7hVapzSI5V2CT8T5uM+pDJO0KxK1ZNxr4M0TG2xoSeHzUz56XhZWILSnU9Mdpzo4mWzLBtF7gff4VuQPvI33B6dHYrv79GmrC47fZCRbW6bth3Xrnam4fRNehRMVhLKdpMNN/LUJDX/ihj+ZhjP21Ts/dYfWnW55tLqFOvgBL9NcErj9IVcDV2pSYARmWJvSnlTXBAts1QpNvP80g6AaDno+bssTezAHP0vSqTdXXsvTvUNTqIQe3DXvJQVi7YGxjq4yuaB/5ML4N3T73YkwlJzvWwEOkqlSB3sPDoBppXAYJ6naT9Mk1SsoJUmbHTGy4wpOrKJShQEb6hHMkCdinFxzmTEWvRiCZCPXuIcRBRnHE+tReIWyI95itaHjhDLNECn7ir7dEDeYy8cI3ffztL1UI/3d1W1NftM8UvUVywdkOF5Y6C5esdBcuem5WlPttYoBQF8gIIzVWKmA5JeM73VyBcjqT+uorZlQ28VLGfl5xAr1BOf1VVG6qonNjM0kVyCa3Z4e0hWlpp7UW/K2dPngdKL8UEYvR5KeRioe4tXpv4Hg4xwrkXEVq76yFcYuvJdRkgfiVKXXIUxW7CnURHR19HkWRoCOC69G4qXfe3fVKa62f7pa+srsvBeXQ0QtkO0EjHUyPqXmlzVYFn3BTkwNq6tUmrMYAtSYbQ8XtCv8wkPdecH3LcOP+5JqBhT4tsaAtl5YXBC4gB57v1tM8L8AwJrhET4AJP1sMeyGLVdjQOpxgBXgcP2SkrYUfBDt8HiCIWZQ1HsstQ8HCrQ0KvZMatNKa+nGkUfp024NCaZJN01C+DYc52Pg/Si5oSVJs9FFi50nncoEZ8KBbucr11rzgvPZ6isHZ/PvppSyE1sg1lapKzy0We30wKcIEGLvs6z1qQwj8rrEORZspXp869DLRn3tpGCJm1Giq7VSKXOvkZ5UQg6r1IG4IF9RvduBkrgS0Sx2WmBhVezwcixjOVTppbhS05sk5QTCFAiNOTs81pQkV5iLx4+xluwakJablBn2oTL7wcwb+GZehtszQrjlv+g+7zx/8qyz3d3udjud7rPOTqffeTrY3tlR/ouvWUQf5J4PVdcxnHv/cAT427xHkNMpBHBjse5Di6jlS62ABauu5ALljHo85YMWNQqrMTD110VGl3j5WyVegOPULcRsSwqW530jUfP1yYtXqyyW24/rBcmb5m+zJomcCqE4ameqIEstuDpttX4wgW75m4sJU+jO9c9tPWnjuAXl2PUSoRKLgf7kZNjJ8OOVYZ3g4sDSZZlBsYl+iZxWSFupiQyYV4ZsdiGj2CpfVvWnJC43ox2du2b3Aa1bbGHB5bObpFUELvXlknXVHrab4EOfn154G/8UWcV/tOsvJgCiDfd2eQcCtHwCDMe+oR1tm0YbpUqtMF4PBjSNId7FtAi3pvCX8kKLWz7f6VDLulKhyTql4pTKo1UqkRpkx3LZcsx9ub1VkyugajAPj7GWuX3AHMkxoZ7gjkorj5xhKhYUXZZyt0PVGBC1K/oj1c179XUFXMktlEZxFKh6/qF6JgjHxFLotJEv4XAxWTCRL9pgBgPBkBE6MxKYbf3CA72zUQEPkWZmPaOIvrI0kNNBfy8dlCRX+WSJCqKTGvMaiB8voPpDk76HI8T3p0dvBfeAPHulpi0WjImEOfKpFHhY3ENlYhy6bIou4MgyNZ5kZjWKLjvijSwF7zRtrqlM8OKPmqrjDqsCZm5XMKVaDASme5N2bjTegt/WaNj0lpW5gsetosHWPDYeavone1hx8X2GfpTxgTAPbnbPyj6uvhpmqVzjxDxqQ7cF3MzAo+sVX8W425S344BusyZgRvhoZpOJxRsiyPY4k3j7hO4cai/y2ySqkVcn+GD/cB/PiPXOT/Htce+lV70SqQ4IMafTnE5zPlLNeaNStxXVsffXyd7Y9C3G/lH4i+Nzx+dfK5/z/oIeZpPechZqKa9/1rYGpnY9AueM+dQGwRokbNNsqAZuLXccVDZAWP+UVsTNXVvsfjb4lk/u2W75kMIWTLQ7tZF0wFvIAfC+H8n4yrbnyhomDfBAUY35oLlYVr7c3rq03f2OGzAud550Lv8+WzCc6vkbqh6ndZzWcVrHaZ0/TOvYXUNLkn6Ltu6tvCHtYK+ynzOb2Ug+QSa2l9dW6EE0xr1lN5LvYqaLu8NsFMb4OBW88yC7Z3P5vu3yrHjt5NTJ6eOV00kkfdWLoj8tO9+r3Hm+MCm/L4Ha+Lfh4kLcTcGp+h4k5HwkIXRT5uLNNGkzrvE2zGd8W3k969wCqAQ8uvDgjzX44z//H+YqXCbZSfqjl/QlYp6CK39LzwqBmRd6/mg1G20OfEsrdiiggjooxDeMF1hlA0B9j9/7/ytbv/Ra//7gLSuhc0IjfJuHUUB5xXrpHBq/2+lSvRwj1uV8P2s3/ALNMrO6R/sVwywP+Ir1FKW3urpIa/4GExo0WB4H9VkL52E4vfN49Q6WEnQbkNwGJKeEnBL6s5SQBlQvug6mqoECFYXjMCN3gY4kzCuj8pPPcn7M0dhC+kp5q3hDZfk6DltCzVVyZo+6l/nHAb/pp0peCar/B4NlN0pBRHSTlOckij0+NZ1Tk+4ms3ewilu3VNNy+Q0VsVMkB5kR8LrKG0k8bQmwEm2YtSWVSP4n7xqiXmjXVqfVx9NdZuNWE/jU6HA8KlIf7aYs04OHSjrM/6Z89T0fdZtCZX7d53pCJTBGaXKzykHosujhOvL8JqkUex6SxXhe55EKMEUrKsqOBo0rh2QQo6xM2FpxXcTYAA8ISvjWrz56jrqsQZlS2WJ0pxlFtgog5cZYO5g+ipx0JNOhvWXNZu+taqVO7M56Lo7I2+rnKw/aHWEHdCYpz44G3xJsRY2OC69eyvDhjuI8ir7I3HGxkRKTwErcV5XUNiXhSoI4U/dVmLoMJrBooe+Lqi8tPTdfFFUi9U37a+1m0eLmjjTJhyN4OwhvVWAX1soXvr3nEJiH5YGL6iPOe+Cown9+UFHiI7OfYZEiHO6NjIc5Fm6vqW0e+r9jCX9KTC5LE5wSsspcvoDPcrQRRW2B36PkriHJ3z59WOfT4rzpw6zaV1jxao5T+XGJNuOSLODUhQdMKxFZUpQbMW5SYXbLk6aF+bmkcS/ppBqHZq3uQsVD32F5/3KkToHjQvHVTVG3WRztw/ls08Ez6uhoMIDhVpouXUJTdc9skaWFi/AJ1Rw2qtbCbPUheRqMDeKUCkIE10xE1V8t7JDEoOLJbQ0HpjujpVvdmc3d24smq+Lgd6IpuFZE00Lj30NVoKlib7vVRaVUtShIPhlFxocsjzwv3ABPUoWriEOqQcEYxa5rRC9GrqLi6T2o+GOormo28DfS3OCyxCD/XsgBC9n9b60gnd/1eP0u6G7sNjA77v46uTufTNz+fMfeXy175wsLFjvursRuH6pIrO5+e7hgHyGWavQC9b9ss995HP4M2DvY44lWT4zWov8tP3j2XAbD0cerj3J75+Noq98dXX0cSZ0rP2AJNXAsp9nBAjLV9jxjP2UxvJafKqJQSUhK7vu5zpKxSuffL6UK4nwBxk+UDIihq1WrEY3L5t80xdU8vNdNZ9BYnCV0413J+kFxLd6c0FUuRYUPD+mOsxbeNNYU1XvOvNmrXj38Bm8lOzysk8CkWi3w0ZXUz4PRx53+VS5hAs+eDcNw9CzakXo0KoE/BuYOb0/nswfVhEIdcpMr6Jj4crsGBVUR/YDqwNvpdOZTRC+jENcMqNa1aImTmbPayOoKN6YnwZQvgL3Gwjmo9HAru9lPIrGojU9KcvOj5uKP2h+psVxkLmYXnTJgspdJoJZLyiswE60h7kBHXUEgU5UbVve0yR6ve+Qurdqg7+p5NMBEuyu+lYE4MfN7aSaDOgDiyCvo62B10bVNQEUVy0ULhlXPlOw/7bzY2hk83ZFy6/lO99mT/ouB3N7uvHjyggotAutqOVxYIr4+tC0DTTdHhr8oXAWQgHsu/46De/dWlZ/bhUC3Vq6SF1XmhstimgZekalbLA4gvn15LHaeicjkL8HYzhQyU3HrHKUIlyp4d6UtdEsdH6VhPfNV7l4wd63u7b/qnb/Ba1VP9v/3+f4p/IV9fVi4kEdKLqEMgblJ1E7gRmKOKwJ0qKAtGqbXBkxImsJt5kNbLIHrMRodBi3M6AtaVLuuZmiY1UhubjO7YNXHZ1yQwCwDcpqu0fNxOallM8ENMQLNqNKNtugV7oYtYDWWU9qGFgTlhWGDHAuN0oIZLqGBWxTObjgrUVmnRqmW31SJgsIBkK+whupnOV5nSiXuK1JYcEuxYmvvCDP3ptagO6sgjVCKV7v6mSmH6icp3lMg+uj1gTNn1BGnLscytt8VGqtq30ndHTIwe1lC73yJ9yQvlbvjCNRPi6ZWvLhWRvgo+WScT1F6hVYjWfcVG1cWKauCpMUgVFHgZNfJrpPdFWV39uWJ0hOQRfuWXJ/uvOtzHssc8JuS8ZxzfVLFwaSwH3EMyIRsovdrXKTv352BYF8pWguAqBYjg9/RP2JTPgd8r6AHP+/bJUVr+ktaIICER57BADSRCnYJ7hJiQhSjant+NHB2+yEwaLzARcRa1LS3Ge+2TvPYhG5NESRKx2uZGEnQjxD04n3itiYOeKotXmB0nqTzJJ01ctboq7FGzpN0sutk93HK7oOeZAEVSYvxk3Q+Hst0ypxm6wvi3XwCPsBNqtReFCJHpJr1VrAzUfhYXt1z8Ppb3X538MxXO4HcCZ5uvxhs+U+35JNn3Wfd/s7WM69q69+XclwIWV2mKvRmOvJ1EyrFg1t5DMylsyQJatyK6E3VANUaba+wfjPgvO1RetH4jjvzvuPbJIO54W3drblSkLb/85M3gs7Uc/eIN16MQaHlepa0uIAuJS3w0NF35zo619GZH2d+vhrz41xHJ7tOdh+n7H6W67izzHXc+QzXcUegi0Un6/9M1zEAvwNds0GIG2iKOkPFaWGTfTRin+FZrKxw9Gpe5NaLeS/yLEnEoYyn1lnStUxkXKIL1Rt8O8ZvU/st7vsWQ1CRMd4yGCa8bTkcK/RJ8bwFH3wMuEQ69JtOWz062ccyU+6dN6OYPfXVezYT4LEQzygO0P2DHigPOgRF/TvmOA21flM+WJzQCROcMd0rrVDmi/zvk0W7BA6KDSFM63u2C3DOHC81jNXthNVX4YI6V9256s7cO3P/dZh756o72XWy+zhl9zNcdeMN3e+qwwcru+rwbbsjCl/qFW2G/aM99l5ley+XEjC3kQalDw5I0Aoe4qXeOAjehP2SWbmXY7ki3Pcc7xZ7fXdTRRWQ6g/5DmrvA27zHSvgTJwfOP2okiT24lUOFHs4JPqWPK36weRPQG2g8l1bTsK23QYeJzd0Ovl6e4HuKiuYgfYLcp9ij97xgQlW2kQjPkXNOpMGYIrZi3aKQ9AP9m+LslJxVe6mKUBkDEtyzdVkPIF4ZE3T122zO39mjjC38zS6WzafH7Yfmgd3cs88FqHvwbHgewFQzkzP453blkNO0XHn0ef4pDRGuGSwNTfYEX62Jb5VMqVzrbiLZv37d2cbYojuKqkLPi1fFJk5BhYhddizO0qwUeW8PQLeq+3ZQfETgwgmLC7iU6XEe3vZ91uwEyeg2Aml2EiRLsFWH9ZXORYPGNqUtXYbZC4prghjPgAKT9sXcUvshajF8Mw8fWOmyOdQ30/svGRlXl8KxD9sby3urUW96Y0ZKBi1733eA+6DDsAuZKQJW188OPfXqvSHQRg8wV5nYUBMGDjqO618S7UvhqPWXwv7q8NxEb+jM0b1ZoJ1lT2iciD8UZJo9b+EQNZBMXg/zEGKvhgsOtjUIolobXUqILV4yFbYAs+S4HsDghEzM8k+WnZybBLOsZBIXhJlQeYv6eDSZW3O9Ph9GBPUWMHhi2HGAVs4YIt1gDbws33TfLEszoH0ADPAy5L+pAkMoBWdx30t1OrU/Sa1QdPgA6h8j/dkl3/slgrO1sShF/h18Q2oYI8OXJm9Z/BbmL7QyNWQZVMKsxichxePMMUzeGN4i4VRtLd/tfnijHtl5uUojqa/t5a+R5P8dfTun6TxnKb5GjWNcZWR3WhYE1NUmZy9tfk8oKbjrvD/8FZzkRbwySHiKQucVbvBokC2Op70R6GiDMJESSpQ3kS+SsYkh+ZMpDKV0oZ0LC8FgCXEfGEE/bXFO6yK4QOKMTzDnbvQ68fExGnFkT+xZwkHDtR4nMd49BKAwPs+gD2WUDcItZ+zEoJoLVZ2Zgm5cUUrK5HINoiKNgUqEA8cDTDVDFGst7w+kRkLaKhNnhkQiRQxZ+rKiZyoiIsWeavWPrJ9A+e0RiqaYIAIGhScKVUZ4fDgbK5H6Cw2ixtJOtw0jfQmfgudYKjDzLDdhrCQCrImOoOgqdLvm1BXbmrQs3z0qUyqe69Vpk2FQYpMUfPL6/qJTQpPNejEntHizGxF/y1qjcGc3eKT0ak/e+CVqIk90x5uoBeRi20HOv2bE0x24VRyDkI4znvvVaYAkcMI5olPP33CLAgGPXf4GKL/lONNQDrydVA5OXrPrLmGTHkyfJBTyRpNQqqytjjXOcVh9iYNU3u2QQs+DUq/ySEe8Fa1AIK7QFSR3TJB12kGmk+mAQhEFLFJEccyBVph4ZnVVZ42/YBPavtpTYp+7rFk96H6SmFeIuFiOkXqwaOTy6sj8lDeVqrpmOlzpXJc4nk8iCDCfjkeDgaigWmxhgjNpciTZJJHzB9KNH5snSUZxFUv8Qh/o0z9mHXCQnsvwCVds7zoUmTLjGhWG0zIhrih1bRhnGBmBi30aRj7RZKMg8YMQeHLjqmmAp+0wCVOwhZ+H44nEouKhhkLMmB/rGJMHeJaLV0tgaM2qJNvaOYNXs0DaE2FT8SCuX0KCyExNI+DG2haX84Nbys37tRK1AL5UrLCRcoXVecSYEwFhy+E5VUYoSW37FQWEbRo46TprV0A5uzwH0sj8N4QSICsZeAk5/KVfUoZ23wySVJKl5t1hUGC94fha1rL0CQIXGAwSfUu3U3WsEnLRmNXNNTPDX6KKDVPmkLfNB4mAEOnazT4UGbQwPZ8gG9ZlMkQcTPOzldaza1f11Kcr/fRGZD3hFbmDxzq7u6/AH3kQ7I= +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Query Parameters

+ +A list of transforms matching the given criteria. + +
Schema
  • Array [
    • attributes object nullable 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 + +
    + +string + +
    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 + +
    + +string + +
    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 + +
    + +string + +
    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 + +
    + +string + +
    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","enum":["LT","LTE","GT","GTE"],"example":"LT"}}>
    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 + +
    + +string + +
    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 + +
    + +string + +
    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 objectrequired
    + +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. + + +
    **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"},"additionalProperties":true}} collapsible={false} discriminator={false}>
    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 objectrequired
    + +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/list-work-items.api.mdx b/docs/api/v3/list-work-items.api.mdx new file mode 100644 index 000000000..52486ebf9 --- /dev/null +++ b/docs/api/v3/list-work-items.api.mdx @@ -0,0 +1,95 @@ +--- +id: list-work-items +sidebar_label: List Work Items +hide_title: true +hide_table_of_contents: true +api: eJztXOtz2zYS/1cwvA9JPKYsyXb8mLm5U22n54zj+Gy56ZybmUIkKKGhAJYP27qM//fbXYAvkbIlJ9M0PfVDKpMA9oF9/LAA+NnRkYh5KrU69Z1DJ5RJ+kHHn05TMU2cTSfl48Q5vHHwGTMPP246vki8WEbYC/oMJzJhY5EmjDNPh6Hw8AXTAbvDXhJ7sZEItRpLNWapZkKmExEz+IclkfBkIIXPskTEL7k/lYrF4vdMxsJ/tcm0aeZlcSxUSo06wFfEYz4VqYiRu8+ORD5+z0Q8g3cK3pAoU5k688y+4/dMZdMRkAcGY5FkITAOPMUizWLV+UVdCcFuftpmg4tTdpVy5fPYZ0elXBcF6Y8vJ2kaJYdbW764BflAk52EyzDSUqUdT0+3pK+2eCS3EjuOW+rHLUV4xQIQc6pjwaSCn1OaDxQzV4RzGPAwEZuOuOfTKATx+rvdTSfxJmLKncPPTjqLUGagK8Yihp5mGPNouw8PQK9ymk2dQ+g35ffmN43ii4CDFuivh4fNdm3qIEhEU53v6TGwDRrEeQqyMLRaZfCiw66TjIfhrDLPdzD5bINmZwMVH3EwC54K6B/rbDyhcezEfDfT8QWTUah/sfI9namm7k8DtpHGmdgAFwOtguIjHWWhUaVgGz+7Q53y0D3C3huo0kirRLCJ4D6YP80DNmxxhwmHEXUW+uC31jNg5mRQzBvoj20Ym9hgdwJVNVagMR9mDOZMKk+QF4skRZ/nMNHACiNBmMcVm/BbAY9hjkg52F5OI+6lmygNBJRYwIxNhfKBsNIpWkoikOoGDfJ3knwDeSJub3mYCaMFbA1sQ6iw3HwXFoTytBjRSOtQcOVU7IR6LnbUOyViiOUtYyVpDJPhPDQM6RgnH02hCNiMhnmcY6fX7/VGHufb8P/+yBPB616/z/1Rvwe/e9xzHj5if2N2CTLS73bxf3XyZ5Bz6tkCyHoavAeMHlrzKAqlRyrc+i3BLp+bsvE45qgF0798rke/wfRgxohxOlNpGJF+Uy9LqMWpit/3Dnr73f3tXb8vdnuv97u9XX+7H+wfdD3e293voaKtD9CMrECw6LYaQTACiL98lNtTlYFjmUQhn52TlTzFyRB48E0HNKvH2XqrJ4pdQViYtDGQ2+NSNEsNULcvlp5GWV7kqqxNBt5yMD4rKIztxQJCbatgRbz3oYWbSqBfk6Tb23O7e26vN+ztH+7sHm7vdboH+/9p8gQ92d1EqDnnvOMJy8kDJ1PtU2p9Hiv7bve1298d9ruH/f5hf7/T6+6sxkrIwYGzyCd+WmahNtJSplc+edwFj0gJjHsmsUDzRGcx5JIXg+MXqBqI02nr5AuF6ffGeQOZOJkQ35cCQ4X9aVIe/Dy5jyj8bToXkH5M5yPMVyE8/FhlpjJUUyRiBIXhNVFSmVLfHHNfYbN3XAFoKmE4yGHYXyzGjwKsVXrIGwa5wMZLEmUqfJn/dQxsj/M/BhEERUic8PMnqUN6fClupbiDJ2/AcFBoDbF3hq913u1oAohOqDFa0inl7IHi4SyRGLevEAcEASruVhBoMdIMPNt7CAGkrreS96baUN42E5jX2xDatagtLoU/nUsMecKoW+tXTSD1iObNTcxqiSTlMSyxVo+jNarMjPJM4s+Lo08y8Bukj06SR1XT4LnJajXKgCBkOPB9gChkLRWg8TxZq0jFBKIaPfQBQL3HEE+8VANoQ5opDD3KUvFMinl3QLwItK3MFIRKwtFEK3FOML9G832+9l+OcFEqaNewVnWWaiyY9FCj/hNC9uUoG3S/ksy7vb67u7vrAkjtI1lYYoLyT30ISjKdLatpmjBpO+UMtBkxYgNjxUDtoQxQl/UIdCxSsLmkicEHLLQwuBKzLBo2pkmh+htFsZw8MfQigfiycgyxOXpJejahxyKAtSUkW1iIznIXKzlZFEdaMEjFNf8Qv1ZLu3NhzqBX6rUwRLUB3NU8uEqr7Nrup7fLu2d1WNOtOiT/5wjXzm3sF/AMEMX7gEp5C4Ha6fnp1b9O0PAuT96eHA3tz+H15Tn9PPn54vSSfl2cnB+fnv+IUGVwfnRyhg+RdB2tleN9GVpzcCU+J9nHaggYVHx3Cf839VIqaigBhp9qrGYYuzd4f3nbKnF6w7IG1sUMhG6bHJgzaPrsJc6+2+u6vYNhb/tw5wCXONv7uy3rCoynuLbAitNEepO59UXJRAuHYBrzAfGRoluLjxeVL6N0qRavNXoHLQwgjVbz/Splh8BA8C9bAi9nLOeVaNcga03lSuQVM7s2aNCyFr+MZSIRZtq3WWVJCytpWGHoHGsKS0k2WpVM3qVTI3URCp6AqxMlFsR6aqUPQ31n62Qm018nYFArJw3cqjBunEzyUir8ukMbk0lTy2+5EoWQRvi2TL8wsy9rg6sbBE736Xy6fSNF6PdqWCdvVwa5p3gB8xHh08ycYbOcG6ubGjNX1lgIaQSWjRW01wjHeU0yFynplD+pfg2TaYlaabEkvgW2SnrJNVDh8QZyAtZDc2XVezc5sO+TmlfOa7uq6UYKAuJxrONl1FBWhkt+5xIIhCWzLcCT6mYO/IX19gC81u809wYHihFNlMJwY0bRtKHnMz+LaU+wFnWrUlaW8/jfprPT7TVLyNeKZ+lEx/K/MKbLLis7FrjTKHBDQWmWNzLg2uyD0BajacfefhhCuv0kFLYXpvDTeUYxeoG1kwKazA/YFNAdH+d1r1GuEdO+FiOAQUAS0jcSBDD5wj8kvkuOjaZIVdtNamA2I+nDiqapJxOyZjqDORMszpSivZtkk/laJOpFandtPA/4ZbTjh1SV75oNkq+nKZ/s+kj7S0SqN1IJdxxziYKQygA0+IIhXpJYsDMbMWbI3JuoXT0f7HS7nR77gfugFipzsyMrDJpjzL1PMNYyBZhrJaE/y7vA8pGS2AKyYk/w0evuQX8neL3DeX9/p7e3OzoI+PZ292D34IAKvMY+2jy5TtqW0lioPbASdAZAd4nNork5Lbk2pDGWTLOmbSFmbs+puE83AUP/cHTBdvZYyNU4o+d8PKcE5V5ftSEKM/D7WI5l6xInXx0cn7wZXJ8NaUXw7+uTq2GB+BvxSCofzVIT7oN8TBxbASi4ESAAx2cbdtQNEIirpNpQmr+SWYKx0W7NQQ9LvaVHdegSbdgdFUZ+c5+yl7IjOpuQXeAZoFeAwyMAKX5eW9kAfCSi1D2zmtywQexVh8EiUaKQsDSmJVgC/We0cvBxC9VC2yADjxe096uzFEO39OZwUanK+aJCHpPPqpOCzgGcP20nsErOgDkSs+qFhbVYFu38AM9Gc3XuhhWlkUpnKuWQKT06ZeDpGNfgDNaikEoSZsMRTlcCgUfl7aSiKNqppZoT5OadYeY41fTO41myhN9dhBB+XBKteHErrPNRqDTRiGYjnyYbkezJCepsWxXTlTs+CxBVrH137btr313Sd+dfXtpzCPS24Iq8xeKkJJtOeTwzlmbfmxoQNCiPzxQuVxTIqmgFB2MFxnLqyMEZ9XujXrDniR2f7/ivtw+Cvve6z3f3enu90U5/z6nm+pvSjwsnq/tUZb7NPJrilYhvAccBIBdxkmrt16wV1RuLAMMahp4CN4POQaUfS+y408SO54D03yDSB+wYz2HHfPzryzNTtjXDo97Mliw6LanOrAAQUtLSQdzDWmsNHdfQcZ1+1unnL5N+1tBx7btr3/0+fXcl6LjzFHTcWQE67rDzvJj6LaGjL82Z6wAmBS912MsXsYhAFPjFi52Z8jhEAfRqKLJ/0ESRQ63ZO65mOVhKapVIVaoLwxu0nWLbOG8LDTgbQ4hUeHhcArpFq8IdRMCkuGtLJ9TRj1EgGDeeuYMgBansuXdrbwUVqbwwAw4pKOAlFaR7xyUeIg8Q/sEIVAcdQ6D+ijVOO1tfVA9mlyjxGUrMTu49IdDni/rvbttp61NgPsZwcWXmmix8Uc2cK1hGiPvIhK8Cgq6h+hqqr9P9Ot3/NdL9GqqvfXftu9+n764A1S0aWgzVocHSUB3adrqswFJv6GbeH43YyVUsB2TeTHvmXEWJwQlXgCkhQ+bQcsTTCfyxhect3Py6nQH+ho8sDuF9fhPyM0wPTMtDh0eyk5+EVvqOrkPebrcEG5hK63wQrvzMnMzBy5eGSIeUGku0WxPkiIBRsb3i6BS3Lh8dPz9uNYOFBzPDbOKVEWtD9BgPEMICwh6u7ZDNNGQE2a7j8OEpeewl0gVymEEWyNGmvkdpQXsGXM6J55hDRImAeaZj7DBfeDztyESnQYZze/Ox2uYK0bjhsNGyzDC4D9A8JPkem/XZD4LHeJiNjsa8fPth+IqNEYNSDMgShL/2Sj9nF2BGFOMG+TER7ERpp7zePagdxEGfYkEISmH2tm5+TP8cgv8lRGtSO3YSFCCw1/J3dXmt34K7ub8o1x7gpkNX2MaKaO4v30S5XLwi13OZ+Fs+mmtGc2m05NUcF0a1N14oMUR64Ng4BA8T0taziZvx3Mp4uLKCJzjqPA+oCctH/fiUl8/as/mojefieHU+flEf6ERwvRsz8Sw/VXnKvInWifgHY2g66Co34ww87dls0TFklzzC7XcrLLmGpCtdgIvE3xk4hjLGxEeYrgmtaFM4Ibf9lWYW4sKvdGf+15rM9PgGsiq29LW3wgX0OZ6RoIsEXRMnEsu/SVpoWODbKAPFAWMAR+X8UySwjFbiohmrNfLT8FvUB9OHB6zSKEl0aP44LIOg/cXoBbYu2kCYRrRdHCiDv5kdCzNXTVl5nWBeg01+Qw0Jc05vht9itxOT6J9NXpR4UJZT3qtw9rWj9IJI8ueJu98o4q0jzV8x0lj8i+ZGZO1CoWrkBtE1i3sJfUMF/oW35KkEtGEZU342pTpMFPLU3GgAn/YmUlBZIBI8RXS4iXalp+SHAInR+WHxRwON6fZNDAxzWMjJEMbrsA+w7lIeqBjXXHgcF0b9TdvF1xVo+QIniR3nEwcAajrNFN5QBCayKd6leWp2fZl4mQlCsARTIpdME4wreuUeiWaDqujQ6iOeJu8DrB/D0rQyiU/QgjnMv+wBiiyvIjilIJfC3ELHdnWI/tTYYDnuRIQRrvogggKYEhUK706HjRFhMGV3LHQ83rKdki1si9ffQHhjDNsdWOvho0gnKSxRK+PSNYHKt7Ea3zooKuXf5CtZNm0g3t+KsHiFUmRmjWKWgTdOZRkIi4YJiIhPP3/GqgauiR7wsfnGDC42QN9o0uXnYBYK/H19aatVVZ8E1gnyD4nZSoBDty2W18P/1yeyHtFj8QmxZypy/b2r7+97V4+YQ/5Rs+daw2MfrXrMCovvY5WEP5aVHKqeQBwkm6GIZ7qZsm6lV2PjE0cpSm0/nkASefgfKLhOXA== +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Query Parameters

+ +List of work items + +
Schema
  • Array [
    • remediationItems object[]nullable
    + +A list of remediation items + +
  • Array [
  • ]
    • approvalItems object[]nullable
    + +A list of items that need to be approved + +
  • Array [
  • ]
    • form object
    sections object[]
    + +Sections of the form + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/make-identity-decision.api.mdx b/docs/api/v3/make-identity-decision.api.mdx new file mode 100644 index 000000000..02cc4ed47 --- /dev/null +++ b/docs/api/v3/make-identity-decision.api.mdx @@ -0,0 +1,99 @@ +--- +id: make-identity-decision +sidebar_label: Decide on a Certification Item +hide_title: true +hide_table_of_contents: true +api: eJztXG13GrcS/is63A9NcgwGDH7hSy/BJKXXsX0xTk7r+CRiV4CaZcXdF9tcH/77nRlp3xeM06Tt7aFpG1YrjUajmUczI60eK2ohPB5I5Q7sSqcy51/EwBZuIIPlqbCkDy8qe5WAT/1K56bSE14gJ9KiBn7ldq9iC9/y5AKfofloJlj3csCQjM84sw0JFijGFwtP3QmmPOaJO/UFfrn0NFeeYNJ0yiw+X3A5dZmV7ovJQMz9GusCpS/CZfcymLGL4dtP3dN3g3Ok0usPR+aJh8FMeUhM+tDXf0LpCRtZsLjjsGAGpcBkjQ3FnRT3wvPZBAhQebZTi7uMO36h4cj8YraCYboqYH64WCgvoN6EH2iKGWIgDt+HcWlO3oIkPJe7lmBvPRUu/BpIecE9PhcBMASyfqxIlOiCBzN45cILeJI2/PatmZjzSuexEiwXWOoHnnSnldVeJRpspRN4oSibncEpUxMYytMSh3/vZ9KaIbs4n/Fk+sCDeIBGDnYuJgfHk5PWQetInLTah81xezw+bjVbvH14cHJkH1dWt5ovEMtrZS+R781sdkGiblXMF8Ab9zy+RI7jzpGdsQCObIEys5QbwDiQKiiYY5jf/81HUo9FWRFBaEf6lCpX49+EFeAkeGgRgRT0FgRekHOZWKUdidUjpYr5faaskLZpuFW/mw0sxQ+OF3lxwzkacvfycnjxvg8lw/77i3/10ZQTPpO3oCBUkjH8GBhWWlzKF3bftU95IMq4BlOYc5ihig0VqoEETU531qw3jqr1o2qjMWocd1rtzsFRrX5y/Gv5eIEE44HRTM5CX3g/gGlZlvB95s9U6NioHgFHlOD3fFljV7pUuc4SX/kiIOv8rEf+OVGtGg5oHDpfUqMYK+UI7haYGbg2SgPM/34mQM5eMhUJF3PufQF75z4D0w5QQzhzuDeF2thNqZKgRZAlW2o+F67NA6MMbug4fBxV2XtCcYvtn1ambBs28dScDboDlDdqEs5cpOUR5wYLJ1LAiO8loCQMGzllcgJmnCd5D6KILDceMVbfyw2PJMB9BJunbTfBvzyQONInsRtaBufzI81wc1MZUmXWQOPQP5uV2xXawhwwDKptreRFEZMMY/0tskISwiLPFnYtZyfNerV+WK2DnRx0WidoJwfH7V8rq1Vip3pJG2Ynf4Uwic9BidTyXPZMzZgLVHA3M+nxNGb4I0VAe8R5d5SLWu4KYcfWCRBFS6ivQs8SxHayENzotS1lEWSIt/mhpbFnLt2BVoUGPPAH89Bs11fpCdUovhl8D8ftdO9pCNSAoG0uEWNquH6Aer9hqIgr2zCBK8B3YwIeFTByu9Jy9xdgDxoqmvU6/pWzHfdpByFCnueuwRvX2pTCWyeN4/rxQdtuinbj8LjeaNsHzcnxSd3ijfYx2udmVU4W5QzjqDran0r3dqWldHHvgjS7WoJa5Qg1+lBNLQXg/Y2W5+2T3WMfaxmIZFomloJVELemu6TpSD+mO8W58DzhAAbZVwEPQvTV5hyBQHlLY9pDTR5/on19ncMTuhJcupQ7GXGVBa1tPJ5oLp7uNCPR0v56kaqeI9FVNEVF4pEj1Ou+u+wO3p6XxzLYCjvUUwP9AnSDRY0FEAGAnAhPgAufA+qY5Co3VxvYeNc9777tD6Hk6uJ62Ot/uvhwrh/73WHvp83crRdHRDa/NG7nWsYl+U7IhxovqYzbAMOwRkCQBKss6B24mshE3l1JeZebSOvFKqfDBXRC/vK1CpJgF+jxpeUZv/MptANX5dpNyEB06WYKCtGgGT15ktK1nBC4yrYwmAnGxF6kIRRhOlNvAmJiM47RI+K1CnHJhU4w4jThK/QK3rxGm5e1tM5eDIf9s+6ofwqF1+epx4wXnypfbUaBJ/XhFKNSmOeUuxutQhCiiSTIRqhMQjU7RGo5MeqABGL5X1RI02AaJxSRCAbcMaE9E9BUSfKpYkXORuLAs9f4esJDJ9jLcohBejmXacl2z84+nfZ7g6vBxflVHBx9ujg/+yVTfn6ReswIPfMm7ZlFyDSMUMO4ZdAsEPYWEcdPHLQhIxZQYPDM0BH7sSSCSFSxV9KLhCUbPLRymA3nY5hhsKeUOqPMwMrnORZmyFXMB6ivTeKOBpaBo3bKTYb+D5qVDJsjFXBnSxYDrFvOqNTOaiZi3WNjFcxirohNMOAyJhv1Mi4NtuUclHrjGD3yZnvUrHeazU7zuNaot35dFw5strEIPrEFGayygf/v22fUR9xpPLHv0L1/rrqYDMS+ttZ9bn1x1b0j7KlI529wEc2qTWYCmqUTELf/PVqyDX8ZXlrlvITb5zlK1tXQpDHKXMN8yAeT3ahXGyf5kG+vonOJW/ORX47XpFaSjBHGFDpdqSYTXJkKRrU9rxHF75dvE94f5XeW9xelkmO/EyIe6WxHnapmyeOqGfkO2Y6i7v8ZCD+oAYJt4+QOTvvno8Hol6fdyKe6jyllMXG9s/dt8Yr8vhRObmI7B6F/JIsZWN3IYyF1A0Zicl9ofTnvLDaa/GCyRoSJu+9hahuQ6jvGees7zaDR9hFffzgavBn0uiPw0XIec+bVDrh2wLUDrucA12rNhlE+5tku6NRBPlVm8J/w0rnorO3rrHm0wZpT8HjfleJKsxeQG0EKbqEc4vK+5ymvJPOgN8cnFGiUABSF9BDTCmyeiDyJ6WLGJtzxMUyjmu+E7/OpKHZ3WpIpyfQXdbRmdyixqFSefiPPuKcHBVsCjBV6Hs4PNSlkYD66r9jnq1H3bf/0c4eN0hkk6cOkQcAGWqU3dLkVyDtKw1Crbm80eN8vaUX1hCE9eHsek47dVhxO0XWNaOzp4I/yeBb4+6DTqFhxLPjRTeGP5h0KNDuYj6Muc9ul0ctS5b8kaabVLTpgkd1UDRRUwmqtsnx8z5EoZ1JLVmVDEYSeqxNJ2kZpgx3CXJuSTdK94460v2aHfM0CZ4sA0L6n7C004410RXXqcYkcklqBfG3BMPqSNs45nfnQJCOtoXpZ0AZJ1BrsNbfZ0IyvZwaD0vQgfgNagy1W3mudrY6a4CocbQWWdCuOBB8f1k+arclhi/Pmcatx1B6fTPjBQf2kfXJCCK0ttmx7Mtv1W+EKT1rMURbMyH9BIBqAiIHIerc8jUA0trRMXTcepuGXBeIhABNgr3uXrHXEHO5OQyrn05wQ3Or1VQFYYOSa8IUnp7I0kxzZzmn/Tff6bERZtH9f96/gF9IqrOSYJtWb6YqC9Jm6J47NABDafeGAODBD+8pQfQUD4pRMiCtK/eQvfRBmlAWEFqb3khZp0nq3O21KZDcPAXsha6K2BxAFZbCmWjM2BoO2I1x5hXtFi6B6ZiT5is0EB0x5WWNd25Y4SO4wsEYgCu3pCAK3cV/VJKomIZiyoBNNKgwwUSmtbEYkJcoCzBtIOUtPChoHcP60nnStIATmaJhpK4y1xbBo5gd41pKrFRaUSGgk0qUbIErjoamlTtNbgEwwNhn4zMARTpcPwONG9WLESiNlP7U4aoDELZXQ38LuLh2AnyoNLX5xJ+KTALDoaDSi2YimySAS7ZxqW4lqxdMVGb4+87Cz3Z3t7mx3S9vNvxyaUwhp16dRdH2uXbMjhotnwfXxSHtwF81UMj4tTSTtEBkX6ecPI3N4FOqLhwXuBH1D/0gv5cVzFPF86PIxebzRZGXmAhkkOZrjV4BEwu4Q3wnHJCgtqoNib2+UN5agoG6Ji0jHRJYq1Bt2oesiJ9zfo0Os7g8mJ587OyJcu7pQ0g12nuTOk9ytRrvV6O+zGu08yZ3t7mz3/9N2N3qSMVdkLcZP8sP5nHtLrWnmvT6QDxVYdB42OdNKU5X3VpAYi32sStZzqIybjXFjcmSJls1b9uHByaRpHTZ5+6hx1Bi3mkeV9Fp/k9hxbGRZm0rNt55HEjE4cXfgx4UuKJcfKGVn038hnnKaIKzRFyGR30xn8ujsr/EdW0Xf8VwFMDYgDL6jtya9eD0808ceNXmUmz42i0abOiMZfxclHqT/DY8I71zHneu4W352y8/Oddy5jjvb3dnu93YdW0+5jq1nuI4thi7WBF2sP9N1tMHvQNdsIvGsdryD74kFDAV+meyjMfsAP1cNYkcv40U2T0q+zFCKvePuMnKW/Ewm0k3EhfCm8MtyqBt/NQ8VOJsCRLoMUEsqfVgKv5kEnxSPpDhyLsmOcUBA11tWu5MAN/3JZiJ9i3uJv9JAUMCPErFfPHgAVjRB9w8oUB50CkD9DXOc83UHOp6RD2ZDHPEZjpj1Hywh0Obj/G+77JTAAI/JIFxc6blec1xA58y5C2GEeFho+Ipd0J2rvnPVd8v9brn/eyz3O1d9Z7s72/3/tN1nuOrGG1rvqkOFrV11qFurs9iXeoPK9Yd77GQqhgNSb6Ys8tXtxAcnvwJUCRlaKEq00n1Rncp+9u6p/Udpr/bxGze6tENHApqx0HOg/iwIFn5nf/8R5gvmaVXjC1mLjnu76h4P7O/fHZSgDx421ZYG+GWHFkUPeDeW7qRGUvYkKrJGPepAy5zGhSoLsqdTBhvpRx8zLCESYZrMHn4DYJSKivEYL0QUP/hUu0ZKVBgjjO3ac1ZPjef9waZxaCJrxlEmvo19QX0GXOaGh+zf4nTBxAMhmq9r4Ken4aob4lzf3KbrXKF7rjks1EyWHNwYaBYYusBqTfZacA9iB31W5sXPH0Yv2RSdUgKF0Ed/WEiMIsCsLkGNCPS60bkRbETrkKfCqb7ipps5mYNGxiYOCIV9dK+EYDfReehzWA2GAN8kdmwkCDGw1e2LaPZscSccXChribRROaXt7oMU93mm3UtaFPUNc67+KAI/I/roVtmpRKyS0bVAZogUDLKbRTQunhrX1zLxj4haVVOrEjX/ZY4LLdobS5/0tsDSkQR3fJLWV3eu6VVT9DDUghKkmucBJWH4yJ6nsqJZ+2o+MvSqSC/Lx0f3g77UK9OMaYCLLtUaMGumlC9+ZAxVB03lZhqCpX01W3QTU5Usotqsp1iq6i6rsgr+I/F3BobhamXiY1y/yX1ROpNCZvuZZhZw4TN9ZfA5M2YqvoFlFmvayvK/mmfssIodVjVO+IZ/vYqhYoFt4xgIB7QC9JL5JyQwjKZwUdMqRX4iv09tcPmwgFWi4i86+qGTgKD5xegF1o7rAEyj+x2fMMObBAwtXMoywooSB3kJFvl1FKygOblpfuPtT1xV/2rjxRF3k/wK3lXyrVF6DZL8dXD3T0K8HdL8HZHGOMSYpxwm1432n3UN3IYb2AoXXW66uDJ9XVvxJsZ8ib4AMb7vcM0NhJkLCDfcBrjmgrgtL+WDbtBgaeJyn6shTGifuJgv9enqCJ9u/yWiFLtAZKhv6kUvME1m4fAAUYFQ0ZpJQZmWheAB+td7aJlqTkgGYkc+8eIhJDSlb2g9mHIOsbF08GNU9gFCWdeCAWAYiyecgepvysSzV6Cnl6jm7DRSfYZXIIUu3ssETIRzvJDxKfuwpW+FWl4Q1boiGpkK9N2fplWEaWh4KIoaBXTe3L+YYEoeov2UGTzRF1iBb/LxIEj6FFjfApwMZIjXSUl9JW82yHmKNthedSacBeoLrEHgjopUD+8GowJFIOaaTSDlTfdNI38f6wIRDCi1MhzUIHym70ghJIWoP8M5RqB0z1XuC96Bvp82d0tZvBexu1n6d90sbTwKDAX3F5joxOkJdfiqMwY3lSxNaNSJb+QEVwxwYYYZBqj4+IhJMYygV1gMbGHG5eY2CZAJbUHT8LdtPnXeMLcvzF1k9kva1vtGV1SXjjlKAbvLJPtTgZ9fBCaNYMArvOlVZ/VoFPqF2UaqmisXo4aF/TFMNugWOlO4se5tKntzeYE508rYXJA914koj99DIf6/U/kIf+BBLfT04DKC5Y+VKK0LdTRd/Od/SgNpBQ== +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Body

arrayrequired
+ +A non-empty array of decisions to be made. + +
  • Array [
    • recommendation objectnullable
  • ]
+ +An identity campaign certification object + +
Schema
    campaign object
    reviewer object
    reassignment objectnullable
    from object
    reviewer object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/move.api.mdx b/docs/api/v3/move.api.mdx new file mode 100644 index 000000000..4d2ee2b82 --- /dev/null +++ b/docs/api/v3/move.api.mdx @@ -0,0 +1,103 @@ +--- +id: move +sidebar_label: Reassign Certifications +hide_title: true +hide_table_of_contents: true +api: eJztXG1v2zgS/iuE7sO2Rez4LXHsLwfXcXteJE3Ocba4S4OWlmibW1nyiVISb5D/fs+QlCzZTpx0i30pjAJFTJHDmeG8PEOJvHeUcJNIxgunfXXvXCoRdcMgFndxJ4mnaHOkF7RdEcVyLF0eyzBo36K7cK4frveccC4i3dj3nLYzC2+Es+fEfKJoZDc/inX5bM7lJFAOxnlCuZGc0wOMG06lYp3zPosEV4r6sHgqmJoLF+OFxwrzKzaOwhkLA8GkJ4IYvLM4ZDwIMSgqsw5+fRUBu5XxlJ0N3n/uHJ/2P7AwYt3eYGh/cUgXktgMU0fif4mMMA/IuNz3MbthqAxp5jziMxGLSGkNSWJ4zqGbPSfAA/ySHv5W7lTMuNO+d+LFnFpVHMlg4jzsOSl5px1HiVgXXhTlAwtGU6x/DMLiDj99oijG9aNxq1FvNEWrcXBYGx2MRkeNWoMfHNZbTe/IoRWhyYSK34begphZndulxQ1iesTnc99Ouf+rIl7u16UIR78KNyY1RLTWsRSKnhYY7nu6rSjWiVQxC8crovWPFSk5XWcyFjMPjyK+wE9Y1kxt1OJMBn3zsIof/M7+qB1Ucjq6cjiUdNBqHDaazVajWa1Vq0sl8ZFbxRxbutS2d6nD+knVRophuF1hsJE1oTZZQmbR/WNS1O1UulPtDJG4keKWrHUkMJiZqYVXfqGJpBp/DjPUg9aQ5gc/kOgG/Jkpg2RG6u4f9z4M+8P/kFMv2chaHx6snox5PT1lN5zNID3JLe7mPpfw4elCz160oluuMhMSXkEBy2Y2hsercCaYnZ9YgWp1t44HcxpolQ5SW3ywzKo5YoxZtVqltm7Zw6nIZmcxV1/BIY/ZlNPSIO6oZDSTcWz09J387bnmg1Wy61XUGLFZtJSa26oeVY4Om9WWEG6lWak2q7wp6vWDA14/rPBvt5QNM7PTMBLshvsITWzGF1AU4x5MiWGNacw4iZNI5A1r0OtcXPTff0CTjtifcw3ds9Pzk96w95kCev9dv9sZ9s/owbv+h/7Fv9aal/07p+cdS7Q77P/SKbalf37uYrJhL99y3CMCRStf4YsUxqOJiIcvVhtFPWNFmX+bzAoNQYejhclI2thup6HSC40GFYfRUolm9j4sXwq/4KVrCkllLsiTtWaS9F9sdlqSpyV4vh0e1RsuMaNiHicbssImVkzflJ1sPquIf1/2LnuUVbFw54Oz94PexQV+XVx2u+av3mBwNiiqxY4BHyKKwijPx2NZ6xEv9kOgi2eahumrgxgJMhNK8QkEAjLbY5y97Z6zRpP5PJgkup1PVjJBULokgYLE9/mImggAQAhD+CySE7kxJqeqOu6961yeDNEy6EEFF/iLaK2Bt04A+/PI3cEq1D4NbzXHVgCK1Ur4UAcCIntjqb6BQNzCPNtRWtC3UGRCnhjzxI8xws6+YUSetMGEJlFqAMRcA2PZK1kW5T3YJNpmPEY6HXFlrJK6v+m4rpjHpROryTdsKrgnotcAkp4nSUjubw9dGm2GScyAQqUrimuxVGVxNZb56CS/KOR+4Hy7nXTcOAFzWkxr8NpEM2uxLNr1Ac9Gc0XuhjmlaZUugpi7kAJIeAE1RhE0zEaQTcaK2YSmow9SV5D2kwF0JBF18mm2R9ycGmaO49B5/BHBxXX5mG9RpPG8NNHeCJNpReCGCdihGDha5Bw+B84IUQwjLv3j4dkGmDrIdWMx9bOz+LACQiIwsFUQm2K07ej1kTgwJzAXJursNhDRSyJsOpCFNDJj5OUYMBC3L54cY37HvLy+tiovTpP50cW5O5fDs1Nkt26Wjk+BQAu2ONhgEDqop0TW1mW7JvOK3C7/JvEf5fxpxrW7oI8LirF4Zpb20BVlMsxaAhUTjrbVRQYt4P2WIqkXuQcBE4NpYIkGFTN3pVYpVVqlWmNYPWpXK+1Gs3zYqv+3oPXCHsAQk6yonIDtdiyaOdoaFMwjLicH5Zb4ZTvCWAKMJT5IU/3VdU7JT4lMQjcqlfUI0/UlxRYd71iJDQTSBZUnclxIVyMU7BRUszj63WoHT8Qwmm7oPcPb3slAlCYwMuLQ5BIXA23pR6huRkjekCzknKI/QhPlKnuLEDqw8nWtMGQbEXe/gtZz0OVlIDGepUMQejJItGFa0RR8dFhp1RrjwwbntaNGtXkwao15vV5pHbRaeh/B5JxNMK449XsBv5auyZnyNyjEFJKaAT35DvntkN8O+T0P+VGy4ol6ht+d085PSYuWPbhJd3H09qHdiKLVSJfJRiQ81CiQBqfbVakuUsc35fHOd3e+u/PdZ/ru6sOB3SS1TzX0qa5Dn8vAvmah5LkGfSJtPUGYvov5zVRXZiH36H2NhUg/fxzaVzroL+7m9D7jO+Ijk8rXmO9k62HaRwQ/ssUqrAUxqPVoJBgjEgmvrflecqwVZVRVX5/tXRiNJAw02AARETUjtggTxqGyKAkCs/+/x7xQqOAnWxFzeIRSJgLSrIFXmofSFEo7JLlDkrtstMtGP0Y22iHJne/ufPfv6btPIsmMK+0tFiepZDbj0cJYmn1O0nKGDix9Xc8yl9NLtYpWiBjLMJZTRA7OqFYdVcdNVzQ83vAO661xzT2s8YNmtVkdNWpNJ5/rr5Z+nDlZ0ady623W0byYFNENcFwSwLhUHIZecfsP6o3EmMKa/pgpxc3QOVR6vcSOjXXs+CGMIRsIAztGj2wvXg5OiL6IDHnSW5hEriCYbVRnXnsQpCQbhqbNG5kddNxBx1362aWfHyP97KDjznd3vvv39N0XQcfGNujYeAF0bDCCWGOCWH8mdPSAOwiajbEokMFNoN6AYOMcouAvu/to3d68Ac+AXgFF1lobPmsNQ3bKg0UKllRhJzJYqovCG/rOqG+U9kUHziYIkQFD1JJAt2RV9J0BMCl9d+DLmdR+TAKBbrQodcYxpDI+k9pbNosMXD8Bhzoo+CHtvYawMQlzEmOCf6Cg90EnCNTfcY/Trtbv2g9mA5L4hCRmvTtXCPL5bP/3YNNXAn36jInCxYVZ60c+FzB75jxAGSHu5iZ8ZRB0B9V3UH2X7nfp/sdI9zuovvPdne/+PX33BVDdoqHHoTo6PBuqo2+5wjIs9Y6M6w9H7NpVLAfavFnoaqzuLTG4xhUwJWJoHuqNVn2mtO3sp6c/1f699B72c0clTRlguEoiH52ncTxX7f39eywWFumhzOeynH6dHYS3ZTec7d/UN4Qe+tLUuBmCl5e4unSgI7hmkrJWcSTJik3I0xMYhWuhyF6heP2JwZP06ZAsreQCZQgzZPboi25rUboZbM5RTvykdO+ytqA1GSHbZeQ/bJPnl/pTchgij8ixSX1PzoX+DFyuiEfsX+9lB6svCHeb2deOVy9zCe3419YmO6NuNfZW8AhFgfkI5tXPH4ev2YTQpvb2RBHQFZLKA/jLOUxER7NO+kEIDdIJJgqTiTlN2il8ckPew8Y+BGafggsh2FXfKuEDwvwAcVmrlAYJHQpo1PWrdGU8cSN8yoDlpSbJ8KQX7END+7ww7rXOdroskIH5xByt5U9BiR1LCkLmiDf6WBF1lceu5qlcPCfXtzLxj5RayVAraWrq9QoXRrVXrvmE24ULEwnuK62tb57c0Cvl6FENhRaiusoDacLyUfxQyk1X7Zv5KNArEb0iH5+Cj/qEQHEYM5GLKWRC32N95k7DUIl/MkamQ25wNUngRd/Mlj6WUNIeUapVciyVzJQlWQIw1PydwDECY0x8RIlZ45LQbJFol/yiVxY+/0UfffhSkFk3XyF/Uk8vdNU380wTlmjCkokByvJv0hMZFnybZDDH57UBdJfrryOBZTQX8wytjVFdk9/XYyg1uGBVU1HztvnRXgY4+xfTD6h31gchmHB19ukYXX5gaVGOKigr3RFY1eA6v36I1LiiN8Nv9l6T0uVfTV6SuLPcODkL/MX3jtKPRJK/Ttz9kyLeLtL8iJHGIl3agBwsryXpLU9/rV8j8sdd4LF6f4c+ifaME382FCyvuFhecPHk7RN7DrmdVr8tjfLOblDr+nYm7bdPBf7HUx2xdGmBws1cb0NYLk9m7vOYfFvHNncqhd4ImQseEwLeI/8KZzoeAfZTEES5qwlN9Bk3sAxUzkfSp9Od7KMwR2wjqjLpA2RQ/TW05eYFrO2cjJUdpwbM6AaPJKDrS8BEMmN0WneLlXtSuYkJxig6A5FKpi/zYdmoNDKR+5AqyrreimbqbEw75ijGc8a8ZS7YsrLb5VAkrYi9yGcpyED45q4h9CuWIdtow4NKU+HPacGRSQAqRW6G0/5wjSKIBfYdTRhN9u0gtU99QYRKPmMM9TKqW2qiihFFeY5uekaUFc5bqlV7ul++I/hrX7pknYwKpX19EwyJnZjCzRTKV05WKKN/W9/BlNXKcO4pVdXodX9PG0FUOD5QM6IQ7TLQsc60LtT1NJaP/kYMGCNIrl7SlNfbq4Fl/LV+lfXU1U0bpUj3MoPFchvDwZ9fBe1+QI4HulvIbE9p1swD+z6kpI+6LgeuveihwtmMMFteT/a9zm1DnJ/R5p8zshdHzcyOSsRvSbH4v+18wj+H7vwytoVOuv3eSfcn0cfQTbHjJuhk/8ASoNv/AXBcVtU= +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Body

required
    = 1`, `<= 250`"} schema={{"description":"List of certification IDs to reassign","type":"array","items":{"type":"string"},"minItems":1,"maxItems":250,"example":["af3859464779471211bb8424a563abc1","af3859464779471211bb8424a563abc2","af3859464779471211bb8424a563abc3"]}}>
    reassignTo object
+ +The reassign task that has been submitted. + +
Schema
    errors object[]
    + +A list of errors that have been encountered by the task. + +
  • Array [
  • ]
    • reassignmentTrailDTOs object[]
    + +Reassignment trails that lead to self certification identity + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/non-employee-lifecycle-management.tag.mdx b/docs/api/v3/non-employee-lifecycle-management.tag.mdx new file mode 100644 index 000000000..ef17bfca1 --- /dev/null +++ b/docs/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/docs/api/v3/o-auth-clients.tag.mdx b/docs/api/v3/o-auth-clients.tag.mdx new file mode 100644 index 000000000..6e2c138da --- /dev/null +++ b/docs/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/docs/api/v3/password-configuration.tag.mdx b/docs/api/v3/password-configuration.tag.mdx new file mode 100644 index 000000000..ff8c62bb3 --- /dev/null +++ b/docs/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/docs/api/v3/password-dictionary.tag.mdx b/docs/api/v3/password-dictionary.tag.mdx new file mode 100644 index 000000000..3217e5cf9 --- /dev/null +++ b/docs/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/docs/api/v3/password-management.tag.mdx b/docs/api/v3/password-management.tag.mdx new file mode 100644 index 000000000..c28a7194c --- /dev/null +++ b/docs/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/docs/api/v3/password-sync-groups.tag.mdx b/docs/api/v3/password-sync-groups.tag.mdx new file mode 100644 index 000000000..801def7f9 --- /dev/null +++ b/docs/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/docs/api/v3/patch-access-profile.api.mdx b/docs/api/v3/patch-access-profile.api.mdx new file mode 100644 index 000000000..9a8806d63 --- /dev/null +++ b/docs/api/v3/patch-access-profile.api.mdx @@ -0,0 +1,170 @@ +--- +id: patch-access-profile +sidebar_label: Patch a specified Access Profile +hide_title: true +hide_table_of_contents: true +api: eJztPWlz20ayf2UK74NjPYLiJVJUVXYfIymOUraoleS4dmVXPAQG5MQgwMUhmevSf3/dPQcOgpJ8bHaTYrnKIoGZnr67p+fgJydeiYRnMo7OfOfIWfHMW0w8T6TpRRIHMhROy8n4PHWObhz1nOkXqfOu5fgi9RK5wv7Q+3ohUza5OGP5yueZSBmPmPgo00xGc1bt3WbXC8GCOAzjO3wbSBH60CERjHDgs1AcvY3eRnt7EV+KvT31uTSeeSQibOubr/FdJBLzJRH/zEWaYQPziBMal+rFcRwFcl60vo0/iMZXqZgvRZSlxaCZzEJRebZK4luZAmZAz3EiM5FIbvvHeeIBDuy7ZZ5mbCY0i3x2J7MFK4ODl2EczZEpWcwiccdUZyYjlgHPUmAHMdnjYfgcwZ8FbB3n0BTAQRdgXjQX1Pa96vqexQF9V8SzlZJBi7p5ICQ/hkFYHIVrJhUwhZ4CUsbufSMabUbiRGQrpCBsgurF0DpI4iX1zXgyF5mhK1vwjMa841FWJiAGsC/j+AOoSUL9xEe+XIWCvXUuxSrk0PeKQLx1DFa6Rcr8JF75oAttZNAEYH0QkeI14Nxi08sXv05OXp2dt9jV9PXl8an5BiPpB1evf6BnjOfZIgZ5Am9ShholE81ooBxGVTrfZmcR474vUTdbjG+AWfK14kWeCtsLwZC+18wjZXcLCU/RHniaxp4slEXRnCK9a9UA1BsBcX8pI7A2kQDVf1EiWfKPcpkvWZqvVnGCMEIRzQGK4WnJopQRIpW9TqeDYki4B9DSNogBJJKUGwOGEsgHTV4lIhXJLYBGmNbeq7qWttgivhO3IgHeRGtSlVoLIJTdCYDJU2pinAhQZoE2IhDKpcyUSOqIo/T/wv6u1ZzYDzJCKSdag+q2rNSRBoT2StVLerppRcgvnmXcWxAKbTuakjOOECKw2jAi8lexBIUnmap2AA6xhrfggpI1aEYCVgaPkDS0GM4IFFgzv+UyJMFXDE5jXMXwWapJ0OxgF6hx5GCg7S0Pc2EcRM1lFhpBrCuUCCXtgScDs05Spl1wQQpKV/tRdgyIgUayKbxI7mQKbgfYJZarTLu4ZezLYK1MQo0HCpWHQA0YNWcDkKhIkjhpQyiyHMGA9MnB0ABxR/rwSkYqfi2celg6OzHkVY3MGh/0MHbtHGVJLlpOCuJccufok5OtVzhGmiWAL7TULgYe9bxx97BzyEeH3X5n3OGdLnwadHvdcXcsPI879/fvFGTgww+xv0ZwXgzsiDL8yFerUHoUfPd/S+PIJWT+Fz/i6w0UeJLwNVIK3EtLz+PZb8LLNsiesJ+vpuckazY1UR6NyxeBjEBcszW7ufzxmA3HnR5zqbVSjXffLbJslR7t72dxHKZtKbKgHSfz/UW2DPeTwMMezytcu4FEguQD/AeiQfNgxEwKwhNeNTCynjuAElosQTLoWUQCirYUKF4R5UscBsyXBl7Gt4I+kBnDJ/3Ai1fII3AcGSJSSMu0vNdYPorRhKkXmjForIL8Bvq7KDP2o4MZwiQnDCmPskZNBA8CkI5id1YmsqJL++WxAUWySuJdJKYBKft2RTwHcyv3B/LRJRSN71u2O1IBrrzcv9/pFD3M+1IXq1+mjX1gQYAyZzDULM+UxLVhrhYylCuwgxI0o8UGmPp+35BMGt+k+Aju1LdRyzKxVURkfPcW9QPSAR758FmLHL7b9umDjAM8LV4/gxmSNVjbodcmw0AqJxBKTkvuF5/VdAiDTSQw4CzjpOasgS7KWQBX7Z/QuztW+DfKcrTKK6V19ssgKm2lX/ikg9God+B1B33wSaMeH/dnM/g76CEgLYfT8+uz65enr+AvPNQCm5yw1xDM2YskzkFu7+BfyzmL4FFWprSZUFT9og3T0XImIJfFnNgQWW7zuQTvd5ySbfwbKCaCTXb5sGxNK8wCK3KlMMgpCJpwvVVoRG/hxP5zQr4kj/qwkHUbFGIgk2pOYzLwZolaf71FqBW2qwR3c/jjYmKjUzI085pKpc1znacwXQHdpmCHo+GoGwSHHnB7OJoN8Nts5B+Igtsq5S8YfQqeIl4LcBbkAL9G1iMYczQ46Pt69FnnMBj2+4fDR2R9Im4vRaiEjG64lujQg3QFflF5NMifm8SOLfy0yO9qeRTkFHo626YIvDXDaUxrtqUvlTGcek6BzHlKTrEt+WvO5Lrjjt8ZCmBydzzuHwae3+uMxj1KNLg/hSTY8k0x+DEUznGa/DgCRlNc4CKf8VS4OJ57h2UETAcqQDfHjPKQJgMme63lvxFmUTr9m8V59hg2x3EYgkiwfc13YcxCzPYJM2V7GnVmUEd8PWiUiSeI6MRUGWoqdQc6ZYC0HIU/NEclczO5rImv0+u6nb7b6V73ekf93tHBYbvbGfyjSWw025Bfi1rIwfsZUO3PwLB33escAZK97Rjq2VQJwRlk4YJHhGHAYWrULOc3C4FzrCacpZ2ktdlZ41yoaIFvIyrIUK1KRl6Y+wLDOSBBs+JKmGiXCdUkUBFu05FM8fFWa6i7g0KpAx7CtLHmAFTzhrRYTxTOTsgh/n2zTKnQwH5YhbSzTlOZE5K4GIogY4gDJm+poHT+mQH6DGfaMlrlWYvFZmKrJ6s/cN9OfmniqgoValJb4VaBI/DsKQ7tzCdjXDOa8db9Fx8MA859IQad7jCYDcCNHXq9zrA/dp7sr37Klzwi50PFBV+mEK7WLCq5MRIuqFFGJS2sv5Q5FS9lhrMdmrtfTK+u8eHF5Pr4J9I8YGSLyUwxe0lzU4Tp5UmCSUSlGEEDPUsrSHwVu3X9opLmkzJcikDA+Gp2mNr0o66RXxuBVGKjwqj6j4p8zdZYlP0aRD0ejfog6P6wC6GqH/izzmzYGXZFMEAKHjMNnac0TrmwTxXflmIoD+/4GqvTzKY5BVb60ZPVDEdq0q1SrfPKZGPFKNOTK3dy4prBSlKsLFmoniBTh7xpNYevzUIfjpyTxgR+oyK7KUDSdeNP0cOgB1MlLhQtrnqoguWMAihYdKHWYB1YyqdYi7kUR1N6wPk+sRx0WsnV0adTlZalK+FBGPPIx2FlkQhpb6j7NqXaOgpY7sn1VPnZkvKV09RKgab84on+sDra2Un7AVPpdboD0e2Lbq/XGdOXh9T1Yb2ojltW5CoGx+fflxSnPRh3ROCLg9b09ffTZH4c44crkdxKT5yIVdY6Of7+p79NTvBvGHs8rOh4aVDS7XtbW1SIftt0oQSa3UpuplP6cZsdK48drlvgxj+QKkV1MFGMoaSAs1lH/qaFZJUvNuChJ+QquGCdHa1xb09NWZ9Qda6nNw1riFT0etiXVBiIlg3dcl3vVHUt5I+ttT0Ye7x4Sa7o0s7mGqW/TdwaiSIZ036GqjQ0ogrQtKTp42s1HPsNnspgbWqfGk6dRU3moxWRWE8Tmkjy8PjLyQApw+wS8IPPzbjeYRoL43wDbNVIPLzCuav4/DjyEqOIejQz2AD7V0rZCPgmklv9elUVDBeuHwn6k4uLX6dvzk8v4Zn5q9cozddXk/PJC/r0YvrL6eX55Bxevricvr7YzBVOFDVqHRLI8CVwP+eUA86xsKTWy8iTUIFBogdAPbeSg8bIhDb7BQ0z1YudelMArt3t7Vmk9/aOaD0zrkwhivKCWma3TSszjVK4rjkGwOYS1Ex1LjNjA4ZO3eqRf8PXKFCakQjlFY/4vIBjM3jtNEsiV13rnEcYE/YCJRxxyFBV1a6lgFFmqZJIYLSO5MVSw96eUY4z3yzmVeLThpitrmOXL6g02Eq2zSoMuJYq4JP/J8ss6y1iv4FLGdHB0BuND7tjlw/HgTsY8547E97M7UKMH3W5GA694faEcFIxX1qOsA0vTXySIYjFoaB6Gyul+kwPf2k7Ps3Ltx9187+r36kjv3NBOxe0c0G/iwtC0ysckNls9gRzrxuoXe9tcgTAl7MTWh8xI7RwuxePIIeH9NkUI3BnUlM1Qs4jVeu0PLlxgtGsOzvkffcgEL47CPyBy/3e2D3Us62R6I6hR2/szYZeZ+h2fX7oDvqCu4czMXBn/W7vIOgNDoMed3AJqGkP3WYd8Q0JLyo0eQE2u4SMTeLuMEA+zkubYSpVF7WramOGUKm3tBQTxEdc6UdkqDiKsweyOj6HTDnFInqclkajjWsxPsI5Om4tMbRsLRI0CLS0ol5sFDhypugRvYUMfZh06TWs4u3k/KT+2i7HY0kas+hy++Pp+fXk7PyqWG1ywDI4uHxcpip3XSrX8Xj/Ky/OsvZxyJMPtJj3dQie/u315GUZ/As5S2ljRLVjJkKxWgC/z/Pl7CloHnR7ZsHz4ZBWgrM9nlk0z6fXv9ovpWF/muD/inoQ4UYEu7IT4WKDAqrtRZMZVGolZjDjQ5p6lDYutMps+8w1K1RvZrvrohXur9GLCXt7FnmcU6dqw0PAFI4tVjCnxQxvaKMlcKdVnoCXtldWZvnKkdM0TlI4x40GG3NzRyy5DDdMqryX5vMiyZXa/WP3oCDJW3hyt5/sZ+WgU5aoXXEptjc9zCRgTcGnr+KPXeuxmMLbKM6Yos1FhvhUjzd7KSFhhYCod1NS5oKBa5VIWgwzpTzLc48noRBtD7p0vXEwng0D//9QDjLiGSAAk3FaDrSW/6Wb2U5oz1qqlgyQUk8rucnnjFD0zjFjDjZLKtKBRxaWd5a/s/yd5e8sf2f5f0rL31n672fp2zZWowNAxlAXa89tZpYBcFa6wUywKOTa9LJVXSs12zbsLoQ2m9hjL6TRicC3tyKkua91H1jrsStRrdKaaCh4ABwEpCuMQNgbmnb/sDm+xGH7tND48OLQH5clT2JBb8eCrlPdfnmjd0npNWi77+TdlgqSo/ZvDpp2aB6HEpf1T2n7iwscy/IkKjhmqtGz2KdDbDIChye/brNmNXT6IgOHcAzcedz8f4Rw7s4TTmdQ1I4dDzrqBTxkNW2VVyDtpvFN3w+caHcr23+ONTEojoR7WN1sLiFWEXodyX+i+9ddmCzOGTSFnJHgs2Fn3BsEwwHnvcNBd3QwGwe83++MD8a012oJYuPzxoJ9degXAlQAMhNa7Zf/ErgKzVO9VECDP70KTzCeuPdGtbVkanwh/H3M8OziD8cXbDBiIY/mOT3n8xoTIvf1VVPcVYCniZzLB9Ook9MfJ69f4kblSwiJp1fwCWFtZEuTiAr7HkYa1IVFfKe2mSsCcC9mKkI6YNNmexrqHhDEo7TcUKpv6RpSmCXTC7zQQ4/e0KMMuji6WlrYQWax72RbtFvgaex2NtwC65va4x6a8CpzX2pO7rGF4L5InoM70mdFeajSj9Rsp+O+r/bP0T77HExZFS9x4y7EdenV4nPByrqDNX7kZVkoaByA+RPCtJfhYgqRWbZCqy0aRS0fPFpK41Sxuy4xjVi6jjLuARU8pHPBSYK7DSBvAa+dMu2OaCkBHE9k2lmPVdkQg9i8UsicZDG983iePsHuLkJwPy6RZl/cCm18qa3e+sIe6QVOaI+kkybqrFtZcRnDtwsdO9vd2e7Odp9iu/WXl/pcin5LqU93M/V5Henz+Rg8N1KfRM+GzCH+f6nEUQmSZmE6Rfr5zbW+JECt/NAE7NvlRyqUb56as/KoLdKb0F/IAhEkPuqtBOCJhH9EeBcYE6MUq/qbo/0YJzMJCho1pIg5HgjDPf+Y/ya5OrDH0xbzY5FGzzK24Lf2TBV5QDow4Lt0iH2XSe4yyV002kWjP0802mWSO9vd2e4f03YfzCSrNzjoPCnNl0uerJWmmVum8CwMgwZm96AoNufb1YVytoLAmM2xnGrm4Mx63Vk3GHli4POBP+yPg5437PGDUXfUnQ16I6cc628KO7ZGVrWpkryVHInFdA9TwvIIlCvN4tivlv+AvYkI0K3RTSUmbwaetx11Ppxyx954M3e8jmPcR7g2GVJaySGjgkfo06DtEtsmpi0dqZiDX4zwThcZqz16cikASoKrDvoKJ3UrHMBN1u4kwPMJylCMktlR9KHUlDwBXpdGG9i4xJpvgDkfQKAMFvdqfcPsVIvoqzJ5dokUv0SK2elHTwg0dJu5HzTVd8/w5Av6iCsl4C2FXjXbwaunIpgQKJ9l885dfr7Lz3cxfhfj/xwxfpef72x3Z7t/TNv9jPxcZ0Pb83No8OT8HNq2O8zmUj/SGc/fO00nU9EYkHqz2KPbL/wiB6czIPAQz4PgIHhb17FS5UmOl0bdONKPjlQ11tU3XB2pvfrOO7xKbylAE+2Fzk5x2VS1T7r/Sfr3uPeA8kpFUp6E0NLcAPkJJA0Svm/zlWxLfeAiiu9w28/+bb/Bb6k7DlDnYBQ/V/cI4V23apA2ySeRaALKX9IASlr63K2TgtSosvwgfHNzxDrOwUMSmBZuYNLqSI8BzRXMRZ6l+ni+uouwRiPQ9joJ7x+j55f+Q3QoIFvoaGLfg2NBewZY1shD9N8V2lE6F7ihI0Ugwoleb2OwKTbrsR8ET+iCWVz7+O7nN9fP2RxTVXIVeYpZsr4Qh7MLUBFyhROzDoCdKDolcT7XZ1wqKy1oeiwIgWD2NroSgt2YQzvnECMuwakTS7GTID+CvYr7R33cOYPhs11wEhUP1H8fOLTPK/2eU6ikOYUs7rxqv41cdiITdaNVSm00ieoGjJuVoYuX6PpSJP7HQHO1rRG09HkNC8XaG0/t3PHA/hEED1Pi1hcPruC5JXg4AYMnCLWOA3JC41FdH/OM1L4Yjwo8F+FV8XgbvVFHsSrdmPJbLIUwGvrsTJ+o+itjqDpoBjfzHKzoi9Gi818uWYTb65RQctWQrnQhqyT8XoJhREqZ1KVplNTEkO9FvjLJ9yRZsPn3dBHh+wrN9PgGgi+29GMv/WKccUAXB3SVD0g1/iq2oWKBbSMN6mYIUoDjQv7kCTSiJZ+nYDV6dQK/T30wNHiAKkFJV0fqy1Hh4PQnRi+wtW0DLhiTcrtiiNdkalgY4CrMMuWEOgc38Q1jiKs1vil8bTkLY+1/G71IcemoMN739q299BZP8t/jd/9DHm/naf6MnkanyVi9vCwuWD+1J5O33rZavSfbnAvduAj6HV4oH8REkp6rlA1IZYKb9UV15X9Kv4xBXoByfZhJFWeAy2AAuQzthfyFt5CCKhMrwem+pBbqbLwkG4dUGh2L0JewzumqowSYwUN9crzN3uBFuB6ID6d9uJcDoP4W6/nfFUiQ7jBnJ0YpGF6/k0d4gBqQyJd4y9hjmuPL1MtTczdZJAxltPma2V7G2lElkRV01YVIluk00PddlRTkkbFAP1JdvwZG0jUc9m5bTcilCO3t3tXU/jHYoJXuQoQrnHiCd4ZETZRGeHV2vQERgEX65xTwSnzdKd3HtnjwBIhXytBvw3STrpuP0wwmZyW46lJ+XjpJsnE0qXbjq63e735kZ/cjO7sf2UHd3P3Izu5HdnY/svNv+JEdPSPBUtL+CpdPMIjlqrSl0qgbp1ZHhF5H0sezSwsIdtjg0ycssWNV7R4fE6/h+buiaEZZGsRhfdu1vuR5a9z7zpwDe771TvfyD/o0EmFWiqJ1KfeDjx8E1paBALoZRBX/CT31Qq82u3S/VdHxod/vwSKj6qzWFh7o5lQKtnRVMrSe6d8LWqradcLv4CH+f+S8hX8OXnWiUh5oRM8/OWYlCNoowGai3TTP1B9AJNDs/wFXrd+L +sidebar_class_name: "patch api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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** + +**source** (must be updated with entitlements belonging to new source in the same API call) + +If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example "Replace Source" in the examples dropdown. + +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. + +## Request + +

Path Parameters

Body

arrayrequired
  • Array [
    • value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    oneOf
    + +string + +
    + +integer + +
  • Array [
    • anyOf
    + +string + +
    + +integer + +
  • ]
  • ]
+ +Responds with the Access Profile as updated. + +
Schema
    owner objectrequired
    + +Owner of the Access Profile + +
    source objectrequired
    entitlements object[]nullable
    + +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. + +
  • Array [
  • ]
    • accessRequestConfig objectnullable
    + +Access request configuration for this object + +
    approvalSchemes object[]nullable
    + +List describing the steps in approving the request + +
  • Array [
  • ]
    • revocationRequestConfig objectnullable
    + +Revocation request configuration for this object. + +
    approvalSchemes object[]nullable
    + +List describing the steps in approving the revocation request + +
  • Array [
  • ]
    • provisioningCriteria objectnullable
    + +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[]nullable
    + +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. + +
  • Array [
    • children object[]nullable
    + +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. + +
  • Array [
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/patch-auth-org-network-config.api.mdx b/docs/api/v3/patch-auth-org-network-config.api.mdx new file mode 100644 index 000000000..788d55a1b --- /dev/null +++ b/docs/api/v3/patch-auth-org-network-config.api.mdx @@ -0,0 +1,125 @@ +--- +id: patch-auth-org-network-config +sidebar_label: Update security network configuration. +hide_title: true +hide_table_of_contents: true +api: eJztXFtzEzkW/iuq3gcG1pfECWSTly0TkplQQNhcloeEqpG7ZbuHttQjdSd4U/nv+50j9cWxkwBL7cxQrqkBd/vo6NzPJ1niJjK5srJIjT5Kor0ol0U8HZbF9NhO3qni2thP+0aP00nUiQo5cdHeRfRzZkYyE2dKS12IUxWXNi3m+FAUqQbJx06UKBfbNCe2YHo2TZ0Yvj8SZZ7IQjkhtVCfU0fkQvtZRMzTlF4WMTaWqIydiNIR2fvh2f4vl1qcqN/L1IKHq+Z1MVQQZrwnxBOX70kI38W4PT/ZEwhekUL4m+jcKQuVCvW5ID1JoeVR0cdbaGExl3LFS5Ng6A0/YmqYqbCluqvkUGTQCHII4sWSr1bNzyBqu8MccWxsQloWRhRTJS5enx6/E+/JFx9/mhZF7vb6/cKYzPVSVYx7YN6fFrOsb8fxi92NwVPhCqkTaZPepT7QriQDFVNZMDf2qUpE8KfwDmWpjJ05mjRWtpCpFpmZpDF8OynTRGWpVq4jrqdpPBXSqj2YX2z2xIHEsyssCawyNVOIAoylqazUEwVaK+diVsIcIzyJK5mliUhzIZMEkjkY51Lj0ZUjmEjMpPvUI96DB3lPlMlM7G24OMNAxFNpZVwo6zqXiMqEBsxFTBGksznRlDnsHUunRIY4BWEPgRFTHOiCnCvzPEs99/5vzuguW+3v9JG+drDgTNKnYp4ruJslAIu0UDPXem9Gv6m4iJajg1zKHhXHleeFdCJRY5g5EaO5uDg53BfkTtEVXxsAUacVnhdIaryABlNKxtxSrBWpYjnxVSOtt/SStGfTVnxSfMCAeKRwAf9OpHQ5o2ngT554Zq4Uf8gzGdOn8AKZSTZCyhckiPosZ3lG81aUt0HKRyUaVkHhDWNSOM4KsEE8wYOcOxC6kHaCiCKeJDbVmRBEXgk5HsM73txFW8moLV2/PTdERPyWim2n1fGYq8hdaZvB79S1aI+H+mmRtYhvO/Vw0mKibHv81sZGM6L6vjWkjq+Kpn5Rs0AwF5hqVBbe41rOiDCfplmaR7e3LW5VFFfM/PPtigquBFsh2LF0sCHV6AUjdkQVg/zdJcXHZSQoHy8rl+O5qXwPGg5y1nK9RhpyNtS5w1/Xgy98XLci0IdV1Ef1KhRVZg7c4MloLDOHCk6W4HE+kKsxrUrTjLmIhod4+uUd/jg4pQZBlsSMLocm3tKDjQ36a9F251zvE0HdRhzf1xYeKUcra1Dt+sUM5yK8olQtuzQ2WQYOlOToW6jIPJRL4926Vgdvy+jRZm+rt9MbgHzw/Hmv+X/Q39qghNdllskR0VLHxNi2Zb9ewNiUurCo6yb5CiH3h6A8PCHfna0Uqh0iDa8Rqq2SekmsV0obwjDXU4Xg9xkA+1+hYSYMARz1StFiinYnRgjLT+GRcgOGEJUlejzHWJYZXB8is5afZWxlwgIoK+tcIJLtVdG3n6VU/g6sxaxdwKeitNRv0rFv2B7iiBEwjgBKSzU36+8YjYkCssj24bLHq/whWmF3YiV3RMUik6+DfanIzwxs61lSRJAKTNdbKCWwRG9TvJQJw0XSbz8oQ5YEUvgEXkfJ4wKd6/R3KnphiEibqrdiWrWj5OjFxu5ge/xiW8rBP7Y3d56Pdsdya2tj9/nuLs0+A/6RE+UeDf+flVY2jTlKsvQ/MIhV0gVozJM/hD4WfcA8vsD+lHKetlYzyCsIL3eA5V7uvxfbOyJDoSj5vZzcMYLunp9GK9LMMz626STVq0SpQMWrg8Ph+ZszvDk5+Nf5wSk+Ea+lnjTUiNaEwhKiIham5polDgpcS1ojZNzue+JZ4PoMCknt2oSpf3JzJOdMhETEiDD7ihFt1mJszWwhlWK/uBA/pT3V66BbOoK4BPxGktqm8XD22TCOVV503wRLPhNTJRNln/bEMElSUhJAnJuPw3gGsWhTlLqewbhEKkOYtJiashCoSmmsFn3RmHLRG005edN2CiUHJP8CNBYXJYRjNdtZWEdLEDH4hwojz7Mo3VnLaGzSuS4A4mkBklGRtxYWFoAxIkVRDeWI3OVQeHRFV1esdpXkcvfWC/OqMPxdLEv3BXn3PkP56bJq9RdXKiQfL5ZCtSdvVG4KFSks33hw3ROCLarEF+NUZck6d9e5u87dL8zdu1+eBMwdvmXos7kCeGvaiTGWm+cS9LEcPdqIisgvdr0jO4TZAkR6/eEMif1JaaJXn3Na33xHfORb+ZLww9of/v2oWuJWrb/xBQnIdgxbZ6hEKtljuRuJ2VDeVFvLsx0aO0oRoHoFRETVtGJuSoa1ttSaJJGuIxKjnH5SiKlEfZTICOd8BaRZddLNaZW+RpJrJLnuRutu9ON0ozWSXOfuOnf/mrn7IJKspeJsCTjJlbOZtHMfaeF7/pFPgEBUu7+iTrn6t4I2WiFmosZY0SJyiEaDzdHmeCdW24ncTl5s7Y4H8YuBfL6zubM52h7sRO1ef9HkcZ1kiznV8rf3I5sYIO4KOK7UCC5XGJMsbv/BvFaNqazx7yYVbobNYdKPDXbcXsaO70wB3cAY2NHes714fvKG+GNqZk92M6WNFcFsbzr/cyVBSoph//PwGjquoeO6/azbzw/TftbQcZ2769z9a+buV0HH7ceg4/ZXQMdtQRBrTBDrj4SOCXAHQbMxnAId4hLm1UVzBqc5uNc6iVMBvQUUOdhdRpFnxoi3Us8rsOQWdiJ1Yy4qb6CdEa2taEEgxQQlUtM5pRTolqIqnSnCpHTaLktnKecxKQS+dt4djukIkc+Z+vxaNUuq46yEhFwUMuOP5l3LlM6bjQn+gQPvg05QqL/jHmfw1v+0HyxOSOM3pLE4+BwrRTlf7/8+X3VK4IiOU1G5OPW+vue4gN8zlxrLCPU59+WrhqBrqL6G6ut2v273P0a7X0P1de6uc/evmbtfAdUDGrofqoPgi6E6aHsbosZSh3yi8/+N2DlVggQc3sLEjNWTBoMzrkAo1Td+oubwc3UTph+OKXfj6v6PXwd4sUqbgbi6mXBT8F2g257M0x6KGBxWzLW57sVm1r/aWlF76Kipq87OJqU/4ktXhPwkPbaxTSmMfc3jCbzFw0nZyMHyfMbgQf50+p1cOcc6RHg2HYGQDyHFryFmjvXEE8fUvXBG/o6O0O3cZreP6fPvrYf08Ezu0WOV+R6cC/QCUt5Rj8T/2Nx6OiXg7WdfuvvUNBNy+2BpsmMiG4iXSlo66synYH56/eHsqZgQ3OR09/ezVErrAyTMe4QIl7NhdSKEBnGHsaacTFnw4cKZG0ofMc6gsLjUp0qJi6NghHeo8ycozGxSGqS4FtCo5l5Moq5URi2w11iSAi9NdB8W4ohuxj3ldsfrgpQvQPkz2Je6K16l1h82d+GMNqvIyzxxkVd6yZZe3yrE3ypuXc+ty9zc0ztSeNNexP4Md4wcJhYyc2ytb57c8+u2+NEiCm+I610ZyBJBjsWTUnHltW+WY4Ffl/gtynGpP/i7ZwvDhC9dwqEVZok4EvHUGKf+KQSFDqXBBV9f+2ax+MJblzOiO9hoidT1U3bTLpAhy/cGiaF9MMkRdWYGJsbvkXBK/sqeRc7/yvdgfl3QmV9foIESZWJi980y04RdmrDra4AL8vv+RIGF3CYduA74ANhv/M+VIAjaqnme18qqzuz7PIZaA93BZC4u3/MPe02BC5/8TU2irmlQgglY12fH8CwCL2pSC8aqtgTuWnBZXrrFqO/Yzctb/7BJ/fLPpi9pPGx2To51Nv/eVfqeSvLnqbt/UMVbV5ofsdIEqEs7kCfNVe6Dxy8NLt7frC4NLl1QBMiiUGaVwnqjnUAeCS7vEdIm9lThT3zLVYDxOlZDvL5jfNRmA+EKyheuF/E0Vby7kCtZEKrsUMyaGec4oDQVFrqcRowmFjQoCA5IV47SDPx64gOWbzqG+2jpRqd6wfU3E9Zwp/Ag360Vr6qgADibzUpNF+0hRDkTEqH3SOQkqYtLX+CweNCq0swwRKxHVdlOIUmm6PEixs7c8Zi2obHCbQXII3MhPlzYg4YhW7deG0VOVFbfOl2E9o/xRlR2pyrLafGI6gygplozvD06W+IIZjr88EFLqTDI9YmWLhRDeR8MWz0sGfkatHEFVrotvv7eaPPvHNx7bXQhvG6affg//N9dCF2Llhv9nLbJSNHSL398ql1E1TDat1hccCK7pjAKEd3c0HYKrb5u6TVSmdbqFx+bxRU9gbnfVuHU/qRoOR/28btnc+7EVSo/dNufln5+sN+1eWAYl4B6Jc2mAvUo/HsRM78rYOU1XtKfe9El/sODyX0g8mXda961CztDoPGMK/izqvuHD6Ty7e1/Ad0dqsE= +sidebar_class_name: "patch api-method" +info_path: docs/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 security network configuration.' (patch-auth-org-network-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Update security network configuration.

+ + + + + +This API updates an existing network configuration for an org using PATCH + Requires security scope of: 'sp:auth-org:update' + +## Request + +

Body

arrayrequired
+ +A list of auth org network configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +Ensures that the patched Network Config conforms to certain logical guidelines, which are: + 1. Each string element in the range array must be a valid ip address or +ip subnet mask. + 2. Each string element in the geolocation array must be 2 characters, +and they can only be uppercase letters. + +
  • Array [
    • value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    oneOf
    + +string + +
    + +integer + +
  • Array [
    • anyOf
    + +string + +
    + +integer + +
  • ]
  • ]
+ +Updated Auth Org network configuration. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/patch-auth-user.api.mdx b/docs/api/v3/patch-auth-user.api.mdx new file mode 100644 index 000000000..c214f233d --- /dev/null +++ b/docs/api/v3/patch-auth-user.api.mdx @@ -0,0 +1,123 @@ +--- +id: patch-auth-user +sidebar_label: Auth User Update +hide_title: true +hide_table_of_contents: true +api: eJztXFtz27oR/isY9iGXmrJuvumlVWwlx6lju7J9MlM7k0AkKOGEBFmCtKN6/N+7uwBvkmJHadrTk1Eyk0ggsFjsDd+uAN47cSJSnslYHfvOwEl45s2GeTa70iJ1tpyMT7UzuHawiVHbhy3HF9pLZYKDYAi0Ms7Oh5eHv7BU/DMXOmNZzPLE5xk8UUx8kTqTaspyGM+kYtkM2oGgUJn0aG6m5zoTUetGIbVsJjUTyk9iqYhWFPsymOM4eBpIEfp6wG4UYy/ZJ48nfCJDmUmhP92oGzVkz/rtdqvT6rDjMBRTHpa8ZDBHkj1jvsi4DJkX+wL48ZEJoYE8z9g8zot+wse5zcK4mdb0Ae5UnDEehvGd8FsgJi28PJXZHER1jwJJD2OViS8Zig3Fp5MBLthFCQwMN86HBxBlwlMeiUykmoZKZXQwA5oKHsA36TuLEj/2UXLZnB0fwTOUuUwFaC9LcwG8eDMRcWdw72TzBCnoLAXpOw9bjvjCoyTENhH09oODfq+/Jw76O7vdyc5kst/v9vnObu9gz993kDmrzVexP0dyixM1mRqyENTM4oBUa3Rt5V6amGbc8+LUR2MA0aIdXL+9ODtl52h2H57PsizRg+3tLI5D3ZIiC1pxOt2eZVG4nQbe7kG7+4LpjCufpyR3D8WsMuSOJ0lorWn7Nx0rl0z5z/gRHy9JhacpnwMJCbrWtfZ48pvwsiWZDxkySnyys2I9jGuwpUAqMJXJnF2PXx8yZJK5bN1lNRR5DV7pbBlDQCNJUYJo4MgnPFrS7SK3l7Oa1FHUE8HgaxCnkUB7EiqPcBru+zRxFN8K+pCE3MNPtsGLE5QReEeGjFT2U/R8sFw+ydGQmQdWMOjZYCBAJgWfVhQe0Bwynk5FxpAmso3RIxSRMGEAFsGDALRjxJ3VF+nUuduuzw0s3vIwFyQ7Jc4C8rRFbqvBp+KO1cfD8mUWNhypHI6rmFKgLMf32u1qRPG8NqS0r6JP2VCSAGPOYKpJnhmN20iQzCDMJc7DQ41aYcUFMfP9YSlIo0GQFKwcwT19BubQFOIWK2yQnt2gfdw4oAUfPluVw/fKnx8VHPBZ8vUW3JC8ofQdelwOvjZ2XbNAY1bOdj2+O6Uqr52z8ZuPw6N3x6cYSFEmMFYnwJORWbfdxv8WjHAhMj0VQ1YGjlJfTbcEGtxQecI1qR9DnbYa4kMncy0VWA3E/Sdp1TaCJq2ud9DZb+/3d/a52OP9oN3Z2Z90JpNgnwft3e4+TpCvM8MzzXIlYTtg0rRI2A/T5qR3MgxbOpKgtweSTiCNNT8xxRFuGgUmYHYchFYdexKVxO4kRoOiA+pvjdXu7ewacSLbgdXuaR5NwC2fjlrFhLB+gARhPBeCKRrcZKFz4O7s7AMLXdpnI4AX61KHIcvylDwyIv2rbW95cUTinUEsW28KGrKS+53yD5K+i9PP5+uTx2HfPAc4DvgXD0frS6oYurbIApnqzMTSdeajYSv89T3MhWRD/j1UcdQKoheF+/hSQyScn65NGGkiyLYETCiPeLbMPCsn4yA0vd40NOQx/8cFnoMTg1n4hzOupuIIUe+TkxwRYgyMgBJLgHlEYcHt292O2+657f3LbnfQ2xv0eq2Dducfxewn8VSqSxlBXIUhy7tB+aiIPzRliKPY8zBGRAKcmm3zBU69tOkbyZqm3X6duc4uAOnuXmd/Z7/XBX4gPUghAK3Nkh333+Kqvrcu75aIJRqx2eq+PqzGwdcQdYWxLOo8HI0v7d695RyenF0dfXxz9uuKlquL0RgafhmdnB+NLv4GH6tdf8sZj87PaoTGZyej5peLq1fF94vh8OLju+Hp8M3o3ei0GrTYPh4Nj2jOi7Or8WFFz36tUfS5HuTS5X4kFSQ+AGritGqGkANQgitPfIy44kYxxZDcl43OAEW4qwFrI+7BVFF60KZnkxjSHDcV3F/VfgcJp2ii8ko6D3XwVebzD9TcXwWNDkOJdjZKUwB+LhuLLE8xrZFG/UViP4FcEPNfqcAA5Y/ETyYnP4SU/OkY8RoyLneackq8BLFMuTxQvJWUXUZxKoo031ow9WtGEKoTsFfch/Wa9R3axaD0Uu59BlrH3wCTrgw2KoYASCrB9YppxZ7gk932Qbcf7PY57+73O3s7k4OA93rtg52DA5wd4oAGs6n7UeFfzanfCCVS6UGE8EAj/wKBgMGA7IkBmvyxJLepA6LxDfLHbML0LZdp+WVY9dhinL06PGf9PQipappTO58uCEG5VxdY5sjDkE+wCasKGLqJ8Fkqp1I9FkWORq+HVyeXFAj+fjW6gE9Iayn1GaqixgOsgi3M4jsT7c0C7iCH15BkYlbZYi8t1ZewIK50vaM030ylCtN+nocZjLCzrxhRJ82CNI4aruSZEhF7LluitQVJGbRFVF+YcMzOYlMoezn0PJFk7omV5Es2g4Ag0hctNvQhkEjCQrQdaBg/pyzZ99F1DYEgB1cWBKLjPMPKlfQWdtJKlE1tVCHkpK4UdA7g/BsAg5flwBwts+6FpbVYFosanG8l1+TusiY0EulcZdzD0mEYzkGMsEN6EJlgbTLTzIYjVJeGwKOKfmXEqkdGCnfvDDNHWUzPPJ7rb/C78xDCj0tLKx/cCut8GtNsE41IG4WabESytS8abHuV6ioc3xQcN7678d2N736j7y4+HNuCkH1K0KezDH2uFILbOKXNcwn6pMLU+1nRydRUjSK3GAjEQqS37y/BsT8Lhf3FlwTLaD8QH5mtfBmkl/ow7ZOiklps/ZUukEGSo1lBAJFI+APiu+KYBGVE1Vue7XWcTiQYqFoBEamuRj+fgMjSXCnkhOst5sdCq2cZm3GIjxw8QmsTAc2vPC79zLNBkhskudmNNrvRz7MbbZDkxnc3vvvH9N1HkWTJFXmLxUk6jyKezo2l2ed0GIJBB1b8NMlKlyt/kq6jFSTGSozlNJGDM+l2Jp1gzxN9n/f93d5B0PV2u3xnr7PXmfS7e059r7+u/Lh0sqZP1fRt9EgiBhB3i7+PKjAuncWx3yz/gXhTEWBYo5/nC9wMMgeRfqiwY38ZO57GGawNCAN2TL9SXrwanyB9mJrIo9ziPPUEwmwjOnMCByElncGhs0Ub6LiBjpvtZ7P9/DTbzwY6bnx347t/TN9dCzr2n4KO/TWgY58hxAoQYv2e0NEH3IHQLAClwBqKEwzlUU9bfbRubw98FkCvgSK7BytOSMQxe8fVvABLulGJVJW4MLxB3wj7pkVf6MDZFEKkwmNEEtAtWpWMBGJSPHgSykiSH+OCgG46d4cBnlQ1PlPYWzmLVF6YA4cUFMzpjBhsTII5iQDhH1CgOugUAvUPrHFabf1H9WA2xhWf4IrZ6IsnBPp8Wf/dWXVK4BhP7WK4uDC6/spxAVMz5wrSCPElMeGrhKAbqL6B6pvtfrPd/xzb/Qaqb3x347t/TN9dA6pbNPR1qA4dvhmqQ99Wm5VY6jUa1/8csZOrWA7IvFnsEVb3KwxOuAJMqbwZ6lT3csr7jHr7XvoPDl6CRExo2MnTEDoVF9/uzbWWhxZPZMteIJmr+A5P5m/f9lbEHDxiavwLopafe5QzDM+PbZLRItmmEs134faNdVY0VJA4nS14lD6dlwcVziH/YIbMFh6xtqZEzXiaF/IIe7q+Za9gLawR1naVhg9PrefX3mPrMES+so5V4nt0LujPgMuF5SH7H6o7qxcIuM3sSzdXq00E1d1dmuwMu3XZK8FTyAbM6Zfnb99fvmBThJnk5rlGhCsk5gV4Ubi4vjEsToLgINpZ0jifmos+w8ZZG3QbFoSwYHajLoRg18W1pFOI72MIyCTSYeNKcXXt0he3IsStr1VJEg1P+mobJLTdvIr8grY5ygekMkfpobV1o1x2JDH60D1W7GOXSOkduy6vpfDaur6XiT8V1FxDzSVq+sUCF0a01545u+2B7yIJHmqS1ndPbui5NXqYPEELUl3kASVh+WiekPIKrX03Hw16LtJr8nGj3s8k7KELd8lNyGIatsDQZ8fMm8WxFn9hDE0H3eB6moMXfTdbdzipSx7hdts1llwzpSsxLhJ/J+AYyhgTn+COTIAkNrURcslPpFnw+U90zfJTY83UfA0bJ/b0Y09/N884oYsT2huG2vJv9iU0LPBtXAPFAWMAh5X+KRJYRmsxz9BaGdWJ/DaNwa0BLzcQFZ0MzJdBFeDsJ1a7AmH7QAhGQF2eGYPvzNLCzakhrKIUsCjBZX7pMs2C3Ay/5Q+auE/+v60XVzysKiZnKpz/6Cj9lUjy/xN3f6eIt4k0P2OksRAXK4/j6lUXo6fvpDdfD2BB/vL9dwBZaMq0JJtn1B3IIMHl2iC9AQXfdAJPKQoQTocsqLoIXScDzGXoLxQvvJkUVFVIBM8QVW6hzcYR+ThAaQwskDsSoWkKfSAgaEC65j7fvMXeQ9qmPFAfpmx4mheo/hbb3O0CNEivbmBHhVEAOIuiXOEldGAijxgH03vCcnypvdwEOMjglChWFhNELEcV3o4miaKgq4YijfRZgOVnyGxrBvLEXGAf2taeQZCoEftShWohYxGWLzVoQvunaINVujMRJnTxFNiCFLA2w7vjyyWKQEzZHzzwTSB2kN7Gvvi+Cli8MYZeC1JFujAd6wwy3Brd8pU87Mq8UGbBkO6rSvvmHT1OeUsVk5vtBItx9BIEk2wZx752qqQWBgykj9crZyB5fHZ/j7UaTPEesBmEiIWA6w9VBkchA4wCP0PKHEA4W3xNTl0pz8f2ZRsvWPONPis5LYqLal4LOfDxs8ByBLAKSTswS/UiYsQ8sD9QuJdzghrFwMfeloO5rRlsylGPDKMYV5YISA3Qe2JfGBSZckfK76AR/x04N/AXvsSJ8TToRO33TlE8hD6GcIHvVsEb+wGED93+Dci47co= +sidebar_class_name: "patch api-method" +info_path: docs/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 'Auth User Update' (patch-auth-user)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Auth User Update

+ + + + + +Use a PATCH request to update an existing user in the authentication system. +Use this endpoint to modify these fields: + * `capabilities` + +A '400.1.1 Illegal update attempt' detail code indicates that you attempted to PATCH a field that is not allowed. + +## Request + +

Path Parameters

Body

arrayrequired
+ +A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +
  • Array [
    • value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    oneOf
    + +string + +
    + +integer + +
  • Array [
    • anyOf
    + +string + +
    + +integer + +
  • ]
  • ]
+ +Auth user updated. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/patch-campaign-template.api.mdx b/docs/api/v3/patch-campaign-template.api.mdx new file mode 100644 index 000000000..21c6c45ea --- /dev/null +++ b/docs/api/v3/patch-campaign-template.api.mdx @@ -0,0 +1,174 @@ +--- +id: patch-campaign-template +sidebar_label: Update a Campaign Template +hide_title: true +hide_table_of_contents: true +api: eJztXVl328aS/is9nAdbuSIF7qTuw4SR6IQZWdSlpPgkko/dBBoiYhDgxSKZ46P/PlXV3dgpUlYyWYbnLhaBXqqra/mqesGXmr8SAY8c35tYtePaikfm4oQvV9y5867EcuXySNQOaxG/C2vHN7UTEUSO7ZhUg+mCYe39Yc0SoRk4K3wBDY1c138IWbyyoKh3xxzPcu4dK+Yusx3hWiGD+pyZqgUWqb5YHGLxaCHYzY+X03N2gRS9f72IolV4fHQU+b4bNhwR2Q0/uDtaREv3KLDN3tBoHbAw4p7FA6sBFIfCjAMnWgPVX2rXoQhOfC8Sn6NRHC1wJI7lHeve67r3Y6JX1N4/woBWPOBLEYkgpDYcT/JnAY178AJ+ORZ2ZC7EkteOv9Si9QqfhlEAQ6g9HtYC8e/YCQQwNgpiUWTRFYxxcsp8m0Zb5sRcICeWvgUMFzQm8RkKudhHyxw2B8ag3bWawyYf9Ixm12oNOt3uvMNb7dawhgPA7kUYfedbayTvaWpGzHXCCKlJKJHMYImEhIybph9YNEH+S+fo1rv1kAW2j6KCbSrB4IFgJId87orjW+8bhuzGfzMUy5/cch1PnMaSPnyWEP+au4moRQseUbMcuxIWs2KcImYGAgZ4cOsBb00UDy9CRvHVylUifvRr6Ht1ouYf+Ce+Lk04DwK+hiYcmLow89yf/yrMqFbmNDKNeMammreMhzAeG0Zjsfma3czenDBkGKuz57K4lhW8G1Dw2qGUW5TpAGczcgTRCa9KYlslpYkE4LTPYXZEYPvBUqD4Cy9eYjfcsqjjpX8v6A8QYhP/Ug9Mf4U8ikAgkZBUlHXJR0XlVopGTL5QjPEdmLiAQTOBCGEGtfmIeHAnIpSkBZLNPSZcsYQCahDctmF2JLuj7CBzinaU7RtIvOduLIh3npjaZBiK1KaVz8VDVmZx+E7k5mxEUh1HcSeCbP22YaQ19PtMlUS+dJnkQdIECHMEXc3jSM64MlyrheM6q9rjY6Y1LcW6Mfn7sWTZUSCIC4qPcQg8BHHIM/GQaRmkd7coH7c1mAUL/lZTDr9T2/Ik44DOhK4fQQ1JGxLdoddJ5Rsp1xkJlGKVn8pkJmvXZOWsbH//QVze0Iq2MEe244LgHZET0I3ZNljl5qDZ7dpiYBoDQ/5lDVvdudFu9oCfyHRoNlzBoOWktAwD/8mzeQIOE2yQCImvF6Orkx8yehjGpimEJaxDYmkgojjwZFHtP16FzAM2JnpBFRtPW7pK87bBjGnnzzIwIW9egDNblXlibXSARYdn9IfzVt/grV6Pg8PDv/r9+XzYMwxjgLophXu7QXPCHJOgVoP9APbXQ3nmZFqAxXfCQ26DZGjKwldUOMy74rfc46CYrMyPx0LXz6Us83ZnAjN1CnRqshJd5Z6HcGyp6NeNNJBu6Rl3mL8TLIgSKaGCXcEGlHZuTT13rZEHOg8OAljDSvXIWRbm2mgZdaNdN7pXrdZxp3NsGI12r/MLEqbh0HbK3lJJ83emrts6NoaNYW9I1KHuWLGbI28Orlpwr6KjTQrvoEKAKJQh4QKEYC4E6L/uKDfHNndDatfmsRup30CW/wCSMhP2dqUmb4+lpVZm5FEamij7PhG7jCjagb/MV2T3DgekryluMBJzQmYM/uBx5AO7Yeiuu2YrfxW71BAgNlPLFs4Be3DQkaOhiIMA3Tg4nqDxQqNDY6lC1r1ev2e1hQGGptfv95pNa26JVsuwcZpl6xWeX2Ghyen4/Gpy9XM5LLqCGpv7TurtbMzOodTm9t4CooepUhYKWwXL7rjbmx1jsc3tLoOGshrfqocN018SnKgVQfluCJNmGGbR8RNw/rBwzEXeM4QLPwapAdAB3UGvEfo/qa4kMiGivMnltI4BEdMUNNi7BahMXii1xIaZIPQw1xsZYDkWkD0IJqDbrPiRSVm5cShbtpLe3oB9VWw5RF1WXaEg+ybVttB8SzvShP8qzUq04gEGclu7aL0DgPQ6evDZgxCfwgNJHjhz0G2KXqoI1QzSrTe70EQl1c0O/FiHB3kvAb2S/VdtV1kMDcS0LYVHoLt5MFwqfOk6S5apkY1QSNTzUqF0rBSxVGv3FsNaghg7IYuhbc4BWfSzylgW3EQ2JYyYKKspx4/2bcUDiqp5xpKGK2E6mAmRoouTSUhMhP9koZBi9vGolJ0Ij7441uORFt2PTHjWCsMfZvlmvNQYjxy8JSJQYYIAm+OTInT5CsSS4UAOrvwZGZEOfHwvgjVEcICQBeYHKJAJxL0jHpKA0Ak0NKplzFoVTyoBw2ZGgb4q80XIRDXcYNIxkoIu4zBCkhyPWGDHAO/plx9YMF8YzpqRc49Fs3INbQDf137MomCdK5XJtJEf5anJQN3wwRJA27q/FQ+jQ2qHDF8gTOHcYyMdw2AiCHwMt2UA06jERs3uVdMA2HZsNBudbu+Xp5xmhTNQTjId1ok2a+IzhC4Q9uQ508j43rej89H34xk8uZxez07GH6bvzuXP8Wh28gP8MZuejT+cTN9eTC8nV5PpeT4doetrZ3nupwnPsYcpqWpwV3CgVDJk1ATg9kzSVMLvDLyrFRFbEdEBKYiSZuLe/yRGMoW1Aw0qBYtVUbah7tf1DdPvL0GpLBmoP58Jk9Gk3HODjSCEXUWgfWCzmbgHF+1IM43lwexbMRgOGyAgyT6YEtsmu4Kv0ZVDxIue1KZK3q5olCTaUVib0RgRkqL6gyGSiQ0qQ42SWVA9OUnXQCy4eMmHNPUR3JWlciNzcdAYMIClisPnGVq0H8qby+qNCheo1eFifH46Of8e5f8K5PoU/jgZnZ+Mz+TD0cnV5KfRVebHGEuAcpyN1VP1g6qOZ7Mp6hJqEhQ9zauOqo/wwQf6CMdfPmeAhVpFt91gOEKW1evMrJucpuvaS5sBGfNyD5iZW79IbKKP7Tqe6cZAVb6GY2FOEfEHew2tqZ9rFIM4V85mTkQBmudTnjz2IrnI4aEKLvzAQa8EZjT048AUB1mjdTKdzcZnI8nk6/PMzxyDM8+fjtF3CmkrAnkYByHxJ/GSjn/bGP82u8fNdgPiI2nj/Yi7uTWi7NSnKc6EHnjUblU7AWyKAX/mKtjMtSo1LWtOqnRA09w0DBJKFTP8NgRmSNMNv5BItPMutJAlSWdlNy3WkDcOKYJ44IEH06+WOxYcPTbEG0sZUFf1vXHBIg+6XbB3lUGjFl9tFt6NZufwz+T8zbQc+p4KcIMqnUktailbijAEmJUHaNQiMMT1Te46/1Oaqq1rLoUhYDM7wg9ZNrHrijyGi4eHgIG+O7lgnT5zuXcX03N+lwdBwqtfX+IiYey66CISYy8bngbOnVOJrTU7T8dvRtdnVwhVxv+6Hl/CX9hWeY3V047MJzlc+A+Su3IAGEaGwqVFjgb7RrX6DQyIq1SxKujIX+E6BGYy5bKghuq9oka2ae1kBVPrjcyUK63stdMQjUMwyvBsSctdcx7K4BeLfyMBQP1McfIbtgD5FMEBmG3LcnCQ2iOHUH9NizZWCfwRoPXjiFCWWQCkKSvzs5EGpmfZSUETBpTvsAZlRpg7pWEqMZa4WEuLIlEDDUtxrpCSzTCNWLqGyMXUuTByLgCB5jA2JwqZytvjdIWAKz1dzvGARw4oeHaVZIzUvJXEnEa+zM0UI/cRWht8VbWolFegp/KuX+Ft3qrmnutuWsZxs9Xo9WUyuApm7GHFC2GFXNbanio+xa0RS4ggQ5WqI1OcpMrUsK2yEyS0raxMyivZLY0/lOOOcnliV9igCmB1P31dzjfdbfEA7pEQvI4z067llgskIK+ohj0Xg17bNOB/HXMw4O2ubfXtZl/An5bdfUZ8m0kAK05n5mv09mI0+f78w5vJ2RUFrbPrs3FhsgplvipVnPacWR4CI/RGPidjEcYQ3kcnFPpF4SzJ120N+zKC4RA4ogYYrVpikzLFYS7A7Au520MnA3MRUwEe6YCJpHyKKWltxSae7W8X17cqpYIESL0sLjvizIAMZO1AWdRk/xNrO0YjKKFQmqylE0151RA5eFjEM+lmonSBe7s4ykXmUPAg3c31W7OJ0illBj0/zSPJTHtIVqyVFhYXVTBQPRlfXhaDT3r23AzmKf2aC5XFL9DSYBNPJZwQDoYAtPT2EvDawZpMhVwZW/lh6MxduZckjQ0ydl4DpiN+zx3CInkjcyn7TpYoCztPVHpyB8s8sWViFR3soRxX4l9gFHc+GD+Pe6Zgd4Efr3KrG7oXGi9uodoW0pA11/uqTq+mNK1SrfWMEX++n/40np1j6uHD97Pp9cVLJEcT+SpMesxKSrErDEkyK3LV6227+pBM35PTyk153d7A7LaGJi4dDkyT9+yhYTbbzfZz9ijkOqK1hVxX72DKHL5k8G9IG2CgaZLI3doOTWB8EuHk5zKTKMbpR2HJSnGSDlPbpqQe4AxnCuUiUAChChtU1kX4RXbgI/38iCL6UcsrGNqPSTYcbNLTGiNpKehNpqkd4mrLIcytDXd2TL423BVKoIeQoxsHosZUGMJmK7/knyfyZdPA7V/Ps/qHNcnvE1DVKOCOt0Mu4U0cwFxgRt+KTRWfS/kobsyBWROfkQO0oTcDYCkC3DR9B1IaLB8DNCkUxDxJaRU3NoQg21bdSZfPxm/h38RHfLiYTQEojVXaf/OC/IioyecgMu2RHFXEF1XuUu7S8gPpJc/GJwCsM+twmzIXlZ4eFye51eJ9g5uib3VpcdK0Wy2TDw2jadCc6w6fYs7o7IzWQCQ5ZT5cI+gGEbc0eAOYLEguNstDuhwvZUc5SZ0XcHCTNzmRgtZqIh4f8+vARHtmOO/TiHVUEOuyqlQ2htwJAKUCigX/TCmF58Gh6UqlISD4tp27WK/jyw1WNF5sn1KAqoM0diy7uL0P3/vwJ304CtMujiqRS+2osOJWHwX2yVeOSnX0keY18VIyyQbG7J9oyDzhkAVAOYBnhyRLsiMepGHMzmHLTsYsEEthOaj/O25YwzXzbCoCFztlE7R1jIef0qQEB4x+55Gla7BZqRiOSq2qkO4IDuhCLZ1aoIwh6b6n0EwxeiMtIifgijvusnQkSdD0Skvrq3Q7nbnwQ5HJAGmowNkMLcvIWtK6P5sGd/LH7lq3fT/aGVE6Sym9kjb4ZfqVnmpJeVBSs6dF4Vlq5mVSG/keN6621FLmbvJDMNr3u8PqRCNVCCmxKCik9J2FDZ0+7ogUqeb+vtpZQsz/ojG9MFbe6PheHjXLYWwLmGkKM66dnRaODGQnNW9X3ieppPAdsHEarBbcG3sENyhd9YwlOJ3cKdgDCXsxaQ+Ahd3e3tZ86oWJTDf4mL3OPkmWM7hMXOM2GwLccrOWxUb6QMcB5aHFcgVGg2hxckcGEjpU8rii9wY7jzO7IageiI4StNj75PkPXlXF0lhf537hWoa2o3MBMqDkX2/mwPcOTuKSsjwHL1ibfN52XzlVz7ZE2+yrTBlWBxd59ZMFvypnW0H7JT2SO7oqZkmu7ABOxq07frBWuVyVyl2qMyDbdD7jWmVAkGR0s6lbtddO+sgwOWCXWxeRaAik7mc/pnUVVTltUQPWpKFD5X7r5Fczj6Gg56cPGuy7tV5TOMxTiFFnNZVZvAnx0YfT8cnkcjI9v6SV15+m/z3+MD0/+zn3/Hya+ZkDork3wPiKg1OOQiIL37Wy+U611OPJhTNklet8km7tMJvOYCIyGyXLVrl9Vm8OyZyYyOzqfV9eC8yeWlGDIgXTm8fhz+TsGypdDZRlLszh0OoM252hORh2m3Nr0LG7A250my2jlhyT1dtMZzT/GeJoda9VNwZ1o3XVHB43e8edVqPXbv2SpfsYl27L5ldKE+2BULs5X+mkQmkHp1xYKG5Mr100O7gylj0eoTbI18J4tfKD6Fs8r4iPGhqfhb7v0W73JKDPJKaJMX1htrotbs6tTqvT7XYGc/htgUVpdwbmvN9NGXMJDdP5RXYpuyucIVGbxrKbsRPWSaYUmVRavCsvKcnJA5vHuegNB92WGNhiMMccUmcgumAEu30zpZHWhfQM6vWhzatD0nhvXKWRVFYtTMg3TwbrsojeIiN/Ve44kq827vdRRDzt/mUhJ+HsJlnOi6V8XJbIrAAmpMsZSjes6s2A8vXm3aeSxxVbQpW8bNqwqcWptGqeXyh+0l+UzNyhwpRlAzHvi16nOxTC6rY6fW4O5sMB79rCGjRt0erbqYzNBAo/OgyZ59lsKfr11oAsxfC4YzSMdvellkKdYw8SCuQumL3BeJnBUHHG72gvEoLVwl8Z9CX5acJH6QzzuePSi1q6qDZJGJKm6ORvFf7VvpUC8xpHecxe0yFmaFAEt7WDg1phmUFZqnIu/mZrRvLPYOSK6yrPNHa7KFXBCCab8/+qNlAicZLgCks4tDvNudkbij7vtIbN+dASRq9ttIc9y2gbVqo8o1OmmtoCltpg/47bvcag23+eCYTWGfQiBWOjmXu7t3K7WLnMrL/c1uU2l9zoTHSnb/QtMecUmALYBko6otvtDWUO46+LpCpE/cVYqnDk5y9qTGb5qXuJPUlMOE6OyiVj87+NXXmi9bJVkQ38DY2KUoI/ICD6snG15Dfm03aYlCxc3dTmza7VM4a22TUHnXZnPugB6O92W+1m17b4wMbsg0JVFUKFjx7/aNv0pGA/UwMKJqp0+nB3M6VE9E9ip2RysVN1d82J6+BGddqDzupg39MTdNlzAnPfog3PyQb2F9xNk88Ky0O/J761Q471DcxR/Q4BOlAoN/GbUBFPIN47lryCLRDqHHFus39+NQI40Wiy77jFZmp8J2owmEEOuPkJ2prskK6+9px/4+1Kqgpz0jOGFd2KvuBzULdWx+51OG8NOs1+FxwEb7eNYXc4pJ0S8hzA9kWN7/HkpGMydepG4M1CPFSHVqnz3bfr7I/c7I/c/D8/coNwIg530LsLF8xPnYaWvLgXSvkonpbWiGZDT5OySCrYpsqqVDJdWvHlMYq97u51d6+7zz8uRy9n6sIL9ZagT7MMfa49dSoLnWcJ+siLDPAklyokV/vkRNKipoJIP767AsX+hPuCQiY+r/TpmN8IH0lXXiJ+lMyHfD7X2za060/nAgkkPqpLLcASCeuY6E4prqUosV3u7Y0fzB0QUK8CIuLdXnQBCa0xx55HidvwkFm+CL1X+c3lZAGxV8+q0zUweyS5R5J7b7T3Rn8fb7RHknvd3evuX1N3n0SS+c1WCieF8XLJadUZN3jK9/LqPCiQXL3GEpVLVgeyaAUbYwnGquWRQ23eas6bdt8UHYt3rF57aLfMXot3+81+c95p9WtZX3+T6nGiZHmdysy3nEd5zFAEeHow9kC4wsj3rXz6L8aNeTaaNdoQrXEz8Lwh78lW2LFTxo7nfgRjg4YBOwYb0ovXszNsH7qW+62Bb3K9CZVWXkuoTqaJkHYJis9OGO2h4x467t3P3v38bdzPHjrudXevu39N3X0WdOxsg46dZ0DHDkOIZSPE+iOhowW4A6GZDZOCJ6LUvaf5j5okaq8++aOBXg5FtoZlFHnl+7i1fa3BUpjLRHopu9C8Qdkllg10WQc/YHbn4MW16uZ6lCq8zwwwKV5x5DpLh/QYBwTtBuv6yMabpqTOaHlLekluCkOj4PryK1sP3ImSQ1TBmvKgd9x52ZdcCne7qQsYX5IPZjMc8RmOmI0/y2/TsCT/263+wk2EZ9hddinnesN2AZkz5x6EEeLzSpqvBILuofoequ/d/d7d/z3c/R6q73V3r7t/Td19BlRXaGgzVIcCO0N1KNswWIKl3tDlmf/XiJ1URVEg73XVXzpKMTjhChCl5DPDtfI3FQtfeKnhzmjEhpKsOMDd4voTqF9gtmCWHht85SQ7xj3/ATeMH923K2wPbjWVeqa+LoGxw+hiooKNBvE4cOijFSSj1IHkuLqUtBYC52mPwZPt6wtJ1njaRjZziJfAKJGix7hxGeKJ5GogeQtzYYwwtuvAfdw2np/aT41DNrJhHFXse7IvKM+AysLw1Il3/dXlSwTesvfSt5dTZ4Ip//Ll+lMs1mLfCR7Qt25wF8zrH99dHWQ+7CG/Eq1vQGEXICJkzkZ6RwhWIg8T+PGd/IzYKLfnBtWH2S4MmN16l0KwG3VicH0Odn4GhplYipUE2QKslX6A18Ib7NEFNlJOouA5lncEHDriuXoH5O4oLsic8m/cenV2ShcOOvo2Mf2xMAzz2M1Kj4tnxvW1RPynbq0uW6tTa+FBgQrJ2htT7uE2QYexCe6GxK2v7ly2V8+0h0EUPMFWizQgJxQd+Z1Spp61r6Yj114d28vTceu9o9us89WYNF36yrsJ3trkh+K/GEPRQTW4uYtBi76aLLpCu04aUW8ZGZLqssu6UwdkSPSdgWJ4Upj4HD0zARNf5khIJT/SzILOqwuEcmOmxzd4pxSUtHwz/GqascM6dliXNiBU9KtPbsnvauMYyA5IAThJ558sgSI0Y/NkW5VWnZo/ojroGvBiJXkp8+pY/jhODZy+YJxeYOmkDJhgBNbJ3jG8cES1hU4qxyydEihysEyv64NvLPBN0pssbKK//LONF0c8SjMneAPPb22lN1iSP4/d/YMs3t7S/B0tjYK6mIFUeb3vfGs9/tqvk5e+hA4gy9EXIKh4I6tAEgmWc4QhXQ0K/w9v1T2RgNchGkq/q5ttBkE46ov8iODCEZRdWAkeIao81F/tBR0HKI2GRV+zcEdnJgNgBnflRQvrBnsH4ZtnwvRh6EafJ/TZr76K4dIDh6daKPBSt2Xs4W2IQES8xI8Bb5McywnNWBo4iOQ8oUfmE0RMamltp2PwwAq6mFcEy3BqYxoaItyMgGzpC+QjVDloYCTOiDo+mA5khuftHPl5+zy039Y2SGV9IdwVfQQJyIJQMNPD28lVqUVozFMLH35wd6QqhUdYFhrBMEoKQ7sBISM+Wvl44NbLtHu9suTnIqs+lF24LDDJvesvDcZYmTLQEJbfOxaG8JRIkh8sqfietZwLlIKbHy+n5+wC48LUSkS+74YNR0Q2jWgRLd2jwDZ7Q6N1gN++8yweWJmrlTHGOFphbgxHF8uYR+rXTa0cY0LFY7zk8bC2AEZgmS9fMIWCEddj5pTqzfs0oCINhjnKn6zcyJnX+iDwAS0CpRdjlnkhvz2iDxlvHJXOC3rrjJWAPz8JzCTAcB7xXgCZ6iFi5Qu1tlBXV9LpisVFkzpF5v+g9RMMR2VlmUl6ohqZpSS6vxhd0V0eeL6T1pdkpiLgeMYf//+4dgv/qeFVz+qw7hf5/EtN5/2gzK/Jrbh8AyJRf+CtKo+P/wuk9kMz +sidebar_class_name: "patch api-method" +info_path: docs/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 Campaign Template' (patch-campaign-template)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Body

arrayrequired
+ +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) + + +
  • Array [
    • value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    oneOf
    + +string + +
    + +integer + +
  • Array [
    • anyOf
    + +string + +
    + +integer + +
  • ]
  • ]
+ +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
    alerts object[]
    + +A list of errors and warnings that have accumulated. + +
  • Array [
    • localizations object[]
  • Array [
  • ]
  • ]
    • 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. + +
  • Array [
  • ]
    • 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 objectrequired
    + +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. + +
    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). + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/patch-non-employee-record.api.mdx b/docs/api/v3/patch-non-employee-record.api.mdx new file mode 100644 index 000000000..111bc0b6b --- /dev/null +++ b/docs/api/v3/patch-non-employee-record.api.mdx @@ -0,0 +1,127 @@ +--- +id: patch-non-employee-record +sidebar_label: Patch Non-Employee Record +hide_title: true +hide_table_of_contents: true +api: eJztXGtz27gV/SsY9cMmqfWWH9KXVnGc1hlvnPrRzNTOTCASkpAlQS4fdrQe//eeewFSpKXITpp2uxklkwwfwMXFfZ4LAbxrRLFKZKYjc+w3Ro1YZt78bWSOwjiIFkqdKS9K/MZOI1Venuhs0Rhd3TUuU5UcRiZTn7Nxns3x7MP9h51GJmcprhvo3ywIiBM9Vd7CC5T4WRo5U6EyWQONfZV6iY5pZIx7MdepSNSvuUozcauDQDAnQgoDYqogljA7LXExV4kSEv+y20h4lpVcBiJPVSqmUSIyIqiMH0faZKNrI0SXu1GLRMxlihagF4Ev111EU/FR+2ZkVJqM8tiXmfq4I7QRt3MNVjyZKuq0uDb2pZBgU95IHcgJyEy1Cvy0RUP1KkOBjejW4ALkacg0yhNPMV3msSSLKyMiEyyEI4+H1wZTEHTXgg5imchQZSpJWQvaWIXN8crgBe40qaou2ber8hPaF88uL49fPUdr9VniLXVW0/7BdDjoD/bVcLC715vsTiYHg95A7u71h/v+ARqThnSiYClZkitYhTdXoWyM7hrZIiYaaZZoM2vckzk4db6M/AW1qLM1FoFOWeY1Bbupl0aZCukRyyAqsogFePXm/PSteEfm8eHZPMvidNRuZ1EUpC2tsmkrSmbteRYG7WTq7Q07vecizaTxJdnNOAN/kzyDkZDxJIr49TLli8nCqovm0RKnhcastlg1jrVSIeI0mUmjf2M+hfRDbdJqw7XWsUaGbH7wCYhIxnGgPSbY/pRCLuwEf6ZLer0ibZkkcgGSOlNhWnkeTT4pL1sxhbEg0bHkxGkhYQFX8NVUGyuEq7PXh4LEJpriawVdm9wVIgvbLOwTxhAnpNNMK+YTr1ZsZjUkVOyAlD9RArdw7lCRmSuThzSM9H0eOIxuFF/EgfToyj3wophkBJ1z3Fnae9Hy3nH5KEdjYV84wVBkgZWADOwIGmQbBdOZTGYqowA2J7ZhESrgsOcmIaeIiM7msuoka97Yro4NFm9kkCuWnVGnUw4AD7lddn6rbkW1P6avs6DqoDtld5rFTCXV/v1OZ9mjeF/pUtpX0aZ8UJKAMZe+RncuQMVzHegY8aFCrbDigpi9v1+TI5RgKTg5wl99F+srQtwRhQ3yu2uyj+sGtODj2qkc98sIs1Fw4LPk6w3ckL2h9B1+XXa+snZdsUBrVo02YsYrhIRGqcVGr9MdNjsHzV7/onswGnRG/d3W/n7vX5g2yQY00hi8Wdn1Op11AZSDA6a5LkM2NsaVtcGk1GHdVZFS1jgGeaEE7QalkbU552gl57S+LttAChT7c5O9Zdt5zDvPbLpRNBR5Y7YQrr8g46uPPp5MFq3zUEM/GGeqk/SJo1Sn9hOgBvVcQ/89IIyWIREP5DfSpo5rSJdcQ306+Gqq3KtO8dYy20qJ8l/d85YXMfvxHAHnq0fhXvVRdss/RDZkMJg8LQ0Uejx+RTlZUhTQFTUjHCB13yjBqA6YquoRYMaNVWfnkwSDfsTh32b547WWvnGaDh48tO2eN+wedA529w683d7Q2+t0ceXJvemw43X73T6NCYyw1vsQrjQNJoN3NT98ALBWclMRbcUkiCbtiZxx+Kvj51Y9Qj+gkNPADN4gESSxjGPWJucnnNPMdKg2RwA7PGdAplsC2orEavFwtzfaHba6exQPKdH7/wVOqsC6ykev8yU+wsjXgHGb4+GXGXk/V8YWHUWZI52PF4SfLhIvURjnu3LiSG7ioZqmKnlxtVy85xw2WJe2DgNN0j9KElhnU5ypLE8IeuppjaMJigYqnbRhX/+O+cxXGQLgYeQ/Iai9BipuzhLJ4Fgxyx46ClC80VyThBHKCEuyKPC4XV2MkESrK15KX7gkJQ7dZEiMifR+Aa2nhJ9Lo38l/OO6UCFXAKA1w6p9JSd7nWFvMN0bSNk7GHT3dyfDqez3O8Pd4ZCNWqUpgmM1xBR4rD703xRKIu2JIPKgkd8gEBgMZM8M8OCbCpG6DpjGE+RPsd+2Lafp+BVUse8gvL08fCcG+/AjM8v5uZw9EIJpXp5ThZwHXInZsovyMhM+TfRMm3WsFPXFq6PX48uTCzw5O/rH5dE5rojWCjwdG1irT2YZcek4j26ZYzcB8rEUhQAh/5Z44ai+wISkSasNtb1LF8AyIZVmMg8y9HCjr+lRJS2mSRTWXKlY3nimW6q1A+BMEYdrwIkkBB3ZWPBi7HkqzponTpIvxFxJXyXPUTWXKcnib8qoC65kfJ9c1xKY5nBlMAMMEeUALlGmvQfRdSnKujaWseSkqhRyDnD+hMLM48WfYhWndIfSWhyLTj/g2Uquzt3Fg4iYLkwmPcwClfwCYkyAZBGZMDedpcKFI1JXisBjinZlxKqGSA53P1tmXmURv/Nknj7B794FCD9Nnlr54kY550sJ+9hoxNoo1OQiklsx4c6uVamuwvHtysTWd7e+u/XdJ/ruw5dnrlh3bxn6dFehz6WROeSbcPJcgT4JW4+JRNHIrntZRe4ICMRBpDfvL+DYvwDC0Qr355iWOr4jPrKpfM1yQ6EP+3xSrHYVqX+pC2KQ5WhnMEUkUv6I+V5yzIKyouqvjvY6SiYaBmrWQERepl1EuV3BzY0hTmS6I1DMpeanTMzlDZeM4NdGQPtLQJN/CtgiyS2S3GajbTb6cbLRFklufXfru39M392IJEuu2FscTkrzMJTJwlqae28XxdFAFD8bidLlyp8Nq2iFiIkSYzXqyKEx6XUn3em+pwa+HPh7/eG05+315O5+d787GfT2G9Vcf7X049LJ6j5V0bfVI4uYF+wTkRsYV5pFkV9f/oN4EzXl3RzZEhJDdwBw/BOZw46DVez4NsowNxAGdky+sLx4eXZC9DE0kye52ZV8cloWHZrLjCEl2TAkrdNsCx230HGbfrbp54dJP1vouPXdre/+MX33q6Dj4DHoOPgK6DgQBLGmBLF+T+joa5+h2RRKwRy8HOI12XI7nlt9dG7vNuUVQK+GInvDVRR5EUW0YXlRgKW0thJpluKi8Ia2IbVNirZoIMUMIdLQlkUNdEtWpUNFmJQ2hwY61OzHNCHQTRbN8ZR2E1qfKeytHEUbL8jBIQeFILK7YW+lhjmpKcE/UOB10BkC9Xdc43Ta+o/Wg8UZzfiEZiyOPntKkc+X67+763YJHNPOSgoX51bXX9guYNfMacutUZ9jG75KCLqF6luovk3323T/Y6T7LVTf+u7Wd/+YvvsVUN2hoS9DdTR4MlRH21ZHlFjqNRnX/xyxs6s4Dti8ReQxVveXGJxxBUypPIHYWJ6dqO5fbtqzBGn7Tvv3DTqUSOjQMpYnAZoXx5TuoC/o6b4lY90qNoqb6JZ2tbdv+muiD202tZ6G+OXnHlcP43fHrtxosZQTTYZsox4PYGXO8yKThex5l8FG+rSln5S5QCUiLJkdOnfmjIofg80YFcVPqTsAYA/MPJgj5naZBPePzeef/U3zsES+MI914ts4FtoLcPlgesT+h+UZ0nOC3nb0lZOky3RCi/69lcFOqVlPvFQyodN6vA/m2Zv3F8/FjAAnO3yeEtZVmioEuMw7mAgHtHGxJ4Q6cY5Jonw2Z8bHtV035EBiGmDC4tqcKyWujp0Q3iLSnyE0s0ipk+JoQL2Wh+R8daMCSoKtpSTJ8LRv2pBQW9b6PeeEx5WBNnb7Np62rk1TvNIUh/gcJLVxU+RCT1zFxbxkZV7fysSfCmpNS63J1NLnD7iwor3y7C5uD15MJGSQsrS+eXBLr1mhR2UUnhDVhzyQJBwf9b1SXqG1b+ajRq9J9Op8XJv3fBa43k3Y4CVSJMPAF8fCm0dRqv4iBJkOucHVLIcXfTNbfAC5yR7R7HUqLDXtkE3dBDZk/k7gGMYak5xQbmZoEtlVEnbJj6xZ+PxHPhT3sTZnfnyFFEot/chLv5lnGrBJAzZtDEgd/zZDkWHBt2kOHAesARwu9c+RwDFaiXmW1tqozuTb3IdSgwdWmUoaj+zNaBng3JXgF9S6bIMQTNC63D1Gp3gdLUpTNWEViwIPJbjKbxAhOz6Qm+W3/GmTMub/23xpxuPl2smpCRbfO0p/IZL8/8Td3ynibSPNjxhpHNilNciz5dcRjh4/QVw/zF2cIl45rQyQRabMU3IVR9WBLBJcXSW0X6DA/3jLUYARO+ohrvAYH1XJgLmM/IXjhTfXitcXYiUzQpU7ZLNRyD4OKE2BBVUkE5rxGbMEwpCoCHUAei3xnr6p4EF9VLzRvl5Q/RS5Ku4cGuSD9uJVYRQAZ2GYGzr4CSbyUEiY3iOW4+vUy22AQy1nVDGziCFi2avwdjJJEkWLy5gkTE+ntBCNGrdiII+MBftI3So0BEkacUfglxM5U0F5BL0O7R+jDatszlUQ8/lisIVisDLCz8cXKxRBzLifPui7Da5T2qa29HUBTN4aQ7+FopEP/kZphlq3Qtd+OaJ2oLL8PkzNou6Wi+/bL7s85csuLpsSs+2YFvBIAbkty2wIuGqsK4TRdaR9+qzFHNqiVnd3tNJDZeE9PYbYaRnh6sOy6uMwA0OiaxTcU4RAtUF/z87c5xSei8c+JbN2FsVipVlUAhcuf1G0vAHm7z+glV1/YtbsC/eDR/NiEVe/m7DpCylUIdvOdnlrQzeOlOWSw7vxxeHf0XrivlQT2uWTRN7iIf0/alzjL26i2PorGvHzu0axGIk2lnCBEteBJHdBn0u6v/83y+yH3Q== +sidebar_class_name: "patch api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Body

arrayrequired
+ +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. + +
  • Array [
    • value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    oneOf
    + +string + +
    + +integer + +
  • Array [
    • anyOf
    + +string + +
    + +integer + +
  • ]
  • ]
+ +A patched non-employee record. + +
Schema
    data object
    + +Attribute blob/bag for a non-employee. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/patch-non-employee-schema-attribute.api.mdx b/docs/api/v3/patch-non-employee-schema-attribute.api.mdx new file mode 100644 index 000000000..de15758e6 --- /dev/null +++ b/docs/api/v3/patch-non-employee-schema-attribute.api.mdx @@ -0,0 +1,121 @@ +--- +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: eJztXGlzG7kR/SuoyQfZjoaXqItfUrQsZ+mSj+iIk0iqMjiDIbE7nGHmkMyo9N/zuoG5SFqSvU5218Xdql1yBmj03a8hgHdOPFeJzHQcjXxn4Mxl5k3fxdHxbB7GC6XOvKmayWGWJXqcZ8rZdjI5SZ3BpYNBbjFKnOhAeQsvVOKtjOREzVSUOdfbjq9SL9FzIg/i51OdChX57jzWUSZ4LZUKKdK58nSgPZHyckIW64kgTvA+wlqqWOsszhNPjfzWVXSq/p3rBCSSGEt7cZSpz5mIA/FJ+9EgUmkyyOe+zNSnqwisz2UiZypTCQlw5+jICDzFqwgv8K1cGMrYdgw3zuDOyRZzep3ibTRx7redxKwMlWVJrlYFBZtGlFJ1YuSLZxcXo1fPQVl9lhCHSKpg5yA47O/099Vhf3evN94djw/6vb7c3ds53PcPsNhaTlOrhV/NJtMR2v9Krq4NcZVmL2N/QYs3aQ9FqFO2xYpNjUlE6XjwAM+LEx88iywWGbi6fHP2/p34QA5y/WyaZfN00G5ncRymLa2yoBUnk/Y0m4XtJPD2Dju95yLNZOTLxG8JkiqIwzC+JYLzhNbJNPlZooSk58pnv7J8bA22xFYoxyrc2hZbUxXOz+FF9HkeSk9N49BXCX0tlLnVgq7Y2eDkEFzO56H2WJT2zylclR37z/SRXq+YRyaJXICEztQsrT2Pxz8rL3OWrTQUpAzWhXhf6EzIVPgq0BFkGS/E5enrI0GKEK74WtU5dTe5RD7gSIGvwcSV9ohPvFpxsnU+VVqWzDlWAl+h75liH4vyGS0jfZ8XnsU3ij+wsvHJPvDiOekog4MRI5VrFiPvLZePcjQU5oVVDKUelQiQQeKABdnrwHQmk4nipDQltmUkVMh5zAohA6S4zKg7qwvZCJx2fW2weCPDXLHuIvU+4LSzzG01+Z26FfX5EF9nYSOiy+kkxUQl9fk7nU41o3hfm1L6VzGmfFCSuKsyIFvcJpv5VId67tzf16gVXlwQM9/v1yR9JVgLVo95asOvocRtUfggv7si/7hyYAUfn63J8b3KGQ8qDnyWfL1BGHI0lLHDr8vJl8avax5o3Mppc05wajaMsEyVxszrQZSH4f399f1KtuUH6Ry8Gl32Op3VNLm2UtwiuNPc81SaBqC+sJXSfyTvrE02pY2boYx8vyZwKEolaDtUpxoall632+l0dt397u6e2+3udtyD7n7X3R33DntqR3U6B/2VyFtTAikm0kWKzFdbf4zspGS0mkugRaEDeApww0oZwbMZ5fwsThaCMmIYNoACpnBtS1t1SaxlZrEPwKEe1gKVBzfTM7XC2cepitiBV7gi24USla9YobE6nKB76HYO3N7OefdgsNsb7B62unu9f5FevERhwf8NS5b2Q8z0O4Od3db+vmHGcLAmW9n8fX78j3N8fTU8P8b/Rq+O352Pzv+5ivmOMX5NsgVVwgYQRxL+W2YZgEDNs6bliiWLwP4ySj0nniGDjdDHCsQJDRO+TpEAFkhAsdHjxcimqTXO12RsCPiSo1C8o2xJulPeNEJkhvzgSSWznCIo5ZJqiIVqPfE2h09R+ow0UBeVVOveraU4ZVZakWWlgDOPc0EjBePnShModRejJSNMSx60TxaFjydlPrfLc3GuwNPji/9E/QAvnk1lJgIdhikZYBx/bi5/zMVbFiygmCRGY6WpCg004e+juWYEjRNEXh9CoNuoT6u5RtvgY5usJJz7JsZiXpb9pPDX66e4ONViEO2vqylHoSbYcpwk4NQVpyrLE8KJ2jiVhe3Qrb8gwXSEAqe/Z3HxVSZ1eBT7T3D+14Cw7iSRjGQVs+xhIuH2G80twSwGbjcki7jgcU3HgCZaXfFS+uLUyndkhaGATKT3C2iN1ibXJkMXxrOKKfDy0rvXLKv2lRzvdQ57/WCvL2XvoN/d3x0fBnJnp3O4e3hIq89Qx9ETp2tagObSf1WRStAFhzF8Qv8HCkHWhu6ZAV78oa6haQOm8cTkY8aWYlp+OR63EWsvjz6I/j6qWjTJ+bmcLCkhci/OqDUFWJHjWpU1hN8neqKjh4rJq+PXw4sTSu6nx3+7OD7DJ6K1UkyGEbzVJ7cEq/CFaXzLHFsBGDcBtRNMb4kXluoLCCTRZNYGavPNABHqo2QeZphhV18zo05aBEk8a4RSsfPwTLdUaxtpmuo/N2xjmVYV5cWQy5p7YjX5QkyVRH583hJD39ckJAoAw03CNgtuO3yfQtcQCHKEMpjR2TTOM2SgTC8XgEqVTWtUSeWkbhSuVk8pD0Mvy8FcscFShkPpLZZFax/wbDS3Wj0KpbFKF1EmvYxyIGCuFycJNCyQ4ITOUmHTEZkrReKJinFlxqrjfE53bw0zr7KY33kyT58Qdx9CpB/X1L7ixY2ywZdS32KyEVujMJPNSHbDgifbUaW5isBHPVOhv4ndTexuYveJsbv88tR20vYtQ5/uKvS5iGQO/SZcPFegT8LeE8WiGGQ2qYwhtwUUYiHSm4/nCOxf0FDRhvXnOeG274iPTClfs2Va2MM8HxfdUlH6K1sQg6xHI0GATKT8AfNdccyKMqraWV3tdZyMNRw0WgMRGVYv4py3TJM8iogTmW4LP1ZptJWJqbwxTVqamgxY39jfIMkNktxUo001+nGq0QZJbmJ3E7t/zNh9EEmWXHG0WJyU5rOZTBbG0+x7klYKDBDF33REGXLl34fqaIWIiRJjOU3k4Ix73XE32PdU35d9f2/nMOh5ez25u9/d7477vX2nXusvqzgug6wZUzV7GzuyigHiboDj8gjOlWZx7De3/6DeRAWU1vjvnQVuhs6h0usKO/ZXseO7OINsIAzsmHxhe/Hi9IToY2kmT3ozRw0oaFl1Zq+XICX5MDSt02wDHTfQcVN+NuXnhyk/G+i4id1N7P4xY/eroGP/MejY/wro2BcEsQKCWL8ldPSBOwiaBTAKZPByqDfKquMcdvfRhr09QVcAvQaK7B2uOfsUx3RceFGApbSxExlV6qL0hrEzGpsUYzFAiglSZESHITTQLXmVninCpHSuM9QzzXFMAoFusnCHAZ0eMDFT+Fu5io68MAeHnBTC2BxGvZWajl0EBP9AgfdBJ0jU33GP01rrV+0Hi1OS+IQkFsefPaUo5sv93911pwRGdJKC0sWZsfUXjguYPXMZoY1Qn+cmfZUQdAPVN1B9U+435f7HKPcbqL6J3U3s/jFj9yugukVDX4bqGPBkqI6xrY4osdRrcq7/O2LnULEcsHuL2GOs7lcYnHEFXKm85OdUFx3qJ1lde2i+fVfcMLtvGxznVldD2ne1i3L3oGT6BcN+noQgWtw8uoNVYc37lpzrljkxnC2i+LblxbP2zc6aHEVHUk08Isv5ucc9xvDDyDYlLbZFosndTW7kBYxlWHpybFiIzyI8SL84ar2ApMKQ2aaj6db1+DHYnKPv2Ep5dMvegVmSEbJdJOH9Y/L8fechOQyRL8ixTn0ProXxAlwuiUfsX5O54B4gxPa6AD9HJqkNc3KIy+v6GD54bDhcGVkVJvrzQW+Fofc0rCdeKpmgwzAnap69+Xj+XEwIunLqyFNCzUpTr4Hg+wA34tQ4LE6X0CSuVkmcT6Ys3LBxfodCUQQhlCKuojOlxOXIKuodasYpkjyrnSYpzis0q7ob56sbFVI5bVXaJufUftSGFtuyMe85l07uMXRkrmXgaesqcsUrTRmNLzTSGCsit4zicl7IJWtyfSsTfyqouYaay9TS50tcGNVeeuY8uId8QCRkmLK2vnlxQ8+t0aOGDE+I6jIPfNHS8NE8deUVVvtmPhr0XKLX5OMq+jjVqMvNacKkQZGirIa+GAlvGsep+osQ5DoUKpeTHJH2zWzd0qIuR4Tb69RYcs2SrnaBMpm/EwRGZJxJjqnKM8iJzX4Lh+0ntizywie+C/epITM/vkQxppF+7KXfzDMt6NKCrskTqeXf1DpyLMQ2ycB5wDjAUWV/zgSW0VpeNLTWZn4m3+Y5VD48sMpU0vnAfBlUSdB+EvyCRpdjkKYdvvNiz6HRtQxLiwpeQ1nF9sKyBlf5DWPU2SW9GX7LP5JS7f29yUsSD6tdmPdRuPjeWfoLmeT3k3d/o4y3yTQ/YqaxsJl2M0+rnzo4fvzicPMOt20cVi8pA2SRK7NItnepB5BBi6v7jbQhPlX4L95yFmDsj86Ke0XGR3UyYC6jeOF84U214p2KuZIZIc9t8tl4xjEOuE2JBf0oE5rwldEEypDoLXUIei3xEa1g5MF81AbSCWFQ/Tm2/eAZLMj368WrwikAzmazPMJcit98JiRc7xHP8XXq5SbBoSuMVCFZzBCxnFVEO7kkqaLFDVEyS98HtKWNbrnmII+sBf9I7X42FEkWsTffK0FOVVjePG/C/8dowytdul3JV1LBFtrK2gpvR+crFEEssn9EoZ9rsJPSNo2lHxWA8MYZdlpoP/m2ZZxm6JprdM0PRsjV2+WURxs/3nJW3FlsONpdtbv/m/9wi61fNKg9p803Ejk3zZIJuktnXROLqYOVH0qp9bH0vv6TL4jIKRRJ5O7uaDuHurp7eozwp72Cy+uqaeMMABvTZ3TVAbLT8i+s1HX4zMrsP+c/SD348zBr5S22JKNFLang4y+KNjHqYlCH+u2M1X4Q5hv4KNV9f83XjyXf/4WmzGv7Rxb33NyALaY/9BMqJI2ZbLbUHpjGObXc5vgwPD/6CaPH9gdqZmbLJpG3eEj/HThX+Bdf4rmJbAzi53dOsQGKMYYw/fNfixF8Fw== +sidebar_class_name: "patch api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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` + + +## Request + +

Path Parameters

Body

arrayrequired
+ +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'. + +
  • Array [
    • value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    oneOf
    + +string + +
    + +integer + +
  • Array [
    • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/patch-non-employee-source.api.mdx b/docs/api/v3/patch-non-employee-source.api.mdx new file mode 100644 index 000000000..1a0edc3f0 --- /dev/null +++ b/docs/api/v3/patch-non-employee-source.api.mdx @@ -0,0 +1,115 @@ +--- +id: patch-non-employee-source +sidebar_label: Patch a Non-Employee Source +hide_title: true +hide_table_of_contents: true +api: eJztW/tv28gR/lcW7A+XuKbebxQtFMe5OvDZrh8XtIrRrMilxDuK1PERRzX8v/eb2SVFSvKjadDeHZQAhkTuzs7zm5nV7r0VLVUsUz8KT1xrZC1l6szPovB4sQyilVJXURY7yjq0UjlLrNHEwjs7fylOfU85KydQ4gcZyplaqDC1bg8tVyVO7C+Jak5TSBFiqsqnJky4Jl4tZZz6MhDZ0pWpei3+NI3rfxYXNEdOQdnzVeCOxMFBKBfqUJRIHwq5XMbRZxUn+Og4URammo84OTgQl+qXzI9VIuIIZJwoTNWXVESe+OS74ShUSTzSa36qQT6wAfoppkLKe8s3jM/xihbGN80xtLQpn9aR4DexXhSqTONMHVqJM1cLaY3urXS1ZCpp7Icz6+HQUl8klEHPVLPd6/b6rhr0VcdttIaq15i2nbbT7brTbs+1Hm41ZZWkbyJ3ReSqLIxF4Ccs3A4lG9WKwtIJayt2wYhII5HOlZi8vzo/01q/fTVP02UyqtfTKAqSmq9SrxbFs/o8XQT12HN6w0brtUhSGboydms7pGZlwxXAJ0wU+A4vW/8pAXPsDX+kj/R6Sz8yjuUKJP1ULZLS82j6k3LSLd2PBTHOfIvzXD4hE/iJ54fKFdOVmFy+OxLEtLDFfypmRbgJgoVdBW4Bi8D3sGLqK+YTr7asvMnt9bxkBVL9VAl89aJ4och7VJgtaBnpal9awLn5wzKQHIXmgRMtSUcp/IEYWXtSPvLBcPksR2OhXxjFRD4MFwuQQeDAguwhYDqV8UylgmgS2zIUKuBoN0JID0CQanWnZSGtMnf18tpg8bMMMsW6C9W5x3G3ye168pm6Kwc/ie+nQSWkiukkBVCgPL/daKxn5O9LUwr/yscUDwoScOYUS02zVFvc4MJy7gf+0np4KFHLvTgnpr8/bEEjOQRrwegxS6BDuENViYci90F+95H846MFK7j4bEyO7+v4flJx4LPg6z3CkKOhiB1+XUyeaL8ueaB2K6vOwpdMGGIVrZAwCwLWxSMzC9BeT59YLWfYHDSGXr/Rnk7bfdlo9hudhmx5wMTOwOljbGcwbXqdXtsZqkGn1Qcyym6j35y6g+aw2ZkOrNuHWzIClkyWUII2UqvR2AWXjELQ5y641JavWU/iWBW8ZBBUHbjwnipI+O6ukKT4l1jFurk5ebsVopWMa1j0GXbXNpaNdqPdG7TsrupIu9Px+vbUdVp2z1G9ZrPV7QydJkVckcOeBYYiqQFMk8jxJUX3nU/xP/eTnbm8wpE26KDbGzjd1tDpNZr45MieN2w4zXazTdxof3khJzT4K3m5VKn0A1qxQvmFC5cefuX624QqQbhVbp0i+e3EpqozrQNpy8FPTTVQjrWXJtjqIvrtDmA2qer78x+PL8/GZ0fH//z+8vzmAq9O3h6fXZ9c/72amoqnm2o+cSnRoMxLhO8x8Pn8JF0JKJfKRkRHsH4IBJRiRlKFMoRaZ3GULa2d6jwxc96m0TXxD6XvjsBdHNH6bsWOXfhwo9l12y1vADeWze6gafy83XVb6jGr5vQuladiBZ4/wHcQhDR8o259wpR6oFjkI/cW/XVadBG5JPvTSE8FuZ36nEOrrH6Yq5B1Zgp+cYdqNpD4kBPeANpGc2g3Bnarfd0cjLqtUXdYa/Za/yDVOLEirPqWnBiST/HQaYza3Vq/Tzw8UM3zKNDRe7DZ2ZWjjwKf6svjOIZ72Ojm0iymgt54VM7TFP0QeZUfopbQafHFWfvpOHE5axxF7gty1Dv0GvYsltxyKGbZwURB6Otzn7WIYsoARJKimUTgcVVFQhO1pngjXe5eSb4jIwz5YSydn0HrJen7JvR/oarSTIHfF2XljmVVX8lprzFsdbxeR8rWoNPsd6dDT7bbjWF3OKTVFypJADxlgMmBp7r09ypUse+IIHJgkX9BIXAZ6J4Z4MVfjlVM4wX6pzpajy3ENPwK6voPgS9vji5Ep49ICmcZP5ezDSWE9s0VtfuoX2nnQTezkFwTPo/9mb+zasiB8+3xu/HN6TWeXB7/7eb4Cp+I1lbRPw7hrS65JViFL8yjO+bYCEBRlqC9on6qJg4M1QMIJNG5lwb6+luySqBManhlFqSYYVbfMaNMWnhxtKiEUr5F8sqvqdoh2hHCHO6sp5L6kkijwcHYcdQytU+NJg/EXElXxa9rYuy6PgkJcOfKPsH8FfeHrkuhqwl4GUJZcQEVZSmyQepvVkxrVVatscaS07JRKDjA+QvaXSfNwFy+E1SEQ+EthkVjH/CsNVfl7noDE5NVmEoHUqANWEGNcQwNC/SJwk8TYeCIzJUAeMJ8XIFY5RzDcPeDZgY5jt85MkteEHcXAeDHZtGKF5+VCb6EGkyNRmyN3EwGkcwuEE82owpz5YGvd+L2sbuP3X3svjB2N19emp0J85ZLn+Z26XMTygz6jTl5bpU+MXtPGIl8kN5N1IY8pGLalEjvP1wjsH9GEYfx6suSNpC+YX2kU/mOvZXcHvr5NN9DzFP/2hbEIOtRS+ABiZQ7Yr7XHLOitKra26u9i+KpDwcNd5SIQM1YrKJMSKgszsKQOJHJoXAjlYTfpWIugY/oq8CvRkBaNXTtJW2D7ivJfSW5z0b7bPT7yUb7SnIfu/vY/W3G7pOVZMEVR4upk5JssZDxSnuaec/7yAIDRP4bmShCrvglr1ytEDFR1FhWtXKwpq3mtOn1HdVxZcfttYdey+m1ZLff7DennRb9aLfO9ZN1HBdBVo2pkr21HVnFKOI+o47LQjhXkkaRW93+g3pj5RGs8Q/Ted0MnUOlt0Xt2Bpu147XUUTnVlZ5hZRUashwrSPCNIxd0Ng4H4sBUsyAiyH9hO+DL3Ilf6FAJabjFoG/8Dl4SQrQjVf22KNf13Wg5E5WrOKHTpCBQ0aCINJnM+6kDyGVRzUfKHAFOwM6f8Pq1Jjov6rkxSVJfEoSi+MvjlIU6EXl3t21v3tCJw0II660gR/Z6NXdjgzhAGgINGYVdee+Pt/X5/scv8/xv48cv6/P97G7j93fZuz+B/W5qYYer88x4MX1OcbWGqKopd6Rc/3Py3QOFcMBu7eIHCeLebs5r8G5roArFYfMrdJZwtIBKlsfoErq9/lZtQeM1E2AZi+LA0zKD+/ew2qw1kNNLv1afqIkjO5qTrSof27vwCA6LKDjDSjmZg7vPY8vTkynUWNdxz65s8Y+XkBrnqUjx4UFeJf4Sfp8ZA0mXUESockcCri+cS1+DDaX6Cu+S3h0zRwj3ZARst3EwcNz8vzYfkoOTeQROXap78m1MF6Ayw3xzIGPRMH8IMT2ugE/Rxq0xhkZfHJbHnNFRbrmcGvkOvFQY9faYuichrXEGyVjdBD6t45X7z9cvxYzKk0ZGrKEqmLlUy+B4LqAGzH0jfN9f5rE2SiOstmchRtXflmhUBNeAKWIj+GVUmKSH/85Q064BIiz2mmSYtygWevj5a76rAJKl7W1tsk5fTesQ4t1WZn3mlMj9xB+qA/p4GntY2iLtz4hFp/fpzFGRG4JxWSZyyVLcn0tE3/Iqdmams3UktcbXGjVThx9UsdBvBMJGSSsra9eXNOzS/So4cITorrJA2nC8FH9PczJrfbVfFTo2USvysfH8MPcp5stlWlCw5xIkDYDV5wIZx5FifqLEOQ6FCqTWYZI+2q27mhRmyPCbjVKLNl6Sdu3UUUyf6cIjFA7k5xSFuciJkJ9F7o6bD+xZYELn/g4+aeKzPx4gmRLI93ISb6aZ1rQpgVtjROJ4V/nMnIsOpIGGRgHtAMcre3PSGAYLeGiprUT+Zl8nedQ+nDAKlNJliP9ZbQGQfNJ8AsaXYwBTFMRXvxCiO/C0OKzm2Vl5dsHmxrc5jeIkEc39Kb5LbavKLf+2uQlicfrXZbzMFh9a5R+BEl+Pbj7f0K8PdL8HpHGlMW0W3m5vtx3/Pzdm+o1KNMYbN/zQZFFrswimd6kHEC6WtzeT6QN77nCX7xlFODaHp1TfuWBboWsyYC5lOKF8cKZ+4p3IpZKplR5HpLPRguOcZTbBCzoN5nQjE8Sx1CGRO/oB6BXEx/Q6oUOzEdtHp3dANWfItPvXcGCfEVNvM2dAsXZYpGFdLQbTGQLIeF6z3iO6ydOpgEOXV+ocskiLhGLWXm0k0uSKmrc8MSL5NyjLWt0wyUHeWYt+Edi9quhyNLlsbUglyooLm9Vy//naMMr7bkKltRoAp1RqKnSCj+cXG9RBLHQXFShG49mUlKnsXQvD8JrZ2jX0F7ybcIoSdEVl+hemFu9letJxXXhjYs2xUb9b+MysMlnNKa+pM02UkGmmycdhBNrV9OKqaPiihXCbw6t0dj7e9qboRbugR4j1qnxn9yuOzQOdxiUPqNF9gBF6gktvjLyuK9F+fbxTr7zrcRwVQILfPxZ0eZDwS4adTDMe0TMjH5tfpSw+bLFevpTt3qpf9WT9RbUE9MYo4ptgYvx9dFfMXpqrjgv9BZHLO/wkP6OrI/4jy/RUkcKBvHzeyvfMMQYTZj+/Rvz2+BL +sidebar_class_name: "patch api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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`. + +## Request + +

Path Parameters

Body

arrayrequired
+ +A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +
  • Array [
    • value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    oneOf
    + +string + +
    + +integer + +
  • Array [
    • anyOf
    + +string + +
    + +integer + +
  • ]
  • ]
+ +A patched non-employee source object. + +
Schema
    approvers object[]
    + +List of approvers + +
  • Array [
  • ]
    • accountManagers object[]
    + +List of account managers + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/patch-oauth-client.api.mdx b/docs/api/v3/patch-oauth-client.api.mdx new file mode 100644 index 000000000..6f0c36b4e --- /dev/null +++ b/docs/api/v3/patch-oauth-client.api.mdx @@ -0,0 +1,135 @@ +--- +id: patch-oauth-client +sidebar_label: Patch OAuth Client +hide_title: true +hide_table_of_contents: true +api: eJztXOtz2zYS/1cwvA+Nc5asl1/6cqP40Srn2Dk/mpnanhQiQQktBbAEaUf1+H+/3QX4kmQ5Sd3rNaPJjCORwGJ3sY/fQgAePB2LhKdSq2Hg9b2Yp/7kjGfp5CCSQqXepmeEnyUynXn96wfvyojkQKtUfEoH0AieeSbua+zQ8KlHf8oVHwvv9vF200v52GCbM2zMLEnjwYtAGD+RMY4Lo15OpGHAR6iTqWGcpTwZi1QELIsDngqWapZOBAuliIJXZoPpkHHFLFE7ahMYjXnCp9AtMcSqVFaeCbxS8AK+yQDl8Sdiyr3+g5fOYnxq0kSqsfe46SXit0wmAhSRJplY5FLUxmRETnzi0zhCOiLs7oX7vW5vV+z3tnc6o+3RaK/X6fHtne7+brDnoUZwCGHSNzqYIQurRxywSJoUxa2N67RSzByozPd1EoAUuaqu316cnbL3OJu3ryZpGpv+1laqdWSaUqRhUyfjrUk6jbaS0N/Zb3U2mEm5CngSNG/UjUJRQx1F+h5pkt5hkEQwsg8+ikT/Rr1mqVBcpfhplBmphDGnoGj8PtFTEYMZXCURflXucUU8/ApsQ59L/atQP/JIBmBlF8LXKjD4NhFhIszk6dcBaM5PrxJJ38cJ8HIJU2oqpOErfgM+gecAP8JsazVGdV5kcayT1D72Iy6npvIIptZHQwcfgHnicRxJn7S99YvRqkGK+Cd+xNcLNsWThM+AhEzF1FSe69EvwLK3ONE4XzRd7CyfVsYNKCwEvQZsNGPX58cHDOeKNdiXzq5Xte1r8HlyF3ANsMg4QUNKpSA+4dWCZyxzhML40OJGIvdeQS6hsikOw4OABp7qO0Ef4oj7+Mk98HWMOkrBH5CR0pPylo+Oy2c5GjD7wilGS5i4BCwkBgOCGSTHAKZtXEEjniDbEENEJKboUlYIHoYwO1bdaVXImp9vVccGFu94lAnSnRJnIcWeeW7LzqfivuoFKL5Mo1oYKrqjFGORVPt3W62yR/6+0qWwr7xN8aAgAcacwlCjLLUz7mJjPJGRjL3Hxwq13IpzYvb745L4LRhpwekxM6BDMIe6EjdZboP07gbt48aDWQjgs5ty+F6GtZWKAz4Lvt6CG5I3FL5Dr4vO19auKxZozcrbWhINvGJGMSSjNp7oW415ZSeP+1PRMDriMDG3qE7oamIQx6q702rhf3UFDlWA0UUY0tj7weXBDxUPMxkEMxGIYJOUlYg0S5RtWs0L3xmmQEmF1VPn5uo4tjR4FTZTDw2Q7p51xOEhZqt5zmoT2fH323utve520BHb7Z29Vns76HbCvf2Wz9vbe210qZpqlwyqsijCiP50okarzlnJqdGXwfuhAyLMTHQWgbOLSFPmrLE5wGm8sNO46VXy2dfxkxNgV+cnENiN9iXHSHMvMRahm9wrCFmO45LJGk8Y6iHSR9rn0USbtN/udHvbyJ96QlHzYXKSATxrJIIHyK7VUu6oTwx6CPG7+u5xjuqXamNQdeNnBB4oepPjnmpYQcipE/k72fJHXwdiM0cMH1OEDNZZbNePPkQdTAQ8MiwEWGNQjKfhR0WqMghjfuOpfdTtLM2KkPhGdhaNJYQ5xg7DiCk2FgrduhAEgG/FIuHbHXKCL6uK2N1uURx5EhC9IMO5Fv8Qw3s7vZZluQRpS+DRvKXMw6USmj8FjMkUYghUdyIoICE42dBYcyn8a9FeyBCqTF8/5WC3wEAJL1fBvDqbFAM77HvsyrAv5tInocHByfDo9PLjwfnRIfw/HJxcVLDU0peDq8sfzs6HPw0uh2enHw/ODo/g4fnR8fnRxQ8fL8/+fXSKuCrPkt/nEqzSpw3bnWbL4mmG7JqFaffBrPM8jxqua3EpW0sFmOO19ElS0rw60WBzZ4IG7JVWEQR2ptGAQ/y4YU2ixmxNx2fHxyfD06Nl8+AUfXbqGuRNKxoclMw95hSWMUncLUQ29irORpB9kV/wtVC6iLRRt4Kz0+OhU9EKNueavb96czI8qPJqx8x5JUCseDV5jaBeEFwtJgnFpIUjpFd2PxEgx3yKqJkARgZX2BqWD4VYcHh4WhUuhPArEJjZcuzlmIEJdzSJF2CqOqzFcd4yrPdiHBhL0rj6ksINTq+/UD/kSpirOP8EVvC5EQmYmAt72Oli8O7EVbtIQH15mCwEABhRZ7yw0iLz4EJFI5UEkBf9hJYxMEtji00WAAbKFzCmMoKQRDlp0/I5J+U9VMc5BzV42WrvNlq7jXb7sr3X7233u7vN1v7eT+gFUx3IUP6lLEfc5As4C3zvNVo7jc72ZafV73T6nb1mu9UjvrHTlVnO93wK/XPkqIf/UhC0HeiWg4R5uNNktLSHY5gUJIVxIJsonTKsw50aGBimuBPJrDpEZgAsbwJ0h6ykohn88YE6sD1zNF1tMqsEojCLyP1tYA1nWPbfT6Q/qRC2y1hKM8T84DvcT+WdgAFIFEKMlp5dtgian21cxtex+HqMg5MU8izCqTNxn6iZPo+ixWx9Qe8WE0yznoYDkKDPY+kWZhtEsh/KxNgFqGVv7bRDJn6srxjRUudcwVutiVwFUud0JcJeDWfnkGMNftVAgsuQlQxXppflIX8x8pahrBIi8gmtAiiREjyy2j53VT0umYC2esvqemfMR0kCZtlg51S5g51JO3UuZ7KRDmaYw6QiMP2CNXsgUi6jAwjjz1eHxzC5DdAzLTgKYpniP4JrSYvLUw2+Y0nm1kft6k4Cmmi22RsegLxWvgMnDIKmhPu/Aq3hZywmXCn5G64puS5MltXfkmHFruCjndZ+pxfu9Djv7PXau9uj/ZB3u6397f19SgBgNmCxyyB8fejvMaABVKNKQP5OtQUH3RMDNPiqxd36HBCNz9A/hmXbthDT8cvw9xaoZ9mbg/estwuxV40zes7Hc0pQjauLhaCDKYQInyVyLJfW7DmuPDw6HlydXBI2/8/V0QV8QloLS37zWGSi74ljJwBmCCMiWk1tsteO6msQiLuVK9dQOpgyM6BM5kIg9HCjL+lRJc3CRE9rruTbH6fYK9kUTcgf+GxK6+ojbmyuweavEcrHaePEafI1mwgeiGSjyQYBBCIQEhAsLekZ6D+j1eEgQNe1BMIMXFkQbtKQoyClSV/U56JU5XwKyAPKSXVS0DmA889YxfHTDOE1iln1wsJaHItufoBnq7k6d5cVpZFKZyrFZAgtIRv6OqFCGvOvhKTpwhFOl4HAo/J2RcSqLsdSuHtnmTlMNb3zeWY+w+/eQ2hWDRKteHEnnPMhqHDRiGYjnyYXkRx8oc6uVTFduePb37LWvrv23bXvfqbvzr/McY97S9CnvQh9rlReSoIQC9AnIesBGF6rN91EbuIKiYNIbz9cuoVIrPE/xQhIXxAf2VS+wPygmA/7fJT/gpin/nIukEHSo5UghEgkgj7xXXJMirKq6i6OdqyTkQQDVUsgIkTNhM10RmVLkimFnHCzSZWU+i5lE35XroppW6oJFTRi/BF0jSTXSHKdjdbZ6NvJRmskufbdte/+PX13JZIsuCJvcTjJZNMpT2bW0tx72v3JoAHL99WwwuWKrVhVtILEWIGxvDpy8Ead9qgd7vqiF/BesNPdDzv+Todv77Z326NeZ9er5vrr0o8LJ6v7VGW+7TySigHE3QGOyxQYl0m1DurLf6DeRIQY1mhbWo6bQedNu4fIYcfeInY81SnIBoQBOyZPLC/ilhOgD0MTedSbzhLf/nBKqoPmPC0X58UnSWvEa+i4ho7r9LNOP99G+llDx7Xvrn337+m7XwQde89Bx94XQMceQ4gVIsT6K6FjALgDoVkIkwIy+BmoV6Vzm70Lt3cHHXKgV0ORnf0lm9a0Zu+4muVgydRWIlWpLgxv0HaKbSs7voCjMYRIhcdAJKBbtCo5FYhJcVdIJKeS/BgFArrJrDEI8YSG9Znc3opRpPKjDDikoOA2Z4ONSTAnESL8Awq0DjqGQP2Ca5xutv7QejA7R4lPUGJ29Mnu22fF+u/28t3/bsfchZ3rJ7YL2DVzrqCMEJ9iG74KCLqG6muovk7363T/baT7NVRf++7ad/+evvsFUN2hoaehOjT4bKgObZstVmCpY9pL+79G7OQqjgMyb6Z9wupBicEJV4ApFfcteOWZ0upNCmbrQQaPHt7AgLDQcpThAUQvP/P9YE/gPzZ5LJt223M6U/q+6evp1l13SdjBXabWxSBwBZlPZQNuIbaDNEm9iUQLtuGOBrDKLrYng9Jpe8FK+vkJzBmUIO6mgE08GeOsiR4DmzGUEnhyFVo33enjORlBtqskenxOnh+7q+SwRJ6QY5n6Vo4F7RlwOScesn9bXphxgZjbjr5wbUaZR3DCF8/muZNjbwRP8IAHbYB59fbD5UblPB7uxh4zIbE0AF95DyZCkWxQPW9IySXR2dge7xjUttsc5Mc7muxGXQjBrodOCacQ4s8hJpNKB7WzLOWNA4G4ExFmv2apSTQ8Gagt0NBW/QzMBmU6KgmksqcU8HzyjWqwQ9rpTTdZYBsnIlV47DrO5aoeLPhaJv6RU2tYag2iZjbmuLCqvXbnTucPj3714G6rfYVeg/a1N5DqPA/2IBPxUd8kVRzK+Wo+avQaSK/Ox436QMcm6t2YjVr5sekh8ydaG/EvxtB00A2uxxl40VezRWc1GjYEdloVlhp2yIZsACgk/k7AMZQ1Jj7CpEyYRNvlEXLJn2lmwed/plMdP9dkpsfXkDuxZaB989U844ANHLBhY4Bx/NvUhIYFvm1PHIPTWwM4KOefIoFjtBLzLK2lUZ3Ib1Efz51RICrlmZEywLlPzJ5k2Jw7V9L3ym1j8J05WpifasrKVwPmNbjIb6QhLc7pzfJb/KaJqfL/TV6UeFAumpypaPbSUfqJSPL/E3f/ooi3jjTfYqRxKBcXH8/L+66Onr+OpX56LL9RZeHql1s87hVqEsmVGlUHskhwcXkQ168nwtCROYoCBNWhECqPv1bJAHMp+gvFC38iBS0sxIKniCo30Wb1lHwcoDQGFigfidCYTpMloAwOpaCMgF6TfYDKTfkwfVi14YZeoPqLduXbBcwg3VrEDnOjAHA2nWYK+qL/ZlPGwfSesZxAGj+zAQ6KOCVyyTRBxKJX7u1okqiKJtUvydSchbgCDcVtxUCeGQvsw7jlZ1Akzoi7T6gU5FxExX0+dWj/HG08njgRUUxnYIEtPG1XjvBueLlAEYgp95sHXoLlOpktbItXNYHw1hi6TagW6YIpbVIocit03TVclSvr5k3poVxuf6G761yewQJhK8Y1LWQtswWLdY5rr1YbQp++DPB0It5Tga8fHnDVAyulR3wMbocl9fVtWQiR54Fu3eF7Ose9QrJX5+4A6Ab9brN49d1SpvPlOjWreDB8/FVggQ/9HvGaB7sCQwzZF27Jv+EOdRaXKa24dw1LRdvZLvCs6EYhoyi66X4laD1yl/BN7QJCwvGYO/7tezfwD77o2BouNKLnD16+HAdtLOEcLi1DC+4DTAI0+y+Aj0wM +sidebar_class_name: "patch api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Patch OAuth Client

+ + + + + +This performs a targeted update to the field(s) of an OAuth client. + +## Request + +

Path Parameters

Body

arrayrequired
+ +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 + + +
  • Array [
    • value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    oneOf
    + +string + +
    + +integer + +
  • Array [
    • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/patch-personal-access-token.api.mdx b/docs/api/v3/patch-personal-access-token.api.mdx new file mode 100644 index 000000000..259cfcfca --- /dev/null +++ b/docs/api/v3/patch-personal-access-token.api.mdx @@ -0,0 +1,128 @@ +--- +id: patch-personal-access-token +sidebar_label: Patch Personal Access Token +hide_title: true +hide_table_of_contents: true +api: eJztXOtv2zgS/1cI3YdterFjO87LXw5p2u6laJtcHlfcJQWWliibW4nSklRSX5D//WaG1MtWk7RX3O4WRoHUlsjhvOc3tKi7IMuF5lZm6jgKJkHObTg/FdpkiieHYSiMucg+CRVsBkaEhZZ2EUyu7oJLI/RRpqz4bA8LO4drgckn6aKX+7k9TpN7FmebScoVn4ng4/3HzcDymcEJ5TLMrcNoIRPAiEiYUMscuQKeLubSMKAbZzo1jDPL9UxYEbEij7gVzGbMzgWLpUiiZ2aDZTEM6iTeBzFyrnkK07UhQaRyUs/hloIb8E1GKG04FykPJneBXeR41Vgt1Sy43wy0+K2QWoC6rC7EKreie3FGdMVnnuYJEhTx9n58MN4e74mD8c7uaLozne6PR2O+s7t9sBftB6grXEsY+yKLFsjLw0sfskQai/KfoFFYmEihbKmmytCgwzDMdATilLq7enN+8p6dovE/Pptbm5vJ1pbNssT0pbBxP9OzrblNky0dh7sHg9EGM5ariOuof62uFcocZ0mS3SJNMgQsogUjd+LTREyu1XOG+sX/TQi8XKNPhehCyqJoPM8TGRKDW7+C9no096/4EW+v2INrzRdAQlqRmsb1bPqrCG2wqhsUkSRkJ6UmGDcsErFU4EzTBbs6e33EUDzWY1+rkKDpF1cQVeRq4FZgxFyj7q0UxCfcWvGqLieq7IVGmooyAgR5kSpSXIZHES2cZjeCPuQJD/GTvwCKRh1ZcCFkpHa+cuS95/JRjg6Zu+EVk0kwnGZARgsDFiRfAqZdbKLd58g2V0wkIkUvdELwOAbrOHXbppCt0Nhqrg0s3vCkEKQ7JU5iittlbuvJ78Uta84H8aVNWiFcTUcpZkI3528PBvWM8n5jSuVf5ZjqQkUCnNnCUtPCOov7vJLPZSLz4P6+Qa304pKY+37fkQMFIy14PRYGdAju0FbiJit9kO5do39cB2CFCD57k8P3OhM8qDjgs+LrDYQhRUMVO3S7mnzl/Lrhgc6tgi0SvjIhLUKXUAlfmEL5oZ5DpYWumQlPEiwiqEOYaHKQwel4NBjgf22tHasIU4owpKbTw4ujvzfCyhSQnUUkok3SkBa20Koa+pNhCnitPJzm9B/OWZ2JqvKPdhqAavCkNHD8EhM6MlWWVuZKK6PSyp41HII77uGzRh2TE7zgRoYM68FGv2Xu/d14GIW7sdiPd8bj4fhgZzDeGYfT6XA42tuPOQae89ynsEnrPcRonx1xpTKLzOIggxOA4Qy+6O4pcPPWp2ZOQrUFeJ9F4s05O8YYLX0SCzc6z2qdUEWSYCUqS+dy3WjIFvMisXip5Xb3y2Kf070VodtSNzm+AgJpNumESD1aaRJLbVzxemQgoLFMRRALmwEqST9eAU873Ycmg6/LCLO4XfRXHNVRfcwHHqb+8uKE4fx+o3Ydv3z1/uL44l/twlRdBcGeEiJPkwqiqO07o/BguD/g492Y80iI8WC4G0/HYjDcD0cDwF9Pd/6HGZgXgHx7WvAIfY9F0kCyW1C0tBk6L/I807aVdCHhnpBt4VoINKzoVAiiAo7+ijCvZyXl29UIJRCIiQ5HbLIIWCzhXyoTQI7kUZvsdg78W4+5O0S7haD13CzpdDDc6w32esPhxXB/Mt6ZbO/1Bwf7/0b2E24s9Ayd/C9H5u8gD7LnUihQmAmFJQKJL2Uw6kRwOUC/aQ5LQvhjSkPI41B2xKCwiBuhF1hDgCR0PZsMkABcTxbwJwSywPrCE/OhtmAhLObSeFwklLid78YLhFa3cwm4FSg6WK0ylmQKgAnwZ+WNAMou/4M2PCGHCb/CQq5DaxpoCnBXcNVMiTFPjGhQ9N+Xqi4kRDSkU7pTMnzwC5TI75zLhGAkg4iwaHNXhqVT6Y00EiNGqqqkMcKcMWCFPnsNCvJcbLIPmf4UQ/Nh2C0Y3jtntd4XSguqGKnCpHlWzrktKfWD+/s2oqfuzYOZEqC4zFsH58c6dn8WtqONPvOQBUEg0B93gZYj17W90ho47LEzgiUgh3R1xneEbAotISpLKoBJMvqOyCQSFmxzBNX18ez3GnqnHlRfaqEEsRzCRPTrG0kdZpqBwzqSZamkcW3PBE30h4BVIpDXyXfkhcF8qHn4CWgdP6EeXCr5G6JkPwWiqILJHcuKPcGnu4OD0TjeHXM+2h8P93amBzHf3h4c7BxQGYBoxyg2HZiivfTPmDcAayVZCBb5j0BIyUH3xAAt/lC72rYB0Xgi9HJjKzE9vwz3ZiCk2IujUzbegxSnZgVd57MlJaje5flKHsakTYRPtJxJ1cVKWclfvnp9ePn2Aq6cvfrH5atz+IS0VpqYQ8gDDpEDq+AL8+yWOPYCYCI20C5if9hnzz3V5yAQ97DcD5Tum1kYUCbzyQlm+NU7ZjRJs1hnaSuUQreRxZ7JvuhDtsZrKe0UTLlxKR2HP8dAzm3vrdfkczaHui70Rp8dRpFEISHLUNOC2W5B/W4UYeg6AnEBoQzMSDvPoCJAmpPhEgyoVblcFcvE8rZpFAwO4PwJ7XtoC2COxGxGYeUtnkVvH+DZaa7N3UVDaaTSBfRFUIFgJJSgMNMaNEzVTlrDfDpCcxlIPKocV2WsJtahdPfOMfPSZnQv5IV5QtydJpB+eiRadeNG+ODDfO+zEVmjNJPPSB4w0GQ/qjJXGfhuQ2sdu+vYXcfuE2N3+WaJe/xdgj7DVehzqXgB+tVUPFegjxYOHLJykNvGcYbcZAiZnXbefLioYaf4nCOE+474yJXyFeYPK3u469NyT7Qs/bUtkEHSo5MghkwkognxXXNMinKq2l5dDQDwVIKDqg6ISGB5kRXUK+hCKeSEm01qWNRPls055McKDjucLlTUyxGPr5HkGkmuq9G6Gv041WiNJNexu47dP2fsPogkK64oWjxOMkWacr1wnubvu2dCYAArfzRkVchVPy430QoSYxXGCtrIIZiOhtNhvBeKccTH0e72QTwKd0d8Z2+4N5yOR3tBs9Zf1XFcBVk7phr2dnYkFQOIuwEcVyhwLmOzLGpv/4F6tYgxrdEP7SVuBp2DSj/W2HG8ih3fZxZkA8KAHfUXthcvz94ifdwfRfKot6zQoUCY7VQHw7mt98DFZ0m/XK2h4xo6rsvPuvz8GOVnDR3XsbuO3T9n7H4VdBw/Bh3HXwEdxwwhVowQ6/eEjhHgDoRmMRgFZAgLUK+yS4+0VWHvH90sgV4LRY4OVlHkRZaxd1wtSrBkWjuRqlYXpjcYm+JYXY6FAZzNIEUq/IFeArpFr5KpQEyKP8UnMpUUxygQ0NWL3mGMz5y6mCn9rVpFqjApgENKCvh0BK57yyU+cBYj/AMKtA86g0T9Hfc4vbX+p/1gdoYSv0WJ2avP7qFEVu3/7nQ/2mjxIb+EnTtbf+FxAbdnzhW0EeJz7tJXBUHXUH0N1dflfl3uf4xyv4bq69hdx+6fM3a/Aqp7NPRlqA4DngzVYWx/wCos9Zqecv1/I3YKFc8BuTfLQsLqUY3BCVeAK1VnNIP6uEz3kcutOxndB3hsE/GhY63QCUwoj7PdgcXAUvd9nst++aS8ym77YZZu3Wx35B983NTFGmSwqAipfzg8PfYNR5/0rCW6sst7tIDTenWoArRPzxk8SL88TrKAXoQ5Mpt4gsC7FV0GNnPoKfCgDj1O7w5WLckIsl3q5P4xef65/ZAcjsgX5OhS34NrwXgGXC6Jh+x/rE/ZniP4dquvnLWtCwpu+49WFqPTnyP2QnANnYE/JvTmw8VG9Wh7xAqDaFdI7BE6jsv6UwxYZXRWzObE+GHruRsMIYYPS/fZtToXgl0deyW8h1x/BsmZVIqTBOUDnFUfpozEjUiwDPZrTaLjyUhtgYa2eGveBpU86g2kcgcE8DjWteqxlxIzEZ1rxTFeRGr12FXnw9/fysRfuiNtY4kLp9orf/o2hDhGEjwxpK1vXtzR6zXoYSMFV5DqMg/u6Xbio/20VFha7Zv5aNHrIb02H9fqA51WaE9jLn0xA+UwidgxC+dZZsTfGEPXwTC4mhUQRd/MFh2R6FFE9EaDBks9t2RP9gAdEn9vITCUcyY+xepM4CRz+yQUkr+QZSHmf6EzCb+0ZKbLV1BEcWSUheabecYFe7hgz+UA4/l3NQodC2KbziNg0DsHOKrtT5nAM9rIeY5WZ1Yn8lu2PNFPB9iomlYn3eoE5z+x8rBD+zQcgOvq+TH4zjwtLFQtZZXbAssaXOU3yaA+LunN8Vv9uIk1848mL0p8WO+enKhk8b2z9BcyyR8n7/5OGW+daX7ETOPhLu5CntVvv3j1+Enz9qH/5oHz1ql2AFnoyiSS7zmaAeSQ4Oo+oaFjy/AX7lIWIMwOHRH1eISPmmTKQ22UL8K5FLTDkAtuEVVuos9mKcU4QGlMLMI4QjM6S6ZBGRx6QpngmVz2AVo4FYL5sH3DJ3uB6q+Z7+Pqk3QvS6cAcJamhcKTr8BEkTIOrveI50TShIVLcNDNKVFK5g5oV7PKaEeXRFX0qZHRqTmJcSsautyGgzyyFviH8fvQoEi0iH9VQi3ImUiqVxW0of1jtMEre3OR5HT8FNjCY3f1Cu+OL1YoAjHlf/zA93v4SWYLx+JbKEB45wzbfWgb6d0ZmbHQ7TboujeMdL4AZtmn7uoN+O/8jhtfeLBj2Mpxtwt5LVwH46LlKujGsjB5Iukg4xxEw3F3d7gxgj3UPV6GgMSu++pj3SJRTILW8XPUfSa0KeqzM3+qcoN+2nngXTmdYpRbe2rRCHL4+EngZgDMu8cz8W63hjhzN/zPA72LRfPVEg++dQa7STfZbQY9MI2yStWg04smYPTUv7UndZsNmt/CRfw7Ca7hH3zJcufbMIiu3wXl1h2McYRLRNUFKPwHsAYM+y+qp7RU +sidebar_class_name: "patch api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Patch Personal Access Token

+ + + + + +This performs a targeted update to the field(s) of a Personal Access Token. + +## Request + +

Path Parameters

Body

arrayrequired
+ +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 + + +
  • Array [
    • value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    oneOf
    + +string + +
    + +integer + +
  • Array [
    • anyOf
    + +string + +
    + +integer + +
  • ]
  • ]
+ +Indicates the PATCH operation succeeded, and returns the PAT's new representation. + +
Schema
    owner objectrequired
    + +Personal access token owner's identity. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/patch-role.api.mdx b/docs/api/v3/patch-role.api.mdx new file mode 100644 index 000000000..9c1ff6a6a --- /dev/null +++ b/docs/api/v3/patch-role.api.mdx @@ -0,0 +1,163 @@ +--- +id: patch-role +sidebar_label: Patch a specified Role +hide_title: true +hide_table_of_contents: true +api: eJztPWtz4ka2f6WL+yGJFzBgxjauSt0lmJmQeIwXcKb2eqZmG6kFnRESVw97yJT/+z3ndLfUErKNPdm7SYrarEdI/TjvV3dLX2rhWkQ8kWEwcmtntTVPnOUk9EWtXkv4Iq6d3dTwZ1z7UK+5InYiucbG0HS2lDHrX41YunZ5ImLGAyY+yziRwYJhH5bGeHnz03R8ya5w4A/fLpNkHZ8dHiZh6MdNKRKvGUaLw2Wy8g8jzznutTrfsXgTJPxz833wPpgtBfNC3w/vcChPCt+FiSLBCFA+98UZOzgI+EocHNThygJR3RABNnLVj/AuEJG65I4j4vgqCj0J2Kl7K7GaiyheyrX6HYn/TUWc4AB2p4m6PQgDTy5My9vwk6h4EIvFSgQJTPA+6LMEGgXsTiZLJFydjSdvPvbP344u62wyvhia6zBSP6fXP9AdxtNkGUYy2TAgOUIlI+HCaMzhvs8SzYgmGwWMu65E7OuM29M9NN6Kb1gY+JviSEx6DH/3CV9mqMRk4PipC1PLANoKxWXkBo/j0JEgBQTVNEwj6KhmXvGALwQSgd2F0adFFKbrmIUeu1tKZ6mGKQAHIHCmWNFUArDin+UqXbE4Xa/DCCfxRbCAsT2gFA5gcV3JCA7SabVaDGQk4k4CXG2yizBYiMhujCACmnMQp0jEIrqFoXHMTIwjFP06W4Z34lZEQNNgwwJxp+4D1uxOQH8e0wOjB0CBbIDKyXy5kppUZSBB7dbwYyXwFyjflxrKNmibdOGRDJSKLmtlZRydI0kznsDIpCDQzohL7SyJUlGvxc5SrHjt7Est2axx5DiJAFJoKT7z1drHWx2n1z5tnfKT0/ZRq9firTZcddudtoD/v2qf1u7vP6iRQdx/CN0NDueEQQJcxku+XvvSIaty+GscBg0C5m94iY+3QOBRxDeIXyJWsXU/nP8qnGQL2T5Dk0IWhY2N+UIuuMKTARB2vmE3k9cDhuaENdhzDVCBajdgIYkrQHVAeh2hwUykIDjhUQUhy3ZSsMzIImdQ3EQEcrYSyFQRpCucBjSXJl6Ft4Iu1j538ErfcMI10ggkLEFAcm6Zlvcayich6jP1QBMmlMC4COwKKUFAcouSlPBoIRIUpCWCjebdV4qskOCeB9xR5E5sJAuydGjPDSDecj8VRLtAjD0S8YcF8RJ0ze4P6MvEtxrf17PuiAXot93/qNXKe5jnVpdMvkyb7EY2BAhzAlPN00RxXKvjeil9uQY9sEYzUmwGU7/vKxynYEQFTcc01manQMR6bujx2XuUj/c14IIL15rl8DtrHz9KOIAzg+snUEPShkx36LHuTFi+5Z+Av8qWTHIvSLMPyaMymaAXGAeCDcBVYKeK8ECPyWKwoDGaUbZK/UTiLe3L0QEhDch2usplcIaBg6+dPLkmNIxacm6U2lkKoqS+dmj567w5Wj1k0gN9dHxQav8B6NGPY7kIDBVQAdhUefMnkAUrn4J4Kl+wJP6icVbI4DgPDoyahA5cK6C++03MwLxDO2Pe4YaJKxgJWQV1lDUxWJrmh428Zc07mbfnp/yo8coTbqPrud0Gdzu9xmmn1e6K9tGJaPdqRIopmAGc/G0WIAFsPmgKWrQBBBIiklxhcgGOD7EduWhJjJ3cSTSgvzLgmjSAponI1kgZML23kojDwYWWp0F98UQkAiezSDICwsU7iU4e+tUsE6UVe3Q+vJyNZv/8eDGaztBNWbjBkNLNXWbv5MgTvdaxAy6z2znutHpETLdHZsdueWw/7XrAiO7JcbvjHSHJn0v1aQKaySNQzs9oxGOpHO3Xkh1mVDH8dNa/PO9Pzpmjp6VYk8JFh8einkceJsZZRDzQMQ5GkjmfdNy35LeCeh0MgwVMLtCcH7DM2DIvClfUQAYuxhIwloorv56fBht0qhof5cyNOTyrjSf4EIy8CxKlJ8qfDv9x3b+YQotPYmONS1JyMXwL/9aySGGDymiwaiq4wO9BIEbYjCyROD05abW9OcpEp30EsZYREPSbyuH9onXXIhrJi7JYrgs8RNM/8DlaHa4M0ADxQG0BFz40kelXigynuYhCzFGz6Rghm6AsM/DIzPSkwcr5d2i6Hxp22EasxJfL8+nHd6PZj1usMSr8EF8gHpX+Npn/rlV9E4R3TSdcYeB7j06/FFbTjXgNXljZOwjrt4k5oRauzovy/Ck23q9JUd6DUXRl6PxgiKyT+GK8igZol3hVunY60WQkByqzWoFvoyRGeAkLUtDtuyVkmU4kOLEdRAD7QBYL3aM7iWLIupDl/MBdE0swEUUQ05CtALpBSNCsyj+OT7o99+T09AiNKW/zbivLP+o6ENsFmWUKOWgD4HMpcHFlDNYC8jgYwMYSI23++YIyy9pZu3NqQ0Sc6rw6PsGpCVexAynPoZllGoHTpmu9hvE/Bz7XkPWNRK5EkQStTrvROmq02rNO5+yoc/bqtNludf+HMgPujiFnz0RvFboSmPMigHwO7DADNJ8BV2fWaZ0BaJ2H4SrMvQ0aCg/FajozLUtwmW9Wkl9kWw7ddRRwhtkzc9IoTmNItHwf1EnEIHcskLHPwsiRuqIA2IeQb6n7IpUx0IF5aewIoEg0l4y8ClgXsHZyLWMH5XvFhQNBY4y9JANcwNrh4DAnzAtjwgV0SzFGc/U4QRo4ahYz8YovENLISSEViCS2Dn3QdpmkEOGYRCtdMRHIVWlOUE65juEZZMtr6KkgdiVfmfthBP81UVSp4lVlLnLie9yPt6hPSSv2VaQG7Vc9m1smRQ1ckcTptDazvFt50JjGx36VBkZINCCWnQGLEQtKPr8xg37DQBhksE6Tr7I3GYz39Z1MpI5mNoyqMmW7xbvHHueuEN1W+9ibd0Wrfep0WsdHvd3t1o9P2yxiD8RhicmhCpQKVzJJVKWOs6vxdIY3r/qzwY/QxUNC1jGFI2KvVGYCY4LWRJiHqPTUngiiQhuIryK3ruMVklIShomJ4JFQxQrtc6pFz/d5efmsWPIsgO154JNap+2TV21xDJ6o56Evah+3e+2ecByOQD+kDSXtgqc4oU5YgU1au56rB/3BYDidfryajF+PLobfbLviIjov4ZpW4+JMxQJU6dnvKeRF+Av0gQtIo0MskBgjUBSzYl/tvS2R69sCBqJHgBd8ElZFAmpO2fPLK5bDfBRdRFdpbLwWDnhehxiKATqBtLuRfXAWUNfz2VgZV4uLdoZSYKH9YEcjWJxtdF4VwvVOTo7AEB7pikIppXlISh4PDIrz2kJThGBw+b3FvGa31xKeK17Vx9ffj6PFIMSLqYhupSPOxTqpnw++//Ef/XP81w8d7hdkxZqUJAWjrjzFxLpgCebH5eEd6qkut9aNFFC5iCd5fCZjXSG0kumtRFqbhxhUPvY2uURlWRfqNLXEhRoNNMkaW8hbAGO7lPJ8J29l1MViSfWqIXbLVz3kb7pQlmizWFWHiKnyAVENwxCTmufrgsldSNh5wIRNvkx0hiuIBrQzNtKFBE1mIrE1g8zXD3B5S0QrTaaK/BUHLiC6y+iQ2oF70/YKEch4lReUiBvCrYxOTPnJyCROkdeGpppA6FtUkpJXNp4nnOdEhThP4IkvJYS2RMTKwx+Wk6xwcjmefcx+DMaXs/7oEi9hzsksy+HtfB5ggb/jybZI9YMHlh6yCWyKmcKZVfwuFwsqguQqQ0TRSqwKcBkrs9Awqy3U0YmFKVh+uKXvgE7aLoFWAGSwJTQZD18cdNfROY+vqSBVMv6lCCgTX4ghyKKghFrrupkWZOtEesXf6AR54S3s4zo6NYN+dg8XWS3PisVbJGECFsnflNx4hkAVG38WGyPxeWFnl6qAHWXkVcciXMjbfJm6ihhUo1EWM4e4qqyUFfue6+7y0FSVP1VhVFv0YJu4ZRTQrEX8LmhSnEfrSdJTKo2L/Yq4JJCF6mVVMaZz4h1xKsa8goS0fdppQwDcqxXLYTcKP4sdHx7k3FbB7bnEmap1zGw1DRdHiVZPqGFUrYfGEWcbHMAusLvD6DCx7TUacGM8KJlSdXAjErR/wRfcY0HoUmmcIxfqRPbCWjBm1QEJobJUdZabxTozVrHOLKOoQDZmsa6mzuJhwwVwkibON9HFBukkSRxQazHULwqtwyNfiKYDLGs7Pa83P/bcv6P4yoCj36Xqp10T3z0WfpyHe3ezdzd7d7N3N3t3s3c3v4u72buXvXvZu5e9e/kDupe9O/lPupP7atZdCFDTo+3q/5ZlRseD+OpdL9lWqIIolmkElh6xHk/sxRez8mav2jVZP9vpTjoSCXwKsFEdMlfSSOQlzrq1nJBxLYah9DEA7vubOsFAD5jDA7XfH2Y2vlWBpxvgDk8siTduwWrz5uNE6+yJ9nyitdUCi7098qXb4LMdj3rvVb4uHdBPu3BMZxaq3PHzq/3azH4cjCeT4UV/NhpfwvXl69Eb5aHtxcDsxgQsw3A6+9i/gke/9C8KzhxuXowGNBJGUP23V/3RG/vyIww2G+KmvMFwMhu9thpfXE/1k/Hl5XAwG08+Tgc/Dt/2S0FCvfZm/Mtwctm/HAw/vpmMr6+s1Qp74SIHPbulgYdbF6PXw8E/B3hgZdafYaOr/nT6bjw5/3g1BhxwJDzPgv9c0z/TsfVoOr6eDPDurP9G/f0ImAzfjCf/pJ/Tn2Gu6fUFTjUZXo0ns/w3DvTLaHxhMDds6A9mo18UDgDHzwq1qrgS+WeUTHthZDFpyvlsHFsHbHCLmvYiRqguwzuQKy/iIA+pk6SReGATRS7750k4U+5za131P7XN4nFrtcOKtAGqiPxsGa54zIbQQ8Xg3Jc8vnwRENcxxKtVUxZmTJpCT3b/0JJQ1u9JK22SpLKNAJTmAs2k+AwGM5a3wuxDz6MJews27T8w0VjB/Gwbxe2lK4TTFwvubCwcAi98fjJT3CYQhAmwMoKOYMPVXrfsNAM8XogAtAJXDiH8Vyda1LLrAU5yQFudwbBvWIReRAZxwsHkArZxuFKZpDrGQFua58LswIBh1ObprVVM1L/MM1GAhQMHIfPVCbXSMmaTvVviBgYge2zmo10acYJ/8VQdbcDe4A7dFFAG0FdyEWXH8UzmG0Yll7ANTmGHBW3ljen4CSg+7Qsk78jWabQOY3UCDqN2SfPEKQTxamK9xdc6RVO5lR71JPO5V5YPyjZfqMMZef95COjzoGpBPUvzzNq57o1ogwQU4DEy4/HUT/QWuPvsRJuSq+fPiXHCXNhnp7ItHWarT7wLGBXHTKtWcUv2vTAPLTbLRaqtvTpdlO3iq20vARcjAAiXKZOdZInQs6hh9jVFxoLhrmYuA9QGNaOK5NSJDnyspmO/wl0d7VvjbJNsmxQlEoJNktwfvBwNFOs1wgfX1bCSrYN5fgdo1Uzcn+Lu7sqQsAgkHbJRt+ZmdiD3OqbAjwbbBmrH7XIG69kTQeD43SVFXW/7l/03dLUVXm3FIOcKZL3dAw92AElTTlva6GCwSTeZ3k0v0Uyj8Gbs4D5h2mSUY8f69LHeCxLTmfGDA4Lt4OCMjfMtrIWKB6qraqrBx8Zv6aRyVPa6YNs/laipupbxxTH67A0SL0APwd4gSupsjKp7qDoHoJd7T3128uDA0H3kHhwo+1tw91vEzcQGu7ygEJPt8M+KfWa4uqrgUcZDQm6LBEJfEUfngHaPnZPeabvX4Mc9r9Ht8U5jLpx5ow1R20mbi+Nj57i4Da8g/K/DiHZ13xfCBWOXIZ9PNlkTNNi3oTohsYO11EqHD7aLn2ac3Qxo809sQfV+7z+LCd0V3H+rDS1Lx96c7s3pn9mcojxvGVNzSHiHilR2+v4JsmSngc+pyGBmoGoyDzZ1e0kCKGEid3VCWp1Hykhxs9uB5Xqt03Pmx07ruNF2+WmjeyR443Quuo35Ubvzyut0T70Or30o1/mpYGAOzJSK/DV15q9bdapv4Essvg9p83yDTUSSRkFe1jTuZB669PYWGQBv5Ncd9StaGFeAYwA77e6w4vAasvwGJGi0y1Xt93ego3W0ehVGeNQKhzQSXVFuB0o024XDAwONDIpZxB1U8Wo9KtU6Ajo8Zbrg2SbzJoSKacWJ4PPjVq/T9Y67nHdOu+2TV/Oex4+OWr1XPSr8gO2Pwe487QDeYNoPekqbveVvQBDI2mPt62ny3a08jbED/XGpTrXN0NTwskR8TvClPT8Mrlj3hPk8WKR0ny9KRAga19OqkpoaeBzJhXx02fp8+LpvKoy6rIljVVUM9dnrkKw4nfzNEcDTg6qAgCWKAz3qASDEg9huKNWveAOeZsW044YeevaKHvbQ+UFwKzJDYrFvZVM065BxZ0eY5jzOd1cfYEa8ThoXmpIHbCm4K6Lv7EK/WnzLXkPBXevtRl6KRU4qhYZpgjUE6ZRqnjkpt7ZYa/NxYTMFlQMg3+ENLU6CfpzQtLUwkxYNYn42XlGuXJTMiUYkxfdqOYAFFbucMMKSGJsDbjKJmTZH5E/B8ASmXWaxCuchEJq3CpjzJKRnDp4Cf1rvrnwwPw1CLXtwK7Ty0QYEEyfmtSFjkXTxkTrrVhm7jOJn3n6vu3vd3evuLrpbfjjR7zLQTyn0aW+HPteBfpEcOs+t0CcSqvZu3jb3m8qgFCNpJ4AOkX56N9OvqqOXTaxpD8DvFx8pV74FfD/jRykJNK4/5wUCSHTUtQCwRMI9I7hziIlQilRH27O9xnPgIKBBRYiY4nrPJkwp+YrSgJJ8DkGyG4o4+CZRCwu6jkwWkIrbbmONb+7aR5L7SHLvjfbe6K/jjfaR5F5397r759TdRyPJ4jsmdZwUp6sVjzZK0syrxujcNTQwhWuRL1xnL/6yoxUcjGUxVq0YOdTmnfa87Z04ouvyrnt81PM6znGHvzppn7Tn3c5Jzfb1N7keZ0pW1CmL34qPRGJ6fXDE0gCEK07C0C2W/4C8kfDQrNFePRM3A82b6gVuKnbs9LZjx1kYYjF9YyKkuBBDBjmN0KZB2xW2NfsN1Atg1El/MFUyVIVquRIwCm4RMW8jxp0f+LLPJNo0+h6uPClFMUKWzaJfAq3eBIc7VqiIyyVuzPQw5oMRKIJdgHX+HaNTzaKviuTZBDG+QIzZ8LMjBCp6Frm/qqrvjvDluGgjporBDxR6VbbDAxCAbBdRFnfu4/N9fL738Xsf/9fw8fv4fK+7e939c+ruM+JzHQ09HJ9Dg53jc2jbbLEslnpNe3f+v8N0UhUNAYk3Cx1646Gbx+C0DwJu4rZ5nAQ34w+UKPdTfDHsTU26wRlulG+kAQRuzifhnqmPnKAlMs9KTz7gZwBWAmQ0+8pOzXpxPe7pPvwi3fsaTo9xpkIxjXx4br5Z8QU4Dxy/b/K1bJbeTHx4e1Rhx3DDgdJZsIRuqvZ64wde1CTqNcwR7YZX9pMmUNzT+6tqMXCRKs2Pjm/OK2zCFCwmDVPHkwBaPOk2gLmG3OSbWL+tTX09oYQj4HYd+fdP4fPL0WN4qEEewKOKfI/OBe0ZQFlCD8H/kEuLte9sS2Zyx4SJX2drsjE267AfBI9w/x+thXz707vZd/psQn6WQL/tjbMrEBEyjX2zLvBJHUpLllGYLtQZ335h5QVVkXk+IMzeB1Mh2I19tGcCRp5Iip0E2RXslX8xxcXDa+hOmzklUfBA5A+BQoe80O87cp2UY1hnB5rvgwY7p6MYEkMAbKNRVC9EvFkbvLiF10uB+C8zWkON1qDR4u9KUOjvVDlqJ48D9gCH4H5M1Hrx5Gq8hjVeg17k18BRyzAgJTQcxfUyx3DtxXAUxmvgeEU43gfv1PnrQjemrJU5UzJizjIMY/HfjKHooBrcLFLQoheDRfu+GqQRjU7LAqmhpmzIBkSZBN8FKEaghInP0cvrl9B74FmVSv6LOAs6/y861fOvAs50+wacMbZ0Qyd+Mcw4YQMnbCgbEGv4la9DwQLdRhzUHmASgEHOf7IEGlDL5qmxKq06DX9IfdA1OAAqjRKvz9SPs9zA6StGD7B11oY+0FLLVxDxiwx6LHR4BWKZ8kKZgtvw+iH42RLdFLxZeQt97x8NX8S4n1dh8HWSv7eVfsCS/HHs7n/I4u0tzV/R0uiwGauZk/yTcMNs3+6DH2mx1Sv/LNHWp6s+4Ifv9ClQnbvYCqQiwe16Y2xOTMJTsgIU+0NmlX9/wx4GgEtQX8heOEspqFKxFpyOA9ZRZsMV6TiE0mhYzAcOF3TYMwJicF9vqm6yd5AKBg6wD9NA3NsBo/4a6nxwChykr66xcyMUDM9ZpAHujwcg0hXjIHpPSI4rYydVBg6ywkAYzOiNCSzrZbQdRRJJQWdX8O22Y0+//tgSkCfmAvmIdT0bCEnHbNT30HJEJsLPvkdWDO2fGhuksrEU/pqOAQNYkFZaM7wdzbZGhMEC9S4a+oif7hQfYlsYBNMoJQxHTUg/6a06YZxASmaNqz4jyK0zBPqrEqWvV2Q1/P2HT/cfPt1/+PTf8OFTHX1h2ny4xtIxKmyq0njlMm5qND+0PZMuHtJYgjrj7S9fsKiIdYN7vA3SiBWrmw95WYD8EFgafaC86qMnto5/a867fcce/rRqJcCmIh5sLJ9W0y9lw9de0Ke6VJGTgFIP9KpaQ78vw3R87EuqWDxRnVUN9ZFutUL5iT4DAq3n+sutK1Wji/gd3MS/Z7X38D/4ESoGYiO6/6VmKt7QRg1sEoiq+FlfACOg2f8BA3FJQw== +sidebar_class_name: "patch api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Body

arrayrequired
  • Array [
    • value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    oneOf
    + +string + +
    + +integer + +
  • Array [
    • anyOf
    + +string + +
    + +integer + +
  • ]
  • ]
+ +Responds with the Role as updated. + +
Schema
    owner objectrequired
    + +The owner of this object. + +
    accessProfiles object[]nullable
  • Array [
  • ]
    • entitlements object[]
  • Array [
  • ]
    • membership objectnullable
    + +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 objectnullable
    + +Defines STANDARD type Role membership + +
    key objectnullable
    + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
    children object[]nullable
    + +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. + +
  • Array [
    • key objectnullable
    + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
    children object[]nullable
    + +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. + +
  • Array [
    • key objectnullable
    + +Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria + +
  • ]
  • ]
    • identities object[]nullable
    + +Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST. + +
  • Array [
  • ]
    • legacyMembershipInfo objectnullable
    + +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 objectnullable
    + +Access request configuration for this object + +
    approvalSchemes object[]
    + +List describing the steps in approving the request + +
  • Array [
  • ]
    • revocationRequestConfig objectnullable
    + +Revocation request configuration for this object. + +
    approvalSchemes object[]
    + +List describing the steps in approving the revocation request + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/patch-segment.api.mdx b/docs/api/v3/patch-segment.api.mdx new file mode 100644 index 000000000..0e26f6a72 --- /dev/null +++ b/docs/api/v3/patch-segment.api.mdx @@ -0,0 +1,121 @@ +--- +id: patch-segment +sidebar_label: Update Segment +hide_title: true +hide_table_of_contents: true +api: eJztXOtX2zgW/1d0vB/asjiEEKDkw+5Jgc4whwLLY3p2KWdHseVEU1vyWDY0w8n/vvdeya8kPNrp7sx001Ka2NLV1X3+riz53tOpyHgutToKvYGX8jyYXIhxIlTurXtGBEUm86k3uL73rozI9rXKxad8WOQTuObJUA2MbT1IuOJj4d3Mbta9nI8N3neUjAfXQmGCTKY4FAwExFg+kYYNz45YrlmRhjwXzBFjkRRxaNhoygoj1RiaCnb9w8XpCTtDDm9eTvI8NYONjVzr2HSkyKOOzsYbkzyJN7Io2Nnr9l4xk3MV8izsfFB/W1s70bkYrK2x/QlXY2FwVF4NmPApy/lH4EAnwJnEX5qlmU75GBnDxnHMZAiNZS6FAZpDuPpRKHYn8wk7Pf/u38ODd0cnTGc0KQ4y0ig8BrPMxC+FzESIdAIkVM69A1JOecYTkYvMkJylsoqYwC0FN+CbDFEZwUQk3Bvce/k0xasmz0A23mzdK8l7gzwrxLysLye1YI8OkIVEhzKa4tjiE0/SGKmJaOt1tNff6u+Kvf72Tm+0PRq97vf6fHtna283fO2hYnEgYfI3OpwiI4+PO2SxNDnTUTW603Jlc4bxINBZSCrWv13LHxTONdJxrO+QpjMjnglGls1HsRh8UGsM5Yr/NxjGr/pOiQw/3EojRzIG7e2DCkUmOV7lQS5voR/ILUBHAB8BIfA0jWVA89n42Wjl01B/xY94e0FtPMv4FEgA3cQ0ruvRzyLIvdms0grdvRA5+7Fih5X84K22uLEhSrDmnQVl43XvlseFIPvSKTTORBrzQJD1oS97G4tTrnvdA0dpJoyRdk5WgTpDJZ8coDgmMg4zodwA1d3Df1wNjy+gAc/BWEdFjhONtZVWk76TwcXl+dHJd/UN7wwI81DE6QT4AdE8TT0U4E+5C2BP0v/+HKjezOy/GbmSScEwrex73e6inI9UiOrGCALSPhte7n9fWzQzRRAIEYpwnYFZguPnRaZsU+cFLwxT4g7uoEThO/XrPG5TSw3JGQyoMMPxMSrhXQgWCzHikZAA7BwdtENBN9rcjHq87+8Ge32/P4q2fN4bhf5uv7f9uhuJrVEoMOzY6PR5Y40woIMlkQu2h3WN/E/TX5F6kAmQ8tLJRDpLeI7KhhY+Ruulo1IYv5tAiG6IH8OxI90evtftdf3uJvxcdrsD+ul06c+/kB2KmfK/w09J+7MYatH/PCVouszjZvxrj32J+anksDJVw5xuKFAuM0VVxDFG2YczEXXFpEAp0HbsLBixpbs4K6GKBJHF0cHhyeXR5T8XkcUp0cd+HUazoCTAkgJS0UgwAcka7sciyhkyi+naYOTU7EVJ9AUDR5YqLfJ1prH5nQS4wlm/22VveMjObRZkIsug950EKiCfIs7bMqx4BIE9xymPLLgAwBC27SDY23zd5f2diEMoFP3u5k406ovu5uug14Xk/HxX/L4AlOaD8YeoIxZKA1lgSq5oNeLU02FHFhKBwFqS0onMwXFAOCCOs9OLS7xIIRC6YJ4HicncCjvBNEg0AURmaEcUdFsDgS02mfhN4jZFmurMJlAQI10jYzgXkYDxA1HBUWixJN1h3I3j04iS2OMxtp0OH29bJ6yn1HPqWgKCyUhGjWFq07cZ1+W+m6YE3LVZKyE+NegJKr8csO7XpNtI2G3/ni1m2AcjwfP8e0nQhBZoMxVr1oxaDLq0voSdRwg/RnAIBgw4vGlKP1KjWRPrLEC6x6PfsUPDtVbNwzBwZUX/d1ZUjfJkEoV6JuBKacpoXE0TDVcAVWFoLgm77Efhksd3fGqwMZJuhU28MGvUHGAbN02GD2vjac1jMXwiOJ9T7A0aERVNjWmOoJgTXC2RJrDrbkKCKUE24CXK2PMQzuaUeOqqMsg/yn4qWxk24fBNaSaiyIGMUEQcEoc3iHhsRGPSxG5jfuUaiC0K+svqgP1YIi+HlJV8yFKI9DE32vzmSmWYUUhLAFKBgcjwKwL9UORcxvs6fIapvgXQ7Y8zLpFDm0gD6IgrHLeS6m+yIUuyTNHUrp1kQRKdzVZW3neTQeFlPPgItI6eAXaulIT+rOwCmKeOV4vDil3BRzvdvV4/2ulz3nvd39zdHu1FfGuru7e9RxAoATPl42ZgqOJye+jvBIACGTAMSLH8VWCVxkH2xAAN/vywTDSeGSps22qajl+GC2pQLLI3+2esv8tirsYFXefjOSEo/+piWfS0hE8zOZZL40kZ8w8O3w6vji/hyjkE+cML+IS0FiD0sPI/TUh9ou+IYzeBO46lQQzigIqFrTmqazAh7ipd11C6uncKgSlhzveghxt9SY8maRZlOmm5UmBXH9lL2RGddQhnFcoccQMdtC2s1oZQgqe5f+wkucYmgHhF9qrDhmEoXelD4dqUKJeHoYW1SCAqwJUFrevpAsCvzmUwV6vWopwP1mUEOW4qBZ0DOH/aToZBXgBzNM2mF1bW4lgs42PoJDdfvdVCI5FOVY7BEZcepyBGCJ0BRCaYm4Qw6cIRo4oPCoSyXRWxWvkAuXlnmTnINd0LeGGe4XdnMYQfn6ZW3bgVzvmMW2+FaETakFWFShHJrQ5SZ9eqUlfp+LbSW/nuyndXvvtM352/ee5WP91dgj6bi9DnSrmnG5g8F6BPRtYDuKtsZFdGrSLXccXAQaQf3l+6RyjQHqoUfJTwFfGRTeULzA8rfdjro/IBU5n6a10ggyRHO4MIIpEIB8R3zTEJyopqa3G0tzobSTBQtQQiQtTM2FQX9IAiK5RCTrhZZ6EWRr3ILYDl4BHG2AiIo6rQT7VU+QpJrpDkKhutstG3k41WSHLluyvf/XP67qNIsr2jweEkUyQJz6bW0tx9WqJl0ICVz+FZ5XLVomwTrSAxVmEsr40cvFFvc7QZ7QaiH/J+uLO1F/WCnR7f3t3c3Rz1e7teM9df135cOVnbpxr6tnp0j1WzW8BxhQLjMrnWYXv5r8DnpxGGNdpEVOJmkDmI9KbGjv1F7Hiic5gbEAbsmD2wvHh1foz0YWi7oQnkpossEPS0jkQHzXlOkBJtGCQtTb6CjivouEo/q/TzzaSfFXRc+e7Kd/+cvvtZ0LH/FHTsfwZ07DOEWBFCrN8TOoaAOxCaRaAUmEO5Xaq9Q7Ry+5xnY5FXQK+FInt7iyjyUmv2jqtpCZZMayVS1eLC8AZtE2yblW1pp9cYQqRiELUkoFu0KtzICJgUN3PHMpHkxzghoJtN/WGUw6ysz5T2Vo0iVRAXwCEFhVjbnd93XOJehgjhH1CgddAxBOqvuMbptPWb1oPZOc74GGfMDj/Zfb6sWv/dXr5bGGSB4eLC6vqB7QJ2zZwrKCPEp9SGrwqCrqD6Cqqv0v0q3X8b6X4F1Ve+u/LdP6fvfgZUd2joYagODZ4N1bfx6AursNRb2sT5v0bs5CqOAzJvpgPC6mGNwQlXgClVh2m9+oRduS91416GMw9P1yIitMwUWQxNyvOO96Aj0M2sw1PZcWdOp0rfdQKdbNxuLYk4uMHUehfErLAIqGLAY6h2kA5JNpNovDbS0QBWzm5LrGdA3rSz4FH65WGRKVQfzJJZx+3VzpDoMrCZQhXxojzlNaOTe3NzhLldZfHsqfn8uPXYPCyRB+axTHyPjgXtGXA5Nz1k/6Y+DH2BcNuOvnAkuk4huNDfWxjsFJv12BvBM9zSTHtfXv7w/vIVGyPIJCe3J57dOSXOzsBEKIgNy30g2InySqaLsT1hM2zttEGnYVEME2Yf1IUQ7Lo8WnQC0f0cwjGJFDsJigDYqz5tG4pbEWPi69SSRMOTodoACW3wVr9XlOSoGpDKHoTD02QflM8OJMYeOueLbdwUqbhj12k5L96Y15cy8ZeSmm+p+UTNvJrjwor2OrA7twPwXCTBY0PS+uLBLT2/QQ9LJ7iCVOd5QEk4Ptr7o4JSa1/MR4uej/TafHxQ7ycSMmi7G7MBixlIgHHIjlgw0dqIvzOGpoNucD0uwIu+mK07HNQnj/B73QZLvh3Slz7gQeLvGBxDWWPiI8zHBEe0XRkhl/yJNAs+/xOdr/2pNWe6fA1pE1uGOjBfzDMO6OOAvo0BxvFvsxIaFvg2zoHigDWA/Vr/FAkco42YZ2ktjepEfoP6YGoIgFWiYtKB/TKoA5z7xOgGtq7aQAhGOF3tGMNXDThamJpawioXAuYluMhvrCEjzsnN8ls9zsQs+UebL854WK+XnKp4+rWj9AOR5I8Td3+niLeKNN9ipHEAF9cdz+sXgRxWB8fuESahMRJTrk5ouoDFcotre/QyGAG/4S75MeFsqGLsu1UQ4TTJpDHP0eLJ44OJFLQqkAqeIy5cR6vTCXkpgGEMDXiMDAmN6dx/BtPhUMfR8bUOew9llwpAAVhy4W5coPqzdrXXBejgDFXIDkq1ArxKkkLhQW1gokgYB+N5QvehNEFhQxRUYEqUM6PjzqzqVforGhWKokPFR5aY0wiXj6Eybaj4ibFAw8atHYMgUSPuZTL1RM5FbF/DAu3a4Pwp2mBX/kTEKRZ9EF8BaonGCO+OLhcoAjHlHljgK1xcJ7OBbfHEJUzeGsNWB0o9vJRqk0OF2qB7ZV8fU7+faO4VCNU6+er1Qo3XC7lch0XKRopLaijcwhZNtjS9Ll+9gYYwkCGeB56A9PHO/T2ut2ChNsPL4PVYzF/f1HUY1a9gGPg5rE5WPqial+eO2VfMPgJb/mKipVyXy4VqWq8UePDxo8AFBmCcTpzaFSBiy95wjxz8yynBh7LjYy/uwXrVdrYLTI90oxcjVUU/vQwBWo/cK5ISu4CR8Tu4iL8H3gf4C1/sSzgo9NL1e69cDoQ2lnCJ2ZZBFveBjuvO/gMtVF/V +sidebar_class_name: "patch api-method" +info_path: docs/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 Segment' (patch-segment)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Update Segment

+ + + + + +Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +>**Note:** Changes to a segment may take some time to propagate to all identities. +A token with ORG_ADMIN or API authority is required to call this API. + +## Request + +

Path Parameters

Body

arrayrequired
+ +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 + + +
  • Array [
    • + +object + +
  • ]
+ +Indicates the PATCH operation succeeded, and returns the segment's new representation. + +
Schema
    owner objectnullable
    + +The owner of this object. + +
    visibilityCriteria object
    expression object
    value objectnullable
    children object[]nullable
    + +List of expressions + +
  • Array [
    • value objectnullable
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/patch-service-desk-integration.api.mdx b/docs/api/v3/patch-service-desk-integration.api.mdx new file mode 100644 index 000000000..26ffc6bef --- /dev/null +++ b/docs/api/v3/patch-service-desk-integration.api.mdx @@ -0,0 +1,156 @@ +--- +id: patch-service-desk-integration +sidebar_label: Service Desk Integration Update PATCH +hide_title: true +hide_table_of_contents: true +api: eJztPGlz4zayfwXL92HseZas07K0k6Q0tmfjlGfs9ZGpXctVA5GghAxF6hGkbcXl//66GwAPXT4yld1MKZXyiCTQ6LsbjePBiaYi5omMwmPP6TlTnrjjCxHfSlccCvX1OEzESH93dpyEj5TTu3ZMA4YtWLHJzY7jCeXGckqPPedq6vFEMB4ycS9VIsMRWw6dDWfs+JDdyWTMODvrXx78zGLxf6lQSRVGnvKYT0QiYhz/wQnhAaBLDz7JUOM9duYHB3iRz5KxYCWEZWHUJGIpoQidcTgZC2BDEqdix1HJLMBRlJxMA2wg7qdB5MErnwcKG7hjMeFO78FJZlNqmcRAIbXk1KfncOTr4+ONBg/UvI+8GXaZH62Mep8FwC5E/+Lw+KPBkWWyUoy7bhR7yE8gAUm8/uXi9BM7Q/ndbI2TZKp6u7tJFAWqKkXiV6N4tDtOJsFu7Lt73Vpjm6mEhx6PveogHISnYTBjX2IxDbgrvpRGigWOJqaJ8FBKyVgqJkJvGgEjqW+ftWpN9iGKh9LzRMiO4jiKgc2edAFrBT14wmZRyniSiAnBAaS1jHk+lG4HwMMoYTwIojuBuAE73QhEFibINj6dBggW2u/+pqKwQhr7v/gTPy+IJBr+JtxkQTX6DNlF3GJe5KYTAM+4Yp7wZajpvD7/cMCQU6zCXsrbKmOvZSgqe4ytEykUEpL3xKcyGac5VODoEOAiewSahaGfxzGfoZUA59XL+JIB/4aMKZnZNdBGtg22e7NI9jLDKmN7ORZF9SEOwKMfxRPigQjTCQ7DPY8GnkS32tBJKPDLvHCjKfIIdDVBRHLrtS0fDZZPYtRn+oNhDEpUxODIprFQoGJkr4B0wuORSBjCRLTRPQaCdNCI0fdBOlY9CkSWfMtucWxA8ZYHqSDeheLUJ0e52jF9Enes2B/Il0lQaPy4k3UnjyniYv9mrZb3sN8LXTL9sm2yFxkIMOYEhhqmiZa4cerTsQzkFHxmAZrVYgtMPz8uhBtUCOKC4WOqgIegDmUm7jCrg/RtgPoxcEAKHvw2IofnguGtYxzgmeH1C7ghsobMdoiOQu/rQcjYA/5hMFg0HTi94qA79guqhv62G92FIj4XfuEr0YifDSR8Jz3dvuF26/u1/b2OV2sPG41OrQ6/ut1GnTfgRcvLwGAn5K/udnx49Ony+PJfpc8oEv25H45EEDUY2oiIB45u84j/wJ8bJPMRLUtNgV9ano1abdFjLY/+h2gEyoQ5b73HL7t5iBNlVV/h2FZlAG8UU1PhSt8MUZ3zUKSUZWDGt+4U1XfBfUFq8qSzuAolpARMeugZfAmOwqrqKmxLirjX6LbavNXdE36rVavvd4d1v9YUzb1Gs1Wvu/voErRNrRDCMmZghypDO8JfbJJCFoKGRKhW87iyxKOsygrZJ0QCkHFjQeJdwhh02RzE7aACVBK5wHRt2yaZhPwBWqzP7O5An+yARSwbtUarUqtX6p3L+n6v1e412tVut/VvRHASeSiHPxHDgAN/s2EX8WxU6vuLeJaGfYFwCw3Xi7LPbkU8YyHCWamLjxbCczFg2Fz1MGWsWLCfojvMcMtvBuES7CAD4WmQ5PBN12U6aD8BitZ7vsRZnGIf4Je2zGS2mJRZwtcbuIVzeHlKtFcLOYn1t+WEI3sLmD/HhcxjCnOoalmNKBrw1p7PuScE+Ik9f9gS4C7cRm2v2S06iecN5UkFwWqmPUWZ+el0GsVJKSJSL3DvEKzRAwQpho8XiuMiSmNQJ9P5tcIoQ1kqk4OTq4vLo/OySOzLZ0pkbpjl8thvdXjHd13Pg+jMeXu/u+d3/Za/5z9fHnMDrRbLZcxliJnnr/2SaDSAA91/XkSLVn2QUfRkmGJbJqGhBDYXOiZeCad5BIIYcvfrHUxAmRtNIN+RQ0j8ktn2etd0P/v991m32yV+QFrt6pCiJ9FhGgR8iO3wGT06D/lIeJrUJRMow8TjQ/VCokADb6WC14DfQRT6clS1Y50LRVCBYLXDID/IqR4LmPs9j/RVE7csO19Cfsala6tnzbZX79b5/l6t3vYa+602ZIC80Wwg+xpue6/QpN3Zy5t09xtNB9Vhkc5FJmLce7PY8A0zZjqzKRbVAkBl6XNq2Eo5OuR/GYAi01WBI5l3KFs/pCYQrBQPPhL/l2juRTb63VgAArGecpfRgBcWEy3IkohtLUqrCTgupmUMz3E00dOLeATT/mOfkSxYaOF4RX3Qk39T28hJG8KUWfCQck/uYekgLwuZqGdqTpmIywpeHGORAfAWFC9EdIG8DPOnFB6LNQHoF5D1ETxLhBUNyAWtMD0mfTbPfeQjobpOlV/o+BHRp5F8ZViwcQBrbSofT5nxvHXj2bhxcXp1fnBUDhvm3TOjhi5Vvnj8+bCyzNyHYO78+WHl5xRUqoJqiI5UzwL+EGo/n7O+m4CWsEOYVLlJFM/KYSifEWp56ziU+7IMY8NSzVFLcptIdttdIhl+iWGtXYf/HEux83HGjCbViyWK54NrwH/LwDU0qkB0eBzKRPJA/i7iC+LmMjcJtgH/c3Amxh6p+MOwPzAyA8B0r2Wurxzg5jVeC2ndyOdpIHSdlZyQKjs5GYJSpC4J0x1zmPKr9cH43U/3kwDnCgjhhzf1au0NA7oiLEz/8Obq8kNl/81PPw4G8WAQvvvb4enB5b/OjjQSZ1fvT44P2GAwcBSXgS5+eomHL5a/tXCoO8riB3x7pJEhoNQXsaUv7wVoqzgrEFiAwti7w5xHP+q2rNhYo3k3lu7YMgOTLOS+ohmeCPVvkiHN4WbVd7tFqNlQWl9+fPe364PD/mX/Wn+QE0yXWU6oFnP17d/Xfy9ieQa6U+27bpSGybmOUX+sdzUrXb0Yji2HvA6Plw43j6f+iw5qi5VJosWSwmOPLK46Ekm5ndraZtvswUoNotvWXFfsczrd2q7CIwS5LbaIFWGb4VY91BrDSpDZPFhFYJ+G9pG0jG3/3UJ6/KbIHoV/Aq6PRXExdnPz47tdYx8DUy4NoyJ0K51Fv/bJBCdwn1ktTns3SPRCSsRyk8VUR/FbtGzosmQApjWNssRQgFMjNdEpm6La/DiO0tFYZ4+FwLc0kXsqcZsuInB0P5WmtrJA6mckyKA/FaFXyklp/Qip9HY0cnq1RtMMOcoQaAGax8Bl/c70pJigk1H0YgEG6aH2hJI+QoqspCewUi4QOfgXPR/ktkEUYranFyqUDmE4l5HBPEvyxYOshAavmo1iIOkUE4KzxSnH487cWsGzS155tyr7FcKrp1MVJCzBeXGCrAPE3HyxhZZ7cTFmnpIsCnPPk/iNB2eF+Ds3B3uwwRlyebM0s+N8FfkT0jxciFEYdV6SI6+KXK/Nh1dGwmUFk/Ork7m0l948M+ldOdR80aTW2hfDptduu23e6rT3h16t47nucL/TadXdzv7zs1sCv7pUsgyjvowTcoskmaKiLiYY2MRUUmjNf0mOW171MOsmrWVLJQeBRK+jV9Mr7FwkaRzqWVfRhoeRN2PkkG5Rv6svWT1ZP7P2sGwRHNCWh6cY+wH8TWUU6zKHIJQhDTSTaPJWE+SsBmm3ZVC7sgSAE9U6e889Zr3ygSEGGR9z9yvAOn7+4ortwmS+ELhkWNERfLhX6zZa/l6Lc5g61TvtYdfnzWat2+5SmXQilIIpbrEYY2e25aH/AeEjli74SJcSeg9kxYH3hAANvm5BviwDgvEM/mMNRrfNyDT4wrTsPtmBFPX9wRlrdRh46lFK7/lojglh5epiYZIBlGvAp7EcyXDpdhfjDg6PPvSvTi7hzfnRP6+OLuAXwlpYpu2HdndIZALTHWFsCMCFESUCWgGvsrcG6lsgCMNxoaE0UX2mgJnMRFzoYUZf0qMIOi/dWFMiu7lP2JasiuoOhEJcnKG9EEOOtSHaoyLY2z7t3qicGE6+ZWOYLot4u8r6WWTQ69AK+lPRBEIGmq4G4KdgyoI2O0VpgvtdwDmUZZGzcn7KZ33KSVEoaByA+TM2KLgJJIOkEyUrzLTFoGh373iGc3Ml5QLTiKUziJYwb4SWwQzYGONEn0qfMlHMuCMUlwLHE9p2mccqOlVydx81MtpBgj/jqXqG3UEaKsMKkZZ9uBXG+FRWY/RIGlZMxiOZXVTU2bTKxGUNn/lSBN7Gdje2u7HdZ9ru/Mdzs0GkmPrUF1Ofq5CnwN+YgudC6hMLvUuQ2UY6p9eC3GG491Bz55fPl2DYXwVV980E5hvmRzqULyDfz+Sh3w/tri8b+nNZIIK3+azEB08kvB7hnWNMjNKsai6Olm+7XEwRwWvGeuMlsCxOQ8pnudphXiRU+CZhY36r9yIqpT2g3olYybYibjLJTSa5iUabaPR9RKNNJrmx3Y3t/jVtd20mmWFF1mLyJJVOJjyeaU0z32m1gI6r2K3KLDO5bPt8MVtxSkdbnHLm4Awb9WHd77ii5fGWt9fs+g13r8HbnXqnPmw1Ok4x1l/ndpwZWdmmCvLWciQW43o75HFpCMqlkijyyuU/2l/ko1ujlUibNwPPq7oOaXLH1pL1kygB2gAw5I7xivLi1fmJXq82C52x2WmCabZmnV5xwZSSTu7QQa9N6rhJHTfhZxN+vpvws0kdN7a7sd2/pu2+KHVsPZU6tl6QOrYYplg+plj/ydTRkx6lZj4IBWhwU2BvmOTHUk310Zi9OZxqE71SFtnoLtldGEXsIw9nNllSpUpkmLML3VtE26Jnhb0rIWA0AhcZ4tFdCdktahUenoKcFA9TBXIiyY6RIIAbzyp9Hw8iaJux+paNIkM3SAFDcgq4TQXHveMysVtbAALVQUfgqL9hjdNI6w/Vg9k5UnyCFLOje1cItPms/ttetksA9xPE6C4utKxXbBfQNXMewjRC3E+1+8pS0E2qvknVN+F+E+6/j3C/SdU3trux3b+m7b4gVTfZ0OpUHRo8O1WHttUay3KpD7R1+8/O2Pv66CNhQOrNIpdydS/PwYEJSsBLiduKYZArSPEPtCr3U7yh5tqRXtgzZ7QqeEarwr2JDHv6pCB6o/nvhR3TttUN7l6dCNDZ7FYwx96B4+yu6q12H6T36CCKmItqNqRxAH3s5UAPoB2gFY9VPpVVe2o9jO6qbjTZvW0u8XX66BLqKXhLz5xO6p8dm8lNlWQaS9rkTzZBA2gJ2xsDstMka+Hbs24zmPcwDWYHtzwbFabXdF43nNmbMsw1NXM0Am1XcfD4FD2/NtfRoYGsoGMZ+9aOBe0ZYDlHnqO3KVuNusBEX4++oFd58MIlhsbCYKfYrMHeCx7jAVvadbP1y+fLbTbC9JbcS6owsxYS5yN4yxuoCLnPvt2Bgp0ootmDFoL1S3t80FyZHwDBbBBeCMGujw0TPkFcOYdAQCzFToJ8D/bKr6byxK0IMORWc06i4oFJ7AKHdnmp3zaFV5qHyFAfXsADAXhXhT7KiCpPbQyJNK1k11NLFy/Q9Vok/sdCq2hoFYKmtuew0Ky9dvWecRd8BoLggSJuvXpwDa9SgIeTNniDUOdxQE4YPMo7s1wrtVfjUYJXQXhlPAbhZzqoV+7GtAdjCkJv4LFj5o6jSImfGEPVQTO4HqVgRa9Gi04HVsgiKo1aAaWKHrIiK5CJEn4nYBihViY+xEyAEqFI12TIJL+QZMHmv9Ahmy8lmun1NQRsbOlFrno1zjhgBQesaB+gDP46HqJigW0jDeQHtAIc5PInT2AQLfg8DWupVyfwu9QHQ4MLqOrTqtOefujlDs78YvQBW2dtwAVjIp/tVaMz+BoWBsUSs2wJYp6Di/gGEcTiOb5pfLOFVIzP/230IsX9vFKDFwZ8ay+9wpP89/jd/5DH23ia79HTmNQaK57n+T2tR9/9tX14fa4fEafNtKto1zpBXSyVKrrZDP7CV3JONG2BSaG+vxfTtiIYvBQCzZjcmDuWgoosU8HpXN0OmlI0IdcDGT76O7ypBQGN6P42vA+Bw7SYrsipss+CrhhIY5zB4uZmgPpbZKayF6BYdOsmO7S6CjnjZJKGeDkWIJFOGAeLeEKhPancVPtdmNCGwlIWUeaa9bJOCC0FWUFnRUU8Uae+OfFX0NsnxgK1VaYUD4xEiZjrJnJCzkWQ3UdZnnE8BRuMpTIWwRTn0BA0IH8UhRE+Hl8uQARgoVn/wUtcTSe1i23xqlF95QN0aFZh5kwXpEYqgdljAe7KCwHNrdB0A/C8dj3kqxHf7PZoExNxMrM7xaIf4pvqyZWe0147K+e00L8nPTzlOgYKsenDA5aIcIb3iK9hGKw/XN/kEzia+JqT5152BHwlnVvn5sbJbfbCO6uXUmaLnuEsr3c4jj18DLTQrSW6jkWY6g9m4aRyqW+3tB3X3biMc1/dWZfJ1nRzShUFK/qhuQ17osswMb+Dl/i354CzQqSjqZYCNKL3D44takIbDdjmf8vSH/MDpAPN/h/o10/9 +sidebar_class_name: "patch api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Service Desk Integration Update PATCH

+ + + + + +Update an existing ServiceDeskIntegration by ID with a PATCH request. + +## Request + +

Path Parameters

Body

required
+ +A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +Only `replace` operations are accepted by this endpoint. + +A 403 Forbidden Error indicates that you attempted to PATCH a operation that is not allowed. + + +
    operations object[]
    + +Operations to be applied + +
  • Array [
    • value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    oneOf
    + +string + +
    + +integer + +
  • Array [
    • anyOf
    + +string + +
    + +integer + +
  • ]
  • ]
+ +ServiceDeskIntegrationDto as updated + +
Schema
    ownerRef object
    + +Owner's identity. + +
    clusterRef object
    + +Source cluster. + +
    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. + +
  • Array [
  • ]
    • planInitializerScript objectnullable
    + +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"}}>
    attributes objectrequired
    + +Service Desk integration's attributes. Validation constraints enforced by the implementation. + +
    beforeProvisioningRule object
    + +Before Provisioning Rule. + +
\\\\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\": \"RULE\",\n \"id\": \"048eb3d55c5a4758bd07dccb87741c78\",\n \"name\": \"Before Provisioning Airtable Rule\"\n }\n}"} language={"json"}>
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/patch-sod-policy.api.mdx b/docs/api/v3/patch-sod-policy.api.mdx new file mode 100644 index 000000000..922d5c1dd --- /dev/null +++ b/docs/api/v3/patch-sod-policy.api.mdx @@ -0,0 +1,159 @@ +--- +id: patch-sod-policy +sidebar_label: Patch SOD policy by ID +hide_title: true +hide_table_of_contents: true +api: eJztXVl3Gzey/is4PQ+xfNkUd4l6uUNTsqMcWfJQ9OTOSD4J2I0mkTQbTC+SGB/+91tVQG/cJTueSQ4T2yK7gUIBqOWrwqLPViScJJTx3Dq7+2x9jETYV0EsnuJeEk/gmSXd4CxSrj1TvnTmZ49QVlifFp8qlpqJkMdSBZeudWbNeOxMbpX7gcpZFSvm4wgJ3N6cM/MQKrkickI5w2pQqef76jFiycwFQsGY5WWZJ4XvRkzFExGyeMIDdncPzNxblXvLCQWPReGzCi/1N83lPxIRzul7PJ+Je+sTSyIkD7TY3Q+3N9fsA3L76dUkjmfR2fFxrJQfVaWIvaoKx8eTeOofh57T6dYaRyyKeeDy0K3eBwPxWyJDEbFQ+YIpj90M3v3UO39/eQ0vhxMZMRG4MyWDmDnAsQr8OaOBYf2b67dXl/3h5TVU6Pcvbm9/etO7vThnyCEjtqWIquxcsUDFwK8Abov0YmUojUUA4+5ndZjNXIW9ixR7lL7PRon0XQbN9z5cMvHkCBrtKoM5mfGQT0UswoimWwZ64ibwKoAX8E268DlyJmLKrbPPNH7wNIpDaMFaVKxQjwDMeBwmYnk+hzDAl+c4MDjUOJt6QthIIIdT5UqYV7cKbYgnPp35SLzhdOuntdOm3XbrXbvOTzt2rd527cZpq90etXij2ehaKHDYtojiN8qdI2/bWekxX0YxslIQKhI0mLhUciPGHUeFLgmH+nL5QCEQzFMo1kjTCDEPhZ48PvLF2X3wmuFo488Cz/hVPcLcDoSHn0EHRRhwX7MOD0UoAodqOWo6E0FEOoPqCtIY6edhKBwk1nMfpC4L3MX0AfURfz5I5VPnb7CxXhTJcTAVQQyEPDmmKjD9buKDghHNwAMGsKme44go6qMFCCW/D2AWHTQWQYzTwWczKEeUj3+JVGBTj/8HP+LrFZniYcjRTgC1aVR4rka/QB+s1fnEiaF5YTfp/DEewRB6MhAuG83Z3eBtn+GkgE48dxqtomzfgXEjdQHVAMGbhSgxMSgb8gmvVjRjnSJkUoaiNQIJEKGnwqlADRNBMsVmuOtSw1P1IOjDzOcOfjIPHDUjWwpij4zkSpOWXBgud3LUY/qFGRi0KWBYgQyYM5jB1DzGPByLGKV1gmyDFRG+QPEwneCeB7OjhzsudrKk0sfFtoHFB+4ngsYuEDce2Z5lbvPK1+KxqBfYfRn7JTOUVcdejEVYrN+s1fIa6ftClUy+0jLZg4wECHMMTY2SWM+4sY2zifTlzFosCtRSKU6J6e+LFU+HAkGjYMYRDLwLhiIsD2KFpTJI7+5RPu4tmAUXPpsph++5/do6cMBnxtcPoIakDZnu0GtTmXrZzzWdaVVnbziyabw3FDHzeKeVoCCuWgbL855Nu/Xe2P0yd5WNVDbanGNfeHH2haYlb2UKwjW3ZWCnbuZlTYRyPMnasAqya6RAN6OSOG8H9NSUvwKfUxTvi+vh5fDq4j38RFPn5u7upHPa8Lrg7Gr1zmmz69Tata5T56MGCM8C/lSsd8bR/0HDD62gJAOVaAaSpGWgUavhj7LsXgYuGnaAGiisH3rD/vcF4xYlMH7CFW6F5DQUcRIG0RIA+C5iAUhnZm6oanW7A1nrNTJlLdtkHNldFtBgAEI4udLUvHrda/CWfeJ0W3Zr5DVt3hi59kmr0T6teaI5crVl5u4NwDkNNhYpXtqzzTeIP1GhrrXI5s3r4bGf5r+jnTTAdh1ddB0cxslCBGPHkuis2hh8wR4nItDwsQDB4JshvwS/ao0aAC74M6zVzuhPtUb//XtdvzOh/4N43IARn8dkqc1dc3RDH0DRCo9XIWyJHYL6hmcAYgmGBAjKfMkBomFlnFAQksT3EfNljKUAbzfeIXQGaiNd9M7xvLoi87r+zt4ZOufDG4o1qgX0cXlO9ulfZWiRPV1U9tKrZU4hAlgH8Hmr43HuCtECi+eNWqJWP3UatU6za+2tTmlTrozA9M0JRpfbuk1mMxXGJd9Htc5jZZHDW4uqnyElF4ZCGlPkNIp8/N+//p0LzooYFMLU3S3fCh4C6P0NS++Qy79z8mWvpHu2h10bH7He9Tl7XiXviAzVmgjkGWNYrI4RBtV/9V7GcqyfpTSPSt37nj8AAmVTHvAxgdcHCU6FYGvIgRyFPqDGjowouDP4SiKSAoeNg5drKeAoAZ/VXIh1U7QcSz2rd2lVxnXdYic0psKoAPhO8wj4OeWmknYwYtFEJT76VAwHmJ4nTIbEaCkxT1CCi7qrv6gR85LAST3sSs8oItzdHTDQJvciCuZZBNCSgx0IkYGCMbm4fnsz6F+cw6Prm+FP2deSbcmeLtIE0QqSLnOBhUzncpO7itjvrGHvXR2ewI8GNrkcVaahQ+pkMWO0r/v+znhO4OLy/KuAB+PknsdDWumFTJTlYA1T2xMDhICXSGzHZDyjMEj8tQKXis773nXv3cUAntwOe8PLvlXBllZiqHMRc+lHjI9QmVEuM5YjnTqp3geGFrMzf4RDpxXqPtD04eU7UCiw4uit34UqmaE8X5oKpdHNedvqzLnvlwPbg1v/hm59WTQxuMkL/nO7YC90wpMyXgVeRwpsMw9WmNX5poil9pGnVmnCI4jsAdVm1ApGMu1Jmqr0eOIDUva4H6Eo7TfpK02CSdSwYKSdSlhM16X+gt5ZhUatdxfXF4PeVUFk8iebEtVlYUrLk6PcEElvV4uy0Bfj+t3R3n5SlQVdWDzLtZhBAa6hWuLElCYuyVqaR9ABWTGu3+GrrkzCOa1UZRDthAJnCUCLpKCiTkHylD/hl3aNkZ9iUqMBZAXlHspeav9Vhy/8yXxp17ZkS/czIrmzzvMSq7kqXJIwoESTnWPW6nEiAYaSHw5TzMsoaMfMgLLKfj6nv6e9ydcNdJ+e26TJq7Q7p0670XUor+I4vON1a069WW/ub46+T8Bf2Ogf0aKUrNKXsdhzYWZhjkPEEpRHLCCYPXJGnU690xm1RzXoW71z4jQbwmvWeaeTr98sNVH5AqonG6mWrOuS0mNGqZRBO2jzQZsP2vxn1ebCq/5GR78LgOXbAl685KBTvHvHOrqjBfK2pmibBGyWaN2RWcyznTsKlmVubcZ9bfYvQ+XlWdws91nnCMzqhPK2vFY5E1VKPBXTRbtkkt0M2O5iJysZpV2rHUfWpmTSH5ntWU3ufPO0jMnCFNMm6Y4ZY8g+lVIV+4p+MbWwb53dkf9yLF8Ii7+qUGehGiuKdzlCK+UeNoYrOwKT5YCjtLhXXEN8ydreZsv+hSac1gVX4NW3XJhcbFuYXF44/GIzuMqLOPXq3POebwZxcXyDGTTBtI6kJTqnabpEudk69delsNeblv6afLDR9U9rDUFB2ClBUDYEe4xN0QigY96t4rqUmY08G7BFh3QNmq12w6nX3RGYmWZT2C2nWbe7rS63Tzodp9sW8Ner5zNmxGeHR27b9caw3j1rnZw1T9e64qUSC7Oe3Vq3hN0HABfE7CIMwSDbbECL1CCYUtt4s7OMjZRLSRUZgERL9ysuULuUu+wrdw/E+hYCHXscctrWJIhlByoien+Qrt5IB4GIJpm5KSxXTprBSFTrAKhcNjD965vOIDYLufMr0NonBf0xkL8l5HapCgCBLABb06w4EXzUqXUbLa/T4rxx2qqftEddjzebtW67S3nBKYgS+NLd+X8SFukwXzkwI78L9Locxp4YoMatvcMoorHH+OMatS6bddPwy3BnbAVAyZv+B9Y6YT4Pxgk95+OlQQjsj7frksaa8A0Ycbl2bTqN6c4v3vY+XqFxHlz84+PF7XBDUrwXgLTS/gxgFWRhojRGMh145ABXhE97tqrstaH6GjrEzSYNU1Dqb9E8gsFkJlcINUzra2oUSTMvVNOSKjl6GzF7JauiWmEjfDal3XujItJ6jWZlFttXZiRfswlEaiI8qrKe60qzokb+BdP4c9qD5rqoupqAl4AqAzMyniDoA/QFBrY8F/lQrixgmADlqjgpqBzA+R5b6pw4Aeaom0UtzKTFsGjmB3jWI1fmblgYNBrSOfgesLhQ0p+na4lsBH2TccSMOcLpisDwBGm5zGIV4y4yd+81M5QoxxwIT6I99O6DD+bHpq5lLx6EUb6IdiOTNaLZSKfJWCSzk5Yqm1LZdKWKr7fGHnT3oLsH3d1Td5dfDszGPfOWoE99Ffp8DHgC4xuS81yBPjqhGSiWFtLRl57ICq4oGYj0w49DUOxfRUC7AJ5mGN5+RXykXfkK871sPvTzUbpPOXX9+VwggzSOugceWCLhnhHfOccFlNhcbe2tCkcSBDRYAxHBaoZsrhLazB8mQUArbFGFuUpEwXcxm/BCLkBlpzdsOr5xQJIHJHnwRgdv9NfxRgckedDdg+7+OXV3K5Isr9AZnBQl0ymnZClImnmPveUMCrD0CEm+MbOQEM7RChJjGcayysjBGjXqo7p34oiWy1tup9n1Gk6nwdsn9ZP6qNXA9cvc19/lepwpWVmnCvOt55GGGEDcA+C4JADhimKl3HL6L8GlGw/NGh1+S3EzjHk1PTBD2LG1ih2vVQx9A8KAHcMN6cWPgyu9rKzJ47ipJMQDA2G2Bo2rSAgpaR1JPOntDAfoeICOB/dzcD9/DfdzgI4H3T3o7p9Td58FHVu7oGPrGdCxxRBieQix/pPQ0QXcgdDMg0mBPjgJDG8QL51sztTeXKeQAr0Simx0V1HkUCn2ngfzFCxFpUxkkA8XmjcoO8WyYVoWCnA2BhMZ4GUTEtAtShWetgVMihef+HIqSY+xQ0A3nNs9D++B0DqTylvWigwcPwEOySj4St+S8sgliJPwEP4BBcqDjsFQf8Ucp5mtL8oHswH2+Ap7zC6e9BF1luV/2+sPupujnbd6rjdsFzCbgAMII8TTTJuvDIIeoPoBqh/c/cHd/zXc/QGqH3T3oLt/Tt19BlQ3aGgzVIcCe0P1Nh6MYBmWekuHTr81YidVMRyQeDPlEFZ3cwxOuAJEKbu+0spvUsquvAR7cvxZugt4pyMAzVAS+lAsvVjuM8wTzM+iymeymh6YDtRj1VHT44fmGquDm0yj9EyWm+jdwXhho26kSqMbShRgbe2oAT3W6THeCMacdhdspZ8edJpDBMI0mQoeGTfCRI9xjzNEEt9F5ui1vuJsqY/Qt4+hv9jVn382t/VDE9nQj3XDt7UtKM+Ay6XuIfu4sdrcbHqLkFu3vnK/ae5GMNnfWGnsBos12BvBQ7wKg/a/vPrhx+GRuYYTFV3fLSpkrI9mfwARIUPWS/eCYCXyLaFKxhNivFfabYOKwzwfOszug1sh2F16FcE1WPgBmGQaUqwkyApgrfxaQ1c8CB+dXzUfSRQ86QbHMELHvFTviBwdRQQy0Dc24ZGU+8Bm59LsU9eHaUwXKcBjd7O0X7zQr5cy8beUmq2p2UQtOlriQg/tnaN3bzugvUiC+xGN1osb1/TsAj0Mn+AJUl3mAUfC8FHeI+Wks/ZiPkr0bKRX5uM++JHOI5arMW200lNIl8yZKBWJ/2UMRQfV4G6cgBa9mC06BGmTRtiNWoElWzdpSxswIfF3BYoRaGHSt3IQJFE6O0Iq+TPNLOj8z3RW9udSn+nxHZ6lhZKucqIX84wN2tigrW1AZPjXngkFC3Qb+0B2QAtAP59/sgSG0YLN07TWWnUif0x10DU4wCpRiWZn+stZbuDMJ0YvsHRWBkwwQups1xh8Z4YWuqfSYKXJgOURXOXXV+AVl8ZN85staaKn/G/rL/a4l+dM8HKar22lN1iS/x67+x+yeAdL81e0NAbkYu5xkN+dfVE4pP6se0RX7pfFe7ZAlKlLJtIoKpBGgqvZQbrbXMC/8JasACF1iIMosiN8VCQDzMWoL2QvnIkUlFeYCR4jqqygzKop6ThAaTQseDkPEhrTkbIQBoNDJCh9vG6J/QiBW+DA9GHQhvt5geovykRvtzCDdDUyO0+FAsDZdJoEeAESMJFMGQfR2yE5roycRBs4iOECkfZMX2af1Uq1HUUSh6JK4Us4jW48TEDrw4N7tgXyEZnsMwxk4VRo3pGB8LNLg8vQfhdtkEp7IvwZho1gnQGoiUIL7y+HKxQVno3USx5407apFB1jWbxqDDqvhaFZhWCRbrFWUQwxboGuvuu7eIn8XF99tnS7Z5ZxP/w6gW/86wSMV8Zw6niGCUCcyESHd9qU3FnFQBqqnEkXD7ZPFB1Htj5/xgwRhpULfPybPpGLx2LTqJHMFAgifs7Pw24UgVdmTN0jWuPa85cRrO1Imu8M5gUbCB9/FZghgX7QaWydwiIu9QuzZmLjvSuFituux8dgW1fWGbIt1cjoZlkLuosZSo/Mr0SY6gxMyB/hIf57Zt3D/xb+sg6t+lCInn+20nwmlNGEU8C5Dm+ZDzAzUOz/AaEVW1c= +sidebar_class_name: "patch api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Body

arrayrequired
+ +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 + + +
  • Array [
    • value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    oneOf
    + +string + +
    + +integer + +
  • Array [
    • anyOf
    + +string + +
    + +integer + +
  • ]
  • ]
+ +Indicates the PATCH operation succeeded, and returns the SOD policy's new representation. + +
Schema
    ownerRef object
    + +Owner's identity. + +
    violationOwnerAssignmentConfig objectnullable
    ownerRef object
    + +Owner's identity. + +
    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. + +
  • Array [
  • ]
    • 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. + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/personal-access-tokens.tag.mdx b/docs/api/v3/personal-access-tokens.tag.mdx new file mode 100644 index 000000000..c900226ad --- /dev/null +++ b/docs/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/docs/api/v3/public-identities-config.tag.mdx b/docs/api/v3/public-identities-config.tag.mdx new file mode 100644 index 000000000..3fa00fe5b --- /dev/null +++ b/docs/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/docs/api/v3/public-identities.tag.mdx b/docs/api/v3/public-identities.tag.mdx new file mode 100644 index 000000000..0e011f83d --- /dev/null +++ b/docs/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/docs/api/v3/put-account.api.mdx b/docs/api/v3/put-account.api.mdx new file mode 100644 index 000000000..6f2843dc8 --- /dev/null +++ b/docs/api/v3/put-account.api.mdx @@ -0,0 +1,102 @@ +--- +id: put-account +sidebar_label: Update Account +hide_title: true +hide_table_of_contents: true +api: eJztW21v27oV/iuE9uG2QWwnjvNif9jmNulFir4tTVYMSbDSEm2zlUiNlNL6Bvnvew5Jya9t2q5YbwshQGBL5OF5P8+hydtI58LwQmp1mkSDKC+LYRzrUhXRdlTwiY0Gl1F4YqPr7SgRNjYypwkYfmEFK6bSsuGrU1ZoVuYJLwTjinE/h32QxZRx9urinBnxn1LYos2u1DnNESrJtcQYW44yWdjFaYFQwe17PE4wtyiNslgsPDw9JjpDLPpeKL/Ky7Pf/z08fn76gvGymGojixnDMrSsNCIh/mKepjXD7Sv1162tFy/PTwbsX7rES8W0SmesrKQirmsuF8QL+mBjozNmdWliYZkeO+6uomORSsgjkicyFVcRK2a5aG9tQaFWxCWxBaXeku7MY60K8bEYgl9StEzUoCI+yLjiExFd30HrOTc8E4Uw1k2VpPucY9J2pPAC32RC9OOpyHg0uI1oTTy1hZFqEt1tR5UWokFhSrFqx2Bh0irIiI88y1OaL8Z7R+N+b693KPq9/YPuaH80Oup1e3z/YK9/mBxFxFyw6yOdzGjp1ZVikhH+hFc8z1MZO2/rvLO08u06z3r0TsTkfnNClxEvIMmoLIRzwtyQ1xYS34jq/B2+LQt2Dov4FVg9jN3wFAyzsTbOYnzu8Csc8CSRRIinrxZW9GLVSrqNYmfSaFjaApaBbqXNUz574S3zVE8VO9YCL+BYJjx9l7gndvg86L567kdmXKb0DXPbGPl3i+/ODduxzqK7O1i0kIWzUZg/nGvhzr03wuZaWa+V7k53XTlDO1OxD6dEFFjBkvW/2F4bXQhR7KhWqzMix6WCG1aLIMiYLbhBhITBsCciyK7YHC59vW6TZdtjzBonMqlikUSbmzUEw6J/d+P+7tHOUe+wd3C0l/CDnV36dNDfi7v43N+PNijaOrWdCVumRVB1b2dnnY3HqYQa2Ykx8LMWO3MZDCJLz1uIGjZC2FCakgpuKZOvssDndePV/VgnYj0jrCaAJ1KJ1sTAUOBQOJZjTCTL3MiEjJdpI4IFK/W6ccsJA5po77JHPIG8Xr7HQRhSpOHxe9A6Te5n6EJJzGfVFAajVvG6YVlxKPjoYKff7Y0Pepx3j3q7h/uj/pjv7e309/t9Wj2DhyGh2oW1uTF8trb070IJI2OWapQL+Yeg6sOhe8eAWxxTkN8ze78NHI0v0D/lKT+2FjPwy6hAbKOEPnr8ivUOWcrVpHTP+WRFCap18ZoqQpmmfESPKFNBck/4pZETqTaxIlSZUcAdnzwZXjw7x5Ozk39cnLzGJ6K1VvWHCt6akFuCVfjCVH9wHAcBPnDLrEihDpG02VagugWBeKjgYaD03+zMQpnwrTFHSGFGWH3DjEXSvvouhlLsqyl7INuivc1G9CzjRTxlI24xASak4VsIZJEXrWdBk1tsKngizMM2G9YJvyoSGZ+BEEMloND1BMYlQlk40KHLgildyFgs22KuymVrzLPJs0WjUHCA8/v9ZBgXJZhzYi5GYe0tgcVgH/DsNbfM3fmC0pxKZ8jRMaQAPJpBjcZAwwzFhBEsC+mIzGWReFQ1rs5Yi0nSpbvnnpnjQrt3MS/tF8TdqxTpp+VEq1/ciBB8lvCXz0bOGpWZQkbCS5fwaXIYVZurCnw2liJNmthtYreJ3S+M3dWXZwHVhbcO+uyuQ58LFTowKp5r0Mc471G6atP+cPAmGHKbQSEBIj19cx76O+oWP+YEDL8jPvKlfB3I1vbwz0cEP2pjLdmCGHR69BKMkYlEMnB8zzl2ivKq2ltf7Yk2IwkHVRsgIrULbIbOlENlplQORHO7zdARWPVbwab8xrUv4NdnQN9Vt3yn0CDJBkk21aipRr9MNWqQZBO7Tez+nLH7WSRZc+WiJeAkW2YZNzPvaeE9ScsZBsz3F+uQc6ZaRStEjNUYK1pGDtGouzvaHR/GopfwXnKw1x9344Mu3z/cPdwd9bqH0WKtv5zHcR1kyzG1YG9vR7/9LMwNcFyp4Fy20DpZ3v6Deo0YU1qj1FPjZugcKr2eY8feOnZ8oQvIBsLAjuYT24sXZ8+IPpZ25Elv7vcKgtledRjOCwcpyYehaWmLBjo20LEpP035+WXKTwMdm9htYvfnjN2vgo69+6Bj7yugY48RxBoTxPqR0DEB7iBoNoZRIENcQr2KYGMOUfAp7D6GsC+4mYiiBnpLKLLb33BEQmv2nKtZBZbs0k6kmquL0hvGZjTWVGMxgLMJUqRiyFpS+9/eZSYIk9JhmXAWps1IINA1s9ZwXEAqHzOVv9WrSBWnJTh0SSHVtPeq4WMS7iTGBP9Awe2DTpCov+MeZ7DW/7QfzM5I4mckMTv5GAtBMV/v/+5vOiVwCuYNpYvX3tafOC7g98y5QhshPuY+fdUQtIHqDVRvyn1T7n+Nct9A9SZ2m9j9OWP3K6B6QEOfhuoY8MVQHWPbO6zGUk/Iuf7viN2FSuDAuTfTscPqyRyDO1wBVwpn7SmH0DHuQdSpzn13bmVyF9FZccKDnpXS0GHgaVHkdtDp3MJCsMxdm+eyjcQFIxUzpT/Q0eDOzd6GfEPHS31sIWMlZez6BTqy7xdpO70aSa7r85xbwGvZSUJOWp1A/ix9Oo1O5puh92CezDYdgA9u5B6DzRw9xG/WjW47t1mTEbJdmPTuPnn+ufc5OTyRT8ixSX2fXQvjGbhcEY/Yv54f7X9NYNuvvnbAf15AaJu/u7bYSxrWZY8EN+gE/MmXB0/fnD9kE4KYLsRLS+hWSOoJ6F4FXMSlsGF1CoQmuapidDmZOsaHS+dsKGTYOIXA7Eq9FoJdngYlvEBuP0MydiqlScLFP826flBZJhE3IqWy1146k96RiepAQx2+NO+hK3GuF5AKHzP3tH2lWuxYUuaRVKppTBDRtXbsMq/k4gtyfSsTf6motTy1lqNmH65w4VV7Gftz2zHilkjw1DptffPinl5rgR41TnhCVFd5IE0EPpZPR8WV1b6ZjyV6LaK3zMeVejOVqJ/L05hPV8yi/KUJO2XxVGsr/sYYuQ6FweWkRBR9M1sfaNGWi4hWd2eBpZZfsiVbQIOOv2cIDOWdiY+oGjswov2+iAvJt86yiPm37tbQ2yWZ3eNLFE0amejYfjPPtGCLFmz5HGAD/+GCA5hFbJMMLg94B3g8t7/LBIHRhZznaW3M6o58x82h0hCDVUfF5gP/ZTBPcOETcy9odD0GKZjAdH1ejC5DBVpUmJaUVW0DrGpwnd9Uox6u6M3zW/+YSTXyzyYvSTyc75a8VOnse2fpT2SSP0/e/UEZr8k0v2KmCfCWdh3P5jcCT+bX5Jbv6f2AS3Po5BELTiehSVmMQA8l1zcW3WVQgf9469KIA/loofytUwJYi2QgREEB5xJOPJXCbUnkghcES7fJ6XXmkkS49YbG0xGaGIxBRrGAynwkU9Brszfo+RRENdTv0VFgUH2nQ+P3GvK9cndTjyuvArrLslLR1VcwUWaMw3fvcT1oPi59hkT7p0QlmXYYs55VpQvyaVJF23U+JrMvx7R3jbZ4wcPuWQsOZsPGNRRJFgnXWOeCnInUhQCNW+4N7qMNt25NRZpTx4n0DqQnFlZ4fnq+RhHEVPi1RJtJJ0yyHRoLItSHeWfYa6PPpEe5tgXa4wW6F/5u8Pz29JIb3c436ZtL0193aTpUY2qjOjlt+ZH+S9/W+eb5MqqIY/jAXxudwkD05vaW9oOolbyjx1AmbTZcXs87Rddhw3foM9ryMdLm6v3oRes9OAuqeVjZOtya3shntYGpZvO9iwgf3wtKfmD17hqj/J6UY8S/CD+CtM5nDtJUE9d+3aHG2c/w+1yfHXu9sPcAI2HsKFzZzvwuiuEf8JD+D6Ir/OGLzn0MYpB7fhtVe5KUaB3ZCjpuQk7hA/SNYf8FpjJ7Fg== +sidebar_class_name: "put api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Update Account

+ + + + + +Use this API to update an account with a PUT request. +This endpoint submits an account update task and returns the task ID. +A token with ORG_ADMIN authority is required to call this API. +>**NOTE: You can only use this PUT endpoint to update accounts from sources of the "DelimitedFile" type.** + +## Request + +

Path Parameters

Body

required
    attributes objectrequired
    + +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/put-correlation-config.api.mdx b/docs/api/v3/put-correlation-config.api.mdx new file mode 100644 index 000000000..06ed4c65c --- /dev/null +++ b/docs/api/v3/put-correlation-config.api.mdx @@ -0,0 +1,96 @@ +--- +id: put-correlation-config +sidebar_label: putCorrelationConfig +hide_title: true +hide_table_of_contents: true +api: eJztW1lz2zgS/iso7kOO0uFDidd62VJsJ+tZx/b62Dw4rgQiIQkJBTAAaFvj8n/f7gZIkZZ8xJXdTFKchwxNAo2++2sIuI4cH9uofxZtaaVE7LSx0Xkr0pkw3EmtdpOoH2W529LGiJRewciRHEetKBE2NjLDdzDoNEu4E4yzuKD0zMJzOQ3fwzyWW6nGTDrL/Gym+FR0PqoBc/qrUOxSugk7OHr3abD9fnef8dxNtJFuxqRlRnzLpREJDGUxT1PmJvB2cLjbAXYyboCSEwbluY6QLLDlF9nHP1qRREYz7iYL3J9MBJsPZRc8zQXTI1hAzAXqsGMagqSRHfyYK/kNhsqEjYVCpQF33M3nsNgIkh9ZLPiP+s7kohVZN0uJSTnNUmRQXGWpTuDViKcWB8QTMeVR/zpys4xGOgPqo5Gc5vQjfjwX8ebm3K8irHujkxnOvL0osOaEcvhpmqdOgt5cd6TNtA0GpLUWVtXDLyBMTYCzaCRheVguM+gtTgqLM+jtEn7r6q6oZ9FDrqYpIzKtCNniwGo0lIqbGciH/yEfNtPK+iXXVlbwf4sGrXpi7t0zEY7LNKppgWdZKmNiofvF4uz7VFAXdyqs5eNHSIz8+MXBQcIsBuIxrgJvHXYyyyS69Yw8C9QiLoBFJoyBccWcywkEiXXc5RZ9kD52ag6RK5tnmTboilc2YRcQEsBEi8FnbgUT8N0IBkoHL6mOYBPnsn63e3l52bHAaaalcp1YT7swqFu++YRW+bT2aaWDc4GH3MJKKIvVuYlFsGN006pG36M0NPeLSnKoCWeFuZCxUPoS6XvNJW9Bq7ayAjeGz5YukEoQGeI6TCQ/g0xU6ms4q4c8EFF5mvIhLu7jRzoxtYvi3FS4PIsynXS1GXdLQsRiFzVevqK/VjtfuInOUVdk06WxrvIpEt05Ojo4gr9PD7cHJzvb+LS/9c/B/jt6Pv7X7uEhPJ3fr9gQCGG1qmo9eQwvJx298Tl928eMj7zesmDbSiU66g45apsdCZcbBdqUo+DJlJDYEDIS+otUkF9l0vlxYegja4tS50N+9lYq0R4bLpFDH1sxTGRA8UImWJym2hTBWtSAJWEGmuissjc8AXm9fFtBGNSg4fFXoIX18yGGTn0JKaZgLcFgumNZsSH48PXK5lpv9LrH+drfe6sbr4abI76+vrL5anMTVw+54uGQeIc1S8Ys1ZB35J+gEKhWoHtigBaPFh3+DhsQjUfGuR9bilnkNieuXAsgxJutQ9bbgAylxjm95+NbSlDt0+OF2ATJPeEDI8dS3RdK2ztvB6d7J/DmaOffpzvH8IS0FmJnoMBbE3RLYBV8YaIvieMgwCWH5AF5Oobc0WEvA9WXIBBXtjowoAU7s6BM8K0Rh9ILM8LqS2ZUSbOR0dNaKFHcXDn2XHZEp8WG+A4qZTxhQ47ZGEyIw18O4lhkrr0XNPmSTQRPhHnRYYMkkSgkTz3asTB/BoQYTxIMXU9glDusFQjKdA7pWDtIvnVbzFV5O1MWaWSvahQMDuD8YT8ZxC4H5kjMahSW3hJYDPYBnr3m6tydVJRGKp0px2MX6iyhjxgyE8iGkDSkIzSXhcSjinFlxqpmR0p37z0z207Tt5jn9hFxd5hC+mmTaOWHCxGCzyK89dmIrFGYKWQk+Ihi0+QwqjRXEfhQ10SaNLHbxG4Tu4+M3dsfj0KLEb4S9FldhD6nKnSoWDwXoI8h71G6aGP/9I2ON2SLgUICRPrjw0nofxHTX2XYZP1AfORL+QLzg9Ie/v0Q4UdprJotkEHSo5dgRI1Mn/iec1z2Z72V9cXV3mozlOCgaglEhKxp2EznjIPKTK4UcsJtiyVaWPXMsQmH/MghIqz1GRBXVUnb9ygNkmyQZFONmmr021SjBkk2sdvE7q8Zu/ciyZIripaAk2w+neL2Nnla+I7ScgYDWLHZzcqQI1PdRitIjJUYK6ojh2i4tjpcHW3EopfwXvJ6fXO0Fr9e4682VjdWh721jaha68/mcVwGWT2mKvb2dvS/oAhzATguV+Bc1mmd1Lf/QL1GjDCtYeopcTPoHFR6PseOvUXsuK8dyAaEATuaO7YXT4/2kD4sTeRRb34/GoOWVAfDuSNIiT4MmpbWNdCxgY5N+WnKz29Tfhro2MRuE7u/Zux+F3TsPQQde98BHXsMIdYIIdbPhI4J4A6EZiMwCp4lykG9CmFjBqLAU9h9DGHvuBkLVwK9Gopc21xyKERr9p6rWQGWbG0nUs3VhekNxk5xrCnGwgDOxpAiFYOsJQHdolfJqUBMir+pp3IqKY5RIKBrZu3ByIFUPmYKfytXkSpOc+CQkkKqce9Vg49JcCcxQvgHFGgfdAyJ+gfucVYOrTx5P5gdocR7KDHbuYqFwJgv939fLTslsAvMG0wXx97WdxwX8HvmeCxGiavMp68SgjZQvYHqTblvyv3vUe4bqN7EbhO7v2bsfgdUD2jobqgOAx4N1WFsZ4WVWOotOtf/HbFTqAQOyL2ZjgmrJ3MMjkdaBbyUbkaLnALE3/KuPMjdBCNTJqpfnkxt+2PDfX9ANTrHo+xTAb4YriBgEsKj+/1ofqrWdq/nR4xvupXD5IFa1Ip8Z+EFzU0K8/GYs+13u9dgf7D7TYdnsgNpEVzAzZS+pCPPF+tLspm0RXRDPkzymLqRweFuaF86ZDUjMTB8FqUFvA1JTxgCxTnqe+nTHQNwjhl0NsyTaTFXHhCn18BmBh3KM+vvUJBTLsgIsp2a9OYhef6zfp8cnsgdcixT371rwXgGXN4SD9k/n/vMMUJ5v/qC58zLE/6IsLaw2AEOW2NvBDfQZ/hzNc//+HDyonJJw99DERI7DgjBQ3ARSpCD4owJTqKaZXQ+nhDjg9opHgxINkpBYPZRHQvBznaDEvahchxBqieV4iRB2QVnnT8vLJOIC5FiUb111h6Cogsa6vLavBdUQKnTkMpfi8BLJR9Vm21LzGsSgQCOCSJS48jOskIuXpHrqUz8raDW9tTaRM2+uMWFV+1Z7E+Fx5AVkARPLWnryYt7eu0KPWzL4A1Svc0DaiLwUT97FRdWezIfNXptpFfn46P6MJFQnevTmM9lzEJxTRO2y+KJ1lb8gzF0HQyDs3EOUfRkti5x0TZFRHttpcJS2y/Zlm3AmsTfHgSG8s7Eh1jrCepov+tCIfmZLAsx/xk68YR9rslMr8+gJOPIRMf2yTzjgm1csO1zgA38+4qHjgWxjTJQHvAOsDW3P2WCwGgl53laS7M6ke/SHCwNMbBKVGzW93/05wkuPDH6gKPLMZCCEaqXp9HwKlqghWWvpqxik+G2Bhf5TTVU21t68/yWP5ViBf6ryYsSD+Z7MQcqnf3oLH1HJvnr5N2flPGaTPM7ZpoAntHdaNnQZVSd3KO1xZ1B3LqeCPgXvlKkEkqHHshfq0UMUyWTAVZGn6aYjidS0J5CJrhD5NdCv9JTikOAuxj80DkSoTFeahV4S49DFyhToNdhH/BqYQwqxoYNz/IC1S86dG7HoOVDNBLbLgwHAGo6zRXe7QUm8inem33Iuom0ce6TUGgCPEOaYFw5q4hIdBtURYdaFzO1B6Njf4GwYsQH1gIb2rDzDIpEi4SrxXNBjkLTgePq8Psh2uA57YlIM2wZU7zXaEVlhfe7JwsUgZgKP3fgBcMwyXZxLBAJVzlhwnoHGkV8lWnroL+t0IVuilVudLPlV7qv57vtP/92dygl2AN0M9wNo+ufvifxbeHZ/FYx2qFfu/m9pDOEXmMCmsGJ19e4k4Jt0g2+/pYLbNPPzuddEHWPYDR8Tsrr2Xeq6/lRkOUF/Rb0v79ZvlQ9xZaims13EyJ4/CpwE6Kinxu8f+p3i0hQPyD8PNE+mREcKAgsuzSOfaef5DehKsMXfqap9fWHp+jhw3BVfeq3OJAukW3NH8EaAVktAxbhAQfd3PwX86O19g== +sidebar_class_name: "put api-method" +info_path: docs/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 'putCorrelationConfig' (put-correlation-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

putCorrelationConfig

+ + + + + +Update a connector's correlation config using its script name. +A token with ORG_ADMIN authority is required to call this API. + +## Request + +

Path Parameters

Body

required
+ +The connector's update detail + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/put-password-dictionary.api.mdx b/docs/api/v3/put-password-dictionary.api.mdx new file mode 100644 index 000000000..e80d104bb --- /dev/null +++ b/docs/api/v3/put-password-dictionary.api.mdx @@ -0,0 +1,132 @@ +--- +id: put-password-dictionary +sidebar_label: Update Password Dictionary +hide_title: true +hide_table_of_contents: true +api: eJztW21v2zgS/iuE90NfEDmJ4zZNDoeDm7aLLNptLi/XD0mxpSXa5q5EqaTUxBvkv98zQ0qWY6dpe4vb3UIpkDoSOZzXZ4Zj8rqXF8rKUufmMOnt94qqPJLOXeY2eaFjeiztvLfRK+XU9fbPe/VL0Xr7fqOXKBdbXdATEDmdaSeqIpGlcqKoZyTNDDHJrShnSuR2Ko3+nZfvX5iRKPPflBGXupyJt8c//jJ68ebwZyGrcpZbXc4FyFr1sdJWJRgqYpmmoIOno6NDzD8FybXL6VRhsBFxbkqpjUi1AWflTJZCWrV/Ybb7eJdlypThXcT8TbR1pYhn0sq4VJbWf/DDgw2mNVZie/BMnBkd5wnI41eRa1M6QQsoMy1nG0KahFYQempyYjqprDZTUdg8Vs7h44UZ9IXKCgjHC1+Ynb5Ic0im+MESI/yAuXaltFiJFXXR8+P/edEjBiGj04kKKgKXLWobTMwqx3KL0iqYCBw6AfYymbKCGiVcmGHfrxn0RqyXd+iY/46ELkVWucCg58/kJrqcafhCIWPV0iYpJzfp/M4RjrmEkfNLlfzjwojwk8krnVVZ0LLIJ8wVcwoFrLfKhaF/R3d5RyaJjbLxkCy3rGojBhtPtraCVzz0QypTkipaLPPrjVs+RPK1lP+oTxIscRDWJoXVC5+dvoqetVVAGuoT7z+IE5kVaUv9pbryJOj1hw8f/Kh1MrqMQ4UMX48PTqPML2cnd0+Ep870WJOX0CtW48dLZcv5hZHjOMFv+rkwNVN4LX+/cpcu8ATscCquKHyBH9e9M6fsAXnZVTlCXBOm6MTs19Ojxdr7mTRyqnrvbwAwFPbg/nmegMx1r0aB3n5pK7WKP5/BAR8UVZHmMlFJH/wFpye6WZWWuoDrbgKisggIJumxi2cq40/lvFBYIR//quISc6Ef4GeplaO3tEBrlCsp2jGKiEks0BtrRswb/iGpXIFw9ZMHW1v037IoJ1VMSDGpUsSJh1TwjKmDre3V0Qc+oHnAcB25g1STf760FggciWNVVtbAtnoSkIG1LMZQM4WSNp9kqm8rSRZFqmMG7c1fHdH9cg0lCl6eHiAs1+lpmdlXCJpoahEV4FAxyxzUoPhJJxSBHKWeZI0CPI4YVlccLaADTfS3xXOZQF4v30EQBmoqEWe/gRZlv/sYAqpgvqinCJ00mWzNsmpXyfHTrb3BcPJ0KOXg2XB798l4byJ3drb2nuzt0eoZbAsfd621pbVyvrL0j8ooq2OPJ/p3KASmhu6ZAV4cUxCmmbvfBj7y7xeXwijgVy1m4JeRB9lNPD84EsNdkUozrfi5nN5SgonOTvDEwIHlmB5RwEJyT/it1VNt1rGiTJUROLx4+Wp09voUT45f/vvs5Qk+Ea2VmmNk4K0JuSVYhS/M8kufFbwAl8hxTqVQB8JDPA5UH0MgaVx7oPZ/ubmDMuFbEwlIwIyw+poZbdJiYvNsKZRij3Xioe6r/gagB8+ABfFMjKVTlAB5+OMR4rwoo9dBk4/FTAGf7KO+GCWJZgRLBaIRRDlZAcNkklDoegKTCqGsOOPmVUm5TMdq2RYLVS5bA0GgSx7xum0UCg5wfr+fjOKykqnPRu0obLwlsBjso+qsuMzdaUtprNI5EiKgm4q8OdRoLTQsxpBNl64pVDTpHomiHtcgFsFrLRbD3RvPzIsy53exrNwXxN1RCviJWLTmxScVgs9RMvFoxNaozRQQCS9JbJ4cRjXmqgMfOUmlSRe7Xex2sfuFsXv75XEoosJbLn3W1EZnJuwjKXmulD6Wvcfk9WbT70mDITewUa1LpJ/enYZdKsarq4Kq0D+wPvKpfIX5UWMP/3xcb8Xq1L+wBTHIevQSTIBEKtlnvhccNxXocGtndbVXuR1rOKhZUyICNa2Y5xVvzWxleFMosfdJcuXMg1LMJPBRctXqEZBWNUnE27CukuwqyS4bddno+8lGXSXZxW4Xu3/P2P1sJdlwxdES6iRXZRk18NjTwnuSVgoMEHU7TzQhx6a6Xa0QMdHUWL3lyqE3HmyPtye7sRomcpg83dmbDOKnA/lkd3t3ezwc7Pbauf58EcdNkC3HVMve3o6sYhRxn1DHVQbO5co8T5bbf1CvVROCNYKepm6GzqHS94vacbhaO/6cl5ANhFE72jvai2fHr4k+dbeJPOktr2xM3wcF1flvOaik5K68utKu7ErHrnTs0k+Xfr6b9NOVjl3sdrH794zdryodh/eVjsOvKB2HgkqsCZVYf2bpmKDuoNJsoumIi4grqNdQ2VhAFHwK3ccQ9qW0U1U2hd5SFTnYW60iT/NcvJFmXhdLbqkTaRbqInjD2IzG2nosBkgxBUQaAdTSqG7Jq3RGp2ks/EekOtMcxyQQ6Np5NJrQkRQfM7W/NatoE6cVOGRQSHPqvebwMQ13UhM+KWLn3AedAqj/wB5nsNb/1A8WxyTxa5JYvLyKlaKYb/q/T9adEjgE85bg4sTb+o7jAr5nLg22Eeqq8PDVlKBdqd6V6l2679L995Huu1K9i90udv+esfsVpXqohu4u1eko8JeW6hjb3xJNLfWKnOv/XrFzqAQO2L1FHnOtnixqcK4r4Erh/D9hiKSTub3NNadye3Sel6pCz1BlUwyclWXh9jc3r2En2OemLwvdB3zBVOXc5Jf9OM82P+2sQR06ZOojDLiVVLwKneYP24w+a9dqcmCPdryA1zXLQ64KnfPpgs/SNzJjI86xAxGezIaAswdn4sdgs8BO4oHj0X12nhUZIduZTW/uk+c/O5+TwxO5Q4516vvsWhgvwOUt8Yj994vj1ydUcvvVVw5hL9IINfsHK4u9pWED8VxJi/2AP//y8Kd3p4/ElApNDvSK7jMIpWlngFA5goswkI3qsyA0iXOLzavpjBkfLZ22ocARkxQCiwtzopQ4PwxK+BkIfwxIZpXSJMUoQLPeP6wtk6hPKqXk119okhxPJ2YTGtqUS/MecaLjHYE2/oC2v4USiRea8EdTwqYxQUTe4InzopZLtuT6ViZ+qKlFnlrE1NyjW1x41Z7H/vR2jOglEjJ1rK1vXtzTi1r0aPuEJ0T1Ng+kicDH8hmpuLbaN/OxRC8iest8XJh3M40sujxNeNASDkkwTcShiGd57tS/hCDXoTA4n1aIom9m65IWjTgiosFWi6XILxnpCDUh8/cagREujcgx5WQuSXLfHeGQ/MCWRcx/4HshH5Zk5sfnSJ00Mslj980804IRLRh5DHCBf5+ZyLEQ2yQD44B3gIOF/RkJAqMtzPO01qI6k9/kOZQaYrDKVFyx7//YXwBc+CT4BY1uxgCCqaRuTo3RbZVAi9LTkrLqZsBtDa7ym+bIirf05vltvtKkTPlXk5ckHi16Jm9NOv+jUfoOJPnr4O6fhHgd0nyPSBOKXHI3XjbsBtpO7qu11Q4etZhnCr/xliOVq2nsVfzdRqph2mSKVJbk0xzT8Uwr3vsXSpZU+W2QX+UZx2G4AqrCJc4p39yyYFhit6ZT0OuLd9hcmRgqpo0VnbkF1V/zsMM6gZaPyEjiRW04FFBZVhm6KQsmqkxIuMc91k20iysPQthnGVVLlnMZ18yqI5LchlTR5y2GzdzbCTWJsf9sGfGetWBDFzrEUCRZhKpt2r00ghyrlL2Mxi2X3/fRhudEM5UWtLUDgqKYUq0V3hyerlAEMRO+lsjtdDNMcps0FkRoq+OdYaePDR09KnJXYh/aonvGN/PEutvRt1zqetEZ7+5Jd/eku3vS3T3p+p50KO6I282C+siENZXvEviOzHlvXUcGe/wZEIleX19Tp5HaEzf0+GOlqI11/n7RfaC/QNZ3HLmF85uiTlf4iis6nXOpGlpaay9EU0/ET/KNzNbwla/6qAHRNJeOzgh9x+EOd+bbZESXyW4sPnoe5R1Fb/hAg25u/gvC7Xdz +sidebar_class_name: "put api-method" +info_path: docs/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' (put-password-dictionary)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. +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 + +``` + +## Request + +

Body

required
+ +The password dictionary file to be uploaded. + +
+ +Successfully updated. + +
+ +Created. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/put-password-org-config.api.mdx b/docs/api/v3/put-password-org-config.api.mdx new file mode 100644 index 000000000..005aa3083 --- /dev/null +++ b/docs/api/v3/put-password-org-config.api.mdx @@ -0,0 +1,85 @@ +--- +id: put-password-org-config +sidebar_label: Update Password Org Config +hide_title: true +hide_table_of_contents: true +api: eJztW2tv2zgW/SuE9kMfiJ13MvGXhZumgwzSSTaPLRZJsKUl2mYrkxpSSuoJ8t/33EtJlh9J2kx3d6YwAgQSH5f3zXNp6i6ymXIy19YcJlEnyor8RHp/a11y7Ab71vT1IFqJcjnwUecyqvpE6CnCzOh6JUqUj53O+LUTnQ+1F92TQ1FkicyVF/lQiayabN1AxExA9K0TPlOx7muVCPxLE98Wxxjuyjdxq9NUfFYqwzw90Eam4kamhWpfmX/ZQowKnwuvcl7iY4w3Ozo0PndFTMz4AyN7qUo+BnIit+IqQqe6iui5pwR102PhlQjTJ5zqBqG2uDKn6rdCO8hzfPrzv7tv3x/+usJiOgsaEEUW+RBc/s5qET6GcoXtixc6MZ2KaAvit4L4nVunc/UCCvYqLvA8hpLvoguvHBScqy95FwRJ8Y8SiK7vYQEH3pTP39gEVO74FazCqCTtShQTQZNTl8yyVMfM4+onTwa7i3w8VCNJT/k4UzCh7X1ScQ7WMkcukmvlqfdBBTem9izUIU006xWHJqFloafboWITP6Zv0VcyL5wScCUV1miLcxg5UX1ZpHnwAurty9SrNi/HPVGHW1Yi9UWOslQFFdyjH/6Tn9vPyvwRpq8CHfgMCMGN/pt8vi1D7L02RR4sUPKrYc6BcqCGGBrJPDRtbswJwKyUZMgZZ9nXRowC9QfY3iaWMUSPilHUWcez/BKed9Yasmw35Fhfm5LiSJkB+fHzmE959gLWH+B3Z4rfnQa/6z81+N1p8Lt3D35zndNzNJ8A7xtD7xZ5UQixR8y2vnF/T2sgd2Tw7WDJjbU1pjcl8anqK6dMzDnpgbRJAi7jeRnPy3j+HvH8SAh8RVwv9MLZeZXCdkIW2FoU+PupRjyLA+fgmy1xquCEBqBI9zkNlNu76GF/J61oAwXp5DumgkTlUqf7NlGNsVCKNoM5O77TRrUGTmriUDHLMSYKULzRCWaIkXVkSyJJpiYReBwxXCufNNFeF29kIk5L+fZLYciATsafQesweZqhC6MxX1RThE4YWz6wrNpVsreztrex1d/ZknLjp6313e3eXl9ubq7tbe/t0eoj5b0cTMWodE6O55b+WRnldCxSG8Miv0MhTknonhngxTEFMG3kn7YB0/gK/XMc8dhazJJfQbBxRUjxZv9EbO2KVJpBwe1yMKME07o4Q4sp0pT8tk5XgfAxo+1FrChDwXcZvT141704OkfL6cE/Lg7O8ES05qqBroG3VlkXvjC0t8xxKcCt9ADwKdRBmfZ1SfU1BJLGNwfq8ObHHsqs8gRmlKsvmNEkLfoOW1MzlOKAscVL3VbtFdQCaEPyioeiJz0mwIQ0/HU3jlWWt45KTb4WQyUT5V61RTdJNAlZ1SQe88dcVCQJhW4g0C94P7nVKA6KXBib61hN22KiymlrTLLYUdMoFBzg/Gk/6cZ5AeZYzGYU1t5SsljaBzwHzU1zd95QGqt0bHKJVImR6RhqdA4aFj3IpnMvynRE5vJIPKYaV2esZnLmdPc+MPM2t9wXy8J/RdydpEg/LRat7rhRZfB5gk8hG7E1KjOVGanEVjy5HFWbqwr8UDEuY3cZu8vY/crYne08Lcudspehz/o89Lkw1cEJhJiDPgGKGztzuhIMuULHLiVE+uXDeYCSDN2/ZHT88R3xUdjK55jv1vYI7T2CH7WxpmxBDLIegwR9ZCKVdJjvCcesqKCqzfnV3lnX03BQswAiIms6MbaFkFCZK4whTqRfEYlV3rzIxVAiP0pEhPchA3KJk7QyC7S+RJJLJLncjZa70Y+zGy2R5DJ2l7H714zdR5FkzRVHS4mTfDEaSTcOnlb2k7RSYICoDt5FHXJsqlm0QsREjbGiaeQQ9TbWe+v93VhtJXIr2dnc62/EOxtye3d9d723tbEbNff6y0kc10E2HVMNewc7sooB4m6A4woD5/K5tcn08R/U61Sf0hqlnho3Q+dQ6XWNHTf25rHjubXivTTjCiH5KQxpJjqinIaxIxrrqrEYIMUAedEIpCoNvsiV9EiBioPTiFSPdF4dloOuG7e6/RyihECpnKxeRZs4LcAhZ4LUEmq2cCwNIVWfMB8oMIIdIDt/R3RamugPIXlxShIfkcTi4EusFAV6jdy3F53vHoJ5RzniLBj4gYPeUO1IAwdAQRByVo07l/h8ic+Xe/xyj/8x9vglPl/G7jJ2/5qx+w34vERDD+NzDPhqfI6x7TVRY6l3/Nv//xqmc6iUHITLCjaOC8fHzRUGZ1wBVypvVVIOkXQFIFpdcI8vohuAhAoDQ4VLMXCY55nvrK7ewU6wz31bZrqN9AVT5WNjb9uxHa3ebC7IOnQ9oLxz6WwSLjXwPcWwSJu16zQ5cMh2vEDQdXmbIvLQOZ8LP0rfyBEbcWwL5DcmsyLg7KUzcTPYzFBJvPA8us3OMycjZLtw6f1T8vxz8zE5ApEH5FikvkfXwngBLmfEI/avJxc2zwhyh9Xnrm1OthEq0+YvwxzTsA3xRkmHeiD8cvHylw/nr8SAgCYHeuEJ4yrNN5WkOIGLcCLrVqf4NIn3FmeLwZAZ7079TkKBI/opBBZX5kwpcXlYKuFXZPhTpGRWKU1SnAVo1vXLyjKJulEpbX7tiSbJ8XRiVqGhVTk17xVvdFwRaBPuAqG1fWVa4q2m/BNugmFMKSIXeOIyq+SSDbmey8TfKmqtQK3F1PyrGS6Cai/jcO8mRvQSCZl61tazFw/0Wg16VD6hhajO8kCaKPmY/nUrrqz2bD6m6LWI3jQfV+bDUGMXnZ4mQtISHptgmohDEQ+t9ervQpDrUBhcDgpE0bPZuqVFWxwRrY21BkutsGRLt4AJmb8jBIYJziR7tCczJLFAayYJIfmRLYuY/4iKOREfp2Tm5ktsnTQysbF/Ns+0YIsWbIUc4Ev+w85EjkU33yBDuFLJDrA/sT9ngpLRRs4LtBZmdSa/ynNoa6B75EzFZ53w0pkkuOq+HHfQ6HoMUjBB6vr3PryLkhZtT1PKqg4DZjU4z29qsSvO6C3wWx9G0U75Z5OXJO5OzkyOTTr+3ln6gUzy58m7/6eMt8w0P2KmKUEunT2eTj49OXjWvdpvuHC7tuhe7R4YIb9n+cuypBltATbOHyXSWfdQ4T96OWUwrEfRxGUgg6kmmSyVOQUXJ5d4qBUfQmRK5sT+Cjm4HXFCAO6mLKR8IDRwGIPs4QGLZU+noNcWH1DlmRi2pgqPrm2A6idblnpnMPcJeYt4W3kQkNxoVBjMpWAvRkLCT59ws0R7mIFFQ6VhVCWZZTxZz6pSA/kvqaLNtY4b+eM+nVajEG540xNrwZl8eVQNRZJFCPZTGVULcqpStiqNm64DnqINF24NVZpRjYlUDlSnGiu8PzyfowhixkMu1PKot1bLSX6VxoII1VzBGTbbqCypKbM+R0HcoHvBX7GJ+uu3YzcQ9bdxUy51NzmiX34E960fwZX7MBVQqxkd+ZE1ilDQheL5MlpUPKMcG8Jm1H13R4dCVEneUzPSEp04XF5PCkV6A9lwOMTV9mdFhxLlrxGt8zGjivL0Yf5nFqpdw4xw4PTo2OvGIcDJBTlnr/w8bxSOM5y8RSP970RX+MOLzUJo0Dd81H4XVYeDGBPIVuhtEXgpH0jK+/v/AAsdWfI= +sidebar_class_name: "put api-method" +info_path: docs/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' (put-password-org-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. +You must set the `customInstructionsEnabled` field to "true" to be able to use custom password instructions. +Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' + +## Request + +

Body

required
    = 1` and `<= 60`"} schema={{"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}}>= 6` and `<= 18`"} schema={{"type":"integer","format":"int32","description":"The length of \"digit token\". The default value is 6.","minimum":6,"maximum":18,"default":6,"example":9}}>
+ +Reference to the password org config. + +
Schema
    = 1` and `<= 60`"} schema={{"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}}>= 6` and `<= 18`"} schema={{"type":"integer","format":"int32","description":"The length of \"digit token\". The default value is 6.","minimum":6,"maximum":18,"default":6,"example":9}}>
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/put-policy-schedule.api.mdx b/docs/api/v3/put-policy-schedule.api.mdx new file mode 100644 index 000000000..5e78cf6d5 --- /dev/null +++ b/docs/api/v3/put-policy-schedule.api.mdx @@ -0,0 +1,127 @@ +--- +id: put-policy-schedule +sidebar_label: Update SOD Policy schedule +hide_title: true +hide_table_of_contents: true +api: eJztXOl32zYS/1fwuB9yPFOWKPnSl32K7bRqHTtry5vX2H5riIQkNBTBEmQc1c//+84MwEuSjxzdTVu2sS2RwGAwxw8zQ4C3jhZ+lsh04fQvbp1zLZJ9FaXiUzrI0hlcc2QQ9bUK3FiF0l/0b6CtcK7urjYcFYuEp1JFw8DpO3GWvqUmZ/5MBFkonA0n5VONNM5ODpi56UC/QGg/kTH2hH6jmdQsiwOeCs207csmKmGc6Vj4ciJFwJCC4aAFdGOe8LlIRaKJa4l0Yg78bjgR3IBvMoDPSG3Onf6tky5ivKrTREZT527DScRvmUwEMJ4mmVjlSbDhAVMTlsKncmyWKssqk2nJLbIkPvF5HOIgYtLdnez1um5vR+y5va1tzx1vjcfubs/r8a3t7t5OsOug/JAHodNXKlggj8ss+aiHKMVbPI5heJL15q8aWbxdnZwa/yr8FKWToGZSKTTeNQJZFsHyjEsNlTqgntWZne3/6Ha2dnvdjuftdtudLZSknwiQR7BuCFDinMMEHJSYm0oityppvMFuZiICaYMtVMRdsAKX7Th1WXttr+22O/Bv1G736V+rTf+9d1DAPDiJwoWRKPA6VwGZ0x/ObD7QV3FbG/xLFFhtUdNj1css958Wv6M2877r7GpVGOWUIyM+uNVasUBD53ap/2GUzVki4kRosHKYEvkaYFECX0OYRRbHKgGNl6MgId26jC6jQRBIpMND9pGH4EVszhdsLBgPAughIyI2ydIsAW3JdKaylEUqlb6A/ohMS8IUwA0i1cFgePQLfH93ePgzfXhzcjz6kT7tD44Ojw8Gp/BxcHx8PjiCq1dVsRZ9UpnW5DzCwcj8onRGIuFheDIh7HrYeb9adCIEsqDlUnRHw7MRc6nHSyO7l4wnCYgPAYfLSDMVCQZ95gqEF0gNI/iplTOROB0c/3D4CI30RtkufWqnU56kjEcBE/BjkTXh0VRsgLr8MNPyo/hjdYszh6/EfV1z9k6hNyu1XG+GjVU9kAtQW+CrkE/JAYkEvsKKOddrl6GChQs0NLK7A1hcoQtgfwIkCcGzMORjbHXfWlUwkXcjzzZqyk2gzho2nIqkintwqetVcaJ7V1soL0zfQhxXqwKDKa2TkbF7XDzFJ4g2YPUkixA88WctRgGAAuBjtMwJapj7vCYNQyiAY6PZXOe+d23mU3BbSNcqM1fahdOFb9vwswc/HY/EWxfpHV4K+KJxzcY1/2auiVZ/j2OiwofgcEj6GoOaa7PAXW9QK2sANzIM0QKuQUhw53p0foh/QFj07cdz/PP6dIh/zgYj+IOGdn12fny9ZgS72l6jjZeevnZAzsB2xiJBqwtUBkpgv2UKkogNFsoPwNCl07l0cFj40KZPSPTS8XbhS4uxk9iYcrio0McGR3Cf+TzCUTINqgP5JGICQ8EHbBlynaLkcl8hfHsyHJXWtOGAYO7DI/CdpAGkBpD+ZoBEZl8w2VrrUkYrVZ+ipX0XhymFASxdkdhiacoU65KoZXmtzQKrGVxn121vu97WyGv3Pa/v7bY67d77lexowAoCaIXDsxN3d7vdYZZ+KY4DaDbCYe7w2ly8B4caBuvtBzBJRdIHlY3eMxmgP0OSmRifyZMkwscki3DY5+JTiw3mIoFOm8fi5j+/qOTDC8A+QN1IUS77OzowQG9RajFgqJLpMw0J5IRnYVpriIjYWiO5FU8qhJYzsD+D31Pl3GMqBvCuVtMnU6/xZSxhxlXfuM9n7slYK7l6Qe7+bPXxdHuZFjsYnRB4tipAMjw4PB4NR0upYnEV3XdtOeLx4UA/xgbSBRseLFUa/J3Obpv3tiecB0L02p3tybgnwHp9r73d83DcpxeG1owMUB+HALVIpD70G+nPuAiZ/atJ3YVKVXCaU6EbYs5leDiP08Wp0GBqVTWOlQoFj1ZYGkYBFsMA7OWECewLrFFnFgmzXMMKQJRFUOVtwkNNmEhWbb/nJSyVDJ+gCFNieWbLUQCcw4Pa7NuTTmfi8d6Ov9frjSdd7o2DnZ63tdueiO44EA9UpT5v/LzT1zNQV89SDffuznirjlWkjYN47fYqPO2b6hyGAqZAGqwrjaGlNGXNpqzZlDWbsmaTqjSpyp87VWnKmo1rNq75XbpmU9ZsypoNIDWA9N0AUlPWbMqaTVmzKWs2Zc3vqKzZW1vJDMnoD5MExOCyUwGLbITril2vzaZNNlbBAnFDRoDKMviGlc1AQPgQ7qvgCWb8WkbCnSYQbgCHglj2oSMDih9lgGGRiWCIZB5yULu6dYMkWh32igcwXzO/fTsZFGPC/Q9A6ymKPI8k9Gd5F3BlWofvGVbsCD7ebu95vcl2j3Nvt9fZ2RrvTXi3297b2tuj6pLQmk/FOoCsD/2DiBCQWahgKZG/g0DAIkD2xAAN/hCm1nVANJ4gf1y+TNtimpZfhnuoIStgr/bfst4OBNfRNKPrfLokhMg9P1tZeWDmhvBJIqdy7SJfFPcOXw/OjyiuO/zX+SHGcUhrZaf1ABdPwhhgFWxhpm5M3G8mcMMrAQp7aam+hAlxDGbLhtJ80wsNwswXU+hhR1/To0qaTRI1r7mSbzacs+eyJVobAHJwDaIJf8bGHPMUZcLdlwPfF3HqHllJvmQz8HiRwML/NfFyTRelKFfiAIslR1WloHMA54/bycBPM2COpln1wsJaLItWP8CzkVydu1FFaCTSBWQafoqhU4h5ByQ/kKWMYW64O93CEUVBADxR3q5ArCpEEty9McwcpCaY8Xmmn+B3b0OAH5emVtz4KKzzURZu0Ii0kavJIpLNPKmzbVWoK3d8ButBGDS+2/hu47tP9N3lm6f2+a29S6FPZzX0OY94BvJNaPFcCX0Ssh7Ir/JGFN5YRVIVyoZIP70bgWN/EBG2pzxVfMv4yCzlK8wPCn2Y6+O8KJQv/aUukEGSo5nBhCLqPvFdckyCMqLqro72WiVjCQYarQkRATUTtlAZ4yAySFkj5ITrDRYooaNnKZtxwEcOHqG1QUAcNcIjVtKkbk0k2USSzWrUrEZ/jdWoiSQb321898/puw9GkgVX5C02TtLZfM6ThbE0ex9nyxk0YPlOQla4HKlqOVpBYqyIsZx65OCMvc64M9nxRS/gvWC7uzfx/G2Pb+10djrjnrfjVNf6i9KPCyer+1RF30aP9oFS8hHiuCwC49KpUkG9/AfiTcQEYQ2hp4ibQeYg0qsidvT21jzzUIq94dEij5B0LYaMShkhpkHbObZN8rbQgLMp4GLEAKqkMk8S8YGMyxI8mR7KuSTnxVkA3WThDiYpTMU4Sm5kxSj06BE4JCQIFUbNCgxLwiTFBGM+oEAR7BTQ+RtGp1ZFXxXJs1Oc8RHOmB1+8oVARy8i96119d0hPklDjDgzCr6n0GuyHR6BAUBCYDCriDub+LyJz5s1vlnj/xprfBOfN77b+O6f03c/Iz630dD98Tk0eHJ8voVnPFgRS72mnQf/6zCdXMVyYHb0KJ+2AAZlDE5xBZiSfUUVYgi+KKrvbBYvtQI02byVwd1mcUpkwzHRv+ErS0JoP0vTWPc3N29BXaCmuxaPZSvfqRKpm5av5psfu2vAB3cJGEcD+Aoyn4rOg7dDm2K0SMiJRDs2oEcDGJHbLR2OBtFTefhB+rhtBXW5UBnAHJHZwK071qboMrAZQ0LxTNtNLiiilTnC3M6T8O6x+fy7+9A8DJF75rFOfA+OBe0ZcLk0PWT/aqN4iRlu8Jib0VdeZVauJpiteSuDnWAzj70SPKE9sfgA4/lP70Yv2BTjTfL3TGOoKyQmCOAxb8FECM8GeTEfO9ESk6hsOiPGB7XHJeg/bBLChNlldCYEuxhaIRwD0J8CMpNIsZMgMMBeV89zzQTiowhxDWyVkkTDk0G0CRLa5LV+L2i9o8SgepTpMnLZgUQYkrhuYxs7Rcrz2EWcz4tX5vWlTPwjp+Yaai5R0y+WuDCivfDN9hsfnBhJ8FCTtL54cEPPrdDDLAquINVlHlASlo/6Qy4/19oX81Gj5yK9Oh+X0buZhMW03o0Z7GIa1sIwYEPmz5TS4p+MoemgG1xMM/CiL2brBgd1ySNcr11hyTVDutKF0JD4OwLHiIwx8TEuzRSZKAjaosC45DVpFnz+2uyGr82ZLl/ACootA+XrL+YZB3RxQNdggLb8mwUKDQt8G+dAOGAMYL/UPyGBZbSCeYbWWlQn8pvUB5cGH1glKjrumy/9EuDyvaV0A1sXbQCCMbIuHvvBd2Zp4SpVE1ZeE1iW4Cq/oYLFcUluht+iJoUL5vc2X5zxoCyd4L69b43S9yDJ94O7/yfEa5Dmr4g0NtbFEuRp+V7Rw/KQgX0x6uph95Wt0fcco157iro4HFweAv6M84r54cTPOVNUHCD6zFMT9SMTDx15qJ5XWN3lX9+0Xx5fKva+m63vj+9VL95Vu7q1/GrtDvJ8XzdCCgnAJn5VIDMR+WqxVtMZOPgNdwmNSTSQlpqDqBinVsnEIU8Rtwi3/ZkUVOaJBU8xut9A7FBzwlpIaRDg8xOtU3qdQQJGySExlyHQa7F3kEdHPugNc2jcGANUf1U2mT6Deb5FR2QHuXNCkDyfZxGeAAAmsjnjAAGPeHAgtZ+ZhQZS6kjkM1MUqhe9ctRFaEBRtCibTOb6ZILPA6QvKo76yFjgp9o+DABBVnysnMipCMngsF09xXqMNqCDOxNhjAYHLggBc9WL3wxHKxSBWKRhXr5oqWS6aTvpTWyLJ7hg8sYYui3I3fFSrHQ651GF7rl5ufGaty4sm9Rt+RDki17hbL0G07PNGOuKyFBm0kWToV841QwduvSLlzoTQ1eIBTrFhre3WIPCjPUOLwP8YYHj4qpMSMlTQbb4OagcmbhnRs9P7UGeF/QU7TPfBb12bnllNVqURRUHPn4QWIuBqZnjkVQsI27NDft0xh1VDp4hmeXHTpjEmx6mAPdg26tKUeTtOZrS2L6Eem7KOwm/gYv4u+9cwv8Ovu3bGDI0ouu3Tl4shTaGbB7Grovi7AdQCjT7L49YzbE= +sidebar_class_name: "put api-method" +info_path: docs/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' (put-policy-schedule)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Update SOD Policy schedule

+ + + + + +This updates schedule for a specified SOD policy. + +## Request + +

Path Parameters

Body

required
    schedule object
    + +The schedule information. + +
    months object
    + +The months to execute the search. This only applies to schedules with a type of `ANNUALLY`. + + +
    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` or `ANNUALLY`, 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[]
  • Array [
  • ]
+ +Created or updated SOD policy schedule. + +
Schema
    schedule object
    + +The schedule information. + +
    months object
    + +The months to execute the search. This only applies to schedules with a type of `ANNUALLY`. + + +
    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` or `ANNUALLY`, 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[]
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/put-provisioning-policy.api.mdx b/docs/api/v3/put-provisioning-policy.api.mdx new file mode 100644 index 000000000..9b34e622c --- /dev/null +++ b/docs/api/v3/put-provisioning-policy.api.mdx @@ -0,0 +1,98 @@ +--- +id: put-provisioning-policy +sidebar_label: Update Provisioning Policy by UsageType +hide_title: true +hide_table_of_contents: true +api: eJztXG1z2zYS/isYXmfyMnqxZTuJ9eVGsZWceo7tk+1mOranhUhIQkMBPIK0o3r83293Ab5ZlO04mWubcjqTyiSw2F3sPngAArjxdCRinkitRoHX96I0OY71lTTwQKrZsQ6lv/RaXsJnxuufeyc6jX1hvMuWFwjjxzLCqlDxdC4NEypoR1qqhKVRwBNhWDIXLCoJZBFJZNcymdNLEwlfTqUIWGr4TDCt7jw21CKTio0CoRKZLA/1dedCncZcmamOF4b5XLGJAAFQXKq1bSaa+bEAtRhnSlwzniSxnKTwdzLnCVvqFFoPl/AO5ARpTFVLcqDRsZiKGAWdl5qHJss+Y+Q0Kczl83mSRKbf7QbiSoTo6I7hMiQPdXy96MpAdQPtm26SS+vOUgmeLT1pS9Uuq9GOnPwXDN6zhY7RO1iUuhG0HICGn4SyTh4cj1rsaPz+l8H+h9Fhi50cnY33htlfIMA9ODl7S88YT5O5jsHPDHo0Fv9NZQz+QOfxMARXwVOQ2YGgMMJPsSAExo13ZkS8p1UiPicDkIDBAub1VzVf9hdcQVeDgDUF2rbP2zxYgO15gJqs4uUthF/EY74QiYgNNS8xCCMODbc8BS/gLysFwrrlZWZ4/SROBWjuz8WCe/0bL1lGVDbB7vZuV8NaMBvzbLSPNovPfBGFWKXn726+2XiztRNs7m7yN682NneC3pvtnZ3JNu9t9XZBWK1aFOen2OyqXquNo35MT2sDmiR12IUaVZKjBfHtsgYzw6RRpOOEXfFY6tRUJRXO7bB3EAzOvBa7nkMAcfYbxCpEPPQ5DwIbBpnwlo2FBYfMiuVsBsUmGgJubzwcnA4ZVwE7O97Hn2tbZEPuz13ik6Egz4c3kAEYc7zOaqg1KJs351eQ0ArSNl1MQAfwFQCAqYMAyBkWiClYFKDXTqkYjwUhBuTjAsCnUMb0oYwzps0I30qaxiK0AKfZsz2LKgPf1ylgH4DBVIbiWWsViRIB3sWymLn4lrs6IAYQzMJTcKcryM3XOg2DHOWwet45WuV9As65UM7r9+t8RgD9JJ1d3WfYVUr4CTxeG0brdFcl9DVL5VeMuFDDw8Hbg4dMGCo+Cb+F2wUJqnW7/yi3w2/fRpF998zkLaCMrFcv1P7o5BGG7UvzjSwLrKRHmObyPRSQTrFF/oW+woyHFnQM2AEj4zTWi1KsXaifYczEJAQRLuum8K6cRNZnMHAs8UUdiuFwC2FTwVabdt56oAY0TcMQbfP6Ux4awE4BAICjTl7X5gH8sNEEP5z78dfwYEjvBicno/eHWPow/2kl/PJ+fHR2nMvJ/7RV8z/Hw/ejk9PhuKg32h8eno5Ofy6qlp4M90enheTDg6O9f2PNfw0O3w9/OQYVPh6N95Fe1TijGR2a0aEZHZrR4e85OgB+ERye5fz5FucBSKGFSd7qYInDxF1G7eOURCX4ikcRiKRA7P5mEENvVscXPfkNgrZCzc8tc8c5R4yhnABSYA3L51dHpipMr5uNUu0yzLtftYXRTVJxP5EAZ9KCOWpxd77yGGVKTxwc1jVZUY0iok4vG7wUz8IYNuEYLBj6KtNyyWYaK2Tao8rFDKgZ15txvRnXm3G9Gdebcb00rre8qRRhYErjA49jjoOSBM1M3Xj9lLEZoRZLZuNgHp3VlT6wMz5EgaBYvi5bp0MNkGfFCUOBgNAyNLZFFpabycXFaYjMIFemZJDnQOdMSWA97GB/cMwGWTngQ6jClKch8h38qyrjfnVzOaVV3yy+CqurCrs4hNo/3ExlbBJU87bzw03I3e8fblLSdQ/jU8S3IMAPdRp84J+tEXtz4X8C9bydjdK7E/k7rbHmz8Y5HfOQ2JGt0hRPc+smWkM4K2JwPDhS4bJ+cfVdyJGVBMQIIS4hFcDSGFfElU6q4VBeCe94JSdnFCVzCf2NUbKG3Kwf6e8Jv2JtWpoP0Kz8iYfpGpu/zsYFSm9fkfhH2HlbJO87jOZ9kXAZmv1EQ/eUXq5+UXJFbrGTTAQDiA3Q3sYG/m/VS7US2DU3wHOIek6BNS6hjyAcfat7Q/wb4t8Q/4b4N8S/If4N8W+If0P8G+LfEP8/D/HfruP6e6EEXsOGcQyattlYJGmscFeX9ZNb6wfiEdDuJKlAZfl1dL8KHwFZsqeDR/TiO8D+9izmSDCYIJV9qGhRL0C3094sKzLraipX7WbwRGeTveUBGzv79pwxFnb8TyBrFDyskAOHrAow8TyPa5oVrwWfvNrY7W1PX21z3nuzvfl6Z7I75VtbG7s7u7h/yVsAuQdwrsPjatPvBYyD0meh9qFHfgeHQBKC70kBavzxEE4yHplFtmxuptOX4S405MVv947Z9msWcjVL6Tmf3XGCap+dVCYfCBlguRV8BExX1k6vssnJ/vDd4OzglOYN/zkbnsAvlLWyP3KgsnzURFrn+po0dgbQVFaE4A4cvV86qS/BIMDfckFp/zJLA85kLk+hhmu9pkZZtB3Sy6nk2y177LnsiE4L+AE8W/AEeHo+p8PiL4GciChpHzhPvmRzAFkRv+iwQRBINJKHjADEzhGAaNgphNuQOU0hlQVtSdRpgigk/TtwV7iy2hsFnhyUOwWTAzR/OE4GfpKCcmRmOQvzaHEquv4Bna3nqtqdlpxGLl2qBGe2uCsS5sM6jsHDDACVycQwB0fYXQaAR2XlcsQqwyTB3QerjAVIwDOemkfk3XEI8NMm0/IXV8IlH9FLi0bUG1k3OURyfIQqu1J5d2WJn7OVJneb3G1y9zG5e/fl2K1wlqnP5ir1OVNu4zUOnivUJ6boUTrbnf070RvXkbSN21GkHz+eut3fuB//c5Qx12/Ej+xQvqL8IO8P+3xCk9Wssyp9gQqSH60FU0AiEfRJ70JjcpR11dZqazC5nUgIUFVDEXHKRlv5caEnThVNPblpsUALo54lbgHJLlsSApbPLTRMsmGSzWjUjEbfz2jUMMkmd5vc/Wvm7r1MMteKssXxJJMuFjxe2kjLviuDtZxBAZZ9a2d5ylFX3WUrKIzlHMurMgdv0tucbE5f+2I74NvBq63dac9/1eM7rzdfb062e6+98lh/XuRxnmTVnCr1t+1HcjGQOPwukSoILpNoHVSX/8C9sZgirNHqesabwefg0suCO26vcsdDnYBtIBi4Y7xmefFsfIDyoWn7ART85r77xM51jE6MIqWk9VTxWZqkoY4NdWyGn2b4+W6Gn4Y6Nrnb5O5fM3e/iDpuP0Qdt7+AOm4zpFhTpFh/JHUMgHcgNZtCp4ANfgruVUgbIzAFfrnVx2ybA49nIsmJXoVF9nZr9qRqzT7gLjRHlkxlJVIV7kJ4g7ILLBtnZSVuvZkBRCoGqCWB3WJUyYVAToq7PEK5kJTHaBDIjZftwTQBq2zOZPGWtyKVH6agIYFCqHHtFXfHSggnMUX6BxJoHXQGQP0N1zhdb33VejAbo8UHaDEbfvaFwJzP13936nYJjHBDCcLFie3rNdsF7Jo5bldS4nNk4SunoA1Vb6h6M9w3w/33Mdw3VL3J3SZ3/5q5+wVU3bGh9VQdCjyaqkPZzgbLudQ72vD5/2bslCpOAwpvpn3i6kHBwYlXQCi5+wkRQ/BCtb7XtWzddG+yq95uu7U35XVv8pNHuA/ZThGsxmkcgqTsor4b6EjowNsOj2QnO8ik9DXd1ne1VQNLuAs1v+YwSH2aVgyOR24e0iH3xxIj3MIhNWA7w+2x9fJLAe+Vn+1Xp531VkwLdxG7aKPHoGYEU41nhkp3KLpWbATbzuLw9iF7ftq6zw4rZI0dde67ty0oz0DLO+ah+pfFNYMnyMlt6yuXDRbjDH4N6K00doTFeuyt4DFd4IgbZJ7/+PH0BZshEyUkSA2SYCFx6gC5dAwhQkg3yDaLYCUafGKdzuz1lYPKdhzMLDYNwWB2oU6EYOelc1psDJhNLsVKgmACaz3umkjwUJdX6q29/rHN9iUCFJ7PoTLORJoBsvMos4uX7HqqEv/IpLWttDZJMy/uaGFde+7b7d0+pDeK4KEhbz25cSuvXZKH8yt4glLv6oCecHpUN1H5Wa89WY+KvDbKq+pxoT7OJQyz1WrMohozczqaM2L+XGsj/skYhg6mwTldBvpkta6x0TZlRLu3UVKpbZtsyzaQRtLvABJD2WDiExy0ibNou3xCKfkr9Szk/K901u/Xis30+BzGViyJN5o+WWdssI0Nti0GGKe/HbowsCC30QbCARsAe0X/ExI4RUuYZ2XVojqJ71IdHBp8UJWkmKhv/+gXAOd+MXqBpfMyAMHIufNtZXgEysmi4zhlZ2WrBXc9uKpvqGHYvOM3q2/+zROH0j+bvWjxoFhUwaM43xql1yDJnwd3/yDEa5Dme0Qax4JxcXJcXHc2LM7juUOCT7lJYPWmgG935L9y4r849p6d8Ty/Ke5Edgct689ZftXByDtHIf/Ak4utlcnrnXN99nTdJR74A2Qhdd3MsIxnlpivrubmh3LhLYEyzaygK4rb1sti0A35AVV/LgWtA0XgTST5LYQQvSDIhWjALoe+J0Ez8ngMsclh5i5DkNdhH/FctQ/ZhJNs3H8NUvF0NDV7Agl1TPfC72c5Clx5sQA/JxSZ6YJxQIIHEjmQxk/teOPOoluFNDH2vFYGvogQ6IoOTTfjhTma4gcD6YtSvj7QFqSrcV8LwJGlsCsMGeNRbsR8DPcKFjwkG0CiPRdhhJEBKQa8uZzMH0anKxJBmHKfqHQ867pKpotlQQjOam0wbHVgco+PIm2SBVclue4qgNUr65dssmTFYeyVG0byTybNZf9/w8v+HXThlLsb4SoyXehilwDsesy5u3EfE6Ffuny/1h4sUwwOMMufQ6CijJsbHFlwgeIWHwPc4krX+WWx/kADR3bVQX5EeW2wPs9w+AV9Tq3c5l9rVLaArpbF2pkHPz8JXHLLDcOVlSdr0dzz0tzz0tzz0tzz8re45+XLQbYYGYgN2+9PhPv2vdvw0HZEJau/spMDMdrWsN+07i17WfrOcHyG5GviLpVe2C8mMb+Gh/hv37uA/+APHVnqB4Xo+Y2XfX+EMlZstv5Tt/zhfsDwBsX+B0yn/Wo= +sidebar_class_name: "put api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Body

required
    fields object[]
  • Array [
  • ]
+ +The ProvisioningPolicyDto was successfully replaced. + +
Schema
    fields object[]
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/put-saved-search.api.mdx b/docs/api/v3/put-saved-search.api.mdx new file mode 100644 index 000000000..d4860b9ae --- /dev/null +++ b/docs/api/v3/put-saved-search.api.mdx @@ -0,0 +1,167 @@ +--- +id: put-saved-search +sidebar_label: Updates an existing saved search + +hide_title: true +hide_table_of_contents: true +api: eJztHWtz27jxr2B4Hy7xmJIsPxL7Q1tFllO1juVKctKr43EgErJxoQiVIG2rHv/37i7Al0RZvtz1enfDu5mEJBaL3cW+sACURyfmN9o5unRG/E74bCR45N06V9uOL7QXyXksVegcORdzn8dCMx4y8SB1LMMbpqmHph4N9jn8HP5pa+tsMO4dsR9UwjwehipmCfVk8a1gX9R9KKIvTE3ptdR/a+tz6Gw7ai4ijmP2fRh1nsRElqVq25nziM9ELCIk+dGRSNqcx9gUQgO8Sd9Zpr1/nI4YiX8nQscwqq+8ZCbCuAHQ2rsVM+4cPTrxYo44dBwBf87TtoMdZCSAljhKxLYjHvhsHiBM2zvcedt6u3/w1ttvH3oHrR148vjB9LDl7ezu7DpPV6Y7jPdO+QtEXyZrvCQCFisG3GuQLlLlqTAGArEfn88D6ZFYmj9q7Py4SrSa/Ci8GDryIBhMSTzLLfMIxRtLobEfSGozTf3jBs1LWTJFQbR8sXfQ2t9zp+Kw5e7t7nF38nZPuN7BZHd3/9BveQd7KEqa++oRqalSK4pjr2HDtC7PHVAYJjPU6063O7g4G193B8Nh77Qz7g/O4PnspP8egKCxNxpdnw8HJ/3TXv5h2PvHRW80vu6cQ9PHzqlpQTz4dH5+2u8SJnjrdj6cd/rvi4/XgGzcG+KX3nDcPykAn16MbMvg7KzXHQ+G16PuX3sfOvCpdzbuj097H3o0yvvBx97wrHPW7V2/Hw4uzuFT/5hAfig8FkjPPlni4dNp/6TX/aF72rsejTtjBDrvjEafBsPj6/MB8ICYhgPqPbygv0aDQtNocDHs4tdx57358xo46b0fDH+g19HfYazRxSkONeydD4bj/B0RfewPTlPO02nodMf9j4YHoOPvhrUVd9MBNwPzZ31Bqho4xRpfjscDzXQyn6sIjflexrcyJJC+DzYj48WZumcynEYc9CHx4iQSjZLWFkQJ4PTpOFZj1CHQ1XWmIf2UFKOMm2xjs5Mo+ZhLg4rGv8oJQ6r8oZiKSISeyGyp71ep/SrRufuTVjjwwmO0Og1PUpdN7icyAOaYTMA7FWiZKBUIHq4Q8+lWABXR6pgM3u+klpNAoBPk4UKFgk2S2IgamW2wMfaaShHgfAcB48E9X2g2EWzKAy0YR2ZARIgsVAwaEZcWMePlwQDQkMx4bGiJ5YzUwxdTngTgcgljQQ70/gSTtcmnmiBUpTrYstHFVajQsdQc5OIz7nkqCWONIi+hrxqt8OXlg4ZJEOBYq8GugoinXD8LIfoM+d8sJi8SkBOsMbIsXSjN2j1MmwxlLCG8LZhF8DI+piqacZhVBzG7ONllHW/tvHVbB257f9xuHbXbR+23jZ3W3r+KrgE6jiWx5syUL0EN1xAfgMN5hoO08/+DcBn60jPyr1ZPnapKD7mQXmqcph/8ze5vpclTKtSIRxFfoO+KxaxikB64c8i/5pHQ6IQgfcSRvCQCpxbDjObe3I4HyDu+L7E7D9gdDyCTYjOwarB47vsESDimCbp3CgIKXAbknNC9UWVUNiMAJRZag0ZOZQDy2HasVnMvlneSdBSBSYaYI9LrnX2wPtQARcog2EJ3nU9MCSadin7oiwechwzusgh49YQpX5DMwjUzZBtR+hPMZIHpEITwSs+FhzqljbOMfPCw+VTdioVxl9DHyl74rxloFhMcANI8mGJrA3P48ZppKUHCQiASR+y6JMrrbfpQEOWi8Ikeb24icUMxHV8LMqbXO/uQxil45qHPrlHM19W5IM9U5LwiK1xVyuf9EoWXzf6bwDY5bsjOZYDzfSu4vy7zJbVO0RrATXg/qegr6xnkS9mDIb+QOXRJZwguQ/CYat2C1giWZceXeh7wBTnwnGb0/PiZZY49hRcukVAALRJ2hUPC2idat+4xroUgWKLRHZSdzuU/qGlE/DN6uXp1G8dzfdRs3t/fN4QBb3iqeZMAR00RNkURRTNKM6bmfqPdpKFcXweueTKSNS+N23gWfFf8/prpBWjxA5tGakaTY+g5Hp1ump+/pDHylW+jJnnz16gKJLw19m3arHkbFjDg3nAZQkgBi+ZsBsmJdE0OZAivcsDLUWRZ9/PVbcETpbSSHyIn8q5i6kbgCthkgS5aPNiULOZfwR2Ab/GEj9Jm6o5yPFjuawD/wqyJLX5RA06ZeHombSlpuoO6YbV7KiP7fGV8OLZT6kZ6i2S/YI4SDfODsRCFEudKDV4W5kk/Hxw3zEVmilfL/JEWBaYC8rjC+/q1fxUzhMZyQzUGYCiLDKYZv5C+oXhKa4NHh8dAPWTpEKu9QCV+J4EIHMkY/PudGKkk8ooL894/+6PxiDB4QeLn7JgY0kWbKYAPO2fvcekZ8fCG0ATq3nhR8pkAgasnDJp5LvnirpA5Hbo7bbe1g3MSAj0aSM4ogpi3DN9uATDCPxkNQeYaabZvx4WF/QdkEMQ2o5LaX4fgD+eBWgjKBLoqgliKuWEHw6Ngx+C4vViBk7xaFQuYTQytJc5WRkBYVNrNKXdaJvnWrMyogwn+/7vULFOSdA4Nx6XsKm1Kg9wJUZYu3bNJ32wABIrB13JgDCHV+8aKCDM1qkj7sYlNQIezCgFhb1R4vGLENgp2tTyS1buNGQON8b1mIvTnSppq5vrItGNWAZm2L6PvY+JNVV5p0KdocUlN/QpTu8xecdH//Co6n7l3KC+naHCr/FJTLdlvk2zhy5Ds4inzHVUSoKYKM3hZECsKJM356U+bf1r3tlE21tPYDjqLpz9PIsZL2My0qCjpsjjNVwvpc6GwcSxik9hWtpqoUN4soA96rkJtNK/dalVL3db8sVCwVIertwDqLYB6C6DeAqi3AOotgHoLoN4CqLcA6i2Aegug3gKotwDqLYB6C6DeAqi3AOotgHoLoN4C+P0XqustgHoL4Pe/BQBo96qq/F0IqzDRvSiCyOqyYbpwk6VbCaDh/sJoA+ih9H/WDkBZ5X0ivav8yjJ5mdgTGQr3JoKcEygURLIHHTGHu5M+xoeZirC8hChTWyG4ct0QJNHYYe+4D/wa/rqWGZySiHtfAddLCpgXoYT+LO2CFVjMUNYMK94IPjloHbb3pgd7nLff7u282Z8cTvnubutw//CQ6jeQbPCbyiSzPPR7EYpIeuDbPZiR/4BAINMA2ZsUCQd/+cKScLxA/iaWIGzGpqUXjPMhhvUwe9c9Z3tvWAD2nNB3frMkhNC9GK2sA4Bzg3gQyRsZPrdjctw76aRFfbuTgLiqivTSGK+i3ZtbdU8UWwaw3qVFQDlMg21ZrFvAEA91EVCaN73QIExmTRp62NErehRR50u01JTIbh5i9ko2RGMbnBl8m/EYctoJx5xdGT+71YHEcx67p1aSW3YB/rrBfmZ2UyicZqJcztRTL3JanBRyzw/xZj2BBDIB4ojNohVm2mJJtPMDNBvJlakbF4RGIl2Yyo1naqwqwvSU6vAy1sy6I5wuDY4nTOEyj1V0t+TuPhhijmNFbR5P9Avs7jwA9+MSa1nDnbDGR+HJeCOajXSarEeCRtoows4WKpuu1PDNgqa23dp2a9t9oe0uNw7t2QbbSqnPzmrqcxFyUxLA4LmS+mRbdSmQ2es1E7nNQCA2RfrbpzEY9lcRIrx4mEublv5C+ZEJ5SvEd7L5MN8n6eo4Df35XCCBJEfDwRQ8kfCPiO6cYhKUEdXu6mgnKppIUNCwIkUErxmxhUqw5s6iJAyREq63ma+EDr+P2S1kosyUUYwHlLRwcbOVS51J1plkHY3qaPTHiEZ1Jlnbbm27v0/bfTaTzKgia7F5kk5mM477yHQo0LQjt5wBAEtP2bLM5AoV3jxbQWQsy7GccubgTNo7k53pG0/s+XzPP9g9nLa9gzbff7PzZmey137jFGP9ZW7HmZGVbaow32Ye7ZZ3hBujSQjKpWOl/HL5D8QbiSm6NToCl+bNIPMGFS1t7tg+rCjdKsU+8HCRZki6lEOGuYzQpwHsDGGjFJZ2lm/AL4Z4GFkqU2aXMwFYaLMqkDNJxotcAN5o4XamWKE1hpKVrdNRbD1bkycIFGbNeBxPApNiijkfYKAMFre2f8Hs1E7Rz8rk2RA5PkWOWe/BEwINPcvc96vqu30gPkIfMTITvKbQa1Y7PAQFgAWB8VlZ3lnn53V+Xsf4Osb/MWJ8nZ/Xtlvb7u/Tdn9Cfm6zofX5OQC8OD8H2EaLZbnUCe3q/9ppOpmKpYDUmymPzkL5eQ5OeQWokv2FQvQh+BOER06TDvu79uSmbj5K/wlaTdpvCEqiAADTU6yPME8wP08NPpeN9KRiqO4bnpo173YrvA4eDzAWBn7LTzyqNnfO+3Zt0SDpRhIV2Hg7GsDI2p6TcDTInOrCz+JPTzsvVAL+jdBs49kvq0z0Gcicw0rie23PBppTaEs8Am8XUfC0iZ+Pu8/xYZCs4aNKfM+OBfAMqFxiD8m/wumCCU/PRl8APV3jpvBsI3y7KsKMMC03FK5A5qEGl3LtFYIGCNZm70Bb8FQd7W68+tun8Wt2g8koOQNzLlpIXD2AOZ2DGpGz66SVfuxE8SdSyQ0d9med0l4KGhebBiAU9jkcCcEui/fjhuC2SezYSZCnwF75OWtf3IkAA2QjlzYqp/TDJkixyUv9zK0CWjXI0Fxdga+Nz6FrDzpKDOoIY1mkRSC7nKd88QJf30rEdyk212BzCZt+vUSFEe2lZ87meJEgsfBAk7S+eXCDzy3gwyUWfEGsyzSgJCwd5R0wL521b6ajhM9FfGU6Poef6HpIuRszjo1pCJSBz/rMu1VKiz8zhqqDpnJJR+2/mSy6k+KSRbjtVoEk1wzpShfyRqLvFAwjNMrEJxi3KW1RkNGFvjHbLzSz4Be+0CWRLyWe6fMlhFeE9JWnv5lmHNDFAV3jJ7Sl30QvVCywbeTBXGwjBejm80+ewBJa8IsGV6XnJ/RN6oPhwwNSCYueH5mXo9wJ2idGDQidwYCbdo6cfE8Q3pnFhSGsJKy0YLAswVV6AwWRc0luht6sYIXR9LfGL3LcyesqgzBY/NJeeo0n+e343f+Tx6s9zR/R09hEGOuTw/xXrnvFizfOC38ZovDDENYWC1fzCc1L7qBnF+I3Q+cX1u2ZYfvb4at3nJe9QRVEdvvkudu4+ZXh56Cy+7nle6Gla6G/ytW97Obe+rts+VW24tWx0s2xb7h7lV69WrkCVbjxVF86+g1dOnIw4BBoesm5EObMmm61zq/pbjz8Ca0Uq2nNzb2YajQrv+IBehBjVKOo7t1KQRXCOcgftW4bI4uaUSQG4nFShTaIbmiOInBZPOATGQC+BvuEdy9ApyMsv+CZKsD6o7J1mBEYwDldyzhOXTcsoWazJMQfzQAikhn+ZsQm/w7K6yUmDfFUGIqUM0ULuaxXGpMxcKAoGqmMB1PcSpKoyM4LxwIvru0+EggSZyT1ahkjQxFQnEG48iJ9E26IHe6tCOboaMFxwnJKFEb40B+vYARkoVVXFd00bSfdRFhAggURowy7jVajRT8ionQ842EB76Z/dOLzyg+MPOb7aL/aP1lhbQQX/s05lrPpOpMpVpjC0KVTLgxBpyPz+y63wDO2Pz5ixRPLJE/42Trfy6u8CkLuPvOzaeBay/yrob3f8ppt+ucvKulPi/bhIq/XOfD4VWBQAOIpSKTRA0gzDXbjzx2bH7FJO67saGIsMj1MbfdZ2KtCve38AlVtYv9BjZmpHEb8ntzuPTx/hv8xo5gbRQcg+g7O2FaPAcagxf/+C28nuh8= +sidebar_class_name: "put api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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.** + + +## Request + +

Path Parameters

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_. + + +
    property name* object[]
  • Array [
  • ]
    • orderBy objectnullable
    + +Sort by index. This takes precedence over the `sort` property. + + +
    property name* string[]nullable
  • Array [
    • + +string + +
  • ]
    • filters objectnullable
    + +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_. + + +
    property name* object[]
  • Array [
  • ]
    • orderBy objectnullable
    + +Sort by index. This takes precedence over the `sort` property. + + +
    property name* string[]nullable
  • Array [
    • + +string + +
  • ]
    • filters objectnullable
    + +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/put-service-desk-integration.api.mdx b/docs/api/v3/put-service-desk-integration.api.mdx new file mode 100644 index 000000000..e3b5f91ab --- /dev/null +++ b/docs/api/v3/put-service-desk-integration.api.mdx @@ -0,0 +1,155 @@ +--- +id: put-service-desk-integration +sidebar_label: Update a Service Desk integration +hide_title: true +hide_table_of_contents: true +api: eJztXf9T4zYW/1dU3w8LOyQkISEk3baTBfZKh124AN3pwc5UseXEXcd2LRtIGf73e+9JcuzECYHu9Nod925a4khP7/v7SLKUByvhY2n1r60LEd96tmBHQn5mJ0EixjFPvDCwPu1YjpB27EX0sW9dRQ5PBOMBE/eeTLxgzAqdvXlnNpqxkyN25yUTllI3h91yPxXQiP10cfaBuWE8ZVyyZCJYLH5PhUzYKHRmdcYGLAk/i0D1PovHbOBMoVsYF4dTT3maTMLYS2bMk0TIi2GsJGTctoVE+vBcBE4UAnt1a8cKI6F4PHFApihNNFGkmRd/x4p4zKciETHq6cEK4AP08Bz4ykN9RDyZWItKAqlDl6RaqRtgTukEOhuOrX4Sp2LHksnMx1GkN418bCDuIz904JHLfYkN7ImYcqv/YCWziFomMViCWnLq07c4yvb4+EmRB82+BcVilyKrl8CkjITtuZ4tDderGLVD+CJIkAqPIt+zqcnubxJJPeTY4r5/5pLCNIPh6DdhJ0uKWqWeVzJjij7XC1q6VmYoEttRQ+1YPAFljNJESPTeKEZbJx58Ar7AbiVKW/DwwPsdfdQBSYEBEaObrjVmQe/7rV67w9u9feG2243mQW/UdBt7Ym+/tdduNu0D63FHe9GiKdYoAzvUGdoK/2LTFANFsJRYrRvZS/1gVWizD8gEMGPHAkOzTDEYnxzMbaH9a4m3pHTlPzojQMRBi/VufwfRbgbMc9lqtNq1RrPW7F42D/rtTr/Vqfd67f8ig9PQQTv8hRz6HPSbDbvMZ6vWPFjmszDsM4yba7jelAN2K+IZC5DOSl98NBQ25YBhc9m/CW6CmiH7Iby7ODp5X3xyE5Rw5wiXp34yp6+7lvmg+QpYDO8CEQ+F+5xkcYZ9QF8qMpMZKqsY3kbw9QFu6BxdnpHsSEcE6RQTy8nR8YfLk8tfMHXM+c+eAuebpJBFTqEM1otuZPeaBw3e3nc5d4SAPLHvjtoC0oXdauzv9fJJYrOhHE9GPp+pTFFUfhpFYZxALQDreQk9o15HSWg9fsIM4EM+ebY5LsI0BnfSnV9qjCKVUpscnl5dXB4PiyYxDze0yMIw5fY4aHd517Vtx2k0u5x3Dnr7bs9tu/vu5vZYGGi1WS5j7gUIn34eFEyjCByq/osmWo7qw0yiJ8sU24oFMGMDNAJkNjf6DkCmBJiB50hixO3Pdzx2mB1OAd14I88HF95en5ruZ3/8Mev1eqSPKBa2KikKzwSp7/MRtsPPmNF5wMfCUaLKklSllHhyJJ8pFHjgrSfhMfB3GAauN66bsYZCElUQWO4wwAdzqSciFhuKzuOYzxD7JWIql73hsUz8TEvXxs/2Ok6z1+QH+41mx2kdtDudUZu39lqovpbd2c816XT35016B609C91hWc5yZPdqueErpsN0ZiCWUADcpq9TrdZUKgSdEcgrXeY0kmWHYvQDNIFiJbn/nvRf4rkX2eh3EwEMxAqmF9mAB4YTZciCic2kQbkJJC6mbAyf43BKUoXxGGYTJ4Br0RYsMHScvD8wDg4A3cM74eREG4WhL3hA2JM7Z4E/MybNqp4G5JmJiw6eH2NZAfAUHC9AdkG8jPOnHB48Dxw+ATzI3kNmCYEtxILGmA7zXLaofdQjsbrOlZ+Z+N3FuVgpky8sC6YO4IxEzseTejxn3XimblycXQ0Pj4tlQz/bsGqoedyzx18sK2XhPoJw55uXlR9TcKkauiEmUjUL+FOs/ThkAzsBL2FHMKmykzCeFcvQfEKs7K3q0DyXZRxrlSqNGpE7JLLd6ZHI8JcYNTpN+McyElvvZ0x7UhP08AJyLfinjFxLsQpCByeBl3jc9/4Q8QVpsyxNQmzA/zkkEx2PtHLAsD8oMiPAVK+y1FcscIser4y0buRh6uOshCcqCclikvMCcIrUJmPaEx6MhVxfjN/8cD/1ca6AFL571aw3XjGQC+Yzwfi7V1eX72oHr374/uYmvrkJ3nxzdHZ4+cv5sWLi/Ort6ckhu7m5sST3fLVg4iQOPih/auhQd7TFd/j0WDFDRKkvckvfvBXgreI8J2COCmNvjuY6+l61ZfnGis27iWdPjDIQZKH2Jc3wRKD+JhvSHG5Wf7Obp5oNpfzl+zffXB8eDS4H1+oLb4pwmc0FVWauv/52/fd5Ls/Bd+oD2w7TIBmqGvXnetfPzIrVs+mY5ZCX8fHc4Rb5VP/GBLXFiiLh4lz+Y58irj4WSbGd3Npm2+zBWA2q29ZCV+xzFm1t1+EjFLkttswVcZvxVj9SHsMKlNkiWUlkn6b2nryMbX9rKD1+UWaPg7+A18e8uRj79On7N7s6PmDe/4ilIQjz1I11lvPaB12cIH1ma3EquwHQCwiIzUMWoY7ktxjZ0KVkAKY8jVBiICCpkZsoyCZheg0U4jAdTxR6zBW+UiD3FHCLlhk4vo88vbayJOpHFEizH4nAKWBSWnNGKZ0dxRwMDvMNJTNglBHIAjJPQMvFJXCsCQqMYhbzsUiPVCb06EuAyNJzBK5xC2QO/ouZD7CtHwaI9rjrksqohOFcxvMXVUKKAlieW0KDR3utfCHp5gHB+fKU47Gw2PqcJa95tzr7Gcqro6AKCpbgvDhB1QFjelpHa9LI0xQMvihJVoW543j4HffPc/V3YQ72YIozYHmLdiOg52cx/4Qyj5ZqFFad52DkVZXrpXh4ZSUsWzAZXp0uwF56siHoXTnU4qJJo30gRntOp2N3eLvbORg5ja5j26ODbrfdtLsHm6NbIr96qaSMo4EXJ5QWyTJ5R10GGNhEr6TQhkgJxs0tjFNLJFjclqEHMgIPVXZrNRorXX6ZIu5y6T2wah+l2kep9lGqfZRqH6XaR6n2Uap9lGofpdpHqfZRqn2Uah+l2kep9lGqfZRqH6XaR6n2Uap9lGofpdpHqfZRqn2Uf/g+ClBsl22VHPoeZp3jOIaaVmNDkaRxoGZdi8eBGCWkW/Tv+nN2T9bPrB1ctvAP6VzNU4p9B/mmNo7VMocglgEG6kk0ZaspalaRNKdoqF3RAqCJepO95Q4zWflQC4OKj7n9GWidbL65Yrowz8kmvCXDiq7go/1Gr9V299ucw9Sp2e2Mei7f22v0Oj1aJp0KKWGKm1+MMTPb4tD/hvIRezbkSJsAvQO24qB7YoAGL1nXWWEDorGB/nENRrXNxNT8wrTsPtkBiPr28Jy1uwwy9Til53y8oISgdnWxNMkAyRXhs9gbe0HpmSqdDo6O3w2uTi/hyfD4P1fHF/AX0lo6IjfA6Y6DbhnqwnRHHGsBcGNECh/UIZw6e62pvgaBsBznGnq6qs8kKJPpigs99OglPfKk50s3JpQobu4TtuXVRX0HSiFuzvAEJgAjjmtDOMeF5q8BNoooqZ1qTb5mE5gui3i7zgZZZVAH+ST0p0UTKBkYuoqAm0IoCzq5F6YJlNMEkkPRFnNVLk75TE45zRsFgwM4f9pPYCoOYJB8ohCFmbdoFrV9gGeluYUl5ZzSSKUzqJYwb4SW/gzUGONEn5Y+vUQynY7QXBIST2DaZRkrn1Qp3b1XzKgECfmMp3KDuAMY6gU1Ei374lbo4JPZGqND1jBm0hkJvkSxqbNulZnLBD5zPeE7VexWsVvF7oaxu/jlUL8gkoc+zWXocxXoA8tYPJegT0zeA5MQ00hhemXIHTwBrSHSTx8v9SFpnCGpCcwXxEeqlC8xP8jsoZ6PEH5kxirYAhm8nc9KXMhEwukT33OOSVFKVXvLo70L45EHDhqUQETImjGbhSlNYeM0IDzL5Q5zQiGDVwmbcMiP5gh4mJ0Cr2XHwCskWSHJqhpV1ejrqEYVkqxit4rdf2bsrkWSGVcULRonyXQ65fFMeZr+nnYLGDRg5lVlloWcWpVdQCtIjGUYyyoiB2vUao6abtcWbYe3nf29ntuy91u80212m6N2q2vla/31PI6zICvGVM7eyo7q8hkR42ZEGoBzySQMneLyH71f5GJao51Ig5tB53W1DqmxY7tk/yRMQDYgDNgxXrG8eDU8VfvVeqMz1m+aIMxWqlM7Lggp0YfVrUcVdKygY1V+qvLz1ZSfCjpWsVvF7j8zdp8FHdtPQcf2M6BjmyHEchFi/T+ho+M5BM1cMArIYKeg3gBhYwSimBcdsrBPeDwWSQb0Ciiy1St5uzAM2XsezAxYkoWVyGCuLkxvIb0WPcu9uxIAR2NIkQGDrOUBukWvwsNTgEnxMJXvTT2KYxQI6Maz2sDFgwgqZoy/ZaN4ge2nwCElBXxNBce9415iXm0BCrQOOoZE/QXXOLW1/tR6MBuixKcoMTu+t4XAmM/Wfztlbwng+wQxposLZesVrwuoNXMewDRC3EcqfWUQtILqFVSvyn1V7r+Ocl9B9Sp2q9j9Z8buM6C6RkOroTo02BiqQ9t6g2VY6h29uv1XI/aBOvpIHJB7s9AmrO7MMTgoQQp46OFrxTDIFUD8Q+XKgzSZYGR6TtDXZ7RqeEarxvEK+L46KYjZaPH73BvTptUnfHt1KsBn9fXvmKzwIve+tbuqr9x98JxHCxlEJKqUkMY+9JkkSST7u7sP4BvgE491Hnl1c2Y9CO/qdjjdvd0ryXTq4BJ6KeRKR59NGpyf6KlNnSwae/SKP0UEDaDsa+4LyM6SrKVvTrrNYNbDFJkdfOFZOzA9ptO6wczck0EOuyQjyHYV+49PyfPz3jo5FJEVcpSpb+1Y0J4BlwviWeolZeNPFwjz1ehLXjUvXbjB0Foa7AybtdhbwWM8Xkvv3Gz99PFym40R3FJySSXiauHhbATC8xxchJLnwLx/gp2onpljFoINCm/4YLAy1weB2U1wIQS7PtFK+ABVZQhlgFSKnQRlHuz1actYxhG3wseCW59rEh0PAmIXNLTLC/22qbjSLMQL1NEFPA6AN1Wog4zo8tRGi0iTSnYdGbl4Tq6XMvEvQ62mqNWImtxe4EKp9tpWb4zbkDGQBPclaevFgyt6tRw9nLLBE6S6yANqQvNRfC/LNlZ7MR8FejWkV+TjJvhIx/SK3ZjKX0xC4fUddsLsSRhK8QNj6DoYBtfjFKLoxWzR2cAaRUSt1cixVFND1rwa4FDi7xQCI1DOxEeIAwgGhWpFhkLyV7IsxPyvdMTm14LM9Pgaf90DWjqhLV/MMw5YwwFrKgdIzb+qhuhYENsoA+UB5QCHc/tTJtCM5nKeolWa1Yn8LvXB0mADq+qsatRXH/rzBKf/YvQFts7aQApGGJ+9qUYn8BUtLIkFZZkFiEUNLvPrh1CJF/Sm+M22UbE6/93kRYkH83UavC7gS2fpFZnk75N3/08Zr8o0X2Om0cAa1zuH858COp6f5KMbAp68by27IWD9TWi5i9BW30aWv4xs9V1gSzO+Te7tys4zLt2jlb8rS7fJLqQqXJOw5j6puRLMbVCL1z5pyuZepeL9C6svRsoIF+4zWnVDTem9KH/zqyTW3CRhbnaoblyoblyoblyoblz4kjcurL5vIbtjZt1NBd2lw/lPnXtfd+xdJ1Q6Rq7T6ZOnv7N0utnxbUSVNJReaMxjWbUos7w5KOkuT/g3fEv5hxbquJ2on1/EpYo8GbwGiX66kX5hceIJ2laIoOojKzsIH8MpwW3QFWJ8vJsMCY0JGeANQNzn6lK4OvsoKMWnMa7Z4nEeoPpbqBdvLyBszzFsodBrfMYOw+k0DfA6SGAinTIOKPAJEAd51k7VXMMOg0AYyUJarcl6GeCN6BBVQbcjiHgqz1yNJnJY7YmxAKpJvfkMikSLaDPOBRkKdZ0Etiuusj1FGwBibSL8CL0NJkoikCI3wvuTyyWKQCzQbzyE8XhXd5K72BaI6JILHfbqjXqDkEcoE8AZObrmtz/Xga+Fy1uzvfev5IdDdQDj0uFuhBtsqKlULWWqFeRra+UKMvTvQ8wDEpqAbrHpwwNux+B66iM+BkFwrf/603y5lGCdhglOdt3KSi1vDbUQ2+yZP0JaKpnZYAxm870FK0t4IAvdEKb2jIhT9YV+SaF2qW6SNh2X3r5AjKl6qH2otW3zS/bnV+jhI/2LplO1yxHzO3iI/+5bN/A/hPyRUjw0oucPltkzhDaKrFlgKVtf0H+AQaDZ/wA17I4a +sidebar_class_name: "put api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Body

required
+ +The specifics of the integration to update + +
    ownerRef object
    + +Owner's identity. + +
    clusterRef object
    + +Source cluster. + +
    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. + +
  • Array [
  • ]
    • planInitializerScript objectnullable
    + +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"}}>
    attributes objectrequired
    + +Service Desk integration's attributes. Validation constraints enforced by the implementation. + +
    beforeProvisioningRule object
    + +Before Provisioning Rule. + +
+ +ServiceDeskIntegrationDto as updated + +
Schema
    ownerRef object
    + +Owner's identity. + +
    clusterRef object
    + +Source cluster. + +
    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. + +
  • Array [
  • ]
    • planInitializerScript objectnullable
    + +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"}}>
    attributes objectrequired
    + +Service Desk integration's attributes. Validation constraints enforced by the implementation. + +
    beforeProvisioningRule object
    + +Before Provisioning Rule. + +
\\\\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\": \"RULE\",\n \"id\": \"048eb3d55c5a4758bd07dccb87741c78\",\n \"name\": \"Before Provisioning Airtable Rule\"\n }\n}"} language={"json"}>
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/put-sod-policy.api.mdx b/docs/api/v3/put-sod-policy.api.mdx new file mode 100644 index 000000000..17c9d10cc --- /dev/null +++ b/docs/api/v3/put-sod-policy.api.mdx @@ -0,0 +1,144 @@ +--- +id: put-sod-policy +sidebar_label: Update SOD policy by ID +hide_title: true +hide_table_of_contents: true +api: eJztHWl32zbyr+BxPyTuM2XdsvxlV7GdVH0+UllutrXzWogEJaQUqfKwrfr5v+/MALx0WHLspk2WPRKJBAZzz2CGoO6NUFhxIKO5cXB1b1yGIjj0vUjcRb04msA1Q9reQejb5sx3pTU/uIWxwvj48HHX8Gci4JH0vb5tHBizOLrw7fc0ytg1Ij4OcfrF+RHTF2GKLUIrkDOcBFOGExmyeGbzSISMs3AmLOlIYTOcpNarXHsD8UcsAxgR+K5gvsPOB+9+7R2d9s8qsM6MB3wqIhGERIBEuDMOqO8aHtyAb9KGz6E1EVNuHNwb0XyGV8MokN7YeNg1AgUfaIiCWCzjKFj/CJeN4FOGGIt8jTpiIe74dOYiXOE09p1us2E2O6JrNlvtujlqjUbmfrPe5K12o9ux9w3kHi4rwuiNb88RrUUsLJSCF+EtPpvBisTpvU8hYnW/TI8/+iSsCBkSoFwiKUK8C8Qv0bxIohIPIz5lhFSdWs2p86bZsbpNszlyGiavj2yz06y39quOaIxsYSAZ3D733LnC+yHh+pZrvolD6YkwZGc4K7+84rJ5N/8TZWTBMpFYSYvjB1MOfDJQFmYkCc6yDPEGu50ID+QIWpcTJHzT4IuSrFfrVbNag/+G1eoB/Vep0j+/rKJ76tukvH8Vjgn8ZyFZWHOTjM7pA3dZ7vKyIRTQIYvWOAsvjNFsLR9uSu5ZZLwoUFCS2HX5CKdoxPxbTwQD4azS6AWscOSrENQVzAP8VmVJ59X8jdRpOEfDc4Yjia9ePEWn1T86Phv2hz+jy8qIS68CvtvY1SKm4EcWhGd1a/tV3mw7nNtCNKu1tjNqimpt36pXwVUYW5tTspQtw5nL5wxnFde6iGczP4iMB4AJyNA1mnUU+bgOeHwRgLCVYYIkRCBAZE/QkmMNQbt7lsHI4/Hfn3/JFGdJDdSdH2MRzDevfCF4YE3YHzh6g17+h1sWuJnX0j7Ywq+Nd1jv7Ig9bZKzQ44KlB0UH5y1N8ZACjErfAIP89OZpee/PpWRHKtrCcydAnnf8xsBAXTKPT4WAQvEjRS3xI8o4ADOItO1IbyG8CFk4I/wrgzYteHHETIvs9Jrgwn47M+FWCUiyw8CQQB79o18koZkUxlXc/NEvOEhhH7fI7yTWI+fE2x2EwJDFk782LWB0KmPlJOcYCyP0FN6fsSScJoj9ZM/Yk7s0fqVVZSFEXjnzeSAgwaABDXnnoUHK1lIQIAI5JzJ8dnb88Hh8RFcOjsf/pp+LfiW9OpDkjqlaPAg4PMlLHCQJi5zuanLTAFfGcPeuxpcgb/quCRkb9MVGvmQBFk/6G+dMrzSkROw6B+9SPKgg9zTcEgmfSYSRT1YgdSN9F3Kvshf9sJQjr0puHSwRUeOEdFFEI/nZDyFMIjdlQqXqM5p76z37ngAVy6GvWH/0NjFlZby6CMRcelCCj1CY0a9TFEOGUVWSKM1LGam8QhZpwzq2lPw4eY7MCjw4hit3wV+PEN97usJBe5muD0azLnrnjuUmpdh/cuH9UXVfPiYH/jT44r9oLZNNihpni0jH3wz95aQtYWDuTxL/CNPvNKEh2wkIKtNoeWcZEJJsvdyeOxCpuxwN0RV2k7oS0uCS1RpwUgFlQCDqQO3KIjqeEH3jNyixrvjs+NB7ySnMtmVw/Oztyf9w2H/DHafh4fHFxe/vuldLPrxZDwFynTFHi14iFvnQPLHzaKo9K5wovy8x0dvp1XppguHJwEyYQpgDdNiK2KuDAsSAufsibkJO2yKFQqnExy0KVbhIMox9KQKg91OIFBKkLRI2lTUGPds8Ed3+KVVZRSnmFTZAKKCeg9j+yp+1eALv9NfWtXluLaGQ+v0KQvW4ApOjk/h7xX1CpiUJCUKLJUBbicS0lCKw0GS8zLatIM1gBkW43wGf0t/k1UfFE1PXVK5o/1We99q1btWG9zRvmXxttOtWrVGrbG9O/o+hnhhYnxEj1LwSs9DsWeDZEHGAeYS4Mse8hlMilWed4p1CW3tdq3dHrVGVaCt1u5YjbpwGjXebmdVoIUldp8BtbMWasG7Lhg9VprkeFJac2nNpTV//dacu3W4NtBvSsCygnnGI1LsHEimYDK1PdbDYcgNd2ORuYn8FFONMnVRtSj2U11HZEe5y4/Uf4oVm9X1jb+yALFcb/jilQJdGMjv5JP2hratj9vsEhf3fbkt1IryZ7otKarxesNP1ThN6xmhomrrD8VsvrBPXZvabkhiF5NTvX4aWRYDy/OM/5lWDpa3IgIXUAZNfFGc95+Hc5dcEArunQA5ppXVgvVvZdzbq1envV93unyf1KvRtaotse/UuONk6pVXqsf8xhl4gNRvFAq7+pveokn0emgVXGO7xsccrqqNrnYQhysKjdpiP64055xl0M6zUAzbhjf5whV6/M3+QI3S0si2mY8YnJpB0mrVrVrNHjXNTqMhzKbVqJndZpebnXbb6rYE/O/UMolp9VkIC2lPTTeRWmatPqx1D5qdg8b+L0a+o7V6xMOD0s5AhDNw6ipy1avVZbXMmsBsNFdlurK/WfY3y/5mWQgt+5tlf7Psb5b9zbK/WfY3y/5mGdbL/mbZ3yw7ImVHpOyIfG0dkbK/WVpzac3fijX/c/qbROS2e51NvdDFove6yuJS7XvdwDX9l/zlF27vbdt/KVSiiv2XXOVnk06y8wHbPKyzVFHa1BrbDm53Z30/qOw5F5pUW1pIvgKx7ZyytV22tsvWdtna/v9rbTdXdbMPISn0InYcBOC9TTYQURx4oJhSBQR9sJeNfJsKNdIDjZbU13yhprdN9dBD394iC34LmydzHHCJGApC2YKJuCO4kTbq29SHzY0CmcY0HFcsxAEnKjVI0mw20PQdamIw3wu49TvA2qasfelJmM+SKZAEpJu6FcuKjuCjdrVbbzrtJuf1/Wat0xp1Hd5oVLutLtUap6BKEHg39xRIWaTFXN8CifwpMERz4D0hQIsbW2/NCMYW/Me+txqbkqnxZXjKfhcymDeH71mzw1zujWO6zscLTPDMy4tVhWgF+Bxcv1zZ7072iUfHb3uXJ+icB8c/Xh5fDNcU2nseaKuNagmogi5MfJVQaQJuOeQ2wgV2CLvCvtNQvwOCIN/KD5TqWzgPgZlM1x9hhl59xYw8aOYE/rRgSpZ6JQF7LSuisstGeG3KI9ixjfJp2XfoVmaReaI5+R2bwO5PBDsV1rNtqbt0FF+wNTAHQOBEbTRdBcCJwZQBGRlNMEOEVA0cbFEWGSuXmiJ603OSFwoaB2C+WU96VhQDckRm3gpTbdEoavkAzopzReyGOaYRS+cQe8Djwkh3nvQn2Qhok1HItDtCcYXgeLxkXOqx8ns5cnenChkqvmNdhcfhFnb33gX3YxJp6Y0boY0Pt9faG5E0EjFpjwQ3KaXHyXpUKq7E8Bm4ctcubbe03dJ2t7TdxZsD/QyfvkupT2059bn0eAz8DSh4LqU+qkjq+SwZpLZqSpC72KXSKdIPH4Zg2L8Lj54suJvhXvgF8yMVypeQ76XyUNdHmH6kwirIAhEkPioKHPBEwj4gvDOMc1liY3m1t34wkqCg3ooUEbxmwOZ+zDiwLIg9j7p24S6zfRF6ryI24bnCga/qksLDl/BILyozyTKTLKNRGY2+nWhUZpKl7Za2+3Xa7qOZZLHrp/OkMJ5OORVLQdP0faSWMxjAktMk2cOeuYJwlq0gMJbmWEYxczBG9dqo5nQs0bR50243uk7datd5q1Pr1EbNOvZEs1h/ldlxamRFm8rJW8mRWAxJ3A3kcbEHyhVGvm8Xy38x9nkcdGvoetK8GXhe0dVvlTs2l3PHMz8C2gAw5I7BmvLi5eBEtaoVeOSbHwd4CCFI+9rYcsKUkppO4k49IlGmjmXqWIafMvx8G+GnTB1L2y1t9+u03Seljs1NqWPzCaljk2GK5WCK9XemjjbkHZiaOSAUoMGKgb0epo0zICV5bCA1+4gHYxGliV4hi6x3l7PIoe+zU+7Nk2QpLFQivYxd6N5g7BTHBslYGMDZGFykx8BrSchuUavwBC/kpKA/zJVTSXaMBAHcYG72nAioUjaT6Fu6ivQsNwYMySm4PtZefdAxCeokHEz/AALVQcfgqF+wxqml9ax6MBsgxSdIMTu+s4RAm0/rv61VTwn0PX1c9ELJes3jAvrBYg+2EeJuptxXmoKWqXqZqpfhvgz330a4L1P10nZL2/06bfcJqbrOhtan6jBg61S9hYctWJpLvaWDrF86YydT0RiQejPfolzdznJwyitAlfRP4aAPwV+hOTD20h/PAW+ydy/tB7in8n+FThy4MGwSRbPwYG/vHqQE0nmo8JmsJEewPf+2YvnTvZvGCp+Dj5iGySkvO1bPBvfe9/Umo0K8DSSqr/J1tIDidHIwOASO07MFj8JPjk7NYf/BFJhdPISuVYku4xPOsI94FerD3MiZJRqBtsvAfdhEz0+Nx+hQQNbQsYp9j64F4xlguUAeoo+PVevfSLrAhFutvvRLSVkQwVJ/fWmxcxxWZ28ED/DlGvT0y+sfPgx32JieYUYzx6OOYyZkpA57vwcVITfWS54EwUkUWQI/Hk8I8V7hWRs0G+a4QDC79i6EYFfJyw3OwL8PwCETS3GSIB+Asz6+TiRjixvhYuirZJxExZO2twcc2uOFeTsU5mg/ID31Dig8vXLtmexI6qfU1bkbTSJt79jVLKGL5+j6XCT+lUAzFTSToIU7C1go1l5Z6tltC2wXQXA3JG599uIKnpmDh5snuIJQF3FATmg8ik9IWYnUPhuPAjwT4RXxuPY+0AnH4jSmXFZyYKnPrInvh+LfjKHqoBlcjWOwos9Gi45VmmQRZr2aQ8lUS5rShIyQ8DsBw/CUMqn3fFBC4qvaCJnkbyRZsPnf6PTtbwWa6fIVns6FkbZvhZ+NMy5o4oKm8gGhxl/FJVQssG2kgfyAUoDDTP7kCTSiOZ+nYK306gR+j+ZgaLAAVYISzg7Ul4PMwelPjG7g6HQMuGBMqNNnxuA707AwOBWYlZQCFjm4jK/rQ0xc4JvCN21oYpz8p9GLFPeyigm+7ualvfQaT/LP8bt/k8crPc236Gl0iouVx0H2w4XHyWYkPW2Ye63lymxri3cnbn2i75E3EKXnw9L3Bz3/pPRf+GK98ozz4hnnhbe6fZkTyE9SqEcOHW915PFLnzH+0u+W2HQi+asnEDUAwy+pla6N5IO+2r0u9zOw4TYR8CfcpcyFagtgylSLInvLg5mB4mOMpxzHmkhBldCZ4BHuhHcxzvpTyktg+48qhq8oQ0BjOgQbgAPnLh9JF186xz6AMXsWhBwsM+EJBID6ydf1pguIOu8xaLGjJJDBhnI6jT18DRwgEU8ZGPimaGfL0IpVUgb674mEMp+2temsJEPBMIqsqFDBJZiG5w62zJRL2nItiGmh7pcBI3O6lhEyEPqNgTCuWI7YBBsiqTkR7gyDCBgzuOl8xDvtD5cg+ujLVZPWD8Z7elK4h2PxhYtAvFKGRqVaqRr0YtgwAt+ag3tJPy6cf0ly8urshZccp03CF/k9ZW0qWNfYm2EdHrGLVZ1FVbSujHxFC6YcgCWBj574ZMPG/T0WarG+84CX/1CRFE+nJ+UbsnTgLn7OjqWvJeu1xtjeoVbz5l9jXklD0nHw5lmx0YCPvwuM80AC+SxVRCYE1Q3dtTTxbUq5iUvtWHQzaoYqTD869mOuWPj+EvVnpH8GeqrKngG/hYv454FxDf9iFJsp7YVBdB3ihy59wxgFNtnnrdrm6A8gBxj2P9EaBKk= +sidebar_class_name: "put api-method" +info_path: docs/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' (put-sod-policy)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Update SOD policy by ID

+ + + + + +This updates a specified SOD policy. +Requires role of ORG_ADMIN. + +## Request + +

Path Parameters

Body

required
    ownerRef object
    + +Owner's identity. + +
    violationOwnerAssignmentConfig objectnullable
    ownerRef object
    + +Owner's identity. + +
    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. + +
  • Array [
  • ]
    • 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. + +
  • Array [
  • ]
+ +SOD Policy by ID + +
Schema
    ownerRef object
    + +Owner's identity. + +
    violationOwnerAssignmentConfig objectnullable
    ownerRef object
    + +Owner's identity. + +
    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. + +
  • Array [
  • ]
    • 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. + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/put-source-config.api.mdx b/docs/api/v3/put-source-config.api.mdx new file mode 100644 index 000000000..a7ad2730a --- /dev/null +++ b/docs/api/v3/put-source-config.api.mdx @@ -0,0 +1,96 @@ +--- +id: put-source-config +sidebar_label: putSourceConfig +hide_title: true +hide_table_of_contents: true +api: eJztW1tzEzsS/iuq2Qcu5Usuhmz8smWSwOZsgGwuy0NIgTwj24KxNEiaJD6p/PftbmlusZMAxS4Has4DZzIjtfreX8vSdeT41EbDs2hHKyVip42NzjuRzoThTmq1n0TDKMvdsc5NLGDQRE6jTpQIGxuZ4Qj4fpol3AnGWVwQeWSZpRn4Cqaw3Eo1ZdLBe5rIFJ+L3ns1Yk5/FopdSjdjb49efRjtvt5/w3juZtpIt2DSMiO+5NKIBIaymKcpczN4Ozrc7wEnGTdAyQmDUlxHSBY48ou8wT86kUQeM+5mS4yfzASrhrILnuaC6QksICpZeuyYhiBpZAc/5kp+gaEyYVOhUFXAHXfVHBYbQfpDFgv+o6EzuehE1i1SYlLOsxQZFFdZqhN4NeGpxQHxTMx5NLyO3CKjkc6A+mgkpznDiB9XIt7cnPtVhHUvdLLAmbcXBdacUA4/zfPUSdCb60+0mXfBdrTW0qp6/AmEaQhwFk0kLA/LZQZ9xElhcQa9XcFvU92VeprOcTVPGVHoRMgRBy6jsVTcLEA0/A9ZsJlW1q+2sbaG/1u2Zd3/cu+UiXBcplFDATzLUhmTffqfLM6+T/qmpHNhLZ9+hbDIj18cfCPMYiAe4yrw1mMni0yiRy/IqYxIxQWwyIQxMK6YczmD+LCOu9yi+9HHXsMXcmXzLNMGvfDKJuwCogGY6DD4zK1gAr4bwVJY07r6CDZzLhv2+5eXlz0LnGZaKteL9bwPg/rlmw9olQ8bH9Z6OBd4yC2sNLltx+imUw+8r9JQzSWqvNAQzgpzIWOh9CXS95pLXoJWbW0FbgxfrFwglSAyhHSYSH4GSajU13jRjHYgovI05WNc3IeOdGJul8W5qXF5FmU66Wsz7ZeEiMU+arx8RX+t9z5xE52jrsimK8Nc5XMkund09PYI/j493B2d7O3i05udf47evKLn43/tHx7C0/n9ig2BEFarq9aTx/By0tEbn8l3fcz4yBusCradVKKj7pGjdtmRcLlRoE05CZ5MuYiNIRmhv0gFqVUmvR8Xhj6ydihrPuRnL6US3anhEjn0sRXDRAYUL2SCdWmuTRGsRfpfEWagid46e8ETkNfLtxOEQQ0aHn8GWlgwH2Lo1FePYgqWEQymO5YVW4KPn69tbwwmzwecb/x9sL71bLw94Zuba9vPtrdx9ZArHg6JV1iuZMxSDXlH/gkKgUIFuicGaPFo2eHvsAHR+Mo492NLMYvc5sSV6wBweLFzyAZbkKHUNKf3fHpLCap7erwUmyC5J/zWyKlU94XS7t7L0enBCbw52vv36d4xPCGtpdgZKfDWBN0SWAVfmOlL4jgIcMkheUCejiF39NjTQPUpCMSVrQ8MQMEuLCgTfGvCoerCjLD6ihl10mxi9LwRShQ3V449lj3R67AxvoNKGc/YmGM2BhPi8KejOBaZ6x4ETT5lM8ETYZ702ChJJArJUw90LMxfACHGkwRD1xOY5A5rBeIxnUM61g6Sb9MWlSpvZ8oijRzUjYLBAZw/7Cej2OXAHIlZj8LSWwKLwT7As9dck7uTmtJIpQvleOxCnY21MaBhNgbZEI2GdITmspB4VDGuzFj17Ejp7rVnZtdp+hbz3H5F3B2mkH66JFr54UKE4LOIbH02ImsUZgoZCT6i2DQ5jCrNVQQ+1DWRJm3strHbxu5Xxu7tj0ehxQhfCfqsL0OfUxWaUyyeS9DHkPcoXXSwfxK8CYbsMFBIgEh/vDsJrS9i+qsM+6sfiI98KV9iflTaw78fI/wojdWwBTJIevQSTKiRGRLfFcdlfzZY21xe7aU2YwkOqlZARMiahi10zjiozORKISfcdliihVWPHJtxyI8cIsJanwFxVZV0fY/SIskWSbbVqK1Gv001apFkG7tt7P6asXsvkiy5omgJOMnm8zlub5Onhe8oLWcwgBWb3awMOTLVbbSCxFiJsaImcojGG+vj9clWLAYJHyTPN7cnG/HzDf5sa31rfTzY2Irqtf6siuMyyJoxVbO3t6P/8USYC8BxuQLnsk7rpLn9B+o1YoJpDVNPiZtB56DS8wo7Dpax4xvtQDYgDNjR3LG9eHp0gPRhaSKPevP70Ri0pDoYzh1BSvRh0LS0roWOLXRsy09bfn6b8tNCxzZ229j9NWP3m6Dj4CHoOPgG6DhgCLEmCLF+JnRMAHcgNJuAUfAEUQ7qVQgbMxAFnsLuYwh7x81UuBLoNVDkxvaKQyFas9dcLQqwZBs7kapSF6Y3GDvHsaYYCwM4m0KKVAyylgR0i14l5wIxKf6mnsq5pDhGgYCuWXRHEwdS+Zgp/K1cRao4zYFDSgqpxr1XDT4mwZ3EBOEfUKB90Ckk6h+4x1k7tPLd+8HsCCU+QInZ3lUsBMZ8uf/7bNUpgX1g3mC6OPa2vuO4gN8zx2MxSlxlPn2VELSF6i1Ub8t9W+5/j3LfQvU2dtvY/TVj9xugekBDd0N1GPDVUB3G9tZYiaVeonP93xE7hUrggNyb6ZiwelJhcDzSKuCldAta5BQg/o535VHuZhiZMlHD8mRq1x8bHvoDqtE5nmKfC/DFcOcAkxCe2h9G1ala27+ujhjf9H0bEAhFncg3FV7G3KQwFU8422G/fw2mB5Pf9Hgme5ARwfpuofQlnXa+2FyRyKQtAhtSYZLH1IiMDvdD59IjgxmJMeETKC3gzUcqQu8vjlDfS59uFoBfLEAa5sl0mCvPhtNrYDOD5uSR9TcnyB+XZATZTk1685A8/9m8Tw5P5A45Vqnv3rVgPAMub4mH7J9X7nKMKN6vvuQ0VWXC3w82lhZ7i8M22AvBDbQY/kjN4z/enTypXc3wt0+ExGYDou8QXIRy46g4XoKTqFwZnU9nxPiocYAHY5FNUhCYvVfHQrCz/aCEN1A0jiDLk0pxkqDEgrPOHxeWScSFSLGe3jpmD/HQBw31eWPeE6qd1GRI5W9E4FWS96rLdiWmNIkYAMcEEalnZGdZIRevyfW9TPytoNb11LpEzT65xYVX7VnsD4THkBCQBE8taeu7F/f0ujV62JHBG6R6mwfUROCjeewqLqz23Xw06HWRXpOP9+rdTEJhbk5jPo0xC3U1Tdg+i2daW/EPxtB1MAzOpjlE0XezdYmLdikiuhtrNZa6fsmu7ALMJP4OIDCUdyY+xjJPKEf7DRcKyY9kWYj5j9CEJ+xjQ2Z6fQbVGEcmOrbfzTMu2MUFuz4H2MC/L3boWBDbKAPlAe8AO5X9KRMERms5z9NamdWJfJ/mYGmIgVWiYrOh/2NYJbjwxOgDji7HQApGlF4eRMMLaIEWVryGsor9hdsaXOY31VBob+nN81v+SorF968mL0o8qrZh3qp08aOz9B2Z5K+Td39Sxmszze+YaQJuRnejZUODUXdyj9aWNwVx13om4F/4SpFKAB3aH3+ZFjFMnUyWcoc+TTEdz6Sg7YRMcIfIr4N+pecUhwB3MfihaSRCU7zKKvCCHocGUKZAr8fe4a3CGFSMvRoe4wWqn3Ro2o5By4doJLZbGA4A1HyeK7zRC0zkc7wt+5B1E2nj3CehgP89Q5pgXDmriEh0G1RFj7oWM7dvJ8f+7mDNiA+sBTa0YdMZFIkWCReKK0GOREpehuOa8Psh2uA53ZlIM+wWU7zSaEVthdf7J0sUgZgKv3Tg3cIwyfZxLBAJtzhhwmYPekR8lWnroLWt0YVGivnb22z19e3rao/9p97kDgUEkX8/w+0vuu/pOxHfB55VN4hR+8PGLe9mKwjNxQxUgXOur3HXBPuiG3z9JRfYkp+dV20PtYtgJXxOylvYdyrp8VEQ4wn97vO/v0C+UjPF9qFaVDsHETx+FrjhUFPNDd419TtDJKgfEH6K6J4sqP4XBFbdDcdG00/yG0614Us/yTR6+MNTdOlxuJE+99sZSJfIdqpHsEaAUquQRHjAQTc3/wUHJqd/ +sidebar_class_name: "put api-method" +info_path: docs/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 'putSourceConfig' (put-source-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

putSourceConfig

+ + + + + +Update a connector's source config using its script name. +A token with ORG_ADMIN authority is required to call this API. + +## Request + +

Path Parameters

Body

required
+ +The connector's update detail + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/put-source-schema.api.mdx b/docs/api/v3/put-source-schema.api.mdx new file mode 100644 index 000000000..c676bc711 --- /dev/null +++ b/docs/api/v3/put-source-schema.api.mdx @@ -0,0 +1,121 @@ +--- +id: put-source-schema +sidebar_label: Update Source Schema (Full) +hide_title: true +hide_table_of_contents: true +api: eJztPWl32ziSfwVP+2GSPEuW5Cv2h93H2IqjGdvy6ki21+3nQCQksUORWh5OtH7+71sHwEOkj3g8M929nJ6XKCRQqCrUhSoAvGsEKxXK2A38vtM4aqySeBQkoa1G9kItZWOrEct51Di6avDjqHG91XBUZIfuCjtBl/HCjYR12RffXc8TdrBceSpW3lqEauVJWwnpC/XDjWLXnwsGC03jhYgXSkTJdOnGsXLESq69QDotMQqWSsxc5TmRCGbUSveype8HsZgqkawcCZ1aYrxQUdpahkp4MBBAmyov+N761f/VfydcB//05VLh33aosCv+XAaOC10dbGb5ayEBkeUqFnHAr9Y4eAae6AtVlHixcH0iKwyDEB+tAh/aEVVSRLGMkwg44SgkYLfdJkT+XXx1na9imUQxdFlKAAH/R/JC9T+JgqfTwFlviWkC4OMcsfZC+nMkVvRnDAMYHmi2zcJgWQGEnxCqhDaAkYgJowz4wMyuZAg8iVWI83vXcHEyVzJewCtkFvwrojkHwdhqIHg3VCAjcZiorUbE8nF014jXK2obhzDBjfuyeMD8ERyYiBZAUj8kigi86tqHnfft9zt7TuewI9/vtzt7Tvf97t7edFd2d7qHAKwaLRqb0HoEjU2MK9Bisfp5tK4ZOrD7A3AbR98czA78WPkxvpKrlefapGLbv0U4+F0Z7WD6m7JjnJQQFTJ2QdPgreuUSauixHWKqvLTfNasfc5Y2PKx0aRtBwmQTkBj91YNiLYxAf7ZAZgvAjuJgLWFgYpoDYqOoi9jtiQ8mWB0QO6B9VERq0mkQkTJdeCdG6+tGBAAVXsBTtJ0FUkEGgjWwpaenXhgVuh94rsgG4JHAtsRihlYCTAXmhit9VEF7yLr3GL2XeB8oDK5EVjRfyS6egRxKz3A+tmoOmzREzdaKMdguwBqZWgvXgff74sArCrhFWUTKwJoFWoMI7LEIh23JQY+uR5P3UqfTPk8DJKVJmFDKJZqOVXhYEaC4dte4qhLFS7dKALUohzq0yDwlPRLuH/05BwwcEi/wb19XyhGLhRovJEcDVesMsCZ+9NsBmcmsS+QMp+Has7AHuD8THqRAoRn4MeSUOXRlGEo19DWBc2Iqjiv/GSJztyajD/1Lsb9Y2vcg8fHg/PLwahPv0/6w97x+OayNzzvj0b9wcWIHo6OB597w5vR8afeuQVPehfWhzNsf25dWKfw5mww+NvkEh5cDG6G1sXJ4PzGOj7ujbD75XDwX7/A36OeNTz+BD/GvfPLMx57cnE2OP4b/RiNh5Pj8WTYO7kZW8PT3hj7jj5Zw97loH8x1g8Z3uc+4ta/OIV/ng4Hk8ubjYejXy6ON59dWqPRl8HwBEmeDIfAgZvcI0B3MIFHg4uzX26Gvf+c9EY4mHVy0h8DCOvsxrTIXgKx1unpsHdqYRODy+jmk/W5d3PeO//QG464WY6hm2jBW03Co22qGFTRrDyBJTYMex9hxiaT/kk5nBvQD+kJI19sYiEcwSAiSlarIKQIa412giOEFkZTeZk6wsBMvzR9IgjxoqgZL0Af5xAnJSDfYCDZMxKEVAyru2NoGUQg2+YNhXKmc5nsaiihAqp81K8TcNh2nFN4Dacg6tVAwPjZwa1CrTKWhSwnWNgQ4lDfYavDEFlVHkBGOgjDnSEztefE8E75cuoBlwEmjEW/CVZR26qR84LgGwIFq7eUvpwTSjiNak0hsvJpGAXhClvPmeJQGsZ1I7ZLK81psMmb+kx4bD4sYOIEIDVo/zRKIgSOQJgK9KmI2YODzFXMocGbtwLi0EUAMXa0CBLPESbylR4yATuoHytoyf4LTCkwe0mIkGkpjI6SCtMAIQIQLQUEVD/W2q2x59AyK76QwTUyLBZZ8y0haSnj+zAm9EQ8ImCmo4zpBo3Q3ZCjwEmSJURPizcSmAHA4fEJI5NTGraI+MuYRPzNNvEh+X1AZLzA/sYSk/j8u8WwylbjKc1IfPAYiY3q74ixDGGmWJRLxvgFkNjbIUdGC2DeZeD6cUv0s4UKOC0XOb7mgAUMjXWyJc5OrEs9UGRmPjVqJQGYwlQTq0h4vocoy5pXUUt8krfsYIFt2swJF7yra6ydnqtbF+1CKp7IZWymlmC4UGUAaXDGsFqE2ED3ZEFgGWdy844fUaMe0xx8VMMZq6e2ssw/bWRNRKDtXNnZPYt4bY9ei3QShk0PW0IkhZPyHsJ23wYV8YMk8tY8j9oDP9IbHcf3IHT0UhjIGEFYZRozW30F9pipNs2jLabTTe1KgMHhVEfCYPtAQ39LfBuZmwVleZIMj9g/bcQMR5yr0ChjrBWlJg+dw0w7NxPZ2kkYYgBr8COvWRF0PKRUtOLE2Uu5iTgHSSxoTcOTw8rxcNDyNHDHcXUIkGqMNvm5UOdIWCnhJPebNr9SbouBUQGVZeAoMLIcrXNgHi3cVWSyKvwotzrQy0HuoAPpUJKFB4zQr7HMl7sYo8mdtOdTsxmtJyhmN5KeTh/gBkbLdNyk7ZHw7kj0eXmQ16+8Z6EsTybq2n6gvyibD/JiqRUj/1UOe0jpq2SYE2R6FbWFOSYXA4MoWZLfqsKNjVUJuxxOmnvGlOhgRdNKwCmeJKRsCXoX5XqnSauYLCIMDWqjnTwoyDdBC5ki2ZrfjwfMr851Yz7/X/E8F8M+Z/lxxGjxYjP15joLTL7syXkjlB/RJoPLE2ucfwYmhUTCxnqajDE85rznR56n6tRocZWVS2QZ01wY6Gpz6fv4wrJqMXp9T9nJmTtPOO9flYUs4vkpoOy6v4YoPA6lKHTncG4T+6VcC50TLRBw1yChOidjnksS6VRM4x6wS+11VWqjzMHMvDtq5vrku8BrLFx7gVK83MijbOZGHsi8viwfmuLyVFov1tnQMjhOdT4KDvSQ5/eh9E7a4GxAf0G8Dn9+GAzOetYFLvmNgKYzcJKyjvK09/nMehFHC+Z1BmtHjL/AZOTmXHtXExUEG9k8ncdbyhW8a2XYPzABT3NI+/ypQiVPkXIe4cvx4OIC7MYgzWNd59laekvp4ucJgcalf8IRZ8Yiyv6jegeVOfm9/ff2XvfQ3m934Jct92eHbbuz09n5uZz8IoGVfhODX/QEaUq3nEkvIkG6CDq3aZmeGtIqDZi9fkp2rXOhdUEYZXCj88SL3dfJt2YCB/OwRLhNkjynnERF6DMJTbKkqhv1slD6H4AQFg2zAZ6J0ilN0ysjkxVKTKQMzpXcJsYgZqH0FctZX3F9+rXAGqpBUqCiW7x7Bw7z3TscJGRKjVkgq4yVSp0DyQSDy5BPMOD+UWuF4pN5x7u0Qlg0uKlFSA2jFrnPJBnp0Buznz7VE6BnJB0lLR+U4ZcKfCXjwrbF2IH3B/sHndnsvd3uwK/pLv7LPnD221nVUyvr5qSfbiyYysRxRXKDNvNQk4b/vKfQgMvjzzM7jqkhmbK+jEx9HUUbva+MsVYET5qxSzORM4HtzmGz0212d8fd7tFO92jvfavT3v1vpNGU5l+OhychxjVgfgKbnc642z4ChLoGm5wE6l0R92QyTd2f3FW33a72VjmUooQSoLPEy3ZHEGp1tbiuFtfV4rpaXFeL62pxXS2uq8V1tbiuFtfV4rpaXFeL62pxXS2uq8V1tbiuFv/ueV5Xi+tqcV0trqvFdbW4rhbX1eK6WlxXi+tqcV0tTqvFu1UF4mOw9mDaenSOvCmGJpPDGZ7CmW7KqfhgnNzXLBk7Kpaudwyr6ad59xEUszkPJeknH32nM+60+KAs4zLABQaBNIadz5sXeIcH4jvig3SAXqbvWBODvAuljfno/jMmc8KlU9MF69rGbFQMqw6UnO63D7u7s/1dKbvvdzsHe9PDmdzZaR/uHVJde6miSM6fEUqeKl+Fro1pVJiR/wWGgCAD7wkBGvz5wSPBeKbr5rYpmRpfEUOovQVG9MPxpdg9AGn25wk9l/MNJvjNCZaY/MTz0BdrXd7SSAxCd+5WunQTFJ30PlqTMwwQ07IWwioVhizf+BZAFWRhEXwnjDUBtB1CeZQFb4l3Guq7NDeaNtQlBl2/19YeeujRK3rkQZevRyC9+RGLN25LtbbAaaHeyxii/6nENJ8OS9+BQ1CruHmmOflOLCB6UeHblrCyjFcapJL3k47DeUIEMEtotW1SbuBRXXsjuMlYWZyNzICc5ScFlQMwf0a8ZccJIEdk5rUwlRaNop4fwJk5V8RunGMasXTtx9KOda7dDkLKM/BlFZHQ5oiSp2B4fNMutVh5u0jm7pyROYkDeseZhyf17tID89Mk0tIXt0orX0TlHrJGKp+Y1BZJrzGos26VTpdRfL7ro9bdWndr3X2m7m6+HOptcfothT6dcugz8bGmH4TkPEuhD68K/ECYRpw94oncwjWKDpH++mUMiv1N+VQH/7HCS1heMT5iV16R1jDzwc+nZgeOcf3ZXCCCxEemYAaWSDlHhHeGMTGKWbVTHu1jEE5dEFC/IkTEPQRiHSRcWU58qqPKaItKLP5fYrGQt8rU0skC0n4Bp7miSmodSdaRZO2Nam/0p/FGdSRZ626tu39M3X00kkyxIm3RcVKULJcyXLOk6fdILd51uJNdzJiqHE3VZrSCwEQaYzWKkUNj2u1MO7MDW+06ctfZ3zmcde39rtw76Bx0prvdg0be119lepwqWVGncvPN80gsph2IuBUPhCuKg8Appv8SvDFyRqX5OAuJYe4ggLu/zmLH3XLseBHEQBsAhtgxfCC9OBmecQ2KwSPfuCoXhOmRisKuHbrOsw4d69Cxdj+1+/nTuJ86dKx1t9bdP6bu/lTouPtU6Lj7E6HjrsAQa4Yh1r8ydHRcPgczg0kBGszm8XTfhs4+arXX+1ZNoFeIIruHFRupgkCc45Y+HSxFhUykn7ELzRu0XWLb0LSlY0NzMJE+7ix1Az5+7C4VxqRYjPfcpWuuc0e44bppzWKginUmuyddj6JPSUZkFLwAc68ByJiL27tmGP4BBMqDzsFQv2KOU8/W35UPFkOk+AwpFr0ftlKo82n+d69ql0Afj1+huRjxXD+wXSA0e4YSPz3/lIagdaheh+q1u6/d/Z/D3deheq27te7+MXX3J0J1HQ09HKpDg2eH6tC21RZpLPWRtg3/syN2UhWNAYm3CGyK1Z0sBqe4Ao/RNuh7TGhD8PM3R41tfYJ1+858mOd+W98nAI/0R3HuoT2vCRjFJPSg6yKOV9HR9vYdzBzM2H1LrtyWud3GD7637GC5fbtTYYeyY/5gyZyET7/i5554kBbxO3TpTBnJKw3A3NdbsxsRzALtN3gUvjl/sAbiBIPZyh3vpsd4qwOsLf4SUesWiVOJRqBtEnr3T9HzeecxOhjIA3RUse/RsaC9ACw3yEP0r3G6QAQAEM0XXj10zIbLSnDar67zbWhPMWNYapk5HywRdEsIDbBZV3xQMsRjr7Rr5s1fv4zfijmGp2QekggjY+XiegIU7BLEiMyfZXaQYCfySNnNBVZhjw6qm5jh57fEr/5IKXHV14y6AL8wBENObLcKN3pcvzGz56hb5aHLbGXcRuF0HX8buLhdvAnkLblHWke4Pu/Z5mO2TX1hR3Ymk0mkZaG4Whm6ZI6ulyLxbwZak6E1CVr0dgMLZu2VzXu+bdB5BCG9iLj14sEZXjMHDxdd8AShbuLA144QHsWdVbaZtRfjUYDXRHhFPH71v9Apu2I3c2OAPnLfF/YiCCL1H0Kg6KCqXM0T0LQXo0VH+5qkEc1uO4dSk4dsuk2IJAm/M1AMn4VJTtGTUyATcE6F1PYrzSzYha904vNrgWZ6fAUOF1s6gR29GGccsIkDNtlORBp/9mcoWKDbSAPZARaA42z+yRJoRHN2kWFVWn4Cv0190H3YgCpBiVZH/I+jzAjqX4JeYOu0DZjpBt3opvea4bUoGhad1Mwzy6QQNjlYxtcLwJdu8I3xTQuh6F9/b/QixVaWacGLxl7bSj9gSX4/dvdfZPFqS/NntDQ6NMaM5TD7+GIvOyuePyH38O2V6Qk5c/Nk1cWTfAFk5f2P5dOC5UsXK647rL7tMH8osOpKQX2mMLu87zWO9Fec6H/imH3xlH19cPLvPDiZOzf58LHG/KnGR44botzMAuKAXlTnrT4vccqJ8IgOQMKf8JZcFy1KYcmf3WuUBwPiHfPlCODkbBBkSqGtgAZcLm2hoQ2W5JhgjYjeUOmLeOZEZwgaLD05dT2A1xJf9KVyIeYncOs6QP0t0ImKEZgduuRLnBhLBiuK5TLxoS86nWQpJNjLJ8wdXrmXsFfW16UwQnynW9rLuCi0o8gKumgAFDAazLDW4toqZ9WeGAuMWqQLLcBInBEtURkhQ+WRymG74pr1KdhgSpsL5ZFgQkgBqwuVG+G8Py5BBGC+ru4F4Xxbd4q2sS0AwfwAC8NOq91q46NVEMVL6efgTugzy+bzvfq47JuPiee93ZSpu6zCVH8R+o/6RWhtRDGjsL3CzDmKRcJZEM5BXelvQqMEH+U+D63TUPTUfJ0Z7NwCRAo73d1hxhWTMvf4GPDCdN7VdZZzIbdiLq/Mne5/QMTeDPUHl99SzbjwgelKKkyVwF9nCcIG/PymMK+YUoJu5+VY5L8n/RIsDOfobD0noYkv/FpXPZsUomTdS+VcpIF7cGL70bbXuWTj5QTNyFR/0nrJadNQfoeH+OdR41f4D/4RrNiIQSN6ftcwRQhow2Dxf/8HNK6sfQ== +sidebar_class_name: "put api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + + +## Request + +

Path Parameters

Body

required
    attributes object[]
    + +The attribute definitions which form the schema. + +
  • Array [
    • 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. + +
  • Array [
    • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/put-source-template.api.mdx b/docs/api/v3/put-source-template.api.mdx new file mode 100644 index 000000000..afccf0ad2 --- /dev/null +++ b/docs/api/v3/put-source-template.api.mdx @@ -0,0 +1,96 @@ +--- +id: put-source-template +sidebar_label: putSourceTemplate +hide_title: true +hide_table_of_contents: true +api: eJztW1lz2zgS/iso7sMkKR0+lHitly3FdrKezeH1sXlwXAlEQhISCuAAoG2Ny/99uxvgJcl2kspuJinOQ4YmgUbf/TUE3ESOT200PI/2tFIidtrY6KIT6UwY7qRWh0k0jLLcnejcxOJUzLOUOxF1okTY2MgMx8CIsyyB14yzuCDzm2WW5jAXJrHcSjVl0sEXmsoUn4veezViTn8Wil1JN2Nvj19+GO2/PnzDeO5m2ki3YNIyI/7IpREJDGUxT1PmZvB2dHTYA14yboCSEwYluYmQLPDkF3mDf3QiiVxm3M1WWD+dCVYNZZc8zQXTE1hAVNL02AkNQdLIDn7MlfwDhsqETYVCdQF33FVzWGwE6RBZLPiPhs7kohNZt0iJSQnKQQbFdZbqBF5NeGpxQDwTcx4NbyK3yGikM6A+GslpzjDiJ5WIt7cXfhVh3XOdLHDm8qLAmhPK4ad5njoJenP9iTbzLliP1lpZVY8/gTANAc6jiYTlYbnMoJ84KSzOoLdr+G2qu1LPsntcz1NGNDoR8sSBz2gsFTcLEA7/QyZsppX1621tbOD/Vq1Z98HcO2YiHJdp1FABz7JUxmSh/ieLs++TvynrXFjLp18gLvLjFwfvCLMYiMe4Crz12Okik+jTC3IrI1JxCSwyYQyMK+ZczSBCrOMut+iA9LHX8IZc2TzLtEE/vLYJu4R4ACY6DD5zK5iA70Yw1LV19RFs5lw27Pevrq56FjjNtFSuF+t5Hwb1yzcf0Coftj5s9HAu8JBbWGlSWRJ0O5HT6LZTD70v0lDNKarM0BDOCnMpY6H0FdL3mktegFZtbQVuDF+sXSCVIDIEdZhIfgZpqNTXeNGMdyCi8jTlY1zcB48ER7Wr4tzWuDyPMp30tZn2S0LEYh81Xr6ivzZ7n7iJLlBXZNO1ga7yORI9OD5+ewx/nx3tj04P9vHpzd4/R29e0vPJvw6PjuDp4n7FhkAIq9VV68ljeDnp6I3P5vs+ZnzkDdYF214q0VEPyFG77Fi43CjQppwET6ZsxMaQjtBfpILkKpPe9wtDH1l7lDcf8rMXUonu1HCJHPrYimEiA4qXMsHKNNemCNaiAKwJM9BEb5M95wnI6+XbC8KgBg2PPwMtLJsPMXTm60cxBQsJBtMdy4odwcfPNna3BpNnA863/j7Y3Hk63p3w7e2N3ae7u7h6yBUPh8RLLFgyZqmGvCP/BIVAqQLdEwO0eLTq8HfYgGh8YZz7saWYRW5z4tp1ADw83ztigx3IUGqa03s+XVKC6p6drMQmSO4JvzVyKtV9obR/8GJ09uoU3hwf/Pvs4ASekNZK7IwUeGuCbgmsgi/M9BVxHAS44pA8IE/HkDt67Emg+gQE4srWBwaoYBcWlAm+NeFQd2FGWH3NjDppNjF63ggliptrxx7Jnuh12BjfQaWMZ2zMMRuDCXH4k1Eci8x1XwVNPmEzwRNhHvfYKEkkCslTD3UszF8AIcaTBEPXE5jkDmsFIjKdQzrWDpJv0xaVKpczZZFGXtWNgsEBnD/sJ6PY5cAciVmPwtJbAovBPsCz11yTu9Oa0kilC+V47EKdjbUxoGE2BtkQj4Z0hOaykHhUMa7MWPXsSOnutWdm32n6FvPcfkHcHaWQfrokWvnhUoTgs4htfTYiaxRmChkJPqLYNDmMKs1VBD7UNZEmbey2sdvG7hfG7vLH49BihK8EfTZXoc+ZCu0pFs8V6GPIe5Quetg/Cd4EQ3YYKCRApN/fnYbmFzH9dYYd1nfER76UrzA/Ku3h348RfpTGatgCGSQ9egkm1MgMie+K47I/G2xsr672QpuxBAdVayAiZE3DFjpnHFRmcqWQE247LNHCqt8cm3HIjxwiwlqfAXFVlXR9j9IiyRZJttWorUa/TDVqkWQbu23s/pyxey+SLLmiaAk4yebzOW5vk6eF7ygtZzCAFZvdrAw5MtUyWkFirMRYURM5ROOtzfHmZCcWg4QPkmfbu5Ot+NkWf7qzubM5HmztRPVaf17FcRlkzZiq2dvb0f98Iswl4LhcgXNZp3XS3P4D9RoxwbSGqafEzaBzUOlFhR0Hq9jxjXYgGxAG7Gju2F48O36F9GFpIo968/vRGLSkOhjOHUFK9GHQtLSuhY4tdGzLT1t+fpny00LHNnbb2P05Y/eroOPgIeg4+AroOGAIsSYIsX4kdEwAdyA0m4BR8BRRDupVCBszEAWewu5jCHvHzVS4Eug1UOTW7ppDIVqz11wtCrBkGzuRqlIXpjcYO8exphgLAzibQopUDLKWBHSLXiXnAjEp/qaeyrmkOEaBgK5ZdEcTB1L5mCn8rVxFqjjNgUNKCqnGvVcNPibBncQE4R9QoH3QKSTq77jHWTu08s37wewYJX6FErOD61gIjPly//fpulMCh8C8wXRx4m19x3EBv2eOx2KUuM58+iohaAvVW6jelvu23P8a5b6F6m3strH7c8buV0D1gIbuhuow4IuhOoztbbASS71A5/q/I3YKlcABuTfTMWH1pMLgeKRVwEvpFrTIGUD8Pe/Ko9zNMDJlooblydSuPzY89AdUows8xz4X4Ivh5gEmITy3P4yqU7W2f1MdMb7t+zag66rbCb6t8FLmJoXJeMbZDvv9GzA+GP22xzPZg5wI9ncLpa/ovPPl9ppUJm0R2pAMkzymVmR0dBh6lx6ZzEiMCp9CaQFvQFIS+n9xiPpe+nS7ADxjAfIwT6bDXHk6nF4Dmxm0J79Zf3uCPHJFRpDtzKS3D8nzn+375PBE7pBjnfruXQvGM+BySTxk/6JymBPE8X71FbepahP+grC1sthbHLbFngtuoMnwh2oe/f7u9HHteoa/gSIkthsQf0fgIpQdR8UBE5xEBcvofDojxkeNIzwYjWySgsDsvToRgp0fBiW8gbJxDHmeVIqTBKUWnHXxqLBMIi5FihV16aA9REQfNNTnjXmPqXpSmyGVvxOB10neqy7bl5jUJKIAHBNEpK6RnWeFXLwm17cy8beCWtdT6xI1+3iJC6/a89gfCY8hJSAJnlrS1jcv7ul1a/SwJ4M3SHWZB9RE4KN58CourPbNfDTodZFek4/36t1MQmluTmM+kTELlTVN2CGLZ1pb8Q/G0HUwDM6nOUTRN7N1hYt2KSK6Wxs1lrp+ya7sAtAk/l5BYCjvTHyMhZ5wjvZbLhSSH8myEPMfoQ1P2MeGzPT6HOoxjkx0bL+ZZ1ywiwt2fQ6wgX9f7tCxILZRBsoD3gH2KvtTJgiM1nKep7U2qxP5Ps3B0hADq0TFZkP/x7BKcOGJ0QccXY6BFIw4vTyKhpfQAi2seQ1lFTsMyxpc5TfVUGqX9Ob5LX8nxfL7V5MXJR5VGzFvVbr43ln6jkzy18m7PyjjtZnmV8w0ATmju9GyocWoO7lHa6vbgrhvPRPwL3ylSCWIDg2Qv1CLGKZOBiEy+jTFdDyTgjYUMsEdIr8O+pWeUxwC3MXgh7aRCE3xOqvAK3ocWkCZAr0ee4f3CmNQMXZreJAXqH7SoW07AS0foZHYfmE4AFDzea7wVi8wkc/xxuxD1k2kjXOfhEIH4BnSBOPKWUVEotugKnrUt5i5fTs58bcHa0Z8YC2woQ3bzqBItEi4VFwJcixS8jIc14TfD9EGz+nORJphv5jipUYraiu8PjxdoQjEVPitA28Xhkm2j2OBSLjHCRO2e9Al4qtMWwfNbY0utFLM3+Jmd13jvqn22X/wje5QRBD99zPcBKNbn74b8d3geXWTGC0wbNz2Xm4IocWYgUJw1s0N7p5gd3SLr//IBbbm5xdV80NNI9gKn5PyPvadinp0HAR5TL///O+vkq/VTbGNqBbVDkIEj58FbjzUlHOLd079DhEJ6geEnyS6pwtCAQWBdbfEsd30k/zGU234yk8zjV7+6Awdexzups/9tgbSJbKd6hGsEQDVOjwRHnDQ7e1/AY4srck= +sidebar_class_name: "put api-method" +info_path: docs/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 'putSourceTemplate' (put-source-template)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

putSourceTemplate

+ + + + + +Update a connector's source template using its script name. +A token with ORG_ADMIN authority is required to call this API. + +## Request + +

Path Parameters

Body

required
+ +The connector's update detail + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/put-source.api.mdx b/docs/api/v3/put-source.api.mdx new file mode 100644 index 000000000..d74350ef4 --- /dev/null +++ b/docs/api/v3/put-source.api.mdx @@ -0,0 +1,194 @@ +--- +id: put-source +sidebar_label: Update Source (Full) +hide_title: true +hide_table_of_contents: true +api: eJztPWlz28aSf2WK+yG2i6RI6uZ+2KIpWmaeJGp5xC8ru2QQGJKIQYCLQzKj0n/f7p4DJynK0TqJg/dSCQXM0dPT90w3HireivtGaHtu36q0K6soHHmRb/JKtRJwM/LtcF1p3zxUJgH3u54b8q9hJwoX8KxiW247oMZBe2m4xpxXPj1+qlZCYx7gezFQUIFHFg9M317hNDDJeGEHrHPdZ9HKMkIeMIOJcZjtsr7F3RBmvfLuqywKbHcOr2eR4zBv+hs3Q+bzlc8DaERQ11nfZV644D6793wrqDL4zfhXOwixq4Dho2t67syeR2KlDKY3veXK4SF31jigY5jcqn90P7ojb8nZzOaOBWD5ANFyGYXG1OHMcC1mGq7rhWzKmbkw3Dm3qiyIzAUzgjZ2fsNsC/8drlcc/2sApjxAIcx6Rw8ADBfW4PmpP7qOEQT4ZAX/xVVce45t2jzAMTthyJerMGChx5aeZc/WuMJAA3lvA2oAIZETIvoMdtBoMO77nk/r6UC/L9yFZuGCDYbnt52zy/5VlY0Gk2G3p/7yfPVgNHlLzzTsa8SWz/83sn1uIRCmAROGcgthDqCUleEbS0CmHxCt2LjJKwOopFpx4QX8ZVtIUOaCL41K+6GCCIKnQejDJlUeqxU1QaUd+hHPEwyXO8loIP7VwN2DNy3ztHnSONk/tJqnTePkqNE8tFonB4eH0wOjtd86rSBB4uA8CN961honz85lIlm7Ib4yVivAPBHJ3m8Bzv2Qh1rQIS7bR+YJYaPwLUCWWxnObVgD11kXLwxp1baYNyOq1ZyXW9/h0Yl52Do1YX3wyzSOZqcNs7nfOkDcCRTnp05P9T4CHq0hOETN2EnNG+TnvVwraB4zAz1znsTLLdORRIB/8LXp+SsPGBX6wi4hf6zrCIV373If50/PN+Qz7nMXSANo04BJ7l1kfCVG2EDt1vbdE2+zgyPh4RsEXYqfKcfhfTWrFY+sEcLdaIkCsH/Wuxr3x7+iBIzXqp/CmoppJg1D/0whzpZregaFNPe/mUIsOwC5uE5RSiEEl+srHP/xEWYynSgIn9wmHApEnWfasM0W68pO+T1yQe4jMIp7Yta9EYuqCslC/T59jz3tXkxG494wvaXq4bN31NQrz23o0VHz6Gh6OG3AhjaPjs39Fp/tN42joxfd0CIAupoB1cbQ1hqm6UVuCG997pCI7JJSfZolO6InS3Rloi/zNnFnduf//3e20+0OJlfj2+5gOOxddMb9wRX8vnrXP09v9pZ2z95/iVOUeRozwlQp5HHScubhqdByhyf7x63j1sGh8aIksSNMZ0o4sxsh0GtHrZOj409Fu72JgIaRU7CNafJh2AgAM0K0vpjlse7g8vqi9+8kgGCGLbzIAU0KqhbNsygAuXK/AMNnE9niaD+Fqm39L0GCw8lFL01s9OTZZOUjXosI6LhxYraODw4aTfplnBjHRw2QMC9KQLnZe+IX7aQgBeEu+IlNuQTTC+dDI8xxBjMyJLerbLmzYCD79jQK+dVOC7hKkrrqipQWoU0NhrCELUledYb7emc4ETaJXKSzFK/EA5E5rggQRnU870u0osZy4J8CrUbrKTTJ92K7RYM/sDY1RHqRATd88FeIM0J/jZQJT2c2LMnQKxdeVxgv2feWyeVqqDbADwuAmYVtsHGjH6sPOQ5Lr+ad7YDykQacQKgV4bqLtojcIyOEtdng7C2TrWgRgdRF2jPUuwE+kljWnrIZwad5/FRIpTsILMRTftXYsSqkU0I0scAmxpiJldoBSqQgms3Q+3PDUih9V6E05cD+/Nr37uwAxoWJNmy3Vkh+5AZKFHS75xQiAOnl3QckSUywnoAUfzeU97NKjM0AROgtJpWOj4wHUHwCxinV0nemAOHqJ/BYMXzfQG/HDvky+fw7epFgW171uuPB8HbUfd+77GRcj+zbZ++KjG/s7FMeHx+/6L4UzH+5HomHtCvpES9AfmNXjTuS7KK9xG6QHCw2I3KoEpjaFkOatvZbRhzFkvqPdNcfG3QaDzr3vWglFE42/ldAiFnu/xMJ87ozGn0YDM9urwcX/W4mypF9+WyyXCEOnhHqeGmyLJj/cs2u5Q6xa/F6ZwLNhDyukzu9VnRbLybcLC7TJJb2CuEXnzYO909PGjGJxR59Dv7qH5nlGJGuZ/mFuxYor9wUSNkzboSRX0jRaewN6IfhMNUjdv3Aqg6iFSwEEThd61ODeoF8znv3k/F7jLt1O+MePEYfcjDq0++z/hA4+Pa6N7zsj0bgzo/o4ag7+KWXYOveVeftBba/7Fx1zuHNxWDwr8k1PLga3A47V2eDy9tOt9sbYffr4eDfiMJRrzPsvocf4x44rWLuydXFoPsv+jEaDyfd8WTYO7sdd4bnvTH2Hb3vDHvXg/7VWD4U4/3SR9j6V+fw5/lwMLm+zTwc/XrVzT5Tm4pLngyHgIHbxCMVyhhcXfx6O+z996Q3wsk6Z2d9DGt0Lm5Vi/glLLZzfj7snVPkQ8Eyun3f+aV3e9m7fNsbjkSzBEKzYMFbuYStbYoQVNAsv4E5NAx772DHJpP+Wf446jkk5yqaw+OaJE21yUWUx1iyT0AHOrVwARJ+vqATFXQwxPkCjaDJsLg7HlJ5AdC2emOCyNKd88suHsXnsCoyOUXM5pr7SztAMzSQ46RIvXgQEJGmd8fJ/ZJmEtm44M34ARm+pMfEiIJVNgBjWDiGPUNkKv8ZDF7uoii28CgK5qLfNFaa24qBQycbBwVHW/psABKdJqzpEA+kME7D8QSLzshmHEZnyVMHbyUxDZI7y88ER/ZhChLLA6rBk0EJEvMBI+A0w/p4INCDk8x5KLzZV6/ZkocLzwpU4EodK5LZTx341xW0FFEE0OSA7CUBQqIlNTtSKmzDHWoYWBxo/q9r2hzDFSejkmbZB/I6FQ2zRdy8in5LwgNBOAJApsXFySFxhOyGGAVMEi0heJK80y4MTk9qlIBJMI2QiPhLiUT8LWTiJvrdQDKOZ34RFBO54nddjJWXGk9xBjhyYE+ZyP4WGxs+7JQg5Zww/oaRmGWEBmFktADkXXs2+PasH+pgESgtGzEugwMgaDpnVXZx1rmWEwVq57VQyxHAFLaaUEXEc+8jLUtcBXX23rgTMR1AmxRzDGMPtpJ2cq+Ee6rJE7FMIYolCC5kGQDacAIPXqPzSj0FIQgaF8tdxQKGQKMe08T4yIYzwZ5Sygr8SSE7n/t8Hsu5vLLbafFSHr3U0okYsho2B4geR+OeBWvXBBZxvShw1mIfpQbe0lt5AvKeASxjZGOASZIDtXY5yGOxatWcrj8IoVYUELcpkv9b5JoUkZCczVOEpXAk9FPGZmgzuh8hQUZbK9AiD5XDTCo3fbwU+WAChxo+0poFRscmpqJze7oCorCJMHtRyChSJzZHMMdmo+XpwS3LliaA5hgp8hOmTpt19MKJ7rMyv5Bu04ZRCpSlZ3EQskSnQHTLKaithb0Sa8RwLD1KxG9lpEl0ULdhDJLwABHqNUHz+S5KaIpOUvPx2QydDhEtVpSutw9gA6GlA9yZtW0x79qs71pIB0n+SmoWukITk7qUH6gv8uKDtJiWYqS/8mYPMX0RDYsrPPK6UJXZpDWAFKMl6a0i2ISwykGXgEliT4kSaazItdLg4raDuC8EfBckeiuyQ6U+pamBbaSSBwb5wsiRSS9b4nu7wfziWFfi8x+F84QNu4v70RZgCWdTa3N1nwx12ZP7RiBv4SYFyxM+zveAJBULyfjT6rxHXBp6J/YJ4zFxOKPQP8350tphzjTMzFfoAGvPFiMOKuK1PRA0AhsbtBYXUlDFwoJ1ACQhY2HCowB7vD6vs46JV/mYPvyusg9AQZYBP3ho1sFAmrG1FxEPCGeN7i+eccde2khz72xHKYAqtVxGQJkBF2zxWTOBEXSDu88MCNdfM32/Dkn2Mwb+PtdZajsGK+6SvViTsCHuNZM9jYeu5kfxlEJh6R03aOk1fSkrNQNdYXx6GtR+eJdzDQszHES8lQq6/WzcGczEsQRra7UUZKSGjd7czDAzMAaG7azIvNZN64gWvbwU0PocszCAuhFBgmRMlrpT+p+C6SwblKovT0yRmjD0B/9NgflQWXDDCRfdBTe/jO0lB4Om0t5vVCsYIhjREW0StpuKibcsI7rqtIQlAoFT2BEvsI4XIGoXnpMMriJ25nSrB71GIxSP9lv5A+OITAwCt4GwNhsN6etpxhBnxR4LvtjiHFvMy1bgPqbX1Ww8iiXoO68JmKae54DTkAPhgziKjvDyb6zAtJFEl09VMFqGYNQ57bXvzYCd6jTmzIgcWOgMdAlPwER/67NcJCVkWBFz336Qe6l7MN1FurUAlL6r+ecfz51j8Oaqc9XtCQmfDsTn3j47Eh+jjtSlwN2ucfkW/O9F4/JPQnO5Ltw6EaoXjLf+Rro0mOwf32HdSHjYFY8UgRGiHSQj+BbUUt7bAM7zq2xuk+uqJY7tCn4mEx38t8U6cXU+0MABjYKxl0KKut09BvV5+77XuRi/pzOZAL3KHeQ2CCmAb7lCt/KeTAx5gUFGkmhmcFZBoLF7I2AgwkMVteKZK9uNVrPWOK21TsbNw/bBSbt1Wt8/AZo5OtpvNP4nJaH7OxDqWN+hjvXdznprt3s1OEXq1qRWBiQrccHmwgODF3clE6pNW00Z8yEBCzQd72SyJIVF3Je9ii16FIqvU/PikzRiU/7ermhO6N+0v5i5lW8pc6emJ0Zs8B2nwaSQWggkJ3VPrA0I03KohHLTHbKE1qo14B8gtIP2YaPd2K+ftI6JwiiTwn4ZgIjW9YC7gHVQazRrrf1x86TdOAHI6ienCNZj4QVnce89ac19ytrbKNuoc7ACZ0lomlajkVc0E0q4sVQyhQoHdNx1HEIShgzFjZDZhWG8oCC6v15hb9NeLbhfw1ygairOji6mxalZjQR4Op8HLDsvsmpTA2NRGLC2TR5UUUykWqm8I8wdsOduvVKmaJQpGmWKRpmiUaZolCkaZYpGmaJR3oUtUzTKFI0yRaNM0finCaUyReOfTgFlikaZolGmaJQpGmWKRpmiUaZolCkaZYpGmaJRpmiUKRplikaZolGmaJQpGmWKRpmiUaZo/MA4L1M0yhSNMkWjTNEoUzTKFI0yRaNM0ShTNMoUjUqZolGmaPwtUjQOirIyug5eJWI9/GgHWIdDFWiz5a0I6RtNPYs+xmG7d2CYWS+YF2HxEEyWrmftQNvvbJfX5r5hI4T0nRGgOUuG5ygIvMTbMmJIxY3ieyQpHAMm6k321rBgvWJ9XbkY9Ax8w8Tjgl2ofuLa0J+pLihoVGS7YFp+zI3pUeO0dTA7OjCM1slB8/hwejoz9vcbp4enp0R5PAhAOT19EnrOYd9B6DueCTvyOyAECB9wTwDQ5LvfS6ExdpQtoq1epoSXyYQc9rZ7zQ6OgejdeUTPjXkGCW5tMsoZQrByMfDAt+d2YR6JsmfOeu86kws8a9SnjjhW7tyu4yrVDKACLah8IrkAZM0ATFWTAtdv5KhvdOhaN5QnQNLpkwodesjZC3okh45vRypWMsWXjNgru87rVbDkUDzQ1USRnCRjcm86pslXYe1CYvINalGL+6/By4wDkvLy4tKgKK5hWSKMG5IjRcEQFREFlW9n/aEYlVmzVAmQi+SmIHMA5DtYK2YI/hvRRIoLNbVIEJXpZEnMpaEbJ5BGKF2DPjFDeRRClzvREoa12XQYShxMsW0QPK5qpyVW8t4pibtLAcxZ6NE7ERh6ku+uHRA/lH8WJy/dccl8dJdDSCOejBtLiSQvelBn2Upvl2J88W2lkndL3i15d0fezb4cylxU+ZZMn2ZBQqorgxGoPHOmj0/U43rqY2Tymq7YSPpqmTSRfv4wlt85w0OTryu0z17QPhKqPAd8R++HeD5Vd/KV6o/3AgEkPIoVzEAScatNcMcQE6IEqvbzs73z/KkNBOoWmIh4xUMHNf3IpWNuI6jSCRjeWF8Yd1xddSAJSNc5rJqIxJWWZGlJltqo1EY/jDYqLcmSd0ve/Xvy7lZLUkNF3CLtpCBaLg1/LShNvsfV4rdw95mqihInstNWZa0VHIxpG6uSthwq01Zz2pwdm/zAMg6so/3TWcs8ahmHx83j5vSghVfsY11/E/OxZrI0TyX2W+wjoZguiOJNSSCuIPQ8Kx3+i/DbxzO6ORHGJjHsHRhwj59i2/EgbzteeSGsDbNia/E9vkx4cTK8EIdZYnjEm6wS46sTr/SlKsrTLE3H0nQs1U+pfn4Y9VOajiXvlrz79+TdZ5mOB0+ZjgfPMB0PGJpYVHjkzzQdLVukKclqIepuv8/lZV8ZfZRsL68VK0MvZUW2TgvuQHl05WqtjKUgFYl0Y3ShePOw2Ae09VVbyuqag4h08daJ7YmaenhiX2OU+CovJIhKLjCuv651ZnijUvCMojc9i+2aTgQQklBwPFEn5d6wQ12xQVRPMeYgqF8wxil36w/Fg9kQV3yBK2a9rybnyPM6/ntYdEugj/cpUVyMxF5vuC4gYuaGC26ETk/TJmhpqpemeqnuS3X/Y6j70lQvebfk3b8n7z7DVJfW0GZTHRrsbKpD23qDaVvqHd0M/94WO7GKhIDIm3km2epWbIOTXYFZztB+FZEMMcIF/LEnE4z3HmzrER4L019AEvkOtFiE4Spo7+09wAbBxjzWjZVdV8UGXe++bnrLvbv9AnETF1sAgWVF4tpy57ov/Ys6odW3KbOPyJImEEiWl+zjBJ+t46u72mtYDBPDVBNJ9vQYa2uAC/FTIFOdECm5NcLaJr7z+NR6ftnftg4xyIZ1FKFv61zQngGUmeUh+J9wu0R1cyqHJWafBFiIkKRUJ8I9jvUHRvnzOUEDbNZib7nhU8IZXnx59fOH8Ws2RwuTOFxUiOQ2ugTAI9dAIiTBOuoSCHYipRLXhuikrtkgx7CZAwtmH90R5+wmWaV9CLKYUNpJ1Uz59ErtjMXvuINar55M+Vru2Za7BxjaS9daeS0Ke6IrkEihqH90VbZcnPUqliiy9m5Wal1GYl3fCsR/qNFqYrQajRa8zkAhUHtjimvbJrAtDmE4AWHrmycX49US46HfBE9w1CwMorALwZG+HGWqXftmOFLj1XC8NBwf3Q8L28wWy1E1GWRRgz6mW3gB/y/GkHSQDW7mEXDRN4N1j5PWiCNqrUYCpJqYsmbXwBgk+C6AMVxBTMYUlTHZIrKIKrHkZ9pZ4PnPlFP7ObVmenwDOhNbWp4ZfDPMOGENJ6wJGRBI+IVKQsIC3sY1kBwQBNCN958kgQQ0IfPEWIVSnYbfoz6oGkwAlUYJVm3xRzsWcPIXoxfYWrcBEVyhUnryuhgWnpFjPcb5g7/LUs0iCpDFYB5exwN1mMGbgFefZaKK/KutF1fciYMl+KWIl5bSGyTJX0fu/kkSr5Q0P6KkkdYtBh1lKO+tZ617ceq1LFYYf+Bkm7FV+C2SxKdIJI/qT3pkaiZu/CZHNQZDfDsj9eUMVVpUflUiPejm70IUlHvUH3DY/vkGOeGWLxtsKwaZ/BCBhuF5nwfY9nEACRyVHM6AsbFusAYjXeP3qcLzhQXldV3zjWXZk5XbN9cMf9F1bK5V/aLT6ILIf5squkVFdH+cSqrJQqrftaCKrj6QLzSSqjOSz7bOFwnZoUrHxiIdf7xwRkHdjGYjV7ZCZvNvqBohcZErrbCD+Kd6CAnxv6FWQaJSgYjhqToCxZn8OpH/yez6THL91v2S0i2XtJ7PWRcJ5lvzy7NJ4Ymc8M2Z2slE7S2J04B3MC9pZ2TYL2nUiuhM/qguoLL78G94S5Y5hc0AIXFhvOQwKxDnaMOSDW8ubE5B/hWsASM9VbQjvSXZ3SvfQ2Ofy0puc1onVtYxHGNqO/jhD/ZBViX1MYKKyTUw6m+eDKWOgFSpSiQ7U4Ya6MvlMnLxgx4ARLRkBpiDT1hzWLM1Ek6H3BgBkCgKqnspCxzNREQFfXSA+8tgMBuJ7+gljLYn5gKbLZBHwYDIhL0VL2Qo9SK2S4fbnhobLMXagjvEHiAQuRukLLr+ODciDObK+weeP9+TnYI9bAuDYGhTEMN+vVFv4KOVF4TA9YlxxWcN1VcNX72LHOd1lpge4sNvYT+iDxVRxyBRoiP1wcKqRLtBFZF0Pb/UbYo667tyu3R5Rx5/w0TA9NFNVSKir0d4yH8hd9a6BlgdPQqq3kjnSaJMmw00ReQrK6e5qgwtVZ20qiyI0EMK2tj5DbOpgCNKP/xvSmTiA839qT9I6uOTrGLGMUFa8+UqJBolVl9LnpRAUlElQAga+HTH46DRkCfp1F16vkTWg+H5befssn9VZVJIyr+w8KqUmpO39EzDvhYFhkTRBWIUdM9DuYV1cmyktMcI6t4KD/uQTiIR0RVh85uKDJtD6zaoAFCXC6AjfPHwgAdBGER+xMdUzwuef4pjxGSfqJLHWvNsJK9XQwnta7rKIsnStjYBqs4u3XV8bFGBn184nnZAP6rPLo6jCBTxQt5/qJF8jzvmLnag2SN6iCOurW0/JY4drifIrlh2gq69iAMU37iHh/jvduUj/B99rZUQFtCInj9U1HEktBHDqrBRUdRE/gCMQ7P/A5tKw54= +sidebar_class_name: "put api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + + +## Request + +

Path Parameters

Body

required
    owner objectrequired
    + +Reference to an owning Identity Object + +
    cluster objectnullable
    + +Reference to the associated Cluster + +
    accountCorrelationConfig objectnullable
    + +Reference to an Account Correlation Config object + +
    accountCorrelationRule objectnullable
    + +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 objectnullable
    + +Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient. + +
    beforeProvisioningRule objectnullable
    + +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 + +
  • Array [
  • ]
    • passwordPolicies object[]nullable
    + +List of references to the associated PasswordPolicy objects. + +
  • Array [
  • ]
    • managementWorkgroup objectnullable
    + +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 objectrequired
    + +Reference to an owning Identity Object + +
    cluster objectnullable
    + +Reference to the associated Cluster + +
    accountCorrelationConfig objectnullable
    + +Reference to an Account Correlation Config object + +
    accountCorrelationRule objectnullable
    + +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 objectnullable
    + +Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient. + +
    beforeProvisioningRule objectnullable
    + +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 + +
  • Array [
  • ]
    • passwordPolicies object[]nullable
    + +List of references to the associated PasswordPolicy objects. + +
  • Array [
  • ]
    • managementWorkgroup objectnullable
    + +Reference to Management Workgroup for this Source + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/put-tagged-object.api.mdx b/docs/api/v3/put-tagged-object.api.mdx new file mode 100644 index 000000000..3bd215e2d --- /dev/null +++ b/docs/api/v3/put-tagged-object.api.mdx @@ -0,0 +1,83 @@ +--- +id: put-tagged-object +sidebar_label: Update Tagged Object +hide_title: true +hide_table_of_contents: true +api: eJztW/tv2zgS/lcI3Q/bFrGTOM7D/uXgOumeF2mTy+OKRRp0aYm2uStTOlJq6wvyv983Q0m2bCfNpcXtA0aBRo/h8JsnZ2jqLkhSZWWmEzOIgm6Q5tmVHI9VdDb8VYVZsBU4FeZWZ7Oge3MXXDtl+4nJ1Jesl2cTPAt0ZLqZHHen0sixCm7vb7cC3Dt651kJz8sFeBMpF1qd0nyY7WqincjTSGbKCSkyT54wuRglVmQTJVyqQj3SeJHNUtUEpFRaOVWZso5BaWKVSsDZCgxe4I4oCXs4UVMZdO/8g27gMqvNGG+UyaeEsNfvn1xefjy/OHszOD3Bi975+emg37sanL3DXb/39rw3+JEuT95dDa5OT97iL+4Gx3z/My4vznjg5dnxx/MzjP2Zb64v+idQxlZg1b9zbRWUm9lcrWpAsVgiGS2JnyWFZkhi9UVO05gk4Nnut9ZKraNHZH4SlMExA8FVgcKqkbLKhOohPGq0dzTqtPfah6rT3j9oDfeHw6N2qy33D/Y6h9FRQP5AEyuXvU6iGQFbxhGSR5mMXsk0jXXI/rj9qyNcd6sSJaVvLgmwqD/2E0vOnWnlaLB/fqFG6zjVSf3b381rFvW7MKQu7fHVGXsOGRaGX4O2Tr9i2oyCb25f1jzCMEtq9m2Fnd2jnaP9g6Nwv9UJD3Z2cRXKg1FnJ9zd292j6b37rQIweRzLIbFZ52//yJEyGlbJiGhEpF0ay5kgZs9C+l7HsZZTgb/kOPcAlumMXy2mtGMMuy9TVIVZWitnYKczNXVrg6cO/lQOVUwQxLAEFNGdNKLKnBW0m+D19cc3g3e9d32y+Xl/gMzwADzgvudQdWlinHfH1s4O/XnE28Vw5tOINBGCmJx/E1SboNoEVS2o2uviqI9ZTCZOrEW90RAXKsutwbzaa6tYusQQa5eAxrT5JGMdfVOE1eMiUpnUcT+J1pq7DvaNNqoxtlITQsWQQwwU4PhJRxghpomF2ZllaXCmq6/a0ERzV7yWEeT18vULYUiDVoa/gdfgCQFwbTTGi3KI0FFVt62ZVh0qOTzY6bTao4O2lK2j9u7h/rAzknt7O539TodmnyrnUEiu86P61D8qo6wORZyEsMh/oBC4PXTPAHjyNa73gA2YxxP0TzWSp63ELPAKqom3UMS+7p+L9qGIpRnn/FyOl5RgGteXK4EMyT3jM6vH2jyWKI9P3vSuTyn1XZz88/rkElfEa6W67hl4a0RuCajwhUnymREXAnyWTjgVQx0qaopXBddXEEgat0io/Z2bOSgTvjWSeZxhRDH7mhGLrMXIJtNaKIW+gRAvdFM1txDreDaVWTgRQ+lorTFM/qoXhirNGqeFJl+JCdKasi+bohdFmoSUsUA0ginGzzhpRBGFrmcwyhHKAKOzSZJnwiSZDpeq17kql9NqmUZOF41CwQHkX/eTXpjlAMdiLkZh5S0FxMI+wOw1V0d3taA0VunMZDKEFDKOZ1Cjtbz0QzadOVGkIzKXQ+IxJV2VsRazI6e7tx4MJ2+8C2XunhB35zHST4NFq158UkXwcfb22YitUZqpyEh4SWLz4IKqMlcZ+AK9XhxtYncTu5vYfWLsLr+8KLqH4i2XPrurpc+1kTn0a3nxXCl9LHuPQflVEHF5UxhyS0AhRYn00/srBPZvyhC9+pJSa/8d6yO/lK+A71X28M+HVH5UxqrZggCyHr0EI2QiFXUZ9xwxK8qram91tjeJHWo4qFlTIiJrWjFLciGhMpsbQ0ik2xJRopz5IRMTifwoERHO+QxIs5qokSbaZJtKclNJblajzWr011mNNpXkJnY3sfvnjN1HK8kKFUdLUSe5fDqVduY9rXhP0koBAlHuY4sq5NhUy9UKMRNVjRXUK4dg2Nod7o4OQ9WOZDs62OuMWuFBS+4f7h7uDtutw2Bxrb+Zx3EVZPWYWrC3tyOrGEXcJ9RxuYFzuSxJovr2X86/hVFa4x3Jsm6GzqHS26p2bHXW7NQniXgrzayskFythjRzHVFOA+2UaG1JCwIpxsiLRiBVaeAiV9JTBS4WTiNiPdUcvCQF+NpZozfKIIoPlNLJqlm0CeMcCDkTxAlVzQkcS0NINaKaDxy4gh0jO3/H6rQw0TdV8uKCJD4licXJl1ApCvSqct9ft787AHhLOeLSG/iBjV7f7UgDB0BD4HNWVXdu6vNNfb5Z4zdr/F9jjd/U55vY3cTunzN2/4f6vKiGHq7PQfDk+hy0zR1R1VJvyLn+72U6h0qBgN1bJGGYW95uLmtwrivgSsVhRsohdEauG2z743UNL6jbviPfuN++09F9QKccqTj0uHIbg36SZanrboNOGZjpvilT3UQWg8WymUk+N8Nkuv1pb03yoVMCPtCQvqI85E3n3vmgaDGarGSryY990uMJvMpZLPJYqJ63hx/lXx7rmCU50hyz2aLzK4VP8WPATNFQ/OCYusk+tCIjZLu28f3X5PnX3mNyeCYPyLFOfY/OBXoBlEviEfzb+aHUS6q8/ewrR1Pnqwl1a62Vyc6IrCVeK2nRFvgfMF789P7qpRhTvcnxnjsqdZWmBgERcw4X4XzWKzfzaRAvMTbJxxMG3qv9XELxI0YxBBYfzKVS4mZQKOEdEv0FMjOrlAYpTgY06vZFaZlIfVIxrYHNuSbJ8XRktqGhbVkb95LXO24MtMHllJ82P5iGONaUhjSt20RTiMh9nrhJS7nkglzPBfG3klvDc2swN/dyCYVX7U3oj9+ECGJiIWPH2nr25J5fY4EfdVF4QlyXMZAmChz1H7nC0mrPxlHj1yB+dRwfzPuJxmJaHyZ87hIOa2EciYEIJ0ni1N+FINehMLgZ54iiZ8P6TJM2OCIarZ0FSA0/ZUM3UBoyvlMEhvHOJIe0NHNlkqBoM5EPyV/Ysoj5X/jc4S81mfnxDVZQooyS0D0bM03YoAkbPge4Ar9foMixENskA+cB7wD9uf05ExRAF3Ke57U2qzP7bR5DS0MIqMzFpV1/050nuOJK8AuirmiQgqmyrn72w70oeNEqVVNWuSewrMFVvHGCxXFJbx5vtSdFC+YfTV6SuDffOjkz8ex7Z+kHMskfJ+/+Thlvk2n+ipmmqHVpC/Ji/nXFSdmVrD+ZvXDumU43f/0ccvVpyfI54Pk3PmtO4YI7ooDnLXqVxdjzReTq/iJtgE8U/sdbTiBc66OT4t6QS6tFNmksMwo1TjXhRCvemUiVzKgg3SJ3T6acHlCFU05C/8mMxhY0yCUORbIc6hj8muI9Wj8TwvLU9tFZDnD9NSn6v0sY/5x8RxyX/oS6bjrNDcZS6OdTIeG1X3G6SLsw97kRXaBRpWQJV5fVqDJRkDeTKprcANmpOxvRFja64wXf+spccC1X7F9DkWSRwp5zQS5UzM5PdPWu4Gu84dCNiYpT8gYkdtR4amGGt4OrFY5gZhzkQoOf2PF2MchtEy2YUAfmnWGviXaTHqWJy9AlL/C95o+QRO3TsmVnupvv2D/3G7MiYqid2E5pH4zQ5L698R3lTVDvKDGoW3x31kV0oUuZADzR3d3Rlgk1WPf0GNFK/fjN7bx/4r4TeqVrBOYIyWT5aP+iTC8uii+oXoonfkC2Vpxy88/M5n1/gMvfFG0XFN9BfAOup35N9gxwUPA9JRq/2cTq8y+KXzcaV94S5cCVn21IMD/Cb2A9Snu7sKlwfk1+PSw+ZZv67RErP+Mh/d8NPuAfbpLURxV970bP74JysxE0nm1ZBq6rgooLeAnI/gsmIveb +sidebar_class_name: "put api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Update Tagged Object

+ + + + + +This updates a tagged object for the specified type. + +## Request + +

Path Parameters

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/put-translations.api.mdx b/docs/api/v3/put-translations.api.mdx new file mode 100644 index 000000000..57b7c8145 --- /dev/null +++ b/docs/api/v3/put-translations.api.mdx @@ -0,0 +1,100 @@ +--- +id: put-translations +sidebar_label: putTranslations +hide_title: true +hide_table_of_contents: true +api: eJztW1tTGzsS/iuq2YdcyhduCYtfthwgZzmHAMtl8wBUIs/ItpKxNJE0gA/l/77dLc3F2EBC5WxOUvMC9ozU6nt/LUu3keMjG/XOo22tlIidNja6bEU6E4Y7qdVeEvWiLHenhiub0iMbtaJE2NjIDL/C+7Ms4U4wzuKCyDPLXG0Gy61UIyadZX4eU3wiOheqz5z+LBS7lm7MDo9/+9Dfebd3wHjuxtpIN2XSMiO+5NKIBIaymKcpc2N42j/a6wAjGTdAyQmDQtxGSBYY8osc4JdWJJHFjLvxAt+nY8GqoeyKp7lgeggLiEqUDjuhIUga2cGXuZJfYKhM2Ego1BRwx101h8VGkOTIYsF/1HMmF63IumlKTMpJliKD4iZLdQKPhjy1OCAeiwmPereRm2Y00hlQH43kNKcX8ZNKxNmsVUqealDRXakXOLh/AZVP0BsSJKE0/BlK+GOvkEqO+nbw5zO++HPcPn1PU3A1fDw0/vH2Afwf42iBvhLjn08cJ6doAvykUvSyShxYb7bMOl4ctDzPsnSKH4JxhnLUYXtDpjS7knyQlmPBRCN5JVQL3A38CvwlEUOepw4nXwC7F1E0u/RKEda90ckUNXFXR7CEE8rhqwlMluBorjvUZtIGXyfdLWhRDz6B9cEcYBCgZzPwfNAADFhbWcF/i/LVAyb3UZQIxyUqqsYBCi9j8qjuJ4uz718e1GwwfJ30a0+EtXwklll7kR+/OHhzmMVAYsZV4K3DTqeZxBickhmMSAVo2jFhDIwr5lyPIaKt4y63aA162Znz3lzZPMu0wbi5sQm7gvgFJloMXnMrmID3BiwKa1pXH8HGzmW9bvf6+rpjgdNMS+U6sZ50YVC3fPIBDfVh7cNKB+dKzD+wEspidW7iwoHQ52qp4qs0VMV4LZPNCWeFuZKxUPoa6XvNJW9Bq7a2AjeGT5cukEoQGZJQmMiGOJNV+hpM5/MTRlOephgChe9KJyZ2UZxZjcvzKNNJV5tRtyRELHZR4+Uj+rba+cRNdIm6Ips+lDd2j48Pj+H72dFO/3R3Bz8dbP+7f/AbfT75Y+/oCD5dPqzYEAhhtbpqPXkMLycdPfGlZ8fHjI+8jWXBtp1KdNRdctQ2OxYuNwq0KYfBkykZsAFkA/QXqaAYyKTz/cLQR9Y25fnH/OytVKI9Mlwihz62YpjIgOKVTLCSTrQpgrUoWEvCDDTRWWVveALyevm2gzCoQcPjz0ALK/xjDJ35eldMwcKHwXTPsmJT8MHrla21jeHrDc7X/rmxuvlqsDXk6+srW6+2tnD1kCseD4nfsMDK2Gd3+ScoBEor6J4YoMWjRYe/xwahOH5VnIdqUohZ5DYnblwLkM6b7SO2sQkZSo1yes5Hd5Sg2mcnC7EJknvCh0aOpHoolHZ23/bP9k/hyfHuf852T+AT0lqInb4Cb03QLYFV8IWxviaOgwDXHJIH5OkYckeHvQxUX4JAAM/qAwO0sVMLyixqJswIqy+ZUSfNhkZP5kKJ4ubGseeyIzotNsBnE+7iMRtwzMZgQhz+sh/HInPt/aDJl2wseCLMiw7rJ4lEIXnqoZmF+VMgxHiSYOh6AsPcYa1ABKlzSMfaQfKdt0WlyruZskgj+3WjYHAA54/7ST92OTBHYtajsPSWwGKwD/DsNTfP3WlNaaTSqXI8dqHOxtoY0DAbgGyIn0M6QnNZSDyqGFdmrHp2pHT3zjOz4zS9i3luvyLujlJIP20SrXxxJULwWcRSPhuRNQozhYwUUBpNDqNKcxWBD3VNpEkTu03sNrH7lbF79+VxaDHCW4I+q4vQ50yFdhqL5wL0MeQ90EUVgwjeBEO2GCgkQKTf35+GZh0x/U2GzdJ3xEe+lC8w3y/t4Z8PEH6UxpqzBTJIevQSDKmR6RHfFcekKK+q9cXV3mozkOCgaglEhKxp2FTnjIPKTK4UcsJtiyVaWPXMsTGH/MghIqz1GRBXVUnb9ygNkmyQZFONmmr0y1SjBkk2sdvE7s8Zuw8iyZIripaAk2w+mXAz9Z4W3qO0nMEAVmx2szLkyFR30QoSYyXGiuaRQzRYWx2sDjdjsZHwjeT1+tZwLX69xl9trm6uDjbWNqN6rT+v4rgMsvmYqtnb29H/3CPMFeC4XIFzWad1Mr/9B+o1YohpjX5zKHAz6BxUellhx41F7HigHcgGhAE7mnu2F8+O95E+LE3kUW9+PxqDllQHw7kjSIk+DJqW1jXQsYGOTflpys8vU34a6NjEbhO7P2fsfhN03HgMOm58A3TcYAixhgixfiR0TAB3IDQbglHwyFMO6lUIGzMQBT6F3ccQ9o6bkXAl0JtDkWtbSw6FaM3ecTUtwJKd24lUlbowvcHYCY41xVgYwP3pFwZZSwK6Ra+SE4GYFH9TT+VEUhyjQEDXTNv9oQOpfMwU/lauIlWc5sAhJYVU496rBh+T4E5iiPAPKNA+6AgS9Xfc46wdWnnyfjA7Ron3UWK2exMLgTFf7v++WnZKYA+YN5guTryt7zku4PfM8ViMEjeZT18lBG2gegPVm3LflPtfo9w3UL2J3SZ2f87Y/QaoHtDQ/VAdBnw1VIexnRVWYqm36Fz/d8ROoRI48Me/dUxYPakwOB5pFfBQuiktcgYQf9u7cj93Y4xMmaheeTK17Y8N9/wB1egSj5FPBPhiuCSBSQhP3Pei6lSt7d5WR4xn3fqtiO6tF2IWtSLfXHhZc5MCCTzpbHvd7i24AJh+1uGZ7EBmBC9wU6Wv6dTz1fqShCZtEeCQEpM8poakf7QXOpgOGc7QoXmfSGkBb0ZSFUZBcZT6Qfp0JwL8YwrNDfNkWsyVZ8TpMbCZQZPyzPo7H+SXCzKCbGcmnT0mz3/XH5LDE7lHjmXqe3AtGM+AyzviIfuXlducIJr3qy84T1Wh8HeEtYXFDnHYGnsjuIFWwx+tef77+9MXtUsl/t6MkNh0QBQegYtQjuwXx0xwEpUto/PRmBjvzx3kwZhkwxQEZhfqRAh2vheUcADF4xiyPakUJwlKMDjr8nlhmURciRTr6p3j9hAXXdBQl8/Ne0E1lJoNqfAMvr8Ec6HabEdiaqPLQDgmiEi9IzvPCrl4Ta6nMvGPglrbU2sTNfviDhdeteexPxgeQ2JAEjy1pK0nL+7ptWv0sDODJ0j1Lg+oicDH/PGruLDak/mYo9dGevN8XKj3YwkFen4a8+mMWaivacL2WDzW2op/MYaug2FwPsohip7M1jUu2qaIaK+t1Fhq+yXbsg1wk/jbh8BQ3pn4AMs9oR3tN14oJD+SZSHmP0IznrCPczLT43Ooyjgy0bF9Ms+4YBsXbPscYAP/vuihY0FsowyUB7wDbFf2p0wQGK3lPE9raVYn8l2ag6UhBlaJis16/kuvSnDF5SZ6gaPLMZCCEa2XB9Lw6lyghZVvTlnFPsNdDS7ym2oouHf05vktfy3FIvx3kxcl7lfbMYcqnX7vLH1PJvn75N0flPGaTPMrZpqAn9HdaNnQaNSd3KO1xc1B3L0eC/gLbylSCahDG+SvASOGqZPJAC6jT1NMx2MpaFshE9wh8muhX+kJxSHAXQx+aB6J0Agv4Qq8qMehEZQp0Ouw93i7MAYVY8+Gx3mB6icdmrcT0PIRGontFIYDADWZ5ArvIgMT+QTv+T5m3UTaOPdJKPQBniFNMK6cVUQkug2qokPdi5nYw+GJv0NYM+Ija4ENbdh8BkWiRcKF4EqQY1Hd356H34/RBs9pj0WaYdeY4tVGK2orvNs7XaAIxFT4xQPvGIZJtotjgUi4zQkT1jvQK+KjTFsHLW6NLjRU7KFr57fVVvuPvIEeygfi/m6Gm2B069P3Ib4bPI+qbhAm9OZup7t5CXuh0YUeYwwawcm3t7iJgu3RDB9/yQV26OeXVfdDXSMYCz8n5TXye5X1/DjI84J+Bvrrb8AvVVGxm6im1UZCBB8/C9x/qOkI28UnC/cXXSB/kkzBtDO8Sus3vshw/mX4paV9OiVYU0xedvccFeIn+f202vCFX5zmtiiOzjBSB+HG+8Tv1iBdItuqPoJ3BYS4DCCFDzhoNvsfbnImzw== +sidebar_class_name: "put api-method" +info_path: docs/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 'putTranslations' (put-translations)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

putTranslations

+ + + + + +Update a connector's translations using its script name. +A token with ORG_ADMIN authority is required to call this API. + +## Request + +

Path Parameters

Body

required
    + +object + +
+ +The connector's update detail + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/query-password-info.api.mdx b/docs/api/v3/query-password-info.api.mdx new file mode 100644 index 000000000..7ad921edd --- /dev/null +++ b/docs/api/v3/query-password-info.api.mdx @@ -0,0 +1,95 @@ +--- +id: query-password-info +sidebar_label: Query Password Info +hide_title: true +hide_table_of_contents: true +api: eJztG2tz2rj2r2i4H3abxrwJITM7d5yQpqR5A03z6NwKW4CCLTmyHUIz/e/3HMkGOyRNbre7d3eHtlPAlo7O++Xjh4IMmKIRl6LjFrYKtzFTsxMahlOp3I4YysJ6IaKjsLB1VUgvk0Mq6Ij5TESFz+sFl4WO4gGCAAC9MQ+JfdIh8BGHzCWRJBooCdLtink0gjscwCtfn10k1+Ja2LB4wgSZ8mhMrhAIjaOxVDyaff51HEVBuFUqueyOeYh0MaTcCyQXUdGRfom7okQDXsItgBl3NOB/OR6HX5ajmItXqRdaI0XhytCT0zdwLOCp2G3MlcHVoZ5HooSIIiHXhRwe1wVYPWQqxLU0wTca04hI4c3ImMKNMYNd5tz/ZM6FrddCn02iWcDWCRUuLgZ4UjEiJPJLEUeKiN1HRWKTK6AylIJ6hDoOC0Nz3A+zIoVmGWiWhhYiD6Sa0zJiAvUBmKGlgMRcJdR/1WD+40iX/TAOOVAWgnokjgWDAAEQxdra0XFvbY2A5kyAx0Y0TLj6JMNDSr7UyzXyTqoBd4HbX0BEYSBFCHIQGsiAwaUoVoK5xWsBKo0SZ2G0Ld1ZYeuhkCpAYStSMVsvaBmAdsMtGgRegnzpJkQVfyiEzpj5FL8hnqD0cnDDnAjgBgpZEXEW4l2U5xH1WWZlGCkuRoVlq2HEkyMuiID1RA4143E/LGX31A883G0PBrNi1wfBFL6tF0IZK4e9/gCXh4FHZ7kjDIzcIYczy24XvsEBEY/0law/OEVbbveOYQEuSTmt6a2Wy/iRP/kMzYUJh6HF4JFzP4D2Xyz8NG5zbWjRDP3YS+zoJGtJp52jveq0KpvlzUazXh8yp14rV5r1jWGLNgYOq2+UGwu2v+YUs/KZM2oIeaNedZIzWuXNzXq5UqV4RhAPgA8f2KuIMYvJhC2Rc1Q9rBz39vnh3m502N73Lrvl8uV5v3bQm8wuervR0Y3duPA7jaPz3drl+cdx7uiXD+6Dfv4Sksz52mds05Bt1MFIwbzNtoxydTrbnRv7aHs0uR1P+F5rWt62T3ff2fbxjn26aeP9ndEH+L5rx3vvJue8ut9s9L5GwYCefHBrG4N90dmu7W+OLjf6juy2ZLd9Ed5ufz0JeuHw8tMF3R3WL+rbH/ZG+51P/m7Jm46n8U3T71d45F5Wb3vdo3eR+GRvvhPNhlPr9yeTt+O3U/dyMIm7/q0X7svaWeVY7E+mk/3RyLFnrf27SevGc9TRwblUwWll2lK0f3cf3Q1Hk657W2nUPtxL0ODTynuHd2eXZWGXPkzLfRo7B2IsN+/dMzm9DCsVOvy098ludXqt9xvtzd7G174bde99WD97/9b3Yp82DtzekB42yuc1r3SwedvY+Khu/ftqcNnhU/e+VH47ql28fXvzsVn+Kv3y5fZkp3Lod+XBoTq92Gscd3aOblSzOmxubldP6N6nIVWn72/ts4ObD8Hhx6h10TnttO1TexslDWFAxiIKM4KmStHZkpxts1Ab7Dx6J3GdYyBPrQm98dyj8Ij54ctmm2DxGkVP8ei0U/eVbC4SnXbAvzBgDh8iUnBEepsYFwL4Z3weBtohH8UqSUA6UTZlAV8ZAQoxD8cplLBIDjFQay44VGBUGcINl2AMJ2lAhODnxwK48SggRo1S6nWO5NTakUIAO6QKS+/hpyutjgXU8pEA7lpUWMmpFo2AGYMYL0LIHjMr4YLVaVuQOFi0FFErKG2Wa41yztR2jn7DeEF0vFg/7v9mx0iT/uaD4Bwa4vc28+V6e+c3sGWOn9TxGX4CzhkleV2UaT8RYf5IET1/2F9KUsg8lJWRVLNeLm8+G9afCbsJKH0/kOBuE+v5rt3OE3bgI0iMcjT2ZcNMhPktg9JVIY3SZyxgaO87Y6qQ+zU04OTeIRe2F4wpXq/krx8wMYJQADca+RtHsdY9s+Xzc+Qm2UX9qYRiR2fWZFcpSFstcpYkdoQbFUhSOzKA3A5P4eKOetz9iYmGyyLQlx3IXV+2iHdc6AyXI4ZMo4xJLwGIdxyjI/FRUw3IVIv1umJORYATxQpEVhfoNfTtJMQgBxV1JgDrNT60LzjsJ+kW8N1gGuq5Y1mT0cFGuVWtQ6pCaXWzXmk2Bq0hrdXKrUarhaf7UEtAOfiyOu5haQGi9yQUWfwrw0qQAu81Avrw10cNDePViTWunZOZ4EuwyoICgmzvnJB6k3gU3L2+TkePmCCsfheuiNjz6AAvYZUAlBvAx4pD4v4UKkzEPtpSG/Kb/kEPrpztnvZ3u/ANYS3VzrYAbXVRLQFV0IWxnGqMEwKmUFyGzAN2QBlD1hKoa0AQFWF2ITe/wlkIzATdGtLYA5+4lpz+xI4saDJU0s+ZUlKSkl95kRXXwZvCNajbnTEZUHTG0jjtNXBSLIisg4STa+BuqcvUG6hlXZcjkVDKgjUCUNg/Q7dMoWBzU68/jMGUmU4iZRxBRQxlI8vLYsHKvDQWbuQgKxQ0DsD8NalFFANymsysFc61JUExkQ/gbDiXx66XYZpm6UxE1MHi1/NmwEalgMMEQgThUUgSd6RjIjgeka6be6ysd9Tu7tAg046kvufQOHxNGPDA/ViatPmNO5YYn25kGG+kpZGKKfFISc2mNyer5uJKDZ9AMPfcle2ubHdlu6+03cc3z5I2SnJXpz6V5dSnL9L+GRCxlPoorT1CklyTLRHkOgGGJCnS/nkv6fZhL+0+wNbXT8yPTChfQt6ey8NcH2D6MRdWThaIoOajoWAInoi5WxrvBcaaUYZVteXT5t3AJ1JE3WedyZhQYJmKhUBMoBoirmSh+CUiY3rHFj3Xec/RMjXCKpNcZZKraLSKRv+YaLTKJFe2u7Ldv6ftfjeTnGOlrSXJk8LY96maGU1L7iO1lOBT1Pmj07nJaVE9zlYKuSeuhXzmUBhUK4PKsOmwukvr7katNaw6G1XaaFaalUG92ixkY/3Vwo7nRpa3qYy8jRw1iyGJu4M8LhagXGEkpZtv/wF7FRuiW9OP6tO8GXgOLP08zx2rreXcsSclzjjM0gwpzOWQYsEj9Gmw1se1Kl0LCygZgV8U2ODmgBeqEvcZQMEn68TjPtfGi1QAXDWz7GEEpBhDSZVsfgoXjhcDhtoTeBKzZgmKxYFIMzoAEHQGOwLv/BOz00REvyuTJ2dI8QFSTHbvHcbQ0OeZe+Op/m4HkFfoI7pGwM80ek21QwUoABQExmfN885Vfr7Kz1cxfhXj/xkxfpWfr2x3Zbt/T9v9H/LzJBt6Pj+HBa/Oz2FtsUzmudQ7VK4/PU3XppJgoNWbSMeJlW43pzm4zitAlRChQIbaidBoDL9Kem7YSocHLG7GkU3ebzCKlQcL04GOBxAUCOhbkQa8mA4lCTnVUx13tSfcjplI0VOJSrqxo9vNOPBrDilq9iqOGmzcnT7AMFsThLqaDo98F346pTKTMTg4DWYdx1wTbdKXAc0ASolfQr26qLVniUagra+8by/R87H2PToMkGfoeIp93z0L1hPA8hF5iP5nFBdIHABpeeHE4I7xU3aMQr76nF3TxbzcYLi0chFrsJarLiF0jMuqZJtRBUWDebzx6/55701mpDkOMRFmHMsHsKeTdLzazoxXEx2AlIxHZvrZzj1MQesiOKuME+tdxshVZlSInIHf1my3c1PPPzot/UZHQz8dZUpn5a+FRdocnRTHqI5rEhJ1FfgnjY0/wsKw9sqMvZPM2Lvm1h80vv8EJxI88o/AnFRqf9DcOr68cD7mEGrz24jxbCSESOm5pEOcsZQh+zchqDpoKlejmP+OcfopHmppi7Cq5QxKljnS4hYkjhq/AzAMYZSJDjBw67xFQkonXGO2X7RkwS980YOcX3I068tXEF9xpSud8IdxxgMtPNAyfiJM8DfhCxULbBtp0H7AKMDOQv7aEySIZvyigfWk59fgS3oPhg8HUNVQwmDL/NhaOMHkG9E3cPV8DbhpzLvnDwXxPZEEFsawHLPSjsFjDi7jq4f+H/HN4DvvWGE4/avRixTbi8bKsfBmP9tLP+NJ/jp+9//k8Vae5p/oaZJMGBuUZ4t3k3bTmiX7LlF2XDj/ElD66g7U55gqI/pJ6ZE1FpMZLrcLsZ89ZvA/3NUWr1N3KIwWb4JlwQQejdA2tG9wxpzpRgMOC2OWuY76KX1tz5BaoxOBclIDGikcKFZAOIXSkHs4gE3OmX5fJFZYxeFoBkC9kUk51wVpnaCwSTtVAEjEkuFttNXYJzQiL2mJy0MnNs7MMTPdBiGp08H5rtSyUf2QFUVdzyg/PB5iRxqK3YwyvHAW6EKYtKOBkSgRYSS1IOQM36dAhwLr8qn+S7BBA60x8wIUOHhiSMpY5oTDTm8JIgATRmGKUo1KyaawhGsBCJZVRhlqRage9dtAUJFB0ZuBq18AI/PR8uQd0ZwuPSz676v3QVfvg/4N3gdNkhZkdCnAJirqfmwqZNONuCo81Y2A2nWMPQu4/fCAbTYszb/hZb0a69tF5a2rXdig2226HJ7gW3aF5PmO1ZvpFCzp5yw/uMJmgNlhWnjfXfs501Y5OcZmZmGQvO3qmw6RolO4iP9vFa7hL/yQgfFE+EosXn8opP1WWGPg4p//Atig2BM= +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/reassign-identity-certifications.api.mdx b/docs/api/v3/reassign-identity-certifications.api.mdx new file mode 100644 index 000000000..1857658a7 --- /dev/null +++ b/docs/api/v3/reassign-identity-certifications.api.mdx @@ -0,0 +1,95 @@ +--- +id: reassign-identity-certifications +sidebar_label: Reassign Identities or Items +hide_title: true +hide_table_of_contents: true +api: eJztXFlz4zYS/iso7UNmpqxbvvSS1cgaR1lfK8uZmnhcMxAJSUgoQsvDttbl/77dDYAiRVqWZ52ztKlNLBJoNBrdXx8A8VBScxHwSCq/75bapUDwMJQT+CH8SEaLrggiOZYOtQhLO6WIT8JS+7q08uJmp+SK0AnkHH8DoeFUhqxz0WeWYsjiOYsU260xqYlLETIVMBmJWcikz7hv3yyYw2dzDr2Ykx4H+3NfRVMRAN1bKe5EUGEdePyr8NmdjKbsfHD8pXN02j9D0t3eYGh+8TiaqgBJA1+B+E8sA+EiPYd7HosMtxU2MGRDNgYC9DzLggNsci/MdUwm7CqYFzDJwng+V0FEo4kw0hQzxEKmZaM5OVa3IvC57wh2HKh4HlZA3nMe8JmIgCGQ+kNJomznPJrCKx9ewC/pwt+hMxUzXmo/lKLFHJ+GUSD9Selxp2QnW2pHQSzy6ySelXr/CEYQ9/DSQ9Ji3DwYH7aarX1x2Nrda4x2R6ODVqPFd/eah/vuQenxRo8Kk36v3AVytcqEo/wIBsVXfD73zEjVX0Jk6iE/HTX6RTgRyiNAhUXd0WS1AFMteRDwBTQktXqeAkgvJ7QiGfWPmBqTrpLOWomNBHRIdFy4lRdKascMvQkL2GJzJvx4hnY67AyOe8Mvl1enp53BJ3jRH/ZO8T9HvbNhf/gpeXOTZpwaPWaU51orGrEJbWFgajkwow7EWAQCdNd000+H6iXSjdK6CAZxN5XOlJ5m9ZEs2E72xQLHrsrfjC/dljlqNgO2yIDvpgtiyXLA7njIZtwVGUaW/FGnUM0ssZxYEx3OiC3hMyNrxCYrcSCkSYVzQBKtzY1aDf+TnUjneVx1RcSlB3A0BqTB6cIsIlSq9ExRBKhar2S72vKWIms4h/WD2kFz122I3freQa2+6zYb44PDmsPruwd1q3xPLph0rRJlJodrrqEyPdqligMA2vM7HybccRwRhgb7acF60EwtBCD5dUgtb54dHsd4kgEr9yKx5GyMuDXDLbsO9c/0oLgWQSA8Hgn3MuJRjB56xn2XRypYdLXWDjR5/BOV6dvgL/Yl4HnKTi1XLwc8uxbPD5qRaOF4XavOZ0h0DZpaOOx2Ti86/eOzooBlibB6aWBcHiHYWHw1CLcC8gnJx5W1WsPGaeesc9wbwJPL86tBt/fl/OOZ/tnrDLo/rOfuaXFYso8r3TcRdurJ6iAsFBEbadjj7gxCtbspxD+AC6B34I6QCT/2PD5CLrSDXzLVWUeahLaqwzkEQ/5WW+Ukwc59b8HS8kzehRS1jQS78pdkIHD0Mw9ygZ6ZvUK60ne8GLjK9khFsm/SMAtKE2faoddmU46BIeOOo2If4kFFMa+NTGHUW8E02rxNu/Du+WDQO+kMexiGXZ2lfmZ8dur543oUeFYfjjDghHWGad1NBYXbxgWCiwjEMn5GqHSFI0MKZt0Yqa2IUcfpYYV9UjEtg+m8pIhEMJZOCO1gJwjpyyT51GNoCPJLHlTYe3w95rEX7WQ5xPi7mMu0ZDsnJ1+Oet3+Zf/87BKeD3o/nf8LlOfs5FPm+dl56mdG6Jk36I6tr7bIlIqLUNPJsYo06I6U8gT3c2vwAwdtyIgFFBiyHAw1vk9bPdob0F6qYrdgFAkueyKCYpiNZyNYYYwsl+qsQx01W2FhilwlfID6uiRuO7EMHO3ulIDKjEd6/GajlGFzqCLubchihG2LGQU0QhjI5KM7bARJYsIVsQkGXMRkvVbEpcG2lQClVj8o1/bKjd1ho9ZuNNqNg0q91vq5lKIANifKkVz67ydtzMIn9iCDVS7w/9uOacdIBk0W9hQD2JeqC0R/AeSsVW2tVe786qs7T7gTkdIYcqJZtcksQKNwAZL+/4+WbMJfhpdWMS9xoS8vlH+BX4WwCVsUhoZZ902LXa+V64fDerPdOmw39yvNg92fkQmT7GzKx6o7LuALedLhva54MJOvqPEYPVPOqDbn1VJ8vex7GdonZZ/fKe4sHs9WiZK4EzIe6W1GnZpmyaPXtLFDdiA7/D8jEUYVQLBNglyb2z8fRj43fEIpi4lPB3uvi1cU96Vwch3bKxD6e7KYgdW1PD6uJvNgJKlyyUp0lhjN6mSyRjQOQC1+A1Nbg1S/YZ739KAZNNo84+sNhv0P/W5nCDHaSsScebUFri1wbYHrJcCVTnfStrma82yWdOokXxda4f8CMzfIPgsiESq5PlEBHmQLrzxddV2tWRNf8Bzy8l4QqKCg8qD3wcaUaBQAFKX0kNMK7L4U+TKnSxgbcy/ENI1anoow5BORH+6ooFKSGc8OtKolOYtKBDJczzOwNIcHGwKMEwcBrg91yVVgPvvv2NfLYee4d/S1zYbpCpIMYdGkLikrrMRwJ5K3VIahXp3usP9Tr6AXtROGdP/4LCGdhK04nXzoamns6OSP6ngOxPug06hYSS742U/hj+YdHmh2sB5HQ2bdRvKyUPkvSJppdSvcSz2KlCngt4pq9l1PopxJLVmZDUQUB74uJGkbpd01SHNdKjZJ/5Z70n3F6rzeEegqdwPN+CB9UZ4EXCKHpFYgX1cwzL6ki2s+U4EwmwxWa6hdFrRBEpU6e89dNjDz65rJoDQDyN+AVn8Dz3ulq9W2C3phvZtbOKzYF3y0VztstMZ7Lc4bB636/u7ocMybzdrh7uEhIbS22PSGot1ozA59LHwRSId5yoEV+S8IxOwhIQPWejfcmyQaG1qmbptM0/DLInEfgQmw990L1tpnHvcnMT3nkxUh+OWryxywwMw14fNATmRhJdnazlHvQ+fqZEhVtH9f9S7hL6SV8+RYJvVdVEtFSfpU3RHHZgII7aHwQBxYoX1nqL6DCXEqJiQNpf4VLkLcDjVVQOhhRi/okSbNMGjOmBLZzX3E3siKqOwARMEz8KnOlI3AoF2LK+9wr2gelU+MJN+xqeCAKW8rrOO6EifJPQbWCESh/4KwznXRdDWBcQymLOiwgoojLFRKJ1sRSYkyB/MGUk7Si4LGAZw/rycdJ4qBOZpm2goTbTEsmvUBnrXkKjmHYoVGIl34EaI0nodY6DK9A8gEc5NRyAwc4XKFADy+bZcgVhopeynnqAESt1TicAO7u/AAfso0teTFrd1zDdHpaDSi1bDLZBAJXuK0qbNplSyXNXwGMYDnbm13a7tb293QdldfDsxJhXToU8+HPle+2RFD55kLfQLSHtxFM41MTEsLSTtEJkT68ePQnAuD9uJ+jjtBrxgfaVeeP2uRrId+PrKHKKzrX64FMkhy1DMYAxIJt018LzkmQWlRNfOjfVDBSIKC+gUhIqBmwBYq1ht2se8jJzzcofNp/nemJs/1yQdCQBzVd8tzJV/1nMc2ktxGkltvtPVG20hyG0lubXdru68dSSZckbWYOCmMZzMeLLSmmfd0JIBBA2bPzLLE5GipVqMVJMaSGKuUjRxKo0Z9VB/vO6Ll8pa71zwcN5y9Bt/dr+/XR63Gfint66+XdpwYWdamUuut15FEDEHcLcRxsQ/KFUZKudnyX4ynnMYIa/RphI2b6Uze480ydmzlY8czFcHcgDDEjsET5cWrwYk+9qjJo9z0sVk02tQZyeSTB3Evw2gbOm5Dx6372bqfv4372YaOW9vd2u5f03ZfFDq2ngsdWy8IHVsMQ6wxhlh/ZOjoQtyBodlY4lntZAc/EHOYCvxlqo/G7CMeTESUBHqZKLJxWPBlhlLslPsLGyyFmUqkvxQXwhu0nWHb5INY/OiXTQAifQaoJZU+LCVnAmNSPJLiyZkkO8YJAd1gUe7QJ2raZqy+JaMkX2kgKHhKnzbAgwdgRWMM/4AC1UEnANSvWOOcPXWg4wX1YDbAGZ/gjFnv3hECbT6p/+4WnRLo4zEZhItLvdZPHBfQNXPuQxoh7ucavpIQdBuqb0P1rbvfuvu/h7vfhupb293a7l/Tdl8Qqpto6OlQHRpsHKpD20qNJbHUB1Su3z1iJ1MxHJB6M+VQrO4uY3CKK0CVkKG5okIrXQXTLlWz18pUH6T7WE1dLKFzAc1aHHjQYxpF87BdrT7AisFKPVb4XFbsgW9f3eGR/eptswB/8LiptjVAMDd2KH/Ai2/0IBWScyBRlTXu0QBa6jQzVFqQPp0zWEvffs6wgFyEaTI7+BWAUSt6jAd5Iaf4LqTWFVKj3BxhbleB9/jcfH5qrpuHJvLEPIrEt3YsaM+Ay5XpIfs3uFyw9ECI1usK+OlqwOrEuNrXN+k2lxigaw5zLZdOB7cGGjmGzrFZg70XPIDsQZ+WefPjx+FbNsGwlGAhDjEiFhLzCDCsC1Ajgr2OPTmCncgTBSqe6OtaOpmzOWhmbOyBUNhn/1IIdm1PRJ+BPxgAgJPYsZMgzMBeN2/s6rniVnjoKitLaaNyStevghSrPNPvLblFyh+krz+LwA+JPvtldiQRreijVGxjpkjpILue23nx1Ly+lYl/WGplTa1M1MK3K1xo0V47+qy3A7aOJLgXkrS+eXBNr5yih8kWPEGqqzygJAwf2RNVjl21b+YjQ6+M9LJ8fPY/0gU/2W5MQxwLwWV6LuszZ6pUKL5nDFUHTeV6EoOlfTNbdKtQmSyi3KilWCrrIcuyDBEk8XcChuFrZeIj9OAUwChdSyGz/UorC7jwlb4z+JqZMz2+BkeLLV3lhN/MMw5YxgHLGidCw7+5t+ctfcWAcyAc0ArQXa4/IYFhNIWLmlYh8hP5KvVB9+EAq0QlnLf1j/YSBM1fjF5g66QNwDQG4MkZM7xLwNBCZ5YRli0drEowz6+nwIeuyE3zm2yAol/9s80XZ9xZVljwtpLXRuknkOTPg7t/EOJtkebviDQmJMZK5WB522DPJi/p2wGv9Re7z39um3xJp2/Au8leZbdJf3u93Nor4HZKaCQkrJWPxNA0dRyar1KGdGED/BveEr5QxgD5mL76EiOvNJm5xyO0REIiZyoF1TfmgkcY0+6gNagZoQcE8ghZeN0PEprQl6vAMsTZfCQ9/ASUfYQE0ndAMTB5xHPFQPUXZbLIS9CNC1QtdmTVjeHFQ7GPtyEBE/GM4TUgz+ikK0Mn1tAJuaQv7Mz0jZ9JL4sjqOwoigqlUcEsPB9jIRxy7JTqPTMWaF5oquAgSPoAV1+ruZzIAC9xkvr602xi8Rxt0PfyVHhzXHDAfQgBRWqE0/4wRxGI+WbrRQWTqukUVrEtEMEkTitDswJJK329CYkg5NopuvbzVqsM5p7VPhWicjeDJfX/7ZWtr3Rlq0EQTMOqcywz4jLFOnXU+fp1KUsTOrXp5r8EsQB4ppjhQ9OHByxKYf76iI+BMax4XN8s01PCN9A5/Ns1nxqvWec35i4w9y1tq210+2vhnGyB1V8saysl+PNXgSUZmNDjDX5dTTUz4lG/MJs0ZXOhoe2Y233CRF730HW4tW1vUrWRi3OsSJZG5u7ZmS7zBPwOJQz/bpc+wz/wQ821+NFX4POHki2aQhtNF//3P9SY18Y= +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Body

required
    reassign object[]required
  • Array [
  • ]
+ +An identity campaign certification details after completing the reassignment. + +
Schema
    campaign object
    reviewer object
    reassignment objectnullable
    from object
    reviewer object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/reject-access-request.api.mdx b/docs/api/v3/reject-access-request.api.mdx new file mode 100644 index 000000000..8dd936b63 --- /dev/null +++ b/docs/api/v3/reject-access-request.api.mdx @@ -0,0 +1,107 @@ +--- +id: reject-access-request +sidebar_label: Rejects an access request approval. +hide_title: true +hide_table_of_contents: true +api: eJztW2lv2zoW/SuE5kMXRLbjOHGSL4M0SQd56DZpMsVMGqC0RNvsk0k9LU08Qf77nHtJeZOztK+Y1xZqi8KWyMu733Np8iawqcpkoa05iYP9IFOfVVQcRJHK81P1R6nyItgICjnKg/2LwD0X/oU4SNPMfpFJHlxuBLHKo0ynRAl0zsY6F8rEqdWmEI5qLqQR0pHIPAnpSbTEW5NMRTFWwl4ZlQk75C/Ve0yNhYwn2ogyVxlIZXiZJPZKxaKwAkIMbTbBHKwrI+KiBcZTmcmJKjAB7N8EmlhLZTHGK4MX+FYtAOk3gjwaq4kM9m+CYprS27zItBkFtxsBMawzBR0VWanq4iqh41WmiQN1LSdpQrS60d7mbmd30O/u9QZKbnU28Wl7ZzfCv06nq4LbS7cM9PLCxlNiY3mVU/VFqyuVPclFZCcTZQpaYc7ZEKYAa5E1Bd7RfHCS6IjN2/6cE5GbupB2QNYhbWXkDIVWOb31S9S1Ad2VSSIHJNU6ZRy6icLzsawFdgyy0VwEaDfKlCxIhPpaZFYJLoIYI8JCw2qrCx7hDTsIva3oiisJNTm6K4aA5sNOP9zcPNvc3e9t72/1W5293f8QI7IsxjZbpxxQislH18t8wPMqB6hUt6pSR7MuozLlhOLr5Oj4zdnJ2b8pnub8zp6u8zoiRct6PiGCXqvG+szSaPiaODmquJ6JWvPZXl91t4db/T40p7pS7UZS9Xa2OwNazwXSY1aMdZ4mcipoxj2LfrZj04otAgJ/kHx0wY+9Wx0V1r/IVJ5akzvVdjvdesBQvkphfxEiZxVlZvBRu3WrBERekpeclIbw6iknKJ6DxGV5aD7NCzUhH/rGyHLs9jqdOoeHiSZfPc4yeM/dXA6QDyhqtEFa0fGf4GXVJWNVSJ0c2vgRNnypjQpHmdTEoWKWI0wUlO10jBliYpGWHcnKwDxuOQChidameCHjWSU59MKQuTMZ/Q5aJ49w43PnwtUUSsFIF3ctq/pKDnY6e93ecKcnZXe3t9nfHuwN5dZWZ297b49Wn8AP5GgxWgOZZXJaW/ofClVKRyKxESzyXygECQK6ZwZ4cUzR8Jv8YRswjUfGkBs7E9PzKwp1XWwgqb44fCd6fZFIMyr5uRytKMGE5+9rKRySO8JvMz3S5r4cdXT88uD81RmenB7/8/z4PT4RrRoCODDw1pjc0uXFsb1ijr0AHHcqgTqQnsVzT/U5BJImXxyo84UghG8NZZkUmOFXXzNjkbQYZnayFEocN9eFeKpbqrUhBvQMBSYai4HMMQEmpOHPXe4IX3lNPhdjFACVPWuJgzjWJCRQCaIRRDF/CkLAJzHnDSYwLBHKYEajMJSFMLbQkVq2xVyVqwW1ynmvFo1CwQHOH/aTg6gowRyLuRiFM2/xLHr7gGenudVKvZIlp6YgZIWRSJORzTJoWAwgmy7yqtiTuXIkHlONm2WsxVTO6e61Y8blc+QzWeaPiLt3CdJPyKLNXnxRPvhyhoKcjdgalZl8RvL5nCf7UTNzVYEvhlolcRO7Tew2sfvI2F19eepx2Ryp9TqbdehzbhzY5uJZgz4Ze4+xohrE8MYbckNAIR4i/fbhDIH9uzI0Xl2n1Ap9R3zkSnkdWc7s4Z4PCH7MjLVkC2KQ9egkGCITqXif+Z5zzIpyqtqqr/bSZgMNBzVrICK1w2JqS+6Is9IY4kTmGwIIOjdPCjGWyI++7eYM6DrzkFvzBkk2SLKpRk01+nWqUYMkm9htYvfnjN17keSMK44Wj5PycjKR2dR5mn9P0kqBAaLaIZzvMrKpVtEKERMzjBUsI4dg0N0cbA77kerFshfvbO0Nu9FOV273N/ubg163HyzW+ot5HM+CbDmmFuzt7MgqBoj7AhxXGjhXXlgbL2//lfQbypDSGqWeGW6GzqHSyzl27NWx4xtbQDYQBnbM7thePD99RfTpdxUiT3qzZRYpgtlOdRguC4aU5MPQtOYfhhro2EDHpvw05efXKD8NdGxit4ndnzN2vwo69h6Cjr2vgI49QRBrSBDrr4SOMXAHQbOhppMyIiqhXj56k0IUfPK7jz7sC5mNVDEDeksosrtXR5Fn1orX0kwrsJQv7USauboovWHshMZm1VgMkGKEFGnooI627qQMHdYAJqXDG4meaI5jEgh0s2l4MCwglYuZyt9mq2gTJSU45KSQWNp7tfAxDXdSQ4J/oMD7oCMk6u+4x+mt9af2g8UpSfyKJBbH15FSFPOz/d/tdacETsB8RunivbP1HccF3J65NGgj1HXq0tcMgjZQvYHqTblvyv2vUe4bqN7EbhO7P2fsfgVU92jobqiOAY+G6hjb6ogZlnpJzvV/R+wcKp4Ddm9hI8bq8RyDM66AKxFDqeWNVj60vh+03e/4obdVWJ00z9s384Pst2133h7TXG/gWC2zBBTGRZHm++32DSwIy922ZKpbSGwwYjE19qoV2Un7y9aafOTObZMvYaG45DP24uDdiW9AWqz3TJNruzzICzgrsKTkxLAGnzu4l351PniK3kQ4Mht00Nm7GT8Gmyl6jCc5j26xW9VkhGznWXL7kDz/2rpPDkfkDjnWqe/etTBegMsV8Yj9SzIXXAGE2F7n4OfQJTA6XY5nl4tj3hNgdxzWRs6LEP1U0K0x9JaGdcULJTN0E+70zNPfPpw9EyOCqZwmypwQstLUVyDQ3sGNOA0eVCdJaBJXpsyWozELd7B0VofCTgwTKEV8NO+VEhcnXlFvUB9OkdBZ7TRJcQ6hWZdPK+vF6otKqHS25tom59SxaUOLbbk07xmXSe4ntHF3BugOyEcTiiNN2UtTuacxXkRuD8VFWsklF+T6Vib+VlELfZwytfzZChdOtReRO/sdIfaJBKKYtfXNizt64QI9ar7whKiu8kCa8Hwsn7CKKqt9Mx9L9EKit8zHR/NhrFGDl6cJl/JEjhKaxOJERGNrc/V3Ich1KFQuRiUi7ZvZuqJFQ46IsNtZYCl0S4Y6BKJk/l4hMIxzJjmgis6Axrq9FQ7bT2xZ5IVPfPHk05LM/PgChZdGxjbKv5lnWjCkBUOXJ3LPv6tr5FiIbZLB3dhhBzic258zgWd0IS86WmszP5Nv8xwqHxFYZSp5uu++7M+ToP8k+AWNno1BmiZAPjtzhu/C07qdXbLxyqq2ElY1WOc3saipK3pz/M5+EKU6+6PJSxIfzHdc6A7R987Sd2SSHyfv/kUZr8k0v2Km8RCZdi5P59clj6tmZuHm4rrbhguXDe+9CUjezFL5VmUxhhxgrG8v0v73WOF/vOVEwFAfjRS3hgyRFsmkiSzcrVWkjGisFW9MpOCOwOcGua2dcJgDcVNuQfvJhEYsQQZ9SLSSOgG9lviAzs9EsCB1fXQgGFQ/W9/+vYcR3/Fd3KPKLwRdqCsN5lIIlxMh4X0POE+s86h0OQ5NoFGVZJZR4mxWFfDklaSKFvc/2SR/O6QdbDTHCz7ywFpwkdxvX0ORZBF/c3cuyKlK2Ilp3HIH8BBtOGY4VklKBkeCBlZTCyu8PjmrUQQx438zsdmo7SflbRoLItRtOWfYaqHbpEfUwaFJXqB7+vB16FXfupnv3/8od6t98aKuo53SLhsJW7pOybWrF8Fd7Sqm7y/dvPYdK/qbMTW8mHpzQ3s01L7d0mMQoA2Ai8t5d8ZdEixJn+e3n+9U29NTf1H6Gf/KtP669lqhqg1GM53vLQT4+LuiLYkFOdDAQwDeO2Lm3AD/Y0V4NmXYUBGo/QpDDayb4faj7h17ubBH8O4t7cwFA39pfOK2OzJ5RYrF//vBR/zFF5u6MMEgfn4TVJuHGOPo0p//ASOGWy8= +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Body

+ +Reviewer's comment. + +
    author object
    + +Author of the 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/reject-approval-item.api.mdx b/docs/api/v3/reject-approval-item.api.mdx new file mode 100644 index 000000000..b80e0f8f4 --- /dev/null +++ b/docs/api/v3/reject-approval-item.api.mdx @@ -0,0 +1,107 @@ +--- +id: reject-approval-item +sidebar_label: Reject an Approval Item +hide_title: true +hide_table_of_contents: true +api: eJztXOtT2zoW/1c02Q99DHknkPBlNxfo3XQoZSG0O8tl5iq2kqh1pKxlQ7MM//uecyTHdmxKQpn7mnxpgy3pPHQev3Ms+76iFyLkkdRq6FcOK6H4IrxosFiE+pYHw0jMK3uViE9N5fC68lmHXxleM5WbvYovjBfKBU6FiaOZNGxwPmR2BcO4YskyNKfGTmQ0EyHe4P5cqj2mQwZXmL5TUk3rXhyGQkUsNjBoHpuIzflXASNg4VD8NxYmqgEzCx7yuYhEiCzdVyQSX/BoBrcU3IC/pA+/jTcTc145vK9EywVeNVEIVCoPexVcTIYCxI3CWBQFEWx4zPSEeLtDkaVVg/jG54sA1xKTdm/S77Q7B6Lf6e63xt3xuNdpdXh3v90/8HtApZQzntHr8AW5TNYlTms5VputZnPscd6G/1tjT0z2m60W98etJvxucq/ycIO0zEIrIwxy0mo08L88vUGqCcN8EXEZGKbHuNVIz9Mqgr3DecBLID2yqPoXg5Pvi2LambibIdpfJC1p2LmCKtYlf2pvWl6/2Wv02l2/JbrN/V6j2fXbrUmv3/B4s9trJroFcxLhcCuCq2nbEYTtj4OAj3E07mWWgWNpFgFfnpF9PMUJbrpvJ6BBfZ+t93qm2OVcWvtbZwB8bjPp84ZG035Yelplc5GzshYZeM/ByJygsLYXCh6JUsEmOpxzsNGKDyOqkQT6OUkazYNq46DabI6avcNO97B9UGv0e/8p8gQz2d1MqLwVsjtuWEIeOJlrX07kc1npVRv71VZ31GoctlqHrV6t2ehsx0rAIYTGC5/4KdmF3EobmV565fsueERKYNzzdAwBHYYbHYeeYK8Gx69QNSaC+2VEhYrnmGneSSXNjPi+oHzifkZxqOjnybcFBce9yrlQvp18xJUnArh4k2Ums1RRJGIEheE5USIZ0VxMeBirL3HYB65iHiSXDMph2X9cjJ8FWKv0kDcMchMXF0mUufBl8tcxsD1N/kiyJvz8JHVAly/ErRR3cOUdGA4KrSHGLvG2TqYdzXgQCDVFSxrOFxyyuOLB0kgDFy7lVOnJBBV3i3F6r2KlGXhu9ggCSF5vKe9FtaG8ZSawrrcRjCtRW5gKb6+lKuRhyJcFa92ryLVxP5BA8hHNW9uY7RJJxMOpiLaPozmqzK7yTOLPi6NPMvAF0kfNJFHVDnhustqOMiAFGQx8H0AJWUsGUDxP1iwisYEoRw994FawY4gnXqTDJdGMYOlxHIlnUkyms7GA8YnMFIRSwouZVuIsno8ho2VpfkwQ+WaEVwC+XMNa5VnKsWDTQ476Jx7EG4p8i0O3k7nbbFW73W4VYGkLySqOyh/6EJRktNxU07Rh0k1KGCgzYsQG1oqB2kMaoC7yEejYAtrKelYE2BtIyKJAIROzLAp2prnC879DFMvB/lcG4svWMcTl6A3puYQeiomAUs0TPhsviwXIY3GkBINkXPM38Wu1sTuvzBn0SrMeDVFlAHc7D87SSqeW++nt5u6ZXdZOyy7J/zGueXpexv4KngGi+DihMvtRoDY8G17+8wQN7+Lk/cnRyP0cXV2c0c+Tf58PL+jX+cnZ8fDsZ4Qqg7Ojk1O8iKTzaC1d78fQGpXga5LdZENAtsexgf/byjea8YgpAYYfaYhzzu4t3t/ctlKcXrCsgXMxC6HLNgf2DIY+u8TpVZuNarM/arYPO30scdq9bkldgfEUawsQ924mvdlafZEyUcIhmMZ6QJQqElMq3FYcwqV2q9zHKSWmSpfq8Vqj2S9hAGmUmu+LtB0mFoL/WAm8mbGcZaJdgawzlUuoHQjFM1cbFGg5i9/EMpEIs+PLrDKlBQMZdhhqx5rCkonH25JJpuT7VeeB4AZcnSixSajnTvog0HeuNWYz/ZUBg9o6aVB3kdzYzHQc+OjF8OtO2UZjQcvvuRIrIa3wZZn+0cy+qQ1ubxC43cP1dPtOisBv5rBOMi4Nck/xAuYjgqeZOcVhCTdONzlmLp2xENKYODa20F4hHJ+6YJyIZGrpT+ZxhZvpiDppGVd+HWyV9JJoIMPjNeQE7IAmysrPLnLg7pucV65rO6vpQgoC4mGow03UkDaDU37XEgiEJTJmbPiYhfAIcdNfSoP7gNf6tWKzfqAY0UQpLDd2FU09eJ/5MRJei7pZKTPl/ANe75T1jI8Cif38EyTAqizp3jCZa1uysfaXTGKYh2ws/RdsJ9s+9ZH2N/Csd1KJ6jTkEjkknUCS8wXD/C6xwcTmOhSu9Z3sPo3Lxy/QRK3JfuI+yGvlO3LCoPpC7n2FtTZpGFwpCfNZMgXKHQq6j5AVB4KP9xv9Vmey3+G81es0D7rj/oS3241+t9+nhiSgVT4VZZaXJ+1aPyzQHuzI/0AhgEaMi/pE/HsRby2W4BobpgU7diWm45dF4lu0B5jvp6Nz1jlgAVfTmK7z6ZoSVPXqsiwD2oU/hnIqSyF5gmaPT94Nrk5HhGD/dXVyOVoh1IL/SOWjWWrCKZA/iGMnADkjJTDh19hbt+pbEIgrkx0o7V9madCXfTHhcRDBDEe9ZEZ26TQ7Jq5EfvMtYq9lTdT2IBrSQ7QI4NsYkqqf9ALeQj4Xi6h66jT5ls0E90X4psagqJEoJJRyVDIYmL8kpOv76Lp2gUkMrgzMQFWn4whDjfTW8niqyvUiOIkhp9lNQecAzp+2E6jqYmCOxMx64cpaHItuf4Bnq7k8d6OM0kilSxVxiOwwMliCGkOsGRnUThD6DHPhCLfLQOBRybhVxMqGRgp3Hywzx5Gmex6PzQZ+dx5A+KmSaKsbt8I5n8GSw0Yj2o1km1xEgpvUBMHJbtRquxLHZxPMgjvf3fnuznc39N31mxfuSbm7S9CnWYQ+V4rHoN+QkmcB+oRkPUqzZJBtK9qNpGMRDiK9/zwCx/4qFI4X9pHXC+Ijm8pLnvUn+2GvjxMsmKT+THUEDJIerQQTiETCPyS+U45JUVZV7SI1AMxjCQaqSiAiFWtLHQNahT2PFZ4TYdzsMV8Lo15FbMZvqS0J/NoIiFSVX11oqV7yYMIOSe6Q5C4b7bLRDknukOTOd3e++9JIcsUVeYvDSSaez3m4tJbm7tunXzCAJWc22crlVo8Gs2gFF2MrjFXJI4fKuNUcNycHnuj4vOPvt/uTlrff4t2D5kFz3GkdVLK5/jr145WT5X0qs992H+1jOxHeAo6LFRiXibT28+2/mB4oY1jD0LPCzaBzUOlNih07Rex4piOQDRYG7Bg+0l68uji1D6zt8qg3exgNnZZUZ3ufCCmpaSq+SRPtoOMOOu7Szy79/GXSzw467nx357t/Tt/dCjp2noKOnS2gY4edJY+Rf0/o6APuoOfZsCkgQ/KmWCgWIAr84qszKelB0BXQy6HIVr+IIkdasw9cLROwZHKdSJWqC8MbjJ3j2DAZCwM4m0KIVAyilgR0i1aFZ6cAk+J5tUDOJfkxCgTrhsvqYBKBVNZnEntbUZHKC2LgkIJCoLH3qsHGJJiTmCD8gxWoDzqFQP2CPU63Wz/UD2YXKPEpSsxOvnlCoM+v+r/dslMCQ2A+xHBxaff6keMCtmfOFZQR4tvChq8VBN1B9R1U36X7Xbr/a6T7HVTf+e7Od/+cvrsFVHdo6HGoDgM2huowttZgKyz1Do3rN0fs5CqOAzJvpj17ojTF4IQrwJSQoYWmRit9I+GwUsejplUKNfV76T/U7Zck6vf5ryY8VPAgNkJFy2UcBjB5FkULc1iv38PmwaY91PhC1pI3xJS+w1dd6rftklCEJ0+t2wEVP7YnlvFDFpZIjVQeSrRqGwKJgN0AEhLtFzaCjhx8d/3kGPoSyhJml9nDV2mdhdFlfLECygv30lGNLKogI8h2FQYPT8nzqf09Oewij8hRpr7v0oLxDLhcE69iD1cbAVZAr/fBfuGx/SMbuwYxbvz1TXbMJWJ1y2FhZJp/8ClB8eWRjzisxX4SPMRD/nRw5vX7z6M3bIoIlSJEbBAcC/cpEnYOZkQRcJAcIsFJlJRCHU/tey+D3DEd9Dg2CUAp7Bd1KQS7Tl5fPIPUcAGxnNSOkwSFD5x18zrZPV/cigCzZi3VNhqn9FUdtFjnuXlvKENSKSGVfXcGrtZ+UVX3YhsdRscxTkSqDNn1IpGLZ+R6LhN/S1ar2tWqtJp5s8aFVe21Z499e+D2uAQPDGnr2cTtetXMelh3wRVcdZ0H1ITjI3+4ykt27dl85Nar4np5Pn5Rn+lNqfw0ZqNd8rbJkHkzrY34O2NoOugq19MYPO3ZbNHrWVXyiGqrkWGpaklWZRXAJPF3Co6hrDHxMSZzwjLatlXIbX+lnYW48Cu+OMF+zclMl68h5+JIX3vm2TwjwSoSrNo4YRz/7sMywCz4NspAccAawFG6/xQJHKOZuGjXKo38tHyd5mD68IBVWsUsDu0fh2kQdL8Y3cDRqzEQphGLr46bwd/MrYV5LaespIuwrsEiv4GGdLqmN8vv6lkoptg/mrwo8SBttnxUwfKlo/QjkeSPE3d/p4i3izR/xUjj0DGaG5F1ZUTWyC2iK7b+sDc9E/Av3CVPJRgORQ6VbYRhssssAh7ZNz3Bp72ZFNQ0WAgeITrcQ7vSc/JDgMTo/FAa0kJTeis5BIY5lHkygPVq7DNUZcoDFWNFhod1YdUv2pVml6Dlc9wkdpxsHACo+TxW+OUGYCKe4zvGT+2uL40X2yAEBZoSiWSaYNxqVuKRaDaoihrVJuHcfJxgdxkK18wmPkEL9tC41jIoMn1Fs5IKciHs13lwXB6iP7U2WE51JoIF1oQQQQFMiQyFD8NRYUVYTLnnGTqc1t0kU8ex+FkAEN4aQ7sGlSBewuoKCtjMuvZTSoUv863b033aT//tPuvncgaC/foC+1ooQmwLFFsgXlfSAhEmHNJn/ixb+Ofat/WgpJhheQnT7u+xI4IV0wNeBpJYbl/fpAURFSawN/gbCtMJeP76F/eySnl94b7N94ae6ZR/ka5UoKSdp5ZpJV+Bn18FNgCkT6+MvgAjhQ8CPoObNYXSq6u2d0TqsoNsdykzvfD8BYu7VcV//vESzPXh/2B4kQk= +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

+ +A work items details object. + +
Schema
    remediationItems object[]nullable
    + +A list of remediation items + +
  • Array [
  • ]
    • approvalItems object[]nullable
    + +A list of items that need to be approved + +
  • Array [
  • ]
    • form object
    sections object[]
    + +Sections of the form + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/reject-approval-items-in-bulk.api.mdx b/docs/api/v3/reject-approval-items-in-bulk.api.mdx new file mode 100644 index 000000000..e44462925 --- /dev/null +++ b/docs/api/v3/reject-approval-items-in-bulk.api.mdx @@ -0,0 +1,107 @@ +--- +id: reject-approval-items-in-bulk +sidebar_label: Bulk reject Approval Items +hide_title: true +hide_table_of_contents: true +api: eJztXOtT2zoW/1c02Q99DM47kPBlNwV6Nx1KWQjtznKZuYqtJGodKWvZ0CzD/77nHMmxnZiS0E7vY/KlDbZ0XjqP35Fl31f0XEQ8lloNgsphJRKfhR/35/NI3/JwEIuZGag3SfilsleJ+cRUDq8rn3T0hdGtys1eJRDGj+QcKcD84VQa1j8fsBHMYZYaXHD07KwqO5HxVESMK8aDmVR7TEcMrjB9p6Sa1PwkioSKWWJg0CwxMZvxLwJGAO1I/DcRJq6CPHMe8ZmIRYRS3Vck8p/zeAq3FNyAv2QAv40/FTNeObyvxIs5XjVxBFwqD3sVJCYjAYrHUSLWdRFscMz0mGS7Q60lyA8kxVc+m4dIS4xb3XGv3WofiF67s98cdUajbrvZ5p39Vu8g6FYebpCNmWtlhEEhmvU6/ldk1c/IGxaImMvQMD1C66GmvlYxGATn8fk8lD4tWO2zwcn36xramWiiCJc3lpY1mGPNCqtKP6Vw0+81uvVuqxM0Raex3603OkGrOe726j5vdLqN1KywRiIabMVwOW07hrDaSRjyEY7GZcwLcCzNPOSLM3KHpyTB9Q7sBPSfb4v1Tk8Vu5xJ626rAoAjb6Z90cdo2ndrT1Q2Vzmv67oA7zg4mVMUaPuR4LEoVWysoxkHH60EMMKLJfAvaFJvHHj1A6/RGDa6h+3OYeugWu91/7MuE8xkd1Ohil7I7rhhKXuQZKYDOZbPFaXr1fe9ZmfYrB82m4fNbrVRb28nSsghLyXzgOQpWYUCpY1cL7vy7RA8IiMw7vs6gSwJw41OIl+wF/3jF2gaE8P9MqZCJTPM4G+lkmZKcl9QinY/4yRS9PPk65zy4l7lXKjATj7iyhchXLzJC5Mjta4SCYLK8IIqsYxpLhYSrAiXOOw9VwkP00sG9bDiP67GLwK8VfooGya5scuLpMpMBDL96xjEnqR/pLUIfn6UOqTLF+JWiju48hYcB5XWkGMXeFun046mPAyFmqAnDWZzDkVS8XBhpIELl3Ki9HiMhrvFPL1Xsdr0fTd7CAmkaLdM9nWzob5lLrBqtyGMKzFblClvr2Um5FHEF2veuleRK+O+o4AUM5q/sjDbFZKYRxMRb59HC1yZpfJM5s/Lo08K8BnKR9WkWdUOeG6x2o4zIAUZ9oMAQAl5Sw5QPE/XPCKxiajAD2PgVrBjyCd+rKMF8YyB9CiJxTM5ptPZSMD4VGdKQhnj+VQrcZbMRlDR8jw/pIB3M8ZLfFxuYa2KIhVEsOWhwP0jD5MNVb7Fodvp3Gk0vU6n4zWajSayVRyNPwggKcl4samlacGkm5QKUObEiA2sFwO3hyxBXRQz0LEFtJXVqgiwN5RQRYFDLmdZFOxcM2tDfn4WS9mTQC8M5Jetc4ir0RvycwU9EmMB/Y8vAjZapCGWSfJYHinBILnQ/ClxrTYO56U7g11p1qMpqgzgbhfBeV7Z1PI4vd08PPNk7bQ8Sf6PUdXXszLxl/AMEMWHMfWujwK1wdng8p8n6HgXJ+9Ojobu5/Dq4ox+nvz7fHBBv85Pzo4HZ78gVOmfHZ2c4kVkXURrGb3vQ2tgq/tVzW7yKSC/hbBB/NvON57ymCkBjh9ryHPO7y3e39y3Mpy+5ll9F2IWQpctDqwZDH12i9P1GnWv0Rs2WoftHrY4rW6npK/AfIq9Bah7N5X+dKW/yIQokRBcYzUhShWLCTVuSwnhUqtZHuNUEjOjS/V4r9HolQiAPErd94dsO4wtBP++FngzZznLZbs1ts5VLqF3IBTPXG+wxst5/CaeiUyYHV/mlRkvGMhwh6F6rCktmWS0LZt0SrXA6jwU3ECoEyc2jvTMaR+G+s7titlKf2XAobYuGrRlR2FspjoJA4xi+HWn7O7dmpXfcSWWSlrlyyr9o5V9Ux/c3iFwuQer5fatFGHQKGCddFyW5J6SBdxHhE8Lc4rDUmmcbQrCXDpnIaQxdmJsYb21dHzqknGqkqlmP5nPFS6mY+q0ZVwFNfBVsktqgZyM11ATcAc0NVZx9roE7r4pROWqtfOWXitBwDyKdLSJGbJ94EzelQICaYmcGTd8zFz4hLjpL6UhfCBqg+r6JnhfMeKJWlhpLBVNG9sBCxJkvJJ181rm2vkHvN4u2zM+CiVukp8gA+axdPeGycK2JRvpYMEkpnmoxjL4gdvJdp/6SAcbRNZbqYQ3ibhECckmUOQCwbC+S9xgYjMdCbf1na4+jSvmL7BEtcHe8AD0tfodOWXQfBH3vwCtTTYMrpSE+SydAu0OJd1H2IoDwUf79V6zPd5vc97sthsHnVFvzFuteq/T69GGJKBVPhFlnldk7bZ+WKh9WJH/gUEAjRiX9Yn5tzLeSi5BGhuWBTt2qaaTl8Xia7wHmO/N0TlrH7CQq0lC1/lkxQjKu7osq4CW8IdITmQpJE/R7PHJ2/7V6ZAQ7L+uTi6HS4S6Fj9SBeiWmnAK1A+S2ClAwUgFTARV9tpRfQ0KcWXyA6X9yywMxnIgxjwJY5jhuJfMyJPOqmMaShQ3X2P2UlZFdQ+yIT2ZigG+jaCoBulewGuo52Iee6fOkq/ZVPBARK+qDJoaiUpCK0ctg4H5C0K6QYChawmMEwhlEAa6Op3EmGqkv1LHM1OuNsFpDjnNLwoGB0j+tJ9AV5eAcKRmPgqX3uJEdOsDMlvLFaUb5oxGJl2omENmh5HhAswYYc/IoHeC1GeYS0e4XAYSj0rHLTNWPjVSuntvhTmONd3zeWI2iLvzENKPR6otb9wKF3wGWw6bjWg10mVyGQlu0iYITnajlsuVBj4bYxXcxe4udnexu2Hsrt68cE/K3V2CPo116HOleAL2jah4rkGfiLxHaZYOstuKdiHprIGDSO8+DSGwvwiF44V95PUD8ZEt5SXP+tP1sNdHKRZMS3+uOwIByY5WgzFkIhEcktyZxGQoa6rWOjcAzCMJDqpKICI1awudAFqFNU8UHr5g3OyxQAujXsRsym9pWxLktRkQuarAm2upfuTBhB2S3CHJXTXaVaMdktwhyV3s7mL3RyPJpVQULQ4nmWQ249HCepq7b59+wQCWntlky5BbPhrMoxUkxpYYq1JEDpVRszFqjA980Q54O9hv9cZNf7/JOweNg8ao3Tyo5Gv9dRbHyyArxlRuve062sd2IroFHJcocC4Tax0Ut/8SeqCMaQ1TzxI3g83BpDcZdmyvY8czHYNuQBiwY/TI9uLVxal9YG3Jo93sYTQMWjKd3ftESEmbpuKrNPEOOu6g46787MrPX6b87KDjLnZ3sfvnjN2toGP7KejY3gI6ttlZ+hj594SOAeAOep4NiwI6pK9fRWIOqsAvvjyTkh0EXQK9Aops9tZR5FBr9p6rRQqWTGEnUmXmwvQGY2c4NkrHwgDOJpAiFYOsJQHdolfh2SnApHheLZQzSXGMCgHdaOH1xzFoZWMm9bclF6n8MAEJKSmEGvdeNfiYBHcSY4R/QIH2QSeQqH/gHqdbre/aD2YXqPEpasxOvvpCYMwv9387ZacEBiB8hOni0q71I8cF7J45V9BGiK9zm76WEHQH1XdQfVfud+X+r1Hud1B9F7u72P1zxu4WUN2hocehOgzYGKrD2GqdLbHUW3Sun47YKVScBOTeTPv2RGmGwQlXgCuhQHNNG630SYTDSg2PmnqUamr4cQbPfpyhdi+DhwoevkZ4aCVLohAmTON4bg5rtXtYMFiohyqfy2r6VpjSd/h6S+22VZJ+8LSpDTVIYEFiTynjRyEskyqZOZLoyTbtEQNrdFIMfRaMT8cMvkk/PXq+gFaEWTJ7+Pqs8yq6jC9TQEvhXjSqkhet6Qi6XUXhw1P6fGx9Sw9L5BE9ysz3TV4wnoGUK+pV7IFqI2Dl6ZU+WC88qn9k81U/wcW+vsmPuUR8biVcG5nVHHwysP7CyAcc1mRvBI/wYD8dlnn57tPwFZsgKqWskBgExMJ904OdgxtR1uunB0dwEhWiSCcT+65Lv3A0B6OMjUMwCvtVXQrBrtNXFs+gHFxA/iaz4yRBKQNn3bxMVy8QtyLESlnNrI3OKQNVAyvWeGHeK6qK1D5IZd+XgavVX5XnXmajA+g4xqlI3SC7nqd68ZxezxXibyk1z1LziJp5tSKFNe21b496+xDqSIKHhqz1bOaWnpejh70WXEGqqzKgJZwcxQNVfrpqz5ajQM9DekU5flWf6O2o4jRmM1z6hsmA+VOtjfg7Y+g6GCrXkwQi7dli0StZHkWE16znRPIsS096ACBJvlMIDGWdiY+wgBN+0XYrhcL2N1pZyAu/4csS7LeCznT5Guosjgy0b54tMzL0kKFn84Rx8ruPyYCwENuoA+UB6wBH2fpTJnCC5vKipVWa+Yl8jeZg+fBBVKJi5of2j8MsCbpfjG7g6OUYSNOIv5dHzOBv5mhhLSsYK905WLXguryhhhK6Yjcr7/L5J5bVP5q+qHE/22D5oMLFj87Sj2SSP07e/Z0y3i7T/BUzjUPE6G7E1rUOeSe3iG59uw/3o6cC/oW7FKkEvaGxoVaNMEyezDzksX27E2Lan0pBGwVzwWNEh3voV3pGcQiQGIMf2kEiNKE3kSMQmENrJ0OgV2WfoBNTPpgYuzA8oAtUP2vXjl2Clc9xkdhxunAAoGazROHXGkCIZIbvFT+1uoE0fmKTEDRlSqSaaYJxy1lpRKLboCmq1I9EM/NhjDvK0KzmFvEJXrCGxm0ngyGz1zIrmSIXwn6RB8cVIfpTtMFzvKkI59gHQgYFMCVyHN4PhmsUgZhyzzB0NKm5SaaGY/FTAKC8dYZWFbo/vIQdFTStObpvss/crXzlbtWl7rNt9J/6lTxXORDy1+a4o4WKJLZNsa3hdSVrDWFCrjmEvw4lffBpir0kjLy/x+0PbJUe8DJwwd76+ibrhKgjgUXB39CFjiHkV7+slzfFywv3Db5X9ACn/PNzpTqke3dqkbXtFfj5RWC3D2LT26B2O4aEsjfshk1uytojDeydlk30+YdL8IaH/wMuVyKV +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

+ +A work items details object. + +
Schema
    remediationItems object[]nullable
    + +A list of remediation items + +
  • Array [
  • ]
    • approvalItems object[]nullable
    + +A list of items that need to be approved + +
  • Array [
  • ]
    • form object
    sections object[]
    + +Sections of the form + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/reject-non-employee-request.api.mdx b/docs/api/v3/reject-non-employee-request.api.mdx new file mode 100644 index 000000000..351d7a1c4 --- /dev/null +++ b/docs/api/v3/reject-non-employee-request.api.mdx @@ -0,0 +1,87 @@ +--- +id: reject-non-employee-request +sidebar_label: Reject a Non-Employee Request +hide_title: true +hide_table_of_contents: true +api: eJztW2tv2zgW/SuE9sO0ReRYfjtfFm7iFikySdZxJthNixlaom3OyJRXj7bewP99zyUpWbLdJNMp5gVjgI5CkZfnvu+lqQcnWoqYpzJS54Fz4sTiZ+Gnl5EaLpZhtBJiJP6biSR1jpxE+Fks05Vzcv/g3CYiPo1UKj6ngyydY+zD+sORk/JZgmcHBNycAruQU+Gv/FCw77niM7EQKnUwORCJH8sl7Y2dx3OZMKGCZSRVyj7JMGQGDOOK8eUyjj7ykMlULDCuMeFFwFSUyumKZcBTY+O5YAAZYwM9whYZpk0ES/HCrhKBpYYF4GrJY74QqYgTzZckKEsOjo4chRf4SwbONtYKe1VsMmAvbm/Pz15iEe0oYwG5pnEmIEF/LhbcOXlw0tWSSCdpLNXMWR854jMHPRoTXrPT7nQD0euKVlBv9EWnPmn6Tb/dDibtTuCQnC0vr6NgReS2N/JJMxAyXgFdKH2t4OOfE0L/sIsjmpCgSRoxmUMqRUJv/WixsGSqgLflcWomskhpSVckQkJe8M8XQs3ITlr1er3MrtUF2FqXBXZfbE5WJVM9t2KWhHhgNzoTvkwIynptyCTLSCWGiUa9Tv97tgKNLAj1s6XIw/Bqqs3ncXnCkvaIchrFC45dHDKbX2dqTlmSDd8TzV5v4nqi3XZbkzp3+aTtu71+d+o16i2v3ffJ1HLr35XKSEwFfMeHv0RGkUkS+ZKTz5wHEAV5/9ETTJq3u2wKlS1Ir2+vfhiOLgeXp8Mf346ubq/x6vxseDk+H/+bdL3hpxjdFomBMsV+TE41TmnBMYQQjpAAgYabwSjG4IxYVpyYm8VRtnT2mlXO5VkajQk/xLVfafsQ0f5VlbS9Tq/utYNmY9rr133utXtew+97vXqv2Q4aQhv9IzAKhdzJdI74TNrz/ShT6aWOTU/hGhUhrxCGXc90cCtjTTGxZt9uzISHNylPs+QxjQ6ur0dQKtnuaPhueDrWj9fDy7Pzy7d4urwa/zgaDs5Ik6ek+IsLzNhJAEOQQ5BewnsJq5pp1SrYv8jtvwj8uR8kBlyZjxKaXLKDKisl5q7iwDiC5Q0QJhjYhpYTgCkF+nWxnVfy32kYcS26Z8dNP4+b0yInVXg5z4eJ6iIKyOgfjyEBnNVNpdZtda+7uVDlPMg+8YSFHA854Vo1nNS9vlvvuY3m2OudtBsn7X7N6zT+oxmMBQWFb4nEknwMQ6t+0mzXul3CsN9vcj2dIzy+5gmJ7amYrHZLnSfz4m+O4znjcotf7nse8mPb7Xrtjut57brb87qe2540+g3RFPV6r+Wsi/RfMd1DOP7dw3GJdgGpJCaC6lj6nY7X6Uzak3rdw1PXbzbEtOnxTmdTZ96h5JV8wW4WoO6sv4DFGukFKgCas786KvuBrYla+8qg01BS+BnGMZTispFIs1hRtphW/HOCMpN0KRVoGpv9RhVmIFIuw9MoeEYyeyOVcGcxl4RQaMg+FjJiVQaULxZRLJghSSGVWNDzqk4GSdQ89poHzMqSnVpmSOIx938BrfNnmNmtkljP8iVU+iMGfGlb0RV80qn3G61pp8V5o9fyuu1Jf8qbzXq/3e/rEC+SBA1SOdvyOOarna3fCiVi6bMw8qGR/0EgCJ+QvQagNyf7g/aTp3WgaTxD/tRcmbkFmxYvozbwCF79+vSatbrIKmqW6XE+2xKCcm9vyOSzMOQTGqKGBZwbwlexnEn1WLg6G74Z3F6Mdanxr9vhDZ6I1k4xMVCw1oDMElBhC/Pok0ZsGaCMk4gQ4kDKYa8s1VdgiKukPFGav5JVQhV3IKY8C1OssLvvWVEmzaZxtKi4km96ZvZC1kTtCK0p5V+e+nM2Qb4K8g7q1cD3xTJ1L6wkX7G54Cg9XtbYIAgkMYmQCm8EUaxfUY/Lg4Bc1xCYZnBlgEEoibJUd8m+qOpiI8qqNjYR5aKsFHIOIH/aTgZ+mgGcZrPshYW1WIhWP8BsJFdFN96qD5KVSrkPLtBsrSBGNPk+IhN4k2nCbDgidSUIPCqfV0SscjTV4e57AwaZRb/zeZY8w++uQ4QfV7NWvPgorPMl1DaZaKS1kavJRiTbU+nFdlahrtzxGdJoGBx89+C7B999pu9uvxzZwx/7Vpc+3m7pc6t4BvnGOnnulD6xth4VsXySLm+sIo+ohLUl0ru7MRz7FzQ0dHr5eUmnV9+wPjKpfAf8oNCHGZ/k3XKe+je6IIBajoaDKSKRCE407g1iLSgjqububm+ieCJhoGpPiahPWVdRxjhEFmdKERKeHLEgEon6LmVzjvjI4RFJYiKgOeV19THvoZI8VJKHbHTIRn+fbHSoJA++e/Ddv6bvPlpJFqi0t9g6KckWCx6vjKXZ9/own2ECy3+GZIXLaVVtVytEjBU1llOtHJxJw5t4064vWgFvBZ1mf9rwOw3e7npdb9JqdJ1yrr/f+HHhZFWfKunb6FGLGEXcR9RxmYJxJWkUBdXjP4g3FlMKaxR6iroZModIPxS1Y6O/WzuOo4h+9V/lFVJSqSHVRkYU0zB3QXPjfC4mcDZDXFQMoUoCF5mSXAhQiWE0LJQLqZ2XuADdeOUOpilYMY6SG1mxi1R+mAGhjgRhRFVzBMOSdElgSjUfKOgKdobo/A2rU6ui31TJsxFxfEEcs+FnXwhy9KJyb+873z0H+JhixI1R8BcOek23wxUMAA2BiVlF3Xmozw/1+SHHH3L83yPHH+rzg+8efPev6bu/oj631dCX63NMeHZ9jrm1OitqqTdkXL97ma5dxSLQ5s0iX191DTY1uK4rYEoEaBnpS7v6KuuJc1y+RuXmt5+S4wcZrI/NNVuHbvhSlWgAZnGIdfM0XSYnx8cP0Bv0ta7xpazlNzlU9KnmR4vjj809UYiuCxiPw15B5uvT58H1ue01alrasSSDNtFPb2Bkr/kj04UO9Dnxo/Tp+gQpdRVliHeazBGD8Vvj0sOAuURn8V2iZ9e0Me3wCN5u43D9FD8/NB/jwxD5Ah/7xPfoXpjPgHKLPXvxI7+QfUMluNl951r2Jq1Q29bY2eyKpjXYa8Fj9Afml4wX7+7GL9mMCk/t+FlCNa+Q1CnAda5hIjqwDfJTfVqkc00cZbO5Bj6o/G5CjsSmIRhm79WNEOw+v1JziYg/QojWIqVFQkcFWvXhRa6ZQHwUISXD2kaSZHgyUMeQ0DGvrHupE5/uEKQyl7IwWnuvXHYmKR5JSuA0x7KoGz52v8z54iW+vhbEP3JqrqHmamrJyy0URrT3vrmH48ObiQQ8U0vrqzc39NwSPWqnMEJUtzGQJCyO6q9dfq61r8ZRoecSvSqO9+puLpFVq8uYCWIsQVIMA3bO/HkUJeKfjJHpkBvczzJ40VfD+kSbutoj3Ea9BMk1W7rSRY2o8V3AMZQxJj6hHK1LlAjVmwqMS/6kNQuf/0l/j/BThWc9fI9USjODyE++GjNt6NKGrokBicVvMhUZFl1BBA/m5r42gNON/nUksEBLMc/Q2hvVNfljvYZSgw+omkqyPDF/nGwCnH1i+gXNLuYgBFOJXfz+h7+ZpUXpqiKs/HBgW4K7eMMIWXJLbgZvcThFmfPPxi9xPNicoVypcPWto/QXIsmfJ+7+QRHvEGn+jpHGFr10FjnafBE13FzKLW7il74zQssN89QwbTdRdgpT3e2eACb6IzL8i7fas3U1jl5Hd2+65imTWYY8JR/QMcCfS6HPDpaCp1QpHpEdRgvtt4BFwQIdoiY00/fgYzDI0e3JEPRq7A7NmfKhEmrM6LYFqP4c2Q7tBlq51h/NneWKZvRBVqboCjRAZAvGYU5PWEMgEz8zQQt9mhI5Z5Eu+4pVuQeTmZEoarpFiRfJ1ZQOmdG/lpT+xF7QeWJPmCFIfRvfXIXeMDISobZKmlct15+iDUtz5yJcksIRcVF8idIO35+PdyiCmErAF1rwKJ4d20XJMc0FEWqNjDE0a2gIaYiaLPSxJboj+8kiq9z333xEWbGqh83h+h/1+aPNO9QwHC/pyIvYykwDY3rHe2d/74jFJ/p+vW0f0ZDMqefEgocHOiahXmpNw9iXevD7D5tWSbeY0BQ9o1udgp54RDgvRvbDwJfsmZ9e7uUrP/BTq02v7+DxF0FHBJI+rcQsc4ajEZoX9kcDV3+CsFm482sItZRmhTkXenTuh1Kvfn1FJ2TOxH7NuTDHDjH/RNLFvyfOe/yHP6Kl8QVM0uMPTn6IhzmGbl5V7Ssq7AN9q7te/x+2iOHH +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/reload-account.api.mdx b/docs/api/v3/reload-account.api.mdx new file mode 100644 index 000000000..9263c9191 --- /dev/null +++ b/docs/api/v3/reload-account.api.mdx @@ -0,0 +1,96 @@ +--- +id: reload-account +sidebar_label: Reload Account +hide_title: true +hide_table_of_contents: true +api: eJztW1tzEzkW/iuq3ocBKrYT27nYL1smwFSmAsnmsjyE1CJ3y7aGttQjqQOeVP77fkdS+5oQYKmdgeoX6HQfHZ27viNLt4kuhOFOanWUJf3EiFzzbJCmulQu2UocH9ukf5XENza53koyYVMjCxqDERcTadng9IhxO1PpxGilS5vPWOBkmZsIxsNolkkjUoePI6On/kuqlcIrbRhXGYMoI22mlnGmlWg4OcXY8diIsZeQFUanwtomY+/UgDn9QSj2UboJOzn79T+DF6+P3jBeuok20s0YxDLijxJTZiBlKc9zTBmEbUI1K9KSCKHebXJphTnUyolPbgAOpLLMVD8KbhvWcSf6U674WCTXd7BCwQ2fCieM9Qwk2aLgGLqVKHzAXzKjWdKJmPKkf5u4WUFvrTNSjZO7raSSLuk7U4pNuy7s5jmJT3xa5MRCjDoHo163090Xve7uXnu4OxwedNtdvrvX6e1nBwnJZ4QttLLC0tzt7Tb9tzrDgBzGHLcfWCYcl7nFLCkZAa4HNS+KXKbe8q3fLQ25XVJnjVc0VIgCVk1O/gVnBY2rOeBZBmsaB7cE4ujVZNkiZH6KtWg0PfwdUQIK0CJInAxqgWZDEpkxPfKxRZolW2t2X7ZjO+3tHGwfdPe7ewedjO9t79DTXq+TtvHc203u4CUnnSeuNPRWOxO2zB2+E0V3e3tTjMNcwozspTGI7QY7E640CirLIBtpKqxjQ535SJXqhucya36NBz5vm2DuQ52JzeBbj7VXEtk2NnAUJBRe5BQDyTM3MiPnTbUR0YOVeT1dc8WgsERzhz3nGfQN+h1GZciQhqcfwOsoe1ygSyUxnlVDkAAMheGhacW+4MO97V67O9rrct4+6O7s7w57I97pbPd2ez2afYoIQ+7apbm5MXy2MfWvQgkjU5ZrVAz5JwxiBIftvQB+cgyRTkzt4z7wPL7A/pTrgXauZpSXUUXaQj18fnjKuvss52pc+vd8vGYE1bg8p+JT5jkf0iuqKtA8MD4xcizVfaIIVU4p4V68fDW4PL7Am7OX/7p8eY4n4rVR8AcK0ZpRWEJUxMJEf/QSRwU+csusyGEOkTXZs8j1GRTiyi4TyvCXnVkYE7E14kgpjIiz3zNimfViCalSKQ3lmz2RTdHcYkN6N+UunbAhtxgAFxL5MySyKFzjOFryGZsIngnztMkGWSZJSZ4zZCOYYvwMjBjPMkrdwGBUIpWFX3d06ZjSTqZi1RcLU656Y1FNjpedQskByR+Pk0HqSgjn1VzOwnm0RBGjfyBzsNyqdBdLRvMmnaFGp9ACK+QMZjS0SLMhdJMo6LEckbssCo+q6OYVa7lI+nL3Ogjzwmn/LeWl/YK8O81RfhpetfmHGxGTz9IKHqqR90blpliR8NEXfBocqebuqhKfjaTIszp369ytc/cLc3f941lEdfGrhz47m9DnUkUQTovnBvQxPnqUrpD6nwHaB0duMRgkQqTf3l5EiA968akgYPgd8VFYyjeB7Nwf4f2Q4MfcWSu+IAG9HYMGI1QikfW93AuJvaGCqTqbs73SZigRoOoeiIiqadhMl4zDZKZUHkRzu8UyLaz6xbEJv/EtAuQNFZBmVVmj0FK5GknWSLJejerV6OdZjWokWedunbs/Zu5+FknOpfLZEnGSLadTbmYh0uJ30pYzECz2F+cp5121jlaIGZtjrGQVOSTD9s5wZ7Sfim7Gu9lepzdqp3ttvru/s78z7Lb3k+W1/mqRx/MkW82pJX8HP3oTA8TdAMeVCsFlndbZ6vYfzGvEiMoalZ45bobNYdLrBXbsbmLHN9pBNzAGdjQPbC9enh0Tf0zt2ZPddGlSQTA7mA7k3HlISTEMS0vrauhYQ8d6+amXn59m+amhY527de7+mLn7VdCx+xh07H4FdOwyglgjglh/JXTMgDsImo3gFOiQljCvIthYQBU8xd3HmPaOm7Fwc6C3giLbvU0UeaE1e83VrAJLdmUnUi3MReUNtFOiNRUtCDgbo0QqOrshdfjtnY5tAJMiflgup9LnMSkEvmbWGIwctAo5U8XbfBap0ryEhL4o5Jr2XjViTCKcxIjgHzj4fdAxCvV33OOM3vqf9oPZGWl8TBqzl59SISjn5/u/u/edEjiC8IbKxXnw9QPHBcKeOVdoI8SnIpSvOQStoXoN1evlvl7uf47lvobqde7Wuftj5u5XQPWIhh6G6iD4YqgO2uY2m2OpVxRc/3fE7lMlSuDDm+nUY/VsgcE9rkAokUCF9hut/shwP2lVJ41btzK7a4XD0wkdUiZcGEQqTQ7KiXOF7bdat/AUPHTX5IVsooDBWW6m9Mdmqqetm849dYeOmYYcQ+XKytT3DXRyO0zS9PY1kkI41Ds/QbC214iCFVb35ws+y58OQJMbZ+hBWGCzxRDuMZz8a4hZoJf4xXrqpg+fDR2h26XJ7x7T59+dz+kRmDygx33m++xcoGeQck09Ev96cab8nEB3mH3jZPliIaHt/vbGZCdE1mbPBTfoCMIJmCe/vb14ysYENX2ql5ZQrpDUGyBZThEivpQNqtMgNMivLkaX44kXfLBy3oZSh41yKMzeqXMh2NVRNMIb1PgzFGVvUhokfB2gUddPKs9k4gYhiuWvubAkBZ7MVAsWavGVcU/9Uud7AqnohL9/23ynGuyFvxIgackmmqiib/HYVVHpxZf0+lYh/lFxawRuDc/NPl2TIpj2Kg3nt1PkL7HgufXW+ubJA7/GEj9qoPCGuK7LQJaIcqyekkorr32zHCv8GsRvVY536u1EYh1dHcZC2WIWy2CesSOWTrS24p+MUehQGlyNS2TRN4v1kSZt+IxotLeXRGqEKRuyAVTo5TtGYqgQTHxIq7IHJTrsj/iUfO89i5x/72+VvF/R2b++wuJJlJlO7TfLTBM2aMJGqAE2yh8vOkBY5Dbp4OtACIDDhf99JYiCLtW8wOvequ7Zt/wYWhpSiOq52KIf/ugvClx8Yv4DUc9pUIIJVM/PjdG9mMiLFqgVY1XbAesW3JQ311gX1+wW5J3/qElr5d9NX9J4sNg1OVH57HtX6Qcqyd+n7v5FFa+uND9jpYkwl8LNTxv7geUgD2htcw+PNpknAv/iq89Uj6fRrYQ7foRhltkUOXcU0z6n04kUvvsvBHeE/LYorvTU52G8YIYezzMaG9AgaS3QKB/KHPya7C3aKwUIbqi1olO34Pq7jj3WOax8Sk5iLyrHAUBNp6Wii4YQopwyjvB4xLuZtGkZilC89xgE0h7GzUdVGUlhQ6Zo+ibDTO3JiLaJ0YEuOfGRueDD6lYfDEkeiZcTF4qcidxHGdGtwu/HeCNyGhORF9TcoYICTImlGV4fXWxwBDMVf5jQZtyKg2yLaMGEWp0QDJ0mWjp6RW0SOtElvme+N2KLO6orYXS72A//ca+mxqWHeoZWQftcZIky9DChYbxKqoYR5H1/PzT2jOhCJtRaguT2lnZDqIG6o9d/lIJa7avrRX/k+0q4k57RlI5QLNYvoi4b9MlZlPqp/z1n5XrqvTJXO3hqtmjeEzx+ENTzYxw6Y8jrN2W8LOFD2LZZGrLxwwY1W/NW+vSENrA8SLlv4Y4PUByl6b+2E0nI +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

+ +Async task details + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/reports-data-extraction.tag.mdx b/docs/api/v3/reports-data-extraction.tag.mdx new file mode 100644 index 000000000..8357f4677 --- /dev/null +++ b/docs/api/v3/reports-data-extraction.tag.mdx @@ -0,0 +1,23 @@ +--- +id: reports-data-extraction +title: "Reports Data Extraction" +description: "Reports Data Extraction" +custom_edit_url: null +--- + + + +Use this API to implement reports lifecycle managing and monitoring. +With this functionality in place, users can run reports, view their results, and cancel reports in progress. +This can be potentially helpful for auditing purposes. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/docs/api/v3/requestable-objects.tag.mdx b/docs/api/v3/requestable-objects.tag.mdx new file mode 100644 index 000000000..0c25d589e --- /dev/null +++ b/docs/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/docs/api/v3/roles.tag.mdx b/docs/api/v3/roles.tag.mdx new file mode 100644 index 000000000..5026522a5 --- /dev/null +++ b/docs/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/access/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/docs/api/v3/saved-search.tag.mdx b/docs/api/v3/saved-search.tag.mdx new file mode 100644 index 000000000..c20def155 --- /dev/null +++ b/docs/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/docs/api/v3/scheduled-search.tag.mdx b/docs/api/v3/scheduled-search.tag.mdx new file mode 100644 index 000000000..6f38b362f --- /dev/null +++ b/docs/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/docs/api/v3/search-aggregate.api.mdx b/docs/api/v3/search-aggregate.api.mdx new file mode 100644 index 000000000..fe2156db7 --- /dev/null +++ b/docs/api/v3/search-aggregate.api.mdx @@ -0,0 +1,292 @@ +--- +id: search-aggregate +sidebar_label: Perform a Search Query Aggregation +hide_title: true +hide_table_of_contents: true +api: eJztfety28jR6KugmB/eVUiKF1G3c/Y7oSXZq0SWtCLlTT7L5R0CQxIxCTAAKVlxqep7jfN650lOd88FMwBIgrK8azmoStYUOZeenp6+T8/nypyN4srhu0qPs8gdV95XKx6P3cifzf0wqBxWLnk0DKNp7DAnpibOvxY8unfYaBTxEcNWDgs8J+LzRRTEznzMrd8iHi8m87rz8t7x+JDB56pzHy4clwXOjI2gsTNln/zpYuqEQ6fZqDYaDTWT6Av/uGHkxXXH6Yeiz4zFc9VW/pqMuoi5HKA7nPMIe/jBCHpf8SH8OQ+dd5f4FcAXjByxbucXWJTP4/c/jOfzWXy4ve3xWz4JZzyqx8yfzEI/mNfdcLrte8E2m/nb8RxWzSKv5oaTCXdxrbUZi9iUw5zxn2Z6hpqApfYvMcOPDqDTmYYRd/wAMStROAgXc2cc3iF8/nQ24VMezHPXUalWEC7qd+rBFslGEukcfo+5u4j8+T1s7OfKdcyjozCY80/z7mI+xs2OZ4ei02HEmVd5/wDbngBPvXzcfNpqGC+AX+DPcDiM+bySJpEL+hqWA6Dj9g8Xk4naO/ih7lzHCzaZ3DvxjLv+0Oeec+fPx87WxJ/68y1csUQXh/5RuBiNaRwxRFy/CXqcO+/etp3u5anTk4h3jjTinUsN+1NtYP421WHtEf/Xwo84IH7IJjGvVvgnhvtVOWwA4t0xn7LK4efK/H6GKINZ+YhH0E8MIr5qt+CLqR8g2VM/eTTg88NDNR/5hKwM7t+wT06wmA6APuD4SIwhRsV5fDa4a3W+AHuSgchRNC7hr6XYdMNFkMXm6dDZmkcLvuX4c6BRIONZOFtMBGFyZ+vvtX44Z5PaEfbeQnTPwgDYzRhOEewAUTU2zNmRMYMRw8XEcwZcbg6cA3+oTwEy0S1xwracO47IGwWAQw/2EHbRD1zsB8uIiW8x2GQAxaGFEN8bs1vkpjPBsBm2B0bCXGC4sBo/Jk45BbbiwcRBOEcqiTnOukWD/EQr30KYCNpbNllwgQVsDWADZ5XQPAuawvXkENUgDCecBRWDUqjnA3JBieGXoXePXVzkm0Ao8JHNZhPfpWm3/xkjuXzOjh0O/gmgw9CzCJc6B4aPv/qB57vio01wfSQWWGKMtIKUczIB0ea7UgDKfvCvczf24QvaMvyp7gCtBmEAOw4ogdlufdjWKo4BwgS2THWl/RsoiQj7V0EMAUoDNjkO3RyYzqBlIFAtpFIKmDHQJo6yiCbQWm9v6C5QZIl9sbc4ZizeHvPJbFsMJf9hgwmvgTiYgGwfz6eTykNV4ZFFEcPT6s/5NAfEEzhgQM4zOF0wJR4HxB3IvAj+REGzmM3CaI4HTAANVNv1PB+7w5khyo5B77hHzDDPo4ZSdsHJ5HSScelA+NAdVysBi+cRTIc4DJDhvKswF4aPYQOG/gR2uIpf4GmCc+ff+kQA2Hjuz4VIpz9v5QfYM/xFNIpCMcAWKmGaiO02NAwyKjjEnxBfut07s+F7+IUYXp+gzqM6XA8SndDmgK7gcIOOZKppiI/fet3Ts8uL0/P+b6opdgRugsygKslSnkGh/f1G7X5zxFnAoQHJMKgfJGiWx8wZwDmDvenT9Ebv43gCA0TObzhbF9nrL+agcWocofxNFzEpHPQLgQlz/3bcOxND9f9xedL9+aR7/JuDexR5sJGT+69HGTAx/KXxB5/7J3+nfxQgQtuWPMhqmWy/+a3a/V/01qp9fgss0hc8CQ7/xZBUuOymyxOScJnoFsTUreict5YEuk69ZcEl/lYQyQEVGCh1s0OloZHzKtYnyEtsMNLEGIhMNZEClZjZlM0cqWkaI9iME4VFMqaAISYRqwhowJFtkESrPOjzksfKbcAJ904imGgIhAdEBcyzAIoHWWxDY60sIxz0xFkMiY6LWHE4e9h3ApYerY4smPtE3N7d3dW5aA48eHu0APawzYNtbg6xHaFJxEFV2Ib93Kbpal48qYlPAm/iD+LQfzK//9GJ74HPfXKGUTgl8AQ8QPcOShjSMwYAH8iCS5QFJL0EZ3bO4dTCz9Ioyj1GmtRQQB6yLSR2IS3ykSV+M7ZdiT6S3LRJwOBeiVZSYhLfILUNzFsyu5w7RuwQzj7+XzEGNbiSv1XNCKbso9oexUuRGKZCWwDygjmBGuVybDN1boAdSvPoXmhfBBgL6EOkKGjo3FTY1k1FMtVkYfA9YummUoVPQz+K5+fyT6R5nOamEsNAwLFEOzSmhYklNFjCFeiYkwUghWn7DVnh3B2rBcrZBTRDEHOSO4a0loir1dQd4Kri8ws4drdAAWzgT8AiBUEwA8oAfUdwVaVUiOOolZQUzkAlRXygqiOaYOMbQ+LhShViESv3Am3yoEhuYWFGQFd1BguBaxd18+DFnPbFbqnoQwwGgN9Iqe8osU/41O6FuYlYoSJqhoTfo3ILqvrEj+ek90n8TBLsVZYrQvYxsTUAsm2Ql839Kf9vUA6XiH741fk36o4ZMmLBvROxYKRoOeJo/NBPHnxYc1C7UzjNLts+AqWAjUKEzg8CHv3sz/MhUb9aHFK7kgBrMDswEgAAkWXaUwqfiUshEBwFoTOg1Fw8MRPeaVuQ2rzfgB9b/Pw/nS0b/OTw5uam0hVkfQxYdudhdI/fJSp9ruWTbJnUQJWyRYThjH3YabFMwa7MDu8krKgHPR6/UiPaFiMTNn906GdiycxRdg1yWGojGYKPbs8QYI10k7rNtIAVSQZ1n9jncgWqiyBkwU2qjjQdYsG14Viu2QHRr/LwYBoG8ryZXxIBaF0RdOsvp26gpscjfa/ebCRULZEuqDbv6OoFf66QNMIP0o3zz3Ac1L0QFGFaL9D3L19PjcPhM7qcyVdgoClaaVJLyXAW8XsG97+i/xpNFDCJI7AbifZQB1AKAUNAAY7FhCHXo40JTaMeqaj+SKEh9Ezf/egMovAugKE+Qdd2c6fZOUAVf48kShHFK0z7GR4DjufHswm7R9GLWw9fh/ecn5P+L41k8r4RVEQO3SCHW5+iXoESS2AS/jfhGDRAqSftDdoNYTQC3IY2Y0oVsbb/5Th01O/8GA82qEc5nY0VL3MxGSsVLqcqeZiYH+SgNrWEBGRkJjDpJCT9EmX23Zj8hUWAN1ROCf0IvUvKc0kzbLYSdLOZ3KavT6Fk/on9/pXOJYoDhpPYp1PIDBsC5R414lmkSoQzZfsTQgI8YwlSYAhP/p5i8vCT0EX/GoJgUNoJ7gSMSPJLK9DYpg6N+kmXQZE+A+y0RIOhndxIhckgS5zCPDw7s3HEYvQu8qH/SQAlxfFKsQT87KM21lawDFSltVtT7kviuxEwSm9nUUUEpxUidrnnK19RXCFeKcBw8mnGAnQ2LPPiapd/vBgCuqQzDAmVDpW2RjkOJPxKYJDeBKfBEOgqcGUH031vOUaUIScnUmSjQgkw0ls28RWZHjpNxGqz0WgYiywST2ka8RTsbpz8ZsNAT7MBiIn9fy/BMozhsCkFJ0htpyCt4E/i2BE+ZJRqYwgNkGyYCCjQZJdoOKjjAiBio4Q9JiMxKsi80gmGI9okAn/LGV/ev0XML6H3CRsJNi4coRITCA7OVkWFXERygLnQDn4hD7bZLhliZNsLpXmVsAFZQlqtPCbKX0bWhMaWFaCPnXisIltymjXCUERmbOildnpFQ77yJ3Bo1ouL7mQS3pk+HyMCinKZhhH2jlSmROxMmZOJ6qJ9H4G3TQxe/KmNKBnP1op71o8nR1jCH6wZZczHmFb7s7OzPNoTULWUqffU4hEgFkLFY4CM58z9OAeNF4FLmysWHcCPRk5JPmtfFxNKvCyCUiYsGC3YiEsTLBk+VlENdDcpsajEk8smqIZTOzyroyhczMi5DMLMPhUUKf2S2MJNsEF0wQoliB8TNiX+VvjtplBpYzf+HmIJanMNN396m7WT44lCDemhEyORwgsmhpda4OYYOdZ4yhI39jH+Mg+TTFEyYdzAKn9ILW/t2v7f//zfWJkprjpz8QKPnODlyalCrcc6c4Kxy+NIag/GXDWdro7DB1r6rRYrhppobkm+1S95bb4zUfgploX9Fbmm5lKOWSVMbemwWmn1vdU+NxX3NaZNlrWRq0moEgYRkqbMoa9bDMPGvoIwQcPcXGZsqb/5OF9i/hRDugC1KNJBUc/thsAD9win/nwuEzBkF9I0jFY6HKU0PTFe4gpU9rstRVZ73EUcAgW8I9wiSze/eM5EzgpxyK+YRHF0cU0B7uvz01+uTz6oP7tvX6OMu34D/31zcnzaPccPp/Tf7t9tkZfqmqBIfaPI9g2tTgm+tTbqPEWosNea+QDBkpC/FAaydq0IMiP3wYu/vBDZeJLdwu7bpy5fyGvo/yIOnjRuH9LLSJ2+YVG1ObBjm9grMf6Zn3sOTYG0hAcKbFYrRBuPPZcSnKdghidm3s0TnIwUaL/DyeifXL2xCZ2+MRcpv1CEIRKaheJcgMqVFiOIPZTRU2MfyEnxVWlckvhcAnu73IwWKYkwl4QtX9E09v+8f9o/O3kD/1qHR2AndXgGC/cjnxcTXaItQkKqSt5xyeqDg9XH5pHHRYLyFMflVIWrzkKplj3FoUkB+Dsdml721PQyx6ZnnJuXBGZxuRCqhZEQ+JLjsfpwzOG7wQJj7y5m9C91ur2RtygSR6SAz3QzFHO0pdxpUz84Dl2hXWRnFU45Y9ZEn2EKQ9I9hAHQDSFomadW7JB1ah9yrdrYNBqXmALxYmCOlFlY1yRX2+aw9VR1DmeMzOEstddLA6U0UEoDpTRQSgOlNFBKA6U0UEoDpTRQSgOlNFA2NVBK06E0HUrToTQdStOhNB1K06E0HUrToTQdStPhP850yAi8J4xUPFARFM1uF4OeVVsK2vTMtK10+zWNV6VmW5eIVNalSJDO6o3OdcydP2P+Zc2+OC1zqj26g+hbLPQLbiH92fcofdaoxpVdxLWEWVyoMYC+8wMvvHPkFR7JC/QlHZV+qK+8kKKirgZjD7pCILspdUWJbMKZnE4lZIpMdqq8Jcf2k2s04vYBtbezCakKkSjB9jedro9p02N/qFkg/iaXo1dK68L8ScpaB1MiU2tI32dnkzt2H+ucZxzx9FitSV7+9RP1TV1IFrcs5WKJoi18QQ+R0o/LC2JkpzgZWF0v5s4IKNxbyLv4Wozdjf0JVwXVbgLrRs8dVtBJbpljemdyz9y+ig67gE0ASwa9yJICYA+xSRyKO/xGovfpcZXGlPM5725MYhMX+H3vpvIe79CfGhSg75ICyvKsKcR6yz1o7jf223sdb5/vN1ijudfhzeH+PuvsdVqtpr5EQiOaQENnvGs0DpzjkKCYIxrUJVBmN8ZRAApaZDxn0ZzY/p2Ch1G5OtolBTRRol2WzygvNQnDj0CAHwkbBhA3lXULAjw98oSraaD9uknkBciJqI2Xz7wmc3lj2LhPT9vMSAGV1xAS8ZmXUZuYLZf2tdGVfp8n0vu/stpy8vfTXh9Vkqvu+euTSjXRYxJ1QP1ka7JKa6GyBMU0WFHBAPiKXIF9GSR7c2MS3uVxdByKfnIGdDlUXRnC0deVGFhiJa7V/805XsTAzzxRRmulHtXUF3xi/zZn+ORyjy+GV8Pisc8o06nlFb7LamoziC8ECqhsGWbppxKzj8Os8c0VnQu6/Z57u5wco3RvOHsMijHOlD2LyvIHUT/xIblTVAA3ktOoS0g5XsDHYCS5ImTeSHhIa6VGA1riNONjIp/7dMrw5myOC8ow3nU5P7voWs4lJat8V/qOROJPltUMfga96g1qPImNqlGT8gFKGy5rQtHSM4vDOgtrFiiFvbgq9Jilip4591xylgXfugwrsLEJlan9vGxBddgzd07L0m6MpZuWNaKeftMST4rctBzHgt40ZYev3q3MqrK7lVnZ19utnPUcGqUrCu1TkA6f1NbsXCbeItwLv8eGJnEzuaEi7mDumvrC2lXLq2Z1dXp0Id05N4JnObQgPIPW5fWiyMsSSFEEfj26kViyMDpjWG/auEgP/ahJDqJyiSyDI5PO8pE1TPs/H0l7GT8qmT3fOEUmQRLZ1YoSZIiPuusF2C7l5eRdiK5XEnSBPSpM4gX36RshfGs/iNJ1VAuIPxmuLrGb9vKnDtC6k5M9MvkCJ5tssEr2EN57dpffU9Iec6yHhDgsJGq9pDk68TJLfXKRXgDFRUR8Dpp/B7FvIHeN3E/wqkgsoc8v1yIkIhPTT1aJUJUVaZxWo5E1PEx8GTbGE9XyTpPpeneELiEnaz0pb8zyoFrdIb+t7gifsW+EldGpmIXtu0WGl6qrqVJhspE68uahh3YR6Fruf8DFcqteuPCyGnXdKapq1H3LJycZBKJ7FR85HqLuAqvj4y6ErrRRD5uNA8y2Eg3OwsALUw12d5Lfeyxw/hrG3G7R2ktavIwWccwncarFrjlG6FyC9RqmmhjTvFkEPtik9u9tYwigETYLozQcraRJP/x4n56hYfzM/Bn3U5jYfXhPhwqLTOV7ClYEeq0cCTPsnS3W7uOwU3zRIyTZJk+QiKccVj5IvWMK5xAdDFrqyXqqOaE4rEZPRXU5ufGlX1Omrg2xJphdkrXuYMms5NpN0Qs4vplBl+P/kL7izu6+22kduLuNJnxy2e7woOE22812LgOAzQasGbEOfUiSOOlDVcfEl89uOK2zs4wXU4YMj3lU5cSMo+fNZ7qQ1M8F0hKteddV5pBaChLGC2BnyW91O1yNlOYBvThY3g9R4cIy7GzGJTOc9i5q+7ALVJ62RpVtabGRLJJIvBC/pbCOEWe6Y8BTxSwITLCYUHEYVZtIh231uDYZNJr7tcZurdXptxpwLA9b+/VmY+e/KU0w9Ciy95WBpxCOmuuJlxDfI608zQKSn2gVxgrgTCxUzNQRU4pHhCSngZ5sgAXoUDoYxWHlz93LUzjlMsSZzOKO0SGKlUPu6e+5qI2IXziLmSezSBJkqmo/sMLRCIM4jGAZR2Hg/1swGHqvQZeoFvE8AxAFZ52AwdlkyCQOp/jywYT+mt9xuYm/ibX+JvZWheTsjRaQejQ2Ae/OxRtKSRmjHGw8ARW025oKeIADmWRg+mdXVw8j4ZGcftJgdPBJDlxf5efV2h498CBW9ARwyNqZctgUDPllyWTbI4pnz+MrrZA+AhxXDkLxY6XaEn3LWUTVYQEwwo5Ar8STqiMa3gVFsiMvsNkLIzC7NJ64+uSrcY77F7qSoor1nR6T1foPO7qnv8WISgHekoYUxGc9RxSznd0hYx7nOyCKh4MdDgTtthq77YNVIjV/Khnj1gFa4xUOES6lUzGFA1h8TGpuD+ZOwoVXkxHYv1hP5QjTx0ipeQl8pau8CNnNNQNjPmanyqy7D/kZ+0Xw3rX0KFhBPt73Wx226zaZ5zaaHbbXdA8arfawsd/cL473zFRZxB8hrpwTEb7/kB/rzgyj7SaiTCUiuBUSj5cGxK3ev9fLQZX0w0H3yTe2wV6xnhOqyNeEKvoxIbpOgGrU+1TczpiMMrHQp7qeYWSQK52xBTVnezDh782hqeFwH0mn2dnr7Hk7w0EDP+3vD9vegddo7A+L05SeIktLJ7KYdCyqhfOUKy5lzaTzKZLGplCReHHGLNZsO6znxFKXqNPQ75JHUz/WpWUfJeKMtRAos2TMQtJjI63ewMUqrV4cXR6M/IBzlYGjHT4bTePobrkbO+WYoHkxtDKsN1mDrrhqQH/+k+Y9agHV46OfNLvGP44u3tBZSruOCk0qetmzUsY1DjmLgAlM+OgL1C+TJjBhTo9YiCKKHGd7PUvkxA6e5Gar0xFn+qCxuzNstwf7G8hne54cIVF4rx5syWoMXEmxBJ0TnMnotWE718nBJj+x4OvgrGy0nsn0oZHwz9FbEQM0GIzHWRKbJY/B5Bf3777+0ITG+G+rYugVOFUqe1dw+kvB0I6lEKQzmxJMeQIYG3QNybXU3fIkGkuGyJbl7rWK+VWSZySWKhnFE+oy+sP3oUEYPyqKUUQiUvRSZ8ugoLUudbeY4Okrp7Z4ZTRJc5cIVAsXp2+jNy4lovQQag7aw8pXeOzyTzrFuCbnrqm5a2j0Wwc58X9f8SFQ4LheOsn+eCcZ8PRCRo7Y1RfaA+JQz5QIk75typoMI3/kF3Kv6qFFl7wV6jnwBwH2fJGb5VcEbuiaD3gl8ZQIP0TpcX8ij/syh4xR3pvT7Q2Y65UQBPlsU1huyYsRWfmPbEgYUGI7XX/mq5BpuZ3PfDux0j4+VSnfUirinbFEIjACNYS8Emdzgt0mY17DPeD7zfYOd9n+Ad/bZe0Ob7hswNtknQHbDqMC1jY1089aY8RbXHuiFYvbOzIaSJUIDEilxbtcO17HH+9AM8DS42uB/FU2/GPABLsApgVjbS2cXdXSvheIz9OhR9xbRAK4RHcq6LtQzuwcCDYboYDmN+bKd07PsFmER9499aI0Sn22mIcCP2JT8ClQ/G5KIZWTfg+09QEOTzSMmpQYusipSF9RTrpatSv0bN0rR20AzoRqRt4kT6WXZDbfUJtAS9bKlBzf0OWhWd9PFWJQkMvYB/22Quv8hhaxWsP8pgDVkZtSxD53ESuyZ4oxEftOtmLnFpSv/MCPx9yqerSOlG05kXOWCavCXGCTKxl1XCtELmQHJbyEm0rGzLG8Ez0f7YEI8RbQSiJONTaeEZa+c0MQbiBxZMfTYmEsmiPtlTw6/6k7wOdvYfvH1Yvrn0TKGH0SzxfH+PmYT0NyIcJX+C9zpxz/pRid4cYujMCu6qETFHQMWr0Bi/BugIyCMTY9b9ZvSt5mSk8OZwUimjC3rjKg3kNCRULNYA/e9bwN/PFv1R29JaO1W412p73X6ex22s3G3q4tplK7IUh8oyXh/Xh7RibgT+JkJXt+1ux5CYMwIprmei5sBilvOsonIE9TBzT/xB+JjF3NKqGv5ILIAvWx1IkflPok8nyESYFTKdWcnhsLDPPi63DNvlWSIfEeZ6j3YL857OxzBtS732q6bX7Q3tlv8V2y8lwGx2n1Dl/JRL9iTCytdOPCreHiKYvmICr5vKZSCIuw6JLTPgWnLVnkd8IiTWhPTGYnrh6JtsU1HqmBUQqjroWxTEk0dEnpRlE6quaQX4flXafJJo/rIUnUj8OSsXwDKlwy4hs08XPC6Eg8yUpR+t4xw/sl8isSAdtn0YiXTu7vgH/lWOBLAFzqiC5QA+MdaHYBDBpG5Kd+77y7CRznM/7HcW4qbujxm8ohfFoEWAZrFPj/5t6Hj/w+xppGspX481D0FV+Js3xTEd+8103xMik1Tb6a8jhmIznNtTGNA+P+EP9IRbFo5YfOCzHuCzHww03w3vlBstRT79Dp8ANv1xt2ageD5qC2s+cdwKdhs+a5bdbaP2i3Dg74j0LOF4wcUqUnaptiqYqTW9gcMn8iXRw+XufK59lr3BylFvIdneKHzC9ZbbMAGYrh0K66DSe3ZpaIHdeypZRhScxhyqrD/IiuH9Rud6qOysM4D+/y16Ci5mb+lJlsk5NXZGbilHlTZd5U8byp7yGJprxp9jxvmmEs0yiSumEO7/KbNl28B7rJBYVUUvUX3E4QMpsvGS/DOwe7/IDvDgf7oBdw7jZZa7A73Bt0NriscGygodjcF8e92s9XtdRVhpiPil1j6MmGorYEqQvAsDYwrNfJlUGjcQCIadcGnV2vttMEbXJ/r92puYNOu8VZYwCCZhlUsGStPRVUkvoY8pfdVwxrk1ua46r+BiY3z/6Ol2J2RQ3qJ7rgmMr0N4YslOpP99Feh7ccdbOnAoIGdUZy1GJwPON81m/gvoZQMzan3KRkDIATiqsH+ipTGrLVBN1+HjcdDJFh6em3+Rr6bambl7r5prr5c2ZmpVL+fJXyondpzg2XkVggwxIJibIkzjBbwClHHgF8IJX5L2BclZuUw0fllWzyQiEe34lv8bQZpaY2ul/jBx7/JO7U0EJqxKN+FFk1zsSPKcmK69ljhXM/cqYgnjGHN3Xb/x+9/smbD0cX569OX0ukhgVyQ02cUhch4kY8wGCEjPwTIKn57mMKsqHwVKGI4jOJPlWHikjIjP2qtbWpDCgGjLDe9dg0ltdY3I/FnLo0GBom2MUedD57VI554iYVbw2pjUptyG57uH/Q5A2wJIY7rrs/GDYPdvebOzusyfd2dhpUU2IGEimSlRjXrIUwBuc8FoWJTi9RaGFfe9pOqw7/O9ir73fI3uVzoMQC40tD8lZdkKZu9tB77cFuxxsOuNfc32l1drBmxd5Ou8Wa++7+zqBhBRoL1JnT8bOsv1OTQP77Ail/+ufKLPRoaaNGuwZsl8Vz1KvCaITanEtiRFimsppXD1Z3icdTxOwIvgIJhaKdwX+AzY1BB+SiPl7uJfq8VwKv+z9jYZGjbv/04lyGDWXsb4OAKB0fwTurRp68TI5fcpKuTn65Pun1KxvERgS7kxepMmywR98/HSeM5Xj5zFD9upYfXnZ7vZNjUWPeHQdgu0wKOn3kEQhQF5lQfIpMcFHeMPWteh5mGE4m4Z2gjBmcATAgEeYXkrI+6O39IBbwor6CID7IPfqg1mAbArcpE0ArhBld+TRRFUtDoDQETEOgjDc+VW3B1Q7lFKy/1Alc+0RLj+pXmdVUnDIiXxJQ1tmIpYKjeF6MYRrDUK+8YhcIBQ6LYZmNR6VYTp7XXWqDBatbGSPOIh8rGItCV/l6lIG4pNyVx6dhXabTP2dj+TsIws3GYbAZGVGP3Fugf246oJDXOq29Wnt3r1W6E563O8EPSOA+Pjahy/fRg0hisEIObWDSoG3Ov8Chbk6tRys0d1Ft3jgRMuEJ0KjtIftgXJ9fnbw+7fVProQqzWUIr7CpnMyluuYewCZrsba3I+5AsoCNipSFNAaXffJYzGNDqn7u6BnFZ3fPG/Ldgx2MEfJWY5+39txGZ+9gg0pRyi+ybsYufOux+lUoXmfYKJKdDtpuNBeqRn78JrMvj6dspmZFWMRTmUlEx4IkHSq6TKptF6YOPbOqs11Qy80fcEWVyfbA3Wdea3ewv7u7c7DTgX8GoAO3D7zmcLjnrbR91k6WVYB+vnLSMfWC+QcmD/ji5AM/b7DfI/NgzcT5aQebOKjesBm6WICayVYEhRFm/cjvt8XrfDMG6u4GTiqy/OjdjGvxGgcoy/L1DqEgy7B2T3LyFPsV8gUNTEAOttlQ/dF9ie/zInV3kj7HiR+xyAyG/zA9xxrD5tuvNbCiipJR/CpwLgU6RIY37PvyKLfu1sgEqpWzux8xd82U/5saUr0T/l8kSUXC9ZpestV/WRbwZWbjk8s06/2kZ9Jlpzo4LI5D1yd1TqeamNWctc+0dEs8kVviCW6dm/eHykT17yVRnRTHL66RTwTjk99ofVl8pcNNQvfj00wrRipokn1xkpMx8YYJTkBHZLMehZEsJ/HFQGClZEo9UmM7rh5cPD5vcdb1+AHefBdG3hmL5738MO43JXsNR3l3pSqXhvqrqnbT0MMADwbcxW/0NIxWeaJFPP8w4bccC3LurCtJ9I27D/Nq/euXlSWZbp7RV1hXWJ3Jx2azDfST5Em12LZRl5dGL+XfE8m/5bZqiUgLkTpm+EhUZeHS3j4jzUdjJA+5benlOiAvV3PY9vZdb9fbOTDAK1qqg2l105jdqkJox2HOfyLj2KFQTPHiR1bMRldBSr1U0p3NBNeazZZzrAzDWcrCirMTvb6WQKCdArTWqlJPAxG39EdBkoGca1Wte9uOprWetuseHZ30eh8ury5enZ6dZK1+ijiQI08+BlrofbtK/ut2JUt91rHopYaMTIoAWrq4Pu9/OLq4ujo5ExkuMk2xmiY0/YVKgelewk9vu2fiFxwHP11enqnkqWrlqPvmsnv62vz4AQbrn1zhNydX/dNXRuOz65785eL8/OSof3H1oXf088mbLnxlPlxcrby+eHtydd49Pzr58Prq4voSvtLvQSUfDdD1VyrHqlo5O311cvSPo7OTD71+t4+NMKfn14ur4w+XF7AGHOnqgnpfXdM/vQvjp97F9dURftvvvhb//QArOXl9cfUP+rP3N5ird32GU12dXF5c9ZO/caC3pxdnauVqG7pH/dO3Yg0Ax9/E0t5ndPOA3h5SBSlU2ialosIfx/2L2MiwQUVNBuOM28b4OmoEZkW0cDGPxvYuGKjUtDcPReJKCpj1Fkn6Zr1t/i57iKrURx6nj5TFP58H465E/DZ0l97S06PSm4HLn1Xpyee+H2wGmZOQpy3zBIpS4j9DwiklfinxS4lfciEtSNY40TNO5ZUv5iWgF3oDz3IFvFzc8wjN/ddUH6q44U9h1MBjEztrcOkalotDQ8zhsHSWM7KQSoWWsq+UfaXsK2Xftyj7ShvuebCjVdH6NRbeChkmKlnTvcOAy+0vHbz/qTRWirxS5P0HiLzS3CsdvN8X435yB2/p0v1eSaWU8aWML2V8yYVKl+5al27pyy2FXin0SqH3bIReaa49D3b0NX25xq+KjhX96Azjp0hxLpp7rFHUse/sPAEMxmgFYWg2HkQBrSeYHYcpOq3GvNyqp9sA6XDfABBgEoWev0u218pgx+4blNzPPniz4Stz/+ksyj41JSK/BJHWGSxR+SWoJO5XYvBLiDH/gmKJwKIIFM9zMPhTOAxKZH4BModgMgyY+7E7w8dFl1R3SvtRjBfHUal4kNrFU6uXufqHpVc+g2c7lDJuFuylUq7rUwbTxFsW6i0L9ZbM7PE2/WrHzFJDiKrh699sVxDdZ8ZKD2QWllVh//CqsGXZ1mdatvXLqaDd1lTAgy8ucKROPz0Lp0WVHHhlYR1KtniaN/JMOFygggFX7+SlYEj5km0QjsIp+RCutP7wCHBcOYjDIgEEjkT0LWehh9dUjQPU3ADoQgWItPc6zb5tkC6wmVHMM1uxclk0J3+c4/6FeNfH0Aq0Z98S3/rbh2qhChtpSDOF1YQoZju7Q8Y8zndAFA8HOxwI2m01dtsblI5VUy1/mrQnlKsNyqSrMam5PRhVp6xJfe0v1sMemdIasjBQsQjGWg9NrnTWTlA/cCcLzywY9MQvhIodA62JdmxvT+zYsDHYbe809lhWrbEhfMQjofSkrCMRuHb01W+FWuGCrEfsUbWaCuJ/9Tui36b9Vj5N+4yfpl3jNF+a3vgETGTM4kseTf04xgJAjxb6xgqobtAsGbOQPN3IzjEwsMrOOaKHcXkw8gPO1YlamRG0dBpHd8utaV0of2jVGqhTCvrzn8QCTpIFWGlF+MfRxRs6+u4YBN+mk4pe9qz0OFyBTKtNaeIxz+xuup58jWV/p7PX2W+2Op1GEz8dNHZ3hu32YH8DjcWeJ+elmMJ7leI6Vg5X0ZhzoRDzY6Rb21aG0LeXeHVW3bt6E4J+DfoUjDLnhe5cOU5lSWaA5UfKrfnbTfxdqXKx6pcVY5xYnjDV3/h2Vd/bVK/b1e1Psy60HM/qEpdq/i4Y29MjS9TeII2PxPt3xWM8Z/Qr/zTfduNbinVrlpGCWbiwtnBPZvND1WXLGXNQIiM8yPGMu+QG0cb0luFtROfgljNjEZySOXYIpE+MDC5nEHr0mMJWr3t6dnlxet7fqqLLlCzHZBRoj2AD9U4mwoIUdYLx7VTmHPXeardr/SbIc5kmipN+leAslGXuqkfSSfoGVA13XG2hH/FltIhjPomrrV34qwfDMDAYeLWFR6QffrwPq60GfmT+jPvVJrY6CwMvDKq7O/BZFvhrNg6wOwudS+Bv0GeH/gycv4bA5lp7puaW2aUabg5tpMA2yeO/1/rhnE1qmiFkfZFzbKBQJgoV/qAxFgYTwLjcVvrR2h5rP2Ff0Azf+hEZRUaqKBZkKqYdAnen0chCdjTBB1KdkygCg7vmXCmA/GEuRfgBSEGfhIMbwkxisUZ5wu1/xkI7yAC21HmKVeCPQq8Ai38FfLs2ipiPEHIC2YWOyLBufQ9dUVNkcmJI/eYrtrNFAWCi3nReMs+5kus7kot5SB5tLVJ18lpowaoLGObkuFgyLd/jbLDbOGjtDHd3GGvt7zT3OoODIWu3Gwcd8bCLrJm/XsN8jRUufRcLVstXIyPOAPcEAE1eXL+kMQrgH8lYtNXLlPA6yIOqcOpfHl06O3vOhAWjBX3PRikkBDV6o8J2yj1UJRAXkT/yc9VL5Uo5PnnVVdmdMqUUx8rL1vSFyhOS5B2HdwSxXAB6W4GViFeQnC056ha9+RmbDX3xl3ge15EqEfSQs+f0MId2hlE4tY4SnZtPcPj9Oq9XgW+iz5rN3bGDDlNkBSZzr51JTCrm/mPd+cLIVbIXCSozT2lI7ndmboqUTkViHOiZJZqwTqGmFgmi3B+AWWAuGwJRSCOU3oswmpvUJneBM8HafNClJDsiXgmMJ1DtNMcyRS+xuzcCmON5KMpmM3z9de25u5wA+6nR0vQPt1wePnJVCm5Eu6G2SXIkFb/AzrKV3i518B1g8hOvPLvl2S3PbsGzm/4R9LQZnEX1K6k+zazqcx2wBeA3IuGZUX1EgCwIHdVIqLxiI+l9bKki/fXXPhzsjzzA9vzTDMMXT6gfCVGeAb6r90N8P1DZD0r0GxFyAJDwKFYwBE7EvUOCO4FYeNkJVe3sbK/CaOADgQY5KiJwzci5DxcifrMI6MFyFldB+edx8EI6V3WNauiDswZebaZeBSw1yVKTLKVRKY2+D2lUapLl2S3P7vM8uys1SQ0VnRapJ8kaZoLS5O/kTXegAXr7qL+jj5yOPJnaCg7maB2rYmsOlUGrOWgO91y+47Edb7d9MGy5uy3W2WvuNQc7LYzSJrL+XXKO9SGzz5Sx32IfCcWgxN2CHrcI0KM5D0PPdv8BeiM+RLZGyThKbwacA0rfa92xdZDj+wxD5w0L7pWGFFs6ZJDgCHkatJ1iW536Aw2YMwK+GGC40ge4kJQwL6zm4AMvjnzIru7gKq7wNcxad4hOU+ULV65tOYuMucTECSahSMq7Yz4msw1R54MRSIMdAXd+Qu3UeDLz0Zq8c4UrPsMVOyefXM7xoGvNvZPn3z0F4CPkET2xwUscvUk6YAAGgeBZWu8s9fNSPy9lfCnjvw8ZX+rn5dktz+7zPLsb6OdSG1qun0ODwvo5tK03HK1LvaKsqN9bTaejIiEg8nZCly4QeIkOTnoFkBICNAtjYiJsPoa/tsWliG2Vv4HpK0LpF+AsInxBdjyfz+LD7e3PsEuwOw91NvPrKt08CO8wIXv7Nu9KlyjqjPQCXMtb0OO3eANDWhZ1wm3kI/kKXkcTCEzLLLOKTsVaOb66xXUfLoC70TBVTLiXpERfY54T2BE6EQwxk1kjrO06mjysW8/b9qp1iEGWrCMPfSvngvYOQJlanrz5GXPYbhiohwq3mP0aoDoSrKq7wH1OhAgaadkbsRfYrOW8BGLADECKW/zw11/7P5oPdsao4XKfkgSZcwkkQmysq3z42IkkSxQuRiJxrWtFSfDYOMMJLNi5CXqcO+/MEkhXwJAJpdiJEw/AXu9/UDvj4XvGKPrq1k2Abd8LtgFD28zq9yOJObIH/EAkzmGa6U1Qc4595D6YTkRt5BLJvHPezdS6mLGuxwLxJzVaTYxWo9HiH1NQCNS+c0XWjQtnF4dgk5iw9ejJxXg1Yzw0nuAbHDUNg7g6RnDYsS1X7dqj4bDGq+F4Nhw3wa90sczu5giW5cQgAieec+q44zCM+f9xHCQdPAbvRgs4RY8Gi26z1ehE1FoNA6SamLLm10AjJPjO4GAEgpjYACUyKSQh6GqBJ47kb7SzcOZ/o9S636w109fvQHBiSy9040fDjBPWcMKa4AGxhF/IJSQsONu4BuIDggCOkv0nTiABNXieGCuXq9Pw29SH8soAVFFwZ3Yo/jhMGJz85NAP2Fq3ARaMCrWO9sHfjhyLroeYyFKugDQGs/BOQpCJKbwJeLUrCuXkt7ZeXHE38ZhcBJP7p+bSSzjJt8N3/yCOV3Ka75HTSBUXPY/Sn/cy9O5PlDHyuUK2CinYqjYCGs+gO0Hj6L4vDp3Oaq7I79+C7BYHr1NvqS9xOPmBbiAcsi3EA9rsND7dSqBE4Sn/byoUW5Gvhm8fARWwUYimfQDH9Wd/bg4mKpjVacybm5sKJcRzeWbC6B6/q+hsaZbU2qMBjmNSNskWxQ/icoRRLUPaf7+oNYDFMCWA0VL718J3PzqDKLxD9+EnmKbd3Gl2DnDVlPacrM+sVIhXPGeT8J5zcZOhYha9e18V0HSDe31TBO085uNdJek3wNV00Tb+JY3bX8Poo0KsjR20eOlGct9CBU736eQT6PfyOlSzAVSEIgA+4Ue8lQqtY7ci/nh5/1ZYdRIWGQI4p7GVLU3giAzvV/5kLi4Oq2CB3u+qhRa6zJu0iMHw/Yg2IfzyYFX3kAs47mHNVuP7OE155m9ip+2B6JwEEnC9+VSzJUUvZAgCNRrNpP6OoDsqu172UlVk1S78RQwjtgGr+WiUyLHMC27JMP2TqzfGKHIQ+lGb1lZFWRh6sHA/8rkxdPYugD1Bz5xBXfmK6664xGEQwtQPjkNXpuS38ArWYmCk85eoLFH5x6OSBJpgWWme+2fAIJn96LihoCa2MQrerCm01BQMHXGEfOOBWN8wJKGQuuqE6qHwc2QjXzEVDIH/wq+k45IXimHFEnVtzRwGFjBHbVBUbRj7nHzmM86oYkUVNbJwShrsLApxJ7i8ijui0jMRiHo2YQN/gqUYnF/xiqILMgEdkphlCKP+M5SeyR7oJ5eo3jjHSuVxsCbFIsCNAiAWUwdvd6/RiwDr7kKo7yC3Aq5WFpIDRPdSuiwqXIgKqgKFwvViiMFVH18HqBScC7SfWEZWAZEGmSULueITTWe242rd2KBz1cZ8QldEwfbgQcyNGd6c9jMjwmCBFLxhNNqWneJtbIvXZbWUatcb9QZdPQ3j+ZQFxriXPKJtZ4649OaQpHe6Vo2r1BViHVlWvanUjOhOAtm6boZKsLgxJZ1lmatodeflvXL+V4lcsLjJDGmHOaA1+FOgiHDogMbQaDTUTPJOFqhfYeTFdcfph6LPDOsJybby12RUrL5jHE3sAdQBval0FBLTu0v8SvibDJyARlpcVxcPEURezQ0nE2FT1fTFsPhPMz1DTcBS+5eYId84sy0NH7Vmuvmbt46EvdH9whlGw3DnF8LbKdzK7yR3MlQXUovG6HuGXz9/xnAJelkftBYu7qbqgtVSY1xKGRfDYcznogqSiJhM9DU6+KHuXMeiDFByRY5O7xZlhmxRnE5giVseSzEE1oIjQ1l6eXsS38BHFL6dS43vp9q3JabzMpR/5Kgoh4QIQ2SJe6mFEfmGfXKCpNq0WD6iR5yp54MI2tjH4+F0KC9QOr68uzoLZ4uJoA/ubFl3ObeSGJFMKNJCLweXWEvkjlwL5nVYf6iJEVnYltjILeeO0m5GQYghHHQJ9MDe0NE04aUWt0bFdVHkOiKZHnOhCFvYHo4xw5pdPoXVkE9hQSWMMQYh1eWKOc4qrpX+RCvfEmk/AC3hUGABWw8on19C8zyoQRVTTKjhfRKiAV7zXt/UJcYjOsksoFrfVgIz6U1IWaKHCPSubPveCL5dXtBbF3hvlsx1EUeM2B2azvDfw8pNhcz8cKbtOvr+c0VF5dGqp3GV4zTPbyg/4DIfHv4/weMOmg== +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Query Parameters

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. + +
    textQuery object
    + +Query parameters used to construct an Elasticsearch text query object. + +
    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`"} schema={{"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}}>= 1`"} schema={{"description":"The max amount of records the search will return.","type":"integer","format":"int32","minimum":1,"default":100,"example":100}}>
    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* Filter
    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. + +
+ +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. + + +
  • Array [
    • oneOf
    owner object
    + +Owner's identity. + +
    source object
    + +Access profile's source. + +
    entitlements object[]
    + +Entitlements the access profile has access to. + +
  • Array [
  • ]
    • requester object
    recipient object
    approvals object[]
    + +Approvals performed on an item during activity. + +
  • Array [
    • comments object[]
  • Array [
  • ]
    • owner object
  • ]
    • originalRequests object[]
    + +Original actions that triggered all individual source actions related to the account action. + +
  • Array [
    • attributeRequests object[]
    + +Attribute changes requested for account. + +
  • Array [
  • ]
    • source object
    + +Account's source. + +
  • ]
    • expansionItems object[]
    + +Controls that translated the attribute requests into actual provisioning actions on the source. + +
  • Array [
    • attributeRequests object[]
  • Array [
  • ]
    • source object
  • ]
    • accountRequests object[]
    + +Account data for each individual source action triggered by the original requests. + +
  • Array [
    • attributeRequests object[]
  • Array [
  • ]
    • provisioningTarget object
    result object
    source object
  • ]
    • source object
    + +Entitlement's source. + +
    segments object[]
    + +Segments with the role. + +
  • Array [
  • ]
    • attributes object
    + +Attributes involved in the event. + +
    manager objectnullable
    + +Identity's manager. + +
    identityProfile object
    + +Identity's identity profile. + +
    source object
    + +Identity's source. + +
    attributes object
    + +Map or dictionary of key/value pairs. + +
    processingDetails objectnullable
    + +Identity's processing details. + +
    "}}>"}}>
    accounts object[]
    + +List of accounts associated with the identity. + +
  • Array [
    • source object
    entitlementAttributes objectnullable
    + +Map or dictionary of key/value pairs. + +
  • ]
    • apps object[]
    + +List of applications the identity has access to. + +
  • Array [
    • source object
    account object
  • ]
    • access object[]
    + +List of access items assigned to the identity. + +
  • Array [
    • oneOf
    source object
    owner object
    source object
    owner object
  • ]
    • owns object[]
    + +Access items the identity owns. + +
  • Array [
    • sources object[]
  • Array [
  • ]
    • entitlements object[]
  • Array [
  • ]
    • accessProfiles object[]
  • Array [
  • ]
    • roles object[]
  • Array [
  • ]
    • apps object[]
  • Array [
  • ]
    • governanceGroups object[]
  • Array [
  • ]
  • ]
    • owner object
    + +Owner's identity. + +
    accessProfiles object[]
    + +Access profiles included with the role. + +
  • Array [
  • ]
    • segments object[]
    + +Segments with the role. + +
  • Array [
  • ]
    • entitlements object[]
    + +Entitlements included with the role. + +
  • Array [
  • ]
  • ]
Schema
    + +string + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/search-count.api.mdx b/docs/api/v3/search-count.api.mdx new file mode 100644 index 000000000..cc3997f52 --- /dev/null +++ b/docs/api/v3/search-count.api.mdx @@ -0,0 +1,179 @@ +--- +id: search-count +sidebar_label: Count Documents Satisfying a Query +hide_title: true +hide_table_of_contents: true +api: eJztPdt22ziSv4KjeUgnI8mSL3HsfdhRYqfHvbk4ttzdO3ZOByIhiR2K1BCkZbWPz9nf2N/bL9m6ACQoUrLiOD0zPdozm5ZJsFAo1B0o4LaRypFuHF42zpVMvHHjY7PhK+0lwTQN4qhx2DhVyTBOJlpIoamJmAXpGP6aJvF14Ctf/D1TyVzIyBeJSrMk0iIdK+HFWZSKeAgPdRamWgQRPf+51Y9TGbZe0fuxkr5K2o1mI56qRGKfJz70yl1RG3inlZclQToHPG8bF1olr+IoVTdpL0vHiLueHvIHhwnAa3y8g1EkCvDS6cvYh89uGx5+AcDgp5xOw8CjvrZ+1TjI24b2xmoi8Vc6nypAIB78qjzsG4YJmKWB0vg2iPzA459lMvVhaJGcKI1DxnEeh1KngWdoZr5DIszGATxIY0POtjgZiiiOlJCJyonaRBiRkGGYfzoL4I+BMp8pH4kGNFBJJMOj2KvB6Q20jMQkBrhyEGepWEBmrBKFULIkhNbjNJ3qw60tP/ayCZCKCNTWMgincRClbS+ebGkp9dZYhdMtBmX+Iwehag0DFfq6PU4nYeOuaekok0TOoY8gVZMaFI+jbAIcMgUmgS6DaMS8kyUJ/BnOhc6m0zhJgcsM0u2rqOf7AX4uQ3EtQ5hkMZFzpIz0fWpIMIYZ8KIiZsWhRzFMBo3WIKbTBLpDGgIKyETSA/AaJmAYhDDDTXyA/Ce9NLgOiAGwcRqkoUL60J/X5gfMGb7hRknMAJ6hNKkbOZmG2GOpDYGBhyeRr26QXnm7S7fhR3hD8tUnrOu4DseDTMdiCHyVadUW4uVc+GooQfSIl8Sn897Jm9P3J+/6n2xT/DDQ2B74jdkSpSaAyeBPqN0nwbKAoIHIADSICjIbMRMDkDOYmz5173x9pEMAkIhP2FsPxf2DC1QvwGmKeZyJSaaRWVN6Q2hC35+Ozt8wqP5/nx73/nrcO/okcI4SHyYynH87zoCO4a+cfvC7f/wz/cciwmqTqA0A3JbF9LtP7ex/yKfWzvOPKtEB6yQQ/vdDUnnVSTcSUmiZ5Fol4po/rhtLgd1ee7uEF/9tMTIALRp3zdsaUIvYmH6t6mP24glGnhgDk9kmQNIBYErKbCKnOLFpGUJZcYLtcWAyDpqMjWWggUK1gUzcbtzl8lKnysuIE+3FVCagtUGLshwgPmAqoJ8MOF5GC9iURlYxDnnHVQrxh5m2Gq4M9pJxOafRCfrj43dWH89ms7bi5qCDt0YZqIctFW0pF8RWooagzSNPbcF8blF3LV+HLf7FdOM/SEP/yX3+VOg56LkbMUziCaHH+ADfC7QwEQrPAPADW3CKtoCsF2tm8Q6k1jgBQIZaMcpZDQ3koXyGzM7Wop5Y/M6Zdmv6yHLTJIGCe82tjMUkvWE8Ex1gf2ImSR2C7OP/W8VggVv728wVwUR+ttNjdSkyw4S9BWAv6BO40QyHNZUHLGIVngN5qrxgCADGMmXEZEQ/EstBQ3HVkM+uGkapFgOD50ilq0YTfg2DRKfvzJ/I89jNVUMDINBY3A6w6pP+1FPgW8W0CiIvzIAo6D9Y/2siU29sB2h6Z2yGYOaMdoxpLImyo2kL0Kr8+wmI3TVwgBwEIfhiYAimwBng77BWtU4Fi2PupCzQLBgSPdDV4SbY+MqxeDhSS1ikypzJZgTFaIsSZRi7phhkTGsw2qEfPUlpXsotLX8wMED8ylh9Yc0+0fMMZcn2lROWXcRcIeFzha6BEmGgU/L7DH3CgnqN5Y5QWUzKHgBOLdn+NJiov4FzuMT0w1vxG/qOFTaS0VwkMhpZXk5AXaT8yocf9whqbwLS7MmtV+AUyFGM2AVRpJK/Bmk9JvZtSUPm8QBQDXoHRQIIILHcsMDSk2UGsY9YoyB2Dpa5Fjcuio90Yo1r2nz8An1c0uf/7mrZ0SeHV1dXjR6z9RFQ2UvjZI7PCpe+NvIppsx4oNbZIsYQ4wBmmofJ6sr94NLgin7Qw+lrPKIthkzUfCroNalkKWxcgxqW2hiFAIhK8AEhGMqbtMtKC1SRUVBz0ktjeZ2PwH7CjMzapClM6KBZa4NY3jMD/F3j7s4NDIy8uQ+JAXJfEXzrr+du4KaHE32/3e0UXG2IzlxbJ7r5gG8bZI3wB6m6w8av8Thq+zE4wjRe4O8P386NQ/AVX87VKwBoglGa8VIqmoXfV2j/E8QiGkMUCIkTiBuJ99AHsA6BREQBjyyUqPVoYmI3qEcuaj/QaLCfGXifxSCJZxGAuoFPd7q73b0DdPH3yaKs43jFi3mGh6DjB3oayjmaXpx6eBzPlXpH/r8Jkjm/g1gRO/SiGm19gn4FWiymJPwvVBJNSKRsvEGzwUEj4O14M65V4bH9hxAk6rNAo2CDe1TzsTPiQQxoysgNoIYyhG+LkdLfMATMMMkgqiHtwhAKlFGZQKdhTP4l2uwZ5mTWQ95xOQ32I8wuoYuT9/BlIwFpUa626edSaJR/Eb9/I7lEcyCxk7J0ss0oYyCmlcQkuRLx1Mb+RJAIZawgCoDwzfsFJQ+v2Bf9IQbD4CYtASLZr9yBxjZtaNQvPhms880AP1riwdBMfpELUyEWS2EdncV0nEiN2UU1DG4YKWOOV5ol0Gef82BthcpAVzpPa5p5KXI3jKPJdq7riGC3bGKXZ77qHcUV5hX1zM3xzVRGmGxYlsXlDAXoFp0NgVwmGYaMSkKVR6MKAXFeCQLSq+gkGgJfRZ75wNBBwoNyYsQGcqYjyzbsLIO+vYp+lGFg2fRQdJGq3U6n4wwSulQj0qPUR8qPdlDNT4IomGDiqkvDNb/hc0fyux2HPN0OEEYHvy2hMsAQclJk8z0ycmnhZhA9GPsvx9BBqYwTIQWe7BIPB31cQIQniuMxJp/FcHUSDCGWWQT+Nj2+nP+IlF/C76EcsRrnRKihBKKDvTXRITdLHwnP4Ffq4LLapUCMYnt2mlcZG7Al5NUaMbH5MoomcmqZObRMqMcYPSN3m27uMYaI7iL2xjs9I5CvgxCE5n5z0QvDeObmfCxG7IwMCQzHO8aZQl0n83CycF3y3Efkb5GC5z/zIIoBF457NY9nICzRD6UezZqP022ez6728uBMQLPkTH2kFg9AcS1SPARJnUrvcwoeLyK3GK6U+ABeytEoUSNaXapX7fetCRVZFuaUUEajTI6UCcEK8NquamC6yZpFa548GaIbTu1QVkdJnE0puQzGrCwVoJG/bm3hKvqC1YXSUgK/LNQU/23p21sgZZm6+o+wlmAn10nzL05znuR4pKWGRdBFkEjLCy6Fl0bgLoyaaHwhEnfmUX9dhokftlwcvyAqv1sY3r1j+7//+V9twxTPypzOUORYlxdShV5PSeZYsRtxJLcH11xzPl29Dh/l1m+1WXHcRHdK6qN+o2vrk4mcp1i27G/ZdaEvm5i1xrRsHVY7rYG/Oudm132dbothfVGqiV0JhwnJU1bwrbcehZ15BWOCgbk7TF1yf+tpviT8WY/ojOq6RAdHvfYzRB60RzwJ0tRswDCfkKfhtMqXo4pNLti4SAXa+L1sRVZn3HkdAg284LTI0slff89EzQgR5DfcRPHq/QUtcF+8O/lwcfyL/bP34/do4y7ewr9vj49Oeu/wxwn92/u5bPIWPi1IZJ9Ytn1Lo7OG794YNV1gVJjrXPkAw5KRP+UAOU+tMJtR+uDJX54gX+XqFma/LHX1Rj7H/i8seCa4vVscxoL0Ddd1m6Py2iZ+VQT/MqiVQ9cgLdGBTM1mg3jjoXJp0HkMZXjs7rt5BMlYQO13kIz+8dnbMqPTE3eQ5oFlDN6Rx47zGlxuvRhm9tisnjrzQEmKb8rjhsVTg+z18jCaXmFfBrd6R9OZ/3f9k/6b47fw35LwMHUWhGeQeZ9Vup7p4raICbkqdeJS9QcHq8XmgeJiUHkMcTmxy1VvYuOWPYbQLCD4OwnNeVVqzitic+7IzUtCc327ENuBkRH4GvFYLRwpPBtkuPbu4V7WpUm3t5y0cxKRjJ+bZlgv0baQTpsE0VHssXdR7ZWTck6vhT8jLYVMeggXQL8Qg21XanmGSlJ7VxvVajdoXBIK6GzgQqoMrOeyaznmKPupVg6nksLhKre3NwHKJkDZBCibAGUToGwClE2AsglQNgHKJkDZBCibAOVLA5RN6LAJHTahwyZ02IQOm9BhEzpsQodN6LAJHTahw79d6FAxeI+4UnF3h4eg5Oo2G7DGdbo4d7dtLba/p/GqrdmlIiK765I3SFf9RnGhlfgz7r9slQunzZ5qn2oQg5IK/YoqpD8HPm2fZSx6Q+OHlAdxYXDmghoH6VkQ+fFMmBIeowvyIh27/TAveSFHxZYG4xdUQmA+s+6KNdlEM9Od3ZDJO9nxIAwLOyjKaLj6gNqXdxOGAXj5CL/b+a98uz5umx4Hw1wF4jsznHykNC7cP0m71iGUSLE/hDCZcLFpXs8uw5mc63zPM0I8ObJjMsW/QeG+2YJkrrI0gyWOLtELvuAt/Ti8SKM6xc4g6nqSihFwuJ+ZWvzcjM3GQYhyAPiPAOVSRc8MT9Apqsxxe2dRZ14uRYdZwCZAJYdfzJECEA/JUMdcw+9s9D45ahJM05+4vHKZjQv4A/+q8RFr6E8cDshrSYFkddEUUn3bO+i+6LzY2d/zX6gXHdnp7u+p7vDFC7m3v7e93c2LSAiiizR8jLVG40gcxYRFimSwRaCy3BihABY0SJ3KJCW1P7P4yCH5VsR5BmniRIswCZDxdwhGGMefgQE/EzUcJK4a9w0I6PRACbfdQPv7OjEFkOhWLa2ADFNTMezU09M0S3JATRlCYT7rdtQWYctpuWx0Zd7nkfz+b+y2HP98ct5Hl+Ss9+7740az8GMKd8C+Knuy1muhYwnW82D5BAPQK2YE5WKQauVGGM/qNDqColdiQMWhtmQIod93xMCSKPFe/9/t44kGfebzMVor/ahuXuCjg+sa8EVxT8DgLVgU+4ozvTC8tWtZXW8G6YVIAZctoyy92lD2YZR1npyRXFD1e211OSVGqW64KgbrKc6FeBad5V88TsgVNUVr0MZoGluEVJMFfAhFihIhtyLhbtErdRoUJbIt96AUnU0mEstmTREyBTh928CJ3fPT/MpnrjlHSJkfDS9RWKJ9KC63O9vbrc5eq3vQ7x4cbj8/7Oy0d/a6fxP996A9Z2TFclzyg1TexPqXHkwv4nxH/+fKgimbs0fN0LC2O7vVmXhH2S88yBD85cApKy8OYptJjRUYmKwYZiGdipNyUbkG/PLPmYXyMsAi/iYMcCb5aEbCpXRm4xLGxAbWgSGeQhiVYxVtOOVO8h5RY7fTqUJ+BeYXK5OShCKEsxzdYWnMePgcy+k1Vs5iz4903qOvUhmEr2Jf1UlTGdnXQaRaI0xMAoaKUPbgQ3NCFVpuOoqRQVotRu3aJckESrS74qX0Ybw8vldmMCgLifTwmKoT/36ELqLg75iJMp+AD5fXONV0q/aVHDzvHGzvDp/vSrn9Yhe8p8HBUO7sdA72Dg544URrrLRz+rYqp9z19ypCxqejDcLgNyrLlUB7dqWw8xottWQOCMYa9Gcrj23zYRp86cCPJvi2L1+dit39oqgslaMFIkStC3RuoiykEsNcNhnw+ySASKNWsdpqvuPXvYs3mMo/O/5wcXwOvxDWx5rktpHfmBISY4zEigGQFIO28OjcsWcG6jMYkDTnq5qGgSlAnmsgpj3xEb4wvdd84YJ2S0GZ1Tw+WVV8F7RVuwk6QqfmvICB1EUe4hmu6UzT1htDyWfmJNenbfGVfqdT65iTsjwbhUF4404KGc6b9H4+6XlpJkM+BMaVwpxb8qOLWL/6hnJl7PqLOnfOR4VCyxBLwBNMXJD6xXMgrNoNkPYTiCRNu1xjuXaO1N1bRuYojemdJzO9htydhqB+WjS0/MW1MsJHjoM9L89ZWjEaydRH0sf54b6GFlbwhV082cjuRnY3sruO7C6+PDM+lnlLrk+3JgsZyQzom5DxrLg+uT9nG3HWmCeyiflU4yL98FMfBPuzojVhdTMNTMDwSP4Rm/Lqnvt8Pvj5wOYtrOkv5gIRJDryCIagidDPxscFxrnPvNvZqfb2Ok4GATBoVOMigtZM8jxfkvF5QFI3hR8rjXlFOszNnAJJGjCgkLKVx5QbT3LjSW6s0cYa/TGs0caT3MjuRnb/NWV3pSdZTooaP6nIhAKn2YVKPKhaQIPiaOtc5Jzce+GtIDCR+1iNsufQGGx3B93hvqd2fbnrP985GG57z7fl3n53vzvY3d5vuLb+spDjXMjKMuXMN8+j2f9FZxJlEWYk0zj2y+m/DNfKh6jWaKXZ+s1Aczqzx/qO2wc1ucs4Fm9xbdp4SLrkQ0YFjVCnQdsJHaxt2+IatxiBXoxwq0YQ8wIInsrdEgmuU9NiPAovjgLgJvMWL5qyoCzmXe1KgyZNEMZ8PuxMBni85xB9PoDAW3ZBOz+id2qm6Ks8eXGGI35D2w+ObzylUNBzz32vLr97EvH9NeKcJ3hJopejHTxqP4KAgHVW7ndu/PONf76x8Rsb/8ew8Rv/fCO7G9n915TdL/DPjTe03D+HBmv759C23RG5L/Wa9lv83m46iYrBgNhbxB7tUvMLH5xL78YxIjSNNSkRiVc4Nux9gl5+4yP6g4xK+XrCW5ghmJm7tpwGbbsrMYpndD/h9U6NvuF9s8groLH8jLYTi97piYkq2kTXJEDWNZc7YAdMZbszP78GcSV8W/FAVxYxGD5YntmIHuOFUhBDPNFm9yBSpTJGGNtFEt7dN54fd1aNg4EsGUcd+Vb2Be0FYLkwPLNv3F7QeY7ONvdeuaazMCAYoG1XOnuPzbbFS2AE2gKMaxbf/fBT/6kYoYtJIs7bWFVA+4ilOAUWIRXWs/l7/IisShJnIz7zv1daIUGREcMQBiyuonOlxKWtJ3kHuv0MlDGRFD9SJP/4VXEmq6+uVYhmb+FizMCPtoBCW7L03VMycRQLBBHXDwRUiNEyl+tgGQC1MUPkM60vp3Zc0hnXQ5H4k4XWYmgtgqafLmDBpL30eMeNB3KLIGSoiVoP7pzhtRx4GDjBE4S6iANSwuBRXtfy7Kw9GI8SvBbCK+NxFf3ER0WXPhOsrmxtyInwxnGs1X8KgayDYnBJx/I+GC06n7pFEtHa7jgotbjLVtACb5Dwq9zmOubN+0OwgCySn2hmQeY/0cbuT6Ux0+NL3GKf0UVH+sE4Y4ct7LDFOkAb/NkmIWOBbOMYSA8wA7wq5p80gUHU0XkMq1arE/gt+ob2lAGqXFg/PeQ/Dt2D/dn40AtsnbcBFdywZXyUJsI97wyLzj12iWXTAIsUrOIbxmAPF+jG+OZpKLSR/2zjxRH3imzJ+yicP7aWXqJJ/nn07j9I4200zR9R0xj3FrOOZ8XN48fFhWer9xr3WejcO4LL1wGbo/UrG5PtlarFxV729sjafcj2QsfyfY4W2FoXARabzYvTNtzr6Fbc7NZcuNiN97mvdXOZO771bxZzLxYz+8+La7pMzgBHU77YypKDrj/Kq2xLtxOVLyeypKjcL4T37HAhLF1vw0WTdNfMwlUzBpeFu104jq69TaW4o6T+jhD3ipCFCzpqruAw90rUXh5hOK967cFd9bKA4ugaM/mBX+UX9/wV06x6Qkj+lT0Zw85C+awJ9zQJA6t0nEIOxpw/YKG41fx5WF2uxHdr7Q3omtLzUgfnbg8LJdElRihVK29jQWrljKANKTek/MeSkgwaq6zaOuqFMuovrMR0CzHvSPUNYzIK9v5Txz3kPEd11Ysv3oZ/4a05QQAgSi8tbvxzwcAAUr6aDrxhbxwoypdPlUwxZ9JEjyyekAc7TWKcCbxECwGNqPonAVMv7fXXbfET1oh5YBMwGYk7DAHqr7HJShZ38h5ZlwdYaDLJIpwoQCKbYL31fX4RUN3L2H0HuxUpOzJzXa39yvqy6HAhKagQC43r+yEurILf4bg/9/QF3o82q6pASIfNioGcqTDns3Li6j7Y4HO1xiqcIh9D7KEirZwe3p70KxABWGQMb5yMtsxHegvb4jEsuZXaaXfaHXyEicWJjBy4xNHAmPbIh3PAXtsLxD6Yg7tKrHVbrCo3Tiv3TJprxPOVk+JaP3vhNbJAfn6Wey8kPC8VU5mEvFM5hx7S1hQXd6jskhN4nCW9NAJH02P8mzGmUeHN7S1m/jFpeOcUsF1+LHKC+NedLeuixOpnNSfq0Ehb/bLWqaylY5qSv+BVhZVtPzqZ3tP3uL7SwCIt8g85aZ3IGfpq8O9h46pBfmU8zR0Jen7bsEtA6EZqPqWCI/W6QNX8wGHe3f0/G3vFjA== +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +
    textQuery object
    + +Query parameters used to construct an Elasticsearch text query object. + +
    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`"} schema={{"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}}>= 1`"} schema={{"description":"The max amount of records the search will return.","type":"integer","format":"int32","minimum":1,"default":100,"example":100}}>
    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* Filter
    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. + +
+ +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/search-get.api.mdx b/docs/api/v3/search-get.api.mdx new file mode 100644 index 000000000..c58cacc0c --- /dev/null +++ b/docs/api/v3/search-get.api.mdx @@ -0,0 +1,199 @@ +--- +id: search-get +sidebar_label: Get a Document by ID +hide_title: true +hide_table_of_contents: true +api: eJztfWtz2ziy6F9h6XyYmRxL5ksv151zV2MrWe9xbB9bnqm9TioLkZDFiUTqkJQTb8r//XY3QBJ8SKIcz06c5dbURiYJoNHoNxqNL62Y3UWto9vWNWehM2+9P2i5PHJCbxV7gd86ar3msTPnkca0yPPvFlxzA2e95H6szcJgqcVzrkUr7ngzj7ua57v884G2xk8Lr9Jmpyed1kErWPGQ4RCnLgwS0eBveAxvIu6sQy9+AKC+tG4iHh4Hfsw/x6N1PEdAo9WR+Pwo5MxtvX8EkFcsZEse8zCiVh4CvmLw/UHLhxfwF0HWKk5uAiDSGzGZT3PPmWtxoM1w0hsm0Hnnv/OxIYAZwt+LBy1ar1ZBGCcI0HBMwFjIj7RXzHF4FK3CYOYtePTqgJ4Eaz9mTuzde7EnHkJHXrzgOID4+z755bn0TnzHfFd7FQbYE8CB2ILFWbLW0ZdW/LDCiUZxCMhvPR60Qv6/ay/kgN84XPODFv/MlqsFfiMhiOCramS5JUydnmjBjDCC3fIoVjHyVDhMZ2gM9EG3N3C65tDp6Qb8clhvNtQdwzKsFq5tyKNV4Ec8ws5NXcd/yqtYDZWDpOPH2IStVgvPIZI7/D3Cdl8UoF0PO1x6PouDEB/AggGFxg/nAiMfaFYHrSV0g9PCDtWFLQP1NgiBRAKcaYzgrWAeAAoBgKhkviZ60GQXHU2DAdhicTEjIs5+SYwG09+5gxwiYfMESmCxSljfC8lVTLH2PcCnpq76jAO1O4BgAUcHl1bQy7bR/xbMfe0k4JWjzNdLQAOyMZuCZMHeto0HAxKTQOur5DWR8HYE5cYtw5oHayTWxIv58odIU951ctNC6JkL9KIhMyIqHJhGzCvXosBJ1xftAayC5sL37dhbysmGJDMDmj09/TTnPv0l5qV9YpEmR0Fg/PVigWhL2GoWhEsGpN5K+82TgW4M2nqvbXYnpn5kmkfmoGPo9v9D2JeBSzLuDwZ+waJYS8Z65ilED0grzzOB7BXNQpkB8MQaKBK+m4JqoCFB5MOfQiNhSzZlEddgJqAFUbkILSJejy5PgctRe3iRMoozZ/4dKgz/gf6GFiA7PHygrVf4XQKZAOUgUVShd3cHOg91M8AyDwPf+6cQMKQ+AEicFYqdpIMCnB0CBkdbsgeaUwDju3xBf8WfuFzEf4i5/kOsLSqh8kILSF3qm4B34jXIsAeN3TOPlrkKG89ABZaVUgH3sSOVDKYB8Cfzy3Tgu6gNAOswAUQ4QcYy7scpZBpedtyhfmZsvQD4ZmwRqeoMoZfqDjSRmNEzwOEAFUwVBZeDoaBR8yAcB0uyJ65SBfwEcBzZCZozWqLKib7lKBHSlgQYYUegt+KJ/gYog08+DxWYUvGdB+kCPwNZLO2gh05JwIv2uzg/6edkcqHhlyTQ/fUSbcrTk/H55HTydzR/M0pLnwKw1Vp2O6TS1C2qYmb3Zoy5nNugimdTmwNBO6bes4bbVGr1UGC3rJBZsVV+rGthkxJXLIEB6/dJn+c7cxbB2m1LM/cvEbxfBSD3OkAcoJbhf+8z1fwLyBWhRSt1c2YN3go7kyZ8IC2s9/Wsm0qdLe0omEE13gdml/Ucg7mObnRZ33CGumnN9IExqI/30lBlxB8jrrSxsH0/JLS5o5vUOyLKTFQEkmdmOgr2qvI6cq0jcAxGruvhUGyh3bMFcGki35nrksqirmbreA1M/cmL58E61vwg9hyaTMmck2ySN3kPWnlP5iF7gr/u7kJ+R9qIekjdG/zrXvybMAqSBZpR7wtOijIYqvhgHTp8t8AoIVc0LMuNOrR1TW0raGo2GyDpGN1+t+/as6mOvwaDmeUOXV0fzOrTVDpEmZbG8G/wwAHcx8fHHBYVwddiYcgeSt2OlY9VpSLxos1ZlIrtAIdFwR1VoTePNWh3ycOlF0UwTvRkFafMhUBZZX3W0h57WfUKLrZZ9YJ1uX/n+Zwn7iuLoc/pOq6xksowWtqscmGXfDnl4QVRCXHovnOgRgXoz39OZU8ygYOT459TcY1/HF+8JV7a4K5vH1S0yo96FwbrFXa5CkEILPjdV5hfKk14SKlJj7Uoog475+ezQU/YyMmG2e0Knh7qPXtmWdPBHvo5P06Fkqi9Vo95zap03CqIhGOSvBlo0AvgLizBdr5G2kNHW5UnOfi6OCoFBncImQl8BEvHkIfvOWgYcAYo0iK8pMxnqRIwWYgoHfi2NRm9+WDAx/iv2VLsChyqlTc1hKS/FALtRCpB4tmCYqpSwPjBSNFcG8Mtz2KxlIjM6nfdAQdrUDf6XW7MBgMGxGaaZr24yu/B3O+4Ad9iZIxz1kMSka1lP3wfFoTyMqGYhEgmCF+RtxQK2qUEEeA6igfHoWgffY9KDr3bDIHJxAX3xTwEhAMY5bhV6wycZl9bYlSRTRHZElFpF8kYtIbQ3ToEm781j+NVdHR4mCwxobOTs+API8aiwzlfrA6FZy7/QQ+2PfP4wo0683i5+A/xGKbZlmO3k7Hb6PTnGLl1mjhBV3wGFDjvNEGyPz9IBjK9lpMjVvWHNAKiUcuCCpOxbRd7DkLvzqsVXk27Fk2qZpiOgS8E2PG6QnHUgxuaVgOe7E1gVIXiEE3E/Zki7psCMhmQJ3zhLT3UPa+FIqgWm8JzA9BAzfjIDiX9j2JIOFBiOR1v5SU7Ps1yvvDljEPmfISxhMVaKzqTU4kgCJIuNJ/6yEuCnsGYqztDPjAsmztsMOT9HrO6XHfYlFvknYHYDsIa3jZ9hs71vYcG0vRBhLrFjD/N0eOWu4EIjaq8pce72TreJR8/gWUAn+4G8jf54Z8DJvgFMCw4azvhHCVfKgYTWDZA6hQRd9ehAC6znWrGLpJgdgUE+/VQw/Kb8yR2rmH6Qo7wKLondQ9pfbaOA4EfsSiwHvRsSVsq48k1WOtT7J5oGC0p0XUdrkBIVMmQNVVBGqWjja60ZAFwJDQzqgZ5LruktPiK2QRWcmpMyf4VWx4+m+AwqlxLIJd7H/Rui9X5DU1iu4X5TQGa7tw0Kvalq1hwzSioVkeIiG+T2SfiPAfla8/3ornwCTbNabueqOBlwqpwF9jiSu467lQiF7JBorxEmErumQMagXYxXQtUiLuGryTiko9DviBhKN21vCLcQ+PIhqf1trFojGJU8vj859EUdMI1LP/84OLm59E6Au1Mv5Y89BwW4e8TvgwohAiP8F/mLDn+S3t0Shi7NgJHSYs0QSFLssL9Xzm1PZBRc48tHbccN6Voc0QyaFVjRzNJMsRllKYEGRLJCPnOR667Rzz+V/yMYjvVvVmmbnWtfrfb61qG3u/l1VRhNQSJ7zWldSTiA8qOmYA/2ydrxPOLFs8bBISyo6nO5yIvIMXuwOcV83FP7bTAoNUcj5m2YbBIRSW0lVIQRWDKlmniB6U+iTwf4VLgUIlpjlI08BX34o+RmkgEGY1l0eMS9Q4Hxqw74Ayod2AajsWHlj0weY+8PIcBO21f4SuZ6FdPiBWNbpx4rrtoycIYVCWP20kKYR0R3Uja55C0jYj8TkSkCu1YFXb0RkqD+haPtMAohRFNHM6c+UYjUbElZRglsVFTCfnHiLybItlUST0kic5J0AiWb8CEy3p8iy5+xTY6Ek82U9S+n5gS/RL5FZmCnbDwjjdB7u9AflV44BsA3BiI3hCRVUG/BcvOh06DkOLU77Xbd76mfcH/07R3LSdw+bvWEfxa+yF3gjvf+yd3P3zkD9G71kHylfjzSLQVjwQvv2uJJ+/TT/E4EX2aPVryKGJ3cpgbZRgN+v0x+gmjT2LmR9oPot8fRMeP7/z32o9SpJ66R1qXD92eO+u2h1Nj2rb77hB+zYy261jMHAwtczjkPwk9X3PnEMlMfFsQqYkkz2FzxryFDHF4zke+QWbvCHM0Vsh3xMWPpTdla7MGGYru0K+6Dxb3apZIfl8rr6UUTyKGIQ805oV0/KB9bx9oSR7GefCpeg7JrrmaP6Um21TkFamZOE3eVJM3VT9v6ntIomlOmr3Mk2a4lymOy5w/IYd380mbEZ4D3eeAQiGp+itOJwidzTf0V5Kd0x4f8t5sOgC7gHPHYOa0N+tPu3scVjhR0FBv7IuT6/Zfr9qFowwRv6t3jOFafkjCUpgLILD2cKx36ZWprg8BMVZ72u25bdsAa3LQt7ptZ9q1TM70KSiaTVDBlFPrqaaRNMEtf9l8S7d5citK3KS9gsn9s7+jjZhNpSN0Ypkq+MYzHXAsZPorXdZK9afzaG+Ce4622XMBQZ1qd7LXenC84HzWb+C8hjAz9qfcrCQGgBOIowfpUaYiZNsJ2noZJx0UlZGz0++rLfT7xjZvbPN9bfOXLMwao/zlGuV1z9KcKyEjMUGGJRIyY0nwMFsDl6OMADlQyPwXMG7LTaqQo/JINkWhEI+34ilyW/T+xyedr6EqUeJMDU2kTTLqJ5FVoy28iJKseDp6lODcC7UlqGfM4S2c9v/79WT89sPxxfnr0zcSqUGN3FAVp9REqLg77uNmhNz5J0AK4z1EtMmGyjPZiqg/kmhzoFERCZmxf5Bb2kIGFANB2Bm5bBnJYyzOx3pBXeoMHRNsku80Xj0pxzwLk1KQOl2owoL0rNlgaHAdPImZ7TiD6cwY9gaGbTOD921bp5oSK9BIIRZK2D0XwhjweSQKE51eotLCtvlhu2YH/hv2O4Mu+bs8Bkqs0b90JO+TA9LULN9135r2uu5syl1jYJtdG2tW9G3LZMbAGdhTPbfRWOmXbdgjLMc7UxJgqca+VFRVIZ7+pbUKqIhcfKdbbRC7LIrRrgrCO7TmHFIjwjOV1byuYXaXyJ5iz47gq5FQKL5T5A+IuTnYgNwX2mOL5ZeLF9xM/oqFRY5Hk9OLc7ltKPf+9tgQJfYRsvNAyZOXyfEbOOlq/D834+tJa4+9ESHu5EGqkhi8pufPJwkj2V+1MEze7pSHl6Pr6/EJ8Td35j74LouaQR/JAj7aIgvanyIXXCOlXXiqscUn9hABqItF8ElQxgp4ABxIhPkHSVkf0uX9ICbwQ2cLQXyQa/QhmUPeEbgvuACpQViylU8zU7FxBBpHQHUEmv3G56otuD2gXID1fzoEbp6jZUT1DxlVNZxKKl8SUDnYCJ6YF0ZxPYGpdEOtqopdIBTYLW7L7N0r7eVURd2lNVizupXS4yr0lix8EIWuqu0oBXFZuSuXL4OOTKd/yc7yd7AJt5oH/n5kRC0qT4H+p6GBQd7umv221eubTTjhZYcTPJ8U7tP3JtLyfR56JqKzWgFtENJgbcZfEVBXh057qzV2XWte4QiZ8ARoTP2hPGPcnF+N35xeT8ZXwpTmcguvtqucjZU0rWRAg5nMcm1xBpL57K5OWUilc9mmSsQ8dUvVq+y9ZPj0+u6M94Y27hFyUx9ws+/o3f5wj0pRSVxk14gjeOqyzlVAdRX328kubtruNRaaRl70trQuT6dsloyKsAT0Sbajk4OkuFV0mVXbrk0d6chJne2aVm51h1uqTFpTZ8Bcszcd9Hr20O7CP1Owga2ha8xmfXer77NzsLIB9NcrrbinXjP/QJUBX5184FV19q/IPNgxcHXawT4BqrdshSEWoGbyFcFghFE/8odD8hnB0Qdzd48gFXl+4QPK1euWNLFlvX1hIMtt7WspyQviV+gXdDABOfjNnuZP2pbkPq9Tdydrc5LFEeuMoMQPi2PscGy+/VoDW6ooKcWvfO1SoENkeMO6b97lTpvppY3qJNg9CZmzY8j/Qx9SvRP+X6RJRcL1jlbyq//KecCXpYXPDtPsjpOeyZBd0kBjURQ4HplzaaqJWs05jZk2YYlnCks8w6lz9fxQk6j+vSSqk+H41TXyiWA8ihvtLouf2HCLwPn4PMOKnmq6ZF+d5KQMvGeCE9AR+azHQSjLSXw1EFgpmVKPkr41J+2c6vD7Ocm6Gz8gmz8FoXvGovi6ehv3m9K9SqB8tNWUK0L9h5p2y8DFDR7ccBfv6GqY1OQJ11H8YcHvORbktHeVJPrGw4dVtf7JtFEO3O6f0VfbVtieycdWqz3sk+xGqCjvo24ujd7ov2fSf5t91QaROUSme4ZPRFUZrjTap6T5pBipQq4lo1xDinIZM8sdOG7PtYcKeHVLdbDU3FRGz1UhzO/DnP9MzrFGWzH1ix/l9mzSKkiFm0pGq5WQWqvVZolVEjgbRVh9cZLOzxQIzKcA7fSqkquBSFp6d36WgVzpVe26246GzV1tNzo+Hl9ff7i8unh9ejYue/2040CBvGi9pK20Ovfbtapvt2tE6ovei97oyMikCKCli5vzyYfji6ur8ZnIcJFpigdFQksfJCkwo0t49evoTLzBfvDX5eVZkjx10Doevb0cnb5Rf36AzibjK3wyvpqcvlY+Pru5lm8uzs/Hx5OLqw/Xx38dvx3BI7rs6Wz8dkyjvLn4dXx1Pjo/Hn94c3VxcwmP0vugsp8K6OmjJMfqoHV2+np8/Pfjs/GH68logh9hTs9vF1cnHy4vYA7Y09UFtb66oX+uL5RX1xc3V8f4dDJ6I/7/A8xk/Obi6u/05/V/w1jXN2c41NX48uJqkv2NHf16enGWzDxZhtHx5PRXMQeA47/F1N6XbHOf7h5KClIkaZuUigp/nEwuIiXDBg01uRmnnDYGo34WglsRrh3Mo8lHFxRUprQXByJxpQDMbo+keLI+7/5uuoiqsUeeZo80xT9fhuBuhfw+cDae0kt7pTsDN1+rci00PHaoCsiKhLzUM8+gaDT+CyScRuM3Gr/R+I0UShXJjiB6Kai89ca8DPRad+DlQgG/rB94iO7+G6oPVd/xp21U32WLfNbgxjlsVoeKmsNuiZdLupBKhTa6r9F9je5rdN+3qPsaH+5liKNtu/U7PLwtOkxUsqZzhz6Xy98EeP9daaxReY3K+zdQeY271wR4vy/B/ewB3iak+72SSqPjGx3f6PhGCjUh3Z0h3SaW2yi9Ruk1Su/FKL3GXXsZ4uiPjOUqbxM6TugnzTB+jhTnurnHKYq6+TM7zwCD0ltNGAz9URTQeobRsZu6w6aYl0v1fAsgA+57AAJCotb1d9ny5jLYsfkeJffLF97secvcv7uIynNNg8ivQWSOBxtUfg0qSfo1GPwaYqw+oNggsC4CxfUcDP4UAYMGmV+BzBm4DFPmfByt8HLRDdWdinEU5cZxNCoepXXx3OZlpf2RsytfwLUdiTGuFuylUq67UwaLxNsU6m0K9TbC7Ok+/fbAzEZHiKrhp+/yoSA6z4yVHsgtbKrC/ulVYZuyrS+0bOvXU4FlpVTA/a8ucJRwP10Ll6oq2fHWwjqUbPE8d+SpcDhABVOe3JNXgKEQS86DcBwsKYZwldoPTwDHkZ1oLBRAYE9E33IUungtqXGAlhsAXasAURq9LorvPEgX+JlSzLNcsXLTbk51PyeTC3Gvj2IVpJH9nPpOnz4e1KqwUYS0VFhNqGJm92aMuZzboIpnU5sDQTum3rP2KB2bDLX5atJrYVztUSY96ZM+z3dG1Snb0l77S+5ij1JpDVkYqN4Oxs4ITaV2ToOgnu8s1q5aMOiZbwgVKwZWE61Yvy9WbKZPe5at91nZrMlD+IRLQulKWU0icGfv2+8KzW0XlCNiT6rVVBP/2+8R/Tb9t+Zq2hd8Ne2OoPnG9MZnECJzFl3ycOlFERYAerLSV2ZAdYNWWZ+19Olefo6CgW1+zjFdjMv9O8/nPOGorRlBG4fR0maVNa1r5Q9tmwM1KkB//rOYwDibQC6tCP84vnhLrO/MQfHtO6holR+VLoerkWm1L0085ZrdfedTbbEM7G6/OzDMblc38NdQ79kzy5oO9rBY8uNU3BRTe60KUieXw1V3z7nWFvNTtJuVN4YwtpdFdbadu3obgH0N9hT0EvNaZ640rbUhMyAXR6qs+TvK4l2FcrHJmy19jHORsKS98nRb2/tCq/vt35+WQ2gVkdUNIdXqVVCW55o80dy1ymIhy8YpbW7LfPkCuluKxEKWS7jG7LKeYzDXAa5hfcMZ6qY10wfGIAnhJvJ1XMEv6ps0toTOb7+tm23TJufXODLB+bW7WGI1C+LgV8O23pVfWb0j3e5YholfJXES+MbUsSdjMNG7RxZ0pndsg4q1pl608C5zDm3uUdnBlJIode0IHbPZAGeNoqPvWj2mi1+2ybs93TJ4ho6sPmHivqSRXCX5Svoz270StXR1GQp7NhWibDCz3KGr64NZBoVycUDRrrjNr/BmuZitcF25ViSA5XqBFwMoyjbTkSnB7SE231eJRiOxxUvGcUGU5sk/LwGqiH9o97irO7blJtc+ALqG5mzqZqhRuu8wZgOT8LJN65fRcCe2/zIkbOioyBGG2daHE2N4BP919Y7RJWrPMdeAPupPdONI7x/Zg2qWGU50G1nGMjuw5FTfWM0b2wRPgSB33o+RIqp8oUU5eqLwh9p7d2AZ3e4QKRR+DbsD2+zzrm3aWe+408K1M17KDpfMnIQzJMn0Bttp5r5MLfdVdML1oQnQzNogF+22Pe0O24w5g7bZtW0Gzh6f2dMMyBsRB52w6KN2DUaXu15w7ZJFEXcLayjXqD8xeiAdj4xBxzL71euofjOgtU4upBaJqphle3JzNv5wc3kymoyTazlTmZS/elm5eVkC/ZYB4iKEOQE5bD2q9ybL7y7FFa6o2e89NPgxbJtsSaUxW06WQSHSm94T0RLXGpdvNW45velwMHWsIXe4PZjqqJl6rtFz+r2p0es5rdx1xICdfscYDDtGD1lkQAwprwApMaOS8lW+X1e5XveW8AktE4yi863cfNsSCG5ll1m1Mlznb3HdujJ0YZFyK2pGg4odUamre13H7vI+t0CSO3YPBJcNEqtnmhkJMrcjinvnLklsjRDI7HpDEcApiYTRiZa8SNTX9dnlpHN8dnFz0rkenZ5dXpyeTzqT8fXkP0cn7dHJ29Pzv7x5Cy86QjsU5JQOnGKiMOva8F/H0s2yEbDpK4UTNn4jr9lrdUEgDm2zDVoTaSG7Yk1KB+XmM/kkqrzF5qB0h1jrwrKHAx0lUXr1FxJY7s6pggxSjLGclOvpXWfg6ri5qfdmVrfvTE2wLHqKUjfH2uikwi5IukACgEa6JABjOB06ICgUAhj77iSA/4PFyS5VyPPCmrosUoqvUAoZLaN1PA9CD637ey77qgXJlmuCkIsXzOdxmy3xKuywzRYei9p4jXKC2I00iZ5R6LPF8bb+PwXhx8tqsngiTSPb+CrbPFZcdSRAr7iRSLzILqe5rcfSViVLK8Ws0ahKcIOnkqLFCpC6joOluH0bLCqMl43SJ6MTfLYIQEhtVPNPoq9U05BXxrUTsLJRxzxobfk7n10uuSW5byNl0ZJOr7qfIvm6eC/ENimx8VKG1FQF2Q/opIwt7TJYeM6DdoySLAg12nCIDuD1TYQ/duAVvjuBF56vvaF9pyc0pCXdq+EYGQMQGPEnNL6m6NATGmYT/GXtLbDo+e42NArwOt1GUb/t+8daqgV9bJWcLZCzbq+vO4nEZZbOdBDoO5lLebzJQwP+mA66U8Ep06Hu9IFTmCLMlRM7ioeYPTwOfJ8Y5V/AHkIKbWAE8bIOft8Xr9Awk5TRVKyZ/a6hmO0nl9pvIJHBcnS4JjBRS/Rwc9YDQWj2mOKlBiE40WhhFyVN4R6CsoCdMZv67etTrrscyaEsTn8JptpvILQDv34hf+YseVa//71arN/IauffFunSsqdOzwHi6VlgXQxcWzcBNGWuMe513OYiOG2ja/bNnm3o4HwM3pesN2yiCOPiAcC8xyo/fl4zIx9ReZLRukH5PxZZu9QrWFNdvd/tqi6jKmvKfRdfS8TlDyvmsCYY5XlxVsHYu6MpTxSj+TPJMgBfxKvLHZcxDBZxvdcFp8wcWoY+KJImGXkYswSy1C3L7gIKTNPaRZbyUGYlMdYiHxhM7+t9pmcAffIWiw5bTKsICJ8iUy8qhKwUZ9nZM6t679nYEJRSzmxtD1ElKbWZpydjv5VentzHZz25j2+CqBjq/b4SaDidaLKHQiB6IlL9ysEGgwIJwyNTPzK6Hd3W846YpOxtcVcZwd0Wd5X0u1/gdWe+SSEOXSfoCo7LkkUdDgse+H9BGd2OggULk6hrMaMjL5+3ZlKowiXJgMgIqUQ42WZ9MoY+M4yZyex23xliSGlmtZk5ddt92+wO9Bm3pq4yjmzf/vzwz9JqU4ae/CDbjIk0/BZBym9vG9vDxHtPekPaRxxgXl/4gAeXcVtAlW+CZIo70ZQPtnfg95E2qmxdL6d0Hy88xMg4DMF+b2tX8upBzUuydok8tWngyjvUgQ092qx0ArCkhQ2hXJdz+HskdqtL268bk3nR+TsO3Bpbjq89n7fvQjD8AUJOIDvQUITZXIyxLXHTTXSZJB7Td/mtScBEx9B+Ya52Jed3LCfzmIXb6tyCdCOyMpImmicS6TYMC5KZTXv60LRnPZsxc2Ab/e50OGOWpQ+74qJxeYfr7oyHN3jjkudopK28fwJCQIoB7gkAGrxVO9+B+qiBf0ySFt+m05TwajH/HB9oTPvl+FKz+9qC+Xdres7uCkjw23Rncj5J9PFAAnERendeZbpDktp3Mn49SqoNyBIH2FdV9QBPbMEHtBM8Dz4RxHICmP0b8QVFujraK9nrK5gQk3c+yQ898Vf0EGHyptyihxZy9IoWatfaLAyWOVYivvkcaz96Hd450Kb4DMwPZ65hAq+rBSKn9hXKiFXcPpOYfKXNOYic8KeO9pUnKbK1yFBZutpZ7qeeqYuCzAGQ18m5x0xhookcF6bUIkGU6wMwC8yVU/ITpBFKH8SxDie7K9MByQRz80CQS3GkkZhfYpxefJdKLDXNgMTdWwHMSRyIaxzZOqrBd5cLED9tmlr64p5L5iORLqQRrUayTFIiJfn02Fh+lS5XwvgaGBkLt+Hdhncb3q3Ju8WXVzxaAS8mb8n0Mcqmz43PRNQelWfJ9BEHNvxASz4SiTtiIQ/wxllpIv3ttwkw9kfu4/f88wrN92e0j4QqLwE/StdDPJ8mp/ES1a+c2AIACY9iBjOQRNw9IrgziFuZlWiVR3sdhFMPCNSvMBFxZ0J7CNbiPMHaF3ud0YHmBjzyf5DJvumdidAGRwXPXuR2NJZkY0k22qjRRt+NNmosyYZ3G959mby71ZLM5xJLO0nJIPY1+Z6yuzX4AAAX7bWU5dIotmqtYGdaamO18pZDa2oaU2PWd7jtMtvtWcOZ6fRM1u0bfWNqm5QYmer624yPUybL85Sy3mIdCcVgxN2DHbf2gbiiOAjcfPhvjUHTGYo1Ohya2M2Ac0CpEmG0y7bjeRDD3KBjsB3DDeHFm6szcWpbdI94o00fNLPlaW06N4YmJdIwYNqjbZDGdGxMx0b9NOrn+1A/jenY8G7Duy+Td/cyHe1dpqO9h+loa2hizdDE+jNNRxfsDjTNZrAoMAdZaqV48DFhe3FkIjX0clakOSxbkZMg0N4y/yExlqJcJNLP0IXiDb5d4rdpQRP4gGl3ICJ9PITtgXWLVIXVbsAmxSS5hbf0iI9xQtBv+NAezWKYleCZhN7SUeRJ0oiEwiIQpYY+MQ9L9MzQ/IMeKA56B4L6GWOccrW+Kh6sXeGMz3DG2vizwznyfBr/7VZlCZzKbHLtWqz1hnSBrMiRzz+vhPhKTdDGVG9M9UbdN+r++1D3jane8G7Duy+Td/cw1aU1tNlUhw9qm+rwbUfXUlvqNdV6+Vdb7MQqEgIiby1wyFZ3Mxuc7AogJQQIDzbjIZl4Dn8ciqPLh19gNfnnR/jXfWxh8ixahQKgdYhJxfM4XkVHh4dfYJ1gfR47bOV1kjOffvAJk4sP76tK1YrLqpFiQG65azq+jZUlpZvRIeyGHhKwkHY0gMC1rJ7TSmslbO0/qU77AB6IJro5wEKCkpjoMdZvAU8iLXDzSIcrCnOEud2Ei8dd8/nV2jYP0cmGeVShb+tY8L0GUBamJytaRxwWHDqi02xidDzHdiyEFR5lVdUIBvvLlb4v8DNT+wXoASsbUf7Lj3/7bfKTdoeGJjH6Gg93atxDzwBY5RJIhARZmv2MjUi3hMH6ThTkGeWybZBxtNkCJqy98685127Vq52uQCQTSrERJymArd7/mKyMy+/5ApVfJ1dL5NBz/UPA0CHLtfuJFB15BJ4vCgJh+ax3fnI0E1Ow6Rs5RXLwtNtVMi+mzOupQPxH0ltb9Nam3qKfClAI1N46InvbAe7FLtgiImw9eXDRX1vpD90neIK9FmEQJXEJjnyOlJOs2pPhyPXXxv7ycLzzf6OCuflmmhBaWgRKcOFqp5ozD4KI/19NQ9JBNri9WwMXPRksqtLbJo5om7oCUlsM2fbwnDbBdwaM4QtiYlPUyWSSBCI6Qiz5D1pZ4Pl/UP3df+TmTI9vQXXil27gRE+GGQds44BtIQMiCb+sAQHAAm/jHEgOCAI4ztafJIEEVJF5oq9KqU7dH1IbVA0OgCqqSqyOxB9HmYCTvzR6gV+n34AIRpM6zRqDvzXZF5W9VJGVBAOKGCzDuwhAKxbwJuBNtzRRU35r88UZj7KYyYW/eHhuKb1Bknw7cvdPkniNpPkeJY00cpHcaNhCITokcmGtlSN4EZVzx+oBl6fEqWRNM6wnnxQVVLtZLVhMpYCopvbc4+T7rzijY4AHmqxCAXwo62FwWSj1jg4lhgAwA2/NW2ChbO03LCDpAIrRscKcW+j190B6WFmttZNk4TQ8V7j2segQALFealh7d8fqul7krIUQcsSpewFQQGZc2irhSCQbRAXd0cHDZXQxwyCxRwVQao4FaxjJCDEgEldEHqLLJnKFp/bpDNxBwfze1TdQTnvOF1TAEyQoGFNcGeHt6aTUI3Tmy22JILw7lI2iQ/wWi5nC5AUxWB1w6OhgchDF4Icq/b7hMdiGSSFCbYq1w4vE9CWLibde8xiscar8D1gF7zK9QSUNKkQr7tARVI28rwO5APlXaTNR+FOqB7TrD1cYiUJo18LPED7dbUv4dPDxEfVLP1ys5zQPsNDMbevLF4xWoIvziI/BS0dX+PZ95sGI8pfFsgwbJ/tjcsz1J9pvoWHFPOU9CCC9EB8b5kbXyWDDqptnRGe4ClTh/kh7lbshJnp1QE+UO2I88VA98El/3ye/pNwR36EEfUWXp73qkESrRHESEvSV+lQt+PmRYxBB4JmqXD4FZ+olLvIOgQw3T4TIRecflpziTrSc4oWITClNSns36FGm0YI3Y2QntsE4kT+AdED8/n8ZPbhk +sidebar_class_name: "get api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Get a Document by ID

+ + + + + +Fetches a single document from the specified index, using the specified document ID. + +## Request + +

Path Parameters

+ +The requested document. + +
Schema
    oneOf
    owner object
    + +Owner's identity. + +
    source object
    + +Access profile's source. + +
    entitlements object[]
    + +Entitlements the access profile has access to. + +
  • Array [
  • ]
    • requester object
    recipient object
    approvals object[]
    + +Approvals performed on an item during activity. + +
  • Array [
    • comments object[]
  • Array [
  • ]
    • owner object
  • ]
    • originalRequests object[]
    + +Original actions that triggered all individual source actions related to the account action. + +
  • Array [
    • attributeRequests object[]
    + +Attribute changes requested for account. + +
  • Array [
  • ]
    • source object
    + +Account's source. + +
  • ]
    • expansionItems object[]
    + +Controls that translated the attribute requests into actual provisioning actions on the source. + +
  • Array [
    • attributeRequests object[]
  • Array [
  • ]
    • source object
  • ]
    • accountRequests object[]
    + +Account data for each individual source action triggered by the original requests. + +
  • Array [
    • attributeRequests object[]
  • Array [
  • ]
    • provisioningTarget object
    result object
    source object
  • ]
    • source object
    + +Entitlement's source. + +
    segments object[]
    + +Segments with the role. + +
  • Array [
  • ]
    • attributes object
    + +Attributes involved in the event. + +
    manager objectnullable
    + +Identity's manager. + +
    identityProfile object
    + +Identity's identity profile. + +
    source object
    + +Identity's source. + +
    attributes object
    + +Map or dictionary of key/value pairs. + +
    processingDetails objectnullable
    + +Identity's processing details. + +
    "}}>"}}>
    accounts object[]
    + +List of accounts associated with the identity. + +
  • Array [
    • source object
    entitlementAttributes objectnullable
    + +Map or dictionary of key/value pairs. + +
  • ]
    • apps object[]
    + +List of applications the identity has access to. + +
  • Array [
    • source object
    account object
  • ]
    • access object[]
    + +List of access items assigned to the identity. + +
  • Array [
    • oneOf
    source object
    owner object
    source object
    owner object
  • ]
    • owns object[]
    + +Access items the identity owns. + +
  • Array [
    • sources object[]
  • Array [
  • ]
    • entitlements object[]
  • Array [
  • ]
    • accessProfiles object[]
  • Array [
  • ]
    • roles object[]
  • Array [
  • ]
    • apps object[]
  • Array [
  • ]
    • governanceGroups object[]
  • Array [
  • ]
  • ]
    • owner object
    + +Owner's identity. + +
    accessProfiles object[]
    + +Access profiles included with the role. + +
  • Array [
  • ]
    • segments object[]
    + +Segments with the role. + +
  • Array [
  • ]
    • entitlements object[]
    + +Entitlements included with the role. + +
  • Array [
  • ]
 AccessProfile Entitlement Event Identity Role
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/search-post.api.mdx b/docs/api/v3/search-post.api.mdx new file mode 100644 index 000000000..b75dcfae0 --- /dev/null +++ b/docs/api/v3/search-post.api.mdx @@ -0,0 +1,283 @@ +--- +id: search-post +sidebar_label: Perform Search +hide_title: true +hide_table_of_contents: true +api: eJztfety48bR6KugmB+2FZEC76TO8XfMlei18mklWaLsJKut9RAYSsiCAAOQ0iouVX2vcV7vPMnp7rlgcCEJarWO10FV4qWAwUxPT0/fprvn19qS3ca1w7e1K84i5672br/m8tiJvMXSC4PaYe2CR7MwmscWs2JqYj14yztrecetRRTeey53rX+uePRoscC1Ir5cRQE2nrOlc+cFt/AoXvlLywl9nzvYacN69Wi5fMbg8b71GK4shwXWgt1y+uyjN1/NrXBmNe1927bVqLKbiDth5MYNy5qE4psFi5eqrXyb9LqKuexgNFvyCL8AmODrSz6DP5eh9fYCH7ElgipwYP0I0/F4/O7ru+VyER8eHLj8nvvhgkeNmHn+IvSCZcMJ5weeGxywhXcQL2HuLHLrySTrCxaxOYcx4z8t9Ah1AUv9n2KEbyxArTUPI255AWKZ4acWm4arpXUXPiB83nzh8zkPloXzqO3X+Ed4EDD/OHRgIX/NLN8pfBSIIUS3opcGfLiKfGig5xg6KxyGQMjMM2YsPrjj/uJAfH3gBS7/2Lhbzv3a034NMUOfnbjQoWhyEcZLGCPmzirylo9AYb/WrmMeHYXBEiAerZZ3SHXx4lC0P4w4c2vvnoD+EszRVx5OgygM+gvgDfwZzmYxx/7Tkz2nx4BLwBsS6Gzl+4pw4EXDuo5XzPcfrXjBHW/mAekSMe/53txb7iG65Vpx+D4KV7eC0EUXceMmuOLcevtT2xpdnFhXctWtI73q1oWG/aWop5hGcP0i/s+VF3HA+Yz5MUdKYEgstUMbEO/c8TlDelg+LhBlMCq/5RF8JzoRj9oteDD3Atxz9J3cl/D76Wm/GPmErBzu37CPVrCaT4E4Ye9KjCFGBUv4YnDXBD7yCfiT/Ev3o/FJf6/FqROugjxOT2bW3jJa8T3LWwKlAjEvwsXKF+TJrb2/1ifhkvn1I/x6D5G+CAPgeHewl2AdNKMuWJc7Bj2GK9+1plwuEewGb6b3AnLzPbHP9qwHjii8DQCTLqwkrKUXOPgdTCMm1slgqQEUiyZCrPeO3SNDXwj5wbA98DLmAM+H2XgxMes5sByUIEG4RFqJOY66R518SzPfQ5gI2nvmr7jAArYGsIG5S2i+CMrC+RQQ1jQMfc6CmkEr9OUT8kKJ4Veh+4ifOMg9gVDgJ1ssfM+hYQ/+ESO5/JrvO5z+A0CHrkFUw1SXIHPwLbBvz+EF0mKCxAJTjJFWkHLGPkhXz5EyWH4H/1oPdx48oCUjeWIBrQZhACseJYrBPvYB8gyWTH1K6zdVQhnW77kSTPd4B7T5ieJM/MOmPq+DUPBBvVCiTeKRRRHD3eot+bwAxDFsMCDnBewuGBK3A+IOJF8Ef6K4WS0WYbTEDSaABqodua6Hn8OeIcqOQfV5RMww16WGUoLBzuS0k3HqQPjwOc5WAhYvIxgOcRgg03lbYw50H8MCzDwfVngfH+Bugn3n3XtEANh46S2FVkF/3ssfsGb4RjSKQtHBHuqEmojTbagbZFSoDyC+dLu3ZsN38IYY3oSgLqI6nA8SnVAlga5gc4OaZmqKiI9frkYnpxfnJ2eTX1RT/BC4CTKDfUmWcg/G4hNq94sl9gJ2DUiGTr0gQbPcZtYU9hmszYSGN74+jn3oILJ+wdFGyF5/NDuNM/0I/XO+ikntoDcEJoz9y/HVqehq8reL8eiH8ej4FwvXKHJhIf3Hz0cZMDD8pfEHvyfjv9I/ChCh/EselGqZLL/5VK3+j3pp1Tr/BCzSEzwJNv/5jBS5/KLLHZJwmegexNS9+LhoLgl03UYrBZf4W0EkO1RgoNTNd5WFRo6rWJ8gL7HASBN3QGSqiRSoxMzmbGFJfdPoIc04UVgkfQoYYhKxioCmHNkGSbTak94vRaw8DTjh3koEE3WB8ICogHFWQPEgi9PQpGaWEw564DyGxIerWHG4dLdvBSxXNDsyoh4Tcfvw8NDgojnw4IPbFbCHAx4ccLOLgwitMg6qwgGs5wENV3djvy5+CbyJP4hD/8l8/o0VPwKf+2jNonBO4Al4gO4tlDCkZ0wBPpAFFygLSHoJzmydwa6VhiygoXAbaVJDAXnI9pDYhbQoRpZ4Zyy7En0kuWmRgMF9L1pJiUl8g9Q2sLbJ8rMeGLFD2Pv4f8UYVOdK/u5rRjBnH9TyKF6KxDAX2gKQF4wJ1Cink7aUlwbYoTSSHoX2RYCxgH5EioJm1k2N7d3UJFNNJgbPEUs3tX34NfOieHkm/0Sax2FuajF0BBxLtEN7XhhaQoMlXIGO6a8AKUxbcXHiVhCd0OgCmhmIOckdQ5pLxNVsGhZwVfH7K9h290ABbOr5YJeCIFgAZYC+I7iqUirEdtRKSgZnoJIiPlDVEU2w8Y0h8XCmCrGIlUeBNrlRJLdIYUZAt29NVwLXDurmwVdLWpd0S0UfojMA/EZKfUuJfcKn9nAsTcQKFVEzJHyOyi2o6r4XL0nvk/jxE+zV1itC6W2S1gDItkFetvTm/O+gHK4R/fDW+hfqjjkyYsGjFbHgVtFyxNH4oVcu/NiyUUdz2M0OOzgCpYDdhgidFwQ8+sFbFkOi3qY4pOHTmsHowEgAAESWaU8pfCaOhUBwFITOgFJz8cRMeKttQWrzbgd+nOLn/+ls2eAnhzc3N7WRIOtjwLKzDKNHfJao9IWWT7JkUgNVyhYRhnXnwUqLaQp2ZX7wVsKKetDz8Ss1ogPRM2HzG4teE0tmlrJrkMNSG8kQAFAGOiAYQ7pJI820gBVJBvWY2OdyBuoTQciCm+xb0nSIBdeGbbllBcR3tacn0zCQ+818SASgdUXQrT+duoGano/0fqNpJ1QtkS6otmjr6gn/WiNphD+kG+cf4V3QcENQhGm+QN8/fj41DrvP6XImX4GO5milSS0lx1nE+xzuf0YXOpooYBJHYDcS7aEOoBQChoACHCufIdejhQlNox6pqPFMoSH0TM/5YE2j8CGArj7Cp+1mp9kdoorfJ4lSRvEKs36G54DjevHCZ48oenHp4XH4yPkZ6f/SSCbvG0FF5DAKCrj1CeoVKLEEJuF/PsdzC5R60t6g1RBGI8BtaDOmVBFz+1+WRVv9wYtxY4N6VPCxMeN1LiZjpsLltE8eJuYFBajNTCEBGZkJDOqHpF+izH64I39hGeANlVNCf4veJeW5pBF2mwm62UxuM9G7UDL/xH7/TPsSxQHDQdK7U8iMNATKPWocr5EqES6U7U8ICXCPJUiBLlz5PsPk4ZXQRf8SgmBQ2gmuBPRI8ksr0NimAY0mySfTMt9M8aM1Ggyt5E4qTA5ZYhcW4dla3EUsRu8in3kfBVBSHG8US8DPPmhjbQPLQFVauzXluiS+GwFjcnpWShHBYYWIXe/5KlYUN4hXOmQYf1ywAJ0N67y42uUfr2aALukMQ0KlTaWtUY4dCb8SGKQ3wUkwA7oKHPmB6b5POUaUIScHUmSjjhKgp5+Y7ykyPbSaiFU8BDEmWeZMpZk5U0kdqaTObQAxsfevNViGPiw2p8MJUtvpnFjwJ3WqTVYmnVXtDKF5ypM+S0KgQJNdo+GgjguAiIUS9pg8iVHn3BudYNhjmkTgbzniq8efEPNr6N1nt4KNC0eoxASCg6Pto0IuTnKAudAKfiIPTrNdMsTIthdK8yZhA7KEtFq5TZS/jKwJja1UjEBsxXfqZEsOs0UYipOZNPRSO72kLr/3fNg028XFyPfDB9PnY5yDolymboS9I5UpcXamzMlEddG+j8A9IAYv/tRGlDzV1op73o8ne1jDH1IjyjMfY1jtz86P8mxPwH5KmXpHLZ4BYilUPAfIeMmcD0vQeBG4rLmSogN4yW5vI35Lp0vFrH3bmVDiZRGU4rPgdsVuuTTBku5jdaqB7iYlFpV4cpiPaji1w716G4WrBTmXQZildwWdlH7K2cJNsMPpQuooQbxM2JT4W+F3lEFlGrvxH+EsQS2u4ebPLrN2crzQUUO268RIpOMFE8NrLXCzjwJrPGOJG+sYf5qHSUZJmTDuYJU/Zaa3dW7/73/+b6zMFEftuXiFW07w8mRXodaT2nOCscvtSGoPnrlqOt18Dh9o6bdZrBhqorkkxVa/5LXFzkThp1h37K/INTOWcswqYZqWDpuVVs/d7HNT577GsMm0dnI1CVXCIELSlDl865TDsLGuIEzQMDenGafU32KcrzF/yiFdgFoW6aCoF36GwAP3COfecikDMOQnpGkYrfRxlNL0RH+JK1DZ72kpstnjLs4hUMBbwi2ydvHLx0wUzBC7/IxBFEfn13TAfX128uP1+L36c/TTa5Rx12/gv2/GxyejM/xxQv8d/TUt8jKfJihSTxTZvqHZKcG31UZdZggV1lozHyBYEvIXwkDWrhVBZuQ++Oq7r0RMnmS3sPrpXVcs5DX034mNJ43bp+w0MrtvVlZtDtJnm/hVYvwzr3AfmgJpDQ8U2NyvEW08d19KcF6CGY7NuJsX2BkZ0H6DnTEZX75JEzo9MScpHyjCEDHVQnEuQeVKixHEHsrTU2MdyEnxWWlckvhSAnu/3owWIYkwloStWNE01v9scjI5Hb+Bf1ObR2Ans3mmK+cDX5YTXaItQkKqStF2yeuD083b5pnbRYLyEtvlRB1XnYZSLXuJTZMB8DfaNFf5XXOV2zZXxr55RWCWlwuhmhgJgU/ZHps3xxKeTVd49u5gXP9ap9sbmciROCIFfKaboZyjLeNOm3vBcegI7SI/qnDKGaMm+gxTGJLuITwA3RGClrlrxQqldu1ToVUbm0bjGlMgXk3NnnITG5nkmrY50nqq2ocLRuZwntoblYFSGSiVgVIZKJWBUhkolYFSGSiVgVIZKJWBUhkouxoolelQmQ6V6VCZDpXpUJkOlelQmQ6V6VCZDpXp8B9nOuQE3gueVDxRERTNbldTwXGNIa7MsK1s+y2NN4Vmp5KIVNSlCJDO643WdcytP2P8ZT2dOC1jql3KQfRSLPQTspD+7LkUPmsUBMtP4lrCLBJqDKAfvMANHyyZwiN5gU7SUeGHOuWFFBWVGoxfUAqB/EypK0pkE87kcCogU0SyU/0t2beXpNGI7ANqn44mpCpEogrcf+twfQybvvNmmgXiOzkdPVOaF8ZPUtQ6mBK5WkM6n535D+wx1jHP2OPJsZqTTP71EvVNJSSLLEs5WaLoFL7gCxHSj9MLYmSnOBhYXV8trVugcHclc/G1GHu483yuarrdBKmMngesoJNkmWN4Z5Jnnk5Fh1XAJoAlg15kSQGwh5gfhyKH3wj0Pjnepz7leNbbG5PYRAK/597U3mEO/YlBATqXFFBWZE0h1lvOsDmwB+1+1x3wgc3sZr/Lm7PBgHX73VarqZNIqEcTaPgYc43uAus4JCiWiAaVBMrSjbEXgIImGS9ZtCS2/6DgYVQxj1ZJAU2UmK4MaJSX8sPwAxDgB8KGAcRNbduEAE/P3OFqGGi/bRCZAOmLCnnFzMtfyoxhI5+elpmRAirTEBLxWRRRm5gtF+m00Y1+nxfS+z+z2jL+68nVBFWSy9HZ63FtP9FjEnVAvUprskprobIE5TRYUcEA+IqcQToZJJ+54YcPRRwdu6JX1pSSQ1XKEPa+rcTAGitxq/5vjvFVDPzMFWW0NupRTZ3gE3v3Bd0nyT2e6F51i9s+p0xnplc6l9XUZhBfCBRQ2TrM0qsKs8/DrPHkkvYFZb8XZpeTY5TyhvPboBzjzNizqCy/F/UTn5KcohK4kZxGJSEVeAGfg5EkRcjMSHjKaqVGgyRFtp6ktcer+Zxh0qxMQSbzRhQLqhl2u67kl663ZpSPkj9qpiRTdnBsVGl5UhlvdbNaSyEYE9XgWYA4Ecc88UPrbctutep2t94cTprDw1bv0G432t3m363JObDwBxKlGhZdzeU0jN+PgMYQcQbUZmWXQqh1KYqXQJ85mqJa4bbX35YsSCJo4zGblp5MYZJ+Vxp6kZZmVHcrGkba3so7okD/S1jLZRl3bWUOU5KrMJ1UCmoq41Tuidy86ulU6HVTFMt1lrT9PFM207TTWdr5paQU8hfBiGA6df4RTao0FgTnELMfi/fPItWMG+PwNAQLyfBZ07BmIz9cuViQOYw8rJd5z68INQZta3VJc1eR4WvMSOtDxRMSYuEl55NiDuMVSt+D4qnSamqnipyS0u403FrrkiDW2oK9SH6106ctuzmsN4G5NWspeS0zi7UakrRv2dAY2z89pdCqpWgxWieyxMvnIhNzkyQI0P48Adzb2g+X1liWRkFojsIItHm0cLM8T2jYJg2R4rSEtykU50bAtiSlBHYSDUx2ogqcEdQt287L/1OZTqyLWaQShnetrJuvCOvhYHMsHh7S2kp9UDhtDmvvl4KVzaF71GI0YcqibQX+Pix5S5X7OPkKpPEkz8dnWHgkXfetYWFdjiS2t2yUr2divkDJkgZptzdwuq2h07Ob8MthvdnQdprtZrvQ6FkFHlCa4VDRTtnEGfu0X8tQVsHohmWcH+VuNQc0YO14SqU2nfVF45l6qnpdIvYhNe629F95ToyEAXq98a6R9onjuYUL9GJhDaFaIaNZM8LJ1Xl9AKtANfBIXROTjWQlJpw9PSXfkeHMemCxJUdBYIKVTxnoqgCC9g3rftNkYDcHdbtXb3UnLfuw1TpsDRpNu/N3ikUIXXIffmbgyU+kxnrhKcSPSCsvM4HkFc3CmAHsiZVyzFpiSHFfgXRWwZdsilVu0FtjVKCTr0cXJ7DLpR81GcW5Q1GE6cmP9PdSFGDCB2DYuvKoKkGmKikAM7y9RU8RI1juojDw/iUYDBWF1nUwhdPQAETB2SBgcDTpl4nDOZZX9umv5QOXi/iLmOsvYm2V3y+90AJSl/om4J2luK4hqZVQgI0XoIJ2W1MBD7AjkwxMI3BziRI6ikx2P04h8XDJjhubjEkty6iKtJjRC8AhC3TJbjMwFNc+kW2PyGm+jC+1uH0GOI7shJzUSnATfctRRGlDATDCjkBvxJMqVhY+BGVCMM6x2VeG93et03Lzzlf9HIN9ii0bhkPx5JgOwP+WdiHqp+i2KcFbspCC+GwUiGLW6c0YcznvgCieTTscCNpp2b32cJNILR5KOtK1F9go9S18srQr5rABy/dJzdOdkZFRl27e71L1+IXKa5zbvQK+MlLFrvKLa3rfPAyBkSbc++KwwDJ4H6X0KJhBMd4HrS7rOU3mOnazy/pNZ2i32jN70ByUx3tuqDzijxBX1licEbwvdqjnutGFQYkylYjgKb97vNbrnvr6t7qeoJa9neAxeVJL1fCope4sqMkrC2r6xgKKWUQ16l3GOWgMRse9Gbt2XcxWFrnSDCqpOac7E8Z0AU3NZgMknWa33+27ndnUxl+DwaztDl3bHszK05QeIk9LiVlGdlPq5oe8NZM9tEkam0JF4sW6Y7Fm22GjwGG7Rp2G7y7ArvNiXb/uWSLOmAuBskj6LCU9dtLqDVxs0urF1uXBrRdwro75tKW90zCW/qxwYecco0DOZ6kwrl3moMu6GdCffat5j5rA/vHRt5pd4x9H529oL2Ut4lKDiq/So1JYV40cAcAEfH77CeqXSRN4Kq97LEURZbZzej5r5EQHd3Kz1e2KPT20e51Zuz0d7CCf0+MUCInSa/WUlqxGx7UMS8j6yJKwoTRsZzoCyeQnKfi6OCpdLbiFyUygkTjSp4LUUzQYjArwic1SxGCKKwiPXr9Hvxv+26oZegUOlQkREpz+QjC0YykEac9mBFORAMYGI0NyrXW3vIjGkiOydQECrXJ+laRW9Volo/ypfU5/+GNoEMZLRTGKSEQcQGZvGRS0TQgyp5zgmcgkEtHeiKWTCFQTF7tvp4u0JKJ0F2oMWsPaZ7hR6086jqkux66rseto9Kc2chIie8lnQIF3jcpJ9u93kgFPL2XkiFX9SntALPoyI8Kkb5tCM8LIu/VKuVd11+KTohnqMfCFAHu5KgwlKAM3fFoMeC3xlAg/ROVxfyGP+zqHjFFDlFOIKIz1vRAExWxTWG5JWeq8/Ec2JA88aTkdb+Gpk6BqOb/w5cRyvngflrywoYx3JiUSgRGoLmTcfZoT9JqMubYz5INmu8MdNhjyfo+1u9x22JS3yToDth1GJaxtapZcqj1VAeQ0YxEiLE8DKd3RgFRavOu142388QE0A6xvuhXIn2XDfw+YYBfAsGCsbYVzpFqmkw/wDhz0iLurSACX6E4lfRfKmb3pKLhUDyU0vzuufOd010uK8Mi7p66tRKnPVstQ4EcsCt43hs/mdKQynlyBtj7F7omGUZMSXZfZFdk8qOTTVIKsHm10aakFwJFQzSga5KX0ktziG2oTaMlamZL9G7o8NMNgtnRyi4Rcnn3UimNAfo+T2Kxh/q4A1Sc3lYj90kWsCJstx0TSiV+Knaeg/N4LvPiOp0orbCPltJwo2MuEVWEuMP9SnjpuFSLn8gMlvISbSp6ZYw0Jea81CMIVtJKIU42Nuwql79wQhDtIHPnhSbljLBoj65U8Ovt2NMU79mD57/bPr78drfDWdvolompj/H3M5yG5EOER/sucOcd/6YzOcGOXRuBIfaEDFPQZtLpoDuHdARklz9j0uHm/KXmbKdk2XJQ40YSxdSqjunQBFQk1Qrrzkevu4I//SSUCrOmt3bLb3Xa/2+11202730uLqcxqCBLfaUrituHUiZmAPzknq9jzF82e1zAI40TTnM95mkHKdAoZ73yS2aDFO/4oDJZR6GtWCd9KLogsUG9LHfhBoU8izkeYFDiUUs3pTpPAMC8+D9ecpPI+E+9xjnqHg+asO+AMqHfQajptPmx3Bi3eIyvPYbCdNq/wpQz0K8fEsko3TjzVXTxn0RJEJV/WVQhhGRZdcdqX4LQVi/yDsEgT2rHJ7OiN5AblNR6pgVEIo064XackGrqkdKMoHVVzyM/D8q6zZFPE9ZAkGsdhxVh+Bypc0uMbNPELjtGReJKZovR9YIb3S8RXJAJ2wqJbXjm5/wD8q8ACXwPgWkd0iUTbt6DZBZTDQ37qd9bbm8CyfsX/WNZNzQldflM7hF+rAGtt3Abev7j7/gN/jLFwgmwl/jwU34pHYi/f1MSTd7rpgi3vqGnyaM7jmN3KYa6NYSzo9+v4G6q8QTM/tL4S/X4lOn66Cd5ZX0uWeuIeWl0+dHvurFsfTpvTeqfvDuHXrFl3nTZrDYbt1nDIvxFyvuTJIZWToLYZlqo4eQqbM+b50sXhYdWbYp69xc1RaSF/oF38lHuT1zZLkKHoDu2q+9C/N6NE0udaaSllWBJLGHLfYl5E6Qf1+86+peIwzsKH4jmoU3MzfsoMtimIKzIjcaq4qSpuqnzc1B8hiKbKNPsyM82e0lcY7xjDuz7TZoR5oLskKGSCqj8hO0HIbL6mvxzvnPb4kPdm0wHoBZw7Tdaa9mb9aXeHZIVjAw3lxj4/vqr/cFnPpDLE/LZcGsOVbCgy5kldAIa1g2G9Ta5MbXsIiGnXp92eW+80QZsc9NvdujPttluc2VMQNOuggilr7amkkjTBI3/5+YZu0+SW5bjqewOTu0d/x2sxu6HQ5QslOGYi/Y0uS4X6Uz7a6/Ceo272UkBQp9at7LUcHF9wPOvvIF9DqBm7U25SGwPACUXqgU5lykK2maDbX0amgyEyUnr6fbGGfl/p5pVuvqtu/iUzs0op/3KV8rK5NGeGy0hMkGGJhERZEnuYrWCXI48APpCJ/BcwbopNKuCjMiWbvFCIx7fiKe62+N3Xz8qv8QKXfxQ5NTSROvGob0RUjeXLUkdcjx4rnHuRNQfxjDG8mWz/v11Nxm/eH52ffX/yWiI1LBEbauKUPhEi7pYHeBghT/4JkMx4jzEdsqHwVEcR5UcS3+xbVERCRuzvp5Y2EwHFgBE2Ri6bxzKNxflQzqlLnaFhgp+kO10unhVjnrhJxYUGaqEyC9JrzwbDJrfBkph1HGcwnTWHvUGz02FN3u90bKopsQCJFGGhhO1zIYzBPo9FYaKTCxRa+G162G6rAf8b9huDLtm7fAmUWKJ/aUjeqwRp+izddb897XXd2ZS7zUGn1e1gzYp+p91izYEz6Ezt1EFjoV225oww7+/UJFBcxDjjT/+1tgipJODy1m7Xge2yeIl6VRjdojbnkBgRlqms5nUFs7vA7SnO7Ai+EgGFop3Bf4DN3YEOyAMhPTZofil/wfXkBywscjSanJyfyWNDefa3w4EobR/BO/eNOHkZHL9mJ12Of7weX01qO5yNCHYnE6lybPCKnr8cJ4xlf8XMUL3dyg8vRldX42NRyNa5C8B28Us6feQWCFAX8el8ikxwi4R25qmqQT8LfT98EJSxgD0ABiTC/JWkrPd6ed+LCXzV2EAQ7+UavVdzSBsC9xkTQCuEOV35JFEVK0OgMgRMQ6A6b3yp2oKbHcoZWH9sELjpHS09qp9lVFNxyol8SUB5ZyPWEI3iZTmGaXRDXxUVu0AosFs8ltm5VzrLKfK6S22wZHUro8dF5GExVlHoqliPMhCXlLty+TxsyHD6L9lY/gMcwi3uZInz8ouOXxRmgf65aYFCXu+2+vV2r9+q3AlftjvBC0jgPv9sQpfvo1sXRGelHNpFpZCfP7TurdTYZbV5Y0fIgCdAo7aH0hvj+uxy/PrkajK+FKo0l0d4pU3lZCz1aeEGbLIWa7sdkQPJAnZbpiyk0bn8pojFPPdI1SvsPaf49PrujPeGHTwj5C17wFt9x+72hztUilJ+kW0jjuCpyxqXIdVV3O0kO3tou9NYqBp58ZvcujyfspkaFWER93ElJzopSLJHRRdJte3S1KFHVnW2S2q5xR1uqDLZnjoD5rZ600Gv1xl2uvDPFHTg9tBtzmZ9d6Pts3WwvAKUqtqeiScsjZxPDz7wijr7LSIPtgxcHHawi4PqDVugiwWomWxFUBhh1A/88UBcAbRgoO7u4KQiy49q919jbXxSlsXMpYIsj7WvJCfPsF8hX9DABORgmx3VH/0t8X1epu5O8s1x4kcsM4LhP8yOscWw+f3XGthQRckofhVYFwIdIsIb1n39Kbf+zM4dVCtn9yRizpYh/zc1pHon/L9IkoqA6y1fyVb/lbKAL3ILnyTTbPeTqqsa1AcWi+PQ8Uid06EmZjVn7TOt3BIv5JZ4gaxzM3+oClT/owSqk+L4yTXyiWA88httL4uvdDg/dD68zLCip5Im2ScHORkD7xjgBHRENutRGMlyEp8MBFZKptAj1bfl6M7FDbcpzrodP8CbH8LIPWXx8qr4GPd3JXsNR/looyqXhfqzqnbz0MUDHjxwF+/oahit8kSrePne5/ccC3J2tpUk+p27D4tq/evrGyWZ7h7RV1pX2BzJxxaLHfST5KaoOG2jri+NXsm/F5J/623VCpEpROozw2eiKg+X9vYZYT4aI0XIbUsv15C8XM1Z2x04bs/tDA3wypbqYFrdNEZPVSFMn8OcfUvGsUVHMeWLH6XObHQVpMxNJaPFQnCtxWI9x8oxnLUsrDw70fNrCQSmQ4C2WlXqaiDilt5tkEQgF1pV2+62o2FTV9uNjo7GV1fvLy7Pvz85HeetfjpxIEeevNew1P12teLb7SqW+kWfRa81ZGRQBNDS+fXZ5P3R+eXl+FREuMgwxf0soekHKgRmdAGvfhqdijfYD/66uDhVwVP7taPRm4vRyWvz53vobDK+xCfjy8nJ90bj0+sr+eb87Gx8NDm/fH919MP4zQge0WVPp+M3Yxrl9flP48uz0dnR+P3ry/PrC3ik74NKfhqg60cqxmq/dnry/fjob0en4/dXk9EEG2FMz8/nl8fvL85hDtjT5Tl9fXlN/1ydG6+uzq8vj+h6+9Fr8d/3MJPx6/PLv9GfV/8NY11dn+JQl+OL88tJ8jd29NPJ+amauVqG0dHk5CcxB4Djv8XU3uV084DuHlIFKVTYJoWiwh/Hk/PYiLBBRU0exhnZxqDUzyIwK6KVg3E0ae+CgUpNe8tQBK5kgNlukWQz69Pm77qLqCp95Hn6SFX888tg3LWI34fO2iw93au8Czq3aeRZ25W8ufgpzSALAvK0ZZ5AUUn8L5BwKolfSfxK4ldcSAuSLU70nFN54415Ceil7sBLuQJerR55hOb+a6oPVd7wp2PUwGV+Ompw7RzWi0NDzGG3tJdzspBKhVayr5J9leyrZN/vUfZVNtyXwY42ndZvsfA2yDBRyZryDgMul79y8P6n0lgl8iqR9x8g8ipzr3Lw/rEY94s7eCuX7h+VVCoZX8n4SsZXXKhy6W516Va+3EroVUKvEnpfjNCrzLUvgx19Tl+u8VbRsaIfHWH8EiHOZWOPNYq66ZydF4DB6K0kDE37SRTQeoHRsZuyw2rMy6V6uQWQDvcdAAEmUer6u2R5UxHs+PkOJffzF97seMvcfzqLSu+aCpGfgsjUHqxQ+SmoJO5XYfBTiLE4QbFCYFkEius5GPwpHAYVMj8BmTMwGabM+TBa4OWia6o7Zf0oxo3jqFQ8Se3ipdXLQv0jpVd+Add2KGXcLNhLpVy3hwxmibcq1FsV6q2Y2fNt+s2OmbWGEFXD1+/SriDKZ8ZKD2QWVlVh/+1VYauyrV9o2dZPp4J2W1MBDz65wJHa/XQtnBZVsuONhXUo2OJl7sgz4XCACqZc3ZOXgSHjS06DcBTOyYdwqfWHZ4DjyE4sFgkgsCeibzkKXbymahyg5gZAlypApL3XWfadBukcmxnFPPMVK9ed5hT3czw5F/f6GFqB9uynxLd++rRfqsJGFtJcYTUhilmnN2PM5bwDong27XAgaKdl99o7lI5VQ62/mvRKKFc7lElXfVLzdGdUnbIu9bXvUhd75EpryMJA5U4wtnpoCqWzdoJ6geOvXLNg0AvfECpWDLQmWrF+X6zYzJ722h27z/JqTRrCZ1wSSlfKWhKBW3vffFdo6rgg7xF7Vq2mkvjffI/o79N+q66m/YKvpt3iNF8b3vgCTOSOxRc8mntxjAWAni30jRlQ3aBF0mcpebqTnWNgYJOdc0QX4/Lg1gs4VztqY0TQ2mEs/VlhTetS8UOb5kAfZaA/+1ZMYJxMIBVWhH8cnb+hre/cgeDbdVDxVXpUuhyuRKTVrjTxnGt2d51PscYy6HT73UGz1e3aTfw1tHudWbs9HeygsaTHKbgppvRaZbhOKoar7JlzqSPm50i3dloZQt9e4tXZlHf1JgT9GvQp6GXJS+VcWVZtTWRAyo9UWPN3lPi7MuVi1ZsNfYxTnjD1vfF007f3ma/uN7c/ybvQCjyra1yqxatgLM8VWaLGAumVXKOdypw4RBcslu9zR63PKN1WM7G3QtarndTqsp7TZK4DO4n1m87QbrVn9qA5UG5dxXPHtIfeKzGWcVump2t+of1QaCj363ar3uqQodw8bIGh3OliOdbE4YOthnW7K1u1e4d2p9FutrCV8qlAm5aNPTUHE7t72IbO7EanSYVdtcUtLNGU8Zt6lDdGJdfSZiChaTYbIDaQzfTddo/Z4lenxbs9u93kCZqSWobK1NFeXyNQS9o+my0Ys8x1HorObCrY3mDWdoeubQ9mCRTGJQNZHSSz8ut5aLLyZXlglgDmKx8vETAEcyJPNSXuwGLfFbHRptLbc4r007sCBWz9VjG1r3UbZdjpcdd2Om1XXRsBKBy2ZlM3QZcxYoOxDmwo3jf2TNphn0ZYkEfYrThUTNC1pvvs3mm26vZw0hwewv+6dqPZ7RTvneHE7uDeabcasPZUFNkMNls3XIYyt16qobGTvwUjrZHI7aecFXKRe4Mtq3xfYn3vi1eW28PWoNOa1YHrdeqdaXdYZ8wZ1FvdToeBecdnnWkC/7XwfE5Y/MG6AjXLXfncumBxzF1zkaU8MdmeRHh/0uwBzztsDhrtVr94Ucw2g8Hfa8mV1CJUFeNsj69Px++vL45Hk7G6mFNzmvTly8bdy3ISbxggN8Y5qClEtSfz5mTZ7kJc4oqy/d5DlR8dt+pQSnttOekGGV+vvimiJi42zt9rXHN60+Fg6rSH3OGdwdRGOdRzmz2n35s2ez2nlrqQGLDTbzQHw0azh+Q8oM0jLwHJbRwj6Ct/w65xwe5bwid8qTCK5rdx921NILiWXGdVS3Cdvsd148oQkSZXCm0m1JOk3Tp53es6nS7v8zZwbafTA4bUAU7Ua7USQmVuQxT9TqjSOPgz7lOsjXA2yU2IwteTYwSjY0u9UNLr6vRi0jg6Pb8+blyNTk4vzk/OJo3J+Gry59FxfXT85uTsu9dv4EVDCIeUDjCo27DFWsihuh34X6Ntt/I6wLpWxpZZ20beyFfrAiscdlp1EJpINMltbJLVGJekySdx4YU3+7nrxmrn7c5wYHdqxi1hSImp66kyDM24MMpcUFAjus7AtfEc1O7N2t2+M22BYtEzZHprbI2OC9QC1QXSBHxkS5poDqdDBziKQRPjwJ2E8B9YnOT+hfSmWVGXBvGY1wIRpZDOMlot78LIQ0Pgnsu+SkGy4UYh3O4+C/iyzuZ4a3ZUZ77H4jreuKwQu5Ym0YiKAuYfber/IYw+XBSTxTNpGrdNYG6bp4JbkQToBZcXiRfJPTYld3m7cJcbda9Rp1K4wQSm2F8AUlfLcC4u6gaFCl1rI/1kdIzP/BC42Vrh/iz60iKJDDhuHYOSjcLo0arL3+lAdLlb1NUceovmFISiqyxU6+wVEpu4hKHfpO9v0JoqCAlAJwV3WReh7zmP1hFysjCy6Gwi3ofX1zH+2IJXaHcML7zAek1HVM/4kJZ0pw/HuDEAgTF/xsdX5Eh6xofJBF+tPB/ro2//hkaBvU4XV5T/9t1TKdGC5rhJzm3gs26vbzuK47K2zWxg6Fs3l/F4nYEG+2M66E7FTpkObacPO4UZzNxI7jEMxOThURgEtFF+g+0huNCajSBelsHvu+xtGy0VXarZWqvfbSY4GB1fWD8DRwYV0+GWwEQp1sNbsx4wwlaPGUZqGIENjap5ltNkrizIM9gZ61C/fXvKbZcjOeTZ6atwav0MTDsMytf8Z86cJ6X+35l1/ZtJmf23Wbpsd6ZOzwHi6bVBuxi4HbsFoBlzXeKxyNuUa6fe7Lb6rV6naYPVMniX097wE4MZZ3MF02aobPyyakbaofIsPXaN8H/Kbu1cr6BNde1+t2vQXorX5PvOvpaIS+c1prAmNsrL4qxgY293pjyTjabTl6WvPotXlzsuY+gr4navC9Zba9hu2oMsaZKSh+5NIEu73e50AQWtVnsbWcr8zUJiLEU+MJjdt/vMTgB68Hy/wfxpEQHhU9zUfgGTlewsSVNrFx9TN9f4pIz0ri0eKp3DsN4ivAw3OW9lGADryTCAFrCPod3vG16Lk4klnc/KFozCAo8tNJPPs46LJjklhoct+7DZbdgdO22rSeLf5JmVPt5NnllJ4ru5ZrdGr2Q82GXcsmDbzFnc4EATYfAdsvF6HPosUn7ZrAc+4yTcFJdh8h8VT5HQWo621hMOHdvccRgnIur5a30SLplf16dLuaNDdc6UPZSlsNElfmxFPF75S0vciPO1usLPCgP/0fJECOwevdyzFiyCqSzxquTYihfcIVKwWGzt4dLufZM6SGvbBG/HtvMB2Ue+hweJ4ygClbpuXapRPRVzS+RgTUNX3oAO28Cjo0YnhCmJ2RqX3Rz8IxZnzTkMrA3FRXvsKHRLHBh+7wW8fhuBLg4QcgLZgQ+Fi8xF/9gcj8xElypsmNqlDxYBE42m9Yq51qWc35GczFPiKitzh9G1iKlQn1ieCINbMywwSzbt2cNWZ9brMNYadJr97nQ4Y+22PeyKa8LlDazb4xVe431JnmORAPH+BQgBrgG4JwBo8FrpaAXqowT+kVZFWz1NCa+15B+X+xazXh1dWJ2+5bPgdkXP2W0GCUGdbjxOh3g+7UsgziPv1isMVlCBecfj70eqVoAsUIB9FeX+e+IAPaRz3LvwgSCWE8DY3Zj75HxqWHuy1z2YEJM3NsmGnvgrfowx9FIesMMXcvSCL8yurVkUzlNbifbNR9jhXoM39q0pPgONwLmzMPwW97vY6sifFsv6qcTkniX4zTcN6xPzIJK1SFCZu5hZnoaemouCmwMgLxMxj3G+RBOpXaipRYIo1wdgFpjLB9QrpBFKH0VShpPcdOkAZ4K5ecvYkuyIGCIwnkC10xzLDBIgdvdGAHO8DMUljGwVl9h3Fz6wnzpNTb+453LzUeCr4Ea0GmqZJEdS0fD4sWyll0ttfAs4ue9We7fau9XeLbl3sy8vebyAvajekurTzKs+1wETjnQUnjnVR6RbBKGlGomwG7GQ+3hfrFSR/vLzBDb2Bx5ge/5xgeryC+pHQpTngB/p9RDPpyqXTol+I98KACQ8ihnMgBNx95DgTiAWMduEqnZ+tO/DaOoBgQYFKiIeFliP4UpkA6wCcU4Z71tuyOPgKxmqq288hG9wVDC2RbRFpUlWmmQljSpp9IeRRpUmWe3dau9+mXt3oyaZDgSWepLhNw4s+Z5isy1ogC49+t7SW07nMZjaCnZmaR2rltYcatNWc9qc9R3ecVnH7bWHs5bTa7Fuv9lvTjstCkDUsv5tso/1JkvvKWO9xToSikGJuwc9bhWgS3MZhm7a/QfojfgM2Rqldiq9GXDeqAl/KOmOrWFed5yEofWGBY9KQ4pTOmSQ4Ah5GrSdY1udSAoNmHULfDHA5BcP4EJSwizjukUnjr4392jz4iyg3+ixPpqhZ1RsFEVkehQZwR8TJ/BDkeL9wDxMjZ6hzgc9kAZ7C9z5BbVTuUSfpMlblzjjU5yxNf7ocI4bXWvu3SL/7okMzbGuxAKvcfQmyeUBGASCZ2m9s9LPK/28kvGVjP9jyPhKP6/2brV3v8y9u4N+LrWh9fo5NCitn0Pbhm1pXep7yrH9rdV02ioSAiJvK3SoHI2b6OCkVwApIUCLkIJ3Fmx5B38diIyRGubhoyYogFhFGHJxt1wu4sODg19hbWBNnhps4TVU0HwQPmDoxcF9UVkwcTEgUgnwKnclgmZGFyfSnmgQRiMPiVZwOBpA4FdmKtd0rtnG/lUlsMdwBTyNutnHoi2SgOgx5sqC9aCTiZ8oOi0zR5jbdeQ/bZvPT+1N8xCdrJlHEfo2jgXtLYAyMz1ZPTDmsMjQEYUDi9ExEPhIMCjMBTBFB5pm+aqK59isZb0CEsAscjqt+PovP0++sW5RuaTNvcLoeIt7lGjOrAsgEWJeI+W5x49InkTh6lYkP49SZyO4WayZDxO2boIrzq23Zhn9S2DDhFL8iNPOx6/efa1WxuX33EeB10jlYh54bnAAGDpgqe++IeFGVoAXiORrLFVwE6jYdiySQG3kFMmos94u1LyYMa/nAvEn1Vtd9Fan3uJvMlAI1L51RKyNAzsWu2B+TNh69uCiv7rRH5pM8AR7zcIgyo8RHOkTLUet2rPhSPVXx/7ScNwEP1NxsvRnlmBUVgyCz3etE8u5C8OY/x/LQtLBbfD2dgW76NlgUUW0Ou2Iess2QKqLIeseJroQfKewMQJBTGyKcpjUkBA0tMAVW/IXWlnY879QrbNfUnOmx29BXGJLN3TiZ8OMA9ZxwLrgAbGEX2bbAbCwt3EOxAcEARwl60+cQAJq8DzRVyFXp+4P6BsUDQ6AKuIhF4fij8OEwclfFr3A1roNsOCaykgnB5HvW7IvKjFkIks5ALIYzMPrhyAJM3gT8GoHFErH39t8ccajxE9yHviPL82l13CS3w/f/TdxvIrT/BE5jVRs0d8ovXivQvdxrEyQX2tkoZBabeb5gu4EjaPHiczLVhmFNfn8J5DdYuN1Gy31ELuTPyhc+JDtIR7QUqf+KYSYyoXM+d9FMqPMQjk4AipgtyEa9AFs1x+8pdmZSE5oUJ83Nze5nDx8VtNx0Sy5r4U6OI5J2SQL1MgRTyouS6vvRzUHsBPmIngZ1LR/rjzngzWNwgd0Gn6EYdrNTrM7xFn3cTbJ/Mwo/VzSrRlZ/25fQDMKHnVwOFp3zMN6V9JbgLMZoUX8Yxa3mHukEJvGDtq5VNVykkIFDvdx/BH0e1lSq2kDFaEIgF/4E+PKoXWMqev4x6vHn4QtJ2GRjv8z6ltZ0ATOJQVef+/5SxnaLo8I9HqnkxeoIGTSghLt0RLklA1nVIiWEzi+wnu/jOdxlvLMd2Kl0x3RPgkk4Hrxqe53hl7I/ANqNJpJ/R1Bt45kGWv5lbqJTK3Cd6IbsQxP+FyhRCfKpMp0yG4m48s3Ri+yE3qZJMeY2TvQ9XTlfEiVO1Aiy0Jnhph0aoArcwSdI9dwREq9QQhzLzgOHZUGhxnbq+nIKNtdobJC5b8dlSTQBMvK8tw/AwbJ7Ed3DR1lYhujaPqWYv1NwdARR8g3noj1zUISCplyWageCj9H/rwrpqLTmLh8cUI6LvmeGFa9VqXPzG5gAksqV0KVf+88Tp7yBWeUXrRvyQR40GBlKj6X5RxvKdkpAlHPfDb1fCzna/2MZe4ckAnohsTYQuj1H6H0RyZVno6VymNhvtIqwIUCIFZzCyuEbtGLAOvOSqjvjkj4FQCF5ADRXyldFhUuRAXdJIDC9XyGR6oe1V4oORZoP7E8TwVEGmSWTOQSE4YlnaUdV9v6Bp2rfsd9KjMItgcPYm6M8OZkkusROguk4A2j2wP5UXyAbbHkopZS7YbdsCknMoyXcxYY/aoqNVfKu5gpOanPjlVLKk0uitdoQtInJCSOSe0V6U/YmLQMXAGdH6Wy8xrWq0fl6t8nMsHC2AukGfzsozcHSghnFmgKtm2rUWU3oHaFkRs3LGsSim8WWItetpVvk16xcruxJfELgAm+pmsHkIjeXuAj4WcS2LBQ6wFNtLyOLrJAI7eeTLKuc73iPy30CHUBS/2fYoRioyxtYXioLVPVyKJ5JGwN1ciDBZ594YqvhJdTOJHfSq6EHOYOvcvw5Ndf8UAEPapPWuMWtQyzifNrKeN8Nov5UlTNF2civs6GgxcN6zoWZeOTTDcinT2K/dijkziBGZ7yToou8O4QMoqlR/dK4hh4hk7zvNA4fqm1WmMmr0PzB45KcUiIMMSTqGNYGpFv2EcrSG4nFNNH9Ijd9OUgghb2+Xg4mck8SMtDpg7UtAgXK1/QB7f2Uumae8kpkAwZ0nypAJdYe/qB3AhUgD8JolHEiMxrTyzknvVAgTW3QYiHNGj+X4Ftoc/LhEdaJH+KrE/kNCJcHqOdCFvYHrYuwzsePDo4Q96E2bnIMIOQ7nGIOY4qskO/pZnvicAegJZwKLCAracUsS+h+TKoQV2+k1DDu+Q4BnjNO52MS4xHfCTjfOqTtMKXC2BCyhJfiKPcjW3fGcdrF+d0NzJmxpJpLk4KI4aVNPC/h7WbGpn04ULbcPT815o6d0cLnvpVTtIiH6H8gdN8evr/M/dbBQ== +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Query Parameters

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. + +
    textQuery object
    + +Query parameters used to construct an Elasticsearch text query object. + +
    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`"} schema={{"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}}>= 1`"} schema={{"description":"The max amount of records the search will return.","type":"integer","format":"int32","minimum":1,"default":100,"example":100}}>
    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* Filter
    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. + +
+ +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
    + +Owner's identity. + +
    source object
    + +Access profile's source. + +
    entitlements object[]
    + +Entitlements the access profile has access to. + +
  • Array [
  • ]
    • requester object
    recipient object
    approvals object[]
    + +Approvals performed on an item during activity. + +
  • Array [
    • comments object[]
  • Array [
  • ]
    • owner object
  • ]
    • originalRequests object[]
    + +Original actions that triggered all individual source actions related to the account action. + +
  • Array [
    • attributeRequests object[]
    + +Attribute changes requested for account. + +
  • Array [
  • ]
    • source object
    + +Account's source. + +
  • ]
    • expansionItems object[]
    + +Controls that translated the attribute requests into actual provisioning actions on the source. + +
  • Array [
    • attributeRequests object[]
  • Array [
  • ]
    • source object
  • ]
    • accountRequests object[]
    + +Account data for each individual source action triggered by the original requests. + +
  • Array [
    • attributeRequests object[]
  • Array [
  • ]
    • provisioningTarget object
    result object
    source object
  • ]
    • source object
    + +Entitlement's source. + +
    segments object[]
    + +Segments with the role. + +
  • Array [
  • ]
    • attributes object
    + +Attributes involved in the event. + +
    manager objectnullable
    + +Identity's manager. + +
    identityProfile object
    + +Identity's identity profile. + +
    source object
    + +Identity's source. + +
    attributes object
    + +Map or dictionary of key/value pairs. + +
    processingDetails objectnullable
    + +Identity's processing details. + +
    "}}>"}}>
    accounts object[]
    + +List of accounts associated with the identity. + +
  • Array [
    • source object
    entitlementAttributes objectnullable
    + +Map or dictionary of key/value pairs. + +
  • ]
    • apps object[]
    + +List of applications the identity has access to. + +
  • Array [
    • source object
    account object
  • ]
    • access object[]
    + +List of access items assigned to the identity. + +
  • Array [
    • oneOf
    source object
    owner object
    source object
    owner object
  • ]
    • owns object[]
    + +Access items the identity owns. + +
  • Array [
    • sources object[]
  • Array [
  • ]
    • entitlements object[]
  • Array [
  • ]
    • accessProfiles object[]
  • Array [
  • ]
    • roles object[]
  • Array [
  • ]
    • apps object[]
  • Array [
  • ]
    • governanceGroups object[]
  • Array [
  • ]
  • ]
    • owner object
    + +Owner's identity. + +
    accessProfiles object[]
    + +Access profiles included with the role. + +
  • Array [
  • ]
    • segments object[]
    + +Segments with the role. + +
  • Array [
  • ]
    • entitlements object[]
    + +Entitlements included with the role. + +
  • Array [
  • ]
  • ]
 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/search.tag.mdx b/docs/api/v3/search.tag.mdx new file mode 100644 index 000000000..238803ef4 --- /dev/null +++ b/docs/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/docs/api/v3/segments.tag.mdx b/docs/api/v3/segments.tag.mdx new file mode 100644 index 000000000..7eba262bf --- /dev/null +++ b/docs/api/v3/segments.tag.mdx @@ -0,0 +1,37 @@ +--- +id: segments +title: "Segments" +description: "Segments" +custom_edit_url: null +--- + + + +Use this API to implement and customize access request segment functionality. +With this functionality in place, administrators can create and manage access request segments. +Segments provide organizations with a way to make the access their users have even more granular - this can simply the access request process for the organization's users and improves security by reducing the risk of overprovisoning access. + +Segments represent sets of identities, all grouped by specified identity attributes, who are only able to see and access the access items associated with their segments. +For example, administrators could group all their organization's London office employees into one segment, "London Office Employees," by their shared location. +The administrators could then define the access items the London employees would need, and the identities in the "London Office Employees" would then only be able to see and access those items. + +In IdentityNow, administrators can use the 'Access' drop-down menu and select 'Segments' to reach the 'Access Requests Segments' page. +This page lists all the existing access request segments, along with their statuses, enabled or disabled. +Administrators can use this page to create, edit, enable, disable, and delete segments. +To create a segment, an administrator must provide a name, define the identities grouped in the segment, and define the items the identities in the segment can access. +These items can be access profiles, roles, or entitlements. + +When administrators use the API to create and manage segments, they use a JSON expression in the `visibilityCriteria` object to define the segment's identities and access items. + +Refer to [Managing Access Request Segments](https://documentation.sailpoint.com/saas/help/requests/segments.html) for more information about segments 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/docs/api/v3/service-desk-integration.tag.mdx b/docs/api/v3/service-desk-integration.tag.mdx new file mode 100644 index 000000000..cf0b7fafc --- /dev/null +++ b/docs/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/docs/api/v3/set-access-request-config.api.mdx b/docs/api/v3/set-access-request-config.api.mdx new file mode 100644 index 000000000..02d6bf25e --- /dev/null +++ b/docs/api/v3/set-access-request-config.api.mdx @@ -0,0 +1,108 @@ +--- +id: set-access-request-config +sidebar_label: Update Access Request Configuration +hide_title: true +hide_table_of_contents: true +api: eJztXG1z27gR/isY9sMlGUmW5Hd/aWVbaX0Tx65jN9OxPT2IhCRcSIAFSNuqx/+9uwuQIiXZVnK59u6GczMXiwQW+/rsLgToMdCpMDyTWp1EwUFgRTYIQ2Hthfh3Lmx2pNVYToIWvAhzI7NZcHD9GFxZYeBNJh6yQZ5N4VkgI3XAaWbbuKntkOYe5GnEMxHcPt22goxPLI52azC/iA3gVSRsaGSKnAAfl1NpmVBRqqXKmBFpzGEGy6aCAR9GwMP6asytljtZOjdqwDL9RSh2L7MpO7v4678Gx6cnHxkHfjUKwmABnCuNiGAoC3kcA314Ojg/6YDEnvChjkDox6AYGxxkJhetIET5VYaveJrGMqSFN362yP9jYMOpSDj+lc1SARLp0c8izIBualDlmRTWzzX6jsf2NIe1xPAhE0bxuDJxpHUsuAoWVXQyZsQJKkWxkg5LgBAbCQafUUEg3WjGhKfL7MxmIkH5xANP0lg4eZ5aAWhGDzyVoeKjGGVdlwvGVcS8xoTxn+6kuMcPRpDhLE9KbmGtBBSGSp953t2gQo5VHHr6Z+pQTHk8Pht77wQu60x5v2Jnirmh7GzMjmoOAuRfMUwc6/uLxRUHaqaVOJy5f9fTD6ex4GCq0JD3XTbWxr9daZCVHAxhjJ4J4OGUKz4RZk0mWOKGP8cHeP7GFF5H4OQhhZw2mV3mCxjLZIYfgyXevD2Qd2/GC5FIFQkzUNHQgrVJ+c+ZrfA+VswiP5rP+1oTRnxmr1Qm4zmJirIAWASqb1FZH/NkBEvrMcP5CA33XGJEgZacj46lsaghx2SHgXqVLj9bcvgCjkTkXZ6gRToIUy8uIUpuUUR4BJHi+N3sV83RbQUqj2OM1NJnkN6hyO6FUIUS7S+RmSiVooGYmRx7qLNfz13CH76Gq1P+IJM8qahrJSPIroVcgf+idkvg8fosfPE1xQJpXC446FXE6K0QYwyROeLhF+evwlyI8Sqgr89bdE43upxlMyPVZEkFlyAPjqCo1QrAEpD95Hj48fLk8p8ddumdyggetfF11QJBMQ4DUkavL3YSQUKj1BjV4j7Y7u3sdXvb0WZ/vLffDXlve6/XD/d7e929ze2oL3ABBej++hJ/ywGG2sguagbAxkJmnzGcjPaVnoPXJBvEEvIsey/MJLcal4dkK+PX1x/iMMajyCDufcWKnFbsjN2KfymmWQ0PQ50EVVws9Ah+IaBUCcVnqEE+goiIgsRndfRgDahEARVNSODfem22BKPD+ciiwvqm5DdcWnGNVPM+5hOX15AEmIBVGC/yzgvJ/UgnOJLqT1durb+kK9FwzdBTYfdTCW5m81EiswzfQBg9w1AkxjyPQUYIbysqDNJnxFahpIh+FQaNQDP8Qv4mhpeWKpzqE5ahVcB5LjDK3GvdDOKXKD5nQxcwiEsASSJJETcoEZZ4C6+VEJGIoBw/BdZlirbw9IsyFTXB21akHJwThjKEPJgto3Io5tObagCc3SthboIWPLU6N6GoPPBlzk1AxcNNcK/Nl4nReXrwKKOnm6DKS/nOsjcTRHLFIVqZe/S2kC23JEHVBNVlVyD9HDYWmW6xysxWUZO15pwceFzd2tnpjre2o51ub2entxtxvt/vdbf3tmrYsRyiBWBUAWZFQ/f09EQxZ1NI5M4/+t3uipKs1qjVYYQdiwzAjOqAphtquqGmG2q6oaYbarqhphtquqGmG2q6oaYbarqh31M3tLWqATqKJZp5aAx4QBsQJMuNgi4CjOuyq0OUkY7oGyWpyFjfsSWKqMk60tEa+eS9VKINbiqRQ0EshzARm587GaHrJlgCOJKI9ygCjatnONBEp8cOeVRFTBIGFWkg2QOtkzVy6JWSMJ8VUyC/UCQ9s6zYFXy0093vb413tjjv7231drdH+2O+udnd397fx9UhAiw4STWGuTF8trT0XwX4lAxZrCF7yP8IbME4pklkgBaHKRK6P/u6DYjGmvWJG1uK6fll+F1pC/qOw6NztrXLYq4mOT3nkwUlqPbVp6UoAskd4TMjJ1KtYkUorNaug+Ph+8HVh0t4cjH8+9XwE/yFtJa+Yh0o8NYI3VJTNTnV98SxF+CeW6gjY1AHwtA7T/UdCMSVrQ70VbxrpZkHBZjhV18xo0qajY1OaqEUui+W2RvZEZ0WQA48g9I0nLIRx/4dS1wY/g4DOc3aH7wm37EplCrCvO2wQRRJFBJAF6IxR3jlVCpCpYOh6wiMcwhlQd8P6zyjGjqsd54VVS5iWoEmH6pGweAAztdIL2GWA3MkZjUKS2/xLHr7AM9Oc3XuLitKI5XOVMbDYhsh1IZa1xHIJiG1ejhCc1kAHlWMKxGrhqTIzalj5jjT9C7kuV0j7s5jgJ82iVa+uBM++KiZcmhE1ijM5BHJtyw02Y8qzVUEPvSbIo6a2G1it4ndNWN38eWF3/b1b6n06S2XPlfKH5bB5LlU+hjyHixw/SC3++AM2WKgEF8i/fj50h/FwSM9Dym2Cd+xPnKpfHn3rLSHez7C8qM0Vs0WyCDp0UkwBiQS0QHxPeeYFOVUtbm82nttRhIcVK0oEQE1DZvpnAp3kytFjY1tsUgLq37I2JQDPvq9R0JAd/SpTWefmkqyqSSbbNRkoz9ONmoqySZ2m9j9fcbui5VkyRVFi6+TbJ4k3Mycp/n3KC1nMIAVBxBYGXJkqsVqBYmxssYK6pVDMOr3Rr3xbii2Ir4V7Wzuj/vhTp9v7/Z2e6Ot/m5QzfXX8zgug6weUxV7OzuSiqGIu4M6Lqdv6zKto/r2X447wWOENYSesm4GnYNKb8vasb+/XDteas1OuZqVp+FrNaSa6wgxDcYmONYUY2EAZxPARcUAqiTwha4kEwFUcAuZxTKR5U4y0DWz9mCMpxJcoBROVq4iVRjnwCEhQayxal74ztfMqIKdADp/x+rUm+gXVfLsAiX+gBKz4UNIu+2srNy3V+3vnih/FOSTM/AzG72u2+EKHAAaAodZZd3Z1OdNfd7k+CbH/zFyfFOfN7HbxO7vM3a/oj731dDz9TkMWLs+h7GdLitrqfd0LuB/XaZTqHgOyL2ZDumyaDSvwamuAFdChtKcMITjBdZgY+Xl1QAvvmJd6FjKTQxDp1mW2oONjUewFFjoqcNT2SmOQCl9jyegNu42V+DO/MwjIFeUh7TfPDg/8d1Fh/RrJLqwwztawGm7PGsBWqed4RfpF0fIZjoHhCMyLTw6592JHgObKfQSP1ga3SH3WZIRZLsy8dNr8vxj8yU5HJFn5FilvhfXgvEMuFwQD9m/nd9Trhz1WbqtPE8k2Kj1lxY7w2F9dii4gY7AfXfx5sfPl2/ZBEtNCvXc0kkgib0BBMs5uAhB2aDYx8dJlF2MzidTYnxQ+6YEQ4eNYxCY3ahPQrDr4qTcR8D4CwBlUilOEoQDOOv2TWGZSNyJGNNfZ65JdDwZqQ3Q0AavzXtLqY56AqncWU93TbrNjumIMx5hdaecnIjU4rHrtJCLV+T6Vib+VFBr+2AjavbtAhdOtdehO3kTQvwiCTzMj9r65sUdvXaFXptOdLWR6iIPqAnPR/37rbCw2jfzUaPXRnp1Pm7U56mEPFqfxhxsMQtpMI7YCQunWlvxZ8bQdTAMric5RNE3s3WPi7YpItr9boWltluyLdtQFRJ/HyAwlHMmPsKsTEWJhnpNRS4kfyLLQsz/ROfOfqrJTI+vIXniyEiH9pt5xgXbuGDbYYD1/LvchI4FsY0yEA44Bzia25+QwDNawTxHayWqE/kNmoOpIQRWiYpND9yHgznA+b8YvcDR5RiAYCyqy2/88JcHPK0nd/VkrqxiO2BRg8v8xhry4oLeHL/ldhTmyt+avCjxYL5rcqbi2fdG6WeQ5LeDu/8nxGuQ5o+INL7Mxd3Hi/lPmAyLhuSFS3auaVp58829euHK2XoXxPwK617lKq5+rXl9atUFp+5zt4C6ixdweq9dZSkvkLj7I6/fAymugSxe0CjvZ6x1j+Klqw7P3kyo2Wv5kL4/NP/cGX7/+sUj9L/WYW6ESVL6wvURBGfXZSzvPVu6iQb/h7eUYagPhC7b/foP1t5VMik4B2Ix5aJwKgXtWqWCZ+jtreI+JuSP4taodYQmBsZAsiH/GsmYbsp8FkyoEETHLQE85wNUf9Z+b+AT2PmcfsPouAAchvrOFd4sAibyhHGAtVdQKZI2zF3yhMZUiUIyTe1HOavIJAh3qAq62iJMYs/G+PWGDEUFfF5ZC7DH+u82QJFoEe/Mc0EuhIsyHFdvG1+jDYjXnoo4xU0JyPzQBIjKCqcnl0sUgZhy/tXRZrLhJ9kNHAtEsEV3zrDZ6Xa6+CjVNgMnrNC9ol+iYi/daV70rcf5lzu/hd+k8kiErexGituvKGjuWmu3kXEdrN7IgNZ4qhEZroPHR9yiw67+CR/DMNz/ub6dN+34CQi7rTra+fgicIvIfzfUvpxRhef3gpa/9MJ9BDfDbf+9OPa2siVzfoWWH/mf3Erc5pLh9/AQ/38Q3MB/8EGnzu9gED1/DIqtWhjjyBaV9KpC0v+BUj49/Rf7SjRS +sidebar_class_name: "put api-method" +info_path: docs/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' (set-access-request-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +
    = 1`"} schema={{"type":"integer","description":"Maximum number of reminder notification to send to the reviewer before approval escalation.","format":"int32","minimum":1,"example":1,"nullable":true}}>
    fallbackApproverRef objectnullable
    entitlementRequestConfig object
    + +Entitlement Request Configuration. + +
+ +Access Request Configuration Details. + +
Schema
    requestOnBehalfOfConfig object
    + +Request On Behalf Of Configuration. + +
    approvalReminderAndEscalationConfig object
    + +Approval Reminder and Escalation Configuration. + +
    = 1`"} schema={{"type":"integer","description":"Maximum number of reminder notification to send to the reviewer before approval escalation.","format":"int32","minimum":1,"example":1,"nullable":true}}>
    fallbackApproverRef objectnullable
    entitlementRequestConfig object
    + +Entitlement Request Configuration. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/set-branding-item.api.mdx b/docs/api/v3/set-branding-item.api.mdx new file mode 100644 index 000000000..c4648eb17 --- /dev/null +++ b/docs/api/v3/set-branding-item.api.mdx @@ -0,0 +1,96 @@ +--- +id: set-branding-item +sidebar_label: Update a branding item +hide_title: true +hide_table_of_contents: true +api: eJztXNty2zgS/RUU92GSlCj5osRrvezKl0x5ykm8vmwebNcGIiEJEwrgAKBtjcv/vt0NUCIlOXY8SSZJ8SWRRaBv6D44DYO+jXQuDHdSq4M06kVWuB3DVSrV6MCJSdSKHB/ZqHcelV9Hl60oFTYxMsdZMOd0LC3rHx0wodJcS+VYkafcCcukGmozIekMPjGumLiR1oEYNgjymAQ97QvVZ05/FIpdSzdGaS327vjX//X33hy8ZbxwY22kmzLQZMQfhTQihfEs4VnGXNDfBmtzbvhEOGHQ5ttIon05d2N4pOAB/ET/tSKbjMWER73byE1z/N46g97dtaJSQdRzphDL3gqGMpgegmZR9wNtGggwEYSJKxDRisQNn+QZakjFkBeZi+4uvQ5h3Y5Op2jDospEKyeUw0cTmCLBLdfBWMYQWLJ6yX49+F0kLqqaf146mxudFol7iz9d0o+w6E4Ki/N9XBbjsOh26XLN3Zp7SWGdnsTlgJgG3NWVP6gmDGbB8Ln0hQeqyDI+wCcYMNDCE5SwUzin1a7OtHlY11jcsCueFeRXgnN8kpIkNiBRNRvW1ra6e9tR0HYlDqX6+Nd0ZSChrmJ9ff8VqVD8So6odP6airkcNuDmHmWQSjJ7bfSkn6ZGWPuwNprBhjCF8TCnKlrp2Ig8m/7bwjAChXaiKR0yPZLqYA4MPHsDk/noEclBU2ugMglTq6pRyVBm4sRBInKTrpLrJcA3A6m4mS6nISQ4yvBoBHp1TcXFxc3aWv2fjegO9DrpaEAVQ3eNADCExzjAiqRAICN0OrPC7GKl37g+IBwWrExVr6yg3jWMhIL1eGFzrayv2I21NfyvbvJODYc8AiP+VKCE53kmE4pc53eLsz6FI18HJWYg+BMCwz3avyZQrFD57YBjhfJvBSQrVNtQ74dQrWfHhw9rLkyG+3U5b7nMV2n5+vC1pPQeXAmI0l0FBruZhJpn+8bAQsbsWLjCKKBM0nOWwD7YAOgHUiqpYP1l2v5ycJEKB+u1q9NHxOW1VCIeGS7RQkEmJzCRgcQrSSgy0UYwL7KkXTSuXYscRKK9znZ4Cv56/3aDMxhBw5OPGLmV+0HdoDMlYT4rpzCZUkHco1ZsCT54tba90R2+6nK+8c/u+tbLwfaQb26ubb/cpv01LHS1HLgxfHnj+VUoYWQCuQjUVv4JAYHdwwb6TMphCoKqfXgNSMYj4o+M1o+duRnsZbg1tRhnO7tHrLvFMq5GBX3PRwtBUPHZyep6QcHvjBxJtcoUoYoJbnx7+6/7Z4en8M3x/n/O9k/gE8paajb6WEEppiWYCrkw1tdkcXDgmltmRQbhEGmbvQhSX4BDXNnqQOl/slOL22XYlWBG0L5iRlW0x6tqKSV+H2fPZFu0W9AEwHdQ5ckYwNPCBFhCHP6inyQid/FhiOQLNhY8FeZ5mwFiSo8oHo0tzJ9iNwGwiKXrBQwLKGXPS3QBu552MhH1tZiHsr4acxg5rC4KFgdY/nCe9BNXgHHkZrUKZ9kSTAzrI9IQubp1p5WgUUinyuEuia3cFMJoDEQYN1ngDpYFOMLlsgA8qhw3Q6wqOhLcBTjec5qeJbywj6i7owzgJybXZg+uRCg+i9uERyNajXKZAiLBQ3SbJodRs+UqCx/YpMjSpnab2m1q95G1u/jwOLRA4SlRn/Vl6nOmwmkRbp5L1MdQ9ihdHin96YmYX8gWg4AEivTb+9NwIAXjxU2OJypfkB/5rXzJ+P5sPfz3A6Qfs8WqrQUaSHEMx2uARCLtkd1ziylQPlSby9peazOQkKBqBUUE1DRsqgvGIWSmUAot4bbFUi2s+sWxMQd85FAR1noERK0qjT1Hb5hkwySb3ajZjX6a3ahhkk3tNrX7Y9buJ5nkzCqqlsCTbDGZ4O8FKNPCc/SWMxjAysN4Nis5WqpFtoLC2IxjRXXmEA021gfrw61EdFPeTV9tbg83klcb/OXW+tb6oLuxFVX3+vN5Hc+KrF5TlfX260ghBhJ3BTyuUJBc1mmd1o//ILxGDBHWEHpmvBliDiG9nHPH7jJ3fKsd+AaCgTuae44Xz44PUT6oJvEYN12YRCDN9qGD4dwRpcQc9r8cbqhjQx2b7afZfn6a7aehjk3tNrX7Y9buZ1HH7kPUsfsZ1LHLkGINkWL9ndQxBd6B1GwIiwI+JAWEVyFtzMEV+DS/3Efww81IuBnRq7HIje1lFnmqNXvD1bQkS7Z2Eqnm4UJ4g7ETHGvKsTCAsxFApGKAWhLYLWaVnAjkpJA/LJMTSXWMDoFcM437Qwde+Zop822mRaokK8BCAoVM49mrhhyTkE5iiPQPJNA56AiA+guecU7mVwiefB7MjtHjQ/SY7d8kQmDNz85/X666JXAAxhuEixO/1vdcF/Bn5lxBGyFucg9fMwraUPWGqjfbfbPd/xzbfUPVm9ptavfHrN3PoOqBDd1P1WHAo6k6jG2vsRmXek3Xm781Y6dSCRZQejOdEFdP5xyceAWkEhqUF4Qh+GZML+qU17Vt5xavUd9FeFEdKaG3pjAZjBo7l9tep3MLiwSLc9fmuWwDdsE6uanS13gvt3O1uQJy8IapL69wWRtbBnxhyCtpU2iNxOz1UEcKfKD9bXHI0/L67yfll/fPp9B+MC+mxSDTQybR12BmDm3EL5ZGtylzlnwE385MdveQP//d/JQfXsg9fqwK3yd1wXiGV5br7qH5l/P3Ck6Qb3vtS28XzPcQPOnfWFL2DodtsB3BDTQD/vLLs9/enz5nI2SZVOWFRYIrJLYFUCdHkCKEYv3yIghOoo3F6GI0JsP7tas2WDVsmIHD7EKdCMHOD0IQ3gK8HwMeU0hxkiAIwFmXz8qVScWVyHDna9cuhHdkqjoQoQ6vzXtOuxy1A5V71+0LFbM9ieAjcbfGMcFF6u7YeV76xSt+PdWIf5TSYi8tJmn2+YIVPrTnib+6nUDpogieWYrWk5V7eXFFHvZO8A1KXbQBIxHsqF+QSspVe7IdNXkxyqvbcaHejyVsofVpzCMWs7ADZik7YMlYayv+xRimDpbB+aiAKnqyWdeoNKaKiDfWKibFXmUsYyCEZN8hFIbyycQHuCETH9H+aIRK8gOtLNT8B2iXU/ah5jN9fQ77Jo5MdWKfbDMqjFFh7DHABvv9toSJBbWNPhAO+ATYna8/IUEwtIJ5XtZKVCfxHZqDW0MCppIUm/f8D705wIVPjB7g6NkYgGDk07MrY/juZpCFe1MtWOVJwGIEl+2ltyoW4ubtnf0+E7fJ781f9Lg/PzB5p7Lpl0bpe5Dk+8HdvwnxGqT5GZEmMFxMN1IbWoFqknu2tnx8h+fLYwH/wlOqVKLS0Kj41z+Rw1TF5Bl3mNNU08kYX/TG83DBHTK/FuaVnlAdAt3F4of2jgSN6E1QAwZzaNVkBvLa7D10ViqBEGNXhRduQervOrRXJxDlI3qlfq9cOCBQk0mh8GV4MKKYMA7p8cDqptImhQchaLKUKD3TRONms8qKxLTBULSpvzAT+26IJ8TQfFYW8QFdsIY2HA9DIOdvkEZzR45FRlmG4+r0+yHZkDnxWGQ5vU8MZkGXVtHw5uB0SSIIU+F3EtqMOmGS7eBYEIKtjk+GzTZ0c/R2qrYOmtCK3DN6pxbo4eLbrbV0up0fiX9Xfxkh7CrYDnRyPL1CJwvfnvg+8Dya9YEwvqfCXwsYQyDw4e0tnm5gV3SHX0NXj63z+eW86aFmEdYIP0OTOQQEWPzzCdXoPDsO9j6n3898zh9VWOlMeWCnpvNeHV+n/CiwxSd3oBUGh+gUhoz1j8Kxf3w6pR28nLrqLy9gq+gn+cOdyvClX39gXzZruI/OMCkH4e89TPzRAcolsa35R4hoIEOruED4gIPu7v4P8rur4A== +sidebar_class_name: "put api-method" +info_path: docs/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 branding item' (set-branding-item)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Update a branding item

+ + + + + +This API endpoint updates information for an existing branding item. +A token with API, ORG_ADMIN authority is required to call this API. + +## Request + +

Path Parameters

Body

required
+ +Branding item updated + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/set-campaign-reports-config.api.mdx b/docs/api/v3/set-campaign-reports-config.api.mdx new file mode 100644 index 000000000..c3099894f --- /dev/null +++ b/docs/api/v3/set-campaign-reports-config.api.mdx @@ -0,0 +1,88 @@ +--- +id: set-campaign-reports-config +sidebar_label: Set Campaign Reports Configuration +hide_title: true +hide_table_of_contents: true +api: eJztW9ty2zgS/RUU92GSlCn5lnjtly1FcaY8lYw9vmweHNcGIiEJCQlwANCOxuV/39MASF1tZ5Ps7kxKM1WORDa6T1/RDcO3ia6E4U5qdZQnB4kVrs/LisuROhWVNs72tRrKUbKROD6yycFl0hfGyaHM/CLWUNvkaiPJhc2MrOgFeB1fC3NjpBOWZZ5JHQSxoTYsi+uYCWI67yHw91oaUBtd4Gf/8PT8X71Xb49+ZVzl7Pj05/CtAyxWZDU4T4DnNrmwwgClE59dr3ZjwihzddBISKOENIA48JCSqzvgNZAorHupc3C69V8BAHZwphaL6jSasmAY1p/VCZgygqAcMeJVVUQDdT9aWn2b2GwsSk6f3KQS4KcHH0XmyLDSFWJZgF2SUBlylpPCEhuZQxps0HPOyEHtRF8XdansjAhuDJ9goaqLgg9IyCrFCmkd00PWMGS84Qi/BZYbCWxWzrK2IFGj5G4jEZ+Bm3hfJkNprFO8FFhQ8Pjx6s7/R9a2lVY2oN/e3KR/5pGcjwWDhhaARM7WBv9Gg++usnG/kJDKDo1BFqZQ3dVGwdpyyBzMH1OCDZATTFom1TUvZN75FnvPmzEXjsuir3OxrN2ipV5LJdKR4ZIQCg85w0IGjtcyxwpWaiNYYEkmJRU8HQFuDUWW6Gyxlzxnp1G/flQGZnKGZ5/AiwrgY4AulMR61iyBC301u0es2BN88GJzf3t3+GKX8+2/727tPR/sD/nOzub+8/19kl4Ka/lIrIqiedE/CyWMzFihM3jkDxjECG5jOfXCV0TNPT7wPL7A/pSQgbZVM+JlVG43GGcv+ydsd48VXI1q/5yPFoyg0ouzpZyA5oHxsZEjqVZBEaouKchfHb7uXbw5x5PTw98uDs/wiXgt7Tc9hWjNKSwBFbEw1jcecVTghltmRQFziLzDnkWuz6AQV3aWUIZvdoIqVCK2hrwuHFZE6StWzLJmQ6PLuVTKwt7EnsiO6GywAT0rucvGbMAtFsCFRP6sl2WicumbaMlnbCx4LszTDuvluSQlecGQjWCK9RMwYjzPKXUDg2GNVAYY6ca6dkxpJzMx74upKRcrVFMT38w6hZIDyB+Pk17maoDzas5mYRstEWL0DzAHy82jO58xmjfpRDmeQQteFBOY0RhYmKFOMuksi+WI3GVReFRD11YsKoGNWr7cvQ1gXjnt32W8tl+QdycFyk/qVWtfXIuYfAgDHauR90bjpliR8JLU9osjVeuuJvHZUIoiX+fuOnfXufuFubv48jR2lvGtb322llufC8UxH2jjN8+l1sf46FGaNURhWAmO3GAwSGyRfnl3jsT+JBTRi88VjQzfsT8KW/kS+F7rj/B8QO1H66w5XxBAb8c4bqESifzA454iTqZd4s6ytNfaDCQCVK1oEVE1DZvomnGYzNRKERJuN1iuhVU/OTbmqI8cGWFtqIAkVeVppaVy605y3Umud6P1bvTj7EbrTnKdu+vc/Wvm7oOdZIvKZ0vsk2xdltxMQqTF96QtZyBgzRkna1POu2qxWyFmrO2xkvnOIRlsbw22hnuZ2M35bv5iZ3+4nb3Y5s/3tva2Brvbe8nsXn85zeM2yeZzasbfwY/exGjirtHH1QrBZZ3W+fzxH8xrxJDKGpWetm+GzWHS6Qnj9v6KU1yt2VuuJk2HZOd6SDW1EdU00JZEaxpaEHA2Ql1UdBQsgYtCSZYCXAyChhWylD55SQvwNZO0N3RQJSRKE2StFKmyogZCXwkKTV2zRmBJKCmG1POBg+9gR6jO37E7jS76pk6enZLGb0hjdvg5E4ISve3cn6863z0CeEM14iw4+J6D3jDtcIUAwEAQalbbd67783V/vt7j13v8j7HHr/vzde6uc/evmbv/QX8eu6H7+3MQfHF/DtrOJmt7qdcUXP/zNt2nSkTgw5vpLKuNP25uenDfVyCUCFBV+xrC6Q5M0m3uv9ju/AWY6fWGMAIEcLUpsGjsXGUPut1b+Ay+uuvwSnaaawpK33QyXXavd1ZUILoqELINNSyvM3/y3Ds5inNGx1vaSArmUPm8gGB3rxuFLezvz4gf5E93HMihE12j1nk2GwyBHwPLPwbMClPFT9ZTd3wgLekI3S5McfeYPv/ceUiPwOQePVaZ70FZoGdAuaAewb+aXno6o/Y7SF+6+jTdUmhk214Sdkxk2+yl4AazQfgtxpNf3p0/ZSNqOn3S15b6XSFpSkDanCBEfFHrNSf6tMjvM0bXo7EH3pv7nQklERsWUJi9V2dCsMujaIRfUe1PUZ69SWmR8BWBVl09aTyTi2tR0EbYmVqSAk/mqgsLdfncuqd+0/PTgVT4WPqnnfcqZa8k1SJJmzfRRBX9sMcuq0YvPqPX14L4W8MtDdxSz80+XUARTHuZhTs4GTKZWPDCemt9tfDAL53hR6MUnhDXRQxkiYhj/jddWeO1r8Yxxy8lfvM43qt3Y4kddX4ZCwWMWWyIRc6OWDbW2op/MEahQ2lwOaqRRV8N64aEpj4j0u3NGUhpEJnKFP2hx/cGiaFCMPEB7c++PdHo3FQeUvKD9yxy/oO/lvhhTmf/+BLbKFHmOrNfjZkEpiQwDTXARvxhl6LAQm6TDr4OhADoT/3vK0EEOlPzAq+VVd2z7/o1tDVkgOq52OogfDmYFrj4ifkXRN3SoARTe93+7g/fWeRFW9WcsZqDgUULLuMtNHbIBbsFvO3BFO2afzZ9SePe9PzkWBWT712l76kkf566+3+qeOtK8yNWmtjw0jnk6fTq9mEzmjx0Rffeu7KYxhG9Xos4aMzmTGj+lg8H6fR6LPATb33i+0YdY5Af7HxLNMumKrijFPElIhtL4Y8VKsEdNZIbFKa69GmN7plqCYZHz2hkQIMaYNHc8oEswK/D3mFuUxk8RjMbXcQA1486Dm9ncNoJ+Zy9auIA/VhZ1opuGgNEXTKOaHskWHJpszrUNIwNSjSaad8VtquaBKcoJFN0/PRiSns8pPNnjLYzMfGILISEjYfPMCR5xLsIg1GryKkofNAS3Xw3/xhvBGI6FkVFUyMKMnozMSPh7dH5EkcwUxZ6YTrXZtSNi2yXaMGEJqcQDDsdzIr0qNLWYcSd4Xsm3OI19uVb5nOhdTs9fP9v/gFF3H9ocOhWdOxF+OswyIQB8jJpB8iE7u6vGiExlIyhMxHf3tIxCc1Td/QYyUkz+OXVdFyibxASjkv8zPlJ0Jgez+fT84nfW+M8vvyLB5rgwopwBPMg7dXMWHxyQc4dxD/yKMOAb/gNqYWfB8l7/I8vugqhRX8JQs8xscdDHtAEtk0Ps2oLjx9Iy7u7fwP/ZBAO +sidebar_class_name: "put api-method" +info_path: docs/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 Campaign Reports Configuration' (set-campaign-reports-config)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/set-campaign-template-schedule.api.mdx b/docs/api/v3/set-campaign-template-schedule.api.mdx new file mode 100644 index 000000000..339f7aead --- /dev/null +++ b/docs/api/v3/set-campaign-template-schedule.api.mdx @@ -0,0 +1,167 @@ +--- +id: set-campaign-template-schedule +sidebar_label: Sets a Campaign Template's Schedule +hide_title: true +hide_table_of_contents: true +api: eJztXGlz2zgS/Sso7ofYKVGW5CvWftjS2M6sZ51jfGxq13LVQCQkcUKBGoK0o3H5v+/rBkiRknwkm50jq8phmQQafT50twjeeclUpTKLEn0Sel3PqOxQTqYyGukLNZnGMlPnwViFeay8hpfJkfG6V96hSrNoGAU8TxQTjHfd8EJlgjSa0g2QO1eZEdlYCeOIiGGSCikCN0VkbpGmOBniejlMxqmS4UyoT5HJTENEmbiN4lgMlEhuVHqbRlmmNK5lY6av1a1ItGqCSaOCHLdnYPTOuzQqPUx0pj5lvTwbE/NRqLvF+n6xfjfNtXd9DwGmMpUTlanUMIGIxJhKTG14GjfwWxTSKuB0Ir3unZfNpnTVZGmkR959w0vVL3mUKqgzS3O1qJILcHtyJJIh872kCEgIMqUiQpJIfcKomBZp7QxUGKjtV/uDcGd/0JGqPXy1pwatwWB7L1TKIwlofWWy75JwRvwFJL7O6KOcTmNnta2fDbFztyxIMvhZBRmWnabkG1mkzPzuoriL0h2R5iaRVtbsZCsJs5V2DWSodEDm1mKkNN1tCBqRRRMlsFyUhGIYqTg0wkxwQ6UgJLVV1jgxMDpxAEKanAHCDaNRDm03xWu4llMVaIqj3snpv6orazGWN0q8GCd5al4IuHpDDPJM6CQTL0I5My/+imkfjo//sXLeIIGvFZOlDt0cosNG0vmE3MvOx4U3795e/J0/9d6+veyd8sfD3unx26PeGYXK3KxuDnxnAmONzSprLATWVAWIQKj5dhwFY2HnkVdVgyjFvyCLbqDvdzqeiRsZRyGHYMHSfDCtZ5ri2DJlun3d1++0eK0GaS7TGUv8RqbBGHdeWhucnpxf0C8gC4cTfa/T9xr4sd33aPYxjD8T2463hjCZhDfBuSMtfpCaqW78gh9wmXi2+QjdNhF8iXkYiYtie04+u00K4Qcqu1Xwjx/y2LJ7pAI1Gah0Tvms9/b74xrpfctyu7OwRKevvzAEjuEIdrUsEYbtNCtY5GUrzkKS4ldmq+4SfAcOYRmtrCrTVM6WFv2nlcehSqEQaVQIWORrqmRrAjTALNySAwQoaEVAH7MSy0qGrrw28BFDnYIqo+nSSKVVoOo0PHjZRGb29t7OEsMnhaILq3GAQ9cOFmiY8e5rcHplVyyVQvxQDH5+uGDWhtmsxkpkXKhQeDTFxRgX8LdY3O5bVSSz8dLXhOd9x1Hfs9glxgkBWBgNhyqFtrFeJkWopkqHFADOJGwNmKygyX5qsaBLLJb2hII+io22v79JIxyw1IewyWnMdrshTvHXbzebTR5fxHpXRHZs38FMyS4JH5uEoOxZVP8qgIXYhSOjuuLk/J3/aq/VJiFJwdiSE6DqTMlUbPQ93293ML3vMS8F/i1Nw8hOq9OqDO7rtwn2Q6B/Vk6D5hDbJp9Ok9RlFhQorMkGx3wJbGECqgTtbjQP5kCzer8dw+kQ3zdRqMK+5kziEVGaDDkL4Hiea9LWU8hlnQR5SQIGAQqxNOQSs5qWHyECrVsyr9NkwjM6Lcp7Ev78BLVlyOu0LOadVmGaoV10dPgIH77f2vZbHTsN4pdzGmCo0y5ndlfsDLg/n/01kZXd9TfCVV7r/wFVOcv5fFilaY/jai2C3A4+TpXiqWaeIgzJ01/13iDz10GcGxB4xDFfrcoPjnJSNzI8Q+mosSs8FhcHNix2rX/3MrFL6+sk0RZadt+/eYSH3XkiwT/3v7ajWw19056+5N1V1//feLr6NI3s6FVmKRmiDcGnGuWRGOAtncoYOQRvLiQySiTKaOAaVmMHSDQkFkmAUrVe4QEoO37rwG8fiPZ2d3e329kjPRLdf0PnVKQ/5T0XBR+/YgJ5UG7cdociV1NMVCtyWzdFGqGHwqxR5AjVAC6LUSIGGgI7cptig6KCBSzTCGQQNKjvHSI8EAg1Uiz9fL7AmLrwh+Sxq01mEemaNJHx2KIt4XcqfsZO+IY2wJhr37piznJtCndu72IHJf5Xbp8NYhHx3iycpaL1eV23iJIuFouAg8vvr8pRl4ftYhjJ/Q4WAHhSvvEA94ohs6ie2mAdjE6iUEejcbaK20rt+SS7rWdxiywAW3nbsfxjUb89qG4WyZV5YkPVisLNwhzDKIUstazTOsl/K1P7eRbgUUvF96pxVQjbZhX8C+ZCVgpJHBYE4sitt9r/bN7U7tSKVLFbhpXVEWedv4n0nNe1O7jGyXpr7o6wXEWmTD0gk4vnpNIuaL+iKKKUfoUIZRfkq4nAtUOr47dfMe/39xZGzBS7gEWFTmtnmfu3iXDtMeEDA0Nqjjkkd100cSuBankQIIUY5jE3jKj2YWDU8+kAvQFNyvKUdsZIOyKWgyZh1E6rtczBYRzR9OM0BQr74qwkMKxxMUjCGa0Yae7hkF98pb5eqDIZxYdJ+Iy85DUyKX+Uyog4VMxygImujKKdZZJAM5ZkEc08ro7z0ESzLb6TIeS18h06YWirS2XwEbSes9Vd6gjzRTFFuO7WA8uqfSUHe62Dzs5wb0fKzqud9v7u4GAot7dbB7sHB9yAg53l6Bn50veUZiAs4iSARX6FQlIloXtmgBdfkRg9YAOm8Qz9085ux5ZiOn4Fdbip6/nd4Xuxs49dTY9yvi5HC0rQ/uU5NbPzOJYDukRdakhuCb9Lo1G0MhcqMs6j49e9y1NOOo9/vDymQCRaS73/ni4iCqzCF8bJra1XrQAcVyqGOqh3+9JRfQmBpDbVgZH7BmFmoEz41lDmcYYZbvUVM6qkbSVRDaXAfh0gNqKmajYQtbiGJA+IXMt3X/YQ89PMP3WafCnGSoYq3WyKXhhGJCSyT5f+T5A/IPxlGM5jf5gjlFXZRNBJFgWqbou5KuvWmGc5p1WjUHCA86f9pBdkOZhjMatRWHqLY7FAvNBprs7dxSIKznRGtRxGYrsLkjSFhhkQo8yUQMhJ4ETqYlyJWPf3c7EY7t5YZo6yhO8FMjfPiLv3MeDHZ9HKGzfKBZ8hHHZNHbJGYSaHSK5jwpOL1k+hiyLwbS67jt117K5j95mxu3jzzGU97i6nPu3l1OdSyxz6TXnzXEp9ygyrGGS/bLaGbAiqWa12fvhwgcD+iPIW47mcV18zP7Jb+RLzvdIe9vqgqKuLrX9uC2KQ9WglGAKJVNhlvucce0XSutPaXl4NJfoggoPqFSkiUDMVsyTnr/uKCl+aBnfA9YvMfnspOYO1CEir6tCfJqhk1pnkOpNc70br3ejb2Y3WmeQ6dtex++eM3UczyXqX3+VJJp9MZDqznubu28egMKDsv4ky5MpWZDVbIWKizLG8eubgDTrtQXu4H6idUO6Ee9sHw06w15G7++399mCns+9V9/qreRyXQVaPqYq9rR09+3RAeoM8LtdwLpMlSVhv/0G9qRoSrBH0lHkzdA6VXs9zx5U9zgyygTByx/SB9uLl2SnRx9JMnvSW5GmgKM22qrPPYZQPVfBzmevUcZ06rref9fbzzWw/69RxHbvr2P1zxu5npY47T6WOO5+ROu4ISrGGlGL9nqljiLyDUrMhjEJHbPKUHz1O1RSi4JPrPrqwz2Q6UlmZ6NWyyM7BchZ5kSTijdSzIlkytU6knquL4A1jJzQ2LcZG9CTBCBCpizMe5FX0jBJyUjr1EkeTiOOYBALddOb3+CkqGzOL36fbpwLBIYMCPU1F697KCO6khpT+gQL3QUcA6q/Y43TW+q/6weKMJD4licXxp0Apivmy/7u76ikBftqN4OLc2vqBxwVsz1xqlBHq09TCV5mCrlP1daq+3u7X2/23sd2vU/V17K5j988Zu5+Rqrts6OFUHQOenapjbLMlylzqNTnXb56xc6g4Dti97SkAfmjhfv7s6kTBlYihac4YQifQu97W0sF1s3UXhfdbZn5I35YDlrs8jTFrnGVT093auoPRYKz7ppxGTWAZ7JbNdHLbDJLJ1s32CgiyhyDJfQBiYR5wCdF7f+JqDvt4chqRN1vo4wWs4lk48lsYgB81eJQ+na0ni85QjghLpkHHTZxn8WWwOUVZ8cLw6CZ70pKMkO0yje+fkuef24/JYYk8IMcq9T26FsYLcLkgHrF/PX9dAZ1nmNjVl15aMN9TqPPfWVrsHQ3riO+UTOm8PD8Ms/HDh4vN4jAMop6OQY2EiqhMQNy8h4swqvWKB0NoEm80aZKP7FsVerVHbyiKxDCGwKKvz5USVydOCW8B92fAZ1YpTVIMCTTreqOwTKhuVEw7YXOuSXK8KNRb0NCWrM3b5F2Py4NI22M4uNrsa18cRQRGdL6HxxTnfajaE1fTQi5ZketLmfhLQc231HymZjYXuLCqvQrso9wBQplIyNiwtr54cUvPr9CjWgpXiOoiD6QJx0f9gamgsNoX81Gj5xO9Oh99/YGPOtWnCYtgwmBHjENxQm9vSIz6mxDkOhQGV6McUfTFbPH5Kp8jwu+0Kiz5dkk/8pEgMn+nCAxtnUkOaIPm/CSxrRIOyZ/Ysoj5n/hQxk81mfnyFfZRGhkmgflinmlBnxb0LQYYx7/dpsixENskA+OAdYDDuf0ZCRyjFcyztFaiOpPf4jm0NQRglamYadf+0p0DnPsk+AaNLscAgim/Lh8hswfhmRbtVTVlFZ2BRQ0u8xsn2CIX9Gb5Lb/fpG3zjyYvSdybN1DoxRpfG6UfQJI/Du7+Toi3RppvEWlcxkuNyLP5q4uOi9qkDKvyzTqffU6v87wjgItTnnM2bXFO9TzxysO89bO89sgrERkmvJKri6oRblPV5V4mNdvHCv/jLsMUc4Kqbf5arCoZKhcooBnQgnGkuAsyVTKjtLdBQZVMGISQ6xPyuTdgiFGKMUAsg1RcDqIY9JriA50ID6AgKjHp6WNQ/TlxteY5XOw9eag4KrwW2eNkkmvMJYDJJ3Rm8CnXDiMT5BaBUXFqVUjGLx8R5awCjihmSBVNLrbSiXk3pHY5KvGKBz+xFhzYuF45FEkWcS/9mgtypmJ3uryxUHs8RRth449VPCWDY/tAJqkqK7w5uViiCGLafUGTpKMtN8ls0Vg62g/hrTNsN1Ha0qVpYjJU5BW6/A42Wb6lTRTvdUMZVXm1W823Ki8N+11e4ebijQqgrSn170iy3BZkthK+8pYrYUzslu9mY7GuKYZNRsPv7qjjQ5XhPV0GzFA74ep6XvhxwQxT0WdE5hAouPjytqpeNs7cIfVN/s7qM1/ptlLCoo+pZ/MWhoePHxV1PiDaPb+bg1tTzK294b4L8S8qLzcgMotf8lCxbGfYdtejY68rLYj3l+SZA/c+uYltpqTyFhfp/67Xxx/8kkxtXGAQX7/zitYkxliyRbq4KltyH2AUDPsPIgDG3w== +sidebar_class_name: "put api-method" +info_path: docs/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 'Sets a Campaign Template's Schedule' (set-campaign-template-schedule)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

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. +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 objectrequired
    + +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/set-lifecycle-state.api.mdx b/docs/api/v3/set-lifecycle-state.api.mdx new file mode 100644 index 000000000..cf4a3b3ed --- /dev/null +++ b/docs/api/v3/set-lifecycle-state.api.mdx @@ -0,0 +1,96 @@ +--- +id: set-lifecycle-state +sidebar_label: Set Lifecycle State +hide_title: true +hide_table_of_contents: true +api: eJztW1tz2zYW/isY7kOTjCVZsmxZetlRbh13nMZrx5sHx7OFSFBCQwEsAdpRPfnv+x0ApK6x3Wxm22aYzNg0CRycO75zCN5FOhcFt1KrkyQaRUbYU5mKeBFn4sJyK6K9yPKpiUZXUf2AuScmut6LEmHiQuY0H7PfzaRhQiW5lsqyW5llDAQ7ZZ5gPOOKyUQoK+3iB8OympohasxqZmeCaSVYXugbjEwwI2F+snEPY10UwuRaJVJN2Ukgxs4KncpMtD+oMch8FApL2xl7e/7jf8Yv35z8zHTBxmcnjJd2pguaATYL8VspCyyChWMOTi0xj2FtiGxEXNJAiH0XXRpRvNDKik92DAqkCpmoUSVLq5ak5SQZeY6j68/QT84LPhdWFMaRkqSlnIPIXqTwAH/VZGQSbetTsJOXTKdO+mokcRzW2IsqMaKRLUqxF4lPfJ5nRLgXD7vH+8eHg+PhQdrtDfe7uOr3D4+6w+H+wVGfxIxnYs6j0V1kFznNMbaAZqPPxDpRFsY+18mCRmwuFJNGlKVHPM8zGTsn6vxqiPO7bdJ68quILRaFdeFyVsKB8DRb8zbywU1m7lfKDjeCy0U7FDEY8OMj0d8/hiL4cdwdpiIV+/2jGOLSP5KYfMt4xnr7+/Rre+2gF3bLDTNlHAtj0jLLFozjOrfwKDi/d2azMFbMyaG+kbawhC6VHcdW3sATdqtrS/KDAZ8cTgbdI5J8MoiP4qFIu6K3/4BuqwA7DxJ7pvCIe+mnQlHugMS3MwQdTbnVxcc007cs46WCUKZWbn+XPl9kEkuwV0WBEG2xc2HLQpEGPQOVqifwQYpZqW54JpNvqNBEWC6zFzoRDzvea6lEa1pwSRwKx3KMiSFdUUaa60IwT7LSoRvXXrMKNNHusuc8YZViXwRhoCZb8PgjaD0mEi6VxHxWTUGCYCmY+sKyYiD45Gh/2OunR33Oe8f97uBwMkz5wcH+8HA4pNXncGY+9aoJa/Oi4IutpX8k08uYZRq5U/4OhRSCQ/eOAbc4pkg4v3lECiAaj9A/OacfW4sZ+GWUm/cYZ89fnLH+AM6npqW7z6cbSlCtywtKvohYPqFblM0guSf8tpBTqXYGlSrnlPlfvno9vjx9hzvnr/51+eoCV0RrayscY7PDNgW3BKvwhRliwi4FcMlDZFCHSNrsWaD6DAJxZVYHSrOSSeBbKS8zixlh9R0zVkmztNDztVCK/UbGnsi2aO+xCd2bcxvP2IQbTNA+jp+NXTJrnQZNPmMzwRNRPG2zcZJIEpJnDNEIopi/ACHGk8QlP0cgLRHKwm3EurRMaStjsW6LpSrXrYEgkNaNOF01CgUHOH/YT5AdSzDnxFyNwtpbAovBPuDZa26du61Uv1CWI+8SVlh4JIJcOIFs0hoW0hGZyyDxqGpcnbEoBVZiuXT3xjPz0mr3LOaleUTcnWVIPy0nWv3gRoTgM7T7BfBE1qjMFDJS2JTc5BpiBV1Ugc9SKbKkid0mdpvYfWTsbj48DygyPHXQp7sNfS5VKEdo89yCPoXzHqWrmuV3B2+CIfeooAkQ6af370LNQ6XXp5wg+jfER34r32J+XNvD358Q/KiNtWYLYtDp0UuQIhOJZOT4XnK8ghIPtld7rYuJhIOqHRARWbNgC10yDpUVpVLECTd7LNHCqB8sm3HkR+5gus+AvkRtuRq1QZINkmx2o2Y3+n52owZJNrHbxO7fM3bvRZI1Vy5aAk4y5XzOi4X3tPCcpOUMA1jVz2R1yDlTbaIVIsZqjBWtI4do0utOuukgFv2E95Ojg2Hai496/HDQHXQn/d4gWt3rr5ZxXAfZekyt2Nvb0akYIO4GOK5UcC5jtU7W239QbyFSSmuUemrcDJ1DpddL7Njfxo4/awvZQBjYsfhCe/Hy/JToY2lHnvSmyyIWBLNXe54EKcmHoWlpbAMdG+jYbD/N9vPdbD8NdGxit4ndv2fs/iHo2H8IOvb/AHTsM4JYKUGsPxM6JsAdBM1SGAUyxCXUqwg25hAFV6H7GMLe8mIqbA301lBkb7jjvb/W7A1XiwosmbVOpFqqi9Ibxs5pbFGNxQDOpkiRiiFrSaBb8io5F4RJ6dBCJufSxTEJBLrFojVOLaTyMVP5W72KVHFWgkOXFDJNvVcNH5NwJ5ES/AMF1wedIlF/wx5nsNb/1A9m5yTxKUnMXn2KhaCYr/u/h7tOCZyA+YLSxYW39ReOC/ieOVcoI8Sn3KevGoI2UL2B6s1232z338d230D1Jnab2P17xu4fgOoBDX0ZqmPAo6E6xrb3WY2lXpNz/d8RuwuVwIFzb6Zjh9WTJQZ3uAKuRAzl2jVa3ZHpUdQJR6CRTDp3KwenP3eMsJvnsCM6xk140bNaFhkozKzNzajTuYMFYbnPbZ7LdkVJ6dt2rOedm4Md+YiOn/rYQ0ZLytjVE3Sq3C/SdnovJLm2z4NuAW8FJyk5Mazhzh3cS58OhpN5F6hNmCezxxAGwc3cbbCZo8b4wbjRbedWWzJCtssi+/yQPP8+uE8OT+QLcuxS371rYTwDlxviEfvXy1P3FwTG/epbZ++XGwy9BuhtLfaWhvXYc8ELVAr+ZMyTn96/e7pyWrk0hH6FpJoBQXQGF3EpblydEqFJbtcpdDmdOcbHa+dwKKQYnXNusw/qQgh2VZ2V/hm5/xzJ2qmUJgmXH2jW9ZPKMom4ERlti+2lJsnxZKI60FCHr8176rZAVytIhcu5u9v+oFrspaTMJGkrpzFBRFf6sau8kouvyPW1TPyjotby1FqOmnm6wYVX7VXsz3XHiGsiwTPjtPXVi3t6rRV6VFjhDlHd5IE0EfhYPz0VV1b7aj7W6LWI3jofH9T7mcT+uj6N+XTGDLbHLGEnLJ5pbcQ/GSPXoTC4mpaIoq9m65YWbbmIaPX2V1hq+SVbsgW06Pg7RWAo70x8Qru1Ayva901cSP7iLIuY/8V9f/PLmszu9hU2VRqZ6Nh8Nc+0YIsWbPkcYAL/fs8ix0JskwwuD3gHeLG0v8sEgdGVnOdp7czqjnzHzaGtIQarjorJR/6P0TLBhSvmHtDoegxSMIHt+jwZfTkUaNHGtaasqk2wqcFtfjON/XJDb57f+mUn7aF/NXlJ4vGym/JWZYtvnaW/kEn+Onn3T8p4Tab5HjNNgL/UlTxffn73qipUdn0u94jP21Cdw3+dHKHwWI0aD/+2m4XUzZ4J/MRTF/oOuKMs8l9XEihaJZNn3FKQuCQRz6RwbYZccEtQco8cVc9dYAM/UzZBMekITQuMQRYwgLd8IjPQa7P3qONUDJtRDUfHe0H1Vx2KuQuY7cx9Yvqy8gQgsvm8VPR1JJgo54zD3x5wl0SauPRZDSWdEpVk2uHCelYV4uSHpIq2q2aKuXmbUj8ape6KVzywFpzChGY0FEkWCV+BLgU5F5lzWxq3jucfog1XbM1ElpPBkZKBzsTKCm9O3m1RBDEV3oDoYtoJk0yHxoII1U7eGQ7aqB3pFtVjKHlX6F4Iyza+DN70pbtl9/37+UQ4bHBUmXRy6rKRekpfKfly9SpalquYMFr/0ndXxYoaaEYFL6be3VGPhsq3z3QbuYAaAFfXy+rMVbWwPV0jD6RIVeIexT85D9I8dW+ZHviseKd0VadRLZZNhgiXHwX1JlbFQykPUVwXybHpR4TXFq13CwcyKgpb72OolPUzfGfq3rHXK92Cs7fUo4sm4ZPluW98FPwWN+nnKPqA//hD5z7EMMjdR2INzS+M8XQrNLcLzIQLmAPD/gvILxiI +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/set-password.api.mdx b/docs/api/v3/set-password.api.mdx new file mode 100644 index 000000000..78ca3dc04 --- /dev/null +++ b/docs/api/v3/set-password.api.mdx @@ -0,0 +1,124 @@ +--- +id: set-password +sidebar_label: Set Identity's Password +hide_title: true +hide_table_of_contents: true +api: eJztHGtT47b2r2hyPxTYOG8I0GHuhEBodgmwSViWhZ2i2EoisKXUsgmB2f9+z5Fsx05gl223vW0nbe8lto+OzvthSX7KyQnzacClaDu53ZxiwRlVaip9J5fPBXSkcrtXufgW6VBBR8xjIsh9zuccpmyfT3AwDO2PuSKNszaBP6FiDgkkAXSEkkk8fCh9QgXhDiDgwaxArsW1aMxvEBue2mMqRowEY8Z9IqdiPnyNKjJlrkvgLxUzIocRFLVtGYpA/ZTAqnXC9dMZ0gI0BPKOCTJiArkF4gazaGz74ARB/DxRoT3WqMkVyERJQV3EzJQyoz+vjYNgonaLRYfdMxcFV1CUuxPJRVCwpVfkjijSCS/SEHADR7YW7H9ibJbBZmlsQCFI4+o6h8DS548a9ldbOuw6Rxzm83sg87QBT//g9JkJLJzAGvlUBNbQldP1gtZBJJ8ph9muUInRoGD2u6e1XQ5Xlu0zrV3qqvS0WtUDllhKpPWNDVDsxkZiET+pufpBXDBB6nqYsoL0iNgctH3lMtyAaH02BH3gnLFVBGMaECncGRmD+hHZdc5Q/2uKehiq6SfBbMK01C5lqNlACwvQ+plwtFgQeWxqaPA3TNj+bAJ2F3vSDVnr9hokuQ84uBiRSThwuf2OzdaR9r4kDviQzIPjuCA0JA2mUgEDfSAB5QI5hxtX70Pmz0jipW0xlK9X2321+BuOt2LBWhzGrxseAi0OMz0SiI98Tyt4l9zEMm87N3lyo2To28z8ThhZuMSLWD3wmwoHHkp4xpm6MfGgUiDNsZRKSy6CJUNfekb7PrvnMlSgRjWRQksetDcDVUw5hIaJL++BLBMikrmACiAdoXwYCOyqIAlPIqWFWASGkmok3h6AtefmFcv5u0QMUyUCXtd8x5Rq452LVbMykhHLmmJGfbBGn2g1FUgfvIxQxzE2h/6MvCzyFutumTltOjc3N7f0nl4L7k2kHxC8eChoUFlo8smY+T9nHhYUs0N0oQKosUXtQPqzlyDOYnW/BKAmzC583CztHAqk3wHQHtzKgpMw4G5hnyq2VfsZae4FPtpgxNFadJnYVp5EdwJ5aEDAiMe+nCpy+GAznafI07UgEPwDdvV5PnIfrhXZI2auAojugCFd/tp6wdG/1uae+XMKQyLcGEN0o6voWhZ7fk4V4tf31q5z5/2WtX2dWzdYfRaEvkiRYcSDZDD9qy8Ni2vZiXH0F5TQBLIGxpwseUjNsyznY8CENoPuBbElaiV38L89MjcEpLUtVECFzYArCG3AUyEOgWbcmmBTsqzzBTlFkog1CQFXzV1jj2jcxcPmfvHsXbNXPgM3ALjrnB5kzJbY5s9edJ2hLYvQzGXgC1zwYK2cR94y2ogeO7LFIYevLYjKSB68icA/qIK2iHLBA/UmLoN4l4y4SeUeHctcCkEpYA/BPKmh91OfYWgKUAIYKTCtxrqEe/n4ZjquLqJOVJUJJzqYcx8iRBwp8LGC0GYiXpzR9IyY1q6OIIwkiaVpknQ3GtsLaBCq7wqDo1QYtEzOt5RGs26qAGbfZbN8VBjE9BpgCIJJbkQOvBAepQPqTQSPgX85kC6kgPR8KAeofCOIfenMcrtP+pJDKZDbDfyQ5XO2FAEWwfCITiZuVPIUbxVWwk85BXx4FH9hrQC1sRzcMjsAvEAjyCeAbIdP5/kzBau06eeWy+t5jQNFq0l7EZnMeU5mgCIyQhi+TbdLdadm16v2Zm1zs1wqm1/DEi2VKsNh7gtAL1Ypr6MqW8hM5u3DfPaPjydvLqfvRn6l+aYt7jqXrc7+UfU8uO0cTjc/tX9zix9b7ke5bb89Ycr17ibuw9a9qN05tWKt2m7t9Pr7d5td8djd+ujdTg5P37SmvxxIvj+9/NS4a3x6V2yr6cNd7dSZDY62LmudXvC2edrk77aleudXN9udTu9D0Ruc1qYN5gayeVd3aP/isX90zNtb57S/GQzftCqHI+f27af65W+d7Yttv07PL5RXnVQ+BqXyZW3rU/eh9J52dsrv/ZC3Hyr+YbPVr0zOT0tT/01dvq/Xb2eTRn92dNENGgcqrF7a98274tb5Zue3pvjYeXy3b3epqp+IT07vuOhs/lI+Grkfjh6rH47POpTfH9WK8rhmj087XqvZdYuPH9TRw6ed7vhk239Q3aNW6514448PH/r8zYA+VBt7e6i1VKn1On3FkQQCKsbx9kFGVZcX7ysnt+9rnX47+HR7WTpplkqdi8OH44vWbef2Ljg9OvE6j+fVy8oH9+T2roIkJFXWtwloRAUdWHBUuMclnu4f4T+sDfiQoymxpLUjxqWwiMMxptSE2kcM+Sg0/WuBtIN07+lwhdEy5Gqc6gg60jflVtyADOGBQyDCMxLHMYhZXih0nZKJY8FmMS4DT+TUakohGKY/VfwFLh1ptS1glo8E5DyLCiua1aIByGIQ4k1o/sbMioRgtQ8syEUWLQbUmhS3S9XNUkYXzZO9xgA61Z4HfVn+9HyvESJP+pcHHaJNFf4+YJ7MHzT3oIvl+JfaHsO/QDNqJ67LX2cdc8VEQsamfTrm0Bsn4YerOPLoJP07Q49TG2yVKrWt3BcgEvBq4Dj0mFQTZRqAQJi45Nexs1Kq4J8sA11MgmDfLMmDWboKuR8Wu5ME85xYRei6dIAMmXyxLOaX8tuCN5a2d7Z3doblKt0e1hxa367Udna2yjvlze36gA52tH4hJbLnqGAi9PD1Tfvk17Pu6VH3sNeDu632Sbv3yyHO02q0j+HH0qucswXizAxputIov6Y+o7BIf7VSaVllTd1ok0PfBzuzoLbAogs82Ly+SeQygEyMdsfFPXW58wMV6bAAvLwJJem3HQRKQP3yhCOFTJOs+y9TeqAzeBhfDMrYjzRcISM+kEShDHW+k9RSzYgZlKVP7TvA9RqPPRccxpN4CLio9tcXpmV1RsHndiq14VaN0sp2rVzfHOwMabVa2tnc0dbkMaXoyIgmmpv6Pp0tTX2E1T23iStt0MgjCMRnFGSvCdCTwxAeME99Wwcaxyvkj55jYBM2I3p1GQ2VMdlvnpFanbhgf6G+T0cLQhDWeW/JR4Fzg/jU5yMuvuZOB4etxvlxH+50D9+fH/bgF+Ja8iJ8sSkcNEsgFWxhbN7gxAxMKeQ65oI4GFSdGxHWDWAIWpQ0IDdXagaFnge2NaShC/X6RjT7MyPSqOeFf+xK2m+g51jjBVaAFhDvQT8EAX5AMXdKk2M3IEtB92cdR5LcgCRJoRldL5AGdF3IJHUJeCMghfEzTKbQjqHrGgTDEFyZ6XeKMgyIkAG3WVYXc1EuRsw4oBynlYLOAZS/psoIQiBOs5n2wsRaIhIj/QDNRnJZ6vopoWmRzkQA/S6McN0ZiNH3QcIEEjvhgSJRONIlDAQeEcMlESsdJ3W46xhiDgKpn9k0VK/wuzPsGi3NWvLgnkXOpxvA5B3YXE1RRIqyomk5DVSirtjxoUFkrrPy3ZXvrnz3lb67+DCue6KnuvQpL5c+5yJemgEmlkofX1uPkCSzfhMpMo+rIVGJ9PaiHy1k6NdOE3xR8QPrI5PKl4hvJPow9wdxKxCn/rkukEAtR8PBECIRc3Y13XOKtaCMqKrLs7WkP+BgoOKZEhFX75L3Zn4ohH5vpvLEkUyJnwIypvdsvpKXLNVYprNbVZKrSnKVjVbZ6F+TjVaV5Mp3V777z/Tdr1aSCVXaW6I6SYWeR/2ZsbToud4aQwBgvksicTmtqsVqBZGRpMbKZSuH3KBSHpSHdZvVHFpztqo7w4q9VaGb9XK9PKhV6rl0rr+a+3HiZFmfSunb6FGLGIq4e6jjQgHGpQIpnezrvxAXu4YY1vTOnbhuBpmDSD8ntWNlZ7l27EuJG9dmcYWkMjWkSO0kgZgGsB7C+jEsAFAygrgocD2CS73vKOAeAyx6f4/LPa6dV6+FscCfWY1hAKwYR4mNLJmFC9sNgUIdCVyp9yuAYXFgkg2x5gMMuoIdQXT+gdVppKI/VMmTLnJ8jBzrzQEMHT2p3Defe7/bBuJ9jBE9o+AXXvSabgc3UwloCEzMSurOVX2+qs9XOX6V4/8dOX5Vn698d+W7/0zf/Y76PKqGXq7PAeDV9TnAFkokqaVaaFx/eZmuXSWiQJs3kbYd+vp1c1yD67oCTAkJmkilgwgNxnCV2QINt03Bb0gJfRcg4v03T6Ah0MyXAp3wQrzpRMip3oRzX30m3pidQ2Z/uHRCW79nxo3/ZpKClqvP0XRNnNMTGClrTtBI470+X8UvqKfVp/cTGjR5PBEQmZG+DWROoIf4SWnogjabJR6Bt3Pf/fItfj5Uv8aHQfICH8+J76tzATwBKhfYQ/I/o7rM3m2tr3Ogp2kCFB5QgXuf0zA9LMgNhUuQ8ySDTVxliSB94qVC9hn1oVsw6xprby/666nDO+awBOPYN4AjncWndRqp0zrmuIgvw9FYM9fIrKKgWxE8iIL7PXuMkavUzi7ShYCtxd7IHGn5vUdh1nUa9OKdZ9Hm48K1sMgBx+jEMZ0jTMSibv/+olNIC1QY0V6Z4y8kdfxFS+tPOgz0jCQiOrJrX3astT/pLBRugb7QW92yw4gJaURBinQd0ia2PqDyX0LQdNBVrkYheNrvJkvvr7O0R1iVUooky0xpcQsqRk3fMTiGMMZEB5ixdcEioZYTjnHbG61ZiAs35nxNhmd9+woSK0I60v6O7dsLNOOEFk5omTihIvpN3kLDAt9GHnQcMAbQnOtfR4KI0FRcNLiejfwafVGPwfRhA6kai5rsmovdeRCMfhH9AKETGAjTWHAnq4FwTSJcmLwywopfFSxKcJleV0LOXJCboTd5VYV59O/GL3LcmL9RORXu7EdH6Rciyd8n7v6fIt4q0vwbI01UAuObye78CMlh3Kxkj3x8+1DGs2cyVqcp/qzTFAuHKb7/LETmKMSP2L6f3r3/io30+RwGOm3wUZeaDq+ml1h+s6wP0eLJYniqc4Tu8qCHNufBsXpOo5m4NMBoqrOJPeZMv5OaMBpgX5LHiCY9nQGgGcO0w5RBNPIBBtKFgl6JDrirPwFwoQ+kAJPY8OMuHsB6K6POvwf+faZPVB/EIQNK9+h0Bkb30CM0IN+KKw5XdmjSn20ObRiCpG4gklFxLsCAhaIo6NbX99TpEBcvuM1S4eMbc0H0UNHKBQgSNYK9IHbVCSNd5ur4hnDZ5vBbuCFmWWPmTlDhYK4Mt9jPZ+i0+0sYAZkwllSQ/qgYDVJFhAUk2IgbY6gWSoWSPlYEzbtHRQrvC8egF+3pab5cs/omxOqbEN9RFK2+CbH6JsTqmxCrb0Ksvgmx+ibE6psQq29C/M2+CRG9EUPdFLWasEwOzfKLWeO6ymXWuD7nc2NcAoP7T0+4aosLPl/wto7auGoyX8/RaygwQK/e6kUWMDpsIk0xbfVn+sVetDy4vA8Kl5jMCLMi/FXYz6lVurNTXBvPDaJPXXhmwdGnU7iJ/7+bu4Z/4UJOTLeCh5/x/lMuXr4HGIMX//kfNX2iLQ== +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/set-tag-to-object.api.mdx b/docs/api/v3/set-tag-to-object.api.mdx new file mode 100644 index 000000000..3df004f36 --- /dev/null +++ b/docs/api/v3/set-tag-to-object.api.mdx @@ -0,0 +1,85 @@ +--- +id: set-tag-to-object +sidebar_label: Add Tag to Object +hide_title: true +hide_table_of_contents: true +api: eJztW21TGzkS/isq34dNUtiAeQt8uXIM7HmLxD4wl9oCKpFnZFvZGckrzUB8FP/9npY0Y49tIMfl7nZTrlQRz6jVevpV3bJ8X9MTYXgmterEtaOaFVmfj/q6O/gioqy2gRdRbmQ2rR1d3dcurTBtrTLxNWvl2RjvajJWRxkfHaVc8ZGo3TzcbNTwbGkMnEYiZp6XrWEkFjYyckLLYbH+WFrG4xh/GOawTDOumHbkjWt1rVpqyjgWEiqTEc/AK9O/CcVSPmUDwXLr3rCIJwnLiFmr12kAtBG/58Jm73QM3PfuURoB+TKTi41aRCKojIb4ZJIQawDa/GIJ1X3NRmORcvqUTScCOHWhjAX4XryAF8MTQ8rMpLA02b8/F8NVnKqkfrSkspmRagQqofKUFNlqt08uLj71zrunnbMTDLR6vbNOu9XvdD/gqd1632t1fqaPJx/6nf7ZyXv8j6fOsXv+FR/Pu27iRff4U6+Lub+6h8vz9gnZRXzl6SShteemVKU97neZw/ewAaOvQlul7xwzPYRVRFCQN5ARQ2GEigRzmhcW9qvNr9+MDrffbr3d238b7TUPo/2tbXyK+P7wcCva3tneoeUVT1eqS+VJwgfExtu5CuhvOXy0bgSPiYbF0k4S+BExexHSjzJJJE8Z/ifHeQCwTGZuyHuG9/tjTHsoYqLEzI3hU7CTmUjtsiwPi+DP+EAkBIH83gOKQ7yUoVpCu6q9u/x02vnQ+tAmm/faHcTlI/CAm4aMsBOtrHfH5tY2/VdF0IbmEIENwra7tbWCAJhUxk6M0YbV2bnIcqOAUnrdhphkAwQlg36luuWJjCluXhyP1SiKRcZl0tbxSueogj2VStRHhktCKBzkCBMZON7KGDNYqg2cxLEs3MPRNSpOAE00ttk7HkNeL187CEP6Njz6Dbw63xAul0piPiumMBmzIUA9sqw4EHywv3XY3B3u73LefLu7fbA3OBzynZ2tw73DQ1o9FdYiJa/yuurSPwsljIxYopFI5T+hEJgauncA3OIrHPURGzge36D/PuTytKWYAS+j3WUDO8K7do/tHrCEq1Hu3vPRghJU/fJiKewhuWfcNXIk1VNp9fjktHV5Rony/OTvlycX+ES8lvaploK3xuSWgApfGOs7hzgIcMctsyKBOhAe7E3g+gYCcWXnCaV/slMLZcK3hjxPMswIq6+YMc+aDY1OK6EU+a2YvZIN0dhAZsC7lGfRmA04bY0wIZG/aUWRmGT1s6DJN2yMJCjM6wZrxbEkIXnCEI1gWmyt2JUpdD2DYY5QBhiZjXWeMaWxG4uqLWaqXEzCRdI5mzcKBQeQP+8nrSjLAc6JOR+FpbcEiME+wOw1V0XXn1OaU+lUZTyimiJJplCjMZT2B5BNZpaFdETmskg8qqArM9Z8LnXp7r0H41I9xiKe22+Iu16C9FN3opUDtyIEn8v1Phs5axRmChkJgyS2mxyoSnMVgc+GUiTxOnbXsbuO3W+M3cXB81AWhVFX+qyojS4VdSnauM1zqfQxznuUZgWRK2+CITcYFBJKpF8+9kODA3rxdUI9y3esj/xWvgS+VdrDvx9Q+VEaq2ILAuj06CUYIhOJ+MjhniF2ivKq2lle7VSbgYSDqhUlIrKmYVOdMw6VmVwpQsLtBou1sOqnjI058iNHRFjrMyCtquL6REuVrSvJdSW53o3Wu9GPsxutK8l17K5j988Zu09WkiUqFy2hTrJ5mnIz9Z4WxklazkDAigM6VoacM9VitULMWFlj1aqVQ23Q3B5sDw8isRvz3Xh/53DYjPabfO9g+2B7sNs8qM3v9VezOC6DrBpTc/b2dnQqRhF3izouV3Aum2kdV4//oF4jhpTW3PllUTdD51DpTVk7Ng+Xa8e+1uw9V9OiQrKVGlLNdEQ5DbQp0ZqCFgScjZAXFUOqksBFriRTAS4GTsMSmUoXvCQF+JppvTXMIIoPlMLJylWkipIcCF0mSLRyX2DccQkhxZBqPnBwFewI2fk7VqfBRP9RJc/OSeIzkpidfI2EoEAvK/e9Vee7HYA3lCMuvIEfOej13Q5XcAA0BD5nlXXnuj5f1+frPX69x/8Ye/y6Pl/H7jp2/5yx+2/U56Eaerw+B8E31+egbWyxspY6Jef6n5fpLlQCAufeTEdRbtxxc1GDu7oCrkSAJtq6JMLpzk9tM3P3B+o63OuhS0JUEXowuUlAM86yiT3a3LyHjWCbhwafyAZSF8yUTZW+a0Q63bzdWZFx6GqAjy7krDiP3Elzq9cJfUXDadZIcl6f6dwCXs9OFnJT6NudCT/Jv7j5MdU5cptjs0FXXIIjudeAOUEX8ZN11A3nOEsyQrZLkzw8J88/dp6SwzN5RI5V6ntyLdAzoFwQj+DfzO50XVC57Vdfutk120KoRWsuLdYlsiZ7J7hBL+C/tXj1y8f+azaiItMFeW6pvhWSugKESQ8u4pJYqzjBp0luXzE6H40d8FblOxIKGjZMIDC7VhdCsKtOUMIHZPdzpGOn0tbsjhhm3bwqLBOLW5HQxteYaZIcT8ZqExra5JV5r90m57oBqfAxdW8b16rOjiXlHkmbNdEEEV1zx64mhVx8Tq6XgvhLwa3uudUdN/t6AYVX7VXk79xEiFxiwRPrtPXixT2/+hw/ap3whrguYiBNBBzVb7aiwmovxlHhVyd+VRzX6uNYYgetTmM+YTGLDTCJWYdFY62t+Ctj5DoUBlejHFH0Ylh3tGjdRUS9uTUHqe6XrMs66kGH7wyBobwz8QHtx64c0ajUVOxD8rOzLGL+M7rlmH2uyOxeX2HbJMpYR/bFmGnBOi1Y9znABvx+VyLHQmyTDC4PeAdoz+zvMkEAOpfzPK+VWd2x33RzaGuIANVxsZMj/3A0S3DhE3MDRF3SIAVTOV1+10dXPAMv2poqyioOAhY1uIw30dgRF/Tm8ZYHUbRL/tHkJYlbs/OSrkqm3ztLP5JJ/jh59/+U8daZ5kfMNKHApXPH89ld8ZOiFVl9eXvuajRdgH7+qnJxU3npqvDsivyKi7rgjihw64YGZT72fBG5fKhIp95jgb8YdQnEFfhon1xD6EqreTaThGcUai7VRGMp3HHERPCMCtINcneduvSAKpxyEppOx2jkrgEb6JGjgZQJ+DXYR/R7KoLlqdejCxzg+kWHpu8Cxu+R77Djwp9Q16VprjCXQj9PGYfXPuN0sbRR7nMjWj8lCsm0qy7LWUWiIG8mVTRc12NS2x3SuTVa4jnfemYtuJYNh9ZQJFkk2HMmyLlInPMTXbUreI43HLo+FsmEvAGJHTWemFvhfae/xBHMlIVc6Oq1GW2GSXaTaMGEOjDvDDsN9Jj0ivo2tMZzfFtxzPr+pxbdlb9quJ+d0f/3fp8RAoq6jc0JnY0R2Nx3P77JvKotNJloW8bUhWLk/p4OTqjjeqDXCF/qyq9uZg0VPYGjP0BxXelvghr3cGJf70/d7hs69OWvIqjH8zP8ocyTtDdzjXKvS8dTtUH44Unqe37D7/CS/h7VrvEPD3rivYZ+nULv0cSHcx/QeL5FmbNqlw8fSMyHh38BVcUNBw== +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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
+ +Created. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/set-tags-to-many-objects.api.mdx b/docs/api/v3/set-tags-to-many-objects.api.mdx new file mode 100644 index 000000000..eba2b445d --- /dev/null +++ b/docs/api/v3/set-tags-to-many-objects.api.mdx @@ -0,0 +1,89 @@ +--- +id: set-tags-to-many-objects +sidebar_label: Tag Multiple Objects +hide_title: true +hide_table_of_contents: true +api: eJztW21v2zgS/iuE7sO2he0kTpo0+XJwHLfnRVL7HOeKRRp0aYm2uZUoHyk19Qb57/cMSclS7Ca9Xu9utzAKNLI4HM7rwxmavgvShdA8k6nqR8FJYEQ25jMzTi+4Wg4mv4kwM0EDr8Ncy2wZnFzfBVdG6G6qMvE56+TZHO8CGamTjM9OEq74TAQ39zeNAJ8NjYHfTESsYIaRSJhQywUtiiXHc2lYZ9hnPIoMo1ksS1mSx5lcxIKlbl7rvXqvOhj5KBS7ldmcpjRYtzcaf+icXfTfNthg9KZ4HPWGg9XAaHDeqz1fXp36j5eDq1G3HEx18aKgYBwapqQ6g5Ra/DOXGspAwJDHMcu87C3YiAaFyU7TCGa6Cwra4CTTuXio9GW+WKQ6AyunH8uWC2EY14J1ut3e5eWH4Wjwun/ea4D98Lzf7Yz7A0jY7VwMO/03eOq9HffH570L/G2w/pn9+IvTj9Q6+zAcYNovhYokYUhOUxlJxxeLWIbW7zu/GRLpLjDhXCScnkgYCOlEw8SFpijJpDA06l6PxNRUaLnWfAlSmYnEPM3DjZZUJtNSzUAlVJ5Q0NSNgIGKFfCpMAMeK3bAp8IQeCRL4M/KFPYD2YJiUHzmCcILa1em1H10Nh5YtwT3UCvaJG2dvn/G0ilCQpQ+nduYmQotVCiYtbmg6A6q67fD471Xu69eHr4KX7aPw8PdPTyF/HB6vBvu7e/t0/KKJxvNpfI45hNisynI/pYjH5ta8IhoWCTNIuZLRsy+SdJ3Mo4lTxj+UsjcQ7BMZnbIJbnL8TNMs2MWAJ6MEK/M/UPpz/lExJRpk0Igm3dceSipinYdnF59eN1/23nbJZ8Pu31gUGOFbY+G2nDYe3uGFxe90Zuew6cpB/yAuBx74OkpcyMNh1eUthBRqMjJSJaNpcmslYlgCmRZmbvFOuxgd5cJrfHeWj7LtcJcOXWuuE3zOCJAZFHuElWUyFjhQ5gIWazgFVESoQlxLUoStfgMWaC0pWixszpLmmFkDGCIAXIzlQK0WjW/O8NU3X2axx+rLscgDWthFqkyLsXbu7v0p265kQNJZvIwFCJyK21xaYtLW1za4tJ/DZcONkFRF55TGetZZZtsVNNVMF/OsQnqObKFVJ94LL8nXkUi4zLuptHGFKoL+1oq0ZxpLklC558QExk4fpIR2TCBfZhjWSSRpaubDJZo7bFTHrECibteGbKi5uFH8Op/BahcKYn5rJjCZFQG04ZlxZHgk8Pd4/bB9PCA8/arg72jl5PjKd/f3z1+eXxMqyfCGDQPm1KzvvQboYSWIYtT1ODydxgEUALbWwHs4l+P95bHV9h/TJljaUs1vbyM+qAG4+y0O2QHRyzmapbb93z2wAiqeXW5Bo7Q3DEeaDmTjyLCWe915+qctpNR7+9XvUs8Ea+1jqqjEK0RhSVERSzM01uX+k6BW26YETHMgYRiLzzXF1CIK1MllO6TWRoYk3n0wQy/+oYZVdZsqtOklkqhaxrZM9kSrQbwE+8SnoVzNuGGWiFlyV90UBsssua5t+QLNsdWIfRz4FMUSVKSxwzZCKaYv7RAHBHEScdgmiOVhcWZNM+YSjMZirovVqZ8uFUVUHJedQolByR/Ok46YZZDOKtmNQvLaPEiev9AZme5unTjitGsSZcq4yG0QM+5hBm1ps1xAt1kZpiHI3KXAfCogq5ErCpCWri7cMIUG2LIc/MVeTeMAT9Nq1o58En45LNbgEMj643CTR6R/P5gJ3uq0l1F4rOpFHG0zd1t7m5z9ytz9+HgyDdgftSWPnvrpc+V8sdatHmulT7aRo9Ki7Ov32154x1pD8l8ifTzu7E/kAO9+LyQ+rv2c24rXxO+U/rDvZ/YCrJwVs0XJKC1o9NgCiQS0YmVeyWxNZQz1f76aq9TPZEIULWhRARqarZMc1uq6lwpkoSbBotSYdRPGZtz4CNHRhhfIdOqKmouUqmybSW5rSS3u9F2N/pxdqNtJbnN3W3u/jlz99FKspTKZouvk0yeJFwvXaT5cdKWMxCw4qsAVqacddXDaoWYsbLGCuqVQzBp7032pkehOIj4QXS4fzxth4dt/vJo72hvctA+Cqp7/fUqj8skq+dUxd/Oj9bEKOI+oY7LFYLLZGka1Y//YF4tpgRr9pS3qJthc5j0pqwd28frteM4TRl9j15USKZWQ6qVjQjTQJsQrS5oQcDZDLioGKBKQi4KJZkIcNF0ShrLRNrkJS3AVy+bnWkGVVyiFEFWriJVGOeQ0CJBnFLVnCKwJJQUU6r5wMFWsDOg83esTr2L/qNKno1I43PSmPU+u6+OWFm5v9x0vtuH8Jow4tI5+AsHva7b4QoBgIbAYVZZd27r8219vt3jt3v8j7HHb+vzbe5uc/fPmbv/Rn3uq6Ev1+cg+Or6HLStXVbWUq/tBYT/dZluU8VLYMObpWGYa3vcXNTgtq5AKJFAi9RYEOF0OzXYyeyNgKa/SbozyeOPTYRiQPdaqTR0UuU6BvE8yxbmZGfnDs6Ck+5bfCFbwDD4K1uq9LYVpsnOp/0N0EN3BFyaAbyiPLRHznSv1S3SsibWkqLYQZ5dwBm8uNdhYHh7OPwo/+KizDLNAXKWTYNuBPmIsq8h5gLtxE/GUrdsBK3pCN2udHz/lD7/2H9MD8fkC3psMt+ja4GeQcoH6pH4N6tryJdUd7vV1y4jr/YS6tXaa4sNiKzNTgXXaArc1xfPfn43fs5mVG3abM8NFbpCUnuAfBkiRCyadYqjfJpkNxid5jN3maVT+7KEsodNYyjM3qtLIdh13xvhLWB+BFy2JqVJwkIBzbp5VngmEp9ETDtga2VJCjwZqR1YaIfX5j23u51tC6TCY2Lftt6rJjuTBEKSdm2i8SraLo9dLwq9eEWvbxXiLwW3puPWtNzM8wdSONNeh+7yTYgUJhY8NtZa37y449es8KMeCm+I60MZyBJejvpXXGHhtW+Wo8avSfzqcrxX7+YSW2l9GnPIxczc3q/qs3Cepkb8lTEKHUqD61mOLPpmsW5p0abNiGZ7tyJS0y3ZlE0Uhla+cySGcsHEJ7Qx27okRcmmIpeSv1rPIud/RdscsV9rOtvX19g/iTJKQ/PNMtOCTVqw6TDAePnd9kSBhdwmHSwOuADorvxvkcALWsE8x2sjqlv2O3YObQ0hRLVczOLEfThZAZx/YnaAqEsaQDDV1eWXfvQzAc+L9qiasYoTgYcWXJc3TrE1PrCbk7c8kaLt8o+mL2ncWR2cDFS8/N4o/QUk+ePg7v8J8bZI8yMija906QBytPq9Ua/oSeqX4K/LLKvcJacb40/f7S6udq/dra78sGv9anPtZnNxPRdLIjmskXwDU01JV1uuHzrSqfhc4H+MWlyxDQDaq9X14SqbRcwzykCLQOFcCntcsRA8ozq1QVmQJhY1UJwTVKEptYxmGjSAGIPamU9kDH4t9g79oAoRENQL0gUPcP0t9U3hJWJiSCHFzoowQ7mXJLmiX4lBiDxhHMH8RCxG0oS5g0y0hkoUmqW26CxnFfhBQU6maNmuSCdmMKVzbbTMlZB7Yi1EnPGH2jAkecQ7eaXISMTWfURXbxae4o04b85FvCCHA+9R+onKChf98RpHMFMGeqHrT/Vsx08yO0QLJtSYuWDYb6EHpVfU16F1rvAd8xm7KH4quPq9Yi2Y7lbH+D/Mjw19XlPbs7Og0zoyT+7aMNf2Xgf1theTysYXiTqnFhlEd3d0qkNd4D29BqTQkcH1zarJo09g7k53LKh8FHSq4L9OaI6XtiLwxwfr35NQ3+lmuBOjR2lvKl38cEBnZ8HE/6AycQcSmt/iJf1/ErzHv4BAx4Us/eqS3t8FxfEeaBzfovTaVHn4B1Lz/v5fWvBtfw== +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + +
    objectRefs object[]
  • Array [
  • ]
+ +Request succeeded. + +
Schema
    objectRefs object[]
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/sidebar.js b/docs/api/v3/sidebar.js new file mode 100644 index 000000000..3e47d3682 --- /dev/null +++ b/docs/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-profile","label":"Delete the specified Access Profile","className":"api-method delete"},{"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/set-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":"Account Usages","link":{"type":"doc","id":"api/v3/account-usages"},"items":[{"type":"doc","id":"api/v3/get-usages-by-account-id","label":"Returns account usage insights","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":"Auth User","link":{"type":"doc","id":"api/v3/auth-user"},"items":[{"type":"doc","id":"api/v3/get-auth-user","label":"Auth User Details","className":"api-method get"},{"type":"doc","id":"api/v3/patch-auth-user","label":"Auth User Update","className":"api-method patch"}]},{"type":"category","label":"Branding","link":{"type":"doc","id":"api/v3/branding"},"items":[{"type":"doc","id":"api/v3/get-branding-list","label":"List of branding items","className":"api-method get"},{"type":"doc","id":"api/v3/create-branding-item","label":"Create a branding item","className":"api-method post"},{"type":"doc","id":"api/v3/get-branding","label":"Get a branding item","className":"api-method get"},{"type":"doc","id":"api/v3/set-branding-item","label":"Update a branding item","className":"api-method put"},{"type":"doc","id":"api/v3/delete-branding","label":"Delete a branding item","className":"api-method delete"}]},{"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/update-campaign","label":"Update a Campaign","className":"api-method patch"},{"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":"doc","id":"api/v3/complete-campaign","label":"Complete a Campaign","className":"api-method post"},{"type":"doc","id":"api/v3/delete-campaigns","label":"Deletes Campaigns","className":"api-method post"},{"type":"doc","id":"api/v3/start-campaign-remediation-scan","label":"Run Campaign Remediation Scan","className":"api-method post"},{"type":"doc","id":"api/v3/get-campaign-reports","label":"Get Campaign Reports","className":"api-method get"},{"type":"doc","id":"api/v3/start-campaign-report","label":"Run Campaign Report","className":"api-method post"},{"type":"doc","id":"api/v3/get-campaign-reports-config","label":"Get Campaign Reports Configuration","className":"api-method get"},{"type":"doc","id":"api/v3/set-campaign-reports-config","label":"Set Campaign Reports Configuration","className":"api-method put"},{"type":"doc","id":"api/v3/create-campaign-template","label":"Create a Campaign Template","className":"api-method post"},{"type":"doc","id":"api/v3/list-campaign-templates","label":"List Campaign Templates","className":"api-method get"},{"type":"doc","id":"api/v3/patch-campaign-template","label":"Update a Campaign Template","className":"api-method patch"},{"type":"doc","id":"api/v3/get-campaign-template","label":"Get a Campaign Template","className":"api-method get"},{"type":"doc","id":"api/v3/delete-campaign-template","label":"Delete a Campaign Template","className":"api-method delete"},{"type":"doc","id":"api/v3/get-campaign-template-schedule","label":"Gets a Campaign Template's Schedule","className":"api-method get"},{"type":"doc","id":"api/v3/set-campaign-template-schedule","label":"Sets a Campaign Template's Schedule","className":"api-method put"},{"type":"doc","id":"api/v3/delete-campaign-template-schedule","label":"Deletes a Campaign Template's Schedule","className":"api-method delete"},{"type":"doc","id":"api/v3/start-generate-campaign-template","label":"Generate a Campaign from Template","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":"doc","id":"api/v3/get-identity-certification-item-permissions","label":"Permissions for Entitlement Certification Item","className":"api-method get"},{"type":"doc","id":"api/v3/list-certification-reviewers","label":"List of Reviewers for certification","className":"api-method get"},{"type":"doc","id":"api/v3/submit-reassign-certs-async","label":"Reassign Certifications Asynchronously","className":"api-method post"},{"type":"doc","id":"api/v3/get-certification-task","label":"Certification Task by ID","className":"api-method get"},{"type":"doc","id":"api/v3/get-pending-certification-tasks","label":"List of Pending Certification Tasks","className":"api-method get"}]},{"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":"Certification Campaign Filters","link":{"type":"doc","id":"api/v3/certification-campaign-filters"},"items":[{"type":"doc","id":"api/v3/create-campaign-filter","label":"Create a Campaign Filter","className":"api-method post"},{"type":"doc","id":"api/v3/list-campaign-filters","label":"List Campaign Filters","className":"api-method get"},{"type":"doc","id":"api/v3/get-campaign-filter-by-id","label":"Get Campaign Filter by ID","className":"api-method get"},{"type":"doc","id":"api/v3/update-campaign-filter","label":"Updates a Campaign Filter","className":"api-method post"},{"type":"doc","id":"api/v3/delete-campaign-filters","label":"Deletes Campaign Filters","className":"api-method post"}]},{"type":"category","label":"Connectors","link":{"type":"doc","id":"api/v3/connectors"},"items":[{"type":"doc","id":"api/v3/create-custom-connector","label":"Create custom connector","className":"api-method post"},{"type":"doc","id":"api/v3/get-connector","label":"getConnector","className":"api-method get"},{"type":"doc","id":"api/v3/delete-custom-connector","label":"deleteCustomConnector","className":"api-method delete"},{"type":"doc","id":"api/v3/update-connector","label":"updateConnector","className":"api-method patch"},{"type":"doc","id":"api/v3/get-connector-source-config","label":"getConnectorSourceConfig","className":"api-method get"},{"type":"doc","id":"api/v3/put-source-config","label":"putSourceConfig","className":"api-method put"},{"type":"doc","id":"api/v3/get-connector-translations","label":"getConnectorTranslations","className":"api-method get"},{"type":"doc","id":"api/v3/put-translations","label":"putTranslations","className":"api-method put"},{"type":"doc","id":"api/v3/get-connector-source-template","label":"getConnectorSourceTemplate","className":"api-method get"},{"type":"doc","id":"api/v3/put-source-template","label":"putSourceTemplate","className":"api-method put"},{"type":"doc","id":"api/v3/get-connector-correlation-config","label":"getConnectorCorrelationConfig","className":"api-method get"},{"type":"doc","id":"api/v3/put-correlation-config","label":"putCorrelationConfig","className":"api-method put"}]},{"type":"category","label":"Global Tenant Security Settings","link":{"type":"doc","id":"api/v3/global-tenant-security-settings"},"items":[{"type":"doc","id":"api/v3/get-auth-org-network-config","label":"Get security network configuration.","className":"api-method get"},{"type":"doc","id":"api/v3/create-auth-org-network-config","label":"Create security network configuration.","className":"api-method post"},{"type":"doc","id":"api/v3/patch-auth-org-network-config","label":"Update security network configuration.","className":"api-method patch"}]},{"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/delete-identity-profiles","label":"Delete Identity Profiles","className":"api-method post"},{"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/delete-identity-profile","label":"Delete an Identity Profile","className":"api-method delete"},{"type":"doc","id":"api/v3/get-default-identity-attribute-config","label":"Get default Identity Attribute Config","className":"api-method get"},{"type":"doc","id":"api/v3/sync-identity-profile","label":"Process identities under profile","className":"api-method post"}]},{"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/put-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/put-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":"Reports Data Extraction","link":{"type":"doc","id":"api/v3/reports-data-extraction"},"items":[{"type":"doc","id":"api/v3/get-report-result","label":"Get Report Result","className":"api-method get"},{"type":"doc","id":"api/v3/start-report","label":"Run Report","className":"api-method post"},{"type":"doc","id":"api/v3/cancel-report","label":"Cancel Report","className":"api-method post"},{"type":"doc","id":"api/v3/get-report","label":"Get Report File","className":"api-method get"}]},{"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/delete-role","label":"Delete a Role","className":"api-method delete"},{"type":"doc","id":"api/v3/delete-bulk-roles","label":"Delete Role(s)","className":"api-method post"},{"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":"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 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 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/put-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/put-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":"Source Usages","link":{"type":"doc","id":"api/v3/source-usages"},"items":[{"type":"doc","id":"api/v3/get-status-by-source-id","label":"Finds status of source usage","className":"api-method get"},{"type":"doc","id":"api/v3/get-usages-by-source-id","label":"Returns source usage insights","className":"api-method get"}]},{"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 by Type","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/docs/api/v3/sign-off-identity-certification.api.mdx b/docs/api/v3/sign-off-identity-certification.api.mdx new file mode 100644 index 000000000..f8b6d7fcd --- /dev/null +++ b/docs/api/v3/sign-off-identity-certification.api.mdx @@ -0,0 +1,95 @@ +--- +id: sign-off-identity-certification +sidebar_label: Finalize Identity Certification Decisions +hide_title: true +hide_table_of_contents: true +api: eJztXFlz20YS/itT3IfYLvGmLr5kaYpWmJUlLUXFlciqeAgMyHFADBcYSOaq9N+3uwcnAYm0185VeIgjAjM9PX18fWCAh5paCZ9rqbyxXevXAjn3LhxnbAtPS70eCl9LR1o0oLZX03we1Po3tdz1oHa7V7NFYPlyReP6telCBmxwOWaO9Lgr/ysCxl2X2cKSAc5gS24LpjzGPSajtZjFlysO6zMrSx2G2Ex6UkuukYy3Zr5YCluateHHf0LpC7vBBkyr34TH7qVesIvJ6a+Dk7fjc6Z8NhxNptEvHuqF8nE5mc6FibA6MKgjvhtsIu6kuBd+wBwgQNfzbFnAOneDwsRk67YCdj2lWRCuVsrXtJoItKGYIwbbClDyhpNTdSd8j3uWYKe+CldBAyS/4j5fCg0MgfwfahKlvOJ6Abc8uAG/pA1/B9ZCLHmt/1DT6xVeDbQvvXntca8Wb7bW134oihoTWzUxPoEVxCe46SJp4XSPnONet3cojnv7B53Z/mx21Ov0+P5B9/jQPqo93uKqwQo2KALkqdNq4f/yKw+2m4CafRSWhsUt5WkYikT4auVG95sfA6T0UNx9MnHlo51rafgAUcG/6U461nH7qHXU3bc7Yr99cNRq79vdjnN03LJ4e/+ojZafE+em9KTNlANGIPKMo9iNdrKrXanQB91e3HvCZwPLEkEQmRtZxgiGqbUA47kJaOTt1uVxjScZiGVaJpbUJm6M/RC30XLp1Kn5mV0UdeH7wgWntK8012EAl5bgq1wrfz1UyyXoaWLI45+IEWVKeH5jaJWhJ8FvwPiSHUZcNT7TGlNdbF80J9HS9YaxqZ4j0cdYRUXiwguXhJmDt5eD8el5GVoKhrNwQaMaWJdrRKiZACKAHI7wBQCCvcFDTPJxQ1fPsPF2cD44HU3gytXF9WQ4+vXi3bn5ORpMhj88z93T4ojJPm5M30XYmSubi7BAaDZb0zVuLyWg+wIg1xdod0xqZMILXZfPkAsDbClTg+dIk9A2bbiATsjf5qiCJNiF565ZVp7JvYACxUyway8lA7HKy10oxJZo9wrpSs9yQ+AqPyPCTHAm9iILoWA0YW6cA2JiC46xiHHLUqEHIciE3jgYwqp3ghm0ednI2uzFZDI6G0xHiPzX55mftzk7TK8/Po8CW+3hBGMc6Bm2db8QIGUIlYYMBElfpCEboTLNJ+wQqW2I0SdQDRrsZxWSGqLJKUUkkktM9nASZBF1knzmMgwE+SUXGuw13nZ46Oq9PIcY8su5zEp2cHb268loOL4aX5xfwfXJ6KeLf4HxnJ/9nLt+fpH5mRN67s4jApDUOWSaxKhhLB2naZEF3ZlSruBeQQc/cLCGfL42E5BYYdL2fdbr0d+AdmqKw5JVJITsufDLYTZczkDD4E8Zc0aZgZcvN1hYIFcJH5QWcqNLWjIHR/t7NaCy5Nqs3+3UcmxOlebujixqHFvOKKARwkAuGd5jMwXpZ8xVlL2WMtlulXEZYdtGgtJqH9VbB/XO/rTT6nc6/c5Ro93q/VLLUACfE3Ut0/j9pI/F8IkzyGGVDfx/2zXjNZJFE8W+BW1+trlA9udDmtw03trk1m+euneFPRcZi6EgmjebnAI6pQpI5v8/VrILfzleeuW8hKWxvFT+JXEV0iYcUZoa5sM3KbvdqrePp+1uv3fc7x42ukf7vyATpjLZmY/NcFzCF/KEDPlRkcWi4kc5DkamglPtzmtMcdcaYHtykqb2Me3fK+8sXy8uTJO8Eyoe6e5GnYbmyWPUjHOH/ELx8v+Esls3AMF2SXLHJ6Pz6Xj68/Y0ctvyCaU8Jj6d7H1dvKK8L4OTz7G9AaG/J4s5WH2Wx0yCEJuQcRjTetjIzhKn2dxM3okcH8ziG7jaM0j1Deu8pxfNodHuFd9oMh2/GQ8HU8jRNjLm3K0KuCrgqoDrc4ArW+5kfXOz5tmt6DRFPg1m8J/Ayg2qz5JMhN1zbBvH7doNA0+6uFRX0jjsweV2kIFbuA51+cj3lV/SeTA9eIcKjRKAopIealqB01ORpzVdwpjD3QDLNBr5VgQBn4viciclnZLcevFCm1ZS8KhEINPneQaWVnBhR4CxQt9H/dCUQgfmvfeKfbiaDk5HJx/6bJrtIMkAlAYFG1iVVtiJ4ZaWd9SGoVmD4XT806hkFo0TEenx6XlCOklbcTvF1DWmsWeKP+rjWZDvg02jYSW14Hsvgz+Gd7hg2MF+HC2ZDxvJzVLjvyRpZs2t9DnOiVYwCIf1yvrxQ1einMksWZ1NhA59zzSSjI/SUwwoc21qNknvjruSGpNfqTtvCw1oP1T2DpbxRnqiPve5RA7JrEC+tmBYfUkbdb5UPtZcOhNAaFwetEESjTZ7zW02ifY3jDaD0vShfgNa4x0i77XpVsdTMAqbB0ily4pDwWcHreNOzznocd456rUP92fHDu92W8f7x8eE0MZjg8za3Pf5urD0qfCELy3mKoueudkRABEDsfdKLZbBdh0QjR0904xNthnxy7T4pMEF2OvhJesdMpd785Cu8/mGELz69VUBWGDnhvCFL+eytJMc+87J6M3g+mxKXbR/X4+u4C+kVYjk2Cb1bDRLRUX6Qt0Tx9EGENoD4YI4sEP7KqL6CjbEqZmQDJTmV7AOQJhxFxBmRKuXzMiSZpg051yJ/OaTZi9kQzT2AKLgGsRUa8Fm4NB2jCuv8FnRStfPIkm+YgvBAVNeNtjAtiVukrsMvBGIwvw1YZ1to+saAk4Irizo+agKNTYqpZXviGREWYD5CFLOskpB5wDOt9vJwNIhMEfbzHphYi0Ri5F+gGcjuUYhoMRCI5GuPY0ojY9g16ZNbwEywd6kDlgER6iuAIDHi8cliJVFylEmOBqAxEcqYbCD3126AD912lpy405Ezhdg0DFoRNqI1RQhEtzEbdPkaFSirtjxGeQArl35buW7le/u6LubNyfRKYRs6tMupj7XXvREDINnIfXxyXrwKVo0KMppSZH0hChKkX58N42OosB48WlFx1O+Xn5kQnnxHEWiD3N9RhlvrKycLpBBkqPZgQNIJOw+8Z1yTIIyouoWV3uj/JkEA/VKUkRATZ+tVWge2IWeh5zwYI+OxHjfRT15bk4+EALiqp5dXynp6SqTrDLJKhpV0ejvE42qTLLy3cp3/5q++2wmmXBF3hLlSUG4XHJ/bSwtuk9HAhgMYPF52PRMK6lqM1tBYizJsWr5zKE267RnbefQEj2b9+yD7rHTsQ46fP+wfdie9TqHtWysv0n9OHGyvE9l9G30SCKGJO4O8rjQA+MKtFJ2vv0X4iknB2ENoSfJm+lM3uNtmjv2irnjudKwNyAMuaP/RHvxenJmjj0a8ig3c2wWnTZzRjI5ZS0+yeArHhGuUscqdazCTxV+qtSxSh0r361891unjr1tqWPvM1LHHsMUy8EU649MHW3IOzA1cySe1U6e4PtiBVuBv6LuY+T2mvtzoZNEL5dFdo5L3sxQir3F1wEn8Xt12U6kl4oL4Q3GLs2rg9FYGMDZHCDSY4BaUpnDUnIpMCfFIymuXEryY9wQ0PXX9YGj8aE/+Uxsb8kqyVsaCAquMqcN8OABeJGD6R9QoD7oHID6K/Y4l08d6PiMfjCb4I7PcMds9MkSAn0+6f/ul50SGOMxGYSLK6PrJ44LmJ4596CMEJ9WBr6SFLRK1atUvQr3Vbj/e4T7KlWvfLfy3b+m735Gqh5lQ0+n6jBg51QdxjZaLMml3qBx/e4ZO7lKxAGZN1MW5ep2moNTXgGmhAytFDVa6esT/Voz/yWL5oO0H5t4KLauHAeGmVrAsBb6LsxYaL0K+s3mA2gMNPXY4CvZiA98e+oej+w377ol+IPHTY2vAYLZoUX1A35rwyzSIDn7Ek3Z4B4tYKROO0OjBenTOYNn6cevM6yhFmGGzB6+BRCZFV3Gg7xQU3wX0OgGmVFhj7C3a9993Lafn7rP7cMQeWIfZeJ7di0Yz4DLje0h+7eoLlA9ECJ9XQM/QwNYgxC1fXObHXOFCbrhsDAyDTr4aKBTYOgCh3XYa8F9qB7MaZkXP76bvmRzTEsJFsIAM2IhsY4Ax7oEMyLYG8QnR3ASRSJfhfMFbW6QO5uDbsYcF4TC3ntXQrCb+ET0OcSDCQA4iR0nCcIMnHX7ItaeLe6Ei6GykUobjVPaXhOk2OS5eS8pLFL9ID3zWgS+SPTeq7MTiWhFL6XimGiLVA6ym1W8L57Z15cy8Y+YWt1QqxO14OUGF0a0N5Y5622BryMJ7gYkrS9e3NCrZ+hhsQVXkOomDyiJiI/8iSor1toX85GjV0d6eT7ee+8WEmJufhozEMcCCJmuzcbMWigViO8ZQ9NBV7mZh+BpX8zWPS5aJ4+od1oZlupmybqsQwZJ/J2BY3jGmPgMIzglMMr0UshtP5BmARc+0HsGH3J7pss3EGhxpK2s4It5xgXruGDd4EQQ8W/iGBoW+DbugXDAGMAw1T8hQcRoBhcNrVLkJ/JNmoPhwwJWiUqw6psf/RQEo78Y3cDRyRiAaUzAkzNm+C2BiBYGs5yw4tbBpgSL/LoKYuiG3Ay/yQNQjKt/tv3ijgdphwW/VvK1UfoJJPnz4O4fhHgV0vwdkSZKidHcaNmN163QyE1GV+z3BfTpA/gX7pKnUu4NlY35bh3mMFkyK5drtGnyaWshBXUKVoJrzA730K7UkvwQUmJ0fvxwDhKa0zugPjDMobaTLr5Myd5BKeZZIGIsw/CELlD9qKJ67AqkfIlKYiex4hh+wif08LtCwES4ZPhBjS3atWVghQaEoCrzRLwzRWlcMiv2SDQbFEWDChJ/GVw42FKGajWjxC1rgQ6DqJ8MgqRXWc038dKNTPBzSAgEMC6fom+jDZZTXwh3hYUgICgkUyKzwtvxtEARiHnRQwzlz5vRpKCJY4EIlkPGGLoNKP/oPUgoqaBqzdB9E304MTGGjfdQT+KviGxa2EPaVq8+w/jVP8MYhUusc5or7OOh9kJTm5mC+KaWpwmT+ubTjHFNDBXUAktoGPrwgF0fLBAf8TIwhi2Fm9u0/qM6DEwR/7ajd3mf0fiL6GNb9kt6brXTFx1L9xR3ML112ryowZ+/Cex5wIYeb/H1ZWpKEY/mhmlbZaYUHuxgAZm0Ei4vrsAlHv8HspRNnA== +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

+ +An identity campaign certification object + +
Schema
    campaign object
    reviewer object
    reassignment objectnullable
    from object
    reviewer object
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/sod-policy.tag.mdx b/docs/api/v3/sod-policy.tag.mdx new file mode 100644 index 000000000..9fecc2690 --- /dev/null +++ b/docs/api/v3/sod-policy.tag.mdx @@ -0,0 +1,46 @@ +--- +id: sod-policy +title: "SOD Policy" +description: "SOD Policy" +custom_edit_url: null +--- + + + +Use this API to implement and manage "separation of duties" (SOD) policies. +With SOD policy functionality in place, administrators can organize the access in their tenants to prevent individuals from gaining conflicting or excessive access. + +"Separation of duties" refers to the concept that people shouldn't have conflicting sets of access - all their access should be configured in a way that protects your organization's assets and data. +For example, people who record monetary transactions shouldn't be able to issue payment for those transactions. +Any changes to major system configurations should be approved by someone other than the person requesting the change. + +Organizations can use "separation of duties" (SOD) policies to enforce and track their internal security rules throughout their tenants. +These SOD policies limit each user's involvement in important processes and protects the organization from individuals gaining excessive access. + +To create SOD policies in IdentityNow, administrators use 'Search' and then access 'Policies'. +To create a policy, they must configure two lists of access items. Each access item can only be added to one of the two lists. +They can search for the entitlements they want to add to these access lists. + +>Note: You can have a maximum of 500 policies of any type (including general policies) in your organization. In each access-based SOD policy, you can have a maximum of 50 entitlements in each access list. + +Once a SOD policy is in place, if an identity has access items on both lists, a SOD violation will trigger. +These violations are included in SOD violation reports that other users will see in emails at regular intervals if they're subscribed to the SOD policy. +The other users can then better help to enforce these SOD policies. + +To create a subscription to a SOD policy in IdentityNow, administrators use 'Search' and then access 'Layers'. +They can create a subscription to the policy and schedule it to run at a regular interval. + +Refer to [Managing Policies](https://documentation.sailpoint.com/saas/help/sod/manage-policies.html) for more information about SOD policies. + +Refer to [Subscribe to a SOD Policy](https://documentation.sailpoint.com/saas/help/sod/policy-violations.html#subscribe-to-an-sod-policy) for more information about SOD policy subscriptions. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/docs/api/v3/sod-violations.tag.mdx b/docs/api/v3/sod-violations.tag.mdx new file mode 100644 index 000000000..d5e477b79 --- /dev/null +++ b/docs/api/v3/sod-violations.tag.mdx @@ -0,0 +1,38 @@ +--- +id: sod-violations +title: "SOD Violations" +description: "SOD Violations" +custom_edit_url: null +--- + + + +Use this API to check for current "separation of duties" (SOD) policy violations as well as potential future SOD policy violations. +With SOD violation functionality in place, administrators can get information about current SOD policy violations and predict whether an access change will trigger new violations, which helps to prevent them from occurring at all. + +"Separation of duties" refers to the concept that people shouldn't have conflicting sets of access - all their access should be configured in a way that protects your organization's assets and data. +For example, people who record monetary transactions shouldn't be able to issue payment for those transactions. +Any changes to major system configurations should be approved by someone other than the person requesting the change. + +Organizations can use "separation of duties" (SOD) policies to enforce and track their internal security rules throughout their tenants. +These SOD policies limit each user's involvement in important processes and protects the organization from individuals gaining excessive access. + +Once a SOD policy is in place, if an identity has conflicting access items, a SOD violation will trigger. +These violations are included in SOD violation reports that other users will see in emails at regular intervals if they're subscribed to the SOD policy. +The other users can then better help to enforce these SOD policies. + +Administrators can use the SOD violations APIs to check a set of identities for any current SOD violations, and they can use them to check whether adding an access item would potentially trigger a SOD violation. +This second option is a good way to prevent SOD violations from triggering at all. + +Refer to [Handling Policy Violations](https://documentation.sailpoint.com/saas/help/sod/policy-violations.html) for more information about SOD policy violations. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/docs/api/v3/source-usages.tag.mdx b/docs/api/v3/source-usages.tag.mdx new file mode 100644 index 000000000..47ffa1c4d --- /dev/null +++ b/docs/api/v3/source-usages.tag.mdx @@ -0,0 +1,23 @@ +--- +id: source-usages +title: "Source Usages" +description: "Source Usages" +custom_edit_url: null +--- + + + +Use this API to implement source usage insight functionality. +With this functionality in place, administrators can gather information and insights about how their tenants' sources are being used. +This allows organizations to get the information they need to start optimizing and securing source usage. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/docs/api/v3/sources.tag.mdx b/docs/api/v3/sources.tag.mdx new file mode 100644 index 000000000..c6a46ee7a --- /dev/null +++ b/docs/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, mapped 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/docs/api/v3/start-campaign-remediation-scan.api.mdx b/docs/api/v3/start-campaign-remediation-scan.api.mdx new file mode 100644 index 000000000..c812e49b3 --- /dev/null +++ b/docs/api/v3/start-campaign-remediation-scan.api.mdx @@ -0,0 +1,100 @@ +--- +id: start-campaign-remediation-scan +sidebar_label: Run Campaign Remediation Scan +hide_title: true +hide_table_of_contents: true +api: eJztW21X2zgW/is63g/T9pAEQloKX/ak0M5hlhY2wPYD7dkqtpxo6kgeyabNcvjv+9wr20kIlL6dmWmP50PHWFdX913PVeSryObKyUJbc5hEe5EvpCv25SyXemJGaqYSzYOnsTTRRlTIiY/2LqJ95Qqd6pjHRE3vo7cbUaJ87HROA+D3Lx2/98KmqXALZsKDmyikfy9S64QU8Qq7uGLXfQMJ/ii1U144myniI/afj87+Ozx4efhKSJOI49Gv4S8I51VcOl3MIeBVdO6V27emUB+LYVlMSWidmL2ad8ep3Lpiz5UmensNsXPp5EwVynmerkn4XGLiRmQwgL90QmvEUzWT0d5VVMxzxQZz2kwwoj6CdUav+vHu1tPNp493tsZxGqdPN7d2tuL+thqMB/3+VhpH1xuRC4rB5IUr1U2rnU2VODwgdQs81TKzsT5MdTxdN6b2YqwgiIBC3YgUgtVya7zyJGx/s0//W11lGMcqL1QiOmKkitIZPOqwJImnfCE+SC98CTrv0zLL5kLWc7QpLJP6uS/UrAsLxGRuU9BCMs+zyp293z2tdrVuOjv+XcVFdI3/NqLB5ua6hPuZBkPx3DlofreUY5vMyQLaXMpMJ98gC+LAUUIUOtgtUYXU2b5N1G0uXxX2hTaqM3FSk4SKRY4xUYDjpU7INzPrlAgsa98yXXclfGCJ7pZ4JhMxqvTbr5SBmQon4/fgRcl6n0DnRmO+qKcInXAE3bGs2lFy/GRztz9Inwyk7D8dbO08Hu+mcnt7c/fx7i6tPkMcyEkwTbW2dE7O15b+VRnldCwyG8Mj/4NBnJKwPQvAi2OKRtz4+33APD7D/pQ0gbZRs5JXUBXYQJ15tn8iBjsik2ZS8ns5uWEE0zk/pZRHsMsxvaL0hOaB8bHTE21uzX5TzqjGHDx/MTw/OsOb0fN/nz8/xRPxWquLQ6SsSSgsISpiYWo/sMSVApx3KoM5VNIVjyquj6CQNH6ZUPulJERspbLMCsyoVr9lxjJrkTo7W0mlOJRM8UB3VXcDNQXvZrJAyRlLjwlwIZE/CrWjc1RZ8pGYKpko97ArhkmiSUmZCWQjmGL+HIyETBKuG8wgLZHKEEYXU1sWwthCx2rVFwtTrnoDSaALpjhadgolByS/P06GcVFCOFZzOQubaKlErPwDmYPlVqU7u1kl56aQMbSQVCZj6xwsLMbQTRdeVOWI3OVReExN11QsKoG1WlzuXgZhDgrLY7Es/Wfk3UmG8tNh1ZqBS1UlH8LAVtWIvVG7qapIVT3nyRVV46468UWqVZa0udvmbpu7n5m7NwdHFS6rRhn6bK1Dn3MjAVut481zDfo4jh5jRU0UoGBw5IaAQSqI9NvrMyT2e8UIUX3MCXN+R3wUtvJ1ZNn4I7wfE/xonLXiCxKQ7Rg0SFGJVLLHci8kZkMFU22vr/bCurFGgJpbICKqphNzWwoJkwEbG5JE+g2RWOXNL4WYStRHyQg3VEBa1SSd3ALhtkiyRZLtbtTuRj/PbtQiyTZ329z9MXP3k0iykYqzpcJJvpzNpJuHSKvGSVspQCDqE0LRpBy76iZaIWaiwVjRKnKIxv2t8Va6E6tBIgfJk+3dtB8/6cvHO1s7W+NBfyda3usvFnncJNlqTi35O/iRTQwQdwkcVxoEly+sTVaP/2Bep1Iqa1R6GtwMm9NR6AI7Dtax4ytbQDcwBnZ0dxwvno+OiD+WZvZkN1u6WBHMDqYDuSwYUlIMw9LaFy10bKFju/20289Ps/200LHN3TZ3f8zc/SLoOLgPOg6+ADoOBEGslCDWXwkdE+AOgmYpnEIXDkqY1xBszKEKnqrTxyrtC+kmqmiA3gqK7O+uo8gza8VLaeY1WPIrJ5FmYS4qb6CdEa2raUEgxQQl0ghULQ10S1GlZ4owKeJHZHqmOY9JIfB1884wLaBVyJk63ppVtImzEhJyUcgsnb1axJhGOKmU4B848DnoBIX6O55xVt76pvNgMSKNj0hj8fxjrBTlfHP++/i2WwKHEN5RuTgNvr7jukA4M5cGbYT6mIfy1UDQFqq3UL3d7tvt/ufY7luo3uZum7s/Zu5+AVSv0NDdUB0Enw3VQdvdFA2WekHB9acjdk6VSgIOb2FjxurJAoMzrkAokUC55YNWvqi7F/Xqm7K+d6WT654r6Z5vc1O248Ml5tASBAlLl2HitChyv9frXcFxcNh1V+a6i3oG3xVzYz90YzvrXW7fUobo1mlIORSypIy5jRieHFZ9R5fN7TRFdCh/vEAwPitIsQsn8HWDT/KnW8jk1TlaEhHYbAhEfxVd/Bpi5mgtfvFM3eVoWtMRup277Po+ff6z/Sk9ApM79LjNfJ9cC/QCUt5Qj8R/u7jWfUoYPKy+drl7sa/Q6X9/bbFjIuuLZ0o6NAjhQsyD316fPRQTQp6c+aUn0Ks0tQrInROECFe2YX05hCbxZuNsOZmy4MOV6zeUSSLNoLB4Y06VEheHlRFeoeSPUKPZpDRJcVmgWW8f1J5J1KXKaDfsLixJgacT04OFenJl3kPe+bhF0AaPM37bfWM64kBTQdK0gxNNpSJ3fOIir/WSS3p9rRD/qLl1ArcOc/MPb0gRTHsRh+vcMdKZWMjMs7W+evHAr7PEj/opvCGuN2UgS1RyrF6aimuvfbUcK/w6xG9VjjfmNd/aX50mQhUTHrtilohDEU+t9eqfQlDoUBpcTEpk0VeLxZ8KdDgjOv3NJZE6YcmO7gAksnxHSAwTgkmOaZNmjGLDcQmn5Dv2LHL+HX938W5FZ359gb2UKBMb+6+WmRbs0IKdUAN8JX/YqiiwkNukA9eBEAD7C/9zJagEXap5gdetVZ3Z93gObQ0xRGUuPt8Lf+wtClz1JHiAqBsalGDC2M01MvwtKl60X60Yqz4duGnBdXkzi23yht2CvM1vnLR1/t30JY2Hi0OUY5PNv3eVvqOS/H3q7l9U8dpK8zNWmgr1UrjxslV7sBzkAa2tH+nRmfNU4V+McqYyvEbzwu0YY5hlNnkmC4ppzul4qhUfBuRKFoT8Niiu7IzzEHCXkh8tHzOaONAgaQGx0b7pDPy64jW6LRPDxNRp0SVccP3dVi3XKax8Qk4SB7XjAKBms9JgLuVYORMS4XGPdxPt4zIUITReRtWaWYZxzaw6IylsyBRd7jnczB+ndGqMhnTJifesBR/66sgYhiSPVF8ILhQZqYyjjOhW4fd9vBE5nanKcur1UEEBptTSCi8Pz9Y4gpmpfqewbtKrJvke0YIJtTohGLa76PDoFXVNaEyX+I7KxVecYumzT1F997kSVVeL0/I/9fvOavMg1N/L6eCKdClDFxI6wIuo6QBBv8dfbN7aBKKtmFLriBlXV3TaQR3RNb1Gl0+t9MXbRcPDjSL8Q89oOlNk/80vNpdN8qBSKnnIv9d8y3ecd+hcH+mZ+aKbj/D4XtEhALRGqwwF+ZSGhQ8D4RxnacraLx3UbjW99ckxnWgxTLlt664eYCkUp/8Dh0ARbw== +sidebar_class_name: "post api-method" +info_path: docs/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 'Run Campaign Remediation Scan' (start-campaign-remediation-scan)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/start-campaign-report.api.mdx b/docs/api/v3/start-campaign-report.api.mdx new file mode 100644 index 000000000..b6b106bef --- /dev/null +++ b/docs/api/v3/start-campaign-report.api.mdx @@ -0,0 +1,100 @@ +--- +id: start-campaign-report +sidebar_label: Run Campaign Report +hide_title: true +hide_table_of_contents: true +api: eJztW1lz2zgS/iso7sMkKR2WrMSxXrYUH7OasiOvbG8eHFcCkZCEhAI4AJhE6/J/3+4GSImWj8ST2kxSnIcMTTQafeNrCLyKdCYMd1KrYRL1I+u4cXt8kXE5U2ORaeOiRuT4zEb9i2hPGCenMiZ6VpDZ6LIRJcLGRmY4AGzGubKMM0MM2FQb+COuTI7D5NZbWObPXBphmZsLoE1T/VmqGTM6FbbP9g7GZ+8G+8fD1w22Pzj916vRYLzfYKPx7/4t4yph44OTUUHWAoGtiHMj3RKEvorOrTB7WjnxxQ1yN0dFZKL6hQRNL2Xf5Cq6vAZVMm74QjhhLE2XqFDGYWIjUjAAf8kE14jnYsGj/lXklpkg2xmQG0bEF2Cd4qtuvNt5ufXy+U5nEk/j6cutzk4n7m6L3qTX7XamcXTdiIxXH6zvTC5uWvIMbDLcZ3pK1ilkJpN+nst4XthYWjYRZLZctYDtrXKToPdJXl0bR3FlzspIECpfUCQMjk8Gw99fv9sbHZ+MTodnw9Hrd94LQFWOjg+OD/aHAxo9PRucnZ/eQrQxAB4fHg73wjQgGR0eFsOX6+a9XwonHVF54c9Q1a8yd6E2GjxY1+lg10tkYDOtrLBowO5WF/9XZTKIY5E5kbAmGM7lRsGjLPj9mQvr2Gdumc2BztppnqZLxos5UsFiSGqX1okFRnOMwascLsSzLA0p1P5gcbWrTXfqyQcRu+ga/mtEva2tTQn3UgkM2YExEEd3SznRyRIjS6pPPJXJX5AFsspgpXHS2y0Rjst0Tyfi4TA8lEo0Z4ZLlFCQyDFMZMDxk0ww5hfaCOZZFo4julYlGcESrQ57xaFcBP32gjJgJmd4/BF4YRV8SKBzJWE+K6YwmVA+3rGs2BF88mJrt9ubvuhx3n3Z6+w8n+xO+fb21u7z3V1cfQFxwGfeNGFtbgxfbiz9u1DCyJilOgaP/BcMYgQH25MAtDhMkRA39mEfEI+vsD/mhKct1QzyMqypDagPr/ZOWG+HpVzNcnrPZzeMoJrnp1iIINj5BF9h9oHmnvHIyJlUt9bSUHD2Dw4H50eY1uODf58fnMIT8trYeQYKojXBsARRIRbm+jNJHBSgvBMpmEMkLfYscH0GCnFl1wmlXUtCiK0pz1MHM8Lqt8xYZ82mRi8qqRT7DYg9kS3RakCthncL7qCAT7iFCeBCJH/ma0fzKFjyGZsLngjztMUGSSJRSZ4yyEZgCvOXwIjxJKG64ffPHFIZhJFurnPHlHYyFlVfrExZ9caqYh6tOwWTAyR/OE4GsctBOFJzPQvLaAkiBv+AzN5yVenOblbJpXI8Bi04lslYGwMWZhPQTTrLQjlCd1koPKqgKysWlsBCLSp3x16YfadpLOa5/Yq8O0mh/DRJtXLgkwjJZ3F/8NWIvFG4KVSkUM9pcqAq3VUkPptKkSZ17ta5W+fuV+buzcFxwGVhlKBPZxP6nCsOTYA2tHluQB9D0aM0K4h8t+Id2WBgkACR/nhzBon9USikF18yhJTfER/5rXwTWZb+8O8nCD9KZ1V8gQKSHb0GU6hEIumT3CuJyVDeVNubqx1qM5EQoOoWiAhV07ClzhkHkwE2VigJtw2WaGHVb47NOdRHTgjXV0BcVSXNTAPCrZFkjSTr3ajejX6d3ahGknXu1rn7c+buvUiylIqyJeAkmy8W3Cx9pIVxf1IKBKw4IWRlypGrbqIVZMZKjBVVkUM06XYmnelOLHoJ7yUvtnen3fhFlz/f6ex0Jr3uTrS+11+s8rhMsmpOrfnb+5FMDCDuE+C4XEFwWad1Uj3+A/MaMcWyhqWnxM1gczwKXWHH3iZ2fK0d6AaMATuaO44Xz8dHyB+WJvZoN52bWCDM9qYDcu4IUmIMg6WldTV0rKFjvf3U288vs/3U0LHO3Tp3f87c/Sbo2HsIOva+ATr2GEKsKUKsHwkdE8AdCM2m4BS85JGDeRXCxgxUgadw+hjS3nEzE64EehUU2d3dRJFnWrNjrpYFWLKVk0i1MheWN6BdIK0paIGAsxmUSMWgaklAtxhVciEQk0L8sFQuJOUxKgR8zbI5mDrQyudMEW/lKlLFaQ4SUlFINZ69aogxCeEkpgj/gAOdg86gUH/HM87grb90HszGqPERaswOvsRCYM6X57/Pb7slMAThDZaLU+/rO64L+DNzrqCNEF8yX75KCFpD9Rqq19t9vd3/Gtt9DdXr3K1z9+fM3W+A6gEN3Q3VgeCroTrQtrZYiaUOMbj+74idUiVIQOHNdExYPVlhcMIVEEooUKbpoJWuD/ejdnHv2LavZHLdNnlxa7p9hXFyHeGVa8SIXrzcpDBr7lxm+20gEQq8dd3imWxBMQPHuaXSn1uxXrQ/bd9Sg/DKqc83qGJJHlMPMTgZhqajRbY2EsPZ1z5awFuetMPABQ/QXYN7+ePFaHTpEvoR5tk08AJwCC16DWJm0Ff8Zom6RaG0oSPodm7S64f0+c/2fXp4JnfocZv57l0L6BlIeUM9FP9ydUP+FAG4X33jnvxqU8Gj/+7GYiMk67JXghvoDvxtmCd/vDl7ymYIOyntc4uIV0jsEyBxTiBEqKwNipshOIl2GqPz2ZwEH1Tu3mAasWkKCrO36lQIdjEMRngN9X4MBZpMipME1QScdfmk8EwiPokUt8LWypIYeDJRbbBQm1fmPaVtj/oDqeBxQW9bb1WT7UusRhK3b6QJKlK7xy6yQi++ptdjhfhHwa3puTWJm316Qwpv2ovY3+WOIZeRBU8tWevRi3t+zTV+2EzBG+R6Uwa0RJCjemMqLrz2aDkq/JrIryrHW/WGPoCoTmO+hDELW2KasCGL51pb8U/GMHQwDS5mOWTRo8Wiry6alBHN7taaSE2/ZFM2ASGSfEeQGMoHE5/gDk0ARfuzEkrJ9+RZyPn39BnL+4rO9PoCNlKkTHRsHy0zLtjEBZu+Btggv9+nMLAgt1EHqgM+APZW/qdKEARdq3me161Vndi3aQ5uDTGISlxs1vd/9FcFLjwxGkDqkgZKMALs8g4Z/M0CL9ysKsYqjgZuWnBT3lTDHnnDbl7e8gdO3Df/bvqixoPVCcpIpcvvXaXvqCR/n7r7gypeXWl+xUoTIC+GGy0beoP1IPdobfM8Dw+c5wL+hVHKVMLW0LlQL0YYZp1NlnKHMU05Hc+loJOATHCHyK+BcaUXlIcAdzH5od8jRjMDNJC0FtAon8gU+LXYG2i1VAwmxjYLb+AC1w869FunYOUTdBLbLxwHAGqxyBXMxRzLF4xDeDzg3UTaOPdFCLouJQrNNMG4claRkRg2aIoWNRxmYUdTPDKGbnTNiQ+sBT604bwYDIkeCR8trhQZi5SiDOmq8Psh3hA5zblIM2z0oIICmBJrKxwPzzY4AjMVfqTQZtYOk2wbaYEJtjo+GLZb0N7hK2yZoCtd4zvOVx/Jrj6hrMTS1eqA/Id/NBu2EcT/7QzPr1Cr3PcjvhG8iMpGEOj79BnsqhfEV8QD2os59o9Af3WFRx7YGV3ja2j1sZ++uFw1PtQwgp/wGTrPKVSBm19lrhvpSVA8eUo/2nz7p7F36Fmc5qnlqpGP4PGjwP4fNMWe79Fi3vNJ6aPkoVHo28HQdGRERvRD/lBpbdLGzy7Y/pWN/skIj9cINt0GJcIDeAyK5f8AsZWoTQ== +sidebar_class_name: "post api-method" +info_path: docs/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 'Run Campaign Report' (start-campaign-report)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/start-campaign.api.mdx b/docs/api/v3/start-campaign.api.mdx new file mode 100644 index 000000000..054c19e5b --- /dev/null +++ b/docs/api/v3/start-campaign.api.mdx @@ -0,0 +1,104 @@ +--- +id: start-campaign +sidebar_label: Activate a Campaign +hide_title: true +hide_table_of_contents: true +api: eJztW/tv20YS/lcWvB/yqCXZsmzH+uXgOE7hIqlzflyAOsZ1RS6lTfi63aUT1fD/ft/MLqmXHSdpcW0DoUBKkcPZec836+VNVFbKSKfL4jiJhpF10rhDmVdSj4toI3JybKPhZXSojNOpjplSNAQ2utqIEmVjoyt6AAZn9SjXzgop3pcj4UohY6evpVPCTZSIw4vio3YTvjPW16oQx0lXnM8/z2vrxEgJyDNWSfddcar+W2ujrDBlhn/LVBwenZ7/5+DF6+OfhSwScXL6o/8Fqa2Ka6PdFJLfRBdWmcOycOqTO6jdhLTRSTFslhrWVQLxoqtb6GKwirLueZng3Zsl1U74QmZdcZyKohRO5+q3slBCW2ErFcM+KtlgrSB2kUiTiIvzwwW62qpEPNZd1aVHP2xuDjc3n3TFQeYmZT0mk4AoloVw8oOCXtP2bc9YQ48iAY9rmdXM0Zs1y5R5ZFtib81gevIYPSCyuM6gbCJSU+Zz9m9FzOUUZJBy0V2Jkkmm8Zz5wKtwTV4mQeNR7YR28GmWCaNyqb1/8T9iUho91jCbIDN7wWbLBTeDVJJKOhHHZyfi2e7mlkhLk0vXjbxX4HvEZyozqzaimNxZOHKRrKoshGXvvSU/3UQ2nkAKunLTSsFz5ei9ih04VYbC3Wll+SnE+AVizFFaZ3Qxjpaj+muFFueB2BJV+1QaBQNVCGNIDy9IywHyeOneo18ePYHZ6BKRUKapVc57DNTegs1NXo4DBgL90OtMJsM83/BXdAEufN1llVJZZ7Ba9At+qU9wbkY6dzZ3EIXR7S3SXTu+dRCStkl0H/oWNERVSSNz5ZSxnGCaLFRJpNZGVOABfumEsnDZDcG4t/MedaZWd1m7DT1mNRNWpdvP0v3B9mBP7Q92dvujndHo2aA/kDu72/t7ybPIp7GtIK73cn+zv5rLB3GsKjJ3R5wqV5sClzrleA01QHyE+W0NOmvTOsumSKfwDpKw9Gk+tU7lZNtvjEhvzwGsvyLhYabBUBwZAx/eL+UIpYrKgC44En+HLMvZkSgndXZYJl+QHy9RGzpjg8yHhIpFjvGiAMdrneANVAvEvmdJxZtUYLrugndhie6WeC4TcRr0OwzKUHAaGX8AL2pUDwl0UWi8L5pXEEWUK/ctq/aUHO1u7vcH6e5Ayv6zwdbezmg/ldvbm/s7+/u0eo44QC+yc2tLY+R0ZekfVaGMjkVWot7q32AQoyRszwLw4nhFI27swz5gHl9Ynzxtq2aQV1Df20Chen74Rgz2RCaLcc335XjJCEXn4oxSGMEuR3SLchOae8YnXMbvEkUVdU5d9cXRy4OLV+e4c3r0r4ujM1wRrxWIcICkLhIKS4iKWJiUH1nioADnncpgDjR+8TRwfQqFZGHnCUPz80koQnXDG2H1O96YZz1rgU0qxR4k+PaMrkb3UF3jiRhJatul72dPfe3ovAqWfCom6I7KUBtPEu0xgu/PlvspKrNMEq4bzCCtkcqKW2SJzlmUTsdq0RczUy56Y1ahX807hZIDkj8cJ6jrNYRjNeezsI2WIGLwD2T2lluU7ny5Sk4LR1iDYAjgQ2kMLBxQgRWhHDFKQuEpGrq2Ys03Hi53r70wL1zJzxiPPJx3bzKUnw6r1j64ViH5LIEWX43YG42bQkUK9ZxfDlStu5rEFwA7WbLO3XXurnP3C3N3+eFpwGXhKUOfrVXoc1FIDGqYG367C6AZjh7MXw2Rn3C8IxnxBoj009tzJPYHjDegV58qApx/ID7yrXwVWbb+8PdHBD9aZy34ggRkO3oNUlQilQxZ7pnEbChvqu3V1V6WZqQRoMUdEBFV04hpWfuxoy4KkkTaDZGUyhaPnJjIa8Wo1lpfAWnVIulUJRDuGkmukeS6G6270ffTjdZIcp2769z9e+buZ5FkKxVnS8BJts5zaaY+0sJz0lYKEIhmh1C0KceuWkYrxEy0GCtaRA7RqL812kr3YjVI5CDZ3d5P+/FuX+7sbe1tjQb9vWi+11/O8rhNssWcmvO39yObGCDuGjiuLhBc1pVlsrj9B/MalVJZ4z+2NLgZNodJr2bYcbCKHX8uHXQDY2BHc8/24sXpK+KPpZk92a2sTUy7+sF0IJeOISXFMCytrVtDxzV0XLefdfv5btrPGjquc3edu3/P3P0q6Dh4CDoOvgI6DgRBrJQg1p8JHRPgDoJmKZwCHeIa5i3c7CBC2H0Mae+kGSvXAr0FFNnfX0WR52UpXtNBlQCW7MJOZDEzF5U30OZEaxpaPkPhz6CgammgW4oqOmQCTEqnhjKda85jUgh8zbRzkDpo5XOmibd2FV3EWQ0JuShkJe29logxTSc2UoJ/4MD7oGMU6j9wjzN463ftB4tT0vgVaSyOPsVKUc63+787d50SOIbwhsrFmff1PccF/J65LDBGqE+VL18tBF1D9TVUX7f7dbv/Ptr9Gqqvc3edu3/P3P0KqB7Q0P1QHQRfDNVB290ULZZ6ycdk/9+InVMlSMDhLcqYsXoyw+CMKxBKJFBV8kYrH7wdRr3mwKzt3ejkttccu4/oNDxBQy9VbTIQT5yr7LDXu4Gz4KTbrqx0FzUM/nLTovzYjcu8d719R+mhk6Y+zVC8kjrm0eHgzXGYNbpsYqMpin3J4wW8wZvTxxaG5yMGn+VPJ4nJk1OMIcKz2RCI+BBRfBtiVhgnHlmm7nIEregI3S5MdvuQPv/e/pwensk9etxlvs+uBXoBKZfUI/GvZh8vnBHu9quvfMIw6yW0499fWeyEyPriuZIGQ4E/BPP4p7fnT8SY0CZne20J6CpN4wHy5Q1ChKvZQXMghF7iBmPCpwlKHCwcuaHsEWkGhcW74kwpcXkcjPAzyvwp6jKblF5SXAroravHjWcSda0y6oDdmSUp8HRS9GChnlx47wl3Ox4LdOHPveNu913RES80FSE6oM40QUWe8sRl1egl5/T6ViH+0XDreG4d5mafLEnhTXsZ+yPcMVKYWMjMsrW+eXHPrzPHj2Yo3CGuyzKQJYIciwel4sZr3yzHAr8O8VuU413xdqLRShdfE75yCYtOmCXiWMSTsrTqn0JQ6FAaXI5rZNE3i/WRFu1wRnT6m3MidfySHd0BMGT5XiExCh9MckSNmXFJ6bdIOCV/Zc8i53/lr4t+XdCZb1+ifxJlUsb2m2WmBTu0YMfXABvk9+2JAgu5TTpwHfABcDjzP1eCIOhczfO87qzqzL7H71BriCEqc7HV0P8YzgpcuBL8gKhbGpRgwtXt0TH8FoEX9agFYzU7AssWXJU3K9Eal+zm5W3/rknt8q+mL2l8MNs4OSmy6R9dpe+pJH+duvsnVbx1pfkeK01AurQBeTr7IPOomUnmP9xrP17DmI3o9A/9BDGfEx7cre76+e8c8S+ecmIzAgd2nn2gOs+myqSjFPDftU604v2CSklHQHGDwrDMOW2BjqlWYCpkRmMDGuS4BXiVI52BX1e8xUBWxPAIDWN0Thdc35dhKjuDU96QT8WLxs/AW3leF3iXUrLOhUQ0PRAMibZx7WsWZrNCNZqVjPrat5oEpigjU3R5LDG5PUlpYxkz65zPH1gLLrdhVxmGJI+EjwJnipyqTPoPCjeW0PpDvBFonYnKKnI4Ci6wl5pb4fXx+QpHMCvCnzJKM+6Fl2yPaMGEJiMfDNtdDIF0iwYrzK5zfJvPIYEn576NXoilm9k2+l/jG+jQemhm6FW01UWq1X6G8TPjZdTOjKAf8oeW7diIQWRCAyaobm5oT4RmqFu6jYSkgfvyajYi8WgJF9H17Cvde+3zOCiSPFlUmCW4U+5mI6+Yzmb4CJcfFI3+eA8DMgTmvRkWxj8IfwzonE+5nzcvrvyVg6ZG/4bf7/ks7dXcDP7mhHa+olH4Xjz32wlGfsRN+ncYvcN/+FGGD2hBxPdvomZzDjSebwOc7sIN4QJGB9n/AL3SOC8= +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +## Request + +

Path Parameters

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/start-evaluate-sod-policy.api.mdx b/docs/api/v3/start-evaluate-sod-policy.api.mdx new file mode 100644 index 000000000..2966f9299 --- /dev/null +++ b/docs/api/v3/start-evaluate-sod-policy.api.mdx @@ -0,0 +1,83 @@ +--- +id: start-evaluate-sod-policy +sidebar_label: Evaluate one policy by ID +hide_title: true +hide_table_of_contents: true +api: eJztW9ty2zgS/RUU92GSlCnZknyRX7YUW5n1VBJ7ZHvy4KQmEAlKSCiAA5BOtC7/+54GSIqSHNvJpnYzKb3YFNho9B2nIegmsCIqjMznweHVTXBphTnSKhef80GRTzEWyFgdWh2H11KnPJdaHX4CuQje3b7bCnQmjBs8iYPDwObc5MNrnhY8F+c6PtOpjObBVpDziSVe56fHrBzE5FjYyMiMpmPyqFCW5VPBbDQVcZGKmBmRaZOzRBv3InMzMZobKa7xfjxnGbcWT+Wrk+MWYxcgLWdWrJi0LBE5fWKJ0bMvsgMDiJtxw2ciF8Y6o0gSL+Mwx1ag8AKfZIxn4j7jweFNkM8z4fQ3Uk2C263AiL8KaQSMkptCrKpKEpIpaqlZrpkpFK0tPvNZlhI3kXQPkn6vG/b2RT/s7e51wvHueBwe9Do9vrvX7e/HBwE5wQibaWWFJVE629v0b8W2IhFGqEjQQqR77czKUlid5dx+JBEiCgCVExueZRDRUbY/WOJ101Cbp+lp4kxUGkCPP4goD1b1bei6vrCwRZo7qxuKplx6PTzHVdN+PWd2fHHKiIkzripmFIej4dnp6OLP0fD88uUFheLC6suv4Eq4+nuI4SNrsU4n6u8cbB90d+Od/g4/2Nve2Y07B73d3XFv3Ol2OC3tg+2hxf9VzLgKjeAxHyPUaRLTiXPz4wy/EGqRn2yH/VHNCG4hSy5zT6LjkWMwcvOPcw1J1wNg2ZkoDHlhH2FHR0fS8/tkb7ry/PLoaHh+jpE3g9Hrk9e/4mk4Gp2O8P9iOHp18npwMTx2H16d/Vm9ORu+PibaJddXg7e3lFWVwk1t6zwi79QTF/rVLLYqRZfDyUdT0N0fd8fwcZh0+72wt5cchDziMdK70+n29/oJ3ztY1JpXWFiy3wth5swLQxJCgN5dqX6USuQuGxqDqhliQl4YheImfURQYRI2Z2Mdz6kqSoVyLeOvSvv7fR2LnMv0SMePCN0XUolwYrgkCYUTOcJEBo7XMsYMNtNGMM+yCmpHtxy3sERrhz3nMfT1+h2VylDkGh59BK+TRyTypZKYz6opTMb17nPHsmJf8PHedr/TS/Z6nCN9d/Z3x3Bft7vd3+33afWZsJZPmjUt4Mbw+drSvwoljIxYqiN45N9u++OwvRPALU7hk4uZfdgHjscj7E8bkaet1SzlZQQBtpCGz4/OWG+fpVxNCjfOJytGUOElpZ8q0pQKkN/yoLlnfGrkRKq7RKky+Hj4YuCTYzT8/XJ4jifitQYQBgrRGlNYQlTEwlR/chKXCnzillmRwhwibrFnJddnUIiXwKIklCXMmFsYE7GVcKqD7Fm5+h0zmqwX+KFKpcjjJfZEtkRri41pbMYBNtiYEzaBC4n82SCKRJaHL0tLPmNTlGxhnrbYII4lKclTRuBJWMyfgxHjcUyp6xkkBVIZwsh8qoucKZ3LSCz7YmHKZW8sqtnLplMoOSD5w3EyiPICwjk1m1lYR0spYukfyOwttyzdRcNozqRzlfMIWgBHzGFGY2BhNoZuMresLEfkLovCoyq6umI1dyVX7l55YdyWhHcRL+wj8u4sRfkJnWr1i2tRJp8lwOSrkfNG5aayIpVoyk0uqWp3VYnPEinSeJO7m9zd5O4jc3f15ahscMq3DvrsrEOfS8XRs2rjNs816GNc9CjNKiKPKL0jtxgMUkKk395cILE/CkX04nNGfdx3xEd+K18TflD7w4+PCX7UzlryBQno7Og1SFCJRHzo5F5I7AzlTdVdX+2FNmOJAFV3QERUTcPmumAcJkNfqEgSbrdYrIVVv+RsylEfOTLCWl8BaVUVh5mWKt8gyQ2S3OxGm93o59mNNkhyk7ub3P175u69SLKWymVLiZNsMZtxM/eRVr73B5IgYNVRO6tTzrlqFa0QM1ZjrGAZOQTjzs54J9mPRC/mvXiv20860V6H7+7v7O+Me539oLnXXy3yuE6y5Zxq+Nv70ZkYIO4aOK5QCC6bax0vH/8VdACcUFmj0lPjZtgcJn1XY8dOfx07XmjNXnE1rxCSXcKQamEjqmmgnRGtqWhBwNkEdVExlCoJuSiU5EyAi0HQsFTOpEte0gJ8zTwcJDlU8YlSBVm9ilRRWkBCVwlSTahZI7AklBQJYT5wcAh2gur8HdFp6aL/CsmzEWn8kjRmw8+REJToNXLfvet89wTCG6oR597BXzjo9d0OVwgANAS+ZtW4c4PPN/h8s8dv9vifY4/f4PNN7m5y9++Zu1+Bz0s09GV8DoJH43PQtrZZjaVeUHD9z2G6S5VSAhfeTEdRYdxxc4XBHa5AKJFAmbauiNBNpMOgTZey3AUJlJP2jYxv26K8egUiD/+9YIVJQT/N88wetts38Bf8dNvimWyhjMFl+VzpT61Iz9rX3TuqD10T8JmG+hUXkTt1HpydlD1Gy1nZSApkX/XcAt7mTi8KWdjenQ/fy7+6uzLXBeqcY7NFl3fKoHLDEDNDR/GLddQtF0RrOkK3S5PePqTPH9379PBMvqDHXea7dy3QM0i5ol552aS6hHdO0NuvvnYVb7GdULvWWVvslMg67LngBn2B/wbjyW9vLp6yCQFOl/CFJawrJHUISJkzhIgraIPqNJ8muT3G6GIydYIPlr4voQRiSQqF2Vt1LgS7OimN8BqVfoTS7ExKk4SrBjTr3ZPKM7G4Filtgq2FJSnwZKzasFCbL8176jY81xlIhceZG229VSE7llSHJG3cRFOq6Bo9dpVVevGGXt8qxD8qbqHnFjpu9umKFN60V5G/fxMhi4kFT62z1jcv7vmFDX7URmGEuK7KQJYo5Vj+liuqvPbNcizxC4nfshxv1ZupxG66PI354sUsNsM0ZicsmmptxT8Zo9ChNLiaFMiibxbrEy0auowIO9sNkUK/ZChDYEMn30skhvLBxMe0NztoooHaVOxT8r3zLHL+PTrnmL1f0tkNX2ELJcpYR/abZaYFQ1ow9DXAlvL7HYoCC7lNOrg64APgaOF/VwlKQRs1z/O6s6o79m03h7aGCKL6a3nZof9wuChw5RNzL4i6pkEJJmhdf++Hz6zkRdvUkrGqQ4FVC67Lm2rsjit28/LWh1K0Y/5o+pLGg8XZyalK59+7Sn+hkvw4dff/VPE2leZnrDQl2KVwc8uWXUEzyD1aWz/Jo6PmqcBfvHWZ6lA1ehbXhTkM02STpTynmHY5HU3p7j/dKxY8J+S3RXGlZy4PAXcp+dHpOUYTAxokrQUa5WOZgl+LvUGTpSKYmBosujUBrh902Wmdw8pn5CR2XDkOAGo2KxTmUo4VM8YRHg94N5Y2KnwRQr+lRKWZdjCunlVlJIUNmaLlWg0zs6cJHRajD2048YG14ENbnhTDkOSR8jbyQpGR8JeyiW4Zfj/EG5ETTkWaUYuHCgowJRorvDq5WOMIZspCL7TS2kza5STbJlowoVbHB0O3hcaOhqhZQj/a4Fv9MAWtfv3jD/eTj9WIulkckP9Iv0op9xVqCNoZHWWRmoVvUHxPeBU0e0JMOXS/U6nbQjQaU+ohQXhzQ8ce1CPd0vBfdLsc4+8WLZBrHeExekb3maAerP6QpWmoJ6PyJy9P2X0/b7lTierUTs0XDXuAx4+C+nzogG4YoruDGCeWf+GPahpT1r7MoNaqbp/PTunQykGSu7bp8gE2QCH6D/yAhis= +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/start-generate-campaign-template.api.mdx b/docs/api/v3/start-generate-campaign-template.api.mdx new file mode 100644 index 000000000..74c7ece29 --- /dev/null +++ b/docs/api/v3/start-generate-campaign-template.api.mdx @@ -0,0 +1,87 @@ +--- +id: start-generate-campaign-template +sidebar_label: Generate a Campaign from Template +hide_title: true +hide_table_of_contents: true +api: eJztW2tz2zYW/SsY7nQaZyzJlt/uhx3FdlJ3Hdsr2810HE8LkZCEhCJYgrSj9fi/77kXfEryo2lnt+3oS2KBFxf3fQ9A8N4zsUpkqk10HHj7nk1lkr5TEY2pAzmJpR5Fl2oSh/jtrXqpHFlv/9o7UEmqh9rnmaIgtN7NqmeVnyU6nYLs3ruyKjkwUaq+pL0sHdNUHUT7fj6hleas95Ms8m4eMD1Q1k90THwhTyGKFVJE6k4UE8UwMROMlb8LRu2P0eVYVeNm8En5qfAhg9SRCoQGLQgKejGWVthY+VqGYmiSiUxTHY2EjONQgzw1QqdWRHKihIwCURNPDLUKA0scTRKohGgDlapkgoV4kVEufVDK861j1amxaYvzUPpqbELwsE4+Y1XBXSaqkAt87nQ6ZtawcaKiVASkAwmWakiYxRArX5VYf4wavGEFq20qzBCmg9994mDZnCYMzR0WGEzxKFRYLIEoAXsY5rgbS1COTRaCROEJ/Ap5viPRhPoC7UK1Kj563/z00YOQYZiTNGSdKpl8t8hpbJMA0w9K94LtN1PixUsWhqxP9mUYzk/qrnXXMO2VtDabkOQkAC0soEBlGWcubZl+BXb6UYY6EHHdWmR5mk0m7jA97HeLJzTfZsOh/iL8sUyknxK5zeLYkFHIhtef5K1sZ6kO229z5yU3r8ZpGtv9Ticwvm0bTAxV2zeTDhFb1dnlBx0Zax7p0PROOb09TichidpXv2Y6QUokJsS/Z/13P/cO3x+ftpGfMcSZUAxaTj9NORRLJN6qRzbGLx3gb+uP1UR6+/deOo0V530CY3kPq17iuKMYpEmmZvORcuv4kAIorWdZ6UikQGY5YOthiBXzGAGLrr+3vru2u7EVrO+ty93ttfWtoLu7ubU12JTdje6eR1UA6iGUrbIkY3dtjf5rSnLsgpMrQynHHSVz5vvK2mEWhtNaBnLBSMdweSHsKudNotIsiYhLooYKceqzFqReveCQDlREEMckC5cHV/06nywJdD9vVFd7vLpNr5392Rerjg58izrrftb1pEWRPCRucJHKNLMYmkBumZpkemAmEwiUBwT9SQU4Tqimp9oZD+vNuXmRV7NI/5otcm7Te2q4sTvc29zY3FF7m1vb3cHWYLC72d2UW9sbezvBLoWQi7SXLMpl9cn1yuQ+JaYPuc0WMFdRNuHO1Ht/3jt+d+rN9RJakGbRgnlbSKmsISQGikpFGQDBjAwFy4cZXz0hxvveae/dUR8jF2dX/YOjn88+nLqfR73+wfdPS/e4OQq2DzPTX2LseuuaTWCrUipbNCYD1E0UfCP8RHHq6JSEiJBQckBSuMJQCdV7ijUbbTaG57KZe/YM1ZwlxFmElK7bs3yG3iYj6kxXUcWmLXpRY0D4DdhSgQTiqyM/zCBVc4YOkFWakkm8Arf855SCJmvQDWEmBhOREdL3TRYBNmARiCWBfAwgEVa9VcKaDI13pV2P2bN+/+ikd3l0iMGr09rPm0YcVuMPT1eBZ+PhsMApFp5WsHIC8zMb1/eKisWVPAA6oqZnRZARtxkzJupWqzvbFj+ZjN2QT644EhN064rRKk0yn1WLLV8bBmFkqoG2eEOPhzIL09WmhJFJH5GybtneycnPh0cHxxfHZ6cXGO8f/Xj2LwTP6clPjfHTs9rPhtEbTx6oAOm0UZn6RdXAU3q+uahbHQBMAgEdJQkkbYk+Nx0XNhTipIgCMBuYgENLR7eER35X02m2AQBTqcMDE7ygMr9FXLRGicPLikX2MVGA460OKAAmJqF6QiyLLGW6ZrGCJdrr4o0MRD/X7yBXhswI+PMZvI5f0J+uXG8qpiAL2eOPLKt2lBxsr+11N4fbm1ICW6zvbA32hnJjY21va2+PkwcIQY6cafK1ZZLI6dzSvAHRvggN8Kb+jyLAIK1xYJMXxxQNSGGf9wHzeGFndLSlmrm8gjZSwC3izcG52NwRoYxGGY/L0YwRotbVxVzVhuaO8VmiR3ph3ygy5/Dobe/q5JJz5t9XRxf4i3jN9S0qig6KQVTEwtjcscS5AozIVAhzUD1+nXN9DYUk6kmNULtfdmphzCLnMSNffcGMOusC3lWp5Ltdp3il26q9itaAMQBpfywGwNoBlWYif90DWozT1kluyddirCTg/wqaRxBoUhIbQ2QjmGL+lHqMDIJqIznMkMqKN2YmS6ksaV81fVGZcraHFrXkpO4USg5I/nyc9Pw0g3CsZj0Ly2jJRcz9A5md5ZrSXdaMxiadYqvsQwtJAJpbHJDSALrRRjgvR+Qui8ITFXRlxaqXSC53750wh6nhZ77M7AvyDvtWTccDUK18cKvy5LOE0F01Ym8UbsorUg7feXJOVbqrSHy3vV7m7jJ3l7n7wtydfdjP9+j5U4Y+6/PQ5yrK8S81zznok3D0EGbOiRymdI5kPJhDpB8+XCKxP6uI6NWXmHDfH4iPXCufE75X+sOND4ojpaL1V74gAdmOToMhKpEK9lnuSmI2lDPVxvxqb00y0AjQaAFERNVMxBQIm+F5FkV8SgnIHBhlo29p74H6KPnsw1VAWjUKWrHRUbpEkkskuexGy2709+lGSyS5zN1l7v41c/dJJFlKxdmS4ySbTSYymbpIy5+715ggEMXbIlGmHLtqFq0QM1FiLK+JHLxBd32wPtzx1WYgN4Ptjb1h19/uyq2d9Z31wWZ3x6v3+usqj8ska+ZUzd/Oj2xigLhb4LgsojeMqTFB8/gvozPNIZU1Kj0lbuYT+IebEjt29xacoBsj3stoWiAk28CQUWUjqmmgnRBtUtCCQIoR6mJE74U15KJQoneeLcEvXkM90Zy8pAX4JtNWb0gviV2iFEFWrlKeplMlCA2hZoPA0lBSDQnzgQMj2BGq8x+ITnMX/S4kL/qk8QlpLI6++EpRopfIfWvx20jYgmrEhXPwIwe9brcjIwQANgSuZpW4c4nPl/h82eOXPf7v0eOX+HyZu8vc/Wvm7m/A5zkaehyfg+DF+By07TVRYqm3FFz/c5jOqZJLwOEtjM83GIMKgzOuQCiRQLGxXETolt2+15m72mo79zp46BQ30Ty6IUsY0YmXJSFmFRcD7+E1eOuhLWPdLu6aROaObwnebiyoQXRZwOUbqliQ+Xz23Ds/zncabbZ1oimcXe3jBZzlWTsKXHiAT4mf5F/c1ZqaDNWO2azSjaU8tHgYYsbYV+S3XNscSnM6QrerJHx4Tp8fN57SwzF5RI9F5ntyLdALSDmjHolfu9B8QQDcrT53rblqKrRp684tdkZkXfFGyYQvCtN7jFc/fLhcqd1QzCwhXqX5No4U5wgRLmu94kyfJnGnSUw2cteAe423JpRGYhhCYfExulBKXB/nRjhFve+jQLNJaZLimkCzatdS1a0KqRW2K0tS4Okg4kupsjFvhdse7w905G4ouyvHLXGoqRrxjaH6TVDa7onruNBL1vT6WiH+UXBrOW4t5mZXZqRwpr323S0cH7lMLGRo2Vpfvbjj16rxo80URojrrAxkiVyO5rsuv/DaV8vR4Ncifk05PkYfxho9tTlNuBJWXOs+Fv7YGKv+KQSFDqXB9ShDFn21WHe0aIszotVdq4nUcku2dAsIkeU7QWJELpjkgDo0AxQD7BYFLiV/Yc8i53/ha7u/NHTm4Wu6iA9KukT91TLTgi1asOVqgM3ld32KAgu5TTpwHXABcFD5nytBLmit5jleC6s6s+/wHGoNPkRlLjbedz/2qwKX/yX4AVGXNCjBBLDLt3902y7nRc2qYaziaGDWgvPyhgY9csZuTt7yaIr65p9NX9K4V52g0K3RP7pKP1JJ/jx19/9U8ZaV5u9YaXLIS+HGy+Z7g3qQO7Q2f55n+Rsa/IunnKmMrbFzqT5lqrMhxEwxzTntj7Xik4BYyZSQ3yrFlZlwHgLuUvLTBWZiNOK76gkElti76RD82uIDtlqRDxPTNovuToDrJ5Pvty5g5XNykjgsHCfoKnUW0f1uCJFN6Juh57wbaOtnrghh1xWpQjPDMK6cVWQkhQ2Zos0bjmRiz4Z0ZIzdaM2Jz6wFH9r8vBiGJI/k3/ZUivTpWjoVAtA14fdzvBE5rbEKY9rooYICTKnaCu+PL+c4glnkLrW3TTLq5JNsh2jBJP9iChM22tje0RBtmbArrfF9V33gVX3ORYcFtW8PZz54KI/Llx8JLj8SXH4k+Bs+EsxBEO1eOzGdvlJOZm437Y4xrr35YwxM3OeP18qTDOyNx3T4AfL7ezqvo239Aw3/mik6DLq+qXbtfNqBIkN/B97+EC1s9uvCek6/yhUIVviN41d9c7hQz+IsOppWx1Ae/vys6PQKCj7cgModL7LM7oE7gKxNmXtFR0cF5aHQ+RkdxTLEXgQ78z9gIDTW/wKnNZkZ +sidebar_class_name: "post api-method" +info_path: docs/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 'Generate a Campaign from Template' (start-generate-campaign-template)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/start-predict-sod-violations.api.mdx b/docs/api/v3/start-predict-sod-violations.api.mdx new file mode 100644 index 000000000..f278aba0d --- /dev/null +++ b/docs/api/v3/start-predict-sod-violations.api.mdx @@ -0,0 +1,121 @@ +--- +id: start-predict-sod-violations +sidebar_label: Predict SOD violations for identity. +hide_title: true +hide_table_of_contents: true +api: eJztXHtz2zYS/yoY3R9tOqasl2XLM50bRZYTtYqlSnIyGSfjQiQosaFIHkHaUT3+7re7AF96+NXe9ZrjZCYWSWCxD+xvF0sQdxUpzDh0onXl9OqucilF2PO9SHyNunG0hHsVx/JOpW8ZN47v8sjxvdNQcKvy+f7zQcUPREj3BlbltCIjHkbjUFiOGU19633SQVYOKhFfSKQ2HZ2x3AOgYQlphk6A10BjtnQk644HDP7EUlgs8pm5FOYX5thsEXIvcrwFk/5KMG5ZDvbiLuOmKaQUkt36sWsxk0NXFi0Fk/H8N2FGSGUumOOxVArm24x7a4YMBb7rmI6QVTYRURx6kvqmTfGSR5o2kCHyVvWT98nrAuUvwmO3TrRko8mb6+7Zu8EF80OSgYMKfdQtShOKf8VOqCXirgtElahVUA8+FDJ67Vtgh7tK0rZyGoWxOKiYaBIvwkc8CIBZ4uvwN4k6u6tI0NCK46+iMrsecyzohxwQh5xJEZHkpDCtFlAkDHWQGxWtrvoN8IFqPRE2GSxaBwKI+6RZeBqEOA0i0B9ykOu4xc8gYcax9NBkWtBlJSUroxAsDNfiK18FLt5qmJ36Se3kqH1iHjU6ZrtWh18mb9udmllv1puV+wKLW8POwJiuI0lwYsAVK/hL4oNmJbAcMhtsFvhSOnO3YHqYM5wFobjBnjea4xy/PAz5Gi6dSKxo7E31FHnpZ+MDadONLZzPYJdAmI7tmEUDVbfUq6jfbWlr7yjfSXY2GzFsj9SEF6/Qvv2L2WA27L+Dv2jTTNn5B6BXx3ruaIOz6g7rdY6Pm5YQzUat3hL1pqg3GrUOXeAoHl89WyrLkYHL1wz7FkfsXfyYM3O11akJ2xJHB6PLH0fhoufjj6kIbxxTnIkgOjjr/fj2l+4Z/nV9cM3K/f19jt5VyldeN0o1ydw8bp807A4/obnZ7Ji1o9pJu87n9UoiHHI18GCWrRT8dMnAyEoEjp/8NaTiC3mZwXWBq4OXMdIxgZHGXkZmwlx6vusv1s9i5jPqiJScc+wPADIX4lbJVskrsQgMj7t00aNLE+wxARohFDIApFL40KjVtgEwDbhMx3aMyC+PKQraEDoj7ngKvxBf8RdAF8ZOjKpZqIWEQSKWWiKCjhAC52sV/VIwzYceHQthnjwabNIhUrkyEEmAucj+UMeBnSrZi+HFUSldoDgNYXxk56fnHtRPk4z1SxE9o7ATzuHx9Xg0HPQ+FtE8d/+JYJ4baBPJa3a9bjd4yzg2Oy2jNbebBm/MLeO41Tg6qdmiObeegea5gfZD+etYOh5mKth6rPSeBx5IM9Xds8jPe+cey+3T9T6F7ZMka99lNyJcgy/4biINdQLP3JHbCjKcxAmoOJSQoQaBH6JTYAZS8Bu5l/9nRfF9bGRcqPyWclRbhMIzwREJWsDFbZAJPVuBZQ+yWRE6hAte7Lp8jsPZ3JVi1zCa/O3SMZcJXqjk2hV2BPm3xUJnsYzYEn9iIpYASDFPQ/YWfqRVA7qC4OCHlDpBDoftM+96eAbguHkhHm5t6paIGk+GFvHVFHSPJd2rDJQRCtQwZyuH1h51kn7Fv+LFUY0R9mC2GelstZoHpP1A88QJridMt9cbXV7MrnujyaQ/7M4Gowv4fXE+eAON4GF/Or0eT0bng2E/uzHp/3LZn86uu2N49L47VE+QDv4aj8FbiBJc9brvxt3Bm/zPayA260/wTn8yG5znGg8vp/rJ6OKi35uNJtfT3tv+uy7cKs7gN6P3/clF96LXv34zGV2O4dbgjJp8zP3MsZ7e0szDreHgvN/72Bv2r6ez7gwbjbvT6YfRJPX4g8pkRL0nl/QnBwZ4cTnp4d1Z9436/xok6b8ZTT7S5fRnGGt6OcShJv3xaDLLrpHQ+8FomEiemKHbmw3eKxmAj5+VaFu4ASEX7aeX2omHpEgC8SAPI7jQ09MoScsu/FuYWXbIYT7EJqxwN1A2p8oEWAFPZziHnhg1BmcJW3664FZeT3E+xRVGqYaQz17fPS2mvI1X3DOwPoHAVIgrf4A/yNbeCjc4E/LL85JFoKHSohznc4gUgntbrH9YCmAvLFQt0sU7d1GmNcCkpcBQr98hYni+SjdsHrtRCsUp81g/QCTfmFGqeya2qg7oggqqSrPJEgmY7XICW8ezMFWELjmGNTu3XEKHiHtRbib1EzhMYDdZHXwD8fFZa8R2u95uz4/mNZjf9fax2WwIu1nn7XYlP1HIYE9ZZuwjd1wgR/OhuFjbMgjOVArDZWAsA2MZGMvAWAbGMjCWgRED466nGyvhfJv3G/UopYytp/odGWpVlfBau6p2PfA3L2L9MAT7GvrVFJjbUf6qy2QwIS16v+R4N9x16FXKk0t7D8dMS8B63e351hMA5tzxhLEIYX0PHApi2YSODCjeOLRQX/kQ6BXJdJGP7YqIC5qo1tlrcOeJlq+nhUFFhtz8ArQGTwDeS8+B/izpgq+c0E/2DCuOBZ+3a51Gy263OG+ctOrHR/OOzZvNWueo08HRV2B1vhCP1xjfCA9mhskI7ZzfQSGqAEoM0OBPrzUSjSfon95xUdtUTM0vw4l4APnV696YtY6Zy71FTPf5YkMJnnE5hTtZYUf5nGZiBDmi4z2URJ31z7tJnNfJBdLaFbc1WgKrMBeWEIajTABESylcKhVX2Q+a6g8gEE+qR6qho67kWoIymYZ66KFH39EjT5rZob8quJKpvJZ971RF9YDN8d6KRxAM5xzfRfsqe/gBESCIjKHW5A9sCUFIhK+qrJu9kwZvBKLQf52+Y02yWDvGVINiix9HGKkgUhZtkamyaI0MTYZ5o6BzIN48Ok+6kOUAcyRm3gvT2aJZTKKZpTVX5G6WUxqpdO1FHAAN32tjMTQMMTjMQTYHIpWGIzSXBODxknYpYhVgFrl5p5ihoi6WIfGF++N+N3YBfgwSLX1wI9K3DxCjFRoVtg5oRNJlROqsW6XmShyf2Y5wrdJ3S98tffeJvrv5cKLfVeqnlPrUt1OfS09vncHguZX6qIKB5yf7a35Xyz9lyAPM/XWK9NOHmd6f42D+HeAbxj8xP1KhfPsNaWoPdX9OrykSYxVsgQySHpUENiCRsE6J74xjUpRSVXN7tHM/nDswQb0dKSKgZsjWfsw4qCyMPfWuVh4wyxfS+w5fu9yI3F4gWvIJzzIC3/GiMpMsM8kyGpXR6NuJRmUmWfpu6bt/T999MJNMuSJv0XmSjFcrHq71ewL1nLbWMmjAkl1zLHU5MtVmtoLEWJpjVYqZQ2XeqM/r9rEpWhZvWe1mx26Y7QY/Oq4f1+etBlYcs1h/lflx6mRFn8rZW9mRVIyVdMjjYg8ml4x83yqW/0C9obAR1hB60rwZdF7VWwRV7tjazh0v/AhkA8KQO4Z7youXk6Gq7iryqDc/Dk2BaXa+CIwpJc5hVRgvU8cydSzDTxl+vpnwU6aOpe+Wvvv39N1npY6tx1LH1jNSxxbDFMvGFOuvTB0tyDswNbPBKCCDGYN6PUwbAxAFfunqo3b7iIcLEaWJXiGLbHR2fF7n++wdfkqpkyVZqER6mboQ3qDtCtuGSVv6vm4BEOkxQC0HslucVc5KYE6K2ylcZ+WQH6NAQDdcG107AqmUzyTzLR1FfVUHjoOg4Ppqi/gtd2A6CRvTP6BAddAFAPWfWOPU1vpD9WA2QYmHKDHD/QYCfT6t/x7t2iUwAOZDhIupsvWe7QJ6k50HywjxNVDwlaagZapepupluC/D/bcR7stUvfTd0nf/nr77jFRdZ0P7U3Vo8ORUHdpWayzNpc5pz/B/O2MnV9Ec0PRmvkm5upXl4JRXwFRChgKfCq0Bx4NaKoeFQ1rkYaA2mUIDtQpQTMWhC22XURTI08PDO7AV2Oi+ygOnmmyq9vzbqumvDm+aO5AHN5oqLwPssmJTfUg/HuilRpU0HDo4iRXi0QBK33ondkWC3mmHwYP0k73pa1iFMEXmALcf6wlFt4HNAFYT30n96TDqZ0tGkO0ydO8fk+d98yE5FJE9cuxS34NjQXsGXG6Ipz8aTg7kmWLarUbfOpYnCyVY8G9sDTbCZg32WvAQd6LTHpjvf/owe8UWmGySs+On1QsmHFwdgLuMYYoQmHWT/SDYieJL6MeLJTHeLey4QedhtgsCs0/eVAh2lf+wYgKwTCrFToKQAHt9/j6xjCVuhIsBsJppEieeY3mHoKFDXuj3ioIdrQqc7OyE6ifPYGcOYhDOemqjRVQHE1wFiVw8J9dLmfhHQs1Q1AyiJl9tcKFUe2WqHdwmeCKS4K4kbb14cEXPyNEz6EgkA6lu8oCa0HwU90mZidVezEeBnoH0inx88j7QJyTFbkwBF5NLOkhpwMyl70vxT8Zw6qAbXC1i8KIXs0XfrRjkEUajlmPJUEMajgF5IfE3BMfw1GTic4zLlJb4qkJCLvkrWRZ8/lf6Hu3Xgsx0+wq/V4OWlm/KF/OMAxo4oKEwQGr+VXTCiQW+jTKoz+5oAvQy+xMSaEZzmKdo7UR1In9IfTA0mMAqUZHBqbo4zQBO/2L0AFunbQCCMa1Od47heVaaFoaogrKSgsCmBrf5dX2IjBt6U/ymrzUxWv6vyYsSd7O6ychz1382Su9Bkv8d3P2LEK9Emm8RaXSii/XHSXYwXr88S+o/eZYUDAxkyMwbp3ohqKjseLtqqs5ZhP/hqVSfQcIKhuOhL/jlJOaMeTIBrE6QV8JQc+kIqrcEgkeYaR+gH/srwj1YXiRnOiKhRQhtACQlcMvnjgv0quwDnhNjwpTGxSzucwaqv/l6VTuFWT1Gp2BniaNAwrpaxR5+OApMxCvGwR0f8SbLkWYsk7MCPZFI5lPanPZKEBDdFFVBJ9GIcCVHtj5qLuc0j4wFPpMc0AWKRItoU2eCTET2pWdxufMYbfBUYyncAJfTELEgeRW5Ed4NZlsUgZinXwX54eJQd5KH2BaI4NJSTYZmFRbReAsXprD2z9HVXzxufKZKkSXx5erm5LrL3kv8vx4LqvEB132HAVYrUbuxWoeqZf9Vpbjsp6KiWvjDUnKJFQJoc3eHRS1cBd/jbYBUrJhcfc4WuXgFtFVxi0Dyi8Ciin6bYtA372n1ZPs1EaKZ6qEKZg+2/ZwrYoxHdAbBXJ98ulL1mJDfwk38/7TyCf5V8KxZJSA0ovt3laS6CW0U3ST13JV56R8o5v39vwFghNKC +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 possible violations in a preventive check. + +
  • Array [
  • ]
+ +Violation Contexts + +
Schema
    violationContexts object[]
    + +List of Violation Contexts + +
  • Array [
    • policy object
    + +SOD policy. + +
    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. + +
  • Array [
  • ]
    • rightCriteria object
    criteriaList object[]
    + +List of exception criteria. There is a min of 1 and max of 50 items in the list. + +
  • Array [
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/start-report.api.mdx b/docs/api/v3/start-report.api.mdx new file mode 100644 index 000000000..10bc34284 --- /dev/null +++ b/docs/api/v3/start-report.api.mdx @@ -0,0 +1,123 @@ +--- +id: start-report +sidebar_label: Run Report +hide_title: true +hide_table_of_contents: true +api: eJztXHtz4zaS/yooXdXtTEqS9bJl+Z8rja3ZaNdjO5K8s7vO1AQiQQkZCtQCpD3aKX/3626AL1F+JrnLpuRUZSQSbHQ3+vHrJqBvtZgvTO3kpjYR60jHhp3xmLPR11hzL5aRqn2q13xhPC3X9PWkNkmUYZxpGs+450Xal2rB4ohJtU7i9I4vYi5D02TjgKlINbxIeYnWQsUs5uYLk0Al1IL7G6YTpYjEUigmkUKcaGXqLIIr+k4awZS4s4958Egs4Fnlp+OatXotWgvNkcOxDzyamOvYSgT3jICJZbwBMb/Vro3Qp5GKxdd4mMRLFN2sTyzPJ5Z47dM9SK3FvxJh4neRDw9+q3n4jIrxI1+vQ+nRbAc/G1TKt5rxlmLF8VO8WQtgIZr/LDycvay9M6sVxudRripQ3VywtY48YYzwUR74AhLFUhikacfNiHI2g4k1KA3GCpWsUI7h6enl9cVsCpfGZ6OL2Xg2Hk0/n41mw/F5+WL+5R+fryaX78fno8/ZhdFkcjmBEZeTq++HF59LT01Hw8np959Hf7+6nMzg+/XF6eVkMjofzkZnn7P5KzYDSofFhRV3Ym1QZF8EUgl2t+SZIswySkK/pAwwKrQLNjkbMVi6W+kJ1I/4ylfrENWwQ9T7eo3rRbKC9SL1RUpcBrT6sYzpoYKqHl+vYUqHBZFmQ7D2BAx49JXYfZOSeVuz9iK18HElChaC9hcl2hMXfCWIfMCTMJ523yXeFxGDrdVztnYu20sYHPvwUaLZpP6XqvZNlfY219us1cHowWFDcAn/UoWbh3h9PY9V3p7iaRcLj9jwK/jasCsdBTIU+YWR1nB/i9mHZq3YAkSZCMIPWMOtmJIpPGUGFc9j/812e9rLJLzU6yVXuxagMuNbCrDXKreA1Pjzh3ay9KIF3A4nLxFmKrj2lqkrpjyVKG7zAgFdb3Yq/1MhopQCPEzb8Qbt49bxoC/6/V5n3mm14dNxu3/cCfqtw/mg7OEQ4iGDTj0plCc+RvqLz3dNeRLrRNxvSziDQGfDesPqgK34+o0vKRVzvXnL7mS8pHiYBThIjcKH5QlyE3XBE8g0a/cwSapumxFdCsIo6WSmIFmwijRJuQyK6S1ZrWB+9LnqMJ0m2lseJmI7X+0OaqX4vFM5lehjVUZ/xWV1itTCrCNlrCydVsvSfST1OsyRpmDAFk2KeL9Bmv85mjNYHcIv+FwdFhnEIhcLZSC8jReKataPn8j3P1wPJ7N/woUfri5P4Z8PoOdLVO4P16NrcMnZcPrXai7GVWFRQEZUZCxRvtDhBnXiUm7Vmtg4Zl6aojn7VwIw69/0eJ0hE0jMcoGkDX5FpBjA4iwPzEZ5mZ7z/O24hiWU/i5pt5CEkuDFlmMCEBJvMElWGUihy8R5p3fstY8C0cG/eWfu9wZH7cPecbvbxr8aWU4RXO3BVBVMleZ/aoXO8m+pmaWGlOh1ZMjsD8AynKuZMgdDB1yA2VsJoN+RkHnYcTKYjYnFqon8rTmWFTb8VtlTSRjyORK3YaXMLj6VTmLpkHEdOJ5lwMRXaSpcJj7UKS4+AgchTxSEBv20eorzVRyMkT3zONoyYy+MEp/7K6lwMlulPMNZLH+2ZMLl8LG4qdcgU6w4hLgafm/EknBpPlmn1Wk1WoNGqz/rdU7avZNWq9k96v2zIOfOubf1vHOanQxSuZZy9zgjh502MeJFOOgBLbyeE0e2oKzH2Gk3291+kR14bgqRPTHP4SqNNNPr09PRFAPCx+HkYnzxZ/iUho3ZaPJhfIEBgb58uHIBpVqVV/g3xEjZjqaJh5aGHK/gX74oJhrIydphlSLlc7D+1GDTh8BHfUyN4KQQe3JTbjL2XkerSniGMGXWkCcBATPwEsESk/Aw3BRi1B3XmI8pZwjE22XWb0BiCf5uduXe56XNh9OgE6tZyK3ji/eXbkWy5SiCRHsHIRTyWphuHkWh4CqHfLWTgIemEnfeh3wB4VpghyNlgHoiyopfkp4owGROSb/mdKniS/M5TPVFbJ5W5AdHzN5+MBMjtA2iMIzucBS3tcQb85YFNtiDHWV474QN6+/qpxRwIo+H8t/Cn4mv8fOZ8WyHJ4fLREewOccsGHK1SNIF/2UcOjBKfagnXWm25RYAi2DFTB2zjBLomYCxX2v2vjTrkG/O+VyETytqGMP1eQIgtHC9rA9GfZR03EPZtUx2SkkZfRjCJ0dts4wCU0CiMgUpMBuzU87yFNSbzKmaSolUqIcKkQlrDt8nvfPwakfASOe7L5WCkV7gcqoGfkBWQekLjTH0xUjj1HU/dZb04m30RdkfzB39sVmu3dB2JmQvD9RvDiFt3O1n1m6TvPxx5th8WSGHT56JwNW+DxeRWXGfVS0I958G6AW4gxm4uxOZVKz7pSCyjCHL8K6I7mqD426nc3xYK0KhnXwRUCnhlB3DHIAoZuObT4V4gl/KvlG2x6I57rQeQ00S2yP5DSyi0r8pGUOpQ/PbGEA70+COIOHFjDo+FItYgMBkFHITS89xBhH9dPq3rcVHJy4t+ax12Bl0KyveeoCRrRXfGtZt9g7bL1pxEuF7bpZA71C0O17QH3hHfX/QEZ2u3/OPvXlXDPq94Ljvt4964vjI7/Hesd/tCC84Hhz1Dj3uBX436OBrkqL51C3tK665TTBeFCYr5CJNJqiReiC1Id3UUXn0QazAVOpuXeo5v00qVM7TlgZiYVHHN0x1TsCzadb4xqfO12vTdB9dV9HdQrNQEM1R9lrur8j6nRKa3u4MDoU354feYQ/+ugNvMBhw4R11jz3R4f1+PxWsdtJvwV8f+3M6Lku1Fct3OI/NTL1dnaTTUGIgt23hBngMLh5W12lZR2+O2DzyN4ixpALvkf4vai9t5Xry1dPIf0ZKfi+VaCw0l8ghQUuAMT41BW4lvblbRVq4gJlGyioERU002+wd90FeK9+pEwazFHjbF6A1fkELxz0CUTnL1TumFX3B50etQacXHPU47xz32v3D+SDg3W5rcDgYvKiW+bMAG5Iey1AlrBUH3RMDFsk/G29ZRPmMQiNHn6mYKf5GiFoHCP7u9Ir1+hkshdi72FKCalxPKwAjhcfiUsuF3NmaScuZs9H74fU5hujJ6Ifr0RQ+Ia1KGTlUjNwPWxBoC8vorgif77hhRoSgDuE32XeO6ncgEFemOFCaQnplrjSBJ9zsO54okraxuuhKKZ5/I5uiWYd60WBrPIYYbhF9ZNP5d0MIM+u4ce40+R1Um9wX+m2TDTPwxyiXIW7cUBvT9/PGWJCAKwsqG7Bxq6K40iLLVbkN91Kodl5cFHSOZ5UuQy+GmphsouSFebVmWXTrg2UMzVMtYlKlkUo3KsY3+R6V21S/QFqEYM1kbNIWHC6XgcCj0nFZxCoiUAp3rsA6iyO65/HEPMPvrkIIPw0SLbtxK5zzGczDNhrRaqTL5CKSazDQw25UtlxZPwLqzdDf++7ed/e++0zf3b45ce/P3F2CPu0q9LlW7n02Js8K9NFkPSpi6SDbd7YLWce2gINIf/k4A8f+gtt9DBNf1/gq71fER1lTbrssTNfDXp+7TUdZ6s/XAhkkPVoJbAvohPjOOS6gxG51tveRnkswULUDIkLU1GwTJQwKj+xVJDd15kfCqD/FbMkhPlrQbCMgzqr8xjqSKt4jyT2S3GejfTb642SjPZLc++7ed/8zffdRJFl+R+FwUt5/Bktz91FazmAAS3dysczlsuZzEa0gMZZhrFoZOdTmnfa8HfQ90fN5zz/qDoKOd9Thh/12vz3vdfrlDmzux5mTlX2qsN52He1WPaFvAcfRzikTR5Ffbv/RBu8AwxqGngw3g85BpZ8y7NgZVLHjLIrYB642KUIyJQypch1hTIOxKxyr07EwgLMFxEV68y6BLzQluRJARePGs1CuJDkvSgF09aYxDGIQxTpKvgHMzSKVFybAIUWCMLK7/e+4BCFFgJgPKBCCXUB0/hXRqVuiX4Tk2QQlPkeJ2eirZ18OZsj9cFd/dwzMa4wRU7vADzR6dfrCPlFQENiYleHOPT7f4/N9jt/n+D9Gjt/j873v7n33P9N3X4DPHRp6GJ/DgGfjcxjbbLEMS72n3Yn/1zCdXMVxQObNIo+Oofo5BidcAaaEDK0jQ0GE49HQmtsFbg50Qgf5CA5aThIdwoBlHK/NycHBN1ggWJj7Jl/LZroTS0V3TS9aHdx2d4Qb3BdgXQsClp/Q9jU2vBq7osLuudESLdeGOZqgcFoGbRSUTQ3hR+krt+N8EyUQ2IhMHY+hOCuiy7hpBUqIPxm3SQ+VUpERZLvW4f1T8vyt+5gclsgDcuxS36NzwXgGXG6Jh+x/ys/9ThFr29krp3/z/IH1Wacy2SUO67B3gmsoBOwrizd/+Th7yxaIMMnDE9q6LyTtreXsCkyEItgwbd/jQ5RUdJQs7H7UYekFCXoMC0IQmP2opkKwm/Ts4QWE9gnEYlIpPiTI/fGpT2/SlfHFrQgx6zVzTaLhSV8dgIYOeOm5t5ThqBSQym6Nx72fP6oGO5MYeCRmahzjRKTKjt2sU7l4Qa7XMvFfKbWGpdYgaubtFhdWtTee3XDjgdsiCR4a0tarJ7f0GgV6WDfBFaS6zQNqwvFRfq3lpav2aj5K9BpIr8zHj+rjUkL6LD/GbLRKN8+PmbeMIiP+hzE0HXSDm0UCXvRqtu5w0gZ5RKPTKrDUsFM2ZAPAIPF3Do6hrDHZs26ERSKAacq3LvkTrSz4/E903u2nksx0+QZyJo70I8+8mmecsIETNmwMMI5/dwwamAXfRhnsTjcygNN8/SkSOEYLMc/S2hnVifwBPYOpwQNWiYpZn9gvJ3mAc58Y3cDR2RgIwYilsxd98J05WrQxuqistAuwrcEqv2EE6XBLb5bfrAuFKfL3Ji9KPMybJXjq89eO0g9Ekt9P3P1/inj7SPNHjDQO3WLTcZL/nMkoP97wwoPaDx2Mtz9rAL7zzHPx08d+EcPVaSb7XgP1g3ZvG3N7AUVCDyJNpj8FUfBbC0Cr3Ug6Nyvg/3DX2N+rgcoAt4lnx4SKZNYhj9FNKUx5Symoj7EWeLAlFHV0lWhFoSU9X2ssoQXti9awBhwqTxkCvSb7CIWi8kBuLBJx5wdQ/Tly1eIUDOcK7Y6dpbYImHC1ShT+/AQwkawYB4t/wmB9abzExlWoGZVIJaOf0WHZU2mQQU9AVTSpXNIrcxlM7aHggl0+MReYpXHdblAkrohyq50JMsETUxjbYFy5oniKNjhDYynCNR0EA7ag6CzM8GE8q1AEYsoaXTPSiwP3kDnAsUAEqzdrDN0mFKd0gAIKPqipC3QnicqPfmwdfc66+r/Tn0FyaRLrm4M1tuJQxMTWW7amvXE+j6uBVS3USUuseeHGt2/YpsES7x4vuz30eCIhreDwGxC07Roqg+mIYM29H2hQIMn6AdUXH1hU2idsC+jRsZ8KZfnVJTbDanP3Y0wr22HQ/A6lgP+f1H6E/2r4O1DW1DC24fVvtbRfB2Ms3RRX7YIV7gOKeX//vzeY7Ic= +sidebar_class_name: "post api-method" +info_path: docs/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 'Run Report' (start-report)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Run Report

+ + + + + +Runs a report according to input report details. If non-concurrent task is already running then it returns, otherwise new task creates and returns. + +## Request + +

Body

required
    arguments object
    + +The string-object map(dictionary) with the arguments needed for report processing. + +
    oneOf
    filters object
    + +The filters to be applied for each filtered field name. + +
    property name* Filter
    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. + +
    query objectrequired
    + +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. + +
+ +Details about running report task. + +
Schema
    messages object[]
    + +List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. + +
  • Array [
  • ]
    • returns object[]
    + +Task definition results, if necessary. + +
  • Array [
  • ]
    • attributes object
    + +Extra attributes map(dictionary) needed for the report. + +
 Identities Details Report task result. Identities Details Report task result.
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/start-sod-all-policies-for-org.api.mdx b/docs/api/v3/start-sod-all-policies-for-org.api.mdx new file mode 100644 index 000000000..d6ca27f40 --- /dev/null +++ b/docs/api/v3/start-sod-all-policies-for-org.api.mdx @@ -0,0 +1,83 @@ +--- +id: start-sod-all-policies-for-org +sidebar_label: Runs all policies for org +hide_title: true +hide_table_of_contents: true +api: eJztW1tz2zYW/isY7kOTjCnrall+2VFspetOEruy3Tw4nhYiQQkNBaogaUfr8X/f7wAgRUqK7WQzu21HkxmHIg8Ozh3fAcF7LxVBrmW29I6u772rVOjjRGXiczbMsxnueTJUR2kS+rcyiXkmE3V0B3Lh3Tzc7HnJQmhz8zT0jrw04zq7SMJhHJ8nsQykSN8k+kxPvT0v49OU2F2cnTDzcOlhfCjSQMsFccD4ca5SNs/jTPoLQ8K0WCQ6Y1GiWTYTLNHTBjuNGGe15xiUaAEKrliv2WyyUtZ0z4xzbOZCmZtEmZkHJSGL5Vxm7I6nTHwOhAhF6GYFpZ3MzGy5/ZGLNGMStPNFtqzNoUkHGsnj2A6EFRrsDCT6TqZiO3Gi4qV5EMk4ExqTOwVjiYkWOrmVkKgBO7rJXychPHZvfkrQe0cRj8HdC8h7KqNnfLEAD6Pe/u8pWfjeS4OZmHO6ypYLAZsnk99FkIExJoEzM0hLTws5rKveQorKGK41X3rr3nu3xXF3ElaYCFLUmRNGMzolEZNhCiaIpXlaYZ5mWiqKGPGZzxexoKCZHB4cBmG36UcR7/rdTqfvD4Jm32/xXuuwexBEfNDFiIMOb/Z5f+J3BkR2yLk/6B2Efq8ZHLb7oZjwNkfcPjwgHGVGrK3QVsmxtaz3UJl6uyG+v0AP5Nh0gdi05m83m/TfWnqICJKoAJGerEXvKp5YxtNPFCjPDgQE6llksn89JOrTU+Y6725OLFIYsrERRpbjpm+/ljM7uTxjxISmECqfkxPGo/Oz8eWv49HF1dtLqial29Yewboy/C5inJ40qpHptYNB67B52OmFrUGLHx40W72wfdjt9SbdSbsD52JqxefPsMG/8jlXvhY85JNYMBpEOUJufp7hV0KtSixrsV+KEV417FGkx4bB2Iw/yRJI+lRNQHnP8q2pumZHQ0fS88dkr7ry4ur4eHRxgTsfhuP3p+9/xNVoPD4b4//L0fjd6fvh5ejE/Hh3/mvx5Hz0/oRoa64vbiKpblYKV7Ut82gt1Qv9ShZ7haL1cLLR5HX6k84EPvajzgDJfRAd+jzgoT/ptdudwcEg4geHXuF+W2jYz7nQS2aF8Wzed7el+nEskbtspDWKpo8BWa4VVgVZX4EmWAVoGZLqlscy/Kq0f9zXoci4jI+T8Bmh+0Yq4U81lyShMCIHGOiWLYywy7NlWQS1oavHLSzRaLHXPGSuFLNjpwxFrubBJ/A6fUYiXymJ8awYgoWmRBBbphV9wScHzUG7Gx10OUf6tvq9CdzX6TQHvcGAZp+LNOXTak37wiL4o1BCy4DFSQCP/BsGQUrD9kYAM/mWJe8LPjA8nmH/S+hlaUs1nbyMgNwe0vD18Tnr9lnM1TQ39/l0zQjKv6L0U3kcUwHyjjKdC2huGZ9pOZVq6yrtMvhk9GZok2M8+vlqdIEr4rWB8YYK0RpSWBLsidgsuTMSOwUIgKUihjkAd9grx/UVFOIGt5WE0v5KlymMidiKONVB9srNvmVElTWLdDKvpVJgUS97IRuisQfMgntzngUzNuEpBsCFRP5qGARikflvnSVfsRlKttAvG2wYhpKU5DFDNoIpxi8J/PCQ0KS0DKIcqQxhZDZL8oypJJOBqPtiZcq6N1bV7G3VKZQckPzpOBkGWQ7hjJrVLCyjxYno/AOZreXq0l1WjGZMulQZD6AFcMQSZtQaFmYT6CYBzF05InelKDyqoCsrVnVVMuXunRXGLEl4FvA8fUbenccoP75RrXxwK1zypQSYHIgmbxRuchXJoSkzuIDahS2KxAcwF3G4y91d7u5y95m5u/5w7Boc99RAn9Ym9LlSPId9tVk8N6CPNtGjElYQWURpHbnHYBAHkX76cInE/iSUadM/L6hJ/o74yC7lG8IPS3/Y+xOCH6Wzar4gAY0drQYRKpEIj4zcK4mNoaypOpuzvUn0RCJA1RaIiKqp2TLJGdem/VYkCU/3WJiIVP2QsRlHfeTIiDS1FZBmVSEaeKmyHZLcIcndarRbjf4+q9EOSe5yd5e7f83cfRRJllKZbHE4Kc3nc66XNtLcc7shCQJWbLWzMuWMq9bRCjFjJcby6sjBm7Rbk1bUD0Q35N3woDOI2sFBm/f6rX5r0m33vepaf73K4zLJ6jlV8bf1ozExQNwtcFyuEFxpliRhffsvpw3giMoalZ4SN8PmMOlNiR3bg03seJkk7B1XywIhpTUMqVY2opoG2jnR6oIWBJxNURcVQ6mSkItCSc4FuGgEjX2dRslLWoCvXvrDKIMqNlGKICtnkSqIc0hoKkGcEGpOEFgSSorIvNzTS4Ngp6jO3xGdOhf9V0iejUnjt+YF4qh4eVgi9962/d1TCK+pRlxYB39ho9d2O1whANAQ2JpV4s4dPt/h890av1vj/x5r/A6f73J3l7t/zdz9Cnzu0NCX8TkIno3PQdtoshJLvaHg+p/DdJMqTgIT3iwJglyb7eYCgxtcgVAigRZJaooIp+N13n7taJ1vT0bs65zaDQv+rVi5jkE9y7JFerS/fw9vwUsPDb6QDRQxOCxbquSuESTz/dvOltpDhwRsnqF6hXlg9pyH56euw2gYG2tJYWxrnpnAWtxoRQELy5vd4Uf5FydXlkmOKmfY7NHRHRdS5jbEXKCf+CE11A0TQhs6QrcrHT88pc8vncf0sEy+oMc28z06F+gZpFxTzx01KQ5SXhDwtrNvHKdcLSbUrLU3JjsjsjZ7LbhGV2DfX7z46cPlSzYluGnSPU8J6QpJ/QES5hwhYsrZsNjLp0FmhdFJPp0ZwYe1tyWUPiyKoTD7qC6EYNenzgjvUefHKMzGpDRImFpAo25eFJ4Jxa2IaQlsrCxJgSdDtQ8L7fPauJdmuTN9gVS4nJu7jY/KZyeSqpA5kUk0TkXT5rHrRaEXr+j1rUL8o+DmW26+4Za+XJPCmvY6sKdvAuQwseBxaqz1zZNbfn6FHzVRuENc12UgSzg56u+4gsJr3yxHjZ9P/OpyfFQfZhJraX0Ys6WLpVgK45CdsmCWJKn4J2MUOpQG19McWfTNYt3RpL7JCL/drIjk2yl96QMZGvneIjGUDSY+oZXZAJMEmE2FNiV/M55Fzv+Gvjlkv9V0NrevsYASZZgE6TfLTBP6NKFva0Dq5LfrEwUWcpt0MHXABsDxyv+mEjhBKzXP8tpa1Q37fTOGloYAotpDeYsj++NoVeDcFTMPiLqkQQkmYF2+9aNDyo4XLVI1YxVbAusW3JQ3TrA2rtnNyltuSdF6+WfTlzQernZOzlS8/N5V+guV5M9Td/9PFW9Xaf6OlcZBXdqBHK8+Uxg9cZj+O5+mv6HT3gh4o7jrSqppZvHi5k4ibXXPBP7iqakVBtWjZzJdoEFRVTYLIHbKKlNVgpkUZg9iIXhG2HOPIjuZm0oAwE3lB52mYTTVoEHZSIGH+UTG4NdgH9DkqQBOpgaPTm2A6++J6/Qu4OdzChN2UoQOINx8niuMpSzP54wjQJ+Ir1CmQW7LIPo9JQrNEgMky1FFTaDAJVM0TKuj5+lZRJvV6IMrYfTEXIii1O1Uw5DkEXcaeqXIWLgvdUBXbwCe4o3Y9WciXlCLiXACnBOVGd6dXm5wBDOVQi+08ome7rtB6T7Rggk1WzYYOg00lnSLmjX0wxW+5hul6rc99vsdvdHI36826HcfNj3jwya35FKvtL+gPT6yf257N9ssX3vbmmUMpXYZDdgssR/n3N/TZhD1jg90+w86c4/7N6vWkH6Bu90UMv31J0GbEe4thH+5NDjC7Tpsvl6hbtWOsBtNj9LeVJr/8zPacvMm7uutud3H0PyOtMDfI+8j/nn0YZ1NCvrEi+7fe8WuIGgs3wKwbcMr7oLUfHj4D7ZQfS4= +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/start-sod-policy.api.mdx b/docs/api/v3/start-sod-policy.api.mdx new file mode 100644 index 000000000..86b80ae69 --- /dev/null +++ b/docs/api/v3/start-sod-policy.api.mdx @@ -0,0 +1,95 @@ +--- +id: start-sod-policy +sidebar_label: Runs SOD policy violation report +hide_title: true +hide_table_of_contents: true +api: eJztW1tz27YS/isYnocmGVOyLr7IL2dU2+lxJ4l9ZLt5cDMtRIISGgpgANKJ6vF/7+4CpEjJt+RkTpsMX2yJBBZ7328h4CawIiqMzJfBwdVNcGmFOdQqF5/ycZHP4VkgY3VgdRxeS53yXGp18BGGi+Dd7butQGfC0MOTODgIbM5Nfq7jM53KaBlsBTmfWaRxfnrE/EOYFAsbGZnhNJh0MZeWSXWt3wvLMqMjYa1UM6YTVi3JjMi0yVmiDZvJa6EYUsyIYoedJCyfC//VD7VsoY2A51yxne3t7RUtu0WjPUUj8sIoyz7KfF5bL5ULmTPxKRIiFjFbAE98JjogUsYNX4hcGEsKkyhCxkFVW4GCF/BNxvDZRnOx4MHBTZAvM0G6MSBVcLsVGPGhkEaAwnJTiE11iJpw7OSI5ZqZQuHa4hNfZClSE8lgPxkNB+FwT4zC4c5uP5zuTKfh/rA/5Du7g9FevB+ggYywGcgsLLLS397Gf80FJyIRRqhI4EKomQ2tw+os5/Y9shChc6gcyfAsAxZpZPcPi7RuamLzND1NSEVeAXr6h4jyYF3emqybCwtbpDlp3aCn5dLJ4Siuq/bzKbOji1OGREi5qligr06Oz04nF79Njs8vX12gu6603nwFpgRTfw02To6a1u1Ho97+9v5gJ+6Nenx/d7u3E/f3hzs70+G0P+hzXNo522OL/6dYcBUawWM+TQXDSRhYedPJHlD8iqlVDLMe+6WcEdwCL7nM3RAdT4jAhOYf5Ro43XSApjEhaeSFfYIeaRxyzx/ivW7K88vDw+Pzc3jydjx5c/LmJ/h0PJmcTuD/xfHk9cmb8cXxEX15ffZb+ebs+M0Rjm2Yvnx4e4tRVQpcl7aKI7RONXElX0ViqxS06U7Om4K+2I/3wfphfziNwmHc74WjXrQb7vEkiafDvcF0O17lGqeE8NPyT+QMFh7eFeKHqYSYZcfGQP4M2YRyHqQ1mfhU+KEQNmdTHS+ZS8Y8lfFnhfvDNo5FzmV6qOMnuOxLqUQ4M1wih4JYjmAiloZrGWNloMzuSJbOTOOa/gqa6PTYjzwGeZ18h14Y9FjDo/dA6+QJAXypJMxn5RQmY6pD9ywr9gSf7m6P+sNkd8g5hG1vb2c6SvhgsD3aGY1wdV9O6k7PjeHLjaV/EkoYGbFUR2CRP0EhEMqge2KAFke3ycXCPm4DovEE/WMBcmMrMT2/DGHBFoTfj4dnbLjHUq5mBT3nszUlqPASw04VaYqJx5U6kNwRPjVyJtVdrJSRe3T8cuyCYnL838vjc/iEtDbAw1iBt8bolsAq+MJcfySOvQAfuWVWpKAOEXfYC0/1BQjEoebXBkr3zS4tKBN8K+GY/9gLv/odM+qkWWL0ohFKkcNQ7JnsiM4Wm+KzBc+jOZtyCxPAhDj8xTiKRJaHr7wmX7A5pGphnnfYOI4lCslTBtEIRGH+EggxHiMikY5AUkAoC0IvusiZ0rmMRNMWK1U2rbHKYq/qRsHgAM4f95NxlBfAHIlZj8LKWzyL3j7As9Nck7uLmtJIpUuV8wikAPywBDUaAxpmU5BNAqbz6QjNZSHxqHJclbHq1YjS3WvHDJUieBfxwj4h7s5SSD8hiVa9uBY++CwCJZeNyBqlmXxG8iiKJvtRlbnKwGeJFGncxm4bu23sPjF2119OfGPj3xL06W1Cn0vFoY/VhornBvQx5D1Ks3KQQ5LOkFsMFOIh0s9vLyCw30PjCePFpwz7t6+Ij1wp32B+XNnDPZ8i/KiM1bAFMkh6dBIkkIlEfEB8rzgmRTlVDTZXe6nNVIKDqjsgImRNw5a6YBxUBv2gQk44tNKxFlb9kLM5h/zII2zeXQbEVVUcZlqqvEWSLZJsq1Fbjb6fatQiyTZ229j9NmP3QSRZcUXR4nGSLRYLbpbO0/x7txEJA1i5xc6qkCNTraMVJMYqjBU0kUMw7femvWQvEsOYD+PdwSjpR7t9vrPX2+tNh/29oF7rr1ZxXAVZM6Zq9nZ2JBUDiLsGHFcocC6bax03t/8K3PhNMK1h6qlwM+gcVPpuhR2Hm9jxjc5BNiAM2NHcs714OXmF9GFpIo9604WJBMJspzr8uSYnSIk+DJqWNm+hYwsd2/LTlp/vpvy00LGN3TZ2v83Y/SzoOHwMOg4/AzoOGUKsBCHW3wkdY8AdCM0SMArIEBWgXoWwMQNR4JPfffRhn3MzE3kF9Boosj/aRJEXWrPXXC1LsGQbO5FqpS5MbzB2gWNNORYGcH86CLKWBHSLXiUXAjEp+I871INxjAIBXbMMx0kOUrmYKf2tWkWqKC2AQ0oKqca9Vw0+JsGdREKni8yS9kFnkKi/4h6nt9b/tB/MJijxKzrGdFweY6r2f3fuOiVwAswbTBfnztb3HBdwe+ZcQRshPmUufVUQtIXqLVRvy31b7r+Pct9C9TZ229j9NmP3M6C6R0P3Q3UY8GSoDmM726zCUi/Ruf7viJ1CxXNA7s10RFg9XmFwwhXgSshQpmmjlc6xHwRdPO5PJ0shnXRvZHzbrU7Zhu6UbdcUuIXtugLHZGFSmDvP88wedLs3YDuw2W2HZ7IDKQ3Mly+V/tiJ9KJ7PbgjE+HBUxd1kMviIqJOYnx24luPDmncSHRqlwFpAad/khHdF+xAJw4epF+egl5CV8IcmS08Bu4djB4Dmxl0Fz9YGt0hh9qQEWS7NOntY/L8MnhIDkfkHjnuUt+Da8F4BlyuieePLZdXPc4RhrvVNy58rEoL/gDQ31jsFIf12Y+CG+gR3JmYZz+/vXjOZgg+KfgLusAhJHYLED5n4CKU3Mbl+RCcRPXG6GI2J8bHjRM4GEwsSUFg9qs6F4JdnXglvIGsP4E0TSrFSYIyA85696y0TCyuRYoFsbPSJDqejFUXNNTljXnPqfhRlyAVfFzQ086vKmRHEnMS3hpxd0+ciNT0sauslIvX5PpSJv5VUgsdtZCo2edrXDjVXkXuRHcEEY0keGpJW1+8uKMX1uhhSwVPkOo6D6gJz0fz3FRUWu2L+WjQC5Fek49f1du5hMranMZcImMWCmMasxMWzbW24t+MoetgGFzNCoiiL2brIy4aUkSE/e0aS6FbMpQh4ETi7xUEhnLOxKdYpwmmaLdjQiH5O1kWYv536KJj9ntDZnp8BeUUR8Y6sl/MMy4Y4oKhywHW8++qFToWxDbKQHnAOcDhyv6UCTyjtZznaN2Z1Yl8l+ZgaYiAVXfBIztwXw5WCc5/YvQCR1djIAUjzK5OksF35mlhyWooq9wgWNfgJr+phkq5pjfHb/UzJ1bPf5q8KPF4tY9yqtLl187S92SSf07e/ZsyXptpvsdM44Evuhst6zuEupM7tLa5q4fbznMBf+EtRSohbOhf3N1RxDB1MhngZfRpiuloLgXtB2SC54j8ttCv9ILi0N95Ff4S6szAGAhaC2iUT2UK9DrsLTRcKgIVY7OF53CB6h/ad13noOUzNBI7Kg0HAGqxKBTMxRgrFoyDezxi3VjaqHBJCHovJUrJNMG4alYZkeg2qIoOtR1mYU8T3DiGnrRmxEfWAhtav2sMikSL+HttK0Emwl/bhXFN+P0YbfCccC7SDNs9yKAApkRthdcnFxsUgZjyP1VoM+v6SbaLY4EItjrOGQYdaPLwETZO0JvW6E4KyFkP3E9cd6yb1Z75t3YV2pcg7B26Ge6AoUYK18u4VvIqqLeSMOWALkevd5PwCPtJ6FDm2IjCtJsb3DvB5uoWH38oBDbmV+9WvRP1nGBq/AwtbAKJZP0udV21zyb+1vVz+vXnvhvWd4pUbv2p5arrD+Dje4GbBSARtNTAOu3mEFvuhdvvqU3Z+EUEe7KqBz87xZ0vwjJ31Xf/AXQAGewvW2gzVQ== +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/start-violation-check.api.mdx b/docs/api/v3/start-violation-check.api.mdx new file mode 100644 index 000000000..5c4135e7a --- /dev/null +++ b/docs/api/v3/start-violation-check.api.mdx @@ -0,0 +1,101 @@ +--- +id: start-violation-check +sidebar_label: Check SOD violations +hide_title: true +hide_table_of_contents: true +api: eJztXHtv2zgS/yqE7o/dFpZj+RHbAYqDm6R7XqRJNo8tcGlwpSXK5lYmdaSU1Bvku98MScmS7SRNtrjdLdwWjS2Rw3nPjyMxd55mYa54tvD2ru68S83UvhQZ+5KN8mwG1zweiT0tI/+Gy4RmXIo9xWjkXd9fNzyZMmWujSNvz9MZVdmvxbD9GQs/ew0vo1ONdM5PDkh5U3swO2I6VDzF7zD7YsY1GZ2OCRc84zRjmlCCk1KZ8HBBbpjiMQ/NdEL1QoQzJYXMdbJofhQfxYhk8jMT5JZnM3Jy9tN/Rgfvx8eEghgS5SNAXrH/5lyxCIaSkCYJydyiTWAUbzKdvZUR6OLOK8Z6e5nKWcMLUS0iw1s0TRPHyc5vGrm/83Q4Y3OKn+pijQThEcxDDgxrlGiWERkTGoZMa2RlwgiNIliqUVkVNW/njfGGHX3GYqO6bJEyIC4nv7Ewg7upQlNknGnkoDJxjZ9zu3jJ0/igYCFEg7EIVeHI60xxMYXv7AudpwleaofDYNAatnqtaLIb9KNW0Gux1iTutINeZ9Bj3n2N1bXlL2aMTHIRJayiAuA+5gmr6QI/ZzDYMQqSEZ2yEFwAWCQjsJ1iMVNMAAUyz3WGMw+PL8YXR4fv4SdBGSqyUKXoAr7yjM0NX2D+k9g4/aoy6xwf4vIJmwMb4JphkkegE7Si5Sasm7O5ZgxL/W5Npw+u8oMmBxcnJf9M5HP0hops6AFLk1RvgPZ59NzVxgfNTTbu9zsRY512K+iyoMOCdrs1NF9wFUHnz5Yq4jpN6ILg3PqK+8dv2HJosztssThivcbJ5ZsTNd2X+OGcqRsesgOWZo2D/Tf/+mV0gD8TCYHs3QNLZn59UfBBv+3dX+PtMOFw5T3LaEQzWuG9tDv4HUfGaXK6wYKFjPerQo7UhGeKqgX5zBb+DU1yRlLKlW4S8HaMenBWwSB/oYuCc6CfgINPFsbBxy4Sj+Ut0QsN7gkBktlZMF6xLFcChkPWCyXqyyRAcDicXCZlG701rd45kY+NqdyXwCs0YVK2NfUg7g+GbfgUt4L+YNIfRLRLO60eDUCxFc0WrH6APHbMbkfG41HBtVWr2adYoLc7CHvtYbjbCuBTSHfjYSsMOkGnntkq0Vj1auvUBa3+7qAdD+nA0OoMQ8hFg92ATlA065boT2MRSzW3urGMohNBVcmKn762HoVedAHfa/7UeBkjwxAYaT/IyAULZ0Imcrp4FjPXm7y37q1BNQjrt9oP3+pU3PremFoxnUJ5to7fbrXXM/iZLZOQNYp6lvE5XAD7o/u9vEzaOCzTusmywiCAFS9fKZOuboO7PVkYl0M3FiYeFXEFiGHKQUnEzahlq9ZgOBgO46BDB3E3ov1Buzsc7gbDoDfoT+hkuFZAMfsAaMrYxtRs3QOugGWZj8o0AtLoRCSLAn2sM1uOJrczgD0GyThuyS3VxK24ktpb7ZbfCuDfRau1Z/41W+bPv2s59FxGK0DOuke31VpX3b7xTXKolFTEJ2dFxuJWlwVTEwBWCMK4gBzJo2c5y+NmjSAseLIvo68oSe+4YP5UUY4cMsNyCBMxL99wU9rnUoF2DcnCHcy4uiZBE82AvKURKQJi3wmDalQ0/Ay0xl9Riy8Fh/mkmIJOCB7x0LKsz+hkFwpxN97tUtoedIN+bzKMaafTGvaGQ1wdolHTaa12FeinvvRPTACoDolJM/x3UAj4DOjeMGAWrwKmx21gaHyF/tF17dhSTMcvwV1HA/LJ2/1T0u2ThIppbq7T6YoShH95jkk2TxI6wUsYJCC5JXxigncTKwWWOjh8N7o8wnx+dvjL5eE5fEJaa3sSBO8iQrcEVsEXZlCjs6UAGGaaJaAOxKSvHdXXIBAVujqQ22+uvEcspnmSwQy3+oYZVdIkVnJeC6XQbtHIj7zJmg2ACXANckg4IxOqLVbA4a+x8KWZf+Q0+ZrMIK0w9QoAdFkHiEEsgKEBmZXgm1sCcQ6hzEyel4BJhMygRNVtsVRl3RrLXHJUNQoGB3D+tJ+MwiwH5oyY1SgsvcWx6OwDPFvN1bm7qCjNqHQhMhqCFID+F6BGpbDkIN7imSYuHaG5NCQeUYwrM1YNZiI37y0zB5k090Ka66+Iu9ME0o9vRCtv3DAXfGYXZLORsUZhJpeR3LbITHajSnMVgU9gk5RE29jdxu42dr8ydldvnjkc7O4a6BOsQ59L4fpLWDzXoI8y3iNk0YT63YJYa8gGgMwCIv384cJ1r2A8+5IitP2G+MiW8nXMXdrDXp8g/CiNVbMFMmj0aCWIIROxaM/wveTY7iGMqjrrq72TsE8GBxUbICJkTUUWMicUVKZyIQz41w0SSabFDxmZUciPy4aZAbtMRH4quci2SHKLJLfVaFuNvp9qtEWS29jdxu7fM3YfRZIlVyZaHE7S+XxO1cJ6mrtvnigRGECKjiwpQ86YahWtIDFSYiyvjhy8STuYBHE/ZN2IdqPdzjBuh7tt2usH/WDSbfe9aq2/WsZxGWT1mKrY29rRqBhb2IDjcgHOpTMpo3r7Lze9XUxrmHpK3Aw6b5pHNAV27K5jx2OZgWxAGLCjeqC9eHl2ZHvHljzqTeYqxF5u0VrOZjQzkBJ9GDTNTWN3Cx230HFbfrbl5/soP1vouI3dbez+PWP3WdCx+xR07D4DOnYJQqwYIdafCR0jwB0IzWIwCsgQ5qBegbAxBVHgk+s+urDPqJqyrAR6NRTZHm54xC8leU/FogBLutaJFEt1YXqDsXMcq4qxMICSKaRIQSBrcWnfFcDn74BJwX9IwufcxDEKBHTVwh/FGUhlY6bwt3IV+zIZBA4mhURi71WCj3F8ky1G+AcUTB90Con6G/Y4nbX+UD+YnKHERygxOfwSMoYxX/Z/e5veEhgD8wrTxbm19QOvC9ieORWwjWBfUpu+Sgi6hepbqL4t99ty/32U+y1U38buNnb/nrH7DKju0NDDUB0GfDVU7+ELm6TEUu/Quf7viN2EiuPAuDeRocHq0RKDG1wBroQMpdI0WlOKJ4q8ndppIr1TvNNr9wCWpVwlMHKWZane29m5A0uBhe6bNOXN4vVyIW+boZzv3HQ25B18zdTGGGSuKA/ta+CnY7fRaBr9Ko4ubPOdWcBq20iEzgpaN+8XPEofX/RGMy5gD0IsmQae3XDuZC7je/uwl/hBu6MPqJ01GUG2S5XcPyXPr53H5LBEHpBjk/oeXQvGE+ByRTxk/7pRnhs7R9BtV187PbYsJNjub68tdoLD2uQtowp2BPYNmB9//nDxikwRappQzzWiXMZxbwDBcgouYlLZqHgbBCeZ6qJkPp0Zxke1920wdEicgMDkozhnjFxVz1ycQVI2KsVJzOQBnHX9Y2GZiN2wBMtfc6lJdDweiR3Q0A6tzXtlSp3ZE/Dlm//Nj8InBxwzEPq8GeNEtKeJrtJCLlqR66VM/KOg5ltqvqGmX61wYVV7Zc8W4AvjRi000UZbL17c0vMr9HADBVeQ6ioPqAnHR/0tqbCw2ov5qNHzkV6dj4/iw4xDHa1PIzZtEQ1lMInImIQzKTX7JyHoOhgGV9McoujFbN3ior6JCL/dqrDk2yV97gMqNPwdQWAI60x0glXZgBJp+yMmJD8Zy0LMf4I9c0Q+1WQ2l6+geOLISIb6xTzjgj4u6NscoB3/tjahY0Fsowx6ee5of2l/kwkco5WcZ2ltzOqG/I6Zg6UhBFYNFZ3u2S97ywTnPhFzA0eXYyAFI6gu3xvDI5+OFhaomrKKdsCqBtf5TSTUxRW9WX7Lh5pYK/9q8qLEo2XXBE+XfOss/UAm+evk3T8p420zzfeYaRzMxe7j2fLs+OGjJyEfOTn97JOQj5zQrR5A/IMnazcePvwmJ0tBGIhUY7GVA6aYHyzQXW9/Yn9+xuB/uGuSnNmKwEbPHkdE+Fclk8I2A9OBSYfhjDPTOEkZCAKguYEhKecmhRUnc7UlNDXn5xTYmsJWlydAr0k+wM5UhOCduCvFF5aB6m/SbU/PwUFP0b/JQeHzgD3n81zgQXtgIp8TCpH1RGBEXIe5zd+wSRWskEwaBFzOKpIZRhyqwpx1Z2quT2Jn0Ir/P7EWuL927XVQJFrEuc9SkDNW/OaGxsrO5SnaEHT+jCUp7ouh+AAOZZUV3o8v1igCMeGe6Ug13XGT9A6OBSK4S7TO0GnCbhgv4Q4TNvEVuubUYv30qF51prvlA4U//9dPuGjHzdNOig0/lCu3mzm7c77y6jtntJjZO0OIznCLDSPu7rArhBvJe7wMWQlbDlfXy30ifgPKtjtk8sxnhl0J9zjCv1gYUOHaD+vPWXDramfYjtOjY68rXYDTE+y9eRP3+zXmtqGh6C1cxP/3vI/w18PfKmLFwwO7eP3OK9qDMMbSLdDbJvDiPqCY9/f/A9nh4ss= +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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
    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. + +
+ +Request ID with a timestamp. + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/submit-account-selection.api.mdx b/docs/api/v3/submit-account-selection.api.mdx new file mode 100644 index 000000000..599411912 --- /dev/null +++ b/docs/api/v3/submit-account-selection.api.mdx @@ -0,0 +1,111 @@ +--- +id: submit-account-selection +sidebar_label: Submit Account Selections +hide_title: true +hide_table_of_contents: true +api: eJztHGlv2zj2rxDaD20HkeMzif1l103S2RRpms0xXWxaYGiJttnKlFaUknqD/Pd975G6LKWx02IueAaYcSTy3bco3TthJGKeyFCd+M7I0elkIZOx54WpSi5FIDy85ew4CZ9pZ3TjfAjjL+wkEQvtfNpxfKG9WEa0ZuRczaVm4/MTZqBoxg0cpjNAusWOZTIXMeOKcX8h1Q4LYwZXWHinpJrtemkcC9iSali0SHXCFvyLgBUAOhb/TYVOWkBOxGO+EImIkah7RyL6iCdzuKXgBvwlffitvblYcGd07yTLCK/qJAYszsOOg8BkLIDpJE5FnRXBTo5YOCXa7pBpCUwDSPGVL6IAYYlp72A67Pf6+2LYH+x1J4PJ5KDf7fPBXm+47x84D58MGqD5degvkYxVrF6oEmAXb/EoCqRHqtj9rJGK+zr94eQzSBLI4L4vcSkPzmNUYSKFNkAfSjTeO1MpAv/MiIR+/8KDVDgPDw+rLFuls1zr7IgnHMQf7bAvYil8BpcKcCRCHYFOEfG902238X8rMAvRaeaLhMtAM8MDavHZ3Eclnu9R1TUNr3L3lDK73rBz0D7oDfyuGHT2Dtqdgd/rTg+GbY93BgedzGRAlyI+2Qhhvm0zhGDJaRDwCa62es0hHUkdBXxp9PoUJWjLvtmAvvFtst6Gc8UuwXvnTQSAk67HfdV/aNt3c09Q1me5zGudgLccjMwyCrC9WPBENDI2DeMFBxt1fFjhJhLwVzhpd/bd9r7b6Vx1Dkb9wai332oPD/5Tpwl2sru5UFUrZHdcsww9ULIIfQle9kxSDtz2ntsdXHXbo2531D1oddr9zUgJOMTcNPKJngYtVCCtZXrFlW+74CEJIU8asFyHaewJ9mJ89AJFoxO434RUqHSByemNVFLPie4LgaHC/kzSWNHP468RRd8d51wo32w+5MqDkOdjPiuIKYGqs0SEIDO8wkoiE9qLORJT5CUue8dVyoPskkY+DPmPs/GzAGuVHtKGQW5q4yKxshC+zP46ArJn2R/jCILiLQ/g5y8yDOjyhbiV4g6uvAHDQaZDiLFLvB1m2w7nPAiEmqElnSwi7iVjyClLLTVcuJQzFU6nKLhbjNM7juFmnFUFVxBAqnIraK+LDfltMoFVuV3BugaxxQXz5lohQh7HfFmz1h1Hrqz7jgRSjWjeimI2SyQJj2ci2TyOVrAyA+WZyJ8XR58k4DOkj5bOoqpZ8NxktRlmqBRkMPZ9KErIWkoFxfN4LVckJhBV8KEP3Ap2BPHES8J4STgTAD1JE/FMjNl2NhGwPuOZglCBOJqHSpyliwlktDLO91khvx7ivO5vlnCoqiRVSDDpoYLdlJVrYb7FpZvxPOh03cFg4Ha6nS6iVRyFf+JDUJLJcl1Jk8Kk3ZQR0GTEWBsYKwZsD0WAuqhGoCNT0Dr1UpoFErIoYCjFLFMFW9OkUP07RbEMPRH0QkN82TiG2By9Jj6b0GMxFdDbedBJTJaZixWUPBZHGmqQkmv+Jn6t1nbn3JxBrrTr0RDVVOBu5sFlXMXWZj+9Xd89y2DNtjJI/o9JywsXTeTn5RlUFO+n1Jc/WqidnJ1c/vMYDe/i+O3x4ZX9eXV9cUY/j/99fnJBv86Pz45Ozn7GUmV8dnh8ihcRdbVaK+B9X7UGsrpf5exTOQSMS767hv+bzjeZ84QpAYafhBDnrN2ben992yrq9JplZb27KaGblAM6g6XPbnEO3E7b7QyvOr1Rf4gtTu9g0NBXYDzF3gLYvZtLb77SXxRENFAIprEaEKVKxIwat5xCuNTrNvs4pcRC6FI93mt0hg0EII5G8/0hY4epKcG/rwVez1jOStGuhnZ1tsdsb1DDZS1+HctEJMysb7LKAhcsZDhhaB2FFJZ0OtkUTbalVUF1HgiuhR00smkcLiz3QRDe2YmfyfTXGgxq46RB40hyYz0P08BHL4Zfd8pMJmtSfsuVyJm0s8+GTP9oZl/XBjc3CFT3yWq6fYNjvU6l1snWFUHuKVrAfETwNDGnuCyjRucD5oKYS2ssVGlMLRkbSK8Wjk9tMM5Y0q3iJ/O4QmVapJZbxpW/C7ZKcskkUKLxBnICTnczYVV31ymw93XFK1elXZZ0LQUB8jgO43XEUMy4C3pXEgiEJTJmHPjoSHhUcdNfKgT3Aa/1W/X5/lgxwolcGGoMlJCG9j7zU0S8EnXLXJbaeRpA95tmxoeBxAcAx4iAuSyb3jBZGVuySegvmcQwD9lY+j9wnGzm1Iehv4ZnvZFKuLOYS6SQZAJJzhcM87vEARNbhLGwo+9M+7SuGr9AEq0Oe8194Nfwd2iZQfHF3PsCsNYZGFwrCftZtgXaHQq6j6AV+4JP9trDbn+61+e8e9Dv7A8mwynv9drDwXBIA0moVvlMNFleFbUd/bAg9EAj/wOBQDWibdQn5N+KeCuxBGGsmRbM2pxNSy9LxNdkB2q+14fnrL/PAq5mKV3nsxUhKPf6sikDGsDvYzmTjSV5Vs0eHb8ZX59eUQX7r+vjy6u8Qq35j1Q+mmVIdQrkD6LYMkDOSAlM+C32k4X6EzDElS4vlOYvvdToy76Y8jRIYIfF3rCjDLrIjpkrkd98TdhL2RKtHYiG9NQtgfJtAknVz2YBP0E+F1HinlpJ/sTmgvsiftVi4/xplGkZNOxfUqXr++i6BsA0BVcGYqCrC9MEQ430VvJ4IcrVJjiLIadlpaBzAOVP2wl0dSkQR2yWvTC3Fkui1Q/QbCRXpe6qJDQS6VIlHCI7rAyWIMYYe0YGvRPDp582HKG6NAQela3LI1Y5NFK4e2eIOUpCuufxVK/hd+cBhB+XWMtv3ArrfBpbDhONSBuZmmxEgps0BMHNdlWurszxzUO/re9ufXfru2v67urNC/uk3N6l0qdTL32uFU9BvjElz1rpE5P1qJBli8xY0SiSzlHYEunthytw7C9C4XphHnn9wPrIpPKGZ/2ZPsz1SVYLZqm/1B0BgSRHw8EUIpHwR0R3QTEJyoiqV8cGBfNEgoGqhhKRmrVlmEK1CjpPFR4sYVzvMD8UWr1I2Jzf0lgS6DURELEq341CqX7kwYRtJbmtJLfZaJuNtpXktpLc+u7Wd390JZlTRd5i6ySdLhY8XhpLs/fN0y9YwLIzmyx3ufzRYLlaQWAsr7GcauXgTLqdSWe674m+z/v+Xm847Xp7XT7Y7+x3Jv3uvlPO9TeFH+dOVvWpkr6NHs1jOxHfQh2XKjAunYShXx3/pfRAGcMahp68bgaZg0g/FbVjv147noUJ8AaAoXaMHxkvXl+cmgfWBjzKzRxGQ6cl0ZnZJ5aUNDQVX6VOtqXjtnTcpp9t+vnLpJ9t6bj13a3v/jl9d6PSsf9U6djfoHTss7PsMfLvWTr6UHfQ82xQCvCQvVoWiwhYgV88P5NSHATNC71KFdkd1qvIqzBk77haZsWSrkwiVSEuDG+wdoFr42wtLOBsBiFSMYhaEqpbtCo8OwU1KZ5XC+RCkh8jQwA3XrrjaQJcGZ/J7C3HIpUXpEAhBYUgxNlrCDYmwZzEFMs/gEBz0BkE6h8447Ta+q55MLtAjk+RY3b81RMCfT6f/w6aTgmcAPExhotLo+tHjguYmTlX0EaIr5EJX3kJui3Vt6X6Nt1v0/1fI91vS/Wt725998/puxuU6rYaerxUhwVrl+qwttVmeS31Bo3rN6/YyVUsBWTeLPTMidKiBqe6AkwJCYpCGrTS5x5Gzi4eNXUp1OzeS/9h13x8wrVvHbm69BEL0xcYMtM4gN3zJIn0aHf3HrQHWnto8Ui2slfEVHiH77rs3vYaYhEePTV+B9HMT82RZfr4BSFpkcxjiWZtYiAhMBogLtGAQRN05uCb8LNz6EvoS5gBs4Pv0loTo8v4ZgX0F/atoxaZVI1H4O06Dh6e4ueX3rf4MEAe4aNJfN/EBesZULnCnmNOV2sBZkDv94G+8Nz+oQle4xQ1f/OpvOYSi3VDYW1lkYDwMUH97ZH3uKzLXgse4yl/Ojnz8u2Hq1dshiUqhYhUY3Us7MdL2DmYEYXAcXaKBDdRVorDdGZefBlXzumgy7FpAEJhH9WlEOwme3/xDHLDBQRzEjtuEhQ/cNenl5n2fHErAkybrULaaJzSV7sgxV1e2feKUiT1ElKZl2fgauujcu2bbXQaHddYFqk1ZDdRxhcv8fVcIv6WQXMNNJeg6VcrVBjR3njm3LcHfo8geKBJWs9GbuC5JXjYeMEVhLpKA0rC0lE9XeVlWns2HRV4LsKr0vFRfaBXparbmAl32esmJ8ybh6EWf2cMTQdd5WaWgqc9myx6P8slj3C77RJJrkHpSheqSaLvFBxDGWPiE8zmVMyEZq5CbvsraRbiwq/45gT7tcIzXb6BpIsr/dDTz6YZEbqI0DVxQlv67ZdlgFjwbeSB4oAxgMNC/xQJLKGluGhgNUZ+Ar9LezB9eEAqQdHRyPwxKoKg/cXoBq7O10CYxmI8P28GfzMLCxNbRVjZGGFVgnV6gxDy6YrcDL35w1DMsX80fpHjcTFtea+C5Y+O0o9Ekj9O3P2dIt420vwVI40tj3FqeVF8bOw4/wQY3ENTJJJsj1F2AFPt1eeCOLieC/gv3CUvphodOiDq6ai+KYOJAp6Y10DB3725FDRRiARPsHLcQZsLF+SjUC5jYIC+kQDN6JXlGJjh0APKAOC12Ado2RTU7zG2a3iSF6B+Dm3fdgkaOEcFsqNMqVBcLRapws86ABHpAl9AfkrzvtReagIUdG9KZJyFVOLluzJvRZNCUbSocYkX+v0UR8/Q1ZYU/AQu0K+2c2cQZPH+plMwciHMp3twXbV8fwo2WJU7F0GEDSNEVyi0RAnDu5OrGkQApuzDjjCe7dpNehfX4jcDgHljDL0WtIl4CVsv6G5LcC+p22K1V331qkXdF+P23/JDgTanYDOwG+HgC9lITQNjOsgbp+ggYcPIfDjwsSYSWo459p+w7f4eRybYUT3gZUCJ/fjNp6JhosYF9IO/oXOdQmRY/dJgWSwvL+zXAV/RQ5/mT9Y1MpTN+9SyaPUd+PlF4IQAOKI3SM0Ih4gyN+wzAxc/uFTaWHsYgr2k2WHGQt9c+6nUqp+/xwGZM7FfP1yYqUPM8ZtU+N+R8xH+dfDTF/kr0nQd3yY2kydYY+DiP/8Hjs6urQ== +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Body

required
+ +Account Selection Data map, keyed on fieldName + +
+ +A work items details object. + +
Schema
    remediationItems object[]nullable
    + +A list of remediation items + +
  • Array [
  • ]
    • approvalItems object[]nullable
    + +A list of items that need to be approved + +
  • Array [
  • ]
    • form object
    sections object[]
    + +Sections of the form + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/submit-reassign-certs-async.api.mdx b/docs/api/v3/submit-reassign-certs-async.api.mdx new file mode 100644 index 000000000..851d787ba --- /dev/null +++ b/docs/api/v3/submit-reassign-certs-async.api.mdx @@ -0,0 +1,103 @@ +--- +id: submit-reassign-certs-async +sidebar_label: Reassign Certifications Asynchronously +hide_title: true +hide_table_of_contents: true +api: eJztXP9z2jgW/1c0vh+27QRCgITALzeU0B47SckRsp29NNMKW4C2RvJJdlI2k//93pNkYwNJSLZzu9vxdCYFWXp6399HQtadJyOmaMylGARex9PJZMHjEaNa85noMRXrrl4K39vzYjrTXufKw0Y+5b4ZpL3rPS9g2lc8wu9AYjznmnTPB4QLHnMaM00oian+SmJJlKNMkgi/HtZqhAdMxNAT+klFeMwWGoYSKtInS+LTRURxlJ+fGwlQIeM5U0D3hrNbpqpkPGfkS6FfBSfXXwxPPpCdMJJoFuDwGYtxoiQKgM+A6JjGCbABpIGK4ZmKgAQsZmrBBSO3c2afpXIsgEMC8vpyEYXQrUq6QPcr9Lrl8ZwMR+8/d0/OBh9QtF5/NHbfaBLPpULRYKxi/024sgz5NAxhAqvBKhk5sTSZAgHTXlQBykNDvT4QzKWZn+AMYLI771Iz1ZMiZt/iLkyNZuSB6BRodW6hO/Ou78GiEVV0gVJrM5yjXSMKA/c8AQ/gGw9wDn/OFtTr3HnxMsJWHSsuZt79npcK5XVilbBNH2FPWndwAjOwbxQVC0PYtHE8bTcbzRZrNw+P6pPDyeS4WW/Sw6NGuxUce8g3zsp0/FYGS+RqnQkfVSBifESjKHQz7f+mkam7TXHk5Dfmx8BGpDBM0EctWWv8XE+qFF1CR+O+T1MA7W0obZuOBidETk1MmNhINTZhMCDzQRZUn6mpPTf1Lixgj92ZEMkCnWvcHb3vjz9fXJ6ddUe/woPBuH+G/530P4wH41+zJ9d5xk2n+4LzXFlHM2xCX5jY9EwT1IhNmWLCZ26YbR3L52g3zvsihODtnPtz01r0RxOpqbDPVjgOlWI3vmxfzCkmvWDo386XhbxDbqkmCxqwAiMr/swgLRcpsQ21Zj5cUFvGZ0HXmINSjQMhS0pHkP2tN9drNfyvKEh3PVljNrXh4JLZWha1encJGsJY8VQMk5XRvb5T/D4v+jY9AUUphlzdbx8c146PWgdtxvxaq3bQOqAt1mgcHtLGUY2+LOQemJmcScXIDQ0h1YEPYCQSGgSgLW6L0zSJE8Xy8Tjqdy8uBu8/QJMpQJ9zDb3h2flpf9z/jPVp8G7Q644HQ3zwbvBhcPGvjeZV/+7ZedcR7Y0Hv3SLbenHzz2YbNzPt5z0kUAx+Nf4QoVRBfV5/LJMFc+pKcw2S1mQAxoCHU6Wtk4ah7ydS20MDQ06lmqlRDv7AFyQs7CQ3DYUkspckCdrzSQZPNvtjCSPS7C7Hx43mj4yY8NpN1ZSQDTNAFFeEf++7F/2sUqD4c5Hw/ej/sUFfLu47PXsp/5oNBwV1eLGAB9MKan0y2toKAHz7Ogatm+WdxZMazoDgQAP7QE6fds7J80WCamYJaadztZKqqhcokAiCUM6wSYEFCCEJTxUfMa3JvdUVSf9d93L0zG0jPqgggv4hLQ2wHMX6owIMNyBVVD7XN4ajp0AmPU1C0EdUG/JG0f1DQhEhc535PabXmp0oYBNaRLGMMLNvmVEnjSZKrlwGdoAKuJb8Ehe8Sqr7oFPQtuCxpCwJ1Rbr8Tub7q+z6K4cuo0+YbMGRQp9RpwcRBwFJKGT6cuA55lEhNA99xnRVusVFm0xqpineaNguEHnD/tJ10/ToA5I6ZzeOOimbc4Fp19gGeruSJ345zSjEqXIqY+SAH4HKCuVAoL4ARk47EmrqCZ7AOlS6T9uAAdccg6WGtTsfrIzZll5iSW3sOPTrmON+UjITSjaDbybIqc0xsGVoAFC8AomQA7mAMny1zA55AVFuqxojw8GQ/1Zs0f5et5jP3cLCF4AWIrcLDpOqxy0CtFec/OAxGu/WSih7eCqedk2HQgkTgyY+T5YFqw22dPDmP+wLy0sWGVZ5fJ/Oji3N3L8fAMqlsvK8dnANsLvjja4hAmqadENuzytCbzinxa/m3iP8j544ybcIE+PlCM2Y5VGncMzO5AzAFlgyOn64YMWkD0O4qoXqg9kDBhMA6s4KBi5a7Va5Vau1Jvjg+OOwe1TrNVPWo3/lPQemHrZQyTODTe3AbAeyHHMDSpgVTIiEFmxZUBnxYy+wTWyph/spTz3WB2wGLQb08GOzjmOy5YZQb2QA5t2vVhIMSovOEBAqAFgl5LspCei64LmqgekLeQbUZOvp4TBtWoqP8VaO0CxC4Fh/EkHQJRmqGHLdOyFqOTo1q73pweNSmtHzcPWoeT9pQ2GrX2YbuNs7sysg3xFKd+zyAEuG/LC/8dFOIWhMiAmbwESSVIKkHSbiAJ8zpN9A5xdx5C+qkY0bIHN+kGikb4YrORsUZqJpeR4KEBTDjY9crMlQa+XUmWsVvGbhm7O8bu+sOR23Z0Tw30OdiEPpfC/cCCxXMD+ijjPUKmv8L8bhci1pB7Zo/baufnj2P3Yw70Z98i3Dv9jvjIlvItG6epPWz7BOFHZqyCLZBBo0crwRQyEQs6hu8Vx0ZRVlWNzdneSTXh4KBiC0SErKnIUiaEgspUIgRyQvUeCSTT4ie3eKQQEVrbDIiziqASSW7XFCWSLJFkWY3KavRjVKMSSZaxW8bu3zN2H0WSGVcmWhxO0sliQdXSepp7jtJSAh1I+gM4yULOmGodrSAxkmEsr4gcvEn9YHIwbfmsGdBmcNRoT+v+UZ0etg5aB5NmveXla/3VKo6zICvGVM7e1o72NzymbgDHJQKcS8dSBsXtP1CvYlNMa+Y8VYqbQeeg0usVdmxuYscPMgbZgDBgR/XA9uLl6BTp4xEmJI96k4nyGcJsdxrA/EKAkBJ9GDRtf7wooWMJHcvyU5afH6P8lNCxjN0ydv+esfss6Nh8Cjo2nwEdmwQh1hQh1p8JHQPAHQjNpmAUkMFPQL0CYWMEosAnt/vowt4edsuAXgFF1tubKHIsJTmjYpmCJV3YiRQrdWF6g74L7KvSvvimAJlBihQEshYHdItehT/JAybFn+hDvuAmjlEgoKuWle40BqlszKT+ls3ChR8mwKFJCqHEvVcJPsbBndgU4R9QMPugM0jU33GP01nrD+0HkxFKfIoSk/43nzGM+Wz/93DbKYEBnvjBdHFhbf3AcQG7Z46vSgj2LbLpK4OgJVQvoXpZ7sty/2OU+xKql7Fbxu7fM3afAdUdGnoYquO7qbtCdehbrZEMS71D5/q/I3YTKo4D495E+garBysMbnAFuBIyFEmz0Wre6+x4+4Vj2Xr/jgf3++kR2wp1LwHbFYFlMFEhjJvHcaQ7+/t3YDew132VRryanmkW8rbqy8X+TWNLFsJDpzbiII8FiW9WEfiSrp2karStODq0zX5mAqt7Ix+6LtjAnDZ4lD6+s4pGXcKKhFgye3gO2jmXacY3eGFl8ZM2vavGmTZkBNkuVXj/lDy/NB6TwxJ5QI5t6nt0LuhPgMs18ZD969VLwBcIwe3sG68Cr8oKbv7XNyYbYrc6ecuogvWBPQ/z6ueP49dkhsDTBH6iEfMyjisFCJ1zcBGT2Lrp2RAcZGqNksnMvl3ZLZy+wUAi0xAEJp/EBWPkauCU8AEy/ghStFEpDmImK+Co61epZQJ2w0IshtWVJtHxeCD2QUP7tDDutSl8ZoXAhT2YDa3VT6JCTjjmI4wA08eJaBZ85CpK5aI5uV7KxD9SahVLrWKo6ddrXFjVXvn2NLcP0YwkaKiNtl48uaVXydHD5RS0INV1HlATjo/imSk/tdqL+SjQqyC9Ih+fxEdzrr44jNgkRjQUxTAgA+LPpdTsn4Sg62AYXM0SiKIXs2UO81dMRFTqtRxLFTtlhVcAIxr+TiEwhHUmOsEabSCKtLslJiS/GMtCzH8xLwx8Kchsmq+glGLPQPr6xTzjhBWcsGJzgHb820qFjgWxjTKYPGAdoLeyv8kEjtFczrO0tmZ1Q37fjMHS4AOrhoqOOvZLZ5Xg3CdiHmDvrA+kYITY2SkyvMjA0cJyVVBWujmwrsFNfkMJVXJNb5bf7CdOrJx/NXlR4u5qD2UowuX3ztIPZJK/Tt79kzJemWl+xEzjQC/uRY5Wl4P0V6+prS7zuLI3A+zyopqLRXthxXXx5oldxqe3QTx6YwMs/CFIjLLcmiYfmhZjbu5D4kb5nMFfeGryi1kTwIrL3kiDyCtPJgppjJFoMpE/58zsYESMxohX9zAa5MJkDwDpmLJgnWoIzcyrbcAyYGg64SG+wUg+MvsaqcLlIZ4cBqq/SbdOvADfOEfXIiepuwHsWywSgTdvABPJguAbqU/4ZMC1n9jUCatFwVLJ7EVA2ag0j6CzoyqqZqGkFno4xa1uWEXnXO+JucDztNvnBkWiRdwtOCtBRix0FyLtrS0anqIN/l6ZszBCg0PeBwjIcjOcDcYbFIGYcD+uSDXbd4P0PvYFIrhAs87QqMKyFJtwqQer6Rzd9D1IUrzOiZjbngClC5nocGPP626111/e8/TXuOfJpSJcz+1HuCOJ9k7s+tIu7a+84tIeBnXMrTprq3vIY3PcEoABd3e4i4VL3XtsxttY8CKp69VK1qRLcGH8DElzCsyt3/KUd5ZXIyf8a2O4ne5+2ipZuiMrlqvNGA8+fmW4hwNi3V9DL7vJZni0D9yvOhXznvBq4MbPVbjmtyPsxt2jfa9zmynnQ9zC9Cbu5qmF3RdS9Bb1DH873if4B19kZI2ApQfb77x0lxX6WLop7N2G+twHsAV0+x81yuyn +sidebar_class_name: "post api-method" +info_path: docs/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 Asynchronously' (submit-reassign-certs-async)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Body

required
    reassign object[]required
  • Array [
  • ]
+ +A certification task object for the reassignment which can be queried for status. + +
Schema
    errors object[]
    + +A list of errors that have been encountered by the task. + +
  • Array [
  • ]
    • reassignmentTrailDTOs object[]
    + +Reassignment trails that lead to self certification identity + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/sync-identity-profile.api.mdx b/docs/api/v3/sync-identity-profile.api.mdx new file mode 100644 index 000000000..d1128de04 --- /dev/null +++ b/docs/api/v3/sync-identity-profile.api.mdx @@ -0,0 +1,101 @@ +--- +id: sync-identity-profile +sidebar_label: Process identities under profile +hide_title: true +hide_table_of_contents: true +api: eJztW1tz2zYW/isY7kOTjCXZsmzHetlR7KTjjhN7fdk8OJ4NRIISUgpgAdKx4vF/3+8AoCRKcpykmbbJsA+tSh6c+zn4DgzeRToXhhdSq6Mk6kd2quKjRKhCFtNTo1OZiWgjKvjIRv2rqHrDwisbXW9EibCxkTmxAAO8iYW1THpSKSwrVSIMK8aC5X7ZO/VODVihfxeKfZTFmJ2c/fq/weHrozeMl8VYGxIhLTPij1IakYCUxTzLwANPB6dHbeiUc8MnohCGNLuLJAnPeTHGK4UX+L+gwrQVxLZkgpc2HosJj/p3UTHNicwWRqoR3qTaTHiBJ2UJyvuNqJIf9QtTimVLL2DQskPY0SEpO3Smkh8EiRS3fJJnJEuk28/T/d52b0/s93Z2u8Od4fB5r9vjO7vb+3vJ8+j+msTaXCsL70LJ7maX/lMXPYhjkRdwTIudiaI0Cj9l6lxMOgtbsI/cMlvGpENaZtmU8WqNVNCQSO3UFmJCvoy1KmAICeJ5nsnYJUTngyVpd6su08MPIi6ie/yzEfU2N1c1PMgkGLKXxmjzGS2HOnGRluqGZzL5E7ogIQylMmWcV6fgMjvQiVgX6rqyr6QSrZHhkjQUTuUYCymGNzLBCjbRRjDPkmlvgqNr16ILT7S32AuewF5v30EwBm4qDI9/By8qs8cUulQS61m1BMXEkJwPiRV7gg93N/e7vXS3x3n3eW9rb2e4n/Lt7c39nf19kj5BHvCRd02QzY3h0xXRvwoljIxZplFx8hMcYgSH750CTjiWSOSNfTwGjscX+J8qydPOzAz6skLcFhuMsxcHp6y3xzKuRqV7zkdLTlCty3OqfSQ7H9IjqllY7hmfGDmSap0qQpUT6m2HL18NLo8v8OTs5X8uX57jF/FaaXADhWxNKC2hKnJhrD86jYMBru5EBneIpM2eBa7PYBBXdpFQ2oUiRG6lvMwKrAjS16xYZM1Soye1UnJ1c1uwJ7It2htoQXiGdhaP2ZCjDTGEkMif+d7ROg6efMbGgqM/P22zQZJIMpJnDNUIplg/pV7Gk8T1DccgLVHKwvVtXRZM6ULGoh6LuSvr0UARyMJRHC8GhYoDmj+eJ4O4KKGcM3OxCmfZElQM8YHO3nN17S6Wu+RUFTyGFZzaZKyNgYfZELbJwrLQjihcFo1HVXSzjkUtsDLLtbvXXpnDQrt3MS/tF9TdaYb203KmzV7ciFB8ljYV341cNKowhY4U+rlbHKhm4aoKn6VSZElTu03tNrX7hbW7/PIs4LLw1kGfrVXoc6kCiP20DqAZlz1KV0j3k4M3IZAbDA4JEOm3txcBIoNe3OYERL8jPvJb+SqynMXDPx8S/JgFqxYLUtD50VuQohOJpO/0nmvsHOVdtb0q7ZU2Q4kEVWsgIrqmYVNdMg6XmVIp0oTbDZZoYdUvBRtz9EfuEK7vgCRVJa1cA+E2SLJBks1u1OxGP89u1CDJpnab2v0xa/ezSHKmlauWgJNsOZlwM/WZFt6TtZyBgFUnhGxWci5Uy2iFmLEZxorqyCEadreGW+leLHoJ7yW72/tpN97t8p29rb2tYa+7Fy3u9VfzOp4VWb2mFuLt4+hcDBB3AxznjoBtoXVSP/6De41Iqa1R65nhZvgcLr2eY8feKnZ8owvYBsbAjuaB48XLs2PiD9GOPflNlyYWBLO960DOCwcpKYfhaWmLBjo20LHZfprt56fZfhro2NRuU7s/Zu1+FXTsPQYde18BHXuMIFZKEOvvhI4JcAdBsxRBgQ1xCfcqgo05TMGvcPoYyr7gZiSKGdCrocju/iqKvNCaveZqWoElWzuJVHN3UXsD7YRoTUULAs5GaJGKoWtJoFvKKjkRhEmRPyyTE+nqmAwCXzNtDdICVvmaqfJtJkWqOCuhoWsKmaazV40ck0gnkRL8Awd3DjpCo/6OZ5whWn/qPJidkcXHZDF7eRsLQTU/O//dWXdL4AjKG2oX5z7WD1wX8GfmXGGMELe5b18zCNpA9QaqN9t9s93/HNt9A9Wb2m1q98es3a+A6gENPQzVQfDFUB207U02w1KvKLn+csTuSiVo4NKb6dhh9WSOweEEK/BQFlMn5BIQ/8Cn8qAsxlSZMlH95Xu7fSNS+GIcXdPt2IlAMpJJuXZHte7Obz/qLK+ynbs1F4DvO+Fibmt+QTkitQh/etNLk4HfuChy2+907pARyIT7Ns9lu2Ko9Md2rCedm+01/Y2us9rqunNSxm4+GZwehYGm7eJoJJWK76tOgI+q8xwVBaLr7jF8lj/dc6Z0mWLWYZ7NBkNZhbR1j6FmjpnlF+uo2y5NV2yEbZcmu3/Mnv9uf84Oz+QBO9a577OyQM+g5ZJ5pP71PIvOCdx76Su5NN+w6M8K3RVhJ0TWZS8EN3Q73d20efLb24unbESQ1rWU0hKaFpJmEBTlKVLEtcxBdeuEFrldzOhyNHaKD2r3eqhEWZrBYPZOnQvBrqor42+wl5yh+TuX0iLh+g2tun5SRSYRNyKjbbY99yQlHsqkAw91eG3dU7elutlDKn+bHU/b71SLHUrqdJKgAdEEE90oya7yyi6+YNe3KvGvilvLc2s5bvbpkhbetVexvyceo08QC55Z561vFu75tRb40aCGJ8R1WQfyRNCjfhsrrqL2zXrU+LWIX12Pd+rtWGK/ri9jvrkxi+02S9gRi8daW/Fvxih1qAyuRiWq6JvV+khCW64iWt3NBZVaXmRLtoA+nX7HKAzlk4kPafd34Ef7cxhXku9dZFHz7zGbJ+x9zWb3+AqbNFEmOrbfrDMJbJHAlu8BNujv90BKLNQ22eD6gE+Ag3n8XScIii70PM9rbVd37DtuDW0NMVR1XGze9//Tnze48Iu5F0Q9o0ELJvA+u59G368EXrQR1pxVHTsse3BV30xj/13ym9d39sdT2pP/afaSxYP56cyJyqbfu0s/0En+OX33b+p4Taf5GTtNgNOUbk5smDsWk9yjtdWzQjrMHgv8G29dpTrcjqnIf4tHGGaRTZ7xgnLa1XQ8lsKdMuSCF4T8Niiv9MTVYfXJm/WMRgY0KFoLNMqHMgO/NnuLMU7FcDGNcHS7F1w/6DDLncPLpxQkdlgFDgBqMikVfWIHJcoJ40iPR6KbSBuXvglholOiskw7GDdbVVUkpQ25ou2GGTOxJykdR2PSXQjiI7IQQxvOouFIikj4BnFuyJnIXJYRXR1+P8YbmdMaiyynIRIdFGBKLEh4fXSxwhHMVPgDiDajTlhkO0QLJjTq+GTYbmN0pEc0TGHiXeD74Iec+eyz0Fpi3c1P4v+6j0DD5kGov5PTiRjZUvopxA+GVyufgVIAVmZM/23omtkQ08aYBk0wuruj0xUalO7p8R+loNH96no+B7n5EWGj3xhRUzSF5c9GF9305CzY9tT9fejLPiZda3J1VKim81OCCD9/F3S4sM5YzOSwzB0HOa09pT8wWuCx8ieV2gh+ekJHZw62rNvKww+4CM3q/80nI8o= +sidebar_class_name: "post api-method" +info_path: docs/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 'Process identities under profile' (sync-identity-profile)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Process identities under profile

+ + + + + +Process identities under the profile + +A token with ORG_ADMIN authority is required to call this API. + +## Request + +

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/tagged-objects.tag.mdx b/docs/api/v3/tagged-objects.tag.mdx new file mode 100644 index 000000000..a57b27a85 --- /dev/null +++ b/docs/api/v3/tagged-objects.tag.mdx @@ -0,0 +1,73 @@ +--- +id: tagged-objects +title: "Tagged Objects" +description: "Tagged Objects" +custom_edit_url: null +--- + + + +Use this API to implement object tagging functionality. +With object tagging functionality in place, any user in an organization can use tags as a way to group objects together and find them more quickly when the user searches IdentityNow. + +In IdentityNow, users can search their tenants for information and add tags objects they find. +Tagging an object provides users with a way of grouping objects together and makes it easier to find these objects in the future. + +For example, if a user is searching for an entitlement that grants a risky level of access to Active Directory, it's possible that the user may have to search through hundreds of entitlements to find the correct one. +Once the user finds that entitlement, the user can add a tag to the entitlement, "AD_RISKY" to make it easier to find the entitlement again. +The user can add the same tag to multiple objects the user wants to group together for an easy future search, and the user can also do so in bulk. +When the user wants to find that tagged entitlement again, the user can search for "tags:AD_RISKY" to find all objects with that tag. + +With the API, you can tag even more different object types than you can in IdentityNow (access profiles, entitlements, identities, and roles). +You can use the API to tag all these objects: + +- Access profiles + +- Applications + +- Certification campaigns + +- Entitlements + +- Identities + +- Roles + +- SOD (separation of duties) policies + +- Sources + +You can also use the API to directly find, create, and manage tagged objects without using search queries. + +There are limits to tags: + +- You can have up to 500 different tags in your tenant. + +- You can apply up to 30 tags to one object. + +- You can have up to 10,000 tag associations, pairings of 1 tag to 1 object, in your tenant. + +Because of these limits, it is recommended that you work with your governance experts and security teams to establish a list of tags that are most expressive of governance objects and access managed by IdentityNow. + +These are the types of information often expressed in tags: + +- Affected departments + +- Compliance and regulatory categories + +- Remediation urgency levels + +- Risk levels + +Refer to [Tagging Items in Search](https://documentation.sailpoint.com/saas/help/search/index.html?h=tags#tagging-items-in-search) for more information about tagging objects 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/docs/api/v3/transforms.tag.mdx b/docs/api/v3/transforms.tag.mdx new file mode 100644 index 000000000..9e15c49fd --- /dev/null +++ b/docs/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/docs/api/v3/unlock-account.api.mdx b/docs/api/v3/unlock-account.api.mdx new file mode 100644 index 000000000..fbb60cd82 --- /dev/null +++ b/docs/api/v3/unlock-account.api.mdx @@ -0,0 +1,96 @@ +--- +id: unlock-account +sidebar_label: Unlock Account +hide_title: true +hide_table_of_contents: true +api: eJztW1tv2zgW/iuE9mHaIrbjSy72y8Jt2kEGvWTTZPqQBltaom1OZVIrSkk9Qf77fueQku3YSdruYGemMAoUinR4eO78Dk3eRDZTuSy0NcdJNIhKk9r48zCObWmKaCcq5MRFg4sovHHR5U6UKBfnOqMxGHE21U4MT46FK0czXTghRSHdZ1FY4ZkJaYT0w/GYiFwVZW6cKKbKUx4fNYX4aIYY8lkZca2LqXh3+vO/h0dvjt8KWRZTm+tiLjBPrv5T6lwlxD2WaQomfvYmZHUqLokQ8t5E507lL6wp1JdiCA6kg07MIAjiGq6QhRrMpJETFV3eQq1M5nKmCpU7ZqBJuUxi6E5k8AF/6YRmiadqJqPBTVTMM3rrilybSXS7E1XSRYMiL9W6oVRtB+akvshZlhILNe4ejvu9bu9A9Xt7+53R3mh02Ov05N5+t3+QHEYkH3FXrnhukznNfneymJSFz/BJZlmqY3Zq6zdHk98sib0q1annKkoHq45tXovonUch4NW0o99UTCGR5RQyhVaOuMG+Kjcy/VXlehwmpUi6O8/xWDhV7FAwVEMEOMXKOXElU53AHRQTsuDAgDi5uJbwFLmaCSEfhwa7PBijuZAvuGHZrN1xv324e9jdSzpqr71/uNveS7qd8WF/N5btvcM2+cyreXz0tor5eyUnsUC38KELNoJgcgyVmOLa5p/Hqb0WsSUpoNSSjCNrUyXNspBjmToFOWD6WJ3k9ko7TEua3CtItkQlyqyy3CK6ZAFbjMoCb7w1nS3BHVkmOFstc2QFyOvXU2Td8nh8MLYQbm5in2rKuDJXnqbmTcN58uRrNISKhS7YLcHS52y8EH/R7e0tZ5DLrHE+tDq7nXUjDEkqXzcSVUiduui7Y78qakIy02pyQeykZvOGOQTMhYqRF+RrJg6xGy1nPZUYKpAPZ4zekB06EXZcV8QHg7oTc1D3Dnr7h91E7u+26Wm/3407eO7vRRtM7dhqp8qVaWXp3u7uuhgvUg0zipd5jkLQEKdcqaGy9rKFpBMjlCByvzacuc1v8cDDtvHmfmETtV5g79bTV9qoxiSHoyChYpFjDPTpkZDzZhZB61lW5mW65opBYYlmWzyXiahq4YugDBkyl/Fn8PIl7WGBzo3GeFENQZHngnrPtOpAydH+br/TG+/3pOwc9toHe6P+WHa7u/29fp9mnyHCsD65pbllnsv52tQ/K4P6GwtkFDzyu6JVVsL2LABPjiG6UDP3uA+Yx1fYn9YzT1urGeQVtOqi1IvnL05E70Ck0kxKfi8nd4xgGufvaYEt01SO6BUtZtDcM36X64k2m0RRppxRwh29fDU8f32GN6cv/3X+8j2eiNcaShmi3JmEwhKiIhamqNDFQoFr6VBbU5gD1Uw8C1yfQSEZkEog1P4vN3cwJmJrLJFSGBFm3zBimbUY53a2kkqxhyjiiW6q5o4Y0buZLOKpGEmqzdZX5mdIZJUVjdfBks/EVMlE5U+bYpgkmpTEeopsBFOMn4ORkElCqesZjMuCKjgtoLYsqLxrLAgrvliYctUbi2ryetkplByQ/PE4GcZFCeFYzeUsrKMliBj8A5m95ValO1syGpt0jhodQwugwDnMmOewsMDCJAiDhnJE7nIoPKaiqyvWcpHkcvfGC3NUWP4Wy9J9Rd6dpCg/DVat/nClQvJV0AXViL1RuSlUJHzkgk+DA1XtrirxxVirNNnm7jZ3t7n7lbl79+NpQHXhK0Of9jr0OTeh0aTFcw365MqD4qob/Z3hTXDkjoBBAkT65cNZaGNBr75kBAz/QHzkl/J1IFv7w78fEfyonbXiCxIw9FukwRiVSCUDlnshMRvKm6q7Ptsrm480AtRsgIjct81tKSRMlpeGQbR0OyKxypmfCjGVV9xoUN/HFZBmNUkjs9oUWyS5RZLb1Wi7Gv04q9EWSW5zd5u7f8/cfRBJ1lJxtgSc5MrZTOZzH2nhO2krBQgW+4t1yrGr7qIVYiZqjBWtIodo1GmP2uODWPUS2Uv2u/1xJ97vyL2D9kF71OscRMtr/cUij+skW82pJX97P7KJAeKugONKg+ByhbXJ6vYfzJurMZU1Kj01bobNYdLLBXbsrWPHt7aAbmAM7Jjfs714fvqa+GNqZk924/1rgtnedP53AoKUvFGtvmhXbKHjFjpul5/t8vPDLD9b6LjN3W3u/j1z95ugY+8x6Nj7BujYEwSxxgSx/kzomAB3EDQbwynQIS5hXkOwMYMqeAq7jyHtC5lPVFEDvRUU2emvo8gza8UbaeYVWHIrO5FmYS4qb6CdEW1e0YJAiglKpBGoWtr63971TBEmRfyIVM805zEpBL75vDHkAx4+Z6p4q2fRJk5LSMhFIbW092oRYxrhpMYE/8CB90EnKNR/4B5n8Nb/tB8sTknj16SxePmFTtnAhPX+796mUwLHJpzfee99fc9xAb9nLg3aCPUl8+WrhqBbqL6F6tvlfrvc/xjL/Raqb3N3m7t/z9z9Bqge0ND9UB0EXw3VQdvcFTWWekXB9X9H7JwqQQIOb2FjxurJAoMzrkAokUCZ5Y1WPhY/iFrVafrWjU5uW/WJcd8DeJHKPAXltCgyN2i1buApeOi2KTPdRAGDs4q5sdfN2M5aV90NdYeOmfocQ+VKypj7Br5uwJM02b65phD29Y4n8NZmjShYYXU+X/AgfzrkT26cowcRns2OQLiHcOLXdKgbvcRPjqmbHD5rOkK38zy9fUyfX7sP6eGZ3KPHJvM9OBfoBaS8ox6Jf7m4N/GeQLeffe32xGIhoe3+ztpk74isI54rmdNBeD4B8+SXD2dPxYSgJqd66QjlKk29AZLlBCHCpWxYnQahQby65LacTFnw4cp5G0odQafrm+Kjea+UuDgORniLGn+KoswmpUGK6wCNunxSeSZRVyql5a+5sCQFnk5MCxZqyZVxT3mp455AGzzO+G3zo2mII00VSNOSTTRBRW7xxEVW6SWX9PpeIf5RcWt4bg3m5p7ekcKb9iL257dj5C+xkKlja3335J5fY4kfNVB4Q1zvykCWCHKsnpKKK699txwr/BrEb1WOj+bDVGMdXR0mfNkSDstgmohjEU+tdeqfQlDoUBpcTEpk0XeLdU2TNjgjGp3dJZEafsqGbgAVsnyvkRjGB5Mc0arMoMT6/RFOyU/sWeT8J74l9WlFZ359gcWTKBMbu++WmSZs0IQNXwNckD9cdICwyG3SgeuAD4AXC/9zJQiCLtU8z2tjVWf2LR5DS0MMUZmLywb+j8GiwIUnwR+IuqZBCSZQXZ8bo7tfgRctUCvGqrYD7lpwXd7UYl28Yzcvb/2jJq2VfzV9SePhYtfknUnnf3SVvqeS/HXq7p9U8baV5kesNAHm0u7j6eKW5cuqIbn/luPjVww33TDkG3Ebr/xVtwEp8NkAoTNZTjePG9d3Ex1f0MP/+Mo1g5E9+qbq2qQSy2yyVBaUXVxd4qlWvA+RKVkQBt2hCLczrgjhqhu6TWY0yUGD8uGAi+VIp+DXFB/Q6Bmol1OTR+d/wfU3G7q99/D3CYWLOKpCCFBuNisNXeuFEOWMbio+FmeJdnHpyyF6PqMqzSwDynpUVRsogMkUfDtR5TP3bkwb1uiFl8LpkbkQTdX9QhiSPBKuAi8UOVUphwPRrTYCj/FGDDemKs2ozUQtB6xTSzO8OT5b4whmJvxEYvNJKwxyLaIFE2q6fDB0m2gu6RU1bOiJl/j6a5diccV7JYxuFjvzf6Gb3WFVo3akldEWGt/c9e2R70UvoqoXBfmAr1eHdhQNzpS6VpDc3NBGC/Vmt/QaiU5d/MXlovXilhX+oeekTtR7LfTkNEj9lH8qWrndvVHmanPQzBf7AhEePyvaTsA4NN2Ql/d7WBb/IfzA0DibM0yoBq79ckLNqB/h95AepL1c6utP3tFuWjQKd8tnfosil9d4Sf8Poo/4hz/81WEuq/z+Jqo2/EDj+VZ4bBMcCQ+wOcj+CyOgga0= +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Body

required
+ +Async task details + +
Schema
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/unsubscribe-scheduled-search.api.mdx b/docs/api/v3/unsubscribe-scheduled-search.api.mdx new file mode 100644 index 000000000..aeaf9d33d --- /dev/null +++ b/docs/api/v3/unsubscribe-scheduled-search.api.mdx @@ -0,0 +1,81 @@ +--- +id: unsubscribe-scheduled-search +sidebar_label: Unsubscribe a recipient from Scheduled Search +hide_title: true +hide_table_of_contents: true +api: eJztW21z2kgS/itTug+bpAzYmNixv1wRjH3sEsMJSCrluJxBGmCy0kg3kpxwLv/3e3pGQgIcO8lt1e6m2K1ypHnp6benp3sY3TkpnyfO6ZUz8hbCzwLhs5Hg2ls413uOLxJPyziVkXJOnYlKsik1TEXCONPCk7EUKmUzHYUsXQiWxGibSdBIVtQSQ63+QTl7ThQLzYlazwe9rKS3Wjxfe8+JueahSIUm5u4cSQzEPKUuhQ68Sd/Z5LB3xqKZ4USL/2QiSbG+H3lZCC7rGE1chdw5vXPSZUw0klRLNXfu9xyaILUAX6nOxJ4jvvAwDmhM0zs5eLX/6uXRK+9l88Q72j/Ak8ePZif73sHhwaFzf22nY73Xkb8k8utsjQ1DhbbSiE3pPYxuwV6puwc15kUqxSSiyeM4kJ5RX+NTQoTvtgWKpp+El24pps2o38eqM6GF8gRxQava8XatWJN9UimSkuCmpqAYlYXkL+1OZzC5HN90Bq7b7bfHvcElni/PexcYhM7uaHQzdAfnvX63bHC7/550R+Ob9hBdb9t920N06Gk47Pc6hhLeOu03w3bvovp4A2LjrkstXXfcO68M7k9Gec/g8rLbGQ/cm1HnX903bTR1L8e9cb/7pmtWuRi87bqX7ctO9+bCHUyGaOqdmSHvK48V1ldNOfNo6vfOu533nX73ZjRuj2nQsD0avRu4ZzfDAWQgSu7AzHYn5p/RoNI1GkzcDrWO2xf27w0k6V4M3PfmdfQb1hpN+rSU2x0O3HH5ToTe9gb9QvLCDO3OuPfWygA+frOibUG4rRjZL0dhARYycUIvZ+NBwpIsjiNN0Pks04VUZkjPhxfKdHkZfWZSzTSHP2RemmlBuCrBUlElhpumszQakw8BZIDsg+CQfsFK1R+3PO87ILmG6CtLyqx/XTJGXPlugQjM2QoDpiGJI5VYTDT3W9sCXEasY1HKaqynfMIo1FmJQuwzJ7V6nkiSWRawaZZSt4bgCVMRy0G+igxQq4L6c9UXHNRJg639/W0OOoEJLF2tIw0e3BWBtVjIpghOtKJUtzyQfv3/CS/rscIXKZdBJ/IfjBjrzJ5LJWpzzSVxKAzLHiYyULyVPmawMIJmLMnCLcy4dU+DJuoH7DX3Ia+VL7cCqSnV3PsdtHr+0wxNlMR8VkwhZ5yBqa8sK44Fnx7tnzRbs6MW581XrYPjl9OTGT883D95eXJCq4ewM59Xw6jDtebLraUvhBJaeiyIPFjkvyZAc+jeMGAWJ6dNRZg8bQND4xv0T3izY1di5vyyVHxJ97Czv+4MWeuYBVzNM9PO5xtKULXJiHbiLAj4lJpytFjCAy3nUj22eZx1z9tFfMuDKtF6KF5JiyiwCl9YIPykpQAGVyKAOoRfZy9yqi8gEFdJdaC0b8kSKUEI35rxLEgxI1/9gRlV0uUmXUDJ4OZLyp7JuqjvAbVoC3nqLdiUJ5gQWei+aAPzcVrr55p8wRaC+0I/r7O270sSkgcMaARRzF8S/Lnvl9ifZRRiTSCOEDRUlEpvI+KWqly3Rhnn+lWjEDjA+dN+0kZ0B3NGzCoKV96Ss5jbBzxbza1zN96MgkuVcg9S8CBYQo0aeVFqAqJMk1UglKT7kKti3CpiUYguxDLh7o1lBnuM6fN4lnwD7oYBwk/NiLbquBU5+BKKwzYaGWsUZsojUp44mcn5qJW5CuAz5MCBv8PuDrs77H4jdjc73TzryXtN6nO4nfqcR3oqoXX1QN6DUKDZMsoYhxl0phTt7jzZQ0koEvVLyhYcoOcmLbOwBu9C+bU4krZe3KVHu/RoF2J3IfbnCLG79GiH3R12/57YfTQ9WnFl0JLnSUkWhlwv80M/20/ScoYBq0MltoKcMdVmtkLE2CrHctYzB2faPJgezI490fJ5yz86PJk1vaMmf3l8cHwwbTWPnepef1XieAWydUxV7G3taFSMJO4WeVym4FxJGkX++pkW1KvFjMIahR6ewZs0UgXoHCq9vr8vcscHD+5SyAbCyB31V87MJm7fHppb8qS3KNMe9KZz1WE4T01KST4MTcsk3aWOu9Rxt/3stp+fZvvZpY477O6w+/fE7neljq2nUsfWd6SOLUYp1oxSrD8zdfSRd1BqNoNRIIOXQb2K0sYYouDJ/hZewD7lei7SVaJXZpEm/YDHEftxZJI8cyHl1Gms7m7U7N0NkTTupH/fqNxwwWjLjpUn0wEmLtI0Tk4bjTvYF3a9r/NY1mX+U7uKPte9KGzcHj4QrehnXItMxDs/84wI7WEvl7lurKIlOb6NkmYBayMDc3Jx2MocdT5Kn27bkPGXUAezZPboxkDuhKYZbMZcLX9JzOi6cbotGSHbRAf3T8nz9vAxOSyRr8jxkPoeXQvjGbjcEI/YvyZzwVNAyNhrAn46Nry1MzL61XV1DN1fCi2HWyPLLYqqk+YWQwMa1mSv4Tlw1jT6XSj27Nd34+dsTkmsCSJZQvmzkHRrAC48hBuZINkuDq9pknFgHWXzhRGunddC1r0JlGwWQCnsgxoJwa6qVzpchHujdpokTIShWdfPCuv54lYEtLHWS22Tc0pfNaDFBl+b99ygyVQbUuExNK31D6rGziTFNknJAI3JRTQn8+wqLuTiFbl+lIl/FNRqllrNUEueb3BhVXvl2TsUnhZGLTxIjLZ+eHFLr1ahR6UZWojqJg+kiZwPvmY1r7DaD/OxRq9G9Nb5+KDeLSR26PVpzEY6lmCDDXzWY94iihLxT8bIdQgqV/MMSPthtj7TojWDiFpzv8JSzS5ZkzXkm4a/PoChrDPxKe33Jt2JbDg3sP1oLIu48JFxtH1ck9k0X2FbppF+5CU/zDMtWKMFazZOJDn/dtcjxwK2SQYTB6wDdEr7m0iQM1qJi5bWg5HfkG+YObR9eGDVUEniU/tyWgbB/ImZDhq9GoMwTen66mcuvLOcFu1pa8oqDho2NbjNbxBh493Qm+V3dQZDm/FfTV6SuF2exwxUsPyjo/RXIslfJ+7+SRFvF2l+xkiTZ8Z0rumWd6C7RamzglXlYijdAv2GK5wYCB82JPLypYocmyZuHzmiLoEq8Re9Bv5QNeCJcorKxa27rHHAUwKKCRTeQgpzWBELnlLKuUfOGoUG3MizKaKgJDWE5hpjEAkSpMF8KgPQq7N3qAaVB7tRJUg3D0D1U5SXhCOYbkiWZ2eFNyArC8NMYS4BNwsZh8894TK+TLzMRjYUhkoUkkUmN1zNKmBOvkiqqJvSSIfJYDZCao2CueIZT6wFx0jyI20okiySX8EvBXFFYFyXxq3n/U/RhjvWFiKIyeAIy8jQRGWFN73xFkUQU3lxFul5I5+UNGgsiFCNZZ3hsL5f36cmKtdQOFfoVr5l2P6UYetTiA0vuytP9/+AjyJygFDB0Ijp+Iw4zmyRYwvMK2e7wMTEU/MFRLXGREWyoMoUM+7u6MyFCq57agYyqaC/ui7rKVPXwAr0DETOEDjEI4I+c/Or0c/ZU59ZPChRcWyoluWJgYPH3wUdNEAU1Nlg35wEGdZsR/7TQ21sb3AXE7d+U6GC086wp0uPjr2ulPLDgbnSP82/3Ajt4YXmn9FIf0+dD/jfoY9XrINjkGm/c4qjQIyxdOm//wERPdOM +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Unsubscribe a recipient from Scheduled Search

+ + + + + +Unsubscribes a recipient from the specified scheduled search. + + +## Request + +

Path Parameters

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
+ +Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
\ No newline at end of file diff --git a/docs/api/v3/update-account.api.mdx b/docs/api/v3/update-account.api.mdx new file mode 100644 index 000000000..44c8aa932 --- /dev/null +++ b/docs/api/v3/update-account.api.mdx @@ -0,0 +1,128 @@ +--- +id: update-account +sidebar_label: Update Account +hide_title: true +hide_table_of_contents: true +api: eJztW21zEzkS/iuquQ8LXGwnjvNif7kyAXZDBcLl5fjgUIc8o7HFzkiz0kyCSeW/X3dL82abBDjqduFcW8WOZ6RWd6v76UeKdBvoTBieS62Oo2AUFFnEczEOQ12oPNgKcj6zwWgS+Dc2eLcVRMKGRmbYB3pcWsHyubRs/OaY5Zo5CfBKMO46sRuZzxlnb8YXR78xI/4ohM27V+oCewkVZVpCo5ArplWyYKmOZLxAASA5liKJ7OhKPWHvZSRULvPFcfSefqdcFTxJFkfaGJHAoPj+Asb1Q7C0gH8yo6+hJ4z/8vz09Rueh3OW8UWieQQ6jEHl34VyKp6e/frv8bNXx68ZL/K5NjAWAxVRnDQiQutCGLAytwsOsiIssCE46RZ9YY60ysXHfAwS0HEyUiPvBzsCjflMBO/uwIsZNzwVuTCWukr0Zcah01ag4AP8khHKD+ci5cHoNsgXGb61uZFqFtxtBaVewSg3hVieFz9j7PgZqik+8jRLsL+Idw/j4WB3cCCGg739/nRvOj0c9Ad8b393eBAdBqic9+BTHS1w6AdGYokER+u4mnAfA1VoWfpiIlAcnYixMcHZYDQd7x7N8zyzo14v1zqxXSnyuKvNrDfP06Rn4nB/uN1/zGzOVcRNhOaE6GQIUNCNZ1kiQxqm98Fq1clQ5t/xET+v+I8bwxcgQuYitY33evpBhBjyy8bVYXNa2sO4ZZGIpYKgmC7Y5OzFEUMlWYd9rVlBcx4nkI3BlgsDDBGDHsylID3h00oULGuL0V95HV09FQx+xtqkAqNJqCLFYXgU0cCpvhb0kCU8xCf/ItQZ+iiHGEBF6ugpW955LR/UaMzcB+8YTHVhIKUyA+kN6YwRAUrn3MwEJCvIRLUBC0QiUmjgjeBxDLPj3J03jWzFdq85Nqh4zZNCkO+UOI0pz5a1rTu/Fjes2R/Ml3nSSrmqO1oxE6bZf3d7u+5Rfm90qeKrbFO9qERAMOcw1LTI3Yx7HMjmMpFZcHfXkFZGcSnM/b5bQWcMCPKC92NhwYcQDm0nbtUYh9+uMD6uApiFCJ79lMPvOp/vdRzoWen1EtKQsqHKHfpcdZ64uG5EoAuroFejfVBNZNAPhzuH24eDvWhHRCIU2zt7Uf+ADw/2hoe7or8DHkA3gTibgZrOjf3tPv5vBR5FhgHVYWciLwymsozJLWX5uIEstwW0szYuoM4giLk+ML0OxezCAow8gEhrYcjP/h2pO9jeXtXwKJEY/8+NgSn5vJZTwGisUlKBk+RD6HifLsuAE4mcy+RIR+LhNH8BWNiZGU6QKEjlEDr66otZnmojmBOJpQJNoHbt6gSe6O6wpzwCe519R94YDCrDw99BFjKVhxS6VPIPjHrfhck67NcMKw4En+5vD/uDeH/Aef9wsHOwNx3GfHd3e7g3HOLoKcQBVG+7ppa0h/5VKGFkyBINbEF+AocYwcH3pAANfl/5ac8ByfgC/2Oeu7aVmV5fhmxkC+jP06M3bHDAEq5mBb3nsyUnqM7lOdIPCHY+xVdY7cFyJ/jUyJlU61Qpq8qz5y/GlycX8Obs+T8vn5/DE8paAaWxgmiNMCxBVYiFub4hjb0BlHcA/4j3XfbES30CBnFgEo2G0jaSEAsyL5IcevjR1/Roimax0WkrlUJH3dgj2RXdLYBL5JBU+acccRNLKjR/4rCjc+I9+YTNBY+Eedxl4yiSaCRPHOpa6L+g+hVFhBskIC4glQVxTl3kTOlchqI9F7Ur27NRI+tJc1IwOUDzLyjHYQ6cmWKilYVVtHgV/fyAzs5zbe0ullFyoXIeghVIx8GNwMdDQCawTeaWeTjC6bIAPKpsVyFWs2AQ3L1yyjzLNX0LeWG/IO/eJAA/HTKt+nAtfPJZLIDVWqCeJo9IHs+ps29VTVeZ+G4xssndTe5ucvcLc3f545nnZf4rUZ+dVepzqfwC/NM6gmYoepQuV+mf3GrHTeQWA4d4ivTy7YVf3uNGw8cMCe535EeulK8yy2o+3PtpucYpS389F6gg+dFZEAMSiWhEetcak6Ocq3ZXR3uhzVRCgKo1FBFQ07CFLhgHl5lCKdSE2y0WaWHVLzmb82vapQF9HQK6DZkO7chsmOSGSW6q0aYa/TzVaMMkN7m7yd0fM3fvZZKVVpQtnifZIk25WbhI89/pjxQMGrByh5BVKVdtFjfZCgpjFccK2swhmPZ3pjvxQSgGER9E+7vDuB/u9/newc7BznTQPwiatX5S53GVZO2casy3m0dyMZC4a+BxhYLgsrnWUXv7D9xrRIywRhvnJW8Gn3fdbqjnjoNV7vha52AbCAbuaD6zvXh5doLyYWgSj37ThQkF0mznOmjOc6KUGMPgaWnzDXXcUMdN+dmUn5+m/Gyo4yZ3N7n7Y+buV1HHwUPUcfAV1HHAkGLFSLH+TOoYAe9AahbDpIANYQHuVXl9CMPvPvq090cxSqLXYpH94SqLvNCaveJqUZIl29qJVLW7EN6gbYptTdkWGnA2A4hUeFBFArvFqJKpQE6Kh4gSmUrKYzQI5JpFZxzjGRKXM2W8VaNIFSYFaEigkGh34uiGSwgnESP9Awm0DzoDoP6Oe5x+tv6r/WB2hhafoMXs+cdQCMz5av93b90pgWM8T4Nwce7m+jPHBdyeOVewjBAfMwdfFQXdUPUNVd+U+025/znK/Yaqb3J3k7s/Zu5+BVX3bOjzVB0afDFVh7bdbVZxqRcYXP9zxk6p4jWg8GY6JK4e1RyceAWEEipEB92D+sRsec2gdyujuwCvJiAjdMoUJoEm5YH0W5gjmJu7Ls9ktzxoq/RNN9Rp73p3DeLgAVOXXYBZURHSigFvfLhBuuRZIzF4HdLRAM7PZAuGKfibThbcKx8PPeMELmD1wZyYLQaB7gOJXoOaGawifrHUuuuPRi/ZCLZdmuTuIXv+tXufHU7IZ+xY5757x4L2DLRcMg/Vf1ffJDlHuu1GX7lPUpcQ3Ojvrwx2is367KngBtYC7uzLo5dvLx6zGZJMSvLCIr8VElcFeCsHQoRAbFyeA8FOVFeMLmZzUnzcOmmDScPiBAxmV+pcCDY59k54Deh+BnBMLsVOghAAe9XXISJxLRIsfN3akxh4MlI98FCPt/o9piJHqwGp8CIDve1eqQ57JhF76H4JtvEm0uKOTbLSLt6w61uV+FspreOkdUiafbykhXPtJHQnt0PIXBTBE0ve+ubBnbxOQx4uneANSl3WAT3h9WifjwrLWftmPVryOiivrceVejuXUEHb3ZgDLGahACYRO2bhXGsr/sEYhg6mwWRWQBZ9s1o3OGiHMqLT326o1HFDdmQH+CDpdwKJoVww8SnWY6Ij2u2MUEq+p5mFnH9P1x/et2ym1xMom9gy0qH9Zp1xwA4O2HEYYL3+riphYEFuow2EAy4Ajur5JyTwijYwz8lai+okvkd9sDSEoCpJsdnI/RjVAOefGH3A1lUbgGCk09WJMbwN52VhaWo5q9wIWPbgqr6Jhoq45Denb/XnTKySfzV70eJxvV9yqpLF90bpzyDJXwd3/yTE2yDNz4g0nuDivuNZfQH1+cN3xdrX9srLYiv30oBkYSiTSX6V0UwgxwRXdwbpgjNeRoavhALE0mEN5G4NIz9qigHlcswXwotwLgXtKWSC58gqtzBmdUo5DlQagQVWjiRoZqANAIIFpsunMgF5XfYWFm0KeL3BBRue5QWpH7RfuZ3DDNKVSvasDAogZ2laKLy6DEoUKeMQeg9ETiRtWDiAg/WbEqVlmihi1avMdgxJdEWXli4mtacxbj7DurYRIA+MBfFh/c4zOLJx2bE25AzvdPvLhm1q/5BsiMrOXCQZLhkBnYGoicYIr44vViSCMOX/3IE3dH0n28O2eI8UjHfBsNuFhSLdftU2h/VtQ+6lu/Rc351vhdFtvcv+/35l3hdHXNX0MtyDQ38WbpXlMnoSlGtZaD6SEd5BnoPD8cvtLW7Q4MruDl+D2rj6n7yrF26EFBAL+Azr5BhQbPnOenM2Hp15ZR+z9p35tXqWO4pq0UAaePxd4B4EqAordVCWNolIEffB/1Wic7EghlF2vO/yOi5pXWe3B3VPN4K2al+AggZaT/3t/dTtcRh+Ay/x31FwBf/BD525BING9P42KHcMoY0TXNK6dazGP4Dzodl/AECbH+I= +sidebar_class_name: "patch api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Update Account

+ + + + + +Use this API to update the account with a PATCH request. +This endpoint can only modify these fields: +* `identityId` +* `manuallyCorrelated` +The request must provide a JSONPatch payload. +A token with ORG_ADMIN authority is required to call this API. + +## Request + +

Path Parameters

Body

arrayrequired
+ +A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +
  • Array [
    • value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    oneOf
    + +string + +
    + +integer + +
  • Array [
    • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/update-campaign-filter.api.mdx b/docs/api/v3/update-campaign-filter.api.mdx new file mode 100644 index 000000000..471ff71f8 --- /dev/null +++ b/docs/api/v3/update-campaign-filter.api.mdx @@ -0,0 +1,95 @@ +--- +id: update-campaign-filter +sidebar_label: Updates a Campaign Filter +hide_title: true +hide_table_of_contents: true +api: eJztXGtz27gV/SsY9sMmGUvyK3HsLx1FllPtOJYryZt2HI8DkZCEhAJZgoyjevzfey4AUqQkPzZJ290MZ3cciQAu7vPcC4DQrRfFIuGpjFQv8I68LA54Kjp8HnM5VScyTEXibXkpn2rv6NLriCSVE+mbASzvxmw/7V1teYHQfiJjage5C0NOM66Y+Cp1KtWU+fmoiRnFMk1P05lwD37RrHfcxKRa+Fki0wUmvvUutEg6kUrF17SdpTNiRgbqKCfWsGOPLP/e1R1YiXnC58IwRhQkMRRzjN3yFBrwzQ6C4JjMn4k5945uvXQRU5tOE/CFFvEVc4T0SBxODvnO3uHB+PX+7iR4yV+9xIft1wfb+9vBHve9uy0vEf/KZCKgyzTJxKo+RpCyd8yiiZF3VRNjQZqYRwFULIKmR0IQPaHTN1GwIOYeJt9eIxmIlMtQsxuZzphVToA2EQbsCw9BmRTtk15VSvR5HIfOvK1PmojerqsmGn8Sfuqtzr7iDuzYzo1+cUJelkqhiYoMNqm5SqsX3KOk320Qa+rH5hvNpGb4f2U2+CKNb1Zm7QVQFvyStVMQG2epWI0EmrdC/9unL/WrctFZsXQaMd9E54LBypyNuYapEaU6Fr5xKObMsCDVrgvRJK6jGwX2n8CvYKartRI4t1w02ch+IQfDB56l0Rze5PMwXLA4irPQeCBPmZ8IiyKpnAvrn8bcWZKAM6ACqFUEHsKZziOJtmEWx1FCDqiyMORjaqZwAP8IHmPtdXappUVSEcvWTFvsZiYSwWRKvJJSzjqnF8Ne/4xFCev+I/9Co5qlRkPlRoYhk8oPs0AYzo3WpWJToQhRIWVhTcY1g+ZLpkA/8AceJHdcoEt1RjuD+Lqc4ZFZHprEqFJlc8LNQhA8K6Yk7C65eNEFOs1pnALAS67Bk4Qv1jyDOpEqyxPj01xvwo8qLtjWDQDs+O703533h71RF88G/VP6p3fcPRv1Rv8sfbxuj0aD3psL0808Ou2+w7/41u50usPh9fmgf9Izw4f9i0Gna1v6F7bP27eD7tv2qHt8XR3cO/utfdo7vu50B6PeSa/95rR77SZfS3sj52bGoZ0iyBrLJEeBItjHQqSPeRj7SJWExxzd51mYShjEtWkigeb22XGrP2CJCE0A6ZmMVwBqkyoQ7BY3HD/Eo4n4PP8b+A/D/sRky/uM0P37Rft0iAdn/dF18aXTPxu1e2f0cThqD0bD6/e90d+MAY6Lz+Abf/sDb4vCdk1p/ZwRAi2eu7FfKLAiYjFzLlYxGjLdruLC1V3ha4ungdsyiD6LBZsk0dwYLzdsJawKpgKp45AvzijjbMAmk3CfNr3pyiZAofRxZjqbFNQOQ7mBi0qFcmk5KekmZ7LsFqS8gu7SMzY62VLJK8pwsnu6gO6S35XdR4kpUG0gNHzfO5rwUKPK0TOM6cjEz+TyYSL8KAk6MxkG73iKGkUXTVRhkOBbZr5EaG17BD2LRK6bT2ORbWxneMmKdpTlvWyePEO6THNViqtKzZzXPnd3lqiOEagW5na3t9czVIeyIQysM98HuxPws6hLs7o0q0uzujSrS7O6NKtLs7o0q0uz/0Jptr+xGoOBkMy6SQIzN9hApFmiCLUtbrg9OTaOggWlJ6mgQxl8V71WxVu7bddxGfNhpzyRSjSmCVAJHArDso+BVFJ8kYHdUUQmtSRz6DP9qiECTTR32BseQF4rX8cJAzWlCfc/g1bvCQXihZIYz/IhTAZFuGyYVhwIPn61fbi7P3m1z/nu6/2dg5fjwwnf29s+fHl4SLPP4SZ8Wk5F96S4t5R6AUxhhLJG/hsKoewN0CIGzORPz3mGxhNBwfYtxHT8Mtqt3gJgvumcs/0DFnI1zcxzPl1RgmpcDDcBkyXcT+RUbqxVc+w/7p60L04pGQ6Av93h6B4kbyt4a0BuGZkCcRbdGI6dADcoVLQIoQ4RNNkLR/UFBOJKlztK+00vNJQJ35pwgAJGuNk3jCiTXgJlHkq+3dpnz2RTNLfYmJ7NCRiWxTJ1f9HG8ihOG6dOky/YTPBAJM+brB0EkoTkodvZxvgFCDEeBLbgMik+QyjbmjbKUqYiFMAra4ilKqvWWOLJadkoFBzg/HE/aftpBuaMmOUoLLzFsejsA56t5qrcjUpKMypdoCDx8zIesAvsBTJBNplq5uCIzKUBPCrvVyAWQWAuloG7d5aZ4zQybT7P9BPi7jwE/DSMaEXDF+GCT9MCyKKRsUZuJodIaDQVNA12vQpz5YFvly117NaxW8fuE2N3tXHg9qBcqyl9dtZLnwvFM+g3MclzrfRJjPeoiOWd7KrAGnKLluauRPr1/QiB/Vko6i++xlS3/cD6yKbyNebbhT3s83F+spyn/qUtiEGjRyvBBEgkgiPD95Jjoyirqr312U6iZCzhoGpDiUh7JGwRZYxDZUmmFHHC9RYLIqHVLymbceAjN5t9FgFpVhU0YtpGqSvJupKss1GdjX6ebFRXknXs1rH754zdByvJgisTLa5O0tl8zpOF9TTXTtJyhg4sPw1lRcgV26/laoWIsaLG8qqVgzfe3RnvTA58sR/w/eDV3uFk13+1y18e7BzsjPd3D7xyrr9cxnERZNWYKtnb2tFuNYvkC72hqOBcOo2ioLr9B/UmYkKwRtBT1M3QOb27V9SOu4cbjr2iiL3japFXSLpSQ6qljgjT0HdOfZO8Lx02sClwUdGxkozsiSwd1jUYnTyxUM6lCV6SAnSTRaM9oTMMGyi5kxWzuMMybZAgjKhqjuBYEkKKCdV8oGAq2CnQ+QdWp85E31XJswFJfEoSs+5XXwgK9KJyf7lpf7cH5hPCiKE18D0bvXa1wxUcAAsCi1lF3VnX53V9Xuf4Osf/HDm+rs/r2K1j988Zu7+jPnfV0P31OTo8uT5H3+Y2K2qpE3Ku/3mZbkLFcWDcm0W+eVEtWNbgpq6AKxFDcaQNiNA9oCOvtXJ/SLduZXDn0d0jKgwtT1kSoussTWN91GrdwlQw0V2Tx7Ip3at6Krpp+tG89WVvA/DY9wfJaQBdQeabDef2ec8tL5pGwYkkH7aAZyaw6jYikbdC7WZr+EH69FYE2XERZYA4Q2aLXlhz/mQeg80Yi4ni9UlSz5qMkO0iCe8ek+e3vYfksETukWOT+h6cC/0ZuFwRj9i/Wl4VG1LVbWdfuzC2zCS0Uttdm6xP3XbZG8ET884mHV48+/X96HnphT57V01IWhwgWs7hIgbL2vlGPg0y6SWJsql9bbJdOSqh2GGTEAKzD2ooBLvMX/c8A8gPgMpGpTRIGCCgUVfPcssE4osIKf81l5okx5OBakFDLV4Z99zkOrMokAof5+Zp84NqsGNJEETvqJk+TkSzxmOXcS4XL8n1rUz8JafWsNQahpp+vsKFVe2lb1+98RHARIKH2mjrmye39BolerSCwhOiusoDacLxUT3g8nOrfTMfFXoNolfl44N6P5NIpNVhzOIW08iDYcB6zJ9FkRZ/ZYxch8Lgcpohir6ZrRuatGEiorG7XWKpYadsyAbKQsPfKQJDWWfiY0rLpiqJULCpwIbkR2NZxPxHLJoD9rEis3l8iexJPYPI19/MM03YoAkbFgO049/ddQSziG2SweCAdYDO0v4GCRyjJcyztDaiuiHfMmMoNfhg1VDR8ZH9crQEOPeJmQbqXfQBBFNVXRz54TtztChDVZSV7wesanCd3zBCYlzRm+W32I+iZPlHk5ckbi+3TfoqXPxolL4HSf44uPt/QrwaaX5GpHF1Lm0/DpZXxrv5isRe7Xn8Vk5xNf4JN2nuvWT04669FLdeNl4xsTdKKpcmqhcifu5XojES4GKczC3/ypBma/P1LVttLqvgL1oNLpvlExany4s+ZTLQSkoIZhAcLAiz2RMLGBR1/lZ+jcjakqBeuB8bmJobbQnck2N5LkPQa7L3WE0rHwFFK2l6PQZUP0VuSb008XEepiiX5/NMkVeAiWxOt5Mei2WY0s9sysHCWolcssgU7cWoHH8JJEgVTbOmTOa6P6FTAemLUsg+MhciVrsjASiSLOKiaCnIIL8Sgn7VxdZjtIETjZkIY1rLI1+idBalGd71RmsUQUxpyOWLZpRMW26QblFfuuwA4a0z7DWxgqdHtCqec1WiW/xyx2Nhf7s8Cfm+n/twkUoLtlZMu4zEWGYXkHa5fumtLtcx7AjhgxXgLDIB793eEszQ4vWOHgMJaZ/j8mq5NjWwAOXS56CIrntlejZw1w6em8O0p/96xz0S5buralECGnz8LAiHil8kMfFtt80Mw7bZndM0RvZySD587QCKlvR2hN2Ke7DvVWl75LxPm5Le2P3ciEPYhN/gIf098j7gPwOI1pvRyTy/9fJ9U/SxdPOqdlNR5z7AMOj2H18keTI= +sidebar_class_name: "post api-method" +info_path: docs/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 a Campaign Filter' (update-campaign-filter)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Updates a Campaign Filter

+ + + + + +Updates an existing campaign filter using the filter's ID. + +## Request + +

Path Parameters

Body

required
+ +A campaign filter details with updated field values. + +
    criteriaList object[]
    + +List of criteria. + +
  • Array [
  • ]
+ +Created successfully. + +
Schema
    criteriaList object[]
    + +List of criteria. + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/update-campaign.api.mdx b/docs/api/v3/update-campaign.api.mdx new file mode 100644 index 000000000..18c0bfbbd --- /dev/null +++ b/docs/api/v3/update-campaign.api.mdx @@ -0,0 +1,136 @@ +--- +id: update-campaign +sidebar_label: Update a Campaign +hide_title: true +hide_table_of_contents: true +api: eJztXOtz2zYS/1dwvA9Ncpasl6XY9+FGlZVWHcfKyfJl5uzMBSJBCS1F6ADSjs7j//12F+BLkl9pp6/RtBOLJLBYLPbx2yWBO0+thOaJVPEo8E68dBXwRAz4csXlPPYOvITPjXdy5Q2ETmQofWrKsgbG+3TgBcL4Wq7wAVDoR5G6NYwIyXjOZBzIGxmkPGKhFFFgGPTnzHcUWGqwVbIQ7OqHi/E5+8ATf/Hp1SJJVubk8DBRKjJ1KZKwrvT8cJEso0Md+t3jRus1MwmPA66DOjBqhJ9qmayB2Tvv0gg9UHEiviT9NFngBGQQn2SDnthpQq/KXS144H26hymtuOZLkQhtiJzEia04EDrwYngAVzLAMf2FWHLv5M5L1iu8axINs/HuDzwt/ptKLUCmiU7FppCmMN3RKVMhTTyXRSKWqwgYYzOBQlmqAEQuaHriCzSKcIyWf9x823h71GvO/NAP3zaavabfaovOrNNqNUPfwwng8MIk36pgjew9zk2fRdIkyE2xKiQgliuHYdz3lQ5ordTPXa7rGAXg1CFZ8AQGjmHSbIXURMBg3qHQbMYNXIC+4HjQO0nNpsyA1nU8si3eXEz73w1P37imB3QzVKiQyLcbrzrUyXX8huGa4t+SWPBSC18tlyIOrAiGMZ9FIrANeRDJmDqBBsjoXBXWUWrH00RNxI36SZBZ4M2C2/5gOvrX8OXcFoODXvio5XGCi8xXq8ixcPijUXGNOv0Nf+LjLWXlWvM12gConSndV7MfhZ9421qCC07rzcaZXjBugJ8QuAnYbM2uJu8GDBeb1dhL1cMrG80V+CXvwNoc2qNGTUykID7h0ZbJ7bKwXHtRZVGIQodKLwWarojTJQ7Dg4AGXqobQT/AAH385W74aoUySsCYkJHCDLOW947LJznqM/vACUZJWDgNOrbSwsAKZl4w4XouElzwBbINyy8iAUqYuElwsAw/seJOypOsOInD8tjA4g2PUkGyi8U4JKe2yW3R+Vzclk0Bpy+TqOLf8u44i7nQ5f7tRqPokT0vdcn1K2uT38hJgDInMNQsTeyKO6e7WshIrrz7+xK1TIszYvb6fisuoUKQFJwcU3QtoA5VIR6wTAfp2TXqx7UHqxDAb7fkcF34xUcFB3zmfP0AZkjWkNsOPc47X1m9LmmgVSvvkCafLyFMRBrrHdgCrG8mROaug7+QmImM09tQq2WJRkaywuQnlCeMa1YwHyvvVqOBf6oSHEEkB/ciDInsQ386+L5kYib1fSECERyQtLRIUh2biq/+xrAYJJSrPHWsP+7EdnquLQ26iOSSlVBL2ZG4qW8oNBLaciwQ1HeYMcKCcRytdwfPUbAZkjajdaN3PGv1GrzV7fIuRGv41esdh/6s0Wj00Ditdm+Ke1pGBtikzkY4EKy+nT+DXwBUKHDzHDscMLMSvkS4Bb4OzAgdC0lVmL8zIwTx+vkwI13LOprDOxncH85FjEsqPjMIfCv0UixQfrrM1ovsIhAJBD1TzyS504285zEH0y/W5X5Dds/x4bkESo9+n4IoJj68EXoNjha0XSDAIX+jxY0Ut7nflpotrXysWGxI3yUTyz3cQROvJXJLm6uCAiMD1AKMEI8Z4Tpj5DcI1S1TQHvAkrRAJEzBVOkKAB6sF0YdP5E32LQCtRjKfa1Sluh1pVUJzt9KiFs8H5dsQwV8DbSz8VbcJAdE51ZGEaIsIW+QSKfRYEJrhVHROqMN5NtoNWqNdq15NG02Thrwf7PeOer+GyVopfYcjcIWZaxbZwOVgjMFgUC6AGsNa1SRTL0EF973zwFiTuDOxfhyMhj+Z/zx3F4O+5PB9/BjMj4b/mcwfv9hfDGajsbnVdSQ9UfP/wBuLM1iBnBJ8HhrGralsdCTxSUaLqJJU/ZGANB4GoEKhTwyosQOXQMrWzD1GTy4PA+7om5D368bezfIfoEQRv3R9sh11odwtErA+sBnM3EDQVJaN43twe0HKTiOUHCr+5hXhORX8DFcYvTC3COkTnFO2LDMLwBCgOBqh80TN9Jo6QIloznWGWodBJHI4Q9qQ0TJLbiRZD40MKvB55AcCoSi59ta+aBwcdIgW5tZvMzRov9ItUbAabvXd4TAzBw+DM9PR+ffof5T6gU/Bv3zwfDM3qQMpz8tXQyxBRjH2dDddRfUdTiZjNGW0JKg6WnVdFz/e4QLwB+KO7h4yQQ3em1lkgxnyMp2XVp1l4ddxgUZ0LG4coP5lSJJ7hMV0pWxH6XAVbWHDBD6I/5gr4Cau1yjGqSVdiGTCeG9WFEqnsaJraTEaIILpSVGJXCjRqXaF6/LTmswnkyGZ30r5Mvz0mVFwKX7KGRY80Q8CxA9I0INLDWGDx/HS87HN9rTVuukeXTSbNe7zab18SrhUaUQVV76IhPJ+YFb7dbuIICkGMhnBraGwaBC1Vpa2Z3ssoGM52ajQUpJQVcEvwyDJdYywj+TSfTzEVAwO0oAD9WDKBobAvS3XMew/K5es+AYsX2AQ6m1hR1jP1hXqILuCPxdtEvNMvXN3MLH/uQc/ozO3423y46nAsKgS02IYqZlS2EMwKwqQCOKIJBI+TyS/9taqidLIxtTQDLPhB+2be7XHXsMS5WQObFvBx9Yp8ciHs9Tus/nVRAk4trlBdYh0yjCEJE7e0t4rOVc7sTWmThPh+/6l2dThCrDf14OL+AX0tou5MZZIFOkhwt1a6VrJ3ALvsiIiGoRdfbGUX0DE+Iu7XMNpb0yawPCZC5kQQ83+o4eZdJZkBXMlTSZb+u67JWsi/oBOGW4t6SqVKVc+MYCgNqZk+QbtgD9FPo1uO0gkDjJLCIb6L+m2kqwBf4I0Ko0IZTlbwDSQpTV1SgS07PyoqALA86fUSryE6yX0zSdGltcnGmLYzEDGoGTXJW7aUloJNI1ZC4A2aElxCMKLgCBZjA3mRjmcnBcLgO4Ms7ayRhkJMHAy8WMIXLz3jJzmiiqyOQPs3yvj94GHxVlDrIWlxfiz7wshZl3Vtnu9prHQviNHla2eU+020dHvN1t8KL6nqWWE0qqdjgwm22RC3PJ2DdUwgaWtxIwi6SyBMxGoGar1jqaNrqUZTTqzVb730WuWyQBGcAqwM3DqN5htB1Y2z15CAlbpAxCvBBc+4ttufUEiKndFO1w9rZz5IczcfS22WzNeKfbawvRKeRmKZQrJVXBbTxnozhUW9Jp1Rq9Wqs7heDcaZ10OiXJ5FnQrywYwjxsfBu/VK06IKZCPP1T5kg9Q7GgIYMOFm+9WIc20sdcXjmOflhe1sN8pbh2oecK8gNxTiDhGgDqUEZmhZqqRNuzlmiBkrWa4i1IsDfrBt3jdtBp+p1Gt9UuSRRJsRKth1UvF22AlROwUc40dla4qM8Qb6f7tiTerSz811VJ6/Q6u6qog0iimyUPymqgaEX+V45yMxVQFpC7359RJa2CFVuyGqjgGYDlHci7Ntec3u/YEORDR8yfb2Rg31FCjLQkK6GqGoo6qP/sWx7AfO38Bm4yGDc0938CWqOdyUaVoctY/hdL+K4LJEw5ktoxrOgJPus2jludsNvhvAXK2juaHYe83W4cHx0f4+gupD6Nir/DvF/6zGFGgTVublzJhQbfA8Y9YNwDxmcCRvBnPDXPsLsPEbifGk0tf3AjnPFRdd16I1qNbJmcR3KfKlBn1ypfrszw7bu0ve3ubXdvuy9P9ujhxL2ucU8J+jS3oc9l7EqVGDy3oI8tw2N50zWyVVS7kAf0/shK54ePUzDsn7Cib5j4ssIXvb8gPrKhfIv5fr4e9v4s+2AjC/3FWiCDJEf3SgY8kQhOiO+CY69Aie3t0d4pPZOgoPEOiAheU9PrMw4i02kc04tNcwDIWZj4m6I4h8kueUAcNQ5q9BJzjyT3SHIfjfbR6M8TjfZIcm+7e9v9Y9ruo0iy+trA4SSTLpdcr62muef2wy9okH84xHKTyyuXZbSCxFiOsbwqcvBmreasGfZ80Ql4J+i2j8OW323xo16z15x1Wj2vHOuvCjvOjaxqU6X1tutIIgYQh995pDEol0mUCqrlPxCvFiG6NfrSKsPNIPO6/WLTYcfONnY8VwnMDQgDdtQPlBcvJ2dIH4Ym8ig3W/hGo7Uf1dF7XoSUqMMgaWmSPXTcQ8d9+NmHnz9N+NlDx73t7m33j2m7L4KOnaegY+cF0LHDEGKFCLF+S+gYAO5AaBbCouAn+O6r3er2mtzs3b6yDOhVUGTreMf2E6XYex6vM7BkKpXIuBAXujdou8S2OmsrcY/vXOJn1+C1pLKbZPDjT8Ck+Gl0JJeS7BgnBHT1utYPcUOctZlM3/JR8s9n0SlEym5DveUSNzKECP+AAtVB5+Cof8EaZ/b54M+pB7MJzvgMZ8yGX+wuKZbXf49277UCWaC7uLBr/cDnArZmzmNII8SXlXVfOQTdQ/U9VN+H+324/3OE+z1U39vu3nb/mLb7Aqju0NDDUB0aPBuqQ9t6g+VY6h1tlvu1ETuZiuOA1Jspn7B6UGBwwhWgSsgQndrhFXv18z1otC3Zw5NuEBJablIdQZvseI07WCRYnPs6X8l6tpcsVrd1Xy0Pb9o7XA5+YWrNy22JxJSh/2Hkcow6iVZL2mlJqkkDWEG7vYeeAYHTpwWP0scPgnEF1/jdtCVzgHtxnSbRbdzqBGkEnhOA+93dQQ8bc4S5Xero/qn5/Kv92DwskQfmsUt8j44F7RlwuTE9ZP9TcTDRBeJtO/rW8URFDMFK//aOsDE2a7FvBde0QRs/fnn1w8fp69JuVHuQkpCYFoCdfAAVIS/Wzz4EwU4UWLRK5wtivF/51AathoURTJhdxxdCsKuRE8I5uPcJ+GMSKXYS5AKwV3G4S4DbrjDy1QtJouLJID4ECR3ySr/XFOUoHZCx3RCHW/uv4xo7leh8aI8btnFTpOyOXa2yefHSvL6Wib9m1GqWWo2omdcbXFjRXvn2020fTBdJ8MiQtL56cEuvVqKHuRPcQaqbPKAkHB/VD6T8bNW+mo8KvRrSq/JxHX9cSAih1W7MeixmFrR9fsT8hVJG/IMxVB00g6t5Clb01Wzd4qA1sohaq1FiqWaHrMkaAELi7wwMI7bKxGcYkAmPKFsaIZP8TCsLNv+ZdjN+rsyZbl/hAQjQMlC++WqeccAaDlizPsA4/t05Ea/pzCacA/kBqwCDYv3JEzhGSz7P0trp1Yn8IfXB0OADq0TFrE7sxUnh4NwvRg+wdd4GXDDi6fyTMbhmjta9PR+gEFZWCdiU4Da/kYKQuCE3y2/+PhPD5O9tvjjjflEwwS2tv7SXfsCT/H787m/k8fae5s/oaRzCxcLjpDiXcPj0yVfVM5uyA7C2TtkCkIWqTFNyaUbZgCwS3C4NGjreBv6Fp+QFCKZDEmQPsUF8VCaDB3ygvdiTbxZSUFFhJXiCqPKATkJZko0DlEbHAqkjEZrT2QcahMEhDZQR0Kuzj5C1xT4sH2ZsdKaOYj8ql7pdwArSAXHsNFMK3ES3TGM8GwKYSJcMN+E/oTmBNH5qHRwkcLHIZqYIIua9MmunDY0gCjrVSeilGYdYfYbEtqQgT4wF+mFc6RkEiSviNgIWE5ng5kNpj06rQvunaINW1hYiWtHOfWALMsDSCO9H0y2KQCx27zvwvEHXyRxiWzwVDyZvlaFdh0yRzvJTJoEEt0T30h6FyR/cunhXVNp/s9NPXWDCjOJwhQUwnEtqMxxrTVdenkhC+xMZ4BkKC5gtPrq7w/IIplX3eBtsFHPvq09F1kRmCgtR3SD5oBxeTdwJbK/pBc/LzjrdOZms5hevS64Afv4ksEoA04FcGiZEZRxi1j5w7w1q0/WqfIjeY2dlYs5pO9sq0SPdyPfkmTsdiQetZ+7U1aWtQmiOG4nx3xPvGv6DC7WyFgCN6P6dl9X0oI0lnOGuXbDD/YAFgmb/B7jFZmY= +sidebar_class_name: "patch api-method" +info_path: docs/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 Campaign' (update-campaign)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Body

arrayrequired
+ +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 + + +
  • Array [
    • value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    oneOf
    + +string + +
    + +integer + +
  • Array [
    • anyOf
    + +string + +
    + +integer + +
  • ]
  • ]
+ +Indicates the PATCH operation succeeded, and returns the campaign's new representation. + +
Schema
    alerts object[]
    + +A list of errors and warnings that have accumulated. + +
  • Array [
    • localizations object[]
  • Array [
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/update-connector.api.mdx b/docs/api/v3/update-connector.api.mdx new file mode 100644 index 000000000..ea35df6c2 --- /dev/null +++ b/docs/api/v3/update-connector.api.mdx @@ -0,0 +1,128 @@ +--- +id: update-connector +sidebar_label: updateConnector +hide_title: true +hide_table_of_contents: true +api: eJztXHlzGzey/yp4zB8+ViQlWbHXKsspWqIdOboiUcnuii4HnAFJxDOYyRyWaJe++/t1A3OJ1Jnk7W4es7UWBwM0+kZ3A4OvrUxO0tbmWWs7MkZ5WZSkrQ8rrShWicx0ZHb91mYrj32ZqbJHa6Xlq9RLdEw98P5IZt5USOHlaRaFwis6imwqM5Gn2kyEzlJhxwgjQ9UZmp7Iok/KiHOdTcXh8buPvZ393QMh82waJTqbCZ2KRP2W60T56Co8GQSAiNbe0W5HDKZKjKMgiM4J/FirwE+FTJSICRs5CtSmeFrhsq8yCSok2mQcB9pj8v4RBtwpSVTADSByrCe2OY3yxFNlC8iOZQLcM5UQy762iBCQb8k6oIeVliaGAIXpHJcI4aqr+CyDXIloDJJUhWZHnHAXAk0MoJe50b+hq/bFRBmSC/gBvlZs9hLFyHcwZ8Gx1maW5GqllWazgJHUYRwQguoiDiIfTWMZpNTBm6pQtja/trJZzD2zBBzlnpLHbLbkSUXi5eUHO4tKszeRP6ORVydtEt4TgU4zIrVC2Yc4dCCsZolS3SBBD9LwSaQQOVF/9v7k8ECwin14PM2yON3sdrMoCtKOVtm4EyWT7jQLg24y9p6/XF1/ItJMGl8mPrEDM2bKZIRkTezdX9PItFlR/kY/6fUcH2SSyBlJNFNhWmuPRr+Chjnx9gQhak3hsKBHyBSkjrWByEYzcXb8dlsQkqIt7ktWQ7ZnsFDWR+gZxBEnxMFMK8YTrxZIc14ZS64Tq0cwHJWMoyQEfMje5CFNI32fJw6jz4p/xIH06Jdr8KKYeJRBGQiRSmWKnpcOy1sx6gn7wjEm0hBcAgcQJyqFBFkjgHQmk4nKyMinhLY0QgUqRAdHhByPIR3L7qxOZEOhu/W5gSIbI/POqMMxG/f11nCgzkV9PMjXWVDrfLlSDicqJiqpj3+2ulqNKN7XhpT6VfQpG0oQUOYMU43yzErcOaJ4qgMdw0Jr0AotLoDZZ7LheYWwLsnyMU/BwzH78BoTVyqPTO+GpB/DFqTg47cTOZ4re76RccCzxOs9zJCtobQdooN6QP4xIFlK11dX6c9V1bF+xBflGiV2QEbJuBu8wELTLwc2Dcuy+S6mVTk6Y5eFigncQIQzkPsB4751YCcq+aw9dRCdE0gvkGl68AAkeeA8qrXmy5X6MndP8LV1vwE/tdgbi31zWb7vHLXR4oIX62qeV9+hRXzGso23W4/WOquPhDJeRMvM1qPTwdv23x9993poXv3PzuH24J9HfdGrQTs6fbO3uw39TrFixeSXOn5GWj/XQiDqI0vstupdq7Ueqm5Kje35MobHA1ziE0a4aKqXkRQ0HN1JjqUIK8d2EOU0P7HnDv26QIu1Y0GUc29FqWBQK4D8Dma3gSKWj0RPppl4vP1ErK+ur4kTMIq9vxgob2qiIJrA/FbErvE6QvQQA/IAig1Jf5TfEe024NXFt32V1PsJEaDmIdxJKqKH8CUH7rXxwgKwkLNXvcJz9zB+YmjpSvkN3r3VAS16pfvEfP0fgaRzQzM8w1HpAE3sq/FsH7v3ghDv+jUIeA6imVIHeTgi/bsPLF+n8Pkzcgo1iJ4poLzqXkPuq+4ch52aXo267+trePjdlHPYgnYC71I9hy3WTzTZGDJAOIBGEw1b371erLDPHqiwr94i1CL8TIoZKABE/Hd+ft6pO4qwe5H63bLlI4VnH9c/rnbQDCRLqg/u6DF8rNxe5lwOBlC0juaxDtQplED6VZtT9+3bQIJRWU4kQJhKImioHNNJTZKs/QL/vXqDTqXAhfsPuob8TYTyAkqnCNwaCQbPJ/oLwULQVCFV4UsI5HEcJVj8+xdY40muNPxXmVSIUP+86A8l1RQsUJhJ7ygLsurKiHSv4EfeQJC+krxeX1XQ36WdS81cauafpplvkyj8fb4zgnLoZtqUxm3Xm6d7thfZSOf2iSCrRE6Uzds+qZlLLXRaTd8MPVm67fJlNy3LIjS15ZnyWSYLcvZ5KosSRDGSVSutZFTki7VKzC7XZhIlzpHFSzMT6kJ5eUalJTe6BGZrFY3Rg1msqWQ1s2QipcJCm82oIkDz1GBRtlUAklkphVpRx+RBQF2L+srVkkSZd1YcPGvFkd+lKkKJEzOrS6l6xVZ6WutAJ1sfMLpS3xrwURTBfswcVwkVoW39yuEMOgmEI6cu0KIuNJZ5kLnaEyZsmP2D55TOfRTsd6/uMH+WSJPaIOSokerdVusJZUyzZVIbrkxUcESVmpNOgRHQAkU6DzBIlzV1kkF9OotcLbun8lzrm3mXvvEAlz4034idQ3FwOBD9nd0BFU4LMeFvVVEErrVYeOAIUuzMwxBrDiAhesv35EgFH53IQMqJyqg4k279pJKRNn6O30qbNFNBgN/K1If1JpNETWRjXK3t6sDUTuHG5pC6yVxydYdpm6MfNPOuGUfXTfwDu8k80XARWH00bFobxar4CQtRhZf4cq6pxGCEj3D6xxyzKLGjAvSW4kTB0DNBiTxeHpr2UaJCnVLV1xe7Ps2bzZDfd16Nktf0/3dq5KYbKS1ewfQjM3n9L6Wz4TBfXR17COIxW4IGmps6Vai86rr+QFPRIqZDGQiVBDIfAWeC4ssciDzWRuxrAy02T8TYQU54VI2wz1D3Go4i1FmdRvBjAdoEo0D7+yjN2qfHezW8MNzxpn2yvbvftpz57UaI+FtA7B3ttge0r9AE6TD6kieiEOdYf4HoiAyCekXkC7SlSUG/ri81Du2C86I2HAvHAozBXR8LwVsKLUrUT8B9ZSaJhfWc//hj1ZRZz3yR04DqntC/LALqmR2gNggRPK9wP5mPWR8T+veLCgzNTBMIyciB9Eycq4R4l0bgDcadK2PEJImKmcWOpMDFgc++gHL41SmUZUz7NjyYiRsiDGnSF5ZUMZpjTiWblLxRFNle5R/hUxtC7ENPpJkIwzapKskhpUjP4a1Ohq0FrK2mfpdgdVdm0eSNV6MaJs35avltOSVUheuc30cBNOuj9LyauLfmMGz2niRxvfci+M0BU1jIVrE/8NVZxkeyjI/WMrjHZffz+tD4kbenzacb3eW+miai8hTievfZgGZrAfPDWVRtdlYNlg4NmTYse6sw8aGp1oyBDlWUZ1t39FpDA6v+ODj8oX+wVdr30Lj9lum+jGPKkei5TQ3toujQdq+GxuIPDOz6i5DZVWrYjxfatqjfuyTKY1h/k7ojBLMfOQO4xmqH5oSrymX9Y8s+l7hZ/CkedoiPkQSYkymi0R0EG1s78A+7tDvgKulh5OdBw9tWRnPrYjLSKsML0vx9h+gk0N70E5B3bgKhCFn1uwhDjTSIrCr4P3D9vC7ljugj/KUtmrSQYPYlg9cp6IdvCNnH9Y3fhorQnz0y0vTL7FOQpxCNAQ+pHtThjYC5ndoHhGFhscnLoZVxu0IULJ7u1vY17h6IlenB6S7m6/9j8P6EdgUQGFHCS3mKR7lOWkiNWmp7nM2tDpuQLtxpdbttO/2j4/52b9DfQeNO/6f+3uHRfv9gwE/7h/hz3N/r907wfuEGTi2Vs3PVU6pyaH3bpSw/7/CGbMtuuWws2mXZDjQxtJ8kgN8WxyrLE9rXdOG42xIWo8jnrXttOJ+9ZRP2Ptsvds94mzevb8s330L6bZgO77wqRtnDQKpdfta8vRxGiSq2od0uPPfrNJgGTnTWxBvpg15L37YjxmYP3ifA2vVvR+jUbuIXQ2g3v9hdWzCteqHk6Pnqy/WN8fMNKdf/vrH24tvRy7F89mz15bcvX9LsoUpTWNDt6e87ivG1h1QEmQhclg9ZSfCeEeDJb9rlbsqAYdxxA8j2Lcl0+IpMXWQryNnebB+JjRcikFh6uV1OrjDBtE9P5rJfUG4BH9r6xI3m9LZ3ujdgs/nxtH+CXwRrznR6Btrqk1oCVejCFM41qwig9D9VAW8rd8RTB/UpCEKOVO/ozmukMyyjoXDJJka42ReMqIMW4yQKG6bEdnOB7E93VGcF3gttIR8wGFE9S9DOPbo/xVKm4qy95zj5VEyVROzwpCN6pZuzxfkU42e8Te5TtUFbAOMcpqz4IA5WZWEiRA2qKYuKlVdrEYUn2asLhYwDmN9h19/LciDHZNatsNQWh6KTD3C2nGtiN6gxjVk6w5LgZa7+wptWHjwTaKNjSM4dkbhSOB5T9Cs9Vt1Bsrvbt8jsZJFdqmSe3sHujgK4nzaTVr74rJzxpbQeWW/E0ijE5DySW7Z4sOtViqswfHvoaWm7S9td2u4dbffqy2N3tsS95dBnbT70OTXuVCItnnOhT8LaY6Li6OIXm/hbQa4IMMSFSO9/Hrgzj+ivLmI6R/MHxkd2KV9wOqaQh20fFUepiqW/kgUh6HYhiIIxPJHyNxnvCmN7LodZ9Wx+NmRMI+1TFj8fIlJuLGZRzsc0k9xwzC7TFeFHKjWPMjGV8I9IqIGv9YA0KxIHu+u0jCSXkeRyNVquRn+Z1WgZSS5td2m7/522e2MkWWLF1uLipDQPQ5nMrKa590StFOggilPO1aHl8kx6PVohYKKMsVrNyKE1Wl8brY1feGrDlxv+82cvx+ve83X57Yu1F2ujjfUXrfpaf1bZcWlkTZuqydvK0X7DYqvLufGp+BtFfrP8B/Ymakxujc/nF3EzeA6Wfqhix4352PEgykAbVZnbgLG4vHh6vEfwMTWDJ77ZcwBktMw6+9URhZSkw+C0Tv/AM+DL0HEZOi6Xn+Xyswwdl6Hj0naXtvtnh44bt4WOG/cIHTcEhVhjCrH+naGjj7iDQrMxhMKfjYO9Jqu+9XTVR2f27ovPItBrRJHrL+ejyEEUiX06ruuCpbRRiTQVu8i9oW9IfZOiLzpIMYGLNHSIQCO6Ja3SIZ0sp4OSItChZjsmggA3mbV7YzqpZG2m0LdyFm28IAeG7BSCyH7YfC411EmNKfwDBK6DTuCo/8Aap5PW76oHi2OieI8oFv0LTymy+bL+++2iUwJ0ZCUhd+EOoVxzXMDWzCWdKVEXsXVfZQi6DNWXofpyuV8u93+N5X4Zqi9td2m7/522e49Q3UVD14fq6HDnUB19O6uijKXe8ldL/9cRO5uKw4DVW0Qex+p+FYPTsVaFRp3NeJLTlE9PEwQ6gE6WqX2zWR5MbduPCzfthR2tD3QRSaigi0QRX8jTKi6MaVVfrqXdr9XtE5etlZZNJCxdeRKgc3lEHuKGmC87MtYd7U5Lm+icv1n9/GyB86KzqtZQ4f78nA+o0xVTLlvpsJASTXZgnSZPYEXmPiervpu6ET5f6gRdmCGRERbMCn0J6nSSm4FmjITkkb13o+Muc7lCI2g7TYLL2+j56dlNdFgg19CxiH03zoX+AlheIY/Q/1CpCB+Bt7PPKUq1GtGewfrcZIfUbV28UTKh0+p8jObx+58HT2rfsNmrxpSmBAMWdwQVYX/YK46U0CBeopIon0wZ8V7j0A7ZnxgHIFgMzYlS4qx+4v4Ynp1Z2vy4orrAyVefVUBr6JWPpWEDXXCoKxvjnvB6yYmFNnSg3H7wOTRtscMfNNK5f+7jSOQ8UZzFBV2yRtdDkfimgNa20NoMLX1yBQvL2jPPHgL34AQIhAxS5taDJ7fw2jV4lIWhhaBexYE44fBoHrXyCqk9GI8GvDbBa+IxND9PNV1y1xgmrOsSKdbSwBe7wptGUaq+E4JUh8zgbJLDih6M1jlN2maLaK+v1lBq2ynbuo3QkvHbg2EYq0xyREs7RzaRLbKwSf7CkoXN/8IXNv3SoJmbz7ACU08/8tIH40wTtmnCtvUBqcPfLnCkWLBtooH9gFWA7Ur+7AkcojWfZ2Et9OoMvstjaGnwgCpDSeNN+7BZOTj3S/AL6l32gQumyLw8fEa3DTpYtMo1mFXUFK5ycB5f+j7XXOGbxbfcGaUF9z+NXqK4dpPRoQlmf7SXvsaT/Of43X+Tx1t6mr+ip3GxMpUwj6u7M/vlbQ321sba/YpFDNy8aNBlC/M36X2gm0fHEZPkEpa6AdlIcL7ISFXwqcK/eMtegAN+pFP2VlaKj+pgig/f2F94U624PBEryRdZrJDORiHbOEJpcixIQhnQhC6zUHQTnERCqQPA64ifFd9vk/PFIHQsGFB/jVwSWF10sFMoBYKzMMwNXQ0LJPKQLsu4TXN8nXq5dXDF5RCMUMQhYjmqsHZSSWJFh7OgJEwPx+6KvZqC3DIX9CN1RWxpL7Vw1zNWhBy7i6+oXzO0vw02tLI9VUFM2WdAd+elqjbD/u5gDiKAGbdzQreBuEFpl/rSzZf2xiEMeNZBzsn3dUZphlS5Btdd03rtDcBfq5L9/5/LgN1CSBlMN6bSHV9MYzMqa71n1cegJOnN2g2KsFf6bpv6fP1KFR7K5y6pGc6BygdnH6p0jf0DNIB+++XFvddK4PGxY9QT5suff+fwQk4UpU4zq/kt/KSLUBp3Jl/SzTO2isWE2g5u26Q9sFdeFgBuusSXEmU72BbJbhjWatQdjnqD7e/Re+SuMw5tESaR52ikfzdbQ/yvRfdiW7NFJ27/2ipKmuhjARfB4qJYyf2AcNHtfwGo1yQ3 +sidebar_class_name: "patch api-method" +info_path: docs/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 'updateConnector' (update-connector)" +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

updateConnector

+ + + + + +Patch a custom connector that using its script name. +A token with ORG_ADMIN authority is required to call this API. The following fields are patchable: * connectorMetadata * applicationXml * correlationConfigXml * sourceConfigXml + +## Request + +

Path Parameters

Body

arrayrequired
+ +A list of connector detail update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +
  • Array [
    • value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    oneOf
    + +string + +
    + +integer + +
  • Array [
    • anyOf
    + +string + +
    + +integer + +
  • ]
  • ]
+ +A updated Connector Dto object + +
Schema
    \n\n\n"}}>\n\n\n\n\n\n\t\n\t\t\n\t\t\n\t\t\n\t\n\n"}}>
    \n \n \n \n \n\n \n
    "}}>
    \n \n \n \n \n\n \n
    "}}>
    translationProperties object
    + +A map containing translation attributes by loacale key + +

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

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

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

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

    Geben Sie im Gruppenfilter die Gruppenfilterbedingungen an. Beispiel: displayName sw \"S\".\nplaceHolder_accAggregation=userName sw \"S\"\nplaceHolder_grpAggregation=displayName sw \"S\"\nplaceHolder_host=https://{Delinea_SCIM_Server_host}/v2\ndocLinkLabel_AuthenticationSettings=Mehr \\u00fcber Verbindungseinstellungen\ndocLinkLabel_Filters=Mehr \\u00fcber Konto- und Gruppenfilter\nHostURL=Host-URL\nConnectionTimeout=Zeit\\u00fcberschreitung bei Verbindung\nAPI_TOKEN=API-Token\nJSONPathMapping=JSON-Path-Attribut-Mapping\nFilterConditionForAccounts=Kontofilter\nFilterConditionForGroups=Gruppenfilter\nPage_Size=Seitengr\\u00f6\\u00dfe\nSchemaAttribute=Schema-Attribut\nJSONpath=JSON-Pfad\nShortDesc=Das Integrationsmodul IdentityNow f\\u00fcr Delinea Secret Server On-Premise bietet die M\\u00f6glichkeit einer tiefen Governance f\\u00fcr Konten und Gruppen. Es unterst\\u00fctzt au\\u00dferdem das End-to-End-Lebenszyklus-Management."}}} collapsible={false} discriminator={false}>
    connectorMetadata object
    + +A map containing metadata pertinent to the UI to be used + +
\\n\\n\\n\",\n \"correlationConfigXml\": \"\\n\\n\\n\\n\\n\\n\\t\\n\\t\\t\\n\\t\\t\\n\\t\\t\\n\\t\\n\\n\",\n \"sourceConfigXml\": \"
\\n \\n \\n \\n \\n\\n \\n
\",\n \"sourceConfig\": \"
\\n \\n \\n \\n \\n\\n \\n
\",\n \"sourceConfigFrom\": \"sp-connect\",\n \"s3Location\": \"custom-connector/scriptname\",\n \"uploadedFiles\": [\n \"pod/org/connectorFiles/testconnector/test1.jar\"\n ],\n \"fileUpload\": true,\n \"directConnect\": true,\n \"translationProperties\": {\n \"de\": \"# Copyright (C) 2024 SailPoint Technologies, Inc. All rights reserved.\\n# DO NOT EDIT. This file is generated by \\\"sailpointTranslate\\\" command.\\nmenuLabel_ConnectionSettings=Verbindungseinstellungen\\nmenuLabel_AggregationSettings=Aggregationseinstellungen\\nsectionLabel_AuthenticationSettings=Verbindungseinstellungen\\nsectionLabel_AggregationSettings=Aggregationseinstellungen\\nsectionInfo_AuthenticationSettings=Konfigurieren Sie eine direkte Verbindung zwischen der Quelle Delinea Secret Server On-Premise und IdentityNow.

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

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

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

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

Geben Sie im Gruppenfilter die Gruppenfilterbedingungen an. Beispiel: displayName sw \\\"S\\\".\\nplaceHolder_accAggregation=userName sw \\\"S\\\"\\nplaceHolder_grpAggregation=displayName sw \\\"S\\\"\\nplaceHolder_host=https://{Delinea_SCIM_Server_host}/v2\\ndocLinkLabel_AuthenticationSettings=Mehr \\\\u00fcber Verbindungseinstellungen\\ndocLinkLabel_Filters=Mehr \\\\u00fcber Konto- und Gruppenfilter\\nHostURL=Host-URL\\nConnectionTimeout=Zeit\\\\u00fcberschreitung bei Verbindung\\nAPI_TOKEN=API-Token\\nJSONPathMapping=JSON-Path-Attribut-Mapping\\nFilterConditionForAccounts=Kontofilter\\nFilterConditionForGroups=Gruppenfilter\\nPage_Size=Seitengr\\\\u00f6\\\\u00dfe\\nSchemaAttribute=Schema-Attribut\\nJSONpath=JSON-Pfad\\nShortDesc=Das Integrationsmodul IdentityNow f\\\\u00fcr Delinea Secret Server On-Premise bietet die M\\\\u00f6glichkeit einer tiefen Governance f\\\\u00fcr Konten und Gruppen. Es unterst\\\\u00fctzt au\\\\u00dferdem das End-to-End-Lebenszyklus-Management.\"\n },\n \"connectorMetadata\": {\n \"supportedUI\": \"EXTJS\",\n \"platform\": \"ccg\",\n \"shortDesc\": \"connector description\"\n },\n \"status\": \"RELEASED\"\n}"} language={"json"}>
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/update-lifecycle-states.api.mdx b/docs/api/v3/update-lifecycle-states.api.mdx new file mode 100644 index 000000000..e805222bd --- /dev/null +++ b/docs/api/v3/update-lifecycle-states.api.mdx @@ -0,0 +1,132 @@ +--- +id: update-lifecycle-states +sidebar_label: Update Lifecycle State +hide_title: true +hide_table_of_contents: true +api: eJztXOtz27gR/1dQ9sMlqSnr/fCXVrGdqzOOnfrRzNT29EASlHBHkSpB2tF5/L93dwE+Rcuxc3N3yWiSSUQSXOwu9vFbEMC9FS1FzBMZhUeetWelS48n4lj6wl25gThP4EpZO1bCZ8rau7LyJ8w8utmxPKHcWC6RBlC4mEvFROgtIxkmTNNTTIaevJVeygNWI8F8KQJPsVTJcMaSuWBX789PT9hHnrjzm1fzJFmqvd3dJIoC1ZIi8VtRPNudJ4tgN/bd4aTdfc1UwkOPx17rOpyyJPpFhOxOJnN2evbjf6cHH45OWBSz6ccjxtNkHsUyWTFgMhb/S2UsPHiDuTwIoHO4C81aILASbooNQeh761KJeD8KE/E5mQIFVIT0wj3piTCBNvYyjnwZCDvIRLMVira34CGfCevmAbS05DFfiETEikhK1NWSA7EdK4QHcLVGTnpWXbtHpg37qNuwowNok0li7SVxKoB5dy4W3Nq7t5LVEkmrJAbtWg87lvjMF8sA73WdcW/siYntORPH5o7r22LYH9pe3++O+tzrd3tjeKOR1ZqgTZzWh/nljAq/N/Yn/V5/JCb9wbDrDBxn3O/2+WDYm4w8YPJGUxYqeRt5KyRX76jK25QFUiUs8lkuCCNBjL2y3CkU464bxR7ZZvT15nkdXgAJPwqC6A5pGuN3ecicrHdv7zp8Ay7EnUB4+LPEPF4iR2mYTF1i0NwRShmTOPLoHuhVBidRIn3pkiinhgAMg4u2HCaoKL5cBqbB7s8qCu0lCvY3/ImP1waIxzFfAQmZiIUq3Y+cn4WbrFnBlKG2SFnsNFMq4wpk8mUIvues2NXZu32GmmI2e65uKzZ1BcHM2tGmih4X4zAmUhCf8GjNzNZjV2nocbxhTODSj+KFQAsXYbrAbrjnUceL6FbQj2XAXfxlbrjREnUEgS9BRgpTzlo+GC6f5GjK9AOjGIypIobItYyFwkhgQmbC45lIGNJEtsGaRCAW0MAIwX0w80SrOykLaZW52y33DSze8iAVpLtQnPoUturcFi+fiLuyoaL4MgkqPp2/jlLMRFx+v9duF29kz0uv5PaVtclv5CTAmBPoykkTPeImVi3nMpBL6+GhRC2z4oyYvn5oSGaCkRaMHlMFOgRzqCpxp0gl+Owa7ePaglHw4LcZcrgugspGxQGfOV/vwQ3JG3Lfocf5y1farksWqM2qOpT5SFqXOsCU+/sLafkRKvXAUpC6srrupDNuj0ejftfhTmfQ7oz6/faIj9t+r9MdIJnNTfo+ZMaNfZfCXKlnGGfXjM/hyfTt8SGm6yiNXeKw4Kw/5F1/3PWddmfI++OO2wEWhm13UHD2WBNXc5b3c3B0vqGj8XDC2+5kMgYqE95tj7qD8aDT8x3M/BskfCREWyXPC/Hp6gPhCEQOOpvpu9MgmHoLCbrZ83mg8vvnS+EiSUQtxTPqbOp5EDjUMWQ/4P/mAdhDe4J7S9Cxdptuu43/rTtCFRWyO4jiKiUD8dMgWGXZq7U5wVSzCsCuamTJ3boc1smT1yI6gI41Ps9XChKTPRMh+gtYehpKAAaAPjDbo9ee5oHk0VAmvU631x8QE9w7DYOVVvxDhn/qvZ7A3WfQ59geA6wL9BPRIMY+PsAcpNHIF1PutjsDuz2wu+OLTn+vPdrrjP4DDTCBcRgNC8nZiVyIJtkWkQdm08TOMQe0pB+7vzdfpWj4liuxHy0WUXiQRI3JoWw0iXDnIfAbnDRaj8FXpRTsAM4QvJISm8Djp7kAqXUKqMNHKn2ILlYcnlT0u4VjXWWnIfEX2rrImjJq25SUcmoMLZLSTo2XFqNKDP7iQ8INITSHDEbsVEhuYqbA8dWU8hja14ooPaXustpmH0N6qcMCCeS2ALd63TIL/W7dKOq9n6QLB0YE7NH0A2MM48MTNue3ommkiKnH4u+TqDbTbA4HKoCMyDIIgb6cpQZLYiNeZ8Kq22Q92j/XNI/AIfE2ShyS2LoCjZFZIi7RMv1G23XnPJxpxazll69jRNfWgEKJGuOxeD4ztaT29ZpJkRBTmiwwIkMAa/UkCajNEVCqrfG8gd/1RLsGOwv8RjXCP/CflhstTM3QLW7crFdaRYlcd0Fd0qJgxga55kKoFgMFXDepknApmSiYSFVFKlPSFwtfitWHj/gWNKkBuxfXljrvkGvpYVyh9xmy9eqNYdlZGu5sAkDjOfVDVlW31pwyA4H3paCY487N1dsBXTk4/+UzTYfdSfAG4KwhT5QqzLyDDHkCjixjzyd1VliJRkBH+rn2jZL95UB42Pb7A28IEHbYGXmcT7qd9mDcL2PlxiaAFtfKptwUNfjSfAMGU5iUsmvFFqkqRWgtMvMB+aRgcKAXP4AITrNc+o0WOxcCzHjXEADbzScayQp0P4aCqhrktGx19GStuPm2tKrZzyYLUbs65aG3cqUiVxIAponQ5gz4gAVvpp8quseHIGW/qRbYDyTOLBzGMejcZmcCtI1TOVKHcjMTx5zIo2lWGUI1I59XFtQdv+qRnkgguOxHXiOOqjL7TobCnsWcJpsEsezCiwwo3kqa1ltEMeIVJJllI2rXqsAg0ESrw95yD+TV8u0bYdDGYu7+ArSOvKcZutSjl70CiCWfUGjoVowEd4btCRTLwz7n3XG/Mxo4E5/3eu3JYDLB3hdgBpDkm+y32vWPWBVJlwURAEf5KygEYJUy6IQ63xR8q2NANL5A/+jvum0upuGX4XT6DgTlt/sfWX/EAkgiKd3ns5oSQvvyHCefoczEQJlXLJrwaSxnshnFmmh6cPhuenl8AXfODv91eXgOv5DWmodNQ/pQAWYZEZqcQ+ZPCgGo4hUBzaS12BtD9Q0IxDHhFA2lvlJUjOJUJ0+DBN4wvTe8USbN/DhaVFzJ1d8e2CvZEq0dyB5YjtGcqsOVzm3Y/A3EOLFM7GOjyTdsDrBZxK9bDPCIRCGhAqC5BQi+fEUzg56nwQ8S8FMKvRgyojShnA9RtzIWhSqro1EKJOVBocLnc/K0nUBcxo9DJGbZC3NrMSya8cEMTv1UubsoKY1UugoTzLv4eWcFaoxjRAwOyCYTxUw4wuFSEHjCrF0esSqABrn5oJmh8hPrd56qL/C7jwGEH5tEyx/cCuN8hFR0NKLRyIbJRCTz0YFeNq3y4cocX39F2Pru1ne3vvuFvlt/eGZmQM1Tgj6ddehzGZovyJg816BPLHSdnX1m/lXX/nogdxDRGoj0/tOF+UyNE0aflzhl9RviI53K15if5uOh7zvZ16Ms9RdjgQySHs3sBUQi4e0R3wXHpCitqt56b++i2JFgoGEDRKQSdRWlhFXjNAyRE652mBcJFf5gigINcHUE1GsKbML6WyS5RZLbbLTNRt9PNtoiya3vbn332/TdjUgy54q8xeAklS4WPF5pSzPPUVrOoAHLvsWz3OXyxQBltILEWI6xrCpysJxux+n4I1f0Pd73hr2J33WHXT4YdUYdp98dWeVcf1X4ce5kVZ8qjbceR1IxgLhbwHFpCMalkijyqtN/oN5Y+BjWaElShptB56DSmwI79hu+p0cJyAaEATvGj0wvXp4dI338PoHkUW96+hedVn8ZoOlQhJRow6Bp/BizhY5b6LhNP9v0872kny103Pru1ne/Td99FnTsPwUd+8+Ajn2GEMtHiPVHQkcPcAdCMx8GBWRwU1BvmBSrqYq1U6VF7hnQq6DI7qRhzWoUsQ88XGVgSVVmIsNCXRjeoO0C28ZZW4nrRWYQIkNcRCIjvVRJLgRiUlz1EsiFJD9GgYBuvLKnPq7O1z6T2VveiwzdIAUOKSgEkd5QcsclmJPwEf4BBZoHnUGg/g3nOM1ofdV8MDtDiY9RYnb42RUCfT6f/x00rRI4ylYcnuuxfmS5gJ4z5yGUEeLzUoevHIJuofoWqm/T/Tbdfx/pfgvVt7679d1v03efAdUNGnocqkODL4bq0LbVZjmWeofG9bsjdnIVwwGZN4tcwupegcEJV4ApIUO0hdgq9rnVN7ar3fuGve4Pu7Vd5dBsfZ/5g4V78xFRamHSOIAusq3C9zDGMLYPLb6UrayPMLrDtfS7t72GiKU3cqC1ASdeqtdo41EBupMWjUws0fh1pKQO9DiRLtDMYbxoZcJG+qHZJLaC6oVpMjsMHMUYIt0GNpdQhfygqHXLbFqtyQiyXcbBw1Py/Lu3SQ5N5BE5mtS3sS9oz4DLmnhmhXF2lMI5wnXd+9qBCkUKwg8F3bXOTrFZl70VPMatV7R25tX7TxevWWmrH50gISRWFeBmH8FEKAhOs3Uk+BLlpThKZ3pR9LSyUgedjvkBCMyuQ1xrfpWdt3AC2eEMwjmpFF8SFEHwrWKjuiduRYCJs1VoEg1PeuEuaGiXV957TUmSqgkZ6t1PuFvqOrTZgcTYRdsYsI0RkYpDdrXM5OIluV7KxF8zarZZTk7U1OsaF1q1V65e+e2C5yMJHijS1os71/TsEj0sveAOUq3zgJowfFTXV7nZqL2Yjwo9G+lV+bgOP80lZODqa0wHPKYggQYeO2LuPIqU+DujbQroBlezFLzoxWzdYac2eYTdbZdYsnWXtrQBTxJ/x+AYoTYm7mA+JzgT6ZkVcsmfaGTB53+ijek/VWSm21eQdrGlF7nqxTxjhzZ2aOsYoAz/OquhYYFvowwUB7QB7BfjT5HAMFqKeZpWY1Qn8rv0DqYGF1glKmq5py/2igBnfjF6gK3zNhCCEY7nK85wy5qhRVtFysrKJhLqGlznN4ggo9b0pvnNP4dilv2zyYsST4v5Ftx3+VtH6UciyZ8n7v5BEW8bab7HSGMAMs5bnhXnFB2+9BSPtRNDcJcomDKJZKqUsgNpJLg+s6iE2eYJTykKEMqHGqrYNFYmA8wl6C8UL9y5FDQnsRQ8QVS5gzYbLcjHAUq7tO9UE5rRMQcxKINDFSkDoNdin3ALpAvDhwUfrgUGqj9HpvI7hxGkw27YQWYUDHf+pyGefQVMpAuGu7ufsBxPKjfVAQ7qv1BkkkUEEfO3Mm9Hk0RVtKj0iRfq1MfJa6iLSwbyRF9gH8rMXIMiaVO3PoamEORMBPkxMFVo/xRtsEp7LoIllpwQnQGoiVIPH44u1igCsdB8LsGzk8xLahfb4gk/ILw2hl4LCk06lyhSCdTHJbr60Jj6uW11c7ovZuu/lzPgTLLDKmV3iXNytPFTV03aQ6/WDm3DQV0/GI7OR6uXt9iy4SA1cOZ5ROezWPf3OOeDxd4D3obIgRMKVzdFLUfBI98/nJ318ujAvDoz8r5mzSfJNYqcTVaGq1IQgp+/CJzeaBIWq9YXcdV4atwLmGrQKx7FY+lJMtKabmi+ytgXK0JIGaFNx6KhcPplPQe34TUKzfm8yMfpxf4/obVjDqlb6DmemN/BTfx3z7qGP3Cht+RTdqH791Y2YwptNOEMljahMvODTvh5+D9/1HBE +sidebar_class_name: "patch api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Body

arrayrequired
+ +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 + + +
  • Array [
    • value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    oneOf
    + +string + +
    + +integer + +
  • Array [
    • anyOf
    + +string + +
    + +integer + +
  • ]
  • ]
+ +The LifecycleState was successfully updated. + +
Schema
    emailNotificationOption object
    + +This is used for representing email configuration for a lifecycle state + +
    accountActions object[]
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/update-non-employee-record.api.mdx b/docs/api/v3/update-non-employee-record.api.mdx new file mode 100644 index 000000000..2c0aa9dee --- /dev/null +++ b/docs/api/v3/update-non-employee-record.api.mdx @@ -0,0 +1,111 @@ +--- +id: update-non-employee-record +sidebar_label: Update Non-Employee Record +hide_title: true +hide_table_of_contents: true +api: eJztXOtz27gR/1cw6odLMqasp23pS+vETsc3TuL60czU9kwgEpKQIwEWIO3oPPrfu7sAKVKSZSfN9e5S5eGRSWCx2MdvHyL40NCpMDyTWp1EjWEjTyOeifdaHSdprGdCnItQm6ix07AizI3MZo3h9UPjygrzRqtMfMkO82wK127ntzuNjE8sfG7A/KAgwE7lWISzMBbsHVd8IhKhsgYMjoQNjUxxaVj4ciotM+LfubAZu5dxzBwrjDMF1ERBzRA/TXY5FQZuwv/sXrPQ8ZJzmGaFZWNtWIYUhYpSLVU2vFGMtWkajjBsyi2MAHoaGPPTmR6zTzJSQyWsGbr1P+0wqdj9VIZTFnIrcNLsRhXMAZ/8jsuYj4DMWIo4sk1cqlNZCtjQ9wo+AHlc0urchILoEo8lWfikmFbxrNg7XLxRsAWGvzVBCSk3PBGZMJbUIFFyKQcF7DQU3IDfJOqqLtr3q/JjMmIvrq5Ojl7CaPGFw12cLMbdg/Gg1+3ti0Gvv9cZ9Uejg16nx/t73cF+dACDUUXSCLCVzOQCzCKcioQ3hg+NbJYiDZsZqSaNOdqD1+drHc1wxNNshUaQLZaWMIKpTXaYAdFRnoFmUeNG4CJhJiI2mjkZ4+JN9qEQsxMxydOLspQi+2AmXMlf3To8SqSy1YFrVbpm42QzYMmwL56msQyJ4O5ni5t7WJWLHn0WYYY6NOhymRSW5oahzlX2nrS3LMRlTZ47qQjUH6wN3sj8fIbqb9aUiU4kedK0iQQDme80xtLYZy5UdeCfwJ1w5polProlkHjMv5E2TlxD+qLgGqQo46+mSrM2yONv/noz1MR+OtXq63mnWfVV+uUfJJsQ4pmnCSNYFKo8OUIT5uyOx7Ki6UwzsPQ7GGcdblRxEZjxa9XZ+cyBwUgLZMY5BcL8V27Te5OM6rQ74aB90Dro7x2E/c4g3Gu14VPI98aDVtjutru4JrjUWifgUSRxMR6f1dxhCUSWGSuBgI1iPdod8QlBfT1G7LB2i/EFZEiH9An/IpM8YVb+Chicp6k24Em1LS1D1GGOXBKagfgybrIjgIh18gMuEg5ggBsWQSbBETYJlTleMRQyolsifEW8rU4raHWDTu+y1RrSv6DVh5/kFSr6DViphpoaI21ipL/CyLyKi9c1MKviTQUeCocuXG7hIxUDrQp7sVdMMGRGLNUSlEWMmc8dRzbVyjqD6gCbq3ot0D5am1w0vhu6y7XOVmoII/Bm5ZThuq6SJwM1iOG3iyyHo9GsebENK9uw8v8UVv7IkaI9CFoHQad72T4Y9jvD/qDZ3uv863cIFK3H+Eh0JCGZ3oyHjzPycSqUq9eKEpF7Hy8IP18kVGR8X048yU089FrDbr+5v488zB+JZFRquyDWWxe33sQSpX9sDFhnwM5FlhuFmD2ucYRFE2Y9UpGvf8d4FokMAPCNjp4Bam+lEsHEcIkcCmI5hIkMKN7JCGaA6qCYcySL2pjG1cUIkmi22WseMR+k2Bu/GRSj4eEvQOs58HOlJMxnxRSsgV2fYO2yYl/w0V5r0OmN93qcdw567f3+aDDm3W5r0B8MyKiFtQCOVYjhxvDZytJ/F1CYypDFOgSN/AoCAYMB2RMDtDhMkZlI7NM6IBrPkD9ivxtbbtPzy7DZsQPw9vrNGevtgx+pSU7X+WRJCCq4usDmQh5TPeyKX4zLRPiDkROp1rEiVJ5gRnh0/Pbw6vQSrpwf/+Pq+AI+Ia2V9g9kZFJFaJaaCvipvieO/QbQx6yIBdb8TfbKU30FG+LKVgf6XN/OIJdJwLbGPI8zmOFXXzOjSpqNjU5qrlR0hl7IpmjusBFeA4QIp2zELUzQDgteHYahSLPg1EvyFZsKHgnzsskOy5CEkReIwvwZEGIQq9B1HYFxDq4MzEAOoXNIXHQmwyV0XYiyro0FlpxWlYLOAZw/bSeHIfXNigZY6Q6ltXgWvX6AZye5OneXS4hoZyrjIeyCx/EMxGggkwVkgr3JzDIPR6guC8CjinElYlUhkuDunWPmKNN0L+S5fYbfncUAPwFtrbxxJ7zzWcx9HBqRNgo1eUSCm7htmuxHleoqHN/1h7a+u/Xdre8+03eXb577at3fpdSnvZr6XCmeg3wNBc+V1MeQ9SjNikGuu+sUucNAID5F+vnjJTj2L5DC4ZcDX1LsXHzH/MiF8tXqoNSHuz7C9KNUVk0XyCDJ0e1gDEgkoiHxveCYBOVE1V1d7a02IwkGqtakiNQsn+nc9dFzpZATbncYFHNW/ZSxKb+jkhH4dQjovkQJ6FuUbSa5zSS30WgbjX6caLTNJLe+u/XdP6fvbswkS67IW3yeZPMk4WbmLM3fd01xGMCK741Y6XKkquVsBYmxMsdq1DOHxqjTHrXH+6HoRbwX7XUH40641+H9/fZ+e9Tr7Deqsf564celk9V9qqJvp0cSMTXsDcsVGJfNtI7q7T8QrxFjehAmW6TEoDtI4Oa3i9yxt+6hjAz2BoQhdzSPtBevzk+RPixN5FFurpOPTkuig+E8o5QSbRgkLW22TR23qeM2/GzDzw8Tfrap49Z3t7775/Tdr0ode0+ljr2vSB17DFOsMaZYv2fqGMmIUrMxKAX2EOYgXoVpYwpbgU++++jdPuNmIrIy0atlkZ3BahZ5qTU+7D0rkiVb60SqhbgQ3mBsgmNNMRYGcDYBiFQMUEtCdotWJROBOSk+ohvLRJIf44aArpkFh+MMH+omnynsrVxFqjDOgUMChVhj71WDjUkwJzHG9A8oUB90AkD9HXucXlv/VT+YneOOT3HH7PhLKAT6fNn/7a97SuAEmDcIFxdO1488LuB65vjgsxJfUgdfZQq6TdW3qfo23G/D/Y8R7rep+tZ3t7775/Tdr0jVfTb0eKoOA56dqsPYZouVudRbNK7/ecZOruI5IPNmOqRcPVrk4JRXgCkhQ2lOGIInAoeN3erTy4E7SWB3H2Q0b+BxTswNHVu5iWH4NMtSO9zdfQBtgZbmTZ7KZvGYuNL3+Ez77l13DfbI8owNoFeUh1Q7HJ6d+GKjSTI2Es3YYR4t4CROu0KDBcnTMwYb6eMD/ajKGdQhzJHZwbN/3qToMrCZQj3xk/WP/6OEVvYIe7sy8fyp/fyzu2kfjsgj+1gnvo1rwXgGXC5tD9m/XZy+vcDE262+cgZ3EUyw5d9ZWewDDuuw14IbPDFJT8G8+Pnj5Us2wXST3D23mOkKifUBOMwZmAjB2WHxRAhOoghjdD6ZEuOHtWdu0H3YOIYNsxt1IQS7PvFCeA84fw7ATCLFSYKwAGfdvig0E4k7EWMIbC4kiYYnI7ULEtrltXkvKdxRXSCVe3gbrjZvVMCOJKKQxLCNY/wWqcxj12mxL17Z17cy8ZeCWuCoBUTNvlziwon2OnTPcIfgw0iCx5ak9c2LO3pBhR4WUXAFqS7zgJLwfNSflAoLrX0zHzV6AdKr83GjPtIh6vo05qCLWQiFccROWDjV2oq/Moamg25wPcnBi76ZLTq5HZBHBJ1WhaXALRnIADJD4u8UHEM5Y+IjjMyUmGjXIyGX/ESaBZ//BHVzxD7V9kyXryGA4shIh/abecYFA1wwcBhgPf8uPqFhgW/jHggHnAG8WeifkMAzWsE8R2stqhP5XZqDoSEEVomKTYful+EC4PwnRjdwdDkGIBgT6/LZMTxJ7WlhkKoJq2gJLEtwld9YQ2xckpvjt/xiE+PlH22/uOPDRefkg4pn3xulH0GSPw7u/k6It0WaHxFpfKqLHcjKkd/jxYG82nnXpbcf1E6pludLq8dL/cnQ8mDohnOd5bHO6qnMyqHMxenI6uHIp881Lo41Pna2sHa0cMMB8cqxv02nt3ca6LykRF9hVSHD5b6rXVH3shL4CXcJ96hCgfqPKlrKCKtk0phniBCEkOFUCuqnpAK2Cnn0DnqpTgjVoHhAKIWqmQhN6EydAfVzqIBlDPSa7CO+yQP0bLBYxeeYgepn7avWC9DcGZo8OyrcANLRJMkVHnQFJvKEcXC2J3wlkjbMHaRD7apEsTNNSXE5q8A3dEIURZPKNpPYD2NsvENNX3GJJ9YCj7C+6w6CRI3417ksNnIuYvJZHFcvZp6iDX4YTEWc0nlqYAuK38oK704uVygCMeW/6tFmsusn2V0cC0SwcHTG0G1CkUwHnbXNwAEqdK/c61RqJ0jLlwnVTOph8W3D9jVAz3oNkM8gkNndFFuWqILclaKu+L9urCv+YepQRvgihSnoC0c9PGBvC0vhOV4GuWPj5Pp2UelShwBMCT8DjI0B9sUGBb449++DeMmeeu/Q2l0U7Vk1W3RmGvDxF4ENHWB+fgujXMeNWHM3/Fc8weWMkrRi4sp3V9gKcDNcF2/j2NtKZ+XsCt1k5N9klLgekeH3cBF/Dhs38Bd+0alzUhhE1x8aRccVAwORLZLhdbmg/4Dv05rP/wNMGzR6 +sidebar_class_name: "put api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

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. + +
+ +An updated non-employee record. + +
Schema
    data object
    + +Attribute blob/bag for a non-employee. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/update-password-sync-group.api.mdx b/docs/api/v3/update-password-sync-group.api.mdx new file mode 100644 index 000000000..35efb6416 --- /dev/null +++ b/docs/api/v3/update-password-sync-group.api.mdx @@ -0,0 +1,95 @@ +--- +id: update-password-sync-group +sidebar_label: Update Password Sync Group by ID +hide_title: true +hide_table_of_contents: true +api: eJztXGtv2zgW/SuE9sO0ReT4FSfxl4XbtIMM0jabxxbYNNihJdrmjExqSampJ8h/33NJSbZsp0m7wU6nEGZQOBJ5eZ+H59KSbwOdCsMzqdVxHAyDPI15Jk65tTfaxOcLFf1sdJ4GO0HGpzYYXgXlPUY3mbtrg+udIBY2MjIlSZBzMZOWjU6PmRdoWTYTzKYikhMpYpaWQiwJmZKQFhuxTP8uFLuR2Yy9P/v536Ojt8fvGM+zmTYyWzCINOI/uTSQkGkW8SSBXL9QCypaEeU0EGreBpdWmFdaZeJzNoIEUl3GaliuHNLKoVs5nHPFp2IuVDa8wXwRXN/BoJQbPheZMNbJk2RWyiFpJ1C4gb9kTItGMzHnwfA2yBYpXbWZkWoa3O0EpbLBMDO52HSRYMdHTE+2eYPs864jw8RnPk8TEj44OOhMBr1O2BvHe2G/2+mFh9H+Xngg2ntR1BO9vTgOSHtaW9jspY4XpNu6KhF5RmV0i6dpIiOXAru/WVLtdtMoPf5NRBlUSQ0lTCaFpbvwwIbh63Z6G138K/O+wabS67dr4t/h6tYF1rVaLrglhVmHVigDcarhkcXxVxlXBTF1k2sLdqPDzkH7IN7v98e8HYl2Z78/mBz2xoNuu7/XdmtbnZtIHMd2ZVFuDF9srHkibVZLG5+/SB8nwiKrLCYhked2a15Wil2VmvUHg/akvxcP2p3BoLMfc37Y7bT3DvqQ8+Uh7TaqBflkBHL1EQ6jrKe0ZlyhiCVi5yp4JfNvuGWluJ1gos2cI08DmhTShLpn291e2O6FncFFuz9st/H/v6hA8yThYxpB6Q795jp2yPNUCiYcMaiEPpGa0DOTWS1Flwi8GjdfeI8rnAqttmV9N9iW9A/nay1dnyqL7u4cZtpUK+vhpYvrGwV/JibCCBUJwsha5a1sJkEDcQ3ENRDXQNx3CHH9baj2KpEAK/baGG1YyM5ElhuFhJe+9Ao6x8bgc8SDpfrEExk/Ic7FIuMyeaVj8XACvZFKgDtzSRoKp3KEiQwSP8kYM5A3BjnmRJbo4cbV2Sw80eqwlzyGvd6+V4UxlCeGR79D1mMw6lJJzGflFCZjhnS9b1mxL/h40D7s9ieDPufdg35nf298OOG9Xvtw7/CQVp8La4E4D0PVz0IJIyOWaPQj8g84BIUN3zsF3OJbgOqeGDgZj/A/FbAfW5lZ6Muo39lhnL18dcr6+yhiNc3ddT5dc4IKL8+34YgX/N7IqVTbVBEqn1NFHL1+M7o8ucCVs9f/uHx9jk8ka6MVHClka0xpCVWRCzN94zQuDCCosSKBO0TcYi8KqS9gEFd2daAsmsiFhTORWxOeJxlmFKtvmbEqmk2MntdKKfLNIXsmW6K1w8Z0DQAXzdiYW0xACGn4i1EUiTQLTwpPvmAzwWNhnqNhjWNJRvKEoRohFPMXEMR4HFPpegGTHKUsXFer84wpncloratburIejSVYnqwGhYoDmj+cJ6Moy6GcM3O1CqtsKVQs4gOdvefq2l2sOM25dKEyHsEK9N8LuNEYeJiNYZvMLCvgiMJlATyqHFch1uoe4ODurVfmKNPuXsRz+4i6O00AP6EzrbrxSRTFZ4kbejRy0SjDVCBSQRzd5GJUFa6y8Bm2vSRuarep3aZ2H1m76zfPil6uuOuoT2eT+lyq4oiPNs8N6mNc9ihdngP+4ehNEcgdBocUFOmXDxfFASLGi88pHXc9IT/yW/mG8qMqHv76mOhHFaxaLEhB50dvwQRIJOKh03upsXOUd1Vvc7U32owlElRtoYhATcMWOmccLjO5UqQJtzss1sKqnzI248BHjoqw1iMgrariMNVSZQ2TbJhksxs1u9GPsxs1TLKp3aZ2/5q1+0UmWWnlqqXgSTafz7lZ+Ewr7pO1nGEAK79VYFXJuVCtsxUSxiqOFdSZQzDudsadyX4k+jHvx4Pe4aQbDbp8b7+z3xn3u/vB6l5/tazjqsjqNbUSbx9H52KQuE/gcblCctlM67h+/Af3GjEhWCPoqXgzfA6XXi+5Y3/Ltwg6g20QDO5o7jlevDw7IflY2oknv7lDUKLZ3nUYzjNHKSmH4Wlps4Y6NtSx2X6a7eeH2X4a6tjUblO7f83a/Srq2H+IOva/gjr2GVGsCVGsP5M6xuAdRM0mCApsiHK4VxFtTGEKPhWnj0XZZ9xMRVYRvRqL7B5ussgLrdlbrhYlWbK1k0i1dBfBG8bOaawpx2IAZ1NApGJALQl2S1lFTyCAk9ITCYmcS1fHZBDkmkU4mmSwytdMmW/VKlJFSQ4NHSgkms5eNXJMIp3EhOgfJLhz0CmA+gnPOIto/U/nweyMLD4hi9nrz5EQVPPV+e/etqcEjqG8Ibg497G+53EBf2bOFdoI8Tn18FVR0IaqN1S92e6b7f7H2O4bqt7UblO7f83a/QqqXrCh+6k6BjyaqmNsq80qLvWGkuv/zthdqRQauPRmOnJcPV5ycMcrkEqkUJo7DKEXkIbB7pbXmOzurYzvAnoNirihVys3CYbPsiy1w93dW0QLUbpr8VS2AGIIWLZQ+qYV6fnup94W7KFHTX2dAb3iPHK9A73X5RdpOR8bSWnsMc8t4D3urKKEhefdMwZflK+Kh9wX6EOYF7PDkPJFSrnLUDNFP/GTdaNbLoU2bIRtlya5e8ief/a+ZIcXco8d29z3xbUwnkHLNfNI/evlW2vnRLz96hvvri03Ezry724s9p6GddlLwQ26Av8UzLNfPlw8Z1Oim67cc0tMV0jqD1Awp0gRB2ej8okQmuR2GGTTdOYUH9WeuaHyYZMEBrOP6lwIdnVcOOEdcP4MwOxcSpOEwwKadf2sjEwsPomEtsDW0pOUeDJWu/DQLq/Ne+62O9cXSOWfPcfV1kcVsiNJKCRp26YxhYmuzWNXaWkXX7HrW5X4Wykt9NJCJ80+X9PCu/Yq8s9wR6hhEsET67z1zYt7eeGKPGqicIWkrutAnij0qD8pFZVR+2Y9avJCklfX46P6MJPYS+vTmIcuZrEVJjE7ZtFMayv+zhilDpXB1TRHFX2zWje0aOgqIuy2V1QK/ZKhDMEMnX4nKAzlk4mPaWd2xET7MxJXkr+6yKLmf3VvRfxas9ldvsIGSiNjHdlv1pkWDGnB0GOALfT3+xMlFmqbbHA44BPg1TL+DgkKRVcwz8vaiupO/K6bQ1tDBFWdFJsO/R/DJcAVn5i7QaOrMYBgItbVs2P05m0hizapmrPKI4F1D27qm2jsjWt+8/pWX2zSfvm92UsWj5YnJ+9VsnhqlL4HSb4f3P2TEK9Bmh8RaQqqSyeQZ8vX1l8/+atgneD7eRVs5X3C+16dW77Qt30EXEYV6iJVtFGruOAJ7ubRJ53NzwT+xV0Hbq4NQZPnf3iBaN+qmDThGcGAg8FoJoU7NEmhO5HlHSpFPXfQhQ6B8BKtsRM0dfYZxJijzZUJ5LXYB3SlKoI3qSOlh5Uh9TddtKbnSMxTymt2VOY6OOd8niv69Qcokc8ZR0U9UBCxtFHucRsNqhKlZdox32pWCWJUaeSKluvNzNy+n9DpOhr3lbx/YC2kvS2O1uFIikiRhktDzkTiCpPG1TuWh2Sj2MKZSNz7kUha8E+xssLb44sNiRCmiu9ztJnuFpPsLo2FEOoOfTL0WuiE3WvB2mZo4FfkXrpfn2Db6mi8YMdH64l1u/xi4c/59Y9i76WmaTelwz6yK/dNnG+br4JtbTOmDgEwqMgZnECjbm/pVIiayDu6DESiI4er62WP6HprxIc+oz4nAMz13/dY9cezs0Lx5+57rUf+6sdWg8ozTrVYHm8E+Pi7oFMRST/+gVH+2Mpp6W8U35OEFwvHdMqJG18AUT/tZ/ijsC+OvV45nji9pDQcFz83MvcHLYbf4CL9Oww+4j/8oVNfBBjkrt8G5bElxnixJaPcRqiKDwgGhv0XX/tOZg== +sidebar_class_name: "put api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/update-provisioning-policies-in-bulk.api.mdx b/docs/api/v3/update-provisioning-policies-in-bulk.api.mdx new file mode 100644 index 000000000..1beec0f42 --- /dev/null +++ b/docs/api/v3/update-provisioning-policies-in-bulk.api.mdx @@ -0,0 +1,96 @@ +--- +id: update-provisioning-policies-in-bulk +sidebar_label: Bulk Update Provisioning Policies +hide_title: true +hide_table_of_contents: true +api: eJztXHtv2zgS/yqEboE+EDuJk7RN/jm4idvzXprknGSLRVLs0hJtcyuROlJK6g3y3W9mSL1s59FscbtdCAVSWSKH8+ZvKFI3gU6F4ZnUahgFe0GeRjwTJ0ZfSQv3pJqe6FiGUtihepvHn4O1IONTG+xdBKc6N6Gwwae1IBI2NDJFKkDjbCYtEyrqpFqqjDmSlnEWS5sxPWFpjTxLPX2mFctmgtlUhHIiRcQsDcCkYsNIqExm8yN93b1UfZbpz0Kxa5nNWP9kuMa0Ycej97/0Dz4MjxjPs5k20JoBG0b8N5cGiGWahTyOYQi4C526IIkVYY4NQZqb4NwKs69VJr5kfaCAEspI7dV57RCv872EKz4VwadbED3lhiciE8YSFYkKSDn0XwsUPIBfTgzQ7lpQcBPsZSYXwEA4EwkP9m6CbJ5S28zAOMHtskoFO/XqiJB18YUnaYxdeuHu5puNN1s70ebuJn/zamNzJ+q92d7ZGW/z3lZvN0AucWBhs7c6muNoi3yEKLfK8BFPU5CRHGL9N4uD3yyzyY3hc+BCZiKxtft6/JsIs4agF04NqCmDrpaBqbGHU86i4Ityo0Mse8ucUe+6FvzVysYTcA+peJjJK1QfuRJysajlxzBTu4OefAd/DdbI41bxFRrhAiOEMLJszC34KdDlquByzqYaOxTcI8u5Bd87I0aXGVZ5HPMxDjvhsQXLCpUnaIT90aB/NoAW5ycH7mJw1H97iBcHw9PianA4oGf909Ph+yNsfVReOgq/vB8dn5+UdMqfrmv5czR4Pzw9G4yqfsODwdHZ8OznqmvtzuBgeFZRPjo83v839vxX/+j94JcTYOHj8egAfajSainQcqCgUlanmTkj7XXZpRo2ssoaZCefbkJQv83TVJuMXXEjdb5gvTJh2i57B67leVpj1zNISpz9BiYTBpMPjyKXeQriay79JHzOwGLTKTQba0hiThgwfMSccu4ekQ14OHNiOEGBHoSvBY/BNMdXSQ29+nXxZhwCgSsIozwZAw/Oke0qV8bEHIkJSBSh1s6oGTeCPD/USQL+WjFj96CNF6bDaB6ocWpETP4OCnm2T77P+mGoc5gjYMKZyFg8W1uOKEgxKfajMMan3PcBMmPhgyhaMAWp+VrncYRtcgws7F4aB6PMawSUc6m81u/n+Zwmsifx7Ps+Q1MpSJFw+043uot3YDkDrxnnQNfOVdgQ4lK5eH5AhIHC7PAN1C6I0Eq1h49SO1yHzovcs2e2HAFpFFa9VD49PSDYgbTfSLLIUXqEaD7eYwHhZBzYSPQVRjyMoA3kjhgmH6OTmq9dqp91TkEIJHzUTeBZPYiczgCrzPHByulPiAjcBsGYzCgdnpezAkwRgJ7iyH7NfP2UuRlTLbYs5sHSO5v4BOQ0R0gQGMsMVxakS1bxsCKRF80phwIwmeMFjkUS1ocpyZk8RmRQMlMTKPBJ51xJQEPs8KB/wvpFu+CW4MCE5zHiIPzVpHE/uyWdGuQs/KuSusmw90Po/cPNRBqbIZu33R9uYu6vf7jJidd99E9hboFAGOs8+sC/OCH2ZyL8DOwFOxu1Z6fyd0KG5b1RCccCBHwkq7TV3VK6sdbgzooQHI+OVTwvIGJT3HcxR1QSEVIEv4RQAEkNAnGls6Y71GF4N6gpuYAohUroN3rJHeDm7pn+HverELW0H2BY+ROP8ztk/mMyJki9c0XkHyHnbRW879CbD0TGZWwPMg3mqT1cqsXmvgk2MsKmMIM4D+1tbOB/C45ZVl3I8Epi7JpbgDyEQicAIOdgLvDM0InR1gZtbdDWBm1t0NYGbW3Q1gZtbdDWBm1t0NYG30FtsL2qHNiPJQAbNjAGWO2wkchyA/M3k05R/j0BII+IXp9IBTzLJ9UBd+SPiETZ19EjzPgOkn9najgiDCaI5RA6urQXod4TbRB3I8nC1tSuaWfQRHeTveURG3n59r0wLu+En4HWMHqYIZ8dii4AxctAXjGseC34+NXGbm978mqb896b7c3XO+PdCd/a2tjd2d3F0RNA95CdVyXk5tDvBUyEMmSxDsEiv4NCIApB98QADf74HE40HhlGrm0ppueX4WsyBMZv90/Y9msWczXN6T6fLihBdc5PG9UH5gyQ3BE+BqgrV9ZXRXVyMHjXPz88o8LhP+eDU7hCWktvHfuqCEhNqHWmr4ljLwDVuCIGdeD0/dJTfQkCQQKuN5Tul51bUCbzgQo9/OgretRJuzm9Hkqhe6fInsuu6K4BQIB7Cc8AqJdFHTZ/CehEpFnn0GvyJZtBlhXmRZf1o0iikDxmlEFckQBIw9UQ0hGY5BDKgl6K6jzDNCTDhXxXqbJpjSqhHNaNgsEBnD/sJ/0wy4E5ErMehaW3eBa9fYBnp7kmd2c1pZFK5yrD0hZf20JBrI0BDTPIqExmlvl0hOaykHhU0a7MWPU8Senug2PGZUjIZzy3j4i7kxjST4dEKx9cCR98hC9dNiJrFGbyGckDEursW5XmKgK/hCtt7Lax28buY2J38eHIL4IW2Aehz+Yy9DlXfmcITp5L0MeQ9yhdbB/5neCNNyTtMPEQ6cePZ37/Ce5y+ZIW0PUb4SM3la9Yxi3s4e6PqVotjNWwBTJIenQSTCATiWiP+K44diCRVLW1PBpUt2MJDqpWQESs2bD6pJUekyuqPbldY5EWVj3L/AqSW7ekDFjfDdQiyRZJtrNROxv9fWajFkm2sdvG7vcZu/ciyZIrihaPk2yeJNzMnacVL5ZBWs6gAStex7My5MhUi2gFibESYwVN5BCMe5vjzcnrUGxHfDt6tbU76YWvenzn9ebrzfF273VQn+svqjgug6wZUzV7OzuSigHE4YuJXIFz2UzrqLn8B+o1YoJpjZbXC9wMOgeVfqqw4/YydjzSGcgGhAE7mjuWF89Hh0gfhnZvQEFv/sWP8aqD5jwjSEkLquKLtFkLHVvo2E4/7fTzt5l+WujYxm4bu99n7H4VdNx+CDpufwV03GYIsSYIsf5M6BgB7kBoNgGjgAxhDupVCBtTEAWu/Opjsc+Bm6nISqDXQJG93WUUeaY1+4Db0DxYso2VSFWpC9MbtE2wrSnaStx7M4UUqRhkLQnoFr1KJgIxKW7ziGUiKY5RIKBr5p3+JAOpXMwU/laOIlUY58AhJYVY49orbpuV4E5igvAPKNA66BQS9Tdc4/TW+kPrwWyEEh+ixGzwJRQCY75c/91ZtUtgiDtKMF2cOlvfsV3ArZnjfiUlvqQufZUQtIXqLVRvp/t2uv97TPctVG9jt43d7zN2vwKqezR0N1SHBo+G6tC2u8FKLPWOdnz+vxE7hYrngNyb6ZCwelRhcMIV4ErIUKppoZU+YbEXrDu4btdviq9Y3K4vfxEDUs36OI8/d9ynPgL8sgbiRsdybmKgNMuy1O6tr9+AJcGCt12eym5xlEnp626ok/WrrRV5Cbeh2mKrfpSHVFf0T4a+EOmS/o1EF3f5kAZw1vC7bAMLVqH9B/fSL3as0956R2YN9xF7d6PbwGYKtcYzS6275F5LMoJs5ya+fUien7buk8MRuUOOVeq7dyxoz4DLBfGQ/U/Vh1BOEZS70Zc+h1JNNPg6oLc02DE267G3ghuoGNwOmec/fjx7waYIRSkV5BZRsJBYO0AwnYCLUKrrF7tFsBPNPkbn0xkx3m/sx8HQYpMYBGaX6lQIdlE7qcVGkLRJpdhJUJ7AXp+eF5aJxJWIcXrsVppEx5ORWgcNrfNGvxc0FVLNIBVu0qe73UvVYQcSMxSe0KE2XkQqAdlFWsjFa3I9lYl/FNQ6jlqHqNkXC1w41V6Ebn93CPGNJHhsSVtPHtzR69ToYYEFd5DqIg+oCc9HcxdVWFjtyXw06HWQXpOPS/VxJmGebXZjLq0xO6PDOUMWzrS24p+MoetgGFxMc4iiJ7N1jYN2KCI6vY0aSx03ZEd2ADUSf4cQGMo5Ex/jrE2gRbv1EwrJX8myEPO/0mm/Xxsy0+0LmFyxZaRD+2SeccAODthxOcB6/t3chY4FsY0yUB5wDrBf2Z8ygWe0lvMcrZVZncivUx+cGkJglajYdM/92KsSnL9i9ABbl20gBSPoLveV4SEoT4sO5NSVVSwXLGpwmd9Yw7y5oDfHb/nSE+fSv5q8KHG/WlXBwzjfOkvfkUn+Onn3T8p4bab5O2YaD4NxdXJUfSttUBQsF+U5wad8TGD5YwHf7tR/49B/dfK9OOZZMV6etVx91PIPnY1cOA35Jx5eXFsqXxeO9rkDdvTpPswtxK8vDusZzUHz5QXd8mAuPKW0TMUV2MJ9jRABa50M6qE8pBrOpKCloBTUiTB/DZOITijpgjugzcH4RGhKKjfgnRyKdxkDvS77iGerQ4gnrLNxCzZQxRPSNOwphNQJfXDxoIhSQMtJAorOyDXzhHHIBQ+EciRtmLsZx59HdwxpwuxlryL9Yo5AVXSp4jSJPZ7gOwMZilrEPjAWBKz1LwxAkTW/qwQZ4XFuzPro741s8BBtSBOdmYhTdA2IMUDOojbCh+HZEkUgpvxbKm2m676TXce2QATrWucMW12o7/EW1swJVzW6+KlM5r8JUD+kyYqvaS561k31vuT7+X6mDzWsEddTXPekb5C4mtUtIFz4r1+ivHu1D2GuXEOA+/VVBIjQGS5GAJGbG0yFWFLf4m3ID7g4c/Gpqpgp0xXH88tjtXeq+HmROF7QG8DGpzVXSlWs+ap5tdwTwOVngatEpWSQWIBrWswjjtxj//aoQ0m66r70WgxXElwPt0B4b9tPtUWbk2NcKg3G/vOeiVt/MvwabuLfveAS/sEPnboogkZ0/yYoVnOhjaNbgOlVWNJfgOah2f8Aiw8mIw== +sidebar_class_name: "post api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Body

arrayrequired
  • Array [
    • fields object[]
  • Array [
  • ]
  • ]
+ +A list of the ProvisioningPolicyDto was successfully replaced. + +
Schema
  • Array [
    • fields object[]
  • Array [
  • ]
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/update-provisioning-policy.api.mdx b/docs/api/v3/update-provisioning-policy.api.mdx new file mode 100644 index 000000000..22361768d --- /dev/null +++ b/docs/api/v3/update-provisioning-policy.api.mdx @@ -0,0 +1,122 @@ +--- +id: update-provisioning-policy +sidebar_label: Partial update of Provisioning Policy +hide_title: true +hide_table_of_contents: true +api: eJztXHtz2zYS/yoYXmfS5PTwM4n9z41iK6lzju2T7WY6dqaFSEhCQwE8grSjevzdb3cB8CHRj6SZa5symUkoEljsLnYXv12CuAl0IlKeSa0OomA3yJOIZ+Ik1VfSwD2ppic6luEi6AQZn5pg9yI41XkaChN86ASRMGEqE+wNfc9m0rDByQEzIhZhJq9EvGCWoGFcMfFJmgwosip5Zumz3OAPzt6eHh+d8CycsYQvYs2j3qU6S7kyE53ODQuBzlhAaxExqVg2EyypUksstUyzMBUwMFBU4prxLEvlOIff2YxnbKFzphVwpwTQifKUulbowKAjMREpErqoDA9DrjIvhfnw/SzLErPb70cCxEad9gyXcaKlynqhnvdlpPqRDk0/K6j1p7kEDVbudKXqVtnoJo7+UwbP2VynAljApjRjwOUAOPwoFLuW2Qx132HHozc/D/bfHRx12Onx+Whv6H8BAXfj9PwV3WM8z2Y6ldmCwcyl4r+5TEEfqDwex6AqO589mHwjwhwbggHcBOdGpHtaZeJTNgAKaBQg3u4q54tdO/3Bh1uwloSnfC4ykRqiItFmEg79O4GCB/DLkGmBIXYCz02wm6W5AAbCmZjzYPcmyBYJtc1w1oLbVSsUzJookxGyLj7xeRJjl41wZ/3l2svN7Wh9Z52/fL62vh1tvNza3h5v8Y3NjR0g1shWbvhUnOGwq3ytDo78MT1ptEui1GOX6kCxg0ioDFR6pK87YKZWdjJwkyeJTjN2xVOpc1OnVPir6bHXMKdOvA67noEdcPYrmBwYLkwdjyI7m554x07pnIODpHI6hWZjDXazNxoOzobgohE7P9nHyztHZEMOrkliWEGBXghPwJDRdHiT1NBrUBVvxq/ALxV4Xz4fAw+gK/Bj0+TJYPosEhOQKEKtnVEzngpyfHCruVYVZswutHHCdBmFowqnqYgpEoFCnuzZ4DAIQ52rDH16ImPxpLMaUDIB2sW26ID4lLs+QAYCkY0y0dJUkJqvdR5HRbDC7sXkaFXMCSjnUjmt38/zObnSF/Hs+j7BqVIQmuH2nWZ0F++qEkTNQoU1IS7V8Gjw6vAhEYaKj+OvoXZBhBrVHj5K7XAdWiuyz56YYgSk4Wf1Uu0fnD5CsH1pvpJkkaX0CNGcv8cC3Cm1AXyur9DjYQSdQuyABW6S6nnF1i7VT7D0oRMCCed1E3hWdSKrM4j/C3zQFMVw1QSzqcVW63bB3YEaomkexyhbsDvhsYHYKSAA4OJR9LV+ABfWmuDCqR+vhodDejY4PT14c4Stj4pLS+HnN6Pj85OCTvHTdi1+joZvDk7PhqOy38H+8Ojs4OynsmvlznD/4KykfHR4vPdv7PnD4OjN8OcTYOH98Wgf0VCDMtrVoV0d2tWhXR3+nqsDxC8Kh+cFfr7FPAAhtDDZKx0tcJl4GFGv5IRWRFCJTS9IUXbdQcAfYmqiMqTNkwR4Ikvu/2o0ZFdI5p94iY9X1iqephxzXQlaMpX7evwrOMZKQB9UWDv2LsN4EZXYeMEuRq/32POdtQ0wEmzNqHmZMGZax6YnRTbp6XTan2XzuJ9OQuzxtJZvXECqHnRsaoLZVIpOmkEMRD7hUcOKu6rKwrGdQcFPTCcFplx+OYaVgQZGe6ELsMgQr9yNUCdUD4A5rC97vuWt4/JBjiDw0wOnGEyWwViBTAqmp6hWgFOb8XQqMoY0acFSTMRiLgqv4JMJzI5Vd1YVsoZQ+tWxgcUrHueCdKfE8YRS0mVuy85H4ppV+5fGXeShRXeUAlbPav/NtbWyh39e6VLYl29T3ChIgDH7CEsz7nLTZCZjmYBjVah5K/bE7O/bhoKNYKQFp8ciJtaU2CkrA/jsEu3jMiA8cOmnHH6XS8a9igM+C77eghuSNxS+Q49dZ5ISxupOpIgjctd8PufpAg0nQjRBD5B35HcsplJZREKIgcXSoALdNF9YH3HGbc0z6BMF018LKubgFAuBQcaoRF+dqZizdOBs4GcE2jXOjiWCQtUew29pRoVnOzi8bH3SvMvjTP6IjPlWEEBv8Q+6pUlA2Xa4jbU1/G91elcrefugr2sIUSYPQ2HMBEC5r9JFD0TPxpBZWGo1UpH4K0HKKuWhoHBXTY96V03LXTU2RkuVilMVkrnpQi6Wy0WPYaZyx9tWw5A11mhBbuLLYgeCE6B8NubocrhmKM/lgk01dvDcI8tlAapNq9q0qk2r2rSqTavatKqSVnUCi2Q+J5X5krUZQy229OtgYZ31Fy0gZ3qEBG+b8dMd6RQFct+cYigAkIUHeBYG1hCxI5fm8Z0IzAWdcyUh6WSH+4MTVqK2W4IDEw4wC1HZMkx7KPsr2tYRclYVY4lhZ4fQ+7ubiUxNhmze9r67ibm7/u4mJ1730D5FeouQLNZ59I5/skLszUT4EdgLttcqz07lb/SKq7hXwssA82qStQo6C+nGkIAKrgjB8ehYxYvmTPx1zBGVRIQIwS7BFUDSFN8rKp3VzaH6PrEXVJTsIYpXiQW1Hvs+xvz8Sn+P+ZWvBpcgdIPMv0/GOVLvUurwGDkruc9rtOZ9kUF+YACSUwJXPGxE7YHF/VtNUH8vlpgOD9MUOO2ykcjyFOsP0urJVVwAeET0qlcqYFn+PrhfDx8RSbKno0fM4muI/d1pyqlCIojlEDraqBeh2ulFtyXpp5ra1acZNNFbZ694xEZOvj0njA074UegdRA9zJALDr4LIPHCjxuGFS8EHz9f29nYmjzf4nzj5db6i+3xzoRvbq7tbO/gW+RgDuAegnNTPK4P/UbAOihDFusQZuQ3UAg4IeieGKDBHx/CicYjvci2LcR0/DJ8pY+4+NXeCdt6wWKupjnd59MlJaju+Wkt+cCQAZJbwseAdGVjeuWTk/3h68H54RnlDf85H57CFdJaqVEMlPdHTaB1pq9tdm8FoEyWtpvg6v3MUX0GAkH8rTaU9pdZGFAmc34KPdzoDT2qpO2SXnWl0O5/YN/Lnuh1AB/AvTkVAoucDps/A3Aikqx76DT5jM0gyIr0aY8NokiikDy2RRibI2A5i1IIt7tlkoMrC9rfofMMo5AMl8Jdqcr6bJTx5LA6KegcwPkjqnNhlgNzJGbVCwtrcSy6+QGerebq3J1VlEYqXagMM1vcYgL5sE5T0DCDgMpkZpgLRzhdBgKP8u2KiFUNkxTu3llmbICEeMZz8wi/O4kh/HRJtOLBlXDOR/DSRiOaDT9NLiI5PEKdXatiurzjF2il9d3Wd1vffYzvLj8cuQJnFfqsr0Kfc+V2seHiuQJ9UrIepf1Wt9/syw87kbQnzkGkt+/P3FY6aC8+JR65fiV8ZJfyFeYHxXzY+2P/ysMv/eVcIIOkRyvBBCKRiHaJ75JjUpRV1ebqaJDcjiUYqGqAiJiy0b5ILPSkua2kc9NhkRZGPclcAcmWLSkC4qgq6totji2SbJFkuxq1q9E3sxq1SLL13dZ3/5q+ey+SrO8vcDipsrNA+fo/SssZNGD+VTsrXK7YLFBFK0iMFRgrqCOHYLyxPl6fvAjFVsS3ouebO5ON8PkG336x/mJ9vLXxIqiu9RelHxdOVvepynzbeSQVA4jD9xK5AuMymdZRvfwH6k3FBMMaVdc9bgadg0o/lNhxaxU7HukMZAPCgB3TO8qL56NDpA9D2xegoDf33id1qrOf3yCkpHoqfRHUQscWOrbLT7v8fDPLTwsdW99tffev6bufBR23HoKOW58BHbcYQqwJQqw/EjpGgDsQmk1gUkCGMAf1qqzck+2qj36bg92Z7YFeDUVu7DRsSdWavcNdaA4smVolUpXqwvAGbefYNvVtJW69mUKIVLhvXQK6RauSc4GYFHd5xHIuyY9RIKCbLrqDCW4ptz7j7a0YRaowzoFDCgqxxtorbo6VYE5igvAPKFAddAqB+ivWON1s/a56MBuhxIcoMRt+CoVAny/qv9tNuwQOcEMJhotTO9d3bBewNXPcrqTEp8SGrwKCtlC9hertct8u99/Gct9C9dZ3W9/9a/ruZ0B1h4buhurQ4NFQHdr21liBpV7Ths//N2InV3EckHkzHRJWj0oMTrgCTAkZou9eg/LDN4vXTf/GH7lz2288eKh/U3x7hDuRbZJgec7TGCj5z1hvYCphCm97PJE9/ymT0td0+NHVZkNgwn2oxm/Vj/KQEgt7fBQO0qMJSCXauA2INICdDrfLNijOWLqXvt+xTnvrLZkO7iN29ka3gc0Eko0nhlr33AeVSzKCbOdpfPuQPD9u3ieHJXKHHE3qu3csaM+AyyXxkP0P5alNp4jK7egrZzeVKw2+D9hYGewYm22wV4KndB4WbpH5/u37s6dsiliUYoE9vEtITB7Am07ARCjWDfx2EexEy0+q8+mMGB/UNuSgb7FJDAKzS3UqBLuofKnFRhC1SaXYSVCgwF6PO3ULNNTntX53nqbVZfsSQxR+oUNtnIj2aLKLxMvFK3J9KRP/8NS6llqXqJmnS1xY1V6EdoN3CA6OJHhsSFtfPLil163QwwwL7iDVZR5QE46P+jaq0M/aF/NRo9dFenU+LtX7mYSFtt6N2bjGzIw+zjlg4UxrI/7FGJoOusEFna32xWxd46Bd8ojuxlqFpa4dsiu7ABuJv0NwDGWNiY9x2SbUom0BhVzyF5pZ8Plf6Gu/X2oy0+0LWF2xJR4Q98U844BdHLBrY4Bx/NvFCw0LfBtloDhgDWCvnH+KBI7RSsyztBqjOpHvUx9cGkJglaiYZNf+2C0DnLti9ABbF20gBCPqLjaW4UdQjhZ9kFNVlq8XLGtwld9Yw8K5pDfLb/HWExfTP5u8KPGgLKvgxzhfO0rfEUn+PHH3D4p4baT5FiONw8FYnhyVx84MfcbiT4UozzjxALl+2IfLBFZPswCQhaZMIrlkpOpAFgmuFhCL70DhKUUBAvOQKtmDPBEfVcngN4PFN5HhTAoqPSSCZ4gqO2izek4+DlAaAwskmERoSl8/pqAMDsmijIFej73HT3lDmD7M63DLL1DFD3Jp2FOYQTqIhe17owBwNp/nCo8mACbyOeNgeg9YTiRNmNsA5z5/tgxpgohFL+/taJKoih5lOOncHE+wRg3pb8VAHhgL7MO4AjUosvIJaCnICL8elvaIkjq0f4g2WGV3JuIEM0uIzgDURGWEdwdnKxSBmHJvRfBcH9fJ9LEtnj4Dwltj2OxBPkln5miTQRpcoXvCU/QYf8wRYPyGo3OXreumrNG3R/J+w0fyOkCAmVw/wfIknRRiM0sbxS7cgbpo7ruVs3Ub5cE25TkjENdmYI5I4+YGq1yY997ibQiiWEK5+FCmtRRH/Tf0xbevdxrl9/4j5Kf0nq52WG+jUL4yqxaVUAyXHwXWcgrBMGH/Yi7aA0TaA0TaA0TaA0T+FgeIfH6QLVeG2w/Q2L7YoLhvn7s36V13Srrvf9/5ixiubWf73uSeboSzi1r2yeBs7wdoPXYHSM5tXT7l13AT/90NLuEv/NCJRXvQiO7fBP4tF7SxhH2NoSnFdhew1kGz/wFBhAGE +sidebar_class_name: "patch api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Body

arrayrequired
+ +The JSONPatch payload used to update the schema. + +
  • Array [
    • value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    oneOf
    + +string + +
    + +integer + +
  • Array [
    • anyOf
    + +string + +
    + +integer + +
  • ]
  • ]
+ +The ProvisioningPolicyDto was successfully updated. + +
Schema
    fields object[]
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/update-public-identity-config.api.mdx b/docs/api/v3/update-public-identity-config.api.mdx new file mode 100644 index 000000000..491b5d2df --- /dev/null +++ b/docs/api/v3/update-public-identity-config.api.mdx @@ -0,0 +1,99 @@ +--- +id: update-public-identity-config +sidebar_label: Update the Public Identities Configuration +hide_title: true +hide_table_of_contents: true +api: eJztW21z2zYS/isY3Yc2GVOWZceO/eWGkWVXrWzp9JJMz/G4EAlJaCiAB5J2VE/+++0uQIqU/Na0c9dm1M44IrlY7OuzCxC8r+lYGJ5KrTph7aSWxSFPRT+bRDLohEKlMl22tJrKWW2nlvJZUju5qtnHzD2XImGO5HqnFookMDJGhsBuTOwSls4Fi2lUtGS3MpGTSDCepkZOMnyup4wrJt2EjN9yGXGkSTUz4j+ZSFLG49joW2ESNtWG+UEgkoQN7MMEhoesJUwqpzIgdViLL2IuZyqpMx/4fBKK3cl0znqDc+afXnQuGc/SuTY4oUxoGmlEiFMGPIpAZrjr9zt10NzJ8E6Hy9rJfS2nrZ2kJhM7tUCrFETHRyBl5CTY/TVBI9zXkmAuFhx/pctYgFn05FcRpLV1a52KFPQma2QxyvEmt/GybKx0zlNQBUSclKzKySBkWLQPalByEDDjaqmVYFKRN7SZoWJg0hitJhISvpikJCw3hi83ZB07AeVzAlZ8KcB/a1IU0mYJ+rYqnkzFInnecOPE+m3BY4yjQhT2SSwtf7WyJNBJCJhQJnHEl0zxhdi0BAwsTZsAPzXbmHY0F9W5gEJ8hrCLcFCgM5WaZe3LTg3n+L3syvJV+LZyvsAYFKJ71YT1cyYuLZFyoUNIDQzZ+5rKIvJIHr5Pi/VhLpRNhoDYZRYu2B1PWMQhMXPWaEUw9oJDItQw771UrsnebOy99RqHXvPNqNk4aTZPmm/re42Df9dKEr4jy2+apoi0u7muTvyAdCjLesysq131uKXe9JFQ2QJBz2+1euPL0U2rNxi0u/6o07uE35dnnXMggoft4fCmP+iddbrt1Y1B+1/j9nB04/fh0Xu/a58gH/zV73c7LeIEVy3/ou93zss/b4DZqD3AO+3BqHNWIu6Oh+5J7/Ky3Rr1BjfD1g/tCx9utS9HnVG3fdGmWc5779uDS/+y1b45H/TGfbjVOSWSn0s/S6IXt5zwcKvbOWu3fm512zfDkT9Cor4/HH7oDU5v+j3QATkNejR6MKZ/hr3So2FvPGjh3ZF/bv/egCbt897gZ7oc/gRzDcddnGrQ7vcGo9U1Mnrf6XVzzXM3+K1R573VAeT4yaq2UX98xdB/rsIhsCK4oIsJZU9HvYQlWRxrk0IYYXlw+JOn0qW+A0iaGgg3kwVpZggrVgFdMmWei6epHmEMQUjL8PmsL3AJiCupEhzvvW3wg8Mp56EQB429w+nkQEACBc3G4f7xy3Hlh2zBlWcEDwmGy8CCRsjzqqrYaK4XkOBtoAYmZazJBR6IqTBCBeIJJCoACEmMSGKtEptuzUZjM81dNQeXQDEToYWUbXHdFtdtcd0W121x3RbXbXF9rLgePFRPW5EEUtY2BmDag8Uy2FiBL6R1Vb6ynsCyFpfAUt3ySP6xolvN+5CKbkuHL7DkmVTCmxkuUUJBIgcwkOGqX4YwAiDJgIWJZR5tRFc1Lliivsfe8TDfHMDdCVIGLWl48Al4dV4QPGMlYTzLh4Avqdw9Mq04Enxy2DhuHkwPDzhvvj3YO3ozOZ7y/f3G8ZtjCqkFNBF89oIG4FwoYWTAIh2AR34Dg0CEge1JAJr8qfpd9QHxeGGFtLSFmk5elorP6Q7j7F2rzw6OoD6oWUb3+WzNCMobDzeqAWhuGfeMnEn1VCE4bZ/5OVY5gEReD2GPVCGGJYgKsTAHKElXCmD5TEQE5oDKyV47rq9BIa6SMqG0V8kyAWNCbE15FqUwws3+wIgyazY1elFJJcqbzyn7XtZFfQdaNKykPA3mbMKxj9IWAV/j9lWcel1nyddsDggizKs688NQopI8YpCNwBTGL6nXC0NMXctgmiFcEqjqLGVKpzJYQ8+VKTdaEgcn3bJTMDlA8ufjxAekBuFIzXIWFtHiRHT+AZmt5dYhcGU0MulSpTwALaBbXYIZjQELM+izqJ90cITuSgB4VE5XIFYZJQnuLqwwUC/oWcCz5AV5148AfjxSrXhwK1zyUaNv0Yi8kbvJIRI8pPqHgx1V4a488Rl0VFG4zd1t7m5z94W5u/5w4HYR3FNqffY2W5+xcrv7WDw3Wh9D0aN0/grgN9vCWkfuwAI5b5F+/DBy7w6AXnyOcdf/T+yPbCnfEN4v/GHvT7D9KJxV8QUKSHa0GkwBiUR4QnKvJCZDWVPtb852ps1EQoCqB1pE3DdgS50xDiYzmVIoCU92WKhFor5L2ZwDPtrtEYuAOKsKvVhLlW47yW0nua1G22r07VSjbSe5zd1t7v49c/fJTrKQirLF9UlJtlhws3R7nfY5nVVhQMDy91msSDly1Xq3gsxY0WPVqp1DbdLcm+xNjwJxEPKD8HD/eNoMDpv8zdHe0d7koHlUK9f6q1UeF0lWzamSv60fycTQxN1CH5cpCK4k1Tqsbv+BeY2YIqzRq6y8bwabg0mvi96xefzAuwOt2QVXy9VBnHIPqVY2QkzT+BIJaE1OCwSczQAXFQOokiAXhpJcCOBiIGhYJBeSkhe1AL5m6fnTFFSxiZIHWTGLVEGUgYSEBJHGrllDYElQUkyx5wMO1MHOAJ3/xO7UuegPdfJsgBp3UWPW/mzff7Kic3/z0P5uB4Q3iBFD6+BHNnrtaocrCABYEFjMKvrObX++7c+3NX5b47+NGr/tz7e5u83dv2fu/o7+3HVDj/fnQPDi/hxo6w1W9FJnGFz/8zadUsVJQOHNdBBkhrab8x6c+goIJRQozghDeDqHi117UM2TxZk0L8gP7dve30qVmQio52kaJye7u/fgLHDSlzqPZT0/qKD0XT3Qi93b/QegB88IuMP8RodZQFvOfr/jFhh1MrGRGMUW8mgCa3BSCuMVDE+bw0/yz89PLHUGIEdsdvBoiYsoug1ixrCc+C5xx8zQQBs6gm5jE315Tp/3+0/pYZk8osdD5ntyLqBnIOWaeij+NboLvA6MyF9jkKdlscrP0NNX12WaIfbmVsINylW9wfVcc0OgHpI12TvBDSwc7CuO73/8MHrFZtiREiJkCTbDQuISAnKqD2FEiOfn2/04iIqQ0dlsTsr5lRcqmGFsGoFR2Ec1FIJdlc/+DAC7yew4SBBc4Kjr73PvheJWRFgl6ytrY3DKUO2CFXd5Zdwrqoi0dJDKnpXDw2oflcdOJQKVxMqONE5FWgmyqzjXi5f0+loh/pFz8yw3j7glr9aksKa9CuwBnQDSHFnwKCFrffXklp9X4ofrLLiDXNdlQEs4OaqvwYLca18tR4Wfh/yqcnxUH+YSym11GLPoxhKollHIOiyYa52IfzKGoYOpcjXLINO+Wqw7nNSjjPCajZJInp3Skx40jyRfFxJD2WDiEyze1LtoaOtUaNP2F/Is4MIv9PHRLxWd6fYV1FikDHWQfLXMOKGHE3oWJxInvy1hGFiQ26gD4YANgNbK/4QETtASLlpeDyI/sd+lMVg+AhCVuCTxib04WYGg+8XoAVIXNADT2HsXLwbxELLjhXWsYqx812DdgpvyRhrK55rdrLzFrhWW1L+avqixv9pc6alo+Wej9CNI8tfB3f8T4m2R5ltEGtcN4yblYPVpZjtft1Q/trhyXxwUHw3kZ3tXp/2vy2f4Hz9Iv36O3iVv6ZyypPHPnS4uBNg8CIwZRKzXDgRj3tomdXP3ErfX5wL+wlMCH1pJwDrNfvC6fuQ6jniKaUowFcyloH2PWPAUG94dTBWQCqEFunzEM1jdEqOZARrAoQSacD6REZ5rZh9gYanAsgYXlXhSBLj+qt3qcgiB08e4Y6d5LEJPuFhkCg9lgxDZgnGI+GcCFswTZBZXYV2jRK6Zps60GJWDDGYCmoK+UxBmkfSmuEEOa+9SXD4zF4Rl4nbHwZD0YYd12UqRgYgocZCuuup4jjckgzcXUYzLWigK0B+K0gwXndEGR2CmEtArEHVtZrtuULKLtMAEV3g2GPbrsJjFW7FOUliDl/jaj7HJL499we0+8FgPsfvVW4Jv5pNul7u4YtqNcTMQjZbZVZ5dVl/VHl1WA17Mwb5Ic3+Pe0a4xvyCt0F23JC4ul4tIWnZBgNo76gER+5lhUcfNBSbE5tvYXBVa0fY/agnaa9LewT9MQbSxH20vrC7HYbfwU38e1L7CP/DhY5tGAMR3b+v5XuHQGPZ4n//Bcw9Nl0= +sidebar_class_name: "put api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +
  • Array [
  • ]
    • modifiedBy objectnullable
    + +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. + +
  • Array [
  • ]
    • modifiedBy objectnullable
    + +The identity who last modified this configuration. + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/update-scheduled-search.api.mdx b/docs/api/v3/update-scheduled-search.api.mdx new file mode 100644 index 000000000..a843abf59 --- /dev/null +++ b/docs/api/v3/update-scheduled-search.api.mdx @@ -0,0 +1,160 @@ +--- +id: update-scheduled-search +sidebar_label: Update an existing Scheduled Search +hide_title: true +hide_table_of_contents: true +api: eJztXetT4zgS/1dUvg87M4VDXoTHl6sMMLvZY4CFcFO7QB2KrSTacSyvH0CW4n+/7pb8ShwCzN7tzK5nCohtqdVqdf+61ZKcByvmk8jau7TOnalwE0+47Fzw0Jla1xuWKyInlEEslW/tWReBy2MRMe4zcS+jWPoTFmW1IqrVuPKtDUsFIuRYa+BCvYTqZfQN+Q0r4CGfiViE2P6DJbGNgMf4yIcHcCVda5GJwQFTYxZPBQvFb4mIYmjaVU4yE37cgNLI0Ixbew9WPA+QRhSHwKj1uGFhBRkKYCkOE7FhiXs+Czws03Z2WzvNna3ejrPV3nV6zRZ8cnhvvNt0Wp1Wx3q81tWhvffKnSP5MltDYGhRFixWDAQRgaiQM0f5MTCJdXkQeNIhCW3+GiGBh2XG1ehX4cRQkXveyZhEtPgkCFHSsRQR1gNpPY+vwQHyU5ZPURxNV3R7za2uPRa7Tbvb6XJ7tNMVttMbdTpbu27T6XUtFAh3T3xvruUJAlZ3vgireaBH6cgtMrREa2NNT/XTxSFeVBVsF0tgs5oQGwlU2lCMRSh8R6B6CT+Zof4PDg6Ph4Phz6j3uSiyu9A9Ld/1bRZVNG2IZT1Z0rredq/ddUbudrO13eu23R0H/rfGvW3rsaS0l7pp4uM6lfZgxZjnPCyNPtUDO73yTz3BI8ES+MGSN9K9YdLXn6nUTSo36YOhcVdb92rFWduj5YF2RRAKMIXULB+h0+sUXaNDVbfxyaqOr2P+gEtvzlwZ8RFW4o6jEj+OEI0Sz8ObmaKXGq7io3DnZeyUm3oOe6gksYypzALGHqOc1osz4rdpjWeoExbOAG7KY3YnPQ8MC3yCcBIYx6exZWurO25ttVr2uMlbdne727X5qNW1t3Z3t1pdtyO2th00NgcUhZTiYRn/VkprrMIZB4S10OHYsZyJsno2Wzt2s2e3t4bt5l67vdfeabSa3V+WrLjPMgJoEIPzE3sHnAIz9HOBH0CxITbzuOQtSQ3gcbUR3vEIKMtYQufmzHS2UQWqM+XKsfzWJeHxKF4jjrSjlVJIa1T5x9UeD1jWjMKjxkovUq5/CP4AgBtQKQJvje4COXaSEIA8hrGKkiBQIYYdWStIKCJE7buuRDrcY7fcg3CBzfgcjYO7LtQw4DpO4iQUYDjxVCUx81UsHbECnox3OugPjn6G60+Hh/+iDx9Pjoc/0Kf9/tHh8UH/DD72j48v+kdHCz4sq7MIE0NsjFTMj6dRpYKtccCvFp3wgKwKC6I7GpwPmU013mnZvWM8DEF8GDhx8EBM+QDuISgKCM+lABRcky5LJM76x98frqER3ylTZU+rYszDGEJalwn4Sf029ydiA4bL8ZJI3or/7dhiz+GSuC+PnHmSjZuRWjpumo0VQR+VBb4y+eQckEgwkIjFLKoMlTMWLlHRSO8OKOiQEMOGQJLc8ALmPMFEWg1xg+lhSlWgzBoWnEAQWUAwuNVpF9GrsyIuMuK4XhYYOcFl9rTeY5hufJfWCO2e2XAqUeVAbylcF1QwtfmIRpjxLMC8SW3vRvcn4zaTrhnMdNAurQ5c9eBnF35abRLvQqSBt1w+r02zNs2/mWmi1q8wTBzwARgckob5SsRutIO72aBSRgHSqPQGhARPboYXh/gHhEVXP1zgnw9nA/xz3h/CH1S0m/OL45uKFoy3vUEdzy29skHOQHdGMNkFrXNVAoPAfktULKIN5snPwNCV1bqysFn40KRPSPTKau/ARYOxk0Crsjcv0McCR/CcOdzHVmDO5qJ8aIaJH+I8yJqntkL49mw4yrVpwwLBrMIjsJ2wBqQakP5mgERqnzHZqDQpPSpFmyLXvoPN5MIAlq5JbIHUSdKqrNJXNJ/DezPxCxjUquwAYJLypQNDNvyFSRftGSZyYWmqp/ExTHxs9o24b7D+TIRQafNY3P3nZxV+fgvYB6jrA5ZBe7+jAQP0RoFwaFqowVCFk+8i5ooxT7y4VBARsVEhudWpiJSB/Sn8nqhV6TYNeNfL0yedU3ZkIAUmYpZE0wfAB0AGnNAyiSmGxJRJBDQ9F+DPEYAY1VNiwEbAP3YrORMzLr3Gepuss6WrsqVobz4lzpaHaeC7mIuHsZErMqagXaZ2CX9GSnmC+9Qr0kdrb8y9qJi1o2tsHEfwcBbE8zMRQckKbSmxQeXZRPhmHSXVGOWAh2R3U+HnagI+BHyVj7EAkX4tj+AlA4/Pf0pEOD8Q4AG9dVyisAyPICzNs2GU3KGrVfs3pEhuM+OZGGXg/G+luGNv7sACp+B3izVPB4O3r+vKgh6U05uFVFLJekueAMvmVn5dpkeLUnqpI0/CV8BDutD1WGbIJLRABoHyI22h7WazGlnN8lEh2ZSlj+sVpXpFqV5RqleU6hWlekWpXlGqV5TqFaU6S1RnieoVpXpFqTbN2jTrFaV6RakGpBqQvmJAqleU6hWlekXpW82W1itK9YrSn7iiBBx1qxaN9j1snB2GIbg6m53RWKILLJ2ZYiPlzlEJpQ8ORLpftJhUhgaXxnlfuc8AiA/SF/YkhMgIB5tYdqAijKK6lS4ihQ62iGRq01Su5C1REo0We89d6K/u377pDLqakDufgdbgGehx4Uuoz9IqgLIUMqxoVmwLPuo1d9vdca/LeXun29reGu2OeafT3N3a3aVEmIgiPimiZoa15aa/R62XDvMUeD35u0As5yB7YoAafz48E41nArQum3XT8MticR/DBIa93z9l3W2YB/iThO7zyYIQfPvivGpFQxM+CeVEVsYjWR7y8EP/4ohC0MOfLg4x5ERaSznfPvp5ggpFy35TdaenKLoDmO/NYin2zlB9Bx3iGHfnBaW+iuYRCDP1+1DDtF5Ro0iajUM1K5kS2c19zN7IhmhsgIeDexD4APqMOE6plI7M3/UdRwSxfWQk+Y5NBXdFCDHKl4T25fWmTJRLIYtBkqPioKBxAOfr9aTvxAkwR90sWmGmLYZFMz7As5ZcmbthQWgk0jlMipwYozxcsFAwT8MIAfomAckNHFHABsDjp+UyxCquUhHcfdTMHMQ67nJ4Ej3D7k49gB+bupY9uBXG+ChhoNGIRiMdJoNIZpJMlU2pbLhSw2cQaXpubbu17da2+0zbXXx4ZrbKmKcU+rSWQ58Lnycg35Cc51LoE5L2QEybFtJRsB5ISpiZEOnHT0Mw7M8QD2OQjlNq8UfGR9qVV8zs0vHQ90dp/ip1/flYIIMkR92DMSCRcPeI75xjEpQWVWe5tQ8qHElQUL8iRATUDNlcJYyDyGB27SMnPNpgrhKR/13MphD94mYB4FcjIE1mXDtQ0v+yg+51JFlHkrU3qr3RV+WN6kiytt3adr9N230yksy4ImsxcVKUzGY8nGtNM8+xt5xBAZZu2s6zyTRUi9EKEmNZjGWVIwdr1G6NWuNtR3Rd3nV7nd1x2+m1+dZ2a7s16rZxS2vu6y9zO86MrGxThfHW42jWvsJbiOMSH5QripVyy+k/EG8oxghrCD1Z3AwyB5Fe57Fjdzl2PFYx9A0IQ+wYrkgvXpwd6dy7Jo9yU0no0PqpWQmgVQsMKVGH9fuk6tCxDh1r91O7n7+M+6lDx9p2a9v9Nm33RaFjd13o2H1B6NhlGGKNMcT6M0NHF+IODM3GMCjQB7OPLt9gZ7KPxuxjHk5EnAV6pSiyvVuxyUcp9pH78zRYikqZSD8XF8IblJ1h2TAtCwU4mwBE+nhCUiq9dQ53IEFMikdCPDmTZMfYIaAbzu3+OIZeaZtJ9S1rxWwRiAgUPIW5VwU6JnHHyhjDP6BAedAJAPUfmOM0o/VF+WB2hj0+wh6zw3tHCLT5LP+7VbVLYIBbxxAuzvVYr9guoHPm3IdphLgPNHxlIWgdqteheu3ua3f/13D3dahe225tu9+m7b4gVDfR0OpQHQo8O1SHso0my2KpD7SD9P8dsZOpGA70Fnba0UubFtIYnOIKUCVkKEgIQ/A1+3vWZrYx2dYbaUW0+SDdRyihZwGaqST0oPA0joNob3PzAcYKxuixwQPZMPvQ5766azhqtnnbqUAe3GiqrQywy00cmjn0TwdmqtEgCYcSlVgjHjWg5W325VoRyJ12GDxJP31bwxxmIUyT2cA96Eah6DawGcBs4ruISjcs/X6IhT5C3y5C73Fdf/7deaofmsiKflSJ78m2oDwDLhe6h+xf43DBoAMhGq8L4GdfQ1U/wYG+vC6Wwe3EM83hUsnc3eCiQHuJoRMs1mbvQVvolBjuk3nz46fh28K27STCWFhInEGASZ2CGhHg9dM9I1iJfFCoksmUOtcv7cpBA2NjD4TCrvxzIdjlwAjqGDzBGUA3iR0rCUILrHX9Jh09V9wKD51kI5c2Kqd0/U2Q4iYv1XtLDpFmDsXD/Ve+zQ4k4pREx45l0t3zOBFkl0HaL17o12uZ+EdKzdbUbKIWvV3gQov20tG7vB2wciTBvYik9erGNT27QA+nWXAHqS7ygJIwfJT3UjnpqL2ajxI9G+mV+bjyP9G+/nI1psEtPSgwYM5UqUj8kzFUHTSVy0kClvZqtugwgU0WYbebBZZs3aQtbYgdib8jMAxfKxMfoe+m0EXpLAqZ7Q2NLODCjT4fWuoz3b4EF4slXeVEr+YZG7SxQVvjRGT41x4MFQtsG/tAOKAVYD8ff0ICw2gBFzWtSuQn8ptUB92HA6zqd8EEe/piLwfB9LQVPcDSWRmAaQy9s91lcM0MLXRjJWGlSYNFCS7z6ynwngty0/xmS5/oUb+2/mKP+3luBV9f8kej9Aok+Xpw909CvBpp/opIY4JhzFGe5d/mdJgfuzXfO7X6xV1lO1tdbuENWM97SVXlS4myd+3k79R5wes/0nd9vOSIfnYe/4WHkMsnkJ86QVw8/rt8aLZ8BjZ/G0B2FlQfBX3G+c3rwiHN9GTf8rlJ86TytGJ6lBERikRiJppFXNSTgOXksH4JHvyGpwTuJCyYBus3vWDYWyQDjccIg+QGnKkUlFYKBI+xBxsIRWpG0A2zKPQX6StjJvSurxB0nHt8JD2g12CfYN7ugzqGOGfH7dxA9VdlJu/n0LlTtGt2kNo6xNyzWeJDXYTlZMY4IMoaQACJOYn2WzCF90XaM0WRf1YrBXFEGhQFnTsW4Sw6GeP6g3REwe7XtAVmH5nFBxBk0WSzjpwJj1QQy5VndetoA9jYU+EFqILgdCH+LoLCx8FwiSIQ882Klwonm6ZStIll8RUJ+PpOUoZOo9lo4q1ARfGM+wW6+mv1St+qt/RdfEsvCMxWX17wrXzGjHCytxlgGhP5SfQEVScELq3lhABU3JN0HHUKrGOZhwfMduH0+BFv02FcnGPms1+y2hQWcwNb1YU3Z+Yw7Fu27uv9KvuQJmz9eZ6rseDjZ4EpHmBev2aEcnDEmn5gFn3sYeEFDkhmcTUL0wO6hs7rPVn2upBrOb1AjRmZLwyc6axRyO/gJv7es67gv4Vfl6j1FQrR/QcrzcFCGU0W//0X/7UdNw== +sidebar_class_name: "put api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; + +

Update an existing Scheduled Search

+ + + + + +Updates an existing scheduled search. + + +## Request + +

Path Parameters

Body

required
+ +The scheduled search to persist. + +
    owner object
    + +The owner of the scheduled search + +
    schedule objectrequired
    + +The schedule information. + +
    months objectnullable
    + +The months to execute the search. This only applies to schedules with a type of `ANNUALLY`. + + +
    days objectnullable
    + +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` or `ANNUALLY`, 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 objectrequired
    + +The hours selected. + +
    recipients object[]required
    + +A list of identities that should receive the scheduled search report via email. + +
  • Array [
  • ]
+ +The persisted scheduled search. + +
Schema
    owner object
    + +The owner of the scheduled search + +
    schedule objectrequired
    + +The schedule information. + +
    months objectnullable
    + +The months to execute the search. This only applies to schedules with a type of `ANNUALLY`. + + +
    days objectnullable
    + +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` or `ANNUALLY`, 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 objectrequired
    + +The hours selected. + +
    recipients object[]required
    + +A list of identities that should receive the scheduled search report via email. + +
  • Array [
  • ]
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/update-source-schema.api.mdx b/docs/api/v3/update-source-schema.api.mdx new file mode 100644 index 000000000..77ed90f87 --- /dev/null +++ b/docs/api/v3/update-source-schema.api.mdx @@ -0,0 +1,156 @@ +--- +id: update-source-schema +sidebar_label: Update Source Schema (Partial) +hide_title: true +hide_table_of_contents: true +api: eJztPWt3GjuSf0WH/TBJFrDBr5gve4hNHO7YxgM42bt2ji26BfRNP9h+2GF8+O9bD6lfYGN7vTNzs+RDDN1SqapUL1VJ4qESzFQoYyfwu3alVUlmtozVIEhCSw2sqfJkpVqJ5SSqtK4q/DiqfK9WbBVZoTPDftDrMlIinjqRaF90RRyISLnKip075c4FQxTSF+qnE8WOPxEMWCQRfpHit0Hv/ELG1lTM5NwNpF0X1/61P5wqMQ5cN7jHZhH3GTvKtSMhQyUcz0tiOXIRti0s6ftBLEZKD2i3EEZNODb+70tP4V8rVPgOP3qB7QA0G5vBYID0vYM4AKLSsoLEj4WM49AZJYA90CTFJAySmVB+7MSu8uBvVcyDRPhK2dhgKu+QC3mkHV/MXGkpjcutE3Wy3i0Rh4m6xRdnSRQLW40dH4hJSQ1CAsfDIo1X0raFE+Ng+CKi6fj+bhrHs6i1tWUrYDhOZz2SjjsLHD+uW4G35dj+lpw5W3c7W0x/jXvWeKD3wDQYSzMO0UbggOsJDnwrxq6c1IX4DOion9KbuaoqpgonIOKWE263zLVQjaGdb/E0a7LiqTS0Rhl9wKHb29s/ogAY9XDtC/h3XaFZq7TgE7WJritV8yqez/SrwbDfPT/JveJx8KUGVO5x1Ds/7xwNe/2bwdGXzlk77csNQWKoWdM6bHzc/vjxYP+gMR5/tLYb8Gm0i9+sA3t/u9SthOx1hV8uUrxyKsPthob4qCrCwAV2qNiqM4MM61TKVhaDYPQHaFaeE050lrixgyBRnnLPc7K24u0JY8nPr/0FTcC1D+o+kyHQEqsQlf6h4qCGz2Q8hVdIJHxj+QGDUa2E6r8TJ1RgOwi+5n6l9UAMx7YgDf6ksijbDKSeDQroaB0gaeGCV5rzO3t247AhP+5vN/bs5sfdvb3RrmzuNA8B2Gq0aGxC6wk0yhivQIsl9eVofWfoKoo/BfYcR18/2JL1A7vIBkVbTlJ1wgjRsQI/hglF2HI2cx2LbPcWak5thmD+HT/i6yUWyDCUcwDhxMqLcs9Zpipl5No51HrGSQgZaeW1xWgurvqfj8T+4XZT1Ki1oOaZSYqDwI3qjorH9SCcbE1jz90Kxxb2eF8QnivwQyR6MJ/AxVmIdix2FOEJr5YmchUrU1eG3ANPAF/BsHkKBUL5iYfDgAmlgb3gTtEHMtDwST+wghnyKIY5RESy2TctFxrLtRi1Bb/QjEFzrEJQ7FmoInQi2tDGMpyoWCBMcjPgJ1lnNRFyPIbZYXbHeSILsrmVHxtQvJNuooh3vuqNSY/L2Gadz9W9yPcH8tFw5LUm7Y5UTFSY77+zvZ31MO9zXVL5Mm3SBykIEGbjNWjGtULPpo7rzCqLRQ6akWIDjL8vlmISFAjiguYjaZXxqSkTwfJqGaR31ygf1xXyttdmyuF72j56knGAZ4rXb6CGpA2p7tBr3ZmohLFqKd2ksonnyXCOwgOeHiORfASCiCtALBjTRxeiqUo601esJlq+WUIrWxlXt2qVnFRo/rqBZURJc5e9ac6A+onrllnbAQqCuQIUsv7aDVVaY+lGqlp0P7mn5Hb098Xi+wL/oRpGM2Aus6W5vY1/HrXL92CDosSCSDQaA3YmxLTXmMeVNjEVxaLFceznWRwnnY1BaqFf5Mf0TDxnLGz51Gg6UGCgGHz3iLYhAX7pAMwXgZ0E2lN6jUBFNI/Af3CUkrmmzK5FRaxgaYDGADhKgfO8nZf3l+GUKYPxkJZ0rcQ1TjLxHfC9gkeC0D4klQYt0sQ4fsmXZlhG7bM2s+8c5wODFScC5f+/RFePoI3Us1G1eRGVONFU2QbbKVArQ2v6NvjeT4NIG88om1gRQKvQRKCIohTpuHXR80ETQ/Bdd5J9FwesTEJJKDzljVQIfgkFw7fcxFYXKvScKCITm6E+gvhBSX8J98+wJgEMbNJvcKT3U8XIhQJXgUiOhotBgAEsYIU3zYs3mA2JfYGUySRUk2z5s4LzbLKqlTEsoZJQRc+IrDJfq6OP9uXwS+d82D1qDzvw+Kh3dtEbdOnzcbcPi5Kbi07/rDsYdHvnA3o4OOp97ZiVCjzpnLc/nWL7s/Z5+wTenPZ6f728gAfnvZt++/y4d3bTPjrqDLD7Rb/3n7/D30Gn3T/6Ah+GnbOLUx778vy0d/RX+gBG//JoeNnvHN8M2/2TzhD7Dr60+52LXvd8qB8yvK9dxI19xEm/d3lxU3o4+P38qPzsoj0YfOv1j5Hky34fOHCTewTo9i7hUe/89Pebfudvl50BDtY+Pu4OAUT79Ma0yF4Cse2Tk37npI1NDC6Dmy/tr52bs87Zp05/wM1yDC2jBW81CU+2WcWgFc2WJ3CJDf3OZ5ixy8vu8XIOpUcfpCuMfLGJtcAoQPQSJbNZEOowEB7xCqx+7X8QeZlqiWGaGDB9Iogto6gWT0EfJ1MhE5BvMJDsGQlCKoaru1uBNwsikG3zhrIIpvMy2auhhAqo8lG/jiHcsuKcwms4BVFfDQSMnwVxephlhCKynGBhw4iiNl5QE0RWlUeQkTYlaMb5fI8DK3AfM0o2GhIYiz4TrKK2rUbODYIfCBSsnid9OSGUKMcxp4QVLOdxGIXBJlnPsQLoAArG1bmUYKY5DTa5rM+ER/lhARM7AKlB+6dREiFwJPCQPoiViD2UcFExhwbv3gtY508DG+KpaZC4ttApNHBUyATsoH7OePkBFl2vpwgRMi2F0VFSYRogRACipYCA6udcuzX2HFpmxTcyuEaGxTRrXhUwMMib78OY0BPxiICZYMa16QaN0N2Qo8BJkiVET4s3EpgBMPE+I5NTGraI+MmYRPzMNvEx+X1EZCAI/sESk/j8uc6wlq3GOs1IfPAYiYXqb4shLQxZlJeM8SsgsbdDjgymwDxakNZFNwbWAtNh1sFpOcjxOQcsYGjax1Vxety+0ANFZuZTo7YkACOYamIVCc99iLKseRXVxRd5xw4W2KbNnHDAuzrG2um5unPQLqTiiVzGZrSWQJUBpMEZB/Ba+ronCwLLuF5R5xw/okY9Rjn4qIZjVk9tZZl/2siaiEDbuWVn9yzitT16K9JJGMoedgmRFE7KewjbfQtUxA+SyJ3zPGoP/ERvdBz3QWgLayr9Ccy/GDiYk9TiQK19dUdpDaDaNI+qTKeT2pUAg0OzCAfbBxr6R+JblKtJg7I8SYZH7J9KMUNLDAIvRRljrSg1eegcxtq5mcjWSsIQA1iDH3nNFUHHY0pFGT1KYhtuIs5BEueLAawcjwct64HbtqNDgFRjtMnPhTot0U4JJ7kv2/yVclsMjAqoeIGtwMhytM6BeTR1ZjpYlvpRbnWgl4P5fDQ4GrLwgJFvCiXRchdjNLmT9nyK8lvs/lJJT6cPcAOjlZYWSrQ9Ed61RJeXB3n9ynsWKhdloq7tB/qLZfNBXiy1YuS/lsMeUvpVMszlKr2KqmIBx8HAIEo88lurcGNjtYRdDifNPWNKdLCiaSXgM87XUm0M9C7K9TZip1NjMDSojXbyoCA/BC1kimRrfj8dML851435/H/F81wM+5zlR4vR0tlm48118pJ82dp5I5Sf0CaDy5o1zj8Ck0IiobSeNrlXrit95nlaXXoqrrJyiSxjmgsDXZWXvk8vLFctRr8vKDs5diaJTgevrcB8CajW7c8hCo9DKQrdOZwrY+/JucloFwh44KrkGRnzXJJIp2IoNV1MwZdSG8sczMw7FYTId4HXmDrWFKXYK+VRHq06FTOvr8uHprisS+vFOhu6DI5TnU+CS5Pjj6V30ganPfoD8Tr8/6nXO+20z3HJbwQ0nYHjlHWUp13kK5flclJWEzYbAHjOtXc1UUFQyubpPJ4nZ/CunmH/yASs55D2+SOFSp4iZT/Bl3LFvVhZW3pL6eJnlvwYl+4xR5y5svlMx9bBypz83v5Ha695aO1vN+CTJffHh9tWY6ex87Kc/DSBlX4Ng1/aiGJSusuZ9CISpItU1irCXF9SLA+YvV4nu+0zoXVBGGVIazZvkW/NBA7mwUO4NZI8ezmJitDHEppkSdVSuejNEcKyajbAM1HStaq3RSYrlJhIuY57nRxeTZmF0i3tDcL1aXHT0C0Rg4GKbvHhAzjMDx9wEN6Sk260MWV6kwPJBKN+7a9nwOJJa1VZ5L1jWlAsGdzlsqIWua8kGS8rFlbTUdLyweNly3TOlowL25a1u3uyXSVaWcuTflJaMC0Txzs+SrSZh5o0/Lqg0IB3pj3P7KT7QnIVUQ0ARRu9r4yxVoSbvWKHZiJnArcbh7VGs9bcHTabrZ1ma+9jvbG9+19Io9kV93o8XAkxrgHzAmx2GsPmdgsQahpschKotyJysXh3VX34CKw9mLZOGIK410TfZHI4w5MG36PAnlNOxQfj5LxlydhWsXTcI1hNr+fdZ1DM2iSUpJ+KULYCW+d/KMvo4YY8BmkMO7UrGnXgRL0hPkkb6GX6jjQxyLtQWpiP7j5jMi+5dGq6YF3bmI0Vw6oDJUf724fN3fH+rpTNj7uNg73R4Vju7Gwf7h1SXdtTUSQnzwglT5SvQseivQSu83dgCAgy8J4QoMGfHzwSjGe6bm6bkqnxFTGE2lUwop+OLsTuAUizP0nouZyUmODXLrHEhBsk0BdrXa5qJHqhM3FWunQTFB13PrcvTzFATMtaCGupMNT2jW8BVEEWpsE97/9gAmg3BO23xczoBw31Q5obTRvqEoOu32trDz306Ct65EGLcRh4BVUivfkZi3dOXdWr4LRQ72m32Ehimk+HpR/AIahZXDvVnPwgphC9qPB9XbSzjFcapJL3k7bNeULaTpvQatuk3MCjOlYpuMlYWZyNzICc5icFlQMwf0a8ZcUJIEdk5rUwlRaNop4fwJk5V8RumGMasXTux9KKda7dCkLKM4B/FQ5V20iDKXkKhsc37VKLlbeLZO7OGJnjOKB3nHlYq3cXLpifGpGWvrhTWvkiKveQNVL5xKS2SHqNQZ11q3S6jOLzVu2N7m50d6O7z9Td8su+3hWn31Lo01gOfS59rOkHITnPpdCHVwV+IEwjzh7xRFZxjaJDpN++DUGxfyif6uA/Z7gp8g3jI3blK9IaZj74+cjswDGuP5sLRJD4yBSMwRIpu0V4ZxgTo5hVO8ujfQ7CkQMC6q8IEXEPAR3ooMpy4lMdVUZVKrH4f4n5gIeupZMFpP0Cdo1PWmwiyU0kufFGG2/0y3ijTSS50d2N7v45dffJSLJ4CEXHSbmjJ74554nUSgENhDmfIVKVS4+S5KMVBCbSGKtSjBwqo2Zj1BgfWGrXlrv2/s7huGntN+XeQeOgMdptHlTyvv4q0+NUyYo6lZtvnkdiMe1AxK14IFxRHAR2Mf2X0NFKKs3HWUgMcwcBnD6NQrHj7nLseB7EQBsAhtgxfCS9eNk/5RoUg0e+cVUuCNMjFYVdO3QmehM6bkLHjfvZuJ9fxv1sQseN7m5098+puy8KHXfXhY67LwgddwWGWGMMsf6ZoaPt8DmYMUwK0GA2j6f7NnT2Uau93rdqAr1CFNk8XLGRKgjEGW7p08FSVMhE+hm70LxBWw/bhqYtHRuagIn0cWepE/DxY8dTGJNiMd51PCfmU0UK4YbzWnuM9w6wzhh5S0fRpyQjMgpugLnXAGTMic2lMACB8qATMNRvmOPUs/W/ygeLPlJ8ihSLzk9LKdT5NP+7t2qXQBePX6G5GPBcP7JdIDR7hhI/Pf+UhqCbUH0Tqm/c/cbd/xrufhOqb3R3o7t/Tt19Qaiuo6HHQ3Vo8OxQHdrWt0UaS32mbcP/6IidVEVjQOItAotidTuLwSmuwGO0FboqzsK74szVSPoM69aDucxusaVvFIBH+iK5BbTnVQEjmYQudDWXmz3A3MGcLepy5tTN/TZ+cE+XLt7trLBE2UF/sGV2wudf8c5MHqROHA8dOlVGEksDMP/15uxKerfjk/DNCYQ5ECcYTDV3wJse470OsLr4S0St6/qarRKNQNtl6C7W0fN15yk6GMgjdKxi35NjQXsBWJbIQ/S/43SBEAAgmi+8fOiITVc7wWm/+p5vQ7uKGcOllpn7wSJBcwmhHjZrik9KhnjwlfbNvPvt2/C9mGCASgaCLzhVDq4oQMUuQIzIALbNHhLsRD4pu7ugXdilgwonxi4wRVz7A6XEVVcz6hw8Qx9MObG9XbjT4/k3ghbvAnlPDpJWEo7Pu7b5oG1NX9mRncpkEvlez6uZoUvm6HotEv9moNUYWo2gRe9LWDBrryze9W2B1iMI6UbErVcPzvBqOXi47IInCLWMA188QngU91ZZZtZejUcBXg3hFfG49r/RObtiN3NngD503xXWNAgi9R9CoOigqlxNEtC0V6NFh/tqpBG15nYOpRoPWXNqEEsSfqegGD4LkxyhL6dQJuCsCqntLc0s2IVbOvN5W6CZHl+By8WWdmBFr8YZB6zhgDW2E5HGnz0aChboNtJAdoAF4Cibf7IEGtGcXWRYKy0/gd+iPug+LECVoESzFn9pZUZQfxL0AlunbcBMV+hON73bDC9G0bDorGaeWSaJUObgMr5uAN60xDfGNy2Foof9V6MXKW5nuRa8auytrfQjluRfx+7+kyzextL8ipZGB8eYs+xnFxZ3cgf66DLR7HZcEzUXr4nVy4Ple1C/471+44BI0iuUvAJxtLicVaRr5BX8D2/JClCED+un7JKYPBhALuaT5mAvrKmjKB8xU5Kuha+izAYe6TiE22hYlL7VZEJn5UJghoQVpOMCvLr4pm/oCnGxh/uAAeofgV71DWAG6cYkcWyEAoIzz0t86Iv6m3hCguitkRy8vyxhA6fvnmCE+IKstJfRdhRJZAWd2lahF/XGmLiGNXFOQNaMBfIR6aw1MDI7Yl/JCOkrN73cthj+r4MNUlmbKpeOR4J1hkBN5UY46w6XIAIwX5dK8EZo3SnawrZ4bzEQz8KwU4dFJt22HEQxrI1zcC/5Ymx9e7g+e/juQoaoR+/LYvWQZew3P1Sw+aGCzQ8V/DI/VKBjP1y0b80wPY3mIuFEAzusK/1TBWjZWrlfLdCZHnpqfjQAfNYUTA12enjAtCbmPRb4GBwk5syuvmdpDfKR5obI3BH6R+zOu76+Zfw9FWYLv3uwkgqTivfnOTcLH38oTN6llGDC5vVY5H/m4DVYGM7RAXbO9BJf+LUuLdboYpOs+1O/WoDkcGdOJD/RjWKMNLl30R7S/bYj/bMLHicqQ3kPD/H/VgXkHFEPZuzpoBE9f6iYtD+0YcD4738AlUusZw== +sidebar_class_name: "patch api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 +} +``` + + +## Request + +

Path Parameters

Body

arrayrequired
+ +The JSONPatch payload used to update the schema. + +
  • Array [
    • value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    oneOf
    + +string + +
    + +integer + +
  • Array [
    • anyOf
    + +string + +
    + +integer + +
  • ]
  • ]
+ +The Schema was successfully updated. + +
Schema
    attributes object[]
    + +The attribute definitions which form the schema. + +
  • Array [
    • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/update-source.api.mdx b/docs/api/v3/update-source.api.mdx new file mode 100644 index 000000000..08ac829a8 --- /dev/null +++ b/docs/api/v3/update-source.api.mdx @@ -0,0 +1,178 @@ +--- +id: update-source +sidebar_label: Update Source (Partial) +hide_title: true +hide_table_of_contents: true +api: eJztPWt34kaWf6WW/ZDuLGAMfu+HPTSm3c7Yxgs4PVm7j1tIBSgtJEYl2WF6/N/3PqpKEsg27jjJTIbJnARL9bh13/fWrdLXSjSXsZP4UXjqVY4q6dxzEjmI0tiVlWpFSTeN/WRRObr+WrlSMu5EYSJ/SdppMoVnFd8LjxQ1VkczJ3QmsvLp4VO1kjgThe95IFWBR55UbuzPcSaYZzj1lWhfnoq5Eye+EwQLwVMr4QgeUfihOPVkmMD8F9F9VaTKDyfwOvBVIqIxdE3cqbDwQ0/XjWIPGyWRSKbyJrz+YdC7EJfY8NObaZLM1dHWVhJFgar7MhnXo3iyNU1mwVY8dvcOG823QiVO6DmxV78Jb8JBNJNi7MvAg8FjgGg2SxNnFEgBjYTrhGGUiJEU7tQJJ9KrCpUCRI46ws7fC9/DfyeLucT/OoCzCJAJwN7RAzeWsGBqM4s8H+ah324UhtJNorjwRydwlMInc/jvPSzzMgp815cKp2oniZzNE4XrpqEWuHxlYb/3g0DEUqVBglh1xE6jIWQcRzEtsw39vsgQmiVT0euf3LaPz08vqmLQu+p3ukt/Da7e6QdRTBQ061oIIGks/5b6sfQQEhfICnAwoWEi4CegtjOTiYwVcZSPrABknMKrEF7AX76HbOdO5cypHH2tIPLgqUpiIGvloVoxE1SOkjiVq2wlxUBzDw4kf3Fm8wBHaLqH2weNg9aut3247RzsNbZ3vebBzu7uaMdptpqHFWRbHFyq5F3kLXDyp+dqW0ZEvkvDRHPwUxwpfgVDina4sNTXLMdsqdLRzAcW8ID1xDxw/LCGQkpMKkM3XszxXTqPQqCPK2EFS7JVB1S5KNlhgut25nPgLVrC1s8qCmskaf+FP/H1CnWcOHYWMIQPXKhyz6PRz8C7lVXEIRIIB6JncIWge3LshwDpaCGu++87AhEgauKlKKvkueQaFBwxHjAZUHgeI3USkBuEE16t8FgZS1mKIhlB3uHPcRTPJLFYmM5wGsfzaOJZdCfpBxCCdKh+4EZzxBFouAQByTjTtHzQUD4LUVvwC42YyAfCxUDZOUg4khS5DYBOnHgiE9SSUwTbCYUM5Awa6EU44zFQh9Gd5BdZkJut/NwA4p0TpJJwF8remKR4Gdqs84W8F/n+sHw/CQoCbbvjKiYyzvdvNRpZD/M+18Xyl2ljH9ghgJkTmGqUJkxxrWXmUz/w55WHh9xohovNYPz3Q4npkoKwoPGYKsAhsEMRidVMFeK7G+SPmwqJ5I0hOfyd6YonEQdwWrh+ADEkabCyQ691Z1pl1/MTAkdb0sICvpaZYt1bqGl0rwT8CxcncRinZBDUF5oRrlmKcvzOTFxkHNu8Ei6v7BPAvgyvG6QKePrbYdUDIGv73lrQ6h5bZDYMsNpo7B9stxzQLI3GNvwat8YHu/utvdHObg56PfEYTHoaMxWeAB3sMUwXk7+DC1hEKboTxoLowVQ6n0cxiqgZdq2lWBiytpXL9mDwsdc/hmeX/d6Pp4PT3sXpxQn82b1ovzvrwo/21fBD92J42mkPu+jFwco6ZGRKWYA9II1msCa9UIoOGPy1aTYDZ8THR9pHmTkLkibCgMe+CEwMWgLasKuHDsVrsl71t+CGtgdmGBYVIGK0otbG3zpzayPJ8IWTHxRG80M3mpE3zK4H2M40NorfuCPOZBLLCdstsHvgh6u6OA2pjZlqJAN0rR1wLUy3ZOokwouAM9G7nTp36O2C0pqhukJNhnrM52F8j31LNCd6Nlkmb2wcLXYNHtpWN2/x2gbGhhic/8cbFGD0TcCrUW80GG/hn3/8Q6y+9PglU+KKhcnOJqwpIJWs5tIFp9vNW3eyBC+kjZZZREcLHDO2QQZBenIigfV9sxmHMGFd0ASER/bqBOiTcRzNkP+19ycmcZTOCyRFm17yOOKJb8jTAHSQk2cMP063ljYsoVC2lEu7kq3mVmEtOcqdEGTtDLIauT5AGfwfOkgKHFLFqhKEaRXvV1oVaIeeEVt0gzXaohDiR0WWYMqUyNxe159PZUwOcRWdTHi7IK8ZuduT1KxGMV3RJwblFqVebeSgeYfI984HAaqi61doZSJk1Cz+JHzGky51n63XUnROQfeUuIIQM3o9WG55TKJlEmKSxEZCZWHQ7t6Bu9s8dCEMgl+uszc+bLjbreYOunjsIz3nhX5IIeCvITiEPOxk5lWr854vDDQPSwO9cJ68CXp8OpIoX2kRjMGKooh64I4hUy/qCEV0H5a5GH05ljGwj9ROMzRDxWpoLnrW6XySeo+pEklCiKBrRTGSOHxsZvWykTOHWocYp8don4c/FeMH+xTWVM4zRRhOjw3ifL2mF3DIduubOcTzFaiZRYFTSiE4X1zg+KQlHvUEC2Qiq6dU5PqkMDq60yqNwjQIEBgjPfk4kRZV5QQE9VsJF38LmnbOrgbDbr9IUvPwxRR17cpXCLq3t723N9odgdsCv/bdVlOOW9vO3t6rErQMgI4VQEMYIq32N+BtLANSkZ0oHPuT50WyrT2VXFfBfUX0mHQuU/63p2y70+ldXQxvO71+v3vWHoLHDb8v3p+eFIn9RLsX09/4cG4OMy5jtUzGKRnm7h5yMmz3oLXf3G/u7DqvyhJrwnRslLO4ZoVe22se7O1/KqP2YwzUT4MSMhbZR2AjdnLRe/Mi0emdX551/5oHsIreRBp47FmYIP9+KkPxGNviaN8lpm39n4IF+1cQ2RWYjZ68mK1ixGsZA+03Dtzm/s5OY5t+OQfO/l4DNMyrMtDK7F3tixO5iRV47yHOEeUcXC+cD52wIChmqh4x2Zqy1uW9WGsBF3lWtwEGcFqqOM7QsOXZC11+k0Qaw5ye8dpt6GYHMuEVMSCMGkTRF/CrsbEe+DtlzWi9gCb9nsnNDX7F2swQxUUq6cQQmZNkJPFCB7tjP8R41aycN26SbMkY2+SWa6F6BP5c8uv8UUJjNL8sYcXVvOfwmR04RqiOmktIRFsplHWwsbZpRYtQJqf6i6+S3Nvv1E2oNdaW8RlvdJprlUvXUFiIp9VVY8cqa6ecahLKn3FKhVbqK9RIKh2PcacoTDZK6XdVSiMJ4i8v4+jOVzAuTPQIua1BitNQGVXQ6ZxQjg20F2YcUJO44D0BK/7dMdHPPDc2bvxAb560mG7CSAhzZxuz9DtzAIf6+S2xZ7fKfoeIo3dx0e0Me/3bQedD97y9FHosv30xVXR+Y+2Ycn9//1XpUjL/+WLAD4kqxRHP9CauxR1pdm6vsVvYm8nciBVUMaae2moeNVtNJ9vs1vYvv6f1jYOOskEpJcgGZ7lWoIQRl6X/D2RMs0dxe9k7O+0sZTmWX76YLeeIgxekOl6bLUvmP1+IS7Off8mv12bQpZTHZZ7SC8O39XLGXcZlkcWKUSH8kqPGbuvwoJGxWBbRr8Bf/TWz7CPS7Sw/ytAD47UyBXJ2fp9tiaOL2OvRDyewW2hZ6DfK77CNFnabq16in1ej+/xuWbWCMWRvcEq/j0/7IMG3l93++ekAN9oG9HDQ6f3YzYm13Xg7b1+0T+DNWa/3l6tLeHDRu+23L45757ftTqc7GPCm3V8RhYNuu9/5AD+GXQhaee6ri7Ne5y/0YzDsX3WGV/3u8e2w3T/pDrHv4EO7373snV4M9cPVTcCTfu/q8nbp4eCni87ys9w+Yueq3wcM3OYemVRG7+Lsp9t+93+vugOcrH18fIppjfbZrWmRvYTFtk9O+t0TynwYWAa3H9o/dm/Pu+fvuv0BN8shdBkseKuX8GSbMgSVNFsl4Aoa+t33QLGrq9Pj1dq2l7BcaHgOS7vyPHVEIWJxI1jRvkctmYKGn0yp8AoDDN5foBEsG5Z3h0BmHik/22GmEjTTeXXZ5aPEElZFLifnbC5lPPMVuqFKj1Ng9fJBQEW60Z2k8Eu7SeTjQjQTK3J8yY7xiCwqjwDjUH2VP0ZkmvgZN+xCVMUeblnCXPSbxipKWzlwGGTjoBBo65hNFbaOQAvjNBKrO6iebixhdJHfdYjmGtOguZflmeBYfliAxG6/apBEDBjBDUEXd3EJPTjJRCYczb55K2YymUaeMokrU5lIbj9Xgv0y53ofsB66gIkAIdVSmB05FXe80MLA4sDy/7Ig4jgw6hS3tZlnxUeKOg0Pi2nWvIpxSy4CQThwj9+TvLNPEqG7IUYBk8RLCJ5m72IIYwpsGJic0LBGxF9GJeJv1omP8e8jLBNE7hfmmDTk33Uea1VrPCcZEMiBP+Wi+HtiSJVYzMoryvgbRhKekziEkcEUkEcVYHVxmthkERgt3+WiWsWKpn1cFWfH7Us9kTKUt0pthQFGQGpCFTHPfYy8bKoN6uKDc8c5HUCbVnMCcw++0XaaVhyeWvZELFOKArejUWQAaCdQEbzG4JVLD4gRmMd1CVumYLgaAnuMcuOjGI5ZPLWWZfxpJZvtQdOyV43dWovX+ui1lk7MsGxhVwCx42SVHmoRuiAiYZSqYMF01Bb4id7LdaN1MfAxwaTZgVqH8o7qCGHVdn+9yuv0VWlC3KdM/s9pyBUOWrJlgbEMjtg+LfkMR4JKrDXI6Gspq/LQOIy1cbPbS2kcYyGDgY+sZonT8ZhQUXlvoW4GYY7SJF8mwcLxuNPy/OCe52sXwEqMVvk5V+dItO3CCyU3BgGlfFt0jAqgzCJPgpLlkpCZnI3AbE39uTK1VPwol7/VmSbuoOM18OpRwwNEoSkvUatdjNI0NRlcIkMFpWz+LKdb8gFsoLRKapMMah5zt47EaeghH+TlK29ZqAo/Y3WtP9BerKoPsmJWi5H9WnV7SOjLeJjLrXWdbRXLdHx0DFQ6I7tVBhsrqxXocjBp7BlVop0VvVYaPFdw54DcqVxvw3a6FhWmBrHRRh4E5IugQKa4bI3vpx3mV8e6UZ//VjjP+bDrhB9HDJauGjTWXJdnkS17lm4E8hPSZGB5Jsb5PSAp5EKW4mmz38NFQ++ZTpWHfDqjND5diaVtwLzUcGm+0gDYRraYcTAZr6cTQQMuKpSsBU0uTC0UsITOhXFEAf54fVIXbRdPAwm7+V0VH4GDPAd+yMStg4M0pkJDlAEO1ugI1LEM/JmPPPfeD4wBqFLLWQqcqSSLxWcrBI7qqLvPAhg3XmSliMiynzHx97kuCuTozWVI/mJNw4a4L9SvPo2HjpVHfkqpsCLFHVp6zRZlFWag407rHc4Yp+jo/i11AjpCVUi6/eDcOcLFsVi0rVlSS1qDzlCMHXcJRuX4wZzca9u0jmixyysA3S4cNXj6EEwOQaYOlYsiUq6m/G8WOs8HoxrrHVPkJkz96SrO3CGHqXSCZNqZSvfL0J9JcGjw9ES1gimCAW3R5mG7rrhYF51SqdMMlggMTmnHAHhiOAVVO42CfHI1O5uBUaOT8KNWc3XDOCUXg8BtIKzbjYaO9axg8F5xJNQXn/exeV4xh/CxuK7txgMvwR6by8E0iqIAgoYVED7yVnSK9ZyZAbNOEp1RM8lonYIx+7SXcTQGcarTmGMnDWChY7AlMgcT/W33cpGVUGA55/70Ru657SFsFx3WAlC2VvOP3547weTNRfui02UNX0zEr7x9cSY+Qx2ZS8bdunn5JvzvVfPyz0JzviglHafqWfAW38iXjtD9sxrWRxkPu+KWIghCuoZmxENi2FLXbYDkxVUx8Sl0tRrHD1medd34/XSRO32rLHDAo+DsFZBiDoMOwXzefui2z4YfaE9GYVS5ht4GJQXwzeZUtU0uhi5g0JkkmhmCVVBo4t5RAlR4Ujx2l3FLo7ldaxzWmgfD7d2jnYOj5mG9dQA8s7fXajT+r6ChT9dg1KGtoc7s3dp2a726GpyiUDVpjQHpSlywO43A4UWqLKVqi17TkvuQg8VU5K8FjFEWueMKbzKPHpXi28K8+KSI2EK8ty6ac/a3GC8uHd71jLtTsxPz2en1psFjBLUEWE7bnswaEKb1UDnjZjssM1qz1oD/A6PtHO02jhqt+kFznzjMHOB+DYCI1+2A64C1U2ts15qt4fbBUeMAIKsfHCJYD6UFzlz3nvfmPi372xU+orFTdiqjE2Apkeji6XHwDvsm0ebrqggdG40ijw6E++EdOGbeK56L8GQCLksn8tbg7fd+KGuT2KFjxXTgHXjO0+k5SgLPsFqGhzTSyAfjCzgGTNS3xTvHg/Xy+jp6MRgZxI6L2wXrcP1V6P8NT47qLqhoTGa7ZFq5L53RXuOwuTPe23Gc5sHO9v7u6HDstFqNw93DQ+I8qRQYp+d3Qk8k0B2UfhC5QJG/A0KA8QH3BABNvn5dCo2xpm7htnaZGl6hD+SId51LsbMPTB9OUnruTJaQENauBiuOEKycB+7F/sQvPUdi/Jnj7vv21RnuNdpdRxxrZd+uHRrTDKACL5jzRHoBKJoKXFWXEtff61G/t6lr21DvAOmgTxt06KFnL+mRHzqrjjSi5PKdG+KNX5f1KnhyqB6oNJEPJ+mc3Pdt15XzpHamMfk9WlFPxm8hyswSkrp4UZ+2dDyP07gJBVKUDDEZUTD5/nI8lKFy2S01CuQsTxQUDoB8DW/FTSB+I54oSKHlFnPeULtOnsZcEbphDmmE0gXYEzfRWyFU3ImeMKzNp81QkmDKbYPiCU07q7Hydaek7s4ZmOMkonecGHpW7i6zCxnsizuphY9qOVgbyXzeWGskXehBnXUrSy4j+HyAdiO7G9ndyO6asrv8sq/Pouq35PpslxxIDXUyAo3niusTE/eEkbkQR5fpMiHpthztIv3wcagv3KFzxXP0z17RP2JTvgJ829KDn49MTb4x/RktEEDCI69gDJpIekcEdwYxIYpR1Vqd7X0Uj3xg0LDERcQSD5vUjNOQtrkdVaUdMKxY5zPnXOpAGpDKObwaZ+I2nuTGk9xYo401+tNYo40nuZHdjez+a8ruk55k8VIu7SepdDZz4gVzmrlVBi8RFNBAmFtRsoPs9sK1vLeCgwnrY1WKnkNl1NwebY/3XbnjOTveXutw3HT3ms7u/vb+9miniSX2ma2/zuTYCllRpnL0ZjoSiqlAFCslgblUEkVeMf0H6I3lmConkswlxqtt6uYOGPIdd1Z9x4sogbXhqdhaVse3lF686p/xZhYPj3jTt8TEZserWFRF5zQ3ruPGddyYn435+dOYn43ruJHdjez+a8rui1zHnedcx50XuI47Al0sunjkj3QdPZ+PKenbQkxtv73IWGcftdjrsmLj6BW8yOZhSQ1URCVXC+MsqUImMszQheotwss+oG1s2tKprgmoyBCrTvyI79TDHfuaoIOvuiCBb3KBceNFrT3GikqWGcNvdhY/dIPU09e9BhHfk3Lv+Im9sYFvT3EmoKhfMcepqfWr8sGijys+wxWL7i+ulCjzNv+7W1YlcIr1lKguBkzrR8oFOGeOl2iG9niadUE3rvrGVd+Y+425/3OY+42rvpHdjez+a8ruC1x17Q097qpDg7VddWhbbwjrS72nyvDf22MnUdEQEHuLyCVf3ct8cPIr8JRzhb7n4+IHfcxd4vqI8dZX33uo4Cel0CFkWNI4gBbmmy5fgURAmoe6M/fr5rrBMLqvu9Fs665VonCy6xZAZXkpFy7jN4l4Er7qPPbpbB8xJk3AaNZl9tkRnyfHN9XaC1iM4GGquWP29Bhv14Ag4julDzvx10WW1ghru4qDh+fW82PrqXXwII+sowx9T84F7QVAubQ8BP9T9gUwuhCLZ1/5DlhmQTDPv3oqqIfNmuKddGI6coalL29++Dh8KyboY5KM8x2R0segAKTkEliEdFjblIFgJzIr2e0Q7UKhDcqMGAewYHETDqQU1/l72vugjQml7cKtKdkXhTx5JwO0e/X8oa/Zlu+FW4ChreJtK2/5ak8MBnKHKOo3oTkvl5175SXyub3ruVmXk1vXtwLxn2a0Go9Wo9HU2yUoGLXXLhduuyC4OIQTKMLWN0/O49Vy42HkBE9w1GUY+GoXgqNYHuUaqn0zHIXxajheEY6b8OPUd5evyzG3MuhrDU7xwEWk5P8IgayDYnA9SUGKvhmse5y0RhJRazZyINV4yppfA3eQ4DsDwQiZmZwRmmP9TRtKjJBIfibKgsx/plO1nwtrpsfXYDWxpRe56pthxglrOGGNdYDS8LNRQsYC2cY1kB5gBuhk9CdNoAHN6Tweq1Sr0/Bb1AdNgwug0ihqfsR/HGUKTv8S9AJb2zb02ZlKVjCGV8/osR6yE4R/15c1cx5gGYOr8AYRGMQlvDG8djcTjeQ/23pxxe0sXYLfinhtLf2IJvnn0bt/kMbbaJo/o6bR/i2mHfvZ9yG7uWsVX/QVqpVPu4GThaxMS9JBRl6A2BNcTQwquuQX/g1vFX8TCpx0CIGya3jywwBwCcoL6Qt36ktKKcylQ98zrSLPRjOScf2pKKnvjZnQ8Tg8x+9AEOgHeM24+KjvQIsxXsNSXhj150gHbgOgIN1JJY4NU4BzNpulIV4fDkCkM+EA6z3DOXhDXMoKTh9VY4D4CjLby0g7siSigq44lvFM9cYD/mpPjkGemQv4Q+nEMyASKaKvoswW0tcXcGO7omv/3NjAlbWpDOYYMYJ2BkdN5mY4Px2ujAiDhXq3Az9yqTupLWwLg2AYxczQqkOcSB+QjFQC4W1uXP0RLP0NpTeX/Lndt8v89DXLtm++zfvv+W1e7R1gWLdFH5FFhko5zGSVdl3RsTy0PvI9PDc6BYbDF1+/Yn4KI9sHfEzXjMDzT1ngSprS3MRoj7c/yoRv+hrat7TDlv+obymgJqUaLnK6Fn5+kZiEgX50bSxnyQgUfqG3ZWp0VDrr+NQXcDGo586chHuiGyl3mxi5bA/pJpqR/rzwjJM8sXMPD/HfR5Ub+Af+iOasYqARPf9aMSlTaMMDG8e2zK/TPwD90Oz/AdJU0qo= +sidebar_class_name: "patch api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + + +## Request + +

Path Parameters

Body

arrayrequired
+ +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. + +
  • Array [
    • value object
    + +The value to be used for the operation, required for "add" and "replace" operations + +
    oneOf
    + +string + +
    + +integer + +
  • Array [
    • 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 objectrequired
    + +Reference to an owning Identity Object + +
    cluster objectnullable
    + +Reference to the associated Cluster + +
    accountCorrelationConfig objectnullable
    + +Reference to an Account Correlation Config object + +
    accountCorrelationRule objectnullable
    + +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 objectnullable
    + +Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient. + +
    beforeProvisioningRule objectnullable
    + +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 + +
  • Array [
  • ]
    • passwordPolicies object[]nullable
    + +List of references to the associated PasswordPolicy objects. + +
  • Array [
  • ]
    • managementWorkgroup objectnullable
    + +Reference to Management Workgroup for this Source + +
+ +Client Error - Returned if the request body is invalid. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/update-status-check-details.api.mdx b/docs/api/v3/update-status-check-details.api.mdx new file mode 100644 index 000000000..356e550d8 --- /dev/null +++ b/docs/api/v3/update-status-check-details.api.mdx @@ -0,0 +1,99 @@ +--- +id: update-status-check-details +sidebar_label: Update the time check configuration +hide_title: true +hide_table_of_contents: true +api: eJztW1tv2zgW/iuE92HaInKubTZ5WbhJusggnWZy2T6kAUpLtM2pRHpEqoknyH/f7xxS8i23doudthCKBjZ1eHju/A5N3XS8HLrO7kXnVJWfdarEvnKfxKHxalhKr63pXK50MuXSUo/5627nfJxJr4Qf4b8ulEhHKv0kUmsGeliFScIOxJ+VqlQmTvcP34Iu/aS86wrRE95+UkZcaT8S78qh6GWFBn0p5gQIo7LyI1tqPxHaiVL9WekSHL0VMk2VcxAB48pkY6uN73ZWOnasggCHGQStWNBTL33l9kjIfeWlzh0IiZly/rXNJp3dmwUFSbPCZnqgabV7VAQTfPfKeGIgx+Ncp/xg9Q9HXG46DrMKucx+b9FShbzWRVUIUxV9VYpMTpyQJhNQCjaRuRjAPCyCNsN5O+mpo4LBhWN1o4pkL3LuuLSftQMRGMzY4zAu8FabyiuaNEv4Vl7P2g5SUSz4yVhBCdv/Q6U+zIDRvcZ0aPrEhZZs0qgKrxeBSPSVv1IIlaBRMADJGCVwvsQi+K6uZTHOaWhzrXP7qA5Lay+YHw5hDyDMeMkHV9zo3GJFrz1/+51DnpcKTq4D7paopg7xZaV4wI2tccEeG2try6Ldx1BIJ0J0Z20ctnH4JXEIsq27Qm0v14ghcVCWcHIiTpSvSoP6pwdc6WPBFH1UTKrG2sBKOut+Sfg97LKMZdyzmZqhbVSdF/aNNipBvGmSULHIKSYKNnlG0VnYUonAkixJKjBdd85ssER3XbyWGfQN+u1FZciapeRIp73kMYHOjcZ8UU8ROuNkuWdZta1k/9XazsbW4NWWlBv/3FrfftnfGcjNzbWdlzs7tHqBDU4Og2ni2rIs5WRp6X8ro0qditym8MhfMEipJGzPAvDimKK9KtzjPmAeT7D/GfQKtI2aUV7h1bVfEVK83jsWW9sil2ZY8bgcLhjBJOenGDFVnss+DcWyGBi/K/VQm7tEUUgQKib7B29650dnGDk5+P384BSfiNcSXukZRGtGYWk5q0b2iiWOClyhljqVwxwq64oXkesLKCSNmyXU4ZubOBgTsTWQVe4xI65+x4xZ1mJQ2mIulThvrr14pruqu4Iyg7FC+nQk+tJhAlxI5C96ADtjnxxFS74QIyUzVT7vAiVlmpREvUI2ginmT8BIyCyj1A0MBhVSWTHispUXxgKNqXlfTE05741pSTmadQolByR/PE56qa8gHKs5m4VNtEQRo38gc7DcvHRnM0Zjk06Mlym0kHk+gRnLEhYWfeimvROxHJG7HAqPqemaijVbKbncvQ3C7HvLz1JZuSfk3XGO8pOwas2DzyomH5ftUI3YG7WbYkXCQ4bPNDlSNe6qE18AfuZZm7tt7ra5+8TcXXx4EgF2fMrQZ30Z+pyb2GjS5rkEfUqOHmPrbvSvgHKDI1eoc40Q6df3Z7G5pa70ekyg9xvio7CVLwnfa/wRxvsEPxpnzfmCBGQ7Bg0GqEQq22W5pxKzoYKpNpdXe2PLvkaAmjsgIqpmKSa2EhImKytDuBeNyorIrHLmFy9GEvWxbt1t070nTfveIskWSba7Ubsb/Ry7UYsk29xtc/fHzN0HkWQjFWdLxEmuKgpZTkKkxeekrRQgEPVRr2hSjl21iFaImWgwVmceOXT6G+v99cF2qrYyuZW92twZbKSvNuTL7fXt9f7WxnZndq+/mOZxk2TzOTXj7+BHNjFA3GfguMoguJy3Nps//oN5SzWgssa/w9S4GTaHSS+n2HFrGTv+Zj10A2Ngx/Ke48XzkyPij6WZPdnNVmWqCGYH04FceoaUFMOwtHa+hY4tdGy3n3b7+Wm2nxY6trnb5u6PmbtfBB23HoOOW18AHbcEQawBQay/EzpmwB0EzQZwCnRIK5jXEGwcQxV8iqePMe29LIfKN0BvDkVu7CyjyDNrxVtpJjVYcnMnkWZqLipvoC2Itqxp6VKRGKJEGoGqpYFuKaroig8wKd1qynWhOY9JIfAtJ0lv4KFVyJk63ppVtEnzChJyUcgtnb1axJhGOKkBwT9w4HPQIQr1NzzjjN76n86DxQlpfEQai4PrVCnK+eb89+VdtwT4AgWVi9Pg63uuC4Qzc2nQRqjrcShfDQRtoXoL1dvtvt3uf47tvoXqbe62uftj5u4XQPWIhu6H6iB4MlQHbXdNNFjqDQXX/x2xc6pECTi8hU0Zq2dTDA4jOIVB7Se8yDkg/l4I5V7lR5SZOjO7LlwFThAQnxJJV/d34QyCpyvLz2euCtdUl7eXpA1iljQfV1ysJPHvrN43162G+7gJX45NFu/mh14kmKYqc3AaeT92u6urN4gYRMptV451F4UUQeMnxl51U1usft68o/7RddeQ66igWZVy/9I7PowNT5f9XGpKpVB3eYHgdbYsJQ28z/ccHuRvZMHhNEEvJAKbFYG0i2HNwxBzjJ7mF8fUXQ7jJR2h23mZ3z6mz382H9IjMLlHj7vM9+BaoBeQckE9Ev9yGmWnBP7D6kuxNt3Q6GeHjaXF3hHZhnitZInOJNzEefbr+7PnYkiQl0tO5QhtK009CpL2GCHCJbVX30qhSbzLlbYajljw3ty9H0phMcihsPhgTpUSF4fRCL9hrznB5sAmpUmK6xHNunxWeyZTn1VO23B3akkKPKTJKiy0KufmPectl3sTbfCx4NHuB5OIfU2VkBKBaaKK3GqKi3Gtl5zR62uF+EfNLQncEubmni9IEUx7kYZ75CnqCLGQuWNrffXigV8yw48aOYwQ10UZyBJRjvnbWmntta+WY45fQvzm5fhg3o809vP5aSJUNeGwHeeZOBTpyFqn/iUEhQ6lwcWwQhZ9tVhXtGjCGZFsrM2IlIQlE50AnbJ8R0gME4JJ9gkdMDiy4ZyGU/IjexY5/5Hf+/g4pzMPX9C7WqDMbOq+WmZaMKEFk1ADXJQ/7JEUWMht0oHrQAiAvan/uRJEQWdqXuB1Z1Vn9qs8h7aGFKIyFzfeDV92pwUufhL8gKgbGpRgAvfN/TV8F5EXbZRzxqqPJRYtuCxvbrE/L9gtyNv8uEp79vemL2ncm57evDP55FtX6XsqyfdTd/+mitdWmp+x0kS4TaegJ9OXUw/qxujpr7TR22ePv3xGb4wBnCO4WcnYBc2mVMCGyyeXjl/9xV885brAXQR6tPBOLyGmWTbjXHrKoPDa7kgrPvMYK+kJZ65QFNuCsx4iU6lBZ8uMhiVoUCIcsK/s6xz8uuI9mkqTwqHUUNJdY3D9w8bO8hQ+PaaQEPt1mACuFUVl6BViCFEVQiIYH4mlTLu0CiUPXYVRtWaWQWMzq85/ClIyRZdbq7Jw7wbx1ciZkHlkLUSMiyfjMCR5hLA9dW2NIicqD30P6ObB/mO8EafJSOVjcjjqNaCbmlnh7eHZEkcwM/HnGFsOV+Mkt0q0YEKNVQiGzS4aWX7X0TqPZm6G7xPeEl+MrZvpTwPf80vmcX+jxmR1TId6ZIAqNEqha73o3Nu1UlW4v29FJzSCJYnDzQ2dDFETd0vDUJSOHS4upz0afcPK4YSIG91Pik4m4k8SydmEN/R4BLH8Wwu1jWFGOHV6kHa2QT8+p5Dpx3fni3CmUcorDNLf3c4H/OvQ2/hBZRDx+E2nPiEETWBbA6e7cEP8QFre3v4XpYG5yg== +sidebar_class_name: "put api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/update-transform.api.mdx b/docs/api/v3/update-transform.api.mdx new file mode 100644 index 000000000..92bb12b11 --- /dev/null +++ b/docs/api/v3/update-transform.api.mdx @@ -0,0 +1,564 @@ +--- +id: update-transform +sidebar_label: Update a transform +hide_title: true +hide_table_of_contents: true +api: eJztfYt2GzeS6K9gOXuOJF+SIiXZsjWbuYex5ERZy9LqEc+O5RuC3SDZVrOb0w/RjK2Put+wP7b1APrFp+xMEsnQnHHY3XgUUA9UFQqFT7VEDuLawbvaZSSDuB9Go7j2vl5zVexE3jjxwqB2UDtXY186KhbJUInEFBTxWDle31Ou6E3p08C7VYE4PhQTLxlWCo+j8NZzoawX0JdI/TNVcSJ6oTttitPA5yauazJJIq+XJiq+rglo3YcqsRiliez5qik6SaJGAFgwEEkonKEMBkqEUDXCLsYqSjwAdFN9bEJbgRwpaEUGLjwk0zE8bAFwvg/dx6mfIDAyECqKwqh5HXSgyRsYAYOfgT6JvEQJmSbDEH5NERyE3otgNAiDhPaSIbztnB03a/UaQiFx6o5dmLx07MpEZdML38cyArgSFeHEfyIgoZznwicPp3ssk2GtigOY1bBfmVPonFuH0gai2kESpapei5Opj83G3mjsYwH1ceyHLrzqSz/GAs5QjWTt4BNNDJaEeQ8GtTssKqnSQW3HcfefS3cw/HDzQe7ufRju9NrDmw9DGafKcWt377ljQOT3gEdsrAz1JcDLILoFuMPeB+UkTXGSxogCx09dlWGrnqGqrhE3SxFxXcDzfAQDqUCrQQikpcQodIlCES1OGCQqSBBIOR77nkM42v4QI6SfZueDoZxBxCUR7xgICBqjJhAxQEUeNB8FQAzThggj4QAY4UhFDVf1vaA4/mYJXe+YAOrcbb0wWmTEnKYRMiaVKsaqEF4FHqBEYGGmGSDNpEB/OXovvRGgDp7EZSgOmZBGXvBaBQMgwYM2PMmP5ulp604DuRICnCMsQd3naDd8gTAE6QjHLh0nTIOkYwYNn3oyVs/2DpWD1GoejwL9CFgExPEP18PWpI/9A/AvwxGwltJPr6BLKogPJ4alHCgTxurQkwBuAjTgn8joJkaI2s/2xsMwwPp9L4qTn6VPPBmlxD8gvIIE2L8Iqhe46uNpH3/F4W772TP45cs4Oc7e+6qfnElsxg/Dm3RMPyYqgv8GCKDv/areAKIQApgoNxx1/PFQvkmBcjwne1l4Vn0VqcBhnie53PH9/AF/eYOh7jQGOsc5iJFSsXqc9jKcwX+RHNLxmOBJYyTfkfpBBYinkN6lMAXviyRTmlr1kUn+MHTiOcyfYf7UYB6HmUY+fBwmyTg+2N521a3ykTKasfT8cQhc1AQkbXtusO1Cs9sZ/cTbYd7M3V2JU5A3Ut/HJcIIwDIsJyqRDYBdCtkLQXSUBGlTAK5BiPHaBNzieyBCgJTMEuegqE3mEjV8ADmjPioHACE5AyQEqEfJDuRCczaHyKsypigP4jCNHKKKojig5/d39bzZCqOUm5wtmLHQ4oIZcy0D75bmqgxKmRmX1YZlCERnzFIAWBFq3QLn6urIFmogy+9KPZUZfVlPxMRaqMUKIdQPTEZE318IQMYAi6eyIHXWnI5yL0sk1eJOizJscamSdLsvprU0LBD5kgZovfrCVewSGdFjnTNfypQg8QQciYDACwlrvVJurBnRC25Bhcs00vnLnmnipfSd1Oc1/BzHdZeBH59BCVAenHPVh6dhAd5eGPpKBjMAdwTNF8MEKwMqGCBTJkNF2mlZdfPDAQAQD8MU9NseahQNhdVJUwKRGE3x3wDVXBkLoPbEjN+sQ1CFIEO1F3TzuDhCUvFQRBqs6RHrQa6BtIIWS+sc6WiwCvVQa81eXKB4lP7LoaS3PmsKX4NwUt6kP5HTGKclVgki9rr20g9TV1yo6NZDQ+QQFrtwOoKZEFeJB2vc9LpWQvHK8ojrfIhraTRZcQQJfhMiuwNeLtU5LdQXVL1bgmVeCey+MqurKSyfIVxyPCIrUHthuQO1N8TfhHh4AAANBZYIcGDW9jIBGh08yBCcQY+t381H+J8A4JjhQTswkk4yH3ZNlusRoDFqYzEMJ9Ap2pmo8RPuwEg1yHQFt1KUPtcB/u9vb04vj8QhSoIw59ZsHRekhcByBPUlaDtgy2AHoGh7o3QEtA/6IeoxWpoASHtPW4UBXgcl4mq3HrnUmmWce4svrcR+U0IpOTeGwnHVcKlKpyVFESCcvXut1hegyJ+hIi+uwKQQqLiKTWhlS5NalSQmQ9BzCgwCzUDjiE9kp04siF2QrhBG0VcySSNVF9MwFQ4Y3mC4UIPdkQzkQEVdcaOmkzAi74w7BUSj9gS8iyaYSMdUGK2dDUAtVyEPArwOgL8T5gX9BcrM8nCzwoQ7zov289bzp/ut3fZuu91qtfdbe61e61l/d29POS8eM4supZ6S6jjPgl6tPZZayOzqpfZTZuOWK2cm+mLVODfXl3Vg9JxSTWPeL6tIPsxqPfYGLIYJp+GN8RUsLzrXg7Cq+FolC16HZQNEQVuuV/BQ3HNmcofGsoqRGqiPufsDpWmlmdwbcl+cGu/Jsnqu8r2RlxBiiDwrTRjHy33trJKjZkndnhp4FdtR+3UWY9N4fJaUSOcYh8DNBc7PPdpFj3Hmzp7nWtTNlSzoshPHC8Zpor8d1E5OThqu25jCX138+OPBaHQQx82Liwtc39OkWBTLbLvu9slJ7Q7/cJLiMShZ3O5OqzXrnzrORGlZhE5AMMapg7Kvn+K6YTzYuEhEChafABaFJAbVb1JxBd/Lzwxr0gIb2nqcrcfZepytx/nP4HGuSoRC2ZVc2REZ8ZjxcHV8ipWMnKGAMdEHDXJJWrwNoxtXkllUhmoteVD0GubWRRgUu0NAWKQ3Bdv/rDkDtTnDGd+jqZS3Rl9vvdhDi11vbSNZs2zuA3vUUTTrTvXgeQloloZ6eHTWOb88OXpzSaPlji7CqIDDtQZdMLFgNCCy+t4g1Raih6aUcVvMnRzcUY7JAxOADQYjANnsaRcIGFSKqkItnjJcEhnQmKugPaKIjEepn3gwMgEiLPJUyYioOZHC9ZTg70soWXhXHvwhjE+B1IXBruNtWmP4urLYRJ7dJntmqylewpodhX6cD9TMTQxQLBycGX1THPdpy1mvvPWqRoEhB3qsOMfUrdiUZnDc5daMpVWYILa8ssk5JwS8wlXjtRfc/E6zMxl6wBUF1tEELXXL/SgcEUNDE7mxLHB2qMe+LwfYkfagkNisTJXRr5IMXGoUH2mNzHrXzIaCs04mrfD6oJVh8yiYCSX8qHvjGV3SHbcfhEEDG+Devwiz98DjK89H22E9/0q+WSRA3UK2ImhwkUGdBfsPZBSFEyNbOcolRtG2jmTIlkMdoMHAFbtFDRgEhMscwb2QK2EgvSBOSuAA3rFbMzl9bowmTPvSjBe3IBqxA6P3cPyHDKYCdQgMMwG058DE3BashbB690jh5XCezpvDslsM21cfgVAQVD01qIzBFMrmdUDBRw6scDAG/ZkcsPlqT1wvb2F+8MOBEA3RDWiT0Pg8uvAKu+lo6jw+pEKuB/qQnOKaVS1BbjEsQw34ZLnGWCjnQu32CTNRrJDGiwvREEyVYv2SmP23zTKMTdDJoiR+6yXDzevak8Oj10eXR4dPrmtbWwWxe8ar/fRLKROeiELyFR6xqLGfLRcw0yM1CqPp70ub2bqlOUMlTfIxIk1W1/YK1kmu8TC084xgzQkNHrT/lSlRj6+Eks1BFKbjuIk2IkIFHW9+2ui4gNuNuy3x+bPwQ7YXxXffiY1OijS7sfW4/IdVaZj7FM4XjJE2oMDcXyc6i/3QwD3hmG21onqDM4AuYwyG8xzodaoFO48A++D9GV7pjIDpE0aNRl6eK15oqCYuPbBUmFDHuWtFIm8UOQ+4Sra4FeRfDi8LNqYHwxQAyq0nqc4VhRtK11ilZwVFnU2Sgl9Gz9scy6Bs1VQUbbZMf9Eeg6LyX7ugh1rRKcRYQv/LmmEqVevCUrml8gdM5QtirCyVWyp/FFR+rwDBKtXr9wX4o0hO0ZWZqFE8Sw93M8QPSh5WQSqlOqhkfgjREgwHxABF+nxX+ykcIgcJ+P/FyOPdHct7lvceLO/9C2Nsq8xaaGMNN69DGyFeDPOLjn8yRplK+iEGNLGjAqqnDsZuIKl3yQPeEeqf7Av/voucBN/0hy7hsGu+kW+c9hS0BzMmvyrtAsbYHp8Byn33TYGWHRqXXfXPrjBBvyZIJUSj/xY3XArAl2y1KnzIPbOTuV6QDoE5e4BHW/MFI5ZkBG1JsnusBBG9uJuHvn8hFDMeLY7ZsyapFaUPVpT+IYcIqhI2b3rOsbk8mo690ggxHTYMg9jD7YnNS3a1agqaGObQO024CyyGiDosbvihIKYzv9WW3UG0O4h2B9HuINodRLuDaHcQ7Q6i3UG0O4jWXLPm2p/LXFtw5LpqW5QCyKtmVceorvpoHRMyvtBnE7UbhBArLihzymHWt9BmRi8FFm4Ae+KIXGRq/EiEYRYvQSJohC3jghKTiHhCeoAoQEgMvwDVMo7TES3PWI6KQlPHF6fPn7XautMncy23NwTWSzpgmDqFKVsgfj/nZQX/fabIbIGx2uIMsKmiAN/ltcTn6+CzaJi/rFqj+ld+x9XMGERWrYvR+w0K9t+43CgG+v+9C59RvJtKsAAFrozcJrzP/rDV14edM1H4062enLjujz+ORtDcP7qlz9gqVcqbxPfY1tnR6dnro18uTl9dmrZOTvB0AbZYbKXYFtnimhjOVIjK/UUIRjgsKKA+UbtHZ6cvf/zl8vjk6JefOj93oOJfxChmDh55boBR1HXxkwxSCUKyjWpp+8V+S3cAug6TFPXEJIyLty/HtFoitnDRABnhsatiddOzgL09frO7g4CR+Qm9kHO13WoFK1pD7NwLUGizEcggZFgL/a3qhoCu5RH9mjbgDeIT/lPAHzxVZr38hoZbjjcv1i5KoZ9gIddCgfmjKpIW29Ta6kMjB3TuhDaw2HeDczFmFouzA41aJQHSwVmsyiHWd9ivTpY16RZoxaAWRaMgnLlenzwnybyudBd5Pq4ZaYfrCB6Bho+wxLEW2hR02M9oxDN14ikoJR+hlwErO6C+IKqZK/B4THY++qAyiAzwGPvE/xPQdCyzBLikFuE3wJ/k4F81L5qk+WCOMGyac5GVG8G6O61Wu9Hab7T2RHvnoPX84OkzrpfRZdbcmeRIfJKD9PVXkLYwBoHeN3TP0cx7cb4Gz8wITkVzC4c9X6iecx6ysjydkZ78nQRa8+Sk6briB7Ehk43sUJT4FQVlFwfXbO03YXCdQ9AC8iGeHV52dStHR0d1cXJyImDN2dhAgfZZvMUF6KfUF3vwDhmZSg6hcSHLYpNaFGcnpshQbIQbGw5M4c2GkHXxK/x1qZwI+TUUrmdzeSinPrI1zwO38Z/UTR3HUBarLe6qjtAXpgDn4ERPww8/iCGDKSV226IpgJFM9SRU4KXBuzR8bCmfQFwd9Dzs0UxgQ/n8Acm0WhkM+aryjzLMBHUbyu61d1rPnz4rV1uwyHHXOWFeml6bO7tP12rh73+nhXJxEwdZG/8Nf42NtxuTSSOdt5RRG2939hu7RspmgnE0MmsgHeytHMH745St3NTgz4nWta3WZbUuq3VZrctqXVbrslqX1boeh9ZlvbjWi/twvLhIsYW4maWRLloluW+oCyUfsLEuNtbFxrrYWBcb62JjXWysi411sbEuNtbFWknWSnoYVpKNdbG7LnbXxe662F0Xu+tid13srovddfmz7brYWBerdVmty2pdVuuyWpfVuqzWZbUuG+tivbjWi1uNdcnSwtzrxrRCrEp+i1sTuSm7x2K5epz95g+vL3N2w2vzHES6jws+UENwILLUM+I/RB6dY+oeZXVfmypoogCd4hoWlqp/N1P/h3l9DyheIZrp/m9zqufd/1CotQiCv1UhKKhtr1E5g/HAvz9c0j9HZUXs9aVN6lW82M1KXCtxH5LEtftm1oNjPTjWg2M9ONaDYz041oNjPTh/Ng+O3TezWpfVuqzWZbUuq3VZrctqXVbrsvtm1otrvbhLvLgnMhmuOIFduJzmKy+uKdkfmjjLSxPuzcHigsewAKn5AaYwqAvph1B5ArYKVYRlZZiXoPL6mvamZthll9fTIoSDF0f5qb3ab3N7/TaOqYHw/SX73siu40GeyYVJEE7+T3tCh6gA++7VeC2xMXMKzwiPBbJDSw3qQqRjtOXccBLwcTTJ7xEz3e1u+dSYPlpq9IEc3Xzhz3Wgj6Au5azCGdQuyZUu1+0iK3QLgm850JteUzXruKcXOJyfAA/gSkcLE5z07TIRZU27TGE0Wlgu4aNIA08LSJQ8psaWhozBXA80msmvAW6rvMAsOpZr1xm7zjzMdUYR0cfq0JN4thnIzz+R0U28cvPQkrwl+QdJ8qr9bG88BDm/ksQ1WZyrwZpRKGvhuqeyk+4FXEfUiaFdgk8E6ajHrgzttMsctbS4l8CbRTasoTmGry746HmeWIGmPZrq5tjVwc5kkzaIvgu8x7fAf6BtvDu+OBW77WfPGm1Q/MZD2djRdd9vGu1MBc2Jd+ONlevJZhgNtvFpGyr+whV/0RUr62vt6sIeWrey5cHKFmrgZ7xMc4Xh9rtcDVzISYEWmCZtcntSXhNMsFVKNPHuU2WCSnPQcTAsTxzCGJwkjKa1mfRatbhzohOV0Iu7+kJU4Kwt6ev0JpFz2kcqDL6i2R/PhcbkbNsK5iCcKnV8uLQDdCt5gyCM1FEUhVG8hlCSFOyIlh1ncGIRFSk02FCOoIc8FKPwltOMMesFYCRrvsYYRmRk7E9s+t4N8o54g9mGzkLyNIOl7CgquyUm6MtHC91x0qi5UiJ96+K2xL9R6qvyjuUSHg7mJroL1kw0lwc9F3Oq/aACANARCAjPaqCUS/xLi+9teAOT1ZuWp7a0hJomXkrfSX0WqOc4rkeF6aIk1iPWg1wDaSY83aMrSnU+qTekbcX5i4uxcjzpvxxKeuurYIBXp38FwkcpZiLjLFY9ZTKMXdde+mHqigsV3XowWHGoUBLR1dFXiefDdFzXSiheWb52VxzievHTxdRXOvJedAc4tYC2c1isw9EFVe+WYJlXgpWY0qyuk2nOzBBMjQ57uKao8Osays5rvm8ZHhY51TQoULZEgCZfWJAhOIMeW7+bj/A/AcAxwyMcAEg6yXzYNVmuR4DUYh8zwOH+JTltyfgg3OHxBI1MN8v3mEsfNhRoa1Qcatem4dZcjSON0qFoDQlLU1zXDuGP3igdAe374YS2JHWgSyz2nrYKA6yYA+3WI5das4xzb/GVgrL5rQml5NwkiDVZ6jINrSqdlhRFgHD27rVaX0jPJ61LXGHCVsrHtwmtbJX3TjKSmAzDuJgrlTz3MeKTUshhljpgF6QrynfbVxJ3IupZpAUmVsUGuyMZyIGKuuJGTSdhxA6EKSAafXZ4rCkMb9AXj4Uxl+wGoJar5B72gdLxYPoLlJnl4WaFCXecF+3nredP91u77d12u9Vq77f2Wr3Ws/7u3p5yXjxmFl1KPe+LqqM38325Bfh12iPw6RQMuJHYdKCG33BkrIAEi6rkHOGMcjzigxYlDKsREPXjQqN1vHxTjhegOPURbLYVCcvTnuao2fzk2ad1NstN4XJC8rr+rfckkVLBFEfpTBlkqQZnpy3mDybQDX1zMmEy3Tn/ucknrRU3N++7nCJUYjLQXywPWx5+uDwch7g5sHJbpp8F0a/g0wJqCzmRYeaVRpvZyMhC5fOs/uTE5WoU0Xmgow9o32IHEy5fTsJGZriUt0s2VXPQrIMOfXVxXdv6q0gK+qPZf9EGEAXcm+0dMNDSMRAc64amt13qbRgptUZ/HehQVwZ7F90iXJvMX/ILza/5fK9FNctChQZrhYoVKg9WqPiqn5zJVdsxi3x76zpXQNSgHx5tLX37gD6So009wQ3lqzxShs5YkDWZ890eZWPAqV1THykG75X3FXAnNxMa2VGg4vmH4pkg7BNToVMgX8jmYjhnIF8UYAYdQZc+KjMSiG3zugZyZ6sAHk6aHnVFED0yN5CVQd+WDArDm3S8QgTRSY1ZCcSv52B92aAXUIT46eL0jeAWkGZv1LTBjDGWMEY+lQIvs3uotI1Dl03RBRxJokbjRO9G0WVHHMiS0U7d+JpyBy8+lEQdN1hkMH27gk7VoiHQzWu385Mnb0Bve/LEuLcMz2U0bgQN1ua+8VDTX1nDCrLyCepRWgdCP7iOnpU93H3VxFK4xolp1Jhuc6iZgUfVK7gJMNqUw3FAtpkloMJ8NLLx2MwbTpBpseJ4+4TqHEov0tskipFX5/ji6OQIz4h1ri7w61nnZa14JVIZECJOKzmt5HygknOiIhuKasn7cZI3Vn2Dtr/v/Wrp3NL5Y6Vzji/ooDfpDXuhVtL6vcIaGNtlC5w95lNjBMfAYds6oBqoNY84KARAGP2UdsT1XVusfj7hWz65ZRPyIYVJmGgitRF1QFtIAfC958vgxtTnzBraDbAkqcas0ZxtK3d3d7qmud8wAKO797TV/XZCMKzo+QZFj5U6VupYqWOlzu8mdUzU0Aqn37zQvbUD0o4PC/GcSSWQfIxEbC6vLeCDcIyxZRPJdzHTxd1eMvQCfB0JjjxIFgSXH5kmL7PPlk8tnz5cPh370lEd3//DvPOdwp3nc53yRxKwjb81FWfsrhNOlWOQkPIRhdBM7ovXw6RgXK1t6GJ8W3nZ69wAqAS8uq7Bjw348T//H30V1pNsOf3Bc/oKNo9Alf9I7zKGmWV6LrTeGq0PfEvDdsigghrI2NcL5qzKGoByjN+7/ycbv3Ya/3hfW5VC55x6+D71fJf8iuXUOdR/u9WmfDmarfPx3isafo5kqezuUbyil6QuX7EeIfcWdxdpz1/PRAwSLA3c8qiF1TCs3Hm4cgdTCdoAJBuAZIWQFUJ/lBCKYarnXQdTlECu8r2Rl5C6QEcSZoVRXuReyo8+GptxX85vBW0oT1/HZosXc5ac6lH33P/Y5y+9SMkbQfn/oLNkohRYRJMwPyeRxfiUZE6Ju+tM3u46at1KScvpN5TPSpHsJ5rByyJvKPG0JcBKuGHSlpQi+a8cNUStUNRWq9HD0106cKsOdKplOB4VKfc2ydP04KGSFtO/Tl+9oFC7LlTilHWup5QCYxiFk3UOQudJDzeR5rdJpJjzkMzGszKPRIBOWlEQdtRpUDgkgzPKwoRXK86LGGjgYYJCvvWrh5pjnOegjChtMarTPEUmCyD5xlg66DYyn7Qvo4G5Zc14741opUZMZD0nR+Sw+tnMgyYi7JjOJKXJaf97gi3L0XFdK6cyXN5QkPr+Fy13nGwkn0kgJW6riGrjkrApQexS9yiWugQGMG+j74uyL608N58lVSLxTfG1Jlg0u7kjCtPBEL72vY/KNRtr+QfH3HMIxMP8wEn1cc47oKjCf35WfuggsV9ikiLs7rUMBikmbi+Jbe763zGFPzkmV7kJLmiycl++gGIprhFZboHfIuWuRsk37z4s02l23nQ5qfYUZryaoVR+nU+bVknmUOrcA6YFiyzM0o1oNSlbdvOTptny06V+u3RSjU2zRnuu4KFymN4/76mVzXEm+MpLUbueHe3D8ezSwTNq6LTfh+7WGi5dQlNUz0ySpbmb8CHlHNai1sBs5CFpGjwbRCmFCRGcMxFFfzGxQxiAiCe11evr5rSUbrQrwd278warAvc3wimoVoTTTOIvwCrgVLG23WijUCquKIg+6ftah8yPPM8NgCeuwl3EAeWg4BnFpktIz3ouTsWzBVPx+2BdldbAr8S5nst8Bvl5LgXMJfdvWkBavevh6l3Q3MgGMFvqfpzUnY7HNj7fkvejJe90bsJiS90F2+19cRKL0W/LE/bRxFKOXsD+lwX7XQXeP2H2jg95oMUToyXrf8dx959LdzD8cPNB7u59GO702sObD0MZp8pxmUM1HKtxdjwHTaWYZ2wnT4bXcCJFGMoRSc59J42TcKSi2e8rsYJzPmfGz5V0S/f08CSuGn1dp1ar4a1ucQJ1xWVI993lhO9ml+LNsFzhSlQoeEI3nDXwnrG6KN5yVqte9FrDMngn2clJGQFmiPByr9Wadc289D301VOOadEQ55Uz0khiCgPCQ3fKF6/eYsIaFDYYQq7jOCQmk3FIOG1/iDnpYuwM1UjOE9PVzZ4EkPsydNVqCn0F4rkxwMhv5FECmbLLsJil4Ha8ZpGbNOxK5cr+K5iJZlt8L11xrsf3Ug8GeQ/stxto63h9ljFVQDRk2zRzulX7SvaetV7s7PWf7Um583yvvf+096Ivd3dbL56+oASHQDSxHMxNzV7u2qRfphsbvV8Vet8lzD2nXcfOawuzuc/s/tNtkev4I5W+WTIbpoZXJOojHsoX3788E3v7wtd+Q1jkKgnEVNC4QvrFLQKOajQJZqnh08gre5zyqAF9x+nh0avO1Wu8zvT86L+uji7gF7b1fu4GGgmXkCxzfYOnGcBEom/Jh+lQblM80a0+gQFJnTBNFzRJCjgPopYdUEP3PqdGsemiZ4RJjfjmY2I2inr4jhMB6O03do896Ti4jdMwHtgnYggSSUVbTdHJlnmTOGokpxT+5br5RV39FBN80kYVbl2BOuJVA73yqSxjIxeHr4tIQeYAyNfYu3SSFK8RpdTyBS7MqCXbKTV3c+n7SkvQXRYmjaYUr1R1Ep2G1AkjvB9A9FDbAiVKiyN2GY5kYMplEqu4rpK4O2FgDpOQvjkS7ydeyXdnPoifBg0t+3CrNPOR00crfSLXxoxEMmojVi5sDhYZKRZ9T/mu5V3Lu5Z31+Td6sdzFY+BF81XUn3as6rPVSBTmN+IFs8Z1SdSbMQJU4htL0ZkHbVOrSL99PYSGPtGkQ8erEnUyH9D/YiX8hngOxk++H3PbOWZpT/HBQJI88gj6IMkUu4BwZ1DTBPFU7U72xuomT0PCDSYoyJiDmiKKcY7paM00CZTXbihioONRAwlyEcwNvEeb5OLRgVugzf2rCZpNUm7GtnV6NGsRlaTtLxrefdh8u5STTKDirhF60lxOhrJaMqUZvL64Z14AgpgcCjVFxnLEaqq2go2JjIdq1bWHGq9nXav3d931J4r99xnuy/6O86zHfl0v73f7u3t7NeKa/27nI8zJivzVAHfjEe+5kFFeGAqDYC44iQM3RK14vRGqo9ijcIajN4Mc97E+yky3XFvVnd8EyYwNrwluzGTgtG0f3X+WtBZdm4e5403QZBpOY8kOfVRpaSNFTpyblVHqzra5ccuP49m+bGqo+Vdy7sPk3fvpTrurVId9+6hOu4JVLHoRPsfqTq6oHegatb3MHAly++TndLV3kfN9gmegUoyRa+kRe68mNUiL8NQnMhgapSluOSJDPLpQvEGZUdYNjJlMd5aDEBEBni7nxdyuLA3UqiT4jkHPnDocmpyaDeaNjp0oo55Jo9Z173oWPbi/ZYh0JiHZwP7qP5BC+QHHYCg/g19nBpbX+UPFud0sgNHTPc5K+T5zP/7dF6UwHEWiMG4XhAuwD5zvEwwUB/HLL4yFdSq6lZVt8u9Xe4fx3JvVXXLu5Z3Hybv3kNV19rQYlUdCqytqkPZZktkutQrCkL9vTX2TiGslo/w61tA3VwHh0mIFbzEy7SxE7yB+iWTcifFNEEYbxwcZDG2B3zNc+09RtKOFBAhDgXjvzG7D1aoFc/sfvLcuxp2gbokD6N8APgTYBeweteUY69pwq2DcEKngG9358iqPFMYSDs3dcjW6Jwda+OkSTjh08osI6kDxpC50CY7bLy0fZP8lJKYcjN1ASyiSZBzm4ajMdgfGzGVbuoo+MoYYWxXkX+3ajw/7y4bBzeyYBzzpm9pX1BeAJSV4dU4QtpQxAUq6tz7DF3kiw9uEezMdHaKxXbE90pGdH4Uo2Y2f3p7uSUG+pZ6V59Kz5K5nAGJkPjrmAgSrFQ4146Ad0oxOshuou/DgMV1cKGUeGcu1X4D68I5CHKaUqykSHZgrfeb6xw/hxnalqV6W7Q8kh3hBXzQEt42r4OGOPRQauHZdCqjh8jnPd+NzbhkYVxfCsRfTGsNbq1BrcVbFSh4at85HPPtAM9jE9KPaba+uHNur1FoD40ueIOtVmHAmdBwlCOrHIO1L4aj1F4D2yvDcR28pbM85WqCBZY5CnIsnGEYxur/CoGkg2zwbpACF30xWHSAqEEc0dhpFUBqcJcNrwGaJMH3GhgjYGKSPVzJSZEJ2adCLNklzALPd+mAULc0Znr9zgsIasyU8MUwY4cN7LDBMiDW8PN6FvMFrjgGkgNMAC9z/JMk0IAWZB63NVeqU/PbVAeXBgdA5fuyxwf8cJALOJN7hj5g6awMiOAaHWzSsWbwLHRbuKiVJsu4EKozOAsvHhUKKvPG8GYbobi+/tnGiyPu5J6W08Cf/tZSeoEk+fPI3T9I4llJ8xgljVaN0WOp/YDfh+70KD8g9lVHv0oHKt+G0Y1L3oTqIczDo7PO+eXJ0RvU6fURzoswKhzjPKjpQ3DlAofA4yrgTJv6IJz+yl7cV3i687UX3FQ/v/J8ysVX+7dNPIB6qwxXN2GQURK/BVVt87oGZvXro8ujwyfXta2tvGt9EnWatbI5AL1tHDf1FSRxx/c3P2103JEXbNxtic+fyUAkfvnuO7HRSfEigA1sceHJUA1v9WDwv+KA6x2druuH1I02IotSjtX1WcdvTOeK4V/4GnM2HJgOMHHzTHLFZjD7kklDKJ2hp8hlNAa0oupfR8ESjkgQ68OnSqekGxDqI6BYCUa+5yOaxFtMPwJzEaE9jqHa0OqHUBvm2dlKcWg4FzTo0SgN8IwrAIEXq4B8WMHerhc7Ka9CgNlAmZGFpMdntYxIRrmBU9EkyxSswtM+7i14jqqtTgSl+wImjvXGAkxkgQHzgZwrn7ND1dZNMmXaBtHRGCp/jB4BWEJBmy6y+Mnx5UyL0Figd7PCaLCtK8XbWBYaQVuXiWG32WpSotdxGCdgOhfavRqjhAD7oHh+tURKn/KNlNo5Z8WOK0ebzW0dWVZL3vk6PsxpLS9c9SsWT3w2BSoN9Pq6wDp46Sw6HemO2ZQosik6fGevx1thzlAGQGuM/NwBKTbVR1AOaLTQCq4r18StmB9Xp/nBdIq0YRfoPZHroKOVEAY/P0UP5qgywWgJnU81R6IJBtSG6LQBEFozl8Form6P0S2LOEjZfGY3xbta7qaACgd8b8oQ0ITfPn1Crx0a7Xf4GuYJXULv3uc2OfkygILwt1s4b7wAf5v6HLi7lZ26rqQgTYkeFsFu5FwwzX1ONfh5o9BVBcDfvYdS7Esk0PiD3rxqXE5JnTQVZ3bl0GnBNdg/ubRs0fNzdoXcgRREe5bs/YrkBGU4/HtQu8ZLH+o1zsvAp/7x/aea8SVDGW7WqO3ztFb9AzAAxf4Xnu7obA== +sidebar_class_name: "put api-method" +info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import Markdown from "@theme/Markdown"; +import OperationTabs from "@theme/OperationTabs"; +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. + +## Request + +

Path Parameters

Body

+ +The updated transform object. Must include "name", "type", and "attributes" fields, but "name" and "type" must not be modified. + +
    attributes object nullable 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 + +
    + +string + +
    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 + +
    + +string + +
    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 + +
    + +string + +
    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 + +
    + +string + +
    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","enum":["LT","LTE","GT","GTE"],"example":"LT"}}>
    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 + +
    + +string + +
    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 + +
    + +string + +
    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 objectrequired
    + +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. + + +
    **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"}}} collapsible={false} discriminator={false}>
    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 objectrequired
    + +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 nullable 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 + +
    + +string + +
    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 + +
    + +string + +
    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 + +
    + +string + +
    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 + +
    + +string + +
    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","enum":["LT","LTE","GT","GTE"],"example":"LT"}}>
    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 + +
    + +string + +
    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 + +
    + +string + +
    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 objectrequired
    + +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. + + +
    **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"},"additionalProperties":true}} collapsible={false} discriminator={false}>
    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 objectrequired
    + +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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • 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 + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 403 response object
+ +Not Found - returned if the request URL refers to a resource or object that does not exist + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 404 response object
+ +Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. + +
Schema
+ +Internal Server Error - Returned if there is an unexpected error. + +
Schema
    messages object[]
    + +Generic localized reason for error + +
  • Array [
  • ]
    • causes object[]
    + +Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + +
  • Array [
  • ]
 An example of a 500 response object
\ No newline at end of file diff --git a/docs/api/v3/work-items.tag.mdx b/docs/api/v3/work-items.tag.mdx new file mode 100644 index 000000000..4ef3ebbcf --- /dev/null +++ b/docs/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/src/components/video-library/VideoComments/index.js b/src/components/video-library/VideoComments/index.js index 249de9450..052306c1f 100644 --- a/src/components/video-library/VideoComments/index.js +++ b/src/components/video-library/VideoComments/index.js @@ -6,9 +6,11 @@ const DiscourseEmbed = ({discourseEmbedUrl}) => { const embedUrl = `https://d1vrqvoe9hgpx0.cloudfront.net/videos/${discourseEmbedUrl}/index.html`; // Set up Discourse Embed + window.DiscourseEmbed = { discourseUrl, - discourseEmbedUrl: embedUrl, + topicId: 24732, + // discourseEmbedUrl: embedUrl, className: 'EMBEDDED_BODY', }; diff --git a/src/pages/exchange.module.css b/src/pages/exchange.module.css index d16546f19..ee387d263 100644 --- a/src/pages/exchange.module.css +++ b/src/pages/exchange.module.css @@ -1,17 +1,22 @@ .blogContainer { - display: flex; + display: flex; } .blogSidbarContainer { - flex: 5%; + flex: 5%; } @media only screen and (max-width: 870px) { - .blogSidbarContainer { - display: none; - } + .blogSidbarContainer { + display: none; + } } .blogCardContainer { - flex: 95%; -} \ No newline at end of file + flex: 95%; +} + +.discourseContainer { + border-radius: 0.5em; + height: 400px; +} diff --git a/src/pages/videos.js b/src/pages/videos.js index 6a79e592f..f292a5349 100644 --- a/src/pages/videos.js +++ b/src/pages/videos.js @@ -47,6 +47,9 @@ export default function VideoLibrary() {
+
+ +